velopayments 2.20.119 → 2.23.78.beta1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (697) hide show
  1. checksums.yaml +5 -5
  2. data/Makefile +5 -2
  3. data/README.md +116 -45
  4. data/docs/{AcceptedPayment.md → AcceptedPaymentV3.md} +2 -2
  5. data/docs/AutoTopUpConfig2.md +23 -0
  6. data/docs/Challenge2.md +19 -0
  7. data/docs/CountriesApi.md +25 -25
  8. data/docs/CreateFundingAccountRequestV2.md +29 -0
  9. data/docs/CreatePayee2.md +3 -3
  10. data/docs/CreatePayeesCSVResponseRejectedCsvRows.md +1 -1
  11. data/docs/{CreatePayoutRequest.md → CreatePayoutRequestV3.md} +3 -3
  12. data/docs/CreateWebhookRequest.md +23 -0
  13. data/docs/CurrenciesApi.md +6 -6
  14. data/docs/FundingAccountResponse.md +15 -7
  15. data/docs/FundingAccountResponse2.md +35 -0
  16. data/docs/{CurrencyType.md → FundingAccountType.md} +2 -3
  17. data/docs/FundingAudit.md +5 -5
  18. data/docs/FundingEvent.md +1 -1
  19. data/docs/FundingManagerApi.md +329 -32
  20. data/docs/FundingManagerPrivateApi.md +7 -7
  21. data/docs/FundingPayorStatusAuditResponse.md +2 -2
  22. data/docs/FundingRequestV3.md +19 -0
  23. data/docs/FxSummaryV3.md +1 -1
  24. data/docs/FxSummaryV4.md +1 -1
  25. data/docs/GetFundingsResponse.md +5 -1
  26. data/docs/GetFundingsResponseLinks.md +19 -0
  27. data/docs/GetPayeeListResponse.md +49 -0
  28. data/docs/GetPayeeListResponseCompany.md +19 -0
  29. data/docs/GetPayeeListResponseIndividual.md +17 -0
  30. data/docs/GetPaymentsForPayoutResponseV3Summary.md +3 -3
  31. data/docs/GetPaymentsForPayoutResponseV4Summary.md +6 -4
  32. data/docs/InlineResponse404.md +19 -0
  33. data/docs/InlineResponse404Errors.md +23 -0
  34. data/docs/InlineResponse412.md +19 -0
  35. data/docs/InlineResponse412Errors.md +23 -0
  36. data/docs/{UserResponse2Roles.md → InvitationStatus2.md} +2 -3
  37. data/docs/ListFundingAccountsResponse2.md +21 -0
  38. data/docs/{ListPaymentsResponse.md → ListPaymentsResponseV3.md} +3 -3
  39. data/docs/{ListPaymentsResponsePage.md → ListPaymentsResponseV3Page.md} +2 -2
  40. data/docs/ListPaymentsResponseV4.md +1 -1
  41. data/docs/ListSourceAccountResponseV2.md +1 -1
  42. data/docs/ListSourceAccountResponseV2Links.md +19 -0
  43. data/docs/ListSourceAccountResponseV3.md +21 -0
  44. data/docs/ListSourceAccountResponseV3Links.md +19 -0
  45. data/docs/LoginApi.md +6 -2
  46. data/docs/MarketingOptIn.md +1 -1
  47. data/docs/Name.md +23 -0
  48. data/docs/Notifications2.md +17 -0
  49. data/docs/PagedPayeeResponse2.md +1 -1
  50. data/docs/PagedPaymentsResponseV3.md +21 -0
  51. data/docs/Payee.md +2 -2
  52. data/docs/Payee2.md +2 -2
  53. data/docs/{PayeeResponseV3.md → PayeeDetailResponse.md} +9 -7
  54. data/docs/PayeeDetailResponse2.md +73 -0
  55. data/docs/PayeeInvitationApi.md +227 -2
  56. data/docs/PayeePayorRef2.md +25 -0
  57. data/docs/PayeePayorRefV2.md +1 -1
  58. data/docs/PayeePayorRefV3.md +3 -3
  59. data/docs/PayeeResponse.md +2 -2
  60. data/docs/PayeeResponseV2.md +3 -3
  61. data/docs/PayeeType2.md +16 -0
  62. data/docs/PayeeUserSelfUpdateRequest.md +27 -0
  63. data/docs/PayeesApi.md +421 -8
  64. data/docs/PaymentAuditServiceApi.md +267 -35
  65. data/docs/PaymentDeltaResponseV4.md +21 -0
  66. data/docs/PaymentDeltaV4.md +31 -0
  67. data/docs/PaymentEventResponseV3.md +1 -1
  68. data/docs/PaymentEventResponseV4.md +1 -1
  69. data/docs/{PaymentInstruction.md → PaymentInstructionV3.md} +5 -3
  70. data/docs/PaymentResponseV3.md +1 -1
  71. data/docs/PaymentResponseV4.md +7 -1
  72. data/docs/PaymentV3.md +37 -0
  73. data/docs/PayorV1.md +3 -1
  74. data/docs/PayorV2.md +5 -1
  75. data/docs/PayorsApi.md +14 -14
  76. data/docs/PayoutCompanyV3.md +17 -0
  77. data/docs/PayoutIndividualV3.md +17 -0
  78. data/docs/PayoutNameV3.md +19 -0
  79. data/docs/PayoutPayeeV3.md +21 -0
  80. data/docs/PayoutServiceApi.md +393 -0
  81. data/docs/PayoutSummaryAuditV4.md +4 -2
  82. data/docs/{PayoutSummaryResponse.md → PayoutSummaryResponseV3.md} +8 -6
  83. data/docs/PingResponse.md +19 -0
  84. data/docs/{QuoteFxSummary.md → QuoteFxSummaryV3.md} +4 -4
  85. data/docs/QuoteResponseV3.md +17 -0
  86. data/docs/{Region.md → RegionV2.md} +2 -2
  87. data/docs/{RejectedPayment.md → RejectedPaymentV3.md} +2 -2
  88. data/docs/SourceAccountResponse.md +3 -1
  89. data/docs/SourceAccountResponseV2.md +4 -2
  90. data/docs/SourceAccountResponseV3.md +47 -0
  91. data/docs/SourceAccountType.md +16 -0
  92. data/docs/{SourceAccount.md → SourceAccountV3.md} +2 -2
  93. data/docs/SupportedCountriesResponseV2.md +17 -0
  94. data/docs/{SupportedCountry2.md → SupportedCountryV2.md} +3 -3
  95. data/docs/SupportedCurrencyResponseV2.md +17 -0
  96. data/docs/{SupportedCurrency.md → SupportedCurrencyV2.md} +2 -2
  97. data/docs/TransferRequest2.md +21 -0
  98. data/docs/TransmissionType.md +16 -0
  99. data/docs/TransmissionTypes.md +21 -0
  100. data/docs/TransmissionTypes2.md +21 -0
  101. data/docs/UpdatePayeeDetailsRequest.md +29 -0
  102. data/docs/UpdatePayeeDetailsRequest2.md +29 -0
  103. data/docs/UpdateWebhookRequest.md +21 -0
  104. data/docs/UserResponse.md +1 -1
  105. data/docs/UsersApi.md +62 -6
  106. data/docs/WatchlistStatus2.md +16 -0
  107. data/docs/WebhookResponse.md +25 -0
  108. data/docs/WebhooksApi.md +280 -0
  109. data/docs/WebhooksResponse.md +21 -0
  110. data/docs/WithdrawPaymentRequest.md +17 -0
  111. data/lib/velopayments.rb +68 -32
  112. data/lib/velopayments/api/countries_api.rb +38 -35
  113. data/lib/velopayments/api/currencies_api.rb +13 -12
  114. data/lib/velopayments/api/funding_manager_api.rb +516 -74
  115. data/lib/velopayments/api/funding_manager_private_api.rb +14 -13
  116. data/lib/velopayments/api/login_api.rb +21 -14
  117. data/lib/velopayments/api/payee_invitation_api.rb +312 -33
  118. data/lib/velopayments/api/payees_api.rb +582 -46
  119. data/lib/velopayments/api/payment_audit_service_api.rb +444 -78
  120. data/lib/velopayments/api/payors_api.rb +48 -40
  121. data/lib/velopayments/api/payors_private_api.rb +6 -5
  122. data/lib/velopayments/api/payout_service_api.rb +506 -0
  123. data/lib/velopayments/api/tokens_api.rb +6 -5
  124. data/lib/velopayments/api/users_api.rb +146 -54
  125. data/lib/velopayments/api/webhooks_api.rb +350 -0
  126. data/lib/velopayments/api_client.rb +47 -44
  127. data/lib/velopayments/api_error.rb +2 -2
  128. data/lib/velopayments/configuration.rb +35 -8
  129. data/lib/velopayments/models/{accepted_payment.rb → accepted_payment_v3.rb} +13 -9
  130. data/lib/velopayments/models/access_token_response.rb +10 -6
  131. data/lib/velopayments/models/access_token_validation_request.rb +10 -6
  132. data/lib/velopayments/models/auth_response.rb +10 -6
  133. data/lib/velopayments/models/auto_top_up_config.rb +10 -6
  134. data/lib/velopayments/models/auto_top_up_config2.rb +248 -0
  135. data/lib/velopayments/models/challenge.rb +10 -6
  136. data/lib/velopayments/models/challenge2.rb +285 -0
  137. data/lib/velopayments/models/company.rb +15 -11
  138. data/lib/velopayments/models/company2.rb +15 -11
  139. data/lib/velopayments/models/company_response.rb +10 -6
  140. data/lib/velopayments/models/company_v1.rb +15 -11
  141. data/lib/velopayments/models/create_funding_account_request_v2.rb +441 -0
  142. data/lib/velopayments/models/create_individual.rb +10 -6
  143. data/lib/velopayments/models/create_individual2.rb +10 -6
  144. data/lib/velopayments/models/create_individual2_name.rb +10 -6
  145. data/lib/velopayments/models/create_payee.rb +10 -6
  146. data/lib/velopayments/models/create_payee2.rb +13 -9
  147. data/lib/velopayments/models/create_payee_address.rb +10 -6
  148. data/lib/velopayments/models/create_payee_address2.rb +10 -6
  149. data/lib/velopayments/models/create_payees_csv_request.rb +10 -6
  150. data/lib/velopayments/models/create_payees_csv_request2.rb +10 -6
  151. data/lib/velopayments/models/create_payees_csv_response.rb +10 -6
  152. data/lib/velopayments/models/create_payees_csv_response2.rb +10 -6
  153. data/lib/velopayments/models/create_payees_csv_response_rejected_csv_rows.rb +10 -6
  154. data/lib/velopayments/models/create_payees_request.rb +10 -6
  155. data/lib/velopayments/models/create_payees_request2.rb +10 -6
  156. data/lib/velopayments/models/create_payment_channel.rb +10 -6
  157. data/lib/velopayments/models/create_payment_channel2.rb +10 -6
  158. data/lib/velopayments/models/create_payor_link_request.rb +10 -6
  159. data/lib/velopayments/models/{create_payout_request.rb → create_payout_request_v3.rb} +14 -10
  160. data/lib/velopayments/models/create_webhook_request.rb +315 -0
  161. data/lib/velopayments/models/error.rb +10 -6
  162. data/lib/velopayments/models/error_response.rb +10 -6
  163. data/lib/velopayments/models/failed_submission.rb +10 -6
  164. data/lib/velopayments/models/failed_submission2.rb +10 -6
  165. data/lib/velopayments/models/funding_account_response.rb +105 -10
  166. data/lib/velopayments/models/{create_funding_account_request.rb → funding_account_response2.rb} +106 -95
  167. data/lib/velopayments/models/funding_account_type.rb +37 -0
  168. data/lib/velopayments/models/funding_audit.rb +23 -17
  169. data/lib/velopayments/models/funding_event.rb +11 -7
  170. data/lib/velopayments/models/funding_event_type.rb +3 -2
  171. data/lib/velopayments/models/funding_payor_status_audit_response.rb +47 -7
  172. data/lib/velopayments/models/funding_request_v1.rb +10 -6
  173. data/lib/velopayments/models/funding_request_v2.rb +10 -6
  174. data/lib/velopayments/models/funding_request_v3.rb +259 -0
  175. data/lib/velopayments/models/fx_summary_v3.rb +11 -7
  176. data/lib/velopayments/models/fx_summary_v4.rb +11 -7
  177. data/lib/velopayments/models/get_fundings_response.rb +37 -24
  178. data/lib/velopayments/models/{paged_response.rb → get_fundings_response_links.rb} +26 -24
  179. data/lib/velopayments/models/{payee_response2.rb → get_payee_list_response.rb} +85 -113
  180. data/lib/velopayments/models/get_payee_list_response_company.rb +268 -0
  181. data/lib/velopayments/models/{user_response2_roles.rb → get_payee_list_response_individual.rb} +14 -10
  182. data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +10 -6
  183. data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +10 -6
  184. data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +13 -9
  185. data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +10 -6
  186. data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +25 -11
  187. data/lib/velopayments/models/get_payout_statistics.rb +10 -6
  188. data/lib/velopayments/models/get_payouts_response_v3.rb +10 -6
  189. data/lib/velopayments/models/get_payouts_response_v3_links.rb +10 -6
  190. data/lib/velopayments/models/get_payouts_response_v3_page.rb +10 -6
  191. data/lib/velopayments/models/get_payouts_response_v4.rb +10 -6
  192. data/lib/velopayments/models/individual.rb +10 -6
  193. data/lib/velopayments/models/individual2.rb +10 -6
  194. data/lib/velopayments/models/individual_response.rb +10 -6
  195. data/lib/velopayments/models/individual_v1.rb +10 -6
  196. data/lib/velopayments/models/individual_v1_name.rb +10 -6
  197. data/lib/velopayments/models/inline_response400.rb +10 -6
  198. data/lib/velopayments/models/inline_response400_errors.rb +10 -6
  199. data/lib/velopayments/models/inline_response401.rb +10 -6
  200. data/lib/velopayments/models/inline_response401_errors.rb +10 -6
  201. data/lib/velopayments/models/inline_response403.rb +10 -6
  202. data/lib/velopayments/models/inline_response403_errors.rb +10 -6
  203. data/lib/velopayments/models/inline_response404.rb +225 -0
  204. data/lib/velopayments/models/inline_response404_errors.rb +240 -0
  205. data/lib/velopayments/models/inline_response409.rb +10 -6
  206. data/lib/velopayments/models/inline_response409_errors.rb +10 -6
  207. data/lib/velopayments/models/inline_response412.rb +225 -0
  208. data/lib/velopayments/models/inline_response412_errors.rb +240 -0
  209. data/lib/velopayments/models/invitation_status.rb +3 -2
  210. data/lib/velopayments/models/invitation_status2.rb +38 -0
  211. data/lib/velopayments/models/invitation_status_response.rb +10 -6
  212. data/lib/velopayments/models/invite_payee_request.rb +10 -6
  213. data/lib/velopayments/models/invite_payee_request2.rb +10 -6
  214. data/lib/velopayments/models/invite_user_request.rb +19 -15
  215. data/lib/velopayments/models/kyc_state.rb +3 -2
  216. data/lib/velopayments/models/language.rb +3 -2
  217. data/lib/velopayments/models/language2.rb +3 -2
  218. data/lib/velopayments/models/link_for_response.rb +10 -6
  219. data/lib/velopayments/models/list_funding_accounts_response.rb +10 -6
  220. data/lib/velopayments/models/list_funding_accounts_response2.rb +233 -0
  221. data/lib/velopayments/models/{list_payments_response.rb → list_payments_response_v3.rb} +14 -10
  222. data/lib/velopayments/models/{paged_response_page.rb → list_payments_response_v3_page.rb} +13 -9
  223. data/lib/velopayments/models/list_payments_response_v4.rb +11 -7
  224. data/lib/velopayments/models/list_source_account_response.rb +10 -6
  225. data/lib/velopayments/models/list_source_account_response_links.rb +10 -6
  226. data/lib/velopayments/models/list_source_account_response_page.rb +10 -6
  227. data/lib/velopayments/models/list_source_account_response_v2.rb +11 -7
  228. data/lib/velopayments/models/list_source_account_response_v2_links.rb +219 -0
  229. data/lib/velopayments/models/list_source_account_response_v3.rb +233 -0
  230. data/lib/velopayments/models/list_source_account_response_v3_links.rb +219 -0
  231. data/lib/velopayments/models/location_type.rb +3 -2
  232. data/lib/velopayments/models/marketing_opt_in.rb +11 -7
  233. data/lib/velopayments/models/mfa_details.rb +10 -6
  234. data/lib/velopayments/models/mfa_type.rb +3 -2
  235. data/lib/velopayments/models/name.rb +333 -0
  236. data/lib/velopayments/models/notifications.rb +10 -6
  237. data/lib/velopayments/models/{get_fundings_response_all_of.rb → notifications2.rb} +20 -18
  238. data/lib/velopayments/models/ofac_status.rb +3 -2
  239. data/lib/velopayments/models/ofac_status2.rb +3 -2
  240. data/lib/velopayments/models/onboarded_status.rb +3 -2
  241. data/lib/velopayments/models/onboarded_status2.rb +3 -2
  242. data/lib/velopayments/models/page_for_response.rb +10 -6
  243. data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +10 -6
  244. data/lib/velopayments/models/paged_payee_invitation_status_response.rb +10 -6
  245. data/lib/velopayments/models/paged_payee_invitation_status_response2.rb +10 -6
  246. data/lib/velopayments/models/paged_payee_invitation_status_response_page.rb +10 -6
  247. data/lib/velopayments/models/paged_payee_response.rb +10 -6
  248. data/lib/velopayments/models/paged_payee_response2.rb +11 -7
  249. data/lib/velopayments/models/paged_payee_response2_summary.rb +10 -6
  250. data/lib/velopayments/models/paged_payee_response_links.rb +10 -6
  251. data/lib/velopayments/models/paged_payee_response_page.rb +10 -6
  252. data/lib/velopayments/models/paged_payee_response_summary.rb +10 -6
  253. data/lib/velopayments/models/paged_payments_response_v3.rb +233 -0
  254. data/lib/velopayments/models/paged_user_response.rb +10 -6
  255. data/lib/velopayments/models/paged_user_response_links.rb +10 -6
  256. data/lib/velopayments/models/paged_user_response_page.rb +10 -6
  257. data/lib/velopayments/models/password_request.rb +10 -6
  258. data/lib/velopayments/models/payee.rb +12 -8
  259. data/lib/velopayments/models/payee2.rb +12 -8
  260. data/lib/velopayments/models/payee_address.rb +10 -6
  261. data/lib/velopayments/models/payee_address2.rb +10 -6
  262. data/lib/velopayments/models/payee_delta.rb +10 -6
  263. data/lib/velopayments/models/payee_delta2.rb +10 -6
  264. data/lib/velopayments/models/payee_delta_response.rb +10 -6
  265. data/lib/velopayments/models/payee_delta_response2.rb +10 -6
  266. data/lib/velopayments/models/payee_delta_response2_links.rb +10 -6
  267. data/lib/velopayments/models/payee_delta_response_links.rb +10 -6
  268. data/lib/velopayments/models/payee_delta_response_page.rb +10 -6
  269. data/lib/velopayments/models/{payee_response_v3.rb → payee_detail_response.rb} +30 -17
  270. data/lib/velopayments/models/payee_detail_response2.rb +475 -0
  271. data/lib/velopayments/models/payee_invitation_status.rb +10 -6
  272. data/lib/velopayments/models/payee_invitation_status_response.rb +10 -6
  273. data/lib/velopayments/models/payee_invitation_status_response2.rb +10 -6
  274. data/lib/velopayments/models/payee_payment_channel.rb +10 -6
  275. data/lib/velopayments/models/payee_payment_channel2.rb +10 -6
  276. data/lib/velopayments/models/payee_payor_ref.rb +10 -6
  277. data/lib/velopayments/models/payee_payor_ref2.rb +248 -0
  278. data/lib/velopayments/models/payee_payor_ref_v2.rb +11 -7
  279. data/lib/velopayments/models/payee_payor_ref_v3.rb +12 -42
  280. data/lib/velopayments/models/payee_response.rb +12 -8
  281. data/lib/velopayments/models/payee_response_v2.rb +13 -9
  282. data/lib/velopayments/models/payee_type.rb +3 -2
  283. data/lib/velopayments/models/payee_type2.rb +37 -0
  284. data/lib/velopayments/models/{user_response2.rb → payee_user_self_update_request.rb} +54 -194
  285. data/lib/velopayments/models/payment_audit_currency_v3.rb +3 -2
  286. data/lib/velopayments/models/payment_audit_currency_v4.rb +3 -2
  287. data/lib/velopayments/models/payment_channel_country.rb +10 -6
  288. data/lib/velopayments/models/payment_channel_rule.rb +10 -6
  289. data/lib/velopayments/models/payment_channel_rules_response.rb +10 -6
  290. data/lib/velopayments/models/payment_delta.rb +10 -6
  291. data/lib/velopayments/models/payment_delta_response.rb +10 -6
  292. data/lib/velopayments/models/payment_delta_response_v4.rb +233 -0
  293. data/lib/velopayments/models/payment_delta_v4.rb +289 -0
  294. data/lib/velopayments/models/payment_event_response_v3.rb +11 -7
  295. data/lib/velopayments/models/payment_event_response_v4.rb +11 -7
  296. data/lib/velopayments/models/{payment_instruction.rb → payment_instruction_v3.rb} +27 -13
  297. data/lib/velopayments/models/payment_rails.rb +3 -2
  298. data/lib/velopayments/models/payment_response_v3.rb +11 -7
  299. data/lib/velopayments/models/payment_response_v4.rb +39 -8
  300. data/lib/velopayments/models/payment_response_v4_payout.rb +10 -6
  301. data/lib/velopayments/models/payment_v3.rb +363 -0
  302. data/lib/velopayments/models/payor_address.rb +10 -6
  303. data/lib/velopayments/models/payor_address_v2.rb +10 -6
  304. data/lib/velopayments/models/payor_aml_transaction_v3.rb +10 -6
  305. data/lib/velopayments/models/payor_aml_transaction_v4.rb +10 -6
  306. data/lib/velopayments/models/payor_branding_response.rb +10 -6
  307. data/lib/velopayments/models/payor_create_api_key_request.rb +10 -6
  308. data/lib/velopayments/models/payor_create_api_key_response.rb +10 -6
  309. data/lib/velopayments/models/payor_create_application_request.rb +10 -6
  310. data/lib/velopayments/models/payor_email_opt_out_request.rb +10 -6
  311. data/lib/velopayments/models/payor_links_response.rb +10 -6
  312. data/lib/velopayments/models/payor_links_response_links.rb +10 -6
  313. data/lib/velopayments/models/payor_links_response_payors.rb +10 -6
  314. data/lib/velopayments/models/payor_logo_request.rb +10 -6
  315. data/lib/velopayments/models/payor_v1.rb +23 -10
  316. data/lib/velopayments/models/payor_v2.rb +33 -10
  317. data/lib/velopayments/models/payout_company_v3.rb +215 -0
  318. data/lib/velopayments/models/payout_individual_v3.rb +215 -0
  319. data/lib/velopayments/models/payout_name_v3.rb +229 -0
  320. data/lib/velopayments/models/payout_payee_v3.rb +234 -0
  321. data/lib/velopayments/models/payout_payor_v4.rb +10 -6
  322. data/lib/velopayments/models/payout_principal_v4.rb +10 -6
  323. data/lib/velopayments/models/payout_status_v3.rb +3 -2
  324. data/lib/velopayments/models/payout_status_v4.rb +3 -2
  325. data/lib/velopayments/models/payout_summary_audit_v3.rb +10 -6
  326. data/lib/velopayments/models/payout_summary_audit_v4.rb +22 -9
  327. data/lib/velopayments/models/{payout_summary_response.rb → payout_summary_response_v3.rb} +32 -14
  328. data/lib/velopayments/models/payout_type_v4.rb +3 -2
  329. data/lib/velopayments/models/ping_response.rb +219 -0
  330. data/lib/velopayments/models/query_batch_response.rb +10 -6
  331. data/lib/velopayments/models/query_batch_response2.rb +10 -6
  332. data/lib/velopayments/models/{quote_fx_summary.rb → quote_fx_summary_v3.rb} +15 -11
  333. data/lib/velopayments/models/{quote_response.rb → quote_response_v3.rb} +14 -10
  334. data/lib/velopayments/models/{region.rb → region_v2.rb} +13 -9
  335. data/lib/velopayments/models/register_sms_request.rb +13 -9
  336. data/lib/velopayments/models/{rejected_payment.rb → rejected_payment_v3.rb} +13 -9
  337. data/lib/velopayments/models/resend_token_request.rb +10 -6
  338. data/lib/velopayments/models/reset_password_request.rb +10 -6
  339. data/lib/velopayments/models/role.rb +10 -6
  340. data/lib/velopayments/models/role_update_request.rb +10 -6
  341. data/lib/velopayments/models/self_mfa_type_unregister_request.rb +10 -6
  342. data/lib/velopayments/models/self_update_password_request.rb +10 -6
  343. data/lib/velopayments/models/set_notifications_request.rb +10 -6
  344. data/lib/velopayments/models/source_account_response.rb +24 -11
  345. data/lib/velopayments/models/source_account_response_v2.rb +26 -13
  346. data/lib/velopayments/models/source_account_response_v3.rb +437 -0
  347. data/lib/velopayments/models/source_account_summary_v3.rb +10 -6
  348. data/lib/velopayments/models/source_account_summary_v4.rb +10 -6
  349. data/lib/velopayments/models/source_account_type.rb +37 -0
  350. data/lib/velopayments/models/{source_account.rb → source_account_v3.rb} +13 -9
  351. data/lib/velopayments/models/supported_countries_response.rb +10 -6
  352. data/lib/velopayments/models/{supported_countries_response2.rb → supported_countries_response_v2.rb} +14 -10
  353. data/lib/velopayments/models/supported_country.rb +10 -6
  354. data/lib/velopayments/models/{supported_country2.rb → supported_country_v2.rb} +14 -10
  355. data/lib/velopayments/models/{supported_currency_response.rb → supported_currency_response_v2.rb} +14 -10
  356. data/lib/velopayments/models/{supported_currency.rb → supported_currency_v2.rb} +13 -9
  357. data/lib/velopayments/models/transfer_request.rb +10 -6
  358. data/lib/velopayments/models/transfer_request2.rb +301 -0
  359. data/lib/velopayments/models/transmission_type.rb +38 -0
  360. data/lib/velopayments/models/{list_payments_response_page.rb → transmission_types.rb} +50 -46
  361. data/lib/velopayments/models/transmission_types2.rb +246 -0
  362. data/lib/velopayments/models/unregister_mfa_request.rb +10 -6
  363. data/lib/velopayments/models/update_payee_details_request.rb +266 -0
  364. data/lib/velopayments/models/update_payee_details_request2.rb +266 -0
  365. data/lib/velopayments/models/update_remote_id_request.rb +10 -6
  366. data/lib/velopayments/models/update_webhook_request.rb +288 -0
  367. data/lib/velopayments/models/user_details_update_request.rb +19 -15
  368. data/lib/velopayments/models/user_info.rb +10 -6
  369. data/lib/velopayments/models/user_response.rb +20 -16
  370. data/lib/velopayments/models/user_status.rb +3 -2
  371. data/lib/velopayments/models/user_type.rb +3 -2
  372. data/lib/velopayments/models/user_type2.rb +3 -2
  373. data/lib/velopayments/models/validate_password_response.rb +10 -6
  374. data/lib/velopayments/models/watchlist_status.rb +3 -2
  375. data/lib/velopayments/models/watchlist_status2.rb +40 -0
  376. data/lib/velopayments/models/webhook_response.rb +246 -0
  377. data/lib/velopayments/models/webhooks_response.rb +233 -0
  378. data/lib/velopayments/models/{currency_type.rb → withdraw_payment_request.rb} +39 -34
  379. data/lib/velopayments/version.rb +3 -3
  380. data/oa3-config.json +1 -1
  381. data/spec/api/countries_api_spec.rb +12 -12
  382. data/spec/api/currencies_api_spec.rb +5 -5
  383. data/spec/api/funding_manager_api_spec.rb +93 -18
  384. data/spec/api/funding_manager_private_api_spec.rb +5 -5
  385. data/spec/api/login_api_spec.rb +3 -2
  386. data/spec/api/payee_invitation_api_spec.rb +57 -4
  387. data/spec/api/payees_api_spec.rb +108 -4
  388. data/spec/api/payment_audit_service_api_spec.rb +72 -18
  389. data/spec/api/payors_api_spec.rb +9 -9
  390. data/spec/api/payors_private_api_spec.rb +2 -2
  391. data/spec/api/payout_service_api_spec.rb +127 -0
  392. data/spec/api/tokens_api_spec.rb +2 -2
  393. data/spec/api/users_api_spec.rb +17 -4
  394. data/spec/api/webhooks_api_spec.rb +96 -0
  395. data/spec/api_client_spec.rb +2 -2
  396. data/spec/configuration_spec.rb +2 -2
  397. data/spec/models/{accepted_payment_spec.rb → accepted_payment_v3_spec.rb} +8 -8
  398. data/spec/models/access_token_response_spec.rb +2 -2
  399. data/spec/models/access_token_validation_request_spec.rb +2 -2
  400. data/spec/models/auth_response_spec.rb +2 -2
  401. data/spec/models/auto_top_up_config2_spec.rb +59 -0
  402. data/spec/models/auto_top_up_config_spec.rb +2 -2
  403. data/spec/models/{paged_response_spec.rb → challenge2_spec.rb} +10 -10
  404. data/spec/models/challenge_spec.rb +2 -2
  405. data/spec/models/company2_spec.rb +2 -2
  406. data/spec/models/company_response_spec.rb +2 -2
  407. data/spec/models/company_spec.rb +2 -2
  408. data/spec/models/company_v1_spec.rb +2 -2
  409. data/spec/models/create_funding_account_request_v2_spec.rb +81 -0
  410. data/spec/models/create_individual2_name_spec.rb +2 -2
  411. data/spec/models/create_individual2_spec.rb +2 -2
  412. data/spec/models/create_individual_spec.rb +2 -2
  413. data/spec/models/create_payee2_spec.rb +2 -2
  414. data/spec/models/create_payee_address2_spec.rb +2 -2
  415. data/spec/models/create_payee_address_spec.rb +2 -2
  416. data/spec/models/create_payee_spec.rb +2 -2
  417. data/spec/models/create_payees_csv_request2_spec.rb +2 -2
  418. data/spec/models/create_payees_csv_request_spec.rb +2 -2
  419. data/spec/models/create_payees_csv_response2_spec.rb +2 -2
  420. data/spec/models/create_payees_csv_response_rejected_csv_rows_spec.rb +2 -2
  421. data/spec/models/create_payees_csv_response_spec.rb +2 -2
  422. data/spec/models/create_payees_request2_spec.rb +2 -2
  423. data/spec/models/create_payees_request_spec.rb +2 -2
  424. data/spec/models/create_payment_channel2_spec.rb +2 -2
  425. data/spec/models/create_payment_channel_spec.rb +2 -2
  426. data/spec/models/create_payor_link_request_spec.rb +2 -2
  427. data/spec/models/{create_payout_request_spec.rb → create_payout_request_v3_spec.rb} +8 -8
  428. data/spec/models/{create_funding_account_request_spec.rb → create_webhook_request_spec.rb} +12 -12
  429. data/spec/models/error_response_spec.rb +2 -2
  430. data/spec/models/error_spec.rb +2 -2
  431. data/spec/models/failed_submission2_spec.rb +2 -2
  432. data/spec/models/failed_submission_spec.rb +2 -2
  433. data/spec/models/funding_account_response2_spec.rb +95 -0
  434. data/spec/models/funding_account_response_spec.rb +26 -2
  435. data/spec/models/funding_account_type_spec.rb +35 -0
  436. data/spec/models/funding_audit_spec.rb +8 -8
  437. data/spec/models/funding_event_spec.rb +2 -2
  438. data/spec/models/funding_event_type_spec.rb +2 -2
  439. data/spec/models/funding_payor_status_audit_response_spec.rb +2 -2
  440. data/spec/models/funding_request_v1_spec.rb +2 -2
  441. data/spec/models/funding_request_v2_spec.rb +2 -2
  442. data/spec/models/funding_request_v3_spec.rb +47 -0
  443. data/spec/models/fx_summary_v3_spec.rb +2 -2
  444. data/spec/models/fx_summary_v4_spec.rb +2 -2
  445. data/spec/models/get_fundings_response_links_spec.rb +47 -0
  446. data/spec/models/get_fundings_response_spec.rb +14 -2
  447. data/spec/models/get_payee_list_response_company_spec.rb +47 -0
  448. data/spec/models/get_payee_list_response_individual_spec.rb +41 -0
  449. data/spec/models/{payee_response2_spec.rb → get_payee_list_response_spec.rb} +21 -39
  450. data/spec/models/get_payments_for_payout_response_v3_page_spec.rb +2 -2
  451. data/spec/models/get_payments_for_payout_response_v3_spec.rb +2 -2
  452. data/spec/models/get_payments_for_payout_response_v3_summary_spec.rb +2 -2
  453. data/spec/models/get_payments_for_payout_response_v4_spec.rb +2 -2
  454. data/spec/models/get_payments_for_payout_response_v4_summary_spec.rb +8 -2
  455. data/spec/models/get_payout_statistics_spec.rb +2 -2
  456. data/spec/models/get_payouts_response_v3_links_spec.rb +2 -2
  457. data/spec/models/get_payouts_response_v3_page_spec.rb +2 -2
  458. data/spec/models/get_payouts_response_v3_spec.rb +2 -2
  459. data/spec/models/get_payouts_response_v4_spec.rb +2 -2
  460. data/spec/models/individual2_spec.rb +2 -2
  461. data/spec/models/individual_response_spec.rb +2 -2
  462. data/spec/models/individual_spec.rb +2 -2
  463. data/spec/models/individual_v1_name_spec.rb +2 -2
  464. data/spec/models/individual_v1_spec.rb +2 -2
  465. data/spec/models/inline_response400_errors_spec.rb +2 -2
  466. data/spec/models/inline_response400_spec.rb +2 -2
  467. data/spec/models/inline_response401_errors_spec.rb +2 -2
  468. data/spec/models/inline_response401_spec.rb +2 -2
  469. data/spec/models/inline_response403_errors_spec.rb +2 -2
  470. data/spec/models/inline_response403_spec.rb +2 -2
  471. data/spec/models/inline_response404_errors_spec.rb +59 -0
  472. data/spec/models/inline_response404_spec.rb +47 -0
  473. data/spec/models/inline_response409_errors_spec.rb +2 -2
  474. data/spec/models/inline_response409_spec.rb +2 -2
  475. data/spec/models/inline_response412_errors_spec.rb +59 -0
  476. data/spec/models/inline_response412_spec.rb +47 -0
  477. data/spec/models/invitation_status2_spec.rb +35 -0
  478. data/spec/models/invitation_status_response_spec.rb +2 -2
  479. data/spec/models/invitation_status_spec.rb +2 -2
  480. data/spec/models/invite_payee_request2_spec.rb +2 -2
  481. data/spec/models/invite_payee_request_spec.rb +2 -2
  482. data/spec/models/invite_user_request_spec.rb +2 -2
  483. data/spec/models/kyc_state_spec.rb +2 -2
  484. data/spec/models/language2_spec.rb +2 -2
  485. data/spec/models/language_spec.rb +2 -2
  486. data/spec/models/link_for_response_spec.rb +2 -2
  487. data/spec/models/list_funding_accounts_response2_spec.rb +53 -0
  488. data/spec/models/list_funding_accounts_response_spec.rb +2 -2
  489. data/spec/models/{list_payments_response_page_spec.rb → list_payments_response_v3_page_spec.rb} +8 -8
  490. data/spec/models/{list_payments_response_spec.rb → list_payments_response_v3_spec.rb} +8 -8
  491. data/spec/models/list_payments_response_v4_spec.rb +2 -2
  492. data/spec/models/list_source_account_response_links_spec.rb +2 -2
  493. data/spec/models/list_source_account_response_page_spec.rb +2 -2
  494. data/spec/models/list_source_account_response_spec.rb +2 -2
  495. data/spec/models/list_source_account_response_v2_links_spec.rb +47 -0
  496. data/spec/models/list_source_account_response_v2_spec.rb +2 -2
  497. data/spec/models/list_source_account_response_v3_links_spec.rb +47 -0
  498. data/spec/models/list_source_account_response_v3_spec.rb +53 -0
  499. data/spec/models/location_type_spec.rb +2 -2
  500. data/spec/models/marketing_opt_in_spec.rb +2 -2
  501. data/spec/models/mfa_details_spec.rb +2 -2
  502. data/spec/models/mfa_type_spec.rb +2 -2
  503. data/spec/models/name_spec.rb +59 -0
  504. data/spec/models/{currency_type_spec.rb → notifications2_spec.rb} +9 -9
  505. data/spec/models/notifications_spec.rb +2 -2
  506. data/spec/models/ofac_status2_spec.rb +2 -2
  507. data/spec/models/ofac_status_spec.rb +2 -2
  508. data/spec/models/onboarded_status2_spec.rb +2 -2
  509. data/spec/models/onboarded_status_spec.rb +2 -2
  510. data/spec/models/page_for_response_spec.rb +2 -2
  511. data/spec/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response_spec.rb +2 -2
  512. data/spec/models/paged_payee_invitation_status_response2_spec.rb +2 -2
  513. data/spec/models/paged_payee_invitation_status_response_page_spec.rb +2 -2
  514. data/spec/models/paged_payee_invitation_status_response_spec.rb +2 -2
  515. data/spec/models/paged_payee_response2_spec.rb +2 -2
  516. data/spec/models/paged_payee_response2_summary_spec.rb +2 -2
  517. data/spec/models/paged_payee_response_links_spec.rb +2 -2
  518. data/spec/models/paged_payee_response_page_spec.rb +2 -2
  519. data/spec/models/paged_payee_response_spec.rb +2 -2
  520. data/spec/models/paged_payee_response_summary_spec.rb +2 -2
  521. data/spec/models/paged_payments_response_v3_spec.rb +53 -0
  522. data/spec/models/paged_user_response_links_spec.rb +2 -2
  523. data/spec/models/paged_user_response_page_spec.rb +2 -2
  524. data/spec/models/paged_user_response_spec.rb +2 -2
  525. data/spec/models/password_request_spec.rb +2 -2
  526. data/spec/models/payee2_spec.rb +2 -2
  527. data/spec/models/payee_address2_spec.rb +2 -2
  528. data/spec/models/payee_address_spec.rb +2 -2
  529. data/spec/models/payee_delta2_spec.rb +2 -2
  530. data/spec/models/payee_delta_response2_links_spec.rb +2 -2
  531. data/spec/models/payee_delta_response2_spec.rb +2 -2
  532. data/spec/models/payee_delta_response_links_spec.rb +2 -2
  533. data/spec/models/payee_delta_response_page_spec.rb +2 -2
  534. data/spec/models/payee_delta_response_spec.rb +2 -2
  535. data/spec/models/payee_delta_spec.rb +2 -2
  536. data/spec/models/payee_detail_response2_spec.rb +209 -0
  537. data/spec/models/{payee_response_v3_spec.rb → payee_detail_response_spec.rb} +14 -8
  538. data/spec/models/payee_invitation_status_response2_spec.rb +2 -2
  539. data/spec/models/payee_invitation_status_response_spec.rb +2 -2
  540. data/spec/models/payee_invitation_status_spec.rb +2 -2
  541. data/spec/models/payee_payment_channel2_spec.rb +2 -2
  542. data/spec/models/payee_payment_channel_spec.rb +2 -2
  543. data/spec/models/payee_payor_ref2_spec.rb +65 -0
  544. data/spec/models/payee_payor_ref_spec.rb +2 -2
  545. data/spec/models/payee_payor_ref_v2_spec.rb +2 -2
  546. data/spec/models/payee_payor_ref_v3_spec.rb +2 -6
  547. data/spec/models/payee_response_spec.rb +2 -2
  548. data/spec/models/payee_response_v2_spec.rb +2 -2
  549. data/spec/models/payee_spec.rb +2 -2
  550. data/spec/models/payee_type2_spec.rb +35 -0
  551. data/spec/models/payee_type_spec.rb +2 -2
  552. data/spec/models/payee_user_self_update_request_spec.rb +71 -0
  553. data/spec/models/payment_audit_currency_v3_spec.rb +2 -2
  554. data/spec/models/payment_audit_currency_v4_spec.rb +2 -2
  555. data/spec/models/payment_channel_country_spec.rb +2 -2
  556. data/spec/models/payment_channel_rule_spec.rb +2 -2
  557. data/spec/models/payment_channel_rules_response_spec.rb +2 -2
  558. data/spec/models/payment_delta_response_spec.rb +2 -2
  559. data/spec/models/payment_delta_response_v4_spec.rb +53 -0
  560. data/spec/models/payment_delta_spec.rb +2 -2
  561. data/spec/models/payment_delta_v4_spec.rb +83 -0
  562. data/spec/models/payment_event_response_v3_spec.rb +2 -2
  563. data/spec/models/payment_event_response_v4_spec.rb +2 -2
  564. data/spec/models/{payment_instruction_spec.rb → payment_instruction_v3_spec.rb} +14 -8
  565. data/spec/models/payment_rails_spec.rb +2 -2
  566. data/spec/models/payment_response_v3_spec.rb +2 -2
  567. data/spec/models/payment_response_v4_payout_spec.rb +2 -2
  568. data/spec/models/payment_response_v4_spec.rb +20 -2
  569. data/spec/models/payment_v3_spec.rb +105 -0
  570. data/spec/models/payor_address_spec.rb +2 -2
  571. data/spec/models/payor_address_v2_spec.rb +2 -2
  572. data/spec/models/payor_aml_transaction_v3_spec.rb +2 -2
  573. data/spec/models/payor_aml_transaction_v4_spec.rb +2 -2
  574. data/spec/models/payor_branding_response_spec.rb +2 -2
  575. data/spec/models/payor_create_api_key_request_spec.rb +2 -2
  576. data/spec/models/payor_create_api_key_response_spec.rb +2 -2
  577. data/spec/models/payor_create_application_request_spec.rb +2 -2
  578. data/spec/models/payor_email_opt_out_request_spec.rb +2 -2
  579. data/spec/models/payor_links_response_links_spec.rb +2 -2
  580. data/spec/models/payor_links_response_payors_spec.rb +2 -2
  581. data/spec/models/payor_links_response_spec.rb +2 -2
  582. data/spec/models/payor_logo_request_spec.rb +2 -2
  583. data/spec/models/payor_v1_spec.rb +8 -2
  584. data/spec/models/payor_v2_spec.rb +14 -2
  585. data/spec/models/{get_fundings_response_all_of_spec.rb → payout_company_v3_spec.rb} +9 -9
  586. data/spec/models/{user_response2_roles_spec.rb → payout_individual_v3_spec.rb} +8 -8
  587. data/spec/models/payout_name_v3_spec.rb +47 -0
  588. data/spec/models/payout_payee_v3_spec.rb +53 -0
  589. data/spec/models/payout_payor_v4_spec.rb +2 -2
  590. data/spec/models/payout_principal_v4_spec.rb +2 -2
  591. data/spec/models/payout_status_v3_spec.rb +2 -2
  592. data/spec/models/payout_status_v4_spec.rb +2 -2
  593. data/spec/models/payout_summary_audit_v3_spec.rb +2 -2
  594. data/spec/models/payout_summary_audit_v4_spec.rb +8 -2
  595. data/spec/models/{payout_summary_response_spec.rb → payout_summary_response_v3_spec.rb} +14 -8
  596. data/spec/models/payout_type_v4_spec.rb +2 -2
  597. data/spec/models/ping_response_spec.rb +47 -0
  598. data/spec/models/query_batch_response2_spec.rb +2 -2
  599. data/spec/models/query_batch_response_spec.rb +2 -2
  600. data/spec/models/{quote_fx_summary_spec.rb → quote_fx_summary_v3_spec.rb} +8 -8
  601. data/spec/models/{quote_response_spec.rb → quote_response_v3_spec.rb} +8 -8
  602. data/spec/models/{region_spec.rb → region_v2_spec.rb} +8 -8
  603. data/spec/models/register_sms_request_spec.rb +2 -2
  604. data/spec/models/{rejected_payment_spec.rb → rejected_payment_v3_spec.rb} +8 -8
  605. data/spec/models/resend_token_request_spec.rb +2 -2
  606. data/spec/models/reset_password_request_spec.rb +2 -2
  607. data/spec/models/role_spec.rb +2 -2
  608. data/spec/models/role_update_request_spec.rb +2 -2
  609. data/spec/models/self_mfa_type_unregister_request_spec.rb +2 -2
  610. data/spec/models/self_update_password_request_spec.rb +2 -2
  611. data/spec/models/set_notifications_request_spec.rb +2 -2
  612. data/spec/models/source_account_response_spec.rb +8 -2
  613. data/spec/models/source_account_response_v2_spec.rb +8 -2
  614. data/spec/models/{user_response2_spec.rb → source_account_response_v3_spec.rb} +30 -32
  615. data/spec/models/source_account_summary_v3_spec.rb +2 -2
  616. data/spec/models/source_account_summary_v4_spec.rb +2 -2
  617. data/spec/models/source_account_type_spec.rb +35 -0
  618. data/spec/models/{source_account_spec.rb → source_account_v3_spec.rb} +8 -8
  619. data/spec/models/supported_countries_response_spec.rb +2 -2
  620. data/spec/models/{supported_countries_response2_spec.rb → supported_countries_response_v2_spec.rb} +8 -8
  621. data/spec/models/supported_country_spec.rb +2 -2
  622. data/spec/models/{supported_country2_spec.rb → supported_country_v2_spec.rb} +8 -8
  623. data/spec/models/{supported_currency_response_spec.rb → supported_currency_response_v2_spec.rb} +8 -8
  624. data/spec/models/{supported_currency_spec.rb → supported_currency_v2_spec.rb} +8 -8
  625. data/spec/models/transfer_request2_spec.rb +53 -0
  626. data/spec/models/transfer_request_spec.rb +2 -2
  627. data/spec/models/transmission_type_spec.rb +35 -0
  628. data/spec/models/transmission_types2_spec.rb +53 -0
  629. data/spec/models/transmission_types_spec.rb +53 -0
  630. data/spec/models/unregister_mfa_request_spec.rb +2 -2
  631. data/spec/models/update_payee_details_request2_spec.rb +77 -0
  632. data/spec/models/update_payee_details_request_spec.rb +77 -0
  633. data/spec/models/update_remote_id_request_spec.rb +2 -2
  634. data/spec/models/update_webhook_request_spec.rb +53 -0
  635. data/spec/models/user_details_update_request_spec.rb +2 -2
  636. data/spec/models/user_info_spec.rb +2 -2
  637. data/spec/models/user_response_spec.rb +2 -2
  638. data/spec/models/user_status_spec.rb +2 -2
  639. data/spec/models/user_type2_spec.rb +2 -2
  640. data/spec/models/user_type_spec.rb +2 -2
  641. data/spec/models/validate_password_response_spec.rb +2 -2
  642. data/spec/models/watchlist_status2_spec.rb +35 -0
  643. data/spec/models/watchlist_status_spec.rb +2 -2
  644. data/spec/models/{paged_response_page_spec.rb → webhook_response_spec.rb} +13 -13
  645. data/spec/models/webhooks_response_spec.rb +53 -0
  646. data/spec/models/withdraw_payment_request_spec.rb +41 -0
  647. data/spec/spec_helper.rb +2 -2
  648. data/specs/api/countries_api_spec.rb +48 -13
  649. data/specs/api/currencies_api_spec.rb +8 -6
  650. data/specs/api/funding_manager_api_spec.rb +197 -30
  651. data/specs/api/funding_manager_private_api_spec.rb +6 -6
  652. data/specs/api/login_api_spec.rb +6 -6
  653. data/specs/api/payee_invitation_api_spec.rb +61 -11
  654. data/specs/api/payees_api_spec.rb +101 -14
  655. data/specs/api/payment_audit_service_api_spec.rb +231 -30
  656. data/specs/api/payors_api_spec.rb +50 -17
  657. data/specs/api/payors_private_api_spec.rb +3 -3
  658. data/specs/api/payout_service_api_spec.rb +127 -0
  659. data/specs/api/tokens_api_spec.rb +3 -3
  660. data/specs/api/users_api_spec.rb +70 -21
  661. data/velopayments.gemspec +3 -4
  662. metadata +444 -326
  663. data/Gemfile.lock +0 -70
  664. data/docs/CreateFundingAccountRequest.md +0 -23
  665. data/docs/GetFundingsResponseAllOf.md +0 -17
  666. data/docs/GetPayoutApi.md +0 -61
  667. data/docs/InstructPayoutApi.md +0 -60
  668. data/docs/PagedResponse.md +0 -19
  669. data/docs/PagedResponsePage.md +0 -25
  670. data/docs/PayeeResponse2.md +0 -55
  671. data/docs/PayoutHistoryApi.md +0 -221
  672. data/docs/QuotePayoutApi.md +0 -61
  673. data/docs/QuoteResponse.md +0 -17
  674. data/docs/SubmitPayoutApi.md +0 -60
  675. data/docs/SupportedCountriesResponse2.md +0 -17
  676. data/docs/SupportedCurrencyResponse.md +0 -17
  677. data/docs/UserResponse2.md +0 -45
  678. data/docs/WithdrawPayoutApi.md +0 -60
  679. data/lib/velopayments/api/get_payout_api.rb +0 -84
  680. data/lib/velopayments/api/instruct_payout_api.rb +0 -84
  681. data/lib/velopayments/api/payout_history_api.rb +0 -285
  682. data/lib/velopayments/api/quote_payout_api.rb +0 -84
  683. data/lib/velopayments/api/submit_payout_api.rb +0 -86
  684. data/lib/velopayments/api/withdraw_payout_api.rb +0 -84
  685. data/spec/api/get_payout_api_spec.rb +0 -47
  686. data/spec/api/instruct_payout_api_spec.rb +0 -47
  687. data/spec/api/payout_history_api_spec.rb +0 -95
  688. data/spec/api/quote_payout_api_spec.rb +0 -47
  689. data/spec/api/submit_payout_api_spec.rb +0 -47
  690. data/spec/api/withdraw_payout_api_spec.rb +0 -47
  691. data/specs/api/get_payout_api_spec.rb +0 -47
  692. data/specs/api/instruct_payout_api_spec.rb +0 -47
  693. data/specs/api/payout_history_api_spec.rb +0 -95
  694. data/specs/api/quote_payout_api_spec.rb +0 -47
  695. data/specs/api/submit_payout_api_spec.rb +0 -47
  696. data/specs/api/withdraw_payout_api_spec.rb +0 -47
  697. data/velopayments-2.20.118.gem +0 -0
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
5
5
 
