node-appwrite 11.0.0 → 12.0.0-rc.4

package/docs/examples/account/update-password.md

@@ -1,20 +1,13 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const account = new sdk.Account(client);
-
-client
+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
-;
+    .setSession(''); // The user session to authenticate with
 
-const promise = account.updatePassword('');
+const account = new sdk.Account(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await account.updatePassword(
+    '', // password
+    'password' // oldPassword (optional)
+);

package/docs/examples/account/update-phone-verification.md

@@ -1,20 +1,13 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const account = new sdk.Account(client);
-
-client
+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
-;
+    .setSession(''); // The user session to authenticate with
 
-const promise = account.updatePhoneVerification('[USER_ID]', '[SECRET]');
+const account = new sdk.Account(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await account.updatePhoneVerification(
+    '[USER_ID]', // userId
+    '[SECRET]' // secret
+);

package/docs/examples/account/update-phone.md

@@ -1,20 +1,13 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const account = new sdk.Account(client);
-
-client
+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
-;
+    .setSession(''); // The user session to authenticate with
 
-const promise = account.updatePhone('+12065550100', 'password');
+const account = new sdk.Account(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await account.updatePhone(
+    '+12065550100', // phone
+    'password' // password
+);

package/docs/examples/account/update-prefs.md

@@ -1,20 +1,12 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const account = new sdk.Account(client);
-
-client
+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
-;
+    .setSession(''); // The user session to authenticate with
 
-const promise = account.updatePrefs({});
+const account = new sdk.Account(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await account.updatePrefs(
+    {} // prefs
+);

package/docs/examples/account/update-recovery.md

@@ -1,20 +1,14 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const account = new sdk.Account(client);
-
-client
+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
-;
+    .setSession(''); // The user session to authenticate with
 
-const promise = account.updateRecovery('[USER_ID]', '[SECRET]', 'password', 'password');
+const account = new sdk.Account(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await account.updateRecovery(
+    '[USER_ID]', // userId
+    '[SECRET]', // secret
+    '' // password
+);

package/docs/examples/account/update-session.md

@@ -1,20 +1,12 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const account = new sdk.Account(client);
-
-client
+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
-;
+    .setSession(''); // The user session to authenticate with
 
-const promise = account.updateSession('[SESSION_ID]');
+const account = new sdk.Account(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await account.updateSession(
+    '[SESSION_ID]' // sessionId
+);

package/docs/examples/account/update-status.md

@@ -1,20 +1,10 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const account = new sdk.Account(client);
-
-client
+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
-;
+    .setSession(''); // The user session to authenticate with
 
-const promise = account.updateStatus();
+const account = new sdk.Account(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await account.updateStatus();

package/docs/examples/account/update-verification.md

@@ -1,20 +1,13 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const account = new sdk.Account(client);
-
-client
+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
-;
+    .setSession(''); // The user session to authenticate with
 
-const promise = account.updateVerification('[USER_ID]', '[SECRET]');
+const account = new sdk.Account(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await account.updateVerification(
+    '[USER_ID]', // userId
+    '[SECRET]' // secret
+);

package/docs/examples/account/verify-authenticator.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
+    .setSession(''); // The user session to authenticate with
+
+const account = new sdk.Account(client);
+
+const response = await account.verifyAuthenticator(
+    sdk.AuthenticatorType.Totp, // type
+    '[OTP]' // otp
+);

package/docs/examples/avatars/get-browser.md

@@ -1,20 +1,15 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const avatars = new sdk.Avatars(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 = avatars.getBrowser('aa');
+const avatars = new sdk.Avatars(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await avatars.getBrowser(
+    sdk.Browser.AvantBrowser, // code
+    0, // width (optional)
+    0, // height (optional)
+    0 // quality (optional)
+);

package/docs/examples/avatars/get-credit-card.md

@@ -1,20 +1,15 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const avatars = new sdk.Avatars(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 = avatars.getCreditCard('amex');
+const avatars = new sdk.Avatars(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await avatars.getCreditCard(
+    sdk.CreditCard.AmericanExpress, // code
+    0, // width (optional)
+    0, // height (optional)
+    0 // quality (optional)
+);

package/docs/examples/avatars/get-favicon.md

@@ -1,20 +1,12 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const avatars = new sdk.Avatars(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 = avatars.getFavicon('https://example.com');
+const avatars = new sdk.Avatars(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await avatars.getFavicon(
+    'https://example.com' // url
+);

package/docs/examples/avatars/get-flag.md

@@ -1,20 +1,15 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const avatars = new sdk.Avatars(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 = avatars.getFlag('af');
+const avatars = new sdk.Avatars(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await avatars.getFlag(
+    sdk.Flag.Afghanistan, // code
+    0, // width (optional)
+    0, // height (optional)
+    0 // quality (optional)
+);

package/docs/examples/avatars/get-image.md

@@ -1,20 +1,14 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const avatars = new sdk.Avatars(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 = avatars.getImage('https://example.com');
+const avatars = new sdk.Avatars(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await avatars.getImage(
+    'https://example.com', // url
+    0, // width (optional)
+    0 // height (optional)
+);

package/docs/examples/avatars/get-initials.md

@@ -1,20 +1,15 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const avatars = new sdk.Avatars(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 = avatars.getInitials();
+const avatars = new sdk.Avatars(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await avatars.getInitials(
+    '[NAME]', // name (optional)
+    0, // width (optional)
+    0, // height (optional)
+    '' // background (optional)
+);

package/docs/examples/avatars/get-q-r.md

@@ -1,20 +1,15 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const avatars = new sdk.Avatars(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 = avatars.getQR('[TEXT]');
+const avatars = new sdk.Avatars(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await avatars.getQR(
+    '[TEXT]', // text
+    1, // size (optional)
+    0, // margin (optional)
+    false // download (optional)
+);

package/docs/examples/databases/create-boolean-attribute.md

@@ -1,20 +1,17 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const databases = new sdk.Databases(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 = databases.createBooleanAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false);
+const databases = new sdk.Databases(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await databases.createBooleanAttribute(
+    '[DATABASE_ID]', // databaseId
+    '[COLLECTION_ID]', // collectionId
+    '', // key
+    false, // required
+    false, // default (optional)
+    false // array (optional)
+);

package/docs/examples/databases/create-collection.md

@@ -1,20 +1,17 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const databases = new sdk.Databases(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 = databases.createCollection('[DATABASE_ID]', '[COLLECTION_ID]', '[NAME]');
+const databases = new sdk.Databases(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await databases.createCollection(
+    '[DATABASE_ID]', // databaseId
+    '[COLLECTION_ID]', // collectionId
+    '[NAME]', // name
+    ["read("any")"], // permissions (optional)
+    false, // documentSecurity (optional)
+    false // enabled (optional)
+);

package/docs/examples/databases/create-datetime-attribute.md

@@ -1,20 +1,17 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const databases = new sdk.Databases(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 = databases.createDatetimeAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false);
+const databases = new sdk.Databases(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await databases.createDatetimeAttribute(
+    '[DATABASE_ID]', // databaseId
+    '[COLLECTION_ID]', // collectionId
+    '', // key
+    false, // required
+    '', // default (optional)
+    false // array (optional)
+);

package/docs/examples/databases/create-document.md

@@ -1,20 +1,16 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const databases = new sdk.Databases(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 = databases.createDocument('[DATABASE_ID]', '[COLLECTION_ID]', '[DOCUMENT_ID]', {});
+const databases = new sdk.Databases(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await databases.createDocument(
+    '[DATABASE_ID]', // databaseId
+    '[COLLECTION_ID]', // collectionId
+    '[DOCUMENT_ID]', // documentId
+    {}, // data
+    ["read("any")"] // permissions (optional)
+);

package/docs/examples/databases/create-email-attribute.md

@@ -1,20 +1,17 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const databases = new sdk.Databases(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 = databases.createEmailAttribute('[DATABASE_ID]', '[COLLECTION_ID]', '', false);
+const databases = new sdk.Databases(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await databases.createEmailAttribute(
+    '[DATABASE_ID]', // databaseId
+    '[COLLECTION_ID]', // collectionId
+    '', // key
+    false, // required
+    'email@example.com', // default (optional)
+    false // array (optional)
+);