velopayments 2.18.113 → 2.19.40.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 (568) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +62 -48
  3. data/docs/Challenge.md +2 -2
  4. data/docs/Company.md +21 -0
  5. data/docs/Company2.md +21 -0
  6. data/docs/CompanyResponse.md +2 -2
  7. data/docs/CompanyV1.md +3 -3
  8. data/docs/CountriesApi.md +3 -13
  9. data/docs/CreateIndividual.md +2 -2
  10. data/docs/CreateIndividual2.md +3 -3
  11. data/docs/CreateIndividual2Name.md +23 -0
  12. data/docs/CreatePayee.md +4 -4
  13. data/docs/CreatePayee2.md +4 -4
  14. data/docs/CreatePayeesCSVRequest.md +22 -22
  15. data/docs/CreatePayeesCSVRequest2.md +23 -23
  16. data/docs/CreatePayeesCSVResponse.md +2 -2
  17. data/docs/CreatePayeesCSVResponse2.md +2 -2
  18. data/docs/CreatePayeesCSVResponseRejectedCsvRows.md +21 -0
  19. data/docs/CreatePayeesRequest.md +1 -1
  20. data/docs/CreatePayeesRequest2.md +1 -1
  21. data/docs/CreatePaymentChannel.md +6 -6
  22. data/docs/CreatePaymentChannel2.md +6 -6
  23. data/docs/CreatePayoutRequest.md +3 -3
  24. data/docs/CurrenciesApi.md +1 -6
  25. data/docs/FailedSubmission.md +2 -2
  26. data/docs/FailedSubmission2.md +19 -0
  27. data/docs/FundingManagerApi.md +8 -4
  28. data/docs/{DefaultApi.md → FundingManagerPrivateApi.md} +4 -4
  29. data/docs/GetPaymentsForPayoutResponseV4.md +1 -1
  30. data/docs/GetPayoutApi.md +5 -5
  31. data/docs/GetPayoutsResponseV4.md +1 -1
  32. data/docs/Individual.md +21 -0
  33. data/docs/Individual2.md +21 -0
  34. data/docs/IndividualV1.md +2 -2
  35. data/docs/IndividualV1Name.md +4 -4
  36. data/docs/InlineResponse400.md +19 -0
  37. data/docs/InlineResponse400Errors.md +23 -0
  38. data/docs/InlineResponse401.md +19 -0
  39. data/docs/InlineResponse401Errors.md +23 -0
  40. data/docs/InlineResponse403.md +19 -0
  41. data/docs/InlineResponse403Errors.md +23 -0
  42. data/docs/InstructPayoutApi.md +6 -6
  43. data/docs/InvitePayeeRequest.md +1 -1
  44. data/docs/{GenerateOTPRequest.md → InvitePayeeRequest2.md} +3 -3
  45. data/docs/InviteUserRequest.md +2 -2
  46. data/docs/{MFAStatus.md → Language2.md} +2 -2
  47. data/docs/{TokenType.md → LocationType.md} +2 -2
  48. data/docs/MarketingOptIn.md +1 -1
  49. data/docs/{OTPType.md → OfacStatus2.md} +2 -2
  50. data/docs/{PaymentStatus.md → OnboardedStatus2.md} +2 -2
  51. data/docs/PagedPayeeInvitationStatusResponse.md +1 -1
  52. data/docs/PagedPayeeInvitationStatusResponse2.md +21 -0
  53. data/docs/PagedPayeeInvitationStatusResponsePage.md +25 -0
  54. data/docs/PagedPayeeResponse2Summary.md +5 -5
  55. data/docs/PagedPayeeResponsePage.md +5 -5
  56. data/docs/PagedPayeeResponseSummary.md +5 -5
  57. data/docs/Payee.md +9 -9
  58. data/docs/Payee2.md +57 -0
  59. data/docs/PayeeAddress2.md +31 -0
  60. data/docs/PayeeDelta.md +1 -1
  61. data/docs/PayeeDelta2.md +29 -0
  62. data/docs/PayeeDeltaResponse2.md +21 -0
  63. data/docs/PayeeDeltaResponse2Links.md +19 -0
  64. data/docs/PayeeInvitationApi.md +184 -64
  65. data/docs/PayeeInvitationStatus.md +1 -1
  66. data/docs/PayeeInvitationStatusResponse.md +3 -3
  67. data/docs/PayeeInvitationStatusResponse2.md +21 -0
  68. data/docs/PayeePaymentChannel.md +8 -8
  69. data/docs/PayeePaymentChannel2.md +29 -0
  70. data/docs/PayeePayorRef.md +1 -1
  71. data/docs/PayeePayorRefV2.md +25 -0
  72. data/docs/PayeePayorRefV3.md +25 -0
  73. data/docs/PayeeResponse.md +9 -9
  74. data/docs/PayeeResponse2.md +10 -10
  75. data/docs/PayeeResponseV2.md +73 -0
  76. data/docs/PayeeResponseV3.md +71 -0
  77. data/docs/PayeesApi.md +316 -35
  78. data/docs/PaymentAuditServiceApi.md +4 -4
  79. data/docs/PaymentChannelCountry.md +3 -3
  80. data/docs/PaymentChannelRule.md +11 -11
  81. data/docs/PaymentDelta.md +1 -1
  82. data/docs/PaymentDeltaResponse.md +1 -1
  83. data/docs/PaymentInstruction.md +1 -1
  84. data/docs/QueryBatchResponse2.md +23 -0
  85. data/docs/ResendTokenRequest.md +1 -1
  86. data/docs/RoleUpdateRequest.md +19 -0
  87. data/docs/SubmitPayoutApi.md +2 -2
  88. data/docs/SupportedCountriesResponse2.md +1 -1
  89. data/docs/{SupportedCountryV2.md → SupportedCountry2.md} +3 -3
  90. data/docs/SupportedCurrency.md +3 -3
  91. data/docs/TokensApi.md +0 -498
  92. data/docs/UnregisterMFARequest.md +1 -1
  93. data/docs/UpdateRemoteIdRequest.md +2 -2
  94. data/docs/UserDetailsUpdateRequest.md +31 -0
  95. data/docs/UsersApi.md +108 -54
  96. data/docs/WithdrawPayoutApi.md +6 -6
  97. data/lib/velopayments.rb +38 -16
  98. data/lib/velopayments/api/countries_api.rb +6 -6
  99. data/lib/velopayments/api/currencies_api.rb +3 -3
  100. data/lib/velopayments/api/funding_manager_api.rb +22 -6
  101. data/lib/velopayments/api/{default_api.rb → funding_manager_private_api.rb} +5 -5
  102. data/lib/velopayments/api/get_payout_api.rb +8 -8
  103. data/lib/velopayments/api/instruct_payout_api.rb +10 -8
  104. data/lib/velopayments/api/login_api.rb +2 -2
  105. data/lib/velopayments/api/payee_invitation_api.rb +247 -111
  106. data/lib/velopayments/api/payees_api.rb +371 -35
  107. data/lib/velopayments/api/payment_audit_service_api.rb +6 -6
  108. data/lib/velopayments/api/payors_api.rb +2 -2
  109. data/lib/velopayments/api/payors_private_api.rb +2 -2
  110. data/lib/velopayments/api/payout_history_api.rb +2 -2
  111. data/lib/velopayments/api/quote_payout_api.rb +2 -2
  112. data/lib/velopayments/api/submit_payout_api.rb +6 -4
  113. data/lib/velopayments/api/tokens_api.rb +2 -695
  114. data/lib/velopayments/api/users_api.rb +142 -72
  115. data/lib/velopayments/api/withdraw_payout_api.rb +10 -8
  116. data/lib/velopayments/api_client.rb +2 -2
  117. data/lib/velopayments/api_error.rb +2 -2
  118. data/lib/velopayments/configuration.rb +2 -2
  119. data/lib/velopayments/models/accepted_payment.rb +13 -3
  120. data/lib/velopayments/models/access_token_response.rb +13 -3
  121. data/lib/velopayments/models/access_token_validation_request.rb +13 -3
  122. data/lib/velopayments/models/auth_response.rb +13 -3
  123. data/lib/velopayments/models/auto_top_up_config.rb +15 -3
  124. data/lib/velopayments/models/challenge.rb +13 -3
  125. data/lib/velopayments/models/company.rb +308 -0
  126. data/lib/velopayments/models/company2.rb +308 -0
  127. data/lib/velopayments/models/company_response.rb +14 -3
  128. data/lib/velopayments/models/company_v1.rb +15 -3
  129. data/lib/velopayments/models/create_funding_account_request.rb +13 -3
  130. data/lib/velopayments/models/create_individual.rb +13 -3
  131. data/lib/velopayments/models/create_individual2.rb +14 -4
  132. data/lib/velopayments/models/create_individual2_name.rb +347 -0
  133. data/lib/velopayments/models/create_payee.rb +16 -4
  134. data/lib/velopayments/models/create_payee2.rb +16 -4
  135. data/lib/velopayments/models/create_payee_address.rb +18 -3
  136. data/lib/velopayments/models/create_payee_address2.rb +18 -3
  137. data/lib/velopayments/models/create_payees_csv_request.rb +13 -3
  138. data/lib/velopayments/models/create_payees_csv_request2.rb +27 -11
  139. data/lib/velopayments/models/create_payees_csv_response.rb +14 -4
  140. data/lib/velopayments/models/create_payees_csv_response2.rb +14 -4
  141. data/lib/velopayments/models/create_payees_csv_response_rejected_csv_rows.rb +224 -0
  142. data/lib/velopayments/models/create_payees_request.rb +13 -3
  143. data/lib/velopayments/models/create_payees_request2.rb +13 -3
  144. data/lib/velopayments/models/create_payment_channel.rb +13 -3
  145. data/lib/velopayments/models/create_payment_channel2.rb +13 -3
  146. data/lib/velopayments/models/create_payor_link_request.rb +13 -3
  147. data/lib/velopayments/models/create_payout_request.rb +28 -3
  148. data/lib/velopayments/models/currency_type.rb +13 -3
  149. data/lib/velopayments/models/error.rb +15 -5
  150. data/lib/velopayments/models/error_response.rb +15 -3
  151. data/lib/velopayments/models/failed_submission.rb +14 -4
  152. data/lib/velopayments/models/{payee_payor_ref2.rb → failed_submission2.rb} +29 -28
  153. data/lib/velopayments/models/funding_account_response.rb +13 -3
  154. data/lib/velopayments/models/funding_audit.rb +13 -3
  155. data/lib/velopayments/models/funding_event.rb +13 -3
  156. data/lib/velopayments/models/funding_event_type.rb +2 -2
  157. data/lib/velopayments/models/funding_payor_status_audit_response.rb +13 -3
  158. data/lib/velopayments/models/funding_request_v1.rb +13 -3
  159. data/lib/velopayments/models/funding_request_v2.rb +13 -3
  160. data/lib/velopayments/models/fx_summary_v3.rb +13 -3
  161. data/lib/velopayments/models/fx_summary_v4.rb +13 -3
  162. data/lib/velopayments/models/get_fundings_response.rb +13 -3
  163. data/lib/velopayments/models/get_fundings_response_all_of.rb +13 -3
  164. data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +13 -3
  165. data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +13 -3
  166. data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +13 -3
  167. data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +14 -4
  168. data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +13 -3
  169. data/lib/velopayments/models/get_payout_statistics.rb +13 -3
  170. data/lib/velopayments/models/get_payouts_response_v3.rb +13 -3
  171. data/lib/velopayments/models/get_payouts_response_v3_links.rb +13 -3
  172. data/lib/velopayments/models/get_payouts_response_v3_page.rb +13 -3
  173. data/lib/velopayments/models/get_payouts_response_v4.rb +14 -4
  174. data/lib/velopayments/models/individual.rb +260 -0
  175. data/lib/velopayments/models/individual2.rb +260 -0
  176. data/lib/velopayments/models/individual_response.rb +13 -3
  177. data/lib/velopayments/models/individual_v1.rb +37 -3
  178. data/lib/velopayments/models/individual_v1_name.rb +13 -3
  179. data/lib/velopayments/models/{generate_otp_request.rb → inline_response400.rb} +38 -18
  180. data/lib/velopayments/models/{validate_otp_request.rb → inline_response400_errors.rb} +52 -46
  181. data/lib/velopayments/models/inline_response401.rb +221 -0
  182. data/lib/velopayments/models/{validate_mfa_request.rb → inline_response401_errors.rb} +52 -46
  183. data/lib/velopayments/models/inline_response403.rb +221 -0
  184. data/lib/velopayments/models/{check_token_response.rb → inline_response403_errors.rb} +44 -42
  185. data/lib/velopayments/models/invitation_status.rb +2 -2
  186. data/lib/velopayments/models/invitation_status_response.rb +13 -3
  187. data/lib/velopayments/models/invite_payee_request.rb +13 -3
  188. data/lib/velopayments/models/{register_mfa_response.rb → invite_payee_request2.rb} +28 -24
  189. data/lib/velopayments/models/invite_user_request.rb +17 -4
  190. data/lib/velopayments/models/kyc_state.rb +2 -2
  191. data/lib/velopayments/models/language.rb +2 -2
  192. data/lib/velopayments/models/{payment_status.rb → language2.rb} +16 -13
  193. data/lib/velopayments/models/link_for_response.rb +13 -3
  194. data/lib/velopayments/models/list_funding_accounts_response.rb +13 -3
  195. data/lib/velopayments/models/list_payments_response.rb +13 -3
  196. data/lib/velopayments/models/list_payments_response_page.rb +13 -3
  197. data/lib/velopayments/models/list_payments_response_v4.rb +13 -3
  198. data/lib/velopayments/models/list_source_account_response.rb +13 -3
  199. data/lib/velopayments/models/list_source_account_response_links.rb +13 -3
  200. data/lib/velopayments/models/list_source_account_response_page.rb +13 -3
  201. data/lib/velopayments/models/list_source_account_response_v2.rb +13 -3
  202. data/lib/velopayments/models/{token_type.rb → location_type.rb} +10 -9
  203. data/lib/velopayments/models/marketing_opt_in.rb +13 -3
  204. data/lib/velopayments/models/mfa_details.rb +14 -3
  205. data/lib/velopayments/models/mfa_type.rb +2 -2
  206. data/lib/velopayments/models/notifications.rb +13 -3
  207. data/lib/velopayments/models/ofac_status.rb +2 -2
  208. data/lib/velopayments/models/{mfa_status.rb → ofac_status2.rb} +8 -7
  209. data/lib/velopayments/models/onboarded_status.rb +2 -2
  210. data/lib/velopayments/models/{otp_type.rb → onboarded_status2.rb} +9 -6
  211. data/lib/velopayments/models/page_for_response.rb +13 -3
  212. data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +13 -3
  213. data/lib/velopayments/models/paged_payee_invitation_status_response.rb +14 -4
  214. data/lib/velopayments/models/paged_payee_invitation_status_response2.rb +229 -0
  215. data/lib/velopayments/models/paged_payee_invitation_status_response_page.rb +242 -0
  216. data/lib/velopayments/models/paged_payee_response.rb +13 -3
  217. data/lib/velopayments/models/paged_payee_response2.rb +13 -3
  218. data/lib/velopayments/models/paged_payee_response2_summary.rb +13 -3
  219. data/lib/velopayments/models/paged_payee_response_links.rb +13 -3
  220. data/lib/velopayments/models/paged_payee_response_page.rb +13 -3
  221. data/lib/velopayments/models/paged_payee_response_summary.rb +13 -3
  222. data/lib/velopayments/models/paged_response.rb +13 -3
  223. data/lib/velopayments/models/paged_response_page.rb +13 -3
  224. data/lib/velopayments/models/paged_user_response.rb +13 -3
  225. data/lib/velopayments/models/paged_user_response_links.rb +13 -3
  226. data/lib/velopayments/models/paged_user_response_page.rb +13 -3
  227. data/lib/velopayments/models/password_request.rb +13 -3
  228. data/lib/velopayments/models/payee.rb +19 -3
  229. data/lib/velopayments/models/payee2.rb +456 -0
  230. data/lib/velopayments/models/payee_address.rb +18 -3
  231. data/lib/velopayments/models/payee_address2.rb +493 -0
  232. data/lib/velopayments/models/payee_delta.rb +14 -3
  233. data/lib/velopayments/models/payee_delta2.rb +299 -0
  234. data/lib/velopayments/models/payee_delta_response.rb +13 -3
  235. data/lib/velopayments/models/payee_delta_response2.rb +229 -0
  236. data/lib/velopayments/models/{register_mfa_request.rb → payee_delta_response2_links.rb} +32 -18
  237. data/lib/velopayments/models/payee_delta_response_links.rb +13 -3
  238. data/lib/velopayments/models/payee_delta_response_page.rb +13 -3
  239. data/lib/velopayments/models/payee_invitation_status.rb +13 -3
  240. data/lib/velopayments/models/payee_invitation_status_response.rb +48 -4
  241. data/lib/velopayments/models/payee_invitation_status_response2.rb +268 -0
  242. data/lib/velopayments/models/payee_payment_channel.rb +60 -39
  243. data/lib/velopayments/models/payee_payment_channel2.rb +451 -0
  244. data/lib/velopayments/models/payee_payor_ref.rb +13 -3
  245. data/lib/velopayments/models/payee_payor_ref_v2.rb +278 -0
  246. data/lib/velopayments/models/payee_payor_ref_v3.rb +278 -0
  247. data/lib/velopayments/models/payee_response.rb +19 -3
  248. data/lib/velopayments/models/payee_response2.rb +20 -4
  249. data/lib/velopayments/models/payee_response_v2.rb +471 -0
  250. data/lib/velopayments/models/payee_response_v3.rb +462 -0
  251. data/lib/velopayments/models/payee_type.rb +2 -2
  252. data/lib/velopayments/models/payment_audit_currency_v3.rb +2 -2
  253. data/lib/velopayments/models/payment_audit_currency_v4.rb +2 -2
  254. data/lib/velopayments/models/payment_channel_country.rb +25 -3
  255. data/lib/velopayments/models/payment_channel_rule.rb +40 -3
  256. data/lib/velopayments/models/payment_channel_rules_response.rb +13 -3
  257. data/lib/velopayments/models/payment_delta.rb +20 -4
  258. data/lib/velopayments/models/payment_delta_response.rb +14 -4
  259. data/lib/velopayments/models/payment_event_response_v3.rb +13 -3
  260. data/lib/velopayments/models/payment_event_response_v4.rb +13 -3
  261. data/lib/velopayments/models/payment_instruction.rb +14 -47
  262. data/lib/velopayments/models/payment_rails.rb +2 -2
  263. data/lib/velopayments/models/payment_response_v3.rb +13 -3
  264. data/lib/velopayments/models/payment_response_v4.rb +13 -3
  265. data/lib/velopayments/models/payment_response_v4_payout.rb +13 -3
  266. data/lib/velopayments/models/payor_address.rb +18 -3
  267. data/lib/velopayments/models/payor_address_v2.rb +18 -3
  268. data/lib/velopayments/models/payor_aml_transaction_v3.rb +13 -3
  269. data/lib/velopayments/models/payor_aml_transaction_v4.rb +13 -3
  270. data/lib/velopayments/models/payor_branding_response.rb +16 -3
  271. data/lib/velopayments/models/payor_create_api_key_request.rb +14 -3
  272. data/lib/velopayments/models/payor_create_api_key_response.rb +13 -3
  273. data/lib/velopayments/models/payor_create_application_request.rb +14 -3
  274. data/lib/velopayments/models/payor_email_opt_out_request.rb +13 -3
  275. data/lib/velopayments/models/payor_links_response.rb +13 -3
  276. data/lib/velopayments/models/payor_links_response_links.rb +13 -3
  277. data/lib/velopayments/models/payor_links_response_payors.rb +13 -3
  278. data/lib/velopayments/models/payor_logo_request.rb +13 -3
  279. data/lib/velopayments/models/payor_v1.rb +13 -3
  280. data/lib/velopayments/models/payor_v2.rb +13 -3
  281. data/lib/velopayments/models/payout_payor_v4.rb +13 -3
  282. data/lib/velopayments/models/payout_principal_v4.rb +13 -3
  283. data/lib/velopayments/models/payout_status_v3.rb +2 -2
  284. data/lib/velopayments/models/payout_status_v4.rb +2 -2
  285. data/lib/velopayments/models/payout_summary_audit_v3.rb +13 -3
  286. data/lib/velopayments/models/payout_summary_audit_v4.rb +13 -3
  287. data/lib/velopayments/models/payout_summary_response.rb +13 -3
  288. data/lib/velopayments/models/payout_type_v4.rb +2 -2
  289. data/lib/velopayments/models/query_batch_response.rb +13 -3
  290. data/lib/velopayments/models/query_batch_response2.rb +270 -0
  291. data/lib/velopayments/models/quote_fx_summary.rb +13 -3
  292. data/lib/velopayments/models/quote_response.rb +13 -3
  293. data/lib/velopayments/models/region.rb +13 -3
  294. data/lib/velopayments/models/register_sms_request.rb +13 -3
  295. data/lib/velopayments/models/rejected_payment.rb +13 -3
  296. data/lib/velopayments/models/resend_token_request.rb +15 -4
  297. data/lib/velopayments/models/reset_password_request.rb +13 -3
  298. data/lib/velopayments/models/role.rb +13 -3
  299. data/lib/velopayments/models/{email_update_request.rb → role_update_request.rb} +31 -18
  300. data/lib/velopayments/models/self_mfa_type_unregister_request.rb +13 -3
  301. data/lib/velopayments/models/self_update_password_request.rb +13 -3
  302. data/lib/velopayments/models/set_notifications_request.rb +13 -3
  303. data/lib/velopayments/models/source_account.rb +13 -3
  304. data/lib/velopayments/models/source_account_response.rb +15 -3
  305. data/lib/velopayments/models/source_account_response_v2.rb +15 -3
  306. data/lib/velopayments/models/source_account_summary_v3.rb +13 -3
  307. data/lib/velopayments/models/source_account_summary_v4.rb +13 -3
  308. data/lib/velopayments/models/supported_countries_response.rb +13 -3
  309. data/lib/velopayments/models/supported_countries_response2.rb +14 -4
  310. data/lib/velopayments/models/supported_country.rb +13 -3
  311. data/lib/velopayments/models/{supported_country_v2.rb → supported_country2.rb} +20 -8
  312. data/lib/velopayments/models/supported_currency.rb +14 -3
  313. data/lib/velopayments/models/supported_currency_response.rb +13 -3
  314. data/lib/velopayments/models/transfer_request.rb +13 -3
  315. data/lib/velopayments/models/unregister_mfa_request.rb +17 -6
  316. data/lib/velopayments/models/update_remote_id_request.rb +13 -3
  317. data/lib/velopayments/models/user_details_update_request.rb +406 -0
  318. data/lib/velopayments/models/user_info.rb +13 -3
  319. data/lib/velopayments/models/user_response.rb +14 -3
  320. data/lib/velopayments/models/user_response2.rb +14 -3
  321. data/lib/velopayments/models/user_response2_roles.rb +13 -3
  322. data/lib/velopayments/models/user_status.rb +2 -2
  323. data/lib/velopayments/models/user_type.rb +2 -2
  324. data/lib/velopayments/models/user_type2.rb +2 -2
  325. data/lib/velopayments/models/validate_password_response.rb +13 -3
  326. data/lib/velopayments/models/watchlist_status.rb +2 -2
  327. data/lib/velopayments/version.rb +3 -3
  328. data/oa3-config.json +1 -1
  329. data/spec/api/countries_api_spec.rb +3 -3
  330. data/spec/api/currencies_api_spec.rb +2 -2
  331. data/spec/api/funding_manager_api_spec.rb +6 -4
  332. data/spec/api/{default_api_spec.rb → funding_manager_private_api_spec.rb} +8 -8
  333. data/spec/api/get_payout_api_spec.rb +4 -4
  334. data/spec/api/instruct_payout_api_spec.rb +4 -4
  335. data/spec/api/login_api_spec.rb +2 -2
  336. data/spec/api/payee_invitation_api_spec.rb +62 -33
  337. data/spec/api/payees_api_spec.rb +81 -15
  338. data/spec/api/payment_audit_service_api_spec.rb +4 -4
  339. data/spec/api/payors_api_spec.rb +2 -2
  340. data/spec/api/payors_private_api_spec.rb +2 -2
  341. data/spec/api/payout_history_api_spec.rb +2 -2
  342. data/spec/api/quote_payout_api_spec.rb +2 -2
  343. data/spec/api/submit_payout_api_spec.rb +3 -3
  344. data/spec/api/tokens_api_spec.rb +2 -131
  345. data/spec/api/users_api_spec.rb +28 -15
  346. data/spec/api/withdraw_payout_api_spec.rb +4 -4
  347. data/spec/api_client_spec.rb +2 -2
  348. data/spec/configuration_spec.rb +2 -2
  349. data/spec/models/accepted_payment_spec.rb +2 -2
  350. data/spec/models/access_token_response_spec.rb +2 -2
  351. data/spec/models/access_token_validation_request_spec.rb +2 -2
  352. data/spec/models/auth_response_spec.rb +2 -2
  353. data/spec/models/auto_top_up_config_spec.rb +2 -2
  354. data/spec/models/challenge_spec.rb +2 -2
  355. data/spec/models/{payee_payor_ref2_spec.rb → company2_spec.rb} +11 -11
  356. data/spec/models/company_response_spec.rb +2 -2
  357. data/spec/models/company_spec.rb +53 -0
  358. data/spec/models/company_v1_spec.rb +2 -2
  359. data/spec/models/create_funding_account_request_spec.rb +2 -2
  360. data/spec/models/create_individual2_name_spec.rb +59 -0
  361. data/spec/models/create_individual2_spec.rb +2 -2
  362. data/spec/models/create_individual_spec.rb +2 -2
  363. data/spec/models/create_payee2_spec.rb +2 -2
  364. data/spec/models/create_payee_address2_spec.rb +2 -2
  365. data/spec/models/create_payee_address_spec.rb +2 -2
  366. data/spec/models/create_payee_spec.rb +2 -2
  367. data/spec/models/create_payees_csv_request2_spec.rb +2 -2
  368. data/spec/models/create_payees_csv_request_spec.rb +2 -2
  369. data/spec/models/create_payees_csv_response2_spec.rb +2 -2
  370. data/spec/models/create_payees_csv_response_rejected_csv_rows_spec.rb +53 -0
  371. data/spec/models/create_payees_csv_response_spec.rb +2 -2
  372. data/spec/models/create_payees_request2_spec.rb +2 -2
  373. data/spec/models/create_payees_request_spec.rb +2 -2
  374. data/spec/models/create_payment_channel2_spec.rb +2 -2
  375. data/spec/models/create_payment_channel_spec.rb +2 -2
  376. data/spec/models/create_payor_link_request_spec.rb +2 -2
  377. data/spec/models/create_payout_request_spec.rb +2 -2
  378. data/spec/models/currency_type_spec.rb +2 -2
  379. data/spec/models/error_response_spec.rb +2 -2
  380. data/spec/models/error_spec.rb +3 -3
  381. data/spec/models/{register_mfa_response_spec.rb → failed_submission2_spec.rb} +10 -10
  382. data/spec/models/failed_submission_spec.rb +2 -2
  383. data/spec/models/funding_account_response_spec.rb +2 -2
  384. data/spec/models/funding_audit_spec.rb +2 -2
  385. data/spec/models/funding_event_spec.rb +2 -2
  386. data/spec/models/funding_event_type_spec.rb +2 -2
  387. data/spec/models/funding_payor_status_audit_response_spec.rb +2 -2
  388. data/spec/models/funding_request_v1_spec.rb +2 -2
  389. data/spec/models/funding_request_v2_spec.rb +2 -2
  390. data/spec/models/fx_summary_v3_spec.rb +2 -2
  391. data/spec/models/fx_summary_v4_spec.rb +2 -2
  392. data/spec/models/get_fundings_response_all_of_spec.rb +2 -2
  393. data/spec/models/get_fundings_response_spec.rb +2 -2
  394. data/spec/models/get_payments_for_payout_response_v3_page_spec.rb +2 -2
  395. data/spec/models/get_payments_for_payout_response_v3_spec.rb +2 -2
  396. data/spec/models/get_payments_for_payout_response_v3_summary_spec.rb +2 -2
  397. data/spec/models/get_payments_for_payout_response_v4_spec.rb +2 -2
  398. data/spec/models/get_payments_for_payout_response_v4_summary_spec.rb +2 -2
  399. data/spec/models/get_payout_statistics_spec.rb +2 -2
  400. data/spec/models/get_payouts_response_v3_links_spec.rb +2 -2
  401. data/spec/models/get_payouts_response_v3_page_spec.rb +2 -2
  402. data/spec/models/get_payouts_response_v3_spec.rb +2 -2
  403. data/spec/models/get_payouts_response_v4_spec.rb +2 -2
  404. data/spec/models/individual2_spec.rb +53 -0
  405. data/spec/models/individual_response_spec.rb +2 -2
  406. data/spec/models/individual_spec.rb +53 -0
  407. data/spec/models/individual_v1_name_spec.rb +2 -2
  408. data/spec/models/individual_v1_spec.rb +2 -2
  409. data/spec/models/inline_response400_errors_spec.rb +59 -0
  410. data/spec/models/{generate_otp_request_spec.rb → inline_response400_spec.rb} +15 -9
  411. data/spec/models/inline_response401_errors_spec.rb +59 -0
  412. data/spec/models/inline_response401_spec.rb +47 -0
  413. data/spec/models/inline_response403_errors_spec.rb +59 -0
  414. data/spec/models/inline_response403_spec.rb +47 -0
  415. data/spec/models/invitation_status_response_spec.rb +2 -2
  416. data/spec/models/invitation_status_spec.rb +2 -2
  417. data/spec/models/{register_mfa_request_spec.rb → invite_payee_request2_spec.rb} +9 -9
  418. data/spec/models/invite_payee_request_spec.rb +2 -2
  419. data/spec/models/invite_user_request_spec.rb +2 -2
  420. data/spec/models/kyc_state_spec.rb +2 -2
  421. data/spec/models/{otp_type_spec.rb → language2_spec.rb} +8 -8
  422. data/spec/models/language_spec.rb +2 -2
  423. data/spec/models/link_for_response_spec.rb +2 -2
  424. data/spec/models/list_funding_accounts_response_spec.rb +2 -2
  425. data/spec/models/list_payments_response_page_spec.rb +2 -2
  426. data/spec/models/list_payments_response_spec.rb +2 -2
  427. data/spec/models/list_payments_response_v4_spec.rb +2 -2
  428. data/spec/models/list_source_account_response_links_spec.rb +2 -2
  429. data/spec/models/list_source_account_response_page_spec.rb +2 -2
  430. data/spec/models/list_source_account_response_spec.rb +2 -2
  431. data/spec/models/list_source_account_response_v2_spec.rb +2 -2
  432. data/spec/models/{token_type_spec.rb → location_type_spec.rb} +8 -8
  433. data/spec/models/marketing_opt_in_spec.rb +2 -2
  434. data/spec/models/mfa_details_spec.rb +2 -2
  435. data/spec/models/mfa_type_spec.rb +2 -2
  436. data/spec/models/notifications_spec.rb +2 -2
  437. data/spec/models/{mfa_status_spec.rb → ofac_status2_spec.rb} +8 -8
  438. data/spec/models/ofac_status_spec.rb +2 -2
  439. data/spec/models/{payment_status_spec.rb → onboarded_status2_spec.rb} +8 -8
  440. data/spec/models/onboarded_status_spec.rb +2 -2
  441. data/spec/models/page_for_response_spec.rb +2 -2
  442. data/spec/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response_spec.rb +2 -2
  443. data/spec/models/paged_payee_invitation_status_response2_spec.rb +53 -0
  444. data/spec/models/{check_token_response_spec.rb → paged_payee_invitation_status_response_page_spec.rb} +13 -13
  445. data/spec/models/paged_payee_invitation_status_response_spec.rb +2 -2
  446. data/spec/models/paged_payee_response2_spec.rb +2 -2
  447. data/spec/models/paged_payee_response2_summary_spec.rb +2 -2
  448. data/spec/models/paged_payee_response_links_spec.rb +2 -2
  449. data/spec/models/paged_payee_response_page_spec.rb +2 -2
  450. data/spec/models/paged_payee_response_spec.rb +2 -2
  451. data/spec/models/paged_payee_response_summary_spec.rb +2 -2
  452. data/spec/models/paged_response_page_spec.rb +2 -2
  453. data/spec/models/paged_response_spec.rb +2 -2
  454. data/spec/models/paged_user_response_links_spec.rb +2 -2
  455. data/spec/models/paged_user_response_page_spec.rb +2 -2
  456. data/spec/models/paged_user_response_spec.rb +2 -2
  457. data/spec/models/password_request_spec.rb +2 -2
  458. data/spec/models/payee2_spec.rb +165 -0
  459. data/spec/models/payee_address2_spec.rb +83 -0
  460. data/spec/models/payee_address_spec.rb +2 -2
  461. data/spec/models/payee_delta2_spec.rb +77 -0
  462. data/spec/models/payee_delta_response2_links_spec.rb +47 -0
  463. data/spec/models/payee_delta_response2_spec.rb +53 -0
  464. data/spec/models/payee_delta_response_links_spec.rb +2 -2
  465. data/spec/models/payee_delta_response_page_spec.rb +2 -2
  466. data/spec/models/payee_delta_response_spec.rb +2 -2
  467. data/spec/models/payee_delta_spec.rb +2 -2
  468. data/spec/models/payee_invitation_status_response2_spec.rb +57 -0
  469. data/spec/models/payee_invitation_status_response_spec.rb +6 -2
  470. data/spec/models/payee_invitation_status_spec.rb +2 -2
  471. data/spec/models/payee_payment_channel2_spec.rb +81 -0
  472. data/spec/models/payee_payment_channel_spec.rb +3 -3
  473. data/spec/models/payee_payor_ref_spec.rb +2 -2
  474. data/spec/models/payee_payor_ref_v2_spec.rb +69 -0
  475. data/spec/models/payee_payor_ref_v3_spec.rb +69 -0
  476. data/spec/models/payee_response2_spec.rb +2 -2
  477. data/spec/models/payee_response_spec.rb +2 -2
  478. data/spec/models/payee_response_v2_spec.rb +209 -0
  479. data/spec/models/payee_response_v3_spec.rb +203 -0
  480. data/spec/models/payee_spec.rb +2 -2
  481. data/spec/models/payee_type_spec.rb +2 -2
  482. data/spec/models/payment_audit_currency_v3_spec.rb +2 -2
  483. data/spec/models/payment_audit_currency_v4_spec.rb +2 -2
  484. data/spec/models/payment_channel_country_spec.rb +2 -2
  485. data/spec/models/payment_channel_rule_spec.rb +2 -2
  486. data/spec/models/payment_channel_rules_response_spec.rb +2 -2
  487. data/spec/models/payment_delta_response_spec.rb +2 -2
  488. data/spec/models/payment_delta_spec.rb +2 -2
  489. data/spec/models/payment_event_response_v3_spec.rb +2 -2
  490. data/spec/models/payment_event_response_v4_spec.rb +2 -2
  491. data/spec/models/payment_instruction_spec.rb +2 -6
  492. data/spec/models/payment_rails_spec.rb +2 -2
  493. data/spec/models/payment_response_v3_spec.rb +2 -2
  494. data/spec/models/payment_response_v4_payout_spec.rb +2 -2
  495. data/spec/models/payment_response_v4_spec.rb +2 -2
  496. data/spec/models/payor_address_spec.rb +2 -2
  497. data/spec/models/payor_address_v2_spec.rb +2 -2
  498. data/spec/models/payor_aml_transaction_v3_spec.rb +2 -2
  499. data/spec/models/payor_aml_transaction_v4_spec.rb +2 -2
  500. data/spec/models/payor_branding_response_spec.rb +2 -2
  501. data/spec/models/payor_create_api_key_request_spec.rb +2 -2
  502. data/spec/models/payor_create_api_key_response_spec.rb +2 -2
  503. data/spec/models/payor_create_application_request_spec.rb +2 -2
  504. data/spec/models/payor_email_opt_out_request_spec.rb +2 -2
  505. data/spec/models/payor_links_response_links_spec.rb +2 -2
  506. data/spec/models/payor_links_response_payors_spec.rb +2 -2
  507. data/spec/models/payor_links_response_spec.rb +2 -2
  508. data/spec/models/payor_logo_request_spec.rb +2 -2
  509. data/spec/models/payor_v1_spec.rb +2 -2
  510. data/spec/models/payor_v2_spec.rb +2 -2
  511. data/spec/models/payout_payor_v4_spec.rb +2 -2
  512. data/spec/models/payout_principal_v4_spec.rb +2 -2
  513. data/spec/models/payout_status_v3_spec.rb +2 -2
  514. data/spec/models/payout_status_v4_spec.rb +2 -2
  515. data/spec/models/payout_summary_audit_v3_spec.rb +2 -2
  516. data/spec/models/payout_summary_audit_v4_spec.rb +2 -2
  517. data/spec/models/payout_summary_response_spec.rb +2 -2
  518. data/spec/models/payout_type_v4_spec.rb +2 -2
  519. data/spec/models/query_batch_response2_spec.rb +63 -0
  520. data/spec/models/query_batch_response_spec.rb +2 -2
  521. data/spec/models/quote_fx_summary_spec.rb +2 -2
  522. data/spec/models/quote_response_spec.rb +2 -2
  523. data/spec/models/region_spec.rb +2 -2
  524. data/spec/models/register_sms_request_spec.rb +2 -2
  525. data/spec/models/rejected_payment_spec.rb +2 -2
  526. data/spec/models/resend_token_request_spec.rb +2 -2
  527. data/spec/models/reset_password_request_spec.rb +2 -2
  528. data/spec/models/role_spec.rb +2 -2
  529. data/spec/models/{email_update_request_spec.rb → role_update_request_spec.rb} +9 -9
  530. data/spec/models/self_mfa_type_unregister_request_spec.rb +2 -2
  531. data/spec/models/self_update_password_request_spec.rb +2 -2
  532. data/spec/models/set_notifications_request_spec.rb +2 -2
  533. data/spec/models/source_account_response_spec.rb +2 -2
  534. data/spec/models/source_account_response_v2_spec.rb +2 -2
  535. data/spec/models/source_account_spec.rb +2 -2
  536. data/spec/models/source_account_summary_v3_spec.rb +2 -2
  537. data/spec/models/source_account_summary_v4_spec.rb +2 -2
  538. data/spec/models/supported_countries_response2_spec.rb +2 -2
  539. data/spec/models/supported_countries_response_spec.rb +2 -2
  540. data/spec/models/{supported_country_v2_spec.rb → supported_country2_spec.rb} +8 -8
  541. data/spec/models/supported_country_spec.rb +2 -2
  542. data/spec/models/supported_currency_response_spec.rb +2 -2
  543. data/spec/models/supported_currency_spec.rb +2 -2
  544. data/spec/models/transfer_request_spec.rb +2 -2
  545. data/spec/models/unregister_mfa_request_spec.rb +3 -3
  546. data/spec/models/update_remote_id_request_spec.rb +2 -2
  547. data/spec/models/user_details_update_request_spec.rb +83 -0
  548. data/spec/models/user_info_spec.rb +2 -2
  549. data/spec/models/user_response2_roles_spec.rb +2 -2
  550. data/spec/models/user_response2_spec.rb +2 -2
  551. data/spec/models/user_response_spec.rb +2 -2
  552. data/spec/models/user_status_spec.rb +2 -2
  553. data/spec/models/user_type2_spec.rb +2 -2
  554. data/spec/models/user_type_spec.rb +2 -2
  555. data/spec/models/validate_password_response_spec.rb +2 -2
  556. data/spec/models/watchlist_status_spec.rb +2 -2
  557. data/spec/spec_helper.rb +2 -2
  558. data/velopayments.gemspec +2 -2
  559. metadata +310 -222
  560. data/docs/CheckTokenResponse.md +0 -25
  561. data/docs/EmailUpdateRequest.md +0 -19
  562. data/docs/PayeePayorRef2.md +0 -21
  563. data/docs/RegisterMFARequest.md +0 -17
  564. data/docs/RegisterMFAResponse.md +0 -19
  565. data/docs/ValidateMFARequest.md +0 -17
  566. data/docs/ValidateOTPRequest.md +0 -17
  567. data/spec/models/validate_mfa_request_spec.rb +0 -41
  568. data/spec/models/validate_otp_request_spec.rb +0 -41
