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

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

@@ -0,0 +1,80 @@
+import { AsyncListResponse, Resource } from './resource.js';
+import { Credential, CreateCredentialRequest, ListCredentialsQueryParams, UpdateCredentialRequest } from '../models/credentials.js';
+import { Overrides } from '../config.js';
+import { NylasDeleteResponse, NylasListResponse, NylasResponse } from '../models/response.js';
+import { Provider } from '../models/auth.js';
+/**
+ * The parameters for the {@link Credentials.find} method
+ * @property provider The provider associated to the credential to retrieve.
+ * @property credentialsId The id of the credentials to retrieve.
+ */
+interface FindCredentialParams {
+    provider: Provider;
+    credentialsId: string;
+}
+/**
+ * The parameters for the {@link Credentials.list} method
+ * @property provider The provider associated to the credential to list from.
+ * @property queryParams The query parameters to include in the request
+ */
+interface ListCredentialsParams {
+    provider: Provider;
+    queryParams?: ListCredentialsQueryParams;
+}
+/**
+ * The parameters for the {@link Credentials.create} method
+ * @property provider The provider associated to the credential being created.
+ * @property requestBody The request body to create a credential
+ */
+interface CreateCredentialParams {
+    provider: Provider;
+    requestBody: CreateCredentialRequest;
+}
+/**
+ * The parameters for the {@link Credentials.update} method
+ * @property provider The provider associated to the credential to update from.
+ * @property requestBody The request body to create a credential
+ * @property credentialsId The id of the credentials to update.
+ */
+interface UpdateCredentialParams {
+    provider: Provider;
+    credentialsId: string;
+    requestBody: UpdateCredentialRequest;
+}
+/**
+ * The parameters for the {@link Credentials.destroy} method
+ * @property provider The provider associated to the credential to delete from.
+ * @property credentialsId The id of the credentials to delete.
+ */
+interface DestroyCredentialParams {
+    provider: string;
+    credentialsId: string;
+}
+export declare class Credentials extends Resource {
+    /**
+     * Return all credentials
+     * @return A list of credentials
+     */
+    list({ provider, queryParams, overrides, }: ListCredentialsParams & ListCredentialsQueryParams & Overrides): AsyncListResponse<NylasListResponse<Credential>>;
+    /**
+     * Return a credential
+     * @return The credential
+     */
+    find({ provider, credentialsId, overrides, }: FindCredentialParams & Overrides): Promise<NylasResponse<Credential>>;
+    /**
+     * Create a credential
+     * @return The created credential
+     */
+    create({ provider, requestBody, overrides, }: CreateCredentialParams & Overrides): Promise<NylasResponse<Credential>>;
+    /**
+     * Update a credential
+     * @return The updated credential
+     */
+    update({ provider, credentialsId, requestBody, overrides, }: UpdateCredentialParams & Overrides): Promise<NylasResponse<Credential>>;
+    /**
+     * Delete a credential
+     * @return The deleted credential
+     */
+    destroy({ provider, credentialsId, overrides, }: DestroyCredentialParams & Overrides): Promise<NylasDeleteResponse>;
+}
+export {};

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

