velopayments 2.19.40.beta1 → 2.26.124.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 (923) hide show
  1. checksums.yaml +4 -4
  2. data/Dockerfile +7 -0
  3. data/Gemfile +1 -1
  4. data/Makefile +7 -12
  5. data/README.md +164 -101
  6. data/docs/AcceptedPaymentV3.md +32 -0
  7. data/docs/AccessTokenResponse.md +20 -19
  8. data/docs/AccessTokenValidationRequest.md +8 -7
  9. data/docs/AuthResponse.md +18 -17
  10. data/docs/AutoTopUpConfig.md +12 -11
  11. data/docs/AutoTopUpConfig2.md +24 -0
  12. data/docs/Category.md +15 -0
  13. data/docs/Challenge.md +10 -9
  14. data/docs/Challenge2.md +20 -0
  15. data/docs/Company.md +12 -11
  16. data/docs/Company2.md +12 -11
  17. data/docs/CountriesApi.md +91 -38
  18. data/docs/CreateFundingAccountRequestV2.md +30 -0
  19. data/docs/CreateIndividual.md +12 -11
  20. data/docs/CreateIndividual2.md +12 -11
  21. data/docs/CreateIndividualName.md +24 -0
  22. data/docs/CreatePayee.md +28 -27
  23. data/docs/CreatePayee2.md +28 -27
  24. data/docs/CreatePayeeAddress.md +22 -21
  25. data/docs/CreatePayeeAddress2.md +22 -21
  26. data/docs/CreatePayeesCSVResponse.md +10 -9
  27. data/docs/CreatePayeesCSVResponse2.md +10 -9
  28. data/docs/CreatePayeesCSVResponseRejectedCsvRows.md +12 -11
  29. data/docs/CreatePayeesRequest.md +10 -9
  30. data/docs/CreatePayeesRequest2.md +10 -9
  31. data/docs/CreatePaymentChannel.md +20 -19
  32. data/docs/CreatePaymentChannel2.md +20 -19
  33. data/docs/CreatePayorLinkRequest.md +12 -11
  34. data/docs/CreatePayoutRequestV3.md +24 -0
  35. data/docs/CreateWebhookRequest.md +26 -0
  36. data/docs/CurrenciesApi.md +29 -12
  37. data/docs/DebitEvent.md +24 -0
  38. data/docs/DebitEventAllOf.md +18 -0
  39. data/docs/DebitStatusChanged.md +26 -0
  40. data/docs/DebitStatusChangedAllOf.md +18 -0
  41. data/docs/Error.md +20 -13
  42. data/docs/ErrorData.md +20 -0
  43. data/docs/ErrorResponse.md +12 -9
  44. data/docs/FailedPayee.md +38 -0
  45. data/docs/FailedPayee2.md +38 -0
  46. data/docs/FailedSubmission.md +10 -9
  47. data/docs/FailedSubmission2.md +10 -9
  48. data/docs/FundingAccountResponse.md +26 -17
  49. data/docs/FundingAccountResponse2.md +36 -0
  50. data/docs/FundingAccountType.md +15 -0
  51. data/docs/FundingAudit.md +24 -23
  52. data/docs/FundingEvent.md +14 -13
  53. data/docs/FundingEventType.md +4 -5
  54. data/docs/FundingManagerApi.md +772 -185
  55. data/docs/FundingManagerPrivateApi.md +101 -16
  56. data/docs/FundingPayorStatusAuditResponse.md +14 -13
  57. data/docs/FundingRequestV1.md +8 -7
  58. data/docs/FundingRequestV2.md +8 -7
  59. data/docs/FundingRequestV3.md +20 -0
  60. data/docs/FxSummary.md +36 -0
  61. data/docs/FxSummaryV3.md +26 -25
  62. data/docs/GetFundingsResponse.md +12 -11
  63. data/docs/GetFundingsResponseLinks.md +20 -0
  64. data/docs/GetPayeeListResponse.md +50 -0
  65. data/docs/GetPayeeListResponse2.md +50 -0
  66. data/docs/GetPayeeListResponseCompany.md +20 -0
  67. data/docs/GetPayeeListResponseCompany2.md +20 -0
  68. data/docs/GetPayeeListResponseIndividual.md +18 -0
  69. data/docs/GetPayeeListResponseIndividual2.md +18 -0
  70. data/docs/GetPaymentsForPayoutResponseV3.md +14 -13
  71. data/docs/GetPaymentsForPayoutResponseV3Page.md +16 -15
  72. data/docs/GetPaymentsForPayoutResponseV3Summary.md +26 -25
  73. data/docs/GetPaymentsForPayoutResponseV4.md +14 -13
  74. data/docs/GetPaymentsForPayoutResponseV4Summary.md +44 -41
  75. data/docs/GetPayoutStatistics.md +10 -9
  76. data/docs/GetPayoutsResponse.md +22 -0
  77. data/docs/GetPayoutsResponseV3.md +12 -11
  78. data/docs/GetPayoutsResponseV3Links.md +10 -9
  79. data/docs/GetPayoutsResponseV3Page.md +16 -15
  80. data/docs/Individual.md +12 -11
  81. data/docs/Individual2.md +12 -11
  82. data/docs/IndividualName.md +24 -0
  83. data/docs/InlineResponse400.md +12 -9
  84. data/docs/InlineResponse401.md +12 -9
  85. data/docs/InlineResponse403.md +12 -9
  86. data/docs/InlineResponse404.md +22 -0
  87. data/docs/InlineResponse409.md +22 -0
  88. data/docs/InlineResponse412.md +22 -0
  89. data/docs/InvitationStatus.md +4 -5
  90. data/docs/InvitationStatus2.md +15 -0
  91. data/docs/InvitePayeeRequest.md +8 -7
  92. data/docs/InvitePayeeRequest2.md +8 -7
  93. data/docs/InviteUserRequest.md +26 -25
  94. data/docs/KycState.md +4 -5
  95. data/docs/LinkForResponse.md +10 -9
  96. data/docs/ListFundingAccountsResponse.md +12 -11
  97. data/docs/ListFundingAccountsResponse2.md +22 -0
  98. data/docs/ListPaymentsResponseV3.md +22 -0
  99. data/docs/ListPaymentsResponseV3Page.md +26 -0
  100. data/docs/ListPaymentsResponseV4.md +12 -11
  101. data/docs/ListSourceAccountResponse.md +12 -11
  102. data/docs/ListSourceAccountResponseLinks.md +10 -9
  103. data/docs/ListSourceAccountResponsePage.md +16 -15
  104. data/docs/ListSourceAccountResponseV2.md +12 -11
  105. data/docs/ListSourceAccountResponseV2Links.md +20 -0
  106. data/docs/ListSourceAccountResponseV3.md +22 -0
  107. data/docs/ListSourceAccountResponseV3Links.md +20 -0
  108. data/docs/LocalisationDetails.md +20 -0
  109. data/docs/LoginApi.md +113 -41
  110. data/docs/MFADetails.md +10 -9
  111. data/docs/MFAType.md +4 -5
  112. data/docs/Name.md +24 -0
  113. data/docs/Name2.md +24 -0
  114. data/docs/Notification.md +26 -0
  115. data/docs/Notifications.md +8 -7
  116. data/docs/Notifications2.md +18 -0
  117. data/docs/OfacStatus.md +4 -5
  118. data/docs/OnboardedStatus.md +4 -5
  119. data/docs/OnboardedStatus2.md +4 -5
  120. data/docs/OnboardingStatusChanged.md +26 -0
  121. data/docs/PageForResponse.md +16 -15
  122. data/docs/PageResourceFundingPayorStatusAuditResponseFundingPayorStatusAuditResponse.md +12 -11
  123. data/docs/PagedPayeeInvitationStatusResponse.md +12 -11
  124. data/docs/PagedPayeeInvitationStatusResponse2.md +12 -11
  125. data/docs/PagedPayeeInvitationStatusResponsePage.md +16 -15
  126. data/docs/PagedPayeeResponse.md +14 -13
  127. data/docs/PagedPayeeResponse2.md +14 -13
  128. data/docs/PagedPayeeResponseLinks.md +10 -9
  129. data/docs/PagedPayeeResponsePage.md +16 -15
  130. data/docs/PagedPayeeResponseSummary.md +16 -15
  131. data/docs/PagedPaymentsResponseV3.md +22 -0
  132. data/docs/PagedUserResponse.md +12 -11
  133. data/docs/PagedUserResponseLinks.md +10 -9
  134. data/docs/PagedUserResponsePage.md +16 -15
  135. data/docs/PasswordRequest.md +8 -7
  136. data/docs/PayableIssue.md +20 -0
  137. data/docs/PayableIssue2.md +20 -0
  138. data/docs/PayableStatusChanged.md +26 -0
  139. data/docs/PayeeAddress.md +22 -21
  140. data/docs/PayeeAddress2.md +22 -21
  141. data/docs/PayeeDelta.md +20 -19
  142. data/docs/PayeeDelta2.md +20 -19
  143. data/docs/PayeeDeltaResponse.md +12 -11
  144. data/docs/PayeeDeltaResponse2.md +12 -11
  145. data/docs/PayeeDeltaResponse2Links.md +10 -9
  146. data/docs/PayeeDeltaResponseLinks.md +10 -9
  147. data/docs/PayeeDeltaResponsePage.md +16 -15
  148. data/docs/PayeeDetailResponse.md +74 -0
  149. data/docs/PayeeDetailResponse2.md +74 -0
  150. data/docs/PayeeDetailsChanged.md +26 -0
  151. data/docs/PayeeEvent.md +26 -0
  152. data/docs/PayeeEventAllOf.md +20 -0
  153. data/docs/PayeeEventAllOfReasons.md +20 -0
  154. data/docs/PayeeInvitationApi.md +258 -176
  155. data/docs/PayeeInvitationStatusResponse.md +12 -11
  156. data/docs/PayeeInvitationStatusResponse2.md +12 -11
  157. data/docs/PayeePayorRef.md +20 -11
  158. data/docs/PayeePayorRefV3.md +20 -15
  159. data/docs/PayeeType.md +4 -5
  160. data/docs/PayeeUserSelfUpdateRequest.md +28 -0
  161. data/docs/PayeesApi.md +479 -219
  162. data/docs/PaymentAuditCurrency.md +15 -0
  163. data/docs/PaymentAuditCurrencyV3.md +4 -5
  164. data/docs/PaymentAuditServiceApi.md +280 -437
  165. data/docs/PaymentAuditServiceDeprecatedApi.md +675 -0
  166. data/docs/PaymentChannelCountry.md +10 -9
  167. data/docs/PaymentChannelRule.md +20 -19
  168. data/docs/PaymentChannelRulesResponse.md +8 -7
  169. data/docs/PaymentDelta.md +22 -21
  170. data/docs/PaymentDeltaResponse.md +12 -11
  171. data/docs/PaymentDeltaResponseV1.md +22 -0
  172. data/docs/PaymentDeltaV1.md +32 -0
  173. data/docs/PaymentEvent.md +28 -0
  174. data/docs/PaymentEventAllOf.md +22 -0
  175. data/docs/PaymentEventResponse.md +40 -0
  176. data/docs/PaymentEventResponseV3.md +30 -29
  177. data/docs/PaymentInstructionV3.md +34 -0
  178. data/docs/PaymentRails.md +4 -5
  179. data/docs/PaymentRejectedOrReturned.md +34 -0
  180. data/docs/PaymentRejectedOrReturnedAllOf.md +20 -0
  181. data/docs/PaymentResponseV3.md +78 -77
  182. data/docs/PaymentResponseV4.md +96 -79
  183. data/docs/PaymentResponseV4Payout.md +12 -11
  184. data/docs/PaymentStatusChanged.md +30 -0
  185. data/docs/PaymentStatusChangedAllOf.md +18 -0
  186. data/docs/PaymentV3.md +42 -0
  187. data/docs/PayorAddress.md +22 -21
  188. data/docs/PayorAddressV2.md +22 -21
  189. data/docs/PayorAmlTransaction.md +70 -0
  190. data/docs/PayorAmlTransactionV3.md +56 -61
  191. data/docs/PayorBrandingResponse.md +16 -15
  192. data/docs/PayorCreateApiKeyRequest.md +12 -11
  193. data/docs/PayorCreateApiKeyResponse.md +10 -9
  194. data/docs/PayorCreateApplicationRequest.md +10 -9
  195. data/docs/PayorEmailOptOutRequest.md +8 -7
  196. data/docs/PayorLinksResponse.md +10 -9
  197. data/docs/PayorLinksResponseLinks.md +14 -13
  198. data/docs/PayorLinksResponsePayors.md +14 -13
  199. data/docs/PayorV1.md +50 -47
  200. data/docs/PayorV2.md +52 -45
  201. data/docs/PayorsApi.md +236 -101
  202. data/docs/PayorsPrivateApi.md +29 -13
  203. data/docs/PayoutCompanyV3.md +18 -0
  204. data/docs/PayoutIndividualV3.md +18 -0
  205. data/docs/PayoutNameV3.md +20 -0
  206. data/docs/PayoutPayeeV3.md +22 -0
  207. data/docs/PayoutPayor.md +26 -0
  208. data/docs/PayoutPayorIds.md +22 -0
  209. data/docs/PayoutPrincipal.md +20 -0
  210. data/docs/PayoutServiceApi.md +513 -0
  211. data/docs/PayoutStatus.md +15 -0
  212. data/docs/PayoutStatusV3.md +4 -5
  213. data/docs/PayoutSummaryAudit.md +48 -0
  214. data/docs/PayoutSummaryAuditV3.md +30 -29
  215. data/docs/PayoutSummaryResponseV3.md +36 -0
  216. data/docs/PayoutType.md +15 -0
  217. data/docs/Ping.md +22 -0
  218. data/docs/QueryBatchResponse.md +14 -13
  219. data/docs/QueryBatchResponse2.md +14 -13
  220. data/docs/QuoteFxSummaryV3.md +38 -0
  221. data/docs/QuoteResponseV3.md +18 -0
  222. data/docs/RegionV2.md +20 -0
  223. data/docs/RegisterSmsRequest.md +8 -7
  224. data/docs/RejectedPaymentV3.md +38 -0
  225. data/docs/ResendTokenRequest.md +10 -9
  226. data/docs/ResetPasswordRequest.md +8 -7
  227. data/docs/Role.md +8 -7
  228. data/docs/RoleUpdateRequest.md +10 -9
  229. data/docs/SelfMFATypeUnregisterRequest.md +8 -7
  230. data/docs/SelfUpdatePasswordRequest.md +10 -9
  231. data/docs/SetNotificationsRequest.md +8 -7
  232. data/docs/SourceAccountResponse.md +34 -31
  233. data/docs/SourceAccountResponseV2.md +38 -35
  234. data/docs/SourceAccountResponseV3.md +52 -0
  235. data/docs/SourceAccountSummary.md +22 -0
  236. data/docs/SourceAccountSummaryV3.md +12 -11
  237. data/docs/SourceAccountType.md +15 -0
  238. data/docs/SourceAccountV3.md +24 -0
  239. data/docs/SourceEvent.md +22 -0
  240. data/docs/SupportedCountriesResponse.md +8 -7
  241. data/docs/SupportedCountriesResponseV2.md +18 -0
  242. data/docs/SupportedCountry.md +10 -9
  243. data/docs/SupportedCountryV2.md +22 -0
  244. data/docs/SupportedCurrencyResponseV2.md +18 -0
  245. data/docs/SupportedCurrencyV2.md +20 -0
  246. data/docs/TokensApi.md +31 -15
  247. data/docs/TransferRequest.md +12 -11
  248. data/docs/TransferRequest2.md +22 -0
  249. data/docs/TransmissionType.md +15 -0
  250. data/docs/TransmissionTypes.md +22 -0
  251. data/docs/TransmissionTypes2.md +22 -0
  252. data/docs/UnregisterMFARequest.md +10 -9
  253. data/docs/UpdatePayeeDetailsRequest.md +30 -0
  254. data/docs/UpdatePayeeDetailsRequest2.md +30 -0
  255. data/docs/UpdateRemoteIdRequest.md +10 -9
  256. data/docs/UpdateRemoteIdRequest2.md +20 -0
  257. data/docs/UpdateWebhookRequest.md +24 -0
  258. data/docs/UserDetailsUpdateRequest.md +22 -21
  259. data/docs/UserInfo.md +12 -11
  260. data/docs/UserResponse.md +34 -33
  261. data/docs/UserStatus.md +4 -5
  262. data/docs/UserType.md +4 -5
  263. data/docs/UserType2.md +4 -5
  264. data/docs/UsersApi.md +526 -181
  265. data/docs/ValidatePasswordResponse.md +14 -13
  266. data/docs/WatchlistStatus.md +4 -5
  267. data/docs/WatchlistStatus2.md +15 -0
  268. data/docs/WebhookResponse.md +28 -0
  269. data/docs/WebhooksApi.md +297 -0
  270. data/docs/WebhooksResponse.md +22 -0
  271. data/docs/WithdrawPaymentRequest.md +18 -0
  272. data/lib/velopayments.rb +110 -70
  273. data/lib/velopayments/api/countries_api.rb +38 -35
  274. data/lib/velopayments/api/currencies_api.rb +13 -12
  275. data/lib/velopayments/api/funding_manager_api.rb +519 -74
  276. data/lib/velopayments/api/funding_manager_private_api.rb +77 -13
  277. data/lib/velopayments/api/login_api.rb +21 -14
  278. data/lib/velopayments/api/payee_invitation_api.rb +100 -154
  279. data/lib/velopayments/api/payees_api.rb +299 -203
  280. data/lib/velopayments/api/payment_audit_service_api.rb +153 -459
  281. data/lib/velopayments/api/payment_audit_service_deprecated_api.rb +714 -0
  282. data/lib/velopayments/api/payors_api.rb +48 -40
  283. data/lib/velopayments/api/payors_private_api.rb +6 -5
  284. data/lib/velopayments/api/payout_service_api.rb +513 -0
  285. data/lib/velopayments/api/tokens_api.rb +6 -5
  286. data/lib/velopayments/api/users_api.rb +146 -54
  287. data/lib/velopayments/api/webhooks_api.rb +291 -0
  288. data/lib/velopayments/api_client.rb +51 -47
  289. data/lib/velopayments/api_error.rb +2 -2
  290. data/lib/velopayments/configuration.rb +40 -11
  291. data/lib/velopayments/models/{accepted_payment.rb → accepted_payment_v3.rb} +57 -15
  292. data/lib/velopayments/models/access_token_response.rb +20 -8
  293. data/lib/velopayments/models/access_token_validation_request.rb +20 -8
  294. data/lib/velopayments/models/auth_response.rb +20 -8
  295. data/lib/velopayments/models/auto_top_up_config.rb +20 -8
  296. data/lib/velopayments/models/auto_top_up_config2.rb +256 -0
  297. data/lib/velopayments/models/{language.rb → category.rb} +9 -16
  298. data/lib/velopayments/models/challenge.rb +20 -8
  299. data/lib/velopayments/models/challenge2.rb +293 -0
  300. data/lib/velopayments/models/company.rb +25 -13
  301. data/lib/velopayments/models/company2.rb +25 -13
  302. data/lib/velopayments/models/{payee_payment_channel.rb → create_funding_account_request_v2.rb} +146 -148
  303. data/lib/velopayments/models/create_individual.rb +21 -9
  304. data/lib/velopayments/models/create_individual2.rb +21 -9
  305. data/lib/velopayments/models/{create_individual2_name.rb → create_individual_name.rb} +23 -11
  306. data/lib/velopayments/models/create_payee.rb +24 -11
  307. data/lib/velopayments/models/create_payee2.rb +25 -12
  308. data/lib/velopayments/models/create_payee_address.rb +53 -25
  309. data/lib/velopayments/models/create_payee_address2.rb +20 -8
  310. data/lib/velopayments/models/create_payees_csv_response.rb +20 -8
  311. data/lib/velopayments/models/create_payees_csv_response2.rb +20 -8
  312. data/lib/velopayments/models/create_payees_csv_response_rejected_csv_rows.rb +20 -8
  313. data/lib/velopayments/models/create_payees_request.rb +20 -8
  314. data/lib/velopayments/models/create_payees_request2.rb +20 -8
  315. data/lib/velopayments/models/create_payment_channel.rb +20 -8
  316. data/lib/velopayments/models/create_payment_channel2.rb +20 -8
  317. data/lib/velopayments/models/create_payor_link_request.rb +20 -8
  318. data/lib/velopayments/models/{create_payout_request.rb → create_payout_request_v3.rb} +56 -26
  319. data/lib/velopayments/models/create_webhook_request.rb +338 -0
  320. data/lib/velopayments/models/debit_event.rb +278 -0
  321. data/lib/velopayments/models/debit_event_all_of.rb +224 -0
  322. data/lib/velopayments/models/debit_status_changed.rb +293 -0
  323. data/lib/velopayments/models/debit_status_changed_all_of.rb +224 -0
  324. data/lib/velopayments/models/error.rb +54 -14
  325. data/lib/velopayments/models/error_data.rb +229 -0
  326. data/lib/velopayments/models/error_response.rb +49 -14
  327. data/lib/velopayments/models/{payee_payor_ref_v2.rb → failed_payee.rb} +104 -69
  328. data/lib/velopayments/models/failed_payee2.rb +313 -0
  329. data/lib/velopayments/models/failed_submission.rb +21 -9
  330. data/lib/velopayments/models/failed_submission2.rb +21 -9
  331. data/lib/velopayments/models/funding_account_response.rb +115 -12
  332. data/lib/velopayments/models/{create_funding_account_request.rb → funding_account_response2.rb} +116 -97
  333. data/lib/velopayments/models/{location_type.rb → funding_account_type.rb} +8 -10
  334. data/lib/velopayments/models/funding_audit.rb +33 -19
  335. data/lib/velopayments/models/funding_event.rb +21 -9
  336. data/lib/velopayments/models/funding_event_type.rb +3 -2
  337. data/lib/velopayments/models/funding_payor_status_audit_response.rb +57 -9
  338. data/lib/velopayments/models/funding_request_v1.rb +20 -8
  339. data/lib/velopayments/models/funding_request_v2.rb +20 -8
  340. data/lib/velopayments/models/{payor_logo_request.rb → funding_request_v3.rb} +79 -18
  341. data/lib/velopayments/models/{fx_summary_v4.rb → fx_summary.rb} +26 -14
  342. data/lib/velopayments/models/fx_summary_v3.rb +21 -9
  343. data/lib/velopayments/models/get_fundings_response.rb +23 -18
  344. data/lib/velopayments/models/{get_fundings_response_all_of.rb → get_fundings_response_links.rb} +39 -20
  345. data/lib/velopayments/models/{payee_response2.rb → get_payee_list_response.rb} +96 -115
  346. data/lib/velopayments/models/{payee.rb → get_payee_list_response2.rb} +97 -116
  347. data/lib/velopayments/models/{company_response.rb → get_payee_list_response_company.rb} +29 -26
  348. data/lib/velopayments/models/{company_v1.rb → get_payee_list_response_company2.rb} +30 -55
  349. data/lib/velopayments/models/{user_response2_roles.rb → get_payee_list_response_individual.rb} +24 -12
  350. data/lib/velopayments/models/{paged_response.rb → get_payee_list_response_individual2.rb} +30 -29
  351. data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +20 -8
  352. data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +20 -8
  353. data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +23 -11
  354. data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +20 -8
  355. data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +43 -56
  356. data/lib/velopayments/models/get_payout_statistics.rb +20 -8
  357. data/lib/velopayments/models/{get_payouts_response_v4.rb → get_payouts_response.rb} +24 -12
  358. data/lib/velopayments/models/get_payouts_response_v3.rb +20 -8
  359. data/lib/velopayments/models/get_payouts_response_v3_links.rb +20 -8
  360. data/lib/velopayments/models/get_payouts_response_v3_page.rb +20 -8
  361. data/lib/velopayments/models/individual.rb +21 -9
  362. data/lib/velopayments/models/individual2.rb +21 -9
  363. data/lib/velopayments/models/{individual_v1_name.rb → individual_name.rb} +23 -11
  364. data/lib/velopayments/models/inline_response400.rb +51 -14
  365. data/lib/velopayments/models/inline_response401.rb +51 -14
  366. data/lib/velopayments/models/inline_response403.rb +51 -14
  367. data/lib/velopayments/models/inline_response404.rb +258 -0
  368. data/lib/velopayments/models/inline_response409.rb +258 -0
  369. data/lib/velopayments/models/inline_response412.rb +258 -0
  370. data/lib/velopayments/models/invitation_status.rb +3 -2
  371. data/lib/velopayments/models/invitation_status2.rb +38 -0
  372. data/lib/velopayments/models/invite_payee_request.rb +20 -8
  373. data/lib/velopayments/models/invite_payee_request2.rb +20 -8
  374. data/lib/velopayments/models/invite_user_request.rb +29 -17
  375. data/lib/velopayments/models/kyc_state.rb +3 -2
  376. data/lib/velopayments/models/link_for_response.rb +20 -8
  377. data/lib/velopayments/models/list_funding_accounts_response.rb +20 -8
  378. data/lib/velopayments/models/list_funding_accounts_response2.rb +241 -0
  379. data/lib/velopayments/models/{list_payments_response.rb → list_payments_response_v3.rb} +24 -12
  380. data/lib/velopayments/models/{list_payments_response_page.rb → list_payments_response_v3_page.rb} +23 -11
  381. data/lib/velopayments/models/list_payments_response_v4.rb +21 -9
  382. data/lib/velopayments/models/list_source_account_response.rb +20 -8
  383. data/lib/velopayments/models/list_source_account_response_links.rb +20 -8
  384. data/lib/velopayments/models/list_source_account_response_page.rb +20 -8
  385. data/lib/velopayments/models/list_source_account_response_v2.rb +21 -9
  386. data/lib/velopayments/models/{invitation_status_response.rb → list_source_account_response_v2_links.rb} +39 -25
  387. data/lib/velopayments/models/list_source_account_response_v3.rb +241 -0
  388. data/lib/velopayments/models/list_source_account_response_v3_links.rb +227 -0
  389. data/lib/velopayments/models/localisation_details.rb +231 -0
  390. data/lib/velopayments/models/mfa_details.rb +20 -8
  391. data/lib/velopayments/models/mfa_type.rb +3 -2
  392. data/lib/velopayments/models/name.rb +341 -0
  393. data/lib/velopayments/models/name2.rb +341 -0
  394. data/lib/velopayments/models/{individual_v1.rb → notification.rb} +77 -58
  395. data/lib/velopayments/models/notifications.rb +20 -8
  396. data/lib/velopayments/models/{marketing_opt_in.rb → notifications2.rb} +30 -27
  397. data/lib/velopayments/models/ofac_status.rb +3 -2
  398. data/lib/velopayments/models/onboarded_status.rb +3 -2
  399. data/lib/velopayments/models/onboarded_status2.rb +3 -2
  400. data/lib/velopayments/models/{inline_response400_errors.rb → onboarding_status_changed.rb} +92 -39
  401. data/lib/velopayments/models/page_for_response.rb +20 -8
  402. data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +20 -8
  403. data/lib/velopayments/models/paged_payee_invitation_status_response.rb +20 -8
  404. data/lib/velopayments/models/paged_payee_invitation_status_response2.rb +20 -8
  405. data/lib/velopayments/models/paged_payee_invitation_status_response_page.rb +20 -8
  406. data/lib/velopayments/models/paged_payee_response.rb +21 -9
  407. data/lib/velopayments/models/paged_payee_response2.rb +22 -10
  408. data/lib/velopayments/models/paged_payee_response_links.rb +20 -8
  409. data/lib/velopayments/models/paged_payee_response_page.rb +20 -8
  410. data/lib/velopayments/models/paged_payee_response_summary.rb +27 -15
  411. data/lib/velopayments/models/paged_payments_response_v3.rb +241 -0
  412. data/lib/velopayments/models/paged_user_response.rb +20 -8
  413. data/lib/velopayments/models/paged_user_response_links.rb +20 -8
  414. data/lib/velopayments/models/paged_user_response_page.rb +20 -8
  415. data/lib/velopayments/models/password_request.rb +20 -8
  416. data/lib/velopayments/models/payable_issue.rb +238 -0
  417. data/lib/velopayments/models/payable_issue2.rb +238 -0
  418. data/lib/velopayments/models/payable_status_changed.rb +289 -0
  419. data/lib/velopayments/models/payee_address.rb +20 -8
  420. data/lib/velopayments/models/payee_address2.rb +20 -8
  421. data/lib/velopayments/models/payee_delta.rb +21 -9
  422. data/lib/velopayments/models/payee_delta2.rb +20 -8
  423. data/lib/velopayments/models/payee_delta_response.rb +20 -8
  424. data/lib/velopayments/models/payee_delta_response2.rb +20 -8
  425. data/lib/velopayments/models/payee_delta_response2_links.rb +20 -8
  426. data/lib/velopayments/models/payee_delta_response_links.rb +20 -8
  427. data/lib/velopayments/models/payee_delta_response_page.rb +20 -8
  428. data/lib/velopayments/models/{payee_response_v3.rb → payee_detail_response.rb} +45 -23
  429. data/lib/velopayments/models/{payee_response_v2.rb → payee_detail_response2.rb} +77 -64
  430. data/lib/velopayments/models/payee_details_changed.rb +289 -0
  431. data/lib/velopayments/models/{payee_invitation_status.rb → payee_event.rb} +86 -64
  432. data/lib/velopayments/models/payee_event_all_of.rb +236 -0
  433. data/lib/velopayments/models/payee_event_all_of_reasons.rb +237 -0
  434. data/lib/velopayments/models/payee_invitation_status_response.rb +20 -8
  435. data/lib/velopayments/models/payee_invitation_status_response2.rb +20 -8
  436. data/lib/velopayments/models/payee_payor_ref.rb +66 -12
  437. data/lib/velopayments/models/payee_payor_ref_v3.rb +46 -46
  438. data/lib/velopayments/models/payee_type.rb +3 -2
  439. data/lib/velopayments/models/{user_response2.rb → payee_user_self_update_request.rb} +64 -196
  440. data/lib/velopayments/models/{payment_audit_currency_v4.rb → payment_audit_currency.rb} +6 -5
  441. data/lib/velopayments/models/payment_audit_currency_v3.rb +3 -2
  442. data/lib/velopayments/models/payment_channel_country.rb +20 -8
  443. data/lib/velopayments/models/payment_channel_rule.rb +20 -8
  444. data/lib/velopayments/models/payment_channel_rules_response.rb +20 -8
  445. data/lib/velopayments/models/payment_delta.rb +20 -8
  446. data/lib/velopayments/models/payment_delta_response.rb +20 -8
  447. data/lib/velopayments/models/payment_delta_response_v1.rb +241 -0
  448. data/lib/velopayments/models/payment_delta_v1.rb +297 -0
  449. data/lib/velopayments/models/payment_event.rb +297 -0
  450. data/lib/velopayments/models/{paged_response_page.rb → payment_event_all_of.rb} +49 -48
  451. data/lib/velopayments/models/{payment_event_response_v4.rb → payment_event_response.rb} +28 -16
  452. data/lib/velopayments/models/payment_event_response_v3.rb +21 -9
  453. data/lib/velopayments/models/{payment_instruction.rb → payment_instruction_v3.rb} +148 -16
  454. data/lib/velopayments/models/payment_rails.rb +3 -2
  455. data/lib/velopayments/models/payment_rejected_or_returned.rb +342 -0
  456. data/lib/velopayments/models/{inline_response403_errors.rb → payment_rejected_or_returned_all_of.rb} +48 -45
  457. data/lib/velopayments/models/payment_response_v3.rb +21 -9
  458. data/lib/velopayments/models/payment_response_v4.rb +101 -13
  459. data/lib/velopayments/models/payment_response_v4_payout.rb +22 -10
  460. data/lib/velopayments/models/payment_status_changed.rb +312 -0
  461. data/lib/velopayments/models/payment_status_changed_all_of.rb +224 -0
  462. data/lib/velopayments/models/payment_v3.rb +389 -0
  463. data/lib/velopayments/models/payor_address.rb +20 -8
  464. data/lib/velopayments/models/payor_address_v2.rb +20 -8
  465. data/lib/velopayments/models/{payor_aml_transaction_v4.rb → payor_aml_transaction.rb} +24 -21
  466. data/lib/velopayments/models/payor_aml_transaction_v3.rb +21 -36
  467. data/lib/velopayments/models/payor_branding_response.rb +20 -8
  468. data/lib/velopayments/models/payor_create_api_key_request.rb +30 -8
  469. data/lib/velopayments/models/payor_create_api_key_response.rb +20 -8
  470. data/lib/velopayments/models/payor_create_application_request.rb +20 -8
  471. data/lib/velopayments/models/payor_email_opt_out_request.rb +20 -8
  472. data/lib/velopayments/models/payor_links_response.rb +20 -8
  473. data/lib/velopayments/models/payor_links_response_links.rb +20 -8
  474. data/lib/velopayments/models/payor_links_response_payors.rb +20 -8
  475. data/lib/velopayments/models/payor_v1.rb +33 -12
  476. data/lib/velopayments/models/payor_v2.rb +55 -12
  477. data/lib/velopayments/models/payout_company_v3.rb +223 -0
  478. data/lib/velopayments/models/{individual_response.rb → payout_individual_v3.rb} +24 -12
  479. data/lib/velopayments/models/payout_name_v3.rb +237 -0
  480. data/lib/velopayments/models/payout_payee_v3.rb +242 -0
  481. data/lib/velopayments/models/{payout_payor_v4.rb → payout_payor.rb} +23 -11
  482. data/lib/velopayments/models/payout_payor_ids.rb +255 -0
  483. data/lib/velopayments/models/{payout_principal_v4.rb → payout_principal.rb} +23 -11
  484. data/lib/velopayments/models/{payout_status_v4.rb → payout_status.rb} +6 -5
  485. data/lib/velopayments/models/payout_status_v3.rb +3 -2
  486. data/lib/velopayments/models/{payout_summary_audit_v4.rb → payout_summary_audit.rb} +39 -18
  487. data/lib/velopayments/models/payout_summary_audit_v3.rb +20 -8
  488. data/lib/velopayments/models/{payout_summary_response.rb → payout_summary_response_v3.rb} +42 -16
  489. data/lib/velopayments/models/{payout_type_v4.rb → payout_type.rb} +6 -5
  490. data/lib/velopayments/models/ping.rb +262 -0
  491. data/lib/velopayments/models/query_batch_response.rb +20 -8
  492. data/lib/velopayments/models/query_batch_response2.rb +20 -8
  493. data/lib/velopayments/models/{quote_fx_summary.rb → quote_fx_summary_v3.rb} +49 -13
  494. data/lib/velopayments/models/{quote_response.rb → quote_response_v3.rb} +24 -12
  495. data/lib/velopayments/models/{region.rb → region_v2.rb} +23 -11
  496. data/lib/velopayments/models/register_sms_request.rb +23 -11
  497. data/lib/velopayments/models/{rejected_payment.rb → rejected_payment_v3.rb} +54 -12
  498. data/lib/velopayments/models/resend_token_request.rb +20 -8
  499. data/lib/velopayments/models/reset_password_request.rb +20 -8
  500. data/lib/velopayments/models/role.rb +20 -8
  501. data/lib/velopayments/models/role_update_request.rb +20 -8
  502. data/lib/velopayments/models/self_mfa_type_unregister_request.rb +20 -8
  503. data/lib/velopayments/models/self_update_password_request.rb +20 -8
  504. data/lib/velopayments/models/set_notifications_request.rb +20 -8
  505. data/lib/velopayments/models/source_account_response.rb +34 -13
  506. data/lib/velopayments/models/source_account_response_v2.rb +36 -15
  507. data/lib/velopayments/models/{payee_payment_channel2.rb → source_account_response_v3.rb} +196 -182
  508. data/lib/velopayments/models/{source_account_summary_v4.rb → source_account_summary.rb} +24 -12
  509. data/lib/velopayments/models/source_account_summary_v3.rb +20 -8
  510. data/lib/velopayments/models/source_account_type.rb +37 -0
  511. data/lib/velopayments/models/{source_account.rb → source_account_v3.rb} +63 -11
  512. data/lib/velopayments/models/source_event.rb +255 -0
  513. data/lib/velopayments/models/supported_countries_response.rb +20 -8
  514. data/lib/velopayments/models/{supported_countries_response2.rb → supported_countries_response_v2.rb} +24 -12
  515. data/lib/velopayments/models/supported_country.rb +51 -37
  516. data/lib/velopayments/models/{supported_country2.rb → supported_country_v2.rb} +55 -41
  517. data/lib/velopayments/models/{supported_currency_response.rb → supported_currency_response_v2.rb} +24 -12
  518. data/lib/velopayments/models/supported_currency_v2.rb +264 -0
  519. data/lib/velopayments/models/transfer_request.rb +20 -8
  520. data/lib/velopayments/models/transfer_request2.rb +309 -0
  521. data/lib/velopayments/models/transmission_type.rb +38 -0
  522. data/lib/velopayments/models/{supported_currency.rb → transmission_types.rb} +63 -26
  523. data/lib/velopayments/models/{currency_type.rb → transmission_types2.rb} +60 -45
  524. data/lib/velopayments/models/unregister_mfa_request.rb +20 -8
  525. data/lib/velopayments/models/update_payee_details_request.rb +275 -0
  526. data/lib/velopayments/models/{paged_payee_response2_summary.rb → update_payee_details_request2.rb} +75 -42
  527. data/lib/velopayments/models/update_remote_id_request.rb +20 -8
  528. data/lib/velopayments/models/update_remote_id_request2.rb +265 -0
  529. data/lib/velopayments/models/update_webhook_request.rb +312 -0
  530. data/lib/velopayments/models/user_details_update_request.rb +29 -17
  531. data/lib/velopayments/models/user_info.rb +20 -8
  532. data/lib/velopayments/models/user_response.rb +45 -18
  533. data/lib/velopayments/models/user_status.rb +3 -2
  534. data/lib/velopayments/models/user_type.rb +3 -2
  535. data/lib/velopayments/models/user_type2.rb +3 -2
  536. data/lib/velopayments/models/validate_password_response.rb +20 -8
  537. data/lib/velopayments/models/watchlist_status.rb +3 -2
  538. data/lib/velopayments/models/{ofac_status2.rb → watchlist_status2.rb} +8 -5
  539. data/lib/velopayments/models/webhook_response.rb +265 -0
  540. data/lib/velopayments/models/webhooks_response.rb +241 -0
  541. data/lib/velopayments/models/withdraw_payment_request.rb +252 -0
  542. data/lib/velopayments/version.rb +3 -3
  543. data/oa3-config.json +1 -1
  544. data/spec/api/countries_api_spec.rb +12 -12
  545. data/spec/api/currencies_api_spec.rb +5 -5
  546. data/spec/api/funding_manager_api_spec.rb +94 -18
  547. data/spec/api/funding_manager_private_api_spec.rb +17 -5
  548. data/spec/api/login_api_spec.rb +3 -2
  549. data/spec/api/payee_invitation_api_spec.rb +23 -35
  550. data/spec/api/payees_api_spec.rb +63 -47
  551. data/spec/api/payment_audit_service_api_spec.rb +28 -112
  552. data/spec/api/{payout_history_api_spec.rb → payment_audit_service_deprecated_api_spec.rb} +115 -33
  553. data/spec/api/payors_api_spec.rb +9 -9
  554. data/spec/api/payors_private_api_spec.rb +2 -2
  555. data/spec/{models/payee2_spec.rb → api/payout_service_api_spec.rb} +66 -103
  556. data/spec/api/tokens_api_spec.rb +2 -2
  557. data/spec/api/users_api_spec.rb +17 -4
  558. data/spec/api/webhooks_api_spec.rb +86 -0
  559. data/spec/api_client_spec.rb +3 -3
  560. data/spec/configuration_spec.rb +2 -2
  561. data/spec/models/accepted_payment_v3_spec.rb +76 -0
  562. data/spec/models/access_token_response_spec.rb +5 -12
  563. data/spec/models/access_token_validation_request_spec.rb +5 -12
  564. data/spec/models/auth_response_spec.rb +5 -12
  565. data/spec/models/{inline_response401_errors_spec.rb → auto_top_up_config2_spec.rb} +12 -19
  566. data/spec/models/auto_top_up_config_spec.rb +5 -12
  567. data/spec/models/{language_spec.rb → category_spec.rb} +8 -15
  568. data/spec/models/{paged_response_spec.rb → challenge2_spec.rb} +10 -17
  569. data/spec/models/challenge_spec.rb +5 -12
  570. data/spec/models/company2_spec.rb +5 -12
  571. data/spec/models/company_spec.rb +5 -12
  572. data/spec/models/{payee_payment_channel_spec.rb → create_funding_account_request_v2_spec.rb} +19 -26
  573. data/spec/models/create_individual2_spec.rb +5 -12
  574. data/spec/models/{individual_v1_name_spec.rb → create_individual_name_spec.rb} +8 -15
  575. data/spec/models/create_individual_spec.rb +5 -12
  576. data/spec/models/create_payee2_spec.rb +5 -12
  577. data/spec/models/create_payee_address2_spec.rb +6 -13
  578. data/spec/models/create_payee_address_spec.rb +9 -12
  579. data/spec/models/create_payee_spec.rb +5 -12
  580. data/spec/models/create_payees_csv_response2_spec.rb +5 -12
  581. data/spec/models/create_payees_csv_response_rejected_csv_rows_spec.rb +5 -12
  582. data/spec/models/create_payees_csv_response_spec.rb +5 -12
  583. data/spec/models/create_payees_request2_spec.rb +5 -12
  584. data/spec/models/create_payees_request_spec.rb +5 -12
  585. data/spec/models/create_payment_channel2_spec.rb +7 -14
  586. data/spec/models/create_payment_channel_spec.rb +7 -14
  587. data/spec/models/create_payor_link_request_spec.rb +6 -13
  588. data/spec/models/{create_payout_request_spec.rb → create_payout_request_v3_spec.rb} +8 -21
  589. data/spec/models/create_webhook_request_spec.rb +58 -0
  590. data/spec/models/debit_event_all_of_spec.rb +34 -0
  591. data/spec/models/debit_event_spec.rb +52 -0
  592. data/spec/models/{currency_type_spec.rb → debit_status_changed_all_of_spec.rb} +9 -16
  593. data/spec/models/debit_status_changed_spec.rb +58 -0
  594. data/spec/models/{marketing_opt_in_spec.rb → error_data_spec.rb} +10 -17
  595. data/spec/models/error_response_spec.rb +11 -12
  596. data/spec/models/error_spec.rb +24 -13
  597. data/spec/models/failed_payee2_spec.rb +94 -0
  598. data/spec/models/failed_payee_spec.rb +94 -0
  599. data/spec/models/failed_submission2_spec.rb +5 -12
  600. data/spec/models/failed_submission_spec.rb +5 -12
  601. data/spec/models/funding_account_response2_spec.rb +88 -0
  602. data/spec/models/funding_account_response_spec.rb +29 -12
  603. data/spec/models/{language2_spec.rb → funding_account_type_spec.rb} +8 -15
  604. data/spec/models/funding_audit_spec.rb +14 -21
  605. data/spec/models/funding_event_spec.rb +5 -12
  606. data/spec/models/funding_event_type_spec.rb +5 -12
  607. data/spec/models/funding_payor_status_audit_response_spec.rb +5 -12
  608. data/spec/models/funding_request_v1_spec.rb +5 -12
  609. data/spec/models/funding_request_v2_spec.rb +5 -12
  610. data/spec/models/funding_request_v3_spec.rb +40 -0
  611. data/spec/models/{fx_summary_v4_spec.rb → fx_summary_spec.rb} +10 -17
  612. data/spec/models/fx_summary_v3_spec.rb +7 -14
  613. data/spec/models/get_fundings_response_links_spec.rb +40 -0
  614. data/spec/models/get_fundings_response_spec.rb +5 -12
  615. data/spec/models/{payee_response2_spec.rb → get_payee_list_response2_spec.rb} +21 -46
  616. data/spec/models/get_payee_list_response_company2_spec.rb +40 -0
  617. data/spec/models/{company_response_spec.rb → get_payee_list_response_company_spec.rb} +8 -15
  618. data/spec/models/get_payee_list_response_individual2_spec.rb +34 -0
  619. data/spec/models/{user_response2_roles_spec.rb → get_payee_list_response_individual_spec.rb} +8 -15
  620. data/spec/models/{payee_spec.rb → get_payee_list_response_spec.rb} +21 -46
  621. data/spec/models/get_payments_for_payout_response_v3_page_spec.rb +5 -12
  622. data/spec/models/get_payments_for_payout_response_v3_spec.rb +5 -12
  623. data/spec/models/get_payments_for_payout_response_v3_summary_spec.rb +6 -13
  624. data/spec/models/get_payments_for_payout_response_v4_spec.rb +5 -12
  625. data/spec/models/get_payments_for_payout_response_v4_summary_spec.rb +11 -16
  626. data/spec/models/get_payout_statistics_spec.rb +5 -12
  627. data/spec/models/{company_v1_spec.rb → get_payouts_response_spec.rb} +11 -18
  628. data/spec/models/get_payouts_response_v3_links_spec.rb +5 -12
  629. data/spec/models/get_payouts_response_v3_page_spec.rb +5 -12
  630. data/spec/models/get_payouts_response_v3_spec.rb +5 -12
  631. data/spec/models/individual2_spec.rb +5 -12
  632. data/spec/models/{create_individual2_name_spec.rb → individual_name_spec.rb} +8 -15
  633. data/spec/models/individual_spec.rb +5 -12
  634. data/spec/models/inline_response400_spec.rb +11 -12
  635. data/spec/models/inline_response401_spec.rb +11 -12
  636. data/spec/models/inline_response403_spec.rb +11 -12
  637. data/spec/models/{individual_v1_spec.rb → inline_response404_spec.rb} +11 -18
  638. data/spec/models/inline_response409_spec.rb +46 -0
  639. data/spec/models/inline_response412_spec.rb +46 -0
  640. data/spec/models/{ofac_status2_spec.rb → invitation_status2_spec.rb} +8 -15
  641. data/spec/models/invitation_status_spec.rb +5 -12
  642. data/spec/models/invite_payee_request2_spec.rb +5 -12
  643. data/spec/models/invite_payee_request_spec.rb +5 -12
  644. data/spec/models/invite_user_request_spec.rb +6 -13
  645. data/spec/models/kyc_state_spec.rb +5 -12
  646. data/spec/models/link_for_response_spec.rb +5 -12
  647. data/spec/models/{list_payments_response_spec.rb → list_funding_accounts_response2_spec.rb} +8 -15
  648. data/spec/models/list_funding_accounts_response_spec.rb +5 -12
  649. data/spec/models/{paged_response_page_spec.rb → list_payments_response_v3_page_spec.rb} +8 -15
  650. data/spec/models/list_payments_response_v3_spec.rb +46 -0
  651. data/spec/models/list_payments_response_v4_spec.rb +5 -12
  652. data/spec/models/list_source_account_response_links_spec.rb +5 -12
  653. data/spec/models/list_source_account_response_page_spec.rb +5 -12
  654. data/spec/models/list_source_account_response_spec.rb +5 -12
  655. data/spec/models/list_source_account_response_v2_links_spec.rb +40 -0
  656. data/spec/models/list_source_account_response_v2_spec.rb +5 -12
  657. data/spec/models/list_source_account_response_v3_links_spec.rb +40 -0
  658. data/spec/models/list_source_account_response_v3_spec.rb +46 -0
  659. data/spec/models/localisation_details_spec.rb +40 -0
  660. data/spec/models/mfa_details_spec.rb +5 -12
  661. data/spec/models/mfa_type_spec.rb +5 -12
  662. data/spec/models/name2_spec.rb +52 -0
  663. data/spec/models/name_spec.rb +52 -0
  664. data/spec/models/notification_spec.rb +58 -0
  665. data/spec/models/notifications2_spec.rb +34 -0
  666. data/spec/models/notifications_spec.rb +5 -12
  667. data/spec/models/ofac_status_spec.rb +5 -12
  668. data/spec/models/onboarded_status2_spec.rb +5 -12
  669. data/spec/models/onboarded_status_spec.rb +5 -12
  670. data/spec/models/{list_payments_response_page_spec.rb → onboarding_status_changed_spec.rb} +13 -20
  671. data/spec/models/page_for_response_spec.rb +5 -12
  672. data/spec/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response_spec.rb +5 -12
  673. data/spec/models/paged_payee_invitation_status_response2_spec.rb +5 -12
  674. data/spec/models/paged_payee_invitation_status_response_page_spec.rb +5 -12
  675. data/spec/models/paged_payee_invitation_status_response_spec.rb +5 -12
  676. data/spec/models/paged_payee_response2_spec.rb +5 -12
  677. data/spec/models/paged_payee_response_links_spec.rb +5 -12
  678. data/spec/models/paged_payee_response_page_spec.rb +5 -12
  679. data/spec/models/paged_payee_response_spec.rb +5 -12
  680. data/spec/models/paged_payee_response_summary_spec.rb +6 -13
  681. data/spec/models/{get_payouts_response_v4_spec.rb → paged_payments_response_v3_spec.rb} +8 -15
  682. data/spec/models/paged_user_response_links_spec.rb +5 -12
  683. data/spec/models/paged_user_response_page_spec.rb +5 -12
  684. data/spec/models/paged_user_response_spec.rb +5 -12
  685. data/spec/models/password_request_spec.rb +5 -12
  686. data/spec/models/payable_issue2_spec.rb +40 -0
  687. data/spec/models/payable_issue_spec.rb +40 -0
  688. data/spec/models/payable_status_changed_spec.rb +58 -0
  689. data/spec/models/payee_address2_spec.rb +5 -12
  690. data/spec/models/payee_address_spec.rb +5 -12
  691. data/spec/models/payee_delta2_spec.rb +5 -12
  692. data/spec/models/payee_delta_response2_links_spec.rb +5 -12
  693. data/spec/models/payee_delta_response2_spec.rb +5 -12
  694. data/spec/models/payee_delta_response_links_spec.rb +5 -12
  695. data/spec/models/payee_delta_response_page_spec.rb +5 -12
  696. data/spec/models/payee_delta_response_spec.rb +5 -12
  697. data/spec/models/payee_delta_spec.rb +5 -12
  698. data/spec/models/{payee_response_v2_spec.rb → payee_detail_response2_spec.rb} +28 -35
  699. data/spec/models/{payee_response_v3_spec.rb → payee_detail_response_spec.rb} +14 -15
  700. data/spec/models/payee_details_changed_spec.rb +58 -0
  701. data/spec/models/payee_event_all_of_reasons_spec.rb +40 -0
  702. data/spec/models/payee_event_all_of_spec.rb +40 -0
  703. data/spec/models/{inline_response400_errors_spec.rb → payee_event_spec.rb} +17 -18
  704. data/spec/models/payee_invitation_status_response2_spec.rb +6 -13
  705. data/spec/models/payee_invitation_status_response_spec.rb +6 -13
  706. data/spec/models/payee_payor_ref_spec.rb +29 -12
  707. data/spec/models/payee_payor_ref_v3_spec.rb +17 -16
  708. data/spec/models/payee_type_spec.rb +5 -12
  709. data/spec/models/{payment_instruction_spec.rb → payee_user_self_update_request_spec.rb} +14 -21
  710. data/spec/models/{location_type_spec.rb → payment_audit_currency_spec.rb} +8 -15
  711. data/spec/models/payment_audit_currency_v3_spec.rb +5 -12
  712. data/spec/models/payment_channel_country_spec.rb +5 -12
  713. data/spec/models/payment_channel_rule_spec.rb +5 -12
  714. data/spec/models/payment_channel_rules_response_spec.rb +5 -12
  715. data/spec/models/payment_delta_response_spec.rb +5 -12
  716. data/spec/models/payment_delta_response_v1_spec.rb +46 -0
  717. data/spec/models/payment_delta_spec.rb +5 -12
  718. data/spec/models/payment_delta_v1_spec.rb +76 -0
  719. data/spec/models/payment_event_all_of_spec.rb +46 -0
  720. data/spec/models/{payment_event_response_v4_spec.rb → payment_event_response_spec.rb} +10 -17
  721. data/spec/models/payment_event_response_v3_spec.rb +6 -13
  722. data/spec/models/{accepted_payment_spec.rb → payment_event_spec.rb} +14 -21
  723. data/spec/models/{rejected_payment_spec.rb → payment_instruction_v3_spec.rb} +15 -22
  724. data/spec/models/payment_rails_spec.rb +5 -12
  725. data/spec/models/payment_rejected_or_returned_all_of_spec.rb +40 -0
  726. data/spec/models/payment_rejected_or_returned_spec.rb +82 -0
  727. data/spec/models/payment_response_v3_spec.rb +7 -14
  728. data/spec/models/payment_response_v4_payout_spec.rb +5 -12
  729. data/spec/models/payment_response_v4_spec.rb +55 -14
  730. data/spec/models/{payor_logo_request_spec.rb → payment_status_changed_all_of_spec.rb} +9 -16
  731. data/spec/models/payment_status_changed_spec.rb +70 -0
  732. data/spec/models/payment_v3_spec.rb +110 -0
  733. data/spec/models/payor_address_spec.rb +5 -12
  734. data/spec/models/payor_address_v2_spec.rb +5 -12
  735. data/spec/models/{payor_aml_transaction_v4_spec.rb → payor_aml_transaction_spec.rb} +8 -21
  736. data/spec/models/payor_aml_transaction_v3_spec.rb +5 -30
  737. data/spec/models/payor_branding_response_spec.rb +5 -12
  738. data/spec/models/payor_create_api_key_request_spec.rb +6 -13
  739. data/spec/models/payor_create_api_key_response_spec.rb +5 -12
  740. data/spec/models/payor_create_application_request_spec.rb +5 -12
  741. data/spec/models/payor_email_opt_out_request_spec.rb +5 -12
  742. data/spec/models/payor_links_response_links_spec.rb +6 -13
  743. data/spec/models/payor_links_response_payors_spec.rb +6 -13
  744. data/spec/models/payor_links_response_spec.rb +5 -12
  745. data/spec/models/payor_v1_spec.rb +12 -13
  746. data/spec/models/payor_v2_spec.rb +24 -13
  747. data/spec/models/payout_company_v3_spec.rb +34 -0
  748. data/spec/models/{individual_response_spec.rb → payout_individual_v3_spec.rb} +8 -15
  749. data/spec/models/payout_name_v3_spec.rb +40 -0
  750. data/spec/models/payout_payee_v3_spec.rb +46 -0
  751. data/spec/models/payout_payor_ids_spec.rb +46 -0
  752. data/spec/models/{payout_payor_v4_spec.rb → payout_payor_spec.rb} +8 -15
  753. data/spec/models/{payout_principal_v4_spec.rb → payout_principal_spec.rb} +8 -15
  754. data/spec/models/payout_status_spec.rb +28 -0
  755. data/spec/models/payout_status_v3_spec.rb +5 -12
  756. data/spec/models/{payout_summary_audit_v4_spec.rb → payout_summary_audit_spec.rb} +14 -15
  757. data/spec/models/payout_summary_audit_v3_spec.rb +5 -12
  758. data/spec/models/{payout_summary_response_spec.rb → payout_summary_response_v3_spec.rb} +14 -15
  759. data/spec/models/payout_type_spec.rb +28 -0
  760. data/spec/models/ping_spec.rb +46 -0
  761. data/spec/models/query_batch_response2_spec.rb +6 -13
  762. data/spec/models/query_batch_response_spec.rb +6 -13
  763. data/spec/models/{quote_fx_summary_spec.rb → quote_fx_summary_v3_spec.rb} +10 -17
  764. data/spec/models/{quote_response_spec.rb → quote_response_v3_spec.rb} +8 -15
  765. data/spec/models/{region_spec.rb → region_v2_spec.rb} +8 -15
  766. data/spec/models/register_sms_request_spec.rb +5 -12
  767. data/spec/models/rejected_payment_v3_spec.rb +94 -0
  768. data/spec/models/resend_token_request_spec.rb +6 -13
  769. data/spec/models/reset_password_request_spec.rb +5 -12
  770. data/spec/models/role_spec.rb +5 -12
  771. data/spec/models/role_update_request_spec.rb +5 -12
  772. data/spec/models/self_mfa_type_unregister_request_spec.rb +6 -13
  773. data/spec/models/self_update_password_request_spec.rb +5 -12
  774. data/spec/models/set_notifications_request_spec.rb +5 -12
  775. data/spec/models/source_account_response_spec.rb +12 -13
  776. data/spec/models/source_account_response_v2_spec.rb +12 -13
  777. data/spec/models/{payee_response_spec.rb → source_account_response_v3_spec.rb} +30 -45
  778. data/spec/models/{source_account_summary_v4_spec.rb → source_account_summary_spec.rb} +8 -15
  779. data/spec/models/source_account_summary_v3_spec.rb +5 -12
  780. data/spec/models/source_account_type_spec.rb +28 -0
  781. data/spec/models/{source_account_spec.rb → source_account_v3_spec.rb} +8 -15
  782. data/spec/models/source_event_spec.rb +46 -0
  783. data/spec/models/supported_countries_response_spec.rb +5 -12
  784. data/spec/models/supported_countries_response_v2_spec.rb +34 -0
  785. data/spec/models/supported_country_spec.rb +5 -20
  786. data/spec/models/supported_country_v2_spec.rb +46 -0
  787. data/spec/models/{supported_currency_response_spec.rb → supported_currency_response_v2_spec.rb} +8 -15
  788. data/spec/models/{supported_currency_spec.rb → supported_currency_v2_spec.rb} +8 -15
  789. data/spec/models/transfer_request2_spec.rb +46 -0
  790. data/spec/models/transfer_request_spec.rb +5 -12
  791. data/spec/models/transmission_type_spec.rb +28 -0
  792. data/spec/models/transmission_types2_spec.rb +46 -0
  793. data/spec/models/transmission_types_spec.rb +46 -0
  794. data/spec/models/unregister_mfa_request_spec.rb +6 -13
  795. data/spec/models/update_payee_details_request2_spec.rb +70 -0
  796. data/spec/models/{payee_payment_channel2_spec.rb → update_payee_details_request_spec.rb} +15 -26
  797. data/spec/models/update_remote_id_request2_spec.rb +40 -0
  798. data/spec/models/update_remote_id_request_spec.rb +5 -12
  799. data/spec/models/update_webhook_request_spec.rb +52 -0
  800. data/spec/models/user_details_update_request_spec.rb +5 -12
  801. data/spec/models/user_info_spec.rb +5 -12
  802. data/spec/models/user_response_spec.rb +8 -15
  803. data/spec/models/user_status_spec.rb +5 -12
  804. data/spec/models/user_type2_spec.rb +5 -12
  805. data/spec/models/user_type_spec.rb +5 -12
  806. data/spec/models/validate_password_response_spec.rb +5 -12
  807. data/spec/models/watchlist_status2_spec.rb +28 -0
  808. data/spec/models/watchlist_status_spec.rb +5 -12
  809. data/spec/models/webhook_response_spec.rb +64 -0
  810. data/spec/models/webhooks_response_spec.rb +46 -0
  811. data/spec/models/withdraw_payment_request_spec.rb +34 -0
  812. data/spec/spec_helper.rb +2 -2
  813. data/specs/api/countries_api_spec.rb +103 -0
  814. data/{spec/api/quote_payout_api_spec.rb → specs/api/currencies_api_spec.rb} +16 -15
  815. data/specs/api/funding_manager_api_spec.rb +372 -0
  816. data/{spec/api/get_payout_api_spec.rb → specs/api/funding_manager_private_api_spec.rb} +15 -15
  817. data/specs/api/login_api_spec.rb +82 -0
  818. data/specs/api/payee_invitation_api_spec.rb +161 -0
  819. data/specs/api/payees_api_spec.rb +186 -0
  820. data/specs/api/payment_audit_service_api_spec.rb +318 -0
  821. data/specs/api/payors_api_spec.rb +171 -0
  822. data/{spec/api/instruct_payout_api_spec.rb → specs/api/payors_private_api_spec.rb} +14 -14
  823. data/specs/api/payout_service_api_spec.rb +127 -0
  824. data/{spec/api/withdraw_payout_api_spec.rb → specs/api/tokens_api_spec.rb} +15 -14
  825. data/specs/api/users_api_spec.rb +284 -0
  826. data/velopayments.gemspec +3 -4
  827. metadata +449 -295
  828. data/docs/AcceptedPayment.md +0 -27
  829. data/docs/CompanyResponse.md +0 -19
  830. data/docs/CompanyV1.md +0 -21
  831. data/docs/CreateFundingAccountRequest.md +0 -23
  832. data/docs/CreateIndividual2Name.md +0 -23
  833. data/docs/CreatePayeesCSVRequest.md +0 -73
  834. data/docs/CreatePayeesCSVRequest2.md +0 -73
  835. data/docs/CreatePayoutRequest.md +0 -25
  836. data/docs/CurrencyType.md +0 -17
  837. data/docs/FxSummaryV4.md +0 -35
  838. data/docs/GetFundingsResponseAllOf.md +0 -17
  839. data/docs/GetPayoutApi.md +0 -61
  840. data/docs/GetPayoutsResponseV4.md +0 -21
  841. data/docs/IndividualResponse.md +0 -17
  842. data/docs/IndividualV1.md +0 -21
  843. data/docs/IndividualV1Name.md +0 -23
  844. data/docs/InlineResponse400Errors.md +0 -23
  845. data/docs/InlineResponse401Errors.md +0 -23
  846. data/docs/InlineResponse403Errors.md +0 -23
  847. data/docs/InstructPayoutApi.md +0 -60
  848. data/docs/InvitationStatusResponse.md +0 -17
  849. data/docs/Language.md +0 -16
  850. data/docs/Language2.md +0 -16
  851. data/docs/ListPaymentsResponse.md +0 -21
  852. data/docs/ListPaymentsResponsePage.md +0 -25
  853. data/docs/LocationType.md +0 -16
  854. data/docs/MarketingOptIn.md +0 -19
  855. data/docs/OfacStatus2.md +0 -16
  856. data/docs/PagedPayeeResponse2Summary.md +0 -25
  857. data/docs/PagedResponse.md +0 -19
  858. data/docs/PagedResponsePage.md +0 -25
  859. data/docs/Payee.md +0 -55
  860. data/docs/Payee2.md +0 -57
  861. data/docs/PayeeInvitationStatus.md +0 -21
  862. data/docs/PayeePaymentChannel.md +0 -29
  863. data/docs/PayeePaymentChannel2.md +0 -29
  864. data/docs/PayeePayorRefV2.md +0 -25
  865. data/docs/PayeeResponse.md +0 -55
  866. data/docs/PayeeResponse2.md +0 -55
  867. data/docs/PayeeResponseV2.md +0 -73
  868. data/docs/PayeeResponseV3.md +0 -71
  869. data/docs/PaymentAuditCurrencyV4.md +0 -16
  870. data/docs/PaymentEventResponseV4.md +0 -39
  871. data/docs/PaymentInstruction.md +0 -27
  872. data/docs/PayorAmlTransactionV4.md +0 -71
  873. data/docs/PayorLogoRequest.md +0 -17
  874. data/docs/PayoutHistoryApi.md +0 -221
  875. data/docs/PayoutPayorV4.md +0 -25
  876. data/docs/PayoutPrincipalV4.md +0 -19
  877. data/docs/PayoutStatusV4.md +0 -16
  878. data/docs/PayoutSummaryAuditV4.md +0 -45
  879. data/docs/PayoutSummaryResponse.md +0 -33
  880. data/docs/PayoutTypeV4.md +0 -16
  881. data/docs/QuoteFxSummary.md +0 -37
  882. data/docs/QuotePayoutApi.md +0 -61
  883. data/docs/QuoteResponse.md +0 -17
  884. data/docs/Region.md +0 -19
  885. data/docs/RejectedPayment.md +0 -33
  886. data/docs/SourceAccount.md +0 -23
  887. data/docs/SourceAccountSummaryV4.md +0 -21
  888. data/docs/SubmitPayoutApi.md +0 -60
  889. data/docs/SupportedCountriesResponse2.md +0 -17
  890. data/docs/SupportedCountry2.md +0 -21
  891. data/docs/SupportedCurrency.md +0 -19
  892. data/docs/SupportedCurrencyResponse.md +0 -17
  893. data/docs/UserResponse2.md +0 -45
  894. data/docs/UserResponse2Roles.md +0 -17
  895. data/docs/WithdrawPayoutApi.md +0 -60
  896. data/lib/velopayments/api/get_payout_api.rb +0 -84
  897. data/lib/velopayments/api/instruct_payout_api.rb +0 -84
  898. data/lib/velopayments/api/payout_history_api.rb +0 -285
  899. data/lib/velopayments/api/quote_payout_api.rb +0 -84
  900. data/lib/velopayments/api/submit_payout_api.rb +0 -86
  901. data/lib/velopayments/api/withdraw_payout_api.rb +0 -84
  902. data/lib/velopayments/models/create_payees_csv_request.rb +0 -1148
  903. data/lib/velopayments/models/create_payees_csv_request2.rb +0 -1148
  904. data/lib/velopayments/models/inline_response401_errors.rb +0 -236
  905. data/lib/velopayments/models/language2.rb +0 -45
  906. data/lib/velopayments/models/payee2.rb +0 -456
  907. data/lib/velopayments/models/payee_response.rb +0 -388
  908. data/spec/api/submit_payout_api_spec.rb +0 -47
  909. data/spec/models/create_funding_account_request_spec.rb +0 -59
  910. data/spec/models/create_payees_csv_request2_spec.rb +0 -225
  911. data/spec/models/create_payees_csv_request_spec.rb +0 -221
  912. data/spec/models/get_fundings_response_all_of_spec.rb +0 -41
  913. data/spec/models/inline_response403_errors_spec.rb +0 -59
  914. data/spec/models/invitation_status_response_spec.rb +0 -41
  915. data/spec/models/paged_payee_response2_summary_spec.rb +0 -65
  916. data/spec/models/payee_invitation_status_spec.rb +0 -57
  917. data/spec/models/payee_payor_ref_v2_spec.rb +0 -69
  918. data/spec/models/payment_audit_currency_v4_spec.rb +0 -35
  919. data/spec/models/payout_status_v4_spec.rb +0 -35
  920. data/spec/models/payout_type_v4_spec.rb +0 -35
  921. data/spec/models/supported_countries_response2_spec.rb +0 -41
  922. data/spec/models/supported_country2_spec.rb +0 -61
  923. data/spec/models/user_response2_spec.rb +0 -137
