node-appwrite 11.0.0 → 12.0.0-rc.4

package/lib/services/health.js

@@ -5,6 +5,8 @@ const client = require('../client.js');
 const Stream = require('stream');
 const { promisify } = require('util');
 const fs = require('fs');
+const { File } = require('undici');
+const Query = require('../query.js');
 
 class Health extends Service {
 
@@ -32,7 +34,7 @@ class Health extends Service {
     }
 
     /**
-     * Get Antivirus
+     * Get antivirus
      *
      * Check the Appwrite Antivirus server is up and connection is successful.
      *
@@ -49,7 +51,7 @@ class Health extends Service {
     }
 
     /**
-     * Get Cache
+     * Get cache
      *
      * Check the Appwrite in-memory cache servers are up and connection is
      * successful.
@@ -66,6 +68,28 @@ class Health extends Service {
         }, payload);
     }
 
+    /**
+     * Get the SSL certificate for a domain
+     *
+     * Get the SSL certificate for a domain
+     *
+     * @param {string} domain
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async getCertificate(domain) {
+        const apiPath = '/health/certificate';
+        let payload = {};
+
+        if (typeof domain !== 'undefined') {
+            payload['domain'] = domain;
+        }
+
+        return await this.client.call('get', apiPath, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
     /**
      * Get DB
      *
@@ -84,7 +108,7 @@ class Health extends Service {
     }
 
     /**
-     * Get PubSub
+     * Get pubsub
      *
      * Check the Appwrite pub-sub servers are up and connection is successful.
      *
@@ -101,7 +125,7 @@ class Health extends Service {
     }
 
     /**
-     * Get Queue
+     * Get queue
      *
      * Check the Appwrite queue messaging servers are up and connection is
      * successful.
@@ -119,77 +143,268 @@ class Health extends Service {
     }
 
     /**
-     * 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) {
+        const apiPath = '/health/queue/builds';
+        let payload = {};
+
+        if (typeof threshold !== 'undefined') {
+            payload['threshold'] = threshold;
+        }
+
+        return await this.client.call('get', apiPath, {
+            '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() {
+    async getQueueCertificates(threshold) {
         const apiPath = '/health/queue/certificates';
         let payload = {};
 
+        if (typeof threshold !== 'undefined') {
+            payload['threshold'] = threshold;
+        }
+
         return await this.client.call('get', apiPath, {
             '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() {
+    async getQueueDatabases(name, threshold) {
+        const apiPath = '/health/queue/databases';
+        let payload = {};
+
+        if (typeof name !== 'undefined') {
+            payload['name'] = name;
+        }
+
+        if (typeof threshold !== 'undefined') {
+            payload['threshold'] = threshold;
+        }
+
+        return await this.client.call('get', apiPath, {
+            '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) {
+        const apiPath = '/health/queue/deletes';
+        let payload = {};
+
+        if (typeof threshold !== 'undefined') {
+            payload['threshold'] = threshold;
+        }
+
+        return await this.client.call('get', apiPath, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Get number of failed queue jobs
+     *
+     * Returns the amount of failed jobs in a given queue.
+     * 
+     *
+     * @param {Name} name
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async getFailedJobs(name, threshold) {
+        const apiPath = '/health/queue/failed/{name}'.replace('{name}', name);
+        let payload = {};
+        if (typeof name === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "name"');
+        }
+
+
+        if (typeof threshold !== 'undefined') {
+            payload['threshold'] = threshold;
+        }
+
+        return await this.client.call('get', apiPath, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Get functions queue
+     *
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async getQueueFunctions(threshold) {
         const apiPath = '/health/queue/functions';
         let payload = {};
 
+        if (typeof threshold !== 'undefined') {
+            payload['threshold'] = threshold;
+        }
+
         return await this.client.call('get', apiPath, {
             '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() {
+    async getQueueLogs(threshold) {
         const apiPath = '/health/queue/logs';
         let payload = {};
 
+        if (typeof threshold !== 'undefined') {
+            payload['threshold'] = threshold;
+        }
+
+        return await this.client.call('get', apiPath, {
+            '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) {
+        const apiPath = '/health/queue/mails';
+        let payload = {};
+
+        if (typeof threshold !== 'undefined') {
+            payload['threshold'] = threshold;
+        }
+
+        return await this.client.call('get', apiPath, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * 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) {
+        const apiPath = '/health/queue/messaging';
+        let payload = {};
+
+        if (typeof threshold !== 'undefined') {
+            payload['threshold'] = threshold;
+        }
+
+        return await this.client.call('get', apiPath, {
+            '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) {
+        const apiPath = '/health/queue/migrations';
+        let payload = {};
+
+        if (typeof threshold !== 'undefined') {
+            payload['threshold'] = threshold;
+        }
+
         return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
 
     /**
-     * Get Webhooks Queue
+     * 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() {
+    async getQueueWebhooks(threshold) {
         const apiPath = '/health/queue/webhooks';
         let payload = {};
 
+        if (typeof threshold !== 'undefined') {
+            payload['threshold'] = threshold;
+        }
+
         return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
 
     /**
-     * Get Local Storage
+     * Get local storage
      *
      * Check the Appwrite local storage device is up and connection is successful.
      *
@@ -206,7 +421,7 @@ class Health extends Service {
     }
 
     /**
-     * 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

package/lib/services/locale.js

@@ -5,6 +5,8 @@ const client = require('../client.js');
 const Stream = require('stream');
 const { promisify } = require('util');
 const fs = require('fs');
+const { File } = require('undici');
+const Query = require('../query.js');
 
 class Locale extends Service {
 
@@ -15,7 +17,7 @@ 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
@@ -55,7 +57,7 @@ class Locale extends Service {
     }
 
     /**
-     * List Continents
+     * List continents
      *
      * List of all continents. You can use the locale header to get the data in a
      * supported language.
@@ -73,7 +75,7 @@ class Locale extends Service {
     }
 
     /**
-     * List Countries
+     * List countries
      *
      * List of all countries. You can use the locale header to get the data in a
      * supported language.
@@ -91,7 +93,7 @@ class Locale extends Service {
     }
 
     /**
-     * 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.
@@ -109,7 +111,7 @@ class Locale extends Service {
     }
 
     /**
-     * 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.
@@ -127,7 +129,7 @@ class Locale extends Service {
     }
 
     /**
-     * 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
@@ -146,7 +148,7 @@ class Locale extends Service {
     }
 
     /**
-     * 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.