nylas 7.0.0 → 7.2.0

package/lib/cjs/models/index.js

@@ -0,0 +1,38 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// This file is generated by scripts/generateModelIndex.js
+__exportStar(require("./applicationDetails.js"), exports);
+__exportStar(require("./attachments.js"), exports);
+__exportStar(require("./auth.js"), exports);
+__exportStar(require("./availability.js"), exports);
+__exportStar(require("./calendars.js"), exports);
+__exportStar(require("./connectors.js"), exports);
+__exportStar(require("./contacts.js"), exports);
+__exportStar(require("./credentials.js"), exports);
+__exportStar(require("./drafts.js"), exports);
+__exportStar(require("./error.js"), exports);
+__exportStar(require("./events.js"), exports);
+__exportStar(require("./folders.js"), exports);
+__exportStar(require("./freeBusy.js"), exports);
+__exportStar(require("./grants.js"), exports);
+__exportStar(require("./listQueryParams.js"), exports);
+__exportStar(require("./messages.js"), exports);
+__exportStar(require("./redirectUri.js"), exports);
+__exportStar(require("./response.js"), exports);
+__exportStar(require("./smartCompose.js"), exports);
+__exportStar(require("./threads.js"), exports);
+__exportStar(require("./webhooks.js"), exports);

package/lib/cjs/nylas.js

@@ -1,5 +1,20 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./models/index.js"), exports);
 const apiClient_js_1 = require("./apiClient.js");
 const config_js_1 = require("./config.js");
 const calendars_js_1 = require("./resources/calendars.js");

package/lib/cjs/resources/auth.js

@@ -122,6 +122,22 @@ class Auth extends resource_js_1.Resource {
             queryParams: params,
         });
     }
+    /**
+     * Get info about an ID token
+     * @param idToken The ID token to query.
+     * @return The token information
+     */
+    idTokenInfo(idToken) {
+        return this.getTokenInfo({ id_token: idToken });
+    }
+    /**
+     * Get info about an access token
+     * @param accessToken The access token to query.
+     * @return The token information
+     */
+    accessTokenInfo(accessToken) {
+        return this.getTokenInfo({ access_token: accessToken });
+    }
     urlAuthBuilder(config) {
         const url = new URL(`${this.apiClient.serverUrl}/v3/connect/auth`);
         url.searchParams.set('client_id', config.clientId);
@@ -156,5 +172,12 @@ class Auth extends resource_js_1.Resource {
             .toString('base64')
             .replace(/=+$/, '');
     }
+    getTokenInfo(params) {
+        return this.apiClient.request({
+            method: 'GET',
+            path: `/v3/connect/tokeninfo`,
+            queryParams: params,
+        });
+    }
 }
 exports.Auth = Auth;

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

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

package/lib/esm/models/index.js

@@ -0,0 +1,22 @@
+// This file is generated by scripts/generateModelIndex.js
+export * from './applicationDetails.js';
+export * from './attachments.js';
+export * from './auth.js';
+export * from './availability.js';
+export * from './calendars.js';
+export * from './connectors.js';
+export * from './contacts.js';
+export * from './credentials.js';
+export * from './drafts.js';
+export * from './error.js';
+export * from './events.js';
+export * from './folders.js';
+export * from './freeBusy.js';
+export * from './grants.js';
+export * from './listQueryParams.js';
+export * from './messages.js';
+export * from './redirectUri.js';
+export * from './response.js';
+export * from './smartCompose.js';
+export * from './threads.js';
+export * from './webhooks.js';

package/lib/esm/nylas.js

@@ -1,3 +1,4 @@
+export * from './models/index.js';
 import APIClient from './apiClient.js';
 import { DEFAULT_SERVER_URL } from './config.js';
 import { Calendars } from './resources/calendars.js';

package/lib/esm/resources/auth.js

@@ -119,6 +119,22 @@ export class Auth extends Resource {
             queryParams: params,
         });
     }
+    /**
+     * Get info about an ID token
+     * @param idToken The ID token to query.
+     * @return The token information
+     */
+    idTokenInfo(idToken) {
+        return this.getTokenInfo({ id_token: idToken });
+    }
+    /**
+     * Get info about an access token
+     * @param accessToken The access token to query.
+     * @return The token information
+     */
+    accessTokenInfo(accessToken) {
+        return this.getTokenInfo({ access_token: accessToken });
+    }
     urlAuthBuilder(config) {
         const url = new URL(`${this.apiClient.serverUrl}/v3/connect/auth`);
         url.searchParams.set('client_id', config.clientId);
@@ -153,4 +169,11 @@ export class Auth extends Resource {
             .toString('base64')
             .replace(/=+$/, '');
     }
+    getTokenInfo(params) {
+        return this.apiClient.request({
+            method: 'GET',
+            path: `/v3/connect/tokeninfo`,
+            queryParams: params,
+        });
+    }
 }

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

package/lib/esm/version.js

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

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.
      */
@@ -197,4 +193,33 @@ export interface ProviderDetectResponse {
      */
     type?: string;
 }
