velopayments 2.18.113 → 2.19.40.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 (568) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +62 -48
  3. data/docs/Challenge.md +2 -2
  4. data/docs/Company.md +21 -0
  5. data/docs/Company2.md +21 -0
  6. data/docs/CompanyResponse.md +2 -2
  7. data/docs/CompanyV1.md +3 -3
  8. data/docs/CountriesApi.md +3 -13
  9. data/docs/CreateIndividual.md +2 -2
  10. data/docs/CreateIndividual2.md +3 -3
  11. data/docs/CreateIndividual2Name.md +23 -0
  12. data/docs/CreatePayee.md +4 -4
  13. data/docs/CreatePayee2.md +4 -4
  14. data/docs/CreatePayeesCSVRequest.md +22 -22
  15. data/docs/CreatePayeesCSVRequest2.md +23 -23
  16. data/docs/CreatePayeesCSVResponse.md +2 -2
  17. data/docs/CreatePayeesCSVResponse2.md +2 -2
  18. data/docs/CreatePayeesCSVResponseRejectedCsvRows.md +21 -0
  19. data/docs/CreatePayeesRequest.md +1 -1
  20. data/docs/CreatePayeesRequest2.md +1 -1
  21. data/docs/CreatePaymentChannel.md +6 -6
  22. data/docs/CreatePaymentChannel2.md +6 -6
  23. data/docs/CreatePayoutRequest.md +3 -3
  24. data/docs/CurrenciesApi.md +1 -6
  25. data/docs/FailedSubmission.md +2 -2
  26. data/docs/FailedSubmission2.md +19 -0
  27. data/docs/FundingManagerApi.md +8 -4
  28. data/docs/{DefaultApi.md → FundingManagerPrivateApi.md} +4 -4
  29. data/docs/GetPaymentsForPayoutResponseV4.md +1 -1
  30. data/docs/GetPayoutApi.md +5 -5
  31. data/docs/GetPayoutsResponseV4.md +1 -1
  32. data/docs/Individual.md +21 -0
  33. data/docs/Individual2.md +21 -0
  34. data/docs/IndividualV1.md +2 -2
  35. data/docs/IndividualV1Name.md +4 -4
  36. data/docs/InlineResponse400.md +19 -0
  37. data/docs/InlineResponse400Errors.md +23 -0
  38. data/docs/InlineResponse401.md +19 -0
  39. data/docs/InlineResponse401Errors.md +23 -0
  40. data/docs/InlineResponse403.md +19 -0
  41. data/docs/InlineResponse403Errors.md +23 -0
  42. data/docs/InstructPayoutApi.md +6 -6
  43. data/docs/InvitePayeeRequest.md +1 -1
  44. data/docs/{GenerateOTPRequest.md → InvitePayeeRequest2.md} +3 -3
  45. data/docs/InviteUserRequest.md +2 -2
  46. data/docs/{MFAStatus.md → Language2.md} +2 -2
  47. data/docs/{TokenType.md → LocationType.md} +2 -2
  48. data/docs/MarketingOptIn.md +1 -1
  49. data/docs/{OTPType.md → OfacStatus2.md} +2 -2
  50. data/docs/{PaymentStatus.md → OnboardedStatus2.md} +2 -2
  51. data/docs/PagedPayeeInvitationStatusResponse.md +1 -1
  52. data/docs/PagedPayeeInvitationStatusResponse2.md +21 -0
  53. data/docs/PagedPayeeInvitationStatusResponsePage.md +25 -0
  54. data/docs/PagedPayeeResponse2Summary.md +5 -5
  55. data/docs/PagedPayeeResponsePage.md +5 -5
  56. data/docs/PagedPayeeResponseSummary.md +5 -5
  57. data/docs/Payee.md +9 -9
  58. data/docs/Payee2.md +57 -0
  59. data/docs/PayeeAddress2.md +31 -0
  60. data/docs/PayeeDelta.md +1 -1
  61. data/docs/PayeeDelta2.md +29 -0
  62. data/docs/PayeeDeltaResponse2.md +21 -0
  63. data/docs/PayeeDeltaResponse2Links.md +19 -0
  64. data/docs/PayeeInvitationApi.md +184 -64
  65. data/docs/PayeeInvitationStatus.md +1 -1
  66. data/docs/PayeeInvitationStatusResponse.md +3 -3
  67. data/docs/PayeeInvitationStatusResponse2.md +21 -0
  68. data/docs/PayeePaymentChannel.md +8 -8
  69. data/docs/PayeePaymentChannel2.md +29 -0
  70. data/docs/PayeePayorRef.md +1 -1
  71. data/docs/PayeePayorRefV2.md +25 -0
  72. data/docs/PayeePayorRefV3.md +25 -0
  73. data/docs/PayeeResponse.md +9 -9
  74. data/docs/PayeeResponse2.md +10 -10
  75. data/docs/PayeeResponseV2.md +73 -0
  76. data/docs/PayeeResponseV3.md +71 -0
  77. data/docs/PayeesApi.md +316 -35
  78. data/docs/PaymentAuditServiceApi.md +4 -4
  79. data/docs/PaymentChannelCountry.md +3 -3
  80. data/docs/PaymentChannelRule.md +11 -11
  81. data/docs/PaymentDelta.md +1 -1
  82. data/docs/PaymentDeltaResponse.md +1 -1
  83. data/docs/PaymentInstruction.md +1 -1
  84. data/docs/QueryBatchResponse2.md +23 -0
  85. data/docs/ResendTokenRequest.md +1 -1
  86. data/docs/RoleUpdateRequest.md +19 -0
  87. data/docs/SubmitPayoutApi.md +2 -2
  88. data/docs/SupportedCountriesResponse2.md +1 -1
  89. data/docs/{SupportedCountryV2.md → SupportedCountry2.md} +3 -3
  90. data/docs/SupportedCurrency.md +3 -3
  91. data/docs/TokensApi.md +0 -498
  92. data/docs/UnregisterMFARequest.md +1 -1
  93. data/docs/UpdateRemoteIdRequest.md +2 -2
  94. data/docs/UserDetailsUpdateRequest.md +31 -0
  95. data/docs/UsersApi.md +108 -54
  96. data/docs/WithdrawPayoutApi.md +6 -6
  97. data/lib/velopayments.rb +38 -16
  98. data/lib/velopayments/api/countries_api.rb +6 -6
  99. data/lib/velopayments/api/currencies_api.rb +3 -3
  100. data/lib/velopayments/api/funding_manager_api.rb +22 -6
  101. data/lib/velopayments/api/{default_api.rb → funding_manager_private_api.rb} +5 -5
  102. data/lib/velopayments/api/get_payout_api.rb +8 -8
  103. data/lib/velopayments/api/instruct_payout_api.rb +10 -8
  104. data/lib/velopayments/api/login_api.rb +2 -2
  105. data/lib/velopayments/api/payee_invitation_api.rb +247 -111
  106. data/lib/velopayments/api/payees_api.rb +371 -35
  107. data/lib/velopayments/api/payment_audit_service_api.rb +6 -6
  108. data/lib/velopayments/api/payors_api.rb +2 -2
  109. data/lib/velopayments/api/payors_private_api.rb +2 -2
  110. data/lib/velopayments/api/payout_history_api.rb +2 -2
  111. data/lib/velopayments/api/quote_payout_api.rb +2 -2
  112. data/lib/velopayments/api/submit_payout_api.rb +6 -4
  113. data/lib/velopayments/api/tokens_api.rb +2 -695
  114. data/lib/velopayments/api/users_api.rb +142 -72
  115. data/lib/velopayments/api/withdraw_payout_api.rb +10 -8
  116. data/lib/velopayments/api_client.rb +2 -2
  117. data/lib/velopayments/api_error.rb +2 -2
  118. data/lib/velopayments/configuration.rb +2 -2
  119. data/lib/velopayments/models/accepted_payment.rb +13 -3
  120. data/lib/velopayments/models/access_token_response.rb +13 -3
  121. data/lib/velopayments/models/access_token_validation_request.rb +13 -3
  122. data/lib/velopayments/models/auth_response.rb +13 -3
  123. data/lib/velopayments/models/auto_top_up_config.rb +15 -3
  124. data/lib/velopayments/models/challenge.rb +13 -3
  125. data/lib/velopayments/models/company.rb +308 -0
  126. data/lib/velopayments/models/company2.rb +308 -0
  127. data/lib/velopayments/models/company_response.rb +14 -3
  128. data/lib/velopayments/models/company_v1.rb +15 -3
  129. data/lib/velopayments/models/create_funding_account_request.rb +13 -3
  130. data/lib/velopayments/models/create_individual.rb +13 -3
  131. data/lib/velopayments/models/create_individual2.rb +14 -4
  132. data/lib/velopayments/models/create_individual2_name.rb +347 -0
  133. data/lib/velopayments/models/create_payee.rb +16 -4
  134. data/lib/velopayments/models/create_payee2.rb +16 -4
  135. data/lib/velopayments/models/create_payee_address.rb +18 -3
  136. data/lib/velopayments/models/create_payee_address2.rb +18 -3
  137. data/lib/velopayments/models/create_payees_csv_request.rb +13 -3
  138. data/lib/velopayments/models/create_payees_csv_request2.rb +27 -11
  139. data/lib/velopayments/models/create_payees_csv_response.rb +14 -4
  140. data/lib/velopayments/models/create_payees_csv_response2.rb +14 -4
  141. data/lib/velopayments/models/create_payees_csv_response_rejected_csv_rows.rb +224 -0
  142. data/lib/velopayments/models/create_payees_request.rb +13 -3
  143. data/lib/velopayments/models/create_payees_request2.rb +13 -3
  144. data/lib/velopayments/models/create_payment_channel.rb +13 -3
  145. data/lib/velopayments/models/create_payment_channel2.rb +13 -3
  146. data/lib/velopayments/models/create_payor_link_request.rb +13 -3
  147. data/lib/velopayments/models/create_payout_request.rb +28 -3
  148. data/lib/velopayments/models/currency_type.rb +13 -3
  149. data/lib/velopayments/models/error.rb +15 -5
  150. data/lib/velopayments/models/error_response.rb +15 -3
  151. data/lib/velopayments/models/failed_submission.rb +14 -4
  152. data/lib/velopayments/models/{payee_payor_ref2.rb → failed_submission2.rb} +29 -28
  153. data/lib/velopayments/models/funding_account_response.rb +13 -3
  154. data/lib/velopayments/models/funding_audit.rb +13 -3
  155. data/lib/velopayments/models/funding_event.rb +13 -3
  156. data/lib/velopayments/models/funding_event_type.rb +2 -2
  157. data/lib/velopayments/models/funding_payor_status_audit_response.rb +13 -3
  158. data/lib/velopayments/models/funding_request_v1.rb +13 -3
  159. data/lib/velopayments/models/funding_request_v2.rb +13 -3
  160. data/lib/velopayments/models/fx_summary_v3.rb +13 -3
  161. data/lib/velopayments/models/fx_summary_v4.rb +13 -3
  162. data/lib/velopayments/models/get_fundings_response.rb +13 -3
  163. data/lib/velopayments/models/get_fundings_response_all_of.rb +13 -3
  164. data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +13 -3
  165. data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +13 -3
  166. data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +13 -3
  167. data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +14 -4
  168. data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +13 -3
  169. data/lib/velopayments/models/get_payout_statistics.rb +13 -3
  170. data/lib/velopayments/models/get_payouts_response_v3.rb +13 -3
  171. data/lib/velopayments/models/get_payouts_response_v3_links.rb +13 -3
  172. data/lib/velopayments/models/get_payouts_response_v3_page.rb +13 -3
  173. data/lib/velopayments/models/get_payouts_response_v4.rb +14 -4
  174. data/lib/velopayments/models/individual.rb +260 -0
  175. data/lib/velopayments/models/individual2.rb +260 -0
  176. data/lib/velopayments/models/individual_response.rb +13 -3
  177. data/lib/velopayments/models/individual_v1.rb +37 -3
  178. data/lib/velopayments/models/individual_v1_name.rb +13 -3
  179. data/lib/velopayments/models/{generate_otp_request.rb → inline_response400.rb} +38 -18
  180. data/lib/velopayments/models/{validate_otp_request.rb → inline_response400_errors.rb} +52 -46
  181. data/lib/velopayments/models/inline_response401.rb +221 -0
  182. data/lib/velopayments/models/{validate_mfa_request.rb → inline_response401_errors.rb} +52 -46
  183. data/lib/velopayments/models/inline_response403.rb +221 -0
  184. data/lib/velopayments/models/{check_token_response.rb → inline_response403_errors.rb} +44 -42
  185. data/lib/velopayments/models/invitation_status.rb +2 -2
  186. data/lib/velopayments/models/invitation_status_response.rb +13 -3
  187. data/lib/velopayments/models/invite_payee_request.rb +13 -3
  188. data/lib/velopayments/models/{register_mfa_response.rb → invite_payee_request2.rb} +28 -24
  189. data/lib/velopayments/models/invite_user_request.rb +17 -4
  190. data/lib/velopayments/models/kyc_state.rb +2 -2
  191. data/lib/velopayments/models/language.rb +2 -2
  192. data/lib/velopayments/models/{payment_status.rb → language2.rb} +16 -13
  193. data/lib/velopayments/models/link_for_response.rb +13 -3
  194. data/lib/velopayments/models/list_funding_accounts_response.rb +13 -3
  195. data/lib/velopayments/models/list_payments_response.rb +13 -3
  196. data/lib/velopayments/models/list_payments_response_page.rb +13 -3
  197. data/lib/velopayments/models/list_payments_response_v4.rb +13 -3
  198. data/lib/velopayments/models/list_source_account_response.rb +13 -3
  199. data/lib/velopayments/models/list_source_account_response_links.rb +13 -3
  200. data/lib/velopayments/models/list_source_account_response_page.rb +13 -3
  201. data/lib/velopayments/models/list_source_account_response_v2.rb +13 -3
  202. data/lib/velopayments/models/{token_type.rb → location_type.rb} +10 -9
  203. data/lib/velopayments/models/marketing_opt_in.rb +13 -3
  204. data/lib/velopayments/models/mfa_details.rb +14 -3
  205. data/lib/velopayments/models/mfa_type.rb +2 -2
  206. data/lib/velopayments/models/notifications.rb +13 -3
  207. data/lib/velopayments/models/ofac_status.rb +2 -2
  208. data/lib/velopayments/models/{mfa_status.rb → ofac_status2.rb} +8 -7
  209. data/lib/velopayments/models/onboarded_status.rb +2 -2
  210. data/lib/velopayments/models/{otp_type.rb → onboarded_status2.rb} +9 -6
  211. data/lib/velopayments/models/page_for_response.rb +13 -3
  212. data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +13 -3
  213. data/lib/velopayments/models/paged_payee_invitation_status_response.rb +14 -4
  214. data/lib/velopayments/models/paged_payee_invitation_status_response2.rb +229 -0
  215. data/lib/velopayments/models/paged_payee_invitation_status_response_page.rb +242 -0
  216. data/lib/velopayments/models/paged_payee_response.rb +13 -3
  217. data/lib/velopayments/models/paged_payee_response2.rb +13 -3
  218. data/lib/velopayments/models/paged_payee_response2_summary.rb +13 -3
  219. data/lib/velopayments/models/paged_payee_response_links.rb +13 -3
  220. data/lib/velopayments/models/paged_payee_response_page.rb +13 -3
  221. data/lib/velopayments/models/paged_payee_response_summary.rb +13 -3
  222. data/lib/velopayments/models/paged_response.rb +13 -3
  223. data/lib/velopayments/models/paged_response_page.rb +13 -3
  224. data/lib/velopayments/models/paged_user_response.rb +13 -3
  225. data/lib/velopayments/models/paged_user_response_links.rb +13 -3
  226. data/lib/velopayments/models/paged_user_response_page.rb +13 -3
  227. data/lib/velopayments/models/password_request.rb +13 -3
  228. data/lib/velopayments/models/payee.rb +19 -3
  229. data/lib/velopayments/models/payee2.rb +456 -0
  230. data/lib/velopayments/models/payee_address.rb +18 -3
  231. data/lib/velopayments/models/payee_address2.rb +493 -0
  232. data/lib/velopayments/models/payee_delta.rb +14 -3
  233. data/lib/velopayments/models/payee_delta2.rb +299 -0
  234. data/lib/velopayments/models/payee_delta_response.rb +13 -3
  235. data/lib/velopayments/models/payee_delta_response2.rb +229 -0
  236. data/lib/velopayments/models/{register_mfa_request.rb → payee_delta_response2_links.rb} +32 -18
  237. data/lib/velopayments/models/payee_delta_response_links.rb +13 -3
  238. data/lib/velopayments/models/payee_delta_response_page.rb +13 -3
  239. data/lib/velopayments/models/payee_invitation_status.rb +13 -3
  240. data/lib/velopayments/models/payee_invitation_status_response.rb +48 -4
  241. data/lib/velopayments/models/payee_invitation_status_response2.rb +268 -0
  242. data/lib/velopayments/models/payee_payment_channel.rb +60 -39
  243. data/lib/velopayments/models/payee_payment_channel2.rb +451 -0
  244. data/lib/velopayments/models/payee_payor_ref.rb +13 -3
  245. data/lib/velopayments/models/payee_payor_ref_v2.rb +278 -0
  246. data/lib/velopayments/models/payee_payor_ref_v3.rb +278 -0
  247. data/lib/velopayments/models/payee_response.rb +19 -3
  248. data/lib/velopayments/models/payee_response2.rb +20 -4
  249. data/lib/velopayments/models/payee_response_v2.rb +471 -0
  250. data/lib/velopayments/models/payee_response_v3.rb +462 -0
  251. data/lib/velopayments/models/payee_type.rb +2 -2
  252. data/lib/velopayments/models/payment_audit_currency_v3.rb +2 -2
  253. data/lib/velopayments/models/payment_audit_currency_v4.rb +2 -2
  254. data/lib/velopayments/models/payment_channel_country.rb +25 -3
  255. data/lib/velopayments/models/payment_channel_rule.rb +40 -3
  256. data/lib/velopayments/models/payment_channel_rules_response.rb +13 -3
  257. data/lib/velopayments/models/payment_delta.rb +20 -4
  258. data/lib/velopayments/models/payment_delta_response.rb +14 -4
  259. data/lib/velopayments/models/payment_event_response_v3.rb +13 -3
  260. data/lib/velopayments/models/payment_event_response_v4.rb +13 -3
  261. data/lib/velopayments/models/payment_instruction.rb +14 -47
  262. data/lib/velopayments/models/payment_rails.rb +2 -2
  263. data/lib/velopayments/models/payment_response_v3.rb +13 -3
  264. data/lib/velopayments/models/payment_response_v4.rb +13 -3
  265. data/lib/velopayments/models/payment_response_v4_payout.rb +13 -3
  266. data/lib/velopayments/models/payor_address.rb +18 -3
  267. data/lib/velopayments/models/payor_address_v2.rb +18 -3
  268. data/lib/velopayments/models/payor_aml_transaction_v3.rb +13 -3
  269. data/lib/velopayments/models/payor_aml_transaction_v4.rb +13 -3
  270. data/lib/velopayments/models/payor_branding_response.rb +16 -3
  271. data/lib/velopayments/models/payor_create_api_key_request.rb +14 -3
  272. data/lib/velopayments/models/payor_create_api_key_response.rb +13 -3
  273. data/lib/velopayments/models/payor_create_application_request.rb +14 -3
  274. data/lib/velopayments/models/payor_email_opt_out_request.rb +13 -3
  275. data/lib/velopayments/models/payor_links_response.rb +13 -3
  276. data/lib/velopayments/models/payor_links_response_links.rb +13 -3
  277. data/lib/velopayments/models/payor_links_response_payors.rb +13 -3
  278. data/lib/velopayments/models/payor_logo_request.rb +13 -3
  279. data/lib/velopayments/models/payor_v1.rb +13 -3
  280. data/lib/velopayments/models/payor_v2.rb +13 -3
  281. data/lib/velopayments/models/payout_payor_v4.rb +13 -3
  282. data/lib/velopayments/models/payout_principal_v4.rb +13 -3
  283. data/lib/velopayments/models/payout_status_v3.rb +2 -2
  284. data/lib/velopayments/models/payout_status_v4.rb +2 -2
  285. data/lib/velopayments/models/payout_summary_audit_v3.rb +13 -3
  286. data/lib/velopayments/models/payout_summary_audit_v4.rb +13 -3
  287. data/lib/velopayments/models/payout_summary_response.rb +13 -3
  288. data/lib/velopayments/models/payout_type_v4.rb +2 -2
  289. data/lib/velopayments/models/query_batch_response.rb +13 -3
  290. data/lib/velopayments/models/query_batch_response2.rb +270 -0
  291. data/lib/velopayments/models/quote_fx_summary.rb +13 -3
  292. data/lib/velopayments/models/quote_response.rb +13 -3
  293. data/lib/velopayments/models/region.rb +13 -3
  294. data/lib/velopayments/models/register_sms_request.rb +13 -3
  295. data/lib/velopayments/models/rejected_payment.rb +13 -3
  296. data/lib/velopayments/models/resend_token_request.rb +15 -4
  297. data/lib/velopayments/models/reset_password_request.rb +13 -3
  298. data/lib/velopayments/models/role.rb +13 -3
  299. data/lib/velopayments/models/{email_update_request.rb → role_update_request.rb} +31 -18
  300. data/lib/velopayments/models/self_mfa_type_unregister_request.rb +13 -3
  301. data/lib/velopayments/models/self_update_password_request.rb +13 -3
  302. data/lib/velopayments/models/set_notifications_request.rb +13 -3
  303. data/lib/velopayments/models/source_account.rb +13 -3
  304. data/lib/velopayments/models/source_account_response.rb +15 -3
  305. data/lib/velopayments/models/source_account_response_v2.rb +15 -3
  306. data/lib/velopayments/models/source_account_summary_v3.rb +13 -3
  307. data/lib/velopayments/models/source_account_summary_v4.rb +13 -3
  308. data/lib/velopayments/models/supported_countries_response.rb +13 -3
  309. data/lib/velopayments/models/supported_countries_response2.rb +14 -4
  310. data/lib/velopayments/models/supported_country.rb +13 -3
  311. data/lib/velopayments/models/{supported_country_v2.rb → supported_country2.rb} +20 -8
  312. data/lib/velopayments/models/supported_currency.rb +14 -3
  313. data/lib/velopayments/models/supported_currency_response.rb +13 -3
  314. data/lib/velopayments/models/transfer_request.rb +13 -3
  315. data/lib/velopayments/models/unregister_mfa_request.rb +17 -6
  316. data/lib/velopayments/models/update_remote_id_request.rb +13 -3
  317. data/lib/velopayments/models/user_details_update_request.rb +406 -0
  318. data/lib/velopayments/models/user_info.rb +13 -3
  319. data/lib/velopayments/models/user_response.rb +14 -3
  320. data/lib/velopayments/models/user_response2.rb +14 -3
  321. data/lib/velopayments/models/user_response2_roles.rb +13 -3
  322. data/lib/velopayments/models/user_status.rb +2 -2
  323. data/lib/velopayments/models/user_type.rb +2 -2
  324. data/lib/velopayments/models/user_type2.rb +2 -2
  325. data/lib/velopayments/models/validate_password_response.rb +13 -3
  326. data/lib/velopayments/models/watchlist_status.rb +2 -2
  327. data/lib/velopayments/version.rb +3 -3
  328. data/oa3-config.json +1 -1
  329. data/spec/api/countries_api_spec.rb +3 -3
  330. data/spec/api/currencies_api_spec.rb +2 -2
  331. data/spec/api/funding_manager_api_spec.rb +6 -4
  332. data/spec/api/{default_api_spec.rb → funding_manager_private_api_spec.rb} +8 -8
  333. data/spec/api/get_payout_api_spec.rb +4 -4
  334. data/spec/api/instruct_payout_api_spec.rb +4 -4
  335. data/spec/api/login_api_spec.rb +2 -2
  336. data/spec/api/payee_invitation_api_spec.rb +62 -33
  337. data/spec/api/payees_api_spec.rb +81 -15
  338. data/spec/api/payment_audit_service_api_spec.rb +4 -4
  339. data/spec/api/payors_api_spec.rb +2 -2
  340. data/spec/api/payors_private_api_spec.rb +2 -2
  341. data/spec/api/payout_history_api_spec.rb +2 -2
  342. data/spec/api/quote_payout_api_spec.rb +2 -2
  343. data/spec/api/submit_payout_api_spec.rb +3 -3
  344. data/spec/api/tokens_api_spec.rb +2 -131
  345. data/spec/api/users_api_spec.rb +28 -15
  346. data/spec/api/withdraw_payout_api_spec.rb +4 -4
  347. data/spec/api_client_spec.rb +2 -2
  348. data/spec/configuration_spec.rb +2 -2
  349. data/spec/models/accepted_payment_spec.rb +2 -2
  350. data/spec/models/access_token_response_spec.rb +2 -2
  351. data/spec/models/access_token_validation_request_spec.rb +2 -2
  352. data/spec/models/auth_response_spec.rb +2 -2
  353. data/spec/models/auto_top_up_config_spec.rb +2 -2
  354. data/spec/models/challenge_spec.rb +2 -2
  355. data/spec/models/{payee_payor_ref2_spec.rb → company2_spec.rb} +11 -11
  356. data/spec/models/company_response_spec.rb +2 -2
  357. data/spec/models/company_spec.rb +53 -0
  358. data/spec/models/company_v1_spec.rb +2 -2
  359. data/spec/models/create_funding_account_request_spec.rb +2 -2
  360. data/spec/models/create_individual2_name_spec.rb +59 -0
  361. data/spec/models/create_individual2_spec.rb +2 -2
  362. data/spec/models/create_individual_spec.rb +2 -2
  363. data/spec/models/create_payee2_spec.rb +2 -2
  364. data/spec/models/create_payee_address2_spec.rb +2 -2
  365. data/spec/models/create_payee_address_spec.rb +2 -2
  366. data/spec/models/create_payee_spec.rb +2 -2
  367. data/spec/models/create_payees_csv_request2_spec.rb +2 -2
  368. data/spec/models/create_payees_csv_request_spec.rb +2 -2
  369. data/spec/models/create_payees_csv_response2_spec.rb +2 -2
  370. data/spec/models/create_payees_csv_response_rejected_csv_rows_spec.rb +53 -0
  371. data/spec/models/create_payees_csv_response_spec.rb +2 -2
  372. data/spec/models/create_payees_request2_spec.rb +2 -2
  373. data/spec/models/create_payees_request_spec.rb +2 -2
  374. data/spec/models/create_payment_channel2_spec.rb +2 -2
  375. data/spec/models/create_payment_channel_spec.rb +2 -2
  376. data/spec/models/create_payor_link_request_spec.rb +2 -2
  377. data/spec/models/create_payout_request_spec.rb +2 -2
  378. data/spec/models/currency_type_spec.rb +2 -2
  379. data/spec/models/error_response_spec.rb +2 -2
  380. data/spec/models/error_spec.rb +3 -3
  381. data/spec/models/{register_mfa_response_spec.rb → failed_submission2_spec.rb} +10 -10
  382. data/spec/models/failed_submission_spec.rb +2 -2
  383. data/spec/models/funding_account_response_spec.rb +2 -2
  384. data/spec/models/funding_audit_spec.rb +2 -2
  385. data/spec/models/funding_event_spec.rb +2 -2
  386. data/spec/models/funding_event_type_spec.rb +2 -2
  387. data/spec/models/funding_payor_status_audit_response_spec.rb +2 -2
  388. data/spec/models/funding_request_v1_spec.rb +2 -2
  389. data/spec/models/funding_request_v2_spec.rb +2 -2
  390. data/spec/models/fx_summary_v3_spec.rb +2 -2
  391. data/spec/models/fx_summary_v4_spec.rb +2 -2
  392. data/spec/models/get_fundings_response_all_of_spec.rb +2 -2
  393. data/spec/models/get_fundings_response_spec.rb +2 -2
  394. data/spec/models/get_payments_for_payout_response_v3_page_spec.rb +2 -2
  395. data/spec/models/get_payments_for_payout_response_v3_spec.rb +2 -2
  396. data/spec/models/get_payments_for_payout_response_v3_summary_spec.rb +2 -2
  397. data/spec/models/get_payments_for_payout_response_v4_spec.rb +2 -2
  398. data/spec/models/get_payments_for_payout_response_v4_summary_spec.rb +2 -2
  399. data/spec/models/get_payout_statistics_spec.rb +2 -2
  400. data/spec/models/get_payouts_response_v3_links_spec.rb +2 -2
  401. data/spec/models/get_payouts_response_v3_page_spec.rb +2 -2
  402. data/spec/models/get_payouts_response_v3_spec.rb +2 -2
  403. data/spec/models/get_payouts_response_v4_spec.rb +2 -2
  404. data/spec/models/individual2_spec.rb +53 -0
  405. data/spec/models/individual_response_spec.rb +2 -2
  406. data/spec/models/individual_spec.rb +53 -0
  407. data/spec/models/individual_v1_name_spec.rb +2 -2
  408. data/spec/models/individual_v1_spec.rb +2 -2
  409. data/spec/models/inline_response400_errors_spec.rb +59 -0
  410. data/spec/models/{generate_otp_request_spec.rb → inline_response400_spec.rb} +15 -9
  411. data/spec/models/inline_response401_errors_spec.rb +59 -0
  412. data/spec/models/inline_response401_spec.rb +47 -0
  413. data/spec/models/inline_response403_errors_spec.rb +59 -0
  414. data/spec/models/inline_response403_spec.rb +47 -0
  415. data/spec/models/invitation_status_response_spec.rb +2 -2
  416. data/spec/models/invitation_status_spec.rb +2 -2
  417. data/spec/models/{register_mfa_request_spec.rb → invite_payee_request2_spec.rb} +9 -9
  418. data/spec/models/invite_payee_request_spec.rb +2 -2
  419. data/spec/models/invite_user_request_spec.rb +2 -2
  420. data/spec/models/kyc_state_spec.rb +2 -2
  421. data/spec/models/{otp_type_spec.rb → language2_spec.rb} +8 -8
  422. data/spec/models/language_spec.rb +2 -2
  423. data/spec/models/link_for_response_spec.rb +2 -2
  424. data/spec/models/list_funding_accounts_response_spec.rb +2 -2
  425. data/spec/models/list_payments_response_page_spec.rb +2 -2
  426. data/spec/models/list_payments_response_spec.rb +2 -2
  427. data/spec/models/list_payments_response_v4_spec.rb +2 -2
  428. data/spec/models/list_source_account_response_links_spec.rb +2 -2
  429. data/spec/models/list_source_account_response_page_spec.rb +2 -2
  430. data/spec/models/list_source_account_response_spec.rb +2 -2
  431. data/spec/models/list_source_account_response_v2_spec.rb +2 -2
  432. data/spec/models/{token_type_spec.rb → location_type_spec.rb} +8 -8
  433. data/spec/models/marketing_opt_in_spec.rb +2 -2
  434. data/spec/models/mfa_details_spec.rb +2 -2
  435. data/spec/models/mfa_type_spec.rb +2 -2
  436. data/spec/models/notifications_spec.rb +2 -2
  437. data/spec/models/{mfa_status_spec.rb → ofac_status2_spec.rb} +8 -8
  438. data/spec/models/ofac_status_spec.rb +2 -2
  439. data/spec/models/{payment_status_spec.rb → onboarded_status2_spec.rb} +8 -8
  440. data/spec/models/onboarded_status_spec.rb +2 -2
  441. data/spec/models/page_for_response_spec.rb +2 -2
  442. data/spec/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response_spec.rb +2 -2
  443. data/spec/models/paged_payee_invitation_status_response2_spec.rb +53 -0
  444. data/spec/models/{check_token_response_spec.rb → paged_payee_invitation_status_response_page_spec.rb} +13 -13
  445. data/spec/models/paged_payee_invitation_status_response_spec.rb +2 -2
  446. data/spec/models/paged_payee_response2_spec.rb +2 -2
  447. data/spec/models/paged_payee_response2_summary_spec.rb +2 -2
  448. data/spec/models/paged_payee_response_links_spec.rb +2 -2
  449. data/spec/models/paged_payee_response_page_spec.rb +2 -2
  450. data/spec/models/paged_payee_response_spec.rb +2 -2
  451. data/spec/models/paged_payee_response_summary_spec.rb +2 -2
  452. data/spec/models/paged_response_page_spec.rb +2 -2
  453. data/spec/models/paged_response_spec.rb +2 -2
  454. data/spec/models/paged_user_response_links_spec.rb +2 -2
  455. data/spec/models/paged_user_response_page_spec.rb +2 -2
  456. data/spec/models/paged_user_response_spec.rb +2 -2
  457. data/spec/models/password_request_spec.rb +2 -2
  458. data/spec/models/payee2_spec.rb +165 -0
  459. data/spec/models/payee_address2_spec.rb +83 -0
  460. data/spec/models/payee_address_spec.rb +2 -2
  461. data/spec/models/payee_delta2_spec.rb +77 -0
  462. data/spec/models/payee_delta_response2_links_spec.rb +47 -0
  463. data/spec/models/payee_delta_response2_spec.rb +53 -0
  464. data/spec/models/payee_delta_response_links_spec.rb +2 -2
  465. data/spec/models/payee_delta_response_page_spec.rb +2 -2
  466. data/spec/models/payee_delta_response_spec.rb +2 -2
  467. data/spec/models/payee_delta_spec.rb +2 -2
  468. data/spec/models/payee_invitation_status_response2_spec.rb +57 -0
  469. data/spec/models/payee_invitation_status_response_spec.rb +6 -2
  470. data/spec/models/payee_invitation_status_spec.rb +2 -2
  471. data/spec/models/payee_payment_channel2_spec.rb +81 -0
  472. data/spec/models/payee_payment_channel_spec.rb +3 -3
  473. data/spec/models/payee_payor_ref_spec.rb +2 -2
  474. data/spec/models/payee_payor_ref_v2_spec.rb +69 -0
  475. data/spec/models/payee_payor_ref_v3_spec.rb +69 -0
  476. data/spec/models/payee_response2_spec.rb +2 -2
  477. data/spec/models/payee_response_spec.rb +2 -2
  478. data/spec/models/payee_response_v2_spec.rb +209 -0
  479. data/spec/models/payee_response_v3_spec.rb +203 -0
  480. data/spec/models/payee_spec.rb +2 -2
  481. data/spec/models/payee_type_spec.rb +2 -2
  482. data/spec/models/payment_audit_currency_v3_spec.rb +2 -2
  483. data/spec/models/payment_audit_currency_v4_spec.rb +2 -2
  484. data/spec/models/payment_channel_country_spec.rb +2 -2
  485. data/spec/models/payment_channel_rule_spec.rb +2 -2
  486. data/spec/models/payment_channel_rules_response_spec.rb +2 -2
  487. data/spec/models/payment_delta_response_spec.rb +2 -2
  488. data/spec/models/payment_delta_spec.rb +2 -2
  489. data/spec/models/payment_event_response_v3_spec.rb +2 -2
  490. data/spec/models/payment_event_response_v4_spec.rb +2 -2
  491. data/spec/models/payment_instruction_spec.rb +2 -6
  492. data/spec/models/payment_rails_spec.rb +2 -2
  493. data/spec/models/payment_response_v3_spec.rb +2 -2
  494. data/spec/models/payment_response_v4_payout_spec.rb +2 -2
  495. data/spec/models/payment_response_v4_spec.rb +2 -2
  496. data/spec/models/payor_address_spec.rb +2 -2
  497. data/spec/models/payor_address_v2_spec.rb +2 -2
  498. data/spec/models/payor_aml_transaction_v3_spec.rb +2 -2
  499. data/spec/models/payor_aml_transaction_v4_spec.rb +2 -2
  500. data/spec/models/payor_branding_response_spec.rb +2 -2
  501. data/spec/models/payor_create_api_key_request_spec.rb +2 -2
  502. data/spec/models/payor_create_api_key_response_spec.rb +2 -2
  503. data/spec/models/payor_create_application_request_spec.rb +2 -2
  504. data/spec/models/payor_email_opt_out_request_spec.rb +2 -2
  505. data/spec/models/payor_links_response_links_spec.rb +2 -2
  506. data/spec/models/payor_links_response_payors_spec.rb +2 -2
  507. data/spec/models/payor_links_response_spec.rb +2 -2
  508. data/spec/models/payor_logo_request_spec.rb +2 -2
  509. data/spec/models/payor_v1_spec.rb +2 -2
  510. data/spec/models/payor_v2_spec.rb +2 -2
  511. data/spec/models/payout_payor_v4_spec.rb +2 -2
  512. data/spec/models/payout_principal_v4_spec.rb +2 -2
  513. data/spec/models/payout_status_v3_spec.rb +2 -2
  514. data/spec/models/payout_status_v4_spec.rb +2 -2
  515. data/spec/models/payout_summary_audit_v3_spec.rb +2 -2
  516. data/spec/models/payout_summary_audit_v4_spec.rb +2 -2
  517. data/spec/models/payout_summary_response_spec.rb +2 -2
  518. data/spec/models/payout_type_v4_spec.rb +2 -2
  519. data/spec/models/query_batch_response2_spec.rb +63 -0
  520. data/spec/models/query_batch_response_spec.rb +2 -2
  521. data/spec/models/quote_fx_summary_spec.rb +2 -2
  522. data/spec/models/quote_response_spec.rb +2 -2
  523. data/spec/models/region_spec.rb +2 -2
  524. data/spec/models/register_sms_request_spec.rb +2 -2
  525. data/spec/models/rejected_payment_spec.rb +2 -2
  526. data/spec/models/resend_token_request_spec.rb +2 -2
  527. data/spec/models/reset_password_request_spec.rb +2 -2
  528. data/spec/models/role_spec.rb +2 -2
  529. data/spec/models/{email_update_request_spec.rb → role_update_request_spec.rb} +9 -9
  530. data/spec/models/self_mfa_type_unregister_request_spec.rb +2 -2
  531. data/spec/models/self_update_password_request_spec.rb +2 -2
  532. data/spec/models/set_notifications_request_spec.rb +2 -2
  533. data/spec/models/source_account_response_spec.rb +2 -2
  534. data/spec/models/source_account_response_v2_spec.rb +2 -2
  535. data/spec/models/source_account_spec.rb +2 -2
  536. data/spec/models/source_account_summary_v3_spec.rb +2 -2
  537. data/spec/models/source_account_summary_v4_spec.rb +2 -2
  538. data/spec/models/supported_countries_response2_spec.rb +2 -2
  539. data/spec/models/supported_countries_response_spec.rb +2 -2
  540. data/spec/models/{supported_country_v2_spec.rb → supported_country2_spec.rb} +8 -8
  541. data/spec/models/supported_country_spec.rb +2 -2
  542. data/spec/models/supported_currency_response_spec.rb +2 -2
  543. data/spec/models/supported_currency_spec.rb +2 -2
  544. data/spec/models/transfer_request_spec.rb +2 -2
  545. data/spec/models/unregister_mfa_request_spec.rb +3 -3
  546. data/spec/models/update_remote_id_request_spec.rb +2 -2
  547. data/spec/models/user_details_update_request_spec.rb +83 -0
  548. data/spec/models/user_info_spec.rb +2 -2
  549. data/spec/models/user_response2_roles_spec.rb +2 -2
  550. data/spec/models/user_response2_spec.rb +2 -2
  551. data/spec/models/user_response_spec.rb +2 -2
  552. data/spec/models/user_status_spec.rb +2 -2
  553. data/spec/models/user_type2_spec.rb +2 -2
  554. data/spec/models/user_type_spec.rb +2 -2
  555. data/spec/models/validate_password_response_spec.rb +2 -2
  556. data/spec/models/watchlist_status_spec.rb +2 -2
  557. data/spec/spec_helper.rb +2 -2
  558. data/velopayments.gemspec +2 -2
  559. metadata +310 -222
  560. data/docs/CheckTokenResponse.md +0 -25
  561. data/docs/EmailUpdateRequest.md +0 -19
  562. data/docs/PayeePayorRef2.md +0 -21
  563. data/docs/RegisterMFARequest.md +0 -17
  564. data/docs/RegisterMFAResponse.md +0 -19
  565. data/docs/ValidateMFARequest.md +0 -17
  566. data/docs/ValidateOTPRequest.md +0 -17
  567. data/spec/models/validate_mfa_request_spec.rb +0 -41
  568. data/spec/models/validate_otp_request_spec.rb +0 -41
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **page** | [**PagedPayeeResponsePage**](PagedPayeeResponsePage.md) | | [optional]
7
+ **page** | [**PagedPayeeInvitationStatusResponsePage**](PagedPayeeInvitationStatusResponsePage.md) | | [optional]
8
8
  **links** | [**Array<PagedPayeeResponseLinks>**](PagedPayeeResponseLinks.md) | | [optional]
