velopayments 2.20.119 → 2.23.78.beta1

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 (697) hide show
  1. checksums.yaml +5 -5
  2. data/Makefile +5 -2
  3. data/README.md +116 -45
  4. data/docs/{AcceptedPayment.md → AcceptedPaymentV3.md} +2 -2
  5. data/docs/AutoTopUpConfig2.md +23 -0
  6. data/docs/Challenge2.md +19 -0
  7. data/docs/CountriesApi.md +25 -25
  8. data/docs/CreateFundingAccountRequestV2.md +29 -0
  9. data/docs/CreatePayee2.md +3 -3
  10. data/docs/CreatePayeesCSVResponseRejectedCsvRows.md +1 -1
  11. data/docs/{CreatePayoutRequest.md → CreatePayoutRequestV3.md} +3 -3
  12. data/docs/CreateWebhookRequest.md +23 -0
  13. data/docs/CurrenciesApi.md +6 -6
  14. data/docs/FundingAccountResponse.md +15 -7
  15. data/docs/FundingAccountResponse2.md +35 -0
  16. data/docs/{CurrencyType.md → FundingAccountType.md} +2 -3
  17. data/docs/FundingAudit.md +5 -5
  18. data/docs/FundingEvent.md +1 -1
  19. data/docs/FundingManagerApi.md +329 -32
  20. data/docs/FundingManagerPrivateApi.md +7 -7
  21. data/docs/FundingPayorStatusAuditResponse.md +2 -2
  22. data/docs/FundingRequestV3.md +19 -0
  23. data/docs/FxSummaryV3.md +1 -1
  24. data/docs/FxSummaryV4.md +1 -1
  25. data/docs/GetFundingsResponse.md +5 -1
  26. data/docs/GetFundingsResponseLinks.md +19 -0
  27. data/docs/GetPayeeListResponse.md +49 -0
  28. data/docs/GetPayeeListResponseCompany.md +19 -0
  29. data/docs/GetPayeeListResponseIndividual.md +17 -0
  30. data/docs/GetPaymentsForPayoutResponseV3Summary.md +3 -3
  31. data/docs/GetPaymentsForPayoutResponseV4Summary.md +6 -4
  32. data/docs/InlineResponse404.md +19 -0
  33. data/docs/InlineResponse404Errors.md +23 -0
  34. data/docs/InlineResponse412.md +19 -0
  35. data/docs/InlineResponse412Errors.md +23 -0
  36. data/docs/{UserResponse2Roles.md → InvitationStatus2.md} +2 -3
  37. data/docs/ListFundingAccountsResponse2.md +21 -0
  38. data/docs/{ListPaymentsResponse.md → ListPaymentsResponseV3.md} +3 -3
  39. data/docs/{ListPaymentsResponsePage.md → ListPaymentsResponseV3Page.md} +2 -2
  40. data/docs/ListPaymentsResponseV4.md +1 -1
  41. data/docs/ListSourceAccountResponseV2.md +1 -1
  42. data/docs/ListSourceAccountResponseV2Links.md +19 -0
  43. data/docs/ListSourceAccountResponseV3.md +21 -0
  44. data/docs/ListSourceAccountResponseV3Links.md +19 -0
  45. data/docs/LoginApi.md +6 -2
  46. data/docs/MarketingOptIn.md +1 -1
  47. data/docs/Name.md +23 -0
  48. data/docs/Notifications2.md +17 -0
  49. data/docs/PagedPayeeResponse2.md +1 -1
  50. data/docs/PagedPaymentsResponseV3.md +21 -0
  51. data/docs/Payee.md +2 -2
  52. data/docs/Payee2.md +2 -2
  53. data/docs/{PayeeResponseV3.md → PayeeDetailResponse.md} +9 -7
  54. data/docs/PayeeDetailResponse2.md +73 -0
  55. data/docs/PayeeInvitationApi.md +227 -2
  56. data/docs/PayeePayorRef2.md +25 -0
  57. data/docs/PayeePayorRefV2.md +1 -1
  58. data/docs/PayeePayorRefV3.md +3 -3
  59. data/docs/PayeeResponse.md +2 -2
  60. data/docs/PayeeResponseV2.md +3 -3
  61. data/docs/PayeeType2.md +16 -0
  62. data/docs/PayeeUserSelfUpdateRequest.md +27 -0
  63. data/docs/PayeesApi.md +421 -8
  64. data/docs/PaymentAuditServiceApi.md +267 -35
  65. data/docs/PaymentDeltaResponseV4.md +21 -0
  66. data/docs/PaymentDeltaV4.md +31 -0
  67. data/docs/PaymentEventResponseV3.md +1 -1
  68. data/docs/PaymentEventResponseV4.md +1 -1
  69. data/docs/{PaymentInstruction.md → PaymentInstructionV3.md} +5 -3
  70. data/docs/PaymentResponseV3.md +1 -1
  71. data/docs/PaymentResponseV4.md +7 -1
  72. data/docs/PaymentV3.md +37 -0
  73. data/docs/PayorV1.md +3 -1
  74. data/docs/PayorV2.md +5 -1
  75. data/docs/PayorsApi.md +14 -14
  76. data/docs/PayoutCompanyV3.md +17 -0
  77. data/docs/PayoutIndividualV3.md +17 -0
  78. data/docs/PayoutNameV3.md +19 -0
  79. data/docs/PayoutPayeeV3.md +21 -0
  80. data/docs/PayoutServiceApi.md +393 -0
  81. data/docs/PayoutSummaryAuditV4.md +4 -2
  82. data/docs/{PayoutSummaryResponse.md → PayoutSummaryResponseV3.md} +8 -6
  83. data/docs/PingResponse.md +19 -0
  84. data/docs/{QuoteFxSummary.md → QuoteFxSummaryV3.md} +4 -4
  85. data/docs/QuoteResponseV3.md +17 -0
  86. data/docs/{Region.md → RegionV2.md} +2 -2
  87. data/docs/{RejectedPayment.md → RejectedPaymentV3.md} +2 -2
  88. data/docs/SourceAccountResponse.md +3 -1
  89. data/docs/SourceAccountResponseV2.md +4 -2
  90. data/docs/SourceAccountResponseV3.md +47 -0
  91. data/docs/SourceAccountType.md +16 -0
  92. data/docs/{SourceAccount.md → SourceAccountV3.md} +2 -2
  93. data/docs/SupportedCountriesResponseV2.md +17 -0
  94. data/docs/{SupportedCountry2.md → SupportedCountryV2.md} +3 -3
  95. data/docs/SupportedCurrencyResponseV2.md +17 -0
  96. data/docs/{SupportedCurrency.md → SupportedCurrencyV2.md} +2 -2
  97. data/docs/TransferRequest2.md +21 -0
  98. data/docs/TransmissionType.md +16 -0
  99. data/docs/TransmissionTypes.md +21 -0
  100. data/docs/TransmissionTypes2.md +21 -0
  101. data/docs/UpdatePayeeDetailsRequest.md +29 -0
  102. data/docs/UpdatePayeeDetailsRequest2.md +29 -0
  103. data/docs/UpdateWebhookRequest.md +21 -0
  104. data/docs/UserResponse.md +1 -1
  105. data/docs/UsersApi.md +62 -6
  106. data/docs/WatchlistStatus2.md +16 -0
  107. data/docs/WebhookResponse.md +25 -0
  108. data/docs/WebhooksApi.md +280 -0
  109. data/docs/WebhooksResponse.md +21 -0
  110. data/docs/WithdrawPaymentRequest.md +17 -0
  111. data/lib/velopayments.rb +68 -32
  112. data/lib/velopayments/api/countries_api.rb +38 -35
  113. data/lib/velopayments/api/currencies_api.rb +13 -12
  114. data/lib/velopayments/api/funding_manager_api.rb +516 -74
  115. data/lib/velopayments/api/funding_manager_private_api.rb +14 -13
  116. data/lib/velopayments/api/login_api.rb +21 -14
  117. data/lib/velopayments/api/payee_invitation_api.rb +312 -33
  118. data/lib/velopayments/api/payees_api.rb +582 -46
  119. data/lib/velopayments/api/payment_audit_service_api.rb +444 -78
  120. data/lib/velopayments/api/payors_api.rb +48 -40
  121. data/lib/velopayments/api/payors_private_api.rb +6 -5
  122. data/lib/velopayments/api/payout_service_api.rb +506 -0
  123. data/lib/velopayments/api/tokens_api.rb +6 -5
  124. data/lib/velopayments/api/users_api.rb +146 -54
  125. data/lib/velopayments/api/webhooks_api.rb +350 -0
  126. data/lib/velopayments/api_client.rb +47 -44
  127. data/lib/velopayments/api_error.rb +2 -2
  128. data/lib/velopayments/configuration.rb +35 -8
  129. data/lib/velopayments/models/{accepted_payment.rb → accepted_payment_v3.rb} +13 -9
  130. data/lib/velopayments/models/access_token_response.rb +10 -6
  131. data/lib/velopayments/models/access_token_validation_request.rb +10 -6
  132. data/lib/velopayments/models/auth_response.rb +10 -6
  133. data/lib/velopayments/models/auto_top_up_config.rb +10 -6
  134. data/lib/velopayments/models/auto_top_up_config2.rb +248 -0
  135. data/lib/velopayments/models/challenge.rb +10 -6
  136. data/lib/velopayments/models/challenge2.rb +285 -0
  137. data/lib/velopayments/models/company.rb +15 -11
  138. data/lib/velopayments/models/company2.rb +15 -11
  139. data/lib/velopayments/models/company_response.rb +10 -6
  140. data/lib/velopayments/models/company_v1.rb +15 -11
  141. data/lib/velopayments/models/create_funding_account_request_v2.rb +441 -0
  142. data/lib/velopayments/models/create_individual.rb +10 -6
  143. data/lib/velopayments/models/create_individual2.rb +10 -6
  144. data/lib/velopayments/models/create_individual2_name.rb +10 -6
  145. data/lib/velopayments/models/create_payee.rb +10 -6
  146. data/lib/velopayments/models/create_payee2.rb +13 -9
  147. data/lib/velopayments/models/create_payee_address.rb +10 -6
  148. data/lib/velopayments/models/create_payee_address2.rb +10 -6
  149. data/lib/velopayments/models/create_payees_csv_request.rb +10 -6
  150. data/lib/velopayments/models/create_payees_csv_request2.rb +10 -6
  151. data/lib/velopayments/models/create_payees_csv_response.rb +10 -6
  152. data/lib/velopayments/models/create_payees_csv_response2.rb +10 -6
  153. data/lib/velopayments/models/create_payees_csv_response_rejected_csv_rows.rb +10 -6
  154. data/lib/velopayments/models/create_payees_request.rb +10 -6
  155. data/lib/velopayments/models/create_payees_request2.rb +10 -6
  156. data/lib/velopayments/models/create_payment_channel.rb +10 -6
  157. data/lib/velopayments/models/create_payment_channel2.rb +10 -6
  158. data/lib/velopayments/models/create_payor_link_request.rb +10 -6
  159. data/lib/velopayments/models/{create_payout_request.rb → create_payout_request_v3.rb} +14 -10
  160. data/lib/velopayments/models/create_webhook_request.rb +315 -0
  161. data/lib/velopayments/models/error.rb +10 -6
  162. data/lib/velopayments/models/error_response.rb +10 -6
  163. data/lib/velopayments/models/failed_submission.rb +10 -6
  164. data/lib/velopayments/models/failed_submission2.rb +10 -6
  165. data/lib/velopayments/models/funding_account_response.rb +105 -10
  166. data/lib/velopayments/models/{create_funding_account_request.rb → funding_account_response2.rb} +106 -95
  167. data/lib/velopayments/models/funding_account_type.rb +37 -0
  168. data/lib/velopayments/models/funding_audit.rb +23 -17
  169. data/lib/velopayments/models/funding_event.rb +11 -7
  170. data/lib/velopayments/models/funding_event_type.rb +3 -2
  171. data/lib/velopayments/models/funding_payor_status_audit_response.rb +47 -7
  172. data/lib/velopayments/models/funding_request_v1.rb +10 -6
  173. data/lib/velopayments/models/funding_request_v2.rb +10 -6
  174. data/lib/velopayments/models/funding_request_v3.rb +259 -0
  175. data/lib/velopayments/models/fx_summary_v3.rb +11 -7
  176. data/lib/velopayments/models/fx_summary_v4.rb +11 -7
  177. data/lib/velopayments/models/get_fundings_response.rb +37 -24
  178. data/lib/velopayments/models/{paged_response.rb → get_fundings_response_links.rb} +26 -24
  179. data/lib/velopayments/models/{payee_response2.rb → get_payee_list_response.rb} +85 -113
  180. data/lib/velopayments/models/get_payee_list_response_company.rb +268 -0
  181. data/lib/velopayments/models/{user_response2_roles.rb → get_payee_list_response_individual.rb} +14 -10
  182. data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +10 -6
  183. data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +10 -6
  184. data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +13 -9
  185. data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +10 -6
  186. data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +25 -11
  187. data/lib/velopayments/models/get_payout_statistics.rb +10 -6
  188. data/lib/velopayments/models/get_payouts_response_v3.rb +10 -6
  189. data/lib/velopayments/models/get_payouts_response_v3_links.rb +10 -6
  190. data/lib/velopayments/models/get_payouts_response_v3_page.rb +10 -6
  191. data/lib/velopayments/models/get_payouts_response_v4.rb +10 -6
  192. data/lib/velopayments/models/individual.rb +10 -6
  193. data/lib/velopayments/models/individual2.rb +10 -6
  194. data/lib/velopayments/models/individual_response.rb +10 -6
  195. data/lib/velopayments/models/individual_v1.rb +10 -6
  196. data/lib/velopayments/models/individual_v1_name.rb +10 -6
  197. data/lib/velopayments/models/inline_response400.rb +10 -6
  198. data/lib/velopayments/models/inline_response400_errors.rb +10 -6
  199. data/lib/velopayments/models/inline_response401.rb +10 -6
  200. data/lib/velopayments/models/inline_response401_errors.rb +10 -6
  201. data/lib/velopayments/models/inline_response403.rb +10 -6
  202. data/lib/velopayments/models/inline_response403_errors.rb +10 -6
  203. data/lib/velopayments/models/inline_response404.rb +225 -0
  204. data/lib/velopayments/models/inline_response404_errors.rb +240 -0
  205. data/lib/velopayments/models/inline_response409.rb +10 -6
  206. data/lib/velopayments/models/inline_response409_errors.rb +10 -6
  207. data/lib/velopayments/models/inline_response412.rb +225 -0
  208. data/lib/velopayments/models/inline_response412_errors.rb +240 -0
  209. data/lib/velopayments/models/invitation_status.rb +3 -2
  210. data/lib/velopayments/models/invitation_status2.rb +38 -0
  211. data/lib/velopayments/models/invitation_status_response.rb +10 -6
  212. data/lib/velopayments/models/invite_payee_request.rb +10 -6
  213. data/lib/velopayments/models/invite_payee_request2.rb +10 -6
  214. data/lib/velopayments/models/invite_user_request.rb +19 -15
  215. data/lib/velopayments/models/kyc_state.rb +3 -2
  216. data/lib/velopayments/models/language.rb +3 -2
  217. data/lib/velopayments/models/language2.rb +3 -2
  218. data/lib/velopayments/models/link_for_response.rb +10 -6
  219. data/lib/velopayments/models/list_funding_accounts_response.rb +10 -6
  220. data/lib/velopayments/models/list_funding_accounts_response2.rb +233 -0
  221. data/lib/velopayments/models/{list_payments_response.rb → list_payments_response_v3.rb} +14 -10
  222. data/lib/velopayments/models/{paged_response_page.rb → list_payments_response_v3_page.rb} +13 -9
  223. data/lib/velopayments/models/list_payments_response_v4.rb +11 -7
  224. data/lib/velopayments/models/list_source_account_response.rb +10 -6
  225. data/lib/velopayments/models/list_source_account_response_links.rb +10 -6
  226. data/lib/velopayments/models/list_source_account_response_page.rb +10 -6
  227. data/lib/velopayments/models/list_source_account_response_v2.rb +11 -7
  228. data/lib/velopayments/models/list_source_account_response_v2_links.rb +219 -0
  229. data/lib/velopayments/models/list_source_account_response_v3.rb +233 -0
  230. data/lib/velopayments/models/list_source_account_response_v3_links.rb +219 -0
  231. data/lib/velopayments/models/location_type.rb +3 -2
  232. data/lib/velopayments/models/marketing_opt_in.rb +11 -7
  233. data/lib/velopayments/models/mfa_details.rb +10 -6
  234. data/lib/velopayments/models/mfa_type.rb +3 -2
  235. data/lib/velopayments/models/name.rb +333 -0
  236. data/lib/velopayments/models/notifications.rb +10 -6
  237. data/lib/velopayments/models/{get_fundings_response_all_of.rb → notifications2.rb} +20 -18
  238. data/lib/velopayments/models/ofac_status.rb +3 -2
  239. data/lib/velopayments/models/ofac_status2.rb +3 -2
  240. data/lib/velopayments/models/onboarded_status.rb +3 -2
  241. data/lib/velopayments/models/onboarded_status2.rb +3 -2
  242. data/lib/velopayments/models/page_for_response.rb +10 -6
  243. data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +10 -6
  244. data/lib/velopayments/models/paged_payee_invitation_status_response.rb +10 -6
  245. data/lib/velopayments/models/paged_payee_invitation_status_response2.rb +10 -6
  246. data/lib/velopayments/models/paged_payee_invitation_status_response_page.rb +10 -6
  247. data/lib/velopayments/models/paged_payee_response.rb +10 -6
  248. data/lib/velopayments/models/paged_payee_response2.rb +11 -7
  249. data/lib/velopayments/models/paged_payee_response2_summary.rb +10 -6
  250. data/lib/velopayments/models/paged_payee_response_links.rb +10 -6
  251. data/lib/velopayments/models/paged_payee_response_page.rb +10 -6
  252. data/lib/velopayments/models/paged_payee_response_summary.rb +10 -6
  253. data/lib/velopayments/models/paged_payments_response_v3.rb +233 -0
  254. data/lib/velopayments/models/paged_user_response.rb +10 -6
  255. data/lib/velopayments/models/paged_user_response_links.rb +10 -6
  256. data/lib/velopayments/models/paged_user_response_page.rb +10 -6
  257. data/lib/velopayments/models/password_request.rb +10 -6
  258. data/lib/velopayments/models/payee.rb +12 -8
  259. data/lib/velopayments/models/payee2.rb +12 -8
  260. data/lib/velopayments/models/payee_address.rb +10 -6
  261. data/lib/velopayments/models/payee_address2.rb +10 -6
  262. data/lib/velopayments/models/payee_delta.rb +10 -6
  263. data/lib/velopayments/models/payee_delta2.rb +10 -6
  264. data/lib/velopayments/models/payee_delta_response.rb +10 -6
  265. data/lib/velopayments/models/payee_delta_response2.rb +10 -6
  266. data/lib/velopayments/models/payee_delta_response2_links.rb +10 -6
  267. data/lib/velopayments/models/payee_delta_response_links.rb +10 -6
  268. data/lib/velopayments/models/payee_delta_response_page.rb +10 -6
  269. data/lib/velopayments/models/{payee_response_v3.rb → payee_detail_response.rb} +30 -17
  270. data/lib/velopayments/models/payee_detail_response2.rb +475 -0
  271. data/lib/velopayments/models/payee_invitation_status.rb +10 -6
  272. data/lib/velopayments/models/payee_invitation_status_response.rb +10 -6
  273. data/lib/velopayments/models/payee_invitation_status_response2.rb +10 -6
  274. data/lib/velopayments/models/payee_payment_channel.rb +10 -6
  275. data/lib/velopayments/models/payee_payment_channel2.rb +10 -6
  276. data/lib/velopayments/models/payee_payor_ref.rb +10 -6
  277. data/lib/velopayments/models/payee_payor_ref2.rb +248 -0
  278. data/lib/velopayments/models/payee_payor_ref_v2.rb +11 -7
  279. data/lib/velopayments/models/payee_payor_ref_v3.rb +12 -42
  280. data/lib/velopayments/models/payee_response.rb +12 -8
  281. data/lib/velopayments/models/payee_response_v2.rb +13 -9
  282. data/lib/velopayments/models/payee_type.rb +3 -2
  283. data/lib/velopayments/models/payee_type2.rb +37 -0
  284. data/lib/velopayments/models/{user_response2.rb → payee_user_self_update_request.rb} +54 -194
  285. data/lib/velopayments/models/payment_audit_currency_v3.rb +3 -2
  286. data/lib/velopayments/models/payment_audit_currency_v4.rb +3 -2
  287. data/lib/velopayments/models/payment_channel_country.rb +10 -6
  288. data/lib/velopayments/models/payment_channel_rule.rb +10 -6
  289. data/lib/velopayments/models/payment_channel_rules_response.rb +10 -6
  290. data/lib/velopayments/models/payment_delta.rb +10 -6
  291. data/lib/velopayments/models/payment_delta_response.rb +10 -6
  292. data/lib/velopayments/models/payment_delta_response_v4.rb +233 -0
  293. data/lib/velopayments/models/payment_delta_v4.rb +289 -0
  294. data/lib/velopayments/models/payment_event_response_v3.rb +11 -7
  295. data/lib/velopayments/models/payment_event_response_v4.rb +11 -7
  296. data/lib/velopayments/models/{payment_instruction.rb → payment_instruction_v3.rb} +27 -13
  297. data/lib/velopayments/models/payment_rails.rb +3 -2
  298. data/lib/velopayments/models/payment_response_v3.rb +11 -7
  299. data/lib/velopayments/models/payment_response_v4.rb +39 -8
  300. data/lib/velopayments/models/payment_response_v4_payout.rb +10 -6
  301. data/lib/velopayments/models/payment_v3.rb +363 -0
  302. data/lib/velopayments/models/payor_address.rb +10 -6
  303. data/lib/velopayments/models/payor_address_v2.rb +10 -6
  304. data/lib/velopayments/models/payor_aml_transaction_v3.rb +10 -6
  305. data/lib/velopayments/models/payor_aml_transaction_v4.rb +10 -6
  306. data/lib/velopayments/models/payor_branding_response.rb +10 -6
  307. data/lib/velopayments/models/payor_create_api_key_request.rb +10 -6
  308. data/lib/velopayments/models/payor_create_api_key_response.rb +10 -6
  309. data/lib/velopayments/models/payor_create_application_request.rb +10 -6
  310. data/lib/velopayments/models/payor_email_opt_out_request.rb +10 -6
  311. data/lib/velopayments/models/payor_links_response.rb +10 -6
  312. data/lib/velopayments/models/payor_links_response_links.rb +10 -6
  313. data/lib/velopayments/models/payor_links_response_payors.rb +10 -6
  314. data/lib/velopayments/models/payor_logo_request.rb +10 -6
  315. data/lib/velopayments/models/payor_v1.rb +23 -10
  316. data/lib/velopayments/models/payor_v2.rb +33 -10
  317. data/lib/velopayments/models/payout_company_v3.rb +215 -0
  318. data/lib/velopayments/models/payout_individual_v3.rb +215 -0
  319. data/lib/velopayments/models/payout_name_v3.rb +229 -0
  320. data/lib/velopayments/models/payout_payee_v3.rb +234 -0
  321. data/lib/velopayments/models/payout_payor_v4.rb +10 -6
  322. data/lib/velopayments/models/payout_principal_v4.rb +10 -6
  323. data/lib/velopayments/models/payout_status_v3.rb +3 -2
  324. data/lib/velopayments/models/payout_status_v4.rb +3 -2
  325. data/lib/velopayments/models/payout_summary_audit_v3.rb +10 -6
  326. data/lib/velopayments/models/payout_summary_audit_v4.rb +22 -9
  327. data/lib/velopayments/models/{payout_summary_response.rb → payout_summary_response_v3.rb} +32 -14
  328. data/lib/velopayments/models/payout_type_v4.rb +3 -2
  329. data/lib/velopayments/models/ping_response.rb +219 -0
  330. data/lib/velopayments/models/query_batch_response.rb +10 -6
  331. data/lib/velopayments/models/query_batch_response2.rb +10 -6
  332. data/lib/velopayments/models/{quote_fx_summary.rb → quote_fx_summary_v3.rb} +15 -11
  333. data/lib/velopayments/models/{quote_response.rb → quote_response_v3.rb} +14 -10
  334. data/lib/velopayments/models/{region.rb → region_v2.rb} +13 -9
  335. data/lib/velopayments/models/register_sms_request.rb +13 -9
  336. data/lib/velopayments/models/{rejected_payment.rb → rejected_payment_v3.rb} +13 -9
  337. data/lib/velopayments/models/resend_token_request.rb +10 -6
  338. data/lib/velopayments/models/reset_password_request.rb +10 -6
  339. data/lib/velopayments/models/role.rb +10 -6
  340. data/lib/velopayments/models/role_update_request.rb +10 -6
  341. data/lib/velopayments/models/self_mfa_type_unregister_request.rb +10 -6
  342. data/lib/velopayments/models/self_update_password_request.rb +10 -6
  343. data/lib/velopayments/models/set_notifications_request.rb +10 -6
  344. data/lib/velopayments/models/source_account_response.rb +24 -11
  345. data/lib/velopayments/models/source_account_response_v2.rb +26 -13
  346. data/lib/velopayments/models/source_account_response_v3.rb +437 -0
  347. data/lib/velopayments/models/source_account_summary_v3.rb +10 -6
  348. data/lib/velopayments/models/source_account_summary_v4.rb +10 -6
  349. data/lib/velopayments/models/source_account_type.rb +37 -0
  350. data/lib/velopayments/models/{source_account.rb → source_account_v3.rb} +13 -9
  351. data/lib/velopayments/models/supported_countries_response.rb +10 -6
  352. data/lib/velopayments/models/{supported_countries_response2.rb → supported_countries_response_v2.rb} +14 -10
  353. data/lib/velopayments/models/supported_country.rb +10 -6
  354. data/lib/velopayments/models/{supported_country2.rb → supported_country_v2.rb} +14 -10
  355. data/lib/velopayments/models/{supported_currency_response.rb → supported_currency_response_v2.rb} +14 -10
  356. data/lib/velopayments/models/{supported_currency.rb → supported_currency_v2.rb} +13 -9
  357. data/lib/velopayments/models/transfer_request.rb +10 -6
  358. data/lib/velopayments/models/transfer_request2.rb +301 -0
  359. data/lib/velopayments/models/transmission_type.rb +38 -0
  360. data/lib/velopayments/models/{list_payments_response_page.rb → transmission_types.rb} +50 -46
  361. data/lib/velopayments/models/transmission_types2.rb +246 -0
  362. data/lib/velopayments/models/unregister_mfa_request.rb +10 -6
  363. data/lib/velopayments/models/update_payee_details_request.rb +266 -0
  364. data/lib/velopayments/models/update_payee_details_request2.rb +266 -0
  365. data/lib/velopayments/models/update_remote_id_request.rb +10 -6
  366. data/lib/velopayments/models/update_webhook_request.rb +288 -0
  367. data/lib/velopayments/models/user_details_update_request.rb +19 -15
  368. data/lib/velopayments/models/user_info.rb +10 -6
  369. data/lib/velopayments/models/user_response.rb +20 -16
  370. data/lib/velopayments/models/user_status.rb +3 -2
  371. data/lib/velopayments/models/user_type.rb +3 -2
  372. data/lib/velopayments/models/user_type2.rb +3 -2
  373. data/lib/velopayments/models/validate_password_response.rb +10 -6
  374. data/lib/velopayments/models/watchlist_status.rb +3 -2
  375. data/lib/velopayments/models/watchlist_status2.rb +40 -0
  376. data/lib/velopayments/models/webhook_response.rb +246 -0
  377. data/lib/velopayments/models/webhooks_response.rb +233 -0
  378. data/lib/velopayments/models/{currency_type.rb → withdraw_payment_request.rb} +39 -34
  379. data/lib/velopayments/version.rb +3 -3
  380. data/oa3-config.json +1 -1
  381. data/spec/api/countries_api_spec.rb +12 -12
  382. data/spec/api/currencies_api_spec.rb +5 -5
  383. data/spec/api/funding_manager_api_spec.rb +93 -18
  384. data/spec/api/funding_manager_private_api_spec.rb +5 -5
  385. data/spec/api/login_api_spec.rb +3 -2
  386. data/spec/api/payee_invitation_api_spec.rb +57 -4
  387. data/spec/api/payees_api_spec.rb +108 -4
  388. data/spec/api/payment_audit_service_api_spec.rb +72 -18
  389. data/spec/api/payors_api_spec.rb +9 -9
  390. data/spec/api/payors_private_api_spec.rb +2 -2
  391. data/spec/api/payout_service_api_spec.rb +127 -0
  392. data/spec/api/tokens_api_spec.rb +2 -2
  393. data/spec/api/users_api_spec.rb +17 -4
  394. data/spec/api/webhooks_api_spec.rb +96 -0
  395. data/spec/api_client_spec.rb +2 -2
  396. data/spec/configuration_spec.rb +2 -2
  397. data/spec/models/{accepted_payment_spec.rb → accepted_payment_v3_spec.rb} +8 -8
  398. data/spec/models/access_token_response_spec.rb +2 -2
  399. data/spec/models/access_token_validation_request_spec.rb +2 -2
  400. data/spec/models/auth_response_spec.rb +2 -2
  401. data/spec/models/auto_top_up_config2_spec.rb +59 -0
  402. data/spec/models/auto_top_up_config_spec.rb +2 -2
  403. data/spec/models/{paged_response_spec.rb → challenge2_spec.rb} +10 -10
  404. data/spec/models/challenge_spec.rb +2 -2
  405. data/spec/models/company2_spec.rb +2 -2
  406. data/spec/models/company_response_spec.rb +2 -2
  407. data/spec/models/company_spec.rb +2 -2
  408. data/spec/models/company_v1_spec.rb +2 -2
  409. data/spec/models/create_funding_account_request_v2_spec.rb +81 -0
  410. data/spec/models/create_individual2_name_spec.rb +2 -2
  411. data/spec/models/create_individual2_spec.rb +2 -2
  412. data/spec/models/create_individual_spec.rb +2 -2
  413. data/spec/models/create_payee2_spec.rb +2 -2
  414. data/spec/models/create_payee_address2_spec.rb +2 -2
  415. data/spec/models/create_payee_address_spec.rb +2 -2
  416. data/spec/models/create_payee_spec.rb +2 -2
  417. data/spec/models/create_payees_csv_request2_spec.rb +2 -2
  418. data/spec/models/create_payees_csv_request_spec.rb +2 -2
  419. data/spec/models/create_payees_csv_response2_spec.rb +2 -2
  420. data/spec/models/create_payees_csv_response_rejected_csv_rows_spec.rb +2 -2
  421. data/spec/models/create_payees_csv_response_spec.rb +2 -2
  422. data/spec/models/create_payees_request2_spec.rb +2 -2
  423. data/spec/models/create_payees_request_spec.rb +2 -2
  424. data/spec/models/create_payment_channel2_spec.rb +2 -2
  425. data/spec/models/create_payment_channel_spec.rb +2 -2
  426. data/spec/models/create_payor_link_request_spec.rb +2 -2
  427. data/spec/models/{create_payout_request_spec.rb → create_payout_request_v3_spec.rb} +8 -8
  428. data/spec/models/{create_funding_account_request_spec.rb → create_webhook_request_spec.rb} +12 -12
  429. data/spec/models/error_response_spec.rb +2 -2
  430. data/spec/models/error_spec.rb +2 -2
  431. data/spec/models/failed_submission2_spec.rb +2 -2
  432. data/spec/models/failed_submission_spec.rb +2 -2
  433. data/spec/models/funding_account_response2_spec.rb +95 -0
  434. data/spec/models/funding_account_response_spec.rb +26 -2
  435. data/spec/models/funding_account_type_spec.rb +35 -0
  436. data/spec/models/funding_audit_spec.rb +8 -8
  437. data/spec/models/funding_event_spec.rb +2 -2
  438. data/spec/models/funding_event_type_spec.rb +2 -2
  439. data/spec/models/funding_payor_status_audit_response_spec.rb +2 -2
  440. data/spec/models/funding_request_v1_spec.rb +2 -2
  441. data/spec/models/funding_request_v2_spec.rb +2 -2
  442. data/spec/models/funding_request_v3_spec.rb +47 -0
  443. data/spec/models/fx_summary_v3_spec.rb +2 -2
  444. data/spec/models/fx_summary_v4_spec.rb +2 -2
  445. data/spec/models/get_fundings_response_links_spec.rb +47 -0
  446. data/spec/models/get_fundings_response_spec.rb +14 -2
  447. data/spec/models/get_payee_list_response_company_spec.rb +47 -0
  448. data/spec/models/get_payee_list_response_individual_spec.rb +41 -0
  449. data/spec/models/{payee_response2_spec.rb → get_payee_list_response_spec.rb} +21 -39
  450. data/spec/models/get_payments_for_payout_response_v3_page_spec.rb +2 -2
  451. data/spec/models/get_payments_for_payout_response_v3_spec.rb +2 -2
  452. data/spec/models/get_payments_for_payout_response_v3_summary_spec.rb +2 -2
  453. data/spec/models/get_payments_for_payout_response_v4_spec.rb +2 -2
  454. data/spec/models/get_payments_for_payout_response_v4_summary_spec.rb +8 -2
  455. data/spec/models/get_payout_statistics_spec.rb +2 -2
  456. data/spec/models/get_payouts_response_v3_links_spec.rb +2 -2
  457. data/spec/models/get_payouts_response_v3_page_spec.rb +2 -2
  458. data/spec/models/get_payouts_response_v3_spec.rb +2 -2
  459. data/spec/models/get_payouts_response_v4_spec.rb +2 -2
  460. data/spec/models/individual2_spec.rb +2 -2
  461. data/spec/models/individual_response_spec.rb +2 -2
  462. data/spec/models/individual_spec.rb +2 -2
  463. data/spec/models/individual_v1_name_spec.rb +2 -2
  464. data/spec/models/individual_v1_spec.rb +2 -2
  465. data/spec/models/inline_response400_errors_spec.rb +2 -2
  466. data/spec/models/inline_response400_spec.rb +2 -2
  467. data/spec/models/inline_response401_errors_spec.rb +2 -2
  468. data/spec/models/inline_response401_spec.rb +2 -2
  469. data/spec/models/inline_response403_errors_spec.rb +2 -2
  470. data/spec/models/inline_response403_spec.rb +2 -2
  471. data/spec/models/inline_response404_errors_spec.rb +59 -0
  472. data/spec/models/inline_response404_spec.rb +47 -0
  473. data/spec/models/inline_response409_errors_spec.rb +2 -2
  474. data/spec/models/inline_response409_spec.rb +2 -2
  475. data/spec/models/inline_response412_errors_spec.rb +59 -0
  476. data/spec/models/inline_response412_spec.rb +47 -0
  477. data/spec/models/invitation_status2_spec.rb +35 -0
  478. data/spec/models/invitation_status_response_spec.rb +2 -2
  479. data/spec/models/invitation_status_spec.rb +2 -2
  480. data/spec/models/invite_payee_request2_spec.rb +2 -2
  481. data/spec/models/invite_payee_request_spec.rb +2 -2
  482. data/spec/models/invite_user_request_spec.rb +2 -2
  483. data/spec/models/kyc_state_spec.rb +2 -2
  484. data/spec/models/language2_spec.rb +2 -2
  485. data/spec/models/language_spec.rb +2 -2
  486. data/spec/models/link_for_response_spec.rb +2 -2
  487. data/spec/models/list_funding_accounts_response2_spec.rb +53 -0
  488. data/spec/models/list_funding_accounts_response_spec.rb +2 -2
  489. data/spec/models/{list_payments_response_page_spec.rb → list_payments_response_v3_page_spec.rb} +8 -8
  490. data/spec/models/{list_payments_response_spec.rb → list_payments_response_v3_spec.rb} +8 -8
  491. data/spec/models/list_payments_response_v4_spec.rb +2 -2
  492. data/spec/models/list_source_account_response_links_spec.rb +2 -2
  493. data/spec/models/list_source_account_response_page_spec.rb +2 -2
  494. data/spec/models/list_source_account_response_spec.rb +2 -2
  495. data/spec/models/list_source_account_response_v2_links_spec.rb +47 -0
  496. data/spec/models/list_source_account_response_v2_spec.rb +2 -2
  497. data/spec/models/list_source_account_response_v3_links_spec.rb +47 -0
  498. data/spec/models/list_source_account_response_v3_spec.rb +53 -0
  499. data/spec/models/location_type_spec.rb +2 -2
  500. data/spec/models/marketing_opt_in_spec.rb +2 -2
  501. data/spec/models/mfa_details_spec.rb +2 -2
  502. data/spec/models/mfa_type_spec.rb +2 -2
  503. data/spec/models/name_spec.rb +59 -0
  504. data/spec/models/{currency_type_spec.rb → notifications2_spec.rb} +9 -9
  505. data/spec/models/notifications_spec.rb +2 -2
  506. data/spec/models/ofac_status2_spec.rb +2 -2
  507. data/spec/models/ofac_status_spec.rb +2 -2
  508. data/spec/models/onboarded_status2_spec.rb +2 -2
  509. data/spec/models/onboarded_status_spec.rb +2 -2
  510. data/spec/models/page_for_response_spec.rb +2 -2
  511. data/spec/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response_spec.rb +2 -2
  512. data/spec/models/paged_payee_invitation_status_response2_spec.rb +2 -2
  513. data/spec/models/paged_payee_invitation_status_response_page_spec.rb +2 -2
  514. data/spec/models/paged_payee_invitation_status_response_spec.rb +2 -2
  515. data/spec/models/paged_payee_response2_spec.rb +2 -2
  516. data/spec/models/paged_payee_response2_summary_spec.rb +2 -2
  517. data/spec/models/paged_payee_response_links_spec.rb +2 -2
  518. data/spec/models/paged_payee_response_page_spec.rb +2 -2
  519. data/spec/models/paged_payee_response_spec.rb +2 -2
  520. data/spec/models/paged_payee_response_summary_spec.rb +2 -2
  521. data/spec/models/paged_payments_response_v3_spec.rb +53 -0
  522. data/spec/models/paged_user_response_links_spec.rb +2 -2
  523. data/spec/models/paged_user_response_page_spec.rb +2 -2
  524. data/spec/models/paged_user_response_spec.rb +2 -2
  525. data/spec/models/password_request_spec.rb +2 -2
  526. data/spec/models/payee2_spec.rb +2 -2
  527. data/spec/models/payee_address2_spec.rb +2 -2
  528. data/spec/models/payee_address_spec.rb +2 -2
  529. data/spec/models/payee_delta2_spec.rb +2 -2
  530. data/spec/models/payee_delta_response2_links_spec.rb +2 -2
  531. data/spec/models/payee_delta_response2_spec.rb +2 -2
  532. data/spec/models/payee_delta_response_links_spec.rb +2 -2
  533. data/spec/models/payee_delta_response_page_spec.rb +2 -2
  534. data/spec/models/payee_delta_response_spec.rb +2 -2
  535. data/spec/models/payee_delta_spec.rb +2 -2
  536. data/spec/models/payee_detail_response2_spec.rb +209 -0
  537. data/spec/models/{payee_response_v3_spec.rb → payee_detail_response_spec.rb} +14 -8
  538. data/spec/models/payee_invitation_status_response2_spec.rb +2 -2
  539. data/spec/models/payee_invitation_status_response_spec.rb +2 -2
  540. data/spec/models/payee_invitation_status_spec.rb +2 -2
  541. data/spec/models/payee_payment_channel2_spec.rb +2 -2
  542. data/spec/models/payee_payment_channel_spec.rb +2 -2
  543. data/spec/models/payee_payor_ref2_spec.rb +65 -0
  544. data/spec/models/payee_payor_ref_spec.rb +2 -2
  545. data/spec/models/payee_payor_ref_v2_spec.rb +2 -2
  546. data/spec/models/payee_payor_ref_v3_spec.rb +2 -6
  547. data/spec/models/payee_response_spec.rb +2 -2
  548. data/spec/models/payee_response_v2_spec.rb +2 -2
  549. data/spec/models/payee_spec.rb +2 -2
  550. data/spec/models/payee_type2_spec.rb +35 -0
  551. data/spec/models/payee_type_spec.rb +2 -2
  552. data/spec/models/payee_user_self_update_request_spec.rb +71 -0
  553. data/spec/models/payment_audit_currency_v3_spec.rb +2 -2
  554. data/spec/models/payment_audit_currency_v4_spec.rb +2 -2
  555. data/spec/models/payment_channel_country_spec.rb +2 -2
  556. data/spec/models/payment_channel_rule_spec.rb +2 -2
  557. data/spec/models/payment_channel_rules_response_spec.rb +2 -2
  558. data/spec/models/payment_delta_response_spec.rb +2 -2
  559. data/spec/models/payment_delta_response_v4_spec.rb +53 -0
  560. data/spec/models/payment_delta_spec.rb +2 -2
  561. data/spec/models/payment_delta_v4_spec.rb +83 -0
  562. data/spec/models/payment_event_response_v3_spec.rb +2 -2
  563. data/spec/models/payment_event_response_v4_spec.rb +2 -2
  564. data/spec/models/{payment_instruction_spec.rb → payment_instruction_v3_spec.rb} +14 -8
  565. data/spec/models/payment_rails_spec.rb +2 -2
  566. data/spec/models/payment_response_v3_spec.rb +2 -2
  567. data/spec/models/payment_response_v4_payout_spec.rb +2 -2
  568. data/spec/models/payment_response_v4_spec.rb +20 -2
  569. data/spec/models/payment_v3_spec.rb +105 -0
  570. data/spec/models/payor_address_spec.rb +2 -2
  571. data/spec/models/payor_address_v2_spec.rb +2 -2
  572. data/spec/models/payor_aml_transaction_v3_spec.rb +2 -2
  573. data/spec/models/payor_aml_transaction_v4_spec.rb +2 -2
  574. data/spec/models/payor_branding_response_spec.rb +2 -2
  575. data/spec/models/payor_create_api_key_request_spec.rb +2 -2
  576. data/spec/models/payor_create_api_key_response_spec.rb +2 -2
  577. data/spec/models/payor_create_application_request_spec.rb +2 -2
  578. data/spec/models/payor_email_opt_out_request_spec.rb +2 -2
  579. data/spec/models/payor_links_response_links_spec.rb +2 -2
  580. data/spec/models/payor_links_response_payors_spec.rb +2 -2
  581. data/spec/models/payor_links_response_spec.rb +2 -2
  582. data/spec/models/payor_logo_request_spec.rb +2 -2
  583. data/spec/models/payor_v1_spec.rb +8 -2
  584. data/spec/models/payor_v2_spec.rb +14 -2
  585. data/spec/models/{get_fundings_response_all_of_spec.rb → payout_company_v3_spec.rb} +9 -9
  586. data/spec/models/{user_response2_roles_spec.rb → payout_individual_v3_spec.rb} +8 -8
  587. data/spec/models/payout_name_v3_spec.rb +47 -0
  588. data/spec/models/payout_payee_v3_spec.rb +53 -0
  589. data/spec/models/payout_payor_v4_spec.rb +2 -2
  590. data/spec/models/payout_principal_v4_spec.rb +2 -2
  591. data/spec/models/payout_status_v3_spec.rb +2 -2
  592. data/spec/models/payout_status_v4_spec.rb +2 -2
  593. data/spec/models/payout_summary_audit_v3_spec.rb +2 -2
  594. data/spec/models/payout_summary_audit_v4_spec.rb +8 -2
  595. data/spec/models/{payout_summary_response_spec.rb → payout_summary_response_v3_spec.rb} +14 -8
  596. data/spec/models/payout_type_v4_spec.rb +2 -2
  597. data/spec/models/ping_response_spec.rb +47 -0
  598. data/spec/models/query_batch_response2_spec.rb +2 -2
  599. data/spec/models/query_batch_response_spec.rb +2 -2
  600. data/spec/models/{quote_fx_summary_spec.rb → quote_fx_summary_v3_spec.rb} +8 -8
  601. data/spec/models/{quote_response_spec.rb → quote_response_v3_spec.rb} +8 -8
  602. data/spec/models/{region_spec.rb → region_v2_spec.rb} +8 -8
  603. data/spec/models/register_sms_request_spec.rb +2 -2
  604. data/spec/models/{rejected_payment_spec.rb → rejected_payment_v3_spec.rb} +8 -8
  605. data/spec/models/resend_token_request_spec.rb +2 -2
  606. data/spec/models/reset_password_request_spec.rb +2 -2
  607. data/spec/models/role_spec.rb +2 -2
  608. data/spec/models/role_update_request_spec.rb +2 -2
  609. data/spec/models/self_mfa_type_unregister_request_spec.rb +2 -2
  610. data/spec/models/self_update_password_request_spec.rb +2 -2
  611. data/spec/models/set_notifications_request_spec.rb +2 -2
  612. data/spec/models/source_account_response_spec.rb +8 -2
  613. data/spec/models/source_account_response_v2_spec.rb +8 -2
  614. data/spec/models/{user_response2_spec.rb → source_account_response_v3_spec.rb} +30 -32
  615. data/spec/models/source_account_summary_v3_spec.rb +2 -2
  616. data/spec/models/source_account_summary_v4_spec.rb +2 -2
  617. data/spec/models/source_account_type_spec.rb +35 -0
  618. data/spec/models/{source_account_spec.rb → source_account_v3_spec.rb} +8 -8
  619. data/spec/models/supported_countries_response_spec.rb +2 -2
  620. data/spec/models/{supported_countries_response2_spec.rb → supported_countries_response_v2_spec.rb} +8 -8
  621. data/spec/models/supported_country_spec.rb +2 -2
  622. data/spec/models/{supported_country2_spec.rb → supported_country_v2_spec.rb} +8 -8
  623. data/spec/models/{supported_currency_response_spec.rb → supported_currency_response_v2_spec.rb} +8 -8
  624. data/spec/models/{supported_currency_spec.rb → supported_currency_v2_spec.rb} +8 -8
  625. data/spec/models/transfer_request2_spec.rb +53 -0
  626. data/spec/models/transfer_request_spec.rb +2 -2
  627. data/spec/models/transmission_type_spec.rb +35 -0
  628. data/spec/models/transmission_types2_spec.rb +53 -0
  629. data/spec/models/transmission_types_spec.rb +53 -0
  630. data/spec/models/unregister_mfa_request_spec.rb +2 -2
  631. data/spec/models/update_payee_details_request2_spec.rb +77 -0
  632. data/spec/models/update_payee_details_request_spec.rb +77 -0
  633. data/spec/models/update_remote_id_request_spec.rb +2 -2
  634. data/spec/models/update_webhook_request_spec.rb +53 -0
  635. data/spec/models/user_details_update_request_spec.rb +2 -2
  636. data/spec/models/user_info_spec.rb +2 -2
  637. data/spec/models/user_response_spec.rb +2 -2
  638. data/spec/models/user_status_spec.rb +2 -2
  639. data/spec/models/user_type2_spec.rb +2 -2
  640. data/spec/models/user_type_spec.rb +2 -2
  641. data/spec/models/validate_password_response_spec.rb +2 -2
  642. data/spec/models/watchlist_status2_spec.rb +35 -0
  643. data/spec/models/watchlist_status_spec.rb +2 -2
  644. data/spec/models/{paged_response_page_spec.rb → webhook_response_spec.rb} +13 -13
  645. data/spec/models/webhooks_response_spec.rb +53 -0
  646. data/spec/models/withdraw_payment_request_spec.rb +41 -0
  647. data/spec/spec_helper.rb +2 -2
  648. data/specs/api/countries_api_spec.rb +48 -13
  649. data/specs/api/currencies_api_spec.rb +8 -6
  650. data/specs/api/funding_manager_api_spec.rb +197 -30
  651. data/specs/api/funding_manager_private_api_spec.rb +6 -6
  652. data/specs/api/login_api_spec.rb +6 -6
  653. data/specs/api/payee_invitation_api_spec.rb +61 -11
  654. data/specs/api/payees_api_spec.rb +101 -14
  655. data/specs/api/payment_audit_service_api_spec.rb +231 -30
  656. data/specs/api/payors_api_spec.rb +50 -17
  657. data/specs/api/payors_private_api_spec.rb +3 -3
  658. data/specs/api/payout_service_api_spec.rb +127 -0
  659. data/specs/api/tokens_api_spec.rb +3 -3
  660. data/specs/api/users_api_spec.rb +70 -21
  661. data/velopayments.gemspec +3 -4
  662. metadata +444 -326
  663. data/Gemfile.lock +0 -70
  664. data/docs/CreateFundingAccountRequest.md +0 -23
  665. data/docs/GetFundingsResponseAllOf.md +0 -17
  666. data/docs/GetPayoutApi.md +0 -61
  667. data/docs/InstructPayoutApi.md +0 -60
  668. data/docs/PagedResponse.md +0 -19
  669. data/docs/PagedResponsePage.md +0 -25
  670. data/docs/PayeeResponse2.md +0 -55
  671. data/docs/PayoutHistoryApi.md +0 -221
  672. data/docs/QuotePayoutApi.md +0 -61
  673. data/docs/QuoteResponse.md +0 -17
  674. data/docs/SubmitPayoutApi.md +0 -60
  675. data/docs/SupportedCountriesResponse2.md +0 -17
  676. data/docs/SupportedCurrencyResponse.md +0 -17
  677. data/docs/UserResponse2.md +0 -45
  678. data/docs/WithdrawPayoutApi.md +0 -60
  679. data/lib/velopayments/api/get_payout_api.rb +0 -84
  680. data/lib/velopayments/api/instruct_payout_api.rb +0 -84
  681. data/lib/velopayments/api/payout_history_api.rb +0 -285
  682. data/lib/velopayments/api/quote_payout_api.rb +0 -84
  683. data/lib/velopayments/api/submit_payout_api.rb +0 -86
  684. data/lib/velopayments/api/withdraw_payout_api.rb +0 -84
  685. data/spec/api/get_payout_api_spec.rb +0 -47
  686. data/spec/api/instruct_payout_api_spec.rb +0 -47
  687. data/spec/api/payout_history_api_spec.rb +0 -95
  688. data/spec/api/quote_payout_api_spec.rb +0 -47
  689. data/spec/api/submit_payout_api_spec.rb +0 -47
  690. data/spec/api/withdraw_payout_api_spec.rb +0 -47
  691. data/specs/api/get_payout_api_spec.rb +0 -47
  692. data/specs/api/instruct_payout_api_spec.rb +0 -47
  693. data/specs/api/payout_history_api_spec.rb +0 -95
  694. data/specs/api/quote_payout_api_spec.rb +0 -47
  695. data/specs/api/submit_payout_api_spec.rb +0 -47
  696. data/specs/api/withdraw_payout_api_spec.rb +0 -47
  697. data/velopayments-2.20.118.gem +0 -0
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.19.116
6
+ The version of the OpenAPI document: 2.23.78
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.1-SNAPSHOT
9
+ OpenAPI Generator version: 5.0.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -32,12 +32,12 @@ describe 'CurrenciesApi' do
32
32
  end
