@appwrite.io/console 0.6.2 → 0.7.0-rc.1

package/src/models.ts

@@ -1,3 +1,6 @@
+/**
+ * Appwrite Models
+ */
 export namespace Models {
     /**
      * Documents List
@@ -168,6 +171,19 @@ export namespace Models {
          */
         functions: Function[];
     }
+    /**
+     * Function Templates List
+     */
+    export type TemplateFunctionList = {
+        /**
+         * Total number of templates documents that matched your query.
+         */
+        total: number;
+        /**
+         * List of templates.
+         */
+        templates: TemplateFunction[];
+    }
     /**
      * Installations List
      */
@@ -493,6 +509,19 @@ export namespace Models {
          */
         projects: FirebaseProject[];
     }
+    /**
+     * VCS Content List
+     */
+    export type VcsContentList = {
+        /**
+         * Total number of contents documents that matched your query.
+         */
+        total: number;
+        /**
+         * List of contents.
+         */
+        contents: VcsContent[];
+    }
     /**
      * Database
      */
@@ -1790,6 +1819,10 @@ export namespace Models {
          * Function's active deployment ID.
          */
         deployment: string;
+        /**
+         * Allowed permission scopes.
+         */
+        scopes: string[];
         /**
          * Function variables.
          */
@@ -1839,6 +1872,129 @@ export namespace Models {
          */
         providerSilentMode: boolean;
     }
+    /**
+     * Template Function
+     */
+    export type TemplateFunction = {
+        /**
+         * Function Template Icon.
+         */
+        icon: string;
+        /**
+         * Function Template ID.
+         */
+        id: string;
+        /**
+         * Function Template Name.
+         */
+        name: string;
+        /**
+         * Function Template Tagline.
+         */
+        tagline: string;
+        /**
+         * Execution permissions.
+         */
+        permissions: string[];
+        /**
+         * Function trigger events.
+         */
+        events: string[];
+        /**
+         * Function execution schedult in CRON format.
+         */
+        cron: string;
+        /**
+         * Function execution timeout in seconds.
+         */
+        timeout: number;
+        /**
+         * Function use cases.
+         */
+        useCases: string[];
+        /**
+         * List of runtimes that can be used with this template.
+         */
+        runtimes: TemplateRuntime[];
+        /**
+         * Function Template Instructions.
+         */
+        instructions: string;
+        /**
+         * VCS (Version Control System) Provider.
+         */
+        vcsProvider: string;
+        /**
+         * VCS (Version Control System) Repository ID
+         */
+        providerRepositoryId: string;
+        /**
+         * VCS (Version Control System) Owner.
+         */
+        providerOwner: string;
+        /**
+         * VCS (Version Control System) branch version (tag).
+         */
+        providerVersion: string;
+        /**
+         * Function variables.
+         */
+        variables: TemplateVariable[];
+        /**
+         * Function scopes.
+         */
+        scopes: string[];
+    }
+    /**
+     * Template Runtime
+     */
+    export type TemplateRuntime = {
+        /**
+         * Runtime Name.
+         */
+        name: string;
+        /**
+         * The build command used to build the deployment.
+         */
+        commands: string;
+        /**
+         * The entrypoint file used to execute the deployment.
+         */
+        entrypoint: string;
+        /**
+         * Path to function in VCS (Version Control System) repository
+         */
+        providerRootDirectory: string;
+    }
+    /**
+     * Template Variable
+     */
+    export type TemplateVariable = {
+        /**
+         * Variable Name.
+         */
+        name: string;
+        /**
+         * Variable Description.
+         */
+        description: string;
+        /**
+         * Variable Value.
+         */
+        value: string;
+        /**
+         * Variable Placeholder.
+         */
+        placeholder: string;
+        /**
+         * Is the variable required?
+         */
+        required: boolean;
+        /**
+         * Variable Type.
+         */
+        type: string;
+    }
     /**
      * Installation
      */
@@ -1910,6 +2066,23 @@ export namespace Models {
          */
         runtime: string;
     }
+    /**
+     * VcsContents
+     */
+    export type VcsContent = {
+        /**
+         * Content size in bytes. Only files have size, and for directories, 0 is returned.
+         */
+        size?: number;
+        /**
+         * If a content is a directory. Directories can be used to check nested contents.
+         */
+        isDirectory?: boolean;
+        /**
+         * Name of directory or file.
+         */
+        name: string;
+    }
     /**
      * Branch
      */
@@ -1927,6 +2100,10 @@ export namespace Models {
          * Runtime ID.
          */
         $id: string;
+        /**
+         * Parent runtime key.
+         */
+        key: string;
         /**
          * Runtime Name.
          */
@@ -2117,6 +2294,51 @@ export namespace Models {
          * Function execution duration in seconds.
          */
         duration: number;
+        /**
+         * The scheduled time for execution. If left empty, execution will be queued immediately.
+         */
+        scheduledAt?: string;
+    }
+    /**
+     * Build
+     */
+    export type Build = {
+        /**
+         * Build ID.
+         */
+        $id: string;
+        /**
+         * The deployment that created this build.
+         */
+        deploymentId: string;
+        /**
+         * The build status. There are a few different types and each one means something different. \nFailed - The deployment build has failed. More details can usually be found in buildStderr\nReady - The deployment build was successful and the deployment is ready to be deployed\nProcessing - The deployment is currently waiting to have a build triggered\nBuilding - The deployment is currently being built
+         */
+        status: string;
+        /**
+         * The stdout of the build.
+         */
+        stdout: string;
+        /**
+         * The stderr of the build.
+         */
+        stderr: string;
+        /**
+         * The deployment creation date in ISO 8601 format.
+         */
+        startTime: string;
+        /**
+         * The time the build was finished in ISO 8601 format.
+         */
+        endTime: string;
+        /**
+         * The build duration in seconds.
+         */
+        duration: number;
+        /**
+         * The code size in bytes.
+         */
+        size: number;
     }
     /**
      * Project
@@ -2202,6 +2424,14 @@ export namespace Models {
          * Whether or not to check the user password for similarity with their personal data.
          */
         authPersonalDataCheck: boolean;
+        /**
+         * An array of mock numbers and their corresponding verification codes (OTPs).
+         */
+        authMockNumbers: MockNumber[];
+        /**
+         * Whether or not to send session alert emails to users.
+         */
+        authSessionAlerts: boolean;
         /**
          * List of Auth Providers.
          */
@@ -2425,6 +2655,19 @@ export namespace Models {
          */
         sdks: string[];
     }
+    /**
+     * Mock Number
+     */
+    export type MockNumber = {
+        /**
+         * Mock phone number for testing phone authentication. Useful for testing phone authentication without sending an SMS.
+         */
+        phone: string;
+        /**
+         * Mock OTP for the number. 
+         */
+        otp: string;
+    }
     /**
      * AuthProvider
      */
@@ -2926,6 +3169,10 @@ export 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.
          */
@@ -2934,6 +3181,10 @@ export 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.
          */
@@ -2958,6 +3209,10 @@ export 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.
          */
@@ -2966,6 +3221,10 @@ export namespace Models {
          * Aggregated number of functions execution compute time per period.
          */
         executionsTime: Metric[];
+        /**
+         * Aggregated number of functions mbSeconds per period.
+         */
+        executionsMbSeconds: Metric[];
     }
     /**
      * UsageFunction
@@ -2995,6 +3254,10 @@ export 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.
          */
@@ -3003,6 +3266,10 @@ export 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.
          */
@@ -3023,6 +3290,10 @@ export 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.
          */
@@ -3031,6 +3302,10 @@ export namespace Models {
          * Aggregated number of function executions compute time per period.
          */
         executionsTime: Metric[];
+        /**
+         * Aggregated number of function mbSeconds per period.
+         */
+        executionsMbSeconds: Metric[];
     }
     /**
      * UsageProject
@@ -3056,10 +3331,22 @@ export 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.
          */
@@ -3084,6 +3371,18 @@ export 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

package/src/permission.ts

@@ -1,22 +1,57 @@
+/**
+ * Helper class to generate permission strings for resources.
+ */
 export class Permission {
-
+    /**
+     * Generate read permission string for the provided role.
+     *
+     * @param {string} role
+     * @returns {string}
+     */
     static read = (role: string): string => {
-        return `read("${role}")`
+        return `read("${role}")`;
     }
 
+    /**
+     * 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 => {
-        return `write("${role}")`
+        return `write("${role}")`;
     }
 
+    /**
+     * Generate create permission string for the provided role.
+     *
+     * @param {string} role
+     * @returns {string}
+     */
     static create = (role: string): string => {
-        return `create("${role}")`
+        return `create("${role}")`;
     }
 
+    /**
+     * Generate update permission string for the provided role.
+     *
+     * @param {string} role
+     * @returns {string}
+     */
     static update = (role: string): string => {
-        return `update("${role}")`
+        return `update("${role}")`;
     }
 
+    /**
+     * Generate delete permission string for the provided role.
+     *
+     * @param {string} role
+     * @returns {string}
+     */
     static delete = (role: string): string => {
-        return `delete("${role}")`
+        return `delete("${role}")`;
     }
 }