Documentation
¶
Index ¶
- type BulkDeleteRowsInput
- type CreateDatabaseInput
- type CreateDatabaseOutput
- type CreateRowInput
- type CreateRowOutput
- type CreateViewInput
- type CreateViewOutput
- type DatabaseItem
- type DatabasePermissionItem
- type DeleteDatabaseInput
- type DeleteDatabasePermissionInput
- type DeleteRowInput
- type DeleteViewInput
- type GetDatabaseInput
- type GetDatabaseOutput
- type GetRowInput
- type GetRowOutput
- type ListDatabasePermissionsInput
- type ListDatabasePermissionsOutput
- type ListDatabasesInput
- type ListDatabasesOutput
- type ListRowsInput
- type ListRowsOutput
- type MoveDatabaseInput
- type MoveDatabaseOutput
- type PropertySchema
- type RowItem
- type SearchDatabaseResultItem
- type SearchDatabasesInput
- type SearchDatabasesOutput
- type SortConfig
- type UpdateDatabaseInput
- type UpdateRowInput
- type UpdateViewInput
- type UpsertDatabasePermissionInput
- type UserInfo
- type ViewConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BulkDeleteRowsInput ¶
type CreateDatabaseInput ¶
type CreateDatabaseInput struct {
UserId string
SpaceId string
DocumentId *string
Name string
Description string
Icon string
Schema []PropertySchema
Type string // "spreadsheet" or "document", defaults to "spreadsheet"
}
Create database
type CreateDatabaseOutput ¶
type CreateRowInput ¶
type CreateRowInput struct {
UserId string
DatabaseId string
Properties map[string]interface{}
Content map[string]interface{}
ShowInSidebar bool
}
Row operations
type CreateRowOutput ¶
type CreateViewInput ¶
type CreateViewInput struct {
UserId string
DatabaseId string
Name string
Type string
Filter map[string]interface{}
Sort []SortConfig
Columns []string
}
Create view
type CreateViewOutput ¶
type DatabaseItem ¶
type DatabasePermissionItem ¶
type DatabasePermissionItem struct {
Id string `json:"id"`
UserId *string `json:"user_id,omitempty"`
Username *string `json:"username,omitempty"`
GroupId *string `json:"group_id,omitempty"`
GroupName *string `json:"group_name,omitempty"`
Role string `json:"role"`
}
Permission item for listing
type DeleteDatabaseInput ¶
Delete database
type DeleteDatabasePermissionInput ¶
type DeleteDatabasePermissionInput struct {
UserId string // The user making the request
DatabaseId string // The database
TargetUserId *string // The user to remove permission from (mutually exclusive with GroupId)
GroupId *string // The group to remove permission from (mutually exclusive with TargetUserId)
}
Delete permission
type DeleteRowInput ¶
type DeleteViewInput ¶
Delete view
type GetDatabaseInput ¶
Get database
type GetDatabaseOutput ¶
type GetRowInput ¶
type GetRowOutput ¶
type ListDatabasePermissionsInput ¶
List permissions
type ListDatabasePermissionsOutput ¶
type ListDatabasePermissionsOutput struct {
Permissions []DatabasePermissionItem `json:"permissions"`
}
type ListDatabasesInput ¶
List databases
type ListDatabasesOutput ¶
type ListDatabasesOutput struct {
Databases []DatabaseItem
}
type ListRowsInput ¶
type ListRowsOutput ¶
type MoveDatabaseInput ¶
type MoveDatabaseInput struct {
UserId string
DatabaseId string
DocumentId *string // nil = move to root (no parent document)
}
Move database
type MoveDatabaseOutput ¶
type PropertySchema ¶
type PropertySchema struct {
Id string `json:"id"`
Name string `json:"name"`
Type string `json:"type"`
Options map[string]interface{} `json:"options,omitempty"`
}
Property schema
type SearchDatabasesInput ¶
Search databases
type SearchDatabasesOutput ¶
type SearchDatabasesOutput struct {
Results []SearchDatabaseResultItem
}
type SortConfig ¶
type UpdateDatabaseInput ¶
type UpdateDatabaseInput struct {
UserId string
DatabaseId string
Name *string
Description *string
Icon *string
Schema *[]PropertySchema
DefaultView *string
}
Update database
type UpdateRowInput ¶
type UpdateViewInput ¶
type UpdateViewInput struct {
UserId string
DatabaseId string
ViewId string
Name *string
Type *string
Filter map[string]interface{}
Sort []SortConfig
Columns []string
HiddenColumns []string
GroupBy *string
}
Update view
type UpsertDatabasePermissionInput ¶
type UpsertDatabasePermissionInput struct {
UserId string // The user making the request
DatabaseId string // The database to add permission to
TargetUserId *string // The user to add permission for (mutually exclusive with GroupId)
GroupId *string // The group to add permission for (mutually exclusive with TargetUserId)
Role string // editor, viewer, denied
}
Upsert permission
type ViewConfig ¶
type ViewConfig struct {
Id string `json:"id"`
Name string `json:"name"`
Type string `json:"type"`
Filter map[string]interface{} `json:"filter,omitempty"`
Sort []SortConfig `json:"sort,omitempty"`
Columns []string `json:"columns,omitempty"`
HiddenColumns []string `json:"hidden_columns,omitempty"`
GroupBy string `json:"group_by,omitempty"`
}
View configuration
Click to show internal directories.
Click to hide internal directories.