Class Drafts

Nylas Drafts API

The Nylas Drafts API allows you to list, find, update, delete, and send drafts on user accounts.

Hierarchy

Resource
- Drafts

Index

Constructors

Properties

Methods

_create _destroy _find _getRaw _getStream _list _update _updatePatch create destroy find list send update

Constructors

constructor

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

Properties

`Protected` apiClient

apiClient: default

Methods

`Protected` _create

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

`Protected` _destroy

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

`Protected` _find

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

`Protected` _getRaw

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

`Protected` _getStream

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

`Protected` _list

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

`Protected` _update

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

`Protected` _updatePatch

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

create

create(__namedParameters): Promise<NylasResponse<Draft>>
Return a Draft
Parameters
- __namedParameters: CreateDraftParams & Overrides
Returns Promise<NylasResponse<Draft>>
The draft
- Defined in src/resources/drafts.ts:112

destroy

destroy(__namedParameters): Promise<NylasBaseResponse>
Delete a Draft
Parameters
- __namedParameters: FindDraftParams & Overrides
Returns Promise<NylasBaseResponse>
The deleted draft
- Defined in src/resources/drafts.ts:183

find

find(__namedParameters): Promise<NylasResponse<Draft>>
Return a Draft
Parameters
- __namedParameters: FindDraftParams & Overrides
Returns Promise<NylasResponse<Draft>>
The draft
- Defined in src/resources/drafts.ts:97

list

list(__namedParameters): AsyncListResponse<NylasListResponse<Draft>>
Return all Drafts
Parameters
- __namedParameters: ListDraftsParams & Overrides
Returns AsyncListResponse<NylasListResponse<Draft>>
A list of drafts
- Defined in src/resources/drafts.ts:79

send

send(__namedParameters): Promise<NylasResponse<Message>>
Send a Draft
Parameters
- __namedParameters: FindDraftParams & Overrides
Returns Promise<NylasResponse<Message>>
The sent message
- Defined in src/resources/drafts.ts:198

update

update(__namedParameters): Promise<NylasResponse<Draft>>
Update a Draft
Parameters
- __namedParameters: UpdateDraftParams & Overrides
Returns Promise<NylasResponse<Draft>>
The updated draft
- Defined in src/resources/drafts.ts:147

Generated using TypeDoc