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

package/src/services/users.ts

@@ -2,6 +2,10 @@ import { Service } from '../service';
 import { AppwriteException, Client } from '../client';
 import type { Models } from '../models';
 import type { UploadProgress, Payload } from '../client';
+import { PasswordHash } from '../enums/password-hash';
+import { UserUsageRange } from '../enums/user-usage-range';
+import { AuthenticatorType } from '../enums/authenticator-type';
+import { MessagingProviderType } from '../enums/messaging-provider-type';
 
 export class Users extends Service {
 
@@ -197,12 +201,12 @@ export class Users extends Service {
      *
      * Get identities for all users.
      *
-     * @param {string} queries
+     * @param {string[]} queries
      * @param {string} search
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async listIdentities(queries?: string, search?: string): Promise<Models.IdentityList> {
+    async listIdentities(queries?: string[], search?: string): Promise<Models.IdentityList> {
         const apiPath = '/users/identities';
         const payload: Payload = {};
 
@@ -539,12 +543,12 @@ export class Users extends Service {
      * @param {string} userId
      * @param {string} email
      * @param {string} password
-     * @param {string} passwordVersion
+     * @param {PasswordHash} passwordVersion
      * @param {string} name
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async createSHAUser<Preferences extends Models.Preferences>(userId: string, email: string, password: string, passwordVersion?: string, 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"');
         }
@@ -587,14 +591,14 @@ export class Users extends Service {
     }
 
     /**
-     * Get usage stats for the users API
+     * Get users usage stats
      *
      *
-     * @param {string} range
+     * @param {UserUsageRange} range
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async getUsage(range?: string): Promise<Models.UsageUsers> {
+    async getUsage(range?: UserUsageRange): Promise<Models.UsageUsers> {
         const apiPath = '/users/usage';
         const payload: Payload = {};
 
@@ -782,6 +786,7 @@ export class Users extends Service {
     /**
      * Update MFA
      *
+     * Enable or disable MFA on a user account.
      *
      * @param {string} userId
      * @param {boolean} mfa
@@ -813,35 +818,128 @@ export class Users extends Service {
     /**
      * Delete Authenticator
      *
+     * Delete an authenticator app.
      *
      * @param {string} userId
-     * @param {string} provider
-     * @param {string} otp
+     * @param {AuthenticatorType} type
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async deleteAuthenticator<Preferences extends Models.Preferences>(userId: string, provider: string, 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);
     }
@@ -999,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
      *
@@ -1159,13 +1235,14 @@ export class Users extends Service {
     /**
      * List User Targets
      *
+     * List the messaging targets that are associated with a user.
      *
      * @param {string} userId
-     * @param {string} queries
+     * @param {string[]} queries
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async listTargets(userId: string, queries?: string): Promise<Models.TargetList> {
+    async listTargets(userId: string, queries?: string[]): Promise<Models.TargetList> {
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
         }
@@ -1186,17 +1263,18 @@ export class Users extends Service {
     /**
      * Create User Target
      *
+     * Create a messaging target.
      *
      * @param {string} userId
      * @param {string} targetId
-     * @param {string} providerType
+     * @param {MessagingProviderType} providerType
      * @param {string} identifier
      * @param {string} providerId
      * @param {string} name
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async createTarget(userId: string, targetId: string, providerType: string, identifier: string, providerId?: string, name?: string): Promise<Models.Target> {
+    async createTarget(userId: string, targetId: string, providerType: MessagingProviderType, identifier: string, providerId?: string, name?: string): Promise<Models.Target> {
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
         }
@@ -1245,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
@@ -1272,6 +1351,7 @@ export class Users extends Service {
     /**
      * Update User target
      *
+     * Update a messaging target.
      *
      * @param {string} userId
      * @param {string} targetId
@@ -1314,6 +1394,7 @@ export class Users extends Service {
     /**
      * Delete user target
      *
+     * Delete a messaging target.
      *
      * @param {string} userId
      * @param {string} targetId

package/types/enums/api-service.d.ts

@@ -0,0 +1,13 @@
+export declare enum ApiService {
+    Account = "account",
+    Avatars = "avatars",
+    Databases = "databases",
+    Locale = "locale",
+    Health = "health",
+    Storage = "storage",
+    Teams = "teams",
+    Users = "users",
+    Functions = "functions",
+    Graphql = "graphql",
+    Messaging = "messaging"
+}

package/types/enums/api.d.ts

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

package/types/enums/auth-method.d.ts

@@ -0,0 +1,9 @@
+export declare enum AuthMethod {
+    Emailpassword = "email-password",
+    Magicurl = "magic-url",
+    Emailotp = "email-otp",
+    Anonymous = "anonymous",
+    Invites = "invites",
+    Jwt = "jwt",
+    Phone = "phone"
+}

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"
+}

package/types/enums/browser.d.ts

@@ -0,0 +1,16 @@
+export declare enum Browser {
+    AvantBrowser = "aa",
+    AndroidWebViewBeta = "an",
+    GoogleChrome = "ch",
+    GoogleChromeIOS = "ci",
+    GoogleChromeMobile = "cm",
+    Chromium = "cr",
+    MozillaFirefox = "ff",
+    Safari = "sf",
+    MobileSafari = "mf",
+    MicrosoftEdge = "ps",
+    MicrosoftEdgeIOS = "oi",
+    OperaMini = "om",
+    Opera = "op",
+    OperaNext = "on"
+}

package/types/enums/compression.d.ts

@@ -0,0 +1,5 @@
+export declare enum Compression {
+    None = "none",
+    Gzip = "gzip",
+    Zstd = "zstd"
+}

package/types/enums/credit-card.d.ts

@@ -0,0 +1,18 @@
+export declare enum CreditCard {
+    AmericanExpress = "amex",
+    Argencard = "argencard",
+    Cabal = "cabal",
+    Consosud = "censosud",
+    DinersClub = "diners",
+    Discover = "discover",
+    Elo = "elo",
+    Hipercard = "hipercard",
+    JCB = "jcb",
+    Mastercard = "mastercard",
+    Naranja = "naranja",
+    TarjetaShopping = "targeta-shopping",
+    UnionChinaPay = "union-china-pay",
+    Visa = "visa",
+    MIR = "mir",
+    Maestro = "maestro"
+}

package/types/enums/database-usage-range.d.ts

@@ -0,0 +1,5 @@
+export declare enum DatabaseUsageRange {
+    TwentyFourHours = "24h",
+    ThirtyDays = "30d",
+    NinetyDays = "90d"
+}

package/types/enums/email-template-locale.d.ts

@@ -0,0 +1,133 @@
+export declare enum EmailTemplateLocale {
+    Af = "af",
+    Arae = "ar-ae",
+    Arbh = "ar-bh",
+    Ardz = "ar-dz",
+    Areg = "ar-eg",
+    Ariq = "ar-iq",
+    Arjo = "ar-jo",
+    Arkw = "ar-kw",
+    Arlb = "ar-lb",
+    Arly = "ar-ly",
+    Arma = "ar-ma",
+    Arom = "ar-om",
+    Arqa = "ar-qa",
+    Arsa = "ar-sa",
+    Arsy = "ar-sy",
+    Artn = "ar-tn",
+    Arye = "ar-ye",
+    As = "as",
+    Az = "az",
+    Be = "be",
+    Bg = "bg",
+    Bh = "bh",
+    Bn = "bn",
+    Bs = "bs",
+    Ca = "ca",
+    Cs = "cs",
+    Cy = "cy",
+    Da = "da",
+    De = "de",
+    Deat = "de-at",
+    Dech = "de-ch",
+    Deli = "de-li",
+    Delu = "de-lu",
+    El = "el",
+    En = "en",
+    Enau = "en-au",
+    Enbz = "en-bz",
+    Enca = "en-ca",
+    Engb = "en-gb",
+    Enie = "en-ie",
+    Enjm = "en-jm",
+    Ennz = "en-nz",
+    Entt = "en-tt",
+    Enus = "en-us",
+    Enza = "en-za",
+    Eo = "eo",
+    Es = "es",
+    Esar = "es-ar",
+    Esbo = "es-bo",
+    Escl = "es-cl",
+    Esco = "es-co",
+    Escr = "es-cr",
+    Esdo = "es-do",
+    Esec = "es-ec",
+    Esgt = "es-gt",
+    Eshn = "es-hn",
+    Esmx = "es-mx",
+    Esni = "es-ni",
+    Espa = "es-pa",
+    Espe = "es-pe",
+    Espr = "es-pr",
+    Espy = "es-py",
+    Essv = "es-sv",
+    Esuy = "es-uy",
+    Esve = "es-ve",
+    Et = "et",
+    Eu = "eu",
+    Fa = "fa",
+    Fi = "fi",
+    Fo = "fo",
+    Fr = "fr",
+    Frbe = "fr-be",
+    Frca = "fr-ca",
+    Frch = "fr-ch",
+    Frlu = "fr-lu",
+    Ga = "ga",
+    Gd = "gd",
+    He = "he",
+    Hi = "hi",
+    Hr = "hr",
+    Hu = "hu",
+    Id = "id",
+    Is = "is",
+    It = "it",
+    Itch = "it-ch",
+    Ja = "ja",
+    Ji = "ji",
+    Ko = "ko",
+    Ku = "ku",
+    Lt = "lt",
+    Lv = "lv",
+    Mk = "mk",
+    Ml = "ml",
+    Ms = "ms",
+    Mt = "mt",
+    Nb = "nb",
+    Ne = "ne",
+    Nl = "nl",
+    Nlbe = "nl-be",
+    Nn = "nn",
+    No = "no",
+    Pa = "pa",
+    Pl = "pl",
+    Pt = "pt",
+    Ptbr = "pt-br",
+    Rm = "rm",
+    Ro = "ro",
+    Romd = "ro-md",
+    Ru = "ru",
+    Rumd = "ru-md",
+    Sb = "sb",
+    Sk = "sk",
+    Sl = "sl",
+    Sq = "sq",
+    Sr = "sr",
+    Sv = "sv",
+    Svfi = "sv-fi",
+    Th = "th",
+    Tn = "tn",
+    Tr = "tr",
+    Ts = "ts",
+    Ua = "ua",
+    Ur = "ur",
+    Ve = "ve",
+    Vi = "vi",
+    Xh = "xh",
+    Zhcn = "zh-cn",
+    Zhhk = "zh-hk",
+    Zhsg = "zh-sg",
+    Zhtw = "zh-tw",
+    Zu = "zu"
+}

package/types/enums/email-template-type.d.ts

@@ -0,0 +1,7 @@
+export declare enum EmailTemplateType {
+    Verification = "verification",
+    Magicsession = "magicsession",
+    Recovery = "recovery",
+    Invitation = "invitation",
+    Mfachallenge = "mfachallenge"
+}

package/types/enums/execution-method.d.ts

@@ -0,0 +1,8 @@
+export declare enum ExecutionMethod {
+    GET = "GET",
+    POST = "POST",
+    PUT = "PUT",
+    PATCH = "PATCH",
+    DELETE = "DELETE",
+    OPTIONS = "OPTIONS"
+}