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

package/docs/examples/account/create-anonymous-session.md

@@ -1,18 +1,11 @@
-import { Client,  Account } from "@appwrite.io/console";
+import { Client, Account } 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 account = new Account(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = account.createAnonymousSession();
+const result = await account.createAnonymousSession();
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/account/create-email-password-session.md

@@ -1,18 +1,14 @@
-import { Client,  Account } from "@appwrite.io/console";
+import { Client, Account } 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 account = new Account(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = account.createEmailPasswordSession('email@example.com', 'password');
+const result = await account.createEmailPasswordSession(
+    'email@example.com', // email
+    'password' // password
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/account/create-email-token.md

@@ -1,18 +1,15 @@
-import { Client,  Account } from "@appwrite.io/console";
+import { Client, Account } 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 account = new Account(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = account.createEmailToken('[USER_ID]', 'email@example.com');
+const result = await account.createEmailToken(
+    '<USER_ID>', // userId
+    'email@example.com', // email
+    false // phrase (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/account/create-j-w-t.md

@@ -1,18 +1,11 @@
-import { Client,  Account } from "@appwrite.io/console";
+import { Client, Account } 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 account = new Account(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = account.createJWT();
+const result = await account.createJWT();
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/account/create-magic-u-r-l-token.md

@@ -1,18 +1,16 @@
-import { Client,  Account } from "@appwrite.io/console";
+import { Client, Account } 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 account = new Account(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = account.createMagicURLToken('[USER_ID]', 'email@example.com');
+const result = await account.createMagicURLToken(
+    '<USER_ID>', // userId
+    'email@example.com', // email
+    'https://example.com', // url (optional)
+    false // phrase (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/account/create-mfa-authenticator.md

@@ -0,0 +1,13 @@
+import { Client, Account, AuthenticatorType } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
+
+const account = new Account(client);
+
+const result = await account.createMfaAuthenticator(
+    AuthenticatorType.Totp // type
+);
+
+console.log(response);

package/docs/examples/account/create-mfa-challenge.md

@@ -0,0 +1,13 @@
+import { Client, Account, AuthenticationFactor } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
+
+const account = new Account(client);
+
+const result = await account.createMfaChallenge(
+    AuthenticationFactor.Email // factor
+);
+
+console.log(response);

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

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

package/docs/examples/account/create-o-auth2session.md

@@ -1,14 +1,15 @@
-import { Client, OAuthProvider, Account } from "@appwrite.io/console";
+import { Client, Account, OAuthProvider } 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 account = new Account(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-// Go to OAuth provider login page
-account.createOAuth2Session(OAuthProvider.Amazon);
+account.createOAuth2Session(
+    OAuthProvider.Amazon, // provider
+    'https://example.com', // success (optional)
+    'https://example.com', // failure (optional)
+    [] // scopes (optional)
+);
 

package/docs/examples/account/create-o-auth2token.md

@@ -0,0 +1,15 @@
+import { Client, Account, OAuthProvider } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
+
+const account = new Account(client);
+
+account.createOAuth2Token(
+    OAuthProvider.Amazon, // provider
+    'https://example.com', // success (optional)
+    'https://example.com', // failure (optional)
+    [] // scopes (optional)
+);
+

package/docs/examples/account/create-phone-token.md

@@ -1,18 +1,14 @@
-import { Client,  Account } from "@appwrite.io/console";
+import { Client, Account } 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 account = new Account(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = account.createPhoneToken('[USER_ID]', '+12065550100');
+const result = await account.createPhoneToken(
+    '<USER_ID>', // userId
+    '+12065550100' // phone
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/account/create-phone-verification.md

@@ -1,18 +1,11 @@
-import { Client,  Account } from "@appwrite.io/console";
+import { Client, Account } 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 account = new Account(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = account.createPhoneVerification();
+const result = await account.createPhoneVerification();
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/account/create-push-target.md

@@ -1,18 +1,15 @@
-import { Client,  Account } from "@appwrite.io/console";
+import { Client, Account } 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 account = new Account(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = account.createPushTarget('[TARGET_ID]', '[IDENTIFIER]');
+const result = await account.createPushTarget(
+    '<TARGET_ID>', // targetId
+    '<IDENTIFIER>', // identifier
+    '<PROVIDER_ID>' // providerId (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/account/create-recovery.md

@@ -1,18 +1,14 @@
-import { Client,  Account } from "@appwrite.io/console";
+import { Client, Account } 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 account = new Account(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = account.createRecovery('email@example.com', 'https://example.com');
+const result = await account.createRecovery(
+    'email@example.com', // email
+    'https://example.com' // url
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

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

@@ -1,18 +1,14 @@
-import { Client,  Account } from "@appwrite.io/console";
+import { Client, Account } 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 account = new Account(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = account.createSession('[USER_ID]', '[SECRET]');
+const result = await account.createSession(
+    '<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/account/create-verification.md

@@ -1,18 +1,13 @@
-import { Client,  Account } from "@appwrite.io/console";
+import { Client, Account } 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 account = new Account(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = account.createVerification('https://example.com');
+const result = await account.createVerification(
+    'https://example.com' // url
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/account/create.md

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

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

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

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

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

package/docs/examples/account/delete-push-target.md

@@ -1,18 +1,13 @@
-import { Client,  Account } from "@appwrite.io/console";
+import { Client, Account } 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 account = new Account(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = account.deletePushTarget('[TARGET_ID]');
+const result = await account.deletePushTarget(
+    '<TARGET_ID>' // targetId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

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

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

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

@@ -1,18 +1,11 @@
-import { Client,  Account } from "@appwrite.io/console";
+import { Client, Account } 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 account = new Account(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = account.deleteSessions();
+const result = await account.deleteSessions();
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/account/delete.md

@@ -1,18 +1,11 @@
-import { Client,  Account } from "@appwrite.io/console";
+import { Client, Account } 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 account = new Account(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = account.delete();
+const result = await account.delete();
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

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

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

package/docs/examples/account/get-prefs.md

@@ -1,18 +1,11 @@
-import { Client,  Account } from "@appwrite.io/console";
+import { Client, Account } 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 account = new Account(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = account.getPrefs();
+const result = await account.getPrefs();
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/account/get-session.md

@@ -1,18 +1,13 @@
-import { Client,  Account } from "@appwrite.io/console";
+import { Client, Account } 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 account = new Account(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = account.getSession('[SESSION_ID]');
+const result = await account.getSession(
+    '<SESSION_ID>' // sessionId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);