@appwrite.io/console 0.3.0 → 0.4.1

package/src/services/graphql.ts

@@ -11,7 +11,7 @@ export class Graphql extends Service {
      }
 
     /**
-     * GraphQL Endpoint
+     * GraphQL endpoint
      *
      * Execute a GraphQL mutation.
      *
@@ -24,14 +24,14 @@ export class Graphql extends Service {
             throw new AppwriteException('Missing required parameter: "query"');
         }
 
-        let path = '/graphql';
-        let payload: Payload = {};
+        const apiPath = '/graphql';
+        const payload: Payload = {};
 
         if (typeof query !== 'undefined') {
             payload['query'] = query;
         }
 
-        const uri = new URL(this.client.config.endpoint + path);
+        const uri = new URL(this.client.config.endpoint + apiPath);
         return await this.client.call('post', uri, {
             'x-sdk-graphql': 'true',
             'content-type': 'application/json',
@@ -39,7 +39,7 @@ export class Graphql extends Service {
     }
 
     /**
-     * GraphQL Endpoint
+     * GraphQL endpoint
      *
      * Execute a GraphQL mutation.
      *
@@ -52,14 +52,14 @@ export class Graphql extends Service {
             throw new AppwriteException('Missing required parameter: "query"');
         }
 
-        let path = '/graphql/mutation';
-        let payload: Payload = {};
+        const apiPath = '/graphql/mutation';
+        const payload: Payload = {};
 
         if (typeof query !== 'undefined') {
             payload['query'] = query;
         }
 
-        const uri = new URL(this.client.config.endpoint + path);
+        const uri = new URL(this.client.config.endpoint + apiPath);
         return await this.client.call('post', uri, {
             'x-sdk-graphql': 'true',
             'content-type': 'application/json',

package/src/services/health.ts

@@ -19,17 +19,17 @@ export class Health extends Service {
      * @returns {Promise}
     */
     async get(): Promise<Models.HealthStatus> {
-        let path = '/health';
-        let payload: Payload = {};
+        const apiPath = '/health';
+        const payload: Payload = {};
 
-        const uri = new URL(this.client.config.endpoint + path);
+        const uri = new URL(this.client.config.endpoint + apiPath);
         return await this.client.call('get', uri, {
             'content-type': 'application/json',
         }, payload);
     }
 
     /**
-     * Get Antivirus
+     * Get antivirus
      *
      * Check the Appwrite Antivirus server is up and connection is successful.
      *
@@ -37,17 +37,17 @@ export class Health extends Service {
      * @returns {Promise}
     */
     async getAntivirus(): Promise<Models.HealthAntivirus> {
-        let path = '/health/anti-virus';
-        let payload: Payload = {};
+        const apiPath = '/health/anti-virus';
+        const payload: Payload = {};
 
-        const uri = new URL(this.client.config.endpoint + path);
+        const uri = new URL(this.client.config.endpoint + apiPath);
         return await this.client.call('get', uri, {
             'content-type': 'application/json',
         }, payload);
     }
 
     /**
-     * Get Cache
+     * Get cache
      *
      * Check the Appwrite in-memory cache servers are up and connection is
      * successful.
@@ -56,10 +56,10 @@ export class Health extends Service {
      * @returns {Promise}
     */
     async getCache(): Promise<Models.HealthStatus> {
-        let path = '/health/cache';
-        let payload: Payload = {};
+        const apiPath = '/health/cache';
+        const payload: Payload = {};
 
-        const uri = new URL(this.client.config.endpoint + path);
+        const uri = new URL(this.client.config.endpoint + apiPath);
         return await this.client.call('get', uri, {
             'content-type': 'application/json',
         }, payload);
@@ -74,17 +74,17 @@ export class Health extends Service {
      * @returns {Promise}
     */
     async getDB(): Promise<Models.HealthStatus> {
-        let path = '/health/db';
-        let payload: Payload = {};
+        const apiPath = '/health/db';
+        const payload: Payload = {};
 
-        const uri = new URL(this.client.config.endpoint + path);
+        const uri = new URL(this.client.config.endpoint + apiPath);
         return await this.client.call('get', uri, {
             'content-type': 'application/json',
         }, payload);
     }
 
     /**
-     * Get PubSub
+     * Get pubsub
      *
      * Check the Appwrite pub-sub servers are up and connection is successful.
      *
@@ -92,17 +92,17 @@ export class Health extends Service {
      * @returns {Promise}
     */
     async getPubSub(): Promise<Models.HealthStatus> {
-        let path = '/health/pubsub';
-        let payload: Payload = {};
+        const apiPath = '/health/pubsub';
+        const payload: Payload = {};
 
-        const uri = new URL(this.client.config.endpoint + path);
+        const uri = new URL(this.client.config.endpoint + apiPath);
         return await this.client.call('get', uri, {
             'content-type': 'application/json',
         }, payload);
     }
 
     /**
-     * Get Queue
+     * Get queue
      *
      * Check the Appwrite queue messaging servers are up and connection is
      * successful.
@@ -111,92 +111,261 @@ export class Health extends Service {
      * @returns {Promise}
     */
     async getQueue(): Promise<Models.HealthStatus> {
-        let path = '/health/queue';
-        let payload: Payload = {};
+        const apiPath = '/health/queue';
+        const payload: Payload = {};
 
-        const uri = new URL(this.client.config.endpoint + path);
+        const uri = new URL(this.client.config.endpoint + apiPath);
         return await this.client.call('get', uri, {
             'content-type': 'application/json',
         }, payload);
     }
 
     /**
-     * Get Certificates Queue
+     * Get builds queue
+     *
+     * Get the number of builds that are waiting to be processed in the Appwrite
+     * internal queue server.
+     *
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    async getQueueBuilds(threshold?: number): Promise<Models.HealthQueue> {
+        const apiPath = '/health/queue/builds';
+        const payload: Payload = {};
+
+        if (typeof threshold !== 'undefined') {
+            payload['threshold'] = threshold;
+        }
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        return await this.client.call('get', uri, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Get certificates queue
      *
      * 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
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async getQueueCertificates(): Promise<Models.HealthQueue> {
-        let path = '/health/queue/certificates';
-        let payload: Payload = {};
+    async getQueueCertificates(threshold?: number): Promise<Models.HealthQueue> {
+        const apiPath = '/health/queue/certificates';
+        const payload: Payload = {};
 
-        const uri = new URL(this.client.config.endpoint + path);
+        if (typeof threshold !== 'undefined') {
+            payload['threshold'] = threshold;
+        }
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
         return await this.client.call('get', uri, {
             'content-type': 'application/json',
         }, payload);
     }
 
     /**
-     * Get Functions Queue
+     * Get databases queue
      *
+     * Get the number of database changes that are waiting to be processed in the
+     * Appwrite internal queue server.
      *
+     * @param {string} name
+     * @param {number} threshold
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async getQueueFunctions(): Promise<Models.HealthQueue> {
-        let path = '/health/queue/functions';
-        let payload: Payload = {};
+    async getQueueDatabases(name?: string, threshold?: number): Promise<Models.HealthQueue> {
+        const apiPath = '/health/queue/databases';
+        const payload: Payload = {};
+
+        if (typeof name !== 'undefined') {
+            payload['name'] = name;
+        }
+
+        if (typeof threshold !== 'undefined') {
+            payload['threshold'] = threshold;
+        }
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        return await this.client.call('get', uri, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Get deletes queue
+     *
+     * Get the number of background destructive changes that are waiting to be
+     * processed in the Appwrite internal queue server.
+     *
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    async getQueueDeletes(threshold?: number): Promise<Models.HealthQueue> {
+        const apiPath = '/health/queue/deletes';
+        const payload: Payload = {};
+
+        if (typeof threshold !== 'undefined') {
+            payload['threshold'] = threshold;
+        }
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        return await this.client.call('get', uri, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Get functions queue
+     *
+     *
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    async getQueueFunctions(threshold?: number): Promise<Models.HealthQueue> {
+        const apiPath = '/health/queue/functions';
+        const payload: Payload = {};
+
+        if (typeof threshold !== 'undefined') {
+            payload['threshold'] = threshold;
+        }
 
-        const uri = new URL(this.client.config.endpoint + path);
+        const uri = new URL(this.client.config.endpoint + apiPath);
         return await this.client.call('get', uri, {
             'content-type': 'application/json',
         }, payload);
     }
 
     /**
-     * Get Logs Queue
+     * Get logs queue
      *
      * Get the number of logs that are waiting to be processed in the Appwrite
      * internal queue server.
      *
+     * @param {number} threshold
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async getQueueLogs(): Promise<Models.HealthQueue> {
-        let path = '/health/queue/logs';
-        let payload: Payload = {};
+    async getQueueLogs(threshold?: number): Promise<Models.HealthQueue> {
+        const apiPath = '/health/queue/logs';
+        const payload: Payload = {};
 
-        const uri = new URL(this.client.config.endpoint + path);
+        if (typeof threshold !== 'undefined') {
+            payload['threshold'] = threshold;
+        }
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        return await this.client.call('get', uri, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Get mails queue
+     *
+     * Get the number of mails that are waiting to be processed in the Appwrite
+     * internal queue server.
+     *
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    async getQueueMails(threshold?: number): Promise<Models.HealthQueue> {
+        const apiPath = '/health/queue/mails';
+        const payload: Payload = {};
+
+        if (typeof threshold !== 'undefined') {
+            payload['threshold'] = threshold;
+        }
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
         return await this.client.call('get', uri, {
             'content-type': 'application/json',
         }, payload);
     }
 
     /**
-     * Get Webhooks Queue
+     * Get messaging queue
+     *
+     * Get the number of messages that are waiting to be processed in the Appwrite
+     * internal queue server.
+     *
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    async getQueueMessaging(threshold?: number): Promise<Models.HealthQueue> {
+        const apiPath = '/health/queue/messaging';
+        const payload: Payload = {};
+
+        if (typeof threshold !== 'undefined') {
+            payload['threshold'] = threshold;
+        }
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        return await this.client.call('get', uri, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Get migrations queue
+     *
+     * Get the number of migrations that are waiting to be processed in the
+     * Appwrite internal queue server.
+     *
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    async getQueueMigrations(threshold?: number): Promise<Models.HealthQueue> {
+        const apiPath = '/health/queue/migrations';
+        const payload: Payload = {};
+
+        if (typeof threshold !== 'undefined') {
+            payload['threshold'] = threshold;
+        }
+
+        const uri = new URL(this.client.config.endpoint + apiPath);
+        return await this.client.call('get', uri, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Get webhooks queue
      *
      * Get the number of webhooks that are waiting to be processed in the Appwrite
      * internal queue server.
      *
+     * @param {number} threshold
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    async getQueueWebhooks(): Promise<Models.HealthQueue> {
-        let path = '/health/queue/webhooks';
-        let payload: Payload = {};
+    async getQueueWebhooks(threshold?: number): Promise<Models.HealthQueue> {
+        const apiPath = '/health/queue/webhooks';
+        const payload: Payload = {};
+
+        if (typeof threshold !== 'undefined') {
+            payload['threshold'] = threshold;
+        }
 
-        const uri = new URL(this.client.config.endpoint + path);
+        const uri = new URL(this.client.config.endpoint + apiPath);
         return await this.client.call('get', uri, {
             'content-type': 'application/json',
         }, payload);
     }
 
     /**
-     * Get Local Storage
+     * Get local storage
      *
      * Check the Appwrite local storage device is up and connection is successful.
      *
@@ -204,17 +373,17 @@ export class Health extends Service {
      * @returns {Promise}
     */
     async getStorageLocal(): Promise<Models.HealthStatus> {
-        let path = '/health/storage/local';
-        let payload: Payload = {};
+        const apiPath = '/health/storage/local';
+        const payload: Payload = {};
 
-        const uri = new URL(this.client.config.endpoint + path);
+        const uri = new URL(this.client.config.endpoint + apiPath);
         return await this.client.call('get', uri, {
             'content-type': 'application/json',
         }, payload);
     }
 
     /**
-     * Get Time
+     * Get time
      *
      * Check the Appwrite server time is synced with Google remote NTP server. We
      * use this technology to smoothly handle leap seconds with no disruptive
@@ -228,10 +397,10 @@ export class Health extends Service {
      * @returns {Promise}
     */
     async getTime(): Promise<Models.HealthTime> {
-        let path = '/health/time';
-        let payload: Payload = {};
+        const apiPath = '/health/time';
+        const payload: Payload = {};
 
-        const uri = new URL(this.client.config.endpoint + path);
+        const uri = new URL(this.client.config.endpoint + apiPath);
         return await this.client.call('get', uri, {
             'content-type': 'application/json',
         }, payload);

package/src/services/locale.ts

@@ -11,7 +11,7 @@ export class Locale extends Service {
      }
 
     /**
-     * Get User Locale
+     * Get user locale
      *
      * Get the current user location based on IP. Returns an object with user
      * country code, country name, continent name, continent code, ip address and
@@ -24,10 +24,10 @@ export class Locale extends Service {
      * @returns {Promise}
     */
     async get(): Promise<Models.Locale> {
-        let path = '/locale';
-        let payload: Payload = {};
+        const apiPath = '/locale';
+        const payload: Payload = {};
 
-        const uri = new URL(this.client.config.endpoint + path);
+        const uri = new URL(this.client.config.endpoint + apiPath);
         return await this.client.call('get', uri, {
             'content-type': 'application/json',
         }, payload);
@@ -43,17 +43,17 @@ export class Locale extends Service {
      * @returns {Promise}
     */
     async listCodes(): Promise<Models.LocaleCodeList> {
-        let path = '/locale/codes';
-        let payload: Payload = {};
+        const apiPath = '/locale/codes';
+        const payload: Payload = {};
 
-        const uri = new URL(this.client.config.endpoint + path);
+        const uri = new URL(this.client.config.endpoint + apiPath);
         return await this.client.call('get', uri, {
             'content-type': 'application/json',
         }, payload);
     }
 
     /**
-     * List Continents
+     * List continents
      *
      * List of all continents. You can use the locale header to get the data in a
      * supported language.
@@ -62,17 +62,17 @@ export class Locale extends Service {
      * @returns {Promise}
     */
     async listContinents(): Promise<Models.ContinentList> {
-        let path = '/locale/continents';
-        let payload: Payload = {};
+        const apiPath = '/locale/continents';
+        const payload: Payload = {};
 
-        const uri = new URL(this.client.config.endpoint + path);
+        const uri = new URL(this.client.config.endpoint + apiPath);
         return await this.client.call('get', uri, {
             'content-type': 'application/json',
         }, payload);
     }
 
     /**
-     * List Countries
+     * List countries
      *
      * List of all countries. You can use the locale header to get the data in a
      * supported language.
@@ -81,17 +81,17 @@ export class Locale extends Service {
      * @returns {Promise}
     */
     async listCountries(): Promise<Models.CountryList> {
-        let path = '/locale/countries';
-        let payload: Payload = {};
+        const apiPath = '/locale/countries';
+        const payload: Payload = {};
 
-        const uri = new URL(this.client.config.endpoint + path);
+        const uri = new URL(this.client.config.endpoint + apiPath);
         return await this.client.call('get', uri, {
             'content-type': 'application/json',
         }, payload);
     }
 
     /**
-     * List EU Countries
+     * List EU countries
      *
      * 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.
@@ -100,17 +100,17 @@ export class Locale extends Service {
      * @returns {Promise}
     */
     async listCountriesEU(): Promise<Models.CountryList> {
-        let path = '/locale/countries/eu';
-        let payload: Payload = {};
+        const apiPath = '/locale/countries/eu';
+        const payload: Payload = {};
 
-        const uri = new URL(this.client.config.endpoint + path);
+        const uri = new URL(this.client.config.endpoint + apiPath);
         return await this.client.call('get', uri, {
             'content-type': 'application/json',
         }, payload);
     }
 
     /**
-     * List Countries Phone Codes
+     * List countries phone codes
      *
      * List of all countries phone codes. You can use the locale header to get the
      * data in a supported language.
@@ -119,17 +119,17 @@ export class Locale extends Service {
      * @returns {Promise}
     */
     async listCountriesPhones(): Promise<Models.PhoneList> {
-        let path = '/locale/countries/phones';
-        let payload: Payload = {};
+        const apiPath = '/locale/countries/phones';
+        const payload: Payload = {};
 
-        const uri = new URL(this.client.config.endpoint + path);
+        const uri = new URL(this.client.config.endpoint + apiPath);
         return await this.client.call('get', uri, {
             'content-type': 'application/json',
         }, payload);
     }
 
     /**
-     * List Currencies
+     * List currencies
      *
      * List of all currencies, including currency symbol, name, plural, and
      * decimal digits for all major and minor currencies. You can use the locale
@@ -139,17 +139,17 @@ export class Locale extends Service {
      * @returns {Promise}
     */
     async listCurrencies(): Promise<Models.CurrencyList> {
-        let path = '/locale/currencies';
-        let payload: Payload = {};
+        const apiPath = '/locale/currencies';
+        const payload: Payload = {};
 
-        const uri = new URL(this.client.config.endpoint + path);
+        const uri = new URL(this.client.config.endpoint + apiPath);
         return await this.client.call('get', uri, {
             'content-type': 'application/json',
         }, payload);
     }
 
     /**
-     * List Languages
+     * List languages
      *
      * List of all languages classified by ISO 639-1 including 2-letter code, name
      * in English, and name in the respective language.
@@ -158,10 +158,10 @@ export class Locale extends Service {
      * @returns {Promise}
     */
     async listLanguages(): Promise<Models.LanguageList> {
-        let path = '/locale/languages';
-        let payload: Payload = {};
+        const apiPath = '/locale/languages';
+        const payload: Payload = {};
 
-        const uri = new URL(this.client.config.endpoint + path);
+        const uri = new URL(this.client.config.endpoint + apiPath);
         return await this.client.call('get', uri, {
             'content-type': 'application/json',
         }, payload);