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
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.18.113
6
+ The version of the OpenAPI document: 2.23.78
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.1-SNAPSHOT
9
+ OpenAPI Generator version: 5.0.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -20,27 +20,27 @@ module VeloPayments
20
20
  @api_client = api_client
21
21
  end
22
22
  # Delete Payee by Id
23
- # This API will delete Payee by Id (UUID). Deletion by ID is not allowed if: * Payee ID is not found * If Payee has not been on-boarded * If Payee is in grace period * If Payee has existing payments
23
+ # <p>This API will delete Payee by Id (UUID). Deletion by ID is not allowed if:</p> <p>* Payee ID is not found</p> <p>* If Payee has not been on-boarded</p> <p>* If Payee is in grace period</p> <p>* If Payee has existing payments</p> <p>Please use V3 instead.</p>
24
24
  # @param payee_id [String] The UUID of the payee.
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @return [nil]
27
- def delete_payee_by_id(payee_id, opts = {})
28
- delete_payee_by_id_with_http_info(payee_id, opts)
27
+ def delete_payee_by_id_v1(payee_id, opts = {})
28
+ delete_payee_by_id_v1_with_http_info(payee_id, opts)
29
29
  nil
30
30
  end
31
31
 
32
32
  # Delete Payee by Id
33
- # This API will delete Payee by Id (UUID). Deletion by ID is not allowed if: * Payee ID is not found * If Payee has not been on-boarded * If Payee is in grace period * If Payee has existing payments
33
+ # &lt;p&gt;This API will delete Payee by Id (UUID). Deletion by ID is not allowed if:&lt;/p&gt; &lt;p&gt;* Payee ID is not found&lt;/p&gt; &lt;p&gt;* If Payee has not been on-boarded&lt;/p&gt; &lt;p&gt;* If Payee is in grace period&lt;/p&gt; &lt;p&gt;* If Payee has existing payments&lt;/p&gt; &lt;p&gt;Please use V3 instead.&lt;/p&gt;
34
34
  # @param payee_id [String] The UUID of the payee.
35
35
  # @param [Hash] opts the optional parameters
36
36
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
37
- def delete_payee_by_id_with_http_info(payee_id, opts = {})
37
+ def delete_payee_by_id_v1_with_http_info(payee_id, opts = {})
38
38
  if @api_client.config.debugging
39
- @api_client.config.logger.debug 'Calling API: PayeesApi.delete_payee_by_id ...'
39
+ @api_client.config.logger.debug 'Calling API: PayeesApi.delete_payee_by_id_v1 ...'
40
40
  end
41
41
  # verify the required parameter 'payee_id' is set
42
42
  if @api_client.config.client_side_validation && payee_id.nil?
43
- fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeesApi.delete_payee_by_id"
43
+ fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeesApi.delete_payee_by_id_v1"
44
44
  end
45
45
  # resource path
46
46
  local_var_path = '/v1/payees/{payeeId}'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s))
@@ -55,15 +55,16 @@ module VeloPayments
55
55
  form_params = opts[:form_params] || {}
56
56
 
57
57
  # http body (model)
58
- post_body = opts[:body]
58
+ post_body = opts[:debug_body]
59
59
 
60
60
  # return_type
61
- return_type = opts[:return_type]
61
+ return_type = opts[:debug_return_type]
62
62
 
63
63
  # auth_names
64
- auth_names = opts[:auth_names] || ['OAuth2']
64
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
65
65
 
66
66
  new_options = opts.merge(
67
+ :operation => :"PayeesApi.delete_payee_by_id_v1",
67
68
  :header_params => header_params,
68
69
  :query_params => query_params,
69
70
  :form_params => form_params,
@@ -74,35 +75,157 @@ module VeloPayments
74
75
 
75
76
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
76
77
  if @api_client.config.debugging
77
- @api_client.config.logger.debug "API called: PayeesApi#delete_payee_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
78
+ @api_client.config.logger.debug "API called: PayeesApi#delete_payee_by_id_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
79
+ end
80
+ return data, status_code, headers
81
+ end
82
+
83
+ # Delete Payee by Id
84
+ # <p>This API will delete Payee by Id (UUID). Deletion by ID is not allowed if:</p> <p>* Payee ID is not found</p> <p>* If Payee has not been on-boarded</p> <p>* If Payee is in grace period</p> <p>* If Payee has existing payments</p>
85
+ # @param payee_id [String] The UUID of the payee.
86
+ # @param [Hash] opts the optional parameters
87
+ # @return [nil]
88
+ def delete_payee_by_id_v3(payee_id, opts = {})
89
+ delete_payee_by_id_v3_with_http_info(payee_id, opts)
90
+ nil
91
+ end
92
+
93
+ # Delete Payee by Id
94
+ # &lt;p&gt;This API will delete Payee by Id (UUID). Deletion by ID is not allowed if:&lt;/p&gt; &lt;p&gt;* Payee ID is not found&lt;/p&gt; &lt;p&gt;* If Payee has not been on-boarded&lt;/p&gt; &lt;p&gt;* If Payee is in grace period&lt;/p&gt; &lt;p&gt;* If Payee has existing payments&lt;/p&gt;
95
+ # @param payee_id [String] The UUID of the payee.
96
+ # @param [Hash] opts the optional parameters
97
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
98
+ def delete_payee_by_id_v3_with_http_info(payee_id, opts = {})
99
+ if @api_client.config.debugging
100
+ @api_client.config.logger.debug 'Calling API: PayeesApi.delete_payee_by_id_v3 ...'
101
+ end
102
+ # verify the required parameter 'payee_id' is set
103
+ if @api_client.config.client_side_validation && payee_id.nil?
104
+ fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeesApi.delete_payee_by_id_v3"
105
+ end
106
+ # resource path
107
+ local_var_path = '/v3/payees/{payeeId}'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s))
108
+
109
+ # query parameters
110
+ query_params = opts[:query_params] || {}
111
+
112
+ # header parameters
113
+ header_params = opts[:header_params] || {}
114
+
115
+ # form parameters
116
+ form_params = opts[:form_params] || {}
117
+
118
+ # http body (model)
119
+ post_body = opts[:debug_body]
120
+
121
+ # return_type
122
+ return_type = opts[:debug_return_type]
123
+
124
+ # auth_names
125
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
126
+
127
+ new_options = opts.merge(
128
+ :operation => :"PayeesApi.delete_payee_by_id_v3",
129
+ :header_params => header_params,
130
+ :query_params => query_params,
131
+ :form_params => form_params,
132
+ :body => post_body,
133
+ :auth_names => auth_names,
134
+ :return_type => return_type
135
+ )
136
+
137
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
138
+ if @api_client.config.debugging
139
+ @api_client.config.logger.debug "API called: PayeesApi#delete_payee_by_id_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
140
+ end
141
+ return data, status_code, headers
142
+ end
143
+
144
+ # Delete Payee by Id
145
+ # <p>This API will delete Payee by Id (UUID). Deletion by ID is not allowed if:</p> <p>* Payee ID is not found</p> <p>* If Payee has not been on-boarded</p> <p>* If Payee is in grace period</p> <p>* If Payee has existing payments</p>
146
+ # @param payee_id [String] The UUID of the payee.
147
+ # @param [Hash] opts the optional parameters
148
+ # @return [nil]
149
+ def delete_payee_by_id_v4(payee_id, opts = {})
150
+ delete_payee_by_id_v4_with_http_info(payee_id, opts)
151
+ nil
152
+ end
153
+
154
+ # Delete Payee by Id
155
+ # &lt;p&gt;This API will delete Payee by Id (UUID). Deletion by ID is not allowed if:&lt;/p&gt; &lt;p&gt;* Payee ID is not found&lt;/p&gt; &lt;p&gt;* If Payee has not been on-boarded&lt;/p&gt; &lt;p&gt;* If Payee is in grace period&lt;/p&gt; &lt;p&gt;* If Payee has existing payments&lt;/p&gt;
156
+ # @param payee_id [String] The UUID of the payee.
157
+ # @param [Hash] opts the optional parameters
158
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
159
+ def delete_payee_by_id_v4_with_http_info(payee_id, opts = {})
160
+ if @api_client.config.debugging
161
+ @api_client.config.logger.debug 'Calling API: PayeesApi.delete_payee_by_id_v4 ...'
162
+ end
163
+ # verify the required parameter 'payee_id' is set
164
+ if @api_client.config.client_side_validation && payee_id.nil?
165
+ fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeesApi.delete_payee_by_id_v4"
166
+ end
167
+ # resource path
168
+ local_var_path = '/v4/payees/{payeeId}'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s))
169
+
170
+ # query parameters
171
+ query_params = opts[:query_params] || {}
172
+
173
+ # header parameters
174
+ header_params = opts[:header_params] || {}
175
+
176
+ # form parameters
177
+ form_params = opts[:form_params] || {}
178
+
179
+ # http body (model)
180
+ post_body = opts[:debug_body]
181
+
182
+ # return_type
183
+ return_type = opts[:debug_return_type]
184
+
185
+ # auth_names
186
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
187
+
188
+ new_options = opts.merge(
189
+ :operation => :"PayeesApi.delete_payee_by_id_v4",
190
+ :header_params => header_params,
191
+ :query_params => query_params,
192
+ :form_params => form_params,
193
+ :body => post_body,
194
+ :auth_names => auth_names,
195
+ :return_type => return_type
196
+ )
197
+
198
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
199
+ if @api_client.config.debugging
200
+ @api_client.config.logger.debug "API called: PayeesApi#delete_payee_by_id_v4\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
78
201
  end
