velopayments 2.18.113 → 2.23.78.beta1

data/specs/api/payors_api_spec.rb

@@ -0,0 +1,171 @@
+=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.22.122
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.0.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for VeloPayments::PayorsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PayorsApi' do
+  before do
+    # run before each test
+    if ENV['APITOKEN'] == ""
+      VeloPayments.configure do |config|
+        config.username = ENV['KEY']
+        config.password =  ENV['SECRET']
+      end
+      
+      api_instance = VeloPayments::LoginApi.new
+      opts = {
+        grant_type: 'client_credentials'
+      }
+      
+      begin
+        res = api_instance.velo_auth(opts)
+
+        ENV['APITOKEN'] = res.access_token
+      rescue VeloPayments::ApiError => e
+        puts "Exception when calling LoginApi->velo_auth: #{e}"
+      end
+    end
+
+    uri = URI.parse(ENV['APIURL'])
+    VeloPayments.configure do |config|
+      config.access_token = ENV['APITOKEN']
+      config.host = uri.host
+    end
+
+    @api_instance = VeloPayments::PayorsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PayorsApi' do
+    it 'should create an instance of PayorsApi' do
+      expect(@api_instance).to be_instance_of(VeloPayments::PayorsApi)
+    end
+  end
+
+  # unit tests for get_payor_by_id
+  # Get Payor
+  # Get a Single Payor by Id. 
+  # @param payor_id The Payor Id
+  # @param [Hash] opts the optional parameters
+  # @return [PayorV1]
+  describe 'get_payor_by_id test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_payor_by_id_v2
+  # Get Payor
+  # Get a Single Payor by Id. 
+  # @param payor_id The Payor Id
+  # @param [Hash] opts the optional parameters
+  # @return [PayorV2]
+  describe 'get_payor_by_id_v2 test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for payor_add_payor_logo
+  # Add Logo
+  # Add Payor Logo. Logo file is used in your branding, and emails sent to payees.
+  # @param payor_id The Payor Id
+  # @param [Hash] opts the optional parameters
+  # @option opts [File] :logo 
+  # @return [nil]
+  describe 'payor_add_payor_logo test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for payor_create_api_key_request
+  # Create API Key
+  # Create an an API key for the given payor Id and application Id
+  # @param payor_id The Payor Id
+  # @param application_id Application ID
+  # @param payor_create_api_key_request Details of application API key to create
+  # @param [Hash] opts the optional parameters
+  # @return [PayorCreateApiKeyResponse]
+  describe 'payor_create_api_key_request test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for payor_create_application_request
+  # Create Application
+  # Create an application for the given Payor ID. Applications are programatic users which can be assigned unique keys.
+  # @param payor_id The Payor Id
+  # @param payor_create_application_request Details of application to create
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'payor_create_application_request test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for payor_email_opt_out
+  # Reminder Email Opt-Out
+  # Update the emailRemindersOptOut field for a Payor. This API can be used to opt out or opt into Payor Reminder emails. These emails are typically around payee events such as payees registering and onboarding. 
+  # @param payor_id The Payor Id
+  # @param payor_email_opt_out_request Reminder Emails Opt-Out Request
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'payor_email_opt_out test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for payor_get_branding
+  # Get Branding
+  # Get the payor branding details.
+  # @param payor_id The Payor Id
+  # @param [Hash] opts the optional parameters
+  # @return [PayorBrandingResponse]
+  describe 'payor_get_branding test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for payor_links
+  # List Payor Links
+  # This endpoint allows you to list payor links
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :descendants_of_payor The Payor ID from which to start the query to show all descendants
+  # @option opts [String] :parent_of_payor Look for the parent payor details for this payor id
+  # @option opts [String] :fields List of additional Payor fields to include in the response for each Payor. The values of payorId and payorName and always included for each Payor - 'fields' allows you to add to this. Example: ```fields=primaryContactEmail,kycState``` - will include payorId+payorName+primaryContactEmail+kycState for each Payor Default if not specified is to include only payorId and payorName. The supported fields are any combination of: primaryContactEmail,kycState 
+  # @return [PayorLinksResponse]
+  describe 'payor_links test' do
+    it 'should work' do
+      opts = {
+        descendants_of_payor: ENV['PAYOR'], # String | The Payor ID from which to start the query to show all descendants
+        parent_of_payor: nil, # String | Look for the parent payor details for this payor id
+        fields: nil # String | List of additional Payor fields to include in the response for each Payor. The values of payorId and payorName and always included for each Payor - 'fields' allows you to add to this. Example: ```fields=primaryContactEmail,kycState``` - will include payorId+payorName+primaryContactEmail+kycState for each Payor Default if not specified is to include only payorId and payorName. The supported fields are any combination of: primaryContactEmail,kycState 
+      }
+      res = @api_instance.payor_links(opts)
+      expect(res.payors.length()).to be >= 0
+      expect(@api_instance).to respond_to(:payor_links) 
+    end
+  end
+
+end

