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

package/lib/esm/resources/smartCompose.js

@@ -0,0 +1,30 @@
+import { Resource } from './resource.js';
+/**
+ * A collection of Smart Compose related API endpoints.
+ *
+ * These endpoints allow for the generation of message suggestions.
+ */
+export class SmartCompose extends Resource {
+    /**
+     * Compose a message
+     * @return The generated message
+     */
+    composeMessage({ identifier, requestBody, overrides, }) {
+        return super._create({
+            path: `/v3/grants/${identifier}/messages/smart-compose`,
+            requestBody,
+            overrides,
+        });
+    }
+    /**
+     * Compose a message reply
+     * @return The generated message reply
+     */
+    composeMessageReply({ identifier, messageId, requestBody, overrides, }) {
+        return super._create({
+            path: `/v3/grants/${identifier}/messages/${messageId}/smart-compose`,
+            requestBody,
+            overrides,
+        });
+    }
+}

package/lib/esm/resources/threads.js

@@ -0,0 +1,50 @@
+import { Resource } from './resource.js';
+/**
+ * Nylas Threads API
+ *
+ * The Nylas Threads API allows you to list, find, update, and delete threads on user accounts.
+ */
+export class Threads extends Resource {
+    /**
+     * Return all Threads
+     * @return A list of threads
+     */
+    list({ identifier, queryParams, overrides, }) {
+        return super._list({
+            queryParams,
+            overrides,
+            path: `/v3/grants/${identifier}/threads`,
+        });
+    }
+    /**
+     * Return a Thread
+     * @return The thread
+     */
+    find({ identifier, threadId, overrides, }) {
+        return super._find({
+            path: `/v3/grants/${identifier}/threads/${threadId}`,
+            overrides,
+        });
+    }
+    /**
+     * Update a Thread
+     * @return The updated thread
+     */
+    update({ identifier, threadId, requestBody, overrides, }) {
+        return super._update({
+            path: `/v3/grants/${identifier}/threads/${threadId}`,
+            requestBody,
+            overrides,
+        });
+    }
+    /**
+     * Delete a Thread
+     * @return The deleted thread
+     */
+    destroy({ identifier, threadId, overrides, }) {
+        return super._destroy({
+            path: `/v3/grants/${identifier}/threads/${threadId}`,
+            overrides,
+        });
+    }
+}

package/lib/esm/utils.js

@@ -1,4 +1,19 @@
 import { camelCase, snakeCase } from 'change-case';
+import * as fs from 'fs';
+import * as path from 'path';
+import * as mime from 'mime-types';
+export function createFileRequestBuilder(filePath) {
+    const stats = fs.statSync(filePath);
+    const filename = path.basename(filePath);
+    const contentType = mime.lookup(filePath) || 'application/octet-stream';
+    const content = fs.createReadStream(filePath);
+    return {
+        filename,
+        contentType,
+        content,
+        size: stats.size,
+    };
+}
 /**
  * A utility function that recursively converts all keys in an object to a given case.
  * @param obj The object to convert

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.4';

package/lib/types/apiClient.d.ts

@@ -1,5 +1,8 @@
+/// <reference types="node" />
+/// <reference types="node" />
 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 +19,7 @@ export interface RequestOptionsParams {
     headers?: Record<string, string>;
     queryParams?: Record<string, any>;
     body?: any;
+    form?: FormData;
     overrides?: OverridableNylasConfig;
 }
 /**
@@ -33,7 +37,7 @@ interface RequestOptions {
     method: string;
     headers: Record<string, string>;
     url: URL;
-    body?: string;
+    body?: any;
     overrides?: Partial<NylasConfig>;
 }
 /**
@@ -57,9 +61,12 @@ export default class APIClient {
     private setRequestUrl;
     private setQueryStrings;
     private setRequestHeaders;
+    private sendRequest;
     requestOptions(optionParams: RequestOptionsParams): RequestOptions;
     newRequest(options: RequestOptionsParams): Request;
     requestWithResponse<T>(response: Response): Promise<T>;
     request<T>(options: RequestOptionsParams): Promise<T>;
+    requestRaw(options: RequestOptionsParams): Promise<Buffer>;
+    requestStream(options: RequestOptionsParams): Promise<NodeJS.ReadableStream>;
 }
 export {};

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

@@ -0,0 +1,42 @@
+/**
+ * Interface of an attachment object from Nylas.
+ */
+export interface Attachment {
+    /**
+     * A globally unique object identifier.
+     */
+    id: string;
+    /**
+     * Attachment's name.
+     */
+    filename: string;
+    /**
+     * Attachment's content type.
+     */
+    contentType: string;
+    /**
+     * Grant ID of the Nylas account.
+     */
+    grantId: string;
+    /**
+     * If it's an inline attachment.
+     */
+    isInline: boolean;
+    /**
+     * Attachment's size in bytes.
+     */
+    size: number;
+}
+/**
+ * Interface representing of the query parameters for finding an attachment's metadata.
+ */
+export interface FindAttachmentQueryParams {
+    /**
+     * ID of the message the attachment belongs to.
+     */
+    messageId: string;
+}
+/**
+ * Interface representing of the query parameters for downloading an attachment.
+ */
+export type DownloadAttachmentQueryParams = FindAttachmentQueryParams;

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.
  */
