velopayments 2.14.90.pre.1 → 2.17.8.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 (394) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/Makefile +41 -9
  4. data/README.md +61 -23
  5. data/docs/AuthApi.md +8 -9
  6. data/docs/AuthResponse.md +3 -1
  7. data/docs/CompanyResponse.md +19 -0
  8. data/docs/{Company.md → CompanyV1.md} +2 -2
  9. data/docs/CreateIndividual.md +1 -1
  10. data/docs/CreateIndividual2.md +21 -0
  11. data/docs/CreatePayee.md +3 -3
  12. data/docs/CreatePayee2.md +37 -0
  13. data/docs/CreatePayeeAddress.md +1 -1
  14. data/docs/CreatePayeeAddress2.md +31 -0
  15. data/docs/CreatePayeesCSVRequest.md +1 -1
  16. data/docs/CreatePayeesCSVRequest2.md +73 -0
  17. data/docs/CreatePayeesCSVResponse2.md +19 -0
  18. data/docs/CreatePayeesRequest2.md +19 -0
  19. data/docs/CreatePaymentChannel2.md +29 -0
  20. data/docs/CreatePayoutRequest.md +6 -2
  21. data/docs/Error.md +23 -0
  22. data/docs/ErrorResponse.md +19 -0
  23. data/docs/FundingAudit.md +3 -1
  24. data/docs/FundingDelta.md +23 -0
  25. data/docs/FundingDeltaResponse.md +21 -0
  26. data/docs/FundingDeltaResponseLinks.md +19 -0
  27. data/docs/FundingEvent.md +3 -1
  28. data/docs/FundingManagerApi.md +33 -26
  29. data/docs/GetFundingsResponse.md +1 -1
  30. data/docs/GetFundingsResponseAllOf.md +1 -1
  31. data/docs/GetPaymentsForPayoutResponseV4.md +2 -2
  32. data/docs/GetPaymentsForPayoutResponseV4Summary.md +16 -0
  33. data/docs/GetPayoutsResponseV4.md +3 -3
  34. data/docs/IndividualResponse.md +17 -0
  35. data/docs/{Individual.md → IndividualV1.md} +5 -5
  36. data/docs/{IndividualName.md → IndividualV1Name.md} +2 -2
  37. data/docs/PagedPayeeInvitationStatusResponse.md +2 -2
  38. data/docs/PagedPayeeResponse.md +23 -0
  39. data/docs/PagedPayeeResponse2.md +23 -0
  40. data/docs/PagedPayeeResponse2Summary.md +25 -0
  41. data/docs/{PayeeResponseLinks.md → PagedPayeeResponseLinks.md} +2 -2
  42. data/docs/{PayeeResponsePage.md → PagedPayeeResponsePage.md} +2 -2
  43. data/docs/{PayeeResponseSummary.md → PagedPayeeResponseSummary.md} +2 -2
  44. data/docs/Payee.md +9 -9
  45. data/docs/{Address.md → PayeeAddress.md} +2 -2
  46. data/docs/PayeeDelta.md +1 -1
  47. data/docs/PayeeInvitationApi.md +109 -3
  48. data/docs/{PaymentChannel.md → PayeePaymentChannel.md} +2 -2
  49. data/docs/{PayorRef.md → PayeePayorRef.md} +2 -2
  50. data/docs/PayeePayorRef2.md +21 -0
  51. data/docs/PayeeResponse.md +40 -8
  52. data/docs/PayeeResponse2.md +55 -0
  53. data/docs/PayeesApi.md +133 -4
  54. data/docs/PaymentAuditServiceApi.md +70 -7
  55. data/docs/PaymentDelta.md +31 -0
  56. data/docs/PaymentDeltaResponse.md +21 -0
  57. data/docs/PaymentResponseV4.md +4 -2
  58. data/docs/PaymentResponseV4Payout.md +19 -0
  59. data/docs/PaymentStatus.md +16 -0
  60. data/docs/PayorAddress.md +31 -0
  61. data/docs/PayorAddressV2.md +31 -0
  62. data/docs/PayorV1.md +9 -7
  63. data/docs/PayorV2.md +9 -7
  64. data/docs/PayorsApi.md +8 -6
  65. data/docs/PayoutPayorV4.md +25 -0
  66. data/docs/PayoutPrincipalV4.md +19 -0
  67. data/docs/PayoutSummaryAuditV4.md +5 -3
  68. data/docs/PayoutTypeV4.md +16 -0
  69. data/docs/QuoteFxSummary.md +2 -2
  70. data/docs/UpdateRemoteIdRequest.md +19 -0
  71. data/docs/WatchlistStatus.md +16 -0
  72. data/lib/velopayments.rb +41 -12
  73. data/lib/velopayments/api/auth_api.rb +9 -16
  74. data/lib/velopayments/api/countries_api.rb +2 -2
  75. data/lib/velopayments/api/currencies_api.rb +2 -2
  76. data/lib/velopayments/api/funding_manager_api.rb +63 -55
  77. data/lib/velopayments/api/get_payout_api.rb +3 -3
  78. data/lib/velopayments/api/instruct_payout_api.rb +3 -3
  79. data/lib/velopayments/api/payee_invitation_api.rb +134 -8
  80. data/lib/velopayments/api/payees_api.rb +177 -9
  81. data/lib/velopayments/api/payment_audit_service_api.rb +95 -12
  82. data/lib/velopayments/api/payor_applications_api.rb +4 -4
  83. data/lib/velopayments/api/payors_api.rb +18 -19
  84. data/lib/velopayments/api/payout_history_api.rb +4 -4
  85. data/lib/velopayments/api/quote_payout_api.rb +3 -3
  86. data/lib/velopayments/api/submit_payout_api.rb +2 -2
  87. data/lib/velopayments/api/withdraw_payout_api.rb +3 -3
  88. data/lib/velopayments/api_client.rb +30 -30
  89. data/lib/velopayments/api_error.rb +2 -2
  90. data/lib/velopayments/configuration.rb +9 -2
  91. data/lib/velopayments/models/auth_response.rb +28 -7
  92. data/lib/velopayments/models/auto_top_up_config.rb +15 -3
  93. data/lib/velopayments/models/challenge.rb +13 -3
  94. data/lib/velopayments/models/company_response.rb +273 -0
  95. data/lib/velopayments/models/{company.rb → company_v1.rb} +18 -6
  96. data/lib/velopayments/models/create_individual.rb +14 -4
  97. data/lib/velopayments/models/create_individual2.rb +259 -0
  98. data/lib/velopayments/models/create_payee.rb +17 -5
  99. data/lib/velopayments/models/{payor_funding_bank_details_update.rb → create_payee2.rb} +153 -93
  100. data/lib/velopayments/models/create_payee_address.rb +19 -3
  101. data/lib/velopayments/models/create_payee_address2.rb +510 -0
  102. data/lib/velopayments/models/create_payees_csv_request.rb +14 -3
  103. data/lib/velopayments/models/create_payees_csv_request2.rb +1142 -0
  104. data/lib/velopayments/models/create_payees_csv_response.rb +13 -3
  105. data/lib/velopayments/models/create_payees_csv_response2.rb +217 -0
  106. data/lib/velopayments/models/create_payees_request.rb +13 -3
  107. data/lib/velopayments/models/create_payees_request2.rb +227 -0
  108. data/lib/velopayments/models/create_payment_channel.rb +13 -3
  109. data/lib/velopayments/models/create_payment_channel2.rb +418 -0
  110. data/lib/velopayments/models/create_payout_request.rb +36 -9
  111. data/lib/velopayments/models/error.rb +271 -0
  112. data/lib/velopayments/models/error_response.rb +222 -0
  113. data/lib/velopayments/models/failed_submission.rb +13 -3
  114. data/lib/velopayments/models/funding_audit.rb +38 -7
  115. data/lib/velopayments/models/funding_delta.rb +298 -0
  116. data/lib/velopayments/models/funding_delta_response.rb +229 -0
  117. data/lib/velopayments/models/funding_delta_response_links.rb +215 -0
  118. data/lib/velopayments/models/funding_event.rb +26 -7
  119. data/lib/velopayments/models/funding_event_type.rb +2 -2
  120. data/lib/velopayments/models/funding_request_v1.rb +13 -3
  121. data/lib/velopayments/models/funding_request_v2.rb +13 -3
  122. data/lib/velopayments/models/fx_summary_v3.rb +13 -3
  123. data/lib/velopayments/models/fx_summary_v4.rb +13 -3
  124. data/lib/velopayments/models/get_fundings_response.rb +17 -5
  125. data/lib/velopayments/models/get_fundings_response_all_of.rb +17 -5
  126. data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +13 -3
  127. data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +13 -3
  128. data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +13 -3
  129. data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +15 -5
  130. data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +87 -4
  131. data/lib/velopayments/models/get_payout_statistics.rb +13 -3
  132. data/lib/velopayments/models/get_payouts_response_v3.rb +13 -3
  133. data/lib/velopayments/models/get_payouts_response_v3_links.rb +13 -3
  134. data/lib/velopayments/models/get_payouts_response_v3_page.rb +13 -3
  135. data/lib/velopayments/models/get_payouts_response_v3_summary.rb +13 -3
  136. data/lib/velopayments/models/get_payouts_response_v4.rb +16 -6
  137. data/lib/velopayments/models/individual_response.rb +211 -0
  138. data/lib/velopayments/models/{individual.rb → individual_v1.rb} +17 -7
  139. data/lib/velopayments/models/{individual_name.rb → individual_v1_name.rb} +16 -6
  140. data/lib/velopayments/models/invitation_status.rb +2 -2
  141. data/lib/velopayments/models/invitation_status_response.rb +13 -3
  142. data/lib/velopayments/models/invite_payee_request.rb +13 -3
  143. data/lib/velopayments/models/language.rb +2 -2
  144. data/lib/velopayments/models/list_payments_response.rb +13 -3
  145. data/lib/velopayments/models/list_payments_response_page.rb +13 -3
  146. data/lib/velopayments/models/list_payments_response_summary.rb +13 -3
  147. data/lib/velopayments/models/list_source_account_response.rb +13 -3
  148. data/lib/velopayments/models/list_source_account_response_links.rb +13 -3
  149. data/lib/velopayments/models/list_source_account_response_page.rb +13 -3
  150. data/lib/velopayments/models/list_source_account_response_v2.rb +13 -3
  151. data/lib/velopayments/models/list_source_account_response_v2_page.rb +13 -3
  152. data/lib/velopayments/models/marketing_opt_in.rb +13 -3
  153. data/lib/velopayments/models/notifications.rb +13 -3
  154. data/lib/velopayments/models/ofac_status.rb +2 -2
  155. data/lib/velopayments/models/onboarded_status.rb +2 -2
  156. data/lib/velopayments/models/paged_payee_invitation_status_response.rb +15 -5
  157. data/lib/velopayments/models/paged_payee_response.rb +238 -0
  158. data/lib/velopayments/models/paged_payee_response2.rb +238 -0
  159. data/lib/velopayments/models/paged_payee_response2_summary.rb +242 -0
  160. data/lib/velopayments/models/{payee_response_links.rb → paged_payee_response_links.rb} +16 -6
  161. data/lib/velopayments/models/{payee_response_page.rb → paged_payee_response_page.rb} +16 -6
  162. data/lib/velopayments/models/{payee_response_summary.rb → paged_payee_response_summary.rb} +16 -6
  163. data/lib/velopayments/models/paged_response.rb +13 -3
  164. data/lib/velopayments/models/paged_response_page.rb +13 -3
  165. data/lib/velopayments/models/payee.rb +24 -8
  166. data/lib/velopayments/models/{address.rb → payee_address.rb} +21 -6
  167. data/lib/velopayments/models/payee_delta.rb +14 -3
  168. data/lib/velopayments/models/payee_delta_response.rb +13 -3
  169. data/lib/velopayments/models/payee_delta_response_links.rb +13 -3
  170. data/lib/velopayments/models/payee_delta_response_page.rb +13 -3
  171. data/lib/velopayments/models/payee_invitation_status.rb +13 -3
  172. data/lib/velopayments/models/payee_invitation_status_response.rb +13 -3
  173. data/lib/velopayments/models/{payment_channel.rb → payee_payment_channel.rb} +16 -6
  174. data/lib/velopayments/models/{payor_ref.rb → payee_payor_ref.rb} +16 -6
  175. data/lib/velopayments/models/payee_payor_ref2.rb +224 -0
  176. data/lib/velopayments/models/payee_response.rb +192 -32
  177. data/lib/velopayments/models/payee_response2.rb +388 -0
  178. data/lib/velopayments/models/payee_type.rb +2 -2
  179. data/lib/velopayments/models/payment_audit_currency_v3.rb +2 -2
  180. data/lib/velopayments/models/payment_audit_currency_v4.rb +2 -2
  181. data/lib/velopayments/models/payment_channel_country.rb +13 -3
  182. data/lib/velopayments/models/payment_channel_rule.rb +13 -3
  183. data/lib/velopayments/models/payment_channel_rules_response.rb +13 -3
  184. data/lib/velopayments/models/payment_delta.rb +285 -0
  185. data/lib/velopayments/models/payment_delta_response.rb +229 -0
  186. data/lib/velopayments/models/payment_event_response_v3.rb +13 -3
  187. data/lib/velopayments/models/payment_event_response_v4.rb +13 -3
  188. data/lib/velopayments/models/payment_instruction.rb +13 -3
  189. data/lib/velopayments/models/payment_response_v3.rb +13 -3
  190. data/lib/velopayments/models/payment_response_v4.rb +27 -7
  191. data/lib/velopayments/models/payment_response_v4_payout.rb +215 -0
  192. data/lib/velopayments/models/payment_status.rb +42 -0
  193. data/lib/velopayments/models/payor_address.rb +493 -0
  194. data/lib/velopayments/models/payor_address_v2.rb +493 -0
  195. data/lib/velopayments/models/payor_branding_response.rb +16 -3
  196. data/lib/velopayments/models/payor_create_api_key_request.rb +14 -3
  197. data/lib/velopayments/models/payor_create_api_key_response.rb +13 -3
  198. data/lib/velopayments/models/payor_create_application_request.rb +14 -3
  199. data/lib/velopayments/models/payor_email_opt_out_request.rb +13 -3
  200. data/lib/velopayments/models/payor_links_response.rb +13 -3
  201. data/lib/velopayments/models/payor_links_response_links.rb +13 -3
  202. data/lib/velopayments/models/payor_links_response_payors.rb +13 -3
  203. data/lib/velopayments/models/payor_logo_request.rb +13 -3
  204. data/lib/velopayments/models/payor_v1.rb +27 -8
  205. data/lib/velopayments/models/payor_v2.rb +27 -8
  206. data/lib/velopayments/models/payout_payor_v4.rb +273 -0
  207. data/lib/velopayments/models/payout_principal_v4.rb +228 -0
  208. data/lib/velopayments/models/payout_status_v3.rb +2 -2
  209. data/lib/velopayments/models/payout_status_v4.rb +2 -2
  210. data/lib/velopayments/models/payout_summary_audit_v3.rb +13 -3
  211. data/lib/velopayments/models/payout_summary_audit_v4.rb +33 -8
  212. data/lib/velopayments/models/payout_summary_response.rb +13 -3
  213. data/lib/velopayments/models/payout_type_v4.rb +37 -0
  214. data/lib/velopayments/models/query_batch_response.rb +13 -3
  215. data/lib/velopayments/models/quote_fx_summary.rb +69 -3
  216. data/lib/velopayments/models/quote_response.rb +13 -3
  217. data/lib/velopayments/models/rejected_payment.rb +13 -3
  218. data/lib/velopayments/models/set_notifications_request.rb +13 -3
  219. data/lib/velopayments/models/source_account.rb +13 -3
  220. data/lib/velopayments/models/source_account_response.rb +15 -3
  221. data/lib/velopayments/models/source_account_response_v2.rb +15 -3
  222. data/lib/velopayments/models/source_account_summary_v3.rb +13 -3
  223. data/lib/velopayments/models/source_account_summary_v4.rb +13 -3
  224. data/lib/velopayments/models/supported_countries_response.rb +13 -3
  225. data/lib/velopayments/models/supported_country.rb +13 -3
  226. data/lib/velopayments/models/supported_currency.rb +13 -3
  227. data/lib/velopayments/models/supported_currency_response.rb +13 -3
  228. data/lib/velopayments/models/update_remote_id_request.rb +253 -0
  229. data/lib/velopayments/models/watchlist_status.rb +39 -0
  230. data/lib/velopayments/version.rb +3 -3
  231. data/oa3-config.json +2 -2
  232. data/spec/api/auth_api_spec.rb +3 -4
  233. data/spec/api/countries_api_spec.rb +2 -2
  234. data/spec/api/currencies_api_spec.rb +2 -2
  235. data/spec/api/funding_manager_api_spec.rb +17 -15
  236. data/spec/api/get_payout_api_spec.rb +2 -2
  237. data/spec/api/instruct_payout_api_spec.rb +2 -2
  238. data/spec/api/payee_invitation_api_spec.rb +27 -3
  239. data/spec/api/payees_api_spec.rb +39 -4
  240. data/spec/api/payment_audit_service_api_spec.rb +21 -5
  241. data/spec/api/payor_applications_api_spec.rb +2 -2
  242. data/spec/api/payors_api_spec.rb +5 -4
  243. data/spec/api/payout_history_api_spec.rb +2 -2
  244. data/spec/api/quote_payout_api_spec.rb +2 -2
  245. data/spec/api/submit_payout_api_spec.rb +2 -2
  246. data/spec/api/withdraw_payout_api_spec.rb +2 -2
  247. data/spec/api_client_spec.rb +3 -3
  248. data/spec/configuration_spec.rb +2 -2
  249. data/spec/models/auth_response_spec.rb +8 -2
  250. data/spec/models/auto_top_up_config_spec.rb +2 -2
  251. data/spec/models/challenge_spec.rb +2 -2
  252. data/spec/models/company_response_spec.rb +47 -0
  253. data/spec/models/{company_spec.rb → company_v1_spec.rb} +8 -8
  254. data/spec/models/{payor_funding_bank_details_update_spec.rb → create_individual2_spec.rb} +11 -11
  255. data/spec/models/create_individual_spec.rb +2 -2
  256. data/spec/models/create_payee2_spec.rb +101 -0
  257. data/spec/models/create_payee_address2_spec.rb +87 -0
  258. data/spec/models/create_payee_address_spec.rb +2 -2
  259. data/spec/models/create_payee_spec.rb +2 -2
  260. data/spec/models/create_payees_csv_request2_spec.rb +225 -0
  261. data/spec/models/create_payees_csv_request_spec.rb +2 -2
  262. data/spec/models/create_payees_csv_response2_spec.rb +47 -0
  263. data/spec/models/create_payees_csv_response_spec.rb +2 -2
  264. data/spec/models/create_payees_request2_spec.rb +47 -0
  265. data/spec/models/create_payees_request_spec.rb +2 -2
  266. data/spec/models/create_payment_channel2_spec.rb +85 -0
  267. data/spec/models/create_payment_channel_spec.rb +2 -2
  268. data/spec/models/create_payout_request_spec.rb +14 -2
  269. data/spec/models/error_response_spec.rb +47 -0
  270. data/spec/models/error_spec.rb +63 -0
  271. data/spec/models/failed_submission_spec.rb +2 -2
  272. data/spec/models/funding_audit_spec.rb +12 -2
  273. data/spec/models/funding_delta_response_links_spec.rb +47 -0
  274. data/spec/models/funding_delta_response_spec.rb +53 -0
  275. data/spec/models/funding_delta_spec.rb +59 -0
  276. data/spec/models/funding_event_spec.rb +8 -2
  277. data/spec/models/funding_event_type_spec.rb +2 -2
  278. data/spec/models/funding_request_v1_spec.rb +2 -2
  279. data/spec/models/funding_request_v2_spec.rb +2 -2
  280. data/spec/models/fx_summary_v3_spec.rb +2 -2
  281. data/spec/models/fx_summary_v4_spec.rb +2 -2
  282. data/spec/models/get_fundings_response_all_of_spec.rb +2 -2
  283. data/spec/models/get_fundings_response_spec.rb +2 -2
  284. data/spec/models/get_payments_for_payout_response_v3_page_spec.rb +2 -2
  285. data/spec/models/get_payments_for_payout_response_v3_spec.rb +2 -2
  286. data/spec/models/get_payments_for_payout_response_v3_summary_spec.rb +2 -2
  287. data/spec/models/get_payments_for_payout_response_v4_spec.rb +2 -2
  288. data/spec/models/get_payments_for_payout_response_v4_summary_spec.rb +50 -2
  289. data/spec/models/get_payout_statistics_spec.rb +2 -2
  290. data/spec/models/get_payouts_response_v3_links_spec.rb +2 -2
  291. data/spec/models/get_payouts_response_v3_page_spec.rb +2 -2
  292. data/spec/models/get_payouts_response_v3_spec.rb +2 -2
  293. data/spec/models/get_payouts_response_v3_summary_spec.rb +2 -2
  294. data/spec/models/get_payouts_response_v4_spec.rb +2 -2
  295. data/spec/models/individual_response_spec.rb +41 -0
  296. data/spec/models/{individual_name_spec.rb → individual_v1_name_spec.rb} +8 -8
  297. data/spec/models/{individual_spec.rb → individual_v1_spec.rb} +8 -8
  298. data/spec/models/invitation_status_response_spec.rb +2 -2
  299. data/spec/models/invitation_status_spec.rb +2 -2
  300. data/spec/models/invite_payee_request_spec.rb +2 -2
  301. data/spec/models/language_spec.rb +2 -2
  302. data/spec/models/list_payments_response_page_spec.rb +2 -2
  303. data/spec/models/list_payments_response_spec.rb +2 -2
  304. data/spec/models/list_payments_response_summary_spec.rb +2 -2
  305. data/spec/models/list_source_account_response_links_spec.rb +2 -2
  306. data/spec/models/list_source_account_response_page_spec.rb +2 -2
  307. data/spec/models/list_source_account_response_spec.rb +2 -2
  308. data/spec/models/list_source_account_response_v2_page_spec.rb +2 -2
  309. data/spec/models/list_source_account_response_v2_spec.rb +2 -2
  310. data/spec/models/marketing_opt_in_spec.rb +2 -2
  311. data/spec/models/notifications_spec.rb +2 -2
  312. data/spec/models/ofac_status_spec.rb +2 -2
  313. data/spec/models/onboarded_status_spec.rb +2 -2
  314. data/spec/models/paged_payee_invitation_status_response_spec.rb +2 -2
  315. data/spec/models/paged_payee_response2_spec.rb +59 -0
  316. data/spec/models/paged_payee_response2_summary_spec.rb +65 -0
  317. data/spec/models/{payee_response_links_spec.rb → paged_payee_response_links_spec.rb} +8 -8
  318. data/spec/models/{payee_response_page_spec.rb → paged_payee_response_page_spec.rb} +8 -8
  319. data/spec/models/paged_payee_response_spec.rb +59 -0
  320. data/spec/models/{payee_response_summary_spec.rb → paged_payee_response_summary_spec.rb} +8 -8
  321. data/spec/models/paged_response_page_spec.rb +2 -2
  322. data/spec/models/paged_response_spec.rb +2 -2
  323. data/spec/models/{address_spec.rb → payee_address_spec.rb} +8 -8
  324. data/spec/models/payee_delta_response_links_spec.rb +2 -2
  325. data/spec/models/payee_delta_response_page_spec.rb +2 -2
  326. data/spec/models/payee_delta_response_spec.rb +2 -2
  327. data/spec/models/payee_delta_spec.rb +2 -2
  328. data/spec/models/payee_invitation_status_response_spec.rb +2 -2
  329. data/spec/models/payee_invitation_status_spec.rb +2 -2
  330. data/spec/models/{payment_channel_spec.rb → payee_payment_channel_spec.rb} +8 -8
  331. data/spec/models/payee_payor_ref2_spec.rb +53 -0
  332. data/spec/models/{payor_ref_spec.rb → payee_payor_ref_spec.rb} +8 -8
  333. data/spec/models/payee_response2_spec.rb +155 -0
  334. data/spec/models/payee_response_spec.rb +102 -6
  335. data/spec/models/payee_spec.rb +2 -2
  336. data/spec/models/payee_type_spec.rb +2 -2
  337. data/spec/models/payment_audit_currency_v3_spec.rb +2 -2
  338. data/spec/models/payment_audit_currency_v4_spec.rb +2 -2
  339. data/spec/models/payment_channel_country_spec.rb +2 -2
  340. data/spec/models/payment_channel_rule_spec.rb +2 -2
  341. data/spec/models/payment_channel_rules_response_spec.rb +2 -2
  342. data/spec/models/payment_delta_response_spec.rb +53 -0
  343. data/spec/models/payment_delta_spec.rb +83 -0
  344. data/spec/models/payment_event_response_v3_spec.rb +2 -2
  345. data/spec/models/payment_event_response_v4_spec.rb +2 -2
  346. data/spec/models/payment_instruction_spec.rb +2 -2
  347. data/spec/models/payment_response_v3_spec.rb +2 -2
  348. data/spec/models/payment_response_v4_payout_spec.rb +47 -0
  349. data/spec/models/payment_response_v4_spec.rb +8 -2
  350. data/spec/models/payment_status_spec.rb +35 -0
  351. data/spec/models/payor_address_spec.rb +83 -0
  352. data/spec/models/payor_address_v2_spec.rb +83 -0
  353. data/spec/models/payor_branding_response_spec.rb +2 -2
  354. data/spec/models/payor_create_api_key_request_spec.rb +2 -2
  355. data/spec/models/payor_create_api_key_response_spec.rb +2 -2
  356. data/spec/models/payor_create_application_request_spec.rb +2 -2
  357. data/spec/models/payor_email_opt_out_request_spec.rb +2 -2
  358. data/spec/models/payor_links_response_links_spec.rb +2 -2
  359. data/spec/models/payor_links_response_payors_spec.rb +2 -2
  360. data/spec/models/payor_links_response_spec.rb +2 -2
  361. data/spec/models/payor_logo_request_spec.rb +2 -2
  362. data/spec/models/payor_v1_spec.rb +8 -2
  363. data/spec/models/payor_v2_spec.rb +8 -2
  364. data/spec/models/payout_payor_v4_spec.rb +65 -0
  365. data/spec/models/payout_principal_v4_spec.rb +47 -0
  366. data/spec/models/payout_status_v3_spec.rb +2 -2
  367. data/spec/models/payout_status_v4_spec.rb +2 -2
  368. data/spec/models/payout_summary_audit_v3_spec.rb +2 -2
  369. data/spec/models/payout_summary_audit_v4_spec.rb +8 -2
  370. data/spec/models/payout_summary_response_spec.rb +2 -2
  371. data/spec/models/payout_type_v4_spec.rb +35 -0
  372. data/spec/models/query_batch_response_spec.rb +2 -2
  373. data/spec/models/quote_fx_summary_spec.rb +10 -2
  374. data/spec/models/quote_response_spec.rb +2 -2
  375. data/spec/models/rejected_payment_spec.rb +2 -2
  376. data/spec/models/set_notifications_request_spec.rb +2 -2
  377. data/spec/models/source_account_response_spec.rb +2 -2
  378. data/spec/models/source_account_response_v2_spec.rb +2 -2
  379. data/spec/models/source_account_spec.rb +2 -2
  380. data/spec/models/source_account_summary_v3_spec.rb +2 -2
  381. data/spec/models/source_account_summary_v4_spec.rb +2 -2
  382. data/spec/models/supported_countries_response_spec.rb +2 -2
  383. data/spec/models/supported_country_spec.rb +2 -2
  384. data/spec/models/supported_currency_response_spec.rb +2 -2
  385. data/spec/models/supported_currency_spec.rb +2 -2
  386. data/spec/models/update_remote_id_request_spec.rb +47 -0
  387. data/spec/models/watchlist_status_spec.rb +35 -0
  388. data/spec/spec_helper.rb +2 -2
  389. data/velopayments.gemspec +2 -8
  390. metadata +252 -259
  391. data/Gemfile.lock +0 -79
  392. data/docs/PayorFundingBankDetailsUpdate.md +0 -21
  393. data/velopayments-2.11.73.gem +0 -0
  394. data/velopayments-2.14.90.gem +0 -0
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a 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. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` 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.
5
5
 
6
- The version of the OpenAPI document: 2.14.92
6
+ The version of the OpenAPI document: 2.17.8
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.1.0-SNAPSHOT
9
+ OpenAPI Generator version: 4.2.3-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a 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. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` 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.
5
5
 
