@appwrite.io/console 8.3.0 → 9.0.0

package/package.json

@@ -2,7 +2,7 @@
   "name": "@appwrite.io/console",
   "homepage": "https://appwrite.io/support",
   "description": "Appwrite is an open-source self-hosted backend server that abstracts and simplifies complex and repetitive development tasks behind a very simple REST API",
-  "version": "8.3.0",
+  "version": "9.0.0",
   "license": "BSD-3-Clause",
   "main": "dist/cjs/sdk.js",
   "exports": {

package/types/enums/o-auth-provider.d.ts

@@ -33,6 +33,7 @@ export declare enum OAuthProvider {
     TradeshiftBox = "tradeshiftBox",
     Twitch = "twitch",
     Wordpress = "wordpress",
+    X = "x",
     Yahoo = "yahoo",
     Yammer = "yammer",
     Yandex = "yandex",

package/types/enums/platform-type.d.ts

@@ -1,17 +1,7 @@
 export declare enum PlatformType {
-    Web = "web",
-    Flutterweb = "flutter-web",
-    Flutterios = "flutter-ios",
-    Flutterandroid = "flutter-android",
-    Flutterlinux = "flutter-linux",
-    Fluttermacos = "flutter-macos",
-    Flutterwindows = "flutter-windows",
-    Appleios = "apple-ios",
-    Applemacos = "apple-macos",
-    Applewatchos = "apple-watchos",
-    Appletvos = "apple-tvos",
+    Windows = "windows",
+    Apple = "apple",
     Android = "android",
-    Unity = "unity",
-    Reactnativeios = "react-native-ios",
-    Reactnativeandroid = "react-native-android"
+    Linux = "linux",
+    Web = "web"
 }

package/types/enums/protocol-id.d.ts

@@ -0,0 +1,5 @@
+export declare enum ProtocolId {
+    Rest = "rest",
+    Graphql = "graphql",
+    Websocket = "websocket"
+}

package/types/enums/scopes.d.ts

@@ -61,6 +61,10 @@ export declare enum Scopes {
     WebhooksWrite = "webhooks.write",
     ProjectRead = "project.read",
     ProjectWrite = "project.write",
+    KeysRead = "keys.read",
+    KeysWrite = "keys.write",
+    PlatformsRead = "platforms.read",
+    PlatformsWrite = "platforms.write",
     PoliciesWrite = "policies.write",
     PoliciesRead = "policies.read",
     ArchivesRead = "archives.read",
@@ -70,12 +74,8 @@ export declare enum Scopes {
     DomainsRead = "domains.read",
     DomainsWrite = "domains.write",
     EventsRead = "events.read",
-    PlatformsRead = "platforms.read",
-    PlatformsWrite = "platforms.write",
     ProjectsRead = "projects.read",
     ProjectsWrite = "projects.write",
-    KeysRead = "keys.read",
-    KeysWrite = "keys.write",
     DevKeysRead = "devKeys.read",
     DevKeysWrite = "devKeys.write"
 }

package/types/enums/{api-service.d.ts → service-id.d.ts}

@@ -1,15 +1,19 @@
-export declare enum ApiService {
+export declare enum ServiceId {
     Account = "account",
     Avatars = "avatars",
     Databases = "databases",
     Tablesdb = "tablesdb",
     Locale = "locale",
     Health = "health",
+    Project = "project",
     Storage = "storage",
     Teams = "teams",
     Users = "users",
+    Vcs = "vcs",
     Sites = "sites",
     Functions = "functions",
+    Proxy = "proxy",
     Graphql = "graphql",
+    Migrations = "migrations",
     Messaging = "messaging"
 }

package/types/index.d.ts

@@ -77,13 +77,12 @@ export { FirebaseMigrationResource } from './enums/firebase-migration-resource';
 export { NHostMigrationResource } from './enums/n-host-migration-resource';
 export { SupabaseMigrationResource } from './enums/supabase-migration-resource';
 export { Addon } from './enums/addon';
+export { ProtocolId } from './enums/protocol-id';
+export { ServiceId } from './enums/service-id';
 export { ProjectUsageRange } from './enums/project-usage-range';
 export { Region } from './enums/region';
-export { Api } from './enums/api';
 export { AuthMethod } from './enums/auth-method';
-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';
@@ -109,6 +108,7 @@ export { IndexStatus } from './enums/index-status';
 export { DeploymentStatus } from './enums/deployment-status';
 export { ExecutionTrigger } from './enums/execution-trigger';
 export { ExecutionStatus } from './enums/execution-status';
+export { PlatformType } from './enums/platform-type';
 export { HealthAntivirusStatus } from './enums/health-antivirus-status';
 export { HealthCheckStatus } from './enums/health-check-status';
 export { ProxyRuleDeploymentResourceType } from './enums/proxy-rule-deployment-resource-type';

package/types/models.d.ts

@@ -435,19 +435,6 @@ export declare namespace Models {
          */
         devKeys: DevKey[];
     };
-    /**
-     * Platforms List
-     */
-    export type PlatformList = {
-        /**
-         * Total number of platforms that matched your query.
-         */
-        total: number;
-        /**
-         * List of platforms.
-         */
-        platforms: Platform[];
-    };
     /**
      * Countries List
      */
@@ -2622,6 +2609,10 @@ export declare namespace Models {
          * API mode when event triggered.
          */
         mode: string;
+        /**
+         * User type who triggered the audit log. Possible values: user, admin, guest, keyProject, keyAccount, keyOrganization.
+         */
+        userType: string;
         /**
          * IP session in use when the session was created.
          */
@@ -4518,7 +4509,7 @@ export declare namespace Models {
         /**
          * List of Platforms.
          */
-        platforms: Platform[];
+        platforms: (Models.PlatformWeb | Models.PlatformApple | Models.PlatformAndroid | Models.PlatformWindows | Models.PlatformLinux)[];
         /**
          * List of Webhooks.
          */
@@ -4635,6 +4626,10 @@ export declare namespace Models {
          * Health service status
          */
         serviceStatusForHealth: boolean;
+        /**
+         * Project service status
+         */
+        serviceStatusForProject: boolean;
         /**
          * Storage service status
          */
@@ -4647,6 +4642,10 @@ export declare namespace Models {
          * Users service status
          */
         serviceStatusForUsers: boolean;
+        /**
+         * VCS service status
+         */
+        serviceStatusForVcs: boolean;
         /**
          * Sites service status
          */
@@ -4655,14 +4654,34 @@ export declare namespace Models {
          * Functions service status
          */
         serviceStatusForFunctions: boolean;
+        /**
+         * Proxy service status
+         */
+        serviceStatusForProxy: boolean;
         /**
          * GraphQL service status
          */
         serviceStatusForGraphql: boolean;
+        /**
+         * Migrations service status
+         */
+        serviceStatusForMigrations: boolean;
         /**
          * Messaging service status
          */
         serviceStatusForMessaging: boolean;
+        /**
+         * REST protocol status
+         */
+        protocolStatusForRest: boolean;
+        /**
+         * GraphQL protocol status
+         */
+        protocolStatusForGraphql: boolean;
+        /**
+         * Websocket protocol status
+         */
+        protocolStatusForWebsocket: boolean;
         /**
          * Project region
          */
@@ -4709,21 +4728,21 @@ export declare namespace Models {
          */
         events: string[];
         /**
-         * Indicated if SSL / TLS Certificate verification is enabled.
+         * Indicates if SSL / TLS certificate verification is enabled.
          */
-        security: boolean;
+        tls: boolean;
         /**
          * HTTP basic authentication username.
          */
-        httpUser: string;
+        authUsername: string;
         /**
          * HTTP basic authentication password.
          */
-        httpPass: string;
+        authPassword: string;
         /**
-         * Signature key which can be used to validated incoming
+         * Signature key which can be used to validate incoming webhook payloads.
          */
-        signatureKey: string;
+        secret: string;
         /**
          * Indicates if this webhook is enabled.
          */
@@ -4854,9 +4873,9 @@ export declare namespace Models {
         enabled: boolean;
     };
     /**
-     * Platform
+     * Platform Web
      */
-    export type Platform = {
+    export type PlatformWeb = {
         /**
          * Platform ID.
          */
@@ -4874,29 +4893,142 @@ export declare namespace Models {
          */
         name: string;
         /**
-         * Platform type. Possible values are: web, flutter-web, flutter-ios, flutter-android, flutter-linux, flutter-macos, flutter-windows, apple-ios, apple-macos, apple-watchos, apple-tvos, android, unity, react-native-ios, react-native-android.
+         * Platform type. Possible values are: windows, apple, android, linux, web.
          */
         type: PlatformType;
         /**
-         * Platform Key. iOS bundle ID or Android package name.  Empty string for other platforms.
+         * Web app hostname. Empty string for other platforms.
          */
-        key: string;
+        hostname: string;
+    };
+    /**
+     * Platform Apple
+     */
+    export type PlatformApple = {
         /**
-         * App store or Google Play store ID.
+         * Platform ID.
          */
-        store: string;
+        $id: string;
         /**
-         * Web app hostname. Empty string for other platforms.
+         * Platform creation date in ISO 8601 format.
          */
-        hostname: string;
+        $createdAt: string;
         /**
-         * HTTP basic authentication username.
+         * Platform update date in ISO 8601 format.
          */
-        httpUser: string;
+        $updatedAt: string;
         /**
-         * HTTP basic authentication password.
+         * Platform name.
          */
-        httpPass: string;
+        name: string;
+        /**
+         * Platform type. Possible values are: windows, apple, android, linux, web.
+         */
+        type: PlatformType;
+        /**
+         * Apple bundle identifier.
+         */
+        bundleIdentifier: string;
+    };
+    /**
+     * Platform Android
+     */
+    export type PlatformAndroid = {
+        /**
+         * Platform ID.
+         */
+        $id: string;
+        /**
+         * Platform creation date in ISO 8601 format.
+         */
+        $createdAt: string;
+        /**
+         * Platform update date in ISO 8601 format.
+         */
+        $updatedAt: string;
+        /**
+         * Platform name.
+         */
+        name: string;
+        /**
+         * Platform type. Possible values are: windows, apple, android, linux, web.
+         */
+        type: PlatformType;
+        /**
+         * Android application ID.
+         */
+        applicationId: string;
+    };
+    /**
+     * Platform Windows
+     */
+    export type PlatformWindows = {
+        /**
+         * Platform ID.
+         */
+        $id: string;
+        /**
+         * Platform creation date in ISO 8601 format.
+         */
+        $createdAt: string;
+        /**
+         * Platform update date in ISO 8601 format.
+         */
+        $updatedAt: string;
+        /**
+         * Platform name.
+         */
+        name: string;
+        /**
+         * Platform type. Possible values are: windows, apple, android, linux, web.
+         */
+        type: PlatformType;
+        /**
+         * Windows package identifier name.
+         */
+        packageIdentifierName: string;
+    };
+    /**
+     * Platform Linux
+     */
+    export type PlatformLinux = {
+        /**
+         * Platform ID.
+         */
+        $id: string;
+        /**
+         * Platform creation date in ISO 8601 format.
+         */
+        $createdAt: string;
+        /**
+         * Platform update date in ISO 8601 format.
+         */
+        $updatedAt: string;
+        /**
+         * Platform name.
+         */
+        name: string;
+        /**
+         * Platform type. Possible values are: windows, apple, android, linux, web.
+         */
+        type: PlatformType;
+        /**
+         * Linux package name.
+         */
+        packageName: string;
+    };
+    /**
+     * Platforms List
+     */
+    export type PlatformList = {
+        /**
+         * Total number of platforms in the given project.
+         */
+        total: number;
+        /**
+         * List of platforms.
+         */
+        platforms: (Models.PlatformWeb | Models.PlatformApple | Models.PlatformAndroid | Models.PlatformWindows | Models.PlatformLinux)[];
     };
     /**
      * Variable
@@ -6256,7 +6388,7 @@ export declare namespace Models {
         /**
          * Type of deployment. Possible values are "function", "site". Used if rule's type is "deployment".
          */
-        deploymentResourceType: ProxyRuleDeploymentResourceType;
+        deploymentResourceType?: ProxyRuleDeploymentResourceType;
         /**
          * ID deployment's resource. Used if type is "deployment"
          */
@@ -7520,6 +7652,18 @@ export declare namespace Models {
          * Does plan support credit
          */
         supportsCredits: boolean;
+        /**
+         * Does plan support blocking disposable email addresses.
+         */
+        supportsDisposableEmailValidation: boolean;
+        /**
+         * Does plan support requiring canonical email addresses.
+         */
+        supportsCanonicalEmailValidation: boolean;
+        /**
+         * Does plan support blocking free email addresses.
+         */
+        supportsFreeEmailValidation: boolean;
         /**
          * Does plan support backup policies.
          */

package/types/services/account.d.ts

@@ -1076,7 +1076,7 @@ export declare class Account {
      * A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).
      *
      *
-     * @param {OAuthProvider} params.provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.
+     * @param {OAuthProvider} params.provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.
      * @param {string} params.success - URL to redirect back to your app after a successful login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
      * @param {string} params.failure - URL to redirect back to your app after a failed login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
      * @param {string[]} params.scopes - A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.
@@ -1097,7 +1097,7 @@ export declare class Account {
      * A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).
      *
      *
-     * @param {OAuthProvider} provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.
+     * @param {OAuthProvider} provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.
      * @param {string} success - URL to redirect back to your app after a successful login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
      * @param {string} failure - URL to redirect back to your app after a failed login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
      * @param {string[]} scopes - A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.
@@ -1353,7 +1353,7 @@ export declare class Account {
      *
      * A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).
      *
-     * @param {OAuthProvider} params.provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.
+     * @param {OAuthProvider} params.provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.
      * @param {string} params.success - URL to redirect back to your app after a successful login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
      * @param {string} params.failure - URL to redirect back to your app after a failed login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
      * @param {string[]} params.scopes - A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.
@@ -1373,7 +1373,7 @@ export declare class Account {
      *
      * A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).
      *
-     * @param {OAuthProvider} provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.
+     * @param {OAuthProvider} provider - OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, x, yahoo, yammer, yandex, zoho, zoom.
      * @param {string} success - URL to redirect back to your app after a successful login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
      * @param {string} failure - URL to redirect back to your app after a failed login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
      * @param {string[]} scopes - A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.

package/types/services/databases.d.ts

@@ -373,6 +373,7 @@ export declare class Databases {
      * @param {string[]} params.permissions - An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
      * @param {boolean} params.documentSecurity - Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https://appwrite.io/docs/permissions).
      * @param {boolean} params.enabled - Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.
+     * @param {boolean} params.purge - When true, purge all cached list responses for this collection as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Collection>}
      * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.updateTable` instead.
@@ -384,6 +385,7 @@ export declare class Databases {
         permissions?: string[];
         documentSecurity?: boolean;
         enabled?: boolean;
+        purge?: boolean;
     }): Promise<Models.Collection>;
     /**
      * Update a collection by its unique ID.
@@ -394,11 +396,12 @@ export declare class Databases {
      * @param {string[]} permissions - An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
      * @param {boolean} documentSecurity - Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https://appwrite.io/docs/permissions).
      * @param {boolean} enabled - Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.
+     * @param {boolean} purge - When true, purge all cached list responses for this collection as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Collection>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    updateCollection(databaseId: string, collectionId: string, name?: string, permissions?: string[], documentSecurity?: boolean, enabled?: boolean): Promise<Models.Collection>;
+    updateCollection(databaseId: string, collectionId: string, name?: string, permissions?: string[], documentSecurity?: boolean, enabled?: boolean, purge?: boolean): Promise<Models.Collection>;
     /**
      * Delete a collection by its unique ID. Only users with write permissions have access to delete this resource.
      *
@@ -1794,7 +1797,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).
+     * @param {number} params.ttl - TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, collection, schema version (attributes and indexes), caller authorization roles, and the exact query — so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; document writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. 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.
@@ -1815,7 +1818,7 @@ 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).
+     * @param {number} ttl - TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, collection, schema version (attributes and indexes), caller authorization roles, and the exact query — so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; document writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. 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.