velopayments 2.11.73 → 2.14.90.pre.1

data/lib/velopayments/api/get_payout_api.rb

@@ -3,14 +3,14 @@
 
 ### 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. 
 
-OpenAPI spec version: 2.11.73
+The version of the OpenAPI document: 2.14.92
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.0.0-SNAPSHOT
+OpenAPI Generator version: 4.1.0-SNAPSHOT
 
 =end
 
-require 'uri'
+require 'cgi'
 
 module VeloPayments
   class GetPayoutApi
@@ -43,29 +43,38 @@ module VeloPayments
         fail ArgumentError, "Missing the required parameter 'payout_id' when calling GetPayoutApi.v3_payouts_payout_id_get"
       end
       # resource path
-      local_var_path = '/v3/payouts/{payoutId}'.sub('{' + 'payoutId' + '}', payout_id.to_s)
+      local_var_path = '/v3/payouts/{payoutId}'.sub('{' + 'payoutId' + '}', CGI.escape(payout_id.to_s).gsub('%2F', '/'))
 
       # query parameters
-      query_params = {}
+      query_params = opts[:query_params] || {}
 
       # header parameters
-      header_params = {}
+      header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
 
       # form parameters
-      form_params = {}
+      form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = nil
-      auth_names = ['OAuth2']
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'PayoutSummaryResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'PayoutSummaryResponse')
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: GetPayoutApi#v3_payouts_payout_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end

data/lib/velopayments/api/instruct_payout_api.rb

@@ -3,14 +3,14 @@
 
 ### 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. 
 
-OpenAPI spec version: 2.11.73
+The version of the OpenAPI document: 2.14.92
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.0.0-SNAPSHOT
+OpenAPI Generator version: 4.1.0-SNAPSHOT
 
 =end
 
-require 'uri'
+require 'cgi'
 
 module VeloPayments
   class InstructPayoutApi
@@ -43,26 +43,36 @@ module VeloPayments
         fail ArgumentError, "Missing the required parameter 'payout_id' when calling InstructPayoutApi.v3_payouts_payout_id_post"
       end
       # resource path
-      local_var_path = '/v3/payouts/{payoutId}'.sub('{' + 'payoutId' + '}', payout_id.to_s)
+      local_var_path = '/v3/payouts/{payoutId}'.sub('{' + 'payoutId' + '}', CGI.escape(payout_id.to_s).gsub('%2F', '/'))
 
       # query parameters
-      query_params = {}
+      query_params = opts[:query_params] || {}
 
       # header parameters
-      header_params = {}
+      header_params = opts[:header_params] || {}
 
       # form parameters
-      form_params = {}
+      form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = nil
-      auth_names = ['OAuth2']
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
-        :auth_names => auth_names)
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: InstructPayoutApi#v3_payouts_payout_id_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end

data/lib/velopayments/api/payee_invitation_api.rb

@@ -3,14 +3,14 @@
 
 ### 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. 
 
-OpenAPI spec version: 2.11.73
+The version of the OpenAPI document: 2.14.92
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.0.0-SNAPSHOT
+OpenAPI Generator version: 4.1.0-SNAPSHOT
 
 =end
 
-require 'uri'
+require 'cgi'
 
 module VeloPayments
   class PayeeInvitationApi
@@ -24,8 +24,8 @@ module VeloPayments
     # @param payor_id [String] The account owner Payor ID
     # @param [Hash] opts the optional parameters
     # @return [InvitationStatusResponse]
-    def get_payor(payor_id, opts = {})
-      data, _status_code, _headers = get_payor_with_http_info(payor_id, opts)
+    def get_payees_invitation_status(payor_id, opts = {})
+      data, _status_code, _headers = get_payees_invitation_status_with_http_info(payor_id, opts)
       data
     end
 
@@ -34,40 +34,123 @@ module VeloPayments
     # @param payor_id [String] The account owner Payor ID
     # @param [Hash] opts the optional parameters
     # @return [Array<(InvitationStatusResponse, Integer, Hash)>] InvitationStatusResponse data, response status code and response headers
