mangopay4-nodejs-sdk 1.64.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 (353) hide show
  1. package/.github/workflows/node.js.yml +32 -0
  2. package/.github/workflows/npm-publish.yml +26 -0
  3. package/.jshintrc +16 -0
  4. package/CHANGELOG.md +946 -0
  5. package/LICENSE +21 -0
  6. package/README.md +179 -0
  7. package/docs/BankAccounts.md +35 -0
  8. package/docs/BankingAliases.md +108 -0
  9. package/docs/CardPreAuthorizations.md +55 -0
  10. package/docs/CardRegistrations.md +55 -0
  11. package/docs/Cards.md +82 -0
  12. package/docs/Clients.md +142 -0
  13. package/docs/DisputeDocuments.md +53 -0
  14. package/docs/Disputes.md +292 -0
  15. package/docs/Events.md +23 -0
  16. package/docs/Hooks.md +68 -0
  17. package/docs/Idempotency.md +11 -0
  18. package/docs/KycDocuments.md +52 -0
  19. package/docs/Mandates.md +125 -0
  20. package/docs/OptionsHelper.md +32 -0
  21. package/docs/PayIns.md +72 -0
  22. package/docs/PayOuts.md +55 -0
  23. package/docs/README.md +131 -0
  24. package/docs/Refunds.md +25 -0
  25. package/docs/Reports.md +63 -0
  26. package/docs/Repudiations.md +25 -0
  27. package/docs/Responses.md +33 -0
  28. package/docs/Transfers.md +72 -0
  29. package/docs/UboDeclarations.md +70 -0
  30. package/docs/Users.md +322 -0
  31. package/docs/Wallets.md +70 -0
  32. package/docs/templates/class.mustache +11 -0
  33. package/docs/templates/file.mustache +53 -0
  34. package/docs/templates/function.mustache +33 -0
  35. package/docs/templates/index.mustache +26 -0
  36. package/docs/templates/overview.mustache +1 -0
  37. package/examples/createUsers.js +112 -0
  38. package/examples/createWallet.js +28 -0
  39. package/examples/failedRequest.js +20 -0
  40. package/examples/getBankAccounts.js +29 -0
  41. package/examples/getUserEmoney.js +16 -0
  42. package/examples/getUsers.js +32 -0
  43. package/examples/readResponseHeaders.js +42 -0
  44. package/index.js +1 -0
  45. package/lib/Model.js +58 -0
  46. package/lib/api.js +467 -0
  47. package/lib/apiMethods.js +270 -0
  48. package/lib/config.js +57 -0
  49. package/lib/log.js +9 -0
  50. package/lib/mangopay.js +8 -0
  51. package/lib/models/Address.js +32 -0
  52. package/lib/models/BankAccount.js +45 -0
  53. package/lib/models/BankAccountDetails.js +7 -0
  54. package/lib/models/BankAccountDetailsCA.js +12 -0
  55. package/lib/models/BankAccountDetailsGB.js +10 -0
  56. package/lib/models/BankAccountDetailsIBAN.js +10 -0
  57. package/lib/models/BankAccountDetailsOTHER.js +16 -0
  58. package/lib/models/BankAccountDetailsUS.js +14 -0
  59. package/lib/models/BankAccountType.js +8 -0
  60. package/lib/models/BankingAlias.js +37 -0
  61. package/lib/models/BankingAliasIBAN.js +27 -0
  62. package/lib/models/Billing.js +14 -0
  63. package/lib/models/BinData.js +16 -0
  64. package/lib/models/Birthplace.js +10 -0
  65. package/lib/models/BrowserInfo.js +15 -0
  66. package/lib/models/Card.js +19 -0
  67. package/lib/models/CardInfo.js +32 -0
  68. package/lib/models/CardPreAuthorization.js +144 -0
  69. package/lib/models/CardRegistration.js +29 -0
  70. package/lib/models/CardValidation.js +19 -0
  71. package/lib/models/CategorizeUserLegal.js +15 -0
  72. package/lib/models/CategorizeUserNatural.js +18 -0
  73. package/lib/models/Check.js +13 -0
  74. package/lib/models/CheckData.js +8 -0
  75. package/lib/models/Client.js +62 -0
  76. package/lib/models/ClientWallet.js +28 -0
  77. package/lib/models/Conversion.js +19 -0
  78. package/lib/models/ConversionRate.js +10 -0
  79. package/lib/models/CountryAuthorization.js +12 -0
  80. package/lib/models/DebitedBankAccount.js +15 -0
  81. package/lib/models/DeclaredUbo.js +29 -0
  82. package/lib/models/DeclaredUboStatus.js +17 -0
  83. package/lib/models/Deposit.js +29 -0
  84. package/lib/models/Dispute.js +46 -0
  85. package/lib/models/DisputeDocument.js +10 -0
  86. package/lib/models/DisputeDocumentPage.js +12 -0
  87. package/lib/models/DisputeReason.js +11 -0
  88. package/lib/models/Document.js +12 -0
  89. package/lib/models/DocumentPageConsult.js +17 -0
  90. package/lib/models/EMoney.js +30 -0
  91. package/lib/models/EntityBase.js +70 -0
  92. package/lib/models/Hook.js +19 -0
  93. package/lib/models/IdempotencyResponse.js +11 -0
  94. package/lib/models/IdentityVerification.js +12 -0
  95. package/lib/models/KycDocument.js +11 -0
  96. package/lib/models/KycDocumentStatus.js +7 -0
  97. package/lib/models/KycDocumentType.js +7 -0
  98. package/lib/models/KycPage.js +12 -0
  99. package/lib/models/LegalPersonType.js +7 -0
  100. package/lib/models/LegalRepresentative.js +16 -0
  101. package/lib/models/Mandate.js +69 -0
  102. package/lib/models/MandateStatus.js +7 -0
  103. package/lib/models/Money.js +16 -0
  104. package/lib/models/PayByBankSupportedBank.js +7 -0
  105. package/lib/models/PayIn.js +36 -0
  106. package/lib/models/PayInExecutionDetails.js +7 -0
  107. package/lib/models/PayInExecutionDetailsBankingAlias.js +19 -0
  108. package/lib/models/PayInExecutionDetailsDirect.js +29 -0
  109. package/lib/models/PayInExecutionDetailsWeb.js +40 -0
  110. package/lib/models/PayInExecutionType.js +5 -0
  111. package/lib/models/PayInIntent.js +20 -0
  112. package/lib/models/PayInIntentSplit.js +14 -0
  113. package/lib/models/PayInIntentSplits.js +7 -0
  114. package/lib/models/PayInPaymentDetails.js +7 -0
  115. package/lib/models/PayInPaymentDetailsApplePay.js +19 -0
  116. package/lib/models/PayInPaymentDetailsBancontact.js +13 -0
  117. package/lib/models/PayInPaymentDetailsBankWire.js +23 -0
  118. package/lib/models/PayInPaymentDetailsBankingAlias.js +18 -0
  119. package/lib/models/PayInPaymentDetailsBizum.js +23 -0
  120. package/lib/models/PayInPaymentDetailsBlik.js +17 -0
  121. package/lib/models/PayInPaymentDetailsCard.js +10 -0
  122. package/lib/models/PayInPaymentDetailsCardDirect.js +14 -0
  123. package/lib/models/PayInPaymentDetailsCardWeb.js +28 -0
  124. package/lib/models/PayInPaymentDetailsDirectDebitDirect.js +22 -0
  125. package/lib/models/PayInPaymentDetailsDirectDebitWeb.js +13 -0
  126. package/lib/models/PayInPaymentDetailsGiropay.js +15 -0
  127. package/lib/models/PayInPaymentDetailsGooglePay.js +35 -0
  128. package/lib/models/PayInPaymentDetailsIdeal.js +25 -0
  129. package/lib/models/PayInPaymentDetailsKlarna.js +36 -0
  130. package/lib/models/PayInPaymentDetailsMbway.js +20 -0
  131. package/lib/models/PayInPaymentDetailsMultibanco.js +14 -0
  132. package/lib/models/PayInPaymentDetailsPayByBank.js +71 -0
  133. package/lib/models/PayInPaymentDetailsPayPal.js +63 -0
  134. package/lib/models/PayInPaymentDetailsPayconiq.js +23 -0
  135. package/lib/models/PayInPaymentDetailsPreAuthorized.js +10 -0
  136. package/lib/models/PayInPaymentDetailsSatispay.js +19 -0
  137. package/lib/models/PayInPaymentDetailsSwish.js +35 -0
  138. package/lib/models/PayInPaymentDetailsTwint.js +15 -0
  139. package/lib/models/PayInPaymentType.js +21 -0
  140. package/lib/models/PayInRecurringRegistration.js +64 -0
  141. package/lib/models/PayInTemplateURLOptions.js +10 -0
  142. package/lib/models/PayOut.js +24 -0
  143. package/lib/models/PayOutPaymentDetails.js +7 -0
  144. package/lib/models/PayOutPaymentDetailsBankWire.js +32 -0
  145. package/lib/models/PayOutPaymentType.js +3 -0
  146. package/lib/models/PaymentData.js +20 -0
  147. package/lib/models/PaymentMethodMetadata.js +38 -0
  148. package/lib/models/PayoutMethods.js +7 -0
  149. package/lib/models/PendingUserAction.js +16 -0
  150. package/lib/models/PersonType.js +5 -0
  151. package/lib/models/PlatformCategorization.js +16 -0
  152. package/lib/models/PlatformType.js +10 -0
  153. package/lib/models/Quote.js +11 -0
  154. package/lib/models/Recipient.js +20 -0
  155. package/lib/models/RecipientSchema.js +17 -0
  156. package/lib/models/RecurringPayIn.js +10 -0
  157. package/lib/models/RecurringPayInCIT.js +32 -0
  158. package/lib/models/RecurringPayInCurrentState.js +24 -0
  159. package/lib/models/RecurringPayInMIT.js +27 -0
  160. package/lib/models/RecurringPayInPut.js +24 -0
  161. package/lib/models/Refund.js +26 -0
  162. package/lib/models/RefundReasonDetails.js +10 -0
  163. package/lib/models/Report.js +54 -0
  164. package/lib/models/ReportFilter.js +52 -0
  165. package/lib/models/ReportFilterV2.js +11 -0
  166. package/lib/models/ReportV2.js +28 -0
  167. package/lib/models/Repudiation.js +51 -0
  168. package/lib/models/SecurityInfo.js +12 -0
  169. package/lib/models/Settlement.js +16 -0
  170. package/lib/models/SettlementTransfer.js +37 -0
  171. package/lib/models/Shipping.js +14 -0
  172. package/lib/models/ShippingAddress.js +25 -0
  173. package/lib/models/ShippingPreference.js +5 -0
  174. package/lib/models/Transaction.js +50 -0
  175. package/lib/models/Transfer.js +13 -0
  176. package/lib/models/Ubo.js +19 -0
  177. package/lib/models/UboDeclaration.js +42 -0
  178. package/lib/models/UboDeclarationRefusedReasonType.js +23 -0
  179. package/lib/models/UboDeclarationStatus.js +26 -0
  180. package/lib/models/UboRefusedReasonType.js +14 -0
  181. package/lib/models/User.js +66 -0
  182. package/lib/models/UserCategory.js +5 -0
  183. package/lib/models/UserConsent.js +7 -0
  184. package/lib/models/UserDataFormatValidation.js +7 -0
  185. package/lib/models/UserEnrollmentResult.js +7 -0
  186. package/lib/models/UserLegal.js +65 -0
  187. package/lib/models/UserLegalOwner.js +66 -0
  188. package/lib/models/UserLegalPayer.js +66 -0
  189. package/lib/models/UserLegalSca.js +57 -0
  190. package/lib/models/UserNatural.js +51 -0
  191. package/lib/models/UserNaturalCapacity.js +13 -0
  192. package/lib/models/UserNaturalOwner.js +55 -0
  193. package/lib/models/UserNaturalPayer.js +55 -0
  194. package/lib/models/UserNaturalPut.js +49 -0
  195. package/lib/models/UserNaturalSca.js +56 -0
  196. package/lib/models/VirtualAccount.js +22 -0
  197. package/lib/models/Wallet.js +32 -0
  198. package/lib/models/index.js +102 -0
  199. package/lib/service.js +14 -0
  200. package/lib/services/BankAccounts.js +31 -0
  201. package/lib/services/BankingAliases.js +137 -0
  202. package/lib/services/CardPreAuthorizations.js +75 -0
  203. package/lib/services/CardRegistrations.js +64 -0
  204. package/lib/services/Cards.js +168 -0
  205. package/lib/services/Clients.js +196 -0
  206. package/lib/services/Conversions.js +155 -0
  207. package/lib/services/Deposits.js +109 -0
  208. package/lib/services/DisputeDocuments.js +65 -0
  209. package/lib/services/Disputes.js +409 -0
  210. package/lib/services/Events.js +24 -0
  211. package/lib/services/Hooks.js +81 -0
  212. package/lib/services/Idempotency.js +17 -0
  213. package/lib/services/IdentityVerifications.js +48 -0
  214. package/lib/services/KycDocuments.js +66 -0
  215. package/lib/services/Mandates.js +161 -0
  216. package/lib/services/OptionsHelper.js +20 -0
  217. package/lib/services/PayIns.js +690 -0
  218. package/lib/services/PayOuts.js +110 -0
  219. package/lib/services/Recipients.js +117 -0
  220. package/lib/services/Refunds.js +29 -0
  221. package/lib/services/Regulatory.js +29 -0
  222. package/lib/services/Reports.js +61 -0
  223. package/lib/services/ReportsV2.js +55 -0
  224. package/lib/services/Repudiations.js +33 -0
  225. package/lib/services/Responses.js +23 -0
  226. package/lib/services/Settlements.js +74 -0
  227. package/lib/services/Transfers.js +87 -0
  228. package/lib/services/UboDeclarations.js +135 -0
  229. package/lib/services/Users.js +831 -0
  230. package/lib/services/VirtualAccounts.js +99 -0
  231. package/lib/services/Wallets.js +85 -0
  232. package/lib/services/index.js +34 -0
  233. package/lib/utils.js +36 -0
  234. package/package.json +40 -0
  235. package/test/TestKycPageFile.png +0 -0
  236. package/test/helpers.js +1431 -0
  237. package/test/main.js +10 -0
  238. package/test/mocha.opts +3 -0
  239. package/test/services/BankAccounts.js +46 -0
  240. package/test/services/BankingAliases.js +89 -0
  241. package/test/services/CardPreAuthorizations.js +70 -0
  242. package/test/services/CardRegistrations.js +239 -0
  243. package/test/services/Cards.js +54 -0
  244. package/test/services/Clients.js +235 -0
  245. package/test/services/Conversions.js +308 -0
  246. package/test/services/Deposits.js +148 -0
  247. package/test/services/Disputes.js +542 -0
  248. package/test/services/EMoney.js +54 -0
  249. package/test/services/Events.js +143 -0
  250. package/test/services/Hooks.js +109 -0
  251. package/test/services/Idempotency.js +46 -0
  252. package/test/services/IdentityVerifications.js +68 -0
  253. package/test/services/KycDocuments.js +73 -0
  254. package/test/services/Mandates.js +256 -0
  255. package/test/services/PayIns.js +2553 -0
  256. package/test/services/PayOuts.js +106 -0
  257. package/test/services/RateLimit.js +48 -0
  258. package/test/services/Recipients.js +234 -0
  259. package/test/services/Refunds.js +123 -0
  260. package/test/services/Regulatory.js +45 -0
  261. package/test/services/Reports.js +114 -0
  262. package/test/services/ReportsV2.js +306 -0
  263. package/test/services/Repudiations.js +22 -0
  264. package/test/services/Settlements.js +58 -0
  265. package/test/services/Tokens.js +55 -0
  266. package/test/services/Transfers.js +137 -0
  267. package/test/services/UboDeclarations.js +135 -0
  268. package/test/services/Users.js +1303 -0
  269. package/test/services/VirtualAccounts.js +105 -0
  270. package/test/services/Wallets.js +132 -0
  271. package/test/settlement_sample.csv +8 -0
  272. package/typings/base.d.ts +308 -0
  273. package/typings/enums.d.ts +204 -0
  274. package/typings/index.d.ts +885 -0
  275. package/typings/index.test-d.ts +1535 -0
  276. package/typings/models/address.d.ts +70 -0
  277. package/typings/models/bankAccount.d.ts +235 -0
  278. package/typings/models/bankingAlias.d.ts +97 -0
  279. package/typings/models/billing.d.ts +42 -0
  280. package/typings/models/birthplace.d.ts +9 -0
  281. package/typings/models/card.d.ts +119 -0
  282. package/typings/models/cardPreauthorization.d.ts +157 -0
  283. package/typings/models/cardRegistration.d.ts +83 -0
  284. package/typings/models/cardValidation.d.ts +125 -0
  285. package/typings/models/client.d.ts +208 -0
  286. package/typings/models/conversion.d.ts +225 -0
  287. package/typings/models/conversionRate.d.ts +29 -0
  288. package/typings/models/countryAuthorization.d.ts +16 -0
  289. package/typings/models/deposit.d.ts +104 -0
  290. package/typings/models/dispute.d.ts +116 -0
  291. package/typings/models/disputeDocument.d.ts +119 -0
  292. package/typings/models/entityBase.d.ts +9 -0
  293. package/typings/models/event.d.ts +142 -0
  294. package/typings/models/hook.d.ts +39 -0
  295. package/typings/models/idempotency.d.ts +36 -0
  296. package/typings/models/identityVerification.d.ts +98 -0
  297. package/typings/models/kycDocument.d.ts +114 -0
  298. package/typings/models/mandate.d.ts +93 -0
  299. package/typings/models/money.d.ts +45 -0
  300. package/typings/models/payIn.d.ts +3742 -0
  301. package/typings/models/payOut.d.ts +144 -0
  302. package/typings/models/recipient.d.ts +242 -0
  303. package/typings/models/refund.d.ts +92 -0
  304. package/typings/models/report.d.ts +234 -0
  305. package/typings/models/reportV2.d.ts +145 -0
  306. package/typings/models/repudiation.d.ts +26 -0
  307. package/typings/models/securityInfo.d.ts +12 -0
  308. package/typings/models/settlement.d.ts +50 -0
  309. package/typings/models/settlementTransfer.d.ts +37 -0
  310. package/typings/models/shipping.d.ts +37 -0
  311. package/typings/models/shippingAddress.d.ts +15 -0
  312. package/typings/models/transaction.d.ts +85 -0
  313. package/typings/models/transfer.d.ts +119 -0
  314. package/typings/models/uboDeclaration.d.ts +100 -0
  315. package/typings/models/user.d.ts +1001 -0
  316. package/typings/models/virtualAccount.d.ts +182 -0
  317. package/typings/models/wallet.d.ts +46 -0
  318. package/typings/models.d.ts +74 -0
  319. package/typings/services/BankAccounts.d.ts +12 -0
  320. package/typings/services/BankingAliases.d.ts +51 -0
  321. package/typings/services/CardPreauthorizations.d.ts +44 -0
  322. package/typings/services/CardRegistrations.d.ts +43 -0
  323. package/typings/services/Cards.d.ts +80 -0
  324. package/typings/services/Clients.d.ts +77 -0
  325. package/typings/services/Conversions.d.ts +23 -0
  326. package/typings/services/Deposits.d.ts +20 -0
  327. package/typings/services/DisputeDocuments.d.ts +27 -0
  328. package/typings/services/Disputes.d.ts +169 -0
  329. package/typings/services/Events.d.ts +11 -0
  330. package/typings/services/Hooks.d.ts +33 -0
  331. package/typings/services/Idempotency.d.ts +7 -0
  332. package/typings/services/IdentityVerifications.d.ts +29 -0
  333. package/typings/services/KycDocuments.d.ts +38 -0
  334. package/typings/services/Mandates.d.ts +59 -0
  335. package/typings/services/OptionsHelper.d.ts +11 -0
  336. package/typings/services/PayIns.d.ts +319 -0
  337. package/typings/services/PayOuts.d.ts +34 -0
  338. package/typings/services/Recipients.d.ts +55 -0
  339. package/typings/services/Refunds.d.ts +12 -0
  340. package/typings/services/Regulatory.d.ts +17 -0
  341. package/typings/services/Reports.d.ts +26 -0
  342. package/typings/services/ReportsV2.d.ts +26 -0
  343. package/typings/services/Repudiations.d.ts +12 -0
  344. package/typings/services/Responses.d.ts +10 -0
  345. package/typings/services/Settlements.d.ts +28 -0
  346. package/typings/services/Transfers.d.ts +38 -0
  347. package/typings/services/UboDeclarations.d.ts +81 -0
  348. package/typings/services/Users.d.ts +308 -0
  349. package/typings/services/VirtualAccounts.d.ts +42 -0
  350. package/typings/services/Wallets.d.ts +36 -0
  351. package/typings/tsconfig.json +20 -0
  352. package/typings/tslint.json +11 -0
  353. package/typings/types.d.ts +652 -0
