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

package/docs/examples/projects/update-email-template.md

@@ -1,18 +1,20 @@
-import { Client, Projects } from "@appwrite.io/console";
+import { Client, Projects, EmailTemplateType, EmailTemplateLocale } 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 projects = new Projects(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = projects.updateEmailTemplate('[PROJECT_ID]', 'verification', 'af', '[SUBJECT]', '[MESSAGE]');
+const result = await projects.updateEmailTemplate(
+    '<PROJECT_ID>', // projectId
+    EmailTemplateType.Verification, // type
+    EmailTemplateLocale.Af, // locale
+    '<SUBJECT>', // subject
+    '<MESSAGE>', // message
+    '<SENDER_NAME>', // senderName (optional)
+    'email@example.com', // senderEmail (optional)
+    'email@example.com' // replyTo (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/projects/update-key.md

@@ -1,18 +1,17 @@
 import { Client, Projects } 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 projects = new Projects(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = projects.updateKey('[PROJECT_ID]', '[KEY_ID]', '[NAME]', []);
+const result = await projects.updateKey(
+    '<PROJECT_ID>', // projectId
+    '<KEY_ID>', // keyId
+    '<NAME>', // name
+    [], // scopes
+    '' // expire (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/projects/update-o-auth2.md

@@ -1,18 +1,17 @@
-import { Client, Projects } from "@appwrite.io/console";
+import { Client, Projects, 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 projects = new Projects(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = projects.updateOAuth2('[PROJECT_ID]', 'amazon');
+const result = await projects.updateOAuth2(
+    '<PROJECT_ID>', // projectId
+    OAuthProvider.Amazon, // provider
+    '<APP_ID>', // appId (optional)
+    '<SECRET>', // secret (optional)
+    false // enabled (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/projects/update-personal-data-check.md

@@ -1,18 +1,14 @@
 import { Client, Projects } 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 projects = new Projects(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = projects.updatePersonalDataCheck('[PROJECT_ID]', false);
+const result = await projects.updatePersonalDataCheck(
+    '<PROJECT_ID>', // projectId
+    false // enabled
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/projects/update-platform.md

@@ -1,18 +1,18 @@
 import { Client, Projects } 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 projects = new Projects(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = projects.updatePlatform('[PROJECT_ID]', '[PLATFORM_ID]', '[NAME]');
+const result = await projects.updatePlatform(
+    '<PROJECT_ID>', // projectId
+    '<PLATFORM_ID>', // platformId
+    '<NAME>', // name
+    '<KEY>', // key (optional)
+    '<STORE>', // store (optional)
+    '' // hostname (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/projects/update-service-status-all.md

@@ -1,18 +1,14 @@
 import { Client, Projects } 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 projects = new Projects(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = projects.updateServiceStatusAll('[PROJECT_ID]', false);
+const result = await projects.updateServiceStatusAll(
+    '<PROJECT_ID>', // projectId
+    false // status
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/projects/update-service-status.md

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

package/docs/examples/projects/update-sms-template.md

@@ -1,18 +1,16 @@
-import { Client, Projects } from "@appwrite.io/console";
+import { Client, Projects, SmsTemplateType, SmsTemplateLocale } 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 projects = new Projects(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = projects.updateSmsTemplate('[PROJECT_ID]', 'verification', 'af', '[MESSAGE]');
+const result = await projects.updateSmsTemplate(
+    '<PROJECT_ID>', // projectId
+    SmsTemplateType.Verification, // type
+    SmsTemplateLocale.Af, // locale
+    '<MESSAGE>' // message
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/projects/update-smtp.md

@@ -1,18 +1,22 @@
-import { Client, Projects } from "@appwrite.io/console";
+import { Client, Projects, SMTPSecure } 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 projects = new Projects(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = projects.updateSmtp('[PROJECT_ID]', false);
+const result = await projects.updateSmtp(
+    '<PROJECT_ID>', // projectId
+    false, // enabled
+    '<SENDER_NAME>', // senderName (optional)
+    'email@example.com', // senderEmail (optional)
+    'email@example.com', // replyTo (optional)
+    '', // host (optional)
+    null, // port (optional)
+    '<USERNAME>', // username (optional)
+    '<PASSWORD>', // password (optional)
+    SMTPSecure.Tls // secure (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/projects/update-team.md

@@ -1,18 +1,14 @@
 import { Client, Projects } 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 projects = new Projects(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = projects.updateTeam('[PROJECT_ID]', '[TEAM_ID]');
+const result = await projects.updateTeam(
+    '<PROJECT_ID>', // projectId
+    '<TEAM_ID>' // teamId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/projects/update-webhook-signature.md

@@ -1,18 +1,14 @@
 import { Client, Projects } 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 projects = new Projects(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = projects.updateWebhookSignature('[PROJECT_ID]', '[WEBHOOK_ID]');
+const result = await projects.updateWebhookSignature(
+    '<PROJECT_ID>', // projectId
+    '<WEBHOOK_ID>' // webhookId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/projects/update-webhook.md

@@ -1,18 +1,21 @@
 import { Client, Projects } 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 projects = new Projects(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = projects.updateWebhook('[PROJECT_ID]', '[WEBHOOK_ID]', '[NAME]', [], '', false);
+const result = await projects.updateWebhook(
+    '<PROJECT_ID>', // projectId
+    '<WEBHOOK_ID>', // webhookId
+    '<NAME>', // name
+    [], // events
+    '', // url
+    false, // security
+    false, // enabled (optional)
+    '<HTTP_USER>', // httpUser (optional)
+    '<HTTP_PASS>' // httpPass (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/projects/update.md

@@ -1,18 +1,23 @@
 import { Client, Projects } 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 projects = new Projects(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = projects.update('[PROJECT_ID]', '[NAME]');
+const result = await projects.update(
+    '<PROJECT_ID>', // projectId
+    '<NAME>', // name
+    '<DESCRIPTION>', // description (optional)
+    '<LOGO>', // logo (optional)
+    'https://example.com', // url (optional)
+    '<LEGAL_NAME>', // legalName (optional)
+    '<LEGAL_COUNTRY>', // legalCountry (optional)
+    '<LEGAL_STATE>', // legalState (optional)
+    '<LEGAL_CITY>', // legalCity (optional)
+    '<LEGAL_ADDRESS>', // legalAddress (optional)
+    '<LEGAL_TAX_ID>' // legalTaxId (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/proxy/create-rule.md

@@ -1,18 +1,15 @@
-import { Client, Proxy } from "@appwrite.io/console";
+import { Client, Proxy,  } 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 proxy = new Proxy(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = proxy.createRule('', 'api');
+const result = await proxy.createRule(
+    '', // domain
+    .Api, // resourceType
+    '<RESOURCE_ID>' // resourceId (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/proxy/delete-rule.md

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

package/docs/examples/proxy/get-rule.md

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

package/docs/examples/proxy/list-rules.md

@@ -1,18 +1,14 @@
 import { Client, Proxy } 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 proxy = new Proxy(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = proxy.listRules();
+const result = await proxy.listRules(
+    [], // 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/proxy/update-rule-verification.md

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

package/docs/examples/storage/create-bucket.md

@@ -1,18 +1,22 @@
-import { Client, Storage } from "@appwrite.io/console";
+import { Client, Storage,  } 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 storage = new Storage(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = storage.createBucket('[BUCKET_ID]', '[NAME]');
+const result = await storage.createBucket(
+    '<BUCKET_ID>', // bucketId
+    '<NAME>', // name
+    ["read("any")"], // permissions (optional)
+    false, // fileSecurity (optional)
+    false, // enabled (optional)
+    1, // maximumFileSize (optional)
+    [], // allowedFileExtensions (optional)
+    .None, // compression (optional)
+    false, // encryption (optional)
+    false // antivirus (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/storage/create-file.md

@@ -1,18 +1,16 @@
 import { Client, Storage } 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 storage = new Storage(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = storage.createFile('[BUCKET_ID]', '[FILE_ID]', document.getElementById('uploader').files[0]);
+const result = await storage.createFile(
+    '<BUCKET_ID>', // bucketId
+    '<FILE_ID>', // fileId
+    document.getElementById('uploader').files[0], // file
+    ["read("any")"] // permissions (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/storage/delete-bucket.md

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