+/**
+ * Interface representing a Nylas token information response.
+ */
+export interface TokenInfoResponse {
+    /**
+     * The issuer of the token.
+     */
+    iss: string;
+    /**
+     * The token's audience.
+     */
+    aud: string;
+    /**
+     * The time that the token was issued.
+     */
+    iat: number;
+    /**
+     * The time that the token expires.
+     */
+    exp: number;
+    /**
+     * The token's subject.
+     */
+    sub?: string;
+    /**
+     * The email address of the Grant belonging to the user's token.
+     */
+    email?: string;
+}
 export {};

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 [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/events.d.ts

@@ -28,14 +28,6 @@ export interface Event {
      * If the event participants are able to edit the event.
      */
     readOnly: boolean;
-    /**
-     * Unix timestamp when the event was created.
-     */
-    createdAt: number;
-    /**
-     * Unix timestamp when the event was last updated.
-     */
-    updatedAt: number;
     /**
      * List of participants invited to the event. Participants may also be rooms or resources.
      */
@@ -109,6 +101,14 @@ export interface Event {
      * Status of the event.
      */
     status?: Status;
+    /**
+     * Unix timestamp when the event was created.
+     */
+    createdAt?: number;
+    /**
+     * Unix timestamp when the event was last updated.
+     */
+    updatedAt?: number;
 }
 /**
  * Interface representing a request to create an event.

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/index.d.ts

@@ -0,0 +1,21 @@
+export * from './applicationDetails.js';
+export * from './attachments.js';
+export * from './auth.js';
+export * from './availability.js';
+export * from './calendars.js';
+export * from './connectors.js';
+export * from './contacts.js';
+export * from './credentials.js';
+export * from './drafts.js';
+export * from './error.js';
+export * from './events.js';
+export * from './folders.js';
+export * from './freeBusy.js';
+export * from './grants.js';
+export * from './listQueryParams.js';
+export * from './messages.js';
+export * from './redirectUri.js';
+export * from './response.js';
+export * from './smartCompose.js';
+export * from './threads.js';
+export * from './webhooks.js';

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/models/webhooks.d.ts

@@ -13,11 +13,11 @@ export interface Webhook {
     /**
      * The url to send webhooks to.
      */
-    callbackUrl: string;
+    webhookUrl: string;
     /**
      * The status of the new destination.
      */
-    status: 'active' | 'failing' | 'failed' | 'pause';
+    status: WebhookStatus;
     /**
      * The time the status field was last updated, represented as a Unix timestamp in seconds.
      */
@@ -37,7 +37,7 @@ export interface Webhook {
     /**
      * The email addresses that Nylas notifies when a webhook is down for a while.
      */
-    notificationEmailAddress?: string;
+    notificationEmailAddresses?: string[];
 }
 /**
  * Class representing a Nylas webhook with secret.
@@ -90,7 +90,7 @@ export interface CreateWebhookRequest {
     /**
      * The url to send webhooks to.
      */
-    callbackUrl: string;
+    webhookUrl: string;
     /**
      * A human-readable description of the webhook destination.
      */
@@ -98,7 +98,7 @@ export interface CreateWebhookRequest {
     /**
      * The email addresses that Nylas notifies when a webhook is down for a while.
      */
-    notificationEmailAddress?: string;
+    notificationEmailAddresses?: string[];
 }
 /**
  * Class representation of a Nylas update webhook request.
@@ -121,3 +121,7 @@ export declare enum WebhookTriggers {
     MessageSendSuccess = "message.send_success",
     MessageSendFailed = "message.send_failed"
 }
+/**
+ * Enum representing the available webhook statuses.
+ */
+export type WebhookStatus = 'active' | 'failing' | 'failed' | 'pause';

package/lib/types/nylas.d.ts

@@ -1,3 +1,4 @@
+export * from './models/index.js';
 import APIClient from './apiClient.js';
 import { NylasConfig } from './config.js';
 import { Calendars } from './resources/calendars.js';

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

@@ -1,5 +1,5 @@
 import { Resource } from './resource.js';
-import { URLForAdminConsentConfig, URLForAuthenticationConfig, CodeExchangeRequest, PKCEAuthURL, TokenExchangeRequest, CodeExchangeResponse, ProviderDetectParams, ProviderDetectResponse } from '../models/auth.js';
+import { URLForAdminConsentConfig, URLForAuthenticationConfig, CodeExchangeRequest, PKCEAuthURL, TokenExchangeRequest, CodeExchangeResponse, ProviderDetectParams, ProviderDetectResponse, TokenInfoResponse } from '../models/auth.js';
 import { Overrides } from '../config.js';
 import { NylasResponse } from '../models/response.js';
 import { CreateGrantRequest, Grant } from '../models/grants.js';
@@ -64,7 +64,20 @@ export declare class Auth extends Resource {
      * @return The detected provider, if found
      */
     detectProvider(params: ProviderDetectParams): Promise<NylasResponse<ProviderDetectResponse>>;
+    /**
+     * Get info about an ID token
+     * @param idToken The ID token to query.
+     * @return The token information
+     */
+    idTokenInfo(idToken: string): Promise<NylasResponse<TokenInfoResponse>>;
+    /**
+     * Get info about an access token
+     * @param accessToken The access token to query.
+     * @return The token information
+     */
+    accessTokenInfo(accessToken: string): Promise<NylasResponse<TokenInfoResponse>>;
     private urlAuthBuilder;
     private hashPKCESecret;
+    private getTokenInfo;
 }
 export {};

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';
@@ -94,7 +94,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 +125,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.0.0";
+export declare const SDK_VERSION = "7.2.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nylas",
-  "version": "7.0.0",
+  "version": "7.2.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",
@@ -21,7 +21,8 @@
     "lint:prettier:check": "prettier --check '**/*.{ts,js}'",
     "export-version": "node scripts/exportVersion.js",
     "generate-lib-package-json": "node scripts/generateLibPackageJson.js",
-    "prebuild": "npm run export-version",
+    "generate-model-index": "node scripts/generateModelIndex.js",
+    "prebuild": "npm run export-version && npm run generate-model-index",
     "build": "rm -rf lib && npm run build-esm && npm run build-cjs && npm run generate-lib-package-json",
     "build-esm": "tsc -p tsconfig.esm.json",
     "build-cjs": "tsc -p tsconfig.cjs.json",