9
9
  **content** | [**Array<PayeeInvitationStatusResponse>**](PayeeInvitationStatusResponse.md) | | [optional]
10
10
 
@@ -0,0 +1,21 @@
1
+ # VeloPayments::PagedPayeeInvitationStatusResponse2
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **page** | [**PagedPayeeInvitationStatusResponsePage**](PagedPayeeInvitationStatusResponsePage.md) | | [optional]
8
+ **links** | [**Array<PagedPayeeResponseLinks>**](PagedPayeeResponseLinks.md) | | [optional]
9
+ **content** | [**Array<PayeeInvitationStatusResponse2>**](PayeeInvitationStatusResponse2.md) | | [optional]
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'VeloPayments'
15
+
16
+ instance = VeloPayments::PagedPayeeInvitationStatusResponse2.new(page: null,
17
+ links: null,
18
+ content: null)
19
+ ```
20
+
21
+
@@ -0,0 +1,25 @@
1
+ # VeloPayments::PagedPayeeInvitationStatusResponsePage
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **number_of_elements** | **Integer** | | [optional]
8
+ **total_elements** | **Integer** | | [optional]
9
+ **total_pages** | **Integer** | | [optional]
10
+ **page** | **Integer** | | [optional]
11
+ **page_size** | **Integer** | | [optional]
12
+
13
+ ## Code Sample
14
+
15
+ ```ruby
16
+ require 'VeloPayments'
17
+
18
+ instance = VeloPayments::PagedPayeeInvitationStatusResponsePage.new(number_of_elements: null,
19
+ total_elements: null,
20
+ total_pages: null,
21
+ page: null,
22
+ page_size: null)
23
+ ```
24
+
25
+
@@ -15,11 +15,11 @@ Name | Type | Description | Notes
15
15
  ```ruby
