appwrite-cli 0.18.5 → 1.0.0

package/lib/commands/account.js

@@ -114,20 +114,16 @@ const accountCreateJWT = async ({ parseOutput = true, sdk = undefined}) => {
     return response;
 }
 
-const accountGetLogs = async ({ limit, offset, parseOutput = true, sdk = undefined}) => {
-    /* @param {number} limit */
-    /* @param {number} offset */
+const accountListLogs = async ({ queries, parseOutput = true, sdk = undefined}) => {
+    /* @param {string[]} queries */
 
     let client = !sdk ? await sdkForProject() : sdk;
     let path = '/account/logs';
     let payload = {};
 
     /** Query Params */
-    if (typeof limit !== 'undefined') {
-        payload['limit'] = limit;
-    }
-    if (typeof offset !== 'undefined') {
-        payload['offset'] = offset;
+    if (typeof queries !== 'undefined') {
+        payload['queries'] = queries;
     }
     let response = undefined;
     response = await client.call('get', path, {
@@ -194,8 +190,8 @@ const accountUpdatePassword = async ({ password, oldPassword, parseOutput = true
     return response;
 }
 
-const accountUpdatePhone = async ({ number, password, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} number */
+const accountUpdatePhone = async ({ phone, password, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} phone */
     /* @param {string} password */
 
     let client = !sdk ? await sdkForProject() : sdk;
@@ -203,8 +199,8 @@ const accountUpdatePhone = async ({ number, password, parseOutput = true, sdk =
     let payload = {};
     
     /** Body Params */
-    if (typeof number !== 'undefined') {
-        payload['number'] = number;
+    if (typeof phone !== 'undefined') {
+        payload['phone'] = phone;
     }
 
     if (typeof password !== 'undefined') {
@@ -332,7 +328,7 @@ const accountUpdateRecovery = async ({ userId, secret, password, passwordAgain,
     return response;
 }
 
-const accountGetSessions = async ({ parseOutput = true, sdk = undefined}) => {
+const accountListSessions = async ({ parseOutput = true, sdk = undefined}) => {
 
     let client = !sdk ? await sdkForProject() : sdk;
     let path = '/account/sessions';
@@ -507,9 +503,9 @@ const accountCreateOAuth2Session = async ({ provider, success, failure, scopes,
     return response;
 }
 
-const accountCreatePhoneSession = async ({ userId, number, parseOutput = true, sdk = undefined}) => {
+const accountCreatePhoneSession = async ({ userId, phone, parseOutput = true, sdk = undefined}) => {
     /* @param {string} userId */
-    /* @param {string} number */
+    /* @param {string} phone */
 
     let client = !sdk ? await sdkForProject() : sdk;
     let path = '/account/sessions/phone';
@@ -520,8 +516,8 @@ const accountCreatePhoneSession = async ({ userId, number, parseOutput = true, s
         payload['userId'] = userId;
     }
 
-    if (typeof number !== 'undefined') {
-        payload['number'] = number;
+    if (typeof phone !== 'undefined') {
+        payload['phone'] = phone;
     }
 
     let response = undefined;
@@ -763,11 +759,10 @@ account
     .action(actionRunner(accountCreateJWT))
 
 account
-    .command(`getLogs`)
+    .command(`listLogs`)
     .description(`Get currently logged in user list of latest security activity logs. Each log returns user IP address, location and date and time of log.`)
-    .option(`--limit <limit>`, `Maximum number of logs to return in response. By default will return maximum 25 results. Maximum of 100 results allowed per request.`, parseInteger)
-    .option(`--offset <offset>`, `Offset value. The default value is 0. Use this value to manage pagination. [learn more about pagination](https://appwrite.io/docs/pagination)`, parseInteger)
-    .action(actionRunner(accountGetLogs))
+    .option(`--queries <queries...>`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Only supported methods are limit and offset`)
+    .action(actionRunner(accountListLogs))
 
 account
     .command(`updateName`)
@@ -785,7 +780,7 @@ account
 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(`--phone <phone>`, `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))
 
@@ -817,9 +812,9 @@ account
     .action(actionRunner(accountUpdateRecovery))
 
 account
-    .command(`getSessions`)
+    .command(`listSessions`)
     .description(`Get currently logged in user list of active sessions across different devices.`)
-    .action(actionRunner(accountGetSessions))
+    .action(actionRunner(accountListSessions))
 
 account
     .command(`deleteSessions`)
@@ -840,7 +835,7 @@ account
 
 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.`)
+    .description(`Sends the user an email with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. 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.`)
     .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(`--email <email>`, `User email.`)
     .option(`--url <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.`)
@@ -856,7 +851,7 @@ 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, 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.`)
+    .requiredOption(`--provider <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, okta, paypal, paypalSandbox, podio, 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 4096 characters long.`)
@@ -866,7 +861,7 @@ account
     .command(`createPhoneSession`)
     .description(`Sends the user an SMS with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. 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.`)
+    .requiredOption(`--phone <phone>`, `Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.`)
     .action(actionRunner(accountCreatePhoneSession))
 
 account
@@ -931,7 +926,7 @@ module.exports = {
     accountCreate,
     accountUpdateEmail,
     accountCreateJWT,
-    accountGetLogs,
+    accountListLogs,
     accountUpdateName,
     accountUpdatePassword,
     accountUpdatePhone,
@@ -939,7 +934,7 @@ module.exports = {
     accountUpdatePrefs,
     accountCreateRecovery,
     accountUpdateRecovery,
-    accountGetSessions,
+    accountListSessions,
     accountDeleteSessions,
     accountCreateAnonymousSession,
     accountCreateEmailSession,

package/lib/commands/avatars.js

@@ -187,11 +187,10 @@ const avatarsGetImage = async ({ url, width, height, parseOutput = true, sdk = u
     }
 }
 
-const avatarsGetInitials = async ({ name, width, height, color, background, parseOutput = true, sdk = undefined, destination}) => {
+const avatarsGetInitials = async ({ name, width, height, background, parseOutput = true, sdk = undefined, destination}) => {
     /* @param {string} name */
     /* @param {number} width */
     /* @param {number} height */
-    /* @param {string} color */
     /* @param {string} background */
 
     let client = !sdk ? await sdkForProject() : sdk;
@@ -208,9 +207,6 @@ const avatarsGetInitials = async ({ name, width, height, color, background, pars
     if (typeof height !== 'undefined') {
         payload['height'] = height;
     }
-    if (typeof color !== 'undefined') {
-        payload['color'] = color;
-    }
     if (typeof background !== 'undefined') {
         payload['background'] = background;
     }
@@ -301,7 +297,7 @@ avatars
 
 avatars
     .command(`getFlag`)
-    .description(`You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings.  When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px. `)
+    .description(`You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) standard.  When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px. `)
     .requiredOption(`--code <code>`, `Country Code. ISO Alpha-2 country code format.`)
     .option(`--width <width>`, `Image width. Pass an integer between 0 to 2000. Defaults to 100.`, parseInteger)
     .option(`--height <height>`, `Image height. Pass an integer between 0 to 2000. Defaults to 100.`, parseInteger)
@@ -324,7 +320,6 @@ avatars
     .option(`--name <name>`, `Full Name. When empty, current user name or email will be used. Max length: 128 chars.`)
     .option(`--width <width>`, `Image width. Pass an integer between 0 to 2000. Defaults to 100.`, parseInteger)
     .option(`--height <height>`, `Image height. Pass an integer between 0 to 2000. Defaults to 100.`, parseInteger)
-    .option(`--color <color>`, `Changes text color. By default a random color will be picked and stay will persistent to the given name.`)
     .option(`--background <background>`, `Changes background color. By default a random color will be picked and stay will persistent to the given name.`)
     .requiredOption(`--destination <path>`, `output file path.`)
     .action(actionRunner(avatarsGetInitials))