Interface IDeliverabilityTestControllerApiSync

Represents a collection of functions to interact with the API endpoints

Inherited Members

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface IDeliverabilityTestControllerApiSync : IApiAccessor

Methods

View Source

CancelDeliverabilitySimulationJob(Guid, Guid, int)

Cancel deliverability simulation job

Declaration

DeliverabilitySimulationJobDto CancelDeliverabilitySimulationJob(Guid testId, Guid jobId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	testId
Guid	jobId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
DeliverabilitySimulationJobDto	DeliverabilitySimulationJobDto

Remarks

Cancel a running or paused simulation job.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CancelDeliverabilitySimulationJobWithHttpInfo(Guid, Guid, int)

Cancel deliverability simulation job

Declaration

ApiResponse<DeliverabilitySimulationJobDto> CancelDeliverabilitySimulationJobWithHttpInfo(Guid testId, Guid jobId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	testId
Guid	jobId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<DeliverabilitySimulationJobDto>	ApiResponse of DeliverabilitySimulationJobDto

Remarks

Cancel a running or paused simulation job.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateDeliverabilitySimulationJob(Guid, CreateDeliverabilitySimulationJobOptions, int)

Create deliverability simulation job

Declaration

DeliverabilitySimulationJobDto CreateDeliverabilitySimulationJob(Guid testId, CreateDeliverabilitySimulationJobOptions createDeliverabilitySimulationJobOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	testId
CreateDeliverabilitySimulationJobOptions	createDeliverabilitySimulationJobOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
DeliverabilitySimulationJobDto	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

CreateDeliverabilitySimulationJobWithHttpInfo(Guid, CreateDeliverabilitySimulationJobOptions, int)

Create deliverability simulation job

Declaration

ApiResponse<DeliverabilitySimulationJobDto> CreateDeliverabilitySimulationJobWithHttpInfo(Guid testId, CreateDeliverabilitySimulationJobOptions createDeliverabilitySimulationJobOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	testId
CreateDeliverabilitySimulationJobOptions	createDeliverabilitySimulationJobOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<DeliverabilitySimulationJobDto>	ApiResponse 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

CreateDeliverabilityTest(CreateDeliverabilityTestOptions, int)

Create deliverability/load test

Declaration

DeliverabilityTestDto CreateDeliverabilityTest(CreateDeliverabilityTestOptions createDeliverabilityTestOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CreateDeliverabilityTestOptions	createDeliverabilityTestOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
DeliverabilityTestDto	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

CreateDeliverabilityTestWithHttpInfo(CreateDeliverabilityTestOptions, int)

Create deliverability/load test

Declaration

ApiResponse<DeliverabilityTestDto> CreateDeliverabilityTestWithHttpInfo(CreateDeliverabilityTestOptions createDeliverabilityTestOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CreateDeliverabilityTestOptions	createDeliverabilityTestOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<DeliverabilityTestDto>	ApiResponse 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

DeleteDeliverabilityTest(Guid, int)

Delete deliverability/load test

Declaration

DeleteResult DeleteDeliverabilityTest(Guid testId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	testId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
DeleteResult	DeleteResult

Remarks

Delete test and all persisted entity-level results.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteDeliverabilityTestWithHttpInfo(Guid, int)

Delete deliverability/load test

Declaration

ApiResponse<DeleteResult> DeleteDeliverabilityTestWithHttpInfo(Guid testId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	testId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<DeleteResult>	ApiResponse of DeleteResult

Remarks

Delete test and all persisted entity-level results.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DuplicateDeliverabilityTest(Guid, int)

Duplicate deliverability/load test

Declaration

DeliverabilityTestDto DuplicateDeliverabilityTest(Guid testId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	testId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
DeliverabilityTestDto	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

DuplicateDeliverabilityTestWithHttpInfo(Guid, int)

Duplicate deliverability/load test

Declaration

ApiResponse<DeliverabilityTestDto> DuplicateDeliverabilityTestWithHttpInfo(Guid testId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	testId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<DeliverabilityTestDto>	ApiResponse 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

ExportDeliverabilityTestReport(Guid, int)

Export deliverability/load test report as PDF

Declaration

void ExportDeliverabilityTestReport(Guid testId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	testId
int	operationIndex	Index associated with the operation.

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

ExportDeliverabilityTestReportWithHttpInfo(Guid, int)

Export deliverability/load test report as PDF

Declaration

ApiResponse<object> ExportDeliverabilityTestReportWithHttpInfo(Guid testId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	testId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<object>	ApiResponse of Object(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

ExportDeliverabilityTestResults(Guid, bool?, int)

Export deliverability/load test entity results as CSV

Declaration

void ExportDeliverabilityTestResults(Guid testId, bool? matched = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	testId
bool?	matched	(optional)
int	operationIndex	Index associated with the operation.

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

ExportDeliverabilityTestResultsWithHttpInfo(Guid, bool?, int)

Export deliverability/load test entity results as CSV

Declaration

ApiResponse<object> ExportDeliverabilityTestResultsWithHttpInfo(Guid testId, bool? matched = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	testId
bool?	matched	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<object>	ApiResponse of Object(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

GetDeliverabilityAnalyticsSeries(DateTime?, DateTime?, string, string, int?, int)

Get deliverability analytics time series

Declaration

DeliverabilityAnalyticsSeriesDto GetDeliverabilityAnalyticsSeries(DateTime? since = null, DateTime? before = null, string scope = null, string bucket = null, int? runLimit = null, int operationIndex = 0)

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.

Returns

Type	Description
DeliverabilityAnalyticsSeriesDto	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

GetDeliverabilityAnalyticsSeriesWithHttpInfo(DateTime?, DateTime?, string, string, int?, int)

Get deliverability analytics time series

Declaration

ApiResponse<DeliverabilityAnalyticsSeriesDto> GetDeliverabilityAnalyticsSeriesWithHttpInfo(DateTime? since = null, DateTime? before = null, string scope = null, string bucket = null, int? runLimit = null, int operationIndex = 0)

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.

Returns

Type	Description
ApiResponse<DeliverabilityAnalyticsSeriesDto>	ApiResponse 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

GetDeliverabilityFailureHotspots(DateTime?, DateTime?, string, int?, int)

Get deliverability failure hotspots

Declaration

DeliverabilityFailureHotspotsDto GetDeliverabilityFailureHotspots(DateTime? since = null, DateTime? before = null, string scope = null, int? limit = null, int operationIndex = 0)

Parameters

Type	Name	Description
DateTime?	since	(optional)
DateTime?	before	(optional)
string	scope	(optional)
int?	limit	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
DeliverabilityFailureHotspotsDto	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

GetDeliverabilityFailureHotspotsWithHttpInfo(DateTime?, DateTime?, string, int?, int)

Get deliverability failure hotspots

Declaration

ApiResponse<DeliverabilityFailureHotspotsDto> GetDeliverabilityFailureHotspotsWithHttpInfo(DateTime? since = null, DateTime? before = null, string scope = null, int? limit = null, int operationIndex = 0)

Parameters

Type	Name	Description
DateTime?	since	(optional)
DateTime?	before	(optional)
string	scope	(optional)
int?	limit	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<DeliverabilityFailureHotspotsDto>	ApiResponse 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

GetDeliverabilitySimulationJob(Guid, Guid, int)

Get deliverability simulation job

Declaration

DeliverabilitySimulationJobDto GetDeliverabilitySimulationJob(Guid testId, Guid jobId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	testId
Guid	jobId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
DeliverabilitySimulationJobDto	DeliverabilitySimulationJobDto

Remarks

Get simulation job status and progress counters.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDeliverabilitySimulationJobEvents(Guid, Guid, int?, int?, string, int)

Get deliverability simulation job events

Declaration

DeliverabilitySimulationJobEventPageDto GetDeliverabilitySimulationJobEvents(Guid testId, Guid jobId, int? page = null, int? size = null, string sort = null, int operationIndex = 0)

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.

Returns

Type	Description
DeliverabilitySimulationJobEventPageDto	DeliverabilitySimulationJobEventPageDto

Remarks

Get paged simulation events including send successes and failures.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDeliverabilitySimulationJobEventsWithHttpInfo(Guid, Guid, int?, int?, string, int)

Get deliverability simulation job events

Declaration

ApiResponse<DeliverabilitySimulationJobEventPageDto> GetDeliverabilitySimulationJobEventsWithHttpInfo(Guid testId, Guid jobId, int? page = null, int? size = null, string sort = null, int operationIndex = 0)

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.

Returns

Type	Description
ApiResponse<DeliverabilitySimulationJobEventPageDto>	ApiResponse 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

GetDeliverabilitySimulationJobWithHttpInfo(Guid, Guid, int)

Get deliverability simulation job

Declaration

ApiResponse<DeliverabilitySimulationJobDto> GetDeliverabilitySimulationJobWithHttpInfo(Guid testId, Guid jobId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	testId
Guid	jobId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<DeliverabilitySimulationJobDto>	ApiResponse of DeliverabilitySimulationJobDto

Remarks

Get simulation job status and progress counters.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDeliverabilityTest(Guid, int)

Get deliverability/load test

Declaration

DeliverabilityTestDto GetDeliverabilityTest(Guid testId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	testId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
DeliverabilityTestDto	DeliverabilityTestDto

Remarks

Get deliverability test configuration and latest progress counters.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDeliverabilityTestResults(Guid, bool?, int?, int?, string, int)

Get deliverability/load test entity results

Declaration

DeliverabilityEntityResultPageDto GetDeliverabilityTestResults(Guid testId, bool? matched = null, int? page = null, int? size = null, string sort = null, int operationIndex = 0)

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.

Returns

Type	Description
DeliverabilityEntityResultPageDto	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

GetDeliverabilityTestResultsWithHttpInfo(Guid, bool?, int?, int?, string, int)

Get deliverability/load test entity results

Declaration

ApiResponse<DeliverabilityEntityResultPageDto> GetDeliverabilityTestResultsWithHttpInfo(Guid testId, bool? matched = null, int? page = null, int? size = null, string sort = null, int operationIndex = 0)

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.

Returns

Type	Description
ApiResponse<DeliverabilityEntityResultPageDto>	ApiResponse 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

GetDeliverabilityTestWithHttpInfo(Guid, int)

Get deliverability/load test

Declaration

ApiResponse<DeliverabilityTestDto> GetDeliverabilityTestWithHttpInfo(Guid testId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	testId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<DeliverabilityTestDto>	ApiResponse of DeliverabilityTestDto

Remarks

Get deliverability test configuration and latest progress counters.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDeliverabilityTests(int?, int?, string, int)

List deliverability/load tests

Declaration

DeliverabilityTestPageDto GetDeliverabilityTests(int? page = null, int? size = null, string sort = null, int operationIndex = 0)

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.

Returns

Type	Description
DeliverabilityTestPageDto	DeliverabilityTestPageDto

Remarks

List deliverability tests for the authenticated account.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDeliverabilityTestsWithHttpInfo(int?, int?, string, int)

List deliverability/load tests

Declaration

ApiResponse<DeliverabilityTestPageDto> GetDeliverabilityTestsWithHttpInfo(int? page = null, int? size = null, string sort = null, int operationIndex = 0)

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.

Returns

Type	Description
ApiResponse<DeliverabilityTestPageDto>	ApiResponse of DeliverabilityTestPageDto

Remarks

List deliverability tests for the authenticated account.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetLatestDeliverabilitySimulationJob(Guid, int)

Get latest deliverability simulation job

Declaration

DeliverabilitySimulationJobDto GetLatestDeliverabilitySimulationJob(Guid testId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	testId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
DeliverabilitySimulationJobDto	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

GetLatestDeliverabilitySimulationJobWithHttpInfo(Guid, int)

Get latest deliverability simulation job

Declaration

ApiResponse<DeliverabilitySimulationJobDto> GetLatestDeliverabilitySimulationJobWithHttpInfo(Guid testId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	testId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<DeliverabilitySimulationJobDto>	ApiResponse 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

PauseDeliverabilitySimulationJob(Guid, Guid, int)

Pause deliverability simulation job

Declaration

DeliverabilitySimulationJobDto PauseDeliverabilitySimulationJob(Guid testId, Guid jobId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	testId
Guid	jobId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
DeliverabilitySimulationJobDto	DeliverabilitySimulationJobDto

Remarks

Pause a running simulation job.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

PauseDeliverabilitySimulationJobWithHttpInfo(Guid, Guid, int)

Pause deliverability simulation job

Declaration

ApiResponse<DeliverabilitySimulationJobDto> PauseDeliverabilitySimulationJobWithHttpInfo(Guid testId, Guid jobId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	testId
Guid	jobId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<DeliverabilitySimulationJobDto>	ApiResponse of DeliverabilitySimulationJobDto

Remarks

Pause a running simulation job.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

PauseDeliverabilityTest(Guid, int)

Pause deliverability/load test

Declaration

DeliverabilityTestDto PauseDeliverabilityTest(Guid testId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	testId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
DeliverabilityTestDto	DeliverabilityTestDto

Remarks

Pause a RUNNING or SCHEDULED deliverability test.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

PauseDeliverabilityTestWithHttpInfo(Guid, int)

Pause deliverability/load test

Declaration

ApiResponse<DeliverabilityTestDto> PauseDeliverabilityTestWithHttpInfo(Guid testId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	testId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<DeliverabilityTestDto>	ApiResponse of DeliverabilityTestDto

Remarks

Pause a RUNNING or SCHEDULED deliverability test.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

PollDeliverabilityTestStatus(Guid, int)

Poll deliverability/load test status

Declaration

DeliverabilityPollStatusResultDto PollDeliverabilityTestStatus(Guid testId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	testId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
DeliverabilityPollStatusResultDto	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

PollDeliverabilityTestStatusWithHttpInfo(Guid, int)

Poll deliverability/load test status

Declaration

ApiResponse<DeliverabilityPollStatusResultDto> PollDeliverabilityTestStatusWithHttpInfo(Guid testId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	testId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<DeliverabilityPollStatusResultDto>	ApiResponse 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

ResumeDeliverabilitySimulationJob(Guid, Guid, int)

Resume deliverability simulation job

Declaration

DeliverabilitySimulationJobDto ResumeDeliverabilitySimulationJob(Guid testId, Guid jobId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	testId
Guid	jobId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
DeliverabilitySimulationJobDto	DeliverabilitySimulationJobDto

Remarks

Resume a paused simulation job.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

ResumeDeliverabilitySimulationJobWithHttpInfo(Guid, Guid, int)

Resume deliverability simulation job

Declaration

ApiResponse<DeliverabilitySimulationJobDto> ResumeDeliverabilitySimulationJobWithHttpInfo(Guid testId, Guid jobId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	testId
Guid	jobId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<DeliverabilitySimulationJobDto>	ApiResponse of DeliverabilitySimulationJobDto

Remarks

Resume a paused simulation job.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

StartDeliverabilityTest(Guid, int)

Start or resume deliverability/load test

Declaration

DeliverabilityTestDto StartDeliverabilityTest(Guid testId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	testId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
DeliverabilityTestDto	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

StartDeliverabilityTestWithHttpInfo(Guid, int)

Start or resume deliverability/load test

Declaration

ApiResponse<DeliverabilityTestDto> StartDeliverabilityTestWithHttpInfo(Guid testId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	testId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<DeliverabilityTestDto>	ApiResponse 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

StopDeliverabilityTest(Guid, int)

Stop deliverability/load test

Declaration

DeliverabilityTestDto StopDeliverabilityTest(Guid testId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	testId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
DeliverabilityTestDto	DeliverabilityTestDto

Remarks

Stop a deliverability test and mark it terminal.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

StopDeliverabilityTestWithHttpInfo(Guid, int)

Stop deliverability/load test

Declaration

ApiResponse<DeliverabilityTestDto> StopDeliverabilityTestWithHttpInfo(Guid testId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	testId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<DeliverabilityTestDto>	ApiResponse of DeliverabilityTestDto

Remarks

Stop a deliverability test and mark it terminal.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateDeliverabilityTest(Guid, UpdateDeliverabilityTestOptions, int)

Update deliverability/load test

Declaration

DeliverabilityTestDto UpdateDeliverabilityTest(Guid testId, UpdateDeliverabilityTestOptions updateDeliverabilityTestOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	testId
UpdateDeliverabilityTestOptions	updateDeliverabilityTestOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
DeliverabilityTestDto	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

UpdateDeliverabilityTestWithHttpInfo(Guid, UpdateDeliverabilityTestOptions, int)

Update deliverability/load test

Declaration

ApiResponse<DeliverabilityTestDto> UpdateDeliverabilityTestWithHttpInfo(Guid testId, UpdateDeliverabilityTestOptions updateDeliverabilityTestOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	testId
UpdateDeliverabilityTestOptions	updateDeliverabilityTestOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<DeliverabilityTestDto>	ApiResponse 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