public class DeliverabilityTestControllerApi : IDeliverabilityTestControllerApi, IDeliverabilityTestControllerApiSync, IDeliverabilityTestControllerApiAsync, IApiAccessor

Constructors

View Source

DeliverabilityTestControllerApi()

Initializes a new instance of the DeliverabilityTestControllerApi class.

Declaration

public DeliverabilityTestControllerApi()

View Source

DeliverabilityTestControllerApi(string)

Initializes a new instance of the DeliverabilityTestControllerApi class.

Declaration

public DeliverabilityTestControllerApi(string basePath)

Parameters

Type	Name	Description
string	basePath

View Source

DeliverabilityTestControllerApi(Configuration)

Initializes a new instance of the DeliverabilityTestControllerApi class using Configuration object

Declaration

public DeliverabilityTestControllerApi(Configuration configuration)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

View Source

DeliverabilityTestControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

Initializes a new instance of the DeliverabilityTestControllerApi class using a Configuration object and client instance.

Declaration

public DeliverabilityTestControllerApi(ISynchronousClient client, IAsynchronousClient asyncClient, IReadableConfiguration configuration)

Parameters

Type	Name	Description
ISynchronousClient	client	The client interface for synchronous API access.
IAsynchronousClient	asyncClient	The client interface for asynchronous API access.
IReadableConfiguration	configuration	The configuration object.

Properties

View Source

AsynchronousClient

The client for accessing this underlying API asynchronously.

Declaration

public IAsynchronousClient AsynchronousClient { get; set; }

Property Value

Type	Description
IAsynchronousClient

View Source

Client

The client for accessing this underlying API synchronously.

Declaration

public ISynchronousClient Client { get; set; }

Property Value

Type	Description
ISynchronousClient

View Source

Configuration

Gets or sets the configuration object

Declaration

public IReadableConfiguration Configuration { get; set; }

Property Value

Type	Description
IReadableConfiguration	An instance of the Configuration

View Source

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
ExceptionFactory

Methods

View Source

CancelDeliverabilitySimulationJob(Guid, Guid, int)

Cancel deliverability simulation job Cancel a running or paused simulation job.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CancelDeliverabilitySimulationJobAsync(Guid, Guid, int, CancellationToken)

Cancel deliverability simulation job Cancel a running or paused simulation job.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CancelDeliverabilitySimulationJobWithHttpInfo(Guid, Guid, int)

Cancel deliverability simulation job Cancel a running or paused simulation job.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CancelDeliverabilitySimulationJobWithHttpInfoAsync(Guid, Guid, int, CancellationToken)

