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

package/types/services/projects.d.ts

@@ -2,13 +2,16 @@ import { Service } from '../service';
 import { Client } from '../client';
 import type { Models } from '../models';
 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 declare class Projects extends Service {
     constructor(client: Client);
     /**
@@ -79,6 +82,27 @@ export declare class Projects extends Service {
      * @returns {Promise}
     */
     delete(projectId: string): Promise<{}>;
+    /**
+     * Update API status
+     *
+     *
+     * @param {string} projectId
+     * @param {Api} api
+     * @param {boolean} status
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updateApiStatus(projectId: string, api: Api, status: boolean): Promise<Models.Project>;
+    /**
+     * Update all API status
+     *
+     *
+     * @param {string} projectId
+     * @param {boolean} status
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updateApiStatusAll(projectId: string, status: boolean): Promise<Models.Project>;
     /**
      * Update project authentication duration
      *
@@ -279,12 +303,12 @@ export declare class Projects extends Service {
      *
      *
      * @param {string} projectId
-     * @param {APIService} service
+     * @param {ApiService} service
      * @param {boolean} status
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateServiceStatus(projectId: string, service: APIService, status: boolean): Promise<Models.Project>;
+    updateServiceStatus(projectId: string, service: ApiService, status: boolean): Promise<Models.Project>;
     /**
      * Update all service status
      *
@@ -346,19 +370,19 @@ export declare class Projects extends Service {
      *
      *
      * @param {string} projectId
-     * @param {TemplateType} type
-     * @param {TemplateLocale} locale
+     * @param {EmailTemplateType} type
+     * @param {EmailTemplateLocale} locale
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    getEmailTemplate(projectId: string, type: TemplateType, locale: TemplateLocale): Promise<Models.EmailTemplate>;
+    getEmailTemplate(projectId: string, type: EmailTemplateType, locale: EmailTemplateLocale): Promise<Models.EmailTemplate>;
     /**
      * Update custom email templates
      *
      *
      * @param {string} projectId
-     * @param {TemplateType} type
-     * @param {TemplateLocale} locale
+     * @param {EmailTemplateType} type
+     * @param {EmailTemplateLocale} locale
      * @param {string} subject
      * @param {string} message
      * @param {string} senderName
@@ -367,52 +391,52 @@ export declare class Projects extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateEmailTemplate(projectId: string, type: TemplateType, locale: TemplateLocale, subject: string, message: string, senderName?: string, senderEmail?: string, replyTo?: string): Promise<Models.Project>;
+    updateEmailTemplate(projectId: string, type: EmailTemplateType, locale: EmailTemplateLocale, subject: string, message: string, senderName?: string, senderEmail?: string, replyTo?: string): Promise<Models.Project>;
     /**
      * Reset custom email template
      *
      *
      * @param {string} projectId
-     * @param {TemplateType} type
-     * @param {TemplateLocale} locale
+     * @param {EmailTemplateType} type
+     * @param {EmailTemplateLocale} locale
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    deleteEmailTemplate(projectId: string, type: TemplateType, locale: TemplateLocale): Promise<Models.EmailTemplate>;
+    deleteEmailTemplate(projectId: string, type: EmailTemplateType, locale: EmailTemplateLocale): Promise<Models.EmailTemplate>;
     /**
      * Get custom SMS template
      *
      *
      * @param {string} projectId
-     * @param {TemplateType} type
-     * @param {TemplateLocale} locale
+     * @param {SmsTemplateType} type
+     * @param {SmsTemplateLocale} locale
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    getSmsTemplate(projectId: string, type: TemplateType, locale: TemplateLocale): Promise<Models.SmsTemplate>;
+    getSmsTemplate(projectId: string, type: SmsTemplateType, locale: SmsTemplateLocale): Promise<Models.SmsTemplate>;
     /**
      * Update custom SMS template
      *
      *
      * @param {string} projectId
-     * @param {TemplateType} type
-     * @param {TemplateLocale} locale
+     * @param {SmsTemplateType} type
+     * @param {SmsTemplateLocale} locale
      * @param {string} message
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateSmsTemplate(projectId: string, type: TemplateType, locale: TemplateLocale, message: string): Promise<Models.SmsTemplate>;
+    updateSmsTemplate(projectId: string, type: SmsTemplateType, locale: SmsTemplateLocale, message: string): Promise<Models.SmsTemplate>;
     /**
      * Reset custom SMS template
      *
      *
      * @param {string} projectId
-     * @param {TemplateType} type
-     * @param {TemplateLocale} locale
+     * @param {SmsTemplateType} type
+     * @param {SmsTemplateLocale} locale
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    deleteSmsTemplate(projectId: string, type: TemplateType, locale: TemplateLocale): Promise<Models.SmsTemplate>;
+    deleteSmsTemplate(projectId: string, type: SmsTemplateType, locale: SmsTemplateLocale): Promise<Models.SmsTemplate>;
     /**
      * List webhooks
      *

package/types/services/storage.d.ts

@@ -213,7 +213,7 @@ export declare class Storage extends Service {
     */
     getFileView(bucketId: string, fileId: string): URL;
     /**
-     * Get usage stats for storage
+     * Get storage usage stats
      *
      *
      * @param {StorageUsageRange} range
@@ -222,7 +222,7 @@ export declare class Storage extends Service {
     */
     getUsage(range?: StorageUsageRange): Promise<Models.UsageStorage>;
     /**
-     * Get usage stats for storage bucket
+     * Get bucket usage stats
      *
      *
      * @param {string} bucketId

package/types/services/users.d.ts

@@ -1,9 +1,9 @@
 import { Service } from '../service';
 import { Client } from '../client';
 import type { Models } from '../models';
-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 declare class Users extends Service {
     constructor(client: Client);
@@ -170,14 +170,14 @@ export declare 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}
     */
-    createSHAUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, passwordVersion?: PasswordVersion, name?: string): Promise<Models.User<Preferences>>;
+    createSHAUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, passwordVersion?: PasswordHash, name?: string): Promise<Models.User<Preferences>>;
     /**
-     * Get usage stats for the users API
+     * Get users usage stats
      *
      *
      * @param {UserUsageRange} range
@@ -261,6 +261,7 @@ export declare class Users extends Service {
     /**
      * Update MFA
      *
+     * Enable or disable MFA on a user account.
      *
      * @param {string} userId
      * @param {boolean} mfa
@@ -271,14 +272,63 @@ export declare 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}
     */
