@appwrite.io/console 2.1.3 → 2.2.0

package/types/enums/runtimes.d.ts

@@ -0,0 +1,66 @@
+export declare enum Runtimes {
+    Node145 = "node-14.5",
+    Node160 = "node-16.0",
+    Node180 = "node-18.0",
+    Node190 = "node-19.0",
+    Node200 = "node-20.0",
+    Node210 = "node-21.0",
+    Node22 = "node-22",
+    Php80 = "php-8.0",
+    Php81 = "php-8.1",
+    Php82 = "php-8.2",
+    Php83 = "php-8.3",
+    Ruby30 = "ruby-3.0",
+    Ruby31 = "ruby-3.1",
+    Ruby32 = "ruby-3.2",
+    Ruby33 = "ruby-3.3",
+    Python38 = "python-3.8",
+    Python39 = "python-3.9",
+    Python310 = "python-3.10",
+    Python311 = "python-3.11",
+    Python312 = "python-3.12",
+    Pythonml311 = "python-ml-3.11",
+    Pythonml312 = "python-ml-3.12",
+    Deno140 = "deno-1.40",
+    Deno146 = "deno-1.46",
+    Deno20 = "deno-2.0",
+    Dart215 = "dart-2.15",
+    Dart216 = "dart-2.16",
+    Dart217 = "dart-2.17",
+    Dart218 = "dart-2.18",
+    Dart219 = "dart-2.19",
+    Dart30 = "dart-3.0",
+    Dart31 = "dart-3.1",
+    Dart33 = "dart-3.3",
+    Dart35 = "dart-3.5",
+    Dart38 = "dart-3.8",
+    Dart39 = "dart-3.9",
+    Dotnet60 = "dotnet-6.0",
+    Dotnet70 = "dotnet-7.0",
+    Dotnet80 = "dotnet-8.0",
+    Java80 = "java-8.0",
+    Java110 = "java-11.0",
+    Java170 = "java-17.0",
+    Java180 = "java-18.0",
+    Java210 = "java-21.0",
+    Java22 = "java-22",
+    Swift55 = "swift-5.5",
+    Swift58 = "swift-5.8",
+    Swift59 = "swift-5.9",
+    Swift510 = "swift-5.10",
+    Kotlin16 = "kotlin-1.6",
+    Kotlin18 = "kotlin-1.8",
+    Kotlin19 = "kotlin-1.9",
+    Kotlin20 = "kotlin-2.0",
+    Cpp17 = "cpp-17",
+    Cpp20 = "cpp-20",
+    Bun10 = "bun-1.0",
+    Bun11 = "bun-1.1",
+    Go123 = "go-1.23",
+    Static1 = "static-1",
+    Flutter324 = "flutter-3.24",
+    Flutter327 = "flutter-3.27",
+    Flutter329 = "flutter-3.29",
+    Flutter332 = "flutter-3.32",
+    Flutter335 = "flutter-3.35"
+}

package/types/enums/scopes.d.ts

@@ -0,0 +1,65 @@
+export declare enum Scopes {
+    SessionsWrite = "sessions.write",
+    UsersRead = "users.read",
+    UsersWrite = "users.write",
+    TeamsRead = "teams.read",
+    TeamsWrite = "teams.write",
+    DatabasesRead = "databases.read",
+    DatabasesWrite = "databases.write",
+    CollectionsRead = "collections.read",
+    CollectionsWrite = "collections.write",
+    TablesRead = "tables.read",
+    TablesWrite = "tables.write",
+    AttributesRead = "attributes.read",
+    AttributesWrite = "attributes.write",
+    ColumnsRead = "columns.read",
+    ColumnsWrite = "columns.write",
+    IndexesRead = "indexes.read",
+    IndexesWrite = "indexes.write",
+    DocumentsRead = "documents.read",
+    DocumentsWrite = "documents.write",
+    RowsRead = "rows.read",
+    RowsWrite = "rows.write",
+    FilesRead = "files.read",
+    FilesWrite = "files.write",
+    BucketsRead = "buckets.read",
+    BucketsWrite = "buckets.write",
+    FunctionsRead = "functions.read",
+    FunctionsWrite = "functions.write",
+    SitesRead = "sites.read",
+    SitesWrite = "sites.write",
+    LogRead = "log.read",
+    LogWrite = "log.write",
+    ExecutionRead = "execution.read",
+    ExecutionWrite = "execution.write",
+    LocaleRead = "locale.read",
+    AvatarsRead = "avatars.read",
+    HealthRead = "health.read",
+    ProvidersRead = "providers.read",
+    ProvidersWrite = "providers.write",
+    MessagesRead = "messages.read",
+    MessagesWrite = "messages.write",
+    TopicsRead = "topics.read",
+    TopicsWrite = "topics.write",
+    SubscribersRead = "subscribers.read",
+    SubscribersWrite = "subscribers.write",
+    TargetsRead = "targets.read",
+    TargetsWrite = "targets.write",
+    RulesRead = "rules.read",
+    RulesWrite = "rules.write",
+    MigrationsRead = "migrations.read",
+    MigrationsWrite = "migrations.write",
+    VcsRead = "vcs.read",
+    VcsWrite = "vcs.write",
+    AssistantRead = "assistant.read",
+    TokensRead = "tokens.read",
+    TokensWrite = "tokens.write",
+    PoliciesWrite = "policies.write",
+    PoliciesRead = "policies.read",
+    ArchivesRead = "archives.read",
+    ArchivesWrite = "archives.write",
+    RestorationsRead = "restorations.read",
+    RestorationsWrite = "restorations.write",
+    DomainsRead = "domains.read",
+    DomainsWrite = "domains.write"
+}