@@ -2,20 +2,21 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **page** | [**PayeeDeltaResponsePage**](PayeeDeltaResponsePage.md) | | [optional]
8
- **links** | [**Array<PayeeDeltaResponse2Links>**](PayeeDeltaResponse2Links.md) | | [optional]
9
- **content** | [**Array<PayeeDelta2>**](PayeeDelta2.md) | | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **page** | [**PayeeDeltaResponsePage**](PayeeDeltaResponsePage.md) | | [optional] |
8
+ | **links** | [**Array<PayeeDeltaResponse2Links>**](PayeeDeltaResponse2Links.md) | | [optional] |
9
+ | **content** | [**Array<PayeeDelta2>**](PayeeDelta2.md) | | [optional] |
10
10
 
11
- ## Code Sample
11
+ ## Example
12
12
 
13
13
  ```ruby
14
- require 'VeloPayments'
14
+ require 'velopayments'
15
15
 
16
- instance = VeloPayments::PayeeDeltaResponse2.new(page: null,
17
- links: null,
18
- content: null)
16
+ instance = VeloPayments::PayeeDeltaResponse2.new(
17
+ page: null,
18
+ links: null,
19
+ content: null
20
+ )
19
21
  ```
20
22
 
21
-
@@ -2,18 +2,19 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **rel** | **String** | | [optional]
8
- **href** | **String** | | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **rel** | **String** | | [optional] |
8
+ | **href** | **String** | | [optional] |
9
9
 
10
- ## Code Sample
10
+ ## Example
11
11
 
12
12
  ```ruby
13
- require 'VeloPayments'
13
+ require 'velopayments'
14
14
 
15
- instance = VeloPayments::PayeeDeltaResponse2Links.new(rel: first,
16
- href: http://api.sandbox.velopayments.com/v3/payees/deltas?payorId=0a818933-087d-47f2-ad83-2f986ed087eb&updatedSince=2019-01-20T09:00:00+00:00&page=1&pageSize=1000)
15
+ instance = VeloPayments::PayeeDeltaResponse2Links.new(
16
+ rel: first,
17
+ href: http://api.sandbox.velopayments.com/v4/payees/deltas?payorId=0a818933-087d-47f2-ad83-2f986ed087eb&updatedSince=2019-01-20T09:00:00+00:00&page=1&pageSize=1000
18
+ )
17
19
  ```
18
20
 
19
-
@@ -2,18 +2,19 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **rel** | **String** | | [optional]
8
- **href** | **String** | | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **rel** | **String** | | [optional] |
8
+ | **href** | **String** | | [optional] |
9
9
 
10
- ## Code Sample
10
+ ## Example
11
11
 
12
12
  ```ruby
13
- require 'VeloPayments'
13
+ require 'velopayments'
14
14
 
15
- instance = VeloPayments::PayeeDeltaResponseLinks.new(rel: first,
16
- href: http://api.sandbox.velopayments.com/v1/deltas/payees?payorId=0a818933-087d-47f2-ad83-2f986ed087eb&updatedSince=2019-01-20T09:00:00+00:00&page=1&pageSize=1000)
15
+ instance = VeloPayments::PayeeDeltaResponseLinks.new(
16
+ rel: first,
17
+ href: http://api.sandbox.velopayments.com/v3/payees/deltas?payorId=0a818933-087d-47f2-ad83-2f986ed087eb&updatedSince=2019-01-20T09:00:00+00:00&page=1&pageSize=1000
18
+ )
17
19
  ```
