velopayments 2.29.128.beta1 → 2.35.58

data/spec/api/payees_api_spec.rb

@@ -3,10 +3,10 @@
 
 ### Terms and Definitions  Throughout this document and the Velo platform the following terms are used:  * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking.  ## Overview  The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution:  * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments  This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference.  ## API Considerations  The Velo Payments API is REST based and uses the JSON format for requests and responses.  Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details.  Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters).  Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print.  ## Authenticating with the Velo Platform  Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner.  You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following:  create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529  base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==  create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==  perform the Velo authentication REST call using the HTTP header created above e.g. via curl:  ```   curl -X POST \\   -H \"Content-Type: application/json\" \\   -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\   'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ```  If successful, this call will result in a **200** HTTP status code and a response body such as:  ```   {     \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\",     \"token_type\":\"bearer\",     \"expires_in\":1799,     \"scope\":\"...\"   } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated.  This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below:  ```   -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ```  If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response. 
 
-The version of the OpenAPI document: 2.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
 
@@ -19,6 +19,32 @@ require 'json'
 describe 'PayeesApi' do
   before do
     # run before each test
+    if ENV['APITOKEN'] == ""
+      VeloPayments.configure do |config|
+        config.username = ENV['KEY']
+        config.password =  ENV['SECRET']
+      end
+      
+      api_instance = VeloPayments::LoginApi.new
+      opts = {
+        grant_type: 'client_credentials'
+      }
+      
+      begin
+        res = api_instance.velo_auth(opts)
+
+        ENV['APITOKEN'] = res.access_token
+      rescue VeloPayments::ApiError => e
+        puts "Exception when calling LoginApi->velo_auth: #{e}"
+      end
+    end
+
+    uri = URI.parse(ENV['APIURL'])
+    VeloPayments.configure do |config|
+      config.access_token = ENV['APITOKEN']
+      config.host = uri.host
+    end
+
     @api_instance = VeloPayments::PayeesApi.new
   end
 
@@ -39,8 +65,8 @@ describe 'PayeesApi' do
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'delete_payee_by_id_v3 test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    skip "skipping test" do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -51,8 +77,8 @@ describe 'PayeesApi' do
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'delete_payee_by_id_v4 test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    skip "skipping test" do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -62,10 +88,10 @@ describe 'PayeesApi' do
   # @param payee_id The UUID of the payee.
   # @param [Hash] opts the optional parameters
   # @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values. 
-  # @return [PayeeDetailResponse]
+  # @return [PayeeDetailResponseV3]
   describe 'get_payee_by_id_v3 test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    skip "skipping test" do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -75,10 +101,10 @@ describe 'PayeesApi' do
   # @param payee_id The UUID of the payee.
   # @param [Hash] opts the optional parameters
   # @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values. 
-  # @return [PayeeDetailResponse2]
+  # @return [PayeeDetailResponseV4]
   describe 'get_payee_by_id_v4 test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    skip "skipping test" do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -90,10 +116,18 @@ describe 'PayeesApi' do
   # @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 [PayeeDeltaResponse]
+  # @return [PayeeDeltaResponseV3]
   describe 'list_payee_changes_v3 test' do
     it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      payor_id = ENV['PAYOR']
+      updated_since = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
+      opts = {
+        page: 1, # Integer | Page number. Default is 1.
+        page_size: 100 # Integer | Page size. Default is 100. Max allowable is 1000.
+      }
+      res = @api_instance.list_payee_changes_v3(payor_id, updated_since, opts)
+      expect(res.content.length()).to be >= 1
+      expect(@api_instance).to respond_to(:list_payee_changes_v3) 
     end
   end
 
@@ -105,10 +139,10 @@ describe 'PayeesApi' do
   # @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 [PayeeDeltaResponse2]
+  # @return [PayeeDeltaResponseV4]
   describe 'list_payee_changes_v4 test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    skip "skipping test" do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -117,21 +151,21 @@ describe 'PayeesApi' do
   # <p>Use v4 instead</p> Get a paginated response listing the payees for a payor. 
   # @param payor_id The account owner Payor ID
   # @param [Hash] opts the optional parameters
-  # @option opts [WatchlistStatus] :watchlist_status The watchlistStatus of the payees.
+  # @option opts [String] :watchlist_status The watchlistStatus of the payees.
   # @option opts [Boolean] :disabled Payee disabled
