| Name | codat-synccommerce JSON |
| Version |
0.8.5
JSON |
| download |
| home_page | |
| Summary | Python Client SDK Generated by Speakeasy |
| upload_time | 2023-04-05 09:30:50 |
| maintainer | |
| docs_url | None |
| author | Speakeasy |
| requires_python | >=3.9 |
| license | |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# codat-synccommerce
<!-- Start SDK Installation -->
## SDK Installation
```bash
pip install codat-synccommerce
```
<!-- End SDK Installation -->
## SDK Example Usage
<!-- Start SDK Example Usage -->
```python
import codat
from codat.models import operations, shared
s = codat.Codat(
security=shared.Security(
auth_header="YOUR_API_KEY_HERE",
),
)
req = shared.CreateCompany(
name="Bob's Burgers",
)
res = s.company_management.create_company(req)
if res.company is not None:
# handle response
```
<!-- End SDK Example Usage -->
<!-- Start SDK Available Operations -->
## Available Resources and Operations
### company_management
* `create_company` - Create a sync for commerce company
* `create_connection` - Create a data connection
* `list_companies` - List companies
* `list_connections` - List data connections
* `update_connection` - Update data connection
### configuration
* `get_configuration` - Retrieve config preferences set for a company.
* `get_sync_status` - Get status for a company's syncs
* `set_configuration` - Create or update configuration.
### integrations
* `get_integration_branding` - Get branding for an integration
* `list_integrations` - List information on Codat's supported integrations
### sync
* `request_sync` - Run a Commerce sync from the last successful sync
* `request_sync_for_date_range` - Run a Commerce sync from a given date range
### sync_flow_preferences
* `get_config_text_sync_flow` - Retrieve preferences for text fields on Sync Flow
* `get_sync_flow_url` - Retrieve sync flow url
* `get_visible_accounts` - List visible accounts
* `update_config_text_sync_flow` - Update preferences for text fields on sync flow
* `update_visible_accounts_sync_flow` - Update the visible accounts on Sync Flow
<!-- End SDK Available Operations -->
### SDK Generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
Raw data
{
"_id": null,
"home_page": "",
"name": "codat-synccommerce",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "",
"author": "Speakeasy",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/f6/75/61247e32d91e7b1f97c458dadb8fcad817879db7b281fc472c3e30be1ba4/codat-synccommerce-0.8.5.tar.gz",
"platform": null,
"description": "# codat-synccommerce\n\n<!-- Start SDK Installation -->\n## SDK Installation\n\n```bash\npip install codat-synccommerce\n```\n<!-- End SDK Installation -->\n\n## SDK Example Usage\n<!-- Start SDK Example Usage -->\n```python\nimport codat\nfrom codat.models import operations, shared\n\ns = codat.Codat(\n security=shared.Security(\n auth_header=\"YOUR_API_KEY_HERE\",\n ),\n)\n\n\nreq = shared.CreateCompany(\n name=\"Bob's Burgers\",\n)\n \nres = s.company_management.create_company(req)\n\nif res.company is not None:\n # handle response\n```\n<!-- End SDK Example Usage -->\n\n<!-- Start SDK Available Operations -->\n## Available Resources and Operations\n\n\n### company_management\n\n* `create_company` - Create a sync for commerce company\n* `create_connection` - Create a data connection\n* `list_companies` - List companies\n* `list_connections` - List data connections\n* `update_connection` - Update data connection\n\n### configuration\n\n* `get_configuration` - Retrieve config preferences set for a company.\n* `get_sync_status` - Get status for a company's syncs\n* `set_configuration` - Create or update configuration.\n\n### integrations\n\n* `get_integration_branding` - Get branding for an integration\n* `list_integrations` - List information on Codat's supported integrations\n\n### sync\n\n* `request_sync` - Run a Commerce sync from the last successful sync\n* `request_sync_for_date_range` - Run a Commerce sync from a given date range\n\n### sync_flow_preferences\n\n* `get_config_text_sync_flow` - Retrieve preferences for text fields on Sync Flow\n* `get_sync_flow_url` - Retrieve sync flow url\n* `get_visible_accounts` - List visible accounts\n* `update_config_text_sync_flow` - Update preferences for text fields on sync flow\n* `update_visible_accounts_sync_flow` - Update the visible accounts on Sync Flow\n<!-- End SDK Available Operations -->\n\n### SDK Generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Python Client SDK Generated by Speakeasy",
"version": "0.8.5",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f661a2e922e2673f81336f8fb0ab94a1995722f07fcccdd5c5659eeac04d5a8f",
"md5": "9e0512a7e6418993b26d6a3a6ccc0d68",
"sha256": "78c39689f32d0f9239a356c8309416e2a98698514fa416d7d544ac16a7153196"
},
"downloads": -1,
"filename": "codat_synccommerce-0.8.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9e0512a7e6418993b26d6a3a6ccc0d68",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 56886,
"upload_time": "2023-04-05T09:30:49",
"upload_time_iso_8601": "2023-04-05T09:30:49.177223Z",
"url": "https://files.pythonhosted.org/packages/f6/61/a2e922e2673f81336f8fb0ab94a1995722f07fcccdd5c5659eeac04d5a8f/codat_synccommerce-0.8.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f67561247e32d91e7b1f97c458dadb8fcad817879db7b281fc472c3e30be1ba4",
"md5": "733490ef4df0a76ce81979536a948d85",
"sha256": "4ddffc67a8966887c891805c692485231ab77a60be5651bf5f37def134cba264"
},
"downloads": -1,
"filename": "codat-synccommerce-0.8.5.tar.gz",
"has_sig": false,
"md5_digest": "733490ef4df0a76ce81979536a948d85",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 23870,
"upload_time": "2023-04-05T09:30:50",
"upload_time_iso_8601": "2023-04-05T09:30:50.427550Z",
"url": "https://files.pythonhosted.org/packages/f6/75/61247e32d91e7b1f97c458dadb8fcad817879db7b281fc472c3e30be1ba4/codat-synccommerce-0.8.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-05 09:30:50",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "codat-synccommerce"
}
