node-appwrite 15.0.0 → 15.0.1

package/dist/services/users.d.mts

@@ -9,8 +9,6 @@ declare class Users {
     client: Client;
     constructor(client: Client);
     /**
-     * List users
-     *
      * Get a list of all the project's users. You can use the query params to filter your results.
      *
      * @param {string[]} queries
@@ -20,8 +18,6 @@ declare class Users {
      */
     list<Preferences extends Models.Preferences>(queries?: string[], search?: string): Promise<Models.UserList<Preferences>>;
     /**
-     * Create user
-     *
      * Create a new user.
      *
      * @param {string} userId
@@ -34,8 +30,6 @@ declare class Users {
      */
     create<Preferences extends Models.Preferences>(userId: string, email?: string, phone?: string, password?: string, name?: string): Promise<Models.User<Preferences>>;
     /**
-     * Create user with Argon2 password
-     *
      * 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.
      *
      * @param {string} userId
@@ -47,8 +41,6 @@ declare class Users {
      */
     createArgon2User<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
     /**
-     * Create user with bcrypt password
-     *
      * 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.
      *
      * @param {string} userId
@@ -60,8 +52,6 @@ declare class Users {
      */
     createBcryptUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
     /**
-     * List identities
-     *
      * Get identities for all users.
      *
      * @param {string[]} queries
@@ -71,8 +61,6 @@ declare class Users {
      */
     listIdentities(queries?: string[], search?: string): Promise<Models.IdentityList>;
     /**
-     * Delete identity
-     *
      * Delete an identity by its unique ID.
      *
      * @param {string} identityId
@@ -81,8 +69,6 @@ declare class Users {
      */
     deleteIdentity(identityId: string): Promise<{}>;
     /**
-     * Create user with MD5 password
-     *
      * Create a new user. Password provided must be hashed with the [MD5](https://en.wikipedia.org/wiki/MD5) algorithm. Use the [POST /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to create users with a plain text password.
      *
      * @param {string} userId
@@ -94,8 +80,6 @@ declare class Users {
      */
     createMD5User<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
     /**
-     * Create user with PHPass password
-     *
      * 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.
      *
      * @param {string} userId
@@ -107,8 +91,6 @@ declare class Users {
      */
     createPHPassUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
     /**
-     * Create user with Scrypt password
-     *
      * 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.
      *
      * @param {string} userId
@@ -125,8 +107,6 @@ declare class Users {
      */
     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>>;
     /**
-     * Create user with Scrypt modified password
-     *
      * 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.
      *
      * @param {string} userId
@@ -141,8 +121,6 @@ declare class Users {
      */
     createScryptModifiedUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, passwordSalt: string, passwordSaltSeparator: string, passwordSignerKey: string, name?: string): Promise<Models.User<Preferences>>;
     /**
-     * Create user with SHA password
-     *
      * 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.
      *
      * @param {string} userId
@@ -155,8 +133,6 @@ declare class Users {
      */
     createSHAUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, passwordVersion?: PasswordHash, name?: string): Promise<Models.User<Preferences>>;
     /**
-     * Get user
-     *
      * Get a user by its unique ID.
      *
      * @param {string} userId
@@ -165,8 +141,6 @@ declare class Users {
      */
     get<Preferences extends Models.Preferences>(userId: string): Promise<Models.User<Preferences>>;
     /**
-     * Delete user
-     *
      * 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.
      *
      * @param {string} userId
@@ -175,8 +149,6 @@ declare class Users {
      */
     delete(userId: string): Promise<{}>;
     /**
-     * Update email
-     *
      * Update the user email by its unique ID.
      *
      * @param {string} userId
@@ -186,8 +158,6 @@ declare class Users {
      */
     updateEmail<Preferences extends Models.Preferences>(userId: string, email: string): Promise<Models.User<Preferences>>;
     /**
-     * Create user JWT
-     *
      * 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.
      *
      * @param {string} userId
@@ -198,8 +168,6 @@ declare class Users {
      */
     createJWT(userId: string, sessionId?: string, duration?: number): Promise<Models.Jwt>;
     /**
-     * Update user labels
-     *
      * 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.
@@ -211,8 +179,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
      */
     updateLabels<Preferences extends Models.Preferences>(userId: string, labels: string[]): Promise<Models.User<Preferences>>;
     /**
-     * List user logs
-     *
      * Get the user activity logs list by its unique ID.
      *
      * @param {string} userId
@@ -222,8 +188,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
      */
     listLogs(userId: string, queries?: string[]): Promise<Models.LogList>;
     /**
-     * List user memberships
-     *
      * Get the user membership list by its unique ID.
      *
      * @param {string} userId
@@ -232,8 +196,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
      */
     listMemberships(userId: string): Promise<Models.MembershipList>;
     /**
-     * Update MFA
-     *
      * Enable or disable MFA on a user account.
      *
      * @param {string} userId
@@ -243,8 +205,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
      */
     updateMfa<Preferences extends Models.Preferences>(userId: string, mfa: boolean): Promise<Models.User<Preferences>>;
     /**
-     * Delete authenticator
-     *
      * Delete an authenticator app.
      *
      * @param {string} userId
@@ -254,8 +214,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
      */
     deleteMfaAuthenticator(userId: string, type: AuthenticatorType): Promise<{}>;
     /**
-     * List factors
-     *
      * List the factors available on the account to be used as a MFA challange.
      *
      * @param {string} userId
@@ -264,8 +222,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
      */
     listMfaFactors(userId: string): Promise<Models.MfaFactors>;
     /**
-     * Get MFA recovery codes
-     *
      * Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) method.
      *
      * @param {string} userId
@@ -274,8 +230,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
      */
     getMfaRecoveryCodes(userId: string): Promise<Models.MfaRecoveryCodes>;
     /**
-     * Regenerate MFA recovery codes
-     *
      * Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) method.
      *
      * @param {string} userId
@@ -284,8 +238,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
      */
     updateMfaRecoveryCodes(userId: string): Promise<Models.MfaRecoveryCodes>;
     /**
-     * Create MFA recovery codes
-     *
      * Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) method by client SDK.
      *
      * @param {string} userId
@@ -294,8 +246,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
      */
     createMfaRecoveryCodes(userId: string): Promise<Models.MfaRecoveryCodes>;
     /**
-     * Update name
-     *
      * Update the user name by its unique ID.
      *
      * @param {string} userId
@@ -305,8 +255,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
      */
     updateName<Preferences extends Models.Preferences>(userId: string, name: string): Promise<Models.User<Preferences>>;
     /**
-     * Update password
-     *
      * Update the user password by its unique ID.
      *
      * @param {string} userId
@@ -316,8 +264,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
      */
     updatePassword<Preferences extends Models.Preferences>(userId: string, password: string): Promise<Models.User<Preferences>>;
     /**
-     * Update phone
-     *
      * Update the user phone by its unique ID.
      *
      * @param {string} userId
@@ -327,8 +273,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
      */
     updatePhone<Preferences extends Models.Preferences>(userId: string, number: string): Promise<Models.User<Preferences>>;
     /**
-     * Get user preferences
-     *
      * Get the user preferences by its unique ID.
      *
      * @param {string} userId
@@ -337,8 +281,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
      */
     getPrefs<Preferences extends Models.Preferences>(userId: string): Promise<Preferences>;
     /**
-     * Update user 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.
      *
      * @param {string} userId
@@ -348,8 +290,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
      */
     updatePrefs<Preferences extends Models.Preferences>(userId: string, prefs: object): Promise<Preferences>;
     /**
-     * List user sessions
-     *
      * Get the user sessions list by its unique ID.
      *
      * @param {string} userId
@@ -358,8 +298,6 @@ Labels can be used to grant access to resources. While teams are a way for user&
      */
     listSessions(userId: string): Promise<Models.SessionList>;
     /**
-     * Create 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.
@@ -370,8 +308,6 @@ If you want to generate a token for a custom authentication flow, use the [POST
      */
     createSession(userId: string): Promise<Models.Session>;
     /**
-     * Delete user sessions
-     *
      * Delete all user&#039;s sessions by using the user&#039;s unique ID.
      *
      * @param {string} userId
@@ -380,8 +316,6 @@ If you want to generate a token for a custom authentication flow, use the [POST
      */
     deleteSessions(userId: string): Promise<{}>;
     /**
-     * Delete user session
-     *
      * Delete a user sessions by its unique ID.
      *
      * @param {string} userId
@@ -391,8 +325,6 @@ If you want to generate a token for a custom authentication flow, use the [POST
      */
     deleteSession(userId: string, sessionId: string): Promise<{}>;
     /**
-     * Update user status
-     *
      * Update the user status by its unique ID. Use this endpoint as an alternative to deleting a user if you want to keep user&#039;s ID reserved.
      *
      * @param {string} userId
@@ -402,8 +334,6 @@ If you want to generate a token for a custom authentication flow, use the [POST
      */
     updateStatus<Preferences extends Models.Preferences>(userId: string, status: boolean): Promise<Models.User<Preferences>>;
     /**
-     * List user targets
-     *
      * List the messaging targets that are associated with a user.
      *
      * @param {string} userId
@@ -413,8 +343,6 @@ If you want to generate a token for a custom authentication flow, use the [POST
      */
     listTargets(userId: string, queries?: string[]): Promise<Models.TargetList>;
     /**
-     * Create user target
-     *
      * Create a messaging target.
      *
      * @param {string} userId
@@ -428,8 +356,6 @@ If you want to generate a token for a custom authentication flow, use the [POST
      */
     createTarget(userId: string, targetId: string, providerType: MessagingProviderType, identifier: string, providerId?: string, name?: string): Promise<Models.Target>;
     /**
-     * Get user target
-     *
      * Get a user&#039;s push notification target by ID.
      *
      * @param {string} userId
@@ -439,8 +365,6 @@ If you want to generate a token for a custom authentication flow, use the [POST
      */
     getTarget(userId: string, targetId: string): Promise<Models.Target>;
     /**
-     * Update user target
-     *
      * Update a messaging target.
      *
      * @param {string} userId
@@ -453,8 +377,6 @@ If you want to generate a token for a custom authentication flow, use the [POST
      */
     updateTarget(userId: string, targetId: string, identifier?: string, providerId?: string, name?: string): Promise<Models.Target>;
     /**
-     * Delete user target
-     *
      * Delete a messaging target.
      *
      * @param {string} userId
@@ -464,8 +386,6 @@ If you want to generate a token for a custom authentication flow, use the [POST
      */
     deleteTarget(userId: string, targetId: string): Promise<{}>;
     /**
-     * Create 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.
 
      *
@@ -477,8 +397,6 @@ If you want to generate a token for a custom authentication flow, use the [POST
      */
     createToken(userId: string, length?: number, expire?: number): Promise<Models.Token>;
     /**
-     * Update email verification
-     *
      * Update the user email verification status by its unique ID.
      *
      * @param {string} userId
@@ -488,8 +406,6 @@ If you want to generate a token for a custom authentication flow, use the [POST
      */
     updateEmailVerification<Preferences extends Models.Preferences>(userId: string, emailVerification: boolean): Promise<Models.User<Preferences>>;
     /**
-     * Update phone verification
-     *
      * Update the user phone verification status by its unique ID.
      *
      * @param {string} userId