Merge pull request #38 from valitydev/ft/IMP-252

remove payout
2024-11-06 01:05:17 +00:00 · 2024-06-27 15:00:13 +03:00 · 2024-06-27 15:00:13 +03:00 · 0f6d0dcf02
commit 0f6d0dcf02
parent 2eda808e69 b84057fc8e
12 changed files with 3 additions and 177 deletions
--- a/openapi/components/parameters/payoutIDPathRequired.yaml
+++ b/openapi/components/parameters/payoutIDPathRequired.yaml
@ -1,8 +0,0 @@
-name: payoutID
-in: path
-description: Идентификатор вывода
-required: true
-schema:
-  type: string
-  maxLength: 40
-  minLength: 1
--- a/openapi/components/schemas/Payout.yaml
+++ b/openapi/components/schemas/Payout.yaml
@ -1,50 +0,0 @@
-type: object
-required:
-  - id
-  - shopID
-  - createdAt
-  - amount
-  - currency
-  - payoutToolDetails
-properties:
-  id:
-    description: Идентификатор выплаты
-    type: string
-  shopID:
-    description: Идентификатор магазина
-    type: string
-  createdAt:
-    description: Дата и время создания
-    type: string
-    format: date-time
-  cancellationDetails:
-    description: Детали отмены выплаты
-    type: string
-    maxLength: 1000
-  amount:
-    description: |
-        Сумма выплаты в минорных денежных
-        единицах, например в копейках в случае указания российских рублей в
-        качестве валюты.
-    type: integer
-    format: int64
-    minimum: 1
-  fee:
-    description: 'Комиссия системы, в минорных денежных единицах'
-    type: integer
-    format: int64
-    minimum: 0
-  currency:
-    $ref: '../schemas/Currency.yaml'
-  payoutToolDetails:
-    $ref: '../schemas/PayoutToolDetails.yaml'
-  status:
-    description: Статус выплаты
-    type: string
-  metadata:
-    description: |
-      Произвольный, специфичный для клиента API и непрозрачный для системы набор данных,
-      ассоциированных с данной выплатой
-    type: object
-    example:
-      payoutDesc: Custom payout
--- a/openapi/components/schemas/PayoutToolDetails.yaml
+++ b/openapi/components/schemas/PayoutToolDetails.yaml
@ -1,15 +0,0 @@
-description: Данные средства вывода
-type: object
-properties:
-   detailsType:
-    description: Тип средства вывода
-    type: string
-required:
-  - detailsType
-discriminator:
-  propertyName: detailsType
-  mapping:
-    'PayoutToolDetailsBankAccount': '../schemas/PayoutToolDetailsBankAccount.yaml'
-    'PayoutToolDetailsInternationalBankAccount': '../schemas/PayoutToolDetailsInternationalBankAccount.yaml'
-    'PayoutToolDetailsPaymentsInstitutionAccount': '../schemas/PayoutToolDetailsPaymentInstitutionAccount.yaml'
-    'PayoutToolDetailsWalletInfo': '../schemas/PayoutToolDetailsWalletInfo.yaml'
--- a/openapi/components/schemas/PayoutToolDetailsBankAccount.yaml
+++ b/openapi/components/schemas/PayoutToolDetailsBankAccount.yaml
@ -1,4 +0,0 @@
-type: object
-allOf:
-  - $ref: '../schemas/PayoutToolDetails.yaml'
-  - $ref: '../schemas/BankAccount.yaml'
--- a/openapi/components/schemas/PayoutToolDetailsInternationalBankAccount.yaml
+++ b/openapi/components/schemas/PayoutToolDetailsInternationalBankAccount.yaml
@ -1,4 +0,0 @@
-type: object
-allOf:
-  - $ref: '../schemas/PayoutToolDetails.yaml'
-  - $ref: '../schemas/InternationalBankAccount.yaml'
--- a/openapi/components/schemas/PayoutToolDetailsPaymentInstitutionAccount.yaml
+++ b/openapi/components/schemas/PayoutToolDetailsPaymentInstitutionAccount.yaml
@ -1,4 +0,0 @@
-type: object
-allOf:
-  - $ref: '../schemas/PayoutToolDetails.yaml'
-  - $ref: '../schemas/PaymentInstitutionAccount.yaml'
--- a/openapi/components/schemas/PayoutToolDetailsWalletInfo.yaml
+++ b/openapi/components/schemas/PayoutToolDetailsWalletInfo.yaml
@ -1,13 +0,0 @@
-type: object
-allOf:
-  - $ref: '../schemas/PayoutToolDetails.yaml'
-  - type: object
-    required:
-      - walletID
-    properties:
-      walletID:
-        description: Идентификатор кошелька
-        type: string
-        maxLength: 40
-        minLength: 1
-
--- a/openapi/components/schemas/Report.yaml
+++ b/openapi/components/schemas/Report.yaml
@ -38,7 +38,6 @@ properties:
    enum:
      - provisionOfService
      - paymentRegistry
-      - paymentRegistryByPayout
  partyID:
    description: Идентификатор участника
    type: string
--- a/openapi/components/schemas/Shop.yaml
+++ b/openapi/components/schemas/Shop.yaml
@ -37,14 +37,5 @@ properties:
      Идентификатор договора, на основании которого производится обслуживание
      магазина
    type: string
