velopayments 2.18.113 → 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 (764) hide show
  1. checksums.yaml +4 -4
  2. data/Dockerfile +7 -0
  3. data/Gemfile +1 -1
  4. data/Makefile +8 -12
  5. data/README.md +161 -74
  6. data/docs/{AcceptedPayment.md → AcceptedPaymentV3.md} +3 -3
  7. data/docs/AutoTopUpConfig2.md +23 -0
  8. data/docs/Challenge.md +2 -2
  9. data/docs/Challenge2.md +19 -0
  10. data/docs/Company.md +21 -0
  11. data/docs/Company2.md +21 -0
  12. data/docs/CompanyResponse.md +2 -2
  13. data/docs/CompanyV1.md +3 -3
  14. data/docs/CountriesApi.md +21 -31
  15. data/docs/CreateFundingAccountRequestV2.md +29 -0
  16. data/docs/CreateIndividual.md +2 -2
  17. data/docs/CreateIndividual2.md +3 -3
  18. data/docs/CreateIndividual2Name.md +23 -0
  19. data/docs/CreatePayee.md +4 -4
  20. data/docs/CreatePayee2.md +7 -7
  21. data/docs/CreatePayeesCSVRequest.md +22 -22
  22. data/docs/CreatePayeesCSVRequest2.md +23 -23
  23. data/docs/CreatePayeesCSVResponse.md +2 -2
  24. data/docs/CreatePayeesCSVResponse2.md +2 -2
  25. data/docs/CreatePayeesCSVResponseRejectedCsvRows.md +21 -0
  26. data/docs/CreatePayeesRequest.md +1 -1
  27. data/docs/CreatePayeesRequest2.md +1 -1
  28. data/docs/CreatePaymentChannel.md +6 -6
  29. data/docs/CreatePaymentChannel2.md +6 -6
  30. data/docs/{CreatePayoutRequest.md → CreatePayoutRequestV3.md} +6 -6
  31. data/docs/CreateWebhookRequest.md +23 -0
  32. data/docs/CurrenciesApi.md +7 -12
  33. data/docs/FailedSubmission.md +2 -2
  34. data/docs/FailedSubmission2.md +19 -0
  35. data/docs/FundingAccountResponse.md +15 -7
  36. data/docs/FundingAccountResponse2.md +35 -0
  37. data/docs/FundingAccountType.md +16 -0
  38. data/docs/FundingAudit.md +5 -5
  39. data/docs/FundingEvent.md +1 -1
  40. data/docs/FundingManagerApi.md +337 -36
  41. data/docs/{DefaultApi.md → FundingManagerPrivateApi.md} +9 -9
  42. data/docs/FundingPayorStatusAuditResponse.md +2 -2
  43. data/docs/FundingRequestV3.md +19 -0
  44. data/docs/FxSummaryV3.md +1 -1
  45. data/docs/FxSummaryV4.md +1 -1
  46. data/docs/GetFundingsResponse.md +2 -2
  47. data/docs/GetFundingsResponseLinks.md +19 -0
  48. data/docs/GetPayeeListResponse.md +49 -0
  49. data/docs/GetPayeeListResponseCompany.md +19 -0
  50. data/docs/GetPayeeListResponseIndividual.md +17 -0
  51. data/docs/GetPaymentsForPayoutResponseV3Summary.md +3 -3
  52. data/docs/GetPaymentsForPayoutResponseV4.md +1 -1
  53. data/docs/GetPaymentsForPayoutResponseV4Summary.md +6 -4
  54. data/docs/GetPayoutsResponseV4.md +1 -1
  55. data/docs/Individual.md +21 -0
  56. data/docs/Individual2.md +21 -0
  57. data/docs/IndividualV1.md +2 -2
  58. data/docs/IndividualV1Name.md +4 -4
  59. data/docs/InlineResponse400.md +19 -0
  60. data/docs/InlineResponse400Errors.md +23 -0
  61. data/docs/InlineResponse401.md +19 -0
  62. data/docs/InlineResponse401Errors.md +23 -0
  63. data/docs/InlineResponse403.md +19 -0
  64. data/docs/InlineResponse403Errors.md +23 -0
  65. data/docs/InlineResponse404.md +19 -0
  66. data/docs/InlineResponse404Errors.md +23 -0
  67. data/docs/InlineResponse409.md +19 -0
  68. data/docs/InlineResponse409Errors.md +23 -0
  69. data/docs/InlineResponse412.md +19 -0
  70. data/docs/InlineResponse412Errors.md +23 -0
  71. data/docs/InvitationStatus2.md +16 -0
  72. data/docs/InvitePayeeRequest.md +1 -1
  73. data/docs/InvitePayeeRequest2.md +17 -0
  74. data/docs/InviteUserRequest.md +2 -2
  75. data/docs/{TokenType.md → Language2.md} +2 -2
  76. data/docs/ListFundingAccountsResponse2.md +21 -0
  77. data/docs/{ListPaymentsResponse.md → ListPaymentsResponseV3.md} +3 -3
  78. data/docs/{ListPaymentsResponsePage.md → ListPaymentsResponseV3Page.md} +2 -2
  79. data/docs/ListPaymentsResponseV4.md +1 -1
  80. data/docs/ListSourceAccountResponseV2.md +1 -1
  81. data/docs/ListSourceAccountResponseV2Links.md +19 -0
  82. data/docs/ListSourceAccountResponseV3.md +21 -0
  83. data/docs/ListSourceAccountResponseV3Links.md +19 -0
  84. data/docs/{PaymentStatus.md → LocationType.md} +2 -2
  85. data/docs/LoginApi.md +6 -2
  86. data/docs/MarketingOptIn.md +2 -2
  87. data/docs/Name.md +23 -0
  88. data/docs/Notifications2.md +17 -0
  89. data/docs/{MFAStatus.md → OfacStatus2.md} +2 -2
  90. data/docs/OnboardedStatus2.md +16 -0
  91. data/docs/PagedPayeeInvitationStatusResponse.md +1 -1
  92. data/docs/PagedPayeeInvitationStatusResponse2.md +21 -0
  93. data/docs/{PagedResponsePage.md → PagedPayeeInvitationStatusResponsePage.md} +2 -2
  94. data/docs/PagedPayeeResponse2.md +1 -1
  95. data/docs/PagedPayeeResponse2Summary.md +5 -5
  96. data/docs/PagedPayeeResponsePage.md +5 -5
  97. data/docs/PagedPayeeResponseSummary.md +5 -5
  98. data/docs/PagedPaymentsResponseV3.md +21 -0
  99. data/docs/Payee.md +11 -11
  100. data/docs/{PayeeResponse2.md → Payee2.md} +22 -20
  101. data/docs/PayeeAddress2.md +31 -0
  102. data/docs/PayeeDelta.md +1 -1
  103. data/docs/PayeeDelta2.md +29 -0
  104. data/docs/PayeeDeltaResponse2.md +21 -0
  105. data/docs/PayeeDeltaResponse2Links.md +19 -0
  106. data/docs/PayeeDetailResponse.md +73 -0
  107. data/docs/PayeeDetailResponse2.md +73 -0
  108. data/docs/PayeeInvitationApi.md +405 -60
  109. data/docs/PayeeInvitationStatus.md +1 -1
  110. data/docs/PayeeInvitationStatusResponse.md +3 -3
  111. data/docs/PayeeInvitationStatusResponse2.md +21 -0
  112. data/docs/PayeePaymentChannel.md +8 -8
  113. data/docs/PayeePaymentChannel2.md +29 -0
  114. data/docs/PayeePayorRef.md +1 -1
  115. data/docs/PayeePayorRef2.md +6 -2
  116. data/docs/PayeePayorRefV2.md +25 -0
  117. data/docs/PayeePayorRefV3.md +25 -0
  118. data/docs/PayeeResponse.md +11 -11
  119. data/docs/PayeeResponseV2.md +73 -0
  120. data/docs/{OTPType.md → PayeeType2.md} +2 -2
  121. data/docs/PayeeUserSelfUpdateRequest.md +27 -0
  122. data/docs/PayeesApi.md +753 -59
  123. data/docs/PaymentAuditServiceApi.md +271 -39
  124. data/docs/PaymentChannelCountry.md +3 -3
  125. data/docs/PaymentChannelRule.md +11 -11
  126. data/docs/PaymentDelta.md +1 -1
  127. data/docs/PaymentDeltaResponse.md +1 -1
  128. data/docs/PaymentDeltaResponseV4.md +21 -0
  129. data/docs/PaymentDeltaV4.md +31 -0
  130. data/docs/PaymentEventResponseV3.md +1 -1
  131. data/docs/PaymentEventResponseV4.md +1 -1
  132. data/docs/{PaymentInstruction.md → PaymentInstructionV3.md} +7 -5
  133. data/docs/PaymentResponseV3.md +1 -1
  134. data/docs/PaymentResponseV4.md +7 -1
  135. data/docs/PaymentV3.md +37 -0
  136. data/docs/PayorV1.md +3 -1
  137. data/docs/PayorV2.md +5 -1
  138. data/docs/PayorsApi.md +14 -14
  139. data/docs/{CurrencyType.md → PayoutCompanyV3.md} +3 -3
  140. data/docs/{GenerateOTPRequest.md → PayoutIndividualV3.md} +3 -3
  141. data/docs/PayoutNameV3.md +19 -0
  142. data/docs/PayoutPayeeV3.md +21 -0
  143. data/docs/PayoutServiceApi.md +393 -0
  144. data/docs/PayoutSummaryAuditV4.md +4 -2
  145. data/docs/{PayoutSummaryResponse.md → PayoutSummaryResponseV3.md} +8 -6
  146. data/docs/PingResponse.md +19 -0
  147. data/docs/QueryBatchResponse2.md +23 -0
  148. data/docs/{QuoteFxSummary.md → QuoteFxSummaryV3.md} +6 -6
  149. data/docs/QuoteResponseV3.md +17 -0
  150. data/docs/{Region.md → RegionV2.md} +2 -2
  151. data/docs/{RejectedPayment.md → RejectedPaymentV3.md} +3 -3
  152. data/docs/ResendTokenRequest.md +1 -1
  153. data/docs/RoleUpdateRequest.md +19 -0
  154. data/docs/SourceAccountResponse.md +3 -1
  155. data/docs/SourceAccountResponseV2.md +4 -2
  156. data/docs/SourceAccountResponseV3.md +47 -0
  157. data/docs/SourceAccountType.md +16 -0
  158. data/docs/{SourceAccount.md → SourceAccountV3.md} +3 -3
  159. data/docs/{SupportedCountriesResponse2.md → SupportedCountriesResponseV2.md} +2 -2
  160. data/docs/SupportedCountry.md +2 -2
  161. data/docs/SupportedCountryV2.md +3 -3
  162. data/docs/SupportedCurrencyResponseV2.md +17 -0
  163. data/docs/SupportedCurrencyV2.md +19 -0
  164. data/docs/TokensApi.md +0 -498
  165. data/docs/TransferRequest2.md +21 -0
  166. data/docs/TransmissionType.md +16 -0
  167. data/docs/TransmissionTypes.md +21 -0
  168. data/docs/TransmissionTypes2.md +21 -0
  169. data/docs/UnregisterMFARequest.md +1 -1
  170. data/docs/UpdatePayeeDetailsRequest.md +29 -0
  171. data/docs/UpdatePayeeDetailsRequest2.md +29 -0
  172. data/docs/UpdateRemoteIdRequest.md +2 -2
  173. data/docs/UpdateWebhookRequest.md +21 -0
  174. data/docs/UserDetailsUpdateRequest.md +31 -0
  175. data/docs/UserResponse.md +1 -1
  176. data/docs/UsersApi.md +170 -60
  177. data/docs/WatchlistStatus2.md +16 -0
  178. data/docs/WebhookResponse.md +25 -0
  179. data/docs/WebhooksApi.md +280 -0
  180. data/docs/WebhooksResponse.md +21 -0
  181. data/docs/WithdrawPaymentRequest.md +17 -0
  182. data/lib/velopayments.rb +102 -42
  183. data/lib/velopayments/api/countries_api.rb +40 -37
  184. data/lib/velopayments/api/currencies_api.rb +13 -12
  185. data/lib/velopayments/api/funding_manager_api.rb +536 -78
  186. data/lib/velopayments/api/{default_api.rb → funding_manager_private_api.rb} +15 -14
  187. data/lib/velopayments/api/login_api.rb +21 -14
  188. data/lib/velopayments/api/payee_invitation_api.rb +531 -116
  189. data/lib/velopayments/api/payees_api.rb +945 -73
  190. data/lib/velopayments/api/payment_audit_service_api.rb +448 -82
  191. data/lib/velopayments/api/payors_api.rb +48 -40
  192. data/lib/velopayments/api/payors_private_api.rb +6 -5
  193. data/lib/velopayments/api/payout_service_api.rb +506 -0
  194. data/lib/velopayments/api/tokens_api.rb +6 -698
  195. data/lib/velopayments/api/users_api.rb +280 -118
  196. data/lib/velopayments/api/webhooks_api.rb +350 -0
  197. data/lib/velopayments/api_client.rb +47 -44
  198. data/lib/velopayments/api_error.rb +2 -2
  199. data/lib/velopayments/configuration.rb +35 -8
  200. data/lib/velopayments/models/{accepted_payment.rb → accepted_payment_v3.rb} +36 -10
  201. data/lib/velopayments/models/access_token_response.rb +21 -7
  202. data/lib/velopayments/models/access_token_validation_request.rb +21 -7
  203. data/lib/velopayments/models/auth_response.rb +21 -7
  204. data/lib/velopayments/models/auto_top_up_config.rb +23 -7
  205. data/lib/velopayments/models/auto_top_up_config2.rb +248 -0
  206. data/lib/velopayments/models/challenge.rb +21 -7
  207. data/lib/velopayments/models/challenge2.rb +285 -0
  208. data/lib/velopayments/models/company.rb +312 -0
  209. data/lib/velopayments/models/company2.rb +312 -0
  210. data/lib/velopayments/models/company_response.rb +22 -7
  211. data/lib/velopayments/models/company_v1.rb +28 -12
  212. data/lib/velopayments/models/create_funding_account_request_v2.rb +441 -0
  213. data/lib/velopayments/models/create_individual.rb +21 -7
  214. data/lib/velopayments/models/create_individual2.rb +22 -8
  215. data/lib/velopayments/models/create_individual2_name.rb +351 -0
  216. data/lib/velopayments/models/create_payee.rb +24 -8
  217. data/lib/velopayments/models/create_payee2.rb +27 -11
  218. data/lib/velopayments/models/create_payee_address.rb +26 -7
  219. data/lib/velopayments/models/create_payee_address2.rb +26 -7
  220. data/lib/velopayments/models/create_payees_csv_request.rb +21 -7
  221. data/lib/velopayments/models/create_payees_csv_request2.rb +35 -15
  222. data/lib/velopayments/models/create_payees_csv_response.rb +22 -8
  223. data/lib/velopayments/models/create_payees_csv_response2.rb +22 -8
  224. data/lib/velopayments/models/create_payees_csv_response_rejected_csv_rows.rb +228 -0
  225. data/lib/velopayments/models/create_payees_request.rb +21 -7
  226. data/lib/velopayments/models/create_payees_request2.rb +21 -7
  227. data/lib/velopayments/models/create_payment_channel.rb +21 -7
  228. data/lib/velopayments/models/create_payment_channel2.rb +21 -7
  229. data/lib/velopayments/models/create_payor_link_request.rb +21 -7
  230. data/lib/velopayments/models/{create_payout_request.rb → create_payout_request_v3.rb} +40 -11
  231. data/lib/velopayments/models/create_webhook_request.rb +315 -0
  232. data/lib/velopayments/models/error.rb +23 -9
  233. data/lib/velopayments/models/error_response.rb +23 -7
  234. data/lib/velopayments/models/failed_submission.rb +22 -8
  235. data/lib/velopayments/models/failed_submission2.rb +219 -0
  236. data/lib/velopayments/models/funding_account_response.rb +116 -11
  237. data/lib/velopayments/models/{create_funding_account_request.rb → funding_account_response2.rb} +117 -96
  238. data/lib/velopayments/models/{token_type.rb → funding_account_type.rb} +8 -9
  239. data/lib/velopayments/models/funding_audit.rb +34 -18
  240. data/lib/velopayments/models/funding_event.rb +22 -8
  241. data/lib/velopayments/models/funding_event_type.rb +3 -2
  242. data/lib/velopayments/models/funding_payor_status_audit_response.rb +58 -8
  243. data/lib/velopayments/models/funding_request_v1.rb +21 -7
  244. data/lib/velopayments/models/funding_request_v2.rb +21 -7
  245. data/lib/velopayments/models/funding_request_v3.rb +259 -0
  246. data/lib/velopayments/models/fx_summary_v3.rb +22 -8
  247. data/lib/velopayments/models/fx_summary_v4.rb +22 -8
  248. data/lib/velopayments/models/get_fundings_response.rb +22 -15
  249. data/lib/velopayments/models/{get_fundings_response_all_of.rb → get_fundings_response_links.rb} +40 -19
  250. data/lib/velopayments/models/{payee_response2.rb → get_payee_list_response.rb} +100 -112
  251. data/lib/velopayments/models/get_payee_list_response_company.rb +268 -0
  252. data/lib/velopayments/models/{user_response2_roles.rb → get_payee_list_response_individual.rb} +25 -11
  253. data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +21 -7
  254. data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +21 -7
  255. data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +24 -10
  256. data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +22 -8
  257. data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +36 -12
  258. data/lib/velopayments/models/get_payout_statistics.rb +21 -7
  259. data/lib/velopayments/models/get_payouts_response_v3.rb +21 -7
  260. data/lib/velopayments/models/get_payouts_response_v3_links.rb +21 -7
  261. data/lib/velopayments/models/get_payouts_response_v3_page.rb +21 -7
  262. data/lib/velopayments/models/get_payouts_response_v4.rb +22 -8
  263. data/lib/velopayments/models/individual.rb +264 -0
  264. data/lib/velopayments/models/individual2.rb +264 -0
  265. data/lib/velopayments/models/individual_response.rb +21 -7
  266. data/lib/velopayments/models/individual_v1.rb +45 -7
  267. data/lib/velopayments/models/individual_v1_name.rb +21 -7
  268. data/lib/velopayments/models/inline_response400.rb +225 -0
  269. data/lib/velopayments/models/inline_response400_errors.rb +240 -0
  270. data/lib/velopayments/models/inline_response401.rb +225 -0
  271. data/lib/velopayments/models/inline_response401_errors.rb +240 -0
  272. data/lib/velopayments/models/inline_response403.rb +225 -0
  273. data/lib/velopayments/models/inline_response403_errors.rb +240 -0
  274. data/lib/velopayments/models/inline_response404.rb +225 -0
  275. data/lib/velopayments/models/inline_response404_errors.rb +240 -0
  276. data/lib/velopayments/models/inline_response409.rb +225 -0
  277. data/lib/velopayments/models/inline_response409_errors.rb +240 -0
  278. data/lib/velopayments/models/inline_response412.rb +225 -0
  279. data/lib/velopayments/models/inline_response412_errors.rb +240 -0
  280. data/lib/velopayments/models/invitation_status.rb +3 -2
  281. data/lib/velopayments/models/{payment_status.rb → invitation_status2.rb} +8 -12
  282. data/lib/velopayments/models/invitation_status_response.rb +21 -7
  283. data/lib/velopayments/models/invite_payee_request.rb +21 -7
  284. data/lib/velopayments/models/{register_mfa_response.rb → invite_payee_request2.rb} +36 -28
  285. data/lib/velopayments/models/invite_user_request.rb +34 -17
  286. data/lib/velopayments/models/kyc_state.rb +3 -2
  287. data/lib/velopayments/models/language.rb +3 -2
  288. data/lib/velopayments/models/language2.rb +46 -0
  289. data/lib/velopayments/models/link_for_response.rb +21 -7
  290. data/lib/velopayments/models/list_funding_accounts_response.rb +21 -7
  291. data/lib/velopayments/models/list_funding_accounts_response2.rb +233 -0
  292. data/lib/velopayments/models/{list_payments_response.rb → list_payments_response_v3.rb} +25 -11
  293. data/lib/velopayments/models/{list_payments_response_page.rb → list_payments_response_v3_page.rb} +24 -10
  294. data/lib/velopayments/models/list_payments_response_v4.rb +22 -8
  295. data/lib/velopayments/models/list_source_account_response.rb +21 -7
  296. data/lib/velopayments/models/list_source_account_response_links.rb +21 -7
  297. data/lib/velopayments/models/list_source_account_response_page.rb +21 -7
  298. data/lib/velopayments/models/list_source_account_response_v2.rb +22 -8
  299. data/lib/velopayments/models/list_source_account_response_v2_links.rb +219 -0
  300. data/lib/velopayments/models/list_source_account_response_v3.rb +233 -0
  301. data/lib/velopayments/models/list_source_account_response_v3_links.rb +219 -0
  302. data/lib/velopayments/models/location_type.rb +40 -0
  303. data/lib/velopayments/models/marketing_opt_in.rb +22 -8
  304. data/lib/velopayments/models/mfa_details.rb +22 -7
  305. data/lib/velopayments/models/mfa_type.rb +3 -2
  306. data/lib/velopayments/models/name.rb +333 -0
  307. data/lib/velopayments/models/notifications.rb +21 -7
  308. data/lib/velopayments/models/{paged_response.rb → notifications2.rb} +31 -28
  309. data/lib/velopayments/models/ofac_status.rb +3 -2
  310. data/lib/velopayments/models/{otp_type.rb → ofac_status2.rb} +9 -6
  311. data/lib/velopayments/models/onboarded_status.rb +3 -2
  312. data/lib/velopayments/models/onboarded_status2.rb +39 -0
  313. data/lib/velopayments/models/page_for_response.rb +21 -7
  314. data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +21 -7
  315. data/lib/velopayments/models/paged_payee_invitation_status_response.rb +22 -8
  316. data/lib/velopayments/models/paged_payee_invitation_status_response2.rb +233 -0
  317. data/lib/velopayments/models/{paged_response_page.rb → paged_payee_invitation_status_response_page.rb} +24 -10
  318. data/lib/velopayments/models/paged_payee_response.rb +21 -7
  319. data/lib/velopayments/models/paged_payee_response2.rb +22 -8
  320. data/lib/velopayments/models/paged_payee_response2_summary.rb +21 -7
  321. data/lib/velopayments/models/paged_payee_response_links.rb +21 -7
  322. data/lib/velopayments/models/paged_payee_response_page.rb +21 -7
  323. data/lib/velopayments/models/paged_payee_response_summary.rb +21 -7
  324. data/lib/velopayments/models/paged_payments_response_v3.rb +233 -0
  325. data/lib/velopayments/models/paged_user_response.rb +21 -7
  326. data/lib/velopayments/models/paged_user_response_links.rb +21 -7
  327. data/lib/velopayments/models/paged_user_response_page.rb +21 -7
  328. data/lib/velopayments/models/password_request.rb +21 -7
  329. data/lib/velopayments/models/payee.rb +29 -9
  330. data/lib/velopayments/models/payee2.rb +460 -0
  331. data/lib/velopayments/models/payee_address.rb +26 -7
  332. data/lib/velopayments/models/payee_address2.rb +497 -0
  333. data/lib/velopayments/models/payee_delta.rb +22 -7
  334. data/lib/velopayments/models/payee_delta2.rb +303 -0
  335. data/lib/velopayments/models/payee_delta_response.rb +21 -7
  336. data/lib/velopayments/models/payee_delta_response2.rb +233 -0
  337. data/lib/velopayments/models/payee_delta_response2_links.rb +219 -0
  338. data/lib/velopayments/models/payee_delta_response_links.rb +21 -7
  339. data/lib/velopayments/models/payee_delta_response_page.rb +21 -7
  340. data/lib/velopayments/models/payee_detail_response.rb +475 -0
  341. data/lib/velopayments/models/payee_detail_response2.rb +475 -0
  342. data/lib/velopayments/models/payee_invitation_status.rb +21 -7
  343. data/lib/velopayments/models/payee_invitation_status_response.rb +56 -8
  344. data/lib/velopayments/models/payee_invitation_status_response2.rb +272 -0
  345. data/lib/velopayments/models/payee_payment_channel.rb +68 -43
  346. data/lib/velopayments/models/payee_payment_channel2.rb +455 -0
  347. data/lib/velopayments/models/payee_payor_ref.rb +21 -7
  348. data/lib/velopayments/models/payee_payor_ref2.rb +45 -11
  349. data/lib/velopayments/models/payee_payor_ref_v2.rb +282 -0
  350. data/lib/velopayments/models/payee_payor_ref_v3.rb +248 -0
  351. data/lib/velopayments/models/payee_response.rb +29 -9
  352. data/lib/velopayments/models/payee_response_v2.rb +475 -0
  353. data/lib/velopayments/models/payee_type.rb +3 -2
  354. data/lib/velopayments/models/{mfa_status.rb → payee_type2.rb} +8 -7
  355. data/lib/velopayments/models/payee_user_self_update_request.rb +365 -0
  356. data/lib/velopayments/models/payment_audit_currency_v3.rb +3 -2
  357. data/lib/velopayments/models/payment_audit_currency_v4.rb +3 -2
  358. data/lib/velopayments/models/payment_channel_country.rb +33 -7
  359. data/lib/velopayments/models/payment_channel_rule.rb +48 -7
  360. data/lib/velopayments/models/payment_channel_rules_response.rb +21 -7
  361. data/lib/velopayments/models/payment_delta.rb +28 -8
  362. data/lib/velopayments/models/payment_delta_response.rb +22 -8
  363. data/lib/velopayments/models/payment_delta_response_v4.rb +233 -0
  364. data/lib/velopayments/models/payment_delta_v4.rb +289 -0
  365. data/lib/velopayments/models/payment_event_response_v3.rb +22 -8
  366. data/lib/velopayments/models/payment_event_response_v4.rb +22 -8
  367. data/lib/velopayments/models/{payment_instruction.rb → payment_instruction_v3.rb} +73 -53
  368. data/lib/velopayments/models/payment_rails.rb +3 -2
  369. data/lib/velopayments/models/payment_response_v3.rb +22 -8
  370. data/lib/velopayments/models/payment_response_v4.rb +50 -9
  371. data/lib/velopayments/models/payment_response_v4_payout.rb +21 -7
  372. data/lib/velopayments/models/payment_v3.rb +363 -0
  373. data/lib/velopayments/models/payor_address.rb +26 -7
  374. data/lib/velopayments/models/payor_address_v2.rb +26 -7
  375. data/lib/velopayments/models/payor_aml_transaction_v3.rb +21 -7
  376. data/lib/velopayments/models/payor_aml_transaction_v4.rb +21 -7
  377. data/lib/velopayments/models/payor_branding_response.rb +24 -7
  378. data/lib/velopayments/models/payor_create_api_key_request.rb +22 -7
  379. data/lib/velopayments/models/payor_create_api_key_response.rb +21 -7
  380. data/lib/velopayments/models/payor_create_application_request.rb +22 -7
  381. data/lib/velopayments/models/payor_email_opt_out_request.rb +21 -7
  382. data/lib/velopayments/models/payor_links_response.rb +21 -7
  383. data/lib/velopayments/models/payor_links_response_links.rb +21 -7
  384. data/lib/velopayments/models/payor_links_response_payors.rb +21 -7
  385. data/lib/velopayments/models/payor_logo_request.rb +21 -7
  386. data/lib/velopayments/models/payor_v1.rb +34 -11
  387. data/lib/velopayments/models/payor_v2.rb +44 -11
  388. data/lib/velopayments/models/payout_company_v3.rb +215 -0
  389. data/lib/velopayments/models/{generate_otp_request.rb → payout_individual_v3.rb} +34 -20
  390. data/lib/velopayments/models/payout_name_v3.rb +229 -0
  391. data/lib/velopayments/models/{validate_otp_request.rb → payout_payee_v3.rb} +53 -49
  392. data/lib/velopayments/models/payout_payor_v4.rb +21 -7
  393. data/lib/velopayments/models/payout_principal_v4.rb +21 -7
  394. data/lib/velopayments/models/payout_status_v3.rb +3 -2
  395. data/lib/velopayments/models/payout_status_v4.rb +3 -2
  396. data/lib/velopayments/models/payout_summary_audit_v3.rb +21 -7
  397. data/lib/velopayments/models/payout_summary_audit_v4.rb +33 -10
  398. data/lib/velopayments/models/{payout_summary_response.rb → payout_summary_response_v3.rb} +43 -15
  399. data/lib/velopayments/models/payout_type_v4.rb +3 -2
  400. data/lib/velopayments/models/{supported_currency.rb → ping_response.rb} +37 -24
  401. data/lib/velopayments/models/query_batch_response.rb +21 -7
  402. data/lib/velopayments/models/query_batch_response2.rb +274 -0
  403. data/lib/velopayments/models/{quote_fx_summary.rb → quote_fx_summary_v3.rb} +50 -12
  404. data/lib/velopayments/models/{quote_response.rb → quote_response_v3.rb} +25 -11
  405. data/lib/velopayments/models/{region.rb → region_v2.rb} +24 -10
  406. data/lib/velopayments/models/register_sms_request.rb +24 -10
  407. data/lib/velopayments/models/{rejected_payment.rb → rejected_payment_v3.rb} +36 -10
  408. data/lib/velopayments/models/resend_token_request.rb +23 -8
  409. data/lib/velopayments/models/reset_password_request.rb +21 -7
  410. data/lib/velopayments/models/role.rb +21 -7
  411. data/lib/velopayments/models/{email_update_request.rb → role_update_request.rb} +39 -22
  412. data/lib/velopayments/models/self_mfa_type_unregister_request.rb +21 -7
  413. data/lib/velopayments/models/self_update_password_request.rb +21 -7
  414. data/lib/velopayments/models/set_notifications_request.rb +21 -7
  415. data/lib/velopayments/models/source_account_response.rb +36 -11
  416. data/lib/velopayments/models/source_account_response_v2.rb +39 -14
  417. data/lib/velopayments/models/source_account_response_v3.rb +437 -0
  418. data/lib/velopayments/models/source_account_summary_v3.rb +21 -7
  419. data/lib/velopayments/models/source_account_summary_v4.rb +21 -7
  420. data/lib/velopayments/models/source_account_type.rb +37 -0
  421. data/lib/velopayments/models/{source_account.rb → source_account_v3.rb} +64 -10
  422. data/lib/velopayments/models/supported_countries_response.rb +21 -7
  423. data/lib/velopayments/models/{supported_countries_response2.rb → supported_countries_response_v2.rb} +24 -10
  424. data/lib/velopayments/models/supported_country.rb +52 -36
  425. data/lib/velopayments/models/supported_country_v2.rb +56 -38
  426. data/lib/velopayments/models/{supported_currency_response.rb → supported_currency_response_v2.rb} +25 -11
  427. data/lib/velopayments/models/supported_currency_v2.rb +256 -0
  428. data/lib/velopayments/models/transfer_request.rb +21 -7
  429. data/lib/velopayments/models/transfer_request2.rb +301 -0
  430. data/lib/velopayments/models/transmission_type.rb +38 -0
  431. data/lib/velopayments/models/transmission_types.rb +246 -0
  432. data/lib/velopayments/models/{validate_mfa_request.rb → transmission_types2.rb} +61 -45
  433. data/lib/velopayments/models/unregister_mfa_request.rb +25 -10
  434. data/lib/velopayments/models/update_payee_details_request.rb +266 -0
  435. data/lib/velopayments/models/update_payee_details_request2.rb +266 -0
  436. data/lib/velopayments/models/update_remote_id_request.rb +21 -7
  437. data/lib/velopayments/models/update_webhook_request.rb +288 -0
  438. data/lib/velopayments/models/{user_response2.rb → user_details_update_request.rb} +97 -181
  439. data/lib/velopayments/models/user_info.rb +21 -7
  440. data/lib/velopayments/models/user_response.rb +32 -17
  441. data/lib/velopayments/models/user_status.rb +3 -2
  442. data/lib/velopayments/models/user_type.rb +3 -2
  443. data/lib/velopayments/models/user_type2.rb +3 -2
  444. data/lib/velopayments/models/validate_password_response.rb +21 -7
  445. data/lib/velopayments/models/watchlist_status.rb +3 -2
  446. data/lib/velopayments/models/watchlist_status2.rb +40 -0
  447. data/lib/velopayments/models/{currency_type.rb → webhook_response.rb} +66 -49
  448. data/lib/velopayments/models/webhooks_response.rb +233 -0
  449. data/lib/velopayments/models/withdraw_payment_request.rb +244 -0
  450. data/lib/velopayments/version.rb +3 -3
  451. data/oa3-config.json +1 -1
  452. data/spec/api/countries_api_spec.rb +13 -13
  453. data/spec/api/currencies_api_spec.rb +5 -5
  454. data/spec/api/funding_manager_api_spec.rb +97 -20
  455. data/spec/api/{default_api_spec.rb → funding_manager_private_api_spec.rb} +11 -11
  456. data/spec/api/login_api_spec.rb +3 -2
  457. data/spec/api/payee_invitation_api_spec.rb +113 -31
  458. data/spec/api/payees_api_spec.rb +186 -16
  459. data/spec/api/payment_audit_service_api_spec.rb +74 -20
  460. data/spec/api/payors_api_spec.rb +9 -9
  461. data/spec/api/payors_private_api_spec.rb +2 -2
  462. data/spec/api/payout_service_api_spec.rb +127 -0
  463. data/spec/api/tokens_api_spec.rb +2 -131
  464. data/spec/api/users_api_spec.rb +43 -17
  465. data/spec/api/webhooks_api_spec.rb +96 -0
  466. data/spec/api_client_spec.rb +3 -3
  467. data/spec/configuration_spec.rb +2 -2
  468. data/spec/models/{accepted_payment_spec.rb → accepted_payment_v3_spec.rb} +8 -8
  469. data/spec/models/access_token_response_spec.rb +2 -2
  470. data/spec/models/access_token_validation_request_spec.rb +2 -2
  471. data/spec/models/auth_response_spec.rb +2 -2
  472. data/spec/models/auto_top_up_config2_spec.rb +59 -0
  473. data/spec/models/auto_top_up_config_spec.rb +2 -2
  474. data/spec/models/{paged_response_spec.rb → challenge2_spec.rb} +10 -10
  475. data/spec/models/challenge_spec.rb +2 -2
  476. data/spec/models/company2_spec.rb +53 -0
  477. data/spec/models/company_response_spec.rb +2 -2
  478. data/spec/models/company_spec.rb +53 -0
  479. data/spec/models/company_v1_spec.rb +2 -2
  480. data/spec/models/create_funding_account_request_v2_spec.rb +81 -0
  481. data/spec/models/create_individual2_name_spec.rb +59 -0
  482. data/spec/models/create_individual2_spec.rb +2 -2
  483. data/spec/models/create_individual_spec.rb +2 -2
  484. data/spec/models/create_payee2_spec.rb +2 -2
  485. data/spec/models/create_payee_address2_spec.rb +2 -2
  486. data/spec/models/create_payee_address_spec.rb +2 -2
  487. data/spec/models/create_payee_spec.rb +2 -2
  488. data/spec/models/create_payees_csv_request2_spec.rb +2 -2
  489. data/spec/models/create_payees_csv_request_spec.rb +2 -2
  490. data/spec/models/create_payees_csv_response2_spec.rb +2 -2
  491. data/spec/models/create_payees_csv_response_rejected_csv_rows_spec.rb +53 -0
  492. data/spec/models/create_payees_csv_response_spec.rb +2 -2
  493. data/spec/models/create_payees_request2_spec.rb +2 -2
  494. data/spec/models/create_payees_request_spec.rb +2 -2
  495. data/spec/models/create_payment_channel2_spec.rb +2 -2
  496. data/spec/models/create_payment_channel_spec.rb +2 -2
  497. data/spec/models/create_payor_link_request_spec.rb +2 -2
  498. data/spec/models/{create_payout_request_spec.rb → create_payout_request_v3_spec.rb} +8 -8
  499. data/spec/models/{create_funding_account_request_spec.rb → create_webhook_request_spec.rb} +12 -12
  500. data/spec/models/error_response_spec.rb +2 -2
  501. data/spec/models/error_spec.rb +3 -3
  502. data/spec/models/failed_submission2_spec.rb +47 -0
  503. data/spec/models/failed_submission_spec.rb +2 -2
  504. data/spec/models/funding_account_response2_spec.rb +95 -0
  505. data/spec/models/funding_account_response_spec.rb +26 -2
  506. data/spec/models/funding_account_type_spec.rb +35 -0
  507. data/spec/models/funding_audit_spec.rb +8 -8
  508. data/spec/models/funding_event_spec.rb +2 -2
  509. data/spec/models/funding_event_type_spec.rb +2 -2
  510. data/spec/models/funding_payor_status_audit_response_spec.rb +2 -2
  511. data/spec/models/funding_request_v1_spec.rb +2 -2
  512. data/spec/models/funding_request_v2_spec.rb +2 -2
  513. data/spec/models/funding_request_v3_spec.rb +47 -0
  514. data/spec/models/fx_summary_v3_spec.rb +2 -2
  515. data/spec/models/fx_summary_v4_spec.rb +2 -2
  516. data/spec/models/{register_mfa_response_spec.rb → get_fundings_response_links_spec.rb} +10 -10
  517. data/spec/models/get_fundings_response_spec.rb +2 -2
  518. data/spec/models/get_payee_list_response_company_spec.rb +47 -0
  519. data/spec/models/{get_fundings_response_all_of_spec.rb → get_payee_list_response_individual_spec.rb} +9 -9
  520. data/spec/models/get_payee_list_response_spec.rb +137 -0
  521. data/spec/models/get_payments_for_payout_response_v3_page_spec.rb +2 -2
  522. data/spec/models/get_payments_for_payout_response_v3_spec.rb +2 -2
  523. data/spec/models/get_payments_for_payout_response_v3_summary_spec.rb +2 -2
  524. data/spec/models/get_payments_for_payout_response_v4_spec.rb +2 -2
  525. data/spec/models/get_payments_for_payout_response_v4_summary_spec.rb +8 -2
  526. data/spec/models/get_payout_statistics_spec.rb +2 -2
  527. data/spec/models/get_payouts_response_v3_links_spec.rb +2 -2
  528. data/spec/models/get_payouts_response_v3_page_spec.rb +2 -2
  529. data/spec/models/get_payouts_response_v3_spec.rb +2 -2
  530. data/spec/models/get_payouts_response_v4_spec.rb +2 -2
  531. data/spec/models/individual2_spec.rb +53 -0
  532. data/spec/models/individual_response_spec.rb +2 -2
  533. data/spec/models/individual_spec.rb +53 -0
  534. data/spec/models/individual_v1_name_spec.rb +2 -2
  535. data/spec/models/individual_v1_spec.rb +2 -2
  536. data/spec/models/inline_response400_errors_spec.rb +59 -0
  537. data/spec/models/inline_response400_spec.rb +47 -0
  538. data/spec/models/inline_response401_errors_spec.rb +59 -0
  539. data/spec/models/inline_response401_spec.rb +47 -0
  540. data/spec/models/inline_response403_errors_spec.rb +59 -0
  541. data/spec/models/inline_response403_spec.rb +47 -0
  542. data/spec/models/inline_response404_errors_spec.rb +59 -0
  543. data/spec/models/inline_response404_spec.rb +47 -0
  544. data/spec/models/inline_response409_errors_spec.rb +59 -0
  545. data/spec/models/inline_response409_spec.rb +47 -0
  546. data/spec/models/inline_response412_errors_spec.rb +59 -0
  547. data/spec/models/inline_response412_spec.rb +47 -0
  548. data/spec/models/invitation_status2_spec.rb +35 -0
  549. data/spec/models/invitation_status_response_spec.rb +2 -2
  550. data/spec/models/invitation_status_spec.rb +2 -2
  551. data/spec/models/{generate_otp_request_spec.rb → invite_payee_request2_spec.rb} +9 -9
  552. data/spec/models/invite_payee_request_spec.rb +2 -2
  553. data/spec/models/invite_user_request_spec.rb +2 -2
  554. data/spec/models/kyc_state_spec.rb +2 -2
  555. data/spec/models/{otp_type_spec.rb → language2_spec.rb} +8 -8
  556. data/spec/models/language_spec.rb +2 -2
  557. data/spec/models/link_for_response_spec.rb +2 -2
  558. data/spec/models/list_funding_accounts_response2_spec.rb +53 -0
  559. data/spec/models/list_funding_accounts_response_spec.rb +2 -2
  560. data/spec/models/{list_payments_response_page_spec.rb → list_payments_response_v3_page_spec.rb} +8 -8
  561. data/spec/models/{list_payments_response_spec.rb → list_payments_response_v3_spec.rb} +8 -8
  562. data/spec/models/list_payments_response_v4_spec.rb +2 -2
  563. data/spec/models/list_source_account_response_links_spec.rb +2 -2
  564. data/spec/models/list_source_account_response_page_spec.rb +2 -2
  565. data/spec/models/list_source_account_response_spec.rb +2 -2
  566. data/spec/models/list_source_account_response_v2_links_spec.rb +47 -0
  567. data/spec/models/list_source_account_response_v2_spec.rb +2 -2
  568. data/spec/models/list_source_account_response_v3_links_spec.rb +47 -0
  569. data/spec/models/list_source_account_response_v3_spec.rb +53 -0
  570. data/spec/models/{payment_status_spec.rb → location_type_spec.rb} +8 -8
  571. data/spec/models/marketing_opt_in_spec.rb +2 -2
  572. data/spec/models/mfa_details_spec.rb +2 -2
  573. data/spec/models/mfa_type_spec.rb +2 -2
  574. data/spec/models/name_spec.rb +59 -0
  575. data/spec/models/{currency_type_spec.rb → notifications2_spec.rb} +9 -9
  576. data/spec/models/notifications_spec.rb +2 -2
  577. data/spec/models/{mfa_status_spec.rb → ofac_status2_spec.rb} +8 -8
  578. data/spec/models/ofac_status_spec.rb +2 -2
  579. data/spec/models/onboarded_status2_spec.rb +35 -0
  580. data/spec/models/onboarded_status_spec.rb +2 -2
  581. data/spec/models/page_for_response_spec.rb +2 -2
  582. data/spec/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response_spec.rb +2 -2
  583. data/spec/models/paged_payee_invitation_status_response2_spec.rb +53 -0
  584. data/spec/models/{paged_response_page_spec.rb → paged_payee_invitation_status_response_page_spec.rb} +8 -8
  585. data/spec/models/paged_payee_invitation_status_response_spec.rb +2 -2
  586. data/spec/models/paged_payee_response2_spec.rb +2 -2
  587. data/spec/models/paged_payee_response2_summary_spec.rb +2 -2
  588. data/spec/models/paged_payee_response_links_spec.rb +2 -2
  589. data/spec/models/paged_payee_response_page_spec.rb +2 -2
  590. data/spec/models/paged_payee_response_spec.rb +2 -2
  591. data/spec/models/paged_payee_response_summary_spec.rb +2 -2
  592. data/spec/models/paged_payments_response_v3_spec.rb +53 -0
  593. data/spec/models/paged_user_response_links_spec.rb +2 -2
  594. data/spec/models/paged_user_response_page_spec.rb +2 -2
  595. data/spec/models/paged_user_response_spec.rb +2 -2
  596. data/spec/models/password_request_spec.rb +2 -2
  597. data/spec/models/{payee_response2_spec.rb → payee2_spec.rb} +20 -10
  598. data/spec/models/payee_address2_spec.rb +83 -0
  599. data/spec/models/payee_address_spec.rb +2 -2
  600. data/spec/models/payee_delta2_spec.rb +77 -0
  601. data/spec/models/payee_delta_response2_links_spec.rb +47 -0
  602. data/spec/models/payee_delta_response2_spec.rb +53 -0
  603. data/spec/models/payee_delta_response_links_spec.rb +2 -2
  604. data/spec/models/payee_delta_response_page_spec.rb +2 -2
  605. data/spec/models/payee_delta_response_spec.rb +2 -2
  606. data/spec/models/payee_delta_spec.rb +2 -2
  607. data/spec/models/payee_detail_response2_spec.rb +209 -0
  608. data/spec/models/payee_detail_response_spec.rb +209 -0
  609. data/spec/models/payee_invitation_status_response2_spec.rb +57 -0
  610. data/spec/models/payee_invitation_status_response_spec.rb +6 -2
  611. data/spec/models/payee_invitation_status_spec.rb +2 -2
  612. data/spec/models/payee_payment_channel2_spec.rb +81 -0
  613. data/spec/models/payee_payment_channel_spec.rb +3 -3
  614. data/spec/models/payee_payor_ref2_spec.rb +14 -2
  615. data/spec/models/payee_payor_ref_spec.rb +2 -2
  616. data/spec/models/payee_payor_ref_v2_spec.rb +69 -0
  617. data/spec/models/payee_payor_ref_v3_spec.rb +65 -0
  618. data/spec/models/payee_response_spec.rb +2 -2
  619. data/spec/models/payee_response_v2_spec.rb +209 -0
  620. data/spec/models/payee_spec.rb +2 -2
  621. data/spec/models/{token_type_spec.rb → payee_type2_spec.rb} +8 -8
  622. data/spec/models/payee_type_spec.rb +2 -2
  623. data/spec/models/payee_user_self_update_request_spec.rb +71 -0
  624. data/spec/models/payment_audit_currency_v3_spec.rb +2 -2
  625. data/spec/models/payment_audit_currency_v4_spec.rb +2 -2
  626. data/spec/models/payment_channel_country_spec.rb +2 -2
  627. data/spec/models/payment_channel_rule_spec.rb +2 -2
  628. data/spec/models/payment_channel_rules_response_spec.rb +2 -2
  629. data/spec/models/payment_delta_response_spec.rb +2 -2
  630. data/spec/models/payment_delta_response_v4_spec.rb +53 -0
  631. data/spec/models/payment_delta_spec.rb +2 -2
  632. data/spec/models/payment_delta_v4_spec.rb +83 -0
  633. data/spec/models/payment_event_response_v3_spec.rb +2 -2
  634. data/spec/models/payment_event_response_v4_spec.rb +2 -2
  635. data/spec/models/{payment_instruction_spec.rb → payment_instruction_v3_spec.rb} +14 -12
  636. data/spec/models/payment_rails_spec.rb +2 -2
  637. data/spec/models/payment_response_v3_spec.rb +2 -2
  638. data/spec/models/payment_response_v4_payout_spec.rb +2 -2
  639. data/spec/models/payment_response_v4_spec.rb +20 -2
  640. data/spec/models/payment_v3_spec.rb +105 -0
  641. data/spec/models/payor_address_spec.rb +2 -2
  642. data/spec/models/payor_address_v2_spec.rb +2 -2
  643. data/spec/models/payor_aml_transaction_v3_spec.rb +2 -2
  644. data/spec/models/payor_aml_transaction_v4_spec.rb +2 -2
  645. data/spec/models/payor_branding_response_spec.rb +2 -2
  646. data/spec/models/payor_create_api_key_request_spec.rb +2 -2
  647. data/spec/models/payor_create_api_key_response_spec.rb +2 -2
  648. data/spec/models/payor_create_application_request_spec.rb +2 -2
  649. data/spec/models/payor_email_opt_out_request_spec.rb +2 -2
  650. data/spec/models/payor_links_response_links_spec.rb +2 -2
  651. data/spec/models/payor_links_response_payors_spec.rb +2 -2
  652. data/spec/models/payor_links_response_spec.rb +2 -2
  653. data/spec/models/payor_logo_request_spec.rb +2 -2
  654. data/spec/models/payor_v1_spec.rb +8 -2
  655. data/spec/models/payor_v2_spec.rb +14 -2
  656. data/spec/models/{validate_mfa_request_spec.rb → payout_company_v3_spec.rb} +9 -9
  657. data/spec/models/{user_response2_roles_spec.rb → payout_individual_v3_spec.rb} +8 -8
  658. data/spec/models/payout_name_v3_spec.rb +47 -0
  659. data/spec/models/payout_payee_v3_spec.rb +53 -0
  660. data/spec/models/payout_payor_v4_spec.rb +2 -2
  661. data/spec/models/payout_principal_v4_spec.rb +2 -2
  662. data/spec/models/payout_status_v3_spec.rb +2 -2
  663. data/spec/models/payout_status_v4_spec.rb +2 -2
  664. data/spec/models/payout_summary_audit_v3_spec.rb +2 -2
  665. data/spec/models/payout_summary_audit_v4_spec.rb +8 -2
  666. data/spec/models/{payout_summary_response_spec.rb → payout_summary_response_v3_spec.rb} +14 -8
  667. data/spec/models/payout_type_v4_spec.rb +2 -2
  668. data/spec/models/ping_response_spec.rb +47 -0
  669. data/spec/models/query_batch_response2_spec.rb +63 -0
  670. data/spec/models/query_batch_response_spec.rb +2 -2
  671. data/spec/models/{quote_fx_summary_spec.rb → quote_fx_summary_v3_spec.rb} +8 -8
  672. data/spec/models/{quote_response_spec.rb → quote_response_v3_spec.rb} +8 -8
  673. data/spec/models/{region_spec.rb → region_v2_spec.rb} +8 -8
  674. data/spec/models/register_sms_request_spec.rb +2 -2
  675. data/spec/models/{rejected_payment_spec.rb → rejected_payment_v3_spec.rb} +8 -8
  676. data/spec/models/resend_token_request_spec.rb +2 -2
  677. data/spec/models/reset_password_request_spec.rb +2 -2
  678. data/spec/models/role_spec.rb +2 -2
  679. data/spec/models/{email_update_request_spec.rb → role_update_request_spec.rb} +9 -9
  680. data/spec/models/self_mfa_type_unregister_request_spec.rb +2 -2
  681. data/spec/models/self_update_password_request_spec.rb +2 -2
  682. data/spec/models/set_notifications_request_spec.rb +2 -2
  683. data/spec/models/source_account_response_spec.rb +8 -2
  684. data/spec/models/source_account_response_v2_spec.rb +8 -2
  685. data/spec/models/{user_response2_spec.rb → source_account_response_v3_spec.rb} +30 -32
  686. data/spec/models/source_account_summary_v3_spec.rb +2 -2
  687. data/spec/models/source_account_summary_v4_spec.rb +2 -2
  688. data/spec/models/source_account_type_spec.rb +35 -0
  689. data/spec/models/{source_account_spec.rb → source_account_v3_spec.rb} +8 -8
  690. data/spec/models/supported_countries_response_spec.rb +2 -2
  691. data/spec/models/{supported_countries_response2_spec.rb → supported_countries_response_v2_spec.rb} +8 -8
  692. data/spec/models/supported_country_spec.rb +2 -10
  693. data/spec/models/supported_country_v2_spec.rb +2 -10
  694. data/spec/models/{supported_currency_response_spec.rb → supported_currency_response_v2_spec.rb} +8 -8
  695. data/spec/models/{supported_currency_spec.rb → supported_currency_v2_spec.rb} +8 -8
  696. data/spec/models/transfer_request2_spec.rb +53 -0
  697. data/spec/models/transfer_request_spec.rb +2 -2
  698. data/spec/models/transmission_type_spec.rb +35 -0
  699. data/spec/models/transmission_types2_spec.rb +53 -0
  700. data/spec/models/transmission_types_spec.rb +53 -0
  701. data/spec/models/unregister_mfa_request_spec.rb +3 -3
  702. data/spec/models/update_payee_details_request2_spec.rb +77 -0
  703. data/spec/models/update_payee_details_request_spec.rb +77 -0
  704. data/spec/models/update_remote_id_request_spec.rb +2 -2
  705. data/spec/models/update_webhook_request_spec.rb +53 -0
  706. data/spec/models/user_details_update_request_spec.rb +83 -0
  707. data/spec/models/user_info_spec.rb +2 -2
  708. data/spec/models/user_response_spec.rb +2 -2
  709. data/spec/models/user_status_spec.rb +2 -2
  710. data/spec/models/user_type2_spec.rb +2 -2
  711. data/spec/models/user_type_spec.rb +2 -2
  712. data/spec/models/validate_password_response_spec.rb +2 -2
  713. data/spec/models/watchlist_status2_spec.rb +35 -0
  714. data/spec/models/watchlist_status_spec.rb +2 -2
  715. data/spec/models/{check_token_response_spec.rb → webhook_response_spec.rb} +13 -13
  716. data/spec/models/webhooks_response_spec.rb +53 -0
  717. data/spec/models/{register_mfa_request_spec.rb → withdraw_payment_request_spec.rb} +9 -9
  718. data/spec/spec_helper.rb +2 -2
  719. data/specs/api/countries_api_spec.rb +103 -0
  720. data/{spec/api/get_payout_api_spec.rb → specs/api/currencies_api_spec.rb} +16 -15
  721. data/specs/api/funding_manager_api_spec.rb +372 -0
  722. data/{spec/api/withdraw_payout_api_spec.rb → specs/api/funding_manager_private_api_spec.rb} +14 -14
  723. data/specs/api/login_api_spec.rb +82 -0
  724. data/specs/api/payee_invitation_api_spec.rb +203 -0
  725. data/specs/api/payees_api_spec.rb +285 -0
  726. data/specs/api/payment_audit_service_api_spec.rb +468 -0
  727. data/specs/api/payors_api_spec.rb +171 -0
  728. data/{spec/api/instruct_payout_api_spec.rb → specs/api/payors_private_api_spec.rb} +14 -14
  729. data/specs/api/payout_service_api_spec.rb +127 -0
  730. data/{spec/api/quote_payout_api_spec.rb → specs/api/tokens_api_spec.rb} +16 -15
  731. data/specs/api/users_api_spec.rb +284 -0
  732. data/velopayments.gemspec +3 -4
  733. metadata +556 -322
  734. data/docs/CheckTokenResponse.md +0 -25
  735. data/docs/CreateFundingAccountRequest.md +0 -23
  736. data/docs/EmailUpdateRequest.md +0 -19
  737. data/docs/GetFundingsResponseAllOf.md +0 -17
  738. data/docs/GetPayoutApi.md +0 -61
  739. data/docs/InstructPayoutApi.md +0 -60
  740. data/docs/PagedResponse.md +0 -19
  741. data/docs/PayoutHistoryApi.md +0 -221
  742. data/docs/QuotePayoutApi.md +0 -61
  743. data/docs/QuoteResponse.md +0 -17
  744. data/docs/RegisterMFARequest.md +0 -17
  745. data/docs/RegisterMFAResponse.md +0 -19
  746. data/docs/SubmitPayoutApi.md +0 -60
  747. data/docs/SupportedCurrency.md +0 -19
  748. data/docs/SupportedCurrencyResponse.md +0 -17
  749. data/docs/UserResponse2.md +0 -45
  750. data/docs/UserResponse2Roles.md +0 -17
  751. data/docs/ValidateMFARequest.md +0 -17
  752. data/docs/ValidateOTPRequest.md +0 -17
  753. data/docs/WithdrawPayoutApi.md +0 -60
  754. data/lib/velopayments/api/get_payout_api.rb +0 -84
  755. data/lib/velopayments/api/instruct_payout_api.rb +0 -82
  756. data/lib/velopayments/api/payout_history_api.rb +0 -285
  757. data/lib/velopayments/api/quote_payout_api.rb +0 -84
  758. data/lib/velopayments/api/submit_payout_api.rb +0 -84
  759. data/lib/velopayments/api/withdraw_payout_api.rb +0 -82
  760. data/lib/velopayments/models/check_token_response.rb +0 -234
  761. data/lib/velopayments/models/register_mfa_request.rb +0 -201
  762. data/spec/api/payout_history_api_spec.rb +0 -95
  763. data/spec/api/submit_payout_api_spec.rb +0 -47
  764. data/spec/models/validate_otp_request_spec.rb +0 -41
