node-appwrite 12.0.0-rc.4 → 12.0.1

package/lib/services/databases.js

@@ -368,6 +368,8 @@ class Databases extends Service {
     /**
      * List attributes
      *
+     * List attributes in the collection.
+     *
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string[]} queries
@@ -454,6 +456,9 @@ class Databases extends Service {
     /**
      * Update boolean attribute
      *
+     * Update a boolean attribute. Changing the `default` value will not update
+     * already existing documents.
+     *
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} key
@@ -502,6 +507,8 @@ class Databases extends Service {
     /**
      * Create datetime attribute
      *
+     * Create a date time attribute according to the ISO 8601 standard.
+     *
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} key
@@ -555,6 +562,9 @@ class Databases extends Service {
     /**
      * Update dateTime attribute
      *
+     * Update a date time attribute. Changing the `default` value will not update
+     * already existing documents.
+     *
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} key
@@ -711,6 +721,10 @@ class Databases extends Service {
     /**
      * Create enum attribute
      *
+     * Create an enumeration attribute. The `elements` param acts as a white-list
+     * of accepted values for this attribute. 
+     * 
+     *
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} key
@@ -1513,6 +1527,8 @@ class Databases extends Service {
     /**
      * Get attribute
      *
+     * Get attribute by ID.
+     *
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} key
@@ -1543,6 +1559,8 @@ class Databases extends Service {
     /**
      * Delete attribute
      *
+     * Deletes an attribute.
+     *
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} key
@@ -1811,6 +1829,8 @@ class Databases extends Service {
     /**
      * List indexes
      *
+     * List indexes in the collection.
+     *
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string[]} queries
@@ -1841,6 +1861,10 @@ class Databases extends Service {
     /**
      * Create index
      *
+     * Creates an index on the attributes listed. Your index should include all
+     * the attributes you will query in a single request.
+     * Attributes can be `key`, `fulltext`, and `unique`.
+     *
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} key
@@ -1898,6 +1922,8 @@ class Databases extends Service {
     /**
      * Get index
      *
+     * Get index by ID.
+     *
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} key
@@ -1928,6 +1954,8 @@ class Databases extends Service {
     /**
      * Delete index
      *
+     * Delete an index.
+     *
      * @param {string} databaseId
      * @param {string} collectionId
      * @param {string} key

package/lib/services/health.js

@@ -271,6 +271,9 @@ class Health extends Service {
     /**
      * Get functions queue
      *
+     * Get the number of function executions that are waiting to be processed in
+     * the Appwrite internal queue server.
+     *
      * @param {number} threshold
      * @throws {AppwriteException}
      * @returns {Promise}
@@ -380,6 +383,52 @@ class Health extends Service {
         }, payload);
     }
 
+    /**
+     * Get usage queue
+     *
+     * Get the number of metrics that are waiting to be processed in the Appwrite
+     * internal queue server.
+     *
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async getQueueUsage(threshold) {
+        const apiPath = '/health/queue/usage';
+        let payload = {};
+
+        if (typeof threshold !== 'undefined') {
+            payload['threshold'] = threshold;
+        }
+
+        return await this.client.call('get', apiPath, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Get usage dump queue
+     *
+     * Get the number of projects containing metrics that are waiting to be
+     * processed in the Appwrite internal queue server.
+     *
+     * @param {number} threshold
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async getQueueUsageDump(threshold) {
+        const apiPath = '/health/queue/usage-dump';
+        let payload = {};
+
+        if (typeof threshold !== 'undefined') {
+            payload['threshold'] = threshold;
+        }
+
+        return await this.client.call('get', apiPath, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
     /**
      * Get webhooks queue
      *
@@ -403,6 +452,23 @@ class Health extends Service {
         }, payload);
     }
 
+    /**
+     * Get storage
+     *
+     * Check the Appwrite storage device is up and connection is successful.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async getStorage() {
+        const apiPath = '/health/storage';
+        let payload = {};
+
+        return await this.client.call('get', apiPath, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
     /**
      * Get local storage
      *

package/lib/services/messaging.js

@@ -44,7 +44,7 @@ class Messaging extends Service {
     }
 
     /**
-     * Create an email
+     * Create email
      *
      * Create a new email message.
      *
@@ -57,13 +57,13 @@ class Messaging extends Service {
      * @param {string[]} cc
      * @param {string[]} bcc
      * @param {string[]} attachments
-     * @param {MessageStatus} status
+     * @param {boolean} draft
      * @param {boolean} html
      * @param {string} scheduledAt
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async createEmail(messageId, subject, content, topics, users, targets, cc, bcc, attachments, status, html, scheduledAt) {
+    async createEmail(messageId, subject, content, topics, users, targets, cc, bcc, attachments, draft, html, scheduledAt) {
         const apiPath = '/messaging/messages/email';
         let payload = {};
         if (typeof messageId === 'undefined') {
@@ -115,8 +115,8 @@ class Messaging extends Service {
             payload['attachments'] = attachments;
         }
 
-        if (typeof status !== 'undefined') {
-            payload['status'] = status;
+        if (typeof draft !== 'undefined') {
+            payload['draft'] = draft;
         }
 
         if (typeof html !== 'undefined') {
@@ -133,7 +133,7 @@ class Messaging extends Service {
     }
 
     /**
-     * Update an email
+     * Update email
      *
      * Update an email message by its unique ID.
      * 
@@ -144,7 +144,7 @@ class Messaging extends Service {
      * @param {string[]} targets
      * @param {string} subject
      * @param {string} content
-     * @param {MessageStatus} status
+     * @param {boolean} draft
      * @param {boolean} html
      * @param {string[]} cc
      * @param {string[]} bcc
@@ -152,7 +152,7 @@ class Messaging extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async updateEmail(messageId, topics, users, targets, subject, content, status, html, cc, bcc, scheduledAt) {
+    async updateEmail(messageId, topics, users, targets, subject, content, draft, html, cc, bcc, scheduledAt) {
         const apiPath = '/messaging/messages/email/{messageId}'.replace('{messageId}', messageId);
         let payload = {};
         if (typeof messageId === 'undefined') {
@@ -180,8 +180,8 @@ class Messaging extends Service {
             payload['content'] = content;
         }
 
-        if (typeof status !== 'undefined') {
-            payload['status'] = status;
+        if (typeof draft !== 'undefined') {
+            payload['draft'] = draft;
         }
 
         if (typeof html !== 'undefined') {
@@ -206,7 +206,7 @@ class Messaging extends Service {
     }
 
     /**
-     * Create a push notification
+     * Create push notification
      *
      * Create a new push notification.
      *
@@ -224,12 +224,12 @@ class Messaging extends Service {
      * @param {string} color
      * @param {string} tag
      * @param {string} badge
-     * @param {MessageStatus} status
+     * @param {boolean} draft
      * @param {string} scheduledAt
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async createPush(messageId, title, body, topics, users, targets, data, action, image, icon, sound, color, tag, badge, status, scheduledAt) {
+    async createPush(messageId, title, body, topics, users, targets, data, action, image, icon, sound, color, tag, badge, draft, scheduledAt) {
         const apiPath = '/messaging/messages/push';
         let payload = {};
         if (typeof messageId === 'undefined') {
@@ -301,8 +301,8 @@ class Messaging extends Service {
             payload['badge'] = badge;
         }
 
-        if (typeof status !== 'undefined') {
-            payload['status'] = status;
+        if (typeof draft !== 'undefined') {
+            payload['draft'] = draft;
         }
 
         if (typeof scheduledAt !== 'undefined') {
@@ -315,7 +315,7 @@ class Messaging extends Service {
     }
 
     /**
-     * Update a push notification
+     * Update push notification
      *
      * Update a push notification by its unique ID.
      * 
@@ -334,12 +334,12 @@ class Messaging extends Service {
      * @param {string} color
      * @param {string} tag
      * @param {number} badge
-     * @param {MessageStatus} status
+     * @param {boolean} draft
      * @param {string} scheduledAt
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async updatePush(messageId, topics, users, targets, title, body, data, action, image, icon, sound, color, tag, badge, status, scheduledAt) {
+    async updatePush(messageId, topics, users, targets, title, body, data, action, image, icon, sound, color, tag, badge, draft, scheduledAt) {
         const apiPath = '/messaging/messages/push/{messageId}'.replace('{messageId}', messageId);
         let payload = {};
         if (typeof messageId === 'undefined') {
@@ -399,8 +399,8 @@ class Messaging extends Service {
             payload['badge'] = badge;
         }
 
-        if (typeof status !== 'undefined') {
-            payload['status'] = status;
+        if (typeof draft !== 'undefined') {
+            payload['draft'] = draft;
         }
 
         if (typeof scheduledAt !== 'undefined') {
@@ -413,7 +413,7 @@ class Messaging extends Service {
     }
 
     /**
-     * Create an SMS
+     * Create SMS
      *
      * Create a new SMS message.
      *
@@ -422,12 +422,12 @@ class Messaging extends Service {
      * @param {string[]} topics
      * @param {string[]} users
      * @param {string[]} targets
-     * @param {MessageStatus} status
+     * @param {boolean} draft
      * @param {string} scheduledAt
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async createSms(messageId, content, topics, users, targets, status, scheduledAt) {
+    async createSms(messageId, content, topics, users, targets, draft, scheduledAt) {
         const apiPath = '/messaging/messages/sms';
         let payload = {};
         if (typeof messageId === 'undefined') {
@@ -459,8 +459,8 @@ class Messaging extends Service {
             payload['targets'] = targets;
         }
 
-        if (typeof status !== 'undefined') {
-            payload['status'] = status;
+        if (typeof draft !== 'undefined') {
+            payload['draft'] = draft;
         }
 
         if (typeof scheduledAt !== 'undefined') {
@@ -473,7 +473,7 @@ class Messaging extends Service {
     }
 
     /**
-     * Update an SMS
+     * Update SMS
      *
      * Update an email message by its unique ID.
      * 
@@ -483,12 +483,12 @@ class Messaging extends Service {
      * @param {string[]} users
      * @param {string[]} targets
      * @param {string} content
-     * @param {MessageStatus} status
+     * @param {boolean} draft
      * @param {string} scheduledAt
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async updateSms(messageId, topics, users, targets, content, status, scheduledAt) {
+    async updateSms(messageId, topics, users, targets, content, draft, scheduledAt) {
         const apiPath = '/messaging/messages/sms/{messageId}'.replace('{messageId}', messageId);
         let payload = {};
         if (typeof messageId === 'undefined') {
@@ -512,8 +512,8 @@ class Messaging extends Service {
             payload['content'] = content;
         }
 
-        if (typeof status !== 'undefined') {
-            payload['status'] = status;
+        if (typeof draft !== 'undefined') {
+            payload['draft'] = draft;
         }
 
         if (typeof scheduledAt !== 'undefined') {
@@ -526,7 +526,7 @@ class Messaging extends Service {
     }
 
     /**
-     * Get a message
+     * Get message
      *
      * Get a message by its unique ID.
      * 
@@ -549,7 +549,10 @@ class Messaging extends Service {
     }
 
     /**
-     * Delete a message
+     * Delete message
+     *
+     * Delete a message. If the message is not a draft or scheduled, but has been
+     * sent, this will not recall the message.
      *
      * @param {string} messageId
      * @throws {AppwriteException}
@@ -660,11 +663,12 @@ class Messaging extends Service {
      * @param {string} authKeyId
      * @param {string} teamId
      * @param {string} bundleId
+     * @param {boolean} sandbox
      * @param {boolean} enabled
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async createApnsProvider(providerId, name, authKey, authKeyId, teamId, bundleId, enabled) {
+    async createApnsProvider(providerId, name, authKey, authKeyId, teamId, bundleId, sandbox, enabled) {
         const apiPath = '/messaging/providers/apns';
         let payload = {};
         if (typeof providerId === 'undefined') {
@@ -700,6 +704,10 @@ class Messaging extends Service {
             payload['bundleId'] = bundleId;
         }
 
+        if (typeof sandbox !== 'undefined') {
+            payload['sandbox'] = sandbox;
+        }
+
         if (typeof enabled !== 'undefined') {
             payload['enabled'] = enabled;
         }
@@ -721,10 +729,11 @@ class Messaging extends Service {
      * @param {string} authKeyId
      * @param {string} teamId
      * @param {string} bundleId
+     * @param {boolean} sandbox
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async updateAPNSProvider(providerId, name, enabled, authKey, authKeyId, teamId, bundleId) {
+    async updateApnsProvider(providerId, name, enabled, authKey, authKeyId, teamId, bundleId, sandbox) {
         const apiPath = '/messaging/providers/apns/{providerId}'.replace('{providerId}', providerId);
         let payload = {};
         if (typeof providerId === 'undefined') {
@@ -756,6 +765,10 @@ class Messaging extends Service {
             payload['bundleId'] = bundleId;
         }
 
+        if (typeof sandbox !== 'undefined') {
+            payload['sandbox'] = sandbox;
+        }
+
         return await this.client.call('patch', apiPath, {
             'content-type': 'application/json',
         }, payload);
@@ -818,7 +831,7 @@ class Messaging extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async updateFCMProvider(providerId, name, enabled, serviceAccountJSON) {
+    async updateFcmProvider(providerId, name, enabled, serviceAccountJSON) {
         const apiPath = '/messaging/providers/fcm/{providerId}'.replace('{providerId}', providerId);
         let payload = {};
         if (typeof providerId === 'undefined') {
@@ -992,14 +1005,14 @@ class Messaging extends Service {
      *
      * @param {string} providerId
      * @param {string} name
-     * @param {string} from
+     * @param {string} templateId
      * @param {string} senderId
      * @param {string} authKey
      * @param {boolean} enabled
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async createMsg91Provider(providerId, name, from, senderId, authKey, enabled) {
+    async createMsg91Provider(providerId, name, templateId, senderId, authKey, enabled) {
         const apiPath = '/messaging/providers/msg91';
         let payload = {};
         if (typeof providerId === 'undefined') {
@@ -1019,8 +1032,8 @@ class Messaging extends Service {
             payload['name'] = name;
         }
 
-        if (typeof from !== 'undefined') {
-            payload['from'] = from;
+        if (typeof templateId !== 'undefined') {
+            payload['templateId'] = templateId;
         }
 
         if (typeof senderId !== 'undefined') {
@@ -1048,13 +1061,13 @@ class Messaging extends Service {
      * @param {string} providerId
      * @param {string} name
      * @param {boolean} enabled
+     * @param {string} templateId
      * @param {string} senderId
      * @param {string} authKey
-     * @param {string} from
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async updateMsg91Provider(providerId, name, enabled, senderId, authKey, from) {
+    async updateMsg91Provider(providerId, name, enabled, templateId, senderId, authKey) {
         const apiPath = '/messaging/providers/msg91/{providerId}'.replace('{providerId}', providerId);
         let payload = {};
         if (typeof providerId === 'undefined') {
@@ -1070,6 +1083,10 @@ class Messaging extends Service {
             payload['enabled'] = enabled;
         }
 
+        if (typeof templateId !== 'undefined') {
+            payload['templateId'] = templateId;
+        }
+
         if (typeof senderId !== 'undefined') {
             payload['senderId'] = senderId;
         }
@@ -1078,10 +1095,6 @@ class Messaging extends Service {
             payload['authKey'] = authKey;
         }
 
-        if (typeof from !== 'undefined') {
-            payload['from'] = from;
-        }
-
         return await this.client.call('patch', apiPath, {
             'content-type': 'application/json',
         }, payload);
@@ -1090,6 +1103,8 @@ class Messaging extends Service {
     /**
      * Create Sendgrid provider
      *
+     * Create a new Sendgrid provider.
+     *
      * @param {string} providerId
      * @param {string} name
      * @param {string} apiKey
@@ -1218,7 +1233,7 @@ class Messaging extends Service {
      * @param {number} port
      * @param {string} username
      * @param {string} password
-     * @param {Encryption} encryption
+     * @param {SmtpEncryption} encryption
      * @param {boolean} autoTLS
      * @param {string} mailer
      * @param {string} fromName
@@ -1317,7 +1332,7 @@ class Messaging extends Service {
      * @param {number} port
      * @param {string} username
      * @param {string} password
-     * @param {Encryption} encryption
+     * @param {SmtpEncryption} encryption
      * @param {boolean} autoTLS
      * @param {string} mailer
      * @param {string} fromName
@@ -1928,7 +1943,7 @@ class Messaging extends Service {
     }
 
     /**
-     * Create a topic
+     * Create topic
      *
      * Create a new topic.
      *
@@ -1968,7 +1983,7 @@ class Messaging extends Service {
     }
 
     /**
-     * Get a topic
+     * Get topic
      *
      * Get a topic by its unique ID.
      * 
@@ -1991,17 +2006,18 @@ class Messaging extends Service {
     }
 
     /**
-     * Update a topic
+     * Update topic
      *
      * Update a topic by its unique ID.
      * 
      *
      * @param {string} topicId
      * @param {string} name
+     * @param {string[]} subscribe
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async updateTopic(topicId, name) {
+    async updateTopic(topicId, name, subscribe) {
         const apiPath = '/messaging/topics/{topicId}'.replace('{topicId}', topicId);
         let payload = {};
         if (typeof topicId === 'undefined') {
@@ -2013,13 +2029,17 @@ class Messaging extends Service {
             payload['name'] = name;
         }
 
+        if (typeof subscribe !== 'undefined') {
+            payload['subscribe'] = subscribe;
+        }
+
         return await this.client.call('patch', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
 
     /**
-     * Delete a topic
+     * Delete topic
      *
      * Delete a topic by its unique ID.
      *
@@ -2100,7 +2120,7 @@ class Messaging extends Service {
     }
 
     /**
-     * Create a subscriber
+     * Create subscriber
      *
      * Create a new subscriber.
      *
@@ -2140,7 +2160,7 @@ class Messaging extends Service {
     }
 
     /**
-     * Get a subscriber
+     * Get subscriber
      *
      * Get a subscriber by its unique ID.
      * 
@@ -2168,7 +2188,7 @@ class Messaging extends Service {
     }
 
     /**
-     * Delete a subscriber
+     * Delete subscriber
      *
      * Delete a subscriber by its unique ID.
      *