appwrite-cli 1.2.1 → 2.0.0

package/lib/commands/teams.js

@@ -51,14 +51,18 @@ const teamsCreate = async ({ teamId, name, roles, parseOutput = true, sdk = unde
     let payload = {};
     
     /** Body Params */
+
     if (typeof teamId !== 'undefined') {
         payload['teamId'] = teamId;
     }
 
+
     if (typeof name !== 'undefined') {
         payload['name'] = name;
     }
 
+    roles = roles === true ? [] : roles;
+
     if (typeof roles !== 'undefined') {
         payload['roles'] = roles;
     }
@@ -93,7 +97,7 @@ const teamsGet = async ({ teamId, parseOutput = true, sdk = undefined}) => {
     return response;
 }
 
-const teamsUpdate = async ({ teamId, name, parseOutput = true, sdk = undefined}) => {
+const teamsUpdateName = async ({ teamId, name, parseOutput = true, sdk = undefined}) => {
     /* @param {string} teamId */
     /* @param {string} name */
 
@@ -102,6 +106,7 @@ const teamsUpdate = async ({ teamId, name, parseOutput = true, sdk = undefined})
     let payload = {};
     
     /** Body Params */
+
     if (typeof name !== 'undefined') {
         payload['name'] = name;
     }
@@ -188,11 +193,13 @@ const teamsListMemberships = async ({ teamId, queries, search, parseOutput = tru
     return response;
 }
 
-const teamsCreateMembership = async ({ teamId, email, roles, url, name, parseOutput = true, sdk = undefined}) => {
+const teamsCreateMembership = async ({ teamId, roles, url, email, userId, phone, name, parseOutput = true, sdk = undefined}) => {
     /* @param {string} teamId */
-    /* @param {string} email */
     /* @param {string[]} roles */
     /* @param {string} url */
+    /* @param {string} email */
+    /* @param {string} userId */
+    /* @param {string} phone */
     /* @param {string} name */
 
     let client = !sdk ? await sdkForProject() : sdk;
@@ -200,18 +207,33 @@ const teamsCreateMembership = async ({ teamId, email, roles, url, name, parseOut
     let payload = {};
     
     /** Body Params */
+
     if (typeof email !== 'undefined') {
         payload['email'] = email;
     }
 
+
+    if (typeof userId !== 'undefined') {
+        payload['userId'] = userId;
+    }
+
+
+    if (typeof phone !== 'undefined') {
+        payload['phone'] = phone;
+    }
+
+    roles = roles === true ? [] : roles;
+
     if (typeof roles !== 'undefined') {
         payload['roles'] = roles;
     }
 
+
     if (typeof url !== 'undefined') {
         payload['url'] = url;
     }
 
+
     if (typeof name !== 'undefined') {
         payload['name'] = name;
     }
@@ -257,6 +279,8 @@ const teamsUpdateMembershipRoles = async ({ teamId, membershipId, roles, parseOu
     let payload = {};
     
     /** Body Params */
+    roles = roles === true ? [] : roles;
+
     if (typeof roles !== 'undefined') {
         payload['roles'] = roles;
     }
@@ -303,10 +327,12 @@ const teamsUpdateMembershipStatus = async ({ teamId, membershipId, userId, secre
     let payload = {};
     
     /** Body Params */
+
     if (typeof userId !== 'undefined') {
         payload['userId'] = userId;
     }
 
+
     if (typeof secret !== 'undefined') {
         payload['secret'] = secret;
     }
@@ -323,11 +349,54 @@ const teamsUpdateMembershipStatus = async ({ teamId, membershipId, userId, secre
     return response;
 }
 
+const teamsGetPrefs = async ({ teamId, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} teamId */
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/teams/{teamId}/prefs'.replace('{teamId}', teamId);
+    let payload = {};
+    let response = undefined;
+    response = await client.call('get', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const teamsUpdatePrefs = async ({ teamId, prefs, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} teamId */
+    /* @param {object} prefs */
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/teams/{teamId}/prefs'.replace('{teamId}', teamId);
+    let payload = {};
+    
+    /** Body Params */
+    if (typeof prefs !== 'undefined') {
+        payload['prefs'] = JSON.parse(prefs);
+    }
+
+    let response = undefined;
+    response = await client.call('put', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
 
 teams
     .command(`list`)
     .description(`Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.`)
-    .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). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, total`)
+    .option(`--queries [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, total`)
     .option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
     .action(actionRunner(teamsList))
 
@@ -336,7 +405,7 @@ teams
     .description(`Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.`)
     .requiredOption(`--teamId <teamId>`, `Team 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.`)
     .requiredOption(`--name <name>`, `Team name. Max length: 128 chars.`)
-    .option(`--roles <roles...>`, `Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.`)
+    .option(`--roles [roles...]`, `Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.`)
     .action(actionRunner(teamsCreate))
 
 teams
@@ -346,11 +415,11 @@ teams
     .action(actionRunner(teamsGet))
 
 teams
-    .command(`update`)
-    .description(`Update a team using its ID. Only members with the owner role can update the team.`)
+    .command(`updateName`)
+    .description(`Update the team's name by its unique ID.`)
     .requiredOption(`--teamId <teamId>`, `Team ID.`)
     .requiredOption(`--name <name>`, `New team name. Max length: 128 chars.`)
-    .action(actionRunner(teamsUpdate))
+    .action(actionRunner(teamsUpdateName))
 
 teams
     .command(`delete`)
@@ -362,24 +431,26 @@ teams
     .command(`listLogs`)
     .description(`Get the team activity logs list by its unique ID.`)
     .requiredOption(`--teamId <teamId>`, `Team ID.`)
-    .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`)
+    .option(`--queries [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`)
     .action(actionRunner(teamsListLogs))
 
 teams
     .command(`listMemberships`)
     .description(`Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint.`)
     .requiredOption(`--teamId <teamId>`, `Team ID.`)
-    .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). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, teamId, invited, joined, confirm`)
+    .option(`--queries [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, teamId, invited, joined, confirm`)
     .option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
     .action(actionRunner(teamsListMemberships))
 
 teams
     .command(`createMembership`)
-    .description(`Invite a new member to join your team. If initiated from the client SDK, an email with a link to join the team will be sent to the member's email address and an account will be created for them should they not be signed up already. If initiated from server-side SDKs, the new member will automatically be added to the team.  Use the 'url' parameter to redirect the user from the invitation email back to your app. When the user is redirected, use the [Update Team Membership Status](/docs/client/teams#teamsUpdateMembershipStatus) endpoint to allow the user to accept the invitation to the team.   Please note that to avoid a [Redirect Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) the only valid redirect URL's are the once from domains you have set when adding your platforms in the console interface.`)
+    .description(`Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn't exist. If initiated from a Server SDK, the new member will be added automatically to the team.  You only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.  Use the 'url' parameter to redirect the user from the invitation email to your app. After the user is redirected, use the [Update Team Membership Status](/docs/client/teams#teamsUpdateMembershipStatus) endpoint to allow the user to accept the invitation to the team.   Please note that to avoid a [Redirect Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console. `)
     .requiredOption(`--teamId <teamId>`, `Team ID.`)
-    .requiredOption(`--email <email>`, `Email of the new team member.`)
-    .requiredOption(`--roles <roles...>`, `Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.`)
+    .requiredOption(`--roles [roles...]`, `Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.`)
     .requiredOption(`--url <url>`, `URL to redirect the user back to your app from the invitation 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.`)
+    .option(`--email <email>`, `Email of the new team member.`)
+    .option(`--userId <userId>`, `ID of the user to be added to a team.`)
+    .option(`--phone <phone>`, `Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.`)
     .option(`--name <name>`, `Name of the new team member. Max length: 128 chars.`)
     .action(actionRunner(teamsCreateMembership))
 
@@ -395,7 +466,7 @@ teams
     .description(`Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](/docs/permissions).`)
     .requiredOption(`--teamId <teamId>`, `Team ID.`)
     .requiredOption(`--membershipId <membershipId>`, `Membership ID.`)
-    .requiredOption(`--roles <roles...>`, `An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.`)
+    .requiredOption(`--roles [roles...]`, `An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.`)
     .action(actionRunner(teamsUpdateMembershipRoles))
 
 teams
@@ -414,13 +485,26 @@ teams
     .requiredOption(`--secret <secret>`, `Secret key.`)
     .action(actionRunner(teamsUpdateMembershipStatus))
 
+teams
+    .command(`getPrefs`)
+    .description(`Get the team's shared preferences by its unique ID. If a preference doesn't need to be shared by all team members, prefer storing them in [user preferences](/docs/client/account#accountGetPrefs).`)
+    .requiredOption(`--teamId <teamId>`, `Team ID.`)
+    .action(actionRunner(teamsGetPrefs))
+
+teams
+    .command(`updatePrefs`)
+    .description(`Update the team's preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.`)
+    .requiredOption(`--teamId <teamId>`, `Team ID.`)
+    .requiredOption(`--prefs <prefs>`, `Prefs key-value JSON object.`)
+    .action(actionRunner(teamsUpdatePrefs))
+
 
 module.exports = {
     teams,
     teamsList,
     teamsCreate,
     teamsGet,
-    teamsUpdate,
+    teamsUpdateName,
     teamsDelete,
     teamsListLogs,
     teamsListMemberships,
@@ -428,5 +512,7 @@ module.exports = {
     teamsGetMembership,
     teamsUpdateMembershipRoles,
     teamsDeleteMembership,
-    teamsUpdateMembershipStatus
+    teamsUpdateMembershipStatus,
+    teamsGetPrefs,
+    teamsUpdatePrefs
 };

package/lib/commands/users.js

@@ -53,22 +53,27 @@ const usersCreate = async ({ userId, email, phone, password, name, parseOutput =
     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;
     }
@@ -96,18 +101,22 @@ const usersCreateArgon2User = async ({ userId, email, password, name, parseOutpu
     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;
     }
@@ -135,18 +144,22 @@ const usersCreateBcryptUser = async ({ userId, email, password, name, parseOutpu
     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;
     }
@@ -174,18 +187,22 @@ const usersCreateMD5User = async ({ userId, email, password, name, parseOutput =
     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;
     }
@@ -213,18 +230,22 @@ const usersCreatePHPassUser = async ({ userId, email, password, name, parseOutpu
     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;
     }
@@ -257,38 +278,47 @@ const usersCreateScryptUser = async ({ userId, email, password, passwordSalt, pa
     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;
     }
@@ -319,30 +349,37 @@ const usersCreateScryptModifiedUser = async ({ userId, email, password, password
     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;
     }
@@ -371,22 +408,27 @@ const usersCreateSHAUser = async ({ userId, email, password, passwordVersion, na
     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;
     }
@@ -475,6 +517,7 @@ const usersUpdateEmail = async ({ userId, email, parseOutput = true, sdk = undef
     let payload = {};
     
     /** Body Params */
+
     if (typeof email !== 'undefined') {
         payload['email'] = email;
     }
@@ -542,6 +585,7 @@ const usersUpdateName = async ({ userId, name, parseOutput = true, sdk = undefin
     let payload = {};
     
     /** Body Params */
+
     if (typeof name !== 'undefined') {
         payload['name'] = name;
     }
@@ -567,6 +611,7 @@ const usersUpdatePassword = async ({ userId, password, parseOutput = true, sdk =
     let payload = {};
     
     /** Body Params */
+
     if (typeof password !== 'undefined') {
         payload['password'] = password;
     }
@@ -592,6 +637,7 @@ const usersUpdatePhone = async ({ userId, number, parseOutput = true, sdk = unde
     let payload = {};
     
     /** Body Params */
+
     if (typeof number !== 'undefined') {
         payload['number'] = number;
     }
@@ -715,6 +761,7 @@ const usersUpdateStatus = async ({ userId, status, parseOutput = true, sdk = und
     let payload = {};
     
     /** Body Params */
+
     if (typeof status !== 'undefined') {
         payload['status'] = status;
     }
@@ -740,6 +787,7 @@ const usersUpdateEmailVerification = async ({ userId, emailVerification, parseOu
     let payload = {};
     
     /** Body Params */
+
     if (typeof emailVerification !== 'undefined') {
         payload['emailVerification'] = emailVerification;
     }
@@ -765,6 +813,7 @@ const usersUpdatePhoneVerification = async ({ userId, phoneVerification, parseOu
     let payload = {};
     
     /** Body Params */
+
     if (typeof phoneVerification !== 'undefined') {
         payload['phoneVerification'] = phoneVerification;
     }
@@ -785,7 +834,7 @@ const usersUpdatePhoneVerification = async ({ userId, phoneVerification, parseOu
 users
     .command(`list`)
     .description(`Get a list of all the project's users. You can use the query params to filter your results.`)
-    .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). 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`)
+    .option(`--queries [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`)
     .option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
     .action(actionRunner(usersList))
 
@@ -901,7 +950,7 @@ users
     .command(`listLogs`)
     .description(`Get the user activity logs list by its unique ID.`)
     .requiredOption(`--userId <userId>`, `User ID.`)
-    .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`)
+    .option(`--queries [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`)
     .action(actionRunner(usersListLogs))
 
 users