18
20
 
19
-
@@ -2,24 +2,25 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **number_of_elements** | **Integer** | | [optional]
8
- **total_elements** | **Integer** | | [optional]
9
- **total_pages** | **Integer** | | [optional]
10
- **page** | **Integer** | | [optional]
11
- **page_size** | **Integer** | | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **number_of_elements** | **Integer** | | [optional] |
8
+ | **total_elements** | **Integer** | | [optional] |
9
+ | **total_pages** | **Integer** | | [optional] |
10
+ | **page** | **Integer** | | [optional] |
11
+ | **page_size** | **Integer** | | [optional] |
12
12
 
13
- ## Code Sample
13
+ ## Example
14
14
 
15
15
  ```ruby
16
- require 'VeloPayments'
16
+ require 'velopayments'
17
17
 
18
- instance = VeloPayments::PayeeDeltaResponsePage.new(number_of_elements: 2,
19
- total_elements: 2,
20
- total_pages: 1,
21
- page: 1,
22
- page_size: 25)
18
+ instance = VeloPayments::PayeeDeltaResponsePage.new(
19
+ number_of_elements: 2,
20
+ total_elements: 2,
21
+ total_pages: 1,
22
+ page: 1,
23
+ page_size: 25
24
+ )
23
25
  ```
24
26
 