-  payoutToolID:
-    description: |
-      Идентификатор средства вывода в рамках контракта, используемое в процессе
-      вывода по магазину
-    type: string
-  scheduleID:
-    description: Идентификатор расписания выводов
-    type: integer
-    format: int32
  account:
    $ref: '../schemas/ShopAccount.yaml'
--- a/openapi/openapi.yaml
+++ b/openapi/openapi.yaml
@ -4,7 +4,7 @@ info:
  title: Vality Platform Analytics API
  description: |
    ## Описание
-    Vality Analytics API является точкой взаимодействия с аналитической и поисковой частью платформы. Все аналитическоие запросы осуществляются с помощью вызовов соответствующих методов API. Любые сторонние приложения, включая наши веб-сайты, личные кабинеты и другие UI-интерфейсы являются внешними приложениями-клиентами.
+    Vality Analytics API является точкой взаимодействия с аналитической и поисковой частью платформы. Все аналитическое запросы осуществляются с помощью вызовов соответствующих методов API. Любые сторонние приложения, включая наши веб-сайты, личные кабинеты и другие UI-интерфейсы являются внешними приложениями-клиентами.

    Vality Analytics API работает поверх HTTP-протокола. Мы используем REST архитектуру, схема описывается в соответствии со стандартом [OpenAPI v3.0](https://spec.openapis.org/oas/v3.0.0/). Коды возврата описываются соответствующими HTTP-статусами. Платформа принимает и возвращает JSON-структуры в HTTP body.

@ -38,7 +38,7 @@ info:

    ## Коды ошибок
    ### Ошибки бизнес-логики
-    Все ошибки бизнес-логики имеют следуюший вид:
+    Все ошибки бизнес-логики имеют следующий вид:

      ```json
      {
@ -56,7 +56,7 @@ info:
      | **ambiguousPartyID**             | Невозможно однозначно определить идентификатор участника, укажите идентификатор в запросе явно.                                       |
      | **invalidPartyID**               | Участник с указанным идентификатором не существует или недоступен.                                                                    |
      | **invalidRequest**               | Прочие неверные данные запроса.                                                                                                       |
-      | **limitExceeded**                | Запрашеваемое количество данных должно быть меньше чем указано.                                                                                                       |
+      | **limitExceeded**                | Запрашиваемое количество данных должно быть меньше чем указано.                                                                                                       |
      | **badContinuationToken**         | Не валидный ContinuationToken.                                                                                                       |

    ### Общие ошибки
@ -146,8 +146,6 @@ paths:
    $ref: './paths/refunds.yaml'
  '/chargebacks':
    $ref: './paths/chargebacks.yaml'
-  '/payouts':
-    $ref: './paths/payouts.yaml'
  '/invoice-templates':
    $ref: './paths/invoice-templates.yaml'
  '/reports':
--- a/openapi/paths/payouts.yaml
+++ b/openapi/paths/payouts.yaml
@ -1,63 +0,0 @@
-get:
-  description: Поиск выплат
-  summary: Поиск выплат
-  tags:
-    - Search
-  operationId: searchPayouts
-  parameters:
-    - $ref: '../components/parameters/requestIDRequired.yaml'
-    - $ref: '../components/parameters/deadline.yaml'
-    - $ref: '../components/parameters/partyIDRequired.yaml'
-    - $ref: '../components/parameters/shopID.yaml'
-    - $ref: '../components/parameters/shopIDs.yaml'
-    - $ref: '../components/parameters/paymentInstitutionRealm.yaml'
-    - $ref: '../components/parameters/fromTimeRequired.yaml'
-    - $ref: '../components/parameters/toTimeRequired.yaml'
-    - $ref: '../components/parameters/limitRequired.yaml'
-    - name: payoutID
-      in: query
-      description: Идентификатор выплаты
-      required: false
-      schema:
-        type: string
-        maxLength: 40
-        minLength: 1
-    - name: payoutToolType
-      in: query
-      required: false
-      schema:
-        type: string
-        enum:
-          - PayoutAccount
-          - Wallet
-          - PaymentInstitutionAccount
-        description: >
-          Тип выплаты для поиска
-            * PayoutAccount - выплата на банковский счёт
-            * Wallet - выплата на кошелёк
-            * PaymentInstitutionAccount - выплата на счёт платежной организации
-    - name: continuationToken
-      in: query
-      required: false
-      schema:
-        $ref: '../components/schemas/ContinuationToken.yaml'
-  responses:
-    '200':
-      description: Найденные выплаты
-      content:
-        application/json; charset=utf-8:
-          schema:
-            type: object
-            properties:
-              totalCount:
-                type: integer
-              continuationToken:
-                $ref: '../components/schemas/ContinuationToken.yaml'
-              result:
-                type: array
-                items:
-                  $ref: '../components/schemas/Payout.yaml'
-    '400':
-      $ref: '../components/responses/SearchRequestError.yaml'
-    '401':
-      $ref: '../components/responses/Unauthorized.yaml'
--- a/openapi/paths/reports.yaml
+++ b/openapi/paths/reports.yaml
@ -81,7 +81,6 @@ get:
          enum:
            - provisionOfService
            - paymentRegistry
-            - paymentRegistryByPayout
    - name: continuationToken
      in: query
      required: false