Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Open API (Swagger) Integration for Confluence
docExpansionnone
openapi: 3.0.1
info:
  title: Abills user API
  version: 0.0.3236
servers:
  - url: https://demo.abills.net.ua:9443/api.cgi
tags:
  - name: user
    description: Работа с пользователем
  - name: internet
    description: Работа с услугой Интернет
  - name: msgs
    description: Работа с заявками пользователя
  - name: abon
    description: Работа с периодическими списаниями
  - name: paysys
    description: Работа с платежными системами
  - name: config
    description: Все доступные конфигурации
  - name: contacts
    description: Работа с контактами
paths:
  /users/login:
    post:
      tags:
        - user
      summary: Авторизация пользователя
      operationId: loginUser
      requestBody:
        content:
          '*application/*'json:
            schema:
              $ref: '#/components/schemas/UserLoginBody'
        required: true
      responses:
        200:
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserLogin'
  /usersuser/{UID}password/logoutrecovery:
    deletepost:
      tags:
        - user
      summary: ВыходВосстановление пользователяпароля
      operationId: logoutUseruserPasswordRecovery
      responsesrequestBody:
        200content:
          descriptionapplication/json:
 Успешное выполнение
          contentschema:
            application/json:   $ref: '#/components/schemas/PasswordRecoveryRequest'
        required: true
     schema responses:
        200:
          $refdescription: '#/components/schemas/ResultOK'Успешное выполнение
      security    content:
        - USER_SID: [ ]
  /user/{UID}/social/networksapplication/json:
    post:
          tagsschema:
        -  user
      summarytype: Привязкаobject
 социальной сети пользователем
      operationId: userSocialNetworkSubscribe
      requestBodyproperties:
        content:
          '*/*'result:
            schema:
        type: string
        $ref: '#/components/schemas/UserSocialNetwork'
            requiredexample: true
Success sent sms to phone  responses:380959212921
        200400:
          description: Успешное выполнение Нет ни login, uid или contractId
          content:
            application/json:
              schema:
                $reftype: '#/components/schemas/ResultOK'object
      security:
         - USER_SIDproperties:
 [ ]
    delete:
      tags:
      errno:
  - user
      summary: Отвязка от социальной сети пользователем
      parameterstype: integer
        - name: google
          inexample: query10005
          description:  Сортировка по одному параметру выше
  errstr:
        schema:
            type: string
          example: ya29.A0AVA9y1s12FRL1mMwZTTq9PSX6fSSzzRINDtnnJf7Gdwf9c0URWEAu203MKj3sxHFW9x2pFd8IqHexGfkfhOe95sLgQk6g1u36lP4t5DXYH4U6yalrLaWHOEP-T3AnhgyNoWcLDqTk8W6neCFKoweuNuEjx_ehAYUNnWUtBVEFTQVRBU0ZRRTY1ZHI4WjIxdXFWYnAzZzNsYkdpQXVIUWw1Zw0165
      operationId: userSocialNetworkUnsubscribe
  example: No uid, login responses:
or contractId field
  /user/internet/registration:
    200post:
      tags:
        - user
      descriptionsummary: Успешное выполнение
Регистрация пользователя сервиса интернет
      operationId: userInternetRegistration
      contentrequestBody:
        content:
          application/json:
              schema:
                $ref: '#/components/schemas/ResultOKUserInternetRegistration'
        securityrequired: true
      responses:
   - USER_SID: [ ]
  /user/{UID}200:
    get:
      tagsdescription: Успешное выполнение
        -  usercontent:
      summary: Информация о пользователе
   application/json:
   operationId: userInfo
      parameters:
    schema:
    - name: UID
          intype: pathobject
          description:  UID пользователя
   properties:
       required: true
          schemaresult:
                    type: numberstring
      responses:              example: "Successfully created user with uid: 49"
        200400:
          description: УспешноеПользователь выполнениесуществует
          content:
            application/json:
              schema:
                $reftype: '#/components/schemas/User'object
      security:
        - USER_SID: [ ]
  /user/{UID}/piproperties:
    get:
      tags:
        - usererrno:
      summary: Персональная информация пользователя
      operationId: userPersonalInfo
      parameterstype: integer
        - name: UID
          inexample: path10024
          description: UID пользователя
          requirederrstr: true
          schema:
            type: numberstring
      responses:
        200:
      example: User already exist
  /users/{UID}/logout:
    delete:
      tags:
        - user
      summary: Выход пользователя
      operationId: logoutUser
      responses:
        200:
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserPiResultOK'
      security:
        - USER_SID: [ ]
  /user/{UID}/creditsocial/networks:
    getpost:
      tags:
        - user
      summary: ИнформацияПривязка обсоциальной установкесети кредитапользователем
      operationId: userCreditInfouserSocialNetworkSubscribe
      parametersrequestBody:
        - namecontent: UID
          inapplication/json: path
          description: UID пользователя
    schema:
      required: true
          schema:$ref: '#/components/schemas/UserSocialNetwork'
            typerequired: numbertrue
      responses:
        200:
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserCreditInfoResultOK'
      security:
        - USER_SID: [ ]
    postdelete:
      tags:
        - user
      summary: УстановкаОтвязка кредитаот пользователю