package/types/enums/services.d.ts

@@ -0,0 +1,5 @@
+export declare enum Services {
+    Databases = "databases",
+    Functions = "functions",
+    Storage = "storage"
+}

package/types/enums/use-cases.d.ts

@@ -0,0 +1,11 @@
+export declare enum UseCases {
+    Portfolio = "portfolio",
+    Starter = "starter",
+    Events = "events",
+    Ecommerce = "ecommerce",
+    Documentation = "documentation",
+    Blog = "blog",
+    Ai = "ai",
+    Forms = "forms",
+    Dashboard = "dashboard"
+}

package/types/index.d.ts

@@ -38,6 +38,7 @@ export { Role } from './role';
 export { ID } from './id';
 export { Channel } from './channel';
 export { Operator, Condition } from './operator';
+export { Scopes } from './enums/scopes';
 export { AuthenticatorType } from './enums/authenticator-type';
 export { AuthenticationFactor } from './enums/authentication-factor';
 export { OAuthProvider } from './enums/o-auth-provider';
@@ -46,15 +47,20 @@ export { CreditCard } from './enums/credit-card';
 export { Flag } from './enums/flag';
 export { Theme } from './enums/theme';
 export { Timezone } from './enums/timezone';
+export { BrowserPermission } from './enums/browser-permission';
 export { ImageFormat } from './enums/image-format';
+export { Services } from './enums/services';
 export { Platform } from './enums/platform';
 export { ConsoleResourceType } from './enums/console-resource-type';
 export { UsageRange } from './enums/usage-range';
 export { RelationshipType } from './enums/relationship-type';
 export { RelationMutate } from './enums/relation-mutate';
 export { IndexType } from './enums/index-type';
+export { OrderBy } from './enums/order-by';
 export { FilterType } from './enums/filter-type';
 export { Runtime } from './enums/runtime';
+export { Runtimes } from './enums/runtimes';
+export { UseCases } from './enums/use-cases';
 export { TemplateReferenceType } from './enums/template-reference-type';
 export { VCSReferenceType } from './enums/vcs-reference-type';
 export { DeploymentDownloadType } from './enums/deployment-download-type';
@@ -62,7 +68,7 @@ export { ExecutionMethod } from './enums/execution-method';
 export { Name } from './enums/name';
 export { MessagePriority } from './enums/message-priority';
 export { SmtpEncryption } from './enums/smtp-encryption';
-export { BillingPlan } from './enums/billing-plan';
+export { Resources } from './enums/resources';
 export { ProjectUsageRange } from './enums/project-usage-range';
 export { Region } from './enums/region';
 export { Api } from './enums/api';
@@ -80,8 +86,10 @@ export { ProxyResourceType } from './enums/proxy-resource-type';
 export { Framework } from './enums/framework';
 export { BuildRuntime } from './enums/build-runtime';
 export { Adapter } from './enums/adapter';
+export { Frameworks } from './enums/frameworks';
 export { Compression } from './enums/compression';
 export { ImageGravity } from './enums/image-gravity';
+export { Roles } from './enums/roles';
 export { PasswordHash } from './enums/password-hash';
 export { MessagingProviderType } from './enums/messaging-provider-type';
 export { VCSDetectionType } from './enums/vcs-detection-type';

package/types/models.d.ts

