node-appwrite 11.1.1 → 12.0.0

package/docs/examples/locale/list-codes.md

@@ -1,20 +1,10 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const locale = new sdk.Locale(client);
-
-client
+const client = new sdk.Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
-;
+    .setSession(''); // The user session to authenticate with
 
-const promise = locale.listCodes();
+const locale = new sdk.Locale(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const result = await locale.listCodes();

package/docs/examples/locale/list-continents.md

@@ -1,20 +1,10 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const locale = new sdk.Locale(client);
-
-client
+const client = new sdk.Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
-;
+    .setSession(''); // The user session to authenticate with
 
-const promise = locale.listContinents();
+const locale = new sdk.Locale(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const result = await locale.listContinents();

package/docs/examples/locale/list-countries-e-u.md

@@ -1,20 +1,10 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const locale = new sdk.Locale(client);
-
-client
+const client = new sdk.Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
-;
+    .setSession(''); // The user session to authenticate with
 
-const promise = locale.listCountriesEU();
+const locale = new sdk.Locale(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const result = await locale.listCountriesEU();

package/docs/examples/locale/list-countries-phones.md

@@ -1,20 +1,10 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const locale = new sdk.Locale(client);
-
-client
+const client = new sdk.Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
-;
+    .setSession(''); // The user session to authenticate with
 
-const promise = locale.listCountriesPhones();
+const locale = new sdk.Locale(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const result = await locale.listCountriesPhones();

package/docs/examples/locale/list-countries.md

@@ -1,20 +1,10 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const locale = new sdk.Locale(client);
-
-client
+const client = new sdk.Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
-;
+    .setSession(''); // The user session to authenticate with
 
-const promise = locale.listCountries();
+const locale = new sdk.Locale(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const result = await locale.listCountries();

package/docs/examples/locale/list-currencies.md

@@ -1,20 +1,10 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const locale = new sdk.Locale(client);
-
-client
+const client = new sdk.Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
-;
+    .setSession(''); // The user session to authenticate with
 
-const promise = locale.listCurrencies();
+const locale = new sdk.Locale(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const result = await locale.listCurrencies();

package/docs/examples/locale/list-languages.md

@@ -1,20 +1,10 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const locale = new sdk.Locale(client);
-
-client
+const client = new sdk.Client()
     .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
-;
+    .setSession(''); // The user session to authenticate with
 
-const promise = locale.listLanguages();
+const locale = new sdk.Locale(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const result = await locale.listLanguages();

package/docs/examples/messaging/create-apns-provider.md

@@ -0,0 +1,19 @@
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
+
+const messaging = new sdk.Messaging(client);
+
+const result = await messaging.createApnsProvider(
+    '<PROVIDER_ID>', // providerId
+    '<NAME>', // name
+    '<AUTH_KEY>', // authKey (optional)
+    '<AUTH_KEY_ID>', // authKeyId (optional)
+    '<TEAM_ID>', // teamId (optional)
+    '<BUNDLE_ID>', // bundleId (optional)
+    false, // sandbox (optional)
+    false // enabled (optional)
+);

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

@@ -0,0 +1,23 @@
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
+
+const messaging = new sdk.Messaging(client);
+
+const result = await messaging.createEmail(
+    '<MESSAGE_ID>', // messageId
+    '<SUBJECT>', // subject
+    '<CONTENT>', // content
+    [], // topics (optional)
+    [], // users (optional)
+    [], // targets (optional)
+    [], // cc (optional)
+    [], // bcc (optional)
+    [], // attachments (optional)
+    false, // draft (optional)
+    false, // html (optional)
+    '' // scheduledAt (optional)
+);

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

@@ -0,0 +1,15 @@
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
+
+const messaging = new sdk.Messaging(client);
+
+const result = await messaging.createFcmProvider(
+    '<PROVIDER_ID>', // providerId
+    '<NAME>', // name
+    {}, // serviceAccountJSON (optional)
+    false // enabled (optional)
+);

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

@@ -0,0 +1,21 @@
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
+
+const messaging = new sdk.Messaging(client);
+
+const result = await messaging.createMailgunProvider(
+    '<PROVIDER_ID>', // providerId
+    '<NAME>', // name
+    '<API_KEY>', // apiKey (optional)
+    '<DOMAIN>', // domain (optional)
+    false, // isEuRegion (optional)
+    '<FROM_NAME>', // fromName (optional)
+    'email@example.com', // fromEmail (optional)
+    '<REPLY_TO_NAME>', // replyToName (optional)
+    'email@example.com', // replyToEmail (optional)
+    false // enabled (optional)
+);

package/docs/examples/messaging/create-msg91provider.md

@@ -0,0 +1,17 @@
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
+
+const messaging = new sdk.Messaging(client);
+
+const result = await messaging.createMsg91Provider(
+    '<PROVIDER_ID>', // providerId
+    '<NAME>', // name
+    '+12065550100', // from (optional)
+    '<SENDER_ID>', // senderId (optional)
+    '<AUTH_KEY>', // authKey (optional)
+    false // enabled (optional)
+);

package/docs/examples/messaging/create-push.md

@@ -0,0 +1,27 @@
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
+
+const messaging = new sdk.Messaging(client);
+
+const result = await messaging.createPush(
+    '<MESSAGE_ID>', // messageId
+    '<TITLE>', // title
+    '<BODY>', // body
+    [], // topics (optional)
+    [], // users (optional)
+    [], // targets (optional)
+    {}, // data (optional)
+    '<ACTION>', // action (optional)
+    '[ID1:ID2]', // image (optional)
+    '<ICON>', // icon (optional)
+    '<SOUND>', // sound (optional)
+    '<COLOR>', // color (optional)
+    '<TAG>', // tag (optional)
+    '<BADGE>', // badge (optional)
+    false, // draft (optional)
+    '' // scheduledAt (optional)
+);

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

@@ -0,0 +1,19 @@
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
+
+const messaging = new sdk.Messaging(client);
+
+const result = await messaging.createSendgridProvider(
+    '<PROVIDER_ID>', // providerId
+    '<NAME>', // name
+    '<API_KEY>', // apiKey (optional)
+    '<FROM_NAME>', // fromName (optional)
+    'email@example.com', // fromEmail (optional)
+    '<REPLY_TO_NAME>', // replyToName (optional)
+    'email@example.com', // replyToEmail (optional)
+    false // enabled (optional)
+);

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

@@ -0,0 +1,18 @@
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
+
+const messaging = new sdk.Messaging(client);
+
+const result = await messaging.createSms(
+    '<MESSAGE_ID>', // messageId
+    '<CONTENT>', // content
+    [], // topics (optional)
+    [], // users (optional)
+    [], // targets (optional)
+    false, // draft (optional)
+    '' // scheduledAt (optional)
+);

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

@@ -0,0 +1,25 @@
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
+
+const messaging = new sdk.Messaging(client);
+
+const result = await messaging.createSmtpProvider(
+    '<PROVIDER_ID>', // providerId
+    '<NAME>', // name
+    '<HOST>', // host
+    1, // port (optional)
+    '<USERNAME>', // username (optional)
+    '<PASSWORD>', // password (optional)
+    sdk.SmtpEncryption.None, // encryption (optional)
+    false, // autoTLS (optional)
+    '<MAILER>', // mailer (optional)
+    '<FROM_NAME>', // fromName (optional)
+    'email@example.com', // fromEmail (optional)
+    '<REPLY_TO_NAME>', // replyToName (optional)
+    'email@example.com', // replyToEmail (optional)
+    false // enabled (optional)
+);

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

@@ -0,0 +1,14 @@
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setJWT('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...'); // Your secret JSON Web Token
+
+const messaging = new sdk.Messaging(client);
+
+const result = await messaging.createSubscriber(
+    '<TOPIC_ID>', // topicId
+    '<SUBSCRIBER_ID>', // subscriberId
+    '<TARGET_ID>' // targetId
+);

package/docs/examples/messaging/create-telesign-provider.md

@@ -0,0 +1,17 @@
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
+
+const messaging = new sdk.Messaging(client);
+
+const result = await messaging.createTelesignProvider(
+    '<PROVIDER_ID>', // providerId
+    '<NAME>', // name
+    '+12065550100', // from (optional)
+    '<CUSTOMER_ID>', // customerId (optional)
+    '<API_KEY>', // apiKey (optional)
+    false // enabled (optional)
+);

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

@@ -0,0 +1,17 @@
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
+
+const messaging = new sdk.Messaging(client);
+
+const result = await messaging.createTextmagicProvider(
+    '<PROVIDER_ID>', // providerId
+    '<NAME>', // name
+    '+12065550100', // from (optional)
+    '<USERNAME>', // username (optional)
+    '<API_KEY>', // apiKey (optional)
+    false // enabled (optional)
+);

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

@@ -0,0 +1,14 @@
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
+
+const messaging = new sdk.Messaging(client);
+
+const result = await messaging.createTopic(
+    '<TOPIC_ID>', // topicId
+    '<NAME>', // name
+    ["any"] // subscribe (optional)
+);

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

@@ -0,0 +1,17 @@
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
+
+const messaging = new sdk.Messaging(client);
+
+const result = await messaging.createTwilioProvider(
+    '<PROVIDER_ID>', // providerId
+    '<NAME>', // name
+    '+12065550100', // from (optional)
+    '<ACCOUNT_SID>', // accountSid (optional)
+    '<AUTH_TOKEN>', // authToken (optional)
+    false // enabled (optional)
+);

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

@@ -0,0 +1,17 @@
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
+
+const messaging = new sdk.Messaging(client);
+
+const result = await messaging.createVonageProvider(
+    '<PROVIDER_ID>', // providerId
+    '<NAME>', // name
+    '+12065550100', // from (optional)
+    '<API_KEY>', // apiKey (optional)
+    '<API_SECRET>', // apiSecret (optional)
+    false // enabled (optional)
+);

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

@@ -0,0 +1,12 @@
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
+
+const messaging = new sdk.Messaging(client);
+
+const result = await messaging.deleteProvider(
+    '<PROVIDER_ID>' // providerId
+);

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

@@ -0,0 +1,13 @@
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setJWT('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...'); // Your secret JSON Web Token
+
+const messaging = new sdk.Messaging(client);
+
+const result = await messaging.deleteSubscriber(
+    '<TOPIC_ID>', // topicId
+    '<SUBSCRIBER_ID>' // subscriberId
+);

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

@@ -0,0 +1,12 @@
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
+
+const messaging = new sdk.Messaging(client);
+
+const result = await messaging.deleteTopic(
+    '<TOPIC_ID>' // topicId
+);

package/docs/examples/messaging/delete.md

@@ -0,0 +1,12 @@
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
+
+const messaging = new sdk.Messaging(client);
+
+const result = await messaging.delete(
+    '<MESSAGE_ID>' // messageId
+);

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

@@ -0,0 +1,12 @@
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
+
+const messaging = new sdk.Messaging(client);
+
+const result = await messaging.getMessage(
+    '<MESSAGE_ID>' // messageId
+);

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

@@ -0,0 +1,12 @@
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
+
+const messaging = new sdk.Messaging(client);
+
+const result = await messaging.getProvider(
+    '<PROVIDER_ID>' // providerId
+);

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

@@ -0,0 +1,13 @@
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
+
+const messaging = new sdk.Messaging(client);
+
+const result = await messaging.getSubscriber(
+    '<TOPIC_ID>', // topicId
+    '<SUBSCRIBER_ID>' // subscriberId
+);

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

@@ -0,0 +1,12 @@
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
+
+const messaging = new sdk.Messaging(client);
+
+const result = await messaging.getTopic(
+    '<TOPIC_ID>' // topicId
+);

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

@@ -0,0 +1,13 @@
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
+
+const messaging = new sdk.Messaging(client);
+
+const result = await messaging.listMessageLogs(
+    '<MESSAGE_ID>', // messageId
+    [] // queries (optional)
+);

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

@@ -0,0 +1,13 @@
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
+
+const messaging = new sdk.Messaging(client);
+
+const result = await messaging.listMessages(
+    [], // queries (optional)
+    '<SEARCH>' // search (optional)
+);

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

@@ -0,0 +1,13 @@
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
+
+const messaging = new sdk.Messaging(client);
+
+const result = await messaging.listProviderLogs(
+    '<PROVIDER_ID>', // providerId
+    [] // queries (optional)
+);