npm - @appwrite.io/console - Versions diffs - 0.6.0-rc.6 → 0.6.0-rc.8 - Mend

@appwrite.io/console 0.6.0-rc.6 → 0.6.0-rc.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (43) hide show

package/README.md +1 -1
package/dist/cjs/sdk.js +241 -55
package/dist/cjs/sdk.js.map +1 -1
package/dist/esm/sdk.js +241 -55
package/dist/esm/sdk.js.map +1 -1
package/dist/iife/sdk.js +241 -55
package/docs/examples/account/create-email-token.md +18 -0
package/docs/examples/account/create-push-target.md +18 -0
package/docs/examples/account/delete.md +18 -0
package/docs/examples/account/update-push-target.md +1 -0
package/docs/examples/messaging/{create-apns-provider.md → create-a-p-n-s-provider.md} +1 -1
package/docs/examples/messaging/create-email.md +18 -0
package/docs/examples/messaging/{create-fcm-provider.md → create-f-c-m-provider.md} +1 -1
package/docs/examples/messaging/create-push.md +18 -0
package/docs/examples/messaging/{create-s-m-s-message.md → create-s-m-s.md} +1 -1
package/docs/examples/messaging/{update-fcm-provider.md → list-targets.md} +1 -1
package/docs/examples/messaging/{update-apns-provider.md → update-a-p-n-s-provider.md} +1 -1
package/docs/examples/messaging/update-f-c-m-provider.md +18 -0
package/docs/examples/project/get-usage.md +1 -1
package/docs/examples/projects/{update-smtp-configuration.md → create-smtp-test.md} +1 -1
package/docs/examples/projects/create-webhook.md +1 -1
package/docs/examples/projects/{get-usage.md → update-smtp.md} +1 -1
package/docs/examples/projects/update-webhook.md +1 -1
package/package.json +1 -1
package/src/client.ts +1 -1
package/src/models.ts +212 -182
package/src/services/account.ts +115 -8
package/src/services/functions.ts +1 -1
package/src/services/messaging.ts +36 -7
package/src/services/project.ts +22 -4
package/src/services/projects.ts +97 -31
package/src/services/storage.ts +1 -1
package/src/services/users.ts +1 -6
package/types/models.d.ts +212 -182
package/types/services/account.d.ts +48 -8
package/types/services/functions.d.ts +1 -1
package/types/services/messaging.d.ts +19 -7
package/types/services/project.d.ts +4 -2
package/types/services/projects.d.ts +24 -14
package/types/services/storage.d.ts +1 -1
package/types/services/users.d.ts +1 -2
package/docs/examples/messaging/create-email-message.md +0 -18
package/docs/examples/messaging/create-push-message.md +0 -18

package/README.md CHANGED Viewed

@@ -33,7 +33,7 @@ import { Client, Account } from "@appwrite.io/console";
 To install with a CDN (content delivery network) add the following scripts to the bottom of your <body> tag, but before you use any Appwrite services:
 ```html
-<script src="https://cdn.jsdelivr.net/npm/@appwrite.io/console@0.6.0-rc.6"></script>
+<script src="https://cdn.jsdelivr.net/npm/@appwrite.io/console@0.6.0-rc.8"></script>
 ```

package/dist/cjs/sdk.js CHANGED Viewed

@@ -104,7 +104,7 @@ class Client {
             'x-sdk-name': 'Console',
             'x-sdk-platform': 'console',
             'x-sdk-language': 'web',
-            'x-sdk-version': '0.6.0-rc.6',
+            'x-sdk-version': '0.6.0-rc.8',
             'X-Appwrite-Response-Format': '1.4.0',
         };
         this.realtime = {
@@ -508,6 +508,24 @@ class Account extends Service {
             }, payload);
         });
     }
