@appwrite.io/console 0.5.0 → 0.6.0-rc.10

package/src/services/users.ts

@@ -2,6 +2,11 @@ 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 { PasswordHash } from '../enums/password-hash';
+import { UserUsageRange } from '../enums/user-usage-range';
+import { Type } from '../enums/type';
+import { MessagingProviderType } from '../enums/messaging-provider-type';
 
 export class Users extends Service {
 
@@ -197,12 +202,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 = {};
 
@@ -221,7 +226,7 @@ export class Users extends Service {
     }
 
     /**
-     * Delete Identity
+     * Delete identity
      *
      * Delete an identity by its unique ID.
      *
@@ -539,12 +544,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"');
         }
@@ -590,11 +595,11 @@ export class Users extends Service {
      * Get usage stats for the users API
      *
      *
-     * @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 = {};
 
@@ -779,6 +784,95 @@ export class Users extends Service {
         }, payload);
     }
 
+    /**
+     * Update MFA
+     *
+     *
+     * @param {string} userId
+     * @param {boolean} mfa
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    async updateMfa<Preferences extends Models.Preferences>(userId: string, mfa: boolean): Promise<Models.User<Preferences>> {
+        if (typeof userId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "userId"');
+        }
+
+        if (typeof mfa === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "mfa"');
+        }
+
+        const apiPath = '/users/{userId}/mfa'.replace('{userId}', userId);
+        const payload: Payload = {};
+
+        if (typeof mfa !== 'undefined') {
+            payload['mfa'] = mfa;
+        }
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        return await this.client.call('patch', uri, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * List Factors
+     *
+     *
+     * @param {string} userId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    async listFactors(userId: string): Promise<Models.MfaFactors> {
+        if (typeof userId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "userId"');
+        }
+
+        const apiPath = '/users/{userId}/mfa/factors'.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);
+    }
+
+    /**
+     * Delete Authenticator
+     *
+     *
+     * @param {string} userId
+     * @param {Type} type
+     * @param {string} otp
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    async deleteAuthenticator<Preferences extends Models.Preferences>(userId: string, type: Type, otp: string): Promise<Models.User<Preferences>> {
+        if (typeof userId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "userId"');
+        }
+
+        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/{type}'.replace('{userId}', userId).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('delete', uri, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
     /**
      * Update name
      *
@@ -955,6 +1049,34 @@ export class Users extends Service {
         }, payload);
     }
 
+    /**
+     * Create session
+     *
+     * Creates a session for a user. Returns an immediately usable session object.
+     * 
+     * If you want to generate a token for a custom authentication flow, use the
+     * [POST
+     * /users/{userId}/tokens](https://appwrite.io/docs/server/users#createToken)
+     * endpoint.
+     *
+     * @param {string} userId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    async createSession(userId: string): Promise<Models.Session> {
+        if (typeof userId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "userId"');
+        }
+
+        const apiPath = '/users/{userId}/sessions'.replace('{userId}', userId);
+        const payload: Payload = {};
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        return await this.client.call('post', uri, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
     /**
      * Delete user sessions
      *
@@ -1039,6 +1161,225 @@ export class Users extends Service {
         }, payload);
     }
 
+    /**
+     * List User Targets
+     *
+     *
+     * @param {string} userId
+     * @param {string[]} queries
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    async listTargets(userId: string, queries?: string[]): Promise<Models.TargetList> {
+        if (typeof userId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "userId"');
+        }
+
+        const apiPath = '/users/{userId}/targets'.replace('{userId}', userId);
+        const payload: Payload = {};
+
+        if (typeof queries !== 'undefined') {
+            payload['queries'] = queries;
+        }
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        return await this.client.call('get', uri, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Create User Target
+     *
+     *
+     * @param {string} userId
+     * @param {string} targetId
+     * @param {MessagingProviderType} providerType
+     * @param {string} identifier
+     * @param {string} providerId
+     * @param {string} name
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    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"');
+        }
+
+        if (typeof targetId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "targetId"');
+        }
+
+        if (typeof providerType === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "providerType"');
+        }
+
+        if (typeof identifier === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "identifier"');
+        }
+
+        const apiPath = '/users/{userId}/targets'.replace('{userId}', userId);
+        const payload: Payload = {};
+
+        if (typeof targetId !== 'undefined') {
+            payload['targetId'] = targetId;
+        }
+
+        if (typeof providerType !== 'undefined') {
+            payload['providerType'] = providerType;
+        }
+
+        if (typeof identifier !== 'undefined') {
+            payload['identifier'] = identifier;
+        }
+
+        if (typeof providerId !== 'undefined') {
+            payload['providerId'] = providerId;
+        }
+
+        if (typeof name !== 'undefined') {
+            payload['name'] = name;
+        }
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        return await this.client.call('post', uri, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Get User Target
+     *
+     *
+     * @param {string} userId
+     * @param {string} targetId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    async getTarget(userId: string, targetId: string): Promise<Models.Target> {
+        if (typeof userId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "userId"');
+        }
+
+        if (typeof targetId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "targetId"');
+        }
+
+        const apiPath = '/users/{userId}/targets/{targetId}'.replace('{userId}', userId).replace('{targetId}', targetId);
+        const payload: Payload = {};
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        return await this.client.call('get', uri, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Update User target
+     *
+     *
+     * @param {string} userId
+     * @param {string} targetId
+     * @param {string} identifier
+     * @param {string} providerId
+     * @param {string} name
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    async updateTarget(userId: string, targetId: string, identifier?: string, providerId?: string, name?: string): Promise<Models.Target> {
+        if (typeof userId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "userId"');
+        }
+
+        if (typeof targetId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "targetId"');
+        }
+
+        const apiPath = '/users/{userId}/targets/{targetId}'.replace('{userId}', userId).replace('{targetId}', targetId);
+        const payload: Payload = {};
+
+        if (typeof identifier !== 'undefined') {
+            payload['identifier'] = identifier;
+        }
+
+        if (typeof providerId !== 'undefined') {
+            payload['providerId'] = providerId;
+        }
+
+        if (typeof name !== 'undefined') {
+            payload['name'] = name;
+        }
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        return await this.client.call('patch', uri, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Delete user target
+     *
+     *
+     * @param {string} userId
+     * @param {string} targetId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    async deleteTarget(userId: string, targetId: string): Promise<{}> {
+        if (typeof userId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "userId"');
+        }
+
+        if (typeof targetId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "targetId"');
+        }
+
+        const apiPath = '/users/{userId}/targets/{targetId}'.replace('{userId}', userId).replace('{targetId}', targetId);
+        const payload: Payload = {};
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        return await this.client.call('delete', uri, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Create token
+     *
+     * Returns a token with a secret key for creating a session. If the provided
+     * user ID has not be registered, a new user will be created. Use the returned
+     * user ID and secret and submit a request to the [PUT
+     * /account/sessions/custom](https://appwrite.io/docs/references/cloud/client-web/account#updateCustomSession)
+     * endpoint to complete the login process.
+     *
+     * @param {string} userId
+     * @param {number} length
+     * @param {number} expire
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    async createToken(userId: string, length?: number, expire?: number): Promise<Models.Token> {
+        if (typeof userId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "userId"');
+        }
+
+        const apiPath = '/users/{userId}/tokens'.replace('{userId}', userId);
+        const payload: Payload = {};
+
+        if (typeof length !== 'undefined') {
+            payload['length'] = length;
+        }
+
+        if (typeof expire !== 'undefined') {
+            payload['expire'] = expire;
+        }
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        return await this.client.call('post', uri, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
     /**
      * Update email verification
      *

package/src/services/vcs.ts

@@ -2,6 +2,7 @@ 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

@@ -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/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/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,6 @@
+export declare enum EmailTemplateType {
+    Verification = "verification",
+    Magicsession = "magicsession",
+    Recovery = "recovery",
+    Invitation = "invitation"
+}

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

package/types/enums/factor.d.ts

@@ -0,0 +1,5 @@
+export declare enum Factor {
+    Totp = "totp",
+    Phone = "phone",
+    Email = "email"
+}