velopayments 2.20.29.beta1 → 2.29.128.beta1

data/spec/api/{payout_history_api_spec.rb → payment_audit_service_deprecated_api_spec.rb}

@@ -3,62 +3,80 @@
 
 ### 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.20.29
+The version of the OpenAPI document: 2.29.128
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.0-SNAPSHOT
+OpenAPI Generator version: 6.0.0-SNAPSHOT
 
 =end
 
 require 'spec_helper'
 require 'json'
 
-# Unit tests for VeloPayments::PayoutHistoryApi
+# Unit tests for VeloPayments::PaymentAuditServiceDeprecatedApi
 # Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
-describe 'PayoutHistoryApi' do
+describe 'PaymentAuditServiceDeprecatedApi' do
   before do
     # run before each test
-    @api_instance = VeloPayments::PayoutHistoryApi.new
+    @api_instance = VeloPayments::PaymentAuditServiceDeprecatedApi.new
   end
 
   after do
     # run after each test
   end
 
-  describe 'test an instance of PayoutHistoryApi' do
-    it 'should create an instance of PayoutHistoryApi' do
-      expect(@api_instance).to be_instance_of(VeloPayments::PayoutHistoryApi)
+  describe 'test an instance of PaymentAuditServiceDeprecatedApi' do
+    it 'should create an instance of PaymentAuditServiceDeprecatedApi' do
+      expect(@api_instance).to be_instance_of(VeloPayments::PaymentAuditServiceDeprecatedApi)
     end
   end
 
-  # unit tests for get_payments_for_payout
-  # Get Payments for Payout
-  # Get List of payments for Payout 
-  # @param payout_id The id (UUID) of the payout.
+  # unit tests for export_transactions_csvv3
+  # V3 Export Transactions
+  # Deprecated (use /v4/paymentaudit/transactions instead)
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :payor_id The Payor ID for whom you wish to run the report. For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor. 
+  # @option opts [Date] :start_date Start date, inclusive. Format is YYYY-MM-DD
+  # @option opts [Date] :end_date End date, inclusive. Format is YYYY-MM-DD
+  # @return [PayorAmlTransactionV3]
+  describe 'export_transactions_csvv3 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
+  # V1 Get Fundings for Payor
+  # Deprecated (use /v4/paymentaudit/fundings)
+  # @param payor_id The account owner Payor ID
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :remote_id The remote id of the payees.
-  # @option opts [String] :status Payment Status
-  # @option opts [Integer] :source_amount_from The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom
-  # @option opts [Integer] :source_amount_to The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo
-  # @option opts [Integer] :payment_amount_from The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom
-  # @option opts [Integer] :payment_amount_to The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo
-  # @option opts [Date] :submitted_date_from The submitted date from range filter. Format is yyyy-MM-dd.
-  # @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
   # @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 List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status 
+  # @option opts [Integer] :page_size The number of results to return in a page
+  # @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_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 get_payment_details_v3
+  # V3 Get Payment
+  # Deprecated (use /v4/paymentaudit/payments/<paymentId> instead)
+  # @param payment_id Payment Id
+  # @param [Hash] opts the optional parameters
   # @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values. 
-  # @return [GetPaymentsForPayoutResponseV3]
-  describe 'get_payments_for_payout test' do
+  # @return [PaymentResponseV3]
+  describe 'get_payment_details_v3 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_payments_for_payout_v4
-  # Get Payments for Payout
-  # Get List of payments for Payout, allowing for RETURNED status 
+  # unit tests for get_payments_for_payout_pav3
+  # V3 Get Payments for Payout
+  # Deprecated (use /v4/paymentaudit/payouts/<payoutId> instead)
   # @param payout_id The id (UUID) of the payout.
   # @param [Hash] opts the optional parameters
   # @option opts [String] :remote_id The remote id of the payees.
@@ -70,19 +88,19 @@ describe 'PayoutHistoryApi' do
   # @option opts [Date] :submitted_date_from The submitted date from range filter. Format is yyyy-MM-dd.
   # @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
   # @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 List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status 
+  # @option opts [Integer] :page_size The number of results to return in a page
+  # @option opts [String] :sort <p>List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId</p> <p>The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status</p> 
   # @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values. 
-  # @return [GetPaymentsForPayoutResponseV4]
-  describe 'get_payments_for_payout_v4 test' do
+  # @return [GetPaymentsForPayoutResponseV3]
+  describe 'get_payments_for_payout_pav3 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_payout_stats_v1
-  # Get Payout Statistics
-  # Get payout statistics for a payor.
+  # V1 Get Payout Statistics
+  # Deprecated (Use /v4/paymentaudit/payoutStatistics)
   # @param [Hash] opts the optional parameters
   # @option opts [String] :payor_id The account owner Payor ID. Required for external users.
   # @return [GetPayoutStatistics]
@@ -92,4 +110,68 @@ describe 'PayoutHistoryApi' do
     end
   end
 
+  # unit tests for get_payouts_for_payor_v3
+  # V3 Get Payouts for Payor
+  # Deprecated (use /v4/paymentaudit/payouts instead)
+  # @param payor_id The account owner Payor ID
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :payout_memo Payout Memo filter - case insensitive sub-string match
+  # @option opts [String] :status Payout Status
+  # @option opts [Date] :submitted_date_from The submitted date from range filter. Format is yyyy-MM-dd.
+  # @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
+  # @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=submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status. 
+  # @return [GetPayoutsResponseV3]
+  describe 'get_payouts_for_payor_v3 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_payment_changes
+  # V1 List Payment Changes
+  # Deprecated (use /v4/payments/deltas instead)
+  # @param payor_id The Payor ID to find associated Payments
+  # @param updated_since The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number. Default is 1.
+  # @option opts [Integer] :page_size The number of results to return in a page
+  # @return [PaymentDeltaResponseV1]
+  describe 'list_payment_changes 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_payments_audit_v3
+  # V3 Get List of Payments
+  # Deprecated (use /v4/paymentaudit/payments instead)
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :payee_id The UUID of the payee.
+  # @option opts [String] :payor_id The account owner Payor Id. Required for external users.
+  # @option opts [String] :payor_name The payor’s name. This filters via a case insensitive substring match.
+  # @option opts [String] :remote_id The remote id of the payees.
+  # @option opts [String] :status Payment Status
+  # @option opts [String] :source_account_name The source account name filter. This filters via a case insensitive substring match.
+  # @option opts [Integer] :source_amount_from The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom
+  # @option opts [Integer] :source_amount_to The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo
+  # @option opts [String] :source_currency The source currency filter. Filters based on an exact match on the currency.
+  # @option opts [Integer] :payment_amount_from The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom
+  # @option opts [Integer] :payment_amount_to The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo
+  # @option opts [String] :payment_currency The payment currency filter. Filters based on an exact match on the currency.
+  # @option opts [Date] :submitted_date_from The submitted date from range filter. Format is yyyy-MM-dd.
+  # @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
+  # @option opts [String] :payment_memo The payment memo filter. This filters via a case insensitive substring match.
+  # @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=submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status 
+  # @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values. 
+  # @return [ListPaymentsResponseV3]
+  describe 'list_payments_audit_v3 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/payors_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.20.29
+The version of the OpenAPI document: 2.29.128
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.0-SNAPSHOT
+OpenAPI Generator version: 6.0.0-SNAPSHOT
 
 =end
 
@@ -35,7 +35,7 @@ describe 'PayorsApi' do
   # unit tests for get_payor_by_id
   # Get Payor
   # Get a Single Payor by Id. 
-  # @param payor_id The account owner Payor ID
+  # @param payor_id The Payor Id
   # @param [Hash] opts the optional parameters
   # @return [PayorV1]
   describe 'get_payor_by_id test' do
@@ -47,7 +47,7 @@ describe 'PayorsApi' do
   # unit tests for get_payor_by_id_v2
   # Get Payor
   # Get a Single Payor by Id. 
