sync

appwrite · Mar 4, 2024 · 600da47 · 600da47
1 parent 626c965
commit 600da47
Show file tree

Hide file tree

Showing 8 changed files with 25 additions and 21 deletions.
diff --git a/docs/examples/account/create-mfa-authenticator.md b/docs/examples/account/create-mfa-authenticator.md
@@ -1,4 +1,4 @@
-import { Client, Account,  } from "@appwrite.io/console";
+import { Client, Account, AuthenticatorType } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
@@ -7,7 +7,7 @@ const client = new Client()
 const account = new Account(client);
 
 const result = await account.createMfaAuthenticator(
-    .Totp // type
+    AuthenticatorType.Totp // type
 );
 
 console.log(response);
diff --git a/docs/examples/account/create-mfa-challenge.md b/docs/examples/account/create-mfa-challenge.md
@@ -1,4 +1,4 @@
-import { Client, Account,  } from "@appwrite.io/console";
+import { Client, Account, AuthenticationFactor } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
@@ -7,7 +7,7 @@ const client = new Client()
 const account = new Account(client);
 
 const result = await account.createMfaChallenge(
-    .Email // factor
+    AuthenticationFactor.Email // factor
 );
 
 console.log(response);
diff --git a/docs/examples/account/delete-mfa-authenticator.md b/docs/examples/account/delete-mfa-authenticator.md
@@ -1,4 +1,4 @@
-import { Client, Account,  } from "@appwrite.io/console";
+import { Client, Account, AuthenticatorType } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
@@ -7,7 +7,7 @@ const client = new Client()
 const account = new Account(client);
 
 const result = await account.deleteMfaAuthenticator(
-    .Totp, // type
+    AuthenticatorType.Totp, // type
     '<OTP>' // otp
 );
 

diff --git a/docs/examples/account/update-mfa-authenticator.md b/docs/examples/account/update-mfa-authenticator.md
@@ -1,4 +1,4 @@
-import { Client, Account,  } from "@appwrite.io/console";
+import { Client, Account, AuthenticatorType } from "@appwrite.io/console";
 
 const client = new Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
@@ -7,7 +7,7 @@ const client = new Client()
 const account = new Account(client);
 
 const result = await account.updateMfaAuthenticator(
-    .Totp, // type
+    AuthenticatorType.Totp, // type
     '<OTP>' // otp
 );
 

diff --git a/src/enums/factor.ts → src/enums/authentication-factor.ts b/src/enums/factor.ts → src/enums/authentication-factor.ts
@@ -1,4 +1,4 @@
-export enum Factor {
+export enum AuthenticationFactor {
     Email = 'email',
     Phone = 'phone',
     Totp = 'totp',

diff --git a/src/enums/authenticator-type.ts b/src/enums/authenticator-type.ts
@@ -0,0 +1,3 @@
+export enum AuthenticatorType {
+    Totp = 'totp',
+}
diff --git a/src/index.ts b/src/index.ts
@@ -22,8 +22,8 @@ export type { QueryTypes, QueryTypesList } from './query';
 export { Permission } from './permission';
 export { Role } from './role';
 export { ID } from './id';
-export { Type } from './enums/type';
-export { Factor } from './enums/factor';
+export { AuthenticatorType } from './enums/authenticator-type';
+export { AuthenticationFactor } from './enums/authentication-factor';
 export { OAuthProvider } from './enums/o-auth-provider';
 export { Browser } from './enums/browser';
 export { CreditCard } from './enums/credit-card';
@@ -54,4 +54,5 @@ export { ImageFormat } from './enums/image-format';
 export { StorageUsageRange } from './enums/storage-usage-range';
 export { PasswordHash } from './enums/password-hash';
 export { UserUsageRange } from './enums/user-usage-range';
+export { Type } from './enums/type';
 export { MessagingProviderType } from './enums/messaging-provider-type';
diff --git a/src/services/account.ts b/src/services/account.ts
@@ -2,8 +2,8 @@ import { Service } from '../service';
 import { AppwriteException, Client } from '../client';
 import type { Models } from '../models';
 import type { UploadProgress, Payload } from '../client';
-import { Type } from '../enums/type';
-import { Factor } from '../enums/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 {
@@ -275,11 +275,11 @@ export class Account extends Service {
      * authenticator](/docs/references/cloud/client-web/account#verifyAuthenticator)
      * method.
      *
-     * @param {Type} type
+     * @param {AuthenticatorType} type
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async createMfaAuthenticator(type: Type): Promise<Models.MfaType> {
+    async createMfaAuthenticator(type: AuthenticatorType): Promise<Models.MfaType> {
         if (typeof type === 'undefined') {
             throw new AppwriteException('Missing required parameter: "type"');
         }
@@ -300,12 +300,12 @@ export class Account extends Service {
      * authenticator](/docs/references/cloud/client-web/account#addAuthenticator)
      * method.
      *
-     * @param {Type} type
+     * @param {AuthenticatorType} type
      * @param {string} otp
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async updateMfaAuthenticator<Preferences extends Models.Preferences>(type: Type, otp: string): Promise<Models.User<Preferences>> {
+    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"');
         }
@@ -332,12 +332,12 @@ export class Account extends Service {
      *
      * Delete an authenticator for a user by ID.
      *
-     * @param {Type} type
+     * @param {AuthenticatorType} type
      * @param {string} otp
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async deleteMfaAuthenticator<Preferences extends Models.Preferences>(type: Type, otp: string): Promise<Models.User<Preferences>> {
+    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"');
         }
@@ -366,11 +366,11 @@ export class Account extends Service {
      * [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge)
      * method.
      *
-     * @param {Factor} factor
+     * @param {AuthenticationFactor} factor
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async createMfaChallenge(factor: Factor): Promise<Models.MfaChallenge> {
+    async createMfaChallenge(factor: AuthenticationFactor): Promise<Models.MfaChallenge> {
         if (typeof factor === 'undefined') {
             throw new AppwriteException('Missing required parameter: "factor"');
         }