velopayments 2.18.113 → 2.19.40.beta1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (568) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +62 -48
  3. data/docs/Challenge.md +2 -2
  4. data/docs/Company.md +21 -0
  5. data/docs/Company2.md +21 -0
  6. data/docs/CompanyResponse.md +2 -2
  7. data/docs/CompanyV1.md +3 -3
  8. data/docs/CountriesApi.md +3 -13
  9. data/docs/CreateIndividual.md +2 -2
  10. data/docs/CreateIndividual2.md +3 -3
  11. data/docs/CreateIndividual2Name.md +23 -0
  12. data/docs/CreatePayee.md +4 -4
  13. data/docs/CreatePayee2.md +4 -4
  14. data/docs/CreatePayeesCSVRequest.md +22 -22
  15. data/docs/CreatePayeesCSVRequest2.md +23 -23
  16. data/docs/CreatePayeesCSVResponse.md +2 -2
  17. data/docs/CreatePayeesCSVResponse2.md +2 -2
  18. data/docs/CreatePayeesCSVResponseRejectedCsvRows.md +21 -0
  19. data/docs/CreatePayeesRequest.md +1 -1
  20. data/docs/CreatePayeesRequest2.md +1 -1
  21. data/docs/CreatePaymentChannel.md +6 -6
  22. data/docs/CreatePaymentChannel2.md +6 -6
  23. data/docs/CreatePayoutRequest.md +3 -3
  24. data/docs/CurrenciesApi.md +1 -6
  25. data/docs/FailedSubmission.md +2 -2
  26. data/docs/FailedSubmission2.md +19 -0
  27. data/docs/FundingManagerApi.md +8 -4
  28. data/docs/{DefaultApi.md → FundingManagerPrivateApi.md} +4 -4
  29. data/docs/GetPaymentsForPayoutResponseV4.md +1 -1
  30. data/docs/GetPayoutApi.md +5 -5
  31. data/docs/GetPayoutsResponseV4.md +1 -1
  32. data/docs/Individual.md +21 -0
  33. data/docs/Individual2.md +21 -0
  34. data/docs/IndividualV1.md +2 -2
  35. data/docs/IndividualV1Name.md +4 -4
  36. data/docs/InlineResponse400.md +19 -0
  37. data/docs/InlineResponse400Errors.md +23 -0
  38. data/docs/InlineResponse401.md +19 -0
  39. data/docs/InlineResponse401Errors.md +23 -0
  40. data/docs/InlineResponse403.md +19 -0
  41. data/docs/InlineResponse403Errors.md +23 -0
  42. data/docs/InstructPayoutApi.md +6 -6
  43. data/docs/InvitePayeeRequest.md +1 -1
  44. data/docs/{GenerateOTPRequest.md → InvitePayeeRequest2.md} +3 -3
  45. data/docs/InviteUserRequest.md +2 -2
  46. data/docs/{MFAStatus.md → Language2.md} +2 -2
  47. data/docs/{TokenType.md → LocationType.md} +2 -2
  48. data/docs/MarketingOptIn.md +1 -1
  49. data/docs/{OTPType.md → OfacStatus2.md} +2 -2
  50. data/docs/{PaymentStatus.md → OnboardedStatus2.md} +2 -2
  51. data/docs/PagedPayeeInvitationStatusResponse.md +1 -1
  52. data/docs/PagedPayeeInvitationStatusResponse2.md +21 -0
  53. data/docs/PagedPayeeInvitationStatusResponsePage.md +25 -0
  54. data/docs/PagedPayeeResponse2Summary.md +5 -5
  55. data/docs/PagedPayeeResponsePage.md +5 -5
  56. data/docs/PagedPayeeResponseSummary.md +5 -5
  57. data/docs/Payee.md +9 -9
  58. data/docs/Payee2.md +57 -0
  59. data/docs/PayeeAddress2.md +31 -0
  60. data/docs/PayeeDelta.md +1 -1
  61. data/docs/PayeeDelta2.md +29 -0
  62. data/docs/PayeeDeltaResponse2.md +21 -0
  63. data/docs/PayeeDeltaResponse2Links.md +19 -0
  64. data/docs/PayeeInvitationApi.md +184 -64
  65. data/docs/PayeeInvitationStatus.md +1 -1
  66. data/docs/PayeeInvitationStatusResponse.md +3 -3
  67. data/docs/PayeeInvitationStatusResponse2.md +21 -0
  68. data/docs/PayeePaymentChannel.md +8 -8
  69. data/docs/PayeePaymentChannel2.md +29 -0
  70. data/docs/PayeePayorRef.md +1 -1
  71. data/docs/PayeePayorRefV2.md +25 -0
  72. data/docs/PayeePayorRefV3.md +25 -0
  73. data/docs/PayeeResponse.md +9 -9
  74. data/docs/PayeeResponse2.md +10 -10
  75. data/docs/PayeeResponseV2.md +73 -0
  76. data/docs/PayeeResponseV3.md +71 -0
  77. data/docs/PayeesApi.md +316 -35
  78. data/docs/PaymentAuditServiceApi.md +4 -4
  79. data/docs/PaymentChannelCountry.md +3 -3
  80. data/docs/PaymentChannelRule.md +11 -11
  81. data/docs/PaymentDelta.md +1 -1
  82. data/docs/PaymentDeltaResponse.md +1 -1
  83. data/docs/PaymentInstruction.md +1 -1
  84. data/docs/QueryBatchResponse2.md +23 -0
  85. data/docs/ResendTokenRequest.md +1 -1
  86. data/docs/RoleUpdateRequest.md +19 -0
  87. data/docs/SubmitPayoutApi.md +2 -2
  88. data/docs/SupportedCountriesResponse2.md +1 -1
  89. data/docs/{SupportedCountryV2.md → SupportedCountry2.md} +3 -3
  90. data/docs/SupportedCurrency.md +3 -3
  91. data/docs/TokensApi.md +0 -498
  92. data/docs/UnregisterMFARequest.md +1 -1
  93. data/docs/UpdateRemoteIdRequest.md +2 -2
  94. data/docs/UserDetailsUpdateRequest.md +31 -0
  95. data/docs/UsersApi.md +108 -54
  96. data/docs/WithdrawPayoutApi.md +6 -6
  97. data/lib/velopayments.rb +38 -16
  98. data/lib/velopayments/api/countries_api.rb +6 -6
  99. data/lib/velopayments/api/currencies_api.rb +3 -3
  100. data/lib/velopayments/api/funding_manager_api.rb +22 -6
  101. data/lib/velopayments/api/{default_api.rb → funding_manager_private_api.rb} +5 -5
  102. data/lib/velopayments/api/get_payout_api.rb +8 -8
  103. data/lib/velopayments/api/instruct_payout_api.rb +10 -8
  104. data/lib/velopayments/api/login_api.rb +2 -2
  105. data/lib/velopayments/api/payee_invitation_api.rb +247 -111
  106. data/lib/velopayments/api/payees_api.rb +371 -35
  107. data/lib/velopayments/api/payment_audit_service_api.rb +6 -6
  108. data/lib/velopayments/api/payors_api.rb +2 -2
  109. data/lib/velopayments/api/payors_private_api.rb +2 -2
  110. data/lib/velopayments/api/payout_history_api.rb +2 -2
  111. data/lib/velopayments/api/quote_payout_api.rb +2 -2
  112. data/lib/velopayments/api/submit_payout_api.rb +6 -4
  113. data/lib/velopayments/api/tokens_api.rb +2 -695
  114. data/lib/velopayments/api/users_api.rb +142 -72
  115. data/lib/velopayments/api/withdraw_payout_api.rb +10 -8
  116. data/lib/velopayments/api_client.rb +2 -2
  117. data/lib/velopayments/api_error.rb +2 -2
  118. data/lib/velopayments/configuration.rb +2 -2
  119. data/lib/velopayments/models/accepted_payment.rb +13 -3
  120. data/lib/velopayments/models/access_token_response.rb +13 -3
  121. data/lib/velopayments/models/access_token_validation_request.rb +13 -3
  122. data/lib/velopayments/models/auth_response.rb +13 -3
  123. data/lib/velopayments/models/auto_top_up_config.rb +15 -3
  124. data/lib/velopayments/models/challenge.rb +13 -3
  125. data/lib/velopayments/models/company.rb +308 -0
  126. data/lib/velopayments/models/company2.rb +308 -0
  127. data/lib/velopayments/models/company_response.rb +14 -3
  128. data/lib/velopayments/models/company_v1.rb +15 -3
  129. data/lib/velopayments/models/create_funding_account_request.rb +13 -3
  130. data/lib/velopayments/models/create_individual.rb +13 -3
  131. data/lib/velopayments/models/create_individual2.rb +14 -4
  132. data/lib/velopayments/models/create_individual2_name.rb +347 -0
  133. data/lib/velopayments/models/create_payee.rb +16 -4
  134. data/lib/velopayments/models/create_payee2.rb +16 -4
  135. data/lib/velopayments/models/create_payee_address.rb +18 -3
  136. data/lib/velopayments/models/create_payee_address2.rb +18 -3
  137. data/lib/velopayments/models/create_payees_csv_request.rb +13 -3
  138. data/lib/velopayments/models/create_payees_csv_request2.rb +27 -11
  139. data/lib/velopayments/models/create_payees_csv_response.rb +14 -4
  140. data/lib/velopayments/models/create_payees_csv_response2.rb +14 -4
  141. data/lib/velopayments/models/create_payees_csv_response_rejected_csv_rows.rb +224 -0
  142. data/lib/velopayments/models/create_payees_request.rb +13 -3
  143. data/lib/velopayments/models/create_payees_request2.rb +13 -3
  144. data/lib/velopayments/models/create_payment_channel.rb +13 -3
  145. data/lib/velopayments/models/create_payment_channel2.rb +13 -3
  146. data/lib/velopayments/models/create_payor_link_request.rb +13 -3
  147. data/lib/velopayments/models/create_payout_request.rb +28 -3
  148. data/lib/velopayments/models/currency_type.rb +13 -3
  149. data/lib/velopayments/models/error.rb +15 -5
  150. data/lib/velopayments/models/error_response.rb +15 -3
  151. data/lib/velopayments/models/failed_submission.rb +14 -4
  152. data/lib/velopayments/models/{payee_payor_ref2.rb → failed_submission2.rb} +29 -28
  153. data/lib/velopayments/models/funding_account_response.rb +13 -3
  154. data/lib/velopayments/models/funding_audit.rb +13 -3
  155. data/lib/velopayments/models/funding_event.rb +13 -3
  156. data/lib/velopayments/models/funding_event_type.rb +2 -2
  157. data/lib/velopayments/models/funding_payor_status_audit_response.rb +13 -3
  158. data/lib/velopayments/models/funding_request_v1.rb +13 -3
  159. data/lib/velopayments/models/funding_request_v2.rb +13 -3
  160. data/lib/velopayments/models/fx_summary_v3.rb +13 -3
  161. data/lib/velopayments/models/fx_summary_v4.rb +13 -3
  162. data/lib/velopayments/models/get_fundings_response.rb +13 -3
  163. data/lib/velopayments/models/get_fundings_response_all_of.rb +13 -3
  164. data/lib/velopayments/models/get_payments_for_payout_response_v3.rb +13 -3
  165. data/lib/velopayments/models/get_payments_for_payout_response_v3_page.rb +13 -3
  166. data/lib/velopayments/models/get_payments_for_payout_response_v3_summary.rb +13 -3
  167. data/lib/velopayments/models/get_payments_for_payout_response_v4.rb +14 -4
  168. data/lib/velopayments/models/get_payments_for_payout_response_v4_summary.rb +13 -3
  169. data/lib/velopayments/models/get_payout_statistics.rb +13 -3
  170. data/lib/velopayments/models/get_payouts_response_v3.rb +13 -3
  171. data/lib/velopayments/models/get_payouts_response_v3_links.rb +13 -3
  172. data/lib/velopayments/models/get_payouts_response_v3_page.rb +13 -3
  173. data/lib/velopayments/models/get_payouts_response_v4.rb +14 -4
  174. data/lib/velopayments/models/individual.rb +260 -0
  175. data/lib/velopayments/models/individual2.rb +260 -0
  176. data/lib/velopayments/models/individual_response.rb +13 -3
  177. data/lib/velopayments/models/individual_v1.rb +37 -3
  178. data/lib/velopayments/models/individual_v1_name.rb +13 -3
  179. data/lib/velopayments/models/{generate_otp_request.rb → inline_response400.rb} +38 -18
  180. data/lib/velopayments/models/{validate_otp_request.rb → inline_response400_errors.rb} +52 -46
  181. data/lib/velopayments/models/inline_response401.rb +221 -0
  182. data/lib/velopayments/models/{validate_mfa_request.rb → inline_response401_errors.rb} +52 -46
  183. data/lib/velopayments/models/inline_response403.rb +221 -0
  184. data/lib/velopayments/models/{check_token_response.rb → inline_response403_errors.rb} +44 -42
  185. data/lib/velopayments/models/invitation_status.rb +2 -2
  186. data/lib/velopayments/models/invitation_status_response.rb +13 -3
  187. data/lib/velopayments/models/invite_payee_request.rb +13 -3
  188. data/lib/velopayments/models/{register_mfa_response.rb → invite_payee_request2.rb} +28 -24
  189. data/lib/velopayments/models/invite_user_request.rb +17 -4
  190. data/lib/velopayments/models/kyc_state.rb +2 -2
  191. data/lib/velopayments/models/language.rb +2 -2
  192. data/lib/velopayments/models/{payment_status.rb → language2.rb} +16 -13
  193. data/lib/velopayments/models/link_for_response.rb +13 -3
  194. data/lib/velopayments/models/list_funding_accounts_response.rb +13 -3
  195. data/lib/velopayments/models/list_payments_response.rb +13 -3
  196. data/lib/velopayments/models/list_payments_response_page.rb +13 -3
  197. data/lib/velopayments/models/list_payments_response_v4.rb +13 -3
  198. data/lib/velopayments/models/list_source_account_response.rb +13 -3
  199. data/lib/velopayments/models/list_source_account_response_links.rb +13 -3
  200. data/lib/velopayments/models/list_source_account_response_page.rb +13 -3
  201. data/lib/velopayments/models/list_source_account_response_v2.rb +13 -3
  202. data/lib/velopayments/models/{token_type.rb → location_type.rb} +10 -9
  203. data/lib/velopayments/models/marketing_opt_in.rb +13 -3
  204. data/lib/velopayments/models/mfa_details.rb +14 -3
  205. data/lib/velopayments/models/mfa_type.rb +2 -2
  206. data/lib/velopayments/models/notifications.rb +13 -3
  207. data/lib/velopayments/models/ofac_status.rb +2 -2
  208. data/lib/velopayments/models/{mfa_status.rb → ofac_status2.rb} +8 -7
  209. data/lib/velopayments/models/onboarded_status.rb +2 -2
  210. data/lib/velopayments/models/{otp_type.rb → onboarded_status2.rb} +9 -6
  211. data/lib/velopayments/models/page_for_response.rb +13 -3
  212. data/lib/velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response.rb +13 -3
  213. data/lib/velopayments/models/paged_payee_invitation_status_response.rb +14 -4
  214. data/lib/velopayments/models/paged_payee_invitation_status_response2.rb +229 -0
  215. data/lib/velopayments/models/paged_payee_invitation_status_response_page.rb +242 -0
  216. data/lib/velopayments/models/paged_payee_response.rb +13 -3
  217. data/lib/velopayments/models/paged_payee_response2.rb +13 -3
  218. data/lib/velopayments/models/paged_payee_response2_summary.rb +13 -3
  219. data/lib/velopayments/models/paged_payee_response_links.rb +13 -3
  220. data/lib/velopayments/models/paged_payee_response_page.rb +13 -3
  221. data/lib/velopayments/models/paged_payee_response_summary.rb +13 -3
  222. data/lib/velopayments/models/paged_response.rb +13 -3
  223. data/lib/velopayments/models/paged_response_page.rb +13 -3
  224. data/lib/velopayments/models/paged_user_response.rb +13 -3
  225. data/lib/velopayments/models/paged_user_response_links.rb +13 -3
  226. data/lib/velopayments/models/paged_user_response_page.rb +13 -3
  227. data/lib/velopayments/models/password_request.rb +13 -3
  228. data/lib/velopayments/models/payee.rb +19 -3
  229. data/lib/velopayments/models/payee2.rb +456 -0
  230. data/lib/velopayments/models/payee_address.rb +18 -3
  231. data/lib/velopayments/models/payee_address2.rb +493 -0
  232. data/lib/velopayments/models/payee_delta.rb +14 -3
  233. data/lib/velopayments/models/payee_delta2.rb +299 -0
  234. data/lib/velopayments/models/payee_delta_response.rb +13 -3
  235. data/lib/velopayments/models/payee_delta_response2.rb +229 -0
  236. data/lib/velopayments/models/{register_mfa_request.rb → payee_delta_response2_links.rb} +32 -18
  237. data/lib/velopayments/models/payee_delta_response_links.rb +13 -3
  238. data/lib/velopayments/models/payee_delta_response_page.rb +13 -3
  239. data/lib/velopayments/models/payee_invitation_status.rb +13 -3
  240. data/lib/velopayments/models/payee_invitation_status_response.rb +48 -4
  241. data/lib/velopayments/models/payee_invitation_status_response2.rb +268 -0
  242. data/lib/velopayments/models/payee_payment_channel.rb +60 -39
  243. data/lib/velopayments/models/payee_payment_channel2.rb +451 -0
  244. data/lib/velopayments/models/payee_payor_ref.rb +13 -3
  245. data/lib/velopayments/models/payee_payor_ref_v2.rb +278 -0
  246. data/lib/velopayments/models/payee_payor_ref_v3.rb +278 -0
  247. data/lib/velopayments/models/payee_response.rb +19 -3
  248. data/lib/velopayments/models/payee_response2.rb +20 -4
  249. data/lib/velopayments/models/payee_response_v2.rb +471 -0
  250. data/lib/velopayments/models/payee_response_v3.rb +462 -0
  251. data/lib/velopayments/models/payee_type.rb +2 -2
  252. data/lib/velopayments/models/payment_audit_currency_v3.rb +2 -2
  253. data/lib/velopayments/models/payment_audit_currency_v4.rb +2 -2
  254. data/lib/velopayments/models/payment_channel_country.rb +25 -3
  255. data/lib/velopayments/models/payment_channel_rule.rb +40 -3
  256. data/lib/velopayments/models/payment_channel_rules_response.rb +13 -3
  257. data/lib/velopayments/models/payment_delta.rb +20 -4
  258. data/lib/velopayments/models/payment_delta_response.rb +14 -4
  259. data/lib/velopayments/models/payment_event_response_v3.rb +13 -3
  260. data/lib/velopayments/models/payment_event_response_v4.rb +13 -3
  261. data/lib/velopayments/models/payment_instruction.rb +14 -47
  262. data/lib/velopayments/models/payment_rails.rb +2 -2
  263. data/lib/velopayments/models/payment_response_v3.rb +13 -3
  264. data/lib/velopayments/models/payment_response_v4.rb +13 -3
  265. data/lib/velopayments/models/payment_response_v4_payout.rb +13 -3
  266. data/lib/velopayments/models/payor_address.rb +18 -3
  267. data/lib/velopayments/models/payor_address_v2.rb +18 -3
  268. data/lib/velopayments/models/payor_aml_transaction_v3.rb +13 -3
  269. data/lib/velopayments/models/payor_aml_transaction_v4.rb +13 -3
  270. data/lib/velopayments/models/payor_branding_response.rb +16 -3
  271. data/lib/velopayments/models/payor_create_api_key_request.rb +14 -3
  272. data/lib/velopayments/models/payor_create_api_key_response.rb +13 -3
  273. data/lib/velopayments/models/payor_create_application_request.rb +14 -3
  274. data/lib/velopayments/models/payor_email_opt_out_request.rb +13 -3
  275. data/lib/velopayments/models/payor_links_response.rb +13 -3
  276. data/lib/velopayments/models/payor_links_response_links.rb +13 -3
  277. data/lib/velopayments/models/payor_links_response_payors.rb +13 -3
  278. data/lib/velopayments/models/payor_logo_request.rb +13 -3
  279. data/lib/velopayments/models/payor_v1.rb +13 -3
  280. data/lib/velopayments/models/payor_v2.rb +13 -3
  281. data/lib/velopayments/models/payout_payor_v4.rb +13 -3
  282. data/lib/velopayments/models/payout_principal_v4.rb +13 -3
  283. data/lib/velopayments/models/payout_status_v3.rb +2 -2
  284. data/lib/velopayments/models/payout_status_v4.rb +2 -2
  285. data/lib/velopayments/models/payout_summary_audit_v3.rb +13 -3
  286. data/lib/velopayments/models/payout_summary_audit_v4.rb +13 -3
  287. data/lib/velopayments/models/payout_summary_response.rb +13 -3
  288. data/lib/velopayments/models/payout_type_v4.rb +2 -2
  289. data/lib/velopayments/models/query_batch_response.rb +13 -3
  290. data/lib/velopayments/models/query_batch_response2.rb +270 -0
  291. data/lib/velopayments/models/quote_fx_summary.rb +13 -3
  292. data/lib/velopayments/models/quote_response.rb +13 -3
  293. data/lib/velopayments/models/region.rb +13 -3
  294. data/lib/velopayments/models/register_sms_request.rb +13 -3
  295. data/lib/velopayments/models/rejected_payment.rb +13 -3
  296. data/lib/velopayments/models/resend_token_request.rb +15 -4
  297. data/lib/velopayments/models/reset_password_request.rb +13 -3
  298. data/lib/velopayments/models/role.rb +13 -3
  299. data/lib/velopayments/models/{email_update_request.rb → role_update_request.rb} +31 -18
  300. data/lib/velopayments/models/self_mfa_type_unregister_request.rb +13 -3
  301. data/lib/velopayments/models/self_update_password_request.rb +13 -3
  302. data/lib/velopayments/models/set_notifications_request.rb +13 -3
  303. data/lib/velopayments/models/source_account.rb +13 -3
  304. data/lib/velopayments/models/source_account_response.rb +15 -3
  305. data/lib/velopayments/models/source_account_response_v2.rb +15 -3
  306. data/lib/velopayments/models/source_account_summary_v3.rb +13 -3
  307. data/lib/velopayments/models/source_account_summary_v4.rb +13 -3
  308. data/lib/velopayments/models/supported_countries_response.rb +13 -3
  309. data/lib/velopayments/models/supported_countries_response2.rb +14 -4
  310. data/lib/velopayments/models/supported_country.rb +13 -3
  311. data/lib/velopayments/models/{supported_country_v2.rb → supported_country2.rb} +20 -8
  312. data/lib/velopayments/models/supported_currency.rb +14 -3
  313. data/lib/velopayments/models/supported_currency_response.rb +13 -3
  314. data/lib/velopayments/models/transfer_request.rb +13 -3
  315. data/lib/velopayments/models/unregister_mfa_request.rb +17 -6
  316. data/lib/velopayments/models/update_remote_id_request.rb +13 -3
  317. data/lib/velopayments/models/user_details_update_request.rb +406 -0
  318. data/lib/velopayments/models/user_info.rb +13 -3
  319. data/lib/velopayments/models/user_response.rb +14 -3
  320. data/lib/velopayments/models/user_response2.rb +14 -3
  321. data/lib/velopayments/models/user_response2_roles.rb +13 -3
  322. data/lib/velopayments/models/user_status.rb +2 -2
  323. data/lib/velopayments/models/user_type.rb +2 -2
  324. data/lib/velopayments/models/user_type2.rb +2 -2
  325. data/lib/velopayments/models/validate_password_response.rb +13 -3
  326. data/lib/velopayments/models/watchlist_status.rb +2 -2
  327. data/lib/velopayments/version.rb +3 -3
  328. data/oa3-config.json +1 -1
  329. data/spec/api/countries_api_spec.rb +3 -3
  330. data/spec/api/currencies_api_spec.rb +2 -2
  331. data/spec/api/funding_manager_api_spec.rb +6 -4
  332. data/spec/api/{default_api_spec.rb → funding_manager_private_api_spec.rb} +8 -8
  333. data/spec/api/get_payout_api_spec.rb +4 -4
  334. data/spec/api/instruct_payout_api_spec.rb +4 -4
  335. data/spec/api/login_api_spec.rb +2 -2
  336. data/spec/api/payee_invitation_api_spec.rb +62 -33
  337. data/spec/api/payees_api_spec.rb +81 -15
  338. data/spec/api/payment_audit_service_api_spec.rb +4 -4
  339. data/spec/api/payors_api_spec.rb +2 -2
  340. data/spec/api/payors_private_api_spec.rb +2 -2
  341. data/spec/api/payout_history_api_spec.rb +2 -2
  342. data/spec/api/quote_payout_api_spec.rb +2 -2
  343. data/spec/api/submit_payout_api_spec.rb +3 -3
  344. data/spec/api/tokens_api_spec.rb +2 -131
  345. data/spec/api/users_api_spec.rb +28 -15
  346. data/spec/api/withdraw_payout_api_spec.rb +4 -4
  347. data/spec/api_client_spec.rb +2 -2
  348. data/spec/configuration_spec.rb +2 -2
  349. data/spec/models/accepted_payment_spec.rb +2 -2
  350. data/spec/models/access_token_response_spec.rb +2 -2
  351. data/spec/models/access_token_validation_request_spec.rb +2 -2
  352. data/spec/models/auth_response_spec.rb +2 -2
  353. data/spec/models/auto_top_up_config_spec.rb +2 -2
  354. data/spec/models/challenge_spec.rb +2 -2
  355. data/spec/models/{payee_payor_ref2_spec.rb → company2_spec.rb} +11 -11
  356. data/spec/models/company_response_spec.rb +2 -2
  357. data/spec/models/company_spec.rb +53 -0
  358. data/spec/models/company_v1_spec.rb +2 -2
  359. data/spec/models/create_funding_account_request_spec.rb +2 -2
  360. data/spec/models/create_individual2_name_spec.rb +59 -0
  361. data/spec/models/create_individual2_spec.rb +2 -2
  362. data/spec/models/create_individual_spec.rb +2 -2
  363. data/spec/models/create_payee2_spec.rb +2 -2
  364. data/spec/models/create_payee_address2_spec.rb +2 -2
  365. data/spec/models/create_payee_address_spec.rb +2 -2
  366. data/spec/models/create_payee_spec.rb +2 -2
  367. data/spec/models/create_payees_csv_request2_spec.rb +2 -2
  368. data/spec/models/create_payees_csv_request_spec.rb +2 -2
  369. data/spec/models/create_payees_csv_response2_spec.rb +2 -2
  370. data/spec/models/create_payees_csv_response_rejected_csv_rows_spec.rb +53 -0
  371. data/spec/models/create_payees_csv_response_spec.rb +2 -2
  372. data/spec/models/create_payees_request2_spec.rb +2 -2
  373. data/spec/models/create_payees_request_spec.rb +2 -2
  374. data/spec/models/create_payment_channel2_spec.rb +2 -2
  375. data/spec/models/create_payment_channel_spec.rb +2 -2
  376. data/spec/models/create_payor_link_request_spec.rb +2 -2
  377. data/spec/models/create_payout_request_spec.rb +2 -2
  378. data/spec/models/currency_type_spec.rb +2 -2
  379. data/spec/models/error_response_spec.rb +2 -2
  380. data/spec/models/error_spec.rb +3 -3
  381. data/spec/models/{register_mfa_response_spec.rb → failed_submission2_spec.rb} +10 -10
  382. data/spec/models/failed_submission_spec.rb +2 -2
  383. data/spec/models/funding_account_response_spec.rb +2 -2
  384. data/spec/models/funding_audit_spec.rb +2 -2
  385. data/spec/models/funding_event_spec.rb +2 -2
  386. data/spec/models/funding_event_type_spec.rb +2 -2
  387. data/spec/models/funding_payor_status_audit_response_spec.rb +2 -2
  388. data/spec/models/funding_request_v1_spec.rb +2 -2
  389. data/spec/models/funding_request_v2_spec.rb +2 -2
  390. data/spec/models/fx_summary_v3_spec.rb +2 -2
  391. data/spec/models/fx_summary_v4_spec.rb +2 -2
  392. data/spec/models/get_fundings_response_all_of_spec.rb +2 -2
  393. data/spec/models/get_fundings_response_spec.rb +2 -2
  394. data/spec/models/get_payments_for_payout_response_v3_page_spec.rb +2 -2
  395. data/spec/models/get_payments_for_payout_response_v3_spec.rb +2 -2
  396. data/spec/models/get_payments_for_payout_response_v3_summary_spec.rb +2 -2
  397. data/spec/models/get_payments_for_payout_response_v4_spec.rb +2 -2
  398. data/spec/models/get_payments_for_payout_response_v4_summary_spec.rb +2 -2
  399. data/spec/models/get_payout_statistics_spec.rb +2 -2
  400. data/spec/models/get_payouts_response_v3_links_spec.rb +2 -2
  401. data/spec/models/get_payouts_response_v3_page_spec.rb +2 -2
  402. data/spec/models/get_payouts_response_v3_spec.rb +2 -2
  403. data/spec/models/get_payouts_response_v4_spec.rb +2 -2
  404. data/spec/models/individual2_spec.rb +53 -0
  405. data/spec/models/individual_response_spec.rb +2 -2
  406. data/spec/models/individual_spec.rb +53 -0
  407. data/spec/models/individual_v1_name_spec.rb +2 -2
  408. data/spec/models/individual_v1_spec.rb +2 -2
  409. data/spec/models/inline_response400_errors_spec.rb +59 -0
  410. data/spec/models/{generate_otp_request_spec.rb → inline_response400_spec.rb} +15 -9
  411. data/spec/models/inline_response401_errors_spec.rb +59 -0
  412. data/spec/models/inline_response401_spec.rb +47 -0
  413. data/spec/models/inline_response403_errors_spec.rb +59 -0
  414. data/spec/models/inline_response403_spec.rb +47 -0
  415. data/spec/models/invitation_status_response_spec.rb +2 -2
  416. data/spec/models/invitation_status_spec.rb +2 -2
  417. data/spec/models/{register_mfa_request_spec.rb → invite_payee_request2_spec.rb} +9 -9
  418. data/spec/models/invite_payee_request_spec.rb +2 -2
  419. data/spec/models/invite_user_request_spec.rb +2 -2
  420. data/spec/models/kyc_state_spec.rb +2 -2
  421. data/spec/models/{otp_type_spec.rb → language2_spec.rb} +8 -8
  422. data/spec/models/language_spec.rb +2 -2
  423. data/spec/models/link_for_response_spec.rb +2 -2
  424. data/spec/models/list_funding_accounts_response_spec.rb +2 -2
  425. data/spec/models/list_payments_response_page_spec.rb +2 -2
  426. data/spec/models/list_payments_response_spec.rb +2 -2
  427. data/spec/models/list_payments_response_v4_spec.rb +2 -2
  428. data/spec/models/list_source_account_response_links_spec.rb +2 -2
  429. data/spec/models/list_source_account_response_page_spec.rb +2 -2
  430. data/spec/models/list_source_account_response_spec.rb +2 -2
  431. data/spec/models/list_source_account_response_v2_spec.rb +2 -2
  432. data/spec/models/{token_type_spec.rb → location_type_spec.rb} +8 -8
  433. data/spec/models/marketing_opt_in_spec.rb +2 -2
  434. data/spec/models/mfa_details_spec.rb +2 -2
  435. data/spec/models/mfa_type_spec.rb +2 -2
  436. data/spec/models/notifications_spec.rb +2 -2
  437. data/spec/models/{mfa_status_spec.rb → ofac_status2_spec.rb} +8 -8
  438. data/spec/models/ofac_status_spec.rb +2 -2
  439. data/spec/models/{payment_status_spec.rb → onboarded_status2_spec.rb} +8 -8
  440. data/spec/models/onboarded_status_spec.rb +2 -2
  441. data/spec/models/page_for_response_spec.rb +2 -2
  442. data/spec/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response_spec.rb +2 -2
  443. data/spec/models/paged_payee_invitation_status_response2_spec.rb +53 -0
  444. data/spec/models/{check_token_response_spec.rb → paged_payee_invitation_status_response_page_spec.rb} +13 -13
  445. data/spec/models/paged_payee_invitation_status_response_spec.rb +2 -2
  446. data/spec/models/paged_payee_response2_spec.rb +2 -2
  447. data/spec/models/paged_payee_response2_summary_spec.rb +2 -2
  448. data/spec/models/paged_payee_response_links_spec.rb +2 -2
  449. data/spec/models/paged_payee_response_page_spec.rb +2 -2
  450. data/spec/models/paged_payee_response_spec.rb +2 -2
  451. data/spec/models/paged_payee_response_summary_spec.rb +2 -2
  452. data/spec/models/paged_response_page_spec.rb +2 -2
  453. data/spec/models/paged_response_spec.rb +2 -2
  454. data/spec/models/paged_user_response_links_spec.rb +2 -2
  455. data/spec/models/paged_user_response_page_spec.rb +2 -2
  456. data/spec/models/paged_user_response_spec.rb +2 -2
  457. data/spec/models/password_request_spec.rb +2 -2
  458. data/spec/models/payee2_spec.rb +165 -0
  459. data/spec/models/payee_address2_spec.rb +83 -0
  460. data/spec/models/payee_address_spec.rb +2 -2
  461. data/spec/models/payee_delta2_spec.rb +77 -0
  462. data/spec/models/payee_delta_response2_links_spec.rb +47 -0
  463. data/spec/models/payee_delta_response2_spec.rb +53 -0
  464. data/spec/models/payee_delta_response_links_spec.rb +2 -2
  465. data/spec/models/payee_delta_response_page_spec.rb +2 -2
  466. data/spec/models/payee_delta_response_spec.rb +2 -2
  467. data/spec/models/payee_delta_spec.rb +2 -2
  468. data/spec/models/payee_invitation_status_response2_spec.rb +57 -0
  469. data/spec/models/payee_invitation_status_response_spec.rb +6 -2
  470. data/spec/models/payee_invitation_status_spec.rb +2 -2
  471. data/spec/models/payee_payment_channel2_spec.rb +81 -0
  472. data/spec/models/payee_payment_channel_spec.rb +3 -3
  473. data/spec/models/payee_payor_ref_spec.rb +2 -2
  474. data/spec/models/payee_payor_ref_v2_spec.rb +69 -0
  475. data/spec/models/payee_payor_ref_v3_spec.rb +69 -0
  476. data/spec/models/payee_response2_spec.rb +2 -2
  477. data/spec/models/payee_response_spec.rb +2 -2
  478. data/spec/models/payee_response_v2_spec.rb +209 -0
  479. data/spec/models/payee_response_v3_spec.rb +203 -0
  480. data/spec/models/payee_spec.rb +2 -2
  481. data/spec/models/payee_type_spec.rb +2 -2
  482. data/spec/models/payment_audit_currency_v3_spec.rb +2 -2
  483. data/spec/models/payment_audit_currency_v4_spec.rb +2 -2
  484. data/spec/models/payment_channel_country_spec.rb +2 -2
  485. data/spec/models/payment_channel_rule_spec.rb +2 -2
  486. data/spec/models/payment_channel_rules_response_spec.rb +2 -2
  487. data/spec/models/payment_delta_response_spec.rb +2 -2
  488. data/spec/models/payment_delta_spec.rb +2 -2
  489. data/spec/models/payment_event_response_v3_spec.rb +2 -2
  490. data/spec/models/payment_event_response_v4_spec.rb +2 -2
  491. data/spec/models/payment_instruction_spec.rb +2 -6
  492. data/spec/models/payment_rails_spec.rb +2 -2
  493. data/spec/models/payment_response_v3_spec.rb +2 -2
  494. data/spec/models/payment_response_v4_payout_spec.rb +2 -2
  495. data/spec/models/payment_response_v4_spec.rb +2 -2
  496. data/spec/models/payor_address_spec.rb +2 -2
  497. data/spec/models/payor_address_v2_spec.rb +2 -2
  498. data/spec/models/payor_aml_transaction_v3_spec.rb +2 -2
  499. data/spec/models/payor_aml_transaction_v4_spec.rb +2 -2
  500. data/spec/models/payor_branding_response_spec.rb +2 -2
  501. data/spec/models/payor_create_api_key_request_spec.rb +2 -2
  502. data/spec/models/payor_create_api_key_response_spec.rb +2 -2
  503. data/spec/models/payor_create_application_request_spec.rb +2 -2
  504. data/spec/models/payor_email_opt_out_request_spec.rb +2 -2
  505. data/spec/models/payor_links_response_links_spec.rb +2 -2
  506. data/spec/models/payor_links_response_payors_spec.rb +2 -2
  507. data/spec/models/payor_links_response_spec.rb +2 -2
  508. data/spec/models/payor_logo_request_spec.rb +2 -2
  509. data/spec/models/payor_v1_spec.rb +2 -2
  510. data/spec/models/payor_v2_spec.rb +2 -2
  511. data/spec/models/payout_payor_v4_spec.rb +2 -2
  512. data/spec/models/payout_principal_v4_spec.rb +2 -2
  513. data/spec/models/payout_status_v3_spec.rb +2 -2
  514. data/spec/models/payout_status_v4_spec.rb +2 -2
  515. data/spec/models/payout_summary_audit_v3_spec.rb +2 -2
  516. data/spec/models/payout_summary_audit_v4_spec.rb +2 -2
  517. data/spec/models/payout_summary_response_spec.rb +2 -2
  518. data/spec/models/payout_type_v4_spec.rb +2 -2
  519. data/spec/models/query_batch_response2_spec.rb +63 -0
  520. data/spec/models/query_batch_response_spec.rb +2 -2
  521. data/spec/models/quote_fx_summary_spec.rb +2 -2
  522. data/spec/models/quote_response_spec.rb +2 -2
  523. data/spec/models/region_spec.rb +2 -2
  524. data/spec/models/register_sms_request_spec.rb +2 -2
  525. data/spec/models/rejected_payment_spec.rb +2 -2
  526. data/spec/models/resend_token_request_spec.rb +2 -2
  527. data/spec/models/reset_password_request_spec.rb +2 -2
  528. data/spec/models/role_spec.rb +2 -2
  529. data/spec/models/{email_update_request_spec.rb → role_update_request_spec.rb} +9 -9
  530. data/spec/models/self_mfa_type_unregister_request_spec.rb +2 -2
  531. data/spec/models/self_update_password_request_spec.rb +2 -2
  532. data/spec/models/set_notifications_request_spec.rb +2 -2
  533. data/spec/models/source_account_response_spec.rb +2 -2
  534. data/spec/models/source_account_response_v2_spec.rb +2 -2
  535. data/spec/models/source_account_spec.rb +2 -2
  536. data/spec/models/source_account_summary_v3_spec.rb +2 -2
  537. data/spec/models/source_account_summary_v4_spec.rb +2 -2
  538. data/spec/models/supported_countries_response2_spec.rb +2 -2
  539. data/spec/models/supported_countries_response_spec.rb +2 -2
  540. data/spec/models/{supported_country_v2_spec.rb → supported_country2_spec.rb} +8 -8
  541. data/spec/models/supported_country_spec.rb +2 -2
  542. data/spec/models/supported_currency_response_spec.rb +2 -2
  543. data/spec/models/supported_currency_spec.rb +2 -2
  544. data/spec/models/transfer_request_spec.rb +2 -2
  545. data/spec/models/unregister_mfa_request_spec.rb +3 -3
  546. data/spec/models/update_remote_id_request_spec.rb +2 -2
  547. data/spec/models/user_details_update_request_spec.rb +83 -0
  548. data/spec/models/user_info_spec.rb +2 -2
  549. data/spec/models/user_response2_roles_spec.rb +2 -2
  550. data/spec/models/user_response2_spec.rb +2 -2
  551. data/spec/models/user_response_spec.rb +2 -2
  552. data/spec/models/user_status_spec.rb +2 -2
  553. data/spec/models/user_type2_spec.rb +2 -2
  554. data/spec/models/user_type_spec.rb +2 -2
  555. data/spec/models/validate_password_response_spec.rb +2 -2
  556. data/spec/models/watchlist_status_spec.rb +2 -2
  557. data/spec/spec_helper.rb +2 -2
  558. data/velopayments.gemspec +2 -2
  559. metadata +310 -222
  560. data/docs/CheckTokenResponse.md +0 -25
  561. data/docs/EmailUpdateRequest.md +0 -19
  562. data/docs/PayeePayorRef2.md +0 -21
  563. data/docs/RegisterMFARequest.md +0 -17
  564. data/docs/RegisterMFAResponse.md +0 -19
  565. data/docs/ValidateMFARequest.md +0 -17
  566. data/docs/ValidateOTPRequest.md +0 -17
  567. data/spec/models/validate_mfa_request_spec.rb +0 -41
  568. data/spec/models/validate_otp_request_spec.rb +0 -41
