velopayments 2.17.8 → 2.18.31.beta1

data/lib/velopayments.rb

@@ -3,10 +3,10 @@
 
 ### 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. 
 
-The version of the OpenAPI document: 2.17.8
+The version of the OpenAPI document: 2.18.31
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.1-SNAPSHOT
+OpenAPI Generator version: 4.2.3-SNAPSHOT
 
 =end
 
@@ -17,11 +17,16 @@ require 'velopayments/version'
 require 'velopayments/configuration'
 
 # Models
+require 'velopayments/models/accepted_payment'
+require 'velopayments/models/access_token_response'
+require 'velopayments/models/access_token_validation_request'
 require 'velopayments/models/auth_response'
 require 'velopayments/models/auto_top_up_config'
 require 'velopayments/models/challenge'
+require 'velopayments/models/check_token_response'
 require 'velopayments/models/company_response'
 require 'velopayments/models/company_v1'
+require 'velopayments/models/create_funding_account_request'
 require 'velopayments/models/create_individual'
 require 'velopayments/models/create_individual2'
 require 'velopayments/models/create_payee'
@@ -36,20 +41,23 @@ require 'velopayments/models/create_payees_request'
 require 'velopayments/models/create_payees_request2'
 require 'velopayments/models/create_payment_channel'
 require 'velopayments/models/create_payment_channel2'
+require 'velopayments/models/create_payor_link_request'
 require 'velopayments/models/create_payout_request'
+require 'velopayments/models/currency_type'
+require 'velopayments/models/email_update_request'
 require 'velopayments/models/error'
 require 'velopayments/models/error_response'
 require 'velopayments/models/failed_submission'
+require 'velopayments/models/funding_account_response'
 require 'velopayments/models/funding_audit'
-require 'velopayments/models/funding_delta'
-require 'velopayments/models/funding_delta_response'
-require 'velopayments/models/funding_delta_response_links'
 require 'velopayments/models/funding_event'
 require 'velopayments/models/funding_event_type'
+require 'velopayments/models/funding_payor_status_audit_response'
 require 'velopayments/models/funding_request_v1'
 require 'velopayments/models/funding_request_v2'
 require 'velopayments/models/fx_summary_v3'
 require 'velopayments/models/fx_summary_v4'
+require 'velopayments/models/generate_otp_request'
 require 'velopayments/models/get_fundings_response'
 require 'velopayments/models/get_fundings_response_all_of'
 require 'velopayments/models/get_payments_for_payout_response_v3'
@@ -61,7 +69,6 @@ require 'velopayments/models/get_payout_statistics'
 require 'velopayments/models/get_payouts_response_v3'
 require 'velopayments/models/get_payouts_response_v3_links'
 require 'velopayments/models/get_payouts_response_v3_page'
-require 'velopayments/models/get_payouts_response_v3_summary'
 require 'velopayments/models/get_payouts_response_v4'
 require 'velopayments/models/individual_response'
 require 'velopayments/models/individual_v1'
@@ -69,19 +76,28 @@ require 'velopayments/models/individual_v1_name'
 require 'velopayments/models/invitation_status'
 require 'velopayments/models/invitation_status_response'
 require 'velopayments/models/invite_payee_request'
+require 'velopayments/models/invite_user_request'
+require 'velopayments/models/kyc_state'
 require 'velopayments/models/language'
+require 'velopayments/models/link_for_response'
+require 'velopayments/models/list_funding_accounts_response'
 require 'velopayments/models/list_payments_response'
 require 'velopayments/models/list_payments_response_page'
-require 'velopayments/models/list_payments_response_summary'
+require 'velopayments/models/list_payments_response_v4'
 require 'velopayments/models/list_source_account_response'
 require 'velopayments/models/list_source_account_response_links'
 require 'velopayments/models/list_source_account_response_page'
 require 'velopayments/models/list_source_account_response_v2'
