nylas 7.0.0-canary.4 → 7.0.0

package/README.md

@@ -1,26 +1,40 @@
+<a href="https://www.nylas.com/">
+    <img src="https://brand.nylas.com/assets/downloads/logo_horizontal_png/Nylas-Logo-Horizontal-Blue_.png" alt="Aimeos logo" title="Aimeos" align="right" height="60" />
+</a>
+
 # Nylas Node.js SDK  
 
-[![Travis build status](https://travis-ci.org/nylas/nylas-nodejs.svg?branch=master)](https://travis-ci.org/nylas/nylas-nodejs)
+[![npm](https://img.shields.io/npm/v/nylas)
+](https://www.npmjs.com/package/nylas)
+[![codecov](https://codecov.io/gh/nylas/nylas-nodejs/branch/main/graph/badge.svg?token=94IMGU4F09)](https://codecov.io/gh/nylas/nylas-nodejs)
 
-This is the GitHub repository for the Nylas Node SDK and this repo is primarily for anyone who wants to make contributions to the SDK or install it from source. If you are looking to use Node to access the Nylas Email, Calendar, or Contacts API you should refer to our official [Node SDK Quickstart Guide](https://developer.nylas.com/docs/developer-tools/sdk/node-sdk/).
+This is the GitHub repository for the Nylas Node SDK. This repo is primarily for anyone who wants to make contributions to the SDK, or install it from source. If you are looking to use Node to access the Nylas Email, Calendar, or Contacts API you should refer to our official [Node SDK Quickstart Guide](https://developer.nylas.com/docs/developer-tools/sdk/node-sdk/).
 
 The Nylas Communications Platform provides REST APIs for [Email](https://developer.nylas.com/docs/connectivity/email/), [Calendar](https://developer.nylas.com/docs/connectivity/calendar/), and [Contacts](https://developer.nylas.com/docs/connectivity/contacts/), and the Node SDK is the quickest way to build your integration using JavaScript.
 
 Here are some resources to help you get started:
 
-- [Nylas SDK Tutorials](https://developer.nylas.com/docs/the-basics/tutorials/nodejs/)
-- [Quickstart](https://developer.nylas.com/docs/the-basics/quickstart/)
+- [Sign up for your free Nylas account](https://dashboard.nylas.com/register)
+- [Sign up for the Nylas v3 Beta program to access the v3 Dashboard](https://info.nylas.com/apiv3betasignup.html?utm_source=github&utm_medium=devrel-surfaces&utm_campaign=&utm_content=node-sdk-upgrade)
+- [Nylas API v3 Quickstart Guide](https://developer.nylas.com/docs/v3-beta/v3-quickstart/)
+- [Nylas SDK Reference](https://nylas-nodejs-sdk-reference.pages.dev/)
 - [Nylas API Reference](https://developer.nylas.com/docs/api/)
+- [Nylas Samples repo for code samples and example applications](https://github.com/orgs/nylas-samples/repositories?q=&type=all&language=javascript)
+
+## ⚙️ Install
 
+**Note:** The Nylas Node SDK requires Node.js v16 or later.
 
-# Install
+### Set up using npm
 
-To install the Nylas Node SDK, you will first need to have [Node](https://nodejs.org/en/download/) and [npm](https://www.npmjs.com/get-npm) installed on your machine.
+To run the Nylas Node SDK, first install [Node](https://nodejs.org/en/download/) and [npm](https://www.npmjs.com/get-npm) on your machine.
 
 Then, head to the nearest command line and run the following:
 `npm install nylas`
 
-Alternatively, if you prefer to use [Yarn](https://yarnpkg.com/en/), you can install the Nylas Node SDK with `yarn add nylas`
+Alternatively, you can use [Yarn](https://yarnpkg.com/en/) to install the Nylas Node SDK by running the `yarn add nylas` command.
+
+### Build from source
 
 To install this package from source, clone this repo and run `npm install` from inside the project directory.
 
@@ -30,40 +44,48 @@ cd nylas-nodejs
 npm install
 ```
 
-# Usage
+## ⚡️ Usage
 
-The SDK entrypoint and application resources (i.e., application accounts, authentication, webhooks) is accessed via an instance of `Nylas`. You can initialize a `Nylas` instance with your `clientId` and `clientSecret`.
+To use this SDK, you must first [get a free Nylas account](https://dashboard.nylas.com/register).
 
-```javascript
-const Nylas = require('nylas');
+Then, follow the Quickstart guide to [set up your first app and get your API keys](https://developer.nylas.com/docs/v3-beta/v3-quickstart/).
 
-const nylasClient = new Nylas({
-  clientId: CLIENT_ID,
-  clientSecret: CLIENT_SECRET,
-});
-```
+For code examples that demonstrate how to use this SDK, take a look at our [Node repos in the Nylas Samples collection](https://github.com/orgs/nylas-samples/repositories?q=&type=all&language=javascript&sort=).
+
+### 🚀 Making Your First Request
+
+You access Nylas resources (messages, calendars, events, contacts) through an instance of `Nylas`. The `Nylas` object must be initialized with your Nylas API key, and you can provide other additional configurations such as the Nylas API url and the timeout.
 
-Every account resource (i.e., messages, events, contacts) is accessed via an instance of `NylasConnection`. To initialize an instance of `NylasConnection`, call `with` on your `Nylas` instance and pass it your `accessToken`.
+```typescript
+import Nylas from "nylas";
 
-```javascript
-const nylasConnection = nylasClient.with(ACCESS_TOKEN);
+const nylas = new Nylas({
+  apiKey: "NYLAS_API_KEY",
+});
 ```
 
-Then, you can use Nylas to access information about a user's account:
-```javascript
-nylasConnection.threads.list().then(threads => {
-  console.log(threads.length);
+Once initialized you can use the object to make requests for a given account's resources, for example to list all the calendars for a given account:
+
+```typescript
+nylas.calendars.list({ identifier: "GRANT_ID" }).then(calendars => {
+  console.log(calendars);
 });
 ```
 
-For more information about how to use the Nylas Node SDK, [take a look at our quickstart guide](https://developer.nylas.com/docs/developer-tools/sdk/node-sdk/).
+## 📚 Documentation
 
-# Contributing
+Nylas maintains a [reference guide for the Node SDK](https://nylas-nodejs-sdk-reference.pages.dev/) to help you get familiar with the available methods and classes.
 
-Please refer to [Contributing](Contributing.md) for information about how to make contributions to this project. We welcome questions, bug reports, and pull requests.
+## ✨ Upgrading from 6.x
 
-# License
+See [UPGRADE.md](UPGRADE.md) for instructions on upgrading from 6.x to 7.x.
 
-This project is licensed under the terms of the MIT license. Please refer to [LICENSE](LICENSE.txt) for the full terms. 
+**Note**: The Node SDK v7.x is not compatible with the Nylas API earlier than v3-beta.
+
+## 💙 Contributing
+
+Please refer to [Contributing](Contributing.md) for information about how to make contributions to this project. We welcome questions, bug reports, and pull requests.
 
+## 📝 License
 
+This project is licensed under the terms of the MIT license. Please refer to [LICENSE](LICENSE.txt) for the full terms.

package/lib/cjs/apiClient.js

@@ -0,0 +1,139 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_fetch_1 = require("node-fetch");
+const error_js_1 = require("./models/error.js");
+const utils_js_1 = require("./utils.js");
+const version_js_1 = require("./version.js");
+/**
+ * The API client for communicating with the Nylas API
+ * @ignore Not for public use
+ */
+class APIClient {
+    constructor({ apiKey, apiUri, timeout }) {
+        this.apiKey = apiKey;
+        this.serverUrl = apiUri;
+        this.timeout = timeout * 1000; // fetch timeout uses milliseconds
+    }
+    setRequestUrl({ overrides, path, queryParams, }) {
+        const url = new URL(`${overrides?.apiUri || this.serverUrl}${path}`);
+        return this.setQueryStrings(url, queryParams);
+    }
+    setQueryStrings(url, queryParams) {
+        if (queryParams) {
+            const snakeCaseParams = (0, utils_js_1.objKeysToSnakeCase)(queryParams, ['metadataPair']);
+            for (const [key, value] of Object.entries(snakeCaseParams)) {
+                if (key == 'metadataPair') {
+                    // The API understands a metadata_pair filter in the form of:
+                    // <key>:<value>
+                    const metadataPair = [];
+                    for (const item in value) {
+                        metadataPair.push(`${item}:${value[item]}`);
+                    }
+                    url.searchParams.set('metadata_pair', metadataPair.join(','));
+                }
+                else {
+                    url.searchParams.set(key, value);
+                }
+            }
+        }
+        return url;
+    }
+    setRequestHeaders({ headers, overrides, }) {
+        return {
+            Accept: 'application/json',
+            'User-Agent': `Nylas Node SDK v${version_js_1.SDK_VERSION}`,
+            Authorization: `Bearer ${overrides?.apiKey || this.apiKey}`,
+            ...headers,
+        };
+    }
+    async sendRequest(options) {
+        const req = this.newRequest(options);
+        const controller = new AbortController();
+        const timeout = setTimeout(() => {
+            controller.abort();
+            throw new error_js_1.NylasSdkTimeoutError(req.url, this.timeout);
+        }, this.timeout);
+        try {
+            const response = await (0, node_fetch_1.default)(req, { signal: controller.signal });
+            clearTimeout(timeout);
+            if (typeof response === 'undefined') {
+                throw new Error('Failed to fetch response');
+            }
+            if (response.status > 299) {
+                const text = await response.text();
+                let error;
+                try {
+                    const parsedError = JSON.parse(text);
+                    const camelCaseError = (0, utils_js_1.objKeysToCamelCase)(parsedError);
+                    // Check if the request is an authentication request
+                    const isAuthRequest = options.path.includes('connect/token') ||
+                        options.path.includes('connect/revoke');
+                    if (isAuthRequest) {
+                        error = new error_js_1.NylasOAuthError(camelCaseError, response.status);
+                    }
+                    else {
+                        error = new error_js_1.NylasApiError(camelCaseError, response.status);
+                    }
+                }
+                catch (e) {
+                    throw new Error(`Received an error but could not parse response from the server: ${text}`);
+                }
+                throw error;
+            }
+            return response;
+        }
+        catch (error) {
+            clearTimeout(timeout);
+            throw error;
+        }
+    }
+    requestOptions(optionParams) {
+        const requestOptions = {};
+        requestOptions.url = this.setRequestUrl(optionParams);
+        requestOptions.headers = this.setRequestHeaders(optionParams);
+        requestOptions.method = optionParams.method;
+        if (optionParams.body) {
+            requestOptions.body = JSON.stringify((0, utils_js_1.objKeysToSnakeCase)(optionParams.body));
+            requestOptions.headers['Content-Type'] = 'application/json';
+        }
+        if (optionParams.form) {
+            requestOptions.body = optionParams.form;
+            requestOptions.headers = {
+                ...requestOptions.headers,
+                ...optionParams.form.getHeaders(),
+            };
+        }
+        return requestOptions;
+    }
+    newRequest(options) {
+        const newOptions = this.requestOptions(options);
+        return new node_fetch_1.Request(newOptions.url, {
+            method: newOptions.method,
+            headers: newOptions.headers,
+            body: newOptions.body,
+        });
+    }
+    async requestWithResponse(response) {
+        const text = await response.text();
+        try {
+            const responseJSON = JSON.parse(text);
+            return (0, utils_js_1.objKeysToCamelCase)(responseJSON);
+        }
+        catch (e) {
+            throw new Error(`Could not parse response from the server: ${text}`);
+        }
+    }
+    async request(options) {
+        const response = await this.sendRequest(options);
+        return this.requestWithResponse(response);
+    }
+    async requestRaw(options) {
+        const response = await this.sendRequest(options);
+        return response.buffer();
+    }
+    async requestStream(options) {
+        const response = await this.sendRequest(options);
+        return response.body;
+    }
+}
+exports.default = APIClient;

package/lib/cjs/config.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_SERVER_URL = exports.REGION_CONFIG = exports.DEFAULT_REGION = exports.Region = void 0;
+/**
+ * Enum representing the available Nylas API regions.
+ */
+var Region;
+(function (Region) {
+    Region["Us"] = "us";
+    Region["Eu"] = "eu";
+})(Region = exports.Region || (exports.Region = {}));
+/**
+ * The default Nylas API region.
+ * @default Region.Us
+ */
+exports.DEFAULT_REGION = Region.Us;
+/**
+ * The available preset configuration values for each Nylas API region.
+ */
+exports.REGION_CONFIG = {
+    [Region.Us]: {
+        nylasAPIUrl: 'https://api.us.nylas.com',
+    },
+    [Region.Eu]: {
+        nylasAPIUrl: 'https://api.eu.nylas.com',
+    },
+};
+/**
+ * The default Nylas API URL.
+ * @default https://api.us.nylas.com
+ */
+exports.DEFAULT_SERVER_URL = exports.REGION_CONFIG[exports.DEFAULT_REGION].nylasAPIUrl;

package/lib/cjs/models/applicationDetails.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/models/attachments.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/models/auth.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/models/availability.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AvailabilityMethod = void 0;
+/**
+ * Enum representing the method used to determine availability for a meeting.
+ */
+var AvailabilityMethod;
+(function (AvailabilityMethod) {
+    AvailabilityMethod["MaxFairness"] = "max-fairness";
+    AvailabilityMethod["MaxAvailability"] = "max-availability";
+})(AvailabilityMethod = exports.AvailabilityMethod || (exports.AvailabilityMethod = {}));

package/lib/cjs/models/calendars.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/models/connectors.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/models/contacts.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/models/credentials.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CredentialType = void 0;
+/**
+ * Enum representing the type of credential
+ */
+var CredentialType;
+(function (CredentialType) {
+    CredentialType["ADMINCONSENT"] = "adminconsent";
+    CredentialType["SERVICEACCOUNT"] = "serviceaccount";
+    CredentialType["CONNECTOR"] = "connector";
+})(CredentialType = exports.CredentialType || (exports.CredentialType = {}));

package/lib/cjs/models/drafts.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/models/error.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NylasSdkTimeoutError = exports.NylasOAuthError = exports.NylasApiError = exports.AbstractNylasSdkError = exports.AbstractNylasApiError = void 0;
+/**
+ * Base class for all Nylas API errors.
+ */
+class AbstractNylasApiError extends Error {
+}
+exports.AbstractNylasApiError = AbstractNylasApiError;
+/**
+ * Base class for all Nylas SDK errors.
+ */
+class AbstractNylasSdkError extends Error {
+}
+exports.AbstractNylasSdkError = AbstractNylasSdkError;
+/**
+ * Class representation of a general Nylas API error.
+ */
+class NylasApiError extends AbstractNylasApiError {
+    constructor(apiError, statusCode) {
+        super(apiError.error.message);
+        this.type = apiError.error.type;
+        this.requestId = apiError.requestId;
+        this.providerError = apiError.error.providerError;
+        this.statusCode = statusCode;
+    }
+}
+exports.NylasApiError = NylasApiError;
+/**
+ * Class representing an OAuth error returned by the Nylas API.
+ */
+class NylasOAuthError extends AbstractNylasApiError {
+    constructor(apiError, statusCode) {
+        super(apiError.errorDescription);
+        this.error = apiError.error;
+        this.errorCode = apiError.errorCode;
+        this.errorDescription = apiError.errorDescription;
+        this.errorUri = apiError.errorUri;
+        this.statusCode = statusCode;
+    }
+}
+exports.NylasOAuthError = NylasOAuthError;
+/**
+ * Error thrown when the Nylas SDK times out before receiving a response from the server
+ */
+class NylasSdkTimeoutError extends AbstractNylasSdkError {
+    constructor(url, timeout) {
+        super('Nylas SDK timed out before receiving a response from the server.');
+        this.url = url;
+        this.timeout = timeout;
+    }
+}
+exports.NylasSdkTimeoutError = NylasSdkTimeoutError;

package/lib/cjs/models/events.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WhenType = void 0;
+/**
+ * Enum representing the different types of when objects.
+ */
+var WhenType;
+(function (WhenType) {
+    WhenType["Time"] = "time";
+    WhenType["Timespan"] = "timespan";
+    WhenType["Date"] = "date";
+    WhenType["Datespan"] = "datespan";
+})(WhenType = exports.WhenType || (exports.WhenType = {}));

package/lib/cjs/models/folders.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/models/freeBusy.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FreeBusyType = void 0;
+/**
+ * Enum representing the type of free/busy information returned for a calendar.
+ */
+var FreeBusyType;
+(function (FreeBusyType) {
+    FreeBusyType["FREE_BUSY"] = "free_busy";
+    FreeBusyType["ERROR"] = "error";
+})(FreeBusyType = exports.FreeBusyType || (exports.FreeBusyType = {}));

package/lib/cjs/models/grants.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/models/listQueryParams.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/models/messages.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MessageFields = void 0;
+/**
+ * Enum representing the message fields that can be included in a response.
+ */
+var MessageFields;
+(function (MessageFields) {
+    MessageFields["STANDARD"] = "standard";
+    MessageFields["INCLUDE_HEADERS"] = "include_headers";
+})(MessageFields = exports.MessageFields || (exports.MessageFields = {}));

package/lib/cjs/models/redirectUri.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/models/response.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/models/smartCompose.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/models/threads.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/models/webhooks.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookTriggers = void 0;
+/**
+ * Enum representing the available webhook triggers.
+ */
+var WebhookTriggers;
+(function (WebhookTriggers) {
+    WebhookTriggers["CalendarCreated"] = "calendar.created";
+    WebhookTriggers["CalendarUpdated"] = "calendar.updated";
+    WebhookTriggers["CalendarDeleted"] = "calendar.deleted";
+    WebhookTriggers["EventCreated"] = "event.created";
+    WebhookTriggers["EventUpdated"] = "event.updated";
+    WebhookTriggers["EventDeleted"] = "event.deleted";
+    WebhookTriggers["GrantCreated"] = "grant.created";
+    WebhookTriggers["GrantUpdated"] = "grant.updated";
+    WebhookTriggers["GrantDeleted"] = "grant.deleted";
+    WebhookTriggers["GrantExpired"] = "grant.expired";
+    WebhookTriggers["MessageSendSuccess"] = "message.send_success";
+    WebhookTriggers["MessageSendFailed"] = "message.send_failed";
+})(WebhookTriggers = exports.WebhookTriggers || (exports.WebhookTriggers = {}));

package/lib/cjs/nylas.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const apiClient_js_1 = require("./apiClient.js");
+const config_js_1 = require("./config.js");
+const calendars_js_1 = require("./resources/calendars.js");
+const events_js_1 = require("./resources/events.js");
+const auth_js_1 = require("./resources/auth.js");
+const webhooks_js_1 = require("./resources/webhooks.js");
+const applications_js_1 = require("./resources/applications.js");
+const messages_js_1 = require("./resources/messages.js");
+const drafts_js_1 = require("./resources/drafts.js");
+const threads_js_1 = require("./resources/threads.js");
+const connectors_js_1 = require("./resources/connectors.js");
+const folders_js_1 = require("./resources/folders.js");
+const grants_js_1 = require("./resources/grants.js");
+const contacts_js_1 = require("./resources/contacts.js");
+const attachments_js_1 = require("./resources/attachments.js");
+/**
+ * The entry point to the Node SDK
+ *
+ * A Nylas instance holds a configured http client pointing to a base URL and is intended to be reused and shared
+ * across threads and time.
+ */
+class Nylas {
+    /**
+     * @param config Configuration options for the Nylas SDK
+     */
+    constructor(config) {
+        this.apiClient = new apiClient_js_1.default({
+            apiKey: config.apiKey,
+            apiUri: config.apiUri || config_js_1.DEFAULT_SERVER_URL,
+            timeout: config.timeout || 30,
+        });
+        this.applications = new applications_js_1.Applications(this.apiClient);
+        this.auth = new auth_js_1.Auth(this.apiClient);
+        this.calendars = new calendars_js_1.Calendars(this.apiClient);
+        this.connectors = new connectors_js_1.Connectors(this.apiClient);
+        this.drafts = new drafts_js_1.Drafts(this.apiClient);
+        this.events = new events_js_1.Events(this.apiClient);
+        this.grants = new grants_js_1.Grants(this.apiClient);
+        this.messages = new messages_js_1.Messages(this.apiClient);
+        this.threads = new threads_js_1.Threads(this.apiClient);
+        this.webhooks = new webhooks_js_1.Webhooks(this.apiClient);
+        this.folders = new folders_js_1.Folders(this.apiClient);
+        this.contacts = new contacts_js_1.Contacts(this.apiClient);
+        this.attachments = new attachments_js_1.Attachments(this.apiClient);
+        return this;
+    }
+}
+exports.default = Nylas;

package/lib/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/lib/cjs/resources/applications.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Applications = void 0;
+const resource_js_1 = require("./resource.js");
+const redirectUris_js_1 = require("./redirectUris.js");
+/**
+ * Nylas Applications API
+ *
+ * This endpoint allows for getting application details as well as redirect URI operations.
+ */
+class Applications extends resource_js_1.Resource {
+    /**
+     * @param apiClient client The configured Nylas API client
+     */
+    constructor(apiClient) {
+        super(apiClient);
+        this.redirectUris = new redirectUris_js_1.RedirectUris(apiClient);
+    }
+    /**
+     * Get application details
+     * @returns The application details
+     */
+    getDetails({ overrides } = {}) {
+        return super._find({
+            path: `/v3/applications`,
+            overrides,
+        });
+    }
+}
+exports.Applications = Applications;

package/lib/cjs/resources/attachments.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Attachments = void 0;
+const resource_js_1 = require("./resource.js");
+/**
+ * Nylas Attachments API
+ *
+ * The Nylas Attachments API allows you to retrieve metadata and download attachments.
+ */
+class Attachments extends resource_js_1.Resource {
+    /**
+     * Returns an attachment by ID.
+     * @return The Attachment metadata
+     */
+    find({ identifier, attachmentId, queryParams, overrides, }) {
+        return super._find({
+            path: `/v3/grants/${identifier}/attachments/${attachmentId}`,
+            queryParams,
+            overrides,
+        });
+    }
+    /**
+     * 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, }) {
+        return this._getStream({
+            path: `/v3/grants/${identifier}/attachments/${attachmentId}/download`,
+            queryParams,
+            overrides,
+        });
+    }
+    /**
+     * 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, }) {
+        return super._getRaw({
+            path: `/v3/grants/${identifier}/attachments/${attachmentId}/download`,
+            queryParams,
+            overrides,
+        });
+    }
+}
+exports.Attachments = Attachments;