apimatic-tql-sdk 0.0.1__py3-none-any.whl

apimatic_tql_sdk-0.0.1.dist-info/METADATA

@@ -0,0 +1,197 @@
+Metadata-Version: 2.4
+Name: apimatic-tql-sdk
+Version: 0.0.1
+Summary: this is a sample SDK generated by APIMatic
+Author-email: developer sdksio <developer+sdksio@apimatic.io>
+Project-URL: Documentation, https://apimatic.io
+Keywords: Apimatic,sdksio
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: apimatic-core>=0.2.24,~=0.2.0
+Requires-Dist: apimatic-core-interfaces>=0.1.8,~=0.1.0
+Requires-Dist: apimatic-requests-client-adapter>=0.1.10,~=0.1.0
+Requires-Dist: python-dotenv<2.0,>=0.21
+Provides-Extra: testutils
+Requires-Dist: pytest>=7.2.2; extra == "testutils"
+Dynamic: license-file
+
+
+# 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
+
+The package is compatible with Python versions `3.7+`.
+Install the package from PyPi using the following pip command:
+
+```bash
+pip install apimatic-tql-sdk==0.0.1
+```
+
+You can also view the package at:
+https://pypi.python.org/pypi/apimatic-tql-sdk/0.0.1
+
+## Initialize the API Client
+
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.1/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| http_client_instance | `Union[Session, HttpClientProvider]` | The Http Client passed from the sdk user for making requests |
+| override_http_client_configuration | `bool` | The value which determines to override properties of the passed Http Client from the sdk user |
+| http_call_back | `HttpCallBack` | The callback value that is invoked before and after an HTTP call is made to an endpoint |
+| timeout | `float` | The value to use for connection timeout. <br> **Default: 30** |
+| max_retries | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
+| backoff_factor | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |
+| retry_statuses | `Array of int` | The http statuses on which retry is to be done. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
+| retry_methods | `Array of string` | The http methods on which retry is to be done. <br> **Default: ["GET", "PUT"]** |
+| proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/apimatic-tql-python-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-python-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-python-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
+
+```python
+import logging
+
+from tqlotrfactoringdataexchange.configuration import Environment
+from tqlotrfactoringdataexchange.http.auth.oauth_2 import ClientCredentialsAuthCredentials
+from tqlotrfactoringdataexchange.logging.configuration.api_logging_configuration import LoggingConfiguration
+from tqlotrfactoringdataexchange.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
+from tqlotrfactoringdataexchange.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
+from tqlotrfactoringdataexchange.models.oauth_scope import OauthScope
+from tqlotrfactoringdataexchange.tqlotrfactoringdataexchange_client import TqlotrfactoringdataexchangeClient
+
+client = TqlotrfactoringdataexchangeClient(
+    client_credentials_auth_credentials=ClientCredentialsAuthCredentials(
+        oauth_client_id='OAuthClientId',
+        oauth_client_secret='OAuthClientSecret',
+        oauth_scopes=[
+            OauthScope.FACTORING_WRITE,
+            OauthScope.FACTORING_READ
+        ]
+    ),
+    environment=Environment.PRODUCTION,
+    logging_configuration=LoggingConfiguration(
+        log_level=logging.INFO,
+        request_logging_config=RequestLoggingConfiguration(
+            log_body=True
+        ),
+        response_logging_config=ResponseLoggingConfiguration(
+            log_headers=True
+        )
+    )
+)
+```
+
+### Environment-Based Client Initialization
+
+```python
+from tqlotrfactoringdataexchange.tqlotrfactoringdataexchange_client import TqlotrfactoringdataexchangeClient
+
+# Specify the path to your .env file if it’s located outside the project’s root directory.
+client = TqlotrfactoringdataexchangeClient.from_environment(dotenv_path='/path/to/.env')
+```
+
+See the [Environment-Based Client Initialization](https://www.github.com/sdks-io/apimatic-tql-python-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-python-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-python-sdk/tree/0.0.1/doc/controllers/invoices.md)
+* [Documents](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.1/doc/controllers/documents.md)
+* [Assignments](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.1/doc/controllers/assignments.md)
+* [Loads](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.1/doc/controllers/loads.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.1/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.1/doc/environment-based-client-initialization.md)
+* [AbstractLogger](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.1/doc/abstract-logger.md)
+* [LoggingConfiguration](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.1/doc/logging-configuration.md)
+* [RequestLoggingConfiguration](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.1/doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.1/doc/response-logging-configuration.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.1/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.1/doc/http-request.md)
+
+### Utilities
+
+* [ApiResponse](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.1/doc/api-response.md)
+* [ApiHelper](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.1/doc/api-helper.md)
+* [HttpDateTime](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.1/doc/http-date-time.md)
+* [RFC3339DateTime](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.1/doc/rfc3339-date-time.md)
+* [UnixDateTime](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.1/doc/unix-date-time.md)
+

apimatic_tql_sdk-0.0.1.dist-info/RECORD

@@ -0,0 +1,84 @@
+apimatic_tql_sdk-0.0.1.dist-info/licenses/LICENSE,sha256=o5qrSek4x1g9YArvhgZmSORdSoQn7unl7I44zmz7iBc,1213
+tqlotrfactoringdataexchange/__init__.py,sha256=VnZilFdfoa9u8b6AaheNasQssg1k699lzr4cVhe9sWg,298
+tqlotrfactoringdataexchange/api_helper.py,sha256=rUG29guytQnW80QiOIKHqN8_2e1YOEJa5yezHN7R-dc,555
+tqlotrfactoringdataexchange/configuration.py,sha256=6hfS6lak2BiDsdqb7GDE908aRQgtCNBJOvOSdZVE1Hg,9686
+tqlotrfactoringdataexchange/tqlotrfactoringdataexchange_client.py,sha256=ghtFVQPso_XhXgV8zjpLvY3UX2SX90GDHUur99I9bHE,4146
+tqlotrfactoringdataexchange/apis/__init__.py,sha256=yu3mlRsjP_mcb-h3N-fE6zHmKhi7mmMOxnVuv2kZXms,254
+tqlotrfactoringdataexchange/apis/assignments_api.py,sha256=4OkKvuKaqt-ps2nQNWnI22YPPc7JOh2qFRFdkYSNEv0,3794
+tqlotrfactoringdataexchange/apis/base_api.py,sha256=GAzuapCJlyrFv6S6flGnrVpP6Wd4aofwsRLwzIE2TAA,2315
+tqlotrfactoringdataexchange/apis/documents_api.py,sha256=woW9HXPWyRvpGw25Vkb0i5FMIJGjLFvD2W-NZJg2bIM,6403
+tqlotrfactoringdataexchange/apis/invoices_api.py,sha256=v3cLMBBz_24mCxPzTnB_5UVQg64lwbdr2r53q4YhxZ8,9173
+tqlotrfactoringdataexchange/apis/loads_api.py,sha256=x_6LHvGNMHm7Bki6Ezqt2Cs319y8cQubCtF8NmYVUu8,5331
+tqlotrfactoringdataexchange/apis/oauth_authorization_api.py,sha256=4R12FRqOPY48RKK_mjIhgpa09pPyZ2y_E01xQNjLUP4,3500
+tqlotrfactoringdataexchange/exceptions/__init__.py,sha256=f-RsLxXBUlJAC1qwYNZ2ZOryctPKqiRveqGIuAMy6kM,215
+tqlotrfactoringdataexchange/exceptions/api_exception.py,sha256=z9fLm7v41ktFbBq3I0OhK37sy7z6k5ZrT2Otn34wZ7k,1106
+tqlotrfactoringdataexchange/exceptions/oauth_provider_exception.py,sha256=-gJ9oBhfETqKbIVPNGK3kNSf0QP-eVaThytrEh_6OEw,2411
+tqlotrfactoringdataexchange/exceptions/problem_details_error_exception.py,sha256=sE6mEm66iC6lSAgxCVsZQSx_FGEVz7D6U1v2hOazsG8,2401
+tqlotrfactoringdataexchange/http/__init__.py,sha256=0inmS5sUVyFFK7c7ivfex-inFU1efoAoOvqBEEhTLVo,276
+tqlotrfactoringdataexchange/http/api_response.py,sha256=iAVhy4dJybkrWgnVOmCnLe_4hKhMgCUH7dl5EoSxP80,1989
+tqlotrfactoringdataexchange/http/http_call_back.py,sha256=Lr5d-PwawXlLMUc9xHjAMJIaVVIUnAhclrkIW88N4zA,481
+tqlotrfactoringdataexchange/http/http_client_provider.py,sha256=nBS3supKOuxPZ80qv_E0L2w8jpg4ggpjbrD5QLxC1Vs,749
+tqlotrfactoringdataexchange/http/http_method_enum.py,sha256=sBGxcYjKYvy5xx56cYX7nbh3GMJwUvIzjoKSEmbxp8g,496
+tqlotrfactoringdataexchange/http/http_request.py,sha256=isYOgPwIo3YdF7fNvTPKcC0e3rSinq7xoMVYzUhgad8,1896
+tqlotrfactoringdataexchange/http/http_response.py,sha256=6iyqezmcrDlJ4Vy1ZtmCF7DHbMarHaeHwx4hkPTJqfU,1491
+tqlotrfactoringdataexchange/http/proxy_settings.py,sha256=INtptKcoUWUTkJwP0_K1coh5RBzeYKNA0yoToCEGXi4,1470
+tqlotrfactoringdataexchange/http/auth/__init__.py,sha256=BNvPkLRZhAb4PgmqDviB26Bc-NqLU_MdAEZ8DYmxrTI,136
+tqlotrfactoringdataexchange/http/auth/oauth_2.py,sha256=Z4rQ_ADY0Y3QDwVpacS2o5bMYw3vLOTITkYB0PY680g,12024
+tqlotrfactoringdataexchange/logging/__init__.py,sha256=1T_Geb9czAiw7EJDOWfKErjKAmWTkaWBEZBk54UU5bY,161
+tqlotrfactoringdataexchange/logging/sdk_logger.py,sha256=WXoN6rcAy9he5aUCZV6iYzBQt4vRbw0tm4OIUTj19sY,689
+tqlotrfactoringdataexchange/logging/configuration/__init__.py,sha256=HTzMD3CB83jTxGL56Xt5PCqAmFN9GWO6LxcdZ7tN-DA,154
+tqlotrfactoringdataexchange/logging/configuration/api_logging_configuration.py,sha256=HVqT74A2ZTTM12tGC2wDqKk77SWV2v80IZp2oCeWQ6Y,15463
+tqlotrfactoringdataexchange/models/__init__.py,sha256=QtAJSpzCjZ8K1b-3yj6hvg5uDDfHZXyhfJPBZfC6aNo,1229
+tqlotrfactoringdataexchange/models/assignment_request.py,sha256=cMuUqmGdm64Ufzowe54EgcnDP4wAt3J3G51qCQQaa6U,7682
+tqlotrfactoringdataexchange/models/assignment_response.py,sha256=9qF7EOI8NWjatggD39ZFKWqVnsG2J6zUoA5HSz-G91Y,6825
+tqlotrfactoringdataexchange/models/assignment_status.py,sha256=eCyjA2QmrjD69Ae4WACRH-_O8nWeaj3cFvSvfJLJbj4,1642
+tqlotrfactoringdataexchange/models/base_64_document.py,sha256=lcLWZALTJ1gFGXiHiFz8cCCEQVfbW4oR66bDmioahGI,6010
+tqlotrfactoringdataexchange/models/base_64_document_upload_request.py,sha256=-rFsdNTQuwvIvBm0FaegbXbrtmyh9WTX2J0PanqRIY4,5168
+tqlotrfactoringdataexchange/models/carrier.py,sha256=jAmatcgG7uHOH73uvw3MOoXJxBs5F4upo88aJduDieI,4659
+tqlotrfactoringdataexchange/models/carrier_1.py,sha256=s2ZiRJf4rroYyQ9mXH_y1cKdkFynZPLSK-T7gbjr018,4848
+tqlotrfactoringdataexchange/models/carrier_2.py,sha256=VPZ5LrObtTkbg6KbhKlUH5y2QUwkSboD1UeFs1FbWNI,4820
+tqlotrfactoringdataexchange/models/carrier_input.py,sha256=h1lozdTgM5-a-4g7w8KLDJR6jkIouu476LPXoGjBUE0,6498
+tqlotrfactoringdataexchange/models/carrier_input_1.py,sha256=OsU-awIR-jLx1NxTCb3yNLWqOihjUEGejPlem3Lnb3o,6499
+tqlotrfactoringdataexchange/models/charge_code.py,sha256=Jpq9nLLd8ycGSiXqOgBhR66Irid4xZsYv8MEUu8rp3M,6511
+tqlotrfactoringdataexchange/models/charge_code_origin.py,sha256=RvtZWcb6y1Qow-36Wi-DXNusdWSFEfXgIm20Ud-rImQ,1893
+tqlotrfactoringdataexchange/models/charge_input.py,sha256=cp2xNUAwf6ERPIloI3ASxw1XKv2Bp0jEVXTT9xLqKIQ,7772
+tqlotrfactoringdataexchange/models/document.py,sha256=JyBJ-NigQbch7_sZNdeBIyEqXiuSPDTaC4ScS1bJl_k,4103
+tqlotrfactoringdataexchange/models/document_type.py,sha256=K2f2aVKa_xmOBaE80rY6S4MyDBFNOJ8qG-9G08StD7U,7416
+tqlotrfactoringdataexchange/models/document_upload_metadata.py,sha256=Bzg_jHJKYq8Z189Qf7FQ7V93uiFkViN2kGj0x-vdm_c,5535
+tqlotrfactoringdataexchange/models/document_upload_response.py,sha256=Xsa0CQ3_GroblHa7B2o2kBTysMwJ6fWHZdFBOlLugWA,7465
+tqlotrfactoringdataexchange/models/exception_severity.py,sha256=wIR4_ZFwWiG-cyd9I2iDGxiPE-AXH0_B7t3AJH6-YZg,1345
+tqlotrfactoringdataexchange/models/factoring_company_input.py,sha256=Ph7I8ua_JCoZWl-f_ovfyJEcM03J1PfqvNB8fiBjXU8,5960
+tqlotrfactoringdataexchange/models/invoice.py,sha256=nvmDtV7ddESYdYzvP06Pglky8aNT1yrGZUgu_QImdGE,13495
+tqlotrfactoringdataexchange/models/invoice_exception.py,sha256=SB8iFR_VzBUm6G85vCQfHRFTZtBh9vbNgKwYOnY9PrM,7087
+tqlotrfactoringdataexchange/models/invoice_item_input.py,sha256=fbGzhVMQvHgeP4XkWyVDd4fGLjTdjI2EooOC_mVFzCY,9618
+tqlotrfactoringdataexchange/models/invoice_search_request.py,sha256=5PfAB2MUNmWWe0HuFkD-Yim_4pXH9mot78XPZUoFIgo,14476
+tqlotrfactoringdataexchange/models/invoice_search_response.py,sha256=SEee9J6DhMOZbqfcb3mfJVNesEeXgY4lt2CBcw74aGg,6361
+tqlotrfactoringdataexchange/models/invoice_status.py,sha256=Z2Zac2gGU12H6maCAPaMBPYjSNmM-YdcU_gAMsoJRFk,2210
+tqlotrfactoringdataexchange/models/invoice_status_response.py,sha256=_DGyCXxHSzLsIYtEoe4C_d3WICJqiwmc2MNhEP38Ey8,11004
+tqlotrfactoringdataexchange/models/invoice_type.py,sha256=Xy5bq9GDgsb0p3BiuYzuZUPvHzzA4G8cxt9NHyiXJbg,2475
+tqlotrfactoringdataexchange/models/load.py,sha256=e3JKKk2I4aDzdgG0TYrlYbNx_PcCN9ICbiLfmJS2Mew,5883
+tqlotrfactoringdataexchange/models/load_detail.py,sha256=2Spj4Q2iKrkgczcX7GbaoeV1luHPpvXwzSQkmvIcX7Y,8272
+tqlotrfactoringdataexchange/models/load_search_request.py,sha256=IMPWetpBiMaf0aiRdzmvp-AS2OwMNsmjTwaHujZEbLY,13308
+tqlotrfactoringdataexchange/models/load_search_response.py,sha256=XB2wRXDk5rNuZtu_GNZpLLIxzFsjRWTwvWKLIjqrdwo,6356
+tqlotrfactoringdataexchange/models/load_status.py,sha256=jSnG4LusM_L2w-PMJHLGnCaNwiGRaUE0TA1qpzgKk4k,1642
+tqlotrfactoringdataexchange/models/location.py,sha256=2qMyfYqjWDfFSgYj3o6wyirz-AOW9dh3yb63UqxPF-E,7952
+tqlotrfactoringdataexchange/models/oauth_provider_error.py,sha256=yWa8Q1BdBz2YaGN7b969rh3lkayDMTYrZNeR_AK_Gtw,2540
+tqlotrfactoringdataexchange/models/oauth_scope.py,sha256=yX9lqgU3NKnkA8bWTg_RU2AQZ-9Am9TGPGE9xKNGTPk,1337
+tqlotrfactoringdataexchange/models/oauth_token.py,sha256=MyhQ5gUcj3LTneWp_IRd8tEqO9QmTNKMtF90eCxAkFE,3618
+tqlotrfactoringdataexchange/models/payment.py,sha256=4ddsFfIlydvIQjg-PiRV9351BsVOr30d97nh8tlUFyg,5762
+tqlotrfactoringdataexchange/models/problem_details.py,sha256=iVjRTHxVa7Xf-Ae33xYAUT-j158nTWFGe4C5sXIxx3c,4650
+tqlotrfactoringdataexchange/models/reference_number_input.py,sha256=xwy6Hql1SRMbeYN_xdeyTLf2ODpoV-01Ve0AV_ZQrOk,5317
+tqlotrfactoringdataexchange/models/reference_type.py,sha256=N2xwUAHTM9Bo0uNiAHy8aZdWyHAILXBIg3vTli5uF0g,2510
+tqlotrfactoringdataexchange/models/status.py,sha256=CZKk1CAeQsZ0FjI3XH2YWPDa-HQT-OwVnVdd5flGjXc,1403
+tqlotrfactoringdataexchange/models/stop_input.py,sha256=0aPTnQSAdtZfVPDhi8YWum9zR2IBCjlU1zOLLWBqr9M,6142
+tqlotrfactoringdataexchange/models/stop_type.py,sha256=uF8Oif65Qv1iTfRVvrHYBCXpdRyGRQN3raLRnh3-ulg,1985
+tqlotrfactoringdataexchange/models/submit_invoice_request.py,sha256=QOm7h_2JFt57BDKXCF_2eUPexRFxYs79rAi84mvOZ_c,19268
+tqlotrfactoringdataexchange/models/submit_invoice_response.py,sha256=Cs0mITMGmp9Lnr6cXF_T0E036ERBlxqEpS3H5XEMx6c,5319
+tqlotrfactoringdataexchange/models/weight_unit.py,sha256=4YVYo_vD16AtSRMub8CqTbH-KkZmwt0FogDWGSW40P8,1552
+tqlotrfactoringdataexchange/utilities/__init__.py,sha256=pq3szt1E0U5M7qGCe9Vdl_jAM7wSgi8mj-UB-Flp6Ow,160
+tqlotrfactoringdataexchange/utilities/file_wrapper.py,sha256=pYrMhWHS92iDU-DnxTO83PTxikZdezHDiLQGWsmwpL4,1442
+tqlotrfactoringdataexchange/utilities/union_type_lookup.py,sha256=rpC7dgtGno3TEg0VXcZrfdBMkc9CdU4adT7CgnnZyGI,1727
+apimatic_tql_sdk-0.0.1.dist-info/METADATA,sha256=iANsQH0SAFkMQS8S06pNmkmFYzcYEEVBjcGUin4-ikk,10678
+apimatic_tql_sdk-0.0.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+apimatic_tql_sdk-0.0.1.dist-info/top_level.txt,sha256=5hKwHeGAF96Bg29gpCtZJJje5F_pgZUXTT-c6-DfltA,28
+apimatic_tql_sdk-0.0.1.dist-info/RECORD,,

apimatic_tql_sdk-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

apimatic_tql_sdk-0.0.1.dist-info/licenses/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

apimatic_tql_sdk-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+tqlotrfactoringdataexchange

tqlotrfactoringdataexchange/__init__.py

@@ -0,0 +1,13 @@
+# ruff: noqa: D104 | Missing docstring in public package
+# ruff: noqa: RUF022 | `__all__` is not sorted
+__all__ = [
+    "api_helper",
+    "apis",
+    "configuration",
+    "exceptions",
+    "http",
+    "logging",
+    "models",
+    "tqlotrfactoringdataexchange_client",
+    "utilities",
+]

tqlotrfactoringdataexchange/api_helper.py

@@ -0,0 +1,19 @@
+"""
+tqlotrfactoringdataexchange
+
+This file was automatically generated by APIMATIC v3.0 (
+ https://www.apimatic.io ).
+"""
+
+from apimatic_core.utilities.api_helper import ApiHelper as CoreApiHelper
+
+
+class APIHelper(CoreApiHelper):
+    """
+    A Helper Class for various functions associated with API Calls.
+
+    This class contains static methods for operations that need to be
+    performed during API requests. All of the methods inside this class are
+    static methods, there is no need to ever initialise an instance of this
+    class.
+    """

tqlotrfactoringdataexchange/apis/__init__.py

@@ -0,0 +1,10 @@
+# ruff: noqa: D104 | Missing docstring in public package
+# ruff: noqa: RUF022 | `__all__` is not sorted
+__all__ = [
+    "assignments_api",
+    "base_api",
+    "documents_api",
+    "invoices_api",
+    "loads_api",
+    "oauth_authorization_api",
+]

tqlotrfactoringdataexchange/apis/assignments_api.py

@@ -0,0 +1,95 @@
+"""tqlotrfactoringdataexchange.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+# ruff: noqa: D410, E501, E101, D206
+from apimatic_core.authentication.multiple.single_auth import (
+    Single,
+)
+from apimatic_core.request_builder import RequestBuilder
+from apimatic_core.response_handler import ResponseHandler
+from apimatic_core.types.parameter import Parameter
+
+from tqlotrfactoringdataexchange.api_helper import (
+    APIHelper,
+)
+from tqlotrfactoringdataexchange.apis.base_api import (
+    BaseApi,
+)
+from tqlotrfactoringdataexchange.configuration import (
+    Server,
+)
+from tqlotrfactoringdataexchange.exceptions.problem_details_error_exception import (
+    ProblemDetailsErrorException,
+)
+from tqlotrfactoringdataexchange.http.http_method_enum import (
+    HttpMethodEnum,
+)
+from tqlotrfactoringdataexchange.models.assignment_response import (
+    AssignmentResponse,
+)
+
+
+class AssignmentsApi(BaseApi):
+    """A Controller to access Endpoints in the tqlotrfactoringdataexchange API."""
+
+    def __init__(self, config):
+        """Initialize AssignmentsApi object."""
+        super(AssignmentsApi, self).__init__(config)
+
+    def upsert_assignment(self,
+                          body):
+        """Perform a PUT request to /api/assignments.
+
+        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.
+
+        Args:
+            body (AssignmentRequest): The carrier assignment payload including
+                carrier identity, assignment status, and effective date.
+
+        Returns:
+            ApiResponse: An object with the response value as well as other useful
+                information such as status codes and headers. Assignment accepted for
+                processing.
+
+        Raises:
+            ApiException: When an error occurs while fetching the data from the
+                remote API. This exception includes the HTTP Response code, an error
+                message, and the HTTP body that was received in the request.
+
+        """
+        return super().new_api_call_builder.request(
+            RequestBuilder().server(Server.DEFAULT)
+            .path("/api/assignments")
+            .http_method(HttpMethodEnum.PUT)
+            .header_param(Parameter()
+                .key("Content-Type")
+                .value("application/json"))
+            .body_param(Parameter()
+                .value(body)
+                .is_required(True))
+            .header_param(Parameter()
+                .key("accept")
+                .value("application/json"))
+            .body_serializer(APIHelper.json_serialize)
+            .auth(Single("bearerAuth")),
+        ).response(
+            ResponseHandler()
+            .deserializer(APIHelper.json_deserialize)
+            .deserialize_into(AssignmentResponse.from_dictionary)
+            .is_api_response(True)
+            .local_error("400",
+                "Validation error — missing required fields or invalid data.\n",
+                ProblemDetailsErrorException),
+        ).execute()

tqlotrfactoringdataexchange/apis/base_api.py

@@ -0,0 +1,72 @@
+"""tqlotrfactoringdataexchange.
+
+This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+"""
+
+import platform
+
+from apimatic_core.api_call import ApiCall
+from apimatic_core.types.error_case import ErrorCase
+
+from tqlotrfactoringdataexchange.exceptions.api_exception import (
+    ApiException,
+)
+
+
+class BaseApi(object):
+    """All controllers inherit from this base class.
+
+    Attributes:
+        config (Configuration): The HttpClient which a specific controller
+            instance will use. By default all the controller objects share
+            the same HttpClient. A user can use his own custom HttpClient
+            as well.
+        http_call_back (HttpCallBack): An object which holds call back
+            methods to be called before and after the execution of an HttpRequest.
+        new_api_call_builder (APICall): Returns the API Call builder instance.
+
+    """
+
+    @staticmethod
+    def user_agent():
+        """Return UserAgent value."""
+        return "Python-SDK/0.0.1 (OS: {os-info}, Engine: {engine}/{engine-version})"
+
+    @staticmethod
+    def user_agent_parameters():
+        """Return UserAgentParameters value."""
+        return {
+            "engine": {"value": platform.python_implementation(), "encode": False},
+            "engine-version": {"value": platform.python_version(), "encode": False},
+            "os-info": {"value": platform.system(), "encode": False},
+        }
+
+    @staticmethod
+    def global_errors():
+        """Return GlobalErrors value."""
+        return {
+            "default": ErrorCase()
+                .error_message("HTTP response not OK.")
+                .exception_type(ApiException),
+        }
+
+    def __init__(self, config):
+        """Initialize BaseApi object."""
+        self._config = config.get_http_client_configuration()
+        self._http_call_back = self.config.http_callback
+        self.api_call = ApiCall(config)
+
+    @property
+    def config(self):
+        """Return Configuration object."""
+        return self._config
+
+    @property
+    def http_call_back(self):
+        """Return HttpCallBack object."""
+        return self._http_call_back
+
+    @property
+    def new_api_call_builder(self):
+        """Return New ApiCallBuilder object."""
+        return self.api_call.new_builder