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

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,14 @@ 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';
+import { Folders } from './resources/folders.js';
+import { Grants } from './resources/grants.js';
+import { Contacts } from './resources/contacts.js';
+import { Attachments } from './resources/attachments.js';
 /**
  * The entry point to the Node SDK
  *
@@ -16,6 +24,10 @@ export default class Nylas {
      * Access the Applications API
      */
     applications: Applications;
+    /**
+     * Access the Attachments API
+     */
+    attachments: Attachments;
     /**
      * Access the Auth API
      */
@@ -24,14 +36,42 @@ export default class Nylas {
      * Access the Calendars API
      */
     calendars: Calendars;
+    /**
+     * Access the Connectors API
+     */
+    connectors: Connectors;
+    /**
+     * Access the Contacts API
+     */
+    contacts: Contacts;
+    /**
+     * Access the Drafts API
+     */
+    drafts: Drafts;
     /**
      * Access the Events API
      */
     events: Events;
+    /**
+     * Access the Grants API
+     */
+    grants: Grants;
+    /**
+     * Access the Messages API
+     */
+    messages: Messages;
+    /**
+     * Access the Threads API
+     */
+    threads: Threads;
     /**
      * Access the Webhooks API
      */
     webhooks: Webhooks;
+    /**
+     * Access the Folders API
+     */
+    folders: Folders;
     /**
      * The configured API client
      * @ignore Not for public use

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

@@ -0,0 +1,61 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { Overrides } from '../config.js';
+import { Attachment, FindAttachmentQueryParams, DownloadAttachmentQueryParams } from '../models/attachments.js';
+import { NylasResponse } from '../models/response.js';
+import { Resource } from './resource.js';
+/**
+ * @property identifier The ID of the grant to act upon. Use "me" to refer to the grant associated with an access token.
+ * @property attachmentId The ID of the attachment to act upon.
+ * @property queryParams The query parameters to include in the request
+ */
+interface FindAttachmentParams {
+    identifier: string;
+    attachmentId: string;
+    queryParams: FindAttachmentQueryParams;
+}
+/**
+ * @property identifier The ID of the grant to act upon. Use "me" to refer to the grant associated with an access token.
+ * @property attachmentId The ID of the attachment to act upon.
+ * @property queryParams The query parameters to include in the request
+ */
+interface DownloadAttachmentParams {
+    identifier: string;
+    attachmentId: string;
+    queryParams: DownloadAttachmentQueryParams;
+}
+/**
+ * Nylas Attachments API
+ *
+ * The Nylas Attachments API allows you to retrieve metadata and download attachments.
+ */
+export declare class Attachments extends Resource {
+    /**
+     * Returns an attachment by ID.
+     * @return The Attachment metadata
+     */
+    find({ identifier, attachmentId, queryParams, overrides, }: FindAttachmentParams & Overrides): Promise<NylasResponse<Attachment>>;
+    /**
+     * Download the attachment data
+     *
+     * This method returns a NodeJS.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.
+     *
+     * @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.
+     */
+    download({ 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
+     * @param attachmentId The id of the attachment to download.
+     * @param queryParams The query parameters to include in the request
+     * @return The raw file data
+     */
+    downloadBytes({ identifier, attachmentId, queryParams, overrides, }: DownloadAttachmentParams & Overrides): Promise<Buffer>;
+}
+export {};

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

@@ -1,7 +1,14 @@
-import APIClient from '../apiClient.js';
 import { Resource } from './resource.js';
-import { Grants } from './grants.js';
 import { URLForAdminConsentConfig, URLForAuthenticationConfig, CodeExchangeRequest, PKCEAuthURL, TokenExchangeRequest, CodeExchangeResponse, ProviderDetectParams, ProviderDetectResponse } from '../models/auth.js';
+import { Overrides } from '../config.js';
+import { NylasResponse } from '../models/response.js';
+import { CreateGrantRequest, Grant } from '../models/grants.js';
+/**
+ * @property requestBody The values to create the Grant with.
+ */
+interface CreateGrantParams {
+    requestBody: CreateGrantRequest;
+}
 /**
  * A collection of authentication related API endpoints
  *
@@ -9,15 +16,6 @@ import { URLForAdminConsentConfig, URLForAuthenticationConfig, CodeExchangeReque
  * Also contains the Grants API and collection of provider API endpoints.
  */
 export declare class Auth extends Resource {
-    /**
-     * Access the Grants API
-     */
-    grants: Grants;
-    apiClient: APIClient;
-    /**
-     * @param apiClient The configured Nylas API client
-     */
-    constructor(apiClient: APIClient);
     /**
      * Build the URL for authenticating users to your application with OAuth 2.0
      * @param config The configuration for building the URL
@@ -49,6 +47,11 @@ export declare class Auth extends Resource {
      * @return The URL for admin consent authentication
      */
     urlForAdminConsent(config: URLForAdminConsentConfig): string;
+    /**
+     * Create a grant via Custom Authentication
+     * @return The created grant
+     */
+    customAuthentication({ requestBody, overrides, }: CreateGrantParams & Overrides): Promise<NylasResponse<Grant>>;
     /**
      * Revoke a token (and the grant attached to the token)
      * @param token The token to revoke
@@ -64,3 +67,4 @@ export declare class Auth extends Resource {
     private urlAuthBuilder;
     private hashPKCESecret;
 }
+export {};

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

@@ -1,8 +1,9 @@
 import { Overrides } from '../config.js';
 import { Calendar, CreateCalenderRequest, ListCalendersQueryParams, UpdateCalenderRequest } from '../models/calendars.js';
-import { NylasDeleteResponse, NylasResponse, NylasListResponse } from '../models/response.js';
+import { NylasBaseResponse, 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
  *
@@ -87,11 +97,16 @@ export declare class Calendars extends Resource {
      * Delete a Calendar
      * @return The deleted Calendar
      */
-    destroy({ identifier, calendarId, overrides, }: DestroyCalendarParams & Overrides): Promise<NylasDeleteResponse>;
+    destroy({ identifier, calendarId, overrides, }: DestroyCalendarParams & Overrides): Promise<NylasBaseResponse>;
     /**
      * 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 { NylasBaseResponse, 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<NylasBaseResponse>;
+}
+export {};

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

@@ -0,0 +1,92 @@
+import { Overrides } from '../config.js';
+import { CreateContactRequest, Contact, ListContactQueryParams, FindContactQueryParams, UpdateContactRequest, ContactGroup } from '../models/contacts.js';
+import { NylasResponse, NylasListResponse, NylasBaseResponse } from '../models/response.js';
+import { AsyncListResponse, Resource } from './resource.js';
+/**
+ * @property contactId The id of the Contact to retrieve.
+ * @property identifier The identifier of the grant to act upon
+ * @property queryParams The query parameters to include in the request
+ */
+interface FindContactParams {
+    identifier: string;
+    contactId: string;
+    queryParams: FindContactQueryParams;
+}
+/**
+ * @property identifier The identifier of the grant to act upon
+ * @property queryParams The query parameters to include in the request
+ */
+interface ListContactParams {
+    identifier: string;
+    queryParams: ListContactQueryParams;
+}
+/**
+ * @property identifier The identifier of the grant to act upon
+ * @property requestBody The values to create the Contact with
+ */
+interface CreateContactParams {
+    identifier: string;
+    requestBody: CreateContactRequest;
+}
+/**
+ * @property identifier The identifier of the grant to act upon
+ * @property contactId The id of the Contact to retrieve.
+ * @property requestBody The values to update the Contact with
+ */
+interface UpdateContactParams {
+    identifier: string;
+    contactId: string;
+    requestBody: UpdateContactRequest;
+}
+/**
+ * @property identifier The identifier of the grant to act upon
+ * @property contactId The id of the Contact to retrieve.
+ */
+interface DestroyContactParams {
+    identifier: string;
+    contactId: string;
+}
+/**
+ * @property identifier The identifier of the grant to act upon
+ */
+interface ListContactGroupParams {
+    identifier: string;
+}
+/**
+ * Nylas Contacts API
+ *
+ * The Nylas Contacts API allows you to create, update, and delete contacts.
+ */
+export declare class Contacts extends Resource {
+    /**
+     * Return all Contacts
+     * @return The list of Contacts
+     */
+    list({ identifier, queryParams, overrides, }: ListContactParams & Overrides): AsyncListResponse<NylasListResponse<Contact>>;
+    /**
+     * Return a Contact
+     * @return The Contact
+     */
+    find({ identifier, contactId, queryParams, overrides, }: FindContactParams & Overrides): Promise<NylasResponse<Contact>>;
+    /**
+     * Create a Contact
+     * @return The created Contact
+     */
+    create({ identifier, requestBody, overrides, }: CreateContactParams & Overrides): Promise<NylasResponse<Contact>>;
+    /**
+     * Update a Contact
+     * @return The updated Contact
+     */
+    update({ identifier, contactId, requestBody, overrides, }: UpdateContactParams & Overrides): Promise<NylasResponse<Contact>>;
+    /**
+     * Delete a Contact
+     * @return The deletion response
+     */
+    destroy({ identifier, contactId, overrides, }: DestroyContactParams & Overrides): Promise<NylasBaseResponse>;
+    /**
+     * Return a Contact Group
+     * @return The list of Contact Groups
+     */
+    groups({ identifier, overrides, }: ListContactGroupParams & Overrides): Promise<NylasListResponse<ContactGroup>>;
+}
+export {};