социальной      operationId: userSetCreditсети пользователем
      parameters:
        - name: UIDgoogle
          in: pathquery
          description: UID пользователяСортировка по одному параметру выше
          requiredschema:
 true
           schematype: string
          example: ya29.A0AVA9y1s12FRL1mMwZTTq9PSX6fSSzzRINDtnnJf7Gdwf9c0URWEAu203MKj3sxHFW9x2pFd8IqHexGfkfhOe95sLgQk6g1u36lP4t5DXYH4U6yalrLaWHOEP-T3AnhgyNoWcLDqTk8W6neCFKoweuNuEjx_ehAYUNnWUtBVEFTQVRBU0ZRRTY1ZHI4WjIxdXFWYnAzZzNsYkdpQXVIUWw1Zw0165
  type    operationId: numberuserSocialNetworkUnsubscribe
      responses:
        200:
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserCreditResultOK'
      security:
        - USER_SID: [ ]
  /user/{UID}/internet:
    get:
      tags:
        - internetuser
      summary: Информация об интернет услугах пользователяо пользователе
      operationId: userInternetInfouserInfo
      parameters:
        - name: UID
          in: path
          description: UID пользователя
          required: true
          schema:
            type: number
      responses:
        200:
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserInternetUser'
      security:
        - USER_SID: [ ]
  /user/{UID}/internet/{ID}pi:
    putget:
      tags:
        - internetuser
      summary: СменаПерсональная информация ТПпользователя
      operationId: userChangeInternetTPuserPersonalInfo
      parameters:
        - name: UID
          in: path
          description: UID пользователя
          required: true
          schema:
            type: number
        - name: IDresponses:
          in200: path
          description: IDУспешное услуги Интернетвыполнение
          requiredcontent: true
          schema:
   application/json:
           type   schema:
 number
       requestBody:
        content:
 $ref: '#/components/schemas/UserPi'
      security:
         '*/*':- USER_SID: [ ]
  /user/{UID}/credit:
    get:
      schematags:
        - user
     $ref summary: '#/components/schemas/body'
   Информация об установке кредита
      requiredoperationId: trueuserCreditInfo
      responsesparameters:
        200- name: UID
          descriptionin: Успешное выполнениеpath
          contentdescription:
 UID пользователя
          application/jsonrequired: true
          schema:
    schema:
        type: number
       $ref: '#/components/schemas/InternetChangeTPSuccess'responses:
        400200:
          description: ОшибкаУспешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternetChangeTPErrorUserCreditInfo'
      security:
        - USER_SID: [ ]
      x-codegen-request-body-name: bodypost:
    delete:
      tags:
        - internetuser
      summary: УдалитьУстановка расписаниекредита изменения ТПпользователю
      operationId: userDeleteChangeInternetTPuserSetCredit
      parameters:
        - name: UID
          in: path
          description: UID пользователя
          required: true
          schema:
            type: integernumber
      responses:
       - name200: ID
          indescription: pathУспешное выполнение
          descriptioncontent:
 ID расписания
          requiredapplication/json:
 true
             schema:
            type: integer
      responses:$ref: '#/components/schemas/UserCredit'
        200security:
        -  description: Успешное выполнениеUSER_SID: [ ]
  /user/{UID}/internet:
    get:
      contenttags:
        - internet
   application/json:
   summary: Информация об интернет услугах пользователя
      schemaoperationId: userInternetInfo
      parameters:
        -  $refname: '#/components/schemas/RemoveInternetChangeTPSuccess'UID
      security:
    in: path
   - USER_SID: [ ]
      x-codegen-request-body-namedescription: body
  /user/{UID}/internet/{ID}/speed:UID пользователя
    get:
      tagsrequired: true
        -  internetschema:
      summary: Скорость ТП
      operationIdtype: userTpSpeednumber
      parametersresponses:
        - name200: UID
          indescription: pathУспешное выполнение
          descriptioncontent:
 UID пользователя
          requiredapplication/json: true
          schema:
    schema:
        type: number
        - name$ref: ID'#/components/schemas/UserInternet'
          in: pathsecurity:
        -  descriptionUSER_SID: ID[ ]
 услуги Интернет /user/{UID}/internet/{ID}:
    put:
      requiredtags:
 true
       - internet
  schema:
    summary: Смена ТП
      typeoperationId: numberuserChangeInternetTP
      responsesparameters:
        200- name: UID
          descriptionin: Успешное выполнениеpath
          contentdescription:
 UID пользователя
          application/jsonrequired: true
              schema:
            type: number
   $ref: '#/components/schemas/InternetSpeed'
    - name: security:ID
        -  USER_SIDin: [path
 ]
  /user/{UID}/internet/{ID}/holdup:
    post:
   description: ID услуги tags:Интернет
        - internet  required: true
      summary:  Приостановление услуги Интернетschema:
      operationId      type: userInternetHoldupnumber
      parametersrequestBody:
        - namecontent: UID
          inapplication/json:
 path
           descriptionschema:
 UID   пользователя
          required$ref: true'#/components/schemas/body'
        required: true
 schema:
     responses:
       type 200:
 number
        - namedescription: Успешное IDвыполнение
          incontent:
  path
          descriptionapplication/json:
 ID  услуги Интернет
          requiredschema: true

                schema:$ref: '#/components/schemas/InternetChangeTPSuccess'
        400:
    type: number
     description: requestBody:Ошибка
          content:
          '*/*'  application/json:
              schema:
                $ref: '#/components/schemas/body_1InternetChangeTPError'
        requiredsecurity: true
      responses:
        200:
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HoldupReply'
      security:
        - - USER_SID: [ ]
      x-codegen-request-body-name: body
    delete:
      tags:
        - internet
      summary: УдалениеУдалить рассписаниярасписание на приостановление услуги Интернетизменения ТП
      operationId: userDeleteInternetHoldupuserDeleteChangeInternetTP
      parameters:
        - name: UID
          in: path
          description: UID пользователя
          required: true
          schema:
            type: numberinteger
        - name: ID
          in: path
          description: ID услуги Интернетрасписания
          required: true
          schema:
            type: numberinteger
      responses:
        200:
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HoldupReplyRemoveInternetChangeTPSuccess'
      security:
        - USER_SID: [ ]
    get:
    x-codegen-request-body-name: body
  /user/{UID}/internet/{ID}/speed:
    get:
      tags:
        - internet
      summary: Инфомация о приостановлении услуги ИнтернетСкорость ТП
      operationId: userInfoInternetHoldupuserTpSpeed
      parameters:
        - name: UID
          in: path
          description: UID пользователя
          required: true
          schema:
            type: number
        - name: ID
          in: path
          description: ID услуги Интернет
          required: true
          schema:
            type: number
      responses:
        200:
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HoldupInfoInternetSpeed'
      security:
        - USER_SID: [ ]
  /user/{UID}/internet/tariffs{ID}/holdup:
    getpost:
      tags:
        - internet
      summary: ДоступныеПриостановление для изменения ТП, на которые хватает денегуслуги Интернет
      operationId: userInternetAvailableToChangeTariffsuserInternetHoldup
      parameters:
        - name: UID
          in: path
          description: UID пользователя
          required: true
          schema:
            type: number
      responses:  - name: ID
        200  in: path
          description: УспешноеID услуги выполнениеИнтернет
          contentrequired: true
          schema:
    application/json:
        type: number
      schemarequestBody:
        content:
        $ref:  '#/components/schemas/UserAvailableTariffs'application/json:
      security      schema:
              $ref: '#/components/schemas/body_1'
        required: true
      responses:
        200:
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HoldupReply'
      security:
        - USER_SID: [ ]
      x-codegen-request-body-name: body
    delete:
      tags:
        - internet
      summary: Удаление рассписания на приостановление услуги Интернет
      operationId: userDeleteInternetHoldup
      parameters:
        - name: UID
          in: path
          description: UID пользователя
          required: true
          schema:
            type: number
        - name: ID
          in: path
          description: ID услуги Интернет
          required: true
          schema:
            type: number
      responses:
        200:
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HoldupReply'
      security:
        - USER_SID: [ ]
    get:
      tags:
        - internet
      summary: Инфомация о приостановлении услуги Интернет
      operationId: userInfoInternetHoldup
      parameters:
        - name: UID
          in: path
          description: UID пользователя
          required: true
          schema:
            type: number
        - name: ID
          in: path
          description: ID услуги Интернет
          required: true
          schema:
            type: number
      responses:
        200:
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HoldupInfo'
      security:
        - USER_SID: [ ]
  /user/{UID}/internet/tariffs:
    get:
      tags:
        - internet
      summary: Доступные для изменения ТП, на которые хватает денег
      operationId: userInternetAvailableToChangeTariffs
      parameters:
        - name: UID
          in: path
          description: UID пользователя
          required: true
          schema:
            type: number
      responses:
        200:
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserAvailableTariffs'
      security:
        - USER_SID: [ ]
  /user/{UID}/internet/tariffs/all:
    get:
      tags:
        - internet
      summary: Все доступные для изменения ТП
      operationId: userInternetAvailableToChangeTariffsAll
      parameters:
        - name: UID
          in: path
          description: UID пользователя
          required: true
          schema:
            type: number
      responses:
        200:
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserAvailableTariffs'
      security:
        - USER_SID: [ ]
  /user/{UID}/internet/{ID}/warnings:
    get:
      tags:
        - internet
      summary: Информация о списаниях
      operationId: userInternetWarnings
      parameters:
        - name: UID
          in: path
          description: UID пользователя
          required: true
          schema:
            type: number
        - name: ID
          in: path
          description: ID услуги
          required: true
          schema:
            type: number
      responses:
        200:
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternetWarnings'
      security:
        - USER_SID: [ ]
  /user/{UID}/internet/sessions/:
    get:
      tags:
        - internet
      summary: История интернет сессий
      operationId: userInternetSessions
      parameters:
        - name: UID
          in: path
          description: UID пользователя
          required: true
          schema:
            type: number
        - name: pageRows
          in: query
          description: Количество возвращаемых значений
          required: false
          schema:
            type: number
            default: 25
      responses:
        200:
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternetSessions'
      security:
        - USER_SID: [ ]
  /user/{UID}/internet/tariffssession/active/all:
    get:
      tags:
        - internet
      summary: ВсеАктивная доступные для изменения ТПсессия абонента
      operationId: userInternetAvailableToChangeTariffsAlluserInternetSessionActive
      parameters:
        - name: UID
          in: path
          description: UID пользователя
          required: true
          schema:
            type: number
      responses:
        200:
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserAvailableTariffsInternetSessionActive'
      security:
        - USER_SID: [ ]

  /user/{UID}/internet/{ID}/warningsabon:
    get:
      tags:
        - internet
      summary: Информация о списаниях
      operationId: userInternetWarnings
      parameters:
        - name: UID
          in: path
          description: UID пользователяtags:
        - abon
 required: true
    summary: Информация об периодических списаниях пользователя
 schema:
     operationId: userAbonInfo
      typeparameters: number
        - name: IDUID
          in: path
          description: IDUID услугипользователя
          required: true
          schema:
            type: number
      responses:
        200:
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternetWarningsUserAbon'
      security:
        - USER_SID: [ ]
  /user/{UID}/internet/sessions/msgs:
    get:
      tags:
        - internetmsgs
      summary: ИсторияСписок интернетзаявок сессийпользователя
      operationId: userInternetSessionsuserMsgsList
      parameters:
        - name: UID
          in: path
          description: UID пользователя
          required: true
          schema:
            type: numberparameters:
        - name: pageRowsUID
          in: querypath
          description: КоличествоUID возвращаемых значенийпользователя
          required: falsetrue
          schema:
            type: number
            default: 25
      responses:
        200:
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternetSessionsMsgsArray'
      security:
        - USER_SID: [ ]
  /user/{UID}/internet/session/active/:
    getpost:
      tags:
        - internetmsgs
      summary: АктивнаяСоздание сессия абонентазаявки
      operationId: userInternetSessionActiveuserAddMessage
      parameters:
        - name: UID
          in: path
          description: UID пользователя
          required: true
          schema:
            type: number
      requestBody:
        content:
          application/json:
 UID пользователя
          requiredschema: true
          schema:
    $ref: '#/components/schemas/MsgsAdd'
       type required: numbertrue
      responses:
        200:
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternetSessionActiveMsgsAdded'
      security:
        - USER_SID: [ ]
      x-codegen-request-body-name: body
  /user/{UID}/abonmsgs/{ID}:
    get:

      tags:
        - msgs
      summary: Информация о заявке пользователя
      operationId: userMsgs
      parameters:
        - name: UID
          in: path
          tagsdescription: UID пользователя
        - abon  required: true
      summary: Информация об периодических списаниях пользователяschema:
      operationId: userAbonInfo
      parameterstype: number
        - name: UIDID
          in: path
          description: UIDID пользователязаявки
          required: true
          schema:
            type: number
      responses:
        200:
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserAbonMsgsInfo'
      security:
        - USER_SID: [ ]
  /user/{UID}/msgs: ]
  /user/{UID}/msgs/{ID}/reply:
    get:
      tags:
        - msgs
      summary: Список заявок пользователя
      operationId: userMsgReplyList
      parameters:
        - name: UID
          in: path
    get:
      tagsdescription: UID пользователя
        - msgs  required: true
      summary:  Список заявок пользователяschema:
      operationId: userMsgsList
     type: parameters:number
        - name: UIDID
          in: path
          description: UIDID пользователязаявки
          required: true
          schema:
            type: number
      responses:
        200:
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MsgsArrayMsgsReplyArray'
      security:
        - USER_SID: [ ]
    post:
      tags:
        - msgs
      summary: Создание заявки
      operationId: userAddMessageuserAddReply
      parameters:
        - name: UID
          in: path
          description: UID пользователя
          required: true
          schema:
            type: number
      requestBody:
  - name: ID
          contentin: path
          '*/*'description:
 ID заявки
          schemarequired: true
          schema:
    $ref: '#/components/schemas/MsgsAdd'
        requiredtype: truenumber
      responsesrequestBody:
        200content:
          description: Успешное выполнение
