@appwrite.io/console 4.0.0 → 5.0.0

package/types/services/functions.d.ts

@@ -57,7 +57,9 @@ export declare class Functions {
      * @param {string} params.providerBranch - Production branch for the repo linked to the function.
      * @param {boolean} params.providerSilentMode - Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.
      * @param {string} params.providerRootDirectory - Path to function code in the linked repo.
-     * @param {string} params.specification - Runtime specification for the function and builds.
+     * @param {string} params.buildSpecification - Build specification for the function deployments.
+     * @param {string} params.runtimeSpecification - Runtime specification for the function 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.Function>}
      */
@@ -79,7 +81,9 @@ export declare class Functions {
         providerBranch?: string;
         providerSilentMode?: boolean;
         providerRootDirectory?: string;
-        specification?: string;
+        buildSpecification?: string;
+        runtimeSpecification?: string;
+        deploymentRetention?: number;
     }): Promise<Models.Function>;
     /**
      * Create a new function. You can pass a list of [permissions](https://appwrite.io/docs/permissions) to allow different project users or team with access to execute the function using the client API.
@@ -101,12 +105,14 @@ export declare class Functions {
      * @param {string} providerBranch - Production branch for the repo linked to the function.
      * @param {boolean} providerSilentMode - Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.
      * @param {string} providerRootDirectory - Path to function code in the linked repo.
-     * @param {string} specification - Runtime specification for the function and builds.
+     * @param {string} buildSpecification - Build specification for the function deployments.
+     * @param {string} runtimeSpecification - Runtime specification for the function 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.Function>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    create(functionId: string, name: string, runtime: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: Scopes[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, specification?: string): Promise<Models.Function>;
+    create(functionId: string, name: string, runtime: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: Scopes[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, buildSpecification?: string, runtimeSpecification?: string, deploymentRetention?: number): Promise<Models.Function>;
     /**
      * Get a list of all runtimes that are currently active on your instance.
      *
@@ -229,7 +235,9 @@ export declare class Functions {
      * @param {string} params.providerBranch - Production branch for the repo linked to the function
      * @param {boolean} params.providerSilentMode - Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.
      * @param {string} params.providerRootDirectory - Path to function code in the linked repo.
-     * @param {string} params.specification - Runtime specification for the function and builds.
+     * @param {string} params.buildSpecification - Build specification for the function deployments.
+     * @param {string} params.runtimeSpecification - Runtime specification for the function 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.Function>}
      */
@@ -251,7 +259,9 @@ export declare class Functions {
         providerBranch?: string;
         providerSilentMode?: boolean;
         providerRootDirectory?: string;
-        specification?: string;
+        buildSpecification?: string;
+        runtimeSpecification?: string;
+        deploymentRetention?: number;
     }): Promise<Models.Function>;
     /**
      * Update function by its unique ID.
@@ -273,12 +283,14 @@ export declare class Functions {
      * @param {string} providerBranch - Production branch for the repo linked to the function
      * @param {boolean} providerSilentMode - Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.
      * @param {string} providerRootDirectory - Path to function code in the linked repo.
-     * @param {string} specification - Runtime specification for the function and builds.
+     * @param {string} buildSpecification - Build specification for the function deployments.
+     * @param {string} runtimeSpecification - Runtime specification for the function 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.Function>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    update(functionId: string, name: string, runtime?: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: Scopes[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, specification?: string): Promise<Models.Function>;
+    update(functionId: string, name: string, runtime?: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, scopes?: Scopes[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, buildSpecification?: string, runtimeSpecification?: string, deploymentRetention?: number): Promise<Models.Function>;
     /**
      * Delete a function by its unique ID.
      *

package/types/services/organizations.d.ts

@@ -456,7 +456,7 @@ export declare class Organizations {
      * List all invoices for an organization.
      *
      * @param {string} params.organizationId - Organization ID
-     * @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>}
      */
@@ -468,7 +468,7 @@ export declare class Organizations {
      * List all invoices for an organization.
      *
      * @param {string} organizationId - Organization ID
-     * @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/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.
      *