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

package/types/services/account.d.ts

@@ -1,8 +1,8 @@
 import { Service } from '../service';
 import { Client } from '../client';
 import type { Models } from '../models';
-import { AuthenticatorProvider } from '../enums/authenticator-provider';
-import { AuthenticatorFactor } from '../enums/authenticator-factor';
+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);
@@ -108,6 +108,7 @@ export declare class Account extends Service {
     /**
      * Update MFA
      *
+     * Enable or disable MFA on an account.
      *
      * @param {boolean} mfa
      * @throws {AppwriteException}
@@ -115,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 {AuthenticatorProvider} provider
+     * @param {AuthenticationFactor} factor
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createChallenge(provider: AuthenticatorProvider): 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 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}
     */
-    listFactors(): 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 {AuthenticatorFactor} factor
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    addAuthenticator(factor: AuthenticatorFactor): 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 {AuthenticatorFactor} factor
-     * @param {string} otp
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    verifyAuthenticator<Preferences extends Models.Preferences>(factor: AuthenticatorFactor, 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 {AuthenticatorProvider} provider
-     * @param {string} otp
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    deleteAuthenticator<Preferences extends Models.Preferences>(provider: AuthenticatorProvider, otp: string): Promise<Models.User<Preferences>>;
+    updateMfaRecoveryCodes(): Promise<Models.MfaRecoveryCodes>;
     /**
      * Update name
      *
@@ -321,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
@@ -356,12 +410,24 @@ export declare class Account extends Service {
      * @param {OAuthProvider} provider
      * @param {string} success
      * @param {string} failure
-     * @param {boolean} token
      * @param {string[]} scopes
      * @throws {AppwriteException}
      * @returns {void|string}
     */
-    createOAuth2Session(provider: OAuthProvider, 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
      *
@@ -387,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}
@@ -423,7 +490,7 @@ export declare class Account extends Service {
     */
     updateStatus<Preferences extends Models.Preferences>(): Promise<Models.User<Preferences>>;
     /**
-     * Create a push target
+     * Create push target
      *
      *
      * @param {string} targetId
@@ -434,7 +501,7 @@ export declare class Account extends Service {
     */
     createPushTarget(targetId: string, identifier: string, providerId?: string): Promise<Models.Target>;
     /**
-     * Update a push target
+     * Update push target
      *
      *
      * @param {string} targetId
@@ -444,7 +511,7 @@ export declare class Account extends Service {
     */
     updatePushTarget(targetId: string, identifier: string): Promise<Models.Target>;
     /**
-     * Delete a push target
+     * Delete push target
      *
      *
      * @param {string} targetId
@@ -501,6 +568,32 @@ export declare class Account extends Service {
      * @returns {Promise}
     */
     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/databases.d.ts

@@ -33,7 +33,7 @@ export declare class Databases extends Service {
     */
     create(databaseId: string, name: string, enabled?: boolean): Promise<Models.Database>;
     /**
-     * Get usage stats for the database
+     * Get databases usage stats
      *
      *
      * @param {DatabaseUsageRange} range
@@ -148,6 +148,7 @@ export declare class Databases extends Service {
     /**
      * List attributes
      *
+     * List attributes in the collection.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -175,6 +176,8 @@ export declare class Databases extends Service {
     /**
      * Update boolean attribute
      *
+     * Update a boolean attribute. Changing the `default` value will not update
+     * already existing documents.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -188,6 +191,7 @@ export declare class Databases extends Service {
     /**
      * Create datetime attribute
      *
+     * Create a date time attribute according to the ISO 8601 standard.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -202,6 +206,8 @@ export declare class Databases extends Service {
     /**
      * Update dateTime attribute
      *
+     * Update a date time attribute. Changing the `default` value will not update
+     * already existing documents.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -247,6 +253,9 @@ export declare class Databases extends Service {
     /**
      * Create enum attribute
      *
+     * Create an enumeration attribute. The `elements` param acts as a white-list
+     * of accepted values for this attribute.
+     *
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -470,6 +479,7 @@ export declare class Databases extends Service {
     /**
      * Get attribute
      *
+     * Get attribute by ID.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -481,6 +491,7 @@ export declare class Databases extends Service {
     /**
      * Delete attribute
      *
+     * Deletes an attribute.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -591,6 +602,7 @@ export declare class Databases extends Service {
     /**
      * List indexes
      *
+     * List indexes in the collection.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -602,6 +614,9 @@ export declare class Databases extends Service {
     /**
      * Create index
      *
+     * Creates an index on the attributes listed. Your index should include all
+     * the attributes you will query in a single request.
+     * Attributes can be `key`, `fulltext`, and `unique`.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -616,6 +631,7 @@ export declare class Databases extends Service {
     /**
      * Get index
      *
+     * Get index by ID.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -627,6 +643,7 @@ export declare class Databases extends Service {
     /**
      * Delete index
      *
+     * Delete an index.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -648,7 +665,7 @@ export declare class Databases extends Service {
     */
     listCollectionLogs(databaseId: string, collectionId: string, queries?: string[]): Promise<Models.LogList>;
     /**
-     * Get usage stats for a collection
+     * Get collection usage stats
      *
      *
      * @param {string} databaseId
@@ -670,7 +687,7 @@ export declare class Databases extends Service {
     */
     listLogs(databaseId: string, queries?: string[]): Promise<Models.LogList>;
     /**
-     * Get usage stats for the database
+     * Get database usage stats
      *
      *
      * @param {string} databaseId

package/types/services/health.d.ts

@@ -1,6 +1,7 @@
 import { Service } from '../service';
 import { Client } from '../client';
 import type { Models } from '../models';
+import { Name } from '../enums/name';
 export declare class Health extends Service {
     constructor(client: Client);
     /**
@@ -31,6 +32,16 @@ export declare class Health extends Service {
      * @returns {Promise}
     */
     getCache(): Promise<Models.HealthStatus>;
+    /**
+     * Get the SSL certificate for a domain
+     *
+     * Get the SSL certificate for a domain
+     *
+     * @param {string} domain
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getCertificate(domain?: string): Promise<Models.HealthCertificate>;
     /**
      * Get DB
      *
@@ -105,9 +116,23 @@ export declare class Health extends Service {
      * @returns {Promise}
     */
     getQueueDeletes(threshold?: number): Promise<Models.HealthQueue>;
+    /**
+     * Get number of failed queue jobs
+     *
+     * Returns the amount of failed jobs in a given queue.
+     *
+     *
+     * @param {Name} name
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getFailedJobs(name: Name, threshold?: number): Promise<Models.HealthQueue>;
     /**
      * Get functions queue
      *
+     * Get the number of function executions that are waiting to be processed in
+     * the Appwrite internal queue server.
      *
      * @param {number} threshold
      * @throws {AppwriteException}
@@ -158,6 +183,28 @@ export declare class Health extends Service {
      * @returns {Promise}
     */
     getQueueMigrations(threshold?: number): Promise<Models.HealthQueue>;
+    /**
+     * Get usage queue
+     *
+     * Get the number of metrics that are waiting to be processed in the Appwrite
+     * internal queue server.
+     *
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getQueueUsage(threshold?: number): Promise<Models.HealthQueue>;
+    /**
+     * Get usage dump queue
+     *
+     * Get the number of projects containing metrics that are waiting to be
+     * processed in the Appwrite internal queue server.
+     *
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getQueueUsageDump(threshold?: number): Promise<Models.HealthQueue>;
     /**
      * Get webhooks queue
      *
@@ -169,6 +216,15 @@ export declare class Health extends Service {
      * @returns {Promise}
     */
     getQueueWebhooks(threshold?: number): Promise<Models.HealthQueue>;
+    /**
+     * Get storage
+     *
+     * Check the Appwrite storage device is up and connection is successful.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getStorage(): Promise<Models.HealthStatus>;
     /**
      * Get local storage
      *