codat-common 0.35.0
Manage the building blocks of Codat, including companies, connections, and more.
Requires Python: <4.0,>=3.8

# Common

<!-- Start Codat Library Description -->
Manage the building blocks of Codat, including companies, connections, and more.
<!-- End Codat Library Description -->

<!-- Start SDK Installation [installation] -->
## SDK Installation

The SDK can be installed with either *pip* or *poetry* package managers.

### PIP

*PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

```bash
pip install codat-common
```

### Poetry

*Poetry* is a modern tool that simplifies dependency management and package publishing by using a single `pyproject.toml` file to handle project metadata and dependencies.

```bash
poetry add codat-common
```
<!-- End SDK Installation [installation] -->

## Example Usage
<!-- Start SDK Example Usage [usage] -->
## SDK Example Usage

### Example

```python
# Synchronous Example
from codat_common import CodatCommon

s = CodatCommon(
    auth_header="Basic BASE_64_ENCODED(API_KEY)",
)

res = s.settings.create_api_key(request={
    "name": "azure-invoice-finance-processor",
})

if res is not None:
    # handle response
    pass
```

</br>

The same SDK client can also be used to make asychronous requests by importing asyncio.
```python
# Asynchronous Example
import asyncio
from codat_common import CodatCommon

async def main():
    s = CodatCommon(
        auth_header="Basic BASE_64_ENCODED(API_KEY)",
    )
    res = await s.settings.create_api_key_async(request={
        "name": "azure-invoice-finance-processor",
    })
    if res is not None:
        # handle response
        pass

asyncio.run(main())
```
<!-- End SDK Example Usage [usage] -->

<!-- Start Available Resources and Operations [operations] -->
## Available Resources and Operations

<details open>
<summary>Available methods</summary>


### [companies](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/companiessdk/README.md)