@@ -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.18.113
6
+ The version of the OpenAPI document: 2.19.40
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.1-SNAPSHOT
9
+ OpenAPI Generator version: 4.2.3-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -31,6 +31,12 @@ module VeloPayments
31
31
  }
32
32
  end
33
33
 
34
+ # List of attributes with nullable: true
35
+ def self.openapi_nullable
36
+ Set.new([
37
+ ])
38
+ end
39
+
34
40
  # Initializes the object
35
41
  # @param [Hash] attributes Model attributes in the form of hash
36
42
  def initialize(attributes = {})
@@ -196,7 +202,11 @@ module VeloPayments
196
202
  hash = {}
197
203
  self.class.attribute_map.each_pair do |attr, param|
198
204
  value = self.send(attr)
199
- next if value.nil?
205
+ if value.nil?
206
+ is_nullable = self.class.openapi_nullable.include?(attr)
207
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
208
+ end
209
+
200
210
  hash[param] = _to_hash(value)
201
211
  end
202
212
  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.18.113
6
+ The version of the OpenAPI document: 2.19.40
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.1-SNAPSHOT
9
+ OpenAPI Generator version: 4.2.3-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -62,6 +62,12 @@ module VeloPayments
62
62
  }
63
63
  end
64
64
 
65
+ # List of attributes with nullable: true
66
+ def self.openapi_nullable
67
+ Set.new([
68
+ ])
69
+ end
70
+
65
71
  # Initializes the object
