@appwrite.io/console 3.0.0 → 4.0.0

package/src/models.ts

@@ -12,6 +12,7 @@ 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 { DomainTransferStatusStatus } from "./enums/domain-transfer-status-status"
 
 /**
  * Appwrite Models
@@ -2627,7 +2628,7 @@ export namespace Models {
          */
         $id: string;
         /**
-         * Row automatically incrementing ID.
+         * Row sequence ID.
          */
         $sequence: number;
         /**
@@ -2666,7 +2667,7 @@ export namespace Models {
          */
         $id: string;
         /**
-         * Document automatically incrementing ID.
+         * Document sequence ID.
          */
         $sequence: number;
         /**
@@ -4015,6 +4016,14 @@ export 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.
          */
@@ -4053,6 +4062,14 @@ export 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.
          */
@@ -4095,6 +4112,14 @@ export 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.
          */
@@ -4753,6 +4778,10 @@ export 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;
     }
 
     /**
@@ -6401,6 +6430,50 @@ export 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;
     }
 
     /**
@@ -6813,6 +6886,10 @@ export namespace Models {
          * Number of functions to be migrated.
          */
         function: number;
+        /**
+         * Number of sites to be migrated.
+         */
+        site: number;
         /**
          * Size of files to be migrated in mb.
          */
@@ -7355,6 +7432,10 @@ export 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
          */
@@ -8567,6 +8648,10 @@ export namespace Models {
          * Domain registrar (e.g. "appwrite" or "third_party").
          */
         registrar: string;
+        /**
+         * Payment status for domain purchase.
+         */
+        paymentStatus: string;
         /**
          * Nameservers setting. "Appwrite" or empty string.
          */
@@ -8584,7 +8669,7 @@ export namespace Models {
          */
         autoRenewal: boolean;
         /**
-         * Renewal price (in USD).
+         * Renewal price (in cents).
          */
         renewalPrice: number;
         /**
@@ -8595,6 +8680,10 @@ export namespace Models {
          * Dns records
          */
         dnsRecords: DnsRecord[];
+        /**
+         * Domain transfer status (e.g., "pending", "completed", "failed").
+         */
+        transferStatus: string;
     }
 
     /**
@@ -8851,6 +8940,10 @@ export namespace Models {
          * Price period in years.
          */
         periodYears: number;
+        /**
+         * Whether the domain is a premium domain.
+         */
+        premium: boolean;
     }
 
     /**
@@ -8875,6 +8968,34 @@ export 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/src/query.ts

@@ -272,7 +272,9 @@ export class Query {
 
   /**
    * Filter resources where attribute contains the specified value.
+   * For string attributes, checks if the string contains the substring.
    *
+   * Note: For array attributes, use {@link containsAny} or {@link containsAll} instead.
    * @param {string} attribute
    * @param {string | string[]} value
    * @returns {string}
@@ -280,6 +282,30 @@ export class Query {
   static contains = (attribute: string, value: string | any[]): string =>
     new Query("contains", attribute, value).toString();
 
+  /**
+   * Filter resources where attribute contains ANY of the specified values.
+   * For array and relationship attributes, matches documents where the attribute
+   * contains at least one of the given values.
+   *
+   * @param {string} attribute
+   * @param {any[]} value
+   * @returns {string}
+   */
+  static containsAny = (attribute: string, value: any[]): string =>
+    new Query("containsAny", attribute, value).toString();
+
+  /**
+   * Filter resources where attribute contains ALL of the specified values.
+   * For array and relationship attributes, matches documents where the attribute
+   * contains every one of the given values.
+   *
+   * @param {string} attribute
+   * @param {any[]} value
+   * @returns {string}
+   */
+  static containsAll = (attribute: string, value: any[]): string =>
+    new Query("containsAll", attribute, value).toString();
+
   /**
    * Filter resources where attribute does not contain the specified value.
    *

package/src/services/account.ts

@@ -835,7 +835,7 @@ export class Account {
     }
 
     /**
-     * Get a list of all API keys from the current account. 
+     * 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}
@@ -843,7 +843,7 @@ export class Account {
      */
     listKeys(params?: { total?: boolean }): Promise<Models.KeyList>;
     /**
-     * Get a list of all API keys from the current account. 
+     * 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}

package/src/services/databases.ts

@@ -1188,7 +1188,7 @@ export 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.
@@ -1203,7 +1203,7 @@ export 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.
@@ -3660,6 +3660,90 @@ export class Databases {
         );
     }
 
+    /**
+     * 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>;
+    updateRelationshipAttribute(
+        paramsOrFirst: { databaseId: string, collectionId: string, key: string, onDelete?: RelationMutate, newKey?: string } | string,
+        ...rest: [(string)?, (string)?, (RelationMutate)?, (string)?]    
+    ): Promise<Models.AttributeRelationship> {
+        let params: { databaseId: string, collectionId: string, key: string, onDelete?: RelationMutate, newKey?: string };
+        
+        if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
+            params = (paramsOrFirst || {}) as { databaseId: string, collectionId: string, key: string, onDelete?: RelationMutate, newKey?: string };
+        } else {
+            params = {
+                databaseId: paramsOrFirst as string,
+                collectionId: rest[0] as string,
+                key: rest[1] as string,
+                onDelete: rest[2] as RelationMutate,
+                newKey: rest[3] as string            
+            };
+        }
+        
+        const databaseId = params.databaseId;
+        const collectionId = params.collectionId;
+        const key = params.key;
+        const onDelete = params.onDelete;
+        const newKey = params.newKey;
+
+        if (typeof databaseId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "databaseId"');
+        }
+        if (typeof collectionId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "collectionId"');
+        }
+        if (typeof key === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "key"');
+        }
+
+        const apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/relationship/{key}'.replace('{databaseId}', databaseId).replace('{collectionId}', collectionId).replace('{key}', key);
+        const payload: Payload = {};
+        if (typeof onDelete !== 'undefined') {
+            payload['onDelete'] = onDelete;
+        }
+        if (typeof newKey !== 'undefined') {
+            payload['newKey'] = newKey;
+        }
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        const apiHeaders: { [header: string]: string } = {
+            'content-type': 'application/json',
+        }
+
+        return this.client.call(
+            'patch',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
+
     /**
      * Create a string attribute.
      * 
@@ -4622,90 +4706,6 @@ export class Databases {
         );
     }
 
-    /**
-     * 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>;
-    updateRelationshipAttribute(
-        paramsOrFirst: { databaseId: string, collectionId: string, key: string, onDelete?: RelationMutate, newKey?: string } | string,
-        ...rest: [(string)?, (string)?, (RelationMutate)?, (string)?]    
-    ): Promise<Models.AttributeRelationship> {
-        let params: { databaseId: string, collectionId: string, key: string, onDelete?: RelationMutate, newKey?: string };
-        
-        if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
-            params = (paramsOrFirst || {}) as { databaseId: string, collectionId: string, key: string, onDelete?: RelationMutate, newKey?: string };
-        } else {
-            params = {
-                databaseId: paramsOrFirst as string,
-                collectionId: rest[0] as string,
-                key: rest[1] as string,
-                onDelete: rest[2] as RelationMutate,
-                newKey: rest[3] as string            
-            };
-        }
-        
-        const databaseId = params.databaseId;
-        const collectionId = params.collectionId;
-        const key = params.key;
-        const onDelete = params.onDelete;
-        const newKey = params.newKey;
-
-        if (typeof databaseId === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "databaseId"');
-        }
-        if (typeof collectionId === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "collectionId"');
-        }
-        if (typeof key === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "key"');
-        }
-
-        const apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}/relationship'.replace('{databaseId}', databaseId).replace('{collectionId}', collectionId).replace('{key}', key);
-        const payload: Payload = {};
-        if (typeof onDelete !== 'undefined') {
-            payload['onDelete'] = onDelete;
-        }
-        if (typeof newKey !== 'undefined') {
-            payload['newKey'] = newKey;
-        }
-        const uri = new URL(this.client.config.endpoint + apiPath);
-
-        const apiHeaders: { [header: string]: string } = {
-            'content-type': 'application/json',
-        }
-
-        return this.client.call(
-            'patch',
-            uri,
-            apiHeaders,
-            payload
-        );
-    }
-
     /**
      * Get a list of all the user's documents in a given collection. You can use the query params to filter your results.
      *
@@ -4714,11 +4714,12 @@ export 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.
      */
