Merge pull request #17 from appwrite/dev

feat: update version

Author: christyjacob4

README.md

@@ -1,18 +1,17 @@
 # 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.8.0-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-0.9.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)
 [![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.8.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.9.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)
 
-Appwrite is an open-source backend as a service server that abstract and simplify complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way.
-                        Use the Node.js SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools.
-                        For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)
+Appwrite is an open-source backend as a service server that abstract and simplify complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the Node.js SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)
 
 ![Appwrite](https://appwrite.io/images/github.png)
 
@@ -28,7 +27,7 @@ npm install node-appwrite --save
 ## Getting Started
 
 ### Init your SDK
-Initialize your SDK code with your project ID which can be found in your project settings page and your new API secret Key project API keys section.
+Initialize your SDK with your Appwrite server API endpoint and project ID which can be found in your project settings page and your new API secret Key project API keys section.
 
 ```js
 const sdk = require('node-appwrite');
@@ -44,7 +43,7 @@ client
 ```
 
 ### Make Your First Request
-Once your SDK object is set, create any of the Appwrite service objects and choose any request to send. Full documentation for any service method you would like to use can be found in your SDK documentation or in the API References section.
+Once your SDK object is set, create any of the Appwrite service objects and choose any request to send. Full documentation for any service method you would like to use can be found in your SDK documentation or in the [API References](https://appwrite.io/docs) section.
 
 ```js
 let users = new sdk.Users(client);
@@ -95,7 +94,7 @@ try {
 ```
 
 ### Learn more
-You can use followng resources to learn more and get help
+You can use following resources to learn more and get help
 - 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-server)
 - 📜 [Appwrite Docs](https://appwrite.io/docs)
 - 💬 [Discord Community](https://appwrite.io/discord)

docs/examples/account/get-session.md

@@ -0,0 +1,20 @@
+const sdk = require('node-appwrite');
+
+// Init SDK
+let client = new sdk.Client();
+
+let account = new sdk.Account(client);
+
+client
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setJWT('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') // Your secret JSON Web Token
+;
+
+let promise = account.getSession('[SESSION_ID]');
+
+promise.then(function (response) {
+    console.log(response);
+}, function (error) {
+    console.log(error);
+});

docs/examples/functions/create.md

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

docs/examples/users/update-verification.md

@@ -0,0 +1,20 @@
+const sdk = require('node-appwrite');
+
+// Init SDK
+let client = new sdk.Client();
+
+let users = new sdk.Users(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 = users.updateVerification('[USER_ID]', false);
+
+promise.then(function (response) {
+    console.log(response);
+}, function (error) {
+    console.log(error);
+});

index.d.ts

@@ -236,6 +236,18 @@ declare module "node-appwrite" {
      */
     deleteSessions<T extends unknown>(): Promise<T>;
 
+    /**
+     * Get Session By ID
+     *
+     * Use this endpoint to get a logged in user's session using a Session ID.
+     * Inputting 'current' will return the current session being used.
+     *
+     * @param {string} sessionId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getSession<T extends unknown>(sessionId: string): Promise<T>;
+
     /**
      * Delete Account Session
      *
@@ -590,15 +602,15 @@ declare module "node-appwrite" {
      *
      * @param {string} name
      * @param {string[]} execute
-     * @param {string} env
+     * @param {string} runtime
      * @param {object} vars
      * @param {string[]} events
      * @param {string} schedule
      * @param {number} timeout
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    create<T extends unknown>(name: string, execute: string[], env: string, vars?: object, events?: string[], schedule?: string, timeout?: number): Promise<T>;
+    create<T extends unknown>(name: string, execute: string[], runtime: string, vars?: object, events?: string[], schedule?: string, timeout?: number): Promise<T>;
 
     /**
      * Get Function
@@ -1072,6 +1084,7 @@ declare module "node-appwrite" {
      * @param {string} fileId
      * @param {number} width
      * @param {number} height
+     * @param {string} gravity
      * @param {number} quality
      * @param {number} borderWidth
      * @param {string} borderColor
@@ -1083,7 +1096,7 @@ declare module "node-appwrite" {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    getFilePreview(fileId: string, width?: number, height?: number, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: string): Promise<Buffer>;
+    getFilePreview(fileId: string, width?: number, height?: number, gravity?: string, quality?: number, borderWidth?: number, borderColor?: string, borderRadius?: number, opacity?: number, rotation?: number, background?: string, output?: string): Promise<Buffer>;
 
     /**
      * Get File for View
@@ -1385,5 +1398,17 @@ declare module "node-appwrite" {
      * @returns {Promise}
      */
     updateStatus<T extends unknown>(userId: string, status: number): Promise<T>;
+
+    /**
+     * Update Email Verification
+     *
+     * Update the user email verification status by its unique ID.
+     *
+     * @param {string} userId
+     * @param {boolean} emailVerification
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updateVerification<T extends unknown>(userId: string, emailVerification: boolean): Promise<T>;
   }
 }

lib/client.js

@@ -9,8 +9,8 @@ class Client {
         this.endpoint = 'https://appwrite.io/v1';
         this.headers = {
             'content-type': '',
-            'x-sdk-version': 'appwrite:nodejs:2.3.0',
-            'X-Appwrite-Response-Format' : '0.8.0',
+            'x-sdk-version': 'appwrite:nodejs:2.4.0',
+            'X-Appwrite-Response-Format' : '0.9.0',
         };
         this.selfSigned = false;
     }

lib/services/account.js

@@ -341,6 +341,29 @@ class Account extends Service {
         }, payload);
     }
 
+    /**
+     * Get Session By ID
+     *
+     * Use this endpoint to get a logged in user's session using a Session ID.
+     * Inputting 'current' will return the current session being used.
+     *
+     * @param {string} sessionId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async getSession(sessionId) {
+        if (typeof sessionId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "sessionId"');
+        }
+
+        let path = '/account/sessions/{sessionId}'.replace('{sessionId}', sessionId);
+        let payload = {};
+
+        return await this.client.call('get', path, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
     /**
      * Delete Account Session
      *

lib/services/functions.js

@@ -50,15 +50,15 @@ class Functions extends Service {
      *
      * @param {string} name
      * @param {string[]} execute
-     * @param {string} env
+     * @param {string} runtime
      * @param {object} vars
      * @param {string[]} events
      * @param {string} schedule
      * @param {number} timeout
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async create(name, execute, env, vars, events, schedule, timeout) {
+    async create(name, execute, runtime, vars, events, schedule, timeout) {
         if (typeof name === 'undefined') {
             throw new AppwriteException('Missing required parameter: "name"');
         }
@@ -67,8 +67,8 @@ class Functions extends Service {
             throw new AppwriteException('Missing required parameter: "execute"');
         }
 
-        if (typeof env === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "env"');
+        if (typeof runtime === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "runtime"');
         }
 
         let path = '/functions';
@@ -82,8 +82,8 @@ class Functions extends Service {
             payload['execute'] = execute;
         }
 
-        if (typeof env !== 'undefined') {
-            payload['env'] = env;
+        if (typeof runtime !== 'undefined') {
+            payload['runtime'] = runtime;
         }
 
         if (typeof vars !== 'undefined') {

lib/services/storage.js

@@ -202,6 +202,7 @@ class Storage extends Service {
      * @param {string} fileId
      * @param {number} width
      * @param {number} height
+     * @param {string} gravity
      * @param {number} quality
      * @param {number} borderWidth
      * @param {string} borderColor
@@ -213,7 +214,7 @@ class Storage extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async getFilePreview(fileId, width, height, quality, borderWidth, borderColor, borderRadius, opacity, rotation, background, output) {
+    async getFilePreview(fileId, width, height, gravity, quality, borderWidth, borderColor, borderRadius, opacity, rotation, background, output) {
         if (typeof fileId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "fileId"');
         }
@@ -229,6 +230,10 @@ class Storage extends Service {
             payload['height'] = height;
         }
 
+        if (typeof gravity !== 'undefined') {
+            payload['gravity'] = gravity;
+        }
+
         if (typeof quality !== 'undefined') {
             payload['quality'] = quality;
         }

lib/services/users.js

@@ -302,6 +302,37 @@ class Users extends Service {
             'content-type': 'application/json',
         }, payload);
     }
+
+    /**
+     * Update Email Verification
+     *
+     * Update the user email verification status by its unique ID.
+     *
+     * @param {string} userId
+     * @param {boolean} emailVerification
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async updateVerification(userId, emailVerification) {
+        if (typeof userId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "userId"');
+        }
+
+        if (typeof emailVerification === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "emailVerification"');
+        }
+
+        let path = '/users/{userId}/verification'.replace('{userId}', userId);
+        let payload = {};
+
+        if (typeof emailVerification !== 'undefined') {
+            payload['emailVerification'] = emailVerification;
+        }
+
+        return await this.client.call('patch', path, {
+            'content-type': 'application/json',
+        }, payload);
+    }
 }
 
 module.exports = Users;