public class DevicePreviewsControllerApi : IDevicePreviewsControllerApi, IDevicePreviewsControllerApiSync, IDevicePreviewsControllerApiAsync, IApiAccessor

Constructors

View Source

DevicePreviewsControllerApi()

Initializes a new instance of the DevicePreviewsControllerApi class.

Declaration

public DevicePreviewsControllerApi()

View Source

DevicePreviewsControllerApi(string)

Initializes a new instance of the DevicePreviewsControllerApi class.

Declaration

public DevicePreviewsControllerApi(string basePath)

Parameters

Type	Name	Description
string	basePath

View Source

DevicePreviewsControllerApi(Configuration)

Initializes a new instance of the DevicePreviewsControllerApi class using Configuration object

Declaration

public DevicePreviewsControllerApi(Configuration configuration)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

View Source

DevicePreviewsControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

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

Declaration

public DevicePreviewsControllerApi(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

CancelDevicePreviewRun(Guid, CancelDevicePreviewRunOptions, int)

Cancel a running device preview run

Declaration

public CancelDevicePreviewRunResult CancelDevicePreviewRun(Guid runId, CancelDevicePreviewRunOptions cancelDevicePreviewRunOptions = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	runId
CancelDevicePreviewRunOptions	cancelDevicePreviewRunOptions	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
CancelDevicePreviewRunResult	CancelDevicePreviewRunResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CancelDevicePreviewRunAsync(Guid, CancelDevicePreviewRunOptions, int, CancellationToken)

Cancel a running device preview run

Declaration

public Task<CancelDevicePreviewRunResult> CancelDevicePreviewRunAsync(Guid runId, CancelDevicePreviewRunOptions cancelDevicePreviewRunOptions = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	runId
CancelDevicePreviewRunOptions	cancelDevicePreviewRunOptions	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<CancelDevicePreviewRunResult>	Task of CancelDevicePreviewRunResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CancelDevicePreviewRunWithHttpInfo(Guid, CancelDevicePreviewRunOptions, int)

Cancel a running device preview run

Declaration

public ApiResponse<CancelDevicePreviewRunResult> CancelDevicePreviewRunWithHttpInfo(Guid runId, CancelDevicePreviewRunOptions cancelDevicePreviewRunOptions = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	runId
CancelDevicePreviewRunOptions	cancelDevicePreviewRunOptions	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<CancelDevicePreviewRunResult>	ApiResponse of CancelDevicePreviewRunResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CancelDevicePreviewRunWithHttpInfoAsync(Guid, CancelDevicePreviewRunOptions, int, CancellationToken)

Cancel a running device preview run

Declaration

public Task<ApiResponse<CancelDevicePreviewRunResult>> CancelDevicePreviewRunWithHttpInfoAsync(Guid runId, CancelDevicePreviewRunOptions cancelDevicePreviewRunOptions = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	runId
CancelDevicePreviewRunOptions	cancelDevicePreviewRunOptions	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateDevicePreviewFeedback(CreateDevicePreviewFeedbackOptions, int)

Create device preview feedback

Declaration

public DevicePreviewFeedbackDto CreateDevicePreviewFeedback(CreateDevicePreviewFeedbackOptions createDevicePreviewFeedbackOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CreateDevicePreviewFeedbackOptions	createDevicePreviewFeedbackOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
DevicePreviewFeedbackDto	DevicePreviewFeedbackDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateDevicePreviewFeedbackAsync(CreateDevicePreviewFeedbackOptions, int, CancellationToken)

Create device preview feedback

Declaration

public Task<DevicePreviewFeedbackDto> CreateDevicePreviewFeedbackAsync(CreateDevicePreviewFeedbackOptions createDevicePreviewFeedbackOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<DevicePreviewFeedbackDto>	Task of DevicePreviewFeedbackDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateDevicePreviewFeedbackWithHttpInfo(CreateDevicePreviewFeedbackOptions, int)

Create device preview feedback

Declaration

public ApiResponse<DevicePreviewFeedbackDto> CreateDevicePreviewFeedbackWithHttpInfo(CreateDevicePreviewFeedbackOptions createDevicePreviewFeedbackOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CreateDevicePreviewFeedbackOptions	createDevicePreviewFeedbackOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<DevicePreviewFeedbackDto>	ApiResponse of DevicePreviewFeedbackDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateDevicePreviewFeedbackWithHttpInfoAsync(CreateDevicePreviewFeedbackOptions, int, CancellationToken)

Create device preview feedback

Declaration

public Task<ApiResponse<DevicePreviewFeedbackDto>> CreateDevicePreviewFeedbackWithHttpInfoAsync(CreateDevicePreviewFeedbackOptions createDevicePreviewFeedbackOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateDevicePreviewRun(Guid, CreateDevicePreviewOptions, int)

Create a new device preview run for an email

Declaration

public CreateDevicePreviewRunResult CreateDevicePreviewRun(Guid emailId, CreateDevicePreviewOptions createDevicePreviewOptions = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId
CreateDevicePreviewOptions	createDevicePreviewOptions	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
CreateDevicePreviewRunResult	CreateDevicePreviewRunResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateDevicePreviewRunAsync(Guid, CreateDevicePreviewOptions, int, CancellationToken)

Create a new device preview run for an email

Declaration

public Task<CreateDevicePreviewRunResult> CreateDevicePreviewRunAsync(Guid emailId, CreateDevicePreviewOptions createDevicePreviewOptions = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId
CreateDevicePreviewOptions	createDevicePreviewOptions	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<CreateDevicePreviewRunResult>	Task of CreateDevicePreviewRunResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateDevicePreviewRunWithHttpInfo(Guid, CreateDevicePreviewOptions, int)

Create a new device preview run for an email

Declaration

public ApiResponse<CreateDevicePreviewRunResult> CreateDevicePreviewRunWithHttpInfo(Guid emailId, CreateDevicePreviewOptions createDevicePreviewOptions = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId
CreateDevicePreviewOptions	createDevicePreviewOptions	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<CreateDevicePreviewRunResult>	ApiResponse of CreateDevicePreviewRunResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateDevicePreviewRunWithHttpInfoAsync(Guid, CreateDevicePreviewOptions, int, CancellationToken)

Create a new device preview run for an email

Declaration

public Task<ApiResponse<CreateDevicePreviewRunResult>> CreateDevicePreviewRunWithHttpInfoAsync(Guid emailId, CreateDevicePreviewOptions createDevicePreviewOptions = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId
CreateDevicePreviewOptions	createDevicePreviewOptions	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteDevicePreviewRun(Guid, int)

Delete local device preview run data

Declaration

public DeleteDevicePreviewRunResult DeleteDevicePreviewRun(Guid runId, int operationIndex = 0)

Parameters

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

Returns

Type	Description
DeleteDevicePreviewRunResult	DeleteDevicePreviewRunResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteDevicePreviewRunAsync(Guid, int, CancellationToken)

Delete local device preview run data

Declaration

public Task<DeleteDevicePreviewRunResult> DeleteDevicePreviewRunAsync(Guid runId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<DeleteDevicePreviewRunResult>	Task of DeleteDevicePreviewRunResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteDevicePreviewRunWithHttpInfo(Guid, int)

Delete local device preview run data

Declaration

public ApiResponse<DeleteDevicePreviewRunResult> DeleteDevicePreviewRunWithHttpInfo(Guid runId, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ApiResponse<DeleteDevicePreviewRunResult>	ApiResponse of DeleteDevicePreviewRunResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteDevicePreviewRunWithHttpInfoAsync(Guid, int, CancellationToken)

Delete local device preview run data

Declaration

public Task<ApiResponse<DeleteDevicePreviewRunResult>> DeleteDevicePreviewRunWithHttpInfoAsync(Guid runId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

EnsureDevicePreviewRun(Guid, CreateDevicePreviewOptions, int)

Return active run for email or create one when none exists

Declaration

public CreateDevicePreviewRunResult EnsureDevicePreviewRun(Guid emailId, CreateDevicePreviewOptions createDevicePreviewOptions = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId
CreateDevicePreviewOptions	createDevicePreviewOptions	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
CreateDevicePreviewRunResult	CreateDevicePreviewRunResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

EnsureDevicePreviewRunAsync(Guid, CreateDevicePreviewOptions, int, CancellationToken)

Return active run for email or create one when none exists

Declaration

public Task<CreateDevicePreviewRunResult> EnsureDevicePreviewRunAsync(Guid emailId, CreateDevicePreviewOptions createDevicePreviewOptions = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId
CreateDevicePreviewOptions	createDevicePreviewOptions	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<CreateDevicePreviewRunResult>	Task of CreateDevicePreviewRunResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

EnsureDevicePreviewRunWithHttpInfo(Guid, CreateDevicePreviewOptions, int)

Return active run for email or create one when none exists

Declaration

public ApiResponse<CreateDevicePreviewRunResult> EnsureDevicePreviewRunWithHttpInfo(Guid emailId, CreateDevicePreviewOptions createDevicePreviewOptions = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId
CreateDevicePreviewOptions	createDevicePreviewOptions	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<CreateDevicePreviewRunResult>	ApiResponse of CreateDevicePreviewRunResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

EnsureDevicePreviewRunWithHttpInfoAsync(Guid, CreateDevicePreviewOptions, int, CancellationToken)

Return active run for email or create one when none exists

Declaration

public Task<ApiResponse<CreateDevicePreviewRunResult>> EnsureDevicePreviewRunWithHttpInfoAsync(Guid emailId, CreateDevicePreviewOptions createDevicePreviewOptions = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId
CreateDevicePreviewOptions	createDevicePreviewOptions	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

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

GetDevicePreviewFeedback(Guid, int)

Get a single device preview feedback item

Declaration

public DevicePreviewFeedbackDto GetDevicePreviewFeedback(Guid feedbackId, int operationIndex = 0)

Parameters

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

Returns

Type	Description
DevicePreviewFeedbackDto	DevicePreviewFeedbackDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDevicePreviewFeedbackAsync(Guid, int, CancellationToken)

Get a single device preview feedback item

Declaration

public Task<DevicePreviewFeedbackDto> GetDevicePreviewFeedbackAsync(Guid feedbackId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<DevicePreviewFeedbackDto>	Task of DevicePreviewFeedbackDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDevicePreviewFeedbackItems(int?, int?, string, Guid?, string, string, string, string, int)

List device preview feedback

Declaration

public DevicePreviewFeedbackListDto GetDevicePreviewFeedbackItems(int? page = null, int? size = null, string source = null, Guid? runId = null, string status = null, string provider = null, string category = null, string search = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	page	(optional)
int?	size	(optional)
string	source	(optional)
Guid?	runId	(optional)
string	status	(optional)
string	provider	(optional)
string	category	(optional)
string	search	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
DevicePreviewFeedbackListDto	DevicePreviewFeedbackListDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

List device preview feedback

Declaration

public Task<DevicePreviewFeedbackListDto> GetDevicePreviewFeedbackItemsAsync(int? page = null, int? size = null, string source = null, Guid? runId = null, string status = null, string provider = null, string category = null, string search = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	(optional)
int?	size	(optional)
string	source	(optional)
Guid?	runId	(optional)
string	status	(optional)
string	provider	(optional)
string	category	(optional)
string	search	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<DevicePreviewFeedbackListDto>	Task of DevicePreviewFeedbackListDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDevicePreviewFeedbackItemsWithHttpInfo(int?, int?, string, Guid?, string, string, string, string, int)

List device preview feedback

Declaration

public ApiResponse<DevicePreviewFeedbackListDto> GetDevicePreviewFeedbackItemsWithHttpInfo(int? page = null, int? size = null, string source = null, Guid? runId = null, string status = null, string provider = null, string category = null, string search = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	page	(optional)
int?	size	(optional)
string	source	(optional)
Guid?	runId	(optional)
string	status	(optional)
string	provider	(optional)
string	category	(optional)
string	search	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<DevicePreviewFeedbackListDto>	ApiResponse of DevicePreviewFeedbackListDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

List device preview feedback

Declaration

public Task<ApiResponse<DevicePreviewFeedbackListDto>> GetDevicePreviewFeedbackItemsWithHttpInfoAsync(int? page = null, int? size = null, string source = null, Guid? runId = null, string status = null, string provider = null, string category = null, string search = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	(optional)
int?	size	(optional)
string	source	(optional)
Guid?	runId	(optional)
string	status	(optional)
string	provider	(optional)
string	category	(optional)
string	search	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDevicePreviewFeedbackWithHttpInfo(Guid, int)

Get a single device preview feedback item

Declaration

public ApiResponse<DevicePreviewFeedbackDto> GetDevicePreviewFeedbackWithHttpInfo(Guid feedbackId, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ApiResponse<DevicePreviewFeedbackDto>	ApiResponse of DevicePreviewFeedbackDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDevicePreviewFeedbackWithHttpInfoAsync(Guid, int, CancellationToken)

Get a single device preview feedback item

Declaration

public Task<ApiResponse<DevicePreviewFeedbackDto>> GetDevicePreviewFeedbackWithHttpInfoAsync(Guid feedbackId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDevicePreviewRun(Guid, int)

Get device preview run status

Declaration

public DevicePreviewRunDto GetDevicePreviewRun(Guid runId, int operationIndex = 0)

Parameters

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

Returns

Type	Description
DevicePreviewRunDto	DevicePreviewRunDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDevicePreviewRunAsync(Guid, int, CancellationToken)

Get device preview run status

Declaration

public Task<DevicePreviewRunDto> GetDevicePreviewRunAsync(Guid runId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<DevicePreviewRunDto>	Task of DevicePreviewRunDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDevicePreviewRunProviderProgress(Guid, string, int)

Get provider-level progress for a device preview run

Declaration

public DevicePreviewProviderProgressDto GetDevicePreviewRunProviderProgress(Guid runId, string provider, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	runId
string	provider
int	operationIndex	Index associated with the operation.

Returns

Type	Description
DevicePreviewProviderProgressDto	DevicePreviewProviderProgressDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDevicePreviewRunProviderProgressAsync(Guid, string, int, CancellationToken)

Get provider-level progress for a device preview run

Declaration

public Task<DevicePreviewProviderProgressDto> GetDevicePreviewRunProviderProgressAsync(Guid runId, string provider, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<DevicePreviewProviderProgressDto>	Task of DevicePreviewProviderProgressDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDevicePreviewRunProviderProgressWithHttpInfo(Guid, string, int)

Get provider-level progress for a device preview run

Declaration

public ApiResponse<DevicePreviewProviderProgressDto> GetDevicePreviewRunProviderProgressWithHttpInfo(Guid runId, string provider, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	runId
string	provider
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<DevicePreviewProviderProgressDto>	ApiResponse of DevicePreviewProviderProgressDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDevicePreviewRunProviderProgressWithHttpInfoAsync(Guid, string, int, CancellationToken)

Get provider-level progress for a device preview run

Declaration

public Task<ApiResponse<DevicePreviewProviderProgressDto>> GetDevicePreviewRunProviderProgressWithHttpInfoAsync(Guid runId, string provider, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDevicePreviewRunResults(Guid, int)

Get device preview run results

Declaration

public DevicePreviewRunResultsDto GetDevicePreviewRunResults(Guid runId, int operationIndex = 0)

Parameters

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

Returns

Type	Description
DevicePreviewRunResultsDto	DevicePreviewRunResultsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDevicePreviewRunResultsAsync(Guid, int, CancellationToken)

Get device preview run results

Declaration

public Task<DevicePreviewRunResultsDto> GetDevicePreviewRunResultsAsync(Guid runId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<DevicePreviewRunResultsDto>	Task of DevicePreviewRunResultsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDevicePreviewRunResultsWithHttpInfo(Guid, int)

Get device preview run results

Declaration

public ApiResponse<DevicePreviewRunResultsDto> GetDevicePreviewRunResultsWithHttpInfo(Guid runId, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ApiResponse<DevicePreviewRunResultsDto>	ApiResponse of DevicePreviewRunResultsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDevicePreviewRunResultsWithHttpInfoAsync(Guid, int, CancellationToken)

Get device preview run results

Declaration

public Task<ApiResponse<DevicePreviewRunResultsDto>> GetDevicePreviewRunResultsWithHttpInfoAsync(Guid runId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDevicePreviewRunScreenshot(Guid, Guid, int)

Get a seeded device preview screenshot image

Declaration

public byte[] GetDevicePreviewRunScreenshot(Guid runId, Guid screenshotId, int operationIndex = 0)

Parameters

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

Returns

Type	Description
byte[]	byte[]

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDevicePreviewRunScreenshotAsync(Guid, Guid, int, CancellationToken)

Get a seeded device preview screenshot image

Declaration

public Task<byte[]> GetDevicePreviewRunScreenshotAsync(Guid runId, Guid screenshotId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<byte[]>	Task of byte[]

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDevicePreviewRunScreenshotWithHttpInfo(Guid, Guid, int)

Get a seeded device preview screenshot image

Declaration

public ApiResponse<byte[]> GetDevicePreviewRunScreenshotWithHttpInfo(Guid runId, Guid screenshotId, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ApiResponse<byte[]>	ApiResponse of byte[]

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDevicePreviewRunScreenshotWithHttpInfoAsync(Guid, Guid, int, CancellationToken)

Get a seeded device preview screenshot image

Declaration

public Task<ApiResponse<byte[]>> GetDevicePreviewRunScreenshotWithHttpInfoAsync(Guid runId, Guid screenshotId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<ApiResponse<byte[]>>	Task of ApiResponse (byte[])

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDevicePreviewRunWithHttpInfo(Guid, int)

Get device preview run status

Declaration

public ApiResponse<DevicePreviewRunDto> GetDevicePreviewRunWithHttpInfo(Guid runId, int operationIndex = 0)

Parameters

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

Returns

Type	Description
ApiResponse<DevicePreviewRunDto>	ApiResponse of DevicePreviewRunDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDevicePreviewRunWithHttpInfoAsync(Guid, int, CancellationToken)

Get device preview run status

Declaration

public Task<ApiResponse<DevicePreviewRunDto>> GetDevicePreviewRunWithHttpInfoAsync(Guid runId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDevicePreviewRuns(Guid, int?, int)

List previous device preview runs for an email

Declaration

public List<DevicePreviewRunDto> GetDevicePreviewRuns(Guid emailId, int? limit = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId
int?	limit	(optional, default to 50)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
List<DevicePreviewRunDto>	List<DevicePreviewRunDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDevicePreviewRunsAsync(Guid, int?, int, CancellationToken)

List previous device preview runs for an email

Declaration

public Task<List<DevicePreviewRunDto>> GetDevicePreviewRunsAsync(Guid emailId, int? limit = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId
int?	limit	(optional, default to 50)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<List<DevicePreviewRunDto>>	Task of List<DevicePreviewRunDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDevicePreviewRunsForAccount(int?, int)

List previous device preview runs for account

Declaration

public List<DevicePreviewRunDto> GetDevicePreviewRunsForAccount(int? limit = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	limit	(optional, default to 50)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
List<DevicePreviewRunDto>	List<DevicePreviewRunDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDevicePreviewRunsForAccountAsync(int?, int, CancellationToken)

List previous device preview runs for account

Declaration

public Task<List<DevicePreviewRunDto>> GetDevicePreviewRunsForAccountAsync(int? limit = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<List<DevicePreviewRunDto>>	Task of List<DevicePreviewRunDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDevicePreviewRunsForAccountWithHttpInfo(int?, int)

List previous device preview runs for account

Declaration

public ApiResponse<List<DevicePreviewRunDto>> GetDevicePreviewRunsForAccountWithHttpInfo(int? limit = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	limit	(optional, default to 50)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<List<DevicePreviewRunDto>>	ApiResponse of List<DevicePreviewRunDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDevicePreviewRunsForAccountWithHttpInfoAsync(int?, int, CancellationToken)

List previous device preview runs for account

Declaration

public Task<ApiResponse<List<DevicePreviewRunDto>>> GetDevicePreviewRunsForAccountWithHttpInfoAsync(int? limit = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDevicePreviewRunsOffsetPaginated(Guid, int?, int?, string, int)

List previous device preview runs for an email in paginated form

Declaration

public PageDevicePreviewRunProjection GetDevicePreviewRunsOffsetPaginated(Guid emailId, int? page = null, int? size = null, string sort = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size for paginated result list. (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to DESC)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageDevicePreviewRunProjection	PageDevicePreviewRunProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

List previous device preview runs for an email in paginated form

Declaration

public Task<PageDevicePreviewRunProjection> GetDevicePreviewRunsOffsetPaginatedAsync(Guid emailId, int? page = null, int? size = null, string sort = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size for paginated result list. (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to DESC)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageDevicePreviewRunProjection>	Task of PageDevicePreviewRunProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDevicePreviewRunsOffsetPaginatedWithHttpInfo(Guid, int?, int?, string, int)

List previous device preview runs for an email in paginated form

Declaration

public ApiResponse<PageDevicePreviewRunProjection> GetDevicePreviewRunsOffsetPaginatedWithHttpInfo(Guid emailId, int? page = null, int? size = null, string sort = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size for paginated result list. (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to DESC)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageDevicePreviewRunProjection>	ApiResponse of PageDevicePreviewRunProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

List previous device preview runs for an email in paginated form

Declaration

public Task<ApiResponse<PageDevicePreviewRunProjection>> GetDevicePreviewRunsOffsetPaginatedWithHttpInfoAsync(Guid emailId, int? page = null, int? size = null, string sort = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId
int?	page	Optional page index in list pagination (optional, default to 0)
int?	size	Optional page size for paginated result list. (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to DESC)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDevicePreviewRunsWithHttpInfo(Guid, int?, int)

List previous device preview runs for an email

Declaration

public ApiResponse<List<DevicePreviewRunDto>> GetDevicePreviewRunsWithHttpInfo(Guid emailId, int? limit = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	emailId
int?	limit	(optional, default to 50)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<List<DevicePreviewRunDto>>	ApiResponse of List<DevicePreviewRunDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetDevicePreviewRunsWithHttpInfoAsync(Guid, int?, int, CancellationToken)

List previous device preview runs for an email

Declaration

public Task<ApiResponse<List<DevicePreviewRunDto>>> GetDevicePreviewRunsWithHttpInfoAsync(Guid emailId, int? limit = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	emailId
int?	limit	(optional, default to 50)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateDevicePreviewFeedback(Guid, UpdateDevicePreviewFeedbackOptions, int)

Update device preview feedback

Declaration

public DevicePreviewFeedbackDto UpdateDevicePreviewFeedback(Guid feedbackId, UpdateDevicePreviewFeedbackOptions updateDevicePreviewFeedbackOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	feedbackId
UpdateDevicePreviewFeedbackOptions	updateDevicePreviewFeedbackOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
DevicePreviewFeedbackDto	DevicePreviewFeedbackDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateDevicePreviewFeedbackAsync(Guid, UpdateDevicePreviewFeedbackOptions, int, CancellationToken)

Update device preview feedback

Declaration

public Task<DevicePreviewFeedbackDto> UpdateDevicePreviewFeedbackAsync(Guid feedbackId, UpdateDevicePreviewFeedbackOptions updateDevicePreviewFeedbackOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<DevicePreviewFeedbackDto>	Task of DevicePreviewFeedbackDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateDevicePreviewFeedbackWithHttpInfo(Guid, UpdateDevicePreviewFeedbackOptions, int)

Update device preview feedback

Declaration

public ApiResponse<DevicePreviewFeedbackDto> UpdateDevicePreviewFeedbackWithHttpInfo(Guid feedbackId, UpdateDevicePreviewFeedbackOptions updateDevicePreviewFeedbackOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	feedbackId
UpdateDevicePreviewFeedbackOptions	updateDevicePreviewFeedbackOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<DevicePreviewFeedbackDto>	ApiResponse of DevicePreviewFeedbackDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateDevicePreviewFeedbackWithHttpInfoAsync(Guid, UpdateDevicePreviewFeedbackOptions, int, CancellationToken)

Update device preview feedback

Declaration

public Task<ApiResponse<DevicePreviewFeedbackDto>> UpdateDevicePreviewFeedbackWithHttpInfoAsync(Guid feedbackId, UpdateDevicePreviewFeedbackOptions updateDevicePreviewFeedbackOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

Implements

IDevicePreviewsControllerApi

IDevicePreviewsControllerApiSync

IDevicePreviewsControllerApiAsync

IApiAccessor