-  # @option opts [OnboardedStatus] :onboarded_status The onboarded status of the payees.
+  # @option opts [String] :onboarded_status The onboarded status of the payees.
   # @option opts [String] :email Email address
   # @option opts [String] :display_name The display name of the payees.
   # @option opts [String] :remote_id The remote id of the payees.
-  # @option opts [PayeeType2] :payee_type The onboarded status of the payees.
+  # @option opts [String] :payee_type The onboarded status of the payees.
   # @option opts [String] :payee_country The country of the payee - 2 letter ISO 3166-1 country code (upper case)
   # @option opts [Integer] :page Page number. Default is 1.
   # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
   # @option opts [String] :sort List of sort fields (e.g. ?sort=onboardedStatus:asc,name:asc) Default is name:asc 'name' is treated as company name for companies - last name + ',' + firstName for individuals The supported sort fields are - payeeId, displayName, payoutStatus, onboardedStatus. 
-  # @return [PagedPayeeResponse]
+  # @return [PagedPayeeResponseV3]
   describe 'list_payees_v3 test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    skip "skipping test" do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -140,22 +174,22 @@ describe 'PayeesApi' do
   # Get a paginated response listing the payees for a payor.
   # @param payor_id The account owner Payor ID
   # @param [Hash] opts the optional parameters
-  # @option opts [WatchlistStatus] :watchlist_status The watchlistStatus of the payees.
+  # @option opts [String] :watchlist_status The watchlistStatus of the payees.
   # @option opts [Boolean] :disabled Payee disabled
-  # @option opts [OnboardedStatus] :onboarded_status The onboarded status of the payees.
+  # @option opts [String] :onboarded_status The onboarded status of the payees.
   # @option opts [String] :email Email address
   # @option opts [String] :display_name The display name of the payees.
   # @option opts [String] :remote_id The remote id of the payees.
-  # @option opts [PayeeType2] :payee_type The onboarded status of the payees.
+  # @option opts [String] :payee_type The onboarded status of the payees.
   # @option opts [String] :payee_country The country of the payee - 2 letter ISO 3166-1 country code (upper case)
-  # @option opts [OfacStatus] :ofac_status The ofacStatus of the payees.
+  # @option opts [String] :ofac_status The ofacStatus 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.
   # @option opts [String] :sort List of sort fields (e.g. ?sort=onboardedStatus:asc,name:asc) Default is name:asc 'name' is treated as company name for companies - last name + ',' + firstName for individuals The supported sort fields are - payeeId, displayName, payoutStatus, onboardedStatus. 
-  # @return [PagedPayeeResponse2]
+  # @return [PagedPayeeResponseV4]
   describe 'list_payees_v4 test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    skip "skipping test" do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -163,12 +197,12 @@ describe 'PayeesApi' do
   # Update Payee Details
   # <p>Use v4 instead</p> <p>Update payee details for the given Payee Id.<p> 
   # @param payee_id The UUID of the payee.
-  # @param update_payee_details_request Request to update payee details
+  # @param update_payee_details_request_v3 Request to update payee details
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'payee_details_update_v3 test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    skip "skipping test" do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -176,12 +210,12 @@ describe 'PayeesApi' do
   # Update Payee Details
   # <p>Update payee details for the given Payee Id.</p> <p>Payors may only update the payee details if the payee has not yet onboarded</p> 
   # @param payee_id The UUID of the payee.
-  # @param update_payee_details_request2 Request to update payee details
+  # @param update_payee_details_request_v4 Request to update payee details
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'payee_details_update_v4 test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    skip "skipping test" do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -189,12 +223,12 @@ describe 'PayeesApi' do
   # Update Payee Remote Id
   # <p>Use v4 instead</p> <p>Update the remote Id for the given Payee Id.</p> 
   # @param payee_id The UUID of the payee.
-  # @param update_remote_id_request Request to update payee remote id v3
+  # @param update_remote_id_request_v3 Request to update payee remote id v3
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'v3_payees_payee_id_remote_id_update_post test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    skip "skipping test" do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -202,12 +236,12 @@ describe 'PayeesApi' do
   # Update Payee Remote Id
   # <p>Update the remote Id for the given Payee Id.</p> 
   # @param payee_id The UUID of the payee.
-  # @param update_remote_id_request2 Request to update payee remote id v4
+  # @param update_remote_id_request_v4 Request to update payee remote id v4
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'v4_payees_payee_id_remote_id_update_post test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    skip "skipping test" do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 

data/spec/api/payment_audit_service_api_spec.rb

