nylas 7.0.0-beta.3 → 7.0.0-beta.4

package/lib/cjs/apiClient.js

@@ -46,6 +46,47 @@ class APIClient {
             ...headers,
         };
     }
+    async sendRequest(options) {
+        const req = this.newRequest(options);
+        const controller = new AbortController();
+        const timeout = setTimeout(() => {
+            controller.abort();
+            throw new error_js_1.NylasSdkTimeoutError(req.url, this.timeout);
+        }, this.timeout);
+        try {
+            const response = await (0, node_fetch_1.default)(req, { signal: controller.signal });
+            clearTimeout(timeout);
+            if (typeof response === 'undefined') {
+                throw new Error('Failed to fetch response');
+            }
+            if (response.status > 299) {
+                const text = await response.text();
+                let error;
+                try {
+                    const parsedError = JSON.parse(text);
+                    const camelCaseError = (0, utils_js_1.objKeysToCamelCase)(parsedError);
+                    // Check if the request is an authentication request
+                    const isAuthRequest = options.path.includes('connect/token') ||
+                        options.path.includes('connect/revoke');
+                    if (isAuthRequest) {
+                        error = new error_js_1.NylasOAuthError(camelCaseError, response.status);
+                    }
+                    else {
+                        error = new error_js_1.NylasApiError(camelCaseError, response.status);
+                    }
+                }
+                catch (e) {
+                    throw new Error(`Received an error but could not parse response from the server: ${text}`);
+                }
+                throw error;
+            }
+            return response;
+        }
+        catch (error) {
+            clearTimeout(timeout);
+            throw error;
+        }
+    }
     requestOptions(optionParams) {
         const requestOptions = {};
         requestOptions.url = this.setRequestUrl(optionParams);
@@ -83,39 +124,16 @@ class APIClient {
         }
     }
     async request(options) {
-        const req = this.newRequest(options);
-        const controller = new AbortController();
-        const timeout = setTimeout(() => {
-            controller.abort();
-            throw new error_js_1.NylasSdkTimeoutError(req.url, this.timeout);
-        }, this.timeout);
-        const response = await (0, node_fetch_1.default)(req, { signal: controller.signal });
-        clearTimeout(timeout);
-        if (typeof response === 'undefined') {
-            throw new Error('Failed to fetch response');
-        }
-        // handle error response
-        if (response.status > 299) {
-            const authErrorResponse = options.path.includes('connect/token') ||
-                options.path.includes('connect/revoke');
-            const text = await response.text();
-            let error;
-            try {
-                const parsedError = JSON.parse(text);
-                const camelCaseError = (0, utils_js_1.objKeysToCamelCase)(parsedError);
-                if (authErrorResponse) {
-                    error = new error_js_1.NylasOAuthError(camelCaseError, response.status);
-                }
-                else {
-                    error = new error_js_1.NylasApiError(camelCaseError, response.status);
-                }
-            }
-            catch (e) {
-                throw new Error(`Received an error but could not parse response from the server: ${text}`);
-            }
-            throw error;
-        }
+        const response = await this.sendRequest(options);
         return this.requestWithResponse(response);
     }
+    async requestRaw(options) {
+        const response = await this.sendRequest(options);
+        return response.buffer();
+    }
+    async requestStream(options) {
+        const response = await this.sendRequest(options);
+        return response.body;
+    }
 }
 exports.default = APIClient;

package/lib/cjs/models/attachments.js

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

package/lib/cjs/models/contacts.js

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

package/lib/cjs/models/folders.js

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

package/lib/cjs/nylas.js

