velopayments 2.35.58.beta1 → 2.37.150.beta1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (337) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +4 -4
  3. data/README.md +50 -11
  4. data/docs/{PayorAddress.md → AddressV4.md} +3 -3
  5. data/docs/CommonLinkObject.md +20 -0
  6. data/docs/CommonPageObject.md +26 -0
  7. data/docs/CreateFundingAccountRequestV2.md +2 -2
  8. data/docs/CreatePaymentChannelRequestV4.md +30 -0
  9. data/docs/CreateTransactionRequest.md +24 -0
  10. data/docs/CreateTransactionResponse.md +20 -0
  11. data/docs/FundingAccountResponseV2.md +3 -3
  12. data/docs/FundingApi.md +2 -2
  13. data/docs/FundingAudit.md +8 -2
  14. data/docs/FundingEvent.md +6 -8
  15. data/docs/FundingEvent2.md +24 -0
  16. data/docs/FundingManagerPrivateApi.md +1 -1
  17. data/docs/FundingResponse.md +7 -3
  18. data/docs/GetPayeeListResponseV4.md +2 -0
  19. data/docs/InstructPayoutRequestV3.md +4 -2
  20. data/docs/ListFundingAccountsResponseV2.md +1 -1
  21. data/docs/NotificationSource.md +3 -0
  22. data/docs/PageResourceTransactions.md +22 -0
  23. data/docs/PayeeDetailResponseV4.md +4 -0
  24. data/docs/PayeePaymentChannelsApi.md +522 -0
  25. data/docs/PayeesApi.md +2 -2
  26. data/docs/PaymentAuditServiceApi.md +7 -1
  27. data/docs/PaymentChannelOrderRequestV4.md +18 -0
  28. data/docs/PaymentChannelResponseV4.md +56 -0
  29. data/docs/PaymentChannelSummaryV4.md +32 -0
  30. data/docs/PaymentChannelsResponseV4.md +20 -0
  31. data/docs/PaymentInstructionV3.md +4 -2
  32. data/docs/PaymentResponseV4.md +10 -0
  33. data/docs/PaymentV3.md +4 -2
  34. data/docs/PayorCreateApiKeyRequest.md +3 -3
  35. data/docs/PayorFundingDetected.md +46 -0
  36. data/docs/PayorFundingDetectedAllOf.md +40 -0
  37. data/docs/PayorToPaymentChannelMappingV4.md +20 -0
  38. data/docs/PayorV2.md +19 -19
  39. data/docs/PayorsApi.md +14 -84
  40. data/docs/PayoutsApi.md +2 -2
  41. data/docs/SourceAccountResponseV3.md +3 -1
  42. data/docs/TransactionResponse.md +36 -0
  43. data/docs/TransactionsApi.md +229 -0
  44. data/docs/UpdatePayeeDetailsRequestV3.md +3 -1
  45. data/docs/UpdatePaymentChannelRequestV4.md +30 -0
  46. data/docs/WebhooksResponse.md +2 -2
  47. data/lib/velopayments/api/countries_api.rb +2 -2
  48. data/lib/velopayments/api/currencies_api.rb +2 -2
  49. data/lib/velopayments/api/funding_api.rb +5 -5
  50. data/lib/velopayments/api/funding_manager_private_api.rb +2 -2
  51. data/lib/velopayments/api/login_api.rb +2 -2
  52. data/lib/velopayments/api/payee_invitation_api.rb +2 -2
  53. data/lib/velopayments/api/payee_payment_channels_api.rb +538 -0
  54. data/lib/velopayments/api/payees_api.rb +6 -2
  55. data/lib/velopayments/api/payment_audit_service_api.rb +12 -3
  56. data/lib/velopayments/api/payment_audit_service_deprecated_api.rb +2 -2
  57. data/lib/velopayments/api/payor_hierarchy_api.rb +2 -2
  58. data/lib/velopayments/api/payors_api.rb +16 -79
  59. data/lib/velopayments/api/payors_private_api.rb +2 -2
  60. data/lib/velopayments/api/payouts_api.rb +2 -6
  61. data/lib/velopayments/api/source_accounts_api.rb +2 -2
  62. data/lib/velopayments/api/tokens_api.rb +2 -2
  63. data/lib/velopayments/api/transactions_api.rb +229 -0
  64. data/lib/velopayments/api/users_api.rb +2 -2
  65. data/lib/velopayments/api/webhooks_api.rb +2 -2
  66. data/lib/velopayments/api_client.rb +2 -2
  67. data/lib/velopayments/api_error.rb +2 -2
  68. data/lib/velopayments/configuration.rb +2 -2
  69. data/lib/velopayments/models/accepted_payment_v3.rb +2 -2
  70. data/lib/velopayments/models/access_token_response.rb +2 -2
  71. data/lib/velopayments/models/access_token_validation_request.rb +2 -2
  72. data/lib/velopayments/models/{payor_address.rb → address_v4.rb} +92 -80
  73. data/lib/velopayments/models/auth_response.rb +2 -2
  74. data/lib/velopayments/models/auto_top_up_config_v2.rb +2 -2
  75. data/lib/velopayments/models/auto_top_up_config_v3.rb +2 -2
  76. data/lib/velopayments/models/category.rb +4 -3
  77. data/lib/velopayments/models/challenge_v3.rb +2 -2
  78. data/lib/velopayments/models/challenge_v4.rb +2 -2
  79. data/lib/velopayments/models/{list_funding_accounts_response_v2_links.rb → common_link_object.rb} +7 -5
  80. data/lib/velopayments/models/common_page_object.rb +250 -0
  81. data/lib/velopayments/models/company_v3.rb +2 -2
  82. data/lib/velopayments/models/company_v4.rb +2 -2
  83. data/lib/velopayments/models/create_funding_account_request_v2.rb +34 -27
  84. data/lib/velopayments/models/create_individual_v3.rb +2 -2
  85. data/lib/velopayments/models/create_individual_v3_name.rb +2 -2
  86. data/lib/velopayments/models/create_individual_v4.rb +2 -2
  87. data/lib/velopayments/models/create_payee_address_v3.rb +2 -2
  88. data/lib/velopayments/models/create_payee_address_v4.rb +2 -2
  89. data/lib/velopayments/models/create_payee_v3.rb +2 -2
  90. data/lib/velopayments/models/create_payee_v4.rb +2 -2
  91. data/lib/velopayments/models/create_payees_csv_request_v3.rb +2 -2
  92. data/lib/velopayments/models/create_payees_csv_request_v4.rb +2 -2
  93. data/lib/velopayments/models/create_payees_csv_response_v3.rb +2 -2
  94. data/lib/velopayments/models/create_payees_csv_response_v3_rejected_csv_rows.rb +2 -2
  95. data/lib/velopayments/models/create_payees_csv_response_v4.rb +2 -2
  96. data/lib/velopayments/models/create_payees_request_v3.rb +2 -2
  97. data/lib/velopayments/models/create_payees_request_v4.rb +2 -2
  98. data/lib/velopayments/models/create_payment_channel_request_v4.rb +472 -0
  99. data/lib/velopayments/models/create_payment_channel_v3.rb +2 -2
  100. data/lib/velopayments/models/create_payment_channel_v4.rb +2 -2
  101. data/lib/velopayments/models/create_payor_link_request.rb +2 -2
  102. data/lib/velopayments/models/create_payout_request_v3.rb +2 -2
  103. data/lib/velopayments/models/create_transaction_request.rb +324 -0
  104. data/lib/velopayments/models/create_transaction_response.rb +239 -0
  105. data/lib/velopayments/models/create_webhook_request.rb +2 -2
  106. data/lib/velopayments/models/debit_event.rb +2 -2
  107. data/lib/velopayments/models/debit_event_all_of.rb +2 -2
  108. data/lib/velopayments/models/debit_status_changed.rb +2 -2
  109. data/lib/velopayments/models/debit_status_changed_all_of.rb +2 -2
  110. data/lib/velopayments/models/error.rb +2 -2
  111. data/lib/velopayments/models/error_data.rb +2 -2
  112. data/lib/velopayments/models/error_response.rb +2 -2
  113. data/lib/velopayments/models/failed_payee_v3.rb +2 -2
  114. data/lib/velopayments/models/failed_payee_v4.rb +2 -2
  115. data/lib/velopayments/models/failed_submission_v3.rb +2 -2
  116. data/lib/velopayments/models/failed_submission_v4.rb +2 -2
  117. data/lib/velopayments/models/funding_account_response_v2.rb +25 -25
  118. data/lib/velopayments/models/funding_audit.rb +37 -7
  119. data/lib/velopayments/models/funding_event.rb +50 -28
  120. data/lib/velopayments/models/funding_event2.rb +242 -0
  121. data/lib/velopayments/models/funding_payor_status_audit_response.rb +2 -2
  122. data/lib/velopayments/models/funding_request_v2.rb +2 -2
  123. data/lib/velopayments/models/funding_request_v3.rb +2 -2
  124. data/lib/velopayments/models/funding_response.rb +35 -14
  125. data/lib/velopayments/models/fx_summary.rb +2 -2
  126. data/lib/velopayments/models/fx_summary_v3.rb +2 -2
  127. data/lib/velopayments/models/get_fundings_response.rb +2 -2
  128. data/lib/velopayments/models/get_fundings_response_links.rb +2 -2
  129. data/lib/velopayments/models/get_payee_list_response_company_v3.rb +2 -2
  130. data/lib/velopayments/models/get_payee_list_response_company_v4.rb +2 -2
  131. data/lib/velopayments/models/get_payee_list_response_individual_v3.rb +2 -2
  132. data/lib/velopayments/models/get_payee_list_response_individual_v4.rb +2 -2
  133. data/lib/velopayments/models/get_payee_list_response_v3.rb +2 -2
  134. data/lib/velopayments/models/get_payee_list_response_v4.rb +13 -3
  135. data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +2 -2
  136. data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +2 -2
  137. data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +2 -2
  138. data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +2 -2
  139. data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +2 -2
  140. data/lib/velopayments/models/get_payout_statistics.rb +2 -2
  141. data/lib/velopayments/models/get_payouts_response.rb +2 -2
  142. data/lib/velopayments/models/get_payouts_response_v3.rb +2 -2
  143. data/lib/velopayments/models/get_payouts_response_v3_links.rb +2 -2
  144. data/lib/velopayments/models/get_payouts_response_v3_page.rb +2 -2
  145. data/lib/velopayments/models/individual_v3.rb +2 -2
  146. data/lib/velopayments/models/individual_v3_name.rb +2 -2
  147. data/lib/velopayments/models/individual_v4.rb +2 -2
  148. data/lib/velopayments/models/inline_response400.rb +2 -2
  149. data/lib/velopayments/models/inline_response401.rb +2 -2
  150. data/lib/velopayments/models/inline_response403.rb +2 -2
  151. data/lib/velopayments/models/inline_response404.rb +2 -2
  152. data/lib/velopayments/models/inline_response409.rb +2 -2
  153. data/lib/velopayments/models/inline_response412.rb +2 -2
  154. data/lib/velopayments/models/instruct_payout_request_v3.rb +19 -7
  155. data/lib/velopayments/models/invite_payee_request_v3.rb +2 -2
  156. data/lib/velopayments/models/invite_payee_request_v4.rb +2 -2
  157. data/lib/velopayments/models/invite_user_request.rb +2 -2
  158. data/lib/velopayments/models/link_for_response.rb +2 -2
  159. data/lib/velopayments/models/list_funding_accounts_response_v2.rb +3 -3
  160. data/lib/velopayments/models/list_funding_accounts_response_v2_page.rb +2 -2
  161. data/lib/velopayments/models/list_payments_response_v3.rb +2 -2
  162. data/lib/velopayments/models/list_payments_response_v3_page.rb +2 -2
  163. data/lib/velopayments/models/list_payments_response_v4.rb +2 -2
  164. data/lib/velopayments/models/list_source_account_response_v2.rb +2 -2
  165. data/lib/velopayments/models/list_source_account_response_v2_links.rb +2 -2
  166. data/lib/velopayments/models/list_source_account_response_v3.rb +2 -2
  167. data/lib/velopayments/models/list_source_account_response_v3_links.rb +2 -2
  168. data/lib/velopayments/models/localisation_details.rb +2 -2
  169. data/lib/velopayments/models/mfa_details.rb +2 -2
  170. data/lib/velopayments/models/mfa_type.rb +2 -2
  171. data/lib/velopayments/models/name_v3.rb +2 -2
  172. data/lib/velopayments/models/name_v4.rb +2 -2
  173. data/lib/velopayments/models/notification.rb +2 -2
  174. data/lib/velopayments/models/notification_source.rb +4 -2
  175. data/lib/velopayments/models/notifications_v2.rb +2 -2
  176. data/lib/velopayments/models/notifications_v3.rb +2 -2
  177. data/lib/velopayments/models/onboarding_status_changed.rb +2 -2
  178. data/lib/velopayments/models/page_for_response.rb +2 -2
  179. data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +2 -2
  180. data/lib/velopayments/models/page_resource_transactions.rb +236 -0
  181. data/lib/velopayments/models/paged_payee_invitation_status_response_v3.rb +2 -2
  182. data/lib/velopayments/models/paged_payee_invitation_status_response_v3_page.rb +2 -2
  183. data/lib/velopayments/models/paged_payee_invitation_status_response_v4.rb +2 -2
  184. data/lib/velopayments/models/paged_payee_response_v3.rb +2 -2
  185. data/lib/velopayments/models/paged_payee_response_v3_links.rb +2 -2
  186. data/lib/velopayments/models/paged_payee_response_v3_page.rb +2 -2
  187. data/lib/velopayments/models/paged_payee_response_v3_summary.rb +2 -2
  188. data/lib/velopayments/models/paged_payee_response_v4.rb +2 -2
  189. data/lib/velopayments/models/paged_payments_response_v3.rb +2 -2
  190. data/lib/velopayments/models/paged_user_response.rb +2 -2
  191. data/lib/velopayments/models/paged_user_response_links.rb +2 -2
  192. data/lib/velopayments/models/paged_user_response_page.rb +2 -2
  193. data/lib/velopayments/models/password_request.rb +12 -12
  194. data/lib/velopayments/models/payable_issue_v3.rb +2 -2
  195. data/lib/velopayments/models/payable_issue_v4.rb +2 -2
  196. data/lib/velopayments/models/payable_status_changed.rb +2 -2
  197. data/lib/velopayments/models/payee_address_v3.rb +2 -2
  198. data/lib/velopayments/models/payee_address_v4.rb +2 -2
  199. data/lib/velopayments/models/payee_delta_response_v3.rb +2 -2
  200. data/lib/velopayments/models/payee_delta_response_v3_links.rb +2 -2
  201. data/lib/velopayments/models/payee_delta_response_v3_page.rb +2 -2
  202. data/lib/velopayments/models/payee_delta_response_v4.rb +2 -2
  203. data/lib/velopayments/models/payee_delta_response_v4_links.rb +2 -2
  204. data/lib/velopayments/models/payee_delta_v3.rb +2 -2
  205. data/lib/velopayments/models/payee_delta_v4.rb +2 -2
  206. data/lib/velopayments/models/payee_detail_response_v3.rb +2 -2
  207. data/lib/velopayments/models/payee_detail_response_v4.rb +26 -3
  208. data/lib/velopayments/models/payee_details_changed.rb +2 -2
  209. data/lib/velopayments/models/payee_event.rb +2 -2
  210. data/lib/velopayments/models/payee_event_all_of.rb +2 -2
  211. data/lib/velopayments/models/payee_event_all_of_reasons.rb +2 -2
  212. data/lib/velopayments/models/payee_invitation_status_response_v3.rb +2 -2
  213. data/lib/velopayments/models/payee_invitation_status_response_v4.rb +2 -2
  214. data/lib/velopayments/models/payee_payor_ref_v3.rb +2 -2
  215. data/lib/velopayments/models/payee_payor_ref_v4.rb +2 -2
  216. data/lib/velopayments/models/payee_type.rb +2 -2
  217. data/lib/velopayments/models/payee_type_enum.rb +2 -2
  218. data/lib/velopayments/models/payee_user_self_update_request.rb +2 -2
  219. data/lib/velopayments/models/payment_channel_country.rb +2 -2
  220. data/lib/velopayments/models/{transmission_types.rb → payment_channel_order_request_v4.rb} +19 -51
  221. data/lib/velopayments/models/payment_channel_response_v4.rb +607 -0
  222. data/lib/velopayments/models/payment_channel_rule.rb +2 -2
  223. data/lib/velopayments/models/payment_channel_rules_response.rb +2 -2
  224. data/lib/velopayments/models/payment_channel_summary_v4.rb +396 -0
  225. data/lib/velopayments/models/payment_channels_response_v4.rb +227 -0
  226. data/lib/velopayments/models/payment_delta.rb +2 -2
  227. data/lib/velopayments/models/payment_delta_response.rb +2 -2
  228. data/lib/velopayments/models/payment_delta_response_v1.rb +2 -2
  229. data/lib/velopayments/models/payment_delta_v1.rb +2 -2
  230. data/lib/velopayments/models/payment_event.rb +2 -2
  231. data/lib/velopayments/models/payment_event_all_of.rb +2 -2
  232. data/lib/velopayments/models/payment_event_response.rb +2 -2
  233. data/lib/velopayments/models/payment_event_response_v3.rb +2 -2
  234. data/lib/velopayments/models/payment_instruction_v3.rb +19 -50
  235. data/lib/velopayments/models/payment_rejected_or_returned.rb +2 -2
  236. data/lib/velopayments/models/payment_rejected_or_returned_all_of.rb +2 -2
  237. data/lib/velopayments/models/payment_response_v3.rb +2 -2
  238. data/lib/velopayments/models/payment_response_v4.rb +50 -3
  239. data/lib/velopayments/models/payment_response_v4_payout.rb +2 -2
  240. data/lib/velopayments/models/payment_status_changed.rb +2 -2
  241. data/lib/velopayments/models/payment_status_changed_all_of.rb +2 -2
  242. data/lib/velopayments/models/payment_v3.rb +17 -7
  243. data/lib/velopayments/models/payor_address_v2.rb +32 -17
  244. data/lib/velopayments/models/payor_aml_transaction.rb +2 -2
  245. data/lib/velopayments/models/payor_aml_transaction_v3.rb +2 -2
  246. data/lib/velopayments/models/payor_branding_response.rb +2 -5
  247. data/lib/velopayments/models/payor_create_api_key_request.rb +2 -2
  248. data/lib/velopayments/models/payor_create_api_key_response.rb +2 -2
  249. data/lib/velopayments/models/payor_create_application_request.rb +2 -2
  250. data/lib/velopayments/models/payor_email_opt_out_request.rb +2 -2
  251. data/lib/velopayments/models/payor_funding_detected.rb +399 -0
  252. data/lib/velopayments/models/payor_funding_detected_all_of.rb +339 -0
  253. data/lib/velopayments/models/payor_links_response.rb +2 -2
  254. data/lib/velopayments/models/payor_links_response_links.rb +2 -2
  255. data/lib/velopayments/models/payor_links_response_payors.rb +2 -2
  256. data/lib/velopayments/models/{transmission_types2.rb → payor_to_payment_channel_mapping_v4.rb} +18 -51
  257. data/lib/velopayments/models/payor_v2.rb +26 -20
  258. data/lib/velopayments/models/payout_company_v3.rb +2 -2
  259. data/lib/velopayments/models/payout_individual_v3.rb +2 -2
  260. data/lib/velopayments/models/payout_name_v3.rb +2 -2
  261. data/lib/velopayments/models/payout_payee_v3.rb +2 -2
  262. data/lib/velopayments/models/payout_payor.rb +2 -2
  263. data/lib/velopayments/models/payout_payor_ids.rb +2 -2
  264. data/lib/velopayments/models/payout_principal.rb +2 -2
  265. data/lib/velopayments/models/payout_schedule.rb +2 -2
  266. data/lib/velopayments/models/payout_schedule_v3.rb +2 -2
  267. data/lib/velopayments/models/payout_summary_audit.rb +2 -2
  268. data/lib/velopayments/models/payout_summary_audit_v3.rb +2 -2
  269. data/lib/velopayments/models/payout_summary_response_v3.rb +2 -2
  270. data/lib/velopayments/models/ping.rb +2 -2
  271. data/lib/velopayments/models/ping_response.rb +2 -2
  272. data/lib/velopayments/models/post_instruct_fx_info.rb +2 -2
  273. data/lib/velopayments/models/query_batch_response_v3.rb +2 -2
  274. data/lib/velopayments/models/query_batch_response_v4.rb +2 -2
  275. data/lib/velopayments/models/quote_fx_summary_v3.rb +2 -2
  276. data/lib/velopayments/models/quote_response_v3.rb +2 -2
  277. data/lib/velopayments/models/region_v2.rb +2 -2
  278. data/lib/velopayments/models/register_sms_request.rb +2 -2
  279. data/lib/velopayments/models/rejected_payment_v3.rb +2 -2
  280. data/lib/velopayments/models/resend_token_request.rb +2 -2
  281. data/lib/velopayments/models/reset_password_request.rb +2 -2
  282. data/lib/velopayments/models/role.rb +2 -2
  283. data/lib/velopayments/models/role_update_request.rb +2 -2
  284. data/lib/velopayments/models/schedule_payout_request_v3.rb +2 -2
  285. data/lib/velopayments/models/self_mfa_type_unregister_request.rb +2 -2
  286. data/lib/velopayments/models/self_update_password_request.rb +22 -22
  287. data/lib/velopayments/models/set_notifications_request.rb +2 -2
  288. data/lib/velopayments/models/set_notifications_request2.rb +2 -2
  289. data/lib/velopayments/models/source_account_response_v2.rb +2 -2
  290. data/lib/velopayments/models/source_account_response_v3.rb +18 -6
  291. data/lib/velopayments/models/source_account_summary.rb +2 -2
  292. data/lib/velopayments/models/source_account_summary_v3.rb +2 -2
  293. data/lib/velopayments/models/source_account_v3.rb +2 -2
  294. data/lib/velopayments/models/source_event.rb +2 -2
  295. data/lib/velopayments/models/supported_countries_response.rb +2 -2
  296. data/lib/velopayments/models/supported_countries_response_v2.rb +2 -2
  297. data/lib/velopayments/models/supported_country.rb +2 -2
  298. data/lib/velopayments/models/supported_country_v2.rb +2 -2
  299. data/lib/velopayments/models/supported_currency_response_v2.rb +2 -2
  300. data/lib/velopayments/models/supported_currency_v2.rb +2 -2
  301. data/lib/velopayments/models/{payor_v1.rb → transaction_response.rb} +143 -181
  302. data/lib/velopayments/models/transfer_request_v2.rb +2 -2
  303. data/lib/velopayments/models/transfer_request_v3.rb +2 -2
  304. data/lib/velopayments/models/unregister_mfa_request.rb +2 -2
  305. data/lib/velopayments/models/update_payee_details_request_v3.rb +38 -7
  306. data/lib/velopayments/models/update_payee_details_request_v4.rb +2 -2
  307. data/lib/velopayments/models/update_payment_channel_request_v4.rb +472 -0
  308. data/lib/velopayments/models/update_remote_id_request_v3.rb +2 -2
  309. data/lib/velopayments/models/update_remote_id_request_v4.rb +2 -2
  310. data/lib/velopayments/models/update_webhook_request.rb +2 -2
  311. data/lib/velopayments/models/user_details_update_request.rb +2 -2
  312. data/lib/velopayments/models/user_info.rb +2 -2
  313. data/lib/velopayments/models/user_response.rb +4 -4
  314. data/lib/velopayments/models/user_status.rb +2 -2
  315. data/lib/velopayments/models/user_type.rb +2 -2
  316. data/lib/velopayments/models/user_type2.rb +2 -2
  317. data/lib/velopayments/models/validate_password_response.rb +2 -2
  318. data/lib/velopayments/models/webhook_response.rb +2 -2
  319. data/lib/velopayments/models/webhooks_response.rb +4 -4
  320. data/lib/velopayments/models/withdraw_payment_request.rb +2 -2
  321. data/lib/velopayments/version.rb +3 -3
  322. data/lib/velopayments.rb +21 -7
  323. data/oa3-config.json +1 -1
  324. data/spec/api/payee_payment_channels_api_spec.rb +132 -0
  325. data/spec/api/transactions_api_spec.rb +75 -0
  326. data/spec/api_client_spec.rb +2 -2
  327. data/spec/configuration_spec.rb +2 -2
  328. data/spec/spec_helper.rb +2 -2
  329. data/specs/api/payee_payment_channels_api_spec.rb +132 -0
  330. data/specs/api/transactions_api_spec.rb +75 -0
  331. data/velopayments.gemspec +2 -2
  332. metadata +46 -13
  333. data/credentials +0 -1
  334. data/docs/ListFundingAccountsResponseV2Links.md +0 -20
  335. data/docs/PayorV1.md +0 -60
  336. data/docs/TransmissionTypes.md +0 -22
  337. data/docs/TransmissionTypes2.md +0 -22
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2c21de0e6eb72b7c2b698ae46127c5cba1b3e90f04d1f627877321f1077c86b6
4
- data.tar.gz: cef4898deacff1bc80c3b0a0ded875630bd23a8131cc9dadba7d8f642833f19c
3
+ metadata.gz: 91fd8816de652d5a078fe90e17dc3a5ec1388ec6de2fc121edcd34e697f2cd9e
4
+ data.tar.gz: 759a377518aaf5169c4958265f1fd9921a9abbe152ae8e94ec043e082fce794e
5
5
  SHA512:
6
- metadata.gz: e707490808ef7406eb4992de8b19bfcfcedde374fe067a0b2fb85627d92c91e978733647a31ac4d95089944fdff4185b0be30d259b4c552f2707712403476a4c
7
- data.tar.gz: 8cf15d52787b71890faee3eec4966596aa1697e197761ebb63c94aacb6e3e9514f129897f019284f0d2c35c4017b2c690062b718415d33f0af3ad7baac0bb7ad
6
+ metadata.gz: 91357e50638f8b184f6b518102f336e2caed253a5533b2fdc21340f47e811f3776a1f0d23c98a4fba8568c3e5ce4b41d4e3fda19404382851f29e7cf70f8f7df
7
+ data.tar.gz: 91303f27c83727a58e15731946225757f044241d5570943c7f834ab816ac545a9944e5d13c86fa3d4f20369367de2a3ac7aea0884c8c1f6ebe195bd0095a31fc
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- velopayments (2.35.58.beta1)
4
+ velopayments (2.37.150.beta1)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
@@ -28,7 +28,7 @@ GEM
28
28
  pry (>= 0.13, < 0.15)
29
29
  psych (5.1.1.1)
30
30
  stringio
31
- racc (1.7.2)
31
+ racc (1.7.3)
32
32
  rainbow (3.1.1)
33
33
  rake (13.0.6)
34
34
  rspec (3.12.0)
@@ -53,8 +53,8 @@ GEM
53
53
  ruby-progressbar (~> 1.7)
54
54
  unicode-display_width (>= 1.4.0, < 1.6)
55
55
  ruby-progressbar (1.13.0)
56
- stringio (3.0.8)
57
- typhoeus (1.4.0)
56
+ stringio (3.1.0)
57
+ typhoeus (1.4.1)
58
58
  ethon (>= 0.9.0)
59
59
  unicode-display_width (1.5.0)
60
60
 
data/README.md CHANGED
@@ -77,10 +77,28 @@ This is achieved by setting the HTTP Authorization header with the value set to
77
77
  If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response.
78
78
 
79
79
 
80
+ ## Http Status Codes
81
+ Following is a list of Http Status codes that could be returned by the platform
82
+
83
+ | Status Code | Description |
84
+ | -----------------------| -------------------------------------------------------------------------------------|
85
+ | 200 OK | The request was successfully processed and usually returns a json response |
86
+ | 201 Created | A resource was created and a Location header is returned linking to the new resource |
87
+ | 202 Accepted | The request has been accepted for processing |
88
+ | 204 No Content | The request has been processed and there is no response (usually deletes and updates)|
89
+ | 400 Bad Request | The request is invalid and should be fixed before retrying |
90
+ | 401 Unauthorized | Authentication has failed, usually means the token has expired |
91
+ | 403 Forbidden | The user does not have permissions for the request |
92
+ | 404 Not Found | The resource was not found |
93
+ | 409 Conflict | The resource already exists and there is a conflict |
94
+ | 429 Too Many Requests | The user has submitted too many requests in a given amount of time |
95
+ | 5xx Server Error | Platform internal error (should rarely happen) |
96
+
97
+
80
98
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
81
99
 
