node-appwrite 11.0.0 → 12.0.0-rc.4

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 response = 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 response = 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 response = 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 response = 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 response = 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 response = 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 response = 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 response = 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 response = 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 response = 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 response = 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 response = 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 response = 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 response = await users.createMD5User(
+    '[USER_ID]', // userId
+    'email@example.com', // email
+    'password', // password
+    '[NAME]' // name (optional)
+);

package/docs/examples/users/create-p-h-pass-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.createPHPassUser('[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 response = await users.createPHPassUser(
+    '[USER_ID]', // userId
+    'email@example.com', // email
+    'password', // password
+    '[NAME]' // name (optional)
+);

package/docs/examples/users/create-s-h-a-user.md

@@ -1,20 +1,16 @@
 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.createSHAUser('[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 response = await users.createSHAUser(
+    '[USER_ID]', // userId
+    'email@example.com', // email
+    'password', // password
+    sdk.PasswordHash.Sha1, // passwordVersion (optional)
+    '[NAME]' // name (optional)
+);

package/docs/examples/users/create-scrypt-modified-user.md

@@ -1,20 +1,18 @@
 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.createScryptModifiedUser('[USER_ID]', 'email@example.com', 'password', '[PASSWORD_SALT]', '[PASSWORD_SALT_SEPARATOR]', '[PASSWORD_SIGNER_KEY]');
+const users = new sdk.Users(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await users.createScryptModifiedUser(
+    '[USER_ID]', // userId
+    'email@example.com', // email
+    'password', // password
+    '[PASSWORD_SALT]', // passwordSalt
+    '[PASSWORD_SALT_SEPARATOR]', // passwordSaltSeparator
+    '[PASSWORD_SIGNER_KEY]', // passwordSignerKey
+    '[NAME]' // name (optional)
+);

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

@@ -1,20 +1,20 @@
 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.createScryptUser('[USER_ID]', 'email@example.com', 'password', '[PASSWORD_SALT]', null, null, null, null);
+const users = new sdk.Users(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await users.createScryptUser(
+    '[USER_ID]', // userId
+    'email@example.com', // email
+    'password', // password
+    '[PASSWORD_SALT]', // passwordSalt
+    null, // passwordCpu
+    null, // passwordMemory
+    null, // passwordParallel
+    null, // passwordLength
+    '[NAME]' // name (optional)
+);

package/docs/examples/users/create-session.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 response = await users.createSession(
+    '[USER_ID]' // userId
+);

package/docs/examples/users/create-target.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 users = new sdk.Users(client);
+
+const response = await users.createTarget(
+    '[USER_ID]', // userId
+    '[TARGET_ID]', // targetId
+    sdk.MessagingProviderType.Email, // providerType
+    '[IDENTIFIER]', // identifier
+    '[PROVIDER_ID]', // providerId (optional)
+    '[NAME]' // name (optional)
+);

package/docs/examples/users/create-token.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 users = new sdk.Users(client);
+
+const response = await users.createToken(
+    '[USER_ID]', // userId
+    4, // length (optional)
+    60 // expire (optional)
+);

package/docs/examples/users/create.md

@@ -1,20 +1,16 @@
 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.create('[USER_ID]');
+const users = new sdk.Users(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await users.create(
+    '[USER_ID]', // userId
+    'email@example.com', // email (optional)
+    '+12065550100', // phone (optional)
+    '', // password (optional)
+    '[NAME]' // name (optional)
+);

package/docs/examples/users/delete-authenticator.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 users = new sdk.Users(client);
+
+const response = await users.deleteAuthenticator(
+    '[USER_ID]', // userId
+    sdk.AuthenticatorType.Totp, // type
+    '[OTP]' // otp
+);