application/json:
            schema:
             content:
 $ref: '#/components/schemas/MsgsReplyAdd'
        required: true
      application/jsonresponses:
        200:
      schema:
    description: Успешное выполнение
          $refcontent: '#/components/schemas/MsgsAdded'{ }
      security:
        - USER_SID: [ ]
      x-codegen-request-body-name: body
  /user/{UID}/msgs/{ID}chapters:
    get:
      tags:
        - msgs
      summary: ИнформацияСписок оразделов заявкезаявок пользователя
      operationId: userMsgsuserMsgsChapters
      parameters:
        - name: UID
          in: path
          description: UID пользователя
          required: true
          schema:
            type: number
        - name: ID
          in: path
          description: ID заявки
          required: true
          schema:
            type: number
      responses:
        200:
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MsgsInfoMsgsArrayChapters'
      security:
        - USER_SID: [ ]
  /user/{UID}/msgs/{ID}/replypaysys/systems:
    get:
      tags:
        - msgspaysys
      summary: Список платежных систем заявокдоступных пользователяпользователю
      operationId: userMsgReplyListuserPaysysList
      parameters:
        - name: UID
          in: path
          description: UID пользователя
          required: true
          schema:
            type: number
      responses:
    -    name200: ID
          indescription: Успешное pathвыполнение
          descriptioncontent:
 ID заявки
          requiredapplication/json:
 true
             schema:
            type    $ref: number'#/components/schemas/PaysysArray'
      responsessecurity:
        200- USER_SID: [ ]
  /user/{UID}/config:
    get:
      descriptiontags:
 Успешное выполнение
      - config
    content:
  summary: Список доступных конфигураций пользователя
      application/jsonoperationId: userConfig
      parameters:
        - schemaname: UID
          in: path
     $ref: '#/components/schemas/MsgsReplyArray'
    description: UID security:пользователя
        -  USER_SIDrequired: [ ]true
    post:
      tagsschema:
        - msgs
      summarytype: Создание заявкиnumber
      operationIdresponses:
 userAddReply
       parameters200:
         - namedescription: Успешное UIDвыполнение
          incontent:
 path
           descriptionapplication/json:
 UID   пользователя
          requiredschema: true
          schema:
      $ref: '#/components/schemas/UserConfig'
      typesecurity: number
        - nameUSER_SID: ID[ ]
  /version:
    get:
      intags:
 path
       - config
    description  summary: IDПолучить заявки
версии биллинга и API
       requiredoperationId: truegetVersion
      responses:
    schema:
    200:
        type: number
 description: Успешное выполнение
   requestBody:
        content:
            '*application/*'json:
              schema:
                $ref: '#/components/schemas/MsgsReplyAddVersion'
  /user/{UID}/paysys/pay:
      requiredpost: true
      responsestags:
        200:- paysys
      summary: Формирование ссылки на description: Успешное выполнениебыструю оплату
          contentoperationId: { }userPaysysPay
      securityparameters:
        - USER_SIDname: [UID
 ]
      x-codegen-request-body-name: body
  /user/{UID}/msgs/chapters:in: path
    get:
      tagsdescription: UID пользователя
        - msgs  required: true
      summary: Список разделов заявок пользователяschema:
      operationId: userMsgsChapters
      parameterstype: number
        - name: UIDrequestBody:
          incontent: path
          descriptionapplication/json:
 UID пользователя
          requiredschema: true
          schema:
    $ref: '#/components/schemas/PaysysPayBody'
        typerequired: numbertrue
      responses:
        200:
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MsgsArrayChaptersPaysysPay'
      security:
        - USER_SID: [ ]
  /user/{UID}/paysys/transaction/systemsstatus:
    getpost:
      tags:
        - paysys
      summary: СписокПроверка платежных систем доступных пользователюстатуса платежа
      operationId: userPaysysListuserPaysysTransactionStatus
      parameters:
        - name: UID
          in: path
          description: UID пользователя
          required: true
           schema:schema:
            type: number
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaysysTransactionStatusBody'
            typerequired: numbertrue
      responses:
        200:
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaysysArrayPaysysTransactionStatus'
      security:
        - USER_SID: [ ]
  /user/{UID}/contacts/configpush/subscribe:
    getpost:
      tags:
        - configcontacts
      summary: СписокПодписка доступныхна конфигурацийPush пользователяуведомления
      operationId: userConfiguserPushSubscribeCreate
      parameters:
        - name: UID
          in: path
          description: UID пользователя
          required: true
          schema:
            type: number
      responsesrequestBody:
        200:
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserConfig'
      security:
        - USER_SID: [ ]
  /version:
    get:
      tagsschema:
        - config
      summary$ref: Получить версии биллинга и API
