# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
APIKeyDetails - Details of the API key.
No description provided by the author
No description provided by the author
BrandingButton - Button branding references.
No description provided by the author
BrandingLogo - Logo branding references.
ClientRateLimitReachedWebhook - Webhook request body for a client that has reached their rate limit.
No description provided by the author
ClientRateLimitResetWebhook - Webhook request body for a client that has had their rate limit reset.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Company - In Codat, a company represents a business sharing access to their data.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
CompanyTags - A collection of user-defined key-value pairs that store custom metadata against the company.
No description provided by the author
Connection - A connection represents a [company's](https://docs.codat.io/platform-api#/schemas/Company) connection to a data source and allows you to synchronize data (pull and/or push) with that source.
No description provided by the author
No description provided by the author
No description provided by the author
ConnectionStatusChangedWebhook - Webhook request body for a company's data connection status changed.
No description provided by the author
No description provided by the author
CreateAPIKey - Details about the newly created API key.
CreateRule - Create a message that notifies a URL of an event based on its given type or condition.
CustomDataTypeConfiguration - Client's configuration details for a specific custom data type and platform pair.
No description provided by the author
CustomDataTypeRecords - Resulting records pulled from the source platform for a specific custom data type.
No description provided by the author
DatasetDataChangedWebhook - Webhook request body to notify that a data synchronization has completed.
No description provided by the author
DatasetStatusChangedErrorWebhook - Webhook request body to notify that a data synchronization has completed.
No description provided by the author
DataStatus - Describes the state of data in the Codat cache for a company and data type.
No description provided by the author
DataSyncCompletedWebhook - Webhook request body to notify the completion of a data sync.
No description provided by the author
DataTypeFeature - Describes support for a given datatype and associated operations.
No description provided by the author
No description provided by the author
No description provided by the author
ErrorValidation - A human-readable object describing validation decisions Codat has made.
No description provided by the author
Group - A container you can use to organize companies together according to a shared characteristic of your choice.
GroupPrototype - The group template used to create a group.
No description provided by the author
No description provided by the author
No description provided by the author
ImageReference - Image reference.
Integration - An integration that Codat supports.
No description provided by the author
No description provided by the author
No description provided by the author
NewCompanySynchronizedWebhook - Webhook request body to notify that a new company has successfully synchronized at least one dataType for the first time.
Profile - Describes your Codat client instance.
PullOperation - Information about a queued, in progress or completed pull operation.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PushOperationStatusChangedWebhook - Webhook request body for a push operation status change.
No description provided by the author
PushOperationTimedOutWebhook - Webhook request body notifying that a push push operation has timed out.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SupplementalDataSourceConfiguration - The client's defined name for the object.
No description provided by the author
SyncSetting - Describes how often, and how much history, should be fetched for the given data type when a pull operation is queued.
No description provided by the author
Tags - A collection of user-defined key-value pairs that store custom metadata against the company.
No description provided by the author
Validation - A human-readable object describing validation decisions Codat has made when pushing data into the platform.
No description provided by the author
Webhook - Configuration to provide an event notification to a URL or list of email addresses based on the given type or condition.
WebhookConsumer - A webhook consumer is an HTTP endpoint that developers can configure to subscribe to Codat's supported event types.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Type aliases
DataConnectionStatus - The current authorization status of the data connection.
DatasetStatus - The current status of the dataset.
DataType - Available data types.
DataTypes - Available data types.
ErrorStatus - The current status of a transient error.
FeatureState - The current release state of the feature.
FeatureType - The type of feature.
PushChangeType - Type of change being applied to record in third party platform.
PushOperationStatus - The current status of the push operation.
PushOptionType - The option type.
SchemaDataType - Available data types.
SourceType - The type of platform of the connection.
Status - The current status of the dataset.
WriteStatus - The current status of the write request, which is the same as the push operation status.
WriteType - Type of write request.