velopayments 2.11.73 → 2.14.90.pre.1

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 (360) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/Makefile +7 -1
  4. data/README.md +82 -26
  5. data/docs/Address.md +5 -5
  6. data/docs/AuthApi.md +65 -0
  7. data/docs/AuthResponse.md +25 -0
  8. data/docs/AutoTopUpConfig.md +21 -0
  9. data/docs/Company.md +3 -1
  10. data/docs/CreateIndividual.md +21 -0
  11. data/docs/CreatePayee.md +3 -25
  12. data/docs/CreatePayeeAddress.md +31 -0
  13. data/docs/CreatePayeesCSVRequest.md +17 -15
  14. data/docs/CreatePayoutRequest.md +1 -1
  15. data/docs/FundingManagerApi.md +180 -10
  16. data/docs/{FundingRequest.md → FundingRequestV1.md} +2 -2
  17. data/docs/{FundingRequest2.md → FundingRequestV2.md} +2 -2
  18. data/docs/FxSummaryV3.md +35 -0
  19. data/docs/{FxSummary.md → FxSummaryV4.md} +7 -7
  20. data/docs/GetFundingsResponseAllOf.md +17 -0
  21. data/docs/GetPaymentsForPayoutResponseV3.md +23 -0
  22. data/docs/GetPaymentsForPayoutResponseV3Page.md +25 -0
  23. data/docs/GetPaymentsForPayoutResponseV3Summary.md +33 -0
  24. data/docs/GetPaymentsForPayoutResponseV4.md +23 -0
  25. data/docs/GetPaymentsForPayoutResponseV4Summary.md +33 -0
  26. data/docs/GetPayoutsResponseV3.md +23 -0
  27. data/docs/GetPayoutsResponseV3Links.md +19 -0
  28. data/docs/GetPayoutsResponseV3Page.md +25 -0
  29. data/docs/GetPayoutsResponseV3Summary.md +25 -0
  30. data/docs/GetPayoutsResponseV4.md +23 -0
  31. data/docs/Individual.md +2 -2
  32. data/docs/{PaymentAuditCurrency.md → InvitationStatus.md} +2 -2
  33. data/docs/ListPaymentsResponse.md +4 -4
  34. data/docs/ListPaymentsResponsePage.md +25 -0
  35. data/docs/ListPaymentsResponseSummary.md +25 -0
  36. data/docs/ListSourceAccountResponse.md +2 -2
  37. data/docs/ListSourceAccountResponseLinks.md +19 -0
  38. data/docs/ListSourceAccountResponsePage.md +25 -0
  39. data/docs/ListSourceAccountResponseV2.md +21 -0
  40. data/docs/ListSourceAccountResponseV2Page.md +25 -0
  41. data/docs/Notifications.md +17 -0
  42. data/docs/PagedPayeeInvitationStatusResponse.md +21 -0
  43. data/docs/Payee.md +1 -3
  44. data/docs/PayeeDelta.md +29 -0
  45. data/docs/PayeeDeltaResponse.md +21 -0
  46. data/docs/PayeeDeltaResponseLinks.md +19 -0
  47. data/docs/PayeeDeltaResponsePage.md +25 -0
  48. data/docs/PayeeInvitationApi.md +68 -5
  49. data/docs/PayeeInvitationStatus.md +1 -1
  50. data/docs/PayeeInvitationStatusResponse.md +21 -0
  51. data/docs/PayeeResponse.md +3 -3
  52. data/docs/{GetPaymentsForPayoutResponseLinks.md → PayeeResponseLinks.md} +2 -2
  53. data/docs/{GetPaymentsForPayoutResponsePage.md → PayeeResponsePage.md} +2 -2
  54. data/docs/{GetPaymentsForPayoutResponseSummary.md → PayeeResponseSummary.md} +2 -2
  55. data/docs/PayeesApi.md +61 -0
  56. data/docs/PaymentAuditCurrencyV3.md +16 -0
  57. data/docs/PaymentAuditCurrencyV4.md +16 -0
  58. data/docs/PaymentAuditServiceApi.md +302 -6
  59. data/docs/PaymentEventResponseV3.md +39 -0
  60. data/docs/{PaymentEventResponse.md → PaymentEventResponseV4.md} +8 -8
  61. data/docs/PaymentInstruction.md +6 -6
  62. data/docs/PaymentResponseV3.md +81 -0
  63. data/docs/{PaymentResponse.md → PaymentResponseV4.md} +5 -5
  64. data/docs/PayorApplicationsApi.md +1 -1
  65. data/docs/PayorBrandingResponse.md +5 -5
  66. data/docs/PayorCreateApiKeyRequest.md +3 -3
  67. data/docs/PayorCreateApiKeyResponse.md +2 -2
  68. data/docs/PayorCreateApplicationRequest.md +2 -2
  69. data/docs/PayorEmailOptOutRequest.md +1 -1
  70. data/docs/PayorFundingBankDetailsUpdate.md +3 -3
  71. data/docs/PayorLinksResponse.md +19 -0
  72. data/docs/PayorLinksResponseLinks.md +23 -0
  73. data/docs/PayorLinksResponsePayors.md +23 -0
  74. data/docs/PayorRef.md +2 -2
  75. data/docs/{Payor.md → PayorV1.md} +15 -15
  76. data/docs/PayorV2.md +49 -0
  77. data/docs/PayorsApi.md +116 -6
  78. data/docs/PayoutHistoryApi.md +81 -2
  79. data/docs/{PayoutStatus.md → PayoutStatusV3.md} +2 -2
  80. data/docs/PayoutStatusV4.md +16 -0
  81. data/docs/PayoutSummaryAuditV3.md +41 -0
  82. data/docs/{PayoutSummaryAudit.md → PayoutSummaryAuditV4.md} +9 -7
  83. data/docs/PayoutSummaryResponse.md +4 -4
  84. data/docs/QuoteFxSummary.md +10 -10
  85. data/docs/RejectedPayment.md +10 -8
  86. data/docs/SetNotificationsRequest.md +17 -0
  87. data/docs/SourceAccount.md +3 -3
  88. data/docs/SourceAccountResponse.md +11 -9
  89. data/docs/SourceAccountResponseV2.md +45 -0
  90. data/docs/SourceAccountSummaryV3.md +21 -0
  91. data/docs/SourceAccountSummaryV4.md +21 -0
  92. data/docs/SubmitPayoutApi.md +2 -2
  93. data/docs/SupportedCountry.md +2 -2
  94. data/lib/velopayments.rb +58 -18
  95. data/lib/velopayments/api/auth_api.rb +88 -0
  96. data/lib/velopayments/api/countries_api.rb +35 -17
  97. data/lib/velopayments/api/currencies_api.rb +19 -10
  98. data/lib/velopayments/api/funding_manager_api.rb +323 -69
  99. data/lib/velopayments/api/get_payout_api.rb +20 -11
  100. data/lib/velopayments/api/instruct_payout_api.rb +21 -11
  101. data/lib/velopayments/api/payee_invitation_api.rb +150 -40
  102. data/lib/velopayments/api/payees_api.rb +130 -26
  103. data/lib/velopayments/api/payment_audit_service_api.rb +481 -55
  104. data/lib/velopayments/api/payor_applications_api.rb +40 -21
  105. data/lib/velopayments/api/payors_api.rb +209 -43
  106. data/lib/velopayments/api/payout_history_api.rb +141 -21
  107. data/lib/velopayments/api/quote_payout_api.rb +20 -11
  108. data/lib/velopayments/api/submit_payout_api.rb +22 -12
  109. data/lib/velopayments/api/withdraw_payout_api.rb +21 -11
  110. data/lib/velopayments/api_client.rb +3 -4
  111. data/lib/velopayments/api_error.rb +2 -2
  112. data/lib/velopayments/configuration.rb +7 -6
  113. data/lib/velopayments/models/address.rb +2 -2
  114. data/lib/velopayments/models/auth_response.rb +242 -0
  115. data/lib/velopayments/models/auto_top_up_config.rb +222 -0
  116. data/lib/velopayments/models/challenge.rb +2 -2
  117. data/lib/velopayments/models/company.rb +39 -6
  118. data/lib/velopayments/models/create_individual.rb +249 -0
  119. data/lib/velopayments/models/create_payee.rb +7 -109
  120. data/lib/velopayments/models/create_payee_address.rb +478 -0
  121. data/lib/velopayments/models/create_payees_csv_request.rb +268 -183
  122. data/lib/velopayments/models/create_payees_csv_response.rb +2 -2
  123. data/lib/velopayments/models/create_payees_request.rb +2 -2
  124. data/lib/velopayments/models/create_payment_channel.rb +9 -15
  125. data/lib/velopayments/models/create_payout_request.rb +2 -2
  126. data/lib/velopayments/models/failed_submission.rb +2 -2
  127. data/lib/velopayments/models/funding_audit.rb +2 -2
  128. data/lib/velopayments/models/funding_event.rb +2 -2
  129. data/lib/velopayments/models/funding_event_type.rb +2 -2
  130. data/lib/velopayments/models/{funding_request.rb → funding_request_v1.rb} +5 -5
  131. data/lib/velopayments/models/{funding_request2.rb → funding_request_v2.rb} +5 -5
  132. data/lib/velopayments/models/{fx_summary.rb → fx_summary_v3.rb} +7 -7
  133. data/lib/velopayments/models/fx_summary_v4.rb +363 -0
  134. data/lib/velopayments/models/get_fundings_response.rb +3 -2
  135. data/lib/velopayments/models/get_fundings_response_all_of.rb +196 -0
  136. data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +228 -0
  137. data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +232 -0
  138. data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +311 -0
  139. data/lib/velopayments/models/{get_payments_for_payout_response.rb → get_payments_for_payout_response_v4.rb} +9 -9
  140. data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +311 -0
  141. data/lib/velopayments/models/get_payout_statistics.rb +2 -2
  142. data/lib/velopayments/models/{get_payouts_response.rb → get_payouts_response_v3.rb} +9 -9
  143. data/lib/velopayments/models/{get_payments_for_payout_response_links.rb → get_payouts_response_v3_links.rb} +5 -5
  144. data/lib/velopayments/models/{get_payments_for_payout_response_page.rb → get_payouts_response_v3_page.rb} +5 -5
  145. data/lib/velopayments/models/{get_payments_for_payout_response_summary.rb → get_payouts_response_v3_summary.rb} +5 -5
  146. data/lib/velopayments/models/get_payouts_response_v4.rb +228 -0
  147. data/lib/velopayments/models/individual.rb +6 -4
  148. data/lib/velopayments/models/individual_name.rb +2 -2
  149. data/lib/velopayments/models/invitation_status.rb +37 -0
  150. data/lib/velopayments/models/invitation_status_response.rb +2 -2
  151. data/lib/velopayments/models/invite_payee_request.rb +2 -2
  152. data/lib/velopayments/models/language.rb +2 -2
  153. data/lib/velopayments/models/list_payments_response.rb +6 -6
  154. data/lib/velopayments/models/list_payments_response_page.rb +232 -0
  155. data/lib/velopayments/models/list_payments_response_summary.rb +232 -0
  156. data/lib/velopayments/models/list_source_account_response.rb +4 -4
  157. data/lib/velopayments/models/{social.rb → list_source_account_response_links.rb} +18 -27
  158. data/lib/velopayments/models/list_source_account_response_page.rb +232 -0
  159. data/lib/velopayments/models/list_source_account_response_v2.rb +219 -0
  160. data/lib/velopayments/models/list_source_account_response_v2_page.rb +232 -0
  161. data/lib/velopayments/models/marketing_opt_in.rb +2 -2
  162. data/lib/velopayments/models/notifications.rb +196 -0
  163. data/lib/velopayments/models/ofac_status.rb +2 -2
  164. data/lib/velopayments/models/onboarded_status.rb +2 -2
  165. data/lib/velopayments/models/paged_payee_invitation_status_response.rb +219 -0
  166. data/lib/velopayments/models/paged_response.rb +2 -2
  167. data/lib/velopayments/models/paged_response_page.rb +2 -2
  168. data/lib/velopayments/models/payee.rb +6 -15
  169. data/lib/velopayments/models/payee_delta.rb +288 -0
  170. data/lib/velopayments/models/payee_delta_response.rb +219 -0
  171. data/lib/velopayments/models/payee_delta_response_links.rb +205 -0
  172. data/lib/velopayments/models/payee_delta_response_page.rb +232 -0
  173. data/lib/velopayments/models/payee_invitation_status.rb +2 -2
  174. data/lib/velopayments/models/payee_invitation_status_response.rb +224 -0
  175. data/lib/velopayments/models/payee_response.rb +5 -5
  176. data/lib/velopayments/models/payee_response_links.rb +205 -0
  177. data/lib/velopayments/models/payee_response_page.rb +232 -0
  178. data/lib/velopayments/models/payee_response_summary.rb +232 -0
  179. data/lib/velopayments/models/payee_type.rb +2 -2
  180. data/lib/velopayments/models/{payment_audit_currency.rb → payment_audit_currency_v3.rb} +5 -5
  181. data/lib/velopayments/models/payment_audit_currency_v4.rb +37 -0
  182. data/lib/velopayments/models/payment_channel.rb +2 -2
  183. data/lib/velopayments/models/payment_channel_country.rb +2 -2
  184. data/lib/velopayments/models/payment_channel_rule.rb +2 -2
  185. data/lib/velopayments/models/payment_channel_rules_response.rb +2 -2
  186. data/lib/velopayments/models/{payment_event_response.rb → payment_event_response_v3.rb} +9 -9
  187. data/lib/velopayments/models/payment_event_response_v4.rb +351 -0
  188. data/lib/velopayments/models/payment_instruction.rb +2 -2
  189. data/lib/velopayments/models/{payment_response.rb → payment_response_v3.rb} +8 -8
  190. data/lib/velopayments/models/payment_response_v4.rb +587 -0
  191. data/lib/velopayments/models/payor_branding_response.rb +2 -2
  192. data/lib/velopayments/models/payor_create_api_key_request.rb +2 -2
  193. data/lib/velopayments/models/payor_create_api_key_response.rb +2 -2
  194. data/lib/velopayments/models/payor_create_application_request.rb +2 -2
  195. data/lib/velopayments/models/payor_email_opt_out_request.rb +7 -2
  196. data/lib/velopayments/models/payor_funding_bank_details_update.rb +2 -2
  197. data/lib/velopayments/models/payor_links_response.rb +210 -0
  198. data/lib/velopayments/models/payor_links_response_links.rb +277 -0
  199. data/lib/velopayments/models/payor_links_response_payors.rb +267 -0
  200. data/lib/velopayments/models/payor_logo_request.rb +2 -2
  201. data/lib/velopayments/models/payor_ref.rb +2 -2
  202. data/lib/velopayments/models/{payor.rb → payor_v1.rb} +6 -6
  203. data/lib/velopayments/models/payor_v2.rb +405 -0
  204. data/lib/velopayments/models/{payout_status.rb → payout_status_v3.rb} +5 -5
  205. data/lib/velopayments/models/payout_status_v4.rb +43 -0
  206. data/lib/velopayments/models/{payout_summary_audit.rb → payout_summary_audit_v3.rb} +18 -9
  207. data/lib/velopayments/models/payout_summary_audit_v4.rb +323 -0
  208. data/lib/velopayments/models/payout_summary_response.rb +2 -2
  209. data/lib/velopayments/models/query_batch_response.rb +2 -2
  210. data/lib/velopayments/models/quote_fx_summary.rb +4 -4
  211. data/lib/velopayments/models/quote_response.rb +2 -2
  212. data/lib/velopayments/models/rejected_payment.rb +37 -34
  213. data/lib/velopayments/models/set_notifications_request.rb +230 -0
  214. data/lib/velopayments/models/source_account.rb +2 -2
  215. data/lib/velopayments/models/source_account_response.rb +16 -7
  216. data/lib/velopayments/models/source_account_response_v2.rb +403 -0
  217. data/lib/velopayments/models/{source_account_summary.rb → source_account_summary_v3.rb} +7 -7
  218. data/lib/velopayments/models/source_account_summary_v4.rb +224 -0
  219. data/lib/velopayments/models/supported_countries_response.rb +2 -2
  220. data/lib/velopayments/models/supported_country.rb +36 -2
  221. data/lib/velopayments/models/supported_currency.rb +2 -2
  222. data/lib/velopayments/models/supported_currency_response.rb +2 -2
  223. data/lib/velopayments/version.rb +3 -3
  224. data/oa3-config.json +1 -1
  225. data/spec/api/auth_api_spec.rb +48 -0
  226. data/spec/api/countries_api_spec.rb +2 -2
  227. data/spec/api/currencies_api_spec.rb +2 -2
  228. data/spec/api/funding_manager_api_spec.rb +45 -4
  229. data/spec/api/get_payout_api_spec.rb +2 -2
  230. data/spec/api/instruct_payout_api_spec.rb +2 -2
  231. data/spec/api/payee_invitation_api_spec.rb +20 -4
  232. data/spec/api/payees_api_spec.rb +17 -2
  233. data/spec/api/payment_audit_service_api_spec.rb +91 -5
  234. data/spec/api/payor_applications_api_spec.rb +3 -3
  235. data/spec/api/payors_api_spec.rb +31 -6
  236. data/spec/api/payout_history_api_spec.rb +27 -3
  237. data/spec/api/quote_payout_api_spec.rb +2 -2
  238. data/spec/api/submit_payout_api_spec.rb +3 -3
  239. data/spec/api/withdraw_payout_api_spec.rb +2 -2
  240. data/spec/api_client_spec.rb +2 -2
  241. data/spec/configuration_spec.rb +2 -2
  242. data/spec/models/address_spec.rb +2 -2
  243. data/spec/models/auth_response_spec.rb +65 -0
  244. data/spec/models/{social_spec.rb → auto_top_up_config_spec.rb} +11 -11
  245. data/spec/models/challenge_spec.rb +2 -2
  246. data/spec/models/company_spec.rb +8 -2
  247. data/spec/models/create_individual_spec.rb +53 -0
  248. data/spec/models/create_payee_address_spec.rb +83 -0
  249. data/spec/models/create_payee_spec.rb +2 -68
  250. data/spec/models/create_payees_csv_request_spec.rb +26 -16
  251. data/spec/models/create_payees_csv_response_spec.rb +2 -2
  252. data/spec/models/create_payees_request_spec.rb +2 -2
  253. data/spec/models/create_payment_channel_spec.rb +6 -2
  254. data/spec/models/create_payout_request_spec.rb +2 -2
  255. data/spec/models/failed_submission_spec.rb +2 -2
  256. data/spec/models/funding_audit_spec.rb +2 -2
  257. data/spec/models/funding_event_spec.rb +2 -2
  258. data/spec/models/funding_event_type_spec.rb +2 -2
  259. data/spec/models/{funding_request2_spec.rb → funding_request_v1_spec.rb} +8 -8
  260. data/spec/models/{funding_request_spec.rb → funding_request_v2_spec.rb} +8 -8
  261. data/spec/models/{fx_summary_spec.rb → fx_summary_v3_spec.rb} +8 -8
  262. data/spec/models/fx_summary_v4_spec.rb +103 -0
  263. data/spec/models/get_fundings_response_all_of_spec.rb +41 -0
  264. data/spec/models/get_fundings_response_spec.rb +2 -2
  265. data/spec/models/{get_payments_for_payout_response_page_spec.rb → get_payments_for_payout_response_v3_page_spec.rb} +8 -8
  266. data/spec/models/{get_payments_for_payout_response_spec.rb → get_payments_for_payout_response_v3_spec.rb} +8 -8
  267. data/spec/models/get_payments_for_payout_response_v3_summary_spec.rb +93 -0
  268. data/spec/models/get_payments_for_payout_response_v4_spec.rb +59 -0
  269. data/spec/models/get_payments_for_payout_response_v4_summary_spec.rb +93 -0
  270. data/spec/models/get_payout_statistics_spec.rb +2 -2
  271. data/spec/models/get_payouts_response_v3_links_spec.rb +47 -0
  272. data/spec/models/get_payouts_response_v3_page_spec.rb +65 -0
  273. data/spec/models/{get_payouts_response_spec.rb → get_payouts_response_v3_spec.rb} +8 -8
  274. data/spec/models/{get_payments_for_payout_response_summary_spec.rb → get_payouts_response_v3_summary_spec.rb} +8 -8
  275. data/spec/models/get_payouts_response_v4_spec.rb +59 -0
  276. data/spec/models/individual_name_spec.rb +2 -2
  277. data/spec/models/individual_spec.rb +2 -2
  278. data/spec/models/invitation_status_response_spec.rb +2 -2
  279. data/spec/models/invitation_status_spec.rb +35 -0
  280. data/spec/models/invite_payee_request_spec.rb +2 -2
  281. data/spec/models/language_spec.rb +2 -2
  282. data/spec/models/list_payments_response_page_spec.rb +65 -0
  283. data/spec/models/list_payments_response_spec.rb +2 -2
  284. data/spec/models/list_payments_response_summary_spec.rb +65 -0
  285. data/spec/models/{get_payments_for_payout_response_links_spec.rb → list_source_account_response_links_spec.rb} +8 -8
  286. data/spec/models/list_source_account_response_page_spec.rb +65 -0
  287. data/spec/models/list_source_account_response_spec.rb +2 -2
  288. data/spec/models/list_source_account_response_v2_page_spec.rb +65 -0
  289. data/spec/models/list_source_account_response_v2_spec.rb +53 -0
  290. data/spec/models/marketing_opt_in_spec.rb +2 -2
  291. data/spec/models/notifications_spec.rb +41 -0
  292. data/spec/models/ofac_status_spec.rb +2 -2
  293. data/spec/models/onboarded_status_spec.rb +2 -2
  294. data/spec/models/paged_payee_invitation_status_response_spec.rb +53 -0
  295. data/spec/models/paged_response_page_spec.rb +2 -2
  296. data/spec/models/paged_response_spec.rb +2 -2
  297. data/spec/models/payee_delta_response_links_spec.rb +47 -0
  298. data/spec/models/payee_delta_response_page_spec.rb +65 -0
  299. data/spec/models/payee_delta_response_spec.rb +53 -0
  300. data/spec/models/payee_delta_spec.rb +77 -0
  301. data/spec/models/payee_invitation_status_response_spec.rb +53 -0
  302. data/spec/models/payee_invitation_status_spec.rb +2 -2
  303. data/spec/models/payee_response_links_spec.rb +47 -0
  304. data/spec/models/payee_response_page_spec.rb +65 -0
  305. data/spec/models/payee_response_spec.rb +2 -2
  306. data/spec/models/payee_response_summary_spec.rb +65 -0
  307. data/spec/models/payee_spec.rb +2 -8
  308. data/spec/models/payee_type_spec.rb +2 -2
  309. data/spec/models/{payment_audit_currency_spec.rb → payment_audit_currency_v3_spec.rb} +8 -8
  310. data/spec/models/payment_audit_currency_v4_spec.rb +35 -0
  311. data/spec/models/payment_channel_country_spec.rb +2 -2
  312. data/spec/models/payment_channel_rule_spec.rb +2 -2
  313. data/spec/models/payment_channel_rules_response_spec.rb +2 -2
  314. data/spec/models/payment_channel_spec.rb +2 -2
  315. data/spec/models/{payment_event_response_spec.rb → payment_event_response_v3_spec.rb} +8 -8
  316. data/spec/models/payment_event_response_v4_spec.rb +111 -0
  317. data/spec/models/payment_instruction_spec.rb +2 -2
  318. data/spec/models/{payment_response_spec.rb → payment_response_v3_spec.rb} +8 -8
  319. data/spec/models/payment_response_v4_spec.rb +241 -0
  320. data/spec/models/payor_branding_response_spec.rb +2 -2
  321. data/spec/models/payor_create_api_key_request_spec.rb +2 -2
  322. data/spec/models/payor_create_api_key_response_spec.rb +2 -2
  323. data/spec/models/payor_create_application_request_spec.rb +2 -2
  324. data/spec/models/payor_email_opt_out_request_spec.rb +2 -2
  325. data/spec/models/payor_funding_bank_details_update_spec.rb +2 -2
  326. data/spec/models/payor_links_response_links_spec.rb +63 -0
  327. data/spec/models/payor_links_response_payors_spec.rb +63 -0
  328. data/spec/models/payor_links_response_spec.rb +47 -0
  329. data/spec/models/payor_logo_request_spec.rb +2 -2
  330. data/spec/models/payor_ref_spec.rb +2 -2
  331. data/spec/models/{payor_spec.rb → payor_v1_spec.rb} +8 -8
  332. data/spec/models/payor_v2_spec.rb +145 -0
  333. data/spec/models/{payout_status_spec.rb → payout_status_v3_spec.rb} +8 -8
  334. data/spec/models/payout_status_v4_spec.rb +35 -0
  335. data/spec/models/{payout_summary_audit_spec.rb → payout_summary_audit_v3_spec.rb} +14 -8
  336. data/spec/models/payout_summary_audit_v4_spec.rb +113 -0
  337. data/spec/models/payout_summary_response_spec.rb +2 -2
  338. data/spec/models/query_batch_response_spec.rb +2 -2
  339. data/spec/models/quote_fx_summary_spec.rb +2 -2
  340. data/spec/models/quote_response_spec.rb +2 -2
  341. data/spec/models/rejected_payment_spec.rb +8 -6
  342. data/spec/models/set_notifications_request_spec.rb +41 -0
  343. data/spec/models/source_account_response_spec.rb +8 -2
  344. data/spec/models/source_account_response_v2_spec.rb +129 -0
  345. data/spec/models/source_account_spec.rb +2 -2
  346. data/spec/models/{source_account_summary_spec.rb → source_account_summary_v3_spec.rb} +8 -8
  347. data/spec/models/source_account_summary_v4_spec.rb +53 -0
  348. data/spec/models/supported_countries_response_spec.rb +2 -2
  349. data/spec/models/supported_country_spec.rb +10 -2
  350. data/spec/models/supported_currency_response_spec.rb +2 -2
  351. data/spec/models/supported_currency_spec.rb +2 -2
  352. data/spec/spec_helper.rb +2 -2
  353. data/velopayments-2.11.73.gem +0 -0
  354. data/velopayments-2.14.90.gem +0 -0
  355. data/velopayments.gemspec +2 -2
  356. metadata +230 -68
  357. data/docs/GetPaymentsForPayoutResponse.md +0 -23
  358. data/docs/GetPayoutsResponse.md +0 -23
  359. data/docs/Social.md +0 -21
  360. data/docs/SourceAccountSummary.md +0 -21
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 7b20488f32b4d4e970188356ea2c546e1b635398
4
- data.tar.gz: '065478cdce0226559bea264d1201d99416bf8961'
3
+ metadata.gz: d822cfebf97ae05ba93c085c224947a7aaa8eb9b
4
+ data.tar.gz: 2df5a539163233f0d15d77bc6cd540673183c604
5
5
  SHA512:
