@appwrite.io/console 0.6.0-rc.8 → 0.6.0

package/types/models.d.ts

@@ -1186,10 +1186,6 @@ export declare namespace Models {
          * Multi factor authentication status.
          */
         mfa: boolean;
-        /**
-         * TOTP status.
-         */
-        totp: boolean;
         /**
          * User preferences as a key-value object
          */
@@ -1417,13 +1413,17 @@ export declare namespace Models {
          */
         current: boolean;
         /**
-         * Returns true if this the current user session.
+         * Returns a list of active session factors.
          */
-        factors: number;
+        factors: string[];
         /**
          * Secret used to authenticate the user. Only included if the request was made with an API key
          */
         secret: string;
+        /**
+         * Most recent date in ISO 8601 format when the session successfully passed MFA challenge.
+         */
+        mfaUpdatedAt: string;
     };
     /**
      * Identity
@@ -1497,7 +1497,7 @@ export declare namespace Models {
         /**
          * Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email.
          */
-        securityPhrase: string;
+        phrase: string;
     };
     /**
      * JWT
@@ -2656,6 +2656,35 @@ export declare namespace Models {
          */
         status: string;
     };
+    /**
+     * Health Certificate
+     */
+    type HealthCertificate = {
+        /**
+         * Certificate name
+         */
+        name: string;
+        /**
+         * Subject SN
+         */
+        subjectSN: string;
+        /**
+         * Issuer organisation
+         */
+        issuerOrganisation: string;
+        /**
+         * Valid from
+         */
+        validFrom: string;
+        /**
+         * Valid to
+         */
+        validTo: string;
+        /**
+         * Signature type SN
+         */
+        signatureTypeSN: string;
+    };
     /**
      * Health Time
      */
@@ -3211,26 +3240,31 @@ export declare namespace Models {
         expire: string;
     };
     /**
-     * MFAProvider
+     * MFA Recovery Codes
      */
