@appwrite.io/console 0.6.4 → 0.7.0-rc.2

package/src/services/teams.ts

@@ -1,87 +1,87 @@
-import { Service } from '../service';
-import { AppwriteException, Client } from '../client';
+import { AppwriteException, Client, type Payload, UploadProgress } from '../client';
 import type { Models } from '../models';
-import type { UploadProgress, Payload } from '../client';
 
-export class Teams extends Service {
+export class Teams {
+    client: Client;
 
-     constructor(client: Client)
-     {
-        super(client);
-     }
+    constructor(client: Client) {
+        this.client = client;
+    }
 
     /**
      * 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.
+     * Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.
      *
      * @param {string[]} queries
      * @param {string} search
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.TeamList<Preferences>>}
+     */
     async list<Preferences extends Models.Preferences>(queries?: string[], search?: string): Promise<Models.TeamList<Preferences>> {
         const apiPath = '/teams';
         const payload: Payload = {};
-
         if (typeof queries !== 'undefined') {
             payload['queries'] = queries;
         }
-
         if (typeof search !== 'undefined') {
             payload['search'] = search;
         }
-
         const uri = new URL(this.client.config.endpoint + apiPath);
-        return await this.client.call('get', uri, {
+
+        const apiHeaders: { [header: string]: string } = {
             'content-type': 'application/json',
-        }, payload);
-    }
+        }
 
+        return await this.client.call(
+            'get',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
     /**
      * 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
-     * invite new members, add new owners and delete or update the 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 invite new members, add new owners and delete or update the team.
      *
      * @param {string} teamId
      * @param {string} name
      * @param {string[]} roles
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Team<Preferences>>}
+     */
     async create<Preferences extends Models.Preferences>(teamId: string, name: string, roles?: string[]): Promise<Models.Team<Preferences>> {
         if (typeof teamId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "teamId"');
         }
-
         if (typeof name === 'undefined') {
             throw new AppwriteException('Missing required parameter: "name"');
         }
-
         const apiPath = '/teams';
         const payload: Payload = {};
-
         if (typeof teamId !== 'undefined') {
             payload['teamId'] = teamId;
         }
-
         if (typeof name !== 'undefined') {
             payload['name'] = name;
         }
-
         if (typeof roles !== 'undefined') {
             payload['roles'] = roles;
         }
-
         const uri = new URL(this.client.config.endpoint + apiPath);
-        return await this.client.call('post', uri, {
+
+        const apiHeaders: { [header: string]: string } = {
             'content-type': 'application/json',
-        }, payload);
-    }
+        }
 
+        return await this.client.call(
+            'post',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
     /**
      * Get team
      *
@@ -89,78 +89,90 @@ export class Teams extends Service {
      *
      * @param {string} teamId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Team<Preferences>>}
+     */
     async get<Preferences extends Models.Preferences>(teamId: string): Promise<Models.Team<Preferences>> {
         if (typeof teamId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "teamId"');
         }
-
         const apiPath = '/teams/{teamId}'.replace('{teamId}', teamId);
         const payload: Payload = {};
-
         const uri = new URL(this.client.config.endpoint + apiPath);
-        return await this.client.call('get', uri, {
+
+        const apiHeaders: { [header: string]: string } = {
             'content-type': 'application/json',
-        }, payload);
-    }
+        }
 
+        return await this.client.call(
+            'get',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
     /**
      * Update name
      *
-     * Update the team's name by its unique ID.
+     * Update the team&#039;s name by its unique ID.
      *
      * @param {string} teamId
      * @param {string} name
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Team<Preferences>>}
+     */
     async updateName<Preferences extends Models.Preferences>(teamId: string, name: string): Promise<Models.Team<Preferences>> {
         if (typeof teamId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "teamId"');
         }
-
         if (typeof name === 'undefined') {
             throw new AppwriteException('Missing required parameter: "name"');
         }
-
         const apiPath = '/teams/{teamId}'.replace('{teamId}', teamId);
         const payload: Payload = {};
-
         if (typeof name !== 'undefined') {
             payload['name'] = name;
         }
-
         const uri = new URL(this.client.config.endpoint + apiPath);
-        return await this.client.call('put', uri, {
+
+        const apiHeaders: { [header: string]: string } = {
             'content-type': 'application/json',
-        }, payload);
-    }
+        }
 
+        return await this.client.call(
+            'put',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
     /**
      * Delete team
      *
-     * Delete a team using its ID. Only team members with the owner role can
-     * delete the team.
+     * Delete a team using its ID. Only team members with the owner role can delete the team.
      *
      * @param {string} teamId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<{}>}
+     */
     async delete(teamId: string): Promise<{}> {
         if (typeof teamId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "teamId"');
         }
-
         const apiPath = '/teams/{teamId}'.replace('{teamId}', teamId);
         const payload: Payload = {};
-
         const uri = new URL(this.client.config.endpoint + apiPath);
-        return await this.client.call('delete', uri, {
+
+        const apiHeaders: { [header: string]: string } = {
             'content-type': 'application/json',
-        }, payload);
-    }
+        }
 
+        return await this.client.call(
+            'delete',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
     /**
      * List team logs
      *
@@ -169,84 +181,77 @@ export class Teams extends Service {
      * @param {string} teamId
      * @param {string[]} queries
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.LogList>}
+     */
     async listLogs(teamId: string, queries?: string[]): Promise<Models.LogList> {
         if (typeof teamId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "teamId"');
         }
-
         const apiPath = '/teams/{teamId}/logs'.replace('{teamId}', teamId);
         const payload: Payload = {};
-
         if (typeof queries !== 'undefined') {
             payload['queries'] = queries;
         }
-
         const uri = new URL(this.client.config.endpoint + apiPath);
-        return await this.client.call('get', uri, {
+
+        const apiHeaders: { [header: string]: string } = {
             'content-type': 'application/json',
-        }, payload);
-    }
+        }
 
+        return await this.client.call(
+            'get',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
     /**
      * 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.
+     * Use this endpoint to list a team&#039;s members using the team&#039;s ID. All team members have read access to this endpoint.
      *
      * @param {string} teamId
      * @param {string[]} queries
      * @param {string} search
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.MembershipList>}
+     */
     async listMemberships(teamId: string, queries?: string[], search?: string): Promise<Models.MembershipList> {
         if (typeof teamId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "teamId"');
         }
-
         const apiPath = '/teams/{teamId}/memberships'.replace('{teamId}', teamId);
         const payload: Payload = {};
-
         if (typeof queries !== 'undefined') {
             payload['queries'] = queries;
         }
-
         if (typeof search !== 'undefined') {
             payload['search'] = search;
         }
-
         const uri = new URL(this.client.config.endpoint + apiPath);
-        return await this.client.call('get', uri, {
+
+        const apiHeaders: { [header: string]: string } = {
             'content-type': 'application/json',
-        }, payload);
-    }
+        }
 
+        return await this.client.call(
+            'get',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
     /**
      * 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
-     * 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.
-     * 
-     * 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](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)
-     * Appwrite will accept the only redirect URLs under the domains you have
-     * added as a platform on the Appwrite Console.
-     * 
+     * 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&#039;t exist. If initiated from a Server SDK, the new member will be added automatically to the team.
+
+You only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID &gt; email &gt; 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](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) 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[]} roles
@@ -256,257 +261,262 @@ export class Teams extends Service {
      * @param {string} url
      * @param {string} name
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Membership>}
+     */
     async createMembership(teamId: string, roles: string[], email?: string, userId?: string, phone?: string, url?: string, name?: string): Promise<Models.Membership> {
         if (typeof teamId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "teamId"');
         }
-
         if (typeof roles === 'undefined') {
             throw new AppwriteException('Missing required parameter: "roles"');
         }
-
         const apiPath = '/teams/{teamId}/memberships'.replace('{teamId}', teamId);
         const payload: Payload = {};
-
         if (typeof email !== 'undefined') {
             payload['email'] = email;
         }
-
         if (typeof userId !== 'undefined') {
             payload['userId'] = userId;
         }
-
         if (typeof phone !== 'undefined') {
             payload['phone'] = phone;
         }
-
         if (typeof roles !== 'undefined') {
             payload['roles'] = roles;
         }
-
         if (typeof url !== 'undefined') {
             payload['url'] = url;
         }
-
         if (typeof name !== 'undefined') {
             payload['name'] = name;
         }
-
         const uri = new URL(this.client.config.endpoint + apiPath);
-        return await this.client.call('post', uri, {
+
+        const apiHeaders: { [header: string]: string } = {
             'content-type': 'application/json',
-        }, payload);
-    }
+        }
 
+        return await this.client.call(
+            'post',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
     /**
      * Get team membership
      *
-     * Get a team member by the membership unique id. All team members have read
-     * access for this resource.
+     * Get a team member by the membership unique id. All team members have read access for this resource.
      *
      * @param {string} teamId
      * @param {string} membershipId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Membership>}
+     */
     async getMembership(teamId: string, membershipId: string): Promise<Models.Membership> {
         if (typeof teamId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "teamId"');
         }
-
         if (typeof membershipId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "membershipId"');
         }
-
         const apiPath = '/teams/{teamId}/memberships/{membershipId}'.replace('{teamId}', teamId).replace('{membershipId}', membershipId);
         const payload: Payload = {};
-
         const uri = new URL(this.client.config.endpoint + apiPath);
-        return await this.client.call('get', uri, {
+
+        const apiHeaders: { [header: string]: string } = {
             'content-type': 'application/json',
-        }, payload);
-    }
+        }
 
+        return await this.client.call(
+            'get',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
     /**
      * 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](https://appwrite.io/docs/permissions).
-     * 
+     * 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](https://appwrite.io/docs/permissions).
+
      *
      * @param {string} teamId
      * @param {string} membershipId
      * @param {string[]} roles
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Membership>}
+     */
     async updateMembership(teamId: string, membershipId: string, roles: string[]): Promise<Models.Membership> {
         if (typeof teamId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "teamId"');
         }
-
         if (typeof membershipId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "membershipId"');
         }
-
         if (typeof roles === 'undefined') {
             throw new AppwriteException('Missing required parameter: "roles"');
         }
-
         const apiPath = '/teams/{teamId}/memberships/{membershipId}'.replace('{teamId}', teamId).replace('{membershipId}', membershipId);
         const payload: Payload = {};
-
         if (typeof roles !== 'undefined') {
             payload['roles'] = roles;
         }
-
         const uri = new URL(this.client.config.endpoint + apiPath);
-        return await this.client.call('patch', uri, {
+
+        const apiHeaders: { [header: string]: string } = {
             'content-type': 'application/json',
-        }, payload);
-    }
+        }
 
+        return await this.client.call(
+            'patch',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
     /**
      * 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
-     * delete a user membership even if it is not accepted.
+     * 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 delete a user membership even if it is not accepted.
      *
      * @param {string} teamId
      * @param {string} membershipId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<{}>}
+     */
     async deleteMembership(teamId: string, membershipId: string): Promise<{}> {
         if (typeof teamId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "teamId"');
         }
-
         if (typeof membershipId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "membershipId"');
         }
-
         const apiPath = '/teams/{teamId}/memberships/{membershipId}'.replace('{teamId}', teamId).replace('{membershipId}', membershipId);
         const payload: Payload = {};
-
         const uri = new URL(this.client.config.endpoint + apiPath);
-        return await this.client.call('delete', uri, {
+
+        const apiHeaders: { [header: string]: string } = {
             'content-type': 'application/json',
-        }, payload);
-    }
+        }
 
+        return await this.client.call(
+            'delete',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
     /**
      * 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
-     * by the user.
-     * 
-     * If the request is successful, a session for the user is automatically
-     * created.
-     * 
+     * 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 by the user.
+
+If the request is successful, a session for the user is automatically created.
+
      *
      * @param {string} teamId
      * @param {string} membershipId
      * @param {string} userId
      * @param {string} secret
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Models.Membership>}
+     */
     async updateMembershipStatus(teamId: string, membershipId: string, userId: string, secret: string): Promise<Models.Membership> {
         if (typeof teamId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "teamId"');
         }
-
         if (typeof membershipId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "membershipId"');
         }
-
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
         }
-
         if (typeof secret === 'undefined') {
             throw new AppwriteException('Missing required parameter: "secret"');
         }
-
         const apiPath = '/teams/{teamId}/memberships/{membershipId}/status'.replace('{teamId}', teamId).replace('{membershipId}', membershipId);
         const payload: 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 await this.client.call('patch', uri, {
+
+        const apiHeaders: { [header: string]: string } = {
             'content-type': 'application/json',
-        }, payload);
-    }
+        }
 
+        return await this.client.call(
+            'patch',
+            uri,
+            apiHeaders,
+            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](https://appwrite.io/docs/references/cloud/client-web/account#getPrefs).
+     * Get the team&#039;s shared preferences by its unique ID. If a preference doesn&#039;t need to be shared by all team members, prefer storing them in [user preferences](https://appwrite.io/docs/references/cloud/client-web/account#getPrefs).
      *
      * @param {string} teamId
      * @throws {AppwriteException}
-     * @returns {Promise}
-    */
+     * @returns {Promise<Preferences>}
+     */
     async getPrefs<Preferences extends Models.Preferences>(teamId: string): Promise<Preferences> {
         if (typeof teamId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "teamId"');
         }
-
         const apiPath = '/teams/{teamId}/prefs'.replace('{teamId}', teamId);
         const payload: Payload = {};
-
         const uri = new URL(this.client.config.endpoint + apiPath);
-        return await this.client.call('get', uri, {
+
+        const apiHeaders: { [header: string]: string } = {
             'content-type': 'application/json',
-        }, payload);
-    }
+        }
 
+        return await this.client.call(
+            'get',
+            uri,
+            apiHeaders,
+            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.
+     * Update the team&#039;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}
-    */
+     * @returns {Promise<Preferences>}
+     */
     async updatePrefs<Preferences extends Models.Preferences>(teamId: string, prefs: object): Promise<Preferences> {
         if (typeof teamId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "teamId"');
         }
-
         if (typeof prefs === 'undefined') {
             throw new AppwriteException('Missing required parameter: "prefs"');
         }
-
         const apiPath = '/teams/{teamId}/prefs'.replace('{teamId}', teamId);
         const payload: Payload = {};
-
         if (typeof prefs !== 'undefined') {
             payload['prefs'] = prefs;
         }
-
         const uri = new URL(this.client.config.endpoint + apiPath);
-        return await this.client.call('put', uri, {
+
+        const apiHeaders: { [header: string]: string } = {
             'content-type': 'application/json',
-        }, payload);
+        }
+
+        return await this.client.call(
+            'put',
+            uri,
+            apiHeaders,
+            payload
+        );
     }
-};
+}