velopayments 2.29.128.beta1 → 2.35.58.beta1

data/lib/velopayments/api/users_api.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.29.128
+The version of the OpenAPI document: 2.35.58
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.0.0-SNAPSHOT
+OpenAPI Generator version: 7.1.0-SNAPSHOT
 
 =end
 
@@ -419,9 +419,9 @@ module VeloPayments
     # @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 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. 
+    # @option opts [Integer] :page Page number. Default is 1. (default to 1)
+    # @option opts [Integer] :page_size The number of results to return in a page (default to 25)
+    # @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.  (default to 'email:asc')
     # @return [Array<(PagedUserResponse, Integer, Hash)>] PagedUserResponse data, response status code and response headers
     def list_users_with_http_info(opts = {})
       if @api_client.config.debugging

data/lib/velopayments/api/webhooks_api.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.29.128
+The version of the OpenAPI document: 2.35.58
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.0.0-SNAPSHOT
+OpenAPI Generator version: 7.1.0-SNAPSHOT
 
 =end
 
@@ -162,8 +162,8 @@ module VeloPayments
     # List the details about the webhooks for the given payor.
     # @param payor_id [String] The Payor ID
     # @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
+    # @option opts [Integer] :page Page number. Default is 1. (default to 1)
+    # @option opts [Integer] :page_size The number of results to return in a page (default to 25)
     # @return [Array<(WebhooksResponse, Integer, Hash)>] WebhooksResponse data, response status code and response headers
     def list_webhooks_v1_with_http_info(payor_id, opts = {})
       if @api_client.config.debugging

data/lib/velopayments/api_client.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.29.128
+The version of the OpenAPI document: 2.35.58
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.0.0-SNAPSHOT
+OpenAPI Generator version: 7.1.0-SNAPSHOT
 
 =end
 
@@ -93,6 +93,7 @@ module VeloPayments
       header_params = @default_headers.merge(opts[:header_params] || {})
       query_params = opts[:query_params] || {}
       form_params = opts[:form_params] || {}
+      follow_location = opts[:follow_location] || true
 
       update_params_for_auth! header_params, query_params, opts[:auth_names]
 
@@ -109,7 +110,8 @@ module VeloPayments
         :ssl_verifyhost => _verify_ssl_host,
         :sslcert => @config.cert_file,
         :sslkey => @config.key_file,
-        :verbose => @config.debugging
+        :verbose => @config.debugging,
+        :followlocation => follow_location
       }
 
       # set custom cert, if provided

data/lib/velopayments/api_error.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.29.128
+The version of the OpenAPI document: 2.35.58
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.0.0-SNAPSHOT
+OpenAPI Generator version: 7.1.0-SNAPSHOT
 
 =end
 
@@ -32,6 +32,7 @@ module VeloPayments
         end
       else
         super arg
+        @message = arg
       end
     end
 

data/lib/velopayments/configuration.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.29.128
+The version of the OpenAPI document: 2.35.58
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.0.0-SNAPSHOT
+OpenAPI Generator version: 7.1.0-SNAPSHOT
 
 =end
 
@@ -62,6 +62,16 @@ module VeloPayments
     # Defines the access token (Bearer) used with OAuth2.
     attr_accessor :access_token
 
+    # Defines a Proc used to fetch or refresh access tokens (Bearer) used with OAuth2.
+    # Overrides the access_token if set
+    # @return [Proc]
+    attr_accessor :access_token_getter
+
+    # Set this to return data as binary instead of downloading a temp file. When enabled (set to true)
+    # HTTP responses with return type `File` will be returned as a stream of binary data.
+    # Default to false.
+    attr_accessor :return_binary_data
+
     # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
     # details will be logged with `logger.debug` (see the `logger` attribute).
     # Default to false.
@@ -133,6 +143,7 @@ module VeloPayments
     # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
     attr_accessor :params_encoding
 
+
     attr_accessor :inject_format
 
     attr_accessor :force_ending_format
@@ -141,7 +152,7 @@ module VeloPayments
       @scheme = 'https'
       @host = 'api.sandbox.velopayments.com'
       @base_path = ''
-      @server_index = 0
+      @server_index = nil
       @server_operation_index = {}
       @server_variables = {}
       @server_operation_variables = {}
@@ -150,10 +161,10 @@ module VeloPayments
       @client_side_validation = true
       @verify_ssl = true
       @verify_ssl_host = true
-      @params_encoding = nil
       @cert_file = nil
       @key_file = nil
       @timeout = 0