data/{spec/api/instruct_payout_api_spec.rb → specs/api/payors_private_api_spec.rb}

@@ -3,43 +3,43 @@
 
 ### 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.113
+The version of the OpenAPI document: 2.22.122
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.1-SNAPSHOT
+OpenAPI Generator version: 5.0.0-SNAPSHOT
 
 =end
 
 require 'spec_helper'
 require 'json'
 
-# Unit tests for VeloPayments::InstructPayoutApi
+# Unit tests for VeloPayments::PayorsPrivateApi
 # Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
-describe 'InstructPayoutApi' do
+describe 'PayorsPrivateApi' do
   before do
     # run before each test
-    @api_instance = VeloPayments::InstructPayoutApi.new
+    @api_instance = VeloPayments::PayorsPrivateApi.new
   end
 
   after do
     # run after each test
   end
 
-  describe 'test an instance of InstructPayoutApi' do
-    it 'should create an instance of InstructPayoutApi' do
-      expect(@api_instance).to be_instance_of(VeloPayments::InstructPayoutApi)
+  describe 'test an instance of PayorsPrivateApi' do
+    it 'should create an instance of PayorsPrivateApi' do
+      expect(@api_instance).to be_instance_of(VeloPayments::PayorsPrivateApi)
     end
   end
 
-  # 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
+  # unit tests for create_payor_links
+  # Create a Payor Link
+  # This endpoint allows you to create a payor link.
+  # @param create_payor_link_request Request to create a payor link
   # @param [Hash] opts the optional parameters
   # @return [nil]
-  describe 'instruct_payout_v3 test' do
-    it 'should work' do
+  describe 'create_payor_links test' do
+    skip "skipping test" do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end

data/specs/api/payout_service_api_spec.rb

@@ -0,0 +1,127 @@
+=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.22.122
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.0.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for VeloPayments::PayoutServiceApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PayoutServiceApi' do
+  before do
+    # run before each test
+    @api_instance = VeloPayments::PayoutServiceApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PayoutServiceApi' do
+    it 'should create an instance of PayoutServiceApi' do
+      expect(@api_instance).to be_instance_of(VeloPayments::PayoutServiceApi)
+    end
+  end
+
+  # unit tests for create_quote_for_payout_v3
+  # Create a quote for the payout
+  # Create quote for a payout
+  # @param payout_id Id of the payout
+  # @param [Hash] opts the optional parameters
+  # @return [QuoteResponseV3]
+  describe 'create_quote_for_payout_v3 test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_payments_for_payout_v3
+  # Retrieve payments for a payout
+  # Retrieve payments for a payout
+  # @param payout_id Id of the payout
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :status Payment Status * ACCEPTED: any payment which was accepted at submission time (status may have changed since) * REJECTED: any payment rejected by initial submission processing * WITHDRAWN: any payment which has been withdrawn * WITHDRAWABLE: any payment eligible for withdrawal 
+  # @option opts [String] :remote_id The remote id of the payees.
+  # @option opts [String] :payor_payment_id Payor's Id of the Payment
+  # @option opts [String] :source_account_name Physical Account Name
+  # @option opts [String] :payment_memo Payment Memo of the Payment
+  # @option opts [Integer] :page_size The number of results to return in a page
+  # @option opts [Integer] :page Page number. Default is 1.
+  # @return [PagedPaymentsResponseV3]
+  describe 'get_payments_for_payout_v3 test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # 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 [PayoutSummaryResponseV3]
+  describe 'get_payout_summary_v3 test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # 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 'instruct_payout_v3 test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for submit_payout_v3
+  # Submit Payout
+  # <p>Create a new payout and return a location header with a link to get the payout.</p> <p>Basic validation of the payout is performed before returning but more comprehensive validation is done asynchronously.</p> <p>The results can be obtained by issuing a HTTP GET to the URL returned in the location header.</p> <p>**NOTE:** amount values in payments must be in 'minor units' format. E.g. cents for USD, pence for GBP etc.</p>  with no decimal places. 
+  # @param create_payout_request_v3 Post amount to transfer using stored funding account details.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'submit_payout_v3 test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for withdraw_payment
+  # Withdraw a Payment
+  # <p>withdraw a payment </p> <p>There are a variety of reasons why this can fail</p> <ul>     <li>the payment must be in a state of 'accepted' or 'unfunded'</li>     <li>the payout must not be in a state of 'instructed'</li> </ul> 
+  # @param payment_id Id of the Payment
+  # @param withdraw_payment_request details for withdrawal
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'withdraw_payment test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for withdraw_payout_v3
+  # Withdraw Payout
+  # Withdraw Payout will delete payout details from payout service and rails services but will just move the status of the payout to WITHDRAWN in payment audit.
+  # @param payout_id Id of the payout
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'withdraw_payout_v3 test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/{spec/api/quote_payout_api_spec.rb → specs/api/tokens_api_spec.rb}

