package
1.0.4
Repository: https://github.com/artsafin/coda-go-client.git
Documentation: pkg.go.dev

# Functions

NewAddPermissionRequest calls the generic AddPermission builder with application/json body.
NewAddPermissionRequestWithBody generates requests for AddPermission with any type of body.
NewChangeUserRoleRequest calls the generic ChangeUserRole builder with application/json body.
NewChangeUserRoleRequestWithBody generates requests for ChangeUserRole with any type of body.
Creates a new Client, with reasonable defaults.
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling.
NewCreateDocRequest calls the generic CreateDoc builder with application/json body.
NewCreateDocRequestWithBody generates requests for CreateDoc with any type of body.
NewDeleteDocRequest generates requests for DeleteDoc.
NewDeletePermissionRequest generates requests for DeletePermission.
NewDeleteRowRequest generates requests for DeleteRow.
NewDeleteRowsRequest calls the generic DeleteRows builder with application/json body.
NewDeleteRowsRequestWithBody generates requests for DeleteRows with any type of body.
NewGetColumnRequest generates requests for GetColumn.
NewGetControlRequest generates requests for GetControl.
NewGetDocRequest generates requests for GetDoc.
NewGetFormulaRequest generates requests for GetFormula.
NewGetMutationStatusRequest generates requests for GetMutationStatus.
NewGetPageRequest generates requests for GetPage.
NewGetPermissionsRequest generates requests for GetPermissions.
NewGetRowRequest generates requests for GetRow.
NewGetSharingMetadataRequest generates requests for GetSharingMetadata.
NewGetTableRequest generates requests for GetTable.
NewListCategoriesRequest generates requests for ListCategories.
NewListColumnsRequest generates requests for ListColumns.
NewListControlsRequest generates requests for ListControls.
NewListDocAnalyticsRequest generates requests for ListDocAnalytics.
NewListDocsRequest generates requests for ListDocs.
NewListFormulasRequest generates requests for ListFormulas.
NewListPagesRequest generates requests for ListPages.
NewListRowsRequest generates requests for ListRows.
NewListTablesRequest generates requests for ListTables.
NewListWorkspaceMembersRequest generates requests for ListWorkspaceMembers.
NewListWorkspaceRoleActivityRequest generates requests for ListWorkspaceRoleActivity.
NewPublishDocRequest calls the generic PublishDoc builder with application/json body.
NewPublishDocRequestWithBody generates requests for PublishDoc with any type of body.
NewPushButtonRequest generates requests for PushButton.
NewResolveBrowserLinkRequest generates requests for ResolveBrowserLink.
NewUnpublishDocRequest generates requests for UnpublishDoc.
NewUpdatePageRequest calls the generic UpdatePage builder with application/json body.
NewUpdatePageRequestWithBody generates requests for UpdatePage with any type of body.
NewUpdateRowRequest calls the generic UpdateRow builder with application/json body.
NewUpdateRowRequestWithBody generates requests for UpdateRow with any type of body.
NewUpsertRowsRequest calls the generic UpsertRows builder with application/json body.
NewUpsertRowsRequestWithBody generates requests for UpsertRows with any type of body.
NewWhoamiRequest generates requests for Whoami.
ParseAddPermissionResponse parses an HTTP response from a AddPermissionWithResponse call.
ParseChangeUserRoleResponse parses an HTTP response from a ChangeUserRoleWithResponse call.
ParseCreateDocResponse parses an HTTP response from a CreateDocWithResponse call.
ParseDeleteDocResponse parses an HTTP response from a DeleteDocWithResponse call.
ParseDeletePermissionResponse parses an HTTP response from a DeletePermissionWithResponse call.
ParseDeleteRowResponse parses an HTTP response from a DeleteRowWithResponse call.
ParseDeleteRowsResponse parses an HTTP response from a DeleteRowsWithResponse call.
ParseGetColumnResponse parses an HTTP response from a GetColumnWithResponse call.
ParseGetControlResponse parses an HTTP response from a GetControlWithResponse call.
ParseGetDocResponse parses an HTTP response from a GetDocWithResponse call.
ParseGetFormulaResponse parses an HTTP response from a GetFormulaWithResponse call.
ParseGetMutationStatusResponse parses an HTTP response from a GetMutationStatusWithResponse call.
ParseGetPageResponse parses an HTTP response from a GetPageWithResponse call.
ParseGetPermissionsResponse parses an HTTP response from a GetPermissionsWithResponse call.
ParseGetRowResponse parses an HTTP response from a GetRowWithResponse call.
ParseGetSharingMetadataResponse parses an HTTP response from a GetSharingMetadataWithResponse call.
ParseGetTableResponse parses an HTTP response from a GetTableWithResponse call.
ParseListCategoriesResponse parses an HTTP response from a ListCategoriesWithResponse call.
ParseListColumnsResponse parses an HTTP response from a ListColumnsWithResponse call.
ParseListControlsResponse parses an HTTP response from a ListControlsWithResponse call.
ParseListDocAnalyticsResponse parses an HTTP response from a ListDocAnalyticsWithResponse call.
ParseListDocsResponse parses an HTTP response from a ListDocsWithResponse call.
ParseListFormulasResponse parses an HTTP response from a ListFormulasWithResponse call.
ParseListPagesResponse parses an HTTP response from a ListPagesWithResponse call.
ParseListRowsResponse parses an HTTP response from a ListRowsWithResponse call.
ParseListTablesResponse parses an HTTP response from a ListTablesWithResponse call.
ParseListWorkspaceMembersResponse parses an HTTP response from a ListWorkspaceMembersWithResponse call.
ParseListWorkspaceRoleActivityResponse parses an HTTP response from a ListWorkspaceRoleActivityWithResponse call.
ParsePublishDocResponse parses an HTTP response from a PublishDocWithResponse call.
ParsePushButtonResponse parses an HTTP response from a PushButtonWithResponse call.
ParseResolveBrowserLinkResponse parses an HTTP response from a ResolveBrowserLinkWithResponse call.
ParseUnpublishDocResponse parses an HTTP response from a UnpublishDocWithResponse call.
ParseUpdatePageResponse parses an HTTP response from a UpdatePageWithResponse call.
ParseUpdateRowResponse parses an HTTP response from a UpdateRowWithResponse call.
ParseUpsertRowsResponse parses an HTTP response from a UpsertRowsWithResponse call.
ParseWhoamiResponse parses an HTTP response from a WhoamiWithResponse call.
WithBaseURL overrides the baseURL.
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client.
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request.

