@appwrite.io/console 3.1.0 → 5.0.0

package/types/index.d.ts

@@ -71,7 +71,10 @@ export { ExecutionMethod } from './enums/execution-method';
 export { Name } from './enums/name';
 export { MessagePriority } from './enums/message-priority';
 export { SmtpEncryption } from './enums/smtp-encryption';
-export { Resources } from './enums/resources';
+export { AppwriteMigrationResource } from './enums/appwrite-migration-resource';
+export { FirebaseMigrationResource } from './enums/firebase-migration-resource';
+export { NHostMigrationResource } from './enums/n-host-migration-resource';
+export { SupabaseMigrationResource } from './enums/supabase-migration-resource';
 export { ProjectUsageRange } from './enums/project-usage-range';
 export { Region } from './enums/region';
 export { Api } from './enums/api';
@@ -80,6 +83,7 @@ export { PlatformType } from './enums/platform-type';
 export { ResourceType } from './enums/resource-type';
 export { ApiService } from './enums/api-service';
 export { SMTPSecure } from './enums/smtp-secure';
+export { Status } from './enums/status';
 export { EmailTemplateType } from './enums/email-template-type';
 export { EmailTemplateLocale } from './enums/email-template-locale';
 export { SmsTemplateType } from './enums/sms-template-type';
@@ -108,3 +112,5 @@ export { ProxyRuleDeploymentResourceType } from './enums/proxy-rule-deployment-r
 export { ProxyRuleStatus } from './enums/proxy-rule-status';
 export { MessageStatus } from './enums/message-status';
 export { BillingPlanGroup } from './enums/billing-plan-group';
+export { DomainPurchasePaymentStatus } from './enums/domain-purchase-payment-status';
+export { DomainTransferStatusStatus } from './enums/domain-transfer-status-status';

package/types/models.d.ts

@@ -12,6 +12,8 @@ import { ProxyRuleDeploymentResourceType } from "./enums/proxy-rule-deployment-r
 import { ProxyRuleStatus } from "./enums/proxy-rule-status";
 import { MessageStatus } from "./enums/message-status";
 import { BillingPlanGroup } from "./enums/billing-plan-group";
+import { DomainPurchasePaymentStatus } from "./enums/domain-purchase-payment-status";
+import { DomainTransferStatusStatus } from "./enums/domain-transfer-status-status";
 /**
  * Appwrite Models
  */