+      @params_encoding = nil
       @debugging = false
       @inject_format = false
       @force_ending_format = false
@@ -189,10 +200,12 @@ module VeloPayments
 
     # Returns base URL for specified operation based on server settings
     def base_url(operation = nil)
-      index = server_operation_index.fetch(operation, server_index)
-      return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if index == nil
-
-      server_url(index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
+      if operation_server_settings.key?(operation) then
+        index = server_operation_index.fetch(operation, server_index)
+        server_url(index.nil? ? 0 : index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
+      else
+        server_index.nil? ? "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') : server_url(server_index, server_variables, nil)
+      end
     end
 
     # Gets API key (with prefix if set).
@@ -207,6 +220,12 @@ module VeloPayments
       end
     end
 
+    # Gets access_token using access_token_getter or uses the static access_token
+    def access_token_with_refresh
+      return access_token if access_token_getter.nil?
+      access_token_getter.call
+    end
+
     # Gets Basic Auth token string
     def basic_auth_token
       'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
@@ -220,7 +239,7 @@ module VeloPayments
             type: 'oauth2',
             in: 'header',
             key: 'Authorization',
-            value: "Bearer #{access_token}"
+            value: "Bearer #{access_token_with_refresh}"
           },
         'basicAuth' =>
           {
@@ -234,7 +253,7 @@ module VeloPayments
             type: 'oauth2',
             in: 'header',
             key: 'Authorization',
-            value: "Bearer #{access_token}"
+            value: "Bearer #{access_token_with_refresh}"
           },
       }
     end
@@ -266,8 +285,8 @@ module VeloPayments
       servers = server_settings if servers == nil
 
       # check array index out of bound
-      if (index < 0 || index >= servers.size)
-        fail ArgumentError, "Invalid index #{index} when selecting the server. Must be less than #{servers.size}"
+      if (index.nil? || index < 0 || index >= servers.size)
+        fail ArgumentError, "Invalid index #{index} when selecting the server. Must not be nil and must be less than #{servers.size}"
       end
 
       server = servers[index]

data/lib/velopayments/models/accepted_payment_v3.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.29.128
+The version of the OpenAPI document: 2.35.58
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.0.0-SNAPSHOT
+OpenAPI Generator version: 7.1.0-SNAPSHOT
 
 =end
 
@@ -15,23 +15,33 @@ require 'time'
 
 module VeloPayments
   class AcceptedPaymentV3
+    # Your identifier for the payee
     attr_accessor :remote_id
 
     # Valid ISO 4217 3 letter currency code. See the <a href=\"https://www.iso.org/iso-4217-currency-codes.html\" target=\"_blank\" a>ISO specification</a> for details.
     attr_accessor :currency_type
 
+    # The amount of the payment in minor units
     attr_accessor :amount
 
+    # The identifier of the source account to debit the payment from
     attr_accessor :source_account_name
 
+    # A reference identifier for the payor for the given payee payment
     attr_accessor :payor_payment_id
 
+    # <p>Any value here will override the memo value in the parent payout</p> <p>This should be the reference field on the statement seen by the payee (but not via ACH)</p> 
     attr_accessor :payment_memo
 
+    # <p>The identifier for the remote payments system if not Velo</p> 
     attr_accessor :remote_system_id
 
+    # <p>Metadata about the payment that may be relevant to the specific rails or remote system making the payout</p> <p>The structure of the data will be dictated by the requirements of the payment rails</p> 
     attr_accessor :payment_metadata
 
+    # Indicates the 3rd party system involved in making this payment
+    attr_accessor :rails_id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -42,7 +52,8 @@ module VeloPayments
         :'payor_payment_id' => :'payorPaymentId',
         :'payment_memo' => :'paymentMemo',
         :'remote_system_id' => :'remoteSystemId',
-        :'payment_metadata' => :'paymentMetadata'
+        :'payment_metadata' => :'paymentMetadata',
+        :'rails_id' => :'railsId'
       }
     end
 
@@ -61,7 +72,8 @@ module VeloPayments
         :'payor_payment_id' => :'String',
         :'payment_memo' => :'String',
         :'remote_system_id' => :'String',
-        :'payment_metadata' => :'String'
+        :'payment_metadata' => :'String',
+        :'rails_id' => :'String'
       }
     end
 
@@ -88,22 +100,32 @@ module VeloPayments
 
       if attributes.key?(:'remote_id')
         self.remote_id = attributes[:'remote_id']
+      else
+        self.remote_id = nil
       end
 
       if attributes.key?(:'currency_type')
         self.currency_type = attributes[:'currency_type']