-    def get_payor_with_http_info(payor_id, opts = {})
+    def get_payees_invitation_status_with_http_info(payor_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: PayeeInvitationApi.get_payor ...'
+        @api_client.config.logger.debug 'Calling API: PayeeInvitationApi.get_payees_invitation_status ...'
       end
       # verify the required parameter 'payor_id' is set
       if @api_client.config.client_side_validation && payor_id.nil?
-        fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayeeInvitationApi.get_payor"
+        fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayeeInvitationApi.get_payees_invitation_status"
       end
       # resource path
-      local_var_path = '/v1/payees/payors/{payorId}/invitationStatus'.sub('{' + 'payorId' + '}', payor_id.to_s)
+      local_var_path = '/v1/payees/payors/{payorId}/invitationStatus'.sub('{' + 'payorId' + '}', CGI.escape(payor_id.to_s).gsub('%2F', '/'))
 
       # query parameters
-      query_params = {}
+      query_params = opts[:query_params] || {}
 
       # header parameters
-      header_params = {}
+      header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
 
       # form parameters
-      form_params = {}
+      form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = nil
-      auth_names = ['OAuth2']
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'InvitationStatusResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'InvitationStatusResponse')
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: PayeeInvitationApi#get_payor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: PayeeInvitationApi#get_payees_invitation_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Payee Invitation Status
+    # Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date. 
+    # @param payor_id [String] The account owner Payor ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :payee_id The UUID of the payee.
+    # @option opts [InvitationStatus] :invitation_status The invitation status of the payees.
+    # @option opts [Integer] :page Page number. Default is 1. (default to 1)
+    # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25)
+    # @return [PagedPayeeInvitationStatusResponse]
+    def get_payees_invitation_status_v2(payor_id, opts = {})
+      data, _status_code, _headers = get_payees_invitation_status_v2_with_http_info(payor_id, opts)
+      data
+    end
+
+    # Get Payee Invitation Status
+    # Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date. 
+    # @param payor_id [String] The account owner Payor ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :payee_id The UUID of the payee.
+    # @option opts [InvitationStatus] :invitation_status The invitation status of the payees.
+    # @option opts [Integer] :page Page number. Default is 1.
+    # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
+    # @return [Array<(PagedPayeeInvitationStatusResponse, Integer, Hash)>] PagedPayeeInvitationStatusResponse data, response status code and response headers
+    def get_payees_invitation_status_v2_with_http_info(payor_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayeeInvitationApi.get_payees_invitation_status_v2 ...'
+      end
+      # verify the required parameter 'payor_id' is set
+      if @api_client.config.client_side_validation && payor_id.nil?
+        fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayeeInvitationApi.get_payees_invitation_status_v2"
+      end
+      # resource path
+      local_var_path = '/v2/payees/payors/{payorId}/invitationStatus'.sub('{' + 'payorId' + '}', CGI.escape(payor_id.to_s).gsub('%2F', '/'))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'payeeId'] = opts[:'payee_id'] if !opts[:'payee_id'].nil?
+      query_params[:'invitationStatus'] = opts[:'invitation_status'] if !opts[:'invitation_status'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'PagedPayeeInvitationStatusResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PayeeInvitationApi#get_payees_invitation_status_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
@@ -102,31 +185,40 @@ module VeloPayments
         fail ArgumentError, "Missing the required parameter 'invite_payee_request' when calling PayeeInvitationApi.resend_payee_invite"
       end
       # resource path
-      local_var_path = '/v1/payees/{payeeId}/invite'.sub('{' + 'payeeId' + '}', payee_id.to_s)
+      local_var_path = '/v1/payees/{payeeId}/invite'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s).gsub('%2F', '/'))
 
       # query parameters
-      query_params = {}
+      query_params = opts[:query_params] || {}
 
       # header parameters
-      header_params = {}
+      header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
 
       # form parameters
-      form_params = {}
+      form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(invite_payee_request)
-      auth_names = ['OAuth2']
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+      post_body = opts[:body] || @api_client.object_to_http_body(invite_payee_request) 
+
+      # return_type
+      return_type = opts[:return_type] || 'InvitationStatusResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'InvitationStatusResponse')
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: PayeeInvitationApi#resend_payee_invite\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -160,28 +252,37 @@ module VeloPayments
       local_var_path = '/v2/payees'
 
       # query parameters
-      query_params = {}
+      query_params = opts[:query_params] || {}
 
       # header parameters
-      header_params = {}
+      header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
 
       # form parameters
-      form_params = {}
+      form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(create_payees_request)
-      auth_names = ['OAuth2']
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+      post_body = opts[:body] || @api_client.object_to_http_body(create_payees_request) 
+
+      # return_type
+      return_type = opts[:return_type] || 'CreatePayeesCSVResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'CreatePayeesCSVResponse')
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: PayeeInvitationApi#v2_create_payee\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -212,29 +313,38 @@ module VeloPayments
         fail ArgumentError, "Missing the required parameter 'batch_id' when calling PayeeInvitationApi.v2_query_batch_status"
       end
       # resource path
-      local_var_path = '/v2/payees/batch/{batchId}'.sub('{' + 'batchId' + '}', batch_id.to_s)
+      local_var_path = '/v2/payees/batch/{batchId}'.sub('{' + 'batchId' + '}', CGI.escape(batch_id.to_s).gsub('%2F', '/'))
 
       # query parameters
-      query_params = {}
+      query_params = opts[:query_params] || {}
 
       # header parameters