-require 'velopayments/models/list_source_account_response_v2_page'
+require 'velopayments/models/mfa_details'
+require 'velopayments/models/mfa_status'
+require 'velopayments/models/mfa_type'
 require 'velopayments/models/marketing_opt_in'
 require 'velopayments/models/notifications'
+require 'velopayments/models/otp_type'
 require 'velopayments/models/ofac_status'
 require 'velopayments/models/onboarded_status'
+require 'velopayments/models/page_for_response'
+require 'velopayments/models/page_resource_funding_payor_status_audit_response_funding_payor_status_audit_response'
 require 'velopayments/models/paged_payee_invitation_status_response'
 require 'velopayments/models/paged_payee_response'
 require 'velopayments/models/paged_payee_response2'
@@ -91,6 +107,10 @@ require 'velopayments/models/paged_payee_response_page'
 require 'velopayments/models/paged_payee_response_summary'
 require 'velopayments/models/paged_response'
 require 'velopayments/models/paged_response_page'
+require 'velopayments/models/paged_user_response'
+require 'velopayments/models/paged_user_response_links'
+require 'velopayments/models/paged_user_response_page'
+require 'velopayments/models/password_request'
 require 'velopayments/models/payee'
 require 'velopayments/models/payee_address'
 require 'velopayments/models/payee_delta'
@@ -115,12 +135,15 @@ require 'velopayments/models/payment_delta_response'
 require 'velopayments/models/payment_event_response_v3'
 require 'velopayments/models/payment_event_response_v4'
 require 'velopayments/models/payment_instruction'
+require 'velopayments/models/payment_rails'
 require 'velopayments/models/payment_response_v3'
 require 'velopayments/models/payment_response_v4'
 require 'velopayments/models/payment_response_v4_payout'
 require 'velopayments/models/payment_status'
 require 'velopayments/models/payor_address'
 require 'velopayments/models/payor_address_v2'
+require 'velopayments/models/payor_aml_transaction_v3'
+require 'velopayments/models/payor_aml_transaction_v4'
 require 'velopayments/models/payor_branding_response'
 require 'velopayments/models/payor_create_api_key_request'
 require 'velopayments/models/payor_create_api_key_response'
@@ -143,7 +166,16 @@ require 'velopayments/models/payout_type_v4'
 require 'velopayments/models/query_batch_response'
 require 'velopayments/models/quote_fx_summary'
 require 'velopayments/models/quote_response'
+require 'velopayments/models/region'
+require 'velopayments/models/register_mfa_request'
+require 'velopayments/models/register_mfa_response'
+require 'velopayments/models/register_sms_request'
 require 'velopayments/models/rejected_payment'
+require 'velopayments/models/resend_token_request'
+require 'velopayments/models/reset_password_request'
+require 'velopayments/models/role'
+require 'velopayments/models/self_mfa_type_unregister_request'
+require 'velopayments/models/self_update_password_request'
 require 'velopayments/models/set_notifications_request'
 require 'velopayments/models/source_account'
 require 'velopayments/models/source_account_response'
@@ -151,27 +183,45 @@ require 'velopayments/models/source_account_response_v2'
 require 'velopayments/models/source_account_summary_v3'
 require 'velopayments/models/source_account_summary_v4'
 require 'velopayments/models/supported_countries_response'
+require 'velopayments/models/supported_countries_response2'
 require 'velopayments/models/supported_country'
+require 'velopayments/models/supported_country2'
 require 'velopayments/models/supported_currency'
 require 'velopayments/models/supported_currency_response'
+require 'velopayments/models/token_type'
+require 'velopayments/models/transfer_request'
+require 'velopayments/models/unregister_mfa_request'
 require 'velopayments/models/update_remote_id_request'
+require 'velopayments/models/user_info'
+require 'velopayments/models/user_response'
+require 'velopayments/models/user_response2'
+require 'velopayments/models/user_response2_roles'
+require 'velopayments/models/user_status'
+require 'velopayments/models/user_type'
+require 'velopayments/models/user_type2'
+require 'velopayments/models/validate_mfa_request'
+require 'velopayments/models/validate_otp_request'
+require 'velopayments/models/validate_password_response'
 require 'velopayments/models/watchlist_status'
 
 # APIs