* [create](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/companiessdk/README.md#create) - Create company
* [delete](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/companiessdk/README.md#delete) - Delete a company
* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/companiessdk/README.md#get) - Get company
* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/companiessdk/README.md#list) - List companies
* [update](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/companiessdk/README.md#update) - Update company

### [connection_management](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/connectionmanagement/README.md)

* [get_access_token](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/connectionmanagement/README.md#get_access_token) - Get access token

#### [connection_management.cors_settings](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/corssettings/README.md)

* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/corssettings/README.md#get) - Get CORS settings
* [set](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/corssettings/README.md#set) - Set CORS settings

### [connections](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/connectionssdk/README.md)

* [create](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/connectionssdk/README.md#create) - Create connection
* [delete](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/connectionssdk/README.md#delete) - Delete connection
* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/connectionssdk/README.md#get) - Get connection
* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/connectionssdk/README.md#list) - List connections
* [unlink](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/connectionssdk/README.md#unlink) - Unlink connection
* [update_authorization](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/connectionssdk/README.md#update_authorization) - Update authorization

### [custom_data_type](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/customdatatype/README.md)

* [configure](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/customdatatype/README.md#configure) - Configure custom data type
* [get_configuration](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/customdatatype/README.md#get_configuration) - Get custom data configuration
* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/customdatatype/README.md#list) - List custom data type records
* [refresh](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/customdatatype/README.md#refresh) - Refresh custom data type

### [groups](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/groupssdk/README.md)

* [add_company](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/groupssdk/README.md#add_company) - Add company
* [create](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/groupssdk/README.md#create) - Create group
* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/groupssdk/README.md#list) - List groups
* [remove_company](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/groupssdk/README.md#remove_company) - Remove company

### [integrations](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/integrationssdk/README.md)

* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/integrationssdk/README.md#get) - Get integration
* [get_branding](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/integrationssdk/README.md#get_branding) - Get branding
* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/integrationssdk/README.md#list) - List integrations

### [push_data](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/pushdata/README.md)

* [get_model_options](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/pushdata/README.md#get_model_options) - Get push options
* [get_operation](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/pushdata/README.md#get_operation) - Get push operation
* [list_operations](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/pushdata/README.md#list_operations) - List push operations

### [refresh_data](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/refreshdata/README.md)

* [all](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/refreshdata/README.md#all) - Refresh all data
* [by_data_type](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/refreshdata/README.md#by_data_type) - Refresh data type
* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/refreshdata/README.md#get) - Get data status
* [get_pull_operation](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/refreshdata/README.md#get_pull_operation) - Get pull operation
* [list_pull_operations](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/refreshdata/README.md#list_pull_operations) - List pull operations

### [settings](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/settings/README.md)

* [create_api_key](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/settings/README.md#create_api_key) - Create API key
* [delete_api_key](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/settings/README.md#delete_api_key) - Delete API key
* [get_profile](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/settings/README.md#get_profile) - Get profile
* [get_sync_settings](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/settings/README.md#get_sync_settings) - Get sync settings
* [list_api_keys](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/settings/README.md#list_api_keys) - List API keys
* [update_profile](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/settings/README.md#update_profile) - Update profile
* [update_sync_settings](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/settings/README.md#update_sync_settings) - Update all sync settings

### [supplemental_data](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/supplementaldata/README.md)

* [configure](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/supplementaldata/README.md#configure) - Configure
* [get_configuration](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/supplementaldata/README.md#get_configuration) - Get configuration

### [webhooks](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/webhookssdk/README.md)

* [~~create~~](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/webhookssdk/README.md#create) - Create webhook :warning: **Deprecated**
* [create_consumer](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/webhookssdk/README.md#create_consumer) - Create webhook consumer
* [delete_consumer](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/webhookssdk/README.md#delete_consumer) - Delete webhook consumer
* [~~get~~](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/webhookssdk/README.md#get) - Get webhook :warning: **Deprecated**
* [~~list~~](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/webhookssdk/README.md#list) - List webhooks :warning: **Deprecated**
* [list_consumers](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/webhookssdk/README.md#list_consumers) - List webhook consumers

</details>
<!-- End Available Resources and Operations [operations] -->



<!-- Start Summary [summary] -->
## Summary

Platform API: Platform API

An API for the common components of all of Codat's products.

These end points cover creating and managing your companies, data connections, and integrations.

[Read about the building blocks of Codat...](https://docs.codat.io/core-concepts/companies) | [See our OpenAPI spec](https://github.com/codatio/oas) 

---
<!-- Start Codat Tags Table -->
## Endpoints

| Endpoints | Description |
| :- |:- |
| Companies | Create and manage your SMB users' companies. |
| Connections | Create new and manage existing data connections for a company. |
| Connection management | Configure connection management UI and retrieve access tokens for authentication. |
| Groups | Define and manage sets of companies based on a chosen characteristic. |
| Webhooks | Create and manage webhooks that listen to Codat's events. |
| Integrations | Get a list of integrations supported by Codat and their logos. |
| Refresh data | Initiate data refreshes, view pull status and history. |
| Settings | Manage company profile configuration, sync settings, and API keys. |
| Push data | Initiate and monitor Create, Update, and Delete operations. |
| Supplemental data | Configure and pull additional data you can include in Codat's standard data types. |
| Custom data type | Configure and pull additional data types that are not included in Codat's standardized data model. |
<!-- End Codat Tags Table -->
<!-- End Summary [summary] -->

<!-- Start Table of Contents [toc] -->
## Table of Contents

* [SDK Installation](https://github.com/codatio/client-sdk-python/blob/master/#sdk-installation)
* [IDE Support](https://github.com/codatio/client-sdk-python/blob/master/#ide-support)
* [SDK Example Usage](https://github.com/codatio/client-sdk-python/blob/master/#sdk-example-usage)
* [Available Resources and Operations](https://github.com/codatio/client-sdk-python/blob/master/#available-resources-and-operations)
* [Retries](https://github.com/codatio/client-sdk-python/blob/master/#retries)
* [Error Handling](https://github.com/codatio/client-sdk-python/blob/master/#error-handling)
* [Server Selection](https://github.com/codatio/client-sdk-python/blob/master/#server-selection)
* [Custom HTTP Client](https://github.com/codatio/client-sdk-python/blob/master/#custom-http-client)
* [Authentication](https://github.com/codatio/client-sdk-python/blob/master/#authentication)
* [Debugging](https://github.com/codatio/client-sdk-python/blob/master/#debugging)
<!-- End Table of Contents [toc] -->

<!-- Start IDE Support [idesupport] -->
## IDE Support

### PyCharm

Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.

- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/)
<!-- End IDE Support [idesupport] -->

<!-- Start Retries [retries] -->
## Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:
```python
from codat_common import CodatCommon
from codatcommon.utils import BackoffStrategy, RetryConfig

s = CodatCommon(
    auth_header="Basic BASE_64_ENCODED(API_KEY)",
)

res = s.settings.create_api_key(request={
    "name": "azure-invoice-finance-processor",
},
    RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

if res is not None:
    # handle response
    pass

```

If you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK:
```python
from codat_common import CodatCommon
from codatcommon.utils import BackoffStrategy, RetryConfig

s = CodatCommon(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    auth_header="Basic BASE_64_ENCODED(API_KEY)",
)

res = s.settings.create_api_key(request={
    "name": "azure-invoice-finance-processor",
})

if res is not None:
    # handle response
    pass

```
<!-- End Retries [retries] -->

<!-- Start Error Handling [errors] -->
## Error Handling

Handling errors in this SDK should largely match your expectations.  All operations return a response object or raise an error.  If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.

| Error Object                    | Status Code                     | Content Type                    |
| ------------------------------- | ------------------------------- | ------------------------------- |
| models.ErrorMessage             | 400,401,402,403,409,429,500,503 | application/json                |
| models.SDKError                 | 4xx-5xx                         | */*                             |

### Example

```python
from codat_common import CodatCommon, models

s = CodatCommon(
    auth_header="Basic BASE_64_ENCODED(API_KEY)",
)

res = None
try:
    res = s.settings.create_api_key(request={
        "name": "azure-invoice-finance-processor",
    })

    if res is not None:
        # handle response
        pass

except models.ErrorMessage as e:
    # handle e.data: models.ErrorMessageData
    raise(e)
except models.SDKError as e:
    # handle exception
    raise(e)
```
<!-- End Error Handling [errors] -->

<!-- Start Server Selection [server] -->
## Server Selection

### Select Server by Index

You can override the default server globally by passing a server index to the `server_idx: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

| # | Server | Variables |
| - | ------ | --------- |
| 0 | `https://api.codat.io` | None |

#### Example

```python
from codat_common import CodatCommon

s = CodatCommon(
    server_idx=0,
    auth_header="Basic BASE_64_ENCODED(API_KEY)",
)

res = s.settings.create_api_key(request={
    "name": "azure-invoice-finance-processor",
})

if res is not None:
    # handle response
    pass

```


### Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
```python
from codat_common import CodatCommon

s = CodatCommon(
    server_url="https://api.codat.io",
    auth_header="Basic BASE_64_ENCODED(API_KEY)",
)

res = s.settings.create_api_key(request={
    "name": "azure-invoice-finance-processor",
})

if res is not None:
    # handle response
    pass

```
<!-- End Server Selection [server] -->

<!-- Start Custom HTTP Client [http-client] -->
## Custom HTTP Client

The Python SDK makes API calls using the [httpx](https://www.python-httpx.org/) HTTP library.  In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance.
Depending on whether you are using the sync or async version of the SDK, you can pass an instance of `HttpClient` or `AsyncHttpClient` respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls.
This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of `httpx.Client` or `httpx.AsyncClient` directly.

For example, you could specify a header for every request that this sdk makes as follows:
```python
from codat_common import CodatCommon
import httpx

http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = CodatCommon(client=http_client)
```

or you could wrap the client with your own custom logic:
```python
from codat_common import CodatCommon
from codat_common.httpclient import AsyncHttpClient
import httpx

class CustomClient(AsyncHttpClient):
    client: AsyncHttpClient

    def __init__(self, client: AsyncHttpClient):
        self.client = client

    async def send(
        self,
        request: httpx.Request,
        *,
        stream: bool = False,
        auth: Union[
            httpx._types.AuthTypes, httpx._client.UseClientDefault, None
        ] = httpx.USE_CLIENT_DEFAULT,
        follow_redirects: Union[
            bool, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
    ) -> httpx.Response:
        request.headers["Client-Level-Header"] = "added by client"

        return await self.client.send(
            request, stream=stream, auth=auth, follow_redirects=follow_redirects
        )

    def build_request(
        self,
        method: str,
        url: httpx._types.URLTypes,
        *,
        content: Optional[httpx._types.RequestContent] = None,
        data: Optional[httpx._types.RequestData] = None,
        files: Optional[httpx._types.RequestFiles] = None,
        json: Optional[Any] = None,
        params: Optional[httpx._types.QueryParamTypes] = None,
        headers: Optional[httpx._types.HeaderTypes] = None,
        cookies: Optional[httpx._types.CookieTypes] = None,
        timeout: Union[
            httpx._types.TimeoutTypes, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
        extensions: Optional[httpx._types.RequestExtensions] = None,
    ) -> httpx.Request:
        return self.client.build_request(
            method,
            url,
            content=content,
            data=data,
            files=files,
            json=json,
            params=params,
            headers=headers,
            cookies=cookies,
            timeout=timeout,
            extensions=extensions,
        )

s = CodatCommon(async_client=CustomClient(httpx.AsyncClient()))
```
<!-- End Custom HTTP Client [http-client] -->

<!-- Start Authentication [security] -->
## Authentication

### Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name          | Type          | Scheme        |
| ------------- | ------------- | ------------- |
| `auth_header` | apiKey        | API key       |

To authenticate with the API the `auth_header` parameter must be set when initializing the SDK client instance. For example:
```python
from codat_common import CodatCommon

s = CodatCommon(
    auth_header="Basic BASE_64_ENCODED(API_KEY)",
)

res = s.settings.create_api_key(request={
    "name": "azure-invoice-finance-processor",
})

if res is not None:
    # handle response
    pass

```
<!-- End Authentication [security] -->

<!-- Start Debugging [debug] -->
## Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass your own logger class directly into your SDK.
```python
from codat_common import CodatCommon
import logging

logging.basicConfig(level=logging.DEBUG)
s = CodatCommon(debug_logger=logging.getLogger("codat_common"))
```
<!-- End Debugging [debug] -->

<!-- Placeholder for Future Speakeasy SDK Sections -->

<!-- Start Codat Support Notes -->
### Support

If you encounter any challenges while utilizing our SDKs, please don't hesitate to reach out for assistance. 
You can raise any issues by contacting your dedicated Codat representative or reaching out to our [support team](https://github.com/codatio/client-sdk-python/blob/master/mailto:support@codat.io).
We're here to help ensure a smooth experience for you.
<!-- End Codat Support Notes -->

<!-- Start Codat Generated By -->
### Library generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
<!-- End Codat Generated By -->