apimatic-tql-sdk 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f17616cccc9924a2b32b77928484e5059d59aafe59799b83c163ea0ca8c8fca
-  data.tar.gz: 4aefe8f560d4933b14a2aae9e1b134909972b38be2ffe403ee68d1f5473d19fd
+  metadata.gz: f5a4f7b263108049a56409f08f9a2eda6892721f7372e9eac824c9f169b18924
+  data.tar.gz: 22dda9b183436153027b8aec4294644df2e1e6fade6dc86bab142d213f3a96fc
 SHA512:
-  metadata.gz: 965c001bdf3d38c93c37d4c54a014d5efa4b2732d1db90ec51946b90998b63bdf95dbdc6c0ed10792d4de2cbc555645ef9bbc28c8600a72550a6936d2167ecf5
-  data.tar.gz: 9471e1d80168cdd85ef293aaa05d59860b04012e3207e314be29074b3a6ede4e3f0ec13d1edfc90708aa1cf4cbe31025753ab6a9eb3874fe629c802a7fb3a7a7
+  metadata.gz: 81464d9b860c769148efddebc588d04856406b86d907c467c152c27b019e0cb2298e9123db9b2737069eaef5d6e58ec8756ee2eb3d60cb24d6212f7371823a6c
+  data.tar.gz: 15509a990832d41770c4927a9405abf4d80ba6b9fb17f8280047f1defbee35ac44aa70d6b4c69785a86ce14227f1d33d6b131f600cae4c4fe761b7a9737c7405

data/README.md

