@appwrite.io/console 0.1.0 → 0.2.0

package/src/models.ts

@@ -1082,6 +1082,59 @@ export namespace Models {
          */
         threads: number;
     }
+    /**
+     * Account
+     */
+    export type Account<Preferences extends Models.Preferences> = {
+        /**
+         * User ID.
+         */
+        $id: string;
+        /**
+         * User creation date in ISO 8601 format.
+         */
+        $createdAt: string;
+        /**
+         * User update date in ISO 8601 format.
+         */
+        $updatedAt: string;
+        /**
+         * User name.
+         */
+        name: string;
+        /**
+         * User registration date in ISO 8601 format.
+         */
+        registration: string;
+        /**
+         * User status. Pass `true` for enabled and `false` for disabled.
+         */
+        status: boolean;
+        /**
+         * Password update time in ISO 8601 format.
+         */
+        passwordUpdate: string;
+        /**
+         * User email address.
+         */
+        email: string;
+        /**
+         * User phone number in E.164 format.
+         */
+        phone: string;
+        /**
+         * Email verification status.
+         */
+        emailVerification: boolean;
+        /**
+         * Phone verification status.
+         */
+        phoneVerification: boolean;
+        /**
+         * User preferences as a key-value object
+         */
+        prefs: Preferences;
+    }
     /**
      * Preferences
      */
