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,14 +3,15 @@
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.20.118
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.3.1-SNAPSHOT
9
+ OpenAPI Generator version: 5.0.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
13
13
  require 'date'
14
+ require 'time'
14
15
 
15
16
  module VeloPayments
16
17
  class UserInfo
@@ -121,7 +122,9 @@ module VeloPayments
121
122
  def build_from_hash(attributes)
122
123
  return nil unless attributes.is_a?(Hash)
123
124
  self.class.openapi_types.each_pair do |key, type|
124
- if type =~ /\AArray<(.*)>/i
125
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
126
+ self.send("#{key}=", nil)
127
+ elsif type =~ /\AArray<(.*)>/i
125
128
  # check to ensure the input is an array given that the attribute
126
129
  # is documented as an array but the input is not
127
130
  if attributes[self.class.attribute_map[key]].is_a?(Array)
@@ -129,7 +132,7 @@ module VeloPayments
129
132
  end
130
133
  elsif !attributes[self.class.attribute_map[key]].nil?
131
134
  self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
132
- end # or else data not found in attributes(hash), not an issue as the data can be optional
135
+ end
133
136
  end
134
137
 
135
138
  self
@@ -141,8 +144,8 @@ module VeloPayments
141
144
  # @return [Object] Deserialized data
142
145
  def _deserialize(type, value)
143
146
  case type.to_sym
144
- when :DateTime
145
- DateTime.parse(value)
147
+ when :Time
148
+ Time.parse(value)
146
149
  when :Date
147
150
  Date.parse(value)
148
151
  when :String
@@ -221,5 +224,6 @@ module VeloPayments
221
224
  value
222
225
  end
223
226
  end
227
+
224
228
  end
225
229
  end
@@ -3,14 +3,15 @@
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.20.118
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.3.1-SNAPSHOT
9
+ OpenAPI Generator version: 5.0.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
13
13
  require 'date'
14
+ require 'time'
14
15
 
15
16
  module VeloPayments
16
17
  class UserResponse
@@ -112,7 +113,7 @@ module VeloPayments
112
113
  :'mfa_type' => :'String',
113
114
  :'mfa_status' => :'String',
114
115
  :'locked_out' => :'Boolean',
115
- :'locked_out_timestamp' => :'DateTime'
116
+ :'locked_out_timestamp' => :'Time'
116
117
  }
117
118
  end
118
119
 
@@ -201,17 +202,17 @@ module VeloPayments
201
202
  # @return Array for valid properties with the reasons
202
203
  def list_invalid_properties
203
204
  invalid_properties = Array.new
204
- pattern = Regexp.new(/^\+?[1-9]\d{1,14}$/)
205
+ pattern = Regexp.new(/^\+[1-9]\d{1,14}$/)
205
206
  if !@sms_number.nil? && @sms_number !~ pattern
206
207
  invalid_properties.push("invalid value for \"sms_number\", must conform to the pattern #{pattern}.")
207
208
  end
208
209
 
209
- pattern = Regexp.new(/^\+?[1-9]\d{1,14}$/)
210
+ pattern = Regexp.new(/^\+[1-9]\d{1,14}$/)
210
211
  if !@primary_contact_number.nil? && @primary_contact_number !~ pattern
211
212
  invalid_properties.push("invalid value for \"primary_contact_number\", must conform to the pattern #{pattern}.")
212
213
  end
213
214
 
214
- pattern = Regexp.new(/^\+?[1-9]\d{1,14}$/)
215
+ pattern = Regexp.new(/^\+[1-9]\d{1,14}$/)
215
216
  if !@secondary_contact_number.nil? && @secondary_contact_number !~ pattern
216
217
  invalid_properties.push("invalid value for \"secondary_contact_number\", must conform to the pattern #{pattern}.")
217
218
  end
@@ -240,9 +241,9 @@ module VeloPayments
240
241
  def valid?
241
242
  status_validator = EnumAttributeValidator.new('String', ["ENABLED", "DISABLED", "PENDING"])
242
243
  return false unless status_validator.valid?(@status)