@@ -2531,7 +2533,7 @@ export declare namespace Models {
          */
         $id: string;
         /**
-         * Row automatically incrementing ID.
+         * Row sequence ID.
          */
         $sequence: number;
         /**
@@ -2568,7 +2570,7 @@ export declare namespace Models {
          */
         $id: string;
         /**
-         * Document automatically incrementing ID.
+         * Document sequence ID.
          */
         $sequence: number;
         /**
@@ -3400,6 +3402,10 @@ export declare namespace Models {
          * Site framework.
          */
         framework: string;
+        /**
+         * How many days to keep the non-active deployments before they will be automatically deleted.
+         */
+        deploymentRetention: number;
         /**
          * Site's active deployment ID.
          */
@@ -3444,6 +3450,10 @@ export declare namespace Models {
          * The build command used to build the site.
          */
         buildCommand: string;
+        /**
+         * Custom command to use when starting site runtime.
+         */
+        startCommand: string;
         /**
          * The directory where the site build output is located.
          */
@@ -3469,9 +3479,13 @@ export declare namespace Models {
          */
         providerSilentMode: boolean;
         /**
-         * Machine specification for builds and executions.
+         * Machine specification for deployment builds.
          */
-        specification: string;
+        buildSpecification: string;
+        /**
+         * Machine specification for SSR executions.
+         */
+        runtimeSpecification: string;
         /**
          * Site build runtime.
          */
@@ -3623,6 +3637,10 @@ export declare namespace Models {
          * Function execution and build runtime.
          */
         runtime: string;
+        /**
+         * How many days to keep the non-active deployments before they will be automatically deleted.
+         */
+        deploymentRetention: number;
         /**
          * Function's active deployment ID.
          */
@@ -3696,9 +3714,13 @@ export declare namespace Models {
          */
         providerSilentMode: boolean;
         /**
-         * Machine specification for builds and executions.
+         * Machine specification for deployment builds.
+         */
+        buildSpecification: string;
+        /**
+         * Machine specification for executions.
          */
-        specification: string;
+        runtimeSpecification: string;
     };
     /**
      * Template Function
@@ -3884,6 +3906,14 @@ export declare namespace Models {
          * VCS (Version Control System) repository's default branch name.
          */
         defaultBranch: string;
+        /**
+         * VCS (Version Control System) installation ID.
+         */
+        providerInstallationId: string;
+        /**
+         * Is VCS (Version Control System) repository authorized for the installation?
+         */
+        authorized: boolean;
         /**
          * Last commit date in ISO 8601 format.
          */
@@ -3921,6 +3951,14 @@ export declare namespace Models {
          * VCS (Version Control System) repository's default branch name.
          */
         defaultBranch: string;
+        /**
+         * VCS (Version Control System) installation ID.
+         */
+        providerInstallationId: string;
+        /**
+         * Is VCS (Version Control System) repository authorized for the installation?
+         */
+        authorized: boolean;
         /**
          * Last commit date in ISO 8601 format.
          */
@@ -3962,6 +4000,14 @@ export declare namespace Models {
          * VCS (Version Control System) repository's default branch name.
          */
         defaultBranch: string;
+        /**
+         * VCS (Version Control System) installation ID.
+         */
+        providerInstallationId: string;
+        /**
+         * Is VCS (Version Control System) repository authorized for the installation?
+         */
+        authorized: boolean;
         /**
          * Last commit date in ISO 8601 format.
          */
@@ -4609,6 +4655,10 @@ export declare namespace Models {
          * Project blocks information
          */
         blocks: Block[];
+        /**
+         * Last time the project was accessed via console. Used with plan's projectInactivityDays to determine if project is paused.
+         */
+        consoleAccessedAt: string;
     };
     /**
      * Webhook
@@ -5932,6 +5982,22 @@ export declare namespace Models {
          * Total aggregated number of image transformations.
          */
         imageTransformationsTotal: number;
+        /**
+         * Aggregated number of function executions per period.
+         */
+        functionsExecutions: Metric[];
+        /**
+         * Total aggregated number of function executions.
+         */
+        functionsExecutionsTotal: number;
+        /**
+         * Aggregated number of site executions per period.
+         */
+        sitesExecutions: Metric[];
+        /**
+         * Total aggregated number of site executions.
+         */
+        sitesExecutionsTotal: number;
         /**
          * Aggregated stats for total network bandwidth.
          */
@@ -5956,6 +6022,30 @@ export declare namespace Models {
          * Total aggregated number of Imagine credits.
          */
         imagineCreditsTotal: number;
+        /**
+         * Current aggregated number of open Realtime connections.
+         */
+        realtimeConnectionsTotal: number;
+        /**
+         * Total number of Realtime messages sent to clients.
+         */
+        realtimeMessagesTotal: number;
+        /**
+         * Total consumed Realtime bandwidth (in bytes).
+         */
+        realtimeBandwidthTotal: number;
+        /**
+         * Aggregated number of open Realtime connections per period.
+         */
+        realtimeConnections: Metric[];
+        /**
+         * Aggregated number of Realtime messages sent to clients per period.
+         */
+        realtimeMessages: Metric[];
+        /**
+         * Aggregated consumed Realtime bandwidth (in bytes) per period.
+         */
+        realtimeBandwidth: Metric[];
     };
     /**
      * Headers
@@ -6219,6 +6309,50 @@ export declare namespace Models {
          * Comma-separated list of nameservers.
          */
         _APP_DOMAINS_NAMESERVERS: string;
+        /**
+         * Database adapter in use.
+         */
+        _APP_DB_ADAPTER: string;
+        /**
+         * Whether the database adapter supports relationships.
+         */
+        supportForRelationships: boolean;
+        /**
+         * Whether the database adapter supports operators.
+         */
+        supportForOperators: boolean;
+        /**
+         * Whether the database adapter supports spatial attributes.
+         */
+        supportForSpatials: boolean;
+        /**
+         * Whether the database adapter supports spatial indexes on nullable columns.
+         */
+        supportForSpatialIndexNull: boolean;
+        /**
+         * Whether the database adapter supports fulltext wildcard search.
+         */
+        supportForFulltextWildcard: boolean;
+        /**
+         * Whether the database adapter supports multiple fulltext indexes per collection.
+         */
+        supportForMultipleFulltextIndexes: boolean;
+        /**
+         * Whether the database adapter supports resizing attributes.
+         */
+        supportForAttributeResizing: boolean;
+        /**
+         * Whether the database adapter supports fixed schemas with row width limits.
+         */
+        supportForSchemas: boolean;
+        /**
+         * Maximum index length supported by the database adapter.
+         */
+        maxIndexLength: number;
+        /**
+         * Whether the database adapter uses integer sequence IDs.
+         */
+        supportForIntegerIds: boolean;
     };
     /**
      * MFA Challenge
@@ -6619,6 +6753,26 @@ export declare namespace Models {
          * Number of functions to be migrated.
          */
         function: number;
+        /**
+         * Number of sites to be migrated.
+         */
+        site: number;
+        /**
+         * Number of providers to be migrated.
+         */
+        provider: number;
+        /**
+         * Number of topics to be migrated.
+         */
+        topic: number;
+        /**
+         * Number of subscribers to be migrated.
+         */
+        subscriber: number;
+        /**
+         * Number of messages to be migrated.
+         */
+        message: number;
         /**
          * Size of files to be migrated in mb.
          */
@@ -7154,6 +7308,10 @@ export declare namespace Models {
          * Log days
          */
         logs: number;
+        /**
+         * Number of days of console inactivity before a project is paused. 0 means pausing is disabled.
+         */
+        projectInactivityDays: number;
         /**
          * Alert threshold percentage
          */
@@ -8345,7 +8503,11 @@ export declare namespace Models {
         /**
          * Payment status for domain purchase.
          */
-        paymentStatus: string;
+        paymentStatus: DomainPurchasePaymentStatus;
+        /**
+         * Client secret for payment confirmation. Present only when paymentStatus is pending_confirmation.
+         */
+        clientSecret: string;
         /**
          * Nameservers setting. "Appwrite" or empty string.
          */
@@ -8374,6 +8536,14 @@ export declare namespace Models {
          * Dns records
          */
         dnsRecords: DnsRecord[];
+        /**
+         * Domain transfer status (e.g., "pending", "completed", "failed").
+         */
+        transferStatus: string;
+        /**
+         * Retry attempts for the current domain payment flow. Development only.
+         */
+        attempts: number;
     };
     /**
      * DNSRecord
@@ -8622,6 +8792,10 @@ export declare namespace Models {
          * Price period in years.
          */
         periodYears: number;
+        /**
+         * Whether the domain is a premium domain.
+         */
+        premium: boolean;
     };
     /**
      * DomainSuggestion
@@ -8644,6 +8818,32 @@ export declare namespace Models {
          */
         available: boolean;
     };
+    /**
+     * domainTransferOut
+     */
+    export type DomainTransferOut = {
+        /**
+         * Domain transfer authorization code.
+         */
+        authCode: string;
+    };
+    /**
+     * domainTransferStatus
+     */
+    export type DomainTransferStatus = {
+        /**
+         * Transfer status.
+         */
+        status: DomainTransferStatusStatus;
+        /**
+         * Additional transfer status information.
+         */
+        reason: string;
+        /**
+         * Transfer status timestamp in ISO 8601 format.
+         */
+        timestamp: string;
+    };
     /**
      * Activity event list
      */

package/types/services/account.d.ts

@@ -266,7 +266,7 @@ export declare class Account {
     /**
      * List all invoices tied to an account.
      *
-     * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: teamId, aggregationId, amount, currency, from, to, dueAt, attempts, status, grossAmount
+     * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: teamId, aggregationId, type, amount, currency, from, to, dueAt, attempts, status, grossAmount
      * @throws {AppwriteException}
      * @returns {Promise<Models.InvoiceList>}
      */
@@ -276,7 +276,7 @@ export declare class Account {
     /**
      * List all invoices tied to an account.
      *
-     * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: teamId, aggregationId, amount, currency, from, to, dueAt, attempts, status, grossAmount
+     * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: teamId, aggregationId, type, amount, currency, from, to, dueAt, attempts, status, grossAmount
      * @throws {AppwriteException}
      * @returns {Promise<Models.InvoiceList>}
      * @deprecated Use the object parameter style method for a better developer experience.

package/types/services/databases.d.ts

@@ -456,7 +456,7 @@ export declare class Databases {
      *
      *
      * @param {string} params.databaseId - Database ID.
-     * @param {string} params.collectionId - Collection ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
+     * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
      * @param {string} params.key - Attribute Key.
      * @param {boolean} params.required - Is attribute required?
      * @param {boolean} params.xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
@@ -478,7 +478,7 @@ export declare class Databases {
      *
      *
      * @param {string} databaseId - Database ID.
-     * @param {string} collectionId - Collection ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
+     * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
      * @param {string} key - Attribute Key.
      * @param {boolean} required - Is attribute required?
      * @param {boolean} xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
@@ -1387,6 +1387,40 @@ export declare class Databases {
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     createRelationshipAttribute(databaseId: string, collectionId: string, relatedCollectionId: string, type: RelationshipType, twoWay?: boolean, key?: string, twoWayKey?: string, onDelete?: RelationMutate): Promise<Models.AttributeRelationship>;
+    /**
+     * Update relationship attribute. [Learn more about relationship attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).
+     *
+     *
+     * @param {string} params.databaseId - Database ID.
+     * @param {string} params.collectionId - Collection ID.
+     * @param {string} params.key - Attribute Key.
+     * @param {RelationMutate} params.onDelete - Constraints option
+     * @param {string} params.newKey - New Attribute Key.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.AttributeRelationship>}
+     * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.updateRelationshipColumn` instead.
+     */
+    updateRelationshipAttribute(params: {
+        databaseId: string;
+        collectionId: string;
+        key: string;
+        onDelete?: RelationMutate;
+        newKey?: string;
+    }): Promise<Models.AttributeRelationship>;
+    /**
+     * Update relationship attribute. [Learn more about relationship attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).
+     *
+     *
+     * @param {string} databaseId - Database ID.
+     * @param {string} collectionId - Collection ID.
+     * @param {string} key - Attribute Key.
+     * @param {RelationMutate} onDelete - Constraints option
+     * @param {string} newKey - New Attribute Key.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.AttributeRelationship>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    updateRelationshipAttribute(databaseId: string, collectionId: string, key: string, onDelete?: RelationMutate, newKey?: string): Promise<Models.AttributeRelationship>;
     /**
      * Create a string attribute.
      *
@@ -1752,40 +1786,6 @@ export declare class Databases {
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     deleteAttribute(databaseId: string, collectionId: string, key: string): Promise<{}>;
-    /**
-     * Update relationship attribute. [Learn more about relationship attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).
-     *
-     *
-     * @param {string} params.databaseId - Database ID.
-     * @param {string} params.collectionId - Collection ID.
-     * @param {string} params.key - Attribute Key.
-     * @param {RelationMutate} params.onDelete - Constraints option
-     * @param {string} params.newKey - New Attribute Key.
-     * @throws {AppwriteException}
-     * @returns {Promise<Models.AttributeRelationship>}
-     * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.updateRelationshipColumn` instead.
-     */
-    updateRelationshipAttribute(params: {
-        databaseId: string;
-        collectionId: string;
-        key: string;
-        onDelete?: RelationMutate;
-        newKey?: string;
-    }): Promise<Models.AttributeRelationship>;
-    /**
-     * Update relationship attribute. [Learn more about relationship attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).
-     *
-     *
-     * @param {string} databaseId - Database ID.
-     * @param {string} collectionId - Collection ID.
-     * @param {string} key - Attribute Key.
-     * @param {RelationMutate} onDelete - Constraints option
-     * @param {string} newKey - New Attribute Key.
-     * @throws {AppwriteException}
-     * @returns {Promise<Models.AttributeRelationship>}
-     * @deprecated Use the object parameter style method for a better developer experience.
-     */
-    updateRelationshipAttribute(databaseId: string, collectionId: string, key: string, onDelete?: RelationMutate, newKey?: string): Promise<Models.AttributeRelationship>;
     /**
      * Get a list of all the user's documents in a given collection. You can use the query params to filter your results.
      *
@@ -1794,6 +1794,7 @@ export declare class Databases {
      * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
      * @param {string} params.transactionId - Transaction ID to read uncommitted changes within the transaction.
      * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @param {number} params.ttl - TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).
      * @throws {AppwriteException}
      * @returns {Promise<Models.DocumentList<Document>>}
      * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.listRows` instead.
@@ -1804,6 +1805,7 @@ export declare class Databases {
         queries?: string[];
         transactionId?: string;
         total?: boolean;
+        ttl?: number;
     }): Promise<Models.DocumentList<Document>>;
     /**
      * Get a list of all the user's documents in a given collection. You can use the query params to filter your results.
@@ -1813,11 +1815,12 @@ export declare class Databases {
      * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
      * @param {string} transactionId - Transaction ID to read uncommitted changes within the transaction.
      * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
+     * @param {number} ttl - TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).
      * @throws {AppwriteException}
      * @returns {Promise<Models.DocumentList<Document>>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listDocuments<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, queries?: string[], transactionId?: string, total?: boolean): Promise<Models.DocumentList<Document>>;
+    listDocuments<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, queries?: string[], transactionId?: string, total?: boolean, ttl?: number): Promise<Models.DocumentList<Document>>;
     /**
      * Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
      *