data/docs/PaymentAuditServiceApi.md CHANGED
@@ -562,7 +562,7 @@ opts = {
562
562
  from_payor_name: 'from_payor_name_example', # String | The name of the payor whose payees are being paid. This filters via a case insensitive substring match.
563
563
  page: 1, # Integer | Page number. Default is 1.
564
564
  page_size: 25, # Integer | Page size. Default is 25. Max allowable is 100.
565
- sort: 'sort_example' # String | List of sort fields (e.g. ?sort=submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status, totalPayments
565
+ sort: 'sort_example' # String | List of sort fields (e.g. ?sort=submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status, totalPayments, payoutId
566
566
  }
567
567
 
568
568
  begin
@@ -587,7 +587,7 @@ Name | Type | Description | Notes
587
587
  **from_payor_name** | **String**| The name of the payor whose payees are being paid. This filters via a case insensitive substring match. | [optional]
588
588
  **page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
589
589
  **page_size** | **Integer**| Page size. Default is 25. Max allowable is 100. | [optional] [default to 25]
590
- **sort** | **String**| List of sort fields (e.g. ?sort=submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status, totalPayments | [optional]
590
+ **sort** | **String**| List of sort fields (e.g. ?sort=submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status, totalPayments, payoutId | [optional]
591
591
 
592
592
  ### Return type
593
593
 
@@ -791,7 +791,7 @@ opts = {
791
791
  payment_memo: 'payment_memo_example', # String | The payment memo filter. This filters via a case insensitive substring match.
792
792
  page: 1, # Integer | Page number. Default is 1.
793
793
  page_size: 25, # Integer | Page size. Default is 25. Max allowable is 100.
794
- sort: 'sort_example', # String | List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status
794
+ sort: 'sort_example', # String | List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by submittedDateTime:desc,paymentId:asc The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime, status and paymentId
795
795
  sensitive: true # Boolean | Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
796
796
  }
797
797
 
@@ -826,7 +826,7 @@ Name | Type | Description | Notes
826
826
  **payment_memo** | **String**| The payment memo filter. This filters via a case insensitive substring match. | [optional]
827
827
  **page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
828
828
  **page_size** | **Integer**| Page size. Default is 25. Max allowable is 100. | [optional] [default to 25]
829
- **sort** | **String**| List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status | [optional]
829
+ **sort** | **String**| List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by submittedDateTime:desc,paymentId:asc The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime, status and paymentId | [optional]
830
830
  **sensitive** | **Boolean**| Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values. | [optional]
831
831
 
832
832
  ### Return type
data/docs/PaymentChannelCountry.md CHANGED
@@ -4,15 +4,15 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **iso_country_code** | **String** | | [optional]
8
- **rules** | [**Array<PaymentChannelRule>**](PaymentChannelRule.md) | | [optional]
7
+ **iso_country_code** | **String** | The ISO code for the country |
8
+ **rules** | [**Array<PaymentChannelRule>**](PaymentChannelRule.md) | The rules for the given country |
9
9
 
10
10
  ## Code Sample
11
11
 
12
12
  ```ruby
13
13
  require 'VeloPayments'
14
14
 
15
- instance = VeloPayments::PaymentChannelCountry.new(iso_country_code: null,
15
+ instance = VeloPayments::PaymentChannelCountry.new(iso_country_code: US,
16
16
  rules: null)
17
17
  ```
18
18
 
data/docs/PaymentChannelRule.md CHANGED
@@ -4,12 +4,12 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **element** | **String** | | [optional]
8
- **required** | **Boolean** | | [optional]
9
- **display_name** | **String** | | [optional]
10
- **min_length** | **Integer** | | [optional]
11
- **max_length** | **Integer** | | [optional]
12
- **validation** | **String** | | [optional]
7
+ **element** | **String** | <p>the rule element</p> <p>will match a given element name for a payment channel configuration |
8
+ **required** | **Boolean** | is this element required |
9
+ **display_name** | **String** | User friendly name |
10
+ **min_length** | **Integer** | mininum length of the element data | [optional]
11
+ **max_length** | **Integer** | maximum length of the element data | [optional]
12
+ **validation** | **String** | a regex to validate the element data |
13
13
  **display_order** | **Integer** | | [optional]
14
14
 
15
15
  ## Code Sample
@@ -17,12 +17,12 @@ Name | Type | Description | Notes
17
17
  ```ruby
18
18
  require 'VeloPayments'
19
19
 
20
- instance = VeloPayments::PaymentChannelRule.new(element: null,
20
+ instance = VeloPayments::PaymentChannelRule.new(element: accountName,
21
21
  required: null,
22
- display_name: null,
23
- min_length: null,
24
- max_length: null,
25
- validation: null,
22
+ display_name: Account Name,
23
+ min_length: 5,
24
+ max_length: 50,
25
+ validation: ^[0-9]{6,11}$,
26
26
  display_order: null)
27
27
  ```
28
28
 
data/docs/PaymentDelta.md CHANGED
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
9
9
  **payor_payment_id** | **String** | | [optional]
10
10
  **payment_currency** | **String** | | [optional]
11
11
  **payment_amount** | **Integer** | | [optional]
12
- **status** | [**PaymentStatus**](PaymentStatus.md) | | [optional]
12
+ **status** | **String** | | [optional]
13
13
  **source_currency** | **String** | | [optional]
14
14
  **source_amount** | **Integer** | | [optional]
15
15
 
data/docs/PaymentDeltaResponse.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **page** | [**PagedPayeeResponsePage**](PagedPayeeResponsePage.md) | | [optional]
7
+ **page** | [**PagedPayeeInvitationStatusResponsePage**](PagedPayeeInvitationStatusResponsePage.md) | | [optional]
8
8
  **links** | [**Array<PagedPayeeResponseLinks>**](PagedPayeeResponseLinks.md) | | [optional]
9
9
  **content** | [**Array<PaymentDelta>**](PaymentDelta.md) | | [optional]
10
10
 
data/docs/PaymentInstruction.md CHANGED
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **remote_id** | **String** | Your identifier for payee |
8
8
  **currency** | **String** | Payee's currency |
9
- **amount** | **Integer** | Amount to send to Payee |
9
+ **amount** | **Integer** | <p>Amount to send to Payee</p> <p>The maximum payment amount is dependent on the currency</p> |
10
10
  **payment_memo** | **String** | | [optional]
11
11
  **source_account_name** | **String** | |
12
12
  **payor_payment_id** | **String** | | [optional]
data/docs/QueryBatchResponse2.md ADDED
@@ -0,0 +1,23 @@
1
+ # VeloPayments::QueryBatchResponse2
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **status** | **String** | Batch Status | [optional]
8
+ **failure_count** | **Integer** | | [optional]
9
+ **pending_count** | **Integer** | | [optional]
10
+ **failures** | [**Array<FailedSubmission2>**](FailedSubmission2.md) | | [optional]
11
+
12
+ ## Code Sample
13
+
14
+ ```ruby
15
+ require 'VeloPayments'
16
+
17
+ instance = VeloPayments::QueryBatchResponse2.new(status: null,
18
+ failure_count: 2,
19
+ pending_count: 2,
20
+ failures: null)
21
+ ```
22
+
23
+
data/docs/ResendTokenRequest.md CHANGED
@@ -5,7 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **token_type** | **String** | The type of the token to resend |
8
- **verification_code** | **String** | Optional property that MUST be suppied when manually verifying a user <P> The user's smsNumber is registered via a separate endpoint and an OTP sent to them | [optional]
8
+ **verification_code** | **String** | <p>Optional property that MUST be suppied when manually verifying a user</p> <p>The user's smsNumber is registered via a separate endpoint and an OTP sent to them</p> | [optional]
9
9
 
10
10
  ## Code Sample
11
11
 
data/docs/RoleUpdateRequest.md ADDED
@@ -0,0 +1,19 @@
1
+ # VeloPayments::RoleUpdateRequest
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **roles** | **Array<String>** | <p>The role(s) for the user</p> <p>The role must exist</p> <p>The role can be a custom role or a system role but the invoker must have the permissions to assign the role</p> <p>System roles are: backoffice.admin, payor.master_admin, payor.admin, payor.support</p> |
8
+ **verification_code** | **String** | <p>Optional property that MUST be suppied when manually verifying a user</p> <p>The user's smsNumber is registered via a separate endpoint and an OTP sent to them</p> | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'VeloPayments'
14
+
15
+ instance = VeloPayments::RoleUpdateRequest.new(roles: ["payor.admin"],
16
+ verification_code: 123456)
17
+ ```
18
+
19
+
data/docs/SubmitPayoutApi.md CHANGED
@@ -14,7 +14,7 @@ Method | HTTP request | Description
14
14
 
15
15
  Submit Payout
16
16
 
17
- Create a new payout and return a location header with a link to get the payout. Basic validation of the payout is performed before returning but more comprehensive validation is done asynchronously, the results of which can be obtained by issuing a HTTP GET to the URL returned in the location header. **NOTE:** amount values in payments must be in 'minor units' format. E.g. cents for USD, pence for GBP etc. with no decimal places.
17
+ <p>Create a new payout and return a location header with a link to get the payout.</p> <p>Basic validation of the payout is performed before returning but more comprehensive validation is done asynchronously.</p> <p>The results can be obtained by issuing a HTTP GET to the URL returned in the location header.</p> <p>**NOTE:** amount values in payments must be in 'minor units' format. E.g. cents for USD, pence for GBP etc.</p> with no decimal places.
18
18
 
19
19
  ### Example
20
20
 
@@ -56,5 +56,5 @@ nil (empty response body)
56
56
  ### HTTP request headers
57
57
 
58
58
  - **Content-Type**: application/json, multipart/form-data
59
- - **Accept**: Not defined
59
+ - **Accept**: application/json
60
60
 
data/docs/SupportedCountriesResponse2.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **countries** | [**Array&lt;SupportedCountryV2&gt;**](SupportedCountryV2.md) | | [optional]
7
+ **countries** | [**Array&lt;SupportedCountry2&gt;**](SupportedCountry2.md) | | [optional]
8
8
 
9
9
  ## Code Sample
10
10
 
data/docs/{SupportedCountryV2.md → SupportedCountry2.md} RENAMED
@@ -1,4 +1,4 @@
1
- # VeloPayments::SupportedCountryV2
1
+ # VeloPayments::SupportedCountry2
2
2
 
3
3
  ## Properties
4
4
 
@@ -6,14 +6,14 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **iso_country_code** | **String** | | [optional]
8
8
  **currencies** | **Array&lt;String&gt;** | | [optional]
9
- **regions** | [**Region**](Region.md) | | [optional]
9
+ **regions** | [**Array&lt;Region&gt;**](Region.md) | | [optional]
10
10
 
11
11
  ## Code Sample
12
12
 
13
13
  ```ruby
14
14
  require 'VeloPayments'
15
15
 
16
- instance = VeloPayments::SupportedCountryV2.new(iso_country_code: US,
16
+ instance = VeloPayments::SupportedCountry2.new(iso_country_code: US,
17
17
  currencies: [&quot;USD&quot;],
18
18
  regions: null)
19
19
  ```
data/docs/SupportedCurrency.md CHANGED
@@ -5,15 +5,15 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **currency** | **String** | ISO Currency Code | [optional]
8
- **max_payment_amount** | **Integer** | | [optional]
8
+ **max_payment_amount** | **Integer** | The max amount allowed in this currency | [optional]
9
9
 
10
10
  ## Code Sample
11
11
 
12
12
  ```ruby
13
13
  require 'VeloPayments'
14
14
 
15
- instance = VeloPayments::SupportedCurrency.new(currency: null,
16
- max_payment_amount: null)
15
+ instance = VeloPayments::SupportedCurrency.new(currency: GBP,
16
+ max_payment_amount: 100000)
17
17
  ```
18
18
 
19
19
 
data/docs/TokensApi.md CHANGED
@@ -4,263 +4,10 @@ All URIs are relative to *https://api.sandbox.velopayments.com*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**generate_otp**](TokensApi.md#generate_otp) | **POST** /v1/tokens/{tokenId}/otp | Generate an OTP
8
- [**generate_otp_for_sms**](TokensApi.md#generate_otp_for_sms) | **POST** /v1/tokens/{tokenId}/otp/generate | Send an OTP to SMS Users
9
- [**get_qr_code_for_mfa**](TokensApi.md#get_qr_code_for_mfa) | **GET** /v1/tokens/{tokenId}/mfa/qrcode | Get a QR Code image
10
- [**get_verification_token_by_id**](TokensApi.md#get_verification_token_by_id) | **GET** /v1/tokens/{tokenId} | Get Token
11
- [**register_mfa**](TokensApi.md#register_mfa) | **POST** /v1/tokens/{tokenId}/mfa/register | Register an MFA Device
12
7
  [**resend_token**](TokensApi.md#resend_token) | **POST** /v2/users/{userId}/tokens | Resend a token
13
- [**submit_password**](TokensApi.md#submit_password) | **POST** /v1/tokens/{tokenId}/password | Submit a password
14
- [**unlock_account_with_token**](TokensApi.md#unlock_account_with_token) | **POST** /v1/tokens/{tokenId}/password/lockout | Unlock the user
15
- [**validate_mfa**](TokensApi.md#validate_mfa) | **POST** /v1/tokens/{tokenId}/mfa/validate | Validate an MFA Device
16
- [**validate_otp**](TokensApi.md#validate_otp) | **POST** /v1/tokens/{tokenId}/otp/validate | Validate an OTP
17
- [**validate_password**](TokensApi.md#validate_password) | **POST** /v1/tokens/{tokenId}/password/validate | Validate the proposed password
18
8
 
19
9
 
20
10
 
21
- ## generate_otp
22
-
23
- > generate_otp(token_id, generate_otp_request)
24
-
25
- Generate an OTP
26
-
27
- Generate an OTP and send to the MFA type specified in the request body
28
-
29
- ### Example
30
-
31
- ```ruby
32
- # load the gem
33
- require 'velopayments'
34
-
35
- api_instance = VeloPayments::TokensApi.new
36
- token_id = 'token_id_example' # String | The UUID of the Token
37
- generate_otp_request = VeloPayments::GenerateOTPRequest.new # GenerateOTPRequest | The MFA type to send the generated OTP to
38
-
39
- begin
40
- #Generate an OTP
41
- api_instance.generate_otp(token_id, generate_otp_request)
42
- rescue VeloPayments::ApiError => e
43
- puts "Exception when calling TokensApi->generate_otp: #{e}"
44
- end
45
- ```
46
-
47
- ### Parameters
48
-
49
-
50
- Name | Type | Description | Notes
51
- ------------- | ------------- | ------------- | -------------
52
- **token_id** | [**String**](.md)| The UUID of the Token |
53
- **generate_otp_request** | [**GenerateOTPRequest**](GenerateOTPRequest.md)| The MFA type to send the generated OTP to |
54
-
55
- ### Return type
56
-
57
- nil (empty response body)
58
-
59
- ### Authorization
60
-
61
- No authorization required
62
-
63
- ### HTTP request headers
64
-
65
- - **Content-Type**: application/json
66
- - **Accept**: application/json
67
-
68
-
69
- ## generate_otp_for_sms
70
-
71
- > generate_otp_for_sms(token_id)
72
-
73
- Send an OTP to SMS Users
74
-
75
- <p>Generate an OTP and send to the SMS device if the user</p> <p>Only users who have SMS as their registered MFA device will receive an OTP</p> <p>Used in conjuction with endpoints that require the Velo-OTP header</p>
76
-
77
- ### Example
78
-
79
- ```ruby
80
- # load the gem
81
- require 'velopayments'
82
-
83
- api_instance = VeloPayments::TokensApi.new
84
- token_id = 'token_id_example' # String | The UUID of the Token
85
-
86
- begin
87
- #Send an OTP to SMS Users
88
- api_instance.generate_otp_for_sms(token_id)
89
- rescue VeloPayments::ApiError => e
90
- puts "Exception when calling TokensApi->generate_otp_for_sms: #{e}"
91
- end
92
- ```
93
-
94
- ### Parameters
95
-
96
-
97
- Name | Type | Description | Notes
98
- ------------- | ------------- | ------------- | -------------
99
- **token_id** | [**String**](.md)| The UUID of the Token |
100
-
101
- ### Return type
102
-
103
- nil (empty response body)
104
-
105
- ### Authorization
106
-
107
- No authorization required
108
-
109
- ### HTTP request headers
110
-
111
- - **Content-Type**: Not defined
112
- - **Accept**: application/json
113
-
114
-
115
- ## get_qr_code_for_mfa
116
-
117
- > File get_qr_code_for_mfa(token_id, opts)
118
-
119
- Get a QR Code image
120
-
121
- <p>Get a QR Code for an MFA device that supports it </p> <p>The device must have first been registered</p>
122
-
123
- ### Example
124
-
125
- ```ruby
126
- # load the gem
127
- require 'velopayments'
128
-
129
- api_instance = VeloPayments::TokensApi.new
130
- token_id = 'token_id_example' # String | The UUID of the Token
131
- opts = {
132
- width: 56, # Integer | The width of the image
133
- height: 56 # Integer | The height of the image
134
- }
135
-
136
- begin
137
- #Get a QR Code image
138
- result = api_instance.get_qr_code_for_mfa(token_id, opts)
139
- p result
140
- rescue VeloPayments::ApiError => e
141
- puts "Exception when calling TokensApi->get_qr_code_for_mfa: #{e}"
142
- end
143
- ```
144
-
145
- ### Parameters
146
-
147
-
148
- Name | Type | Description | Notes
149
- ------------- | ------------- | ------------- | -------------
150
- **token_id** | [**String**](.md)| The UUID of the Token |
151
- **width** | **Integer**| The width of the image | [optional]
152
- **height** | **Integer**| The height of the image | [optional]
153
-
154
- ### Return type
155
-
156
- **File**
157
-
158
- ### Authorization
159
-
160
- No authorization required
161
-
162
- ### HTTP request headers
163
-
164
- - **Content-Type**: Not defined
165
- - **Accept**: image/png, application/json
166
-
167
-
168
- ## get_verification_token_by_id
169
-
170
- > CheckTokenResponse get_verification_token_by_id(token_id)
171
-
172
- Get Token
173
-
174
- Get a Single Verification Token by Id.
175
-
176
- ### Example
177
-
178
- ```ruby
179
- # load the gem
180
- require 'velopayments'
181
-
182
- api_instance = VeloPayments::TokensApi.new
183
- token_id = 'token_id_example' # String | The UUID of the Token
184
-
185
- begin
186
- #Get Token
187
- result = api_instance.get_verification_token_by_id(token_id)
188
- p result
189
- rescue VeloPayments::ApiError => e
190
- puts "Exception when calling TokensApi->get_verification_token_by_id: #{e}"
191
- end
192
- ```
193
-
194
- ### Parameters
195
-
196
-
197
- Name | Type | Description | Notes
198
- ------------- | ------------- | ------------- | -------------
199
- **token_id** | [**String**](.md)| The UUID of the Token |
200
-
201
- ### Return type
202
-
203
- [**CheckTokenResponse**](CheckTokenResponse.md)
204
-
205
- ### Authorization
206
-
207
- No authorization required
208
-
209
- ### HTTP request headers
210
-
211
- - **Content-Type**: Not defined
212
- - **Accept**: application/json
213
-
214
-
215
- ## register_mfa
216
-
217
- > RegisterMFAResponse register_mfa(token_id, register_mfa_request)
218
-
219
- Register an MFA Device
220
-
221
- <p>Some MFA Devices based on TOTP require a registration step (Authy, Authenticator) </p> <p>Registering the device will create a shared secret that the MFA device uses to generate OTPs</p>
222
-
223
- ### Example
224
-
225
- ```ruby
226
- # load the gem
227
- require 'velopayments'
228
-
229
- api_instance = VeloPayments::TokensApi.new
230
- token_id = 'token_id_example' # String | The UUID of the Token
231
- register_mfa_request = VeloPayments::RegisterMFARequest.new # RegisterMFARequest | The MFA Type to register
232
-
233
- begin
234
- #Register an MFA Device
235
- result = api_instance.register_mfa(token_id, register_mfa_request)
236
- p result
237
- rescue VeloPayments::ApiError => e
238
- puts "Exception when calling TokensApi->register_mfa: #{e}"
239
- end
240
- ```
241
-
242
- ### Parameters
243
-
244
-
245
- Name | Type | Description | Notes
246
- ------------- | ------------- | ------------- | -------------
247
- **token_id** | [**String**](.md)| The UUID of the Token |
248
- **register_mfa_request** | [**RegisterMFARequest**](RegisterMFARequest.md)| The MFA Type to register |
249
-
250
- ### Return type
251
-
252
- [**RegisterMFAResponse**](RegisterMFAResponse.md)
253
-
254
- ### Authorization
255
-
256
- No authorization required
257
-
258
- ### HTTP request headers
259
-
260
- - **Content-Type**: application/json
261
- - **Accept**: application/json
262
-
263
-
264
11
  ## resend_token
265
12
 
266
13
  > resend_token(user_id, resend_token_request)
@@ -313,248 +60,3 @@ nil (empty response body)
313
60
  - **Content-Type**: application/json
314
61
  - **Accept**: application/json
315
62
 
316
-
317
- ## submit_password
318
-
319
- > AccessTokenResponse submit_password(token_id, password_request, opts)
320
-
321
- Submit a password
322
-
323
- Submit a password
324
-
325
- ### Example
326
-
327
- ```ruby
328
- # load the gem
329
- require 'velopayments'
330
-
331
- api_instance = VeloPayments::TokensApi.new
332
- token_id = 'token_id_example' # String | The UUID of the Token
333
- password_request = VeloPayments::PasswordRequest.new # PasswordRequest | The password
334
- opts = {
335
- velo_otp: 'velo_otp_example' # String | required when updating password using reset password <P> The OTP is supplied by the users MFA device
336
- }
337
-
338
- begin
339
- #Submit a password
340
- result = api_instance.submit_password(token_id, password_request, opts)
341
- p result
342
- rescue VeloPayments::ApiError => e
343
- puts "Exception when calling TokensApi->submit_password: #{e}"
344
- end
345
- ```
346
-
347
- ### Parameters
348
-
349
-
350
- Name | Type | Description | Notes
351
- ------------- | ------------- | ------------- | -------------
352
- **token_id** | [**String**](.md)| The UUID of the Token |
353
- **password_request** | [**PasswordRequest**](PasswordRequest.md)| The password |
354
- **velo_otp** | **String**| required when updating password using reset password &lt;P&gt; The OTP is supplied by the users MFA device | [optional]
355
-
356
- ### Return type
357
-
358
- [**AccessTokenResponse**](AccessTokenResponse.md)
359
-
360
- ### Authorization
361
-
362
- No authorization required
363
-
364
- ### HTTP request headers
365
-
366
- - **Content-Type**: application/json
367
- - **Accept**: application/json
368
-
369
-
370
- ## unlock_account_with_token
371
-
372
- > unlock_account_with_token(token_id)
373
-
374
- Unlock the user
375
-
376
- <p>When a user is locked out of their account due to execeding the limit of login attempts</p> <p>They can use a token to unlock their account </p> <p>Submitting the token will unlock the account associated with the token</p>
377
-
378
- ### Example
379
-
380
- ```ruby
381
- # load the gem
382
- require 'velopayments'
383
-
384
- api_instance = VeloPayments::TokensApi.new
385
- token_id = 'token_id_example' # String | The UUID of the Token
386
-
387
- begin
388
- #Unlock the user
389
- api_instance.unlock_account_with_token(token_id)
390
- rescue VeloPayments::ApiError => e
391
- puts "Exception when calling TokensApi->unlock_account_with_token: #{e}"
392
- end
393
- ```
394
-
395
- ### Parameters
396
-
397
-
398
- Name | Type | Description | Notes
399
- ------------- | ------------- | ------------- | -------------
400
- **token_id** | [**String**](.md)| The UUID of the Token |
401
-
402
- ### Return type
403
-
404
- nil (empty response body)
405
-
406
- ### Authorization
407
-
408
- No authorization required
409
-
410
- ### HTTP request headers
411
-
412
- - **Content-Type**: Not defined
413
- - **Accept**: application/json
414
-
415
-
416
- ## validate_mfa
417
-
418
- > AccessTokenResponse validate_mfa(token_id, validate_mfa_request)
419
-
420
- Validate an MFA Device
421
-
422
- <p>Validate the user's registered MFA device with an OTP </p> <p>The response will be different based on the token type against which the MFA is validated </p> <p>For INVITE_MFA_USER tokens the response will be 200 and an access token will be returned i the response </p> <p>For MFA_REGISTRATION tokens the response will be 204</p>
423
-
424
- ### Example
425
-
426
- ```ruby
427
- # load the gem
428
- require 'velopayments'
429
-
430
- api_instance = VeloPayments::TokensApi.new
431
- token_id = 'token_id_example' # String | The UUID of the Token
432
- validate_mfa_request = VeloPayments::ValidateMFARequest.new # ValidateMFARequest | The OTP generated or received by the device
433
-
434
- begin
435
- #Validate an MFA Device
436
- result = api_instance.validate_mfa(token_id, validate_mfa_request)
437
- p result
438
- rescue VeloPayments::ApiError => e
439
- puts "Exception when calling TokensApi->validate_mfa: #{e}"
440
- end
441
- ```
442
-
443
- ### Parameters
444
-
445
-
446
- Name | Type | Description | Notes
447
- ------------- | ------------- | ------------- | -------------
448
- **token_id** | [**String**](.md)| The UUID of the Token |
449
- **validate_mfa_request** | [**ValidateMFARequest**](ValidateMFARequest.md)| The OTP generated or received by the device |
450
-
451
- ### Return type
452
-
453
- [**AccessTokenResponse**](AccessTokenResponse.md)
454
-
455
- ### Authorization
456
-
457
- No authorization required
458
-
459
- ### HTTP request headers
460
-
461
- - **Content-Type**: application/json
462
- - **Accept**: application/json
463
-
464
-
465
- ## validate_otp
466
-
467
- > validate_otp(token_id, validate_otp_request)
468
-
469
- Validate an OTP
470
-
471
- <p>Validate the OTP </p> <p>The token that was used in the request will be revoked and a new token issued </p> <p>The new token link will be returned in a location header</p> <p>If there are too many invalid OTP requests the token may be disabled</p>
472
-
473
- ### Example
474
-
475
- ```ruby
476
- # load the gem
477
- require 'velopayments'
478
-
479
- api_instance = VeloPayments::TokensApi.new
480
- token_id = 'token_id_example' # String | The UUID of the Token
481
- validate_otp_request = VeloPayments::ValidateOTPRequest.new # ValidateOTPRequest | The OTP generated and sent to the device
482
-
483
- begin
484
- #Validate an OTP
485
- api_instance.validate_otp(token_id, validate_otp_request)
486
- rescue VeloPayments::ApiError => e
487
- puts "Exception when calling TokensApi->validate_otp: #{e}"
488
- end
489
- ```
490
-
491
- ### Parameters
492
-
493
-
494
- Name | Type | Description | Notes
495
- ------------- | ------------- | ------------- | -------------
496
- **token_id** | [**String**](.md)| The UUID of the Token |
497
- **validate_otp_request** | [**ValidateOTPRequest**](ValidateOTPRequest.md)| The OTP generated and sent to the device |
498
-
499
- ### Return type
500
-
501
- nil (empty response body)
502
-
503
- ### Authorization
504
-
505
- No authorization required
506
-
507
- ### HTTP request headers
508
-
509
- - **Content-Type**: application/json
510
- - **Accept**: application/json
511
-
512
-
513
- ## validate_password
514
-
515
- > ValidatePasswordResponse validate_password(token_id, password_request)
516
-
517
- Validate the proposed password
518
-
519
- validate the password and return a score
520
-
521
- ### Example
522
-
523
- ```ruby
524
- # load the gem
525
- require 'velopayments'
526
-
527
- api_instance = VeloPayments::TokensApi.new
528
- token_id = 'token_id_example' # String | The UUID of the Token
529
- password_request = VeloPayments::PasswordRequest.new # PasswordRequest | The password
530
-
531
- begin
532
- #Validate the proposed password
533
- result = api_instance.validate_password(token_id, password_request)
534
- p result
535
- rescue VeloPayments::ApiError => e
536
- puts "Exception when calling TokensApi->validate_password: #{e}"
537
- end
538
- ```
539
-
540
- ### Parameters
541
-
542
-
543
- Name | Type | Description | Notes
544
- ------------- | ------------- | ------------- | -------------
545
- **token_id** | [**String**](.md)| The UUID of the Token |
546
- **password_request** | [**PasswordRequest**](PasswordRequest.md)| The password |
547
-
548
- ### Return type
549
-
550
- [**ValidatePasswordResponse**](ValidatePasswordResponse.md)
551
-
552
- ### Authorization
553
-
554
- No authorization required
555
-
556
- ### HTTP request headers
557
-
558
- - **Content-Type**: application/json
559
- - **Accept**: application/json
560
-