-require 'velopayments/api/auth_api'
 require 'velopayments/api/countries_api'
 require 'velopayments/api/currencies_api'
+require 'velopayments/api/default_api'
 require 'velopayments/api/funding_manager_api'
 require 'velopayments/api/get_payout_api'
 require 'velopayments/api/instruct_payout_api'
+require 'velopayments/api/login_api'
 require 'velopayments/api/payee_invitation_api'
 require 'velopayments/api/payees_api'
 require 'velopayments/api/payment_audit_service_api'
-require 'velopayments/api/payor_applications_api'
 require 'velopayments/api/payors_api'
+require 'velopayments/api/payors_private_api'
 require 'velopayments/api/payout_history_api'
 require 'velopayments/api/quote_payout_api'
 require 'velopayments/api/submit_payout_api'
+require 'velopayments/api/tokens_api'
+require 'velopayments/api/users_api'
 require 'velopayments/api/withdraw_payout_api'
 
 module VeloPayments

data/oa3-config.json

@@ -1,6 +1,6 @@
 {
     "gemName": "velopayments",
-    "gemVersion": "2.17.8",
+    "gemVersion": "2.18.31",
     "gemHomepage": "https://github.com/velopaymentsapi/velo-ruby",
     "gemAuthor": "Velo Payments API",
     "gemDescription": "This library provides a Ruby client that simplifies interactions with the Velo Payments API. For full details covering the API visit our docs at Velo Payments APIs https://apidocs.velopayments.com. Note: some of the Velo API calls which require authorization via an access token, see the full docs on how to configure.",

data/spec/api/countries_api_spec.rb

@@ -3,10 +3,10 @@
 
 ### 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. 
 
-The version of the OpenAPI document: 2.17.8
+The version of the OpenAPI document: 2.18.31
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.1-SNAPSHOT
+OpenAPI Generator version: 4.2.3-SNAPSHOT
 
 =end
 
@@ -36,13 +36,24 @@ describe 'CountriesApi' do
   # List Supported Countries
   # List the supported countries.
   # @param [Hash] opts the optional parameters
-  # @return [SupportedCountriesResponse]
+  # @return [SupportedCountriesResponse2]
   describe 'list_supported_countries test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
+  # unit tests for list_supported_countries_v1
+  # List Supported Countries
+  # List the supported countries.
+  # @param [Hash] opts the optional parameters
+  # @return [SupportedCountriesResponse]
+  describe 'list_supported_countries_v1 test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for v1_payment_channel_rules_get
   # List Payment Channel Country Rules
   # List the country specific payment channel rules.

data/spec/api/currencies_api_spec.rb

@@ -3,10 +3,10 @@
 
 ### 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. 
 
-The version of the OpenAPI document: 2.17.8
+The version of the OpenAPI document: 2.18.31
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.1-SNAPSHOT
+OpenAPI Generator version: 4.2.3-SNAPSHOT
 
 =end
 

data/spec/api/{auth_api_spec.rb → default_api_spec.rb}

@@ -3,42 +3,42 @@
 
 ### 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. 
 
-The version of the OpenAPI document: 2.17.8
+The version of the OpenAPI document: 2.18.31
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.1-SNAPSHOT
+OpenAPI Generator version: 4.2.3-SNAPSHOT
 
 =end
 
 require 'spec_helper'
 require 'json'
 
-# Unit tests for VeloPayments::AuthApi
+# Unit tests for VeloPayments::DefaultApi
 # Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
-describe 'AuthApi' do
+describe 'DefaultApi' do
   before do
     # run before each test
-    @api_instance = VeloPayments::AuthApi.new
+    @api_instance = VeloPayments::DefaultApi.new
   end
 
   after do
     # run after each test
   end
 
-  describe 'test an instance of AuthApi' do
-    it 'should create an instance of AuthApi' do
-      expect(@api_instance).to be_instance_of(VeloPayments::AuthApi)
+  describe 'test an instance of DefaultApi' do
+    it 'should create an instance of DefaultApi' do
+      expect(@api_instance).to be_instance_of(VeloPayments::DefaultApi)
     end
   end
 
-  # unit tests for velo_auth
-  # Authentication endpoint
-  # Use this endpoint to obtain an access token for calling Velo Payments APIs. Use HTTP Basic Auth. String value of Basic and a Base64 endcoded string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret  (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. Basic 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 
+  # unit tests for create_funding_account
+  # Create Funding Account
+  # Create Funding Account
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :grant_type OAuth grant type. Should use 'client_credentials'
-  # @return [AuthResponse]
-  describe 'velo_auth test' do
+  # @option opts [CreateFundingAccountRequest] :create_funding_account_request 
+  # @return [nil]
+  describe 'create_funding_account test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end

data/spec/api/funding_manager_api_spec.rb

@@ -3,10 +3,10 @@
 
 ### 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. 
 
-The version of the OpenAPI document: 2.17.8
+The version of the OpenAPI document: 2.18.31
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.1-SNAPSHOT
+OpenAPI Generator version: 4.2.3-SNAPSHOT
 
 =end
 
@@ -34,7 +34,7 @@ describe 'FundingManagerApi' do
 
   # unit tests for create_ach_funding_request
   # Create Funding Request
-  # Instruct a funding request to transfer funds from the payor’s funding bank to the payor’s balance held within Velo  (202 - accepted, 400 - invalid request body, 404 - source account not found).
+  # Instruct a funding request to transfer funds from the payor’s funding bank to the payor’s balance held within Velo.
   # @param source_account_id Source account id
   # @param funding_request_v1 Body to included ammount to be funded
   # @param [Hash] opts the optional parameters
@@ -58,7 +58,37 @@ describe 'FundingManagerApi' do
     end
   end
 
-  # unit tests for get_fundings
+  # unit tests for get_funding_account
+  # Get Funding Account
+  # Get Funding Account by ID
+  # @param funding_account_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :sensitive 
+  # @return [FundingAccountResponse]
+  describe 'get_funding_account test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_funding_accounts
+  # Get Funding Accounts
+  # Get the source accounts.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :payor_id 
+  # @option opts [String] :source_account_id 
+  # @option opts [Integer] :page Page number. Default is 1.
+  # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
+  # @option opts [String] :sort 
+  # @option opts [Boolean] :sensitive 
+  # @return [ListFundingAccountsResponse]
+  describe 'get_funding_accounts test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_fundings_v1
   # Get Fundings for Payor
   # Get a list of Fundings for a payor. 
   # @param [Hash] opts the optional parameters
@@ -67,7 +97,7 @@ describe 'FundingManagerApi' do
   # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
   # @option opts [String] :sort List of sort fields. Example: ```?sort=destinationCurrency:asc,destinationAmount:asc``` Default is no sort. The supported sort fields are: dateTime and amount. 
   # @return [GetFundingsResponse]
-  describe 'get_fundings test' do
+  describe 'get_fundings_v1 test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
@@ -130,14 +160,14 @@ describe 'FundingManagerApi' do
   end
 
   # unit tests for list_funding_audit_deltas
-  # List Funding changes
-  # Get a paginated response listing funding changes.
-  # @param payor_id The Payor ID to find associated funding records
-  # @param updated_since The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
+  # Get Funding Audit Delta
+  # Get funding audit deltas for a payor
+  # @param payor_id 
+  # @param updated_since 
   # @param [Hash] opts the optional parameters
   # @option opts [Integer] :page Page number. Default is 1.
-  # @option opts [Integer] :page_size Page size. Default is 100. Max allowable is 1000.
-  # @return [FundingDeltaResponse]
+  # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
+  # @return [PageResourceFundingPayorStatusAuditResponseFundingPayorStatusAuditResponse]
   describe 'list_funding_audit_deltas test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -157,4 +187,17 @@ describe 'FundingManagerApi' do
     end
   end
 
+  # unit tests for transfer_funds
+  # Transfer Funds between source accounts
+  # Transfer funds between source accounts for a Payor. The 'from' source account is identified in the URL, and is the account which will be debited. The 'to' (destination) source account is in the body, and is the account which will be credited. Both source accounts must belong to the same Payor. There must be sufficient balance in the 'from' source account, otherwise the transfer attempt will fail.
+  # @param source_account_id The 'from' source account id, which will be debited
+  # @param transfer_request Body
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'transfer_funds test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end

data/spec/api/get_payout_api_spec.rb

@@ -3,10 +3,10 @@
 
 ### 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. 
 
-The version of the OpenAPI document: 2.17.8
+The version of the OpenAPI document: 2.18.31
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.1-SNAPSHOT
+OpenAPI Generator version: 4.2.3-SNAPSHOT
 
 =end
 
@@ -32,13 +32,13 @@ describe 'GetPayoutApi' do
     end
   end
 
-  # unit tests for v3_payouts_payout_id_get
+  # unit tests for get_payout_summary_v3
   # Get Payout Summary
   # Get payout summary - returns the current state of the payout.
   # @param payout_id Id of the payout
   # @param [Hash] opts the optional parameters
   # @return [PayoutSummaryResponse]
-  describe 'v3_payouts_payout_id_get test' do
+  describe 'get_payout_summary_v3 test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end

data/spec/api/instruct_payout_api_spec.rb

@@ -3,10 +3,10 @@
 
 ### 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. 
 
-The version of the OpenAPI document: 2.17.8
+The version of the OpenAPI document: 2.18.31
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.1-SNAPSHOT
+OpenAPI Generator version: 4.2.3-SNAPSHOT
 
 =end
 
@@ -32,13 +32,13 @@ describe 'InstructPayoutApi' do
     end
   end
 
-  # unit tests for v3_payouts_payout_id_post
+  # unit tests for instruct_payout_v3
   # Instruct Payout
   # Instruct a payout to be made for the specified payoutId.
   # @param payout_id Id of the payout
   # @param [Hash] opts the optional parameters
   # @return [nil]
-  describe 'v3_payouts_payout_id_post test' do
+  describe 'instruct_payout_v3 test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end

data/spec/api/login_api_spec.rb

@@ -0,0 +1,82 @@
+=begin
+#Velo Payments APIs
+
+### 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. 
+
+The version of the OpenAPI document: 2.18.31
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.3-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for VeloPayments::LoginApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'LoginApi' do
+  before do
+    # run before each test
+    @api_instance = VeloPayments::LoginApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of LoginApi' do
+    it 'should create an instance of LoginApi' do
+      expect(@api_instance).to be_instance_of(VeloPayments::LoginApi)
+    end
+  end
+
+  # unit tests for logout
+  # Logout
+  # <p>Given a valid access token in the header then log out the authenticated user or client </p> <p>Will revoke the token</p> 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'logout test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for reset_password
+  # Reset password
+  # <p>Reset password </p> <p>An email with an embedded link will be sent to the receipient of the email address </p> <p>The link will contain a token to be used for resetting the password </p> 
+  # @param reset_password_request An Email address to send the reset password link to
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'reset_password test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for validate_access_token
+  # validate
+  # <p>The second part of login involves validating using an MFA device</p> <p>An access token with PRE_AUTH authorities is required</p> 
+  # @param access_token_validation_request An OTP from the user's registered MFA Device 
+  # @param [Hash] opts the optional parameters
+  # @return [AccessTokenResponse]
+  describe 'validate_access_token test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for velo_auth
+  # Authentication endpoint
+  # Use this endpoint to obtain an access token for calling Velo Payments APIs. Use HTTP Basic Auth. String value of Basic and a Base64 endcoded string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret  (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. Basic 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :grant_type OAuth grant type. Should use 'client_credentials'
+  # @return [AuthResponse]
+  describe 'velo_auth test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end