appwrite-cli 0.17.1 → 0.18.3

package/lib/commands/account.js

@@ -194,6 +194,35 @@ const accountUpdatePassword = async ({ password, oldPassword, parseOutput = true
     return response;
 }
 
+const accountUpdatePhone = async ({ number, password, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} number */
+    /* @param {string} password */
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/account/phone';
+    let payload = {};
+    
+    /** Body Params */
+    if (typeof number !== 'undefined') {
+        payload['number'] = number;
+    }
+
+    if (typeof password !== 'undefined') {
+        payload['password'] = password;
+    }
+
+    let response = undefined;
+    response = await client.call('patch', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
 const accountGetPrefs = async ({ parseOutput = true, sdk = undefined}) => {
 
     let client = !sdk ? await sdkForProject() : sdk;
@@ -320,25 +349,13 @@ const accountGetSessions = async ({ parseOutput = true, sdk = undefined}) => {
     return response;
 }
 
-const accountCreateSession = async ({ email, password, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} email */
-    /* @param {string} password */
+const accountDeleteSessions = async ({ parseOutput = true, sdk = undefined}) => {
 
     let client = !sdk ? await sdkForProject() : sdk;
     let path = '/account/sessions';
     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', path, {
+    response = await client.call('delete', path, {
         'content-type': 'application/json',
     }, payload);
     
@@ -349,13 +366,13 @@ const accountCreateSession = async ({ email, password, parseOutput = true, sdk =
     return response;
 }
 
-const accountDeleteSessions = async ({ parseOutput = true, sdk = undefined}) => {
+const accountCreateAnonymousSession = async ({ parseOutput = true, sdk = undefined}) => {
 
     let client = !sdk ? await sdkForProject() : sdk;
-    let path = '/account/sessions';
+    let path = '/account/sessions/anonymous';
     let payload = {};
     let response = undefined;
-    response = await client.call('delete', path, {
+    response = await client.call('post', path, {
         'content-type': 'application/json',
     }, payload);
     
@@ -366,11 +383,23 @@ const accountDeleteSessions = async ({ parseOutput = true, sdk = undefined}) =>
     return response;
 }
 
-const accountCreateAnonymousSession = async ({ parseOutput = true, sdk = undefined}) => {
+const accountCreateEmailSession = async ({ email, password, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} email */
+    /* @param {string} password */
 
     let client = !sdk ? await sdkForProject() : sdk;
-    let path = '/account/sessions/anonymous';
+    let path = '/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', path, {
         'content-type': 'application/json',
@@ -478,6 +507,64 @@ const accountCreateOAuth2Session = async ({ provider, success, failure, scopes,
     return response;
 }
 
+const accountCreatePhoneSession = async ({ userId, number, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} userId */
+    /* @param {string} number */
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/account/sessions/phone';
+    let payload = {};
+    
+    /** Body Params */
+    if (typeof userId !== 'undefined') {
+        payload['userId'] = userId;
+    }
+
+    if (typeof number !== 'undefined') {
+        payload['number'] = number;
+    }
+
+    let response = undefined;
+    response = await client.call('post', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const accountUpdatePhoneSession = async ({ userId, secret, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} userId */
+    /* @param {string} secret */
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/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', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
 const accountGetSession = async ({ sessionId, parseOutput = true, sdk = undefined}) => {
     /* @param {string} sessionId */
 
@@ -602,6 +689,52 @@ const accountUpdateVerification = async ({ userId, secret, parseOutput = true, s
     return response;
 }
 
+const accountCreatePhoneVerification = async ({ parseOutput = true, sdk = undefined}) => {
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/account/verification/phone';
+    let payload = {};
+    let response = undefined;
+    response = await client.call('post', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const accountUpdatePhoneVerification = async ({ userId, secret, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} userId */
+    /* @param {string} secret */
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/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', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
 
 account
     .command(`get`)
@@ -649,6 +782,13 @@ account
     .option(`--oldPassword <oldPassword>`, `Current user password. Must be at least 8 chars.`)
     .action(actionRunner(accountUpdatePassword))
 
+account
+    .command(`updatePhone`)
+    .description(`Update the currently logged in user's phone number. After updating the phone number, the phone verification status will be reset. A confirmation SMS is not sent automatically, however you can use the [POST /account/verification/phone](/docs/client/account#accountCreatePhoneVerification) endpoint to send a confirmation SMS.`)
+    .requiredOption(`--number <number>`, `Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.`)
+    .requiredOption(`--password <password>`, `User password. Must be at least 8 chars.`)
+    .action(actionRunner(accountUpdatePhone))
+
 account
     .command(`getPrefs`)
     .description(`Get currently logged in user preferences as a key-value object.`)
@@ -681,13 +821,6 @@ account
     .description(`Get currently logged in user list of active sessions across different devices.`)
     .action(actionRunner(accountGetSessions))
 
-account
-    .command(`createSession`)
-    .description(`Allow the user to login into their account by providing a valid email and password combination. This route will create a new session for the user.`)
-    .requiredOption(`--email <email>`, `User email.`)
-    .requiredOption(`--password <password>`, `User password. Must be at least 8 chars.`)
-    .action(actionRunner(accountCreateSession))
-
 account
     .command(`deleteSessions`)
     .description(`Delete all sessions from the user account and remove any sessions cookies from the end client.`)
@@ -698,6 +831,13 @@ account
     .description(`Use this endpoint to allow a new user to register an anonymous account in your project. This route will also create a new session for the user. To allow the new user to convert an anonymous account to a normal account, you need to update its [email and password](/docs/client/account#accountUpdateEmail) or create an [OAuth2 session](/docs/client/account#accountCreateOAuth2Session).`)
     .action(actionRunner(accountCreateAnonymousSession))
 
+account
+    .command(`createEmailSession`)
+    .description(`Allow the user to login into their account by providing a valid email and password combination. This route will create a new session for the user.`)
+    .requiredOption(`--email <email>`, `User email.`)
+    .requiredOption(`--password <password>`, `User password. Must be at least 8 chars.`)
+    .action(actionRunner(accountCreateEmailSession))
+
 account
     .command(`createMagicURLSession`)
     .description(`Sends the user an email with a secret key for creating a session. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [PUT /account/sessions/magic-url](/docs/client/account#accountUpdateMagicURLSession) endpoint to complete the login process. The link sent to the user's email address is valid for 1 hour. If you are on a mobile device you can leave the URL parameter empty, so that the login completion will be handled by your Appwrite instance by default.`)
@@ -716,12 +856,26 @@ account
 account
     .command(`createOAuth2Session`)
     .description(`Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed.  If there is already an active session, the new session will be attached to the logged-in account. If there are no active sessions, the server will attempt to look for a user with the same email address as the email received from the OAuth2 provider and attach the new session to the existing user. If no matching user is found - the server will create a new user.. `)
-    .requiredOption(`--provider <provider>`, `OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, bitbucket, bitly, box, discord, dropbox, facebook, github, gitlab, google, linkedin, microsoft, notion, okta, paypal, paypalSandbox, salesforce, slack, spotify, tradeshift, tradeshiftBox, twitch, zoom, yahoo, yammer, yandex, wordpress, stripe.`)
+    .requiredOption(`--provider <provider>`, `OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, autodesk, bitbucket, bitly, box, dailymotion, discord, dropbox, facebook, github, gitlab, google, linkedin, microsoft, notion, okta, paypal, paypalSandbox, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoom.`)
     .option(`--success <success>`, `URL to redirect back to your app after a successful login attempt.  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.`)
     .option(`--failure <failure>`, `URL to redirect back to your app after a failed login attempt.  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.`)
-    .option(`--scopes <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 128 characters long.`)
+    .option(`--scopes <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.`)
     .action(actionRunner(accountCreateOAuth2Session))
 
+account
+    .command(`createPhoneSession`)
+    .description(`Sends the user an SMS with a secret key for creating a session. Use the returned user ID and secret and submit a request to the [PUT /account/sessions/phone](/docs/client/account#accountUpdatePhoneSession) endpoint to complete the login process. The secret sent to the user's phone is valid for 15 minutes.`)
+    .requiredOption(`--userId <userId>`, `Unique Id. Choose your own unique ID or pass the string "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.`)
+    .requiredOption(`--number <number>`, `Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.`)
+    .action(actionRunner(accountCreatePhoneSession))
+
+account
+    .command(`updatePhoneSession`)
+    .description(`Use this endpoint to complete creating a session with SMS. Use the **userId** from the [createPhoneSession](/docs/client/account#accountCreatePhoneSession) endpoint and the **secret** received via SMS to successfully update and confirm the phone session.`)
+    .requiredOption(`--userId <userId>`, `User ID.`)
+    .requiredOption(`--secret <secret>`, `Valid verification token.`)
+    .action(actionRunner(accountUpdatePhoneSession))
+
 account
     .command(`getSession`)
     .description(`Use this endpoint to get a logged in user's session using a Session ID. Inputting 'current' will return the current session being used.`)
@@ -747,7 +901,7 @@ account
 
 account
     .command(`createVerification`)
-    .description(`Use this endpoint to send a verification message to your user email address to confirm they are the valid owners of that address. Both the **userId** and **secret** arguments will be passed as query parameters to the URL you have provided to be attached to the verification email. The provided URL should redirect the user back to your app and allow you to complete the verification process by verifying both the **userId** and **secret** parameters. Learn more about how to [complete the verification process](/docs/client/account#accountUpdateVerification). The verification link sent to the user's email address is valid for 7 days.  Please note that in order to avoid a [Redirect Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md), the only valid redirect URLs are the ones from domains you have set when adding your platforms in the console interface. `)
+    .description(`Use this endpoint to send a verification message to your user email address to confirm they are the valid owners of that address. Both the **userId** and **secret** arguments will be passed as query parameters to the URL you have provided to be attached to the verification email. The provided URL should redirect the user back to your app and allow you to complete the verification process by verifying both the **userId** and **secret** parameters. Learn more about how to [complete the verification process](/docs/client/account#accountUpdateEmailVerification). The verification link sent to the user's email address is valid for 7 days.  Please note that in order to avoid a [Redirect Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md), the only valid redirect URLs are the ones from domains you have set when adding your platforms in the console interface. `)
     .requiredOption(`--url <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.`)
     .action(actionRunner(accountCreateVerification))
 
@@ -758,6 +912,18 @@ account
     .requiredOption(`--secret <secret>`, `Valid verification token.`)
     .action(actionRunner(accountUpdateVerification))
 
+account
+    .command(`createPhoneVerification`)
+    .description(`Use this endpoint to send a verification SMS to the currently logged in user. This endpoint is meant for use after updating a user's phone number using the [accountUpdatePhone](/docs/client/account#accountUpdatePhone) endpoint. Learn more about how to [complete the verification process](/docs/client/account#accountUpdatePhoneVerification). The verification code sent to the user's phone number is valid for 15 minutes.`)
+    .action(actionRunner(accountCreatePhoneVerification))
+
+account
+    .command(`updatePhoneVerification`)
+    .description(`Use this endpoint to complete the user phone verification process. Use the **userId** and **secret** that were sent to your user's phone number to verify the user email ownership. If confirmed this route will return a 200 status code.`)
+    .requiredOption(`--userId <userId>`, `User ID.`)
+    .requiredOption(`--secret <secret>`, `Valid verification token.`)
+    .action(actionRunner(accountUpdatePhoneVerification))
+
 
 module.exports = {
     account,
@@ -768,21 +934,26 @@ module.exports = {
     accountGetLogs,
     accountUpdateName,
     accountUpdatePassword,
+    accountUpdatePhone,
     accountGetPrefs,
     accountUpdatePrefs,
     accountCreateRecovery,
     accountUpdateRecovery,
     accountGetSessions,
-    accountCreateSession,
     accountDeleteSessions,
     accountCreateAnonymousSession,
+    accountCreateEmailSession,
     accountCreateMagicURLSession,
     accountUpdateMagicURLSession,
     accountCreateOAuth2Session,
+    accountCreatePhoneSession,
+    accountUpdatePhoneSession,
     accountGetSession,
     accountUpdateSession,
     accountDeleteSession,
     accountUpdateStatus,
     accountCreateVerification,
-    accountUpdateVerification
+    accountUpdateVerification,
+    accountCreatePhoneVerification,
+    accountUpdatePhoneVerification
 };