Cancel deliverability simulation job Cancel a running or paused simulation job.

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateDeliverabilitySimulationJob(Guid, CreateDeliverabilitySimulationJobOptions, int)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateDeliverabilitySimulationJobAsync(Guid, CreateDeliverabilitySimulationJobOptions, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateDeliverabilitySimulationJobWithHttpInfo(Guid, CreateDeliverabilitySimulationJobOptions, int)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateDeliverabilitySimulationJobWithHttpInfoAsync(Guid, CreateDeliverabilitySimulationJobOptions, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateDeliverabilityTest(CreateDeliverabilityTestOptions, int)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateDeliverabilityTestAsync(CreateDeliverabilityTestOptions, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateDeliverabilityTestWithHttpInfo(CreateDeliverabilityTestOptions, int)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateDeliverabilityTestWithHttpInfoAsync(CreateDeliverabilityTestOptions, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteDeliverabilityTest(Guid, int)

Delete deliverability/load test Delete test and all persisted entity-level results.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteDeliverabilityTestAsync(Guid, int, CancellationToken)

Delete deliverability/load test Delete test and all persisted entity-level results.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteDeliverabilityTestWithHttpInfo(Guid, int)

Delete deliverability/load test Delete test and all persisted entity-level results.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteDeliverabilityTestWithHttpInfoAsync(Guid, int, CancellationToken)

Delete deliverability/load test Delete test and all persisted entity-level results.

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DuplicateDeliverabilityTest(Guid, int)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DuplicateDeliverabilityTestAsync(Guid, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DuplicateDeliverabilityTestWithHttpInfo(Guid, int)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DuplicateDeliverabilityTestWithHttpInfoAsync(Guid, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

ExportDeliverabilityTestReport(Guid, int)

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

Declaration

public void ExportDeliverabilityTestReport(Guid testId, int operationIndex = 0)

Parameters

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

ExportDeliverabilityTestReportAsync(Guid, int, CancellationToken)

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

ExportDeliverabilityTestReportWithHttpInfo(Guid, int)

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

ExportDeliverabilityTestReportWithHttpInfoAsync(Guid, int, CancellationToken)

Declaration

public 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

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 Export per-entity deliverability results including expectation-level pass/fail counts. The latest status is evaluated with the same polling safeguards before export.

Declaration

public 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.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

ExportDeliverabilityTestResultsAsync(Guid, bool?, int, CancellationToken)

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

ExportDeliverabilityTestResultsWithHttpInfo(Guid, bool?, int)

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

ExportDeliverabilityTestResultsWithHttpInfoAsync(Guid, bool?, int, CancellationToken)

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

View Source

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

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

Declaration

public 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

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 Compare deliverability runs over a time range with bucketed chart metrics and run-level rows for table views.

Declaration

public 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

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 Compare deliverability runs over a time range with bucketed chart metrics and run-level rows for table views.

Declaration

public 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

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 Compare deliverability runs over a time range with bucketed chart metrics and run-level rows for table views.

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDeliverabilitySimulationJob(Guid, Guid, int)

Get deliverability simulation job Get simulation job status and progress counters.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDeliverabilitySimulationJobAsync(Guid, Guid, int, CancellationToken)

Get deliverability simulation job Get simulation job status and progress counters.

Declaration

public 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

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 Get paged simulation events including send successes and failures.

Declaration

public 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

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 Get paged simulation events including send successes and failures.

Declaration

public 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

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 Get paged simulation events including send successes and failures.

Declaration

public 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

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 Get paged simulation events including send successes and failures.

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDeliverabilitySimulationJobWithHttpInfo(Guid, Guid, int)

Get deliverability simulation job Get simulation job status and progress counters.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDeliverabilitySimulationJobWithHttpInfoAsync(Guid, Guid, int, CancellationToken)

Get deliverability simulation job Get simulation job status and progress counters.

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDeliverabilityTest(Guid, int)

Get deliverability/load test Get deliverability test configuration and latest progress counters.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDeliverabilityTestAsync(Guid, int, CancellationToken)

Get deliverability/load test Get deliverability test configuration and latest progress counters.

Declaration

public 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

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 Get paged per-entity expectation results with optional matched/unmatched filtering.

Declaration

public 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

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 Get paged per-entity expectation results with optional matched/unmatched filtering.

Declaration

public 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

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 Get paged per-entity expectation results with optional matched/unmatched filtering.

Declaration

public 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

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 Get paged per-entity expectation results with optional matched/unmatched filtering.

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDeliverabilityTestWithHttpInfo(Guid, int)

Get deliverability/load test Get deliverability test configuration and latest progress counters.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDeliverabilityTestWithHttpInfoAsync(Guid, int, CancellationToken)

Get deliverability/load test Get deliverability test configuration and latest progress counters.

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

List deliverability/load tests List deliverability tests for the authenticated account.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

List deliverability/load tests List deliverability tests for the authenticated account.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

List deliverability/load tests List deliverability tests for the authenticated account.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

List deliverability/load tests List deliverability tests for the authenticated account.

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetLatestDeliverabilitySimulationJob(Guid, int)

Get latest deliverability simulation job Get the most recent simulation job for a deliverability test.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetLatestDeliverabilitySimulationJobAsync(Guid, int, CancellationToken)

Get latest deliverability simulation job Get the most recent simulation job for a deliverability test.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetLatestDeliverabilitySimulationJobWithHttpInfo(Guid, int)

Get latest deliverability simulation job Get the most recent simulation job for a deliverability test.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetLatestDeliverabilitySimulationJobWithHttpInfoAsync(Guid, int, CancellationToken)

Get latest deliverability simulation job Get the most recent simulation job for a deliverability test.

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

PauseDeliverabilitySimulationJob(Guid, Guid, int)

Pause deliverability simulation job Pause a running simulation job.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

PauseDeliverabilitySimulationJobAsync(Guid, Guid, int, CancellationToken)

Pause deliverability simulation job Pause a running simulation job.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

PauseDeliverabilitySimulationJobWithHttpInfo(Guid, Guid, int)

Pause deliverability simulation job Pause a running simulation job.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

PauseDeliverabilitySimulationJobWithHttpInfoAsync(Guid, Guid, int, CancellationToken)

Pause deliverability simulation job Pause a running simulation job.

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

PauseDeliverabilityTest(Guid, int)

Pause deliverability/load test Pause a RUNNING or SCHEDULED deliverability test.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

PauseDeliverabilityTestAsync(Guid, int, CancellationToken)

Pause deliverability/load test Pause a RUNNING or SCHEDULED deliverability test.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

PauseDeliverabilityTestWithHttpInfo(Guid, int)

Pause deliverability/load test Pause a RUNNING or SCHEDULED deliverability test.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

PauseDeliverabilityTestWithHttpInfoAsync(Guid, int, CancellationToken)

Pause deliverability/load test Pause a RUNNING or SCHEDULED deliverability test.

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

PollDeliverabilityTestStatus(Guid, int)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

PollDeliverabilityTestStatusAsync(Guid, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

PollDeliverabilityTestStatusWithHttpInfo(Guid, int)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

PollDeliverabilityTestStatusWithHttpInfoAsync(Guid, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

ResumeDeliverabilitySimulationJob(Guid, Guid, int)

Resume deliverability simulation job Resume a paused simulation job.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

ResumeDeliverabilitySimulationJobAsync(Guid, Guid, int, CancellationToken)

Resume deliverability simulation job Resume a paused simulation job.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

ResumeDeliverabilitySimulationJobWithHttpInfo(Guid, Guid, int)

Resume deliverability simulation job Resume a paused simulation job.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

ResumeDeliverabilitySimulationJobWithHttpInfoAsync(Guid, Guid, int, CancellationToken)

Resume deliverability simulation job Resume a paused simulation job.

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

StartDeliverabilityTest(Guid, int)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

StartDeliverabilityTestAsync(Guid, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

StartDeliverabilityTestWithHttpInfo(Guid, int)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

StartDeliverabilityTestWithHttpInfoAsync(Guid, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

StopDeliverabilityTest(Guid, int)

Stop deliverability/load test Stop a deliverability test and mark it terminal.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

StopDeliverabilityTestAsync(Guid, int, CancellationToken)

Stop deliverability/load test Stop a deliverability test and mark it terminal.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

StopDeliverabilityTestWithHttpInfo(Guid, int)

Stop deliverability/load test Stop a deliverability test and mark it terminal.

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

StopDeliverabilityTestWithHttpInfoAsync(Guid, int, CancellationToken)

Stop deliverability/load test Stop a deliverability test and mark it terminal.

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateDeliverabilityTest(Guid, UpdateDeliverabilityTestOptions, int)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateDeliverabilityTestAsync(Guid, UpdateDeliverabilityTestOptions, int, CancellationToken)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateDeliverabilityTestWithHttpInfo(Guid, UpdateDeliverabilityTestOptions, int)

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

Declaration

public 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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateDeliverabilityTestWithHttpInfoAsync(Guid, UpdateDeliverabilityTestOptions, int, CancellationToken)

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

Declaration

public 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)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

Implements

IDeliverabilityTestControllerApi

IDeliverabilityTestControllerApiSync

IDeliverabilityTestControllerApiAsync

IApiAccessor