node-appwrite 3.0.0 → 4.0.0

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2021 Appwrite (https://appwrite.io) and individual contributors.
+Copyright (c) 2022 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-0.11.0-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-0.12.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_io?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite_io)
+[![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 0.11.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-node/releases).**
+**This SDK is compatible with Appwrite server version 0.12.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)
@@ -48,7 +48,7 @@ Once your SDK object is set, create any of the Appwrite service objects and choo
 ```js
 let users = new sdk.Users(client);
 
-let promise = users.create('email@example.com', 'password');
+let promise = users.create('[USER_ID]', 'email@example.com', 'password');
 
 promise.then(function (response) {
     console.log(response);
@@ -71,7 +71,7 @@ client
 ;
 
 let users = new sdk.Users(client);
-let promise = users.create('email@example.com', 'password');
+let promise = users.create('[USER_ID]', 'email@example.com', 'password');
 
 promise.then(function (response) {
     console.log(response);
@@ -87,7 +87,7 @@ The Appwrite Node SDK raises `AppwriteException` object with `message`, `code` a
 let users = new sdk.Users(client);
 
 try {
-    let res = await users.create('email@example.com', 'password');
+    let res = await users.create('[USER_ID]', 'email@example.com', 'password');
 } catch(e) {
     console.log(e.message);
 }

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

@@ -0,0 +1,20 @@
+const sdk = require('node-appwrite');
+
+// Init SDK
+let client = new sdk.Client();
+
+let database = new sdk.Database(client);
+
+client
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
+;
+
+let promise = database.createBooleanAttribute('[COLLECTION_ID]', '', false);
+
+promise.then(function (response) {
+    console.log(response);
+}, function (error) {
+    console.log(error);
+});

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

@@ -11,7 +11,7 @@ client
     .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
 ;
 
-let promise = database.createCollection('[NAME]', [], [], []);
+let promise = database.createCollection('[COLLECTION_ID]', '[NAME]', 'document', ["role:all"], ["role:all"]);
 
 promise.then(function (response) {
     console.log(response);

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

@@ -11,7 +11,7 @@ client
     .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
 ;
 
-let promise = database.createDocument('[COLLECTION_ID]', {});
+let promise = database.createDocument('[COLLECTION_ID]', '[DOCUMENT_ID]', {});
 
 promise.then(function (response) {
     console.log(response);

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

@@ -0,0 +1,20 @@
+const sdk = require('node-appwrite');
+
+// Init SDK
+let client = new sdk.Client();
+
+let database = new sdk.Database(client);
+
+client
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
+;
+
+let promise = database.createEmailAttribute('[COLLECTION_ID]', '', false);
+
+promise.then(function (response) {
+    console.log(response);
+}, function (error) {
+    console.log(error);
+});

package/docs/examples/database/create-enum-attribute.md

@@ -0,0 +1,20 @@
+const sdk = require('node-appwrite');
+
+// Init SDK
+let client = new sdk.Client();
+
+let database = new sdk.Database(client);
+
+client
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
+;
+
+let promise = database.createEnumAttribute('[COLLECTION_ID]', '', [], false);
+
+promise.then(function (response) {
+    console.log(response);
+}, function (error) {
+    console.log(error);
+});

package/docs/examples/database/create-float-attribute.md

@@ -0,0 +1,20 @@
+const sdk = require('node-appwrite');
+
+// Init SDK
+let client = new sdk.Client();
+
+let database = new sdk.Database(client);
+
+client
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
+;
+
+let promise = database.createFloatAttribute('[COLLECTION_ID]', '', false);
+
+promise.then(function (response) {
+    console.log(response);
+}, function (error) {
+    console.log(error);
+});

package/docs/examples/database/create-index.md

@@ -0,0 +1,20 @@
+const sdk = require('node-appwrite');
+
+// Init SDK
+let client = new sdk.Client();
+
+let database = new sdk.Database(client);
+
+client
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
+;
+
+let promise = database.createIndex('[COLLECTION_ID]', '', 'key', []);
+
+promise.then(function (response) {
+    console.log(response);
+}, function (error) {
+    console.log(error);
+});

package/docs/examples/database/create-integer-attribute.md

@@ -0,0 +1,20 @@
+const sdk = require('node-appwrite');
+
+// Init SDK
+let client = new sdk.Client();
+
+let database = new sdk.Database(client);
+
+client
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
+;
+
+let promise = database.createIntegerAttribute('[COLLECTION_ID]', '', false);
+
+promise.then(function (response) {
+    console.log(response);
+}, function (error) {
+    console.log(error);
+});

package/docs/examples/database/create-ip-attribute.md

@@ -0,0 +1,20 @@
+const sdk = require('node-appwrite');
+
+// Init SDK
+let client = new sdk.Client();
+
+let database = new sdk.Database(client);
+
+client
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
+;
+
+let promise = database.createIpAttribute('[COLLECTION_ID]', '', false);
+
+promise.then(function (response) {
+    console.log(response);
+}, function (error) {
+    console.log(error);
+});

package/docs/examples/database/create-string-attribute.md

@@ -0,0 +1,20 @@
+const sdk = require('node-appwrite');
+
+// Init SDK
+let client = new sdk.Client();
+
+let database = new sdk.Database(client);
+
+client
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
+;
+
+let promise = database.createStringAttribute('[COLLECTION_ID]', '', 1, false);
+
+promise.then(function (response) {
+    console.log(response);
+}, function (error) {
+    console.log(error);
+});

package/docs/examples/database/create-url-attribute.md

@@ -0,0 +1,20 @@
+const sdk = require('node-appwrite');
+
+// Init SDK
+let client = new sdk.Client();
+
+let database = new sdk.Database(client);
+
+client
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
+;
+
+let promise = database.createUrlAttribute('[COLLECTION_ID]', '', false);
+
+promise.then(function (response) {
+    console.log(response);
+}, function (error) {
+    console.log(error);
+});

package/docs/examples/database/delete-attribute.md

@@ -0,0 +1,20 @@
+const sdk = require('node-appwrite');
+
+// Init SDK
+let client = new sdk.Client();
+
+let database = new sdk.Database(client);
+
+client
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
+;
+
+let promise = database.deleteAttribute('[COLLECTION_ID]', '');
+
+promise.then(function (response) {
+    console.log(response);
+}, function (error) {
+    console.log(error);
+});

package/docs/examples/database/delete-index.md

@@ -0,0 +1,20 @@
+const sdk = require('node-appwrite');
+
+// Init SDK
+let client = new sdk.Client();
+
+let database = new sdk.Database(client);
+
+client
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
+;
+
+let promise = database.deleteIndex('[COLLECTION_ID]', '');
+
+promise.then(function (response) {
+    console.log(response);
+}, function (error) {
+    console.log(error);
+});

package/docs/examples/database/get-attribute.md

@@ -0,0 +1,20 @@
+const sdk = require('node-appwrite');
+
+// Init SDK
+let client = new sdk.Client();
+
+let database = new sdk.Database(client);
+
+client
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
+;
+
+let promise = database.getAttribute('[COLLECTION_ID]', '');
+
+promise.then(function (response) {
+    console.log(response);
+}, function (error) {
+    console.log(error);
+});

package/docs/examples/database/get-index.md

@@ -0,0 +1,20 @@
+const sdk = require('node-appwrite');
+
+// Init SDK
+let client = new sdk.Client();
+
+let database = new sdk.Database(client);
+
+client
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
+;
+
+let promise = database.getIndex('[COLLECTION_ID]', '');
+
+promise.then(function (response) {
+    console.log(response);
+}, function (error) {
+    console.log(error);
+});

package/docs/examples/database/list-attributes.md

@@ -0,0 +1,20 @@
+const sdk = require('node-appwrite');
+
+// Init SDK
+let client = new sdk.Client();
+
+let database = new sdk.Database(client);
+
+client
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
+;
+
+let promise = database.listAttributes('[COLLECTION_ID]');
+
+promise.then(function (response) {
+    console.log(response);
+}, function (error) {
+    console.log(error);
+});

package/docs/examples/database/list-indexes.md

@@ -0,0 +1,20 @@
+const sdk = require('node-appwrite');
+
+// Init SDK
+let client = new sdk.Client();
+
+let database = new sdk.Database(client);
+
+client
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
+;
+
+let promise = database.listIndexes('[COLLECTION_ID]');
+
+promise.then(function (response) {
+    console.log(response);
+}, function (error) {
+    console.log(error);
+});

package/docs/examples/database/update-collection.md

@@ -11,7 +11,7 @@ client
     .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
 ;
 
-let promise = database.updateCollection('[COLLECTION_ID]', '[NAME]');
+let promise = database.updateCollection('[COLLECTION_ID]', '[NAME]', 'document');
 
 promise.then(function (response) {
     console.log(response);

package/docs/examples/functions/create.md

@@ -11,7 +11,7 @@ client
     .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
 ;
 
-let promise = functions.create('[NAME]', [], 'dotnet-5.0');
+let promise = functions.create('[FUNCTION_ID]', '[NAME]', [], 'node-14.5');
 
 promise.then(function (response) {
     console.log(response);

package/docs/examples/{health/get-queue-tasks.md → functions/list-runtimes.md}

@@ -3,7 +3,7 @@ const sdk = require('node-appwrite');
 // Init SDK
 let client = new sdk.Client();
 
-let health = new sdk.Health(client);
+let functions = new sdk.Functions(client);
 
 client
     .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
@@ -11,7 +11,7 @@ client
     .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
 ;
 
-let promise = health.getQueueTasks();
+let promise = functions.listRuntimes();
 
 promise.then(function (response) {
     console.log(response);

package/docs/examples/health/{get-anti-virus.md → get-antivirus.md}

@@ -11,7 +11,7 @@ client
     .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
 ;
 
-let promise = health.getAntiVirus();
+let promise = health.getAntivirus();
 
 promise.then(function (response) {
     console.log(response);

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

@@ -12,7 +12,7 @@ client
     .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
 ;
 
-let promise = storage.createFile(fs.createReadStream(__dirname + '/file.png'));
+let promise = storage.createFile('[FILE_ID]', fs.createReadStream(__dirname + '/file.png'));
 
 promise.then(function (response) {
     console.log(response);

package/docs/examples/teams/create.md

@@ -11,7 +11,7 @@ client
     .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
 ;
 
-let promise = teams.create('[NAME]');
+let promise = teams.create('[TEAM_ID]', '[NAME]');
 
 promise.then(function (response) {
     console.log(response);

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

@@ -0,0 +1,20 @@
+const sdk = require('node-appwrite');
+
+// Init SDK
+let client = new sdk.Client();
+
+let teams = new sdk.Teams(client);
+
+client
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
+;
+
+let promise = teams.getMembership('[TEAM_ID]', '[MEMBERSHIP_ID]');
+
+promise.then(function (response) {
+    console.log(response);
+}, function (error) {
+    console.log(error);
+});

package/docs/examples/users/create.md

@@ -11,7 +11,7 @@ client
     .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
 ;
 
-let promise = users.create('email@example.com', 'password');
+let promise = users.create('[USER_ID]', 'email@example.com', 'password');
 
 promise.then(function (response) {
     console.log(response);

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

@@ -11,7 +11,7 @@ client
     .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
 ;
 
-let promise = users.updateStatus('[USER_ID]', 1);
+let promise = users.updateStatus('[USER_ID]', false);
 
 promise.then(function (response) {
     console.log(response);