nylas/com.nylas.resources/NylasLists

NylasLists

public final class NylasLists extends Resource<NylasList>

Nylas Lists API

The Nylas Lists API allows you to create and manage typed collections of domains, TLDs, or email addresses. Lists are referenced by rule conditions via the RuleConditionOperator.IN_LIST operator.

Parameters

client

The configured Nylas API client

Constructors

NylasLists

public NylasLists NylasLists(NylasClient client)

Functions

addItems

@JvmOverloads()

public final Response<NylasList> addItems(String listId, ListItemsRequest requestBody)

@JvmOverloads()

public final Response<NylasList> addItems(String listId, ListItemsRequest requestBody, RequestOverrides overrides)

Add items to a Nylas list. Duplicate additions are silently ignored. Max 1000 items per request.

create

@JvmOverloads()

public final Response<NylasList> create(CreateNylasListRequest requestBody)

@JvmOverloads()

public final Response<NylasList> create(CreateNylasListRequest requestBody, RequestOverrides overrides)

Create a Nylas list.

destroy

@JvmOverloads()

public final DeleteResponse destroy(String listId)

@JvmOverloads()

public final DeleteResponse destroy(String listId, RequestOverrides overrides)

Delete a Nylas list. Cascades to all items in the list.

find

@JvmOverloads()

public final Response<NylasList> find(String listId)

@JvmOverloads()

public final Response<NylasList> find(String listId, RequestOverrides overrides)

Return a Nylas list.

list

@JvmOverloads()

public final ListResponse<NylasList> list()

@JvmOverloads()

public final ListResponse<NylasList> list(ListNylasListsQueryParams queryParams)

@JvmOverloads()

public final ListResponse<NylasList> list(ListNylasListsQueryParams queryParams, RequestOverrides overrides)

Return all lists for your application.

listItems

@JvmOverloads()

public final ListResponse<NylasListItem> listItems(String listId)

@JvmOverloads()

public final ListResponse<NylasListItem> listItems(String listId, ListNylasListItemsQueryParams queryParams)

@JvmOverloads()

public final ListResponse<NylasListItem> listItems(String listId, ListNylasListItemsQueryParams queryParams, RequestOverrides overrides)

Return all items in a Nylas list.

removeItems

@JvmOverloads()

public final Response<NylasList> removeItems(String listId, ListItemsRequest requestBody)

@JvmOverloads()

public final Response<NylasList> removeItems(String listId, ListItemsRequest requestBody, RequestOverrides overrides)

Remove items from a Nylas list. Values not in the list are silently ignored. Max 1000 items per request.

update

@JvmOverloads()

public final Response<NylasList> update(String listId, UpdateNylasListRequest requestBody)

@JvmOverloads()

public final Response<NylasList> update(String listId, UpdateNylasListRequest requestBody, RequestOverrides overrides)

Update a Nylas list. Only UpdateNylasListRequest.name and UpdateNylasListRequest.description can be changed — the list type is immutable after creation.