33
33
  end
34
34
 
35
- # unit tests for list_supported_currencies
35
+ # unit tests for list_supported_currencies_v2
36
36
  # List Supported Currencies
37
37
  # List the supported currencies.
38
38
  # @param [Hash] opts the optional parameters
39
- # @return [SupportedCurrencyResponse]
40
- describe 'list_supported_currencies test' do
39
+ # @return [SupportedCurrencyResponseV2]
40
+ describe 'list_supported_currencies_v2 test' do
41
41
  it 'should work' do
42
42
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
43
43
  end
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.19.116
6
+ The version of the OpenAPI document: 2.23.78
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.1-SNAPSHOT
9
+ OpenAPI Generator version: 5.0.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -36,7 +36,7 @@ describe 'FundingManagerApi' do
36
36
  # Create Funding Request
37
37
  # Instruct a funding request to transfer funds from the payor’s funding bank to the payor’s balance held within Velo.
38
38
  # @param source_account_id Source account id
39
- # @param funding_request_v1 Body to included ammount to be funded
39
+ # @param funding_request_v1 Body to included amount to be funded
40
40
  # @param [Hash] opts the optional parameters
41
41
  # @return [nil]
42
42
  describe 'create_ach_funding_request test' do
@@ -49,7 +49,7 @@ describe 'FundingManagerApi' do
49
49
  # Create Funding Request
