# Sync for Commerce
<!-- Start Codat Library Description -->
Embedded accounting integrations for POS and eCommerce platforms.
<!-- End Codat Library Description -->
<!-- Start Summary [summary] -->
## Summary
Sync for Commerce: The API for Sync for Commerce.
Sync for Commerce automatically replicates and reconciles sales data from a merchant’s source PoS, Payments, and eCommerce systems into their accounting software. This eliminates manual processing by merchants and transforms their ability to run and grow their business.
[Explore product](https://docs.codat.io/commerce/overview) | [See our OpenAPI spec](https://github.com/codatio/oas)
Not seeing the endpoints you're expecting? We've [reorganized our products](https://docs.codat.io/updates/230901-new-products), and you may be using a [different version of Sync for Commerce](https://docs.codat.io/sync-for-commerce-v1-api#/).
---
<!-- Start Codat Tags Table -->
## Endpoints
| Endpoints | Description |
| :- |:- |
| Connections | Create new and manage existing data connections for a company. |
| Sync | Initiate data syncs and monitor their status. |
| Sync flow settings | Control text and visibility settings for the Sync Flow. |
| Integrations | Get a list of integrations supported by Sync for Commerce and their logos. |
| Advanced controls | View and manage mapping configured for a company's commerce sync. |
<!-- 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 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-sync-for-commerce
```
### 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-sync-for-commerce
```
<!-- End SDK Installation [installation] -->
## Example Usage
<!-- 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 SDK Example Usage [usage] -->
## SDK Example Usage
### Example
```python
# Synchronous Example
from codat_sync_for_commerce import CodatSyncCommerce
from codat_sync_for_commerce.models import shared
s = CodatSyncCommerce(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
res = s.sync_flow_settings.get_config_text_sync_flow(request={
"locale": shared.Locale.EN_US,
})
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_sync_for_commerce import CodatSyncCommerce
from codat_sync_for_commerce.models import shared
async def main():
s = CodatSyncCommerce(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
res = await s.sync_flow_settings.get_config_text_sync_flow_async(request={
"locale": shared.Locale.EN_US,
})
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>
### [advanced_controls](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/advancedcontrols/README.md)
* [create_company](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/advancedcontrols/README.md#create_company) - Create company
* [get_configuration](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/advancedcontrols/README.md#get_configuration) - Get company configuration
* [list_companies](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/advancedcontrols/README.md#list_companies) - List companies
* [set_configuration](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/advancedcontrols/README.md#set_configuration) - Set configuration
### [connections](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/connections/README.md)
* [create](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/connections/README.md#create) - Create connection
* [get_sync_flow_url](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/connections/README.md#get_sync_flow_url) - Start new sync flow
* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/connections/README.md#list) - List connections
* [update_authorization](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/connections/README.md#update_authorization) - Update authorization
* [update_connection](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/connections/README.md#update_connection) - Update connection
### [integrations](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/integrations/README.md)
* [get_branding](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/integrations/README.md#get_branding) - Get branding for an integration
* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/integrations/README.md#list) - List integrations
### [sync](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/sync/README.md)
* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/sync/README.md#get) - Get sync status
* [get_last_successful_sync](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/sync/README.md#get_last_successful_sync) - Last successful sync
* [get_latest_sync](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/sync/README.md#get_latest_sync) - Latest sync status
* [get_status](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/sync/README.md#get_status) - Get sync status
* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/sync/README.md#list) - List sync statuses
* [request](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/sync/README.md#request) - Initiate new sync
* [request_for_date_range](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/sync/README.md#request_for_date_range) - Initiate sync for specific range
### [sync_flow_settings](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/syncflowsettings/README.md)
* [get_config_text_sync_flow](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/syncflowsettings/README.md#get_config_text_sync_flow) - Get preferences for text fields
* [get_visible_accounts](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/syncflowsettings/README.md#get_visible_accounts) - List visible accounts
* [update_config_text_sync_flow](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/syncflowsettings/README.md#update_config_text_sync_flow) - Update preferences for text fields
* [update_visible_accounts_sync_flow](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/syncflowsettings/README.md#update_visible_accounts_sync_flow) - Update visible accounts
</details>
<!-- End Available Resources and Operations [operations] -->
<!-- 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_sync_for_commerce import CodatSyncCommerce
from codat_sync_for_commerce.models import shared
from codatsynccommerce.utils import BackoffStrategy, RetryConfig
s = CodatSyncCommerce(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
res = s.sync_flow_settings.get_config_text_sync_flow(request={
"locale": shared.Locale.EN_US,
},
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_sync_for_commerce import CodatSyncCommerce
from codat_sync_for_commerce.models import shared
from codatsynccommerce.utils import BackoffStrategy, RetryConfig
s = CodatSyncCommerce(
retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
res = s.sync_flow_settings.get_config_text_sync_flow(request={
"locale": shared.Locale.EN_US,
})
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 |
| ----------------------- | ----------------------- | ----------------------- |
| errors.ErrorMessage | 401,402,403,429,500,503 | application/json |
| errors.SDKError | 4xx-5xx | */* |
### Example
```python
from codat_sync_for_commerce import CodatSyncCommerce
from codat_sync_for_commerce.models import errors, shared
s = CodatSyncCommerce(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
res = None
try:
res = s.sync_flow_settings.get_config_text_sync_flow(request={
"locale": shared.Locale.EN_US,
})
if res is not None:
# handle response
pass
except errors.ErrorMessage as e:
# handle e.data: errors.ErrorMessageData
raise(e)
except errors.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_sync_for_commerce import CodatSyncCommerce
from codat_sync_for_commerce.models import shared
s = CodatSyncCommerce(
server_idx=0,
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
res = s.sync_flow_settings.get_config_text_sync_flow(request={
"locale": shared.Locale.EN_US,
})
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_sync_for_commerce import CodatSyncCommerce
from codat_sync_for_commerce.models import shared
s = CodatSyncCommerce(
server_url="https://api.codat.io",
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
res = s.sync_flow_settings.get_config_text_sync_flow(request={
"locale": shared.Locale.EN_US,
})
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_sync_for_commerce import CodatSyncCommerce
import httpx
http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = CodatSyncCommerce(client=http_client)
```
or you could wrap the client with your own custom logic:
```python
from codat_sync_for_commerce import CodatSyncCommerce
from codat_sync_for_commerce.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 = CodatSyncCommerce(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 |
You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. For example:
```python
from codat_sync_for_commerce import CodatSyncCommerce
from codat_sync_for_commerce.models import shared
s = CodatSyncCommerce(
security=shared.Security(
auth_header="Basic BASE_64_ENCODED(API_KEY)",
),
)
res = s.sync_flow_settings.get_config_text_sync_flow(request={
"locale": shared.Locale.EN_US,
})
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_sync_for_commerce import CodatSyncCommerce
import logging
logging.basicConfig(level=logging.DEBUG)
s = CodatSyncCommerce(debug_logger=logging.getLogger("codat_sync_for_commerce"))
```
<!-- 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 -->
Raw data
{
"_id": null,
"home_page": "https://github.com/codatio/client-sdk-python.git",
"name": "codat-sync-for-commerce",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Speakeasy",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/8f/55/68dd3bc5e07f837208574a7db58df3ae601bd88f3b916760d226c69a05cd/codat_sync_for_commerce-5.0.0.tar.gz",
"platform": null,
"description": "# Sync for Commerce\n\n<!-- Start Codat Library Description -->\n\ufeffEmbedded accounting integrations for POS and eCommerce platforms.\n<!-- End Codat Library Description -->\n\n<!-- Start Summary [summary] -->\n## Summary\n\nSync for Commerce: The API for Sync for Commerce. \n\nSync for Commerce automatically replicates and reconciles sales data from a merchant\u2019s source PoS, Payments, and eCommerce systems into their accounting software. This eliminates manual processing by merchants and transforms their ability to run and grow their business.\n \n[Explore product](https://docs.codat.io/commerce/overview) | [See our OpenAPI spec](https://github.com/codatio/oas)\n\nNot seeing the endpoints you're expecting? We've [reorganized our products](https://docs.codat.io/updates/230901-new-products), and you may be using a [different version of Sync for Commerce](https://docs.codat.io/sync-for-commerce-v1-api#/).\n\n---\n\n<!-- Start Codat Tags Table -->\n## Endpoints\n\n| Endpoints | Description |\n| :- |:- |\n| Connections | Create new and manage existing data connections for a company. |\n| Sync | Initiate data syncs and monitor their status. |\n| Sync flow settings | Control text and visibility settings for the Sync Flow. |\n| Integrations | Get a list of integrations supported by Sync for Commerce and their logos. |\n| Advanced controls | View and manage mapping configured for a company's commerce sync. |\n<!-- End Codat Tags Table -->\n<!-- End Summary [summary] -->\n\n<!-- Start Table of Contents [toc] -->\n## Table of Contents\n\n* [SDK Installation](https://github.com/codatio/client-sdk-python/blob/master/#sdk-installation)\n* [IDE Support](https://github.com/codatio/client-sdk-python/blob/master/#ide-support)\n* [SDK Example Usage](https://github.com/codatio/client-sdk-python/blob/master/#sdk-example-usage)\n* [Available Resources and Operations](https://github.com/codatio/client-sdk-python/blob/master/#available-resources-and-operations)\n* [Retries](https://github.com/codatio/client-sdk-python/blob/master/#retries)\n* [Error Handling](https://github.com/codatio/client-sdk-python/blob/master/#error-handling)\n* [Server Selection](https://github.com/codatio/client-sdk-python/blob/master/#server-selection)\n* [Custom HTTP Client](https://github.com/codatio/client-sdk-python/blob/master/#custom-http-client)\n* [Authentication](https://github.com/codatio/client-sdk-python/blob/master/#authentication)\n* [Debugging](https://github.com/codatio/client-sdk-python/blob/master/#debugging)\n<!-- End Table of Contents [toc] -->\n\n<!-- Start SDK Installation [installation] -->\n## SDK Installation\n\nThe SDK can be installed with either *pip* or *poetry* package managers.\n\n### PIP\n\n*PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.\n\n```bash\npip install codat-sync-for-commerce\n```\n\n### Poetry\n\n*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.\n\n```bash\npoetry add codat-sync-for-commerce\n```\n<!-- End SDK Installation [installation] -->\n\n## Example Usage\n<!-- Start IDE Support [idesupport] -->\n## IDE Support\n\n### PyCharm\n\nGenerally, 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.\n\n- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/)\n<!-- End IDE Support [idesupport] -->\n\n<!-- Start SDK Example Usage [usage] -->\n## SDK Example Usage\n\n### Example\n\n```python\n# Synchronous Example\nfrom codat_sync_for_commerce import CodatSyncCommerce\nfrom codat_sync_for_commerce.models import shared\n\ns = CodatSyncCommerce(\n security=shared.Security(\n auth_header=\"Basic BASE_64_ENCODED(API_KEY)\",\n ),\n)\n\nres = s.sync_flow_settings.get_config_text_sync_flow(request={\n \"locale\": shared.Locale.EN_US,\n})\n\nif res is not None:\n # handle response\n pass\n```\n\n</br>\n\nThe same SDK client can also be used to make asychronous requests by importing asyncio.\n```python\n# Asynchronous Example\nimport asyncio\nfrom codat_sync_for_commerce import CodatSyncCommerce\nfrom codat_sync_for_commerce.models import shared\n\nasync def main():\n s = CodatSyncCommerce(\n security=shared.Security(\n auth_header=\"Basic BASE_64_ENCODED(API_KEY)\",\n ),\n )\n res = await s.sync_flow_settings.get_config_text_sync_flow_async(request={\n \"locale\": shared.Locale.EN_US,\n })\n if res is not None:\n # handle response\n pass\n\nasyncio.run(main())\n```\n<!-- End SDK Example Usage [usage] -->\n\n<!-- Start Available Resources and Operations [operations] -->\n## Available Resources and Operations\n\n<details open>\n<summary>Available methods</summary>\n\n### [advanced_controls](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/advancedcontrols/README.md)\n\n* [create_company](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/advancedcontrols/README.md#create_company) - Create company\n* [get_configuration](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/advancedcontrols/README.md#get_configuration) - Get company configuration\n* [list_companies](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/advancedcontrols/README.md#list_companies) - List companies\n* [set_configuration](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/advancedcontrols/README.md#set_configuration) - Set configuration\n\n\n### [connections](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/connections/README.md)\n\n* [create](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/connections/README.md#create) - Create connection\n* [get_sync_flow_url](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/connections/README.md#get_sync_flow_url) - Start new sync flow\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/connections/README.md#list) - List connections\n* [update_authorization](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/connections/README.md#update_authorization) - Update authorization\n* [update_connection](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/connections/README.md#update_connection) - Update connection\n\n### [integrations](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/integrations/README.md)\n\n* [get_branding](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/integrations/README.md#get_branding) - Get branding for an integration\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/integrations/README.md#list) - List integrations\n\n### [sync](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/sync/README.md)\n\n* [get](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/sync/README.md#get) - Get sync status\n* [get_last_successful_sync](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/sync/README.md#get_last_successful_sync) - Last successful sync\n* [get_latest_sync](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/sync/README.md#get_latest_sync) - Latest sync status\n* [get_status](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/sync/README.md#get_status) - Get sync status\n* [list](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/sync/README.md#list) - List sync statuses\n* [request](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/sync/README.md#request) - Initiate new sync\n* [request_for_date_range](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/sync/README.md#request_for_date_range) - Initiate sync for specific range\n\n### [sync_flow_settings](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/syncflowsettings/README.md)\n\n* [get_config_text_sync_flow](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/syncflowsettings/README.md#get_config_text_sync_flow) - Get preferences for text fields\n* [get_visible_accounts](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/syncflowsettings/README.md#get_visible_accounts) - List visible accounts\n* [update_config_text_sync_flow](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/syncflowsettings/README.md#update_config_text_sync_flow) - Update preferences for text fields\n* [update_visible_accounts_sync_flow](https://github.com/codatio/client-sdk-python/blob/master/docs/sdks/syncflowsettings/README.md#update_visible_accounts_sync_flow) - Update visible accounts\n\n</details>\n<!-- End Available Resources and Operations [operations] -->\n\n\n\n<!-- Start Retries [retries] -->\n## Retries\n\nSome 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.\n\nTo change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:\n```python\nfrom codat_sync_for_commerce import CodatSyncCommerce\nfrom codat_sync_for_commerce.models import shared\nfrom codatsynccommerce.utils import BackoffStrategy, RetryConfig\n\ns = CodatSyncCommerce(\n security=shared.Security(\n auth_header=\"Basic BASE_64_ENCODED(API_KEY)\",\n ),\n)\n\nres = s.sync_flow_settings.get_config_text_sync_flow(request={\n \"locale\": shared.Locale.EN_US,\n},\n RetryConfig(\"backoff\", BackoffStrategy(1, 50, 1.1, 100), False))\n\nif res is not None:\n # handle response\n pass\n\n```\n\nIf 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:\n```python\nfrom codat_sync_for_commerce import CodatSyncCommerce\nfrom codat_sync_for_commerce.models import shared\nfrom codatsynccommerce.utils import BackoffStrategy, RetryConfig\n\ns = CodatSyncCommerce(\n retry_config=RetryConfig(\"backoff\", BackoffStrategy(1, 50, 1.1, 100), False),\n security=shared.Security(\n auth_header=\"Basic BASE_64_ENCODED(API_KEY)\",\n ),\n)\n\nres = s.sync_flow_settings.get_config_text_sync_flow(request={\n \"locale\": shared.Locale.EN_US,\n})\n\nif res is not None:\n # handle response\n pass\n\n```\n<!-- End Retries [retries] -->\n\n<!-- Start Error Handling [errors] -->\n## Error Handling\n\nHandling 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.\n\n| Error Object | Status Code | Content Type |\n| ----------------------- | ----------------------- | ----------------------- |\n| errors.ErrorMessage | 401,402,403,429,500,503 | application/json |\n| errors.SDKError | 4xx-5xx | */* |\n\n### Example\n\n```python\nfrom codat_sync_for_commerce import CodatSyncCommerce\nfrom codat_sync_for_commerce.models import errors, shared\n\ns = CodatSyncCommerce(\n security=shared.Security(\n auth_header=\"Basic BASE_64_ENCODED(API_KEY)\",\n ),\n)\n\nres = None\ntry:\n res = s.sync_flow_settings.get_config_text_sync_flow(request={\n \"locale\": shared.Locale.EN_US,\n })\n\n if res is not None:\n # handle response\n pass\n\nexcept errors.ErrorMessage as e:\n # handle e.data: errors.ErrorMessageData\n raise(e)\nexcept errors.SDKError as e:\n # handle exception\n raise(e)\n```\n<!-- End Error Handling [errors] -->\n\n<!-- Start Server Selection [server] -->\n## Server Selection\n\n### Select Server by Index\n\nYou 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:\n\n| # | Server | Variables |\n| - | ------ | --------- |\n| 0 | `https://api.codat.io` | None |\n\n#### Example\n\n```python\nfrom codat_sync_for_commerce import CodatSyncCommerce\nfrom codat_sync_for_commerce.models import shared\n\ns = CodatSyncCommerce(\n server_idx=0,\n security=shared.Security(\n auth_header=\"Basic BASE_64_ENCODED(API_KEY)\",\n ),\n)\n\nres = s.sync_flow_settings.get_config_text_sync_flow(request={\n \"locale\": shared.Locale.EN_US,\n})\n\nif res is not None:\n # handle response\n pass\n\n```\n\n\n### Override Server URL Per-Client\n\nThe 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:\n```python\nfrom codat_sync_for_commerce import CodatSyncCommerce\nfrom codat_sync_for_commerce.models import shared\n\ns = CodatSyncCommerce(\n server_url=\"https://api.codat.io\",\n security=shared.Security(\n auth_header=\"Basic BASE_64_ENCODED(API_KEY)\",\n ),\n)\n\nres = s.sync_flow_settings.get_config_text_sync_flow(request={\n \"locale\": shared.Locale.EN_US,\n})\n\nif res is not None:\n # handle response\n pass\n\n```\n<!-- End Server Selection [server] -->\n\n<!-- Start Custom HTTP Client [http-client] -->\n## Custom HTTP Client\n\nThe 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.\nDepending 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.\nThis 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.\n\nFor example, you could specify a header for every request that this sdk makes as follows:\n```python\nfrom codat_sync_for_commerce import CodatSyncCommerce\nimport httpx\n\nhttp_client = httpx.Client(headers={\"x-custom-header\": \"someValue\"})\ns = CodatSyncCommerce(client=http_client)\n```\n\nor you could wrap the client with your own custom logic:\n```python\nfrom codat_sync_for_commerce import CodatSyncCommerce\nfrom codat_sync_for_commerce.httpclient import AsyncHttpClient\nimport httpx\n\nclass CustomClient(AsyncHttpClient):\n client: AsyncHttpClient\n\n def __init__(self, client: AsyncHttpClient):\n self.client = client\n\n async def send(\n self,\n request: httpx.Request,\n *,\n stream: bool = False,\n auth: Union[\n httpx._types.AuthTypes, httpx._client.UseClientDefault, None\n ] = httpx.USE_CLIENT_DEFAULT,\n follow_redirects: Union[\n bool, httpx._client.UseClientDefault\n ] = httpx.USE_CLIENT_DEFAULT,\n ) -> httpx.Response:\n request.headers[\"Client-Level-Header\"] = \"added by client\"\n\n return await self.client.send(\n request, stream=stream, auth=auth, follow_redirects=follow_redirects\n )\n\n def build_request(\n self,\n method: str,\n url: httpx._types.URLTypes,\n *,\n content: Optional[httpx._types.RequestContent] = None,\n data: Optional[httpx._types.RequestData] = None,\n files: Optional[httpx._types.RequestFiles] = None,\n json: Optional[Any] = None,\n params: Optional[httpx._types.QueryParamTypes] = None,\n headers: Optional[httpx._types.HeaderTypes] = None,\n cookies: Optional[httpx._types.CookieTypes] = None,\n timeout: Union[\n httpx._types.TimeoutTypes, httpx._client.UseClientDefault\n ] = httpx.USE_CLIENT_DEFAULT,\n extensions: Optional[httpx._types.RequestExtensions] = None,\n ) -> httpx.Request:\n return self.client.build_request(\n method,\n url,\n content=content,\n data=data,\n files=files,\n json=json,\n params=params,\n headers=headers,\n cookies=cookies,\n timeout=timeout,\n extensions=extensions,\n )\n\ns = CodatSyncCommerce(async_client=CustomClient(httpx.AsyncClient()))\n```\n<!-- End Custom HTTP Client [http-client] -->\n\n<!-- Start Authentication [security] -->\n## Authentication\n\n### Per-Client Security Schemes\n\nThis SDK supports the following security scheme globally:\n\n| Name | Type | Scheme |\n| ------------- | ------------- | ------------- |\n| `auth_header` | apiKey | API key |\n\nYou can set the security parameters through the `security` optional parameter when initializing the SDK client instance. For example:\n```python\nfrom codat_sync_for_commerce import CodatSyncCommerce\nfrom codat_sync_for_commerce.models import shared\n\ns = CodatSyncCommerce(\n security=shared.Security(\n auth_header=\"Basic BASE_64_ENCODED(API_KEY)\",\n ),\n)\n\nres = s.sync_flow_settings.get_config_text_sync_flow(request={\n \"locale\": shared.Locale.EN_US,\n})\n\nif res is not None:\n # handle response\n pass\n\n```\n<!-- End Authentication [security] -->\n\n<!-- Start Debugging [debug] -->\n## Debugging\n\nYou can setup your SDK to emit debug logs for SDK requests and responses.\n\nYou can pass your own logger class directly into your SDK.\n```python\nfrom codat_sync_for_commerce import CodatSyncCommerce\nimport logging\n\nlogging.basicConfig(level=logging.DEBUG)\ns = CodatSyncCommerce(debug_logger=logging.getLogger(\"codat_sync_for_commerce\"))\n```\n<!-- End Debugging [debug] -->\n\n<!-- Placeholder for Future Speakeasy SDK Sections -->\n\n<!-- Start Codat Support Notes -->\n### Support\n\nIf you encounter any challenges while utilizing our SDKs, please don't hesitate to reach out for assistance. \nYou 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).\nWe're here to help ensure a smooth experience for you.\n<!-- End Codat Support Notes -->\n\n<!-- Start Codat Generated By -->\n### Library generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)\n<!-- End Codat Generated By -->",
"bugtrack_url": null,
"license": null,
"summary": "Push merchants' data from your ecommerce or point-of-sale (POS) platform into your merchants' accounting platform.",
"version": "5.0.0",
"project_urls": {
"Homepage": "https://github.com/codatio/client-sdk-python.git",
"Repository": "https://github.com/codatio/client-sdk-python.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0dcafb4fc430e4ef9970a8e2c7d425e9b50701fc7f922e3c744abbb06282a5d6",
"md5": "eeb8b4c33d4240809afe38645a59796b",
"sha256": "4cf16a6d2d9639f62d6bfb0d2b1e444921970c9aa80b197f22f72a487501d754"
},
"downloads": -1,
"filename": "codat_sync_for_commerce-5.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "eeb8b4c33d4240809afe38645a59796b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 115074,
"upload_time": "2024-09-18T10:39:46",
"upload_time_iso_8601": "2024-09-18T10:39:46.112049Z",
"url": "https://files.pythonhosted.org/packages/0d/ca/fb4fc430e4ef9970a8e2c7d425e9b50701fc7f922e3c744abbb06282a5d6/codat_sync_for_commerce-5.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8f5568dd3bc5e07f837208574a7db58df3ae601bd88f3b916760d226c69a05cd",
"md5": "ad9755c658636eb076975139e17788f4",
"sha256": "3296fb198a435ab664331f77968a258ec416b05a565b14aaeb10b53eb5d91efe"
},
"downloads": -1,
"filename": "codat_sync_for_commerce-5.0.0.tar.gz",
"has_sig": false,
"md5_digest": "ad9755c658636eb076975139e17788f4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 54983,
"upload_time": "2024-09-18T10:39:47",
"upload_time_iso_8601": "2024-09-18T10:39:47.709113Z",
"url": "https://files.pythonhosted.org/packages/8f/55/68dd3bc5e07f837208574a7db58df3ae601bd88f3b916760d226c69a05cd/codat_sync_for_commerce-5.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-18 10:39:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "codatio",
"github_project": "client-sdk-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "codat-sync-for-commerce"
}
JSON