6
- metadata.gz: 79507ee9df11d7f53581ef9dbe0649e1e0046da28cd89fe29821112230a43ee3226d676ef375161bd56af8539e2cd20b274beca8402699b26da711a6e77ca7da
7
- data.tar.gz: d00fad2384280411893522e65b510e3a454b81da3a68dd17fdc68cff90bf29cf3a76ff0a69120846999f3b755f1a03b321795f8496ca49843da25340b3d782b2
6
+ metadata.gz: 32b11f6b9b896d18d554d5d0830bc970a9497df618c9c977a8651fd042224e0ab0729c95cb7943f804c7c2150945fe8c5907a76ff2a7b2fb3adb4773026f142b
7
+ data.tar.gz: 187667a56eb739e9bf4073362970c987aab1a5806ed89e3248ac91cb02d36a03f97993f9bd33cf3c65e10153475c2ee2fa5d1452ae07f8ee0b7395b3dc95ba38
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- velopayments (2.11.73)
4
+ velopayments (2.14.90.pre.1)
5
5
  json (~> 2.1, >= 2.1.0)
6
6
  typhoeus (~> 1.0, >= 1.0.1)
7
7
 
data/Makefile CHANGED
@@ -36,4 +36,10 @@ trim:
36
36
  info:
37
37
  sed -i.bak '1s/.*/# Ruby client for Velo/' README.md && rm README.md.bak
