Interface IContactResource

Namespace

Mailtrap.Contacts

Assembly

Mailtrap.Abstractions.dll

Represents Contacts resource.

public interface IContactResource : IRestResource

Inherited Members

IRestResource.ResourceUri

Methods

Delete(CancellationToken)

Deletes a contact, represented by the current resource instance.

Task Delete(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task

Nothing is returned upon successful deletion.

Remarks

After deletion of the contact, represented by the current resource instance, it will be no longer available.
Thus any further operations on it will result in an error.

GetDetails(CancellationToken)

Gets details of the contact, represented by the current resource instance.

Task<ContactResponse> GetDetails(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<ContactResponse>

Requested contact details.

Update(UpdateContactRequest, CancellationToken)

Updates the contact, represented by the current resource instance, with details specified by request.

Task<UpdateContactResponse> Update(UpdateContactRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateContactRequest

Contact details for update.

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<UpdateContactResponse>

Updated contact details.