Module types

Source
Expand description

Types used as operation parameters and responses.

Modules§

error
Error types.

Structs§

Acl
List of Permissions.
AclMetadata
Doc level metadata associated with ACL.
AclSettings
Sharing settings for the doc.
AddCustomDocDomainRequest
Payload for adding a custom published doc domain.
AddCustomDocDomainResponse
The result of adding a custom domain to a published doc.
AddGoLinkRequest
Payload for creating a Go Link
AddGoLinkRequestCreatorEmail
Optional creator email for the Go Link. Only organization admins can set this field.
AddGoLinkRequestDescription
Optional description for the Go Link.
AddGoLinkRequestDestinationUrl
The URL that the Go Link redirects to.
AddGoLinkRequestName
The name of the Go Link that comes after go/. Only alphanumeric characters, dashes, and underscores are allowed.
AddGoLinkRequestUrlPattern
Optional destination URL with {*} placeholders for variables to be inserted. Variables are specified like go///.
AddGoLinkResponse
An HTTP error resulting from an unsuccessful request.
AddGoLinkResult
The result of adding a Go Link.
AddPackCategoryRequest
Payload for adding a Pack Category.
AddPackCategoryResponse
Confirmation of successfully adding a Pack category.
AddPackCategoryResponseCodaDetail
Detail about why this request was rejected.
AddPackMakerRequest
Payload for adding a Pack maker.
AddPackMakerResponse
Confirmation of successfully adding a Pack maker.
AddPackMakerResponseCodaDetail
Detail about why this request was rejected.
AddPackPermissionRequest
Payload for upserting a Pack permission.
AddPackPermissionResponse
Confirmation of successfully upserting a Pack permission.
AddPackPermissionResponseCodaDetail
Detail about why this request was rejected.
AddPermissionRequest
Payload for granting a new permission.
AddPermissionResponse
An HTTP error resulting from an unsuccessful request.
AddPermissionResult
The result of sharing a doc.
AddedAnyonePrincipal
AddedAnyonePrincipal
AddedDomainPrincipal
AddedDomainPrincipal
AddedEmailPrincipal
AddedEmailPrincipal
AddedGroupPrincipal
AddedGroupPrincipal
AddedWorkspacePrincipal
AddedWorkspacePrincipal
AnalyticsLastUpdatedResponse
Response representing the last day analytics were updated.
AnyonePrincipal
AnyonePrincipal
ApiLink
Info about a resolved link to an API resource.
ApiLinkResolvedResource
Reference to the resolved resource.
BeginPageContentExportRequest
Request for beginning an export of page content.
BeginPageContentExportResponse
Response when beginning an export of page content.
BundledPackPlan
The Pack plan to show the Pack can be accessed if the workspace is at least the given tier.
BundledPackPlanPricing
Pricing used when workspaces have access to the Pack for free if their workspace is at least the given tier.
CellEdit
An edit made to a particular cell in a row.
ChangeRole
Parameters for changing a workspace user role.
ChangeRoleResult
The result of changing a user’s workspace user role.
ChangeUserRoleResponse
An HTTP error resulting from an unsuccessful request.
Column
Info about a column.
ColumnDetail
Info about a column.
ColumnList
List of columns.
ColumnReference
Reference to a column.
Control
Details about a control.
ControlList
List of controls.
ControlReference
Reference to a control.
CreateDocResponse
An HTTP error resulting from an unsuccessful request.
CreatePackReleaseRequest
Payload for creating a new Pack release.
CreatePackReleaseResponse
An HTTP error resulting from an unsuccessful request.
CreatePackReleaseResponseCodaDetail
Detail about why this request was rejected.
CreatePackRequest
Payload for creating a Pack.
CreatePackResponse
Info about a Pack that was just created.
CreatePackVersionRequest
Payload for Pack version upload complete.
CreatePackVersionResponse
Confirmation of successful Pack version creation.
CreatePageResponse
An HTTP error resulting from an unsuccessful request.
CustomDocDomain
The custom domain added to a published doc.
CustomDocDomainList
List of all custom domains added to a published doc.
CustomDocDomainProviderResponse
The result of determining the domain provider for a custom doc domain.
DeleteCustomDocDomainResponse
The result of deleting a custom domain from a published doc.
DeleteDocResponse
An HTTP error resulting from an unsuccessful request.
DeletePackCategoryResponse
Confirmation of successfully deleting a Pack category.
DeletePackCategoryResponseCodaDetail
Detail about why this request was rejected.
DeletePackMakerResponse
Confirmation of successfully deleting a Pack maker.
DeletePackMakerResponseCodaDetail
Detail about why this request was rejected.
DeletePackPermissionResponse
Confirmation of successfully deleting a Pack permission.
DeletePackPermissionResponseCodaDetail
Detail about why this request was rejected.
DeletePackResponse
Confirmation of successful Pack deletion.
DeletePageResponse
An HTTP error resulting from an unsuccessful request.
DeletePermissionResponse
An HTTP error resulting from an unsuccessful request.
DeletePermissionResult
The result of deleting a permission.
DeleteRowResponse
An HTTP error resulting from an unsuccessful request.
DeleteRowsResponse
An HTTP error resulting from an unsuccessful request.
Doc
Metadata about a Coda doc.
DocAnalyticsCollection
List of analytics for Coda docs over a date range.
DocAnalyticsItem
Analytics data for a Coda doc.
DocAnalyticsMetrics
Analytics metrics for a Coda Doc.
DocAnalyticsSummary
Summarized metrics for Coda docs.
DocCategory
The category applied to a doc.
DocCategoryList
A list of categories that can be applied to a doc.
DocCreate
Payload for creating a new doc.
DocCreateInitialPage
DocCreateInitialPage
DocDelete
The result of a doc deletion.
DocList
List of Coda docs.
DocPublish
Payload for publishing a doc or or updating its publishing information.
DocPublished
Information about the publishing state of the document.
DocReference
Reference to a Coda doc.
DocSize
The number of components within a Coda doc.
DocUpdate
Payload for updating a doc.
DocUpdateResult
The result of a doc update
DocumentCreationResult
The result of a doc creation.
DocumentMutateResponse
Base response type for an operation that mutates a document.
DomainPrincipal
DomainPrincipal
EmailPrincipal
EmailPrincipal
FolderReference
Reference to a Coda folder.
Formula
Details about a formula.
FormulaDetail
Detailed information about a formula.
FormulaList
List of formulas.
FormulaReference
Reference to a formula.
FreePackPlanPricing
Pricing used when workspaces can subscribe to the Pack for free.
GetAclSettingsResponse
An HTTP error resulting from an unsuccessful request.
GetAnalyticsLastUpdatedResponse
An HTTP error resulting from an unsuccessful request.
GetColumnResponse
An HTTP error resulting from an unsuccessful request.
GetControlResponse
An HTTP error resulting from an unsuccessful request.
GetCustomDocDomainProviderResponse
An HTTP error resulting from an unsuccessful request.
GetDocResponse
An HTTP error resulting from an unsuccessful request.
GetFormulaResponse
An HTTP error resulting from an unsuccessful request.
GetMutationStatusResponse
An HTTP error resulting from an unsuccessful request.
GetNextPackVersionRequest
Payload for getting the next version of a Pack.
GetNextPackVersionResponse
An HTTP error resulting from an unsuccessful request.
GetNextPackVersionResponseCodaDetail
Detail about why this request was rejected.
GetPackConfigurationJsonSchemaResponse
JSON schema response.
GetPackConfigurationSchemaResponse
An HTTP error resulting from an unsuccessful request.
GetPackConfigurationSchemaResponseCodaDetail
Detail about why this request was rejected.
GetPackListingResponse
An HTTP error resulting from an unsuccessful request.
GetPackListingResponseCodaDetail
Detail about why this request was rejected.
GetPackLogDetailsResponse
An HTTP error resulting from an unsuccessful request.
GetPackLogDetailsResponseCodaDetail
Detail about why this request was rejected.
GetPackOauthConfigResponse
An HTTP error resulting from an unsuccessful request.
GetPackOauthConfigResponseCodaDetail
Detail about why this request was rejected.
GetPackPermissionsResponse
An HTTP error resulting from an unsuccessful request.
GetPackPermissionsResponseCodaDetail
Detail about why this request was rejected.
GetPackResponse
An HTTP error resulting from an unsuccessful request.
GetPackSourceCodeResponse
An HTTP error resulting from an unsuccessful request.
GetPackSourceCodeResponseCodaDetail
Detail about why this request was rejected.
GetPackSystemConnectionResponse
An HTTP error resulting from an unsuccessful request.
GetPackSystemConnectionResponseCodaDetail
Detail about why this request was rejected.
GetPackVersionDiffsResponse
An HTTP error resulting from an unsuccessful request.
GetPackVersionDiffsResponseCodaDetail
Detail about why this request was rejected.
GetPageContentExportStatusResponse
An HTTP error resulting from an unsuccessful request.
GetPageResponse
An HTTP error resulting from an unsuccessful request.
GetPermissionsResponse
An HTTP error resulting from an unsuccessful request.
GetRowResponse
An HTTP error resulting from an unsuccessful request.
GetSharingMetadataResponse
An HTTP error resulting from an unsuccessful request.
GetTableResponse
An HTTP error resulting from an unsuccessful request.
GetWorkspaceRoleActivity
Response for getting workspace role activity.
GroupPrincipal
GroupPrincipal
GroupedPackAuthLog
Grouped logs of the Pack’s auth requests.
GroupedPackInvocationLog
Grouped logs of the invocations of the Pack.
GroupedPackLogsList
List of grouped Pack logs.
Icon
Info about the icon.
Image
Info about the image.
IngestionBatchExecution
An ingestion batch execution.
IngestionBatchExecutionsList
List of Ingestion Batch Executions.
IngestionExecutionAttempt
An attempt of an ingestion execution.
IngestionExecutionAttemptsList
List of Ingestion Execution Attempts.
IngestionExecutionContext
Context that comes with a ingestion execution.
IngestionExecutionsList
List of Ingestion Executions.
IngestionParentItem
An ingestion parent item and its execution state (either full or incremental).
IngestionParentItemsList
List of Ingestion Parent Items.
LinkedDataObject
Base type for a JSON-LD (Linked Data) object.
ListCategoriesResponse
An HTTP error resulting from an unsuccessful request.
ListColumnsResponse
An HTTP error resulting from an unsuccessful request.
ListControlsResponse
An HTTP error resulting from an unsuccessful request.
ListCustomDocDomainsResponse
An HTTP error resulting from an unsuccessful request.
ListDocAnalyticsResponse
An HTTP error resulting from an unsuccessful request.
ListDocAnalyticsSummaryResponse
An HTTP error resulting from an unsuccessful request.
ListDocsResponse
An HTTP error resulting from an unsuccessful request.
ListFormulasResponse
An HTTP error resulting from an unsuccessful request.
ListGroupedIngestionLogsResponse
An HTTP error resulting from an unsuccessful request.
ListGroupedIngestionLogsResponseCodaDetail
Detail about why this request was rejected.
ListGroupedPackLogsResponse
An HTTP error resulting from an unsuccessful request.
ListGroupedPackLogsResponseCodaDetail
Detail about why this request was rejected.
ListIngestionBatchExecutionsResponse
An HTTP error resulting from an unsuccessful request.
ListIngestionBatchExecutionsResponseCodaDetail
Detail about why this request was rejected.
ListIngestionExecutionAttemptsResponse
An HTTP error resulting from an unsuccessful request.
ListIngestionExecutionAttemptsResponseCodaDetail
Detail about why this request was rejected.
ListIngestionExecutionsResponse
An HTTP error resulting from an unsuccessful request.
ListIngestionExecutionsResponseCodaDetail
Detail about why this request was rejected.
ListIngestionLogsResponse
An HTTP error resulting from an unsuccessful request.
ListIngestionLogsResponseCodaDetail
Detail about why this request was rejected.
ListIngestionParentItemsResponse
An HTTP error resulting from an unsuccessful request.
ListIngestionParentItemsResponseCodaDetail
Detail about why this request was rejected.
ListPackAnalyticsResponse
An HTTP error resulting from an unsuccessful request.
ListPackAnalyticsSummaryResponse
An HTTP error resulting from an unsuccessful request.
ListPackCategoriesResponse
Confirmation of successfully retrieving Pack categories.
ListPackCategoriesResponseCodaDetail
Detail about why this request was rejected.
ListPackFeaturedDocsResponse
An HTTP error resulting from an unsuccessful request.
ListPackFormulaAnalyticsResponse
An HTTP error resulting from an unsuccessful request.
ListPackListingsResponse
An HTTP error resulting from an unsuccessful request.
ListPackListingsResponseCodaDetail
Detail about why this request was rejected.
ListPackLogsResponse
An HTTP error resulting from an unsuccessful request.
ListPackLogsResponseCodaDetail
Detail about why this request was rejected.
ListPackMakersResponse
Confirmation of successfully retrieving Pack makers.
ListPackMakersResponseCodaDetail
Detail about why this request was rejected.
ListPackReleasesResponse
An HTTP error resulting from an unsuccessful request.
ListPackReleasesResponseCodaDetail
Detail about why this request was rejected.
ListPackVersionsResponse
An HTTP error resulting from an unsuccessful request.
ListPackVersionsResponseCodaDetail
Detail about why this request was rejected.
ListPacksResponse
An HTTP error resulting from an unsuccessful request.
ListPageAnalyticsResponse
An HTTP error resulting from an unsuccessful request.
ListPagesResponse
An HTTP error resulting from an unsuccessful request.
ListRowsResponse
An HTTP error resulting from an unsuccessful request.
ListTablesResponse
An HTTP error resulting from an unsuccessful request.
ListWorkspaceMembersResponse
An HTTP error resulting from an unsuccessful request.
ListWorkspaceRoleActivityResponse
An HTTP error resulting from an unsuccessful request.
Maker
Info about the maker
MakerSummary
Summary about a maker
MonthlyDocMakerPackPlanPricing
Pricing used when workspaces can subscribe to the Pack for a monthly cost per Doc Maker.
MutationStatus
The status of an asynchronous mutation.
NextPackVersionInfo
Information indicating the next Pack version definition.
NextPackVersionInfoFindingDetailsItem
NextPackVersionInfoFindingDetailsItem
NextPageLink
If specified, a link that can be used to fetch the next page of results.
NextPageToken
If specified, an opaque token used to fetch the next page of results.
NextSyncToken
If specified, an opaque token that can be passed back later to retrieve new results that match the parameters specified when the sync token was created.
Pack
Details about a Pack.
PackAccessTypes
Access types for a Pack.
PackAnalyticsCollection
List of analytics for Coda Packs over a date range.
PackAnalyticsDetails
Metadata about a Pack relevant to analytics.
PackAnalyticsItem
Analytics data for a Coda Pack.
PackAnalyticsMetrics
Analytics metrics for a Coda Pack.
PackAnalyticsSummary
Summary analytics for Packs.
PackAssetUploadCompleteRequest
Payload for noting a Pack asset upload is complete.
PackAssetUploadCompleteResponse
Response for noting a Pack asset upload is complete.
PackAssetUploadCompleteResponseCodaDetail
Detail about why this request was rejected.
PackAssetUploadInfo
Information indicating where to upload the Pack asset, and an endpoint to mark the upload as complete.
PackAuthLog
System logs of Pack authentication requests.
PackConfigurationEntry
Basic details about a configuration that can be used in conjunction with a pack
PackConnectionAwsAccessKeyCredentials
PackConnectionAwsAccessKeyCredentials
PackConnectionAwsAccessKeyMetadata
PackConnectionAwsAccessKeyMetadata
PackConnectionAwsAccessKeyPatch
PackConnectionAwsAccessKeyPatch
PackConnectionAwsAssumeRoleCredentials
PackConnectionAwsAssumeRoleCredentials
PackConnectionAwsAssumeRoleMetadata
PackConnectionAwsAssumeRoleMetadata
PackConnectionAwsAssumeRolePatch
PackConnectionAwsAssumeRolePatch
PackConnectionCustomCredentials
PackConnectionCustomCredentials
PackConnectionCustomCredentialsParamsItem
PackConnectionCustomCredentialsParamsItem
PackConnectionCustomMetadata
PackConnectionCustomMetadata
PackConnectionCustomMetadataParamsItem
PackConnectionCustomMetadataParamsItem
PackConnectionCustomPatch
PackConnectionCustomPatch
PackConnectionCustomPatchParamsToPatchItem
PackConnectionCustomPatchParamsToPatchItem
PackConnectionGoogleServiceAccountCredentials
PackConnectionGoogleServiceAccountCredentials
PackConnectionGoogleServiceAccountMetadata
PackConnectionGoogleServiceAccountMetadata
PackConnectionGoogleServiceAccountPatch
PackConnectionGoogleServiceAccountPatch
PackConnectionGoogleServiceAccountPatchServiceAccountKey
PackConnectionGoogleServiceAccountPatchServiceAccountKey
PackConnectionHeaderCredentials
PackConnectionHeaderCredentials
PackConnectionHeaderMetadata
PackConnectionHeaderMetadata
PackConnectionHeaderPatch
PackConnectionHeaderPatch
PackConnectionHttpBasicCredentials
PackConnectionHttpBasicCredentials
PackConnectionHttpBasicMetadata
PackConnectionHttpBasicMetadata
PackConnectionHttpBasicPatch
PackConnectionHttpBasicPatch
PackConnectionMultiHeaderCredentials
PackConnectionMultiHeaderCredentials
PackConnectionMultiHeaderCredentialsTokensItem
PackConnectionMultiHeaderCredentialsTokensItem
PackConnectionMultiHeaderMetadata
PackConnectionMultiHeaderMetadata
PackConnectionMultiHeaderMetadataHeadersItem
PackConnectionMultiHeaderMetadataHeadersItem
PackConnectionMultiHeaderMetadataPresetsItem
PackConnectionMultiHeaderMetadataPresetsItem
PackConnectionMultiHeaderPatch
PackConnectionMultiHeaderPatch
PackConnectionMultiHeaderPatchTokensToPatchItem
PackConnectionMultiHeaderPatchTokensToPatchItem
PackConnectionOauth2ClientCredentials
PackConnectionOauth2ClientCredentials
PackConnectionOauth2ClientCredentialsClientId
PackConnectionOauth2ClientCredentialsClientId
PackConnectionOauth2ClientCredentialsClientSecret
PackConnectionOauth2ClientCredentialsClientSecret
PackConnectionOauth2ClientCredentialsMetadata
PackConnectionOauth2ClientCredentialsMetadata
PackConnectionOauth2ClientCredentialsPatch
PackConnectionOauth2ClientCredentialsPatch
PackConnectionOauth2ClientCredentialsPatchClientId
PackConnectionOauth2ClientCredentialsPatchClientId
PackConnectionOauth2ClientCredentialsPatchClientSecret
PackConnectionOauth2ClientCredentialsPatchClientSecret
PackConnectionUrlParamCredentials
PackConnectionUrlParamCredentials
PackConnectionUrlParamCredentialsParamsItem
PackConnectionUrlParamCredentialsParamsItem
PackConnectionUrlParamMetadata
PackConnectionUrlParamMetadata
PackConnectionUrlParamMetadataParamsItem
PackConnectionUrlParamMetadataParamsItem
PackConnectionUrlParamPatch
PackConnectionUrlParamPatch
PackConnectionUrlParamPatchParamsToPatchItem
PackConnectionUrlParamPatchParamsToPatchItem
PackCustomLog
Pack log generated by developer’s custom logging with context.logger.
PackDescription
The full description of the Pack.
PackFeaturedDoc
A Pack’s featured doc.
PackFeaturedDocRequestItem
Item representing a featured doc in the update Pack featured docs request.
PackFeaturedDocsResponse
List of a Pack’s featured docs.
PackFetcherLog
System logs of Pack calls to context.fetcher.
PackFetcherLogDetails
Details for pack fetcher logs
PackFormulaAnalyticsCollection
A collection of analytics for Coda Packs formulas over a date range.
PackFormulaAnalyticsItem
Analytics data for a Coda Pack formula.
PackFormulaAnalyticsMetrics
Analytics metrics for a Coda Pack formula.
PackFormulaIdentifier
PackFormulaIdentifier
PackGlobalPrincipal
PackGlobalPrincipal
PackImageFile
A Pack image file.
PackIngestionDebugLog
Pack log generated by an executing ingestion. Contains metadata helpful for debugging
PackIngestionLifecycleLog
Pack log generated by an executing ingestion.
PackInternalLog
Coda internal logs from the packs infrastructure. Only visible to Codans.
PackInvocationLog
System logs of the invocations of the Pack.
PackInvocationLogDetails
Details for pack invocation logs
PackInvocationLogDetailsResult
PackInvocationLogDetailsResult
PackInvocationLogError
Error info if this invocation resulted in an error.
PackListing
A Pack listing.
PackListingDescription
The full description of the Pack.
PackListingDetail
A detailed Pack listing.
PackListingDetailDescription
The full description of the Pack.
PackListingList
A list of Pack listings.
PackLogContext
Logging context that comes with a Pack log.
PackLogsList
List of Pack logs.
PackName
The name of the Pack.
PackOauthConfigMetadata
The Pack OAuth configuration metadata.
PackOrganizationAccessForCodaBrain
Describes restrictions that a user’s organization has placed on a pack for Coda Brain ingestions
PackOrganizationAccessForDocs
Describes restrictions that a user’s organization has placed on a pack
PackPermission
Metadata about a Pack permission.
PackPermissionList
List of Pack permissions.
PackRateLimit
Rate limit in Pack settings.
PackRelease
Details about a Pack release.
PackReleaseList
List of Pack releases.
PackShortDescription
A short version of the description of the Pack.
PackSourceCode
Details about a Pack’s source code.
PackSourceCodeInfo
Information indicating where to upload the Pack source code, and an endpoint to mark the upload as complete.
PackSourceCodeUploadCompleteRequest
Payload for noting a Pack source code upload is complete.
PackSourceCodeUploadCompleteResponse
Response for noting a Pack source code upload is complete.
PackSourceCodeUploadCompleteResponseCodaDetail
Detail about why this request was rejected.
PackSourceCodeUploadInfo
Information indicating where to upload the Pack source code, and an endpoint to mark the upload as complete.
PackSummary
Summary of a Pack.
PackSummaryDescription
The full description of the Pack.
PackSummaryList
List of Pack summaries.
PackSummaryName
The name of the Pack.
PackSummaryShortDescription
A short version of the description of the Pack.
PackSummarySupportEmail
A contact email for the Pack.
PackSupportEmail
A contact email for the Pack.
PackUserAccess
The access capabilities the current user has for this Pack.
PackUserPrincipal
PackUserPrincipal
PackVersion
Details about a Pack version.
PackVersionDiffs
Info about the diff between two Pack versions.
PackVersionDiffsFindingDetailsItem
PackVersionDiffsFindingDetailsItem
PackVersionList
List of Pack versions.
PackVersionUploadCompleteResponse
An HTTP error resulting from an unsuccessful request.
PackVersionUploadCompleteResponseCodaDetail
Detail about why this request was rejected.
PackVersionUploadInfo
Information indicating where to upload the Pack version definition.
PackWorkspacePrincipal
PackWorkspacePrincipal
Page
Metadata about a page.
PageAnalyticsCollection
List of analytics for pages within a Coda doc over a date range.
PageAnalyticsDetails
Metadata about a page relevant to analytics.
PageAnalyticsItem
Analytics data for a page within a Coda doc.
PageAnalyticsMetrics
Analytics metrics for a page within a Coda doc.
PageContent
Content for a page (canvas).
PageContentExportStatusResponse
Response when requesting the status of a page content export.
PageContentUpdate
Payload for updating the content of an existing page.
PageCreate
Payload for creating a new page in a doc.
PageList
List of pages.
PageReference
Reference to a page.
PageUpdate
Payload for updating a page.
PatchPackSystemConnectionResponse
An HTTP error resulting from an unsuccessful request.
PatchPackSystemConnectionResponseCodaDetail
Detail about why this request was rejected.
Permission
A specific permission granted to a principal.
PublishDocResponse
An HTTP error resulting from an unsuccessful request.
PublishingCategory
Info about a publishing category
PushButtonResponse
An HTTP error resulting from an unsuccessful request.
RegisterPackVersionRequest
Payload for registering a Pack version.
RegisterPackVersionResponse
An HTTP error resulting from an unsuccessful request.
ResolveBrowserLinkResponse
An HTTP error resulting from an unsuccessful request.
Row
Info about a row.
RowDetail
Details about a row.
RowEdit
An edit made to a particular row.
RowList
List of rows.
RowUpdate
Payload for updating a row in a table.
RowsDelete
Payload for deleting rows from a table.
RowsUpsert
Payload for upserting rows in a table.
SearchPrincipalsResponse
Metadata about the principals that match the given query.
SelectOption
An option for a select column.
SetPackOauthConfigRequest
Request to set the Pack OAuth configuration.
SetPackOauthConfigResponse
An HTTP error resulting from an unsuccessful request.
SetPackOauthConfigResponseCodaDetail
Detail about why this request was rejected.
SetPackSystemConnectionRequest
The request to set pack system connection credentials.
SetPackSystemConnectionResponse
An HTTP error resulting from an unsuccessful request.
SetPackSystemConnectionResponseCodaDetail
Detail about why this request was rejected.
SimpleColumnFormat
Format of a simple column.
Sort
A sort applied to a table or view.
StandardPackPlan
The Pack plan to show the Pack can be subscribed to at a monthly cost per Doc Maker or for free.
Table
Metadata about a table.
TableList
List of tables.
TableReference
Reference to a table or view.
TriggerWebhookAutomationResponse
An HTTP error resulting from an unsuccessful request.
UnpublishDocResponse
An HTTP error resulting from an unsuccessful request.
UnpublishResult
The result of unpublishing a doc.
UpdateAclSettingsRequest
Request to update ACL settings for a doc.
UpdateAclSettingsResponse
An HTTP error resulting from an unsuccessful request.
UpdateCustomDocDomainRequest
Payload for updating the properties of a custom published doc domain.
UpdateCustomDocDomainResponse
The result of updating a custom domain for a published doc.
UpdateDocResponse
An HTTP error resulting from an unsuccessful request.
UpdatePackFeaturedDocsRequest
Payload for updating featured docs for a Pack.
UpdatePackFeaturedDocsResponse
Confirmation of successful Pack featured docs update.
UpdatePackReleaseRequest
Payload for updating a new Pack release.
UpdatePackReleaseResponse
An HTTP error resulting from an unsuccessful request.
UpdatePackReleaseResponseCodaDetail
Detail about why this request was rejected.
UpdatePackRequest
Payload for updating a Pack.
UpdatePackRequestDescription
The full description of the Pack.
UpdatePackRequestExampleImagesItem
UpdatePackRequestExampleImagesItem
UpdatePackRequestName
The name of the Pack.
UpdatePackRequestOverallRateLimit
Rate limit in Pack settings.
UpdatePackRequestPerConnectionRateLimit
Rate limit in Pack settings.
UpdatePackRequestShortDescription
A short version of the description of the Pack.
UpdatePackRequestSupportEmail
A contact email for the Pack.
UpdatePackResponse
An HTTP error resulting from an unsuccessful request.
UpdatePageResponse
An HTTP error resulting from an unsuccessful request.
UpdateRowResponse
An HTTP error resulting from an unsuccessful request.
UploadPackAssetRequest
Payload for a Pack asset upload.
UploadPackAssetResponse
An HTTP error resulting from an unsuccessful request.
UploadPackAssetResponseCodaDetail
Detail about why this request was rejected.
UploadPackSourceCodeRequest
Payload for a Pack asset upload.
UploadPackSourceCodeResponse
An HTTP error resulting from an unsuccessful request.
UploadPackSourceCodeResponseCodaDetail
Detail about why this request was rejected.
UpsertRowsResponse
An HTTP error resulting from an unsuccessful request.
User
Info about the user.
UserSummary
Summary about the user.
ValidationError
Detail about why a particular field failed request validation.
WebhookTriggerPayload
Payload for webhook trigger
WhoamiResponse
An HTTP error resulting from an unsuccessful request.
Workspace
Metadata about a Coda workspace.
WorkspaceMembersList
Response for listing workspace users.
WorkspacePrincipal
WorkspacePrincipal
WorkspaceReference
Reference to a Coda workspace.
WorkspaceRoleActivity
Metadata for workspace role activity.
WorkspaceUser
Metadata of a workspace user.