@@ -11,6 +11,10 @@ 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");
+const folders_js_1 = require("./resources/folders.js");
+const grants_js_1 = require("./resources/grants.js");
+const contacts_js_1 = require("./resources/contacts.js");
+const attachments_js_1 = require("./resources/attachments.js");
 /**
  * The entry point to the Node SDK
  *
@@ -33,9 +37,13 @@ class Nylas {
         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.grants = new grants_js_1.Grants(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);
+        this.folders = new folders_js_1.Folders(this.apiClient);
+        this.contacts = new contacts_js_1.Contacts(this.apiClient);
+        this.attachments = new attachments_js_1.Attachments(this.apiClient);
         return this;
     }
 }

package/lib/cjs/resources/attachments.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Attachments = void 0;
+const resource_js_1 = require("./resource.js");
+/**
+ * Nylas Attachments API
+ *
+ * The Nylas Attachments API allows you to retrieve metadata and download attachments.
+ */
+class Attachments extends resource_js_1.Resource {
+    /**
+     * Returns an attachment by ID.
+     * @return The Attachment metadata
+     */
+    find({ identifier, attachmentId, queryParams, overrides, }) {
+        return super._find({
+            path: `/v3/grants/${identifier}/attachments/${attachmentId}`,
+            queryParams,
+            overrides,
+        });
+    }
+    /**
+     * Download the attachment data
+     *
+     * This method returns a NodeJS.ReadableStream which can be used to stream the attachment data.
+     * This is particularly useful for handling large attachments efficiently, as it avoids loading
+     * the entire file into memory. The stream can be piped to a file stream or used in any other way
+     * that Node.js streams are typically used.
+     *
+     * @param identifier Grant ID or email account to query
+     * @param attachmentId The id of the attachment to download.
+     * @param queryParams The query parameters to include in the request
+     * @returns {NodeJS.ReadableStream} The ReadableStream containing the file data.
+     */
+    download({ identifier, attachmentId, queryParams, overrides, }) {
+        return this._getStream({
+            path: `/v3/grants/${identifier}/attachments/${attachmentId}/download`,
+            queryParams,
+            overrides,
+        });
+    }
+    /**
+     * Download the attachment as a byte array
+     * @param identifier Grant ID or email account to query
+     * @param attachmentId The id of the attachment to download.
+     * @param queryParams The query parameters to include in the request
+     * @return The raw file data
+     */
+    downloadBytes({ identifier, attachmentId, queryParams, overrides, }) {
+        return super._getRaw({
+            path: `/v3/grants/${identifier}/attachments/${attachmentId}/download`,
+            queryParams,
+            overrides,
+        });
+    }
+}
+exports.Attachments = Attachments;

package/lib/cjs/resources/auth.js

@@ -4,7 +4,6 @@ exports.Auth = void 0;
 const uuid_1 = require("uuid");
 const node_crypto_1 = require("node:crypto");
 const resource_js_1 = require("./resource.js");