38
38
 
39
- client: clean ruby-client trim info
39
+ client: clean ruby-client trim info
40
+
41
+ candidate:
42
+ gem build velopayments.gemspec
43
+
44
+ release:
45
+ @echo "test"
data/README.md CHANGED
@@ -79,8 +79,8 @@ If you make other Velo API calls which require authorization but the Authorizati
79
79
 
80
80
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
81
81
 
82
- - API version: 2.11.73
83
- - Package version: 2.11.73
82
+ - API version: 2.14.92
83
+ - Package version: 2.14.90.pre.1
84
84
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
85
85
 
86
86
  ## Installation
@@ -96,16 +96,16 @@ gem build velopayments.gemspec
96
96
  Then either install the gem locally:
97
97
 
98
98
  ```shell
99
- gem install ./velopayments-2.11.73.gem
99
+ gem install ./velopayments-2.14.90.pre.1.gem
100
100
  ```
101
101
 
102
- (for development, run `gem install --dev ./velopayments-2.11.73.gem` to install the development dependencies)
102
+ (for development, run `gem install --dev ./velopayments-2.14.90.pre.1.gem` to install the development dependencies)
103
103
 
104
104
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
105
105
 
106
106
  Finally add this to the Gemfile:
107
107
 
108
- gem 'velopayments', '~> 2.11.73'
108
+ gem 'velopayments', '~> 2.14.90.pre.1'
109
109
 