@@ -0,0 +1,19 @@
1
+ # VeloPayments::PayeeDeltaResponse2Links
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **rel** | **String** | | [optional]
8
+ **href** | **String** | | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'VeloPayments'
14
+
15
+ instance = VeloPayments::PayeeDeltaResponse2Links.new(rel: first,
16
+ href: http://api.sandbox.velopayments.com/v3/payees/deltas?payorId=0a818933-087d-47f2-ad83-2f986ed087eb&updatedSince=2019-01-20T09:00:00+00:00&page=1&pageSize=1000)
17
+ ```
18
+
19
+
@@ -0,0 +1,73 @@
1
+ # VeloPayments::PayeeDetailResponse
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **payee_id** | **String** | | [optional] [readonly]
8
+ **payor_refs** | [**Array<PayeePayorRefV3>**](PayeePayorRefV3.md) | | [optional] [readonly]
9
+ **email** | **String** | | [optional]
10
+ **onboarded_status** | [**OnboardedStatus2**](OnboardedStatus2.md) | | [optional]
11
+ **watchlist_status** | [**WatchlistStatus**](WatchlistStatus.md) | | [optional]
12
+ **watchlist_override_expires_at_timestamp** | **Time** | | [optional]
13
+ **watchlist_override_comment** | **String** | | [optional]
14
+ **language** | [**Language2**](Language2.md) | | [optional]
15
+ **created** | **Time** | | [optional]
16
+ **country** | **String** | | [optional]
17
+ **display_name** | **String** | | [optional]
18
+ **payee_type** | [**PayeeType**](PayeeType.md) | | [optional]
19
+ **disabled** | **Boolean** | | [optional]
20
+ **disabled_comment** | **String** | | [optional]
21
+ **disabled_updated_timestamp** | **Time** | | [optional]
22
+ **address** | [**PayeeAddress2**](PayeeAddress2.md) | | [optional]
23
+ **individual** | [**Individual2**](Individual2.md) | | [optional]
24
+ **company** | [**Company2**](Company2.md) | | [optional]
25
+ **cellphone_number** | **String** | | [optional]
26
+ **watchlist_status_updated_timestamp** | **String** | | [optional] [readonly]
27
+ **grace_period_end_date** | **Date** | | [optional] [readonly]
28
+ **enhanced_kyc_completed** | **Boolean** | | [optional]
29
+ **kyc_completed_timestamp** | **String** | | [optional]
30
+ **pause_payment** | **Boolean** | | [optional]
31
+ **pause_payment_timestamp** | **String** | | [optional]
32
+ **marketing_opt_in_decision** | **Boolean** | | [optional]
33
+ **marketing_opt_in_timestamp** | **String** | | [optional]
34
+ **accept_terms_and_conditions_timestamp** | **Time** | The timestamp when the payee last accepted T&Cs | [optional] [readonly]
35
+ **challenge** | [**Challenge2**](Challenge2.md) | | [optional]
36
+
37
+ ## Code Sample
38
+
39
+ ```ruby
40
+ require 'VeloPayments'
41
+
42
+ instance = VeloPayments::PayeeDetailResponse.new(payee_id: 2aa5d7e0-2ecb-403f-8494-1865ed0454e9,
43
+ payor_refs: null,
44
+ email: bob@example.com,
45
+ onboarded_status: null,
46
+ watchlist_status: null,
47
+ watchlist_override_expires_at_timestamp: 2019-01-20T09:00Z,
48
+ watchlist_override_comment: watchlist override comment,
49
+ language: null,
50
+ created: 2019-01-20T09:00Z,
51
+ country: US,
52
+ display_name: Bob,
53
+ payee_type: null,
54
+ disabled: null,
55
+ disabled_comment: reason for disabled,
56
+ disabled_updated_timestamp: 2019-01-20T09:00Z,
57
+ address: null,
58
+ individual: null,
59
+ company: null,
60
+ cellphone_number: 1234567890,
61
+ watchlist_status_updated_timestamp: 2019-01-20T09:00:00+00:00,
62
+ grace_period_end_date: Sun Jan 20 00:00:00 GMT 2019,
63
+ enhanced_kyc_completed: null,
64
+ kyc_completed_timestamp: 2019-01-20T09:00:00+00:00,
65
+ pause_payment: null,
66
+ pause_payment_timestamp: 2019-01-20T09:00:00+00:00,
67
+ marketing_opt_in_decision: null,
68
+ marketing_opt_in_timestamp: 2019-01-20T09:00:00+00:00,
69
+ accept_terms_and_conditions_timestamp: 2019-01-20T09:00Z,
70
+ challenge: null)
71
+ ```
72
+
73
+
@@ -0,0 +1,73 @@
1
+ # VeloPayments::PayeeDetailResponse2
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **payee_id** | **String** | | [optional] [readonly]
8
+ **payor_refs** | [**Array<PayeePayorRef2>**](PayeePayorRef2.md) | | [optional] [readonly]
9
+ **email** | **String** | | [optional]
10
+ **onboarded_status** | [**OnboardedStatus2**](OnboardedStatus2.md) | | [optional]
11
+ **watchlist_status** | [**WatchlistStatus2**](WatchlistStatus2.md) | | [optional]
12
+ **watchlist_override_expires_at_timestamp** | **Time** | | [optional]
13
+ **watchlist_override_comment** | **String** | | [optional]
14
+ **language** | [**Language2**](Language2.md) | | [optional]
15
+ **created** | **Time** | | [optional]
16
+ **country** | **String** | | [optional]
17
+ **display_name** | **String** | | [optional]
18
+ **payee_type** | [**PayeeType**](PayeeType.md) | | [optional]
19
+ **disabled** | **Boolean** | | [optional]
20
+ **disabled_comment** | **String** | | [optional]
21
+ **disabled_updated_timestamp** | **Time** | | [optional]
22
+ **address** | [**PayeeAddress2**](PayeeAddress2.md) | | [optional]
23
+ **individual** | [**Individual2**](Individual2.md) | | [optional]
24
+ **company** | [**Company2**](Company2.md) | | [optional]
25
+ **cellphone_number** | **String** | | [optional]
26
+ **watchlist_status_updated_timestamp** | **String** | | [optional] [readonly]
27
+ **grace_period_end_date** | **Date** | | [optional] [readonly]
28
+ **enhanced_kyc_completed** | **Boolean** | | [optional]
29
+ **kyc_completed_timestamp** | **String** | | [optional]
30
+ **pause_payment** | **Boolean** | | [optional]
31
+ **pause_payment_timestamp** | **String** | | [optional]
32
+ **marketing_opt_in_decision** | **Boolean** | | [optional]
33
+ **marketing_opt_in_timestamp** | **String** | | [optional]
34
+ **accept_terms_and_conditions_timestamp** | **Time** | The timestamp when the payee last accepted T&Cs | [optional] [readonly]
35
+ **challenge** | [**Challenge2**](Challenge2.md) | | [optional]
36
+
37
+ ## Code Sample
38
+
39
+ ```ruby
40
+ require 'VeloPayments'
41
+
42
+ instance = VeloPayments::PayeeDetailResponse2.new(payee_id: 2aa5d7e0-2ecb-403f-8494-1865ed0454e9,
43
+ payor_refs: null,
44
+ email: bob@example.com,
45
+ onboarded_status: null,
46
+ watchlist_status: null,
47
+ watchlist_override_expires_at_timestamp: 2019-01-20T09:00Z,
48
+ watchlist_override_comment: watchlist override comment,
49
+ language: null,
50
+ created: 2019-01-20T09:00Z,
51
+ country: US,
52
+ display_name: Bob,
53
+ payee_type: null,
54
+ disabled: null,
55
+ disabled_comment: reason for disabled,
56
+ disabled_updated_timestamp: 2019-01-20T09:00Z,
57
+ address: null,
58
+ individual: null,
59
+ company: null,
60
+ cellphone_number: 1234567890,
61
+ watchlist_status_updated_timestamp: 2019-01-20T09:00:00+00:00,
62
+ grace_period_end_date: Sun Jan 20 00:00:00 GMT 2019,
63
+ enhanced_kyc_completed: null,
64
+ kyc_completed_timestamp: 2019-01-20T09:00:00+00:00,
65
+ pause_payment: null,
66
+ pause_payment_timestamp: 2019-01-20T09:00:00+00:00,
67
+ marketing_opt_in_decision: null,
68
+ marketing_opt_in_timestamp: 2019-01-20T09:00:00+00:00,
69
+ accept_terms_and_conditions_timestamp: 2019-01-20T09:00Z,
70
+ challenge: null)
71
+ ```
72
+
73
+
@@ -4,23 +4,29 @@ All URIs are relative to *https://api.sandbox.velopayments.com*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**get_payees_invitation_status**](PayeeInvitationApi.md#get_payees_invitation_status) | **GET** /v1/payees/payors/{payorId}/invitationStatus | Get Payee Invitation Status
7
+ [**get_payees_invitation_status_v1**](PayeeInvitationApi.md#get_payees_invitation_status_v1) | **GET** /v1/payees/payors/{payorId}/invitationStatus | Get Payee Invitation Status
8
8
  [**get_payees_invitation_status_v2**](PayeeInvitationApi.md#get_payees_invitation_status_v2) | **GET** /v2/payees/payors/{payorId}/invitationStatus | Get Payee Invitation Status
9
- [**resend_payee_invite**](PayeeInvitationApi.md#resend_payee_invite) | **POST** /v1/payees/{payeeId}/invite | Resend Payee Invite
10
- [**v2_create_payee**](PayeeInvitationApi.md#v2_create_payee) | **POST** /v2/payees | Intiate Payee Creation V2
11
- [**v2_query_batch_status**](PayeeInvitationApi.md#v2_query_batch_status) | **GET** /v2/payees/batch/{batchId} | Query Batch Status
12
- [**v3_create_payee**](PayeeInvitationApi.md#v3_create_payee) | **POST** /v3/payees | Intiate Payee Creation V3
13
- [**v3_query_batch_status**](PayeeInvitationApi.md#v3_query_batch_status) | **GET** /v3/payees/batch/{batchId} | Query Batch Status
9
+ [**get_payees_invitation_status_v3**](PayeeInvitationApi.md#get_payees_invitation_status_v3) | **GET** /v3/payees/payors/{payorId}/invitationStatus | Get Payee Invitation Status
10
+ [**get_payees_invitation_status_v4**](PayeeInvitationApi.md#get_payees_invitation_status_v4) | **GET** /v4/payees/payors/{payorId}/invitationStatus | Get Payee Invitation Status
11
+ [**query_batch_status_v2**](PayeeInvitationApi.md#query_batch_status_v2) | **GET** /v2/payees/batch/{batchId} | Query Batch Status
12
+ [**query_batch_status_v3**](PayeeInvitationApi.md#query_batch_status_v3) | **GET** /v3/payees/batch/{batchId} | Query Batch Status
13
+ [**query_batch_status_v4**](PayeeInvitationApi.md#query_batch_status_v4) | **GET** /v4/payees/batch/{batchId} | Query Batch Status
14
+ [**resend_payee_invite_v1**](PayeeInvitationApi.md#resend_payee_invite_v1) | **POST** /v1/payees/{payeeId}/invite | Resend Payee Invite
15
+ [**resend_payee_invite_v3**](PayeeInvitationApi.md#resend_payee_invite_v3) | **POST** /v3/payees/{payeeId}/invite | Resend Payee Invite
16
+ [**resend_payee_invite_v4**](PayeeInvitationApi.md#resend_payee_invite_v4) | **POST** /v4/payees/{payeeId}/invite | Resend Payee Invite
17
+ [**v2_create_payee**](PayeeInvitationApi.md#v2_create_payee) | **POST** /v2/payees | Initiate Payee Creation
18
+ [**v3_create_payee**](PayeeInvitationApi.md#v3_create_payee) | **POST** /v3/payees | Initiate Payee Creation
19
+ [**v4_create_payee**](PayeeInvitationApi.md#v4_create_payee) | **POST** /v4/payees | Initiate Payee Creation
14
20
 
15
21
 
16
22
 
17
- ## get_payees_invitation_status
23
+ ## get_payees_invitation_status_v1
18
24
 
19
- > InvitationStatusResponse get_payees_invitation_status(payor_id)
25
+ > InvitationStatusResponse get_payees_invitation_status_v1(payor_id)
20
26
 
21
27
  Get Payee Invitation Status
22
28
 
23
- Returns a list of payees associated with a payor, along with invitation status and grace period end date.
29
+ <p>Returns a list of payees associated with a payor, along with invitation status and grace period end date.</p> <p>Please use V3 instead</p>
24
30
 
25
31
  ### Example
26
32
 
@@ -34,14 +40,14 @@ VeloPayments.configure do |config|
34
40
  end
35
41
 
36
42
  api_instance = VeloPayments::PayeeInvitationApi.new
37
- payor_id = 'payor_id_example' # String | The account owner Payor ID
43
+ payor_id = '9ac75325-5dcd-42d5-b992-175d7e0a035e' # String | The account owner Payor ID
38
44
 
39
45
  begin
40
46
  #Get Payee Invitation Status
41
- result = api_instance.get_payees_invitation_status(payor_id)
47
+ result = api_instance.get_payees_invitation_status_v1(payor_id)
42
48
  p result
43
49
  rescue VeloPayments::ApiError => e
44
- puts "Exception when calling PayeeInvitationApi->get_payees_invitation_status: #{e}"
50
+ puts "Exception when calling PayeeInvitationApi->get_payees_invitation_status_v1: #{e}"
45
51
  end
46
52
  ```
47
53
 
@@ -72,7 +78,7 @@ Name | Type | Description | Notes
72
78
 
73
79
  Get Payee Invitation Status
74
80
 
75
- Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.
81
+ <p>Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.</p> <p>Please use V3 instead</p>
76
82
 
77
83
  ### Example
78
84
 
@@ -86,9 +92,9 @@ VeloPayments.configure do |config|
86
92
  end
87
93
 
88
94
  api_instance = VeloPayments::PayeeInvitationApi.new
89
- payor_id = 'payor_id_example' # String | The account owner Payor ID
95
+ payor_id = '9ac75325-5dcd-42d5-b992-175d7e0a035e' # String | The account owner Payor ID
90
96
  opts = {
91
- payee_id: 'payee_id_example', # String | The UUID of the payee.
97
+ payee_id: '2aa5d7e0-2ecb-403f-8494-1865ed0454e9', # String | The UUID of the payee.
92
98
  invitation_status: VeloPayments::InvitationStatus.new, # InvitationStatus | The invitation status of the payees.
93
99
  page: 1, # Integer | Page number. Default is 1.
94
100
  page_size: 25 # Integer | Page size. Default is 25. Max allowable is 100.
@@ -128,13 +134,13 @@ Name | Type | Description | Notes
128
134
  - **Accept**: application/json
129
135
 
130
136
 
131
- ## resend_payee_invite
137
+ ## get_payees_invitation_status_v3
132
138
 
133
- > InvitationStatusResponse resend_payee_invite(payee_id, invite_payee_request)
139
+ > PagedPayeeInvitationStatusResponse2 get_payees_invitation_status_v3(payor_id, opts)
134
140
 
135
- Resend Payee Invite
141
+ Get Payee Invitation Status
136
142
 
137
- Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined Any previous invites to the payee by this Payor will be invalidated
143
+ Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.
138
144
 
139
145
  ### Example
140
146
 
@@ -148,15 +154,20 @@ VeloPayments.configure do |config|
148
154
  end
149
155
 
150
156
  api_instance = VeloPayments::PayeeInvitationApi.new
151
- payee_id = 'payee_id_example' # String | The UUID of the payee.
152
- invite_payee_request = VeloPayments::InvitePayeeRequest.new # InvitePayeeRequest |
157
+ payor_id = '9ac75325-5dcd-42d5-b992-175d7e0a035e' # String | The account owner Payor ID
158
+ opts = {
159
+ payee_id: '2aa5d7e0-2ecb-403f-8494-1865ed0454e9', # String | The UUID of the payee.
160
+ invitation_status: VeloPayments::InvitationStatus.new, # InvitationStatus | The invitation status of the payees.
161
+ page: 1, # Integer | Page number. Default is 1.
162
+ page_size: 25 # Integer | Page size. Default is 25. Max allowable is 100.
163
+ }
153
164
 
154
165
  begin
155
- #Resend Payee Invite
156
- result = api_instance.resend_payee_invite(payee_id, invite_payee_request)
166
+ #Get Payee Invitation Status
167
+ result = api_instance.get_payees_invitation_status_v3(payor_id, opts)
157
168
  p result
158
169
  rescue VeloPayments::ApiError => e
159
- puts "Exception when calling PayeeInvitationApi->resend_payee_invite: #{e}"
170
+ puts "Exception when calling PayeeInvitationApi->get_payees_invitation_status_v3: #{e}"
160
171
  end
161
172
  ```
162
173
 
@@ -165,12 +176,15 @@ end
165
176
 
166
177
  Name | Type | Description | Notes
167
178
  ------------- | ------------- | ------------- | -------------
168
- **payee_id** | [**String**](.md)| The UUID of the payee. |
169
- **invite_payee_request** | [**InvitePayeeRequest**](InvitePayeeRequest.md)| |
179
+ **payor_id** | [**String**](.md)| The account owner Payor ID |
180
+ **payee_id** | [**String**](.md)| The UUID of the payee. | [optional]
181
+ **invitation_status** | [**InvitationStatus**](.md)| The invitation status of the payees. | [optional]
182
+ **page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
183
+ **page_size** | **Integer**| Page size. Default is 25. Max allowable is 100. | [optional] [default to 25]
170
184
 
171
185
  ### Return type
172
186
 
173
- [**InvitationStatusResponse**](InvitationStatusResponse.md)
187
+ [**PagedPayeeInvitationStatusResponse2**](PagedPayeeInvitationStatusResponse2.md)
174
188
 
175
189
  ### Authorization
176
190
 
@@ -178,17 +192,17 @@ Name | Type | Description | Notes
178
192
 
179
193
  ### HTTP request headers
180
194
 
181
- - **Content-Type**: application/json
195
+ - **Content-Type**: Not defined
182
196
  - **Accept**: application/json
183
197
 
184
198
 
185
- ## v2_create_payee
199
+ ## get_payees_invitation_status_v4
186
200
 
187
- > CreatePayeesCSVResponse v2_create_payee(create_payees_request)
201
+ > PagedPayeeInvitationStatusResponse2 get_payees_invitation_status_v4(payor_id, opts)
188
202
 
189
- Intiate Payee Creation V2
203
+ Get Payee Invitation Status
190
204
 
191
- Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body, 409 - if there is a duplicate remote id within the batch / if there is a duplicate email within the batch).
205
+ Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.
192
206
 
193
207
  ### Example
194
208
 
@@ -202,14 +216,20 @@ VeloPayments.configure do |config|
202
216
  end
203
217
 
204
218
  api_instance = VeloPayments::PayeeInvitationApi.new
205
- create_payees_request = VeloPayments::CreatePayeesRequest.new # CreatePayeesRequest | Post payees to create.
219
+ payor_id = '9ac75325-5dcd-42d5-b992-175d7e0a035e' # String | The account owner Payor ID
220
+ opts = {
221
+ payee_id: '2aa5d7e0-2ecb-403f-8494-1865ed0454e9', # String | The UUID of the payee.
222
+ invitation_status: VeloPayments::InvitationStatus.new, # InvitationStatus | The invitation status of the payees.
223
+ page: 1, # Integer | Page number. Default is 1.
224
+ page_size: 25 # Integer | Page size. Default is 25. Max allowable is 100.
225
+ }
206
226
 
207
227
  begin
208
- #Intiate Payee Creation V2
209
- result = api_instance.v2_create_payee(create_payees_request)
228
+ #Get Payee Invitation Status
229
+ result = api_instance.get_payees_invitation_status_v4(payor_id, opts)
210
230
  p result
211
231
  rescue VeloPayments::ApiError => e
212
- puts "Exception when calling PayeeInvitationApi->v2_create_payee: #{e}"
232
+ puts "Exception when calling PayeeInvitationApi->get_payees_invitation_status_v4: #{e}"
213
233
  end
214
234
  ```
215
235
 
@@ -218,11 +238,15 @@ end
218
238
 
219
239
  Name | Type | Description | Notes
220
240
  ------------- | ------------- | ------------- | -------------
221
- **create_payees_request** | [**CreatePayeesRequest**](CreatePayeesRequest.md)| Post payees to create. |
241
+ **payor_id** | [**String**](.md)| The account owner Payor ID |
242
+ **payee_id** | [**String**](.md)| The UUID of the payee. | [optional]
243
+ **invitation_status** | [**InvitationStatus**](.md)| The invitation status of the payees. | [optional]
244
+ **page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
245
+ **page_size** | **Integer**| Page size. Default is 25. Max allowable is 100. | [optional] [default to 25]
222
246
 
223
247
  ### Return type
224
248
 
225
- [**CreatePayeesCSVResponse**](CreatePayeesCSVResponse.md)
249
+ [**PagedPayeeInvitationStatusResponse2**](PagedPayeeInvitationStatusResponse2.md)
226
250
 
227
251
  ### Authorization
228
252
 
@@ -230,17 +254,17 @@ Name | Type | Description | Notes
230
254
 
231
255
  ### HTTP request headers
232
256
 
233
- - **Content-Type**: application/json, multipart/form-data
257
+ - **Content-Type**: Not defined
234
258
  - **Accept**: application/json
235
259
 
236
260
 
237
- ## v2_query_batch_status
261
+ ## query_batch_status_v2
238
262
 
239
- > QueryBatchResponse v2_query_batch_status(batch_id)
263
+ > QueryBatchResponse query_batch_status_v2(batch_id)
240
264
 
241
265
  Query Batch Status
242
266
 
243
- Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ).
267
+ <p>Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ).</p> <p>Please use V3 instead</p>
244
268
 