# Constants

Defines values for AccessType.
Defines values for AccessType.
Defines values for AccessType.
Defines values for AccessType.
Defines values for ApiLinkType.
No description provided by the author
Defines values for ColumnDetailType.
Defines values for ColumnFormatType.
Defines values for ColumnFormatType.
Defines values for ColumnFormatType.
Defines values for ColumnFormatType.
Defines values for ColumnFormatType.
Defines values for ColumnFormatType.
Defines values for ColumnFormatType.
Defines values for ColumnFormatType.
Defines values for ColumnFormatType.
Defines values for ColumnFormatType.
Defines values for ColumnFormatType.
Defines values for ColumnFormatType.
Defines values for ColumnFormatType.
Defines values for ColumnFormatType.
Defines values for ColumnFormatType.
Defines values for ColumnFormatType.
Defines values for ColumnFormatType.
Defines values for ColumnFormatType.
Defines values for ColumnFormatType.
Defines values for ColumnFormatType.
Defines values for ColumnFormatType.
Defines values for ColumnFormatType.
Defines values for ColumnFormatType.
Defines values for ColumnReferenceType.
Defines values for ColumnType.
Defines values for ControlReferenceType.
Defines values for ControlType.
Defines values for CurrencyFormatType.
Defines values for CurrencyFormatType.
Defines values for CurrencyFormatType.
Defines values for DocAnalyticsScale.
Defines values for DocAnalyticsScale.
Defines values for DocPublishMode.
Defines values for DocPublishMode.
Defines values for DocPublishMode.
Defines values for DocReferenceType.
Defines values for DocType.
Defines values for DocumentCreationResultType.
Defines values for DurationUnit.
Defines values for DurationUnit.
Defines values for DurationUnit.
Defines values for DurationUnit.
Defines values for EmailDisplayType.
Defines values for EmailDisplayType.
Defines values for EmailDisplayType.
Defines values for FolderReferenceType.
Defines values for FormulaReferenceType.
Defines values for FormulaType.
Defines values for IconSet.
Defines values for IconSet.
Defines values for IconSet.
Defines values for IconSet.
Defines values for IconSet.
Defines values for IconSet.
Defines values for IconSet.
Defines values for IconSet.
Defines values for IconSet.
Defines values for IconSet.
Defines values for IconSet.
Defines values for IconSet.
Defines values for IconSet.
Defines values for IconSet.
Defines values for IconSet.
Defines values for IconSet.
Defines values for IconSet.
Defines values for IconSet.
Defines values for IconSet.
Defines values for IconSet.
Defines values for ImageStatus.
Defines values for ImageStatus.
Defines values for ImageStatus.
Defines values for Layout.
Defines values for Layout.
Defines values for Layout.
Defines values for Layout.
Defines values for Layout.
Defines values for Layout.
Defines values for Layout.
Defines values for Layout.
Defines values for Layout.
Defines values for Layout.
Defines values for Layout.
Defines values for Layout.
Defines values for Layout.
Defines values for Layout.
Defines values for Layout.
Defines values for LinkDisplayType.
Defines values for LinkDisplayType.
Defines values for LinkDisplayType.
Defines values for LinkDisplayType.
Defines values for LinkDisplayType.
Defines values for LinkedDataType.
Defines values for LinkedDataType.
Defines values for LinkedDataType.
Defines values for LinkedDataType.
Defines values for LinkedDataType.
Defines values for PageReferenceType.
Defines values for PageType.
Defines values for PrincipalType.
Defines values for PrincipalType.
Defines values for PrincipalType.
Defines values for RowDetailType.
Defines values for RowsSortBy.
Defines values for RowsSortBy.
Defines values for RowsSortBy.
Defines values for RowType.
Defines values for RowValueAdditionalType.
Defines values for SortBy.
Defines values for SortDirection.
Defines values for SortDirection.
Defines values for TableReferenceType.
Defines values for TableType.
Defines values for Type.
Defines values for Type.
Defines values for Type.
Defines values for Type.
Defines values for Type.
Defines values for Type.
Defines values for Type.
Defines values for Type.
Defines values for Type.
Defines values for Type.
Defines values for Type.
Defines values for Type.
Defines values for Type.
Defines values for Type.
Defines values for Type.
Defines values for Type.
Defines values for Type.
Defines values for Type.
Defines values for Type.
Defines values for Type.
Defines values for Type.
Defines values for Type.
Defines values for Type.
Defines values for Type.
Defines values for Type.
Defines values for Type.
Defines values for UserType.
Defines values for ValueFormat.
Defines values for ValueFormat.
Defines values for ValueFormat.
Defines values for WorkspaceReferenceType.
Defines values for WorkspaceUserRole.
Defines values for WorkspaceUserRole.
Defines values for WorkspaceUserRole.

