nylas 7.0.0-beta.2 → 7.0.0-beta.4

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

@@ -0,0 +1,92 @@
+import { BaseMessage, BaseCreateMessage } from './messages.js';
+import { ListQueryParams } from './listQueryParams.js';
+/**
+ * Interface representing a request to create a draft.
+ */
+export interface CreateDraftRequest extends BaseCreateMessage {
+    /**
+     * Unix timestamp to send the message at.
+     */
+    sendAt?: number;
+    /**
+     * The ID of the message that you are replying to.
+     */
+    replyToMessageId?: string;
+    /**
+     * Options for tracking opens, links, and thread replies.
+     */
+    trackingOptions?: TrackingOptions;
+}
+/**
+ * Interface representing a request to send a message.
+ */
+export interface SendMessageRequest extends CreateDraftRequest {
+    /**
+     * Whether or not to use draft support.
+     * This is primarily used when dealing with large attachments.
+     */
+    useDraft?: boolean;
+}
+/**
+ * Interface representing a Nylas Draft object.
+ */
+export interface Draft extends BaseMessage, Omit<CreateDraftRequest, 'attachments'> {
+    /**
+     * The type of object.
+     */
+    object: 'draft';
+}
+/**
+ * Interface representing a request to update a draft.
+ */
+export type UpdateDraftRequest = Partial<CreateDraftRequest>;
+/**
+ * Interface representing the different tracking options for when a message is sent.
+ */
+export interface TrackingOptions {
+    label?: string;
+    links?: boolean;
+    opens?: boolean;
+    threadReplies?: boolean;
+}
+/**
+ * Interface representing the query parameters for listing drafts.
+ */
+export interface ListDraftsQueryParams 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 drafts to be sent these email address.
+     */
+    to?: string[];
+    /**
+     * Return items containing drafts cc'ing these email address.
+     */
+    cc?: string[];
+    /**
+     * Return items containing drafts bcc'ing these email address.
+     */
+    bcc?: string[];
+    /**
+     * Return drafts that are unread.
+     */
+    unread?: boolean;
+    /**
+     * Return drafts that are starred.
+     */
+    starred?: boolean;
+    /**
+     * Return drafts that belong to this thread.
+     */
+    threadId?: string;
+    /**
+     * Return drafts that contain attachments.
+     */
+    hasAttachment?: boolean;
+}

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

