nylas 7.0.0-beta.2 → 7.0.0-beta.4

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,
+        });
+    }
+}

package/lib/esm/resources/auth.js

@@ -1,7 +1,6 @@
 import { v4 as uuid } from 'uuid';
-import sha256 from 'sha256';
+import { createHash } from 'node:crypto';
 import { Resource } from './resource.js';
-import { Grants } from './grants.js';
 /**
  * A collection of authentication related API endpoints
  *
@@ -9,14 +8,6 @@ import { Grants } from './grants.js';
  * Also contains the Grants API and collection of provider API endpoints.
  */
 export class Auth extends Resource {
-    /**
-     * @param apiClient The configured Nylas API client
-     */
-    constructor(apiClient) {
-        super(apiClient);
-        this.apiClient = apiClient;
-        this.grants = new Grants(apiClient);
-    }
     /**
      * Build the URL for authenticating users to your application with OAuth 2.0
      * @param config The configuration for building the URL
@@ -71,7 +62,7 @@ export class Auth extends Resource {
         url.searchParams.set('code_challenge_method', 's256');
         const secret = uuid();
         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() };
     }
@@ -87,6 +78,18 @@ export class Auth extends 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
@@ -110,7 +113,7 @@ export class Auth extends Resource {
     async detectProvider(params) {
         return this.apiClient.request({
             method: 'POST',
-            path: `/v3/grants/providers/detect`,
+            path: `/v3/providers/detect`,
             queryParams: params,
         });
     }
@@ -135,15 +138,17 @@ export class Auth extends 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(sha256(secret)).toString('base64');
+        const hash = createHash('sha256')
+            .update(secret)
+            .digest('hex');
+        return Buffer.from(hash)
+            .toString('base64')
+            .replace(/=+$/, '');
     }
 }

package/lib/esm/resources/calendars.js

@@ -71,4 +71,16 @@ export class Calendars extends 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,
+        });
+    }
 }

package/lib/esm/resources/connectors.js

@@ -0,0 +1,64 @@
+import { Resource } from './resource.js';
+import { Credentials } from './credentials.js';
+export class Connectors extends Resource {
+    /**
+     * @param apiClient client The configured Nylas API client
+     */
+    constructor(apiClient) {
+        super(apiClient);
+        this.credentials = new 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,
+        });
+    }
+}

package/lib/esm/resources/contacts.js

@@ -0,0 +1,72 @@
+import { Resource } from './resource.js';
+/**
+ * Nylas Contacts API
+ *
+ * The Nylas Contacts API allows you to create, update, and delete contacts.
+ */
+export class Contacts extends 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,
+        });
+    }
+}

package/lib/esm/resources/credentials.js

@@ -0,0 +1,56 @@
+import { Resource } from './resource.js';
+export class Credentials extends 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,
+        });
+    }
+}

package/lib/esm/resources/drafts.js

@@ -0,0 +1,77 @@
+import { Resource } from './resource.js';
+import { Messages } from './messages.js';
+/**
+ * Nylas Drafts API
+ *
+ * The Nylas Drafts API allows you to list, find, update, delete, and send drafts on user accounts.
+ */
+export class Drafts extends 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._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._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,
+        });
+    }
+}

package/lib/esm/resources/events.js

@@ -62,4 +62,18 @@ export class Events extends 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,
+        });
+    }
 }

package/lib/esm/resources/folders.js

@@ -0,0 +1,68 @@
+import { Resource } from './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.
+ */
+export class Folders extends 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,
+        });
+    }
+}

package/lib/esm/resources/grants.js

@@ -26,17 +26,6 @@ export class Grants extends Resource {
             overrides,
         });
     }
-    /**
-     * Create a Grant
-     * @return The created Grant
-     */
-    create({ requestBody, overrides, }) {
-        return super._create({
-            path: `/v3/grants`,
-            requestBody,
-            overrides,
-        });
-    }
     /**
      * Update a Grant
      * @return The updated Grant

package/lib/esm/resources/messages.js

@@ -0,0 +1,124 @@
+import { Resource } from './resource.js';
+import * as FormData from 'form-data';
+import { objKeysToSnakeCase } from '../utils.js';
+import { SmartCompose } from './smartCompose.js';
+/**
+ * Nylas Messages API
+ *
+ * The Nylas Messages API allows you to list, find, update, delete, schedule, and send messages on user accounts.
+ */
+export class Messages extends Resource {
+    constructor(apiClient) {
+        super(apiClient);
+        this.smartCompose = new 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) {
+        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,
+            attachments: undefined,
+        };
+        form.append('message', JSON.stringify(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;
+    }
+}

package/lib/esm/resources/redirectUris.js

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

package/lib/esm/resources/resource.js

@@ -104,4 +104,20 @@ export 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,
+        });
+    }
 }