node-appwrite 11.1.1 → 12.0.0

package/docs/examples/storage/get-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.getFile('[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.getFile(
+    '<BUCKET_ID>', // bucketId
+    '<FILE_ID>' // fileId
+);

package/docs/examples/storage/list-buckets.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
-;
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2'); // Your secret API key
 
-const promise = storage.listBuckets();
+const storage = new sdk.Storage(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const result = await storage.listBuckets(
+    [], // queries (optional)
+    '<SEARCH>' // search (optional)
+);

package/docs/examples/storage/list-files.md

@@ -1,20 +1,14 @@
 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.listFiles('[BUCKET_ID]');
+const storage = new sdk.Storage(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const result = await storage.listFiles(
+    '<BUCKET_ID>', // bucketId
+    [], // queries (optional)
+    '<SEARCH>' // search (optional)
+);

package/docs/examples/storage/update-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.updateBucket('[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.updateBucket(
+    '<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/update-file.md

@@ -1,20 +1,15 @@
 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.updateFile('[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.updateFile(
+    '<BUCKET_ID>', // bucketId
+    '<FILE_ID>', // fileId
+    '<NAME>', // name (optional)
+    ["read("any")"] // permissions (optional)
+);

package/docs/examples/teams/create-membership.md

@@ -1,20 +1,18 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const teams = new sdk.Teams(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 = teams.createMembership('[TEAM_ID]', []);
+const teams = new sdk.Teams(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const result = await teams.createMembership(
+    '<TEAM_ID>', // teamId
+    [], // roles
+    'email@example.com', // email (optional)
+    '<USER_ID>', // userId (optional)
+    '+12065550100', // phone (optional)
+    'https://example.com', // url (optional)
+    '<NAME>' // name (optional)
+);

package/docs/examples/teams/create.md

@@ -1,20 +1,14 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const teams = new sdk.Teams(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 = teams.create('[TEAM_ID]', '[NAME]');
+const teams = new sdk.Teams(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const result = await teams.create(
+    '<TEAM_ID>', // teamId
+    '<NAME>', // name
+    [] // roles (optional)
+);

package/docs/examples/teams/delete-membership.md

@@ -1,20 +1,13 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const teams = new sdk.Teams(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 = teams.deleteMembership('[TEAM_ID]', '[MEMBERSHIP_ID]');
+const teams = new sdk.Teams(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const result = await teams.deleteMembership(
+    '<TEAM_ID>', // teamId
+    '<MEMBERSHIP_ID>' // membershipId
+);

package/docs/examples/teams/delete.md

@@ -1,20 +1,12 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const teams = new sdk.Teams(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 = teams.delete('[TEAM_ID]');
+const teams = new sdk.Teams(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const result = await teams.delete(
+    '<TEAM_ID>' // teamId
+);

package/docs/examples/teams/get-membership.md

@@ -1,20 +1,13 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const teams = new sdk.Teams(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 = teams.getMembership('[TEAM_ID]', '[MEMBERSHIP_ID]');
+const teams = new sdk.Teams(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const result = await teams.getMembership(
+    '<TEAM_ID>', // teamId
+    '<MEMBERSHIP_ID>' // membershipId
+);

package/docs/examples/teams/get-prefs.md

@@ -1,20 +1,12 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const teams = new sdk.Teams(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 = teams.getPrefs('[TEAM_ID]');
+const teams = new sdk.Teams(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const result = await teams.getPrefs(
+    '<TEAM_ID>' // teamId
+);

package/docs/examples/teams/get.md

@@ -1,20 +1,12 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const teams = new sdk.Teams(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 = teams.get('[TEAM_ID]');
+const teams = new sdk.Teams(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const result = await teams.get(
+    '<TEAM_ID>' // teamId
+);

package/docs/examples/teams/list-memberships.md

@@ -1,20 +1,14 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const teams = new sdk.Teams(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 = teams.listMemberships('[TEAM_ID]');
+const teams = new sdk.Teams(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const result = await teams.listMemberships(
+    '<TEAM_ID>', // teamId
+    [], // queries (optional)
+    '<SEARCH>' // search (optional)
+);

package/docs/examples/teams/list.md

@@ -1,20 +1,13 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const teams = new sdk.Teams(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 = teams.list();
+const teams = new sdk.Teams(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const result = await teams.list(
+    [], // queries (optional)
+    '<SEARCH>' // search (optional)
+);

package/docs/examples/teams/update-membership-status.md

@@ -1,20 +1,15 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const teams = new sdk.Teams(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 = teams.updateMembershipStatus('[TEAM_ID]', '[MEMBERSHIP_ID]', '[USER_ID]', '[SECRET]');
+const teams = new sdk.Teams(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const result = await teams.updateMembershipStatus(
+    '<TEAM_ID>', // teamId
+    '<MEMBERSHIP_ID>', // membershipId
+    '<USER_ID>', // userId
+    '<SECRET>' // secret
+);

package/docs/examples/teams/update-membership.md

@@ -1,20 +1,14 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const teams = new sdk.Teams(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 = teams.updateMembership('[TEAM_ID]', '[MEMBERSHIP_ID]', []);
+const teams = new sdk.Teams(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const result = await teams.updateMembership(
+    '<TEAM_ID>', // teamId
+    '<MEMBERSHIP_ID>', // membershipId
+    [] // roles
+);

package/docs/examples/teams/update-name.md

@@ -1,20 +1,13 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const teams = new sdk.Teams(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 = teams.updateName('[TEAM_ID]', '[NAME]');
+const teams = new sdk.Teams(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const result = await teams.updateName(
+    '<TEAM_ID>', // teamId
+    '<NAME>' // name
+);

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

@@ -1,20 +1,13 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const teams = new sdk.Teams(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 = teams.updatePrefs('[TEAM_ID]', {});
+const teams = new sdk.Teams(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const result = await teams.updatePrefs(
+    '<TEAM_ID>', // teamId
+    {} // prefs
+);

package/docs/examples/users/create-argon2user.md

@@ -1,20 +1,15 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const users = new sdk.Users(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 = users.createArgon2User('[USER_ID]', 'email@example.com', 'password');
+const users = new sdk.Users(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const result = await users.createArgon2User(
+    '<USER_ID>', // userId
+    'email@example.com', // email
+    'password', // password
+    '<NAME>' // name (optional)
+);

package/docs/examples/users/create-bcrypt-user.md

@@ -1,20 +1,15 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const users = new sdk.Users(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 = users.createBcryptUser('[USER_ID]', 'email@example.com', 'password');
+const users = new sdk.Users(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const result = await users.createBcryptUser(
+    '<USER_ID>', // userId
+    'email@example.com', // email
+    'password', // password
+    '<NAME>' // name (optional)
+);

package/docs/examples/users/create-m-d5user.md

@@ -1,20 +1,15 @@
 const sdk = require('node-appwrite');
 
-// Init SDK
-const client = new sdk.Client();
-
-const users = new sdk.Users(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 = users.createMD5User('[USER_ID]', 'email@example.com', 'password');
+const users = new sdk.Users(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const result = await users.createMD5User(
+    '<USER_ID>', // userId
+    'email@example.com', // email
+    'password', // password
+    '<NAME>' // name (optional)
+);

package/docs/examples/users/create-mfa-recovery-codes.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 users = new sdk.Users(client);
+
+const result = await users.createMfaRecoveryCodes(
+    '<USER_ID>' // userId
+);