Interface IDevicePreviewsControllerApiAsync

Represents a collection of functions to interact with the API endpoints

Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public interface IDevicePreviewsControllerApiAsync : IApiAccessor

Methods

View Source

CancelDevicePreviewRunAsync(Guid, CancelDevicePreviewRunOptions, int, CancellationToken)

Cancel a running device preview run

Declaration
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

CancelDevicePreviewRunWithHttpInfoAsync(Guid, CancelDevicePreviewRunOptions, int, CancellationToken)

Cancel a running device preview run

Declaration
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

CreateDevicePreviewFeedbackAsync(CreateDevicePreviewFeedbackOptions, int, CancellationToken)

Create device preview feedback

Declaration
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

CreateDevicePreviewFeedbackWithHttpInfoAsync(CreateDevicePreviewFeedbackOptions, int, CancellationToken)

Create device preview feedback

Declaration
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

CreateDevicePreviewRunAsync(Guid, CreateDevicePreviewOptions, int, CancellationToken)

Create a new device preview run for an email

Declaration
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

CreateDevicePreviewRunWithHttpInfoAsync(Guid, CreateDevicePreviewOptions, int, CancellationToken)

Create a new device preview run for an email

Declaration
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

DeleteDevicePreviewRunAsync(Guid, int, CancellationToken)

Delete local device preview run data

Declaration
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

DeleteDevicePreviewRunWithHttpInfoAsync(Guid, int, CancellationToken)

Delete local device preview run data

Declaration
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

EnsureDevicePreviewRunAsync(Guid, CreateDevicePreviewOptions, int, CancellationToken)

Return active run for email or create one when none exists

Declaration
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

EnsureDevicePreviewRunWithHttpInfoAsync(Guid, CreateDevicePreviewOptions, int, CancellationToken)

Return active run for email or create one when none exists

Declaration
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

GetDevicePreviewFeedbackAsync(Guid, int, CancellationToken)

Get a single device preview feedback item

Declaration
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

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

List device preview feedback

Declaration
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

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

List device preview feedback

Declaration
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

GetDevicePreviewFeedbackWithHttpInfoAsync(Guid, int, CancellationToken)

Get a single device preview feedback item

Declaration
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

GetDevicePreviewRunAsync(Guid, int, CancellationToken)

Get device preview run status

Declaration
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

GetDevicePreviewRunProviderProgressAsync(Guid, string, int, CancellationToken)

Get provider-level progress for a device preview run

Declaration
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

GetDevicePreviewRunProviderProgressWithHttpInfoAsync(Guid, string, int, CancellationToken)

Get provider-level progress for a device preview run

Declaration
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

GetDevicePreviewRunResultsAsync(Guid, int, CancellationToken)

Get device preview run results

Declaration
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

GetDevicePreviewRunResultsWithHttpInfoAsync(Guid, int, CancellationToken)

Get device preview run results

Declaration
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

GetDevicePreviewRunScreenshotAsync(Guid, Guid, int, CancellationToken)

Get a seeded device preview screenshot image

Declaration
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

GetDevicePreviewRunScreenshotWithHttpInfoAsync(Guid, Guid, int, CancellationToken)

Get a seeded device preview screenshot image

Declaration
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

GetDevicePreviewRunWithHttpInfoAsync(Guid, int, CancellationToken)

Get device preview run status

Declaration
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

GetDevicePreviewRunsAsync(Guid, int?, int, CancellationToken)

List previous device preview runs for an email

Declaration
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

GetDevicePreviewRunsForAccountAsync(int?, int, CancellationToken)

List previous device preview runs for account

Declaration
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

GetDevicePreviewRunsForAccountWithHttpInfoAsync(int?, int, CancellationToken)

List previous device preview runs for account

Declaration
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

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

List previous device preview runs for an email in paginated form

Declaration
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

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

List previous device preview runs for an email in paginated form

Declaration
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

GetDevicePreviewRunsWithHttpInfoAsync(Guid, int?, int, CancellationToken)

List previous device preview runs for an email

Declaration
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

UpdateDevicePreviewFeedbackAsync(Guid, UpdateDevicePreviewFeedbackOptions, int, CancellationToken)

Update device preview feedback

Declaration
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

UpdateDevicePreviewFeedbackWithHttpInfoAsync(Guid, UpdateDevicePreviewFeedbackOptions, int, CancellationToken)

Update device preview feedback

Declaration
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