@@ -191,6 +191,12 @@ export interface CreateEventRequest {
  * Interface representing a request to update an event.
  */
 export type UpdateEventRequest = Subset<CreateEventRequest>;
+/**
+ * Interface representing a request to send RSVP to an event.
+ */
+export type SendRsvpRequest = {
+    status: RsvpStatus;
+};
 /**
  * Interface representing the query parameters for listing events.
  */
@@ -290,10 +296,18 @@ export type UpdateEventQueryParams = CreateEventQueryParams;
  * Interface representing of the query parameters for destroying events.
  */
 export type DestroyEventQueryParams = CreateEventQueryParams;
+/**
+ * Interface representing of the query parameters for sending RSVP to an event.
+ */
+export type SendRsvpQueryParams = FindEventQueryParams;
 /**
  * Enum representing the status of an event.
  */
 type Status = 'confirmed' | 'tentative' | 'cancelled';
+/**
+ * Enum representing the status of an RSVP response.
+ */
+type RsvpStatus = 'yes' | 'no' | 'maybe';
 /**
  * Enum representing the visibility of an event.
  */

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

@@ -0,0 +1,17 @@
+/// <reference types="node" />
+interface BaseFile {
+    filename: string;
+    contentType: string;
+    size?: number;
+    isInline?: boolean;
+    contentId?: string;
+    contentDisposition?: string;
+}
+export interface CreateFileRequest extends BaseFile {
+    content: NodeJS.ReadableStream;
+}
+export interface File extends BaseFile {
+    id: string;
+    grantId: string;
+}
+export {};

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

@@ -0,0 +1,71 @@
+/**
+ * Interface of a folder object from Nylas.
+ */
+export interface Folder {
+    /**
+     * A globally unique object identifier.
+     */
+    id: string;
+    /**
+     * Folder name.
+     */
+    name: string;
+    /**
+     * The type of object.
+     */
+    object: string;
+    /**
+     * Grant ID of the Nylas account
+     */
+    grantId: string;
+    /**
+     * (Google only) Folder background color.
+     */
+    backgroundColor?: string;
+    /**
+     * (Google only) Indicates if the folder is user created or system created.
+     */
+    systemFolder?: boolean;
+    /**
+     * (Google only) Folder text color.
+     */
+    textColor?: string;
+    /**
+     * (Microsoft only) The number of immediate child folders in the current folder.
+     */
+    childCount?: number;
+    /**
+     * (Microsoft only) ID of the parent folder.
+     */
+    parentId?: string;
+    /**
+     * The number of items inside of a folder.
+     */
+    totalCount?: number;
+    /**
+     * The number of unread items inside of a folder.
+     */
+    unreadCount?: number;
+}
+/**
+ * Interface for creating a new folder.
+ */
+export interface CreateFolderRequest {
+    /**
+     * Creates a folder with the specified display name. (Constraints: 1 to 1024 chars)
+     */
+    name: string;
+    /**
+     * (Microsoft only) ID of the parent folder.
+     */
+    parentId?: string;
+    /**
+     * (Google only) The text color of the folder in the hexadecimal format "#0099EE". See Google Defined Values for more information.
+     */
+    textColor?: string;
+    /**
+     * (Google only) The background color of the folder in the hexadecimal format "#0099EE". See Google Defined Values for more information.
+     */
+    backgroundColor?: string;
+}
+export type UpdateFolderRequest = Partial<CreateFolderRequest>;

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

@@ -0,0 +1,79 @@
+/**
+ * Interface representation of a Nylas free-busy time slot object.
+ */
+export interface FreeBusyTimeSlot {
+    /**
+     * Unix timestamp for the start of the slot.
+     */
+    startTime: number;
+    /**
+     * Unix timestamp for the end of the slot.
+     */
+    endTime: number;
+    /**
+     * The status of the time slot.
+     */
+    status: string;
+}
+/**
+ * Class representation of a Nylas get free-busy request
+ */
+export interface GetFreeBusyRequest {
+    /**
+     * Unix timestamp representing the start of the time block for assessing the account's free/busy schedule.
+     */
+    startTime: number;
+    /**
+     * Unix timestamp representing the end of the time block for assessing the account's free/busy schedule.
+     */
+    endTime: number;
+    /**
+     * A list of email addresses to check the free/busy schedules for.
+     */
+    emails: string[];
+}
+/**
+ * Enum representing the type of free/busy information returned for a calendar.
+ */
+export declare enum FreeBusyType {
+    FREE_BUSY = "free_busy",
+    ERROR = "error"
+}
+/**
+ * Union type of the possible Nylas get free busy response.
+ */
+export type GetFreeBusyResponse = FreeBusy | FreeBusyError;
+/**
+ * This interface represents a successful free-busy response.
+ */
+export interface FreeBusy {
+    /**
+     * The participant's email address.
+     */
+    email: string;
+    /**
+     * A list of busy time slots.
+     */
+    timeSlots: FreeBusyTimeSlot[];
+    /**
+     * The type of the response.
+     */
+    object: FreeBusyType.FREE_BUSY;
+}
+/**
+ * This interface represents a failed free-busy response.
+ */
+export interface FreeBusyError {
+    /**
+     * The participant's email address.
+     */
+    email: string;
+    /**
+     * Description of the error fetching data for this participant.
+     */
+    error: string;
+    /**
+     * The type of the response.
+     */
+    object: FreeBusyType.ERROR;
+}

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

@@ -1,3 +1,9 @@
+/**
+ * Interface representing a base response to a request.
+ */
+export interface NylasBaseResponse {
+    requestId: string;
+}
 /**
  * Interface representation of a Nylas response object
  */
@@ -28,12 +34,6 @@ export interface NylasListResponse<T> {
      */
     nextCursor?: string;
 }
-/**
- * Interface representing a response to a delete request.
- */
-export interface NylasDeleteResponse {
-    requestId: string;
-}
 /**
  * Helper type for pagination
  */

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;
+}