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

package/docs/examples/messaging/get-provider.md

@@ -1,18 +1,13 @@
-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.getProvider('[PROVIDER_ID]');
+const result = await messaging.getProvider(
+    '<PROVIDER_ID>' // providerId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/messaging/get-subscriber.md

@@ -1,18 +1,14 @@
-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.getSubscriber('[TOPIC_ID]', '[SUBSCRIBER_ID]');
+const result = await messaging.getSubscriber(
+    '<TOPIC_ID>', // topicId
+    '<SUBSCRIBER_ID>' // subscriberId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

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

@@ -1,18 +1,13 @@
-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.getTopic('[TOPIC_ID]');
+const result = await messaging.getTopic(
+    '<TOPIC_ID>' // topicId
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/messaging/list-message-logs.md

@@ -1,18 +1,14 @@
-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.listMessageLogs('[MESSAGE_ID]');
+const result = await messaging.listMessageLogs(
+    '<MESSAGE_ID>', // messageId
+    [] // queries (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/messaging/list-messages.md

@@ -1,18 +1,14 @@
-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.listMessages();
+const result = await messaging.listMessages(
+    [], // 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/messaging/list-provider-logs.md

@@ -1,18 +1,14 @@
-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.listProviderLogs('[PROVIDER_ID]');
+const result = await messaging.listProviderLogs(
+    '<PROVIDER_ID>', // providerId
+    [] // queries (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/messaging/list-providers.md

@@ -1,18 +1,14 @@
-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.listProviders();
+const result = await messaging.listProviders(
+    [], // 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/messaging/list-subscriber-logs.md

@@ -1,18 +1,14 @@
-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.listSubscriberLogs('[SUBSCRIBER_ID]');
+const result = await messaging.listSubscriberLogs(
+    '<SUBSCRIBER_ID>', // subscriberId
+    [] // queries (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/messaging/list-subscribers.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.listSubscribers('[TOPIC_ID]');
+const result = await messaging.listSubscribers(
+    '<TOPIC_ID>', // topicId
+    [], // 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/messaging/list-targets.md

@@ -1,18 +1,14 @@
-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.listTargets('[MESSAGE_ID]');
+const result = await messaging.listTargets(
+    '<MESSAGE_ID>', // messageId
+    [] // queries (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/messaging/list-topic-logs.md

@@ -1,18 +1,14 @@
-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.listTopicLogs('[TOPIC_ID]');
+const result = await messaging.listTopicLogs(
+    '<TOPIC_ID>', // topicId
+    [] // queries (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/messaging/list-topics.md

@@ -1,18 +1,14 @@
-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.listTopics();
+const result = await messaging.listTopics(
+    [], // 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/messaging/update-apns-provider.md

@@ -0,0 +1,20 @@
+import { Client, Messaging } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
+
+const messaging = new Messaging(client);
+
+const result = await messaging.updateApnsProvider(
+    '<PROVIDER_ID>', // providerId
+    '<NAME>', // name (optional)
+    false, // enabled (optional)
+    '<AUTH_KEY>', // authKey (optional)
+    '<AUTH_KEY_ID>', // authKeyId (optional)
+    '<TEAM_ID>', // teamId (optional)
+    '<BUNDLE_ID>', // bundleId (optional)
+    false // sandbox (optional)
+);
+
+console.log(response);

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

@@ -1,18 +1,23 @@
-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.updateEmail('[MESSAGE_ID]');
+const result = await messaging.updateEmail(
+    '<MESSAGE_ID>', // messageId
+    [], // topics (optional)
+    [], // users (optional)
+    [], // targets (optional)
+    '<SUBJECT>', // subject (optional)
+    '<CONTENT>', // content (optional)
+    false, // draft (optional)
+    false, // html (optional)
+    [], // cc (optional)
+    [], // bcc (optional)
+    '' // scheduledAt (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

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

@@ -0,0 +1,16 @@
+import { Client, Messaging } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
+
+const messaging = new Messaging(client);
+
+const result = await messaging.updateFcmProvider(
+    '<PROVIDER_ID>', // providerId
+    '<NAME>', // name (optional)
+    false, // enabled (optional)
+    {} // serviceAccountJSON (optional)
+);
+
+console.log(response);

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

@@ -1,18 +1,22 @@
-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.updateMailgunProvider('[PROVIDER_ID]');
+const result = await messaging.updateMailgunProvider(
+    '<PROVIDER_ID>', // providerId
+    '<NAME>', // name (optional)
+    '<API_KEY>', // apiKey (optional)
+    '<DOMAIN>', // domain (optional)
+    false, // isEuRegion (optional)
+    false, // enabled (optional)
+    '<FROM_NAME>', // fromName (optional)
+    'email@example.com', // fromEmail (optional)
+    '<REPLY_TO_NAME>', // replyToName (optional)
+    '<REPLY_TO_EMAIL>' // replyToEmail (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

package/docs/examples/messaging/update-msg91provider.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.updateMsg91Provider('[PROVIDER_ID]');
+const result = await messaging.updateMsg91Provider(
+    '<PROVIDER_ID>', // providerId
+    '<NAME>', // name (optional)
+    false, // enabled (optional)
+    '<SENDER_ID>', // senderId (optional)
+    '<AUTH_KEY>', // authKey (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-push.md

@@ -1,18 +1,28 @@
-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.updatePush('[MESSAGE_ID]');
+const result = await messaging.updatePush(
+    '<MESSAGE_ID>', // messageId
+    [], // topics (optional)
+    [], // users (optional)
+    [], // targets (optional)
+    '<TITLE>', // title (optional)
+    '<BODY>', // body (optional)
+    {}, // data (optional)
+    '<ACTION>', // action (optional)
+    '[ID1:ID2]', // image (optional)
+    '<ICON>', // icon (optional)
+    '<SOUND>', // sound (optional)
+    '<COLOR>', // color (optional)
+    '<TAG>', // tag (optional)
+    null, // badge (optional)
+    false, // draft (optional)
+    '' // scheduledAt (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

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

@@ -1,18 +1,20 @@
-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.updateSendgridProvider('[PROVIDER_ID]');
+const result = await messaging.updateSendgridProvider(
+    '<PROVIDER_ID>', // providerId
+    '<NAME>', // name (optional)
+    false, // enabled (optional)
+    '<API_KEY>', // apiKey (optional)
+    '<FROM_NAME>', // fromName (optional)
+    'email@example.com', // fromEmail (optional)
+    '<REPLY_TO_NAME>', // replyToName (optional)
+    '<REPLY_TO_EMAIL>' // replyToEmail (optional)
+);
 
-promise.then(function (response) {
-    console.log(response); // Success
-}, function (error) {
-    console.log(error); // Failure
-});
+console.log(response);

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

@@ -0,0 +1,19 @@
+import { Client, Messaging } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
+
+const messaging = new Messaging(client);
+
+const result = await messaging.updateSms(
+    '<MESSAGE_ID>', // messageId
+    [], // topics (optional)
+    [], // users (optional)
+    [], // targets (optional)
+    '<CONTENT>', // content (optional)
+    false, // draft (optional)
+    '' // scheduledAt (optional)
+);
+
+console.log(response);

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

@@ -0,0 +1,26 @@
+import { Client, Messaging, SmtpEncryption } from "@appwrite.io/console";
+
+const client = new Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
+
+const messaging = new Messaging(client);
+
+const result = await messaging.updateSmtpProvider(
+    '<PROVIDER_ID>', // providerId
+    '<NAME>', // name (optional)
+    '<HOST>', // host (optional)
+    1, // port (optional)
+    '<USERNAME>', // username (optional)
+    '<PASSWORD>', // password (optional)
+    SmtpEncryption.None, // encryption (optional)
+    false, // autoTLS (optional)
+    '<MAILER>', // mailer (optional)
+    '<FROM_NAME>', // fromName (optional)
+    'email@example.com', // fromEmail (optional)
+    '<REPLY_TO_NAME>', // replyToName (optional)
+    '<REPLY_TO_EMAIL>', // replyToEmail (optional)
+    false // enabled (optional)
+);
+
+console.log(response);

package/docs/examples/messaging/update-telesign-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.updateTelesignProvider('[PROVIDER_ID]');
+const result = await messaging.updateTelesignProvider(
+    '<PROVIDER_ID>', // providerId
+    '<NAME>', // name (optional)
+    false, // enabled (optional)
+    '<CUSTOMER_ID>', // customerId (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);