245
269
  ### Example
246
270
 
@@ -258,10 +282,10 @@ batch_id = 'batch_id_example' # String | Batch Id
258
282
 
259
283
  begin
260
284
  #Query Batch Status
261
- result = api_instance.v2_query_batch_status(batch_id)
285
+ result = api_instance.query_batch_status_v2(batch_id)
262
286
  p result
263
287
  rescue VeloPayments::ApiError => e
264
- puts "Exception when calling PayeeInvitationApi->v2_query_batch_status: #{e}"
288
+ puts "Exception when calling PayeeInvitationApi->query_batch_status_v2: #{e}"
265
289
  end
266
290
  ```
267
291
 
@@ -286,13 +310,13 @@ Name | Type | Description | Notes
286
310
  - **Accept**: application/json
287
311
 
288
312
 
289
- ## v3_create_payee
313
+ ## query_batch_status_v3
290
314
 
291
- > CreatePayeesCSVResponse2 v3_create_payee(create_payees_request2)
315
+ > QueryBatchResponse2 query_batch_status_v3(batch_id)
292
316
 
293
- Intiate Payee Creation V3
317
+ Query Batch Status
294
318
 
295
- Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body, 409 - if there is a duplicate remote id within the batch / if there is a duplicate email within the batch).
319
+ Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ).
296
320
 
297
321
  ### Example
298
322
 
@@ -306,14 +330,14 @@ VeloPayments.configure do |config|
306
330
  end
307
331
 
308
332
  api_instance = VeloPayments::PayeeInvitationApi.new
309
- create_payees_request2 = VeloPayments::CreatePayeesRequest2.new # CreatePayeesRequest2 | Post payees to create.
333
+ batch_id = 'batch_id_example' # String | Batch Id
310
334
 
311
335
  begin
312
- #Intiate Payee Creation V3
313
- result = api_instance.v3_create_payee(create_payees_request2)
336
+ #Query Batch Status
337
+ result = api_instance.query_batch_status_v3(batch_id)
314
338
  p result
315
339
  rescue VeloPayments::ApiError => e
316
- puts "Exception when calling PayeeInvitationApi->v3_create_payee: #{e}"
340
+ puts "Exception when calling PayeeInvitationApi->query_batch_status_v3: #{e}"
317
341
  end
318
342
  ```
