Metadata-Version: 2.4
Name: apimatic-tql-sdk
Version: 0.0.2
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 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

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.2
```

You can also view the package at:
https://pypi.python.org/pypi/apimatic-tql-sdk/0.0.2

## 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.2/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.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-python-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

```python
import logging

from freightfinancialswebhookingestionapi.configuration import Environment
from freightfinancialswebhookingestionapi.freightfinancialswebhookingestionapi_client import FreightfinancialswebhookingestionapiClient
from freightfinancialswebhookingestionapi.logging.configuration.api_logging_configuration import LoggingConfiguration
from freightfinancialswebhookingestionapi.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from freightfinancialswebhookingestionapi.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration

client = FreightfinancialswebhookingestionapiClient(
    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 freightfinancialswebhookingestionapi.freightfinancialswebhookingestionapi_client import FreightfinancialswebhookingestionapiClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = FreightfinancialswebhookingestionapiClient.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.2/doc/environment-based-client-initialization.md) section for details.

## List of APIs

* [Assignments](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.2/doc/controllers/assignments.md)
* [Documents](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.2/doc/controllers/documents.md)
* [Freight Audit](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.2/doc/controllers/freight-audit.md)
* [Invoices](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.2/doc/controllers/invoices.md)
* [Loads](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.2/doc/controllers/loads.md)
* [Rating](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.2/doc/controllers/rating.md)

## SDK Infrastructure

### Configuration

* [ProxySettings](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.2/doc/proxy-settings.md)
* [Environment-Based Client Initialization](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.2/doc/environment-based-client-initialization.md)
* [AbstractLogger](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.2/doc/abstract-logger.md)
* [LoggingConfiguration](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.2/doc/logging-configuration.md)
* [RequestLoggingConfiguration](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.2/doc/request-logging-configuration.md)
* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.2/doc/response-logging-configuration.md)

### HTTP

* [HttpResponse](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.2/doc/http-response.md)
* [HttpRequest](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.2/doc/http-request.md)

### Utilities

* [ApiResponse](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.2/doc/api-response.md)
* [ApiHelper](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.2/doc/api-helper.md)
* [HttpDateTime](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.2/doc/http-date-time.md)
* [RFC3339DateTime](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.2/doc/rfc3339-date-time.md)
* [UnixDateTime](https://www.github.com/sdks-io/apimatic-tql-python-sdk/tree/0.0.2/doc/unix-date-time.md)

