@mojaloop/api-snippets 17.3.0-snapshot.0 → 17.3.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 (248) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +0 -12
  3. package/audit-ci.jsonc +1 -1
  4. package/docs/fspiop-rest-v1.0-openapi3-snippets.yaml +205 -805
  5. package/docs/fspiop-rest-v1.1-openapi3-snippets.yaml +2432 -2447
  6. package/docs/fspiop-rest-v2.0-openapi3-snippets.yaml +3149 -3163
  7. package/docs/index.html +0 -4
  8. package/docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml +103 -346
  9. package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml +153 -478
  10. package/docs/thirdparty-openapi3-snippets.yaml +296 -886
  11. package/fspiop/v1_0/openapi3/components/schemas/PartiesTypeIDPutResponse.yaml +1 -0
  12. package/fspiop/v1_1/openapi3/openapi.yaml +10 -2
  13. package/fspiop/v2_0/openapi3/openapi.yaml +11 -1
  14. package/lib/fspiop/v1_0/openapi.d.ts +1 -0
  15. package/lib/fspiop/v1_1/openapi.d.ts +524 -542
  16. package/lib/fspiop/v2_0/openapi.d.ts +685 -703
  17. package/lib/scripts/openapi-refactor.d.ts +29 -0
  18. package/lib/scripts/openapi-refactor.js +70 -0
  19. package/lib/scripts/openapi-refactor.js.map +1 -0
  20. package/lib/sdk-scheme-adapter/v2_0_0/backend/json-schemas.json +7 -7
  21. package/lib/sdk-scheme-adapter/v2_0_0/backend/openapi.d.ts +1 -1
  22. package/lib/sdk-scheme-adapter/v2_0_0/outbound/json-schemas.json +12 -12
  23. package/lib/sdk-scheme-adapter/v2_0_0/outbound/openapi.d.ts +7 -1
  24. package/package.json +24 -30
  25. package/sdk-scheme-adapter/v2_0_0/components/schemas/getPartiesResponse.yaml +1 -0
  26. package/sdk-scheme-adapter/v2_0_0/components/schemas/partiesByIdResponse.yaml +1 -0
  27. package/sdk-scheme-adapter/v2_0_0/components/schemas/requestToPayResponse.yaml +5 -0
  28. package/sdk-scheme-adapter/v2_0_0/components/schemas/requestToPayTransferResponse.yaml +5 -0
  29. package/sdk-scheme-adapter/v2_0_0/components/schemas/simpleQuotesPostRequest.yaml +1 -0
  30. package/sdk-scheme-adapter/v2_0_0/components/schemas/transferError.yaml +2 -3
  31. package/sdk-scheme-adapter/v2_0_0/components/schemas/transferResponse.yaml +5 -0
  32. package/docs/sdk-scheme-adapter-backend-v2_1_0-openapi3-snippets.yaml +0 -2837
  33. package/docs/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml +0 -3451
  34. package/lib/sdk-scheme-adapter/v2_1_0/backend/json-schemas.json +0 -26898
  35. package/lib/sdk-scheme-adapter/v2_1_0/backend/openapi.d.ts +0 -1476
  36. package/lib/sdk-scheme-adapter/v2_1_0/backend/openapi.js +0 -7
  37. package/lib/sdk-scheme-adapter/v2_1_0/backend/openapi.js.map +0 -1
  38. package/lib/sdk-scheme-adapter/v2_1_0/backend/schemas.d.ts +0 -8814
  39. package/lib/sdk-scheme-adapter/v2_1_0/backend/schemas.js +0 -140
  40. package/lib/sdk-scheme-adapter/v2_1_0/backend/schemas.js.map +0 -1
  41. package/lib/sdk-scheme-adapter/v2_1_0/backend/types.d.ts +0 -133
  42. package/lib/sdk-scheme-adapter/v2_1_0/backend/types.js +0 -4
  43. package/lib/sdk-scheme-adapter/v2_1_0/backend/types.js.map +0 -1
  44. package/lib/sdk-scheme-adapter/v2_1_0/outbound/json-schemas.json +0 -38718
  45. package/lib/sdk-scheme-adapter/v2_1_0/outbound/openapi.d.ts +0 -1897
  46. package/lib/sdk-scheme-adapter/v2_1_0/outbound/openapi.js +0 -7
  47. package/lib/sdk-scheme-adapter/v2_1_0/outbound/openapi.js.map +0 -1
  48. package/lib/sdk-scheme-adapter/v2_1_0/outbound/schemas.d.ts +0 -15536
  49. package/lib/sdk-scheme-adapter/v2_1_0/outbound/schemas.js +0 -149
  50. package/lib/sdk-scheme-adapter/v2_1_0/outbound/schemas.js.map +0 -1
  51. package/lib/sdk-scheme-adapter/v2_1_0/outbound/types.d.ts +0 -142
  52. package/lib/sdk-scheme-adapter/v2_1_0/outbound/types.js +0 -4
  53. package/lib/sdk-scheme-adapter/v2_1_0/outbound/types.js.map +0 -1
  54. package/sdk-scheme-adapter/v2_1_0/backend/openapi.yaml +0 -1494
  55. package/sdk-scheme-adapter/v2_1_0/backend/paths/fxQuotes.yaml +0 -26
  56. package/sdk-scheme-adapter/v2_1_0/backend/paths/fxTransfers.yaml +0 -25
  57. package/sdk-scheme-adapter/v2_1_0/backend/paths/fxTransfersById.yaml +0 -21
  58. package/sdk-scheme-adapter/v2_1_0/components/parameters/ID.yaml +0 -6
  59. package/sdk-scheme-adapter/v2_1_0/components/parameters/SubId.yaml +0 -8
  60. package/sdk-scheme-adapter/v2_1_0/components/parameters/Type.yaml +0 -6
  61. package/sdk-scheme-adapter/v2_1_0/components/parameters/bulkQuoteId.yaml +0 -8
  62. package/sdk-scheme-adapter/v2_1_0/components/parameters/bulkTransactionId.yaml +0 -8
  63. package/sdk-scheme-adapter/v2_1_0/components/parameters/bulkTransferId.yaml +0 -8
  64. package/sdk-scheme-adapter/v2_1_0/components/parameters/transactionRequestId.yaml +0 -8
  65. package/sdk-scheme-adapter/v2_1_0/components/parameters/transferId.yaml +0 -8
  66. package/sdk-scheme-adapter/v2_1_0/components/responses/200.yaml +0 -1
  67. package/sdk-scheme-adapter/v2_1_0/components/responses/400.yaml +0 -5
  68. package/sdk-scheme-adapter/v2_1_0/components/responses/404.yaml +0 -5
  69. package/sdk-scheme-adapter/v2_1_0/components/responses/500.yaml +0 -5
  70. package/sdk-scheme-adapter/v2_1_0/components/responses/accountsCreationCompleted.yaml +0 -5
  71. package/sdk-scheme-adapter/v2_1_0/components/responses/accountsCreationError.yaml +0 -5
  72. package/sdk-scheme-adapter/v2_1_0/components/responses/accountsCreationTimeout.yaml +0 -5
  73. package/sdk-scheme-adapter/v2_1_0/components/responses/bulkQuoteBadRequest.yaml +0 -5
  74. package/sdk-scheme-adapter/v2_1_0/components/responses/bulkQuoteServerError.yaml +0 -5
  75. package/sdk-scheme-adapter/v2_1_0/components/responses/bulkQuoteSuccess.yaml +0 -5
  76. package/sdk-scheme-adapter/v2_1_0/components/responses/bulkQuoteTimeout.yaml +0 -5
  77. package/sdk-scheme-adapter/v2_1_0/components/responses/bulkTransactionAccepted.yaml +0 -1
  78. package/sdk-scheme-adapter/v2_1_0/components/responses/bulkTransactionBadRequest.yaml +0 -5
  79. package/sdk-scheme-adapter/v2_1_0/components/responses/bulkTransactionPutBadRequest.yaml +0 -7
  80. package/sdk-scheme-adapter/v2_1_0/components/responses/bulkTransferBadRequest.yaml +0 -5
  81. package/sdk-scheme-adapter/v2_1_0/components/responses/bulkTransferStatusResponse.yaml +0 -16
  82. package/sdk-scheme-adapter/v2_1_0/components/responses/bulkTransferSuccess.yaml +0 -5
  83. package/sdk-scheme-adapter/v2_1_0/components/responses/errorResponse.yaml +0 -5
  84. package/sdk-scheme-adapter/v2_1_0/components/responses/partiesByIdError404.yaml +0 -8
  85. package/sdk-scheme-adapter/v2_1_0/components/responses/partiesByIdSuccess.yaml +0 -5
  86. package/sdk-scheme-adapter/v2_1_0/components/responses/quotesPostSuccess.yaml +0 -5
  87. package/sdk-scheme-adapter/v2_1_0/components/responses/quotesServerError.yaml +0 -5
  88. package/sdk-scheme-adapter/v2_1_0/components/responses/requestToPaySuccess.yaml +0 -5
  89. package/sdk-scheme-adapter/v2_1_0/components/responses/requestToPayTransferBadRequest.yaml +0 -5
  90. package/sdk-scheme-adapter/v2_1_0/components/responses/requestToPayTransferSuccess.yaml +0 -5
  91. package/sdk-scheme-adapter/v2_1_0/components/responses/servicesFXPSucess.yaml +0 -5
  92. package/sdk-scheme-adapter/v2_1_0/components/responses/simpleTransfersPostSuccess.yaml +0 -5
  93. package/sdk-scheme-adapter/v2_1_0/components/responses/simpleTransfersServerError.yaml +0 -5
  94. package/sdk-scheme-adapter/v2_1_0/components/responses/transferBadRequest.yaml +0 -5
  95. package/sdk-scheme-adapter/v2_1_0/components/responses/transferServerError.yaml +0 -5
  96. package/sdk-scheme-adapter/v2_1_0/components/responses/transferSuccess.yaml +0 -5
  97. package/sdk-scheme-adapter/v2_1_0/components/responses/transferTimeout.yaml +0 -5
  98. package/sdk-scheme-adapter/v2_1_0/components/schemas/Amount.yaml +0 -11
  99. package/sdk-scheme-adapter/v2_1_0/components/schemas/AmountType.yaml +0 -14
  100. package/sdk-scheme-adapter/v2_1_0/components/schemas/AuthenticationInfo.yaml +0 -11
  101. package/sdk-scheme-adapter/v2_1_0/components/schemas/AuthenticationType.yaml +0 -12
  102. package/sdk-scheme-adapter/v2_1_0/components/schemas/AuthenticationValue.yaml +0 -44
  103. package/sdk-scheme-adapter/v2_1_0/components/schemas/AuthorizationIDPutResponse.yaml +0 -10
  104. package/sdk-scheme-adapter/v2_1_0/components/schemas/AuthorizationResponseType.yaml +0 -12
  105. package/sdk-scheme-adapter/v2_1_0/components/schemas/BalanceOfPayments.yaml +0 -9
  106. package/sdk-scheme-adapter/v2_1_0/components/schemas/CorrelationId.yaml +0 -10
  107. package/sdk-scheme-adapter/v2_1_0/components/schemas/Currency.yaml +0 -174
  108. package/sdk-scheme-adapter/v2_1_0/components/schemas/DateOfBirth.yaml +0 -6
  109. package/sdk-scheme-adapter/v2_1_0/components/schemas/DateTime.yaml +0 -14
  110. package/sdk-scheme-adapter/v2_1_0/components/schemas/ErrorCode.yaml +0 -11
  111. package/sdk-scheme-adapter/v2_1_0/components/schemas/ErrorDescription.yaml +0 -5
  112. package/sdk-scheme-adapter/v2_1_0/components/schemas/ErrorInformation.yaml +0 -13
  113. package/sdk-scheme-adapter/v2_1_0/components/schemas/Extension.yaml +0 -11
  114. package/sdk-scheme-adapter/v2_1_0/components/schemas/ExtensionKey.yaml +0 -5
  115. package/sdk-scheme-adapter/v2_1_0/components/schemas/ExtensionList.yaml +0 -15
  116. package/sdk-scheme-adapter/v2_1_0/components/schemas/ExtensionValue.yaml +0 -5
  117. package/sdk-scheme-adapter/v2_1_0/components/schemas/FirstName.yaml +0 -9
  118. package/sdk-scheme-adapter/v2_1_0/components/schemas/FspId.yaml +0 -5
  119. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxQuotesPostBackendRequest.yaml +0 -16
  120. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxQuotesPostBackendResponse.yaml +0 -14
  121. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxQuotesPostOutboundRequest.yaml +0 -19
  122. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxQuotesPostOutboundResponse.yaml +0 -18
  123. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxTransfersPostBackendRequest.yaml +0 -28
  124. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxTransfersPostBackendResponse.yaml +0 -17
  125. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxTransfersPostOutboundRequest.yaml +0 -28
  126. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxTransfersPostOutboundResponse.yaml +0 -17
  127. package/sdk-scheme-adapter/v2_1_0/components/schemas/FxTransfersPutBackendRequest.yaml +0 -17
  128. package/sdk-scheme-adapter/v2_1_0/components/schemas/GeoCode.yaml +0 -13
  129. package/sdk-scheme-adapter/v2_1_0/components/schemas/IlpCondition.yaml +0 -5
  130. package/sdk-scheme-adapter/v2_1_0/components/schemas/IlpFulfilment.yaml +0 -6
  131. package/sdk-scheme-adapter/v2_1_0/components/schemas/IlpPacket.yaml +0 -8
  132. package/sdk-scheme-adapter/v2_1_0/components/schemas/LastName.yaml +0 -9
  133. package/sdk-scheme-adapter/v2_1_0/components/schemas/Latitude.yaml +0 -7
  134. package/sdk-scheme-adapter/v2_1_0/components/schemas/Longitude.yaml +0 -8
  135. package/sdk-scheme-adapter/v2_1_0/components/schemas/MerchantClassificationCode.yaml +0 -7
  136. package/sdk-scheme-adapter/v2_1_0/components/schemas/MiddleName.yaml +0 -9
  137. package/sdk-scheme-adapter/v2_1_0/components/schemas/Money.yaml +0 -11
  138. package/sdk-scheme-adapter/v2_1_0/components/schemas/Name.yaml +0 -17
  139. package/sdk-scheme-adapter/v2_1_0/components/schemas/Note.yaml +0 -6
  140. package/sdk-scheme-adapter/v2_1_0/components/schemas/Party.yaml +0 -21
  141. package/sdk-scheme-adapter/v2_1_0/components/schemas/PartyComplexName.yaml +0 -10
  142. package/sdk-scheme-adapter/v2_1_0/components/schemas/PartyIdInfo.yaml +0 -19
  143. package/sdk-scheme-adapter/v2_1_0/components/schemas/PartyIdType.yaml +0 -54
  144. package/sdk-scheme-adapter/v2_1_0/components/schemas/PartyIdentifier.yaml +0 -6
  145. package/sdk-scheme-adapter/v2_1_0/components/schemas/PartyName.yaml +0 -5
  146. package/sdk-scheme-adapter/v2_1_0/components/schemas/PartyPersonalInfo.yaml +0 -8
  147. package/sdk-scheme-adapter/v2_1_0/components/schemas/PartySubIdOrType.yaml +0 -7
  148. package/sdk-scheme-adapter/v2_1_0/components/schemas/QuotesIDPutResponse.yaml +0 -27
  149. package/sdk-scheme-adapter/v2_1_0/components/schemas/QuotesPostRequest.yaml +0 -53
  150. package/sdk-scheme-adapter/v2_1_0/components/schemas/Refund.yaml +0 -10
  151. package/sdk-scheme-adapter/v2_1_0/components/schemas/RefundReason.yaml +0 -6
  152. package/sdk-scheme-adapter/v2_1_0/components/schemas/TransactionInitiator.yaml +0 -16
  153. package/sdk-scheme-adapter/v2_1_0/components/schemas/TransactionInitiatorType.yaml +0 -14
  154. package/sdk-scheme-adapter/v2_1_0/components/schemas/TransactionRequestResponse.yaml +0 -20
  155. package/sdk-scheme-adapter/v2_1_0/components/schemas/TransactionRequestState.yaml +0 -14
  156. package/sdk-scheme-adapter/v2_1_0/components/schemas/TransactionScenario.yaml +0 -32
  157. package/sdk-scheme-adapter/v2_1_0/components/schemas/TransactionSubScenario.yaml +0 -5
  158. package/sdk-scheme-adapter/v2_1_0/components/schemas/TransactionType.yaml +0 -20
  159. package/sdk-scheme-adapter/v2_1_0/components/schemas/TransferState.yaml +0 -19
  160. package/sdk-scheme-adapter/v2_1_0/components/schemas/TransfersIDPutResponse.yaml +0 -14
  161. package/sdk-scheme-adapter/v2_1_0/components/schemas/TransfersPostRequest.yaml +0 -28
  162. package/sdk-scheme-adapter/v2_1_0/components/schemas/accountCreationStatus.yaml +0 -15
  163. package/sdk-scheme-adapter/v2_1_0/components/schemas/accountsCreationState.yaml +0 -4
  164. package/sdk-scheme-adapter/v2_1_0/components/schemas/accountsRequest.yaml +0 -16
  165. package/sdk-scheme-adapter/v2_1_0/components/schemas/accountsResponse.yaml +0 -23
  166. package/sdk-scheme-adapter/v2_1_0/components/schemas/async2SyncCurrentState.yaml +0 -5
  167. package/sdk-scheme-adapter/v2_1_0/components/schemas/autoAcceptPartyOption.yaml +0 -9
  168. package/sdk-scheme-adapter/v2_1_0/components/schemas/autoAcceptQuote.yaml +0 -14
  169. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkPerTransferFeeLimit.yaml +0 -9
  170. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkQuoteErrorResponse.yaml +0 -8
  171. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkQuoteRequest.yaml +0 -24
  172. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkQuoteResponse.yaml +0 -26
  173. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkQuoteStatus.yaml +0 -4
  174. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkQuoteStatusResponse.yaml +0 -16
  175. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransactionAcceptPartyErrorResponse.yaml +0 -10
  176. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransactionAcceptQuoteErrorResponse.yaml +0 -10
  177. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransactionContinuationAcceptParty.yaml +0 -17
  178. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransactionContinuationAcceptQuote.yaml +0 -13
  179. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransactionIndividualTransfer.yaml +0 -34
  180. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransactionIndividualTransferAccept.yaml +0 -7
  181. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransactionIndividualTransferResult.yaml +0 -38
  182. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransactionOptions.yaml +0 -35
  183. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransactionRequest.yaml +0 -27
  184. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransactionResponse.yaml +0 -27
  185. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransactionStatus.yaml +0 -6
  186. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransferErrorResponse.yaml +0 -8
  187. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransferRequest.yaml +0 -28
  188. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransferResponse.yaml +0 -29
  189. package/sdk-scheme-adapter/v2_1_0/components/schemas/bulkTransferStatus.yaml +0 -4
  190. package/sdk-scheme-adapter/v2_1_0/components/schemas/errorAccountsResponse.yaml +0 -8
  191. package/sdk-scheme-adapter/v2_1_0/components/schemas/errorQuotesResponse.yaml +0 -3
  192. package/sdk-scheme-adapter/v2_1_0/components/schemas/errorResponse.yaml +0 -10
  193. package/sdk-scheme-adapter/v2_1_0/components/schemas/errorSimpleTransfersResponse.yaml +0 -3
  194. package/sdk-scheme-adapter/v2_1_0/components/schemas/errorTransferResponse.yaml +0 -8
  195. package/sdk-scheme-adapter/v2_1_0/components/schemas/extensionListEmptiable.yaml +0 -5
  196. package/sdk-scheme-adapter/v2_1_0/components/schemas/getPartiesResponse.yaml +0 -11
  197. package/sdk-scheme-adapter/v2_1_0/components/schemas/individualQuote.yaml +0 -29
  198. package/sdk-scheme-adapter/v2_1_0/components/schemas/individualQuoteResult.yaml +0 -25
  199. package/sdk-scheme-adapter/v2_1_0/components/schemas/individualTransfer.yaml +0 -34
  200. package/sdk-scheme-adapter/v2_1_0/components/schemas/individualTransferFulfilment.yaml +0 -9
  201. package/sdk-scheme-adapter/v2_1_0/components/schemas/individualTransferResult.yaml +0 -14
  202. package/sdk-scheme-adapter/v2_1_0/components/schemas/mojaloopError.yaml +0 -4
  203. package/sdk-scheme-adapter/v2_1_0/components/schemas/partiesByIdResponse.yaml +0 -18
  204. package/sdk-scheme-adapter/v2_1_0/components/schemas/partyError.yaml +0 -12
  205. package/sdk-scheme-adapter/v2_1_0/components/schemas/quoteError.yaml +0 -12
  206. package/sdk-scheme-adapter/v2_1_0/components/schemas/quotesPostResponse.yaml +0 -48
  207. package/sdk-scheme-adapter/v2_1_0/components/schemas/requestToPayRequest.yaml +0 -32
  208. package/sdk-scheme-adapter/v2_1_0/components/schemas/requestToPayResponse.yaml +0 -35
  209. package/sdk-scheme-adapter/v2_1_0/components/schemas/requestToPayStatus.yaml +0 -5
  210. package/sdk-scheme-adapter/v2_1_0/components/schemas/requestToPayTransferRequest.yaml +0 -42
  211. package/sdk-scheme-adapter/v2_1_0/components/schemas/requestToPayTransferResponse.yaml +0 -72
  212. package/sdk-scheme-adapter/v2_1_0/components/schemas/simpleQuotesPostRequest.yaml +0 -10
  213. package/sdk-scheme-adapter/v2_1_0/components/schemas/simpleTransfersPostRequest.yaml +0 -10
  214. package/sdk-scheme-adapter/v2_1_0/components/schemas/simpleTransfersPostResponse.yaml +0 -17
  215. package/sdk-scheme-adapter/v2_1_0/components/schemas/transferContinuationAcceptConversion.yaml +0 -9
  216. package/sdk-scheme-adapter/v2_1_0/components/schemas/transferContinuationAcceptOTP.yaml +0 -9
  217. package/sdk-scheme-adapter/v2_1_0/components/schemas/transferContinuationAcceptParty.yaml +0 -9
  218. package/sdk-scheme-adapter/v2_1_0/components/schemas/transferContinuationAcceptQuote.yaml +0 -9
  219. package/sdk-scheme-adapter/v2_1_0/components/schemas/transferError.yaml +0 -12
  220. package/sdk-scheme-adapter/v2_1_0/components/schemas/transferParty.yaml +0 -38
  221. package/sdk-scheme-adapter/v2_1_0/components/schemas/transferRequest.yaml +0 -41
  222. package/sdk-scheme-adapter/v2_1_0/components/schemas/transferResponse.yaml +0 -93
  223. package/sdk-scheme-adapter/v2_1_0/components/schemas/transferStatus.yaml +0 -7
  224. package/sdk-scheme-adapter/v2_1_0/components/schemas/transferStatusResponse.yaml +0 -19
  225. package/sdk-scheme-adapter/v2_1_0/components/schemas/transferTransactionType.yaml +0 -5
  226. package/sdk-scheme-adapter/v2_1_0/outbound/openapi.yaml +0 -66
  227. package/sdk-scheme-adapter/v2_1_0/outbound/paths/accounts.yaml +0 -26
  228. package/sdk-scheme-adapter/v2_1_0/outbound/paths/bulkQuotes.yaml +0 -23
  229. package/sdk-scheme-adapter/v2_1_0/outbound/paths/bulkQuotes_bulkQuoteId.yaml +0 -24
  230. package/sdk-scheme-adapter/v2_1_0/outbound/paths/bulkTransactions.yaml +0 -21
  231. package/sdk-scheme-adapter/v2_1_0/outbound/paths/bulkTransactions_bulkTransactionId.yaml +0 -33
  232. package/sdk-scheme-adapter/v2_1_0/outbound/paths/bulkTransfers.yaml +0 -21
  233. package/sdk-scheme-adapter/v2_1_0/outbound/paths/bulkTransfers_bulkTransferId.yaml +0 -24
  234. package/sdk-scheme-adapter/v2_1_0/outbound/paths/fxQuotes.yaml +0 -26
  235. package/sdk-scheme-adapter/v2_1_0/outbound/paths/fxTransfers.yaml +0 -25
  236. package/sdk-scheme-adapter/v2_1_0/outbound/paths/parties_Type_ID.yaml +0 -18
  237. package/sdk-scheme-adapter/v2_1_0/outbound/paths/parties_Type_ID_SubId.yaml +0 -19
  238. package/sdk-scheme-adapter/v2_1_0/outbound/paths/quotes.yaml +0 -18
  239. package/sdk-scheme-adapter/v2_1_0/outbound/paths/requestToPay.yaml +0 -22
  240. package/sdk-scheme-adapter/v2_1_0/outbound/paths/requestToPayTransfer.yaml +0 -57
  241. package/sdk-scheme-adapter/v2_1_0/outbound/paths/requestToPayTransfer_transactionRequestId.yaml +0 -34
  242. package/sdk-scheme-adapter/v2_1_0/outbound/paths/requestToPay_transactionRequestId.yaml +0 -29
  243. package/sdk-scheme-adapter/v2_1_0/outbound/paths/services_FXP.yaml +0 -15
  244. package/sdk-scheme-adapter/v2_1_0/outbound/paths/services_FXP_SourceCurrency_TargetCurrency.yaml +0 -18
  245. package/sdk-scheme-adapter/v2_1_0/outbound/paths/simpleTransfers.yaml +0 -18
  246. package/sdk-scheme-adapter/v2_1_0/outbound/paths/transfers.yaml +0 -55
  247. package/sdk-scheme-adapter/v2_1_0/outbound/paths/transfers_transferId.yaml +0 -59
  248. package/sdk-scheme-adapter/v2_1_0/outbound/paths.yaml +0 -12
@@ -0,0 +1,29 @@
1
+ /*****
2
+ License
3
+ --------------
4
+ Copyright © 2017 Bill & Melinda Gates Foundation
5
+ The Mojaloop files are made available by the Bill & Melinda Gates Foundation under the Apache License, Version 2.0 (the "License") and you may not use these files except in compliance with the License. You may obtain a copy of the License at
6
+
7
+ http://www.apache.org/licenses/LICENSE-2.0
8
+
9
+ Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
10
+
11
+ Contributors
12
+ --------------
13
+ This is the official list (alphabetical ordering) of the Mojaloop project contributors for this file.
14
+ Names of the original copyright holders (individuals or organizations)
15
+ should be listed with a '*' in the first column. People who have
16
+ contributed from an organization can be listed under the organization
17
+ that actually holds the copyright for their contributions (see the
18
+ Gates Foundation organization for an example). Those individuals should have
19
+ their names indented and be marked with a '-'. Email address can be added
20
+ optionally within square brackets <email>.
21
+
22
+ * Gates Foundation
23
+ - Name Surname <name.surname@gatesfoundation.com>
24
+ * Modusbox
25
+ - Vijay Kumar Guthi <vijaya.guthi@modusbox.com>
26
+
27
+ --------------
28
+ ******/
29
+ export {};
@@ -0,0 +1,70 @@
1
+ "use strict";
2
+ /*****
3
+ License
4
+ --------------
5
+ Copyright © 2017 Bill & Melinda Gates Foundation
6
+ The Mojaloop files are made available by the Bill & Melinda Gates Foundation under the Apache License, Version 2.0 (the "License") and you may not use these files except in compliance with the License. You may obtain a copy of the License at
7
+
8
+ http://www.apache.org/licenses/LICENSE-2.0
9
+
10
+ Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
11
+
12
+ Contributors
13
+ --------------
14
+ This is the official list (alphabetical ordering) of the Mojaloop project contributors for this file.
15
+ Names of the original copyright holders (individuals or organizations)
16
+ should be listed with a '*' in the first column. People who have
17
+ contributed from an organization can be listed under the organization
18
+ that actually holds the copyright for their contributions (see the
19
+ Gates Foundation organization for an example). Those individuals should have
20
+ their names indented and be marked with a '-'. Email address can be added
21
+ optionally within square brackets <email>.
22
+
23
+ * Gates Foundation
24
+ - Name Surname <name.surname@gatesfoundation.com>
25
+ * Modusbox
26
+ - Vijay Kumar Guthi <vijaya.guthi@modusbox.com>
27
+
28
+ --------------
29
+ ******/
30
+ Object.defineProperty(exports, "__esModule", { value: true });
31
+ const tslib_1 = require("tslib");
32
+ // Accepts an OpenAPI YAML file as input and alphabetically sorts the components section
33
+ // This is done to maintain a consistent order of components
34
+ const fs_1 = tslib_1.__importDefault(require("fs"));
35
+ const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
36
+ const openapi_core_1 = require("@redocly/openapi-core");
37
+ const myArgs = process.argv.slice(2);
38
+ if (myArgs.length !== 2) {
39
+ console.log('Usage: openapi-sort-components.js <openapi-spec-yaml-file> <output-yaml-file>');
40
+ process.exit(1);
41
+ }
42
+ const openApiFile = myArgs[0];
43
+ const outputFile = myArgs[1];
44
+ const openapi = js_yaml_1.default.load(fs_1.default.readFileSync(openApiFile, 'utf8'));
45
+ if (openapi.components.schemas) {
46
+ const sortedComponentSchemas = {};
47
+ Object.keys(openapi.components.schemas)
48
+ .sort()
49
+ .forEach((key) => {
50
+ sortedComponentSchemas[key] = openapi.components.schemas[key];
51
+ });
52
+ openapi.components.schemas = sortedComponentSchemas;
53
+ }
54
+ if (openapi.components.parameters) {
55
+ const sortedComponentParameters = {};
56
+ Object.keys(openapi.components.parameters)
57
+ .sort()
58
+ .forEach((key) => {
59
+ sortedComponentParameters[key] = openapi.components.parameters[key];
60
+ });
61
+ openapi.components.parameters = sortedComponentParameters;
62
+ }
63
+ // Deleting unnecessary paths those are added as a workaround for the openapi-cli bundle issue
64
+ delete openapi.paths['/interface'];
65
+ fs_1.default.writeFileSync(outputFile, (0, openapi_core_1.stringifyYaml)(openapi, {
66
+ quotingType: '"',
67
+ forceQuotes: false
68
+ }));
69
+ console.log(`Refactored the specification in ${outputFile}`);
70
+ //# sourceMappingURL=openapi-refactor.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"openapi-refactor.js","sourceRoot":"","sources":["../../src/scripts/openapi-refactor.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;QA2BQ;;;AAER,wFAAwF;AACxF,4DAA4D;AAE5D,oDAAmB;AACnB,8DAA0B;AAC1B,wDAAqD;AAErD,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;AACpC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;IACxB,OAAO,CAAC,GAAG,CAAC,+EAA+E,CAAC,CAAA;IAC5F,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;AACjB,CAAC;AACD,MAAM,WAAW,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;AAC7B,MAAM,UAAU,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;AAE5B,MAAM,OAAO,GAAQ,iBAAI,CAAC,IAAI,CAAC,YAAE,CAAC,YAAY,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC,CAAA;AAEpE,IAAI,OAAO,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;IAC/B,MAAM,sBAAsB,GAAQ,EAAE,CAAA;IACtC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC;SACpC,IAAI,EAAE;SACN,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QACf,sBAAsB,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;IAC/D,CAAC,CAAC,CAAA;IACJ,OAAO,CAAC,UAAU,CAAC,OAAO,GAAG,sBAAsB,CAAA;AACrD,CAAC;AAED,IAAI,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC;IAClC,MAAM,yBAAyB,GAAQ,EAAE,CAAA;IACzC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC;SACvC,IAAI,EAAE;SACN,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QACf,yBAAyB,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;IACrE,CAAC,CAAC,CAAA;IACJ,OAAO,CAAC,UAAU,CAAC,UAAU,GAAG,yBAAyB,CAAA;AAC3D,CAAC;AAED,8FAA8F;AAC9F,OAAO,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAA;AAElC,YAAE,CAAC,aAAa,CACd,UAAU,EACV,IAAA,4BAAa,EAAC,OAAO,EAAE;IACrB,WAAW,EAAE,GAAG;IAChB,WAAW,EAAE,KAAK;CACnB,CAAC,CACH,CAAA;AAED,OAAO,CAAC,GAAG,CAAC,mCAAmC,UAAU,EAAE,CAAC,CAAA"}
@@ -5324,7 +5324,7 @@
5324
5324
  },