-  # @param payor_id The account owner Payor ID
+  # @param payor_id The Payor Id
   # @param [Hash] opts the optional parameters
   # @return [PayorV2]
   describe 'get_payor_by_id_v2 test' do
@@ -59,7 +59,7 @@ describe 'PayorsApi' do
   # 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 account owner Payor ID
+  # @param payor_id The Payor Id
   # @param [Hash] opts the optional parameters
   # @option opts [File] :logo 
   # @return [nil]
@@ -72,7 +72,7 @@ describe 'PayorsApi' do
   # 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 account owner Payor 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
@@ -86,7 +86,7 @@ describe 'PayorsApi' do
   # 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 account owner Payor ID
+  # @param payor_id The Payor Id
   # @param payor_create_application_request Details of application to create
   # @param [Hash] opts the optional parameters
   # @return [nil]
@@ -99,7 +99,7 @@ describe 'PayorsApi' do
   # 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 account owner Payor ID
+  # @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]
@@ -112,7 +112,7 @@ describe 'PayorsApi' do
   # unit tests for payor_get_branding
   # Get Branding
   # Get the payor branding details.
-  # @param payor_id The account owner Payor ID
+  # @param payor_id The Payor Id
   # @param [Hash] opts the optional parameters
   # @return [PayorBrandingResponse]
   describe 'payor_get_branding test' do

data/spec/api/payors_private_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.20.29
+The version of the OpenAPI document: 2.29.128
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.0-SNAPSHOT
+OpenAPI Generator version: 6.0.0-SNAPSHOT
 
 =end
 

data/spec/api/payout_service_api_spec.rb

@@ -0,0 +1,154 @@
+=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.29.128
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.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
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for deschedule_payout
+  # Deschedule a payout
+  # Remove the schedule for a scheduled payout
+  # @param payout_id Id of the payout
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'deschedule_payout 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_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] :transmission_type Transmission Type * ACH * SAME_DAY_ACH * WIRE 
+  # @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
+    it 'should work' 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
+    it 'should work' 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
+  # @option opts [InstructPayoutRequest] :instruct_payout_request Additional instruct payout parameters
+  # @return [nil]
+  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
+  end
+
+  # unit tests for schedule_for_payout
+  # Schedule a payout
+  # <p>Schedule a payout for auto-instruction in the future or update existing payout schedule if the payout has been scheduled before.</p> 
+  # @param payout_id Id of the payout
+  # @param [Hash] opts the optional parameters
+  # @option opts [SchedulePayoutRequest] :schedule_payout_request schedule payout parameters
+  # @return [nil]
+  describe 'schedule_for_payout 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 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
+    it 'should work' 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
+    it 'should work' 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 remove the payout details from the rails but the payout will still be accessible in payout service in WITHDRAWN status.
+  # @param payout_id Id of the payout
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'withdraw_payout_v3 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/tokens_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.20.29
+The version of the OpenAPI document: 2.29.128
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.0-SNAPSHOT
+OpenAPI Generator version: 6.0.0-SNAPSHOT
 
 =end
 

data/spec/api/users_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.20.29
+The version of the OpenAPI document: 2.29.128
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.0-SNAPSHOT
+OpenAPI Generator version: 6.0.0-SNAPSHOT
 
 =end
 
@@ -72,7 +72,7 @@ describe 'UsersApi' do
   # Get Self
   # Get the user's details 
   # @param [Hash] opts the optional parameters
-  # @return [UserResponse2]
+  # @return [UserResponse]
   describe 'get_self test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -110,8 +110,9 @@ describe 'UsersApi' do
   # @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 [PayeeType] :payee_type The Type of the Payee entity. Either COMPANY or INDIVIDUAL.
   # @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 [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
@@ -188,6 +189,7 @@ describe 'UsersApi' do
   # <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
+  # @option opts [String] :authorization Bearer token authorization leg of validate
   # @return [nil]
   describe 'unregister_mfa_for_self test' do
     it 'should work' do
@@ -220,6 +222,18 @@ describe 'UsersApi' do
     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
+    it 'should work' 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