66
72
  # @param [Hash] attributes Model attributes in the form of hash
67
73
  def initialize(attributes = {})
@@ -299,7 +305,11 @@ module VeloPayments
299
305
  hash = {}
300
306
  self.class.attribute_map.each_pair do |attr, param|
301
307
  value = self.send(attr)
302
- next if value.nil?
308
+ if value.nil?
309
+ is_nullable = self.class.openapi_nullable.include?(attr)
310
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
311
+ end
312
+
303
313
  hash[param] = _to_hash(value)
304
314
  end
305
315
  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.18.113
6
+ The version of the OpenAPI document: 2.19.40
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.1-SNAPSHOT
9
+ OpenAPI Generator version: 4.2.3-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -17,7 +17,7 @@ module VeloPayments
17
17
  # The type of the token to resend
18
18
  attr_accessor :token_type
19
19
 
20
- # Optional property that MUST be suppied when manually verifying a user <P> The user's smsNumber is registered via a separate endpoint and an OTP sent to them
20
+ # <p>Optional property that MUST be suppied when manually verifying a user</p> <p>The user's smsNumber is registered via a separate endpoint and an OTP sent to them</p>
21
21
  attr_accessor :verification_code
22
22
 
23
23
  class EnumAttributeValidator
@@ -58,6 +58,13 @@ module VeloPayments
58
58
  }
