Class SmartCompose

A collection of Smart Compose related API endpoints.

These endpoints allow for the generation of message suggestions.

Index

Constructors

Properties

Methods

_create _destroy _find _getRaw _getStream _list _update _updatePatch composeMessage composeMessageReply

Constructors

constructor

new SmartCompose(apiClient: APIClient): SmartCompose
Parameters
- apiClient: APIClient
  client The configured Nylas API client
Returns SmartCompose
Inherited from Resource.constructor
- Defined in src/resources/resource.ts:50

Properties

`Protected`apiClient

apiClient: APIClient

Methods

`Protected`_create

_create<T>(params: PayloadParams<T>): Promise<NylasResponse<T>>
Type Parameters
- T
Parameters
- params: PayloadParams<T>
Returns Promise<NylasResponse<T>>
Inherited from Resource._create
- Defined in src/resources/resource.ts:170

`Protected`_destroy

_destroy<T>(__namedParameters: DestroyParams): Promise<T>
Type Parameters
- T
Parameters
- __namedParameters: DestroyParams
Returns Promise<T>
Inherited from Resource._destroy
- Defined in src/resources/resource.ts:184

`Protected`_find

_find<T>(__namedParameters: FindParams<T>): Promise<NylasResponse<T>>
Type Parameters
- T
Parameters
- __namedParameters: FindParams<T>
Returns Promise<NylasResponse<T>>
Inherited from Resource._find
- Defined in src/resources/resource.ts:144

`Protected`_getRaw

_getRaw(__namedParameters: FindParams<void>): Promise<Buffer<ArrayBufferLike>>
Parameters
- __namedParameters: FindParams<void>
Returns Promise<Buffer<ArrayBufferLike>>
Inherited from Resource._getRaw
- Defined in src/resources/resource.ts:199

`Protected`_getStream

_getStream(__namedParameters: FindParams<void>): Promise<ReadableStream>
Parameters
- __namedParameters: FindParams<void>
Returns Promise<ReadableStream>
Inherited from Resource._getStream
- Defined in src/resources/resource.ts:212

`Protected`_list

_list<T extends List<T>>(listParams: ListParams<T>): AsyncListResponse<T>
Type Parameters
- T extends List<T>
Parameters
- listParams: ListParams<T>
Returns AsyncListResponse<T>
Inherited from Resource._list
- Defined in src/resources/resource.ts:124

`Protected`_update

_update<T>(params: PayloadParams<T>): Promise<NylasResponse<T>>
Type Parameters
- T
Parameters
- params: PayloadParams<T>
Returns Promise<NylasResponse<T>>
Inherited from Resource._update
- Defined in src/resources/resource.ts:174

`Protected`_updatePatch

_updatePatch<T>(params: PayloadParams<T>): Promise<NylasResponse<T>>
Type Parameters
- T
Parameters
- params: PayloadParams<T>
Returns Promise<NylasResponse<T>>
Inherited from Resource._updatePatch
- Defined in src/resources/resource.ts:178

composeMessage

composeMessage(
__namedParameters: ComposeMessageParams & Overrides,
): Promise<NylasResponse<ComposeMessageResponse>>
Compose a message
Parameters
- __namedParameters: ComposeMessageParams & Overrides
Returns Promise<NylasResponse<ComposeMessageResponse>>
The generated message
- Defined in src/resources/smartCompose.ts:41

composeMessageReply

composeMessageReply(
__namedParameters: ComposeMessageReplyParams & Overrides,
): Promise<NylasResponse<ComposeMessageResponse>>
Compose a message reply
Parameters
- __namedParameters: ComposeMessageReplyParams & Overrides
Returns Promise<NylasResponse<ComposeMessageResponse>>
The generated message reply
- Defined in src/resources/smartCompose.ts:61