Interface IProjectResource

Namespace

Mailtrap.Projects

Assembly

Mailtrap.Abstractions.dll

Represents project resource.

public interface IProjectResource : IRestResource

Inherited Members

IRestResource.ResourceUri

Methods

Delete(CancellationToken)

Deletes a project, represented by the current resource instance, with all its inboxes.

Task<DeleteProjectResponse> Delete(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<DeleteProjectResponse>

Deleted project details.

Remarks

All inboxes, associated with the project, will be deleted as well.

After deletion of the project, 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 and inboxes of the project, represented by the current resource instance.

Task<Project> GetDetails(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<Project>

Requested project details.

Update(UpdateProjectRequest, CancellationToken)

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

Task<Project> Update(UpdateProjectRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateProjectRequest

Project details for update.

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<Project>

Updated project details.