319
343
 
@@ -322,11 +346,11 @@ end
322
346
 
323
347
  Name | Type | Description | Notes
324
348
  ------------- | ------------- | ------------- | -------------
325
- **create_payees_request2** | [**CreatePayeesRequest2**](CreatePayeesRequest2.md)| Post payees to create. |
349
+ **batch_id** | [**String**](.md)| Batch Id |
326
350
 
327
351
  ### Return type
328
352
 
329
- [**CreatePayeesCSVResponse2**](CreatePayeesCSVResponse2.md)
353
+ [**QueryBatchResponse2**](QueryBatchResponse2.md)
330
354
 
331
355
  ### Authorization
332
356
 
@@ -334,13 +358,13 @@ Name | Type | Description | Notes
334
358
 
335
359
  ### HTTP request headers
336
360
 
337
- - **Content-Type**: application/json, multipart/form-data
361
+ - **Content-Type**: Not defined
338
362
  - **Accept**: application/json
339
363
 
340
364
 
341
- ## v3_query_batch_status
365
+ ## query_batch_status_v4
342
366
 
343
- > QueryBatchResponse v3_query_batch_status(batch_id)
367
+ > QueryBatchResponse2 query_batch_status_v4(batch_id)
344
368
 
345
369
  Query Batch Status