@@ -1492,14 +1545,6 @@ export namespace Models {
          * Function execution schedult in CRON format.
          */
         schedule: string;
-        /**
-         * Function&#039;s next scheduled execution time in ISO 8601 format.
-         */
-        scheduleNext: string;
-        /**
-         * Function&#039;s previous scheduled execution time in ISO 8601 format.
-         */
-        schedulePrevious: string;
         /**
          * Function execution timeout in seconds.
          */
@@ -2150,6 +2195,10 @@ export namespace Models {
      * Health Status
      */
     export type HealthStatus = {
+        /**
+         * Name of the service.
+         */
+        name: string;
         /**
          * Duration in milliseconds how long the health check took.
          */
@@ -2200,63 +2249,15 @@ export namespace Models {
         /**
          * Aggregated stats for total number of documents.
          */
-        databasesCount: Metric[];
-        /**
-         * Aggregated stats for total number of documents.
-         */
-        documentsCount: Metric[];
-        /**
-         * Aggregated stats for total number of collections.
-         */
-        collectionsCount: Metric[];
-        /**
-         * Aggregated stats for documents created.
-         */
-        databasesCreate: Metric[];
-        /**
-         * Aggregated stats for documents read.
-         */
-        databasesRead: Metric[];
-        /**
-         * Aggregated stats for documents updated.
-         */
-        databasesUpdate: Metric[];
+        databasesTotal: Metric[];
         /**
          * Aggregated stats for total number of collections.
          */
-        databasesDelete: Metric[];
-        /**
-         * Aggregated stats for documents created.
-         */
-        documentsCreate: Metric[];
-        /**
-         * Aggregated stats for documents read.
-         */
-        documentsRead: Metric[];
-        /**
-         * Aggregated stats for documents updated.
-         */
-        documentsUpdate: Metric[];
-        /**
-         * Aggregated stats for documents deleted.
-         */
-        documentsDelete: Metric[];
+        collectionsTotal: Metric[];
         /**
-         * Aggregated stats for collections created.
-         */
-        collectionsCreate: Metric[];
-        /**
-         * Aggregated stats for collections read.
-         */
-        collectionsRead: Metric[];
-        /**
-         * Aggregated stats for collections updated.
-         */
-        collectionsUpdate: Metric[];
-        /**
-         * Aggregated stats for collections delete.
+         * Aggregated stats for total number of documents.
          */
-        collectionsDelete: Metric[];
+        documentsTotal: Metric[];
     }
     /**
      * UsageDatabase
@@ -2266,46 +2267,14 @@ export namespace Models {
          * The time range of the usage stats.
          */
         range: string;
-        /**
-         * Aggregated stats for total number of documents.
-         */
-        documentsCount: Metric[];
         /**
          * Aggregated stats for total number of collections.
          */
-        collectionsCount: Metric[];
+        collectionsTotal: Metric[];
         /**
-         * Aggregated stats for documents created.
-         */
-        documentsCreate: Metric[];
-        /**
-         * Aggregated stats for documents read.
-         */
-        documentsRead: Metric[];
-        /**
-         * Aggregated stats for documents updated.
-         */
-        documentsUpdate: Metric[];
-        /**
-         * Aggregated stats for documents deleted.
-         */
-        documentsDelete: Metric[];
-        /**
-         * Aggregated stats for collections created.
-         */
-        collectionsCreate: Metric[];
-        /**
-         * Aggregated stats for collections read.
-         */
-        collectionsRead: Metric[];
-        /**
-         * Aggregated stats for collections updated.
-         */
-        collectionsUpdate: Metric[];
-        /**
-         * Aggregated stats for collections delete.
+         * Aggregated stats for total number of documents.
          */
-        collectionsDelete: Metric[];
+        documentsTotal: Metric[];
     }
     /**
      * UsageCollection
@@ -2318,23 +2287,7 @@ export namespace Models {
         /**
          * Aggregated stats for total number of documents.
          */
-        documentsCount: Metric[];
-        /**
-         * Aggregated stats for documents created.
-         */
-        documentsCreate: Metric[];
-        /**
-         * Aggregated stats for documents read.
-         */
-        documentsRead: Metric[];
-        /**
-         * Aggregated stats for documents updated.
-         */
-        documentsUpdate: Metric[];
-        /**
-         * Aggregated stats for documents deleted.
-         */
-        documentsDelete: Metric[];
+        documentsTotal: Metric[];
     }
     /**
      * UsageUsers
@@ -2347,35 +2300,11 @@ export namespace Models {
         /**
          * Aggregated stats for total number of users.
          */
-        usersCount: Metric[];
-        /**
-         * Aggregated stats for users created.
-         */
-        usersCreate: Metric[];
-        /**
-         * Aggregated stats for users read.
-         */
-        usersRead: Metric[];
-        /**
-         * Aggregated stats for users updated.
-         */
-        usersUpdate: Metric[];
-        /**
-         * Aggregated stats for users deleted.
-         */
-        usersDelete: Metric[];
+        usersTotal: Metric[];
         /**
          * Aggregated stats for sessions created.
          */
-        sessionsCreate: Metric[];
-        /**
-         * Aggregated stats for sessions created for a provider ( email, anonymous or oauth2 ).
-         */
-        sessionsProviderCreate: Metric[];
-        /**
-         * Aggregated stats for sessions deleted.
-         */
-        sessionsDelete: Metric[];
+        sessionsTotal: Metric[];
     }
     /**
      * StorageUsage
@@ -2385,50 +2314,18 @@ export namespace Models {
          * The time range of the usage stats.
          */
         range: string;
-        /**
-         * Aggregated stats for the occupied storage size (in bytes).
-         */
-        storage: Metric[];
-        /**
-         * Aggregated stats for total number of files.
-         */
-        filesCount: Metric[];
         /**
          * Aggregated stats for total number of buckets.
          */
-        bucketsCount: Metric[];
-        /**
-         * Aggregated stats for buckets created.
-         */
-        bucketsCreate: Metric[];
-        /**
-         * Aggregated stats for buckets read.
-         */
-        bucketsRead: Metric[];
+        bucketsTotal: Metric[];
         /**
-         * Aggregated stats for buckets updated.
-         */
-        bucketsUpdate: Metric[];
-        /**
-         * Aggregated stats for buckets deleted.
-         */
-        bucketsDelete: Metric[];
-        /**
-         * Aggregated stats for files created.
-         */
-        filesCreate: Metric[];
-        /**
-         * Aggregated stats for files read.
-         */
-        filesRead: Metric[];
-        /**
-         * Aggregated stats for files updated.
+         * Aggregated stats for total number of files.
          */
