@mojaloop/api-snippets 14.1.0 → 14.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +4 -0
  3. package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml +627 -410
  4. package/lib/sdk-scheme-adapter/outbound/v2_0_0/json-schemas.json +2899 -2463
  5. package/lib/sdk-scheme-adapter/outbound/v2_0_0/openapi.d.ts +3885 -1746
  6. package/lib/sdk-scheme-adapter/outbound/v2_0_0/schemas.d.ts +1260 -892
  7. package/lib/sdk-scheme-adapter/outbound/v2_0_0/schemas.js +15 -12
  8. package/lib/sdk-scheme-adapter/outbound/v2_0_0/schemas.js.map +1 -1
  9. package/lib/sdk-scheme-adapter/outbound/v2_0_0/types.d.ts +15 -12
  10. package/package.json +9 -9
  11. package/sdk-scheme-adapter/outbound/v2_0_0/components/parameters/bulkTransactionId.yaml +2 -2
  12. package/sdk-scheme-adapter/outbound/v2_0_0/components/parameters/bulkTransferId.yaml +8 -0
  13. package/sdk-scheme-adapter/outbound/v2_0_0/components/responses/{bulkTransferAccepted.yaml → bulkTransactionAccepted.yaml} +0 -0
  14. package/sdk-scheme-adapter/outbound/v2_0_0/components/responses/bulkTransactionBadRequest.yaml +5 -0
  15. package/sdk-scheme-adapter/outbound/v2_0_0/components/responses/bulkTransactionPutBadRequest.yaml +7 -0
  16. package/sdk-scheme-adapter/outbound/v2_0_0/components/responses/bulkTransferStatusResponse.yaml +16 -0
  17. package/sdk-scheme-adapter/outbound/v2_0_0/components/responses/bulkTransferSuccess.yaml +5 -0
  18. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/{transactionType.yaml → TransactionType.yaml} +0 -0
  19. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/{bulkAcceptPartyErrorResponse.yaml → bulkTransactionAcceptPartyErrorResponse.yaml} +2 -2
  20. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/{bulkAcceptQuoteErrorResponse.yaml → bulkTransactionAcceptQuoteErrorResponse.yaml} +1 -1
  21. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/{bulkTransferContinuationAcceptParty.yaml → bulkTransactionContinuationAcceptParty.yaml} +1 -1
  22. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/{bulkTransferContinuationAcceptQuote.yaml → bulkTransactionContinuationAcceptQuote.yaml} +1 -1
  23. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/{bulkTransferOptions.yaml → bulkTransactionOptions.yaml} +0 -0
  24. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/bulkTransactionRequest.yaml +27 -0
  25. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/bulkTransactionResponse.yaml +27 -0
  26. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/bulkTransactionStatus.yaml +6 -0
  27. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/bulkTransferRequest.yaml +6 -9
  28. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/bulkTransferResponse.yaml +6 -18
  29. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/bulkTransferStatus.yaml +0 -2
  30. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/individualQuote.yaml +1 -1
  31. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/individualQuoteResult.yaml +1 -1
  32. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/individualTransaction.yaml +31 -0
  33. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/{individualTransferAccept.yaml → individualTransactionAccept.yaml} +0 -0
  34. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/individualTransactionResult.yaml +37 -0
  35. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/individualTransfer.yaml +6 -11
  36. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/individualTransferFulfilment.yaml +13 -0
  37. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/individualTransferResult.yaml +10 -10
  38. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/requestToPayTransferResponse.yaml +1 -1
  39. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/transferRequest.yaml +1 -1
  40. package/sdk-scheme-adapter/outbound/v2_0_0/components/schemas/transferResponse.yaml +1 -1
  41. package/sdk-scheme-adapter/outbound/v2_0_0/openapi.yaml +6 -2
  42. package/sdk-scheme-adapter/outbound/v2_0_0/paths/bulkTransactions.yaml +21 -0
  43. package/sdk-scheme-adapter/outbound/v2_0_0/paths/bulkTransactions_bulkTransactionId.yaml +33 -0
  44. package/sdk-scheme-adapter/outbound/v2_0_0/paths/bulkTransfers.yaml +2 -2
  45. package/sdk-scheme-adapter/outbound/v2_0_0/paths/bulkTransfers_bulkTransferId.yaml +24 -0
  46. package/sdk-scheme-adapter/outbound/v2_0_0/paths/quotes.yaml +1 -1
  47. package/sdk-scheme-adapter/outbound/v2_0_0/components/responses/bulkTransferPutBadRequest.yaml +0 -7
  48. package/sdk-scheme-adapter/outbound/v2_0_0/paths/bulkTransfers_bulkTransactionId.yaml +0 -33
