appwrite-cli 4.2.0 → 4.2.2

package/lib/commands/account.js

@@ -9,546 +9,722 @@ 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 account = new Command("account").description(commandDescriptions['account']).configureHelp({
     helpWidth: process.stdout.columns || 80
-  })
+})
 
-const accountGet = async ({ parseOutput = true, sdk = undefined}) => {
+/**
+ * @typedef {Object} AccountGetRequestParams
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {AccountGetRequestParams} params
+ */
+const accountGet = async ({ parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/account';
     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} AccountCreateRequestParams
+ * @property {string} userId Unique 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 New 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 {AccountCreateRequestParams} params
+ */
 const accountCreate = 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 = '/account';
     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} AccountUpdateEmailRequestParams
+ * @property {string} email User email.
+ * @property {string} password User password. Must be at least 8 chars.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {AccountUpdateEmailRequestParams} params
+ */
 const accountUpdateEmail = async ({ email, password, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} email */
-    /* @param {string} password */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/account/email';
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof email !== 'undefined') {
         payload['email'] = email;
     }
-
-
     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;
 }
 
-const accountListIdentities = async ({ queries, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} queries */
+/**
+ * @typedef {Object} AccountListIdentitiesRequestParams
+ * @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 {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {AccountListIdentitiesRequestParams} params
+ */
+const accountListIdentities = async ({ queries, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/account/identities';
     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 accountDeleteIdentity = async ({ identityId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} identityId */
+/**
+ * @typedef {Object} AccountDeleteIdentityRequestParams
+ * @property {string} identityId Identity ID.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {AccountDeleteIdentityRequestParams} params
+ */
+const accountDeleteIdentity = async ({ identityId, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/account/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;
 }
 
-const accountCreateJWT = async ({ parseOutput = true, sdk = undefined}) => {
+/**
+ * @typedef {Object} AccountCreateJWTRequestParams
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {AccountCreateJWTRequestParams} params
+ */
+const accountCreateJWT = async ({ parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/account/jwt';
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const accountListLogs = async ({ queries, parseOutput = true, sdk = undefined}) => {
-    /* @param {string[]} queries */
+/**
+ * @typedef {Object} AccountListLogsRequestParams
+ * @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 {AccountListLogsRequestParams} params
+ */
+const accountListLogs = async ({ queries, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/account/logs';
     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 accountUpdateName = async ({ name, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} name */
+/**
+ * @typedef {Object} AccountUpdateNameRequestParams
+ * @property {string} name User name. Max length: 128 chars.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {AccountUpdateNameRequestParams} params
+ */
+const accountUpdateName = async ({ name, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/account/name';
     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} AccountUpdatePasswordRequestParams
+ * @property {string} password New user password. Must be at least 8 chars.
+ * @property {string} oldPassword Current user password. Must be at least 8 chars.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {AccountUpdatePasswordRequestParams} params
+ */
 const accountUpdatePassword = async ({ password, oldPassword, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} password */
-    /* @param {string} oldPassword */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/account/password';
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof password !== 'undefined') {
         payload['password'] = password;
     }
-
-
     if (typeof oldPassword !== 'undefined') {
         payload['oldPassword'] = oldPassword;
     }
 
     let response = undefined;
+
     response = await client.call('patch', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} AccountUpdatePhoneRequestParams
+ * @property {string} phone Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
+ * @property {string} password User password. Must be at least 8 chars.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {AccountUpdatePhoneRequestParams} params
+ */
 const accountUpdatePhone = async ({ phone, password, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} phone */
-    /* @param {string} password */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/account/phone';
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof phone !== 'undefined') {
         payload['phone'] = phone;
     }
-
-
     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;
 }
 
-const accountGetPrefs = async ({ parseOutput = true, sdk = undefined}) => {
+/**
+ * @typedef {Object} AccountGetPrefsRequestParams
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {AccountGetPrefsRequestParams} params
+ */
+const accountGetPrefs = async ({ parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/account/prefs';
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const accountUpdatePrefs = async ({ prefs, parseOutput = true, sdk = undefined}) => {
-    /* @param {object} prefs */
+/**
+ * @typedef {Object} AccountUpdatePrefsRequestParams
+ * @property {object} prefs Prefs key-value JSON object.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {AccountUpdatePrefsRequestParams} params
+ */
+const accountUpdatePrefs = async ({ prefs, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/account/prefs';
     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;
 }
 
+/**
+ * @typedef {Object} AccountCreateRecoveryRequestParams
+ * @property {string} email User email.
+ * @property {string} url URL to redirect the user back to your app from the recovery email. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {AccountCreateRecoveryRequestParams} params
+ */
 const accountCreateRecovery = async ({ email, url, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} email */
-    /* @param {string} url */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/account/recovery';
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof email !== 'undefined') {
         payload['email'] = email;
     }
-
-
     if (typeof url !== 'undefined') {
         payload['url'] = url;
     }
 
     let response = undefined;
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} AccountUpdateRecoveryRequestParams
+ * @property {string} userId User ID.
+ * @property {string} secret Valid reset token.
+ * @property {string} password New user password. Must be at least 8 chars.
+ * @property {string} passwordAgain Repeat new user password. Must be at least 8 chars.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {AccountUpdateRecoveryRequestParams} params
+ */
 const accountUpdateRecovery = async ({ userId, secret, password, passwordAgain, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} userId */
-    /* @param {string} secret */
-    /* @param {string} password */
-    /* @param {string} passwordAgain */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/account/recovery';
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof userId !== 'undefined') {
         payload['userId'] = userId;
     }
-
-
     if (typeof secret !== 'undefined') {
         payload['secret'] = secret;
     }
-
-
     if (typeof password !== 'undefined') {
         payload['password'] = password;
     }
-
-
     if (typeof passwordAgain !== 'undefined') {
         payload['passwordAgain'] = passwordAgain;
     }
 
     let response = undefined;
+
     response = await client.call('put', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const accountListSessions = async ({ parseOutput = true, sdk = undefined}) => {
+/**
+ * @typedef {Object} AccountListSessionsRequestParams
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {AccountListSessionsRequestParams} params
+ */
+const accountListSessions = async ({ parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/account/sessions';
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const accountDeleteSessions = async ({ parseOutput = true, sdk = undefined}) => {
+/**
+ * @typedef {Object} AccountDeleteSessionsRequestParams
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {AccountDeleteSessionsRequestParams} params
+ */
+const accountDeleteSessions = async ({ parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/account/sessions';
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('delete', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const accountCreateAnonymousSession = async ({ parseOutput = true, sdk = undefined}) => {
+/**
+ * @typedef {Object} AccountCreateAnonymousSessionRequestParams
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {AccountCreateAnonymousSessionRequestParams} params
+ */
+const accountCreateAnonymousSession = async ({ parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/account/sessions/anonymous';
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} AccountCreateEmailSessionRequestParams
+ * @property {string} email User email.
+ * @property {string} password User password. Must be at least 8 chars.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {AccountCreateEmailSessionRequestParams} params
+ */
 const accountCreateEmailSession = async ({ email, password, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} email */
-    /* @param {string} password */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/account/sessions/email';
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof email !== 'undefined') {
         payload['email'] = email;
     }
-
-
     if (typeof password !== 'undefined') {
         payload['password'] = password;
     }
 
     let response = undefined;
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} AccountCreateMagicURLSessionRequestParams
+ * @property {string} userId Unique 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} url URL to redirect the user back to your app from the magic URL login. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {AccountCreateMagicURLSessionRequestParams} params
+ */
 const accountCreateMagicURLSession = async ({ userId, email, url, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} userId */
-    /* @param {string} email */
-    /* @param {string} url */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/account/sessions/magic-url';
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof userId !== 'undefined') {
         payload['userId'] = userId;
     }
-
-
     if (typeof email !== 'undefined') {
         payload['email'] = email;
     }
-
-
     if (typeof url !== 'undefined') {
         payload['url'] = url;
     }
 
     let response = undefined;
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} AccountUpdateMagicURLSessionRequestParams
+ * @property {string} userId User ID.
+ * @property {string} secret Valid verification token.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {AccountUpdateMagicURLSessionRequestParams} params
+ */
 const accountUpdateMagicURLSession = async ({ userId, secret, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} userId */
-    /* @param {string} secret */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/account/sessions/magic-url';
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof userId !== 'undefined') {
         payload['userId'] = userId;
     }
-
-
     if (typeof secret !== 'undefined') {
         payload['secret'] = secret;
     }
 
     let response = undefined;
+
     response = await client.call('put', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} AccountCreateOAuth2SessionRequestParams
+ * @property {string} provider OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoom.
+ * @property {string} success URL to redirect back to your app after a successful login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
+ * @property {string} failure URL to redirect back to your app after a failed login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
+ * @property {string[]} scopes A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {AccountCreateOAuth2SessionRequestParams} params
+ */
 const accountCreateOAuth2Session = async ({ provider, success, failure, scopes, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} provider */
-    /* @param {string} success */
-    /* @param {string} failure */
-    /* @param {string[]} scopes */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/account/sessions/oauth2/{provider}'.replace('{provider}', provider);
     let payload = {};
-
-    /** Query Params */
     if (typeof success !== 'undefined') {
         payload['success'] = success;
     }
@@ -558,256 +734,340 @@ const accountCreateOAuth2Session = async ({ provider, success, failure, scopes,
     if (typeof scopes !== 'undefined') {
         payload['scopes'] = scopes;
     }
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} AccountCreatePhoneSessionRequestParams
+ * @property {string} userId Unique 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} phone Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {AccountCreatePhoneSessionRequestParams} params
+ */
 const accountCreatePhoneSession = async ({ userId, phone, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} userId */
-    /* @param {string} phone */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/account/sessions/phone';
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof userId !== 'undefined') {
         payload['userId'] = userId;
     }
-
-
     if (typeof phone !== 'undefined') {
         payload['phone'] = phone;
     }
 
     let response = undefined;
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} AccountUpdatePhoneSessionRequestParams
+ * @property {string} userId User ID.
+ * @property {string} secret Valid verification token.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {AccountUpdatePhoneSessionRequestParams} params
+ */
 const accountUpdatePhoneSession = async ({ userId, secret, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} userId */
-    /* @param {string} secret */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/account/sessions/phone';
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof userId !== 'undefined') {
         payload['userId'] = userId;
     }
-
-
     if (typeof secret !== 'undefined') {
         payload['secret'] = secret;
     }
 
     let response = undefined;
+
     response = await client.call('put', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const accountGetSession = async ({ sessionId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} sessionId */
+/**
+ * @typedef {Object} AccountGetSessionRequestParams
+ * @property {string} sessionId Session ID. Use the string 'current' to get the current device session.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {AccountGetSessionRequestParams} params
+ */
+const accountGetSession = async ({ sessionId, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/account/sessions/{sessionId}'.replace('{sessionId}', sessionId);
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const accountUpdateSession = async ({ sessionId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} sessionId */
+/**
+ * @typedef {Object} AccountUpdateSessionRequestParams
+ * @property {string} sessionId Session ID. Use the string 'current' to update the current device session.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {AccountUpdateSessionRequestParams} params
+ */
+const accountUpdateSession = async ({ sessionId, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/account/sessions/{sessionId}'.replace('{sessionId}', sessionId);
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('patch', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const accountDeleteSession = async ({ sessionId, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} sessionId */
+/**
+ * @typedef {Object} AccountDeleteSessionRequestParams
+ * @property {string} sessionId Session ID. Use the string 'current' to delete the current device session.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {AccountDeleteSessionRequestParams} params
+ */
+const accountDeleteSession = async ({ sessionId, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/account/sessions/{sessionId}'.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;
 }
 
-const accountUpdateStatus = async ({ parseOutput = true, sdk = undefined}) => {
+/**
+ * @typedef {Object} AccountUpdateStatusRequestParams
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {AccountUpdateStatusRequestParams} params
+ */
+const accountUpdateStatus = async ({ parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/account/status';
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('patch', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const accountCreateVerification = async ({ url, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} url */
+/**
+ * @typedef {Object} AccountCreateVerificationRequestParams
+ * @property {string} url URL to redirect the user back to your app from the verification email. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {AccountCreateVerificationRequestParams} params
+ */
+const accountCreateVerification = async ({ url, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/account/verification';
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof url !== 'undefined') {
         payload['url'] = url;
     }
 
     let response = undefined;
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} AccountUpdateVerificationRequestParams
+ * @property {string} userId User ID.
+ * @property {string} secret Valid verification token.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {AccountUpdateVerificationRequestParams} params
+ */
 const accountUpdateVerification = async ({ userId, secret, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} userId */
-    /* @param {string} secret */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/account/verification';
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof userId !== 'undefined') {
         payload['userId'] = userId;
     }
-
-
     if (typeof secret !== 'undefined') {
         payload['secret'] = secret;
     }
 
     let response = undefined;
+
     response = await client.call('put', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-const accountCreatePhoneVerification = async ({ parseOutput = true, sdk = undefined}) => {
+/**
+ * @typedef {Object} AccountCreatePhoneVerificationRequestParams
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {AccountCreatePhoneVerificationRequestParams} params
+ */
+const accountCreatePhoneVerification = async ({ parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/account/verification/phone';
     let payload = {};
+
     let response = undefined;
+
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
+/**
+ * @typedef {Object} AccountUpdatePhoneVerificationRequestParams
+ * @property {string} userId User ID.
+ * @property {string} secret Valid verification token.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {AccountUpdatePhoneVerificationRequestParams} params
+ */
 const accountUpdatePhoneVerification = async ({ userId, secret, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} userId */
-    /* @param {string} secret */
-
     let client = !sdk ? await sdkForProject() : sdk;
     let apiPath = '/account/verification/phone';
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof userId !== 'undefined') {
         payload['userId'] = userId;
     }
-
-
     if (typeof secret !== 'undefined') {
         payload['secret'] = secret;
     }
 
     let response = undefined;
+
     response = await client.call('put', apiPath, {
         'content-type': 'application/json',
     }, payload);
-    
+
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
-
 account
     .command(`get`)
     .description(`Get the currently logged in user.`)
@@ -1007,7 +1267,6 @@ account
     .requiredOption(`--secret <secret>`, `Valid verification token.`)
     .action(actionRunner(accountUpdatePhoneVerification))
 
-
 module.exports = {
     account,
     accountGet,
@@ -1041,4 +1300,4 @@ module.exports = {
     accountUpdateVerification,
     accountCreatePhoneVerification,
     accountUpdatePhoneVerification
-};
+};