@@ -1,210 +1,161 @@
-
-# Getting Started with TQL <> OTR — Factoring Data Exchange
-
-## Introduction
-
-### Overview
-
-The **TQL &lt;&gt; OTR Factoring Data Exchange** API enables factoring clients to submit carrier invoices against loads managed by TQL, upload supporting documentation, search for invoices, and check processing status including any outstanding exceptions.
-
-#### Key Capabilities
-
-- **Invoice Submission** — `POST /api/invoices` — Submit a factoring company invoice referencing a TQL load, including carrier details, stops, charges, and reference numbers.
-- **Invoice Search** — `POST /api/invoices/search` — Search and retrieve a paginated list of invoices with status and last-updated timestamps.
-- **Invoice Status** — `GET /api/invoices/{invoiceNumber}` — Retrieve the current processing status of an invoice, including any outstanding exceptions.
-- **Document Upload** — `POST /api/documents` — Upload a supporting document (BOL, rate confirmation, proof of delivery, etc.) via `multipart/form-data` and link it to an invoice. Supports arbitrary key-value tags for metadata.
-- **Carrier Assignment** — `PUT /api/assignments` — Notify TQL that a factoring company has been assigned to (or unassigned from) a carrier, including the effective date.
-- **Load Lookup** — `GET /api/loads/{loadNumber}` — Verify a load exists in TQL's system and retrieve basic details (carrier, status, dates).
-- **Load Search** — `POST /api/loads/search` — Search for TQL loads by carrier, date range, or status.
-
-#### Authentication
-
-This API uses **[OAuth 2.0 Client Credentials](https://datatracker.ietf.org/doc/html/rfc6749#section-4.4)** for authentication. TQL will provision each factoring partner with a unique **Client ID** and **Client Secret** during onboarding.
-
-**How it works:**
-
-1. **Obtain an access token** — Make a `POST` request to the TQL
-   token endpoint with your Client ID and Client Secret using the
-   `client_credentials` grant type.
-
-2. **Include the token** — Pass the access token as a Bearer token
-   in the `Authorization` header on every API request:
-   `Authorization: Bearer <access_token>`
-
-3. **Token expiry** — Access tokens have a limited lifetime
-   (typically 1 hour). When the token expires, request a new one from
-   the token endpoint. Do **not** request a new token on every API
-   call — cache and reuse the token until it expires.
-
-**Required scopes:**
-
-- **`Factoring.Write`** — Submit invoices, upload documents, manage assignments
-- **`Factoring.Read`** — Query invoice status, search invoices
-  The scopes your client is allowed to request are configured during onboarding. Include the required scope(s) in the `scope` parameter when requesting a token.
-
-**Example token request:**
-
-POST /oauth2/token HTTP/1.1
-Content-Type: application/x-www-form-urlencoded
-
-    grant_type=client_credentials
-    &client_id=<your_client_id>
-    &client_secret=<your_client_secret>
-    &scope=Factoring.Write Factoring.Read
-
-TQL will provide the exact token endpoint URL, Client ID, and Client Secret during partner onboarding.
-
-#### Philosophy
-
-- **Authentication** — All endpoints require a valid OAuth 2.0 Bearer token in the `Authorization` header. See the **Authentication** section above for details.
-- **Asynchronous processing** — Write endpoints return `202 Accepted` immediately; poll `GET /api/invoices/{invoiceNumber}` for completion and exceptions.
-- **Error handling** — Non-2xx responses follow [RFC 7807 Problem Details](https://datatracker.ietf.org/doc/html/rfc7807) with `title`, `status`, and `detail` fields.
-
-## Install the Package
-
-Install the gem from the command line:
-
-```bash
-gem install apimatic-tql-sdk -v 0.0.1
-```
-
-Or add the gem to your Gemfile and run `bundle`:
-
-```ruby
-gem 'apimatic-tql-sdk', '0.0.1'
-```
-
-For additional gem details, see the [RubyGems page for the apimatic-tql-sdk gem](https://rubygems.org/gems/apimatic-tql-sdk/versions/0.0.1).
-
-## 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 'tql_otr_factoring_data_exchange'
-include TqlOtrFactoringDataExchange
-```
-
-### 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/tql_otr_factoring_data_exchange
-```
-
-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/apimatic-tql-ruby-sdk/tree/0.0.1/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: 30** |
-| 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/apimatic-tql-ruby-sdk/tree/0.0.1/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
-| logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.1/doc/logging-configuration.md) | The SDK logging configuration for API calls |
-| client_credentials_auth_credentials | [`ClientCredentialsAuthCredentials`](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.1/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
-
-The API client can be initialized as follows:
-
-### Code-Based Client Initialization
-
-```ruby
-require 'tql_otr_factoring_data_exchange'
-include TqlOtrFactoringDataExchange
+
+# Getting Started with Freight Financials — Webhook Ingestion API
+
+## Introduction
+
+Receives real-time event callbacks from freight audit providers (currently [Navix](https://www.navix.io)) and publishes them to Kafka for downstream processing.
+
+### Request Flow
+
+```
+Navix ──POST──▶ APIM ──validates key, stamps X-Tenant-Id──▶ Webhooks API ──publishes──▶ Kafka
+```
+
+1. **Navix** fires an HTTP callback when an event occurs (invoice created, dispute updated, etc.).
+2. **Azure API Management (APIM)** authenticates the caller via subscription key or OAuth client credentials, then forwards the request with an `X-Tenant-Id` header identifying the tenant.
+3. **This service** validates the tenant header, deserializes the Navix payload, maps it to a provider-agnostic domain event, and publishes it to a Kafka topic.
+4. **Downstream consumers** (the Events function app) process the domain events asynchronously.
+
+### Authentication
+
+This API does **not** use Entra ID / OAuth for inbound requests. Authentication is handled at the APIM layer.
+
+All requests must include the **`X-Tenant-Id`** header. Requests without this header receive a `401 Unauthorized` response.
+
+When testing from Swagger UI, click the **Authorize** button and enter your tenant identifier in the `X-Tenant-Id` field.
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install apimatic-tql-sdk -v 0.0.2
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'apimatic-tql-sdk', '0.0.2'
+```
+
+For additional gem details, see the [RubyGems page for the apimatic-tql-sdk gem](https://rubygems.org/gems/apimatic-tql-sdk/versions/0.0.2).
+
+## 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 'freight_financials_webhook_ingestion_api'
+include FreightFinancialsWebhookIngestionApi
+```
+
+### 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/freight_financials_webhook_ingestion_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/apimatic-tql-ruby-sdk/tree/0.0.2/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: 30** |
+| 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/apimatic-tql-ruby-sdk/tree/0.0.2/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.2/doc/logging-configuration.md) | The SDK logging configuration for API calls |
+
+The API client can be initialized as follows:
+
+### Code-Based Client Initialization
+
+```ruby
+require 'freight_financials_webhook_ingestion_api'
+include FreightFinancialsWebhookIngestionApi
 
 client = Client.new(
-  client_credentials_auth_credentials: ClientCredentialsAuthCredentials.new(
-    oauth_client_id: 'OAuthClientId',
-    oauth_client_secret: 'OAuthClientSecret',
-    oauth_scopes: [
-      OauthScope::FACTORING_WRITE,
-      OauthScope::FACTORING_READ
-    ]
-  ),
-  logging_configuration: LoggingConfiguration.new(
-    log_level: Logger::INFO,
-    request_logging_config: RequestLoggingConfiguration.new(
-      log_body: true
-    ),
-    response_logging_config: ResponseLoggingConfiguration.new(
-      log_headers: true
-    )
+  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 'tql_otr_factoring_data_exchange'
-include TqlOtrFactoringDataExchange
+)
+```
+
+### Environment-Based Client Initialization
+
+```ruby
+require 'freight_financials_webhook_ingestion_api'
+include FreightFinancialsWebhookIngestionApi
 
 # Create client from environment
-client = Client.from_env
-```
-
-See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.1/doc/environment-based-client-initialization.md) section for details.
-
-## Authorization
-
-This API uses the following authentication schemes.
-
-* [`bearerAuth (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.1/doc/auth/oauth-2-client-credentials-grant.md)
-
-## List of APIs
-
-* [Invoices](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.1/doc/controllers/invoices.md)
-* [Documents](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.1/doc/controllers/documents.md)
-* [Assignments](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.1/doc/controllers/assignments.md)
-* [Loads](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.1/doc/controllers/loads.md)
-
-## SDK Infrastructure
-
+client = Client.from_env
+```
+
+See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.2/doc/environment-based-client-initialization.md) section for details.
+
+## List of APIs
+
+* [Assignments](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.2/doc/controllers/assignments.md)
+* [Documents](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.2/doc/controllers/documents.md)
+* [Freight Audit](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.2/doc/controllers/freight-audit.md)
+* [Invoices](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.2/doc/controllers/invoices.md)
+* [Loads](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.2/doc/controllers/loads.md)
+* [Rating](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.2/doc/controllers/rating.md)
+
+## SDK Infrastructure
+
 ### Configuration
 
-* [ProxySettings](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.1/doc/proxy-settings.md)
-* [Environment-Based Client Initialization](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.1/doc/environment-based-client-initialization.md)
-* [AbstractLogger](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.1/doc/abstract-logger.md)
-* [LoggingConfiguration](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.1/doc/logging-configuration.md)
-* [RequestLoggingConfiguration](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.1/doc/request-logging-configuration.md)
-* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.1/doc/response-logging-configuration.md)
+* [ProxySettings](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.2/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.2/doc/environment-based-client-initialization.md)
+* [AbstractLogger](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.2/doc/abstract-logger.md)
+* [LoggingConfiguration](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.2/doc/logging-configuration.md)
+* [RequestLoggingConfiguration](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.2/doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.2/doc/response-logging-configuration.md)
 
 ### HTTP
 
-* [HttpResponse](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.1/doc/http-response.md)
-* [HttpRequest](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.1/doc/http-request.md)
+* [HttpResponse](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.2/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.2/doc/http-request.md)
 
 ### Utilities
 
-* [ApiResponse](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.1/doc/api-response.md)
-* [ApiHelper](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.1/doc/api-helper.md)
-* [DateTimeHelper](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.1/doc/date-time-helper.md)
-
+* [ApiResponse](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.2/doc/api-response.md)
+* [ApiHelper](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.2/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/sdks-io/apimatic-tql-ruby-sdk/tree/0.0.2/doc/date-time-helper.md)
+

data/bin/console

@@ -4,11 +4,11 @@
 $LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
 
 # Require the gem
-require 'tql_otr_factoring_data_exchange'
+require 'freight_financials_webhook_ingestion_api'
 
-puts 'TqlOtrFactoringDataExchange SDK loaded!'
-puts 'You can now create a client with: client = TqlOtrFactoringDataExchange::Client.new'
-puts 'Or use from_env: client = TqlOtrFactoringDataExchange::Client.from_env'
+puts 'FreightFinancialsWebhookIngestionApi SDK loaded!'
+puts 'You can now create a client with: client = FreightFinancialsWebhookIngestionApi::Client.new'
+puts 'Or use from_env: client = FreightFinancialsWebhookIngestionApi::Client.from_env'
 
 # Start an interactive IRB session
 require 'irb'

data/lib/freight_financials_webhook_ingestion_api/api_helper.rb

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

data/lib/freight_financials_webhook_ingestion_api/apis/assignments_api.rb

@@ -0,0 +1,41 @@
+# freight_financials_webhook_ingestion_api
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module FreightFinancialsWebhookIngestionApi
+  # AssignmentsApi
+  class AssignmentsApi < BaseApi
+    # TODO: type endpoint description here
+    # @param [String] x_tenant_id Required parameter: Tenant identifier stamped
+    # by APIM. Required on all requests.
+    # @param [AssignmentRequest] body Required parameter: Cancellation token.
+    # @param [String] api_version Optional parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def assign_or_unassign_factoring_company(x_tenant_id,
+                                             body,
+                                             api_version: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/api/v1/Assignments',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_tenant_id, key: 'X-Tenant-Id')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .query_param(new_parameter(api_version, key: 'api-version'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AssignmentResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Missing required fields or invalid data.',
+                                 ProblemDetailsException))
+        .execute
+    end
+  end
+end

data/lib/{tql_otr_factoring_data_exchange → freight_financials_webhook_ingestion_api}/apis/base_api.rb

@@ -1,38 +1,38 @@
-# tql_otr_factoring_data_exchange
-#
-# This file was automatically generated by
-# APIMATIC v3.0 ( https://www.apimatic.io ).
-
-module TqlOtrFactoringDataExchange
-  # BaseApi.
-  class BaseApi
-    include CoreLibrary
-    attr_accessor :config, :http_call_back
-
-    def self.user_agent
-      'Ruby-SDK/0.0.1 (OS: {os-info}, Engine: {engine}/{engine-version})'
-    end
-
-    def self.user_agent_parameters
-      {
-        '{engine}' => { 'value' => RUBY_ENGINE, 'encode' => false },
-        '{engine-version}' => { 'value' => RUBY_ENGINE_VERSION, 'encode' => false },
-        '{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
+# freight_financials_webhook_ingestion_api
+#
+# This file was automatically
+# generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module FreightFinancialsWebhookIngestionApi
+  # BaseApi.
+  class BaseApi
+    include CoreLibrary
+    attr_accessor :config, :http_call_back
+
+    def self.user_agent
+      'Ruby-SDK/0.0.2 (OS: {os-info}, Engine: {engine}/{engine-version})'
+    end
+
+    def self.user_agent_parameters
+      {
+        '{engine}' => { 'value' => RUBY_ENGINE, 'encode' => false },
+        '{engine-version}' => { 'value' => RUBY_ENGINE_VERSION, 'encode' => false },
+        '{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
 
@@ -40,28 +40,28 @@ module TqlOtrFactoringDataExchange
     # @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
+    # @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