node-appwrite 9.0.0 → 10.0.0

package/lib/services/users.js

@@ -26,7 +26,7 @@ class Users extends Service {
      * @returns {Promise}
      */
     async list(queries, search) {
-        let path = '/users';
+        const apiPath = '/users';
         let payload = {};
 
         if (typeof queries !== 'undefined') {
@@ -37,7 +37,7 @@ class Users 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 Users extends Service {
      * @returns {Promise}
      */
     async create(userId, email, phone, password, name) {
-        let path = '/users';
+        const apiPath = '/users';
         let payload = {};
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
@@ -83,7 +83,7 @@ class Users extends Service {
             payload['name'] = name;
         }
 
-        return await this.client.call('post', path, {
+        return await this.client.call('post', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -104,7 +104,7 @@ class Users extends Service {
      * @returns {Promise}
      */
     async createArgon2User(userId, email, password, name) {
-        let path = '/users/argon2';
+        const apiPath = '/users/argon2';
         let payload = {};
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
@@ -135,7 +135,7 @@ class Users extends Service {
             payload['name'] = name;
         }
 
-        return await this.client.call('post', path, {
+        return await this.client.call('post', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -156,7 +156,7 @@ class Users extends Service {
      * @returns {Promise}
      */
     async createBcryptUser(userId, email, password, name) {
-        let path = '/users/bcrypt';
+        const apiPath = '/users/bcrypt';
         let payload = {};
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
@@ -187,7 +187,56 @@ class Users extends Service {
             payload['name'] = name;
         }
 
-        return await this.client.call('post', path, {
+        return await this.client.call('post', apiPath, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * List Identities
+     *
+     * Get identities for all users.
+     *
+     * @param {string} queries
+     * @param {string} search
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async listIdentities(queries, search) {
+        const apiPath = '/users/identities';
+        let payload = {};
+
+        if (typeof queries !== 'undefined') {
+            payload['queries'] = queries;
+        }
+
+        if (typeof search !== 'undefined') {
+            payload['search'] = search;
+        }
+
+        return await this.client.call('get', apiPath, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Delete Identity
+     *
+     * Delete an identity by its unique ID.
+     *
+     * @param {string} identityId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async deleteIdentity(identityId) {
+        const apiPath = '/users/identities/{identityId}'.replace('{identityId}', identityId);
+        let payload = {};
+        if (typeof identityId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "identityId"');
+        }
+
+
+        return await this.client.call('delete', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -208,7 +257,7 @@ class Users extends Service {
      * @returns {Promise}
      */
     async createMD5User(userId, email, password, name) {
-        let path = '/users/md5';
+        const apiPath = '/users/md5';
         let payload = {};
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
@@ -239,7 +288,7 @@ class Users extends Service {
             payload['name'] = name;
         }
 
-        return await this.client.call('post', path, {
+        return await this.client.call('post', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -260,7 +309,7 @@ class Users extends Service {
      * @returns {Promise}
      */
     async createPHPassUser(userId, email, password, name) {
-        let path = '/users/phpass';
+        const apiPath = '/users/phpass';
         let payload = {};
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
@@ -291,7 +340,7 @@ class Users extends Service {
             payload['name'] = name;
         }
 
-        return await this.client.call('post', path, {
+        return await this.client.call('post', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -317,7 +366,7 @@ class Users extends Service {
      * @returns {Promise}
      */
     async createScryptUser(userId, email, password, passwordSalt, passwordCpu, passwordMemory, passwordParallel, passwordLength, name) {
-        let path = '/users/scrypt';
+        const apiPath = '/users/scrypt';
         let payload = {};
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
@@ -388,7 +437,7 @@ class Users extends Service {
             payload['name'] = name;
         }
 
-        return await this.client.call('post', path, {
+        return await this.client.call('post', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -412,7 +461,7 @@ class Users extends Service {
      * @returns {Promise}
      */
     async createScryptModifiedUser(userId, email, password, passwordSalt, passwordSaltSeparator, passwordSignerKey, name) {
-        let path = '/users/scrypt-modified';
+        const apiPath = '/users/scrypt-modified';
         let payload = {};
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
@@ -467,7 +516,7 @@ class Users extends Service {
             payload['name'] = name;
         }
 
-        return await this.client.call('post', path, {
+        return await this.client.call('post', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -489,7 +538,7 @@ class Users extends Service {
      * @returns {Promise}
      */
     async createSHAUser(userId, email, password, passwordVersion, name) {
-        let path = '/users/sha';
+        const apiPath = '/users/sha';
         let payload = {};
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
@@ -524,7 +573,7 @@ class Users extends Service {
             payload['name'] = name;
         }
 
-        return await this.client.call('post', path, {
+        return await this.client.call('post', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -539,14 +588,14 @@ class Users extends Service {
      * @returns {Promise}
      */
     async get(userId) {
-        let path = '/users/{userId}'.replace('{userId}', userId);
+        const apiPath = '/users/{userId}'.replace('{userId}', userId);
         let payload = {};
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
         }
 
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -565,14 +614,14 @@ class Users extends Service {
      * @returns {Promise}
      */
     async delete(userId) {
-        let path = '/users/{userId}'.replace('{userId}', userId);
+        const apiPath = '/users/{userId}'.replace('{userId}', userId);
         let payload = {};
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
         }
 
 
-        return await this.client.call('delete', path, {
+        return await this.client.call('delete', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -588,7 +637,7 @@ class Users extends Service {
      * @returns {Promise}
      */
     async updateEmail(userId, email) {
-        let path = '/users/{userId}/email'.replace('{userId}', userId);
+        const apiPath = '/users/{userId}/email'.replace('{userId}', userId);
         let payload = {};
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
@@ -603,7 +652,43 @@ class Users extends Service {
             payload['email'] = email;
         }
 
-        return await this.client.call('patch', path, {
+        return await this.client.call('patch', apiPath, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Update User Labels
+     *
+     * Update the user labels by its unique ID. 
+     * 
+     * Labels can be used to grant access to resources. While teams are a way for
+     * user's to share access to a resource, labels can be defined by the
+     * developer to grant access without an invitation. See the [Permissions
+     * docs](/docs/permissions) for more info.
+     *
+     * @param {string} userId
+     * @param {string[]} labels
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async updateLabels(userId, labels) {
+        const apiPath = '/users/{userId}/labels'.replace('{userId}', userId);
+        let payload = {};
+        if (typeof userId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "userId"');
+        }
+
+        if (typeof labels === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "labels"');
+        }
+
+
+        if (typeof labels !== 'undefined') {
+            payload['labels'] = labels;
+        }
+
+        return await this.client.call('put', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -619,7 +704,7 @@ class Users extends Service {
      * @returns {Promise}
      */
     async listLogs(userId, queries) {
-        let path = '/users/{userId}/logs'.replace('{userId}', userId);
+        const apiPath = '/users/{userId}/logs'.replace('{userId}', userId);
         let payload = {};
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
@@ -630,7 +715,7 @@ class Users extends Service {
             payload['queries'] = queries;
         }
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -645,14 +730,14 @@ class Users extends Service {
      * @returns {Promise}
      */
     async listMemberships(userId) {
-        let path = '/users/{userId}/memberships'.replace('{userId}', userId);
+        const apiPath = '/users/{userId}/memberships'.replace('{userId}', userId);
         let payload = {};
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
         }
 
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -668,7 +753,7 @@ class Users extends Service {
      * @returns {Promise}
      */
     async updateName(userId, name) {
-        let path = '/users/{userId}/name'.replace('{userId}', userId);
+        const apiPath = '/users/{userId}/name'.replace('{userId}', userId);
         let payload = {};
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
@@ -683,7 +768,7 @@ class Users extends Service {
             payload['name'] = name;
         }
 
-        return await this.client.call('patch', path, {
+        return await this.client.call('patch', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -699,7 +784,7 @@ class Users extends Service {
      * @returns {Promise}
      */
     async updatePassword(userId, password) {
-        let path = '/users/{userId}/password'.replace('{userId}', userId);
+        const apiPath = '/users/{userId}/password'.replace('{userId}', userId);
         let payload = {};
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
@@ -714,7 +799,7 @@ class Users extends Service {
             payload['password'] = password;
         }
 
-        return await this.client.call('patch', path, {
+        return await this.client.call('patch', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -730,7 +815,7 @@ class Users extends Service {
      * @returns {Promise}
      */
     async updatePhone(userId, number) {
-        let path = '/users/{userId}/phone'.replace('{userId}', userId);
+        const apiPath = '/users/{userId}/phone'.replace('{userId}', userId);
         let payload = {};
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
@@ -745,7 +830,7 @@ class Users extends Service {
             payload['number'] = number;
         }
 
-        return await this.client.call('patch', path, {
+        return await this.client.call('patch', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -760,14 +845,14 @@ class Users extends Service {
      * @returns {Promise}
      */
     async getPrefs(userId) {
-        let path = '/users/{userId}/prefs'.replace('{userId}', userId);
+        const apiPath = '/users/{userId}/prefs'.replace('{userId}', userId);
         let payload = {};
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
         }
 
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -785,7 +870,7 @@ class Users extends Service {
      * @returns {Promise}
      */
     async updatePrefs(userId, prefs) {
-        let path = '/users/{userId}/prefs'.replace('{userId}', userId);
+        const apiPath = '/users/{userId}/prefs'.replace('{userId}', userId);
         let payload = {};
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
@@ -800,7 +885,7 @@ class Users extends Service {
             payload['prefs'] = prefs;
         }
 
-        return await this.client.call('patch', path, {
+        return await this.client.call('patch', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -815,14 +900,14 @@ class Users extends Service {
      * @returns {Promise}
      */
     async listSessions(userId) {
-        let path = '/users/{userId}/sessions'.replace('{userId}', userId);
+        const apiPath = '/users/{userId}/sessions'.replace('{userId}', userId);
         let payload = {};
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
         }
 
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -837,14 +922,14 @@ class Users extends Service {
      * @returns {Promise}
      */
     async deleteSessions(userId) {
-        let path = '/users/{userId}/sessions'.replace('{userId}', userId);
+        const apiPath = '/users/{userId}/sessions'.replace('{userId}', userId);
         let payload = {};
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
         }
 
 
-        return await this.client.call('delete', path, {
+        return await this.client.call('delete', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -860,7 +945,7 @@ class Users extends Service {
      * @returns {Promise}
      */
     async deleteSession(userId, sessionId) {
-        let path = '/users/{userId}/sessions/{sessionId}'.replace('{userId}', userId).replace('{sessionId}', sessionId);
+        const apiPath = '/users/{userId}/sessions/{sessionId}'.replace('{userId}', userId).replace('{sessionId}', sessionId);
         let payload = {};
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
@@ -871,7 +956,7 @@ class Users extends Service {
         }
 
 
-        return await this.client.call('delete', path, {
+        return await this.client.call('delete', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -888,7 +973,7 @@ class Users extends Service {
      * @returns {Promise}
      */
     async updateStatus(userId, status) {
-        let path = '/users/{userId}/status'.replace('{userId}', userId);
+        const apiPath = '/users/{userId}/status'.replace('{userId}', userId);
         let payload = {};
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
@@ -903,7 +988,7 @@ class Users extends Service {
             payload['status'] = status;
         }
 
-        return await this.client.call('patch', path, {
+        return await this.client.call('patch', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -919,7 +1004,7 @@ class Users extends Service {
      * @returns {Promise}
      */
     async updateEmailVerification(userId, emailVerification) {
-        let path = '/users/{userId}/verification'.replace('{userId}', userId);
+        const apiPath = '/users/{userId}/verification'.replace('{userId}', userId);
         let payload = {};
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
@@ -934,7 +1019,7 @@ class Users extends Service {
             payload['emailVerification'] = emailVerification;
         }
 
-        return await this.client.call('patch', path, {
+        return await this.client.call('patch', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -950,7 +1035,7 @@ class Users extends Service {
      * @returns {Promise}
      */
     async updatePhoneVerification(userId, phoneVerification) {
-        let path = '/users/{userId}/verification/phone'.replace('{userId}', userId);
+        const apiPath = '/users/{userId}/verification/phone'.replace('{userId}', userId);
         let payload = {};
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
@@ -965,7 +1050,7 @@ class Users extends Service {
             payload['phoneVerification'] = phoneVerification;
         }
 
-        return await this.client.call('patch', path, {
+        return await this.client.call('patch', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }

package/package.json

@@ -2,7 +2,7 @@
   "name": "node-appwrite",
   "homepage": "https://appwrite.io/support",
   "description": "Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API",
-  "version": "9.0.0",
+  "version": "10.0.0",
   "license": "BSD-3-Clause",
   "main": "./index.js",
   "types": "./index.d.ts",
@@ -14,7 +14,7 @@
     "@types/node": "^18.16.1"
   },
   "dependencies": {
-    "axios": "^1.3.6",
+    "axios": "^1.4.0",
     "form-data": "^4.0.0"
   }
 }