@mojaloop/api-snippets 18.0.0-snapshot.0 → 18.0.0-snapshot.2

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 (74) hide show
  1. package/CHANGELOG.md +35 -0
  2. package/CODEOWNERS +1 -1
  3. package/LICENSE.md +1 -1
  4. package/audit-ci.jsonc +2 -4
  5. package/docs/sdk-scheme-adapter-backend-v2_1_0-openapi3-snippets.yaml +3 -36
  6. package/docs/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml +90 -56
  7. package/lib/fspiop/v2_0/schemas.js +102 -102
  8. package/lib/fspiop/v2_0/schemas.js.map +1 -1
  9. package/lib/fspiop/v2_0_ISO20022/schemas.js +166 -166
  10. package/lib/fspiop/v2_0_ISO20022/schemas.js.map +1 -1
  11. package/lib/scripts/json-schema-generator.d.ts +7 -6
  12. package/lib/scripts/json-schema-generator.js +13 -8
  13. package/lib/scripts/json-schema-generator.js.map +1 -1
  14. package/lib/scripts/openapi-refactor.d.ts +7 -6
  15. package/lib/scripts/openapi-refactor.js +7 -6
  16. package/lib/scripts/openapi-refactor.js.map +1 -1
  17. package/lib/sdk-scheme-adapter/index.d.ts +7 -6
  18. package/lib/sdk-scheme-adapter/index.js +7 -6
  19. package/lib/sdk-scheme-adapter/index.js.map +1 -1
  20. package/lib/sdk-scheme-adapter/v2_0_0/backend/schemas.js +108 -108
  21. package/lib/sdk-scheme-adapter/v2_0_0/backend/schemas.js.map +1 -1
  22. package/lib/sdk-scheme-adapter/v2_0_0/index.d.ts +7 -6
  23. package/lib/sdk-scheme-adapter/v2_0_0/index.js +7 -6
  24. package/lib/sdk-scheme-adapter/v2_0_0/index.js.map +1 -1
  25. package/lib/sdk-scheme-adapter/v2_0_0/outbound/schemas.js +116 -116
  26. package/lib/sdk-scheme-adapter/v2_0_0/outbound/schemas.js.map +1 -1
  27. package/lib/sdk-scheme-adapter/v2_1_0/backend/json-schemas.json +10 -119
  28. package/lib/sdk-scheme-adapter/v2_1_0/backend/openapi.d.ts +3 -24
  29. package/lib/sdk-scheme-adapter/v2_1_0/backend/schemas.d.ts +0 -101
  30. package/lib/sdk-scheme-adapter/v2_1_0/backend/schemas.js +141 -144
  31. package/lib/sdk-scheme-adapter/v2_1_0/backend/schemas.js.map +1 -1
  32. package/lib/sdk-scheme-adapter/v2_1_0/backend/types.d.ts +0 -3
  33. package/lib/sdk-scheme-adapter/v2_1_0/outbound/json-schemas.json +27 -91
  34. package/lib/sdk-scheme-adapter/v2_1_0/outbound/openapi.d.ts +121 -31
  35. package/lib/sdk-scheme-adapter/v2_1_0/outbound/schemas.d.ts +10 -71
  36. package/lib/sdk-scheme-adapter/v2_1_0/outbound/schemas.js +139 -141
  37. package/lib/sdk-scheme-adapter/v2_1_0/outbound/schemas.js.map +1 -1
  38. package/lib/sdk-scheme-adapter/v2_1_0/outbound/types.d.ts +1 -3
  39. package/package.json +14 -13
  40. package/sdk-scheme-adapter/v2_1_0/backend/openapi.yaml +0 -1
  41. package/sdk-scheme-adapter/v2_1_0/components/responses/accountDeletionCompleted.yaml +5 -0
  42. package/sdk-scheme-adapter/v2_1_0/components/responses/accountDeletionError.yaml +5 -0
  43. package/sdk-scheme-adapter/v2_1_0/components/responses/accountDeletionTimeout.yaml +5 -0
  44. package/sdk-scheme-adapter/v2_1_0/components/schemas/ErrorInformation.yaml +1 -1
  45. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxCharge.yaml +19 -0
  46. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxConversion.yaml +57 -0
  47. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxMoney.yaml +10 -0
  48. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxQuotesPostBackendRequest.yaml +1 -1
  49. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxQuotesPostBackendResponse.yaml +1 -1
  50. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxQuotesPostOutboundRequest.yaml +1 -1
  51. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxQuotesPostOutboundResponse.yaml +1 -1
  52. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxTransfersPostBackendResponse.yaml +1 -1
  53. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxTransfersPostOutboundResponse.yaml +1 -1
  54. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxTransfersPutBackendRequest.yaml +1 -1
  55. package/sdk-scheme-adapter/v2_1_0/components/schemas/PartyIdInfo.yaml +1 -1
  56. package/sdk-scheme-adapter/v2_1_0/components/schemas/QuotesIDPutResponse.yaml +1 -1
  57. package/sdk-scheme-adapter/v2_1_0/components/schemas/QuotesPostRequest.yaml +1 -1
  58. package/sdk-scheme-adapter/v2_1_0/components/schemas/TransactionRequestResponse.yaml +1 -1
  59. package/sdk-scheme-adapter/v2_1_0/components/schemas/TransfersIDPutResponse.yaml +1 -1
  60. package/sdk-scheme-adapter/v2_1_0/components/schemas/TransfersPostRequest.yaml +1 -1
  61. package/sdk-scheme-adapter/v2_1_0/components/schemas/accountDeletionResponse.yaml +23 -0
  62. package/sdk-scheme-adapter/v2_1_0/components/schemas/accountDeletionState.yaml +4 -0
  63. package/sdk-scheme-adapter/v2_1_0/components/schemas/accountDeletionStatus.yaml +10 -0
  64. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkQuoteResponse.yaml +1 -1
  65. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransferResponse.yaml +1 -1
  66. package/sdk-scheme-adapter/v2_1_0/components/schemas/individualQuoteResult.yaml +1 -1
  67. package/sdk-scheme-adapter/v2_1_0/components/schemas/individualTransferFulfilment.yaml +1 -1
  68. package/sdk-scheme-adapter/v2_1_0/components/schemas/individualTransferResult.yaml +1 -1
  69. package/sdk-scheme-adapter/v2_1_0/components/schemas/quotesPostResponse.yaml +1 -1
  70. package/sdk-scheme-adapter/v2_1_0/components/schemas/transferContinuationAcceptQuoteOrConversion.yaml +9 -0
  71. package/sdk-scheme-adapter/v2_1_0/outbound/openapi.yaml +4 -0
  72. package/sdk-scheme-adapter/v2_1_0/outbound/paths/accounts_Type_ID.yaml +19 -0
  73. package/sdk-scheme-adapter/v2_1_0/outbound/paths/accounts_Type_ID_SubId.yaml +20 -0
  74. package/sdk-scheme-adapter/v2_1_0/outbound/paths/transfers_transferId.yaml +2 -1
package/sdk-scheme-adapter/v2_1_0/components/schemas/FxTransfersPostOutboundResponse.yaml CHANGED
@@ -12,6 +12,6 @@ properties:
12
12
  conversionState:
13
13
  $ref: "../../../../fspiop/v2_0/openapi3/components/schemas/FxTransfersIDPutResponse.yaml#/properties/conversionState"
14
14
  extensionList:
15
- $ref: "../../../../fspiop/v2_0/openapi3/components/schemas/FxTransfersIDPutResponse.yaml#/properties/extensionList"
15
+ $ref: "./ExtensionList_v2_1_0.yaml"
16
16
  required:
17
17
  - conversionState
package/sdk-scheme-adapter/v2_1_0/components/schemas/FxTransfersPutBackendRequest.yaml CHANGED
@@ -12,6 +12,6 @@ properties:
12
12
  conversionState:
13
13
  $ref: "../../../../fspiop/v2_0/openapi3/components/schemas/FxTransfersIDPutResponse.yaml#/properties/conversionState"
14
14
  extensionList:
15
- $ref: "../../../../fspiop/v2_0/openapi3/components/schemas/FxTransfersIDPutResponse.yaml#/properties/extensionList"
15
+ $ref: "./ExtensionList_v2_1_0.yaml"
16
16
  required:
