appwrite-cli 4.2.0 → 4.2.2

package/lib/commands/users.js

@@ -9,900 +9,1100 @@ const { Command } = require('commander');
 const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')
 const { localConfig, globalConfig } = require("../config");
+const { File } = require('undici');
+const { ReadableStream } = require('stream/web');
+
+/**
+ * @param {fs.ReadStream} readStream
+ * @returns {ReadableStream}
+ */
+function convertReadStreamToReadableStream(readStream) {
+  return new ReadableStream({
+    start(controller) {
+      readStream.on("data", (chunk) => {
+        controller.enqueue(chunk);
+      });
+      readStream.on("end", () => {
+        controller.close();
+      });
+      readStream.on("error", (err) => {
+        controller.error(err);
+      });
+    },
+    cancel() {
+      readStream.destroy();
+    },
+  });
+}
 
 const users = new Command("users").description(commandDescriptions['users']).configureHelp({
     helpWidth: process.stdout.columns || 80
-  })
-
+})
+
+/**
+ * @typedef {Object} UsersListRequestParams
+ * @property {string[]} queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification
+ * @property {string} search Search term to filter your list results. Max length: 256 chars.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {UsersListRequestParams} params
+ */
 const usersList = async ({ queries, search, parseOutput = true, sdk = undefined}) => {
-    /* @param {string[]} queries */
-    /* @param {string} search */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/users';
     let payload = {};
-
-    /** Query Params */
     if (typeof queries !== 'undefined') {
         payload['queries'] = queries;
     }
     if (typeof search !== 'undefined') {
         payload['search'] = search;
     }
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} UsersCreateRequestParams
+ * @property {string} userId User ID. Choose a custom ID or generate a random ID with 'ID.unique()'. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
+ * @property {string} email User email.
+ * @property {string} phone Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
+ * @property {string} password Plain text user password. Must be at least 8 chars.
+ * @property {string} name User name. Max length: 128 chars.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {UsersCreateRequestParams} params
+ */
 const usersCreate = async ({ userId, email, phone, password, name, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} userId */
-    /* @param {string} email */
-    /* @param {string} phone */
-    /* @param {string} password */
-    /* @param {string} name */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/users';
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof userId !== 'undefined') {
         payload['userId'] = userId;
     }
-
-
     if (typeof email !== 'undefined') {
         payload['email'] = email;
     }
-
-
     if (typeof phone !== 'undefined') {
         payload['phone'] = phone;
     }
-
-
     if (typeof password !== 'undefined') {
         payload['password'] = password;
     }
-
-
     if (typeof name !== 'undefined') {
         payload['name'] = name;
     }
 
     let response = undefined;
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} UsersCreateArgon2UserRequestParams
+ * @property {string} userId User ID. Choose a custom ID or generate a random ID with 'ID.unique()'. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
+ * @property {string} email User email.
+ * @property {string} password User password hashed using Argon2.
+ * @property {string} name User name. Max length: 128 chars.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {UsersCreateArgon2UserRequestParams} params
+ */
 const usersCreateArgon2User = async ({ userId, email, password, name, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} userId */
-    /* @param {string} email */
-    /* @param {string} password */
-    /* @param {string} name */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/users/argon2';
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof userId !== 'undefined') {
         payload['userId'] = userId;
     }
-
-
     if (typeof email !== 'undefined') {
         payload['email'] = email;
     }
-
-
     if (typeof password !== 'undefined') {
         payload['password'] = password;
     }
-
-
     if (typeof name !== 'undefined') {
         payload['name'] = name;
     }
 
     let response = undefined;
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} UsersCreateBcryptUserRequestParams
+ * @property {string} userId User ID. Choose a custom ID or generate a random ID with 'ID.unique()'. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
+ * @property {string} email User email.
+ * @property {string} password User password hashed using Bcrypt.
+ * @property {string} name User name. Max length: 128 chars.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {UsersCreateBcryptUserRequestParams} params
+ */
 const usersCreateBcryptUser = async ({ userId, email, password, name, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} userId */
-    /* @param {string} email */
-    /* @param {string} password */
-    /* @param {string} name */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/users/bcrypt';
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof userId !== 'undefined') {
         payload['userId'] = userId;
     }
-
-
     if (typeof email !== 'undefined') {
         payload['email'] = email;
     }