-    type MfaProvider = {
+    type MfaRecoveryCodes = {
         /**
-         * backup codes
+         * Recovery codes.
          */
-        backups: string[];
+        recoveryCodes: string[];
+    };
+    /**
+     * MFAType
+     */
+    type MfaType = {
         /**
-         * secret used for top auth
+         * Secret token used for TOTP factor.
          */
         secret: string;
         /**
-         * uri for otp app
+         * URI for authenticator apps.
          */
         uri: string;
     };
     /**
-     * MFAProviders
+     * MFAFactors
      */
-    type MfaProviders = {
+    type MfaFactors = {
         /**
          * TOTP
          */
@@ -3341,10 +3375,6 @@ export declare namespace Models {
          * Status of delivery.
          */
         status: string;
-        /**
-         * Message description.
-         */
-        description?: string;
     };
     /**
      * Topic
@@ -3367,13 +3397,21 @@ export declare namespace Models {
          */
         name: string;
         /**
-         * Total count of subscribers subscribed to topic.
+         * Total count of email subscribers subscribed to the topic.
          */
-        total: number;
+        emailTotal: number;
+        /**
+         * Total count of SMS subscribers subscribed to the topic.
+         */
+        smsTotal: number;
+        /**
+         * Total count of push subscribers subscribed to the topic.
+         */
+        pushTotal: number;
         /**
-         * Description of the topic.
+         * Subscribe permissions.
          */
-        description?: string;
+        subscribe: string[];
     };
     /**
      * Subscriber

package/types/query.d.ts

@@ -1,7 +1,13 @@
 declare type QueryTypesSingle = string | number | boolean;
-export declare type QueryTypesList = string[] | number[] | boolean[];
+export declare type QueryTypesList = string[] | number[] | boolean[] | Query[];
 export declare type QueryTypes = QueryTypesSingle | QueryTypesList;
+declare type AttributesTypes = string | string[];
 export declare class Query {
+    method: string;
+    attribute: AttributesTypes | undefined;
+    values: QueryTypesList | undefined;
+    constructor(method: string, attribute?: AttributesTypes, values?: QueryTypes);
+    toString(): string;
     static equal: (attribute: string, value: QueryTypes) => string;
     static notEqual: (attribute: string, value: QueryTypes) => string;
     static lessThan: (attribute: string, value: QueryTypes) => string;
@@ -21,7 +27,8 @@ export declare class Query {
     static cursorBefore: (documentId: string) => string;
     static limit: (limit: number) => string;
     static offset: (offset: number) => string;
-    private static addQuery;
-    private static parseValues;
+    static contains: (attribute: string, value: string | string[]) => string;
+    static or: (queries: string[]) => string;
+    static and: (queries: string[]) => string;
 }
 export {};

package/types/services/account.d.ts

@@ -1,6 +1,9 @@
 import { Service } from '../service';
 import { Client } from '../client';
 import type { Models } from '../models';
+import { AuthenticatorType } from '../enums/authenticator-type';
+import { AuthenticationFactor } from '../enums/authentication-factor';
+import { OAuthProvider } from '../enums/o-auth-provider';
 export declare class Account extends Service {
     constructor(client: Client);
     /**
@@ -63,11 +66,11 @@ export declare class Account extends Service {
      *
      * Get the list of identities for the currently logged in user.
      *
-     * @param {string} queries
+     * @param {string[]} queries
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    listIdentities(queries?: string): Promise<Models.IdentityList>;
+    listIdentities(queries?: string[]): Promise<Models.IdentityList>;
     /**
      * Delete identity
      *
@@ -105,6 +108,7 @@ export declare class Account extends Service {
     /**
      * Update MFA
      *
+     * Enable or disable MFA on an account.
      *
      * @param {boolean} mfa
      * @throws {AppwriteException}
@@ -112,62 +116,115 @@ export declare class Account extends Service {
     */
     updateMFA<Preferences extends Models.Preferences>(mfa: boolean): Promise<Models.User<Preferences>>;
     /**
-     * Create MFA Challenge
+     * Add Authenticator
+     *
+     * Add an authenticator app to be used as an MFA factor. Verify the
+     * authenticator using the [verify
+     * authenticator](/docs/references/cloud/client-web/account#verifyAuthenticator)
+     * method.
+     *
+     * @param {AuthenticatorType} type
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createMfaAuthenticator(type: AuthenticatorType): Promise<Models.MfaType>;
+    /**
+     * Verify Authenticator
+     *
+     * Verify an authenticator app after adding it using the [add
+     * authenticator](/docs/references/cloud/client-web/account#addAuthenticator)
+     * method.
+     *
+     * @param {AuthenticatorType} type
+     * @param {string} otp
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updateMfaAuthenticator<Preferences extends Models.Preferences>(type: AuthenticatorType, otp: string): Promise<Models.User<Preferences>>;
+    /**
+     * Delete Authenticator
+     *
+     * Delete an authenticator for a user by ID.
+     *
+     * @param {AuthenticatorType} type
+     * @param {string} otp
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    deleteMfaAuthenticator<Preferences extends Models.Preferences>(type: AuthenticatorType, otp: string): Promise<Models.User<Preferences>>;
+    /**
+     * Create 2FA Challenge
      *
+     * Begin the process of MFA verification after sign-in. Finish the flow with
+     * [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge)
+     * method.
      *
-     * @param {string} provider
+     * @param {AuthenticationFactor} factor
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createChallenge(provider: string): Promise<Models.MfaChallenge>;
+    createMfaChallenge(factor: AuthenticationFactor): Promise<Models.MfaChallenge>;
     /**
      * Create MFA Challenge (confirmation)
      *
+     * Complete the MFA challenge by providing the one-time password. Finish the
+     * process of MFA verification by providing the one-time password. To begin
+     * the flow, use
+     * [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge)
+     * method.
      *
      * @param {string} challengeId
      * @param {string} otp
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateChallenge(challengeId: string, otp: string): Promise<{}>;
+    updateMfaChallenge(challengeId: string, otp: string): Promise<{}>;
     /**
-     * List Providers
+     * List Factors
      *
-     * Get the currently logged in user.
+     * List the factors available on the account to be used as a MFA challange.
      *
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    listProviders(): Promise<Models.MfaProviders>;
+    listMfaFactors(): Promise<Models.MfaFactors>;
     /**
-     * Add Authenticator
+     * Get MFA Recovery Codes
      *
+     * Get recovery codes that can be used as backup for MFA flow. Before getting
+     * codes, they must be generated using
+     * [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes)
+     * method. An OTP challenge is required to read recovery codes.
      *
-     * @param {string} provider
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    addAuthenticator(provider: string): Promise<Models.MfaProvider>;
+    getMfaRecoveryCodes(): Promise<Models.MfaRecoveryCodes>;
     /**
-     * Verify Authenticator
+     * Create MFA Recovery Codes
      *
+     * Generate recovery codes as backup for MFA flow. It's recommended to
+     * generate and show then immediately after user successfully adds their
+     * authehticator. Recovery codes can be used as a MFA verification type in
+     * [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge)
+     * method.
      *
-     * @param {string} provider
-     * @param {string} otp
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    verifyAuthenticator<Preferences extends Models.Preferences>(provider: string, otp: string): Promise<Models.User<Preferences>>;
+    createMfaRecoveryCodes(): Promise<Models.MfaRecoveryCodes>;
     /**
-     * Delete Authenticator
+     * Regenerate MFA Recovery Codes
      *
+     * Regenerate recovery codes that can be used as backup for MFA flow. Before
+     * regenerating codes, they must be first generated using
+     * [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes)
+     * method. An OTP challenge is required to regenreate recovery codes.
      *
-     * @param {string} provider
-     * @param {string} otp
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    deleteAuthenticator<Preferences extends Models.Preferences>(provider: string, otp: string): Promise<Models.User<Preferences>>;
+    updateMfaRecoveryCodes(): Promise<Models.MfaRecoveryCodes>;
     /**
      * Update name
      *
@@ -318,7 +375,7 @@ export declare class Account extends Service {
     */
     createEmailPasswordSession(email: string, password: string): Promise<Models.Session>;
     /**
-     * Create session (deprecated)
+     * Update magic URL session
      *
      * Use this endpoint to create a session from token. Provide the **userId**
      * and **secret** parameters from the successful response of authentication
@@ -350,15 +407,27 @@ export declare class Account extends Service {
      * limits](https://appwrite.io/docs/authentication-security#limits).
      *
      *
-     * @param {string} provider
+     * @param {OAuthProvider} provider
      * @param {string} success
      * @param {string} failure
-     * @param {boolean} token
      * @param {string[]} scopes
      * @throws {AppwriteException}
      * @returns {void|string}
     */
-    createOAuth2Session(provider: string, success?: string, failure?: string, token?: boolean, scopes?: string[]): void | URL;
+    createOAuth2Session(provider: OAuthProvider, success?: string, failure?: string, scopes?: string[]): void | URL;
+    /**
+     * Update phone session
+     *
+     * Use this endpoint to create a session from token. Provide the **userId**
+     * and **secret** parameters from the successful response of authentication
+     * flows initiated by token creation. For example, magic URL and phone login.
+     *
+     * @param {string} userId
+     * @param {string} secret
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updatePhoneSession(userId: string, secret: string): Promise<Models.Session>;
     /**
      * Create session
      *
@@ -384,10 +453,11 @@ export declare class Account extends Service {
     */
     getSession(sessionId: string): Promise<Models.Session>;
     /**
-     * Update (or renew) a session
+     * Update session
      *
-     * Extend session's expiry to increase it's lifespan. Extending a session is
-     * useful when session length is short such as 5 minutes.
+     * Use this endpoint to extend a session's length. Extending a session is
+     * useful when session expiry is short. If the session was created using an
+     * OAuth provider, this endpoint refreshes the access token from the provider.
      *
      * @param {string} sessionId
      * @throws {AppwriteException}
@@ -420,7 +490,7 @@ export declare class Account extends Service {
     */
     updateStatus<Preferences extends Models.Preferences>(): Promise<Models.User<Preferences>>;
     /**
-     * Create Account&#039;s push target
+     * Create push target
      *
      *
      * @param {string} targetId
@@ -431,7 +501,7 @@ export declare class Account extends Service {
     */
     createPushTarget(targetId: string, identifier: string, providerId?: string): Promise<Models.Target>;
     /**
-     * Update Account&#039;s push target
+     * Update push target
      *
      *
      * @param {string} targetId
@@ -440,6 +510,15 @@ export declare class Account extends Service {
      * @returns {Promise}
     */
     updatePushTarget(targetId: string, identifier: string): Promise<Models.Target>;
+    /**
+     * Delete push target
+     *
+     *
+     * @param {string} targetId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    deletePushTarget(targetId: string): Promise<{}>;
     /**
      * Create email token (OTP)
      *
@@ -456,11 +535,11 @@ export declare class Account extends Service {
      *
      * @param {string} userId
      * @param {string} email
-     * @param {boolean} securityPhrase
+     * @param {boolean} phrase
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createEmailToken(userId: string, email: string, securityPhrase?: boolean): Promise<Models.Token>;
+    createEmailToken(userId: string, email: string, phrase?: boolean): Promise<Models.Token>;
     /**
      * Create magic URL token
      *
@@ -484,11 +563,37 @@ export declare class Account extends Service {
      * @param {string} userId
      * @param {string} email
      * @param {string} url
-     * @param {boolean} securityPhrase
+     * @param {boolean} phrase
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createMagicURLToken(userId: string, email: string, url?: string, securityPhrase?: boolean): Promise<Models.Token>;
+    createMagicURLToken(userId: string, email: string, url?: string, phrase?: boolean): Promise<Models.Token>;
+    /**
+     * Create OAuth2 token
+     *
+     * 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
+     * first. Use the success and failure arguments to provide a redirect URL's
+     * back to your app when login is completed.
+     *
+     * If authentication succeeds, `userId` and `secret` of a token will be
+     * appended to the success URL as query parameters. These can be used to
+     * create a new session using the [Create
+     * session](https://appwrite.io/docs/references/cloud/client-web/account#createSession)
+     * endpoint.
+     *
+     * A user is limited to 10 active sessions at a time by default. [Learn more
+     * about session
+     * limits](https://appwrite.io/docs/authentication-security#limits).
+     *
+     * @param {OAuthProvider} provider
+     * @param {string} success
+     * @param {string} failure
+     * @param {string[]} scopes
+     * @throws {AppwriteException}
+     * @returns {void|string}
+    */
+    createOAuth2Token(provider: OAuthProvider, success?: string, failure?: string, scopes?: string[]): void | URL;
     /**
      * Create phone token
      *

package/types/services/avatars.d.ts

@@ -1,5 +1,8 @@
 import { Service } from '../service';
 import { Client } from '../client';
+import { Browser } from '../enums/browser';
+import { CreditCard } from '../enums/credit-card';
+import { Flag } from '../enums/flag';
 export declare class Avatars extends Service {
     constructor(client: Client);
     /**
@@ -16,14 +19,14 @@ export declare class Avatars extends Service {
      * image at source quality. If dimensions are not specified, the default size
      * of image returned is 100x100px.
      *
-     * @param {string} code
+     * @param {Browser} code
      * @param {number} width
      * @param {number} height
      * @param {number} quality
      * @throws {AppwriteException}
      * @returns {URL}
     */
-    getBrowser(code: string, width?: number, height?: number, quality?: number): URL;
+    getBrowser(code: Browser, width?: number, height?: number, quality?: number): URL;
     /**
      * Get credit card icon
      *
@@ -37,14 +40,14 @@ export declare class Avatars extends Service {
      * of image returned is 100x100px.
      *
      *
-     * @param {string} code
+     * @param {CreditCard} code
      * @param {number} width
      * @param {number} height
      * @param {number} quality
      * @throws {AppwriteException}
      * @returns {URL}
     */
-    getCreditCard(code: string, width?: number, height?: number, quality?: number): URL;
+    getCreditCard(code: CreditCard, width?: number, height?: number, quality?: number): URL;
     /**
      * Get favicon
      *
@@ -71,14 +74,14 @@ export declare class Avatars extends Service {
      * of image returned is 100x100px.
      *
      *
-     * @param {string} code
+     * @param {Flag} code
      * @param {number} width
      * @param {number} height
      * @param {number} quality
      * @throws {AppwriteException}
      * @returns {URL}
     */
-    getFlag(code: string, width?: number, height?: number, quality?: number): URL;
+    getFlag(code: Flag, width?: number, height?: number, quality?: number): URL;
     /**
      * Get image from URL
      *