17
17
  - conversionState
package/sdk-scheme-adapter/v2_1_0/components/schemas/PartyIdInfo.yaml CHANGED
@@ -13,7 +13,7 @@ properties:
13
13
  fspId:
14
14
  $ref: ./FspId.yaml
15
15
  extensionList:
16
- $ref: ExtensionList_v2_1_0.yaml
16
+ $ref: ./ExtensionList_v2_1_0.yaml
17
17
  required:
18
18
  - partyIdType
19
19
  - partyIdentifier
package/sdk-scheme-adapter/v2_1_0/components/schemas/QuotesIDPutResponse.yaml CHANGED
@@ -19,7 +19,7 @@ properties:
19
19
  condition:
20
20
  $ref: ./IlpCondition.yaml
21
21
  extensionList:
22
- $ref: ExtensionList_v2_1_0.yaml
22
+ $ref: ./ExtensionList_v2_1_0.yaml
23
23
  required:
24
24
  - transferAmount
25
25
  - expiration
package/sdk-scheme-adapter/v2_1_0/components/schemas/QuotesPostRequest.yaml CHANGED
@@ -42,7 +42,7 @@ properties:
42
42
  expiration:
43
43
  $ref: ./DateTime.yaml
44
44
  extensionList:
45
- $ref: ExtensionList_v2_1_0.yaml
45
+ $ref: ./ExtensionList_v2_1_0.yaml
46
46
  required:
47
47
  - quoteId
48
48
  - transactionId
package/sdk-scheme-adapter/v2_1_0/components/schemas/TransactionRequestResponse.yaml CHANGED
@@ -10,7 +10,7 @@ properties:
10
10
  transactionRequestState:
11
11
  $ref: ./TransactionRequestState.yaml
12
12
  extensionList:
13
- $ref: ExtensionList_v2_1_0.yaml
13
+ $ref: ./ExtensionList_v2_1_0.yaml
14
14
  required:
15
15
  - transactionRequestState
16
16
  headers:
package/sdk-scheme-adapter/v2_1_0/components/schemas/TransfersIDPutResponse.yaml CHANGED
@@ -9,6 +9,6 @@ properties:
9
9
  transferState:
10
10
  $ref: ./TransferState.yaml
11
11
  extensionList:
12
- $ref: ExtensionList_v2_1_0.yaml
12
+ $ref: ./ExtensionList_v2_1_0.yaml
13
13
  required:
14
14
  - transferState
package/sdk-scheme-adapter/v2_1_0/components/schemas/TransfersPostRequest.yaml CHANGED
@@ -17,7 +17,7 @@ properties:
17
17
  expiration:
18
18
  $ref: ./DateTime.yaml
19
19
  extensionList:
20
- $ref: ExtensionList_v2_1_0.yaml
20
+ $ref: ./ExtensionList_v2_1_0.yaml
21
21
  required:
22
22
  - transferId
23
23
  - payeeFsp
