| Name | codat-common JSON |
| Version |
0.33.1
JSON |
| download |
| home_page | |
| Summary | Python Client SDK Generated by Speakeasy |
| upload_time | 2023-07-14 17:38: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-common
<!-- Start SDK Installation -->
## SDK Installation
```bash
pip install codat-common
```
<!-- End SDK Installation -->
## SDK Example Usage
<!-- Start SDK Example Usage -->
```python
import codatcommon
from codatcommon.models import shared
s = codatcommon.CodatCommon(
security=shared.Security(
auth_header="",
),
)
req = shared.CompanyRequestBody(
description='Requested early access to the new financing scheme.',
name='Bank of Dave',
)
res = s.companies.create(req)
if res.company is not None:
# handle response
```
<!-- End SDK Example Usage -->
<!-- Start SDK Available Operations -->
## Available Resources and Operations
### [companies](docs/sdks/companies/README.md)
* [create](docs/sdks/companies/README.md#create) - Create company
* [delete](docs/sdks/companies/README.md#delete) - Delete a company
* [get](docs/sdks/companies/README.md#get) - Get company
* [list](docs/sdks/companies/README.md#list) - List companies
* [update](docs/sdks/companies/README.md#update) - Update company
### [connections](docs/sdks/connections/README.md)
* [create](docs/sdks/connections/README.md#create) - Create connection
* [delete](docs/sdks/connections/README.md#delete) - Delete connection
* [get](docs/sdks/connections/README.md#get) - Get connection
* [list](docs/sdks/connections/README.md#list) - List connections
* [unlink_connection](docs/sdks/connections/README.md#unlink_connection) - Unlink connection
* [update_authorization](docs/sdks/connections/README.md#update_authorization) - Update authorization
### [integrations](docs/sdks/integrations/README.md)
* [get](docs/sdks/integrations/README.md#get) - Get integration
* [get_branding](docs/sdks/integrations/README.md#get_branding) - Get branding
* [list](docs/sdks/integrations/README.md#list) - List integrations
### [push_data](docs/sdks/pushdata/README.md)
* [get_model_options](docs/sdks/pushdata/README.md#get_model_options) - Get push options
* [get_operation](docs/sdks/pushdata/README.md#get_operation) - Get push operation
* [list_operations](docs/sdks/pushdata/README.md#list_operations) - List push operations
### [refresh_data](docs/sdks/refreshdata/README.md)
* [all](docs/sdks/refreshdata/README.md#all) - Refresh all data
* [by_data_type](docs/sdks/refreshdata/README.md#by_data_type) - Refresh data type
* [get](docs/sdks/refreshdata/README.md#get) - Get data status
* [get_pull_operation](docs/sdks/refreshdata/README.md#get_pull_operation) - Get pull operation
* [list_pull_operations](docs/sdks/refreshdata/README.md#list_pull_operations) - List pull operations
### [settings](docs/sdks/settings/README.md)
* [~~get_profile~~](docs/sdks/settings/README.md#get_profile) - Get profile :warning: **Deprecated**
* [get_sync_settings](docs/sdks/settings/README.md#get_sync_settings) - Get sync settings
* [update_profile](docs/sdks/settings/README.md#update_profile) - Update profile
* [update_sync_settings](docs/sdks/settings/README.md#update_sync_settings) - Update all sync settings
### [supplemental_data](docs/sdks/supplementaldata/README.md)
* [configure](docs/sdks/supplementaldata/README.md#configure) - Configure
* [get_configuration](docs/sdks/supplementaldata/README.md#get_configuration) - Get configuration
### [webhooks](docs/sdks/webhooks/README.md)
* [create](docs/sdks/webhooks/README.md#create) - Create webhook
* [get](docs/sdks/webhooks/README.md#get) - Get webhook
* [list](docs/sdks/webhooks/README.md#list) - List webhooks
<!-- 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-common",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "",
"author": "Speakeasy",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/da/8d/3b5fde6390c9f1e918845f57d87a9e1fcf5ac208d0451cc77feee367111a/codat-common-0.33.1.tar.gz",
"platform": null,
"description": "# codat-common\n\n<!-- Start SDK Installation -->\n## SDK Installation\n\n```bash\npip install codat-common\n```\n<!-- End SDK Installation -->\n\n## SDK Example Usage\n<!-- Start SDK Example Usage -->\n\n\n```python\nimport codatcommon\nfrom codatcommon.models import shared\n\ns = codatcommon.CodatCommon(\n security=shared.Security(\n auth_header=\"\",\n ),\n)\n\nreq = shared.CompanyRequestBody(\n description='Requested early access to the new financing scheme.',\n name='Bank of Dave',\n)\n\nres = s.companies.create(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### [companies](docs/sdks/companies/README.md)\n\n* [create](docs/sdks/companies/README.md#create) - Create company\n* [delete](docs/sdks/companies/README.md#delete) - Delete a company\n* [get](docs/sdks/companies/README.md#get) - Get company\n* [list](docs/sdks/companies/README.md#list) - List companies\n* [update](docs/sdks/companies/README.md#update) - Update company\n\n### [connections](docs/sdks/connections/README.md)\n\n* [create](docs/sdks/connections/README.md#create) - Create connection\n* [delete](docs/sdks/connections/README.md#delete) - Delete connection\n* [get](docs/sdks/connections/README.md#get) - Get connection\n* [list](docs/sdks/connections/README.md#list) - List connections\n* [unlink_connection](docs/sdks/connections/README.md#unlink_connection) - Unlink connection\n* [update_authorization](docs/sdks/connections/README.md#update_authorization) - Update authorization\n\n### [integrations](docs/sdks/integrations/README.md)\n\n* [get](docs/sdks/integrations/README.md#get) - Get integration\n* [get_branding](docs/sdks/integrations/README.md#get_branding) - Get branding\n* [list](docs/sdks/integrations/README.md#list) - List integrations\n\n### [push_data](docs/sdks/pushdata/README.md)\n\n* [get_model_options](docs/sdks/pushdata/README.md#get_model_options) - Get push options\n* [get_operation](docs/sdks/pushdata/README.md#get_operation) - Get push operation\n* [list_operations](docs/sdks/pushdata/README.md#list_operations) - List push operations\n\n### [refresh_data](docs/sdks/refreshdata/README.md)\n\n* [all](docs/sdks/refreshdata/README.md#all) - Refresh all data\n* [by_data_type](docs/sdks/refreshdata/README.md#by_data_type) - Refresh data type\n* [get](docs/sdks/refreshdata/README.md#get) - Get data status\n* [get_pull_operation](docs/sdks/refreshdata/README.md#get_pull_operation) - Get pull operation\n* [list_pull_operations](docs/sdks/refreshdata/README.md#list_pull_operations) - List pull operations\n\n### [settings](docs/sdks/settings/README.md)\n\n* [~~get_profile~~](docs/sdks/settings/README.md#get_profile) - Get profile :warning: **Deprecated**\n* [get_sync_settings](docs/sdks/settings/README.md#get_sync_settings) - Get sync settings\n* [update_profile](docs/sdks/settings/README.md#update_profile) - Update profile\n* [update_sync_settings](docs/sdks/settings/README.md#update_sync_settings) - Update all sync settings\n\n### [supplemental_data](docs/sdks/supplementaldata/README.md)\n\n* [configure](docs/sdks/supplementaldata/README.md#configure) - Configure\n* [get_configuration](docs/sdks/supplementaldata/README.md#get_configuration) - Get configuration\n\n### [webhooks](docs/sdks/webhooks/README.md)\n\n* [create](docs/sdks/webhooks/README.md#create) - Create webhook\n* [get](docs/sdks/webhooks/README.md#get) - Get webhook\n* [list](docs/sdks/webhooks/README.md#list) - List webhooks\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.33.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a0c6fd4bbe1cc2c85ca69f7313c276486557116c53a4e504019addaeee141075",
"md5": "e4afba2e5b402b111ff6782d659274ed",
"sha256": "2e6ca0c3c40392fdd935efe6c1a1424a066ca982f83269e104226eb4822192db"
},
"downloads": -1,
"filename": "codat_common-0.33.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e4afba2e5b402b111ff6782d659274ed",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 94982,
"upload_time": "2023-07-14T17:38:49",
"upload_time_iso_8601": "2023-07-14T17:38:49.326519Z",
"url": "https://files.pythonhosted.org/packages/a0/c6/fd4bbe1cc2c85ca69f7313c276486557116c53a4e504019addaeee141075/codat_common-0.33.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "da8d3b5fde6390c9f1e918845f57d87a9e1fcf5ac208d0451cc77feee367111a",
"md5": "ddff18b317c8a452ec8aedea124385c0",
"sha256": "221382d7f8bd7c61c0e8159e29295c4b40df74e59080663558db9f222151c345"
},
"downloads": -1,
"filename": "codat-common-0.33.1.tar.gz",
"has_sig": false,
"md5_digest": "ddff18b317c8a452ec8aedea124385c0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 35558,
"upload_time": "2023-07-14T17:38:50",
"upload_time_iso_8601": "2023-07-14T17:38:50.802644Z",
"url": "https://files.pythonhosted.org/packages/da/8d/3b5fde6390c9f1e918845f57d87a9e1fcf5ac208d0451cc77feee367111a/codat-common-0.33.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-14 17:38:50",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "codat-common"
}
