Interface IDomainMonitorControllerApiAsync

Represents a collection of functions to interact with the API endpoints

Inherited Members

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface IDomainMonitorControllerApiAsync : IApiAccessor

Methods

View Source

CreateDomainMonitorAlertSinkAsync(Guid, CreateDomainMonitorAlertSinkOptions, int, CancellationToken)

Create alert sink for monitor

Declaration

Task<DomainMonitorAlertSinkDto> CreateDomainMonitorAlertSinkAsync(Guid monitorId, CreateDomainMonitorAlertSinkOptions createDomainMonitorAlertSinkOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	monitorId
CreateDomainMonitorAlertSinkOptions	createDomainMonitorAlertSinkOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<DomainMonitorAlertSinkDto>	Task of DomainMonitorAlertSinkDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateDomainMonitorAlertSinkWithHttpInfoAsync(Guid, CreateDomainMonitorAlertSinkOptions, int, CancellationToken)

Create alert sink for monitor

Declaration

Task<ApiResponse<DomainMonitorAlertSinkDto>> CreateDomainMonitorAlertSinkWithHttpInfoAsync(Guid monitorId, CreateDomainMonitorAlertSinkOptions createDomainMonitorAlertSinkOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	monitorId
CreateDomainMonitorAlertSinkOptions	createDomainMonitorAlertSinkOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<DomainMonitorAlertSinkDto>>	Task of ApiResponse (DomainMonitorAlertSinkDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateDomainMonitorAsync(CreateDomainMonitorOptions, int, CancellationToken)

Create domain monitor

Declaration

Task<DomainMonitorDto> CreateDomainMonitorAsync(CreateDomainMonitorOptions createDomainMonitorOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateDomainMonitorOptions	createDomainMonitorOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<DomainMonitorDto>	Task of DomainMonitorDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateDomainMonitorWithHttpInfoAsync(CreateDomainMonitorOptions, int, CancellationToken)

Create domain monitor

Declaration

Task<ApiResponse<DomainMonitorDto>> CreateDomainMonitorWithHttpInfoAsync(CreateDomainMonitorOptions createDomainMonitorOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateDomainMonitorOptions	createDomainMonitorOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<DomainMonitorDto>>	Task of ApiResponse (DomainMonitorDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteDomainMonitorAlertSinkAsync(Guid, Guid, int, CancellationToken)

Delete monitor alert sink

Declaration

Task DeleteDomainMonitorAlertSinkAsync(Guid monitorId, Guid sinkId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	monitorId
Guid	sinkId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteDomainMonitorAlertSinkWithHttpInfoAsync(Guid, Guid, int, CancellationToken)

Delete monitor alert sink

Declaration

Task<ApiResponse<object>> DeleteDomainMonitorAlertSinkWithHttpInfoAsync(Guid monitorId, Guid sinkId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	monitorId
Guid	sinkId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<object>>	Task of ApiResponse

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteDomainMonitorAsync(Guid, int, CancellationToken)

Delete domain monitor

Declaration

Task DeleteDomainMonitorAsync(Guid monitorId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	monitorId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteDomainMonitorWithHttpInfoAsync(Guid, int, CancellationToken)

Delete domain monitor

Declaration

Task<ApiResponse<object>> DeleteDomainMonitorWithHttpInfoAsync(Guid monitorId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	monitorId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<object>>	Task of ApiResponse

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDomainMonitorAlertSinksAsync(Guid, int, CancellationToken)

List alert sinks for monitor

Declaration

Task<List<DomainMonitorAlertSinkDto>> GetDomainMonitorAlertSinksAsync(Guid monitorId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	monitorId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<List<DomainMonitorAlertSinkDto>>	Task of List<DomainMonitorAlertSinkDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDomainMonitorAlertSinksWithHttpInfoAsync(Guid, int, CancellationToken)

List alert sinks for monitor

Declaration

Task<ApiResponse<List<DomainMonitorAlertSinkDto>>> GetDomainMonitorAlertSinksWithHttpInfoAsync(Guid monitorId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	monitorId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<List<DomainMonitorAlertSinkDto>>>	Task of ApiResponse (List<DomainMonitorAlertSinkDto>)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDomainMonitorAsync(Guid, int, CancellationToken)

Get domain monitor

Declaration

Task<DomainMonitorDto> GetDomainMonitorAsync(Guid monitorId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	monitorId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<DomainMonitorDto>	Task of DomainMonitorDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDomainMonitorInsightsAsync(Guid, DateTime?, DateTime?, int, CancellationToken)

Get monitor insights

Declaration

Task<DomainMonitorInsightsDto> GetDomainMonitorInsightsAsync(Guid monitorId, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	monitorId
DateTime?	since	(optional)
DateTime?	before	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<DomainMonitorInsightsDto>	Task of DomainMonitorInsightsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDomainMonitorInsightsWithHttpInfoAsync(Guid, DateTime?, DateTime?, int, CancellationToken)

Get monitor insights

Declaration

Task<ApiResponse<DomainMonitorInsightsDto>> GetDomainMonitorInsightsWithHttpInfoAsync(Guid monitorId, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	monitorId
DateTime?	since	(optional)
DateTime?	before	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<DomainMonitorInsightsDto>>	Task of ApiResponse (DomainMonitorInsightsDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDomainMonitorRunsAsync(Guid, DateTime?, DateTime?, string, int?, int, CancellationToken)

List monitor runs

Declaration

Task<List<DomainMonitorRunDto>> GetDomainMonitorRunsAsync(Guid monitorId, DateTime? since = null, DateTime? before = null, string status = null, int? limit = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	monitorId
DateTime?	since	(optional)
DateTime?	before	(optional)
string	status	(optional)
int?	limit	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<List<DomainMonitorRunDto>>	Task of List<DomainMonitorRunDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDomainMonitorRunsWithHttpInfoAsync(Guid, DateTime?, DateTime?, string, int?, int, CancellationToken)

List monitor runs

Declaration

Task<ApiResponse<List<DomainMonitorRunDto>>> GetDomainMonitorRunsWithHttpInfoAsync(Guid monitorId, DateTime? since = null, DateTime? before = null, string status = null, int? limit = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	monitorId
DateTime?	since	(optional)
DateTime?	before	(optional)
string	status	(optional)
int?	limit	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<List<DomainMonitorRunDto>>>	Task of ApiResponse (List<DomainMonitorRunDto>)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDomainMonitorSeriesAsync(Guid, DateTime?, DateTime?, string, int, CancellationToken)

Get monitor trend series

Declaration

Task<DomainMonitorSeriesDto> GetDomainMonitorSeriesAsync(Guid monitorId, DateTime? since = null, DateTime? before = null, string bucket = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	monitorId
DateTime?	since	(optional)
DateTime?	before	(optional)
string	bucket	(optional, default to DAY)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<DomainMonitorSeriesDto>	Task of DomainMonitorSeriesDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDomainMonitorSeriesWithHttpInfoAsync(Guid, DateTime?, DateTime?, string, int, CancellationToken)

Get monitor trend series

Declaration

Task<ApiResponse<DomainMonitorSeriesDto>> GetDomainMonitorSeriesWithHttpInfoAsync(Guid monitorId, DateTime? since = null, DateTime? before = null, string bucket = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	monitorId
DateTime?	since	(optional)
DateTime?	before	(optional)
string	bucket	(optional, default to DAY)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<DomainMonitorSeriesDto>>	Task of ApiResponse (DomainMonitorSeriesDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDomainMonitorWithHttpInfoAsync(Guid, int, CancellationToken)

Get domain monitor

Declaration

Task<ApiResponse<DomainMonitorDto>> GetDomainMonitorWithHttpInfoAsync(Guid monitorId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	monitorId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<DomainMonitorDto>>	Task of ApiResponse (DomainMonitorDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDomainMonitorsAsync(int, CancellationToken)

List domain monitors

Declaration

Task<List<DomainMonitorDto>> GetDomainMonitorsAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<List<DomainMonitorDto>>	Task of List<DomainMonitorDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDomainMonitorsWithHttpInfoAsync(int, CancellationToken)

List domain monitors

Declaration

Task<ApiResponse<List<DomainMonitorDto>>> GetDomainMonitorsWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<List<DomainMonitorDto>>>	Task of ApiResponse (List<DomainMonitorDto>)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

RunDomainMonitorNowAsync(Guid, int, CancellationToken)

Run monitor now

Declaration

Task<DomainMonitorRunNowResult> RunDomainMonitorNowAsync(Guid monitorId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	monitorId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<DomainMonitorRunNowResult>	Task of DomainMonitorRunNowResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

RunDomainMonitorNowWithHttpInfoAsync(Guid, int, CancellationToken)

Run monitor now

Declaration

Task<ApiResponse<DomainMonitorRunNowResult>> RunDomainMonitorNowWithHttpInfoAsync(Guid monitorId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	monitorId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<DomainMonitorRunNowResult>>	Task of ApiResponse (DomainMonitorRunNowResult)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

RunDueDomainMonitorsAsync(int?, int, CancellationToken)

Run due monitors for user

Declaration

Task<DomainMonitorRunDueResult> RunDueDomainMonitorsAsync(int? maxRuns = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	maxRuns	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<DomainMonitorRunDueResult>	Task of DomainMonitorRunDueResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

RunDueDomainMonitorsWithHttpInfoAsync(int?, int, CancellationToken)

Run due monitors for user

Declaration

Task<ApiResponse<DomainMonitorRunDueResult>> RunDueDomainMonitorsWithHttpInfoAsync(int? maxRuns = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	maxRuns	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<DomainMonitorRunDueResult>>	Task of ApiResponse (DomainMonitorRunDueResult)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateDomainMonitorAsync(Guid, UpdateDomainMonitorOptions, int, CancellationToken)

Update domain monitor

Declaration

Task<DomainMonitorDto> UpdateDomainMonitorAsync(Guid monitorId, UpdateDomainMonitorOptions updateDomainMonitorOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	monitorId
UpdateDomainMonitorOptions	updateDomainMonitorOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<DomainMonitorDto>	Task of DomainMonitorDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateDomainMonitorWithHttpInfoAsync(Guid, UpdateDomainMonitorOptions, int, CancellationToken)

Update domain monitor

Declaration

Task<ApiResponse<DomainMonitorDto>> UpdateDomainMonitorWithHttpInfoAsync(Guid monitorId, UpdateDomainMonitorOptions updateDomainMonitorOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	monitorId
UpdateDomainMonitorOptions	updateDomainMonitorOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<DomainMonitorDto>>	Task of ApiResponse (DomainMonitorDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call