package/sdk-scheme-adapter/v2_1_0/components/schemas/accountDeletionResponse.yaml ADDED
@@ -0,0 +1,23 @@
1
+ type: object
2
+ required:
3
+ - accounts
4
+ properties:
5
+ modelId:
6
+ $ref: ./CorrelationId.yaml
7
+ fspId:
8
+ $ref: ./FspId.yaml
9
+ response:
10
+ $ref: ./accountDeletionStatus.yaml
11
+ currentState:
12
+ $ref: ./accountDeletionState.yaml
13
+ lastError:
14
+ $ref: ./transferError.yaml
15
+ postAccountsResponse:
16
+ type: object
17
+ required:
18
+ - body
19
+ properties:
20
+ body:
21
+ type: object
22
+ headers:
23
+ type: object
package/sdk-scheme-adapter/v2_1_0/components/schemas/accountDeletionState.yaml ADDED
@@ -0,0 +1,4 @@
1
+ type: string
2
+ enum:
3
+ - ERROR_OCCURRED
4
+ - COMPLETED
package/sdk-scheme-adapter/v2_1_0/components/schemas/accountDeletionStatus.yaml ADDED
@@ -0,0 +1,10 @@
1
+ type: array
2
+ items:
3
+ type: object
4
+ required:
5
+ - fspId
6
+ properties:
7
+ fspId:
8
+ $ref: ./FspId.yaml
9
+ error:
10
+ $ref: ./errorResponse.yaml
package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkQuoteResponse.yaml CHANGED
@@ -15,7 +15,7 @@ properties:
15
15
  expiration:
16
16
  $ref: ./DateTime.yaml
17
17
  extensionList:
18
- $ref: ExtensionList_v2_1_0.yaml
18
+ $ref: ./ExtensionList_v2_1_0.yaml
19
19
  currentState:
20
20
  $ref: ../schemas/bulkTransferStatus.yaml
21
21
  individualQuoteResults:
package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransferResponse.yaml CHANGED
@@ -18,7 +18,7 @@ properties:
18
18
  completedTimestamp:
19
19
  $ref: ./DateTime.yaml
20
20
  extensionList:
21
- $ref: ExtensionList_v2_1_0.yaml
21
+ $ref: ./ExtensionList_v2_1_0.yaml
22
22
  currentState:
23
23
  $ref: ../schemas/bulkTransferStatus.yaml
24
24
  individualTransferResults:
package/sdk-scheme-adapter/v2_1_0/components/schemas/individualQuoteResult.yaml CHANGED
@@ -17,7 +17,7 @@ properties:
17
17
  condition:
18
18
  $ref: ./IlpCondition.yaml
19
19
  extensionList:
20
- $ref: ExtensionList_v2_1_0.yaml
20
+ $ref: ./ExtensionList_v2_1_0.yaml
21
21
  lastError:
22
22
  $ref: ./quoteError.yaml
23
23
  required:
package/sdk-scheme-adapter/v2_1_0/components/schemas/individualTransferFulfilment.yaml CHANGED
@@ -6,4 +6,4 @@ properties:
6
6
  fulfilment:
7
7
  $ref: ./IlpFulfilment.yaml
8
8
  extensionList:
9
- $ref: ExtensionList_v2_1_0.yaml
9
+ $ref: ./ExtensionList_v2_1_0.yaml
package/sdk-scheme-adapter/v2_1_0/components/schemas/individualTransferResult.yaml CHANGED
@@ -7,7 +7,7 @@ properties:
7
7
  fulfilment:
8
8
  $ref: ./IlpFulfilment.yaml
9
9
  extensionList:
10
- $ref: ExtensionList_v2_1_0.yaml
10
+ $ref: ./ExtensionList_v2_1_0.yaml
11
11
  transferState:
12
12
  $ref: ./TransferState.yaml
13
13
  lastError:
package/sdk-scheme-adapter/v2_1_0/components/schemas/quotesPostResponse.yaml CHANGED
@@ -30,7 +30,7 @@ properties:
30
30
  condition:
31
31
  $ref: ./IlpCondition.yaml
32
32
  extensionList:
33
- $ref: ExtensionList_v2_1_0.yaml
33
+ $ref: ./ExtensionList_v2_1_0.yaml
34
34
  required:
35
35
  - transferAmount
36
36
  - expiration
package/sdk-scheme-adapter/v2_1_0/components/schemas/transferContinuationAcceptQuoteOrConversion.yaml ADDED
@@ -0,0 +1,9 @@
1
+ type: object
2
+ required:
3
+ - acceptQuoteOrConversion
4
+ properties:
5
+ acceptQuoteOrConversion:
6
+ type: boolean
7
+ enum:
8
+ - true
9
+ - false
package/sdk-scheme-adapter/v2_1_0/outbound/openapi.yaml CHANGED
@@ -24,6 +24,10 @@ paths:
24
24
  $ref: paths.yaml