# Variables

No description provided by the author

# Structs

List of Permissions.
Doc level metadata associated with ACL.
Payload for granting a new permission.
No description provided by the author
AnyonePrincipal defines model for AnyonePrincipal.
Info about a resolved link to an API resource.
Reference to the resolved resource.
An HTTP error resulting from an unsuccessful request.
ButtonColumnFormat defines model for ButtonColumnFormat.
An edit made to a particular cell in a row.
Parameters for changing a workspace user role.
The result of changing a user's workspace user role.
No description provided by the author
Client which conforms to the OpenAPI3 specification for this service.
ClientWithResponses builds on ClientInterface to offer response payloads.
Info about a column.
Info about a column.
List of columns.
Reference to a column.
Details about a control.
List of controls.
Reference to a control.
No description provided by the author
CurrencyColumnFormat defines model for CurrencyColumnFormat.
CurrencyValue defines model for CurrencyValue.
DateColumnFormat defines model for DateColumnFormat.
DateTimeColumnFormat defines model for DateTimeColumnFormat.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Metadata about a Coda doc.
List of analytics for Coda docs over a date range.
Analytics data for a Coda doc.
The category applied to a doc.
A list of categories that can be applied to a doc.
Payload for creating a new doc.
List of Coda docs.
Payload for publishing a doc or or updating its publishing information.
Information about the publishing state of the document.
Reference to a Coda doc.
The number of components within a Coda doc.
The result of a doc creation.
Base response type for an operation that mutates a document.
DomainPrincipal defines model for DomainPrincipal.
DurationColumnFormat defines model for DurationColumnFormat.
EmailColumnFormat defines model for EmailColumnFormat.
EmailPrincipal defines model for EmailPrincipal.
Reference to a Coda folder.
An HTTP error resulting from an unsuccessful request.
Details about a formula.
Detailed information about a formula.
List of formulas.
Reference to a formula.
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
GetPermissionsParams defines parameters for GetPermissions.
No description provided by the author
GetRowParams defines parameters for GetRow.
No description provided by the author
No description provided by the author
GetTableParams defines parameters for GetTable.
No description provided by the author
Response for getting workspace role activity.
An HTTP error resulting from an unsuccessful request.
Info about the icon.
Info about the image.
ImageUrlValue defines model for ImageUrlValue.
LinkColumnFormat defines model for LinkColumnFormat.
Base type for a JSON-LD (Linked Data) object.
No description provided by the author
ListColumnsParams defines parameters for ListColumns.
No description provided by the author
ListControlsParams defines parameters for ListControls.
No description provided by the author
ListDocAnalyticsParams defines parameters for ListDocAnalytics.
No description provided by the author
ListDocsParams defines parameters for ListDocs.
No description provided by the author
ListFormulasParams defines parameters for ListFormulas.
No description provided by the author
ListPagesParams defines parameters for ListPages.
No description provided by the author
ListRowsParams defines parameters for ListRows.
No description provided by the author
ListTablesParams defines parameters for ListTables.
No description provided by the author
ListWorkspaceMembersParams defines parameters for ListWorkspaceMembers.
No description provided by the author
No description provided by the author
The status of an asynchronous mutation.
An HTTP error resulting from an unsuccessful request.
NumericColumnFormat defines model for NumericColumnFormat.
Metadata about a page.
List of pages.
Reference to a page.
Payload for updating a page.
PageUpdateResult defines model for PageUpdateResult.
A specific premission granted to a principal.
PersonValue defines model for PersonValue.
No description provided by the author
PublishResult defines model for PublishResult.
No description provided by the author
PushButtonResult defines model for PushButtonResult.
ReferenceColumnFormat defines model for ReferenceColumnFormat.
ResolveBrowserLinkParams defines parameters for ResolveBrowserLink.
No description provided by the author
Info about a row.
Values for a specific row, represented as a hash of column IDs (or names with `useColumnNames`) to values.
RowDeleteResult defines model for RowDeleteResult.
Details about a row.
Values for a specific row, represented as a hash of column IDs (or names with `useColumnNames`) to values.
An edit made to a particular row.
List of rows.
Payload for deleting rows from a table.
RowsDeleteResult defines model for RowsDeleteResult.
Payload for upserting rows in a table.
RowsUpsertResult defines model for RowsUpsertResult.
Payload for updating a row in a table.
RowUpdateResult defines model for RowUpdateResult.
RowValue defines model for RowValue.
ScaleColumnFormat defines model for ScaleColumnFormat.
Format of a simple column.
SliderColumnFormat defines model for SliderColumnFormat.
A sort applied to a table or view.
Metadata about a table.
List of tables.
Reference to a table or view.
TimeColumnFormat defines model for TimeColumnFormat.
An HTTP error resulting from an unsuccessful request.
An HTTP error resulting from an unsuccessful request.
No description provided by the author
No description provided by the author
UpdateRowParams defines parameters for UpdateRow.
No description provided by the author
UpsertRowsParams defines parameters for UpsertRows.
No description provided by the author
UrlValue defines model for UrlValue.
Info about the user.
No description provided by the author
Response for listing workspace users.
Reference to a Coda workspace.
Metadata for workspace role activity.
Metadata of a workspace user.