110
110
  ### Install from Git
111
111
 
@@ -135,14 +135,18 @@ VeloPayments.configure do |config|
135
135
  config.access_token = 'YOUR ACCESS TOKEN'
136
136
  end
137
137
 
138
- api_instance = VeloPayments::CountriesApi.new
138
+ api_instance = VeloPayments::AuthApi.new
139
+ authorization = 'authorization_example' # String | String value of Basic and a Base64 endcoded string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. Basic 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529
140
+ opts = {
141
+ grant_type: 'client_credentials' # String | OAuth grant type. Should use 'client_credentials'
142
+ }
139
143
 
140
144
  begin
141
- #List Supported Countries
142
- result = api_instance.list_supported_countries
145
+ #Authentication endpoint
146
+ result = api_instance.velo_auth(authorization, opts)
143
147
  p result
144
148
  rescue VeloPayments::ApiError => e
145
- puts "Exception when calling CountriesApi->list_supported_countries: #{e}"
149
+ puts "Exception when calling AuthApi->velo_auth: #{e}"
146
150
  end
147
151
 
148
152
  ```
@@ -153,6 +157,7 @@ All URIs are relative to *https://api.sandbox.velopayments.com*
153
157
 
154
158
  Class | Method | HTTP request | Description
155
159
  ------------ | ------------- | ------------- | -------------
160
+ *VeloPayments::AuthApi* | [**velo_auth**](docs/AuthApi.md#velo_auth) | **POST** /v1/authenticate/ | Authentication endpoint
156
161
  *VeloPayments::CountriesApi* | [**list_supported_countries**](docs/CountriesApi.md#list_supported_countries) | **GET** /v1/supportedCountries | List Supported Countries
157
162
  *VeloPayments::CountriesApi* | [**v1_payment_channel_rules_get**](docs/CountriesApi.md#v1_payment_channel_rules_get) | **GET** /v1/paymentChannelRules | List Payment Channel Country Rules
158
163
  *VeloPayments::CurrenciesApi* | [**list_supported_currencies**](docs/CurrenciesApi.md#list_supported_currencies) | **GET** /v2/currencies | List Supported Currencies
@@ -160,30 +165,42 @@ Class | Method | HTTP request | Description
160
165
  *VeloPayments::FundingManagerApi* | [**create_funding_request**](docs/FundingManagerApi.md#create_funding_request) | **POST** /v2/sourceAccounts/{sourceAccountId}/fundingRequest | Create Funding Request
161
166
  *VeloPayments::FundingManagerApi* | [**get_fundings**](docs/FundingManagerApi.md#get_fundings) | **GET** /v1/paymentaudit/fundings | Get Fundings for Payor
162
167
  *VeloPayments::FundingManagerApi* | [**get_source_account**](docs/FundingManagerApi.md#get_source_account) | **GET** /v1/sourceAccounts/{sourceAccountId} | Get details about given source account.
168
+ *VeloPayments::FundingManagerApi* | [**get_source_account_v2**](docs/FundingManagerApi.md#get_source_account_v2) | **GET** /v2/sourceAccounts/{sourceAccountId} | Get details about given source account.
163
169
  *VeloPayments::FundingManagerApi* | [**get_source_accounts**](docs/FundingManagerApi.md#get_source_accounts) | **GET** /v1/sourceAccounts | Get list of source accounts
170
+ *VeloPayments::FundingManagerApi* | [**get_source_accounts_v2**](docs/FundingManagerApi.md#get_source_accounts_v2) | **GET** /v2/sourceAccounts | Get list of source accounts
171
+ *VeloPayments::FundingManagerApi* | [**set_notifications_request**](docs/FundingManagerApi.md#set_notifications_request) | **POST** /v1/sourceAccounts/{sourceAccountId}/notifications | Set notifications
164
172
  *VeloPayments::FundingManagerApi* | [**set_payor_funding_bank_details**](docs/FundingManagerApi.md#set_payor_funding_bank_details) | **POST** /v1/payors/{payorId}/payorFundingBankDetailsUpdate | Set Funding Bank Details
165
173
  *VeloPayments::GetPayoutApi* | [**v3_payouts_payout_id_get**](docs/GetPayoutApi.md#v3_payouts_payout_id_get) | **GET** /v3/payouts/{payoutId} | Get Payout Summary
166
174
  *VeloPayments::InstructPayoutApi* | [**v3_payouts_payout_id_post**](docs/InstructPayoutApi.md#v3_payouts_payout_id_post) | **POST** /v3/payouts/{payoutId} | Instruct Payout
167
- *VeloPayments::PayeeInvitationApi* | [**get_payor**](docs/PayeeInvitationApi.md#get_payor) | **GET** /v1/payees/payors/{payorId}/invitationStatus | Get Payee Invitation Status
175
+ *VeloPayments::PayeeInvitationApi* | [**get_payees_invitation_status**](docs/PayeeInvitationApi.md#get_payees_invitation_status) | **GET** /v1/payees/payors/{payorId}/invitationStatus | Get Payee Invitation Status
176
+ *VeloPayments::PayeeInvitationApi* | [**get_payees_invitation_status_v2**](docs/PayeeInvitationApi.md#get_payees_invitation_status_v2) | **GET** /v2/payees/payors/{payorId}/invitationStatus | Get Payee Invitation Status
168
177
  *VeloPayments::PayeeInvitationApi* | [**resend_payee_invite**](docs/PayeeInvitationApi.md#resend_payee_invite) | **POST** /v1/payees/{payeeId}/invite | Resend Payee Invite
169
178
  *VeloPayments::PayeeInvitationApi* | [**v2_create_payee**](docs/PayeeInvitationApi.md#v2_create_payee) | **POST** /v2/payees | Intiate Payee Creation
170
179
  *VeloPayments::PayeeInvitationApi* | [**v2_query_batch_status**](docs/PayeeInvitationApi.md#v2_query_batch_status) | **GET** /v2/payees/batch/{batchId} | Query Batch Status
171
180
  *VeloPayments::PayeesApi* | [**delete_payee_by_id**](docs/PayeesApi.md#delete_payee_by_id) | **DELETE** /v1/payees/{payeeId} | Delete Payee by Id
172
181
  *VeloPayments::PayeesApi* | [**get_payee_by_id**](docs/PayeesApi.md#get_payee_by_id) | **GET** /v1/payees/{payeeId} | Get Payee by Id
182
+ *VeloPayments::PayeesApi* | [**list_payee_changes**](docs/PayeesApi.md#list_payee_changes) | **GET** /v1/deltas/payees | List Payee Changes
173
183
  *VeloPayments::PayeesApi* | [**list_payees**](docs/PayeesApi.md#list_payees) | **GET** /v1/payees | List Payees
174
184
  *VeloPayments::PaymentAuditServiceApi* | [**export_transactions_csv**](docs/PaymentAuditServiceApi.md#export_transactions_csv) | **GET** /v4/paymentaudit/transactions | Export Transactions
175
185
  *VeloPayments::PaymentAuditServiceApi* | [**get_fundings**](docs/PaymentAuditServiceApi.md#get_fundings) | **GET** /v1/paymentaudit/fundings | Get Fundings for Payor
176
186
  *VeloPayments::PaymentAuditServiceApi* | [**get_payment_details**](docs/PaymentAuditServiceApi.md#get_payment_details) | **GET** /v3/paymentaudit/payments/{paymentId} | Get Payment
187
+ *VeloPayments::PaymentAuditServiceApi* | [**get_payment_details_v4**](docs/PaymentAuditServiceApi.md#get_payment_details_v4) | **GET** /v4/paymentaudit/payments/{paymentId} | Get Payment
177
188
  *VeloPayments::PaymentAuditServiceApi* | [**get_payments_for_payout**](docs/PaymentAuditServiceApi.md#get_payments_for_payout) | **GET** /v3/paymentaudit/payouts/{payoutId} | Get Payments for Payout
189
+ *VeloPayments::PaymentAuditServiceApi* | [**get_payments_for_payout_v4**](docs/PaymentAuditServiceApi.md#get_payments_for_payout_v4) | **GET** /v4/paymentaudit/payouts/{payoutId} | Get Payments for Payout
178
190
  *VeloPayments::PaymentAuditServiceApi* | [**get_payouts_for_payor**](docs/PaymentAuditServiceApi.md#get_payouts_for_payor) | **GET** /v3/paymentaudit/payouts | Get Payouts for Payor
191
+ *VeloPayments::PaymentAuditServiceApi* | [**get_payouts_for_payor_v4**](docs/PaymentAuditServiceApi.md#get_payouts_for_payor_v4) | **GET** /v4/paymentaudit/payouts | Get Payouts for Payor
179
192
  *VeloPayments::PaymentAuditServiceApi* | [**list_payments_audit**](docs/PaymentAuditServiceApi.md#list_payments_audit) | **GET** /v3/paymentaudit/payments | Get List of Payments
193
+ *VeloPayments::PaymentAuditServiceApi* | [**list_payments_audit_v4**](docs/PaymentAuditServiceApi.md#list_payments_audit_v4) | **GET** /v4/paymentaudit/payments | Get List of Payments
180
194
  *VeloPayments::PayorApplicationsApi* | [**payor_create_api_key_request**](docs/PayorApplicationsApi.md#payor_create_api_key_request) | **POST** /v1/payors/{payorId}/applications/{applicationId}/keys | Create API Key
181
195
  *VeloPayments::PayorApplicationsApi* | [**payor_create_application_request**](docs/PayorApplicationsApi.md#payor_create_application_request) | **POST** /v1/payors/{payorId}/applications | Create Application
182
196
  *VeloPayments::PayorsApi* | [**get_payor_by_id**](docs/PayorsApi.md#get_payor_by_id) | **GET** /v1/payors/{payorId} | Get Payor
197
+ *VeloPayments::PayorsApi* | [**get_payor_by_id_v2**](docs/PayorsApi.md#get_payor_by_id_v2) | **GET** /v2/payors/{payorId} | Get Payor
183
198
  *VeloPayments::PayorsApi* | [**payor_add_payor_logo**](docs/PayorsApi.md#payor_add_payor_logo) | **POST** /v1/payors/{payorId}/branding/logos | Add Logo
184
199
  *VeloPayments::PayorsApi* | [**payor_email_opt_out**](docs/PayorsApi.md#payor_email_opt_out) | **POST** /v1/payors/{payorId}/reminderEmailsUpdate | Reminder Email Opt-Out
185
200
  *VeloPayments::PayorsApi* | [**payor_get_branding**](docs/PayorsApi.md#payor_get_branding) | **GET** /v1/payors/{payorId}/branding | Get Branding
201
+ *VeloPayments::PayorsApi* | [**payor_links**](docs/PayorsApi.md#payor_links) | **GET** /v1/payorLinks | List Payor Links
186
202
  *VeloPayments::PayoutHistoryApi* | [**get_payments_for_payout**](docs/PayoutHistoryApi.md#get_payments_for_payout) | **GET** /v3/paymentaudit/payouts/{payoutId} | Get Payments for Payout
203
+ *VeloPayments::PayoutHistoryApi* | [**get_payments_for_payout_v4**](docs/PayoutHistoryApi.md#get_payments_for_payout_v4) | **GET** /v4/paymentaudit/payouts/{payoutId} | Get Payments for Payout
187
204
  *VeloPayments::PayoutHistoryApi* | [**get_payout_stats**](docs/PayoutHistoryApi.md#get_payout_stats) | **GET** /v1/paymentaudit/payoutStatistics | Get Payout Statistics
188
205
  *VeloPayments::QuotePayoutApi* | [**v3_payouts_payout_id_quote_post**](docs/QuotePayoutApi.md#v3_payouts_payout_id_quote_post) | **POST** /v3/payouts/{payoutId}/quote | Create a quote for the payout
189
206
  *VeloPayments::SubmitPayoutApi* | [**submit_payout**](docs/SubmitPayoutApi.md#submit_payout) | **POST** /v3/payouts | Submit Payout
@@ -193,9 +210,13 @@ Class | Method | HTTP request | Description
193
210
  ## Documentation for Models
194
211
 
195
212
  - [VeloPayments::Address](docs/Address.md)
213
+ - [VeloPayments::AuthResponse](docs/AuthResponse.md)
214
+ - [VeloPayments::AutoTopUpConfig](docs/AutoTopUpConfig.md)
196
215
  - [VeloPayments::Challenge](docs/Challenge.md)
197
216
  - [VeloPayments::Company](docs/Company.md)
217
+ - [VeloPayments::CreateIndividual](docs/CreateIndividual.md)
198
218
  - [VeloPayments::CreatePayee](docs/CreatePayee.md)
219
+ - [VeloPayments::CreatePayeeAddress](docs/CreatePayeeAddress.md)
199
220
  - [VeloPayments::CreatePayeesCSVRequest](docs/CreatePayeesCSVRequest.md)
200
221
  - [VeloPayments::CreatePayeesCSVResponse](docs/CreatePayeesCSVResponse.md)
201
222
  - [VeloPayments::CreatePayeesRequest](docs/CreatePayeesRequest.md)
@@ -205,60 +226,95 @@ Class | Method | HTTP request | Description
205
226
  - [VeloPayments::FundingAudit](docs/FundingAudit.md)
206
227
  - [VeloPayments::FundingEvent](docs/FundingEvent.md)
207
228
  - [VeloPayments::FundingEventType](docs/FundingEventType.md)
208
- - [VeloPayments::FundingRequest](docs/FundingRequest.md)
209
- - [VeloPayments::FundingRequest2](docs/FundingRequest2.md)
210
- - [VeloPayments::FxSummary](docs/FxSummary.md)
229
+ - [VeloPayments::FundingRequestV1](docs/FundingRequestV1.md)
230
+ - [VeloPayments::FundingRequestV2](docs/FundingRequestV2.md)
231
+ - [VeloPayments::FxSummaryV3](docs/FxSummaryV3.md)
232
+ - [VeloPayments::FxSummaryV4](docs/FxSummaryV4.md)
211
233
  - [VeloPayments::GetFundingsResponse](docs/GetFundingsResponse.md)
212
- - [VeloPayments::GetPaymentsForPayoutResponse](docs/GetPaymentsForPayoutResponse.md)
213
- - [VeloPayments::GetPaymentsForPayoutResponseLinks](docs/GetPaymentsForPayoutResponseLinks.md)
214
- - [VeloPayments::GetPaymentsForPayoutResponsePage](docs/GetPaymentsForPayoutResponsePage.md)
215
- - [VeloPayments::GetPaymentsForPayoutResponseSummary](docs/GetPaymentsForPayoutResponseSummary.md)
234
+ - [VeloPayments::GetFundingsResponseAllOf](docs/GetFundingsResponseAllOf.md)
235
+ - [VeloPayments::GetPaymentsForPayoutResponseV3](docs/GetPaymentsForPayoutResponseV3.md)
236
+ - [VeloPayments::GetPaymentsForPayoutResponseV3Page](docs/GetPaymentsForPayoutResponseV3Page.md)
237
+ - [VeloPayments::GetPaymentsForPayoutResponseV3Summary](docs/GetPaymentsForPayoutResponseV3Summary.md)
238
+ - [VeloPayments::GetPaymentsForPayoutResponseV4](docs/GetPaymentsForPayoutResponseV4.md)
239
+ - [VeloPayments::GetPaymentsForPayoutResponseV4Summary](docs/GetPaymentsForPayoutResponseV4Summary.md)
216
240
  - [VeloPayments::GetPayoutStatistics](docs/GetPayoutStatistics.md)
217
- - [VeloPayments::GetPayoutsResponse](docs/GetPayoutsResponse.md)
241
+ - [VeloPayments::GetPayoutsResponseV3](docs/GetPayoutsResponseV3.md)
242
+ - [VeloPayments::GetPayoutsResponseV3Links](docs/GetPayoutsResponseV3Links.md)
243
+ - [VeloPayments::GetPayoutsResponseV3Page](docs/GetPayoutsResponseV3Page.md)
244
+ - [VeloPayments::GetPayoutsResponseV3Summary](docs/GetPayoutsResponseV3Summary.md)
245
+ - [VeloPayments::GetPayoutsResponseV4](docs/GetPayoutsResponseV4.md)
218
246
  - [VeloPayments::Individual](docs/Individual.md)
219
247
  - [VeloPayments::IndividualName](docs/IndividualName.md)
248
+ - [VeloPayments::InvitationStatus](docs/InvitationStatus.md)
220
249
  - [VeloPayments::InvitationStatusResponse](docs/InvitationStatusResponse.md)
221
250
  - [VeloPayments::InvitePayeeRequest](docs/InvitePayeeRequest.md)
222
251
  - [VeloPayments::Language](docs/Language.md)
223
252
  - [VeloPayments::ListPaymentsResponse](docs/ListPaymentsResponse.md)
253
+ - [VeloPayments::ListPaymentsResponsePage](docs/ListPaymentsResponsePage.md)
254
+ - [VeloPayments::ListPaymentsResponseSummary](docs/ListPaymentsResponseSummary.md)
224
255
  - [VeloPayments::ListSourceAccountResponse](docs/ListSourceAccountResponse.md)
256
+ - [VeloPayments::ListSourceAccountResponseLinks](docs/ListSourceAccountResponseLinks.md)
257
+ - [VeloPayments::ListSourceAccountResponsePage](docs/ListSourceAccountResponsePage.md)
258
+ - [VeloPayments::ListSourceAccountResponseV2](docs/ListSourceAccountResponseV2.md)
259
+ - [VeloPayments::ListSourceAccountResponseV2Page](docs/ListSourceAccountResponseV2Page.md)
225
260
  - [VeloPayments::MarketingOptIn](docs/MarketingOptIn.md)
261
+ - [VeloPayments::Notifications](docs/Notifications.md)
226
262
  - [VeloPayments::OfacStatus](docs/OfacStatus.md)
227
263
  - [VeloPayments::OnboardedStatus](docs/OnboardedStatus.md)
264
+ - [VeloPayments::PagedPayeeInvitationStatusResponse](docs/PagedPayeeInvitationStatusResponse.md)
228
265
  - [VeloPayments::PagedResponse](docs/PagedResponse.md)
229
266
  - [VeloPayments::PagedResponsePage](docs/PagedResponsePage.md)
230
267
  - [VeloPayments::Payee](docs/Payee.md)
268
+ - [VeloPayments::PayeeDelta](docs/PayeeDelta.md)
269
+ - [VeloPayments::PayeeDeltaResponse](docs/PayeeDeltaResponse.md)
270
+ - [VeloPayments::PayeeDeltaResponseLinks](docs/PayeeDeltaResponseLinks.md)
271
+ - [VeloPayments::PayeeDeltaResponsePage](docs/PayeeDeltaResponsePage.md)
231
272
  - [VeloPayments::PayeeInvitationStatus](docs/PayeeInvitationStatus.md)
273
+ - [VeloPayments::PayeeInvitationStatusResponse](docs/PayeeInvitationStatusResponse.md)
232
274
  - [VeloPayments::PayeeResponse](docs/PayeeResponse.md)
275
+ - [VeloPayments::PayeeResponseLinks](docs/PayeeResponseLinks.md)
276
+ - [VeloPayments::PayeeResponsePage](docs/PayeeResponsePage.md)
277
+ - [VeloPayments::PayeeResponseSummary](docs/PayeeResponseSummary.md)
233
278
  - [VeloPayments::PayeeType](docs/PayeeType.md)
234
- - [VeloPayments::PaymentAuditCurrency](docs/PaymentAuditCurrency.md)
279
+ - [VeloPayments::PaymentAuditCurrencyV3](docs/PaymentAuditCurrencyV3.md)
280
+ - [VeloPayments::PaymentAuditCurrencyV4](docs/PaymentAuditCurrencyV4.md)
235
281
  - [VeloPayments::PaymentChannel](docs/PaymentChannel.md)
236
282
  - [VeloPayments::PaymentChannelCountry](docs/PaymentChannelCountry.md)
237
283
  - [VeloPayments::PaymentChannelRule](docs/PaymentChannelRule.md)
238
284
  - [VeloPayments::PaymentChannelRulesResponse](docs/PaymentChannelRulesResponse.md)
239
- - [VeloPayments::PaymentEventResponse](docs/PaymentEventResponse.md)
285
+ - [VeloPayments::PaymentEventResponseV3](docs/PaymentEventResponseV3.md)
286
+ - [VeloPayments::PaymentEventResponseV4](docs/PaymentEventResponseV4.md)
240
287
  - [VeloPayments::PaymentInstruction](docs/PaymentInstruction.md)
241
- - [VeloPayments::PaymentResponse](docs/PaymentResponse.md)
242
- - [VeloPayments::Payor](docs/Payor.md)
288
+ - [VeloPayments::PaymentResponseV3](docs/PaymentResponseV3.md)
289
+ - [VeloPayments::PaymentResponseV4](docs/PaymentResponseV4.md)
243
290
  - [VeloPayments::PayorBrandingResponse](docs/PayorBrandingResponse.md)
244
291
  - [VeloPayments::PayorCreateApiKeyRequest](docs/PayorCreateApiKeyRequest.md)
245
292
  - [VeloPayments::PayorCreateApiKeyResponse](docs/PayorCreateApiKeyResponse.md)
246
293
  - [VeloPayments::PayorCreateApplicationRequest](docs/PayorCreateApplicationRequest.md)
247
294
  - [VeloPayments::PayorEmailOptOutRequest](docs/PayorEmailOptOutRequest.md)
248
295
  - [VeloPayments::PayorFundingBankDetailsUpdate](docs/PayorFundingBankDetailsUpdate.md)
296
+ - [VeloPayments::PayorLinksResponse](docs/PayorLinksResponse.md)
297
+ - [VeloPayments::PayorLinksResponseLinks](docs/PayorLinksResponseLinks.md)
298
+ - [VeloPayments::PayorLinksResponsePayors](docs/PayorLinksResponsePayors.md)
249
299
  - [VeloPayments::PayorLogoRequest](docs/PayorLogoRequest.md)
250
300
  - [VeloPayments::PayorRef](docs/PayorRef.md)
251
- - [VeloPayments::PayoutStatus](docs/PayoutStatus.md)
252
- - [VeloPayments::PayoutSummaryAudit](docs/PayoutSummaryAudit.md)
301
+ - [VeloPayments::PayorV1](docs/PayorV1.md)
302
+ - [VeloPayments::PayorV2](docs/PayorV2.md)
303
+ - [VeloPayments::PayoutStatusV3](docs/PayoutStatusV3.md)
304
+ - [VeloPayments::PayoutStatusV4](docs/PayoutStatusV4.md)
305
+ - [VeloPayments::PayoutSummaryAuditV3](docs/PayoutSummaryAuditV3.md)
306
+ - [VeloPayments::PayoutSummaryAuditV4](docs/PayoutSummaryAuditV4.md)
253
307
  - [VeloPayments::PayoutSummaryResponse](docs/PayoutSummaryResponse.md)
254
308
  - [VeloPayments::QueryBatchResponse](docs/QueryBatchResponse.md)
255
309
  - [VeloPayments::QuoteFxSummary](docs/QuoteFxSummary.md)
256
310
  - [VeloPayments::QuoteResponse](docs/QuoteResponse.md)
257
311
  - [VeloPayments::RejectedPayment](docs/RejectedPayment.md)
258
- - [VeloPayments::Social](docs/Social.md)
312
+ - [VeloPayments::SetNotificationsRequest](docs/SetNotificationsRequest.md)
259
313
  - [VeloPayments::SourceAccount](docs/SourceAccount.md)
260
314
  - [VeloPayments::SourceAccountResponse](docs/SourceAccountResponse.md)
261
- - [VeloPayments::SourceAccountSummary](docs/SourceAccountSummary.md)
315
+ - [VeloPayments::SourceAccountResponseV2](docs/SourceAccountResponseV2.md)
316
+ - [VeloPayments::SourceAccountSummaryV3](docs/SourceAccountSummaryV3.md)
317
+ - [VeloPayments::SourceAccountSummaryV4](docs/SourceAccountSummaryV4.md)
262
318
  - [VeloPayments::SupportedCountriesResponse](docs/SupportedCountriesResponse.md)
263
319
  - [VeloPayments::SupportedCountry](docs/SupportedCountry.md)
264
320
  - [VeloPayments::SupportedCurrency](docs/SupportedCurrency.md)
data/docs/Address.md CHANGED
@@ -18,14 +18,14 @@ Name | Type | Description | Notes
18
18
  ```ruby
