node-appwrite 20.2.1 → 21.0.0

package/dist/services/functions.d.mts

@@ -1,7 +1,8 @@
 import { Client, UploadProgress } from '../client.mjs';
 import { Models } from '../models.mjs';
 import { Runtime } from '../enums/runtime.mjs';
-import { VCSDeploymentType } from '../enums/vcs-deployment-type.mjs';
+import { TemplateReferenceType } from '../enums/template-reference-type.mjs';
+import { VCSReferenceType } from '../enums/vcs-reference-type.mjs';
 import { DeploymentDownloadType } from '../enums/deployment-download-type.mjs';
 import { ExecutionMethod } from '../enums/execution-method.mjs';
 import '../query.mjs';
@@ -24,23 +25,26 @@ declare class Functions {
      *
      * @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. You may filter on the following attributes: name, enabled, runtime, deploymentId, schedule, scheduleNext, schedulePrevious, timeout, entrypoint, commands, installationId
      * @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.FunctionList>}
      */
     list(params?: {
         queries?: string[];
         search?: string;
+        total?: boolean;
     }): Promise<Models.FunctionList>;
     /**
      * Get a list of all the project's functions. You can use the query params to filter your results.
      *
      * @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. You may filter on the following attributes: name, enabled, runtime, deploymentId, schedule, scheduleNext, schedulePrevious, timeout, entrypoint, commands, installationId
      * @param {string} search - Search term to filter your list results. Max length: 256 chars.
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.FunctionList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    list(queries?: string[], search?: string): Promise<Models.FunctionList>;
+    list(queries?: string[], search?: string, total?: boolean): Promise<Models.FunctionList>;
     /**
      * 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.
      *
@@ -261,6 +265,7 @@ declare class Functions {
      * @param {string} params.functionId - Function 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/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: buildSize, sourceSize, totalSize, buildDuration, status, activate, type
      * @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.DeploymentList>}
      */
@@ -268,6 +273,7 @@ declare class Functions {
         functionId: string;
         queries?: string[];
         search?: string;
+        total?: boolean;
     }): Promise<Models.DeploymentList>;
     /**
      * Get a list of all the function's code deployments. You can use the query params to filter your results.
@@ -275,11 +281,12 @@ declare class Functions {
      * @param {string} functionId - Function 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/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: buildSize, sourceSize, totalSize, buildDuration, status, activate, type
      * @param {string} search - Search term to filter your list results. Max length: 256 chars.
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.DeploymentList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listDeployments(functionId: string, queries?: string[], search?: string): Promise<Models.DeploymentList>;
+    listDeployments(functionId: string, queries?: string[], search?: string, total?: boolean): Promise<Models.DeploymentList>;
     /**
      * Create a new function code deployment. Use this endpoint to upload a new version of your code function. To execute your newly uploaded code, you'll need to update the function's deployment to use your new deployment UID.
      *
@@ -354,7 +361,8 @@ declare class Functions {
      * @param {string} params.repository - Repository name of the template.
      * @param {string} params.owner - The name of the owner of the template.
      * @param {string} params.rootDirectory - Path to function code in the template repo.
-     * @param {string} params.version - Version (tag) for the repo linked to the function template.
+     * @param {TemplateReferenceType} params.type - Type for the reference provided. Can be commit, branch, or tag
+     * @param {string} params.reference - Reference value, can be a commit hash, branch name, or release tag
      * @param {boolean} params.activate - Automatically activate the deployment when it is finished building.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Deployment>}
@@ -364,7 +372,8 @@ declare class Functions {
         repository: string;
         owner: string;
         rootDirectory: string;
-        version: string;
+        type: TemplateReferenceType;
+        reference: string;
         activate?: boolean;
     }): Promise<Models.Deployment>;
     /**
@@ -376,20 +385,21 @@ declare class Functions {
      * @param {string} repository - Repository name of the template.
      * @param {string} owner - The name of the owner of the template.
      * @param {string} rootDirectory - Path to function code in the template repo.
-     * @param {string} version - Version (tag) for the repo linked to the function template.
+     * @param {TemplateReferenceType} type - Type for the reference provided. Can be commit, branch, or tag
+     * @param {string} reference - Reference value, can be a commit hash, branch name, or release tag
      * @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.
      */