@@ -0,0 +1,87 @@
+import { AsyncListResponse, Resource } from './resource.js';
+import { CreateDraftRequest, Draft, ListDraftsQueryParams, UpdateDraftRequest } from '../models/drafts.js';
+import { Overrides } from '../config.js';
+import { NylasDeleteResponse, NylasListResponse, NylasResponse } from '../models/response.js';
+/**
+ * The parameters for the {@link Drafts.list} method
+ * @property identifier The identifier of the grant to act upon
+ * @property queryParams The query parameters to include in the request
+ */
+export interface ListDraftsParams {
+    identifier: string;
+    queryParams?: ListDraftsQueryParams;
+}
+/**
+ * The parameters for the {@link Drafts.find} method
+ * @property identifier The identifier of the grant to act upon
+ * @property draftId The id of the draft to retrieve.
+ */
+export interface FindDraftParams {
+    identifier: string;
+    draftId: string;
+}
+/**
+ * The parameters for the {@link Drafts.create} method
+ * @property identifier The identifier of the grant to act upon
+ * @property requestBody The values to create the message with
+ */
+export interface CreateDraftParams {
+    identifier: string;
+    requestBody: CreateDraftRequest;
+}
+/**
+ * The parameters for the {@link Drafts.update} method
+ * @property identifier The identifier of the grant to act upon
+ * @property draftId The id of the draft to update.
+ * @property requestBody The values to update the draft with
+ */
+export interface UpdateDraftParams {
+    identifier: string;
+    draftId: string;
+    requestBody: UpdateDraftRequest;
+}
+/**
+ * The parameters for the {@link Drafts.destroy} method
+ */
+export type DestroyDraftParams = FindDraftParams;
+/**
+ * The parameters for the {@link Drafts.send} method
+ */
+export type SendDraftParams = FindDraftParams;
+/**
+ * Nylas Drafts API
+ *
+ * The Nylas Drafts API allows you to list, find, update, delete, and send drafts on user accounts.
+ */
+export declare class Drafts extends Resource {
+    /**
+     * Return all Drafts
+     * @return A list of drafts
+     */
+    list({ identifier, queryParams, overrides, }: ListDraftsParams & Overrides): AsyncListResponse<NylasListResponse<Draft>>;
+    /**
+     * Return a Draft
+     * @return The draft
+     */
+    find({ identifier, draftId, overrides, }: FindDraftParams & Overrides): Promise<NylasResponse<Draft>>;
+    /**
+     * Return a Draft
+     * @return The draft
+     */
+    create({ identifier, requestBody, overrides, }: CreateDraftParams & Overrides): Promise<NylasResponse<Draft>>;
+    /**
+     * Update a Draft
+     * @return The updated draft
+     */
+    update({ identifier, draftId, requestBody, overrides, }: UpdateDraftParams & Overrides): Promise<NylasResponse<Draft>>;
+    /**
+     * Delete a Draft
+     * @return The deleted draft
+     */
+    destroy({ identifier, draftId, overrides, }: DestroyDraftParams & Overrides): Promise<NylasDeleteResponse>;
+    /**
+     * Send a Draft
+     * @return The sent draft
+     */
+    send({ identifier, draftId, overrides, }: SendDraftParams & Overrides): Promise<NylasResponse<Draft>>;
+}

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