-        filesUpdate: Metric[];
+        filesTotal: Metric[];
         /**
-         * Aggregated stats for files deleted.
+         * Aggregated stats for the occupied storage size (in bytes).
          */
-        filesDelete: Metric[];
+        filesStorage: Metric[];
     }
     /**
      * UsageBuckets
@@ -2441,27 +2338,11 @@ export namespace Models {
         /**
          * Aggregated stats for total number of files in this bucket.
          */
-        filesCount: Metric[];
+        filesTotal: Metric[];
         /**
          * Aggregated stats for total storage of files in this bucket.
          */
         filesStorage: Metric[];
-        /**
-         * Aggregated stats for files created.
-         */
-        filesCreate: Metric[];
-        /**
-         * Aggregated stats for files read.
-         */
-        filesRead: Metric[];
-        /**
-         * Aggregated stats for files updated.
-         */
-        filesUpdate: Metric[];
-        /**
-         * Aggregated stats for files deleted.
-         */
-        filesDelete: Metric[];
     }
     /**
      * UsageFunctions
@@ -2472,37 +2353,37 @@ export namespace Models {
          */
         range: string;
         /**
-         * Aggregated stats for number of function executions.
-         */
-        executionsTotal: Metric[];
-        /**
-         * Aggregated stats for function execution failures.
+         * Aggregated stats for number of functions.
          */
-        executionsFailure: Metric[];
+        functionsTotal: Metric[];
         /**
-         * Aggregated stats for function execution successes.
+         * Aggregated stats for number of function deployments.
          */
-        executionsSuccess: Metric[];
+        deploymentsTotal: Metric[];
         /**
-         * Aggregated stats for function execution duration.
+         * Aggregated stats for function deployments storage.
          */
-        executionsTime: Metric[];
+        deploymentsStorage: Metric[];
         /**
          * Aggregated stats for number of function builds.
          */
         buildsTotal: Metric[];
         /**
-         * Aggregated stats for function build failures.
+         * Aggregated stats for builds  storage.
          */
-        buildsFailure: Metric[];
+        buildsStorage: Metric[];
         /**
-         * Aggregated stats for function build successes.
+         * Aggregated stats for function build compute.
          */
-        buildsSuccess: Metric[];
+        buildsTime: Metric[];
         /**
-         * Aggregated stats for function build duration.
+         * Aggregated stats for number of function executions.
          */
-        buildsTime: Metric[];
+        executionsTotal: Metric[];
+        /**
+         * Aggregated stats for function execution compute.
+         */
+        executionsTime: Metric[];
     }
     /**
      * UsageProject
@@ -2515,7 +2396,7 @@ export namespace Models {
         /**
          * Aggregated stats for number of requests.
          */
-        requests: Metric[];
+        requestsTotal: Metric[];
         /**
          * Aggregated stats for consumed bandwidth.
          */
@@ -2523,26 +2404,47 @@ export namespace Models {
         /**
          * Aggregated stats for function executions.
          */
-        executions: Metric[];
+        executionsTotal: Metric[];
         /**
          * Aggregated stats for number of documents.
          */
-        documents: Metric[];
+        documentsTotal: Metric[];
         /**
          * Aggregated stats for number of databases.
          */
-        databases: Metric[];
+        databasesTotal: Metric[];
         /**
          * Aggregated stats for number of users.
          */
-        users: Metric[];
+        usersTotal: Metric[];
         /**
          * Aggregated stats for the occupied storage size (in bytes).
          */
-        storage: Metric[];
+        filesStorage: Metric[];
         /**
          * Aggregated stats for number of buckets.
          */
-        buckets: Metric[];
+        bucketsTotal: Metric[];
+    }
+    /**
+     * Console Variables
+     */
+    export type ConsoleVariables = {
+        /**
+         * CNAME target for your Appwrite custom domains.
+         */
+        _APP_DOMAIN_TARGET: string;
+        /**
+         * Maximum file size allowed for file upload in bytes.
+         */
+        _APP_STORAGE_LIMIT: number;
+        /**
+         * Maximum file size allowed for deployment in bytes.
+         */
+        _APP_FUNCTIONS_SIZE_LIMIT: number;
+        /**
+         * Defines if usage stats are enabled. This value is set to &#039;enabled&#039; by default, to disable the usage stats set the value to &#039;disabled&#039;.
+         */
+        _APP_USAGE_STATS: string;
     }
 }

package/src/query.ts

@@ -21,6 +21,24 @@ export class Query {
   static greaterThanEqual = (attribute: string, value: QueryTypes): string =>
     Query.addQuery(attribute, "greaterThanEqual", value);
 
+  static isNull = (attribute: string): string =>
+    `isNull("${attribute}")`;
+
+  static isNotNull = (attribute: string): string =>
+    `isNotNull("${attribute}")`;
+
+  static between = (attribute: string, start: string|number, end: string|number): string =>
+    `between("${attribute}", [${Query.parseValues(start)},${Query.parseValues(end)}])`;
+
+  static startsWith = (attribute: string, value: string): string =>
+    Query.addQuery(attribute, "startsWith", value);
+
+  static endsWith = (attribute: string, value: string): string =>
+    Query.addQuery(attribute, "endsWith", value);
+
+  static select = (attributes: string[]): string =>
+    `select([${attributes.map((attr: string) => `"${attr}"`).join(",")}])`;
+
   static search = (attribute: string, value: string): string =>
     Query.addQuery(attribute, "search", value);
 

package/src/services/account.ts

@@ -126,6 +126,66 @@ export class Account extends Service {
             }, payload);
         }
 
+        /**
+         * Create account using an invite code
+         *
+         * Use this endpoint to allow a new user to register a new account in your
+         * project. After the user registration completes successfully, you can use
+         * the [/account/verfication](/docs/client/account#accountCreateVerification)
+         * route to start verifying the user email address. To allow the new user to
+         * login to their new account, you need to create a new [account
+         * session](/docs/client/account#accountCreateSession).
+         *
+         * @param {string} userId
+         * @param {string} email
+         * @param {string} password
+         * @param {string} name
+         * @param {string} code
+         * @throws {AppwriteException}
+         * @returns {Promise}
+         */
+        async createWithInviteCode<Preferences extends Models.Preferences>(userId: string, email: string, password: string, name?: string, code?: string): Promise<Models.Account<Preferences>> {
+            if (typeof userId === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "userId"');
+            }
+
+            if (typeof email === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "email"');
+            }
+
+            if (typeof password === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "password"');
+            }
+
+            let path = '/account/invite';
+            let payload: Payload = {};
+
+            if (typeof userId !== 'undefined') {
+                payload['userId'] = userId;
+            }
+
+            if (typeof email !== 'undefined') {
+                payload['email'] = email;
+            }
+
+            if (typeof password !== 'undefined') {
+                payload['password'] = password;
+            }
+
+            if (typeof name !== 'undefined') {
+                payload['name'] = name;
+            }
+
+            if (typeof code !== 'undefined') {
+                payload['code'] = code;
+            }
+
+            const uri = new URL(this.client.config.endpoint + path);
+            return await this.client.call('post', uri, {
+                'content-type': 'application/json',
+            }, payload);
+        }
+
         /**
          * Create JWT
          *

package/src/services/console.ts

@@ -0,0 +1,30 @@
+import { Service } from '../service';
+import { AppwriteException, Client } from '../client';
+import type { Models } from '../models';
+import type { UploadProgress, Payload } from '../client';
+
+export class Console extends Service {
+
+     constructor(client: Client)
+     {
+        super(client);
+     }
+
+        /**
+         * Get Variables
+         *
+         * Get all Environment Variables that are relevant for the console.
+         *
+         * @throws {AppwriteException}
+         * @returns {Promise}
+         */
+        async variables(): Promise<Models.ConsoleVariables> {
+            let path = '/console/variables';
+            let payload: Payload = {};
+
+            const uri = new URL(this.client.config.endpoint + path);
+            return await this.client.call('get', uri, {
+                'content-type': 'application/json',
+            }, payload);
+        }
+};