82
- - API version: 2.35.58
83
- - Package version: 2.35.58.beta1
100
+ - API version: 2.37.150
101
+ - Package version: 2.37.150.beta1
84
102
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
85
103
 
86
104
  ## Installation
@@ -96,16 +114,16 @@ gem build velopayments.gemspec
96
114
  Then either install the gem locally:
97
115
 
98
116
  ```shell
99
- gem install ./velopayments-2.35.58.beta1.gem
117
+ gem install ./velopayments-2.37.150.beta1.gem
100
118
  ```
101
119
 
102
- (for development, run `gem install --dev ./velopayments-2.35.58.beta1.gem` to install the development dependencies)
120
+ (for development, run `gem install --dev ./velopayments-2.37.150.beta1.gem` to install the development dependencies)
103
121
 
104
122
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
105
123
 
106
124
  Finally add this to the Gemfile:
107
125
 
108
- gem 'velopayments', '~> 2.35.58.beta1'
126
+ gem 'velopayments', '~> 2.37.150.beta1'
109
127
 
110
128
  ### Install from Git
111
129
 
@@ -179,6 +197,13 @@ Class | Method | HTTP request | Description
179
197
  *VeloPayments::PayeeInvitationApi* | [**resend_payee_invite_v3**](docs/PayeeInvitationApi.md#resend_payee_invite_v3) | **POST** /v3/payees/{payeeId}/invite | Resend Payee Invite
180
198
  *VeloPayments::PayeeInvitationApi* | [**resend_payee_invite_v4**](docs/PayeeInvitationApi.md#resend_payee_invite_v4) | **POST** /v4/payees/{payeeId}/invite | Resend Payee Invite
181
199
  *VeloPayments::PayeeInvitationApi* | [**v4_create_payee**](docs/PayeeInvitationApi.md#v4_create_payee) | **POST** /v4/payees | Initiate Payee Creation
200
+ *VeloPayments::PayeePaymentChannelsApi* | [**create_payment_channel_v4**](docs/PayeePaymentChannelsApi.md#create_payment_channel_v4) | **POST** /v4/payees/{payeeId}/paymentChannels/ | Create Payment Channel
201
+ *VeloPayments::PayeePaymentChannelsApi* | [**delete_payment_channel_v4**](docs/PayeePaymentChannelsApi.md#delete_payment_channel_v4) | **DELETE** /v4/payees/{payeeId}/paymentChannels/{paymentChannelId} | Delete Payment Channel
202
+ *VeloPayments::PayeePaymentChannelsApi* | [**enable_payment_channel_v4**](docs/PayeePaymentChannelsApi.md#enable_payment_channel_v4) | **POST** /v4/payees/{payeeId}/paymentChannels/{paymentChannelId}/enable | Enable Payment Channel
203
+ *VeloPayments::PayeePaymentChannelsApi* | [**get_payment_channel_v4**](docs/PayeePaymentChannelsApi.md#get_payment_channel_v4) | **GET** /v4/payees/{payeeId}/paymentChannels/{paymentChannelId} | Get Payment Channel Details
204
+ *VeloPayments::PayeePaymentChannelsApi* | [**get_payment_channels_v4**](docs/PayeePaymentChannelsApi.md#get_payment_channels_v4) | **GET** /v4/payees/{payeeId}/paymentChannels/ | Get All Payment Channels Details
205
+ *VeloPayments::PayeePaymentChannelsApi* | [**update_payment_channel_order_v4**](docs/PayeePaymentChannelsApi.md#update_payment_channel_order_v4) | **PUT** /v4/payees/{payeeId}/paymentChannels/order | Update Payees preferred Payment Channel order
206
+ *VeloPayments::PayeePaymentChannelsApi* | [**update_payment_channel_v4**](docs/PayeePaymentChannelsApi.md#update_payment_channel_v4) | **POST** /v4/payees/{payeeId}/paymentChannels/{paymentChannelId} | Update Payment Channel
182
207
  *VeloPayments::PayeesApi* | [**delete_payee_by_id_v3**](docs/PayeesApi.md#delete_payee_by_id_v3) | **DELETE** /v3/payees/{payeeId} | Delete Payee by Id
183
208
  *VeloPayments::PayeesApi* | [**delete_payee_by_id_v4**](docs/PayeesApi.md#delete_payee_by_id_v4) | **DELETE** /v4/payees/{payeeId} | Delete Payee by Id
184
209
  *VeloPayments::PayeesApi* | [**get_payee_by_id_v3**](docs/PayeesApi.md#get_payee_by_id_v3) | **GET** /v3/payees/{payeeId} | Get Payee by Id
@@ -208,7 +233,6 @@ Class | Method | HTTP request | Description
208
233
  *VeloPayments::PaymentAuditServiceDeprecatedApi* | [**list_payment_changes**](docs/PaymentAuditServiceDeprecatedApi.md#list_payment_changes) | **GET** /v1/deltas/payments | V1 List Payment Changes
209
234
  *VeloPayments::PaymentAuditServiceDeprecatedApi* | [**list_payments_audit_v3**](docs/PaymentAuditServiceDeprecatedApi.md#list_payments_audit_v3) | **GET** /v3/paymentaudit/payments | V3 Get List of Payments
210
235
  *VeloPayments::PayorHierarchyApi* | [**payor_links_v1**](docs/PayorHierarchyApi.md#payor_links_v1) | **GET** /v1/payorLinks | List Payor Links
211
- *VeloPayments::PayorsApi* | [**get_payor_by_id_v1**](docs/PayorsApi.md#get_payor_by_id_v1) | **GET** /v1/payors/{payorId} | Get Payor
212
236
  *VeloPayments::PayorsApi* | [**get_payor_by_id_v2**](docs/PayorsApi.md#get_payor_by_id_v2) | **GET** /v2/payors/{payorId} | Get Payor
213
237
  *VeloPayments::PayorsApi* | [**payor_add_payor_logo_v1**](docs/PayorsApi.md#payor_add_payor_logo_v1) | **POST** /v1/payors/{payorId}/branding/logos | Add Logo
214
238
  *VeloPayments::PayorsApi* | [**payor_create_api_key_v1**](docs/PayorsApi.md#payor_create_api_key_v1) | **POST** /v1/payors/{payorId}/applications/{applicationId}/keys | Create API Key
@@ -234,6 +258,9 @@ Class | Method | HTTP request | Description
234
258
  *VeloPayments::SourceAccountsApi* | [**transfer_funds_v2**](docs/SourceAccountsApi.md#transfer_funds_v2) | **POST** /v2/sourceAccounts/{sourceAccountId}/transfers | Transfer Funds between source accounts
235
259
  *VeloPayments::SourceAccountsApi* | [**transfer_funds_v3**](docs/SourceAccountsApi.md#transfer_funds_v3) | **POST** /v3/sourceAccounts/{sourceAccountId}/transfers | Transfer Funds between source accounts
236
260
  *VeloPayments::TokensApi* | [**resend_token**](docs/TokensApi.md#resend_token) | **POST** /v2/users/{userId}/tokens | Resend a token
261
+ *VeloPayments::TransactionsApi* | [**create_transaction_v1**](docs/TransactionsApi.md#create_transaction_v1) | **POST** /v1/transactions | Create a Transaction
262
+ *VeloPayments::TransactionsApi* | [**get_transaction_by_id_v1**](docs/TransactionsApi.md#get_transaction_by_id_v1) | **GET** /v1/transactions/{transactionId} | Get Transaction
263
+ *VeloPayments::TransactionsApi* | [**get_transactions**](docs/TransactionsApi.md#get_transactions) | **GET** /v1/transactions | Get Transactions
237
264
  *VeloPayments::UsersApi* | [**delete_user_by_id_v2**](docs/UsersApi.md#delete_user_by_id_v2) | **DELETE** /v2/users/{userId} | Delete a User
238
265
  *VeloPayments::UsersApi* | [**disable_user_v2**](docs/UsersApi.md#disable_user_v2) | **POST** /v2/users/{userId}/disable | Disable a User
239
266
  *VeloPayments::UsersApi* | [**enable_user_v2**](docs/UsersApi.md#enable_user_v2) | **POST** /v2/users/{userId}/enable | Enable a User
@@ -263,12 +290,15 @@ Class | Method | HTTP request | Description
263
290
  - [VeloPayments::AcceptedPaymentV3](docs/AcceptedPaymentV3.md)
264
291
  - [VeloPayments::AccessTokenResponse](docs/AccessTokenResponse.md)
265
292
  - [VeloPayments::AccessTokenValidationRequest](docs/AccessTokenValidationRequest.md)
293
+ - [VeloPayments::AddressV4](docs/AddressV4.md)
266
294
  - [VeloPayments::AuthResponse](docs/AuthResponse.md)
267
295
  - [VeloPayments::AutoTopUpConfigV2](docs/AutoTopUpConfigV2.md)
268
296
  - [VeloPayments::AutoTopUpConfigV3](docs/AutoTopUpConfigV3.md)
269
297
  - [VeloPayments::Category](docs/Category.md)
270
298
  - [VeloPayments::ChallengeV3](docs/ChallengeV3.md)
271
299
  - [VeloPayments::ChallengeV4](docs/ChallengeV4.md)
300
+ - [VeloPayments::CommonLinkObject](docs/CommonLinkObject.md)
301
+ - [VeloPayments::CommonPageObject](docs/CommonPageObject.md)
272
302
  - [VeloPayments::CompanyV3](docs/CompanyV3.md)
273
303
  - [VeloPayments::CompanyV4](docs/CompanyV4.md)
274
304
  - [VeloPayments::CreateFundingAccountRequestV2](docs/CreateFundingAccountRequestV2.md)
@@ -286,10 +316,13 @@ Class | Method | HTTP request | Description
286
316
  - [VeloPayments::CreatePayeesCSVResponseV4](docs/CreatePayeesCSVResponseV4.md)
287
317
  - [VeloPayments::CreatePayeesRequestV3](docs/CreatePayeesRequestV3.md)
288
318
  - [VeloPayments::CreatePayeesRequestV4](docs/CreatePayeesRequestV4.md)
319
+ - [VeloPayments::CreatePaymentChannelRequestV4](docs/CreatePaymentChannelRequestV4.md)
289
320
  - [VeloPayments::CreatePaymentChannelV3](docs/CreatePaymentChannelV3.md)
290
321
  - [VeloPayments::CreatePaymentChannelV4](docs/CreatePaymentChannelV4.md)
291
322
  - [VeloPayments::CreatePayorLinkRequest](docs/CreatePayorLinkRequest.md)
292
323
  - [VeloPayments::CreatePayoutRequestV3](docs/CreatePayoutRequestV3.md)
324
+ - [VeloPayments::CreateTransactionRequest](docs/CreateTransactionRequest.md)
325
+ - [VeloPayments::CreateTransactionResponse](docs/CreateTransactionResponse.md)
293
326
  - [VeloPayments::CreateWebhookRequest](docs/CreateWebhookRequest.md)
294
327
  - [VeloPayments::DebitEvent](docs/DebitEvent.md)
295
328
  - [VeloPayments::DebitEventAllOf](docs/DebitEventAllOf.md)
@@ -305,6 +338,7 @@ Class | Method | HTTP request | Description
305
338
  - [VeloPayments::FundingAccountResponseV2](docs/FundingAccountResponseV2.md)
306
339
  - [VeloPayments::FundingAudit](docs/FundingAudit.md)
307
340
  - [VeloPayments::FundingEvent](docs/FundingEvent.md)
341
+ - [VeloPayments::FundingEvent2](docs/FundingEvent2.md)
308
342
  - [VeloPayments::FundingPayorStatusAuditResponse](docs/FundingPayorStatusAuditResponse.md)
309
343
  - [VeloPayments::FundingRequestV2](docs/FundingRequestV2.md)
310
344
  - [VeloPayments::FundingRequestV3](docs/FundingRequestV3.md)
@@ -344,7 +378,6 @@ Class | Method | HTTP request | Description
344
378
  - [VeloPayments::InviteUserRequest](docs/InviteUserRequest.md)
345
379
  - [VeloPayments::LinkForResponse](docs/LinkForResponse.md)
346
380
  - [VeloPayments::ListFundingAccountsResponseV2](docs/ListFundingAccountsResponseV2.md)
347
- - [VeloPayments::ListFundingAccountsResponseV2Links](docs/ListFundingAccountsResponseV2Links.md)
348
381
  - [VeloPayments::ListFundingAccountsResponseV2Page](docs/ListFundingAccountsResponseV2Page.md)
349
382
  - [VeloPayments::ListPaymentsResponseV3](docs/ListPaymentsResponseV3.md)
350
383
  - [VeloPayments::ListPaymentsResponseV3Page](docs/ListPaymentsResponseV3Page.md)
@@ -365,6 +398,7 @@ Class | Method | HTTP request | Description
365
398
  - [VeloPayments::OnboardingStatusChanged](docs/OnboardingStatusChanged.md)
366
399
  - [VeloPayments::PageForResponse](docs/PageForResponse.md)
367
400
  - [VeloPayments::PageResourceFundingPayorStatusAuditResponseFundingPayorStatusAuditResponse](docs/PageResourceFundingPayorStatusAuditResponseFundingPayorStatusAuditResponse.md)
401
+ - [VeloPayments::PageResourceTransactions](docs/PageResourceTransactions.md)
368
402
  - [VeloPayments::PagedPayeeInvitationStatusResponseV3](docs/PagedPayeeInvitationStatusResponseV3.md)
369
403
  - [VeloPayments::PagedPayeeInvitationStatusResponseV3Page](docs/PagedPayeeInvitationStatusResponseV3Page.md)
370
404
  - [VeloPayments::PagedPayeeInvitationStatusResponseV4](docs/PagedPayeeInvitationStatusResponseV4.md)
@@ -404,8 +438,12 @@ Class | Method | HTTP request | Description
404
438
  - [VeloPayments::PayeeTypeEnum](docs/PayeeTypeEnum.md)
405
439
  - [VeloPayments::PayeeUserSelfUpdateRequest](docs/PayeeUserSelfUpdateRequest.md)
406
440
  - [VeloPayments::PaymentChannelCountry](docs/PaymentChannelCountry.md)
441
+ - [VeloPayments::PaymentChannelOrderRequestV4](docs/PaymentChannelOrderRequestV4.md)
442
+ - [VeloPayments::PaymentChannelResponseV4](docs/PaymentChannelResponseV4.md)
407
443
  - [VeloPayments::PaymentChannelRule](docs/PaymentChannelRule.md)
408
444
  - [VeloPayments::PaymentChannelRulesResponse](docs/PaymentChannelRulesResponse.md)
445
+ - [VeloPayments::PaymentChannelSummaryV4](docs/PaymentChannelSummaryV4.md)
446
+ - [VeloPayments::PaymentChannelsResponseV4](docs/PaymentChannelsResponseV4.md)
409
447
  - [VeloPayments::PaymentDelta](docs/PaymentDelta.md)
410
448
  - [VeloPayments::PaymentDeltaResponse](docs/PaymentDeltaResponse.md)
411
449
  - [VeloPayments::PaymentDeltaResponseV1](docs/PaymentDeltaResponseV1.md)
@@ -423,7 +461,6 @@ Class | Method | HTTP request | Description
423
461
  - [VeloPayments::PaymentStatusChanged](docs/PaymentStatusChanged.md)
424
462
  - [VeloPayments::PaymentStatusChangedAllOf](docs/PaymentStatusChangedAllOf.md)
425
463
  - [VeloPayments::PaymentV3](docs/PaymentV3.md)
426
- - [VeloPayments::PayorAddress](docs/PayorAddress.md)
427
464
  - [VeloPayments::PayorAddressV2](docs/PayorAddressV2.md)
428
465
  - [VeloPayments::PayorAmlTransaction](docs/PayorAmlTransaction.md)
429
466
  - [VeloPayments::PayorAmlTransactionV3](docs/PayorAmlTransactionV3.md)
@@ -432,10 +469,12 @@ Class | Method | HTTP request | Description
432
469
  - [VeloPayments::PayorCreateApiKeyResponse](docs/PayorCreateApiKeyResponse.md)
433
470
  - [VeloPayments::PayorCreateApplicationRequest](docs/PayorCreateApplicationRequest.md)
434
471
  - [VeloPayments::PayorEmailOptOutRequest](docs/PayorEmailOptOutRequest.md)
472
+ - [VeloPayments::PayorFundingDetected](docs/PayorFundingDetected.md)
473
+ - [VeloPayments::PayorFundingDetectedAllOf](docs/PayorFundingDetectedAllOf.md)
435
474
  - [VeloPayments::PayorLinksResponse](docs/PayorLinksResponse.md)
436
475
  - [VeloPayments::PayorLinksResponseLinks](docs/PayorLinksResponseLinks.md)
437
476
  - [VeloPayments::PayorLinksResponsePayors](docs/PayorLinksResponsePayors.md)
438
- - [VeloPayments::PayorV1](docs/PayorV1.md)
477
+ - [VeloPayments::PayorToPaymentChannelMappingV4](docs/PayorToPaymentChannelMappingV4.md)
439
478
  - [VeloPayments::PayorV2](docs/PayorV2.md)
440
479
  - [VeloPayments::PayoutCompanyV3](docs/PayoutCompanyV3.md)
441
480
  - [VeloPayments::PayoutIndividualV3](docs/PayoutIndividualV3.md)
@@ -480,13 +519,13 @@ Class | Method | HTTP request | Description
480
519
  - [VeloPayments::SupportedCountryV2](docs/SupportedCountryV2.md)
481
520
  - [VeloPayments::SupportedCurrencyResponseV2](docs/SupportedCurrencyResponseV2.md)
482
521
  - [VeloPayments::SupportedCurrencyV2](docs/SupportedCurrencyV2.md)
522
+ - [VeloPayments::TransactionResponse](docs/TransactionResponse.md)
483
523
  - [VeloPayments::TransferRequestV2](docs/TransferRequestV2.md)
484
524
  - [VeloPayments::TransferRequestV3](docs/TransferRequestV3.md)
485
- - [VeloPayments::TransmissionTypes](docs/TransmissionTypes.md)
486
- - [VeloPayments::TransmissionTypes2](docs/TransmissionTypes2.md)
487
525
  - [VeloPayments::UnregisterMFARequest](docs/UnregisterMFARequest.md)
488
526
  - [VeloPayments::UpdatePayeeDetailsRequestV3](docs/UpdatePayeeDetailsRequestV3.md)
489
527
  - [VeloPayments::UpdatePayeeDetailsRequestV4](docs/UpdatePayeeDetailsRequestV4.md)
528
+ - [VeloPayments::UpdatePaymentChannelRequestV4](docs/UpdatePaymentChannelRequestV4.md)
490
529
  - [VeloPayments::UpdateRemoteIdRequestV3](docs/UpdateRemoteIdRequestV3.md)
491
530
  - [VeloPayments::UpdateRemoteIdRequestV4](docs/UpdateRemoteIdRequestV4.md)
492
531
  - [VeloPayments::UpdateWebhookRequest](docs/UpdateWebhookRequest.md)
@@ -1,4 +1,4 @@
1
- # VeloPayments::PayorAddress
1
+ # VeloPayments::AddressV4
2
2
 
3
3
  ## Properties
4
4
 
@@ -11,14 +11,14 @@
11
11
  | **city** | **String** | | |
12
12
  | **county_or_province** | **String** | | [optional] |
13
13
  | **zip_or_postcode** | **String** | | [optional] |
14
- | **country** | **String** | | |
14
+ | **country** | **String** | Valid ISO 3166 2 character country code. See the &lt;a href&#x3D;\&quot;https://www.iso.org/iso-3166-country-codes.html\&quot; target&#x3D;\&quot;_blank\&quot; a&gt;ISO specification&lt;/a&gt; for details. | |
15
15
 
16
16
  ## Example
17
17
 
18
18
  ```ruby
19
19
  require 'velopayments'
20
20
 
21
- instance = VeloPayments::PayorAddress.new(
21
+ instance = VeloPayments::AddressV4.new(
22
22
  line1: 500 Duval St,
23
23
  line2: null,
24
24
  line3: null,
@@ -0,0 +1,20 @@
1
+ # VeloPayments::CommonLinkObject
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **rel** | **String** | One of: first, last, or self | [optional] |
8
+ | **href** | **String** | the resource URI | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'velopayments'
14
+
15
+ instance = VeloPayments::CommonLinkObject.new(
16
+ rel: first,
17
+ href: https://api.sandbox.velopayments.com/v1/resources?page&#x3D;1&amp;pageSize&#x3D;3&amp;sort&#x3D;lastLoadedAt:asc
18
+ )
19
+ ```
20
+
@@ -0,0 +1,26 @@
1
+ # VeloPayments::CommonPageObject
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **number_of_elements** | **Integer** | | [optional] |
8
+ | **total_elements** | **Integer** | | [optional] |
9
+ | **total_pages** | **Integer** | | [optional] |
10
+ | **page** | **Integer** | | [optional] |
11
+ | **page_size** | **Integer** | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'velopayments'
17
+
18
+ instance = VeloPayments::CommonPageObject.new(
19
+ number_of_elements: 10,
20
+ total_elements: 10,
21
+ total_pages: 10,
22
+ page: 10,
23
+ page_size: 10
24
+ )
25
+ ```
26
+
@@ -10,7 +10,7 @@
10
10
  | **account_name** | **String** | Required if type is either FBO or PRIVATE | [optional] |
11
11
  | **account_number** | **String** | Required if type is either FBO or PRIVATE | [optional] |
12
12
  | **routing_number** | **String** | Required if type is either FBO or PRIVATE | [optional] |
13
- | **currency** | **String** | ISO 4217 currency code, Required if type is either WUBS_DECOUPLED or PRIVATE | [optional] |
13
+ | **country_code** | **String** | ISO 3166-1 2 letter country code (upper case) | |
14
14
 
15
15
  ## Example
16
16
 
@@ -24,7 +24,7 @@ instance = VeloPayments::CreateFundingAccountRequestV2.new(
24
24
  account_name: null,
25
25
  account_number: null,
26
26
  routing_number: null,
27
- currency: USD
27
+ country_code: US
28
28
  )
29
29
  ```
30
30
 
@@ -0,0 +1,30 @@
1
+ # VeloPayments::CreatePaymentChannelRequestV4
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **payment_channel_name** | **String** | | [optional] |
8
+ | **iban** | **String** | Must match the regular expression &#x60;&#x60;&#x60;^[A-Za-z0-9]+$&#x60;&#x60;&#x60;. | [optional] |
9
+ | **account_number** | **String** | | [optional] |
10
+ | **routing_number** | **String** | | [optional] |
11
+ | **country_code** | **String** | Valid ISO 3166 2 character country code. See the &lt;a href&#x3D;\&quot;https://www.iso.org/iso-3166-country-codes.html\&quot; target&#x3D;\&quot;_blank\&quot; a&gt;ISO specification&lt;/a&gt; for details. | [optional] |
12
+ | **currency** | **String** | Valid ISO 4217 3 letter currency code. See the &lt;a href&#x3D;\&quot;https://www.iso.org/iso-4217-currency-codes.html\&quot; target&#x3D;\&quot;_blank\&quot; a&gt;ISO specification&lt;/a&gt; for details. | [optional] |
13
+ | **account_name** | **String** | | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'velopayments'
19
+
20
+ instance = VeloPayments::CreatePaymentChannelRequestV4.new(
21
+ payment_channel_name: My Payment Channel,
22
+ iban: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX1234,
23
+ account_number: XXXXXX5678,
24
+ routing_number: XXXXX6789,
25
+ country_code: US,
26
+ currency: USD,
27
+ account_name: My Account
28
+ )
29
+ ```
30
+
@@ -0,0 +1,24 @@
1
+ # VeloPayments::CreateTransactionRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **payor_id** | **String** | Indicates the Payor creating the Transaction and which matches the payorId on the provided source account | |
8
+ | **source_account_name** | **String** | The name of the source account that the new Transaction will be associated with and any funding containing the transactionShortCode will credit. | |
9
+ | **transaction_reference** | **String** | The payors own reference for the transaction that can later be used for querying and retrieval. | |
10
+ | **transaction_metadata** | **Hash&lt;String, String&gt;** | Optional metadata that will be attached to the created transaction and can that can be retrieved later.| The total length of all the keys and values provided in the metadata must be no more than 4000 chars. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'velopayments'
16
+
17
+ instance = VeloPayments::CreateTransactionRequest.new(
18
+ payor_id: null,
19
+ source_account_name: Payor_FOO_USD_Account,
20
+ transaction_reference: myInvoiceNumber-1234567890,
21
+ transaction_metadata: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,20 @@
1
+ # VeloPayments::CreateTransactionResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **transaction_id** | **String** | The Id of the newly created transaction | |
8
+ | **transaction_short_code** | **String** | The short code for the transaction that can be used when sending funds into the platform | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'velopayments'
14
+
15
+ instance = VeloPayments::CreateTransactionResponse.new(
16
+ transaction_id: 4d88e559-d057-45b1-8d8b-b9ccc06f4503,
17
+ transaction_short_code: T1234ABC
18
+ )
19
+ ```
20
+
@@ -11,8 +11,8 @@
11
11
  | **routing_number** | **String** | bank account routing number | [optional] |
12
12
  | **name** | **String** | name of funding account | [optional] |
13
13
  | **currency** | **String** | Valid ISO 4217 3 letter currency code. See the &lt;a href&#x3D;\&quot;https://www.iso.org/iso-4217-currency-codes.html\&quot; target&#x3D;\&quot;_blank\&quot; a&gt;ISO specification&lt;/a&gt; for details. | [optional] |
14
- | **country** | **String** | ISO 3166-1 2 letter country code (upper case) | [optional] |
15
- | **type** | **String** | Funding account type. One of the following values: FBO, WUBS_DECOUPLED, PRIVATE | [optional] |
14
+ | **country_code** | **String** | ISO 3166-1 2 letter country code (upper case) | [optional] |
15
+ | **type** | **String** | Funding account type. One of the following values: FBO, PRIVATE | [optional] |
16
16
  | **archived** | **Boolean** | A flag for whether the funding account has been archived. Only present in the response if true. | [optional] |
17
17
 
18
18
  ## Example
@@ -28,7 +28,7 @@ instance = VeloPayments::FundingAccountResponseV2.new(
28
28
  routing_number: 12345678,
29
29
  name: My Funding Account,
30
30
  currency: USD,
31
- country: US,
31
+ country_code: US,
32
32
  type: FBO,
33
33
  archived: null
34
34
  )
data/docs/FundingApi.md CHANGED
@@ -248,7 +248,7 @@ api_instance = VeloPayments::FundingApi.new
248
248
  opts = {
249
249
  payor_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String |
250
250
  name: 'name_example', # String | The descriptive funding account name
251
- country: 'US', # String | The 2 letter ISO 3166-1 country code (upper case)
251
+ country_code: 'US', # String | The 2 letter ISO 3166-1 country code (upper case)
252
252
  currency: 'USD', # String | The ISO 4217 currency code
253
253
  type: 'type_example', # String | The type of funding account.
254
254
  page: 56, # Integer | Page number. Default is 1.
@@ -290,7 +290,7 @@ end
290
290
  | ---- | ---- | ----------- | ----- |
291
291
  | **payor_id** | **String** | | [optional] |
292
292
  | **name** | **String** | The descriptive funding account name | [optional] |
293
- | **country** | **String** | The 2 letter ISO 3166-1 country code (upper case) | [optional] |
293
+ | **country_code** | **String** | The 2 letter ISO 3166-1 country code (upper case) | [optional] |
294
294
  | **currency** | **String** | The ISO 4217 currency code | [optional] |
295
295
  | **type** | **String** | The type of funding account. | [optional] |
296
296
  | **page** | **Integer** | Page number. Default is 1. | [optional][default to 1] |
data/docs/FundingAudit.md CHANGED
@@ -4,6 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **payor_id** | **String** | The id of the payor associated with the funding. | [optional] |
7
8
  | **amount** | **Float** | The amount funded | [optional] |
8
9
  | **currency** | **String** | The currency of the funding | [optional] |
9
10
  | **date_time** | **Time** | | [optional] |
@@ -11,8 +12,10 @@
11
12
  | **source_account_name** | **String** | | [optional] |
12
13
  | **funding_account_name** | **String** | | [optional] |
13
14
  | **funding_type** | **String** | Funding type. One of the following values: ACH, WIRE, EMBEDDED, BANK_TRANSFER | [optional] |
14
- | **events** | [**Array&lt;FundingEvent&gt;**](FundingEvent.md) | | [optional] |
15
+ | **events** | [**Array&lt;FundingEvent2&gt;**](FundingEvent2.md) | | [optional] |
15
16
  | **topup_type** | **String** | Type of top up. One of the following values: AUTOMATIC, MANUAL | [optional] |
17
+ | **transaction_id** | **String** | The id of the transaction associated with the funding if there was one | [optional] |
18
+ | **transaction_reference** | **String** | The payors reference for the transaction associated with the funding if there was one | [optional] |
16
19
 
17
20
  ## Example
18
21
 
@@ -20,6 +23,7 @@
20
23
  require 'velopayments'
21
24
 
22
25
  instance = VeloPayments::FundingAudit.new(
26
+ payor_id: null,
23
27
  amount: 120000,
24
28
  currency: USD,
25
29
  date_time: null,
@@ -28,7 +32,9 @@ instance = VeloPayments::FundingAudit.new(
28
32
  funding_account_name: null,
29
33
  funding_type: null,
30
34
  events: null,
31
- topup_type: null
35
+ topup_type: null,
36
+ transaction_id: null,
37
+ transaction_reference: null
32
38
  )
33
39
  ```
34
40
 
data/docs/FundingEvent.md CHANGED
@@ -4,10 +4,9 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **event_id** | **String** | | [optional] |
8
- | **event_date_time** | **Time** | | [optional] |
9
- | **funding_event_type** | **String** | Funding event type. One of the following values: PAYOR_FUNDING_DETECTED, PAYOR_FUNDING_REQUESTED, PAYOR_FUNDING_RETURN_RECEIVED, FUNDING_RETURN_DETECTED, PAYOR_FUNDING_REQUEST_SUBMITTED, PAYOR_FUNDING_ENTRY_DETAIL_RECEIVED, FUNDING_DEALLOCATED | [optional] |
10
- | **principal** | **String** | | [optional] |
7
+ | **source_type** | **String** | OA3 Schema type name for the source info which is used as the discriminator value to ensure that data binding works correctly | |
8
+ | **event_id** | **String** | UUID id of the source event in the Velo platform | |
9
+ | **created_at** | **Time** | ISO8601 timestamp indicating when the source event was created | |
11
10
 
12
11
  ## Example
13
12
 
@@ -15,10 +14,9 @@
15
14
  require 'velopayments'
16
15
 
17
16
  instance = VeloPayments::FundingEvent.new(
18
- event_id: null,
19
- event_date_time: null,
20
- funding_event_type: null,
21
- principal: null
17
+ source_type: payment_status_changed,
18
+ event_id: 270ab907-27ec-4b83-8028-0ff432bbdec4,
19
+ created_at: 2020-06-18T15:09:42Z
22
20
  )
23
21
  ```
24
22
 
@@ -0,0 +1,24 @@
1
+ # VeloPayments::FundingEvent2
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **event_id** | **String** | | [optional] |
8
+ | **event_date_time** | **Time** | | [optional] |
9
+ | **funding_event_type** | **String** | Funding event type. One of the following values: PAYOR_FUNDING_DETECTED, PAYOR_FUNDING_REQUESTED, PAYOR_FUNDING_RETURN_RECEIVED, FUNDING_RETURN_DETECTED, PAYOR_FUNDING_REQUEST_SUBMITTED, PAYOR_FUNDING_ENTRY_DETAIL_RECEIVED, FUNDING_DEALLOCATED | [optional] |
10
+ | **principal** | **String** | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'velopayments'
16
+
17
+ instance = VeloPayments::FundingEvent2.new(
18
+ event_id: null,
19
+ event_date_time: null,
20
+ funding_event_type: null,
21
+ principal: null
22
+ )
23
+ ```
24
+
@@ -29,7 +29,7 @@ end
29
29
 
30
30
  api_instance = VeloPayments::FundingManagerPrivateApi.new
31
31
  opts = {
32
- create_funding_account_request_v2: VeloPayments::CreateFundingAccountRequestV2.new({type: 'FBO', name: 'name_example', payor_id: 'payor_id_example'}) # CreateFundingAccountRequestV2 |
32
+ create_funding_account_request_v2: VeloPayments::CreateFundingAccountRequestV2.new({type: 'FBO', name: 'name_example', payor_id: 'payor_id_example', country_code: 'US'}) # CreateFundingAccountRequestV2 |
33
33
  }
34
34
 
35
35
  begin
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **funding_id** | **String** | | |
8
8
  | **payor_id** | **String** | | |
9
- | **allocation_date** | **Time** | | |
9
+ | **created_at** | **Time** | The date and time the funding was created | |
10
10
  | **detected_funding_ref** | **String** | | [optional] |
11
11
  | **amount** | **Integer** | | |
12
12
  | **currency** | **String** | Valid ISO 4217 3 letter currency code. See the &lt;a href&#x3D;\&quot;https://www.iso.org/iso-4217-currency-codes.html\&quot; target&#x3D;\&quot;_blank\&quot; a&gt;ISO specification&lt;/a&gt; for details. | |
@@ -14,9 +14,11 @@
14
14
  | **physical_account_name** | **String** | | [optional] |
15
15
  | **source_account_id** | **String** | | [optional] |
16
16
  | **allocation_type** | **String** | Funding Allocation Type. One of the following values: AUTOMATIC, MANUAL | [optional] |
17
+ | **allocated_at** | **Time** | Populated only if the funding has been allocated. The date and time the funding was allocated. | [optional] |
18
+ | **allocation_date** | **Time** | Populated with allocatedAt if allocated otherwise createdAt. Deprecated in v2.36 - will be removed in the future. | [optional] |
17
19
  | **reason** | **String** | | [optional] |
18
20
  | **hidden_date** | **Time** | | [optional] |
19
- | **funding_account_type** | **String** | Funding Account Type. One of the following values: FBO, WUBS_DECOUPLED, PRIVATE | |
21
+ | **funding_account_type** | **String** | Funding Account Type. One of the following values: FBO, PRIVATE | |
20
22
  | **status** | **String** | Current status of the funding. One of the follwing values: PENDING, UNALLOCATED, ALLOCATED, HIDDEN, RETURNED, RETURNING, BULK_RETURN, OTHER | |
21
23
 
22
24
  ## Example
@@ -27,7 +29,7 @@ require 'velopayments'
27
29
  instance = VeloPayments::FundingResponse.new(
28
30
  funding_id: null,
29
31
  payor_id: null,
30
- allocation_date: null,
32
+ created_at: null,
31
33
  detected_funding_ref: null,
32
34
  amount: null,
33
35
  currency: USD,
@@ -35,6 +37,8 @@ instance = VeloPayments::FundingResponse.new(
35
37
  physical_account_name: null,
36
38
  source_account_id: null,
37
39
  allocation_type: null,
40
+ allocated_at: null,
41
+ allocation_date: null,
38
42
  reason: null,
39
43
  hidden_date: null,
40
44
  funding_account_type: FBO,
@@ -19,6 +19,7 @@
19
19
  | **disabled** | **Boolean** | | [optional] |
20
20
  | **disabled_comment** | **String** | | [optional] |
21
21
  | **disabled_updated_timestamp** | **Time** | | [optional] |
22
+ | **managed_by_payor_id** | **String** | The id of the payor if the payee is managed | [optional] |
22
23
  | **individual** | [**GetPayeeListResponseIndividualV4**](GetPayeeListResponseIndividualV4.md) | | [optional] |
23
24
  | **company** | [**GetPayeeListResponseCompanyV4**](GetPayeeListResponseCompanyV4.md) | | [optional] |
24
25
 
@@ -43,6 +44,7 @@ instance = VeloPayments::GetPayeeListResponseV4.new(
43
44
  disabled: null,
44
45
  disabled_comment: reason for disabled,
45
46
  disabled_updated_timestamp: 2019-01-20T09:00Z,
47
+ managed_by_payor_id: a2967711-df07-41e5-b5ea-0f563088911c,
46
48
  individual: null,
47
49
  company: null
48
50
  )
@@ -4,7 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **fx_rate_degredation_threshold_percentage** | **Float** | Halt instruction if the FX rates have become worse since the last quote | [optional] |
7
+ | **fx_rate_degredation_threshold_percentage** | **Float** | Halt instruction if the FX rates have become worse since the last quote. Property deprecated because of misspelled. Please use fxRateDegradationThresholdPercentage. | [optional] |
8
+ | **fx_rate_degradation_threshold_percentage** | **Float** | Halt instruction if the FX rates have become worse since the last quote. Previously called fxRateDegredationThresholdPercentage. | [optional] |
8
9
 
9
10
  ## Example
10
11
 
@@ -12,7 +13,8 @@
12
13
  require 'velopayments'
13
14
 
14
15
  instance = VeloPayments::InstructPayoutRequestV3.new(
15
- fx_rate_degredation_threshold_percentage: null
16
+ fx_rate_degredation_threshold_percentage: null,
17
+ fx_rate_degradation_threshold_percentage: null
16
18
  )
17
19
  ```
18
20
 
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **page** | [**ListFundingAccountsResponseV2Page**](ListFundingAccountsResponseV2Page.md) | | [optional] |
8
- | **links** | [**Array&lt;ListFundingAccountsResponseV2Links&gt;**](ListFundingAccountsResponseV2Links.md) | | [optional] |
8
+ | **links** | [**Array&lt;ListSourceAccountResponseV2Links&gt;**](ListSourceAccountResponseV2Links.md) | | [optional] |
9
9
  | **content** | [**Array&lt;FundingAccountResponseV2&gt;**](FundingAccountResponseV2.md) | | [optional] |
10
10
 
11
11
  ## Example