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

package/types/services/account.d.ts

@@ -1,6 +1,9 @@
 import { Service } from '../service';
 import { Client } from '../client';
 import type { Models } from '../models';
+import { Factor } from '../enums/factor';
+import { Type } from '../enums/type';
+import { OAuthProvider } from '../enums/o-auth-provider';
 export declare class Account extends Service {
     constructor(client: Client);
     /**
@@ -63,13 +66,13 @@ export declare class Account extends Service {
      *
      * Get the list of identities for the currently logged in user.
      *
-     * @param {string} queries
+     * @param {string[]} queries
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    listIdentities(queries?: string): Promise<Models.IdentityList>;
+    listIdentities(queries?: string[]): Promise<Models.IdentityList>;
     /**
-     * Delete Identity
+     * Delete identity
      *
      * Delete an identity by its unique ID.
      *
@@ -102,6 +105,71 @@ export declare class Account extends Service {
      * @returns {Promise}
     */
     listLogs(queries?: string[]): Promise<Models.LogList>;
+    /**
+     * Update MFA
+     *
+     *
+     * @param {boolean} mfa
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updateMFA<Preferences extends Models.Preferences>(mfa: boolean): Promise<Models.User<Preferences>>;
+    /**
+     * Create 2FA Challenge
+     *
+     *
+     * @param {Factor} factor
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    create2FAChallenge(factor: Factor): Promise<Models.MfaChallenge>;
+    /**
+     * Create MFA Challenge (confirmation)
+     *
+     *
+     * @param {string} challengeId
+     * @param {string} otp
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updateChallenge(challengeId: string, otp: string): Promise<{}>;
+    /**
+     * List Factors
+     *
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    listFactors(): Promise<Models.MfaFactors>;
+    /**
+     * Add Authenticator
+     *
+     *
+     * @param {Type} type
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    addAuthenticator(type: Type): Promise<Models.MfaType>;
+    /**
+     * Verify Authenticator
+     *
+     *
+     * @param {Type} type
+     * @param {string} otp
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    verifyAuthenticator<Preferences extends Models.Preferences>(type: Type, otp: string): Promise<Models.User<Preferences>>;
+    /**
+     * Delete Authenticator
+     *
+     *
+     * @param {Type} type
+     * @param {string} otp
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    deleteAuthenticator<Preferences extends Models.Preferences>(type: Type, otp: string): Promise<Models.User<Preferences>>;
     /**
      * Update name
      *
@@ -196,11 +264,10 @@ export declare class Account extends Service {
      * @param {string} userId
      * @param {string} secret
      * @param {string} password
-     * @param {string} passwordAgain
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateRecovery(userId: string, secret: string, password: string, passwordAgain: string): Promise<Models.Token>;
+    updateRecovery(userId: string, secret: string, password: string): Promise<Models.Token>;
     /**
      * List sessions
      *
@@ -237,7 +304,7 @@ export declare class Account extends Service {
     */
     createAnonymousSession(): Promise<Models.Session>;
     /**
-     * Create email session
+     * Create email password session
      *
      * Allow the user to login into their account by providing a valid email and
      * password combination. This route will create a new session for the user.
@@ -251,48 +318,13 @@ export declare class Account extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createEmailSession(email: string, password: string): Promise<Models.Session>;
-    /**
-     * Create magic URL session
-     *
-     * Sends the user an email with a secret key for creating a session. If the
-     * provided user ID has not been registered, a new user will be created. When
-     * the user clicks the link in the email, the user is redirected back to the
-     * URL you provided with the secret key and userId values attached to the URL
-     * query string. Use the query string parameters to submit a request to the
-     * [PUT
-     * /account/sessions/magic-url](https://appwrite.io/docs/references/cloud/client-web/account#updateMagicURLSession)
-     * endpoint to complete the login process. The link sent to the user's email
-     * address is valid for 1 hour. If you are on a mobile device you can leave
-     * the URL parameter empty, so that the login completion will be handled by
-     * your Appwrite instance by default.
-     *
-     * A user is limited to 10 active sessions at a time by default. [Learn more
-     * about session
-     * limits](https://appwrite.io/docs/authentication-security#limits).
-     *
-     *
-     * @param {string} userId
-     * @param {string} email
-     * @param {string} url
-     * @throws {AppwriteException}
-     * @returns {Promise}
-    */
-    createMagicURLSession(userId: string, email: string, url?: string): Promise<Models.Token>;
+    createEmailPasswordSession(email: string, password: string): Promise<Models.Session>;
     /**
-     * Create magic URL session (confirmation)
+     * Create session (deprecated)
      *
-     * Use this endpoint to complete creating the session with the Magic URL. Both
-     * the **userId** and **secret** arguments will be passed as query parameters
-     * to the redirect URL you have provided when sending your request to the
-     * [POST
-     * /account/sessions/magic-url](https://appwrite.io/docs/references/cloud/client-web/account#createMagicURLSession)
-     * endpoint.
-     *
-     * Please note that in order to avoid a [Redirect
-     * Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md)
-     * the only valid redirect URLs are the ones from domains you have set when
-     * adding your platforms in the console interface.
+     * Use this endpoint to create a session from token. Provide the **userId**
+     * and **secret** parameters from the successful response of authentication
+     * flows initiated by token creation. For example, magic URL and phone login.
      *
      * @param {string} userId
      * @param {string} secret
@@ -320,49 +352,28 @@ export declare class Account extends Service {
      * limits](https://appwrite.io/docs/authentication-security#limits).
      *
      *
-     * @param {string} provider
+     * @param {OAuthProvider} provider
      * @param {string} success
      * @param {string} failure
+     * @param {boolean} token
      * @param {string[]} scopes
      * @throws {AppwriteException}
      * @returns {void|string}
     */
-    createOAuth2Session(provider: string, success?: string, failure?: string, scopes?: string[]): void | URL;
-    /**
-     * Create phone session
-     *
-     * Sends the user an SMS 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/phone](https://appwrite.io/docs/references/cloud/client-web/account#updatePhoneSession)
-     * endpoint to complete the login process. The secret sent to the user's phone
-     * is valid for 15 minutes.
-     *
-     * A user is limited to 10 active sessions at a time by default. [Learn more
-     * about session
-     * limits](https://appwrite.io/docs/authentication-security#limits).
-     *
-     * @param {string} userId
-     * @param {string} phone
-     * @throws {AppwriteException}
-     * @returns {Promise}
-    */
-    createPhoneSession(userId: string, phone: string): Promise<Models.Token>;
+    createOAuth2Session(provider: OAuthProvider, success?: string, failure?: string, token?: boolean, scopes?: string[]): void | URL;
     /**
-     * Create phone session (confirmation)
+     * Create session
      *
-     * Use this endpoint to complete creating a session with SMS. Use the
-     * **userId** from the
-     * [createPhoneSession](https://appwrite.io/docs/references/cloud/client-web/account#createPhoneSession)
-     * endpoint and the **secret** received via SMS to successfully update and
-     * confirm the phone session.
+     * Use this endpoint to create a session from token. Provide the **userId**
+     * and **secret** parameters from the successful response of authentication
+     * flows initiated by token creation. For example, magic URL and phone login.
      *
      * @param {string} userId
      * @param {string} secret
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updatePhoneSession(userId: string, secret: string): Promise<Models.Session>;
+    createSession(userId: string, secret: string): Promise<Models.Session>;
     /**
      * Get session
      *
@@ -375,11 +386,10 @@ export declare class Account extends Service {
     */
     getSession(sessionId: string): Promise<Models.Session>;
     /**
-     * Update OAuth session (refresh tokens)
+     * Update (or renew) a session
      *
-     * Access tokens have limited lifespan and expire to mitigate security risks.
-     * If session was created using an OAuth provider, this route can be used to
-     * "refresh" the access token.
+     * Extend session's expiry to increase it's lifespan. Extending a session is
+     * useful when session length is short such as 5 minutes.
      *
      * @param {string} sessionId
      * @throws {AppwriteException}
@@ -411,6 +421,105 @@ export declare class Account extends Service {
      * @returns {Promise}
     */
     updateStatus<Preferences extends Models.Preferences>(): Promise<Models.User<Preferences>>;
+    /**
+     * Create a push target
+     *
+     *
+     * @param {string} targetId
+     * @param {string} identifier
+     * @param {string} providerId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createPushTarget(targetId: string, identifier: string, providerId?: string): Promise<Models.Target>;
+    /**
+     * Update a push target
+     *
+     *
+     * @param {string} targetId
+     * @param {string} identifier
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    updatePushTarget(targetId: string, identifier: string): Promise<Models.Target>;
+    /**
+     * Delete a push target
+     *
+     *
+     * @param {string} targetId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    deletePushTarget(targetId: string): Promise<{}>;
+    /**
+     * Create email token (OTP)
+     *
+     * Sends the user an email 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 [POST
+     * /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession)
+     * endpoint to complete the login process. The secret sent to the user's email
+     * is valid for 15 minutes.
+     *
+     * A user is limited to 10 active sessions at a time by default. [Learn more
+     * about session
+     * limits](https://appwrite.io/docs/authentication-security#limits).
+     *
+     * @param {string} userId
+     * @param {string} email
+     * @param {boolean} phrase
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createEmailToken(userId: string, email: string, phrase?: boolean): Promise<Models.Token>;
+    /**
+     * Create magic URL token
+     *
+     * Sends the user an email with a secret key for creating a session. If the
+     * provided user ID has not been registered, a new user will be created. When
+     * the user clicks the link in the email, the user is redirected back to the
+     * URL you provided with the secret key and userId values attached to the URL
+     * query string. Use the query string parameters to submit a request to the
+     * [POST
+     * /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession)
+     * endpoint to complete the login process. The link sent to the user's email
+     * address is valid for 1 hour. If you are on a mobile device you can leave
+     * the URL parameter empty, so that the login completion will be handled by
+     * your Appwrite instance by default.
+     *
+     * A user is limited to 10 active sessions at a time by default. [Learn more
+     * about session
+     * limits](https://appwrite.io/docs/authentication-security#limits).
+     *
+     *
+     * @param {string} userId
+     * @param {string} email
+     * @param {string} url
+     * @param {boolean} phrase
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createMagicURLToken(userId: string, email: string, url?: string, phrase?: boolean): Promise<Models.Token>;
+    /**
+     * Create phone token
+     *
+     * Sends the user an SMS 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 [POST
+     * /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession)
+     * endpoint to complete the login process. The secret sent to the user's phone
+     * is valid for 15 minutes.
+     *
+     * A user is limited to 10 active sessions at a time by default. [Learn more
+     * about session
+     * limits](https://appwrite.io/docs/authentication-security#limits).
+     *
+     * @param {string} userId
+     * @param {string} phone
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createPhoneToken(userId: string, phone: string): Promise<Models.Token>;
     /**
      * Create email verification
      *

package/types/services/avatars.d.ts

@@ -1,5 +1,8 @@
 import { Service } from '../service';
 import { Client } from '../client';
+import { Browser } from '../enums/browser';
+import { CreditCard } from '../enums/credit-card';
+import { Flag } from '../enums/flag';
 export declare class Avatars extends Service {
     constructor(client: Client);
     /**
@@ -16,14 +19,14 @@ export declare class Avatars extends Service {
      * image at source quality. If dimensions are not specified, the default size
      * of image returned is 100x100px.
      *
-     * @param {string} code
+     * @param {Browser} code
      * @param {number} width
      * @param {number} height
      * @param {number} quality
      * @throws {AppwriteException}
      * @returns {URL}
     */
-    getBrowser(code: string, width?: number, height?: number, quality?: number): URL;
+    getBrowser(code: Browser, width?: number, height?: number, quality?: number): URL;
     /**
      * Get credit card icon
      *
@@ -37,14 +40,14 @@ export declare class Avatars extends Service {
      * of image returned is 100x100px.
      *
      *
-     * @param {string} code
+     * @param {CreditCard} code
      * @param {number} width
      * @param {number} height
      * @param {number} quality
      * @throws {AppwriteException}
      * @returns {URL}
     */
-    getCreditCard(code: string, width?: number, height?: number, quality?: number): URL;
+    getCreditCard(code: CreditCard, width?: number, height?: number, quality?: number): URL;
     /**
      * Get favicon
      *
@@ -71,14 +74,14 @@ export declare class Avatars extends Service {
      * of image returned is 100x100px.
      *
      *
-     * @param {string} code
+     * @param {Flag} code
      * @param {number} width
      * @param {number} height
      * @param {number} quality
      * @throws {AppwriteException}
      * @returns {URL}
     */
-    getFlag(code: string, width?: number, height?: number, quality?: number): URL;
+    getFlag(code: Flag, width?: number, height?: number, quality?: number): URL;
     /**
      * Get image from URL
      *

package/types/services/databases.d.ts

@@ -1,6 +1,10 @@
 import { Service } from '../service';
 import { Client } from '../client';
 import type { Models } from '../models';
+import { DatabaseUsageRange } from '../enums/database-usage-range';
+import { RelationshipType } from '../enums/relationship-type';
+import { RelationMutate } from '../enums/relation-mutate';
+import { IndexType } from '../enums/index-type';
 export declare class Databases extends Service {
     constructor(client: Client);
     /**
@@ -32,11 +36,11 @@ export declare class Databases extends Service {
      * Get usage stats for the database
      *
      *
-     * @param {string} range
+     * @param {DatabaseUsageRange} range
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    getUsage(range?: string): Promise<Models.UsageDatabases>;
+    getUsage(range?: DatabaseUsageRange): Promise<Models.UsageDatabases>;
     /**
      * Get database
      *
@@ -388,15 +392,15 @@ export declare class Databases extends Service {
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} relatedCollectionId
-     * @param {string} type
+     * @param {RelationshipType} type
      * @param {boolean} twoWay
      * @param {string} key
      * @param {string} twoWayKey
-     * @param {string} onDelete
+     * @param {RelationMutate} onDelete
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createRelationshipAttribute(databaseId: string, collectionId: string, relatedCollectionId: string, type: string, twoWay?: boolean, key?: string, twoWayKey?: string, onDelete?: string): Promise<Models.AttributeRelationship>;
+    createRelationshipAttribute(databaseId: string, collectionId: string, relatedCollectionId: string, type: RelationshipType, twoWay?: boolean, key?: string, twoWayKey?: string, onDelete?: RelationMutate): Promise<Models.AttributeRelationship>;
     /**
      * Create string attribute
      *
@@ -495,11 +499,11 @@ export declare class Databases extends Service {
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} key
-     * @param {string} onDelete
+     * @param {RelationMutate} onDelete
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateRelationshipAttribute(databaseId: string, collectionId: string, key: string, onDelete?: string): Promise<Models.AttributeRelationship>;
+    updateRelationshipAttribute(databaseId: string, collectionId: string, key: string, onDelete?: RelationMutate): Promise<Models.AttributeRelationship>;
     /**
      * List documents
      *
@@ -602,13 +606,13 @@ export declare class Databases extends Service {
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} key
-     * @param {string} type
+     * @param {IndexType} type
      * @param {string[]} attributes
      * @param {string[]} orders
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createIndex(databaseId: string, collectionId: string, key: string, type: string, attributes: string[], orders?: string[]): Promise<Models.Index>;
+    createIndex(databaseId: string, collectionId: string, key: string, type: IndexType, attributes: string[], orders?: string[]): Promise<Models.Index>;
     /**
      * Get index
      *
@@ -649,11 +653,11 @@ export declare class Databases extends Service {
      *
      * @param {string} databaseId
      * @param {string} collectionId
-     * @param {string} range
+     * @param {DatabaseUsageRange} range
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    getCollectionUsage(databaseId: string, collectionId: string, range?: string): Promise<Models.UsageCollection>;
+    getCollectionUsage(databaseId: string, collectionId: string, range?: DatabaseUsageRange): Promise<Models.UsageCollection>;
     /**
      * List database logs
      *
@@ -670,9 +674,9 @@ export declare class Databases extends Service {
      *
      *
      * @param {string} databaseId
-     * @param {string} range
+     * @param {DatabaseUsageRange} range
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    getDatabaseUsage(databaseId: string, range?: string): Promise<Models.UsageDatabase>;
+    getDatabaseUsage(databaseId: string, range?: DatabaseUsageRange): Promise<Models.UsageDatabase>;
 }

package/types/services/functions.d.ts

@@ -2,6 +2,9 @@ import { Service } from '../service';
 import { Client } from '../client';
 import type { Models } from '../models';
 import type { UploadProgress } from '../client';
+import { Runtime } from '../enums/runtime';
+import { FunctionUsageRange } from '../enums/function-usage-range';
+import { ExecutionMethod } from '../enums/execution-method';
 export declare class Functions extends Service {
     constructor(client: Client);
     /**
@@ -26,7 +29,7 @@ export declare class Functions extends Service {
      *
      * @param {string} functionId
      * @param {string} name
-     * @param {string} runtime
+     * @param {Runtime} runtime
      * @param {string[]} execute
      * @param {string[]} events
      * @param {string} schedule
@@ -47,7 +50,7 @@ export declare class Functions extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    create(functionId: string, name: string, runtime: string, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, templateRepository?: string, templateOwner?: string, templateRootDirectory?: string, templateBranch?: string): Promise<Models.Function>;
+    create(functionId: string, name: string, runtime: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string, templateRepository?: string, templateOwner?: string, templateRootDirectory?: string, templateBranch?: string): Promise<Models.Function>;
     /**
      * List runtimes
      *
@@ -61,11 +64,11 @@ export declare class Functions extends Service {
      * Get functions usage
      *
      *
-     * @param {string} range
+     * @param {FunctionUsageRange} range
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    getUsage(range?: string): Promise<Models.UsageFunctions>;
+    getUsage(range?: FunctionUsageRange): Promise<Models.UsageFunctions>;
     /**
      * Get function
      *
@@ -83,7 +86,7 @@ export declare class Functions extends Service {
      *
      * @param {string} functionId
      * @param {string} name
-     * @param {string} runtime
+     * @param {Runtime} runtime
      * @param {string[]} execute
      * @param {string[]} events
      * @param {string} schedule
@@ -100,7 +103,7 @@ export declare class Functions extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    update(functionId: string, name: string, runtime?: string, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string): Promise<Models.Function>;
+    update(functionId: string, name: string, runtime?: Runtime, execute?: string[], events?: string[], schedule?: string, timeout?: number, enabled?: boolean, logging?: boolean, entrypoint?: string, commands?: string, installationId?: string, providerRepositoryId?: string, providerBranch?: string, providerSilentMode?: boolean, providerRootDirectory?: string): Promise<Models.Function>;
     /**
      * Delete function
      *
@@ -232,12 +235,12 @@ export declare class Functions extends Service {
      * @param {string} body
      * @param {boolean} async
      * @param {string} xpath
-     * @param {string} method
+     * @param {ExecutionMethod} method
      * @param {object} headers
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createExecution(functionId: string, body?: string, async?: boolean, xpath?: string, method?: string, headers?: object): Promise<Models.Execution>;
+    createExecution(functionId: string, body?: string, async?: boolean, xpath?: string, method?: ExecutionMethod, headers?: object): Promise<Models.Execution>;
     /**
      * Get execution
      *
@@ -254,11 +257,11 @@ export declare class Functions extends Service {
      *
      *
      * @param {string} functionId
-     * @param {string} range
+     * @param {FunctionUsageRange} range
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    getFunctionUsage(functionId: string, range?: string): Promise<Models.UsageFunction>;
+    getFunctionUsage(functionId: string, range?: FunctionUsageRange): Promise<Models.UsageFunction>;
     /**
      * List variables
      *

package/types/services/health.d.ts

@@ -1,6 +1,7 @@
 import { Service } from '../service';
 import { Client } from '../client';
 import type { Models } from '../models';
+import { Name } from '../enums/name';
 export declare class Health extends Service {
     constructor(client: Client);
     /**
@@ -31,6 +32,16 @@ export declare class Health extends Service {
      * @returns {Promise}
     */
     getCache(): Promise<Models.HealthStatus>;
+    /**
+     * Get the SSL certificate for a domain
+     *
+     * Get the SSL certificate for a domain
+     *
+     * @param {string} domain
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getCertificate(domain?: string): Promise<Models.HealthCertificate>;
     /**
      * Get DB
      *
@@ -105,6 +116,18 @@ export declare class Health extends Service {
      * @returns {Promise}
     */
     getQueueDeletes(threshold?: number): Promise<Models.HealthQueue>;
+    /**
+     * Get number of failed queue jobs
+     *
+     * Returns the amount of failed jobs in a given queue.
+     *
+     *
+     * @param {Name} name
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getFailedJobs(name: Name, threshold?: number): Promise<Models.HealthQueue>;
     /**
      * Get functions queue
      *