nylas 7.2.0 → 7.3.0

package/lib/cjs/apiClient.js

@@ -9,10 +9,11 @@ const version_js_1 = require("./version.js");
  * @ignore Not for public use
  */
 class APIClient {
-    constructor({ apiKey, apiUri, timeout }) {
+    constructor({ apiKey, apiUri, timeout, headers }) {
         this.apiKey = apiKey;
         this.serverUrl = apiUri;
         this.timeout = timeout * 1000; // fetch timeout uses milliseconds
+        this.headers = headers;
     }
     setRequestUrl({ overrides, path, queryParams, }) {
         const url = new URL(`${overrides?.apiUri || this.serverUrl}${path}`);
@@ -39,11 +40,16 @@ class APIClient {
         return url;
     }
     setRequestHeaders({ headers, overrides, }) {
+        const mergedHeaders = {
+            ...headers,
+            ...this.headers,
+            ...overrides?.headers,
+        };
         return {
             Accept: 'application/json',
             'User-Agent': `Nylas Node SDK v${version_js_1.SDK_VERSION}`,
             Authorization: `Bearer ${overrides?.apiKey || this.apiKey}`,
-            ...headers,
+            ...mergedHeaders,
         };
     }
     async sendRequest(options) {

package/lib/cjs/nylas.js

@@ -44,7 +44,8 @@ class Nylas {
         this.apiClient = new apiClient_js_1.default({
             apiKey: config.apiKey,
             apiUri: config.apiUri || config_js_1.DEFAULT_SERVER_URL,
-            timeout: config.timeout || 30,
+            timeout: config.timeout || 90,
+            headers: config.headers || {},
         });
         this.applications = new applications_js_1.Applications(this.apiClient);
         this.auth = new auth_js_1.Auth(this.apiClient);

package/lib/cjs/resources/auth.js

@@ -149,9 +149,9 @@ class Auth extends resource_js_1.Resource {
         }
         if (config.loginHint) {
             url.searchParams.set('login_hint', config.loginHint);
-            if (config.includeGrantScopes) {
-                url.searchParams.set('include_grant_scopes', config.includeGrantScopes.toString());
-            }
+        }
+        if (config.includeGrantScopes !== undefined) {
+            url.searchParams.set('include_grant_scopes', config.includeGrantScopes.toString());
         }
         if (config.scope) {
             url.searchParams.set('scope', config.scope.join(' '));

package/lib/cjs/resources/drafts.js

@@ -35,11 +35,23 @@ class Drafts extends resource_js_1.Resource {
      * @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,
+        const path = `/v3/grants/${identifier}/drafts`;
+        // Use form data only if the attachment size is greater than 3mb
+        const attachmentSize = requestBody.attachments?.reduce(function (_, attachment) {
+            return attachment.size || 0;
+        }, 0) || 0;
+        if (attachmentSize >= messages_js_1.Messages.MAXIMUM_JSON_ATTACHMENT_SIZE) {
+            const form = messages_js_1.Messages._buildFormRequest(requestBody);
+            return this.apiClient.request({
+                method: 'POST',
+                path,
+                form,
+                overrides,
+            });
+        }
+        return super._create({
+            path,
+            requestBody,
             overrides,
         });
     }
@@ -48,11 +60,23 @@ class Drafts extends resource_js_1.Resource {
      * @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,
+        const path = `/v3/grants/${identifier}/drafts/${draftId}`;
+        // Use form data only if the attachment size is greater than 3mb
+        const attachmentSize = requestBody.attachments?.reduce(function (_, attachment) {
+            return attachment.size || 0;
+        }, 0) || 0;
+        if (attachmentSize >= messages_js_1.Messages.MAXIMUM_JSON_ATTACHMENT_SIZE) {
+            const form = messages_js_1.Messages._buildFormRequest(requestBody);
+            return this.apiClient.request({
+                method: 'PUT',
+                path,
+                form,
+                overrides,
+            });
+        }
+        return super._update({
+            path,
+            requestBody,
             overrides,
         });
     }

package/lib/cjs/resources/messages.js

@@ -63,13 +63,23 @@ class Messages extends resource_js_1.Resource {
      * @return The sent message
      */
     send({ identifier, requestBody, overrides, }) {
-        const form = Messages._buildFormRequest(requestBody);
-        return this.apiClient.request({
+        const path = `/v3/grants/${identifier}/messages/send`;
+        const requestOptions = {
             method: 'POST',
-            path: `/v3/grants/${identifier}/messages/send`,
-            form,
+            path,
             overrides,
-        });
+        };
+        // Use form data only if the attachment size is greater than 3mb
+        const attachmentSize = requestBody.attachments?.reduce(function (_, attachment) {
+            return attachment.size || 0;
+        }, 0) || 0;
+        if (attachmentSize >= Messages.MAXIMUM_JSON_ATTACHMENT_SIZE) {
+            requestOptions.form = Messages._buildFormRequest(requestBody);
+        }
+        else {
+            requestOptions.body = requestBody;
+        }
+        return this.apiClient.request(requestOptions);
     }
     /**
      * Retrieve your scheduled messages
@@ -127,3 +137,5 @@ class Messages extends resource_js_1.Resource {
     }
 }
 exports.Messages = Messages;
+// The maximum size of an attachment that can be sent using json
+Messages.MAXIMUM_JSON_ATTACHMENT_SIZE = 3 * 1024 * 1024;

package/lib/cjs/utils.js

@@ -18,6 +18,21 @@ function createFileRequestBuilder(filePath) {
     };
 }
 exports.createFileRequestBuilder = createFileRequestBuilder;
+/**
+ * Applies the casing function and ensures numeric parts are preceded by underscores in snake_case.
+ * @param casingFunction The original casing function.
+ * @param input The string to convert.
+ * @returns The converted string.
+ */
+function applyCasing(casingFunction, input) {
+    const transformed = casingFunction(input);
+    if (casingFunction === change_case_1.snakeCase) {
+        return transformed.replace(/(\d+)/g, '_$1');
+    }
+    else {
+        return transformed.replace(/_+(\d+)/g, (match, p1) => p1);
+    }
+}
 /**
  * A utility function that recursively converts all keys in an object to a given case.
  * @param obj The object to convert
@@ -33,7 +48,7 @@ function convertCase(obj, casingFunction, excludeKeys) {
             newObj[key] = obj[key];
         }
         else if (Array.isArray(obj[key])) {
-            newObj[casingFunction(key)] = obj[key].map(item => {
+            newObj[applyCasing(casingFunction, key)] = obj[key].map(item => {
                 if (typeof item === 'object') {
                     return convertCase(item, casingFunction);
                 }
@@ -43,10 +58,10 @@ function convertCase(obj, casingFunction, excludeKeys) {
             });
         }
         else if (typeof obj[key] === 'object' && obj[key] !== null) {
-            newObj[casingFunction(key)] = convertCase(obj[key], casingFunction);
+            newObj[applyCasing(casingFunction, key)] = convertCase(obj[key], casingFunction);
         }
         else {
-            newObj[casingFunction(key)] = obj[key];
+            newObj[applyCasing(casingFunction, key)] = obj[key];
         }
     }
     return newObj;

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.2.0';
+exports.SDK_VERSION = '7.3.0';

package/lib/esm/apiClient.js

@@ -7,10 +7,11 @@ import { SDK_VERSION } from './version.js';
  * @ignore Not for public use
  */
 export default class APIClient {
-    constructor({ apiKey, apiUri, timeout }) {
+    constructor({ apiKey, apiUri, timeout, headers }) {
         this.apiKey = apiKey;
         this.serverUrl = apiUri;
         this.timeout = timeout * 1000; // fetch timeout uses milliseconds
+        this.headers = headers;
     }
     setRequestUrl({ overrides, path, queryParams, }) {
         const url = new URL(`${overrides?.apiUri || this.serverUrl}${path}`);
@@ -37,11 +38,16 @@ export default class APIClient {
         return url;
     }
     setRequestHeaders({ headers, overrides, }) {
+        const mergedHeaders = {
+            ...headers,
+            ...this.headers,
+            ...overrides?.headers,
+        };
         return {
             Accept: 'application/json',
             'User-Agent': `Nylas Node SDK v${SDK_VERSION}`,
             Authorization: `Bearer ${overrides?.apiKey || this.apiKey}`,
-            ...headers,
+            ...mergedHeaders,
         };
     }
     async sendRequest(options) {

package/lib/esm/nylas.js

@@ -28,7 +28,8 @@ export default class Nylas {
         this.apiClient = new APIClient({
             apiKey: config.apiKey,
             apiUri: config.apiUri || DEFAULT_SERVER_URL,
-            timeout: config.timeout || 30,
+            timeout: config.timeout || 90,
+            headers: config.headers || {},
         });
         this.applications = new Applications(this.apiClient);
         this.auth = new Auth(this.apiClient);

package/lib/esm/resources/auth.js

@@ -146,9 +146,9 @@ export class Auth extends Resource {
         }
         if (config.loginHint) {
             url.searchParams.set('login_hint', config.loginHint);
-            if (config.includeGrantScopes) {
-                url.searchParams.set('include_grant_scopes', config.includeGrantScopes.toString());
-            }
+        }
+        if (config.includeGrantScopes !== undefined) {
+            url.searchParams.set('include_grant_scopes', config.includeGrantScopes.toString());
         }
         if (config.scope) {
             url.searchParams.set('scope', config.scope.join(' '));

package/lib/esm/resources/drafts.js

@@ -32,11 +32,23 @@ export class Drafts extends Resource {
      * @return The draft
      */
     create({ identifier, requestBody, overrides, }) {
-        const form = Messages._buildFormRequest(requestBody);
-        return this.apiClient.request({
-            method: 'POST',
-            path: `/v3/grants/${identifier}/drafts`,
-            form,
+        const path = `/v3/grants/${identifier}/drafts`;
+        // Use form data only if the attachment size is greater than 3mb
+        const attachmentSize = requestBody.attachments?.reduce(function (_, attachment) {
+            return attachment.size || 0;
+        }, 0) || 0;
+        if (attachmentSize >= Messages.MAXIMUM_JSON_ATTACHMENT_SIZE) {
+            const form = Messages._buildFormRequest(requestBody);
+            return this.apiClient.request({
+                method: 'POST',
+                path,
+                form,
+                overrides,
+            });
+        }
+        return super._create({
+            path,
+            requestBody,
             overrides,
         });
     }
@@ -45,11 +57,23 @@ export class Drafts extends Resource {
      * @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,
+        const path = `/v3/grants/${identifier}/drafts/${draftId}`;
+        // Use form data only if the attachment size is greater than 3mb
+        const attachmentSize = requestBody.attachments?.reduce(function (_, attachment) {
+            return attachment.size || 0;
+        }, 0) || 0;
+        if (attachmentSize >= Messages.MAXIMUM_JSON_ATTACHMENT_SIZE) {
+            const form = Messages._buildFormRequest(requestBody);
+            return this.apiClient.request({
+                method: 'PUT',
+                path,
+                form,
+                overrides,
+            });
+        }
+        return super._update({
+            path,
+            requestBody,
             overrides,
         });
     }

package/lib/esm/resources/messages.js

@@ -60,13 +60,23 @@ export class Messages extends Resource {
      * @return The sent message
      */
     send({ identifier, requestBody, overrides, }) {
-        const form = Messages._buildFormRequest(requestBody);
-        return this.apiClient.request({
+        const path = `/v3/grants/${identifier}/messages/send`;
+        const requestOptions = {
             method: 'POST',
-            path: `/v3/grants/${identifier}/messages/send`,
-            form,
+            path,
             overrides,
-        });
+        };
+        // Use form data only if the attachment size is greater than 3mb
+        const attachmentSize = requestBody.attachments?.reduce(function (_, attachment) {
+            return attachment.size || 0;
+        }, 0) || 0;
+        if (attachmentSize >= Messages.MAXIMUM_JSON_ATTACHMENT_SIZE) {
+            requestOptions.form = Messages._buildFormRequest(requestBody);
+        }
+        else {
+            requestOptions.body = requestBody;
+        }
+        return this.apiClient.request(requestOptions);
     }
     /**
      * Retrieve your scheduled messages
@@ -123,3 +133,5 @@ export class Messages extends Resource {
         return form;
     }
 }
+// The maximum size of an attachment that can be sent using json
+Messages.MAXIMUM_JSON_ATTACHMENT_SIZE = 3 * 1024 * 1024;

package/lib/esm/utils.js

@@ -14,6 +14,21 @@ export function createFileRequestBuilder(filePath) {
         size: stats.size,
     };
 }
+/**
+ * Applies the casing function and ensures numeric parts are preceded by underscores in snake_case.
+ * @param casingFunction The original casing function.
+ * @param input The string to convert.
+ * @returns The converted string.
+ */
+function applyCasing(casingFunction, input) {
+    const transformed = casingFunction(input);
+    if (casingFunction === snakeCase) {
+        return transformed.replace(/(\d+)/g, '_$1');
+    }
+    else {
+        return transformed.replace(/_+(\d+)/g, (match, p1) => p1);
+    }
+}
 /**
  * A utility function that recursively converts all keys in an object to a given case.
  * @param obj The object to convert
@@ -29,7 +44,7 @@ function convertCase(obj, casingFunction, excludeKeys) {
             newObj[key] = obj[key];
         }
         else if (Array.isArray(obj[key])) {
-            newObj[casingFunction(key)] = obj[key].map(item => {
+            newObj[applyCasing(casingFunction, key)] = obj[key].map(item => {
                 if (typeof item === 'object') {
                     return convertCase(item, casingFunction);
                 }
@@ -39,10 +54,10 @@ function convertCase(obj, casingFunction, excludeKeys) {
             });
         }
         else if (typeof obj[key] === 'object' && obj[key] !== null) {
-            newObj[casingFunction(key)] = convertCase(obj[key], casingFunction);
+            newObj[applyCasing(casingFunction, key)] = convertCase(obj[key], casingFunction);
         }
         else {
-            newObj[casingFunction(key)] = obj[key];
+            newObj[applyCasing(casingFunction, key)] = obj[key];
         }
     }
     return newObj;

package/lib/esm/version.js

@@ -1,2 +1,2 @@
 // This file is generated by scripts/exportVersion.js
-export const SDK_VERSION = '7.2.0';
+export const SDK_VERSION = '7.3.0';

package/lib/types/apiClient.d.ts

@@ -57,7 +57,11 @@ export default class APIClient {
      * The timeout for requests to the Nylas API, in seconds
      */
     timeout: number;
-    constructor({ apiKey, apiUri, timeout }: Required<NylasConfig>);
+    /**
+     * Additional headers to send with outgoing requests
+     */
+    headers: Record<string, string>;
+    constructor({ apiKey, apiUri, timeout, headers }: Required<NylasConfig>);
     private setRequestUrl;
     private setQueryStrings;
     private setRequestHeaders;

package/lib/types/config.d.ts

@@ -3,11 +3,13 @@
  * @property apiKey The Nylas API key to use for authentication
  * @property apiUri The URL to use for communicating with the Nylas API
  * @property timeout The timeout for requests to the Nylas API, in seconds
+ * @property headers Additional headers to send with outgoing requests
  */
 export type NylasConfig = {
     apiKey: string;
     apiUri?: string;
     timeout?: number;
+    headers?: Record<string, string>;
 };
 /**
  * The options that can override the default Nylas API client configuration.

package/lib/types/models/availability.d.ts

@@ -52,7 +52,7 @@ export interface GetAvailabilityRequest {
     /**
      * When set to true, the availability time slots will start at 30 minutes past or on the hour.
      * For example, a free slot starting at 16:10 is considered available only from 16:30.
-     * @deprecated Use [roundTo] instead.
+     * @deprecated Use {@link roundTo} instead.
      */
     roundTo30Minutes?: boolean;
 }

package/lib/types/models/drafts.d.ts

@@ -2,6 +2,16 @@ import { BaseMessage } from './messages.js';
 import { ListQueryParams } from './listQueryParams.js';
 import { EmailName } from './events.js';
 import { CreateAttachmentRequest } from './attachments.js';
+export interface CustomHeader {
+    /**
+     * The name of the custom header.
+     */
+    name: string;
+    /**
+     * The value of the custom header.
+     */
+    value: string;
+}
 /**
  * Interface representing a request to create a draft.
  */
@@ -55,6 +65,10 @@ export interface CreateDraftRequest {
      * Options for tracking opens, links, and thread replies.
      */
     trackingOptions?: TrackingOptions;
+    /**
+     * An array of custom headers to add to the message.
+     */
+    customHeaders?: CustomHeader[];
 }
 /**
  * Interface representing a request to send a message.

package/lib/types/models/events.d.ts

@@ -1,5 +1,7 @@
 import { ListQueryParams } from './listQueryParams.js';
 import { Subset } from '../utils.js';
+import { NylasBaseResponse } from './response.js';
+import { NylasApiErrorResponseData } from './error.js';
 /**
  * Interface representing a Nylas Event object.
  */
@@ -192,6 +194,13 @@ export type UpdateEventRequest = Subset<CreateEventRequest>;
 export type SendRsvpRequest = {
     status: RsvpStatus;
 };
+/**
+ * Interface representing the response from sending RSVP to an event.
+ * @property sendIcsError If the send-rsvp request succeeded but the ICS email could not be sent, this will contain the error.
+ */
+export interface SendRsvpResponse extends NylasBaseResponse {
+    sendIcsError?: NylasApiErrorResponseData;
+}
 /**
  * Interface representing the query parameters for listing events.
  */
@@ -329,7 +338,7 @@ type When = Time | Timespan | Date | Datespan;
 /**
  * Type representing the different objects representing time and duration when creating events.
  */
-type CreateWhen = Omit<Time, 'type'> | Omit<Timespan, 'type'> | Omit<Date, 'type'> | Omit<Datespan, 'type'>;
+type CreateWhen = Omit<Time, 'object'> | Omit<Timespan, 'object'> | Omit<Date, 'object'> | Omit<Datespan, 'object'>;
 /**
  * Enum representing the different types of when objects.
  */
@@ -409,7 +418,7 @@ export interface Time {
     /**
      * The type of 'when' object.
      */
-    type: WhenType.Time;
+    object: WhenType.Time;
 }
 /**
  * Class representation of a time span with start and end times.
@@ -439,7 +448,7 @@ export interface Timespan {
     /**
      * The type of 'when' object.
      */
-    type: WhenType.Timespan;
+    object: WhenType.Timespan;
 }
 /**
  * Class representation of an entire day spans without specific times.
@@ -454,7 +463,7 @@ export interface Date {
     /**
      * The type of 'when' object.
      */
-    type: WhenType.Date;
+    object: WhenType.Date;
 }
 /**
  * Class representation of a specific dates without clock-based start or end times.
@@ -474,7 +483,7 @@ export interface Datespan {
     /**
      * The type of 'when' object.
      */
-    type: WhenType.Datespan;
+    object: WhenType.Datespan;
 }
 /**
  * Interface representing an Event participant.
@@ -523,7 +532,7 @@ export interface ReminderOverride {
      * The number of minutes before the event start time when a user wants a reminder for this event.
      * Reminder minutes are in the following format: "[20]".
      */
-    reminderMinutes: string;
+    reminderMinutes: number;
     /**
      * Method to remind the user about the event. (Google only).
      */

package/lib/types/resources/events.d.ts

@@ -1,5 +1,5 @@
 import { Overrides } from '../config.js';
-import { CreateEventQueryParams, CreateEventRequest, DestroyEventQueryParams, Event, FindEventQueryParams, ListEventQueryParams, SendRsvpQueryParams, SendRsvpRequest, UpdateEventQueryParams, UpdateEventRequest } from '../models/events.js';
+import { CreateEventQueryParams, CreateEventRequest, DestroyEventQueryParams, Event, FindEventQueryParams, ListEventQueryParams, SendRsvpQueryParams, SendRsvpRequest, SendRsvpResponse, UpdateEventQueryParams, UpdateEventRequest } from '../models/events.js';
 import { NylasBaseResponse, NylasResponse, NylasListResponse } from '../models/response.js';
 import { AsyncListResponse, Resource } from './resource.js';
 /**
@@ -101,6 +101,6 @@ export declare class Events extends Resource {
      * 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, }: SendRsvpParams & Overrides): Promise<NylasBaseResponse>;
+    sendRsvp({ identifier, eventId, requestBody, queryParams, overrides, }: SendRsvpParams & Overrides): Promise<SendRsvpResponse>;
 }
 export {};

package/lib/types/resources/messages.d.ts

@@ -84,6 +84,7 @@ export type StopScheduledMessageParams = FindScheduledMessageParams;
  */
 export declare class Messages extends Resource {
     smartCompose: SmartCompose;
+    static MAXIMUM_JSON_ATTACHMENT_SIZE: number;
     constructor(apiClient: APIClient);
     /**
      * Return all Messages

package/lib/types/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "7.2.0";
+export declare const SDK_VERSION = "7.3.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nylas",
-  "version": "7.2.0",
+  "version": "7.3.0",
   "description": "A NodeJS wrapper for the Nylas REST API for email, contacts, and calendar.",
   "main": "lib/cjs/nylas.js",
   "types": "lib/types/nylas.d.ts",