@appwrite.io/console 0.6.0-rc.13 → 0.6.0-rc.14

package/dist/iife/sdk.js

@@ -115,7 +115,7 @@
                 'x-sdk-name': 'Console',
                 'x-sdk-platform': 'console',
                 'x-sdk-language': 'web',
-                'x-sdk-version': '0.6.0-rc.13',
+                'x-sdk-version': '0.6.0-rc.14',
                 'X-Appwrite-Response-Format': '1.5.0',
             };
             this.realtime = {
@@ -668,6 +668,7 @@
         /**
          * Update MFA
          *
+         * Enable or disable MFA on an account.
          *
          * @param {boolean} mfa
          * @throws {AppwriteException}
@@ -716,6 +717,7 @@
         /**
          * Create MFA Challenge (confirmation)
          *
+         * Complete the MFA challenge by providing the one-time password.
          *
          * @param {string} challengeId
          * @param {string} otp
@@ -747,6 +749,7 @@
         /**
          * List Factors
          *
+         * List the factors available on the account to be used as a MFA challange.
          *
          * @throws {AppwriteException}
          * @returns {Promise}
@@ -764,6 +767,10 @@
         /**
          * Add Authenticator
          *
+         * Add an authenticator app to be used as an MFA factor. Verify the
+         * authenticator using the [verify
+         * authenticator](/docs/references/cloud/client-web/account#verifyAuthenticator)
+         * method.
          *
          * @param {AuthenticatorType} type
          * @throws {AppwriteException}
@@ -785,6 +792,9 @@
         /**
          * Verify Authenticator
          *
+         * Verify an authenticator app after adding it using the [add
+         * authenticator](/docs/references/cloud/client-web/account#addAuthenticator)
+         * method.
          *
          * @param {AuthenticatorType} type
          * @param {string} otp
@@ -813,6 +823,7 @@
         /**
          * Delete Authenticator
          *
+         * Delete an authenticator for a user by ID.
          *
          * @param {AuthenticatorType} type
          * @param {string} otp
@@ -1162,7 +1173,7 @@
             });
         }
         /**
-         * Create session (deprecated)
+         * Update magic URL session
          *
          * Use this endpoint to create a session from token. Provide the **userId**
          * and **secret** parameters from the successful response of authentication
@@ -1249,6 +1260,40 @@
                 return uri;
             }
         }
+        /**
+         * Update phone session
+         *
+         * Use this endpoint to create a session from token. Provide the **userId**
+         * and **secret** parameters from the successful response of authentication
+         * flows initiated by token creation. For example, magic URL and phone login.
+         *
+         * @param {string} userId
+         * @param {string} secret
+         * @throws {AppwriteException}
+         * @returns {Promise}
+        */
+        updatePhoneSession(userId, secret) {
+            return __awaiter(this, void 0, void 0, function* () {
+                if (typeof userId === 'undefined') {
+                    throw new AppwriteException('Missing required parameter: "userId"');
+                }
+                if (typeof secret === 'undefined') {
+                    throw new AppwriteException('Missing required parameter: "secret"');
+                }
+                const apiPath = '/account/sessions/phone';
+                const payload = {};
+                if (typeof userId !== 'undefined') {
+                    payload['userId'] = userId;
+                }
+                if (typeof secret !== 'undefined') {
+                    payload['secret'] = secret;
+                }
+                const uri = new URL(this.client.config.endpoint + apiPath);
+                return yield this.client.call('put', uri, {
+                    'content-type': 'application/json',
+                }, payload);
+            });
+        }
         /**
          * Create session
          *
@@ -1307,7 +1352,7 @@
             });
         }
         /**
-         * Update (or renew) a session
+         * Update (or renew) session
          *
          * Extend session's expiry to increase it's lifespan. Extending a session is
          * useful when session length is short such as 5 minutes.
@@ -1376,7 +1421,7 @@
             });
         }
         /**
-         * Create a push target
+         * Create push target
          *
          *
          * @param {string} targetId
@@ -1411,7 +1456,7 @@
             });
         }
         /**
-         * Update a push target
+         * Update push target
          *
          *
          * @param {string} targetId
@@ -1439,7 +1484,7 @@
             });
         }
         /**
-         * Delete a push target
+         * Delete push target
          *
          *
          * @param {string} targetId
@@ -2202,7 +2247,7 @@
             });
         }
         /**
-         * Get usage stats for the database
+         * Get databases usage stats
          *
          *
          * @param {DatabaseUsageRange} range
@@ -2485,6 +2530,7 @@
         /**
          * List attributes
          *
+         * List attributes in the collection.
          *
          * @param {string} databaseId
          * @param {string} collectionId
@@ -2563,6 +2609,8 @@
         /**
          * Update boolean attribute
          *
+         * Update a boolean attribute. Changing the `default` value will not update
+         * already existing documents.
          *
          * @param {string} databaseId
          * @param {string} collectionId
@@ -2606,6 +2654,7 @@
         /**
          * Create datetime attribute
          *
+         * Create a date time attribute according to the ISO 8601 standard.
          *
          * @param {string} databaseId
          * @param {string} collectionId
@@ -2653,6 +2702,8 @@
         /**
          * Update dateTime attribute
          *
+         * Update a date time attribute. Changing the `default` value will not update
+         * already existing documents.
          *
          * @param {string} databaseId
          * @param {string} collectionId
@@ -2791,6 +2842,9 @@
         /**
          * 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
@@ -3488,6 +3542,7 @@
         /**
          * Get attribute
          *
+         * Get attribute by ID.
          *
          * @param {string} databaseId
          * @param {string} collectionId
@@ -3517,6 +3572,7 @@
         /**
          * Delete attribute
          *
+         * Deletes an attribute.
          *
          * @param {string} databaseId
          * @param {string} collectionId
@@ -3798,6 +3854,7 @@
         /**
          * List indexes
          *
+         * List indexes in the collection.
          *
          * @param {string} databaseId
          * @param {string} collectionId
@@ -3827,6 +3884,9 @@
         /**
          * 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
@@ -3877,6 +3937,7 @@
         /**
          * Get index
          *
+         * Get index by ID.
          *
          * @param {string} databaseId
          * @param {string} collectionId
@@ -3906,6 +3967,7 @@
         /**
          * Delete index
          *
+         * Delete an index.
          *
          * @param {string} databaseId
          * @param {string} collectionId
@@ -3963,7 +4025,7 @@
             });
         }
         /**
-         * Get usage stats for a collection
+         * Get collection usage stats
          *
          *
          * @param {string} databaseId
@@ -4018,7 +4080,7 @@
             });
         }
         /**
-         * Get usage stats for the database
+         * Get database usage stats
          *
          *
          * @param {string} databaseId
@@ -5205,6 +5267,8 @@
         /**
          * 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}
@@ -5576,7 +5640,7 @@
             });
         }
         /**
-         * Create an email
+         * Create email
          *
          * Create a new email message.
          *
@@ -5589,13 +5653,13 @@
          * @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}
         */
-        createEmail(messageId, subject, content, topics, users, targets, cc, bcc, attachments, status, html, scheduledAt) {
+        createEmail(messageId, subject, content, topics, users, targets, cc, bcc, attachments, draft, html, scheduledAt) {
             return __awaiter(this, void 0, void 0, function* () {
                 if (typeof messageId === 'undefined') {
                     throw new AppwriteException('Missing required parameter: "messageId"');
@@ -5635,8 +5699,8 @@
                 if (typeof attachments !== 'undefined') {
                     payload['attachments'] = attachments;
                 }
-                if (typeof status !== 'undefined') {
-                    payload['status'] = status;
+                if (typeof draft !== 'undefined') {
+                    payload['draft'] = draft;
                 }
                 if (typeof html !== 'undefined') {
                     payload['html'] = html;
@@ -5651,7 +5715,7 @@
             });
         }
         /**
-         * Update an email
+         * Update email
          *
          * Update an email message by its unique ID.
          *
@@ -5662,7 +5726,7 @@
          * @param {string[]} targets
          * @param {string} subject
          * @param {string} content
-         * @param {MessageStatus} status
+         * @param {boolean} draft
          * @param {boolean} html
          * @param {string[]} cc
          * @param {string[]} bcc
@@ -5670,7 +5734,7 @@
          * @throws {AppwriteException}
          * @returns {Promise}
         */
-        updateEmail(messageId, topics, users, targets, subject, content, status, html, cc, bcc, scheduledAt) {
+        updateEmail(messageId, topics, users, targets, subject, content, draft, html, cc, bcc, scheduledAt) {
             return __awaiter(this, void 0, void 0, function* () {
                 if (typeof messageId === 'undefined') {
                     throw new AppwriteException('Missing required parameter: "messageId"');
@@ -5692,8 +5756,8 @@
                 if (typeof content !== 'undefined') {
                     payload['content'] = content;
                 }
-                if (typeof status !== 'undefined') {
-                    payload['status'] = status;
+                if (typeof draft !== 'undefined') {
+                    payload['draft'] = draft;
                 }
                 if (typeof html !== 'undefined') {
                     payload['html'] = html;
@@ -5714,7 +5778,7 @@
             });
         }
         /**
-         * Create a push notification
+         * Create push notification
          *
          * Create a new push notification.
          *
@@ -5732,12 +5796,12 @@
          * @param {string} color
          * @param {string} tag
          * @param {string} badge
-         * @param {MessageStatus} status
+         * @param {boolean} draft
          * @param {string} scheduledAt
          * @throws {AppwriteException}
          * @returns {Promise}
         */
-        createPush(messageId, title, body, topics, users, targets, data, action, image, icon, sound, color, tag, badge, status, scheduledAt) {
+        createPush(messageId, title, body, topics, users, targets, data, action, image, icon, sound, color, tag, badge, draft, scheduledAt) {
             return __awaiter(this, void 0, void 0, function* () {
                 if (typeof messageId === 'undefined') {
                     throw new AppwriteException('Missing required parameter: "messageId"');
@@ -5792,8 +5856,8 @@
                 if (typeof badge !== 'undefined') {
                     payload['badge'] = badge;
                 }
-                if (typeof status !== 'undefined') {
-                    payload['status'] = status;
+                if (typeof draft !== 'undefined') {
+                    payload['draft'] = draft;
                 }
                 if (typeof scheduledAt !== 'undefined') {
                     payload['scheduledAt'] = scheduledAt;
@@ -5805,7 +5869,7 @@
             });
         }
         /**
-         * Update a push notification
+         * Update push notification
          *
          * Update a push notification by its unique ID.
          *
@@ -5824,12 +5888,12 @@
          * @param {string} color
          * @param {string} tag
          * @param {number} badge
-         * @param {MessageStatus} status
+         * @param {boolean} draft
          * @param {string} scheduledAt
          * @throws {AppwriteException}
          * @returns {Promise}
         */
-        updatePush(messageId, topics, users, targets, title, body, data, action, image, icon, sound, color, tag, badge, status, scheduledAt) {
+        updatePush(messageId, topics, users, targets, title, body, data, action, image, icon, sound, color, tag, badge, draft, scheduledAt) {
             return __awaiter(this, void 0, void 0, function* () {
                 if (typeof messageId === 'undefined') {
                     throw new AppwriteException('Missing required parameter: "messageId"');
@@ -5875,8 +5939,8 @@
                 if (typeof badge !== 'undefined') {
                     payload['badge'] = badge;
                 }
-                if (typeof status !== 'undefined') {
-                    payload['status'] = status;
+                if (typeof draft !== 'undefined') {
+                    payload['draft'] = draft;
                 }
                 if (typeof scheduledAt !== 'undefined') {
                     payload['scheduledAt'] = scheduledAt;
@@ -5888,7 +5952,7 @@
             });
         }
         /**
-         * Create an SMS
+         * Create SMS
          *
          * Create a new SMS message.
          *
@@ -5897,12 +5961,12 @@
          * @param {string[]} topics
          * @param {string[]} users
          * @param {string[]} targets
-         * @param {MessageStatus} status
+         * @param {boolean} draft
          * @param {string} scheduledAt
          * @throws {AppwriteException}
          * @returns {Promise}
         */
-        createSms(messageId, content, topics, users, targets, status, scheduledAt) {
+        createSms(messageId, content, topics, users, targets, draft, scheduledAt) {
             return __awaiter(this, void 0, void 0, function* () {
                 if (typeof messageId === 'undefined') {
                     throw new AppwriteException('Missing required parameter: "messageId"');
@@ -5927,8 +5991,8 @@
                 if (typeof targets !== 'undefined') {
                     payload['targets'] = targets;
                 }
-                if (typeof status !== 'undefined') {
-                    payload['status'] = status;
+                if (typeof draft !== 'undefined') {
+                    payload['draft'] = draft;
                 }
                 if (typeof scheduledAt !== 'undefined') {
                     payload['scheduledAt'] = scheduledAt;
@@ -5940,7 +6004,7 @@
             });
         }
         /**
-         * Update an SMS
+         * Update SMS
          *
          * Update an email message by its unique ID.
          *
@@ -5950,12 +6014,12 @@
          * @param {string[]} users
          * @param {string[]} targets
          * @param {string} content
-         * @param {MessageStatus} status
+         * @param {boolean} draft
          * @param {string} scheduledAt
          * @throws {AppwriteException}
          * @returns {Promise}
         */
-        updateSms(messageId, topics, users, targets, content, status, scheduledAt) {
+        updateSms(messageId, topics, users, targets, content, draft, scheduledAt) {
             return __awaiter(this, void 0, void 0, function* () {
                 if (typeof messageId === 'undefined') {
                     throw new AppwriteException('Missing required parameter: "messageId"');
@@ -5974,8 +6038,8 @@
                 if (typeof content !== 'undefined') {
                     payload['content'] = content;
                 }
-                if (typeof status !== 'undefined') {
-                    payload['status'] = status;
+                if (typeof draft !== 'undefined') {
+                    payload['draft'] = draft;
                 }
                 if (typeof scheduledAt !== 'undefined') {
                     payload['scheduledAt'] = scheduledAt;
@@ -5987,7 +6051,7 @@
             });
         }
         /**
-         * Get a message
+         * Get message
          *
          * Get a message by its unique ID.
          *
@@ -6010,8 +6074,10 @@
             });
         }
         /**
-         * 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}
@@ -6503,6 +6569,7 @@
         /**
          * Create Sendgrid provider
          *
+         * Create a new Sendgrid provider.
          *
          * @param {string} providerId
          * @param {string} name
@@ -7246,7 +7313,7 @@
             });
         }
         /**
-         * Create a topic
+         * Create topic
          *
          * Create a new topic.
          *
@@ -7282,7 +7349,7 @@
             });
         }
         /**
-         * Get a topic
+         * Get topic
          *
          * Get a topic by its unique ID.
          *
@@ -7305,7 +7372,7 @@
             });
         }
         /**
-         * Update a topic
+         * Update topic
          *
          * Update a topic by its unique ID.
          *
@@ -7336,7 +7403,7 @@
             });
         }
         /**
-         * Delete a topic
+         * Delete topic
          *
          * Delete a topic by its unique ID.
          *
@@ -7414,7 +7481,7 @@
             });
         }
         /**
-         * Create a subscriber
+         * Create subscriber
          *
          * Create a new subscriber.
          *
@@ -7450,7 +7517,7 @@
             });
         }
         /**
-         * Get a subscriber
+         * Get subscriber
          *
          * Get a subscriber by its unique ID.
          *
@@ -7477,7 +7544,7 @@
             });
         }
         /**
-         * Delete a subscriber
+         * Delete subscriber
          *
          * Delete a subscriber by its unique ID.
          *
@@ -8117,7 +8184,7 @@
             super(client);
         }
         /**
-         * Get usage stats for a project
+         * Get project usage stats
          *
          *
          * @param {string} startDate
@@ -10385,7 +10452,7 @@
             return uri;
         }
         /**
-         * Get usage stats for storage
+         * Get storage usage stats
          *
          *
          * @param {StorageUsageRange} range
@@ -10406,7 +10473,7 @@
             });
         }
         /**
-         * Get usage stats for storage bucket
+         * Get bucket usage stats
          *
          *
          * @param {string} bucketId
@@ -11399,7 +11466,7 @@
             });
         }
         /**
-         * Get usage stats for the users API
+         * Get users usage stats
          *
          *
          * @param {UserUsageRange} range
@@ -11582,6 +11649,7 @@
         /**
          * Update MFA
          *
+         * Enable or disable MFA on a user account.
          *
          * @param {string} userId
          * @param {boolean} mfa
@@ -11610,6 +11678,7 @@
         /**
          * List Factors
          *
+         * List the factors available on the account to be used as a MFA challange.
          *
          * @param {string} userId
          * @throws {AppwriteException}
@@ -11631,14 +11700,14 @@
         /**
          * Delete Authenticator
          *
+         * Delete an authenticator app.
          *
          * @param {string} userId
          * @param {AuthenticatorType} type
-         * @param {string} otp
          * @throws {AppwriteException}
          * @returns {Promise}
         */
-        deleteAuthenticator(userId, type, otp) {
+        deleteAuthenticator(userId, type) {
             return __awaiter(this, void 0, void 0, function* () {
                 if (typeof userId === 'undefined') {
                     throw new AppwriteException('Missing required parameter: "userId"');
@@ -11646,14 +11715,8 @@
                 if (typeof type === 'undefined') {
                     throw new AppwriteException('Missing required parameter: "type"');
                 }
-                if (typeof otp === 'undefined') {
-                    throw new AppwriteException('Missing required parameter: "otp"');
-                }
                 const apiPath = '/users/{userId}/mfa/{type}'.replace('{userId}', userId).replace('{type}', type);
                 const payload = {};
-                if (typeof otp !== 'undefined') {
-                    payload['otp'] = otp;
-                }
                 const uri = new URL(this.client.config.endpoint + apiPath);
                 return yield this.client.call('delete', uri, {
                     'content-type': 'application/json',
@@ -11930,6 +11993,7 @@
         /**
          * List User Targets
          *
+         * List the messaging targets that are associated with a user.
          *
          * @param {string} userId
          * @param {string[]} queries
@@ -11955,6 +12019,7 @@
         /**
          * Create User Target
          *
+         * Create a messaging target.
          *
          * @param {string} userId
          * @param {string} targetId
@@ -12005,6 +12070,7 @@
         /**
          * Get User Target
          *
+         * Get a user's push notification target by ID.
          *
          * @param {string} userId
          * @param {string} targetId
@@ -12030,6 +12096,7 @@
         /**
          * Update User target
          *
+         * Update a messaging target.
          *
          * @param {string} userId
          * @param {string} targetId
@@ -12067,6 +12134,7 @@
         /**
          * Delete user target
          *
+         * Delete a messaging target.
          *
          * @param {string} userId
          * @param {string} targetId
@@ -12866,7 +12934,6 @@
         IndexType["Key"] = "key";
         IndexType["Fulltext"] = "fulltext";
         IndexType["Unique"] = "unique";
-        IndexType["Spatial"] = "spatial";
     })(exports.IndexType || (exports.IndexType = {}));
 
     exports.Runtime = void 0;
@@ -12942,13 +13009,6 @@
         Name["Hamsterv1"] = "hamsterv1";
     })(exports.Name || (exports.Name = {}));
 
-    exports.MessageStatus = void 0;
-    (function (MessageStatus) {
-        MessageStatus["Draft"] = "draft";
-        MessageStatus["Scheduled"] = "scheduled";
-        MessageStatus["Processing"] = "processing";
-    })(exports.MessageStatus || (exports.MessageStatus = {}));
-
     exports.SmtpEncryption = void 0;
     (function (SmtpEncryption) {
         SmtpEncryption["None"] = "none";