'#/components/schemas/PushSubscribeCreateBody'
        operationIdrequired: getVersiontrue
      responses:
        200:
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Version'
  /user/{UID}/paysys/pay:ResultOK'
    post:
      tagssecurity:
        - paysys
      summaryUSER_SID: Формирование ссылки на быструю оплату[ ]
      operationIddelete: userPaysysPay
      parameterstags:
        - name: UIDcontacts
          insummary: path
Отписка от         description: UID пользователяPush уведомлений
          requiredoperationId: trueuserPushSubscribeDelete
          schemaparameters:
        -    typename: numberUID
      requestBody:
        contentin: path
          '*/*'description:
 UID пользователя
          schemarequired: true
          schema:
    $ref: '#/components/schemas/PaysysPayBody'
        requiredtype: truenumber
      responses:
        200:
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaysysPayResultOK'
      security:
        - USER_SID: [ ]
  /user/{UID}/paysys/transaction/status:
    postget:
      tags:
        - paysyscontacts
      summary: Проверка статуса платежа
      operationId: userPaysysTransactionStatus
      parameters:
        - name: UID
          in: path
          description: UID пользователя
          required: trueПолучить FCM токен
      operationId: userPushSubscribeGet
   schema:
   parameters:
        - typename: numberUID
      requestBody:
        content:in: path
          '*/*'description:
 UID пользователя
          schemarequired: true
          schema:
    $ref: '#/components/schemas/PaysysTransactionStatusBody'
        requiredtype: truenumber
      responses:
        200:
          description: Успешное выполнение
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaysysTransactionStatusPushSubscribeInfo'
      security:
        - USER_SID: [ ]
components:
  /user/{UID}/contacts/push/subscribeschemas:
    postUser:
      tagstype: object
      properties:
  - contacts
      login:
          summarytype: Подпискаstring
  на Push уведомления
      operationIdexample: userPushSubscribeCreate"3433"
        parametersdeposit:
        -  nametype: UIDinteger
          in: pathexample: 1600
        credit:
          descriptiontype: UID пользователяinteger
          requiredexample: true100
          schemacreditDate:
            type: numberstring
      requestBody:    example: 2021-08-13
        contentbillId:
          '*/*':type: integer
          example:  schema:12
        gid:
      $ref: '#/components/schemas/PushSubscribeCreateBody'
   type: integer
    required: true
      responsesexample: 57
        200disable:
          descriptiontype: Успешное выполнениеinteger
          contentexample: 0
        deleted:
    application/json:
      type: integer
       schema:
   example: 0
    UserPi:
        $reftype: '#/components/schemas/ResultOK'object
      securityproperties:
        - USER_SID: [ ]fio:
    delete:
      tagstype: string
          -example: contacts
Иванов Иван Иванович
    summary: Отписка от Push уведомленийaddressFull:
      operationId: userPushSubscribeDelete
   type: string
  parameters:
        - nameexample: UID
  ул.Адамца, 121, 3
        inage: path
          descriptiontype: UID пользователяinteger
          requiredexample: true33
          schemalocationId:
            type: numberinteger
      responses:    example: 1444
        200contractId:
          descriptiontype: Успешное выполнениеstring
          contentexample: "575493"
        email:
    application/json:
      type: array
       schema:
   items:
             $reftype: '#/components/schemas/ResultOK'string
      security:
      example: test@gmail.com
 - USER_SID: [ ]
    getphone:
      tags:
    type: array
   - contacts
      summary: Получить FCM токен
 items:
     operationId: userPushSubscribeGet
      parameterstype: string
        -    nameexample: UID"380976574568"
    UserInternet:
      intype: patharray
      items:
       description: UID пользователя $ref: '#/components/schemas/UserInternet_inner'
    InternetSpeed:
      requiredtype: truearray
      items:
    schema:    $ref: '#/components/schemas/InternetSpeed_inner'
     UserAbon:
       type: numberarray
      responsesitems:
        200:$ref: '#/components/schemas/UserAbon_inner'
    UserCredit:
      descriptiontype: Успешное выполнениеobject
          contentproperties:
            application/jsoncreditSum:
          type: integer
   schema:
       example: 500
        $refcreditChangePrice: '#/components/schemas/PushSubscribeInfo'

          securitytype: integer
        -  USER_SIDexample: [ ]
