diff --git a/platform/README.md b/platform/README.md index f34783408..fb464765e 100644 --- a/platform/README.md +++ b/platform/README.md @@ -40,7 +40,7 @@ if res.company is not None: ## Available Resources and Operations -### [companies](docs/sdks/companies/README.md) +### [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 @@ -48,7 +48,7 @@ if res.company is not None: * [list](docs/sdks/companies/README.md#list) - List companies * [update](docs/sdks/companies/README.md#update) - Update company -### [connections](docs/sdks/connections/README.md) +### [Connections](docs/sdks/connections/README.md) * [create](docs/sdks/connections/README.md#create) - Create connection * [delete](docs/sdks/connections/README.md#delete) - Delete connection @@ -57,19 +57,19 @@ if res.company is not None: * [unlink](docs/sdks/connections/README.md#unlink) - Unlink connection * [update_authorization](docs/sdks/connections/README.md#update_authorization) - Update authorization -### [integrations](docs/sdks/integrations/README.md) +### [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) +### [PushData](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) +### [RefreshData](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 @@ -77,7 +77,7 @@ if res.company is not None: * [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) +### [Settings](docs/sdks/settings/README.md) * [create_api_key](docs/sdks/settings/README.md#create_api_key) - Create API key * [delete_api_key](docs/sdks/settings/README.md#delete_api_key) - Delete api key @@ -87,12 +87,12 @@ if res.company is not None: * [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) +### [SupplementalData](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) +### [Webhooks](docs/sdks/webhooks/README.md) * [create](docs/sdks/webhooks/README.md#create) - Create webhook * [get](docs/sdks/webhooks/README.md#get) - Get webhook diff --git a/platform/RELEASES.md b/platform/RELEASES.md index 884866d02..92f10ea18 100644 --- a/platform/RELEASES.md +++ b/platform/RELEASES.md @@ -18,4 +18,14 @@ Based on: ### Generated - [python v0.2.0] platform ### Releases -- [PyPI v0.2.0] https://pypi.org/project/codat-platform/0.2.0 - platform \ No newline at end of file +- [PyPI v0.2.0] https://pypi.org/project/codat-platform/0.2.0 - platform + +## 2023-09-18 21:45:30 +### Changes +Based on: +- OpenAPI Doc 3.0.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Platform.yaml +- Speakeasy CLI 1.87.0 (2.116.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.1.0] platform +### Releases +- [PyPI v1.1.0] https://pypi.org/project/codat-platform/1.1.0 - platform \ No newline at end of file diff --git a/platform/docs/models/shared/clientratelimitreachedwebhook.md b/platform/docs/models/shared/clientratelimitreachedwebhook.md new file mode 100755 index 000000000..3d7030310 --- /dev/null +++ b/platform/docs/models/shared/clientratelimitreachedwebhook.md @@ -0,0 +1,16 @@ +# ClientRateLimitReachedWebhook + +Webhook request body for a client that has reached their rate limit. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | +| `alert_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the webhook event. | +| `client_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your client in Codat. | +| `client_name` | *Optional[str]* | :heavy_minus_sign: | Name of your client in Codat. | +| `data` | [Optional[ClientRateLimitReachedWebhookData]](../../models/shared/clientratelimitreachedwebhookdata.md) | :heavy_minus_sign: | N/A | +| `message` | *Optional[str]* | :heavy_minus_sign: | A human readable message about the webhook. | +| `rule_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rule. | +| `rule_type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | \ No newline at end of file diff --git a/platform/docs/models/shared/clientratelimitreachedwebhookdata.md b/platform/docs/models/shared/clientratelimitreachedwebhookdata.md new file mode 100755 index 000000000..caa124b1b --- /dev/null +++ b/platform/docs/models/shared/clientratelimitreachedwebhookdata.md @@ -0,0 +1,9 @@ +# ClientRateLimitReachedWebhookData + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `daily_quota` | *Optional[int]* | :heavy_minus_sign: | The number of available requests per day. | | +| `expires_utc` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | \ No newline at end of file diff --git a/platform/docs/models/shared/clientratelimitresetwebhook.md b/platform/docs/models/shared/clientratelimitresetwebhook.md new file mode 100755 index 000000000..7336566a4 --- /dev/null +++ b/platform/docs/models/shared/clientratelimitresetwebhook.md @@ -0,0 +1,16 @@ +# ClientRateLimitResetWebhook + +Webhook request body for a client that has had their rate limit reset. + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| `alert_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the webhook event. | +| `client_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your client in Codat. | +| `client_name` | *Optional[str]* | :heavy_minus_sign: | Name of your client in Codat. | +| `data` | [Optional[ClientRateLimitResetWebhookData]](../../models/shared/clientratelimitresetwebhookdata.md) | :heavy_minus_sign: | N/A | +| `message` | *Optional[str]* | :heavy_minus_sign: | A human readable message about the webhook. | +| `rule_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rule. | +| `rule_type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | \ No newline at end of file diff --git a/platform/docs/models/shared/clientratelimitresetwebhookdata.md b/platform/docs/models/shared/clientratelimitresetwebhookdata.md new file mode 100755 index 000000000..1b2b1eb58 --- /dev/null +++ b/platform/docs/models/shared/clientratelimitresetwebhookdata.md @@ -0,0 +1,11 @@ +# ClientRateLimitResetWebhookData + + +## Fields + +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `daily_quota` | *Optional[int]* | :heavy_minus_sign: | The number of available requests per day. | | +| `expires_utc` | *Optional[str]* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | +| `quota_remaining` | *Optional[int]* | :heavy_minus_sign: | Total number of request remaining for your client. | | +| `reset_reason` | *Optional[str]* | :heavy_minus_sign: | The reason for your rate limit quota being reset. | | \ No newline at end of file diff --git a/platform/docs/models/shared/companydataconnectionstatuschangedwebhook.md b/platform/docs/models/shared/companydataconnectionstatuschangedwebhook.md deleted file mode 100755 index ea7232cbe..000000000 --- a/platform/docs/models/shared/companydataconnectionstatuschangedwebhook.md +++ /dev/null @@ -1,15 +0,0 @@ -# CompanyDataConnectionStatusChangedWebhook - -Webhook request body for a company's data connection status changed. - - -## Fields - -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `alert_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the webhook event. | | -| `company_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `data` | [Optional[CompanyDataConnectionStatusChangedWebhookData]](../../models/shared/companydataconnectionstatuschangedwebhookdata.md) | :heavy_minus_sign: | N/A | | -| `message` | *Optional[str]* | :heavy_minus_sign: | A human readable message about the webhook. | | -| `rule_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rule. | | -| `type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file diff --git a/platform/docs/models/shared/connectionstatuschangedwebhook.md b/platform/docs/models/shared/connectionstatuschangedwebhook.md new file mode 100755 index 000000000..4e3dac281 --- /dev/null +++ b/platform/docs/models/shared/connectionstatuschangedwebhook.md @@ -0,0 +1,18 @@ +# ConnectionStatusChangedWebhook + +Webhook request body for a company's data connection status changed. + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | +| `alert_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the webhook event. | | +| `client_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your client in Codat. | | +| `client_name` | *Optional[str]* | :heavy_minus_sign: | Name of your client in Codat. | | +| `company_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `data` | [Optional[ConnectionStatusChangedWebhookData]](../../models/shared/connectionstatuschangedwebhookdata.md) | :heavy_minus_sign: | N/A | | +| `data_connection_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `message` | *Optional[str]* | :heavy_minus_sign: | A human readable message about the webhook. | | +| `rule_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rule. | | +| `rule_type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file diff --git a/platform/docs/models/shared/companydataconnectionstatuschangedwebhookdata.md b/platform/docs/models/shared/connectionstatuschangedwebhookdata.md similarity index 99% rename from platform/docs/models/shared/companydataconnectionstatuschangedwebhookdata.md rename to platform/docs/models/shared/connectionstatuschangedwebhookdata.md index 5b5dc5b64..def3a3cf6 100755 --- a/platform/docs/models/shared/companydataconnectionstatuschangedwebhookdata.md +++ b/platform/docs/models/shared/connectionstatuschangedwebhookdata.md @@ -1,4 +1,4 @@ -# CompanyDataConnectionStatusChangedWebhookData +# ConnectionStatusChangedWebhookData ## Fields diff --git a/platform/docs/models/shared/datasetdatachangedwebhook.md b/platform/docs/models/shared/datasetdatachangedwebhook.md index 999204772..f3ea77861 100755 --- a/platform/docs/models/shared/datasetdatachangedwebhook.md +++ b/platform/docs/models/shared/datasetdatachangedwebhook.md @@ -5,11 +5,14 @@ Webhook request body to notify that a data synchronization has completed. ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `alert_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the webhook event. | | -| `company_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `data` | [Optional[DatasetDataChangedWebhookData]](../../models/shared/datasetdatachangedwebhookdata.md) | :heavy_minus_sign: | N/A | | -| `message` | *Optional[str]* | :heavy_minus_sign: | A human readable message about the webhook. | | -| `rule_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rule. | | -| `type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | +| `alert_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the webhook event. | | +| `client_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your client in Codat. | | +| `client_name` | *Optional[str]* | :heavy_minus_sign: | Name of your client in Codat. | | +| `company_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `data` | [Optional[DatasetDataChangedWebhookDatasetDataChangedWebhookData]](../../models/shared/datasetdatachangedwebhookdatasetdatachangedwebhookdata.md) | :heavy_minus_sign: | N/A | | +| `data_connection_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `message` | *Optional[str]* | :heavy_minus_sign: | A human readable message about the webhook. | | +| `rule_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rule. | | +| `rule_type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file diff --git a/platform/docs/models/shared/datasetdatachangedwebhookdata.md b/platform/docs/models/shared/datasetdatachangedwebhookdata.md deleted file mode 100755 index c3377811c..000000000 --- a/platform/docs/models/shared/datasetdatachangedwebhookdata.md +++ /dev/null @@ -1,9 +0,0 @@ -# DatasetDataChangedWebhookData - - -## Fields - -| Field | Type | Required | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `data_type` | *Optional[str]* | :heavy_minus_sign: | Data type the sync completed for. | -| `dataset_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the dataset that completed its sync. | \ No newline at end of file diff --git a/platform/docs/models/shared/datasetdatachangedwebhookdatasetdatachangedwebhookdata.md b/platform/docs/models/shared/datasetdatachangedwebhookdatasetdatachangedwebhookdata.md new file mode 100755 index 000000000..5b9297e61 --- /dev/null +++ b/platform/docs/models/shared/datasetdatachangedwebhookdatasetdatachangedwebhookdata.md @@ -0,0 +1,9 @@ +# DatasetDataChangedWebhookDatasetDataChangedWebhookData + + +## Fields + +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `data_type` | [Optional[DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | +| `dataset_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the dataset that completed its sync. | | \ No newline at end of file diff --git a/platform/docs/models/shared/datasetstatuschangederrorwebhook.md b/platform/docs/models/shared/datasetstatuschangederrorwebhook.md index ce6e37f0d..73b468624 100755 --- a/platform/docs/models/shared/datasetstatuschangederrorwebhook.md +++ b/platform/docs/models/shared/datasetstatuschangederrorwebhook.md @@ -8,8 +8,11 @@ Webhook request body to notify that a data synchronization has completed. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | | `alert_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the webhook event. | | +| `client_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your client in Codat. | | +| `client_name` | *Optional[str]* | :heavy_minus_sign: | Name of your client in Codat. | | | `company_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `data` | [Optional[DatasetStatusChangedErrorWebhookData]](../../models/shared/datasetstatuschangederrorwebhookdata.md) | :heavy_minus_sign: | N/A | | +| `data_connection_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `message` | *Optional[str]* | :heavy_minus_sign: | A human readable message about the webhook. | | | `rule_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rule. | | -| `type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file +| `rule_type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file diff --git a/platform/docs/models/shared/datasetstatuschangederrorwebhookdata.md b/platform/docs/models/shared/datasetstatuschangederrorwebhookdata.md index 2767bf8e0..9354de3a5 100755 --- a/platform/docs/models/shared/datasetstatuschangederrorwebhookdata.md +++ b/platform/docs/models/shared/datasetstatuschangederrorwebhookdata.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `data_type` | *Optional[str]* | :heavy_minus_sign: | Data type the sync completed for. | -| `dataset_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the dataset that completed its sync. | -| `dataset_status` | *Optional[str]* | :heavy_minus_sign: | The current status of the dataset's sync. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `data_type` | [Optional[DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | +| `dataset_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the dataset that completed its sync. | | +| `dataset_status` | *Optional[str]* | :heavy_minus_sign: | The current status of the dataset's sync. | | \ No newline at end of file diff --git a/platform/docs/models/shared/datasynccompletedwebhook.md b/platform/docs/models/shared/datasynccompletedwebhook.md index 20d4db14b..96ea02d91 100755 --- a/platform/docs/models/shared/datasynccompletedwebhook.md +++ b/platform/docs/models/shared/datasynccompletedwebhook.md @@ -15,4 +15,4 @@ Webhook request body to notify the completion of a data sync. | `data_connection_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `message` | *Optional[str]* | :heavy_minus_sign: | A human readable message about the webhook. | | | `rule_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rule. | | -| `type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file +| `rule_type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file diff --git a/platform/docs/models/shared/datasynccompletedwebhookdata.md b/platform/docs/models/shared/datasynccompletedwebhookdata.md index ecb9a361a..5a1252636 100755 --- a/platform/docs/models/shared/datasynccompletedwebhookdata.md +++ b/platform/docs/models/shared/datasynccompletedwebhookdata.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | -| `data_type` | *Optional[str]* | :heavy_minus_sign: | Data type the sync completed for. | -| `dataset_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the dataset that completed its sync. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------- | +| `data_type` | [Optional[DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | +| `dataset_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the dataset that completed its sync. | | \ No newline at end of file diff --git a/platform/docs/models/shared/newcompanysynchronizedwebhook.md b/platform/docs/models/shared/newcompanysynchronizedwebhook.md index ac91aedb0..431416ec4 100755 --- a/platform/docs/models/shared/newcompanysynchronizedwebhook.md +++ b/platform/docs/models/shared/newcompanysynchronizedwebhook.md @@ -5,10 +5,14 @@ Webhook request body to notify that a new company has successfully synchronized ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `alert_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the webhook event. | | -| `company_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `message` | *Optional[str]* | :heavy_minus_sign: | A human readable message about the webhook. | | -| `rule_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rule. | | -| `type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | +| `alert_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the webhook event. | | +| `client_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your client in Codat. | | +| `client_name` | *Optional[str]* | :heavy_minus_sign: | Name of your client in Codat. | | +| `company_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `data` | [Optional[NewCompanySynchronizedWebhookData]](../../models/shared/newcompanysynchronizedwebhookdata.md) | :heavy_minus_sign: | N/A | | +| `data_connection_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `message` | *Optional[str]* | :heavy_minus_sign: | A human readable message about the webhook. | | +| `rule_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rule. | | +| `rule_type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file diff --git a/platform/docs/models/shared/newcompanysynchronizedwebhookdata.md b/platform/docs/models/shared/newcompanysynchronizedwebhookdata.md new file mode 100755 index 000000000..874203b26 --- /dev/null +++ b/platform/docs/models/shared/newcompanysynchronizedwebhookdata.md @@ -0,0 +1,7 @@ +# NewCompanySynchronizedWebhookData + + +## Fields + +| Field | Type | Required | Description | +| ----------- | ----------- | ----------- | ----------- | \ No newline at end of file diff --git a/platform/docs/models/shared/pushoperation.md b/platform/docs/models/shared/pushoperation.md index 8537a2c10..c89b853f7 100755 --- a/platform/docs/models/shared/pushoperation.md +++ b/platform/docs/models/shared/pushoperation.md @@ -13,7 +13,7 @@ | `error_message` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `push_operation_key` | *str* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `requested_on_utc` | *str* | :heavy_check_mark: | In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example:

```
2020-10-08T22:40:50Z
2021-01-01T00:00:00
```



When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:

- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
- Unqualified local time: `2021-11-15T01:00:00`
- UTC time offsets: `2021-11-15T01:00:00-05:00`

> Time zones
>
> Not all dates from Codat will contain information about time zones.
> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z | -| `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The status of the push operation. | | +| `status` | [PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | | | `status_code` | *int* | :heavy_check_mark: | N/A | | | `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | N/A | | | ~~`timeout_in_seconds`~~ | *Optional[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | | diff --git a/platform/docs/models/shared/pushoperationstatus.md b/platform/docs/models/shared/pushoperationstatus.md index 4125ba6a3..721aaa76b 100755 --- a/platform/docs/models/shared/pushoperationstatus.md +++ b/platform/docs/models/shared/pushoperationstatus.md @@ -1,6 +1,6 @@ # PushOperationStatus -The status of the push operation. +The current status of the push operation. ## Values diff --git a/platform/docs/models/shared/pushoperationstatuschangedwebhook.md b/platform/docs/models/shared/pushoperationstatuschangedwebhook.md index 85e23a33b..5d723d181 100755 --- a/platform/docs/models/shared/pushoperationstatuschangedwebhook.md +++ b/platform/docs/models/shared/pushoperationstatuschangedwebhook.md @@ -8,8 +8,11 @@ Webhook request body for a push operation status change. | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | | `alert_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the webhook event. | | +| `client_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your client in Codat. | | +| `client_name` | *Optional[str]* | :heavy_minus_sign: | Name of your client in Codat. | | | `company_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `data` | [Optional[PushOperationStatusChangedWebhookData]](../../models/shared/pushoperationstatuschangedwebhookdata.md) | :heavy_minus_sign: | N/A | | +| `data_connection_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `message` | *Optional[str]* | :heavy_minus_sign: | A human readable message about the webhook. | | | `rule_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rule. | | -| `type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file +| `rule_type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file diff --git a/platform/docs/models/shared/pushoperationstatuschangedwebhookdata.md b/platform/docs/models/shared/pushoperationstatuschangedwebhookdata.md index 6740b1a92..0f85e0b7c 100755 --- a/platform/docs/models/shared/pushoperationstatuschangedwebhookdata.md +++ b/platform/docs/models/shared/pushoperationstatuschangedwebhookdata.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `data_type` | *Optional[str]* | :heavy_minus_sign: | Data type used in the push operation. | -| `push_operation_key` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the push operation. | -| `status` | *Optional[str]* | :heavy_minus_sign: | The current status of the push operation. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `data_type` | [Optional[DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | +| `push_operation_key` | *Optional[str]* | :heavy_minus_sign: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | +| `status` | [Optional[PushOperationStatus]](../../models/shared/pushoperationstatus.md) | :heavy_minus_sign: | The current status of the push operation. | | \ No newline at end of file diff --git a/platform/docs/models/shared/pushoperationtimedoutwebhook.md b/platform/docs/models/shared/pushoperationtimedoutwebhook.md index ea7bb906c..ba9b95c03 100755 --- a/platform/docs/models/shared/pushoperationtimedoutwebhook.md +++ b/platform/docs/models/shared/pushoperationtimedoutwebhook.md @@ -8,8 +8,11 @@ Webhook request body notifying that a push push operation has timed out. | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | | `alert_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the webhook event. | | +| `client_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your client in Codat. | | +| `client_name` | *Optional[str]* | :heavy_minus_sign: | Name of your client in Codat. | | | `company_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `data` | [Optional[PushOperationTimedOutWebhookData]](../../models/shared/pushoperationtimedoutwebhookdata.md) | :heavy_minus_sign: | N/A | | +| `data_connection_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `message` | *Optional[str]* | :heavy_minus_sign: | A human readable message about the webhook. | | | `rule_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the rule. | | -| `type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file +| `rule_type` | *Optional[str]* | :heavy_minus_sign: | The type of rule. | | \ No newline at end of file diff --git a/platform/docs/models/shared/pushoperationtimedoutwebhookdata.md b/platform/docs/models/shared/pushoperationtimedoutwebhookdata.md index b90d9ddd9..187482837 100755 --- a/platform/docs/models/shared/pushoperationtimedoutwebhookdata.md +++ b/platform/docs/models/shared/pushoperationtimedoutwebhookdata.md @@ -3,7 +3,8 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `data_type` | *Optional[str]* | :heavy_minus_sign: | Data type used in the push operation. | -| `push_operation_key` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the push operation. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `data_type` | [Optional[DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | +| `push_operation_guid` | *Optional[str]* | :heavy_minus_sign: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | +| `push_operation_key` | *Optional[str]* | :heavy_minus_sign: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | \ No newline at end of file diff --git a/platform/docs/models/webhooks/clientratelimitreachedresponse.md b/platform/docs/models/webhooks/clientratelimitreachedresponse.md new file mode 100755 index 000000000..a5368aedf --- /dev/null +++ b/platform/docs/models/webhooks/clientratelimitreachedresponse.md @@ -0,0 +1,10 @@ +# ClientRateLimitReachedResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/platform/docs/models/webhooks/clientratelimitresetresponse.md b/platform/docs/models/webhooks/clientratelimitresetresponse.md new file mode 100755 index 000000000..d5db35b1b --- /dev/null +++ b/platform/docs/models/webhooks/clientratelimitresetresponse.md @@ -0,0 +1,10 @@ +# ClientRateLimitResetResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | N/A | +| `status_code` | *int* | :heavy_check_mark: | N/A | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/platform/docs/sdks/companies/README.md b/platform/docs/sdks/companies/README.md index b06aa33ab..442cd3707 100755 --- a/platform/docs/sdks/companies/README.md +++ b/platform/docs/sdks/companies/README.md @@ -1,4 +1,4 @@ -# companies +# Companies ## Overview diff --git a/platform/docs/sdks/connections/README.md b/platform/docs/sdks/connections/README.md index e266441e9..560cff70d 100755 --- a/platform/docs/sdks/connections/README.md +++ b/platform/docs/sdks/connections/README.md @@ -1,4 +1,4 @@ -# connections +# Connections ## Overview diff --git a/platform/docs/sdks/integrations/README.md b/platform/docs/sdks/integrations/README.md index d365671c7..5486e2f24 100755 --- a/platform/docs/sdks/integrations/README.md +++ b/platform/docs/sdks/integrations/README.md @@ -1,4 +1,4 @@ -# integrations +# Integrations ## Overview diff --git a/platform/docs/sdks/pushdata/README.md b/platform/docs/sdks/pushdata/README.md index e9e74e480..fa4cc3e86 100755 --- a/platform/docs/sdks/pushdata/README.md +++ b/platform/docs/sdks/pushdata/README.md @@ -1,4 +1,4 @@ -# push_data +# PushData ## Overview diff --git a/platform/docs/sdks/refreshdata/README.md b/platform/docs/sdks/refreshdata/README.md index 7ed92626f..5ae5c9d78 100755 --- a/platform/docs/sdks/refreshdata/README.md +++ b/platform/docs/sdks/refreshdata/README.md @@ -1,4 +1,4 @@ -# refresh_data +# RefreshData ## Overview diff --git a/platform/docs/sdks/settings/README.md b/platform/docs/sdks/settings/README.md index c876387c0..376a897b4 100755 --- a/platform/docs/sdks/settings/README.md +++ b/platform/docs/sdks/settings/README.md @@ -1,4 +1,4 @@ -# settings +# Settings ## Overview diff --git a/platform/docs/sdks/supplementaldata/README.md b/platform/docs/sdks/supplementaldata/README.md index b759ee0bd..fc2b6612a 100755 --- a/platform/docs/sdks/supplementaldata/README.md +++ b/platform/docs/sdks/supplementaldata/README.md @@ -1,4 +1,4 @@ -# supplemental_data +# SupplementalData ## Overview diff --git a/platform/docs/sdks/webhooks/README.md b/platform/docs/sdks/webhooks/README.md index 6c87d59c5..0e257c100 100755 --- a/platform/docs/sdks/webhooks/README.md +++ b/platform/docs/sdks/webhooks/README.md @@ -1,4 +1,4 @@ -# webhooks +# Webhooks ## Overview diff --git a/platform/files.gen b/platform/files.gen index 928a567e8..ad6e0cf23 100755 --- a/platform/files.gen +++ b/platform/files.gen @@ -103,14 +103,26 @@ src/codatplatform/models/shared/webhook.py src/codatplatform/models/shared/createrule.py src/codatplatform/models/shared/webhooks.py src/codatplatform/models/shared/security.py -src/codatplatform/models/shared/companydataconnectionstatuschangedwebhook.py +src/codatplatform/models/shared/clientratelimitreachedwebhook.py +src/codatplatform/models/shared/clientratelimitreachedwebhookdata.py +src/codatplatform/models/shared/clientratelimitresetwebhook.py +src/codatplatform/models/shared/clientratelimitresetwebhookdata.py +src/codatplatform/models/shared/connectionstatuschangedwebhook.py +src/codatplatform/models/shared/connectionstatuschangedwebhookdata.py src/codatplatform/models/shared/datasynccompletedwebhook.py +src/codatplatform/models/shared/datasynccompletedwebhookdata.py src/codatplatform/models/shared/datasetdatachangedwebhook.py src/codatplatform/models/shared/datasetstatuschangederrorwebhook.py +src/codatplatform/models/shared/datasetstatuschangederrorwebhookdata.py src/codatplatform/models/shared/newcompanysynchronizedwebhook.py +src/codatplatform/models/shared/newcompanysynchronizedwebhookdata.py src/codatplatform/models/shared/pushoperationtimedoutwebhook.py +src/codatplatform/models/shared/pushoperationtimedoutwebhookdata.py src/codatplatform/models/shared/pushoperationstatuschangedwebhook.py +src/codatplatform/models/shared/pushoperationstatuschangedwebhookdata.py src/codatplatform/models/shared/__init__.py +src/codatplatform/models/webhooks/client_rate_limit_reached.py +src/codatplatform/models/webhooks/client_rate_limit_reset.py src/codatplatform/models/webhooks/company_data_connection_status_changed.py src/codatplatform/models/webhooks/data_sync_completed.py src/codatplatform/models/webhooks/dataset_data_changed.py @@ -252,19 +264,26 @@ docs/models/shared/createrulenotifiers.md docs/models/shared/createrule.md docs/models/shared/webhooks.md docs/models/shared/security.md -docs/models/shared/companydataconnectionstatuschangedwebhookdata.md -docs/models/shared/companydataconnectionstatuschangedwebhook.md -docs/models/shared/datasynccompletedwebhookdata.md +docs/models/shared/clientratelimitreachedwebhook.md +docs/models/shared/clientratelimitreachedwebhookdata.md +docs/models/shared/clientratelimitresetwebhook.md +docs/models/shared/clientratelimitresetwebhookdata.md +docs/models/shared/connectionstatuschangedwebhook.md +docs/models/shared/connectionstatuschangedwebhookdata.md docs/models/shared/datasynccompletedwebhook.md -docs/models/shared/datasetdatachangedwebhookdata.md +docs/models/shared/datasynccompletedwebhookdata.md +docs/models/shared/datasetdatachangedwebhookdatasetdatachangedwebhookdata.md docs/models/shared/datasetdatachangedwebhook.md -docs/models/shared/datasetstatuschangederrorwebhookdata.md docs/models/shared/datasetstatuschangederrorwebhook.md +docs/models/shared/datasetstatuschangederrorwebhookdata.md docs/models/shared/newcompanysynchronizedwebhook.md -docs/models/shared/pushoperationtimedoutwebhookdata.md +docs/models/shared/newcompanysynchronizedwebhookdata.md docs/models/shared/pushoperationtimedoutwebhook.md -docs/models/shared/pushoperationstatuschangedwebhookdata.md +docs/models/shared/pushoperationtimedoutwebhookdata.md docs/models/shared/pushoperationstatuschangedwebhook.md +docs/models/shared/pushoperationstatuschangedwebhookdata.md +docs/models/webhooks/clientratelimitreachedresponse.md +docs/models/webhooks/clientratelimitresetresponse.md docs/models/webhooks/companydataconnectionstatuschangedresponse.md docs/models/webhooks/datasynccompletedresponse.md docs/models/webhooks/datasetdatachangedresponse.md diff --git a/platform/gen.yaml b/platform/gen.yaml index 877461df4..29073cbdf 100644 --- a/platform/gen.yaml +++ b/platform/gen.yaml @@ -1,16 +1,16 @@ configVersion: 1.0.0 management: - docChecksum: 6f41b61f64ea1dcaee9df6bc1e3cb37c + docChecksum: 22588f231182e4787ffec29bd112d175 docVersion: 3.0.0 - speakeasyVersion: 1.82.5 - generationVersion: 2.108.3 + speakeasyVersion: 1.87.0 + generationVersion: 2.116.0 generation: sdkClassName: CodatPlatform singleTagPerOp: false telemetryEnabled: true features: python: - core: 2.85.4 + core: 2.85.5 deprecations: 2.81.1 examples: 2.81.2 globalSecurity: 2.81.1 @@ -18,7 +18,7 @@ features: nameOverrides: 2.81.1 retries: 2.82.0 python: - version: 1.0.0 + version: 1.1.0 author: Codat description: Manage the building blocks of Codat, including companies, connections, and more. maxMethodParams: 0 diff --git a/platform/setup.py b/platform/setup.py index e3eb9996c..cb2d75830 100755 --- a/platform/setup.py +++ b/platform/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="codat-platform", - version="0.2.0", + version="1.1.0", author="Codat", description="Manage the building blocks of Codat, including companies, connections, and more.", long_description=long_description, diff --git a/platform/src/codatplatform/models/shared/__init__.py b/platform/src/codatplatform/models/shared/__init__.py index bbd79f3e8..e17a54c97 100755 --- a/platform/src/codatplatform/models/shared/__init__.py +++ b/platform/src/codatplatform/models/shared/__init__.py @@ -6,20 +6,27 @@ from .brandingbutton import * from .brandingimage import * from .brandinglogo import * +from .clientratelimitreachedwebhook import * +from .clientratelimitreachedwebhookdata import * +from .clientratelimitresetwebhook import * +from .clientratelimitresetwebhookdata import * from .companies import * from .company import * -from .companydataconnectionstatuschangedwebhook import * from .companyrequestbody import * from .connection import * from .connections import * +from .connectionstatuschangedwebhook import * +from .connectionstatuschangedwebhookdata import * from .createapikey import * from .createrule import * from .dataconnectionerror import * from .dataconnectionstatus import * from .datasetdatachangedwebhook import * from .datasetstatuschangederrorwebhook import * +from .datasetstatuschangederrorwebhookdata import * from .datastatus import * from .datasynccompletedwebhook import * +from .datasynccompletedwebhookdata import * from .datatype import * from .datatypefeature import * from .errormessage import * @@ -31,6 +38,7 @@ from .integrations import * from .links import * from .newcompanysynchronizedwebhook import * +from .newcompanysynchronizedwebhookdata import * from .profile import * from .pulloperation import * from .pulloperations import * @@ -42,7 +50,9 @@ from .pushoperations import * from .pushoperationstatus import * from .pushoperationstatuschangedwebhook import * +from .pushoperationstatuschangedwebhookdata import * from .pushoperationtimedoutwebhook import * +from .pushoperationtimedoutwebhookdata import * from .pushoption import * from .pushoptionchoice import * from .pushoptionproperty import * @@ -60,4 +70,4 @@ from .webhook import * from .webhooks import * -__all__ = ["APIKeyDetails","APIKeys","Branding","BrandingButton","BrandingImage","BrandingLogo","Companies","Company","CompanyDataConnectionStatusChangedWebhook","CompanyDataConnectionStatusChangedWebhookData","CompanyRequestBody","Connection","Connections","CreateAPIKey","CreateRule","CreateRuleNotifiers","DataConnectionError","DataConnectionStatus","DataStatus","DataSyncCompletedWebhook","DataSyncCompletedWebhookData","DataType","DataTypeFeature","DatasetDataChangedWebhook","DatasetDataChangedWebhookData","DatasetStatusChangedErrorWebhook","DatasetStatusChangedErrorWebhookData","ErrorMessage","FeatureState","FeatureType","HalRef","ImageReference","Integration","Integrations","Links","NewCompanySynchronizedWebhook","Profile","PullOperation","PullOperationStatus","PullOperations","PushChangeType","PushFieldValidation","PushOperation","PushOperationChange","PushOperationRef","PushOperationStatus","PushOperationStatusChangedWebhook","PushOperationStatusChangedWebhookData","PushOperationTimedOutWebhook","PushOperationTimedOutWebhookData","PushOperations","PushOption","PushOptionChoice","PushOptionProperty","PushOptionType","PushValidationInfo","Security","SourceType","SupplementalDataConfiguration","SupplementalDataConfigurationSupplementalDataSourceConfiguration","SupportedFeature","SyncSetting","SyncSettingDataTypes","SyncSettings","UpdateConnectionStatus","Validation","ValidationItem","Webhook","WebhookNotifiers","Webhooks"] +__all__ = ["APIKeyDetails","APIKeys","Branding","BrandingButton","BrandingImage","BrandingLogo","ClientRateLimitReachedWebhook","ClientRateLimitReachedWebhookData","ClientRateLimitResetWebhook","ClientRateLimitResetWebhookData","Companies","Company","CompanyRequestBody","Connection","ConnectionStatusChangedWebhook","ConnectionStatusChangedWebhookData","Connections","CreateAPIKey","CreateRule","CreateRuleNotifiers","DataConnectionError","DataConnectionStatus","DataStatus","DataSyncCompletedWebhook","DataSyncCompletedWebhookData","DataType","DataTypeFeature","DatasetDataChangedWebhook","DatasetDataChangedWebhookDatasetDataChangedWebhookData","DatasetStatusChangedErrorWebhook","DatasetStatusChangedErrorWebhookData","ErrorMessage","FeatureState","FeatureType","HalRef","ImageReference","Integration","Integrations","Links","NewCompanySynchronizedWebhook","NewCompanySynchronizedWebhookData","Profile","PullOperation","PullOperationStatus","PullOperations","PushChangeType","PushFieldValidation","PushOperation","PushOperationChange","PushOperationRef","PushOperationStatus","PushOperationStatusChangedWebhook","PushOperationStatusChangedWebhookData","PushOperationTimedOutWebhook","PushOperationTimedOutWebhookData","PushOperations","PushOption","PushOptionChoice","PushOptionProperty","PushOptionType","PushValidationInfo","Security","SourceType","SupplementalDataConfiguration","SupplementalDataConfigurationSupplementalDataSourceConfiguration","SupportedFeature","SyncSetting","SyncSettingDataTypes","SyncSettings","UpdateConnectionStatus","Validation","ValidationItem","Webhook","WebhookNotifiers","Webhooks"] diff --git a/platform/src/codatplatform/models/shared/clientratelimitreachedwebhook.py b/platform/src/codatplatform/models/shared/clientratelimitreachedwebhook.py new file mode 100755 index 000000000..87bc7f9d8 --- /dev/null +++ b/platform/src/codatplatform/models/shared/clientratelimitreachedwebhook.py @@ -0,0 +1,30 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from ..shared import clientratelimitreachedwebhookdata as shared_clientratelimitreachedwebhookdata +from codatplatform import utils +from dataclasses_json import Undefined, dataclass_json +from typing import Optional + + +@dataclass_json(undefined=Undefined.EXCLUDE) + +@dataclasses.dataclass +class ClientRateLimitReachedWebhook: + r"""Webhook request body for a client that has reached their rate limit.""" + alert_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('AlertId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier of the webhook event.""" + client_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ClientId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for your client in Codat.""" + client_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ClientName'), 'exclude': lambda f: f is None }}) + r"""Name of your client in Codat.""" + data: Optional[shared_clientratelimitreachedwebhookdata.ClientRateLimitReachedWebhookData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Data'), 'exclude': lambda f: f is None }}) + message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Message'), 'exclude': lambda f: f is None }}) + r"""A human readable message about the webhook.""" + rule_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('RuleId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for the rule.""" + rule_type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('RuleType'), 'exclude': lambda f: f is None }}) + r"""The type of rule.""" + + diff --git a/platform/src/codatplatform/models/shared/clientratelimitreachedwebhookdata.py b/platform/src/codatplatform/models/shared/clientratelimitreachedwebhookdata.py new file mode 100755 index 000000000..f80e474fa --- /dev/null +++ b/platform/src/codatplatform/models/shared/clientratelimitreachedwebhookdata.py @@ -0,0 +1,38 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from codatplatform import utils +from dataclasses_json import Undefined, dataclass_json +from typing import Optional + + +@dataclass_json(undefined=Undefined.EXCLUDE) + +@dataclasses.dataclass +class ClientRateLimitReachedWebhookData: + daily_quota: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('DailyQuota'), 'exclude': lambda f: f is None }}) + r"""The number of available requests per day.""" + expires_utc: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ExpiresUtc'), 'exclude': lambda f: f is None }}) + r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + + ``` + 2020-10-08T22:40:50Z + 2021-01-01T00:00:00 + ``` + + + + When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: + + - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` + - Unqualified local time: `2021-11-15T01:00:00` + - UTC time offsets: `2021-11-15T01:00:00-05:00` + + > Time zones + > + > Not all dates from Codat will contain information about time zones. + > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + """ + + diff --git a/platform/src/codatplatform/models/shared/clientratelimitresetwebhook.py b/platform/src/codatplatform/models/shared/clientratelimitresetwebhook.py new file mode 100755 index 000000000..b860c80aa --- /dev/null +++ b/platform/src/codatplatform/models/shared/clientratelimitresetwebhook.py @@ -0,0 +1,30 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from ..shared import clientratelimitresetwebhookdata as shared_clientratelimitresetwebhookdata +from codatplatform import utils +from dataclasses_json import Undefined, dataclass_json +from typing import Optional + + +@dataclass_json(undefined=Undefined.EXCLUDE) + +@dataclasses.dataclass +class ClientRateLimitResetWebhook: + r"""Webhook request body for a client that has had their rate limit reset.""" + alert_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('AlertId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier of the webhook event.""" + client_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ClientId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for your client in Codat.""" + client_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ClientName'), 'exclude': lambda f: f is None }}) + r"""Name of your client in Codat.""" + data: Optional[shared_clientratelimitresetwebhookdata.ClientRateLimitResetWebhookData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Data'), 'exclude': lambda f: f is None }}) + message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Message'), 'exclude': lambda f: f is None }}) + r"""A human readable message about the webhook.""" + rule_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('RuleId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for the rule.""" + rule_type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('RuleType'), 'exclude': lambda f: f is None }}) + r"""The type of rule.""" + + diff --git a/platform/src/codatplatform/models/shared/clientratelimitresetwebhookdata.py b/platform/src/codatplatform/models/shared/clientratelimitresetwebhookdata.py new file mode 100755 index 000000000..69fadbea2 --- /dev/null +++ b/platform/src/codatplatform/models/shared/clientratelimitresetwebhookdata.py @@ -0,0 +1,42 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from codatplatform import utils +from dataclasses_json import Undefined, dataclass_json +from typing import Optional + + +@dataclass_json(undefined=Undefined.EXCLUDE) + +@dataclasses.dataclass +class ClientRateLimitResetWebhookData: + daily_quota: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('DailyQuota'), 'exclude': lambda f: f is None }}) + r"""The number of available requests per day.""" + expires_utc: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ExpiresUtc'), 'exclude': lambda f: f is None }}) + r"""In Codat's data model, dates and times are represented using the ISO 8601 standard. Date and time fields are formatted as strings; for example: + + ``` + 2020-10-08T22:40:50Z + 2021-01-01T00:00:00 + ``` + + + + When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: + + - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` + - Unqualified local time: `2021-11-15T01:00:00` + - UTC time offsets: `2021-11-15T01:00:00-05:00` + + > Time zones + > + > Not all dates from Codat will contain information about time zones. + > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. + """ + quota_remaining: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('QuotaRemaining'), 'exclude': lambda f: f is None }}) + r"""Total number of request remaining for your client.""" + reset_reason: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ResetReason'), 'exclude': lambda f: f is None }}) + r"""The reason for your rate limit quota being reset.""" + + diff --git a/platform/src/codatplatform/models/shared/connectionstatuschangedwebhook.py b/platform/src/codatplatform/models/shared/connectionstatuschangedwebhook.py new file mode 100755 index 000000000..42d207ea5 --- /dev/null +++ b/platform/src/codatplatform/models/shared/connectionstatuschangedwebhook.py @@ -0,0 +1,34 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from ..shared import connectionstatuschangedwebhookdata as shared_connectionstatuschangedwebhookdata +from codatplatform import utils +from dataclasses_json import Undefined, dataclass_json +from typing import Optional + + +@dataclass_json(undefined=Undefined.EXCLUDE) + +@dataclasses.dataclass +class ConnectionStatusChangedWebhook: + r"""Webhook request body for a company's data connection status changed.""" + alert_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('AlertId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier of the webhook event.""" + client_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ClientId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for your client in Codat.""" + client_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ClientName'), 'exclude': lambda f: f is None }}) + r"""Name of your client in Codat.""" + company_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('CompanyId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for your SMB in Codat.""" + data: Optional[shared_connectionstatuschangedwebhookdata.ConnectionStatusChangedWebhookData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Data'), 'exclude': lambda f: f is None }}) + data_connection_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('DataConnectionId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for a company's data connection.""" + message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Message'), 'exclude': lambda f: f is None }}) + r"""A human readable message about the webhook.""" + rule_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('RuleId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for the rule.""" + rule_type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('RuleType'), 'exclude': lambda f: f is None }}) + r"""The type of rule.""" + + diff --git a/platform/src/codatplatform/models/shared/companydataconnectionstatuschangedwebhook.py b/platform/src/codatplatform/models/shared/connectionstatuschangedwebhookdata.py similarity index 52% rename from platform/src/codatplatform/models/shared/companydataconnectionstatuschangedwebhook.py rename to platform/src/codatplatform/models/shared/connectionstatuschangedwebhookdata.py index aa79d1ceb..013c24fe7 100755 --- a/platform/src/codatplatform/models/shared/companydataconnectionstatuschangedwebhook.py +++ b/platform/src/codatplatform/models/shared/connectionstatuschangedwebhookdata.py @@ -11,7 +11,7 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass -class CompanyDataConnectionStatusChangedWebhookData: +class ConnectionStatusChangedWebhookData: data_connection_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataConnectionId'), 'exclude': lambda f: f is None }}) r"""Unique identifier for a company's data connection.""" new_status: Optional[shared_dataconnectionstatus.DataConnectionStatus] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('newStatus'), 'exclude': lambda f: f is None }}) @@ -22,23 +22,3 @@ class CompanyDataConnectionStatusChangedWebhookData: r"""A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/accounting-platform-keys), [banking](https://docs.codat.io/integrations/banking/banking-platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/commerce-platform-keys) platform keys.""" - - -@dataclass_json(undefined=Undefined.EXCLUDE) - -@dataclasses.dataclass -class CompanyDataConnectionStatusChangedWebhook: - r"""Webhook request body for a company's data connection status changed.""" - alert_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('AlertId'), 'exclude': lambda f: f is None }}) - r"""Unique identifier of the webhook event.""" - company_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('CompanyId'), 'exclude': lambda f: f is None }}) - r"""Unique identifier for your SMB in Codat.""" - data: Optional[CompanyDataConnectionStatusChangedWebhookData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Data'), 'exclude': lambda f: f is None }}) - message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Message'), 'exclude': lambda f: f is None }}) - r"""A human readable message about the webhook.""" - rule_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('RuleId'), 'exclude': lambda f: f is None }}) - r"""Unique identifier for the rule.""" - type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Type'), 'exclude': lambda f: f is None }}) - r"""The type of rule.""" - - diff --git a/platform/src/codatplatform/models/shared/datasetdatachangedwebhook.py b/platform/src/codatplatform/models/shared/datasetdatachangedwebhook.py index eece6c958..26210828c 100755 --- a/platform/src/codatplatform/models/shared/datasetdatachangedwebhook.py +++ b/platform/src/codatplatform/models/shared/datasetdatachangedwebhook.py @@ -2,6 +2,7 @@ from __future__ import annotations import dataclasses +from ..shared import datatype as shared_datatype from codatplatform import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -10,11 +11,11 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass -class DatasetDataChangedWebhookData: +class DatasetDataChangedWebhookDatasetDataChangedWebhookData: dataset_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('datasetId'), 'exclude': lambda f: f is None }}) r"""Unique identifier for the dataset that completed its sync.""" - data_type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) - r"""Data type the sync completed for.""" + data_type: Optional[shared_datatype.DataType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) + r"""Available Data types""" @@ -26,14 +27,20 @@ class DatasetDataChangedWebhook: r"""Webhook request body to notify that a data synchronization has completed.""" alert_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('AlertId'), 'exclude': lambda f: f is None }}) r"""Unique identifier of the webhook event.""" + client_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ClientId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for your client in Codat.""" + client_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ClientName'), 'exclude': lambda f: f is None }}) + r"""Name of your client in Codat.""" company_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('CompanyId'), 'exclude': lambda f: f is None }}) r"""Unique identifier for your SMB in Codat.""" - data: Optional[DatasetDataChangedWebhookData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Data'), 'exclude': lambda f: f is None }}) + data: Optional[DatasetDataChangedWebhookDatasetDataChangedWebhookData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Data'), 'exclude': lambda f: f is None }}) + data_connection_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('DataConnectionId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for a company's data connection.""" message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Message'), 'exclude': lambda f: f is None }}) r"""A human readable message about the webhook.""" rule_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('RuleId'), 'exclude': lambda f: f is None }}) r"""Unique identifier for the rule.""" - type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Type'), 'exclude': lambda f: f is None }}) + rule_type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('RuleType'), 'exclude': lambda f: f is None }}) r"""The type of rule.""" diff --git a/platform/src/codatplatform/models/shared/datasetstatuschangederrorwebhook.py b/platform/src/codatplatform/models/shared/datasetstatuschangederrorwebhook.py index b122eb97e..bc21fa05f 100755 --- a/platform/src/codatplatform/models/shared/datasetstatuschangederrorwebhook.py +++ b/platform/src/codatplatform/models/shared/datasetstatuschangederrorwebhook.py @@ -2,25 +2,12 @@ from __future__ import annotations import dataclasses +from ..shared import datasetstatuschangederrorwebhookdata as shared_datasetstatuschangederrorwebhookdata from codatplatform import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional -@dataclass_json(undefined=Undefined.EXCLUDE) - -@dataclasses.dataclass -class DatasetStatusChangedErrorWebhookData: - dataset_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('datasetId'), 'exclude': lambda f: f is None }}) - r"""Unique identifier for the dataset that completed its sync.""" - dataset_status: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('datasetStatus'), 'exclude': lambda f: f is None }}) - r"""The current status of the dataset's sync.""" - data_type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) - r"""Data type the sync completed for.""" - - - - @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass @@ -28,14 +15,20 @@ class DatasetStatusChangedErrorWebhook: r"""Webhook request body to notify that a data synchronization has completed.""" alert_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('AlertId'), 'exclude': lambda f: f is None }}) r"""Unique identifier of the webhook event.""" + client_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ClientId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for your client in Codat.""" + client_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ClientName'), 'exclude': lambda f: f is None }}) + r"""Name of your client in Codat.""" company_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('CompanyId'), 'exclude': lambda f: f is None }}) r"""Unique identifier for your SMB in Codat.""" - data: Optional[DatasetStatusChangedErrorWebhookData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Data'), 'exclude': lambda f: f is None }}) + data: Optional[shared_datasetstatuschangederrorwebhookdata.DatasetStatusChangedErrorWebhookData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Data'), 'exclude': lambda f: f is None }}) + data_connection_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('DataConnectionId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for a company's data connection.""" message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Message'), 'exclude': lambda f: f is None }}) r"""A human readable message about the webhook.""" rule_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('RuleId'), 'exclude': lambda f: f is None }}) r"""Unique identifier for the rule.""" - type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Type'), 'exclude': lambda f: f is None }}) + rule_type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('RuleType'), 'exclude': lambda f: f is None }}) r"""The type of rule.""" diff --git a/platform/src/codatplatform/models/shared/datasetstatuschangederrorwebhookdata.py b/platform/src/codatplatform/models/shared/datasetstatuschangederrorwebhookdata.py new file mode 100755 index 000000000..08ab1b430 --- /dev/null +++ b/platform/src/codatplatform/models/shared/datasetstatuschangederrorwebhookdata.py @@ -0,0 +1,22 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from ..shared import datatype as shared_datatype +from codatplatform import utils +from dataclasses_json import Undefined, dataclass_json +from typing import Optional + + +@dataclass_json(undefined=Undefined.EXCLUDE) + +@dataclasses.dataclass +class DatasetStatusChangedErrorWebhookData: + dataset_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('datasetId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for the dataset that completed its sync.""" + dataset_status: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('datasetStatus'), 'exclude': lambda f: f is None }}) + r"""The current status of the dataset's sync.""" + data_type: Optional[shared_datatype.DataType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) + r"""Available Data types""" + + diff --git a/platform/src/codatplatform/models/shared/datasynccompletedwebhook.py b/platform/src/codatplatform/models/shared/datasynccompletedwebhook.py index 4f5a3d61a..1fe594f16 100755 --- a/platform/src/codatplatform/models/shared/datasynccompletedwebhook.py +++ b/platform/src/codatplatform/models/shared/datasynccompletedwebhook.py @@ -2,23 +2,12 @@ from __future__ import annotations import dataclasses +from ..shared import datasynccompletedwebhookdata as shared_datasynccompletedwebhookdata from codatplatform import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional -@dataclass_json(undefined=Undefined.EXCLUDE) - -@dataclasses.dataclass -class DataSyncCompletedWebhookData: - dataset_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('datasetId'), 'exclude': lambda f: f is None }}) - r"""Unique identifier for the dataset that completed its sync.""" - data_type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) - r"""Data type the sync completed for.""" - - - - @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass @@ -32,14 +21,14 @@ class DataSyncCompletedWebhook: r"""Name of your client in Codat.""" company_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('CompanyId'), 'exclude': lambda f: f is None }}) r"""Unique identifier for your SMB in Codat.""" - data: Optional[DataSyncCompletedWebhookData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Data'), 'exclude': lambda f: f is None }}) + data: Optional[shared_datasynccompletedwebhookdata.DataSyncCompletedWebhookData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Data'), 'exclude': lambda f: f is None }}) data_connection_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('DataConnectionId'), 'exclude': lambda f: f is None }}) r"""Unique identifier for a company's data connection.""" message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Message'), 'exclude': lambda f: f is None }}) r"""A human readable message about the webhook.""" rule_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('RuleId'), 'exclude': lambda f: f is None }}) r"""Unique identifier for the rule.""" - type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Type'), 'exclude': lambda f: f is None }}) + rule_type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('RuleType'), 'exclude': lambda f: f is None }}) r"""The type of rule.""" diff --git a/platform/src/codatplatform/models/shared/datasynccompletedwebhookdata.py b/platform/src/codatplatform/models/shared/datasynccompletedwebhookdata.py new file mode 100755 index 000000000..ebbb13d4c --- /dev/null +++ b/platform/src/codatplatform/models/shared/datasynccompletedwebhookdata.py @@ -0,0 +1,20 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from ..shared import datatype as shared_datatype +from codatplatform import utils +from dataclasses_json import Undefined, dataclass_json +from typing import Optional + + +@dataclass_json(undefined=Undefined.EXCLUDE) + +@dataclasses.dataclass +class DataSyncCompletedWebhookData: + dataset_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('datasetId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for the dataset that completed its sync.""" + data_type: Optional[shared_datatype.DataType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) + r"""Available Data types""" + + diff --git a/platform/src/codatplatform/models/shared/newcompanysynchronizedwebhook.py b/platform/src/codatplatform/models/shared/newcompanysynchronizedwebhook.py index 0a85ec1dd..c63144071 100755 --- a/platform/src/codatplatform/models/shared/newcompanysynchronizedwebhook.py +++ b/platform/src/codatplatform/models/shared/newcompanysynchronizedwebhook.py @@ -2,6 +2,7 @@ from __future__ import annotations import dataclasses +from ..shared import newcompanysynchronizedwebhookdata as shared_newcompanysynchronizedwebhookdata from codatplatform import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -14,13 +15,20 @@ class NewCompanySynchronizedWebhook: r"""Webhook request body to notify that a new company has successfully synchronized at least one dataType for the first time.""" alert_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('AlertId'), 'exclude': lambda f: f is None }}) r"""Unique identifier of the webhook event.""" + client_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ClientId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for your client in Codat.""" + client_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ClientName'), 'exclude': lambda f: f is None }}) + r"""Name of your client in Codat.""" company_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('CompanyId'), 'exclude': lambda f: f is None }}) r"""Unique identifier for your SMB in Codat.""" + data: Optional[shared_newcompanysynchronizedwebhookdata.NewCompanySynchronizedWebhookData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Data'), 'exclude': lambda f: f is None }}) + data_connection_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('DataConnectionId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for a company's data connection.""" message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Message'), 'exclude': lambda f: f is None }}) r"""A human readable message about the webhook.""" rule_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('RuleId'), 'exclude': lambda f: f is None }}) r"""Unique identifier for the rule.""" - type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Type'), 'exclude': lambda f: f is None }}) + rule_type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('RuleType'), 'exclude': lambda f: f is None }}) r"""The type of rule.""" diff --git a/platform/src/codatplatform/models/shared/newcompanysynchronizedwebhookdata.py b/platform/src/codatplatform/models/shared/newcompanysynchronizedwebhookdata.py new file mode 100755 index 000000000..2dcb37f94 --- /dev/null +++ b/platform/src/codatplatform/models/shared/newcompanysynchronizedwebhookdata.py @@ -0,0 +1,10 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses + + + +@dataclasses.dataclass +class NewCompanySynchronizedWebhookData: + pass diff --git a/platform/src/codatplatform/models/shared/pushoperation.py b/platform/src/codatplatform/models/shared/pushoperation.py index 67a2bb9b4..4199473c8 100755 --- a/platform/src/codatplatform/models/shared/pushoperation.py +++ b/platform/src/codatplatform/models/shared/pushoperation.py @@ -43,7 +43,7 @@ class PushOperation: > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. """ status: shared_pushoperationstatus.PushOperationStatus = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) - r"""The status of the push operation.""" + r"""The current status of the push operation.""" status_code: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusCode') }}) changes: Optional[list[shared_pushoperationchange.PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes'), 'exclude': lambda f: f is None }}) r"""Contains a single entry that communicates which record has changed and the manner in which it changed.""" diff --git a/platform/src/codatplatform/models/shared/pushoperationstatus.py b/platform/src/codatplatform/models/shared/pushoperationstatus.py index fc391b0a2..5b3fabf24 100755 --- a/platform/src/codatplatform/models/shared/pushoperationstatus.py +++ b/platform/src/codatplatform/models/shared/pushoperationstatus.py @@ -4,7 +4,7 @@ from enum import Enum class PushOperationStatus(str, Enum): - r"""The status of the push operation.""" + r"""The current status of the push operation.""" PENDING = 'Pending' FAILED = 'Failed' SUCCESS = 'Success' diff --git a/platform/src/codatplatform/models/shared/pushoperationstatuschangedwebhook.py b/platform/src/codatplatform/models/shared/pushoperationstatuschangedwebhook.py index 2a5a4740e..fb9d52010 100755 --- a/platform/src/codatplatform/models/shared/pushoperationstatuschangedwebhook.py +++ b/platform/src/codatplatform/models/shared/pushoperationstatuschangedwebhook.py @@ -2,25 +2,12 @@ from __future__ import annotations import dataclasses +from ..shared import pushoperationstatuschangedwebhookdata as shared_pushoperationstatuschangedwebhookdata from codatplatform import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional -@dataclass_json(undefined=Undefined.EXCLUDE) - -@dataclasses.dataclass -class PushOperationStatusChangedWebhookData: - data_type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) - r"""Data type used in the push operation.""" - push_operation_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pushOperationKey'), 'exclude': lambda f: f is None }}) - r"""Unique identifier for the push operation.""" - status: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status'), 'exclude': lambda f: f is None }}) - r"""The current status of the push operation.""" - - - - @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass @@ -28,14 +15,20 @@ class PushOperationStatusChangedWebhook: r"""Webhook request body for a push operation status change.""" alert_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('AlertId'), 'exclude': lambda f: f is None }}) r"""Unique identifier of the webhook event.""" + client_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ClientId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for your client in Codat.""" + client_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ClientName'), 'exclude': lambda f: f is None }}) + r"""Name of your client in Codat.""" company_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('CompanyId'), 'exclude': lambda f: f is None }}) r"""Unique identifier for your SMB in Codat.""" - data: Optional[PushOperationStatusChangedWebhookData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Data'), 'exclude': lambda f: f is None }}) + data: Optional[shared_pushoperationstatuschangedwebhookdata.PushOperationStatusChangedWebhookData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Data'), 'exclude': lambda f: f is None }}) + data_connection_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('DataConnectionId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for a company's data connection.""" message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Message'), 'exclude': lambda f: f is None }}) r"""A human readable message about the webhook.""" rule_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('RuleId'), 'exclude': lambda f: f is None }}) r"""Unique identifier for the rule.""" - type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Type'), 'exclude': lambda f: f is None }}) + rule_type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('RuleType'), 'exclude': lambda f: f is None }}) r"""The type of rule.""" diff --git a/platform/src/codatplatform/models/shared/pushoperationstatuschangedwebhookdata.py b/platform/src/codatplatform/models/shared/pushoperationstatuschangedwebhookdata.py new file mode 100755 index 000000000..f23b6d16b --- /dev/null +++ b/platform/src/codatplatform/models/shared/pushoperationstatuschangedwebhookdata.py @@ -0,0 +1,23 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from ..shared import datatype as shared_datatype +from ..shared import pushoperationstatus as shared_pushoperationstatus +from codatplatform import utils +from dataclasses_json import Undefined, dataclass_json +from typing import Optional + + +@dataclass_json(undefined=Undefined.EXCLUDE) + +@dataclasses.dataclass +class PushOperationStatusChangedWebhookData: + data_type: Optional[shared_datatype.DataType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) + r"""Available Data types""" + push_operation_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pushOperationKey'), 'exclude': lambda f: f is None }}) + r"""A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted.""" + status: Optional[shared_pushoperationstatus.PushOperationStatus] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status'), 'exclude': lambda f: f is None }}) + r"""The current status of the push operation.""" + + diff --git a/platform/src/codatplatform/models/shared/pushoperationtimedoutwebhook.py b/platform/src/codatplatform/models/shared/pushoperationtimedoutwebhook.py index f4a3f3ed0..46cb6297e 100755 --- a/platform/src/codatplatform/models/shared/pushoperationtimedoutwebhook.py +++ b/platform/src/codatplatform/models/shared/pushoperationtimedoutwebhook.py @@ -2,23 +2,12 @@ from __future__ import annotations import dataclasses +from ..shared import pushoperationtimedoutwebhookdata as shared_pushoperationtimedoutwebhookdata from codatplatform import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional -@dataclass_json(undefined=Undefined.EXCLUDE) - -@dataclasses.dataclass -class PushOperationTimedOutWebhookData: - data_type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) - r"""Data type used in the push operation.""" - push_operation_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pushOperationKey'), 'exclude': lambda f: f is None }}) - r"""Unique identifier for the push operation.""" - - - - @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass @@ -26,14 +15,20 @@ class PushOperationTimedOutWebhook: r"""Webhook request body notifying that a push push operation has timed out.""" alert_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('AlertId'), 'exclude': lambda f: f is None }}) r"""Unique identifier of the webhook event.""" + client_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ClientId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for your client in Codat.""" + client_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ClientName'), 'exclude': lambda f: f is None }}) + r"""Name of your client in Codat.""" company_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('CompanyId'), 'exclude': lambda f: f is None }}) r"""Unique identifier for your SMB in Codat.""" - data: Optional[PushOperationTimedOutWebhookData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Data'), 'exclude': lambda f: f is None }}) + data: Optional[shared_pushoperationtimedoutwebhookdata.PushOperationTimedOutWebhookData] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Data'), 'exclude': lambda f: f is None }}) + data_connection_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('DataConnectionId'), 'exclude': lambda f: f is None }}) + r"""Unique identifier for a company's data connection.""" message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Message'), 'exclude': lambda f: f is None }}) r"""A human readable message about the webhook.""" rule_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('RuleId'), 'exclude': lambda f: f is None }}) r"""Unique identifier for the rule.""" - type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('Type'), 'exclude': lambda f: f is None }}) + rule_type: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('RuleType'), 'exclude': lambda f: f is None }}) r"""The type of rule.""" diff --git a/platform/src/codatplatform/models/shared/pushoperationtimedoutwebhookdata.py b/platform/src/codatplatform/models/shared/pushoperationtimedoutwebhookdata.py new file mode 100755 index 000000000..089f3d7e3 --- /dev/null +++ b/platform/src/codatplatform/models/shared/pushoperationtimedoutwebhookdata.py @@ -0,0 +1,22 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from ..shared import datatype as shared_datatype +from codatplatform import utils +from dataclasses_json import Undefined, dataclass_json +from typing import Optional + + +@dataclass_json(undefined=Undefined.EXCLUDE) + +@dataclasses.dataclass +class PushOperationTimedOutWebhookData: + data_type: Optional[shared_datatype.DataType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataType'), 'exclude': lambda f: f is None }}) + r"""Available Data types""" + push_operation_guid: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pushOperationGuid'), 'exclude': lambda f: f is None }}) + r"""A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted.""" + push_operation_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('pushOperationKey'), 'exclude': lambda f: f is None }}) + r"""A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted.""" + + diff --git a/platform/src/codatplatform/models/webhooks/__init__.py b/platform/src/codatplatform/models/webhooks/__init__.py index eb005e724..b0b49fa3a 100755 --- a/platform/src/codatplatform/models/webhooks/__init__.py +++ b/platform/src/codatplatform/models/webhooks/__init__.py @@ -1,5 +1,7 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" +from .client_rate_limit_reached import * +from .client_rate_limit_reset import * from .company_data_connection_status_changed import * from .data_sync_completed import * from .dataset_data_changed import * @@ -8,4 +10,4 @@ from .push_operation_has_timed_out import * from .push_operation_status_has_changed import * -__all__ = ["CompanyDataConnectionStatusChangedResponse","DataSyncCompletedResponse","DatasetDataChangedResponse","DatasetStatusHasChangedToAnErrorStateResponse","NewCompanySynchronizedResponse","PushOperationHasTimedOutResponse","PushOperationStatusHasChangedResponse"] +__all__ = ["ClientRateLimitReachedResponse","ClientRateLimitResetResponse","CompanyDataConnectionStatusChangedResponse","DataSyncCompletedResponse","DatasetDataChangedResponse","DatasetStatusHasChangedToAnErrorStateResponse","NewCompanySynchronizedResponse","PushOperationHasTimedOutResponse","PushOperationStatusHasChangedResponse"] diff --git a/platform/src/codatplatform/models/webhooks/client_rate_limit_reached.py b/platform/src/codatplatform/models/webhooks/client_rate_limit_reached.py new file mode 100755 index 000000000..8ce5abf44 --- /dev/null +++ b/platform/src/codatplatform/models/webhooks/client_rate_limit_reached.py @@ -0,0 +1,16 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +import requests as requests_http +from typing import Optional + + + +@dataclasses.dataclass +class ClientRateLimitReachedResponse: + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + + diff --git a/platform/src/codatplatform/models/webhooks/client_rate_limit_reset.py b/platform/src/codatplatform/models/webhooks/client_rate_limit_reset.py new file mode 100755 index 000000000..df91ac429 --- /dev/null +++ b/platform/src/codatplatform/models/webhooks/client_rate_limit_reset.py @@ -0,0 +1,16 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +import requests as requests_http +from typing import Optional + + + +@dataclasses.dataclass +class ClientRateLimitResetResponse: + content_type: str = dataclasses.field() + status_code: int = dataclasses.field() + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + + diff --git a/platform/src/codatplatform/sdkconfiguration.py b/platform/src/codatplatform/sdkconfiguration.py index 270f22517..74efdb5f6 100755 --- a/platform/src/codatplatform/sdkconfiguration.py +++ b/platform/src/codatplatform/sdkconfiguration.py @@ -20,8 +20,8 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '3.0.0' - sdk_version: str = '0.2.0' - gen_version: str = '2.108.3' + sdk_version: str = '1.1.0' + gen_version: str = '2.116.0' retry_config: RetryConfig = None def get_server_details(self) -> tuple[str, dict[str, str]]: