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

package/docs/examples/project/delete-variable.md

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

package/docs/examples/project/get-usage.md

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

package/docs/examples/project/get-variable.md

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

package/docs/examples/project/list-variables.md

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

package/docs/examples/project/update-variable.md

@@ -1,18 +1,15 @@
-import { Client,  Project } from "@appwrite.io/console";
+import { Client, Project } 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 project = new Project(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = project.updateVariable('[VARIABLE_ID]', '[KEY]');
+const result = await project.updateVariable(
+    '<VARIABLE_ID>', // variableId
+    '<KEY>', // key
+    '<VALUE>' // value (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

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

@@ -1,18 +1,16 @@
-import { Client,  Projects } from "@appwrite.io/console";
+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.createKey('[PROJECT_ID]', '[NAME]', []);
+const result = await projects.createKey(
+    '<PROJECT_ID>', // projectId
+    '<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/create-platform.md

@@ -1,18 +1,18 @@
-import { Client, PlatformType, Projects } from "@appwrite.io/console";
+import { Client, Projects, PlatformType } 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.createPlatform('[PROJECT_ID]', PlatformType.Web, '[NAME]');
+const result = await projects.createPlatform(
+    '<PROJECT_ID>', // projectId
+    PlatformType.Web, // type
+    '<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/create-smtp-test.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.createSmtpTest('[PROJECT_ID]', [], '[SENDER_NAME]', 'email@example.com', '');
+const result = await projects.createSmtpTest(
+    '<PROJECT_ID>', // projectId
+    [], // emails
+    '<SENDER_NAME>', // senderName
+    'email@example.com', // senderEmail
+    '', // host
+    'email@example.com', // replyTo (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/create-webhook.md

@@ -1,18 +1,20 @@
-import { Client,  Projects } from "@appwrite.io/console";
+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.createWebhook('[PROJECT_ID]', '[NAME]', [], '', false);
+const result = await projects.createWebhook(
+    '<PROJECT_ID>', // projectId
+    '<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/create.md

@@ -1,18 +1,25 @@
-import { Client,  Projects } from "@appwrite.io/console";
+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.create('', '[NAME]', '[TEAM_ID]');
+const result = await projects.create(
+    '', // projectId
+    '<NAME>', // name
+    '<TEAM_ID>', // teamId
+    .Default, // region (optional)
+    '<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/projects/delete-email-template.md

@@ -1,18 +1,15 @@
-import { Client, TemplateType,TemplateLocale, 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.deleteEmailTemplate('[PROJECT_ID]', TemplateType.Verification, TemplateLocale.Af);
+const result = await projects.deleteEmailTemplate(
+    '<PROJECT_ID>', // projectId
+    EmailTemplateType.Verification, // type
+    EmailTemplateLocale.Af // locale
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

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

@@ -1,18 +1,14 @@
-import { Client,  Projects } from "@appwrite.io/console";
+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.deleteKey('[PROJECT_ID]', '[KEY_ID]');
+const result = await projects.deleteKey(
+    '<PROJECT_ID>', // projectId
+    '<KEY_ID>' // keyId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

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

@@ -1,18 +1,14 @@
-import { Client,  Projects } from "@appwrite.io/console";
+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.deletePlatform('[PROJECT_ID]', '[PLATFORM_ID]');
+const result = await projects.deletePlatform(
+    '<PROJECT_ID>', // projectId
+    '<PLATFORM_ID>' // platformId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

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

@@ -1,18 +1,15 @@
-import { Client, TemplateType,TemplateLocale, 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.deleteSmsTemplate('[PROJECT_ID]', TemplateType.Verification, TemplateLocale.Af);
+const result = await projects.deleteSmsTemplate(
+    '<PROJECT_ID>', // projectId
+    SmsTemplateType.Verification, // type
+    SmsTemplateLocale.Af // locale
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

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

@@ -1,18 +1,14 @@
-import { Client,  Projects } from "@appwrite.io/console";
+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.deleteWebhook('[PROJECT_ID]', '[WEBHOOK_ID]');
+const result = await projects.deleteWebhook(
+    '<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/delete.md

@@ -1,18 +1,13 @@
-import { Client,  Projects } from "@appwrite.io/console";
+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.delete('[PROJECT_ID]');
+const result = await projects.delete(
+    '<PROJECT_ID>' // projectId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

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

@@ -1,18 +1,15 @@
-import { Client, TemplateType,TemplateLocale, 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.getEmailTemplate('[PROJECT_ID]', TemplateType.Verification, TemplateLocale.Af);
+const result = await projects.getEmailTemplate(
+    '<PROJECT_ID>', // projectId
+    EmailTemplateType.Verification, // type
+    EmailTemplateLocale.Af // locale
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

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

@@ -1,18 +1,14 @@
-import { Client,  Projects } from "@appwrite.io/console";
+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.getKey('[PROJECT_ID]', '[KEY_ID]');
+const result = await projects.getKey(
+    '<PROJECT_ID>', // projectId
+    '<KEY_ID>' // keyId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

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

@@ -1,18 +1,14 @@
-import { Client,  Projects } from "@appwrite.io/console";
+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.getPlatform('[PROJECT_ID]', '[PLATFORM_ID]');
+const result = await projects.getPlatform(
+    '<PROJECT_ID>', // projectId
+    '<PLATFORM_ID>' // platformId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

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

@@ -1,18 +1,15 @@
-import { Client, TemplateType,TemplateLocale, 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.getSmsTemplate('[PROJECT_ID]', TemplateType.Verification, TemplateLocale.Af);
+const result = await projects.getSmsTemplate(
+    '<PROJECT_ID>', // projectId
+    SmsTemplateType.Verification, // type
+    SmsTemplateLocale.Af // locale
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

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

@@ -1,18 +1,14 @@
-import { Client,  Projects } from "@appwrite.io/console";
+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.getWebhook('[PROJECT_ID]', '[WEBHOOK_ID]');
+const result = await projects.getWebhook(
+    '<PROJECT_ID>', // projectId
+    '<WEBHOOK_ID>' // webhookId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);