node-appwrite 20.2.1 → 21.0.0

package/dist/services/tables-db.d.ts

@@ -23,23 +23,26 @@ declare class TablesDB {
      *
      * @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 columns: 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>}
      */
     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 columns: 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.
      *
@@ -259,6 +262,7 @@ declare class TablesDB {
      * @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 columns: name, enabled, rowSecurity
      * @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.TableList>}
      */
@@ -266,6 +270,7 @@ declare class TablesDB {
         databaseId: string;
         queries?: string[];
         search?: string;
+        total?: boolean;
     }): Promise<Models.TableList>;
     /**
      * Get a list of all tables that belong to the provided databaseId. You can use the search parameter to filter your results.
@@ -273,11 +278,12 @@ declare class TablesDB {
      * @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 columns: name, enabled, rowSecurity
      * @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.TableList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listTables(databaseId: string, queries?: string[], search?: string): Promise<Models.TableList>;
+    listTables(databaseId: string, queries?: string[], search?: string, total?: boolean): Promise<Models.TableList>;
     /**
      * Create a new Table. Before using this route, you should create a new database resource using either a [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable) API or directly from your database console.
      *
@@ -341,7 +347,7 @@ declare class TablesDB {
      * @param {string} params.tableId - Table ID.
      * @param {string} params.name - Table name. Max length: 128 chars.
      * @param {string[]} params.permissions - An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
-     * @param {boolean} params.rowSecurity - Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a document. [Learn more about permissions](https://appwrite.io/docs/permissions).
+     * @param {boolean} params.rowSecurity - Enables configuring permissions for individual rows. A user needs one of row or table-level permissions to access a row. [Learn more about permissions](https://appwrite.io/docs/permissions).
      * @param {boolean} params.enabled - Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Table>}
@@ -361,7 +367,7 @@ declare class TablesDB {
      * @param {string} tableId - Table ID.
      * @param {string} name - Table name. Max length: 128 chars.
      * @param {string[]} permissions - An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
-     * @param {boolean} rowSecurity - Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a document. [Learn more about permissions](https://appwrite.io/docs/permissions).
+     * @param {boolean} rowSecurity - Enables configuring permissions for individual rows. A user needs one of row or table-level permissions to access a row. [Learn more about permissions](https://appwrite.io/docs/permissions).
      * @param {boolean} enabled - Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Table>}
@@ -396,6 +402,7 @@ declare class TablesDB {
      * @param {string} params.databaseId - Database ID.
      * @param {string} params.tableId - Table 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 columns: 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.ColumnList>}
      */
@@ -403,6 +410,7 @@ declare class TablesDB {
         databaseId: string;
         tableId: string;
         queries?: string[];
+        total?: boolean;
     }): Promise<Models.ColumnList>;
     /**
      * List columns in the table.
@@ -410,11 +418,12 @@ declare class TablesDB {
      * @param {string} databaseId - Database ID.
      * @param {string} tableId - Table 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 columns: 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.ColumnList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listColumns(databaseId: string, tableId: string, queries?: string[]): Promise<Models.ColumnList>;
+    listColumns(databaseId: string, tableId: string, queries?: string[], total?: boolean): Promise<Models.ColumnList>;
     /**
      * Create a boolean column.
      *
@@ -1420,6 +1429,7 @@ declare class TablesDB {
      * @param {string} params.databaseId - Database ID.
      * @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
      * @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 columns: 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.ColumnIndexList>}
      */
@@ -1427,6 +1437,7 @@ declare class TablesDB {
         databaseId: string;
         tableId: string;
         queries?: string[];
+        total?: boolean;
     }): Promise<Models.ColumnIndexList>;
     /**
      * List indexes on the table.
@@ -1434,11 +1445,12 @@ declare class TablesDB {
      * @param {string} databaseId - Database ID.
      * @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
      * @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 columns: 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.ColumnIndexList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listIndexes(databaseId: string, tableId: string, queries?: string[]): Promise<Models.ColumnIndexList>;
+    listIndexes(databaseId: string, tableId: string, queries?: string[], total?: boolean): Promise<Models.ColumnIndexList>;
     /**
      * Creates an index on the columns listed. Your index should include all the columns you will query in a single request.
      * Type can be `key`, `fulltext`, or `unique`.
@@ -1535,6 +1547,7 @@ declare class TablesDB {
      * @param {string} params.tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/products/databases/tables#create-table).
      * @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.RowList<Row>>}
      */
@@ -1543,6 +1556,7 @@ declare class TablesDB {
         tableId: string;
         queries?: string[];
         transactionId?: string;
+        total?: boolean;
     }): Promise<Models.RowList<Row>>;
     /**
      * Get a list of all the user's rows in a given table. You can use the query params to filter your results.
@@ -1551,11 +1565,12 @@ declare class TablesDB {
      * @param {string} tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/products/databases/tables#create-table).
      * @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.RowList<Row>>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listRows<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, queries?: string[], transactionId?: string): Promise<Models.RowList<Row>>;
+    listRows<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, queries?: string[], transactionId?: string, total?: boolean): Promise<Models.RowList<Row>>;
     /**
      * Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable) API or directly from your database console.
      *

package/dist/services/tables-db.js

@@ -13,11 +13,13 @@ class TablesDB {
     } 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 = "/tablesdb";
     const payload = {};
     if (typeof queries !== "undefined") {
@@ -26,6 +28,9 @@ class TablesDB {
     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 TablesDB {
       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 TablesDB {
     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 TablesDB {
       params = {
         databaseId: paramsOrFirst,
         tableId: rest[0],
-        queries: rest[1]
+        queries: rest[1],
+        total: rest[2]
       };
     }
     const databaseId = params.databaseId;
     const tableId = params.tableId;
     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 TablesDB {
     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(
@@ -2181,12 +2196,14 @@ class TablesDB {
       params = {
         databaseId: paramsOrFirst,
         tableId: rest[0],
-        queries: rest[1]
+        queries: rest[1],
+        total: rest[2]
       };
     }
     const databaseId = params.databaseId;
     const tableId = params.tableId;
     const queries = params.queries;
+    const total = params.total;
     if (typeof databaseId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "databaseId"');
     }
@@ -2198,6 +2215,9 @@ class TablesDB {
     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(
@@ -2351,13 +2371,15 @@ class TablesDB {
         databaseId: paramsOrFirst,
         tableId: rest[0],
         queries: rest[1],
-        transactionId: rest[2]
+        transactionId: rest[2],
+        total: rest[3]
       };
     }
     const databaseId = params.databaseId;
     const tableId = params.tableId;
     const queries = params.queries;
     const transactionId = params.transactionId;
+    const total = params.total;
     if (typeof databaseId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "databaseId"');
     }
@@ -2372,6 +2394,9 @@ class TablesDB {
     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(