node-appwrite 11.1.0 → 12.0.0-rc.4

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2023 Appwrite (https://appwrite.io) and individual contributors.
+Copyright (c) 2024 Appwrite (https://appwrite.io) and individual contributors.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

package/README.md

@@ -1,12 +1,12 @@
 # Appwrite Node.js SDK
 
 ![License](https://img.shields.io/github/license/appwrite/sdk-for-node.svg?style=flat-square)
-![Version](https://img.shields.io/badge/api%20version-1.4.12-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-1.5.0-blue.svg?style=flat-square)
 [![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator)
 [![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite)
 [![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)
 
-**This SDK is compatible with Appwrite server version 1.4.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-node/releases).**
+**This SDK is compatible with Appwrite server version 1.5.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-node/releases).**
 
  > This is the Node.js SDK for integrating with Appwrite from your Node.js server-side code.
                             If you're looking to integrate from the browser, you should check [appwrite/sdk-for-web](https://github.com/appwrite/sdk-for-web)

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

package/docs/examples/account/create-anonymous-session.md

@@ -0,0 +1,9 @@
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
+
+const account = new sdk.Account(client);
+
+const response = await account.createAnonymousSession();

package/docs/examples/account/create-email-password-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
+
+const account = new sdk.Account(client);
+
+const response = await account.createEmailPasswordSession(
+    'email@example.com', // email
+    'password' // password
+);

package/docs/examples/account/create-email-token.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
+
+const account = new sdk.Account(client);
+
+const response = await account.createEmailToken(
+    '[USER_ID]', // userId
+    'email@example.com', // email
+    false // phrase (optional)
+);

package/docs/examples/account/create-j-w-t.md

@@ -0,0 +1,9 @@
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
+
+const account = new sdk.Account(client);
+
+const response = await account.createJWT();

package/docs/examples/account/create-magic-u-r-l-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
+
+const account = new sdk.Account(client);
+
+const response = await account.createMagicURLToken(
+    '[USER_ID]', // userId
+    'email@example.com', // email
+    'https://example.com', // url (optional)
+    false // phrase (optional)
+);

package/docs/examples/account/create-o-auth2session.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
+
+const account = new sdk.Account(client);
+
+const response = await account.createOAuth2Session(
+    sdk.OAuthProvider.Amazon, // provider
+    'https://example.com', // success (optional)
+    'https://example.com', // failure (optional)
+    false, // token (optional)
+    [] // scopes (optional)
+);

package/docs/examples/account/create-phone-token.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
+
+const account = new sdk.Account(client);
+
+const response = await account.createPhoneToken(
+    '[USER_ID]', // userId
+    '+12065550100' // phone
+);

package/docs/examples/account/create-phone-verification.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.createPhoneVerification();
+const account = new sdk.Account(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await account.createPhoneVerification();

package/docs/examples/account/create-recovery.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.createRecovery('email@example.com', 'https://example.com');
+const account = new sdk.Account(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await account.createRecovery(
+    'email@example.com', // email
+    'https://example.com' // url
+);

package/docs/examples/account/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
+
+const account = new sdk.Account(client);
+
+const response = await account.createSession(
+    '[USER_ID]', // userId
+    '[SECRET]' // secret
+);

package/docs/examples/account/create-verification.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.createVerification('https://example.com');
+const account = new sdk.Account(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await account.createVerification(
+    'https://example.com' // url
+);

package/docs/examples/account/create.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
+
+const account = new sdk.Account(client);
+
+const response = await account.create(
+    '[USER_ID]', // userId
+    'email@example.com', // email
+    '', // password
+    '[NAME]' // name (optional)
+);

package/docs/examples/account/create2f-a-challenge.md

@@ -0,0 +1,11 @@
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2'); // Your project ID
+
+const account = new sdk.Account(client);
+
+const response = await account.create2FAChallenge(
+    sdk.AuthenticationFactor.Totp // factor
+);

package/docs/examples/account/delete-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.deleteAuthenticator(
+    sdk.AuthenticatorType.Totp, // type
+    '[OTP]' // otp
+);

package/docs/examples/account/delete-identity.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.deleteIdentity('[IDENTITY_ID]');
+const account = new sdk.Account(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await account.deleteIdentity(
+    '[IDENTITY_ID]' // identityId
+);

package/docs/examples/account/delete-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.deleteSession('[SESSION_ID]');
+const account = new sdk.Account(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await account.deleteSession(
+    '[SESSION_ID]' // sessionId
+);

package/docs/examples/account/delete-sessions.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.deleteSessions();
+const account = new sdk.Account(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await account.deleteSessions();

package/docs/examples/account/get-prefs.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.getPrefs();
+const account = new sdk.Account(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await account.getPrefs();

package/docs/examples/account/get-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.getSession('[SESSION_ID]');
+const account = new sdk.Account(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await account.getSession(
+    '[SESSION_ID]' // sessionId
+);

package/docs/examples/account/get.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.get();
+const account = new sdk.Account(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await account.get();

package/docs/examples/account/list-factors.md

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

package/docs/examples/account/list-identities.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.listIdentities();
+const account = new sdk.Account(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await account.listIdentities(
+    [] // queries (optional)
+);

package/docs/examples/account/list-logs.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.listLogs();
+const account = new sdk.Account(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await account.listLogs(
+    [] // queries (optional)
+);

package/docs/examples/account/list-sessions.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.listSessions();
+const account = new sdk.Account(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await account.listSessions();

package/docs/examples/account/update-challenge.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.updateChallenge(
+    '[CHALLENGE_ID]', // challengeId
+    '[OTP]' // otp
+);

package/docs/examples/account/update-email.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.updateEmail('email@example.com', 'password');
+const account = new sdk.Account(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await account.updateEmail(
+    'email@example.com', // email
+    'password' // password
+);

package/docs/examples/account/update-m-f-a.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
+    .setSession(''); // The user session to authenticate with
+
+const account = new sdk.Account(client);
+
+const response = await account.updateMFA(
+    false // mfa
+);

package/docs/examples/account/update-magic-u-r-l-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
+
+const account = new sdk.Account(client);
+
+const response = await account.updateMagicURLSession(
+    '[USER_ID]', // userId
+    '[SECRET]' // secret
+);

package/docs/examples/account/update-name.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.updateName('[NAME]');
+const account = new sdk.Account(client);
 
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});
+const response = await account.updateName(
+    '[NAME]' // name
+);