@appwrite.io/console 0.3.0 → 0.4.1

package/types/role.d.ts

@@ -1,8 +1,70 @@
+/**
+ * Helper class to generate role strings for `Permission`.
+ */
 export declare class Role {
+    /**
+     * Grants access to anyone.
+     *
+     * This includes authenticated and unauthenticated users.
+     *
+     * @returns {string}
+     */
     static any(): string;
+    /**
+     * Grants access to a specific user by user ID.
+     *
+     * You can optionally pass verified or unverified for
+     * `status` to target specific types of users.
+     *
+     * @param {string} id
+     * @param {string} status
+     * @returns {string}
+     */
     static user(id: string, status?: string): string;
+    /**
+     * Grants access to any authenticated or anonymous user.
+     *
+     * You can optionally pass verified or unverified for
+     * `status` to target specific types of users.
+     *
+     * @param {string} status
+     * @returns {string}
+     */
     static users(status?: string): string;
+    /**
+     * Grants access to any guest user without a session.
+     *
+     * Authenticated users don't have access to this role.
+     *
+     * @returns {string}
+     */
     static guests(): string;
+    /**
+     * Grants access to a team by team ID.
+     *
+     * You can optionally pass a role for `role` to target
+     * team members with the specified role.
+     *
+     * @param {string} id
+     * @param {string} role
+     * @returns {string}
+     */
     static team(id: string, role?: string): string;
+    /**
+     * Grants access to a specific member of a team.
+     *
+     * When the member is removed from the team, they will
+     * no longer have access.
+     *
+     * @param {string} id
+     * @returns {string}
+     */
     static member(id: string): string;
+    /**
+     * Grants access to a user with the specified label.
+     *
+     * @param {string} name
+     * @returns  {string}
+     */
+    static label(name: string): string;
 }

package/types/services/account.d.ts

@@ -4,7 +4,7 @@ import type { Models } from '../models';
 export declare class Account extends Service {
     constructor(client: Client);
     /**
-     * Get Account
+     * Get account
      *
      * Get the currently logged in user.
      *
@@ -13,14 +13,15 @@ export declare class Account extends Service {
     */
     get<Preferences extends Models.Preferences>(): Promise<Models.User<Preferences>>;
     /**
-     * Create Account
+     * Create account
      *
      * Use this endpoint to allow a new user to register a new account in your
      * project. After the user registration completes successfully, you can use
-     * the [/account/verfication](/docs/client/account#accountCreateVerification)
+     * the
+     * [/account/verfication](https://appwrite.io/docs/references/cloud/client-web/account#createVerification)
      * route to start verifying the user email address. To allow the new user to
      * login to their new account, you need to create a new [account
-     * session](/docs/client/account#accountCreateSession).
+     * session](https://appwrite.io/docs/references/cloud/client-web/account#createEmailSession).
      *
      * @param {string} userId
      * @param {string} email
@@ -31,7 +32,7 @@ export declare class Account extends Service {
     */
     create<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string): Promise<Models.User<Preferences>>;
     /**
-     * Update Email
+     * Update email
      *
      * Update currently logged in user account email address. After changing user
      * address, the user confirmation status will get reset. A new confirmation
@@ -68,25 +69,6 @@ export declare class Account extends Service {
      * @returns {Promise}
     */
     deleteIdentity(identityId: string): Promise<{}>;
