@appwrite.io/console 0.6.0-rc.15 → 0.6.0-rc.16

package/dist/iife/sdk.js

@@ -115,7 +115,7 @@
                 'x-sdk-name': 'Console',
                 'x-sdk-platform': 'console',
                 'x-sdk-language': 'web',
-                'x-sdk-version': '0.6.0-rc.15',
+                'x-sdk-version': '0.6.0-rc.16',
                 'X-Appwrite-Response-Format': '1.5.0',
             };
             this.realtime = {
@@ -698,7 +698,7 @@
          * authenticator](/docs/references/cloud/client-web/account#verifyAuthenticator)
          * method.
          *
-         * @param {Type} type
+         * @param {AuthenticatorType} type
          * @throws {AppwriteException}
          * @returns {Promise}
         */
@@ -722,7 +722,7 @@
          * authenticator](/docs/references/cloud/client-web/account#addAuthenticator)
          * method.
          *
-         * @param {Type} type
+         * @param {AuthenticatorType} type
          * @param {string} otp
          * @throws {AppwriteException}
          * @returns {Promise}
@@ -751,7 +751,7 @@
          *
          * Delete an authenticator for a user by ID.
          *
-         * @param {Type} type
+         * @param {AuthenticatorType} type
          * @param {string} otp
          * @throws {AppwriteException}
          * @returns {Promise}
@@ -782,7 +782,7 @@
          * [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge)
          * method.
          *
-         * @param {Factor} factor
+         * @param {AuthenticationFactor} factor
          * @throws {AppwriteException}
          * @returns {Promise}
         */
@@ -1423,10 +1423,11 @@
             });
         }
         /**
-         * Update (or renew) session
+         * Update session
          *
-         * Extend session's expiry to increase it's lifespan. Extending a session is
-         * useful when session length is short such as 5 minutes.
+         * Use this endpoint to extend a session's length. Extending a session is
+         * useful when session expiry is short. If the session was created using an
+         * OAuth provider, this endpoint refreshes the access token from the provider.
          *
          * @param {string} sessionId
          * @throws {AppwriteException}
@@ -12762,18 +12763,18 @@
         }
     }
 
-    exports.Type = void 0;
-    (function (Type) {
-        Type["Totp"] = "totp";
-    })(exports.Type || (exports.Type = {}));
+    exports.AuthenticatorType = void 0;
+    (function (AuthenticatorType) {
+        AuthenticatorType["Totp"] = "totp";
+    })(exports.AuthenticatorType || (exports.AuthenticatorType = {}));
 
-    exports.Factor = void 0;
-    (function (Factor) {
-        Factor["Email"] = "email";
-        Factor["Phone"] = "phone";
-        Factor["Totp"] = "totp";
-        Factor["Recoverycode"] = "recoverycode";
-    })(exports.Factor || (exports.Factor = {}));
+    exports.AuthenticationFactor = void 0;
+    (function (AuthenticationFactor) {
+        AuthenticationFactor["Email"] = "email";
+        AuthenticationFactor["Phone"] = "phone";
+        AuthenticationFactor["Totp"] = "totp";
+        AuthenticationFactor["Recoverycode"] = "recoverycode";
+    })(exports.AuthenticationFactor || (exports.AuthenticationFactor = {}));
 
     exports.OAuthProvider = void 0;
     (function (OAuthProvider) {
@@ -13574,6 +13575,11 @@
         UserUsageRange["NinetyDays"] = "90d";
     })(exports.UserUsageRange || (exports.UserUsageRange = {}));
 
+    exports.Type = void 0;
+    (function (Type) {
+        Type["Totp"] = "totp";
+    })(exports.Type || (exports.Type = {}));
+
     exports.MessagingProviderType = void 0;
     (function (MessagingProviderType) {
         MessagingProviderType["Email"] = "email";

package/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);

package/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);

package/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
 );
 

package/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
 );
 

package/package.json

@@ -2,7 +2,7 @@
   "name": "@appwrite.io/console",
   "homepage": "https://appwrite.io/support",
   "description": "Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API",
-  "version": "0.6.0-rc.15",
+  "version": "0.6.0-rc.16",
   "license": "BSD-3-Clause",
   "main": "dist/cjs/sdk.js",
   "exports": {

package/src/client.ts

@@ -104,7 +104,7 @@ class Client {
         'x-sdk-name': 'Console',
         'x-sdk-platform': 'console',
         'x-sdk-language': 'web',
-        'x-sdk-version': '0.6.0-rc.15',
+        'x-sdk-version': '0.6.0-rc.16',
         'X-Appwrite-Response-Format': '1.5.0',
     };
 

package/src/enums/{factor.ts → authentication-factor.ts}

@@ -1,4 +1,4 @@
-export enum Factor {
+export enum AuthenticationFactor {
     Email = 'email',
     Phone = 'phone',
     Totp = 'totp',

package/src/enums/authenticator-type.ts

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

package/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';

package/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"');
         }
@@ -1058,10 +1058,11 @@ export class Account extends Service {
     }
 
     /**
-     * Update (or renew) session
+     * Update session
      *
-     * Extend session's expiry to increase it's lifespan. Extending a session is
-     * useful when session length is short such as 5 minutes.
+     * Use this endpoint to extend a session's length. Extending a session is
+     * useful when session expiry is short. If the session was created using an
+     * OAuth provider, this endpoint refreshes the access token from the provider.
      *
      * @param {string} sessionId
      * @throws {AppwriteException}

package/types/enums/{factor.d.ts → authentication-factor.d.ts}

@@ -1,4 +1,4 @@
-export declare enum Factor {
+export declare enum AuthenticationFactor {
     Email = "email",
     Phone = "phone",
     Totp = "totp",

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

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

package/types/index.d.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';

package/types/services/account.d.ts

@@ -1,8 +1,8 @@
 import { Service } from '../service';
 import { Client } from '../client';
 import type { Models } from '../models';
-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 declare class Account extends Service {
     constructor(client: Client);
@@ -123,11 +123,11 @@ export declare class Account extends Service {
      * authenticator](/docs/references/cloud/client-web/account#verifyAuthenticator)
      * method.
      *
-     * @param {Type} type
+     * @param {AuthenticatorType} type
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createMfaAuthenticator(type: Type): Promise<Models.MfaType>;
+    createMfaAuthenticator(type: AuthenticatorType): Promise<Models.MfaType>;
     /**
      * Verify Authenticator
      *
@@ -135,23 +135,23 @@ export declare 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}
     */
-    updateMfaAuthenticator<Preferences extends Models.Preferences>(type: Type, otp: string): Promise<Models.User<Preferences>>;
+    updateMfaAuthenticator<Preferences extends Models.Preferences>(type: AuthenticatorType, otp: string): Promise<Models.User<Preferences>>;
     /**
      * Delete Authenticator
      *
      * Delete an authenticator for a user by ID.
      *
-     * @param {Type} type
+     * @param {AuthenticatorType} type
      * @param {string} otp
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    deleteMfaAuthenticator<Preferences extends Models.Preferences>(type: Type, otp: string): Promise<Models.User<Preferences>>;
+    deleteMfaAuthenticator<Preferences extends Models.Preferences>(type: AuthenticatorType, otp: string): Promise<Models.User<Preferences>>;
     /**
      * Create 2FA Challenge
      *
@@ -159,11 +159,11 @@ export declare class Account extends Service {
      * [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge)
      * method.
      *
-     * @param {Factor} factor
+     * @param {AuthenticationFactor} factor
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createMfaChallenge(factor: Factor): Promise<Models.MfaChallenge>;
+    createMfaChallenge(factor: AuthenticationFactor): Promise<Models.MfaChallenge>;
     /**
      * Create MFA Challenge (confirmation)
      *
@@ -453,10 +453,11 @@ export declare class Account extends Service {
     */
     getSession(sessionId: string): Promise<Models.Session>;
     /**
-     * Update (or renew) session
+     * Update session
      *
-     * Extend session's expiry to increase it's lifespan. Extending a session is
-     * useful when session length is short such as 5 minutes.
+     * Use this endpoint to extend a session's length. Extending a session is
+     * useful when session expiry is short. If the session was created using an
+     * OAuth provider, this endpoint refreshes the access token from the provider.
      *
      * @param {string} sessionId
      * @throws {AppwriteException}