Class Threads

Nylas Threads API

The Nylas Threads API allows you to list, find, update, and delete threads on user accounts.

Index

Constructors

Properties

Methods

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

Constructors

constructor

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

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:196

`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:210

`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:163

`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:225

`Protected`_getStream

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

`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:143

`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:200

`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:204

destroy

destroy(
__namedParameters: DestroyThreadParams & Overrides,
): Promise<NylasBaseResponse>
Delete a Thread
Parameters
- __namedParameters: DestroyThreadParams & Overrides
Returns Promise<NylasBaseResponse>
The deleted thread
- Defined in src/resources/threads.ts:140

find

find(
__namedParameters: FindThreadParams & Overrides,
): Promise<NylasResponse<Thread>>
Return a Thread
Parameters
- __namedParameters: FindThreadParams & Overrides
Returns Promise<NylasResponse<Thread>>
The thread
- Defined in src/resources/threads.ts:100

list

list(
__namedParameters: ListThreadsParams & Overrides,
): AsyncListResponse<NylasListResponse<Thread>>
Return all Threads
Parameters
- __namedParameters: ListThreadsParams & Overrides
Returns AsyncListResponse<NylasListResponse<Thread>>
A list of threads
- Defined in src/resources/threads.ts:70

update

update(
__namedParameters: UpdateThreadParams & Overrides,
): Promise<NylasResponse<Thread>>
Update a Thread
Parameters
- __namedParameters: UpdateThreadParams & Overrides
Returns Promise<NylasResponse<Thread>>
The updated thread
- Defined in src/resources/threads.ts:120