components:
  schemas100
        uid:
    User:
      type: objectinteger
      properties:    example: 11135
        logincreditDays:
          type: string
          example: "34333"
        depositcreditMonthChanges:
          type: integerstring
          example: 1600"1"
        creditUserCreditInfo:
          type: integerobject
          example: 100properties:
        creditDatecreditChgPrice:
          type: string
          example: 2021-08-13"500"
        billIdcreditMonthChanges:
          type: integerstring
          example: 12"1"
        gidcreditSum:
          type: integerstring
          example: 57"800"
        disablecreditDays:
          type: integerstring
          example: 0"3"
    UserAvailableTariffs:
    deleted:
  type: array
       typeitems: integer
          example$ref: 0'#/components/schemas/UserAvailableTariffs_inner'
    UserPiHoldupReply:
      type: object
      properties:
        fiosuccess:
          type: stringinteger
          example: Иванов Иван Иванович1
        addressFullmsg:
          type: string
    HoldupInfo:
      exampletype: ул.Адамца, 121, 3object
      properties:
        agecanCancel:
          type: integerboolean
          example: 33true
        locationIddateFrom:
          type: integerstring
          example: 1444"2022-06-12"
        contractIddateTo:
          type: string
          example: "5754932022-07-12"
        emaildelIds:
          type: arraystring
          itemsexample:
 "1, 2, 3"
    InternetWarnings:
      type: stringobject
      properties:
      example  messageType:
  test@gmail.com
        phonetype: string
          typeexample: arraysuccess
          itemswarning:
            type: string
          example: следующее списание через example: "380976574568"7 дней
    UserInternet    daysToFee:
          type: arraystring
      items:
    example: "2"
   $ref: '#/components/schemas/UserInternet_inner'
    InternetSpeedsum:
          type: arrayinteger
      items:    example: 150
        $ref: '#/components/schemas/InternetSpeed_inner'abonDate:
    UserAbon:
      type: arraystring
      items:
        $ref: '#/components/schemas/UserAbon_inner'example: 2021-10-01
    UserCreditInternetSessionActive:
      type: object
      properties:
        creditSumduration:
          type: integernumber
          example: 50010782
        creditChangePriceinput:
          type: integernumber
          example: 100366270859
        uidip:
          type: integerstring
          example: 11135192.168.50.156
        creditDaysoutput:
          type: stringnumber
          example: "3" 73249353
    InternetSessions:
      type: array
      items:
        creditMonthChanges:$ref: '#/components/schemas/InternetSession'
    InternetSession:
      type: string object
      properties:
          example: "1"duration:
    UserCreditInfo:
      type: objectnumber
      properties:    example: 1738
        creditChgPriceinput:
          type: stringnumber
          example: "500"21423525
        creditMonthChangesip:
          type: string
          example: "1"192.190.50.1
        creditSumoutput:
          type: stringnumber
          example: "800"177703957
        creditDaystpId:
          type: stringnumber
          example: "3"1
    UserAvailableTariffs    tpName:
      type: array
   type: string
  items:
        $refexample: '#/components/schemas/UserAvailableTariffs_inner'test_tariff
    HoldupReplyInternetChangeTPSuccess:
      type: object
      properties:
        success:
          type: integer
          example: 1
        msguid:
          type: stringinteger
    HoldupInfoInternetChangeTPError:
      type: object
      properties:
        canCancelerror:
          type: booleaninteger
          example: true
        dateFrom:
          type: string
          example: "2022-06-12"145
        dateTomessage:
          type: string
        messageType:
  example: "2022-07-12"
       type: delIds:string
          typemessageTitle: string
          exampletype: "1, 2, 3"string
    InternetWarningsRemoveInternetChangeTPSuccess:
      type: object
      properties:
        messageTypesuccess:
          type: stringinteger
          example: success1
        warninguid:
          type: stringinteger
          example: следующее списание через 7 дней1
        daysToFeeMsgsAdd:
          type: stringobject
          example: "2"properties:
        sumchapter:
          type: integer
          example: 1503
        abonDatemessage:
          type: string
          example: 2021-10-01Some message
    InternetSessionActive    subject:
          type: objectstring
        properties:  example: Message subject
        durationpriority: 
          type: numberinteger
          example: 107822
        inputMsgsAdded: 
          type: numberobject
          example: 366270859properties:
        ipinsertId: 
          type: stringinteger
          example: 192.168.50.15643
        outputmsgId: 
          type: numberinteger
          example: 7324935343
    InternetSessions    affected:
      type: array
   type: integer
  items:
        $refexample: '#/components/schemas/InternetSession'1
    InternetSessionMsgsInfo:
      type: object
      properties:
        durationsubject: 
          type: numberstring
          example: 1738Message user api subject
        inputmessage: 
          type: numberstring
          example: 21423525Test message from user api
        ipchapterName: 
          type: string
          example: 192.190.50.1Второй раздел
        outputchapter: 
          type: numberinteger
          example: 1777039573
        tpIdpriority: 
          type: numberinteger
          example: 12
        tpNamestate: 
          type: stringinteger
          example: test_tariff0
    InternetChangeTPSuccess:
      typedate: object
      properties:
    type: string
   success:
       example:   type: integer2021-09-02 13:20:37
    MsgsArray:
      exampletype: 1array
        uiditems:
          type$ref: integer'#/components/schemas/MsgsInfo'
    InternetChangeTPErrorMsgsArrayChapters:
      type: objectarray
      propertiesitems:
        error:$ref: '#/components/schemas/MsgsChapter'
    MsgsReply:
      type: integerobject
          example: 145properties:
        messageuid:
          type: stringinteger
        messageType:
          typeexample: string0
        messageTitleaid:
          type: stringinteger
    RemoveInternetChangeTPSuccess:
      typeexample: object2
      properties:
        successid:
          type: integer
          example: 154
        uidtext:
          type: integerstring
          example: 1some reply text
    MsgsAdd    datetime:
          type: objectstring
      properties:
    example:    chapter:2021-09-02 12:50:47
    MsgsReplyAdd:
      type: integerobject
          exampleproperties: 3
        messagereply_text:
          type: string
          example: Some messagereply text
        reply_subject:
          type: string
          example: Message subjectSubject
    MsgsReplyArray:
    priority:
  type: array
       typeitems: integer
          example$ref: 2'#/components/schemas/MsgsReply'
    MsgsAddedbody:
      type: object
      properties:
        insertIdtp_id:
          type: integer
          example: 434
        msgIddate:
          type: integerstring
          example: 432021-09-17
        affectedperiod:
          type: integer
    body_1:
      exampletype: 1 object
      properties:
    MsgsInfo    fromDate:
          type: objectstring
          properties:example: 2021-08-14
        subjecttoDate:
          type: string
          example: 2021-08-17
    UserInternet_inner:
      type: object
 Message   user api subjectproperties:
        messageid:
          type: stringinteger
          example: Test message from user api2
        chapterNametpName:
          type: string
          example: Премиум Второйдо раздел100м
        chaptertpId:
          type: integer
          example: 341
        priorityinternetStatus:
          type: integer
          example: 20
        statecid:
          type: integerstring
          example: 014:11:11:11:11:c1
        datemonthFee:
          type: stringinteger
          example: 2021-09-02 13:20:37250
        dayFee:
    MsgsArray:
      type: arrayinteger
      items:    example: 0
        $ref: '#/components/schemas/MsgsInfo'schedule:
    MsgsArrayChapters:
      type: arrayobject
          itemsproperties:
        $ref: '#/components/schemas/MsgsChapter'
    MsgsReplydate:
       type: object
      propertiestype: string
        uid:
          type: integer
