Interface IDeliverabilityTestControllerApiAsync

Represents a collection of functions to interact with the API endpoints

Inherited Members

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface IDeliverabilityTestControllerApiAsync : IApiAccessor

Methods

View Source

CancelDeliverabilitySimulationJobAsync(Guid, Guid, int, CancellationToken)

Cancel deliverability simulation job

Declaration

Task<DeliverabilitySimulationJobDto> CancelDeliverabilitySimulationJobAsync(Guid testId, Guid jobId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<DeliverabilitySimulationJobDto>	Task of DeliverabilitySimulationJobDto

Remarks

Cancel a running or paused simulation job.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CancelDeliverabilitySimulationJobWithHttpInfoAsync(Guid, Guid, int, CancellationToken)

Cancel deliverability simulation job

Declaration

Task<ApiResponse<DeliverabilitySimulationJobDto>> CancelDeliverabilitySimulationJobWithHttpInfoAsync(Guid testId, Guid jobId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Cancel a running or paused simulation job.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateDeliverabilitySimulationJobAsync(Guid, CreateDeliverabilitySimulationJobOptions, int, CancellationToken)

Create deliverability simulation job

Declaration

Task<DeliverabilitySimulationJobDto> CreateDeliverabilitySimulationJobAsync(Guid testId, CreateDeliverabilitySimulationJobOptions createDeliverabilitySimulationJobOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<DeliverabilitySimulationJobDto>	Task of DeliverabilitySimulationJobDto

Remarks

Create and start a simulation job for a running deliverability test. Only one active simulation job is allowed per user.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateDeliverabilitySimulationJobWithHttpInfoAsync(Guid, CreateDeliverabilitySimulationJobOptions, int, CancellationToken)

Create deliverability simulation job

Declaration

Task<ApiResponse<DeliverabilitySimulationJobDto>> CreateDeliverabilitySimulationJobWithHttpInfoAsync(Guid testId, CreateDeliverabilitySimulationJobOptions createDeliverabilitySimulationJobOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Create and start a simulation job for a running deliverability test. Only one active simulation job is allowed per user.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateDeliverabilityTestAsync(CreateDeliverabilityTestOptions, int, CancellationToken)

Create deliverability/load test

Declaration

Task<DeliverabilityTestDto> CreateDeliverabilityTestAsync(CreateDeliverabilityTestOptions createDeliverabilityTestOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<DeliverabilityTestDto>	Task of DeliverabilityTestDto

Remarks

Create a deliverability test for inboxes or phone numbers using ALL, PATTERN, or EXPLICIT selector scope.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateDeliverabilityTestWithHttpInfoAsync(CreateDeliverabilityTestOptions, int, CancellationToken)

Create deliverability/load test

Declaration

Task<ApiResponse<DeliverabilityTestDto>> CreateDeliverabilityTestWithHttpInfoAsync(CreateDeliverabilityTestOptions createDeliverabilityTestOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Create a deliverability test for inboxes or phone numbers using ALL, PATTERN, or EXPLICIT selector scope.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteDeliverabilityTestAsync(Guid, int, CancellationToken)

Delete deliverability/load test

Declaration

Task<DeleteResult> DeleteDeliverabilityTestAsync(Guid testId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<DeleteResult>	Task of DeleteResult

Remarks

Delete test and all persisted entity-level results.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteDeliverabilityTestWithHttpInfoAsync(Guid, int, CancellationToken)

Delete deliverability/load test

Declaration

Task<ApiResponse<DeleteResult>> DeleteDeliverabilityTestWithHttpInfoAsync(Guid testId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Delete test and all persisted entity-level results.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DuplicateDeliverabilityTestAsync(Guid, int, CancellationToken)

Duplicate deliverability/load test

Declaration

Task<DeliverabilityTestDto> DuplicateDeliverabilityTestAsync(Guid testId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<DeliverabilityTestDto>	Task of DeliverabilityTestDto

Remarks

Create a fresh deliverability test using an existing test configuration, including selector scope, exclusions, and expectations.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DuplicateDeliverabilityTestWithHttpInfoAsync(Guid, int, CancellationToken)

Duplicate deliverability/load test

Declaration

Task<ApiResponse<DeliverabilityTestDto>> DuplicateDeliverabilityTestWithHttpInfoAsync(Guid testId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Create a fresh deliverability test using an existing test configuration, including selector scope, exclusions, and expectations.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

ExportDeliverabilityTestReportAsync(Guid, int, CancellationToken)

Export deliverability/load test report as PDF

Declaration

Task ExportDeliverabilityTestReportAsync(Guid testId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task	Task of void

Remarks

Export a PDF report for a terminal deliverability test (COMPLETE, FAILED, or STOPPED), including configuration, summary outcomes, and detailed entity-level results.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

ExportDeliverabilityTestReportWithHttpInfoAsync(Guid, int, CancellationToken)

Export deliverability/load test report as PDF

Declaration

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

Parameters

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

Returns

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

Remarks

Export a PDF report for a terminal deliverability test (COMPLETE, FAILED, or STOPPED), including configuration, summary outcomes, and detailed entity-level results.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

ExportDeliverabilityTestResultsAsync(Guid, bool?, int, CancellationToken)

Export deliverability/load test entity results as CSV

Declaration

Task ExportDeliverabilityTestResultsAsync(Guid testId, bool? matched = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task	Task of void

Remarks

Export per-entity deliverability results including expectation-level pass/fail counts. The latest status is evaluated with the same polling safeguards before export.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

ExportDeliverabilityTestResultsWithHttpInfoAsync(Guid, bool?, int, CancellationToken)

Export deliverability/load test entity results as CSV

Declaration

Task<ApiResponse<object>> ExportDeliverabilityTestResultsWithHttpInfoAsync(Guid testId, bool? matched = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Export per-entity deliverability results including expectation-level pass/fail counts. The latest status is evaluated with the same polling safeguards before export.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDeliverabilityAnalyticsSeriesAsync(DateTime?, DateTime?, string, string, int?, int, CancellationToken)

Get deliverability analytics time series

Declaration

Task<DeliverabilityAnalyticsSeriesDto> GetDeliverabilityAnalyticsSeriesAsync(DateTime? since = null, DateTime? before = null, string scope = null, string bucket = null, int? runLimit = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<DeliverabilityAnalyticsSeriesDto>	Task of DeliverabilityAnalyticsSeriesDto

Remarks

Compare deliverability runs over a time range with bucketed chart metrics and run-level rows for table views.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDeliverabilityAnalyticsSeriesWithHttpInfoAsync(DateTime?, DateTime?, string, string, int?, int, CancellationToken)

Get deliverability analytics time series

Declaration

Task<ApiResponse<DeliverabilityAnalyticsSeriesDto>> GetDeliverabilityAnalyticsSeriesWithHttpInfoAsync(DateTime? since = null, DateTime? before = null, string scope = null, string bucket = null, int? runLimit = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Compare deliverability runs over a time range with bucketed chart metrics and run-level rows for table views.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDeliverabilityFailureHotspotsAsync(DateTime?, DateTime?, string, int?, int, CancellationToken)

Get deliverability failure hotspots

Declaration

Task<DeliverabilityFailureHotspotsDto> GetDeliverabilityFailureHotspotsAsync(DateTime? since = null, DateTime? before = null, string scope = null, int? limit = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<DeliverabilityFailureHotspotsDto>	Task of DeliverabilityFailureHotspotsDto

Remarks

Find commonly failing entities and phone country/variant dimensions across deliverability runs in a time range.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDeliverabilityFailureHotspotsWithHttpInfoAsync(DateTime?, DateTime?, string, int?, int, CancellationToken)

Get deliverability failure hotspots

Declaration

Task<ApiResponse<DeliverabilityFailureHotspotsDto>> GetDeliverabilityFailureHotspotsWithHttpInfoAsync(DateTime? since = null, DateTime? before = null, string scope = null, int? limit = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Find commonly failing entities and phone country/variant dimensions across deliverability runs in a time range.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDeliverabilitySimulationJobAsync(Guid, Guid, int, CancellationToken)

Get deliverability simulation job

Declaration

Task<DeliverabilitySimulationJobDto> GetDeliverabilitySimulationJobAsync(Guid testId, Guid jobId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<DeliverabilitySimulationJobDto>	Task of DeliverabilitySimulationJobDto

Remarks

Get simulation job status and progress counters.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDeliverabilitySimulationJobEventsAsync(Guid, Guid, int?, int?, string, int, CancellationToken)

Get deliverability simulation job events

Declaration

Task<DeliverabilitySimulationJobEventPageDto> GetDeliverabilitySimulationJobEventsAsync(Guid testId, Guid jobId, int? page = null, int? size = null, string sort = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	testId
Guid	jobId
int?	page	(optional, default to 0)
int?	size	(optional, default to 20)
string	sort	(optional, default to DESC)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<DeliverabilitySimulationJobEventPageDto>	Task of DeliverabilitySimulationJobEventPageDto

Remarks

Get paged simulation events including send successes and failures.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDeliverabilitySimulationJobEventsWithHttpInfoAsync(Guid, Guid, int?, int?, string, int, CancellationToken)

Get deliverability simulation job events

Declaration

Task<ApiResponse<DeliverabilitySimulationJobEventPageDto>> GetDeliverabilitySimulationJobEventsWithHttpInfoAsync(Guid testId, Guid jobId, int? page = null, int? size = null, string sort = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	testId
Guid	jobId
int?	page	(optional, default to 0)
int?	size	(optional, default to 20)
string	sort	(optional, default to DESC)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Remarks

Get paged simulation events including send successes and failures.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDeliverabilitySimulationJobWithHttpInfoAsync(Guid, Guid, int, CancellationToken)

Get deliverability simulation job

Declaration

Task<ApiResponse<DeliverabilitySimulationJobDto>> GetDeliverabilitySimulationJobWithHttpInfoAsync(Guid testId, Guid jobId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Get simulation job status and progress counters.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDeliverabilityTestAsync(Guid, int, CancellationToken)

Get deliverability/load test

Declaration

Task<DeliverabilityTestDto> GetDeliverabilityTestAsync(Guid testId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<DeliverabilityTestDto>	Task of DeliverabilityTestDto

Remarks

Get deliverability test configuration and latest progress counters.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDeliverabilityTestResultsAsync(Guid, bool?, int?, int?, string, int, CancellationToken)

Get deliverability/load test entity results

Declaration

Task<DeliverabilityEntityResultPageDto> GetDeliverabilityTestResultsAsync(Guid testId, bool? matched = null, int? page = null, int? size = null, string sort = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	testId
bool?	matched	(optional)
int?	page	(optional, default to 0)
int?	size	(optional, default to 20)
string	sort	(optional, default to ASC)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<DeliverabilityEntityResultPageDto>	Task of DeliverabilityEntityResultPageDto

Remarks

Get paged per-entity expectation results with optional matched/unmatched filtering.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDeliverabilityTestResultsWithHttpInfoAsync(Guid, bool?, int?, int?, string, int, CancellationToken)

Get deliverability/load test entity results

Declaration

Task<ApiResponse<DeliverabilityEntityResultPageDto>> GetDeliverabilityTestResultsWithHttpInfoAsync(Guid testId, bool? matched = null, int? page = null, int? size = null, string sort = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	testId
bool?	matched	(optional)
int?	page	(optional, default to 0)
int?	size	(optional, default to 20)
string	sort	(optional, default to ASC)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Remarks

Get paged per-entity expectation results with optional matched/unmatched filtering.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDeliverabilityTestWithHttpInfoAsync(Guid, int, CancellationToken)

Get deliverability/load test

Declaration

Task<ApiResponse<DeliverabilityTestDto>> GetDeliverabilityTestWithHttpInfoAsync(Guid testId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Get deliverability test configuration and latest progress counters.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDeliverabilityTestsAsync(int?, int?, string, int, CancellationToken)

List deliverability/load tests

Declaration

Task<DeliverabilityTestPageDto> GetDeliverabilityTestsAsync(int? page = null, int? size = null, string sort = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Page index (optional, default to 0)
int?	size	Page size (optional, default to 20)
string	sort	Sort direction (optional, default to DESC)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<DeliverabilityTestPageDto>	Task of DeliverabilityTestPageDto

Remarks

List deliverability tests for the authenticated account.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDeliverabilityTestsWithHttpInfoAsync(int?, int?, string, int, CancellationToken)

List deliverability/load tests

Declaration

Task<ApiResponse<DeliverabilityTestPageDto>> GetDeliverabilityTestsWithHttpInfoAsync(int? page = null, int? size = null, string sort = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Page index (optional, default to 0)
int?	size	Page size (optional, default to 20)
string	sort	Sort direction (optional, default to DESC)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Remarks

List deliverability tests for the authenticated account.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetLatestDeliverabilitySimulationJobAsync(Guid, int, CancellationToken)

Get latest deliverability simulation job

Declaration

Task<DeliverabilitySimulationJobDto> GetLatestDeliverabilitySimulationJobAsync(Guid testId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<DeliverabilitySimulationJobDto>	Task of DeliverabilitySimulationJobDto

Remarks

Get the most recent simulation job for a deliverability test.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetLatestDeliverabilitySimulationJobWithHttpInfoAsync(Guid, int, CancellationToken)

Get latest deliverability simulation job

Declaration

Task<ApiResponse<DeliverabilitySimulationJobDto>> GetLatestDeliverabilitySimulationJobWithHttpInfoAsync(Guid testId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Get the most recent simulation job for a deliverability test.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

PauseDeliverabilitySimulationJobAsync(Guid, Guid, int, CancellationToken)

Pause deliverability simulation job

Declaration

Task<DeliverabilitySimulationJobDto> PauseDeliverabilitySimulationJobAsync(Guid testId, Guid jobId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<DeliverabilitySimulationJobDto>	Task of DeliverabilitySimulationJobDto

Remarks

Pause a running simulation job.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

PauseDeliverabilitySimulationJobWithHttpInfoAsync(Guid, Guid, int, CancellationToken)

Pause deliverability simulation job

Declaration

Task<ApiResponse<DeliverabilitySimulationJobDto>> PauseDeliverabilitySimulationJobWithHttpInfoAsync(Guid testId, Guid jobId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Pause a running simulation job.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

PauseDeliverabilityTestAsync(Guid, int, CancellationToken)

Pause deliverability/load test

Declaration

Task<DeliverabilityTestDto> PauseDeliverabilityTestAsync(Guid testId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<DeliverabilityTestDto>	Task of DeliverabilityTestDto

Remarks

Pause a RUNNING or SCHEDULED deliverability test.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

PauseDeliverabilityTestWithHttpInfoAsync(Guid, int, CancellationToken)

Pause deliverability/load test

Declaration

Task<ApiResponse<DeliverabilityTestDto>> PauseDeliverabilityTestWithHttpInfoAsync(Guid testId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Pause a RUNNING or SCHEDULED deliverability test.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

PollDeliverabilityTestStatusAsync(Guid, int, CancellationToken)

Poll deliverability/load test status

Declaration

Task<DeliverabilityPollStatusResultDto> PollDeliverabilityTestStatusAsync(Guid testId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<DeliverabilityPollStatusResultDto>	Task of DeliverabilityPollStatusResultDto

Remarks

Poll test progress. Evaluation is throttled with a 5-second cache window to protect backing data stores.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

PollDeliverabilityTestStatusWithHttpInfoAsync(Guid, int, CancellationToken)

Poll deliverability/load test status

Declaration

Task<ApiResponse<DeliverabilityPollStatusResultDto>> PollDeliverabilityTestStatusWithHttpInfoAsync(Guid testId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Poll test progress. Evaluation is throttled with a 5-second cache window to protect backing data stores.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

ResumeDeliverabilitySimulationJobAsync(Guid, Guid, int, CancellationToken)

Resume deliverability simulation job

Declaration

Task<DeliverabilitySimulationJobDto> ResumeDeliverabilitySimulationJobAsync(Guid testId, Guid jobId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<DeliverabilitySimulationJobDto>	Task of DeliverabilitySimulationJobDto

Remarks

Resume a paused simulation job.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

ResumeDeliverabilitySimulationJobWithHttpInfoAsync(Guid, Guid, int, CancellationToken)

Resume deliverability simulation job

Declaration

Task<ApiResponse<DeliverabilitySimulationJobDto>> ResumeDeliverabilitySimulationJobWithHttpInfoAsync(Guid testId, Guid jobId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Resume a paused simulation job.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

StartDeliverabilityTestAsync(Guid, int, CancellationToken)

Start or resume deliverability/load test

Declaration

Task<DeliverabilityTestDto> StartDeliverabilityTestAsync(Guid testId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<DeliverabilityTestDto>	Task of DeliverabilityTestDto

Remarks

Start a CREATED test or resume a PAUSED/SCHEDULED test.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

StartDeliverabilityTestWithHttpInfoAsync(Guid, int, CancellationToken)

Start or resume deliverability/load test

Declaration

Task<ApiResponse<DeliverabilityTestDto>> StartDeliverabilityTestWithHttpInfoAsync(Guid testId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Start a CREATED test or resume a PAUSED/SCHEDULED test.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

StopDeliverabilityTestAsync(Guid, int, CancellationToken)

Stop deliverability/load test

Declaration

Task<DeliverabilityTestDto> StopDeliverabilityTestAsync(Guid testId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<DeliverabilityTestDto>	Task of DeliverabilityTestDto

Remarks

Stop a deliverability test and mark it terminal.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

StopDeliverabilityTestWithHttpInfoAsync(Guid, int, CancellationToken)

Stop deliverability/load test

Declaration

Task<ApiResponse<DeliverabilityTestDto>> StopDeliverabilityTestWithHttpInfoAsync(Guid testId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Stop a deliverability test and mark it terminal.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateDeliverabilityTestAsync(Guid, UpdateDeliverabilityTestOptions, int, CancellationToken)

Update deliverability/load test

Declaration

Task<DeliverabilityTestDto> UpdateDeliverabilityTestAsync(Guid testId, UpdateDeliverabilityTestOptions updateDeliverabilityTestOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<DeliverabilityTestDto>	Task of DeliverabilityTestDto

Remarks

Update metadata, timeout, and expectations for a non-running non-terminal test.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateDeliverabilityTestWithHttpInfoAsync(Guid, UpdateDeliverabilityTestOptions, int, CancellationToken)

Update deliverability/load test

Declaration

Task<ApiResponse<DeliverabilityTestDto>> UpdateDeliverabilityTestWithHttpInfoAsync(Guid testId, UpdateDeliverabilityTestOptions updateDeliverabilityTestOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Update metadata, timeout, and expectations for a non-running non-terminal test.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call