nylas 8.1.1 → 8.1.2

package/lib/cjs/apiClient.js

@@ -5,7 +5,7 @@ const error_js_1 = require("./models/error.js");
 const utils_js_1 = require("./utils.js");
 const version_js_1 = require("./version.js");
 const form_data_encoder_1 = require("form-data-encoder");
-const stream_1 = require("stream");
+const node_stream_1 = require("node:stream");
 const change_case_1 = require("change-case");
 /**
  * The header key for the debugging flow ID
@@ -164,7 +164,7 @@ class APIClient {
             // Set the Content-Type header with the boundary from the encoder
             requestOptions.headers['Content-Type'] = encoder.contentType;
             // Convert the encoded form data to a readable stream for the request body
-            requestOptions.body = stream_1.Readable.from(encoder);
+            requestOptions.body = node_stream_1.Readable.from(encoder);
             // Node.js native fetch requires duplex: 'half' when sending a streaming body
             requestOptions.duplex = 'half';
         }

package/lib/cjs/models/messages.js

@@ -7,6 +7,7 @@ exports.MessageFields = void 0;
 var MessageFields;
 (function (MessageFields) {
     MessageFields["STANDARD"] = "standard";
+    MessageFields["INCLUDE_BASIC_HEADERS"] = "include_basic_headers";
     MessageFields["INCLUDE_HEADERS"] = "include_headers";
     MessageFields["INCLUDE_TRACKING_OPTIONS"] = "include_tracking_options";
     MessageFields["RAW_MIME"] = "raw_mime";

package/lib/cjs/resources/attachments.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Attachments = void 0;
 const utils_js_1 = require("../utils.js");
 const resource_js_1 = require("./resource.js");
+const node_stream_1 = require("node:stream");
 /**
  * Nylas Attachments API
  *
@@ -23,15 +24,15 @@ class Attachments extends resource_js_1.Resource {
     /**
      * Download the attachment data
      *
-     * This method returns a NodeJS.ReadableStream which can be used to stream the attachment data.
+     * This method returns a Web 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.
+     * the entire file into memory. In Node.js, convert it with Readable.fromWeb() when a
+     * NodeJS.ReadableStream is required.
      *
      * @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.
+     * @returns {ReadableStream<Uint8Array>} The ReadableStream containing the file data.
      */
     download({ identifier, attachmentId, queryParams, overrides, }) {
         return this._getStream({
@@ -40,6 +41,27 @@ class Attachments extends resource_js_1.Resource {
             overrides,
         });
     }
+    /**
+     * Download the attachment data as a Node.js readable stream.
+     *
+     * This is a Node.js convenience wrapper around {@link Attachments.download}. Use
+     * {@link Attachments.download} directly in Fetch-native runtimes, such as Cloudflare Workers,
+     * where Web ReadableStreams are the standard stream primitive.
+     *
+     * @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 Node.js readable stream containing the file data.
+     */
+    async downloadNodeStream({ identifier, attachmentId, queryParams, overrides, }) {
+        const stream = await this.download({
+            identifier,
+            attachmentId,
+            queryParams,
+            overrides,
+        });
+        return node_stream_1.Readable.fromWeb(stream);
+    }
     /**
      * Download the attachment as a byte array
      * @param identifier Grant ID or email account to query

package/lib/cjs/resources/messages.js

@@ -81,13 +81,14 @@ class Messages extends resource_js_1.Resource {
      * Send an email
      * @return The sent message
      */
-    async send({ identifier, requestBody, overrides, }) {
+    async send({ identifier, requestBody, queryParams, overrides, }) {
         const path = (0, utils_js_1.makePathParams)('/v3/grants/{identifier}/messages/send', {
             identifier,
         });
         const requestOptions = {
             method: 'POST',
             path,
+            queryParams,
             overrides,
         };
         // Use form data if the total payload size (body + attachments) is greater than 3mb

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 = '8.1.1';
+exports.SDK_VERSION = '8.1.2';

package/lib/esm/apiClient.js

@@ -2,7 +2,7 @@ import { NylasApiError, NylasOAuthError, NylasSdkTimeoutError, } from './models/
 import { objKeysToCamelCase, objKeysToSnakeCase } from './utils.js';
 import { SDK_VERSION } from './version.js';
 import { FormDataEncoder } from 'form-data-encoder';
-import { Readable } from 'stream';
+import { Readable } from 'node:stream';
 import { snakeCase } from 'change-case';
 /**
  * The header key for the debugging flow ID

package/lib/esm/models/messages.js

@@ -4,6 +4,7 @@
 export var MessageFields;
 (function (MessageFields) {
     MessageFields["STANDARD"] = "standard";
+    MessageFields["INCLUDE_BASIC_HEADERS"] = "include_basic_headers";
     MessageFields["INCLUDE_HEADERS"] = "include_headers";
     MessageFields["INCLUDE_TRACKING_OPTIONS"] = "include_tracking_options";
     MessageFields["RAW_MIME"] = "raw_mime";

package/lib/esm/resources/attachments.js

@@ -1,5 +1,6 @@
 import { makePathParams } from '../utils.js';
 import { Resource } from './resource.js';
+import { Readable } from 'node:stream';
 /**
  * Nylas Attachments API
  *
@@ -20,15 +21,15 @@ export class Attachments extends Resource {
     /**
      * Download the attachment data
      *
-     * This method returns a NodeJS.ReadableStream which can be used to stream the attachment data.
+     * This method returns a Web 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.
+     * the entire file into memory. In Node.js, convert it with Readable.fromWeb() when a
+     * NodeJS.ReadableStream is required.
      *
      * @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.
+     * @returns {ReadableStream<Uint8Array>} The ReadableStream containing the file data.
      */
     download({ identifier, attachmentId, queryParams, overrides, }) {
         return this._getStream({
@@ -37,6 +38,27 @@ export class Attachments extends Resource {
             overrides,
         });
     }
+    /**
+     * Download the attachment data as a Node.js readable stream.
+     *
+     * This is a Node.js convenience wrapper around {@link Attachments.download}. Use
+     * {@link Attachments.download} directly in Fetch-native runtimes, such as Cloudflare Workers,
+     * where Web ReadableStreams are the standard stream primitive.
+     *
+     * @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 Node.js readable stream containing the file data.
+     */
+    async downloadNodeStream({ identifier, attachmentId, queryParams, overrides, }) {
+        const stream = await this.download({
+            identifier,
+            attachmentId,
+            queryParams,
+            overrides,
+        });
+        return Readable.fromWeb(stream);
+    }
     /**
      * Download the attachment as a byte array
      * @param identifier Grant ID or email account to query

package/lib/esm/resources/messages.js

@@ -78,13 +78,14 @@ export class Messages extends Resource {
      * Send an email
      * @return The sent message
      */
-    async send({ identifier, requestBody, overrides, }) {
+    async send({ identifier, requestBody, queryParams, overrides, }) {
         const path = makePathParams('/v3/grants/{identifier}/messages/send', {
             identifier,
         });
         const requestOptions = {
             method: 'POST',
             path,
+            queryParams,
             overrides,
         };
         // Use form data if the total payload size (body + attachments) is greater than 3mb

package/lib/esm/version.js

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

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

@@ -177,6 +177,7 @@ export interface MessageHeaders {
  */
 export declare enum MessageFields {
     STANDARD = "standard",
+    INCLUDE_BASIC_HEADERS = "include_basic_headers",
     INCLUDE_HEADERS = "include_headers",
     INCLUDE_TRACKING_OPTIONS = "include_tracking_options",
     RAW_MIME = "raw_mime"
@@ -304,6 +305,15 @@ export interface FindMessageQueryParams {
      */
     fields?: MessageFields;
 }
+/**
+ * Interface representing the query parameters for sending a message.
+ */
+export interface SendMessageQueryParams {
+    /**
+     * Allows you to specify to return the sent message with headers included.
+     */
+    fields?: MessageFields;
+}
 /**
  * Interface representing the request to clean a message.
  */

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

@@ -52,17 +52,30 @@ export declare class Attachments extends Resource {
     /**
      * Download the attachment data
      *
-     * This method returns a NodeJS.ReadableStream which can be used to stream the attachment data.
+     * This method returns a Web 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.
+     * the entire file into memory. In Node.js, convert it with Readable.fromWeb() when a
+     * NodeJS.ReadableStream is required.
      *
      * @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.
+     * @returns {ReadableStream<Uint8Array>} The ReadableStream containing the file data.
      */
     download({ identifier, attachmentId, queryParams, overrides, }: DownloadAttachmentParams & Overrides): Promise<ReadableStream<Uint8Array>>;
+    /**
+     * Download the attachment data as a Node.js readable stream.
+     *
+     * This is a Node.js convenience wrapper around {@link Attachments.download}. Use
+     * {@link Attachments.download} directly in Fetch-native runtimes, such as Cloudflare Workers,
+     * where Web ReadableStreams are the standard stream primitive.
+     *
+     * @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 Node.js readable stream containing the file data.
+     */
+    downloadNodeStream({ identifier, attachmentId, queryParams, overrides, }: DownloadAttachmentParams & Overrides): Promise<NodeJS.ReadableStream>;
     /**
      * Download the attachment as a byte array
      * @param identifier Grant ID or email account to query

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

@@ -2,7 +2,7 @@ import { FormData } from 'formdata-node';
 import APIClient from '../apiClient.js';
 import { Overrides } from '../config.js';
 import { CreateDraftRequest, SendMessageRequest, UpdateDraftRequest } from '../models/drafts.js';
-import { CleanMessagesRequest, CleanMessagesResponse, FindMessageQueryParams, ListMessagesQueryParams, Message, ScheduledMessage, ScheduledMessagesList, StopScheduledMessageResponse, UpdateMessageRequest } from '../models/messages.js';
+import { CleanMessagesRequest, CleanMessagesResponse, FindMessageQueryParams, ListMessagesQueryParams, Message, ScheduledMessage, ScheduledMessagesList, SendMessageQueryParams, StopScheduledMessageResponse, UpdateMessageRequest } from '../models/messages.js';
 import { NylasBaseResponse, NylasListResponse, NylasResponse } from '../models/response.js';
 import { AsyncListResponse, Resource } from './resource.js';
 import { SmartCompose } from './smartCompose.js';
@@ -50,10 +50,12 @@ export interface DestroyMessageParams {
  * The parameters for the {@link Messages.send} method
  * @property identifier The identifier of the grant to act upon
  * @property requestBody The message to send
+ * @property queryParams The query parameters to include in the request
  */
 export interface SendMessageParams {
     identifier: string;
     requestBody: SendMessageRequest;
+    queryParams?: SendMessageQueryParams;
 }
 /**
  * The parameters for the {@link Messages.listScheduledMessages} method
@@ -119,7 +121,7 @@ export declare class Messages extends Resource {
      * Send an email
      * @return The sent message
      */
-    send({ identifier, requestBody, overrides, }: SendMessageParams & Overrides): Promise<NylasResponse<Message>>;
+    send({ identifier, requestBody, queryParams, overrides, }: SendMessageParams & Overrides): Promise<NylasResponse<Message>>;
     /**
      * Retrieve your scheduled messages
      * @return A list of scheduled messages

package/lib/types/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "8.1.1";
+export declare const SDK_VERSION = "8.1.2";

package/package.json

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