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

package/docs/examples/messaging/update-textmagic-provider.md

@@ -1,18 +1,18 @@
-import { Client,  Messaging } from "@appwrite.io/console";
+import { Client, Messaging } 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 messaging = new Messaging(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = messaging.updateTextmagicProvider('[PROVIDER_ID]');
+const result = await messaging.updateTextmagicProvider(
+    '<PROVIDER_ID>', // providerId
+    '<NAME>', // name (optional)
+    false, // enabled (optional)
+    '<USERNAME>', // username (optional)
+    '<API_KEY>', // apiKey (optional)
+    '<FROM>' // from (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/messaging/update-topic.md

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

package/docs/examples/messaging/update-twilio-provider.md

@@ -1,18 +1,18 @@
-import { Client,  Messaging } from "@appwrite.io/console";
+import { Client, Messaging } 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 messaging = new Messaging(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = messaging.updateTwilioProvider('[PROVIDER_ID]');
+const result = await messaging.updateTwilioProvider(
+    '<PROVIDER_ID>', // providerId
+    '<NAME>', // name (optional)
+    false, // enabled (optional)
+    '<ACCOUNT_SID>', // accountSid (optional)
+    '<AUTH_TOKEN>', // authToken (optional)
+    '<FROM>' // from (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/messaging/update-vonage-provider.md

@@ -1,18 +1,18 @@
-import { Client,  Messaging } from "@appwrite.io/console";
+import { Client, Messaging } 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 messaging = new Messaging(client);
 
-client
-    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-;
-
-const promise = messaging.updateVonageProvider('[PROVIDER_ID]');
+const result = await messaging.updateVonageProvider(
+    '<PROVIDER_ID>', // providerId
+    '<NAME>', // name (optional)
+    false, // enabled (optional)
+    '<API_KEY>', // apiKey (optional)
+    '<API_SECRET>', // apiSecret (optional)
+    '<FROM>' // from (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/migrations/create-appwrite-migration.md

@@ -1,18 +1,16 @@
-import { Client,  Migrations } from "@appwrite.io/console";
+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.createAppwriteMigration([], 'https://example.com', '[PROJECT_ID]', '[API_KEY]');
+const result = await migrations.createAppwriteMigration(
+    [], // resources
+    'https://example.com', // endpoint
+    '<PROJECT_ID>', // projectId
+    '<API_KEY>' // apiKey
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/migrations/create-firebase-migration.md

@@ -1,18 +1,14 @@
-import { Client,  Migrations } from "@appwrite.io/console";
+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.createFirebaseMigration([], '[SERVICE_ACCOUNT]');
+const result = await migrations.createFirebaseMigration(
+    [], // 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/create-firebase-o-auth-migration.md

@@ -1,18 +1,14 @@
-import { Client,  Migrations } from "@appwrite.io/console";
+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.createFirebaseOAuthMigration([], '[PROJECT_ID]');
+const result = await migrations.createFirebaseOAuthMigration(
+    [], // 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/create-n-host-migration.md

@@ -1,18 +1,20 @@
-import { Client,  Migrations } from "@appwrite.io/console";
+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.createNHostMigration([], '[SUBDOMAIN]', '[REGION]', '[ADMIN_SECRET]', '[DATABASE]', '[USERNAME]', '[PASSWORD]');
+const result = await migrations.createNHostMigration(
+    [], // 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/create-supabase-migration.md

@@ -1,18 +1,19 @@
-import { Client,  Migrations } from "@appwrite.io/console";
+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.createSupabaseMigration([], 'https://example.com', '[API_KEY]', '[DATABASE_HOST]', '[USERNAME]', '[PASSWORD]');
+const result = await migrations.createSupabaseMigration(
+    [], // 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/delete-firebase-auth.md

@@ -1,18 +1,11 @@
-import { Client,  Migrations } from "@appwrite.io/console";
+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";
+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";
+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";
+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";
+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";
+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";
+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";
+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";
+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";
+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";
+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";
+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);