node-appwrite 17.0.0 → 17.2.0

package/dist/services/users.d.ts

@@ -16,7 +16,7 @@ declare class Users {
      * @throws {AppwriteException}
      * @returns {Promise<Models.UserList<Preferences>>}
      */
-    list<Preferences extends Models.Preferences>(queries?: string[], search?: string): Promise<Models.UserList<Preferences>>;
+    list<Preferences extends Models.Preferences = Models.DefaultPreferences>(queries?: string[], search?: string): Promise<Models.UserList<Preferences>>;
     /**
      * Create a new user.
      *
@@ -28,7 +28,7 @@ declare class Users {
      * @throws {AppwriteException}
      * @returns {Promise<Models.User<Preferences>>}
      */
-    create<Preferences extends Models.Preferences>(userId: string, email?: string, phone?: string, password?: string, name?: string): Promise<Models.User<Preferences>>;
+    create<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, email?: string, phone?: string, password?: string, name?: string): Promise<Models.User<Preferences>>;
     /**
      * Create a new user. Password provided must be hashed with the [Argon2](https://en.wikipedia.org/wiki/Argon2) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
      *
@@ -39,7 +39,7 @@ declare class Users {
      * @throws {AppwriteException}
      * @returns {Promise<Models.User<Preferences>>}
      */
-    createArgon2User<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
+    createArgon2User<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
     /**
      * Create a new user. Password provided must be hashed with the [Bcrypt](https://en.wikipedia.org/wiki/Bcrypt) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
      *
@@ -50,7 +50,7 @@ declare class Users {
      * @throws {AppwriteException}
      * @returns {Promise<Models.User<Preferences>>}
      */
-    createBcryptUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
+    createBcryptUser<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
     /**
      * Get identities for all users.
      *
@@ -78,7 +78,7 @@ declare class Users {
      * @throws {AppwriteException}
      * @returns {Promise<Models.User<Preferences>>}
      */
-    createMD5User<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
+    createMD5User<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
     /**
      * Create a new user. Password provided must be hashed with the [PHPass](https://www.openwall.com/phpass/) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
      *
@@ -89,7 +89,7 @@ declare class Users {
      * @throws {AppwriteException}
      * @returns {Promise<Models.User<Preferences>>}
      */
-    createPHPassUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
+    createPHPassUser<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
     /**
      * Create a new user. Password provided must be hashed with the [Scrypt](https://github.com/Tarsnap/scrypt) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
      *
@@ -105,7 +105,7 @@ declare class Users {
      * @throws {AppwriteException}
      * @returns {Promise<Models.User<Preferences>>}
      */
-    createScryptUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, passwordSalt: string, passwordCpu: number, passwordMemory: number, passwordParallel: number, passwordLength: number, name?: string): Promise<Models.User<Preferences>>;
+    createScryptUser<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, email: string, password: string, passwordSalt: string, passwordCpu: number, passwordMemory: number, passwordParallel: number, passwordLength: number, name?: string): Promise<Models.User<Preferences>>;
     /**
      * Create a new user. Password provided must be hashed with the [Scrypt Modified](https://gist.github.com/Meldiron/eecf84a0225eccb5a378d45bb27462cc) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
      *
@@ -119,7 +119,7 @@ declare class Users {
      * @throws {AppwriteException}
      * @returns {Promise<Models.User<Preferences>>}
      */
-    createScryptModifiedUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, passwordSalt: string, passwordSaltSeparator: string, passwordSignerKey: string, name?: string): Promise<Models.User<Preferences>>;
+    createScryptModifiedUser<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, email: string, password: string, passwordSalt: string, passwordSaltSeparator: string, passwordSignerKey: string, name?: string): Promise<Models.User<Preferences>>;
     /**
      * Create a new user. Password provided must be hashed with the [SHA](https://en.wikipedia.org/wiki/Secure_Hash_Algorithm) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
      *
@@ -131,7 +131,7 @@ declare class Users {
      * @throws {AppwriteException}
      * @returns {Promise<Models.User<Preferences>>}
      */
-    createSHAUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, passwordVersion?: PasswordHash, name?: string): Promise<Models.User<Preferences>>;
+    createSHAUser<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, email: string, password: string, passwordVersion?: PasswordHash, name?: string): Promise<Models.User<Preferences>>;
     /**
      * Get a user by its unique ID.
      *
@@ -139,7 +139,7 @@ declare class Users {
      * @throws {AppwriteException}
      * @returns {Promise<Models.User<Preferences>>}
      */
-    get<Preferences extends Models.Preferences>(userId: string): Promise<Models.User<Preferences>>;
+    get<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string): Promise<Models.User<Preferences>>;
     /**
      * Delete a user by its unique ID, thereby releasing it&#039;s ID. Since ID is released and can be reused, all user-related resources like documents or storage files should be deleted before user deletion. If you want to keep ID reserved, use the [updateStatus](https://appwrite.io/docs/server/users#usersUpdateStatus) endpoint instead.
      *
@@ -156,7 +156,7 @@ declare class Users {
      * @throws {AppwriteException}
      * @returns {Promise<Models.User<Preferences>>}
      */
