@appwrite.io/console 0.3.0 → 0.4.1

package/types/services/teams.d.ts

@@ -4,7 +4,7 @@ import type { Models } from '../models';
 export declare class Teams extends Service {
     constructor(client: Client);
     /**
-     * List Teams
+     * List teams
      *
      * Get a list of all the teams in which the current user is a member. You can
      * use the parameters to filter your results.
@@ -16,7 +16,7 @@ export declare class Teams extends Service {
     */
     list<Preferences extends Models.Preferences>(queries?: string[], search?: string): Promise<Models.TeamList<Preferences>>;
     /**
-     * Create Team
+     * Create team
      *
      * Create a new team. The user who creates the team will automatically be
      * assigned as the owner of the team. Only the users with the owner role can
@@ -30,7 +30,7 @@ export declare class Teams extends Service {
     */
     create<Preferences extends Models.Preferences>(teamId: string, name: string, roles?: string[]): Promise<Models.Team<Preferences>>;
     /**
-     * Get Team
+     * Get team
      *
      * Get a team by its ID. All team members have read access for this resource.
      *
@@ -40,7 +40,7 @@ export declare class Teams extends Service {
     */
     get<Preferences extends Models.Preferences>(teamId: string): Promise<Models.Team<Preferences>>;
     /**
-     * Update Name
+     * Update name
      *
      * Update the team's name by its unique ID.
      *
@@ -51,7 +51,7 @@ export declare class Teams extends Service {
     */
     updateName<Preferences extends Models.Preferences>(teamId: string, name: string): Promise<Models.Team<Preferences>>;
     /**
-     * Delete Team
+     * Delete team
      *
      * Delete a team using its ID. Only team members with the owner role can
      * delete the team.
@@ -62,7 +62,7 @@ export declare class Teams extends Service {
     */
     delete(teamId: string): Promise<{}>;
     /**
-     * List Team Logs
+     * List team logs
      *
      * Get the team activity logs list by its unique ID.
      *
@@ -73,7 +73,7 @@ export declare class Teams extends Service {
     */
     listLogs(teamId: string, queries?: string[]): Promise<Models.LogList>;
     /**
-     * List Team Memberships
+     * List team memberships
      *
      * Use this endpoint to list a team's members using the team's ID. All team
      * members have read access to this endpoint.
@@ -86,7 +86,7 @@ export declare class Teams extends Service {
     */
     listMemberships(teamId: string, queries?: string[], search?: string): Promise<Models.MembershipList>;
     /**
-     * Create Team Membership
+     * Create team membership
      *
      * Invite a new member to join your team. Provide an ID for existing users, or
      * invite unregistered users using an email or phone number. If initiated from
@@ -101,8 +101,8 @@ export declare class Teams extends Service {
      *
      * Use the `url` parameter to redirect the user from the invitation email to
      * your app. After the user is redirected, use the [Update Team Membership
-     * Status](/docs/client/teams#teamsUpdateMembershipStatus) endpoint to allow
-     * the user to accept the invitation to the team.
+     * Status](https://appwrite.io/docs/references/cloud/client-web/teams#updateMembershipStatus)
+     * endpoint to allow the user to accept the invitation to the team.
      *
      * Please note that to avoid a [Redirect
      * Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md)
@@ -112,17 +112,17 @@ export declare class Teams extends Service {
      *
      * @param {string} teamId
      * @param {string[]} roles
-     * @param {string} url
      * @param {string} email
      * @param {string} userId
      * @param {string} phone
+     * @param {string} url
      * @param {string} name
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createMembership(teamId: string, roles: string[], url: string, email?: string, userId?: string, phone?: string, name?: string): Promise<Models.Membership>;
+    createMembership(teamId: string, roles: string[], email?: string, userId?: string, phone?: string, url?: string, name?: string): Promise<Models.Membership>;
     /**
-     * Get Team Membership
+     * Get team membership
      *
      * Get a team member by the membership unique id. All team members have read
      * access for this resource.
@@ -134,11 +134,11 @@ export declare class Teams extends Service {
     */
     getMembership(teamId: string, membershipId: string): Promise<Models.Membership>;
     /**
-     * Update Membership
+     * Update membership
      *
      * Modify the roles of a team member. Only team members with the owner role
      * have access to this endpoint. Learn more about [roles and
-     * permissions](/docs/permissions).
+     * permissions](https://appwrite.io/docs/permissions).
      *
      *
      * @param {string} teamId
@@ -149,7 +149,7 @@ export declare class Teams extends Service {
     */
     updateMembership(teamId: string, membershipId: string, roles: string[]): Promise<Models.Membership>;
     /**
-     * Delete Team Membership
+     * Delete team membership
      *
      * This endpoint allows a user to leave a team or for a team owner to delete
      * the membership of any other team member. You can also use this endpoint to
@@ -162,7 +162,7 @@ export declare class Teams extends Service {
     */
     deleteMembership(teamId: string, membershipId: string): Promise<{}>;
     /**
-     * Update Team Membership Status
+     * Update team membership status
      *
      * Use this endpoint to allow a user to accept an invitation to join a team
      * after being redirected back to your app from the invitation email received
@@ -181,11 +181,11 @@ export declare class Teams extends Service {
     */
     updateMembershipStatus(teamId: string, membershipId: string, userId: string, secret: string): Promise<Models.Membership>;
     /**
-     * Get Team Preferences
+     * Get team preferences
      *
      * Get the team's shared preferences by its unique ID. If a preference doesn't
      * need to be shared by all team members, prefer storing them in [user
-     * preferences](/docs/client/account#accountGetPrefs).
+     * preferences](https://appwrite.io/docs/references/cloud/client-web/account#getPrefs).
      *
      * @param {string} teamId
      * @throws {AppwriteException}
@@ -193,7 +193,7 @@ export declare class Teams extends Service {
     */
     getPrefs<Preferences extends Models.Preferences>(teamId: string): Promise<Preferences>;
     /**
-     * Update Preferences
+     * Update preferences
      *
      * Update the team's preferences by its unique ID. The object you pass is
      * stored as is and replaces any previous value. The maximum allowed prefs

package/types/services/users.d.ts

@@ -4,7 +4,7 @@ import type { Models } from '../models';
 export declare class Users extends Service {
     constructor(client: Client);
     /**
-     * List Users
+     * List users
      *
      * Get a list of all the project's users. You can use the query params to
      * filter your results.
@@ -16,7 +16,7 @@ export declare class Users extends Service {
     */
     list<Preferences extends Models.Preferences>(queries?: string[], search?: string): Promise<Models.UserList<Preferences>>;
     /**
-     * Create User
+     * Create user
      *
      * Create a new user.
      *
@@ -30,12 +30,12 @@ export declare class Users extends Service {
     */
     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 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](/docs/server/users#usersCreate) endpoint to create users with a
-     * plain text password.
+     * /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to
+     * create users with a plain text password.
      *
      * @param {string} userId
      * @param {string} email
@@ -46,12 +46,12 @@ export declare class Users extends Service {
     */
     createArgon2User<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
     /**
-     * Create User with Bcrypt Password
+     * 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](/docs/server/users#usersCreate) endpoint to create users with a
-     * plain text password.
+     * /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to
+     * create users with a plain text password.
      *
      * @param {string} userId
      * @param {string} email
@@ -83,12 +83,12 @@ export declare class Users extends Service {
     */
     deleteIdentity(identityId: string): Promise<{}>;
     /**
-     * Create User with MD5 Password
+     * 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](/docs/server/users#usersCreate) endpoint to create users with a
-     * plain text password.
+     * /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to
+     * create users with a plain text password.
      *
      * @param {string} userId
      * @param {string} email
@@ -99,12 +99,12 @@ export declare class Users extends Service {
     */
     createMD5User<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
     /**
-     * Create User with PHPass Password
+     * 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](/docs/server/users#usersCreate) endpoint to create users with a
-     * plain text password.
+     * /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to
+     * create users with a plain text password.
      *
      * @param {string} userId
      * @param {string} email
@@ -115,12 +115,12 @@ export declare class Users extends Service {
     */
     createPHPassUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
     /**
-     * Create User with Scrypt Password
+     * 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](/docs/server/users#usersCreate) endpoint to create users with a
-     * plain text password.
+     * /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to
+     * create users with a plain text password.
      *
      * @param {string} userId
      * @param {string} email
@@ -136,12 +136,13 @@ export declare class Users extends Service {
     */
     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 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](/docs/server/users#usersCreate) endpoint
-     * to create users with a plain text password.
+     * algorithm. Use the [POST
+     * /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to
+     * create users with a plain text password.
      *
      * @param {string} userId
      * @param {string} email
@@ -155,12 +156,12 @@ export declare class Users extends Service {
     */
     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 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](/docs/server/users#usersCreate) endpoint to create users
-     * with a plain text password.
+     * the [POST /users](https://appwrite.io/docs/server/users#usersCreate)
+     * endpoint to create users with a plain text password.
      *
      * @param {string} userId
      * @param {string} email
@@ -176,13 +177,12 @@ export declare class Users extends Service {
      *
      *
      * @param {string} range
-     * @param {string} provider
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    getUsage(range?: string, provider?: string): Promise<Models.UsageUsers>;
+    getUsage(range?: string): Promise<Models.UsageUsers>;
     /**
-     * Get User
+     * Get user
      *
      * Get a user by its unique ID.
      *
@@ -192,12 +192,13 @@ export declare class Users extends Service {
     */
     get<Preferences extends Models.Preferences>(userId: string): Promise<Models.User<Preferences>>;
     /**
-     * Delete User
+     * Delete user
      *
      * Delete a user by its unique ID, thereby releasing it'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](/docs/server/users#usersUpdateStatus)
+     * ID reserved, use the
+     * [updateStatus](https://appwrite.io/docs/server/users#usersUpdateStatus)
      * endpoint instead.
      *
      * @param {string} userId
@@ -206,7 +207,7 @@ export declare class Users extends Service {
     */
     delete(userId: string): Promise<{}>;
     /**
-     * Update Email
+     * Update email
      *
      * Update the user email by its unique ID.
      *
@@ -217,14 +218,14 @@ export declare class Users extends Service {
     */
     updateEmail<Preferences extends Models.Preferences>(userId: string, email: string): Promise<Models.User<Preferences>>;
     /**
-     * Update User Labels
+     * 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's to share access to a resource, labels can be defined by the
      * developer to grant access without an invitation. See the [Permissions
-     * docs](/docs/permissions) for more info.
+     * docs](https://appwrite.io/docs/permissions) for more info.
      *
      * @param {string} userId
      * @param {string[]} labels
@@ -233,7 +234,7 @@ export declare class Users extends Service {
     */
     updateLabels<Preferences extends Models.Preferences>(userId: string, labels: string[]): Promise<Models.User<Preferences>>;
     /**
-     * List User Logs
+     * List user logs
      *
      * Get the user activity logs list by its unique ID.
      *
@@ -244,7 +245,7 @@ export declare class Users extends Service {
     */
     listLogs(userId: string, queries?: string[]): Promise<Models.LogList>;
     /**
-     * List User Memberships
+     * List user memberships
      *
      * Get the user membership list by its unique ID.
      *
@@ -254,7 +255,7 @@ export declare class Users extends Service {
     */
     listMemberships(userId: string): Promise<Models.MembershipList>;
     /**
-     * Update Name
+     * Update name
      *
      * Update the user name by its unique ID.
      *
@@ -265,7 +266,7 @@ export declare class Users extends Service {
     */
     updateName<Preferences extends Models.Preferences>(userId: string, name: string): Promise<Models.User<Preferences>>;
     /**
-     * Update Password
+     * Update password
      *
      * Update the user password by its unique ID.
      *
@@ -276,7 +277,7 @@ export declare class Users extends Service {
     */
     updatePassword<Preferences extends Models.Preferences>(userId: string, password: string): Promise<Models.User<Preferences>>;
     /**
-     * Update Phone
+     * Update phone
      *
      * Update the user phone by its unique ID.
      *
@@ -287,7 +288,7 @@ export declare class Users extends Service {
     */
     updatePhone<Preferences extends Models.Preferences>(userId: string, number: string): Promise<Models.User<Preferences>>;
     /**
-     * Get User Preferences
+     * Get user preferences
      *
      * Get the user preferences by its unique ID.
      *
@@ -297,7 +298,7 @@ export declare class Users extends Service {
     */
     getPrefs<Preferences extends Models.Preferences>(userId: string): Promise<Preferences>;
     /**
-     * Update User 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
@@ -310,7 +311,7 @@ export declare class Users extends Service {
     */
     updatePrefs<Preferences extends Models.Preferences>(userId: string, prefs: object): Promise<Preferences>;
     /**
-     * List User Sessions
+     * List user sessions
      *
      * Get the user sessions list by its unique ID.
      *
@@ -320,7 +321,7 @@ export declare class Users extends Service {
     */
     listSessions(userId: string): Promise<Models.SessionList>;
     /**
-     * Delete User Sessions
+     * Delete user sessions
      *
      * Delete all user's sessions by using the user's unique ID.
      *
@@ -330,7 +331,7 @@ export declare class Users extends Service {
     */
     deleteSessions(userId: string): Promise<{}>;
     /**
-     * Delete User Session
+     * Delete user session
      *
      * Delete a user sessions by its unique ID.
      *
@@ -341,7 +342,7 @@ export declare class Users extends Service {
     */
     deleteSession(userId: string, sessionId: string): Promise<{}>;
     /**
-     * Update User Status
+     * 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's ID reserved.
@@ -353,7 +354,7 @@ export declare class Users extends Service {
     */
     updateStatus<Preferences extends Models.Preferences>(userId: string, status: boolean): Promise<Models.User<Preferences>>;
     /**
-     * Update Email Verification
+     * Update email verification
      *
      * Update the user email verification status by its unique ID.
      *
@@ -364,7 +365,7 @@ export declare class Users extends Service {
     */
     updateEmailVerification<Preferences extends Models.Preferences>(userId: string, emailVerification: boolean): Promise<Models.User<Preferences>>;
     /**
-     * Update Phone Verification
+     * Update phone verification
      *
      * Update the user phone verification status by its unique ID.
      *