+      else
+        self.currency_type = nil
       end
 
       if attributes.key?(:'amount')
         self.amount = attributes[:'amount']
+      else
+        self.amount = nil
       end
 
       if attributes.key?(:'source_account_name')
         self.source_account_name = attributes[:'source_account_name']
+      else
+        self.source_account_name = nil
       end
 
       if attributes.key?(:'payor_payment_id')
         self.payor_payment_id = attributes[:'payor_payment_id']
+      else
+        self.payor_payment_id = nil
       end
 
       if attributes.key?(:'payment_memo')
@@ -117,16 +139,31 @@ module VeloPayments
       if attributes.key?(:'payment_metadata')
         self.payment_metadata = attributes[:'payment_metadata']
       end
+
+      if attributes.key?(:'rails_id')
+        self.rails_id = attributes[:'rails_id']
+      else
+        self.rails_id = nil
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
       if @remote_id.nil?
         invalid_properties.push('invalid value for "remote_id", remote_id cannot be nil.')
       end
 
+      if @remote_id.to_s.length > 100
+        invalid_properties.push('invalid value for "remote_id", the character length must be smaller than or equal to 100.')
+      end
+
+      if @remote_id.to_s.length < 1
+        invalid_properties.push('invalid value for "remote_id", the character length must be great than or equal to 1.')
+      end
+
       if @currency_type.nil?
         invalid_properties.push('invalid value for "currency_type", currency_type cannot be nil.')
       end
@@ -156,13 +193,52 @@ module VeloPayments
         invalid_properties.push('invalid value for "payor_payment_id", payor_payment_id cannot be nil.')
       end
 
+      if @payor_payment_id.to_s.length > 40
+        invalid_properties.push('invalid value for "payor_payment_id", the character length must be smaller than or equal to 40.')
+      end
+
+      if @payor_payment_id.to_s.length < 0
+        invalid_properties.push('invalid value for "payor_payment_id", the character length must be great than or equal to 0.')
+      end
+
+      if !@payment_memo.nil? && @payment_memo.to_s.length > 40
+        invalid_properties.push('invalid value for "payment_memo", the character length must be smaller than or equal to 40.')
+      end
+
+      if !@payment_memo.nil? && @payment_memo.to_s.length < 0
+        invalid_properties.push('invalid value for "payment_memo", the character length must be great than or equal to 0.')
+      end
+
+      if !@remote_system_id.nil? && @remote_system_id.to_s.length > 100
+        invalid_properties.push('invalid value for "remote_system_id", the character length must be smaller than or equal to 100.')
+      end
+
+      if !@remote_system_id.nil? && @remote_system_id.to_s.length < 1
+        invalid_properties.push('invalid value for "remote_system_id", the character length must be great than or equal to 1.')
+      end
+
+      if !@payment_metadata.nil? && @payment_metadata.to_s.length > 512
+        invalid_properties.push('invalid value for "payment_metadata", the character length must be smaller than or equal to 512.')
+      end
+
+      if !@payment_metadata.nil? && @payment_metadata.to_s.length < 0
+        invalid_properties.push('invalid value for "payment_metadata", the character length must be great than or equal to 0.')
+      end
+
+      if @rails_id.nil?
+        invalid_properties.push('invalid value for "rails_id", rails_id cannot be nil.')
+      end
+
       invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @remote_id.nil?
+      return false if @remote_id.to_s.length > 100
+      return false if @remote_id.to_s.length < 1
       return false if @currency_type.nil?
       return false if @currency_type.to_s.length > 3
       return false if @currency_type.to_s.length < 3
@@ -170,9 +246,36 @@ module VeloPayments
       return false if @amount.nil?
       return false if @source_account_name.nil?
       return false if @payor_payment_id.nil?
+      return false if @payor_payment_id.to_s.length > 40
+      return false if @payor_payment_id.to_s.length < 0
+      return false if !@payment_memo.nil? && @payment_memo.to_s.length > 40
+      return false if !@payment_memo.nil? && @payment_memo.to_s.length < 0
+      return false if !@remote_system_id.nil? && @remote_system_id.to_s.length > 100
+      return false if !@remote_system_id.nil? && @remote_system_id.to_s.length < 1
+      return false if !@payment_metadata.nil? && @payment_metadata.to_s.length > 512
+      return false if !@payment_metadata.nil? && @payment_metadata.to_s.length < 0
+      return false if @rails_id.nil?
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] remote_id Value to be assigned
+    def remote_id=(remote_id)
+      if remote_id.nil?
+        fail ArgumentError, 'remote_id cannot be nil'
+      end
+
+      if remote_id.to_s.length > 100
+        fail ArgumentError, 'invalid value for "remote_id", the character length must be smaller than or equal to 100.'
+      end
+
+      if remote_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "remote_id", the character length must be great than or equal to 1.'
+      end
+
+      @remote_id = remote_id
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] currency_type Value to be assigned
     def currency_type=(currency_type)