-    updateEmail<Preferences extends Models.Preferences>(userId: string, email: string): Promise<Models.User<Preferences>>;
+    updateEmail<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, email: string): Promise<Models.User<Preferences>>;
     /**
      * Use this endpoint to create a JSON Web Token for user by its unique ID. You can use the resulting JWT to authenticate on behalf of the user. The JWT secret will become invalid if the session it uses gets deleted.
      *
@@ -169,15 +169,15 @@ declare class Users {
     createJWT(userId: string, sessionId?: string, duration?: number): Promise<Models.Jwt>;
     /**
      * Update the user labels by its unique ID.
-
-Labels can be used to grant access to resources. While teams are a way for user&#039;s to share access to a resource, labels can be defined by the developer to grant access without an invitation. See the [Permissions docs](https://appwrite.io/docs/permissions) for more info.
+     *
+     * Labels can be used to grant access to resources. While teams are a way for user&#039;s to share access to a resource, labels can be defined by the developer to grant access without an invitation. See the [Permissions docs](https://appwrite.io/docs/permissions) for more info.
      *
      * @param {string} userId
      * @param {string[]} labels
      * @throws {AppwriteException}
      * @returns {Promise<Models.User<Preferences>>}
      */
-    updateLabels<Preferences extends Models.Preferences>(userId: string, labels: string[]): Promise<Models.User<Preferences>>;
+    updateLabels<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, labels: string[]): Promise<Models.User<Preferences>>;
     /**
      * Get the user activity logs list by its unique ID.
      *
@@ -205,7 +205,7 @@ Labels can be used to grant access to resources. While teams are a way for user&
      * @throws {AppwriteException}
      * @returns {Promise<Models.User<Preferences>>}
      */
-    updateMfa<Preferences extends Models.Preferences>(userId: string, mfa: boolean): Promise<Models.User<Preferences>>;
+    updateMfa<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, mfa: boolean): Promise<Models.User<Preferences>>;
     /**
      * Delete an authenticator app.
      *
@@ -255,7 +255,7 @@ Labels can be used to grant access to resources. While teams are a way for user&
      * @throws {AppwriteException}
      * @returns {Promise<Models.User<Preferences>>}
      */
-    updateName<Preferences extends Models.Preferences>(userId: string, name: string): Promise<Models.User<Preferences>>;
+    updateName<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, name: string): Promise<Models.User<Preferences>>;
     /**
      * Update the user password by its unique ID.
      *
@@ -264,7 +264,7 @@ Labels can be used to grant access to resources. While teams are a way for user&
      * @throws {AppwriteException}
      * @returns {Promise<Models.User<Preferences>>}
      */
-    updatePassword<Preferences extends Models.Preferences>(userId: string, password: string): Promise<Models.User<Preferences>>;
+    updatePassword<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, password: string): Promise<Models.User<Preferences>>;
     /**
      * Update the user phone by its unique ID.
      *
@@ -273,7 +273,7 @@ Labels can be used to grant access to resources. While teams are a way for user&
      * @throws {AppwriteException}
      * @returns {Promise<Models.User<Preferences>>}
      */
-    updatePhone<Preferences extends Models.Preferences>(userId: string, number: string): Promise<Models.User<Preferences>>;
+    updatePhone<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, number: string): Promise<Models.User<Preferences>>;
     /**
      * Get the user preferences by its unique ID.
      *
@@ -281,7 +281,7 @@ Labels can be used to grant access to resources. While teams are a way for user&
      * @throws {AppwriteException}
      * @returns {Promise<Preferences>}
      */
-    getPrefs<Preferences extends Models.Preferences>(userId: string): Promise<Preferences>;
+    getPrefs<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string): Promise<Preferences>;
     /**
      * Update the user preferences by its unique ID. The object you pass is stored as is, and replaces any previous value. The maximum allowed prefs size is 64kB and throws error if exceeded.
      *
@@ -290,7 +290,7 @@ Labels can be used to grant access to resources. While teams are a way for user&
      * @throws {AppwriteException}
      * @returns {Promise<Preferences>}
      */
-    updatePrefs<Preferences extends Models.Preferences>(userId: string, prefs: object): Promise<Preferences>;
+    updatePrefs<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, prefs: object): Promise<Preferences>;
     /**
      * Get the user sessions list by its unique ID.
      *
@@ -301,8 +301,8 @@ Labels can be used to grant access to resources. While teams are a way for user&
     listSessions(userId: string): Promise<Models.SessionList>;
     /**
      * Creates a session for a user. Returns an immediately usable session object.
-
-If you want to generate a token for a custom authentication flow, use the [POST /users/{userId}/tokens](https://appwrite.io/docs/server/users#createToken) endpoint.
+     *
+     * If you want to generate a token for a custom authentication flow, use the [POST /users/{userId}/tokens](https://appwrite.io/docs/server/users#createToken) endpoint.
      *
      * @param {string} userId
      * @throws {AppwriteException}
@@ -334,7 +334,7 @@ If you want to generate a token for a custom authentication flow, use the [POST
      * @throws {AppwriteException}
      * @returns {Promise<Models.User<Preferences>>}
      */