-    /**
-     * Create account using an invite code
-     *
-     * Use this endpoint to allow a new user to register a new account in your
-     * project. After the user registration completes successfully, you can use
-     * the [/account/verfication](/docs/client/account#accountCreateVerification)
-     * route to start verifying the user email address. To allow the new user to
-     * login to their new account, you need to create a new [account
-     * session](/docs/client/account#accountCreateSession).
-     *
-     * @param {string} userId
-     * @param {string} email
-     * @param {string} password
-     * @param {string} name
-     * @param {string} code
-     * @throws {AppwriteException}
-     * @returns {Promise}
-    */
-    createWithInviteCode<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string, code?: string): Promise<Models.Account<Preferences>>;
     /**
      * Create JWT
      *
@@ -101,7 +83,7 @@ export declare class Account extends Service {
     */
     createJWT(): Promise<Models.Jwt>;
     /**
-     * List Logs
+     * List logs
      *
      * Get the list of latest security activity logs for the currently logged in
      * user. Each log returns user IP address, location and date and time of log.
@@ -112,7 +94,7 @@ export declare class Account extends Service {
     */
     listLogs(queries?: string[]): Promise<Models.LogList>;
     /**
-     * Update Name
+     * Update name
      *
      * Update currently logged in user account name.
      *
@@ -122,7 +104,7 @@ export declare class Account extends Service {
     */
     updateName<Preferences extends Models.Preferences>(name: string): Promise<Models.User<Preferences>>;
     /**
-     * Update Password
+     * Update password
      *
      * Update currently logged in user password. For validation, user is required
      * to pass in the new password, and the old password. For users created with
@@ -135,12 +117,12 @@ export declare class Account extends Service {
     */
     updatePassword<Preferences extends Models.Preferences>(password: string, oldPassword?: string): Promise<Models.User<Preferences>>;
     /**
-     * Update Phone
+     * Update phone
      *
      * Update the currently logged in user's phone number. After updating the
      * phone number, the phone verification status will be reset. A confirmation
      * SMS is not sent automatically, however you can use the [POST
-     * /account/verification/phone](/docs/client/account#accountCreatePhoneVerification)
+     * /account/verification/phone](https://appwrite.io/docs/references/cloud/client-web/account#createPhoneVerification)
      * endpoint to send a confirmation SMS.
      *
      * @param {string} phone
@@ -150,7 +132,7 @@ export declare class Account extends Service {
     */
     updatePhone<Preferences extends Models.Preferences>(phone: string, password: string): Promise<Models.User<Preferences>>;
     /**
-     * Get Account Preferences
+     * Get account preferences
      *
      * Get the preferences as a key-value object for the currently logged in user.
      *
@@ -159,7 +141,7 @@ export declare class Account extends Service {
     */
     getPrefs<Preferences extends Models.Preferences>(): Promise<Preferences>;
     /**
-     * Update Preferences
+     * Update preferences
      *
      * Update currently logged in user account preferences. The object you pass is
      * stored as is, and replaces any previous value. The maximum allowed prefs
@@ -171,16 +153,16 @@ export declare class Account extends Service {
     */
     updatePrefs<Preferences extends Models.Preferences>(prefs: Partial<Preferences>): Promise<Models.User<Preferences>>;
     /**
-     * Create Password Recovery
+     * Create password recovery
      *
      * Sends the user an email with a temporary secret key for password reset.
      * When the user clicks the confirmation link he is redirected back to your
      * app password reset URL with the secret key and email address values
      * attached to the URL query string. Use the query string params to submit a
      * request to the [PUT
-     * /account/recovery](/docs/client/account#accountUpdateRecovery) endpoint to
-     * complete the process. The verification link sent to the user's email
-     * address is valid for 1 hour.
+     * /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#updateRecovery)
+     * endpoint to complete the process. The verification link sent to the user's
+     * email address is valid for 1 hour.
      *
      * @param {string} email
      * @param {string} url
@@ -189,12 +171,13 @@ export declare class Account extends Service {
     */
     createRecovery(email: string, url: string): Promise<Models.Token>;
     /**
-     * Create Password Recovery (confirmation)
+     * Create password recovery (confirmation)
      *
      * Use this endpoint to complete the user account password reset. Both the
      * **userId** and **secret** arguments will be passed as query parameters to
      * the redirect URL you have provided when sending your request to the [POST
-     * /account/recovery](/docs/client/account#accountCreateRecovery) endpoint.
+     * /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#createRecovery)
+     * endpoint.
      *
      * Please note that in order to avoid a [Redirect
      * Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md)
@@ -210,7 +193,7 @@ export declare class Account extends Service {
     */
     updateRecovery(userId: string, secret: string, password: string, passwordAgain: string): Promise<Models.Token>;
     /**
-     * List Sessions
+     * List sessions
      *
      * Get the list of active sessions across different devices for the currently
      * logged in user.
@@ -220,7 +203,7 @@ export declare class Account extends Service {
     */
     listSessions(): Promise<Models.SessionList>;
     /**
-     * Delete Sessions
+     * Delete sessions
      *
      * Delete all sessions from the user account and remove any sessions cookies
      * from the end client.
@@ -230,27 +213,29 @@ export declare class Account extends Service {
     */
     deleteSessions(): Promise<{}>;
     /**
-     * Create Anonymous Session
+     * Create anonymous session
      *
      * Use this endpoint to allow a new user to register an anonymous account in
      * your project. This route will also create a new session for the user. To
      * allow the new user to convert an anonymous account to a normal account, you
      * need to update its [email and
-     * password](/docs/client/account#accountUpdateEmail) or create an [OAuth2
-     * session](/docs/client/account#accountCreateOAuth2Session).
+     * password](https://appwrite.io/docs/references/cloud/client-web/account#updateEmail)
+     * or create an [OAuth2
+     * session](https://appwrite.io/docs/references/cloud/client-web/account#CreateOAuth2Session).
      *
      * @throws {AppwriteException}
      * @returns {Promise}
     */
     createAnonymousSession(): Promise<Models.Session>;
     /**
-     * Create Email Session
+     * Create email session
      *
      * Allow the user to login into their account by providing a valid email and
      * password combination. This route will create a new session for the user.
      *
      * A user is limited to 10 active sessions at a time by default. [Learn more
-     * about session limits](/docs/authentication-security#limits).
+     * about session
+     * limits](https://appwrite.io/docs/authentication-security#limits).
      *
      * @param {string} email
      * @param {string} password
@@ -259,7 +244,7 @@ export declare class Account extends Service {
     */
     createEmailSession(email: string, password: string): Promise<Models.Session>;
     /**
-     * Create Magic URL session
+     * Create magic URL session
      *
      * Sends the user an email with a secret key for creating a session. If the
      * provided user ID has not been registered, a new user will be created. When
@@ -267,14 +252,15 @@ export declare class Account extends Service {
      * URL you provided with the secret key and userId values attached to the URL
      * query string. Use the query string parameters to submit a request to the
      * [PUT
-     * /account/sessions/magic-url](/docs/client/account#accountUpdateMagicURLSession)
+     * /account/sessions/magic-url](https://appwrite.io/docs/references/cloud/client-web/account#updateMagicURLSession)
      * endpoint to complete the login process. The link sent to the user's email
      * address is valid for 1 hour. If you are on a mobile device you can leave
      * the URL parameter empty, so that the login completion will be handled by
      * your Appwrite instance by default.
      *
      * A user is limited to 10 active sessions at a time by default. [Learn more
-     * about session limits](/docs/authentication-security#limits).
+     * about session
+     * limits](https://appwrite.io/docs/authentication-security#limits).
      *
      *
      * @param {string} userId
@@ -285,13 +271,13 @@ export declare class Account extends Service {
     */
     createMagicURLSession(userId: string, email: string, url?: string): Promise<Models.Token>;
     /**
-     * Create Magic URL session (confirmation)
+     * Create magic URL session (confirmation)
      *
      * Use this endpoint to complete creating the session with the Magic URL. Both
      * the **userId** and **secret** arguments will be passed as query parameters
      * to the redirect URL you have provided when sending your request to the
      * [POST
-     * /account/sessions/magic-url](/docs/client/account#accountCreateMagicURLSession)
+     * /account/sessions/magic-url](https://appwrite.io/docs/references/cloud/client-web/account#createMagicURLSession)
      * endpoint.
      *
      * Please note that in order to avoid a [Redirect
@@ -306,7 +292,7 @@ export declare class Account extends Service {
     */
     updateMagicURLSession(userId: string, secret: string): Promise<Models.Session>;
     /**
-     * Create OAuth2 Session
+     * Create OAuth2 session
      *
      * Allow the user to login to their account using the OAuth2 provider of their
      * choice. Each OAuth2 provider should be enabled from the Appwrite console
@@ -321,7 +307,8 @@ export declare class Account extends Service {
      * user.
      *
      * A user is limited to 10 active sessions at a time by default. [Learn more
-     * about session limits](/docs/authentication-security#limits).
+     * about session
+     * limits](https://appwrite.io/docs/authentication-security#limits).
      *
      *
      * @param {string} provider
@@ -333,17 +320,18 @@ export declare class Account extends Service {
     */
     createOAuth2Session(provider: string, success?: string, failure?: string, scopes?: string[]): void | URL;
     /**
-     * Create Phone session
+     * Create phone session
      *
      * Sends the user an SMS with a secret key for creating a session. If the
      * provided user ID has not be registered, a new user will be created. Use the
      * returned user ID and secret and submit a request to the [PUT
-     * /account/sessions/phone](/docs/client/account#accountUpdatePhoneSession)
+     * /account/sessions/phone](https://appwrite.io/docs/references/cloud/client-web/account#updatePhoneSession)
      * endpoint to complete the login process. The secret sent to the user's phone
      * is valid for 15 minutes.
      *
      * A user is limited to 10 active sessions at a time by default. [Learn more
-     * about session limits](/docs/authentication-security#limits).
+     * about session
+     * limits](https://appwrite.io/docs/authentication-security#limits).
      *
      * @param {string} userId
      * @param {string} phone
@@ -352,11 +340,11 @@ export declare class Account extends Service {
     */
     createPhoneSession(userId: string, phone: string): Promise<Models.Token>;
     /**
-     * Create Phone Session (confirmation)
+     * Create phone session (confirmation)
      *
      * Use this endpoint to complete creating a session with SMS. Use the
      * **userId** from the
-     * [createPhoneSession](/docs/client/account#accountCreatePhoneSession)
+     * [createPhoneSession](https://appwrite.io/docs/references/cloud/client-web/account#createPhoneSession)
      * endpoint and the **secret** received via SMS to successfully update and
      * confirm the phone session.
      *
@@ -367,7 +355,7 @@ export declare class Account extends Service {
     */
     updatePhoneSession(userId: string, secret: string): Promise<Models.Session>;
     /**
-     * Get Session
+     * Get session
      *
      * Use this endpoint to get a logged in user's session using a Session ID.
      * Inputting 'current' will return the current session being used.
@@ -378,7 +366,7 @@ export declare class Account extends Service {
     */
     getSession(sessionId: string): Promise<Models.Session>;
     /**
-     * Update OAuth Session (Refresh Tokens)
+     * Update OAuth session (refresh tokens)
      *
      * Access tokens have limited lifespan and expire to mitigate security risks.
      * If session was created using an OAuth provider, this route can be used to
@@ -390,12 +378,13 @@ export declare class Account extends Service {
     */
     updateSession(sessionId: string): Promise<Models.Session>;
     /**
-     * Delete Session
+     * Delete session
      *
      * Logout the user. Use 'current' as the session ID to logout on this device,
      * use a session ID to logout on another device. If you're looking to logout
      * the user on all devices, use [Delete
-     * Sessions](/docs/client/account#accountDeleteSessions) instead.
+     * Sessions](https://appwrite.io/docs/references/cloud/client-web/account#deleteSessions)
+     * instead.
      *
      * @param {string} sessionId
      * @throws {AppwriteException}
@@ -403,7 +392,7 @@ export declare class Account extends Service {
     */
     deleteSession(sessionId: string): Promise<{}>;
     /**
-     * Update Status
+     * Update status
      *
      * Block the currently logged in user account. Behind the scene, the user
      * record is not deleted but permanently blocked from any access. To
@@ -414,7 +403,7 @@ export declare class Account extends Service {
     */
     updateStatus<Preferences extends Models.Preferences>(): Promise<Models.User<Preferences>>;
     /**
-     * Create Email Verification
+     * Create email verification
      *
      * Use this endpoint to send a verification message to your user email address
      * to confirm they are the valid owners of that address. Both the **userId**
@@ -423,8 +412,8 @@ export declare class Account extends Service {
      * should redirect the user back to your app and allow you to complete the
      * verification process by verifying both the **userId** and **secret**
      * parameters. Learn more about how to [complete the verification
-     * process](/docs/client/account#accountUpdateEmailVerification). The
-     * verification link sent to the user's email address is valid for 7 days.
+     * process](https://appwrite.io/docs/references/cloud/client-web/account#updateVerification).
+     * The verification link sent to the user's email address is valid for 7 days.
      *
      * Please note that in order to avoid a [Redirect
      * Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md),
@@ -438,7 +427,7 @@ export declare class Account extends Service {
     */
     createVerification(url: string): Promise<Models.Token>;
     /**
-     * Create Email Verification (confirmation)
+     * Create email verification (confirmation)
      *
      * Use this endpoint to complete the user email verification process. Use both
      * the **userId** and **secret** parameters that were attached to your app URL
@@ -452,21 +441,23 @@ export declare class Account extends Service {
     */
     updateVerification(userId: string, secret: string): Promise<Models.Token>;
     /**
-     * Create Phone Verification
+     * Create phone verification
      *
      * Use this endpoint to send a verification SMS to the currently logged in
      * user. This endpoint is meant for use after updating a user's phone number
-     * using the [accountUpdatePhone](/docs/client/account#accountUpdatePhone)
+     * using the
+     * [accountUpdatePhone](https://appwrite.io/docs/references/cloud/client-web/account#updatePhone)
      * endpoint. Learn more about how to [complete the verification
-     * process](/docs/client/account#accountUpdatePhoneVerification). The
-     * verification code sent to the user's phone number is valid for 15 minutes.
+     * process](https://appwrite.io/docs/references/cloud/client-web/account#updatePhoneVerification).
+     * The verification code sent to the user's phone number is valid for 15
+     * minutes.
      *
      * @throws {AppwriteException}
      * @returns {Promise}
     */
     createPhoneVerification(): Promise<Models.Token>;
     /**
-     * Create Phone Verification (confirmation)
+     * Create phone verification (confirmation)
      *
      * Use this endpoint to complete the user phone verification process. Use the
      * **userId** and **secret** that were sent to your user's phone number to

package/types/services/avatars.d.ts

@@ -3,12 +3,13 @@ import { Client } from '../client';
 export declare class Avatars extends Service {
     constructor(client: Client);
     /**
-     * Get Browser Icon
+     * Get browser icon
      *
      * You can use this endpoint to show different browser icons to your users.
      * The code argument receives the browser code as it appears in your user [GET
-     * /account/sessions](/docs/client/account#accountGetSessions) endpoint. Use
-     * width, height and quality arguments to change the output settings.
+     * /account/sessions](https://appwrite.io/docs/references/cloud/client-web/account#getSessions)
+     * endpoint. Use width, height and quality arguments to change the output
+     * settings.
      *
      * When one dimension is specified and the other is 0, the image is scaled
      * with preserved aspect ratio. If both dimensions are 0, the API provides an
@@ -24,7 +25,7 @@ export declare class Avatars extends Service {
     */
     getBrowser(code: string, width?: number, height?: number, quality?: number): URL;
     /**
-     * Get Credit Card Icon
+     * Get credit card icon
      *
      * The credit card endpoint will return you the icon of the credit card
      * provider you need. Use width, height and quality arguments to change the
@@ -45,7 +46,7 @@ export declare class Avatars extends Service {
     */
     getCreditCard(code: string, width?: number, height?: number, quality?: number): URL;
     /**
-     * Get Favicon
+     * Get favicon
      *
      * Use this endpoint to fetch the favorite icon (AKA favicon) of any remote
      * website URL.
@@ -57,12 +58,12 @@ export declare class Avatars extends Service {
     */
     getFavicon(url: string): URL;
     /**
-     * Get Country Flag
+     * Get country flag
      *
      * You can use this endpoint to show different country flags icons to your
      * users. The code argument receives the 2 letter country code. Use width,
      * height and quality arguments to change the output settings. Country codes
-     * follow the [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) standard.
+     * follow the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard.
      *
      * When one dimension is specified and the other is 0, the image is scaled
      * with preserved aspect ratio. If both dimensions are 0, the API provides an
@@ -79,7 +80,7 @@ export declare class Avatars extends Service {
     */
     getFlag(code: string, width?: number, height?: number, quality?: number): URL;
     /**
-     * Get Image from URL
+     * Get image from URL
      *
      * Use this endpoint to fetch a remote image URL and crop it to any image size
      * you want. This endpoint is very useful if you need to crop and display
@@ -100,7 +101,7 @@ export declare class Avatars extends Service {
     */
     getImage(url: string, width?: number, height?: number): URL;
     /**
-     * Get User Initials
+     * Get user initials
      *
      * Use this endpoint to show your user initials avatar icon on your website or
      * app. By default, this route will try to print your logged-in user name or
@@ -128,7 +129,7 @@ export declare class Avatars extends Service {
     */
     getInitials(name?: string, width?: number, height?: number, background?: string): URL;
     /**
-     * Get QR Code
+     * Get QR code
      *
      * Converts a given plain text to a QR code image. You can use the query
      * parameters to change the size and style of the resulting image.

package/types/services/console.d.ts

@@ -4,7 +4,7 @@ import type { Models } from '../models';
 export declare class Console extends Service {
     constructor(client: Client);
     /**
-     * Get Variables
+     * Get variables
      *
      * Get all Environment Variables that are relevant for the console.
      *