@mojaloop/api-snippets 17.7.8 → 17.7.10
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.
- package/CHANGELOG.md +15 -0
- package/docs/fspiop-rest-v2.0-openapi3-snippets.yaml +146 -146
- package/docs/sdk-scheme-adapter-backend-v2_1_0-openapi3-snippets.yaml +50 -19
- package/docs/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml +60 -29
- package/fspiop/v2_0/openapi3/openapi.yaml +7 -7
- package/lib/fspiop/v2_0/openapi.d.ts +158 -158
- package/lib/sdk-scheme-adapter/v2_1_0/backend/json-schemas.json +177 -155
- package/lib/sdk-scheme-adapter/v2_1_0/backend/openapi.d.ts +39 -18
- package/lib/sdk-scheme-adapter/v2_1_0/backend/schemas.d.ts +68 -54
- package/lib/sdk-scheme-adapter/v2_1_0/backend/schemas.js +6 -3
- package/lib/sdk-scheme-adapter/v2_1_0/backend/schemas.js.map +1 -1
- package/lib/sdk-scheme-adapter/v2_1_0/backend/types.d.ts +6 -3
- package/lib/sdk-scheme-adapter/v2_1_0/outbound/json-schemas.json +287 -320
- package/lib/sdk-scheme-adapter/v2_1_0/outbound/openapi.d.ts +49 -28
- package/lib/sdk-scheme-adapter/v2_1_0/outbound/schemas.d.ts +68 -109
- package/lib/sdk-scheme-adapter/v2_1_0/outbound/schemas.js +6 -3
- package/lib/sdk-scheme-adapter/v2_1_0/outbound/schemas.js.map +1 -1
- package/lib/sdk-scheme-adapter/v2_1_0/outbound/types.d.ts +6 -3
- package/package.json +11 -11
- package/sdk-scheme-adapter/v2_1_0/components/schemas/ErrorInformation.yaml +1 -1
- package/sdk-scheme-adapter/v2_1_0/components/schemas/{ExtensionKey.yaml → ExtensionKey_v2_1_0.yaml} +1 -2
- package/sdk-scheme-adapter/v2_1_0/components/schemas/{ExtensionList.yaml → ExtensionList_v2_1_0.yaml} +1 -1
- package/sdk-scheme-adapter/v2_1_0/components/schemas/{Extension.yaml → Extension_v2_1_0.yaml} +2 -2
- package/sdk-scheme-adapter/v2_1_0/components/schemas/PartyIdInfo.yaml +1 -1
- package/sdk-scheme-adapter/v2_1_0/components/schemas/QuotesIDPutResponse.yaml +1 -1
- package/sdk-scheme-adapter/v2_1_0/components/schemas/QuotesPostRequest.yaml +1 -1
- package/sdk-scheme-adapter/v2_1_0/components/schemas/TransactionRequestResponse.yaml +1 -1
- package/sdk-scheme-adapter/v2_1_0/components/schemas/TransfersIDPutResponse.yaml +1 -1
- package/sdk-scheme-adapter/v2_1_0/components/schemas/TransfersPostRequest.yaml +1 -1
- package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkQuoteRequest.yaml +1 -1
- package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkQuoteResponse.yaml +1 -1
- package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransactionIndividualTransfer.yaml +2 -2
- package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransactionIndividualTransferResult.yaml +2 -2
- package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransactionRequest.yaml +1 -1
- package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransactionResponse.yaml +1 -1
- package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransferRequest.yaml +1 -1
- package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransferResponse.yaml +1 -1
- package/sdk-scheme-adapter/v2_1_0/components/schemas/extensionListEmptiable.yaml +1 -1
- package/sdk-scheme-adapter/v2_1_0/components/schemas/individualQuote.yaml +1 -1
- package/sdk-scheme-adapter/v2_1_0/components/schemas/individualQuoteResult.yaml +1 -1
- package/sdk-scheme-adapter/v2_1_0/components/schemas/individualTransfer.yaml +1 -1
- package/sdk-scheme-adapter/v2_1_0/components/schemas/individualTransferFulfilment.yaml +1 -1
- package/sdk-scheme-adapter/v2_1_0/components/schemas/individualTransferResult.yaml +1 -1
- package/sdk-scheme-adapter/v2_1_0/components/schemas/quotesPostResponse.yaml +1 -1
@@ -809,11 +809,10 @@ components:
|
|
809
809
|
minLength: 1
|
810
810
|
maxLength: 128
|
811
811
|
description: Error description string.
|
812
|
-
|
813
|
-
title:
|
812
|
+
ExtensionKey_v2_1_0:
|
813
|
+
title: ExtensionKey_v2_1_0
|
814
814
|
type: string
|
815
815
|
minLength: 1
|
816
|
-
maxLength: 32
|
817
816
|
description: Extension key.
|
818
817
|
ExtensionValue:
|
819
818
|
title: ExtensionValue
|
@@ -821,19 +820,19 @@ components:
|
|
821
820
|
minLength: 1
|
822
821
|
maxLength: 128
|
823
822
|
description: Extension value.
|
824
|
-
|
825
|
-
title:
|
823
|
+
Extension_v2_1_0:
|
824
|
+
title: Extension_v2_1_0
|
826
825
|
type: object
|
827
826
|
description: Data model for the complex type Extension.
|
828
827
|
properties:
|
829
828
|
key:
|
830
|
-
$ref: '#/components/schemas/
|
829
|
+
$ref: '#/components/schemas/ExtensionKey_v2_1_0'
|
831
830
|
value:
|
832
831
|
$ref: '#/components/schemas/ExtensionValue'
|
833
832
|
required:
|
834
833
|
- key
|
835
834
|
- value
|
836
|
-
|
835
|
+
ExtensionList_v2_1_0:
|
837
836
|
title: ExtensionList
|
838
837
|
type: object
|
839
838
|
description: Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
|
@@ -841,7 +840,7 @@ components:
|
|
841
840
|
extension:
|
842
841
|
type: array
|
843
842
|
items:
|
844
|
-
$ref: '#/components/schemas/
|
843
|
+
$ref: '#/components/schemas/Extension_v2_1_0'
|
845
844
|
minItems: 1
|
846
845
|
maxItems: 16
|
847
846
|
description: Number of Extension elements.
|
@@ -857,7 +856,7 @@ components:
|
|
857
856
|
errorDescription:
|
858
857
|
$ref: '#/components/schemas/ErrorDescription'
|
859
858
|
extensionList:
|
860
|
-
$ref: '#/components/schemas/
|
859
|
+
$ref: '#/components/schemas/ExtensionList_v2_1_0'
|
861
860
|
required:
|
862
861
|
- errorCode
|
863
862
|
- errorDescription
|
@@ -1011,7 +1010,7 @@ components:
|
|
1011
1010
|
extensionListEmptiable:
|
1012
1011
|
type: array
|
1013
1012
|
items:
|
1014
|
-
$ref: '#/components/schemas/
|
1013
|
+
$ref: '#/components/schemas/Extension_v2_1_0'
|
1015
1014
|
minItems: 0
|
1016
1015
|
maxItems: 16
|
1017
1016
|
transferParty:
|
@@ -1111,7 +1110,7 @@ components:
|
|
1111
1110
|
note:
|
1112
1111
|
$ref: '#/components/schemas/Note'
|
1113
1112
|
extensions:
|
1114
|
-
$ref: '#/components/schemas/
|
1113
|
+
$ref: '#/components/schemas/ExtensionList_v2_1_0'
|
1115
1114
|
required:
|
1116
1115
|
- quoteId
|
1117
1116
|
- to
|
@@ -1141,7 +1140,7 @@ components:
|
|
1141
1140
|
items:
|
1142
1141
|
$ref: '#/components/schemas/individualQuote'
|
1143
1142
|
extensions:
|
1144
|
-
$ref: '#/components/schemas/
|
1143
|
+
$ref: '#/components/schemas/ExtensionList_v2_1_0'
|
1145
1144
|
DateTime:
|
1146
1145
|
title: DateTime
|
1147
1146
|
type: string
|
@@ -1232,7 +1231,7 @@ components:
|
|
1232
1231
|
condition:
|
1233
1232
|
$ref: '#/components/schemas/IlpCondition'
|
1234
1233
|
extensionList:
|
1235
|
-
$ref: '#/components/schemas/
|
1234
|
+
$ref: '#/components/schemas/ExtensionList_v2_1_0'
|
1236
1235
|
lastError:
|
1237
1236
|
$ref: '#/components/schemas/quoteError'
|
1238
1237
|
required:
|
@@ -1253,7 +1252,7 @@ components:
|
|
1253
1252
|
expiration:
|
1254
1253
|
$ref: '#/components/schemas/DateTime'
|
1255
1254
|
extensionList:
|
1256
|
-
$ref: '#/components/schemas/
|
1255
|
+
$ref: '#/components/schemas/ExtensionList_v2_1_0'
|
1257
1256
|
currentState:
|
1258
1257
|
$ref: '#/components/schemas/bulkTransferStatus'
|
1259
1258
|
individualQuoteResults:
|
@@ -1367,7 +1366,7 @@ components:
|
|
1367
1366
|
fspId:
|
1368
1367
|
$ref: '#/components/schemas/FspId'
|
1369
1368
|
extensionList:
|
1370
|
-
$ref: '#/components/schemas/
|
1369
|
+
$ref: '#/components/schemas/ExtensionList_v2_1_0'
|
1371
1370
|
required:
|
1372
1371
|
- partyIdType
|
1373
1372
|
- partyIdentifier
|
@@ -1443,9 +1442,9 @@ components:
|
|
1443
1442
|
note:
|
1444
1443
|
$ref: '#/components/schemas/Note'
|
1445
1444
|
quoteExtensions:
|
1446
|
-
$ref: '#/components/schemas/
|
1445
|
+
$ref: '#/components/schemas/ExtensionList_v2_1_0'
|
1447
1446
|
transferExtensions:
|
1448
|
-
$ref: '#/components/schemas/
|
1447
|
+
$ref: '#/components/schemas/ExtensionList_v2_1_0'
|
1449
1448
|
lastError:
|
1450
1449
|
$ref: '#/components/schemas/transferError'
|
1451
1450
|
required:
|
@@ -1479,7 +1478,7 @@ components:
|
|
1479
1478
|
items:
|
1480
1479
|
$ref: '#/components/schemas/bulkTransactionIndividualTransfer'
|
1481
1480
|
extensions:
|
1482
|
-
$ref: '#/components/schemas/
|
1481
|
+
$ref: '#/components/schemas/ExtensionList_v2_1_0'
|
1483
1482
|
TransferState:
|
1484
1483
|
title: TransferState
|
1485
1484
|
type: string
|
@@ -1512,7 +1511,7 @@ components:
|
|
1512
1511
|
fulfilment:
|
1513
1512
|
$ref: '#/components/schemas/IlpFulfilment'
|
1514
1513
|
extensionList:
|
1515
|
-
$ref: '#/components/schemas/
|
1514
|
+
$ref: '#/components/schemas/ExtensionList_v2_1_0'
|
1516
1515
|
transferState:
|
1517
1516
|
$ref: '#/components/schemas/TransferState'
|
1518
1517
|
lastError:
|
@@ -1536,7 +1535,7 @@ components:
|
|
1536
1535
|
completedTimestamp:
|
1537
1536
|
$ref: '#/components/schemas/DateTime'
|
1538
1537
|
extensionList:
|
1539
|
-
$ref: '#/components/schemas/
|
1538
|
+
$ref: '#/components/schemas/ExtensionList_v2_1_0'
|
1540
1539
|
currentState:
|
1541
1540
|
$ref: '#/components/schemas/bulkTransferStatus'
|
1542
1541
|
individualTransferResults:
|
@@ -1667,7 +1666,7 @@ components:
|
|
1667
1666
|
note:
|
1668
1667
|
$ref: '#/components/schemas/Note'
|
1669
1668
|
extensions:
|
1670
|
-
$ref: '#/components/schemas/
|
1669
|
+
$ref: '#/components/schemas/ExtensionList_v2_1_0'
|
1671
1670
|
required:
|
1672
1671
|
- transferId
|
1673
1672
|
- to
|
@@ -1702,7 +1701,7 @@ components:
|
|
1702
1701
|
items:
|
1703
1702
|
$ref: '#/components/schemas/individualTransfer'
|
1704
1703
|
extensions:
|
1705
|
-
$ref: '#/components/schemas/
|
1704
|
+
$ref: '#/components/schemas/ExtensionList_v2_1_0'
|
1706
1705
|
individualTransferFulfilment:
|
1707
1706
|
type: object
|
1708
1707
|
description: A Mojaloop API transfer fulfilment for individual transfers in a bulk transfer
|
@@ -1710,7 +1709,7 @@ components:
|
|
1710
1709
|
fulfilment:
|
1711
1710
|
$ref: '#/components/schemas/IlpFulfilment'
|
1712
1711
|
extensionList:
|
1713
|
-
$ref: '#/components/schemas/
|
1712
|
+
$ref: '#/components/schemas/ExtensionList_v2_1_0'
|
1714
1713
|
bulkTransferStatusResponse:
|
1715
1714
|
type: object
|
1716
1715
|
required:
|
@@ -1887,7 +1886,7 @@ components:
|
|
1887
1886
|
expiration:
|
1888
1887
|
$ref: '#/components/schemas/DateTime'
|
1889
1888
|
extensionList:
|
1890
|
-
$ref: '#/components/schemas/
|
1889
|
+
$ref: '#/components/schemas/ExtensionList_v2_1_0'
|
1891
1890
|
required:
|
1892
1891
|
- quoteId
|
1893
1892
|
- transactionId
|
@@ -1938,7 +1937,7 @@ components:
|
|
1938
1937
|
condition:
|
1939
1938
|
$ref: '#/components/schemas/IlpCondition'
|
1940
1939
|
extensionList:
|
1941
|
-
$ref: '#/components/schemas/
|
1940
|
+
$ref: '#/components/schemas/ExtensionList_v2_1_0'
|
1942
1941
|
required:
|
1943
1942
|
- transferAmount
|
1944
1943
|
- expiration
|
@@ -2047,7 +2046,7 @@ components:
|
|
2047
2046
|
transactionRequestState:
|
2048
2047
|
$ref: '#/components/schemas/TransactionRequestState'
|
2049
2048
|
extensionList:
|
2050
|
-
$ref: '#/components/schemas/
|
2049
|
+
$ref: '#/components/schemas/ExtensionList_v2_1_0'
|
2051
2050
|
required:
|
2052
2051
|
- transactionRequestState
|
2053
2052
|
headers:
|
@@ -2121,7 +2120,7 @@ components:
|
|
2121
2120
|
condition:
|
2122
2121
|
$ref: '#/components/schemas/IlpCondition'
|
2123
2122
|
extensionList:
|
2124
|
-
$ref: '#/components/schemas/
|
2123
|
+
$ref: '#/components/schemas/ExtensionList_v2_1_0'
|
2125
2124
|
required:
|
2126
2125
|
- transferAmount
|
2127
2126
|
- expiration
|
@@ -2158,6 +2157,38 @@ components:
|
|
2158
2157
|
- description: The amount of the charge which is being levied, expressed in the target currency.
|
2159
2158
|
required:
|
2160
2159
|
- chargeType
|
2160
|
+
ExtensionKey:
|
2161
|
+
title: ExtensionKey
|
2162
|
+
type: string
|
2163
|
+
minLength: 1
|
2164
|
+
maxLength: 32
|
2165
|
+
description: Extension key.
|
2166
|
+
Extension:
|
2167
|
+
title: Extension
|
2168
|
+
type: object
|
2169
|
+
description: Data model for the complex type Extension.
|
2170
|
+
properties:
|
2171
|
+
key:
|
2172
|
+
$ref: '#/components/schemas/ExtensionKey'
|
2173
|
+
value:
|
2174
|
+
$ref: '#/components/schemas/ExtensionValue'
|
2175
|
+
required:
|
2176
|
+
- key
|
2177
|
+
- value
|
2178
|
+
ExtensionList:
|
2179
|
+
title: ExtensionList
|
2180
|
+
type: object
|
2181
|
+
description: Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
|
2182
|
+
properties:
|
2183
|
+
extension:
|
2184
|
+
type: array
|
2185
|
+
items:
|
2186
|
+
$ref: '#/components/schemas/Extension'
|
2187
|
+
minItems: 1
|
2188
|
+
maxItems: 16
|
2189
|
+
description: Number of Extension elements.
|
2190
|
+
required:
|
2191
|
+
- extension
|
2161
2192
|
FxConversion:
|
2162
2193
|
title: FxConversion
|
2163
2194
|
type: object
|
@@ -2244,7 +2275,7 @@ components:
|
|
2244
2275
|
transferState:
|
2245
2276
|
$ref: '#/components/schemas/TransferState'
|
2246
2277
|
extensionList:
|
2247
|
-
$ref: '#/components/schemas/
|
2278
|
+
$ref: '#/components/schemas/ExtensionList_v2_1_0'
|
2248
2279
|
required:
|
2249
2280
|
- transferState
|
2250
2281
|
transferResponse:
|
@@ -2565,7 +2596,7 @@ components:
|
|
2565
2596
|
expiration:
|
2566
2597
|
$ref: '#/components/schemas/DateTime'
|
2567
2598
|
extensionList:
|
2568
|
-
$ref: '#/components/schemas/
|
2599
|
+
$ref: '#/components/schemas/ExtensionList_v2_1_0'
|
2569
2600
|
required:
|
2570
2601
|
- transferId
|
2571
2602
|
- payeeFsp
|
@@ -58,6 +58,12 @@ paths:
|
|
58
58
|
responses:
|
59
59
|
200:
|
60
60
|
description: Ok
|
61
|
+
/participants:
|
62
|
+
$ref: 'paths/participants.yaml'
|
63
|
+
/participants/{ID}:
|
64
|
+
$ref: 'paths/participants_ID.yaml'
|
65
|
+
/participants/{ID}/error:
|
66
|
+
$ref: 'paths/participants_ID_error.yaml'
|
61
67
|
/participants/{Type}/{ID}:
|
62
68
|
$ref: 'paths/participants_Type_ID.yaml'
|
63
69
|
/participants/{Type}/{ID}/error:
|
@@ -66,12 +72,6 @@ paths:
|
|
66
72
|
$ref: 'paths/participants_Type_ID_SubId.yaml'
|
67
73
|
/participants/{Type}/{ID}/{SubId}/error:
|
68
74
|
$ref: 'paths/participants_Type_ID_SubId_error.yaml'
|
69
|
-
/participants:
|
70
|
-
$ref: 'paths/participants.yaml'
|
71
|
-
/participants/{ID}:
|
72
|
-
$ref: 'paths/participants_ID.yaml'
|
73
|
-
/participants/{ID}/error:
|
74
|
-
$ref: 'paths/participants_ID_error.yaml'
|
75
75
|
/parties/{Type}/{ID}:
|
76
76
|
$ref: 'paths/parties_Type_ID.yaml'
|
77
77
|
/parties/{Type}/{ID}/error:
|
@@ -133,4 +133,4 @@ paths:
|
|
133
133
|
/services/FXP:
|
134
134
|
$ref: 'paths/services_FXP.yaml'
|
135
135
|
/services/FXP/{SourceCurrency}/{TargetCurrency}:
|
136
|
-
$ref: 'paths/services_FXP_SourceCurrency_TargetCurrency.yaml'
|
136
|
+
$ref: 'paths/services_FXP_SourceCurrency_TargetCurrency.yaml'
|