Class AgentLists

Nylas Agent Account Lists API

Lists manage values that rules can reference using the in_list operator.

Index

Constructors

Properties

Methods

_create _destroy _find _getRaw _getStream _list _update _updatePatch addItems create destroy find list listItems removeItems update

Constructors

constructor

new AgentLists(apiClient: APIClient): AgentLists
Parameters
- apiClient: APIClient
  client The configured Nylas API client
Returns AgentLists
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<Uint8Array<ArrayBufferLike>>>
Parameters
- __namedParameters: FindParams<void>
Returns Promise<ReadableStream<Uint8Array<ArrayBufferLike>>>
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

addItems

addItems(
__namedParameters: AddAgentListItemsParams & Overrides,
): Promise<NylasResponse<AgentList>>
Add items to a list.
Parameters
- __namedParameters: AddAgentListItemsParams & Overrides
Returns Promise<NylasResponse<AgentList>>
The updated Agent Account list.
- Defined in src/resources/agentLists.ts:188

create

create(
__namedParameters: CreateAgentListParams & Overrides,
): Promise<NylasResponse<AgentList>>
Create a list.
Parameters
- __namedParameters: CreateAgentListParams & Overrides
Returns Promise<NylasResponse<AgentList>>
The created Agent Account list.
- Defined in src/resources/agentLists.ts:125

destroy

destroy(
__namedParameters: DestroyAgentListParams & Overrides,
): Promise<NylasBaseResponse>
Delete a list.
Parameters
- __namedParameters: DestroyAgentListParams & Overrides
Returns Promise<NylasBaseResponse>
The deletion response.
- Defined in src/resources/agentLists.ts:156

find

find(
__namedParameters: FindAgentListParams & Overrides,
): Promise<NylasResponse<AgentList>>
Return a list.
Parameters
- __namedParameters: FindAgentListParams & Overrides
Returns Promise<NylasResponse<AgentList>>
The Agent Account list.
- Defined in src/resources/agentLists.ts:111

list

list(
__namedParameters?: ListAgentListsParams & Overrides,
): AsyncListResponse<NylasListResponse<AgentList>>
Return all lists.
Parameters
- __namedParameters: ListAgentListsParams & Overrides = {}
Returns AsyncListResponse<NylasListResponse<AgentList>>
The list of Agent Account lists.
- Defined in src/resources/agentLists.ts:94

listItems

listItems(
__namedParameters: ListAgentListItemsParams & Overrides,
): AsyncListResponse<NylasListResponse<AgentListItem>>
Return items in a list.
Parameters
- __namedParameters: ListAgentListItemsParams & Overrides
Returns AsyncListResponse<NylasListResponse<AgentListItem>>
The list items.
- Defined in src/resources/agentLists.ts:170

removeItems

removeItems(
__namedParameters: RemoveAgentListItemsParams & Overrides,
): Promise<NylasResponse<AgentList>>
Remove items from a list.
Parameters
- __namedParameters: RemoveAgentListItemsParams & Overrides
Returns Promise<NylasResponse<AgentList>>
The updated Agent Account list.
- Defined in src/resources/agentLists.ts:204

update

update(
__namedParameters: UpdateAgentListParams & Overrides,
): Promise<NylasResponse<AgentList>>
Update a list.
Parameters
- __namedParameters: UpdateAgentListParams & Overrides
Returns Promise<NylasResponse<AgentList>>
The updated Agent Account list.
- Defined in src/resources/agentLists.ts:140