59
59
  end
60
60
 
61
+ # List of attributes with nullable: true
62
+ def self.openapi_nullable
63
+ Set.new([
64
+ :'verification_code'
65
+ ])
66
+ end
67
+
61
68
  # Initializes the object
62
69
  # @param [Hash] attributes Model attributes in the form of hash
63
70
  def initialize(attributes = {})
@@ -243,7 +250,11 @@ module VeloPayments
243
250
  hash = {}
244
251
  self.class.attribute_map.each_pair do |attr, param|
245
252
  value = self.send(attr)
246
- next if value.nil?
253
+ if value.nil?
254
+ is_nullable = self.class.openapi_nullable.include?(attr)
255
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
256
+ end
257
+
247
258
  hash[param] = _to_hash(value)
248
259
  end
249
260
  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.18.113
6
+ The version of the OpenAPI document: 2.19.40
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.1-SNAPSHOT
9
+ OpenAPI Generator version: 4.2.3-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -31,6 +31,12 @@ module VeloPayments
31
31
  }
32
32
  end
33
33
 
34
+ # List of attributes with nullable: true
35
+ def self.openapi_nullable
36
+ Set.new([
37
+ ])
38
+ end
39
+
34
40
  # Initializes the object
35
41
  # @param [Hash] attributes Model attributes in the form of hash
