@mojaloop/api-snippets 17.7.11 → 18.0.0-snapshot.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 (50) hide show
  1. package/CHANGELOG.md +0 -14
  2. package/docs/sdk-scheme-adapter-backend-v2_1_0-openapi3-snippets.yaml +36 -3
  3. package/docs/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml +34 -2
  4. package/lib/fspiop/v2_0/schemas.js +102 -102
  5. package/lib/fspiop/v2_0/schemas.js.map +1 -1
  6. package/lib/fspiop/v2_0_ISO20022/schemas.js +166 -166
  7. package/lib/fspiop/v2_0_ISO20022/schemas.js.map +1 -1
  8. package/lib/scripts/json-schema-generator.js +2 -6
  9. package/lib/scripts/json-schema-generator.js.map +1 -1
  10. package/lib/sdk-scheme-adapter/v2_0_0/backend/schemas.js +108 -108
  11. package/lib/sdk-scheme-adapter/v2_0_0/backend/schemas.js.map +1 -1
  12. package/lib/sdk-scheme-adapter/v2_0_0/outbound/schemas.js +116 -116
  13. package/lib/sdk-scheme-adapter/v2_0_0/outbound/schemas.js.map +1 -1
  14. package/lib/sdk-scheme-adapter/v2_1_0/backend/json-schemas.json +119 -10
  15. package/lib/sdk-scheme-adapter/v2_1_0/backend/openapi.d.ts +24 -3
  16. package/lib/sdk-scheme-adapter/v2_1_0/backend/schemas.d.ts +101 -0
  17. package/lib/sdk-scheme-adapter/v2_1_0/backend/schemas.js +144 -141
  18. package/lib/sdk-scheme-adapter/v2_1_0/backend/schemas.js.map +1 -1
  19. package/lib/sdk-scheme-adapter/v2_1_0/backend/types.d.ts +3 -0
  20. package/lib/sdk-scheme-adapter/v2_1_0/outbound/json-schemas.json +91 -12
  21. package/lib/sdk-scheme-adapter/v2_1_0/outbound/openapi.d.ts +23 -2
  22. package/lib/sdk-scheme-adapter/v2_1_0/outbound/schemas.d.ts +71 -0
  23. package/lib/sdk-scheme-adapter/v2_1_0/outbound/schemas.js +141 -138
  24. package/lib/sdk-scheme-adapter/v2_1_0/outbound/schemas.js.map +1 -1
  25. package/lib/sdk-scheme-adapter/v2_1_0/outbound/types.d.ts +3 -0
  26. package/package.json +4 -4
  27. package/sdk-scheme-adapter/v2_1_0/backend/openapi.yaml +1 -0
  28. package/sdk-scheme-adapter/v2_1_0/components/schemas/ErrorInformation.yaml +1 -1
  29. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxQuotesPostBackendRequest.yaml +1 -1
  30. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxQuotesPostBackendResponse.yaml +1 -1
  31. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxQuotesPostOutboundRequest.yaml +1 -1
  32. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxQuotesPostOutboundResponse.yaml +1 -1
  33. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxTransfersPostBackendResponse.yaml +1 -1
  34. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxTransfersPostOutboundResponse.yaml +1 -1
  35. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxTransfersPutBackendRequest.yaml +1 -1
  36. package/sdk-scheme-adapter/v2_1_0/components/schemas/PartyIdInfo.yaml +1 -1
  37. package/sdk-scheme-adapter/v2_1_0/components/schemas/QuotesIDPutResponse.yaml +1 -1
  38. package/sdk-scheme-adapter/v2_1_0/components/schemas/QuotesPostRequest.yaml +1 -1
  39. package/sdk-scheme-adapter/v2_1_0/components/schemas/TransactionRequestResponse.yaml +1 -1
  40. package/sdk-scheme-adapter/v2_1_0/components/schemas/TransfersIDPutResponse.yaml +1 -1
  41. package/sdk-scheme-adapter/v2_1_0/components/schemas/TransfersPostRequest.yaml +1 -1
  42. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkQuoteResponse.yaml +1 -1
  43. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransferResponse.yaml +1 -1
  44. package/sdk-scheme-adapter/v2_1_0/components/schemas/individualQuoteResult.yaml +1 -1
  45. package/sdk-scheme-adapter/v2_1_0/components/schemas/individualTransferFulfilment.yaml +1 -1
  46. package/sdk-scheme-adapter/v2_1_0/components/schemas/individualTransferResult.yaml +1 -1
  47. package/sdk-scheme-adapter/v2_1_0/components/schemas/quotesPostResponse.yaml +1 -1
  48. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxCharge.yaml +0 -19
  49. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxConversion.yaml +0 -57
  50. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxMoney.yaml +0 -10