@@ -3,10 +3,10 @@
 
 ### Terms and Definitions  Throughout this document and the Velo platform the following terms are used:  * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking.  ## Overview  The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution:  * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments  This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference.  ## API Considerations  The Velo Payments API is REST based and uses the JSON format for requests and responses.  Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details.  Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters).  Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print.  ## Authenticating with the Velo Platform  Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner.  You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following:  create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529  base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==  create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==  perform the Velo authentication REST call using the HTTP header created above e.g. via curl:  ```   curl -X POST \\   -H \"Content-Type: application/json\" \\   -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\   'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ```  If successful, this call will result in a **200** HTTP status code and a response body such as:  ```   {     \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\",     \"token_type\":\"bearer\",     \"expires_in\":1799,     \"scope\":\"...\"   } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated.  This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below:  ```   -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ```  If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response. 
 
-The version of the OpenAPI document: 2.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
 
@@ -19,6 +19,32 @@ require 'json'
 describe 'PaymentAuditServiceApi' do
   before do
     # run before each test
+    if ENV['APITOKEN'] == ""
+      VeloPayments.configure do |config|
+        config.username = ENV['KEY']
+        config.password =  ENV['SECRET']
+      end
+      
+      api_instance = VeloPayments::LoginApi.new
+      opts = {
+        grant_type: 'client_credentials'
+      }
+      
+      begin
+        res = api_instance.velo_auth(opts)
+
+        ENV['APITOKEN'] = res.access_token
+      rescue VeloPayments::ApiError => e
+        puts "Exception when calling LoginApi->velo_auth: #{e}"
+      end
+    end
+
+    uri = URI.parse(ENV['APIURL'])
+    VeloPayments.configure do |config|
+      config.access_token = ENV['APITOKEN']
+      config.host = uri.host
+    end
+
     @api_instance = VeloPayments::PaymentAuditServiceApi.new
   end
 
@@ -42,8 +68,8 @@ describe 'PaymentAuditServiceApi' do
   # @option opts [String] :include <p>Mode to determine whether to include other Payor's data in the results.</p> <p>May only be used if payorId is specified.</p> <p>Can be omitted or set to 'payorOnly' or 'payorAndDescendants'.</p> <p>payorOnly: Only include results for the specified Payor. This is the default if 'include' is omitted.</p> <p>payorAndDescendants: Aggregate results for all descendant Payors of the specified Payor. Should only be used if the Payor with the specified payorId has at least one child Payor.</p> <p>Note when a Payor requests the report and include=payorAndDescendants is used, the following additional columns are included in the CSV: Payor Name, Payor Id</p> 
   # @return [PayorAmlTransaction]
   describe 'export_transactions_csvv4 test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    skip "skipping broken test" do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -52,13 +78,14 @@ describe 'PaymentAuditServiceApi' do
   # <p>Get a list of Fundings for a payor.</p> 
   # @param payor_id The account owner Payor ID
   # @param [Hash] opts the optional parameters
+  # @option opts [String] :source_account_name The source account name
   # @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. Example: ```?sort=destinationCurrency:asc,destinationAmount:asc``` Default is no sort. The supported sort fields are: dateTime and amount. 
   # @return [GetFundingsResponse]
   describe 'get_fundings_v4 test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    skip "skipping broken test" do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -70,8 +97,8 @@ describe 'PaymentAuditServiceApi' do
   # @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values. 
   # @return [PaymentResponseV4]
   describe 'get_payment_details_v4 test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    skip "skipping broken test" do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -80,6 +107,7 @@ describe 'PaymentAuditServiceApi' do
   # Get List of payments for Payout, allowing for RETURNED status 
   # @param payout_id The id (UUID) of the payout.
   # @param [Hash] opts the optional parameters
+  # @option opts [String] :rails_id Payout Rails ID filter - case insensitive match. Any value is allowed, but you should use one of the supported railsId values. To get this list of values, you should call the 'Get Supported Rails' endpoint. 
   # @option opts [String] :remote_id The remote id of the payees.
   # @option opts [String] :remote_system_id The id of the remote system that is orchestrating payments
   # @option opts [String] :status Payment Status
@@ -89,15 +117,15 @@ describe 'PaymentAuditServiceApi' do
   # @option opts [Integer] :payment_amount_to The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo
   # @option opts [Date] :submitted_date_from The submitted date from range filter. Format is yyyy-MM-dd.
   # @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
