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

package/src/services/migrations.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 Migrations extends Service {
 

package/src/services/project.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 { ProjectUsageRange } from '../enums/project-usage-range';
 
 export class Project extends Service {
@@ -13,7 +12,7 @@ export class Project extends Service {
      }
 
     /**
-     * Get usage stats for a project
+     * Get project usage stats
      *
      *
      * @param {string} startDate

package/src/services/projects.ts

@@ -2,15 +2,17 @@ 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 { Region } from '../enums/region';
+import { Api } from '../enums/api';
 import { AuthMethod } from '../enums/auth-method';
 import { OAuthProvider } from '../enums/o-auth-provider';
 import { PlatformType } from '../enums/platform-type';
-import { APIService } from '../enums/a-p-i-service';
+import { ApiService } from '../enums/api-service';
 import { SMTPSecure } from '../enums/s-m-t-p-secure';
-import { TemplateType } from '../enums/template-type';
-import { TemplateLocale } from '../enums/template-locale';
+import { EmailTemplateType } from '../enums/email-template-type';
+import { EmailTemplateLocale } from '../enums/email-template-locale';
+import { SmsTemplateType } from '../enums/sms-template-type';
+import { SmsTemplateLocale } from '../enums/sms-template-locale';
 
 export class Projects extends Service {
 
@@ -260,6 +262,77 @@ export class Projects extends Service {
         }, payload);
     }
 
+    /**
+     * Update API status
+     *
+     *
+     * @param {string} projectId
+     * @param {Api} api
+     * @param {boolean} status
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    async updateApiStatus(projectId: string, api: Api, status: boolean): Promise<Models.Project> {
+        if (typeof projectId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "projectId"');
+        }
+
+        if (typeof api === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "api"');
+        }
+
+        if (typeof status === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "status"');
+        }
+
+        const apiPath = '/projects/{projectId}/api'.replace('{projectId}', projectId);
+        const payload: Payload = {};
+
+        if (typeof api !== 'undefined') {
+            payload['api'] = api;
+        }
+
+        if (typeof status !== 'undefined') {
+            payload['status'] = status;
+        }
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        return await this.client.call('patch', uri, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Update all API status
+     *
+     *
+     * @param {string} projectId
+     * @param {boolean} status
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    async updateApiStatusAll(projectId: string, status: boolean): Promise<Models.Project> {
+        if (typeof projectId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "projectId"');
+        }
+
+        if (typeof status === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "status"');
+        }
+
+        const apiPath = '/projects/{projectId}/api/all'.replace('{projectId}', projectId);
+        const payload: Payload = {};
+
+        if (typeof status !== 'undefined') {
+            payload['status'] = status;
+        }
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        return await this.client.call('patch', uri, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
     /**
      * Update project authentication duration
      *
@@ -886,12 +959,12 @@ export class Projects extends Service {
      *
      *
      * @param {string} projectId
-     * @param {APIService} service
+     * @param {ApiService} service
      * @param {boolean} status
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async updateServiceStatus(projectId: string, service: APIService, status: boolean): Promise<Models.Project> {
+    async updateServiceStatus(projectId: string, service: ApiService, status: boolean): Promise<Models.Project> {
         if (typeof projectId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "projectId"');
         }
@@ -1142,12 +1215,12 @@ export class Projects extends Service {
      *
      *
      * @param {string} projectId
-     * @param {TemplateType} type
-     * @param {TemplateLocale} locale
+     * @param {EmailTemplateType} type
+     * @param {EmailTemplateLocale} locale
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async getEmailTemplate(projectId: string, type: TemplateType, locale: TemplateLocale): Promise<Models.EmailTemplate> {
+    async getEmailTemplate(projectId: string, type: EmailTemplateType, locale: EmailTemplateLocale): Promise<Models.EmailTemplate> {
         if (typeof projectId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "projectId"');
         }
@@ -1174,8 +1247,8 @@ export class Projects extends Service {
      *
      *
      * @param {string} projectId
-     * @param {TemplateType} type
-     * @param {TemplateLocale} locale
+     * @param {EmailTemplateType} type
+     * @param {EmailTemplateLocale} locale
      * @param {string} subject
      * @param {string} message
      * @param {string} senderName
@@ -1184,7 +1257,7 @@ export class Projects extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async updateEmailTemplate(projectId: string, type: TemplateType, locale: TemplateLocale, subject: string, message: string, senderName?: string, senderEmail?: string, replyTo?: string): Promise<Models.Project> {
+    async updateEmailTemplate(projectId: string, type: EmailTemplateType, locale: EmailTemplateLocale, subject: string, message: string, senderName?: string, senderEmail?: string, replyTo?: string): Promise<Models.Project> {
         if (typeof projectId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "projectId"');
         }
@@ -1239,12 +1312,12 @@ export class Projects extends Service {
      *
      *
      * @param {string} projectId
-     * @param {TemplateType} type
-     * @param {TemplateLocale} locale
+     * @param {EmailTemplateType} type
+     * @param {EmailTemplateLocale} locale
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async deleteEmailTemplate(projectId: string, type: TemplateType, locale: TemplateLocale): Promise<Models.EmailTemplate> {
+    async deleteEmailTemplate(projectId: string, type: EmailTemplateType, locale: EmailTemplateLocale): Promise<Models.EmailTemplate> {
         if (typeof projectId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "projectId"');
         }
@@ -1271,12 +1344,12 @@ export class Projects extends Service {
      *
      *
      * @param {string} projectId
-     * @param {TemplateType} type
-     * @param {TemplateLocale} locale
+     * @param {SmsTemplateType} type
+     * @param {SmsTemplateLocale} locale
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async getSmsTemplate(projectId: string, type: TemplateType, locale: TemplateLocale): Promise<Models.SmsTemplate> {
+    async getSmsTemplate(projectId: string, type: SmsTemplateType, locale: SmsTemplateLocale): Promise<Models.SmsTemplate> {
         if (typeof projectId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "projectId"');
         }
@@ -1303,13 +1376,13 @@ export class Projects extends Service {
      *
      *
      * @param {string} projectId
-     * @param {TemplateType} type
-     * @param {TemplateLocale} locale
+     * @param {SmsTemplateType} type
+     * @param {SmsTemplateLocale} locale
      * @param {string} message
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async updateSmsTemplate(projectId: string, type: TemplateType, locale: TemplateLocale, message: string): Promise<Models.SmsTemplate> {
+    async updateSmsTemplate(projectId: string, type: SmsTemplateType, locale: SmsTemplateLocale, message: string): Promise<Models.SmsTemplate> {
         if (typeof projectId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "projectId"');
         }
@@ -1344,12 +1417,12 @@ export class Projects extends Service {
      *
      *
      * @param {string} projectId
-     * @param {TemplateType} type
-     * @param {TemplateLocale} locale
+     * @param {SmsTemplateType} type
+     * @param {SmsTemplateLocale} locale
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async deleteSmsTemplate(projectId: string, type: TemplateType, locale: TemplateLocale): Promise<Models.SmsTemplate> {
+    async deleteSmsTemplate(projectId: string, type: SmsTemplateType, locale: SmsTemplateLocale): Promise<Models.SmsTemplate> {
         if (typeof projectId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "projectId"');
         }

package/src/services/proxy.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 { ResourceType } from '../enums/resource-type';
 
 export class Proxy extends Service {

package/src/services/storage.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 { Compression } from '../enums/compression';
 import { ImageGravity } from '../enums/image-gravity';
 import { ImageFormat } from '../enums/image-format';
@@ -641,7 +640,7 @@ export class Storage extends Service {
     }
 
     /**
-     * Get usage stats for storage
+     * Get storage usage stats
      *
      *
      * @param {StorageUsageRange} range
@@ -663,7 +662,7 @@ export class Storage extends Service {
     }
 
     /**
-     * Get usage stats for storage bucket
+     * Get bucket usage stats
      *
      *
      * @param {string} bucketId

package/src/services/teams.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 Teams extends Service {
 

package/src/services/users.ts

@@ -2,10 +2,9 @@ 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 { PasswordVersion } from '../enums/password-version';
+import { PasswordHash } from '../enums/password-hash';
 import { UserUsageRange } from '../enums/user-usage-range';
-import { AuthenticatorProvider } from '../enums/authenticator-provider';
+import { AuthenticatorType } from '../enums/authenticator-type';
 import { MessagingProviderType } from '../enums/messaging-provider-type';
 
 export class Users extends Service {
@@ -544,12 +543,12 @@ export class Users extends Service {
      * @param {string} userId
      * @param {string} email
      * @param {string} password
-     * @param {PasswordVersion} passwordVersion
+     * @param {PasswordHash} passwordVersion
      * @param {string} name
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async createSHAUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, passwordVersion?: PasswordVersion, name?: string): Promise<Models.User<Preferences>> {
+    async createSHAUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, passwordVersion?: PasswordHash, name?: string): Promise<Models.User<Preferences>> {
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
         }
@@ -592,7 +591,7 @@ export class Users extends Service {
     }
 
     /**
-     * Get usage stats for the users API
+     * Get users usage stats
      *
      *
      * @param {UserUsageRange} range
@@ -787,6 +786,7 @@ export class Users extends Service {
     /**
      * Update MFA
      *
+     * Enable or disable MFA on a user account.
      *
      * @param {string} userId
      * @param {boolean} mfa
@@ -818,35 +818,128 @@ export class Users extends Service {
     /**
      * Delete Authenticator
      *
+     * Delete an authenticator app.
      *
      * @param {string} userId
-     * @param {AuthenticatorProvider} provider
-     * @param {string} otp
+     * @param {AuthenticatorType} type
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async deleteAuthenticator<Preferences extends Models.Preferences>(userId: string, provider: AuthenticatorProvider, otp: string): Promise<Models.User<Preferences>> {
+    async deleteMfaAuthenticator<Preferences extends Models.Preferences>(userId: string, type: AuthenticatorType): Promise<Models.User<Preferences>> {
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
         }
 
-        if (typeof provider === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "provider"');
+        if (typeof type === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "type"');
         }
 
-        if (typeof otp === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "otp"');
+        const apiPath = '/users/{userId}/mfa/authenticators/{type}'.replace('{userId}', userId).replace('{type}', type);
+        const payload: Payload = {};
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        return await this.client.call('delete', uri, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * List Factors
+     *
+     * List the factors available on the account to be used as a MFA challange.
+     *
+     * @param {string} userId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    async listMfaFactors(userId: string): Promise<Models.MfaFactors> {
+        if (typeof userId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "userId"');
         }
 
-        const apiPath = '/users/{userId}/mfa/{provider}'.replace('{userId}', userId).replace('{provider}', provider);
+        const apiPath = '/users/{userId}/mfa/factors'.replace('{userId}', userId);
         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);
+    }
+
+    /**
+     * Get MFA Recovery Codes
+     *
+     * Get recovery codes that can be used as backup for MFA flow by User ID.
+     * Before getting codes, they must be generated using
+     * [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes)
+     * method.
+     *
+     * @param {string} userId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    async getMfaRecoveryCodes(userId: string): Promise<Models.MfaRecoveryCodes> {
+        if (typeof userId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "userId"');
         }
 
+        const apiPath = '/users/{userId}/mfa/recovery-codes'.replace('{userId}', userId);
+        const payload: Payload = {};
+
         const uri = new URL(this.client.config.endpoint + apiPath);
-        return await this.client.call('delete', uri, {
+        return await this.client.call('get', uri, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Regenerate MFA Recovery Codes
+     *
+     * Regenerate recovery codes that can be used as backup for MFA flow by User
+     * ID. Before regenerating codes, they must be first generated using
+     * [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes)
+     * method.
+     *
+     * @param {string} userId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    async updateMfaRecoveryCodes(userId: string): Promise<Models.MfaRecoveryCodes> {
+        if (typeof userId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "userId"');
+        }
+
+        const apiPath = '/users/{userId}/mfa/recovery-codes'.replace('{userId}', userId);
+        const payload: Payload = {};
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        return await this.client.call('put', uri, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Create MFA Recovery Codes
+     *
+     * Generate recovery codes used as backup for MFA flow for User ID. Recovery
+     * codes can be used as a MFA verification type in
+     * [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge)
+     * method by client SDK.
+     *
+     * @param {string} userId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    async createMfaRecoveryCodes(userId: string): Promise<Models.MfaRecoveryCodes> {
+        if (typeof userId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "userId"');
+        }
+
+        const apiPath = '/users/{userId}/mfa/recovery-codes'.replace('{userId}', userId);
+        const payload: Payload = {};
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        return await this.client.call('patch', uri, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -1004,28 +1097,6 @@ export class Users extends Service {
         }, payload);
     }
 
-    /**
-     * List Providers
-     *
-     *
-     * @param {string} userId
-     * @throws {AppwriteException}
-     * @returns {Promise}
-    */
-    async listProviders(userId: string): Promise<Models.MfaProviders> {
-        if (typeof userId === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "userId"');
-        }
-
-        const apiPath = '/users/{userId}/providers'.replace('{userId}', userId);
-        const payload: Payload = {};
-
-        const uri = new URL(this.client.config.endpoint + apiPath);
-        return await this.client.call('get', uri, {
-            'content-type': 'application/json',
-        }, payload);
-    }
-
     /**
      * List user sessions
      *
@@ -1164,6 +1235,7 @@ export class Users extends Service {
     /**
      * List User Targets
      *
+     * List the messaging targets that are associated with a user.
      *
      * @param {string} userId
      * @param {string[]} queries
@@ -1191,6 +1263,7 @@ export class Users extends Service {
     /**
      * Create User Target
      *
+     * Create a messaging target.
      *
      * @param {string} userId
      * @param {string} targetId
@@ -1250,6 +1323,7 @@ export class Users extends Service {
     /**
      * Get User Target
      *
+     * Get a user's push notification target by ID.
      *
      * @param {string} userId
      * @param {string} targetId
@@ -1277,6 +1351,7 @@ export class Users extends Service {
     /**
      * Update User target
      *
+     * Update a messaging target.
      *
      * @param {string} userId
      * @param {string} targetId
@@ -1319,6 +1394,7 @@ export class Users extends Service {
     /**
      * Delete user target
      *
+     * Delete a messaging target.
      *
      * @param {string} userId
      * @param {string} targetId

package/src/services/vcs.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 Vcs extends Service {
 

package/types/enums/{a-p-i-service.d.ts → api-service.d.ts}

@@ -1,4 +1,4 @@
-export declare enum APIService {
+export declare enum ApiService {
     Account = "account",
     Avatars = "avatars",
     Databases = "databases",

package/types/enums/api.d.ts

@@ -0,0 +1,5 @@
+export declare enum Api {
+    Rest = "rest",
+    Graphql = "graphql",
+    Realtime = "realtime"
+}

package/types/enums/authentication-factor.d.ts

@@ -0,0 +1,6 @@
+export declare enum AuthenticationFactor {
+    Email = "email",
+    Phone = "phone",
+    Totp = "totp",
+    Recoverycode = "recoverycode"
+}

package/types/enums/authenticator-type.d.ts

@@ -0,0 +1,3 @@
+export declare enum AuthenticatorType {
+    Totp = "totp"
+}