36
42
  def initialize(attributes = {})
@@ -175,7 +181,11 @@ module VeloPayments
175
181
  hash = {}
176
182
  self.class.attribute_map.each_pair do |attr, param|
177
183
  value = self.send(attr)
178
- next if value.nil?
184
+ if value.nil?
185
+ is_nullable = self.class.openapi_nullable.include?(attr)
186
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
187
+ end
188
+
179
189
  hash[param] = _to_hash(value)
180
190
  end
181
191
  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.18.113
6
+ The version of the OpenAPI document: 2.19.40
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.1-SNAPSHOT
9
+ OpenAPI Generator version: 4.2.3-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -31,6 +31,12 @@ module VeloPayments
31
31
  }
32
32
  end
33
33
 
34
+ # List of attributes with nullable: true
35
+ def self.openapi_nullable
36
+ Set.new([
37
+ ])
38
+ end
39
+
34
40
  # Initializes the object
35
41
  # @param [Hash] attributes Model attributes in the form of hash
36
42
  def initialize(attributes = {})
@@ -175,7 +181,11 @@ module VeloPayments
175
181
  hash = {}
176
182
  self.class.attribute_map.each_pair do |attr, param|
177
183
  value = self.send(attr)
178
- next if value.nil?
184
+ if value.nil?
185
+ is_nullable = self.class.openapi_nullable.include?(attr)
186
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
187
+ end
188
+
179
189
  hash[param] = _to_hash(value)
