Interface ICompanyInfoResource

Namespace

Mailtrap.SendingDomains

Assembly

Mailtrap.Abstractions.dll

Represents company info resource of a sending domain.

public interface ICompanyInfoResource : IRestResource

Inherited Members

IRestResource.ResourceUri

Methods

Create(CreateCompanyInfoRequest, CancellationToken)

Creates company info for the sending domain, represented by this resource instance.
Company info is required for domain compliance verification.

Task<CompanyInfo> Create(CreateCompanyInfoRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateCompanyInfoRequest

Request containing company info details.

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<CompanyInfo>

Created company info.

GetDetails(CancellationToken)

Gets company info associated with the sending domain, represented by this resource instance.

Task<CompanyInfo> GetDetails(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<CompanyInfo>

Company info of the sending domain.

Update(UpdateCompanyInfoRequest, CancellationToken)

Updates company info of the sending domain, represented by this resource instance.

Task<CompanyInfo> Update(UpdateCompanyInfoRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateCompanyInfoRequest

Request containing company info details to update. Only properties set on the request are sent.

cancellationToken CancellationToken

Token to control operation cancellation.

Returns

Task<CompanyInfo>

Updated company info.