node-appwrite 11.1.1 → 12.0.0

package/docs/examples/messaging/list-providers.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.listProviders(
+    [], // queries (optional)
+    '<SEARCH>' // search (optional)
+);

package/docs/examples/messaging/list-subscriber-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.listSubscriberLogs(
+    '<SUBSCRIBER_ID>', // subscriberId
+    [] // queries (optional)
+);

package/docs/examples/messaging/list-subscribers.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.listSubscribers(
+    '<TOPIC_ID>', // topicId
+    [], // queries (optional)
+    '<SEARCH>' // search (optional)
+);

package/docs/examples/messaging/list-targets.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.listTargets(
+    '<MESSAGE_ID>', // messageId
+    [] // queries (optional)
+);

package/docs/examples/messaging/list-topic-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.listTopicLogs(
+    '<TOPIC_ID>', // topicId
+    [] // queries (optional)
+);

package/docs/examples/messaging/list-topics.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.listTopics(
+    [], // queries (optional)
+    '<SEARCH>' // search (optional)
+);

package/docs/examples/messaging/update-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.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)
+);

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

@@ -0,0 +1,22 @@
+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.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)
+);

package/docs/examples/messaging/update-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.updateFcmProvider(
+    '<PROVIDER_ID>', // providerId
+    '<NAME>', // name (optional)
+    false, // enabled (optional)
+    {} // serviceAccountJSON (optional)
+);

package/docs/examples/messaging/update-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.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)
+);

package/docs/examples/messaging/update-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.updateMsg91Provider(
+    '<PROVIDER_ID>', // providerId
+    '<NAME>', // name (optional)
+    false, // enabled (optional)
+    '<SENDER_ID>', // senderId (optional)
+    '<AUTH_KEY>', // authKey (optional)
+    '<FROM>' // from (optional)
+);

package/docs/examples/messaging/update-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.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)
+);

package/docs/examples/messaging/update-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.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)
+);

package/docs/examples/messaging/update-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.updateSms(
+    '<MESSAGE_ID>', // messageId
+    [], // topics (optional)
+    [], // users (optional)
+    [], // targets (optional)
+    '<CONTENT>', // content (optional)
+    false, // draft (optional)
+    '' // scheduledAt (optional)
+);

package/docs/examples/messaging/update-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.updateSmtpProvider(
+    '<PROVIDER_ID>', // providerId
+    '<NAME>', // name (optional)
+    '<HOST>', // host (optional)
+    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)
+    '<REPLY_TO_EMAIL>', // replyToEmail (optional)
+    false // enabled (optional)
+);

package/docs/examples/messaging/update-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.updateTelesignProvider(
+    '<PROVIDER_ID>', // providerId
+    '<NAME>', // name (optional)
+    false, // enabled (optional)
+    '<CUSTOMER_ID>', // customerId (optional)
+    '<API_KEY>', // apiKey (optional)
+    '<FROM>' // from (optional)
+);

package/docs/examples/messaging/update-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.updateTextmagicProvider(
+    '<PROVIDER_ID>', // providerId
+    '<NAME>', // name (optional)
+    false, // enabled (optional)
+    '<USERNAME>', // username (optional)
+    '<API_KEY>', // apiKey (optional)
+    '<FROM>' // from (optional)
+);

package/docs/examples/messaging/update-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.updateTopic(
+    '<TOPIC_ID>', // topicId
+    '<NAME>', // name (optional)
+    ["any"] // subscribe (optional)
+);

package/docs/examples/messaging/update-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.updateTwilioProvider(
+    '<PROVIDER_ID>', // providerId
+    '<NAME>', // name (optional)
+    false, // enabled (optional)
+    '<ACCOUNT_SID>', // accountSid (optional)
+    '<AUTH_TOKEN>', // authToken (optional)
+    '<FROM>' // from (optional)
+);

package/docs/examples/messaging/update-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.updateVonageProvider(
+    '<PROVIDER_ID>', // providerId
+    '<NAME>', // name (optional)
+    false, // enabled (optional)
+    '<API_KEY>', // apiKey (optional)
+    '<API_SECRET>', // apiSecret (optional)
+    '<FROM>' // from (optional)
+);

