appbuild-oceanbase-console 1.10.2

package/types/services/graphql.d.ts

@@ -0,0 +1,43 @@
+import { Client } from '../client';
+export declare class Graphql {
+    client: Client;
+    constructor(client: Client);
+    /**
+     * Execute a GraphQL mutation.
+     *
+     * @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} 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

@@ -0,0 +1,432 @@
+import { Client } from '../client';
+import type { Models } from '../models';
+import { Name } from '../enums/name';
+export declare class Health {
+    client: Client;
+    constructor(client: Client);
+    /**
+     * Check the Appwrite HTTP server is up and responsive.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.HealthStatus>}
+     */
+    get(): Promise<Models.HealthStatus>;
+    /**
+     * Check the Appwrite Antivirus server is up and connection is successful.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.HealthAntivirus>}
+     */
+    getAntivirus(): Promise<Models.HealthAntivirus>;
+    /**
+     * Check the Appwrite in-memory cache servers are up and connection is successful.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.HealthStatus>}
+     */
+    getCache(): Promise<Models.HealthStatus>;
+    /**
+     * Get the SSL certificate for a 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.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.HealthStatus>}
+     */
+    getDB(): Promise<Models.HealthStatus>;
+    /**
+     * Check the Appwrite pub-sub servers are up and connection is successful.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.HealthStatus>}
+     */
+    getPubSub(): Promise<Models.HealthStatus>;
+    /**
+     * Get billing project aggregation 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>}
+     */
+    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.
+     *
+     * @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} 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} 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} 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} 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} 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} 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} 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} 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} 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} 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} 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.
+     *
+     * @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 - 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} 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} 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 - 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>;
+    /**
+     * Check the Appwrite storage device is up and connection is successful.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.HealthStatus>}
+     */
+    getStorage(): Promise<Models.HealthStatus>;
+    /**
+     * Check the Appwrite local storage device is up and connection is successful.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.HealthStatus>}
+     */
+    getStorageLocal(): Promise<Models.HealthStatus>;
+    /**
+     * Check the Appwrite server time is synced with Google remote NTP server. We use this technology to smoothly handle leap seconds with no disruptive events. The [Network Time Protocol](https://en.wikipedia.org/wiki/Network_Time_Protocol) (NTP) is used by hundreds of millions of computers and devices to synchronize their clocks over the Internet. If your computer sets its own clock, it likely uses NTP.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.HealthTime>}
+     */
+    getTime(): Promise<Models.HealthTime>;
+}

package/types/services/locale.d.ts

@@ -0,0 +1,64 @@
+import { Client } from '../client';
+import type { Models } from '../models';
+export declare class Locale {
+    client: Client;
+    constructor(client: Client);
+    /**
+     * Get the current user location based on IP. Returns an object with user country code, country name, continent name, continent code, ip address and suggested currency. You can use the locale header to get the data in a supported language.
+     *
+     * ([IP Geolocation by DB-IP](https://db-ip.com))
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.Locale>}
+     */
+    get(): Promise<Models.Locale>;
+    /**
+     * List of all locale codes in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.LocaleCodeList>}
+     */
+    listCodes(): Promise<Models.LocaleCodeList>;
+    /**
+     * List of all continents. You can use the locale header to get the data in a supported language.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.ContinentList>}
+     */
+    listContinents(): Promise<Models.ContinentList>;
+    /**
+     * List of all countries. You can use the locale header to get the data in a supported language.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.CountryList>}
+     */
+    listCountries(): Promise<Models.CountryList>;
+    /**
+     * List of all countries that are currently members of the EU. You can use the locale header to get the data in a supported language.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.CountryList>}
+     */
+    listCountriesEU(): Promise<Models.CountryList>;
+    /**
+     * List of all countries phone codes. You can use the locale header to get the data in a supported language.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.PhoneList>}
+     */
+    listCountriesPhones(): Promise<Models.PhoneList>;
+    /**
+     * List of all currencies, including currency symbol, name, plural, and decimal digits for all major and minor currencies. You can use the locale header to get the data in a supported language.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.CurrencyList>}
+     */
+    listCurrencies(): Promise<Models.CurrencyList>;
+    /**
+     * List of all languages classified by ISO 639-1 including 2-letter code, name in English, and name in the respective language.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise<Models.LanguageList>}
+     */
+    listLanguages(): Promise<Models.LanguageList>;
+}