velopayments 2.29.128.beta1 → 2.35.58

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 (761) hide show
  1. checksums.yaml +5 -5
  2. data/Gemfile.lock +72 -0
  3. data/Makefile +21 -37
  4. data/README.md +122 -144
  5. data/docs/AcceptedPaymentV3.md +16 -14
  6. data/docs/AuthResponse.md +1 -1
  7. data/docs/{AutoTopUpConfig.md → AutoTopUpConfigV2.md} +2 -2
  8. data/docs/{AutoTopUpConfig2.md → AutoTopUpConfigV3.md} +2 -2
  9. data/docs/{Challenge.md → ChallengeV3.md} +2 -2
  10. data/docs/{Challenge2.md → ChallengeV4.md} +2 -2
  11. data/docs/{Company2.md → CompanyV3.md} +2 -2
  12. data/docs/{Company.md → CompanyV4.md} +2 -2
  13. data/docs/CreateFundingAccountRequestV2.md +4 -4
  14. data/docs/{CreateIndividual.md → CreateIndividualV3.md} +3 -3
  15. data/docs/{CreateIndividualName.md → CreateIndividualV3Name.md} +2 -2
  16. data/docs/{CreateIndividual2.md → CreateIndividualV4.md} +3 -3
  17. data/docs/{CreatePayeeAddress.md → CreatePayeeAddressV3.md} +2 -2
  18. data/docs/{PayeeAddress2.md → CreatePayeeAddressV4.md} +3 -3
  19. data/docs/{CreatePayee.md → CreatePayeeV3.md} +8 -8
  20. data/docs/CreatePayeeV4.md +34 -0
  21. data/docs/{CreatePayeesCSVRequest.md → CreatePayeesCSVRequestV3.md} +6 -6
  22. data/docs/{CreatePayeesCSVRequest2.md → CreatePayeesCSVRequestV4.md} +6 -6
  23. data/docs/{CreatePayeesCSVResponse.md → CreatePayeesCSVResponseV3.md} +3 -3
  24. data/docs/{CreatePayeesCSVResponseRejectedCsvRows.md → CreatePayeesCSVResponseV3RejectedCsvRows.md} +2 -2
  25. data/docs/{CreatePayeesCSVResponse2.md → CreatePayeesCSVResponseV4.md} +3 -3
  26. data/docs/{CreatePayeesRequest2.md → CreatePayeesRequestV3.md} +3 -3
  27. data/docs/{CreatePayeesRequest.md → CreatePayeesRequestV4.md} +3 -3
  28. data/docs/{CreatePaymentChannel.md → CreatePaymentChannelV3.md} +6 -6
  29. data/docs/{CreatePaymentChannel2.md → CreatePaymentChannelV4.md} +6 -6
  30. data/docs/{FailedPayee.md → FailedPayeeV3.md} +8 -8
  31. data/docs/{FailedPayee2.md → FailedPayeeV4.md} +9 -9
  32. data/docs/{FailedSubmission.md → FailedSubmissionV3.md} +3 -3
  33. data/docs/{FailedSubmission2.md → FailedSubmissionV4.md} +3 -3
  34. data/docs/{FundingAccountResponse2.md → FundingAccountResponseV2.md} +4 -4
  35. data/docs/FundingApi.md +459 -0
  36. data/docs/FundingAudit.md +3 -3
  37. data/docs/FundingEvent.md +1 -1
  38. data/docs/FundingResponse.md +44 -0
  39. data/docs/FxSummary.md +6 -6
  40. data/docs/FxSummaryV3.md +4 -4
  41. data/docs/{GetPayeeListResponseCompany.md → GetPayeeListResponseCompanyV3.md} +2 -2
  42. data/docs/{GetPayeeListResponseCompany2.md → GetPayeeListResponseCompanyV4.md} +2 -2
  43. data/docs/GetPayeeListResponseIndividualV3.md +18 -0
  44. data/docs/GetPayeeListResponseIndividualV4.md +18 -0
  45. data/docs/{GetPayeeListResponse.md → GetPayeeListResponseV3.md} +8 -8
  46. data/docs/{GetPayeeListResponse2.md → GetPayeeListResponseV4.md} +9 -9
  47. data/docs/GetPaymentsForPayoutResponseV3Summary.md +1 -1
  48. data/docs/GetPaymentsForPayoutResponseV4.md +2 -2
  49. data/docs/GetPaymentsForPayoutResponseV4Summary.md +2 -2
  50. data/docs/GetPayoutsResponse.md +2 -2
  51. data/docs/{Individual.md → IndividualV3.md} +3 -3
  52. data/docs/{IndividualName.md → IndividualV3Name.md} +2 -2
  53. data/docs/{Individual2.md → IndividualV4.md} +3 -3
  54. data/docs/{InstructPayoutRequest.md → InstructPayoutRequestV3.md} +2 -2
  55. data/docs/{InvitePayeeRequest.md → InvitePayeeRequestV3.md} +2 -2
  56. data/docs/{InvitePayeeRequest2.md → InvitePayeeRequestV4.md} +2 -2
  57. data/docs/ListFundingAccountsResponseV2.md +22 -0
  58. data/docs/{ListSourceAccountResponseLinks.md → ListFundingAccountsResponseV2Links.md} +2 -2
  59. data/docs/{ListSourceAccountResponsePage.md → ListFundingAccountsResponseV2Page.md} +2 -2
  60. data/docs/LoginApi.md +1 -1
  61. data/docs/{Name.md → NameV3.md} +2 -2
  62. data/docs/{Name2.md → NameV4.md} +2 -2
  63. data/docs/Notification.md +2 -2
  64. data/docs/NotificationSource.md +94 -0
  65. data/docs/{Notifications.md → NotificationsV2.md} +2 -2
  66. data/docs/{Notifications2.md → NotificationsV3.md} +2 -2
  67. data/docs/PagedPayeeInvitationStatusResponseV3.md +22 -0
  68. data/docs/{PagedPayeeInvitationStatusResponsePage.md → PagedPayeeInvitationStatusResponseV3Page.md} +2 -2
  69. data/docs/PagedPayeeInvitationStatusResponseV4.md +22 -0
  70. data/docs/PagedPayeeResponseV3.md +24 -0
  71. data/docs/{PagedPayeeResponseLinks.md → PagedPayeeResponseV3Links.md} +2 -2
  72. data/docs/{PagedPayeeResponsePage.md → PagedPayeeResponseV3Page.md} +2 -2
  73. data/docs/{PagedPayeeResponseSummary.md → PagedPayeeResponseV3Summary.md} +2 -2
  74. data/docs/PagedPayeeResponseV4.md +24 -0
  75. data/docs/PagedPaymentsResponseV3.md +2 -2
  76. data/docs/{PayableIssue.md → PayableIssueV3.md} +2 -2
  77. data/docs/{PayableIssue2.md → PayableIssueV4.md} +2 -2
  78. data/docs/{CreatePayeeAddress2.md → PayeeAddressV3.md} +3 -3
  79. data/docs/{PayeeAddress.md → PayeeAddressV4.md} +2 -2
  80. data/docs/PayeeDeltaResponseV3.md +22 -0
  81. data/docs/{PayeeDeltaResponseLinks.md → PayeeDeltaResponseV3Links.md} +2 -2
  82. data/docs/{PayeeDeltaResponsePage.md → PayeeDeltaResponseV3Page.md} +2 -2
  83. data/docs/PayeeDeltaResponseV4.md +22 -0
  84. data/docs/{PayeeDeltaResponse2Links.md → PayeeDeltaResponseV4Links.md} +2 -2
  85. data/docs/{PayeeDelta.md → PayeeDeltaV3.md} +3 -3
  86. data/docs/{PayeeDelta2.md → PayeeDeltaV4.md} +4 -4
  87. data/docs/{PayeeDetailResponse2.md → PayeeDetailResponseV3.md} +11 -11
  88. data/docs/{PayeeDetailResponse.md → PayeeDetailResponseV4.md} +10 -10
  89. data/docs/PayeeInvitationApi.md +111 -111
  90. data/docs/{PayeeInvitationStatusResponse.md → PayeeInvitationStatusResponseV3.md} +3 -3
  91. data/docs/{PayeeInvitationStatusResponse2.md → PayeeInvitationStatusResponseV4.md} +3 -3
  92. data/docs/PayeePayorRefV3.md +2 -2
  93. data/docs/{PayeePayorRef.md → PayeePayorRefV4.md} +4 -4
  94. data/docs/{OfacStatus.md → PayeeTypeEnum.md} +2 -2
  95. data/docs/PayeesApi.md +62 -62
  96. data/docs/PaymentAuditServiceApi.md +12 -4
  97. data/docs/PaymentChannelRule.md +3 -1
  98. data/docs/PaymentDeltaResponse.md +2 -2
  99. data/docs/PaymentDeltaResponseV1.md +2 -2
  100. data/docs/PaymentEventResponse.md +12 -6
  101. data/docs/PaymentEventResponseV3.md +3 -3
  102. data/docs/PaymentInstructionV3.md +3 -3
  103. data/docs/PaymentResponseV3.md +6 -4
  104. data/docs/PaymentResponseV4.md +13 -7
  105. data/docs/PaymentV3.md +23 -21
  106. data/docs/PayorBrandingResponse.md +3 -3
  107. data/docs/PayorCreateApiKeyRequest.md +2 -2
  108. data/docs/PayorHierarchyApi.md +83 -0
  109. data/docs/PayorLinksResponseLinks.md +1 -1
  110. data/docs/PayorLinksResponsePayors.md +1 -1
  111. data/docs/PayorV1.md +2 -2
  112. data/docs/PayorV2.md +9 -5
  113. data/docs/PayorsApi.md +41 -117
  114. data/docs/PayoutSchedule.md +2 -2
  115. data/docs/{PayoutSchedule2.md → PayoutScheduleV3.md} +4 -4
  116. data/docs/PayoutSummaryAudit.md +2 -2
  117. data/docs/PayoutSummaryAuditV3.md +1 -1
  118. data/docs/PayoutSummaryResponseV3.md +10 -10
  119. data/docs/{PayoutServiceApi.md → PayoutsApi.md} +42 -42
  120. data/docs/PostInstructFxInfo.md +24 -0
  121. data/docs/{QueryBatchResponse.md → QueryBatchResponseV3.md} +4 -4
  122. data/docs/{QueryBatchResponse2.md → QueryBatchResponseV4.md} +4 -4
  123. data/docs/QuoteFxSummaryV3.md +15 -15
  124. data/docs/RejectedPaymentV3.md +16 -16
  125. data/docs/{SchedulePayoutRequest.md → SchedulePayoutRequestV3.md} +2 -2
  126. data/docs/SetNotificationsRequest2.md +18 -0
  127. data/docs/SourceAccountResponseV2.md +2 -2
  128. data/docs/SourceAccountResponseV3.md +4 -4
  129. data/docs/SourceAccountSummary.md +2 -2
  130. data/docs/SourceAccountSummaryV3.md +1 -1
  131. data/docs/SourceAccountV3.md +5 -5
  132. data/docs/SourceAccountsApi.md +603 -0
  133. data/docs/{TransferRequest.md → TransferRequestV2.md} +2 -2
  134. data/docs/{TransferRequest2.md → TransferRequestV3.md} +3 -3
  135. data/docs/{UpdatePayeeDetailsRequest.md → UpdatePayeeDetailsRequestV3.md} +7 -7
  136. data/docs/{UpdatePayeeDetailsRequest2.md → UpdatePayeeDetailsRequestV4.md} +7 -7
  137. data/docs/{UpdateRemoteIdRequest.md → UpdateRemoteIdRequestV3.md} +2 -2
  138. data/docs/{UpdateRemoteIdRequest2.md → UpdateRemoteIdRequestV4.md} +2 -2
  139. data/docs/WebhooksResponse.md +2 -2
  140. data/lib/velopayments/api/countries_api.rb +2 -2
  141. data/lib/velopayments/api/currencies_api.rb +2 -2
  142. data/lib/velopayments/api/funding_api.rb +481 -0
  143. data/lib/velopayments/api/funding_manager_private_api.rb +2 -2
  144. data/lib/velopayments/api/login_api.rb +5 -5
  145. data/lib/velopayments/api/payee_invitation_api.rb +112 -112
  146. data/lib/velopayments/api/payees_api.rb +80 -80
  147. data/lib/velopayments/api/payment_audit_service_api.rb +34 -18
  148. data/lib/velopayments/api/payment_audit_service_deprecated_api.rb +12 -12
  149. data/{spec/models/create_webhook_request_spec.rb → lib/velopayments/api/payor_hierarchy_api.rb} +67 -37
  150. data/lib/velopayments/api/payors_api.rb +41 -107
  151. data/lib/velopayments/api/payors_private_api.rb +2 -2
  152. data/lib/velopayments/api/{payout_service_api.rb → payouts_api.rb} +52 -52
  153. data/lib/velopayments/api/source_accounts_api.rb +632 -0
  154. data/lib/velopayments/api/tokens_api.rb +2 -2
  155. data/lib/velopayments/api/users_api.rb +5 -5
  156. data/lib/velopayments/api/webhooks_api.rb +4 -4
  157. data/lib/velopayments/api_client.rb +5 -3
  158. data/lib/velopayments/api_error.rb +3 -2
  159. data/lib/velopayments/configuration.rb +31 -12
  160. data/lib/velopayments/models/accepted_payment_v3.rb +193 -23
  161. data/lib/velopayments/models/access_token_response.rb +15 -19
  162. data/lib/velopayments/models/access_token_validation_request.rb +17 -19
  163. data/lib/velopayments/models/auth_response.rb +19 -19
  164. data/lib/velopayments/models/{auto_top_up_config.rb → auto_top_up_config_v2.rb} +20 -22
  165. data/lib/velopayments/models/{auto_top_up_config2.rb → auto_top_up_config_v3.rb} +20 -22
  166. data/lib/velopayments/models/category.rb +8 -5
  167. data/lib/velopayments/models/{challenge.rb → challenge_v3.rb} +22 -22
  168. data/lib/velopayments/models/{challenge2.rb → challenge_v4.rb} +22 -22
  169. data/lib/velopayments/models/{company.rb → company_v3.rb} +20 -22
  170. data/lib/velopayments/models/{company2.rb → company_v4.rb} +20 -22
  171. data/lib/velopayments/models/create_funding_account_request_v2.rb +55 -37
  172. data/lib/velopayments/models/{create_individual.rb → create_individual_v3.rb} +29 -25
  173. data/lib/velopayments/models/{individual_name.rb → create_individual_v3_name.rb} +34 -26
  174. data/lib/velopayments/models/{create_individual2.rb → create_individual_v4.rb} +29 -25
  175. data/lib/velopayments/models/{create_payee_address2.rb → create_payee_address_v3.rb} +37 -51
  176. data/lib/velopayments/models/{create_payee_address.rb → create_payee_address_v4.rb} +49 -52
  177. data/lib/velopayments/models/{create_payee.rb → create_payee_v3.rb} +33 -28
  178. data/lib/velopayments/models/{create_payee2.rb → create_payee_v4.rb} +55 -50
  179. data/lib/velopayments/models/{create_payees_csv_request.rb → create_payees_csv_request_v3.rb} +209 -81
  180. data/lib/velopayments/models/{create_payees_csv_request2.rb → create_payees_csv_request_v4.rb} +209 -81
  181. data/lib/velopayments/models/{create_payees_csv_response.rb → create_payees_csv_response_v3.rb} +19 -23
  182. data/lib/velopayments/models/{create_payees_csv_response_rejected_csv_rows.rb → create_payees_csv_response_v3_rejected_csv_rows.rb} +18 -22
  183. data/lib/velopayments/models/{create_payees_csv_response2.rb → create_payees_csv_response_v4.rb} +19 -23
  184. data/lib/velopayments/models/{create_payees_request.rb → create_payees_request_v3.rb} +23 -23
  185. data/lib/velopayments/models/{create_payees_request2.rb → create_payees_request_v4.rb} +23 -23
  186. data/lib/velopayments/models/{create_payment_channel.rb → create_payment_channel_v3.rb} +104 -67
  187. data/lib/velopayments/models/{create_payment_channel2.rb → create_payment_channel_v4.rb} +104 -67
  188. data/lib/velopayments/models/create_payor_link_request.rb +21 -19
  189. data/lib/velopayments/models/create_payout_request_v3.rb +22 -20
  190. data/lib/velopayments/models/create_webhook_request.rb +28 -22
  191. data/lib/velopayments/models/debit_event.rb +23 -19
  192. data/lib/velopayments/models/debit_event_all_of.rb +17 -19
  193. data/lib/velopayments/models/debit_status_changed.rb +25 -19
  194. data/lib/velopayments/models/debit_status_changed_all_of.rb +17 -19
  195. data/lib/velopayments/models/error.rb +15 -19
  196. data/lib/velopayments/models/error_data.rb +15 -19
  197. data/lib/velopayments/models/error_response.rb +20 -20
  198. data/lib/velopayments/models/{failed_payee.rb → failed_payee_v3.rb} +25 -28
  199. data/lib/velopayments/models/{failed_payee2.rb → failed_payee_v4.rb} +26 -29
  200. data/lib/velopayments/models/{failed_submission.rb → failed_submission_v3.rb} +19 -23
  201. data/lib/velopayments/models/{failed_submission2.rb → failed_submission_v4.rb} +19 -23
  202. data/lib/velopayments/models/{funding_account_response2.rb → funding_account_response_v2.rb} +43 -28
  203. data/lib/velopayments/models/funding_audit.rb +18 -77
  204. data/lib/velopayments/models/funding_event.rb +17 -20
  205. data/lib/velopayments/models/funding_payor_status_audit_response.rb +22 -22
  206. data/lib/velopayments/models/funding_request_v2.rb +17 -19
  207. data/lib/velopayments/models/funding_request_v3.rb +19 -19
  208. data/lib/velopayments/models/{source_account_response.rb → funding_response.rb} +178 -138
  209. data/lib/velopayments/models/fx_summary.rb +87 -61
  210. data/lib/velopayments/models/fx_summary_v3.rb +87 -61
  211. data/lib/velopayments/models/get_fundings_response.rb +15 -19
  212. data/lib/velopayments/models/get_fundings_response_links.rb +15 -19
  213. data/lib/velopayments/models/{get_payee_list_response_company.rb → get_payee_list_response_company_v3.rb} +24 -24
  214. data/lib/velopayments/models/{get_payee_list_response_company2.rb → get_payee_list_response_company_v4.rb} +24 -24
  215. data/lib/velopayments/models/{get_payee_list_response_individual.rb → get_payee_list_response_individual_v3.rb} +19 -23
  216. data/lib/velopayments/models/{get_payee_list_response_individual2.rb → get_payee_list_response_individual_v4.rb} +19 -23
  217. data/lib/velopayments/models/{get_payee_list_response.rb → get_payee_list_response_v3.rb} +66 -27
  218. data/lib/velopayments/models/{get_payee_list_response2.rb → get_payee_list_response_v4.rb} +67 -28
  219. data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +15 -19
  220. data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +15 -19
  221. data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +16 -54
  222. data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +17 -21
  223. data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +19 -21
  224. data/lib/velopayments/models/get_payout_statistics.rb +19 -19
  225. data/lib/velopayments/models/get_payouts_response.rb +17 -21
  226. data/lib/velopayments/models/get_payouts_response_v3.rb +15 -19
  227. data/lib/velopayments/models/get_payouts_response_v3_links.rb +15 -19
  228. data/lib/velopayments/models/get_payouts_response_v3_page.rb +15 -19
  229. data/lib/velopayments/models/{individual.rb → individual_v3.rb} +29 -25
  230. data/lib/velopayments/models/{create_individual_name.rb → individual_v3_name.rb} +34 -26
  231. data/lib/velopayments/models/{individual2.rb → individual_v4.rb} +29 -25
  232. data/lib/velopayments/models/inline_response400.rb +15 -19
  233. data/lib/velopayments/models/inline_response401.rb +15 -19
  234. data/lib/velopayments/models/inline_response403.rb +15 -19
  235. data/lib/velopayments/models/inline_response404.rb +15 -19
  236. data/lib/velopayments/models/inline_response409.rb +15 -19
  237. data/lib/velopayments/models/inline_response412.rb +15 -19
  238. data/lib/velopayments/models/{instruct_payout_request.rb → instruct_payout_request_v3.rb} +18 -22
  239. data/lib/velopayments/models/{invite_payee_request.rb → invite_payee_request_v3.rb} +20 -22
  240. data/lib/velopayments/models/{invite_payee_request2.rb → invite_payee_request_v4.rb} +20 -22
  241. data/lib/velopayments/models/invite_user_request.rb +37 -23
  242. data/lib/velopayments/models/link_for_response.rb +15 -19
  243. data/lib/velopayments/models/{list_funding_accounts_response2.rb → list_funding_accounts_response_v2.rb} +21 -25
  244. data/lib/velopayments/models/{payee_delta_response_links.rb → list_funding_accounts_response_v2_links.rb} +18 -22
  245. data/lib/velopayments/models/{paged_payee_response_page.rb → list_funding_accounts_response_v2_page.rb} +18 -22
  246. data/lib/velopayments/models/list_payments_response_v3.rb +15 -19
  247. data/lib/velopayments/models/list_payments_response_v3_page.rb +15 -19
  248. data/lib/velopayments/models/list_payments_response_v4.rb +15 -19
  249. data/lib/velopayments/models/list_source_account_response_v2.rb +15 -19
  250. data/lib/velopayments/models/list_source_account_response_v2_links.rb +15 -19
  251. data/lib/velopayments/models/list_source_account_response_v3.rb +15 -19
  252. data/lib/velopayments/models/list_source_account_response_v3_links.rb +15 -19
  253. data/lib/velopayments/models/localisation_details.rb +15 -19
  254. data/lib/velopayments/models/mfa_details.rb +37 -19
  255. data/lib/velopayments/models/mfa_type.rb +8 -5
  256. data/lib/velopayments/models/{name.rb → name_v3.rb} +42 -30
  257. data/lib/velopayments/models/{name2.rb → name_v4.rb} +42 -30
  258. data/lib/velopayments/models/notification.rb +24 -22
  259. data/lib/velopayments/models/{invitation_status2.rb → notification_source.rb} +48 -20
  260. data/lib/velopayments/models/{notifications.rb → notifications_v2.rb} +18 -22
  261. data/lib/velopayments/models/{notifications2.rb → notifications_v3.rb} +18 -22
  262. data/lib/velopayments/models/onboarding_status_changed.rb +23 -19
  263. data/lib/velopayments/models/page_for_response.rb +15 -19
  264. data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +15 -19
  265. data/lib/velopayments/models/{paged_payee_invitation_status_response.rb → paged_payee_invitation_status_response_v3.rb} +21 -25
  266. data/lib/velopayments/models/{paged_payee_invitation_status_response_page.rb → paged_payee_invitation_status_response_v3_page.rb} +18 -22
  267. data/lib/velopayments/models/{paged_payee_invitation_status_response2.rb → paged_payee_invitation_status_response_v4.rb} +21 -25
  268. data/lib/velopayments/models/{paged_payee_response.rb → paged_payee_response_v3.rb} +22 -26
  269. data/lib/velopayments/models/{paged_payee_response_links.rb → paged_payee_response_v3_links.rb} +18 -22
  270. data/lib/velopayments/models/{payee_delta_response_page.rb → paged_payee_response_v3_page.rb} +18 -22
  271. data/lib/velopayments/models/{paged_payee_response_summary.rb → paged_payee_response_v3_summary.rb} +18 -22
  272. data/lib/velopayments/models/{paged_payee_response2.rb → paged_payee_response_v4.rb} +22 -26
  273. data/lib/velopayments/models/paged_payments_response_v3.rb +17 -21
  274. data/lib/velopayments/models/paged_user_response.rb +15 -19
  275. data/lib/velopayments/models/paged_user_response_links.rb +15 -19
  276. data/lib/velopayments/models/paged_user_response_page.rb +15 -19
  277. data/lib/velopayments/models/password_request.rb +17 -19
  278. data/lib/velopayments/models/{payable_issue.rb → payable_issue_v3.rb} +22 -22
  279. data/lib/velopayments/models/{payable_issue2.rb → payable_issue_v4.rb} +22 -22
  280. data/lib/velopayments/models/payable_status_changed.rb +23 -19
  281. data/lib/velopayments/models/{payee_address2.rb → payee_address_v3.rb} +41 -27
  282. data/lib/velopayments/models/{payee_address.rb → payee_address_v4.rb} +24 -22
  283. data/lib/velopayments/models/{payee_delta_response.rb → payee_delta_response_v3.rb} +21 -25
  284. data/lib/velopayments/models/{payee_delta_response2_links.rb → payee_delta_response_v3_links.rb} +18 -22
  285. data/lib/velopayments/models/{list_source_account_response_page.rb → payee_delta_response_v3_page.rb} +18 -22
  286. data/lib/velopayments/models/{payee_delta_response2.rb → payee_delta_response_v4.rb} +21 -25
  287. data/lib/velopayments/models/{list_source_account_response_links.rb → payee_delta_response_v4_links.rb} +18 -22
  288. data/lib/velopayments/models/{payee_delta.rb → payee_delta_v3.rb} +24 -23
  289. data/lib/velopayments/models/{payee_delta2.rb → payee_delta_v4.rb} +64 -23
  290. data/lib/velopayments/models/{payee_detail_response2.rb → payee_detail_response_v3.rb} +69 -30
  291. data/lib/velopayments/models/{payee_detail_response.rb → payee_detail_response_v4.rb} +29 -30
  292. data/lib/velopayments/models/payee_details_changed.rb +23 -19
  293. data/lib/velopayments/models/payee_event.rb +23 -19
  294. data/lib/velopayments/models/payee_event_all_of.rb +17 -19
  295. data/lib/velopayments/models/payee_event_all_of_reasons.rb +19 -19
  296. data/lib/velopayments/models/{payee_invitation_status_response.rb → payee_invitation_status_response_v3.rb} +23 -56
  297. data/lib/velopayments/models/{payee_invitation_status_response2.rb → payee_invitation_status_response_v4.rb} +23 -56
  298. data/lib/velopayments/models/payee_payor_ref_v3.rb +17 -21
  299. data/lib/velopayments/models/{payee_payor_ref.rb → payee_payor_ref_v4.rb} +20 -24
  300. data/lib/velopayments/models/payee_type.rb +8 -5
  301. data/lib/velopayments/models/{payee_type2.rb → payee_type_enum.rb} +9 -6
  302. data/lib/velopayments/models/payee_user_self_update_request.rb +15 -19
  303. data/lib/velopayments/models/payment_channel_country.rb +19 -19
  304. data/lib/velopayments/models/payment_channel_rule.rb +37 -23
  305. data/lib/velopayments/models/payment_channel_rules_response.rb +15 -19
  306. data/lib/velopayments/models/payment_delta.rb +19 -19
  307. data/lib/velopayments/models/payment_delta_response.rb +17 -21
  308. data/lib/velopayments/models/payment_delta_response_v1.rb +17 -21
  309. data/lib/velopayments/models/payment_delta_v1.rb +19 -19
  310. data/lib/velopayments/models/payment_event.rb +23 -19
  311. data/lib/velopayments/models/payment_event_all_of.rb +17 -19
  312. data/lib/velopayments/models/payment_event_response.rb +109 -55
  313. data/lib/velopayments/models/payment_event_response_v3.rb +79 -53
  314. data/lib/velopayments/models/payment_instruction_v3.rb +84 -29
  315. data/lib/velopayments/models/payment_rejected_or_returned.rb +29 -19
  316. data/lib/velopayments/models/payment_rejected_or_returned_all_of.rb +19 -19
  317. data/lib/velopayments/models/payment_response_v3.rb +101 -63
  318. data/lib/velopayments/models/payment_response_v4.rb +121 -64
  319. data/lib/velopayments/models/payment_response_v4_payout.rb +15 -19
  320. data/lib/velopayments/models/payment_status_changed.rb +25 -19
  321. data/lib/velopayments/models/payment_status_changed_all_of.rb +17 -19
  322. data/lib/velopayments/models/payment_v3.rb +158 -56
  323. data/lib/velopayments/models/payor_address.rb +21 -19
  324. data/lib/velopayments/models/payor_address_v2.rb +21 -19
  325. data/lib/velopayments/models/payor_aml_transaction.rb +15 -19
  326. data/lib/velopayments/models/payor_aml_transaction_v3.rb +15 -19
  327. data/lib/velopayments/models/payor_branding_response.rb +20 -20
  328. data/lib/velopayments/models/payor_create_api_key_request.rb +23 -23
  329. data/lib/velopayments/models/payor_create_api_key_response.rb +15 -19
  330. data/lib/velopayments/models/payor_create_application_request.rb +17 -19
  331. data/lib/velopayments/models/payor_email_opt_out_request.rb +17 -19
  332. data/lib/velopayments/models/payor_links_response.rb +15 -19
  333. data/lib/velopayments/models/payor_links_response_links.rb +24 -53
  334. data/lib/velopayments/models/payor_links_response_payors.rb +20 -53
  335. data/lib/velopayments/models/payor_v1.rb +19 -54
  336. data/lib/velopayments/models/payor_v2.rb +45 -58
  337. data/lib/velopayments/models/payout_company_v3.rb +17 -19
  338. data/lib/velopayments/models/payout_individual_v3.rb +17 -19
  339. data/lib/velopayments/models/payout_name_v3.rb +19 -19
  340. data/lib/velopayments/models/payout_payee_v3.rb +17 -19
  341. data/lib/velopayments/models/payout_payor.rb +25 -19
  342. data/lib/velopayments/models/payout_payor_ids.rb +21 -19
  343. data/lib/velopayments/models/payout_principal.rb +19 -19
  344. data/lib/velopayments/models/payout_schedule.rb +27 -20
  345. data/lib/velopayments/models/{payout_schedule2.rb → payout_schedule_v3.rb} +30 -23
  346. data/lib/velopayments/models/payout_summary_audit.rb +27 -21
  347. data/lib/velopayments/models/payout_summary_audit_v3.rb +23 -20
  348. data/lib/velopayments/models/payout_summary_response_v3.rb +32 -20
  349. data/lib/velopayments/models/ping.rb +21 -19
  350. data/lib/velopayments/models/ping_response.rb +15 -19
  351. data/lib/velopayments/models/post_instruct_fx_info.rb +267 -0
  352. data/lib/velopayments/models/{query_batch_response.rb → query_batch_response_v3.rb} +20 -58
  353. data/lib/velopayments/models/{query_batch_response2.rb → query_batch_response_v4.rb} +20 -58
  354. data/lib/velopayments/models/quote_fx_summary_v3.rb +42 -65
  355. data/lib/velopayments/models/quote_response_v3.rb +15 -19
  356. data/lib/velopayments/models/region_v2.rb +15 -19
  357. data/lib/velopayments/models/register_sms_request.rb +17 -19
  358. data/lib/velopayments/models/rejected_payment_v3.rb +121 -19
  359. data/lib/velopayments/models/resend_token_request.rb +17 -19
  360. data/lib/velopayments/models/reset_password_request.rb +17 -19
  361. data/lib/velopayments/models/role.rb +17 -19
  362. data/lib/velopayments/models/role_update_request.rb +17 -19
  363. data/lib/velopayments/models/{schedule_payout_request.rb → schedule_payout_request_v3.rb} +22 -22
  364. data/lib/velopayments/models/self_mfa_type_unregister_request.rb +17 -19
  365. data/lib/velopayments/models/self_update_password_request.rb +19 -19
  366. data/lib/velopayments/models/set_notifications_request.rb +17 -19
  367. data/lib/velopayments/models/{funding_request_v1.rb → set_notifications_request2.rb} +46 -48
  368. data/lib/velopayments/models/source_account_response_v2.rb +44 -50
  369. data/lib/velopayments/models/source_account_response_v3.rb +66 -53
  370. data/lib/velopayments/models/source_account_summary.rb +49 -20
  371. data/lib/velopayments/models/source_account_summary_v3.rb +49 -20
  372. data/lib/velopayments/models/source_account_v3.rb +26 -19
  373. data/lib/velopayments/models/source_event.rb +21 -19
  374. data/lib/velopayments/models/supported_countries_response.rb +15 -19
  375. data/lib/velopayments/models/supported_countries_response_v2.rb +15 -19
  376. data/lib/velopayments/models/supported_country.rb +22 -22
  377. data/lib/velopayments/models/supported_country_v2.rb +22 -22
  378. data/lib/velopayments/models/supported_currency_response_v2.rb +15 -19
  379. data/lib/velopayments/models/supported_currency_v2.rb +22 -22
  380. data/lib/velopayments/models/{transfer_request2.rb → transfer_request_v2.rb} +24 -22
  381. data/lib/velopayments/models/{transfer_request.rb → transfer_request_v3.rb} +36 -22
  382. data/lib/velopayments/models/transmission_types.rb +21 -19
  383. data/lib/velopayments/models/transmission_types2.rb +21 -19
  384. data/lib/velopayments/models/unregister_mfa_request.rb +17 -19
  385. data/lib/velopayments/models/{update_payee_details_request.rb → update_payee_details_request_v3.rb} +45 -27
  386. data/lib/velopayments/models/{update_payee_details_request2.rb → update_payee_details_request_v4.rb} +50 -28
  387. data/lib/velopayments/models/{update_remote_id_request2.rb → update_remote_id_request_v3.rb} +22 -22
  388. data/lib/velopayments/models/{update_remote_id_request.rb → update_remote_id_request_v4.rb} +22 -22
  389. data/lib/velopayments/models/update_webhook_request.rb +21 -21
  390. data/lib/velopayments/models/user_details_update_request.rb +37 -19
  391. data/lib/velopayments/models/user_info.rb +37 -19
  392. data/lib/velopayments/models/user_response.rb +53 -29
  393. data/lib/velopayments/models/user_status.rb +8 -5
  394. data/lib/velopayments/models/user_type.rb +8 -5
  395. data/lib/velopayments/models/user_type2.rb +8 -5
  396. data/lib/velopayments/models/validate_password_response.rb +21 -21
  397. data/lib/velopayments/models/webhook_response.rb +15 -19
  398. data/lib/velopayments/models/webhooks_response.rb +17 -21
  399. data/lib/velopayments/models/withdraw_payment_request.rb +17 -19
  400. data/lib/velopayments/version.rb +3 -3
  401. data/lib/velopayments.rb +91 -111
  402. data/oa3-config.json +1 -1
  403. data/spec/api/countries_api_spec.rb +41 -6
  404. data/spec/api/currencies_api_spec.rb +5 -3
  405. data/spec/api/funding_api_spec.rb +169 -0
  406. data/spec/api/funding_manager_private_api_spec.rb +4 -4
  407. data/spec/api/login_api_spec.rb +11 -11
  408. data/spec/api/payee_invitation_api_spec.rb +74 -38
  409. data/spec/api/payees_api_spec.rb +76 -42
  410. data/spec/api/payment_audit_service_api_spec.rb +90 -17
  411. data/spec/api/payment_audit_service_deprecated_api_spec.rb +10 -10
  412. data/spec/{models/get_fundings_response_links_spec.rb → api/payor_hierarchy_api_spec.rb} +24 -15
  413. data/spec/api/payors_api_spec.rb +47 -35
  414. data/spec/api/payors_private_api_spec.rb +3 -3
  415. data/spec/api/{payout_service_api_spec.rb → payouts_api_spec.rb} +20 -20
  416. data/spec/api/{funding_manager_api_spec.rb → source_accounts_api_spec.rb} +81 -162
  417. data/spec/api/tokens_api_spec.rb +3 -3
  418. data/spec/api/users_api_spec.rb +45 -19
  419. data/spec/api/webhooks_api_spec.rb +7 -7
  420. data/spec/api_client_spec.rb +4 -2
  421. data/spec/configuration_spec.rb +2 -2
  422. data/spec/spec_helper.rb +2 -2
  423. data/specs/api/countries_api_spec.rb +19 -19
  424. data/specs/api/currencies_api_spec.rb +2 -2
  425. data/specs/api/funding_api_spec.rb +169 -0
  426. data/specs/api/funding_manager_private_api_spec.rb +16 -4
  427. data/specs/api/login_api_spec.rb +8 -7
  428. data/specs/api/payee_invitation_api_spec.rb +55 -39
  429. data/specs/api/payees_api_spec.rb +107 -45
  430. data/specs/api/payment_audit_service_api_spec.rb +29 -85
  431. data/specs/api/payment_audit_service_deprecated_api_spec.rb +10 -10
  432. data/{spec/models/company2_spec.rb → specs/api/payor_hierarchy_api_spec.rb} +23 -20
  433. data/specs/api/payors_api_spec.rb +27 -48
  434. data/specs/api/payors_private_api_spec.rb +4 -4
  435. data/specs/api/{payout_service_api_spec.rb → payouts_api_spec.rb} +51 -24
  436. data/specs/api/{funding_manager_api_spec.rb → source_accounts_api_spec.rb} +36 -208
  437. data/specs/api/tokens_api_spec.rb +4 -4
  438. data/specs/api/users_api_spec.rb +38 -47
  439. data/specs/api/webhooks_api_spec.rb +7 -7
  440. data/velopayments.gemspec +3 -3
  441. metadata +208 -766
  442. data/docs/CreatePayee2.md +0 -38
  443. data/docs/FundingAccountResponse.md +0 -36
  444. data/docs/FundingAccountType.md +0 -15
  445. data/docs/FundingEventType.md +0 -15
  446. data/docs/FundingManagerApi.md +0 -1291
  447. data/docs/FundingRequestV1.md +0 -18
  448. data/docs/GetPayeeListResponseIndividual.md +0 -18
  449. data/docs/GetPayeeListResponseIndividual2.md +0 -18
  450. data/docs/InvitationStatus.md +0 -15
  451. data/docs/InvitationStatus2.md +0 -15
  452. data/docs/KycState.md +0 -15
  453. data/docs/ListFundingAccountsResponse.md +0 -22
  454. data/docs/ListFundingAccountsResponse2.md +0 -22
  455. data/docs/ListSourceAccountResponse.md +0 -22
  456. data/docs/OnboardedStatus.md +0 -15
  457. data/docs/OnboardedStatus2.md +0 -15
  458. data/docs/PagedPayeeInvitationStatusResponse.md +0 -22
  459. data/docs/PagedPayeeInvitationStatusResponse2.md +0 -22
  460. data/docs/PagedPayeeResponse.md +0 -24
  461. data/docs/PagedPayeeResponse2.md +0 -24
  462. data/docs/PayeeDeltaResponse.md +0 -22
  463. data/docs/PayeeDeltaResponse2.md +0 -22
  464. data/docs/PayeeType2.md +0 -15
  465. data/docs/PaymentAuditCurrency.md +0 -15
  466. data/docs/PaymentAuditCurrencyV3.md +0 -15
  467. data/docs/PaymentRails.md +0 -15
  468. data/docs/PayorLogoRequest.md +0 -18
  469. data/docs/PayoutStatus.md +0 -15
  470. data/docs/PayoutStatusV3.md +0 -15
  471. data/docs/PayoutType.md +0 -15
  472. data/docs/ScheduleStatus.md +0 -15
  473. data/docs/ScheduleStatus2.md +0 -15
  474. data/docs/SourceAccountResponse.md +0 -44
  475. data/docs/SourceAccountType.md +0 -15
  476. data/docs/TransmissionType.md +0 -15
  477. data/docs/WatchlistStatus.md +0 -15
  478. data/docs/WatchlistStatus2.md +0 -15
  479. data/lib/velopayments/api/funding_manager_api.rb +0 -1330
  480. data/lib/velopayments/models/funding_account_response.rb +0 -357
  481. data/lib/velopayments/models/funding_account_type.rb +0 -37
  482. data/lib/velopayments/models/funding_event_type.rb +0 -42
  483. data/lib/velopayments/models/invitation_status.rb +0 -38
  484. data/lib/velopayments/models/kyc_state.rb +0 -38
  485. data/lib/velopayments/models/list_funding_accounts_response.rb +0 -241
  486. data/lib/velopayments/models/list_source_account_response.rb +0 -241
  487. data/lib/velopayments/models/ofac_status.rb +0 -38
  488. data/lib/velopayments/models/onboarded_status.rb +0 -39
  489. data/lib/velopayments/models/onboarded_status2.rb +0 -39
  490. data/lib/velopayments/models/payment_audit_currency.rb +0 -38
  491. data/lib/velopayments/models/payment_audit_currency_v3.rb +0 -38
  492. data/lib/velopayments/models/payment_rails.rb +0 -37
  493. data/lib/velopayments/models/payor_logo_request.rb +0 -218
  494. data/lib/velopayments/models/payout_status.rb +0 -44
  495. data/lib/velopayments/models/payout_status_v3.rb +0 -44
  496. data/lib/velopayments/models/payout_type.rb +0 -38
  497. data/lib/velopayments/models/schedule_status.rb +0 -38
  498. data/lib/velopayments/models/schedule_status2.rb +0 -38
  499. data/lib/velopayments/models/source_account_type.rb +0 -37
  500. data/lib/velopayments/models/transmission_type.rb +0 -38
  501. data/lib/velopayments/models/watchlist_status.rb +0 -40
  502. data/lib/velopayments/models/watchlist_status2.rb +0 -40
  503. data/spec/models/accepted_payment_v3_spec.rb +0 -76
  504. data/spec/models/access_token_response_spec.rb +0 -70
  505. data/spec/models/access_token_validation_request_spec.rb +0 -34
  506. data/spec/models/auth_response_spec.rb +0 -64
  507. data/spec/models/auto_top_up_config2_spec.rb +0 -52
  508. data/spec/models/auto_top_up_config_spec.rb +0 -46
  509. data/spec/models/category_spec.rb +0 -28
  510. data/spec/models/challenge2_spec.rb +0 -40
  511. data/spec/models/challenge_spec.rb +0 -40
  512. data/spec/models/company_spec.rb +0 -46
  513. data/spec/models/create_funding_account_request_v2_spec.rb +0 -74
  514. data/spec/models/create_individual2_spec.rb +0 -46
  515. data/spec/models/create_individual_name_spec.rb +0 -52
  516. data/spec/models/create_individual_spec.rb +0 -46
  517. data/spec/models/create_payee2_spec.rb +0 -94
  518. data/spec/models/create_payee_address2_spec.rb +0 -80
  519. data/spec/models/create_payee_address_spec.rb +0 -80
  520. data/spec/models/create_payee_spec.rb +0 -94
  521. data/spec/models/create_payees_csv_request2_spec.rb +0 -214
  522. data/spec/models/create_payees_csv_request_spec.rb +0 -214
  523. data/spec/models/create_payees_csv_response2_spec.rb +0 -40
  524. data/spec/models/create_payees_csv_response_rejected_csv_rows_spec.rb +0 -46
  525. data/spec/models/create_payees_csv_response_spec.rb +0 -40
  526. data/spec/models/create_payees_request2_spec.rb +0 -40
  527. data/spec/models/create_payees_request_spec.rb +0 -40
  528. data/spec/models/create_payment_channel2_spec.rb +0 -78
  529. data/spec/models/create_payment_channel_spec.rb +0 -78
  530. data/spec/models/create_payor_link_request_spec.rb +0 -50
  531. data/spec/models/create_payout_request_v3_spec.rb +0 -52
  532. data/spec/models/debit_event_all_of_spec.rb +0 -34
  533. data/spec/models/debit_event_spec.rb +0 -52
  534. data/spec/models/debit_status_changed_all_of_spec.rb +0 -34
  535. data/spec/models/debit_status_changed_spec.rb +0 -58
  536. data/spec/models/error_data_spec.rb +0 -40
  537. data/spec/models/error_response_spec.rb +0 -46
  538. data/spec/models/error_spec.rb +0 -74
  539. data/spec/models/failed_payee2_spec.rb +0 -94
  540. data/spec/models/failed_payee_spec.rb +0 -94
  541. data/spec/models/failed_submission2_spec.rb +0 -40
  542. data/spec/models/failed_submission_spec.rb +0 -40
  543. data/spec/models/funding_account_response2_spec.rb +0 -88
  544. data/spec/models/funding_account_response_spec.rb +0 -88
  545. data/spec/models/funding_account_type_spec.rb +0 -28
  546. data/spec/models/funding_audit_spec.rb +0 -94
  547. data/spec/models/funding_event_spec.rb +0 -52
  548. data/spec/models/funding_event_type_spec.rb +0 -28
  549. data/spec/models/funding_payor_status_audit_response_spec.rb +0 -52
  550. data/spec/models/funding_request_v1_spec.rb +0 -34
  551. data/spec/models/funding_request_v2_spec.rb +0 -34
  552. data/spec/models/funding_request_v3_spec.rb +0 -40
  553. data/spec/models/fx_summary_spec.rb +0 -96
  554. data/spec/models/fx_summary_v3_spec.rb +0 -96
  555. data/spec/models/get_fundings_response_spec.rb +0 -46
  556. data/spec/models/get_payee_list_response2_spec.rb +0 -130
  557. data/spec/models/get_payee_list_response_company2_spec.rb +0 -40
  558. data/spec/models/get_payee_list_response_company_spec.rb +0 -40
  559. data/spec/models/get_payee_list_response_individual2_spec.rb +0 -34
  560. data/spec/models/get_payee_list_response_individual_spec.rb +0 -34
  561. data/spec/models/get_payee_list_response_spec.rb +0 -130
  562. data/spec/models/get_payments_for_payout_response_v3_page_spec.rb +0 -58
  563. data/spec/models/get_payments_for_payout_response_v3_spec.rb +0 -52
  564. data/spec/models/get_payments_for_payout_response_v3_summary_spec.rb +0 -92
  565. data/spec/models/get_payments_for_payout_response_v4_spec.rb +0 -52
  566. data/spec/models/get_payments_for_payout_response_v4_summary_spec.rb +0 -148
  567. data/spec/models/get_payout_statistics_spec.rb +0 -40
  568. data/spec/models/get_payouts_response_spec.rb +0 -46
  569. data/spec/models/get_payouts_response_v3_links_spec.rb +0 -40
  570. data/spec/models/get_payouts_response_v3_page_spec.rb +0 -58
  571. data/spec/models/get_payouts_response_v3_spec.rb +0 -46
  572. data/spec/models/individual2_spec.rb +0 -46
  573. data/spec/models/individual_name_spec.rb +0 -52
  574. data/spec/models/individual_spec.rb +0 -46
  575. data/spec/models/inline_response400_spec.rb +0 -46
  576. data/spec/models/inline_response401_spec.rb +0 -46
  577. data/spec/models/inline_response403_spec.rb +0 -46
  578. data/spec/models/inline_response404_spec.rb +0 -46
  579. data/spec/models/inline_response409_spec.rb +0 -46
  580. data/spec/models/inline_response412_spec.rb +0 -46
  581. data/spec/models/instruct_payout_request_spec.rb +0 -34
  582. data/spec/models/invitation_status2_spec.rb +0 -28
  583. data/spec/models/invitation_status_spec.rb +0 -28
  584. data/spec/models/invite_payee_request2_spec.rb +0 -34
  585. data/spec/models/invite_payee_request_spec.rb +0 -34
  586. data/spec/models/invite_user_request_spec.rb +0 -102
  587. data/spec/models/kyc_state_spec.rb +0 -28
  588. data/spec/models/link_for_response_spec.rb +0 -40
  589. data/spec/models/list_funding_accounts_response2_spec.rb +0 -46
  590. data/spec/models/list_funding_accounts_response_spec.rb +0 -46
  591. data/spec/models/list_payments_response_v3_page_spec.rb +0 -58
  592. data/spec/models/list_payments_response_v3_spec.rb +0 -46
  593. data/spec/models/list_payments_response_v4_spec.rb +0 -46
  594. data/spec/models/list_source_account_response_links_spec.rb +0 -40
  595. data/spec/models/list_source_account_response_page_spec.rb +0 -58
  596. data/spec/models/list_source_account_response_spec.rb +0 -46
  597. data/spec/models/list_source_account_response_v2_links_spec.rb +0 -40
  598. data/spec/models/list_source_account_response_v2_spec.rb +0 -46
  599. data/spec/models/list_source_account_response_v3_links_spec.rb +0 -40
  600. data/spec/models/list_source_account_response_v3_spec.rb +0 -46
  601. data/spec/models/localisation_details_spec.rb +0 -40
  602. data/spec/models/mfa_details_spec.rb +0 -40
  603. data/spec/models/mfa_type_spec.rb +0 -28
  604. data/spec/models/name2_spec.rb +0 -52
  605. data/spec/models/name_spec.rb +0 -52
  606. data/spec/models/notification_spec.rb +0 -58
  607. data/spec/models/notifications2_spec.rb +0 -34
  608. data/spec/models/notifications_spec.rb +0 -34
  609. data/spec/models/ofac_status_spec.rb +0 -28
  610. data/spec/models/onboarded_status2_spec.rb +0 -28
  611. data/spec/models/onboarded_status_spec.rb +0 -28
  612. data/spec/models/onboarding_status_changed_spec.rb +0 -58
  613. data/spec/models/page_for_response_spec.rb +0 -58
  614. data/spec/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response_spec.rb +0 -46
  615. data/spec/models/paged_payee_invitation_status_response2_spec.rb +0 -46
  616. data/spec/models/paged_payee_invitation_status_response_page_spec.rb +0 -58
  617. data/spec/models/paged_payee_invitation_status_response_spec.rb +0 -46
  618. data/spec/models/paged_payee_response2_spec.rb +0 -52
  619. data/spec/models/paged_payee_response_links_spec.rb +0 -40
  620. data/spec/models/paged_payee_response_page_spec.rb +0 -58
  621. data/spec/models/paged_payee_response_spec.rb +0 -52
  622. data/spec/models/paged_payee_response_summary_spec.rb +0 -58
  623. data/spec/models/paged_payments_response_v3_spec.rb +0 -46
  624. data/spec/models/paged_user_response_links_spec.rb +0 -40
  625. data/spec/models/paged_user_response_page_spec.rb +0 -58
  626. data/spec/models/paged_user_response_spec.rb +0 -46
  627. data/spec/models/password_request_spec.rb +0 -34
  628. data/spec/models/payable_issue2_spec.rb +0 -40
  629. data/spec/models/payable_issue_spec.rb +0 -40
  630. data/spec/models/payable_status_changed_spec.rb +0 -58
  631. data/spec/models/payee_address2_spec.rb +0 -76
  632. data/spec/models/payee_address_spec.rb +0 -76
  633. data/spec/models/payee_delta2_spec.rb +0 -70
  634. data/spec/models/payee_delta_response2_links_spec.rb +0 -40
  635. data/spec/models/payee_delta_response2_spec.rb +0 -46
  636. data/spec/models/payee_delta_response_links_spec.rb +0 -40
  637. data/spec/models/payee_delta_response_page_spec.rb +0 -58
  638. data/spec/models/payee_delta_response_spec.rb +0 -46
  639. data/spec/models/payee_delta_spec.rb +0 -70
  640. data/spec/models/payee_detail_response2_spec.rb +0 -202
  641. data/spec/models/payee_detail_response_spec.rb +0 -202
  642. data/spec/models/payee_details_changed_spec.rb +0 -58
  643. data/spec/models/payee_event_all_of_reasons_spec.rb +0 -40
  644. data/spec/models/payee_event_all_of_spec.rb +0 -40
  645. data/spec/models/payee_event_spec.rb +0 -58
  646. data/spec/models/payee_invitation_status_response2_spec.rb +0 -50
  647. data/spec/models/payee_invitation_status_response_spec.rb +0 -50
  648. data/spec/models/payee_payor_ref_spec.rb +0 -70
  649. data/spec/models/payee_payor_ref_v3_spec.rb +0 -70
  650. data/spec/models/payee_type2_spec.rb +0 -28
  651. data/spec/models/payee_type_spec.rb +0 -28
  652. data/spec/models/payee_user_self_update_request_spec.rb +0 -64
  653. data/spec/models/payment_audit_currency_spec.rb +0 -28
  654. data/spec/models/payment_audit_currency_v3_spec.rb +0 -28
  655. data/spec/models/payment_channel_country_spec.rb +0 -40
  656. data/spec/models/payment_channel_rule_spec.rb +0 -70
  657. data/spec/models/payment_channel_rules_response_spec.rb +0 -34
  658. data/spec/models/payment_delta_response_spec.rb +0 -46
  659. data/spec/models/payment_delta_response_v1_spec.rb +0 -46
  660. data/spec/models/payment_delta_spec.rb +0 -76
  661. data/spec/models/payment_delta_v1_spec.rb +0 -76
  662. data/spec/models/payment_event_all_of_spec.rb +0 -46
  663. data/spec/models/payment_event_response_spec.rb +0 -104
  664. data/spec/models/payment_event_response_v3_spec.rb +0 -104
  665. data/spec/models/payment_event_spec.rb +0 -64
  666. data/spec/models/payment_instruction_v3_spec.rb +0 -82
  667. data/spec/models/payment_rails_spec.rb +0 -28
  668. data/spec/models/payment_rejected_or_returned_all_of_spec.rb +0 -40
  669. data/spec/models/payment_rejected_or_returned_spec.rb +0 -82
  670. data/spec/models/payment_response_v3_spec.rb +0 -252
  671. data/spec/models/payment_response_v4_payout_spec.rb +0 -46
  672. data/spec/models/payment_response_v4_spec.rb +0 -318
  673. data/spec/models/payment_status_changed_all_of_spec.rb +0 -34
  674. data/spec/models/payment_status_changed_spec.rb +0 -70
  675. data/spec/models/payment_v3_spec.rb +0 -116
  676. data/spec/models/payor_address_spec.rb +0 -76
  677. data/spec/models/payor_address_v2_spec.rb +0 -76
  678. data/spec/models/payor_aml_transaction_spec.rb +0 -190
  679. data/spec/models/payor_aml_transaction_v3_spec.rb +0 -178
  680. data/spec/models/payor_branding_response_spec.rb +0 -58
  681. data/spec/models/payor_create_api_key_request_spec.rb +0 -50
  682. data/spec/models/payor_create_api_key_response_spec.rb +0 -40
  683. data/spec/models/payor_create_application_request_spec.rb +0 -40
  684. data/spec/models/payor_email_opt_out_request_spec.rb +0 -34
  685. data/spec/models/payor_links_response_links_spec.rb +0 -56
  686. data/spec/models/payor_links_response_payors_spec.rb +0 -56
  687. data/spec/models/payor_links_response_spec.rb +0 -40
  688. data/spec/models/payor_logo_request_spec.rb +0 -34
  689. data/spec/models/payor_v1_spec.rb +0 -164
  690. data/spec/models/payor_v2_spec.rb +0 -182
  691. data/spec/models/payout_company_v3_spec.rb +0 -34
  692. data/spec/models/payout_individual_v3_spec.rb +0 -34
  693. data/spec/models/payout_name_v3_spec.rb +0 -40
  694. data/spec/models/payout_payee_v3_spec.rb +0 -46
  695. data/spec/models/payout_payor_ids_spec.rb +0 -46
  696. data/spec/models/payout_payor_spec.rb +0 -58
  697. data/spec/models/payout_principal_spec.rb +0 -40
  698. data/spec/models/payout_schedule2_spec.rb +0 -58
  699. data/spec/models/payout_schedule_spec.rb +0 -64
  700. data/spec/models/payout_status_spec.rb +0 -28
  701. data/spec/models/payout_status_v3_spec.rb +0 -28
  702. data/spec/models/payout_summary_audit_spec.rb +0 -130
  703. data/spec/models/payout_summary_audit_v3_spec.rb +0 -100
  704. data/spec/models/payout_summary_response_v3_spec.rb +0 -94
  705. data/spec/models/payout_type_spec.rb +0 -28
  706. data/spec/models/ping_response_spec.rb +0 -40
  707. data/spec/models/ping_spec.rb +0 -46
  708. data/spec/models/query_batch_response2_spec.rb +0 -56
  709. data/spec/models/query_batch_response_spec.rb +0 -56
  710. data/spec/models/quote_fx_summary_v3_spec.rb +0 -102
  711. data/spec/models/quote_response_v3_spec.rb +0 -34
  712. data/spec/models/region_v2_spec.rb +0 -40
  713. data/spec/models/register_sms_request_spec.rb +0 -34
  714. data/spec/models/rejected_payment_v3_spec.rb +0 -94
  715. data/spec/models/resend_token_request_spec.rb +0 -44
  716. data/spec/models/reset_password_request_spec.rb +0 -34
  717. data/spec/models/role_spec.rb +0 -34
  718. data/spec/models/role_update_request_spec.rb +0 -40
  719. data/spec/models/schedule_payout_request_spec.rb +0 -40
  720. data/spec/models/schedule_status2_spec.rb +0 -28
  721. data/spec/models/schedule_status_spec.rb +0 -28
  722. data/spec/models/self_mfa_type_unregister_request_spec.rb +0 -38
  723. data/spec/models/self_update_password_request_spec.rb +0 -40
  724. data/spec/models/set_notifications_request_spec.rb +0 -34
  725. data/spec/models/source_account_response_spec.rb +0 -116
  726. data/spec/models/source_account_response_v2_spec.rb +0 -128
  727. data/spec/models/source_account_response_v3_spec.rb +0 -140
  728. data/spec/models/source_account_summary_spec.rb +0 -46
  729. data/spec/models/source_account_summary_v3_spec.rb +0 -46
  730. data/spec/models/source_account_type_spec.rb +0 -28
  731. data/spec/models/source_account_v3_spec.rb +0 -52
  732. data/spec/models/source_event_spec.rb +0 -46
  733. data/spec/models/supported_countries_response_spec.rb +0 -34
  734. data/spec/models/supported_countries_response_v2_spec.rb +0 -34
  735. data/spec/models/supported_country_spec.rb +0 -40
  736. data/spec/models/supported_country_v2_spec.rb +0 -46
  737. data/spec/models/supported_currency_response_v2_spec.rb +0 -34
  738. data/spec/models/supported_currency_v2_spec.rb +0 -40
  739. data/spec/models/transfer_request2_spec.rb +0 -46
  740. data/spec/models/transfer_request_spec.rb +0 -46
  741. data/spec/models/transmission_type_spec.rb +0 -28
  742. data/spec/models/transmission_types2_spec.rb +0 -46
  743. data/spec/models/transmission_types_spec.rb +0 -46
  744. data/spec/models/unregister_mfa_request_spec.rb +0 -44
  745. data/spec/models/update_payee_details_request2_spec.rb +0 -76
  746. data/spec/models/update_payee_details_request_spec.rb +0 -70
  747. data/spec/models/update_remote_id_request2_spec.rb +0 -40
  748. data/spec/models/update_remote_id_request_spec.rb +0 -40
  749. data/spec/models/update_webhook_request_spec.rb +0 -52
  750. data/spec/models/user_details_update_request_spec.rb +0 -76
  751. data/spec/models/user_info_spec.rb +0 -46
  752. data/spec/models/user_response_spec.rb +0 -140
  753. data/spec/models/user_status_spec.rb +0 -28
  754. data/spec/models/user_type2_spec.rb +0 -28
  755. data/spec/models/user_type_spec.rb +0 -28
  756. data/spec/models/validate_password_response_spec.rb +0 -52
  757. data/spec/models/watchlist_status2_spec.rb +0 -28
  758. data/spec/models/watchlist_status_spec.rb +0 -28
  759. data/spec/models/webhook_response_spec.rb +0 -64
  760. data/spec/models/webhooks_response_spec.rb +0 -46
  761. data/spec/models/withdraw_payment_request_spec.rb +0 -34