16
16
  require 'VeloPayments'
17
17
 
18
- instance = VeloPayments::PagedPayeeResponse2Summary.new(total_payees_count: null,
19
- total_invited_count: null,
20
- total_registered_count: null,
21
- total_onboarded_count: null,
22
- total_watchlist_failed_count: null)
18
+ instance = VeloPayments::PagedPayeeResponse2Summary.new(total_payees_count: 10,
19
+ total_invited_count: 10,
20
+ total_registered_count: 10,
21
+ total_onboarded_count: 10,
22
+ total_watchlist_failed_count: 0)
23
23
  ```
24
24
 
25
25
 
@@ -15,11 +15,11 @@ Name | Type | Description | Notes
15
15
  ```ruby
16
16
  require 'VeloPayments'
17
17
 
18
- instance = VeloPayments::PagedPayeeResponsePage.new(number_of_elements: null,
19
- total_elements: null,
20
- total_pages: null,
21
- page: null,
22
- page_size: null)
18
+ instance = VeloPayments::PagedPayeeResponsePage.new(number_of_elements: 10,
19
+ total_elements: 10,
20
+ total_pages: 10,
21
+ page: 10,
22
+ page_size: 10)
23
23
  ```
24
24
 
25
25
 
@@ -15,11 +15,11 @@ Name | Type | Description | Notes
15
15
  ```ruby