Enums§

AccessType
Type of access.
AccessTypeNotNone
Type of access (excluding none).
AddedAnyonePrincipalType
The type of this principal.
AddedDomainPrincipalType
The type of this principal.
AddedEmailPrincipalType
The type of this principal.
AddedGroupPrincipalType
The type of this principal.
AddedPrincipal
Metadata about a principal to add to a doc.
AddedWorkspacePrincipalType
The type of this principal.
AnalyticsScale
Quantization period over which to view analytics.
AnyonePrincipalType
The type of this principal.
ApiLinkType
The type of this resource.
BundledPackPlanPricingType
BundledPackPlanPricingType
ButtonColumnFormat
ButtonColumnFormat
CellValue
All values that a row cell can contain.
CheckboxColumnFormat
CheckboxColumnFormat
CheckboxDisplayType
How a checkbox should be displayed.
ColumnDetailType
The type of this resource.
ColumnFormat
Format of a column.
ColumnFormatType
Format type of the column
ColumnReferenceType
The type of this resource.
ColumnType
The type of this resource.
ControlReferenceType
The type of this resource.
ControlType
The type of this resource.
ControlTypeEnum
Type of the control.
CurrencyAmount
A numeric monetary amount as a string or number.
CurrencyColumnFormat
CurrencyColumnFormat
CurrencyFormatType
How the numeric value should be formatted (with or without symbol, negative numbers in parens).
CurrencyValue
CurrencyValue
CustomDocDomainProvider
CustomDocDomainProvider
CustomDocDomainSetupStatus
CustomDocDomainSetupStatus
CustomDomainConnectedStatus
CustomDomainConnectedStatus
DateColumnFormat
DateColumnFormat
DateTimeColumnFormat
DateTimeColumnFormat
DocAnalyticsDetails
DocAnalyticsDetails
DocAnalyticsOrderBy
Determines how the Doc analytics returned are sorted.
DocPublishMode
Which interaction mode the published doc should use.
DocReferenceType
The type of this resource.
DocSourceDoc
DocSourceDoc
DocType
The type of this resource.
DocumentCreationResultSourceDoc
DocumentCreationResultSourceDoc
DocumentCreationResultType
The type of this resource.
DomainPrincipalType
The type of this principal.
DurationColumnFormat
DurationColumnFormat
DurationUnit
A time unit used as part of a duration value.
EmailColumnFormat
EmailColumnFormat
EmailDisplayType
How an email address should be displayed in the user interface.
EmailPrincipalType
The type of this principal.
FeatureSet
Only relevant for original Coda packs.
FeaturedDocStatus
Status of featured doc in pack listing.
FolderReferenceType
The type of this resource.
FormulaReferenceType
The type of this resource.
FormulaType
The type of this resource.
FreePackPlanPricingType
FreePackPlanPricingType
GroupPrincipalType
The type of this principal.
GroupedPackAuthLogType
GroupedPackAuthLogType
GroupedPackInvocationLogType
GroupedPackInvocationLogType
GroupedPackLog
A record of grouped Pack log.
IconSet
List of available icon sets.
ImageReferenceColumnFormat
ImageReferenceColumnFormat
ImageShapeStyle
How an image should be displayed.
ImageStatus
The status values that an image object can have.
ImageUrlValue
ImageUrlValue
IngestionChildExecutionType
Type of an ingestion childexecution.
IngestionExecutionType
Type of an ingestion batch execution.
IngestionPackReleaseChannel
Live or Latest version of pack
IngestionStatus
Status of the ingestion execution.
Layout
Layout type of the table or view.
LinkColumnFormat
LinkColumnFormat
LinkDisplayType
How a link should be displayed in the user interface.
LinkedDataType
A schema.org identifier for the object.
ListGroupedIngestionLogsOrder
ListGroupedIngestionLogsOrder
ListGroupedPackLogsOrder
ListGroupedPackLogsOrder
ListIngestionExecutionAttemptsOrder
ListIngestionExecutionAttemptsOrder
ListIngestionExecutionsOrder
ListIngestionExecutionsOrder
ListIngestionLogsOrder
ListIngestionLogsOrder
ListPackLogsOrder
ListPackLogsOrder
LogLevel
LogLevel
MonthlyDocMakerPackPlanPricingType
MonthlyDocMakerPackPlanPricingType
NumberOrNumberFormula
A number or a string representing a formula that evaluates to a number.
NumericColumnFormat
NumericColumnFormat
PackAccessType
PackAccessType
PackAnalyticsOrderBy
Determines how the Pack analytics returned are sorted.
PackAssetType
PackAssetType
PackAuthLogType
PackAuthLogType
PackConnectionAwsAccessKeyCredentialsType
PackConnectionAwsAccessKeyCredentialsType
PackConnectionAwsAccessKeyMetadataType
PackConnectionAwsAccessKeyMetadataType
PackConnectionAwsAccessKeyPatchType
PackConnectionAwsAccessKeyPatchType
PackConnectionAwsAssumeRoleCredentialsType
PackConnectionAwsAssumeRoleCredentialsType
PackConnectionAwsAssumeRoleMetadataType
PackConnectionAwsAssumeRoleMetadataType
PackConnectionAwsAssumeRolePatchType
PackConnectionAwsAssumeRolePatchType
PackConnectionCustomCredentialsType
PackConnectionCustomCredentialsType
PackConnectionCustomMetadataType
PackConnectionCustomMetadataType
PackConnectionCustomPatchType
PackConnectionCustomPatchType
PackConnectionGoogleServiceAccountCredentialsType
PackConnectionGoogleServiceAccountCredentialsType
PackConnectionGoogleServiceAccountMetadataType
PackConnectionGoogleServiceAccountMetadataType
PackConnectionGoogleServiceAccountPatchType
PackConnectionGoogleServiceAccountPatchType
PackConnectionHeaderCredentialsType
PackConnectionHeaderCredentialsType
PackConnectionHeaderMetadataType
PackConnectionHeaderMetadataType
PackConnectionHeaderPatchType
PackConnectionHeaderPatchType
PackConnectionHttpBasicCredentialsType
PackConnectionHttpBasicCredentialsType
PackConnectionHttpBasicMetadataType
PackConnectionHttpBasicMetadataType
PackConnectionHttpBasicPatchType
PackConnectionHttpBasicPatchType
PackConnectionMultiHeaderCredentialsType
PackConnectionMultiHeaderCredentialsType
PackConnectionMultiHeaderMetadataType
PackConnectionMultiHeaderMetadataType
PackConnectionMultiHeaderPatchType
PackConnectionMultiHeaderPatchType
PackConnectionOauth2ClientCredentialsMetadataType
PackConnectionOauth2ClientCredentialsMetadataType
PackConnectionOauth2ClientCredentialsPatchType
PackConnectionOauth2ClientCredentialsPatchType
PackConnectionOauth2ClientCredentialsType
PackConnectionOauth2ClientCredentialsType
PackConnectionType
Type of Pack connections.
PackConnectionUrlParamCredentialsType
PackConnectionUrlParamCredentialsType
PackConnectionUrlParamMetadataType
PackConnectionUrlParamMetadataType
PackConnectionUrlParamPatchType
PackConnectionUrlParamPatchType
PackCustomLogType
PackCustomLogType
PackDiscoverability
Widest principal a Pack is available to.
PackFetcherLogDetailsType
PackFetcherLogDetailsType
PackFetcherLogMethod
PackFetcherLogMethod
PackFetcherLogType
PackFetcherLogType
PackFormulaAnalyticsOrderBy
Determines how the Pack formula analytics returned are sorted.
PackFormulaType
PackFormulaType
PackGlobalPrincipalType
PackGlobalPrincipalType
PackIngestionDebugLogType
PackIngestionDebugLogType
PackIngestionLifecycleLogType
PackIngestionLifecycleLogType
PackInternalLogType
PackInternalLogType
PackInvocationLogDetailsType
PackInvocationLogDetailsType
PackInvocationLogType
PackInvocationLogType
PackListingInstallContextType
Type of context in which a Pack is being installed.
PackListingsSortBy
Determines how the Pack listings returned are sorted.
PackLog
A record of Pack log.
PackLogDetails
Details for a pack log.
PackLogRequestType
The context request type where a Pack log is generated.
PackLogType
PackLogType
PackOAuth2ClientCredentialsLocation
Location of including OAuth2 client credentials in a request.
PackPlanCurrency
Currency needed to subscribe to the Pack.
PackPlanPricingType
Type of pricing used to subscribe to a Pack.
PackPrincipal
Metadata about a Pack principal.
PackPrincipalType
Type of Pack permissions.
PackSource
PackSource
PackSourceCodeVisibility
Visibility of a pack’s source code.
PackSystemConnectionCredentials
Credentials of a Pack connection.
PackSystemConnectionMetadata
Metadata of a Pack system connection.
PackUserAccessOrganization
PackUserAccessOrganization
PackUserPrincipalType
PackUserPrincipalType
PackWorkspacePrincipalType
PackWorkspacePrincipalType
PacksSortBy
Determines how the Packs returned are sorted.
PageContentExportStatus
Status of a page content export.
PageContentFormat
Supported content types for page (canvas) content.
PageContentInsertionMode
Mode for inserting content into an existing page.
PageContentOutputFormat
Supported output content formats that can be requested for getting content for an existing page.
PageCreateContent
Content that can be added to a page at creation time, either text (or rich text) or a URL to create a full-page embed.
PageCreateContentVariant0Type
Indicates a page containing canvas content.
PageCreateContentVariant1Type
Indicates a page that embeds other content.
PageCreateContentVariant2Mode
Indicates a single-page sync page.
PageCreateContentVariant2Type
Indicates a page that embeds other Coda content.
PageCreateContentVariant3Mode
Indicates a full doc sync page.
PageCreateContentVariant3Type
Indicates a page that embeds other content.
PageCreateResult
PageCreateResult
PageDeleteResult
PageDeleteResult
PageEmbedRenderMethod
Render mode for a page using the Embed page type.
PageReferenceType
The type of this resource.
PageType
The type of this resource.
PageTypeEnum
The type of a page in a doc.
PageUpdateContentUpdate
PageUpdateContentUpdate
PageUpdateResult
PageUpdateResult
PaidFeatureSet
Workspace feature set excluding free.
PatchPackSystemConnectionRequest
The request to patch pack system connection credentials.
PersonValue
PersonValue
Principal
Metadata about a principal.
PrincipalType
Type of principal.
PublishResult
PublishResult
PushButtonResult
PushButtonResult
ReferenceColumnFormat
ReferenceColumnFormat
RichSingleValue
A value that contains rich structured data. Cell values are composed of these values or arrays of these values.
RichValue
A cell value that contains rich structured data.
RichValueVariant1Item
RichValueVariant1Item
RowDeleteResult
RowDeleteResult
RowDetailType
The type of this resource.
RowType
The type of this resource.
RowUpdateResult
RowUpdateResult
RowValue
RowValue
RowsDeleteResult
RowsDeleteResult
RowsSortBy
Determines how the rows returned are sorted
RowsUpsertResult
RowsUpsertResult
ScalarValue
A Coda result or entity expressed as a primitive type.
ScaleColumnFormat
ScaleColumnFormat
SelectColumnFormat
SelectColumnFormat
SliderColumnFormat
SliderColumnFormat
SliderDisplayType
How the slider should be rendered.
SortBy
Determines how the objects returned are sorted
SortDirection
Direction of a sort for a table or view.
StandardPackPlanPricing
Pricing to show how workspaces can subscribe to the Pack.
SyncPageTypeEnum
The type of sync page in a doc
TableFilter
TableFilter
TableReferenceType
The type of this resource.
TableType
The type of this resource.
TableTypeEnum
TableTypeEnum
TimeColumnFormat
TimeColumnFormat
Type
A constant identifying the type of the resource.
UrlValue
UrlValue
UserSummaryType
The type of this resource.
UserType
The type of this resource.
Value
A Coda result or entity expressed as a primitive type, or array of primitive types.
ValueFormat
The format that cell values are returned as.
ValueVariant0
ValueVariant0
ValueVariant1Item
ValueVariant1Item
WebhookTriggerResult
WebhookTriggerResult
WorkspacePrincipalType
The type of this principal.
WorkspaceReferenceType
The type of this resource.
WorkspaceType
The type of this resource.
WorkspaceUserRole
WorkspaceUserRole