node-appwrite 20.2.1 → 20.3.0

package/dist/services/databases.d.mts

@@ -23,6 +23,7 @@ declare class Databases {
      *
      * @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
      * @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.DatabaseList>}
      * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.list` instead.
@@ -30,17 +31,19 @@ declare class Databases {
     list(params?: {
         queries?: string[];
         search?: string;
+        total?: boolean;
     }): Promise<Models.DatabaseList>;
     /**
      * Get a list of all databases from the current Appwrite project. You can use the search parameter 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
      * @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.DatabaseList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    list(queries?: string[], search?: string): Promise<Models.DatabaseList>;
+    list(queries?: string[], search?: string, total?: boolean): Promise<Models.DatabaseList>;
     /**
      * Create a new Database.
      *
@@ -264,6 +267,7 @@ declare class Databases {
      * @param {string} params.databaseId - Database 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: name, enabled, documentSecurity
      * @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.CollectionList>}
      * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.listTables` instead.
@@ -272,6 +276,7 @@ declare class Databases {
         databaseId: string;
         queries?: string[];
         search?: string;
+        total?: boolean;
     }): Promise<Models.CollectionList>;
     /**
      * Get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results.
@@ -279,11 +284,12 @@ declare class Databases {
      * @param {string} databaseId - Database 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: name, enabled, documentSecurity
      * @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.CollectionList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listCollections(databaseId: string, queries?: string[], search?: string): Promise<Models.CollectionList>;
+    listCollections(databaseId: string, queries?: string[], search?: string, total?: boolean): Promise<Models.CollectionList>;
     /**
      * Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
      *
@@ -406,6 +412,7 @@ declare class Databases {
      * @param {string} params.databaseId - Database ID.
      * @param {string} params.collectionId - Collection 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: key, type, size, required, array, status, error
+     * @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.AttributeList>}
      * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.listColumns` instead.
@@ -414,6 +421,7 @@ declare class Databases {
         databaseId: string;
         collectionId: string;
         queries?: string[];
+        total?: boolean;
     }): Promise<Models.AttributeList>;
     /**
      * List attributes in the collection.
@@ -421,11 +429,12 @@ declare class Databases {
      * @param {string} databaseId - Database ID.
      * @param {string} collectionId - Collection 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: key, type, size, required, array, status, error
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.AttributeList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listAttributes(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.AttributeList>;
+    listAttributes(databaseId: string, collectionId: string, queries?: string[], total?: boolean): Promise<Models.AttributeList>;
     /**
      * Create a boolean attribute.
      *
@@ -1462,6 +1471,7 @@ declare class Databases {
      * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
      * @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.
      * @throws {AppwriteException}
      * @returns {Promise<Models.DocumentList<Document>>}
      * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.listRows` instead.
@@ -1471,6 +1481,7 @@ declare class Databases {
         collectionId: string;
         queries?: string[];
         transactionId?: string;
+        total?: boolean;
     }): Promise<Models.DocumentList<Document>>;
     /**
      * Get a list of all the user's documents in a given collection. You can use the query params to filter your results.
@@ -1479,11 +1490,12 @@ declare class Databases {
      * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
      * @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.
      * @throws {AppwriteException}
      * @returns {Promise<Models.DocumentList<Document>>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listDocuments<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, queries?: string[], transactionId?: string): Promise<Models.DocumentList<Document>>;
+    listDocuments<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, queries?: string[], transactionId?: string, total?: boolean): Promise<Models.DocumentList<Document>>;
     /**
      * Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
      *
@@ -1853,6 +1865,7 @@ declare class Databases {
      * @param {string} params.databaseId - Database ID.
      * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
      * @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: key, type, status, attributes, error
+     * @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.IndexList>}
      * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.listIndexes` instead.
@@ -1861,6 +1874,7 @@ declare class Databases {
         databaseId: string;
         collectionId: string;
         queries?: string[];
+        total?: boolean;
     }): Promise<Models.IndexList>;
     /**
      * List indexes in the collection.
@@ -1868,11 +1882,12 @@ declare class Databases {
      * @param {string} databaseId - Database ID.
      * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
      * @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: key, type, status, attributes, error
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.IndexList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listIndexes(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.IndexList>;
+    listIndexes(databaseId: string, collectionId: string, queries?: string[], total?: boolean): Promise<Models.IndexList>;
     /**
      * Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.
      * Attributes can be `key`, `fulltext`, and `unique`.

package/dist/services/databases.d.ts

@@ -23,6 +23,7 @@ declare class Databases {
      *
      * @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
      * @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.DatabaseList>}
      * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.list` instead.
@@ -30,17 +31,19 @@ declare class Databases {
     list(params?: {
         queries?: string[];
         search?: string;
+        total?: boolean;
     }): Promise<Models.DatabaseList>;
     /**
      * Get a list of all databases from the current Appwrite project. You can use the search parameter 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
      * @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.DatabaseList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    list(queries?: string[], search?: string): Promise<Models.DatabaseList>;
+    list(queries?: string[], search?: string, total?: boolean): Promise<Models.DatabaseList>;
     /**
      * Create a new Database.
      *
@@ -264,6 +267,7 @@ declare class Databases {
      * @param {string} params.databaseId - Database 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: name, enabled, documentSecurity
      * @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.CollectionList>}
      * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.listTables` instead.
@@ -272,6 +276,7 @@ declare class Databases {
         databaseId: string;
         queries?: string[];
         search?: string;
+        total?: boolean;
     }): Promise<Models.CollectionList>;
     /**
      * Get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results.
@@ -279,11 +284,12 @@ declare class Databases {
      * @param {string} databaseId - Database 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: name, enabled, documentSecurity
      * @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.CollectionList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listCollections(databaseId: string, queries?: string[], search?: string): Promise<Models.CollectionList>;
+    listCollections(databaseId: string, queries?: string[], search?: string, total?: boolean): Promise<Models.CollectionList>;
     /**
      * Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
      *
@@ -406,6 +412,7 @@ declare class Databases {
      * @param {string} params.databaseId - Database ID.
      * @param {string} params.collectionId - Collection 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: key, type, size, required, array, status, error
+     * @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.AttributeList>}
      * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.listColumns` instead.
@@ -414,6 +421,7 @@ declare class Databases {
         databaseId: string;
         collectionId: string;
         queries?: string[];
+        total?: boolean;
     }): Promise<Models.AttributeList>;
     /**
      * List attributes in the collection.
@@ -421,11 +429,12 @@ declare class Databases {
      * @param {string} databaseId - Database ID.
      * @param {string} collectionId - Collection 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: key, type, size, required, array, status, error
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.AttributeList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listAttributes(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.AttributeList>;
+    listAttributes(databaseId: string, collectionId: string, queries?: string[], total?: boolean): Promise<Models.AttributeList>;
     /**
      * Create a boolean attribute.
      *
@@ -1462,6 +1471,7 @@ declare class Databases {
      * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
      * @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.
      * @throws {AppwriteException}
      * @returns {Promise<Models.DocumentList<Document>>}
      * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.listRows` instead.
@@ -1471,6 +1481,7 @@ declare class Databases {
         collectionId: string;
         queries?: string[];
         transactionId?: string;
+        total?: boolean;
     }): Promise<Models.DocumentList<Document>>;
     /**
      * Get a list of all the user's documents in a given collection. You can use the query params to filter your results.
@@ -1479,11 +1490,12 @@ declare class Databases {
      * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
      * @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.
      * @throws {AppwriteException}
      * @returns {Promise<Models.DocumentList<Document>>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listDocuments<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, queries?: string[], transactionId?: string): Promise<Models.DocumentList<Document>>;
+    listDocuments<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, queries?: string[], transactionId?: string, total?: boolean): Promise<Models.DocumentList<Document>>;
     /**
      * Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
      *
@@ -1853,6 +1865,7 @@ declare class Databases {
      * @param {string} params.databaseId - Database ID.
      * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
      * @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: key, type, status, attributes, error
+     * @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.IndexList>}
      * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.listIndexes` instead.
@@ -1861,6 +1874,7 @@ declare class Databases {
         databaseId: string;
         collectionId: string;
         queries?: string[];
+        total?: boolean;
     }): Promise<Models.IndexList>;
     /**
      * List indexes in the collection.
@@ -1868,11 +1882,12 @@ declare class Databases {
      * @param {string} databaseId - Database ID.
      * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
      * @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: key, type, status, attributes, error
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.IndexList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listIndexes(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.IndexList>;
+    listIndexes(databaseId: string, collectionId: string, queries?: string[], total?: boolean): Promise<Models.IndexList>;
     /**
      * Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.
      * Attributes can be `key`, `fulltext`, and `unique`.

package/dist/services/databases.js

@@ -13,11 +13,13 @@ class Databases {
     } 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 = "/databases";
     const payload = {};
     if (typeof queries !== "undefined") {
@@ -26,6 +28,9 @@ class Databases {
     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(
@@ -341,12 +346,14 @@ class Databases {
       params = {
         databaseId: paramsOrFirst,
         queries: rest[0],
-        search: rest[1]
+        search: rest[1],
+        total: rest[2]
       };
     }
     const databaseId = params.databaseId;
     const queries = params.queries;
     const search = params.search;
+    const total = params.total;
     if (typeof databaseId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "databaseId"');
     }
@@ -358,6 +365,9 @@ class Databases {
     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(
@@ -546,12 +556,14 @@ class Databases {
       params = {
         databaseId: paramsOrFirst,
         collectionId: rest[0],
-        queries: rest[1]
+        queries: rest[1],
+        total: rest[2]
       };
     }
     const databaseId = params.databaseId;
     const collectionId = params.collectionId;
     const queries = params.queries;
+    const total = params.total;
     if (typeof databaseId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "databaseId"');
     }
@@ -563,6 +575,9 @@ class Databases {
     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(
@@ -2182,13 +2197,15 @@ class Databases {
         databaseId: paramsOrFirst,
         collectionId: rest[0],
         queries: rest[1],
-        transactionId: rest[2]
+        transactionId: rest[2],
+        total: rest[3]
       };
     }
     const databaseId = params.databaseId;
     const collectionId = params.collectionId;
     const queries = params.queries;
     const transactionId = params.transactionId;
+    const total = params.total;
     if (typeof databaseId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "databaseId"');
     }
@@ -2203,6 +2220,9 @@ class Databases {
     if (typeof transactionId !== "undefined") {
       payload["transactionId"] = transactionId;
     }
+    if (typeof total !== "undefined") {
+      payload["total"] = total;
+    }
     const uri = new URL(this.client.config.endpoint + apiPath);
     const apiHeaders = {};
     return this.client.call(
@@ -2754,12 +2774,14 @@ class Databases {
       params = {
         databaseId: paramsOrFirst,
         collectionId: rest[0],
-        queries: rest[1]
+        queries: rest[1],
+        total: rest[2]
       };
     }
     const databaseId = params.databaseId;
     const collectionId = params.collectionId;
     const queries = params.queries;
+    const total = params.total;
     if (typeof databaseId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "databaseId"');
     }
@@ -2771,6 +2793,9 @@ class Databases {
     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(