nylas 7.1.0 → 7.2.1

package/lib/cjs/nylas.js

@@ -44,7 +44,7 @@ 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,
         });
         this.applications = new applications_js_1.Applications(this.apiClient);
         this.auth = new auth_js_1.Auth(this.apiClient);

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

@@ -30,10 +30,11 @@ class Messages extends resource_js_1.Resource {
      * Return a Message
      * @return The message
      */
-    find({ identifier, messageId, overrides, }) {
+    find({ identifier, messageId, overrides, queryParams, }) {
         return super._find({
             path: `/v3/grants/${identifier}/messages/${messageId}`,
             overrides,
+            queryParams,
         });
     }
     /**
@@ -62,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
@@ -126,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.1.0';
+exports.SDK_VERSION = '7.2.1';

package/lib/esm/nylas.js

@@ -28,7 +28,7 @@ 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,
         });
         this.applications = new Applications(this.apiClient);
         this.auth = new Auth(this.apiClient);

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

@@ -27,10 +27,11 @@ export class Messages extends Resource {
      * Return a Message
      * @return The message
      */
-    find({ identifier, messageId, overrides, }) {
+    find({ identifier, messageId, overrides, queryParams, }) {
         return super._find({
             path: `/v3/grants/${identifier}/messages/${messageId}`,
             overrides,
+            queryParams,
         });
     }
     /**
@@ -59,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
@@ -122,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.1.0';
+export const SDK_VERSION = '7.2.1';

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

@@ -5,7 +5,7 @@ type AccessType = 'online' | 'offline';
 /**
  * Type for the different OAuth providers Nylas supports.
  */
-export type Provider = 'google' | 'imap' | 'microsoft' | 'virtual-calendar';
+export type Provider = 'google' | 'imap' | 'microsoft' | 'icloud' | 'virtual-calendar';
 /**
  * Configuration for generating a URL for OAuth 2.0 authentication.
  */
@@ -167,10 +167,6 @@ export interface ProviderDetectParams {
      * Email address to detect the provider for.
      */
     email: string;
-    /**
-     * Client ID of the Nylas application.
-     */
-    clientId: string;
     /**
      * Search by all providers regardless of created integrations. If unset, defaults to false.
      */

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

@@ -39,14 +39,22 @@ export interface GetAvailabilityRequest {
      */
     intervalMinutes?: number;
     /**
-     * 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.
+     * The number of minutes to round the time slots to.
+     * This allows for rounding to any multiple of 5 minutes, up to a maximum of 60 minutes.
+     * The default value is set to 15 minutes.
+     * When this variable is assigned a value, it overrides the behavior of the {@link roundTo30Minutes} flag, if it was set.
      */
-    roundTo30Minutes?: boolean;
+    roundTo?: number;
     /**
      * The rules to apply when checking availability.
      */
     availabilityRules?: AvailabilityRules;
+    /**
+     * 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 {@link roundTo} instead.
+     */
+    roundTo30Minutes?: boolean;
 }
 /**
  * Interface for a Nylas availability time slot

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

@@ -1,9 +1,48 @@
-import { BaseMessage, BaseCreateMessage } from './messages.js';
+import { BaseMessage } from './messages.js';
 import { ListQueryParams } from './listQueryParams.js';
+import { EmailName } from './events.js';
+import { CreateAttachmentRequest } from './attachments.js';
 /**
  * Interface representing a request to create a draft.
  */
-export interface CreateDraftRequest extends BaseCreateMessage {
+export interface CreateDraftRequest {
+    /**
+     *  An array of name/email address pairs that the message was sent from. This is usually one pair only, but can be many.
+     */
+    from?: EmailName[];
+    /**
+     * An array of message recipients.
+     */
+    to: EmailName[];
+    /**
+     * An array of bcc recipients.
+     */
+    bcc?: EmailName[];
+    /**
+     * An array of cc recipients.
+     */
+    cc?: EmailName[];
+    /**
+     * An array of name and email pairs that override the sent reply-to headers.
+     */
+    replyTo?: EmailName[];
+    /**
+     * An array of files to attach to the message.
+     */
+    attachments?: CreateAttachmentRequest[];
+    /**
+     * The message subject.
+     */
+    subject?: string;
+    /**
+     * The full HTML message body.
+     * Messages with only plain-text representations are up-converted to HTML.
+     */
+    body?: string;
+    /**
+     * Whether or not the message has been starred by the user.
+     */
+    starred?: boolean;
     /**
      * Unix timestamp to send the message at.
      */
@@ -21,6 +60,10 @@ export interface CreateDraftRequest extends BaseCreateMessage {
  * Interface representing a request to send a message.
  */
 export interface SendMessageRequest extends CreateDraftRequest {
+    /**
+     * An array of message senders.
+     */
+    from?: EmailName[];
     /**
      * Whether or not to use draft support.
      * This is primarily used when dealing with large attachments.

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

@@ -46,6 +46,13 @@ export interface Folder {
      * The number of unread items inside of a folder.
      */
     unreadCount?: number;
+    /**
+     * Common attribute descriptors shared by system folders across providers.
+     * For example, Sent email folders have the `["\\Sent"]` attribute.
+     * For IMAP grants, IMAP providers provide the attributes.
+     * For Google and Microsoft Graph, Nylas matches system folders to a set of common attributes.
+     */
+    attributes?: string[];
 }
 /**
  * Interface for creating a new folder.

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

@@ -1,10 +1,31 @@
 import { EmailName } from './events.js';
 import { ListQueryParams } from './listQueryParams.js';
-import { Attachment, CreateAttachmentRequest } from './attachments.js';
+import { Attachment } from './attachments.js';
 /**
- * @internal Internal interface for creating a message.
+ * @internal Internal interface for a message.
  */
-export interface BaseCreateMessage {
+export interface BaseMessage {
+    /**
+     * The unique identifier for the message.
+     */
+    id: string;
+    /**
+     * Grant ID of the Nylas account.
+     */
+    grantId: string;
+    /**
+     * Unix timestamp of when the message was received by the mail server.
+     * This may be different from the unverified Date header in raw message object.
+     */
+    date: number;
+    /**
+     * Unix timestamp of when the message was created.
+     */
+    createdAt: number;
+    /**
+     * The ID of the folder(s) the message appears in.
+     */
+    folders: string[];
     /**
      * An array of message recipients.
      */
@@ -21,10 +42,6 @@ export interface BaseCreateMessage {
      * An array of name and email pairs that override the sent reply-to headers.
      */
     replyTo?: EmailName[];
-    /**
-     * An array of files to attach to the message.
-     */
-    attachments?: CreateAttachmentRequest[];
     /**
      * The message subject.
      */
@@ -38,32 +55,6 @@ export interface BaseCreateMessage {
      * Whether or not the message has been starred by the user.
      */
     starred?: boolean;
-}
-/**
- * @internal Internal interface for a message.
- */
-export interface BaseMessage extends Omit<BaseCreateMessage, 'attachments'> {
-    /**
-     * The unique identifier for the message.
-     */
-    id: string;
-    /**
-     * Grant ID of the Nylas account.
-     */
-    grantId: string;
-    /**
-     * Unix timestamp of when the message was received by the mail server.
-     * This may be different from the unverified Date header in raw message object.
-     */
-    date: number;
-    /**
-     * Unix timestamp of when the message was created.
-     */
-    createdAt: number;
-    /**
-     * The ID of the folder(s) the message appears in.
-     */
-    folders: string[];
     /**
      * An array of message senders.
      */
@@ -104,6 +95,19 @@ export interface Message extends BaseMessage {
      * A list of key-value pairs storing additional data.
      */
     metadata?: Record<string, unknown>;
+    /**
+     * The unique identifier for the scheduled message.
+     */
+    scheduleId?: string;
+    /**
+     * Unix timestamp to send the message at.
+     */
+    sendAt?: number;
+    /**
+     * Whether or not to use draft support.
+     * This is primarily used when dealing with large attachments.
+     */
+    useDraft?: boolean;
 }
 /**
  * Interface representing a request to update a message.

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

@@ -1,8 +1,8 @@
 import { AsyncListResponse, Resource } from './resource.js';
-import { BaseCreateMessage, FindMessageQueryParams, ListMessagesQueryParams, Message, ScheduledMessage, ScheduledMessagesList, StopScheduledMessageResponse, UpdateMessageRequest } from '../models/messages.js';
+import { FindMessageQueryParams, ListMessagesQueryParams, Message, ScheduledMessage, ScheduledMessagesList, StopScheduledMessageResponse, UpdateMessageRequest } from '../models/messages.js';
 import { Overrides } from '../config.js';
 import { NylasBaseResponse, NylasListResponse, NylasResponse } from '../models/response.js';
-import { SendMessageRequest, UpdateDraftRequest } from '../models/drafts.js';
+import { CreateDraftRequest, SendMessageRequest, UpdateDraftRequest } from '../models/drafts.js';
 import * as FormData from 'form-data';
 import { SmartCompose } from './smartCompose.js';
 import APIClient from '../apiClient.js';
@@ -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
@@ -94,7 +95,7 @@ export declare class Messages extends Resource {
      * Return a Message
      * @return The message
      */
-    find({ identifier, messageId, overrides, }: FindMessageParams & Overrides): Promise<NylasResponse<Message>>;
+    find({ identifier, messageId, overrides, queryParams, }: FindMessageParams & Overrides): Promise<NylasResponse<Message>>;
     /**
      * Update a Message
      * @return The updated message
@@ -125,5 +126,5 @@ export declare class Messages extends Resource {
      * @return The confirmation of the stopped scheduled message
      */
     stopScheduledMessage({ identifier, scheduleId, overrides, }: StopScheduledMessageParams & Overrides): Promise<NylasResponse<StopScheduledMessageResponse>>;
-    static _buildFormRequest(requestBody: BaseCreateMessage | UpdateDraftRequest): FormData;
+    static _buildFormRequest(requestBody: CreateDraftRequest | UpdateDraftRequest | SendMessageRequest): FormData;
 }

package/lib/types/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "7.1.0";
+export declare const SDK_VERSION = "7.2.1";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nylas",
-  "version": "7.1.0",
+  "version": "7.2.1",
   "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",