-    createTemplateDeployment(functionId: string, repository: string, owner: string, rootDirectory: string, version: string, activate?: boolean): Promise<Models.Deployment>;
+    createTemplateDeployment(functionId: string, repository: string, owner: string, rootDirectory: string, type: TemplateReferenceType, reference: string, activate?: boolean): Promise<Models.Deployment>;
     /**
      * 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} params.functionId - Function ID.
-     * @param {VCSDeploymentType} params.type - Type of reference passed. Allowed values are: branch, commit
+     * @param {VCSReferenceType} params.type - Type of reference passed. Allowed values are: branch, commit
      * @param {string} params.reference - VCS reference to create deployment from. Depending on type this can be: branch name, commit hash
      * @param {boolean} params.activate - Automatically activate the deployment when it is finished building.
      * @throws {AppwriteException}
@@ -397,7 +407,7 @@ declare class Functions {
      */
     createVcsDeployment(params: {
         functionId: string;
-        type: VCSDeploymentType;
+        type: VCSReferenceType;
         reference: string;
         activate?: boolean;
     }): Promise<Models.Deployment>;
@@ -407,14 +417,14 @@ declare class Functions {
      * This endpoint lets you create deployment from a branch, commit, or a tag.
      *
      * @param {string} functionId - Function ID.
-     * @param {VCSDeploymentType} type - Type of reference passed. Allowed values are: branch, commit
+     * @param {VCSReferenceType} type - Type of reference passed. Allowed values are: branch, commit
      * @param {string} reference - VCS reference to create deployment from. Depending on type this can be: branch name, commit hash
      * @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.
      */
-    createVcsDeployment(functionId: string, type: VCSDeploymentType, reference: string, activate?: boolean): Promise<Models.Deployment>;
+    createVcsDeployment(functionId: string, type: VCSReferenceType, reference: string, activate?: boolean): Promise<Models.Deployment>;
     /**
      * Get a function deployment by its unique ID.
      *
@@ -511,23 +521,26 @@ declare class Functions {
      *
      * @param {string} params.functionId - Function 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/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.ExecutionList>}
      */
     listExecutions(params: {
         functionId: string;
         queries?: string[];
+        total?: boolean;
     }): Promise<Models.ExecutionList>;
     /**
      * Get a list of all the current user function execution logs. You can use the query params to filter your results.
      *
      * @param {string} functionId - Function 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/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.ExecutionList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listExecutions(functionId: string, queries?: string[]): Promise<Models.ExecutionList>;
+    listExecutions(functionId: string, queries?: string[], total?: boolean): 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.
      *

package/dist/services/functions.d.ts

@@ -1,7 +1,8 @@
 import { Client, UploadProgress } from '../client.js';
 import { Models } from '../models.js';
 import { Runtime } from '../enums/runtime.js';
-import { VCSDeploymentType } from '../enums/vcs-deployment-type.js';
+import { TemplateReferenceType } from '../enums/template-reference-type.js';
+import { VCSReferenceType } from '../enums/vcs-reference-type.js';
 import { DeploymentDownloadType } from '../enums/deployment-download-type.js';
 import { ExecutionMethod } from '../enums/execution-method.js';
 import '../query.js';
@@ -24,23 +25,26 @@ declare class Functions {
      *
      * @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. You may filter on the following attributes: name, enabled, runtime, deploymentId, schedule, scheduleNext, schedulePrevious, timeout, entrypoint, commands, installationId
      * @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.FunctionList>}
      */
     list(params?: {
         queries?: string[];
         search?: string;
+        total?: boolean;
     }): Promise<Models.FunctionList>;
     /**
      * Get a list of all the project's functions. You can use the query params to filter your results.
      *
      * @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. You may filter on the following attributes: name, enabled, runtime, deploymentId, schedule, scheduleNext, schedulePrevious, timeout, entrypoint, commands, installationId
      * @param {string} search - Search term to filter your list results. Max length: 256 chars.
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.FunctionList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    list(queries?: string[], search?: string): Promise<Models.FunctionList>;
+    list(queries?: string[], search?: string, total?: boolean): Promise<Models.FunctionList>;
     /**
      * 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.
      *
@@ -261,6 +265,7 @@ declare class Functions {
      * @param {string} params.functionId - Function 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/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: buildSize, sourceSize, totalSize, buildDuration, status, activate, type
      * @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.DeploymentList>}
      */
@@ -268,6 +273,7 @@ declare class Functions {
         functionId: string;
         queries?: string[];
         search?: string;
+        total?: boolean;
     }): Promise<Models.DeploymentList>;
     /**
      * Get a list of all the function's code deployments. You can use the query params to filter your results.
@@ -275,11 +281,12 @@ declare class Functions {
      * @param {string} functionId - Function 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/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: buildSize, sourceSize, totalSize, buildDuration, status, activate, type
      * @param {string} search - Search term to filter your list results. Max length: 256 chars.
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.DeploymentList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listDeployments(functionId: string, queries?: string[], search?: string): Promise<Models.DeploymentList>;
+    listDeployments(functionId: string, queries?: string[], search?: string, total?: boolean): Promise<Models.DeploymentList>;
     /**
      * Create a new function code deployment. Use this endpoint to upload a new version of your code function. To execute your newly uploaded code, you'll need to update the function's deployment to use your new deployment UID.
      *
@@ -354,7 +361,8 @@ declare class Functions {
      * @param {string} params.repository - Repository name of the template.
      * @param {string} params.owner - The name of the owner of the template.
      * @param {string} params.rootDirectory - Path to function code in the template repo.
-     * @param {string} params.version - Version (tag) for the repo linked to the function template.
+     * @param {TemplateReferenceType} params.type - Type for the reference provided. Can be commit, branch, or tag
+     * @param {string} params.reference - Reference value, can be a commit hash, branch name, or release tag
      * @param {boolean} params.activate - Automatically activate the deployment when it is finished building.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Deployment>}
@@ -364,7 +372,8 @@ declare class Functions {
         repository: string;
         owner: string;
         rootDirectory: string;
-        version: string;
+        type: TemplateReferenceType;
+        reference: string;
         activate?: boolean;
     }): Promise<Models.Deployment>;
     /**
@@ -376,20 +385,21 @@ declare class Functions {
      * @param {string} repository - Repository name of the template.
      * @param {string} owner - The name of the owner of the template.
      * @param {string} rootDirectory - Path to function code in the template repo.
-     * @param {string} version - Version (tag) for the repo linked to the function template.
+     * @param {TemplateReferenceType} type - Type for the reference provided. Can be commit, branch, or tag
+     * @param {string} reference - Reference value, can be a commit hash, branch name, or release tag
      * @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.
      */
-    createTemplateDeployment(functionId: string, repository: string, owner: string, rootDirectory: string, version: string, activate?: boolean): Promise<Models.Deployment>;
+    createTemplateDeployment(functionId: string, repository: string, owner: string, rootDirectory: string, type: TemplateReferenceType, reference: string, activate?: boolean): Promise<Models.Deployment>;
     /**
      * 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} params.functionId - Function ID.
-     * @param {VCSDeploymentType} params.type - Type of reference passed. Allowed values are: branch, commit
+     * @param {VCSReferenceType} params.type - Type of reference passed. Allowed values are: branch, commit
      * @param {string} params.reference - VCS reference to create deployment from. Depending on type this can be: branch name, commit hash
      * @param {boolean} params.activate - Automatically activate the deployment when it is finished building.
      * @throws {AppwriteException}
@@ -397,7 +407,7 @@ declare class Functions {
      */
     createVcsDeployment(params: {
         functionId: string;
-        type: VCSDeploymentType;
+        type: VCSReferenceType;
         reference: string;
         activate?: boolean;
     }): Promise<Models.Deployment>;
@@ -407,14 +417,14 @@ declare class Functions {
      * This endpoint lets you create deployment from a branch, commit, or a tag.
      *
      * @param {string} functionId - Function ID.
-     * @param {VCSDeploymentType} type - Type of reference passed. Allowed values are: branch, commit
+     * @param {VCSReferenceType} type - Type of reference passed. Allowed values are: branch, commit
      * @param {string} reference - VCS reference to create deployment from. Depending on type this can be: branch name, commit hash
      * @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.
      */
-    createVcsDeployment(functionId: string, type: VCSDeploymentType, reference: string, activate?: boolean): Promise<Models.Deployment>;
+    createVcsDeployment(functionId: string, type: VCSReferenceType, reference: string, activate?: boolean): Promise<Models.Deployment>;
     /**
      * Get a function deployment by its unique ID.
      *
@@ -511,23 +521,26 @@ declare class Functions {
      *
      * @param {string} params.functionId - Function 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/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.ExecutionList>}
      */
     listExecutions(params: {
         functionId: string;
         queries?: string[];
+        total?: boolean;
     }): Promise<Models.ExecutionList>;
     /**
      * Get a list of all the current user function execution logs. You can use the query params to filter your results.
      *
      * @param {string} functionId - Function 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/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.ExecutionList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listExecutions(functionId: string, queries?: string[]): Promise<Models.ExecutionList>;
+    listExecutions(functionId: string, queries?: string[], total?: boolean): 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.
      *

package/dist/services/functions.js

@@ -13,11 +13,13 @@ class Functions {
     } else {
       params = {
         queries: paramsOrFirst,
-        search: rest[0]
+        search: rest[0],
+        total: rest[1]
       };
     }
     const queries = params.queries;
     const search = params.search;
+    const total = params.total;
     const apiPath = "/functions";
     const payload = {};
     if (typeof queries !== "undefined") {
@@ -26,6 +28,9 @@ class Functions {
     if (typeof search !== "undefined") {
       payload["search"] = search;
     }
+    if (typeof total !== "undefined") {
+      payload["total"] = total;
+    }
     const uri = new URL(this.client.config.endpoint + apiPath);
     const apiHeaders = {};
     return this.client.call(
@@ -397,12 +402,14 @@ class Functions {
       params = {
         functionId: paramsOrFirst,
         queries: rest[0],
-        search: rest[1]
+        search: rest[1],
+        total: rest[2]
       };
     }
     const functionId = params.functionId;
     const queries = params.queries;
     const search = params.search;
+    const total = params.total;
     if (typeof functionId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "functionId"');
     }
@@ -414,6 +421,9 @@ class Functions {
     if (typeof search !== "undefined") {
       payload["search"] = search;
     }
+    if (typeof total !== "undefined") {
+      payload["total"] = total;
+    }
     const uri = new URL(this.client.config.endpoint + apiPath);
     const apiHeaders = {};
     return this.client.call(
@@ -528,15 +538,17 @@ class Functions {
         repository: rest[0],
         owner: rest[1],
         rootDirectory: rest[2],
-        version: rest[3],
-        activate: rest[4]
+        type: rest[3],
+        reference: rest[4],
+        activate: rest[5]
       };
     }
     const functionId = params.functionId;
     const repository = params.repository;
     const owner = params.owner;
     const rootDirectory = params.rootDirectory;
-    const version = params.version;
+    const type = params.type;
+    const reference = params.reference;
     const activate = params.activate;
     if (typeof functionId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "functionId"');
@@ -550,8 +562,11 @@ class Functions {
     if (typeof rootDirectory === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "rootDirectory"');
     }
-    if (typeof version === "undefined") {
-      throw new client.AppwriteException('Missing required parameter: "version"');
+    if (typeof type === "undefined") {
+      throw new client.AppwriteException('Missing required parameter: "type"');
+    }
+    if (typeof reference === "undefined") {
+      throw new client.AppwriteException('Missing required parameter: "reference"');
     }
     const apiPath = "/functions/{functionId}/deployments/template".replace("{functionId}", functionId);
     const payload = {};
@@ -564,8 +579,11 @@ class Functions {
     if (typeof rootDirectory !== "undefined") {
       payload["rootDirectory"] = rootDirectory;
     }
-    if (typeof version !== "undefined") {
-      payload["version"] = version;
+    if (typeof type !== "undefined") {
+      payload["type"] = type;
+    }
+    if (typeof reference !== "undefined") {
+      payload["reference"] = reference;
     }
     if (typeof activate !== "undefined") {
       payload["activate"] = activate;
@@ -761,11 +779,13 @@ class Functions {
     } else {
       params = {
         functionId: paramsOrFirst,
-        queries: rest[0]
+        queries: rest[0],
+        total: rest[1]
       };
     }
     const functionId = params.functionId;
     const queries = params.queries;
+    const total = params.total;
     if (typeof functionId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "functionId"');
     }
@@ -774,6 +794,9 @@ class Functions {
     if (typeof queries !== "undefined") {
       payload["queries"] = queries;
     }
+    if (typeof total !== "undefined") {
+      payload["total"] = total;
+    }
     const uri = new URL(this.client.config.endpoint + apiPath);
     const apiHeaders = {};
     return this.client.call(