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

package/lib/esm/version.js

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

package/lib/types/apiClient.d.ts

@@ -1,5 +1,6 @@
 import { Request, Response } from 'node-fetch';
 import { NylasConfig, OverridableNylasConfig } from './config.js';
+import * as FormData from 'form-data';
 /**
  * Options for a request to the Nylas API
  * @property path The path to the API endpoint
@@ -16,6 +17,7 @@ export interface RequestOptionsParams {
     headers?: Record<string, string>;
     queryParams?: Record<string, any>;
     body?: any;
+    form?: FormData;
     overrides?: OverridableNylasConfig;
 }
 /**
@@ -33,7 +35,7 @@ interface RequestOptions {
     method: string;
     headers: Record<string, string>;
     url: URL;
-    body?: string;
+    body?: any;
     overrides?: Partial<NylasConfig>;
 }
 /**

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';
+export type Provider = 'google' | 'imap' | 'microsoft' | 'virtual-calendar';
 /**
  * Configuration for generating a URL for OAuth 2.0 authentication.
  */

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

@@ -47,7 +47,7 @@ export interface CreateCalenderRequest {
 /**
  * Interface of a Nylas update calendar request
  */
-export interface UpdateCalenderRequest extends CreateCalenderRequest {
+export interface UpdateCalenderRequest extends Partial<CreateCalenderRequest> {
     /**
      * The background color of the calendar in the hexadecimal format (e.g. #0099EE).
      * Empty indicates default color.

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

@@ -0,0 +1,127 @@
+import { Provider } from './auth.js';
+import { ListQueryParams } from './listQueryParams.js';
+/**
+ * Interface representing the Nylas connector response.
+ */
+export interface Connector {
+    /**
+     * Custom name of the connector
+     */
+    name: string;
+    /**
+     * The provider type
+     */
+    provider: Provider;
+    /**
+     * Optional settings from provider
+     */
+    settings?: Record<string, unknown>;
+    /**
+     * Default scopes for the connector
+     */
+    scope?: string[];
+}
+/**
+ * Interface representing a Google connector creation request.
+ */
+export interface GoogleCreateConnectorSettings {
+    /**
+     * The Google Client ID
+     */
+    clientId: string;
+    /**
+     * The Google Client Secret
+     */
+    clientSecret: string;
+    /**
+     * The Google Pub/Sub topic name
+     */
+    topicName?: string;
+}
+/**
+ * Interface representing a Microsoft connector creation request.
+ */
+export interface MicrosoftCreateConnectorSettings {
+    /**
+     * The Microsoft Client ID
+     */
+    clientId: string;
+    /**
+     * The Microsoft Client Secret
+     */
+    clientSecret: string;
+    /**
+     * The Microsoft tenant ID
+     */
+    tenant?: string;
+}
+/**
+ * Interface representing the base Nylas connector creation request.
+ */
+interface BaseCreateConnectionRequest {
+    /**
+     * Custom name of the connector
+     */
+    name: string;
+    /**
+     * The provider type
+     */
+    provider: Provider;
+}
+/**
+ * Interface representing the base Nylas connector creation request.
+ */
+export interface GoogleCreateConnectorRequest extends BaseCreateConnectionRequest {
+    /**
+     * The Google OAuth provider credentials and settings
+     */
+    settings: GoogleCreateConnectorSettings;
+    /**
+     * The Google OAuth scopes
+     */
+    scope?: string[];
+}
+export interface MicrosoftCreateConnectorRequest extends BaseCreateConnectionRequest {
+    /**
+     * The Microsoft OAuth provider credentials and settings
+     */
+    settings: MicrosoftCreateConnectorSettings;
+    /**
+     * The Microsoft OAuth scopes
+     */
+    scope?: string[];
+}
+/**
+ * Interface representing the base Nylas connector creation request.
+ */
+export type ImapCreateConnectorRequest = BaseCreateConnectionRequest;
+/**
+ * Interface representing the base Nylas connector creation request.
+ */
+export type VirtualCalendarsCreateConnectorRequest = BaseCreateConnectionRequest;
+/**
+ * The type of the Nylas connector creation request.
+ */
+export type CreateConnectorRequest = GoogleCreateConnectorRequest | MicrosoftCreateConnectorRequest | ImapCreateConnectorRequest | VirtualCalendarsCreateConnectorRequest;
+/**
+ * Interface representing the base Nylas connector creation request.
+ */
+export interface UpdateConnectorRequest {
+    /**
+     * Custom name of the connector
+     */
+    name?: string;
+    /**
+     * The OAuth provider credentials and settings
+     */
+    settings?: Record<string, unknown>;
+    /**
+     * The OAuth scopes
+     */
+    scope?: string[];
+}
+/**
+ * Interface of the query parameters for listing connectors.
+ */
+export type ListConnectorsQueryParams = ListQueryParams;
+export {};

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

@@ -0,0 +1,151 @@
+/**
+ * Interface representing a Nylas Credential object.
+ */
+export interface Credential {
+    /**
+     * Globally unique object identifier
+     */
+    id: string;
+    /**
+     * Name of the credential
+     */
+    name: string;
+    /**
+     * The type of credential
+     */
+    credentialType?: CredentialType;
+    /**
+     * Hashed value of the credential that you created
+     */
+    hashedData?: string;
+    /**
+     * Timestamp of when the credential was created
+     */
+    createdAt?: number;
+    /**
+     * Timestamp of when the credential was updated
+     */
+    updatedAt?: number;
+}
+/**
+ * Interface representing additional data needed to create a credential for Microsoft Admin Consent
+ */
+export interface MicrosoftAdminConsentSettings {
+    clientId: string;
+    clientSecret: string;
+    [key: string]: string;
+}
+/**
+ * Interface representing additional data needed to create a credential for Google Service Account
+ */
+export interface GoogleServiceAccountCredential {
+    privateKeyId: string;
+    privateKey: string;
+    clientEmail: string;
+    [key: string]: string;
+}
+/**
+ * Interface representing additional data needed to create a credential for a Connector Override
+ */
+export type ConnectorOverrideCredential = Record<string, unknown>;
+/**
+ * Type representing the data needed to create a credential
+ */
+export type CredentialData = MicrosoftAdminConsentSettings | GoogleServiceAccountCredential | ConnectorOverrideCredential;
+/**
+ * Interface representing a request to create a Microsoft Admin Consent credential
+ */
+export interface CreateMicrosoftCredentialRequest {
+    /**
+     * Unique name of this credential
+     */
+    name: string;
+    /**
+     * Type of credential for the admin consent flow
+     */
+    credentialType: CredentialType.ADMINCONSENT;
+    /**
+     * Data that specifies some special data required for this credential
+     */
+    credentialData: MicrosoftAdminConsentSettings;
+}
+/**
+ * Interface representing a request to create a Google Service Account credential
+ */
+export interface CreateGoogleCredentialRequest {
+    /**
+     * Unique name of this credential
+     */
+    name: string;
+    /**
+     * Type of credential for the app permission flow
+     */
+    credentialType: CredentialType.SERVICEACCOUNT;
+    /**
+     * Data that specifies some special data required for this credential
+     */
+    credentialData: GoogleServiceAccountCredential;
+}
+/**
+ * Interface representing a request to create a Connector Override credential
+ */
+export interface CreateOverrideCredentialRequest {
+    /**
+     * Unique name of this credential
+     */
+    name: string;
+    /**
+     * Type of credential to force the override of a connector's client values
+     */
+    credentialType: CredentialType.CONNECTOR;
+    /**
+     * Data that specifies some special data required for this credential
+     */
+    credentialData: ConnectorOverrideCredential;
+}
+/**
+ * Interface representing a request to create a credential
+ */
+export type CreateCredentialRequest = CreateMicrosoftCredentialRequest | CreateGoogleCredentialRequest | CreateOverrideCredentialRequest;
+/**
+ * Interface representing a request to update a credential
+ */
+export interface UpdateCredentialRequest {
+    /**
+     * Unique name of this credential
+     */
+    name?: string;
+    /**
+     * Data that specifies some special data required for this credential
+     */
+    credentialData?: CredentialData;
+}
+/**
+ * Enum representing the type of credential
+ */
+export declare enum CredentialType {
+    ADMINCONSENT = "adminconsent",
+    SERVICEACCOUNT = "serviceaccount",
+    CONNECTOR = "connector"
+}
+/**
+ * Interface representing the query parameters for listing credentials.
+ */
+export interface ListCredentialsQueryParams {
+    /**
+     * Limit the number of results
+     */
+    limit?: number;
+    /**
+     * Offset the results by this number
+     */
+    offset?: number;
+    /**
+     * Sort the results by field name
+     */
+    sortBy?: 'createdAt' | 'updatedAt';
+    /**
+     * Order the results by ascending or descending
+     */
+    orderBy?: 'desc' | 'asc';
+}

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?: string;
+    opens?: string;
+    threadReplies?: string;
+}
+/**
+ * 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/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/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;
+}