@@ -26,7 +26,7 @@ properties:
26
26
  amount:
27
27
  $ref: ./Amount.yaml
28
28
  transactionType:
29
- $ref: ./transactionType.yaml
29
+ $ref: ./TransactionType.yaml
30
30
  note:
31
31
  $ref: ./Note.yaml
32
32
  currentState:
@@ -24,7 +24,7 @@ properties:
24
24
  amount:
25
25
  $ref: ./Amount.yaml
26
26
  transactionType:
27
- $ref: ./transactionType.yaml
27
+ $ref: ./TransactionType.yaml
28
28
  note:
29
29
  $ref: ./Note.yaml
30
30
  quoteRequestExtensions:
@@ -26,7 +26,7 @@ properties:
26
26
  amount:
27
27
  $ref: ./Amount.yaml
28
28
  transactionType:
29
- $ref: ./transactionType.yaml
29
+ $ref: ./TransactionType.yaml
30
30
  note:
31
31
  $ref: ./Note.yaml
32
32
  currentState:
@@ -26,10 +26,14 @@ paths:
26
26
  $ref: paths/transfers.yaml
27
27
  /transfers/{transferId}:
28
28
  $ref: paths/transfers_transferId.yaml
29
+ /bulkTransactions:
30
+ $ref: paths/bulkTransactions.yaml
31
+ /bulkTransactions/{bulkTransactionId}:
32
+ $ref: paths/bulkTransactions_bulkTransactionId.yaml
29
33
  /bulkTransfers:
30
34
  $ref: paths/bulkTransfers.yaml
31
- /bulkTransfers/{bulkTransactionId}:
32
- $ref: paths/bulkTransfers_bulkTransactionId.yaml
35
+ /bulkTransfers/{bulkTransferId}:
36
+ $ref: paths/bulkTransfers_bulkTransferId.yaml
33
37
  /bulkQuotes:
34
38
  $ref: paths/bulkQuotes.yaml
35
39
  /bulkQuotes/{bulkQuoteId}:
@@ -0,0 +1,21 @@
1
+ post:
2
+ summary: Sends money from one account to multiple accounts
3
+ description: >
4
+ The HTTP request `POST /bulkTransactions` is used to request the movement of
5
+ funds from payer DFSP to payees' DFSP.
6
+ tags:
7
+ - BulkTransactions
8
+ requestBody:
9
+ description: Bulk transfer request body
10
+ content:
11
+ application/json:
12
+ schema:
13
+ $ref: ../components/schemas/bulkTransactionRequest.yaml
14
+ required: true
15
+ responses:
16
+ '202':
17
+ $ref: ../components/responses/bulkTransactionAccepted.yaml
18
+ '400':
19
+ $ref: ../components/responses/bulkTransferBadRequest.yaml
20
+ '500':
21
+ $ref: ../components/responses/errorResponse.yaml
@@ -0,0 +1,33 @@
1
+ put:
2
+ summary: Amends the bulk transaction request
3
+ description: >-
4
+ The HTTP request `PUT /bulkTransactions/{bulkTransactionId}` is used to amend
5
+ information regarding a bulk transaction, i.e. when autoAcceptParty or
6
+ autoAcceptQuote is false then the payer need to provide confirmation to
7
+ proceed with further processing of the request. The `{bulkTransactionId}` in
8
+ the URI should contain the `bulkTransactionId` that was used for the
9
+ creation of the bulk transfer.
10
+ tags:
11
+ - BulkTransactions
12
+ parameters:
13
+ - $ref: ../components/parameters/bulkTransactionId.yaml
14
+ requestBody:
15
+ description: Bulk transaction request body
16
+ content:
17
+ application/json:
18
+ schema:
19
+ oneOf:
20
+ - $ref: ../components/schemas/bulkTransactionContinuationAcceptParty.yaml
21
+ - $ref: ../components/schemas/bulkTransactionContinuationAcceptQuote.yaml
22
+ required: true
23
+ responses:
24
+ '202':
25
+ description: Bulk transaction information successfully amended
26
+ '400':
27
+ $ref: ../components/responses/bulkTransactionPutBadRequest.yaml
28
+ '500':
29
+ description: An error occurred processing the bulk transaction
30
+ content:
31
+ application/json:
32
+ schema:
33
+ $ref: ../components/schemas/errorResponse.yaml
@@ -13,8 +13,8 @@ post:
13
13
  $ref: ../components/schemas/bulkTransferRequest.yaml
