v7.5.0

Changelog

Added

• Added support for filtering by event type when listing events (#564)
• Added support for filtering a list of folders (#565)

Updated

• Fixed query parameters not being formatted properly (#564)

v7.4.0

Changelog

Added

• Added support for provider field in code exchange response (#560)
• Added clean messages support (#561)

Changed

• Fixed issue where attachments < 3mb were not being encoded correctly (#559)

v7.3.0

Changelog

Added

• Add response type to sendRsvp (#556)
• Add support for adding custom headers to outgoing requests (#552)
• Add support for custom headers field for drafts and messages (#553)
• Add support for setting include_grant_scopes for auth url generation (#554)

Changed

• Rename incorrect type field in When models to object (#551)
• Fix inaccuracy in ReminderOverride model (#555)

New Contributors 🎉

• @hanut made their first contribution in #551
• @Taha-Sardar made their first contribution in #554

v7.2.1

Changelog

Changed

• Improved message sending and draft create/update performance (#544)
• Change default timeout to match API (90 seconds) (#545)
• Fixed serialization/deserialization of keys with numbers in them (#546)

v7.2.0

Changelog

Added

• Added support for roundTo field in availability response model (#540)
• Added support for attributes field in folder model (#540)
• Added support for icloud as an auth provider (#540)

Changed

• Fixed query params not showing up in method parameters for finding a message (#539)
• Fixed missing fields in message models (#541, #542)

Removed

• Removed unnecessary clientId from detectProvider params (#540)

v7.1.0

The first release adds support for a new endpoint and a couple of updates.

Changelog

Added

• Added support for /v3/connect/tokeninfo endpoint (#536)

Updated

• Models can now directly be imported from the top-level nylas package (#534)
• Fixed inaccuracies in event and webhook models (#535)

v6.11.1

Changelog

Updates

• Fix issue where Graph events were returning 400 on update (#524)
• Make comment param in rsvp optional (#529)

v7.0.0

The Nylas Node SDK v7.0.0 is out of beta now Generally Available! This SDK sees a number of changes, including breaking changes, and more importantly brings full support of the new Nylas API v3.

Changelog

Breaking changes

• Node SDK v7 supports the Nylas API v3 exclusively, dropping support for any endpoints that are not available in v3. See API v3 Features and Changes for more information.
• Convert Nylas class from a static to a non-static class.
• Officially support minimum Node 16.
• Dropped the use of 'Collections' in favor of 'Resources'.
• Removed all REST calls from models and moved them directly into resources.

Added

• Created models for all API resources and endpoints, for all HTTP methods to reduce confusion on which fields are available for each endpoint.
• Created error classes for the different API errors as well as SDK-specific errors.
• Added support for both ES6 and CommonJS module systems.

Updated

• Rewrote the majority of SDK to be more modular and efficient.

Removed

• Removed the use of custom strings for serialization and deserialization, now automatically converting to camelCase and from the API's snake_case.
• Local Webhook development support is removed due to incompatibility with the new API version.

Docs and References

Please refer to the README.md for a quick description and getting started guide with the new SDK. Furthermore, we have an UPGRADE.md for instructions on upgrading from v6.x to v7.x, as well as a reference guide for the Node SDK.

v6.11.0

Release Notes

Added

• Add support for logging (#508, #456)

Fixed

• Nullify replyToMessageId is an empty string (#484, #509)
• Nullify visibility if visibility is an empty string (#507, #470)
• Fix numbers defaulting to 0 instead of null (#469)
• Fix parsing of Number arrays (#503, #502)
• Fix configured timeout not being used (#506, #489)
• Bump node-fetch dependency from 2.6.1 to 2.6.12 (#504, #496)

v6.10.0

This latest release of the Nylas Node SDK includes support for verifying webhook signatures.

Release Notes

Added

• Add support for verifying webhook signatures (#442)

Usage

To verify a webhook signature

const Nylas = require('nylas');
const express = require('express');
const cors = require('cors');

const app = express();

// Enable CORS
app.use(cors());

// The port the express app will run on
const port = 9000;

// Nylas app credentials
const NYLAS_CLIENT_SECRET = process.env.NYLAS_CLIENT_SECRET;
if (!NYLAS_CLIENT_SECRET) {
  throw new Error('NYLAS_CLIENT_SECRET is required')
}

// Create a callback route for the Nylas Event Webhook
app.post('/', express.json(), async (req, res) => {
  // Verify the Nylas Event Webhook signature to ensure the request is coming from Nylas
  const signature =
    req.headers['x-nylas-signature'] || req.headers['X-Nylas-Signature'];
  if (
    !WebhookNotification.verifyWebhookSignature(
      NYLAS_CLIENT_SECRET,
      signature,
      JSON.stringify(req.body)
    )
  ) {
    res.status(403).send('Invalid signature');
  }

  const { body } = req;

  // Log the webhook event to the console
  console.log('Webhook event received: ', JSON.stringify(body, undefined, 2));

  // Send a 200 response to the Nylas Event Webhook
  res.status(200).send({ success: true });
});