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

package/src/services/account.ts

@@ -2,9 +2,8 @@ import { Service } from '../service';
 import { AppwriteException, Client } from '../client';
 import type { Models } from '../models';
 import type { UploadProgress, Payload } from '../client';
-import { Query } from '../query';
-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 class Account extends Service {
@@ -244,6 +243,7 @@ export class Account extends Service {
     /**
      * Update MFA
      *
+     * Enable or disable MFA on an account.
      *
      * @param {boolean} mfa
      * @throws {AppwriteException}
@@ -268,25 +268,25 @@ export class Account extends Service {
     }
 
     /**
-     * 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 {AuthenticatorProvider} provider
+     * @param {AuthenticatorType} type
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async createChallenge(provider: AuthenticatorProvider): Promise<Models.MfaChallenge> {
-        if (typeof provider === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "provider"');
+    async createMfaAuthenticator(type: AuthenticatorType): Promise<Models.MfaType> {
+        if (typeof type === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "type"');
         }
 
-        const apiPath = '/account/mfa/challenge';
+        const apiPath = '/account/mfa/authenticators/{type}'.replace('{type}', type);
         const payload: Payload = {};
 
-        if (typeof provider !== 'undefined') {
-            payload['provider'] = provider;
-        }
-
         const uri = new URL(this.client.config.endpoint + apiPath);
         return await this.client.call('post', uri, {
             'content-type': 'application/json',
@@ -294,30 +294,29 @@ export class Account extends Service {
     }
 
     /**
-     * Create MFA Challenge (confirmation)
+     * Verify Authenticator
      *
+     * Verify an authenticator app after adding it using the [add
+     * authenticator](/docs/references/cloud/client-web/account#addAuthenticator)
+     * method.
      *
-     * @param {string} challengeId
+     * @param {AuthenticatorType} type
      * @param {string} otp
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async updateChallenge(challengeId: string, otp: string): Promise<{}> {
-        if (typeof challengeId === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "challengeId"');
+    async updateMfaAuthenticator<Preferences extends Models.Preferences>(type: AuthenticatorType, otp: string): Promise<Models.User<Preferences>> {
+        if (typeof type === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "type"');
         }
 
         if (typeof otp === 'undefined') {
             throw new AppwriteException('Missing required parameter: "otp"');
         }
 
-        const apiPath = '/account/mfa/challenge';
+        const apiPath = '/account/mfa/authenticators/{type}'.replace('{type}', type);
         const payload: Payload = {};
 
-        if (typeof challengeId !== 'undefined') {
-            payload['challengeId'] = challengeId;
-        }
-
         if (typeof otp !== 'undefined') {
             payload['otp'] = otp;
         }
@@ -329,39 +328,60 @@ export class Account extends Service {
     }
 
     /**
-     * List Factors
+     * Delete Authenticator
      *
-     * Get the currently logged in user.
+     * Delete an authenticator for a user by ID.
      *
+     * @param {AuthenticatorType} type
+     * @param {string} otp
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async listFactors(): Promise<Models.MfaProviders> {
-        const apiPath = '/account/mfa/factors';
+    async deleteMfaAuthenticator<Preferences extends Models.Preferences>(type: AuthenticatorType, otp: string): Promise<Models.User<Preferences>> {
+        if (typeof type === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "type"');
+        }
+
+        if (typeof otp === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "otp"');
+        }
+
+        const apiPath = '/account/mfa/authenticators/{type}'.replace('{type}', type);
         const payload: Payload = {};
 
+        if (typeof otp !== 'undefined') {
+            payload['otp'] = otp;
+        }
+
         const uri = new URL(this.client.config.endpoint + apiPath);
-        return await this.client.call('get', uri, {
+        return await this.client.call('delete', uri, {
             'content-type': 'application/json',
         }, payload);
     }
 
     /**
-     * Add Authenticator
+     * 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 {AuthenticatorFactor} factor
+     * @param {AuthenticationFactor} factor
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async addAuthenticator(factor: AuthenticatorFactor): Promise<Models.MfaProvider> {
+    async createMfaChallenge(factor: AuthenticationFactor): Promise<Models.MfaChallenge> {
         if (typeof factor === 'undefined') {
             throw new AppwriteException('Missing required parameter: "factor"');
         }
 
-        const apiPath = '/account/mfa/{factor}'.replace('{factor}', factor);
+        const apiPath = '/account/mfa/challenge';
         const payload: Payload = {};
 
+        if (typeof factor !== 'undefined') {
+            payload['factor'] = factor;
+        }
+
         const uri = new URL(this.client.config.endpoint + apiPath);
         return await this.client.call('post', uri, {
             'content-type': 'application/json',
@@ -369,26 +389,35 @@ export class Account extends Service {
     }
 
     /**
-     * Verify Authenticator
+     * 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 {AuthenticatorFactor} factor
+     * @param {string} challengeId
      * @param {string} otp
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async verifyAuthenticator<Preferences extends Models.Preferences>(factor: AuthenticatorFactor, otp: string): Promise<Models.User<Preferences>> {
-        if (typeof factor === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "factor"');
+    async updateMfaChallenge(challengeId: string, otp: string): Promise<{}> {
+        if (typeof challengeId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "challengeId"');
         }
 
         if (typeof otp === 'undefined') {
             throw new AppwriteException('Missing required parameter: "otp"');
         }
 
-        const apiPath = '/account/mfa/{factor}'.replace('{factor}', factor);
+        const apiPath = '/account/mfa/challenge';
         const payload: Payload = {};
 
+        if (typeof challengeId !== 'undefined') {
+            payload['challengeId'] = challengeId;
+        }
+
         if (typeof otp !== 'undefined') {
             payload['otp'] = otp;
         }
@@ -400,32 +429,83 @@ export class Account extends Service {
     }
 
     /**
-     * Delete Authenticator
+     * List Factors
      *
+     * List the factors available on the account to be used as a MFA challange.
      *
-     * @param {AuthenticatorProvider} provider
-     * @param {string} otp
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async deleteAuthenticator<Preferences extends Models.Preferences>(provider: AuthenticatorProvider, otp: string): Promise<Models.User<Preferences>> {
-        if (typeof provider === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "provider"');
-        }
+    async listMfaFactors(): Promise<Models.MfaFactors> {
+        const apiPath = '/account/mfa/factors';
+        const payload: Payload = {};
 
-        if (typeof otp === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "otp"');
-        }
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        return await this.client.call('get', uri, {
+            'content-type': 'application/json',
+        }, payload);
+    }
 
-        const apiPath = '/account/mfa/{provider}'.replace('{provider}', provider);
+    /**
+     * 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.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    async getMfaRecoveryCodes(): Promise<Models.MfaRecoveryCodes> {
+        const apiPath = '/account/mfa/recovery-codes';
         const payload: Payload = {};
 
-        if (typeof otp !== 'undefined') {
-            payload['otp'] = otp;
-        }
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        return await this.client.call('get', uri, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * 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.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    async createMfaRecoveryCodes(): Promise<Models.MfaRecoveryCodes> {
+        const apiPath = '/account/mfa/recovery-codes';
+        const payload: Payload = {};
 
         const uri = new URL(this.client.config.endpoint + apiPath);
-        return await this.client.call('delete', uri, {
+        return await this.client.call('post', uri, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * 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.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    async updateMfaRecoveryCodes(): Promise<Models.MfaRecoveryCodes> {
+        const apiPath = '/account/mfa/recovery-codes';
+        const payload: Payload = {};
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        return await this.client.call('patch', uri, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -779,7 +859,7 @@ export class Account extends Service {
     }
 
     /**
-     * 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
@@ -839,12 +919,11 @@ export 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 {
         if (typeof provider === 'undefined') {
             throw new AppwriteException('Missing required parameter: "provider"');
         }
@@ -860,10 +939,6 @@ export class Account extends Service {
             payload['failure'] = failure;
         }
 
-        if (typeof token !== 'undefined') {
-            payload['token'] = token;
-        }
-
         if (typeof scopes !== 'undefined') {
             payload['scopes'] = scopes;
         }
@@ -882,6 +957,44 @@ export class Account extends Service {
         }
     }
 
+    /**
+     * 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}
+    */
+    async updatePhoneSession(userId: string, secret: string): Promise<Models.Session> {
+        if (typeof userId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "userId"');
+        }
+
+        if (typeof secret === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "secret"');
+        }
+
+        const apiPath = '/account/sessions/phone';
+        const payload: Payload = {};
+
+        if (typeof userId !== 'undefined') {
+            payload['userId'] = userId;
+        }
+
+        if (typeof secret !== 'undefined') {
+            payload['secret'] = secret;
+        }
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        return await this.client.call('put', uri, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
     /**
      * Create session
      *
@@ -945,10 +1058,11 @@ export class Account extends Service {
     }
 
     /**
-     * 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}
@@ -1016,7 +1130,7 @@ export class Account extends Service {
     }
 
     /**
-     * Create a push target
+     * Create push target
      *
      *
      * @param {string} targetId
@@ -1056,7 +1170,7 @@ export class Account extends Service {
     }
 
     /**
-     * Update a push target
+     * Update push target
      *
      *
      * @param {string} targetId
@@ -1087,7 +1201,7 @@ export class Account extends Service {
     }
 
     /**
-     * Delete a push target
+     * Delete push target
      *
      *
      * @param {string} targetId
@@ -1219,6 +1333,65 @@ export class Account extends Service {
         }, payload);
     }
 
+    /**
+     * 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 {
+        if (typeof provider === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "provider"');
+        }
+
+        const apiPath = '/account/tokens/oauth2/{provider}'.replace('{provider}', provider);
+        const payload: Payload = {};
+
+        if (typeof success !== 'undefined') {
+            payload['success'] = success;
+        }
+
+        if (typeof failure !== 'undefined') {
+            payload['failure'] = failure;
+        }
+
+        if (typeof scopes !== 'undefined') {
+            payload['scopes'] = scopes;
+        }
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        payload['project'] = this.client.config.project;
+
+
+        for (const [key, value] of Object.entries(Service.flatten(payload))) {
+            uri.searchParams.append(key, value);
+        }
+        if (typeof window !== 'undefined' && window?.location) {
+            window.location.href = uri.toString();
+        } else {
+            return uri;
+        }
+    }
+
     /**
      * Create phone token
      *

package/src/services/assistant.ts

@@ -2,7 +2,6 @@ import { Service } from '../service';
 import { AppwriteException, Client } from '../client';
 import type { Models } from '../models';
 import type { UploadProgress, Payload } from '../client';
-import { Query } from '../query';
 
 export class Assistant extends Service {
 

package/src/services/avatars.ts

@@ -2,7 +2,6 @@ import { Service } from '../service';
 import { AppwriteException, Client } from '../client';
 import type { Models } from '../models';
 import type { UploadProgress, Payload } from '../client';
-import { Query } from '../query';
 import { Browser } from '../enums/browser';
 import { CreditCard } from '../enums/credit-card';
 import { Flag } from '../enums/flag';

package/src/services/console.ts

@@ -2,7 +2,6 @@ import { Service } from '../service';
 import { AppwriteException, Client } from '../client';
 import type { Models } from '../models';
 import type { UploadProgress, Payload } from '../client';
-import { Query } from '../query';
 
 export class Console extends Service {
 

package/src/services/databases.ts

@@ -2,7 +2,6 @@ import { Service } from '../service';
 import { AppwriteException, Client } from '../client';
 import type { Models } from '../models';
 import type { UploadProgress, Payload } from '../client';
-import { Query } from '../query';
 import { DatabaseUsageRange } from '../enums/database-usage-range';
 import { RelationshipType } from '../enums/relationship-type';
 import { RelationMutate } from '../enums/relation-mutate';
@@ -87,7 +86,7 @@ export class Databases extends Service {
     }
 
     /**
-     * Get usage stats for the database
+     * Get databases usage stats
      *
      *
      * @param {DatabaseUsageRange} range
@@ -399,6 +398,7 @@ export class Databases extends Service {
     /**
      * List attributes
      *
+     * List attributes in the collection.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -488,6 +488,8 @@ export 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
@@ -538,6 +540,7 @@ export class Databases extends Service {
     /**
      * Create datetime attribute
      *
+     * Create a date time attribute according to the ISO 8601 standard.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -593,6 +596,8 @@ export 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
@@ -753,6 +758,9 @@ export 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
@@ -1569,6 +1577,7 @@ export class Databases extends Service {
     /**
      * Get attribute
      *
+     * Get attribute by ID.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -1601,6 +1610,7 @@ export class Databases extends Service {
     /**
      * Delete attribute
      *
+     * Deletes an attribute.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -1915,6 +1925,7 @@ export class Databases extends Service {
     /**
      * List indexes
      *
+     * List indexes in the collection.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -1947,6 +1958,9 @@ export 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
@@ -2006,6 +2020,7 @@ export class Databases extends Service {
     /**
      * Get index
      *
+     * Get index by ID.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -2038,6 +2053,7 @@ export class Databases extends Service {
     /**
      * Delete index
      *
+     * Delete an index.
      *
      * @param {string} databaseId
      * @param {string} collectionId
@@ -2101,7 +2117,7 @@ export class Databases extends Service {
     }
 
     /**
-     * Get usage stats for a collection
+     * Get collection usage stats
      *
      *
      * @param {string} databaseId
@@ -2161,7 +2177,7 @@ export class Databases extends Service {
     }
 
     /**
-     * Get usage stats for the database
+     * Get database usage stats
      *
      *
      * @param {string} databaseId

package/src/services/functions.ts

@@ -2,7 +2,6 @@ import { Service } from '../service';
 import { AppwriteException, Client } from '../client';
 import type { Models } from '../models';
 import type { UploadProgress, Payload } from '../client';
-import { Query } from '../query';
 import { Runtime } from '../enums/runtime';
 import { FunctionUsageRange } from '../enums/function-usage-range';
 import { ExecutionMethod } from '../enums/execution-method';

package/src/services/graphql.ts

@@ -2,7 +2,6 @@ import { Service } from '../service';
 import { AppwriteException, Client } from '../client';
 import type { Models } from '../models';
 import type { UploadProgress, Payload } from '../client';
-import { Query } from '../query';
 
 export class Graphql extends Service {