@@ -3,43 +3,44 @@
 
 ### 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.113
+The version of the OpenAPI document: 2.22.122
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.1-SNAPSHOT
+OpenAPI Generator version: 5.0.0-SNAPSHOT
 
 =end
 
 require 'spec_helper'
 require 'json'
 
-# Unit tests for VeloPayments::QuotePayoutApi
+# Unit tests for VeloPayments::TokensApi
 # Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
-describe 'QuotePayoutApi' do
+describe 'TokensApi' do
   before do
     # run before each test
-    @api_instance = VeloPayments::QuotePayoutApi.new
+    @api_instance = VeloPayments::TokensApi.new
   end
 
   after do
     # run after each test
   end
 
-  describe 'test an instance of QuotePayoutApi' do
-    it 'should create an instance of QuotePayoutApi' do
-      expect(@api_instance).to be_instance_of(VeloPayments::QuotePayoutApi)
+  describe 'test an instance of TokensApi' do
+    it 'should create an instance of TokensApi' do
+      expect(@api_instance).to be_instance_of(VeloPayments::TokensApi)
     end
   end
 
-  # unit tests for v3_payouts_payout_id_quote_post
-  # Create a quote for the payout
-  # Create quote for a payout
-  # @param payout_id Id of the payout
+  # unit tests for resend_token
+  # Resend a token
+  # <p>Resend the specified token </p> <p>The token to resend must already exist for the user </p> <p>It will be revoked and a new one issued</p> 
+  # @param user_id The UUID of the User.
+  # @param resend_token_request The type of token to resend
   # @param [Hash] opts the optional parameters
-  # @return [QuoteResponse]
-  describe 'v3_payouts_payout_id_quote_post test' do
-    it 'should work' do
+  # @return [nil]
+  describe 'resend_token test' do
+    skip "skipping test" do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end

data/specs/api/users_api_spec.rb

