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

package/docs/examples/users/list-targets.md

@@ -1,18 +1,14 @@
-import { Client,  Users } from "@appwrite.io/console";
+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.listTargets('[USER_ID]');
+const result = await users.listTargets(
+    '<USER_ID>', // userId
+    [] // queries (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/users/list.md

@@ -1,18 +1,14 @@
-import { Client,  Users } from "@appwrite.io/console";
+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.list();
+const result = await users.list(
+    [], // queries (optional)
+    '<SEARCH>' // search (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/users/update-email-verification.md

@@ -1,18 +1,14 @@
-import { Client,  Users } from "@appwrite.io/console";
+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.updateEmailVerification('[USER_ID]', false);
+const result = await users.updateEmailVerification(
+    '<USER_ID>', // userId
+    false // emailVerification
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/users/update-email.md

@@ -1,18 +1,14 @@
-import { Client,  Users } from "@appwrite.io/console";
+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.updateEmail('[USER_ID]', 'email@example.com');
+const result = await users.updateEmail(
+    '<USER_ID>', // userId
+    'email@example.com' // email
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/users/update-labels.md

@@ -1,18 +1,14 @@
-import { Client,  Users } from "@appwrite.io/console";
+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.updateLabels('[USER_ID]', []);
+const result = await users.updateLabels(
+    '<USER_ID>', // userId
+    [] // labels
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/users/update-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.updateMfaRecoveryCodes(
+    '<USER_ID>' // userId
+);
+
+console.log(response);

package/docs/examples/users/update-mfa.md

@@ -1,18 +1,14 @@
-import { Client,  Users } from "@appwrite.io/console";
+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.updateMfa('[USER_ID]', false);
+const result = await users.updateMfa(
+    '<USER_ID>', // userId
+    false // mfa
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

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

@@ -1,18 +1,14 @@
-import { Client,  Users } from "@appwrite.io/console";
+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.updateName('[USER_ID]', '[NAME]');
+const result = await users.updateName(
+    '<USER_ID>', // userId
+    '<NAME>' // name
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/users/update-password.md

@@ -1,18 +1,14 @@
-import { Client,  Users } from "@appwrite.io/console";
+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.updatePassword('[USER_ID]', '');
+const result = await users.updatePassword(
+    '<USER_ID>', // userId
+    '' // password
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/users/update-phone-verification.md

@@ -1,18 +1,14 @@
-import { Client,  Users } from "@appwrite.io/console";
+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.updatePhoneVerification('[USER_ID]', false);
+const result = await users.updatePhoneVerification(
+    '<USER_ID>', // userId
+    false // phoneVerification
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/users/update-phone.md

@@ -1,18 +1,14 @@
-import { Client,  Users } from "@appwrite.io/console";
+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.updatePhone('[USER_ID]', '+12065550100');
+const result = await users.updatePhone(
+    '<USER_ID>', // userId
+    '+12065550100' // number
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

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

@@ -1,18 +1,14 @@
-import { Client,  Users } from "@appwrite.io/console";
+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.updatePrefs('[USER_ID]', {});
+const result = await users.updatePrefs(
+    '<USER_ID>', // userId
+    {} // prefs
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/users/update-status.md

@@ -1,18 +1,14 @@
-import { Client,  Users } from "@appwrite.io/console";
+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.updateStatus('[USER_ID]', false);
+const result = await users.updateStatus(
+    '<USER_ID>', // userId
+    false // status
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

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

@@ -1,18 +1,17 @@
-import { Client,  Users } from "@appwrite.io/console";
+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.updateTarget('[USER_ID]', '[TARGET_ID]');
+const result = await users.updateTarget(
+    '<USER_ID>', // userId
+    '<TARGET_ID>', // targetId
+    '<IDENTIFIER>', // identifier (optional)
+    '<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/vcs/create-repository-detection.md

@@ -1,18 +1,15 @@
-import { Client,  Vcs } from "@appwrite.io/console";
+import { Client, Vcs } 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 vcs = new Vcs(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = vcs.createRepositoryDetection('[INSTALLATION_ID]', '[PROVIDER_REPOSITORY_ID]');
+const result = await vcs.createRepositoryDetection(
+    '<INSTALLATION_ID>', // installationId
+    '<PROVIDER_REPOSITORY_ID>', // providerRepositoryId
+    '<PROVIDER_ROOT_DIRECTORY>' // providerRootDirectory (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/vcs/create-repository.md

@@ -1,18 +1,15 @@
-import { Client,  Vcs } from "@appwrite.io/console";
+import { Client, Vcs } 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 vcs = new Vcs(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = vcs.createRepository('[INSTALLATION_ID]', '[NAME]', false);
+const result = await vcs.createRepository(
+    '<INSTALLATION_ID>', // installationId
+    '<NAME>', // name
+    false // private
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/vcs/delete-installation.md

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

package/docs/examples/vcs/get-installation.md

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

package/docs/examples/vcs/get-repository.md

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

package/docs/examples/vcs/list-installations.md

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

package/docs/examples/vcs/list-repositories.md

@@ -1,18 +1,14 @@
-import { Client,  Vcs } from "@appwrite.io/console";
+import { Client, Vcs } 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 vcs = new Vcs(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = vcs.listRepositories('[INSTALLATION_ID]');
+const result = await vcs.listRepositories(
+    '<INSTALLATION_ID>', // installationId
+    '<SEARCH>' // search (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/vcs/list-repository-branches.md

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