@appwrite.io/console 1.10.0 → 2.1.0

package/types/services/graphql.d.ts

@@ -5,17 +5,39 @@ export declare class Graphql {
     /**
      * Execute a GraphQL mutation.
      *
-     * @param {object} query
+     * @param {object} params.query - The query or queries to execute.
      * @throws {AppwriteException}
      * @returns {Promise<{}>}
      */
+    query(params: {
+        query: object;
+    }): Promise<{}>;
+    /**
+     * Execute a GraphQL mutation.
+     *
+     * @param {object} query - The query or queries to execute.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
     query(query: object): Promise<{}>;
     /**
      * Execute a GraphQL mutation.
      *
-     * @param {object} query
+     * @param {object} params.query - The query or queries to execute.
+     * @throws {AppwriteException}
+     * @returns {Promise<{}>}
+     */
+    mutation(params: {
+        query: object;
+    }): Promise<{}>;
+    /**
+     * Execute a GraphQL mutation.
+     *
+     * @param {object} query - The query or queries to execute.
      * @throws {AppwriteException}
      * @returns {Promise<{}>}
+     * @deprecated Use the object parameter style method for a better developer experience.
      */
     mutation(query: object): Promise<{}>;
 }

package/types/services/health.d.ts

@@ -28,10 +28,21 @@ export declare class Health {
     /**
      * Get the SSL certificate for a domain
      *
-     * @param {string} domain
+     * @param {string} params.domain - string
      * @throws {AppwriteException}
      * @returns {Promise<Models.HealthCertificate>}
      */
+    getCertificate(params?: {
+        domain?: string;
+    }): Promise<Models.HealthCertificate>;
+    /**
+     * Get the SSL certificate for a domain
+     *
+     * @param {string} domain - string
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.HealthCertificate>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
     getCertificate(domain?: string): Promise<Models.HealthCertificate>;
     /**
      * Check the Appwrite database servers are up and connection is successful.
@@ -48,142 +59,353 @@ export declare class Health {
      */
     getPubSub(): Promise<Models.HealthStatus>;
     /**
-     * Get billing project aggregation queue
+     * Get billing project aggregation queue.
      *
-     * @param {number} threshold
+     * @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
      * @throws {AppwriteException}
      * @returns {Promise<Models.HealthQueue>}
      */
+    getQueueBillingProjectAggregation(params?: {
+        threshold?: number;
+    }): Promise<Models.HealthQueue>;
+    /**
+     * Get billing project aggregation queue.
+     *
+     * @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.HealthQueue>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
     getQueueBillingProjectAggregation(threshold?: number): Promise<Models.HealthQueue>;
     /**
-     * Get billing team aggregation queue
+     * Get billing team aggregation queue.
      *
-     * @param {number} threshold
+     * @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
      * @throws {AppwriteException}
      * @returns {Promise<Models.HealthQueue>}
      */
+    getQueueBillingTeamAggregation(params?: {
+        threshold?: number;
+    }): Promise<Models.HealthQueue>;
+    /**
+     * Get billing team aggregation queue.
+     *
+     * @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.HealthQueue>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
     getQueueBillingTeamAggregation(threshold?: number): Promise<Models.HealthQueue>;
     /**
      * Get the number of builds that are waiting to be processed in the Appwrite internal queue server.
      *
-     * @param {number} threshold
+     * @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.HealthQueue>}
+     */
+    getQueueBuilds(params?: {
+        threshold?: number;
+    }): Promise<Models.HealthQueue>;
+    /**
+     * Get the number of builds that are waiting to be processed in the Appwrite internal queue server.
+     *
+     * @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
      * @throws {AppwriteException}
      * @returns {Promise<Models.HealthQueue>}
+     * @deprecated Use the object parameter style method for a better developer experience.
      */
     getQueueBuilds(threshold?: number): Promise<Models.HealthQueue>;
     /**
      * Get the priority builds queue size.
      *
-     * @param {number} threshold
+     * @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 500.
      * @throws {AppwriteException}
      * @returns {Promise<Models.HealthQueue>}
      */
+    getQueuePriorityBuilds(params?: {
+        threshold?: number;
+    }): Promise<Models.HealthQueue>;
+    /**
+     * Get the priority builds queue size.
+     *
+     * @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 500.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.HealthQueue>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
     getQueuePriorityBuilds(threshold?: number): Promise<Models.HealthQueue>;
     /**
      * Get the number of certificates that are waiting to be issued against [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue server.
      *
-     * @param {number} threshold
+     * @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.HealthQueue>}
+     */
+    getQueueCertificates(params?: {
+        threshold?: number;
+    }): Promise<Models.HealthQueue>;
+    /**
+     * Get the number of certificates that are waiting to be issued against [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue server.
+     *
+     * @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
      * @throws {AppwriteException}
      * @returns {Promise<Models.HealthQueue>}
+     * @deprecated Use the object parameter style method for a better developer experience.
      */
     getQueueCertificates(threshold?: number): Promise<Models.HealthQueue>;
     /**
      * Get the number of database changes that are waiting to be processed in the Appwrite internal queue server.
      *
-     * @param {string} name
-     * @param {number} threshold
+     * @param {string} params.name - Queue name for which to check the queue size
+     * @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
      * @throws {AppwriteException}
      * @returns {Promise<Models.HealthQueue>}
      */
+    getQueueDatabases(params?: {
+        name?: string;
+        threshold?: number;
+    }): Promise<Models.HealthQueue>;
+    /**
+     * Get the number of database changes that are waiting to be processed in the Appwrite internal queue server.
+     *
+     * @param {string} name - Queue name for which to check the queue size
+     * @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.HealthQueue>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
     getQueueDatabases(name?: string, threshold?: number): Promise<Models.HealthQueue>;
     /**
      * Get the number of background destructive changes that are waiting to be processed in the Appwrite internal queue server.
      *
-     * @param {number} threshold
+     * @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
      * @throws {AppwriteException}
      * @returns {Promise<Models.HealthQueue>}
      */
+    getQueueDeletes(params?: {
+        threshold?: number;
+    }): Promise<Models.HealthQueue>;
+    /**
+     * Get the number of background destructive changes that are waiting to be processed in the Appwrite internal queue server.
+     *
+     * @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.HealthQueue>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
     getQueueDeletes(threshold?: number): Promise<Models.HealthQueue>;
     /**
      * Returns the amount of failed jobs in a given queue.
      *
      *
-     * @param {Name} name
-     * @param {number} threshold
+     * @param {Name} params.name - The name of the queue
+     * @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.HealthQueue>}
+     */
+    getFailedJobs(params: {
+        name: Name;
+        threshold?: number;
+    }): Promise<Models.HealthQueue>;
+    /**
+     * Returns the amount of failed jobs in a given queue.
+     *
+     *
+     * @param {Name} name - The name of the queue
+     * @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
      * @throws {AppwriteException}
      * @returns {Promise<Models.HealthQueue>}
+     * @deprecated Use the object parameter style method for a better developer experience.
      */
     getFailedJobs(name: Name, threshold?: number): Promise<Models.HealthQueue>;
     /**
      * Get the number of function executions that are waiting to be processed in the Appwrite internal queue server.
      *
-     * @param {number} threshold
+     * @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.HealthQueue>}
+     */
+    getQueueFunctions(params?: {
+        threshold?: number;
+    }): Promise<Models.HealthQueue>;
+    /**
+     * Get the number of function executions that are waiting to be processed in the Appwrite internal queue server.
+     *
+     * @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
      * @throws {AppwriteException}
      * @returns {Promise<Models.HealthQueue>}
+     * @deprecated Use the object parameter style method for a better developer experience.
      */
     getQueueFunctions(threshold?: number): Promise<Models.HealthQueue>;
     /**
      * Get the number of logs that are waiting to be processed in the Appwrite internal queue server.
      *
-     * @param {number} threshold
+     * @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.HealthQueue>}
+     */
+    getQueueLogs(params?: {
+        threshold?: number;
+    }): Promise<Models.HealthQueue>;
+    /**
+     * Get the number of logs that are waiting to be processed in the Appwrite internal queue server.
+     *
+     * @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
      * @throws {AppwriteException}
      * @returns {Promise<Models.HealthQueue>}
+     * @deprecated Use the object parameter style method for a better developer experience.
      */
     getQueueLogs(threshold?: number): Promise<Models.HealthQueue>;
     /**
      * Get the number of mails that are waiting to be processed in the Appwrite internal queue server.
      *
-     * @param {number} threshold
+     * @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
      * @throws {AppwriteException}
      * @returns {Promise<Models.HealthQueue>}
      */
+    getQueueMails(params?: {
+        threshold?: number;
+    }): Promise<Models.HealthQueue>;
+    /**
+     * Get the number of mails that are waiting to be processed in the Appwrite internal queue server.
+     *
+     * @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.HealthQueue>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
     getQueueMails(threshold?: number): Promise<Models.HealthQueue>;
     /**
      * Get the number of messages that are waiting to be processed in the Appwrite internal queue server.
      *
-     * @param {number} threshold
+     * @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
      * @throws {AppwriteException}
      * @returns {Promise<Models.HealthQueue>}
      */
+    getQueueMessaging(params?: {
+        threshold?: number;
+    }): Promise<Models.HealthQueue>;
+    /**
+     * Get the number of messages that are waiting to be processed in the Appwrite internal queue server.
+     *
+     * @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.HealthQueue>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
     getQueueMessaging(threshold?: number): Promise<Models.HealthQueue>;
     /**
      * Get the number of migrations that are waiting to be processed in the Appwrite internal queue server.
      *
-     * @param {number} threshold
+     * @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.HealthQueue>}
+     */
+    getQueueMigrations(params?: {
+        threshold?: number;
+    }): Promise<Models.HealthQueue>;
+    /**
+     * Get the number of migrations that are waiting to be processed in the Appwrite internal queue server.
+     *
+     * @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
      * @throws {AppwriteException}
      * @returns {Promise<Models.HealthQueue>}
+     * @deprecated Use the object parameter style method for a better developer experience.
      */
     getQueueMigrations(threshold?: number): Promise<Models.HealthQueue>;
     /**
-     * Get region manager queue
+     * Get region manager queue.
+     *
+     * @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 100.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.HealthQueue>}
+     */
+    getQueueRegionManager(params?: {
+        threshold?: number;
+    }): Promise<Models.HealthQueue>;
+    /**
+     * Get region manager queue.
      *
-     * @param {number} threshold
+     * @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 100.
      * @throws {AppwriteException}
      * @returns {Promise<Models.HealthQueue>}
+     * @deprecated Use the object parameter style method for a better developer experience.
      */
     getQueueRegionManager(threshold?: number): Promise<Models.HealthQueue>;
     /**
      * Get the number of metrics that are waiting to be processed in the Appwrite stats resources queue.
      *
-     * @param {number} threshold
+     * @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.HealthQueue>}
+     */
+    getQueueStatsResources(params?: {
+        threshold?: number;
+    }): Promise<Models.HealthQueue>;
+    /**
+     * Get the number of metrics that are waiting to be processed in the Appwrite stats resources queue.
+     *
+     * @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
      * @throws {AppwriteException}
      * @returns {Promise<Models.HealthQueue>}
+     * @deprecated Use the object parameter style method for a better developer experience.
      */
     getQueueStatsResources(threshold?: number): Promise<Models.HealthQueue>;
     /**
      * Get the number of metrics that are waiting to be processed in the Appwrite internal queue server.
      *
-     * @param {number} threshold
+     * @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
      * @throws {AppwriteException}
      * @returns {Promise<Models.HealthQueue>}
      */
+    getQueueUsage(params?: {
+        threshold?: number;
+    }): Promise<Models.HealthQueue>;
+    /**
+     * Get the number of metrics that are waiting to be processed in the Appwrite internal queue server.
+     *
+     * @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.HealthQueue>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
     getQueueUsage(threshold?: number): Promise<Models.HealthQueue>;
+    /**
+     * Get threats queue.
+     *
+     * @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 100.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.HealthQueue>}
+     */
+    getQueueThreats(params?: {
+        threshold?: number;
+    }): Promise<Models.HealthQueue>;
+    /**
+     * Get threats queue.
+     *
+     * @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 100.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.HealthQueue>}
+     * @deprecated Use the object parameter style method for a better developer experience.
+     */
+    getQueueThreats(threshold?: number): Promise<Models.HealthQueue>;
+    /**
+     * Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.
+     *
+     * @param {number} params.threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.HealthQueue>}
+     */
+    getQueueWebhooks(params?: {
+        threshold?: number;
+    }): Promise<Models.HealthQueue>;
     /**
      * Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.
      *
-     * @param {number} threshold
+     * @param {number} threshold - Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.
      * @throws {AppwriteException}
      * @returns {Promise<Models.HealthQueue>}
+     * @deprecated Use the object parameter style method for a better developer experience.
      */
     getQueueWebhooks(threshold?: number): Promise<Models.HealthQueue>;
     /**