wp-sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e8f06b621cd848a6a76b973b25e074c76a5a753849f0f0a117b7c0725a73d142
+  data.tar.gz: 8d6be02baf8f927f0a0a10467e7b789acc01a4d72abb1145833e8f65cec40c50
+SHA512:
+  metadata.gz: 6061308f73961ace75f15288ee43da7bd242e6e25c5e3056aa7722b6264736e69ded8eed866838e08a95cc6c6b0f4bcad28b482ed69fe33633b39e00bce2624d
+  data.tar.gz: 8918d6c84fbfd893ed75bef6f79f06b5c44e5db6d9fec9246c047c2976c6aa633b0b525118bb915ba2d7eac002f5a8b68d16d4db820a0ea594ea75887e72383e

data/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2026 APIMATIC Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+Trade Mark:
+==========
+APIMATIC is a trade mark for APIMATIC Limited

data/README.md

@@ -0,0 +1,152 @@
+
+# Getting Started with Reporting: Settlement Research API
+
+## Introduction
+
+API used to search and retrieve settled transactions. This API is used to search settled transactions and retrieve individual transaction details based on card types.
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install wp-sdk -v 1.0.0
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'wp-sdk', '1.0.0'
+```
+
+For additional gem details, see the [RubyGems page for the wp-sdk gem](https://rubygems.org/gems/wp-sdk/versions/1.0.0).
+
+## IRB Console Usage
+
+You can explore the SDK interactively using IRB in two ways
+
+### 1. Use IRB with Installed Gem
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and type the following command to start the irb console.
+
+```bash
+irb
+```
+
+Now you can load the SDK in the IRB
+
+```ruby
+require 'reporting_settlement_research_api'
+include ReportingSettlementResearchApi
+```
+
+### 2. Use IRB within SDK
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and navigate to the root folder of SDK.
+
+```
+cd path/to/reporting_settlement_research_api
+```
+
+Now you can start the preconfigured irb console by running the following command
+
+```bash
+ruby bin/console
+```
+
+**_Note:_** This automatically loads the SDK from lib/
+
+## Initialize the API Client
+
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/wp-ruby-sdk/tree/1.0.0/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| connection | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
+| adapter | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
+| timeout | `Float` | The value to use for connection timeout. <br> **Default: 60** |
+| max_retries | `Integer` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
+| retry_interval | `Float` | Pause in seconds between retries. <br> **Default: 1** |
+| backoff_factor | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff. <br> **Default: 2** |
+| retry_statuses | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
+| retry_methods | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
+| http_callback | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
+| proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/wp-ruby-sdk/tree/1.0.0/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/wp-ruby-sdk/tree/1.0.0/doc/logging-configuration.md) | The SDK logging configuration for API calls |
+| custom_header_authentication_credentials | [`CustomHeaderAuthenticationCredentials`](https://www.github.com/sdks-io/wp-ruby-sdk/tree/1.0.0/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
+
+The API client can be initialized as follows:
+
+### Code-Based Client Initialization
+
+```ruby
+require 'reporting_settlement_research_api'
+include ReportingSettlementResearchApi
+
+client = Client.new(
+  custom_header_authentication_credentials: CustomHeaderAuthenticationCredentials.new(
+    authorization: 'Authorization'
+  ),
+  logging_configuration: LoggingConfiguration.new(
+    log_level: Logger::INFO,
+    request_logging_config: RequestLoggingConfiguration.new(
+      log_body: true
+    ),
+    response_logging_config: ResponseLoggingConfiguration.new(
+      log_headers: true
+    )
+  )
+)
+```
+
+### Environment-Based Client Initialization
+
+```ruby
+require 'reporting_settlement_research_api'
+include ReportingSettlementResearchApi
+
+# Create client from environment
+client = Client.from_env
+```
+
+See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/wp-ruby-sdk/tree/1.0.0/doc/environment-based-client-initialization.md) section for details.
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`api_key (Custom Header Signature)`](https://www.github.com/sdks-io/wp-ruby-sdk/tree/1.0.0/doc/auth/custom-header-signature.md)
+
+## List of APIs
+
+* [Settlement Errors](https://www.github.com/sdks-io/wp-ruby-sdk/tree/1.0.0/doc/controllers/settlement-errors.md)
+* [Settlement Daily Totals](https://www.github.com/sdks-io/wp-ruby-sdk/tree/1.0.0/doc/controllers/settlement-daily-totals.md)
+* [Settlement Batches](https://www.github.com/sdks-io/wp-ruby-sdk/tree/1.0.0/doc/controllers/settlement-batches.md)
+* [Transaction Type](https://www.github.com/sdks-io/wp-ruby-sdk/tree/1.0.0/doc/controllers/transaction-type.md)
+* [Transaction Status](https://www.github.com/sdks-io/wp-ruby-sdk/tree/1.0.0/doc/controllers/transaction-status.md)
+* [Settlements](https://www.github.com/sdks-io/wp-ruby-sdk/tree/1.0.0/doc/controllers/settlements.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](https://www.github.com/sdks-io/wp-ruby-sdk/tree/1.0.0/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/sdks-io/wp-ruby-sdk/tree/1.0.0/doc/environment-based-client-initialization.md)
+* [AbstractLogger](https://www.github.com/sdks-io/wp-ruby-sdk/tree/1.0.0/doc/abstract-logger.md)
+* [LoggingConfiguration](https://www.github.com/sdks-io/wp-ruby-sdk/tree/1.0.0/doc/logging-configuration.md)
+* [RequestLoggingConfiguration](https://www.github.com/sdks-io/wp-ruby-sdk/tree/1.0.0/doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/wp-ruby-sdk/tree/1.0.0/doc/response-logging-configuration.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/sdks-io/wp-ruby-sdk/tree/1.0.0/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/wp-ruby-sdk/tree/1.0.0/doc/http-request.md)
+
+### Utilities
+
+* [ApiResponse](https://www.github.com/sdks-io/wp-ruby-sdk/tree/1.0.0/doc/api-response.md)
+* [ApiHelper](https://www.github.com/sdks-io/wp-ruby-sdk/tree/1.0.0/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/sdks-io/wp-ruby-sdk/tree/1.0.0/doc/date-time-helper.md)
+

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+# Load the lib folder into Ruby's load path
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+
+# Require the gem
+require 'reporting_settlement_research_api'
+
+puts 'ReportingSettlementResearchApi SDK loaded!'
+puts 'You can now create a client with: client = ReportingSettlementResearchApi::Client.new'
+puts 'Or use from_env: client = ReportingSettlementResearchApi::Client.from_env'
+
+# Start an interactive IRB session
+require 'irb'
+IRB.start

data/lib/reporting_settlement_research_api/api_helper.rb

@@ -0,0 +1,10 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # API utility class
+  class APIHelper < CoreLibrary::ApiHelper
+  end
+end

data/lib/reporting_settlement_research_api/apis/base_api.rb

@@ -0,0 +1,65 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # BaseApi.
+  class BaseApi
+    include CoreLibrary
+    attr_accessor :config, :http_call_back
+
+    def self.user_agent
+      'Ruby SDK, Version: 1.0.0, on OS {os-info}'
+    end
+
+    def self.user_agent_parameters
+      {
+        '{os-info}' => { 'value' => RUBY_PLATFORM, 'encode' => false }
+      }
+    end
+
+    GLOBAL_ERRORS = {
+      'default' => ErrorCase.new
+                            .error_message('HTTP response not OK.')
+                            .exception_type(APIException)
+    }.freeze
+
+    # Initialization constructor.
+    # @param [GlobalConfiguration] global_configuration The instance of GlobalConfiguration.
+    def initialize(global_configuration)
+      @global_configuration = global_configuration
+      @config = @global_configuration.client_configuration
+      @http_call_back = @config.http_callback
+      @api_call = ApiCall.new(@global_configuration)
+    end
+
+    # Creates a new instance of the request builder.
+    # @param [String] http_method The HTTP method to use in the request.
+    # @param [String] path The endpoint path to use in the request.
+    # @param [String] server The server to extract the base uri for the request.
+    # @return [RequestBuilder] The instance of RequestBuilder.
+    def new_request_builder(http_method, path, server)
+      RequestBuilder.new
+                    .http_method(http_method)
+                    .path(path)
+                    .server(server)
+    end
+
+    # Creates a new instance of the response handler.
+    # @return [ResponseHandler] The instance of ResponseHandler.
+    def new_response_handler
+      ResponseHandler.new
+    end
+
+    # Creates a new instance of the parameter.
+    # @param [String|optional] key The key of the parameter.
+    # @param [Object] value The value of the parameter.
+    # @return [Parameter] The instance of Parameter.
+    def new_parameter(value, key: nil)
+      Parameter.new
+               .key(key)
+               .value(value)
+    end
+  end
+end

data/lib/reporting_settlement_research_api/apis/settlement_batches_api.rb

@@ -0,0 +1,67 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # SettlementBatchesApi
+  class SettlementBatchesApi < BaseApi
+    # Search settlement batches grouped by store.
+    # @param [SearchStoreRequest] body Required parameter: TODO: type
+    # description here
+    # @param [UUID | String] v_correlation_id Optional parameter: Correlation
+    # Id
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def search_settlement_batches_store(body,
+                                        v_correlation_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/search/store',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter(v_correlation_id, key: 'v-correlation-id'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('api_key')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SearchStoreResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Default errors',
+                                 SearchStore0ErrorException))
+        .execute
+    end
+
+    # Search settlement batches grouped by date.
+    # @param [SearchDateRequest] body Required parameter: TODO: type description
+    # here
+    # @param [UUID | String] v_correlation_id Optional parameter: Correlation
+    # Id
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def search_settlement_batches_date(body,
+                                       v_correlation_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/search/date',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter(v_correlation_id, key: 'v-correlation-id'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('api_key')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SearchDateResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Default errors',
+                                 SearchDate0ErrorException))
+        .execute
+    end
+  end
+end

data/lib/reporting_settlement_research_api/apis/settlement_daily_totals_api.rb

@@ -0,0 +1,39 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # SettlementDailyTotalsApi
+  class SettlementDailyTotalsApi < BaseApi
+    # Retrieve the settled transactions daily financial activity for a given
+    # hierarchy and date range. Optional fields help refine the search.
+    # @param [SettlementsDailyTotalsSearchRequest] body Required parameter:
+    # TODO: type description here
+    # @param [UUID | String] v_correlation_id Optional parameter: Correlation
+    # Id
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def search_settlements_daily_totals(body,
+                                        v_correlation_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/settlements/daily-totals/search',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter(v_correlation_id, key: 'v-correlation-id'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('api_key')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SettlementsDailyTotalsSearchResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Default errors',
+                                 SettlementsDailyTotalsSearch0ErrorException))
+        .execute
+    end
+  end
+end

data/lib/reporting_settlement_research_api/apis/settlement_errors_api.rb

@@ -0,0 +1,67 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # SettlementErrorsApi
+  class SettlementErrorsApi < BaseApi
+    # Search settlement rejections.
+    # @param [SettlementerrorsSettlementfileerrorsSearchRequest] body Required
+    # parameter: TODO: type description here
+    # @param [UUID | String] v_correlation_id Optional parameter: Correlation
+    # Id
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def search_settlement_rejects(body,
+                                  v_correlation_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/settlementerrors/settlementfileerrors/search',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter(v_correlation_id, key: 'v-correlation-id'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('api_key')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SettlementerrorsSettlementfileerrorsSearchResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Default errors',
+                                 SettlementerrorsSettlementfileerrorsSearch0ErrorException))
+        .execute
+    end
+
+    # Search bank card rejections.
+    # @param [SettlementerrorsPendingsettlementbatchesSearchRequest] body
+    # Required parameter: TODO: type description here
+    # @param [UUID | String] v_correlation_id Optional parameter: Correlation
+    # Id
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def search_bank_card_rejects(body,
+                                 v_correlation_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/settlementerrors/pendingsettlementbatches/search',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter(v_correlation_id, key: 'v-correlation-id'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('api_key')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SettlementerrorsPendingsettlementbatchesSearchResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Default errors',
+                                 SettlementerrorsPendingsettlementbatchesSearch0ErrorException))
+        .execute
+    end
+  end
+end

data/lib/reporting_settlement_research_api/apis/settlements_api.rb

@@ -0,0 +1,40 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # SettlementsApi
+  class SettlementsApi < BaseApi
+    # Endpoint to retrieve the settled transaction details for a given hierarchy
+    # and date range, with a 45-day limit and unrestricted lookup period.
+    # Optional fields help refine the search.
+    # @param [SettlementsSearchRequest] body Required parameter: TODO: type
+    # description here
+    # @param [UUID | String] v_correlation_id Optional parameter: Correlation
+    # Id
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def search_settlements(body,
+                           v_correlation_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/settlements/search',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter(v_correlation_id, key: 'v-correlation-id'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('api_key')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SettlementsSearchResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Default errors',
+                                 SettlementsSearch0ErrorException))
+        .execute
+    end
+  end
+end

data/lib/reporting_settlement_research_api/apis/transaction_status_api.rb

@@ -0,0 +1,33 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # TransactionStatusApi
+  class TransactionStatusApi < BaseApi
+    # Indicates the current state of a financial transaction, whether it's
+    # pending, completed, failed, or under review.
+    # @param [UUID | String] v_correlation_id Optional parameter: Correlation
+    # Id
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_transaction_status(v_correlation_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/transaction-statuses',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(v_correlation_id, key: 'v-correlation-id'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('api_key')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TransactionStatusCode.method(:from_hash))
+                    .is_api_response(true)
+                    .is_response_array(true)
+                    .local_error('default',
+                                 'Default errors',
+                                 TransactionStatuses0ErrorException))
+        .execute
+    end
+  end
+end

data/lib/reporting_settlement_research_api/apis/transaction_type_api.rb

@@ -0,0 +1,33 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # TransactionTypeApi
+  class TransactionTypeApi < BaseApi
+    # The specific nature or purpose of a financial activity, such as purchases,
+    # withdrawals, or transfers.
+    # @param [UUID | String] v_correlation_id Optional parameter: Correlation
+    # Id
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_transaction_type(v_correlation_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/transaction-types',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(v_correlation_id, key: 'v-correlation-id'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('api_key')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TransactionTypeCode.method(:from_hash))
+                    .is_api_response(true)
+                    .is_response_array(true)
+                    .local_error('default',
+                                 'Default errors',
+                                 TransactionTypes0ErrorException))
+        .execute
+    end
+  end
+end

data/lib/reporting_settlement_research_api/client.rb

@@ -0,0 +1,105 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  #  reporting_settlement_research_api client class.
+  class Client
+    include CoreLibrary
+    attr_reader :config, :auth_managers
+
+    def user_agent_detail
+      config.user_agent_detail
+    end
+
+    # Access to settlements controller.
+    # @return [SettlementsApi] Returns the controller instance.
+    def settlements
+      @settlements ||= SettlementsApi.new @global_configuration
+    end
+
+    # Access to settlement_errors controller.
+    # @return [SettlementErrorsApi] Returns the controller instance.
+    def settlement_errors
+      @settlement_errors ||= SettlementErrorsApi.new @global_configuration
+    end
+
+    # Access to settlement_daily_totals controller.
+    # @return [SettlementDailyTotalsApi] Returns the controller instance.
+    def settlement_daily_totals
+      @settlement_daily_totals ||= SettlementDailyTotalsApi.new @global_configuration
+    end
+
+    # Access to settlement_batches controller.
+    # @return [SettlementBatchesApi] Returns the controller instance.
+    def settlement_batches
+      @settlement_batches ||= SettlementBatchesApi.new @global_configuration
+    end
+
+    # Access to transaction_type controller.
+    # @return [TransactionTypeApi] Returns the controller instance.
+    def transaction_type
+      @transaction_type ||= TransactionTypeApi.new @global_configuration
+    end
+
+    # Access to transaction_status controller.
+    # @return [TransactionStatusApi] Returns the controller instance.
+    def transaction_status
+      @transaction_status ||= TransactionStatusApi.new @global_configuration
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 60,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
+      logging_configuration: nil, environment: Environment::PRODUCTION,
+      custom_header_authentication_credentials: nil, config: nil
+    )
+      @config = if config.nil?
+                  Configuration.new(
+                    connection: connection, adapter: adapter, timeout: timeout,
+                    max_retries: max_retries, retry_interval: retry_interval,
+                    backoff_factor: backoff_factor,
+                    retry_statuses: retry_statuses,
+                    retry_methods: retry_methods, http_callback: http_callback,
+                    proxy_settings: proxy_settings,
+                    logging_configuration: logging_configuration,
+                    environment: environment,
+                    custom_header_authentication_credentials: custom_header_authentication_credentials
+                  )
+                else
+                  config
+                end
+      user_agent_params = BaseApi.user_agent_parameters
+
+      @global_configuration = GlobalConfiguration.new(client_configuration: @config)
+                                                 .base_uri_executor(@config.method(:get_base_uri))
+                                                 .global_errors(BaseApi::GLOBAL_ERRORS)
+                                                 .user_agent(BaseApi.user_agent,
+                                                             agent_parameters: user_agent_params)
+
+      initialize_auth_managers(@global_configuration)
+      @global_configuration = @global_configuration.auth_managers(@auth_managers)
+    end
+
+    # Initializes the auth managers hash used for authenticating API calls.
+    # @param [GlobalConfiguration] global_config The global configuration of the SDK)
+    def initialize_auth_managers(global_config)
+      @auth_managers = {}
+      http_client_config = global_config.client_configuration
+      %w[api_key].each { |auth| @auth_managers[auth] = nil }
+      @auth_managers['api_key'] = CustomHeaderAuthentication.new(
+        http_client_config.custom_header_authentication_credentials
+      )
+    end
+
+    # Creates a client directly from environment variables.
+    def self.from_env(**overrides)
+      default_config = Configuration.build_default_config_from_env
+      new_config = default_config.clone_with(**overrides)
+      new(config: new_config)
+    end
+  end
+end