-    deleteAuthenticator<Preferences extends Models.Preferences>(userId: string, provider: AuthenticatorProvider, otp: string): Promise<Models.User<Preferences>>;
+    deleteMfaAuthenticator<Preferences extends Models.Preferences>(userId: string, type: AuthenticatorType): Promise<Models.User<Preferences>>;
+    /**
+     * List Factors
+     *
+     * List the factors available on the account to be used as a MFA challange.
+     *
+     * @param {string} userId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    listMfaFactors(userId: string): Promise<Models.MfaFactors>;
+    /**
+     * 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}
+    */
+    getMfaRecoveryCodes(userId: string): Promise<Models.MfaRecoveryCodes>;
+    /**
+     * 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}
+    */
+    updateMfaRecoveryCodes(userId: string): Promise<Models.MfaRecoveryCodes>;
+    /**
+     * 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}
+    */
+    createMfaRecoveryCodes(userId: string): Promise<Models.MfaRecoveryCodes>;
     /**
      * Update name
      *
@@ -335,15 +385,6 @@ export declare class Users extends Service {
      * @returns {Promise}
     */
     updatePrefs<Preferences extends Models.Preferences>(userId: string, prefs: object): Promise<Preferences>;
-    /**
-     * List Providers
-     *
-     *
-     * @param {string} userId
-     * @throws {AppwriteException}
-     * @returns {Promise}
-    */
-    listProviders(userId: string): Promise<Models.MfaProviders>;
     /**
      * List user sessions
      *
@@ -405,6 +446,7 @@ export declare class Users extends Service {
     /**
      * List User Targets
      *
+     * List the messaging targets that are associated with a user.
      *
      * @param {string} userId
      * @param {string[]} queries
@@ -415,6 +457,7 @@ export declare class Users extends Service {
     /**
      * Create User Target
      *
+     * Create a messaging target.
      *
      * @param {string} userId
      * @param {string} targetId
@@ -429,6 +472,7 @@ export declare class Users extends Service {
     /**
      * Get User Target
      *
+     * Get a user's push notification target by ID.
      *
      * @param {string} userId
      * @param {string} targetId
@@ -439,6 +483,7 @@ export declare class Users extends Service {
     /**
      * Update User target
      *
+     * Update a messaging target.
      *
      * @param {string} userId
      * @param {string} targetId
@@ -452,6 +497,7 @@ export declare class Users extends Service {
     /**
      * Delete user target
      *
+     * Delete a messaging target.
      *
      * @param {string} userId
      * @param {string} targetId

package/docs/examples/account/add-authenticator.md

@@ -1,18 +0,0 @@
-import { Client, AuthenticatorFactor, Account } from "@appwrite.io/console";
-
-const client = new Client();
-
-const account = new Account(client);
-
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = account.addAuthenticator(AuthenticatorFactor.Totp);
-
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});

package/docs/examples/account/create-challenge.md

@@ -1,18 +0,0 @@
-import { Client, AuthenticatorProvider, Account } from "@appwrite.io/console";
-
-const client = new Client();
-
-const account = new Account(client);
-
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = account.createChallenge(AuthenticatorProvider.Totp);
-
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});

package/docs/examples/account/delete-authenticator.md

@@ -1,18 +0,0 @@
-import { Client, AuthenticatorProvider, Account } from "@appwrite.io/console";
-
-const client = new Client();
-
-const account = new Account(client);
-
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = account.deleteAuthenticator(AuthenticatorProvider.Totp, '[OTP]');
-
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});

package/docs/examples/account/list-factors.md

@@ -1,18 +0,0 @@
-import { Client,  Account } from "@appwrite.io/console";
-
-const client = new Client();
-
-const account = new Account(client);
-
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = account.listFactors();
-
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});

package/docs/examples/account/update-challenge.md

@@ -1,18 +0,0 @@
-import { Client,  Account } from "@appwrite.io/console";
-
-const client = new Client();
-
-const account = new Account(client);
-
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = account.updateChallenge('[CHALLENGE_ID]', '[OTP]');
-
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});

package/docs/examples/account/verify-authenticator.md

@@ -1,18 +0,0 @@
-import { Client, AuthenticatorFactor, Account } from "@appwrite.io/console";
-
-const client = new Client();
-
-const account = new Account(client);
-
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = account.verifyAuthenticator(AuthenticatorFactor.Totp, '[OTP]');
-
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});

package/docs/examples/messaging/create-a-p-n-s-provider.md

@@ -1,18 +0,0 @@
-import { Client,  Messaging } from "@appwrite.io/console";
-
-const client = new Client();
-
-const messaging = new Messaging(client);
-
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = messaging.createAPNSProvider('[PROVIDER_ID]', '[NAME]');
-
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});

package/docs/examples/messaging/create-f-c-m-provider.md

@@ -1,18 +0,0 @@
-import { Client,  Messaging } from "@appwrite.io/console";
-
-const client = new Client();
-
-const messaging = new Messaging(client);
-
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = messaging.createFCMProvider('[PROVIDER_ID]', '[NAME]');
-
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});

package/docs/examples/messaging/create-s-m-s.md

@@ -1,18 +0,0 @@
-import { Client,  Messaging } from "@appwrite.io/console";
-
-const client = new Client();
-
-const messaging = new Messaging(client);
-
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = messaging.createSMS('[MESSAGE_ID]', '[CONTENT]');
-
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});

package/docs/examples/messaging/create-s-m-t-p-provider.md

@@ -1,18 +0,0 @@
-import { Client,  Messaging } from "@appwrite.io/console";
-
-const client = new Client();
-
-const messaging = new Messaging(client);
-
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = messaging.createSMTPProvider('[PROVIDER_ID]', '[NAME]', '[HOST]');
-
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});

package/docs/examples/messaging/update-a-p-n-s-provider.md

@@ -1,18 +0,0 @@
-import { Client,  Messaging } from "@appwrite.io/console";
-
-const client = new Client();
-
-const messaging = new Messaging(client);
-
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = messaging.updateAPNSProvider('[PROVIDER_ID]');
-
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});

package/docs/examples/messaging/update-f-c-m-provider.md

@@ -1,18 +0,0 @@
-import { Client,  Messaging } from "@appwrite.io/console";
-
-const client = new Client();
-
-const messaging = new Messaging(client);
-
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = messaging.updateFCMProvider('[PROVIDER_ID]');
-
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});

package/docs/examples/messaging/update-s-m-s.md

@@ -1,18 +0,0 @@
-import { Client,  Messaging } from "@appwrite.io/console";
-
-const client = new Client();
-
-const messaging = new Messaging(client);
-
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = messaging.updateSMS('[MESSAGE_ID]');
-
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});

package/docs/examples/messaging/update-s-m-t-p-provider.md

@@ -1,18 +0,0 @@
-import { Client,  Messaging } from "@appwrite.io/console";
-
-const client = new Client();
-
-const messaging = new Messaging(client);
-
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = messaging.updateSMTPProvider('[PROVIDER_ID]');
-
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});

package/docs/examples/users/delete-authenticator.md

@@ -1,18 +0,0 @@
-import { Client, AuthenticatorProvider, Users } from "@appwrite.io/console";
-
-const client = new Client();
-
-const users = new Users(client);
-
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = users.deleteAuthenticator('[USER_ID]', AuthenticatorProvider.Totp, '[OTP]');
-
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});

package/docs/examples/users/list-providers.md

@@ -1,18 +0,0 @@
-import { Client,  Users } from "@appwrite.io/console";
-
-const client = new Client();
-
-const users = new Users(client);
-
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = users.listProviders('[USER_ID]');
-
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});

package/src/enums/authenticator-factor.ts

@@ -1,3 +0,0 @@
-export enum AuthenticatorFactor {
-    Totp = 'totp',
-}

package/src/enums/authenticator-provider.ts

@@ -1,3 +0,0 @@
-export enum AuthenticatorProvider {
-    Totp = 'totp',
-}

package/src/enums/message-type.ts

@@ -1,5 +0,0 @@
-export enum MessageType {
-    Draft = 'draft',
-    Cancelled = 'cancelled',
-    Processing = 'processing',
-}

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

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

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

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