example: "2022-06-11"
            exampledateFrom: 0
        aid:
      type: string
   type: integer
          example: 2
"2022-07-11"
           id sheduleId:
              type: integer
              example: 541
        text:
    tpId:
      type: string
       type: integer
  example:  some reply text
        datetimeexample: 1
    InternetSpeed_inner:
      type: stringobject
      properties:
      example: 2021-09-02 12inSpeed:50:47
    MsgsReplyAdd:
      type: objectinteger
      properties:    example: 2999
        reply_textoutSpeed:
          type: stringinteger
          example: Some reply text3000
        reply_subjecttpNum:
          type: stringinteger
          example: Subject155
    MsgsReplyArrayUserAbon_inner:
      type: arrayobject
      itemsproperties:
        $ref: '#/components/schemas/MsgsReply'id:
    body:
      type: objectinteger
          propertiesexample: 2
        tp_idname:
          type: integerstring
          example: Test 4abon TP
        dateprice:
          type: stringinteger
          example: 2021-09-17100
        period:
          type: integer
    body_1:
      typeexample: object1
        propertiesnextAbon:
        fromDate  type: string
          typeexample: string2021-09-01
        comments:
          exampletype: 2021-08-14string
        toDatedescription:
          type: string
          example: 2021-08-17Test description
    UserInternetUserAvailableTariffs_inner:
      type: object
      properties:
        id:
          type: integer
          example: 2
        tpNamename:
          type: string
          example: Премиум до 100м
        tpId:
          type: integer
          example: 41
        internetStatusmonthFee:
          type: integer
          example: 250
        dayFee:
          type: integer
          example: 0
        cidcomments:
          type: string

    PaysysArray:
      type: array
     example: 14:11:11:11:11:c1items:
        monthFee:$ref: '#/components/schemas/PaymentSystem'
    PaymentSystem:
      type: integerobject
          example: 250properties:
        dayFeeid:
          type: integer
          example: 01
        schedulename:
          type: objectstring
          propertiesexample: LiqPay
            datemodule:
              type: string
          example: Liqpay.pm
    example: "2022-06-11"PaysysPayBody:
      type: object
     dateFrom properties:
        systemId:
      type: string
   type: integer
          example: "2022-07-11"1
            sheduleIdsum: 
              type: integer
              example: 1100
            tpIdoperationId: 
              type: integerstring
              example: 1123456789
    InternetSpeed_innerPaysysPay:
      type: object
      properties:
        inSpeedoperationId:
          type: integerstring
          example: 2999123456789
        outSpeedtransactionId:
          type: integerstring
          example: 3000Liqpay:123456789
        tpNumurl:
          type: integerstring
          example: 155https://www.liqpay.ua/api/3/checkout?data=123456789&signature=123456789
    UserAbon_innerPaysysTransactionStatus:
      type: object
      properties:
        id:
          type: integer
          example: 21
        namedatetime:
          type: string
          example: Test abon TP"2022-01-01 01:01:01"
        pricelogin:
          type: integerstring
          example: 100test
        periodstatus:
          type: integer
          example: 1
        nextAbonsystemId:
          type: stringinteger
          example: 2021-09-011
        commentssum:
          type: stringinteger
        description  example: 100
          typeuid: string
          exampletype: Test descriptioninteger
    UserAvailableTariffs_inner:
      typeexample: object1
      properties:
        idtransactionId:
          type: integerstring
          example: 2
        name:
     Liqpay:123456789
     typePaysysTransactionStatusBody: string
      type: object
   example: Премиум до 100мproperties:
        tpIdtransactionId:
          type: integerstring
          example: 41Liqpay:123456789
        monthFeeUserLoginBody:
          type: integerobject
          example: 250properties:
        dayFeelogin:
          type: integerstring
          example: 0testuser
        commentspassword:
          type: string
    PaysysArray:
      typeexample: arraytestuser
      itemsUserLogin:
        $ref: '#/components/schemas/PaymentSystem'
    PaymentSystem:
      type: object
      properties:
        idlogin:
          type: integerstring
          example: 1testuser
        namesid:
          type: string
          example: LiqPaysW44EJZLyWDMeXAV
        moduleuid:
          type: stringinteger
          example: Liqpay.pm1
    PaysysPayBodyUserConfig:
      type: object
      properties:
        systemIdcardsUserPayment:
          type: integer
          example: 16
        sumdocsActsList:
          type: integer
          example: 100
        operationId:
          type: string
  9
        exampledocsInvoicesList: 123456789
    PaysysPay:
      type: objectinteger
      properties:    example: 8
        operationIddocsReceiptList:
          type: stringinteger
          example: 1234567895
        transactionIdinternetUserInfo:
          type: stringinteger
          example: Liqpay:1234567893
        urlinternetUserStats:
          type: stringinteger
          example: https://www.liqpay.ua/api/3/checkout?data=123456789&signature=12345678910
    PaysysTransactionStatus    msgsUser:
          type: objectinteger
        properties  example: 1
        idpaysysPayment:
          type: integer
          example: 14
        datetimepaysysSubscribe:
          type: stringinteger
          example: "2022-01-01 01:01:01"7
        loginpaysysUserLog:
          type: stringinteger
          example: test2
        statussystem:
          type: integerobject
          exampleproperties:
 1
           systemIdcurrency:
              type: integer
          example: 1
   example: 980
    sumMsgsChapter:
          type: integerobject
          example: 100properties:
        uidid:
          type: integer
          example: 1
        transactionIdname:
          type: string
          example: Liqpay:123456789Example chapter
    PaysysTransactionStatusBodyUserSocialNetwork:
      type: object
      properties:
        transactionIdgoogle:
          type: string
          example: Liqpay:123456789ya29.A0AVA9y1s12FRL1mMwZTTq9PSX6fSSzzRINDtnnJf7Gdwf9c0URWEAu203MKj3sxHFW9x2pFd8IqHexGfkfhOe95sLgQk6g1u36lP4t5DXYH4U6yalrLaWHOEP-T3AnhgyNoWcLDqTk8W6neCFKoweuNuEjx_ehAYUNnWUtBVEFTQVRBU0ZRRTY1ZHI4WjIxdXFWYnAzZzNsYkdpQXVIUWw1Zw0165
    UserLoginBodyVersion:
      type: object
      properties:
        version:
           logintype: string
          example: 0.91.0
        apiVersion:
          type: string
          example: testuser"0.01"
        passwordbilling:
          type: string
          example: testuserAbills
    UserLoginPushSubscribeCreateBody:
      type: object
      properties:
       login token:
          type: string
          example: testuser"d61FRIQSRI2j1mOwvLqt12:APA91bGpVb1bbokiMBWAoBh6uaGhzFr6YOD9ZT_1WcFeu6b_Dc8a8glaQCEk5GtCM3LYdvnF1XewSIpiT6Y5gkoa9ztFUb8of1wxd28eG-L94DM8MHvaCGa2jIbatHWiPYcPSUOtAdsM"
       sidResultOK:
         type: stringobject
         exampleproperties:
 sW44EJZLyWDMeXAV
       uidresult:
          type: integerstring
          example: 1OK
    UserConfigPushSubscribeInfo:
      type: object
      properties:
        cardsUserPaymentvalue:
          type: integerstring
          example: 6"d61FRIQSRI2j1mOwvLqt12:APA91bGpVb1bbokiMBWAoBh6uaGhzFr6YOD9ZT_1WcFeu6b_Dc8a8glaQCEk5GtCM3LYdvnF1XewSIpiT6Y5gkoa9ztFUb8of1wxd28eG-L94DM8MHvaCGa2jIbatHWiPYcPSUOtAdsM"
        docsActsListuid:
          type: integer
          example: 91
        docsInvoicesListPasswordRecoveryRequest:
          type: integerobject
          example: 8properties:
        docsReceiptListuid:
          type: integer
          example: 549
        internetUserInfo  required: false
          typedescription: integer