-    updateStatus<Preferences extends Models.Preferences>(userId: string, status: boolean): Promise<Models.User<Preferences>>;
+    updateStatus<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, status: boolean): Promise<Models.User<Preferences>>;
     /**
      * List the messaging targets that are associated with a user.
      *
@@ -389,7 +389,7 @@ If you want to generate a token for a custom authentication flow, use the [POST
     deleteTarget(userId: string, targetId: string): Promise<{}>;
     /**
      * Returns a token with a secret key for creating a session. Use the user ID and secret and submit a request to the [PUT /account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) endpoint to complete the login process.
-
+     *
      *
      * @param {string} userId
      * @param {number} length
@@ -406,7 +406,7 @@ If you want to generate a token for a custom authentication flow, use the [POST
      * @throws {AppwriteException}
      * @returns {Promise<Models.User<Preferences>>}
      */
-    updateEmailVerification<Preferences extends Models.Preferences>(userId: string, emailVerification: boolean): Promise<Models.User<Preferences>>;
+    updateEmailVerification<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, emailVerification: boolean): Promise<Models.User<Preferences>>;
     /**
      * Update the user phone verification status by its unique ID.
      *
@@ -415,7 +415,7 @@ If you want to generate a token for a custom authentication flow, use the [POST
      * @throws {AppwriteException}
      * @returns {Promise<Models.User<Preferences>>}
      */
-    updatePhoneVerification<Preferences extends Models.Preferences>(userId: string, phoneVerification: boolean): Promise<Models.User<Preferences>>;
+    updatePhoneVerification<Preferences extends Models.Preferences = Models.DefaultPreferences>(userId: string, phoneVerification: boolean): Promise<Models.User<Preferences>>;
 }
 
 export { Users };

package/dist/services/users.js

@@ -610,15 +610,15 @@ class Users {
     );
   }
   /**
-       * Update the user labels by its unique ID. 
-  
-  Labels can be used to grant access to resources. While teams are a way for user's to share access to a resource, labels can be defined by the developer to grant access without an invitation. See the [Permissions docs](https://appwrite.io/docs/permissions) for more info.
-       *
-       * @param {string} userId
-       * @param {string[]} labels
-       * @throws {AppwriteException}
-       * @returns {Promise<Models.User<Preferences>>}
-       */
+   * Update the user labels by its unique ID. 
+   * 
+   * Labels can be used to grant access to resources. While teams are a way for user&#039;s to share access to a resource, labels can be defined by the developer to grant access without an invitation. See the [Permissions docs](https://appwrite.io/docs/permissions) for more info.
+   *
+   * @param {string} userId
+   * @param {string[]} labels
+   * @throws {AppwriteException}
+   * @returns {Promise<Models.User<Preferences>>}
+   */
   updateLabels(userId, labels) {
     if (typeof userId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "userId"');
@@ -1018,14 +1018,14 @@ class Users {
     );
   }
   /**
-       * Creates a session for a user. Returns an immediately usable session object.
-  
-  If you want to generate a token for a custom authentication flow, use the [POST /users/{userId}/tokens](https://appwrite.io/docs/server/users#createToken) endpoint.
-       *
-       * @param {string} userId
-       * @throws {AppwriteException}
-       * @returns {Promise<Models.Session>}
-       */
+   * Creates a session for a user. Returns an immediately usable session object.
+   * 
+   * If you want to generate a token for a custom authentication flow, use the [POST /users/{userId}/tokens](https://appwrite.io/docs/server/users#createToken) endpoint.
+   *
+   * @param {string} userId
+   * @throws {AppwriteException}
+   * @returns {Promise<Models.Session>}
+   */
   createSession(userId) {
     if (typeof userId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "userId"');
@@ -1300,15 +1300,15 @@ class Users {
     );
   }
   /**
-       * Returns a token with a secret key for creating a session. Use the user ID and secret and submit a request to the [PUT /account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) endpoint to complete the login process.
-  
-       *
-       * @param {string} userId
-       * @param {number} length
-       * @param {number} expire
-       * @throws {AppwriteException}
-       * @returns {Promise<Models.Token>}
-       */
+   * Returns a token with a secret key for creating a session. Use the user ID and secret and submit a request to the [PUT /account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) endpoint to complete the login process.
+   * 
+   *
+   * @param {string} userId
+   * @param {number} length
+   * @param {number} expire
+   * @throws {AppwriteException}
+   * @returns {Promise<Models.Token>}
+   */
   createToken(userId, length, expire) {
     if (typeof userId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "userId"');