Interface IDevicePreviewsControllerApiSync

Represents a collection of functions to interact with the API endpoints

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

Methods

View Source

CancelDevicePreviewRun(Guid, CancelDevicePreviewRunOptions, int)

Cancel a running device preview run

Declaration
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

CancelDevicePreviewRunWithHttpInfo(Guid, CancelDevicePreviewRunOptions, int)

Cancel a running device preview run

Declaration
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

CreateDevicePreviewFeedback(CreateDevicePreviewFeedbackOptions, int)

Create device preview feedback

Declaration
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

CreateDevicePreviewFeedbackWithHttpInfo(CreateDevicePreviewFeedbackOptions, int)

Create device preview feedback

Declaration
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

CreateDevicePreviewRun(Guid, CreateDevicePreviewOptions, int)

Create a new device preview run for an email

Declaration
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

CreateDevicePreviewRunWithHttpInfo(Guid, CreateDevicePreviewOptions, int)

Create a new device preview run for an email

Declaration
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

DeleteDevicePreviewRun(Guid, int)

Delete local device preview run data

Declaration
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

DeleteDevicePreviewRunWithHttpInfo(Guid, int)

Delete local device preview run data

Declaration
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

EnsureDevicePreviewRun(Guid, CreateDevicePreviewOptions, int)

Return active run for email or create one when none exists

Declaration
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

EnsureDevicePreviewRunWithHttpInfo(Guid, CreateDevicePreviewOptions, int)

Return active run for email or create one when none exists

Declaration
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

GetDevicePreviewFeedback(Guid, int)

Get a single device preview feedback item

Declaration
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

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

List device preview feedback

Declaration
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

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

List device preview feedback

Declaration
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

GetDevicePreviewFeedbackWithHttpInfo(Guid, int)

Get a single device preview feedback item

Declaration
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

GetDevicePreviewRun(Guid, int)

Get device preview run status

Declaration
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

GetDevicePreviewRunProviderProgress(Guid, string, int)

Get provider-level progress for a device preview run

Declaration
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

GetDevicePreviewRunProviderProgressWithHttpInfo(Guid, string, int)

Get provider-level progress for a device preview run

Declaration
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

GetDevicePreviewRunResults(Guid, int)

Get device preview run results

Declaration
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

GetDevicePreviewRunResultsWithHttpInfo(Guid, int)

Get device preview run results

Declaration
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

GetDevicePreviewRunScreenshot(Guid, Guid, int)

Get a seeded device preview screenshot image

Declaration
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

GetDevicePreviewRunScreenshotWithHttpInfo(Guid, Guid, int)

Get a seeded device preview screenshot image

Declaration
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

GetDevicePreviewRunWithHttpInfo(Guid, int)

Get device preview run status

Declaration
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

GetDevicePreviewRuns(Guid, int?, int)

List previous device preview runs for an email

Declaration
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

GetDevicePreviewRunsForAccount(int?, int)

List previous device preview runs for account

Declaration
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

GetDevicePreviewRunsForAccountWithHttpInfo(int?, int)

List previous device preview runs for account

Declaration
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

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

List previous device preview runs for an email in paginated form

Declaration
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

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

List previous device preview runs for an email in paginated form

Declaration
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

GetDevicePreviewRunsWithHttpInfo(Guid, int?, int)

List previous device preview runs for an email

Declaration
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

UpdateDevicePreviewFeedback(Guid, UpdateDevicePreviewFeedbackOptions, int)

Update device preview feedback

Declaration
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

UpdateDevicePreviewFeedbackWithHttpInfo(Guid, UpdateDevicePreviewFeedbackOptions, int)

Update device preview feedback

Declaration
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