19
19
  require 'VeloPayments'
20
20
 
21
- instance = VeloPayments::Address.new(line1: null,
21
+ instance = VeloPayments::Address.new(line1: 500 Duval St,
22
22
  line2: null,
23
23
  line3: null,
24
24
  line4: null,
25
- city: null,
26
- county_or_province: null,
27
- zip_or_postcode: null,
28
- country: null)
25
+ city: Key West,
26
+ county_or_province: FL,
27
+ zip_or_postcode: 33945,
28
+ country: US)
29
29
  ```
30
30
 
31
31
 
data/docs/AuthApi.md ADDED
@@ -0,0 +1,65 @@
1
+ # VeloPayments::AuthApi
2
+
3
+ All URIs are relative to *https://api.sandbox.velopayments.com*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**velo_auth**](AuthApi.md#velo_auth) | **POST** /v1/authenticate/ | Authentication endpoint
8
+
9
+
10
+
11
+ ## velo_auth
12
+
13
+ > AuthResponse velo_auth(authorization, opts)
14
+
15
+ Authentication endpoint
16
+
17
+ Use this endpoint to obtain an access token for calling Velo Payments APIs.
18
+
19
+ ### Example
20
+
21
+ ```ruby
22
+ # load the gem
23
+ require 'velopayments'
24
+ # setup authorization
25
+ VeloPayments.configure do |config|
26
+ # Configure OAuth2 access token for authorization: OAuth2
27
+ config.access_token = 'YOUR ACCESS TOKEN'
28
+ end
29
+
30
+ api_instance = VeloPayments::AuthApi.new
31
+ authorization = 'authorization_example' # String | String value of Basic and a Base64 endcoded string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. Basic 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529
32
+ opts = {
33
+ grant_type: 'client_credentials' # String | OAuth grant type. Should use 'client_credentials'
34
+ }
35
+
36
+ begin
37
+ #Authentication endpoint
38
+ result = api_instance.velo_auth(authorization, opts)
39
+ p result
40
+ rescue VeloPayments::ApiError => e
41
+ puts "Exception when calling AuthApi->velo_auth: #{e}"
42
+ end
43
+ ```
44
+
45
+ ### Parameters
46
+
47
+
48
+ Name | Type | Description | Notes
49
+ ------------- | ------------- | ------------- | -------------
50
+ **authorization** | **String**| String value of Basic and a Base64 endcoded string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. Basic 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 |
51
+ **grant_type** | **String**| OAuth grant type. Should use 'client_credentials' | [optional] [default to 'client_credentials']
52
+
53
+ ### Return type
54
+
55
+ [**AuthResponse**](AuthResponse.md)
56
+
57
+ ### Authorization
58
+
59
+ [OAuth2](../README.md#OAuth2)
60
+
61
+ ### HTTP request headers
62
+
63
+ - **Content-Type**: Not defined
64
+ - **Accept**: application/json
65
+
data/docs/AuthResponse.md ADDED
@@ -0,0 +1,25 @@
1
+ # VeloPayments::AuthResponse
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **access_token** | **String** | |
8
+ **token_type** | **String** | |
9
+ **expires_in** | **Float** | | [optional]
10
+ **refresh_token** | **String** | | [optional]
11
+ **scope** | **String** | | [optional]
12
+
13
+ ## Code Sample
14
+
15
+ ```ruby
16
+ require 'VeloPayments'
17
+
18
+ instance = VeloPayments::AuthResponse.new(access_token: null,
19
+ token_type: bearer,
20
+ expires_in: 1799,
21
+ refresh_token: IwOGYzYTlmM2YxOTQ5MGE3YmNmMDFkNTVk,
22
+ scope: example_scope)
23
+ ```
24
+
25
+
data/docs/AutoTopUpConfig.md ADDED
@@ -0,0 +1,21 @@
1
+ # VeloPayments::AutoTopUpConfig
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **enabled** | **Boolean** | Is auto top-up enabled? automatically trigger funding to top-up the source account balance when the balance falls below the configured minimum level. |
8
+ **min_balance** | **Integer** | When the payor balance falls below this level then auto top-up will be triggered. Note - This is in minor units. | [optional]
9
+ **target_balance** | **Integer** | When the payor balance falls below the min balance then auto top-up will request funds bring the balance to this level. Note - this is in minor units. | [optional]
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'VeloPayments'
15
+
16
+ instance = VeloPayments::AutoTopUpConfig.new(enabled: true,
17
+ min_balance: 10000,
18
+ target_balance: 300000)
19
+ ```
20
+
21
+
data/docs/Company.md CHANGED
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **name** | **String** | |
8
8
  **tax_id** | **String** | Company Tax Id (EIN) must be 9 numeric characters. Must match the regular expression ```[\\d]{9}```. | [optional]