@@ -45,7 +45,7 @@ export declare class Grants extends Resource {
      */
     find({ grantId, overrides, }: FindGrantParams & Overrides): Promise<NylasResponse<Grant>>;
     /**
-     * Create a Grant
+     * Create a Grant via Custom Authentication
      * @return The created Grant
      */
     create({ requestBody, overrides, }: CreateGrantParams & Overrides): Promise<NylasResponse<Grant>>;

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

@@ -0,0 +1,129 @@
+import { AsyncListResponse, Resource } from './resource.js';
+import { BaseCreateMessage, FindMessageQueryParams, ListMessagesQueryParams, Message, ScheduledMessage, ScheduledMessagesList, StopScheduledMessageResponse, UpdateMessageRequest } from '../models/messages.js';
+import { Overrides } from '../config.js';
+import { NylasDeleteResponse, NylasListResponse, NylasResponse } from '../models/response.js';
+import { SendMessageRequest, UpdateDraftRequest } from '../models/drafts.js';
+import * as FormData from 'form-data';
+import { SmartCompose } from './smartCompose.js';
+import APIClient from '../apiClient.js';
+/**
+ * The parameters for the {@link Messages.list} method
+ * @property identifier The identifier of the grant to act upon
+ * @property queryParams The query parameters to include in the request
+ */
+export interface ListMessagesParams {
+    identifier: string;
+    queryParams?: ListMessagesQueryParams;
+}
+/**
+ * The parameters for the {@link Messages.find} method
+ * @property identifier The identifier of the grant to act upon
+ * @property messageId The id of the message to retrieve.
+ * @property queryParams The query parameters to include in the request
+ */
+export interface FindMessageParams {
+    identifier: string;
+    messageId: string;
+    queryParams?: FindMessageQueryParams;
+}
+/**
+ * The parameters for the {@link Messages.update} method
+ * @property identifier The identifier of the grant to act upon
+ * @property messageId The id of the message to update
+ * @property requestBody The values to update the message with
+ */
+export interface UpdateMessageParams {
+    identifier: string;
+    messageId: string;
+    requestBody: UpdateMessageRequest;
+}
+/**
+ * The parameters for the {@link Messages.destroy} method
+ * @property identifier The identifier of the grant to act upon
+ * @property messageId The id of the message to delete
+ */
+export interface DestroyMessageParams {
+    identifier: string;
+    messageId: string;
+}
+/**
+ * The parameters for the {@link Messages.send} method
+ * @property identifier The identifier of the grant to act upon
+ * @property requestBody The message to send
+ */
+export interface SendMessageParams {
+    identifier: string;
+    requestBody: SendMessageRequest;
+}
+/**
+ * The parameters for the {@link Messages.listScheduledMessages} method
+ * @property identifier The identifier of the grant to act upon
+ */
+export interface ListScheduledMessagesParams {
+    identifier: string;
+}
+/**
+ * The parameters for the {@link Messages.findScheduledMessage} method
+ * @property identifier The identifier of the grant to act upon
+ * @property scheduleId The id of the scheduled message to retrieve.
+ */
+export interface FindScheduledMessageParams {
+    identifier: string;
+    scheduleId: string;
+}
+/**
+ * The parameters for the {@link Messages.stopScheduledMessage} method
+ * @property identifier The identifier of the grant to act upon
+ * @property scheduleId The id of the scheduled message to destroy.
+ */
+export type StopScheduledMessageParams = FindScheduledMessageParams;
+/**
+ * Nylas Messages API
+ *
+ * The Nylas Messages API allows you to list, find, update, delete, schedule, and send messages on user accounts.
+ */
+export declare class Messages extends Resource {
+    smartCompose: SmartCompose;
+    constructor(apiClient: APIClient);
+    /**
+     * Return all Messages
+     * @return A list of messages
+     */
+    list({ identifier, queryParams, overrides, }: ListMessagesParams & Overrides): AsyncListResponse<NylasListResponse<Message>>;
+    /**
+     * Return a Message
+     * @return The message
+     */
+    find({ identifier, messageId, overrides, }: FindMessageParams & Overrides): Promise<NylasResponse<Message>>;
+    /**
+     * Update a Message
+     * @return The updated message
+     */
+    update({ identifier, messageId, requestBody, overrides, }: UpdateMessageParams & Overrides): Promise<NylasResponse<Message>>;
+    /**
+     * Delete a Message
+     * @return The deleted message
+     */
+    destroy({ identifier, messageId, overrides, }: DestroyMessageParams & Overrides): Promise<NylasDeleteResponse>;
+    /**
+     * Send an email
+     * @return The sent message
+     */
+    send({ identifier, requestBody, overrides, }: SendMessageParams & Overrides): Promise<NylasResponse<Message>>;
+    /**
+     * Retrieve your scheduled messages
+     * @return A list of scheduled messages
+     */
+    listScheduledMessages({ identifier, overrides, }: ListScheduledMessagesParams & Overrides): Promise<NylasResponse<ScheduledMessagesList>>;
+    /**
+     * Retrieve a scheduled message
+     * @return The scheduled message
+     */
+    findScheduledMessage({ identifier, scheduleId, overrides, }: FindScheduledMessageParams & Overrides): Promise<NylasResponse<ScheduledMessage>>;
+    /**
+     * Stop a scheduled message
+     * @return The confirmation of the stopped scheduled message
+     */
+    stopScheduledMessage({ identifier, scheduleId, overrides, }: StopScheduledMessageParams & Overrides): Promise<NylasResponse<StopScheduledMessageResponse>>;
+    static _buildFormRequest(requestBody: BaseCreateMessage | UpdateDraftRequest): FormData;
+}

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

@@ -0,0 +1,41 @@
+import { Resource } from './resource.js';
+import { ComposeMessageRequest, ComposeMessageResponse } from '../models/smartCompose.js';
+import { Overrides } from '../config.js';
+import { NylasResponse } from '../models/response.js';
+/**
+ * The parameters for the {@link SmartCompose.composeMessage} method
+ * @property identifier The identifier of the grant to act upon
+ * @property requestBody The prompt that smart compose will use to generate a message suggestion
+ */
+export interface ComposeMessageParams {
+    identifier: string;
+    requestBody: ComposeMessageRequest;
+}
+/**
+ * The parameters for the {@link SmartCompose.composeMessageReply} method
+ * @property identifier The identifier of the grant to act upon
+ * @property messageId The id of the message to reply to
+ * @property requestBody The prompt that smart compose will use to generate a reply suggestion
+ */
+export interface ComposeMessageReplyParams {
+    identifier: string;
+    messageId: string;
+    requestBody: ComposeMessageRequest;
+}
+/**
+ * A collection of Smart Compose related API endpoints.
+ *
+ * These endpoints allow for the generation of message suggestions.
+ */
+export declare class SmartCompose extends Resource {
+    /**
+     * Compose a message
+     * @return The generated message
+     */
+    composeMessage({ identifier, requestBody, overrides, }: ComposeMessageParams & Overrides): Promise<NylasResponse<ComposeMessageResponse>>;
+    /**
+     * Compose a message reply
+     * @return The generated message reply
+     */
+    composeMessageReply({ identifier, messageId, requestBody, overrides, }: ComposeMessageReplyParams & Overrides): Promise<NylasResponse<ComposeMessageResponse>>;
+}

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

@@ -0,0 +1,70 @@
+import { ListThreadsQueryParams, Thread, UpdateThreadRequest } from '../models/threads.js';
+import { AsyncListResponse, Resource } from './resource.js';
+import { Overrides } from '../config.js';
+import { NylasDeleteResponse, NylasListResponse, NylasResponse } from '../models/response.js';
+/**
+ * The parameters for the {@link Threads.list} method
+ * @property identifier The identifier of the grant to act upon
+ * @property queryParams The query parameters to include in the request
+ */
+export interface ListThreadsParams {
+    identifier: string;
+    queryParams?: ListThreadsQueryParams;
+}
+/**
+ * The parameters for the {@link Threads.find} method
+ * @property identifier The identifier of the grant to act upon
+ * @property threadId The id of the thread to retrieve.
+ * @property queryParams The query parameters to include in the request
+ */
+export interface FindThreadParams {
+    identifier: string;
+    threadId: string;
+}
+/**
+ * The parameters for the {@link Threads.update} method
+ * @property identifier The identifier of the grant to act upon
+ * @property threadId The id of the thread to update
+ * @property requestBody The values to update the thread with
+ */
+export interface UpdateThreadParams {
+    identifier: string;
+    threadId: string;
+    requestBody: UpdateThreadRequest;
+}
+/**
+ * The parameters for the {@link Threads.destroy} method
+ * @property identifier The identifier of the grant to act upon
+ * @property threadId The id of the thread to delete
+ */
+export interface DestroyThreadParams {
+    identifier: string;
+    threadId: string;
+}
+/**
+ * Nylas Threads API
+ *
+ * The Nylas Threads API allows you to list, find, update, and delete threads on user accounts.
+ */
+export declare class Threads extends Resource {
+    /**
+     * Return all Threads
+     * @return A list of threads
+     */
+    list({ identifier, queryParams, overrides, }: ListThreadsParams & Overrides): AsyncListResponse<NylasListResponse<Thread>>;
+    /**
+     * Return a Thread
+     * @return The thread
+     */
+    find({ identifier, threadId, overrides, }: FindThreadParams & Overrides): Promise<NylasResponse<Thread>>;
+    /**
+     * Update a Thread
+     * @return The updated thread
+     */
+    update({ identifier, threadId, requestBody, overrides, }: UpdateThreadParams & Overrides): Promise<NylasResponse<Thread>>;
+    /**
+     * Delete a Thread
+     * @return The deleted thread
+     */
+    destroy({ identifier, threadId, overrides, }: DestroyThreadParams & Overrides): Promise<NylasDeleteResponse>;
+}

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

@@ -48,7 +48,7 @@ export declare class Webhooks extends Resource {
      * Create a webhook destination
      * @returns The created webhook destination
      */
-    create({ requestBody, overrides, }: CreateWebhookParams & Overrides): Promise<NylasResponse<Webhook>>;
+    create({ requestBody, overrides, }: CreateWebhookParams & Overrides): Promise<NylasResponse<WebhookWithSecret>>;
     /**
      * Update a webhook destination
      * @returns The updated webhook destination

package/lib/types/utils.d.ts

@@ -1,3 +1,5 @@
+import { CreateFileRequest } from './models/files.js';
+export declare function createFileRequestBuilder(filePath: string): CreateFileRequest;
 /**
  * A utility function that recursively converts all keys in an object to camelCase.
  * @param obj The object to convert

package/lib/types/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "7.0.0-beta.2";
+export declare const SDK_VERSION = "7.0.0-beta.3";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nylas",
-  "version": "7.0.0-beta.2",
+  "version": "7.0.0-beta.3",
   "description": "A NodeJS wrapper for the Nylas REST API for email, contacts, and calendar.",
   "main": "lib/cjs/nylas.js",
   "types": "lib/types/nylas.d.ts",
@@ -40,15 +40,16 @@
   "dependencies": {
     "change-case": "^4.1.2",
     "eslint-plugin-import": "^2.28.1",
+    "form-data": "^4.0.0",
+    "mime-types": "^2.1.35",
     "node-fetch": "^2.6.12",
-    "sha256": "^0.2.0",
     "uuid": "^8.3.2"
   },
   "devDependencies": {
     "@babel/core": "^7.3.3",
     "@types/jest": "^29.5.2",
+    "@types/mime-types": "^2.1.2",
     "@types/node-fetch": "^2.6.4",
-    "@types/sha256": "^0.2.0",
     "@types/uuid": "^8.3.4",
     "@typescript-eslint/eslint-plugin": "^2.25.0",
     "@typescript-eslint/parser": "^2.25.0",
@@ -56,6 +57,7 @@
     "eslint-config-prettier": "^4.0.0",
     "eslint-plugin-custom-rules": "^0.0.0",
     "eslint-plugin-prettier": "^3.0.1",
+    "eslint-plugin-import": "^2.28.1",
     "jest": "^29.6.1",
     "prettier": "^1.19.1",
     "ts-jest": "^29.1.1",