apimatic-tql-sdk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9f17616cccc9924a2b32b77928484e5059d59aafe59799b83c163ea0ca8c8fca
+  data.tar.gz: 4aefe8f560d4933b14a2aae9e1b134909972b38be2ffe403ee68d1f5473d19fd
+SHA512:
+  metadata.gz: 965c001bdf3d38c93c37d4c54a014d5efa4b2732d1db90ec51946b90998b63bdf95dbdc6c0ed10792d4de2cbc555645ef9bbc28c8600a72550a6936d2167ecf5
+  data.tar.gz: 9471e1d80168cdd85ef293aaa05d59860b04012e3207e314be29074b3a6ede4e3f0ec13d1edfc90708aa1cf4cbe31025753ab6a9eb3874fe629c802a7fb3a7a7

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,210 @@
+
+# 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
+
+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
+    )
+  )
+)
+```
+
+### Environment-Based Client Initialization
+
+```ruby
+require 'tql_otr_factoring_data_exchange'
+include TqlOtrFactoringDataExchange
+
+# 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
+
+### 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)
+
+### 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)
+
+### 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)
+

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 'tql_otr_factoring_data_exchange'
+
+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'
+
+# Start an interactive IRB session
+require 'irb'
+IRB.start

data/lib/tql_otr_factoring_data_exchange/api_helper.rb

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

data/lib/tql_otr_factoring_data_exchange/apis/assignments_api.rb

@@ -0,0 +1,45 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # AssignmentsApi
+  class AssignmentsApi < BaseApi
+    # Notify TQL that a factoring company has been assigned to — or unassigned
+    # from — a carrier. The request is idempotent; sending the same carrier +
+    # status combination again is a no-op.
+    # The `effectiveDate` field indicates the date the assignment or
+    # un-assignment took effect (i.e., the "as of" date).
+    # **Load event webhooks:** Assigning a carrier also serves as a subscription
+    # to load event webhooks for that carrier. Once a carrier is assigned, TQL
+    # will begin pushing webhook notifications (e.g., Load Created, Load
+    # Dispatched, Load Delivered) for loads where that carrier is the assigned
+    # carrier. Unassigning the carrier stops these notifications. The webhook
+    # endpoint URL is configured during partner onboarding.
+    # @param [AssignmentRequest] body Required parameter: The carrier assignment
+    # payload including carrier identity, assignment status, and effective
+    # date.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def upsert_assignment(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/api/assignments',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AssignmentResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 "Validation error — missing required fields or invalid data.\n",
+                                 ProblemDetailsErrorException))
+        .execute
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/apis/base_api.rb

@@ -0,0 +1,67 @@
+# 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
+      @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/tql_otr_factoring_data_exchange/apis/documents_api.rb

@@ -0,0 +1,82 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # DocumentsApi
+  class DocumentsApi < BaseApi
+    # Upload a document via `multipart/form-data` and associate it with an
+    # invoice. The request contains two parts:
+    # - **file** — the raw binary document content
+    # - **metadata** — a JSON string containing the invoice ID,
+    #   document type, optional file name, and key-value tags
+    #   (e.g., `"shortage": "2"`, `"palletCount": "14"`)
+    # **Supported document types** are listed in the `DocumentType` enum.
+    # Accepted asynchronously — returns `202` with a document receipt. To upload
+    # multiple documents, make one request per document.
+    # @param [File | UploadIO] file Required parameter: The document file
+    # content.
+    # @param [DocumentUploadMetadata] metadata Required parameter: Metadata for
+    # the document upload, provided as the `metadata` part of the
+    # `multipart/form-data` request. Specifies the invoice linkage, document
+    # classification, and optional tags.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def upload_document(file,
+                        metadata)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/documents',
+                                     Server::DEFAULT)
+                   .multipart_param(new_parameter(file, key: 'file')
+                                     .is_required(true)
+                                     .default_content_type('application/octet-stream'))
+                   .multipart_param(new_parameter(StringIO.new(metadata.to_json), key: 'metadata')
+                                     .is_required(true)
+                                     .default_content_type('application/json'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(DocumentUploadResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 "Validation error — missing required fields or invalid document'\
+                                  ' type.\n",
+                                 ProblemDetailsErrorException))
+        .execute
+    end
+
+    # Upload a document as a base64-encoded string in a JSON request body and
+    # associate it with an invoice. Use this endpoint when `multipart/form-data`
+    # is inconvenient (e.g., from environments that prefer pure JSON payloads).
+    # **Supported document types** are listed in the `DocumentType` enum.
+    # Accepted asynchronously — returns `202` with a document receipt. To upload
+    # multiple documents, make one request per document.
+    # @param [Base64DocumentUploadRequest] body Required parameter: A JSON
+    # payload containing the base64-encoded document content along with invoice
+    # linkage, document type, and optional tags.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def upload_document_base64(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/documents/base64',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(DocumentUploadResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 "Validation error — missing required fields or invalid document'\
+                                  ' type.\n",
+                                 ProblemDetailsErrorException))
+        .execute
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/apis/invoices_api.rb