25
-
@@ -0,0 +1,74 @@
1
+ # VeloPayments::PayeeDetailResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **payee_id** | **String** | | [optional][readonly] |
8
+ | **payor_refs** | [**Array<PayeePayorRefV3>**](PayeePayorRefV3.md) | | [optional][readonly] |
9
+ | **email** | **String** | | [optional] |
10
+ | **onboarded_status** | [**OnboardedStatus2**](OnboardedStatus2.md) | | [optional] |
11
+ | **watchlist_status** | [**WatchlistStatus**](WatchlistStatus.md) | | [optional] |
12
+ | **watchlist_override_expires_at_timestamp** | **Time** | | [optional] |
13
+ | **watchlist_override_comment** | **String** | | [optional] |
14
+ | **language** | **String** | An IETF BCP 47 language code which has been configured for use within this Velo environment.<BR> See the /v1/supportedLanguages endpoint to list the available codes for an environment. | [optional] |
15
+ | **created** | **Time** | | [optional] |
16
+ | **country** | **String** | | [optional] |
17
+ | **display_name** | **String** | | [optional] |
18
+ | **payee_type** | [**PayeeType**](PayeeType.md) | | [optional] |
19
+ | **disabled** | **Boolean** | | [optional] |
20
+ | **disabled_comment** | **String** | | [optional] |
21
+ | **disabled_updated_timestamp** | **Time** | | [optional] |
22
+ | **address** | [**PayeeAddress**](PayeeAddress.md) | | [optional] |
23
+ | **individual** | [**Individual**](Individual.md) | | [optional] |
24
+ | **company** | [**Company**](Company.md) | | [optional] |
25
+ | **cellphone_number** | **String** | | [optional] |
26
+ | **watchlist_status_updated_timestamp** | **String** | | [optional][readonly] |
27
+ | **grace_period_end_date** | **Date** | | [optional][readonly] |
28
+ | **enhanced_kyc_completed** | **Boolean** | | [optional] |
29
+ | **kyc_completed_timestamp** | **String** | | [optional] |
30
+ | **pause_payment** | **Boolean** | | [optional] |
31
+ | **pause_payment_timestamp** | **String** | | [optional] |
32
+ | **marketing_opt_in_decision** | **Boolean** | | [optional] |
33
+ | **marketing_opt_in_timestamp** | **String** | | [optional] |
34
+ | **accept_terms_and_conditions_timestamp** | **Time** | The timestamp when the payee last accepted T&Cs | [optional][readonly] |
35
+ | **challenge** | [**Challenge**](Challenge.md) | | [optional] |
36
+
37
+ ## Example
38
+
39
+ ```ruby
40
+ require 'velopayments'
41
+
42
+ instance = VeloPayments::PayeeDetailResponse.new(
43
+ payee_id: 2aa5d7e0-2ecb-403f-8494-1865ed0454e9,
44
+ payor_refs: null,
45
+ email: bob@example.com,
46
+ onboarded_status: null,
47
+ watchlist_status: null,
48
+ watchlist_override_expires_at_timestamp: 2019-01-20T09:00Z,
49
+ watchlist_override_comment: watchlist override comment,
50
+ language: en-US,
51
+ created: 2019-01-20T09:00Z,
52
+ country: US,
53
+ display_name: Bob,
54
+ payee_type: null,
55
+ disabled: null,
56
+ disabled_comment: reason for disabled,
57
+ disabled_updated_timestamp: 2019-01-20T09:00Z,
58
+ address: null,
59
+ individual: null,
60
+ company: null,
61
+ cellphone_number: 1234567890,
62
+ watchlist_status_updated_timestamp: 2019-01-20T09:00:00+00:00,
63
+ grace_period_end_date: Sun Jan 20 00:00:00 UTC 2019,
64
+ enhanced_kyc_completed: null,
65
+ kyc_completed_timestamp: 2019-01-20T09:00:00+00:00,
66
+ pause_payment: null,
67
+ pause_payment_timestamp: 2019-01-20T09:00:00+00:00,
68
+ marketing_opt_in_decision: null,
69
+ marketing_opt_in_timestamp: 2019-01-20T09:00:00+00:00,
70
+ accept_terms_and_conditions_timestamp: 2019-01-20T09:00Z,
71
+ challenge: null
72
+ )
73
+ ```
74
+
@@ -0,0 +1,74 @@
1
+ # VeloPayments::PayeeDetailResponse2
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **payee_id** | **String** | | [optional][readonly] |
8
+ | **payor_refs** | [**Array<PayeePayorRef>**](PayeePayorRef.md) | | [optional][readonly] |
9
+ | **email** | **String** | | [optional] |
10
+ | **onboarded_status** | [**OnboardedStatus**](OnboardedStatus.md) | | [optional] |
11
+ | **watchlist_status** | [**WatchlistStatus2**](WatchlistStatus2.md) | | [optional] |
12
+ | **watchlist_override_expires_at_timestamp** | **Time** | | [optional] |
13
+ | **watchlist_override_comment** | **String** | | [optional] |
14
+ | **language** | **String** | An IETF BCP 47 language code which has been configured for use within this Velo environment.<BR> See the /v1/supportedLanguages endpoint to list the available codes for an environment. | [optional] |
15
+ | **created** | **Time** | | [optional] |
16
+ | **country** | **String** | | [optional] |
17
+ | **display_name** | **String** | | [optional] |
18
+ | **payee_type** | [**PayeeType**](PayeeType.md) | | [optional] |
19
+ | **disabled** | **Boolean** | | [optional] |
20
+ | **disabled_comment** | **String** | | [optional] |
21
+ | **disabled_updated_timestamp** | **Time** | | [optional] |
22
+ | **address** | [**PayeeAddress2**](PayeeAddress2.md) | | [optional] |
23
+ | **individual** | [**Individual2**](Individual2.md) | | [optional] |
24
+ | **company** | [**Company2**](Company2.md) | | [optional] |
25
+ | **cellphone_number** | **String** | | [optional] |
26
+ | **watchlist_status_updated_timestamp** | **String** | | [optional][readonly] |
27
+ | **grace_period_end_date** | **Date** | | [optional][readonly] |
28
+ | **enhanced_kyc_completed** | **Boolean** | | [optional] |
29
+ | **kyc_completed_timestamp** | **String** | | [optional] |
30
+ | **pause_payment** | **Boolean** | | [optional] |
31
+ | **pause_payment_timestamp** | **String** | | [optional] |
32
+ | **marketing_opt_in_decision** | **Boolean** | | [optional] |
33
+ | **marketing_opt_in_timestamp** | **String** | | [optional] |
34
+ | **accept_terms_and_conditions_timestamp** | **Time** | The timestamp when the payee last accepted T&Cs | [optional][readonly] |
35
+ | **challenge** | [**Challenge2**](Challenge2.md) | | [optional] |
36
+
37
+ ## Example
38
+
39
+ ```ruby
40
+ require 'velopayments'
41
+
42
+ instance = VeloPayments::PayeeDetailResponse2.new(
43
+ payee_id: 2aa5d7e0-2ecb-403f-8494-1865ed0454e9,
44
+ payor_refs: null,
45
+ email: bob@example.com,
46
+ onboarded_status: null,
47
+ watchlist_status: null,
48
+ watchlist_override_expires_at_timestamp: 2019-01-20T09:00Z,
49
+ watchlist_override_comment: watchlist override comment,
50
+ language: en-US,
51
+ created: 2019-01-20T09:00Z,
52
+ country: US,
53
+ display_name: Bob,
54
+ payee_type: null,
55
+ disabled: null,
56
+ disabled_comment: reason for disabled,
57
+ disabled_updated_timestamp: 2019-01-20T09:00Z,
58
+ address: null,
59
+ individual: null,
60
+ company: null,
61
+ cellphone_number: 1234567890,
62
+ watchlist_status_updated_timestamp: 2019-01-20T09:00:00+00:00,
63
+ grace_period_end_date: Sun Jan 20 00:00:00 UTC 2019,
64
+ enhanced_kyc_completed: null,
65
+ kyc_completed_timestamp: 2019-01-20T09:00:00+00:00,
66
+ pause_payment: null,
67
+ pause_payment_timestamp: 2019-01-20T09:00:00+00:00,
68
+ marketing_opt_in_decision: null,
69
+ marketing_opt_in_timestamp: 2019-01-20T09:00:00+00:00,
70
+ accept_terms_and_conditions_timestamp: 2019-01-20T09:00Z,
71
+ challenge: null
72
+ )
73
+ ```
74
+
@@ -0,0 +1,26 @@
1
+ # VeloPayments::PayeeDetailsChanged
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **source_type** | **String** | OA3 Schema type name for the source info which is used as the discriminator value to ensure that data binding works correctly | |
8
+ | **event_id** | **String** | UUID id of the source event in the Velo platform | |
9
+ | **created_at** | **Time** | ISO8601 timestamp indicating when the source event was created | |
10
+ | **payee_id** | **String** | ID of this payee within the Velo platform | |
11
+ | **reasons** | [**Array<PayeeEventAllOfReasons>**](PayeeEventAllOfReasons.md) | The reasons for the event notification. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'velopayments'
17
+
18
+ instance = VeloPayments::PayeeDetailsChanged.new(
19
+ source_type: payment_status_changed,
20
+ event_id: 270ab907-27ec-4b83-8028-0ff432bbdec4,
21
+ created_at: 2020-06-18T15:09:42Z,
22
+ payee_id: cbd9280f-8fde-4190-b014-979d88f3ec54,
23
+ reasons: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,26 @@
1
+ # VeloPayments::PayeeEvent
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **source_type** | **String** | OA3 Schema type name for the source info which is used as the discriminator value to ensure that data binding works correctly | |
8
+ | **event_id** | **String** | UUID id of the source event in the Velo platform | |
9
+ | **created_at** | **Time** | ISO8601 timestamp indicating when the source event was created | |
10
+ | **payee_id** | **String** | ID of this payee within the Velo platform | |
11
+ | **reasons** | [**Array<PayeeEventAllOfReasons>**](PayeeEventAllOfReasons.md) | The reasons for the event notification. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'velopayments'
17
+
18
+ instance = VeloPayments::PayeeEvent.new(
19
+ source_type: payment_status_changed,
20
+ event_id: 270ab907-27ec-4b83-8028-0ff432bbdec4,
21
+ created_at: 2020-06-18T15:09:42Z,
22
+ payee_id: cbd9280f-8fde-4190-b014-979d88f3ec54,
23
+ reasons: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,20 @@
1
+ # VeloPayments::PayeeEventAllOf
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **payee_id** | **String** | ID of this payee within the Velo platform | |
8
+ | **reasons** | [**Array<PayeeEventAllOfReasons>**](PayeeEventAllOfReasons.md) | The reasons for the event notification. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'velopayments'
14
+
15
+ instance = VeloPayments::PayeeEventAllOf.new(
16
+ payee_id: cbd9280f-8fde-4190-b014-979d88f3ec54,
17
+ reasons: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # VeloPayments::PayeeEventAllOfReasons
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **code** | **String** | | |
8
+ | **message** | **String** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'velopayments'
14
+
15
+ instance = VeloPayments::PayeeEventAllOfReasons.new(
16
+ code: 00001,
17
+ message: payment channel disabled
18
+ )
19
+ ```
20
+
@@ -2,32 +2,30 @@
2
2
 
3
3
  All URIs are relative to *https://api.sandbox.velopayments.com*
4
4
 
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**get_payees_invitation_status_v1**](PayeeInvitationApi.md#get_payees_invitation_status_v1) | **GET** /v1/payees/payors/{payorId}/invitationStatus | Get Payee Invitation Status
8
- [**get_payees_invitation_status_v2**](PayeeInvitationApi.md#get_payees_invitation_status_v2) | **GET** /v2/payees/payors/{payorId}/invitationStatus | Get Payee Invitation Status
9
- [**get_payees_invitation_status_v3**](PayeeInvitationApi.md#get_payees_invitation_status_v3) | **GET** /v3/payees/payors/{payorId}/invitationStatus | Get Payee Invitation Status
10
- [**query_batch_status_v2**](PayeeInvitationApi.md#query_batch_status_v2) | **GET** /v2/payees/batch/{batchId} | Query Batch Status
11
- [**query_batch_status_v3**](PayeeInvitationApi.md#query_batch_status_v3) | **GET** /v3/payees/batch/{batchId} | Query Batch Status
12
- [**resend_payee_invite_v1**](PayeeInvitationApi.md#resend_payee_invite_v1) | **POST** /v1/payees/{payeeId}/invite | Resend Payee Invite
13
- [**resend_payee_invite_v3**](PayeeInvitationApi.md#resend_payee_invite_v3) | **POST** /v3/payees/{payeeId}/invite | Resend Payee Invite
14
- [**v2_create_payee**](PayeeInvitationApi.md#v2_create_payee) | **POST** /v2/payees | Initiate Payee Creation
15
- [**v3_create_payee**](PayeeInvitationApi.md#v3_create_payee) | **POST** /v3/payees | Initiate Payee Creation
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**get_payees_invitation_status_v3**](PayeeInvitationApi.md#get_payees_invitation_status_v3) | **GET** /v3/payees/payors/{payorId}/invitationStatus | Get Payee Invitation Status |
8
+ | [**get_payees_invitation_status_v4**](PayeeInvitationApi.md#get_payees_invitation_status_v4) | **GET** /v4/payees/payors/{payorId}/invitationStatus | Get Payee Invitation Status |
9
+ | [**query_batch_status_v3**](PayeeInvitationApi.md#query_batch_status_v3) | **GET** /v3/payees/batch/{batchId} | Query Batch Status |
10
+ | [**query_batch_status_v4**](PayeeInvitationApi.md#query_batch_status_v4) | **GET** /v4/payees/batch/{batchId} | Query Batch Status |
11
+ | [**resend_payee_invite_v3**](PayeeInvitationApi.md#resend_payee_invite_v3) | **POST** /v3/payees/{payeeId}/invite | Resend Payee Invite |
12
+ | [**resend_payee_invite_v4**](PayeeInvitationApi.md#resend_payee_invite_v4) | **POST** /v4/payees/{payeeId}/invite | Resend Payee Invite |
13
+ | [**v3_create_payee**](PayeeInvitationApi.md#v3_create_payee) | **POST** /v3/payees | Initiate Payee Creation |
14
+ | [**v4_create_payee**](PayeeInvitationApi.md#v4_create_payee) | **POST** /v4/payees | Initiate Payee Creation |
16
15
 
17
16
 
17
+ ## get_payees_invitation_status_v3
18
18
 
19
- ## get_payees_invitation_status_v1
20
-
21
- > InvitationStatusResponse get_payees_invitation_status_v1(payor_id)
19
+ > <PagedPayeeInvitationStatusResponse> get_payees_invitation_status_v3(payor_id, opts)
22
20
 
23
21
  Get Payee Invitation Status
24
22
 
25
- <p>Returns a list of payees associated with a payor, along with invitation status and grace period end date.</p> <p>Please use V3 instead</p>
23
+ <p>Use v4 instead</p> <p>Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.</p>
26
24
 
27
- ### Example
25
+ ### Examples
28
26
 
29
27
  ```ruby
30
- # load the gem
28
+ require 'time'
31
29
  require 'velopayments'
32
30
  # setup authorization
33
31
  VeloPayments.configure do |config|
@@ -36,85 +34,50 @@ VeloPayments.configure do |config|
36
34
  end
37
35
 
38
36
  api_instance = VeloPayments::PayeeInvitationApi.new
39
- payor_id = '9ac75325-5dcd-42d5-b992-175d7e0a035e' # String | The account owner Payor ID
37
+ payor_id = TODO # String | The account owner Payor ID
38
+ opts = {
39
+ payee_id: TODO, # String | The UUID of the payee.
40
+ invitation_status: VeloPayments::InvitationStatus::ACCEPTED, # InvitationStatus | The invitation status of the payees.
41
+ page: 1, # Integer | Page number. Default is 1.
42
+ page_size: 25 # Integer | Page size. Default is 25. Max allowable is 100.
43
+ }
40
44
 
41
45
  begin
42
- #Get Payee Invitation Status
43
- result = api_instance.get_payees_invitation_status_v1(payor_id)
46
+ # Get Payee Invitation Status
47
+ result = api_instance.get_payees_invitation_status_v3(payor_id, opts)
44
48
  p result
45
49
  rescue VeloPayments::ApiError => e
46
- puts "Exception when calling PayeeInvitationApi->get_payees_invitation_status_v1: #{e}"
50
+ puts "Error when calling PayeeInvitationApi->get_payees_invitation_status_v3: #{e}"
47
51
  end
48
52
  ```
49
53
 
50
- ### Parameters
51
-
52
-
53
- Name | Type | Description | Notes
54
- ------------- | ------------- | ------------- | -------------
55
- **payor_id** | [**String**](.md)| The account owner Payor ID |
56
-
57
- ### Return type
58
-
59
- [**InvitationStatusResponse**](InvitationStatusResponse.md)
54
+ #### Using the get_payees_invitation_status_v3_with_http_info variant
60
55
 
61
- ### Authorization
56
+ This returns an Array which contains the response data, status code and headers.
62
57
 
63
- [OAuth2](../README.md#OAuth2)
64
-
65
- ### HTTP request headers
66
-
67
- - **Content-Type**: Not defined
68
- - **Accept**: application/json
69
-
70
-
71
- ## get_payees_invitation_status_v2
72
-
73
- > PagedPayeeInvitationStatusResponse get_payees_invitation_status_v2(payor_id, opts)
74
-
75
- Get Payee Invitation Status
76
-
77
- <p>Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.</p> <p>Please use V3 instead</p>
78
-
79
- ### Example
58
+ > <Array(<PagedPayeeInvitationStatusResponse>, Integer, Hash)> get_payees_invitation_status_v3_with_http_info(payor_id, opts)
80
59
 
81
60
  ```ruby
82
- # load the gem
83
- require 'velopayments'
84
- # setup authorization
85
- VeloPayments.configure do |config|
86
- # Configure OAuth2 access token for authorization: OAuth2
87
- config.access_token = 'YOUR ACCESS TOKEN'
88
- end
89
-
90
- api_instance = VeloPayments::PayeeInvitationApi.new
91
- payor_id = '9ac75325-5dcd-42d5-b992-175d7e0a035e' # String | The account owner Payor ID
92
- opts = {
93
- payee_id: '2aa5d7e0-2ecb-403f-8494-1865ed0454e9', # String | The UUID of the payee.
94
- invitation_status: VeloPayments::InvitationStatus.new, # InvitationStatus | The invitation status of the payees.
95
- page: 1, # Integer | Page number. Default is 1.
96
- page_size: 25 # Integer | Page size. Default is 25. Max allowable is 100.
97
- }
98
-
99
61
  begin
100
- #Get Payee Invitation Status
101
- result = api_instance.get_payees_invitation_status_v2(payor_id, opts)
102
- p result
62
+ # Get Payee Invitation Status
63
+ data, status_code, headers = api_instance.get_payees_invitation_status_v3_with_http_info(payor_id, opts)
64
+ p status_code # => 2xx
65
+ p headers # => { ... }
66
+ p data # => <PagedPayeeInvitationStatusResponse>
103
67
  rescue VeloPayments::ApiError => e
104
- puts "Exception when calling PayeeInvitationApi->get_payees_invitation_status_v2: #{e}"
68
+ puts "Error when calling PayeeInvitationApi->get_payees_invitation_status_v3_with_http_info: #{e}"
105
69
  end
106
70
  ```
107
71
 
108
72
  ### Parameters
109
73
 
110
-
111
- Name | Type | Description | Notes
112
- ------------- | ------------- | ------------- | -------------
113
- **payor_id** | [**String**](.md)| The account owner Payor ID |
114
- **payee_id** | [**String**](.md)| The UUID of the payee. | [optional]
115
- **invitation_status** | [**InvitationStatus**](.md)| The invitation status of the payees. | [optional]
116
- **page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
117
- **page_size** | **Integer**| Page size. Default is 25. Max allowable is 100. | [optional] [default to 25]
74
+ | Name | Type | Description | Notes |
75
+ | ---- | ---- | ----------- | ----- |
76
+ | **payor_id** | [**String**](.md) | The account owner Payor ID | |
77
+ | **payee_id** | [**String**](.md) | The UUID of the payee. | [optional] |
78
+ | **invitation_status** | [**InvitationStatus**](.md) | The invitation status of the payees. | [optional] |
79
+ | **page** | **Integer** | Page number. Default is 1. | [optional][default to 1] |
80
+ | **page_size** | **Integer** | Page size. Default is 25. Max allowable is 100. | [optional][default to 25] |
118
81
 
119
82
  ### Return type
120
83
 
@@ -130,18 +93,18 @@ Name | Type | Description | Notes
130
93
  - **Accept**: application/json
131
94
 
132
95
 
133
- ## get_payees_invitation_status_v3
96
+ ## get_payees_invitation_status_v4
134
97
 
135
- > PagedPayeeInvitationStatusResponse2 get_payees_invitation_status_v3(payor_id, opts)
98
+ > <PagedPayeeInvitationStatusResponse2> get_payees_invitation_status_v4(payor_id, opts)
136
99
 
137
100
  Get Payee Invitation Status
138
101
 
139
102
  Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.
140
103
 
141
- ### Example
104
+ ### Examples
142
105
 
143
106
  ```ruby
144
- # load the gem
107
+ require 'time'
145
108
  require 'velopayments'
146
109
  # setup authorization
147
110
  VeloPayments.configure do |config|
@@ -150,33 +113,50 @@ VeloPayments.configure do |config|
150
113
  end
151
114
 
152
115
  api_instance = VeloPayments::PayeeInvitationApi.new
153
- payor_id = '9ac75325-5dcd-42d5-b992-175d7e0a035e' # String | The account owner Payor ID
116
+ payor_id = TODO # String | The account owner Payor ID
154
117
  opts = {
155
- payee_id: '2aa5d7e0-2ecb-403f-8494-1865ed0454e9', # String | The UUID of the payee.
156
- invitation_status: VeloPayments::InvitationStatus.new, # InvitationStatus | The invitation status of the payees.
118
+ payee_id: TODO, # String | The UUID of the payee.
119
+ invitation_status: VeloPayments::InvitationStatus::ACCEPTED, # InvitationStatus | The invitation status of the payees.
157
120
  page: 1, # Integer | Page number. Default is 1.
158
121
  page_size: 25 # Integer | Page size. Default is 25. Max allowable is 100.
159
122
  }
160
123
 
161
124
  begin
162
- #Get Payee Invitation Status
163
- result = api_instance.get_payees_invitation_status_v3(payor_id, opts)
125
+ # Get Payee Invitation Status
126
+ result = api_instance.get_payees_invitation_status_v4(payor_id, opts)
164
127
  p result
165
128
  rescue VeloPayments::ApiError => e
166
- puts "Exception when calling PayeeInvitationApi->get_payees_invitation_status_v3: #{e}"
129
+ puts "Error when calling PayeeInvitationApi->get_payees_invitation_status_v4: #{e}"
167
130
  end
168
131
  ```
169
132
 
170
- ### Parameters
133
+ #### Using the get_payees_invitation_status_v4_with_http_info variant
171
134
 
135
+ This returns an Array which contains the response data, status code and headers.
172
136
 
173
- Name | Type | Description | Notes
174
- ------------- | ------------- | ------------- | -------------
175
- **payor_id** | [**String**](.md)| The account owner Payor ID |
176
- **payee_id** | [**String**](.md)| The UUID of the payee. | [optional]
177
- **invitation_status** | [**InvitationStatus**](.md)| The invitation status of the payees. | [optional]
178
- **page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
179
- **page_size** | **Integer**| Page size. Default is 25. Max allowable is 100. | [optional] [default to 25]
137
+ > <Array(<PagedPayeeInvitationStatusResponse2>, Integer, Hash)> get_payees_invitation_status_v4_with_http_info(payor_id, opts)
138
+
139
+ ```ruby
140
+ begin
141
+ # Get Payee Invitation Status
142
+ data, status_code, headers = api_instance.get_payees_invitation_status_v4_with_http_info(payor_id, opts)
143
+ p status_code # => 2xx
144
+ p headers # => { ... }
145
+ p data # => <PagedPayeeInvitationStatusResponse2>
146
+ rescue VeloPayments::ApiError => e
147
+ puts "Error when calling PayeeInvitationApi->get_payees_invitation_status_v4_with_http_info: #{e}"
148
+ end
149
+ ```
150
+
151
+ ### Parameters
152
+
153
+ | Name | Type | Description | Notes |
154
+ | ---- | ---- | ----------- | ----- |
155
+ | **payor_id** | [**String**](.md) | The account owner Payor ID | |
156
+ | **payee_id** | [**String**](.md) | The UUID of the payee. | [optional] |
157
+ | **invitation_status** | [**InvitationStatus**](.md) | The invitation status of the payees. | [optional] |
158
+ | **page** | **Integer** | Page number. Default is 1. | [optional][default to 1] |
159
+ | **page_size** | **Integer** | Page size. Default is 25. Max allowable is 100. | [optional][default to 25] |
180
160
 
181
161
  ### Return type
182
162
 
@@ -192,18 +172,18 @@ Name | Type | Description | Notes
192
172
  - **Accept**: application/json
193
173
 
194
174
 
195
- ## query_batch_status_v2
175
+ ## query_batch_status_v3
196
176
 
197
- > QueryBatchResponse query_batch_status_v2(batch_id)
177
+ > <QueryBatchResponse> query_batch_status_v3(batch_id)
198
178
 
199
179
  Query Batch Status
200
180
 
201
- <p>Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ).</p> <p>Please use V3 instead</p>
181
+ <p>Use v4 instead</p> Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ).
202
182
 
203
- ### Example
183
+ ### Examples
204
184
 
205
185
  ```ruby
206
- # load the gem
186
+ require 'time'
207
187
  require 'velopayments'
208
188
  # setup authorization
209
189
  VeloPayments.configure do |config|
@@ -212,23 +192,40 @@ VeloPayments.configure do |config|
212
192
  end
213
193
 
214
194
  api_instance = VeloPayments::PayeeInvitationApi.new
215
- batch_id = 'batch_id_example' # String | Batch Id
195
+ batch_id = TODO # String | Batch Id
216
196
 
217
197
  begin
218
- #Query Batch Status
219
- result = api_instance.query_batch_status_v2(batch_id)
198
+ # Query Batch Status
199
+ result = api_instance.query_batch_status_v3(batch_id)
220
200
  p result
221
201
  rescue VeloPayments::ApiError => e
222
- puts "Exception when calling PayeeInvitationApi->query_batch_status_v2: #{e}"
202
+ puts "Error when calling PayeeInvitationApi->query_batch_status_v3: #{e}"
223
203
  end
224
204
  ```
225
205
 
226
- ### Parameters
206
+ #### Using the query_batch_status_v3_with_http_info variant
207
+
208
+ This returns an Array which contains the response data, status code and headers.
209
+
210
+ > <Array(<QueryBatchResponse>, Integer, Hash)> query_batch_status_v3_with_http_info(batch_id)
211
+
212
+ ```ruby
213
+ begin
214
+ # Query Batch Status
215
+ data, status_code, headers = api_instance.query_batch_status_v3_with_http_info(batch_id)
216
+ p status_code # => 2xx
217
+ p headers # => { ... }
218
+ p data # => <QueryBatchResponse>
219
+ rescue VeloPayments::ApiError => e
220
+ puts "Error when calling PayeeInvitationApi->query_batch_status_v3_with_http_info: #{e}"
221
+ end
222
+ ```
227
223
 
224
+ ### Parameters
228
225
 
229
- Name | Type | Description | Notes
230
- ------------- | ------------- | ------------- | -------------
231
- **batch_id** | [**String**](.md)| Batch Id |
226
+ | Name | Type | Description | Notes |
227
+ | ---- | ---- | ----------- | ----- |
228
+ | **batch_id** | [**String**](.md) | Batch Id | |
232
229
 
233
230
  ### Return type
234
231
 
@@ -244,18 +241,18 @@ Name | Type | Description | Notes
244
241
  - **Accept**: application/json
245
242
 
246
243
 
247
- ## query_batch_status_v3
244
+ ## query_batch_status_v4
248
245
 
249
- > QueryBatchResponse2 query_batch_status_v3(batch_id)
246
+ > <QueryBatchResponse2> query_batch_status_v4(batch_id)
250
247
 
251
248
  Query Batch Status
252
249
 
253
250
  Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ).
254
251
 
255
- ### Example
252
+ ### Examples
256
253
 
257
254
  ```ruby
258
- # load the gem
255
+ require 'time'
259
256
  require 'velopayments'
260
257
  # setup authorization
261
258
  VeloPayments.configure do |config|
@@ -264,23 +261,40 @@ VeloPayments.configure do |config|
264
261
  end
265
262
 
266
263
  api_instance = VeloPayments::PayeeInvitationApi.new
267
- batch_id = 'batch_id_example' # String | Batch Id
264
+ batch_id = TODO # String | Batch Id
268
265
 
269
266
  begin
270
- #Query Batch Status
271
- result = api_instance.query_batch_status_v3(batch_id)
267
+ # Query Batch Status
268
+ result = api_instance.query_batch_status_v4(batch_id)
272
269
  p result
273
270
  rescue VeloPayments::ApiError => e
274
- puts "Exception when calling PayeeInvitationApi->query_batch_status_v3: #{e}"
271
+ puts "Error when calling PayeeInvitationApi->query_batch_status_v4: #{e}"
275
272
  end
276
273
  ```
277
274
 
278
- ### Parameters
275
+ #### Using the query_batch_status_v4_with_http_info variant
276
+
277
+ This returns an Array which contains the response data, status code and headers.
279
278
 
279
+ > <Array(<QueryBatchResponse2>, Integer, Hash)> query_batch_status_v4_with_http_info(batch_id)
280
+
281
+ ```ruby
282
+ begin
283
+ # Query Batch Status
284
+ data, status_code, headers = api_instance.query_batch_status_v4_with_http_info(batch_id)
285
+ p status_code # => 2xx
286
+ p headers # => { ... }
287
+ p data # => <QueryBatchResponse2>
288
+ rescue VeloPayments::ApiError => e
289
+ puts "Error when calling PayeeInvitationApi->query_batch_status_v4_with_http_info: #{e}"
290
+ end
291
+ ```
292
+
293
+ ### Parameters
280
294
 
281
- Name | Type | Description | Notes
282
- ------------- | ------------- | ------------- | -------------
283
- **batch_id** | [**String**](.md)| Batch Id |
295
+ | Name | Type | Description | Notes |
296
+ | ---- | ---- | ----------- | ----- |
297
+ | **batch_id** | [**String**](.md) | Batch Id | |
284
298
 
285
299
  ### Return type
286
300
 
@@ -296,18 +310,18 @@ Name | Type | Description | Notes
296
310
  - **Accept**: application/json
297
311
 
298
312
 
299
- ## resend_payee_invite_v1
313
+ ## resend_payee_invite_v3
300
314
 
301
- > resend_payee_invite_v1(payee_id, invite_payee_request)
315
+ > resend_payee_invite_v3(payee_id, invite_payee_request)
302
316
 
303
317
  Resend Payee Invite
304
318
 
305
- <p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p> <p>Deprecated. Please use v3 instead</p>
319
+ <p>Use v4 instead</p> <p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p>
306
320
 
307
- ### Example
321
+ ### Examples
308
322
 
309
323
  ```ruby
310
- # load the gem
324
+ require 'time'
311
325
  require 'velopayments'
312
326
  # setup authorization
313
327
  VeloPayments.configure do |config|
@@ -316,24 +330,41 @@ VeloPayments.configure do |config|
316
330
  end
317
331
 
318
332
  api_instance = VeloPayments::PayeeInvitationApi.new
319
- payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
320
- invite_payee_request = VeloPayments::InvitePayeeRequest.new # InvitePayeeRequest | Provide Payor Id in body of request
333
+ payee_id = TODO # String | The UUID of the payee.
334
+ invite_payee_request = VeloPayments::InvitePayeeRequest.new({payor_id: '9ac75325-5dcd-42d5-b992-175d7e0a035e'}) # InvitePayeeRequest | Provide Payor Id in body of request
321
335
 
322
336
  begin
323
- #Resend Payee Invite
324
- api_instance.resend_payee_invite_v1(payee_id, invite_payee_request)
337
+ # Resend Payee Invite
338
+ api_instance.resend_payee_invite_v3(payee_id, invite_payee_request)
325
339
  rescue VeloPayments::ApiError => e
326
- puts "Exception when calling PayeeInvitationApi->resend_payee_invite_v1: #{e}"
340
+ puts "Error when calling PayeeInvitationApi->resend_payee_invite_v3: #{e}"
327
341
  end
328
342
  ```
329
343
 
330
- ### Parameters
344
+ #### Using the resend_payee_invite_v3_with_http_info variant
331
345
 
346
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
332
347
 
333
- Name | Type | Description | Notes
334
- ------------- | ------------- | ------------- | -------------
335
- **payee_id** | [**String**](.md)| The UUID of the payee. |
336
- **invite_payee_request** | [**InvitePayeeRequest**](InvitePayeeRequest.md)| Provide Payor Id in body of request |
348
+ > <Array(nil, Integer, Hash)> resend_payee_invite_v3_with_http_info(payee_id, invite_payee_request)
349
+
350
+ ```ruby
351
+ begin
352
+ # Resend Payee Invite
353
+ data, status_code, headers = api_instance.resend_payee_invite_v3_with_http_info(payee_id, invite_payee_request)
354
+ p status_code # => 2xx
355
+ p headers # => { ... }
356
+ p data # => nil
357
+ rescue VeloPayments::ApiError => e
358
+ puts "Error when calling PayeeInvitationApi->resend_payee_invite_v3_with_http_info: #{e}"
359
+ end
360
+ ```
361
+
362
+ ### Parameters
363
+
364
+ | Name | Type | Description | Notes |
365
+ | ---- | ---- | ----------- | ----- |
366
+ | **payee_id** | [**String**](.md) | The UUID of the payee. | |
367
+ | **invite_payee_request** | [**InvitePayeeRequest**](InvitePayeeRequest.md) | Provide Payor Id in body of request | |
337
368
 
338
369
  ### Return type
339
370
 
@@ -349,18 +380,18 @@ nil (empty response body)
349
380
  - **Accept**: application/json
350
381
 
351
382
 
352
- ## resend_payee_invite_v3
383
+ ## resend_payee_invite_v4
353
384
 
354
- > resend_payee_invite_v3(payee_id, invite_payee_request2)
385
+ > resend_payee_invite_v4(payee_id, invite_payee_request2)
355
386
 
356
387
  Resend Payee Invite
357
388
 
358
389
  <p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p>
359
390
 
360
- ### Example
391
+ ### Examples
361
392
 
362
393
  ```ruby
363
- # load the gem
394
+ require 'time'
364
395
  require 'velopayments'
365
396
  # setup authorization
366
397
  VeloPayments.configure do |config|
@@ -369,24 +400,41 @@ VeloPayments.configure do |config|
369
400
  end
370
401
 
371
402
  api_instance = VeloPayments::PayeeInvitationApi.new
372
- payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
373
- invite_payee_request2 = VeloPayments::InvitePayeeRequest2.new # InvitePayeeRequest2 | Provide Payor Id in body of request
403
+ payee_id = TODO # String | The UUID of the payee.
404
+ invite_payee_request2 = VeloPayments::InvitePayeeRequest2.new({payor_id: '9ac75325-5dcd-42d5-b992-175d7e0a035e'}) # InvitePayeeRequest2 | Provide Payor Id in body of request
374
405
 
375
406
  begin
376
- #Resend Payee Invite
377
- api_instance.resend_payee_invite_v3(payee_id, invite_payee_request2)
407
+ # Resend Payee Invite
408
+ api_instance.resend_payee_invite_v4(payee_id, invite_payee_request2)
378
409
  rescue VeloPayments::ApiError => e
379
- puts "Exception when calling PayeeInvitationApi->resend_payee_invite_v3: #{e}"
410
+ puts "Error when calling PayeeInvitationApi->resend_payee_invite_v4: #{e}"
380
411
  end
381
412
  ```
382
413
 
383
- ### Parameters
414
+ #### Using the resend_payee_invite_v4_with_http_info variant
415
+
416
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
417
+
418
+ > <Array(nil, Integer, Hash)> resend_payee_invite_v4_with_http_info(payee_id, invite_payee_request2)
384
419
 
420
+ ```ruby
421
+ begin
422
+ # Resend Payee Invite
423
+ data, status_code, headers = api_instance.resend_payee_invite_v4_with_http_info(payee_id, invite_payee_request2)
424
+ p status_code # => 2xx
425
+ p headers # => { ... }
426
+ p data # => nil
427
+ rescue VeloPayments::ApiError => e
428
+ puts "Error when calling PayeeInvitationApi->resend_payee_invite_v4_with_http_info: #{e}"
429
+ end
430
+ ```
431
+
432
+ ### Parameters
385
433
 
386
- Name | Type | Description | Notes
387
- ------------- | ------------- | ------------- | -------------
388
- **payee_id** | [**String**](.md)| The UUID of the payee. |
389
- **invite_payee_request2** | [**InvitePayeeRequest2**](InvitePayeeRequest2.md)| Provide Payor Id in body of request |
434
+ | Name | Type | Description | Notes |
435
+ | ---- | ---- | ----------- | ----- |
436
+ | **payee_id** | [**String**](.md) | The UUID of the payee. | |
437
+ | **invite_payee_request2** | [**InvitePayeeRequest2**](InvitePayeeRequest2.md) | Provide Payor Id in body of request | |
390
438
 
391
439
  ### Return type
392
440
 
@@ -402,18 +450,18 @@ nil (empty response body)
402
450
  - **Accept**: application/json
403
451
 
404
452
 
405
- ## v2_create_payee
453
+ ## v3_create_payee
406
454
 
407
- > CreatePayeesCSVResponse v2_create_payee(opts)
455
+ > <CreatePayeesCSVResponse> v3_create_payee(opts)
408
456
 
409
457
  Initiate Payee Creation
410
458
 
411
- Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body, 409 - if there is a duplicate remote id within the batch / if there is a duplicate email within the batch).
459
+ <p>Use v4 instead</p> Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body. In addition to standard semantic validations, a 400 will also result if there is a duplicate remote id within the batch / if there is a duplicate email within the batch, i.e. if there is a conflict between the data provided for one payee within the batch and that provided for another payee within the same batch). The validation at this stage is intra-batch only. Validation against payees who have already been invited occurs subsequently during processing of the batch.
412
460
 
413
- ### Example
461
+ ### Examples
414
462
 
415
463
  ```ruby
416
- # load the gem
464
+ require 'time'
417
465
  require 'velopayments'
418
466
  # setup authorization
419
467
  VeloPayments.configure do |config|
@@ -423,24 +471,41 @@ end
423
471
 
424
472
  api_instance = VeloPayments::PayeeInvitationApi.new
425
473
  opts = {
426
- create_payees_request: VeloPayments::CreatePayeesRequest.new # CreatePayeesRequest | Post payees to create.
474
+ create_payees_request: VeloPayments::CreatePayeesRequest.new({payor_id: '9ac75325-5dcd-42d5-b992-175d7e0a035e', payees: [VeloPayments::CreatePayee.new({email: 'bob@example.com', remote_id: 'Remote ID', type: VeloPayments::PayeeType::INDIVIDUAL, address: VeloPayments::CreatePayeeAddress.new({line1: '500 Duval St', city: 'Key West', country: 'AF'})})]}) # CreatePayeesRequest | Post payees to create.
427
475
  }
428
476
 
429
477
  begin
430
- #Initiate Payee Creation
431
- result = api_instance.v2_create_payee(opts)
478
+ # Initiate Payee Creation
479
+ result = api_instance.v3_create_payee(opts)
432
480
  p result
433
481
  rescue VeloPayments::ApiError => e
434
- puts "Exception when calling PayeeInvitationApi->v2_create_payee: #{e}"
482
+ puts "Error when calling PayeeInvitationApi->v3_create_payee: #{e}"
435
483
  end
436
484
  ```
437
485
 
438
- ### Parameters
486
+ #### Using the v3_create_payee_with_http_info variant
439
487
 
488
+ This returns an Array which contains the response data, status code and headers.
440
489
 
441
- Name | Type | Description | Notes
442
- ------------- | ------------- | ------------- | -------------
443
- **create_payees_request** | [**CreatePayeesRequest**](CreatePayeesRequest.md)| Post payees to create. | [optional]
490
+ > <Array(<CreatePayeesCSVResponse>, Integer, Hash)> v3_create_payee_with_http_info(opts)
491
+
492
+ ```ruby
493
+ begin
494
+ # Initiate Payee Creation
495
+ data, status_code, headers = api_instance.v3_create_payee_with_http_info(opts)
496
+ p status_code # => 2xx
497
+ p headers # => { ... }
498
+ p data # => <CreatePayeesCSVResponse>
499
+ rescue VeloPayments::ApiError => e
500
+ puts "Error when calling PayeeInvitationApi->v3_create_payee_with_http_info: #{e}"
501
+ end
502
+ ```
503
+
504
+ ### Parameters
505
+
506
+ | Name | Type | Description | Notes |
507
+ | ---- | ---- | ----------- | ----- |
508
+ | **create_payees_request** | [**CreatePayeesRequest**](CreatePayeesRequest.md) | Post payees to create. | [optional] |
444
509
 
445
510
  ### Return type
446
511
 
@@ -456,18 +521,18 @@ Name | Type | Description | Notes
456
521
  - **Accept**: application/json
457
522
 
458
523
 
459
- ## v3_create_payee
524
+ ## v4_create_payee
460
525
 
461
- > CreatePayeesCSVResponse2 v3_create_payee(opts)
526
+ > <CreatePayeesCSVResponse2> v4_create_payee(opts)
462
527
 
463
528
  Initiate Payee Creation
464
529
 
465
- Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body, 409 - if there is a duplicate remote id within the batch / if there is a duplicate email within the batch).
530
+ Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body. In addition to standard semantic validations, a 400 will also result if there is a duplicate remote id within the batch / if there is a duplicate email within the batch, i.e. if there is a conflict between the data provided for one payee within the batch and that provided for another payee within the same batch). The validation at this stage is intra-batch only. Validation against payees who have already been invited occurs subsequently during processing of the batch.
466
531
 
467
- ### Example
532
+ ### Examples
468
533
 
469
534
  ```ruby
470
- # load the gem
535
+ require 'time'
471
536
  require 'velopayments'
472
537
  # setup authorization
473
538
  VeloPayments.configure do |config|
@@ -477,24 +542,41 @@ end
477
542
 
478
543
  api_instance = VeloPayments::PayeeInvitationApi.new
479
544
  opts = {
480
- create_payees_request2: VeloPayments::CreatePayeesRequest2.new # CreatePayeesRequest2 | Post payees to create.
545
+ create_payees_request2: VeloPayments::CreatePayeesRequest2.new({payor_id: '9ac75325-5dcd-42d5-b992-175d7e0a035e', payees: [VeloPayments::CreatePayee2.new({email: 'bob@example.com', remote_id: 'Remote ID', type: VeloPayments::PayeeType::INDIVIDUAL, address: VeloPayments::CreatePayeeAddress2.new({line1: '500 Duval St', city: 'Key West', country: 'AF'})})]}) # CreatePayeesRequest2 | Post payees to create.
481
546
  }
482
547
 
483
548
  begin
484
- #Initiate Payee Creation
485
- result = api_instance.v3_create_payee(opts)
549
+ # Initiate Payee Creation
550
+ result = api_instance.v4_create_payee(opts)
486
551
  p result
487
552
  rescue VeloPayments::ApiError => e
488
- puts "Exception when calling PayeeInvitationApi->v3_create_payee: #{e}"
553
+ puts "Error when calling PayeeInvitationApi->v4_create_payee: #{e}"
489
554
  end
490
555
  ```
491
556
 
492
- ### Parameters
557
+ #### Using the v4_create_payee_with_http_info variant
558
+
559
+ This returns an Array which contains the response data, status code and headers.
560
+
561
+ > <Array(<CreatePayeesCSVResponse2>, Integer, Hash)> v4_create_payee_with_http_info(opts)
493
562
 
563
+ ```ruby
564
+ begin
565
+ # Initiate Payee Creation
566
+ data, status_code, headers = api_instance.v4_create_payee_with_http_info(opts)
567
+ p status_code # => 2xx
568
+ p headers # => { ... }
569
+ p data # => <CreatePayeesCSVResponse2>
570
+ rescue VeloPayments::ApiError => e
571
+ puts "Error when calling PayeeInvitationApi->v4_create_payee_with_http_info: #{e}"
572
+ end
573
+ ```
574
+
575
+ ### Parameters
494
576
 
495
- Name | Type | Description | Notes
496
- ------------- | ------------- | ------------- | -------------
497
- **create_payees_request2** | [**CreatePayeesRequest2**](CreatePayeesRequest2.md)| Post payees to create. | [optional]
577
+ | Name | Type | Description | Notes |
578
+ | ---- | ---- | ----------- | ----- |
579
+ | **create_payees_request2** | [**CreatePayeesRequest2**](CreatePayeesRequest2.md) | Post payees to create. | [optional] |
498
580
 
499
581
  ### Return type
500
582