Используется для проверки пользователя, обязательно если пустой login или  example: 3contractId
        internetUserStatslogin:
          type: integerstring
          example: 10testuser
        msgsUser  required: false
          typedescription: integer
Используется для проверки пользователя, обязательно если пустой contractId или  example: 1uid
        paysysPaymentcontractId:
          type: integerstring
          example: 411112345
        paysysSubscribe  required: false
          typedescription: integer
Используется для проверки пользователя, обязательно если пустой login или  example: 7uid
        paysysUserLogphone:
          type: integerstring
          example: 2380959212921
        system  required: false
          description: Используется для отправки пользователю пароля, type:обязательно object
если пустой phone
        propertiesemail:
          type:  currency:string
              typeexample: integertest@gmail.com
              examplerequired: 980false
    MsgsChapter:  
    description: Используется type:для object
отправки пользователю пароля, обязательно если пустой properties:email
        idsendSms:
          type: integer
          example: 1
        name  required: false
          typedescription: string
Отправить SMS пользвателю, если включен модуль Sms, за умолчанием отправит example: Example chapterна email
    UserSocialNetworkUserInternetRegistration: 
      type: object
      properties:
        googlelogin:
          type: string
          example: ya29.A0AVA9y1s12FRL1mMwZTTq9PSX6fSSzzRINDtnnJf7Gdwf9c0URWEAu203MKj3sxHFW9x2pFd8IqHexGfkfhOe95sLgQk6g1u36lP4t5DXYH4U6yalrLaWHOEP-T3AnhgyNoWcLDqTk8W6neCFKoweuNuEjx_ehAYUNnWUtBVEFTQVRBU0ZRRTY1ZHI4WjIxdXFWYnAzZzNsYkdpQXVIUWw1Zw0165testuser
    Version:
      typerequired: objecttrue
      properties:
        versionemail:
          type: string
          example: 0.91.0
        apiVersion:
          type: stringtest@gmail.com
          examplerequired: "0.01"true
        billingphone:
          type: string
          example: Abills 380912324212
    PushSubscribeCreateBody:
      typerequired: objecttrue
      properties:
        tokentpId:
          type: stringnumber
          example: "d61FRIQSRI2j1mOwvLqt12:APA91bGpVb1bbokiMBWAoBh6uaGhzFr6YOD9ZT_1WcFeu6b_Dc8a8glaQCEk5GtCM3LYdvnF1XewSIpiT6Y5gkoa9ztFUb8of1wxd28eG-L94DM8MHvaCGa2jIbatHWiPYcPSUOtAdsM"112
    ResultOK:
      typerequired: objecttrue
       properties userIp:
        result  type: string
          typeexample: string0.0.0.0
          examplerequired: OKfalse
    PushSubscribeInfo:
      typedescription: object
Нужный параметр если включена   properties:опция INTERNET_REGISTRATION_IP
        valuefio:
          type: string
          example: "d61FRIQSRI2j1mOwvLqt12:APA91bGpVb1bbokiMBWAoBh6uaGhzFr6YOD9ZT_1WcFeu6b_Dc8a8glaQCEk5GtCM3LYdvnF1XewSIpiT6Y5gkoa9ztFUb8of1wxd28eG-L94DM8MHvaCGa2jIbatHWiPYcPSUOtAdsM" Test user
          required: false
        uidregistrationTag: 
          type: integernumber
          example: 1
          required: false
  securitySchemes:
    USER_SID:
      type: apiKey
      name: USERSID
      in: header

...