nylas
Version:
A NodeJS wrapper for the Nylas REST API for email, contacts, and calendar.
42 lines (41 loc) • 1.67 kB
TypeScript
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>>;
}