-
-
     if (typeof password !== 'undefined') {
         payload['password'] = password;
     }
-
-
     if (typeof name !== 'undefined') {
         payload['name'] = name;
     }
 
     let response = undefined;
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} UsersListIdentitiesRequestParams
+ * @property {string} queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, provider, providerUid, providerEmail, providerAccessTokenExpiry
+ * @property {string} search Search term to filter your list results. Max length: 256 chars.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {UsersListIdentitiesRequestParams} params
+ */
 const usersListIdentities = async ({ queries, search, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} queries */
-    /* @param {string} search */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/users/identities';
     let payload = {};
-
-    /** Query Params */
     if (typeof queries !== 'undefined') {
         payload['queries'] = queries;
     }
     if (typeof search !== 'undefined') {
         payload['search'] = search;
     }
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const usersDeleteIdentity = async ({ identityId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} identityId */
+/**
+ * @typedef {Object} UsersDeleteIdentityRequestParams
+ * @property {string} identityId Identity ID.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {UsersDeleteIdentityRequestParams} params
+ */
+const usersDeleteIdentity = async ({ identityId, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/users/identities/{identityId}'.replace('{identityId}', identityId);
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('delete', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} UsersCreateMD5UserRequestParams
+ * @property {string} userId User ID. Choose a custom ID or generate a random ID with 'ID.unique()'. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
+ * @property {string} email User email.
+ * @property {string} password User password hashed using MD5.
+ * @property {string} name User name. Max length: 128 chars.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {UsersCreateMD5UserRequestParams} params
+ */
 const usersCreateMD5User = async ({ userId, email, password, name, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} userId */
-    /* @param {string} email */
-    /* @param {string} password */
-    /* @param {string} name */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/users/md5';
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof userId !== 'undefined') {
         payload['userId'] = userId;
     }
-
-
     if (typeof email !== 'undefined') {
         payload['email'] = email;
     }
-
-
     if (typeof password !== 'undefined') {
         payload['password'] = password;
     }
-
-
     if (typeof name !== 'undefined') {
         payload['name'] = name;
     }
 
     let response = undefined;
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} UsersCreatePHPassUserRequestParams
+ * @property {string} userId User ID. Choose a custom ID or pass the string 'ID.unique()'to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
+ * @property {string} email User email.
+ * @property {string} password User password hashed using PHPass.
+ * @property {string} name User name. Max length: 128 chars.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {UsersCreatePHPassUserRequestParams} params
+ */
 const usersCreatePHPassUser = async ({ userId, email, password, name, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} userId */
-    /* @param {string} email */
-    /* @param {string} password */
-    /* @param {string} name */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/users/phpass';
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof userId !== 'undefined') {
         payload['userId'] = userId;
     }
-
-
     if (typeof email !== 'undefined') {
         payload['email'] = email;
     }
-
-
     if (typeof password !== 'undefined') {
         payload['password'] = password;
     }
-
-
     if (typeof name !== 'undefined') {
         payload['name'] = name;
     }
 
     let response = undefined;
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} UsersCreateScryptUserRequestParams
+ * @property {string} userId User ID. Choose a custom ID or generate a random ID with 'ID.unique()'. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
+ * @property {string} email User email.
+ * @property {string} password User password hashed using Scrypt.
+ * @property {string} passwordSalt Optional salt used to hash password.
+ * @property {number} passwordCpu Optional CPU cost used to hash password.
+ * @property {number} passwordMemory Optional memory cost used to hash password.
+ * @property {number} passwordParallel Optional parallelization cost used to hash password.
+ * @property {number} passwordLength Optional hash length used to hash password.
+ * @property {string} name User name. Max length: 128 chars.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {UsersCreateScryptUserRequestParams} params
+ */
 const usersCreateScryptUser = async ({ userId, email, password, passwordSalt, passwordCpu, passwordMemory, passwordParallel, passwordLength, name, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} userId */
-    /* @param {string} email */
-    /* @param {string} password */
-    /* @param {string} passwordSalt */
-    /* @param {number} passwordCpu */
-    /* @param {number} passwordMemory */
-    /* @param {number} passwordParallel */
-    /* @param {number} passwordLength */
-    /* @param {string} name */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/users/scrypt';
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof userId !== 'undefined') {
         payload['userId'] = userId;
     }
-
-
     if (typeof email !== 'undefined') {
         payload['email'] = email;
     }
-
-
     if (typeof password !== 'undefined') {
         payload['password'] = password;
     }
-
-
     if (typeof passwordSalt !== 'undefined') {
         payload['passwordSalt'] = passwordSalt;
     }
-
-
     if (typeof passwordCpu !== 'undefined') {
         payload['passwordCpu'] = passwordCpu;
     }
-
-
     if (typeof passwordMemory !== 'undefined') {
         payload['passwordMemory'] = passwordMemory;
     }
-
-
     if (typeof passwordParallel !== 'undefined') {
         payload['passwordParallel'] = passwordParallel;
     }
-
-
     if (typeof passwordLength !== 'undefined') {
         payload['passwordLength'] = passwordLength;
     }
-
-
     if (typeof name !== 'undefined') {
         payload['name'] = name;
     }
 
     let response = undefined;
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} UsersCreateScryptModifiedUserRequestParams
+ * @property {string} userId User ID. Choose a custom ID or generate a random ID with 'ID.unique()'. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
+ * @property {string} email User email.
+ * @property {string} password User password hashed using Scrypt Modified.
+ * @property {string} passwordSalt Salt used to hash password.
+ * @property {string} passwordSaltSeparator Salt separator used to hash password.
+ * @property {string} passwordSignerKey Signer key used to hash password.
+ * @property {string} name User name. Max length: 128 chars.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {UsersCreateScryptModifiedUserRequestParams} params
+ */
 const usersCreateScryptModifiedUser = async ({ userId, email, password, passwordSalt, passwordSaltSeparator, passwordSignerKey, name, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} userId */
-    /* @param {string} email */
-    /* @param {string} password */
-    /* @param {string} passwordSalt */
-    /* @param {string} passwordSaltSeparator */
-    /* @param {string} passwordSignerKey */
-    /* @param {string} name */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/users/scrypt-modified';
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof userId !== 'undefined') {
         payload['userId'] = userId;
     }
-
-
     if (typeof email !== 'undefined') {
         payload['email'] = email;
     }
-
-
     if (typeof password !== 'undefined') {
         payload['password'] = password;
     }
-
-
     if (typeof passwordSalt !== 'undefined') {
         payload['passwordSalt'] = passwordSalt;
     }
-
-
     if (typeof passwordSaltSeparator !== 'undefined') {
         payload['passwordSaltSeparator'] = passwordSaltSeparator;
     }
-
-
     if (typeof passwordSignerKey !== 'undefined') {
         payload['passwordSignerKey'] = passwordSignerKey;
     }
-
-
     if (typeof name !== 'undefined') {
         payload['name'] = name;
     }
 
     let response = undefined;
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} UsersCreateSHAUserRequestParams
+ * @property {string} userId User ID. Choose a custom ID or generate a random ID with 'ID.unique()'. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
+ * @property {string} email User email.
+ * @property {string} password User password hashed using SHA.
+ * @property {string} passwordVersion Optional SHA version used to hash password. Allowed values are: 'sha1', 'sha224', 'sha256', 'sha384', 'sha512/224', 'sha512/256', 'sha512', 'sha3-224', 'sha3-256', 'sha3-384', 'sha3-512'
+ * @property {string} name User name. Max length: 128 chars.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {UsersCreateSHAUserRequestParams} params
+ */
 const usersCreateSHAUser = async ({ userId, email, password, passwordVersion, name, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} userId */
-    /* @param {string} email */
-    /* @param {string} password */
-    /* @param {string} passwordVersion */
-    /* @param {string} name */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/users/sha';
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof userId !== 'undefined') {
         payload['userId'] = userId;
     }
