node-appwrite 20.1.0 → 20.3.0

package/dist/services/users.d.mts

@@ -23,23 +23,26 @@ declare class Users {
      *
      * @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, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels
      * @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.UserList<Preferences>>}
      */
     list<Preferences extends Models.Preferences = Models.DefaultPreferences>(params?: {
         queries?: string[];
         search?: string;
+        total?: boolean;
     }): Promise<Models.UserList<Preferences>>;
     /**
      * Get a list of all the project's users. 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, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels
      * @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.UserList<Preferences>>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    list<Preferences extends Models.Preferences = Models.DefaultPreferences>(queries?: string[], search?: string): Promise<Models.UserList<Preferences>>;
+    list<Preferences extends Models.Preferences = Models.DefaultPreferences>(queries?: string[], search?: string, total?: boolean): Promise<Models.UserList<Preferences>>;
     /**
      * Create a new user.
      *
@@ -132,23 +135,26 @@ declare class Users {
      *
      * @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: userId, provider, providerUid, providerEmail, providerAccessTokenExpiry
      * @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.IdentityList>}
      */
     listIdentities(params?: {
         queries?: string[];
         search?: string;
+        total?: boolean;
     }): Promise<Models.IdentityList>;
     /**
      * Get identities for all users.
      *
      * @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: userId, provider, providerUid, providerEmail, providerAccessTokenExpiry
      * @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.IdentityList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listIdentities(queries?: string[], search?: string): Promise<Models.IdentityList>;
+    listIdentities(queries?: string[], search?: string, total?: boolean): Promise<Models.IdentityList>;
     /**
      * Delete an identity by its unique ID.
      *
@@ -451,29 +457,33 @@ declare class Users {
      *
      * @param {string} params.userId - User 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). Only supported methods are limit and offset
+     * @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.LogList>}
      */
     listLogs(params: {
         userId: string;
         queries?: string[];
+        total?: boolean;
     }): Promise<Models.LogList>;
     /**
      * Get the user activity logs list by its unique ID.
      *
      * @param {string} userId - User 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). Only supported methods are limit and offset
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.LogList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listLogs(userId: string, queries?: string[]): Promise<Models.LogList>;
+    listLogs(userId: string, queries?: string[], total?: boolean): Promise<Models.LogList>;
     /**
      * Get the user membership list by its unique ID.
      *
      * @param {string} params.userId - User 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: userId, teamId, invited, joined, confirm, roles
      * @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.MembershipList>}
      */
@@ -481,6 +491,7 @@ declare class Users {
         userId: string;
         queries?: string[];
         search?: string;
+        total?: boolean;
     }): Promise<Models.MembershipList>;
     /**
      * Get the user membership list by its unique ID.
@@ -488,11 +499,12 @@ declare class Users {
      * @param {string} userId - User 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: userId, teamId, invited, joined, confirm, roles
      * @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.MembershipList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listMemberships(userId: string, queries?: string[], search?: string): Promise<Models.MembershipList>;
+    listMemberships(userId: string, queries?: string[], search?: string, total?: boolean): Promise<Models.MembershipList>;
     /**
      * Enable or disable MFA on a user account.
      *
@@ -850,21 +862,24 @@ declare class Users {
      * Get the user sessions list by its unique ID.
      *
      * @param {string} params.userId - User ID.
+     * @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.SessionList>}
      */
     listSessions(params: {
         userId: string;
+        total?: boolean;
     }): Promise<Models.SessionList>;
     /**
      * Get the user sessions list by its unique ID.
      *
      * @param {string} userId - User ID.
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.SessionList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listSessions(userId: string): Promise<Models.SessionList>;
+    listSessions(userId: string, total?: boolean): Promise<Models.SessionList>;
     /**
      * Creates a session for a user. Returns an immediately usable session object.
      *
@@ -956,23 +971,26 @@ declare class Users {
      *
      * @param {string} params.userId - User 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: userId, providerId, identifier, providerType
+     * @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.TargetList>}
      */
     listTargets(params: {
         userId: string;
         queries?: string[];
+        total?: boolean;
     }): Promise<Models.TargetList>;
     /**
      * List the messaging targets that are associated with a user.
      *
      * @param {string} userId - User 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: userId, providerId, identifier, providerType
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.TargetList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listTargets(userId: string, queries?: string[]): Promise<Models.TargetList>;
+    listTargets(userId: string, queries?: string[], total?: boolean): Promise<Models.TargetList>;
     /**
      * Create a messaging target.
      *

package/dist/services/users.d.ts

@@ -23,23 +23,26 @@ declare class Users {
      *
      * @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, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels
      * @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.UserList<Preferences>>}
      */
     list<Preferences extends Models.Preferences = Models.DefaultPreferences>(params?: {
         queries?: string[];
         search?: string;
+        total?: boolean;
     }): Promise<Models.UserList<Preferences>>;
     /**
      * Get a list of all the project's users. 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, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels
      * @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.UserList<Preferences>>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    list<Preferences extends Models.Preferences = Models.DefaultPreferences>(queries?: string[], search?: string): Promise<Models.UserList<Preferences>>;
+    list<Preferences extends Models.Preferences = Models.DefaultPreferences>(queries?: string[], search?: string, total?: boolean): Promise<Models.UserList<Preferences>>;
     /**
      * Create a new user.
      *
@@ -132,23 +135,26 @@ declare class Users {
      *
      * @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: userId, provider, providerUid, providerEmail, providerAccessTokenExpiry
      * @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.IdentityList>}
      */
     listIdentities(params?: {
         queries?: string[];
         search?: string;
+        total?: boolean;
     }): Promise<Models.IdentityList>;
     /**
      * Get identities for all users.
      *
      * @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: userId, provider, providerUid, providerEmail, providerAccessTokenExpiry
      * @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.IdentityList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listIdentities(queries?: string[], search?: string): Promise<Models.IdentityList>;
+    listIdentities(queries?: string[], search?: string, total?: boolean): Promise<Models.IdentityList>;
     /**
      * Delete an identity by its unique ID.
      *
@@ -451,29 +457,33 @@ declare class Users {
      *
      * @param {string} params.userId - User 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). Only supported methods are limit and offset
+     * @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.LogList>}
      */
     listLogs(params: {
         userId: string;
         queries?: string[];
+        total?: boolean;
     }): Promise<Models.LogList>;
     /**
      * Get the user activity logs list by its unique ID.
      *
      * @param {string} userId - User 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). Only supported methods are limit and offset
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.LogList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listLogs(userId: string, queries?: string[]): Promise<Models.LogList>;
+    listLogs(userId: string, queries?: string[], total?: boolean): Promise<Models.LogList>;
     /**
      * Get the user membership list by its unique ID.
      *
      * @param {string} params.userId - User 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: userId, teamId, invited, joined, confirm, roles
      * @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.MembershipList>}
      */
