node-appwrite 16.0.0 → 17.0.0

package/dist/services/functions.d.mts

@@ -1,6 +1,8 @@
 import { Client, UploadProgress } from '../client.mjs';
 import { Models } from '../models.mjs';
 import { Runtime } from '../enums/runtime.mjs';
+import { VCSDeploymentType } from '../enums/v-c-s-deployment-type.mjs';
+import { DeploymentDownloadType } from '../enums/deployment-download-type.mjs';
 import { ExecutionMethod } from '../enums/execution-method.mjs';
 import '../query.mjs';
 
@@ -36,15 +38,11 @@ declare class Functions {
      * @param {string} providerBranch
      * @param {boolean} providerSilentMode
      * @param {string} providerRootDirectory
-     * @param {string} templateRepository
-     * @param {string} templateOwner
-     * @param {string} templateRootDirectory
-     * @param {string} templateVersion
      * @param {string} specification
      * @throws {AppwriteException}
      * @returns {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?: string[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, templateRepository?: string, templateOwner?: string, templateRootDirectory?: string, templateVersion?: 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?: string[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, specification?: string): Promise<Models.Function>;
     /**
      * Get a list of all runtimes that are currently active on your instance.
      *
@@ -54,7 +52,6 @@ declare class Functions {
     listRuntimes(): Promise<Models.RuntimeList>;
     /**
      * List allowed function specifications for this instance.
-
      *
      * @throws {AppwriteException}
      * @returns {Promise<Models.SpecificationList>}
@@ -102,7 +99,16 @@ declare class Functions {
      */
     delete(functionId: string): Promise<{}>;
     /**
-     * Get a list of all the project&#039;s code deployments. You can use the query params to filter your results.
+     * Update the function active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your function.
+     *
+     * @param {string} functionId
+     * @param {string} deploymentId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Function>}
+     */
+    updateFunctionDeployment(functionId: string, deploymentId: string): Promise<Models.Function>;
+    /**
+     * Get a list of all the function&#039;s code deployments. You can use the query params to filter your results.
      *
      * @param {string} functionId
      * @param {string[]} queries
@@ -128,70 +134,89 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     createDeployment(functionId: string, code: File, activate: boolean, entrypoint?: string, commands?: string, onProgress?: (progress: UploadProgress) => void): Promise<Models.Deployment>;
     /**
-     * Get a code deployment by its unique ID.
+     * Create a new build for an existing function deployment. This endpoint allows you to rebuild a deployment with the updated function configuration, including its entrypoint and build commands if they have been modified. The build process will be queued and executed asynchronously. The original deployment&#039;s code will be preserved and used for the new build.
      *
      * @param {string} functionId
      * @param {string} deploymentId
+     * @param {string} buildId
      * @throws {AppwriteException}
      * @returns {Promise<Models.Deployment>}
      */
-    getDeployment(functionId: string, deploymentId: string): Promise<Models.Deployment>;
+    createDuplicateDeployment(functionId: string, deploymentId: string, buildId?: string): Promise<Models.Deployment>;
     /**
-     * Update the function code deployment ID using the unique function ID. Use this endpoint to switch the code deployment that should be executed by the execution endpoint.
+     * Create a deployment based on a template.
+
+Use this endpoint with combination of [listTemplates](https://appwrite.io/docs/server/functions#listTemplates) to find the template details.
      *
      * @param {string} functionId
-     * @param {string} deploymentId
+     * @param {string} repository
+     * @param {string} owner
+     * @param {string} rootDirectory
+     * @param {string} version
+     * @param {boolean} activate
      * @throws {AppwriteException}
-     * @returns {Promise<Models.Function>}
+     * @returns {Promise<Models.Deployment>}
      */
-    updateDeployment(functionId: string, deploymentId: string): Promise<Models.Function>;
+    createTemplateDeployment(functionId: string, repository: string, owner: string, rootDirectory: string, version: string, activate?: boolean): Promise<Models.Deployment>;
     /**
-     * Delete a code deployment by its unique ID.
+     * Create a deployment when a function is connected to VCS.
+
+This endpoint lets you create deployment from a branch, commit, or a tag.
+     *
+     * @param {string} functionId
+     * @param {VCSDeploymentType} type
+     * @param {string} reference
+     * @param {boolean} activate
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Deployment>}
+     */
+    createVcsDeployment(functionId: string, type: VCSDeploymentType, reference: string, activate?: boolean): Promise<Models.Deployment>;
+    /**
+     * Get a function deployment by its unique ID.
      *
      * @param {string} functionId
      * @param {string} deploymentId
      * @throws {AppwriteException}
-     * @returns {Promise<{}>}
+     * @returns {Promise<Models.Deployment>}
      */
-    deleteDeployment(functionId: string, deploymentId: string): Promise<{}>;
+    getDeployment(functionId: string, deploymentId: string): Promise<Models.Deployment>;
     /**
-     * Create a new build for an existing function deployment. This endpoint allows you to rebuild a deployment with the updated function configuration, including its entrypoint and build commands if they have been modified The build process will be queued and executed asynchronously. The original deployment&#039;s code will be preserved and used for the new build.
+     * Delete a code deployment by its unique ID.
      *
      * @param {string} functionId
      * @param {string} deploymentId
-     * @param {string} buildId
      * @throws {AppwriteException}
      * @returns {Promise<{}>}
      */
-    createBuild(functionId: string, deploymentId: string, buildId?: string): Promise<{}>;
+    deleteDeployment(functionId: string, deploymentId: string): Promise<{}>;
     /**
-     * Cancel an ongoing function deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn&#039;t started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status &#039;ready&#039;) or failed. The response includes the final build status and details.
+     * Get a function deployment content by its unique ID. The endpoint response return with a &#039;Content-Disposition: attachment&#039; header that tells the browser to start downloading the file to user downloads directory.
      *
      * @param {string} functionId
      * @param {string} deploymentId
+     * @param {DeploymentDownloadType} type
      * @throws {AppwriteException}
-     * @returns {Promise<Models.Build>}
+     * @returns {Promise<ArrayBuffer>}
      */
-    updateDeploymentBuild(functionId: string, deploymentId: string): Promise<Models.Build>;
+    getDeploymentDownload(functionId: string, deploymentId: string, type?: DeploymentDownloadType): Promise<ArrayBuffer>;
     /**
-     * Get a Deployment&#039;s contents by its unique ID. This endpoint supports range requests for partial or streaming file download.
+     * Cancel an ongoing function deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn&#039;t started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status &#039;ready&#039;) or failed. The response includes the final build status and details.
      *
      * @param {string} functionId
      * @param {string} deploymentId
      * @throws {AppwriteException}
-     * @returns {Promise<ArrayBuffer>}
+     * @returns {Promise<Models.Deployment>}
      */
-    getDeploymentDownload(functionId: string, deploymentId: string): Promise<ArrayBuffer>;
+    updateDeploymentStatus(functionId: string, deploymentId: string): Promise<Models.Deployment>;
     /**
      * Get a list of all the current user function execution logs. You can use the query params to filter your results.
      *
      * @param {string} functionId
      * @param {string[]} queries
-     * @param {string} search
      * @throws {AppwriteException}
      * @returns {Promise<Models.ExecutionList>}
      */
-    listExecutions(functionId: string, queries?: string[], search?: string): Promise<Models.ExecutionList>;
+    listExecutions(functionId: string, queries?: string[]): Promise<Models.ExecutionList>;
     /**
      * Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.
      *
@@ -217,7 +242,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
     getExecution(functionId: string, executionId: string): Promise<Models.Execution>;
     /**
      * Delete a function execution by its unique ID.
-
      *
      * @param {string} functionId
      * @param {string} executionId
@@ -239,10 +263,11 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      * @param {string} functionId
      * @param {string} key
      * @param {string} value
+     * @param {boolean} secret
      * @throws {AppwriteException}
      * @returns {Promise<Models.Variable>}
      */
-    createVariable(functionId: string, key: string, value: string): Promise<Models.Variable>;
+    createVariable(functionId: string, key: string, value: string, secret?: boolean): Promise<Models.Variable>;
     /**
      * Get a variable by its unique ID.
      *
@@ -259,10 +284,11 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      * @param {string} variableId
      * @param {string} key
      * @param {string} value
+     * @param {boolean} secret
      * @throws {AppwriteException}
      * @returns {Promise<Models.Variable>}
      */
-    updateVariable(functionId: string, variableId: string, key: string, value?: string): Promise<Models.Variable>;
+    updateVariable(functionId: string, variableId: string, key: string, value?: string, secret?: boolean): Promise<Models.Variable>;
     /**
      * Delete a variable by its unique ID.
      *

package/dist/services/functions.d.ts

@@ -1,6 +1,8 @@
 import { Client, UploadProgress } from '../client.js';
 import { Models } from '../models.js';
 import { Runtime } from '../enums/runtime.js';
+import { VCSDeploymentType } from '../enums/v-c-s-deployment-type.js';
+import { DeploymentDownloadType } from '../enums/deployment-download-type.js';
 import { ExecutionMethod } from '../enums/execution-method.js';
 import '../query.js';
 
@@ -36,15 +38,11 @@ declare class Functions {
      * @param {string} providerBranch
      * @param {boolean} providerSilentMode
      * @param {string} providerRootDirectory
-     * @param {string} templateRepository
-     * @param {string} templateOwner
-     * @param {string} templateRootDirectory
-     * @param {string} templateVersion
      * @param {string} specification
      * @throws {AppwriteException}
      * @returns {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?: string[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, templateRepository?: string, templateOwner?: string, templateRootDirectory?: string, templateVersion?: 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?: string[], installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, specification?: string): Promise<Models.Function>;
     /**
      * Get a list of all runtimes that are currently active on your instance.
      *
@@ -54,7 +52,6 @@ declare class Functions {
     listRuntimes(): Promise<Models.RuntimeList>;
     /**
      * List allowed function specifications for this instance.
-
      *
      * @throws {AppwriteException}
      * @returns {Promise<Models.SpecificationList>}
@@ -102,7 +99,16 @@ declare class Functions {
      */
     delete(functionId: string): Promise<{}>;
     /**
-     * Get a list of all the project&#039;s code deployments. You can use the query params to filter your results.
+     * Update the function active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your function.
+     *
+     * @param {string} functionId
+     * @param {string} deploymentId
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Function>}
+     */
+    updateFunctionDeployment(functionId: string, deploymentId: string): Promise<Models.Function>;
+    /**
+     * Get a list of all the function&#039;s code deployments. You can use the query params to filter your results.
      *
      * @param {string} functionId
      * @param {string[]} queries
@@ -128,70 +134,89 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      */
     createDeployment(functionId: string, code: File, activate: boolean, entrypoint?: string, commands?: string, onProgress?: (progress: UploadProgress) => void): Promise<Models.Deployment>;
     /**
-     * Get a code deployment by its unique ID.
+     * Create a new build for an existing function deployment. This endpoint allows you to rebuild a deployment with the updated function configuration, including its entrypoint and build commands if they have been modified. The build process will be queued and executed asynchronously. The original deployment&#039;s code will be preserved and used for the new build.
      *
      * @param {string} functionId
      * @param {string} deploymentId
+     * @param {string} buildId
      * @throws {AppwriteException}
      * @returns {Promise<Models.Deployment>}
      */
-    getDeployment(functionId: string, deploymentId: string): Promise<Models.Deployment>;
+    createDuplicateDeployment(functionId: string, deploymentId: string, buildId?: string): Promise<Models.Deployment>;
     /**
-     * Update the function code deployment ID using the unique function ID. Use this endpoint to switch the code deployment that should be executed by the execution endpoint.
+     * Create a deployment based on a template.
+
+Use this endpoint with combination of [listTemplates](https://appwrite.io/docs/server/functions#listTemplates) to find the template details.
      *
      * @param {string} functionId
-     * @param {string} deploymentId
+     * @param {string} repository
+     * @param {string} owner
+     * @param {string} rootDirectory
+     * @param {string} version
+     * @param {boolean} activate
      * @throws {AppwriteException}
-     * @returns {Promise<Models.Function>}
+     * @returns {Promise<Models.Deployment>}
      */
-    updateDeployment(functionId: string, deploymentId: string): Promise<Models.Function>;
+    createTemplateDeployment(functionId: string, repository: string, owner: string, rootDirectory: string, version: string, activate?: boolean): Promise<Models.Deployment>;
     /**
-     * Delete a code deployment by its unique ID.
+     * Create a deployment when a function is connected to VCS.
+
+This endpoint lets you create deployment from a branch, commit, or a tag.
+     *
+     * @param {string} functionId
+     * @param {VCSDeploymentType} type
+     * @param {string} reference
+     * @param {boolean} activate
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Deployment>}
+     */
+    createVcsDeployment(functionId: string, type: VCSDeploymentType, reference: string, activate?: boolean): Promise<Models.Deployment>;
+    /**
+     * Get a function deployment by its unique ID.
      *
      * @param {string} functionId
      * @param {string} deploymentId
      * @throws {AppwriteException}
-     * @returns {Promise<{}>}
+     * @returns {Promise<Models.Deployment>}
      */
-    deleteDeployment(functionId: string, deploymentId: string): Promise<{}>;
+    getDeployment(functionId: string, deploymentId: string): Promise<Models.Deployment>;
     /**
-     * Create a new build for an existing function deployment. This endpoint allows you to rebuild a deployment with the updated function configuration, including its entrypoint and build commands if they have been modified The build process will be queued and executed asynchronously. The original deployment&#039;s code will be preserved and used for the new build.
+     * Delete a code deployment by its unique ID.
      *
      * @param {string} functionId
      * @param {string} deploymentId
-     * @param {string} buildId
      * @throws {AppwriteException}
      * @returns {Promise<{}>}
      */
-    createBuild(functionId: string, deploymentId: string, buildId?: string): Promise<{}>;
+    deleteDeployment(functionId: string, deploymentId: string): Promise<{}>;
     /**
-     * Cancel an ongoing function deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn&#039;t started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status &#039;ready&#039;) or failed. The response includes the final build status and details.
+     * Get a function deployment content by its unique ID. The endpoint response return with a &#039;Content-Disposition: attachment&#039; header that tells the browser to start downloading the file to user downloads directory.
      *
      * @param {string} functionId
      * @param {string} deploymentId
+     * @param {DeploymentDownloadType} type
      * @throws {AppwriteException}
-     * @returns {Promise<Models.Build>}
+     * @returns {Promise<ArrayBuffer>}
      */
-    updateDeploymentBuild(functionId: string, deploymentId: string): Promise<Models.Build>;
+    getDeploymentDownload(functionId: string, deploymentId: string, type?: DeploymentDownloadType): Promise<ArrayBuffer>;
     /**
-     * Get a Deployment&#039;s contents by its unique ID. This endpoint supports range requests for partial or streaming file download.
+     * Cancel an ongoing function deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn&#039;t started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status &#039;ready&#039;) or failed. The response includes the final build status and details.
      *
      * @param {string} functionId
      * @param {string} deploymentId
      * @throws {AppwriteException}
-     * @returns {Promise<ArrayBuffer>}
+     * @returns {Promise<Models.Deployment>}
      */
-    getDeploymentDownload(functionId: string, deploymentId: string): Promise<ArrayBuffer>;
+    updateDeploymentStatus(functionId: string, deploymentId: string): Promise<Models.Deployment>;
     /**
      * Get a list of all the current user function execution logs. You can use the query params to filter your results.
      *
      * @param {string} functionId
      * @param {string[]} queries
-     * @param {string} search
      * @throws {AppwriteException}
      * @returns {Promise<Models.ExecutionList>}
      */
-    listExecutions(functionId: string, queries?: string[], search?: string): Promise<Models.ExecutionList>;
+    listExecutions(functionId: string, queries?: string[]): Promise<Models.ExecutionList>;
     /**
      * Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.
      *
@@ -217,7 +242,6 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
     getExecution(functionId: string, executionId: string): Promise<Models.Execution>;
     /**
      * Delete a function execution by its unique ID.
-
      *
      * @param {string} functionId
      * @param {string} executionId
@@ -239,10 +263,11 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      * @param {string} functionId
      * @param {string} key
      * @param {string} value
+     * @param {boolean} secret
      * @throws {AppwriteException}
      * @returns {Promise<Models.Variable>}
      */
-    createVariable(functionId: string, key: string, value: string): Promise<Models.Variable>;
+    createVariable(functionId: string, key: string, value: string, secret?: boolean): Promise<Models.Variable>;
     /**
      * Get a variable by its unique ID.
      *
@@ -259,10 +284,11 @@ Use the &quot;command&quot; param to set the entrypoint used to execute your cod
      * @param {string} variableId
      * @param {string} key
      * @param {string} value
+     * @param {boolean} secret
      * @throws {AppwriteException}
      * @returns {Promise<Models.Variable>}
      */
-    updateVariable(functionId: string, variableId: string, key: string, value?: string): Promise<Models.Variable>;
+    updateVariable(functionId: string, variableId: string, key: string, value?: string, secret?: boolean): Promise<Models.Variable>;
     /**
      * Delete a variable by its unique ID.
      *