-
-
     if (typeof email !== 'undefined') {
         payload['email'] = email;
     }
-
-
     if (typeof password !== 'undefined') {
         payload['password'] = password;
     }
-
-
     if (typeof passwordVersion !== 'undefined') {
         payload['passwordVersion'] = passwordVersion;
     }
-
-
     if (typeof name !== 'undefined') {
         payload['name'] = name;
     }
 
     let response = undefined;
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} UsersGetUsageRequestParams
+ * @property {string} range Date range.
+ * @property {string} provider Provider Name.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {UsersGetUsageRequestParams} params
+ */
 const usersGetUsage = async ({ range, provider, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} range */
-    /* @param {string} provider */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/users/usage';
     let payload = {};
-
-    /** Query Params */
     if (typeof range !== 'undefined') {
         payload['range'] = range;
     }
     if (typeof provider !== 'undefined') {
         payload['provider'] = provider;
     }
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const usersGet = async ({ userId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} userId */
+/**
+ * @typedef {Object} UsersGetRequestParams
+ * @property {string} userId User ID.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {UsersGetRequestParams} params
+ */
+const usersGet = async ({ userId, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/users/{userId}'.replace('{userId}', userId);
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const usersDelete = async ({ userId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} userId */
+/**
+ * @typedef {Object} UsersDeleteRequestParams
+ * @property {string} userId User ID.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {UsersDeleteRequestParams} params
+ */
+const usersDelete = async ({ userId, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/users/{userId}'.replace('{userId}', userId);
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('delete', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} UsersUpdateEmailRequestParams
+ * @property {string} userId User ID.
+ * @property {string} email User email.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {UsersUpdateEmailRequestParams} params
+ */
 const usersUpdateEmail = async ({ userId, email, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} userId */
-    /* @param {string} email */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/users/{userId}/email'.replace('{userId}', userId);
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof email !== 'undefined') {
         payload['email'] = email;
     }
 
     let response = undefined;
+
     response = await client.call('patch', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} UsersUpdateLabelsRequestParams
+ * @property {string} userId User ID.
+ * @property {string[]} labels Array of user labels. Replaces the previous labels. Maximum of 100 labels are allowed, each up to 36 alphanumeric characters long.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {UsersUpdateLabelsRequestParams} params
+ */
 const usersUpdateLabels = async ({ userId, labels, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} userId */
-    /* @param {string[]} labels */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/users/{userId}/labels'.replace('{userId}', userId);
     let payload = {};
-    
-    /** Body Params */
     labels = labels === true ? [] : labels;
-
     if (typeof labels !== 'undefined') {
         payload['labels'] = labels;
     }
 
     let response = undefined;
+
     response = await client.call('put', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} UsersListLogsRequestParams
+ * @property {string} userId User ID.
+ * @property {string[]} queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {UsersListLogsRequestParams} params
+ */
 const usersListLogs = async ({ userId, queries, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} userId */
-    /* @param {string[]} queries */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/users/{userId}/logs'.replace('{userId}', userId);
     let payload = {};
-
-    /** Query Params */
     if (typeof queries !== 'undefined') {
         payload['queries'] = queries;
     }
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const usersListMemberships = async ({ userId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} userId */
+/**
+ * @typedef {Object} UsersListMembershipsRequestParams
+ * @property {string} userId User ID.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {UsersListMembershipsRequestParams} params
+ */
+const usersListMemberships = async ({ userId, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/users/{userId}/memberships'.replace('{userId}', userId);
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} UsersUpdateNameRequestParams
+ * @property {string} userId User ID.
+ * @property {string} name User name. Max length: 128 chars.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {UsersUpdateNameRequestParams} params
+ */
 const usersUpdateName = async ({ userId, name, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} userId */
-    /* @param {string} name */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/users/{userId}/name'.replace('{userId}', userId);
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof name !== 'undefined') {
         payload['name'] = name;
     }
 
     let response = undefined;
+
     response = await client.call('patch', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} UsersUpdatePasswordRequestParams
+ * @property {string} userId User ID.
+ * @property {string} password New user password. Must be at least 8 chars.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {UsersUpdatePasswordRequestParams} params
+ */
 const usersUpdatePassword = async ({ userId, password, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} userId */
-    /* @param {string} password */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/users/{userId}/password'.replace('{userId}', userId);
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof password !== 'undefined') {
         payload['password'] = password;
     }
 
     let response = undefined;
+
     response = await client.call('patch', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} UsersUpdatePhoneRequestParams
+ * @property {string} userId User ID.
+ * @property {string} number User phone number.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {UsersUpdatePhoneRequestParams} params
+ */
 const usersUpdatePhone = async ({ userId, number, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} userId */
-    /* @param {string} number */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/users/{userId}/phone'.replace('{userId}', userId);
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof number !== 'undefined') {
         payload['number'] = number;
     }
 
     let response = undefined;
+
     response = await client.call('patch', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const usersGetPrefs = async ({ userId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} userId */
+/**
+ * @typedef {Object} UsersGetPrefsRequestParams
+ * @property {string} userId User ID.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {UsersGetPrefsRequestParams} params
+ */
+const usersGetPrefs = async ({ userId, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/users/{userId}/prefs'.replace('{userId}', userId);
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} UsersUpdatePrefsRequestParams
+ * @property {string} userId User ID.
+ * @property {object} prefs Prefs key-value JSON object.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {UsersUpdatePrefsRequestParams} params
+ */
 const usersUpdatePrefs = async ({ userId, prefs, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} userId */
-    /* @param {object} prefs */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/users/{userId}/prefs'.replace('{userId}', userId);
     let payload = {};
-    
-    /** Body Params */
     if (typeof prefs !== 'undefined') {
         payload['prefs'] = JSON.parse(prefs);
     }
 
     let response = undefined;
+
     response = await client.call('patch', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const usersListSessions = async ({ userId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} userId */
+/**
+ * @typedef {Object} UsersListSessionsRequestParams
+ * @property {string} userId User ID.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {UsersListSessionsRequestParams} params
+ */
+const usersListSessions = async ({ userId, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/users/{userId}/sessions'.replace('{userId}', userId);
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const usersDeleteSessions = async ({ userId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} userId */
+/**
+ * @typedef {Object} UsersDeleteSessionsRequestParams
+ * @property {string} userId User ID.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {UsersDeleteSessionsRequestParams} params
+ */
+const usersDeleteSessions = async ({ userId, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/users/{userId}/sessions'.replace('{userId}', userId);
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('delete', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} UsersDeleteSessionRequestParams
+ * @property {string} userId User ID.
+ * @property {string} sessionId Session ID.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {UsersDeleteSessionRequestParams} params
+ */
 const usersDeleteSession = async ({ userId, sessionId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} userId */
-    /* @param {string} sessionId */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/users/{userId}/sessions/{sessionId}'.replace('{userId}', userId).replace('{sessionId}', sessionId);
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('delete', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} UsersUpdateStatusRequestParams
+ * @property {string} userId User ID.
+ * @property {boolean} status User Status. To activate the user pass 'true' and to block the user pass 'false'.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {UsersUpdateStatusRequestParams} params
+ */
 const usersUpdateStatus = async ({ userId, status, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} userId */
-    /* @param {boolean} status */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/users/{userId}/status'.replace('{userId}', userId);
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof status !== 'undefined') {
         payload['status'] = status;
     }
 
     let response = undefined;
+
     response = await client.call('patch', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} UsersUpdateEmailVerificationRequestParams
+ * @property {string} userId User ID.
+ * @property {boolean} emailVerification User email verification status.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {UsersUpdateEmailVerificationRequestParams} params
+ */
 const usersUpdateEmailVerification = async ({ userId, emailVerification, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} userId */
-    /* @param {boolean} emailVerification */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/users/{userId}/verification'.replace('{userId}', userId);
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof emailVerification !== 'undefined') {
         payload['emailVerification'] = emailVerification;
     }
 
     let response = undefined;
+
     response = await client.call('patch', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} UsersUpdatePhoneVerificationRequestParams
+ * @property {string} userId User ID.
+ * @property {boolean} phoneVerification User phone verification status.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {UsersUpdatePhoneVerificationRequestParams} params
+ */
 const usersUpdatePhoneVerification = async ({ userId, phoneVerification, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} userId */
-    /* @param {boolean} phoneVerification */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/users/{userId}/verification/phone'.replace('{userId}', userId);
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof phoneVerification !== 'undefined') {
         payload['phoneVerification'] = phoneVerification;
     }
 
     let response = undefined;
+
     response = await client.call('patch', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-
 users
     .command(`list`)
     .description(`Get a list of all the project's users. You can use the query params to filter your results.`)
@@ -1125,7 +1325,6 @@ users
     .requiredOption(`--phoneVerification <phoneVerification>`, `User phone verification status.`, parseBool)
     .action(actionRunner(usersUpdatePhoneVerification))
 
-
 module.exports = {
     users,
     usersList,
@@ -1157,4 +1356,4 @@ module.exports = {
     usersUpdateStatus,
     usersUpdateEmailVerification,
     usersUpdatePhoneVerification
-};
+};