6
- The version of the OpenAPI document: 2.14.92
6
+ The version of the OpenAPI document: 2.17.8
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.1.0-SNAPSHOT
9
+ OpenAPI Generator version: 4.2.3-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a 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. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` 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.
5
5
 
6
- The version of the OpenAPI document: 2.14.92
6
+ The version of the OpenAPI document: 2.17.8
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.1.0-SNAPSHOT
9
+ OpenAPI Generator version: 4.2.3-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a 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. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` 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.
5
5
 
6
- The version of the OpenAPI document: 2.14.92
6
+ The version of the OpenAPI document: 2.17.8
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.1.0-SNAPSHOT
9
+ OpenAPI Generator version: 4.2.3-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -34,6 +34,12 @@ module VeloPayments
34
34
  }
35
35
  end
36
36
 
37
+ # List of attributes with nullable: true
38
+ def self.openapi_nullable
39
+ Set.new([
40
+ ])
41
+ end
42
+
37
43
  # Initializes the object
38
44
  # @param [Hash] attributes Model attributes in the form of hash
39
45
  def initialize(attributes = {})
@@ -180,7 +186,11 @@ module VeloPayments
180
186
  hash = {}
181
187
  self.class.attribute_map.each_pair do |attr, param|
182
188
  value = self.send(attr)
