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

package/docs/examples/migrations/delete-firebase-auth.md

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

package/docs/examples/migrations/delete.md

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

package/docs/examples/migrations/get-appwrite-report.md

@@ -1,18 +1,16 @@
 import { Client, Migrations } 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 migrations = new Migrations(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = migrations.getAppwriteReport([], 'https://example.com', '[PROJECT_ID]', '[KEY]');
+const result = await migrations.getAppwriteReport(
+    [], // resources
+    'https://example.com', // endpoint
+    '<PROJECT_ID>', // projectID
+    '<KEY>' // key
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/migrations/get-firebase-report-o-auth.md

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

package/docs/examples/migrations/get-firebase-report.md

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

package/docs/examples/migrations/get-n-host-report.md

@@ -1,18 +1,20 @@
 import { Client, Migrations } 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 migrations = new Migrations(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = migrations.getNHostReport([], '[SUBDOMAIN]', '[REGION]', '[ADMIN_SECRET]', '[DATABASE]', '[USERNAME]', '[PASSWORD]');
+const result = await migrations.getNHostReport(
+    [], // resources
+    '<SUBDOMAIN>', // subdomain
+    '<REGION>', // region
+    '<ADMIN_SECRET>', // adminSecret
+    '<DATABASE>', // database
+    '<USERNAME>', // username
+    '<PASSWORD>', // password
+    null // port (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/migrations/get-supabase-report.md

@@ -1,18 +1,19 @@
 import { Client, Migrations } 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 migrations = new Migrations(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = migrations.getSupabaseReport([], 'https://example.com', '[API_KEY]', '[DATABASE_HOST]', '[USERNAME]', '[PASSWORD]');
+const result = await migrations.getSupabaseReport(
+    [], // resources
+    'https://example.com', // endpoint
+    '<API_KEY>', // apiKey
+    '<DATABASE_HOST>', // databaseHost
+    '<USERNAME>', // username
+    '<PASSWORD>', // password
+    null // port (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/migrations/get.md

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

package/docs/examples/migrations/list-firebase-projects.md

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

package/docs/examples/migrations/list.md

@@ -1,18 +1,14 @@
 import { Client, Migrations } 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 migrations = new Migrations(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = migrations.list();
+const result = await migrations.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/migrations/retry.md

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

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

@@ -1,18 +1,14 @@
 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.createVariable('[KEY]', '[VALUE]');
+const result = await project.createVariable(
+    '<KEY>', // key
+    '<VALUE>' // value
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

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

@@ -1,18 +1,13 @@
 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";
 
-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";
 
-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";
 
-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";
 
-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, 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]', '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";
 
-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);