node-appwrite 2.4.0 → 4.0.0

package/lib/services/functions.js

@@ -12,11 +12,13 @@ class Functions extends Service {
      * @param {string} search
      * @param {number} limit
      * @param {number} offset
+     * @param {string} cursor
+     * @param {string} cursorDirection
      * @param {string} orderType
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async list(search, limit, offset, orderType) {
+    async list(search, limit, offset, cursor, cursorDirection, orderType) {
         let path = '/functions';
         let payload = {};
 
@@ -32,6 +34,14 @@ class Functions extends Service {
             payload['offset'] = offset;
         }
 
+        if (typeof cursor !== 'undefined') {
+            payload['cursor'] = cursor;
+        }
+
+        if (typeof cursorDirection !== 'undefined') {
+            payload['cursorDirection'] = cursorDirection;
+        }
+
         if (typeof orderType !== 'undefined') {
             payload['orderType'] = orderType;
         }
@@ -48,6 +58,7 @@ class Functions extends Service {
      * [permissions](/docs/permissions) to allow different project users or team
      * with access to execute the function using the client API.
      *
+     * @param {string} functionId
      * @param {string} name
      * @param {string[]} execute
      * @param {string} runtime
@@ -58,7 +69,11 @@ class Functions extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async create(name, execute, runtime, vars, events, schedule, timeout) {
+    async create(functionId, name, execute, runtime, vars, events, schedule, timeout) {
+        if (typeof functionId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "functionId"');
+        }
+
         if (typeof name === 'undefined') {
             throw new AppwriteException('Missing required parameter: "name"');
         }
@@ -74,6 +89,10 @@ class Functions extends Service {
         let path = '/functions';
         let payload = {};
 
+        if (typeof functionId !== 'undefined') {
+            payload['functionId'] = functionId;
+        }
+
         if (typeof name !== 'undefined') {
             payload['name'] = name;
         }
@@ -107,6 +126,23 @@ class Functions extends Service {
         }, payload);
     }
 
+    /**
+     * List the currently active function runtimes.
+     *
+     * Get a list of all runtimes that are currently active in your project.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async listRuntimes() {
+        let path = '/functions/runtimes';
+        let payload = {};
+
+        return await this.client.call('get', path, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
     /**
      * Get Function
      *
@@ -220,14 +256,15 @@ class Functions extends Service {
      * different API modes](/docs/admin).
      *
      * @param {string} functionId
-     * @param {string} search
      * @param {number} limit
      * @param {number} offset
-     * @param {string} orderType
+     * @param {string} search
+     * @param {string} cursor
+     * @param {string} cursorDirection
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async listExecutions(functionId, search, limit, offset, orderType) {
+    async listExecutions(functionId, limit, offset, search, cursor, cursorDirection) {
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
@@ -235,10 +272,6 @@ class Functions extends Service {
         let path = '/functions/{functionId}/executions'.replace('{functionId}', functionId);
         let payload = {};
 
-        if (typeof search !== 'undefined') {
-            payload['search'] = search;
-        }
-
         if (typeof limit !== 'undefined') {
             payload['limit'] = limit;
         }
@@ -247,8 +280,16 @@ class Functions extends Service {
             payload['offset'] = offset;
         }
 
-        if (typeof orderType !== 'undefined') {
-            payload['orderType'] = orderType;
+        if (typeof search !== 'undefined') {
+            payload['search'] = search;
+        }
+
+        if (typeof cursor !== 'undefined') {
+            payload['cursor'] = cursor;
+        }
+
+        if (typeof cursorDirection !== 'undefined') {
+            payload['cursorDirection'] = cursorDirection;
         }
 
         return await this.client.call('get', path, {
@@ -356,11 +397,13 @@ class Functions extends Service {
      * @param {string} search
      * @param {number} limit
      * @param {number} offset
+     * @param {string} cursor
+     * @param {string} cursorDirection
      * @param {string} orderType
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async listTags(functionId, search, limit, offset, orderType) {
+    async listTags(functionId, search, limit, offset, cursor, cursorDirection, orderType) {
         if (typeof functionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "functionId"');
         }
@@ -380,6 +423,14 @@ class Functions extends Service {
             payload['offset'] = offset;
         }
 
+        if (typeof cursor !== 'undefined') {
+            payload['cursor'] = cursor;
+        }
+
+        if (typeof cursorDirection !== 'undefined') {
+            payload['cursorDirection'] = cursorDirection;
+        }
+
         if (typeof orderType !== 'undefined') {
             payload['orderType'] = orderType;
         }

package/lib/services/health.js

@@ -21,14 +21,14 @@ class Health extends Service {
     }
 
     /**
-     * Get Anti virus
+     * Get Antivirus
      *
-     * Check the Appwrite Anti Virus server is up and connection is successful.
+     * Check the Appwrite Antivirus server is up and connection is successful.
      *
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async getAntiVirus() {
+    async getAntivirus() {
         let path = '/health/anti-virus';
         let payload = {};
 
@@ -73,7 +73,7 @@ class Health extends Service {
     }
 
     /**
-     * Get Certificate Queue
+     * Get Certificates Queue
      *
      * Get the number of certificates that are waiting to be issued against
      * [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue
@@ -124,24 +124,6 @@ class Health extends Service {
         }, payload);
     }
 
-    /**
-     * Get Tasks Queue
-     *
-     * Get the number of tasks that are waiting to be processed in the Appwrite
-     * internal queue server.
-     *
-     * @throws {AppwriteException}
-     * @returns {Promise}
-     */
-    async getQueueTasks() {
-        let path = '/health/queue/tasks';
-        let payload = {};
-
-        return await this.client.call('get', path, {
-            'content-type': 'application/json',
-        }, payload);
-    }
-
     /**
      * Get Usage Queue
      *

package/lib/services/storage.js

@@ -13,11 +13,13 @@ class Storage extends Service {
      * @param {string} search
      * @param {number} limit
      * @param {number} offset
+     * @param {string} cursor
+     * @param {string} cursorDirection
      * @param {string} orderType
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async listFiles(search, limit, offset, orderType) {
+    async listFiles(search, limit, offset, cursor, cursorDirection, orderType) {
         let path = '/storage/files';
         let payload = {};
 
@@ -33,6 +35,14 @@ class Storage extends Service {
             payload['offset'] = offset;
         }
 
+        if (typeof cursor !== 'undefined') {
+            payload['cursor'] = cursor;
+        }
+
+        if (typeof cursorDirection !== 'undefined') {
+            payload['cursorDirection'] = cursorDirection;
+        }
+
         if (typeof orderType !== 'undefined') {
             payload['orderType'] = orderType;
         }
@@ -49,13 +59,18 @@ class Storage extends Service {
      * assigned to read and write access unless he has passed custom values for
      * read and write arguments.
      *
+     * @param {string} fileId
      * @param {File} file
      * @param {string[]} read
      * @param {string[]} write
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async createFile(file, read, write) {
+    async createFile(fileId, file, read, write) {
+        if (typeof fileId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "fileId"');
+        }
+
         if (typeof file === 'undefined') {
             throw new AppwriteException('Missing required parameter: "file"');
         }
@@ -63,6 +78,10 @@ class Storage extends Service {
         let path = '/storage/files';
         let payload = {};
 
+        if (typeof fileId !== 'undefined') {
+            payload['fileId'] = fileId;
+        }
+
         if (typeof file !== 'undefined') {
             payload['file'] = file;
         }

package/lib/services/teams.js

@@ -6,19 +6,22 @@ class Teams extends Service {
     /**
      * List Teams
      *
-     * Get a list of all the current user teams. You can use the query params to
-     * filter your results. On admin mode, this endpoint will return a list of all
-     * of the project's teams. [Learn more about different API
-     * modes](/docs/admin).
+     * Get a list of all the teams in which the current user is a member. You can
+     * use the parameters to filter your results.
+     * 
+     * In admin mode, this endpoint returns a list of all the teams in the current
+     * project. [Learn more about different API modes](/docs/admin).
      *
      * @param {string} search
      * @param {number} limit
      * @param {number} offset
+     * @param {string} cursor
+     * @param {string} cursorDirection
      * @param {string} orderType
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async list(search, limit, offset, orderType) {
+    async list(search, limit, offset, cursor, cursorDirection, orderType) {
         let path = '/teams';
         let payload = {};
 
@@ -34,6 +37,14 @@ class Teams extends Service {
             payload['offset'] = offset;
         }
 
+        if (typeof cursor !== 'undefined') {
+            payload['cursor'] = cursor;
+        }
+
+        if (typeof cursorDirection !== 'undefined') {
+            payload['cursorDirection'] = cursorDirection;
+        }
+
         if (typeof orderType !== 'undefined') {
             payload['orderType'] = orderType;
         }
@@ -47,16 +58,20 @@ class Teams extends Service {
      * Create Team
      *
      * Create a new team. The user who creates the team will automatically be
-     * assigned as the owner of the team. The team owner can invite new members,
-     * who will be able add new owners and update or delete the team from your
-     * project.
+     * 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}
      */
-    async create(name, roles) {
+    async create(teamId, name, roles) {
+        if (typeof teamId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "teamId"');
+        }
+
         if (typeof name === 'undefined') {
             throw new AppwriteException('Missing required parameter: "name"');
         }
@@ -64,6 +79,10 @@ class Teams extends Service {
         let path = '/teams';
         let payload = {};
 
+        if (typeof teamId !== 'undefined') {
+            payload['teamId'] = teamId;
+        }
+
         if (typeof name !== 'undefined') {
             payload['name'] = name;
         }
@@ -80,8 +99,7 @@ class Teams extends Service {
     /**
      * Get Team
      *
-     * Get a team by its unique ID. All team members have read access for this
-     * resource.
+     * Get a team by its ID. All team members have read access for this resource.
      *
      * @param {string} teamId
      * @throws {AppwriteException}
@@ -103,8 +121,8 @@ class Teams extends Service {
     /**
      * Update Team
      *
-     * Update a team by its unique ID. Only team owners have write access for this
-     * resource.
+     * Update a team using its ID. Only members with the owner role can update the
+     * team.
      *
      * @param {string} teamId
      * @param {string} name
@@ -135,8 +153,8 @@ class Teams extends Service {
     /**
      * Delete Team
      *
-     * Delete a team by its unique ID. Only team owners have write access for this
-     * resource.
+     * Delete a team using its ID. Only team members with the owner role can
+     * delete the team.
      *
      * @param {string} teamId
      * @throws {AppwriteException}
@@ -158,18 +176,20 @@ class Teams extends Service {
     /**
      * Get Team Memberships
      *
-     * Get a team members by the team unique ID. All team members have read access
-     * for this list of resources.
+     * Use this endpoint to list a team's members using the team's ID. All team
+     * members have read access to this endpoint.
      *
      * @param {string} teamId
      * @param {string} search
      * @param {number} limit
      * @param {number} offset
+     * @param {string} cursor
+     * @param {string} cursorDirection
      * @param {string} orderType
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async getMemberships(teamId, search, limit, offset, orderType) {
+    async getMemberships(teamId, search, limit, offset, cursor, cursorDirection, orderType) {
         if (typeof teamId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "teamId"');
         }
@@ -189,6 +209,14 @@ class Teams extends Service {
             payload['offset'] = offset;
         }
 
+        if (typeof cursor !== 'undefined') {
+            payload['cursor'] = cursor;
+        }
+
+        if (typeof cursorDirection !== 'undefined') {
+            payload['cursorDirection'] = cursorDirection;
+        }
+
         if (typeof orderType !== 'undefined') {
             payload['orderType'] = orderType;
         }
@@ -201,19 +229,21 @@ class Teams extends Service {
     /**
      * Create Team Membership
      *
-     * Use this endpoint to invite a new member to join your team. An email with a
-     * link to join the team will be sent to the new member email address if the
-     * member doesn't exist in the project it will be created automatically.
+     * 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.
      * 
-     * Use the 'URL' parameter to redirect the user from the invitation email back
+     * 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
      * Status](/docs/client/teams#teamsUpdateMembershipStatus) endpoint to allow
-     * the user to accept the invitation to the team.
+     * the user to accept the invitation to the team. 
      * 
-     * Please note that in order to avoid a [Redirect
-     * Attacks](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md)
+     * 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
-     * added your platforms in the console interface.
+     * adding your platforms in the console interface.
      *
      * @param {string} teamId
      * @param {string} email
@@ -247,10 +277,6 @@ class Teams extends Service {
             payload['email'] = email;
         }
 
-        if (typeof name !== 'undefined') {
-            payload['name'] = name;
-        }
-
         if (typeof roles !== 'undefined') {
             payload['roles'] = roles;
         }
@@ -259,14 +285,50 @@ class Teams extends Service {
             payload['url'] = url;
         }
 
+        if (typeof name !== 'undefined') {
+            payload['name'] = name;
+        }
+
         return await this.client.call('post', path, {
             'content-type': 'application/json',
         }, payload);
     }
 
+    /**
+     * Get Team Membership
+     *
+     * 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}
+     */
+    async getMembership(teamId, membershipId) {
+        if (typeof teamId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "teamId"');
+        }
+
+        if (typeof membershipId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "membershipId"');
+        }
+
+        let path = '/teams/{teamId}/memberships/{membershipId}'.replace('{teamId}', teamId).replace('{membershipId}', membershipId);
+        let payload = {};
+
+        return await this.client.call('get', path, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
     /**
      * Update Membership Roles
      *
+     * 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
      * @param {string[]} roles
@@ -331,7 +393,7 @@ class Teams extends Service {
      * 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 recieved
+     * after being redirected back to your app from the invitation email received
      * by the user.
      *
      * @param {string} teamId