Interface IContactListCollectionResource

Namespace

Mailtrap.ContactLists

Assembly

Mailtrap.Abstractions.dll

Represents the contact list collection resource.

public interface IContactListCollectionResource : IRestResource

Inherited Members

IRestResource.ResourceUri

Methods

Create(ContactListRequest, CancellationToken)

Creates a new contact list with details specified by request.

Task<ContactList> Create(ContactListRequest request, CancellationToken cancellationToken = default)

Parameters

request ContactListRequest

The request containing contact list details for creation.

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<ContactList>

Created contact list details.

GetAll(ContactListListFilter, CancellationToken)

Gets collection of contact list details matching the specified filter.

Task<IList<ContactList>> GetAll(ContactListListFilter filter, CancellationToken cancellationToken = default)

Parameters

filter ContactListListFilter

Filter to apply when fetching contact lists.
When Search is specified, only contact lists whose name starts with the provided value (case-insensitive prefix match) are returned.

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<IList<ContactList>>

A collection of contact list details.

GetAll(CancellationToken)

Gets collection of contact list details.

Task<IList<ContactList>> GetAll(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<IList<ContactList>>

A collection of contact list details.