16
16
  require 'VeloPayments'
17
17
 
18
- instance = VeloPayments::PagedPayeeResponseSummary.new(total_payees_count: null,
19
- total_invited_count: null,
20
- total_registered_count: null,
21
- total_onboarded_count: null,
22
- total_ofac_failed_count: null)
18
+ instance = VeloPayments::PagedPayeeResponseSummary.new(total_payees_count: 10,
19
+ total_invited_count: 10,
20
+ total_registered_count: 10,
21
+ total_onboarded_count: 10,
22
+ total_ofac_failed_count: 0)
23
23
  ```
24
24
 
25
25
 
data/docs/Payee.md CHANGED
@@ -30,23 +30,23 @@ Name | Type | Description | Notes
30
30
  ```ruby
31
31
  require 'VeloPayments'
32
32
 
33
- instance = VeloPayments::Payee.new(payee_id: null,
33
+ instance = VeloPayments::Payee.new(payee_id: 2aa5d7e0-2ecb-403f-8494-1865ed0454e9,
34
34
  payor_refs: null,
35
- email: null,
35
+ email: bob@example.com,
36
36
  address: null,
37
- country: null,
38
- display_name: null,
37
+ country: US,
38
+ display_name: Bob,
39
39
  payment_channel: null,
40
40
  challenge: null,
41
41
  language: null,
42
- accept_terms_and_conditions_timestamp: null,
43
- cellphone_number: null,
42
+ accept_terms_and_conditions_timestamp: 2019-01-20T09:00Z,
43
+ cellphone_number: 1234567890,
44
44
  payee_type: null,
45
45
  company: null,
46
46
  individual: null,
47
- created: null,
48
- grace_period_end_date: null,
49
- last_ofac_check_timestamp: null,
47
+ created: 2019-01-20T09:00Z,
48
+ grace_period_end_date: Sun Jan 20 00:00:00 GMT 2019,
49
+ last_ofac_check_timestamp: 2019-01-20T09:00:00+00:00,
50
50
  marketing_opt_ins: null,
51
51
  ofac_status: null,
52
52
  onboarded_status: null)
data/docs/Payee2.md ADDED
@@ -0,0 +1,57 @@
1
+ # VeloPayments::Payee2
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **type** | **String** | | [optional]
8
+ **payee_id** | **String** | | [optional] [readonly]
9
+ **payor_refs** | [**Array<PayeePayorRefV2>**](PayeePayorRefV2.md) | | [optional] [readonly]
10
+ **email** | **String** | | [optional]
11
+ **address** | [**PayeeAddress**](PayeeAddress.md) | | [optional]
12
+ **country** | **String** | | [optional]
13
+ **display_name** | **String** | | [optional]
14
+ **payment_channel** | [**PayeePaymentChannel2**](PayeePaymentChannel2.md) | | [optional]
15
+ **challenge** | [**Challenge**](Challenge.md) | | [optional]
16
+ **language** | [**Language2**](Language2.md) | | [optional]
17
+ **accept_terms_and_conditions_timestamp** | **DateTime** | The timestamp when the payee last accepted T&Cs | [optional] [readonly]
18
+ **cellphone_number** | **String** | | [optional]
19
+ **payee_type** | [**PayeeType**](PayeeType.md) | | [optional]
20
+ **company** | [**CompanyV1**](CompanyV1.md) | | [optional]
21
+ **individual** | [**IndividualV1**](IndividualV1.md) | | [optional]
22
+ **created** | **DateTime** | | [optional]
23
+ **grace_period_end_date** | **Date** | | [optional] [readonly]
24
+ **watchlist_status_updated_timestamp** | **String** | | [optional] [readonly]
25
+ **marketing_opt_ins** | [**Array<MarketingOptIn>**](MarketingOptIn.md) | | [optional]
26
+ **onboarded_status** | [**OnboardedStatus**](OnboardedStatus.md) | | [optional]
27
+ **remote_id** | **String** | Remote Id must be between 1 and 100 characters long | [optional]
28
+
29
+ ## Code Sample
30
+
31
+ ```ruby
32
+ require 'VeloPayments'
33
+
34
+ instance = VeloPayments::Payee2.new(type: null,
35
+ payee_id: 2aa5d7e0-2ecb-403f-8494-1865ed0454e9,
36
+ payor_refs: null,
37
+ email: bob@example.com,
38
+ address: null,
39
+ country: US,
40
+ display_name: Bob,
41
+ payment_channel: null,
42
+ challenge: null,
43
+ language: null,
44
+ accept_terms_and_conditions_timestamp: 2019-01-20T09:00Z,
45
+ cellphone_number: 1234567890,
46
+ payee_type: null,
47
+ company: null,
48
+ individual: null,
49
+ created: 2019-01-20T09:00Z,
50
+ grace_period_end_date: Sun Jan 20 00:00:00 GMT 2019,
51
+ watchlist_status_updated_timestamp: 2019-01-20T09:00:00+00:00,
52
+ marketing_opt_ins: null,
53
+ onboarded_status: null,
54
+ remote_id: remoteId123)
55
+ ```
56
+
57
+
@@ -0,0 +1,31 @@
1
+ # VeloPayments::PayeeAddress2
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **line1** | **String** | |
8
+ **line2** | **String** | | [optional]
9
+ **line3** | **String** | | [optional]
10
+ **line4** | **String** | | [optional]
11
+ **city** | **String** | |
12
+ **county_or_province** | **String** | | [optional]
13
+ **zip_or_postcode** | **String** | | [optional]
14
+ **country** | **String** | |
15
+
16
+ ## Code Sample
17
+
18
+ ```ruby
19
+ require 'VeloPayments'
20
+
21
+ instance = VeloPayments::PayeeAddress2.new(line1: 500 Duval St,
22
+ line2: null,
23
+ line3: null,
24
+ line4: null,
25
+ city: Key West,
26
+ county_or_province: FL,
27
+ zip_or_postcode: 33945,
28
+ country: US)
29
+ ```
30
+
31
+
data/docs/PayeeDelta.md CHANGED
@@ -18,7 +18,7 @@ Name | Type | Description | Notes
18
18
  require 'VeloPayments'
19
19
 
20
20
  instance = VeloPayments::PayeeDelta.new(remote_id: payee_1,
21
- payee_id: null,
21
+ payee_id: 2aa5d7e0-2ecb-403f-8494-1865ed0454e9,
22
22
  display_name: Payee1,
23
23
  dba_name: Payee DBA Name,
24
24
  email: payee1@example.com,
@@ -0,0 +1,29 @@
1
+ # VeloPayments::PayeeDelta2
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **remote_id** | **String** | |
8
+ **payee_id** | **String** | | [readonly]
9
+ **display_name** | **String** | | [optional]
10
+ **dba_name** | **String** | | [optional]
11
+ **email** | **String** | | [optional]
12
+ **payee_country** | **String** | | [optional]
13
+ **onboarded_status** | [**OnboardedStatus2**](OnboardedStatus2.md) | | [optional]
14
+
15
+ ## Code Sample
16
+
17
+ ```ruby
18
+ require 'VeloPayments'
19
+
20
+ instance = VeloPayments::PayeeDelta2.new(remote_id: payee_1,
21
+ payee_id: null,
22
+ display_name: Payee1,
23
+ dba_name: Payee DBA Name,
24
+ email: payee1@example.com,
25
+ payee_country: US,
26
+ onboarded_status: null)
27
+ ```
28
+
29
+
@@ -0,0 +1,21 @@
1
+ # VeloPayments::PayeeDeltaResponse2
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **page** | [**PayeeDeltaResponsePage**](PayeeDeltaResponsePage.md) | | [optional]
8
+ **links** | [**Array<PayeeDeltaResponse2Links>**](PayeeDeltaResponse2Links.md) | | [optional]
9
+ **content** | [**Array<PayeeDelta2>**](PayeeDelta2.md) | | [optional]
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'VeloPayments'
15
+
16
+ instance = VeloPayments::PayeeDeltaResponse2.new(page: null,
17
+ links: null,
18
+ content: null)
19
+ ```
20
+
21
+
@@ -0,0 +1,19 @@
1
+ # VeloPayments::PayeeDeltaResponse2Links
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **rel** | **String** | | [optional]
8
+ **href** | **String** | | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'VeloPayments'
14
+
15
+ instance = VeloPayments::PayeeDeltaResponse2Links.new(rel: first,
16
+ href: http://api.sandbox.velopayments.com/v3/payees/deltas?payorId=0a818933-087d-47f2-ad83-2f986ed087eb&updatedSince=2019-01-20T09:00:00+00:00&page=1&pageSize=1000)
17
+ ```
18
+
19
+
@@ -4,23 +4,25 @@ All URIs are relative to *https://api.sandbox.velopayments.com*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**get_payees_invitation_status**](PayeeInvitationApi.md#get_payees_invitation_status) | **GET** /v1/payees/payors/{payorId}/invitationStatus | Get Payee Invitation Status
7
+ [**get_payees_invitation_status_v1**](PayeeInvitationApi.md#get_payees_invitation_status_v1) | **GET** /v1/payees/payors/{payorId}/invitationStatus | Get Payee Invitation Status
8
8
  [**get_payees_invitation_status_v2**](PayeeInvitationApi.md#get_payees_invitation_status_v2) | **GET** /v2/payees/payors/{payorId}/invitationStatus | Get Payee Invitation Status
9
- [**resend_payee_invite**](PayeeInvitationApi.md#resend_payee_invite) | **POST** /v1/payees/{payeeId}/invite | Resend Payee Invite
10
- [**v2_create_payee**](PayeeInvitationApi.md#v2_create_payee) | **POST** /v2/payees | Intiate Payee Creation V2
11
- [**v2_query_batch_status**](PayeeInvitationApi.md#v2_query_batch_status) | **GET** /v2/payees/batch/{batchId} | Query Batch Status
12
- [**v3_create_payee**](PayeeInvitationApi.md#v3_create_payee) | **POST** /v3/payees | Intiate Payee Creation V3
13
- [**v3_query_batch_status**](PayeeInvitationApi.md#v3_query_batch_status) | **GET** /v3/payees/batch/{batchId} | Query Batch Status
9
+ [**get_payees_invitation_status_v3**](PayeeInvitationApi.md#get_payees_invitation_status_v3) | **GET** /v3/payees/payors/{payorId}/invitationStatus | Get Payee Invitation Status
10
+ [**query_batch_status_v2**](PayeeInvitationApi.md#query_batch_status_v2) | **GET** /v2/payees/batch/{batchId} | Query Batch Status
11
+ [**query_batch_status_v3**](PayeeInvitationApi.md#query_batch_status_v3) | **GET** /v3/payees/batch/{batchId} | Query Batch Status
12
+ [**resend_payee_invite_v1**](PayeeInvitationApi.md#resend_payee_invite_v1) | **POST** /v1/payees/{payeeId}/invite | Resend Payee Invite
13
+ [**resend_payee_invite_v3**](PayeeInvitationApi.md#resend_payee_invite_v3) | **POST** /v3/payees/{payeeId}/invite | Resend Payee Invite
14
+ [**v2_create_payee**](PayeeInvitationApi.md#v2_create_payee) | **POST** /v2/payees | Initiate Payee Creation
15
+ [**v3_create_payee**](PayeeInvitationApi.md#v3_create_payee) | **POST** /v3/payees | Initiate Payee Creation
14
16
 
15
17
 
16
18
 
17
- ## get_payees_invitation_status
19
+ ## get_payees_invitation_status_v1
18
20
 
19
- > InvitationStatusResponse get_payees_invitation_status(payor_id)
21
+ > InvitationStatusResponse get_payees_invitation_status_v1(payor_id)
20
22
 
21
23
  Get Payee Invitation Status
22
24
 
23
- Returns a list of payees associated with a payor, along with invitation status and grace period end date.
25
+ <p>Returns a list of payees associated with a payor, along with invitation status and grace period end date.</p> <p>Please use V3 instead</p>
24
26
 
25
27
  ### Example
26
28
 
@@ -34,14 +36,14 @@ VeloPayments.configure do |config|
34
36
  end
35
37
 
36
38
  api_instance = VeloPayments::PayeeInvitationApi.new
37
- payor_id = 'payor_id_example' # String | The account owner Payor ID
39
+ payor_id = '9ac75325-5dcd-42d5-b992-175d7e0a035e' # String | The account owner Payor ID
38
40
 
39
41
  begin
40
42
  #Get Payee Invitation Status
41
- result = api_instance.get_payees_invitation_status(payor_id)
43
+ result = api_instance.get_payees_invitation_status_v1(payor_id)
42
44
  p result
43
45
  rescue VeloPayments::ApiError => e
44
- puts "Exception when calling PayeeInvitationApi->get_payees_invitation_status: #{e}"
46
+ puts "Exception when calling PayeeInvitationApi->get_payees_invitation_status_v1: #{e}"
45
47
  end
46
48
  ```
47
49
 
@@ -72,7 +74,7 @@ Name | Type | Description | Notes
72
74
 
73
75
  Get Payee Invitation Status
74
76
 
75
- Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.
77
+ <p>Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.</p> <p>Please use V3 instead</p>
76
78
 
77
79
  ### Example
78
80
 
@@ -86,9 +88,9 @@ VeloPayments.configure do |config|
86
88
  end
87
89
 
88
90
  api_instance = VeloPayments::PayeeInvitationApi.new
89
- payor_id = 'payor_id_example' # String | The account owner Payor ID
91
+ payor_id = '9ac75325-5dcd-42d5-b992-175d7e0a035e' # String | The account owner Payor ID
90
92
  opts = {
91
- payee_id: 'payee_id_example', # String | The UUID of the payee.
93
+ payee_id: '2aa5d7e0-2ecb-403f-8494-1865ed0454e9', # String | The UUID of the payee.
92
94
  invitation_status: VeloPayments::InvitationStatus.new, # InvitationStatus | The invitation status of the payees.
93
95
  page: 1, # Integer | Page number. Default is 1.
94
96
  page_size: 25 # Integer | Page size. Default is 25. Max allowable is 100.
@@ -128,13 +130,13 @@ Name | Type | Description | Notes
128
130
  - **Accept**: application/json
129
131
 
130
132
 
131
- ## resend_payee_invite
133
+ ## get_payees_invitation_status_v3
132
134
 
133
- > InvitationStatusResponse resend_payee_invite(payee_id, invite_payee_request)
135
+ > PagedPayeeInvitationStatusResponse2 get_payees_invitation_status_v3(payor_id, opts)
134
136
 
135
- Resend Payee Invite
137
+ Get Payee Invitation Status
136
138
 
137
- Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined Any previous invites to the payee by this Payor will be invalidated
139
+ Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.
138
140
 
139
141
  ### Example
140
142
 
@@ -148,15 +150,20 @@ VeloPayments.configure do |config|
148
150
  end
149
151
 
150
152
  api_instance = VeloPayments::PayeeInvitationApi.new
151
- payee_id = 'payee_id_example' # String | The UUID of the payee.
152
- invite_payee_request = VeloPayments::InvitePayeeRequest.new # InvitePayeeRequest |
153
+ payor_id = '9ac75325-5dcd-42d5-b992-175d7e0a035e' # String | The account owner Payor ID
154
+ opts = {
155
+ payee_id: '2aa5d7e0-2ecb-403f-8494-1865ed0454e9', # String | The UUID of the payee.
156
+ invitation_status: VeloPayments::InvitationStatus.new, # InvitationStatus | The invitation status of the payees.
157
+ page: 1, # Integer | Page number. Default is 1.
158
+ page_size: 25 # Integer | Page size. Default is 25. Max allowable is 100.
159
+ }
153
160
 
154
161
  begin
155
- #Resend Payee Invite
156
- result = api_instance.resend_payee_invite(payee_id, invite_payee_request)
162
+ #Get Payee Invitation Status
163
+ result = api_instance.get_payees_invitation_status_v3(payor_id, opts)
157
164
  p result
158
165
  rescue VeloPayments::ApiError => e
159
- puts "Exception when calling PayeeInvitationApi->resend_payee_invite: #{e}"
166
+ puts "Exception when calling PayeeInvitationApi->get_payees_invitation_status_v3: #{e}"
160
167
  end
161
168
  ```
162
169
 
@@ -165,12 +172,15 @@ end
165
172
 
166
173
  Name | Type | Description | Notes
167
174
  ------------- | ------------- | ------------- | -------------
168
- **payee_id** | [**String**](.md)| The UUID of the payee. |
169
- **invite_payee_request** | [**InvitePayeeRequest**](InvitePayeeRequest.md)| |
175
+ **payor_id** | [**String**](.md)| The account owner Payor ID |
176
+ **payee_id** | [**String**](.md)| The UUID of the payee. | [optional]
177
+ **invitation_status** | [**InvitationStatus**](.md)| The invitation status of the payees. | [optional]
178
+ **page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
179
+ **page_size** | **Integer**| Page size. Default is 25. Max allowable is 100. | [optional] [default to 25]
170
180
 
171
181
  ### Return type
172
182
 
173
- [**InvitationStatusResponse**](InvitationStatusResponse.md)
183
+ [**PagedPayeeInvitationStatusResponse2**](PagedPayeeInvitationStatusResponse2.md)
174
184
 
175
185
  ### Authorization
176
186
 
@@ -178,17 +188,17 @@ Name | Type | Description | Notes
178
188
 
179
189
  ### HTTP request headers
180
190
 
181
- - **Content-Type**: application/json
191
+ - **Content-Type**: Not defined
182
192
  - **Accept**: application/json
183
193
 
184
194
 
185
- ## v2_create_payee
195
+ ## query_batch_status_v2
186
196
 
187
- > CreatePayeesCSVResponse v2_create_payee(create_payees_request)
197
+ > QueryBatchResponse query_batch_status_v2(batch_id)
188
198
 
189
- Intiate Payee Creation V2
199
+ Query Batch Status
190
200
 
191
- Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body, 409 - if there is a duplicate remote id within the batch / if there is a duplicate email within the batch).
201
+ <p>Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ).</p> <p>Please use V3 instead</p>
192
202
 
193
203
  ### Example
194
204
 
@@ -202,14 +212,14 @@ VeloPayments.configure do |config|
202
212
  end
203
213
 
204
214
  api_instance = VeloPayments::PayeeInvitationApi.new
205
- create_payees_request = VeloPayments::CreatePayeesRequest.new # CreatePayeesRequest | Post payees to create.
215
+ batch_id = 'batch_id_example' # String | Batch Id
206
216
 
207
217
  begin
208
- #Intiate Payee Creation V2
209
- result = api_instance.v2_create_payee(create_payees_request)
218
+ #Query Batch Status
219
+ result = api_instance.query_batch_status_v2(batch_id)
210
220
  p result
211
221
  rescue VeloPayments::ApiError => e
212
- puts "Exception when calling PayeeInvitationApi->v2_create_payee: #{e}"
222
+ puts "Exception when calling PayeeInvitationApi->query_batch_status_v2: #{e}"
213
223
  end
214
224
  ```
215
225
 
@@ -218,11 +228,11 @@ end
218
228
 
219
229
  Name | Type | Description | Notes
220
230
  ------------- | ------------- | ------------- | -------------
221
- **create_payees_request** | [**CreatePayeesRequest**](CreatePayeesRequest.md)| Post payees to create. |
231
+ **batch_id** | [**String**](.md)| Batch Id |
222
232
 
223
233
  ### Return type
224
234
 
225
- [**CreatePayeesCSVResponse**](CreatePayeesCSVResponse.md)
235
+ [**QueryBatchResponse**](QueryBatchResponse.md)
226
236
 
227
237
  ### Authorization
228
238
 
@@ -230,13 +240,13 @@ Name | Type | Description | Notes
230
240
 
231
241
  ### HTTP request headers
232
242
 
233
- - **Content-Type**: application/json, multipart/form-data
243
+ - **Content-Type**: Not defined
234
244
  - **Accept**: application/json
235
245
 
236
246
 
237
- ## v2_query_batch_status
247
+ ## query_batch_status_v3
238
248
 
239
- > QueryBatchResponse v2_query_batch_status(batch_id)
249
+ > QueryBatchResponse2 query_batch_status_v3(batch_id)
240
250
 
241
251
  Query Batch Status
242
252
 
@@ -258,10 +268,10 @@ batch_id = 'batch_id_example' # String | Batch Id
258
268
 
259
269
  begin
260
270
  #Query Batch Status
261
- result = api_instance.v2_query_batch_status(batch_id)
271
+ result = api_instance.query_batch_status_v3(batch_id)
262
272
  p result
263
273
  rescue VeloPayments::ApiError => e
264
- puts "Exception when calling PayeeInvitationApi->v2_query_batch_status: #{e}"
274
+ puts "Exception when calling PayeeInvitationApi->query_batch_status_v3: #{e}"
265
275
  end
266
276
  ```
267
277
 
@@ -274,7 +284,7 @@ Name | Type | Description | Notes
274
284
 
275
285
  ### Return type
276
286
 
277
- [**QueryBatchResponse**](QueryBatchResponse.md)
287
+ [**QueryBatchResponse2**](QueryBatchResponse2.md)
278
288
 
279
289
  ### Authorization
280
290
 
@@ -286,11 +296,117 @@ Name | Type | Description | Notes
286
296
  - **Accept**: application/json
287
297
 
288
298
 
289
- ## v3_create_payee
299
+ ## resend_payee_invite_v1
300
+
301
+ > resend_payee_invite_v1(payee_id, invite_payee_request)
302
+
303
+ Resend Payee Invite
304
+
305
+ <p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p> <p>Deprecated. Please use v3 instead</p>
306
+
307
+ ### Example
308
+
309
+ ```ruby
310
+ # load the gem
311
+ require 'velopayments'
312
+ # setup authorization
313
+ VeloPayments.configure do |config|
314
+ # Configure OAuth2 access token for authorization: OAuth2
315
+ config.access_token = 'YOUR ACCESS TOKEN'
316
+ end
317
+
318
+ api_instance = VeloPayments::PayeeInvitationApi.new
319
+ payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
320
+ invite_payee_request = VeloPayments::InvitePayeeRequest.new # InvitePayeeRequest | Provide Payor Id in body of request
321
+
322
+ begin
323
+ #Resend Payee Invite
324
+ api_instance.resend_payee_invite_v1(payee_id, invite_payee_request)
325
+ rescue VeloPayments::ApiError => e
326
+ puts "Exception when calling PayeeInvitationApi->resend_payee_invite_v1: #{e}"
327
+ end
328
+ ```
329
+
330
+ ### Parameters
331
+
332
+
333
+ Name | Type | Description | Notes
334
+ ------------- | ------------- | ------------- | -------------
335
+ **payee_id** | [**String**](.md)| The UUID of the payee. |
336
+ **invite_payee_request** | [**InvitePayeeRequest**](InvitePayeeRequest.md)| Provide Payor Id in body of request |
337
+
338
+ ### Return type
339
+
340
+ nil (empty response body)
341
+
342
+ ### Authorization
343
+
344
+ [OAuth2](../README.md#OAuth2)
345
+
346
+ ### HTTP request headers
347
+
348
+ - **Content-Type**: application/json
349
+ - **Accept**: application/json
350
+
351
+
352
+ ## resend_payee_invite_v3
353
+
354
+ > resend_payee_invite_v3(payee_id, invite_payee_request2)
355
+
356
+ Resend Payee Invite
357
+
358
+ <p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p>
359
+
360
+ ### Example
361
+
362
+ ```ruby
363
+ # load the gem
364
+ require 'velopayments'
365
+ # setup authorization
366
+ VeloPayments.configure do |config|
367
+ # Configure OAuth2 access token for authorization: OAuth2
368
+ config.access_token = 'YOUR ACCESS TOKEN'
369
+ end
370
+
371
+ api_instance = VeloPayments::PayeeInvitationApi.new
372
+ payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
373
+ invite_payee_request2 = VeloPayments::InvitePayeeRequest2.new # InvitePayeeRequest2 | Provide Payor Id in body of request
374
+
375
+ begin
376
+ #Resend Payee Invite
377
+ api_instance.resend_payee_invite_v3(payee_id, invite_payee_request2)
378
+ rescue VeloPayments::ApiError => e
379
+ puts "Exception when calling PayeeInvitationApi->resend_payee_invite_v3: #{e}"
380
+ end
381
+ ```
290
382
 
291
- > CreatePayeesCSVResponse2 v3_create_payee(create_payees_request2)
383
+ ### Parameters
292
384
 
293
- Intiate Payee Creation V3
385
+
386
+ Name | Type | Description | Notes
387
+ ------------- | ------------- | ------------- | -------------
388
+ **payee_id** | [**String**](.md)| The UUID of the payee. |
389
+ **invite_payee_request2** | [**InvitePayeeRequest2**](InvitePayeeRequest2.md)| Provide Payor Id in body of request |
390
+
391
+ ### Return type
392
+
393
+ nil (empty response body)
394
+
395
+ ### Authorization
396
+
397
+ [OAuth2](../README.md#OAuth2)
398
+
399
+ ### HTTP request headers
400
+
401
+ - **Content-Type**: application/json
402
+ - **Accept**: application/json
403
+
404
+
405
+ ## v2_create_payee
406
+
407
+ > CreatePayeesCSVResponse v2_create_payee(opts)
408
+
409
+ Initiate Payee Creation
294
410
 
295
411
  Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body, 409 - if there is a duplicate remote id within the batch / if there is a duplicate email within the batch).
296
412
 
@@ -306,14 +422,16 @@ VeloPayments.configure do |config|
306
422
  end
307
423
 
308
424
  api_instance = VeloPayments::PayeeInvitationApi.new
309
- create_payees_request2 = VeloPayments::CreatePayeesRequest2.new # CreatePayeesRequest2 | Post payees to create.
425
+ opts = {
426
+ create_payees_request: VeloPayments::CreatePayeesRequest.new # CreatePayeesRequest | Post payees to create.
427
+ }
310
428
 
311
429
  begin
312
- #Intiate Payee Creation V3
313
- result = api_instance.v3_create_payee(create_payees_request2)
430
+ #Initiate Payee Creation
431
+ result = api_instance.v2_create_payee(opts)
314
432
  p result
315
433
  rescue VeloPayments::ApiError => e
316
- puts "Exception when calling PayeeInvitationApi->v3_create_payee: #{e}"
434
+ puts "Exception when calling PayeeInvitationApi->v2_create_payee: #{e}"
317
435
  end
318
436
  ```
319
437
 
@@ -322,11 +440,11 @@ end
322
440
 
323
441
  Name | Type | Description | Notes
324
442
  ------------- | ------------- | ------------- | -------------
325
- **create_payees_request2** | [**CreatePayeesRequest2**](CreatePayeesRequest2.md)| Post payees to create. |
443
+ **create_payees_request** | [**CreatePayeesRequest**](CreatePayeesRequest.md)| Post payees to create. | [optional]
326
444
 
327
445
  ### Return type
328
446
 
329
- [**CreatePayeesCSVResponse2**](CreatePayeesCSVResponse2.md)
447
+ [**CreatePayeesCSVResponse**](CreatePayeesCSVResponse.md)
330
448
 
331
449
  ### Authorization
332
450
 
@@ -338,13 +456,13 @@ Name | Type | Description | Notes
338
456
  - **Accept**: application/json
339
457
 
340
458
 
341
- ## v3_query_batch_status
459
+ ## v3_create_payee
342
460
 
343
- > QueryBatchResponse v3_query_batch_status(batch_id)
461
+ > CreatePayeesCSVResponse2 v3_create_payee(opts)
344
462
 
345
- Query Batch Status
463
+ Initiate Payee Creation
346
464
 
347
- 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 ).
465
+ Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body, 409 - if there is a duplicate remote id within the batch / if there is a duplicate email within the batch).
348
466
 
349
467
  ### Example
350
468
 
@@ -358,14 +476,16 @@ VeloPayments.configure do |config|
358
476
  end
359
477
 
360
478
  api_instance = VeloPayments::PayeeInvitationApi.new
361
- batch_id = 'batch_id_example' # String | Batch Id
479
+ opts = {
480
+ create_payees_request2: VeloPayments::CreatePayeesRequest2.new # CreatePayeesRequest2 | Post payees to create.
481
+ }
362
482
 
363
483
  begin
364
- #Query Batch Status
365
- result = api_instance.v3_query_batch_status(batch_id)
484
+ #Initiate Payee Creation
485
+ result = api_instance.v3_create_payee(opts)
366
486
  p result
367
487
  rescue VeloPayments::ApiError => e
368
- puts "Exception when calling PayeeInvitationApi->v3_query_batch_status: #{e}"
488
+ puts "Exception when calling PayeeInvitationApi->v3_create_payee: #{e}"
369
489
  end
370
490
  ```
371
491
 
@@ -374,11 +494,11 @@ end
374
494
 
375
495
  Name | Type | Description | Notes
376
496
  ------------- | ------------- | ------------- | -------------
377
- **batch_id** | [**String**](.md)| Batch Id |
497
+ **create_payees_request2** | [**CreatePayeesRequest2**](CreatePayeesRequest2.md)| Post payees to create. | [optional]
378
498
 
379
499
  ### Return type
380
500
 
381
- [**QueryBatchResponse**](QueryBatchResponse.md)
501
+ [**CreatePayeesCSVResponse2**](CreatePayeesCSVResponse2.md)
382
502
 
383
503
  ### Authorization
384
504
 
@@ -386,6 +506,6 @@ Name | Type | Description | Notes
386
506
 
387
507
  ### HTTP request headers
388
508
 
389
- - **Content-Type**: Not defined
509
+ - **Content-Type**: application/json, multipart/form-data
390
510
  - **Accept**: application/json
391
511