183
- next if value.nil?
189
+ if value.nil?
190
+ is_nullable = self.class.openapi_nullable.include?(attr)
191
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
192
+ end
193
+
184
194
  hash[param] = _to_hash(value)
185
195
  end
186
196
  hash
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a 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. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` 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.
5
5
 
6
- The version of the OpenAPI document: 2.14.92
6
+ The version of the OpenAPI document: 2.17.8
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.1.0-SNAPSHOT
9
+ OpenAPI Generator version: 4.2.3-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -54,6 +54,12 @@ module VeloPayments
54
54
  }
55
55
  end
56
56
 
57
+ # List of attributes with nullable: true
58
+ def self.openapi_nullable
59
+ Set.new([
60
+ ])
61
+ end
62
+
57
63
  # Initializes the object
58
64
  # @param [Hash] attributes Model attributes in the form of hash
59
65
  def initialize(attributes = {})
@@ -223,7 +229,11 @@ module VeloPayments
223
229
  hash = {}
224
230
  self.class.attribute_map.each_pair do |attr, param|
225
231
  value = self.send(attr)
226
- next if value.nil?
232
+ if value.nil?
233
+ is_nullable = self.class.openapi_nullable.include?(attr)
234
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
235
+ end
236
+
227
237
  hash[param] = _to_hash(value)
228
238
  end
229
239
  hash
@@ -3,10 +3,10 @@
3
3
 
4
4
  ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a 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. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` 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.
