@appwrite.io/console 3.1.0 → 5.0.0

package/types/services/sites.d.ts

@@ -49,6 +49,7 @@ export declare class Sites {
      * @param {number} params.timeout - Maximum request time in seconds.
      * @param {string} params.installCommand - Install Command.
      * @param {string} params.buildCommand - Build Command.
+     * @param {string} params.startCommand - Custom start command. Leave empty to use default.
      * @param {string} params.outputDirectory - Output Directory for site.
      * @param {Adapter} params.adapter - Framework adapter defining rendering strategy. Allowed values are: static, ssr
      * @param {string} params.installationId - Appwrite Installation ID for VCS (Version Control System) deployment.
@@ -57,7 +58,9 @@ export declare class Sites {
      * @param {string} params.providerBranch - Production branch for the repo linked to the site.
      * @param {boolean} params.providerSilentMode - Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.
      * @param {string} params.providerRootDirectory - Path to site code in the linked repo.
-     * @param {string} params.specification - Framework specification for the site and builds.
+     * @param {string} params.buildSpecification - Build specification for the site deployments.
+     * @param {string} params.runtimeSpecification - Runtime specification for the SSR executions.
+     * @param {number} params.deploymentRetention - Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Site>}
      */
@@ -71,6 +74,7 @@ export declare class Sites {
         timeout?: number;
         installCommand?: string;
         buildCommand?: string;
+        startCommand?: string;
         outputDirectory?: string;
         adapter?: Adapter;
         installationId?: string;
@@ -79,7 +83,9 @@ export declare class Sites {
         providerBranch?: string;
         providerSilentMode?: boolean;
         providerRootDirectory?: string;
-        specification?: string;
+        buildSpecification?: string;
+        runtimeSpecification?: string;
+        deploymentRetention?: number;
     }): Promise<Models.Site>;
     /**
      * Create a new site.
@@ -93,6 +99,7 @@ export declare class Sites {
      * @param {number} timeout - Maximum request time in seconds.
      * @param {string} installCommand - Install Command.
      * @param {string} buildCommand - Build Command.
+     * @param {string} startCommand - Custom start command. Leave empty to use default.
      * @param {string} outputDirectory - Output Directory for site.
      * @param {Adapter} adapter - Framework adapter defining rendering strategy. Allowed values are: static, ssr
      * @param {string} installationId - Appwrite Installation ID for VCS (Version Control System) deployment.
@@ -101,12 +108,14 @@ export declare class Sites {
      * @param {string} providerBranch - Production branch for the repo linked to the site.
      * @param {boolean} providerSilentMode - Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.
      * @param {string} providerRootDirectory - Path to site code in the linked repo.
-     * @param {string} specification - Framework specification for the site and builds.
+     * @param {string} buildSpecification - Build specification for the site deployments.
+     * @param {string} runtimeSpecification - Runtime specification for the SSR executions.
+     * @param {number} deploymentRetention - Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Site>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    create(siteId: string, name: string, framework: Framework, buildRuntime: BuildRuntime, enabled?: boolean, logging?: boolean, timeout?: number, installCommand?: string, buildCommand?: string, outputDirectory?: string, adapter?: Adapter, installationId?: string, fallbackFile?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, specification?: string): Promise<Models.Site>;
+    create(siteId: string, name: string, framework: Framework, buildRuntime: BuildRuntime, enabled?: boolean, logging?: boolean, timeout?: number, installCommand?: string, buildCommand?: string, startCommand?: string, outputDirectory?: string, adapter?: Adapter, installationId?: string, fallbackFile?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, buildSpecification?: string, runtimeSpecification?: string, deploymentRetention?: number): Promise<Models.Site>;
     /**
      * Get a list of all frameworks that are currently available on the server instance.
      *
@@ -217,6 +226,7 @@ export declare class Sites {
      * @param {number} params.timeout - Maximum request time in seconds.
      * @param {string} params.installCommand - Install Command.
      * @param {string} params.buildCommand - Build Command.
+     * @param {string} params.startCommand - Custom start command. Leave empty to use default.
      * @param {string} params.outputDirectory - Output Directory for site.
      * @param {BuildRuntime} params.buildRuntime - Runtime to use during build step.
      * @param {Adapter} params.adapter - Framework adapter defining rendering strategy. Allowed values are: static, ssr
@@ -226,7 +236,9 @@ export declare class Sites {
      * @param {string} params.providerBranch - Production branch for the repo linked to the site.
      * @param {boolean} params.providerSilentMode - Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.
      * @param {string} params.providerRootDirectory - Path to site code in the linked repo.
-     * @param {string} params.specification - Framework specification for the site and builds.
+     * @param {string} params.buildSpecification - Build specification for the site deployments.
+     * @param {string} params.runtimeSpecification - Runtime specification for the SSR executions.
+     * @param {number} params.deploymentRetention - Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Site>}
      */
@@ -239,6 +251,7 @@ export declare class Sites {
         timeout?: number;
         installCommand?: string;
         buildCommand?: string;
+        startCommand?: string;
         outputDirectory?: string;
         buildRuntime?: BuildRuntime;
         adapter?: Adapter;
@@ -248,7 +261,9 @@ export declare class Sites {
         providerBranch?: string;
         providerSilentMode?: boolean;
         providerRootDirectory?: string;
-        specification?: string;
+        buildSpecification?: string;
+        runtimeSpecification?: string;
+        deploymentRetention?: number;
     }): Promise<Models.Site>;
     /**
      * Update site by its unique ID.
@@ -261,6 +276,7 @@ export declare class Sites {
      * @param {number} timeout - Maximum request time in seconds.
      * @param {string} installCommand - Install Command.
      * @param {string} buildCommand - Build Command.
+     * @param {string} startCommand - Custom start command. Leave empty to use default.
      * @param {string} outputDirectory - Output Directory for site.
      * @param {BuildRuntime} buildRuntime - Runtime to use during build step.
      * @param {Adapter} adapter - Framework adapter defining rendering strategy. Allowed values are: static, ssr
@@ -270,12 +286,14 @@ export declare class Sites {
      * @param {string} providerBranch - Production branch for the repo linked to the site.
      * @param {boolean} providerSilentMode - Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.
      * @param {string} providerRootDirectory - Path to site code in the linked repo.
-     * @param {string} specification - Framework specification for the site and builds.
+     * @param {string} buildSpecification - Build specification for the site deployments.
+     * @param {string} runtimeSpecification - Runtime specification for the SSR executions.
+     * @param {number} deploymentRetention - Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Site>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    update(siteId: string, name: string, framework: Framework, enabled?: boolean, logging?: boolean, timeout?: number, installCommand?: string, buildCommand?: string, outputDirectory?: string, buildRuntime?: BuildRuntime, adapter?: Adapter, fallbackFile?: string, installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, specification?: string): Promise<Models.Site>;
+    update(siteId: string, name: string, framework: Framework, enabled?: boolean, logging?: boolean, timeout?: number, installCommand?: string, buildCommand?: string, startCommand?: string, outputDirectory?: string, buildRuntime?: BuildRuntime, adapter?: Adapter, fallbackFile?: string, installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, buildSpecification?: string, runtimeSpecification?: string, deploymentRetention?: number): Promise<Models.Site>;
     /**
      * Delete a site by its unique ID.
      *
@@ -350,20 +368,20 @@ export declare class Sites {
      *
      * @param {string} params.siteId - Site ID.
      * @param {File} params.code - Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.
-     * @param {boolean} params.activate - Automatically activate the deployment when it is finished building.
      * @param {string} params.installCommand - Install Commands.
      * @param {string} params.buildCommand - Build Commands.
      * @param {string} params.outputDirectory - Output Directory.
+     * @param {boolean} params.activate - Automatically activate the deployment when it is finished building.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Deployment>}
      */
     createDeployment(params: {
         siteId: string;
         code: File;
-        activate: boolean;
         installCommand?: string;
         buildCommand?: string;
         outputDirectory?: string;
+        activate?: boolean;
         onProgress?: (progress: UploadProgress) => void;
     }): Promise<Models.Deployment>;
     /**
@@ -371,15 +389,15 @@ export declare class Sites {
      *
      * @param {string} siteId - Site ID.
      * @param {File} code - Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.
-     * @param {boolean} activate - Automatically activate the deployment when it is finished building.
      * @param {string} installCommand - Install Commands.
      * @param {string} buildCommand - Build Commands.
      * @param {string} outputDirectory - Output Directory.
+     * @param {boolean} activate - Automatically activate the deployment when it is finished building.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Deployment>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    createDeployment(siteId: string, code: File, activate: boolean, installCommand?: string, buildCommand?: string, outputDirectory?: string, onProgress?: (progress: UploadProgress) => void): Promise<Models.Deployment>;
+    createDeployment(siteId: string, code: File, installCommand?: string, buildCommand?: string, outputDirectory?: string, activate?: boolean, onProgress?: (progress: UploadProgress) => void): Promise<Models.Deployment>;
     /**
      * Create a new build for an existing site deployment. This endpoint allows you to rebuild a deployment with the updated site configuration, including its commands and output directory if they have been modified. The build process will be queued and executed asynchronously. The original deployment's code will be preserved and used for the new build.
      *

package/types/services/tables-db.d.ts

@@ -1896,6 +1896,7 @@ export declare class TablesDB {
      * @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.RowList<Row>>}
      */
@@ -1905,6 +1906,7 @@ export declare class TablesDB {
         queries?: string[];
         transactionId?: string;
         total?: boolean;
+        ttl?: number;
     }): Promise<Models.RowList<Row>>;
     /**
      * Get a list of all the user's rows in a given table. You can use the query params to filter your results.
@@ -1914,11 +1916,12 @@ export declare class TablesDB {
      * @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.RowList<Row>>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listRows<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, queries?: string[], transactionId?: string, total?: boolean): Promise<Models.RowList<Row>>;
+    listRows<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, queries?: string[], transactionId?: string, total?: boolean, ttl?: number): Promise<Models.RowList<Row>>;
     /**
      * Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable) API or directly from your database console.
      *

package/types/services/teams.d.ts

@@ -177,7 +177,7 @@ export declare class Teams {
      *
      *
      * @param {string} params.teamId - Team ID.
-     * @param {string[]} params.roles - Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
+     * @param {string[]} params.roles - Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 81 characters long.
      * @param {string} params.email - Email of the new team member.
      * @param {string} params.userId - ID of the user to be added to a team.
      * @param {string} params.phone - Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
@@ -206,7 +206,7 @@ export declare class Teams {
      *
      *
      * @param {string} teamId - Team ID.
-     * @param {string[]} roles - Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
+     * @param {string[]} roles - Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 81 characters long.
      * @param {string} email - Email of the new team member.
      * @param {string} userId - ID of the user to be added to a team.
      * @param {string} phone - Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
@@ -245,7 +245,7 @@ export declare class Teams {
      *
      * @param {string} params.teamId - Team ID.
      * @param {string} params.membershipId - Membership ID.
-     * @param {string[]} params.roles - An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
+     * @param {string[]} params.roles - An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 81 characters long.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Membership>}
      */
@@ -260,7 +260,7 @@ export declare class Teams {
      *
      * @param {string} teamId - Team ID.
      * @param {string} membershipId - Membership ID.
-     * @param {string[]} roles - An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.
+     * @param {string[]} roles - An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 81 characters long.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Membership>}
      * @deprecated Use the object parameter style method for a better developer experience.