180
190
  end
181
191
  hash
@@ -3,27 +3,27 @@
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.18.113
6
+ The version of the OpenAPI document: 2.19.40
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.1-SNAPSHOT
9
+ OpenAPI Generator version: 4.2.3-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
13
13
  require 'date'
14
14
 
15
15
  module VeloPayments
16
- class EmailUpdateRequest
17
- # the email address of the invited user
18
- attr_accessor :email
16
+ class RoleUpdateRequest
17
+ # <p>The role(s) for the user</p> <p>The role must exist</p> <p>The role can be a custom role or a system role but the invoker must have the permissions to assign the role</p> <p>System roles are: backoffice.admin, payor.master_admin, payor.admin, payor.support</p>
18
+ attr_accessor :roles
19
19
 
20
- # Optional property that MUST be suppied when manually verifying a user The user's smsNumber is registered via a separate endpoint and an OTP sent to them
20
+ # <p>Optional property that MUST be suppied when manually verifying a user</p> <p>The user's smsNumber is registered via a separate endpoint and an OTP sent to them</p>
21
21
  attr_accessor :verification_code
22
22
 
23
23
  # Attribute mapping from ruby-style variable name to JSON key.
24
24
  def self.attribute_map
25
25
  {
26
- :'email' => :'email',
26
+ :'roles' => :'roles',
27
27
  :'verification_code' => :'verificationCode'
28
28
  }