@@ -134,6 +134,10 @@ export interface CodeExchangeResponse {
      * Nylas grant ID that is now successfully created.
      */
     grantId: string;
+    /**
+     * Email address of the grant that is created.
+     */
+    email: string;
     /**
      * The remaining lifetime of the access token in seconds.
      */

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,123 @@
+import { Provider } from './auth.js';
+import { ListQueryParams } from './listQueryParams.js';
+/**
+ * Interface representing the Nylas connector response.
+ */
+export interface Connector {
+    /**
+     * 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/contacts.d.ts

@@ -0,0 +1,148 @@
+import { ListQueryParams } from './listQueryParams.js';
+/**
+ * Interface representing a Nylas Contact object.
+ */
+export interface Contact {
+    id: string;
+    grantId: string;
+    object: 'contact';
+    birthday?: string;
+    companyName?: string;
+    displayName: string;
+    emails: Email[];
+    imAddresses: InstantMessagingAddress[];
+    givenName?: string;
+    jobTitle?: string;
+    managerName?: string;
+    middleName?: string;
+    nickname?: string;
+    notes?: string;
+    officeLocation?: string;
+    pictureUrl?: string;
+    picture?: string;
+    suffix?: string;
+    surname?: string;
+    source?: SourceType;
+    phoneNumbers: PhoneNumber[];
+    physicalAddresses: PhysicalAddress[];
+    webPages: WebPage[];
+    groups: ContactGroup[];
+}
+/**
+ * Custom Types.
+ */
+export type ContactType = 'work' | 'home' | 'other';
+export type SourceType = 'address_book' | 'inbox' | 'domain';
+export type GroupType = 'user' | 'system' | 'other';
+/**
+ * Interface for email addresses in a contact.
+ */
+export interface Email {
+    email?: string;
+    type?: ContactType;
+}
+/**
+ * Interface for IM addresses in a contact.
+ */
+export interface InstantMessagingAddress {
+    type?: string;
+    imAddress?: string;
+}
+/**
+ * Interface for phone numbers in a contact.
+ */
+export interface PhoneNumber {
+    number?: string;
+    type?: ContactType;
+}
+/**
+ * Interface for physical addresses in a contact.
+ */
+export interface PhysicalAddress {
+    format?: string;
+    streetAddress?: string;
+    city?: string;
+    postalCode?: string;
+    state?: string;
+    country?: string;
+    type?: ContactType;
+}
+/**
+ * Interface for web pages in a contact.
+ */
+export interface WebPage {
+    url?: string;
+    type?: ContactType;
+}
+/**
+ * Interface representing a contact group.
+ */
+export interface ContactGroup {
+    id: string;
+    object: 'contact_group';
+    grantId?: string;
+    groupType?: GroupType;
+    name?: string;
+    path?: string;
+}
+/**
+ * Interface representing the query parameters for listing contacts.
+ */
+export interface ListContactQueryParams extends ListQueryParams {
+    /**
+     * Returns the contacts matching the exact contact's email.
+     */
+    email?: string;
+    /**
+     * Returns the contacts matching the contact's exact phone number
+     */
+    phoneNumber?: string;
+    /**
+     * Returns the contacts matching from the address book or auto-generated contacts from emails.
+     * For example of contacts only from the address book: /contacts?source=address_bookor for only autogenerated contacts:/contacts?source=inbox`
+     */
+    source?: string;
+    /**
+     * Returns the contacts belonging to the Contact Group matching this ID
+     */
+    group?: string;
+    /**
+     * When set to true, returns the contacts also within the specified Contact Group subgroups, if the group parameter is set.
+     */
+    recurse?: boolean;
+}
+/**
+ * Interface representing the query parameters for retrieving a single contact.
+ */
+export interface FindContactQueryParams {
+    profilePicture?: boolean;
+}
+/**
+ * Interface for creating a contact.
+ */
+export type CreateContactRequest = {
+    displayName?: string;
+    birthday?: string;
+    companyName?: string;
+    emails?: Email[];
+    givenName?: string;
+    imAddresses?: InstantMessagingAddress[];
+    jobTitle?: string;
+    managerName?: string;
+    middleName?: string;
+    nickname?: string;
+    notes?: string;
+    officeLocation?: string;
+    phoneNumbers?: PhoneNumber[];
+    physicalAddresses?: PhysicalAddress[];
+    suffix?: string;
+    surname?: string;
+    webPages?: WebPage[];
+    picture?: string;
+    source?: SourceType;
+    groups?: ContactGroup[];
+};
+/**
+ * Interface for updating a contact.
+ */
+export type UpdateContactRequest = CreateContactRequest;

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