243
- return false if !@sms_number.nil? && @sms_number !~ Regexp.new(/^\+?[1-9]\d{1,14}$/)
244
- return false if !@primary_contact_number.nil? && @primary_contact_number !~ Regexp.new(/^\+?[1-9]\d{1,14}$/)
245
- return false if !@secondary_contact_number.nil? && @secondary_contact_number !~ Regexp.new(/^\+?[1-9]\d{1,14}$/)
244
+ return false if !@sms_number.nil? && @sms_number !~ Regexp.new(/^\+[1-9]\d{1,14}$/)
245
+ return false if !@primary_contact_number.nil? && @primary_contact_number !~ Regexp.new(/^\+[1-9]\d{1,14}$/)
246
+ return false if !@secondary_contact_number.nil? && @secondary_contact_number !~ Regexp.new(/^\+[1-9]\d{1,14}$/)
246
247
  return false if !@first_name.nil? && @first_name.to_s.length > 128
247
248
  return false if !@first_name.nil? && @first_name.to_s.length < 1
248
249
  return false if !@last_name.nil? && @last_name.to_s.length > 128
@@ -267,7 +268,7 @@ module VeloPayments
267
268
  # Custom attribute writer method with validation
268
269
  # @param [Object] sms_number Value to be assigned
269
270
  def sms_number=(sms_number)
270
- pattern = Regexp.new(/^\+?[1-9]\d{1,14}$/)
271
+ pattern = Regexp.new(/^\+[1-9]\d{1,14}$/)
271
272
  if !sms_number.nil? && sms_number !~ pattern
272
273
  fail ArgumentError, "invalid value for \"sms_number\", must conform to the pattern #{pattern}."
273
274
  end
@@ -278,7 +279,7 @@ module VeloPayments
278
279
  # Custom attribute writer method with validation
279
280
  # @param [Object] primary_contact_number Value to be assigned
280
281
  def primary_contact_number=(primary_contact_number)
281
- pattern = Regexp.new(/^\+?[1-9]\d{1,14}$/)
282
+ pattern = Regexp.new(/^\+[1-9]\d{1,14}$/)
282
283
  if !primary_contact_number.nil? && primary_contact_number !~ pattern
283
284
  fail ArgumentError, "invalid value for \"primary_contact_number\", must conform to the pattern #{pattern}."
284
285
  end
@@ -289,7 +290,7 @@ module VeloPayments
289
290
  # Custom attribute writer method with validation
290
291
  # @param [Object] secondary_contact_number Value to be assigned
291
292
  def secondary_contact_number=(secondary_contact_number)
292
- pattern = Regexp.new(/^\+?[1-9]\d{1,14}$/)
293
+ pattern = Regexp.new(/^\+[1-9]\d{1,14}$/)
293
294
  if !secondary_contact_number.nil? && secondary_contact_number !~ pattern
294
295
  fail ArgumentError, "invalid value for \"secondary_contact_number\", must conform to the pattern #{pattern}."
295
296
  end
@@ -391,7 +392,9 @@ module VeloPayments
391
392
  def build_from_hash(attributes)
392
393
  return nil unless attributes.is_a?(Hash)
393
394
  self.class.openapi_types.each_pair do |key, type|
394
- if type =~ /\AArray<(.*)>/i
395
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
396
+ self.send("#{key}=", nil)
397
+ elsif type =~ /\AArray<(.*)>/i
395
398
  # check to ensure the input is an array given that the attribute
396
399
  # is documented as an array but the input is not
397
400
  if attributes[self.class.attribute_map[key]].is_a?(Array)
@@ -399,7 +402,7 @@ module VeloPayments
399
402
  end
400
403
  elsif !attributes[self.class.attribute_map[key]].nil?
401
404
  self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
402
- end # or else data not found in attributes(hash), not an issue as the data can be optional
405
+ end
403
406
  end
404
407
 
405
408
  self
@@ -411,8 +414,8 @@ module VeloPayments
411
414
  # @return [Object] Deserialized data
412
415
  def _deserialize(type, value)
413
416
  case type.to_sym
