nylas 7.0.0-beta.2 → 7.0.0-beta.3

package/README.md

@@ -4,18 +4,22 @@
 
 # Nylas Node.js SDK  
 
+[![npm](https://img.shields.io/npm/v/nylas%2Fbeta?label=npm%40beta)
+](https://www.npmjs.com/package/nylas/v/beta@)
 [![codecov](https://codecov.io/gh/nylas/nylas-nodejs/branch/main/graph/badge.svg?token=94IMGU4F09)](https://codecov.io/gh/nylas/nylas-nodejs)
 
-This is the GitHub repository for the Nylas Node SDK and 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](https://developer.nylas.com/docs/developer-tools/sdk/node-sdk/).
+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](https://developer.nylas.com/docs/developer-tools/sdk/node-sdk/).
 
 The Nylas Communications Platform provides REST APIs for [Email](https://developer.nylas.com/docs/connectivity/email/), [Calendar](https://developer.nylas.com/docs/connectivity/calendar/), and [Contacts](https://developer.nylas.com/docs/connectivity/contacts/), and the Node SDK is the quickest way to build your integration using JavaScript.
 
 Here are some resources to help you get started:
 
-- [Nylas SDK Tutorials](https://developer.nylas.com/docs/the-basics/tutorials/nodejs/)
-- [Quickstart](https://developer.nylas.com/docs/the-basics/quickstart/)
+- [Sign up for your free Nylas account](https://dashboard.nylas.com/register)
+- [Sign up for the Nylas v3 Beta program to access the v3 Dashboard](https://info.nylas.com/apiv3betasignup.html?utm_source=github&utm_medium=devrel-surfaces&utm_campaign=&utm_content=node-sdk-upgrade)
+- [Nylas API v3 Quickstart Guide](https://developer.nylas.com/docs/v3-beta/v3-quickstart/)
+- [Nylas SDK Reference](https://nylas-nodejs-sdk-reference.pages.dev/)
 - [Nylas API Reference](https://developer.nylas.com/docs/api/)
-
+- [Nylas Samples repo for code samples and example applications](https://github.com/orgs/nylas-samples/repositories?q=&type=all&language=javascript)
 
 ## ⚙️ Install
 
@@ -23,12 +27,12 @@ Here are some resources to help you get started:
 
 ### Set up using npm
 
-To run the Nylas Node SDK, you will first need to have [Node](https://nodejs.org/en/download/) and [npm](https://www.npmjs.com/get-npm) installed on your machine.
+To run the Nylas Node SDK, first install [Node](https://nodejs.org/en/download/) and [npm](https://www.npmjs.com/get-npm) on your machine.
 
 Then, head to the nearest command line and run the following:
 `npm install nylas@beta`
 
-Alternatively, if you prefer to use [Yarn](https://yarnpkg.com/en/), you can install the Nylas Node SDK with `yarn add nylas`
+Alternatively, you can use [Yarn](https://yarnpkg.com/en/) to install the Nylas Node SDK by running the `yarn add nylas` command.
 
 ### Build from source
 
@@ -50,7 +54,7 @@ For code examples that demonstrate how to use this SDK, take a look at our [Node
 
 ### 🚀 Making Your First Request
 
-Every resource (i.e., messages, events, contacts) is accessed via 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.
+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.
 
 ```typescript
 import Nylas from "nylas";
@@ -61,6 +65,7 @@ const nylas = new Nylas({
 ```
 
 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:
+
 ```typescript
 nylas.calendars.list({ identifier: "GRANT_ID" }).then(calendars => {
   console.log(calendars);
@@ -71,12 +76,16 @@ nylas.calendars.list({ identifier: "GRANT_ID" }).then(calendars => {
 
 Nylas maintains a [reference guide for the Node SDK](https://nylas-nodejs-sdk-reference.pages.dev/) to help you get familiar with the available methods and classes.
 
+## ✨ Upgrading from 6.x
+
+See [UPGRADE.md](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](Contributing.md) 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](LICENSE.txt) for the full terms. 
-
-
+This project is licensed under the terms of the MIT license. Please refer to [LICENSE](LICENSE.txt) for the full terms.

package/lib/cjs/apiClient.js

@@ -55,6 +55,13 @@ class APIClient {
             requestOptions.body = JSON.stringify((0, utils_js_1.objKeysToSnakeCase)(optionParams.body));
             requestOptions.headers['Content-Type'] = 'application/json';
         }
+        if (optionParams.form) {
+            requestOptions.body = optionParams.form;
+            requestOptions.headers = {
+                ...requestOptions.headers,
+                ...optionParams.form.getHeaders(),
+            };
+        }
         return requestOptions;
     }
     newRequest(options) {

package/lib/cjs/models/connectors.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/models/credentials.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CredentialType = void 0;
+/**
+ * Enum representing the type of credential
+ */
+var CredentialType;
+(function (CredentialType) {
+    CredentialType["ADMINCONSENT"] = "adminconsent";
+    CredentialType["SERVICEACCOUNT"] = "serviceaccount";
+    CredentialType["CONNECTOR"] = "connector";
+})(CredentialType = exports.CredentialType || (exports.CredentialType = {}));

package/lib/cjs/models/drafts.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/models/files.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/models/freeBusy.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FreeBusyType = void 0;
+/**
+ * Enum representing the type of free/busy information returned for a calendar.
+ */
+var FreeBusyType;
+(function (FreeBusyType) {
+    FreeBusyType["FREE_BUSY"] = "free_busy";
+    FreeBusyType["ERROR"] = "error";
+})(FreeBusyType = exports.FreeBusyType || (exports.FreeBusyType = {}));

package/lib/cjs/models/messages.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MessageFields = void 0;
+/**
+ * Enum representing the message fields that can be included in a response.
+ */
+var MessageFields;
+(function (MessageFields) {
+    MessageFields["STANDARD"] = "standard";
+    MessageFields["INCLUDE_HEADERS"] = "include_headers";
+})(MessageFields = exports.MessageFields || (exports.MessageFields = {}));

package/lib/cjs/models/smartCompose.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/models/threads.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/models/webhooks.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebhookTriggers = void 0;
+/**
+ * Enum representing the available webhook triggers.
+ */
 var WebhookTriggers;
 (function (WebhookTriggers) {
     WebhookTriggers["CalendarCreated"] = "calendar.created";

package/lib/cjs/nylas.js

@@ -7,6 +7,10 @@ const events_js_1 = require("./resources/events.js");
 const auth_js_1 = require("./resources/auth.js");
 const webhooks_js_1 = require("./resources/webhooks.js");
 const applications_js_1 = require("./resources/applications.js");
+const messages_js_1 = require("./resources/messages.js");
+const drafts_js_1 = require("./resources/drafts.js");
+const threads_js_1 = require("./resources/threads.js");
+const connectors_js_1 = require("./resources/connectors.js");
 /**
  * The entry point to the Node SDK
  *
@@ -26,7 +30,11 @@ class Nylas {
         this.applications = new applications_js_1.Applications(this.apiClient);
         this.auth = new auth_js_1.Auth(this.apiClient);
         this.calendars = new calendars_js_1.Calendars(this.apiClient);
+        this.connectors = new connectors_js_1.Connectors(this.apiClient);
+        this.drafts = new drafts_js_1.Drafts(this.apiClient);
         this.events = new events_js_1.Events(this.apiClient);
+        this.messages = new messages_js_1.Messages(this.apiClient);
+        this.threads = new threads_js_1.Threads(this.apiClient);
         this.webhooks = new webhooks_js_1.Webhooks(this.apiClient);
         return this;
     }

package/lib/cjs/resources/auth.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Auth = void 0;
 const uuid_1 = require("uuid");
-const sha256_1 = require("sha256");
+const node_crypto_1 = require("node:crypto");
 const resource_js_1 = require("./resource.js");
 const grants_js_1 = require("./grants.js");
 /**
@@ -74,7 +74,7 @@ class Auth extends resource_js_1.Resource {
         url.searchParams.set('code_challenge_method', 's256');
         const secret = (0, uuid_1.v4)();
         const secretHash = this.hashPKCESecret(secret);
-        url.searchParams.set('code_challenge', secret);
+        url.searchParams.set('code_challenge', secretHash);
         // Return the url with secret & hashed secret
         return { secret, secretHash, url: url.toString() };
     }
@@ -138,16 +138,18 @@ class Auth extends resource_js_1.Resource {
         if (config.prompt) {
             url.searchParams.set('prompt', config.prompt);
         }
-        if (config.metadata) {
-            url.searchParams.set('metadata', config.metadata);
-        }
         if (config.state) {
             url.searchParams.set('state', config.state);
         }
         return url;
     }
     hashPKCESecret(secret) {
-        return Buffer.from((0, sha256_1.default)(secret)).toString('base64');
+        const hash = (0, node_crypto_1.createHash)('sha256')
+            .update(secret)
+            .digest('hex');
+        return Buffer.from(hash)
+            .toString('base64')
+            .replace(/=+$/, '');
     }
 }
 exports.Auth = Auth;

package/lib/cjs/resources/calendars.js

@@ -74,5 +74,17 @@ class Calendars extends resource_js_1.Resource {
             overrides,
         });
     }
+    /**
+     * Get the free/busy schedule for a list of email addresses
+     * @return The free/busy response
+     */
+    getFreeBusy({ identifier, requestBody, overrides, }) {
+        return this.apiClient.request({
+            method: 'POST',
+            path: `/v3/grants/${identifier}/calendars/free-busy`,
+            body: requestBody,
+            overrides,
+        });
+    }
 }
 exports.Calendars = Calendars;

package/lib/cjs/resources/connectors.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Connectors = void 0;
+const resource_js_1 = require("./resource.js");
+const credentials_js_1 = require("./credentials.js");
+class Connectors extends resource_js_1.Resource {
+    /**
+     * @param apiClient client The configured Nylas API client
+     */
+    constructor(apiClient) {
+        super(apiClient);
+        this.credentials = new credentials_js_1.Credentials(apiClient);
+    }
+    /**
+     * Return all connectors
+     * @return A list of connectors
+     */
+    list({ queryParams, overrides, }) {
+        return super._list({
+            queryParams,
+            overrides,
+            path: `/v3/connectors`,
+        });
+    }
+    /**
+     * Return a connector
+     * @return The connector
+     */
+    find({ provider, overrides, }) {
+        return super._find({
+            path: `/v3/connectors/${provider}`,
+            overrides,
+        });
+    }
+    /**
+     * Create a connector
+     * @return The created connector
+     */
+    create({ requestBody, overrides, }) {
+        return super._create({
+            path: `/v3/connectors`,
+            requestBody,
+            overrides,
+        });
+    }
+    /**
+     * Update a connector
+     * @return The updated connector
+     */
+    update({ provider, requestBody, overrides, }) {
+        return super._update({
+            path: `/v3/connectors/${provider}`,
+            requestBody,
+            overrides,
+        });
+    }
+    /**
+     * Delete a connector
+     * @return The deleted connector
+     */
+    destroy({ provider, overrides, }) {
+        return super._destroy({
+            path: `/v3/connectors/${provider}`,
+            overrides,
+        });
+    }
+}
+exports.Connectors = Connectors;

package/lib/cjs/resources/credentials.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Credentials = void 0;
+const resource_js_1 = require("./resource.js");
+class Credentials extends resource_js_1.Resource {
+    /**
+     * Return all credentials
+     * @return A list of credentials
+     */
+    list({ provider, queryParams, overrides, }) {
+        return super._list({
+            queryParams,
+            overrides,
+            path: `/v3/credentials/${provider}/creds`,
+        });
+    }
+    /**
+     * Return a credential
+     * @return The credential
+     */
+    find({ provider, credentialsId, overrides, }) {
+        return super._find({
+            path: `/v3/credentials/${provider}/creds/${credentialsId}`,
+            overrides,
+        });
+    }
+    /**
+     * Create a credential
+     * @return The created credential
+     */
+    create({ provider, requestBody, overrides, }) {
+        return super._create({
+            path: `/v3/credentials/${provider}/creds`,
+            requestBody,
+            overrides,
+        });
+    }
+    /**
+     * Update a credential
+     * @return The updated credential
+     */
+    update({ provider, credentialsId, requestBody, overrides, }) {
+        return super._update({
+            path: `/v3/credentials/${provider}/creds/${credentialsId}}`,
+            requestBody,
+            overrides,
+        });
+    }
+    /**
+     * Delete a credential
+     * @return The deleted credential
+     */
+    destroy({ provider, credentialsId, overrides, }) {
+        return super._destroy({
+            path: `/v3/credentials/${provider}/creds/${credentialsId}}`,
+            overrides,
+        });
+    }
+}
+exports.Credentials = Credentials;

package/lib/cjs/resources/drafts.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Drafts = void 0;
+const resource_js_1 = require("./resource.js");
+const messages_js_1 = require("./messages.js");
+/**
+ * Nylas Drafts API
+ *
+ * The Nylas Drafts API allows you to list, find, update, delete, and send drafts on user accounts.
+ */
+class Drafts extends resource_js_1.Resource {
+    /**
+     * Return all Drafts
+     * @return A list of drafts
+     */
+    list({ identifier, queryParams, overrides, }) {
+        return super._list({
+            queryParams,
+            overrides,
+            path: `/v3/grants/${identifier}/drafts`,
+        });
+    }
+    /**
+     * Return a Draft
+     * @return The draft
+     */
+    find({ identifier, draftId, overrides, }) {
+        return super._find({
+            path: `/v3/grants/${identifier}/drafts/${draftId}`,
+            overrides,
+        });
+    }
+    /**
+     * Return a Draft
+     * @return The draft
+     */
+    create({ identifier, requestBody, overrides, }) {
+        const form = messages_js_1.Messages._buildFormRequest(requestBody);
+        return this.apiClient.request({
+            method: 'POST',
+            path: `/v3/grants/${identifier}/drafts`,
+            form,
+            overrides,
+        });
+    }
+    /**
+     * Update a Draft
+     * @return The updated draft
+     */
+    update({ identifier, draftId, requestBody, overrides, }) {
+        const form = messages_js_1.Messages._buildFormRequest(requestBody);
+        return this.apiClient.request({
+            method: 'PUT',
+            path: `/v3/grants/${identifier}/drafts/${draftId}`,
+            form,
+            overrides,
+        });
+    }
+    /**
+     * Delete a Draft
+     * @return The deleted draft
+     */
+    destroy({ identifier, draftId, overrides, }) {
+        return super._destroy({
+            path: `/v3/grants/${identifier}/drafts/${draftId}`,
+            overrides,
+        });
+    }
+    /**
+     * Send a Draft
+     * @return The sent draft
+     */
+    send({ identifier, draftId, overrides, }) {
+        return super._create({
+            path: `/v3/grants/${identifier}/drafts/${draftId}`,
+            requestBody: {},
+            overrides,
+        });
+    }
+}
+exports.Drafts = Drafts;

package/lib/cjs/resources/grants.js

@@ -30,12 +30,12 @@ class Grants extends resource_js_1.Resource {
         });
     }
     /**
-     * Create a Grant
+     * Create a Grant via Custom Authentication
      * @return The created Grant
      */
     create({ requestBody, overrides, }) {
         return super._create({
-            path: `/v3/grants`,
+            path: `/v3/connect/custom`,
             requestBody,
             overrides,
         });

package/lib/cjs/resources/messages.js

@@ -0,0 +1,121 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Messages = void 0;
+const resource_js_1 = require("./resource.js");
+const FormData = require("form-data");
+const utils_js_1 = require("../utils.js");
+const smartCompose_js_1 = require("./smartCompose.js");
+/**
+ * Nylas Messages API
+ *
+ * The Nylas Messages API allows you to list, find, update, delete, schedule, and send messages on user accounts.
+ */
+class Messages extends resource_js_1.Resource {
+    constructor(apiClient) {
+        super(apiClient);
+        this.smartCompose = new smartCompose_js_1.SmartCompose(apiClient);
+    }
+    /**
+     * Return all Messages
+     * @return A list of messages
+     */
+    list({ identifier, queryParams, overrides, }) {
+        return super._list({
+            queryParams,
+            overrides,
+            path: `/v3/grants/${identifier}/messages`,
+        });
+    }
+    /**
+     * Return a Message
+     * @return The message
+     */
+    find({ identifier, messageId, overrides, }) {
+        return super._find({
+            path: `/v3/grants/${identifier}/messages/${messageId}`,
+            overrides,
+        });
+    }
+    /**
+     * Update a Message
+     * @return The updated message
+     */
+    update({ identifier, messageId, requestBody, overrides, }) {
+        return super._update({
+            path: `/v3/grants/${identifier}/messages/${messageId}`,
+            requestBody,
+            overrides,
+        });
+    }
+    /**
+     * Delete a Message
+     * @return The deleted message
+     */
+    destroy({ identifier, messageId, overrides, }) {
+        return super._destroy({
+            path: `/v3/grants/${identifier}/messages/${messageId}`,
+            overrides,
+        });
+    }
+    /**
+     * Send an email
+     * @return The sent message
+     */
+    send({ identifier, requestBody, overrides, }) {
+        const form = Messages._buildFormRequest(requestBody);
+        return this.apiClient.request({
+            method: 'POST',
+            path: `/v3/grants/${identifier}/messages/send`,
+            form,
+            overrides,
+        });
+    }
+    /**
+     * Retrieve your scheduled messages
+     * @return A list of scheduled messages
+     */
+    listScheduledMessages({ identifier, overrides, }) {
+        return super._find({
+            path: `/v3/grants/${identifier}/messages/schedules`,
+            overrides,
+        });
+    }
+    /**
+     * Retrieve a scheduled message
+     * @return The scheduled message
+     */
+    findScheduledMessage({ identifier, scheduleId, overrides, }) {
+        return super._find({
+            path: `/v3/grants/${identifier}/messages/schedules/${scheduleId}`,
+            overrides,
+        });
+    }
+    /**
+     * Stop a scheduled message
+     * @return The confirmation of the stopped scheduled message
+     */
+    stopScheduledMessage({ identifier, scheduleId, overrides, }) {
+        return super._destroy({
+            path: `/v3/grants/${identifier}/messages/schedules/${scheduleId}`,
+            overrides,
+        });
+    }
+    static _buildFormRequest(requestBody) {
+        const form = new FormData();
+        // Split out the message payload from the attachments
+        const messagePayload = {
+            ...requestBody,
+            attachments: undefined,
+        };
+        form.append('message', JSON.stringify((0, utils_js_1.objKeysToSnakeCase)(messagePayload)));
+        // Add a separate form field for each attachment
+        requestBody.attachments?.forEach((attachment, index) => {
+            form.append(`file${index}`, attachment.content, {
+                filename: attachment.filename,
+                contentType: attachment.contentType,
+            });
+        });
+        return form;
+    }
+}
+exports.Messages = Messages;

package/lib/cjs/resources/redirectUris.js

@@ -57,7 +57,7 @@ class RedirectUris extends resource_js_1.Resource {
     destroy({ redirectUriId, overrides, }) {
         return super._destroy({
             overrides,
-            path: `/v1/redirect_uris/${redirectUriId}`,
+            path: `/v3/applications/redirect-uris/${redirectUriId}`,
         });
     }
 }

package/lib/cjs/resources/smartCompose.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SmartCompose = void 0;
+const resource_js_1 = require("./resource.js");
+/**
+ * A collection of Smart Compose related API endpoints.
+ *
+ * These endpoints allow for the generation of message suggestions.
+ */
+class SmartCompose extends resource_js_1.Resource {
+    /**
+     * Compose a message
+     * @return The generated message
+     */
+    composeMessage({ identifier, requestBody, overrides, }) {
+        return super._create({
+            path: `/v3/grants/${identifier}/messages/smart-compose`,
+            requestBody,
+            overrides,
+        });
+    }
+    /**
+     * Compose a message reply
+     * @return The generated message reply
+     */
+    composeMessageReply({ identifier, messageId, requestBody, overrides, }) {
+        return super._create({
+            path: `/v3/grants/${identifier}/messages/${messageId}/smart-compose`,
+            requestBody,
+            overrides,
+        });
+    }
+}
+exports.SmartCompose = SmartCompose;