-const grants_js_1 = require("./grants.js");
 /**
  * A collection of authentication related API endpoints
  *
@@ -12,14 +11,6 @@ const grants_js_1 = require("./grants.js");
  * Also contains the Grants API and collection of provider API endpoints.
  */
 class Auth extends resource_js_1.Resource {
-    /**
-     * @param apiClient The configured Nylas API client
-     */
-    constructor(apiClient) {
-        super(apiClient);
-        this.apiClient = apiClient;
-        this.grants = new grants_js_1.Grants(apiClient);
-    }
     /**
      * Build the URL for authenticating users to your application with OAuth 2.0
      * @param config The configuration for building the URL
@@ -90,6 +81,18 @@ class Auth extends resource_js_1.Resource {
         url.searchParams.set('credential_id', config.credentialId);
         return url.toString();
     }
+    /**
+     * Create a grant via Custom Authentication
+     * @return The created grant
+     */
+    customAuthentication({ requestBody, overrides, }) {
+        return this.apiClient.request({
+            method: 'POST',
+            path: `/v3/connect/custom`,
+            body: requestBody,
+            overrides,
+        });
+    }
     /**
      * Revoke a token (and the grant attached to the token)
      * @param token The token to revoke
@@ -113,7 +116,7 @@ class Auth extends resource_js_1.Resource {
     async detectProvider(params) {
         return this.apiClient.request({
             method: 'POST',
-            path: `/v3/grants/providers/detect`,
+            path: `/v3/providers/detect`,
             queryParams: params,
         });
     }

package/lib/cjs/resources/contacts.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Contacts = void 0;
+const resource_js_1 = require("./resource.js");
+/**
+ * Nylas Contacts API
+ *
+ * The Nylas Contacts API allows you to create, update, and delete contacts.
+ */
+class Contacts extends resource_js_1.Resource {
+    /**
+     * Return all Contacts
+     * @return The list of Contacts
+     */
+    list({ identifier, queryParams, overrides, }) {
+        return super._list({
+            queryParams,
+            path: `/v3/grants/${identifier}/contacts`,
+            overrides,
+        });
+    }
+    /**
+     * Return a Contact
+     * @return The Contact
+     */
+    find({ identifier, contactId, queryParams, overrides, }) {
+        return super._find({
+            path: `/v3/grants/${identifier}/contacts/${contactId}`,
+            queryParams,
+            overrides,
+        });
+    }
+    /**
+     * Create a Contact
+     * @return The created Contact
+     */
+    create({ identifier, requestBody, overrides, }) {
+        return super._create({
+            path: `/v3/grants/${identifier}/contacts`,
+            requestBody,
+            overrides,
+        });
+    }
+    /**
+     * Update a Contact
+     * @return The updated Contact
+     */
+    update({ identifier, contactId, requestBody, overrides, }) {
+        return super._update({
+            path: `/v3/grants/${identifier}/contacts/${contactId}`,
+            requestBody,
+            overrides,
+        });
+    }
+    /**
+     * Delete a Contact
+     * @return The deletion response
+     */
+    destroy({ identifier, contactId, overrides, }) {
+        return super._destroy({
+            path: `/v3/grants/${identifier}/contacts/${contactId}`,
+            overrides,
+        });
+    }
+    /**
+     * Return a Contact Group
+     * @return The list of Contact Groups
+     */
+    groups({ identifier, overrides, }) {
+        return super._list({
+            path: `/v3/grants/${identifier}/contacts/groups`,
+            overrides,
+        });
+    }
+}
+exports.Contacts = Contacts;

package/lib/cjs/resources/events.js

@@ -65,5 +65,19 @@ class Events extends resource_js_1.Resource {
             overrides,
         });
     }
+    /**
+     * Send RSVP. Allows users to respond to events they have been added to as an attendee.
+     * You cannot send RSVP as an event owner/organizer.
+     * You cannot directly update events as an invitee, since you are not the owner/organizer.
+     * @return The send-rsvp response
+     */
+    sendRsvp({ identifier, eventId, requestBody, queryParams, overrides, }) {
+        return super._create({
+            path: `/v3/grants/${identifier}/events/${eventId}/send-rsvp`,
+            queryParams,
+            requestBody,
+            overrides,
+        });
+    }
 }
 exports.Events = Events;

package/lib/cjs/resources/folders.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Folders = void 0;
+const resource_js_1 = require("./resource.js");
+/**
+ * Nylas Folder API
+ *
+ * Email providers use folders to store and organize email messages. Examples of common system folders include Inbox, Sent, Drafts, etc.
+ *
+ * If your team is migrating from Nylas APIv2, there were previously two separate endpoints for interacting with Folders (Microsoft) and Labels (Google).
+ * In Nylas API v3, these endpoints are consolidated under Folders.
+ *
+ * To simplify the developer experience, Nylas uses the same folders commands to manage both folders and labels, using the folder_id key to refer to the folder's ID on the provider.
+ * The API also exposes provider-specific fields such as background_color (Google only).
+ *
+ * Depending on the provider (Google, some IMAP providers, etc.), a message can be contained in more than one folder.
+ */
+class Folders extends resource_js_1.Resource {
+    /**
+     * Return all Folders
+     * @return A list of folders
+     */
+    list({ identifier, overrides, }) {
+        return super._list({
+            overrides,
+            path: `/v3/grants/${identifier}/folders`,
+        });
+    }
+    /**
+     * Return a Folder
+     * @return The folder
+     */
+    find({ identifier, folderId, overrides, }) {
+        return super._find({
+            path: `/v3/grants/${identifier}/folders/${folderId}`,
+            overrides,
+        });
+    }
+    /**
+     * Create a Folder
+     * @return The created folder
+     */
+    create({ identifier, requestBody, overrides, }) {
+        return super._create({
+            path: `/v3/grants/${identifier}/folders`,
+            requestBody,
+            overrides,
+        });
+    }
+    /**
+     * Update a Folder
+     * @return The updated Folder
+     */
+    update({ identifier, folderId, requestBody, overrides, }) {
+        return super._update({
+            path: `/v3/grants/${identifier}/folders/${folderId}`,
+            requestBody,
+            overrides,
+        });
+    }
+    /**
+     * Delete a Folder
+     * @return The deleted Folder
+     */
+    destroy({ identifier, folderId, overrides, }) {
+        return super._destroy({
+            path: `/v3/grants/${identifier}/folders/${folderId}`,
+            overrides,
+        });
+    }
+}
+exports.Folders = Folders;