25
25
  /accounts:
26
26
  $ref: paths/accounts.yaml
27
+ /accounts/{Type}/{ID}:
28
+ $ref: paths/accounts_Type_ID.yaml
29
+ /accounts/{Type}/{ID}/{SubId}:
30
+ $ref: paths/accounts_Type_ID_SubId.yaml
27
31
  /bulkQuotes:
28
32
  $ref: paths/bulkQuotes.yaml
29
33
  /bulkQuotes/{bulkQuoteId}:
package/sdk-scheme-adapter/v2_1_0/outbound/paths/accounts_Type_ID.yaml ADDED
@@ -0,0 +1,19 @@
1
+ delete:
2
+ summary: Delete account on the Account Lookup Service
3
+ description: >-
4
+ The HTTP request `DELETE /accounts/{Type}/{ID}/{SubId}` is used to account account information on
5
+ the Account Lookup Service (ALS) by Type and ID (and optionally SubId).
6
+ tags:
7
+ - Accounts
8
+ parameters:
9
+ - $ref: ../../components/parameters/Type.yaml
10
+ - $ref: ../../components/parameters/ID.yaml
11
+ responses:
12
+ '200':
13
+ $ref: ../../components/responses/accountDeletionCompleted.yaml
14
+ '400':
15
+ $ref: ../../components/responses/accountDeletionError.yaml
16
+ '500':
17
+ $ref: ../../components/responses/accountDeletionError.yaml
18
+ '504':
19
+ $ref: ../../components/responses/accountDeletionTimeout.yaml
package/sdk-scheme-adapter/v2_1_0/outbound/paths/accounts_Type_ID_SubId.yaml ADDED
@@ -0,0 +1,20 @@
1
+ delete:
2
+ summary: Delete account on the Account Lookup Service
3
+ description: >-
4
+ The HTTP request `DELETE /accounts/{Type}/{ID}/{SubId}` is used to account account information on
5
+ the Account Lookup Service (ALS) by Type and ID (and optionally SubId).
6
+ tags:
7
+ - Accounts
8
+ parameters:
9
+ - $ref: ../../components/parameters/Type.yaml
10
+ - $ref: ../../components/parameters/ID.yaml
11
+ - $ref: ../../components/parameters/SubId.yaml
12
+ responses:
13
+ '200':
14
+ $ref: ../../components/responses/accountDeletionCompleted.yaml
15
+ '400':
16
+ $ref: ../../components/responses/accountDeletionError.yaml
17
+ '500':
18
+ $ref: ../../components/responses/accountDeletionError.yaml
19
+ '504':
20
+ $ref: ../../components/responses/accountDeletionTimeout.yaml
package/sdk-scheme-adapter/v2_1_0/outbound/paths/transfers_transferId.yaml CHANGED
@@ -8,7 +8,7 @@ put:
8
8
  party lookup and/or quotation stage and/or currency conversion stage.
9
9
 
10
10
 
11
- The request body should contain either the "acceptParty" or "acceptQuote" or "acceptConversion"
11
+ The request body should contain either the "acceptParty" or "acceptQuote" or "acceptConversion" or "acceptQuoteOrConversion"
12
12
  property set to `true` as required to continue the transfer.
13
13
 
14
14
 
@@ -24,6 +24,7 @@ put:
24
24
  - $ref: ../../components/schemas/transferContinuationAcceptParty.yaml
25
25
  - $ref: ../../components/schemas/transferContinuationAcceptQuote.yaml
26
26
  - $ref: ../../components/schemas/transferContinuationAcceptConversion.yaml
27
+ - $ref: ../../components/schemas/transferContinuationAcceptQuoteOrConversion.yaml
27
28
  parameters:
28
29
  - $ref: ../../components/parameters/transferId.yaml
29
30
  responses: