diff --git a/platform/.speakeasy/gen.lock b/platform/.speakeasy/gen.lock new file mode 100755 index 000000000..a7c532397 --- /dev/null +++ b/platform/.speakeasy/gen.lock @@ -0,0 +1,370 @@ +lockVersion: 2.0.0 +id: ede4f28e-23c0-442d-89ba-baa76ae2da6e +management: + docChecksum: 1c413a5d3d57588774d54236c89a147e + docVersion: 3.0.0 + speakeasyVersion: internal + generationVersion: 2.257.2 + releaseVersion: 3.3.0 + configChecksum: 784efc81af1d53ff20fe66e5949e3428 + repoURL: https://github.com/codatio/client-sdk-python.git + repoSubDirectory: platform + installationURL: https://github.com/codatio/client-sdk-python.git#subdirectory=platform + published: true +features: + python: + constsAndDefaults: 0.1.2 + core: 4.4.6 + deprecations: 2.81.1 + examples: 2.81.3 + globalSecurity: 2.83.2 + globalServerURLs: 2.82.1 + inputOutputModels: 2.83.1 + nameOverrides: 2.81.1 + retries: 2.82.1 +generatedFiles: + - src/codatplatform/sdkconfiguration.py + - src/codatplatform/settings.py + - src/codatplatform/companies.py + - src/codatplatform/connections.py + - src/codatplatform/custom_data_type.py + - src/codatplatform/push_data.py + - src/codatplatform/refresh_data.py + - src/codatplatform/groups.py + - src/codatplatform/integrations.py + - src/codatplatform/supplemental_data.py + - src/codatplatform/webhooks.py + - src/codatplatform/sdk.py + - pylintrc + - setup.py + - src/codatplatform/__init__.py + - src/codatplatform/utils/__init__.py + - src/codatplatform/utils/retries.py + - src/codatplatform/utils/utils.py + - src/codatplatform/models/errors/sdkerror.py + - tests/helpers.py + - src/codatplatform/models/operations/create_api_key.py + - src/codatplatform/models/operations/delete_api_key.py + - src/codatplatform/models/operations/get_profile.py + - src/codatplatform/models/operations/get_profile_syncsettings.py + - src/codatplatform/models/operations/list_api_keys.py + - src/codatplatform/models/operations/update_profile.py + - src/codatplatform/models/operations/update_profile_syncsettings.py + - src/codatplatform/models/operations/create_company.py + - src/codatplatform/models/operations/delete_company.py + - src/codatplatform/models/operations/get_company.py + - src/codatplatform/models/operations/list_companies.py + - src/codatplatform/models/operations/update_company.py + - src/codatplatform/models/operations/create_connection.py + - src/codatplatform/models/operations/delete_connection.py + - src/codatplatform/models/operations/get_connection.py + - src/codatplatform/models/operations/list_connections.py + - src/codatplatform/models/operations/unlink_connection.py + - src/codatplatform/models/operations/update_connection_authorization.py + - src/codatplatform/models/operations/configure_custom_data_type.py + - src/codatplatform/models/operations/get_custom_data_type_configuration.py + - src/codatplatform/models/operations/list_custom_data_type_records.py + - src/codatplatform/models/operations/refresh_custom_data_type.py + - src/codatplatform/models/operations/get_create_update_model_options_by_data_type.py + - src/codatplatform/models/operations/get_push_operation.py + - src/codatplatform/models/operations/get_company_push_history.py + - src/codatplatform/models/operations/refresh_company_data.py + - src/codatplatform/models/operations/refresh_data_type.py + - src/codatplatform/models/operations/get_company_data_status.py + - src/codatplatform/models/operations/get_pull_operation.py + - src/codatplatform/models/operations/list_pull_operations.py + - src/codatplatform/models/operations/add_company_to_group.py + - src/codatplatform/models/operations/create_group.py + - src/codatplatform/models/operations/list_groups.py + - src/codatplatform/models/operations/remove_company_from_group.py + - src/codatplatform/models/operations/get_integration.py + - src/codatplatform/models/operations/get_integrations_branding.py + - src/codatplatform/models/operations/list_integrations.py + - src/codatplatform/models/operations/configure_supplemental_data.py + - src/codatplatform/models/operations/get_supplemental_data_configuration.py + - src/codatplatform/models/operations/create_rule.py + - src/codatplatform/models/operations/get_webhook.py + - src/codatplatform/models/operations/list_rules.py + - src/codatplatform/models/shared/apikeydetails.py + - src/codatplatform/models/shared/errorvalidation.py + - src/codatplatform/models/shared/errorvalidationitem.py + - src/codatplatform/models/shared/createapikey.py + - src/codatplatform/models/shared/profile.py + - src/codatplatform/models/shared/syncsettings.py + - src/codatplatform/models/shared/syncsetting.py + - src/codatplatform/models/shared/datatype.py + - src/codatplatform/models/shared/apikeys.py + - src/codatplatform/models/shared/company.py + - src/codatplatform/models/shared/groupref.py + - src/codatplatform/models/shared/connection.py + - src/codatplatform/models/shared/dataconnectionstatus.py + - src/codatplatform/models/shared/sourcetype.py + - src/codatplatform/models/shared/dataconnectionerror.py + - src/codatplatform/models/shared/companyrequestbody.py + - src/codatplatform/models/shared/companies.py + - src/codatplatform/models/shared/links.py + - src/codatplatform/models/shared/halref.py + - src/codatplatform/models/shared/connections.py + - src/codatplatform/models/shared/updateconnectionstatus.py + - src/codatplatform/models/shared/customdatatypeconfiguration.py + - src/codatplatform/models/shared/customdatatyperecords.py + - src/codatplatform/models/shared/customdatatyperecord.py + - src/codatplatform/models/shared/pulloperation.py + - src/codatplatform/models/shared/pushoption.py + - src/codatplatform/models/shared/pushvalidationinfo.py + - src/codatplatform/models/shared/pushfieldvalidation.py + - src/codatplatform/models/shared/pushoptiontype.py + - src/codatplatform/models/shared/pushoptionproperty.py + - src/codatplatform/models/shared/pushoptionchoice.py + - src/codatplatform/models/shared/schema_datatype.py + - src/codatplatform/models/shared/pushoperation.py + - src/codatplatform/models/shared/validation.py + - src/codatplatform/models/shared/validationitem.py + - src/codatplatform/models/shared/pushoperationstatus.py + - src/codatplatform/models/shared/pushoperationchange.py + - src/codatplatform/models/shared/pushchangetype.py + - src/codatplatform/models/shared/pushoperationref.py + - src/codatplatform/models/shared/pushoperations.py + - src/codatplatform/models/shared/datastatus.py + - src/codatplatform/models/shared/pulloperations.py + - src/codatplatform/models/shared/companygroupassignment.py + - src/codatplatform/models/shared/group.py + - src/codatplatform/models/shared/groupprototype.py + - src/codatplatform/models/shared/groups.py + - src/codatplatform/models/shared/integration.py + - src/codatplatform/models/shared/datatypefeature.py + - src/codatplatform/models/shared/supportedfeature.py + - src/codatplatform/models/shared/featuretype.py + - src/codatplatform/models/shared/featurestate.py + - src/codatplatform/models/shared/branding.py + - src/codatplatform/models/shared/brandinglogo.py + - src/codatplatform/models/shared/brandingimage.py + - src/codatplatform/models/shared/imagereference.py + - src/codatplatform/models/shared/brandingbutton.py + - src/codatplatform/models/shared/integrations.py + - src/codatplatform/models/shared/supplementaldataconfiguration.py + - src/codatplatform/models/shared/webhook.py + - src/codatplatform/models/shared/webhooknotifier.py + - src/codatplatform/models/shared/createrule.py + - src/codatplatform/models/shared/webhooks.py + - src/codatplatform/models/shared/security.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/errors/errormessage.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 + - src/codatplatform/models/webhooks/dataset_status_has_changed_to_an_error_state.py + - src/codatplatform/models/webhooks/new_company_synchronized.py + - src/codatplatform/models/webhooks/push_operation_has_timed_out.py + - src/codatplatform/models/webhooks/push_operation_status_has_changed.py + - src/codatplatform/models/__init__.py + - src/codatplatform/models/errors/__init__.py + - src/codatplatform/models/operations/__init__.py + - src/codatplatform/models/shared/__init__.py + - src/codatplatform/models/webhooks/__init__.py + - docs/models/operations/createapikeyresponse.md + - docs/models/operations/deleteapikeyrequest.md + - docs/models/operations/deleteapikeyresponse.md + - docs/models/operations/getprofileresponse.md + - docs/models/operations/getprofilesyncsettingsresponse.md + - docs/models/operations/listapikeysresponse.md + - docs/models/operations/updateprofileresponse.md + - docs/models/operations/updateprofilesyncsettingsrequestbody.md + - docs/models/operations/updateprofilesyncsettingsresponse.md + - docs/models/operations/createcompanyresponse.md + - docs/models/operations/deletecompanyrequest.md + - docs/models/operations/deletecompanyresponse.md + - docs/models/operations/getcompanyrequest.md + - docs/models/operations/getcompanyresponse.md + - docs/models/operations/listcompaniesrequest.md + - docs/models/operations/listcompaniesresponse.md + - docs/models/operations/updatecompanyrequest.md + - docs/models/operations/updatecompanyresponse.md + - docs/models/operations/createconnectionrequestbody.md + - docs/models/operations/createconnectionrequest.md + - docs/models/operations/createconnectionresponse.md + - docs/models/operations/deleteconnectionrequest.md + - docs/models/operations/deleteconnectionresponse.md + - docs/models/operations/getconnectionrequest.md + - docs/models/operations/getconnectionresponse.md + - docs/models/operations/listconnectionsrequest.md + - docs/models/operations/listconnectionsresponse.md + - docs/models/operations/unlinkconnectionrequest.md + - docs/models/operations/unlinkconnectionresponse.md + - docs/models/operations/updateconnectionauthorizationrequest.md + - docs/models/operations/updateconnectionauthorizationresponse.md + - docs/models/operations/configurecustomdatatyperequest.md + - docs/models/operations/configurecustomdatatyperesponse.md + - docs/models/operations/getcustomdatatypeconfigurationrequest.md + - docs/models/operations/getcustomdatatypeconfigurationresponse.md + - docs/models/operations/listcustomdatatyperecordsrequest.md + - docs/models/operations/listcustomdatatyperecordsresponse.md + - docs/models/operations/refreshcustomdatatyperequest.md + - docs/models/operations/refreshcustomdatatyperesponse.md + - docs/models/operations/getcreateupdatemodeloptionsbydatatyperequest.md + - docs/models/operations/getcreateupdatemodeloptionsbydatatyperesponse.md + - docs/models/operations/getpushoperationrequest.md + - docs/models/operations/getpushoperationresponse.md + - docs/models/operations/getcompanypushhistoryrequest.md + - docs/models/operations/getcompanypushhistoryresponse.md + - docs/models/operations/refreshcompanydatarequest.md + - docs/models/operations/refreshcompanydataresponse.md + - docs/models/operations/refreshdatatyperequest.md + - docs/models/operations/refreshdatatyperesponse.md + - docs/models/operations/getcompanydatastatusrequest.md + - docs/models/operations/getcompanydatastatusresponse.md + - docs/models/operations/getpulloperationrequest.md + - docs/models/operations/getpulloperationresponse.md + - docs/models/operations/listpulloperationsrequest.md + - docs/models/operations/listpulloperationsresponse.md + - docs/models/operations/addcompanytogrouprequest.md + - docs/models/operations/addcompanytogroupresponse.md + - docs/models/operations/creategroupresponse.md + - docs/models/operations/listgroupsresponse.md + - docs/models/operations/removecompanyfromgrouprequest.md + - docs/models/operations/removecompanyfromgroupresponse.md + - docs/models/operations/getintegrationrequest.md + - docs/models/operations/getintegrationresponse.md + - docs/models/operations/getintegrationsbrandingrequest.md + - docs/models/operations/getintegrationsbrandingresponse.md + - docs/models/operations/listintegrationsrequest.md + - docs/models/operations/listintegrationsresponse.md + - docs/models/operations/datatype.md + - docs/models/operations/configuresupplementaldatarequest.md + - docs/models/operations/configuresupplementaldataresponse.md + - docs/models/operations/pathparamdatatype.md + - docs/models/operations/getsupplementaldataconfigurationrequest.md + - docs/models/operations/getsupplementaldataconfigurationresponse.md + - docs/models/operations/createruleresponse.md + - docs/models/operations/getwebhookrequest.md + - docs/models/operations/getwebhookresponse.md + - docs/models/operations/listrulesrequest.md + - docs/models/operations/listrulesresponse.md + - docs/models/shared/apikeydetails.md + - docs/models/shared/errorvalidation.md + - docs/models/shared/errorvalidationitem.md + - docs/models/shared/createapikey.md + - docs/models/shared/profile.md + - docs/models/shared/syncsettings.md + - docs/models/shared/syncsetting.md + - docs/models/shared/datatype.md + - docs/models/shared/apikeys.md + - docs/models/shared/company.md + - docs/models/shared/groupref.md + - docs/models/shared/connection.md + - docs/models/shared/dataconnectionstatus.md + - docs/models/shared/sourcetype.md + - docs/models/shared/dataconnectionerror.md + - docs/models/shared/companyrequestbody.md + - docs/models/shared/companies.md + - docs/models/shared/links.md + - docs/models/shared/halref.md + - docs/models/shared/connections.md + - docs/models/shared/updateconnectionstatus.md + - docs/models/shared/customdatatypeconfiguration.md + - docs/models/shared/customdatatyperecords.md + - docs/models/shared/content.md + - docs/models/shared/modifieddate.md + - docs/models/shared/customdatatyperecord.md + - docs/models/shared/status.md + - docs/models/shared/pulloperation.md + - docs/models/shared/pushoption.md + - docs/models/shared/pushvalidationinfo.md + - docs/models/shared/pushfieldvalidation.md + - docs/models/shared/pushoptiontype.md + - docs/models/shared/pushoptionproperty.md + - docs/models/shared/pushoptionchoice.md + - docs/models/shared/schemadatatype.md + - docs/models/shared/pushoperation.md + - docs/models/shared/validation.md + - docs/models/shared/validationitem.md + - docs/models/shared/pushoperationstatus.md + - docs/models/shared/pushoperationchange.md + - docs/models/shared/pushchangetype.md + - docs/models/shared/pushoperationref.md + - docs/models/shared/pushoperations.md + - docs/models/shared/datatypes.md + - docs/models/shared/datastatus.md + - docs/models/shared/pulloperations.md + - docs/models/shared/companygroupassignment.md + - docs/models/shared/group.md + - docs/models/shared/groupprototype.md + - docs/models/shared/groups.md + - docs/models/shared/integration.md + - docs/models/shared/datatypefeature.md + - docs/models/shared/supportedfeature.md + - docs/models/shared/featuretype.md + - docs/models/shared/featurestate.md + - docs/models/shared/branding.md + - docs/models/shared/brandinglogo.md + - docs/models/shared/brandingimage.md + - docs/models/shared/imagereference.md + - docs/models/shared/brandingbutton.md + - docs/models/shared/integrations.md + - docs/models/shared/supplementaldatasourceconfiguration.md + - docs/models/shared/supplementaldataconfiguration.md + - docs/models/shared/webhook.md + - docs/models/shared/webhooknotifier.md + - docs/models/shared/createrule.md + - docs/models/shared/webhooks.md + - docs/models/shared/security.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/datasynccompletedwebhookdata.md + - docs/models/shared/datasetdatachangedwebhookdata.md + - docs/models/shared/datasetdatachangedwebhook.md + - docs/models/shared/datasetstatuschangederrorwebhook.md + - docs/models/shared/datasetstatuschangederrorwebhookdata.md + - docs/models/shared/newcompanysynchronizedwebhook.md + - docs/models/shared/newcompanysynchronizedwebhookdata.md + - docs/models/shared/pushoperationtimedoutwebhook.md + - docs/models/shared/pushoperationtimedoutwebhookdata.md + - docs/models/shared/pushoperationstatuschangedwebhook.md + - docs/models/shared/pushoperationstatuschangedwebhookdata.md + - docs/models/errors/errormessage.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 + - docs/models/webhooks/datasetstatushaschangedtoanerrorstateresponse.md + - docs/models/webhooks/newcompanysynchronizedresponse.md + - docs/models/webhooks/pushoperationhastimedoutresponse.md + - docs/models/webhooks/pushoperationstatushaschangedresponse.md + - docs/sdks/codatplatform/README.md + - docs/models/utils/retryconfig.md + - docs/sdks/settings/README.md + - docs/sdks/companies/README.md + - docs/sdks/connections/README.md + - docs/sdks/customdatatype/README.md + - docs/sdks/pushdata/README.md + - docs/sdks/refreshdata/README.md + - docs/sdks/groups/README.md + - docs/sdks/integrations/README.md + - docs/sdks/supplementaldata/README.md + - docs/sdks/webhooks/README.md + - USAGE.md + - .gitattributes diff --git a/platform/README.md b/platform/README.md index 401e696ac..bda3179b2 100644 --- a/platform/README.md +++ b/platform/README.md @@ -121,9 +121,9 @@ if res.api_key_details is not None: ## Retries -Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK. +Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK. -To change the default retry strategy for a single API call, simply provide a retryConfig object to the call: +To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call: ```python import codatplatform from codatplatform.models import shared @@ -147,7 +147,7 @@ if res.api_key_details is not None: pass ``` -If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization: +If you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK: ```python import codatplatform from codatplatform.models import shared @@ -186,7 +186,7 @@ Handling errors in this SDK should largely match your expectations. All operati ```python import codatplatform -from codatplatform.models import shared +from codatplatform.models import errors, shared s = codatplatform.CodatPlatform( security=shared.Security( @@ -202,10 +202,10 @@ res = None try: res = s.settings.create_api_key(req) except errors.ErrorMessage as e: - print(e) # handle exception + # handle exception raise(e) except errors.SDKError as e: - print(e) # handle exception + # handle exception raise(e) if res.api_key_details is not None: @@ -279,7 +279,7 @@ if res.api_key_details is not None: ## Custom HTTP Client -The Python SDK makes API calls using the (requests)[https://pypi.org/project/requests/] HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `requests.Session` object. +The Python SDK makes API calls using the [requests](https://pypi.org/project/requests/) HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `requests.Session` object. For example, you could specify a header for every request that this sdk makes as follows: ```python diff --git a/platform/RELEASES.md b/platform/RELEASES.md index 2942dbdf2..4d0c9a721 100644 --- a/platform/RELEASES.md +++ b/platform/RELEASES.md @@ -68,4 +68,14 @@ Based on: ### Generated - [python v3.2.0] platform ### Releases -- [PyPI v3.2.0] https://pypi.org/project/codat-platform/3.2.0 - platform \ No newline at end of file +- [PyPI v3.2.0] https://pypi.org/project/codat-platform/3.2.0 - platform + +## 2024-02-14 10:44:02 +### Changes +Based on: +- OpenAPI Doc 3.0.0 https://raw.githubusercontent.com/codatio/oas/main/yaml/Codat-Platform.yaml +- Speakeasy CLI 1.179.0 (2.257.2) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v3.3.0] platform +### Releases +- [PyPI v3.3.0] https://pypi.org/project/codat-platform/3.3.0 - platform \ No newline at end of file diff --git a/platform/docs/models/errors/errormessage.md b/platform/docs/models/errors/errormessage.md index 0ba63c988..10b0ad779 100644 --- a/platform/docs/models/errors/errormessage.md +++ b/platform/docs/models/errors/errormessage.md @@ -5,11 +5,12 @@ Bad Request ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `can_be_retried` | *Optional[str]* | :heavy_minus_sign: | `True` if the error occurred transiently and can be retried. | -| `correlation_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier used to propagate to all downstream services and determine the source of the error. | -| `detailed_error_code` | *Optional[int]* | :heavy_minus_sign: | Machine readable error code used to automate processes based on the code returned. | -| `error` | *Optional[str]* | :heavy_minus_sign: | A brief description of the error. | -| `service` | *Optional[str]* | :heavy_minus_sign: | Codat's service the returned the error. | -| `status_code` | *Optional[int]* | :heavy_minus_sign: | The HTTP status code returned by the error. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `can_be_retried` | *Optional[str]* | :heavy_minus_sign: | `True` if the error occurred transiently and can be retried. | +| `correlation_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier used to propagate to all downstream services and determine the source of the error. | +| `detailed_error_code` | *Optional[int]* | :heavy_minus_sign: | Machine readable error code used to automate processes based on the code returned. | +| `error` | *Optional[str]* | :heavy_minus_sign: | A brief description of the error. | +| `service` | *Optional[str]* | :heavy_minus_sign: | Codat's service the returned the error. | +| `status_code` | *Optional[int]* | :heavy_minus_sign: | The HTTP status code returned by the error. | +| `validation` | [Optional[shared.ErrorValidation]](../../models/shared/errorvalidation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made. If an operation has failed because of validation errors, they will be detailed here. | \ No newline at end of file diff --git a/platform/docs/models/operations/addcompanytogrouprequest.md b/platform/docs/models/operations/addcompanytogrouprequest.md index bdff26f68..427289838 100644 --- a/platform/docs/models/operations/addcompanytogrouprequest.md +++ b/platform/docs/models/operations/addcompanytogrouprequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `company_group_assignment` | [Optional[shared.CompanyGroupAssignment]](../../models/shared/companygroupassignment.md) | :heavy_minus_sign: | N/A | | -| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_group_assignment` | [Optional[shared.CompanyGroupAssignment]](../../models/shared/companygroupassignment.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/platform/docs/models/operations/addcompanytogroupresponse.md b/platform/docs/models/operations/addcompanytogroupresponse.md index 32746e27f..05f5abd06 100644 --- a/platform/docs/models/operations/addcompanytogroupresponse.md +++ b/platform/docs/models/operations/addcompanytogroupresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `company` | [Optional[shared.Company]](../../models/shared/company.md) | :heavy_minus_sign: | Success | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `company` | [Optional[shared.Company]](../../models/shared/company.md) | :heavy_minus_sign: | Success | {"id":"0498e921-9b53-4396-a412-4f2f5983b0a2","name":"string","platform":"string","redirect":"https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739","lastSync":"2022-01-01T12:00:00.000Z","created":"2022-01-01T12:00:00.000Z","createdByUserName":"string","dataConnections":[{"id":"ee2eb431-c0fa-4dc9-93fa-d29781c12bcd","integrationId":"bf083d72-62c7-493e-aec9-81b4dbba7e2c","integrationKey":"dfxm","sourceId":"bdd831ce-eebd-4896-89a7-20e5ee8989ee","platformName":"Basiq","linkUrl":"https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start","status":"Linked","lastSync":"2022-10-27T10:22:43.6464237Z","created":"2022-10-27T09:53:29Z","sourceType":"Banking"}],"groups":[{"id":"d7a6c4b4-dc87-45f6-b803-62f466398680"}]} | \ No newline at end of file diff --git a/platform/docs/models/operations/configurecustomdatatyperequest.md b/platform/docs/models/operations/configurecustomdatatyperequest.md index ec12ae094..025ad48bc 100644 --- a/platform/docs/models/operations/configurecustomdatatyperequest.md +++ b/platform/docs/models/operations/configurecustomdatatyperequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `custom_data_type_configuration` | [Optional[shared.CustomDataTypeConfiguration]](../../models/shared/customdatatypeconfiguration.md) | :heavy_minus_sign: | Custom data type configuration for the specified platform. | | -| `custom_data_identifier` | *str* | :heavy_check_mark: | Unique identifier for a custom data type. | DynamicsPurchaseOrders | -| `platform_key` | *str* | :heavy_check_mark: | A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys. | gbol | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `custom_data_identifier` | *str* | :heavy_check_mark: | Unique identifier for a custom data type. | DynamicsPurchaseOrders | +| `platform_key` | *str* | :heavy_check_mark: | A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys. | gbol | +| `custom_data_type_configuration` | [Optional[shared.CustomDataTypeConfiguration]](../../models/shared/customdatatypeconfiguration.md) | :heavy_minus_sign: | Custom data type configuration for the specified platform. | {"dataSource":"api/purchaseOrders?$filter=currencyCode eq 'NOK'","requiredData":{"currencyCode":"$[*].currencyCode","id":"$[*].id","number":"$[*].number","orderDate":"$[*].orderDate","totalAmountExcludingTax":"$[*].totalAmountExcludingTax","totalTaxAmount":"$[*].totalTaxAmount","vendorName":"$[*].number"},"keyBy":["$[*].id"],"sourceModifiedDate":["$[*].lastModifiedDateTime"]} | \ No newline at end of file diff --git a/platform/docs/models/operations/configurecustomdatatyperesponse.md b/platform/docs/models/operations/configurecustomdatatyperesponse.md index 32a7aa7e3..3e01b572a 100644 --- a/platform/docs/models/operations/configurecustomdatatyperesponse.md +++ b/platform/docs/models/operations/configurecustomdatatyperesponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `custom_data_type_configuration` | [Optional[shared.CustomDataTypeConfiguration]](../../models/shared/customdatatypeconfiguration.md) | :heavy_minus_sign: | OK | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `custom_data_type_configuration` | [Optional[shared.CustomDataTypeConfiguration]](../../models/shared/customdatatypeconfiguration.md) | :heavy_minus_sign: | OK | {"dataSource":"api/purchaseOrders?$filter=currencyCode eq 'NOK'","requiredData":{"currencyCode":"$[*].currencyCode","id":"$[*].id","number":"$[*].number","orderDate":"$[*].orderDate","totalAmountExcludingTax":"$[*].totalAmountExcludingTax","totalTaxAmount":"$[*].totalTaxAmount","vendorName":"$[*].number"},"keyBy":["$[*].id"],"sourceModifiedDate":["$[*].lastModifiedDateTime"]} | \ No newline at end of file diff --git a/platform/docs/models/operations/configuresupplementaldatarequest.md b/platform/docs/models/operations/configuresupplementaldatarequest.md index da21768e8..103acdabf 100644 --- a/platform/docs/models/operations/configuresupplementaldatarequest.md +++ b/platform/docs/models/operations/configuresupplementaldatarequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `supplemental_data_configuration` | [Optional[shared.SupplementalDataConfiguration]](../../models/shared/supplementaldataconfiguration.md) | :heavy_minus_sign: | The configuration for the specified platform and data type. | | | `data_type` | [operations.DataType](../../models/operations/datatype.md) | :heavy_check_mark: | Supported supplemental data data type. | invoices | -| `platform_key` | *str* | :heavy_check_mark: | A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys. | gbol | \ No newline at end of file +| `platform_key` | *str* | :heavy_check_mark: | A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys. | gbol | +| `supplemental_data_configuration` | [Optional[shared.SupplementalDataConfiguration]](../../models/shared/supplementaldataconfiguration.md) | :heavy_minus_sign: | The configuration for the specified platform and data type. | {"supplementalDataConfig":{"orders-supplemental-data":{"dataSource":"/orders","pullData":{"orderNumber":"order_num"},"pushData":{"orderNumber":"order_num"}}}} | \ No newline at end of file diff --git a/platform/docs/models/operations/createapikeyresponse.md b/platform/docs/models/operations/createapikeyresponse.md index 6a06c6da3..2aaf8231c 100644 --- a/platform/docs/models/operations/createapikeyresponse.md +++ b/platform/docs/models/operations/createapikeyresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `api_key_details` | [Optional[shared.APIKeyDetails]](../../models/shared/apikeydetails.md) | :heavy_minus_sign: | Success | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `api_key_details` | [Optional[shared.APIKeyDetails]](../../models/shared/apikeydetails.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/platform/docs/models/operations/createcompanyresponse.md b/platform/docs/models/operations/createcompanyresponse.md index 509542849..faee951b5 100644 --- a/platform/docs/models/operations/createcompanyresponse.md +++ b/platform/docs/models/operations/createcompanyresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `company` | [Optional[shared.Company]](../../models/shared/company.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `company` | [Optional[shared.Company]](../../models/shared/company.md) | :heavy_minus_sign: | OK | {"id":"0498e921-9b53-4396-a412-4f2f5983b0a2","name":"string","platform":"string","redirect":"https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739","lastSync":"2022-01-01T12:00:00.000Z","created":"2022-01-01T12:00:00.000Z","createdByUserName":"string","dataConnections":[{"id":"ee2eb431-c0fa-4dc9-93fa-d29781c12bcd","integrationId":"bf083d72-62c7-493e-aec9-81b4dbba7e2c","integrationKey":"dfxm","sourceId":"bdd831ce-eebd-4896-89a7-20e5ee8989ee","platformName":"Basiq","linkUrl":"https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start","status":"Linked","lastSync":"2022-10-27T10:22:43.6464237Z","created":"2022-10-27T09:53:29Z","sourceType":"Banking"}],"groups":[{"id":"d7a6c4b4-dc87-45f6-b803-62f466398680"}]} | \ No newline at end of file diff --git a/platform/docs/models/operations/createconnectionrequest.md b/platform/docs/models/operations/createconnectionrequest.md index 0998495bf..ff26e52b6 100644 --- a/platform/docs/models/operations/createconnectionrequest.md +++ b/platform/docs/models/operations/createconnectionrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `request_body` | [Optional[operations.CreateConnectionRequestBody]](../../models/operations/createconnectionrequestbody.md) | :heavy_minus_sign: | N/A | | -| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `request_body` | [Optional[operations.CreateConnectionRequestBody]](../../models/operations/createconnectionrequestbody.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/platform/docs/models/operations/createconnectionresponse.md b/platform/docs/models/operations/createconnectionresponse.md index 4f38451fa..4d113122e 100644 --- a/platform/docs/models/operations/createconnectionresponse.md +++ b/platform/docs/models/operations/createconnectionresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `connection` | [Optional[shared.Connection]](../../models/shared/connection.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `connection` | [Optional[shared.Connection]](../../models/shared/connection.md) | :heavy_minus_sign: | OK | {"id":"ee2eb431-c0fa-4dc9-93fa-d29781c12bcd","integrationId":"bf083d72-62c7-493e-aec9-81b4dbba7e2c","integrationKey":"dfxm","sourceId":"bdd831ce-eebd-4896-89a7-20e5ee8989ee","platformName":"Basiq","linkUrl":"https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start","status":"Linked","lastSync":"2022-10-27T10:22:43.6464237Z","created":"2022-10-27T09:53:29Z","sourceType":"Banking"} | \ No newline at end of file diff --git a/platform/docs/models/operations/creategroupresponse.md b/platform/docs/models/operations/creategroupresponse.md index 8e6f8a7ea..cdccd50c1 100644 --- a/platform/docs/models/operations/creategroupresponse.md +++ b/platform/docs/models/operations/creategroupresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `group` | [Optional[shared.Group]](../../models/shared/group.md) | :heavy_minus_sign: | Success | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `group` | [Optional[shared.Group]](../../models/shared/group.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/platform/docs/models/operations/createruleresponse.md b/platform/docs/models/operations/createruleresponse.md index 4b8531707..df77fc41f 100644 --- a/platform/docs/models/operations/createruleresponse.md +++ b/platform/docs/models/operations/createruleresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `webhook` | [Optional[shared.Webhook]](../../models/shared/webhook.md) | :heavy_minus_sign: | OK | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `webhook` | [Optional[shared.Webhook]](../../models/shared/webhook.md) | :heavy_minus_sign: | OK | {"type":"DataConnectionStatusChanged","companyId":"39b73b17-cc2e-429e-915d-71654e9dcd1e","notifiers":{"emails":["info@client.com"],"webhook":"https://webhook.client.com"}} | \ No newline at end of file diff --git a/platform/docs/models/operations/deleteapikeyresponse.md b/platform/docs/models/operations/deleteapikeyresponse.md index 7436a0169..7a65db7b8 100644 --- a/platform/docs/models/operations/deleteapikeyresponse.md +++ b/platform/docs/models/operations/deleteapikeyresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `error_message` | *Optional[errors.ErrorMessage]* | :heavy_minus_sign: | Too many requests were made in a given amount of time. Wait a short period and then try again. | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `error_message` | *Optional[errors.ErrorMessage]* | :heavy_minus_sign: | Too many requests were made in a given amount of time. Wait a short period and then try again. | \ No newline at end of file diff --git a/platform/docs/models/operations/getcompanydatastatusresponse.md b/platform/docs/models/operations/getcompanydatastatusresponse.md index 76e928288..0d9e4b287 100644 --- a/platform/docs/models/operations/getcompanydatastatusresponse.md +++ b/platform/docs/models/operations/getcompanydatastatusresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `data_statuses` | Dict[str, [shared.DataStatus](../../models/shared/datastatus.md)] | :heavy_minus_sign: | OK | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `data_statuses` | Dict[str, [shared.DataStatus](../../models/shared/datastatus.md)] | :heavy_minus_sign: | OK | \ No newline at end of file diff --git a/platform/docs/models/operations/getcompanypushhistoryresponse.md b/platform/docs/models/operations/getcompanypushhistoryresponse.md index 54d1c9e53..4f22f04b7 100644 --- a/platform/docs/models/operations/getcompanypushhistoryresponse.md +++ b/platform/docs/models/operations/getcompanypushhistoryresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `push_operations` | [Optional[shared.PushOperations]](../../models/shared/pushoperations.md) | :heavy_minus_sign: | OK | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `push_operations` | [Optional[shared.PushOperations]](../../models/shared/pushoperations.md) | :heavy_minus_sign: | OK | {"_links":{"pageNumber":1,"pageSize":10,"totalResults":1,"self":{"href":"/companies/{id}/data/{dataType}"},"current":{"href":"/companies/{id}/data/{dataType}?page=1&pageSize=10"}}} | \ No newline at end of file diff --git a/platform/docs/models/operations/getcompanyresponse.md b/platform/docs/models/operations/getcompanyresponse.md index 98fd19b23..9b44863d2 100644 --- a/platform/docs/models/operations/getcompanyresponse.md +++ b/platform/docs/models/operations/getcompanyresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `company` | [Optional[shared.Company]](../../models/shared/company.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `company` | [Optional[shared.Company]](../../models/shared/company.md) | :heavy_minus_sign: | OK | {"id":"0498e921-9b53-4396-a412-4f2f5983b0a2","name":"string","platform":"string","redirect":"https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739","lastSync":"2022-01-01T12:00:00.000Z","created":"2022-01-01T12:00:00.000Z","createdByUserName":"string","dataConnections":[{"id":"ee2eb431-c0fa-4dc9-93fa-d29781c12bcd","integrationId":"bf083d72-62c7-493e-aec9-81b4dbba7e2c","integrationKey":"dfxm","sourceId":"bdd831ce-eebd-4896-89a7-20e5ee8989ee","platformName":"Basiq","linkUrl":"https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start","status":"Linked","lastSync":"2022-10-27T10:22:43.6464237Z","created":"2022-10-27T09:53:29Z","sourceType":"Banking"}],"groups":[{"id":"d7a6c4b4-dc87-45f6-b803-62f466398680"}]} | \ No newline at end of file diff --git a/platform/docs/models/operations/getconnectionresponse.md b/platform/docs/models/operations/getconnectionresponse.md index 4dd62a7a6..66e3f65f1 100644 --- a/platform/docs/models/operations/getconnectionresponse.md +++ b/platform/docs/models/operations/getconnectionresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `connection` | [Optional[shared.Connection]](../../models/shared/connection.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `connection` | [Optional[shared.Connection]](../../models/shared/connection.md) | :heavy_minus_sign: | OK | {"id":"ee2eb431-c0fa-4dc9-93fa-d29781c12bcd","integrationId":"bf083d72-62c7-493e-aec9-81b4dbba7e2c","integrationKey":"dfxm","sourceId":"bdd831ce-eebd-4896-89a7-20e5ee8989ee","platformName":"Basiq","linkUrl":"https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start","status":"Linked","lastSync":"2022-10-27T10:22:43.6464237Z","created":"2022-10-27T09:53:29Z","sourceType":"Banking"} | \ No newline at end of file diff --git a/platform/docs/models/operations/getcreateupdatemodeloptionsbydatatyperesponse.md b/platform/docs/models/operations/getcreateupdatemodeloptionsbydatatyperesponse.md index 14382593c..57d39fdca 100644 --- a/platform/docs/models/operations/getcreateupdatemodeloptionsbydatatyperesponse.md +++ b/platform/docs/models/operations/getcreateupdatemodeloptionsbydatatyperesponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `push_option` | [Optional[shared.PushOption]](../../models/shared/pushoption.md) | :heavy_minus_sign: | OK | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `push_option` | [Optional[shared.PushOption]](../../models/shared/pushoption.md) | :heavy_minus_sign: | OK | \ No newline at end of file diff --git a/platform/docs/models/operations/getcustomdatatypeconfigurationresponse.md b/platform/docs/models/operations/getcustomdatatypeconfigurationresponse.md index 74e6c1da1..1a0b475aa 100644 --- a/platform/docs/models/operations/getcustomdatatypeconfigurationresponse.md +++ b/platform/docs/models/operations/getcustomdatatypeconfigurationresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `custom_data_type_records` | [Optional[shared.CustomDataTypeRecords]](../../models/shared/customdatatyperecords.md) | :heavy_minus_sign: | OK | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `custom_data_type_records` | [Optional[shared.CustomDataTypeRecords]](../../models/shared/customdatatyperecords.md) | :heavy_minus_sign: | OK | \ No newline at end of file diff --git a/platform/docs/models/operations/getintegrationresponse.md b/platform/docs/models/operations/getintegrationresponse.md index b3e65ce15..ba1fe0aff 100644 --- a/platform/docs/models/operations/getintegrationresponse.md +++ b/platform/docs/models/operations/getintegrationresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `integration` | [Optional[shared.Integration]](../../models/shared/integration.md) | :heavy_minus_sign: | OK | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `integration` | [Optional[shared.Integration]](../../models/shared/integration.md) | :heavy_minus_sign: | OK | {"key":"gbol","logoUrl":"http://example.com","name":"Xero","enabled":true,"sourceId":"accounting","sourceType":"8193a927-ab7a-45a3-9dc2-d357a4932dfe","integrationId":"497a18ca-284e-40c0-985d-f72be35d468e","isOfflineConnector":true,"isBeta":true,"dataProvidedBy":"string","datatypeFeatures":[{"datatype":"invoices","supportedFeatures":[{"featureType":"get","featureState":"release"}]}]} | \ No newline at end of file diff --git a/platform/docs/models/operations/getintegrationsbrandingresponse.md b/platform/docs/models/operations/getintegrationsbrandingresponse.md index 73e19ae4a..13d358a4d 100644 --- a/platform/docs/models/operations/getintegrationsbrandingresponse.md +++ b/platform/docs/models/operations/getintegrationsbrandingresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `branding` | [Optional[shared.Branding]](../../models/shared/branding.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `branding` | [Optional[shared.Branding]](../../models/shared/branding.md) | :heavy_minus_sign: | OK | {"logo":{"full":{"image":{"src":"https://static.codat.io/public/officialLogos/Full/8A156A5A-39CB-4F9D-856E-76EF9B9A9607.png","alt":"xero full icon"}},"square":{"image":{"src":"https://static.codat.io/public/officialLogos/Square/8A156A5A-39CB-4F9D-856E-76EF9B2W3607.png","alt":"xero square icon"}}},"button":{"default":{"image":{"src":"https://static.codat.io/public/officialButtons/Full/8A156A5A-39CB-4F9D-856E-76EF9Q7A9607.png","alt":"xero default button icon"}},"hover":{"image":{"src":"https://static.codat.io/public/officialLogos/Full/8A156A5A-39CB-4F9D-856E-76EF9B9A9607.png","alt":"xero hover button icon"}}},"sourceId":"35b92968-9851-4095-ad60-395c95cbcba4"} | \ No newline at end of file diff --git a/platform/docs/models/operations/getprofileresponse.md b/platform/docs/models/operations/getprofileresponse.md index 520d19a4c..2bdefd1d7 100644 --- a/platform/docs/models/operations/getprofileresponse.md +++ b/platform/docs/models/operations/getprofileresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `profile` | [Optional[shared.Profile]](../../models/shared/profile.md) | :heavy_minus_sign: | OK | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `profile` | [Optional[shared.Profile]](../../models/shared/profile.md) | :heavy_minus_sign: | OK | {"name":"Bob's Burgers","logoUrl":"https://client-images.codat.io/logo/042399f5-d104-4f38-9ce8-cac3524f4e88_5806cb1f-7342-4c0e-a0a8-99bfbc47b0ff.png","iconUrl":"https://client-images.codat.io/icon/042399f5-d104-4f38-9ce8-cac3524f4e88_3f5623af-d992-4c22-bc08-e58c520a8526.ico","redirectUrl":"https://bobs-burgers.{countrySuffix}/{companyId}","whiteListUrls":["https://bobs-burgers.com","https://bobs-burgers.co.uk"],"confirmCompanyName":true} | \ No newline at end of file diff --git a/platform/docs/models/operations/getpulloperationresponse.md b/platform/docs/models/operations/getpulloperationresponse.md index 6ed2cf572..1ee27f4e4 100644 --- a/platform/docs/models/operations/getpulloperationresponse.md +++ b/platform/docs/models/operations/getpulloperationresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `pull_operation` | [Optional[shared.PullOperation]](../../models/shared/pulloperation.md) | :heavy_minus_sign: | OK | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `pull_operation` | [Optional[shared.PullOperation]](../../models/shared/pulloperation.md) | :heavy_minus_sign: | OK | {"id":"97d60846-f07a-4d42-b5a0-0bdcc6ebf56b","companyId":"4645bd78-8988-45bc-ac9e-67ba5df6e4e5","connectionId":"51baa045-4836-4317-a42e-3542e991e581","dataType":"invoices","status":"Initial","statusDescription":"Paused until 2022-10-23T00:00:00.000Z","requested":"2022-11-14T11:18:37.2798351Z","progress":10,"isCompleted":false,"isErrored":false} | \ No newline at end of file diff --git a/platform/docs/models/operations/getpushoperationresponse.md b/platform/docs/models/operations/getpushoperationresponse.md index bfc9ae726..17e937758 100644 --- a/platform/docs/models/operations/getpushoperationresponse.md +++ b/platform/docs/models/operations/getpushoperationresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `push_operation` | [Optional[shared.PushOperation]](../../models/shared/pushoperation.md) | :heavy_minus_sign: | OK | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `push_operation` | [Optional[shared.PushOperation]](../../models/shared/pushoperation.md) | :heavy_minus_sign: | OK | \ No newline at end of file diff --git a/platform/docs/models/operations/getsupplementaldataconfigurationresponse.md b/platform/docs/models/operations/getsupplementaldataconfigurationresponse.md index e134d4b53..16cfadc4c 100644 --- a/platform/docs/models/operations/getsupplementaldataconfigurationresponse.md +++ b/platform/docs/models/operations/getsupplementaldataconfigurationresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `supplemental_data_configuration` | [Optional[shared.SupplementalDataConfiguration]](../../models/shared/supplementaldataconfiguration.md) | :heavy_minus_sign: | OK | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `supplemental_data_configuration` | [Optional[shared.SupplementalDataConfiguration]](../../models/shared/supplementaldataconfiguration.md) | :heavy_minus_sign: | OK | {"supplementalDataConfig":{"orders-supplemental-data":{"dataSource":"/orders","pullData":{"orderNumber":"order_num"},"pushData":{"orderNumber":"order_num"}}}} | \ No newline at end of file diff --git a/platform/docs/models/operations/getwebhookresponse.md b/platform/docs/models/operations/getwebhookresponse.md index ca16b40b5..173e7fea6 100644 --- a/platform/docs/models/operations/getwebhookresponse.md +++ b/platform/docs/models/operations/getwebhookresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `webhook` | [Optional[shared.Webhook]](../../models/shared/webhook.md) | :heavy_minus_sign: | OK | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `webhook` | [Optional[shared.Webhook]](../../models/shared/webhook.md) | :heavy_minus_sign: | OK | {"type":"DataConnectionStatusChanged","companyId":"39b73b17-cc2e-429e-915d-71654e9dcd1e","notifiers":{"emails":["info@client.com"],"webhook":"https://webhook.client.com"}} | \ No newline at end of file diff --git a/platform/docs/models/operations/listapikeysresponse.md b/platform/docs/models/operations/listapikeysresponse.md index 74c508f56..c1f0c8546 100644 --- a/platform/docs/models/operations/listapikeysresponse.md +++ b/platform/docs/models/operations/listapikeysresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `api_keys` | [Optional[shared.APIKeys]](../../models/shared/apikeys.md) | :heavy_minus_sign: | Success | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `api_keys` | [Optional[shared.APIKeys]](../../models/shared/apikeys.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/platform/docs/models/operations/listcompaniesresponse.md b/platform/docs/models/operations/listcompaniesresponse.md index 42b07950c..7abc40ecd 100644 --- a/platform/docs/models/operations/listcompaniesresponse.md +++ b/platform/docs/models/operations/listcompaniesresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `companies` | [Optional[shared.Companies]](../../models/shared/companies.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `companies` | [Optional[shared.Companies]](../../models/shared/companies.md) | :heavy_minus_sign: | OK | {"_links":{"pageNumber":1,"pageSize":10,"totalResults":1,"self":{"href":"/companies/{id}/data/{dataType}"},"current":{"href":"/companies/{id}/data/{dataType}?page=1&pageSize=10"}}} | \ No newline at end of file diff --git a/platform/docs/models/operations/listconnectionsresponse.md b/platform/docs/models/operations/listconnectionsresponse.md index dacec2f64..78b8ddd89 100644 --- a/platform/docs/models/operations/listconnectionsresponse.md +++ b/platform/docs/models/operations/listconnectionsresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `connections` | [Optional[shared.Connections]](../../models/shared/connections.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `connections` | [Optional[shared.Connections]](../../models/shared/connections.md) | :heavy_minus_sign: | OK | {"_links":{"pageNumber":1,"pageSize":10,"totalResults":1,"self":{"href":"/companies/{id}/data/{dataType}"},"current":{"href":"/companies/{id}/data/{dataType}?page=1&pageSize=10"}}} | \ No newline at end of file diff --git a/platform/docs/models/operations/listcustomdatatyperecordsresponse.md b/platform/docs/models/operations/listcustomdatatyperecordsresponse.md index 8a781bac4..a8a5baed4 100644 --- a/platform/docs/models/operations/listcustomdatatyperecordsresponse.md +++ b/platform/docs/models/operations/listcustomdatatyperecordsresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `custom_data_type_records` | [Optional[shared.CustomDataTypeRecords]](../../models/shared/customdatatyperecords.md) | :heavy_minus_sign: | OK | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `custom_data_type_records` | [Optional[shared.CustomDataTypeRecords]](../../models/shared/customdatatyperecords.md) | :heavy_minus_sign: | OK | \ No newline at end of file diff --git a/platform/docs/models/operations/listintegrationsresponse.md b/platform/docs/models/operations/listintegrationsresponse.md index bfa4b02b7..37c3b9e4b 100644 --- a/platform/docs/models/operations/listintegrationsresponse.md +++ b/platform/docs/models/operations/listintegrationsresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `integrations` | [Optional[shared.Integrations]](../../models/shared/integrations.md) | :heavy_minus_sign: | OK | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `integrations` | [Optional[shared.Integrations]](../../models/shared/integrations.md) | :heavy_minus_sign: | OK | {"_links":{"pageNumber":1,"pageSize":10,"totalResults":1,"self":{"href":"/companies/{id}/data/{dataType}"},"current":{"href":"/companies/{id}/data/{dataType}?page=1&pageSize=10"}}} | \ No newline at end of file diff --git a/platform/docs/models/operations/listpulloperationsresponse.md b/platform/docs/models/operations/listpulloperationsresponse.md index b58dc8961..b51df770a 100644 --- a/platform/docs/models/operations/listpulloperationsresponse.md +++ b/platform/docs/models/operations/listpulloperationsresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `pull_operations` | [Optional[shared.PullOperations]](../../models/shared/pulloperations.md) | :heavy_minus_sign: | OK | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `pull_operations` | [Optional[shared.PullOperations]](../../models/shared/pulloperations.md) | :heavy_minus_sign: | OK | {"_links":{"pageNumber":1,"pageSize":10,"totalResults":1,"self":{"href":"/companies/{id}/data/{dataType}"},"current":{"href":"/companies/{id}/data/{dataType}?page=1&pageSize=10"}}} | \ No newline at end of file diff --git a/platform/docs/models/operations/listrulesresponse.md b/platform/docs/models/operations/listrulesresponse.md index bbf032630..b3b7870ac 100644 --- a/platform/docs/models/operations/listrulesresponse.md +++ b/platform/docs/models/operations/listrulesresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `webhooks` | [Optional[shared.Webhooks]](../../models/shared/webhooks.md) | :heavy_minus_sign: | OK | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `webhooks` | [Optional[shared.Webhooks]](../../models/shared/webhooks.md) | :heavy_minus_sign: | OK | {"_links":{"pageNumber":1,"pageSize":10,"totalResults":1,"self":{"href":"/companies/{id}/data/{dataType}"},"current":{"href":"/companies/{id}/data/{dataType}?page=1&pageSize=10"}}} | \ No newline at end of file diff --git a/platform/docs/models/operations/refreshcustomdatatyperesponse.md b/platform/docs/models/operations/refreshcustomdatatyperesponse.md index 3e82a5e51..ff115ff33 100644 --- a/platform/docs/models/operations/refreshcustomdatatyperesponse.md +++ b/platform/docs/models/operations/refreshcustomdatatyperesponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `pull_operation` | [Optional[shared.PullOperation]](../../models/shared/pulloperation.md) | :heavy_minus_sign: | OK | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `pull_operation` | [Optional[shared.PullOperation]](../../models/shared/pulloperation.md) | :heavy_minus_sign: | OK | {"id":"97d60846-f07a-4d42-b5a0-0bdcc6ebf56b","companyId":"4645bd78-8988-45bc-ac9e-67ba5df6e4e5","connectionId":"51baa045-4836-4317-a42e-3542e991e581","dataType":"invoices","status":"Initial","statusDescription":"Paused until 2022-10-23T00:00:00.000Z","requested":"2022-11-14T11:18:37.2798351Z","progress":10,"isCompleted":false,"isErrored":false} | \ No newline at end of file diff --git a/platform/docs/models/operations/refreshdatatyperequest.md b/platform/docs/models/operations/refreshdatatyperequest.md index 1047c2228..35df09d55 100644 --- a/platform/docs/models/operations/refreshdatatyperequest.md +++ b/platform/docs/models/operations/refreshdatatyperequest.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | | `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *Optional[str]* | :heavy_minus_sign: | Optionally, provide a data connection id to only queue pull operations on that connection. | | -| `data_type` | [shared.SchemaDataType](../../models/shared/schemadatatype.md) | :heavy_check_mark: | The key of a Codat data type | invoices | \ No newline at end of file +| `data_type` | [shared.SchemaDataType](../../models/shared/schemadatatype.md) | :heavy_check_mark: | The key of a Codat data type | invoices | +| `connection_id` | *Optional[str]* | :heavy_minus_sign: | Optionally, provide a data connection id to only queue pull operations on that connection. | | \ No newline at end of file diff --git a/platform/docs/models/operations/refreshdatatyperesponse.md b/platform/docs/models/operations/refreshdatatyperesponse.md index 7be7f61b1..7ec003a19 100644 --- a/platform/docs/models/operations/refreshdatatyperesponse.md +++ b/platform/docs/models/operations/refreshdatatyperesponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `pull_operation` | [Optional[shared.PullOperation]](../../models/shared/pulloperation.md) | :heavy_minus_sign: | OK | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `pull_operation` | [Optional[shared.PullOperation]](../../models/shared/pulloperation.md) | :heavy_minus_sign: | OK | {"id":"97d60846-f07a-4d42-b5a0-0bdcc6ebf56b","companyId":"4645bd78-8988-45bc-ac9e-67ba5df6e4e5","connectionId":"51baa045-4836-4317-a42e-3542e991e581","dataType":"invoices","status":"Initial","statusDescription":"Paused until 2022-10-23T00:00:00.000Z","requested":"2022-11-14T11:18:37.2798351Z","progress":10,"isCompleted":false,"isErrored":false} | \ No newline at end of file diff --git a/platform/docs/models/operations/unlinkconnectionrequest.md b/platform/docs/models/operations/unlinkconnectionrequest.md index b96501797..a4e65982a 100644 --- a/platform/docs/models/operations/unlinkconnectionrequest.md +++ b/platform/docs/models/operations/unlinkconnectionrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| `update_connection_status` | [Optional[shared.UpdateConnectionStatus]](../../models/shared/updateconnectionstatus.md) | :heavy_minus_sign: | N/A | | | `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `update_connection_status` | [Optional[shared.UpdateConnectionStatus]](../../models/shared/updateconnectionstatus.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/platform/docs/models/operations/unlinkconnectionresponse.md b/platform/docs/models/operations/unlinkconnectionresponse.md index d1754acb5..08eb976b5 100644 --- a/platform/docs/models/operations/unlinkconnectionresponse.md +++ b/platform/docs/models/operations/unlinkconnectionresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `connection` | [Optional[shared.Connection]](../../models/shared/connection.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `connection` | [Optional[shared.Connection]](../../models/shared/connection.md) | :heavy_minus_sign: | OK | {"id":"ee2eb431-c0fa-4dc9-93fa-d29781c12bcd","integrationId":"bf083d72-62c7-493e-aec9-81b4dbba7e2c","integrationKey":"dfxm","sourceId":"bdd831ce-eebd-4896-89a7-20e5ee8989ee","platformName":"Basiq","linkUrl":"https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start","status":"Linked","lastSync":"2022-10-27T10:22:43.6464237Z","created":"2022-10-27T09:53:29Z","sourceType":"Banking"} | \ No newline at end of file diff --git a/platform/docs/models/operations/updatecompanyrequest.md b/platform/docs/models/operations/updatecompanyrequest.md index 7b76c7562..8ee99180f 100644 --- a/platform/docs/models/operations/updatecompanyrequest.md +++ b/platform/docs/models/operations/updatecompanyrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `company_request_body` | [Optional[shared.CompanyRequestBody]](../../models/shared/companyrequestbody.md) | :heavy_minus_sign: | N/A | | -| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `company_request_body` | [Optional[shared.CompanyRequestBody]](../../models/shared/companyrequestbody.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/platform/docs/models/operations/updatecompanyresponse.md b/platform/docs/models/operations/updatecompanyresponse.md index d299179e8..3005c9e88 100644 --- a/platform/docs/models/operations/updatecompanyresponse.md +++ b/platform/docs/models/operations/updatecompanyresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `company` | [Optional[shared.Company]](../../models/shared/company.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `company` | [Optional[shared.Company]](../../models/shared/company.md) | :heavy_minus_sign: | OK | {"id":"0498e921-9b53-4396-a412-4f2f5983b0a2","name":"string","platform":"string","redirect":"https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739","lastSync":"2022-01-01T12:00:00.000Z","created":"2022-01-01T12:00:00.000Z","createdByUserName":"string","dataConnections":[{"id":"ee2eb431-c0fa-4dc9-93fa-d29781c12bcd","integrationId":"bf083d72-62c7-493e-aec9-81b4dbba7e2c","integrationKey":"dfxm","sourceId":"bdd831ce-eebd-4896-89a7-20e5ee8989ee","platformName":"Basiq","linkUrl":"https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start","status":"Linked","lastSync":"2022-10-27T10:22:43.6464237Z","created":"2022-10-27T09:53:29Z","sourceType":"Banking"}],"groups":[{"id":"d7a6c4b4-dc87-45f6-b803-62f466398680"}]} | \ No newline at end of file diff --git a/platform/docs/models/operations/updateconnectionauthorizationrequest.md b/platform/docs/models/operations/updateconnectionauthorizationrequest.md index f35cc6013..219745541 100644 --- a/platform/docs/models/operations/updateconnectionauthorizationrequest.md +++ b/platform/docs/models/operations/updateconnectionauthorizationrequest.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `request_body` | Dict[str, *str*] | :heavy_minus_sign: | N/A | | | `company_id` | *str* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | \ No newline at end of file +| `connection_id` | *str* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `request_body` | Dict[str, *str*] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/platform/docs/models/operations/updateconnectionauthorizationresponse.md b/platform/docs/models/operations/updateconnectionauthorizationresponse.md index 8eca4e4bc..accfd471b 100644 --- a/platform/docs/models/operations/updateconnectionauthorizationresponse.md +++ b/platform/docs/models/operations/updateconnectionauthorizationresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `connection` | [Optional[shared.Connection]](../../models/shared/connection.md) | :heavy_minus_sign: | OK | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `connection` | [Optional[shared.Connection]](../../models/shared/connection.md) | :heavy_minus_sign: | OK | {"id":"ee2eb431-c0fa-4dc9-93fa-d29781c12bcd","integrationId":"bf083d72-62c7-493e-aec9-81b4dbba7e2c","integrationKey":"dfxm","sourceId":"bdd831ce-eebd-4896-89a7-20e5ee8989ee","platformName":"Basiq","linkUrl":"https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start","status":"Linked","lastSync":"2022-10-27T10:22:43.6464237Z","created":"2022-10-27T09:53:29Z","sourceType":"Banking"} | \ No newline at end of file diff --git a/platform/docs/models/operations/updateprofileresponse.md b/platform/docs/models/operations/updateprofileresponse.md index f821b94da..915dce5de 100644 --- a/platform/docs/models/operations/updateprofileresponse.md +++ b/platform/docs/models/operations/updateprofileresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `profile` | [Optional[shared.Profile]](../../models/shared/profile.md) | :heavy_minus_sign: | OK | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `profile` | [Optional[shared.Profile]](../../models/shared/profile.md) | :heavy_minus_sign: | OK | {"name":"Bob's Burgers","logoUrl":"https://client-images.codat.io/logo/042399f5-d104-4f38-9ce8-cac3524f4e88_5806cb1f-7342-4c0e-a0a8-99bfbc47b0ff.png","iconUrl":"https://client-images.codat.io/icon/042399f5-d104-4f38-9ce8-cac3524f4e88_3f5623af-d992-4c22-bc08-e58c520a8526.ico","redirectUrl":"https://bobs-burgers.{countrySuffix}/{companyId}","whiteListUrls":["https://bobs-burgers.com","https://bobs-burgers.co.uk"],"confirmCompanyName":true} | \ No newline at end of file diff --git a/platform/docs/models/operations/updateprofilesyncsettingsrequestbody.md b/platform/docs/models/operations/updateprofilesyncsettingsrequestbody.md index 50e12a24f..6be85a867 100644 --- a/platform/docs/models/operations/updateprofilesyncsettingsrequestbody.md +++ b/platform/docs/models/operations/updateprofilesyncsettingsrequestbody.md @@ -9,5 +9,5 @@ Include a `syncSetting` object for each data type. | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | | `client_id` | *str* | :heavy_check_mark: | Unique identifier for your client in Codat. | -| `overrides_defaults` | *Optional[bool]* | :heavy_minus_sign: | Set to `True` if you want to override default [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings). | -| `settings` | List[[shared.SyncSetting](../../models/shared/syncsetting.md)] | :heavy_check_mark: | N/A | \ No newline at end of file +| `settings` | List[[shared.SyncSetting](../../models/shared/syncsetting.md)] | :heavy_check_mark: | N/A | +| `overrides_defaults` | *Optional[bool]* | :heavy_minus_sign: | Set to `True` if you want to override default [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings). | \ No newline at end of file diff --git a/platform/docs/models/shared/companies.md b/platform/docs/models/shared/companies.md index 05e8c5131..c19c46de5 100644 --- a/platform/docs/models/shared/companies.md +++ b/platform/docs/models/shared/companies.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | Current page number. | -| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | -| `results` | List[[shared.Company](../../models/shared/company.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | {"self":{"href":"/companies/{id}/data/{dataType}"},"current":{"href":"/companies/{id}/data/{dataType}?page=1&pageSize=10"}} | +| `page_number` | *int* | :heavy_check_mark: | Current page number. | | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | | +| `results` | List[[shared.Company](../../models/shared/company.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/platform/docs/models/shared/company.md b/platform/docs/models/shared/company.md index c39e5742f..28b0d3df8 100644 --- a/platform/docs/models/shared/company.md +++ b/platform/docs/models/shared/company.md @@ -11,13 +11,13 @@ When you create a company, you can specify a `name` and we will automatically ge | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | *str* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `name` | *str* | :heavy_check_mark: | The name of the company | Codat Ltd. | +| `redirect` | *str* | :heavy_check_mark: | The `redirect` [Link URL](https://docs.codat.io/auth-flow/authorize-hosted-link) enabling the customer to start their auth flow journey for the company. | https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739 | | `created` | *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-23 00:00:00 +0000 UTC | | `created_by_user_name` | *Optional[str]* | :heavy_minus_sign: | Name of user that created the company in Codat. | | | `data_connections` | List[[shared.Connection](../../models/shared/connection.md)] | :heavy_minus_sign: | N/A | | | `description` | *Optional[str]* | :heavy_minus_sign: | Additional information about the company. This can be used to store foreign IDs, references, etc. | Requested early access to the new financing scheme. | | `groups` | List[[shared.GroupRef](../../models/shared/groupref.md)] | :heavy_minus_sign: | An array of groups the company has been assigned to. | | -| `id` | *str* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `last_sync` | *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-23 00:00:00 +0000 UTC | -| `name` | *str* | :heavy_check_mark: | The name of the company | Codat Ltd. | -| ~~`platform`~~ | *Optional[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

`platformKeys` name used when creating the company. | Xero | -| `redirect` | *str* | :heavy_check_mark: | The `redirect` [Link URL](https://docs.codat.io/auth-flow/authorize-hosted-link) enabling the customer to start their auth flow journey for the company. | https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739 | \ No newline at end of file +| ~~`platform`~~ | *Optional[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

`platformKeys` name used when creating the company. | Xero | \ No newline at end of file diff --git a/platform/docs/models/shared/companyrequestbody.md b/platform/docs/models/shared/companyrequestbody.md index 8bd4f49c0..a996dc2f2 100644 --- a/platform/docs/models/shared/companyrequestbody.md +++ b/platform/docs/models/shared/companyrequestbody.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | +| `name` | *str* | :heavy_check_mark: | Name of company being connected. | Bank of Dave | | `description` | *Optional[str]* | :heavy_minus_sign: | Additional information about the company. This can be used to store foreign IDs, references, etc. | Requested early access to the new financing scheme. | -| `groups` | List[[shared.GroupRef](../../models/shared/groupref.md)] | :heavy_minus_sign: | Reference to the groups that the company is assigned to. | | -| `name` | *str* | :heavy_check_mark: | Name of company being connected. | Bank of Dave | \ No newline at end of file +| `groups` | List[[shared.GroupRef](../../models/shared/groupref.md)] | :heavy_minus_sign: | Reference to the groups that the company is assigned to. | | \ No newline at end of file diff --git a/platform/docs/models/shared/connection.md b/platform/docs/models/shared/connection.md index b1a00bb0b..ea70426b5 100644 --- a/platform/docs/models/shared/connection.md +++ b/platform/docs/models/shared/connection.md @@ -16,16 +16,16 @@ Before you can use a data connection to pull or push data, the company must gran | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `additional_properties` | *Optional[Any]* | :heavy_minus_sign: | N/A | | -| `connection_info` | Dict[str, *str*] | :heavy_minus_sign: | N/A | | | `created` | *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-23 00:00:00 +0000 UTC | -| `data_connection_errors` | List[[shared.DataConnectionError](../../models/shared/dataconnectionerror.md)] | :heavy_minus_sign: | N/A | | | `id` | *str* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `integration_id` | *str* | :heavy_check_mark: | A Codat ID representing the integration. | fd321cb6-7963-4506-b873-e99593a45e30 | | `integration_key` | *str* | :heavy_check_mark: | A unique four-character ID that identifies the platform of the company's data connection. This ensures continuity if the platform changes its name in the future. | | -| `last_sync` | *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-23 00:00:00 +0000 UTC | | `link_url` | *str* | :heavy_check_mark: | The link URL your customers can use to authorize access to their business application. | https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/2e2eb431-c1fa-4dc9-93fa-d29781c12bcd/start | | `platform_name` | *str* | :heavy_check_mark: | Name of integration connected to company. | | | `source_id` | *str* | :heavy_check_mark: | A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, `sourceId` is associated with a specific bank and has a many-to-one relationship with the `integrationId`. | 35b92968-9851-4095-ad60-395c95cbcba4 | | `source_type` | [shared.SourceType](../../models/shared/sourcetype.md) | :heavy_check_mark: | The type of platform of the connection. | Accounting | -| `status` | [shared.DataConnectionStatus](../../models/shared/dataconnectionstatus.md) | :heavy_check_mark: | The current authorization status of the data connection. | | \ No newline at end of file +| `status` | [shared.DataConnectionStatus](../../models/shared/dataconnectionstatus.md) | :heavy_check_mark: | The current authorization status of the data connection. | | +| `additional_properties` | *Optional[Any]* | :heavy_minus_sign: | N/A | | +| `connection_info` | Dict[str, *str*] | :heavy_minus_sign: | N/A | | +| `data_connection_errors` | List[[shared.DataConnectionError](../../models/shared/dataconnectionerror.md)] | :heavy_minus_sign: | N/A | | +| `last_sync` | *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-23 00:00:00 +0000 UTC | \ No newline at end of file diff --git a/platform/docs/models/shared/connections.md b/platform/docs/models/shared/connections.md index 5a69d197d..b2e15bef0 100644 --- a/platform/docs/models/shared/connections.md +++ b/platform/docs/models/shared/connections.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | Current page number. | -| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | -| `results` | List[[shared.Connection](../../models/shared/connection.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | {"self":{"href":"/companies/{id}/data/{dataType}"},"current":{"href":"/companies/{id}/data/{dataType}?page=1&pageSize=10"}} | +| `page_number` | *int* | :heavy_check_mark: | Current page number. | | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | | +| `results` | List[[shared.Connection](../../models/shared/connection.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/platform/docs/models/shared/createrule.md b/platform/docs/models/shared/createrule.md index 09c88595a..509a878f9 100644 --- a/platform/docs/models/shared/createrule.md +++ b/platform/docs/models/shared/createrule.md @@ -7,6 +7,6 @@ Create an event notification to a URL or list of email addresses based on the gi | Field | Type | Required | Description | Example | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `company_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `notifiers` | [shared.WebhookNotifier](../../models/shared/webhooknotifier.md) | :heavy_check_mark: | N/A | | -| `type` | *str* | :heavy_check_mark: | The type of webhook. | | \ No newline at end of file +| `type` | *str* | :heavy_check_mark: | The type of webhook. | | +| `company_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/platform/docs/models/shared/datatypefeature.md b/platform/docs/models/shared/datatypefeature.md index 401fed407..eeb7b5ac7 100644 --- a/platform/docs/models/shared/datatypefeature.md +++ b/platform/docs/models/shared/datatypefeature.md @@ -7,5 +7,5 @@ Describes support for a given datatype and associated operations | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `data_type` | [Optional[shared.DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | -| `supported_features` | List[[shared.SupportedFeature](../../models/shared/supportedfeature.md)] | :heavy_check_mark: | N/A | | \ No newline at end of file +| `supported_features` | List[[shared.SupportedFeature](../../models/shared/supportedfeature.md)] | :heavy_check_mark: | N/A | | +| `data_type` | [Optional[shared.DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | \ No newline at end of file diff --git a/platform/docs/models/shared/errorvalidation.md b/platform/docs/models/shared/errorvalidation.md new file mode 100644 index 000000000..122badd9d --- /dev/null +++ b/platform/docs/models/shared/errorvalidation.md @@ -0,0 +1,11 @@ +# ErrorValidation + +A human-readable object describing validation decisions Codat has made. If an operation has failed because of validation errors, they will be detailed here. + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | +| `errors` | List[[shared.ErrorValidationItem](../../models/shared/errorvalidationitem.md)] | :heavy_minus_sign: | N/A | +| `warnings` | List[[shared.ErrorValidationItem](../../models/shared/errorvalidationitem.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/platform/docs/models/shared/errorvalidationitem.md b/platform/docs/models/shared/errorvalidationitem.md new file mode 100644 index 000000000..346bb51f1 --- /dev/null +++ b/platform/docs/models/shared/errorvalidationitem.md @@ -0,0 +1,10 @@ +# ErrorValidationItem + + +## Fields + +| Field | Type | Required | Description | +| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | +| `item_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for a validation item. | +| `message` | *Optional[str]* | :heavy_minus_sign: | A message outlining validation item's issue. | +| `validator_name` | *Optional[str]* | :heavy_minus_sign: | Name of validator. | \ No newline at end of file diff --git a/platform/docs/models/shared/integration.md b/platform/docs/models/shared/integration.md index 7bd072311..106b972e8 100644 --- a/platform/docs/models/shared/integration.md +++ b/platform/docs/models/shared/integration.md @@ -7,14 +7,14 @@ An integration that Codat supports | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `enabled` | *bool* | :heavy_check_mark: | Whether this integration is enabled for your customers to use. | | +| `key` | *str* | :heavy_check_mark: | A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys. | gbol | +| `logo_url` | *str* | :heavy_check_mark: | Static url for integration's logo. | | +| `name` | *str* | :heavy_check_mark: | Name of integration. | Xero | | `data_provided_by` | *Optional[str]* | :heavy_minus_sign: | The name of the data provider. | | | `datatype_features` | List[[shared.DataTypeFeature](../../models/shared/datatypefeature.md)] | :heavy_minus_sign: | N/A | | -| `enabled` | *bool* | :heavy_check_mark: | Whether this integration is enabled for your customers to use. | | | `integration_id` | *Optional[str]* | :heavy_minus_sign: | A Codat ID representing the integration. | fd321cb6-7963-4506-b873-e99593a45e30 | | `is_beta` | *Optional[bool]* | :heavy_minus_sign: | `True` if the integration is currently in beta release. | | | `is_offline_connector` | *Optional[bool]* | :heavy_minus_sign: | `True` if the integration is to an application installed and run locally on an SMBs computer. | | -| `key` | *str* | :heavy_check_mark: | A unique 4-letter key to represent a platform in each integration. View [accounting](https://docs.codat.io/integrations/accounting/overview#platform-keys), [banking](https://docs.codat.io/integrations/banking/overview#platform-keys), and [commerce](https://docs.codat.io/integrations/commerce/overview#platform-keys) platform keys. | gbol | -| `logo_url` | *str* | :heavy_check_mark: | Static url for integration's logo. | | -| `name` | *str* | :heavy_check_mark: | Name of integration. | Xero | | `source_id` | *Optional[str]* | :heavy_minus_sign: | A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, `sourceId` is associated with a specific bank and has a many-to-one relationship with the `integrationId`. | 35b92968-9851-4095-ad60-395c95cbcba4 | | `source_type` | [Optional[shared.SourceType]](../../models/shared/sourcetype.md) | :heavy_minus_sign: | The type of platform of the connection. | Accounting | \ No newline at end of file diff --git a/platform/docs/models/shared/integrations.md b/platform/docs/models/shared/integrations.md index b7728cf75..28ecd4e72 100644 --- a/platform/docs/models/shared/integrations.md +++ b/platform/docs/models/shared/integrations.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | Current page number. | -| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | -| `results` | List[[shared.Integration](../../models/shared/integration.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | {"self":{"href":"/companies/{id}/data/{dataType}"},"current":{"href":"/companies/{id}/data/{dataType}?page=1&pageSize=10"}} | +| `page_number` | *int* | :heavy_check_mark: | Current page number. | | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | | +| `results` | List[[shared.Integration](../../models/shared/integration.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/platform/docs/models/shared/links.md b/platform/docs/models/shared/links.md index 5f80d2652..bfd552f9a 100644 --- a/platform/docs/models/shared/links.md +++ b/platform/docs/models/shared/links.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | | `current` | [shared.HalRef](../../models/shared/halref.md) | :heavy_check_mark: | N/A | +| `self_` | [shared.HalRef](../../models/shared/halref.md) | :heavy_check_mark: | N/A | | `next` | [Optional[shared.HalRef]](../../models/shared/halref.md) | :heavy_minus_sign: | N/A | -| `previous` | [Optional[shared.HalRef]](../../models/shared/halref.md) | :heavy_minus_sign: | N/A | -| `self_` | [shared.HalRef](../../models/shared/halref.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `previous` | [Optional[shared.HalRef]](../../models/shared/halref.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/platform/docs/models/shared/profile.md b/platform/docs/models/shared/profile.md index 21c46b6c3..7f345a958 100644 --- a/platform/docs/models/shared/profile.md +++ b/platform/docs/models/shared/profile.md @@ -7,11 +7,11 @@ Describes your Codat client instance | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `name` | *str* | :heavy_check_mark: | The name given to the instance. | Bob's Burgers | +| `redirect_url` | *str* | :heavy_check_mark: | The redirect URL pasted on to the SMB once Codat's [Hosted Link](https://docs.codat.io/auth-flow/authorize-hosted-link) has been completed by the SMB. | https://bobs-burgers.{countrySuffix}/{companyId} | | `alert_auth_header` | *Optional[str]* | :heavy_minus_sign: | Alert or webhooks authorization header. | Bearer tXEiHiRK7XCtI8TNHbpGs1LI1pumdb4Cl1QIo7B2 | | ~~`api_key`~~ | *Optional[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The API key for this Codat instance. | sartANTjHAkLdbyDfaynoTQb7pkmj6hXHmnQKMrB | | ~~`confirm_company_name`~~ | *Optional[bool]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

`True` if the company name has been confirmed. | | | `icon_url` | *Optional[str]* | :heavy_minus_sign: | Static url to your organization's icon. | https://client-images.codat.io/icon/042399f5-d104-4f38-9ce8-cac3524f4e88_3f5623af-d992-4c22-bc08-e58c520a8526.ico | | `logo_url` | *Optional[str]* | :heavy_minus_sign: | Static url to your organization's logo. | https://client-images.codat.io/logo/042399f5-d104-4f38-9ce8-cac3524f4e88_5806cb1f-7342-4c0e-a0a8-99bfbc47b0ff.png | -| `name` | *str* | :heavy_check_mark: | The name given to the instance. | Bob's Burgers | -| `redirect_url` | *str* | :heavy_check_mark: | The redirect URL pasted on to the SMB once Codat's [Hosted Link](https://docs.codat.io/auth-flow/authorize-hosted-link) has been completed by the SMB. | https://bobs-burgers.{countrySuffix}/{companyId} | | `white_list_urls` | List[*str*] | :heavy_minus_sign: | A list of urls that are allowed to communicate with Codat. If empty any url is allowed to communicate with Codat. | | \ No newline at end of file diff --git a/platform/docs/models/shared/pulloperation.md b/platform/docs/models/shared/pulloperation.md index 629e645ab..8bcdf5d2b 100644 --- a/platform/docs/models/shared/pulloperation.md +++ b/platform/docs/models/shared/pulloperation.md @@ -9,14 +9,14 @@ Information about a queued, in progress or completed pull operation. | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `company_id` | *str* | :heavy_check_mark: | Unique identifier of the company associated to this pull operation. | 22ece347-e5f6-4896-95e0-35a4c7f17023 | -| `completed` | *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-23 00:00:00 +0000 UTC | | `connection_id` | *str* | :heavy_check_mark: | Unique identifier of the connection associated to this pull operation. | 50830828-7d39-4367-b0eb-5ddb2de5faa5 | | `data_type` | *str* | :heavy_check_mark: | The data type you are requesting in a pull operation. | | -| `error_message` | *Optional[str]* | :heavy_minus_sign: | A message about a transient or persistent error. | | | `id` | *str* | :heavy_check_mark: | Unique identifier of the pull operation. | 943accd0-4247-42d8-865b-363c8629e1da | | `is_completed` | *bool* | :heavy_check_mark: | `True` if the pull operation is completed successfully. The `isCompleted` property is not queryable. To filter failed pull operations, query by `status!=Complete&&status!=NotSupported` instead. | | | `is_errored` | *bool* | :heavy_check_mark: | `True` if the pull operation entered an error state. | | | `progress` | *int* | :heavy_check_mark: | An integer signifying the progress of the pull operation. | | | `requested` | *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-23 00:00:00 +0000 UTC | | `status` | [shared.Status](../../models/shared/status.md) | :heavy_check_mark: | The current status of the pull operation. | Complete | +| `completed` | *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-23 00:00:00 +0000 UTC | +| `error_message` | *Optional[str]* | :heavy_minus_sign: | A message about a transient or persistent error. | | | `status_description` | *Optional[str]* | :heavy_minus_sign: | Additional information about the dataset status. | Paused until 2022-10-23T00:00:00.000Z | \ No newline at end of file diff --git a/platform/docs/models/shared/pulloperations.md b/platform/docs/models/shared/pulloperations.md index bc8a8c451..75bc96de7 100644 --- a/platform/docs/models/shared/pulloperations.md +++ b/platform/docs/models/shared/pulloperations.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | Current page number. | -| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | -| `results` | List[[shared.PullOperation](../../models/shared/pulloperation.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | {"self":{"href":"/companies/{id}/data/{dataType}"},"current":{"href":"/companies/{id}/data/{dataType}?page=1&pageSize=10"}} | +| `page_number` | *int* | :heavy_check_mark: | Current page number. | | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | | +| `results` | List[[shared.PullOperation](../../models/shared/pulloperation.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/platform/docs/models/shared/pushoperation.md b/platform/docs/models/shared/pushoperation.md index 4dd49b0f0..8ceefbf7f 100644 --- a/platform/docs/models/shared/pushoperation.md +++ b/platform/docs/models/shared/pushoperation.md @@ -5,16 +5,16 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `changes` | List[[shared.PushOperationChange](../../models/shared/pushoperationchange.md)] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | | `company_id` | *str* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `completed_on_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-23 00:00:00 +0000 UTC | | `data_connection_key` | *str* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `data_type` | [Optional[shared.DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | -| `error_message` | *Optional[str]* | :heavy_minus_sign: | A message about the error. | | | `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-23 00:00:00 +0000 UTC | | `status` | [shared.PushOperationStatus](../../models/shared/pushoperationstatus.md) | :heavy_check_mark: | The current status of the push operation. | | | `status_code` | *int* | :heavy_check_mark: | Push status code. | | +| `changes` | List[[shared.PushOperationChange](../../models/shared/pushoperationchange.md)] | :heavy_minus_sign: | Contains a single entry that communicates which record has changed and the manner in which it changed. | | +| `completed_on_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-23 00:00:00 +0000 UTC | +| `data_type` | [Optional[shared.DataType]](../../models/shared/datatype.md) | :heavy_minus_sign: | Available Data types | invoices | +| `error_message` | *Optional[str]* | :heavy_minus_sign: | A message about the error. | | | `timeout_in_minutes` | *Optional[int]* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | | ~~`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.

Number of seconds the push operation must complete within before it times out. | | | `validation` | [Optional[shared.Validation]](../../models/shared/validation.md) | :heavy_minus_sign: | A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here. | | \ No newline at end of file diff --git a/platform/docs/models/shared/pushoperations.md b/platform/docs/models/shared/pushoperations.md index be6e80331..fbdf79507 100644 --- a/platform/docs/models/shared/pushoperations.md +++ b/platform/docs/models/shared/pushoperations.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | Current page number. | -| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | -| `results` | List[[shared.PushOperation](../../models/shared/pushoperation.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | {"self":{"href":"/companies/{id}/data/{dataType}"},"current":{"href":"/companies/{id}/data/{dataType}?page=1&pageSize=10"}} | +| `page_number` | *int* | :heavy_check_mark: | Current page number. | | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | | +| `results` | List[[shared.PushOperation](../../models/shared/pushoperation.md)] | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/platform/docs/models/shared/pushoption.md b/platform/docs/models/shared/pushoption.md index e908d0b28..a41fbc063 100644 --- a/platform/docs/models/shared/pushoption.md +++ b/platform/docs/models/shared/pushoption.md @@ -5,10 +5,10 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `description` | *Optional[str]* | :heavy_minus_sign: | A description of the property. | | `display_name` | *str* | :heavy_check_mark: | The property's display name. | -| `options` | List[[shared.PushOptionChoice](../../models/shared/pushoptionchoice.md)] | :heavy_minus_sign: | N/A | -| `properties` | Dict[str, [shared.PushOptionProperty](../../models/shared/pushoptionproperty.md)] | :heavy_minus_sign: | N/A | | `required` | *bool* | :heavy_check_mark: | The property is required if `True`. | | `type` | [shared.PushOptionType](../../models/shared/pushoptiontype.md) | :heavy_check_mark: | The option type. | +| `description` | *Optional[str]* | :heavy_minus_sign: | A description of the property. | +| `options` | List[[shared.PushOptionChoice](../../models/shared/pushoptionchoice.md)] | :heavy_minus_sign: | N/A | +| `properties` | Dict[str, [shared.PushOptionProperty](../../models/shared/pushoptionproperty.md)] | :heavy_minus_sign: | N/A | | `validation` | [Optional[shared.PushValidationInfo]](../../models/shared/pushvalidationinfo.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/platform/docs/models/shared/pushoptionproperty.md b/platform/docs/models/shared/pushoptionproperty.md index 2bedd19d3..cb20b30fe 100644 --- a/platform/docs/models/shared/pushoptionproperty.md +++ b/platform/docs/models/shared/pushoptionproperty.md @@ -7,8 +7,8 @@ | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | | `description` | *str* | :heavy_check_mark: | A description of the property. | | `display_name` | *str* | :heavy_check_mark: | The property's display name. | -| `options` | List[[shared.PushOptionChoice](../../models/shared/pushoptionchoice.md)] | :heavy_minus_sign: | N/A | -| `properties` | Dict[str, [shared.PushOptionProperty](../../models/shared/pushoptionproperty.md)] | :heavy_minus_sign: | N/A | | `required` | *bool* | :heavy_check_mark: | The property is required if `True`. | | `type` | [shared.PushOptionType](../../models/shared/pushoptiontype.md) | :heavy_check_mark: | The option type. | +| `options` | List[[shared.PushOptionChoice](../../models/shared/pushoptionchoice.md)] | :heavy_minus_sign: | N/A | +| `properties` | Dict[str, [shared.PushOptionProperty](../../models/shared/pushoptionproperty.md)] | :heavy_minus_sign: | N/A | | `validation` | [Optional[shared.PushValidationInfo]](../../models/shared/pushvalidationinfo.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/platform/docs/models/shared/syncsetting.md b/platform/docs/models/shared/syncsetting.md index 9d5cbae80..77c3b3dba 100644 --- a/platform/docs/models/shared/syncsetting.md +++ b/platform/docs/models/shared/syncsetting.md @@ -9,9 +9,9 @@ Describes how often, and how much history, should be fetched for the given data | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `data_type` | [shared.DataType](../../models/shared/datatype.md) | :heavy_check_mark: | Available Data types | invoices | | `fetch_on_first_link` | *bool* | :heavy_check_mark: | Whether this data type should be queued after a company has authorized a connection. | | +| `sync_order` | *int* | :heavy_check_mark: | The sync in which data types are queued for a sync. | | +| `sync_schedule` | *int* | :heavy_check_mark: | Number of hours after which this data type should be refreshed. | 24 | | `is_locked` | *Optional[bool]* | :heavy_minus_sign: | `True` if the [sync setting](https://docs.codat.io/knowledge-base/advanced-sync-settings) is locked. | | | `months_to_sync` | *Optional[int]* | :heavy_minus_sign: | Months of data to fetch, for report data types (`balanceSheet` & `profitAndLoss`) only. | 24 | | `sync_from_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-23 00:00:00 +0000 UTC | -| `sync_from_window` | *Optional[int]* | :heavy_minus_sign: | Number of months of data to be fetched. Set this *or* `syncFromUTC`. | 24 | -| `sync_order` | *int* | :heavy_check_mark: | The sync in which data types are queued for a sync. | | -| `sync_schedule` | *int* | :heavy_check_mark: | Number of hours after which this data type should be refreshed. | 24 | \ No newline at end of file +| `sync_from_window` | *Optional[int]* | :heavy_minus_sign: | Number of months of data to be fetched. Set this *or* `syncFromUTC`. | 24 | \ No newline at end of file diff --git a/platform/docs/models/shared/webhook.md b/platform/docs/models/shared/webhook.md index cb44f637e..dd3876089 100644 --- a/platform/docs/models/shared/webhook.md +++ b/platform/docs/models/shared/webhook.md @@ -7,7 +7,7 @@ Configuration to provide an event notification to a URL or list of email address | Field | Type | Required | Description | Example | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | -| `company_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the configured notification. | ff89c50e-a719-4ef5-a182-9917e53927b6 | | `notifiers` | [shared.WebhookNotifier](../../models/shared/webhooknotifier.md) | :heavy_check_mark: | N/A | | -| `type` | *str* | :heavy_check_mark: | The type of webhook. | | \ No newline at end of file +| `type` | *str* | :heavy_check_mark: | The type of webhook. | | +| `company_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier for the configured notification. | ff89c50e-a719-4ef5-a182-9917e53927b6 | \ No newline at end of file diff --git a/platform/docs/models/shared/webhooks.md b/platform/docs/models/shared/webhooks.md index 883d34dee..c473b0026 100644 --- a/platform/docs/models/shared/webhooks.md +++ b/platform/docs/models/shared/webhooks.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | -| `page_number` | *int* | :heavy_check_mark: | Current page number. | -| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | -| `results` | List[[shared.Webhook](../../models/shared/webhook.md)] | :heavy_minus_sign: | N/A | -| `total_results` | *int* | :heavy_check_mark: | Total number of items. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | +| `links` | [shared.Links](../../models/shared/links.md) | :heavy_check_mark: | N/A | {"self":{"href":"/companies/{id}/data/{dataType}"},"current":{"href":"/companies/{id}/data/{dataType}?page=1&pageSize=10"}} | +| `page_number` | *int* | :heavy_check_mark: | Current page number. | | +| `page_size` | *int* | :heavy_check_mark: | Number of items to return in results array. | | +| `total_results` | *int* | :heavy_check_mark: | Total number of items. | | +| `results` | List[[shared.Webhook](../../models/shared/webhook.md)] | :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 dcf998a80..166806cc9 100644 --- a/platform/docs/sdks/companies/README.md +++ b/platform/docs/sdks/companies/README.md @@ -35,13 +35,8 @@ s = codatplatform.CodatPlatform( ) req = shared.CompanyRequestBody( - description='Requested early access to the new financing scheme.', - groups=[ - shared.GroupRef( - id='60d2fa12-8a04-11ee-b9d1-0242ac120002', - ), - ], name='Bank of Dave', + description='Requested early access to the new financing scheme.', ) res = s.companies.create(req) @@ -238,15 +233,6 @@ s = codatplatform.CodatPlatform( ) req = operations.UpdateCompanyRequest( - company_request_body=shared.CompanyRequestBody( - description='Requested early access to the new financing scheme.', - groups=[ - shared.GroupRef( - id='60d2fa12-8a04-11ee-b9d1-0242ac120002', - ), - ], - name='Bank of Dave', - ), company_id='8a210b68-6988-11ed-a1eb-0242ac120002', ) diff --git a/platform/docs/sdks/connections/README.md b/platform/docs/sdks/connections/README.md index 16dab68bc..83038f9d0 100644 --- a/platform/docs/sdks/connections/README.md +++ b/platform/docs/sdks/connections/README.md @@ -33,9 +33,6 @@ s = codatplatform.CodatPlatform( ) req = operations.CreateConnectionRequest( - request_body=operations.CreateConnectionRequestBody( - platform_key='gbol', - ), company_id='8a210b68-6988-11ed-a1eb-0242ac120002', ) @@ -222,7 +219,6 @@ s = codatplatform.CodatPlatform( ) req = operations.UnlinkConnectionRequest( - update_connection_status=shared.UpdateConnectionStatus(), company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', ) @@ -269,9 +265,6 @@ s = codatplatform.CodatPlatform( ) req = operations.UpdateConnectionAuthorizationRequest( - request_body={ - 'key': 'string', - }, company_id='8a210b68-6988-11ed-a1eb-0242ac120002', connection_id='2e9d2c44-f675-40ba-8049-353bfcb5e171', ) diff --git a/platform/docs/sdks/customdatatype/README.md b/platform/docs/sdks/customdatatype/README.md index e046ac09e..98ca7fc47 100644 --- a/platform/docs/sdks/customdatatype/README.md +++ b/platform/docs/sdks/customdatatype/README.md @@ -39,19 +39,26 @@ s = codatplatform.CodatPlatform( ) req = operations.ConfigureCustomDataTypeRequest( + custom_data_identifier='DynamicsPurchaseOrders', + platform_key='gbol', custom_data_type_configuration=shared.CustomDataTypeConfiguration( + data_source='api/purchaseOrders?$filter=currencyCode eq \'NOK\'', key_by=[ - 'string', + '$[*].id', ], required_data={ - 'key': 'string', + 'currencyCode': '$[*].currencyCode', + 'id': '$[*].id', + 'number': '$[*].number', + 'orderDate': '$[*].orderDate', + 'totalAmountExcludingTax': '$[*].totalAmountExcludingTax', + 'totalTaxAmount': '$[*].totalTaxAmount', + 'vendorName': '$[*].number', }, source_modified_date=[ - 'string', + '$[*].lastModifiedDateTime', ], ), - custom_data_identifier='DynamicsPurchaseOrders', - platform_key='gbol', ) res = s.custom_data_type.configure(req) diff --git a/platform/docs/sdks/groups/README.md b/platform/docs/sdks/groups/README.md index 594815f8f..52c56bc60 100644 --- a/platform/docs/sdks/groups/README.md +++ b/platform/docs/sdks/groups/README.md @@ -31,9 +31,6 @@ s = codatplatform.CodatPlatform( ) req = operations.AddCompanyToGroupRequest( - company_group_assignment=shared.CompanyGroupAssignment( - group_id='60d2fa12-8a04-11ee-b9d1-0242ac120002', - ), company_id='8a210b68-6988-11ed-a1eb-0242ac120002', ) diff --git a/platform/docs/sdks/settings/README.md b/platform/docs/sdks/settings/README.md index 1e7405975..71a069c13 100644 --- a/platform/docs/sdks/settings/README.md +++ b/platform/docs/sdks/settings/README.md @@ -268,14 +268,16 @@ s = codatplatform.CodatPlatform( ) req = shared.Profile( + name='Bob\'s Burgers', + redirect_url='https://bobs-burgers.{countrySuffix}/{companyId}', alert_auth_header='Bearer tXEiHiRK7XCtI8TNHbpGs1LI1pumdb4Cl1QIo7B2', api_key='sartANTjHAkLdbyDfaynoTQb7pkmj6hXHmnQKMrB', + confirm_company_name=True, icon_url='https://client-images.codat.io/icon/042399f5-d104-4f38-9ce8-cac3524f4e88_3f5623af-d992-4c22-bc08-e58c520a8526.ico', logo_url='https://client-images.codat.io/logo/042399f5-d104-4f38-9ce8-cac3524f4e88_5806cb1f-7342-4c0e-a0a8-99bfbc47b0ff.png', - name='Bob\'s Burgers', - redirect_url='https://bobs-burgers.{countrySuffix}/{companyId}', white_list_urls=[ 'https://bobs-burgers.com', + 'https://bobs-burgers.co.uk', ], ) @@ -325,12 +327,13 @@ req = operations.UpdateProfileSyncSettingsRequestBody( settings=[ shared.SyncSetting( data_type=shared.DataType.INVOICES, - fetch_on_first_link=False, + fetch_on_first_link=True, + sync_order=0, + sync_schedule=24, + is_locked=True, months_to_sync=24, - sync_from_utc='2022-10-23T00:00:00Z', + sync_from_utc='2020-01-01T12:00:00.000Z', sync_from_window=24, - sync_order=334238, - sync_schedule=24, ), ], ) diff --git a/platform/docs/sdks/supplementaldata/README.md b/platform/docs/sdks/supplementaldata/README.md index b30f63a31..822c6c76f 100644 --- a/platform/docs/sdks/supplementaldata/README.md +++ b/platform/docs/sdks/supplementaldata/README.md @@ -32,20 +32,21 @@ s = codatplatform.CodatPlatform( ) req = operations.ConfigureSupplementalDataRequest( + data_type=operations.DataType.INVOICES, + platform_key='gbol', supplemental_data_configuration=shared.SupplementalDataConfiguration( supplemental_data_config={ - 'key': shared.SupplementalDataSourceConfiguration( + 'orders-supplemental-data': shared.SupplementalDataSourceConfiguration( + data_source='/orders', pull_data={ - 'key': 'string', + 'orderNumber': 'order_num', }, push_data={ - 'key': 'string', + 'orderNumber': 'order_num', }, ), }, ), - data_type=operations.DataType.INVOICES, - platform_key='gbol', ) res = s.supplemental_data.configure(req) diff --git a/platform/docs/sdks/webhooks/README.md b/platform/docs/sdks/webhooks/README.md index 8de14717f..2684faafc 100644 --- a/platform/docs/sdks/webhooks/README.md +++ b/platform/docs/sdks/webhooks/README.md @@ -28,14 +28,14 @@ s = codatplatform.CodatPlatform( ) req = shared.CreateRule( - company_id='8a210b68-6988-11ed-a1eb-0242ac120002', notifiers=shared.WebhookNotifier( emails=[ 'info@client.com', ], webhook='https://webhook.client.com', ), - type='string', + type='DataConnectionStatusChanged', + company_id='39b73b17-cc2e-429e-915d-71654e9dcd1e', ) res = s.webhooks.create(req) diff --git a/platform/gen.yaml b/platform/gen.yaml index 507106efb..8d67052a7 100644 --- a/platform/gen.yaml +++ b/platform/gen.yaml @@ -1,34 +1,18 @@ -configVersion: 1.0.0 -management: - docChecksum: 1573d3af37949ec5c2ba8ed38e783946 - docVersion: 3.0.0 - speakeasyVersion: 1.128.1 - generationVersion: 2.223.0 +configVersion: 2.0.0 generation: - comments: {} sdkClassName: CodatPlatform - repoURL: https://github.com/codatio/client-sdk-python.git usageSnippets: optionalPropertyRendering: withExample fixes: nameResolutionDec2023: false + parameterOrderingFeb2024: false + requestResponseComponentNamesFeb2024: false telemetryEnabled: true -features: - python: - core: 4.3.1 - deprecations: 2.81.1 - examples: 2.81.3 - globalSecurity: 2.83.1 - globalServerURLs: 2.82.1 - inputOutputModels: 2.83.0 - nameOverrides: 2.81.1 - retries: 2.82.0 python: - version: 3.2.0 + version: 3.3.0 author: Codat clientServerStatusCodesAsErrors: true - description: Manage the building blocks of Codat, including companies, connections, - and more. + description: Manage the building blocks of Codat, including companies, connections, and more. flattenGlobalSecurity: false imports: option: openapi @@ -39,9 +23,6 @@ python: shared: models/shared webhooks: models/webhooks inputModelSuffix: input - installationURL: https://github.com/codatio/client-sdk-python.git#subdirectory=platform maxMethodParams: 0 outputModelSuffix: output packageName: codat-platform - published: true - repoSubDirectory: platform diff --git a/platform/pylintrc b/platform/pylintrc index 1ed32214e..cebe76d49 100644 --- a/platform/pylintrc +++ b/platform/pylintrc @@ -440,7 +440,8 @@ disable=raw-checker-failed, cyclic-import, too-many-nested-blocks, too-many-boolean-expressions, - no-else-raise + no-else-raise, + bare-except # Enable the message, report, category or checker with the given id(s). You can # either give multiple identifier separated by comma (,) or put this option diff --git a/platform/setup.py b/platform/setup.py index 541aa323b..2002c6980 100644 --- a/platform/setup.py +++ b/platform/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="codat-platform", - version="3.2.0", + version="3.3.0", author="Codat", description="Manage the building blocks of Codat, including companies, connections, and more.", long_description=long_description, @@ -19,7 +19,7 @@ install_requires=[ "certifi>=2023.7.22", "charset-normalizer>=3.2.0", - "dataclasses-json>=0.6.1", + "dataclasses-json-speakeasy>=0.5.11", "idna>=3.4", "jsonpath-python>=1.0.6 ", "marshmallow>=3.19.0", @@ -36,5 +36,6 @@ "dev":["pylint==2.16.2"] }, package_dir={'': 'src'}, - python_requires='>=3.8' + python_requires='>=3.8', + package_data={"codat-platform": ["py.typed"]}, ) diff --git a/platform/src/codatplatform/models/errors/errormessage.py b/platform/src/codatplatform/models/errors/errormessage.py index 0a44ee38d..0b366e95a 100644 --- a/platform/src/codatplatform/models/errors/errormessage.py +++ b/platform/src/codatplatform/models/errors/errormessage.py @@ -2,6 +2,7 @@ from __future__ import annotations import dataclasses +from ...models.shared import errorvalidation as shared_errorvalidation from codatplatform import utils from dataclasses_json import Undefined, dataclass_json from typing import Optional @@ -12,6 +13,7 @@ @dataclasses.dataclass class ErrorMessage(Exception): r"""Bad Request""" + UNSET='__SPEAKEASY_UNSET__' can_be_retried: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('canBeRetried'), 'exclude': lambda f: f is None }}) r"""`True` if the error occurred transiently and can be retried.""" correlation_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('correlationId'), 'exclude': lambda f: f is None }}) @@ -24,6 +26,8 @@ class ErrorMessage(Exception): r"""Codat's service the returned the error.""" status_code: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusCode'), 'exclude': lambda f: f is None }}) r"""The HTTP status code returned by the error.""" + validation: Optional[shared_errorvalidation.ErrorValidation] = dataclasses.field(default=UNSET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validation'), 'exclude': lambda f: f is ErrorMessage.UNSET }}) + r"""A human-readable object describing validation decisions Codat has made. If an operation has failed because of validation errors, they will be detailed here.""" def __str__(self) -> str: diff --git a/platform/src/codatplatform/models/operations/add_company_to_group.py b/platform/src/codatplatform/models/operations/add_company_to_group.py index 8f69617f9..f7afeabc6 100644 --- a/platform/src/codatplatform/models/operations/add_company_to_group.py +++ b/platform/src/codatplatform/models/operations/add_company_to_group.py @@ -21,10 +21,10 @@ class AddCompanyToGroupRequest: class AddCompanyToGroupResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" company: Optional[shared_company.Company] = dataclasses.field(default=None) r"""Success""" diff --git a/platform/src/codatplatform/models/operations/configure_custom_data_type.py b/platform/src/codatplatform/models/operations/configure_custom_data_type.py index dab4441c2..65b0390dc 100644 --- a/platform/src/codatplatform/models/operations/configure_custom_data_type.py +++ b/platform/src/codatplatform/models/operations/configure_custom_data_type.py @@ -23,10 +23,10 @@ class ConfigureCustomDataTypeRequest: class ConfigureCustomDataTypeResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" custom_data_type_configuration: Optional[shared_customdatatypeconfiguration.CustomDataTypeConfiguration] = dataclasses.field(default=None) r"""OK""" diff --git a/platform/src/codatplatform/models/operations/configure_supplemental_data.py b/platform/src/codatplatform/models/operations/configure_supplemental_data.py index dee7b1287..2d4bec2c1 100644 --- a/platform/src/codatplatform/models/operations/configure_supplemental_data.py +++ b/platform/src/codatplatform/models/operations/configure_supplemental_data.py @@ -48,9 +48,9 @@ class ConfigureSupplementalDataRequest: class ConfigureSupplementalDataResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/platform/src/codatplatform/models/operations/create_api_key.py b/platform/src/codatplatform/models/operations/create_api_key.py index eb15c6cc6..61b1ac8c4 100644 --- a/platform/src/codatplatform/models/operations/create_api_key.py +++ b/platform/src/codatplatform/models/operations/create_api_key.py @@ -9,13 +9,14 @@ @dataclasses.dataclass class CreateAPIKeyResponse: + UNSET='__SPEAKEASY_UNSET__' content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" - api_key_details: Optional[shared_apikeydetails.APIKeyDetails] = dataclasses.field(default=None) + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" + api_key_details: Optional[shared_apikeydetails.APIKeyDetails] = dataclasses.field(default=UNSET) r"""Success""" diff --git a/platform/src/codatplatform/models/operations/create_company.py b/platform/src/codatplatform/models/operations/create_company.py index 6d6514892..d7751fcaf 100644 --- a/platform/src/codatplatform/models/operations/create_company.py +++ b/platform/src/codatplatform/models/operations/create_company.py @@ -11,10 +11,10 @@ class CreateCompanyResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" company: Optional[shared_company.Company] = dataclasses.field(default=None) r"""OK""" diff --git a/platform/src/codatplatform/models/operations/create_connection.py b/platform/src/codatplatform/models/operations/create_connection.py index 79aa9039a..6ba75073c 100644 --- a/platform/src/codatplatform/models/operations/create_connection.py +++ b/platform/src/codatplatform/models/operations/create_connection.py @@ -31,10 +31,10 @@ class CreateConnectionRequest: class CreateConnectionResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" connection: Optional[shared_connection.Connection] = dataclasses.field(default=None) r"""OK""" diff --git a/platform/src/codatplatform/models/operations/create_group.py b/platform/src/codatplatform/models/operations/create_group.py index fde635e30..2c1e17fc8 100644 --- a/platform/src/codatplatform/models/operations/create_group.py +++ b/platform/src/codatplatform/models/operations/create_group.py @@ -11,10 +11,10 @@ class CreateGroupResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" group: Optional[shared_group.Group] = dataclasses.field(default=None) r"""Success""" diff --git a/platform/src/codatplatform/models/operations/create_rule.py b/platform/src/codatplatform/models/operations/create_rule.py index 5db21c3db..46680583b 100644 --- a/platform/src/codatplatform/models/operations/create_rule.py +++ b/platform/src/codatplatform/models/operations/create_rule.py @@ -11,10 +11,10 @@ class CreateRuleResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" webhook: Optional[shared_webhook.Webhook] = dataclasses.field(default=None) r"""OK""" diff --git a/platform/src/codatplatform/models/operations/delete_api_key.py b/platform/src/codatplatform/models/operations/delete_api_key.py index 8edaa659f..549593296 100644 --- a/platform/src/codatplatform/models/operations/delete_api_key.py +++ b/platform/src/codatplatform/models/operations/delete_api_key.py @@ -19,10 +19,10 @@ class DeleteAPIKeyRequest: class DeleteAPIKeyResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" error_message: Optional[errors_errormessage.ErrorMessage] = dataclasses.field(default=None) r"""Too many requests were made in a given amount of time. Wait a short period and then try again.""" diff --git a/platform/src/codatplatform/models/operations/delete_company.py b/platform/src/codatplatform/models/operations/delete_company.py index cee215d50..e544df054 100644 --- a/platform/src/codatplatform/models/operations/delete_company.py +++ b/platform/src/codatplatform/models/operations/delete_company.py @@ -17,9 +17,9 @@ class DeleteCompanyRequest: class DeleteCompanyResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/platform/src/codatplatform/models/operations/delete_connection.py b/platform/src/codatplatform/models/operations/delete_connection.py index f6c98ce2b..f6a77abb5 100644 --- a/platform/src/codatplatform/models/operations/delete_connection.py +++ b/platform/src/codatplatform/models/operations/delete_connection.py @@ -19,9 +19,9 @@ class DeleteConnectionRequest: class DeleteConnectionResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/platform/src/codatplatform/models/operations/get_company.py b/platform/src/codatplatform/models/operations/get_company.py index 2938755e5..65e6aba22 100644 --- a/platform/src/codatplatform/models/operations/get_company.py +++ b/platform/src/codatplatform/models/operations/get_company.py @@ -19,10 +19,10 @@ class GetCompanyRequest: class GetCompanyResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" company: Optional[shared_company.Company] = dataclasses.field(default=None) r"""OK""" diff --git a/platform/src/codatplatform/models/operations/get_company_data_status.py b/platform/src/codatplatform/models/operations/get_company_data_status.py index 2a604f0be..42d6e8b25 100644 --- a/platform/src/codatplatform/models/operations/get_company_data_status.py +++ b/platform/src/codatplatform/models/operations/get_company_data_status.py @@ -19,10 +19,10 @@ class GetCompanyDataStatusRequest: class GetCompanyDataStatusResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" data_statuses: Optional[Dict[str, shared_datastatus.DataStatus]] = dataclasses.field(default=None) r"""OK""" diff --git a/platform/src/codatplatform/models/operations/get_company_push_history.py b/platform/src/codatplatform/models/operations/get_company_push_history.py index dfc84fc78..200cb98b4 100644 --- a/platform/src/codatplatform/models/operations/get_company_push_history.py +++ b/platform/src/codatplatform/models/operations/get_company_push_history.py @@ -27,10 +27,10 @@ class GetCompanyPushHistoryRequest: class GetCompanyPushHistoryResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" push_operations: Optional[shared_pushoperations.PushOperations] = dataclasses.field(default=None) r"""OK""" diff --git a/platform/src/codatplatform/models/operations/get_connection.py b/platform/src/codatplatform/models/operations/get_connection.py index 80642dd26..083a24ed2 100644 --- a/platform/src/codatplatform/models/operations/get_connection.py +++ b/platform/src/codatplatform/models/operations/get_connection.py @@ -21,10 +21,10 @@ class GetConnectionRequest: class GetConnectionResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" connection: Optional[shared_connection.Connection] = dataclasses.field(default=None) r"""OK""" diff --git a/platform/src/codatplatform/models/operations/get_create_update_model_options_by_data_type.py b/platform/src/codatplatform/models/operations/get_create_update_model_options_by_data_type.py index 72d0364c7..17d9abdcb 100644 --- a/platform/src/codatplatform/models/operations/get_create_update_model_options_by_data_type.py +++ b/platform/src/codatplatform/models/operations/get_create_update_model_options_by_data_type.py @@ -24,10 +24,10 @@ class GetCreateUpdateModelOptionsByDataTypeRequest: class GetCreateUpdateModelOptionsByDataTypeResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" push_option: Optional[shared_pushoption.PushOption] = dataclasses.field(default=None) r"""OK""" diff --git a/platform/src/codatplatform/models/operations/get_custom_data_type_configuration.py b/platform/src/codatplatform/models/operations/get_custom_data_type_configuration.py index 2ffff114a..85628ad02 100644 --- a/platform/src/codatplatform/models/operations/get_custom_data_type_configuration.py +++ b/platform/src/codatplatform/models/operations/get_custom_data_type_configuration.py @@ -21,10 +21,10 @@ class GetCustomDataTypeConfigurationRequest: class GetCustomDataTypeConfigurationResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" custom_data_type_records: Optional[shared_customdatatyperecords.CustomDataTypeRecords] = dataclasses.field(default=None) r"""OK""" diff --git a/platform/src/codatplatform/models/operations/get_integration.py b/platform/src/codatplatform/models/operations/get_integration.py index 41b1b360a..983128328 100644 --- a/platform/src/codatplatform/models/operations/get_integration.py +++ b/platform/src/codatplatform/models/operations/get_integration.py @@ -19,10 +19,10 @@ class GetIntegrationRequest: class GetIntegrationResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" integration: Optional[shared_integration.Integration] = dataclasses.field(default=None) r"""OK""" diff --git a/platform/src/codatplatform/models/operations/get_integrations_branding.py b/platform/src/codatplatform/models/operations/get_integrations_branding.py index 459c7c2fe..9cf9d74e3 100644 --- a/platform/src/codatplatform/models/operations/get_integrations_branding.py +++ b/platform/src/codatplatform/models/operations/get_integrations_branding.py @@ -19,10 +19,10 @@ class GetIntegrationsBrandingRequest: class GetIntegrationsBrandingResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" branding: Optional[shared_branding.Branding] = dataclasses.field(default=None) r"""OK""" diff --git a/platform/src/codatplatform/models/operations/get_profile.py b/platform/src/codatplatform/models/operations/get_profile.py index a561b574e..ca802806a 100644 --- a/platform/src/codatplatform/models/operations/get_profile.py +++ b/platform/src/codatplatform/models/operations/get_profile.py @@ -11,10 +11,10 @@ class GetProfileResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" profile: Optional[shared_profile.Profile] = dataclasses.field(default=None) r"""OK""" diff --git a/platform/src/codatplatform/models/operations/get_profile_syncsettings.py b/platform/src/codatplatform/models/operations/get_profile_syncsettings.py index 5d8c7a03c..075af96fd 100644 --- a/platform/src/codatplatform/models/operations/get_profile_syncsettings.py +++ b/platform/src/codatplatform/models/operations/get_profile_syncsettings.py @@ -11,10 +11,10 @@ class GetProfileSyncSettingsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" sync_settings: Optional[shared_syncsettings.SyncSettings] = dataclasses.field(default=None) r"""OK""" diff --git a/platform/src/codatplatform/models/operations/get_pull_operation.py b/platform/src/codatplatform/models/operations/get_pull_operation.py index 0afe77aaf..ecdbbb805 100644 --- a/platform/src/codatplatform/models/operations/get_pull_operation.py +++ b/platform/src/codatplatform/models/operations/get_pull_operation.py @@ -21,10 +21,10 @@ class GetPullOperationRequest: class GetPullOperationResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" pull_operation: Optional[shared_pulloperation.PullOperation] = dataclasses.field(default=None) r"""OK""" diff --git a/platform/src/codatplatform/models/operations/get_push_operation.py b/platform/src/codatplatform/models/operations/get_push_operation.py index d40da909e..bcca4f62d 100644 --- a/platform/src/codatplatform/models/operations/get_push_operation.py +++ b/platform/src/codatplatform/models/operations/get_push_operation.py @@ -21,10 +21,10 @@ class GetPushOperationRequest: class GetPushOperationResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" push_operation: Optional[shared_pushoperation.PushOperation] = dataclasses.field(default=None) r"""OK""" diff --git a/platform/src/codatplatform/models/operations/get_supplemental_data_configuration.py b/platform/src/codatplatform/models/operations/get_supplemental_data_configuration.py index cb9c258c9..128b2b142 100644 --- a/platform/src/codatplatform/models/operations/get_supplemental_data_configuration.py +++ b/platform/src/codatplatform/models/operations/get_supplemental_data_configuration.py @@ -46,10 +46,10 @@ class GetSupplementalDataConfigurationRequest: class GetSupplementalDataConfigurationResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" supplemental_data_configuration: Optional[shared_supplementaldataconfiguration.SupplementalDataConfiguration] = dataclasses.field(default=None) r"""OK""" diff --git a/platform/src/codatplatform/models/operations/get_webhook.py b/platform/src/codatplatform/models/operations/get_webhook.py index 1eaebe8da..fbe60cff1 100644 --- a/platform/src/codatplatform/models/operations/get_webhook.py +++ b/platform/src/codatplatform/models/operations/get_webhook.py @@ -19,10 +19,10 @@ class GetWebhookRequest: class GetWebhookResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" webhook: Optional[shared_webhook.Webhook] = dataclasses.field(default=None) r"""OK""" diff --git a/platform/src/codatplatform/models/operations/list_api_keys.py b/platform/src/codatplatform/models/operations/list_api_keys.py index 1380a5182..9a29a5e9c 100644 --- a/platform/src/codatplatform/models/operations/list_api_keys.py +++ b/platform/src/codatplatform/models/operations/list_api_keys.py @@ -11,10 +11,10 @@ class ListAPIKeysResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" api_keys: Optional[shared_apikeys.APIKeys] = dataclasses.field(default=None) r"""Success""" diff --git a/platform/src/codatplatform/models/operations/list_companies.py b/platform/src/codatplatform/models/operations/list_companies.py index 72bcc118a..41f52fdfb 100644 --- a/platform/src/codatplatform/models/operations/list_companies.py +++ b/platform/src/codatplatform/models/operations/list_companies.py @@ -25,10 +25,10 @@ class ListCompaniesRequest: class ListCompaniesResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" companies: Optional[shared_companies.Companies] = dataclasses.field(default=None) r"""OK""" diff --git a/platform/src/codatplatform/models/operations/list_connections.py b/platform/src/codatplatform/models/operations/list_connections.py index 24f4c54f5..e4665b548 100644 --- a/platform/src/codatplatform/models/operations/list_connections.py +++ b/platform/src/codatplatform/models/operations/list_connections.py @@ -27,10 +27,10 @@ class ListConnectionsRequest: class ListConnectionsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" connections: Optional[shared_connections.Connections] = dataclasses.field(default=None) r"""OK""" diff --git a/platform/src/codatplatform/models/operations/list_custom_data_type_records.py b/platform/src/codatplatform/models/operations/list_custom_data_type_records.py index fcd685a0b..ddcd47afa 100644 --- a/platform/src/codatplatform/models/operations/list_custom_data_type_records.py +++ b/platform/src/codatplatform/models/operations/list_custom_data_type_records.py @@ -27,10 +27,10 @@ class ListCustomDataTypeRecordsRequest: class ListCustomDataTypeRecordsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" custom_data_type_records: Optional[shared_customdatatyperecords.CustomDataTypeRecords] = dataclasses.field(default=None) r"""OK""" diff --git a/platform/src/codatplatform/models/operations/list_groups.py b/platform/src/codatplatform/models/operations/list_groups.py index 3e744a55a..94ebd2631 100644 --- a/platform/src/codatplatform/models/operations/list_groups.py +++ b/platform/src/codatplatform/models/operations/list_groups.py @@ -11,10 +11,10 @@ class ListGroupsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" groups: Optional[shared_groups.Groups] = dataclasses.field(default=None) r"""Success""" diff --git a/platform/src/codatplatform/models/operations/list_integrations.py b/platform/src/codatplatform/models/operations/list_integrations.py index 3c3bce2c6..7adb05af9 100644 --- a/platform/src/codatplatform/models/operations/list_integrations.py +++ b/platform/src/codatplatform/models/operations/list_integrations.py @@ -25,10 +25,10 @@ class ListIntegrationsRequest: class ListIntegrationsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" integrations: Optional[shared_integrations.Integrations] = dataclasses.field(default=None) r"""OK""" diff --git a/platform/src/codatplatform/models/operations/list_pull_operations.py b/platform/src/codatplatform/models/operations/list_pull_operations.py index 348e80bd8..d25577197 100644 --- a/platform/src/codatplatform/models/operations/list_pull_operations.py +++ b/platform/src/codatplatform/models/operations/list_pull_operations.py @@ -27,10 +27,10 @@ class ListPullOperationsRequest: class ListPullOperationsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" pull_operations: Optional[shared_pulloperations.PullOperations] = dataclasses.field(default=None) r"""OK""" diff --git a/platform/src/codatplatform/models/operations/list_rules.py b/platform/src/codatplatform/models/operations/list_rules.py index 7bf935508..78cd137a7 100644 --- a/platform/src/codatplatform/models/operations/list_rules.py +++ b/platform/src/codatplatform/models/operations/list_rules.py @@ -25,10 +25,10 @@ class ListRulesRequest: class ListRulesResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" webhooks: Optional[shared_webhooks.Webhooks] = dataclasses.field(default=None) r"""OK""" diff --git a/platform/src/codatplatform/models/operations/refresh_company_data.py b/platform/src/codatplatform/models/operations/refresh_company_data.py index c93c636fa..9abcb1baa 100644 --- a/platform/src/codatplatform/models/operations/refresh_company_data.py +++ b/platform/src/codatplatform/models/operations/refresh_company_data.py @@ -17,9 +17,9 @@ class RefreshCompanyDataRequest: class RefreshCompanyDataResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/platform/src/codatplatform/models/operations/refresh_custom_data_type.py b/platform/src/codatplatform/models/operations/refresh_custom_data_type.py index b19d4f1b6..fb30d9155 100644 --- a/platform/src/codatplatform/models/operations/refresh_custom_data_type.py +++ b/platform/src/codatplatform/models/operations/refresh_custom_data_type.py @@ -23,10 +23,10 @@ class RefreshCustomDataTypeRequest: class RefreshCustomDataTypeResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" pull_operation: Optional[shared_pulloperation.PullOperation] = dataclasses.field(default=None) r"""OK""" diff --git a/platform/src/codatplatform/models/operations/refresh_data_type.py b/platform/src/codatplatform/models/operations/refresh_data_type.py index ea9a0a6be..1c2f20d9f 100644 --- a/platform/src/codatplatform/models/operations/refresh_data_type.py +++ b/platform/src/codatplatform/models/operations/refresh_data_type.py @@ -24,10 +24,10 @@ class RefreshDataTypeRequest: class RefreshDataTypeResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" pull_operation: Optional[shared_pulloperation.PullOperation] = dataclasses.field(default=None) r"""OK""" diff --git a/platform/src/codatplatform/models/operations/remove_company_from_group.py b/platform/src/codatplatform/models/operations/remove_company_from_group.py index ec4684dcb..2cf3a6e5d 100644 --- a/platform/src/codatplatform/models/operations/remove_company_from_group.py +++ b/platform/src/codatplatform/models/operations/remove_company_from_group.py @@ -19,9 +19,9 @@ class RemoveCompanyFromGroupRequest: class RemoveCompanyFromGroupResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/platform/src/codatplatform/models/operations/unlink_connection.py b/platform/src/codatplatform/models/operations/unlink_connection.py index 8f637683e..ad4ba6b26 100644 --- a/platform/src/codatplatform/models/operations/unlink_connection.py +++ b/platform/src/codatplatform/models/operations/unlink_connection.py @@ -23,10 +23,10 @@ class UnlinkConnectionRequest: class UnlinkConnectionResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" connection: Optional[shared_connection.Connection] = dataclasses.field(default=None) r"""OK""" diff --git a/platform/src/codatplatform/models/operations/update_company.py b/platform/src/codatplatform/models/operations/update_company.py index 3df4f661f..4eae4a4d0 100644 --- a/platform/src/codatplatform/models/operations/update_company.py +++ b/platform/src/codatplatform/models/operations/update_company.py @@ -21,10 +21,10 @@ class UpdateCompanyRequest: class UpdateCompanyResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" company: Optional[shared_company.Company] = dataclasses.field(default=None) r"""OK""" diff --git a/platform/src/codatplatform/models/operations/update_connection_authorization.py b/platform/src/codatplatform/models/operations/update_connection_authorization.py index 987fe1d07..3ae434d80 100644 --- a/platform/src/codatplatform/models/operations/update_connection_authorization.py +++ b/platform/src/codatplatform/models/operations/update_connection_authorization.py @@ -22,10 +22,10 @@ class UpdateConnectionAuthorizationRequest: class UpdateConnectionAuthorizationResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" connection: Optional[shared_connection.Connection] = dataclasses.field(default=None) r"""OK""" diff --git a/platform/src/codatplatform/models/operations/update_profile.py b/platform/src/codatplatform/models/operations/update_profile.py index 778c54fe0..99890f536 100644 --- a/platform/src/codatplatform/models/operations/update_profile.py +++ b/platform/src/codatplatform/models/operations/update_profile.py @@ -11,10 +11,10 @@ class UpdateProfileResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" profile: Optional[shared_profile.Profile] = dataclasses.field(default=None) r"""OK""" diff --git a/platform/src/codatplatform/models/operations/update_profile_syncsettings.py b/platform/src/codatplatform/models/operations/update_profile_syncsettings.py index e69abab8d..e1b429b38 100644 --- a/platform/src/codatplatform/models/operations/update_profile_syncsettings.py +++ b/platform/src/codatplatform/models/operations/update_profile_syncsettings.py @@ -28,9 +28,9 @@ class UpdateProfileSyncSettingsRequestBody: class UpdateProfileSyncSettingsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/platform/src/codatplatform/models/shared/__init__.py b/platform/src/codatplatform/models/shared/__init__.py index 4f139d4a4..a10cf5dd6 100644 --- a/platform/src/codatplatform/models/shared/__init__.py +++ b/platform/src/codatplatform/models/shared/__init__.py @@ -33,6 +33,8 @@ from .datasynccompletedwebhookdata import * from .datatype import * from .datatypefeature import * +from .errorvalidation import * +from .errorvalidationitem import * from .featurestate import * from .featuretype import * from .group import * @@ -79,4 +81,4 @@ from .webhooknotifier import * from .webhooks import * -__all__ = ["APIKeyDetails","APIKeys","Branding","BrandingButton","BrandingImage","BrandingLogo","ClientRateLimitReachedWebhook","ClientRateLimitReachedWebhookData","ClientRateLimitResetWebhook","ClientRateLimitResetWebhookData","Companies","Company","CompanyGroupAssignment","CompanyRequestBody","Connection","ConnectionStatusChangedWebhook","ConnectionStatusChangedWebhookData","Connections","Content","CreateAPIKey","CreateRule","CustomDataTypeConfiguration","CustomDataTypeRecord","CustomDataTypeRecords","DataConnectionError","DataConnectionStatus","DataStatus","DataSyncCompletedWebhook","DataSyncCompletedWebhookData","DataType","DataTypeFeature","DataTypes","DatasetDataChangedWebhook","DatasetDataChangedWebhookData","DatasetStatusChangedErrorWebhook","DatasetStatusChangedErrorWebhookData","FeatureState","FeatureType","Group","GroupPrototype","GroupRef","Groups","HalRef","ImageReference","Integration","Integrations","Links","ModifiedDate","NewCompanySynchronizedWebhook","NewCompanySynchronizedWebhookData","Profile","PullOperation","PullOperations","PushChangeType","PushFieldValidation","PushOperation","PushOperationChange","PushOperationRef","PushOperationStatus","PushOperationStatusChangedWebhook","PushOperationStatusChangedWebhookData","PushOperationTimedOutWebhook","PushOperationTimedOutWebhookData","PushOperations","PushOption","PushOptionChoice","PushOptionProperty","PushOptionType","PushValidationInfo","SchemaDataType","Security","SourceType","Status","SupplementalDataConfiguration","SupplementalDataSourceConfiguration","SupportedFeature","SyncSetting","SyncSettings","UpdateConnectionStatus","Validation","ValidationItem","Webhook","WebhookNotifier","Webhooks"] +__all__ = ["APIKeyDetails","APIKeys","Branding","BrandingButton","BrandingImage","BrandingLogo","ClientRateLimitReachedWebhook","ClientRateLimitReachedWebhookData","ClientRateLimitResetWebhook","ClientRateLimitResetWebhookData","Companies","Company","CompanyGroupAssignment","CompanyRequestBody","Connection","ConnectionStatusChangedWebhook","ConnectionStatusChangedWebhookData","Connections","Content","CreateAPIKey","CreateRule","CustomDataTypeConfiguration","CustomDataTypeRecord","CustomDataTypeRecords","DataConnectionError","DataConnectionStatus","DataStatus","DataSyncCompletedWebhook","DataSyncCompletedWebhookData","DataType","DataTypeFeature","DataTypes","DatasetDataChangedWebhook","DatasetDataChangedWebhookData","DatasetStatusChangedErrorWebhook","DatasetStatusChangedErrorWebhookData","ErrorValidation","ErrorValidationItem","FeatureState","FeatureType","Group","GroupPrototype","GroupRef","Groups","HalRef","ImageReference","Integration","Integrations","Links","ModifiedDate","NewCompanySynchronizedWebhook","NewCompanySynchronizedWebhookData","Profile","PullOperation","PullOperations","PushChangeType","PushFieldValidation","PushOperation","PushOperationChange","PushOperationRef","PushOperationStatus","PushOperationStatusChangedWebhook","PushOperationStatusChangedWebhookData","PushOperationTimedOutWebhook","PushOperationTimedOutWebhookData","PushOperations","PushOption","PushOptionChoice","PushOptionProperty","PushOptionType","PushValidationInfo","SchemaDataType","Security","SourceType","Status","SupplementalDataConfiguration","SupplementalDataSourceConfiguration","SupportedFeature","SyncSetting","SyncSettings","UpdateConnectionStatus","Validation","ValidationItem","Webhook","WebhookNotifier","Webhooks"] diff --git a/platform/src/codatplatform/models/shared/apikeydetails.py b/platform/src/codatplatform/models/shared/apikeydetails.py index 2453ed4e0..427d114f1 100644 --- a/platform/src/codatplatform/models/shared/apikeydetails.py +++ b/platform/src/codatplatform/models/shared/apikeydetails.py @@ -11,6 +11,7 @@ @dataclasses.dataclass class APIKeyDetails: r"""Details of the API key.""" + UNSET='__SPEAKEASY_UNSET__' api_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('apiKey'), 'exclude': lambda f: f is None }}) r"""The API key value used to make authenticated http requests.""" created_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('createdDate'), 'exclude': lambda f: f is None }}) @@ -36,7 +37,7 @@ class APIKeyDetails: """ id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) r"""Unique identifier for the API key.""" - name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + name: Optional[str] = dataclasses.field(default=UNSET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is APIKeyDetails.UNSET }}) r"""A meaningful name assigned to the API key.""" diff --git a/platform/src/codatplatform/models/shared/clientratelimitresetwebhookdata.py b/platform/src/codatplatform/models/shared/clientratelimitresetwebhookdata.py index 4e0b67ad3..9907406fa 100644 --- a/platform/src/codatplatform/models/shared/clientratelimitresetwebhookdata.py +++ b/platform/src/codatplatform/models/shared/clientratelimitresetwebhookdata.py @@ -10,6 +10,7 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class ClientRateLimitResetWebhookData: + UNSET='__SPEAKEASY_UNSET__' 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 }}) @@ -33,7 +34,7 @@ class ClientRateLimitResetWebhookData: > 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') }}) + quota_remaining: Optional[int] = dataclasses.field(default=UNSET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('QuotaRemaining'), 'exclude': lambda f: f is ClientRateLimitResetWebhookData.UNSET }}) 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/createapikey.py b/platform/src/codatplatform/models/shared/createapikey.py index df224905a..a0d2a14d1 100644 --- a/platform/src/codatplatform/models/shared/createapikey.py +++ b/platform/src/codatplatform/models/shared/createapikey.py @@ -11,7 +11,8 @@ @dataclasses.dataclass class CreateAPIKey: r"""Details about the newly created API key.""" - name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) + UNSET='__SPEAKEASY_UNSET__' + name: Optional[str] = dataclasses.field(default=UNSET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name'), 'exclude': lambda f: f is CreateAPIKey.UNSET }}) r"""A meaningful name assigned to the API key.""" diff --git a/platform/src/codatplatform/models/shared/customdatatypeconfiguration.py b/platform/src/codatplatform/models/shared/customdatatypeconfiguration.py index 57d4d80b4..678d9f1dd 100644 --- a/platform/src/codatplatform/models/shared/customdatatypeconfiguration.py +++ b/platform/src/codatplatform/models/shared/customdatatypeconfiguration.py @@ -11,13 +11,14 @@ @dataclasses.dataclass class CustomDataTypeConfiguration: r"""Client's configuration details for a specific custom data type and platform pair.""" + UNSET='__SPEAKEASY_UNSET__' data_source: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataSource'), 'exclude': lambda f: f is None }}) r"""Underlying endpoint of the source platform that will serve as a data source for the custom data type. This value is not validated by Codat.""" key_by: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('keyBy'), 'exclude': lambda f: f is None }}) r"""An array of properties from the source system that can be used to uniquely identify the records returned for the custom data type. This value is not validated by Codat.""" required_data: Optional[Dict[str, str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('requiredData'), 'exclude': lambda f: f is None }}) r"""Properties required to be fetched from the underlying platform for the custom data type that is being configured. This value is not validated by Codat.""" - source_modified_date: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate') }}) + source_modified_date: Optional[List[str]] = dataclasses.field(default=UNSET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceModifiedDate'), 'exclude': lambda f: f is CustomDataTypeConfiguration.UNSET }}) r"""Property in the source platform nominated by the client that defines the date when a record was last modified there. This value is not validated by Codat.""" diff --git a/platform/src/codatplatform/models/shared/dataconnectionerror.py b/platform/src/codatplatform/models/shared/dataconnectionerror.py index 91cf61e3a..f8049156c 100644 --- a/platform/src/codatplatform/models/shared/dataconnectionerror.py +++ b/platform/src/codatplatform/models/shared/dataconnectionerror.py @@ -10,6 +10,8 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class DataConnectionError: + error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage'), 'exclude': lambda f: f is None }}) + r"""A brief message about the error.""" errored_on_utc: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('erroredOnUtc'), '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: @@ -31,8 +33,6 @@ class DataConnectionError: > 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. """ - error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage'), 'exclude': lambda f: f is None }}) - r"""A brief message about the error.""" status_code: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusCode'), 'exclude': lambda f: f is None }}) r"""The HTTP status code returned by the error.""" status_text: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusText'), 'exclude': lambda f: f is None }}) diff --git a/platform/src/codatplatform/models/shared/datasetdatachangedwebhook.py b/platform/src/codatplatform/models/shared/datasetdatachangedwebhook.py index 705ea757c..c1ebcda9e 100644 --- a/platform/src/codatplatform/models/shared/datasetdatachangedwebhook.py +++ b/platform/src/codatplatform/models/shared/datasetdatachangedwebhook.py @@ -11,10 +11,10 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class DatasetDataChangedWebhookData: - 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[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""" + 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.""" diff --git a/platform/src/codatplatform/models/shared/datasetstatuschangederrorwebhookdata.py b/platform/src/codatplatform/models/shared/datasetstatuschangederrorwebhookdata.py index 335e48ef8..cc1ca26dd 100644 --- a/platform/src/codatplatform/models/shared/datasetstatuschangederrorwebhookdata.py +++ b/platform/src/codatplatform/models/shared/datasetstatuschangederrorwebhookdata.py @@ -11,11 +11,11 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class DatasetStatusChangedErrorWebhookData: + data_type: Optional[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""" 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[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/datasynccompletedwebhookdata.py b/platform/src/codatplatform/models/shared/datasynccompletedwebhookdata.py index 676c8d5c6..14089e489 100644 --- a/platform/src/codatplatform/models/shared/datasynccompletedwebhookdata.py +++ b/platform/src/codatplatform/models/shared/datasynccompletedwebhookdata.py @@ -11,9 +11,9 @@ @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[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""" + 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.""" diff --git a/platform/src/codatplatform/models/shared/errorvalidation.py b/platform/src/codatplatform/models/shared/errorvalidation.py new file mode 100644 index 000000000..124103058 --- /dev/null +++ b/platform/src/codatplatform/models/shared/errorvalidation.py @@ -0,0 +1,19 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from __future__ import annotations +import dataclasses +from .errorvalidationitem import ErrorValidationItem +from codatplatform import utils +from dataclasses_json import Undefined, dataclass_json +from typing import List, Optional + + +@dataclass_json(undefined=Undefined.EXCLUDE) +@dataclasses.dataclass +class ErrorValidation: + r"""A human-readable object describing validation decisions Codat has made. If an operation has failed because of validation errors, they will be detailed here.""" + UNSET='__SPEAKEASY_UNSET__' + errors: Optional[List[ErrorValidationItem]] = dataclasses.field(default=UNSET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errors'), 'exclude': lambda f: f is ErrorValidation.UNSET }}) + warnings: Optional[List[ErrorValidationItem]] = dataclasses.field(default=UNSET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('warnings'), 'exclude': lambda f: f is ErrorValidation.UNSET }}) + + diff --git a/platform/src/codatplatform/models/shared/errorvalidationitem.py b/platform/src/codatplatform/models/shared/errorvalidationitem.py new file mode 100644 index 000000000..424f949ed --- /dev/null +++ b/platform/src/codatplatform/models/shared/errorvalidationitem.py @@ -0,0 +1,21 @@ +"""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 ErrorValidationItem: + UNSET='__SPEAKEASY_UNSET__' + item_id: Optional[str] = dataclasses.field(default=UNSET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('itemId'), 'exclude': lambda f: f is ErrorValidationItem.UNSET }}) + r"""Unique identifier for a validation item.""" + message: Optional[str] = dataclasses.field(default=UNSET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('message'), 'exclude': lambda f: f is ErrorValidationItem.UNSET }}) + r"""A message outlining validation item's issue.""" + validator_name: Optional[str] = dataclasses.field(default=UNSET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validatorName'), 'exclude': lambda f: f is ErrorValidationItem.UNSET }}) + r"""Name of validator.""" + + diff --git a/platform/src/codatplatform/models/shared/pulloperation.py b/platform/src/codatplatform/models/shared/pulloperation.py index 991ff8187..bdd4683bf 100644 --- a/platform/src/codatplatform/models/shared/pulloperation.py +++ b/platform/src/codatplatform/models/shared/pulloperation.py @@ -40,6 +40,7 @@ class PullOperation: r"""Information about a queued, in progress or completed pull operation. *Formally called `dataset`* """ + UNSET='__SPEAKEASY_UNSET__' company_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyId') }}) r"""Unique identifier of the company associated to this pull operation.""" connection_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('connectionId') }}) @@ -98,9 +99,9 @@ class PullOperation: > 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. """ - error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage') }}) + error_message: Optional[str] = dataclasses.field(default=UNSET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage'), 'exclude': lambda f: f is PullOperation.UNSET }}) r"""A message about a transient or persistent error.""" - status_description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusDescription') }}) + status_description: Optional[str] = dataclasses.field(default=UNSET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusDescription'), 'exclude': lambda f: f is PullOperation.UNSET }}) r"""Additional information about the dataset status.""" diff --git a/platform/src/codatplatform/models/shared/pushfieldvalidation.py b/platform/src/codatplatform/models/shared/pushfieldvalidation.py index b62beff71..c6b672d7c 100644 --- a/platform/src/codatplatform/models/shared/pushfieldvalidation.py +++ b/platform/src/codatplatform/models/shared/pushfieldvalidation.py @@ -10,11 +10,12 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class PushFieldValidation: + UNSET='__SPEAKEASY_UNSET__' details: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('details') }}) r"""Details on the validation issue.""" field: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('field'), 'exclude': lambda f: f is None }}) r"""Field name that resulted in the validation issue.""" - ref: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ref') }}) + ref: Optional[str] = dataclasses.field(default=UNSET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ref'), 'exclude': lambda f: f is PushFieldValidation.UNSET }}) r"""Unique reference identifier for the validation issue.""" diff --git a/platform/src/codatplatform/models/shared/pushoperation.py b/platform/src/codatplatform/models/shared/pushoperation.py index 146e9f578..5a0987e4f 100644 --- a/platform/src/codatplatform/models/shared/pushoperation.py +++ b/platform/src/codatplatform/models/shared/pushoperation.py @@ -14,6 +14,7 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class PushOperation: + UNSET='__SPEAKEASY_UNSET__' company_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('companyId') }}) r"""Unique identifier for your SMB in Codat.""" data_connection_key: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataConnectionKey') }}) @@ -45,7 +46,7 @@ class PushOperation: r"""The current status of the push operation.""" status_code: int = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('statusCode') }}) r"""Push status code.""" - changes: Optional[List[PushOperationChange]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes') }}) + changes: Optional[List[PushOperationChange]] = dataclasses.field(default=UNSET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('changes'), 'exclude': lambda f: f is PushOperation.UNSET }}) r"""Contains a single entry that communicates which record has changed and the manner in which it changed.""" completed_on_utc: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('completedOnUtc'), '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: @@ -70,11 +71,11 @@ class PushOperation: """ data_type: Optional[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""" - error_message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage') }}) + error_message: Optional[str] = dataclasses.field(default=UNSET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errorMessage'), 'exclude': lambda f: f is PushOperation.UNSET }}) r"""A message about the error.""" - timeout_in_minutes: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInMinutes') }}) + timeout_in_minutes: Optional[int] = dataclasses.field(default=UNSET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInMinutes'), 'exclude': lambda f: f is PushOperation.UNSET }}) r"""Number of minutes the push operation must complete within before it times out.""" - timeout_in_seconds: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInSeconds') }}) + timeout_in_seconds: Optional[int] = dataclasses.field(default=UNSET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timeoutInSeconds'), 'exclude': lambda f: f is PushOperation.UNSET }}) r"""Number of seconds the push operation must complete within before it times out. Deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/platform/src/codatplatform/models/shared/pushoperationchange.py b/platform/src/codatplatform/models/shared/pushoperationchange.py index 917d8e086..d45b4d37f 100644 --- a/platform/src/codatplatform/models/shared/pushoperationchange.py +++ b/platform/src/codatplatform/models/shared/pushoperationchange.py @@ -12,7 +12,8 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class PushOperationChange: - attachment_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attachmentId') }}) + UNSET='__SPEAKEASY_UNSET__' + attachment_id: Optional[str] = dataclasses.field(default=UNSET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attachmentId'), 'exclude': lambda f: f is PushOperationChange.UNSET }}) r"""Unique identifier for the attachment created otherwise null.""" record_ref: Optional[PushOperationRef] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('recordRef'), 'exclude': lambda f: f is None }}) type: Optional[PushChangeType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type'), 'exclude': lambda f: f is None }}) diff --git a/platform/src/codatplatform/models/shared/pushoption.py b/platform/src/codatplatform/models/shared/pushoption.py index 4fdae0c92..9158e6b6c 100644 --- a/platform/src/codatplatform/models/shared/pushoption.py +++ b/platform/src/codatplatform/models/shared/pushoption.py @@ -14,6 +14,7 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class PushOption: + UNSET='__SPEAKEASY_UNSET__' display_name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('displayName') }}) r"""The property's display name.""" required: bool = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('required') }}) @@ -22,8 +23,8 @@ class PushOption: r"""The option type.""" description: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description'), 'exclude': lambda f: f is None }}) r"""A description of the property.""" - options: Optional[List[PushOptionChoice]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options') }}) - properties: Optional[Dict[str, PushOptionProperty]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('properties') }}) + options: Optional[List[PushOptionChoice]] = dataclasses.field(default=UNSET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options'), 'exclude': lambda f: f is PushOption.UNSET }}) + properties: Optional[Dict[str, PushOptionProperty]] = dataclasses.field(default=UNSET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('properties'), 'exclude': lambda f: f is PushOption.UNSET }}) validation: Optional[PushValidationInfo] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validation'), 'exclude': lambda f: f is None }}) diff --git a/platform/src/codatplatform/models/shared/pushoptionproperty.py b/platform/src/codatplatform/models/shared/pushoptionproperty.py index f5f793235..edf8a35d2 100644 --- a/platform/src/codatplatform/models/shared/pushoptionproperty.py +++ b/platform/src/codatplatform/models/shared/pushoptionproperty.py @@ -13,6 +13,7 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class PushOptionProperty: + UNSET='__SPEAKEASY_UNSET__' description: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('description') }}) r"""A description of the property.""" display_name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('displayName') }}) @@ -21,8 +22,8 @@ class PushOptionProperty: r"""The property is required if `True`.""" type: PushOptionType = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('type') }}) r"""The option type.""" - options: Optional[List[PushOptionChoice]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options') }}) - properties: Optional[Dict[str, PushOptionProperty]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('properties') }}) + options: Optional[List[PushOptionChoice]] = dataclasses.field(default=UNSET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options'), 'exclude': lambda f: f is PushOptionProperty.UNSET }}) + properties: Optional[Dict[str, PushOptionProperty]] = dataclasses.field(default=UNSET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('properties'), 'exclude': lambda f: f is PushOptionProperty.UNSET }}) validation: Optional[PushValidationInfo] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validation'), 'exclude': lambda f: f is None }}) diff --git a/platform/src/codatplatform/models/shared/pushvalidationinfo.py b/platform/src/codatplatform/models/shared/pushvalidationinfo.py index 80039b80c..2595e7278 100644 --- a/platform/src/codatplatform/models/shared/pushvalidationinfo.py +++ b/platform/src/codatplatform/models/shared/pushvalidationinfo.py @@ -11,7 +11,8 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class PushValidationInfo: - information: Optional[List[PushFieldValidation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('information') }}) - warnings: Optional[List[PushFieldValidation]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('warnings') }}) + UNSET='__SPEAKEASY_UNSET__' + information: Optional[List[PushFieldValidation]] = dataclasses.field(default=UNSET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('information'), 'exclude': lambda f: f is PushValidationInfo.UNSET }}) + warnings: Optional[List[PushFieldValidation]] = dataclasses.field(default=UNSET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('warnings'), 'exclude': lambda f: f is PushValidationInfo.UNSET }}) diff --git a/platform/src/codatplatform/models/shared/validation.py b/platform/src/codatplatform/models/shared/validation.py index d4196fbf6..006455426 100644 --- a/platform/src/codatplatform/models/shared/validation.py +++ b/platform/src/codatplatform/models/shared/validation.py @@ -12,7 +12,8 @@ @dataclasses.dataclass class Validation: r"""A human-readable object describing validation decisions Codat has made when pushing data into the platform. If a push has failed because of validation errors, they will be detailed here.""" - errors: Optional[List[ValidationItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errors') }}) - warnings: Optional[List[ValidationItem]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('warnings') }}) + UNSET='__SPEAKEASY_UNSET__' + errors: Optional[List[ValidationItem]] = dataclasses.field(default=UNSET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('errors'), 'exclude': lambda f: f is Validation.UNSET }}) + warnings: Optional[List[ValidationItem]] = dataclasses.field(default=UNSET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('warnings'), 'exclude': lambda f: f is Validation.UNSET }}) diff --git a/platform/src/codatplatform/models/shared/validationitem.py b/platform/src/codatplatform/models/shared/validationitem.py index cdd0994e7..4deb0c0af 100644 --- a/platform/src/codatplatform/models/shared/validationitem.py +++ b/platform/src/codatplatform/models/shared/validationitem.py @@ -10,11 +10,12 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class ValidationItem: - item_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('itemId') }}) + UNSET='__SPEAKEASY_UNSET__' + item_id: Optional[str] = dataclasses.field(default=UNSET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('itemId'), 'exclude': lambda f: f is ValidationItem.UNSET }}) r"""Unique identifier for a validation item.""" - message: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('message') }}) + message: Optional[str] = dataclasses.field(default=UNSET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('message'), 'exclude': lambda f: f is ValidationItem.UNSET }}) r"""A message outlining validation item's issue.""" - validator_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validatorName') }}) + validator_name: Optional[str] = dataclasses.field(default=UNSET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('validatorName'), 'exclude': lambda f: f is ValidationItem.UNSET }}) r"""Name of validator.""" diff --git a/platform/src/codatplatform/models/webhooks/client_rate_limit_reached.py b/platform/src/codatplatform/models/webhooks/client_rate_limit_reached.py index 2e236f1a6..6f8ec4867 100644 --- a/platform/src/codatplatform/models/webhooks/client_rate_limit_reached.py +++ b/platform/src/codatplatform/models/webhooks/client_rate_limit_reached.py @@ -9,9 +9,9 @@ class ClientRateLimitReachedResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/platform/src/codatplatform/models/webhooks/client_rate_limit_reset.py b/platform/src/codatplatform/models/webhooks/client_rate_limit_reset.py index 27dbf5cb4..ecc722470 100644 --- a/platform/src/codatplatform/models/webhooks/client_rate_limit_reset.py +++ b/platform/src/codatplatform/models/webhooks/client_rate_limit_reset.py @@ -9,9 +9,9 @@ class ClientRateLimitResetResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/platform/src/codatplatform/models/webhooks/company_data_connection_status_changed.py b/platform/src/codatplatform/models/webhooks/company_data_connection_status_changed.py index 37c3b6fb3..058fb16c7 100644 --- a/platform/src/codatplatform/models/webhooks/company_data_connection_status_changed.py +++ b/platform/src/codatplatform/models/webhooks/company_data_connection_status_changed.py @@ -9,9 +9,9 @@ class CompanyDataConnectionStatusChangedResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/platform/src/codatplatform/models/webhooks/data_sync_completed.py b/platform/src/codatplatform/models/webhooks/data_sync_completed.py index 1f0f04ce7..03c61337c 100644 --- a/platform/src/codatplatform/models/webhooks/data_sync_completed.py +++ b/platform/src/codatplatform/models/webhooks/data_sync_completed.py @@ -9,9 +9,9 @@ class DataSyncCompletedResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/platform/src/codatplatform/models/webhooks/dataset_data_changed.py b/platform/src/codatplatform/models/webhooks/dataset_data_changed.py index 7dcbf633f..901ca8e1b 100644 --- a/platform/src/codatplatform/models/webhooks/dataset_data_changed.py +++ b/platform/src/codatplatform/models/webhooks/dataset_data_changed.py @@ -9,9 +9,9 @@ class DatasetDataChangedResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/platform/src/codatplatform/models/webhooks/dataset_status_has_changed_to_an_error_state.py b/platform/src/codatplatform/models/webhooks/dataset_status_has_changed_to_an_error_state.py index 88603aed1..e16af6645 100644 --- a/platform/src/codatplatform/models/webhooks/dataset_status_has_changed_to_an_error_state.py +++ b/platform/src/codatplatform/models/webhooks/dataset_status_has_changed_to_an_error_state.py @@ -9,9 +9,9 @@ class DatasetStatusHasChangedToAnErrorStateResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/platform/src/codatplatform/models/webhooks/new_company_synchronized.py b/platform/src/codatplatform/models/webhooks/new_company_synchronized.py index e6b0f06ea..df7120b79 100644 --- a/platform/src/codatplatform/models/webhooks/new_company_synchronized.py +++ b/platform/src/codatplatform/models/webhooks/new_company_synchronized.py @@ -9,9 +9,9 @@ class NewCompanySynchronizedResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/platform/src/codatplatform/models/webhooks/push_operation_has_timed_out.py b/platform/src/codatplatform/models/webhooks/push_operation_has_timed_out.py index ce5e5261f..745884c80 100644 --- a/platform/src/codatplatform/models/webhooks/push_operation_has_timed_out.py +++ b/platform/src/codatplatform/models/webhooks/push_operation_has_timed_out.py @@ -9,9 +9,9 @@ class PushOperationHasTimedOutResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/platform/src/codatplatform/models/webhooks/push_operation_status_has_changed.py b/platform/src/codatplatform/models/webhooks/push_operation_status_has_changed.py index dd5cd624c..db1c910dd 100644 --- a/platform/src/codatplatform/models/webhooks/push_operation_status_has_changed.py +++ b/platform/src/codatplatform/models/webhooks/push_operation_status_has_changed.py @@ -9,9 +9,9 @@ class PushOperationStatusHasChangedResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/platform/src/codatplatform/sdkconfiguration.py b/platform/src/codatplatform/sdkconfiguration.py index 2dbbddc52..5aaf765fb 100644 --- a/platform/src/codatplatform/sdkconfiguration.py +++ b/platform/src/codatplatform/sdkconfiguration.py @@ -1,11 +1,12 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" -import requests -from dataclasses import dataclass -from typing import Dict, Tuple, Callable, Union -from .utils.retries import RetryConfig + +import requests as requests_http from .utils import utils +from .utils.retries import RetryConfig from codatplatform.models import shared +from dataclasses import dataclass +from typing import Callable, Dict, Tuple, Union SERVERS = [ @@ -16,15 +17,15 @@ @dataclass class SDKConfiguration: - client: requests.Session + client: requests_http.Session security: Union[shared.Security,Callable[[], shared.Security]] = None server_url: str = '' server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '3.0.0' - sdk_version: str = '3.2.0' - gen_version: str = '2.223.0' - user_agent: str = 'speakeasy-sdk/python 3.2.0 2.223.0 3.0.0 codat-platform' + sdk_version: str = '3.3.0' + gen_version: str = '2.257.2' + user_agent: str = 'speakeasy-sdk/python 3.3.0 2.257.2 3.0.0 codat-platform' retry_config: RetryConfig = None def get_server_details(self) -> Tuple[str, Dict[str, str]]: diff --git a/platform/src/codatplatform/utils/retries.py b/platform/src/codatplatform/utils/retries.py index 25f49a1f2..8eba09407 100644 --- a/platform/src/codatplatform/utils/retries.py +++ b/platform/src/codatplatform/utils/retries.py @@ -75,12 +75,12 @@ def do_request(): if res.status_code == parsed_code: raise TemporaryError(res) except requests.exceptions.ConnectionError as exception: - if not retries.config.config.retry_connection_errors: + if retries.config.config.retry_connection_errors: raise raise PermanentError(exception) from exception except requests.exceptions.Timeout as exception: - if not retries.config.config.retry_connection_errors: + if retries.config.config.retry_connection_errors: raise raise PermanentError(exception) from exception diff --git a/platform/src/codatplatform/utils/utils.py b/platform/src/codatplatform/utils/utils.py index 1a60d4064..52434025e 100644 --- a/platform/src/codatplatform/utils/utils.py +++ b/platform/src/codatplatform/utils/utils.py @@ -110,19 +110,22 @@ def _parse_security_scheme_value(client: SecurityClient, scheme_metadata: Dict, else: raise Exception('not supported') elif scheme_type == "openIdConnect": - client.client.headers[header_name] = value + client.client.headers[header_name] = _apply_bearer(value) elif scheme_type == 'oauth2': - client.client.headers[header_name] = value + client.client.headers[header_name] = _apply_bearer(value) elif scheme_type == 'http': if sub_type == 'bearer': - client.client.headers[header_name] = value.lower().startswith( - 'bearer ') and value or f'Bearer {value}' + client.client.headers[header_name] = _apply_bearer(value) else: raise Exception('not supported') else: raise Exception('not supported') +def _apply_bearer(token: str) -> str: + return token.lower().startswith('bearer ') and token or f'Bearer {token}' + + def _parse_basic_auth_scheme(client: SecurityClient, scheme: dataclass): username = "" password = "" @@ -692,7 +695,7 @@ def unmarshal_json(data, typ, decoder=None): out = unmarshal.from_dict({"res": json_dict}) except AttributeError as attr_err: raise AttributeError( - f'unable to unmarshal {data} as {typ}') from attr_err + f'unable to unmarshal {data} as {typ} - {attr_err}') from attr_err return out.res if decoder is None else decoder(out.res)