5325
5325
  "lastError": {
5326
5326
  "type": "object",
5327
- "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
5327
+ "description": "This object represents a Mojaloop API error received at any time during the transfer process",
5328
5328
  "properties": {
5329
5329
  "httpStatusCode": {
5330
5330
  "type": "integer",
@@ -13304,7 +13304,7 @@
13304
13304
  },
13305
13305
  "transferError": {
13306
13306
  "type": "object",
13307
- "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
13307
+ "description": "This object represents a Mojaloop API error received at any time during the transfer process",
13308
13308
  "properties": {
13309
13309
  "httpStatusCode": {
13310
13310
  "type": "integer",
@@ -13459,7 +13459,7 @@
13459
13459
  },
13460
13460
  "lastError": {
13461
13461
  "type": "object",
13462
- "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
13462
+ "description": "This object represents a Mojaloop API error received at any time during the transfer process",
13463
13463
  "properties": {
13464
13464
  "httpStatusCode": {
13465
13465
  "type": "integer",
@@ -14951,7 +14951,7 @@
14951
14951
  },
14952
14952
  "lastError": {
14953
14953
  "type": "object",
14954
- "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
14954
+ "description": "This object represents a Mojaloop API error received at any time during the transfer process",
14955
14955
  "properties": {
14956
14956
  "httpStatusCode": {
14957
14957
  "type": "integer",
@@ -15116,7 +15116,7 @@
15116
15116
  },
15117
15117
  "lastError": {
15118
15118
  "type": "object",
15119
- "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
15119
+ "description": "This object represents a Mojaloop API error received at any time during the transfer process",
15120
15120
  "properties": {
15121
15121
  "httpStatusCode": {
15122
15122
  "type": "integer",
@@ -16900,7 +16900,7 @@
16900
16900
  },
16901
16901
  "lastError": {
16902
16902
  "type": "object",
16903
- "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
16903
+ "description": "This object represents a Mojaloop API error received at any time during the transfer process",
16904
16904
  "properties": {
16905
16905
  "httpStatusCode": {
16906
16906
  "type": "integer",
@@ -17065,7 +17065,7 @@
17065
17065
  },
17066
17066
  "lastError": {
17067
17067
  "type": "object",
17068
- "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
17068
+ "description": "This object represents a Mojaloop API error received at any time during the transfer process",
17069
17069
  "properties": {
17070
17070
  "httpStatusCode": {
17071
17071
  "type": "integer",
@@ -786,7 +786,7 @@ export interface components {
786
786
  * @enum {string}
787
787
  */
788
788
  TransferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED";
789
- /** @description This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter. */
789
+ /** @description This object represents a Mojaloop API error received at any time during the transfer process */
790
790
  transferError: {
791
791
  /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */
792
792
  httpStatusCode?: number;
@@ -733,7 +733,7 @@
733
733
  },
734
734
  "transferError": {
735
735
  "type": "object",
736
- "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
736
+ "description": "This object represents a Mojaloop API error received at any time during the transfer process",
737
737
  "properties": {
738
738
  "httpStatusCode": {
739
739
  "type": "integer",
@@ -1105,7 +1105,7 @@
1105
1105
  },
1106
1106
  "lastError": {
1107
1107
  "type": "object",
1108
- "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
1108
+ "description": "This object represents a Mojaloop API error received at any time during the transfer process",
1109
1109
  "properties": {
1110
1110
  "httpStatusCode": {
1111
1111
  "type": "integer",
@@ -1514,7 +1514,7 @@
1514
1514
  },
1515
1515
  "lastError": {
1516
1516
  "type": "object",
1517
- "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
1517
+ "description": "This object represents a Mojaloop API error received at any time during the transfer process",
1518
1518
  "properties": {
1519
1519
  "httpStatusCode": {
1520
1520
  "type": "integer",
@@ -8169,7 +8169,7 @@
8169
8169
  },
8170
8170
  "lastError": {
8171
8171
  "type": "object",
8172
- "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
8172
+ "description": "This object represents a Mojaloop API error received at any time during the transfer process",
8173
8173
  "properties": {
8174
8174
  "httpStatusCode": {
8175
8175
  "type": "integer",
@@ -9155,7 +9155,7 @@
9155
9155
  },
9156
9156
  "lastError": {
9157
9157
  "type": "object",
9158
- "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
9158
+ "description": "This object represents a Mojaloop API error received at any time during the transfer process",
9159
9159
  "properties": {
9160
9160
  "httpStatusCode": {
9161
9161
  "type": "integer",
@@ -9383,7 +9383,7 @@
9383
9383
  },
9384
9384
  "lastError": {
9385
9385
  "type": "object",
9386
- "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
9386
+ "description": "This object represents a Mojaloop API error received at any time during the transfer process",
9387
9387
  "properties": {
9388
9388
  "httpStatusCode": {
9389
9389
  "type": "integer",
@@ -9636,7 +9636,7 @@
9636
9636
  },
9637
9637
  "lastError": {
9638
9638
  "type": "object",
9639
- "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
9639
+ "description": "This object represents a Mojaloop API error received at any time during the transfer process",
9640
9640
  "properties": {
9641
9641
  "httpStatusCode": {
9642
9642
  "type": "integer",
@@ -9914,7 +9914,7 @@
9914
9914
  },
9915
9915
  "lastError": {
9916
9916
  "type": "object",
9917
- "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
9917
+ "description": "This object represents a Mojaloop API error received at any time during the transfer process",
9918
9918
  "properties": {
9919
9919
  "httpStatusCode": {
9920
9920
  "type": "integer",
@@ -16418,7 +16418,7 @@
16418
16418
  },
16419
16419
  "lastError": {
16420
16420
  "type": "object",
16421
- "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
16421
+ "description": "This object represents a Mojaloop API error received at any time during the transfer process",
16422
16422
  "properties": {
16423
16423
  "httpStatusCode": {
16424
16424
  "type": "integer",
@@ -18958,7 +18958,7 @@
18958
18958
  },
18959
18959
  "lastError": {
18960
18960
  "type": "object",
18961
- "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
18961
+ "description": "This object represents a Mojaloop API error received at any time during the transfer process",
18962
18962
  "properties": {
18963
18963
  "httpStatusCode": {
18964
18964
  "type": "integer",
@@ -20570,7 +20570,7 @@
20570
20570
  },
20571
20571
  "lastError": {
20572
20572
  "type": "object",
20573
- "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
20573
+ "description": "This object represents a Mojaloop API error received at any time during the transfer process",
20574
20574
  "properties": {
20575
20575
  "httpStatusCode": {
20576
20576
  "type": "integer",
@@ -23004,7 +23004,7 @@
23004
23004
  },
23005
23005
  "lastError": {
23006
23006
  "type": "object",
23007
- "description": "This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter.",
23007
+ "description": "This object represents a Mojaloop API error received at any time during the transfer process",
23008
23008
  "properties": {
23009
23009
  "httpStatusCode": {
23010
23010
  "type": "integer",
@@ -535,7 +535,7 @@ export interface components {
535
535
  mojaloopError: {
536
536
  errorInformation?: components["schemas"]["ErrorInformation"];
537
537
  };
538
- /** @description This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter. */
538
+ /** @description This object represents a Mojaloop API error received at any time during the transfer process */
539
539
  transferError: {
540
540
  /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */
541
541
  httpStatusCode?: number;
@@ -980,6 +980,7 @@ export interface components {
980
980
  */
981
981
  partiesByIdResponse: {
982
982
  party: {
983
+ /** @description Information regarding the requested Party. */
983
984
  body: components["schemas"]["Party"];
984
985
  headers: Record<string, never>;
985
986
  };
@@ -1059,6 +1060,7 @@ export interface components {
1059
1060
  };
1060
1061
  /** simpleQuotesPostRequest */
1061
1062
  simpleQuotesPostRequest: {
1063
+ /** destination DFSP requested to calculate the quote */
1062
1064
  fspId: components["schemas"]["FspId"];
1063
1065
  quotesPostRequest: components["schemas"]["QuotesPostRequest"];
1064
1066
  };
@@ -1118,6 +1120,7 @@ export interface components {
1118
1120
  * @description The object sent in the GET /parties/{Type}/{ID} callback.
1119
1121
  */
1120
1122
  getPartiesResponse: {
1123
+ /** @description Information regarding the requested Party. */
1121
1124
  body: components["schemas"]["Party"];
1122
1125
  headers: Record<string, never>;
1123
1126
  };
@@ -1156,6 +1159,7 @@ export interface components {
1156
1159
  currentState: components["schemas"]["requestToPayStatus"];
1157
1160
  getPartiesResponse?: components["schemas"]["getPartiesResponse"];
1158
1161
  transactionRequestResponse?: components["schemas"]["TransactionRequestResponse"];
1162
+ /** @description Object representing the last error to occur during a transfer process. This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter. */
1159
1163
  lastError?: components["schemas"]["transferError"];
1160
1164
  };
1161
1165
  /** @enum {string} */
@@ -1213,6 +1217,7 @@ export interface components {
1213
1217
  body: components["schemas"]["TransfersIDPutResponse"];
1214
1218
  headers?: Record<string, never>;
1215
1219
  };
1220
+ /** @description Object representing the last error to occur during a transfer process. This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter. */
1216
1221
  lastError?: components["schemas"]["transferError"];
1217
1222
  /** @description Set to true if supplying an FSPID for the payee party and no party resolution is needed. This may be useful is a previous party resolution has been performed. */
1218
1223
  skipPartyLookup?: boolean;
@@ -1303,6 +1308,7 @@ export interface components {
1303
1308
  body: components["schemas"]["TransfersIDPutResponse"];
1304
1309
  headers?: Record<string, never>;
1305
1310
  };
1311
+ /** @description Object representing the last error to occur during a transfer process. This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter. */
1306
1312
  lastError?: components["schemas"]["transferError"];
1307
1313
  };
1308
1314
  transferContinuationAcceptOTP: {
package/package.json CHANGED
@@ -1,43 +1,35 @@
1
1
  {
2
2
  "name": "@mojaloop/api-snippets",
3
- "version": "17.3.0-snapshot.0",
3
+ "version": "17.3.0",
4
4
  "description": "Mojaloop API specification reusable snippets",
5
5
  "main": "lib/index.js",
6
6
  "types": "lib/index.d.ts",
7
7
  "scripts": {
8
8
  "audit:fix": "npm audit fix",
9
9
  "audit:check": "npx audit-ci --config ./audit-ci.jsonc",
10
- "build": "npm run build:openapi; npm run build:dto; npm run build:schemas:v2.0.0; npm run build:schemas:v2.1.0; tsc -p ./tsconfig.build.json",
11
- "build:dto": "npm run build:dto:v1.0; npm run build:dto:v1.1; npm run build:dto:v2.0; npm run build:dto:thirdparty; npm run build:dto:sdk-scheme-adapter:v2.0.0; npm run build:dto:sdk-scheme-adapter:v2.1.0;",
12
- "build:schemas:v2.0.0": "npm run build:schemas:sdk-scheme-adapter:backend:v2.0.0; npm run build:schemas:sdk-scheme-adapter:outbound:v2.0.0;",
13
- "build:schemas:v2.1.0": "npm run build:schemas:sdk-scheme-adapter:backend:v2.1.0; npm run build:schemas:sdk-scheme-adapter:outbound:v2.1.0;",
10
+ "build": "npm run build:openapi; npm run build:dto; npm run build:schemas; tsc -p ./tsconfig.build.json",
11
+ "build:dto": "npm run build:dto:v1.0; npm run build:dto:v1.1; npm run build:dto:v2.0; npm run build:dto:thirdparty; npm run build:dto:sdk-scheme-adapter;",
12
+ "build:schemas": "npm run build:schemas:sdk-scheme-adapter:backend; npm run build:schemas:sdk-scheme-adapter:outbound;",
14
13
  "build:dto:v1.0": "openapi-typescript docs/fspiop-rest-v1.0-openapi3-snippets.yaml --output src/fspiop/v1_0/openapi.ts",
15
14
  "build:dto:v1.1": "openapi-typescript docs/fspiop-rest-v1.1-openapi3-snippets.yaml --output src/fspiop/v1_1/openapi.ts",
16
15
  "build:dto:v2.0": "openapi-typescript docs/fspiop-rest-v2.0-openapi3-snippets.yaml --output src/fspiop/v2_0/openapi.ts",
17
16
  "build:dto:thirdparty": "openapi-typescript docs/thirdparty-openapi3-snippets.yaml --output src/thirdparty/openapi.ts",
18
- "build:dto:sdk-scheme-adapter:v2.0.0": "npm run build:dto:sdk-scheme-adapter:backend:v2.0.0; npm run build:dto:sdk-scheme-adapter:outbound:v2.0.0;",
19
- "build:dto:sdk-scheme-adapter:v2.1.0": "npm run build:dto:sdk-scheme-adapter:backend:v2.1.0; npm run build:dto:sdk-scheme-adapter:outbound:v2.1.0;",
20
- "build:dto:sdk-scheme-adapter:backend:v2.0.0": "openapi-typescript docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml --output src/sdk-scheme-adapter/v2_0_0/backend/openapi.ts",
21
- "build:dto:sdk-scheme-adapter:outbound:v2.0.0": "openapi-typescript docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml --output src/sdk-scheme-adapter/v2_0_0/outbound/openapi.ts",
22
- "build:dto:sdk-scheme-adapter:backend:v2.1.0": "openapi-typescript docs/sdk-scheme-adapter-backend-v2_1_0-openapi3-snippets.yaml --output src/sdk-scheme-adapter/v2_1_0/backend/openapi.ts",
23
- "build:dto:sdk-scheme-adapter:outbound:v2.1.0": "openapi-typescript docs/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml --output src/sdk-scheme-adapter/v2_1_0/outbound/openapi.ts",
24
- "build:openapi": "npm run build:v1.0; npm run build:v1.1; npm run build:v2.0; npm run build:thirdparty; npm run build:sdk-scheme-adapter:v2.0.0; npm run build:sdk-scheme-adapter:v2.1.0;",
17
+ "build:dto:sdk-scheme-adapter": "npm run build:dto:sdk-scheme-adapter:backend; npm run build:dto:sdk-scheme-adapter:outbound;",
18
+ "build:dto:sdk-scheme-adapter:backend": "openapi-typescript docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml --output src/sdk-scheme-adapter/v2_0_0/backend/openapi.ts",
19
+ "build:dto:sdk-scheme-adapter:outbound": "openapi-typescript docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml --output src/sdk-scheme-adapter/v2_0_0/outbound/openapi.ts",
20
+ "build:openapi": "npm run build:v1.0; npm run build:v1.1; npm run build:refactor:fspiop:v1.1; npm run build:v2.0; npm run build:refactor:fspiop:v2.0; npm run build:thirdparty; npm run build:sdk-scheme-adapter:backend; npm run build:sdk-scheme-adapter:outbound;",
25
21
  "build:v1.0": "openapi bundle --output docs/fspiop-rest-v1.0-openapi3-snippets.yaml --ext yaml fspiop/v1_0/openapi3/openapi.yaml && swagger-cli validate docs/fspiop-rest-v1.0-openapi3-snippets.yaml",
26
22
  "build:v1.1": "openapi bundle --output docs/fspiop-rest-v1.1-openapi3-snippets.yaml --ext yaml fspiop/v1_1/openapi3/openapi.yaml && swagger-cli validate docs/fspiop-rest-v1.1-openapi3-snippets.yaml",
27
23
  "build:v2.0": "openapi bundle --output docs/fspiop-rest-v2.0-openapi3-snippets.yaml --ext yaml fspiop/v2_0/openapi3/openapi.yaml && swagger-cli validate docs/fspiop-rest-v2.0-openapi3-snippets.yaml",
28
24
  "build:thirdparty": "openapi bundle --output docs/thirdparty-openapi3-snippets.yaml --ext yaml thirdparty/v1_0/openapi3/openapi.yaml && swagger-cli validate docs/thirdparty-openapi3-snippets.yaml",
29
25
  "build:thirdparty-dfsp": "swagger-cli bundle -o ./thirdparty/v1_0/openapi3/thirdparty-dfsp-api.yaml -t yaml ./thirdparty/v1_0/openapi3/thirdparty-dfsp-api.template.yaml",
30
26
  "build:thirdparty-pisp": "swagger-cli bundle -o ./thirdparty/v1_0/openapi3/thirdparty-pisp-api.yaml -t yaml ./thirdparty/v1_0/openapi3/thirdparty-pisp-api.template.yaml",
31
- "build:sdk-scheme-adapter:v2.0.0": "npm run build:sdk-scheme-adapter:backend:v2.0.0; npm run build:sdk-scheme-adapter:outbound:v2.0.0;",
32
- "build:sdk-scheme-adapter:v2.1.0": "npm run build:sdk-scheme-adapter:backend:v2.1.0; npm run build:sdk-scheme-adapter:outbound:v2.1.0;",
33
- "build:sdk-scheme-adapter:backend:v2.0.0": "openapi bundle --output docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml --ext yaml sdk-scheme-adapter/v2_0_0/backend/openapi.yaml && swagger-cli validate docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml",
34
- "build:sdk-scheme-adapter:outbound:v2.0.0": "openapi bundle --output docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml --ext yaml sdk-scheme-adapter/v2_0_0/outbound/openapi.yaml && swagger-cli validate docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml",
35
- "build:sdk-scheme-adapter:backend:v2.1.0": "openapi bundle --output docs/sdk-scheme-adapter-backend-v2_1_0-openapi3-snippets.yaml --ext yaml sdk-scheme-adapter/v2_1_0/backend/openapi.yaml && swagger-cli validate docs/sdk-scheme-adapter-backend-v2_1_0-openapi3-snippets.yaml",
36
- "build:sdk-scheme-adapter:outbound:v2.1.0": "openapi bundle --output docs/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml --ext yaml sdk-scheme-adapter/v2_1_0/outbound/openapi.yaml && swagger-cli validate docs/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml",
37
- "build:schemas:sdk-scheme-adapter:backend:v2.0.0": "npx ts-node --transpile-only src/scripts/json-schema-generator.ts docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml src/sdk-scheme-adapter/v2_0_0/backend",
38
- "build:schemas:sdk-scheme-adapter:outbound:v2.0.0": "npx ts-node --transpile-only src/scripts/json-schema-generator.ts docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml src/sdk-scheme-adapter/v2_0_0/outbound",
39
- "build:schemas:sdk-scheme-adapter:backend:v2.1.0": "npx ts-node --transpile-only src/scripts/json-schema-generator.ts docs/sdk-scheme-adapter-backend-v2_1_0-openapi3-snippets.yaml src/sdk-scheme-adapter/v2_1_0/backend",
40
- "build:schemas:sdk-scheme-adapter:outbound:v2.1.0": "npx ts-node --transpile-only src/scripts/json-schema-generator.ts docs/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml src/sdk-scheme-adapter/v2_1_0/outbound",
27
+ "build:sdk-scheme-adapter:backend": "openapi bundle --output docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml --ext yaml sdk-scheme-adapter/v2_0_0/backend/openapi.yaml && swagger-cli validate docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml",
28
+ "build:sdk-scheme-adapter:outbound": "openapi bundle --output docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml --ext yaml sdk-scheme-adapter/v2_0_0/outbound/openapi.yaml && swagger-cli validate docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml",
29
+ "build:schemas:sdk-scheme-adapter:backend": "npx ts-node --transpile-only src/scripts/json-schema-generator.ts docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml src/sdk-scheme-adapter/v2_0_0/backend",
30
+ "build:schemas:sdk-scheme-adapter:outbound": "npx ts-node --transpile-only src/scripts/json-schema-generator.ts docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml src/sdk-scheme-adapter/v2_0_0/outbound",
31
+ "build:refactor:fspiop:v1.1": "npx ts-node --transpile-only src/scripts/openapi-refactor.ts docs/fspiop-rest-v1.1-openapi3-snippets.yaml docs/fspiop-rest-v1.1-openapi3-snippets.yaml",
32
+ "build:refactor:fspiop:v2.0": "npx ts-node --transpile-only src/scripts/openapi-refactor.ts docs/fspiop-rest-v2.0-openapi3-snippets.yaml docs/fspiop-rest-v2.0-openapi3-snippets.yaml",
41
33
  "lint": "eslint --ext ts --ext js test src",
42
34
  "lint:fix": "eslint --fix --ext ts --ext js test src",
43
35
  "prepare": "husky install && npm run build",
@@ -72,12 +64,13 @@
72
64
  "license": "Apache-2.0",
73
65
  "dependencies": {
74
66
  "@apidevtools/json-schema-ref-parser": "^9.1.2",
67
+ "@redocly/openapi-core": "^1.5.0",
75
68
  "commander": "^11.1.0",
76
69
  "jest-ts-auto-mock": "^2.1.0",
77
70
  "js-yaml": "^4.1.0",
78
71
  "json-refs": "^3.0.15",
79
72
  "openapi-types": "^12.1.3",
80
- "openapi-typescript": "^6.7.1",
73
+ "openapi-typescript": "^6.7.2",
81
74
  "ts-auto-mock": "^3.7.1"
82
75
  },
83
76
  "overrides": {
@@ -87,15 +80,16 @@
87
80
  "devDependencies": {
88
81
  "@commitlint/cli": "^18.4.3",
89
82
  "@commitlint/config-conventional": "^18.4.3",
90
- "@redocly/openapi-cli": "^1.0.0-beta.94",
91
- "@types/jest": "^29.5.9",
92
- "@typescript-eslint/eslint-plugin": "^6.12.0",
93
- "@typescript-eslint/parser": "^6.12.0",
83
+ "@redocly/cli": "^1.5.0",
84
+ "@types/jest": "^29.5.10",
85
+ "@types/js-yaml": "^4.0.9",
86
+ "@typescript-eslint/eslint-plugin": "^6.13.2",
87
+ "@typescript-eslint/parser": "^6.13.2",
94
88
  "audit-ci": "^6.6.1",
95
89
  "browser-sync": "^2.29.3",
96
90
  "diff": "^5.1.0",
97
- "eslint": "^8.54.0",
98
- "eslint-config-prettier": "^9.0.0",
91
+ "eslint": "^8.55.0",
92
+ "eslint-config-prettier": "^9.1.0",
99
93
  "eslint-config-standard": "^17.1.0",
100
94
  "eslint-import-resolver-typescript": "^3.6.1",
101
95
  "eslint-plugin-cucumber": "^2.0.0",
@@ -107,7 +101,7 @@
107
101
  "husky": "8.0.3",
108
102
  "jest": "^29.7.0",
109
103
  "jest-junit": "^16.0.0",
110
- "lint-staged": "^15.1.0",
104
+ "lint-staged": "^15.2.0",
111
105
  "npm-check-updates": "^16.14.11",
112
106
  "prettier": "^3.1.0",
113
107
  "standard-version": "^9.5.0",
@@ -4,6 +4,7 @@ description: 'The object sent in the GET /parties/{Type}/{ID} callback.'
4
4
  properties:
5
5
  body:
6
6
  $ref: ./Party.yaml
7
+ description: Information regarding the requested Party.
7
8
  headers:
8
9
  type: object
9
10
  required:
@@ -6,6 +6,7 @@ properties:
6
6
  properties:
7
7
  body:
8
8
  $ref: ./Party.yaml
9
+ description: Information regarding the requested Party.
9
10
  headers:
10
11
  type: object
11
12
  required:
@@ -32,4 +32,9 @@ properties:
32
32
  transactionRequestResponse:
33
33
  $ref: ./TransactionRequestResponse.yaml
34
34
  lastError:
35
+ description: >
36
+ Object representing the last error to occur during a transfer process.
37
+ This may be a Mojaloop API error returned from another entity in the
38
+ scheme or an object representing other types of error e.g. exceptions that
39
+ may occur inside the scheme adapter.
35
40
  $ref: ./transferError.yaml
@@ -69,4 +69,9 @@ properties:
69
69
  headers:
70
70
  type: object
71
71
  lastError:
72
+ description: >
73
+ Object representing the last error to occur during a transfer process.
74
+ This may be a Mojaloop API error returned from another entity in the
75
+ scheme or an object representing other types of error e.g. exceptions that
76
+ may occur inside the scheme adapter.
72
77
  $ref: ./transferError.yaml
@@ -2,6 +2,7 @@ title: simpleQuotesPostRequest
2
2
  type: object
3
3
  properties:
4
4
  fspId:
5
+ title: destination DFSP requested to calculate the quote
5
6
  $ref: ./FspId.yaml
6
7
  quotesPostRequest:
7
8
  $ref: ./QuotesPostRequest.yaml
@@ -1,8 +1,7 @@
1
1
  type: object
2
2
  description: >-
3
- This may be a Mojaloop API error returned from another entity in the
4
- scheme or an object representing other types of error e.g. exceptions that
5
- may occur inside the scheme adapter.
3
+ This object represents a Mojaloop API error received at any time during the
4
+ transfer process
6
5
  properties:
7
6
  httpStatusCode:
8
7
  type: integer
@@ -69,6 +69,11 @@ properties:
69
69
  headers:
70
70
  type: object
71
71
  lastError:
72
+ description: >
73
+ Object representing the last error to occur during a transfer process.
74
+ This may be a Mojaloop API error returned from another entity in the
75
+ scheme or an object representing other types of error e.g. exceptions that
76
+ may occur inside the scheme adapter.
72
77
  $ref: ./transferError.yaml
73
78
  skipPartyLookup:
74
79
  description: >-