data/docs/PayorsApi.md CHANGED
@@ -4,23 +4,22 @@ All URIs are relative to *https://api.sandbox.velopayments.com*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**get_payor_by_id**](PayorsApi.md#get_payor_by_id) | **GET** /v1/payors/{payorId} | Get Payor |
7
+ | [**get_payor_by_id_v1**](PayorsApi.md#get_payor_by_id_v1) | **GET** /v1/payors/{payorId} | Get Payor |
8
8
  | [**get_payor_by_id_v2**](PayorsApi.md#get_payor_by_id_v2) | **GET** /v2/payors/{payorId} | Get Payor |
9
- | [**payor_add_payor_logo**](PayorsApi.md#payor_add_payor_logo) | **POST** /v1/payors/{payorId}/branding/logos | Add Logo |
10
- | [**payor_create_api_key_request**](PayorsApi.md#payor_create_api_key_request) | **POST** /v1/payors/{payorId}/applications/{applicationId}/keys | Create API Key |
11
- | [**payor_create_application_request**](PayorsApi.md#payor_create_application_request) | **POST** /v1/payors/{payorId}/applications | Create Application |
9
+ | [**payor_add_payor_logo_v1**](PayorsApi.md#payor_add_payor_logo_v1) | **POST** /v1/payors/{payorId}/branding/logos | Add Logo |
10
+ | [**payor_create_api_key_v1**](PayorsApi.md#payor_create_api_key_v1) | **POST** /v1/payors/{payorId}/applications/{applicationId}/keys | Create API Key |
11
+ | [**payor_create_application_v1**](PayorsApi.md#payor_create_application_v1) | **POST** /v1/payors/{payorId}/applications | Create Application |
12
12
  | [**payor_email_opt_out**](PayorsApi.md#payor_email_opt_out) | **POST** /v1/payors/{payorId}/reminderEmailsUpdate | Reminder Email Opt-Out |
13
13
  | [**payor_get_branding**](PayorsApi.md#payor_get_branding) | **GET** /v1/payors/{payorId}/branding | Get Branding |
14
- | [**payor_links**](PayorsApi.md#payor_links) | **GET** /v1/payorLinks | List Payor Links |
15
14
 
16
15
 
17
- ## get_payor_by_id
16
+ ## get_payor_by_id_v1
18
17
 
19
- > <PayorV1> get_payor_by_id(payor_id)
18
+ > <PayorV1> get_payor_by_id_v1(payor_id)
20
19
 
21
20
  Get Payor
22
21
 
23
- Get a Single Payor by Id.
22
+ <p>Get a Single Payor by Id.</p> <p>deprecated since v2.10 - Use /v2/payors
24
23
 
25
24
  ### Examples
26
25
 
@@ -38,28 +37,28 @@ payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The Payor Id
38
37
 
39
38
  begin
40
39
  # Get Payor
41
- result = api_instance.get_payor_by_id(payor_id)
40
+ result = api_instance.get_payor_by_id_v1(payor_id)
42
41
  p result
43
42
  rescue VeloPayments::ApiError => e
44
- puts "Error when calling PayorsApi->get_payor_by_id: #{e}"
43
+ puts "Error when calling PayorsApi->get_payor_by_id_v1: #{e}"
45
44
  end
46
45
  ```
47
46
 
48
- #### Using the get_payor_by_id_with_http_info variant
47
+ #### Using the get_payor_by_id_v1_with_http_info variant
49
48
 
50
49
  This returns an Array which contains the response data, status code and headers.
51
50
 
52
- > <Array(<PayorV1>, Integer, Hash)> get_payor_by_id_with_http_info(payor_id)
51
+ > <Array(<PayorV1>, Integer, Hash)> get_payor_by_id_v1_with_http_info(payor_id)
53
52
 
54
53
  ```ruby
55
54
  begin
56
55
  # Get Payor
57
- data, status_code, headers = api_instance.get_payor_by_id_with_http_info(payor_id)
56
+ data, status_code, headers = api_instance.get_payor_by_id_v1_with_http_info(payor_id)
58
57
  p status_code # => 2xx
59
58
  p headers # => { ... }
60
59
  p data # => <PayorV1>
61
60
  rescue VeloPayments::ApiError => e
62
- puts "Error when calling PayorsApi->get_payor_by_id_with_http_info: #{e}"
61
+ puts "Error when calling PayorsApi->get_payor_by_id_v1_with_http_info: #{e}"
63
62
  end
64
63
  ```
65
64
 
@@ -152,13 +151,13 @@ end
152
151
  - **Accept**: application/json
153
152
 
154
153
 
155
- ## payor_add_payor_logo
154
+ ## payor_add_payor_logo_v1
156
155
 
157
- > payor_add_payor_logo(payor_id, opts)
156
+ > payor_add_payor_logo_v1(payor_id, opts)
158
157
 
159
158
  Add Logo
160
159
 
161
- Add Payor Logo. Logo file is used in your branding, and emails sent to payees.
160
+ <p>Add Payor Logo</p> <p>Logo file is used in your branding and emails sent to payees</p>
162
161
 
163
162
  ### Examples
164
163
 
@@ -179,27 +178,27 @@ opts = {
179
178
 
180
179
  begin
181
180
  # Add Logo
182
- api_instance.payor_add_payor_logo(payor_id, opts)
181
+ api_instance.payor_add_payor_logo_v1(payor_id, opts)
183
182
  rescue VeloPayments::ApiError => e
184
- puts "Error when calling PayorsApi->payor_add_payor_logo: #{e}"
183
+ puts "Error when calling PayorsApi->payor_add_payor_logo_v1: #{e}"
185
184
  end
186
185
  ```
187
186
 
188
- #### Using the payor_add_payor_logo_with_http_info variant
187
+ #### Using the payor_add_payor_logo_v1_with_http_info variant
189
188
 
190
189
  This returns an Array which contains the response data (`nil` in this case), status code and headers.
191
190
 
192
- > <Array(nil, Integer, Hash)> payor_add_payor_logo_with_http_info(payor_id, opts)
191
+ > <Array(nil, Integer, Hash)> payor_add_payor_logo_v1_with_http_info(payor_id, opts)
193
192
 
194
193
  ```ruby
195
194
  begin
196
195
  # Add Logo
197
- data, status_code, headers = api_instance.payor_add_payor_logo_with_http_info(payor_id, opts)
196
+ data, status_code, headers = api_instance.payor_add_payor_logo_v1_with_http_info(payor_id, opts)
198
197
  p status_code # => 2xx
199
198
  p headers # => { ... }
200
199
  p data # => nil
201
200
  rescue VeloPayments::ApiError => e
202
- puts "Error when calling PayorsApi->payor_add_payor_logo_with_http_info: #{e}"
201
+ puts "Error when calling PayorsApi->payor_add_payor_logo_v1_with_http_info: #{e}"
203
202
  end
204
203
  ```
205
204
 
@@ -224,13 +223,13 @@ nil (empty response body)
224
223
  - **Accept**: application/json
225
224
 
226
225
 
227
- ## payor_create_api_key_request
226
+ ## payor_create_api_key_v1
228
227
 
229
- > <PayorCreateApiKeyResponse> payor_create_api_key_request(payor_id, application_id, payor_create_api_key_request)
228
+ > <PayorCreateApiKeyResponse> payor_create_api_key_v1(payor_id, application_id, payor_create_api_key_request)
230
229
 
231
230
  Create API Key
232
231
 
233
- Create an an API key for the given payor Id and application Id
232
+ <p>Create an an API key for the given payor Id and application Id</p> <p>You can create multiple API Keys for a given application</p> <p>API Keys are programmatic users for integrating your application with the Velo platform</p>
234
233
 
235
234
  ### Examples
236
235
 
@@ -246,32 +245,32 @@ end
246
245
  api_instance = VeloPayments::PayorsApi.new
247
246
  payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The Payor Id
248
247
  application_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Application ID
249
- payor_create_api_key_request = VeloPayments::PayorCreateApiKeyRequest.new({name: 'iOS Key', roles: ["payor.admin"]}) # PayorCreateApiKeyRequest | Details of application API key to create
248
+ payor_create_api_key_request = VeloPayments::PayorCreateApiKeyRequest.new({name: 'iOS Key', roles: ["velo.payor.admin"]}) # PayorCreateApiKeyRequest | Details of application API key to create
250
249
 
251
250
  begin
252
251
  # Create API Key
253
- result = api_instance.payor_create_api_key_request(payor_id, application_id, payor_create_api_key_request)
252
+ result = api_instance.payor_create_api_key_v1(payor_id, application_id, payor_create_api_key_request)
254
253
  p result
255
254
  rescue VeloPayments::ApiError => e
256
- puts "Error when calling PayorsApi->payor_create_api_key_request: #{e}"
255
+ puts "Error when calling PayorsApi->payor_create_api_key_v1: #{e}"
257
256
  end
258
257
  ```
259
258
 
260
- #### Using the payor_create_api_key_request_with_http_info variant
259
+ #### Using the payor_create_api_key_v1_with_http_info variant
261
260
 
262
261
  This returns an Array which contains the response data, status code and headers.
263
262
 
264
- > <Array(<PayorCreateApiKeyResponse>, Integer, Hash)> payor_create_api_key_request_with_http_info(payor_id, application_id, payor_create_api_key_request)
263
+ > <Array(<PayorCreateApiKeyResponse>, Integer, Hash)> payor_create_api_key_v1_with_http_info(payor_id, application_id, payor_create_api_key_request)
265
264
 
266
265
  ```ruby
267
266
  begin
268
267
  # Create API Key
269
- data, status_code, headers = api_instance.payor_create_api_key_request_with_http_info(payor_id, application_id, payor_create_api_key_request)
268
+ data, status_code, headers = api_instance.payor_create_api_key_v1_with_http_info(payor_id, application_id, payor_create_api_key_request)
270
269
  p status_code # => 2xx
271
270
  p headers # => { ... }
272
271
  p data # => <PayorCreateApiKeyResponse>
273
272
  rescue VeloPayments::ApiError => e
274
- puts "Error when calling PayorsApi->payor_create_api_key_request_with_http_info: #{e}"
273
+ puts "Error when calling PayorsApi->payor_create_api_key_v1_with_http_info: #{e}"
275
274
  end
276
275
  ```
277
276
 
@@ -297,13 +296,13 @@ end
297
296
  - **Accept**: application/json
298
297
 
299
298
 
300
- ## payor_create_application_request
299
+ ## payor_create_application_v1
301
300
 
302
- > payor_create_application_request(payor_id, payor_create_application_request)
301
+ > payor_create_application_v1(payor_id, payor_create_application_request)
303
302
 
304
303
  Create Application
305
304
 
306
- Create an application for the given Payor ID. Applications are programatic users which can be assigned unique keys.
305
+ <p>Create an application for the given Payor ID.</p> <p>Applications provide a means to group your API Keys</p> <p>For example you might have an SAP application that you wish to integrate with Velo</p> <p>You can create an application and then create one or more API keys for the application</p>
307
306
 
308
307
  ### Examples
309
308
 
@@ -322,27 +321,27 @@ payor_create_application_request = VeloPayments::PayorCreateApplicationRequest.n
322
321
 
323
322
  begin
324
323
  # Create Application
325
- api_instance.payor_create_application_request(payor_id, payor_create_application_request)
324
+ api_instance.payor_create_application_v1(payor_id, payor_create_application_request)
326
325
  rescue VeloPayments::ApiError => e
327
- puts "Error when calling PayorsApi->payor_create_application_request: #{e}"
326
+ puts "Error when calling PayorsApi->payor_create_application_v1: #{e}"
328
327
  end
329
328
  ```
330
329
 
331
- #### Using the payor_create_application_request_with_http_info variant
330
+ #### Using the payor_create_application_v1_with_http_info variant
332
331
 
333
332
  This returns an Array which contains the response data (`nil` in this case), status code and headers.
334
333
 
335
- > <Array(nil, Integer, Hash)> payor_create_application_request_with_http_info(payor_id, payor_create_application_request)
334
+ > <Array(nil, Integer, Hash)> payor_create_application_v1_with_http_info(payor_id, payor_create_application_request)
336
335
 
337
336
  ```ruby
338
337
  begin
339
338
  # Create Application
340
- data, status_code, headers = api_instance.payor_create_application_request_with_http_info(payor_id, payor_create_application_request)
339
+ data, status_code, headers = api_instance.payor_create_application_v1_with_http_info(payor_id, payor_create_application_request)
341
340
  p status_code # => 2xx
342
341
  p headers # => { ... }
343
342
  p data # => nil
344
343
  rescue VeloPayments::ApiError => e
345
- puts "Error when calling PayorsApi->payor_create_application_request_with_http_info: #{e}"
344
+ puts "Error when calling PayorsApi->payor_create_application_v1_with_http_info: #{e}"
346
345
  end
347
346
  ```
348
347
 
@@ -505,78 +504,3 @@ end
505
504
  - **Content-Type**: Not defined
506
505
  - **Accept**: application/json
507
506
 
508
-
509
- ## payor_links
510
-
511
- > <PayorLinksResponse> payor_links(opts)
512
-
513
- List Payor Links
514
-
515
- This endpoint allows you to list payor links
516
-
517
- ### Examples
518
-
519
- ```ruby
520
- require 'time'
521
- require 'velopayments'
522
- # setup authorization
523
- VeloPayments.configure do |config|
524
- # Configure OAuth2 access token for authorization: OAuth2
525
- config.access_token = 'YOUR ACCESS TOKEN'
526
- end
527
-
528
- api_instance = VeloPayments::PayorsApi.new
529
- opts = {
530
- descendants_of_payor: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | The Payor ID from which to start the query to show all descendants
531
- parent_of_payor: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | Look for the parent payor details for this payor id
532
- fields: 'fields_example' # String | List of additional Payor fields to include in the response for each Payor. The values of payorId and payorName and always included for each Payor - 'fields' allows you to add to this. Example: ```fields=primaryContactEmail,kycState``` - will include payorId+payorName+primaryContactEmail+kycState for each Payor Default if not specified is to include only payorId and payorName. The supported fields are any combination of: primaryContactEmail,kycState
533
- }
534
-
535
- begin
536
- # List Payor Links
537
- result = api_instance.payor_links(opts)
538
- p result
539
- rescue VeloPayments::ApiError => e
540
- puts "Error when calling PayorsApi->payor_links: #{e}"
541
- end
542
- ```
543
-
544
- #### Using the payor_links_with_http_info variant
545
-
546
- This returns an Array which contains the response data, status code and headers.
547
-
548
- > <Array(<PayorLinksResponse>, Integer, Hash)> payor_links_with_http_info(opts)
549
-
550
- ```ruby
551
- begin
552
- # List Payor Links
553
- data, status_code, headers = api_instance.payor_links_with_http_info(opts)
554
- p status_code # => 2xx
555
- p headers # => { ... }
556
- p data # => <PayorLinksResponse>
557
- rescue VeloPayments::ApiError => e
558
- puts "Error when calling PayorsApi->payor_links_with_http_info: #{e}"
559
- end
560
- ```
561
-
562
- ### Parameters
563
-
564
- | Name | Type | Description | Notes |
565
- | ---- | ---- | ----------- | ----- |
566
- | **descendants_of_payor** | **String** | The Payor ID from which to start the query to show all descendants | [optional] |
567
- | **parent_of_payor** | **String** | Look for the parent payor details for this payor id | [optional] |
568
- | **fields** | **String** | List of additional Payor fields to include in the response for each Payor. The values of payorId and payorName and always included for each Payor - &#39;fields&#39; allows you to add to this. Example: &#x60;&#x60;&#x60;fields&#x3D;primaryContactEmail,kycState&#x60;&#x60;&#x60; - will include payorId+payorName+primaryContactEmail+kycState for each Payor Default if not specified is to include only payorId and payorName. The supported fields are any combination of: primaryContactEmail,kycState | [optional] |
569
-
570
- ### Return type
571
-
572
- [**PayorLinksResponse**](PayorLinksResponse.md)
573
-
574
- ### Authorization
575
-
576
- [OAuth2](../README.md#OAuth2)
577
-
578
- ### HTTP request headers
579
-
580
- - **Content-Type**: Not defined
581
- - **Accept**: application/json
582
-
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **schedule_status** | [**ScheduleStatus**](ScheduleStatus.md) | | |
7
+ | **schedule_status** | **String** | Current status of the payout schedule. One of the following values: SCHEDULED, EXECUTED, FAILED | |
8
8
  | **scheduled_at** | **Time** | | |
9
9
  | **scheduled_for** | **Time** | | |
10
10
  | **scheduled_by_principal_id** | **String** | ID of the user or application that scheduled the payout | |
@@ -17,7 +17,7 @@
17
17
  require 'velopayments'
18
18
 
19
19
  instance = VeloPayments::PayoutSchedule.new(
20
- schedule_status: null,
20
+ schedule_status: SCHEDULED,
21
21
  scheduled_at: null,
22
22
  scheduled_for: null,
23
23
  scheduled_by_principal_id: 8946953b-1e3b-49cf-9da4-b704cbb78f3e,
@@ -1,10 +1,10 @@
1
- # VeloPayments::PayoutSchedule2
1
+ # VeloPayments::PayoutScheduleV3
2
2
 
3
3
  ## Properties
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **schedule_status** | [**ScheduleStatus2**](ScheduleStatus2.md) | | |
7
+ | **schedule_status** | **String** | The current status of the payout schedule. One of the following values: SCHEDULED, EXECUTED, FAILED | |
8
8
  | **scheduled_at** | **Time** | | |
9
9
  | **scheduled_for** | **Time** | | |
10
10
  | **scheduled_by_principal_id** | **String** | ID of the user or application that scheduled the payout | |
@@ -15,8 +15,8 @@
15
15
  ```ruby
16
16
  require 'velopayments'
17
17
 
18
- instance = VeloPayments::PayoutSchedule2.new(
19
- schedule_status: null,
18
+ instance = VeloPayments::PayoutScheduleV3.new(
19
+ schedule_status: SCHEDULED,
20
20
  scheduled_at: null,
21
21
  scheduled_for: null,
22
22
  scheduled_by_principal_id: 8946953b-1e3b-49cf-9da4-b704cbb78f3e,
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **payout_id** | **String** | | [optional] |
8
8
  | **payor_id** | **String** | | [optional] |
9
- | **status** | [**PayoutStatus**](PayoutStatus.md) | | |
9
+ | **status** | **String** | Current status of the Payout. One of the following values: ACCEPTED, REJECTED, SUBMITTED, QUOTED, INSTRUCTED, COMPLETED, INCOMPLETE, CONFIRMED, WITHDRAWN | |
10
10
  | **date_time** | **Time** | | [optional] |
11
11
  | **submitted_date_time** | **String** | | |
12
12
  | **instructed_date_time** | **String** | | [optional] |
@@ -18,7 +18,7 @@
18
18
  | **source_account_summary** | [**Array&lt;SourceAccountSummary&gt;**](SourceAccountSummary.md) | | [optional] |
19
19
  | **fx_summaries** | [**Array&lt;FxSummary&gt;**](FxSummary.md) | | [optional] |
20
20
  | **payout_memo** | **String** | | [optional] |
21
- | **payout_type** | [**PayoutType**](PayoutType.md) | | |
21
+ | **payout_type** | **String** | The type of payout. One of the following values: STANDARD, AS, ON_BEHALF_OF | |
22
22
  | **payor_name** | **String** | | |
23
23
  | **schedule** | [**PayoutSchedule**](PayoutSchedule.md) | | [optional] |
24
24
 
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **payout_id** | **String** | | |
8
8
  | **payor_id** | **String** | | [optional] |
9
- | **status** | [**PayoutStatusV3**](PayoutStatusV3.md) | | |
9
+ | **status** | **String** | Current status of the payout. One of the following values: ACCEPTED, REJECTED, SUBMITTED, QUOTED, INSTRUCTED, COMPLETED, INCOMPLETE, CONFIRMED, WITHDRAWN | |
10
10
  | **submitted_date_time** | **String** | | |
11
11
  | **instructed_date_time** | **String** | | [optional] |
12
12
  | **withdrawn_date_time** | **String** | | [optional] |
@@ -4,17 +4,17 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **payout_id** | **String** | | [optional] |
8
- | **status** | **String** | | [optional] |
9
- | **payments_submitted** | **Integer** | | [optional] |
10
- | **payments_accepted** | **Integer** | | [optional] |
11
- | **payments_rejected** | **Integer** | | [optional] |
12
- | **payments_withdrawn** | **Integer** | | |
7
+ | **payout_id** | **String** | The id of the payout | [optional] |
8
+ | **status** | **String** | The status of the payout (one of SUBMITTED, ACCEPTED, REJECTED, QUOTED, INSTRUCTED, COMPLETED, INCOMPLETE, WITHDRAWN) | [optional] |
9
+ | **payments_submitted** | **Integer** | The number of payments that were submitted in the payout | [optional] |
10
+ | **payments_accepted** | **Integer** | The number of payments that were accepted in the payout | [optional] |
11
+ | **payments_rejected** | **Integer** | The number of payments that were rejected in the payout | [optional] |
12
+ | **payments_withdrawn** | **Integer** | The number of payments that were withdrawn in the payout | |
13
13
  | **fx_summaries** | [**Array&lt;QuoteFxSummaryV3&gt;**](QuoteFxSummaryV3.md) | | |
14
14
  | **accounts** | [**Array&lt;SourceAccountV3&gt;**](SourceAccountV3.md) | | |
15
15
  | **accepted_payments** | [**Array&lt;AcceptedPaymentV3&gt;**](AcceptedPaymentV3.md) | | |
16
16
  | **rejected_payments** | [**Array&lt;RejectedPaymentV3&gt;**](RejectedPaymentV3.md) | | |
17
- | **schedule** | [**PayoutSchedule2**](PayoutSchedule2.md) | | [optional] |
17
+ | **schedule** | [**PayoutScheduleV3**](PayoutScheduleV3.md) | | [optional] |
18
18
 
19
19
  ## Example
20
20
 
@@ -22,11 +22,11 @@
22
22
  require 'velopayments'
23
23
 
24
24
  instance = VeloPayments::PayoutSummaryResponseV3.new(
25
- payout_id: null,
25
+ payout_id: cf81e490-4ab8-49c2-bd68-9d1e725480cb,
26
26
  status: COMPLETED,
27
27
  payments_submitted: 10,
28
- payments_accepted: 10,
29
- payments_rejected: 0,
28
+ payments_accepted: 9,
29
+ payments_rejected: 1,
30
30
  payments_withdrawn: 0,
31
31
  fx_summaries: null,
32
32
  accounts: null,