-  # @option opts [String] :transmission_type Transmission Type * ACH * SAME_DAY_ACH * WIRE 
+  # @option opts [String] :transmission_type Transmission Type * ACH * SAME_DAY_ACH * WIRE * GACHO 
   # @option opts [Integer] :page Page number. Default is 1.
   # @option opts [Integer] :page_size The number of results to return in a page
   # @option opts [String] :sort List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status 
   # @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values. 
   # @return [GetPaymentsForPayoutResponseV4]
   describe 'get_payments_for_payout_v4 test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    skip "skipping broken test" do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -109,7 +137,12 @@ describe 'PaymentAuditServiceApi' do
   # @return [GetPayoutStatistics]
   describe 'get_payout_stats_v4 test' do
     it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      opts = {
+        payor_id: ENV['PAYOR']
+      }
+      res = @api_instance.get_payout_stats_v4(opts)
+      expect(res.this_month_payouts_count).to be >= 1
+      expect(@api_instance).to respond_to(:get_payout_stats_v4) 
     end
   end
 
@@ -132,7 +165,21 @@ describe 'PaymentAuditServiceApi' do
   # @return [GetPayoutsResponse]
   describe 'get_payouts_for_payor_v4 test' do
     it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      opts = {
+        payor_id: ENV['PAYOR'], # String | The id (UUID) of the payor funding the payout or the payor whose payees are being paid.
+        payout_memo: nil, # # String | Payout Memo filter - case insensitive sub-string match
+        status: nil, # String | Payout Status
+        submitted_date_from: nil, # Date.parse('2013-10-20'), # Date | The submitted date from range filter. Format is yyyy-MM-dd.
+        submitted_date_to: nil, # Date.parse('2013-10-20'), # Date | The submitted date to range filter. Format is yyyy-MM-dd.
+        from_payor_name: nil, # String | The name of the payor whose payees are being paid. This filters via a case insensitive substring match.
+        page: 1, # Integer | Page number. Default is 1.
+        page_size: 25, # Integer | The number of results to return in a page
+        sort: 'submittedDateTime:desc' # String | List of sort fields (e.g. ?sort=submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status, totalPayments, payoutId 
+      }
+
+      res = @api_instance.get_payouts_for_payor_v4(opts)
+      expect(res.content.length()).to be >= 1
+      expect(@api_instance).to respond_to(:get_payouts_for_payor_v4) 
     end
   end
 
@@ -146,8 +193,8 @@ describe 'PaymentAuditServiceApi' do
   # @option opts [Integer] :page_size The number of results to return in a page
   # @return [PaymentDeltaResponse]
   describe 'list_payment_changes_v4 test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    skip "skipping broken test" do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -161,7 +208,7 @@ describe 'PaymentAuditServiceApi' do
   # @option opts [String] :remote_id The remote id of the payees.
   # @option opts [String] :remote_system_id The id of the remote system that is orchestrating payments
   # @option opts [String] :status Payment Status
-  # @option opts [String] :transmission_type Transmission Type * ACH * SAME_DAY_ACH * WIRE 
+  # @option opts [String] :transmission_type Transmission Type * ACH * SAME_DAY_ACH * WIRE * GACHO 
   # @option opts [String] :source_account_name The source account name filter. This filters via a case insensitive substring match.
   # @option opts [Integer] :source_amount_from The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom
   # @option opts [Integer] :source_amount_to The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo
@@ -172,9 +219,11 @@ describe 'PaymentAuditServiceApi' do
   # @option opts [Date] :submitted_date_from The submitted date from range filter. Format is yyyy-MM-dd.
   # @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd.
   # @option opts [String] :payment_memo The payment memo filter. This filters via a case insensitive substring match.
+  # @option opts [String] :rails_id Payout Rails ID filter - case insensitive match. Any value is allowed, but you should use one of the supported railsId values. To get this list of values, you should call the 'Get Supported Rails' endpoint. 
   # @option opts [Date] :scheduled_for_date_from Filter payouts scheduled to run on or after the given date. Format is yyyy-MM-dd.
   # @option opts [Date] :scheduled_for_date_to Filter payouts scheduled to run on or before the given date. Format is yyyy-MM-dd.
   # @option opts [String] :schedule_status Payout Schedule Status
+  # @option opts [String] :post_instruct_fx_status The status of the post instruct FX step if one was required for the payment
   # @option opts [Integer] :page Page number. Default is 1.
   # @option opts [Integer] :page_size The number of results to return in a page
   # @option opts [String] :sort List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by submittedDateTime:desc,paymentId:asc The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime, status and paymentId 