6
- The version of the OpenAPI document: 2.20.118
6
+ The version of the OpenAPI document: 2.23.78
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.3.1-SNAPSHOT
9
+ OpenAPI Generator version: 5.0.0-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -54,21 +54,22 @@ module VeloPayments
54
54
  # header parameters
55
55
  header_params = opts[:header_params] || {}
56
56
  # HTTP header 'Accept' (if needed)
57
- header_params['Accept'] = @api_client.select_header_accept(['application/csv'])
57
+ header_params['Accept'] = @api_client.select_header_accept(['application/csv', 'application/json'])
58
58
 
59
59
  # form parameters
60
60
  form_params = opts[:form_params] || {}
61
61
 
62
62
  # http body (model)
63
- post_body = opts[:body]
63
+ post_body = opts[:debug_body]
64
64
 
65
65
  # return_type
66
- return_type = opts[:return_type] || 'PayorAmlTransactionV3'
66
+ return_type = opts[:debug_return_type] || 'PayorAmlTransactionV3'
67
67
 
68
68
  # auth_names
69
- auth_names = opts[:auth_names] || ['OAuth2']
69
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
70
70
 
71
71
  new_options = opts.merge(
72
+ :operation => :"PaymentAuditServiceApi.export_transactions_csvv3",
72
73
  :header_params => header_params,
73
74
  :query_params => query_params,
74
75
  :form_params => form_params,
@@ -87,10 +88,10 @@ module VeloPayments
87
88
  # Export Transactions
88
89
  # Download a CSV file containing payments in a date range. Uses Transfer-Encoding - chunked to stream to the client. Date range is inclusive of both the start and end dates.
89
90
  # @param [Hash] opts the optional parameters
90
- # @option opts [String] :payor_id The Payor ID for whom you wish to run the report. For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor.
91
+ # @option opts [String] :payor_id <p>The Payor ID for whom you wish to run the report.</p> <p>For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor.</p>
91
92
  # @option opts [Date] :start_date Start date, inclusive. Format is YYYY-MM-DD
92
- # @option opts [Date] :submitted_date_from Start date, inclusive. Format is YYYY-MM-DD
93
- # @option opts [String] :include Mode to determine whether to include other Payor's data in the results. May only be used if payorId is specified. Can be omitted or set to 'payorOnly' or 'payorAndDescendants'. payorOnly: Only include results for the specified Payor. This is the default if 'include' is omitted. payorAndDescendants: Aggregate results for all descendant Payors of the specified Payor. Should only be used if the Payor with the specified payorId has at least one child Payor. Note when a Payor requests the report and include=payorAndDescendants is used, the following additional columns are included in the CSV: Payor Name, Payor Id
93
+ # @option opts [Date] :end_date End date, inclusive. Format is YYYY-MM-DD
94
+ # @option opts [String] :include <p>Mode to determine whether to include other Payor's data in the results.</p> <p>May only be used if payorId is specified.</p> <p>Can be omitted or set to 'payorOnly' or 'payorAndDescendants'.</p> <p>payorOnly: Only include results for the specified Payor. This is the default if 'include' is omitted.</p> <p>payorAndDescendants: Aggregate results for all descendant Payors of the specified Payor. Should only be used if the Payor with the specified payorId has at least one child Payor.</p> <p>Note when a Payor requests the report and include=payorAndDescendants is used, the following additional columns are included in the CSV: Payor Name, Payor Id</p>
94
95
  # @return [PayorAmlTransactionV4]
95
96
  def export_transactions_csvv4(opts = {})
96
97
  data, _status_code, _headers = export_transactions_csvv4_with_http_info(opts)
@@ -100,10 +101,10 @@ module VeloPayments
100
101
  # Export Transactions
101
102
  # Download a CSV file containing payments in a date range. Uses Transfer-Encoding - chunked to stream to the client. Date range is inclusive of both the start and end dates.
102
103
  # @param [Hash] opts the optional parameters
103
- # @option opts [String] :payor_id The Payor ID for whom you wish to run the report. For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor.
104
+ # @option opts [String] :payor_id <p>The Payor ID for whom you wish to run the report.</p> <p>For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor.</p>
104
105
  # @option opts [Date] :start_date Start date, inclusive. Format is YYYY-MM-DD
105
- # @option opts [Date] :submitted_date_from Start date, inclusive. Format is YYYY-MM-DD
106
- # @option opts [String] :include Mode to determine whether to include other Payor's data in the results. May only be used if payorId is specified. Can be omitted or set to 'payorOnly' or 'payorAndDescendants'. payorOnly: Only include results for the specified Payor. This is the default if 'include' is omitted. payorAndDescendants: Aggregate results for all descendant Payors of the specified Payor. Should only be used if the Payor with the specified payorId has at least one child Payor. Note when a Payor requests the report and include=payorAndDescendants is used, the following additional columns are included in the CSV: Payor Name, Payor Id
106
+ # @option opts [Date] :end_date End date, inclusive. Format is YYYY-MM-DD
107
+ # @option opts [String] :include <p>Mode to determine whether to include other Payor's data in the results.</p> <p>May only be used if payorId is specified.</p> <p>Can be omitted or set to 'payorOnly' or 'payorAndDescendants'.</p> <p>payorOnly: Only include results for the specified Payor. This is the default if 'include' is omitted.</p> <p>payorAndDescendants: Aggregate results for all descendant Payors of the specified Payor. Should only be used if the Payor with the specified payorId has at least one child Payor.</p> <p>Note when a Payor requests the report and include=payorAndDescendants is used, the following additional columns are included in the CSV: Payor Name, Payor Id</p>
107
108
  # @return [Array<(PayorAmlTransactionV4, Integer, Hash)>] PayorAmlTransactionV4 data, response status code and response headers
108
109
  def export_transactions_csvv4_with_http_info(opts = {})
109
110
  if @api_client.config.debugging
@@ -120,7 +121,7 @@ module VeloPayments
120
121
  query_params = opts[:query_params] || {}
121
122
  query_params[:'payorId'] = opts[:'payor_id'] if !opts[:'payor_id'].nil?
122
123
  query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
123
- query_params[:'submittedDateFrom'] = opts[:'submitted_date_from'] if !opts[:'submitted_date_from'].nil?
124
+ query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
124
125
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?
125
126
 
126
127
  # header parameters
@@ -132,15 +133,16 @@ module VeloPayments
132
133
  form_params = opts[:form_params] || {}
133
134
 
134
135
  # http body (model)
135
- post_body = opts[:body]
136
+ post_body = opts[:debug_body]
136
137
 
137
138
  # return_type
138
- return_type = opts[:return_type] || 'PayorAmlTransactionV4'
139
+ return_type = opts[:debug_return_type] || 'PayorAmlTransactionV4'
139
140
 
140
141
  # auth_names
141
- auth_names = opts[:auth_names] || ['OAuth2']
142
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
142
143
 
143
144
  new_options = opts.merge(
145
+ :operation => :"PaymentAuditServiceApi.export_transactions_csvv4",
144
146
  :header_params => header_params,
145
147
  :query_params => query_params,
146
148
  :form_params => form_params,
@@ -157,36 +159,48 @@ module VeloPayments
157
159
  end
158
160
 
159
161
  # Get Fundings for Payor
160
- # Get a list of Fundings for a payor.
162
+ # <p>Get a list of Fundings for a payor.</p> <p>Deprecated (use v4/paymentaudit/fundings)</p>
163
+ # @param payor_id [String] The account owner Payor ID
161
164
  # @param [Hash] opts the optional parameters
162
- # @option opts [String] :payor_id The account owner Payor ID
163
165
  # @option opts [Integer] :page Page number. Default is 1. (default to 1)
164
- # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25)
166
+ # @option opts [Integer] :page_size The number of results to return in a page (default to 25)
165
167
  # @option opts [String] :sort List of sort fields. Example: &#x60;&#x60;&#x60;?sort&#x3D;destinationCurrency:asc,destinationAmount:asc&#x60;&#x60;&#x60; Default is no sort. The supported sort fields are: dateTime and amount.
166
168
  # @return [GetFundingsResponse]
167
- def get_fundings_v1(opts = {})
168
- data, _status_code, _headers = get_fundings_v1_with_http_info(opts)
169
+ def get_fundings_v1(payor_id, opts = {})
170
+ data, _status_code, _headers = get_fundings_v1_with_http_info(payor_id, opts)
169
171
  data
170
172
  end
171
173
 
172
174
  # Get Fundings for Payor
173
- # Get a list of Fundings for a payor.
175
+ # &lt;p&gt;Get a list of Fundings for a payor.&lt;/p&gt; &lt;p&gt;Deprecated (use v4/paymentaudit/fundings)&lt;/p&gt;
176
+ # @param payor_id [String] The account owner Payor ID
174
177
  # @param [Hash] opts the optional parameters
175
- # @option opts [String] :payor_id The account owner Payor ID
176
178
  # @option opts [Integer] :page Page number. Default is 1.
177
- # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
179
+ # @option opts [Integer] :page_size The number of results to return in a page
178
180
  # @option opts [String] :sort List of sort fields. Example: &#x60;&#x60;&#x60;?sort&#x3D;destinationCurrency:asc,destinationAmount:asc&#x60;&#x60;&#x60; Default is no sort. The supported sort fields are: dateTime and amount.
179
181
  # @return [Array<(GetFundingsResponse, Integer, Hash)>] GetFundingsResponse data, response status code and response headers
180
- def get_fundings_v1_with_http_info(opts = {})
182
+ def get_fundings_v1_with_http_info(payor_id, opts = {})
181
183
  if @api_client.config.debugging
182
184
  @api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.get_fundings_v1 ...'
183
185
  end
186
+ # verify the required parameter 'payor_id' is set
187
+ if @api_client.config.client_side_validation && payor_id.nil?
188
+ fail ArgumentError, "Missing the required parameter 'payor_id' when calling PaymentAuditServiceApi.get_fundings_v1"
189
+ end
190
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
191
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.get_fundings_v1, must be smaller than or equal to 100.'
192
+ end
193
+
194
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
195
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.get_fundings_v1, must be greater than or equal to 1.'
196
+ end
197
+
184
198
  # resource path
185
199
  local_var_path = '/v1/paymentaudit/fundings'
186
200
 
187
201
  # query parameters
188
202
  query_params = opts[:query_params] || {}
189
- query_params[:'payorId'] = opts[:'payor_id'] if !opts[:'payor_id'].nil?
203
+ query_params[:'payorId'] = payor_id
190
204
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
191
205
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
192
206
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
@@ -200,15 +214,16 @@ module VeloPayments
200
214
  form_params = opts[:form_params] || {}
201
215
 
202
216
  # http body (model)
203
- post_body = opts[:body]
217
+ post_body = opts[:debug_body]
204
218
 
205
219
  # return_type
206
- return_type = opts[:return_type] || 'GetFundingsResponse'
220
+ return_type = opts[:debug_return_type] || 'GetFundingsResponse'
207
221
 
208
222
  # auth_names
209
- auth_names = opts[:auth_names] || ['OAuth2']
223
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
210
224
 
211
225
  new_options = opts.merge(
226
+ :operation => :"PaymentAuditServiceApi.get_fundings_v1",
212
227
  :header_params => header_params,
213
228
  :query_params => query_params,
214
229
  :form_params => form_params,
@@ -224,6 +239,87 @@ module VeloPayments
224
239
  return data, status_code, headers
225
240
  end
226
241
 
242
+ # Get Fundings for Payor
243
+ # <p>Get a list of Fundings for a payor.</p>
244
+ # @param payor_id [String] The account owner Payor ID
245
+ # @param [Hash] opts the optional parameters
246
+ # @option opts [Integer] :page Page number. Default is 1. (default to 1)
247
+ # @option opts [Integer] :page_size The number of results to return in a page (default to 25)
248
+ # @option opts [String] :sort List of sort fields. Example: &#x60;&#x60;&#x60;?sort&#x3D;destinationCurrency:asc,destinationAmount:asc&#x60;&#x60;&#x60; Default is no sort. The supported sort fields are: dateTime and amount.
249
+ # @return [GetFundingsResponse]
250
+ def get_fundings_v4(payor_id, opts = {})
251
+ data, _status_code, _headers = get_fundings_v4_with_http_info(payor_id, opts)
252
+ data
253
+ end
254
+
255
+ # Get Fundings for Payor
256
+ # &lt;p&gt;Get a list of Fundings for a payor.&lt;/p&gt;
257
+ # @param payor_id [String] The account owner Payor ID
258
+ # @param [Hash] opts the optional parameters
259
+ # @option opts [Integer] :page Page number. Default is 1.
260
+ # @option opts [Integer] :page_size The number of results to return in a page
261
+ # @option opts [String] :sort List of sort fields. Example: &#x60;&#x60;&#x60;?sort&#x3D;destinationCurrency:asc,destinationAmount:asc&#x60;&#x60;&#x60; Default is no sort. The supported sort fields are: dateTime and amount.
262
+ # @return [Array<(GetFundingsResponse, Integer, Hash)>] GetFundingsResponse data, response status code and response headers
263
+ def get_fundings_v4_with_http_info(payor_id, opts = {})
264
+ if @api_client.config.debugging
265
+ @api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.get_fundings_v4 ...'
266
+ end
267
+ # verify the required parameter 'payor_id' is set
268
+ if @api_client.config.client_side_validation && payor_id.nil?
269
+ fail ArgumentError, "Missing the required parameter 'payor_id' when calling PaymentAuditServiceApi.get_fundings_v4"
270
+ end
271
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
272
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.get_fundings_v4, must be smaller than or equal to 100.'
273
+ end
274
+
275
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
276
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.get_fundings_v4, must be greater than or equal to 1.'
277
+ end
278
+
279
+ # resource path
280
+ local_var_path = '/v4/paymentaudit/fundings'
281
+
282
+ # query parameters
283
+ query_params = opts[:query_params] || {}
284
+ query_params[:'payorId'] = payor_id
285
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
286
+ query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
287
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
288
+
289
+ # header parameters
290
+ header_params = opts[:header_params] || {}
291
+ # HTTP header 'Accept' (if needed)
292
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
293
+
294
+ # form parameters
295
+ form_params = opts[:form_params] || {}
296
+
297
+ # http body (model)
298
+ post_body = opts[:debug_body]
299
+
300
+ # return_type
301
+ return_type = opts[:debug_return_type] || 'GetFundingsResponse'
302
+
303
+ # auth_names
304
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
305
+
306
+ new_options = opts.merge(
307
+ :operation => :"PaymentAuditServiceApi.get_fundings_v4",
308
+ :header_params => header_params,
309
+ :query_params => query_params,
310
+ :form_params => form_params,
311
+ :body => post_body,
312
+ :auth_names => auth_names,
313
+ :return_type => return_type
314
+ )
315
+
316
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
317
+ if @api_client.config.debugging
318
+ @api_client.config.logger.debug "API called: PaymentAuditServiceApi#get_fundings_v4\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
319
+ end
320
+ return data, status_code, headers
321
+ end
322
+
227
323
  # Get Payment
228
324
  # Get the payment with the given id. This contains the payment history.
229
325
  # @param payment_id [String] Payment Id
@@ -265,15 +361,16 @@ module VeloPayments
265
361
  form_params = opts[:form_params] || {}
266
362
 
267
363
  # http body (model)
268
- post_body = opts[:body]
364
+ post_body = opts[:debug_body]
269
365
 
270
366
  # return_type
271
- return_type = opts[:return_type] || 'PaymentResponseV3'
367
+ return_type = opts[:debug_return_type] || 'PaymentResponseV3'
272
368
 
273
369
  # auth_names
274
- auth_names = opts[:auth_names] || ['OAuth2']
370
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
275
371
 
276
372
  new_options = opts.merge(
373
+ :operation => :"PaymentAuditServiceApi.get_payment_details",
277
374
  :header_params => header_params,
278
375
  :query_params => query_params,
279
376
  :form_params => form_params,
@@ -330,15 +427,16 @@ module VeloPayments
330
427
  form_params = opts[:form_params] || {}
331
428
 
332
429
  # http body (model)
333
- post_body = opts[:body]
430
+ post_body = opts[:debug_body]
334
431
 
335
432
  # return_type
336
- return_type = opts[:return_type] || 'PaymentResponseV4'
433
+ return_type = opts[:debug_return_type] || 'PaymentResponseV4'
337
434
 
338
435
  # auth_names
339
- auth_names = opts[:auth_names] || ['OAuth2']
436
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
340
437
 
341
438
  new_options = opts.merge(
439
+ :operation => :"PaymentAuditServiceApi.get_payment_details_v4",
342
440
  :header_params => header_params,
343
441
  :query_params => query_params,
344
442
  :form_params => form_params,
@@ -367,8 +465,8 @@ module VeloPayments
367
465
  # @option opts [Date] :submitted_date_from The submitted date from range filter. Format is yyyy-MM-dd.
368
466
  # @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
369
467
  # @option opts [Integer] :page Page number. Default is 1. (default to 1)
370
- # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25)
371
- # @option opts [String] :sort List of sort fields (e.g. ?sort&#x3D;submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status
468
+ # @option opts [Integer] :page_size The number of results to return in a page (default to 25)
469
+ # @option opts [String] :sort &lt;p&gt;List of sort fields (e.g. ?sort&#x3D;submittedDateTime:asc,status:asc). Default is sort by remoteId&lt;/p&gt; &lt;p&gt;The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status&lt;/p&gt;
372
470
  # @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.
373
471
  # @return [GetPaymentsForPayoutResponseV3]
374
472
  def get_payments_for_payout(payout_id, opts = {})
@@ -389,8 +487,8 @@ module VeloPayments
389
487
  # @option opts [Date] :submitted_date_from The submitted date from range filter. Format is yyyy-MM-dd.
390
488
  # @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
391
489
  # @option opts [Integer] :page Page number. Default is 1.
392
- # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
393
- # @option opts [String] :sort List of sort fields (e.g. ?sort&#x3D;submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status
490
+ # @option opts [Integer] :page_size The number of results to return in a page
491
+ # @option opts [String] :sort &lt;p&gt;List of sort fields (e.g. ?sort&#x3D;submittedDateTime:asc,status:asc). Default is sort by remoteId&lt;/p&gt; &lt;p&gt;The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status&lt;/p&gt;
394
492
  # @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.
395
493
  # @return [Array<(GetPaymentsForPayoutResponseV3, Integer, Hash)>] GetPaymentsForPayoutResponseV3 data, response status code and response headers
396
494
  def get_payments_for_payout_with_http_info(payout_id, opts = {})
@@ -405,6 +503,14 @@ module VeloPayments
405
503
  if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
406
504
  fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
407
505
  end
506
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
507
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.get_payments_for_payout, must be smaller than or equal to 100.'
508
+ end
509
+
510
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
511
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.get_payments_for_payout, must be greater than or equal to 1.'
512
+ end
513
+
408
514
  # resource path
409
515
  local_var_path = '/v3/paymentaudit/payouts/{payoutId}'.sub('{' + 'payoutId' + '}', CGI.escape(payout_id.to_s))
410
516
 
@@ -432,15 +538,16 @@ module VeloPayments
432
538
  form_params = opts[:form_params] || {}
433
539
 
434
540
  # http body (model)
435
- post_body = opts[:body]
541
+ post_body = opts[:debug_body]
436
542
 
437
543
  # return_type
438
- return_type = opts[:return_type] || 'GetPaymentsForPayoutResponseV3'
544
+ return_type = opts[:debug_return_type] || 'GetPaymentsForPayoutResponseV3'
439
545
 
440
546
  # auth_names
441
- auth_names = opts[:auth_names] || ['OAuth2']
547
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
442
548
 
443
549
  new_options = opts.merge(
550
+ :operation => :"PaymentAuditServiceApi.get_payments_for_payout",
444
551
  :header_params => header_params,
445
552
  :query_params => query_params,
446
553
  :form_params => form_params,
@@ -469,7 +576,7 @@ module VeloPayments
469
576
  # @option opts [Date] :submitted_date_from The submitted date from range filter. Format is yyyy-MM-dd.
470
577
  # @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
471
578
  # @option opts [Integer] :page Page number. Default is 1. (default to 1)
472
- # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25)
579
+ # @option opts [Integer] :page_size The number of results to return in a page (default to 25)
473
580
  # @option opts [String] :sort List of sort fields (e.g. ?sort&#x3D;submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status
474
581
  # @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.
475
582
  # @return [GetPaymentsForPayoutResponseV4]
@@ -491,7 +598,7 @@ module VeloPayments
491
598
  # @option opts [Date] :submitted_date_from The submitted date from range filter. Format is yyyy-MM-dd.
492
599
  # @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
493
600
  # @option opts [Integer] :page Page number. Default is 1.
494
- # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
601
+ # @option opts [Integer] :page_size The number of results to return in a page
495
602
  # @option opts [String] :sort List of sort fields (e.g. ?sort&#x3D;submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status
496
603
  # @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.
497
604
  # @return [Array<(GetPaymentsForPayoutResponseV4, Integer, Hash)>] GetPaymentsForPayoutResponseV4 data, response status code and response headers
@@ -507,6 +614,14 @@ module VeloPayments
507
614
  if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
508
615
  fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
509
616
  end
617
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
618
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.get_payments_for_payout_v4, must be smaller than or equal to 100.'
619
+ end
620
+
621
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
622
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.get_payments_for_payout_v4, must be greater than or equal to 1.'
623
+ end
624
+
510
625
  # resource path
511
626
  local_var_path = '/v4/paymentaudit/payouts/{payoutId}'.sub('{' + 'payoutId' + '}', CGI.escape(payout_id.to_s))
512
627
 
@@ -534,15 +649,16 @@ module VeloPayments
534
649
  form_params = opts[:form_params] || {}
535
650
 
536
651
  # http body (model)
537
- post_body = opts[:body]
652
+ post_body = opts[:debug_body]
538
653
 
539
654
  # return_type
540
- return_type = opts[:return_type] || 'GetPaymentsForPayoutResponseV4'
655
+ return_type = opts[:debug_return_type] || 'GetPaymentsForPayoutResponseV4'
541
656
 
542
657
  # auth_names
543
- auth_names = opts[:auth_names] || ['OAuth2']
658
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
544
659
 
545
660
  new_options = opts.merge(
661
+ :operation => :"PaymentAuditServiceApi.get_payments_for_payout_v4",
546
662
  :header_params => header_params,
547
663
  :query_params => query_params,
548
664
  :form_params => form_params,
@@ -558,8 +674,128 @@ module VeloPayments
558
674
  return data, status_code, headers
559
675
  end
560
676
 
677
+ # Get Payout Statistics
678
+ # <p>Get payout statistics for a payor.</p> <p>Deprecated (Use /v4/paymentaudit/payoutStatistics)</p>
679
+ # @param [Hash] opts the optional parameters
680
+ # @option opts [String] :payor_id The account owner Payor ID. Required for external users.
681
+ # @return [GetPayoutStatistics]
682
+ def get_payout_stats_v1(opts = {})
683
+ data, _status_code, _headers = get_payout_stats_v1_with_http_info(opts)
684
+ data
685
+ end
686
+
687
+ # Get Payout Statistics
688
+ # &lt;p&gt;Get payout statistics for a payor.&lt;/p&gt; &lt;p&gt;Deprecated (Use /v4/paymentaudit/payoutStatistics)&lt;/p&gt;
689
+ # @param [Hash] opts the optional parameters
690
+ # @option opts [String] :payor_id The account owner Payor ID. Required for external users.
691
+ # @return [Array<(GetPayoutStatistics, Integer, Hash)>] GetPayoutStatistics data, response status code and response headers
692
+ def get_payout_stats_v1_with_http_info(opts = {})
693
+ if @api_client.config.debugging
694
+ @api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.get_payout_stats_v1 ...'
695
+ end
696
+ # resource path
697
+ local_var_path = '/v1/paymentaudit/payoutStatistics'
698
+
699
+ # query parameters
700
+ query_params = opts[:query_params] || {}
701
+ query_params[:'payorId'] = opts[:'payor_id'] if !opts[:'payor_id'].nil?
702
+
703
+ # header parameters
704
+ header_params = opts[:header_params] || {}
705
+ # HTTP header 'Accept' (if needed)
706
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
707
+
708
+ # form parameters
709
+ form_params = opts[:form_params] || {}
710
+
711
+ # http body (model)
712
+ post_body = opts[:debug_body]
713
+
714
+ # return_type
715
+ return_type = opts[:debug_return_type] || 'GetPayoutStatistics'
716
+
717
+ # auth_names
718
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
719
+
720
+ new_options = opts.merge(
721
+ :operation => :"PaymentAuditServiceApi.get_payout_stats_v1",
722
+ :header_params => header_params,
723
+ :query_params => query_params,
724
+ :form_params => form_params,
725
+ :body => post_body,
726
+ :auth_names => auth_names,
727
+ :return_type => return_type
728
+ )
729
+
730
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
731
+ if @api_client.config.debugging
732
+ @api_client.config.logger.debug "API called: PaymentAuditServiceApi#get_payout_stats_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
733
+ end
734
+ return data, status_code, headers
735
+ end
736
+
737
+ # Get Payout Statistics
738
+ # <p>Get payout statistics for a payor.</p>
739
+ # @param [Hash] opts the optional parameters
740
+ # @option opts [String] :payor_id The account owner Payor ID. Required for external users.
741
+ # @return [GetPayoutStatistics]
742
+ def get_payout_stats_v4(opts = {})
743
+ data, _status_code, _headers = get_payout_stats_v4_with_http_info(opts)
744
+ data
745
+ end
746
+
747
+ # Get Payout Statistics
748
+ # &lt;p&gt;Get payout statistics for a payor.&lt;/p&gt;
749
+ # @param [Hash] opts the optional parameters
750
+ # @option opts [String] :payor_id The account owner Payor ID. Required for external users.
751
+ # @return [Array<(GetPayoutStatistics, Integer, Hash)>] GetPayoutStatistics data, response status code and response headers
752
+ def get_payout_stats_v4_with_http_info(opts = {})
753
+ if @api_client.config.debugging
754
+ @api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.get_payout_stats_v4 ...'
755
+ end
756
+ # resource path
757
+ local_var_path = '/v4/paymentaudit/payoutStatistics'
758
+
759
+ # query parameters
760
+ query_params = opts[:query_params] || {}
761
+ query_params[:'payorId'] = opts[:'payor_id'] if !opts[:'payor_id'].nil?
762
+
763
+ # header parameters
764
+ header_params = opts[:header_params] || {}
765
+ # HTTP header 'Accept' (if needed)
766
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
767
+
768
+ # form parameters
769
+ form_params = opts[:form_params] || {}
770
+
771
+ # http body (model)
772
+ post_body = opts[:debug_body]
773
+
774
+ # return_type
775
+ return_type = opts[:debug_return_type] || 'GetPayoutStatistics'
776
+
777
+ # auth_names
778
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
779
+
780
+ new_options = opts.merge(
781
+ :operation => :"PaymentAuditServiceApi.get_payout_stats_v4",
782
+ :header_params => header_params,
783
+ :query_params => query_params,
784
+ :form_params => form_params,
785
+ :body => post_body,
786
+ :auth_names => auth_names,
787
+ :return_type => return_type
788
+ )
789
+
790
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
791
+ if @api_client.config.debugging
792
+ @api_client.config.logger.debug "API called: PaymentAuditServiceApi#get_payout_stats_v4\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
793
+ end
794
+ return data, status_code, headers
795
+ end
796
+
561
797
  # Get Payouts for Payor
562
- # Get List of payouts for payor
798
+ # <p>Get List of payouts for payor</p> <p>Deprecated Use v4</p>
563
799
  # @param payor_id [String] The account owner Payor ID
564
800
  # @param [Hash] opts the optional parameters
565
801
  # @option opts [String] :payout_memo Payout Memo filter - case insensitive sub-string match
@@ -567,7 +803,7 @@ module VeloPayments
567
803
  # @option opts [Date] :submitted_date_from The submitted date from range filter. Format is yyyy-MM-dd.
568
804
  # @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
569
805
  # @option opts [Integer] :page Page number. Default is 1. (default to 1)
570
- # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25)
806
+ # @option opts [Integer] :page_size The number of results to return in a page (default to 25)
571
807
  # @option opts [String] :sort List of sort fields (e.g. ?sort&#x3D;submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status.
572
808
  # @return [GetPayoutsResponseV3]
573
809
  def get_payouts_for_payor_v3(payor_id, opts = {})
@@ -576,7 +812,7 @@ module VeloPayments
576
812
  end
577
813
 
578
814
  # Get Payouts for Payor
579
- # Get List of payouts for payor
815
+ # &lt;p&gt;Get List of payouts for payor&lt;/p&gt; &lt;p&gt;Deprecated Use v4&lt;/p&gt;
580
816
  # @param payor_id [String] The account owner Payor ID
581
817
  # @param [Hash] opts the optional parameters
582
818
  # @option opts [String] :payout_memo Payout Memo filter - case insensitive sub-string match
@@ -584,7 +820,7 @@ module VeloPayments
584
820
  # @option opts [Date] :submitted_date_from The submitted date from range filter. Format is yyyy-MM-dd.
585
821
  # @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
586
822
  # @option opts [Integer] :page Page number. Default is 1.
587
- # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
823
+ # @option opts [Integer] :page_size The number of results to return in a page
588
824
  # @option opts [String] :sort List of sort fields (e.g. ?sort&#x3D;submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status.
589
825
  # @return [Array<(GetPayoutsResponseV3, Integer, Hash)>] GetPayoutsResponseV3 data, response status code and response headers
590
826
  def get_payouts_for_payor_v3_with_http_info(payor_id, opts = {})
@@ -599,6 +835,14 @@ module VeloPayments
599
835
  if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
600
836
  fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
601
837
  end
838
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
839
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.get_payouts_for_payor_v3, must be smaller than or equal to 100.'
840
+ end
841
+
842
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
843
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.get_payouts_for_payor_v3, must be greater than or equal to 1.'
844
+ end
845
+
602
846
  # resource path
603
847
  local_var_path = '/v3/paymentaudit/payouts'
604
848
 
@@ -622,15 +866,16 @@ module VeloPayments
622
866
  form_params = opts[:form_params] || {}
623
867
 
624
868
  # http body (model)
625
- post_body = opts[:body]
869
+ post_body = opts[:debug_body]
626
870
 
627
871
  # return_type
628
- return_type = opts[:return_type] || 'GetPayoutsResponseV3'
872
+ return_type = opts[:debug_return_type] || 'GetPayoutsResponseV3'
629
873
 
630
874
  # auth_names
631
- auth_names = opts[:auth_names] || ['OAuth2']
875
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
632
876
 
633
877
  new_options = opts.merge(
878
+ :operation => :"PaymentAuditServiceApi.get_payouts_for_payor_v3",
634
879
  :header_params => header_params,
635
880
  :query_params => query_params,
636
881
  :form_params => form_params,
@@ -656,7 +901,7 @@ module VeloPayments
656
901
  # @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
657
902
  # @option opts [String] :from_payor_name The name of the payor whose payees are being paid. This filters via a case insensitive substring match.
658
903
  # @option opts [Integer] :page Page number. Default is 1. (default to 1)
659
- # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25)
904
+ # @option opts [Integer] :page_size The number of results to return in a page (default to 25)
660
905
  # @option opts [String] :sort List of sort fields (e.g. ?sort&#x3D;submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status, totalPayments, payoutId
661
906
  # @return [GetPayoutsResponseV4]
662
907
  def get_payouts_for_payor_v4(opts = {})
@@ -674,7 +919,7 @@ module VeloPayments
674
919
  # @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
675
920
  # @option opts [String] :from_payor_name The name of the payor whose payees are being paid. This filters via a case insensitive substring match.
676
921
  # @option opts [Integer] :page Page number. Default is 1.
677
- # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
922
+ # @option opts [Integer] :page_size The number of results to return in a page
678
923
  # @option opts [String] :sort List of sort fields (e.g. ?sort&#x3D;submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status, totalPayments, payoutId
679
924
  # @return [Array<(GetPayoutsResponseV4, Integer, Hash)>] GetPayoutsResponseV4 data, response status code and response headers
680
925
  def get_payouts_for_payor_v4_with_http_info(opts = {})
@@ -685,6 +930,14 @@ module VeloPayments
685
930
  if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
686
931
  fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
687
932
  end
933
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
934
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.get_payouts_for_payor_v4, must be smaller than or equal to 100.'
935
+ end
936
+
937
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
938
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.get_payouts_for_payor_v4, must be greater than or equal to 1.'
939
+ end
940
+
688
941
  # resource path
689
942
  local_var_path = '/v4/paymentaudit/payouts'
690
943
 
@@ -709,15 +962,16 @@ module VeloPayments
709
962
  form_params = opts[:form_params] || {}
710
963
 
711
964
  # http body (model)
712
- post_body = opts[:body]
965
+ post_body = opts[:debug_body]
713
966
 
714
967
  # return_type
715
- return_type = opts[:return_type] || 'GetPayoutsResponseV4'
968
+ return_type = opts[:debug_return_type] || 'GetPayoutsResponseV4'
716
969
 
717
970
  # auth_names
718
- auth_names = opts[:auth_names] || ['OAuth2']
971
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
719
972
 
720
973
  new_options = opts.merge(
974
+ :operation => :"PaymentAuditServiceApi.get_payouts_for_payor_v4",
721
975
  :header_params => header_params,
722
976
  :query_params => query_params,
723
977
  :form_params => form_params,
@@ -736,10 +990,10 @@ module VeloPayments
736
990
  # List Payment Changes
737
991
  # Get a paginated response listing payment changes.
738
992
  # @param payor_id [String] The Payor ID to find associated Payments
739
- # @param updated_since [DateTime] The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
993
+ # @param updated_since [Time] The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
740
994
  # @param [Hash] opts the optional parameters
741
995
  # @option opts [Integer] :page Page number. Default is 1. (default to 1)
742
- # @option opts [Integer] :page_size Page size. Default is 100. Max allowable is 1000. (default to 100)
996
+ # @option opts [Integer] :page_size The number of results to return in a page (default to 100)
743
997
  # @return [PaymentDeltaResponse]
744
998
  def list_payment_changes(payor_id, updated_since, opts = {})
745
999
  data, _status_code, _headers = list_payment_changes_with_http_info(payor_id, updated_since, opts)
@@ -749,10 +1003,10 @@ module VeloPayments
749
1003
  # List Payment Changes
750
1004
  # Get a paginated response listing payment changes.
751
1005
  # @param payor_id [String] The Payor ID to find associated Payments
752
- # @param updated_since [DateTime] The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
1006
+ # @param updated_since [Time] The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
753
1007
  # @param [Hash] opts the optional parameters
754
1008
  # @option opts [Integer] :page Page number. Default is 1.
755
- # @option opts [Integer] :page_size Page size. Default is 100. Max allowable is 1000.
1009
+ # @option opts [Integer] :page_size The number of results to return in a page
756
1010
  # @return [Array<(PaymentDeltaResponse, Integer, Hash)>] PaymentDeltaResponse data, response status code and response headers
757
1011
  def list_payment_changes_with_http_info(payor_id, updated_since, opts = {})
758
1012
  if @api_client.config.debugging
@@ -766,6 +1020,14 @@ module VeloPayments
766
1020
  if @api_client.config.client_side_validation && updated_since.nil?
767
1021
  fail ArgumentError, "Missing the required parameter 'updated_since' when calling PaymentAuditServiceApi.list_payment_changes"
768
1022
  end
1023
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
1024
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.list_payment_changes, must be smaller than or equal to 1000.'
1025
+ end
1026
+
1027
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
1028
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.list_payment_changes, must be greater than or equal to 1.'
1029
+ end
1030
+
769
1031
  # resource path
770
1032
  local_var_path = '/v1/deltas/payments'
771
1033
 
@@ -785,15 +1047,16 @@ module VeloPayments
785
1047
  form_params = opts[:form_params] || {}
786
1048
 
787
1049
  # http body (model)
788
- post_body = opts[:body]
1050
+ post_body = opts[:debug_body]
789
1051
 
790
1052
  # return_type
791
- return_type = opts[:return_type] || 'PaymentDeltaResponse'
1053
+ return_type = opts[:debug_return_type] || 'PaymentDeltaResponse'
792
1054
 
793
1055
  # auth_names
794
- auth_names = opts[:auth_names] || ['OAuth2']
1056
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
795
1057
 
796
1058
  new_options = opts.merge(
1059
+ :operation => :"PaymentAuditServiceApi.list_payment_changes",
797
1060
  :header_params => header_params,
798
1061
  :query_params => query_params,
799
1062
  :form_params => form_params,
@@ -809,6 +1072,91 @@ module VeloPayments
809
1072
  return data, status_code, headers
810
1073
  end
811
1074
 
1075
+ # List Payment Changes
1076
+ # Get a paginated response listing payment changes.
1077
+ # @param payor_id [String] The Payor ID to find associated Payments
1078
+ # @param updated_since [Time] The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
1079
+ # @param [Hash] opts the optional parameters
1080
+ # @option opts [Integer] :page Page number. Default is 1. (default to 1)
1081
+ # @option opts [Integer] :page_size The number of results to return in a page (default to 100)
1082
+ # @return [PaymentDeltaResponseV4]
1083
+ def list_payment_changes_v4(payor_id, updated_since, opts = {})
1084
+ data, _status_code, _headers = list_payment_changes_v4_with_http_info(payor_id, updated_since, opts)
1085
+ data
1086
+ end
1087
+
1088
+ # List Payment Changes
1089
+ # Get a paginated response listing payment changes.
1090
+ # @param payor_id [String] The Payor ID to find associated Payments
1091
+ # @param updated_since [Time] The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
1092
+ # @param [Hash] opts the optional parameters
1093
+ # @option opts [Integer] :page Page number. Default is 1.
1094
+ # @option opts [Integer] :page_size The number of results to return in a page
1095
+ # @return [Array<(PaymentDeltaResponseV4, Integer, Hash)>] PaymentDeltaResponseV4 data, response status code and response headers
1096
+ def list_payment_changes_v4_with_http_info(payor_id, updated_since, opts = {})
1097
+ if @api_client.config.debugging
1098
+ @api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.list_payment_changes_v4 ...'
1099
+ end
1100
+ # verify the required parameter 'payor_id' is set
1101
+ if @api_client.config.client_side_validation && payor_id.nil?
1102
+ fail ArgumentError, "Missing the required parameter 'payor_id' when calling PaymentAuditServiceApi.list_payment_changes_v4"
1103
+ end
1104
+ # verify the required parameter 'updated_since' is set
1105
+ if @api_client.config.client_side_validation && updated_since.nil?
1106
+ fail ArgumentError, "Missing the required parameter 'updated_since' when calling PaymentAuditServiceApi.list_payment_changes_v4"
1107
+ end
1108
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
1109
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.list_payment_changes_v4, must be smaller than or equal to 1000.'
1110
+ end
1111
+
1112
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
1113
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.list_payment_changes_v4, must be greater than or equal to 1.'
1114
+ end
1115
+
1116
+ # resource path
1117
+ local_var_path = '/v4/payments/deltas'
1118
+
1119
+ # query parameters
1120
+ query_params = opts[:query_params] || {}
1121
+ query_params[:'payorId'] = payor_id
1122
+ query_params[:'updatedSince'] = updated_since
1123
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
1124
+ query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
1125
+
1126
+ # header parameters
1127
+ header_params = opts[:header_params] || {}
1128
+ # HTTP header 'Accept' (if needed)
1129
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1130
+
1131
+ # form parameters
1132
+ form_params = opts[:form_params] || {}
1133
+
1134
+ # http body (model)
1135
+ post_body = opts[:debug_body]
1136
+
1137
+ # return_type
1138
+ return_type = opts[:debug_return_type] || 'PaymentDeltaResponseV4'
1139
+
1140
+ # auth_names
1141
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
1142
+
1143
+ new_options = opts.merge(
1144
+ :operation => :"PaymentAuditServiceApi.list_payment_changes_v4",
1145
+ :header_params => header_params,
1146
+ :query_params => query_params,
1147
+ :form_params => form_params,
1148
+ :body => post_body,
1149
+ :auth_names => auth_names,
1150
+ :return_type => return_type
1151
+ )
1152
+
1153
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1154
+ if @api_client.config.debugging
1155
+ @api_client.config.logger.debug "API called: PaymentAuditServiceApi#list_payment_changes_v4\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1156
+ end
1157
+ return data, status_code, headers
1158
+ end
1159
+
812
1160
  # Get List of Payments
813
1161
  # Get payments for the given payor Id
814
1162
  # @param [Hash] opts the optional parameters
@@ -828,10 +1176,10 @@ module VeloPayments
828
1176
  # @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
829
1177
  # @option opts [String] :payment_memo The payment memo filter. This filters via a case insensitive substring match.
830
1178
  # @option opts [Integer] :page Page number. Default is 1. (default to 1)
831
- # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25)
1179
+ # @option opts [Integer] :page_size The number of results to return in a page (default to 25)
832
1180
  # @option opts [String] :sort List of sort fields (e.g. ?sort&#x3D;submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status
833
1181
  # @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.
834
- # @return [ListPaymentsResponse]
1182
+ # @return [ListPaymentsResponseV3]
835
1183
  def list_payments_audit(opts = {})
836
1184
  data, _status_code, _headers = list_payments_audit_with_http_info(opts)
837
1185
  data
@@ -856,10 +1204,10 @@ module VeloPayments
856
1204
  # @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
857
1205
  # @option opts [String] :payment_memo The payment memo filter. This filters via a case insensitive substring match.
858
1206
  # @option opts [Integer] :page Page number. Default is 1.
859
- # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
1207
+ # @option opts [Integer] :page_size The number of results to return in a page
860
1208
  # @option opts [String] :sort List of sort fields (e.g. ?sort&#x3D;submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status
861
1209
  # @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.
862
- # @return [Array<(ListPaymentsResponse, Integer, Hash)>] ListPaymentsResponse data, response status code and response headers
1210
+ # @return [Array<(ListPaymentsResponseV3, Integer, Hash)>] ListPaymentsResponseV3 data, response status code and response headers
863
1211
  def list_payments_audit_with_http_info(opts = {})
864
1212
  if @api_client.config.debugging
865
1213
  @api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.list_payments_audit ...'
@@ -868,6 +1216,14 @@ module VeloPayments
868
1216
  if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
869
1217
  fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
870
1218
  end
1219
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
1220
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.list_payments_audit, must be smaller than or equal to 100.'
1221
+ end
1222
+
1223
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
1224
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.list_payments_audit, must be greater than or equal to 1.'
1225
+ end
1226
+
871
1227
  # resource path
872
1228
  local_var_path = '/v3/paymentaudit/payments'
873
1229
 
@@ -902,15 +1258,16 @@ module VeloPayments
902
1258
  form_params = opts[:form_params] || {}
903
1259
 
904
1260
  # http body (model)
905
- post_body = opts[:body]
1261
+ post_body = opts[:debug_body]
906
1262
 
907
1263
  # return_type
908
- return_type = opts[:return_type] || 'ListPaymentsResponse'
1264
+ return_type = opts[:debug_return_type] || 'ListPaymentsResponseV3'
909
1265
 
910
1266
  # auth_names
911
- auth_names = opts[:auth_names] || ['OAuth2']
1267
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
912
1268
 
913
1269
  new_options = opts.merge(
1270
+ :operation => :"PaymentAuditServiceApi.list_payments_audit",
914
1271
  :header_params => header_params,
915
1272
  :query_params => query_params,
916
1273
  :form_params => form_params,
@@ -945,7 +1302,7 @@ module VeloPayments
945
1302
  # @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
946
1303
  # @option opts [String] :payment_memo The payment memo filter. This filters via a case insensitive substring match.
947
1304
  # @option opts [Integer] :page Page number. Default is 1. (default to 1)
948
- # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25)
1305
+ # @option opts [Integer] :page_size The number of results to return in a page (default to 25)
949
1306
  # @option opts [String] :sort List of sort fields (e.g. ?sort&#x3D;submittedDateTime:asc,status:asc). Default is sort by submittedDateTime:desc,paymentId:asc The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime, status and paymentId
950
1307
  # @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.
951
1308
  # @return [ListPaymentsResponseV4]
@@ -973,7 +1330,7 @@ module VeloPayments
973
1330
  # @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
974
1331
  # @option opts [String] :payment_memo The payment memo filter. This filters via a case insensitive substring match.
975
1332
  # @option opts [Integer] :page Page number. Default is 1.
976
- # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
1333
+ # @option opts [Integer] :page_size The number of results to return in a page
977
1334
  # @option opts [String] :sort List of sort fields (e.g. ?sort&#x3D;submittedDateTime:asc,status:asc). Default is sort by submittedDateTime:desc,paymentId:asc The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime, status and paymentId
978
1335
  # @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.
979
1336
  # @return [Array<(ListPaymentsResponseV4, Integer, Hash)>] ListPaymentsResponseV4 data, response status code and response headers
@@ -985,6 +1342,14 @@ module VeloPayments
985
1342
  if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
986
1343
  fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
987
1344
  end
1345
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
1346
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.list_payments_audit_v4, must be smaller than or equal to 100.'
1347
+ end
1348
+
1349
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
1350
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PaymentAuditServiceApi.list_payments_audit_v4, must be greater than or equal to 1.'
1351
+ end
1352
+
988
1353
  # resource path
989
1354
  local_var_path = '/v4/paymentaudit/payments'
990
1355
 
@@ -1019,15 +1384,16 @@ module VeloPayments
1019
1384
  form_params = opts[:form_params] || {}
1020
1385
 
1021
1386
  # http body (model)
1022
- post_body = opts[:body]
1387
+ post_body = opts[:debug_body]
1023
1388
 
1024
1389
  # return_type
1025
- return_type = opts[:return_type] || 'ListPaymentsResponseV4'
1390
+ return_type = opts[:debug_return_type] || 'ListPaymentsResponseV4'
1026
1391
 
1027
1392
  # auth_names
1028
- auth_names = opts[:auth_names] || ['OAuth2']
1393
+ auth_names = opts[:debug_auth_names] || ['OAuth2']
1029
1394
 
1030
1395
  new_options = opts.merge(
1396
+ :operation => :"PaymentAuditServiceApi.list_payments_audit_v4",
1031
1397
  :header_params => header_params,
1032
1398
  :query_params => query_params,
1033
1399
  :form_params => form_params,