# Interfaces

All values that a row cell can contain.
The interface specification for the client above.
ClientWithResponsesInterface is the interface specification for the client with responses above.
Format of a column.
A numeric monetary amount as a string or number.
Doer performs HTTP requests.
A number or a string representing a formula that evaluates to a number.
Metadata about a principal.
A value that contains rich structured data.
A cell value that contains rich structured data.
A Coda result or entity expressed as a primitive type.
A Coda result or entity expressed as a primitive type, or array of primitive types.

# Type aliases

Type of access.
AddPermissionJSONBody defines parameters for AddPermission.
AddPermissionJSONRequestBody defines body for AddPermission for application/json ContentType.
The result of sharing a doc.
The type of this resource.
ChangeUserRoleJSONBody defines parameters for ChangeUserRole.
ChangeUserRoleJSONRequestBody defines body for ChangeUserRole for application/json ContentType.
ClientOption allows setting custom parameters during construction.
The type of this resource.
Format type of the column.
ColumnIdOrName defines model for columnIdOrName.
The type of this resource.
The type of this resource.
ControlIdOrName defines model for controlIdOrName.
The type of this resource.
The type of this resource.
CreateDocJSONBody defines parameters for CreateDoc.
CreateDocJSONRequestBody defines body for CreateDoc for application/json ContentType.
How the numeric value should be formatted (with or without symbol, negative numbers in parens).
The result of deleting a permission.
DeleteRowsJSONBody defines parameters for DeleteRows.
DeleteRowsJSONRequestBody defines body for DeleteRows for application/json ContentType.
Quantization period over which to view analytics.
The result of a doc deletion.
DocId defines model for docId.
A time unit used as part of a duration value.
The type of this resource.
The type of this resource.
The type of this resource.
A time unit used as part of a duration value.
How an email address should be displayed in the user interface.
The type of this resource.
FormulaIdOrName defines model for formulaIdOrName.
The type of this resource.
The type of this resource.
List of available icon sets.
The status values that an image object can have.
Layout type of the table or view.
Limit defines model for limit.
How a link should be displayed in the user interface.
A schema.org identifier for the object.
No description provided by the author
If specified, a link that can be used to fetch the next page of results.
If specified, an opaque token used to fetch the next page of results.
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.
PageIdOrName defines model for pageIdOrName.
The type of this resource.
PageToken defines model for pageToken.
The type of this resource.
PermissionId defines model for permissionId.
Type of principal.
PublishDocJSONBody defines parameters for PublishDoc.
PublishDocJSONRequestBody defines body for PublishDoc for application/json ContentType.
RequestEditorFn is the function signature for the RequestEditor callback function.
RequestId defines model for requestId.
The type of this resource.
RowIdOrName defines model for rowIdOrName.
Determines how the rows returned are sorted.
The type of this resource.
The type of this resource.
Determines how the objects returned are sorted.
Direction of a sort for a table or view.
SyncToken defines model for syncToken.
TableIdOrName defines model for tableIdOrName.
The type of this resource.
The type of this resource.
TableTypes defines model for tableTypes.
A constant identifying the type of the resource.
The result of unpublishing a doc.
UpdatePageJSONBody defines parameters for UpdatePage.
UpdatePageJSONRequestBody defines body for UpdatePage for application/json ContentType.
UpdateRowJSONBody defines parameters for UpdateRow.
UpdateRowJSONRequestBody defines body for UpdateRow for application/json ContentType.
UpsertRowsJSONBody defines parameters for UpsertRows.
UpsertRowsJSONRequestBody defines body for UpsertRows for application/json ContentType.
UseColumnNames defines model for useColumnNames.
The type of this resource.
The format that cell values are returned as.
WorkspaceId defines model for workspaceId.
The type of this resource.
WorkspaceUserRole defines model for WorkspaceUserRole.