@@ -0,0 +1,114 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # InvoicesApi
+  class InvoicesApi < BaseApi
+    # Submit a factoring company invoice against a TQL load. The request must
+    # include the TQL load number, the factoring company's invoice number,
+    # carrier details, at least two stops (origin and destination), one or more
+    # charges, and at least one reference number.
+    # The invoice is accepted asynchronously — a `202 Accepted` response is
+    # returned immediately with the generated invoice ID. Use `GET
+    # /api/invoices/{invoiceNumber}` to poll for processing completion and to
+    # retrieve any exceptions.
+    # @param [SubmitInvoiceRequest] body Required parameter: The factoring
+    # company invoice payload including TQL load number, factoring company
+    # invoice number, carrier information, stops, charges, reference numbers,
+    # and operational dates.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def submit_invoice(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/invoices',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SubmitInvoiceResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 "Validation error — the request body is missing required fields'\
+                                  ' or contains invalid data. Review the `detail` field for'\
+                                  ' specifics.\n",
+                                 ProblemDetailsErrorException))
+        .execute
+    end
+
+    # Retrieve the current processing status of a previously submitted invoice.
+    # If processing is complete, the response indicates success. If there are
+    # outstanding exceptions (missing documents, charge discrepancies, data
+    # mismatches, etc.), they are listed in the `exceptions` array.
+    # This endpoint also confirms whether data you submitted has been ingested —
+    # if `status` is `Received` or beyond, the data is in the system.
+    # @param [String] invoice_number Required parameter: The factoring company's
+    # invoice number (provided when submitting via `POST /api/invoices`).
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_invoice_status(invoice_number)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/invoices/{invoiceNumber}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(invoice_number, key: 'invoiceNumber')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(InvoiceStatusResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('404',
+                                 "Invoice not found — no invoice exists with the specified'\
+                                  ' invoice number.\n",
+                                 ProblemDetailsErrorException))
+        .execute
+    end
+
+    # Search for invoices using optional filter criteria. Returns a paginated
+    # list of invoice summaries including the invoice ID, a direct URI to
+    # retrieve full details, the factoring company invoice number, TQL load
+    # number, current status, and the last-updated timestamp.
+    # **Scoping:** Results are automatically scoped to invoices submitted by the
+    # authenticated factoring company. You will only see invoices where *you*
+    # are the factor — you cannot query invoices submitted by other parties.
+    # **Filter logic:** Filters use **AND** across different fields and **OR**
+    # within array-valued fields. For example, searching with `lastUpdatedAfter
+    # = 2026-04-03` **and** `statuses = [Approved, PendingExceptions]` returns
+    # invoices updated today that are in *either* `Approved` or
+    # `PendingExceptions` status.
+    # This is a synchronous call — results are returned immediately.
+    # @param [InvoiceSearchRequest] body Required parameter: Search filters and
+    # pagination parameters. All filter fields are optional — omit a field to
+    # skip that filter. Provide at least `page` and `pageSize` for pagination.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def search_invoices(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/invoices/search',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(InvoiceSearchResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 "Validation error — invalid filter criteria or pagination'\
+                                  ' parameters.\n",
+                                 ProblemDetailsErrorException))
+        .execute
+    end
+  end
+end

data/lib/tql_otr_factoring_data_exchange/apis/loads_api.rb

@@ -0,0 +1,68 @@
+# tql_otr_factoring_data_exchange
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module TqlOtrFactoringDataExchange
+  # LoadsApi
+  class LoadsApi < BaseApi
+    # Retrieve basic details for a TQL load by its load number. Use this to
+    # verify a load exists in TQL's system and to confirm carrier assignment,
+    # load status, and shipment dates before submitting an invoice.
+    # @param [String] load_number Required parameter: The TQL load number.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_load(load_number)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/loads/{loadNumber}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(load_number, key: 'loadNumber')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(LoadDetail.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('404',
+                                 "Load not found — no load exists with the specified load number'\
+                                  '.\n",
+                                 ProblemDetailsErrorException))
+        .execute
+    end
+
+    # Search for TQL loads using optional filter criteria. Returns a paginated
+    # list of load summaries. Use this to find loads by carrier, date range, or
+    # status.
+    # **Scoping:** Results are scoped to loads where the authenticated factoring
+    # company's assigned carriers are the carrier on the load.
+    # **Filter logic:** Filters use **AND** across different fields and **OR**
+    # within array-valued fields.
+    # @param [LoadSearchRequest] body Required parameter: Search filters and
+    # pagination parameters. All filter fields are optional — omit a field to
+    # skip that filter.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def search_loads(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/loads/search',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(LoadSearchResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 "Validation error — invalid filter criteria or pagination'\
+                                  ' parameters.\n",
+                                 ProblemDetailsErrorException))
+        .execute
+    end
+  end
+end