node-appwrite
Version:
Appwrite is an open-source self-hosted backend server that abstracts and simplifies complex and repetitive development tasks behind a very simple REST API
1,997 lines (1,995 loc) • 103 kB
text/typescript
import { DatabaseType } from './enums/database-type.mjs';
import { AttributeStatus } from './enums/attribute-status.mjs';
import { ColumnStatus } from './enums/column-status.mjs';
import { IndexStatus } from './enums/index-status.mjs';
import { DeploymentStatus } from './enums/deployment-status.mjs';
import { ExecutionTrigger } from './enums/execution-trigger.mjs';
import { ExecutionStatus } from './enums/execution-status.mjs';
import { HealthAntivirusStatus } from './enums/health-antivirus-status.mjs';
import { HealthCheckStatus } from './enums/health-check-status.mjs';
import { MessageStatus } from './enums/message-status.mjs';
/**
* Appwrite Models
*/
declare namespace Models {
const __default: unique symbol;
/**
* Rows List
*/
export type RowList<Row extends Models.Row = Models.DefaultRow> = {
/**
* Total number of rows that matched your query.
*/
total: number;
/**
* List of rows.
*/
rows: Row[];
};
/**
* Documents List
*/
export type DocumentList<Document extends Models.Document = Models.DefaultDocument> = {
/**
* Total number of documents that matched your query.
*/
total: number;
/**
* List of documents.
*/
documents: Document[];
};
/**
* Tables List
*/
export type TableList = {
/**
* Total number of tables that matched your query.
*/
total: number;
/**
* List of tables.
*/
tables: Table[];
};
/**
* Collections List
*/
export type CollectionList = {
/**
* Total number of collections that matched your query.
*/
total: number;
/**
* List of collections.
*/
collections: Collection[];
};
/**
* Databases List
*/
export type DatabaseList = {
/**
* Total number of databases that matched your query.
*/
total: number;
/**
* List of databases.
*/
databases: Database[];
};
/**
* Indexes List
*/
export type IndexList = {
/**
* Total number of indexes that matched your query.
*/
total: number;
/**
* List of indexes.
*/
indexes: Index[];
};
/**
* Column Indexes List
*/
export type ColumnIndexList = {
/**
* Total number of indexes that matched your query.
*/
total: number;
/**
* List of indexes.
*/
indexes: ColumnIndex[];
};
/**
* Users List
*/
export type UserList<Preferences extends Models.Preferences = Models.DefaultPreferences> = {
/**
* Total number of users that matched your query.
*/
total: number;
/**
* List of users.
*/
users: User<Preferences>[];
};
/**
* Sessions List
*/
export type SessionList = {
/**
* Total number of sessions that matched your query.
*/
total: number;
/**
* List of sessions.
*/
sessions: Session[];
};
/**
* Identities List
*/
export type IdentityList = {
/**
* Total number of identities that matched your query.
*/
total: number;
/**
* List of identities.
*/
identities: Identity[];
};
/**
* Logs List
*/
export type LogList = {
/**
* Total number of logs that matched your query.
*/
total: number;
/**
* List of logs.
*/
logs: Log[];
};
/**
* Files List
*/
export type FileList = {
/**
* Total number of files that matched your query.
*/
total: number;
/**
* List of files.
*/
files: File[];
};
/**
* Buckets List
*/
export type BucketList = {
/**
* Total number of buckets that matched your query.
*/
total: number;
/**
* List of buckets.
*/
buckets: Bucket[];
};
/**
* Resource Tokens List
*/
export type ResourceTokenList = {
/**
* Total number of tokens that matched your query.
*/
total: number;
/**
* List of tokens.
*/
tokens: ResourceToken[];
};
/**
* Teams List
*/
export type TeamList<Preferences extends Models.Preferences = Models.DefaultPreferences> = {
/**
* Total number of teams that matched your query.
*/
total: number;
/**
* List of teams.
*/
teams: Team<Preferences>[];
};
/**
* Memberships List
*/
export type MembershipList = {
/**
* Total number of memberships that matched your query.
*/
total: number;
/**
* List of memberships.
*/
memberships: Membership[];
};
/**
* Sites List
*/
export type SiteList = {
/**
* Total number of sites that matched your query.
*/
total: number;
/**
* List of sites.
*/
sites: Site[];
};
/**
* Functions List
*/
export type FunctionList = {
/**
* Total number of functions that matched your query.
*/
total: number;
/**
* List of functions.
*/
functions: Function[];
};
/**
* Frameworks List
*/
export type FrameworkList = {
/**
* Total number of frameworks that matched your query.
*/
total: number;
/**
* List of frameworks.
*/
frameworks: Framework[];
};
/**
* Runtimes List
*/
export type RuntimeList = {
/**
* Total number of runtimes that matched your query.
*/
total: number;
/**
* List of runtimes.
*/
runtimes: Runtime[];
};
/**
* Deployments List
*/
export type DeploymentList = {
/**
* Total number of deployments that matched your query.
*/
total: number;
/**
* List of deployments.
*/
deployments: Deployment[];
};
/**
* Executions List
*/
export type ExecutionList = {
/**
* Total number of executions that matched your query.
*/
total: number;
/**
* List of executions.
*/
executions: Execution[];
};
/**
* Countries List
*/
export type CountryList = {
/**
* Total number of countries that matched your query.
*/
total: number;
/**
* List of countries.
*/
countries: Country[];
};
/**
* Continents List
*/
export type ContinentList = {
/**
* Total number of continents that matched your query.
*/
total: number;
/**
* List of continents.
*/
continents: Continent[];
};
/**
* Languages List
*/
export type LanguageList = {
/**
* Total number of languages that matched your query.
*/
total: number;
/**
* List of languages.
*/
languages: Language[];
};
/**
* Currencies List
*/
export type CurrencyList = {
/**
* Total number of currencies that matched your query.
*/
total: number;
/**
* List of currencies.
*/
currencies: Currency[];
};
/**
* Phones List
*/
export type PhoneList = {
/**
* Total number of phones that matched your query.
*/
total: number;
/**
* List of phones.
*/
phones: Phone[];
};
/**
* Variables List
*/
export type VariableList = {
/**
* Total number of variables that matched your query.
*/
total: number;
/**
* List of variables.
*/
variables: Variable[];
};
/**
* Status List
*/
export type HealthStatusList = {
/**
* Total number of statuses that matched your query.
*/
total: number;
/**
* List of statuses.
*/
statuses: HealthStatus[];
};
/**
* Locale codes list
*/
export type LocaleCodeList = {
/**
* Total number of localeCodes that matched your query.
*/
total: number;
/**
* List of localeCodes.
*/
localeCodes: LocaleCode[];
};
/**
* Provider list
*/
export type ProviderList = {
/**
* Total number of providers that matched your query.
*/
total: number;
/**
* List of providers.
*/
providers: Provider[];
};
/**
* Message list
*/
export type MessageList = {
/**
* Total number of messages that matched your query.
*/
total: number;
/**
* List of messages.
*/
messages: Message[];
};
/**
* Topic list
*/
export type TopicList = {
/**
* Total number of topics that matched your query.
*/
total: number;
/**
* List of topics.
*/
topics: Topic[];
};
/**
* Subscriber list
*/
export type SubscriberList = {
/**
* Total number of subscribers that matched your query.
*/
total: number;
/**
* List of subscribers.
*/
subscribers: Subscriber[];
};
/**
* Target list
*/
export type TargetList = {
/**
* Total number of targets that matched your query.
*/
total: number;
/**
* List of targets.
*/
targets: Target[];
};
/**
* Transaction List
*/
export type TransactionList = {
/**
* Total number of transactions that matched your query.
*/
total: number;
/**
* List of transactions.
*/
transactions: Transaction[];
};
/**
* Specifications List
*/
export type SpecificationList = {
/**
* Total number of specifications that matched your query.
*/
total: number;
/**
* List of specifications.
*/
specifications: Specification[];
};
/**
* Database
*/
export type Database = {
/**
* Database ID.
*/
$id: string;
/**
* Database name.
*/
name: string;
/**
* Database creation date in ISO 8601 format.
*/
$createdAt: string;
/**
* Database update date in ISO 8601 format.
*/
$updatedAt: string;
/**
* If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys.
*/
enabled: boolean;
/**
* Database type.
*/
type: DatabaseType;
};
/**
* Collection
*/
export type Collection = {
/**
* Collection ID.
*/
$id: string;
/**
* Collection creation date in ISO 8601 format.
*/
$createdAt: string;
/**
* Collection update date in ISO 8601 format.
*/
$updatedAt: string;
/**
* Collection permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
*/
$permissions: string[];
/**
* Database ID.
*/
databaseId: string;
/**
* Collection name.
*/
name: string;
/**
* Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys.
*/
enabled: boolean;
/**
* Whether document-level permissions are enabled. [Learn more about permissions](https://appwrite.io/docs/permissions).
*/
documentSecurity: boolean;
/**
* Collection attributes.
*/
attributes: (Models.AttributeBoolean | Models.AttributeInteger | Models.AttributeFloat | Models.AttributeEmail | Models.AttributeEnum | Models.AttributeUrl | Models.AttributeIp | Models.AttributeDatetime | Models.AttributeRelationship | Models.AttributePoint | Models.AttributeLine | Models.AttributePolygon | Models.AttributeString)[];
/**
* Collection indexes.
*/
indexes: Index[];
};
/**
* Attributes List
*/
export type AttributeList = {
/**
* Total number of attributes in the given collection.
*/
total: number;
/**
* List of attributes.
*/
attributes: (Models.AttributeBoolean | Models.AttributeInteger | Models.AttributeFloat | Models.AttributeEmail | Models.AttributeEnum | Models.AttributeUrl | Models.AttributeIp | Models.AttributeDatetime | Models.AttributeRelationship | Models.AttributePoint | Models.AttributeLine | Models.AttributePolygon | Models.AttributeString)[];
};
/**
* AttributeString
*/
export type AttributeString = {
/**
* Attribute Key.
*/
key: string;
/**
* Attribute type.
*/
type: string;
/**
* Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
*/
status: AttributeStatus;
/**
* Error message. Displays error generated on failure of creating or deleting an attribute.
*/
error: string;
/**
* Is attribute required?
*/
required: boolean;
/**
* Is attribute an array?
*/
array?: boolean;
/**
* Attribute creation date in ISO 8601 format.
*/
$createdAt: string;
/**
* Attribute update date in ISO 8601 format.
*/
$updatedAt: string;
/**
* Attribute size.
*/
size: number;
/**
* Default value for attribute when not provided. Cannot be set when attribute is required.
*/
default?: string;
/**
* Defines whether this attribute is encrypted or not.
*/
encrypt?: boolean;
};
/**
* AttributeInteger
*/
export type AttributeInteger = {
/**
* Attribute Key.
*/
key: string;
/**
* Attribute type.
*/
type: string;
/**
* Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
*/
status: AttributeStatus;
/**
* Error message. Displays error generated on failure of creating or deleting an attribute.
*/
error: string;
/**
* Is attribute required?
*/
required: boolean;
/**
* Is attribute an array?
*/
array?: boolean;
/**
* Attribute creation date in ISO 8601 format.
*/
$createdAt: string;
/**
* Attribute update date in ISO 8601 format.
*/
$updatedAt: string;
/**
* Minimum value to enforce for new documents.
*/
min?: number | bigint;
/**
* Maximum value to enforce for new documents.
*/
max?: number | bigint;
/**
* Default value for attribute when not provided. Cannot be set when attribute is required.
*/
default?: number;
};
/**
* AttributeFloat
*/
export type AttributeFloat = {
/**
* Attribute Key.
*/
key: string;
/**
* Attribute type.
*/
type: string;
/**
* Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
*/
status: AttributeStatus;
/**
* Error message. Displays error generated on failure of creating or deleting an attribute.
*/
error: string;
/**
* Is attribute required?
*/
required: boolean;
/**
* Is attribute an array?
*/
array?: boolean;
/**
* Attribute creation date in ISO 8601 format.
*/
$createdAt: string;
/**
* Attribute update date in ISO 8601 format.
*/
$updatedAt: string;
/**
* Minimum value to enforce for new documents.
*/
min?: number;
/**
* Maximum value to enforce for new documents.
*/
max?: number;
/**
* Default value for attribute when not provided. Cannot be set when attribute is required.
*/
default?: number;
};
/**
* AttributeBoolean
*/
export type AttributeBoolean = {
/**
* Attribute Key.
*/
key: string;
/**
* Attribute type.
*/
type: string;
/**
* Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
*/
status: AttributeStatus;
/**
* Error message. Displays error generated on failure of creating or deleting an attribute.
*/
error: string;
/**
* Is attribute required?
*/
required: boolean;
/**
* Is attribute an array?
*/
array?: boolean;
/**
* Attribute creation date in ISO 8601 format.
*/
$createdAt: string;
/**
* Attribute update date in ISO 8601 format.
*/
$updatedAt: string;
/**
* Default value for attribute when not provided. Cannot be set when attribute is required.
*/
default?: boolean;
};
/**
* AttributeEmail
*/
export type AttributeEmail = {
/**
* Attribute Key.
*/
key: string;
/**
* Attribute type.
*/
type: string;
/**
* Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
*/
status: AttributeStatus;
/**
* Error message. Displays error generated on failure of creating or deleting an attribute.
*/
error: string;
/**
* Is attribute required?
*/
required: boolean;
/**
* Is attribute an array?
*/
array?: boolean;
/**
* Attribute creation date in ISO 8601 format.
*/
$createdAt: string;
/**
* Attribute update date in ISO 8601 format.
*/
$updatedAt: string;
/**
* String format.
*/
format: string;
/**
* Default value for attribute when not provided. Cannot be set when attribute is required.
*/
default?: string;
};
/**
* AttributeEnum
*/
export type AttributeEnum = {
/**
* Attribute Key.
*/
key: string;
/**
* Attribute type.
*/
type: string;
/**
* Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
*/
status: AttributeStatus;
/**
* Error message. Displays error generated on failure of creating or deleting an attribute.
*/
error: string;
/**
* Is attribute required?
*/
required: boolean;
/**
* Is attribute an array?
*/
array?: boolean;
/**
* Attribute creation date in ISO 8601 format.
*/
$createdAt: string;
/**
* Attribute update date in ISO 8601 format.
*/
$updatedAt: string;
/**
* Array of elements in enumerated type.
*/
elements: string[];
/**
* String format.
*/
format: string;
/**
* Default value for attribute when not provided. Cannot be set when attribute is required.
*/
default?: string;
};
/**
* AttributeIP
*/
export type AttributeIp = {
/**
* Attribute Key.
*/
key: string;
/**
* Attribute type.
*/
type: string;
/**
* Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
*/
status: AttributeStatus;
/**
* Error message. Displays error generated on failure of creating or deleting an attribute.
*/
error: string;
/**
* Is attribute required?
*/
required: boolean;
/**
* Is attribute an array?
*/
array?: boolean;
/**
* Attribute creation date in ISO 8601 format.
*/
$createdAt: string;
/**
* Attribute update date in ISO 8601 format.
*/
$updatedAt: string;
/**
* String format.
*/
format: string;
/**
* Default value for attribute when not provided. Cannot be set when attribute is required.
*/
default?: string;
};
/**
* AttributeURL
*/
export type AttributeUrl = {
/**
* Attribute Key.
*/
key: string;
/**
* Attribute type.
*/
type: string;
/**
* Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
*/
status: AttributeStatus;
/**
* Error message. Displays error generated on failure of creating or deleting an attribute.
*/
error: string;
/**
* Is attribute required?
*/
required: boolean;
/**
* Is attribute an array?
*/
array?: boolean;
/**
* Attribute creation date in ISO 8601 format.
*/
$createdAt: string;
/**
* Attribute update date in ISO 8601 format.
*/
$updatedAt: string;
/**
* String format.
*/
format: string;
/**
* Default value for attribute when not provided. Cannot be set when attribute is required.
*/
default?: string;
};
/**
* AttributeDatetime
*/
export type AttributeDatetime = {
/**
* Attribute Key.
*/
key: string;
/**
* Attribute type.
*/
type: string;
/**
* Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
*/
status: AttributeStatus;
/**
* Error message. Displays error generated on failure of creating or deleting an attribute.
*/
error: string;
/**
* Is attribute required?
*/
required: boolean;
/**
* Is attribute an array?
*/
array?: boolean;
/**
* Attribute creation date in ISO 8601 format.
*/
$createdAt: string;
/**
* Attribute update date in ISO 8601 format.
*/
$updatedAt: string;
/**
* ISO 8601 format.
*/
format: string;
/**
* Default value for attribute when not provided. Only null is optional
*/
default?: string;
};
/**
* AttributeRelationship
*/
export type AttributeRelationship = {
/**
* Attribute Key.
*/
key: string;
/**
* Attribute type.
*/
type: string;
/**
* Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
*/
status: AttributeStatus;
/**
* Error message. Displays error generated on failure of creating or deleting an attribute.
*/
error: string;
/**
* Is attribute required?
*/
required: boolean;
/**
* Is attribute an array?
*/
array?: boolean;
/**
* Attribute creation date in ISO 8601 format.
*/
$createdAt: string;
/**
* Attribute update date in ISO 8601 format.
*/
$updatedAt: string;
/**
* The ID of the related collection.
*/
relatedCollection: string;
/**
* The type of the relationship.
*/
relationType: string;
/**
* Is the relationship two-way?
*/
twoWay: boolean;
/**
* The key of the two-way relationship.
*/
twoWayKey: string;
/**
* How deleting the parent document will propagate to child documents.
*/
onDelete: string;
/**
* Whether this is the parent or child side of the relationship
*/
side: string;
};
/**
* AttributePoint
*/
export type AttributePoint = {
/**
* Attribute Key.
*/
key: string;
/**
* Attribute type.
*/
type: string;
/**
* Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
*/
status: AttributeStatus;
/**
* Error message. Displays error generated on failure of creating or deleting an attribute.
*/
error: string;
/**
* Is attribute required?
*/
required: boolean;
/**
* Is attribute an array?
*/
array?: boolean;
/**
* Attribute creation date in ISO 8601 format.
*/
$createdAt: string;
/**
* Attribute update date in ISO 8601 format.
*/
$updatedAt: string;
/**
* Default value for attribute when not provided. Cannot be set when attribute is required.
*/
default?: any[];
};
/**
* AttributeLine
*/
export type AttributeLine = {
/**
* Attribute Key.
*/
key: string;
/**
* Attribute type.
*/
type: string;
/**
* Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
*/
status: AttributeStatus;
/**
* Error message. Displays error generated on failure of creating or deleting an attribute.
*/
error: string;
/**
* Is attribute required?
*/
required: boolean;
/**
* Is attribute an array?
*/
array?: boolean;
/**
* Attribute creation date in ISO 8601 format.
*/
$createdAt: string;
/**
* Attribute update date in ISO 8601 format.
*/
$updatedAt: string;
/**
* Default value for attribute when not provided. Cannot be set when attribute is required.
*/
default?: any[];
};
/**
* AttributePolygon
*/
export type AttributePolygon = {
/**
* Attribute Key.
*/
key: string;
/**
* Attribute type.
*/
type: string;
/**
* Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
*/
status: AttributeStatus;
/**
* Error message. Displays error generated on failure of creating or deleting an attribute.
*/
error: string;
/**
* Is attribute required?
*/
required: boolean;
/**
* Is attribute an array?
*/
array?: boolean;
/**
* Attribute creation date in ISO 8601 format.
*/
$createdAt: string;
/**
* Attribute update date in ISO 8601 format.
*/
$updatedAt: string;
/**
* Default value for attribute when not provided. Cannot be set when attribute is required.
*/
default?: any[];
};
/**
* AttributeVarchar
*/
export type AttributeVarchar = {
/**
* Attribute Key.
*/
key: string;
/**
* Attribute type.
*/
type: string;
/**
* Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
*/
status: AttributeStatus;
/**
* Error message. Displays error generated on failure of creating or deleting an attribute.
*/
error: string;
/**
* Is attribute required?
*/
required: boolean;
/**
* Is attribute an array?
*/
array?: boolean;
/**
* Attribute creation date in ISO 8601 format.
*/
$createdAt: string;
/**
* Attribute update date in ISO 8601 format.
*/
$updatedAt: string;
/**
* Attribute size.
*/
size: number;
/**
* Default value for attribute when not provided. Cannot be set when attribute is required.
*/
default?: string;
};
/**
* AttributeText
*/
export type AttributeText = {
/**
* Attribute Key.
*/
key: string;
/**
* Attribute type.
*/
type: string;
/**
* Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
*/
status: AttributeStatus;
/**
* Error message. Displays error generated on failure of creating or deleting an attribute.
*/
error: string;
/**
* Is attribute required?
*/
required: boolean;
/**
* Is attribute an array?
*/
array?: boolean;
/**
* Attribute creation date in ISO 8601 format.
*/
$createdAt: string;
/**
* Attribute update date in ISO 8601 format.
*/
$updatedAt: string;
/**
* Default value for attribute when not provided. Cannot be set when attribute is required.
*/
default?: string;
};
/**
* AttributeMediumtext
*/
export type AttributeMediumtext = {
/**
* Attribute Key.
*/
key: string;
/**
* Attribute type.
*/
type: string;
/**
* Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
*/
status: AttributeStatus;
/**
* Error message. Displays error generated on failure of creating or deleting an attribute.
*/
error: string;
/**
* Is attribute required?
*/
required: boolean;
/**
* Is attribute an array?
*/
array?: boolean;
/**
* Attribute creation date in ISO 8601 format.
*/
$createdAt: string;
/**
* Attribute update date in ISO 8601 format.
*/
$updatedAt: string;
/**
* Default value for attribute when not provided. Cannot be set when attribute is required.
*/
default?: string;
};
/**
* AttributeLongtext
*/
export type AttributeLongtext = {
/**
* Attribute Key.
*/
key: string;
/**
* Attribute type.
*/
type: string;
/**
* Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
*/
status: AttributeStatus;
/**
* Error message. Displays error generated on failure of creating or deleting an attribute.
*/
error: string;
/**
* Is attribute required?
*/
required: boolean;
/**
* Is attribute an array?
*/
array?: boolean;
/**
* Attribute creation date in ISO 8601 format.
*/
$createdAt: string;
/**
* Attribute update date in ISO 8601 format.
*/
$updatedAt: string;
/**
* Default value for attribute when not provided. Cannot be set when attribute is required.
*/
default?: string;
};
/**
* Table
*/
export type Table = {
/**
* Table ID.
*/
$id: string;
/**
* Table creation date in ISO 8601 format.
*/
$createdAt: string;
/**
* Table update date in ISO 8601 format.
*/
$updatedAt: string;
/**
* Table permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
*/
$permissions: string[];
/**
* Database ID.
*/
databaseId: string;
/**
* Table name.
*/
name: string;
/**
* Table enabled. Can be 'enabled' or 'disabled'. When disabled, the table is inaccessible to users, but remains accessible to Server SDKs using API keys.
*/
enabled: boolean;
/**
* Whether row-level permissions are enabled. [Learn more about permissions](https://appwrite.io/docs/permissions).
*/
rowSecurity: boolean;
/**
* Table columns.
*/
columns: (Models.ColumnBoolean | Models.ColumnInteger | Models.ColumnFloat | Models.ColumnEmail | Models.ColumnEnum | Models.ColumnUrl | Models.ColumnIp | Models.ColumnDatetime | Models.ColumnRelationship | Models.ColumnPoint | Models.ColumnLine | Models.ColumnPolygon | Models.ColumnString)[];
/**
* Table indexes.
*/
indexes: ColumnIndex[];
};
/**
* Columns List
*/
export type ColumnList = {
/**
* Total number of columns in the given table.
*/
total: number;
/**
* List of columns.
*/
columns: (Models.ColumnBoolean | Models.ColumnInteger | Models.ColumnFloat | Models.ColumnEmail | Models.ColumnEnum | Models.ColumnUrl | Models.ColumnIp | Models.ColumnDatetime | Models.ColumnRelationship | Models.ColumnPoint | Models.ColumnLine | Models.ColumnPolygon | Models.ColumnString)[];
};
/**
* ColumnString
*/
export type ColumnString = {
/**
* Column Key.
*/
key: string;
/**
* Column type.
*/
type: string;
/**
* Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
*/
status: ColumnStatus;
/**
* Error message. Displays error generated on failure of creating or deleting an column.
*/
error: string;
/**
* Is column required?
*/
required: boolean;
/**
* Is column an array?
*/
array?: boolean;
/**
* Column creation date in ISO 8601 format.
*/
$createdAt: string;
/**
* Column update date in ISO 8601 format.
*/
$updatedAt: string;
/**
* Column size.
*/
size: number;
/**
* Default value for column when not provided. Cannot be set when column is required.
*/
default?: string;
/**
* Defines whether this column is encrypted or not.
*/
encrypt?: boolean;
};
/**
* ColumnInteger
*/
export type ColumnInteger = {
/**
* Column Key.
*/
key: string;
/**
* Column type.
*/
type: string;
/**
* Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
*/
status: ColumnStatus;
/**
* Error message. Displays error generated on failure of creating or deleting an column.
*/
error: string;
/**
* Is column required?
*/
required: boolean;
/**
* Is column an array?
*/
array?: boolean;
/**
* Column creation date in ISO 8601 format.
*/
$createdAt: string;
/**
* Column update date in ISO 8601 format.
*/
$updatedAt: string;
/**
* Minimum value to enforce for new documents.
*/
min?: number | bigint;
/**
* Maximum value to enforce for new documents.
*/
max?: number | bigint;
/**
* Default value for column when not provided. Cannot be set when column is required.
*/
default?: number;
};
/**
* ColumnFloat
*/
export type ColumnFloat = {
/**
* Column Key.
*/
key: string;
/**
* Column type.
*/
type: string;
/**
* Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
*/
status: ColumnStatus;
/**
* Error message. Displays error generated on failure of creating or deleting an column.
*/
error: string;
/**
* Is column required?
*/
required: boolean;
/**
* Is column an array?
*/
array?: boolean;
/**
* Column creation date in ISO 8601 format.
*/
$createdAt: string;
/**
* Column update date in ISO 8601 format.
*/
$updatedAt: string;
/**
* Minimum value to enforce for new documents.
*/
min?: number;
/**
* Maximum value to enforce for new documents.
*/
max?: number;
/**
* Default value for column when not provided. Cannot be set when column is required.
*/
default?: number;
};
/**
* ColumnBoolean
*/
export type ColumnBoolean = {
/**
* Column Key.
*/
key: string;
/**
* Column type.
*/
type: string;
/**
* Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
*/
status: ColumnStatus;
/**
* Error message. Displays error generated on failure of creating or deleting an column.
*/
error: string;
/**
* Is column required?
*/
required: boolean;
/**
* Is column an array?
*/
array?: boolean;
/**
* Column creation date in ISO 8601 format.
*/
$createdAt: string;
/**
* Column update date in ISO 8601 format.
*/
$updatedAt: string;
/**
* Default value for column when not provided. Cannot be set when column is required.
*/
default?: boolean;
};
/**
* ColumnEmail
*/
export type ColumnEmail = {
/**
* Column Key.
*/
key: string;
/**
* Column type.
*/
type: string;
/**
* Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
*/
status: ColumnStatus;
/**
* Error message. Displays error generated on failure of creating or deleting an column.
*/
error: string;
/**
* Is column required?
*/
required: boolean;
/**
* Is column an array?
*/
array?: boolean;
/**
* Column creation date in ISO 8601 format.
*/
$createdAt: string;
/**
* Column update date in ISO 8601 format.
*/
$updatedAt: string;
/**
* String format.
*/
format: string;
/**
* Default value for column when not provided. Cannot be set when column is required.
*/
default?: string;
};
/**
* ColumnEnum
*/
export type ColumnEnum = {
/**
* Column Key.
*/
key: string;
/**
* Column type.
*/
type: string;
/**
* Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
*/
status: ColumnStatus;
/**
* Error message. Displays error generated on failure of creating or deleting an column.
*/
error: string;
/**
* Is column required?
*/
required: boolean;
/**
* Is column an array?
*/
array?: boolean;
/**
* Column creation date in ISO 8601 format.
*/
$createdAt: string;
/**
* Column update date in ISO 8601 format.
*/
$updatedAt: string;
/**
* Array of elements in enumerated type.
*/
elements: string[];
/**
* String format.
*/
format: string;
/**
* Default value for column when not provided. Cannot be set when column is required.
*/
default?: string;
};
/**
* ColumnIP
*/
export type ColumnIp = {
/**
* Column Key.
*/
key: string;
/**
* Column type.
*/
type: string;
/**
* Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
*/
status: ColumnStatus;
/**
* Error message. Displays error generated on failure of creating or deleting an column.
*/
error: string;
/**
* Is column required?
*/
required: boolean;
/**
* Is column an array?
*/
array?: boolean;
/**
* Column creation date in ISO 8601 format.
*/
$createdAt: string;
/**
* Column update date in ISO 8601 format.
*/
$updatedAt: string;
/**
* String format.
*/
format: string;
/**
* Default value for column when not provided. Cannot be set when column is required.
*/
default?: string;
};
/**
* ColumnURL
*/
export type ColumnUrl = {
/**
* Column Key.
*/
key: string;
/**
* Column type.
*/
type: string;
/**
* Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
*/
status: ColumnStatus;
/**
* Error message. Displays error generated on failure of creating or deleting an column.
*/
error: string;
/**
* Is column required?
*/
required: boolean;
/**
* Is column an array?
*/
array?: boolean;
/**
* Column creation date in ISO 8601 format.
*/
$createdAt: string;
/**
* Column update date in ISO 8601 format.
*/
$updatedAt: string;
/**
* String format.
*/
format: string;
/**
* Default value for column when not provided. Cannot be set when column is required.
*/
default?: string;
};
/**
* ColumnDatetime
*/
export type ColumnDatetime = {
/**
* Column Key.
*/
key: string;
/**
* Column type.
*/
type: string;
/**
* Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
*/
status: ColumnStatus;
/**
* Error message. Displays error generated on failure of creating or deleting an column.
*/
error: string;
/**
* Is column required?
*/
required: boolean;
/**
* Is column an array?
*/
array?: boolean;
/**
* Column creation date in ISO 8601 format.
*/
$createdAt: string;
/**
* Column update date in ISO 8601 format.
*/
$updatedAt: string;
/**
* ISO 8601 format.
*/
format: string;
/**
* Default value for column when not provided. Only null is optional
*/
default?: string;
};
/**
* ColumnRelationship
*/
export type ColumnRelationship = {
/**
* Column Key.
*/
key: string;
/**
* Column type.
*/
type: string;
/**
* Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
*/
status: ColumnStatus;
/**
* Error message. Displays error generated on failure of creating or deleting an column.
*/
error: string;
/**
* Is column required?
*/
required: boolean;
/**
* Is column an array?
*/
array?: boolean;
/**
* Column creation date in ISO 8601 format.
*/
$createdAt: string;
/**
* Column update date in ISO 8601 format.
*/
$updatedAt: string;
/**
* The ID of the related table.
*/
relatedTable: string;
/**
* The type of the relationship.
*/
relationType: string;
/**
* Is the relationship two-way?
*/
twoWay: boolean;
/**
* The key of the two-way relationship.
*/
twoWayKey: string;
/**
* How deleting the parent document will propagate to child documents.
*/
onDelete: string;
/**
* Whether this is the parent or child side of the relationship
*/
side: string;
};
/**
* ColumnPoint
*/
export type ColumnPoint = {
/**
* Column Key.
*/
key: string;
/**
* Column type.
*/
type: string;
/**
* Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
*/
status: ColumnStatus;
/**
* Error message. Displays error generated on failure of creating or deleting an column.
*/
error: string;
/**
* Is column required?
*/
required: boolean;
/**
* Is column an array?
*/
array?: boolean;
/**
* Column creation date in ISO 8601 format.
*/
$createdAt: string;
/**
* Column update date in ISO 8601 format.
*/
$updatedAt: string;
/**
* Default value for column when not provided. Cannot be set when column is required.
*/
default?: any[];
};
/**
* ColumnLine
*/
export type ColumnLine = {
/**
* Column Key.
*/
key: string;
/**
* Column type.
*/
type: string;
/**
* Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
*/
status: ColumnStatus;
/**
* Error message. Displays error generated on failure of creating or deleting an column.
*/
error: string;
/**
* Is column required?
*/
required: boolean;
/**
* Is column an array?
*/
array?: boolean;
/**
* Column creation date in ISO 8601 format.
*/
$createdAt: string;
/**
* Column update date in ISO 8601 format.
*/
$updatedAt: string;
/**
* Default value for column when not provided. Cannot be set when column is required.
*/
default?: any[];
};
/**
* ColumnPolygon
*/
export type ColumnPolygon = {
/**
* Column Key.
*/
key: string;
/**
* Column type.
*/
type: string;
/**
* Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
*/
status: ColumnStatus;
/**
* Error message. Displays error generated on failure of creating or deleting an column.
*/
error: string;
/**
* Is column required?
*/
required: boolean;
/**