346
370
 
@@ -362,10 +386,10 @@ batch_id = 'batch_id_example' # String | Batch Id
362
386
 
363
387
  begin
364
388
  #Query Batch Status
365
- result = api_instance.v3_query_batch_status(batch_id)
389
+ result = api_instance.query_batch_status_v4(batch_id)
366
390
  p result
367
391
  rescue VeloPayments::ApiError => e
368
- puts "Exception when calling PayeeInvitationApi->v3_query_batch_status: #{e}"
392
+ puts "Exception when calling PayeeInvitationApi->query_batch_status_v4: #{e}"
369
393
  end
370
394
  ```
371
395
 
@@ -378,7 +402,7 @@ Name | Type | Description | Notes
378
402
 
379
403
  ### Return type
380
404
 
381
- [**QueryBatchResponse**](QueryBatchResponse.md)
405
+ [**QueryBatchResponse2**](QueryBatchResponse2.md)
382
406
 
383
407
  ### Authorization
384
408
 
@@ -389,3 +413,324 @@ Name | Type | Description | Notes
389
413
  - **Content-Type**: Not defined
390
414
  - **Accept**: application/json
391
415
 
416
+
417
+ ## resend_payee_invite_v1
418
+
419
+ > resend_payee_invite_v1(payee_id, invite_payee_request)
420
+
421
+ Resend Payee Invite
422
+
423
+ <p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p> <p>Deprecated. Please use v3 instead</p>
424
+
425
+ ### Example
426
+
427
+ ```ruby
428
+ # load the gem
429
+ require 'velopayments'
430
+ # setup authorization
431
+ VeloPayments.configure do |config|
432
+ # Configure OAuth2 access token for authorization: OAuth2
433
+ config.access_token = 'YOUR ACCESS TOKEN'
434
+ end
435
+
436
+ api_instance = VeloPayments::PayeeInvitationApi.new
437
+ payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
438
+ invite_payee_request = VeloPayments::InvitePayeeRequest.new # InvitePayeeRequest | Provide Payor Id in body of request
439
+
440
+ begin
441
+ #Resend Payee Invite
442
+ api_instance.resend_payee_invite_v1(payee_id, invite_payee_request)
443
+ rescue VeloPayments::ApiError => e
444
+ puts "Exception when calling PayeeInvitationApi->resend_payee_invite_v1: #{e}"
445
+ end
446
+ ```
447
+
448
+ ### Parameters
449
+
450
+
451
+ Name | Type | Description | Notes
452
+ ------------- | ------------- | ------------- | -------------
453
+ **payee_id** | [**String**](.md)| The UUID of the payee. |
454
+ **invite_payee_request** | [**InvitePayeeRequest**](InvitePayeeRequest.md)| Provide Payor Id in body of request |
455
+
456
+ ### Return type
457
+
458
+ nil (empty response body)
459
+
460
+ ### Authorization
461
+
462
+ [OAuth2](../README.md#OAuth2)
463
+
464
+ ### HTTP request headers
465
+
466
+ - **Content-Type**: application/json
467
+ - **Accept**: application/json
468
+
469
+
470
+ ## resend_payee_invite_v3
471
+
472
+ > resend_payee_invite_v3(payee_id, invite_payee_request2)
473
+
474
+ Resend Payee Invite
475
+
476
+ <p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p>
477
+
478
+ ### Example
479
+
480
+ ```ruby
481
+ # load the gem
482
+ require 'velopayments'
483
+ # setup authorization
484
+ VeloPayments.configure do |config|
485
+ # Configure OAuth2 access token for authorization: OAuth2
486
+ config.access_token = 'YOUR ACCESS TOKEN'
487
+ end
488
+
489
+ api_instance = VeloPayments::PayeeInvitationApi.new
490
+ payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
491
+ invite_payee_request2 = VeloPayments::InvitePayeeRequest2.new # InvitePayeeRequest2 | Provide Payor Id in body of request
492
+
493
+ begin
494
+ #Resend Payee Invite
495
+ api_instance.resend_payee_invite_v3(payee_id, invite_payee_request2)
496
+ rescue VeloPayments::ApiError => e
497
+ puts "Exception when calling PayeeInvitationApi->resend_payee_invite_v3: #{e}"
498
+ end
499
+ ```
500
+
501
+ ### Parameters
502
+
503
+
504
+ Name | Type | Description | Notes
505
+ ------------- | ------------- | ------------- | -------------
506
+ **payee_id** | [**String**](.md)| The UUID of the payee. |
507
+ **invite_payee_request2** | [**InvitePayeeRequest2**](InvitePayeeRequest2.md)| Provide Payor Id in body of request |
508
+
509
+ ### Return type
510
+
511
+ nil (empty response body)
512
+
513
+ ### Authorization
514
+
515
+ [OAuth2](../README.md#OAuth2)
516
+
517
+ ### HTTP request headers
518
+
519
+ - **Content-Type**: application/json
520
+ - **Accept**: application/json
521
+
522
+
523
+ ## resend_payee_invite_v4
524
+
525
+ > resend_payee_invite_v4(payee_id, invite_payee_request2)
526
+
527
+ Resend Payee Invite
528
+
529
+ <p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p>
530
+
531
+ ### Example
532
+
533
+ ```ruby
534
+ # load the gem
535
+ require 'velopayments'
536
+ # setup authorization
537
+ VeloPayments.configure do |config|
538
+ # Configure OAuth2 access token for authorization: OAuth2
539
+ config.access_token = 'YOUR ACCESS TOKEN'
540
+ end
541
+
542
+ api_instance = VeloPayments::PayeeInvitationApi.new
543
+ payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
544
+ invite_payee_request2 = VeloPayments::InvitePayeeRequest2.new # InvitePayeeRequest2 | Provide Payor Id in body of request
545
+
546
+ begin
547
+ #Resend Payee Invite
548
+ api_instance.resend_payee_invite_v4(payee_id, invite_payee_request2)
549
+ rescue VeloPayments::ApiError => e
550
+ puts "Exception when calling PayeeInvitationApi->resend_payee_invite_v4: #{e}"
551
+ end
552
+ ```
553
+
554
+ ### Parameters
555
+
556
+
557
+ Name | Type | Description | Notes
558
+ ------------- | ------------- | ------------- | -------------
559
+ **payee_id** | [**String**](.md)| The UUID of the payee. |
560
+ **invite_payee_request2** | [**InvitePayeeRequest2**](InvitePayeeRequest2.md)| Provide Payor Id in body of request |
561
+
562
+ ### Return type
563
+
564
+ nil (empty response body)
565
+
566
+ ### Authorization
567
+
568
+ [OAuth2](../README.md#OAuth2)
569
+
570
+ ### HTTP request headers
571
+
572
+ - **Content-Type**: application/json
573
+ - **Accept**: application/json
574
+
575
+
576
+ ## v2_create_payee
577
+
578
+ > CreatePayeesCSVResponse v2_create_payee(opts)
579
+
580
+ Initiate Payee Creation
581
+
582
+ Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body
583
+
584
+ ### Example
585
+
586
+ ```ruby
587
+ # load the gem
588
+ require 'velopayments'
589
+ # setup authorization
590
+ VeloPayments.configure do |config|
591
+ # Configure OAuth2 access token for authorization: OAuth2
592
+ config.access_token = 'YOUR ACCESS TOKEN'
593
+ end
594
+
595
+ api_instance = VeloPayments::PayeeInvitationApi.new
596
+ opts = {
597
+ create_payees_request: VeloPayments::CreatePayeesRequest.new # CreatePayeesRequest | Post payees to create.
598
+ }
599
+
600
+ begin
601
+ #Initiate Payee Creation
602
+ result = api_instance.v2_create_payee(opts)
603
+ p result
604
+ rescue VeloPayments::ApiError => e
605
+ puts "Exception when calling PayeeInvitationApi->v2_create_payee: #{e}"
606
+ end
607
+ ```
608
+
609
+ ### Parameters
610
+
611
+
612
+ Name | Type | Description | Notes
613
+ ------------- | ------------- | ------------- | -------------
614
+ **create_payees_request** | [**CreatePayeesRequest**](CreatePayeesRequest.md)| Post payees to create. | [optional]
615
+
616
+ ### Return type
617
+
618
+ [**CreatePayeesCSVResponse**](CreatePayeesCSVResponse.md)
619
+
620
+ ### Authorization
621
+
622
+ [OAuth2](../README.md#OAuth2)
623
+
624
+ ### HTTP request headers
625
+
626
+ - **Content-Type**: application/json, multipart/form-data
627
+ - **Accept**: application/json
628
+
629
+
630
+ ## v3_create_payee
631
+
632
+ > CreatePayeesCSVResponse2 v3_create_payee(opts)
633
+
634
+ Initiate Payee Creation
635
+
636
+ Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body. In addition to standard semantic validations, a 400 will also result if there is a duplicate remote id within the batch / if there is a duplicate email within the batch, i.e. if there is a conflict between the data provided for one payee within the batch and that provided for another payee within the same batch). The validation at this stage is intra-batch only. Validation against payees who have already been invited occurs subsequently during processing of the batch.
637
+
638
+ ### Example
639
+
640
+ ```ruby
641
+ # load the gem
642
+ require 'velopayments'
643
+ # setup authorization
644
+ VeloPayments.configure do |config|
645
+ # Configure OAuth2 access token for authorization: OAuth2
646
+ config.access_token = 'YOUR ACCESS TOKEN'
647
+ end
648
+
649
+ api_instance = VeloPayments::PayeeInvitationApi.new
650
+ opts = {
651
+ create_payees_request2: VeloPayments::CreatePayeesRequest2.new # CreatePayeesRequest2 | Post payees to create.
652
+ }
653
+
654
+ begin
655
+ #Initiate Payee Creation
656
+ result = api_instance.v3_create_payee(opts)
657
+ p result
658
+ rescue VeloPayments::ApiError => e
659
+ puts "Exception when calling PayeeInvitationApi->v3_create_payee: #{e}"
660
+ end
661
+ ```
662
+
663
+ ### Parameters
664
+
665
+
666
+ Name | Type | Description | Notes
667
+ ------------- | ------------- | ------------- | -------------
668
+ **create_payees_request2** | [**CreatePayeesRequest2**](CreatePayeesRequest2.md)| Post payees to create. | [optional]
669
+
670
+ ### Return type
671
+
672
+ [**CreatePayeesCSVResponse2**](CreatePayeesCSVResponse2.md)
673
+
674
+ ### Authorization
675
+
676
+ [OAuth2](../README.md#OAuth2)
677
+
678
+ ### HTTP request headers
679
+
680
+ - **Content-Type**: application/json, multipart/form-data
681
+ - **Accept**: application/json
682
+
683
+
684
+ ## v4_create_payee
685
+
686
+ > CreatePayeesCSVResponse2 v4_create_payee(opts)
687
+
688
+ Initiate Payee Creation
689
+
690
+ Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body. In addition to standard semantic validations, a 400 will also result if there is a duplicate remote id within the batch / if there is a duplicate email within the batch, i.e. if there is a conflict between the data provided for one payee within the batch and that provided for another payee within the same batch). The validation at this stage is intra-batch only. Validation against payees who have already been invited occurs subsequently during processing of the batch.
691
+
692
+ ### Example
693
+
694
+ ```ruby
695
+ # load the gem
696
+ require 'velopayments'
697
+ # setup authorization
698
+ VeloPayments.configure do |config|
699
+ # Configure OAuth2 access token for authorization: OAuth2
700
+ config.access_token = 'YOUR ACCESS TOKEN'
701
+ end
702
+
703
+ api_instance = VeloPayments::PayeeInvitationApi.new
704
+ opts = {
705
+ create_payees_request2: VeloPayments::CreatePayeesRequest2.new # CreatePayeesRequest2 | Post payees to create.
706
+ }
707
+
708
+ begin
709
+ #Initiate Payee Creation
710
+ result = api_instance.v4_create_payee(opts)
711
+ p result
712
+ rescue VeloPayments::ApiError => e
713
+ puts "Exception when calling PayeeInvitationApi->v4_create_payee: #{e}"
714
+ end
715
+ ```
716
+
717
+ ### Parameters
718
+
719
+
720
+ Name | Type | Description | Notes
721
+ ------------- | ------------- | ------------- | -------------
722
+ **create_payees_request2** | [**CreatePayeesRequest2**](CreatePayeesRequest2.md)| Post payees to create. | [optional]
723
+
724
+ ### Return type
725
+
726
+ [**CreatePayeesCSVResponse2**](CreatePayeesCSVResponse2.md)
727
+
728
+ ### Authorization
729
+
730
+ [OAuth2](../README.md#OAuth2)
731
+
732
+ ### HTTP request headers
733
+
734
+ - **Content-Type**: application/json, multipart/form-data
735
+ - **Accept**: application/json
736
+