9
+ **operating_name** | **String** | | [optional]
9
10
 
10
11
  ## Code Sample
11
12
 
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
13
14
  require 'VeloPayments'
14
15
 
15
16
  instance = VeloPayments::Company.new(name: null,
16
- tax_id: null)
17
+ tax_id: null,
18
+ operating_name: null)
17
19
  ```
18
20
 
19
21
 
data/docs/CreateIndividual.md ADDED
@@ -0,0 +1,21 @@
1
+ # VeloPayments::CreateIndividual
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **name** | [**IndividualName**](IndividualName.md) | |
8
+ **national_identification** | **String** | | [optional]
9
+ **date_of_birth** | **Date** | Must not be date in future. Example - 1970-05-20 |
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'VeloPayments'
15
+
16
+ instance = VeloPayments::CreateIndividual.new(name: null,
17
+ national_identification: null,
18
+ date_of_birth: null)
19
+ ```
20
+
21
+
data/docs/CreatePayee.md CHANGED
@@ -9,23 +9,12 @@ Name | Type | Description | Notes
9
9
  **email** | **String** | |
10
10
  **remote_id** | **String** | |
11
11
  **type** | [**PayeeType**](PayeeType.md) | |
12
- **display_name** | **String** | | [optional]
13
- **country** | **String** | | [optional]
14
- **address** | [**Address**](Address.md) | |
12
+ **address** | [**CreatePayeeAddress**](CreatePayeeAddress.md) | |
15
13
  **payment_channel** | [**CreatePaymentChannel**](CreatePaymentChannel.md) | | [optional]