@@ -0,0 +1,284 @@
+=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.22.122
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.0.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for VeloPayments::UsersApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'UsersApi' do
+  before do
+    # run before each test
+    if ENV['APITOKEN'] == ""
+      VeloPayments.configure do |config|
+        config.username = ENV['KEY']
+        config.password =  ENV['SECRET']
+      end
+      
+      api_instance = VeloPayments::LoginApi.new
+      opts = {
+        grant_type: 'client_credentials'
+      }
+      
+      begin
+        res = api_instance.velo_auth(opts)
+
+        ENV['APITOKEN'] = res.access_token
+      rescue VeloPayments::ApiError => e
+        puts "Exception when calling LoginApi->velo_auth: #{e}"
+      end
+    end
+
+    uri = URI.parse(ENV['APIURL'])
+    VeloPayments.configure do |config|
+      config.access_token = ENV['APITOKEN']
+      config.host = uri.host
+    end
+
+    @api_instance = VeloPayments::UsersApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of UsersApi' do
+    it 'should create an instance of UsersApi' do
+      expect(@api_instance).to be_instance_of(VeloPayments::UsersApi)
+    end
+  end
+
+  # unit tests for delete_user_by_id_v2
+  # Delete a User
+  # Delete User by Id. 
+  # @param user_id The UUID of the User.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_user_by_id_v2 test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for disable_user_v2
+  # Disable a User
+  # <p>If a user is enabled this endpoint will disable them </p> <p>The invoker must have the appropriate permission </p> <p>A user cannot disable themself </p> <p>When a user is disabled any active access tokens will be revoked and the user will not be able to log in</p> 
+  # @param user_id The UUID of the User.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'disable_user_v2 test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for enable_user_v2
+  # Enable a User
+  # <p>If a user has been disabled this endpoints will enable them </p> <p>The invoker must have the appropriate permission </p> <p>A user cannot enable themself </p> <p>If the user is a payor user and the payor is disabled this operation is not allowed</p> <p>If enabling a payor user would breach the limit for master admin payor users the request will be rejected </p> 
+  # @param user_id The UUID of the User.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'enable_user_v2 test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_self
+  # Get Self
+  # Get the user's details 
+  # @param [Hash] opts the optional parameters
+  # @return [UserResponse]
+  describe 'get_self test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_user_by_id_v2
+  # Get User
+  # Get a Single User by Id. 
+  # @param user_id The UUID of the User.
+  # @param [Hash] opts the optional parameters
+  # @return [UserResponse]
+  describe 'get_user_by_id_v2 test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for invite_user
+  # Invite a User
+  # Create a User and invite them to the system 
+  # @param invite_user_request Details of User to invite
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'invite_user test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for list_users
+  # List Users
+  # Get a paginated response listing the Users
+  # @param [Hash] opts the optional parameters
+  # @option opts [UserType] :type The Type of the User.
+  # @option opts [UserStatus] :status The status of the User.
+  # @option opts [String] :entity_id The entityId of the User.
+  # @option opts [Integer] :page Page number. Default is 1.
+  # @option opts [Integer] :page_size The number of results to return in a page
+  # @option opts [String] :sort List of sort fields (e.g. ?sort=email:asc,lastName:asc) Default is email:asc 'name' The supported sort fields are - email, lastNmae. 
+  # @return [PagedUserResponse]
+  describe 'list_users test' do
+    skip "skipping test" do
+    # it 'should work' do
+    #   opts = {
+    #     type: nil, # VeloPayments::UserType.new, # UserType | The Type of the User.
+    #     status: nil, # VeloPayments::UserStatus.new, # UserStatus | The status of the User.
+    #     entity_id: ENV['PAYOR'], # String | The entityId of the User.
+    #     page: 1, # Integer | Page number. Default is 1.
+    #     page_size: 25, # Integer | The number of results to return in a page
+    #     sort: 'email:asc' # String | List of sort fields (e.g. ?sort=email:asc,lastName:asc) Default is email:asc 'name' The supported sort fields are - email, lastNmae. 
+    #   }
+    #   res = @api_instance.list_users(opts)
+    #   expect(res.payors.length()).to be >= 0
+    #   expect(@api_instance).to respond_to(:list_users) 
+    end
+  end
+
+  # unit tests for register_sms
+  # Register SMS Number
+  # <p>Register an Sms number and send an OTP to it </p> <p>Used for manual verification of a user </p> <p>The backoffice user initiates the request to send the OTP to the user's sms </p> <p>The user then reads back the OTP which the backoffice user enters in the verifactionCode property for requests that require it</p> 
+  # @param register_sms_request a SMS Number to send an OTP to
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'register_sms test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for resend_token
+  # Resend a token
+  # <p>Resend the specified token </p> <p>The token to resend must already exist for the user </p> <p>It will be revoked and a new one issued</p> 
+  # @param user_id The UUID of the User.
+  # @param resend_token_request The type of token to resend
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'resend_token test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for role_update
+  # Update User Role
+  # <p>Update the user's Role</p> 
+  # @param user_id The UUID of the User.
+  # @param role_update_request The Role to change to
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'role_update test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for unlock_user_v2
+  # Unlock a User
+  # If a user is locked this endpoint will unlock them 
+  # @param user_id The UUID of the User.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'unlock_user_v2 test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for unregister_mfa
+  # Unregister MFA for the user
+  # <p>Unregister the MFA device for the user </p> <p>If the user does not require further verification then a register new MFA device token will be sent to them via their email address</p> 
+  # @param user_id The UUID of the User.
+  # @param unregister_mfa_request The MFA Type to unregister
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'unregister_mfa test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for unregister_mfa_for_self
+  # Unregister MFA for Self
+  # <p>Unregister the MFA device for the user </p> <p>If the user does not require further verification then a register new MFA device token will be sent to them via their email address</p> 
+  # @param self_mfa_type_unregister_request The MFA Type to unregister
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'unregister_mfa_for_self test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_password_self
+  # Update Password for self
+  # Update password for self 
+  # @param self_update_password_request The password
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'update_password_self test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for user_details_update
+  # Update User Details
+  # <p>Update the profile details for the given user</p> <p>When updating Payor users with the role of payor.master_admin a verificationCode is required</p> 
+  # @param user_id The UUID of the User.
+  # @param user_details_update_request The details of the user to update
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'user_details_update test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for user_details_update_for_self
+  # Update User Details for self
+  # <p>Update the profile details for the given user</p> <p>Only Payee user types are supported</p> 
+  # @param payee_user_self_update_request The details of the user to update
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'user_details_update_for_self test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for validate_password_self
+  # Validate the proposed password
+  # validate the password and return a score 
+  # @param password_request The password
+  # @param [Hash] opts the optional parameters
+  # @return [ValidatePasswordResponse]
+  describe 'validate_password_self test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end