50
50
  # Instruct a funding request to transfer funds from the payor’s funding bank to the payor’s balance held within Velo (202 - accepted, 400 - invalid request body, 404 - source account not found).
51
51
  # @param source_account_id Source account id
52
- # @param funding_request_v2 Body to included ammount to be funded
52
+ # @param funding_request_v2 Body to included amount to be funded
53
53
  # @param [Hash] opts the optional parameters
54
54
  # @return [nil]
55
55
  describe 'create_funding_request test' do
@@ -58,6 +58,19 @@ describe 'FundingManagerApi' do
58
58
  end
59
59
  end
60
60
 
61
+ # unit tests for create_funding_request_v3
62
+ # Create Funding Request
63
+ # Instruct a funding request to transfer funds from the payor’s funding bank to the payor’s balance held within Velo (202 - accepted, 400 - invalid request body, 404 - source account not found).
64
+ # @param source_account_id Source account id
65
+ # @param funding_request_v3 Body to included amount to be funded
66
+ # @param [Hash] opts the optional parameters
67
+ # @return [nil]
68
+ describe 'create_funding_request_v3 test' do
69
+ it 'should work' do
70
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
71
+ end
72
+ end
73
+
61
74
  # unit tests for get_funding_account
62
75
  # Get Funding Account
63
76
  # Get Funding Account by ID
