@appwrite.io/console 0.6.1 → 0.6.4

package/types/id.d.ts

@@ -1,5 +1,20 @@
+/**
+ * Helper class to generate ID strings for resources.
+ */
 export declare class ID {
     #private;
+    /**
+     * Uses the provided ID as the ID for the resource.
+     *
+     * @param {string} id
+     * @returns {string}
+     */
     static custom(id: string): string;
+    /**
+     * Have Appwrite generate a unique ID for you.
+     *
+     * @param {number} padding. Default is 7.
+     * @returns {string}
+     */
     static unique(padding?: number): string;
 }

package/types/index.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Appwrite Console SDK
+ *
+ * This SDK is compatible with Appwrite server version 1.5.x.
+ * For older versions, please check
+ * [previous releases](https://github.com/appwrite/sdk-for-console/releases).
+ */
 export { Client, Query, AppwriteException } from './client';
 export { Account } from './services/account';
 export { Avatars } from './services/avatars';

package/types/models.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Appwrite Models
+ */
 export declare namespace Models {
     /**
      * Documents List
@@ -493,6 +496,19 @@ export declare namespace Models {
          */
         projects: FirebaseProject[];
     };
+    /**
+     * Specifications List
+     */
+    type SpecificationList = {
+        /**
+         * Total number of specifications documents that matched your query.
+         */
+        total: number;
+        /**
+         * List of specifications.
+         */
+        specifications: Specification[];
+    };
     /**
      * Database
      */
@@ -1320,6 +1336,10 @@ export declare namespace Models {
          * Session creation date in ISO 8601 format.
          */
         $createdAt: string;
+        /**
+         * Session update date in ISO 8601 format.
+         */
+        $updatedAt: string;
         /**
          * User ID.
          */
@@ -1834,6 +1854,10 @@ export declare namespace Models {
          * Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests
          */
         providerSilentMode: boolean;
+        /**
+         * Function execution and builds machine specification.
+         */
+        specification: string;
     };
     /**
      * Installation
@@ -2922,6 +2946,10 @@ export declare namespace Models {
          * Total aggregated sum of functions build compute time.
          */
         buildsTimeTotal: number;
+        /**
+         * Total aggregated sum of functions build mbSeconds.
+         */
+        buildsMbSecondsTotal: number;
         /**
          * Total  aggregated number of functions execution.
          */
@@ -2930,6 +2958,10 @@ export declare namespace Models {
          * Total aggregated sum of functions  execution compute time.
          */
         executionsTimeTotal: number;
+        /**
+         * Total aggregated sum of functions execution mbSeconds.
+         */
+        executionsMbSecondsTotal: number;
         /**
          * Aggregated number of functions per period.
          */
@@ -2954,6 +2986,10 @@ export declare namespace Models {
          * Aggregated sum of  functions build compute time per period.
          */
         buildsTime: Metric[];
+        /**
+         * Aggregated sum of functions build mbSeconds per period.
+         */
+        buildsMbSeconds: Metric[];
         /**
          * Aggregated number of  functions execution per period.
          */
@@ -2962,6 +2998,10 @@ export declare namespace Models {
          * Aggregated number of functions execution compute time per period.
          */
         executionsTime: Metric[];
+        /**
+         * Aggregated number of functions mbSeconds per period.
+         */
+        executionsMbSeconds: Metric[];
     };
     /**
      * UsageFunction
@@ -2991,6 +3031,10 @@ export declare namespace Models {
          * Total aggregated sum of function builds compute time.
          */
         buildsTimeTotal: number;
+        /**
+         * Total aggregated sum of function builds mbSeconds.
+         */
+        buildsMbSecondsTotal: number;
         /**
          * Total  aggregated number of function executions.
          */
@@ -2999,6 +3043,10 @@ export declare namespace Models {
          * Total aggregated sum of function  executions compute time.
          */
         executionsTimeTotal: number;
+        /**
+         * Total aggregated sum of function executions mbSeconds.
+         */
+        executionsMbSecondsTotal: number;
         /**
          * Aggregated number of function deployments per period.
          */
@@ -3019,6 +3067,10 @@ export declare namespace Models {
          * Aggregated sum of function builds compute time per period.
          */
         buildsTime: Metric[];
+        /**
+         * Aggregated number of function builds mbSeconds per period.
+         */
+        buildsMbSeconds: Metric[];
         /**
          * Aggregated number of function executions per period.
          */
@@ -3027,6 +3079,10 @@ export declare namespace Models {
          * Aggregated number of function executions compute time per period.
          */
         executionsTime: Metric[];
+        /**
+         * Aggregated number of function mbSeconds per period.
+         */
+        executionsMbSeconds: Metric[];
     };
     /**
      * UsageProject
@@ -3052,10 +3108,22 @@ export declare namespace Models {
          * Total aggregated sum of files storage size (in bytes).
          */
         filesStorageTotal: number;
+        /**
+         * Total aggregated sum of deployments storage size (in bytes).
+         */
+        deploymentsStorageTotal: number;
         /**
          * Total aggregated number of buckets.
          */
         bucketsTotal: number;
+        /**
+         * Total aggregated number of function executions mbSeconds.
+         */
+        executionsMbSecondsTotal: number;
+        /**
+         * Total aggregated number of function builds mbSeconds.
+         */
+        buildsMbSecondsTotal: number;
         /**
          * Aggregated  number of requests per period.
          */
@@ -3080,6 +3148,18 @@ export declare namespace Models {
          * Aggregated breakdown in totals of usage by buckets.
          */
         bucketsBreakdown: MetricBreakdown[];
+        /**
+         * Aggregated breakdown in totals of execution mbSeconds by functions.
+         */
+        executionsMbSecondsBreakdown: MetricBreakdown[];
+        /**
+         * Aggregated breakdown in totals of build mbSeconds by functions.
+         */
+        buildsMbSecondsBreakdown: MetricBreakdown[];
+        /**
+         * Aggregated breakdown in totals of deployments storage size (in bytes).
+         */
+        deploymentsStorageBreakdown: MetricBreakdown[];
     };
     /**
      * Headers
@@ -3094,6 +3174,27 @@ export declare namespace Models {
          */
         value: string;
     };
+    /**
+     * Specification
+     */
+    type Specification = {
+        /**
+         * Memory size in MB.
+         */
+        memory: number;
+        /**
+         * Number of CPUs.
+         */
+        cpus: number;
+        /**
+         * Is size enabled.
+         */
+        enabled: boolean;
+        /**
+         * Size slug.
+         */
+        slug: string;
+    };
     /**
      * Rule
      */
@@ -3266,17 +3367,21 @@ export declare namespace Models {
      */
     type MfaFactors = {
         /**
-         * TOTP
+         * Can TOTP be used for MFA challenge for this account.
          */
         totp: boolean;
         /**
-         * Phone
+         * Can phone (SMS) be used for MFA challenge for this account.
          */
         phone: boolean;
         /**
-         * Email
+         * Can email be used for MFA challenge for this account.
          */
         email: boolean;
+        /**
+         * Can recovery code be used for MFA challenge for this account.
+         */
+        recoveryCode: boolean;
     };
     /**
      * Provider

package/types/permission.d.ts

@@ -1,7 +1,43 @@
+/**
+ * Helper class to generate permission strings for resources.
+ */
 export declare class Permission {
+    /**
+     * Generate read permission string for the provided role.
+     *
+     * @param {string} role
+     * @returns {string}
+     */
     static read: (role: string) => string;
+    /**
+     * Generate write permission string for the provided role.
+     *
+     * This is an alias of update, delete, and possibly create.
+     * Don't use write in combination with update, delete, or create.
+     *
+     * @param {string} role
+     * @returns {string}
+     */
     static write: (role: string) => string;
+    /**
+     * Generate create permission string for the provided role.
+     *
+     * @param {string} role
+     * @returns {string}
+     */
     static create: (role: string) => string;
+    /**
+     * Generate update permission string for the provided role.
+     *
+     * @param {string} role
+     * @returns {string}
+     */
     static update: (role: string) => string;
+    /**
+     * Generate delete permission string for the provided role.
+     *
+     * @param {string} role
+     * @returns {string}
+     */
     static delete: (role: string) => string;
 }

package/types/query.d.ts

@@ -2,33 +2,193 @@ declare type QueryTypesSingle = string | number | boolean;
 export declare type QueryTypesList = string[] | number[] | boolean[] | Query[];
 export declare type QueryTypes = QueryTypesSingle | QueryTypesList;
 declare type AttributesTypes = string | string[];
+/**
+ * Helper class to generate query strings.
+ */
 export declare class Query {
     method: string;
     attribute: AttributesTypes | undefined;
     values: QueryTypesList | undefined;
+    /**
+     * Constructor for Query class.
+     *
+     * @param {string} method
+     * @param {AttributesTypes} attribute
+     * @param {QueryTypes} values
+     */
     constructor(method: string, attribute?: AttributesTypes, values?: QueryTypes);
+    /**
+     * Convert the query object to a JSON string.
+     *
+     * @returns {string}
+     */
     toString(): string;
+    /**
+     * Filter resources where attribute is equal to value.
+     *
+     * @param {string} attribute
+     * @param {QueryTypes} value
+     * @returns {string}
+     */
     static equal: (attribute: string, value: QueryTypes) => string;
+    /**
+     * Filter resources where attribute is not equal to value.
+     *
+     * @param {string} attribute
+     * @param {QueryTypes} value
+     * @returns {string}
+     */
     static notEqual: (attribute: string, value: QueryTypes) => string;
+    /**
+     * Filter resources where attribute is less than value.
+     *
+     * @param {string} attribute
+     * @param {QueryTypes} value
+     * @returns {string}
+     */
     static lessThan: (attribute: string, value: QueryTypes) => string;
+    /**
+     * Filter resources where attribute is less than or equal to value.
+     *
+     * @param {string} attribute
+     * @param {QueryTypes} value
+     * @returns {string}
+     */
     static lessThanEqual: (attribute: string, value: QueryTypes) => string;
+    /**
+     * Filter resources where attribute is greater than value.
+     *
+     * @param {string} attribute
+     * @param {QueryTypes} value
+     * @returns {string}
+     */
     static greaterThan: (attribute: string, value: QueryTypes) => string;
+    /**
+     * Filter resources where attribute is greater than or equal to value.
+     *
+     * @param {string} attribute
+     * @param {QueryTypes} value
+     * @returns {string}
+     */
     static greaterThanEqual: (attribute: string, value: QueryTypes) => string;
+    /**
+     * Filter resources where attribute is null.
+     *
+     * @param {string} attribute
+     * @returns {string}
+     */
     static isNull: (attribute: string) => string;
+    /**
+     * Filter resources where attribute is not null.
+     *
+     * @param {string} attribute
+     * @returns {string}
+     */
     static isNotNull: (attribute: string) => string;
+    /**
+     * Filter resources where attribute is between start and end (inclusive).
+     *
+     * @param {string} attribute
+     * @param {string | number} start
+     * @param {string | number} end
+     * @returns {string}
+     */
     static between: (attribute: string, start: string | number, end: string | number) => string;
+    /**
+     * Filter resources where attribute starts with value.
+     *
+     * @param {string} attribute
+     * @param {string} value
+     * @returns {string}
+     */
     static startsWith: (attribute: string, value: string) => string;
+    /**
+     * Filter resources where attribute ends with value.
+     *
+     * @param {string} attribute
+     * @param {string} value
+     * @returns {string}
+     */
     static endsWith: (attribute: string, value: string) => string;
+    /**
+     * Specify which attributes should be returned by the API call.
+     *
+     * @param {string[]} attributes
+     * @returns {string}
+     */
     static select: (attributes: string[]) => string;
+    /**
+     * Filter resources by searching attribute for value.
+     * A fulltext index on attribute is required for this query to work.
+     *
+     * @param {string} attribute
+     * @param {string} value
+     * @returns {string}
+     */
     static search: (attribute: string, value: string) => string;
+    /**
+     * Sort results by attribute descending.
+     *
+     * @param {string} attribute
+     * @returns {string}
+     */
     static orderDesc: (attribute: string) => string;
+    /**
+     * Sort results by attribute ascending.
+     *
+     * @param {string} attribute
+     * @returns {string}
+     */
     static orderAsc: (attribute: string) => string;
+    /**
+     * Return results after documentId.
+     *
+     * @param {string} documentId
+     * @returns {string}
+     */
     static cursorAfter: (documentId: string) => string;
+    /**
+     * Return results before documentId.
+     *
+     * @param {string} documentId
+     * @returns {string}
+     */
     static cursorBefore: (documentId: string) => string;
+    /**
+     * Return only limit results.
+     *
+     * @param {number} limit
+     * @returns {string}
+     */
     static limit: (limit: number) => string;
+    /**
+     * Filter resources by skipping the first offset results.
+     *
+     * @param {number} offset
+     * @returns {string}
+     */
     static offset: (offset: number) => string;
+    /**
+     * Filter resources where attribute contains the specified value.
+     *
+     * @param {string} attribute
+     * @param {string | string[]} value
+     * @returns {string}
+     */
     static contains: (attribute: string, value: string | string[]) => string;
+    /**
+     * Combine multiple queries using logical OR operator.
+     *
+     * @param {string[]} queries
+     * @returns {string}
+     */
     static or: (queries: string[]) => string;
+    /**
+     * Combine multiple queries using logical AND operator.
+     *
+     * @param {string[]} queries
+     * @returns {string}
+     */
     static and: (queries: string[]) => string;
 }
 export {};

package/types/service.d.ts

@@ -1,6 +1,9 @@
 import { Client } from './client';
 import type { Payload } from './client';
 export declare class Service {
+    /**
+     * The size for chunked uploads in bytes.
+     */
     static CHUNK_SIZE: number;
     client: Client;
     constructor(client: Client);

package/types/services/account.d.ts

@@ -116,11 +116,11 @@ export declare class Account extends Service {
     */
     updateMFA<Preferences extends Models.Preferences>(mfa: boolean): Promise<Models.User<Preferences>>;
     /**
-     * Add Authenticator
+     * Create Authenticator
      *
      * Add an authenticator app to be used as an MFA factor. Verify the
      * authenticator using the [verify
-     * authenticator](/docs/references/cloud/client-web/account#verifyAuthenticator)
+     * authenticator](/docs/references/cloud/client-web/account#updateMfaAuthenticator)
      * method.
      *
      * @param {AuthenticatorType} type
@@ -132,7 +132,7 @@ export declare class Account extends Service {
      * Verify Authenticator
      *
      * Verify an authenticator app after adding it using the [add
-     * authenticator](/docs/references/cloud/client-web/account#addAuthenticator)
+     * authenticator](/docs/references/cloud/client-web/account#createMfaAuthenticator)
      * method.
      *
      * @param {AuthenticatorType} type
@@ -151,9 +151,9 @@ export declare class Account extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    deleteMfaAuthenticator<Preferences extends Models.Preferences>(type: AuthenticatorType, otp: string): Promise<Models.User<Preferences>>;
+    deleteMfaAuthenticator(type: AuthenticatorType, otp: string): Promise<{}>;
     /**
-     * Create 2FA Challenge
+     * Create MFA Challenge
      *
      * Begin the process of MFA verification after sign-in. Finish the flow with
      * [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge)
@@ -669,7 +669,7 @@ export declare class Account extends Service {
     */
     createPhoneVerification(): Promise<Models.Token>;
     /**
-     * Create phone verification (confirmation)
+     * Update phone verification (confirmation)
      *
      * Use this endpoint to complete the user phone verification process. Use the
      * **userId** and **secret** that were sent to your user's phone number to

package/types/services/functions.d.ts

@@ -47,10 +47,11 @@ export declare class Functions extends Service {
      * @param {string} templateOwner
      * @param {string} templateRootDirectory
      * @param {string} templateBranch
+     * @param {string} specification
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    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>;
+    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, specification?: string): Promise<Models.Function>;
     /**
      * List runtimes
      *
@@ -60,6 +61,16 @@ export declare class Functions extends Service {
      * @returns {Promise}
     */
     listRuntimes(): Promise<Models.RuntimeList>;
+    /**
+     * Get available function runtime specifications
+     *
+     * Get allowed function specifications for this instance.
+     *
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    getSpecifications(): Promise<Models.SpecificationList>;
     /**
      * Get functions usage
      *
@@ -100,10 +111,11 @@ export declare class Functions extends Service {
      * @param {string} providerBranch
      * @param {boolean} providerSilentMode
      * @param {string} providerRootDirectory
+     * @param {string} specification
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    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>;
+    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, specification?: string): Promise<Models.Function>;
     /**
      * Delete function
      *
@@ -162,7 +174,7 @@ export declare class Functions extends Service {
     */
     getDeployment(functionId: string, deploymentId: string): Promise<Models.Deployment>;
     /**
-     * Update function deployment
+     * Update deployment
      *
      * Update the function code deployment ID using the unique function ID. Use
      * this endpoint to switch the code deployment that should be executed by the
@@ -199,7 +211,7 @@ export declare class Functions extends Service {
     */
     createBuild(functionId: string, deploymentId: string, buildId: string): Promise<{}>;
     /**
-     * Download Deployment
+     * Download deployment
      *
      * Get a Deployment's contents by its unique ID. This endpoint supports range
      * requests for partial or streaming file download.

package/types/services/messaging.d.ts

@@ -53,10 +53,11 @@ export declare class Messaging extends Service {
      * @param {string[]} cc
      * @param {string[]} bcc
      * @param {string} scheduledAt
+     * @param {string[]} attachments
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateEmail(messageId: string, topics?: string[], users?: string[], targets?: string[], subject?: string, content?: string, draft?: boolean, html?: boolean, cc?: string[], bcc?: string[], scheduledAt?: string): Promise<Models.Message>;
+    updateEmail(messageId: string, topics?: string[], users?: string[], targets?: string[], subject?: string, content?: string, draft?: boolean, html?: boolean, cc?: string[], bcc?: string[], scheduledAt?: string, attachments?: string[]): Promise<Models.Message>;
     /**
      * Create push notification
      *

package/types/services/users.d.ts

@@ -508,12 +508,12 @@ export declare class Users extends Service {
     /**
      * 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)
+     * Returns a token with a secret key for creating a session. Use the user ID
+     * and secret and submit a request to the [PUT
+     * /account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession)
      * endpoint to complete the login process.
      *
+     *
      * @param {string} userId
      * @param {number} length
      * @param {number} expire