From 626d0d7281cdf0c5617d972618c571b31a42fc74 Mon Sep 17 00:00:00 2001 From: Eldad Fux Date: Sat, 19 Sep 2020 07:09:18 +0300 Subject: [PATCH] Added user delete method to the console SDK --- app/sdks/client-web/README.md | 2 +- app/sdks/console-web/README.md | 2 +- .../docs/examples/users/delete-user.md | 15 ++++++++++++ app/sdks/console-web/src/sdk.js | 24 +++++++++++++++++++ app/sdks/console-web/src/sdk.min.js | 3 ++- app/sdks/console-web/types/index.d.ts | 11 +++++++++ 6 files changed, 54 insertions(+), 3 deletions(-) create mode 100644 app/sdks/console-web/docs/examples/users/delete-user.md diff --git a/app/sdks/client-web/README.md b/app/sdks/client-web/README.md index 093783ab41..41e939b017 100644 --- a/app/sdks/client-web/README.md +++ b/app/sdks/client-web/README.md @@ -1,7 +1,7 @@ # Appwrite Web SDK ![License](https://img.shields.io/github/license/appwrite/sdk-for-js.svg?v=1) -![Version](https://img.shields.io/badge/api%20version-0.6.2-blue.svg?v=1) +![Version](https://img.shields.io/badge/api%20version-0.7.0-blue.svg?v=1) Appwrite is an open-source backend as a service server that abstract and simplify complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the Web SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. diff --git a/app/sdks/console-web/README.md b/app/sdks/console-web/README.md index 68b7e8ff9c..000e4988f1 100644 --- a/app/sdks/console-web/README.md +++ b/app/sdks/console-web/README.md @@ -1,7 +1,7 @@ # Appwrite Console SDK ![License](https://img.shields.io/github/license/appwrite/sdk-for-console.svg?v=1) -![Version](https://img.shields.io/badge/api%20version-0.6.2-blue.svg?v=1) +![Version](https://img.shields.io/badge/api%20version-0.7.0-blue.svg?v=1) Appwrite is an open-source backend as a service server that abstract and simplify complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the Console SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. diff --git a/app/sdks/console-web/docs/examples/users/delete-user.md b/app/sdks/console-web/docs/examples/users/delete-user.md new file mode 100644 index 0000000000..40f33e34c2 --- /dev/null +++ b/app/sdks/console-web/docs/examples/users/delete-user.md @@ -0,0 +1,15 @@ +let sdk = new Appwrite(); + +sdk + .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint + .setProject('5df5acd0d48c2') // Your project ID + .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key +; + +let promise = sdk.users.deleteUser('[USER_ID]'); + +promise.then(function (response) { + console.log(response); // Success +}, function (error) { + console.log(error); // Failure +}); \ No newline at end of file diff --git a/app/sdks/console-web/src/sdk.js b/app/sdks/console-web/src/sdk.js index b246db4cc5..fc8da5a1c2 100644 --- a/app/sdks/console-web/src/sdk.js +++ b/app/sdks/console-web/src/sdk.js @@ -4750,6 +4750,30 @@ }, payload); }, + /** + * Delete User + * + * Delete a user by its unique ID. + * + * @param {string} userId + * @throws {Error} + * @return {Promise} + */ + deleteUser: function(userId) { + if(userId === undefined) { + throw new Error('Missing required parameter: "userId"'); + } + + let path = '/users/{userId}'.replace(new RegExp('{userId}', 'g'), userId); + + let payload = {}; + + return http + .delete(path, { + 'content-type': 'application/json', + }, payload); + }, + /** * Get User Logs * diff --git a/app/sdks/console-web/src/sdk.min.js b/app/sdks/console-web/src/sdk.min.js index 6501248b84..2413458654 100644 --- a/app/sdks/console-web/src/sdk.min.js +++ b/app/sdks/console-web/src/sdk.min.js @@ -415,7 +415,8 @@ let path='/users';let payload={};if(email){payload.email=email} if(password){payload.password=password} if(name){payload.name=name} return http.post(path,{'content-type':'application/json',},payload)},get:function(userId){if(userId===undefined){throw new Error('Missing required parameter: "userId"')} -let path='/users/{userId}'.replace(new RegExp('{userId}','g'),userId);let payload={};return http.get(path,{'content-type':'application/json',},payload)},getLogs:function(userId){if(userId===undefined){throw new Error('Missing required parameter: "userId"')} +let path='/users/{userId}'.replace(new RegExp('{userId}','g'),userId);let payload={};return http.get(path,{'content-type':'application/json',},payload)},deleteUser:function(userId){if(userId===undefined){throw new Error('Missing required parameter: "userId"')} +let path='/users/{userId}'.replace(new RegExp('{userId}','g'),userId);let payload={};return http.delete(path,{'content-type':'application/json',},payload)},getLogs:function(userId){if(userId===undefined){throw new Error('Missing required parameter: "userId"')} let path='/users/{userId}/logs'.replace(new RegExp('{userId}','g'),userId);let payload={};return http.get(path,{'content-type':'application/json',},payload)},getPrefs:function(userId){if(userId===undefined){throw new Error('Missing required parameter: "userId"')} let path='/users/{userId}/prefs'.replace(new RegExp('{userId}','g'),userId);let payload={};return http.get(path,{'content-type':'application/json',},payload)},updatePrefs:function(userId,prefs){if(userId===undefined){throw new Error('Missing required parameter: "userId"')} if(prefs===undefined){throw new Error('Missing required parameter: "prefs"')} diff --git a/app/sdks/console-web/types/index.d.ts b/app/sdks/console-web/types/index.d.ts index b34f32c5bc..e6e7ba776a 100644 --- a/app/sdks/console-web/types/index.d.ts +++ b/app/sdks/console-web/types/index.d.ts @@ -1706,6 +1706,17 @@ declare namespace Appwrite { */ get(userId: string): Promise; + /** + * Delete User + * + * Delete a user by its unique ID. + * + * @param {string} userId + * @throws {Error} + * @return {Promise} + */ + deleteUser(userId: string): Promise; + /** * Get User Logs *