package/lib/cjs/resources/grants.js

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

package/lib/cjs/resources/messages.js

@@ -101,7 +101,14 @@ class Messages extends resource_js_1.Resource {
         });
     }
     static _buildFormRequest(requestBody) {
-        const form = new FormData();
+        let form;
+        // FormData imports are funky, cjs needs to use .default, es6 doesn't
+        if (typeof FormData.default !== 'undefined') {
+            form = new FormData.default();
+        }
+        else {
+            form = new FormData();
+        }
         // Split out the message payload from the attachments
         const messagePayload = {
             ...requestBody,

package/lib/cjs/resources/resource.js

@@ -107,5 +107,21 @@ class Resource {
             overrides,
         });
     }
+    _getRaw({ path, queryParams, overrides, }) {
+        return this.apiClient.requestRaw({
+            method: 'GET',
+            path,
+            queryParams,
+            overrides,
+        });
+    }
+    _getStream({ path, queryParams, overrides, }) {
+        return this.apiClient.requestStream({
+            method: 'GET',
+            path,
+            queryParams,
+            overrides,
+        });
+    }
 }
 exports.Resource = Resource;

package/lib/cjs/version.js

@@ -2,4 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
 // This file is generated by scripts/exportVersion.js
-exports.SDK_VERSION = '7.0.0-beta.3';
+exports.SDK_VERSION = '7.0.0-beta.4';

package/lib/esm/apiClient.js

@@ -44,6 +44,47 @@ export default class APIClient {
             ...headers,
         };
     }
+    async sendRequest(options) {
+        const req = this.newRequest(options);
+        const controller = new AbortController();
+        const timeout = setTimeout(() => {
+            controller.abort();
+            throw new NylasSdkTimeoutError(req.url, this.timeout);
+        }, this.timeout);
+        try {
+            const response = await fetch(req, { signal: controller.signal });
+            clearTimeout(timeout);
+            if (typeof response === 'undefined') {
+                throw new Error('Failed to fetch response');
+            }
+            if (response.status > 299) {
+                const text = await response.text();
+                let error;
+                try {
+                    const parsedError = JSON.parse(text);
+                    const camelCaseError = objKeysToCamelCase(parsedError);
+                    // Check if the request is an authentication request
+                    const isAuthRequest = options.path.includes('connect/token') ||
+                        options.path.includes('connect/revoke');
+                    if (isAuthRequest) {
+                        error = new NylasOAuthError(camelCaseError, response.status);
+                    }
+                    else {
+                        error = new NylasApiError(camelCaseError, response.status);
+                    }
+                }
+                catch (e) {
+                    throw new Error(`Received an error but could not parse response from the server: ${text}`);
+                }
+                throw error;
+            }
+            return response;
+        }
+        catch (error) {
+            clearTimeout(timeout);
+            throw error;
+        }
+    }
     requestOptions(optionParams) {
         const requestOptions = {};
         requestOptions.url = this.setRequestUrl(optionParams);
@@ -81,38 +122,15 @@ export default class APIClient {
         }
     }
     async request(options) {
-        const req = this.newRequest(options);
-        const controller = new AbortController();
-        const timeout = setTimeout(() => {
-            controller.abort();
-            throw new NylasSdkTimeoutError(req.url, this.timeout);
-        }, this.timeout);
-        const response = await fetch(req, { signal: controller.signal });
-        clearTimeout(timeout);
-        if (typeof response === 'undefined') {
-            throw new Error('Failed to fetch response');
-        }
-        // handle error response
-        if (response.status > 299) {
-            const authErrorResponse = options.path.includes('connect/token') ||
-                options.path.includes('connect/revoke');
-            const text = await response.text();
-            let error;
-            try {
-                const parsedError = JSON.parse(text);
-                const camelCaseError = objKeysToCamelCase(parsedError);
-                if (authErrorResponse) {
-                    error = new NylasOAuthError(camelCaseError, response.status);
-                }
-                else {
-                    error = new NylasApiError(camelCaseError, response.status);
-                }
-            }
-            catch (e) {
-                throw new Error(`Received an error but could not parse response from the server: ${text}`);
-            }
-            throw error;
-        }
+        const response = await this.sendRequest(options);
         return this.requestWithResponse(response);
     }