5
5
 
6
- The version of the OpenAPI document: 2.14.92
6
+ The version of the OpenAPI document: 2.17.8
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.1.0-SNAPSHOT
9
+ OpenAPI Generator version: 4.2.3-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -30,6 +30,12 @@ module VeloPayments
30
30
  }
31
31
  end
32
32
 
33
+ # List of attributes with nullable: true
34
+ def self.openapi_nullable
35
+ Set.new([
36
+ ])
37
+ end
38
+
33
39
  # Initializes the object
34
40
  # @param [Hash] attributes Model attributes in the form of hash
35
41
  def initialize(attributes = {})
@@ -171,7 +177,11 @@ module VeloPayments
171
177
  hash = {}
172
178
  self.class.attribute_map.each_pair do |attr, param|
173
179
  value = self.send(attr)
174
- next if value.nil?
180
+ if value.nil?
181
+ is_nullable = self.class.openapi_nullable.include?(attr)
182
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
183
+ end
184
+
175
185
  hash[param] = _to_hash(value)
176
186
  end
177
187
  hash
@@ -0,0 +1,285 @@
1
+ =begin
2
+ #Velo Payments APIs
3
+
4
+ ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a 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. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` 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.
5
+
6
+ The version of the OpenAPI document: 2.17.8
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.2.3-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module VeloPayments
16
+ class PaymentDelta
17
+ attr_accessor :payment_id
18
+
19
+ attr_accessor :payout_id
20
+
21
+ attr_accessor :payor_payment_id
22
+
23
+ attr_accessor :payment_currency
24
+
25
+ attr_accessor :payment_amount
26
+
27
+ attr_accessor :status
28
+
29
+ attr_accessor :source_currency
30
+
31
+ attr_accessor :source_amount
32
+
33
+ # Attribute mapping from ruby-style variable name to JSON key.
34
+ def self.attribute_map
35
+ {
36
+ :'payment_id' => :'paymentId',
37
+ :'payout_id' => :'payoutId',
38
+ :'payor_payment_id' => :'payorPaymentId',
39
+ :'payment_currency' => :'paymentCurrency',
40
+ :'payment_amount' => :'paymentAmount',
41
+ :'status' => :'status',
42
+ :'source_currency' => :'sourceCurrency',
43
+ :'source_amount' => :'sourceAmount'
44
+ }
45
+ end
46
+
47
+ # Attribute type mapping.
48
+ def self.openapi_types
49
+ {
50
+ :'payment_id' => :'String',
51
+ :'payout_id' => :'String',
52
+ :'payor_payment_id' => :'String',
53
+ :'payment_currency' => :'String',
54
+ :'payment_amount' => :'Integer',
55
+ :'status' => :'PaymentStatus',
56
+ :'source_currency' => :'String',
57
+ :'source_amount' => :'Integer'
58
+ }
59
+ end
60
+
61
+ # List of attributes with nullable: true
62
+ def self.openapi_nullable
63
+ Set.new([
64
+ :'payor_payment_id',
65
+ :'payment_currency',
66
+ :'payment_amount',
67
+ :'status',
68
+ :'source_currency',
69
+ :'source_amount'
70
+ ])
71
+ end
72
+
73
+ # Initializes the object
74
+ # @param [Hash] attributes Model attributes in the form of hash
75
+ def initialize(attributes = {})
76
+ if (!attributes.is_a?(Hash))
77
+ fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::PaymentDelta` initialize method"
78
+ end
79
+
80
+ # check to see if the attribute exists and convert string to symbol for hash key
81
+ attributes = attributes.each_with_object({}) { |(k, v), h|
82
+ if (!self.class.attribute_map.key?(k.to_sym))
83
+ fail ArgumentError, "`#{k}` is not a valid attribute in `VeloPayments::PaymentDelta`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
84
+ end
85
+ h[k.to_sym] = v
86
+ }
87
+
88
+ if attributes.key?(:'payment_id')
89
+ self.payment_id = attributes[:'payment_id']
90
+ end
91
+
92
+ if attributes.key?(:'payout_id')
93
+ self.payout_id = attributes[:'payout_id']
94
+ end
95
+
96
+ if attributes.key?(:'payor_payment_id')
97
+ self.payor_payment_id = attributes[:'payor_payment_id']
98
+ end
99
+
100
+ if attributes.key?(:'payment_currency')
101
+ self.payment_currency = attributes[:'payment_currency']
102
+ end
103
+
104
+ if attributes.key?(:'payment_amount')
105
+ self.payment_amount = attributes[:'payment_amount']
106
+ end
107
+
108
+ if attributes.key?(:'status')
109
+ self.status = attributes[:'status']
110
+ end
111
+
112
+ if attributes.key?(:'source_currency')
113
+ self.source_currency = attributes[:'source_currency']
114
+ end
115
+
116
+ if attributes.key?(:'source_amount')
117
+ self.source_amount = attributes[:'source_amount']
118
+ end
119
+ end
120
+
121
+ # Show invalid properties with the reasons. Usually used together with valid?
122
+ # @return Array for valid properties with the reasons
123
+ def list_invalid_properties
124
+ invalid_properties = Array.new
125
+ if @payment_id.nil?
126
+ invalid_properties.push('invalid value for "payment_id", payment_id cannot be nil.')
127
+ end
128
+
129
+ if @payout_id.nil?
130
+ invalid_properties.push('invalid value for "payout_id", payout_id cannot be nil.')
131
+ end
132
+
133
+ invalid_properties
134
+ end
135
+
136
+ # Check to see if the all the properties in the model are valid
137
+ # @return true if the model is valid
138
+ def valid?
139
+ return false if @payment_id.nil?
140
+ return false if @payout_id.nil?
141
+ true
142
+ end
143
+
144
+ # Checks equality by comparing each attribute.
145
+ # @param [Object] Object to be compared
146
+ def ==(o)
147
+ return true if self.equal?(o)
148
+ self.class == o.class &&
149
+ payment_id == o.payment_id &&
150
+ payout_id == o.payout_id &&
151
+ payor_payment_id == o.payor_payment_id &&
152
+ payment_currency == o.payment_currency &&
153
+ payment_amount == o.payment_amount &&
154
+ status == o.status &&
155
+ source_currency == o.source_currency &&
156
+ source_amount == o.source_amount
157
+ end
158
+
159
+ # @see the `==` method
160
+ # @param [Object] Object to be compared
161
+ def eql?(o)
162
+ self == o
163
+ end
164
+
165
+ # Calculates hash code according to all attributes.
166
+ # @return [Integer] Hash code
167
+ def hash
168
+ [payment_id, payout_id, payor_payment_id, payment_currency, payment_amount, status, source_currency, source_amount].hash
169
+ end
170
+
171
+ # Builds the object from hash
172
+ # @param [Hash] attributes Model attributes in the form of hash
173
+ # @return [Object] Returns the model itself
174
+ def self.build_from_hash(attributes)
175
+ new.build_from_hash(attributes)
176
+ end
177
+
178
+ # Builds the object from hash
179
+ # @param [Hash] attributes Model attributes in the form of hash
180
+ # @return [Object] Returns the model itself
181
+ def build_from_hash(attributes)
182
+ return nil unless attributes.is_a?(Hash)
183
+ self.class.openapi_types.each_pair do |key, type|
184
+ if type =~ /\AArray<(.*)>/i
185
+ # check to ensure the input is an array given that the attribute
186
+ # is documented as an array but the input is not
187
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
188
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
189
+ end
190
+ elsif !attributes[self.class.attribute_map[key]].nil?
191
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
192
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
193
+ end
194
+
195
+ self
196
+ end
197
+
198
+ # Deserializes the data based on type
199
+ # @param string type Data type
200
+ # @param string value Value to be deserialized
201
+ # @return [Object] Deserialized data
202
+ def _deserialize(type, value)
203
+ case type.to_sym
204
+ when :DateTime
205
+ DateTime.parse(value)
206
+ when :Date
207
+ Date.parse(value)
208
+ when :String
209
+ value.to_s
210
+ when :Integer
211
+ value.to_i
212
+ when :Float
213
+ value.to_f
214
+ when :Boolean
215
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
216
+ true
217
+ else
218
+ false
219
+ end
220
+ when :Object
221
+ # generic object (usually a Hash), return directly
222
+ value
223
+ when /\AArray<(?<inner_type>.+)>\z/
224
+ inner_type = Regexp.last_match[:inner_type]
225
+ value.map { |v| _deserialize(inner_type, v) }
226
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
227
+ k_type = Regexp.last_match[:k_type]
228
+ v_type = Regexp.last_match[:v_type]
229
+ {}.tap do |hash|
230
+ value.each do |k, v|
231
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
232
+ end
233
+ end
234
+ else # model
235
+ VeloPayments.const_get(type).build_from_hash(value)
236
+ end
237
+ end
238
+
239
+ # Returns the string representation of the object
240
+ # @return [String] String presentation of the object
241
+ def to_s
242
+ to_hash.to_s
243
+ end
244
+
245
+ # to_body is an alias to to_hash (backward compatibility)
246
+ # @return [Hash] Returns the object in the form of hash
247
+ def to_body
248
+ to_hash
249
+ end
250
+
251
+ # Returns the object in the form of hash
252
+ # @return [Hash] Returns the object in the form of hash
253
+ def to_hash
254
+ hash = {}
255
+ self.class.attribute_map.each_pair do |attr, param|
256
+ value = self.send(attr)
257
+ if value.nil?
258
+ is_nullable = self.class.openapi_nullable.include?(attr)
259
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
260
+ end
261
+
262
+ hash[param] = _to_hash(value)
263
+ end
264
+ hash
265
+ end
266
+
267
+ # Outputs non-array value in the form of hash
268
+ # For object, use to_hash. Otherwise, just return the value
269
+ # @param [Object] value Any valid value
270
+ # @return [Hash] Returns the value in the form of hash
271
+ def _to_hash(value)
272
+ if value.is_a?(Array)
273
+ value.compact.map { |v| _to_hash(v) }
274
+ elsif value.is_a?(Hash)
275
+ {}.tap do |hash|
276
+ value.each { |k, v| hash[k] = _to_hash(v) }
277
+ end
278
+ elsif value.respond_to? :to_hash
279
+ value.to_hash
280
+ else
281
+ value
282
+ end
283
+ end
284
+ end
285
+ end
@@ -0,0 +1,229 @@
1
+ =begin
2
+ #Velo Payments APIs
3
+
4
+ ### Terms and Definitions Throughout this document and the Velo platform the following terms are used: * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking. ## Overview The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution: * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference. ## API Considerations The Velo Payments API is REST based and uses the JSON format for requests and responses. Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details. Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters). Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print. ## Authenticating with the Velo Platform Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner. You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following: create a 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. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ== perform the Velo authentication REST call using the HTTP header created above e.g. via curl: ``` curl -X POST \\ -H \"Content-Type: application/json\" \\ -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\ 'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ``` If successful, this call will result in a **200** HTTP status code and a response body such as: ``` { \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\", \"token_type\":\"bearer\", \"expires_in\":1799, \"scope\":\"...\" } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated. This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below: ``` -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ``` 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.
5
+
6
+ The version of the OpenAPI document: 2.17.8
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.2.3-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module VeloPayments
16
+ # List Payment Changes Response Object
17
+ class PaymentDeltaResponse
18
+ attr_accessor :page
19
+
20
+ attr_accessor :links
21
+
22
+ attr_accessor :content
23
+
24
+ # Attribute mapping from ruby-style variable name to JSON key.
25
+ def self.attribute_map
26
+ {
27
+ :'page' => :'page',
28
+ :'links' => :'links',
29
+ :'content' => :'content'
30
+ }
31
+ end
32
+
33
+ # Attribute type mapping.
34
+ def self.openapi_types
35
+ {
36
+ :'page' => :'PagedPayeeResponsePage',
37
+ :'links' => :'Array<PagedPayeeResponseLinks>',
38
+ :'content' => :'Array<PaymentDelta>'
39
+ }
40
+ end
41
+
42
+ # List of attributes with nullable: true
43
+ def self.openapi_nullable
44
+ Set.new([
45
+ ])
46
+ end
47
+
48
+ # Initializes the object
49
+ # @param [Hash] attributes Model attributes in the form of hash
50
+ def initialize(attributes = {})
51
+ if (!attributes.is_a?(Hash))
52
+ fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::PaymentDeltaResponse` initialize method"
53
+ end
54
+
55
+ # check to see if the attribute exists and convert string to symbol for hash key
56
+ attributes = attributes.each_with_object({}) { |(k, v), h|
57
+ if (!self.class.attribute_map.key?(k.to_sym))
58
+ fail ArgumentError, "`#{k}` is not a valid attribute in `VeloPayments::PaymentDeltaResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
59
+ end
60
+ h[k.to_sym] = v
61
+ }
62
+
63
+ if attributes.key?(:'page')
64
+ self.page = attributes[:'page']
65
+ end
66
+
67
+ if attributes.key?(:'links')
68
+ if (value = attributes[:'links']).is_a?(Array)
69
+ self.links = value
70
+ end
71
+ end
72
+
73
+ if attributes.key?(:'content')
74
+ if (value = attributes[:'content']).is_a?(Array)
75
+ self.content = value
76
+ end
77
+ end
78
+ end
79
+
80
+ # Show invalid properties with the reasons. Usually used together with valid?
81
+ # @return Array for valid properties with the reasons
82
+ def list_invalid_properties
83
+ invalid_properties = Array.new
84
+ invalid_properties
85
+ end
86
+
87
+ # Check to see if the all the properties in the model are valid
88
+ # @return true if the model is valid
89
+ def valid?
90
+ true
91
+ end
92
+
93
+ # Checks equality by comparing each attribute.
94
+ # @param [Object] Object to be compared
95
+ def ==(o)
96
+ return true if self.equal?(o)
97
+ self.class == o.class &&
98
+ page == o.page &&
99
+ links == o.links &&
100
+ content == o.content
101
+ end
102
+
103
+ # @see the `==` method
104
+ # @param [Object] Object to be compared
105
+ def eql?(o)
106
+ self == o
107
+ end
108
+
109
+ # Calculates hash code according to all attributes.
110
+ # @return [Integer] Hash code
111
+ def hash
112
+ [page, links, content].hash
113
+ end
114
+
115
+ # Builds the object from hash
116
+ # @param [Hash] attributes Model attributes in the form of hash
117
+ # @return [Object] Returns the model itself
118
+ def self.build_from_hash(attributes)
119
+ new.build_from_hash(attributes)
120
+ end
121
+
122
+ # Builds the object from hash
123
+ # @param [Hash] attributes Model attributes in the form of hash
124
+ # @return [Object] Returns the model itself
125
+ def build_from_hash(attributes)
126
+ return nil unless attributes.is_a?(Hash)
127
+ self.class.openapi_types.each_pair do |key, type|
128
+ if type =~ /\AArray<(.*)>/i
129
+ # check to ensure the input is an array given that the attribute
130
+ # is documented as an array but the input is not
131
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
132
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
133
+ end
134
+ elsif !attributes[self.class.attribute_map[key]].nil?
135
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
136
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
137
+ end
138
+
139
+ self
140
+ end
141
+
142
+ # Deserializes the data based on type
143
+ # @param string type Data type
144
+ # @param string value Value to be deserialized
145
+ # @return [Object] Deserialized data
146
+ def _deserialize(type, value)
147
+ case type.to_sym
148
+ when :DateTime
149
+ DateTime.parse(value)
150
+ when :Date
151
+ Date.parse(value)
152
+ when :String
153
+ value.to_s
154
+ when :Integer
155
+ value.to_i
156
+ when :Float
157
+ value.to_f
158
+ when :Boolean
159
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
160
+ true
161
+ else
162
+ false
163
+ end
164
+ when :Object
165
+ # generic object (usually a Hash), return directly
166
+ value
167
+ when /\AArray<(?<inner_type>.+)>\z/
168
+ inner_type = Regexp.last_match[:inner_type]
169
+ value.map { |v| _deserialize(inner_type, v) }
170
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
171
+ k_type = Regexp.last_match[:k_type]
172
+ v_type = Regexp.last_match[:v_type]
173
+ {}.tap do |hash|
174
+ value.each do |k, v|
175
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
176
+ end
177
+ end
178
+ else # model
179
+ VeloPayments.const_get(type).build_from_hash(value)
180
+ end
181
+ end
182
+
183
+ # Returns the string representation of the object
184
+ # @return [String] String presentation of the object
185
+ def to_s
186
+ to_hash.to_s
187
+ end
188
+
189
+ # to_body is an alias to to_hash (backward compatibility)
190
+ # @return [Hash] Returns the object in the form of hash
191
+ def to_body
192
+ to_hash
193
+ end
194
+
195
+ # Returns the object in the form of hash
196
+ # @return [Hash] Returns the object in the form of hash
197
+ def to_hash
198
+ hash = {}
199
+ self.class.attribute_map.each_pair do |attr, param|
200
+ value = self.send(attr)
201
+ if value.nil?
202
+ is_nullable = self.class.openapi_nullable.include?(attr)
203
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
204
+ end
205
+
206
+ hash[param] = _to_hash(value)
207
+ end
208
+ hash
209
+ end
210
+
211
+ # Outputs non-array value in the form of hash
212
+ # For object, use to_hash. Otherwise, just return the value
213
+ # @param [Object] value Any valid value
214
+ # @return [Hash] Returns the value in the form of hash
215
+ def _to_hash(value)
216
+ if value.is_a?(Array)
217
+ value.compact.map { |v| _to_hash(v) }
218
+ elsif value.is_a?(Hash)
219
+ {}.tap do |hash|
220
+ value.each { |k, v| hash[k] = _to_hash(v) }
221
+ end
222
+ elsif value.respond_to? :to_hash
223
+ value.to_hash
224
+ else
225
+ value
226
+ end
227
+ end
228
+ end
229
+ end