node-appwrite 10.0.1 → 11.1.0

package/lib/services/health.js

@@ -32,7 +32,7 @@ class Health extends Service {
     }
 
     /**
-     * Get Antivirus
+     * Get antivirus
      *
      * Check the Appwrite Antivirus server is up and connection is successful.
      *
@@ -49,7 +49,7 @@ class Health extends Service {
     }
 
     /**
-     * Get Cache
+     * Get cache
      *
      * Check the Appwrite in-memory cache servers are up and connection is
      * successful.
@@ -84,7 +84,7 @@ class Health extends Service {
     }
 
     /**
-     * Get PubSub
+     * Get pubsub
      *
      * Check the Appwrite pub-sub servers are up and connection is successful.
      *
@@ -101,7 +101,7 @@ class Health extends Service {
     }
 
     /**
-     * Get Queue
+     * Get queue
      *
      * Check the Appwrite queue messaging servers are up and connection is
      * successful.
@@ -119,77 +119,240 @@ 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 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 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 Functions Queue
+     * 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 getQueueFunctions() {
+    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 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 Webhooks Queue
+     * 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 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 +369,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

@@ -15,7 +15,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 +55,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 +73,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 +91,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 +109,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 +127,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 +146,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.

package/lib/services/storage.js

@@ -118,7 +118,7 @@ class Storage extends Service {
     }
 
     /**
-     * Get Bucket
+     * Get bucket
      *
      * Get a storage bucket by its unique ID. This endpoint response returns a
      * JSON object with the storage bucket metadata.
@@ -141,7 +141,7 @@ class Storage extends Service {
     }
 
     /**
-     * Update Bucket
+     * Update bucket
      *
      * Update a storage bucket by its unique ID.
      *
@@ -212,7 +212,7 @@ class Storage extends Service {
     }
 
     /**
-     * Delete Bucket
+     * Delete bucket
      *
      * Delete a storage bucket by its unique ID.
      *
@@ -234,7 +234,7 @@ class Storage extends Service {
     }
 
     /**
-     * List Files
+     * List files
      *
      * Get a list of all the user files. You can use the query params to filter
      * your results.
@@ -267,12 +267,12 @@ class Storage extends Service {
     }
 
     /**
-     * Create File
+     * Create file
      *
      * Create a new file. Before using this route, you should create a new bucket
      * resource using either a [server
-     * integration](/docs/server/storage#storageCreateBucket) API or directly from
-     * your Appwrite console.
+     * integration](https://appwrite.io/docs/server/storage#storageCreateBucket)
+     * API or directly from your Appwrite console.
      * 
      * Larger files should be uploaded using multiple requests with the
      * [content-range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range)
@@ -458,7 +458,7 @@ class Storage extends Service {
     }
 
     /**
-     * Get File
+     * Get file
      *
      * Get a file by its unique ID. This endpoint response returns a JSON object
      * with the file metadata.
@@ -486,7 +486,7 @@ class Storage extends Service {
     }
 
     /**
-     * Update File
+     * Update file
      *
      * Update a file by its unique ID. Only users with write permissions have
      * access to update this resource.
@@ -552,7 +552,7 @@ class Storage extends Service {
     }
 
     /**
-     * Get File for Download
+     * Get file for download
      *
      * Get a file content by its unique ID. The endpoint response return with a
      * 'Content-Disposition: attachment' header that tells the browser to start
@@ -581,7 +581,7 @@ class Storage extends Service {
     }
 
     /**
-     * Get File Preview
+     * Get file preview
      *
      * Get a file preview image. Currently, this method supports preview for image
      * files (jpg, png, and gif), other supported formats, like pdf, docs, slides,
@@ -667,7 +667,7 @@ class Storage extends Service {
     }
 
     /**
-     * Get File for View
+     * Get file for view
      *
      * Get a file content by its unique ID. This endpoint is similar to the
      * download method but returns with no  'Content-Disposition: attachment'

package/lib/services/teams.js

@@ -15,7 +15,7 @@ class Teams extends Service {
 
 
     /**
-     * List Teams
+     * List teams
      *
      * Get a list of all the teams in which the current user is a member. You can
      * use the parameters to filter your results.
@@ -43,7 +43,7 @@ class Teams extends Service {
     }
 
     /**
-     * Create Team
+     * Create team
      *
      * Create a new team. The user who creates the team will automatically be
      * assigned as the owner of the team. Only the users with the owner role can
@@ -85,7 +85,7 @@ class Teams extends Service {
     }
 
     /**
-     * Get Team
+     * Get team
      *
      * Get a team by its ID. All team members have read access for this resource.
      *
@@ -107,7 +107,7 @@ class Teams extends Service {
     }
 
     /**
-     * Update Name
+     * Update name
      *
      * Update the team's name by its unique ID.
      *
@@ -138,7 +138,7 @@ class Teams extends Service {
     }
 
     /**
-     * Delete Team
+     * Delete team
      *
      * Delete a team using its ID. Only team members with the owner role can
      * delete the team.
@@ -161,7 +161,7 @@ class Teams extends Service {
     }
 
     /**
-     * List Team Memberships
+     * List team memberships
      *
      * Use this endpoint to list a team's members using the team's ID. All team
      * members have read access to this endpoint.
@@ -194,7 +194,7 @@ class Teams extends Service {
     }
 
     /**
-     * Create Team Membership
+     * Create team membership
      *
      * Invite a new member to join your team. Provide an ID for existing users, or
      * invite unregistered users using an email or phone number. If initiated from
@@ -209,8 +209,8 @@ class Teams extends Service {
      * 
      * Use the `url` parameter to redirect the user from the invitation email to
      * your app. After the user is redirected, use the [Update Team Membership
-     * Status](/docs/client/teams#teamsUpdateMembershipStatus) endpoint to allow
-     * the user to accept the invitation to the team. 
+     * Status](https://appwrite.io/docs/references/cloud/client-web/teams#updateMembershipStatus)
+     * endpoint to allow the user to accept the invitation to the team. 
      * 
      * Please note that to avoid a [Redirect
      * Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md)
@@ -220,15 +220,15 @@ class Teams extends Service {
      *
      * @param {string} teamId
      * @param {string[]} roles
-     * @param {string} url
      * @param {string} email
      * @param {string} userId
      * @param {string} phone
+     * @param {string} url
      * @param {string} name
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async createMembership(teamId, roles, url, email, userId, phone, name) {
+    async createMembership(teamId, roles, email, userId, phone, url, name) {
         const apiPath = '/teams/{teamId}/memberships'.replace('{teamId}', teamId);
         let payload = {};
         if (typeof teamId === 'undefined') {
@@ -239,10 +239,6 @@ class Teams extends Service {
             throw new AppwriteException('Missing required parameter: "roles"');
         }
 
-        if (typeof url === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "url"');
-        }
-
 
         if (typeof email !== 'undefined') {
             payload['email'] = email;
@@ -274,7 +270,7 @@ class Teams extends Service {
     }
 
     /**
-     * Get Team Membership
+     * Get team membership
      *
      * Get a team member by the membership unique id. All team members have read
      * access for this resource.
@@ -302,11 +298,11 @@ class Teams extends Service {
     }
 
     /**
-     * Update Membership
+     * Update membership
      *
      * Modify the roles of a team member. Only team members with the owner role
      * have access to this endpoint. Learn more about [roles and
-     * permissions](/docs/permissions).
+     * permissions](https://appwrite.io/docs/permissions).
      * 
      *
      * @param {string} teamId
@@ -341,7 +337,7 @@ class Teams extends Service {
     }
 
     /**
-     * Delete Team Membership
+     * Delete team membership
      *
      * This endpoint allows a user to leave a team or for a team owner to delete
      * the membership of any other team member. You can also use this endpoint to
@@ -370,7 +366,7 @@ class Teams extends Service {
     }
 
     /**
-     * Update Team Membership Status
+     * Update team membership status
      *
      * Use this endpoint to allow a user to accept an invitation to join a team
      * after being redirected back to your app from the invitation email received
@@ -421,11 +417,11 @@ class Teams extends Service {
     }
 
     /**
-     * Get Team Preferences
+     * Get team preferences
      *
      * Get the team's shared preferences by its unique ID. If a preference doesn't
      * need to be shared by all team members, prefer storing them in [user
-     * preferences](/docs/client/account#accountGetPrefs).
+     * preferences](https://appwrite.io/docs/references/cloud/client-web/account#getPrefs).
      *
      * @param {string} teamId
      * @throws {AppwriteException}
@@ -445,7 +441,7 @@ class Teams extends Service {
     }
 
     /**
-     * Update Preferences
+     * Update preferences
      *
      * Update the team's preferences by its unique ID. The object you pass is
      * stored as is and replaces any previous value. The maximum allowed prefs