nylas 7.0.0-beta.2 → 7.0.0-beta.3

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

@@ -0,0 +1,271 @@
+import { EmailName } from './events.js';
+import { CreateFileRequest, File } from './files.js';
+import { ListQueryParams } from './listQueryParams.js';
+/**
+ * @internal Internal interface for creating a message.
+ */
+export interface BaseCreateMessage {
+    /**
+     * 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?: CreateFileRequest[];
+    /**
+     * A short snippet of the message body.
+     * This is the first 100 characters of the message body, with any HTML tags removed.
+     */
+    snippet?: string;
+    /**
+     * The message subject.
+     */
+    subject?: string;
+    /**
+     * A reference to the parent thread object.
+     * If this is a new draft, the thread will be empty.
+     */
+    threadId?: 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;
+    /**
+     * Whether or not the message has been read by the user.
+     */
+    unread?: 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.
+     */
+    from?: EmailName[];
+    /**
+     * An array of files attached to the message.
+     */
+    attachments?: File[];
+}
+/**
+ * Interface representing a Nylas Message object.
+ */
+export interface Message extends BaseMessage {
+    /**
+     * The type of object.
+     */
+    object: 'message';
+    /**
+     * The message headers.
+     * Only present if the 'fields' query parameter is set to includeHeaders.
+     */
+    headers?: MessageHeaders[];
+    /**
+     * A list of key-value pairs storing additional data.
+     */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Interface representing a request to update a message.
+ */
+export interface UpdateMessageRequest {
+    /**
+     * Sets the message as starred or unstarred.
+     */
+    starred?: boolean;
+    /**
+     * Sets the message as read or unread.
+     */
+    unread?: boolean;
+    /**
+     * The IDs of the folders the message should appear in.
+     */
+    folders?: string[];
+    /**
+     * A list of key-value pairs storing additional data.
+     */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Interface representing a message header.
+ */
+export interface MessageHeaders {
+    /**
+     * The header name.
+     */
+    name: string;
+    /**
+     * The header value.
+     */
+    value: string;
+}
+/**
+ * Enum representing the message fields that can be included in a response.
+ */
+export declare enum MessageFields {
+    STANDARD = "standard",
+    INCLUDE_HEADERS = "include_headers"
+}
+/**
+ * Interface representing information about a scheduled message.
+ */
+export interface ScheduledMessage {
+    /**
+     * The unique identifier for the scheduled message.
+     */
+    scheduleId: number;
+    /**
+     * The status of the scheduled message.
+     */
+    status: ScheduledMessageStatus;
+    /**
+     * The time the message was sent or failed to send, in epoch time.
+     */
+    closeTime?: number;
+}
+/**
+ * Interface representing a list of scheduled messages.
+ */
+export interface ScheduledMessagesList {
+    /**
+     * The list of scheduled messages.
+     */
+    schedules: ScheduledMessage[];
+}
+/**
+ * Interface representing a scheduled message status.
+ */
+export interface ScheduledMessageStatus {
+    /**
+     * The status code the describes the state of the scheduled message
+     */
+    code: string;
+    /**
+     * A description of the status of the scheduled message
+     */
+    description: string;
+}
+/**
+ * Interface representing a response after stopping a scheduled message.
+ */
+export interface StopScheduledMessageResponse {
+    /**
+     * A message describing the result of the request.
+     */
+    message: string;
+}
+/**
+ * Interface representing the query parameters for listing messages.
+ */
+export interface ListMessagesQueryParams extends ListQueryParams {
+    /**
+     * Return items with a matching literal subject.
+     */
+    subject?: string;
+    /**
+     * Return emails that have been sent or received from this list of email addresses.
+     */
+    anyEmail?: string[];
+    /**
+     * Return items containing messages sent to these email address.
+     */
+    to?: string[];
+    /**
+     * Return items containing messages sent from these email address.
+     */
+    from?: string[];
+    /**
+     * Return items containing messages cc'd on these email address.
+     */
+    cc?: string[];
+    /**
+     * Return items containing messages bcc'd on these email address.
+     */
+    bcc?: string[];
+    /**
+     * Return emails that are in these folder IDs.
+     */
+    in?: string[];
+    /**
+     * Return emails that are unread.
+     */
+    unread?: boolean;
+    /**
+     * Return emails that are starred.
+     */
+    starred?: boolean;
+    /**
+     * Return emails that belong to this thread.
+     */
+    threadId?: string;
+    /**
+     * Return emails that have been received before this timestamp.
+     */
+    receivedBefore?: number;
+    /**
+     * Return emails that have been received after this timestamp.
+     */
+    receivedAfter?: number;
+    /**
+     * Return emails that contain attachments.
+     */
+    hasAttachment?: boolean;
+    /**
+     * Allows you to specify to return messages with headers included.
+     */
+    fields?: MessageFields;
+    /**
+     * The provider-specific query string used to search messages.
+     * Available for Google and Microsoft Graph only.
+     */
+    searchQueryNative?: string;
+}
+/**
+ * Interface representing the query parameters for finding a message.
+ */
+export interface FindMessageQueryParams {
+    /**
+     * Allows you to specify to the message with headers included.
+     */
+    fields?: MessageFields;
+}

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

@@ -0,0 +1,18 @@
+/**
+ * Interface representing a request to compose a message.
+ */
+export interface ComposeMessageRequest {
+    /**
+     * The prompt that smart compose will use to generate a message suggestion.
+     */
+    prompt: string;
+}
+/**
+ * Interface representing a response to a message composition request.
+ */
+export interface ComposeMessageResponse {
+    /**
+     * The message suggestion generated by smart compose.
+     */
+    suggestion: string;
+}

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

@@ -0,0 +1,153 @@
+import { Message } from './messages.js';
+import { Draft } from './drafts.js';
+import { EmailName } from './events.js';
+import { ListQueryParams } from './listQueryParams.js';
+/**
+ * Interface representing a Nylas thread object.
+ */
+export interface Thread {
+    /**
+     * The unique identifier for the thread.
+     */
+    id: string;
+    /**
+     * Grant ID of the Nylas account.
+     */
+    grantId: string;
+    /**
+     * The latest message or draft in the thread.
+     */
+    latestDraftOrMessage: Message | Draft;
+    /**
+     * Whether or not a message in a thread has attachments.
+     */
+    hasAttachments: boolean;
+    /**
+     * Whether or not a message in a thread has drafts.
+     */
+    hasDrafts: boolean;
+    /**
+     * A boolean indicating whether the thread is starred or not.
+     */
+    starred: boolean;
+    /**
+     * A boolean indicating if all messages within the thread are read or not.
+     */
+    unread: boolean;
+    /**
+     * Unix timestamp of the earliest or first message in the thread.
+     */
+    earliestMessageDate: number;
+    /**
+     * Unix timestamp of the most recent message received in the thread.
+     */
+    latestMessageReceivedDate: number;
+    /**
+     * Unix timestamp of the most recent message sent in the thread.
+     */
+    latestMessageSentDate: number;
+    /**
+     * An array of participants in the thread.
+     */
+    participants: EmailName[];
+    /**
+     * An array of message IDs in the thread.
+     */
+    messageIds: string[];
+    /**
+     * An array of draft IDs in the thread.
+     */
+    draftIds: string[];
+    /**
+     * An array of folder IDs the thread appears in.
+     */
+    folders: string[];
+    /**
+     * The type of object.
+     */
+    object: 'thread';
+    /**
+     * A short snippet of the last received message/draft body.
+     * This is the first 100 characters of the message body, with any HTML tags removed.
+     */
+    snippet?: string;
+    /**
+     * The subject line of the thread.
+     */
+    subject?: string;
+}
+/**
+ * Interface representing a request to update a thread.
+ */
+export interface UpdateThreadRequest {
+    /**
+     * Sets all messages in the thread as starred or unstarred.
+     */
+    starred?: boolean;
+    /**
+     * Sets all messages in the thread as read or unread.
+     */
+    unread?: boolean;
+    /**
+     * The IDs of the folders to apply, overwriting all previous folders for all messages in the thread.
+     */
+    folders?: string[];
+}
+/**
+ * Interface representing the query parameters for listing drafts.
+ */
+export interface ListThreadsQueryParams extends ListQueryParams {
+    /**
+     * Return items with a matching literal subject.
+     */
+    subject?: string;
+    /**
+     * Return threads that contain messages that have been sent or received from this list of email addresses.
+     */
+    anyEmail?: string[];
+    /**
+     * Return threads containing messages sent to these email address.
+     */
+    to?: string[];
+    /**
+     * Return threads containing messages sent from these email address.
+     */
+    from?: string[];
+    /**
+     * Return threads containing messages cc'd on these email address.
+     */
+    cc?: string[];
+    /**
+     * Return threads containing messages bcc'd on these email address.
+     */
+    bcc?: string[];
+    /**
+     * Return threads with messages that belong to these specified folder IDs.
+     */
+    in?: string[];
+    /**
+     * Return threads with unread messages.
+     */
+    unread?: boolean;
+    /**
+     * Return threads with starred messages.
+     */
+    starred?: boolean;
+    /**
+     * Return threads whose most recent message was received before this Unix timestamp.
+     */
+    latestMessageBefore?: number;
+    /**
+     * Return threads whose most recent message was received after this Unix timestamp.
+     */
+    latestMessageAfter?: number;
+    /**
+     * Return threads with messages that contain attachments.
+     */
+    hasAttachment?: boolean;
+    /**
+     * The provider-specific query string used to search threads.
+     * Available for Google only.
+     */
+    searchQueryNative?: string;
+}

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

@@ -1,34 +1,112 @@
+/**
+ * Interface representing a Nylas Webhook object.
+ */
 export interface Webhook {
+    /**
+     * Globally unique object identifier.
+     */
     id: string;
-    description?: string;
+    /**
+     * List of events that triggers the webhook.
+     */
     triggerTypes: WebhookTriggers[];
+    /**
+     * The url to send webhooks to.
+     */
     callbackUrl: string;
+    /**
+     * The status of the new destination.
+     */
     status: 'active' | 'failing' | 'failed' | 'pause';
-    notificationEmailAddress?: string;
+    /**
+     * The time the status field was last updated, represented as a Unix timestamp in seconds.
+     */
     statusUpdatedAt: number;
+    /**
+     * The time the status field was created, represented as a Unix timestamp in seconds
+     */
     createdAt: number;
+    /**
+     * The time the status field was last updated, represented as a Unix timestamp in seconds.
+     */
     updatedAt: number;
+    /**
+     * A human-readable description of the webhook destination.
+     */
+    description?: string;
+    /**
+     * The email addresses that Nylas notifies when a webhook is down for a while.
+     */
+    notificationEmailAddress?: string;
 }
+/**
+ * Class representing a Nylas webhook with secret.
+ */
 export interface WebhookWithSecret extends Webhook {
+    /**
+     * A secret value used to encode the X-Nylas-Signature header on webhook requests.
+     */
     webhookSecret: string;
 }
+/**
+ * Class representing a Nylas webhook delete response.
+ */
 export interface WebhookDeleteResponse {
+    /**
+     * ID of the request.
+     */
     requestId: string;
+    /**
+     * Object containing the webhook deletion status.
+     */
     data?: {
+        /**
+         * The status of the webhook deletion.
+         */
         status: 'success';
     };
 }
+/**
+ * Class representing the response for getting a list of webhook ip addresses.
+ */
 export interface WebhookIpAddressesResponse {
+    /**
+     * The IP addresses that Nylas send you webhook from.
+     */
     ipAddresses: string[];
+    /**
+     * UNIX timestamp when Nylas updated the list of IP addresses.
+     */
     updatedAt: number;
 }
+/**
+ * Class representation of a Nylas create webhook request.
+ */
 export interface CreateWebhookRequest {
+    /**
+     * List of events that triggers the webhook.
+     */
     triggerTypes: WebhookTriggers[];
+    /**
+     * The url to send webhooks to.
+     */
     callbackUrl: string;
+    /**
+     * A human-readable description of the webhook destination.
+     */
     description?: string;
+    /**
+     * The email addresses that Nylas notifies when a webhook is down for a while.
+     */
     notificationEmailAddress?: string;
 }
+/**
+ * Class representation of a Nylas update webhook request.
+ */
 export type UpdateWebhookRequest = Partial<CreateWebhookRequest>;
+/**
+ * Enum representing the available webhook triggers.
+ */
 export declare enum WebhookTriggers {
     CalendarCreated = "calendar.created",
     CalendarUpdated = "calendar.updated",

package/lib/types/nylas.d.ts

@@ -5,6 +5,10 @@ import { Events } from './resources/events.js';
 import { Auth } from './resources/auth.js';
 import { Webhooks } from './resources/webhooks.js';
 import { Applications } from './resources/applications.js';
+import { Messages } from './resources/messages.js';
+import { Drafts } from './resources/drafts.js';
+import { Threads } from './resources/threads.js';
+import { Connectors } from './resources/connectors.js';
 /**
  * The entry point to the Node SDK
  *
@@ -24,10 +28,26 @@ export default class Nylas {
      * Access the Calendars API
      */
     calendars: Calendars;
+    /**
+     * Access the Connectors API
+     */
+    connectors: Connectors;
+    /**
+     * Access the Drafts API
+     */
+    drafts: Drafts;
     /**
      * Access the Events API
      */
     events: Events;
+    /**
+     * Access the Messages API
+     */
+    messages: Messages;
+    /**
+     * Access the Threads API
+     */
+    threads: Threads;
     /**
      * Access the Webhooks API
      */

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

@@ -3,6 +3,7 @@ import { Calendar, CreateCalenderRequest, ListCalendersQueryParams, UpdateCalend
 import { NylasDeleteResponse, NylasResponse, NylasListResponse } from '../models/response.js';
 import { Resource, AsyncListResponse } from './resource.js';
 import { GetAvailabilityRequest, GetAvailabilityResponse } from '../models/availability.js';
+import { GetFreeBusyRequest, GetFreeBusyResponse } from '../models/freeBusy.js';
 /**
  * The parameters for the {@link Calendars.find} method
  * @property calendarId The id of the Calendar to retrieve. Use "primary" to refer to the primary calendar associated with grant.
@@ -56,6 +57,15 @@ interface DestroyCalendarParams {
 interface GetAvailabilityParams {
     requestBody: GetAvailabilityRequest;
 }
+/**
+ * The parameters for the {@link Calendars.getFreeBusy} method
+ * @property identifier The identifier of the grant to act upon
+ * @property requestBody The free busy request
+ */
+interface GetFreeBusyParams {
+    identifier: string;
+    requestBody: GetFreeBusyRequest;
+}
 /**
  * Nylas Calendar API
  *
@@ -92,6 +102,11 @@ export declare class Calendars extends Resource {
      * Get Availability for a given account / accounts
      * @return The availability response
      */
-    getAvailability({ requestBody, overrides, }: GetAvailabilityParams & Overrides): Promise<GetAvailabilityResponse>;
+    getAvailability({ requestBody, overrides, }: GetAvailabilityParams & Overrides): Promise<NylasResponse<GetAvailabilityResponse>>;
+    /**
+     * Get the free/busy schedule for a list of email addresses
+     * @return The free/busy response
+     */
+    getFreeBusy({ identifier, requestBody, overrides, }: GetFreeBusyParams & Overrides): Promise<NylasResponse<GetFreeBusyResponse[]>>;
 }
 export {};

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

@@ -0,0 +1,80 @@
+import { AsyncListResponse, Resource } from './resource.js';
+import { Connector, CreateConnectorRequest, ListConnectorsQueryParams, UpdateConnectorRequest } from '../models/connectors.js';
+import { Overrides } from '../config.js';
+import { NylasDeleteResponse, NylasListResponse, NylasResponse } from '../models/response.js';
+import { Provider } from '../models/auth.js';
+import { Credentials } from './credentials.js';
+import APIClient from '../apiClient.js';
+/**
+ * The parameters for the {@link Connectors.find} method
+ * @property provider The provider associated to the connector to retrieve.
+ */
+interface FindConnectorParams {
+    provider: Provider;
+}
+/**
+ * The parameters for the {@link Connectors.list} method
+ * @property queryParams The query parameters to include in the request
+ */
+interface ListConnectorsParams {
+    queryParams?: ListConnectorsQueryParams;
+}
+/**
+ * The parameters for the {@link Connectors.create} method
+ * @property requestBody The request body to create a connector
+ */
+interface CreateConnectorParams {
+    requestBody: CreateConnectorRequest;
+}
+/**
+ * The parameters for the {@link Connectors.update} method
+ * @property provider The provider associated to the connector to update.
+ * @property requestBody The request body to create a connector
+ */
+interface UpdateConnectorParams {
+    provider: Provider;
+    requestBody: UpdateConnectorRequest;
+}
+/**
+ * The parameters for the {@link Connectors.destroy} method
+ * @property provider The provider associated to the connector to update.
+ */
+interface DestroyConnectorParams {
+    provider: string;
+}
+export declare class Connectors extends Resource {
+    /**
+     * Access the Credentials API
+     */
+    credentials: Credentials;
+    /**
+     * @param apiClient client The configured Nylas API client
+     */
+    constructor(apiClient: APIClient);
+    /**
+     * Return all connectors
+     * @return A list of connectors
+     */
+    list({ queryParams, overrides, }: ListConnectorsParams & ListConnectorsQueryParams & Overrides): AsyncListResponse<NylasListResponse<Connector>>;
+    /**
+     * Return a connector
+     * @return The connector
+     */
+    find({ provider, overrides, }: FindConnectorParams & Overrides): Promise<NylasResponse<Connector>>;
+    /**
+     * Create a connector
+     * @return The created connector
+     */
+    create({ requestBody, overrides, }: CreateConnectorParams & Overrides): Promise<NylasResponse<Connector>>;
+    /**
+     * Update a connector
+     * @return The updated connector
+     */
+    update({ provider, requestBody, overrides, }: UpdateConnectorParams & Overrides): Promise<NylasResponse<Connector>>;
+    /**
+     * Delete a connector
+     * @return The deleted connector
+     */
+    destroy({ provider, overrides, }: DestroyConnectorParams & Overrides): Promise<NylasDeleteResponse>;
+}
+export {};