@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
@@ -928,30 +928,30 @@ export interface components {
|
|
928
928
|
*/
|
929
929
|
ErrorDescription: string;
|
930
930
|
/**
|
931
|
-
*
|
931
|
+
* ExtensionKey_v2_1_0
|
932
932
|
* @description Extension key.
|
933
933
|
*/
|
934
|
-
|
934
|
+
ExtensionKey_v2_1_0: string;
|
935
935
|
/**
|
936
936
|
* ExtensionValue
|
937
937
|
* @description Extension value.
|
938
938
|
*/
|
939
939
|
ExtensionValue: string;
|
940
940
|
/**
|
941
|
-
*
|
941
|
+
* Extension_v2_1_0
|
942
942
|
* @description Data model for the complex type Extension.
|
943
943
|
*/
|
944
|
-
|
945
|
-
key: components["schemas"]["
|
944
|
+
Extension_v2_1_0: {
|
945
|
+
key: components["schemas"]["ExtensionKey_v2_1_0"];
|
946
946
|
value: components["schemas"]["ExtensionValue"];
|
947
947
|
};
|
948
948
|
/**
|
949
949
|
* ExtensionList
|
950
950
|
* @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
|
951
951
|
*/
|
952
|
-
|
952
|
+
ExtensionList_v2_1_0: {
|
953
953
|
/** @description Number of Extension elements. */
|
954
|
-
extension: components["schemas"]["
|
954
|
+
extension: components["schemas"]["Extension_v2_1_0"][];
|
955
955
|
};
|
956
956
|
/**
|
957
957
|
* ErrorInformation
|
@@ -960,7 +960,7 @@ export interface components {
|
|
960
960
|
ErrorInformation: {
|
961
961
|
errorCode: components["schemas"]["ErrorCode"];
|
962
962
|
errorDescription: components["schemas"]["ErrorDescription"];
|
963
|
-
extensionList?: components["schemas"]["
|
963
|
+
extensionList?: components["schemas"]["ExtensionList_v2_1_0"];
|
964
964
|
};
|
965
965
|
mojaloopError: {
|
966
966
|
errorInformation?: components["schemas"]["ErrorInformation"];
|
@@ -1071,7 +1071,7 @@ export interface components {
|
|
1071
1071
|
* }
|
1072
1072
|
*/
|
1073
1073
|
KYCInformation: string;
|
1074
|
-
extensionListEmptiable: components["schemas"]["
|
1074
|
+
extensionListEmptiable: components["schemas"]["Extension_v2_1_0"][];
|
1075
1075
|
transferParty: {
|
1076
1076
|
type?: components["schemas"]["TransactionInitiatorType"];
|
1077
1077
|
idType: components["schemas"]["PartyIdType"];
|
@@ -1135,7 +1135,7 @@ export interface components {
|
|
1135
1135
|
transactionType: components["schemas"]["transferTransactionType"];
|
1136
1136
|
subScenario?: components["schemas"]["TransactionSubScenario"];
|
1137
1137
|
note?: components["schemas"]["Note"];
|
1138
|
-
extensions?: components["schemas"]["
|
1138
|
+
extensions?: components["schemas"]["ExtensionList_v2_1_0"];
|
1139
1139
|
};
|
1140
1140
|
bulkQuoteRequest: {
|
1141
1141
|
/** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
|
@@ -1144,7 +1144,7 @@ export interface components {
|
|
1144
1144
|
from: components["schemas"]["transferParty"];
|
1145
1145
|
/** @description List of individual quotes in a bulk quote. */
|
1146
1146
|
individualQuotes: components["schemas"]["individualQuote"][];
|
1147
|
-
extensions?: components["schemas"]["
|
1147
|
+
extensions?: components["schemas"]["ExtensionList_v2_1_0"];
|
1148
1148
|
};
|
1149
1149
|
/**
|
1150
1150
|
* DateTime
|
@@ -1208,7 +1208,7 @@ export interface components {
|
|
1208
1208
|
geoCode?: components["schemas"]["GeoCode"];
|
1209
1209
|
ilpPacket?: components["schemas"]["IlpPacket"];
|
1210
1210
|
condition?: components["schemas"]["IlpCondition"];
|
1211
|
-
extensionList?: components["schemas"]["
|
1211
|
+
extensionList?: components["schemas"]["ExtensionList_v2_1_0"];
|
1212
1212
|
lastError?: components["schemas"]["quoteError"];
|
1213
1213
|
};
|
1214
1214
|
bulkQuoteResponse: {
|
@@ -1216,7 +1216,7 @@ export interface components {
|
|
1216
1216
|
/** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
|
1217
1217
|
homeTransactionId?: string;
|
1218
1218
|
expiration: components["schemas"]["DateTime"];
|
1219
|
-
extensionList?: components["schemas"]["
|
1219
|
+
extensionList?: components["schemas"]["ExtensionList_v2_1_0"];
|
1220
1220
|
currentState: components["schemas"]["bulkTransferStatus"];
|
1221
1221
|
/** @description List of individualQuoteResults in a bulk transfer response. */
|
1222
1222
|
individualQuoteResults: components["schemas"]["individualQuoteResult"][];
|
@@ -1265,7 +1265,7 @@ export interface components {
|
|
1265
1265
|
partyIdentifier: components["schemas"]["PartyIdentifier"];
|
1266
1266
|
partySubIdOrType?: components["schemas"]["PartySubIdOrType"];
|
1267
1267
|
fspId?: components["schemas"]["FspId"];
|
1268
|
-
extensionList?: components["schemas"]["
|
1268
|
+
extensionList?: components["schemas"]["ExtensionList_v2_1_0"];
|
1269
1269
|
};
|
1270
1270
|
/**
|
1271
1271
|
* PartyName
|
@@ -1316,8 +1316,8 @@ export interface components {
|
|
1316
1316
|
currency: components["schemas"]["Currency"];
|
1317
1317
|
amount: components["schemas"]["Amount"];
|
1318
1318
|
note?: components["schemas"]["Note"];
|
1319
|
-
quoteExtensions?: components["schemas"]["
|
1320
|
-
transferExtensions?: components["schemas"]["
|
1319
|
+
quoteExtensions?: components["schemas"]["ExtensionList_v2_1_0"];
|
1320
|
+
transferExtensions?: components["schemas"]["ExtensionList_v2_1_0"];
|
1321
1321
|
lastError?: components["schemas"]["transferError"];
|
1322
1322
|
};
|
1323
1323
|
bulkTransactionRequest: {
|
@@ -1328,7 +1328,7 @@ export interface components {
|
|
1328
1328
|
from: components["schemas"]["Party"];
|
1329
1329
|
/** @description List of individual transfers in a bulk transfer. */
|
1330
1330
|
individualTransfers: components["schemas"]["bulkTransactionIndividualTransfer"][];
|
1331
|
-
extensions?: components["schemas"]["
|
1331
|
+
extensions?: components["schemas"]["ExtensionList_v2_1_0"];
|
1332
1332
|
};
|
1333
1333
|
/**
|
1334
1334
|
* TransferState
|
@@ -1350,7 +1350,7 @@ export interface components {
|
|
1350
1350
|
individualTransferResult: {
|
1351
1351
|
transferId: components["schemas"]["CorrelationId"];
|
1352
1352
|
fulfilment?: components["schemas"]["IlpFulfilment"];
|
1353
|
-
extensionList?: components["schemas"]["
|
1353
|
+
extensionList?: components["schemas"]["ExtensionList_v2_1_0"];
|
1354
1354
|
transferState?: components["schemas"]["TransferState"];
|
1355
1355
|
lastError?: components["schemas"]["transferError"];
|
1356
1356
|
};
|
@@ -1361,7 +1361,7 @@ export interface components {
|
|
1361
1361
|
homeTransactionId?: string;
|
1362
1362
|
bulkTransferState?: components["schemas"]["TransferState"];
|
1363
1363
|
completedTimestamp?: components["schemas"]["DateTime"];
|
1364
|
-
extensionList?: components["schemas"]["
|
1364
|
+
extensionList?: components["schemas"]["ExtensionList_v2_1_0"];
|
1365
1365
|
currentState: components["schemas"]["bulkTransferStatus"];
|
1366
1366
|
/** @description List of individual transfer result in a bulk transfer response. */
|
1367
1367
|
individualTransferResults: components["schemas"]["individualTransferResult"][];
|
@@ -1418,7 +1418,7 @@ export interface components {
|
|
1418
1418
|
ilpPacket: components["schemas"]["IlpPacket"];
|
1419
1419
|
condition: components["schemas"]["IlpCondition"];
|
1420
1420
|
note?: components["schemas"]["Note"];
|
1421
|
-
extensions?: components["schemas"]["
|
1421
|
+
extensions?: components["schemas"]["ExtensionList_v2_1_0"];
|
1422
1422
|
};
|
1423
1423
|
bulkTransferRequest: {
|
1424
1424
|
/** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
|
@@ -1428,12 +1428,12 @@ export interface components {
|
|
1428
1428
|
from: components["schemas"]["transferParty"];
|
1429
1429
|
/** @description List of individual transfers in a bulk transfer. */
|
1430
1430
|
individualTransfers: components["schemas"]["individualTransfer"][];
|
1431
|
-
extensions?: components["schemas"]["
|
1431
|
+
extensions?: components["schemas"]["ExtensionList_v2_1_0"];
|
1432
1432
|
};
|
1433
1433
|
/** @description A Mojaloop API transfer fulfilment for individual transfers in a bulk transfer */
|
1434
1434
|
individualTransferFulfilment: {
|
1435
1435
|
fulfilment?: components["schemas"]["IlpFulfilment"];
|
1436
|
-
extensionList?: components["schemas"]["
|
1436
|
+
extensionList?: components["schemas"]["ExtensionList_v2_1_0"];
|
1437
1437
|
};
|
1438
1438
|
bulkTransferStatusResponse: {
|
1439
1439
|
bulkTransferId: components["schemas"]["CorrelationId"];
|
@@ -1539,7 +1539,7 @@ export interface components {
|
|
1539
1539
|
geoCode?: components["schemas"]["GeoCode"];
|
1540
1540
|
note?: components["schemas"]["Note"];
|
1541
1541
|
expiration?: components["schemas"]["DateTime"];
|
1542
|
-
extensionList?: components["schemas"]["
|
1542
|
+
extensionList?: components["schemas"]["ExtensionList_v2_1_0"];
|
1543
1543
|
};
|
1544
1544
|
/** simpleQuotesPostRequest */
|
1545
1545
|
simpleQuotesPostRequest: {
|
@@ -1566,7 +1566,7 @@ export interface components {
|
|
1566
1566
|
geoCode?: components["schemas"]["GeoCode"];
|
1567
1567
|
ilpPacket: components["schemas"]["IlpPacket"];
|
1568
1568
|
condition: components["schemas"]["IlpCondition"];
|
1569
|
-
extensionList?: components["schemas"]["
|
1569
|
+
extensionList?: components["schemas"]["ExtensionList_v2_1_0"];
|
1570
1570
|
};
|
1571
1571
|
headers: Record<string, never>;
|
1572
1572
|
};
|
@@ -1624,7 +1624,7 @@ export interface components {
|
|
1624
1624
|
body: {
|
1625
1625
|
transactionId?: components["schemas"]["CorrelationId"];
|
1626
1626
|
transactionRequestState: components["schemas"]["TransactionRequestState"];
|
1627
|
-
extensionList?: components["schemas"]["
|
1627
|
+
extensionList?: components["schemas"]["ExtensionList_v2_1_0"];
|
1628
1628
|
};
|
1629
1629
|
headers: Record<string, never>;
|
1630
1630
|
};
|
@@ -1657,7 +1657,7 @@ export interface components {
|
|
1657
1657
|
geoCode?: components["schemas"]["GeoCode"];
|
1658
1658
|
ilpPacket: components["schemas"]["IlpPacket"];
|
1659
1659
|
condition: components["schemas"]["IlpCondition"];
|
1660
|
-
extensionList?: components["schemas"]["
|
1660
|
+
extensionList?: components["schemas"]["ExtensionList_v2_1_0"];
|
1661
1661
|
};
|
1662
1662
|
/**
|
1663
1663
|
* FxMoney
|
@@ -1677,6 +1677,27 @@ export interface components {
|
|
1677
1677
|
sourceAmount?: components["schemas"]["Money"] & unknown;
|
1678
1678
|
targetAmount?: components["schemas"]["Money"] & unknown;
|
1679
1679
|
};
|
1680
|
+
/**
|
1681
|
+
* ExtensionKey
|
1682
|
+
* @description Extension key.
|
1683
|
+
*/
|
1684
|
+
ExtensionKey: string;
|
1685
|
+
/**
|
1686
|
+
* Extension
|
1687
|
+
* @description Data model for the complex type Extension.
|
1688
|
+
*/
|
1689
|
+
Extension: {
|
1690
|
+
key: components["schemas"]["ExtensionKey"];
|
1691
|
+
value: components["schemas"]["ExtensionValue"];
|
1692
|
+
};
|
1693
|
+
/**
|
1694
|
+
* ExtensionList
|
1695
|
+
* @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
|
1696
|
+
*/
|
1697
|
+
ExtensionList: {
|
1698
|
+
/** @description Number of Extension elements. */
|
1699
|
+
extension: components["schemas"]["Extension"][];
|
1700
|
+
};
|
1680
1701
|
/**
|
1681
1702
|
* FxConversion
|
1682
1703
|
* @description A DFSP will be able to request a currency conversion, and an FX provider will be able to describe its involvement in a proposed transfer, using a FxConversion object.
|
@@ -1712,7 +1733,7 @@ export interface components {
|
|
1712
1733
|
fulfilment?: components["schemas"]["IlpFulfilment"];
|
1713
1734
|
completedTimestamp?: components["schemas"]["DateTime"];
|
1714
1735
|
transferState: components["schemas"]["TransferState"];
|
1715
|
-
extensionList?: components["schemas"]["
|
1736
|
+
extensionList?: components["schemas"]["ExtensionList_v2_1_0"];
|
1716
1737
|
};
|
1717
1738
|
transferResponse: {
|
1718
1739
|
transferId?: components["schemas"]["CorrelationId"];
|
@@ -1865,7 +1886,7 @@ export interface components {
|
|
1865
1886
|
ilpPacket: components["schemas"]["IlpPacket"];
|
1866
1887
|
condition: components["schemas"]["IlpCondition"];
|
1867
1888
|
expiration: components["schemas"]["DateTime"];
|
1868
|
-
extensionList?: components["schemas"]["
|
1889
|
+
extensionList?: components["schemas"]["ExtensionList_v2_1_0"];
|
1869
1890
|
};
|
1870
1891
|
/** SimpleTransfersPostRequest */
|
1871
1892
|
simpleTransfersPostRequest: {
|