414
- when :DateTime
415
- DateTime.parse(value)
417
+ when :Time
418
+ Time.parse(value)
416
419
  when :Date
417
420
  Date.parse(value)
418
421
  when :String
@@ -491,5 +494,6 @@ module VeloPayments
491
494
  value
492
495
  end
493
496
  end
497
+
494
498
  end
495
499
  end
@@ -3,14 +3,15 @@
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.20.118
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.3.1-SNAPSHOT
9
+ OpenAPI Generator version: 5.0.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
13
13
  require 'date'
14
+ require 'time'
14
15
 
15
16
  module VeloPayments
16
17
  class UserStatus
@@ -3,14 +3,15 @@
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.20.118
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.3.1-SNAPSHOT
9
+ OpenAPI Generator version: 5.0.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
13
13
  require 'date'
14
+ require 'time'
14
15
 
15
16
  module VeloPayments
16
17
  class UserType
@@ -3,14 +3,15 @@
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.20.118
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.3.1-SNAPSHOT
9
+ OpenAPI Generator version: 5.0.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
13
13
  require 'date'
14
+ require 'time'
14
15
 
15
16
  module VeloPayments
16
17
  class UserType2
@@ -3,14 +3,15 @@
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.20.118
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.3.1-SNAPSHOT
9
+ OpenAPI Generator version: 5.0.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
13
13
  require 'date'
14
+ require 'time'
14
15
 
15
16
  module VeloPayments
16
17
  class ValidatePasswordResponse
@@ -158,7 +159,9 @@ module VeloPayments
158
159
  def build_from_hash(attributes)
159
160
  return nil unless attributes.is_a?(Hash)
160
161
  self.class.openapi_types.each_pair do |key, type|
161
- if type =~ /\AArray<(.*)>/i
162
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
163
+ self.send("#{key}=", nil)
164
+ elsif type =~ /\AArray<(.*)>/i
162
165
  # check to ensure the input is an array given that the attribute
163
166
  # is documented as an array but the input is not
164
167
  if attributes[self.class.attribute_map[key]].is_a?(Array)
@@ -166,7 +169,7 @@ module VeloPayments
166
169
  end
167
170
  elsif !attributes[self.class.attribute_map[key]].nil?
168
171
  self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
169
- end # or else data not found in attributes(hash), not an issue as the data can be optional
172
+ end
170
173
  end
171
174
 
172
175
  self
@@ -178,8 +181,8 @@ module VeloPayments
178
181
  # @return [Object] Deserialized data
179
182
  def _deserialize(type, value)
180
183
  case type.to_sym
181
- when :DateTime
182
- DateTime.parse(value)
184
+ when :Time
185
+ Time.parse(value)
183
186
  when :Date
184
187
  Date.parse(value)
185
188
  when :String
@@ -258,5 +261,6 @@ module VeloPayments
258
261
  value
259
262
  end
260
263
  end
264
+
261
265
  end
262
266
  end
@@ -3,14 +3,15 @@
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.20.118
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.3.1-SNAPSHOT
9
+ OpenAPI Generator version: 5.0.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
13
13
  require 'date'
14
+ require 'time'
14
15
 
15
16
  module VeloPayments
16
17
  class WatchlistStatus
@@ -0,0 +1,40 @@
1
+ =begin
2
+ #Velo Payments APIs
3
+
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
+
6
+ The version of the OpenAPI document: 2.23.78
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.0.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module VeloPayments
17
+ class WatchlistStatus2
18
+ NONE = "NONE".freeze
19
+ PENDING = "PENDING".freeze
20
+ REVIEW = "REVIEW".freeze
21
+ PASSED = "PASSED".freeze
22
+ FAILED = "FAILED".freeze
23
+
24
+ # Builds the enum from string
25
+ # @param [String] The enum value in the form of the string
26
+ # @return [String] The enum value
27
+ def self.build_from_hash(value)
28
+ new.build_from_hash(value)
29
+ end
30
+
31
+ # Builds the enum from string
32
+ # @param [String] The enum value in the form of the string
33
+ # @return [String] The enum value
34
+ def build_from_hash(value)
35
+ constantValues = WatchlistStatus2.constants.select { |c| WatchlistStatus2::const_get(c) == value }
36
+ raise "Invalid ENUM value #{value} for class #WatchlistStatus2" if constantValues.empty?
37
+ value
38
+ end
39
+ end
40
+ end
@@ -0,0 +1,246 @@
1
+ =begin
2
+ #Velo Payments APIs
3
+
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
+
6
+ The version of the OpenAPI document: 2.23.78
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.0.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module VeloPayments
17
+ class WebhookResponse
18
+ attr_accessor :id
19
+
20
+ attr_accessor :payor_id
21
+
22
+ attr_accessor :webhook_url
23
+
24
+ attr_accessor :authorization_header
25
+
26
+ attr_accessor :enabled
27
+
28
+ # Attribute mapping from ruby-style variable name to JSON key.
29
+ def self.attribute_map
30
+ {
31
+ :'id' => :'id',
32
+ :'payor_id' => :'payorId',
33
+ :'webhook_url' => :'webhookUrl',
34
+ :'authorization_header' => :'authorizationHeader',
35
+ :'enabled' => :'enabled'
36
+ }
37
+ end
38
+
39
+ # Attribute type mapping.
40
+ def self.openapi_types
41
+ {
42
+ :'id' => :'String',
43
+ :'payor_id' => :'String',
44
+ :'webhook_url' => :'String',
45
+ :'authorization_header' => :'String',
46
+ :'enabled' => :'Boolean'
47
+ }
48
+ end
49
+
50
+ # List of attributes with nullable: true
51
+ def self.openapi_nullable
52
+ Set.new([
53
+ ])
54
+ end
55
+
56
+ # Initializes the object
57
+ # @param [Hash] attributes Model attributes in the form of hash
58
+ def initialize(attributes = {})
59
+ if (!attributes.is_a?(Hash))
60
+ fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::WebhookResponse` initialize method"
61
+ end
62
+
63
+ # check to see if the attribute exists and convert string to symbol for hash key
64
+ attributes = attributes.each_with_object({}) { |(k, v), h|
65
+ if (!self.class.attribute_map.key?(k.to_sym))
66
+ fail ArgumentError, "`#{k}` is not a valid attribute in `VeloPayments::WebhookResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
67
+ end
68
+ h[k.to_sym] = v
69
+ }
70
+
71
+ if attributes.key?(:'id')
72
+ self.id = attributes[:'id']
73
+ end
74
+
75
+ if attributes.key?(:'payor_id')
76
+ self.payor_id = attributes[:'payor_id']
77
+ end
78
+
79
+ if attributes.key?(:'webhook_url')
80
+ self.webhook_url = attributes[:'webhook_url']
81
+ end
82
+
83
+ if attributes.key?(:'authorization_header')
84
+ self.authorization_header = attributes[:'authorization_header']
85
+ end
86
+
87
+ if attributes.key?(:'enabled')
88
+ self.enabled = attributes[:'enabled']
89
+ end
90
+ end
91
+
92
+ # Show invalid properties with the reasons. Usually used together with valid?
93
+ # @return Array for valid properties with the reasons
94
+ def list_invalid_properties
95
+ invalid_properties = Array.new
96
+ invalid_properties
97
+ end
98
+
99
+ # Check to see if the all the properties in the model are valid
100
+ # @return true if the model is valid
101
+ def valid?
102
+ true
103
+ end
104
+
105
+ # Checks equality by comparing each attribute.
106
+ # @param [Object] Object to be compared
107
+ def ==(o)
108
+ return true if self.equal?(o)
109
+ self.class == o.class &&
110
+ id == o.id &&
111
+ payor_id == o.payor_id &&
112
+ webhook_url == o.webhook_url &&
113
+ authorization_header == o.authorization_header &&
114
+ enabled == o.enabled
115
+ end
116
+
117
+ # @see the `==` method
118
+ # @param [Object] Object to be compared
119
+ def eql?(o)
120
+ self == o
121
+ end
122
+
123
+ # Calculates hash code according to all attributes.
124
+ # @return [Integer] Hash code
125
+ def hash
126
+ [id, payor_id, webhook_url, authorization_header, enabled].hash
127
+ end
128
+
129
+ # Builds the object from hash
130
+ # @param [Hash] attributes Model attributes in the form of hash
131
+ # @return [Object] Returns the model itself
132
+ def self.build_from_hash(attributes)
133
+ new.build_from_hash(attributes)
134
+ end
135
+
136
+ # Builds the object from hash
137
+ # @param [Hash] attributes Model attributes in the form of hash
138
+ # @return [Object] Returns the model itself
139
+ def build_from_hash(attributes)
140
+ return nil unless attributes.is_a?(Hash)
141
+ self.class.openapi_types.each_pair do |key, type|
142
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
143
+ self.send("#{key}=", nil)
144
+ elsif type =~ /\AArray<(.*)>/i
145
+ # check to ensure the input is an array given that the attribute
146
+ # is documented as an array but the input is not
147
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
148
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
149
+ end
150
+ elsif !attributes[self.class.attribute_map[key]].nil?
151
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
152
+ end
153
+ end
154
+
155
+ self
156
+ end
157
+
158
+ # Deserializes the data based on type
159
+ # @param string type Data type
160
+ # @param string value Value to be deserialized
161
+ # @return [Object] Deserialized data
162
+ def _deserialize(type, value)
163
+ case type.to_sym
164
+ when :Time
165
+ Time.parse(value)
166
+ when :Date
167
+ Date.parse(value)
168
+ when :String
169
+ value.to_s
170
+ when :Integer
171
+ value.to_i
172
+ when :Float
173
+ value.to_f
174
+ when :Boolean
175
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
176
+ true
177
+ else
178
+ false
179
+ end
180
+ when :Object
181
+ # generic object (usually a Hash), return directly
182
+ value
183
+ when /\AArray<(?<inner_type>.+)>\z/
184
+ inner_type = Regexp.last_match[:inner_type]
185
+ value.map { |v| _deserialize(inner_type, v) }
186
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
187
+ k_type = Regexp.last_match[:k_type]
188
+ v_type = Regexp.last_match[:v_type]
189
+ {}.tap do |hash|
190
+ value.each do |k, v|
191
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
192
+ end
193
+ end
194
+ else # model
195
+ VeloPayments.const_get(type).build_from_hash(value)
196
+ end
197
+ end
198
+
199
+ # Returns the string representation of the object
200
+ # @return [String] String presentation of the object
201
+ def to_s
202
+ to_hash.to_s
203
+ end
204
+
205
+ # to_body is an alias to to_hash (backward compatibility)
206
+ # @return [Hash] Returns the object in the form of hash
207
+ def to_body
208
+ to_hash
209
+ end
210
+
211
+ # Returns the object in the form of hash
212
+ # @return [Hash] Returns the object in the form of hash
213
+ def to_hash
214
+ hash = {}
215
+ self.class.attribute_map.each_pair do |attr, param|
216
+ value = self.send(attr)
217
+ if value.nil?
218
+ is_nullable = self.class.openapi_nullable.include?(attr)
219
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
220
+ end
221
+
222
+ hash[param] = _to_hash(value)
223
+ end
224
+ hash
225
+ end
226
+
227
+ # Outputs non-array value in the form of hash
228
+ # For object, use to_hash. Otherwise, just return the value
229
+ # @param [Object] value Any valid value
230
+ # @return [Hash] Returns the value in the form of hash
231
+ def _to_hash(value)
232
+ if value.is_a?(Array)
233
+ value.compact.map { |v| _to_hash(v) }
234
+ elsif value.is_a?(Hash)
235
+ {}.tap do |hash|
236
+ value.each { |k, v| hash[k] = _to_hash(v) }
237
+ end
238
+ elsif value.respond_to? :to_hash
239
+ value.to_hash
240
+ else
241
+ value
242
+ end
243
+ end
244
+
245
+ end
246
+ end