16
14
  **challenge** | [**Challenge**](Challenge.md) | | [optional]
17
15
  **language** | [**Language**](Language.md) | | [optional]
18
- **accept_terms_and_conditions_timestamp** | **DateTime** | The timestamp when the payee last accepted T&Cs | [optional]
19
- **cellphone_number** | **String** | | [optional]
20
16
  **company** | [**Company**](Company.md) | | [optional]
21
- **individual** | [**Individual**](Individual.md) | | [optional]
22
- **created** | **DateTime** | | [optional]
23
- **grace_period_end_date** | **Date** | | [optional]
24
- **last_ofac_check_timestamp** | **String** | | [optional]
25
- **marketing_opt_ins** | [**Array<MarketingOptIn>**](MarketingOptIn.md) | | [optional]
26
- **ofac_status** | [**OfacStatus**](OfacStatus.md) | | [optional]
27
- **onboarded_status** | [**OnboardedStatus**](OnboardedStatus.md) | | [optional]
28
- **social** | [**Social**](Social.md) | | [optional]
17
+ **individual** | [**CreateIndividual**](CreateIndividual.md) | | [optional]
29
18
 
30
19
  ## Code Sample
31
20
 
@@ -37,23 +26,12 @@ instance = VeloPayments::CreatePayee.new(payee_id: null,
37
26
  email: null,
38
27
  remote_id: null,
39
28
  type: null,
40
- display_name: null,
41
- country: null,
42
29
  address: null,
43
30
  payment_channel: null,
44
31
  challenge: null,
45
32
  language: null,
46
- accept_terms_and_conditions_timestamp: null,
47
- cellphone_number: null,
48
33
  company: null,
49
- individual: null,
50
- created: null,
51
- grace_period_end_date: null,
52
- last_ofac_check_timestamp: null,
53
- marketing_opt_ins: null,
54
- ofac_status: null,
55
- onboarded_status: null,
56
- social: null)
34
+ individual: null)
57
35
  ```
58
36
 
59
37