14
14
  required: true
15
15
  responses:
16
- '202':
17
- $ref: ../components/responses/bulkTransferAccepted.yaml
16
+ '200':
17
+ $ref: ../components/responses/bulkTransferSuccess.yaml
18
18
  '400':
19
19
  $ref: ../components/responses/bulkTransferBadRequest.yaml
20
20
  '500':
@@ -0,0 +1,24 @@
1
+ get:
2
+ summary: Retrieves information for a specific bulk transfer
3
+ description: >-
4
+ The HTTP request `GET /bulkTransfers/{bulkTransferId}` is used to get
5
+ information regarding a bulk transfer created or requested earlier. The
6
+ `{bulkTransferId}` in the URI should contain the `bulkTransferId` that
7
+ was used for the creation of the bulk transfer.
8
+ tags:
9
+ - BulkTransfers
10
+ parameters:
11
+ - $ref: ../components/parameters/bulkTransferId.yaml
12
+ responses:
13
+ '200':
14
+ description: Bulk transfer information successfully retrieved
15
+ content:
16
+ application/json:
17
+ schema:
18
+ $ref: ../components/responses/bulkTransferStatusResponse.yaml
19
+ '500':
20
+ description: An error occurred processing the bulk transfer
21
+ content:
22
+ application/json:
23
+ schema:
24
+ $ref: ../components/schemas/errorResponse.yaml
@@ -9,7 +9,7 @@ post:
9
9
  content:
10
10
  application/json:
11
11
  schema:
12
- $ref: ../components/schemas/quotesPostRequest.yaml
12
+ $ref: ../components/schemas/QuotesPostRequest.yaml
13
13
  required: true
14
14
  responses:
15
15
  '200':
@@ -1,7 +0,0 @@
1
- description: Malformed or missing required body, headers or parameters
2
- content:
3
- application/json:
4
- schema:
5
- oneOf:
6
- - $ref: ../schemas/bulkAcceptPartyErrorResponse.yaml
7
- - $ref: ../schemas/bulkAcceptQuoteErrorResponse.yaml
@@ -1,33 +0,0 @@
1
- put:
2
- summary: Amends the bulk transfer request
3
- description: >-
4
- The HTTP request `PUT /bulkTransfers/{bulkTransactionId}` is used to amend
5
- information regarding a bulk transfer, i.e. when autoAcceptParty or
6
- autoAcceptQuote is false then the payer need to provide confirmation to
7
- proceed with further processing of the request. The `{bulkTransactionId}` in
8
- the URI should contain the `bulkTransactionId` that was used for the
9
- creation of the bulk transfer.
10
- tags:
11
- - BulkTransfers
12
- parameters:
13
- - $ref: ../components/parameters/bulkTransactionId.yaml
14
- requestBody:
15
- description: Bulk transfer request body
16
- content:
17
- application/json:
18
- schema:
19
- oneOf:
20
- - $ref: ../components/schemas/bulkTransferContinuationAcceptParty.yaml
21
- - $ref: ../components/schemas/bulkTransferContinuationAcceptQuote.yaml
22
- required: true
23
- responses:
24
- '202':
25
- description: Bulk transfer information successfully amended
26
- '400':
27
- $ref: ../components/responses/bulkTransferPutBadRequest.yaml
28
- '500':
29
- description: An error occurred processing the bulk transfer
30
- content:
31
- application/json:
32
- schema:
33
- $ref: ../components/schemas/errorResponse.yaml