node-appwrite 16.0.0 → 17.0.0

package/dist/services/functions.js

@@ -52,15 +52,11 @@ 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, name, runtime, execute, events, schedule, timeout, enabled, logging, entrypoint, commands, scopes, installationId, providerRepositoryId, providerBranch, providerSilentMode, providerRootDirectory, templateRepository, templateOwner, templateRootDirectory, templateVersion, specification) {
+  create(functionId, name, runtime, execute, events, schedule, timeout, enabled, logging, entrypoint, commands, scopes, installationId, providerRepositoryId, providerBranch, providerSilentMode, providerRootDirectory, specification) {
     if (typeof functionId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "functionId"');
     }
@@ -123,18 +119,6 @@ class Functions {
     if (typeof providerRootDirectory !== "undefined") {
       payload["providerRootDirectory"] = providerRootDirectory;
     }
-    if (typeof templateRepository !== "undefined") {
-      payload["templateRepository"] = templateRepository;
-    }
-    if (typeof templateOwner !== "undefined") {
-      payload["templateOwner"] = templateOwner;
-    }
-    if (typeof templateRootDirectory !== "undefined") {
-      payload["templateRootDirectory"] = templateRootDirectory;
-    }
-    if (typeof templateVersion !== "undefined") {
-      payload["templateVersion"] = templateVersion;
-    }
     if (typeof specification !== "undefined") {
       payload["specification"] = specification;
     }
@@ -168,12 +152,11 @@ class Functions {
     );
   }
   /**
-       * List allowed function specifications for this instance.
-  
-       *
-       * @throws {AppwriteException}
-       * @returns {Promise<Models.SpecificationList>}
-       */
+   * List allowed function specifications for this instance.
+   *
+   * @throws {AppwriteException}
+   * @returns {Promise<Models.SpecificationList>}
+   */
   listSpecifications() {
     const apiPath = "/functions/specifications";
     const payload = {};
@@ -328,7 +311,38 @@ class Functions {
     );
   }
   /**
-   * 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, deploymentId) {
+    if (typeof functionId === "undefined") {
+      throw new client.AppwriteException('Missing required parameter: "functionId"');
+    }
+    if (typeof deploymentId === "undefined") {
+      throw new client.AppwriteException('Missing required parameter: "deploymentId"');
+    }
+    const apiPath = "/functions/{functionId}/deployment".replace("{functionId}", functionId);
+    const payload = {};
+    if (typeof deploymentId !== "undefined") {
+      payload["deploymentId"] = deploymentId;
+    }
+    const uri = new URL(this.client.config.endpoint + apiPath);
+    const apiHeaders = {
+      "content-type": "application/json"
+    };
+    return this.client.call(
+      "patch",
+      uri,
+      apiHeaders,
+      payload
+    );
+  }
+  /**
+   * 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
@@ -410,156 +424,206 @@ class Functions {
     );
   }
   /**
-   * 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, deploymentId) {
+  createDuplicateDeployment(functionId, deploymentId, buildId) {
     if (typeof functionId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "functionId"');
     }
     if (typeof deploymentId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "deploymentId"');
     }
-    const apiPath = "/functions/{functionId}/deployments/{deploymentId}".replace("{functionId}", functionId).replace("{deploymentId}", deploymentId);
+    const apiPath = "/functions/{functionId}/deployments/duplicate".replace("{functionId}", functionId);
     const payload = {};
+    if (typeof deploymentId !== "undefined") {
+      payload["deploymentId"] = deploymentId;
+    }
+    if (typeof buildId !== "undefined") {
+      payload["buildId"] = buildId;
+    }
     const uri = new URL(this.client.config.endpoint + apiPath);
-    const apiHeaders = {};
+    const apiHeaders = {
+      "content-type": "application/json"
+    };
     return this.client.call(
-      "get",
+      "post",
       uri,
       apiHeaders,
       payload
     );
   }
   /**
-   * 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.
-   *
-   * @param {string} functionId
-   * @param {string} deploymentId
-   * @throws {AppwriteException}
-   * @returns {Promise<Models.Function>}
-   */
-  updateDeployment(functionId, deploymentId) {
+       * 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} repository
+       * @param {string} owner
+       * @param {string} rootDirectory
+       * @param {string} version
+       * @param {boolean} activate
+       * @throws {AppwriteException}
+       * @returns {Promise<Models.Deployment>}
+       */
+  createTemplateDeployment(functionId, repository, owner, rootDirectory, version, activate) {
     if (typeof functionId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "functionId"');
     }
-    if (typeof deploymentId === "undefined") {
-      throw new client.AppwriteException('Missing required parameter: "deploymentId"');
+    if (typeof repository === "undefined") {
+      throw new client.AppwriteException('Missing required parameter: "repository"');
     }
-    const apiPath = "/functions/{functionId}/deployments/{deploymentId}".replace("{functionId}", functionId).replace("{deploymentId}", deploymentId);
+    if (typeof owner === "undefined") {
+      throw new client.AppwriteException('Missing required parameter: "owner"');
+    }
+    if (typeof rootDirectory === "undefined") {
+      throw new client.AppwriteException('Missing required parameter: "rootDirectory"');
+    }
+    if (typeof version === "undefined") {
+      throw new client.AppwriteException('Missing required parameter: "version"');
+    }
+    const apiPath = "/functions/{functionId}/deployments/template".replace("{functionId}", functionId);
     const payload = {};
+    if (typeof repository !== "undefined") {
+      payload["repository"] = repository;
+    }
+    if (typeof owner !== "undefined") {
+      payload["owner"] = owner;
+    }
+    if (typeof rootDirectory !== "undefined") {
+      payload["rootDirectory"] = rootDirectory;
+    }
+    if (typeof version !== "undefined") {
+      payload["version"] = version;
+    }
+    if (typeof activate !== "undefined") {
+      payload["activate"] = activate;
+    }
     const uri = new URL(this.client.config.endpoint + apiPath);
     const apiHeaders = {
       "content-type": "application/json"
     };
     return this.client.call(
-      "patch",
+      "post",
       uri,
       apiHeaders,
       payload
     );
   }
   /**
-   * Delete a code deployment by its unique ID.
-   *
-   * @param {string} functionId
-   * @param {string} deploymentId
-   * @throws {AppwriteException}
-   * @returns {Promise<{}>}
-   */
-  deleteDeployment(functionId, deploymentId) {
+       * 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, type, reference, activate) {
     if (typeof functionId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "functionId"');
     }
-    if (typeof deploymentId === "undefined") {
-      throw new client.AppwriteException('Missing required parameter: "deploymentId"');
+    if (typeof type === "undefined") {
+      throw new client.AppwriteException('Missing required parameter: "type"');
     }
-    const apiPath = "/functions/{functionId}/deployments/{deploymentId}".replace("{functionId}", functionId).replace("{deploymentId}", deploymentId);
+    if (typeof reference === "undefined") {
+      throw new client.AppwriteException('Missing required parameter: "reference"');
+    }
+    const apiPath = "/functions/{functionId}/deployments/vcs".replace("{functionId}", functionId);
     const payload = {};
+    if (typeof type !== "undefined") {
+      payload["type"] = type;
+    }
+    if (typeof reference !== "undefined") {
+      payload["reference"] = reference;
+    }
+    if (typeof activate !== "undefined") {
+      payload["activate"] = activate;
+    }
     const uri = new URL(this.client.config.endpoint + apiPath);
     const apiHeaders = {
       "content-type": "application/json"
     };
     return this.client.call(
-      "delete",
+      "post",
       uri,
       apiHeaders,
       payload
     );
   }
   /**
-   * 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.
+   * Get a function deployment by its unique ID.
    *
    * @param {string} functionId
    * @param {string} deploymentId
-   * @param {string} buildId
    * @throws {AppwriteException}
-   * @returns {Promise<{}>}
+   * @returns {Promise<Models.Deployment>}
    */
-  createBuild(functionId, deploymentId, buildId) {
+  getDeployment(functionId, deploymentId) {
     if (typeof functionId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "functionId"');
     }
     if (typeof deploymentId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "deploymentId"');
     }
-    const apiPath = "/functions/{functionId}/deployments/{deploymentId}/build".replace("{functionId}", functionId).replace("{deploymentId}", deploymentId);
+    const apiPath = "/functions/{functionId}/deployments/{deploymentId}".replace("{functionId}", functionId).replace("{deploymentId}", deploymentId);
     const payload = {};
-    if (typeof buildId !== "undefined") {
-      payload["buildId"] = buildId;
-    }
     const uri = new URL(this.client.config.endpoint + apiPath);
-    const apiHeaders = {
-      "content-type": "application/json"
-    };
+    const apiHeaders = {};
     return this.client.call(
-      "post",
+      "get",
       uri,
       apiHeaders,
       payload
     );
   }
   /**
-   * 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.
+   * Delete a code deployment by its unique ID.
    *
    * @param {string} functionId
    * @param {string} deploymentId
    * @throws {AppwriteException}
-   * @returns {Promise<Models.Build>}
+   * @returns {Promise<{}>}
    */
-  updateDeploymentBuild(functionId, deploymentId) {
+  deleteDeployment(functionId, deploymentId) {
     if (typeof functionId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "functionId"');
     }
     if (typeof deploymentId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "deploymentId"');
     }
-    const apiPath = "/functions/{functionId}/deployments/{deploymentId}/build".replace("{functionId}", functionId).replace("{deploymentId}", deploymentId);
+    const apiPath = "/functions/{functionId}/deployments/{deploymentId}".replace("{functionId}", functionId).replace("{deploymentId}", deploymentId);
     const payload = {};
     const uri = new URL(this.client.config.endpoint + apiPath);
     const apiHeaders = {
       "content-type": "application/json"
     };
     return this.client.call(
-      "patch",
+      "delete",
       uri,
       apiHeaders,
       payload
     );
   }
   /**
-   * Get a Deployment&#039;s contents by its unique ID. This endpoint supports range requests for partial or streaming file download.
+   * 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<ArrayBuffer>}
    */
-  getDeploymentDownload(functionId, deploymentId) {
+  getDeploymentDownload(functionId, deploymentId, type) {
     if (typeof functionId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "functionId"');
     }
@@ -568,6 +632,9 @@ class Functions {
     }
     const apiPath = "/functions/{functionId}/deployments/{deploymentId}/download".replace("{functionId}", functionId).replace("{deploymentId}", deploymentId);
     const payload = {};
+    if (typeof type !== "undefined") {
+      payload["type"] = type;
+    }
     const uri = new URL(this.client.config.endpoint + apiPath);
     const apiHeaders = {};
     return this.client.call(
@@ -578,16 +645,43 @@ class Functions {
       "arrayBuffer"
     );
   }
+  /**
+   * 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<Models.Deployment>}
+   */
+  updateDeploymentStatus(functionId, deploymentId) {
+    if (typeof functionId === "undefined") {
+      throw new client.AppwriteException('Missing required parameter: "functionId"');
+    }
+    if (typeof deploymentId === "undefined") {
+      throw new client.AppwriteException('Missing required parameter: "deploymentId"');
+    }
+    const apiPath = "/functions/{functionId}/deployments/{deploymentId}/status".replace("{functionId}", functionId).replace("{deploymentId}", deploymentId);
+    const payload = {};
+    const uri = new URL(this.client.config.endpoint + apiPath);
+    const apiHeaders = {
+      "content-type": "application/json"
+    };
+    return this.client.call(
+      "patch",
+      uri,
+      apiHeaders,
+      payload
+    );
+  }
   /**
    * 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, queries, search) {
+  listExecutions(functionId, queries) {
     if (typeof functionId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "functionId"');
     }
@@ -596,9 +690,6 @@ class Functions {
     if (typeof queries !== "undefined") {
       payload["queries"] = queries;
     }
-    if (typeof search !== "undefined") {
-      payload["search"] = search;
-    }
     const uri = new URL(this.client.config.endpoint + apiPath);
     const apiHeaders = {};
     return this.client.call(
@@ -683,14 +774,13 @@ class Functions {
     );
   }
   /**
-       * Delete a function execution by its unique ID.
-  
-       *
-       * @param {string} functionId
-       * @param {string} executionId
-       * @throws {AppwriteException}
-       * @returns {Promise<{}>}
-       */
+   * Delete a function execution by its unique ID.
+   *
+   * @param {string} functionId
+   * @param {string} executionId
+   * @throws {AppwriteException}
+   * @returns {Promise<{}>}
+   */
   deleteExecution(functionId, executionId) {
     if (typeof functionId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "functionId"');
@@ -739,10 +829,11 @@ class Functions {
    * @param {string} functionId
    * @param {string} key
    * @param {string} value
+   * @param {boolean} secret
    * @throws {AppwriteException}
    * @returns {Promise<Models.Variable>}
    */
-  createVariable(functionId, key, value) {
+  createVariable(functionId, key, value, secret) {
     if (typeof functionId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "functionId"');
     }
@@ -760,6 +851,9 @@ class Functions {
     if (typeof value !== "undefined") {
       payload["value"] = value;
     }
+    if (typeof secret !== "undefined") {
+      payload["secret"] = secret;
+    }
     const uri = new URL(this.client.config.endpoint + apiPath);
     const apiHeaders = {
       "content-type": "application/json"
@@ -804,10 +898,11 @@ class Functions {
    * @param {string} variableId
    * @param {string} key
    * @param {string} value
+   * @param {boolean} secret
    * @throws {AppwriteException}
    * @returns {Promise<Models.Variable>}
    */
-  updateVariable(functionId, variableId, key, value) {
+  updateVariable(functionId, variableId, key, value, secret) {
     if (typeof functionId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "functionId"');
     }
@@ -825,6 +920,9 @@ class Functions {
     if (typeof value !== "undefined") {
       payload["value"] = value;
     }
+    if (typeof secret !== "undefined") {
+      payload["secret"] = secret;
+    }
     const uri = new URL(this.client.config.endpoint + apiPath);
     const apiHeaders = {
       "content-type": "application/json"