+    /**
+     * Delete account
+     *
+     * Delete the currently logged in user.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    delete() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const apiPath = '/account';
+            const payload = {};
+            const uri = new URL(this.client.config.endpoint + apiPath);
+            return yield this.client.call('delete', uri, {
+                'content-type': 'application/json',
+            }, payload);
+        });
+    }
     /**
      * Update email
      *
@@ -1283,11 +1301,10 @@ class Account extends Service {
         });
     }
     /**
-     * Update OAuth session (refresh tokens)
+     * Update (or renew) a session
      *
-     * Access tokens have limited lifespan and expire to mitigate security risks.
-     * If session was created using an OAuth provider, this route can be used to
-     * "refresh" the access token.
+     * Extend session's expiry to increase it's lifespan. Extending a session is
+     * useful when session length is short such as 5 minutes.
      *
      * @param {string} sessionId
      * @throws {AppwriteException}
@@ -1352,6 +1369,41 @@ class Account extends Service {
             }, payload);
         });
     }
+    /**
+     * Create Account&#039;s push target
+     *
+     *
+     * @param {string} targetId
+     * @param {string} identifier
+     * @param {string} providerId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createPushTarget(targetId, identifier, providerId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (typeof targetId === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "targetId"');
+            }
+            if (typeof identifier === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "identifier"');
+            }
+            const apiPath = '/account/targets/push';
+            const payload = {};
+            if (typeof targetId !== 'undefined') {
+                payload['targetId'] = targetId;
+            }
+            if (typeof identifier !== 'undefined') {
+                payload['identifier'] = identifier;
+            }
+            if (typeof providerId !== 'undefined') {
+                payload['providerId'] = providerId;
+            }
+            const uri = new URL(this.client.config.endpoint + apiPath);
+            return yield this.client.call('post', uri, {
+                'content-type': 'application/json',
+            }, payload);
+        });
+    }
     /**
      * Update Account&#039;s push target
      *
@@ -1380,6 +1432,51 @@ class Account extends Service {
             }, payload);
         });
     }
+    /**
+     * Create email token (OTP)
+     *
+     * Sends the user an email with a secret key for creating a session. If the
+     * provided user ID has not be registered, a new user will be created. Use the
+     * returned user ID and secret and submit a request to the [POST
+     * /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession)
+     * endpoint to complete the login process. The secret sent to the user's email
+     * is valid for 15 minutes.
+     *
+     * A user is limited to 10 active sessions at a time by default. [Learn more
+     * about session
+     * limits](https://appwrite.io/docs/authentication-security#limits).
+     *
+     * @param {string} userId
+     * @param {string} email
+     * @param {boolean} securityPhrase
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createEmailToken(userId, email, securityPhrase) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (typeof userId === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "userId"');
+            }
+            if (typeof email === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "email"');
+            }
+            const apiPath = '/account/tokens/email';
+            const payload = {};
+            if (typeof userId !== 'undefined') {
+                payload['userId'] = userId;
+            }
+            if (typeof email !== 'undefined') {
+                payload['email'] = email;
+            }
+            if (typeof securityPhrase !== 'undefined') {
+                payload['securityPhrase'] = securityPhrase;
+            }
+            const uri = new URL(this.client.config.endpoint + apiPath);
+            return yield this.client.call('post', uri, {
+                'content-type': 'application/json',
+            }, payload);
+        });
+    }
     /**
      * Create magic URL token
      *
@@ -1388,8 +1485,8 @@ class Account extends Service {
      * the user clicks the link in the email, the user is redirected back to the
      * URL you provided with the secret key and userId values attached to the URL
      * query string. Use the query string parameters to submit a request to the
-     * [PUT
-     * /account/sessions/magic-url](https://appwrite.io/docs/references/cloud/client-web/account#updateMagicURLSession)
+     * [POST
+     * /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession)
      * endpoint to complete the login process. The link sent to the user's email
      * address is valid for 1 hour. If you are on a mobile device you can leave
      * the URL parameter empty, so that the login completion will be handled by
@@ -1440,8 +1537,8 @@ class Account extends Service {
      *
      * Sends the user an SMS with a secret key for creating a session. If the
      * provided user ID has not be registered, a new user will be created. Use the
-     * returned user ID and secret and submit a request to the [PUT
-     * /account/sessions/phone](https://appwrite.io/docs/references/cloud/client-web/account#updatePhoneSession)
+     * returned user ID and secret and submit a request to the [POST
+     * /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession)
      * endpoint to complete the login process. The secret sent to the user's phone
      * is valid for 15 minutes.
      *
@@ -5368,7 +5465,7 @@ class Messaging extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createEmailMessage(messageId, subject, content, topics, users, targets, cc, bcc, description, status, html, scheduledAt) {
+    createEmail(messageId, subject, content, topics, users, targets, cc, bcc, description, status, html, scheduledAt) {
         return __awaiter(this, void 0, void 0, function* () {
             if (typeof messageId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "messageId"');
@@ -5511,7 +5608,7 @@ class Messaging extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createPushMessage(messageId, title, body, topics, users, targets, description, data, action, icon, sound, color, tag, badge, status, scheduledAt) {
+    createPush(messageId, title, body, topics, users, targets, description, data, action, icon, sound, color, tag, badge, status, scheduledAt) {
         return __awaiter(this, void 0, void 0, function* () {
             if (typeof messageId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "messageId"');
@@ -5674,7 +5771,7 @@ class Messaging extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createSMSMessage(messageId, content, topics, users, targets, description, status, scheduledAt) {
+    createSMS(messageId, content, topics, users, targets, description, status, scheduledAt) {
         return __awaiter(this, void 0, void 0, function* () {
             if (typeof messageId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "messageId"');
@@ -5809,6 +5906,33 @@ class Messaging extends Service {
             }, payload);
         });
     }
+    /**
+     * List message targets
+     *
+     * List the targets associated with a message as set via the targets
+     * attribute.
+     *
+     * @param {string} messageId
+     * @param {string} queries
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    listTargets(messageId, queries) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (typeof messageId === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "messageId"');
+            }
+            const apiPath = '/messaging/messages/{messageId}/targets'.replace('{messageId}', messageId);
+            const payload = {};
+            if (typeof queries !== 'undefined') {
+                payload['queries'] = queries;
+            }
+            const uri = new URL(this.client.config.endpoint + apiPath);
+            return yield this.client.call('get', uri, {
+                'content-type': 'application/json',
+            }, payload);
+        });
+    }
     /**
      * List providers
      *
@@ -5848,7 +5972,7 @@ class Messaging extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createApnsProvider(providerId, name, authKey, authKeyId, teamId, bundleId, enabled) {
+    createAPNSProvider(providerId, name, authKey, authKeyId, teamId, bundleId, enabled) {
         return __awaiter(this, void 0, void 0, function* () {
             if (typeof providerId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "providerId"');
@@ -5899,7 +6023,7 @@ class Messaging extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateApnsProvider(providerId, name, enabled, authKey, authKeyId, teamId, bundleId) {
+    updateAPNSProvider(providerId, name, enabled, authKey, authKeyId, teamId, bundleId) {
         return __awaiter(this, void 0, void 0, function* () {
             if (typeof providerId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "providerId"');
@@ -5941,7 +6065,7 @@ class Messaging extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createFcmProvider(providerId, name, serviceAccountJSON, enabled) {
+    createFCMProvider(providerId, name, serviceAccountJSON, enabled) {
         return __awaiter(this, void 0, void 0, function* () {
             if (typeof providerId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "providerId"');
@@ -5980,7 +6104,7 @@ class Messaging extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateFcmProvider(providerId, name, enabled, serviceAccountJSON) {
+    updateFCMProvider(providerId, name, enabled, serviceAccountJSON) {
         return __awaiter(this, void 0, void 0, function* () {
             if (typeof providerId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "providerId"');
@@ -7646,16 +7770,30 @@ class Project extends Service {
      * Get usage stats for a project
      *
      *
-     * @param {string} range
+     * @param {string} startDate
+     * @param {string} endDate
+     * @param {string} period
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    getUsage(range) {
+    getUsage(startDate, endDate, period) {
         return __awaiter(this, void 0, void 0, function* () {
+            if (typeof startDate === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "startDate"');
+            }
+            if (typeof endDate === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "endDate"');
+            }
             const apiPath = '/project/usage';
             const payload = {};
-            if (typeof range !== 'undefined') {
-                payload['range'] = range;
+            if (typeof startDate !== 'undefined') {
+                payload['startDate'] = startDate;
+            }
+            if (typeof endDate !== 'undefined') {
+                payload['endDate'] = endDate;
+            }
+            if (typeof period !== 'undefined') {
+                payload['period'] = period;
             }
             const uri = new URL(this.client.config.endpoint + apiPath);
             return yield this.client.call('get', uri, {
@@ -8655,7 +8793,7 @@ class Projects extends Service {
         });
     }
     /**
-     * Update SMTP configuration
+     * Update SMTP
      *
      *
      * @param {string} projectId
@@ -8671,7 +8809,7 @@ class Projects extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateSmtpConfiguration(projectId, enabled, senderName, senderEmail, replyTo, host, port, username, password, secure) {
+    updateSmtp(projectId, enabled, senderName, senderEmail, replyTo, host, port, username, password, secure) {
         return __awaiter(this, void 0, void 0, function* () {
             if (typeof projectId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "projectId"');
@@ -8714,6 +8852,75 @@ class Projects extends Service {
             }, payload);
         });
     }
+    /**
+     * Create SMTP test
+     *
+     *
+     * @param {string} projectId
+     * @param {string[]} emails
+     * @param {string} senderName
+     * @param {string} senderEmail
+     * @param {string} host
+     * @param {string} replyTo
+     * @param {number} port
+     * @param {string} username
+     * @param {string} password
+     * @param {string} secure
+     * @throws {AppwriteException}
+     * @returns {Promise}
+    */
+    createSmtpTest(projectId, emails, senderName, senderEmail, host, replyTo, port, username, password, secure) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (typeof projectId === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "projectId"');
+            }
+            if (typeof emails === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "emails"');
+            }
+            if (typeof senderName === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "senderName"');
+            }
+            if (typeof senderEmail === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "senderEmail"');
+            }
+            if (typeof host === 'undefined') {
+                throw new AppwriteException('Missing required parameter: "host"');
+            }
+            const apiPath = '/projects/{projectId}/smtp/tests'.replace('{projectId}', projectId);
+            const payload = {};
+            if (typeof emails !== 'undefined') {
+                payload['emails'] = emails;
+            }
+            if (typeof senderName !== 'undefined') {
+                payload['senderName'] = senderName;
+            }
+            if (typeof senderEmail !== 'undefined') {
+                payload['senderEmail'] = senderEmail;
+            }
+            if (typeof replyTo !== 'undefined') {
+                payload['replyTo'] = replyTo;
+            }
+            if (typeof host !== 'undefined') {
+                payload['host'] = host;
+            }
+            if (typeof port !== 'undefined') {
+                payload['port'] = port;
+            }
+            if (typeof username !== 'undefined') {
+                payload['username'] = username;
+            }
+            if (typeof password !== 'undefined') {
+                payload['password'] = password;
+            }
+            if (typeof secure !== 'undefined') {
+                payload['secure'] = secure;
+            }
+            const uri = new URL(this.client.config.endpoint + apiPath);
+            return yield this.client.call('post', uri, {
+                'content-type': 'application/json',
+            }, payload);
+        });
+    }
     /**
      * Update Project Team
      *
@@ -8949,31 +9156,6 @@ class Projects extends Service {
             }, payload);
         });
     }
-    /**
-     * Get usage stats for a project
-     *
-     *
-     * @param {string} projectId
-     * @param {string} range
-     * @throws {AppwriteException}
-     * @returns {Promise}
-    */
-    getUsage(projectId, range) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (typeof projectId === 'undefined') {
-                throw new AppwriteException('Missing required parameter: "projectId"');
-            }
-            const apiPath = '/projects/{projectId}/usage'.replace('{projectId}', projectId);
-            const payload = {};
-            if (typeof range !== 'undefined') {
-                payload['range'] = range;
-            }
-            const uri = new URL(this.client.config.endpoint + apiPath);
-            return yield this.client.call('get', uri, {
-                'content-type': 'application/json',
-            }, payload);
-        });
-    }
     /**
      * List webhooks
      *
@@ -9004,12 +9186,13 @@ class Projects extends Service {
      * @param {string[]} events
      * @param {string} url
      * @param {boolean} security
+     * @param {boolean} enabled
      * @param {string} httpUser
      * @param {string} httpPass
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    createWebhook(projectId, name, events, url, security, httpUser, httpPass) {
+    createWebhook(projectId, name, events, url, security, enabled, httpUser, httpPass) {
         return __awaiter(this, void 0, void 0, function* () {
             if (typeof projectId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "projectId"');
@@ -9031,6 +9214,9 @@ class Projects extends Service {
             if (typeof name !== 'undefined') {
                 payload['name'] = name;
             }
+            if (typeof enabled !== 'undefined') {
+                payload['enabled'] = enabled;
+            }
             if (typeof events !== 'undefined') {
                 payload['events'] = events;
             }
@@ -9087,12 +9273,13 @@ class Projects extends Service {
      * @param {string[]} events
      * @param {string} url
      * @param {boolean} security
+     * @param {boolean} enabled
      * @param {string} httpUser
      * @param {string} httpPass
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    updateWebhook(projectId, webhookId, name, events, url, security, httpUser, httpPass) {
+    updateWebhook(projectId, webhookId, name, events, url, security, enabled, httpUser, httpPass) {
         return __awaiter(this, void 0, void 0, function* () {
             if (typeof projectId === 'undefined') {
                 throw new AppwriteException('Missing required parameter: "projectId"');
@@ -9117,6 +9304,9 @@ class Projects extends Service {
             if (typeof name !== 'undefined') {
                 payload['name'] = name;
             }
+            if (typeof enabled !== 'undefined') {
+                payload['enabled'] = enabled;
+            }
             if (typeof events !== 'undefined') {
                 payload['events'] = events;
             }
@@ -9894,7 +10084,7 @@ class Storage extends Service {
         });
     }
     /**
-     * Get usage stats for a storage bucket
+     * Get usage stats for storage bucket
      *
      *
      * @param {string} bucketId
@@ -10891,20 +11081,16 @@ class Users extends Service {
      *
      *
      * @param {string} range
-     * @param {string} provider
      * @throws {AppwriteException}
      * @returns {Promise}
     */
-    getUsage(range, provider) {
+    getUsage(range) {
         return __awaiter(this, void 0, void 0, function* () {
             const apiPath = '/users/usage';
             const payload = {};
             if (typeof range !== 'undefined') {
                 payload['range'] = range;
             }
-            if (typeof provider !== 'undefined') {
-                payload['provider'] = provider;
-            }
             const uri = new URL(this.client.config.endpoint + apiPath);
             return yield this.client.call('get', uri, {
                 'content-type': 'application/json',