-    listDocuments<Document extends Models.Document = Models.DefaultDocument>(params: { databaseId: string, collectionId: string, queries?: string[], transactionId?: string, total?: boolean }): Promise<Models.DocumentList<Document>>;
+    listDocuments<Document extends Models.Document = Models.DefaultDocument>(params: { databaseId: string, collectionId: string, 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.
      *
@@ -4727,26 +4728,28 @@ export 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>>;
     listDocuments<Document extends Models.Document = Models.DefaultDocument>(
-        paramsOrFirst: { databaseId: string, collectionId: string, queries?: string[], transactionId?: string, total?: boolean } | string,
-        ...rest: [(string)?, (string[])?, (string)?, (boolean)?]    
+        paramsOrFirst: { databaseId: string, collectionId: string, queries?: string[], transactionId?: string, total?: boolean, ttl?: number } | string,
+        ...rest: [(string)?, (string[])?, (string)?, (boolean)?, (number)?]    
     ): Promise<Models.DocumentList<Document>> {
-        let params: { databaseId: string, collectionId: string, queries?: string[], transactionId?: string, total?: boolean };
+        let params: { databaseId: string, collectionId: string, queries?: string[], transactionId?: string, total?: boolean, ttl?: number };
         
         if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
-            params = (paramsOrFirst || {}) as { databaseId: string, collectionId: string, queries?: string[], transactionId?: string, total?: boolean };
+            params = (paramsOrFirst || {}) as { databaseId: string, collectionId: string, queries?: string[], transactionId?: string, total?: boolean, ttl?: number };
         } else {
             params = {
                 databaseId: paramsOrFirst as string,
                 collectionId: rest[0] as string,
                 queries: rest[1] as string[],
                 transactionId: rest[2] as string,
-                total: rest[3] as boolean            
+                total: rest[3] as boolean,
+                ttl: rest[4] as number            
             };
         }
         
@@ -4755,6 +4758,7 @@ export class Databases {
         const queries = params.queries;
         const transactionId = params.transactionId;
         const total = params.total;
+        const ttl = params.ttl;
 
         if (typeof databaseId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "databaseId"');
@@ -4774,6 +4778,9 @@ export class Databases {
         if (typeof total !== 'undefined') {
             payload['total'] = total;
         }
+        if (typeof ttl !== 'undefined') {
+            payload['ttl'] = ttl;
+        }
         const uri = new URL(this.client.config.endpoint + apiPath);
 
         const apiHeaders: { [header: string]: string } = {