-      header_params = {}
+      header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
 
       # form parameters
-      form_params = {}
+      form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = nil
-      auth_names = ['OAuth2']
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'QueryBatchResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'QueryBatchResponse')
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: PayeeInvitationApi#v2_query_batch_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end

data/lib/velopayments/api/payees_api.rb

@@ -3,14 +3,14 @@
 
 ### 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. 
 
-OpenAPI spec version: 2.11.73
+The version of the OpenAPI document: 2.14.92
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.0.0-SNAPSHOT
+OpenAPI Generator version: 4.1.0-SNAPSHOT
 
 =end
 
-require 'uri'
+require 'cgi'
 
 module VeloPayments
   class PayeesApi
@@ -43,26 +43,36 @@ module VeloPayments
         fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeesApi.delete_payee_by_id"
       end
       # resource path
-      local_var_path = '/v1/payees/{payeeId}'.sub('{' + 'payeeId' + '}', payee_id.to_s)
+      local_var_path = '/v1/payees/{payeeId}'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s).gsub('%2F', '/'))
 
       # query parameters
-      query_params = {}
+      query_params = opts[:query_params] || {}
 
       # header parameters
-      header_params = {}
+      header_params = opts[:header_params] || {}
 
       # form parameters
-      form_params = {}
+      form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = nil
-      auth_names = ['OAuth2']
-      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
-        :auth_names => auth_names)
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: PayeesApi#delete_payee_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -95,36 +105,121 @@ module VeloPayments
         fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeesApi.get_payee_by_id"
       end
       # resource path
-      local_var_path = '/v1/payees/{payeeId}'.sub('{' + 'payeeId' + '}', payee_id.to_s)
+      local_var_path = '/v1/payees/{payeeId}'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s).gsub('%2F', '/'))
 
       # query parameters
-      query_params = {}
+      query_params = opts[:query_params] || {}
       query_params[:'sensitive'] = opts[:'sensitive'] if !opts[:'sensitive'].nil?
 
       # header parameters
-      header_params = {}
+      header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
 
       # form parameters
-      form_params = {}
+      form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = nil
-      auth_names = ['OAuth2']
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'Payee' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'Payee')
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: PayeesApi#get_payee_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
+    # List Payee Changes
+    # Get a paginated response listing payee changes.
+    # @param payor_id [String] The Payor ID to find associated Payees
+    # @param updated_since [DateTime] 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. (default to 1)
+    # @option opts [Integer] :page_size Page size. Default is 100. Max allowable is 1000. (default to 100)
+    # @return [PayeeDeltaResponse]
+    def list_payee_changes(payor_id, updated_since, opts = {})
+      data, _status_code, _headers = list_payee_changes_with_http_info(payor_id, updated_since, opts)
+      data
+    end
+
+    # List Payee Changes
+    # Get a paginated response listing payee changes.
+    # @param payor_id [String] The Payor ID to find associated Payees
+    # @param updated_since [DateTime] 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 Page size. Default is 100. Max allowable is 1000.
+    # @return [Array<(PayeeDeltaResponse, Integer, Hash)>] PayeeDeltaResponse data, response status code and response headers
+    def list_payee_changes_with_http_info(payor_id, updated_since, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayeesApi.list_payee_changes ...'
+      end
+      # verify the required parameter 'payor_id' is set
+      if @api_client.config.client_side_validation && payor_id.nil?
+        fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayeesApi.list_payee_changes"
+      end
+      # verify the required parameter 'updated_since' is set
+      if @api_client.config.client_side_validation && updated_since.nil?
+        fail ArgumentError, "Missing the required parameter 'updated_since' when calling PayeesApi.list_payee_changes"
+      end
+      # resource path
+      local_var_path = '/v1/deltas/payees'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'payorId'] = payor_id
+      query_params[:'updatedSince'] = updated_since
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'PayeeDeltaResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PayeesApi#list_payee_changes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # List Payees
     # Get a paginated response listing the payees for a payor.
     # @param payor_id [String] The account owner Payor ID
@@ -177,7 +272,7 @@ module VeloPayments
       local_var_path = '/v1/payees'
 
       # query parameters
-      query_params = {}
+      query_params = opts[:query_params] || {}
       query_params[:'payorId'] = payor_id
       query_params[:'ofacStatus'] = opts[:'ofac_status'] if !opts[:'ofac_status'].nil?
       query_params[:'onboardedStatus'] = opts[:'onboarded_status'] if !opts[:'onboarded_status'].nil?
@@ -191,23 +286,32 @@ module VeloPayments
       query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
 
       # header parameters
-      header_params = {}
+      header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
 
       # form parameters
-      form_params = {}
+      form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = nil
-      auth_names = ['OAuth2']
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'PayeeResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'PayeeResponse')
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: PayeesApi#list_payees\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end