Interface ICampaignProbeControllerApiAsync

Represents a collection of functions to interact with the API endpoints

Inherited Members

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface ICampaignProbeControllerApiAsync : IApiAccessor

Methods

View Source

CreateCampaignProbeAsync(CreateCampaignProbeOptions, int, CancellationToken)

Create campaign probe

Declaration

Task<CampaignProbeDto> CreateCampaignProbeAsync(CreateCampaignProbeOptions createCampaignProbeOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<CampaignProbeDto>	Task of CampaignProbeDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateCampaignProbeWithHttpInfoAsync(CreateCampaignProbeOptions, int, CancellationToken)

Create campaign probe

Declaration

Task<ApiResponse<CampaignProbeDto>> CreateCampaignProbeWithHttpInfoAsync(CreateCampaignProbeOptions createCampaignProbeOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteCampaignProbeAsync(Guid, int, CancellationToken)

Delete campaign probe

Declaration

Task DeleteCampaignProbeAsync(Guid probeId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	probeId
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

DeleteCampaignProbeWithHttpInfoAsync(Guid, int, CancellationToken)

Delete campaign probe

Declaration

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

Parameters

Type	Name	Description
Guid	probeId
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

GetCampaignProbeAsync(Guid, int, CancellationToken)

Get campaign probe

Declaration

Task<CampaignProbeDto> GetCampaignProbeAsync(Guid probeId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<CampaignProbeDto>	Task of CampaignProbeDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get campaign probe insights

Declaration

Task<CampaignProbeInsightsDto> GetCampaignProbeInsightsAsync(Guid probeId, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	probeId
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<CampaignProbeInsightsDto>	Task of CampaignProbeInsightsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get campaign probe insights

Declaration

Task<ApiResponse<CampaignProbeInsightsDto>> GetCampaignProbeInsightsWithHttpInfoAsync(Guid probeId, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	probeId
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<CampaignProbeInsightsDto>>	Task of ApiResponse (CampaignProbeInsightsDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

List campaign probe runs

Declaration

Task<List<CampaignProbeRunDto>> GetCampaignProbeRunsAsync(Guid probeId, DateTime? since = null, DateTime? before = null, string status = null, int? limit = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	probeId
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<CampaignProbeRunDto>>	Task of List<CampaignProbeRunDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

List campaign probe runs

Declaration

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

Parameters

Type	Name	Description
Guid	probeId
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<CampaignProbeRunDto>>>	Task of ApiResponse (List<CampaignProbeRunDto>)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get campaign probe trend series

Declaration

Task<CampaignProbeSeriesDto> GetCampaignProbeSeriesAsync(Guid probeId, DateTime? since = null, DateTime? before = null, string bucket = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	probeId
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<CampaignProbeSeriesDto>	Task of CampaignProbeSeriesDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get campaign probe trend series

Declaration

Task<ApiResponse<CampaignProbeSeriesDto>> GetCampaignProbeSeriesWithHttpInfoAsync(Guid probeId, DateTime? since = null, DateTime? before = null, string bucket = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	probeId
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<CampaignProbeSeriesDto>>	Task of ApiResponse (CampaignProbeSeriesDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetCampaignProbeWithHttpInfoAsync(Guid, int, CancellationToken)

Get campaign probe

Declaration

Task<ApiResponse<CampaignProbeDto>> GetCampaignProbeWithHttpInfoAsync(Guid probeId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetCampaignProbesAsync(int, CancellationToken)

List campaign probes

Declaration

Task<List<CampaignProbeDto>> GetCampaignProbesAsync(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<CampaignProbeDto>>	Task of List<CampaignProbeDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetCampaignProbesWithHttpInfoAsync(int, CancellationToken)

List campaign probes

Declaration

Task<ApiResponse<List<CampaignProbeDto>>> GetCampaignProbesWithHttpInfoAsync(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<CampaignProbeDto>>>	Task of ApiResponse (List<CampaignProbeDto>)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

RunCampaignProbeNowAsync(Guid, CreateCampaignProbeRunOptions, int, CancellationToken)

Run campaign probe now

Declaration

Task<CampaignProbeRunNowResult> RunCampaignProbeNowAsync(Guid probeId, CreateCampaignProbeRunOptions createCampaignProbeRunOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<CampaignProbeRunNowResult>	Task of CampaignProbeRunNowResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

RunCampaignProbeNowWithHttpInfoAsync(Guid, CreateCampaignProbeRunOptions, int, CancellationToken)

Run campaign probe now

Declaration

Task<ApiResponse<CampaignProbeRunNowResult>> RunCampaignProbeNowWithHttpInfoAsync(Guid probeId, CreateCampaignProbeRunOptions createCampaignProbeRunOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

RunDueCampaignProbesAsync(int?, int, CancellationToken)

Run due campaign probes for user

Declaration

Task<CampaignProbeRunDueResult> RunDueCampaignProbesAsync(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<CampaignProbeRunDueResult>	Task of CampaignProbeRunDueResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

RunDueCampaignProbesWithHttpInfoAsync(int?, int, CancellationToken)

Run due campaign probes for user

Declaration

Task<ApiResponse<CampaignProbeRunDueResult>> RunDueCampaignProbesWithHttpInfoAsync(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<CampaignProbeRunDueResult>>	Task of ApiResponse (CampaignProbeRunDueResult)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateCampaignProbeAsync(Guid, UpdateCampaignProbeOptions, int, CancellationToken)

Update campaign probe

Declaration

Task<CampaignProbeDto> UpdateCampaignProbeAsync(Guid probeId, UpdateCampaignProbeOptions updateCampaignProbeOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<CampaignProbeDto>	Task of CampaignProbeDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateCampaignProbeWithHttpInfoAsync(Guid, UpdateCampaignProbeOptions, int, CancellationToken)

Update campaign probe

Declaration

Task<ApiResponse<CampaignProbeDto>> UpdateCampaignProbeWithHttpInfoAsync(Guid probeId, UpdateCampaignProbeOptions updateCampaignProbeOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call