+    async requestRaw(options) {
+        const response = await this.sendRequest(options);
+        return response.buffer();
+    }
+    async requestStream(options) {
+        const response = await this.sendRequest(options);
+        return response.body;
+    }
 }

package/lib/esm/models/attachments.js

@@ -0,0 +1 @@
+export {};

package/lib/esm/models/contacts.js

@@ -0,0 +1 @@
+export {};

package/lib/esm/models/folders.js

@@ -0,0 +1 @@
+export {};

package/lib/esm/nylas.js

@@ -9,6 +9,10 @@ import { Messages } from './resources/messages.js';
 import { Drafts } from './resources/drafts.js';
 import { Threads } from './resources/threads.js';
 import { Connectors } from './resources/connectors.js';
+import { Folders } from './resources/folders.js';
+import { Grants } from './resources/grants.js';
+import { Contacts } from './resources/contacts.js';
+import { Attachments } from './resources/attachments.js';
 /**
  * The entry point to the Node SDK
  *
@@ -31,9 +35,13 @@ export default class Nylas {
         this.connectors = new Connectors(this.apiClient);
         this.drafts = new Drafts(this.apiClient);
         this.events = new Events(this.apiClient);
+        this.grants = new Grants(this.apiClient);
         this.messages = new Messages(this.apiClient);
         this.threads = new Threads(this.apiClient);
         this.webhooks = new Webhooks(this.apiClient);
+        this.folders = new Folders(this.apiClient);
+        this.contacts = new Contacts(this.apiClient);
+        this.attachments = new Attachments(this.apiClient);
         return this;
     }
 }

package/lib/esm/resources/attachments.js

@@ -0,0 +1,53 @@
+import { Resource } from './resource.js';
+/**
+ * Nylas Attachments API
+ *
+ * The Nylas Attachments API allows you to retrieve metadata and download attachments.
+ */
+export class Attachments extends Resource {
+    /**
+     * Returns an attachment by ID.
+     * @return The Attachment metadata
+     */
+    find({ identifier, attachmentId, queryParams, overrides, }) {
+        return super._find({
+            path: `/v3/grants/${identifier}/attachments/${attachmentId}`,
+            queryParams,
+            overrides,
+        });
+    }
+    /**
+     * Download the attachment data
+     *
+     * This method returns a NodeJS.ReadableStream which can be used to stream the attachment data.
+     * This is particularly useful for handling large attachments efficiently, as it avoids loading
+     * the entire file into memory. The stream can be piped to a file stream or used in any other way
+     * that Node.js streams are typically used.
+     *
+     * @param identifier Grant ID or email account to query
+     * @param attachmentId The id of the attachment to download.
+     * @param queryParams The query parameters to include in the request
+     * @returns {NodeJS.ReadableStream} The ReadableStream containing the file data.
+     */
+    download({ identifier, attachmentId, queryParams, overrides, }) {
+        return this._getStream({
+            path: `/v3/grants/${identifier}/attachments/${attachmentId}/download`,
+            queryParams,
+            overrides,
+        });
+    }
+    /**
+     * Download the attachment as a byte array
+     * @param identifier Grant ID or email account to query
+     * @param attachmentId The id of the attachment to download.
+     * @param queryParams The query parameters to include in the request
+     * @return The raw file data
+     */
+    downloadBytes({ identifier, attachmentId, queryParams, overrides, }) {
+        return super._getRaw({
+            path: `/v3/grants/${identifier}/attachments/${attachmentId}/download`,
+            queryParams,
+            overrides,
+        });
+    }
+}