@@ -0,0 +1,169 @@
1
+ import { dispute } from "../models/dispute";
2
+ import { transaction } from "../models/transaction";
3
+ import { repudiation } from "../models/repudiation";
4
+ import { settlementTransfer } from "../models/settlementTransfer";
5
+ import { disputeDocument } from "../models/disputeDocument";
6
+ import { base } from "../base";
7
+ import MethodOverload = base.MethodOverload;
8
+ import NoArgMethodOverload = base.NoArgMethodOverload;
9
+ import TwoArgsMethodOverload = base.TwoArgsMethodOverload;
10
+ import { money } from "../models/money";
11
+ import MoneyData = money.MoneyData;
12
+ import ThreeArgsMethodOverload = base.ThreeArgsMethodOverload;
13
+
14
+ export class Disputes {
15
+ /**
16
+ * Get dispute
17
+ * @param disputeId
18
+ * @param options
19
+ */
20
+ get: MethodOverload<string, dispute.DisputeData>;
21
+
22
+ /**
23
+ * Get all disputes
24
+ * @param options
25
+ */
26
+ getAll: NoArgMethodOverload<dispute.DisputeData[]>;
27
+
28
+ /**
29
+ * Update dispute's tag
30
+ * @param dispute
31
+ * @param options
32
+ */
33
+ update: MethodOverload<dispute.UpdateDispute, dispute.DisputeData>;
34
+
35
+ /**
36
+ * Contest dispute
37
+ * @param disputeId
38
+ * @param contestedFunds
39
+ * @param options
40
+ */
41
+ contestDispute: TwoArgsMethodOverload<string,
42
+ MoneyData,
43
+ dispute.DisputeData>;
44
+
45
+ /**
46
+ * This method is used to resubmit a Dispute if it is reopened requiring more docs
47
+ * @param disputeId
48
+ * @param options
49
+ */
50
+ resubmitDispute: MethodOverload<string, dispute.DisputeData>;
51
+
52
+ /**
53
+ * Close dispute
54
+ * @param disputeId
55
+ * @param options
56
+ */
57
+ closeDispute: MethodOverload<string, dispute.DisputeData>;
58
+
59
+ /**
60
+ * Gets dispute's transactions
61
+ * @param disputeId
62
+ * @param options
63
+ */
64
+ getTransactions: MethodOverload<string, transaction.TransactionData[]>;
65
+
66
+ /**
67
+ * Gets dispute's documents for wallet
68
+ * @param walletId
69
+ * @param options
70
+ */
71
+ getDisputesForWallet: MethodOverload<string, dispute.DisputeData[]>;
72
+
73
+ /**
74
+ * Gets user's disputes
75
+ * @param userId
76
+ * @param options
77
+ */
78
+ getDisputesForUser: MethodOverload<string, dispute.DisputeData[]>;
79
+
80
+ /**
81
+ * Gets dispute's documents for pay in
82
+ * @param payInId
83
+ * @param options
84
+ */
85
+ getDisputesForPayIn: MethodOverload<string, dispute.DisputeData[]>;
86
+
87
+ /**
88
+ * Gets repudiation
89
+ * @param repudiationId
90
+ * @param options
91
+ */
92
+ getRepudiation: MethodOverload<string, repudiation.RepudiationData>;
93
+
94
+ /**
95
+ * Creates settlement transfer
96
+ * @param settlementTransfer
97
+ * @param repudiationId
98
+ * @param options
99
+ */
100
+ createSettlementTransfer: TwoArgsMethodOverload<settlementTransfer.CreateSettlementTransfer,
101
+ string,
102
+ settlementTransfer.SettlementTransferData>;
103
+
104
+ /**
105
+ * Gets settlement transfer
106
+ * @param settlementTransferId
107
+ * @param options
108
+ */
109
+ getSettlementTransfer: MethodOverload<string,
110
+ settlementTransfer.SettlementTransferData>;
111
+
112
+ /**
113
+ * Gets documents for dispute
114
+ * @param disputeId
115
+ * @param options
116
+ */
117
+ getDocumentsForDispute: MethodOverload<string,
118
+ disputeDocument.DisputeDocumentData[]>;
119
+
120
+ /**
121
+ * Update dispute document
122
+ * @param disputeId
123
+ * @param disputeDocument
124
+ * @param options
125
+ */
126
+ updateDisputeDocument: TwoArgsMethodOverload<string,
127
+ Partial<disputeDocument.DisputeDocumentData>,
128
+ disputeDocument.DisputeDocumentData>;
129
+
130
+ /**
131
+ * Creates document for dispute
132
+ * @param disputeId
133
+ * @param disputeDocument
134
+ * @param options
135
+ */
136
+ createDisputeDocument: TwoArgsMethodOverload<string,
137
+ disputeDocument.CreateDisputeDocument,
138
+ disputeDocument.DisputeDocumentData>;
139
+
140
+ /**
141
+ * Creates document's page for dispute
142
+ * @param disputeId
143
+ * @param disputeDocumentId
144
+ * @param disputeDocumentPage
145
+ * @param options
146
+ */
147
+ createDisputeDocumentPage: ThreeArgsMethodOverload<string,
148
+ string,
149
+ disputeDocument.CreateDisputeDocumentPage,
150
+ disputeDocument.DisputeDocumentData>;
151
+
152
+ /**
153
+ * Creates document's page for dispute from file
154
+ * @param disputeId
155
+ * @param disputeDocumentId
156
+ * @param file
157
+ * @param options
158
+ */
159
+ createDisputeDocumentPageFromFile: ThreeArgsMethodOverload<string,
160
+ string,
161
+ string,
162
+ disputeDocument.DisputeDocumentData>;
163
+
164
+ /**
165
+ * Retrieve a list of Disputes pending settlement
166
+ * @param options
167
+ */
168
+ getPendingSettlement: NoArgMethodOverload<dispute.DisputeData[]>;
169
+ }
@@ -0,0 +1,11 @@
1
+ import { event } from "../models/event";
2
+ import { base } from "../base";
3
+ import NoArgMethodOverload = base.NoArgMethodOverload;
4
+
5
+ export class Events {
6
+ /**
7
+ * Get events
8
+ * @param options
9
+ */
10
+ getAll: NoArgMethodOverload<event.EventData[]>;
11
+ }
@@ -0,0 +1,33 @@
1
+ import { hook } from "../models/hook";
2
+ import { base } from "../base";
3
+ import MethodOverload = base.MethodOverload;
4
+ import NoArgMethodOverload = base.NoArgMethodOverload;
5
+
6
+ export class Hooks {
7
+ /**
8
+ * Create new hook
9
+ * @param hook
10
+ * @param options
11
+ */
12
+ create: MethodOverload<hook.CreateHook, hook.HookData>;
13
+
14
+ /**
15
+ * Get hook
16
+ * @param hookId
17
+ * @param options
18
+ */
19
+ get: MethodOverload<string, hook.HookData>;
20
+
21
+ /**
22
+ * Save hook
23
+ * @param hook
24
+ * @param options
25
+ */
26
+ update: MethodOverload<hook.UpdateHook, hook.HookData>;
27
+
28
+ /**
29
+ * Get all hooks
30
+ * @param options
31
+ */
32
+ getAll: NoArgMethodOverload<hook.HookData[]>;
33
+ }
@@ -0,0 +1,7 @@
1
+ import { base } from "../base";
2
+ import { idempotency } from "../models/idempotency";
3
+ import MethodOverload = base.MethodOverload;
4
+
5
+ export class Idempotency {
6
+ get: MethodOverload<string, idempotency.IdempotencyData>;
7
+ }
@@ -0,0 +1,29 @@
1
+ import {base} from "../base";
2
+ import {identityVerification} from "../models/identityVerification";
3
+ import TwoArgsMethodOverload = base.TwoArgsMethodOverload;
4
+ import MethodOverload = base.MethodOverload;
5
+
6
+ export class IdentityVerifications {
7
+ /**
8
+ * Start an identity verification session and get a link for the hosted experience
9
+ * @param {string} userId The user identifier
10
+ * @param {Object} identityVerification The IdentityVerification object
11
+ */
12
+ create: TwoArgsMethodOverload<
13
+ string,
14
+ identityVerification.CreateIdentityVerification,
15
+ identityVerification.IdentityVerificationData
16
+ >;
17
+
18
+ /**
19
+ * See the status and basic details of an identity verification session
20
+ * @param {string} id The unique identifier of the identity verification session.
21
+ */
22
+ get: MethodOverload<string, identityVerification.IdentityVerificationData>;
23
+
24
+ /**
25
+ * Get all IdentityVerifications for a user
26
+ * @param {string} userId The unique identifier of the user.
27
+ */
28
+ getAll: MethodOverload<string, identityVerification.IdentityVerificationData[]>;
29
+ }
@@ -0,0 +1,38 @@
1
+ import { kycDocument } from "../models/kycDocument";
2
+ import { base } from "../base";
3
+ import NoArgMethodOverload = base.NoArgMethodOverload;
4
+ import MethodOverload = base.MethodOverload;
5
+
6
+ /**
7
+ * You need to create document in order to upload pages on this document.
8
+ *
9
+ * 1. The KYC Document Object is a request to validate a required document. There is one request for one Type of document
10
+ * 2. Upload a file through a Page. A document should get several pages
11
+ * 3. Edit the object Document and set the Status field to "VALIDATION_ASKED" (instead of "CREATED")
12
+ * 4. The demand is received by our team. The object is waiting for a "VALIDATED" status
13
+ *
14
+ * Note that you are not allowed to store KYC documents on your side unless you have permission from the appropriate authorities in your country
15
+ */
16
+ export class KycDocuments {
17
+ /**
18
+ * Get all KycDocuments
19
+ * @param options
20
+ */
21
+ getAll: NoArgMethodOverload<kycDocument.KycDocumentData[]>;
22
+
23
+ /**
24
+ * Get KycDocument
25
+ * @param kycDocumentId
26
+ * @param options
27
+ */
28
+ get: MethodOverload<string, kycDocument.KycDocumentData>;
29
+
30
+ /**
31
+ * Creates temporary URLs where each page of a KYC document can be viewed.
32
+ * @param documentId
33
+ */
34
+ createKycDocumentConsult: MethodOverload<
35
+ string,
36
+ any // Unsure of data structure from docs
37
+ >;
38
+ }
@@ -0,0 +1,59 @@
1
+ import { mandate } from "../models/mandate";
2
+ import { transaction } from "../models/transaction";
3
+ import { base } from "../base";
4
+ import MethodOverload = base.MethodOverload;
5
+ import NoArgMethodOverload = base.NoArgMethodOverload;
6
+ import TwoArgsMethodOverload = base.TwoArgsMethodOverload;
7
+
8
+ export class Mandates {
9
+ /**
10
+ * Create a new Mandate
11
+ * @param mandate
12
+ * @param options
13
+ */
14
+ create: MethodOverload<mandate.CreateMandate, mandate.MandateData>;
15
+
16
+ /**
17
+ * Get all mandates
18
+ * @param options
19
+ */
20
+ getAll: NoArgMethodOverload<mandate.MandateData[]>;
21
+
22
+ /**
23
+ * Get mandate by ID
24
+ * @param mandateId
25
+ * @param options
26
+ */
27
+ get: MethodOverload<string, mandate.MandateData>;
28
+
29
+ /**
30
+ * Cancel a mandate
31
+ * @param mandateId
32
+ * @param options
33
+ */
34
+ cancel: MethodOverload<string, mandate.MandateData>;
35
+
36
+ /**
37
+ * Gets user's mandates
38
+ * @param userId
39
+ * @param options
40
+ */
41
+ getMandatesForUser: MethodOverload<string, mandate.MandateData[]>;
42
+
43
+ /**
44
+ * Gets bank account mandates
45
+ * @param userId
46
+ * @param bankAccountId
47
+ * @param options
48
+ */
49
+ getMandatesForBankAccount: TwoArgsMethodOverload<string,
50
+ string,
51
+ mandate.MandateData[]>;
52
+
53
+ /**
54
+ * Gets Transactions for a Mandate
55
+ * @param mandateId
56
+ * @param options
57
+ */
58
+ getTransactions: MethodOverload<string, transaction.TransactionData[]>;
59
+ }
@@ -0,0 +1,11 @@
1
+ import { base } from "../base";
2
+ import TwoArgsMethodOverload = base.TwoArgsMethodOverload;
3
+
4
+ export class OptionsHelper {
5
+ /**
6
+ * Adds Idempotency-Key headers to the provided 'options' parameter
7
+ * @param options
8
+ * @param idempotencyKey
9
+ */
10
+ withIdempotency: TwoArgsMethodOverload<base.MethodOptions, string, base.MethodOptions>
11
+ }
@@ -0,0 +1,319 @@
1
+ import { payIn } from "../models/payIn";
2
+ import { refund } from "../models/refund";
3
+ import { base } from "../base";
4
+ import MethodOverload = base.MethodOverload;
5
+ import TwoArgsMethodOverload = base.TwoArgsMethodOverload;
6
+ import NoArgMethodOverload = base.NoArgMethodOverload;
7
+ import ThreeArgsMethodOverload = base.ThreeArgsMethodOverload;
8
+
9
+ export class PayIns {
10
+ /**
11
+ * Create new pay-in
12
+ * @param payIn
13
+ * @param options
14
+ */
15
+ create:
16
+ MethodOverload<payIn.CreateCardDirectPayIn, payIn.CardDirectPayInData> &
17
+ MethodOverload<payIn.CreateCardPreAuthorizedPayIn, payIn.CardPreAuthorizedPayInData> &
18
+ MethodOverload<payIn.CreateCardWebPayIn, payIn.CardWebPayInData> &
19
+ MethodOverload<payIn.CreateBankWireDirectPayIn, payIn.BankWireDirectPayInData> &
20
+ MethodOverload<payIn.CreatePayconiqWebPayInData, payIn.PayconiqWebPayInData> &
21
+ MethodOverload<payIn.CreateDirectDebitDirectPayIn, payIn.DirectDebitDirectPayInData> &
22
+ MethodOverload<payIn.CreateDirectDebitWebPayIn, payIn.DirectDebitWebPayInData> &
23
+ MethodOverload<payIn.CreateMbwayWebPayIn, payIn.MbwayWebPayInData> &
24
+ MethodOverload<payIn.CreateMultibancoWebPayIn, payIn.MultibancoWebPayInData> &
25
+ MethodOverload<payIn.CreateSatispayWebPayIn, payIn.SatispayWebPayInData> &
26
+ MethodOverload<payIn.CreateBlikWebPayIn, payIn.BlikWebPayInData> &
27
+ MethodOverload<payIn.CreateApplePayPayIn, payIn.ApplePayPayInData> &
28
+ MethodOverload<payIn.CreateGooglePayDirectPayIn, payIn.GooglePayDirectPayInData> &
29
+ MethodOverload<payIn.CreateKlarnaWebPayIn, payIn.KlarnaWebPayInData> &
30
+ MethodOverload<payIn.CreateIdealWebPayIn, payIn.IdealWebPayInData> &
31
+ MethodOverload<payIn.CreateGiropayWebPayIn, payIn.GiropayWebPayInData> &
32
+ MethodOverload<payIn.CreateSwishWebPayIn, payIn.SwishWebPayInData> &
33
+ MethodOverload<payIn.CreateTwintWebPayIn, payIn.TwintWebPayInData> &
34
+ MethodOverload<payIn.CreateBancontactWebPayIn, payIn.BancontactWebPayInData> &
35
+ MethodOverload<payIn.CreateBizumWebPayIn, payIn.BizumWebPayInData> &
36
+ MethodOverload<payIn.CreatePayByBankWebPayIn, payIn.PayByBankWebPayInData>;
37
+
38
+
39
+
40
+ /**
41
+ * Get pay-in
42
+ * @param payInId
43
+ * @param options
44
+ */
45
+ get: MethodOverload<string, payIn.PayInData>;
46
+
47
+ /**
48
+ * Create refund for pay-in object
49
+ * @param payInId
50
+ * @param refundData
51
+ * @param options
52
+ */
53
+ createRefund: TwoArgsMethodOverload<string,
54
+ refund.CreatePayInRefund,
55
+ refund.RefundData>;
56
+
57
+ /**
58
+ * Gets list of Refunds for a PayIn
59
+ * @param payInId
60
+ * @param options
61
+ */
62
+ getRefunds: MethodOverload<string, refund.RefundData[]>;
63
+
64
+ /**
65
+ * Get Recurring PayIn
66
+ * @param payInId
67
+ */
68
+ getRecurringPayin: MethodOverload<string, payIn.PayInRecurringRegistrationData>;
69
+
70
+ /**
71
+ * Update Recurring PayIn
72
+ * @param payInId
73
+ * @param updateData
74
+ */
75
+ updateRecurringPayin: TwoArgsMethodOverload<string,
76
+ payIn.UpdatePayInRecurringRegistration,
77
+ payIn.PayInRecurringRegistrationData>;
78
+
79
+ /**
80
+ * Create Recurring PayIn Registration
81
+ * @param createData
82
+ */
83
+ createRecurringPayment: MethodOverload<payIn.CreatePayInRecurringRegistration,
84
+ payIn.PayInRecurringRegistrationData>;
85
+
86
+ /**
87
+ * Create new recurring pay-in CIT
88
+ */
89
+ createRecurringPayInRegistrationCIT: MethodOverload<payIn.CreateRecurringPayInCIT,
90
+ payIn.RecurringPayInData>;
91
+
92
+ /**
93
+ * Create new recurring pay-in MIT
94
+ */
95
+ createRecurringPayInRegistrationMIT: MethodOverload<payIn.CreateRecurringPayInMIT,
96
+ payIn.RecurringPayInData>;
97
+
98
+ /**
99
+ * Create new Card PreAuthorized Deposit PayIn without complement
100
+ */
101
+ createCardPreAuthorizedDepositPayIn:
102
+ MethodOverload<payIn.CreateCardPreAuthorizedDepositPayIn, payIn.CardPreAuthorizedDepositPayInData>;
103
+
104
+ /**
105
+ * Create new Card PreAuthorized Deposit PayIn prior to complement
106
+ */
107
+ createDepositPreauthorizedPayInPriorToComplement:
108
+ MethodOverload<payIn.CreateCardPreAuthorizedDepositPayIn, payIn.CardPreAuthorizedDepositPayInData>;
109
+
110
+ /**
111
+ * Create new Card PreAuthorized Deposit PayIn complement
112
+ */
113
+ createDepositPreauthorizedPayInComplement:
114
+ MethodOverload<payIn.CreateCardPreAuthorizedDepositPayIn, payIn.CardPreAuthorizedDepositPayInData>;
115
+
116
+ createRecurringPayPalPayInCIT: MethodOverload<payIn.CreateRecurringPayPalPayInCIT,
117
+ payIn.RecurringPayInData>;
118
+
119
+ createRecurringPayPalPayInMIT: MethodOverload<payIn.CreateRecurringPayPalPayInMIT,
120
+ payIn.RecurringPayInData>;
121
+
122
+ /**
123
+ * Create new PayPal Web pay-in
124
+ * To be used instead of the 'create' method for PayPal PayIns
125
+ * @param payIn
126
+ * @param options
127
+ */
128
+ createPayPal:
129
+ MethodOverload<payIn.CreatePayPalWebPayIn, payIn.PayPalWebPayInData>;
130
+
131
+ /**
132
+ * Create new GooglePay Direct pay-in
133
+ * To be used instead of the 'create' method for GooglePay PayIns
134
+ * @param payIn
135
+ * @param options
136
+ */
137
+ createGooglePay:
138
+ MethodOverload<payIn.CreateGooglePayDirectPayIn, payIn.GooglePayDirectPayInData>;
139
+
140
+ /**
141
+ * Get Payment Method Metadata
142
+ * The body should contain the 'Type' and: 'Bin' (if the type is BIN) or 'Token' (if the type is GOOGLE_PAY)
143
+ */
144
+ getPaymentMethodMetadata: MethodOverload<payIn.PaymentMethodMetadataRequest, payIn.PaymentMethodMetadata>;
145
+
146
+ /**
147
+ * Add tracking information to a PayPal PayIn (add the tracking number and carrier for LineItems shipments.)
148
+ *
149
+ * Caution – Tracking information cannot be edited
150
+ *
151
+ * You can’t modify the TrackingNumber, Carrier, or NotifyBuyer once added.
152
+ *
153
+ * You can only send a unique tracking number once.
154
+ *
155
+ * @param {string} payInId The ID of the PayIn
156
+ * @param {Object} trackingInformation trackingInformation object
157
+ * @param {Function} callback Callback function
158
+ * @param {Object} options Request options
159
+ * @return {Object} Request promise
160
+ */
161
+ addPayPalTrackingInformation: TwoArgsMethodOverload<string,
162
+ payIn.PayPalWebTrackingData,
163
+ payIn.PayPalWebPayInData>;
164
+
165
+ /**
166
+ * View card details for a Web Card PayIn
167
+ * @param payInId
168
+ * @param options
169
+ */
170
+ getCardWebPayInExtendedDetails: MethodOverload<string, payIn.CardWebExtendedPayInData>;
171
+
172
+ /**
173
+ * Create new pay-in Payconiq Web, using the latest API url (/payment-methods/payconiq)
174
+ * @param payIn
175
+ * @param options
176
+ */
177
+ createPayconiq: MethodOverload<payIn.CreatePayconiqWebPayInData, payIn.PayconiqWebPayInData>
178
+
179
+ /**
180
+ * Create a pay in intent authorization
181
+ * @param {payIn.CreatePayInIntentAuthorization} payInIntentAuthorization PayInIntentAuthorization object
182
+ * @param {Function} callback Callback function
183
+ * @param {Object} options Request options
184
+ * @return {Object} Request promise
185
+ */
186
+ createPayInIntentAuthorization: MethodOverload<payIn.CreatePayInIntentAuthorization, payIn.PayInIntentData>
187
+
188
+ /**
189
+ * Create a pay in intent full capture
190
+ * @param {string} payInIntentId PayInIntent identifier
191
+ * @param {payIn.CreatePayInIntentFullCapture} payInIntentFullCapture PayInIntentFullCapture object
192
+ * @param {Function} callback Callback function
193
+ * @param {Object} options Request options
194
+ * @return {Object} Request promise
195
+ */
196
+ createPayInIntentFullCapture: TwoArgsMethodOverload<string, payIn.CreatePayInIntentFullCapture, payIn.PayInIntentData>
197
+
198
+ /**
199
+ * Create a pay in intent partial capture
200
+ * @param {string} payInIntentId PayInIntent identifier
201
+ * @param {payIn.CreatePayInIntentPartialCapture} payInIntentPartialCapture PayInIntentPartialCapture object
202
+ * @param {Function} callback Callback function
203
+ * @param {Object} options Request options
204
+ * @return {Object} Request promise
205
+ */
206
+ createPayInIntentPartialCapture: TwoArgsMethodOverload<string, payIn.CreatePayInIntentPartialCapture, payIn.PayInIntentData>
207
+
208
+ /**
209
+ * Get a PayInIntent
210
+ * @param {string} payInIntentId PayInIntent identifier
211
+ * @param {Function} callback Callback function
212
+ * @param {Object} options Request options
213
+ * @return {Object} Request promise
214
+ */
215
+ getPayInIntent: MethodOverload<string, payIn.PayInIntentData>
216
+
217
+ /**
218
+ * Cancel a PayInIntent
219
+ * @param {string} payInIntentId PayInIntent identifier
220
+ * @param {payIn.FullCancelPayInIntent} intentDetails Details about the intent to be canceled
221
+ * @param {Function} callback Callback function
222
+ * @param {Object} options Request options
223
+ * @return {Object} Request promise
224
+ */
225
+ fullCancelPayInIntent: TwoArgsMethodOverload<string, payIn.FullCancelPayInIntent, payIn.PayInIntentData>
226
+
227
+ /**
228
+ * Cancel a PayInIntent
229
+ * @param {string} payInIntentId PayInIntent identifier
230
+ * @param {payIn.PartialCancelPayInIntent} intentDetails Details about the intent to be canceled
231
+ * @param {Function} callback Callback function
232
+ * @param {Object} options Request options
233
+ * @return {Object} Request promise
234
+ */
235
+ partialCancelPayInIntent: TwoArgsMethodOverload<string, payIn.PartialCancelPayInIntent, payIn.PayInIntentData>
236
+
237
+ /**
238
+ * Create PayInIntent splits
239
+ * @param {string} payInIntentId PayInIntent identifier
240
+ * @param {payIn.CreatePayInIntentSplits} splits CreatePayInIntentSplits object
241
+ * @param {Function} callback Callback function
242
+ * @param {Object} options Request options
243
+ * @return {Object} Request promise
244
+ */
245
+ createPayInIntentSplits: TwoArgsMethodOverload<string, payIn.CreatePayInIntentSplits, payIn.PayInIntentSplitsData>
246
+
247
+ /**
248
+ * Execute split
249
+ * @param {string} payInIntentId PayInIntent identifier
250
+ * @param {string} splitId Split identifier
251
+ * @param {Function} callback Callback function
252
+ * @param {Object} options Request options
253
+ * @return {Object} Request promise
254
+ */
255
+ executePayInIntentSplit: TwoArgsMethodOverload<string, string, payIn.PayInIntentSplitData>
256
+
257
+ /**
258
+ * Reverse split
259
+ * @param {string} payInIntentId PayInIntent identifier
260
+ * @param {string} splitId Split identifier
261
+ * @param {Function} callback Callback function
262
+ * @param {Object} options Request options
263
+ * @return {Object} Request promise
264
+ */
265
+ reversePayInIntentSplit: TwoArgsMethodOverload<string, string, payIn.PayInIntentSplitData>
266
+
267
+ /**
268
+ * Get split
269
+ * @param {string} payInIntentId PayInIntent identifier
270
+ * @param {string} splitId Split identifier
271
+ * @param {Function} callback Callback function
272
+ * @param {Object} options Request options
273
+ * @return {Object} Request promise
274
+ */
275
+ getPayInIntentSplit: TwoArgsMethodOverload<string, string, payIn.PayInIntentSplitData>
276
+
277
+ /**
278
+ * Update split
279
+ * @param {string} payInIntentId PayInIntent identifier
280
+ * @param {string} splitId Split identifier
281
+ * @param {payIn.UpdatePayInIntentSplit} Object containing the split properties to be updated
282
+ * @param {Function} callback Callback function
283
+ * @param {Object} options Request options
284
+ * @return {Object} Request promise
285
+ */
286
+ updatePayInIntentSplit: ThreeArgsMethodOverload<string, string, payIn.UpdatePayInIntentSplit, payIn.PayInIntentSplitData>
287
+
288
+ /**
289
+ * Retrieve a paginated list of banks that you can present to the user for selection during their Pay by Bank checkout experience
290
+ * Optionally filter by CountryCodes. Paginated.
291
+ * @param {Function} callback Callback function
292
+ * @param {Object} options Request options
293
+ * @return {Object} Request promise
294
+ */
295
+ getPayByBankSupportedBanks: NoArgMethodOverload<payIn.PayByBankSupportedBank>
296
+
297
+ /**
298
+ * Send key pre-transaction data such as order details, buyer information,
299
+ * and merchant context before initiating a PayPal payment.
300
+ *
301
+ * Given that the payload can be anything, depending on what PayPal needs, there is no defined interface for it.
302
+ *
303
+ * @param dataCollection The data collection to be created
304
+ * @param callback Callback function
305
+ * @param options Request options
306
+ * @returns {Object} Request promise
307
+ */
308
+ createPayPalDataCollection: MethodOverload<any, any>
309
+
310
+ /**
311
+ * Get a PayPal data collection.
312
+ *
313
+ * @param dataCollectionId Data collection identifier
314
+ * @param callback Callback function
315
+ * @param options Request options
316
+ * @returns {Object} Request promise
317
+ */
318
+ getPayPalDataCollection: MethodOverload<string, any>
319
+ }