node-appwrite 8.2.0 → 10.0.0

package/lib/services/teams.js

@@ -26,7 +26,7 @@ class Teams extends Service {
      * @returns {Promise}
      */
     async list(queries, search) {
-        let path = '/teams';
+        const apiPath = '/teams';
         let payload = {};
 
         if (typeof queries !== 'undefined') {
@@ -37,7 +37,7 @@ class Teams extends Service {
             payload['search'] = search;
         }
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -56,7 +56,7 @@ class Teams extends Service {
      * @returns {Promise}
      */
     async create(teamId, name, roles) {
-        let path = '/teams';
+        const apiPath = '/teams';
         let payload = {};
         if (typeof teamId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "teamId"');
@@ -79,7 +79,7 @@ class Teams extends Service {
             payload['roles'] = roles;
         }
 
-        return await this.client.call('post', path, {
+        return await this.client.call('post', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -94,31 +94,30 @@ class Teams extends Service {
      * @returns {Promise}
      */
     async get(teamId) {
-        let path = '/teams/{teamId}'.replace('{teamId}', teamId);
+        const apiPath = '/teams/{teamId}'.replace('{teamId}', teamId);
         let payload = {};
         if (typeof teamId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "teamId"');
         }
 
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
 
     /**
-     * Update Team
+     * Update Name
      *
-     * Update a team using its ID. Only members with the owner role can update the
-     * team.
+     * Update the team's name by its unique ID.
      *
      * @param {string} teamId
      * @param {string} name
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async update(teamId, name) {
-        let path = '/teams/{teamId}'.replace('{teamId}', teamId);
+    async updateName(teamId, name) {
+        const apiPath = '/teams/{teamId}'.replace('{teamId}', teamId);
         let payload = {};
         if (typeof teamId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "teamId"');
@@ -133,7 +132,7 @@ class Teams extends Service {
             payload['name'] = name;
         }
 
-        return await this.client.call('put', path, {
+        return await this.client.call('put', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -149,14 +148,14 @@ class Teams extends Service {
      * @returns {Promise}
      */
     async delete(teamId) {
-        let path = '/teams/{teamId}'.replace('{teamId}', teamId);
+        const apiPath = '/teams/{teamId}'.replace('{teamId}', teamId);
         let payload = {};
         if (typeof teamId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "teamId"');
         }
 
 
-        return await this.client.call('delete', path, {
+        return await this.client.call('delete', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -174,7 +173,7 @@ class Teams extends Service {
      * @returns {Promise}
      */
     async listMemberships(teamId, queries, search) {
-        let path = '/teams/{teamId}/memberships'.replace('{teamId}', teamId);
+        const apiPath = '/teams/{teamId}/memberships'.replace('{teamId}', teamId);
         let payload = {};
         if (typeof teamId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "teamId"');
@@ -189,7 +188,7 @@ class Teams extends Service {
             payload['search'] = search;
         }
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -197,41 +196,45 @@ class Teams extends Service {
     /**
      * Create Team Membership
      *
-     * Invite a new member to join your team. If initiated from the client SDK, an
-     * email with a link to join the team will be sent to the member's email
-     * address and an account will be created for them should they not be signed
-     * up already. If initiated from server-side SDKs, the new member will
-     * automatically be added to the team.
+     * 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
+     * a Client SDK, Appwrite will send an email or sms with a link to join the
+     * team to the invited user, and an account will be created for them if one
+     * doesn't exist. If initiated from a Server SDK, the new member will be added
+     * automatically to the team.
      * 
-     * Use the 'url' parameter to redirect the user from the invitation email back
-     * to your app. When the user is redirected, use the [Update Team Membership
+     * You only need to provide one of a user ID, email, or phone number. Appwrite
+     * will prioritize accepting the user ID > email > phone number if you provide
+     * more than one of these parameters.
+     * 
+     * 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. 
      * 
      * Please note that to avoid a [Redirect
      * Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md)
-     * the only valid redirect URL's are the once from domains you have set when
-     * adding your platforms in the console interface.
+     * Appwrite will accept the only redirect URLs under the domains you have
+     * added as a platform on the Appwrite Console.
+     * 
      *
      * @param {string} teamId
-     * @param {string} email
      * @param {string[]} roles
      * @param {string} url
+     * @param {string} email
+     * @param {string} userId
+     * @param {string} phone
      * @param {string} name
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async createMembership(teamId, email, roles, url, name) {
-        let path = '/teams/{teamId}/memberships'.replace('{teamId}', teamId);
+    async createMembership(teamId, roles, url, email, userId, phone, name) {
+        const apiPath = '/teams/{teamId}/memberships'.replace('{teamId}', teamId);
         let payload = {};
         if (typeof teamId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "teamId"');
         }
 
-        if (typeof email === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "email"');
-        }
-
         if (typeof roles === 'undefined') {
             throw new AppwriteException('Missing required parameter: "roles"');
         }
@@ -245,6 +248,14 @@ class Teams extends Service {
             payload['email'] = email;
         }
 
+        if (typeof userId !== 'undefined') {
+            payload['userId'] = userId;
+        }
+
+        if (typeof phone !== 'undefined') {
+            payload['phone'] = phone;
+        }
+
         if (typeof roles !== 'undefined') {
             payload['roles'] = roles;
         }
@@ -257,7 +268,7 @@ class Teams extends Service {
             payload['name'] = name;
         }
 
-        return await this.client.call('post', path, {
+        return await this.client.call('post', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -274,7 +285,7 @@ class Teams extends Service {
      * @returns {Promise}
      */
     async getMembership(teamId, membershipId) {
-        let path = '/teams/{teamId}/memberships/{membershipId}'.replace('{teamId}', teamId).replace('{membershipId}', membershipId);
+        const apiPath = '/teams/{teamId}/memberships/{membershipId}'.replace('{teamId}', teamId).replace('{membershipId}', membershipId);
         let payload = {};
         if (typeof teamId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "teamId"');
@@ -285,17 +296,18 @@ class Teams extends Service {
         }
 
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
 
     /**
-     * Update Membership Roles
+     * 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).
+     * 
      *
      * @param {string} teamId
      * @param {string} membershipId
@@ -303,8 +315,8 @@ class Teams extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async updateMembershipRoles(teamId, membershipId, roles) {
-        let path = '/teams/{teamId}/memberships/{membershipId}'.replace('{teamId}', teamId).replace('{membershipId}', membershipId);
+    async updateMembership(teamId, membershipId, roles) {
+        const apiPath = '/teams/{teamId}/memberships/{membershipId}'.replace('{teamId}', teamId).replace('{membershipId}', membershipId);
         let payload = {};
         if (typeof teamId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "teamId"');
@@ -323,7 +335,7 @@ class Teams extends Service {
             payload['roles'] = roles;
         }
 
-        return await this.client.call('patch', path, {
+        return await this.client.call('patch', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -341,7 +353,7 @@ class Teams extends Service {
      * @returns {Promise}
      */
     async deleteMembership(teamId, membershipId) {
-        let path = '/teams/{teamId}/memberships/{membershipId}'.replace('{teamId}', teamId).replace('{membershipId}', membershipId);
+        const apiPath = '/teams/{teamId}/memberships/{membershipId}'.replace('{teamId}', teamId).replace('{membershipId}', membershipId);
         let payload = {};
         if (typeof teamId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "teamId"');
@@ -352,7 +364,7 @@ class Teams extends Service {
         }
 
 
-        return await this.client.call('delete', path, {
+        return await this.client.call('delete', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -376,7 +388,7 @@ class Teams extends Service {
      * @returns {Promise}
      */
     async updateMembershipStatus(teamId, membershipId, userId, secret) {
-        let path = '/teams/{teamId}/memberships/{membershipId}/status'.replace('{teamId}', teamId).replace('{membershipId}', membershipId);
+        const apiPath = '/teams/{teamId}/memberships/{membershipId}/status'.replace('{teamId}', teamId).replace('{membershipId}', membershipId);
         let payload = {};
         if (typeof teamId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "teamId"');
@@ -403,7 +415,64 @@ class Teams extends Service {
             payload['secret'] = secret;
         }
 
-        return await this.client.call('patch', path, {
+        return await this.client.call('patch', apiPath, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * 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).
+     *
+     * @param {string} teamId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async getPrefs(teamId) {
+        const apiPath = '/teams/{teamId}/prefs'.replace('{teamId}', teamId);
+        let payload = {};
+        if (typeof teamId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "teamId"');
+        }
+
+
+        return await this.client.call('get', apiPath, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * 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
+     * size is 64kB and throws an error if exceeded.
+     *
+     * @param {string} teamId
+     * @param {object} prefs
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async updatePrefs(teamId, prefs) {
+        const apiPath = '/teams/{teamId}/prefs'.replace('{teamId}', teamId);
+        let payload = {};
+        if (typeof teamId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "teamId"');
+        }
+
+        if (typeof prefs === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "prefs"');
+        }
+
+
+        if (typeof prefs !== 'undefined') {
+            payload['prefs'] = prefs;
+        }
+
+        return await this.client.call('put', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }