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

package/types/models.d.ts

@@ -402,6 +402,71 @@ export declare namespace Models {
          */
         localeCodes: LocaleCode[];
     };
+    /**
+     * Provider list
+     */
+    type ProviderList = {
+        /**
+         * Total number of providers documents that matched your query.
+         */
+        total: number;
+        /**
+         * List of providers.
+         */
+        providers: Provider[];
+    };
+    /**
+     * Message list
+     */
+    type MessageList = {
+        /**
+         * Total number of messages documents that matched your query.
+         */
+        total: number;
+        /**
+         * List of messages.
+         */
+        messages: Message[];
+    };
+    /**
+     * Topic list
+     */
+    type TopicList = {
+        /**
+         * Total number of topics documents that matched your query.
+         */
+        total: number;
+        /**
+         * List of topics.
+         */
+        topics: Topic[];
+    };
+    /**
+     * Subscriber list
+     */
+    type SubscriberList = {
+        /**
+         * Total number of subscribers documents that matched your query.
+         */
+        total: number;
+        /**
+         * List of subscribers.
+         */
+        subscribers: Subscriber[];
+    };
+    /**
+     * Target list
+     */
+    type TargetList = {
+        /**
+         * Total number of targets documents that matched your query.
+         */
+        total: number;
+        /**
+         * List of targets.
+         */
+        targets: Target[];
+    };
     /**
      * Migrations List
      */