@@ -71,15 +84,28 @@ describe 'FundingManagerApi' do
71
84
  end
72
85
  end
73
86
 
87
+ # unit tests for get_funding_account_v2
88
+ # Get Funding Account
89
+ # Get Funding Account by ID
90
+ # @param funding_account_id
91
+ # @param [Hash] opts the optional parameters
92
+ # @option opts [Boolean] :sensitive
93
+ # @return [FundingAccountResponse2]
94
+ describe 'get_funding_account_v2 test' do
95
+ it 'should work' do
96
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
97
+ end
98
+ end
99
+
74
100
  # unit tests for get_funding_accounts
75
101
  # Get Funding Accounts
76
- # Get the source accounts.
102
+ # Get the funding accounts.
77
103
  # @param [Hash] opts the optional parameters
78
104
  # @option opts [String] :payor_id
79
105
  # @option opts [String] :source_account_id
80
106
  # @option opts [Integer] :page Page number. Default is 1.
81
- # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
82
- # @option opts [String] :sort
107
+ # @option opts [Integer] :page_size The number of results to return in a page
108
+ # @option opts [String] :sort List of sort fields (e.g. ?sort=accountName:asc,name:asc) Default is accountName:asc The supported sort fields are - accountName, name and currency.
83
109
  # @option opts [Boolean] :sensitive
84
110
  # @return [ListFundingAccountsResponse]
85
111
  describe 'get_funding_accounts test' do
@@ -88,16 +114,21 @@ describe 'FundingManagerApi' do
88
114
  end
89
115
  end
90
116
 
91
- # unit tests for get_fundings_v1
92
- # Get Fundings for Payor
93
- # Get a list of Fundings for a payor.
117
+ # unit tests for get_funding_accounts_v2
118
+ # Get Funding Accounts
119
+ # Get the funding accounts.
94
120
  # @param [Hash] opts the optional parameters
95
- # @option opts [String] :payor_id The account owner Payor ID
121
+ # @option opts [String] :payor_id
122
+ # @option opts [String] :name The descriptive funding account name
123
+ # @option opts [String] :country The 2 letter ISO 3166-1 country code (upper case)
124
+ # @option opts [String] :currency The ISO 4217 currency code
125
+ # @option opts [FundingAccountType] :type The type of funding account.
96
126
  # @option opts [Integer] :page Page number. Default is 1.
97
- # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
98
- # @option opts [String] :sort List of sort fields. Example: ```?sort=destinationCurrency:asc,destinationAmount:asc``` Default is no sort. The supported sort fields are: dateTime and amount.
99
- # @return [GetFundingsResponse]
100
- describe 'get_fundings_v1 test' do
127
+ # @option opts [Integer] :page_size The number of results to return in a page
128
+ # @option opts [String] :sort List of sort fields (e.g. ?sort=accountName:asc,name:asc) Default is accountName:asc The supported sort fields are - accountName, name.
129
+ # @option opts [Boolean] :sensitive
130
+ # @return [ListFundingAccountsResponse2]
131
+ describe 'get_funding_accounts_v2 test' do
101
132
  it 'should work' do
102
133
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
103
134
  end
@@ -127,6 +158,18 @@ describe 'FundingManagerApi' do
127
158
  end
128
159
  end
129
160
 
161
+ # unit tests for get_source_account_v3
162
+ # Get details about given source account.
163
+ # Get details about given source account.
164
+ # @param source_account_id Source account id
165
+ # @param [Hash] opts the optional parameters
166
+ # @return [SourceAccountResponseV3]
167
+ describe 'get_source_account_v3 test' do
168
+ it 'should work' do
169
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
170
+ end
171
+ end
172
+
130
173
  # unit tests for get_source_accounts
131
174
  # Get list of source accounts
132
175
  # List source accounts.
@@ -134,7 +177,7 @@ describe 'FundingManagerApi' do
134
177
  # @option opts [String] :physical_account_name Physical Account Name
135
178
  # @option opts [String] :payor_id The account owner Payor ID
136
179
  # @option opts [Integer] :page Page number. Default is 1.
137
- # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
180
+ # @option opts [Integer] :page_size The number of results to return in a page
138
181
  # @option opts [String] :sort List of sort fields e.g. ?sort=name:asc Default is name:asc The supported sort fields are - fundingRef
139
182
  # @return [ListSourceAccountResponse]
140
183
  describe 'get_source_accounts test' do
@@ -152,7 +195,7 @@ describe 'FundingManagerApi' do
152
195
  # @option opts [String] :payor_id The account owner Payor ID
153
196
  # @option opts [String] :funding_account_id The funding account ID
154
197
  # @option opts [Integer] :page Page number. Default is 1.
155
- # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
198
+ # @option opts [Integer] :page_size The number of results to return in a page
156
199
  # @option opts [String] :sort List of sort fields e.g. ?sort=name:asc Default is name:asc The supported sort fields are - fundingRef, name, balance
157
200
  # @return [ListSourceAccountResponseV2]
158
201
  describe 'get_source_accounts_v2 test' do
@@ -161,6 +204,25 @@ describe 'FundingManagerApi' do
161
204
  end
162
205
  end
163
206
 
207
+ # unit tests for get_source_accounts_v3
208
+ # Get list of source accounts
209
+ # List source accounts.
210
+ # @param [Hash] opts the optional parameters
211
+ # @option opts [String] :physical_account_name Physical Account Name
212
+ # @option opts [String] :physical_account_id The physical account ID
213
+ # @option opts [String] :payor_id The account owner Payor ID
214
+ # @option opts [String] :funding_account_id The funding account ID
215
+ # @option opts [SourceAccountType] :type The type of source account.
216
+ # @option opts [Integer] :page Page number. Default is 1.
217
+ # @option opts [Integer] :page_size The number of results to return in a page
218
+ # @option opts [String] :sort List of sort fields e.g. ?sort=name:asc Default is name:asc The supported sort fields are - fundingRef, name, balance
219
+ # @return [ListSourceAccountResponseV3]
220
+ describe 'get_source_accounts_v3 test' do
221
+ it 'should work' do
222
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
223
+ end
224
+ end
225
+
164
226
  # unit tests for list_funding_audit_deltas
165
227
  # Get Funding Audit Delta
166
228
  # Get funding audit deltas for a payor
@@ -168,7 +230,7 @@ describe 'FundingManagerApi' do
168
230
  # @param updated_since
169
231
  # @param [Hash] opts the optional parameters
170
232
  # @option opts [Integer] :page Page number. Default is 1.
171
- # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
233
+ # @option opts [Integer] :page_size The number of results to return in a page
172
234
  # @return [PageResourceFundingPayorStatusAuditResponseFundingPayorStatusAuditResponse]
173
235
  describe 'list_funding_audit_deltas test' do
174
236
  it 'should work' do
@@ -202,4 +264,17 @@ describe 'FundingManagerApi' do
202
264
  end
203
265
  end
204
266
 
267
+ # unit tests for transfer_funds_v3
268
+ # Transfer Funds between source accounts
269
+ # Transfer funds between source accounts for a Payor. The 'from' source account is identified in the URL, and is the account which will be debited. The 'to' (destination) source account is in the body, and is the account which will be credited. Both source accounts must belong to the same Payor. There must be sufficient balance in the 'from' source account, otherwise the transfer attempt will fail.
270
+ # @param source_account_id The 'from' source account id, which will be debited
271
+ # @param transfer_request2 Body
272
+ # @param [Hash] opts the optional parameters
273
+ # @return [nil]
274
+ describe 'transfer_funds_v3 test' do
275
+ it 'should work' do
276
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
277
+ end
278
+ end
279
+
205
280
  end
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.19.116
6
+ The version of the OpenAPI document: 2.23.78
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.1-SNAPSHOT
9
+ OpenAPI Generator version: 5.0.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -32,13 +32,13 @@ describe 'FundingManagerPrivateApi' do
32
32
  end
33
33
  end
34
34
 
35
- # unit tests for create_funding_account
35
+ # unit tests for create_funding_account_v2
36
36
  # Create Funding Account
37
37
  # Create Funding Account
38
38
  # @param [Hash] opts the optional parameters
39
- # @option opts [CreateFundingAccountRequest] :create_funding_account_request
39
+ # @option opts [CreateFundingAccountRequestV2] :create_funding_account_request_v2
40
40
  # @return [nil]
41
- describe 'create_funding_account test' do
41
+ describe 'create_funding_account_v2 test' do
42
42
  it 'should work' do
43
43
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
44
44
  end
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.19.116
6
+ The version of the OpenAPI document: 2.23.78
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.1-SNAPSHOT
9
+ OpenAPI Generator version: 5.0.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -60,6 +60,7 @@ describe 'LoginApi' do
60
60
  # <p>The second part of login involves validating using an MFA device</p> <p>An access token with PRE_AUTH authorities is required</p>
61
61
  # @param access_token_validation_request An OTP from the user's registered MFA Device
62
62
  # @param [Hash] opts the optional parameters
63
+ # @option opts [String] :authorization Bearer token authorization leg of validate
63
64
  # @return [AccessTokenResponse]
64
65
  describe 'validate_access_token test' do
65
66
  it 'should work' do
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.19.116
6
+ The version of the OpenAPI document: 2.23.78
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.1-SNAPSHOT
9
+ OpenAPI Generator version: 5.0.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -76,6 +76,22 @@ describe 'PayeeInvitationApi' do
76
76
  end
77
77
  end
78
78
 
79
+ # unit tests for get_payees_invitation_status_v4
80
+ # Get Payee Invitation Status
81
+ # Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.
82
+ # @param payor_id The account owner Payor ID
83
+ # @param [Hash] opts the optional parameters
84
+ # @option opts [String] :payee_id The UUID of the payee.
85
+ # @option opts [InvitationStatus] :invitation_status The invitation status of the payees.
86
+ # @option opts [Integer] :page Page number. Default is 1.
87
+ # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
88
+ # @return [PagedPayeeInvitationStatusResponse2]
89
+ describe 'get_payees_invitation_status_v4 test' do
90
+ it 'should work' do
91
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
92
+ end
93
+ end
94
+
79
95
  # unit tests for query_batch_status_v2
80
96
  # Query Batch Status
81
97
  # <p>Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ).</p> <p>Please use V3 instead</p>
@@ -100,6 +116,18 @@ describe 'PayeeInvitationApi' do
100
116
  end
101
117
  end
102
118
 
119
+ # unit tests for query_batch_status_v4
120
+ # Query Batch Status
121
+ # Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ).
122
+ # @param batch_id Batch Id
123
+ # @param [Hash] opts the optional parameters
124
+ # @return [QueryBatchResponse2]
125
+ describe 'query_batch_status_v4 test' do
126
+ it 'should work' do
127
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
128
+ end
129
+ end
130
+
103
131
  # unit tests for resend_payee_invite_v1
104
132
  # Resend Payee Invite
105
133
  # <p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p> <p>Deprecated. Please use v3 instead</p>
@@ -126,9 +154,22 @@ describe 'PayeeInvitationApi' do
126
154
  end
127
155
  end
128
156
 
157
+ # unit tests for resend_payee_invite_v4
158
+ # Resend Payee Invite
159
+ # <p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p>
160
+ # @param payee_id The UUID of the payee.
161
+ # @param invite_payee_request2 Provide Payor Id in body of request
162
+ # @param [Hash] opts the optional parameters
163
+ # @return [nil]
164
+ describe 'resend_payee_invite_v4 test' do
165
+ it 'should work' do
166
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
167
+ end
168
+ end
169
+
129
170
  # unit tests for v2_create_payee
130
171
  # Initiate Payee Creation
131
- # Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body, 409 - if there is a duplicate remote id within the batch / if there is a duplicate email within the batch).
172
+ # Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body
132
173
  # @param [Hash] opts the optional parameters
133
174
  # @option opts [CreatePayeesRequest] :create_payees_request Post payees to create.
134
175
  # @return [CreatePayeesCSVResponse]
@@ -140,7 +181,7 @@ describe 'PayeeInvitationApi' do
140
181
 
141
182
  # unit tests for v3_create_payee
142
183
  # Initiate Payee Creation
143
- # Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body, 409 - if there is a duplicate remote id within the batch / if there is a duplicate email within the batch).
184
+ # Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body. In addition to standard semantic validations, a 400 will also result if there is a duplicate remote id within the batch / if there is a duplicate email within the batch, i.e. if there is a conflict between the data provided for one payee within the batch and that provided for another payee within the same batch). The validation at this stage is intra-batch only. Validation against payees who have already been invited occurs subsequently during processing of the batch.
144
185
  # @param [Hash] opts the optional parameters
145
186
  # @option opts [CreatePayeesRequest2] :create_payees_request2 Post payees to create.
146
187
  # @return [CreatePayeesCSVResponse2]
@@ -150,4 +191,16 @@ describe 'PayeeInvitationApi' do
150
191
  end
151
192
  end
152
193
 
194
+ # unit tests for v4_create_payee
195
+ # Initiate Payee Creation
196
+ # Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body. In addition to standard semantic validations, a 400 will also result if there is a duplicate remote id within the batch / if there is a duplicate email within the batch, i.e. if there is a conflict between the data provided for one payee within the batch and that provided for another payee within the same batch). The validation at this stage is intra-batch only. Validation against payees who have already been invited occurs subsequently during processing of the batch.
197
+ # @param [Hash] opts the optional parameters
198
+ # @option opts [CreatePayeesRequest2] :create_payees_request2 Post payees to create.
199
+ # @return [CreatePayeesCSVResponse2]
200
+ describe 'v4_create_payee test' do
201
+ it 'should work' do
202
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
203
+ end
204
+ end
205
+
153
206
  end
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.19.116
6
+ The version of the OpenAPI document: 2.23.78
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.1-SNAPSHOT
9
+ OpenAPI Generator version: 5.0.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -56,6 +56,18 @@ describe 'PayeesApi' do
56
56
  end
57
57
  end
58
58
 
59
+ # unit tests for delete_payee_by_id_v4
60
+ # Delete Payee by Id
61
+ # <p>This API will delete Payee by Id (UUID). Deletion by ID is not allowed if:</p> <p>* Payee ID is not found</p> <p>* If Payee has not been on-boarded</p> <p>* If Payee is in grace period</p> <p>* If Payee has existing payments</p>
62
+ # @param payee_id The UUID of the payee.
63
+ # @param [Hash] opts the optional parameters
64
+ # @return [nil]
65
+ describe 'delete_payee_by_id_v4 test' do
66
+ it 'should work' do
67
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
68
+ end
69
+ end
70
+
59
71
  # unit tests for get_payee_by_id_v1
60
72
  # Get Payee by Id
61
73
  # <p>Get Payee by Id</p> <p>Please use V3 instead.</p>
@@ -88,13 +100,26 @@ describe 'PayeesApi' do
88
100
  # @param payee_id The UUID of the payee.
89
101
  # @param [Hash] opts the optional parameters
90
102
  # @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
91
- # @return [PayeeResponseV3]
103
+ # @return [PayeeDetailResponse]
92
104
  describe 'get_payee_by_id_v3 test' do
93
105
  it 'should work' do
94
106
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
95
107
  end
96
108
  end
97
109
 
110
+ # unit tests for get_payee_by_id_v4
111
+ # Get Payee by Id
112
+ # Get Payee by Id
113
+ # @param payee_id The UUID of the payee.
114
+ # @param [Hash] opts the optional parameters
115
+ # @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
116
+ # @return [PayeeDetailResponse2]
117
+ describe 'get_payee_by_id_v4 test' do
118
+ it 'should work' do
119
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
120
+ end
121
+ end
122
+
98
123
  # unit tests for list_payee_changes
99
124
  # List Payee Changes
100
125
  # <p>Get a paginated response listing payee changes.</p> <p>Please use V3 instead.</p>
@@ -125,6 +150,21 @@ describe 'PayeesApi' do
125
150
  end
126
151
  end
127
152
 
153
+ # unit tests for list_payee_changes_v4
154
+ # List Payee Changes
155
+ # Get a paginated response listing payee changes (updated since a particular time) to a limited set of fields: - dbaName - displayName - email - onboardedStatus - payeeCountry - payeeId - remoteId
156
+ # @param payor_id The Payor ID to find associated Payees
157
+ # @param updated_since The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
158
+ # @param [Hash] opts the optional parameters
159
+ # @option opts [Integer] :page Page number. Default is 1.
160
+ # @option opts [Integer] :page_size Page size. Default is 100. Max allowable is 1000.
161
+ # @return [PayeeDeltaResponse2]
162
+ describe 'list_payee_changes_v4 test' do
163
+ it 'should work' do
164
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
165
+ end
166
+ end
167
+
128
168
  # unit tests for list_payees_v1
129
169
  # List Payees V1
130
170
  # <p>Get a paginated response listing the payees for a payor.</p> <p>Please use V3 instead.</>
@@ -152,7 +192,8 @@ describe 'PayeesApi' do
152
192
  # Get a paginated response listing the payees for a payor.
153
193
  # @param payor_id The account owner Payor ID
154
194
  # @param [Hash] opts the optional parameters
155
- # @option opts [WatchlistStatus] :ofac_status The watchlistStatus of the payees.
195
+ # @option opts [WatchlistStatus] :watchlist_status The watchlistStatus of the payees.
196
+ # @option opts [Boolean] :disabled Payee disabled
156
197
  # @option opts [OnboardedStatus] :onboarded_status The onboarded status of the payees.
157
198
  # @option opts [String] :email Email address
158
199
  # @option opts [String] :display_name The display name of the payees.
@@ -169,6 +210,56 @@ describe 'PayeesApi' do
169
210
  end
170
211
  end
171
212
 
213
+ # unit tests for list_payees_v4
214
+ # List Payees
215
+ # Get a paginated response listing the payees for a payor.
216
+ # @param payor_id The account owner Payor ID
217
+ # @param [Hash] opts the optional parameters
218
+ # @option opts [WatchlistStatus] :watchlist_status The watchlistStatus of the payees.
219
+ # @option opts [Boolean] :disabled Payee disabled
220
+ # @option opts [OnboardedStatus] :onboarded_status The onboarded status of the payees.
221
+ # @option opts [String] :email Email address
222
+ # @option opts [String] :display_name The display name of the payees.
223
+ # @option opts [String] :remote_id The remote id of the payees.
224
+ # @option opts [PayeeType] :payee_type The onboarded status of the payees.
225
+ # @option opts [String] :payee_country The country of the payee - 2 letter ISO 3166-1 country code (upper case)
226
+ # @option opts [OfacStatus] :ofac_status The ofacStatus of the payees.
227
+ # @option opts [Integer] :page Page number. Default is 1.
228
+ # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
229
+ # @option opts [String] :sort List of sort fields (e.g. ?sort=onboardedStatus:asc,name:asc) Default is name:asc 'name' is treated as company name for companies - last name + ',' + firstName for individuals The supported sort fields are - payeeId, displayName, payoutStatus, onboardedStatus.
230
+ # @return [PagedPayeeResponse2]
231
+ describe 'list_payees_v4 test' do
232
+ it 'should work' do
233
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
234
+ end
235
+ end
236
+
237
+ # unit tests for payee_details_update_v3
238
+ # Update Payee Details
239
+ # <p>Update payee details for the given Payee Id.<p>
240
+ # @param payee_id The UUID of the payee.
241
+ # @param update_payee_details_request Request to update payee details
242
+ # @param [Hash] opts the optional parameters
243
+ # @return [nil]
244
+ describe 'payee_details_update_v3 test' do
245
+ it 'should work' do
246
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
247
+ end
248
+ end
249
+
250
+ # unit tests for payee_details_update_v4
251
+ # Update Payee Details
252
+ # <p>Update payee details for the given Payee Id.<p>
253
+ # @param payee_id The UUID of the payee.
254
+ # @param update_payee_details_request2 Request to update payee details
255
+ # @param [Hash] opts the optional parameters
256
+ # @return [nil]
257
+ describe 'payee_details_update_v4 test' do
258
+ it 'should work' do
259
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
260
+ end
261
+ end
262
+
172
263
  # unit tests for v1_payees_payee_id_remote_id_update_post
173
264
  # Update Payee Remote Id
174
265
  # <p>Update the remote Id for the given Payee Id.</p> <p>Please use V3 instead</p>
@@ -195,4 +286,17 @@ describe 'PayeesApi' do
195
286
  end
196
287
  end
197
288
 
289
+ # unit tests for v4_payees_payee_id_remote_id_update_post
290
+ # Update Payee Remote Id
291
+ # <p>Update the remote Id for the given Payee Id.</p>
292
+ # @param payee_id The UUID of the payee.
293
+ # @param update_remote_id_request Request to update payee remote id v4
294
+ # @param [Hash] opts the optional parameters
295
+ # @return [nil]
296
+ describe 'v4_payees_payee_id_remote_id_update_post test' do
297
+ it 'should work' do
298
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
299
+ end
300
+ end
301
+
198
302
  end