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