Skip to content

Latest commit

 

History

History
91 lines (57 loc) · 4.3 KB

README.md

File metadata and controls

91 lines (57 loc) · 4.3 KB
Raw
Aimeos logo

Nylas Node.js SDK

npm codecov

This is the GitHub repository for the Nylas Node SDK. This repo is primarily for anyone who wants to make contributions to the SDK, or install it from source. If you are looking to use Node to access the Nylas Email, Calendar, or Contacts API you should refer to our official Node SDK Quickstart Guide.

The Nylas Communications Platform provides REST APIs for Email, Calendar, and Contacts, and the Node SDK is the quickest way to build your integration using JavaScript.

Here are some resources to help you get started:

⚙️ Install

Note: The Nylas Node SDK requires Node.js v16 or later.

Set up using npm

To run the Nylas Node SDK, first install Node and npm on your machine.

Then, head to the nearest command line and run the following: npm install nylas

Alternatively, you can use Yarn to install the Nylas Node SDK by running the yarn add nylas command.

Build from source

To install this package from source, clone this repo and run npm install from inside the project directory.

git clone https://github.com/nylas/nylas-nodejs.git
cd nylas-nodejs
npm install

⚡️ Usage

To use this SDK, you must first get a free Nylas account.

Then, follow the Quickstart guide to set up your first app and get your API keys.

For code examples that demonstrate how to use this SDK, take a look at our Node repos in the Nylas Samples collection.

🚀 Making Your First Request

You access Nylas resources (messages, calendars, events, contacts) through an instance of Nylas. The Nylas object must be initialized with your Nylas API key, and you can provide other additional configurations such as the Nylas API url and the timeout.

import Nylas from "nylas";

const nylas = new Nylas({
  apiKey: "NYLAS_API_KEY",
});

Once initialized you can use the object to make requests for a given account's resources, for example to list all the calendars for a given account:

nylas.calendars.list({ identifier: "GRANT_ID" }).then(calendars => {
  console.log(calendars);
});

📚 Documentation

Nylas maintains a reference guide for the Node SDK to help you get familiar with the available methods and classes.

✨ Upgrading from 6.x

See UPGRADE.md for instructions on upgrading from 6.x to 7.x.

Note: The Node SDK v7.x is not compatible with the Nylas API earlier than v3-beta.

💙 Contributing

Please refer to Contributing for information about how to make contributions to this project. We welcome questions, bug reports, and pull requests.

📝 License

This project is licensed under the terms of the MIT license. Please refer to LICENSE for the full terms.