valitydev/swag-payments
14
0
Fork 0
mirror of https://github.com/valitydev/swag-payments.git synced 2024-11-06 01:25:22 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

TD-367: Retire legacy APIs (#56)

Browse Source 
* Allow zero amount payment in search results
* Retire Claims API
* Drop `InvoiceSearchResult` as unused
* Retire Analytics API while keeping Search API intact
* Retire Reports API
This commit is contained in:
Andrew Mayorov 2022-08-22 11:16:26 +03:00 committed by GitHub
parent 4efebe4b79
commit 37e6f46d86
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
49 changed files with 2 additions and 1161 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
spec/definitions/Claim.yaml
View File

@ -1,30 +0,0 @@
type: object
discriminator: status
required:
- id
- revision
- createdAt
- status
- changeset
properties:
id:
description: Идентификатор заявки
type: integer
format: int64
revision:
description: Версия заявки
type: integer
format: int32
createdAt:
description: Дата создания
type: string
format: date-time
updatedAt:
description: Дата изменения
type: string
format: date-time
status:
description: Статус заявки
type: string
changeset:
$ref: '#/definitions/ClaimChangeset'

3
spec/definitions/ClaimAccepted.yaml
View File

@ -1,3 +0,0 @@
type: object
allOf:
- $ref: '#/definitions/Claim'

4
spec/definitions/ClaimChangeset.yaml
View File

@ -1,4 +0,0 @@
description: Набор изменений данных участника
type: array
items:
$ref: '#/definitions/PartyModification'

11
spec/definitions/ClaimDenied.yaml
View File

@ -1,11 +0,0 @@
type: object
allOf:
- $ref: '#/definitions/Claim'
- type: object
required:
- reason
properties:
reason:
description: Причина отклонения заявки
type: string
maxLength: 1000

3
spec/definitions/ClaimPending.yaml
View File

@ -1,3 +0,0 @@
type: object
allOf:
- $ref: '#/definitions/Claim'

11
spec/definitions/ClaimRevoked.yaml
View File

@ -1,11 +0,0 @@
type: object
allOf:
- $ref: '#/definitions/Claim'
- type: object
required:
- reason
properties:
reason:
description: Причина отзыва заявки
type: string
maxLength: 1000

8
spec/definitions/ContractAdjustmentCreation.yaml
View File

@ -1,8 +0,0 @@
description: Создание поправки к договору
type: object
allOf:
- $ref: '#/definitions/ContractModification'
- type: object
properties:
adjustmentID:
type: string

14
spec/definitions/ContractCreation.yaml
View File

@ -1,14 +0,0 @@
description: Создание нового договора
type: object
allOf:
- $ref: '#/definitions/ContractModification'
- type: object
required:
- contractor
- paymentInstitutionID
properties:
contractor:
$ref: '#/definitions/Contractor'
paymentInstitutionID:
type: integer
format: int32

10
spec/definitions/ContractLegalAgreementBinding.yaml
View File

@ -1,10 +0,0 @@
description: Привязка юридического соглашения
type: object
allOf:
- $ref: '#/definitions/ContractModification'
- type: object
required:
- legalAgreement
properties:
legalAgreement:
$ref: '#/definitions/LegalAgreement'

25
spec/definitions/ContractModification.yaml
View File

@ -1,25 +0,0 @@
description: Изменение или создание договора
type: object
allOf:
- $ref: '#/definitions/PartyModification'
- type: object
discriminator: contractModificationType
required:
- contractID
- contractModificationType
properties:
contractID:
description: Идентификатор договора
type: string
maxLength: 40
minLength: 1
contractModificationType:
type: string
enum:
- ContractCreation
- ContractTermination
- ContractLegalAgreementBinding
- ContractAdjustmentCreation
- ContractPayoutToolCreation
- ContractPayoutToolInfoModification
- ContractReportingPreferencesChange

14
spec/definitions/ContractPayoutToolCreation.yaml
View File

@ -1,14 +0,0 @@
description: Создание инструмента вывода в рамках договора
type: object
allOf:
- $ref: '#/definitions/ContractModification'
- type: object
required:
- payoutToolID
properties:
payoutToolID:
description: Идентификатор средства вывода
type: string
maxLength: 40
minLength: 1
- $ref: '#/definitions/PayoutToolParams'

16
spec/definitions/ContractPayoutToolInfoModification.yaml
View File

@ -1,16 +0,0 @@
description: Изменение информации об инструменте вывода в рамках договора
type: object
allOf:
- $ref: '#/definitions/ContractModification'
- type: object
required:
- payoutToolID
- details
properties:
payoutToolID:
description: Идентификатор средства вывода
type: string
maxLength: 40
minLength: 1
details:
$ref: '#/definitions/PayoutToolDetails'

5
spec/definitions/ContractReportingPreferencesChange.yaml
View File

@ -1,5 +0,0 @@
description: Изменение настроек выгрузки автоматической отчетности
type: object
allOf:
- $ref: '#/definitions/ContractModification'
- $ref: '#/definitions/ReportingPreferences'

10
spec/definitions/ContractTermination.yaml
View File

@ -1,10 +0,0 @@
description: Расторжение договора
type: object
allOf:
- $ref: '#/definitions/ContractModification'
- type: object
properties:
reason:
description: Причина расторжения
type: string
maxLength: 1000

32
spec/definitions/FileMeta.yaml
View File

@ -1,32 +0,0 @@
type: object
required:
- id
- filename
properties:
id:
description: Идентификатор файла
type: string
maxLength: 40
minLength: 1
filename:
description: Имя файла
type: string
maxLength: 1000
minLength: 1
signatures:
type: object
description: Сигнатуры файла
required:
- md5
- sha256
properties:
md5:
description: MD5 содержимого файла
type: string
maxLength: 32
minLength: 32
sha256:
description: SHA256 содержимого файла
type: string
maxLength: 64
minLength: 64

51
spec/definitions/InvoiceSearchResult.yaml
View File

@ -1,51 +0,0 @@
type: object
allOf:
- $ref: '#/definitions/InvoiceStatus'
- type: object
required:
- id
- shopID
- createdAt
- dueDate
- amount
- currency
- product
- metadata
properties:
id:
description: Идентификатор инвойса
type: string
shopID:
description: Идентификатор магазина
type: string
createdAt:
description: Дата и время создания
type: string
format: date-time
dueDate:
description: Дата и время окончания действия
type: string
format: date-time
amount:
description: >
Стоимость предлагаемых товаров или услуг, в минорных денежных единицах,
например в копейках в случае указания российских рублей в качестве валюты.
type: integer
format: int64
minimum: 1
currency:
x-rebillyMerge:
- $ref: '#/definitions/Currency'
product:
description: Наименование предлагаемых товаров или услуг
type: string
maxLength: 100
description:
description: Описание предлагаемых товаров или услуг
type: string
maxLength: 1000
cart:
$ref: '#/definitions/InvoiceCart'
metadata:
description: Связанные с инвойсом метаданные
type: object

11
spec/definitions/PartyModification.yaml
View File

@ -1,11 +0,0 @@
description: Единичное изменение данных участника
type: object
discriminator: partyModificationType
required:
- partyModificationType
properties:
partyModificationType:
type: string
enum:
- ContractModification
- ShopModification

19
spec/definitions/PaymentConversionStat.yaml
View File

@ -1,19 +0,0 @@
type: object
required:
- offset
- successfulCount
- totalCount
- conversion
properties:
offset:
description: Смещение сегмента выборки
type: integer
successfulCount:
description: Количество успешных платежей
type: integer
totalCount:
description: Общее количество платежей
type: integer
conversion:
description: Значение конверсии
type: number

24
spec/definitions/PaymentGeoStat.yaml
View File

@ -1,24 +0,0 @@
type: object
required:
- offset
- geoID
- currency
- profit
- revenue
properties:
offset:
description: Смещение сегмента выборки
type: integer
geoID:
description: Идентификатор геопозиции плательщика
type: integer
format: int32
currency:
x-rebillyMerge:
- $ref: '#/definitions/Currency'
profit:
description: Прибыль магазина
type: integer
revenue:
description: Сумма платежей в магазине
type: integer

26
spec/definitions/PaymentMethodBankCardStat.yaml
View File

@ -1,26 +0,0 @@
type: object
allOf:
- $ref: '#/definitions/PaymentMethodStat'
- type: object
required:
- offset
- totalCount
- paymentSystem
- profit
- revenue
properties:
offset:
description: Смещение сегмента выборки
type: integer
totalCount:
description: Общее количество плательщиков
type: integer
paymentSystem:
x-rebillyMerge:
- $ref: '#/definitions/BankCardPaymentSystem'
profit:
description: Прибыль магазина
type: integer
revenue:
description: Сумма платежей в магазине
type: integer

8
spec/definitions/PaymentMethodStat.yaml
View File

@ -1,8 +0,0 @@
type: object
discriminator: statType
required:
- statType
properties:
statType:
description: Тип статистики по методу оплаты
type: string

7
spec/definitions/PaymentRateStat.yaml
View File

@ -1,7 +0,0 @@
type: object
required:
- uniqueCount
properties:
uniqueCount:
description: Количество уникальных плательщиков
type: integer

19
spec/definitions/PaymentRevenueStat.yaml
View File

@ -1,19 +0,0 @@
type: object
required:
- offset
- currency
- profit
- revenue
properties:
offset:
description: Смещение сегмента выборки
type: integer
currency:
x-rebillyMerge:
- $ref: '#/definitions/Currency'
profit:
description: Прибыль магазина
type: integer
revenue:
description: Сумма платежей в магазине
type: integer

6
spec/definitions/PaymentSearchResult.yaml
View File

@ -34,9 +34,9 @@ allOf:
качестве валюты.
type: integer
format: int64
minimum: 1
minimum: 0
fee:
description: 'Комиссия системы, в минорных денежных единицах'
description: Комиссия системы в минорных денежных единицах
type: integer
format: int64
minimum: 0
@ -55,12 +55,10 @@ allOf:
type: string
format: date-time
transactionInfo:
description: 'Информация о транзакции'
$ref: '#/definitions/TransactionInfo'
makeRecurrent:
x-rebillyMerge:
- $ref: '#/definitions/PaymentMakeRecurrent'
- readOnly: true
cart:
$ref: '#/definitions/InvoiceCart'
allocation:

42
spec/definitions/Report.yaml
View File

@ -1,42 +0,0 @@
type: object
required:
- id
- createdAt
- fromTime
- toTime
- status
- type
- files
properties:
id:
description: Идентификатор отчета
type: integer
format: int64
createdAt:
description: Дата и время создания
type: string
format: date-time
fromTime:
description: Дата и время начала периода
type: string
format: date-time
toTime:
description: Дата и время конца периода
type: string
format: date-time
status:
description: Статус формирования отчета
type: string
enum:
- pending
- created
type:
description: Тип отчета
type: string
enum:
- provisionOfService
- paymentRegistry
files:
type: array
items:
$ref: '#/definitions/FileMeta'

11
spec/definitions/ShopAccountCreation.yaml
View File

@ -1,11 +0,0 @@
description: Создание новых счетов в магазине
type: object
allOf:
- $ref: '#/definitions/ShopModification'
- type: object
required:
- currency
properties:
currency:
x-rebillyMerge:
- $ref: '#/definitions/Currency'

13
spec/definitions/ShopCategoryChange.yaml
View File

@ -1,13 +0,0 @@
description: Изменение категории магазина
type: object
allOf:
- $ref: '#/definitions/ShopModification'
- type: object
required:
- categoryID
properties:
categoryID:
description: |
Идентификатор категории товаров и услуг, предлагаемых в этом магазине
type: integer
format: int32

18
spec/definitions/ShopContractBinding.yaml
View File

@ -1,18 +0,0 @@
description: Привязка магазина к указанному договору
type: object
allOf:
- $ref: '#/definitions/ShopModification'
- type: object
required:
- contractID
- payoutToolID
properties:
contractID:
description: |
Идентификатор договора, на основании которого следует производить
обслуживание магазина
type: string
payoutToolID:
description: |
Идентификатор средства вывода в рамках указанного контракта
type: string

25
spec/definitions/ShopCreation.yaml
View File

@ -1,25 +0,0 @@
description: Создание нового магазина
type: object
allOf:
- $ref: '#/definitions/ShopModification'
- type: object
required:
- location
- details
- contractID
- payoutToolID
properties:
location:
$ref: '#/definitions/ShopLocation'
details:
$ref: '#/definitions/ShopDetails'
contractID:
description: |
Идентификатор договора, на основании которого следует производить
обслуживание создаваемого магазина
type: string
payoutToolID:
description: |
Идентификатор средства вывода для создаваемого магазина в рамках
указанного контракта
type: string

10
spec/definitions/ShopDetailsChange.yaml
View File

@ -1,10 +0,0 @@
description: Изменение деталей магазина
type: object
allOf:
- $ref: '#/definitions/ShopModification'
- type: object
required:
- details
properties:
details:
$ref: '#/definitions/ShopDetails'

10
spec/definitions/ShopLocationChange.yaml
View File

@ -1,10 +0,0 @@
description: Изменение местоположения магазина
type: object
allOf:
- $ref: '#/definitions/ShopModification'
- type: object
required:
- location
properties:
location:
$ref: '#/definitions/ShopLocation'

25
spec/definitions/ShopModification.yaml
View File

@ -1,25 +0,0 @@
type: object
allOf:
- $ref: '#/definitions/PartyModification'
- type: object
discriminator: shopModificationType
required:
- shopID
- shopModificationType
properties:
shopID:
description: Идентификатор магазина
type: string
maxLength: 40
minLength: 1
shopModificationType:
type: string
enum:
- ShopCreation
- ShopAccountCreation
- ShopCategoryChange
- ShopLocationChange
- ShopDetailsChange
- ShopContractBinding
- ShopPayoutToolChange
- ShopPayoutScheduleChange

10
spec/definitions/ShopPayoutScheduleChange.yaml
View File

@ -1,10 +0,0 @@
description: Изменение расписания выводов магазина
type: object
allOf:
- $ref: '#/definitions/ShopModification'
- type: object
properties:
scheduleID:
description: Идентификатор расписания выводов
type: integer
format: int32

12
spec/definitions/ShopPayoutToolChange.yaml
View File

@ -1,12 +0,0 @@
description: Изменение средства вывода магазина
type: object
allOf:
- $ref: '#/definitions/ShopModification'
- type: object
required:
- payoutToolID
properties:
payoutToolID:
description: |
Идентификатор средства вывода в рамках текущего контракта магазина
type: string

34
spec/paths/analytics@shops@{shopID}@customers@stats@payment_method.yaml
View File

@ -1,34 +0,0 @@
get:
description: |
Получить статистику по платежным средствам за определённое время.
tags:
- Analytics
operationId: getPaymentMethodStats
parameters:
- $ref: '#/parameters/requestID'
- $ref: '#/parameters/deadline'
- $ref: '#/parameters/shopID'
- $ref: '#/parameters/fromTime'
- $ref: '#/parameters/toTime'
- $ref: '#/parameters/splitUnit'
- $ref: '#/parameters/splitSize'
- name: paymentMethod
in: query
description: Метод оплаты
type: string
required: true
enum:
- bankCard
responses:
'200':
description: Статистика по платежным средствам
schema:
type: array
items:
$ref: '#/definitions/PaymentMethodStat'
'404':
$ref: '#/responses/NotFound'
'401':
$ref: '#/responses/Unauthorized'
'400':
$ref: '#/responses/DefaultLogicError'

23
spec/paths/analytics@shops@{shopID}@customers@stats@rate.yaml
View File

@ -1,23 +0,0 @@
get:
description: >
Получить статистику по уникальным плательщикам за определённое время.
tags:
- Analytics
operationId: getPaymentRateStats
parameters:
- $ref: '#/parameters/requestID'
- $ref: '#/parameters/deadline'
- $ref: '#/parameters/shopID'
- $ref: '#/parameters/fromTime'
- $ref: '#/parameters/toTime'
responses:
'200':
description: Статистика по уникальным плательщикам
schema:
$ref: '#/definitions/PaymentRateStat'
'404':
$ref: '#/responses/NotFound'
'401':
$ref: '#/responses/Unauthorized'
'400':
$ref: '#/responses/DefaultLogicError'

27
spec/paths/analytics@shops@{shopID}@payments@stats@conversion.yaml
View File

@ -1,27 +0,0 @@
get:
description: |
Получить статистику конверсии платежей магазина за определённое время.
tags:
- Analytics
operationId: getPaymentConversionStats
parameters:
- $ref: '#/parameters/requestID'
- $ref: '#/parameters/deadline'
- $ref: '#/parameters/shopID'
- $ref: '#/parameters/fromTime'
- $ref: '#/parameters/toTime'
- $ref: '#/parameters/splitUnit'
- $ref: '#/parameters/splitSize'
responses:
'200':
description: Статистика конверсии платежей
schema:
type: array
items:
$ref: '#/definitions/PaymentConversionStat'
'404':
$ref: '#/responses/NotFound'
'401':
$ref: '#/responses/Unauthorized'
'400':
$ref: '#/responses/DefaultLogicError'

27
spec/paths/analytics@shops@{shopID}@payments@stats@geo.yaml
View File

@ -1,27 +0,0 @@
get:
description: |
Получить статистику по геопозициям плательщиков за определённое время.
tags:
- Analytics
operationId: getPaymentGeoStats
parameters:
- $ref: '#/parameters/requestID'
- $ref: '#/parameters/deadline'
- $ref: '#/parameters/shopID'
- $ref: '#/parameters/fromTime'
- $ref: '#/parameters/toTime'
- $ref: '#/parameters/splitUnit'
- $ref: '#/parameters/splitSize'
responses:
'200':
description: Статистика по геопозициям плательщиков
schema:
type: array
items:
$ref: '#/definitions/PaymentGeoStat'
'404':
$ref: '#/responses/NotFound'
'401':
$ref: '#/responses/Unauthorized'
'400':
$ref: '#/responses/DefaultLogicError'

28
spec/paths/analytics@shops@{shopID}@payments@stats@revenue.yaml
View File

@ -1,28 +0,0 @@
get:
description: |
Получить статистику по сумме платежей магазина за определенное время, в том
числе за вычетом комиссии системы.
tags:
- Analytics
operationId: getPaymentRevenueStats
parameters:
- $ref: '#/parameters/requestID'
- $ref: '#/parameters/deadline'
- $ref: '#/parameters/shopID'
- $ref: '#/parameters/fromTime'
- $ref: '#/parameters/toTime'
- $ref: '#/parameters/splitUnit'
- $ref: '#/parameters/splitSize'
responses:
'200':
description: Статистика по сумме платежей и прибыли
schema:
type: array
items:
$ref: '#/definitions/PaymentRevenueStat'
'404':
$ref: '#/responses/NotFound'
'401':
$ref: '#/responses/Unauthorized'
'400':
$ref: '#/responses/DefaultLogicError'

87
spec/paths/parties@{partyID}@shops@{shopID}@reports.yaml
View File

@ -1,87 +0,0 @@
post:
description: Сгенерировать отчет с указанным типом по магазину за указанный промежуток времени
tags:
- Reports
operationId: createReportForParty
parameters:
- $ref: '#/parameters/requestID'
- $ref: '#/parameters/deadline'
- $ref: '#/parameters/shopID'
- $ref: '#/parameters/partyID'
- name: createReport
in: body
description: Параметры генерации отчета
required: true
schema:
$ref: '#/definitions/ReportParams'
responses:
'201':
description: Отчет создан
schema:
$ref: '#/definitions/Report'
'401':
$ref: '#/responses/Unauthorized'
'400':
description: Ошибочные данные для генерации
schema:
type: object
required:
- code
- message
properties:
code:
description: |
[Код ошибки](#tag/Error-Codes)
type: string
enum:
- invalidShopID
- invalidRequest
- invalidDeadline
message:
description: Человекочитаемое описание ошибки
type: string
example: "Invalid shop id"
'404':
$ref: '#/responses/NotFound'
get:
description: Получить список отчетов по данному магазину за период
tags:
- Reports
operationId: getReportsForParty
parameters:
- $ref: '#/parameters/requestID'
- $ref: '#/parameters/deadline'
- $ref: '#/parameters/shopID'
- $ref: '#/parameters/fromTime'
- $ref: '#/parameters/toTime'
- $ref: '#/parameters/partyID'
responses:
'200':
description: Найденные отчеты
schema:
type: array
items:
$ref: '#/definitions/Report'
'401':
$ref: '#/responses/Unauthorized'
'400':
description: Ошибочные данные для получения
schema:
type: object
required:
- code
- message
properties:
code:
description: |
[Код ошибки](#tag/Error-Codes)
type: string
enum:
- limitExceeded
- invalidRequest
- invalidDeadline
message:
description: Человекочитаемое описание ошибки
type: string
example: "Max limit: 1000"

22
spec/paths/parties@{partyID}@shops@{shopID}@reports@{reportID}.yaml
View File

@ -1,22 +0,0 @@
get:
description: Получить отчет по данному идентификатору
tags:
- Reports
operationId: getReportForParty
parameters:
- $ref: '#/parameters/requestID'
- $ref: '#/parameters/deadline'
- $ref: '#/parameters/shopID'
- $ref: '#/parameters/reportID'
- $ref: '#/parameters/partyID'
responses:
'200':
description: Найденный отчет
schema:
$ref: '#/definitions/Report'
'404':
$ref: '#/responses/NotFound'
'401':
$ref: '#/responses/Unauthorized'
'400':
$ref: '#/responses/DefaultLogicError'

23
spec/paths/parties@{partyID}@shops@{shopID}@reports@{reportID}@files@{fileID}@download.yaml
View File

@ -1,23 +0,0 @@
get:
description: Скачать файл
tags:
- Reports
operationId: downloadFileForParty
parameters:
- $ref: '#/parameters/requestID'
- $ref: '#/parameters/deadline'
- $ref: '#/parameters/shopID'
- $ref: '#/parameters/partyID'
- $ref: '#/parameters/reportID'
- $ref: '#/parameters/fileID'
responses:
'200':
description: Download link
schema:
$ref: '#/definitions/ReportLink'
'404':
$ref: '#/responses/NotFound'
'401':
$ref: '#/responses/Unauthorized'
'400':
$ref: '#/responses/DefaultLogicError'

75
spec/paths/processing@claims.yaml
View File

@ -1,75 +0,0 @@
get:
description: |
Получить список заявок участника, при желании отфильтрованный по значению
статуса.
operationId: getClaims
tags:
- Claims
parameters:
- $ref: '#/parameters/requestID'
- $ref: '#/parameters/deadline'
- name: claimStatus
description: Значение статуса для фильтрации
in: query
type: string
enum:
- pending
- accepted
- denied
- revoked
responses:
'200':
description: Список найденных заявок
schema:
type: array
items:
$ref: '#/definitions/Claim'
'401':
$ref: '#/responses/Unauthorized'
'400':
$ref: '#/responses/DefaultLogicError'
post:
description: |
Создать новую заявку с заданным набором изменений и отправить её на
премодерацию.
operationId: createClaim
tags:
- Claims
parameters:
- $ref: '#/parameters/requestID'
- $ref: '#/parameters/deadline'
- name: claimChangeset
in: body
required: true
schema:
$ref: '#/definitions/ClaimChangeset'
responses:
'201':
description: Заявка создана
schema:
$ref: '#/definitions/Claim'
'401':
$ref: '#/responses/Unauthorized'
'400':
description: Ошибочные данные в заявке
schema:
type: object
required:
- code
- message
properties:
code:
description: |
[Код ошибки](#tag/Error-Codes)
type: string
enum:
- changesetConflict
- invalidPartyStatus
- invalidChangeset
- invalidRequest
- invalidDeadline
message:
description: Человекочитаемое описание ошибки
type: string
example: Changeset conflict

21
spec/paths/processing@claims@{claimID}.yaml
View File

@ -1,21 +0,0 @@
get:
description: |
Получить заявку по её идентификатору.
operationId: getClaimByID
tags:
- Claims
parameters:
- $ref: '#/parameters/requestID'
- $ref: '#/parameters/deadline'
- $ref: '#/parameters/claimID'
responses:
'200':
description: Данные заявки
schema:
$ref: '#/definitions/Claim'
'404':
$ref: '#/responses/NotFound'
'401':
$ref: '#/responses/Unauthorized'
'400':
$ref: '#/responses/DefaultLogicError'

43
spec/paths/processing@claims@{claimID}@revoke.yaml
View File

@ -1,43 +0,0 @@
put:
description: Отозвать заявку по её идентификатору.
operationId: revokeClaimByID
tags:
- Claims
parameters:
- $ref: '#/parameters/requestID'
- $ref: '#/parameters/deadline'
- $ref: '#/parameters/claimID'
- $ref: '#/parameters/claimRevision'
- name: reason
in: body
schema:
$ref: '#/definitions/Reason'
responses:
'204':
description: Заявка отозвана
'404':
$ref: '#/responses/NotFound'
'401':
$ref: '#/responses/Unauthorized'
'400':
description: Ошибка отзыва заявки
schema:
type: object
required:
- code
- message
properties:
code:
description: |
[Код ошибки](#tag/Error-Codes)
type: string
enum:
- invalidClaimStatus
- invalidClaimRevision
- invalidPartyStatus
- invalidRequest
- invalidDeadline
message:
description: Человекочитаемое описание ошибки
type: string
example: Invalid claim status

87
spec/paths/shops@{shopID}@reports.yaml
View File

@ -1,87 +0,0 @@
post:
description: Сгенерировать отчет с указанным типом по магазину за указанный промежуток времени
tags:
- Reports
operationId: createReport
parameters:
- $ref: '#/parameters/requestID'
- $ref: '#/parameters/deadline'
- $ref: '#/parameters/shopID'
- name: createReport
in: body
description: Параметры генерации отчета
required: true
schema:
$ref: '#/definitions/ReportParams'
responses:
'201':
description: Отчет создан
schema:
$ref: '#/definitions/Report'
'401':
$ref: '#/responses/Unauthorized'
'404':
$ref: '#/responses/NotFound'
'400':
description: Ошибочные данные для генерации
schema:
type: object
required:
- code
- message
properties:
code:
description: |
[Код ошибки](#tag/Error-Codes)
type: string
enum:
- invalidShopID
- invalidRequest
- invalidDeadline
message:
description: Человекочитаемое описание ошибки
type: string
example: "Invalid shop id"
get:
description: Получить список отчетов по данному магазину за период
tags:
- Reports
operationId: getReports
parameters:
- $ref: '#/parameters/requestID'
- $ref: '#/parameters/deadline'
- $ref: '#/parameters/shopID'
- $ref: '#/parameters/fromTime'
- $ref: '#/parameters/toTime'
responses:
'200':
description: Найденные отчеты
schema:
type: array
items:
$ref: '#/definitions/Report'
'401':
$ref: '#/responses/Unauthorized'
'404':
$ref: '#/responses/NotFound'
'400':
description: Ошибочные данные для получения
schema:
type: object
required:
- code
- message
properties:
code:
description: |
[Код ошибки](#tag/Error-Codes)
type: string
enum:
- limitExceeded
- invalidRequest
- invalidDeadline
message:
description: Человекочитаемое описание ошибки
type: string
example: "Max limit: 1000"

21
spec/paths/shops@{shopID}@reports@{reportID}.yaml
View File

@ -1,21 +0,0 @@
get:
description: Получить отчет по данному идентификатору
tags:
- Reports
operationId: getReport
parameters:
- $ref: '#/parameters/requestID'
- $ref: '#/parameters/deadline'
- $ref: '#/parameters/shopID'
- $ref: '#/parameters/reportID'
responses:
'200':
description: Найденный отчет
schema:
$ref: '#/definitions/Report'
'404':
$ref: '#/responses/NotFound'
'401':
$ref: '#/responses/Unauthorized'
'400':
$ref: '#/responses/DefaultLogicError'

22
spec/paths/shops@{shopID}@reports@{reportID}@files@{fileID}@download.yaml
View File

@ -1,22 +0,0 @@
get:
description: Скачать файл
tags:
- Reports
operationId: downloadFile
parameters:
- $ref: '#/parameters/requestID'
- $ref: '#/parameters/deadline'
- $ref: '#/parameters/shopID'
- $ref: '#/parameters/reportID'
- $ref: '#/parameters/fileID'
responses:
'200':
description: Download link
schema:
$ref: '#/definitions/ReportLink'
'404':
$ref: '#/responses/NotFound'
'401':
$ref: '#/responses/Unauthorized'
'400':
$ref: '#/responses/DefaultLogicError'

80
spec/swagger.yaml
View File

@ -109,20 +109,6 @@ parameters:
type: string
maxLength: 32
minLength: 1
claimID:
name: claimID
in: path
description: Идентификатор заявки
required: true
type: integer
format: int64
claimRevision:
name: claimRevision
in: query
description: Версия заявки
required: true
type: integer
format: int32
shopID:
name: shopID
in: path
@ -228,21 +214,6 @@ parameters:
type: string
maxLength: 40
minLength: 1
reportID:
name: reportID
in: path
description: Идентификатор отчета
required: true
type: integer
format: int64
fileID:
name: fileID
in: path
description: Идентификатор файла
required: true
type: string
maxLength: 40
minLength: 1
invoiceID:
name: invoiceID
in: path
@ -280,27 +251,6 @@ parameters:
required: true
type: string
format: date-time
splitUnit:
name: splitUnit
in: query
description: Единица времени сегмента разбиения
required: true
type: string
enum:
- minute
- hour
- day
- week
- month
- year
splitSize:
name: splitSize
in: query
description: Размер сегмента разбиения
required: true
type: integer
format: int32
minimum: 1
limit:
name: limit
in: query
@ -350,18 +300,6 @@ tags:
description: >
Участник системы - совокупность данных о вашей организации, составе и условиях
заключенных договоров, а также информация о связанных с организацией магазинах.
- name: Claims
x-displayName: Заявки
description: >
Некоторая область данных может быть изменена только после премодерации на
стороне платформы. Например, создание и активация новых магазинов,
изменение финансовых данных вашего участника и т.п. требуют ручной
проверки сотрудниками RBKmoney. Попытка изменить такие данные приводит к
автоматическому созданию заявки на изменение данных. До тех пор, пока
заявка не одобрена, вы можете добавлять изменения. После одобрения они
будут применены к набору данных. В случае отказа по заявке данные
останутся в неизменном состоянии. Ближайшим аналогом заявок можно
представить Pull Request в распределенных системах контроля версий.
- name: Shops
x-displayName: Магазины
description: >
@ -653,28 +591,12 @@ tags:
Для получения списка всех инвойсов/платежей указанного магазина необходимо
вызвать соответствующий метод платформы. Имеется возможность отфильтровать
выборку по определенным статусам.
- name: Analytics
x-displayName: Аналитика
description: >
Платформа предоставляет возможность получения различных аналитических
данных, полученных в рамках взаимодействия с ней. Аналитические отчеты
подготовлены заранее и не подразумевают интерактивного изменения структуры
данных.
- name: PaymentInstitutions
x-displayName: Платёжные организации
description: >
Платёжная организация - организация, осуществляющая услуги по обслуживанию
финансовых операций, которые возникают в результате осуществления
бизнес-процессов системой.
- name: Reports
x-displayName: Отчеты
description: >
Один раз в отчетный период платформа автоматически подготавливает и
размещает документы в формате XLSX с разбиением по магазину активной
категории. Также, каждый документ будет подписан [квалифицированной
ЭЦП](http://minsvyaz.ru/ru/appeals/faq/31/). Данная подпись является
юридически значимой и позволяет полностью отказаться от бумажного
документооборота.
- name: Error Codes
x-displayName: Коды ошибок
description: >
@ -718,8 +640,6 @@ tags:
| **inconsistentRefundCurrency** | Попытка возврата средств в валюте, отличной от валюты платежа. |
| **changesetConflict** | Попытка внести изменения участника, конфликтующие с изменениями в других заявках, ожидающих рассмотрения. |
| **invalidChangeset** | Неверные изменения участника, например, попытка создать магазин в валюте, недоступной в рамках договора. |
| **invalidClaimStatus** | Неверный статус заявки. Например, при попытке [отзыва](#operation/revokeClaimByID) уже принятой заявки. |
| **invalidClaimRevision** | Неверная ревизия заявки. Например, в случае если заявку одновременно с вами кто-то уже принял или отклонил. |
| **limitExceeded** | Превышен разумный лимит выборки. В этом случае лучше запросить менее объёмный набор данных. |
| **invalidDeadline** | Неверный формат времени. |
| **chargebackInProgress** | Попытка возврата при открытом возвратном платеже. |