79
202
  return data, status_code, headers
80
203
  end
81
204
 
82
205
  # Get Payee by Id
83
- # Get Payee by Id
206
+ # <p>Get Payee by Id</p> <p>Please use V3 instead.</p>
84
207
  # @param payee_id [String] The UUID of the payee.
85
208
  # @param [Hash] opts the optional parameters
86
209
  # @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
87
210
  # @return [Payee]
88
- def get_payee_by_id(payee_id, opts = {})
89
- data, _status_code, _headers = get_payee_by_id_with_http_info(payee_id, opts)
211
+ def get_payee_by_id_v1(payee_id, opts = {})
212
+ data, _status_code, _headers = get_payee_by_id_v1_with_http_info(payee_id, opts)
90
213
  data
91
214
  end
92
215
 
93
216
  # Get Payee by Id
94
- # Get Payee by Id
217
+ # &lt;p&gt;Get Payee by Id&lt;/p&gt; &lt;p&gt;Please use V3 instead.&lt;/p&gt;
95
218
  # @param payee_id [String] The UUID of the payee.
96
219
  # @param [Hash] opts the optional parameters
97
220
  # @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
98
221
  # @return [Array<(Payee, Integer, Hash)>] Payee data, response status code and response headers
99
- def get_payee_by_id_with_http_info(payee_id, opts = {})
222
+ def get_payee_by_id_v1_with_http_info(payee_id, opts = {})
100
223
  if @api_client.config.debugging
101
- @api_client.config.logger.debug 'Calling API: PayeesApi.get_payee_by_id ...'
224
+ @api_client.config.logger.debug 'Calling API: PayeesApi.get_payee_by_id_v1 ...'
102
225
  end
103
226
  # verify the required parameter 'payee_id' is set
104
227
  if @api_client.config.client_side_validation && payee_id.nil?
105
- fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeesApi.get_payee_by_id"
228
+ fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeesApi.get_payee_by_id_v1"
106
229
  end
107
230
  # resource path
108
231
  local_var_path = '/v1/payees/{payeeId}'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s))
@@ -120,15 +243,214 @@ module VeloPayments
120
243
  form_params = opts[:form_params] || {}
121
244
 
122
245
  # http body (model)
123
- post_body = opts[:body]
246
+ post_body = opts[:debug_body]
247
+
248
+ # return_type
249
+ return_type = opts[:debug_return_type] || 'Payee'
250
+
251
+ # auth_names
252
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
253
+
254
+ new_options = opts.merge(
255
+ :operation => :"PayeesApi.get_payee_by_id_v1",
256
+ :header_params => header_params,
257
+ :query_params => query_params,
258
+ :form_params => form_params,
259
+ :body => post_body,
260
+ :auth_names => auth_names,
261
+ :return_type => return_type
262
+ )
263
+
264
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
265
+ if @api_client.config.debugging
266
+ @api_client.config.logger.debug "API called: PayeesApi#get_payee_by_id_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
267
+ end
268
+ return data, status_code, headers
269
+ end
270
+
271
+ # Get Payee by Id
272
+ # <p>Get Payee by Id</p> <p>Please use V3 instead.</p>
273
+ # @param payee_id [String] The UUID of the payee.
274
+ # @param [Hash] opts the optional parameters
275
+ # @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
276
+ # @return [PayeeResponseV2]
277
+ def get_payee_by_id_v2(payee_id, opts = {})
278
+ data, _status_code, _headers = get_payee_by_id_v2_with_http_info(payee_id, opts)
279
+ data
280
+ end
281
+
282
+ # Get Payee by Id
283
+ # &lt;p&gt;Get Payee by Id&lt;/p&gt; &lt;p&gt;Please use V3 instead.&lt;/p&gt;
284
+ # @param payee_id [String] The UUID of the payee.
285
+ # @param [Hash] opts the optional parameters
286
+ # @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
287
+ # @return [Array<(PayeeResponseV2, Integer, Hash)>] PayeeResponseV2 data, response status code and response headers
288
+ def get_payee_by_id_v2_with_http_info(payee_id, opts = {})
289
+ if @api_client.config.debugging
290
+ @api_client.config.logger.debug 'Calling API: PayeesApi.get_payee_by_id_v2 ...'
291
+ end
292
+ # verify the required parameter 'payee_id' is set
293
+ if @api_client.config.client_side_validation && payee_id.nil?
294
+ fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeesApi.get_payee_by_id_v2"
295
+ end
296
+ # resource path
297
+ local_var_path = '/v2/payees/{payeeId}'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s))
298
+
299
+ # query parameters
300
+ query_params = opts[:query_params] || {}
301
+ query_params[:'sensitive'] = opts[:'sensitive'] if !opts[:'sensitive'].nil?
302
+
303
+ # header parameters
304
+ header_params = opts[:header_params] || {}
305
+ # HTTP header 'Accept' (if needed)
306
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
307
+
308
+ # form parameters
309
+ form_params = opts[:form_params] || {}
310
+
311
+ # http body (model)
312
+ post_body = opts[:debug_body]
313
+
314
+ # return_type
315
+ return_type = opts[:debug_return_type] || 'PayeeResponseV2'
316
+
317
+ # auth_names
318
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
319
+
320
+ new_options = opts.merge(
321
+ :operation => :"PayeesApi.get_payee_by_id_v2",
322
+ :header_params => header_params,
323
+ :query_params => query_params,
324
+ :form_params => form_params,
325
+ :body => post_body,
326
+ :auth_names => auth_names,
327
+ :return_type => return_type
328
+ )
329
+
330
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
331
+ if @api_client.config.debugging
332
+ @api_client.config.logger.debug "API called: PayeesApi#get_payee_by_id_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
333
+ end
334
+ return data, status_code, headers
335
+ end
336
+
337
+ # Get Payee by Id
338
+ # Get Payee by Id
339
+ # @param payee_id [String] The UUID of the payee.
340
+ # @param [Hash] opts the optional parameters
341
+ # @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
342
+ # @return [PayeeDetailResponse]
343
+ def get_payee_by_id_v3(payee_id, opts = {})
344
+ data, _status_code, _headers = get_payee_by_id_v3_with_http_info(payee_id, opts)
345
+ data
346
+ end
347
+
348
+ # Get Payee by Id
349
+ # Get Payee by Id
350
+ # @param payee_id [String] The UUID of the payee.
351
+ # @param [Hash] opts the optional parameters
352
+ # @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
353
+ # @return [Array<(PayeeDetailResponse, Integer, Hash)>] PayeeDetailResponse data, response status code and response headers
354
+ def get_payee_by_id_v3_with_http_info(payee_id, opts = {})
355
+ if @api_client.config.debugging
356
+ @api_client.config.logger.debug 'Calling API: PayeesApi.get_payee_by_id_v3 ...'
357
+ end
358
+ # verify the required parameter 'payee_id' is set
359
+ if @api_client.config.client_side_validation && payee_id.nil?
360
+ fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeesApi.get_payee_by_id_v3"
361
+ end
362
+ # resource path
363
+ local_var_path = '/v3/payees/{payeeId}'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s))
364
+
365
+ # query parameters
366
+ query_params = opts[:query_params] || {}
367
+ query_params[:'sensitive'] = opts[:'sensitive'] if !opts[:'sensitive'].nil?
368
+
369
+ # header parameters
370
+ header_params = opts[:header_params] || {}
371
+ # HTTP header 'Accept' (if needed)
372
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
373
+
374
+ # form parameters
375
+ form_params = opts[:form_params] || {}
376
+
377
+ # http body (model)
378
+ post_body = opts[:debug_body]
379
+
380
+ # return_type
381
+ return_type = opts[:debug_return_type] || 'PayeeDetailResponse'
382
+
383
+ # auth_names
384
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
385
+
386
+ new_options = opts.merge(
387
+ :operation => :"PayeesApi.get_payee_by_id_v3",
388
+ :header_params => header_params,
389
+ :query_params => query_params,
390
+ :form_params => form_params,
391
+ :body => post_body,
392
+ :auth_names => auth_names,
393
+ :return_type => return_type
394
+ )
395
+
396
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
397
+ if @api_client.config.debugging
398
+ @api_client.config.logger.debug "API called: PayeesApi#get_payee_by_id_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
399
+ end
400
+ return data, status_code, headers
401
+ end
402
+
403
+ # Get Payee by Id
404
+ # Get Payee by Id
405
+ # @param payee_id [String] The UUID of the payee.
406
+ # @param [Hash] opts the optional parameters
407
+ # @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
408
+ # @return [PayeeDetailResponse2]
409
+ def get_payee_by_id_v4(payee_id, opts = {})
410
+ data, _status_code, _headers = get_payee_by_id_v4_with_http_info(payee_id, opts)
411
+ data
412
+ end
413
+
414
+ # Get Payee by Id
415
+ # Get Payee by Id
416
+ # @param payee_id [String] The UUID of the payee.
417
+ # @param [Hash] opts the optional parameters
418
+ # @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.
419
+ # @return [Array<(PayeeDetailResponse2, Integer, Hash)>] PayeeDetailResponse2 data, response status code and response headers
420
+ def get_payee_by_id_v4_with_http_info(payee_id, opts = {})
421
+ if @api_client.config.debugging
422
+ @api_client.config.logger.debug 'Calling API: PayeesApi.get_payee_by_id_v4 ...'
423
+ end
424
+ # verify the required parameter 'payee_id' is set
425
+ if @api_client.config.client_side_validation && payee_id.nil?
426
+ fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeesApi.get_payee_by_id_v4"
427
+ end
428
+ # resource path
429
+ local_var_path = '/v4/payees/{payeeId}'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s))
430
+
431
+ # query parameters
432
+ query_params = opts[:query_params] || {}
433
+ query_params[:'sensitive'] = opts[:'sensitive'] if !opts[:'sensitive'].nil?
434
+
435
+ # header parameters
436
+ header_params = opts[:header_params] || {}
437
+ # HTTP header 'Accept' (if needed)
438
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
439
+
440
+ # form parameters
441
+ form_params = opts[:form_params] || {}
442
+
443
+ # http body (model)
444
+ post_body = opts[:debug_body]
124
445
 