29
29
  end
@@ -31,28 +31,37 @@ module VeloPayments
31
31
  # Attribute type mapping.
32
32
  def self.openapi_types
33
33
  {
34
- :'email' => :'String',
34
+ :'roles' => :'Array<String>',
35
35
  :'verification_code' => :'String'
36
36
  }
37
37
  end
38
38
 
39
+ # List of attributes with nullable: true
40
+ def self.openapi_nullable
41
+ Set.new([
42
+ :'verification_code'
43
+ ])
44
+ end
45
+
39
46
  # Initializes the object
40
47
  # @param [Hash] attributes Model attributes in the form of hash
41
48
  def initialize(attributes = {})
42
49
  if (!attributes.is_a?(Hash))
43
- fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::EmailUpdateRequest` initialize method"
50
+ fail ArgumentError, "The input argument (attributes) must be a hash in `VeloPayments::RoleUpdateRequest` initialize method"
44
51
  end
45
52
 
46
53
  # check to see if the attribute exists and convert string to symbol for hash key
47
54
  attributes = attributes.each_with_object({}) { |(k, v), h|
48
55
  if (!self.class.attribute_map.key?(k.to_sym))
49
- fail ArgumentError, "`#{k}` is not a valid attribute in `VeloPayments::EmailUpdateRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
56
+ fail ArgumentError, "`#{k}` is not a valid attribute in `VeloPayments::RoleUpdateRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
50
57
  end
51
58
  h[k.to_sym] = v
52
59
  }
53
60
 
54
- if attributes.key?(:'email')
55
- self.email = attributes[:'email']
61
+ if attributes.key?(:'roles')
62
+ if (value = attributes[:'roles']).is_a?(Array)
63
+ self.roles = value
64
+ end
56
65
  end
57
66
 
58
67
  if attributes.key?(:'verification_code')
@@ -64,8 +73,8 @@ module VeloPayments
64
73
  # @return Array for valid properties with the reasons
65
74
  def list_invalid_properties
66
75
  invalid_properties = Array.new
67
- if @email.nil?
68
- invalid_properties.push('invalid value for "email", email cannot be nil.')
76
+ if @roles.nil?
77
+ invalid_properties.push('invalid value for "roles", roles cannot be nil.')
69
78
  end
70
79
 
71
80
  if !@verification_code.nil? && @verification_code.to_s.length > 6
@@ -82,7 +91,7 @@ module VeloPayments
82
91
  # Check to see if the all the properties in the model are valid
83
92
  # @return true if the model is valid
84
93
  def valid?
85
- return false if @email.nil?
94
+ return false if @roles.nil?
86
95
  return false if !@verification_code.nil? && @verification_code.to_s.length > 6
87
96
  return false if !@verification_code.nil? && @verification_code.to_s.length < 6
88
97
  true
@@ -107,7 +116,7 @@ module VeloPayments
107
116
  def ==(o)
108
117
  return true if self.equal?(o)
109
118
  self.class == o.class &&
110
- email == o.email &&
119
+ roles == o.roles &&
111
120
  verification_code == o.verification_code
112
121
  end
113
122
 
@@ -120,7 +129,7 @@ module VeloPayments
120
129
  # Calculates hash code according to all attributes.
121
130
  # @return [Integer] Hash code
122
131
  def hash
123
- [email, verification_code].hash
132
+ [roles, verification_code].hash
124
133
  end
125
134
 
126
135
  # Builds the object from hash
@@ -209,7 +218,11 @@ module VeloPayments
209
218
  hash = {}
210
219
  self.class.attribute_map.each_pair do |attr, param|
211
220
  value = self.send(attr)
212
- next if value.nil?
221
+ if value.nil?
222
+ is_nullable = self.class.openapi_nullable.include?(attr)
223
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
224
+ end
225
+
213
226
  hash[param] = _to_hash(value)
214
227
  end
215
228
  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.18.113
6
+ The version of the OpenAPI document: 2.19.40
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.1-SNAPSHOT
9
+ OpenAPI Generator version: 4.2.3-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -53,6 +53,12 @@ module VeloPayments
53
53
  }
54
54
  end
55
55
 
56
+ # List of attributes with nullable: true
57
+ def self.openapi_nullable
58
+ Set.new([
59
+ ])
60
+ end
61
+
56
62
  # Initializes the object
57
63
  # @param [Hash] attributes Model attributes in the form of hash
58
64
  def initialize(attributes = {})
@@ -209,7 +215,11 @@ module VeloPayments
209
215
  hash = {}
210
216
  self.class.attribute_map.each_pair do |attr, param|
211
217
  value = self.send(attr)
212
- next if value.nil?
218
+ if value.nil?
219
+ is_nullable = self.class.openapi_nullable.include?(attr)
220
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
221
+ end
222
+
213
223
  hash[param] = _to_hash(value)
214
224
  end
215
225
  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.18.113
6
+ The version of the OpenAPI document: 2.19.40
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.1-SNAPSHOT
9
+ OpenAPI Generator version: 4.2.3-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -36,6 +36,12 @@ module VeloPayments
36
36
  }
37
37
  end
38
38
 
39
+ # List of attributes with nullable: true
40
+ def self.openapi_nullable
41
+ Set.new([
42
+ ])
43
+ end
44
+
39
45
  # Initializes the object
40
46
  # @param [Hash] attributes Model attributes in the form of hash
41
47
  def initialize(attributes = {})
@@ -246,7 +252,11 @@ module VeloPayments
246
252
  hash = {}
247
253
  self.class.attribute_map.each_pair do |attr, param|
248
254
  value = self.send(attr)
249
- next if value.nil?
255
+ if value.nil?
256
+ is_nullable = self.class.openapi_nullable.include?(attr)
257
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
258
+ end
259
+
250
260
  hash[param] = _to_hash(value)
251
261
  end
252
262
  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.18.113
6
+ The version of the OpenAPI document: 2.19.40
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.1-SNAPSHOT
9
+ OpenAPI Generator version: 4.2.3-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -31,6 +31,12 @@ module VeloPayments
31
31
  }
32
32
  end
33
33
 
34
+ # List of attributes with nullable: true
35
+ def self.openapi_nullable
36
+ Set.new([
37
+ ])
38
+ end
39
+
34
40
  # Initializes the object
35
41
  # @param [Hash] attributes Model attributes in the form of hash
36
42
  def initialize(attributes = {})
@@ -203,7 +209,11 @@ module VeloPayments
203
209
  hash = {}
204
210
  self.class.attribute_map.each_pair do |attr, param|
205
211
  value = self.send(attr)
206
- next if value.nil?
212
+ if value.nil?
213
+ is_nullable = self.class.openapi_nullable.include?(attr)
214
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
215
+ end
216
+
207
217
  hash[param] = _to_hash(value)
208
218
  end
209
219
  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.18.113
6
+ The version of the OpenAPI document: 2.19.40
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.1-SNAPSHOT
9
+ OpenAPI Generator version: 4.2.3-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -42,6 +42,12 @@ module VeloPayments
42
42
  }
43
43
  end
44
44
 
45
+ # List of attributes with nullable: true
46
+ def self.openapi_nullable
47
+ Set.new([
48
+ ])
49
+ end
50
+
45
51
  # Initializes the object
46
52
  # @param [Hash] attributes Model attributes in the form of hash
47
53
  def initialize(attributes = {})
@@ -216,7 +222,11 @@ module VeloPayments
216
222
  hash = {}
217
223
  self.class.attribute_map.each_pair do |attr, param|
218
224
  value = self.send(attr)
219
- next if value.nil?
225
+ if value.nil?
226
+ is_nullable = self.class.openapi_nullable.include?(attr)
227
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
228
+ end
229
+
220
230
  hash[param] = _to_hash(value)
221
231
  end
222
232
  hash