@appwrite.io/console 0.6.0-rc.8 → 0.6.0

package/docs/examples/teams/update-membership-status.md

@@ -1,18 +1,16 @@
 import { Client, Teams } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const teams = new Teams(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = teams.updateMembershipStatus('[TEAM_ID]', '[MEMBERSHIP_ID]', '[USER_ID]', '[SECRET]');
+const result = await teams.updateMembershipStatus(
+    '<TEAM_ID>', // teamId
+    '<MEMBERSHIP_ID>', // membershipId
+    '<USER_ID>', // userId
+    '<SECRET>' // secret
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/teams/update-membership.md

@@ -1,18 +1,15 @@
 import { Client, Teams } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const teams = new Teams(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = teams.updateMembership('[TEAM_ID]', '[MEMBERSHIP_ID]', []);
+const result = await teams.updateMembership(
+    '<TEAM_ID>', // teamId
+    '<MEMBERSHIP_ID>', // membershipId
+    [] // roles
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/teams/update-name.md

@@ -1,18 +1,14 @@
 import { Client, Teams } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const teams = new Teams(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = teams.updateName('[TEAM_ID]', '[NAME]');
+const result = await teams.updateName(
+    '<TEAM_ID>', // teamId
+    '<NAME>' // name
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/teams/update-prefs.md

@@ -1,18 +1,14 @@
 import { Client, Teams } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const teams = new Teams(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = teams.updatePrefs('[TEAM_ID]', {});
+const result = await teams.updatePrefs(
+    '<TEAM_ID>', // teamId
+    {} // prefs
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/users/create-argon2user.md

@@ -1,18 +1,16 @@
 import { Client, Users } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const users = new Users(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = users.createArgon2User('[USER_ID]', 'email@example.com', 'password');
+const result = await users.createArgon2User(
+    '<USER_ID>', // userId
+    'email@example.com', // email
+    'password', // password
+    '<NAME>' // name (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/users/create-bcrypt-user.md

@@ -1,18 +1,16 @@
 import { Client, Users } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const users = new Users(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = users.createBcryptUser('[USER_ID]', 'email@example.com', 'password');
+const result = await users.createBcryptUser(
+    '<USER_ID>', // userId
+    'email@example.com', // email
+    'password', // password
+    '<NAME>' // name (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/users/create-m-d5user.md

@@ -1,18 +1,16 @@
 import { Client, Users } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const users = new Users(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = users.createMD5User('[USER_ID]', 'email@example.com', 'password');
+const result = await users.createMD5User(
+    '<USER_ID>', // userId
+    'email@example.com', // email
+    'password', // password
+    '<NAME>' // name (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/users/create-mfa-recovery-codes.md

@@ -0,0 +1,13 @@
+import { Client, Users } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
+
+const users = new Users(client);
+
+const result = await users.createMfaRecoveryCodes(
+    '<USER_ID>' // userId
+);
+
+console.log(response);

package/docs/examples/users/create-p-h-pass-user.md

@@ -1,18 +1,16 @@
 import { Client, Users } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const users = new Users(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = users.createPHPassUser('[USER_ID]', 'email@example.com', 'password');
+const result = await users.createPHPassUser(
+    '<USER_ID>', // userId
+    'email@example.com', // email
+    'password', // password
+    '<NAME>' // name (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/users/create-s-h-a-user.md

@@ -1,18 +1,17 @@
-import { Client, Users } from "@appwrite.io/console";
+import { Client, Users, PasswordHash } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const users = new Users(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = users.createSHAUser('[USER_ID]', 'email@example.com', 'password');
+const result = await users.createSHAUser(
+    '<USER_ID>', // userId
+    'email@example.com', // email
+    'password', // password
+    PasswordHash.Sha1, // passwordVersion (optional)
+    '<NAME>' // name (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/users/create-scrypt-modified-user.md

@@ -1,18 +1,19 @@
 import { Client, Users } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const users = new Users(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = users.createScryptModifiedUser('[USER_ID]', 'email@example.com', 'password', '[PASSWORD_SALT]', '[PASSWORD_SALT_SEPARATOR]', '[PASSWORD_SIGNER_KEY]');
+const result = await users.createScryptModifiedUser(
+    '<USER_ID>', // userId
+    'email@example.com', // email
+    'password', // password
+    '<PASSWORD_SALT>', // passwordSalt
+    '<PASSWORD_SALT_SEPARATOR>', // passwordSaltSeparator
+    '<PASSWORD_SIGNER_KEY>', // passwordSignerKey
+    '<NAME>' // name (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/users/create-scrypt-user.md

@@ -1,18 +1,21 @@
 import { Client, Users } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const users = new Users(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = users.createScryptUser('[USER_ID]', 'email@example.com', 'password', '[PASSWORD_SALT]', null, null, null, null);
+const result = await users.createScryptUser(
+    '<USER_ID>', // userId
+    'email@example.com', // email
+    'password', // password
+    '<PASSWORD_SALT>', // passwordSalt
+    null, // passwordCpu
+    null, // passwordMemory
+    null, // passwordParallel
+    null, // passwordLength
+    '<NAME>' // name (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/users/create-session.md

@@ -1,18 +1,13 @@
 import { Client, Users } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const users = new Users(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = users.createSession('[USER_ID]');
+const result = await users.createSession(
+    '<USER_ID>' // userId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/users/create-target.md

@@ -1,18 +1,18 @@
-import { Client, Users } from "@appwrite.io/console";
+import { Client, Users, MessagingProviderType } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const users = new Users(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = users.createTarget('[USER_ID]', '[TARGET_ID]', 'email', '[IDENTIFIER]');
+const result = await users.createTarget(
+    '<USER_ID>', // userId
+    '<TARGET_ID>', // targetId
+    MessagingProviderType.Email, // providerType
+    '<IDENTIFIER>', // identifier
+    '<PROVIDER_ID>', // providerId (optional)
+    '<NAME>' // name (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/users/create-token.md

@@ -1,18 +1,15 @@
 import { Client, Users } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const users = new Users(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = users.createToken('[USER_ID]');
+const result = await users.createToken(
+    '<USER_ID>', // userId
+    4, // length (optional)
+    60 // expire (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/users/create.md

@@ -1,18 +1,17 @@
 import { Client, Users } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const users = new Users(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = users.create('[USER_ID]');
+const result = await users.create(
+    '<USER_ID>', // userId
+    'email@example.com', // email (optional)
+    '+12065550100', // phone (optional)
+    '', // password (optional)
+    '<NAME>' // name (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/users/delete-identity.md

@@ -1,18 +1,13 @@
 import { Client, Users } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const users = new Users(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = users.deleteIdentity('[IDENTITY_ID]');
+const result = await users.deleteIdentity(
+    '<IDENTITY_ID>' // identityId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/users/delete-mfa-authenticator.md

@@ -0,0 +1,14 @@
+import { Client, Users, AuthenticatorType } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
+
+const users = new Users(client);
+
+const result = await users.deleteMfaAuthenticator(
+    '<USER_ID>', // userId
+    AuthenticatorType.Totp // type
+);
+
+console.log(response);

package/docs/examples/users/delete-session.md

@@ -1,18 +1,14 @@
 import { Client, Users } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const users = new Users(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = users.deleteSession('[USER_ID]', '[SESSION_ID]');
+const result = await users.deleteSession(
+    '<USER_ID>', // userId
+    '<SESSION_ID>' // sessionId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/users/delete-sessions.md

@@ -1,18 +1,13 @@
 import { Client, Users } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const users = new Users(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = users.deleteSessions('[USER_ID]');
+const result = await users.deleteSessions(
+    '<USER_ID>' // userId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/users/delete-target.md

@@ -1,18 +1,14 @@
 import { Client, Users } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const users = new Users(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = users.deleteTarget('[USER_ID]', '[TARGET_ID]');
+const result = await users.deleteTarget(
+    '<USER_ID>', // userId
+    '<TARGET_ID>' // targetId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/users/delete.md

@@ -1,18 +1,13 @@
 import { Client, Users } from "@appwrite.io/console";
 
-const client = new Client();
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
 
 const users = new Users(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = users.delete('[USER_ID]');
+const result = await users.delete(
+    '<USER_ID>' // userId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/users/get-mfa-recovery-codes.md

@@ -0,0 +1,13 @@
+import { Client, Users } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
+
+const users = new Users(client);
+
+const result = await users.getMfaRecoveryCodes(
+    '<USER_ID>' // userId
+);
+
+console.log(response);