@@ -182,7 +231,31 @@ describe 'PaymentAuditServiceApi' do
   # @return [ListPaymentsResponseV4]
   describe 'list_payments_audit_v4 test' do
     it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      opts = {
+        payee_id: nil, # String | The UUID of the payee.
+        payor_id: ENV['PAYOR'], # String | The account owner Payor Id. Required for external users.
+        payor_name: nil, # String | The payor’s name. This filters via a case insensitive substring match.
+        remote_id: nil, # String | The remote id of the payees.
+        status: nil, # String | Payment Status
+        source_account_name: nil, # String | The source account name filter. This filters via a case insensitive substring match.
+        source_amount_from: nil, # Integer | The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom
+        source_amount_to: nil, # Integer | The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo
+        source_currency: nil, # String | The source currency filter. Filters based on an exact match on the currency.
+        payment_amount_from: nil, # Integer | The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom
+        payment_amount_to: nil, # Integer | The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo
+        payment_currency: nil, # String | The payment currency filter. Filters based on an exact match on the currency.
+        submitted_date_from: nil, # Date.parse('2013-10-20'), # Date | The submitted date from range filter. Format is yyyy-MM-dd.
+        submitted_date_to: nil, # Date.parse('2013-10-20'), # Date | The submitted date to range filter. Format is yyyy-MM-dd.
+        payment_memo: nil, # String | The payment memo filter. This filters via a case insensitive substring match.
+        page: 1, # Integer | Page number. Default is 1.
+        page_size: 25, # Integer | The number of results to return in a page
+        sort: 'submittedDateTime:desc', # String | List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status 
+        sensitive: true # Boolean | Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values. 
+      }
+
+      res = @api_instance.list_payments_audit_v4(opts)
+      expect(res.content.length()).to be >= 1
+      expect(@api_instance).to respond_to(:list_payments_audit_v4) 
     end
   end
 

data/spec/api/payment_audit_service_deprecated_api_spec.rb

@@ -3,10 +3,10 @@
 
 ### Terms and Definitions  Throughout this document and the Velo platform the following terms are used:  * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking.  ## Overview  The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution:  * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments  This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference.  ## API Considerations  The Velo Payments API is REST based and uses the JSON format for requests and responses.  Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details.  Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters).  Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print.  ## Authenticating with the Velo Platform  Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner.  You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following:  create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529  base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==  create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==  perform the Velo authentication REST call using the HTTP header created above e.g. via curl:  ```   curl -X POST \\   -H \"Content-Type: application/json\" \\   -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\   'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ```  If successful, this call will result in a **200** HTTP status code and a response body such as:  ```   {     \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\",     \"token_type\":\"bearer\",     \"expires_in\":1799,     \"scope\":\"...\"   } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated.  This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below:  ```   -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ```  If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response. 
 
-The version of the OpenAPI document: 2.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
 
@@ -42,7 +42,7 @@ describe 'PaymentAuditServiceDeprecatedApi' do
   # @return [PayorAmlTransactionV3]
   describe 'export_transactions_csvv3 test' do
     it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -57,7 +57,7 @@ describe 'PaymentAuditServiceDeprecatedApi' do
   # @return [GetFundingsResponse]
   describe 'get_fundings_v1 test' do
     it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -70,7 +70,7 @@ describe 'PaymentAuditServiceDeprecatedApi' do
   # @return [PaymentResponseV3]
   describe 'get_payment_details_v3 test' do
     it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -94,7 +94,7 @@ describe 'PaymentAuditServiceDeprecatedApi' do
   # @return [GetPaymentsForPayoutResponseV3]
   describe 'get_payments_for_payout_pav3 test' do
     it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -106,7 +106,7 @@ describe 'PaymentAuditServiceDeprecatedApi' do
   # @return [GetPayoutStatistics]
   describe 'get_payout_stats_v1 test' do
     it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -125,7 +125,7 @@ describe 'PaymentAuditServiceDeprecatedApi' do
   # @return [GetPayoutsResponseV3]
   describe 'get_payouts_for_payor_v3 test' do
     it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -140,7 +140,7 @@ describe 'PaymentAuditServiceDeprecatedApi' do
   # @return [PaymentDeltaResponseV1]
   describe 'list_payment_changes test' do
     it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
@@ -170,7 +170,7 @@ describe 'PaymentAuditServiceDeprecatedApi' do
   # @return [ListPaymentsResponseV3]
   describe 'list_payments_audit_v3 test' do
     it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end