@@ -196,6 +299,78 @@ module VeloPayments
       @currency_type = currency_type
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] payor_payment_id Value to be assigned
+    def payor_payment_id=(payor_payment_id)
+      if payor_payment_id.nil?
+        fail ArgumentError, 'payor_payment_id cannot be nil'
+      end
+
+      if payor_payment_id.to_s.length > 40
+        fail ArgumentError, 'invalid value for "payor_payment_id", the character length must be smaller than or equal to 40.'
+      end
+
+      if payor_payment_id.to_s.length < 0
+        fail ArgumentError, 'invalid value for "payor_payment_id", the character length must be great than or equal to 0.'
+      end
+
+      @payor_payment_id = payor_payment_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] payment_memo Value to be assigned
+    def payment_memo=(payment_memo)
+      if payment_memo.nil?
+        fail ArgumentError, 'payment_memo cannot be nil'
+      end
+
+      if payment_memo.to_s.length > 40
+        fail ArgumentError, 'invalid value for "payment_memo", the character length must be smaller than or equal to 40.'
+      end
+
+      if payment_memo.to_s.length < 0
+        fail ArgumentError, 'invalid value for "payment_memo", the character length must be great than or equal to 0.'
+      end
+
+      @payment_memo = payment_memo
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] remote_system_id Value to be assigned
+    def remote_system_id=(remote_system_id)
+      if remote_system_id.nil?
+        fail ArgumentError, 'remote_system_id cannot be nil'
+      end
+
+      if remote_system_id.to_s.length > 100
+        fail ArgumentError, 'invalid value for "remote_system_id", the character length must be smaller than or equal to 100.'
+      end
+
+      if remote_system_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "remote_system_id", the character length must be great than or equal to 1.'
+      end
+
+      @remote_system_id = remote_system_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] payment_metadata Value to be assigned
+    def payment_metadata=(payment_metadata)
+      if payment_metadata.nil?
+        fail ArgumentError, 'payment_metadata cannot be nil'
+      end
+
+      if payment_metadata.to_s.length > 512
+        fail ArgumentError, 'invalid value for "payment_metadata", the character length must be smaller than or equal to 512.'
+      end
+
+      if payment_metadata.to_s.length < 0
+        fail ArgumentError, 'invalid value for "payment_metadata", the character length must be great than or equal to 0.'
+      end
+
+      @payment_metadata = payment_metadata
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -208,7 +383,8 @@ module VeloPayments
           payor_payment_id == o.payor_payment_id &&
           payment_memo == o.payment_memo &&
           remote_system_id == o.remote_system_id &&
-          payment_metadata == o.payment_metadata
+          payment_metadata == o.payment_metadata &&
+          rails_id == o.rails_id
     end
 
     # @see the `==` method
@@ -220,43 +396,37 @@ module VeloPayments
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [remote_id, currency_type, amount, source_account_name, payor_payment_id, payment_memo, remote_system_id, payment_metadata].hash
+      [remote_id, currency_type, amount, source_account_name, payor_payment_id, payment_memo, remote_system_id, payment_metadata, rails_id].hash
     end
 
     # Builds the object from hash
     # @param [Hash] attributes Model attributes in the form of hash
     # @return [Object] Returns the model itself
     def self.build_from_hash(attributes)
-      new.build_from_hash(attributes)
-    end
-
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
-      self.class.openapi_types.each_pair do |key, type|
-        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
-          self.send("#{key}=", nil)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
         elsif type =~ /\AArray<(.*)>/i
           # check to ensure the input is an array given that the attribute
           # is documented as an array but the input is not
-          if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
           end
-        elsif !attributes[self.class.attribute_map[key]].nil?
-          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
         end
       end
-
-      self
+      new(transformed_hash)
     end
 
     # Deserializes the data based on type
     # @param string type Data type
     # @param string value Value to be deserialized
     # @return [Object] Deserialized data
-    def _deserialize(type, value)
+    def self._deserialize(type, value)
       case type.to_sym
       when :Time
         Time.parse(value)