package/src/services/databases.ts

@@ -472,7 +472,7 @@ export class Databases extends Service {
          * @throws {AppwriteException}
          * @returns {Promise}
          */
-        async updateBooleanAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault: boolean): Promise<Models.AttributeBoolean> {
+        async updateBooleanAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: boolean): Promise<Models.AttributeBoolean> {
             if (typeof databaseId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "databaseId"');
             }
@@ -577,7 +577,7 @@ export class Databases extends Service {
          * @throws {AppwriteException}
          * @returns {Promise}
          */
-        async updateDatetimeAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault: string): Promise<Models.AttributeDatetime> {
+        async updateDatetimeAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeDatetime> {
             if (typeof databaseId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "databaseId"');
             }
@@ -687,7 +687,7 @@ export class Databases extends Service {
          * @throws {AppwriteException}
          * @returns {Promise}
          */
-        async updateEmailAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault: string): Promise<Models.AttributeEmail> {
+        async updateEmailAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeEmail> {
             if (typeof databaseId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "databaseId"');
             }
@@ -805,7 +805,7 @@ export class Databases extends Service {
          * @throws {AppwriteException}
          * @returns {Promise}
          */
-        async updateEnumAttribute(databaseId: string, collectionId: string, key: string, elements: string[], required: boolean, xdefault: string): Promise<Models.AttributeEnum> {
+        async updateEnumAttribute(databaseId: string, collectionId: string, key: string, elements: string[], required: boolean, xdefault?: string): Promise<Models.AttributeEnum> {
             if (typeof databaseId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "databaseId"');
             }
@@ -936,7 +936,7 @@ export class Databases extends Service {
          * @throws {AppwriteException}
          * @returns {Promise}
          */
-        async updateFloatAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault: number): Promise<Models.AttributeFloat> {
+        async updateFloatAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault?: number): Promise<Models.AttributeFloat> {
             if (typeof databaseId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "databaseId"');
             }
@@ -1075,7 +1075,7 @@ export class Databases extends Service {
          * @throws {AppwriteException}
          * @returns {Promise}
          */
-        async updateIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault: number): Promise<Models.AttributeInteger> {
+        async updateIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min: number, max: number, xdefault?: number): Promise<Models.AttributeInteger> {
             if (typeof databaseId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "databaseId"');
             }
@@ -1201,7 +1201,7 @@ export class Databases extends Service {
          * @throws {AppwriteException}
          * @returns {Promise}
          */
-        async updateIpAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault: string): Promise<Models.AttributeIp> {
+        async updateIpAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeIp> {
             if (typeof databaseId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "databaseId"');
             }
@@ -1243,7 +1243,7 @@ export class Databases extends Service {
          * Create Relationship Attribute
          *
          * Create relationship attribute. [Learn more about relationship
-         * attributes](docs/databases-relationships#relationship-attributes).
+         * attributes](/docs/databases-relationships#relationship-attributes).
          * 
          *
          * @param {string} databaseId
@@ -1388,7 +1388,7 @@ export class Databases extends Service {
          * @throws {AppwriteException}
          * @returns {Promise}
          */
-        async updateStringAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault: string): Promise<Models.AttributeString> {
+        async updateStringAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeString> {
             if (typeof databaseId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "databaseId"');
             }
@@ -1498,7 +1498,7 @@ export class Databases extends Service {
          * @throws {AppwriteException}
          * @returns {Promise}
          */
-        async updateUrlAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault: string): Promise<Models.AttributeUrl> {
+        async updateUrlAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string): Promise<Models.AttributeUrl> {
             if (typeof databaseId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "databaseId"');
             }
@@ -1604,7 +1604,7 @@ export class Databases extends Service {
          * Update Relationship Attribute
          *
          * Update relationship attribute. [Learn more about relationship
-         * attributes](docs/databases-relationships#relationship-attributes).
+         * attributes](/docs/databases-relationships#relationship-attributes).
          * 
          *
          * @param {string} databaseId