125
446
  # return_type
126
- return_type = opts[:return_type] || 'Payee'
447
+ return_type = opts[:debug_return_type] || 'PayeeDetailResponse2'
127
448
 
128
449
  # auth_names
129
- auth_names = opts[:auth_names] || ['OAuth2']
450
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
130
451
 
131
452
  new_options = opts.merge(
453
+ :operation => :"PayeesApi.get_payee_by_id_v4",
132
454
  :header_params => header_params,
133
455
  :query_params => query_params,
134
456
  :form_params => form_params,
@@ -139,15 +461,15 @@ module VeloPayments
139
461
 
140
462
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
141
463
  if @api_client.config.debugging
142
- @api_client.config.logger.debug "API called: PayeesApi#get_payee_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
464
+ @api_client.config.logger.debug "API called: PayeesApi#get_payee_by_id_v4\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
143
465
  end
144
466
  return data, status_code, headers
145
467
  end
146
468
 
147
469
  # List Payee Changes
148
- # Get a paginated response listing payee changes.
470
+ # <p>Get a paginated response listing payee changes.</p> <p>Please use V3 instead.</p>
149
471
  # @param payor_id [String] The Payor ID to find associated Payees
150
- # @param updated_since [DateTime] The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
472
+ # @param updated_since [Time] The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
151
473
  # @param [Hash] opts the optional parameters
152
474
  # @option opts [Integer] :page Page number. Default is 1. (default to 1)
153
475
  # @option opts [Integer] :page_size Page size. Default is 100. Max allowable is 1000. (default to 100)
@@ -158,9 +480,9 @@ module VeloPayments
158
480
  end
159
481
 
160
482
  # List Payee Changes
161
- # Get a paginated response listing payee changes.
483
+ # &lt;p&gt;Get a paginated response listing payee changes.&lt;/p&gt; &lt;p&gt;Please use V3 instead.&lt;/p&gt;
162
484
  # @param payor_id [String] The Payor ID to find associated Payees
163
- # @param updated_since [DateTime] The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
485
+ # @param updated_since [Time] The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
164
486
  # @param [Hash] opts the optional parameters
165
487
  # @option opts [Integer] :page Page number. Default is 1.
166
488
  # @option opts [Integer] :page_size Page size. Default is 100. Max allowable is 1000.
@@ -178,14 +500,267 @@ module VeloPayments
178
500
  fail ArgumentError, "Missing the required parameter 'updated_since' when calling PayeesApi.list_payee_changes"
179
501
  end
180
502
  # resource path
181
- local_var_path = '/v1/deltas/payees'
503
+ local_var_path = '/v1/deltas/payees'
504
+
505
+ # query parameters
506
+ query_params = opts[:query_params] || {}
507
+ query_params[:'payorId'] = payor_id
508
+ query_params[:'updatedSince'] = updated_since
509
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
510
+ query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
511
+
512
+ # header parameters
513
+ header_params = opts[:header_params] || {}
514
+ # HTTP header 'Accept' (if needed)
515
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
516
+
517
+ # form parameters
518
+ form_params = opts[:form_params] || {}
519
+
520
+ # http body (model)
521
+ post_body = opts[:debug_body]
522
+
523
+ # return_type
524
+ return_type = opts[:debug_return_type] || 'PayeeDeltaResponse'
525
+
526
+ # auth_names
527
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
528
+
529
+ new_options = opts.merge(
530
+ :operation => :"PayeesApi.list_payee_changes",
531
+ :header_params => header_params,
532
+ :query_params => query_params,
533
+ :form_params => form_params,
534
+ :body => post_body,
535
+ :auth_names => auth_names,
536
+ :return_type => return_type
537
+ )
538
+
539
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
540
+ if @api_client.config.debugging
541
+ @api_client.config.logger.debug "API called: PayeesApi#list_payee_changes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
542
+ end
543
+ return data, status_code, headers
544
+ end
545
+
546
+ # List Payee Changes
547
+ # Get a paginated response listing payee changes.
548
+ # @param payor_id [String] The Payor ID to find associated Payees
549
+ # @param updated_since [Time] The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
550
+ # @param [Hash] opts the optional parameters
551
+ # @option opts [Integer] :page Page number. Default is 1. (default to 1)
552
+ # @option opts [Integer] :page_size Page size. Default is 100. Max allowable is 1000. (default to 100)
553
+ # @return [PayeeDeltaResponse2]
554
+ def list_payee_changes_v3(payor_id, updated_since, opts = {})
555
+ data, _status_code, _headers = list_payee_changes_v3_with_http_info(payor_id, updated_since, opts)
556
+ data
557
+ end
558
+
559
+ # List Payee Changes
560
+ # Get a paginated response listing payee changes.
561
+ # @param payor_id [String] The Payor ID to find associated Payees
562
+ # @param updated_since [Time] The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
563
+ # @param [Hash] opts the optional parameters
564
+ # @option opts [Integer] :page Page number. Default is 1.
565
+ # @option opts [Integer] :page_size Page size. Default is 100. Max allowable is 1000.
566
+ # @return [Array<(PayeeDeltaResponse2, Integer, Hash)>] PayeeDeltaResponse2 data, response status code and response headers
567
+ def list_payee_changes_v3_with_http_info(payor_id, updated_since, opts = {})
568
+ if @api_client.config.debugging
569
+ @api_client.config.logger.debug 'Calling API: PayeesApi.list_payee_changes_v3 ...'
570
+ end
571
+ # verify the required parameter 'payor_id' is set
572
+ if @api_client.config.client_side_validation && payor_id.nil?
573
+ fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayeesApi.list_payee_changes_v3"
574
+ end
575
+ # verify the required parameter 'updated_since' is set
576
+ if @api_client.config.client_side_validation && updated_since.nil?
577
+ fail ArgumentError, "Missing the required parameter 'updated_since' when calling PayeesApi.list_payee_changes_v3"
578
+ end
579
+ # resource path
580
+ local_var_path = '/v3/payees/deltas'
581
+
582
+ # query parameters
583
+ query_params = opts[:query_params] || {}
584
+ query_params[:'payorId'] = payor_id
585
+ query_params[:'updatedSince'] = updated_since
586
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
587
+ query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
588
+
589
+ # header parameters
590
+ header_params = opts[:header_params] || {}
591
+ # HTTP header 'Accept' (if needed)
592
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
593
+
594
+ # form parameters
595
+ form_params = opts[:form_params] || {}
596
+
597
+ # http body (model)
598
+ post_body = opts[:debug_body]
599
+
600
+ # return_type
601
+ return_type = opts[:debug_return_type] || 'PayeeDeltaResponse2'
602
+
603
+ # auth_names
604
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
605
+
606
+ new_options = opts.merge(
607
+ :operation => :"PayeesApi.list_payee_changes_v3",
608
+ :header_params => header_params,
609
+ :query_params => query_params,
610
+ :form_params => form_params,
611
+ :body => post_body,
612
+ :auth_names => auth_names,
613
+ :return_type => return_type
614
+ )
615
+
616
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
617
+ if @api_client.config.debugging
618
+ @api_client.config.logger.debug "API called: PayeesApi#list_payee_changes_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
619
+ end
620
+ return data, status_code, headers
621
+ end
622
+
623
+ # List Payee Changes
624
+ # Get a paginated response listing payee changes (updated since a particular time) to a limited set of fields: - dbaName - displayName - email - onboardedStatus - payeeCountry - payeeId - remoteId
625
+ # @param payor_id [String] The Payor ID to find associated Payees
626
+ # @param updated_since [Time] The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
627
+ # @param [Hash] opts the optional parameters
628
+ # @option opts [Integer] :page Page number. Default is 1. (default to 1)
629
+ # @option opts [Integer] :page_size Page size. Default is 100. Max allowable is 1000. (default to 100)
630
+ # @return [PayeeDeltaResponse2]
631
+ def list_payee_changes_v4(payor_id, updated_since, opts = {})
632
+ data, _status_code, _headers = list_payee_changes_v4_with_http_info(payor_id, updated_since, opts)
633
+ data
634
+ end
635
+
636
+ # List Payee Changes
637
+ # Get a paginated response listing payee changes (updated since a particular time) to a limited set of fields: - dbaName - displayName - email - onboardedStatus - payeeCountry - payeeId - remoteId
638
+ # @param payor_id [String] The Payor ID to find associated Payees
639
+ # @param updated_since [Time] The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
640
+ # @param [Hash] opts the optional parameters
641
+ # @option opts [Integer] :page Page number. Default is 1.
642
+ # @option opts [Integer] :page_size Page size. Default is 100. Max allowable is 1000.
643
+ # @return [Array<(PayeeDeltaResponse2, Integer, Hash)>] PayeeDeltaResponse2 data, response status code and response headers
644
+ def list_payee_changes_v4_with_http_info(payor_id, updated_since, opts = {})
645
+ if @api_client.config.debugging
646
+ @api_client.config.logger.debug 'Calling API: PayeesApi.list_payee_changes_v4 ...'
647
+ end
648
+ # verify the required parameter 'payor_id' is set
649
+ if @api_client.config.client_side_validation && payor_id.nil?
650
+ fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayeesApi.list_payee_changes_v4"
651
+ end
652
+ # verify the required parameter 'updated_since' is set
653
+ if @api_client.config.client_side_validation && updated_since.nil?
654
+ fail ArgumentError, "Missing the required parameter 'updated_since' when calling PayeesApi.list_payee_changes_v4"
655
+ end
656
+ # resource path
657
+ local_var_path = '/v4/payees/deltas'
658
+
659
+ # query parameters
660
+ query_params = opts[:query_params] || {}
661
+ query_params[:'payorId'] = payor_id
662
+ query_params[:'updatedSince'] = updated_since
663
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
664
+ query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
665
+
666
+ # header parameters
667
+ header_params = opts[:header_params] || {}
668
+ # HTTP header 'Accept' (if needed)
669
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
670
+
671
+ # form parameters
672
+ form_params = opts[:form_params] || {}
673
+
674
+ # http body (model)
675
+ post_body = opts[:debug_body]
676
+
677
+ # return_type
678
+ return_type = opts[:debug_return_type] || 'PayeeDeltaResponse2'
679
+
680
+ # auth_names
681
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
682
+
683
+ new_options = opts.merge(
684
+ :operation => :"PayeesApi.list_payee_changes_v4",
685
+ :header_params => header_params,
686
+ :query_params => query_params,
687
+ :form_params => form_params,
688
+ :body => post_body,
689
+ :auth_names => auth_names,
690
+ :return_type => return_type
691
+ )
692
+
693
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
694
+ if @api_client.config.debugging
695
+ @api_client.config.logger.debug "API called: PayeesApi#list_payee_changes_v4\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
696
+ end
697
+ return data, status_code, headers
698
+ end
699
+
700
+ # List Payees V1
701
+ # <p>Get a paginated response listing the payees for a payor.</p> <p>Please use V3 instead.</>
702
+ # @param payor_id [String] The account owner Payor ID
703
+ # @param [Hash] opts the optional parameters
704
+ # @option opts [OfacStatus] :ofac_status The ofacStatus of the payees.
705
+ # @option opts [OnboardedStatus] :onboarded_status The onboarded status of the payees.
706
+ # @option opts [String] :email Email address
707
+ # @option opts [String] :display_name The display name of the payees.
708
+ # @option opts [String] :remote_id The remote id of the payees.
709
+ # @option opts [PayeeType] :payee_type The onboarded status of the payees.
710
+ # @option opts [String] :payee_country The country of the payee - 2 letter ISO 3166-1 country code (upper case)
711
+ # @option opts [Integer] :page Page number. Default is 1. (default to 1)
712
+ # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25)
713
+ # @option opts [String] :sort List of sort fields (e.g. ?sort&#x3D;onboardedStatus:asc,name:asc) Default is name:asc &#39;name&#39; is treated as company name for companies - last name + &#39;,&#39; + firstName for individuals The supported sort fields are - payeeId, displayName, payoutStatus, onboardedStatus. (default to 'displayName:asc')
714
+ # @return [PagedPayeeResponse]
715
+ def list_payees_v1(payor_id, opts = {})
716
+ data, _status_code, _headers = list_payees_v1_with_http_info(payor_id, opts)
717
+ data
718
+ end
719
+
720
+ # List Payees V1
721
+ # &lt;p&gt;Get a paginated response listing the payees for a payor.&lt;/p&gt; &lt;p&gt;Please use V3 instead.&lt;/&gt;
722
+ # @param payor_id [String] The account owner Payor ID
723
+ # @param [Hash] opts the optional parameters
724
+ # @option opts [OfacStatus] :ofac_status The ofacStatus of the payees.
725
+ # @option opts [OnboardedStatus] :onboarded_status The onboarded status of the payees.
726
+ # @option opts [String] :email Email address
727
+ # @option opts [String] :display_name The display name of the payees.
728
+ # @option opts [String] :remote_id The remote id of the payees.
729
+ # @option opts [PayeeType] :payee_type The onboarded status of the payees.
730
+ # @option opts [String] :payee_country The country of the payee - 2 letter ISO 3166-1 country code (upper case)
731
+ # @option opts [Integer] :page Page number. Default is 1.
732
+ # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
733
+ # @option opts [String] :sort List of sort fields (e.g. ?sort&#x3D;onboardedStatus:asc,name:asc) Default is name:asc &#39;name&#39; is treated as company name for companies - last name + &#39;,&#39; + firstName for individuals The supported sort fields are - payeeId, displayName, payoutStatus, onboardedStatus.
734
+ # @return [Array<(PagedPayeeResponse, Integer, Hash)>] PagedPayeeResponse data, response status code and response headers
735
+ def list_payees_v1_with_http_info(payor_id, opts = {})
736
+ if @api_client.config.debugging
737
+ @api_client.config.logger.debug 'Calling API: PayeesApi.list_payees_v1 ...'
738
+ end
739
+ # verify the required parameter 'payor_id' is set
740
+ if @api_client.config.client_side_validation && payor_id.nil?
741
+ fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayeesApi.list_payees_v1"
742
+ end
743
+ pattern = Regexp.new(/[a-zA-Z]+[:desc|:asc]/)
744
+ if @api_client.config.client_side_validation && !opts[:'sort'].nil? && opts[:'sort'] !~ pattern
745
+ fail ArgumentError, "invalid value for 'opts[:\"sort\"]' when calling PayeesApi.list_payees_v1, must conform to the pattern #{pattern}."
746
+ end
747
+
748
+ # resource path
749
+ local_var_path = '/v1/payees'
182
750
 
183
751
  # query parameters
184
752
  query_params = opts[:query_params] || {}
185
753
  query_params[:'payorId'] = payor_id
186
- query_params[:'updatedSince'] = updated_since
754
+ query_params[:'ofacStatus'] = opts[:'ofac_status'] if !opts[:'ofac_status'].nil?
755
+ query_params[:'onboardedStatus'] = opts[:'onboarded_status'] if !opts[:'onboarded_status'].nil?
756
+ query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
757
+ query_params[:'displayName'] = opts[:'display_name'] if !opts[:'display_name'].nil?
758
+ query_params[:'remoteId'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
759
+ query_params[:'payeeType'] = opts[:'payee_type'] if !opts[:'payee_type'].nil?
760
+ query_params[:'payeeCountry'] = opts[:'payee_country'] if !opts[:'payee_country'].nil?
187
761
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
188
762
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
763
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
189
764
 
190
765
  # header parameters
191
766
  header_params = opts[:header_params] || {}
@@ -196,15 +771,16 @@ module VeloPayments
196
771
  form_params = opts[:form_params] || {}
197
772
 
198
773
  # http body (model)
199
- post_body = opts[:body]
774
+ post_body = opts[:debug_body]
200
775
 
201
776
  # return_type
202
- return_type = opts[:return_type] || 'PayeeDeltaResponse'
777
+ return_type = opts[:debug_return_type] || 'PagedPayeeResponse'
203
778
 
204
779
  # auth_names
205
- auth_names = opts[:auth_names] || ['OAuth2']
780
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
206
781
 
207
782
  new_options = opts.merge(
783
+ :operation => :"PayeesApi.list_payees_v1",
208
784
  :header_params => header_params,
209
785
  :query_params => query_params,
210
786
  :form_params => form_params,
@@ -215,7 +791,7 @@ module VeloPayments
215
791
 
216
792
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
217
793
  if @api_client.config.debugging
218
- @api_client.config.logger.debug "API called: PayeesApi#list_payee_changes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
794
+ @api_client.config.logger.debug "API called: PayeesApi#list_payees_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
219
795
  end
220
796
  return data, status_code, headers
221
797
  end
@@ -224,7 +800,8 @@ module VeloPayments
224
800
  # Get a paginated response listing the payees for a payor.
225
801
  # @param payor_id [String] The account owner Payor ID
226
802
  # @param [Hash] opts the optional parameters
227
- # @option opts [OfacStatus] :ofac_status The ofacStatus of the payees.
803
+ # @option opts [WatchlistStatus] :watchlist_status The watchlistStatus of the payees.
804
+ # @option opts [Boolean] :disabled Payee disabled
228
805
  # @option opts [OnboardedStatus] :onboarded_status The onboarded status of the payees.
229
806
  # @option opts [String] :email Email address
230
807
  # @option opts [String] :display_name The display name of the payees.
@@ -234,9 +811,9 @@ module VeloPayments
234
811
  # @option opts [Integer] :page Page number. Default is 1. (default to 1)
235
812
  # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25)
236
813
  # @option opts [String] :sort List of sort fields (e.g. ?sort&#x3D;onboardedStatus:asc,name:asc) Default is name:asc &#39;name&#39; is treated as company name for companies - last name + &#39;,&#39; + firstName for individuals The supported sort fields are - payeeId, displayName, payoutStatus, onboardedStatus. (default to 'displayName:asc')
237
- # @return [PagedPayeeResponse]
238
- def list_payees(payor_id, opts = {})
239
- data, _status_code, _headers = list_payees_with_http_info(payor_id, opts)
814
+ # @return [PagedPayeeResponse2]
815
+ def list_payees_v3(payor_id, opts = {})
816
+ data, _status_code, _headers = list_payees_v3_with_http_info(payor_id, opts)
240
817
  data
241
818
  end
242
819
 
@@ -244,7 +821,8 @@ module VeloPayments
244
821
  # Get a paginated response listing the payees for a payor.
245
822
  # @param payor_id [String] The account owner Payor ID
246
823
  # @param [Hash] opts the optional parameters
247
- # @option opts [OfacStatus] :ofac_status The ofacStatus of the payees.
824
+ # @option opts [WatchlistStatus] :watchlist_status The watchlistStatus of the payees.
825
+ # @option opts [Boolean] :disabled Payee disabled
248
826
  # @option opts [OnboardedStatus] :onboarded_status The onboarded status of the payees.
249
827
  # @option opts [String] :email Email address
250
828
  # @option opts [String] :display_name The display name of the payees.
@@ -254,29 +832,30 @@ module VeloPayments
254
832
  # @option opts [Integer] :page Page number. Default is 1.
255
833
  # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
256
834
  # @option opts [String] :sort List of sort fields (e.g. ?sort&#x3D;onboardedStatus:asc,name:asc) Default is name:asc &#39;name&#39; is treated as company name for companies - last name + &#39;,&#39; + firstName for individuals The supported sort fields are - payeeId, displayName, payoutStatus, onboardedStatus.
257
- # @return [Array<(PagedPayeeResponse, Integer, Hash)>] PagedPayeeResponse data, response status code and response headers
258
- def list_payees_with_http_info(payor_id, opts = {})
835
+ # @return [Array<(PagedPayeeResponse2, Integer, Hash)>] PagedPayeeResponse2 data, response status code and response headers
836
+ def list_payees_v3_with_http_info(payor_id, opts = {})
259
837
  if @api_client.config.debugging
260
- @api_client.config.logger.debug 'Calling API: PayeesApi.list_payees ...'
838
+ @api_client.config.logger.debug 'Calling API: PayeesApi.list_payees_v3 ...'
261
839
  end
262
840
  # verify the required parameter 'payor_id' is set
263
841
  if @api_client.config.client_side_validation && payor_id.nil?
264
- fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayeesApi.list_payees"
842
+ fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayeesApi.list_payees_v3"
265
843
  end
266
844
  pattern = Regexp.new(/[a-zA-Z]+[:desc|:asc]/)
267
845
  if @api_client.config.client_side_validation && !opts[:'sort'].nil? && opts[:'sort'] !~ pattern
268
- fail ArgumentError, "invalid value for 'opts[:\"sort\"]' when calling PayeesApi.list_payees, must conform to the pattern #{pattern}."
846
+ fail ArgumentError, "invalid value for 'opts[:\"sort\"]' when calling PayeesApi.list_payees_v3, must conform to the pattern #{pattern}."
269
847
  end
270
848
 
271
849
  # resource path
272
- local_var_path = '/v1/payees'
850
+ local_var_path = '/v3/payees'
273
851
 
274
852
  # query parameters
275
853
  query_params = opts[:query_params] || {}
276
854
  query_params[:'payorId'] = payor_id
277
- query_params[:'ofacStatus'] = opts[:'ofac_status'] if !opts[:'ofac_status'].nil?
855
+ query_params[:'watchlistStatus'] = opts[:'watchlist_status'] if !opts[:'watchlist_status'].nil?
856
+ query_params[:'disabled'] = opts[:'disabled'] if !opts[:'disabled'].nil?
278
857
  query_params[:'onboardedStatus'] = opts[:'onboarded_status'] if !opts[:'onboarded_status'].nil?
279
- query_params[:'Email'] = opts[:'email'] if !opts[:'email'].nil?
858
+ query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
280
859
  query_params[:'displayName'] = opts[:'display_name'] if !opts[:'display_name'].nil?
281
860
  query_params[:'remoteId'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
282
861
  query_params[:'payeeType'] = opts[:'payee_type'] if !opts[:'payee_type'].nil?
@@ -294,15 +873,16 @@ module VeloPayments
294
873
  form_params = opts[:form_params] || {}
295
874
 
296
875
  # http body (model)
297
- post_body = opts[:body]
876
+ post_body = opts[:debug_body]
298
877
 
299
878
  # return_type
300
- return_type = opts[:return_type] || 'PagedPayeeResponse'
879
+ return_type = opts[:debug_return_type] || 'PagedPayeeResponse2'
301
880
 
302
881
  # auth_names
303
- auth_names = opts[:auth_names] || ['OAuth2']
882
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
304
883
 
305
884
  new_options = opts.merge(
885
+ :operation => :"PayeesApi.list_payees_v3",
306
886
  :header_params => header_params,
307
887
  :query_params => query_params,
308
888
  :form_params => form_params,
@@ -313,7 +893,7 @@ module VeloPayments
313
893
 
314
894
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
315
895
  if @api_client.config.debugging
316
- @api_client.config.logger.debug "API called: PayeesApi#list_payees\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
896
+ @api_client.config.logger.debug "API called: PayeesApi#list_payees_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
317
897
  end
318
898
  return data, status_code, headers
319
899
  end
@@ -322,19 +902,21 @@ module VeloPayments
322
902
  # Get a paginated response listing the payees for a payor.
323
903
  # @param payor_id [String] The account owner Payor ID
324
904
  # @param [Hash] opts the optional parameters
325
- # @option opts [WatchlistStatus] :ofac_status The watchlistStatus of the payees.
905
+ # @option opts [WatchlistStatus] :watchlist_status The watchlistStatus of the payees.
906
+ # @option opts [Boolean] :disabled Payee disabled
326
907
  # @option opts [OnboardedStatus] :onboarded_status The onboarded status of the payees.
327
908
  # @option opts [String] :email Email address
328
909
  # @option opts [String] :display_name The display name of the payees.
329
910
  # @option opts [String] :remote_id The remote id of the payees.
330
911
  # @option opts [PayeeType] :payee_type The onboarded status of the payees.
331
912
  # @option opts [String] :payee_country The country of the payee - 2 letter ISO 3166-1 country code (upper case)
913
+ # @option opts [OfacStatus] :ofac_status The ofacStatus of the payees.
332
914
  # @option opts [Integer] :page Page number. Default is 1. (default to 1)
333
915
  # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25)
334
916
  # @option opts [String] :sort List of sort fields (e.g. ?sort&#x3D;onboardedStatus:asc,name:asc) Default is name:asc &#39;name&#39; is treated as company name for companies - last name + &#39;,&#39; + firstName for individuals The supported sort fields are - payeeId, displayName, payoutStatus, onboardedStatus. (default to 'displayName:asc')
335
917
  # @return [PagedPayeeResponse2]
336
- def list_payees_v3(payor_id, opts = {})
337
- data, _status_code, _headers = list_payees_v3_with_http_info(payor_id, opts)
918
+ def list_payees_v4(payor_id, opts = {})
919
+ data, _status_code, _headers = list_payees_v4_with_http_info(payor_id, opts)
338
920
  data
339
921
  end
340
922
 
@@ -342,43 +924,47 @@ module VeloPayments
342
924
  # Get a paginated response listing the payees for a payor.
343
925
  # @param payor_id [String] The account owner Payor ID
344
926
  # @param [Hash] opts the optional parameters
345
- # @option opts [WatchlistStatus] :ofac_status The watchlistStatus of the payees.
927
+ # @option opts [WatchlistStatus] :watchlist_status The watchlistStatus of the payees.
928
+ # @option opts [Boolean] :disabled Payee disabled
346
929
  # @option opts [OnboardedStatus] :onboarded_status The onboarded status of the payees.
347
930
  # @option opts [String] :email Email address
348
931
  # @option opts [String] :display_name The display name of the payees.
349
932
  # @option opts [String] :remote_id The remote id of the payees.
350
933
  # @option opts [PayeeType] :payee_type The onboarded status of the payees.
351
934
  # @option opts [String] :payee_country The country of the payee - 2 letter ISO 3166-1 country code (upper case)
935
+ # @option opts [OfacStatus] :ofac_status The ofacStatus of the payees.
352
936
  # @option opts [Integer] :page Page number. Default is 1.
353
937
  # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
354
938
  # @option opts [String] :sort List of sort fields (e.g. ?sort&#x3D;onboardedStatus:asc,name:asc) Default is name:asc &#39;name&#39; is treated as company name for companies - last name + &#39;,&#39; + firstName for individuals The supported sort fields are - payeeId, displayName, payoutStatus, onboardedStatus.
355
939
  # @return [Array<(PagedPayeeResponse2, Integer, Hash)>] PagedPayeeResponse2 data, response status code and response headers
356
- def list_payees_v3_with_http_info(payor_id, opts = {})
940
+ def list_payees_v4_with_http_info(payor_id, opts = {})
357
941
  if @api_client.config.debugging
358
- @api_client.config.logger.debug 'Calling API: PayeesApi.list_payees_v3 ...'
942
+ @api_client.config.logger.debug 'Calling API: PayeesApi.list_payees_v4 ...'
359
943
  end
360
944
  # verify the required parameter 'payor_id' is set
361
945
  if @api_client.config.client_side_validation && payor_id.nil?
362
- fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayeesApi.list_payees_v3"
946
+ fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayeesApi.list_payees_v4"
363
947
  end
364
948
  pattern = Regexp.new(/[a-zA-Z]+[:desc|:asc]/)
365
949
  if @api_client.config.client_side_validation && !opts[:'sort'].nil? && opts[:'sort'] !~ pattern
366
- fail ArgumentError, "invalid value for 'opts[:\"sort\"]' when calling PayeesApi.list_payees_v3, must conform to the pattern #{pattern}."
950
+ fail ArgumentError, "invalid value for 'opts[:\"sort\"]' when calling PayeesApi.list_payees_v4, must conform to the pattern #{pattern}."
367
951
  end
368
952
 
369
953
  # resource path
370
- local_var_path = '/v3/payees'
954
+ local_var_path = '/v4/payees'
371
955
 
372
956
  # query parameters
373
957
  query_params = opts[:query_params] || {}
374
958
  query_params[:'payorId'] = payor_id
375
- query_params[:'ofacStatus'] = opts[:'ofac_status'] if !opts[:'ofac_status'].nil?
959
+ query_params[:'watchlistStatus'] = opts[:'watchlist_status'] if !opts[:'watchlist_status'].nil?
960
+ query_params[:'disabled'] = opts[:'disabled'] if !opts[:'disabled'].nil?
376
961
  query_params[:'onboardedStatus'] = opts[:'onboarded_status'] if !opts[:'onboarded_status'].nil?
377
- query_params[:'Email'] = opts[:'email'] if !opts[:'email'].nil?
962
+ query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
378
963
  query_params[:'displayName'] = opts[:'display_name'] if !opts[:'display_name'].nil?
379
964
  query_params[:'remoteId'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
380
965
  query_params[:'payeeType'] = opts[:'payee_type'] if !opts[:'payee_type'].nil?
381
966
  query_params[:'payeeCountry'] = opts[:'payee_country'] if !opts[:'payee_country'].nil?
967
+ query_params[:'ofacStatus'] = opts[:'ofac_status'] if !opts[:'ofac_status'].nil?
382
968
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
383
969
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
384
970
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
@@ -392,15 +978,16 @@ module VeloPayments
392
978
  form_params = opts[:form_params] || {}
393
979
 
394
980
  # http body (model)
395
- post_body = opts[:body]
981
+ post_body = opts[:debug_body]
396
982
 
397
983
  # return_type
398
- return_type = opts[:return_type] || 'PagedPayeeResponse2'
984
+ return_type = opts[:debug_return_type] || 'PagedPayeeResponse2'
399
985
 
400
986
  # auth_names
401
- auth_names = opts[:auth_names] || ['OAuth2']
987
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
402
988
 
403
989
  new_options = opts.merge(
990
+ :operation => :"PayeesApi.list_payees_v4",
404
991
  :header_params => header_params,
405
992
  :query_params => query_params,
406
993
  :form_params => form_params,
@@ -411,15 +998,157 @@ module VeloPayments
411
998
 
412
999
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
413
1000
  if @api_client.config.debugging
414
- @api_client.config.logger.debug "API called: PayeesApi#list_payees_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1001
+ @api_client.config.logger.debug "API called: PayeesApi#list_payees_v4\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1002
+ end
1003
+ return data, status_code, headers
1004
+ end
1005
+
1006
+ # Update Payee Details
1007
+ # <p>Update payee details for the given Payee Id.<p>
1008
+ # @param payee_id [String] The UUID of the payee.
1009
+ # @param update_payee_details_request [UpdatePayeeDetailsRequest] Request to update payee details
1010
+ # @param [Hash] opts the optional parameters
1011
+ # @return [nil]
1012
+ def payee_details_update_v3(payee_id, update_payee_details_request, opts = {})
1013
+ payee_details_update_v3_with_http_info(payee_id, update_payee_details_request, opts)
1014
+ nil
1015
+ end
1016
+
1017
+ # Update Payee Details
1018
+ # &lt;p&gt;Update payee details for the given Payee Id.&lt;p&gt;
1019
+ # @param payee_id [String] The UUID of the payee.
1020
+ # @param update_payee_details_request [UpdatePayeeDetailsRequest] Request to update payee details
1021
+ # @param [Hash] opts the optional parameters
1022
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1023
+ def payee_details_update_v3_with_http_info(payee_id, update_payee_details_request, opts = {})
1024
+ if @api_client.config.debugging
1025
+ @api_client.config.logger.debug 'Calling API: PayeesApi.payee_details_update_v3 ...'
1026
+ end
1027
+ # verify the required parameter 'payee_id' is set
1028
+ if @api_client.config.client_side_validation && payee_id.nil?
1029
+ fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeesApi.payee_details_update_v3"
1030
+ end
1031
+ # verify the required parameter 'update_payee_details_request' is set
1032
+ if @api_client.config.client_side_validation && update_payee_details_request.nil?
1033
+ fail ArgumentError, "Missing the required parameter 'update_payee_details_request' when calling PayeesApi.payee_details_update_v3"
1034
+ end
1035
+ # resource path
1036
+ local_var_path = '/v3/payees/{payeeId}/payeeDetailsUpdate'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s))
1037
+
1038
+ # query parameters
1039
+ query_params = opts[:query_params] || {}
1040
+
1041
+ # header parameters
1042
+ header_params = opts[:header_params] || {}
1043
+ # HTTP header 'Accept' (if needed)
1044
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1045
+ # HTTP header 'Content-Type'
1046
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1047
+
1048
+ # form parameters
1049
+ form_params = opts[:form_params] || {}
1050
+
1051
+ # http body (model)
1052
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(update_payee_details_request)
1053
+
1054
+ # return_type
1055
+ return_type = opts[:debug_return_type]
1056
+
1057
+ # auth_names
1058
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
1059
+
1060
+ new_options = opts.merge(
1061
+ :operation => :"PayeesApi.payee_details_update_v3",
1062
+ :header_params => header_params,
1063
+ :query_params => query_params,
1064
+ :form_params => form_params,
1065
+ :body => post_body,
1066
+ :auth_names => auth_names,
1067
+ :return_type => return_type
1068
+ )
1069
+
1070
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1071
+ if @api_client.config.debugging
1072
+ @api_client.config.logger.debug "API called: PayeesApi#payee_details_update_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1073
+ end
1074
+ return data, status_code, headers
1075
+ end
1076
+
1077
+ # Update Payee Details
1078
+ # <p>Update payee details for the given Payee Id.<p>
1079
+ # @param payee_id [String] The UUID of the payee.
1080
+ # @param update_payee_details_request2 [UpdatePayeeDetailsRequest2] Request to update payee details
1081
+ # @param [Hash] opts the optional parameters
1082
+ # @return [nil]
1083
+ def payee_details_update_v4(payee_id, update_payee_details_request2, opts = {})
1084
+ payee_details_update_v4_with_http_info(payee_id, update_payee_details_request2, opts)
1085
+ nil
1086
+ end
1087
+
1088
+ # Update Payee Details
1089
+ # &lt;p&gt;Update payee details for the given Payee Id.&lt;p&gt;
1090
+ # @param payee_id [String] The UUID of the payee.
1091
+ # @param update_payee_details_request2 [UpdatePayeeDetailsRequest2] Request to update payee details
1092
+ # @param [Hash] opts the optional parameters
1093
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1094
+ def payee_details_update_v4_with_http_info(payee_id, update_payee_details_request2, opts = {})
1095
+ if @api_client.config.debugging
1096
+ @api_client.config.logger.debug 'Calling API: PayeesApi.payee_details_update_v4 ...'
1097
+ end
1098
+ # verify the required parameter 'payee_id' is set
1099
+ if @api_client.config.client_side_validation && payee_id.nil?
1100
+ fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeesApi.payee_details_update_v4"
1101
+ end
1102
+ # verify the required parameter 'update_payee_details_request2' is set
1103
+ if @api_client.config.client_side_validation && update_payee_details_request2.nil?
1104
+ fail ArgumentError, "Missing the required parameter 'update_payee_details_request2' when calling PayeesApi.payee_details_update_v4"
1105
+ end
1106
+ # resource path
1107
+ local_var_path = '/v4/payees/{payeeId}/payeeDetailsUpdate'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s))
1108
+
1109
+ # query parameters
1110
+ query_params = opts[:query_params] || {}
1111
+
1112
+ # header parameters
1113
+ header_params = opts[:header_params] || {}
1114
+ # HTTP header 'Accept' (if needed)
1115
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1116
+ # HTTP header 'Content-Type'
1117
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1118
+
1119
+ # form parameters
1120
+ form_params = opts[:form_params] || {}
1121
+
1122
+ # http body (model)
1123
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(update_payee_details_request2)
1124
+
1125
+ # return_type
1126
+ return_type = opts[:debug_return_type]
1127
+
1128
+ # auth_names
1129
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
1130
+
1131
+ new_options = opts.merge(
1132
+ :operation => :"PayeesApi.payee_details_update_v4",
1133
+ :header_params => header_params,
1134
+ :query_params => query_params,
1135
+ :form_params => form_params,
1136
+ :body => post_body,
1137
+ :auth_names => auth_names,
1138
+ :return_type => return_type
1139
+ )
1140
+
1141
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1142
+ if @api_client.config.debugging
1143
+ @api_client.config.logger.debug "API called: PayeesApi#payee_details_update_v4\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
415
1144
  end
416
1145
  return data, status_code, headers
417
1146
  end
418
1147
 
419
1148
  # Update Payee Remote Id
420
- # Update the remote Id for the given Payee Id.
1149
+ # <p>Update the remote Id for the given Payee Id.</p> <p>Please use V3 instead</p>
421
1150
  # @param payee_id [String] The UUID of the payee.
422
- # @param update_remote_id_request [UpdateRemoteIdRequest] Request to update payee remote id
1151
+ # @param update_remote_id_request [UpdateRemoteIdRequest] Request to update payee remote id v1
423
1152
  # @param [Hash] opts the optional parameters
424
1153
  # @return [nil]
425
1154
  def v1_payees_payee_id_remote_id_update_post(payee_id, update_remote_id_request, opts = {})
@@ -428,9 +1157,9 @@ module VeloPayments
428
1157
  end
429
1158
 
430
1159
  # Update Payee Remote Id
431
- # Update the remote Id for the given Payee Id.
1160
+ # &lt;p&gt;Update the remote Id for the given Payee Id.&lt;/p&gt; &lt;p&gt;Please use V3 instead&lt;/p&gt;
432
1161
  # @param payee_id [String] The UUID of the payee.
433
- # @param update_remote_id_request [UpdateRemoteIdRequest] Request to update payee remote id
1162
+ # @param update_remote_id_request [UpdateRemoteIdRequest] Request to update payee remote id v1
434
1163
  # @param [Hash] opts the optional parameters
435
1164
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
436
1165
  def v1_payees_payee_id_remote_id_update_post_with_http_info(payee_id, update_remote_id_request, opts = {})
@@ -462,15 +1191,16 @@ module VeloPayments
462
1191
  form_params = opts[:form_params] || {}
463
1192
 
464
1193
  # http body (model)
465
- post_body = opts[:body] || @api_client.object_to_http_body(update_remote_id_request)
1194
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(update_remote_id_request)
466
1195
 
467
1196
  # return_type
468
- return_type = opts[:return_type]
1197
+ return_type = opts[:debug_return_type]
469
1198
 
470
1199
  # auth_names
471
- auth_names = opts[:auth_names] || ['OAuth2']
1200
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
472
1201
 
473
1202
  new_options = opts.merge(
1203
+ :operation => :"PayeesApi.v1_payees_payee_id_remote_id_update_post",
474
1204
  :header_params => header_params,
475
1205
  :query_params => query_params,
476
1206
  :form_params => form_params,
@@ -485,5 +1215,147 @@ module VeloPayments
485
1215
  end
486
1216
  return data, status_code, headers
487
1217
  end
1218
+
1219
+ # Update Payee Remote Id
1220
+ # <p>Update the remote Id for the given Payee Id.</p>
1221
+ # @param payee_id [String] The UUID of the payee.
1222
+ # @param update_remote_id_request [UpdateRemoteIdRequest] Request to update payee remote id v3
1223
+ # @param [Hash] opts the optional parameters
1224
+ # @return [nil]
1225
+ def v3_payees_payee_id_remote_id_update_post(payee_id, update_remote_id_request, opts = {})
1226
+ v3_payees_payee_id_remote_id_update_post_with_http_info(payee_id, update_remote_id_request, opts)
1227
+ nil
1228
+ end
1229
+
1230
+ # Update Payee Remote Id
1231
+ # &lt;p&gt;Update the remote Id for the given Payee Id.&lt;/p&gt;
1232
+ # @param payee_id [String] The UUID of the payee.
1233
+ # @param update_remote_id_request [UpdateRemoteIdRequest] Request to update payee remote id v3
1234
+ # @param [Hash] opts the optional parameters
1235
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1236
+ def v3_payees_payee_id_remote_id_update_post_with_http_info(payee_id, update_remote_id_request, opts = {})
1237
+ if @api_client.config.debugging
1238
+ @api_client.config.logger.debug 'Calling API: PayeesApi.v3_payees_payee_id_remote_id_update_post ...'
1239
+ end
1240
+ # verify the required parameter 'payee_id' is set
1241
+ if @api_client.config.client_side_validation && payee_id.nil?
1242
+ fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeesApi.v3_payees_payee_id_remote_id_update_post"
1243
+ end
1244
+ # verify the required parameter 'update_remote_id_request' is set
1245
+ if @api_client.config.client_side_validation && update_remote_id_request.nil?
1246
+ fail ArgumentError, "Missing the required parameter 'update_remote_id_request' when calling PayeesApi.v3_payees_payee_id_remote_id_update_post"
1247
+ end
1248
+ # resource path
1249
+ local_var_path = '/v3/payees/{payeeId}/remoteIdUpdate'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s))
1250
+
1251
+ # query parameters
1252
+ query_params = opts[:query_params] || {}
1253
+
1254
+ # header parameters
1255
+ header_params = opts[:header_params] || {}
1256
+ # HTTP header 'Accept' (if needed)
1257
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1258
+ # HTTP header 'Content-Type'
1259
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1260
+
1261
+ # form parameters
1262
+ form_params = opts[:form_params] || {}
1263
+
1264
+ # http body (model)
1265
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(update_remote_id_request)
1266
+
1267
+ # return_type
1268
+ return_type = opts[:debug_return_type]
1269
+
1270
+ # auth_names
1271
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
1272
+
1273
+ new_options = opts.merge(
1274
+ :operation => :"PayeesApi.v3_payees_payee_id_remote_id_update_post",
1275
+ :header_params => header_params,
1276
+ :query_params => query_params,
1277
+ :form_params => form_params,
1278
+ :body => post_body,
1279
+ :auth_names => auth_names,
1280
+ :return_type => return_type
1281
+ )
1282
+
1283
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1284
+ if @api_client.config.debugging
1285
+ @api_client.config.logger.debug "API called: PayeesApi#v3_payees_payee_id_remote_id_update_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1286
+ end
1287
+ return data, status_code, headers
1288
+ end
1289
+
1290
+ # Update Payee Remote Id
1291
+ # <p>Update the remote Id for the given Payee Id.</p>
1292
+ # @param payee_id [String] The UUID of the payee.
1293
+ # @param update_remote_id_request [UpdateRemoteIdRequest] Request to update payee remote id v4
1294
+ # @param [Hash] opts the optional parameters
1295
+ # @return [nil]
1296
+ def v4_payees_payee_id_remote_id_update_post(payee_id, update_remote_id_request, opts = {})
1297
+ v4_payees_payee_id_remote_id_update_post_with_http_info(payee_id, update_remote_id_request, opts)
1298
+ nil
1299
+ end
1300
+
1301
+ # Update Payee Remote Id
1302
+ # &lt;p&gt;Update the remote Id for the given Payee Id.&lt;/p&gt;
1303
+ # @param payee_id [String] The UUID of the payee.
1304
+ # @param update_remote_id_request [UpdateRemoteIdRequest] Request to update payee remote id v4
1305
+ # @param [Hash] opts the optional parameters
1306
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1307
+ def v4_payees_payee_id_remote_id_update_post_with_http_info(payee_id, update_remote_id_request, opts = {})
1308
+ if @api_client.config.debugging
1309
+ @api_client.config.logger.debug 'Calling API: PayeesApi.v4_payees_payee_id_remote_id_update_post ...'
1310
+ end
1311
+ # verify the required parameter 'payee_id' is set
1312
+ if @api_client.config.client_side_validation && payee_id.nil?
1313
+ fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeesApi.v4_payees_payee_id_remote_id_update_post"
1314
+ end
1315
+ # verify the required parameter 'update_remote_id_request' is set
1316
+ if @api_client.config.client_side_validation && update_remote_id_request.nil?
1317
+ fail ArgumentError, "Missing the required parameter 'update_remote_id_request' when calling PayeesApi.v4_payees_payee_id_remote_id_update_post"
1318
+ end
1319
+ # resource path
1320
+ local_var_path = '/v4/payees/{payeeId}/remoteIdUpdate'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s))
1321
+
1322
+ # query parameters
1323
+ query_params = opts[:query_params] || {}
1324
+
1325
+ # header parameters
1326
+ header_params = opts[:header_params] || {}
1327
+ # HTTP header 'Accept' (if needed)
1328
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1329
+ # HTTP header 'Content-Type'
1330
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1331
+
1332
+ # form parameters
1333
+ form_params = opts[:form_params] || {}
1334
+
1335
+ # http body (model)
1336
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(update_remote_id_request)
1337
+
1338
+ # return_type
1339
+ return_type = opts[:debug_return_type]
1340
+
1341
+ # auth_names
1342
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
1343
+
1344
+ new_options = opts.merge(
1345
+ :operation => :"PayeesApi.v4_payees_payee_id_remote_id_update_post",
1346
+ :header_params => header_params,
1347
+ :query_params => query_params,
1348
+ :form_params => form_params,
1349
+ :body => post_body,
1350
+ :auth_names => auth_names,
1351
+ :return_type => return_type
1352
+ )
1353
+
1354
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1355
+ if @api_client.config.debugging
1356
+ @api_client.config.logger.debug "API called: PayeesApi#v4_payees_payee_id_remote_id_update_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1357
+ end
1358
+ return data, status_code, headers
1359
+ end
488
1360
  end
489
1361
  end