package/lib/sdk-scheme-adapter/v2_1_0/backend/json-schemas.json CHANGED
@@ -431,6 +431,7 @@
431
431
  "items": {
432
432
  "properties": {
433
433
  "key": {
434
+ "maxLength": 32,
434
435
  "minLength": 1,
435
436
  "type": "string"
436
437
  },
@@ -1863,6 +1864,7 @@
1863
1864
  "items": {
1864
1865
  "properties": {
1865
1866
  "key": {
1867
+ "maxLength": 32,
1866
1868
  "minLength": 1,
1867
1869
  "type": "string"
1868
1870
  },
@@ -2163,6 +2165,7 @@
2163
2165
  "items": {
2164
2166
  "properties": {
2165
2167
  "key": {
2168
+ "maxLength": 32,
2166
2169
  "minLength": 1,
2167
2170
  "type": "string"
2168
2171
  },
@@ -2438,6 +2441,7 @@
2438
2441
  "items": {
2439
2442
  "properties": {
2440
2443
  "key": {
2444
+ "maxLength": 32,
2441
2445
  "minLength": 1,
2442
2446
  "type": "string"
2443
2447
  },
@@ -3127,6 +3131,7 @@
3127
3131
  "items": {
3128
3132
  "properties": {
3129
3133
  "key": {
3134
+ "maxLength": 32,
3130
3135
  "minLength": 1,
3131
3136
  "type": "string"
3132
3137
  },
@@ -4996,6 +5001,7 @@
4996
5001
  "items": {
4997
5002
  "properties": {
4998
5003
  "key": {
5004
+ "maxLength": 32,
4999
5005
  "minLength": 1,
5000
5006
  "type": "string"
5001
5007
  },
@@ -5660,6 +5666,7 @@
5660
5666
  "items": {
5661
5667
  "properties": {
5662
5668
  "key": {
5669
+ "maxLength": 32,
5663
5670
  "minLength": 1,
5664
5671
  "type": "string"
5665
5672
  },
@@ -5983,6 +5990,7 @@
5983
5990
  "items": {
5984
5991
  "properties": {
5985
5992
  "key": {
5993
+ "maxLength": 32,
5986
5994
  "minLength": 1,
5987
5995
  "type": "string"
5988
5996
  },
@@ -6232,6 +6240,7 @@
6232
6240
  "items": {
6233
6241
  "properties": {
6234
6242
  "key": {
6243
+ "maxLength": 32,
6235
6244
  "minLength": 1,
6236
6245
  "type": "string"
6237
6246
  },
@@ -6264,6 +6273,7 @@
6264
6273
  "extensionItem": {
6265
6274
  "properties": {
6266
6275
  "key": {
6276
+ "maxLength": 32,
6267
6277
  "minLength": 1,
6268
6278
  "type": "string"
6269
6279
  },
@@ -6279,6 +6289,7 @@
6279
6289
  "items": {
6280
6290
  "properties": {
6281
6291
  "key": {
6292
+ "maxLength": 32,
6282
6293
  "minLength": 1,
6283
6294
  "type": "string"
6284
6295
  },
@@ -6302,6 +6313,7 @@
6302
6313
  "items": {
6303
6314
  "properties": {
6304
6315
  "key": {
6316
+ "maxLength": 32,
6305
6317
  "minLength": 1,
6306
6318
  "type": "string"
6307
6319
  },
@@ -6358,6 +6370,7 @@
6358
6370
  "items": {
6359
6371
  "properties": {
6360
6372
  "key": {
6373
+ "maxLength": 32,
6361
6374
  "minLength": 1,
6362
6375
  "type": "string"
6363
6376
  },
@@ -7067,6 +7080,7 @@
7067
7080
  "items": {
7068
7081
  "properties": {
7069
7082
  "key": {
7083
+ "maxLength": 32,
7070
7084
  "minLength": 1,
7071
7085
  "type": "string"
7072
7086
  },
@@ -7272,6 +7286,7 @@
7272
7286
  "items": {
7273
7287
  "properties": {
7274
7288
  "key": {
7289
+ "maxLength": 32,
7275
7290
  "minLength": 1,
7276
7291
  "type": "string"
7277
7292
  },
@@ -7600,6 +7615,7 @@
7600
7615
  "items": {
7601
7616
  "properties": {
7602
7617
  "key": {
7618
+ "maxLength": 32,
7603
7619
  "minLength": 1,
7604
7620
  "type": "string"
7605
7621
  },
@@ -10916,6 +10932,7 @@
10916
10932
  "items": {
10917
10933
  "properties": {
10918
10934
  "key": {
10935
+ "maxLength": 32,
10919
10936
  "minLength": 1,
10920
10937
  "type": "string"
10921
10938
  },
@@ -15535,6 +15552,7 @@
15535
15552
  "items": {
15536
15553
  "properties": {
15537
15554
  "key": {
15555
+ "maxLength": 32,
15538
15556
  "minLength": 1,
15539
15557
  "type": "string"
15540
15558
  },
@@ -15740,6 +15758,7 @@
15740
15758
  "items": {
15741
15759
  "properties": {
15742
15760
  "key": {
15761
+ "maxLength": 32,
15743
15762
  "minLength": 1,
15744
15763
  "type": "string"
15745
15764
  },
@@ -16068,6 +16087,7 @@
16068
16087
  "items": {
16069
16088
  "properties": {
16070
16089
  "key": {
16090
+ "maxLength": 32,
16071
16091
  "minLength": 1,
16072
16092
  "type": "string"
16073
16093
  },
@@ -16802,6 +16822,7 @@
16802
16822
  "items": {
16803
16823
  "properties": {
16804
16824
  "key": {
16825
+ "maxLength": 32,
16805
16826
  "minLength": 1,
16806
16827
  "type": "string"
16807
16828
  },
@@ -17770,6 +17791,7 @@
17770
17791
  "items": {
17771
17792
  "properties": {
17772
17793
  "key": {
17794
+ "maxLength": 32,
17773
17795
  "minLength": 1,
17774
17796
  "type": "string"
17775
17797
  },
@@ -18086,6 +18108,7 @@
18086
18108
  "items": {
18087
18109
  "properties": {
18088
18110
  "key": {
18111
+ "maxLength": 32,
18089
18112
  "minLength": 1,
18090
18113
  "type": "string"
18091
18114
  },
@@ -18674,6 +18697,7 @@
18674
18697
  "items": {
18675
18698
  "properties": {
18676
18699
  "key": {
18700
+ "maxLength": 32,
18677
18701
  "minLength": 1,
18678
18702
  "type": "string"
18679
18703
  },
@@ -18704,6 +18728,7 @@
18704
18728
  "items": {
18705
18729
  "properties": {
18706
18730
  "key": {
18731
+ "maxLength": 32,
18707
18732
  "minLength": 1,
18708
18733
  "type": "string"
18709
18734
  },
@@ -18998,6 +19023,7 @@
18998
19023
  "items": {
18999
19024
  "properties": {
19000
19025
  "key": {
19026
+ "maxLength": 32,
19001
19027
  "minLength": 1,
19002
19028
  "type": "string"
19003
19029
  },
@@ -19309,6 +19335,7 @@
19309
19335
  "items": {
19310
19336
  "properties": {
19311
19337
  "key": {
19338
+ "maxLength": 32,
19312
19339
  "minLength": 1,
19313
19340
  "type": "string"
19314
19341
  },
@@ -19771,6 +19798,7 @@
19771
19798
  "items": {
19772
19799
  "properties": {
19773
19800
  "key": {
19801
+ "maxLength": 32,
19774
19802
  "minLength": 1,
19775
19803
  "type": "string"
19776
19804
  },
@@ -20995,6 +21023,7 @@
20995
21023
  "items": {
20996
21024
  "properties": {
20997
21025
  "key": {
21026
+ "maxLength": 32,
20998
21027
  "minLength": 1,
20999
21028
  "type": "string"
21000
21029
  },
@@ -21753,6 +21782,7 @@
21753
21782
  "items": {
21754
21783
  "properties": {
21755
21784
  "key": {
21785
+ "maxLength": 32,
21756
21786
  "minLength": 1,
21757
21787
  "type": "string"
21758
21788
  },
@@ -21790,6 +21820,7 @@
21790
21820
  "items": {
21791
21821
  "properties": {
21792
21822
  "key": {
21823
+ "maxLength": 32,
21793
21824
  "minLength": 1,
21794
21825
  "type": "string"
21795
21826
  },
@@ -33530,6 +33561,79 @@
33530
33561
  "chargeType"
33531
33562
  ]
33532
33563
  },
33564
+ "ExtensionKey": {
33565
+ "title": "ExtensionKey",
33566
+ "type": "string",
33567
+ "minLength": 1,
33568
+ "maxLength": 32,
33569
+ "description": "Extension key."
33570
+ },
33571
+ "Extension": {
33572
+ "title": "Extension",
33573
+ "type": "object",
33574
+ "description": "Data model for the complex type Extension.",
33575
+ "properties": {
33576
+ "key": {
33577
+ "title": "ExtensionKey",
33578
+ "type": "string",
33579
+ "minLength": 1,
33580
+ "maxLength": 32,
33581
+ "description": "Extension key."
33582
+ },
33583
+ "value": {
33584
+ "title": "ExtensionValue",
33585
+ "type": "string",
33586
+ "minLength": 1,
33587
+ "maxLength": 128,
33588
+ "description": "Extension value."
33589
+ }
33590
+ },
33591
+ "required": [
33592
+ "key",
33593
+ "value"
33594
+ ]
33595
+ },
33596
+ "ExtensionList": {
33597
+ "title": "ExtensionList",
33598
+ "type": "object",
33599
+ "description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.",
33600
+ "properties": {
33601
+ "extension": {
33602
+ "type": "array",
33603
+ "items": {
33604
+ "title": "Extension",
33605
+ "type": "object",
33606
+ "description": "Data model for the complex type Extension.",
33607
+ "properties": {
33608
+ "key": {
33609
+ "title": "ExtensionKey",
33610
+ "type": "string",
33611
+ "minLength": 1,
33612
+ "maxLength": 32,
33613
+ "description": "Extension key."
33614
+ },
33615
+ "value": {
33616
+ "title": "ExtensionValue",
33617
+ "type": "string",
33618
+ "minLength": 1,
33619
+ "maxLength": 128,
33620
+ "description": "Extension value."
33621
+ }
33622
+ },
33623
+ "required": [
33624
+ "key",
33625
+ "value"
33626
+ ]
33627
+ },
33628
+ "minItems": 1,
33629
+ "maxItems": 16,
33630
+ "description": "Number of Extension elements."
33631
+ }
33632
+ },
33633
+ "required": [
33634
+ "extension"
33635
+ ]
33636
+ },
33533
33637
  "FxConversion": {
33534
33638
  "title": "FxConversion",
33535
33639
  "type": "object",
@@ -34444,14 +34548,15 @@
34444
34548
  "extension": {
34445
34549
  "type": "array",
34446
34550
  "items": {
34447
- "title": "Extension_v2_1_0",
34551
+ "title": "Extension",
34448
34552
  "type": "object",
34449
34553
  "description": "Data model for the complex type Extension.",
34450
34554
  "properties": {
34451
34555
  "key": {
34452
- "title": "ExtensionKey_v2_1_0",
34556
+ "title": "ExtensionKey",
34453
34557
  "type": "string",
34454
34558
  "minLength": 1,
34559
+ "maxLength": 32,
34455
34560
  "description": "Extension key."
34456
34561
  },
34457
34562
  "value": {
@@ -35427,14 +35532,15 @@
35427
35532
  "extension": {
35428
35533
  "type": "array",
35429
35534
  "items": {
35430
- "title": "Extension_v2_1_0",
35535
+ "title": "Extension",
35431
35536
  "type": "object",
35432
35537
  "description": "Data model for the complex type Extension.",
35433
35538
  "properties": {
35434
35539
  "key": {
35435
- "title": "ExtensionKey_v2_1_0",
35540
+ "title": "ExtensionKey",
35436
35541
  "type": "string",
35437
35542
  "minLength": 1,
35543
+ "maxLength": 32,
35438
35544
  "description": "Extension key."
35439
35545
  },
35440
35546
  "value": {
@@ -36411,14 +36517,15 @@
36411
36517
  "extension": {
36412
36518
  "type": "array",
36413
36519
  "items": {
36414
- "title": "Extension_v2_1_0",
36520
+ "title": "Extension",
36415
36521
  "type": "object",
36416
36522
  "description": "Data model for the complex type Extension.",
36417
36523
  "properties": {
36418
36524
  "key": {
36419
- "title": "ExtensionKey_v2_1_0",
36525
+ "title": "ExtensionKey",
36420
36526
  "type": "string",
36421
36527
  "minLength": 1,
36528
+ "maxLength": 32,
36422
36529
  "description": "Extension key."
36423
36530
  },
36424
36531
  "value": {
@@ -37532,14 +37639,15 @@
37532
37639
  "extension": {
37533
37640
  "type": "array",
37534
37641
  "items": {
37535
- "title": "Extension_v2_1_0",
37642
+ "title": "Extension",
37536
37643
  "type": "object",
37537
37644
  "description": "Data model for the complex type Extension.",
37538
37645
  "properties": {
37539
37646
  "key": {
37540
- "title": "ExtensionKey_v2_1_0",
37647
+ "title": "ExtensionKey",
37541
37648
  "type": "string",
37542
37649
  "minLength": 1,
37650
+ "maxLength": 32,
37543
37651
  "description": "Extension key."
37544
37652
  },
37545
37653
  "value": {
@@ -37634,14 +37742,15 @@
37634
37742
  "extension": {
37635
37743
  "type": "array",
37636
37744
  "items": {
37637
- "title": "Extension_v2_1_0",
37745
+ "title": "Extension",
37638
37746
  "type": "object",
37639
37747
  "description": "Data model for the complex type Extension.",
37640
37748
  "properties": {
37641
37749
  "key": {
37642
- "title": "ExtensionKey_v2_1_0",
37750
+ "title": "ExtensionKey",
37643
37751
  "type": "string",
37644
37752
  "minLength": 1,
37753
+ "maxLength": 32,
37645
37754
  "description": "Extension key."
37646
37755
  },
37647
37756
  "value": {
package/lib/sdk-scheme-adapter/v2_1_0/backend/openapi.d.ts CHANGED
@@ -1306,6 +1306,27 @@ export interface components {
1306
1306
  sourceAmount?: components["schemas"]["Money"] & unknown;
1307
1307
  targetAmount?: components["schemas"]["Money"] & unknown;
1308
1308
  };
1309
+ /**
1310
+ * ExtensionKey
1311
+ * @description Extension key.
1312
+ */
1313
+ ExtensionKey: string;
1314
+ /**
1315
+ * Extension
1316
+ * @description Data model for the complex type Extension.
1317
+ */
1318
+ Extension: {
1319
+ key: components["schemas"]["ExtensionKey"];
1320
+ value: components["schemas"]["ExtensionValue"];
1321
+ };
1322
+ /**
1323
+ * ExtensionList
1324
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
1325
+ */
1326
+ ExtensionList: {
1327
+ /** @description Number of Extension elements. */
1328
+ extension: components["schemas"]["Extension"][];
1329
+ };
1309
1330
  /**
1310
1331
  * FxConversion
1311
1332
  * @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.
@@ -1321,7 +1342,7 @@ export interface components {
1321
1342
  expiration: components["schemas"]["DateTime"] & unknown;
1322
1343
  /** @description One or more charges which the FXP intends to levy as part of the currency conversion, or which the payee DFSP intends to add to the amount transferred. */
1323
1344
  charges?: components["schemas"]["FxCharge"][];
1324
- extensionList?: components["schemas"]["ExtensionList_v2_1_0"] & unknown;
1345
+ extensionList?: components["schemas"]["ExtensionList"] & unknown;
1325
1346
  };
1326
1347
  /**
1327
1348
  * FxQuotesPostBackendRequest
@@ -1375,7 +1396,7 @@ export interface components {
1375
1396
  fulfilment?: components["schemas"]["fulfilment"];
1376
1397
  completedTimestamp?: components["schemas"]["completedTimestamp"];
1377
1398
  conversionState: components["schemas"]["conversionState"];
1378
- extensionList?: components["schemas"]["ExtensionList_v2_1_0"];
1399
+ extensionList?: components["schemas"]["ExtensionList"];
1379
1400
  };
1380
1401
  /**
1381
1402
  * FxTransfersPutBackendRequest
@@ -1387,7 +1408,7 @@ export interface components {
1387
1408
  fulfilment?: components["schemas"]["fulfilment"];
1388
1409
  completedTimestamp?: components["schemas"]["completedTimestamp"];
1389
1410
  conversionState: components["schemas"]["conversionState"];
1390
- extensionList?: components["schemas"]["ExtensionList_v2_1_0"];
1411
+ extensionList?: components["schemas"]["ExtensionList"];
1391
1412
  };
1392
1413
  /**
1393
1414
  * fxTransfersPatchBackendRequest