@@ -481,6 +491,7 @@ declare class Users {
         userId: string;
         queries?: string[];
         search?: string;
+        total?: boolean;
     }): Promise<Models.MembershipList>;
     /**
      * Get the user membership list by its unique ID.
@@ -488,11 +499,12 @@ declare class Users {
      * @param {string} userId - User 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: userId, teamId, invited, joined, confirm, roles
      * @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.MembershipList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listMemberships(userId: string, queries?: string[], search?: string): Promise<Models.MembershipList>;
+    listMemberships(userId: string, queries?: string[], search?: string, total?: boolean): Promise<Models.MembershipList>;
     /**
      * Enable or disable MFA on a user account.
      *
@@ -850,21 +862,24 @@ declare class Users {
      * Get the user sessions list by its unique ID.
      *
      * @param {string} params.userId - User ID.
+     * @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.SessionList>}
      */
     listSessions(params: {
         userId: string;
+        total?: boolean;
     }): Promise<Models.SessionList>;
     /**
      * Get the user sessions list by its unique ID.
      *
      * @param {string} userId - User ID.
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.SessionList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listSessions(userId: string): Promise<Models.SessionList>;
+    listSessions(userId: string, total?: boolean): Promise<Models.SessionList>;
     /**
      * Creates a session for a user. Returns an immediately usable session object.
      *
@@ -956,23 +971,26 @@ declare class Users {
      *
      * @param {string} params.userId - User 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: userId, providerId, identifier, providerType
+     * @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.TargetList>}
      */
     listTargets(params: {
         userId: string;
         queries?: string[];
+        total?: boolean;
     }): Promise<Models.TargetList>;
     /**
      * List the messaging targets that are associated with a user.
      *
      * @param {string} userId - User 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: userId, providerId, identifier, providerType
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.TargetList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listTargets(userId: string, queries?: string[]): Promise<Models.TargetList>;
+    listTargets(userId: string, queries?: string[], total?: boolean): Promise<Models.TargetList>;
     /**
      * Create a messaging target.
      *

package/dist/services/users.js

@@ -13,11 +13,13 @@ class Users {
     } 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 = "/users";
     const payload = {};
     if (typeof queries !== "undefined") {
@@ -26,6 +28,9 @@ class Users {
     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(
@@ -191,11 +196,13 @@ class Users {
     } 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 = "/users/identities";
     const payload = {};
     if (typeof queries !== "undefined") {
@@ -204,6 +211,9 @@ class Users {
     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(
@@ -719,11 +729,13 @@ class Users {
     } else {
       params = {
         userId: paramsOrFirst,
-        queries: rest[0]
+        queries: rest[0],
+        total: rest[1]
       };
     }
     const userId = params.userId;
     const queries = params.queries;
+    const total = params.total;
     if (typeof userId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "userId"');
     }
@@ -732,6 +744,9 @@ class Users {
     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(
@@ -749,12 +764,14 @@ class Users {
       params = {
         userId: paramsOrFirst,
         queries: rest[0],
-        search: rest[1]
+        search: rest[1],
+        total: rest[2]
       };
     }
     const userId = params.userId;
     const queries = params.queries;
     const search = params.search;
+    const total = params.total;
     if (typeof userId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "userId"');
     }
@@ -766,6 +783,9 @@ class Users {
     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(
@@ -1265,21 +1285,26 @@ class Users {
       payload
     );
   }
-  listSessions(paramsOrFirst) {
+  listSessions(paramsOrFirst, ...rest) {
     let params;
     if (paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
       params = paramsOrFirst || {};
     } else {
       params = {
-        userId: paramsOrFirst
+        userId: paramsOrFirst,
+        total: rest[0]
       };
     }
     const userId = params.userId;
+    const total = params.total;
     if (typeof userId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "userId"');
     }
     const apiPath = "/users/{userId}/sessions".replace("{userId}", userId);
     const payload = {};
+    if (typeof total !== "undefined") {
+      payload["total"] = total;
+    }
     const uri = new URL(this.client.config.endpoint + apiPath);
     const apiHeaders = {};
     return this.client.call(
@@ -1413,11 +1438,13 @@ class Users {
     } else {
       params = {
         userId: paramsOrFirst,
-        queries: rest[0]
+        queries: rest[0],
+        total: rest[1]
       };
     }
     const userId = params.userId;
     const queries = params.queries;
+    const total = params.total;
     if (typeof userId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "userId"');
     }
@@ -1426,6 +1453,9 @@ class Users {
     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(