package/docs/examples/storage/create-bucket.md

@@ -1,20 +1,21 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const storage = new sdk.Storage(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
-;
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
 
-const promise = storage.createBucket('[BUCKET_ID]', '[NAME]');
+const storage = new sdk.Storage(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const result = await storage.createBucket(
+    '<BUCKET_ID>', // bucketId
+    '<NAME>', // name
+    ["read("any")"], // permissions (optional)
+    false, // fileSecurity (optional)
+    false, // enabled (optional)
+    1, // maximumFileSize (optional)
+    [], // allowedFileExtensions (optional)
+    sdk..None, // compression (optional)
+    false, // encryption (optional)
+    false // antivirus (optional)
+);

package/docs/examples/storage/create-file.md

@@ -1,21 +1,16 @@
 const sdk = require('node-appwrite');
 const fs = require('fs');
 
-// Init SDK
-const client = new sdk.Client();
-
-const storage = new sdk.Storage(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 = storage.createFile('[BUCKET_ID]', '[FILE_ID]', InputFile.fromPath('/path/to/file.png', 'file.png'));
+const storage = new sdk.Storage(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const result = await storage.createFile(
+    '<BUCKET_ID>', // bucketId
+    '<FILE_ID>', // fileId
+    InputFile.fromPath('/path/to/file.png', 'file.png'), // file
+    ["read("any")"] // permissions (optional)
+);

package/docs/examples/storage/delete-bucket.md

@@ -1,20 +1,12 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const storage = new sdk.Storage(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
-;
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
 
-const promise = storage.deleteBucket('[BUCKET_ID]');
+const storage = new sdk.Storage(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const result = await storage.deleteBucket(
+    '<BUCKET_ID>' // bucketId
+);

package/docs/examples/storage/delete-file.md

@@ -1,20 +1,13 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const storage = new sdk.Storage(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 = storage.deleteFile('[BUCKET_ID]', '[FILE_ID]');
+const storage = new sdk.Storage(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const result = await storage.deleteFile(
+    '<BUCKET_ID>', // bucketId
+    '<FILE_ID>' // fileId
+);

package/docs/examples/storage/get-bucket.md

@@ -1,20 +1,12 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const storage = new sdk.Storage(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
-;
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
 
-const promise = storage.getBucket('[BUCKET_ID]');
+const storage = new sdk.Storage(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const result = await storage.getBucket(
+    '<BUCKET_ID>' // bucketId
+);

package/docs/examples/storage/get-file-download.md

@@ -1,20 +1,13 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const storage = new sdk.Storage(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 = storage.getFileDownload('[BUCKET_ID]', '[FILE_ID]');
+const storage = new sdk.Storage(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const result = await storage.getFileDownload(
+    '<BUCKET_ID>', // bucketId
+    '<FILE_ID>' // fileId
+);

package/docs/examples/storage/get-file-preview.md

@@ -1,20 +1,24 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const storage = new sdk.Storage(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 = storage.getFilePreview('[BUCKET_ID]', '[FILE_ID]');
+const storage = new sdk.Storage(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const result = await storage.getFilePreview(
+    '<BUCKET_ID>', // bucketId
+    '<FILE_ID>', // fileId
+    0, // width (optional)
+    0, // height (optional)
+    sdk.ImageGravity.Center, // gravity (optional)
+    0, // quality (optional)
+    0, // borderWidth (optional)
+    '', // borderColor (optional)
+    0, // borderRadius (optional)
+    0, // opacity (optional)
+    -360, // rotation (optional)
+    '', // background (optional)
+    sdk.ImageFormat.Jpg // output (optional)
+);

package/docs/examples/storage/get-file-view.md

@@ -1,20 +1,13 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const storage = new sdk.Storage(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 = storage.getFileView('[BUCKET_ID]', '[FILE_ID]');
+const storage = new sdk.Storage(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const result = await storage.getFileView(
+    '<BUCKET_ID>', // bucketId
+    '<FILE_ID>' // fileId
+);