codat-platform 3.2.0

Manage the building blocks of Codat, including companies, connections, and more.

Platform

Manage the building blocks of Codat, including companies, connections, and more.

SDK Installation

pip install codat-platform

Example Usage

SDK Example Usage

Example

import codatplatform
from codatplatform.models import shared

s = codatplatform.CodatPlatform(
    security=shared.Security(
        auth_header="<YOUR_API_KEY_HERE>",
    ),
)

req = shared.CreateAPIKey(
    name='azure-invoice-finance-processor',
)

res = s.settings.create_api_key(req)

if res.api_key_details is not None:
    # handle response
    pass

Available Resources and Operations

settings

• create_api_key - Create API key
• delete_api_key - Delete API key
• get_profile - Get profile
• get_sync_settings - Get sync settings
• list_api_keys - List API keys
• update_profile - Update profile
• update_sync_settings - Update all sync settings

companies

• create - Create company
• delete - Delete a company
• get - Get company
• list - List companies
• update - Update company

connections

• create - Create connection
• delete - Delete connection
• get - Get connection
• list - List connections
• unlink - Unlink connection
• update_authorization - Update authorization

custom_data_type

• configure - Configure custom data type
• get_configuration - Get custom data configuration
• list - List custom data type records
• refresh - Refresh custom data type

push_data

• get_model_options - Get push options
• get_operation - Get push operation
• list_operations - List push operations

refresh_data

• all - Refresh all data
• by_data_type - Refresh data type
• get - Get data status
• get_pull_operation - Get pull operation
• list_pull_operations - List pull operations

groups

• add_company - Add company
• create - Create group
• list - List groups
• remove_company - Remove company

integrations

• get - Get integration
• get_branding - Get branding
• list - List integrations

supplemental_data

• configure - Configure
• get_configuration - Get configuration

webhooks

• create - Create webhook
• get - Get webhook
• list - List webhooks

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:

import codatplatform
from codatplatform.models import shared
from codatplatform.utils import BackoffStrategy, RetryConfig

s = codatplatform.CodatPlatform(
    security=shared.Security(
        auth_header="<YOUR_API_KEY_HERE>",
    ),
)

req = shared.CreateAPIKey(
    name='azure-invoice-finance-processor',
)

res = s.settings.create_api_key(req,
    RetryConfig('backoff', BackoffStrategy(1, 50, 1.1, 100), False))

if res.api_key_details is not None:
    # handle response
    pass

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import codatplatform
from codatplatform.models import shared
from codatplatform.utils import BackoffStrategy, RetryConfig

s = codatplatform.CodatPlatform(
    retry_config=RetryConfig('backoff', BackoffStrategy(1, 50, 1.1, 100), False)
    security=shared.Security(
        auth_header="<YOUR_API_KEY_HERE>",
    ),
)

req = shared.CreateAPIKey(
    name='azure-invoice-finance-processor',
)

res = s.settings.create_api_key(req)

if res.api_key_details is not None:
    # handle response
    pass

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
errors.ErrorMessage	400,401,402,403,409,429,500,503	application/json
errors.SDKError	4x-5xx	/

Example

import codatplatform
from codatplatform.models import shared

s = codatplatform.CodatPlatform(
    security=shared.Security(
        auth_header="<YOUR_API_KEY_HERE>",
    ),
)

req = shared.CreateAPIKey(
    name='azure-invoice-finance-processor',
)

res = None
try:
    res = s.settings.create_api_key(req)
except errors.ErrorMessage as e:
    print(e)  # handle exception
    raise(e)
except errors.SDKError as e:
    print(e)  # handle exception
    raise(e)

if res.api_key_details is not None:
    # handle response
    pass

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

import codatplatform
from codatplatform.models import shared

s = codatplatform.CodatPlatform(
    server_idx=0,
    security=shared.Security(
        auth_header="<YOUR_API_KEY_HERE>",
    ),
)

req = shared.CreateAPIKey(
    name='azure-invoice-finance-processor',
)

res = s.settings.create_api_key(req)

if res.api_key_details 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:

import codatplatform
from codatplatform.models import shared

s = codatplatform.CodatPlatform(
    server_url="https://api.codat.io",
    security=shared.Security(
        auth_header="<YOUR_API_KEY_HERE>",
    ),
)

req = shared.CreateAPIKey(
    name='azure-invoice-finance-processor',
)

res = s.settings.create_api_key(req)

if res.api_key_details is not None:
    # handle response
    pass

Custom HTTP Client

The Python SDK makes API calls using the (requests)[https://pypi.org/project/requests/] 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 a custom requests.Session object.

For example, you could specify a header for every request that this sdk makes as follows:

import codatplatform
import requests

http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = codatplatform.CodatPlatform(client: http_client)

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
auth_header	apiKey	API key

You can set the security parameters through the security optional parameter when initializing the SDK client instance. For example:

import codatplatform
from codatplatform.models import shared

s = codatplatform.CodatPlatform(
    security=shared.Security(
        auth_header="<YOUR_API_KEY_HERE>",
    ),
)

req = shared.CreateAPIKey(
    name='azure-invoice-finance-processor',
)

res = s.settings.create_api_key(req)

if res.api_key_details is not None:
    # handle response
    pass

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. We're here to help ensure a smooth experience for you.

Library generated by Speakeasy