@@ -1117,10 +1182,18 @@ export declare namespace Models {
          * Phone verification status.
          */
         phoneVerification: boolean;
+        /**
+         * Multi factor authentication status.
+         */
+        mfa: boolean;
         /**
          * User preferences as a key-value object
          */
         prefs: Preferences;
+        /**
+         * A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.
+         */
+        targets: Target[];
         /**
          * Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.
          */
@@ -1339,6 +1412,10 @@ export declare namespace Models {
          * Returns true if this the current user session.
          */
         current: boolean;
+        /**
+         * Returns true if this the current user session.
+         */
+        factors: number;
     };
     /**
      * Identity
@@ -2106,9 +2183,9 @@ export declare namespace Models {
          */
         authPersonalDataCheck: boolean;
         /**
-         * List of Providers.
+         * List of Auth Providers.
          */
-        providers: Provider[];
+        oAuthProviders: AuthProvider[];
         /**
          * List of Platforms.
          */
@@ -2221,6 +2298,10 @@ export declare namespace Models {
          * GraphQL service status
          */
         serviceStatusForGraphql: boolean;
+        /**
+         * Messaging service status
+         */
+        serviceStatusForMessaging: boolean;
     };
     /**
      * Webhook
@@ -2309,15 +2390,15 @@ export declare namespace Models {
         sdks: string[];
     };
     /**
-     * Provider
+     * AuthProvider
      */
-    type Provider = {
+    type AuthProvider = {
         /**
-         * Provider.
+         * Auth Provider.
          */
         key: string;
         /**
-         * Provider name.
+         * Auth Provider name.
          */
         name: string;
         /**
@@ -2329,7 +2410,7 @@ export declare namespace Models {
          */
         secret: string;
         /**
-         * Provider is active and can be used to create session.
+         * Auth Provider is active and can be used to create session.
          */
         enabled: boolean;
     };
@@ -2574,370 +2655,360 @@ export declare namespace Models {
         date: string;
     };
     /**
-     * Metric Breakdown
+     * UsageDatabases
      */
-    type MetricBreakdown = {
+    type UsageDatabases = {
         /**
-         * Resource ID.
+         * The time range of the usage stats.
          */
-        resourceId: string;
+        range: string;
         /**
-         * Resource name.
+         * Aggregated stats for total number of documents.
          */
-        name: string;
+        databasesCount: Metric[];
         /**
-         * The value of this metric at the timestamp.
+         * Aggregated stats for total number of documents.
          */
-        value: number;
-    };
-    /**
-     * UsageDatabases
-     */
-    type UsageDatabases = {
+        documentsCount: Metric[];
         /**
-         * Time range of the usage stats.
+         * Aggregated stats for total number of collections.
          */
-        range: string;
+        collectionsCount: Metric[];
         /**
-         * Total aggregated number of databases.
+         * Aggregated stats for documents created.
          */
-        databasesTotal: number;
+        databasesCreate: Metric[];
         /**
-         * Total aggregated number  of collections.
+         * Aggregated stats for documents read.
          */
-        collectionsTotal: number;
+        databasesRead: Metric[];
         /**
-         * Total aggregated number of documents.
+         * Aggregated stats for documents updated.
          */
-        documentsTotal: number;
+        databasesUpdate: Metric[];
         /**
-         * Aggregated number of databases per period.
+         * Aggregated stats for total number of collections.
          */
-        databases: Metric[];
+        databasesDelete: Metric[];
         /**
-         * Aggregated number of collections per period.
+         * Aggregated stats for documents created.
          */
-        collections: Metric[];
+        documentsCreate: Metric[];
         /**
-         * Aggregated number of documents per period.
+         * Aggregated stats for documents read.
          */
-        documents: Metric[];
-    };
-    /**
-     * UsageDatabase
-     */
-    type UsageDatabase = {
+        documentsRead: Metric[];
         /**
-         * Time range of the usage stats.
+         * Aggregated stats for documents updated.
          */
-        range: string;
+        documentsUpdate: Metric[];
         /**
-         * Total aggregated number of collections.
+         * Aggregated stats for documents deleted.
          */
-        collectionsTotal: number;
+        documentsDelete: Metric[];
         /**
-         * Total aggregated number of documents.
+         * Aggregated stats for collections created.
          */
-        documentsTotal: number;
+        collectionsCreate: Metric[];
         /**
-         * Aggregated  number of collections per period.
+         * Aggregated stats for collections read.
          */
-        collections: Metric[];
+        collectionsRead: Metric[];
         /**
-         * Aggregated  number of documents per period.
+         * Aggregated stats for collections updated.
          */
-        documents: Metric[];
+        collectionsUpdate: Metric[];
+        /**
+         * Aggregated stats for collections delete.
+         */
+        collectionsDelete: Metric[];
     };
     /**
-     * UsageCollection
+     * UsageDatabase
      */
-    type UsageCollection = {
+    type UsageDatabase = {
         /**
-         * Time range of the usage stats.
+         * The time range of the usage stats.
          */
         range: string;
         /**
-         * Total aggregated number of of documents.
+         * Aggregated stats for total number of documents.
          */
-        documentsTotal: number;
+        documentsCount: Metric[];
         /**
-         * Aggregated  number of documents per period.
+         * Aggregated stats for total number of collections.
          */
-        documents: Metric[];
-    };
-    /**
-     * UsageUsers
-     */
-    type UsageUsers = {
+        collectionsCount: Metric[];
         /**
-         * Time range of the usage stats.
+         * Aggregated stats for documents created.
          */
-        range: string;
+        documentsCreate: Metric[];
         /**
-         * Total aggregated number of statistics of users.
+         * Aggregated stats for documents read.
          */
-        usersTotal: number;
+        documentsRead: Metric[];
         /**
-         * Total aggregated number of active sessions.
+         * Aggregated stats for documents updated.
          */
-        sessionsTotal: number;
+        documentsUpdate: Metric[];
         /**
-         * Aggregated number of users per period.
+         * Aggregated stats for documents deleted.
          */
-        users: Metric[];
+        documentsDelete: Metric[];
+        /**
+         * Aggregated stats for collections created.
+         */
+        collectionsCreate: Metric[];
+        /**
+         * Aggregated stats for collections read.
+         */
+        collectionsRead: Metric[];
+        /**
+         * Aggregated stats for collections updated.
+         */
+        collectionsUpdate: Metric[];
         /**
-         * Aggregated number of active sessions  per period.
+         * Aggregated stats for collections delete.
          */
-        sessions: Metric[];
+        collectionsDelete: Metric[];
     };
     /**
-     * StorageUsage
+     * UsageCollection
      */
-    type UsageStorage = {
+    type UsageCollection = {
         /**
-         * Time range of the usage stats.
+         * The time range of the usage stats.
          */
         range: string;
         /**
-         * Total aggregated number of buckets
+         * Aggregated stats for total number of documents.
          */
-        bucketsTotal: number;
+        documentsCount: Metric[];
         /**
-         * Total aggregated number of files.
+         * Aggregated stats for documents created.
          */
-        filesTotal: number;
+        documentsCreate: Metric[];
         /**
-         * Total aggregated number of files storage (in bytes).
+         * Aggregated stats for documents read.
          */
-        filesStorageTotal: number;
+        documentsRead: Metric[];
         /**
-         * Aggregated number of buckets per period.
+         * Aggregated stats for documents updated.
          */
-        buckets: Metric[];
-        /**
-         * Aggregated number of files per period.
-         */
-        files: Metric[];
+        documentsUpdate: Metric[];
         /**
-         * Aggregated number of files storage (in bytes) per period .
+         * Aggregated stats for documents deleted.
          */
-        storage: Metric[];
+        documentsDelete: Metric[];
     };
     /**
-     * UsageBuckets
+     * UsageUsers
      */
-    type UsageBuckets = {
+    type UsageUsers = {
         /**
-         * Time range of the usage stats.
+         * The time range of the usage stats.
          */
         range: string;
         /**
-         * Total aggregated number of bucket files.
+         * Aggregated stats for total number of users.
          */
-        filesTotal: number;
+        usersCount: Metric[];
         /**
-         * Total aggregated number of bucket files storage (in bytes).
+         * Aggregated stats for users created.
          */
-        filesStorageTotal: number;
+        usersCreate: Metric[];
         /**
-         * Aggregated  number of bucket files per period.
+         * Aggregated stats for users read.
          */
-        files: Metric[];
+        usersRead: Metric[];
         /**
-         * Aggregated  number of bucket storage files (in bytes) per period.
+         * Aggregated stats for users updated.
          */
-        storage: Metric[];
-    };
-    /**
-     * UsageFunctions
-     */
-    type UsageFunctions = {
+        usersUpdate: Metric[];
         /**
-         * Time range of the usage stats.
+         * Aggregated stats for users deleted.
          */
-        range: string;
+        usersDelete: Metric[];
         /**
-         * Total aggregated number of functions.
+         * Aggregated stats for sessions created.
          */
-        functionsTotal: number;
+        sessionsCreate: Metric[];
         /**
-         * Total aggregated number of functions deployments.
+         * Aggregated stats for sessions created for a provider ( email, anonymous or oauth2 ).
          */
-        deploymentsTotal: number;
+        sessionsProviderCreate: Metric[];
         /**
-         * Total aggregated sum of functions deployment storage.
+         * Aggregated stats for sessions deleted.
          */
-        deploymentsStorageTotal: number;
+        sessionsDelete: Metric[];
+    };
+    /**
+     * StorageUsage
+     */
+    type UsageStorage = {
         /**
-         * Total aggregated number of functions build.
+         * The time range of the usage stats.
          */
-        buildsTotal: number;
+        range: string;
         /**
-         * total aggregated sum of functions build storage.
+         * Aggregated stats for the occupied storage size (in bytes).
          */
-        buildsStorageTotal: number;
+        storage: Metric[];
         /**
-         * Total aggregated sum of functions build compute time.
+         * Aggregated stats for total number of files.
          */
-        buildsTimeTotal: number;
+        filesCount: Metric[];
         /**
-         * Total  aggregated number of functions execution.
+         * Aggregated stats for total number of buckets.
          */
-        executionsTotal: number;
+        bucketsCount: Metric[];
         /**
-         * Total aggregated sum of functions  execution compute time.
+         * Aggregated stats for buckets created.
          */
-        executionsTimeTotal: number;
+        bucketsCreate: Metric[];
         /**
-         * Aggregated number of functions per period.
+         * Aggregated stats for buckets read.
          */
-        functions: Metric[];
+        bucketsRead: Metric[];
         /**
-         * Aggregated number of functions deployment per period.
+         * Aggregated stats for buckets updated.
          */
-        deployments: Metric[];
+        bucketsUpdate: Metric[];
         /**
-         * Aggregated number of  functions deployment storage per period.
+         * Aggregated stats for buckets deleted.
          */
-        deploymentsStorage: Metric[];
+        bucketsDelete: Metric[];
         /**
-         * Aggregated number of functions build per period.
+         * Aggregated stats for files created.
          */
-        builds: Metric[];
+        filesCreate: Metric[];
         /**
-         * Aggregated sum of functions build storage per period.
+         * Aggregated stats for files read.
          */
-        buildsStorage: Metric[];
+        filesRead: Metric[];
         /**
-         * Aggregated sum of  functions build compute time per period.
+         * Aggregated stats for files updated.
          */
-        buildsTime: Metric[];
+        filesUpdate: Metric[];
         /**
-         * Aggregated number of  functions execution per period.
+         * Aggregated stats for files deleted.
          */
-        executions: Metric[];
-        /**
-         * Aggregated number of functions execution compute time per period.
-         */
-        executionsTime: Metric[];
+        filesDelete: Metric[];
     };
     /**
-     * UsageFunction
+     * UsageBuckets
      */
-    type UsageFunction = {
+    type UsageBuckets = {
         /**
          * The time range of the usage stats.
          */
         range: string;
         /**
-         * Total aggregated number of function deployments.
+         * Aggregated stats for total number of files in this bucket.
          */
-        deploymentsTotal: number;
+        filesCount: Metric[];
         /**
-         * Total aggregated sum of function deployments storage.
+         * Aggregated stats for total storage of files in this bucket.
          */
-        deploymentsStorageTotal: number;
+        filesStorage: Metric[];
         /**
-         * Total aggregated number of function builds.
+         * Aggregated stats for files created.
          */
-        buildsTotal: number;
+        filesCreate: Metric[];
         /**
-         * total aggregated sum of function builds storage.
+         * Aggregated stats for files read.
          */
-        buildsStorageTotal: number;
+        filesRead: Metric[];
         /**
-         * Total aggregated sum of function builds compute time.
+         * Aggregated stats for files updated.
          */
-        buildsTimeTotal: number;
+        filesUpdate: Metric[];
         /**
-         * Total  aggregated number of function executions.
+         * Aggregated stats for files deleted.
          */
-        executionsTotal: number;
+        filesDelete: Metric[];
+    };
+    /**
+     * UsageFunctions
+     */
+    type UsageFunctions = {
         /**
-         * Total aggregated sum of function  executions compute time.
+         * The time range of the usage stats.
          */
-        executionsTimeTotal: number;
+        range: string;
         /**
-         * Aggregated number of function deployments per period.
+         * Aggregated stats for number of function executions.
          */
-        deployments: Metric[];
+        executionsTotal: Metric[];
         /**
-         * Aggregated number of  function deployments storage per period.
+         * Aggregated stats for function execution failures.
          */
-        deploymentsStorage: Metric[];
+        executionsFailure: Metric[];
         /**
-         * Aggregated number of function builds per period.
+         * Aggregated stats for function execution successes.
          */
-        builds: Metric[];
+        executionsSuccess: Metric[];
         /**
-         * Aggregated sum of function builds storage per period.
+         * Aggregated stats for function execution duration.
          */
-        buildsStorage: Metric[];
+        executionsTime: Metric[];
         /**
-         * Aggregated sum of function builds compute time per period.
+         * Aggregated stats for number of function builds.
          */
-        buildsTime: Metric[];
+        buildsTotal: Metric[];
         /**
-         * Aggregated number of function executions per period.
+         * Aggregated stats for function build failures.
          */
-        executions: Metric[];
+        buildsFailure: Metric[];
         /**
-         * Aggregated number of function executions compute time per period.
+         * Aggregated stats for function build successes.
          */
-        executionsTime: Metric[];
+        buildsSuccess: Metric[];
+        /**
+         * Aggregated stats for function build duration.
+         */
+        buildsTime: Metric[];
     };
     /**
      * UsageProject
      */
     type UsageProject = {
         /**
-         * Total aggregated number of function executions.
-         */
-        executionsTotal: number;
-        /**
-         * Total aggregated  number of documents.
-         */
-        documentsTotal: number;
-        /**
-         * Total aggregated number of databases.
+         * The time range of the usage stats.
          */
-        databasesTotal: number;
+        range: string;
         /**
-         * Total aggregated number of users.
+         * Aggregated stats for number of requests.
          */
-        usersTotal: number;
+        requests: Metric[];
         /**
-         * Total aggregated sum of files storage size (in bytes).
+         * Aggregated stats for consumed bandwidth.
          */
-        filesStorageTotal: number;
+        network: Metric[];
         /**
-         * Total aggregated number of buckets.
+         * Aggregated stats for function executions.
          */
-        bucketsTotal: number;
+        executions: Metric[];
         /**
-         * Aggregated  number of requests per period.
+         * Aggregated stats for number of documents.
          */
-        requests: Metric[];
+        documents: Metric[];
         /**
-         * Aggregated number of consumed bandwidth per period.
+         * Aggregated stats for number of databases.
          */
-        network: Metric[];
+        databases: Metric[];
         /**
-         * Aggregated number of users per period.
+         * Aggregated stats for number of users.
          */
         users: Metric[];
         /**
-         * Aggregated number of executions per period.
+         * Aggregated stats for the occupied storage size (in bytes).
          */
-        executions: Metric[];
-        /**
-         * Aggregated breakdown in totals of executions by functions.
-         */
-        executionsBreakdown: MetricBreakdown[];
+        storage: Metric[];
         /**
-         * Aggregated breakdown in totals of usage by buckets.
+         * Aggregated stats for number of buckets.
          */
-        bucketsBreakdown: MetricBreakdown[];
+        buckets: Metric[];
     };
     /**
      * Headers
@@ -3076,6 +3147,270 @@ export declare namespace Models {
          */
         _APP_ASSISTANT_ENABLED: boolean;
     };
+    /**
+     * MFA Challenge
+     */
+    type MfaChallenge = {
+        /**
+         * Token ID.
+         */
+        $id: string;
+        /**
+         * Token creation date in ISO 8601 format.
+         */
+        $createdAt: string;
+        /**
+         * User ID.
+         */
+        userId: string;
+        /**
+         * Token expiration date in ISO 8601 format.
+         */
+        expire: string;
+    };
+    /**
+     * MFAProvider
+     */
+    type MfaProvider = {
+        /**
+         * backup codes
+         */
+        backups: string[];
+        /**
+         * secret used for top auth
+         */
+        secret: string;
+        /**
+         * uri for otp app
+         */
+        uri: string;
+    };
+    /**
+     * MFAProviders
+     */
+    type MfaProviders = {
+        /**
+         * TOTP
+         */
+        totp: boolean;
+        /**
+         * Phone
+         */
+        phone: boolean;
+        /**
+         * Email
+         */
+        email: boolean;
+    };
+    /**
+     * Provider
+     */
+    type Provider = {
+        /**
+         * Provider ID.
+         */
+        $id: string;
+        /**
+         * Provider creation time in ISO 8601 format.
+         */
+        $createdAt: string;
+        /**
+         * Provider update date in ISO 8601 format.
+         */
+        $updatedAt: string;
+        /**
+         * The name for the provider instance.
+         */
+        name: string;
+        /**
+         * The name of the provider service.
+         */
+        provider: string;
+        /**
+         * Is provider enabled?
+         */
+        enabled: boolean;
+        /**
+         * Type of provider.
+         */
+        type: string;
+        /**
+         * Provider credentials.
+         */
+        credentials: object;
+        /**
+         * Provider options.
+         */
+        options?: object;
+    };
+    /**
+     * Message
+     */
+    type Message = {
+        /**
+         * Message ID.
+         */
+        $id: string;
+        /**
+         * Message creation time in ISO 8601 format.
+         */
+        $createdAt: string;
+        /**
+         * Message update date in ISO 8601 format.
+         */
+        $updatedAt: string;
+        /**
+         * Message provider type.
+         */
+        providerType: string;
+        /**
+         * Topic IDs set as recipients.
+         */
+        topics: string[];
+        /**
+         * User IDs set as recipients.
+         */
+        users: string[];
+        /**
+         * Target IDs set as recipients.
+         */
+        targets: string[];
+        /**
+         * The scheduled time for message.
+         */
+        scheduledAt?: string;
+        /**
+         * The time when the message was delivered.
+         */
+        deliveredAt?: string;
+        /**
+         * Delivery errors if any.
+         */
+        deliveryErrors?: string[];
+        /**
+         * Number of recipients the message was delivered to.
+         */
+        deliveredTotal: number;
+        /**
+         * Data of the message.
+         */
+        data: object;
+        /**
+         * Status of delivery.
+         */
+        status: string;
+        /**
+         * Message description.
+         */
+        description?: string;
+    };
+    /**
+     * Topic
+     */
+    type Topic = {
+        /**
+         * Topic ID.
+         */
+        $id: string;
+        /**
+         * Topic creation time in ISO 8601 format.
+         */
+        $createdAt: string;
+        /**
+         * Topic update date in ISO 8601 format.
+         */
+        $updatedAt: string;
+        /**
+         * The name of the topic.
+         */
+        name: string;
+        /**
+         * Total count of subscribers subscribed to topic.
+         */
+        total: number;
+        /**
+         * Description of the topic.
+         */
+        description?: string;
+    };
+    /**
+     * Subscriber
+     */
+    type Subscriber = {
+        /**
+         * Subscriber ID.
+         */
+        $id: string;
+        /**
+         * Subscriber creation time in ISO 8601 format.
+         */
+        $createdAt: string;
+        /**
+         * Subscriber update date in ISO 8601 format.
+         */
+        $updatedAt: string;
+        /**
+         * Target ID.
+         */
+        targetId: string;
+        /**
+         * Target.
+         */
+        target: Target;
+        /**
+         * Topic ID.
+         */
+        userId: string;
+        /**
+         * User Name.
+         */
+        userName: string;
+        /**
+         * Topic ID.
+         */
+        topicId: string;
+        /**
+         * The target provider type. Can be one of the following: `email`, `sms` or `push`.
+         */
+        providerType: string;
+    };
+    /**
+     * Target
+     */
+    type Target = {
+        /**
+         * Target ID.
+         */
+        $id: string;
+        /**
+         * Target creation time in ISO 8601 format.
+         */
+        $createdAt: string;
+        /**
+         * Target update date in ISO 8601 format.
+         */
+        $updatedAt: string;
+        /**
+         * Target Name.
+         */
+        name: string;
+        /**
+         * User ID.
+         */
+        userId: string;
+        /**
+         * Provider ID.
+         */
+        providerId?: string;
+        /**
+         * The target provider type. Can be one of the following: `email`, `sms` or `push`.
+         */
+        providerType: string;
+        /**
+         * The target identifier.
+         */
+        identifier: string;
+    };
     /**
      * Migration
      */