@@ -1376,6 +1376,174 @@ export declare namespace Models {
          */
         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
      */
@@ -2035,6 +2203,174 @@ export declare namespace Models {
          */
         default?: any[];
     };
+    /**
+     * ColumnVarchar
+     */
+    export type ColumnVarchar = {
+        /**
+         * 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;
+    };
+    /**
+     * ColumnText
+     */
+    export type ColumnText = {
+        /**
+         * 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?: string;
+    };
+    /**
+     * ColumnMediumtext
+     */
+    export type ColumnMediumtext = {
+        /**
+         * 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?: string;
+    };
+    /**
+     * ColumnLongtext
+     */
+    export type ColumnLongtext = {
+        /**
+         * 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?: string;
+    };
     /**
      * Index
      */
@@ -3811,7 +4147,7 @@ export declare namespace Models {
          */
         screenshotDark: string;
         /**
-         * The deployment status. Possible values are "waiting", "processing", "building", "ready", and "failed".
+         * The deployment status. Possible values are "waiting", "processing", "building", "ready", "canceled" and "failed".
          */
         status: DeploymentStatus;
         /**
@@ -6479,6 +6815,10 @@ export declare namespace Models {
          * Image Transformations
          */
         imageTransformations: number;
+        /**
+         * Screenshots generated
+         */
+        screenshotsGenerated: number;
         /**
          * Members
          */

package/types/services/account.d.ts

@@ -1,5 +1,6 @@
 import { Client } from '../client';
 import type { Models } from '../models';
+import { Scopes } from '../enums/scopes';
 import { AuthenticatorType } from '../enums/authenticator-type';
 import { AuthenticationFactor } from '../enums/authentication-factor';
 import { OAuthProvider } from '../enums/o-auth-provider';
@@ -300,6 +301,116 @@ export declare class Account {
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     createJWT(duration?: number): Promise<Models.Jwt>;
+    /**
+     * Get a list of all API keys from the current account.
+     *
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.KeyList>}
+     */
+    listKeys(params?: {
+        total?: boolean;
+    }): Promise<Models.KeyList>;
+    /**
+     * Get a list of all API keys from the current account.
+     *
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.KeyList>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    listKeys(total?: boolean): Promise<Models.KeyList>;
+    /**
+     * Create a new account API key.
+     *
+     * @param {string} params.name - Key name. Max length: 128 chars.
+     * @param {Scopes[]} params.scopes - Key scopes list. Maximum of 100 scopes are allowed.
+     * @param {string} params.expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Key>}
+     */
+    createKey(params: {
+        name: string;
+        scopes: Scopes[];
+        expire?: string;
+    }): Promise<Models.Key>;
+    /**
+     * Create a new account API key.
+     *
+     * @param {string} name - Key name. Max length: 128 chars.
+     * @param {Scopes[]} scopes - Key scopes list. Maximum of 100 scopes are allowed.
+     * @param {string} expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Key>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    createKey(name: string, scopes: Scopes[], expire?: string): Promise<Models.Key>;
+    /**
+     * Get a key by its unique ID. This endpoint returns details about a specific API key in your account including it's scopes.
+     *
+     * @param {string} params.keyId - Key unique ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Key>}
+     */
+    getKey(params: {
+        keyId: string;
+    }): Promise<Models.Key>;
+    /**
+     * Get a key by its unique ID. This endpoint returns details about a specific API key in your account including it's scopes.
+     *
+     * @param {string} keyId - Key unique ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Key>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getKey(keyId: string): Promise<Models.Key>;
+    /**
+     * Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key.
+     *
+     * @param {string} params.keyId - Key unique ID.
+     * @param {string} params.name - Key name. Max length: 128 chars.
+     * @param {Scopes[]} params.scopes - Key scopes list. Maximum of 100 scopes are allowed.
+     * @param {string} params.expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Key>}
+     */
+    updateKey(params: {
+        keyId: string;
+        name: string;
+        scopes: Scopes[];
+        expire?: string;
+    }): Promise<Models.Key>;
+    /**
+     * Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key.
+     *
+     * @param {string} keyId - Key unique ID.
+     * @param {string} name - Key name. Max length: 128 chars.
+     * @param {Scopes[]} scopes - Key scopes list. Maximum of 100 scopes are allowed.
+     * @param {string} expire - Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Key>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    updateKey(keyId: string, name: string, scopes: Scopes[], expire?: string): Promise<Models.Key>;
+    /**
+     * Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.
+     *
+     * @param {string} params.keyId - Key unique ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    deleteKey(params: {
+        keyId: string;
+    }): Promise<{}>;
+    /**
+     * Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.
+     *
+     * @param {string} keyId - Key unique ID.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    deleteKey(keyId: string): Promise<{}>;
     /**
      * Get the list of latest security activity logs for the currently logged in user. Each log returns user IP address, location and date and time of log.
      *