Class DevicePreviewsControllerApi

Hierarchy

BaseAPI
- DevicePreviewsControllerApi

Index

Constructors

Properties

Methods

Constructors

constructor

new DevicePreviewsControllerApi(configuration?: Configuration): DevicePreviewsControllerApi
Parameters
- configuration: Configuration = ...
Returns DevicePreviewsControllerApi

Inherited from BaseAPI.constructor

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

cancelDevicePreviewRun

cancelDevicePreviewRun(requestParameters: CancelDevicePreviewRunRequest, initOverrides?: RequestInit): Promise<CancelDevicePreviewRunResult>
Cancel a running device preview run
Parameters
- requestParameters: CancelDevicePreviewRunRequest
- Optional initOverrides: RequestInit
Returns Promise<CancelDevicePreviewRunResult>

cancelDevicePreviewRunRaw

cancelDevicePreviewRunRaw(requestParameters: CancelDevicePreviewRunRequest, initOverrides?: RequestInit): Promise<ApiResponse<CancelDevicePreviewRunResult>>
Cancel a running device preview run
Parameters
- requestParameters: CancelDevicePreviewRunRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<CancelDevicePreviewRunResult>>

createDevicePreviewFeedback

createDevicePreviewFeedback(requestParameters: CreateDevicePreviewFeedbackRequest, initOverrides?: RequestInit): Promise<DevicePreviewFeedbackDto>
Create device preview feedback
Parameters
- requestParameters: CreateDevicePreviewFeedbackRequest
- Optional initOverrides: RequestInit
Returns Promise<DevicePreviewFeedbackDto>

createDevicePreviewFeedbackRaw

createDevicePreviewFeedbackRaw(requestParameters: CreateDevicePreviewFeedbackRequest, initOverrides?: RequestInit): Promise<ApiResponse<DevicePreviewFeedbackDto>>
Create device preview feedback
Parameters
- requestParameters: CreateDevicePreviewFeedbackRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DevicePreviewFeedbackDto>>

createDevicePreviewImportAddress

createDevicePreviewImportAddress(requestParameters: CreateDevicePreviewImportAddressRequest, initOverrides?: RequestInit): Promise<DevicePreviewIngestAddressDto>
Create a temporary email address for device preview import
Parameters
- requestParameters: CreateDevicePreviewImportAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<DevicePreviewIngestAddressDto>

createDevicePreviewImportAddressRaw

createDevicePreviewImportAddressRaw(requestParameters: CreateDevicePreviewImportAddressRequest, initOverrides?: RequestInit): Promise<ApiResponse<DevicePreviewIngestAddressDto>>
Create a temporary email address for device preview import
Parameters
- requestParameters: CreateDevicePreviewImportAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DevicePreviewIngestAddressDto>>

createDevicePreviewProfile

createDevicePreviewProfile(requestParameters: CreateDevicePreviewProfileRequest, initOverrides?: RequestInit): Promise<DevicePreviewProfileDto>
Create a device preview profile
Parameters
- requestParameters: CreateDevicePreviewProfileRequest
- Optional initOverrides: RequestInit
Returns Promise<DevicePreviewProfileDto>

createDevicePreviewProfileRaw

createDevicePreviewProfileRaw(requestParameters: CreateDevicePreviewProfileRequest, initOverrides?: RequestInit): Promise<ApiResponse<DevicePreviewProfileDto>>
Create a device preview profile
Parameters
- requestParameters: CreateDevicePreviewProfileRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DevicePreviewProfileDto>>

createDevicePreviewRun

createDevicePreviewRun(requestParameters: CreateDevicePreviewRunRequest, initOverrides?: RequestInit): Promise<CreateDevicePreviewRunResult>
Create a new device preview run for an email
Parameters
- requestParameters: CreateDevicePreviewRunRequest
- Optional initOverrides: RequestInit
Returns Promise<CreateDevicePreviewRunResult>

createDevicePreviewRunFromFile

createDevicePreviewRunFromFile(requestParameters: CreateDevicePreviewRunFromFileRequest, initOverrides?: RequestInit): Promise<CreateDevicePreviewRunResult>
Uploads an HTML or RFC822 EML file, or a ZIP archive containing exactly one HTML or EML file. ZIP uploads are bounded by entry count, expanded size, and compression ratio. Create a device preview run from an HTML, EML, or ZIP file
Parameters
- requestParameters: CreateDevicePreviewRunFromFileRequest
- Optional initOverrides: RequestInit
Returns Promise<CreateDevicePreviewRunResult>

createDevicePreviewRunFromFileRaw

createDevicePreviewRunFromFileRaw(requestParameters: CreateDevicePreviewRunFromFileRequest, initOverrides?: RequestInit): Promise<ApiResponse<CreateDevicePreviewRunResult>>
Uploads an HTML or RFC822 EML file, or a ZIP archive containing exactly one HTML or EML file. ZIP uploads are bounded by entry count, expanded size, and compression ratio. Create a device preview run from an HTML, EML, or ZIP file
Parameters
- requestParameters: CreateDevicePreviewRunFromFileRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<CreateDevicePreviewRunResult>>

createDevicePreviewRunFromHtmlImport

createDevicePreviewRunFromHtmlImport(requestParameters: CreateDevicePreviewRunFromHtmlImportRequest, initOverrides?: RequestInit): Promise<CreateDevicePreviewRunResult>
Create a device preview run from HTML
Parameters
- requestParameters: CreateDevicePreviewRunFromHtmlImportRequest
- Optional initOverrides: RequestInit
Returns Promise<CreateDevicePreviewRunResult>

createDevicePreviewRunFromHtmlImportRaw

createDevicePreviewRunFromHtmlImportRaw(requestParameters: CreateDevicePreviewRunFromHtmlImportRequest, initOverrides?: RequestInit): Promise<ApiResponse<CreateDevicePreviewRunResult>>
Create a device preview run from HTML
Parameters
- requestParameters: CreateDevicePreviewRunFromHtmlImportRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<CreateDevicePreviewRunResult>>

createDevicePreviewRunFromImport

createDevicePreviewRunFromImport(requestParameters: CreateDevicePreviewRunFromImportRequest, initOverrides?: RequestInit): Promise<CreateDevicePreviewRunResult>
Create a device preview run from imported raw MIME
Parameters
- requestParameters: CreateDevicePreviewRunFromImportRequest
- Optional initOverrides: RequestInit
Returns Promise<CreateDevicePreviewRunResult>

createDevicePreviewRunFromImportRaw

createDevicePreviewRunFromImportRaw(requestParameters: CreateDevicePreviewRunFromImportRequest, initOverrides?: RequestInit): Promise<ApiResponse<CreateDevicePreviewRunResult>>
Create a device preview run from imported raw MIME
Parameters
- requestParameters: CreateDevicePreviewRunFromImportRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<CreateDevicePreviewRunResult>>

createDevicePreviewRunFromMultipartImport

createDevicePreviewRunFromMultipartImport(requestParameters: CreateDevicePreviewRunFromMultipartImportRequest, initOverrides?: RequestInit): Promise<CreateDevicePreviewRunResult>
Create a device preview run from multipart EML upload
Parameters
- requestParameters: CreateDevicePreviewRunFromMultipartImportRequest
- Optional initOverrides: RequestInit
Returns Promise<CreateDevicePreviewRunResult>

createDevicePreviewRunFromMultipartImportRaw

createDevicePreviewRunFromMultipartImportRaw(requestParameters: CreateDevicePreviewRunFromMultipartImportRequest, initOverrides?: RequestInit): Promise<ApiResponse<CreateDevicePreviewRunResult>>
Create a device preview run from multipart EML upload
Parameters
- requestParameters: CreateDevicePreviewRunFromMultipartImportRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<CreateDevicePreviewRunResult>>

createDevicePreviewRunFromRawImport

createDevicePreviewRunFromRawImport(requestParameters: CreateDevicePreviewRunFromRawImportRequest, initOverrides?: RequestInit): Promise<CreateDevicePreviewRunResult>
Create a device preview run from raw MIME bytes
Parameters
- requestParameters: CreateDevicePreviewRunFromRawImportRequest
- Optional initOverrides: RequestInit
Returns Promise<CreateDevicePreviewRunResult>

createDevicePreviewRunFromRawImportRaw

createDevicePreviewRunFromRawImportRaw(requestParameters: CreateDevicePreviewRunFromRawImportRequest, initOverrides?: RequestInit): Promise<ApiResponse<CreateDevicePreviewRunResult>>
Create a device preview run from raw MIME bytes
Parameters
- requestParameters: CreateDevicePreviewRunFromRawImportRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<CreateDevicePreviewRunResult>>

createDevicePreviewRunRaw

createDevicePreviewRunRaw(requestParameters: CreateDevicePreviewRunRequest, initOverrides?: RequestInit): Promise<ApiResponse<CreateDevicePreviewRunResult>>
Create a new device preview run for an email
Parameters
- requestParameters: CreateDevicePreviewRunRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<CreateDevicePreviewRunResult>>

createDevicePreviewShareLink

createDevicePreviewShareLink(requestParameters: CreateDevicePreviewShareLinkRequest, initOverrides?: RequestInit): Promise<DevicePreviewShareLinkDto>
Create a share link for a device preview run
Parameters
- requestParameters: CreateDevicePreviewShareLinkRequest
- Optional initOverrides: RequestInit
Returns Promise<DevicePreviewShareLinkDto>

createDevicePreviewShareLinkRaw

createDevicePreviewShareLinkRaw(requestParameters: CreateDevicePreviewShareLinkRequest, initOverrides?: RequestInit): Promise<ApiResponse<DevicePreviewShareLinkDto>>
Create a share link for a device preview run
Parameters
- requestParameters: CreateDevicePreviewShareLinkRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DevicePreviewShareLinkDto>>

deleteDevicePreviewProfile

deleteDevicePreviewProfile(requestParameters: DeleteDevicePreviewProfileRequest, initOverrides?: RequestInit): Promise<DeleteDevicePreviewProfileResult>
Delete a device preview profile
Parameters
- requestParameters: DeleteDevicePreviewProfileRequest
- Optional initOverrides: RequestInit
Returns Promise<DeleteDevicePreviewProfileResult>

deleteDevicePreviewProfileRaw

deleteDevicePreviewProfileRaw(requestParameters: DeleteDevicePreviewProfileRequest, initOverrides?: RequestInit): Promise<ApiResponse<DeleteDevicePreviewProfileResult>>
Delete a device preview profile
Parameters
- requestParameters: DeleteDevicePreviewProfileRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DeleteDevicePreviewProfileResult>>

deleteDevicePreviewRun

deleteDevicePreviewRun(requestParameters: DeleteDevicePreviewRunRequest, initOverrides?: RequestInit): Promise<DeleteDevicePreviewRunResult>
Delete local device preview run data
Parameters
- requestParameters: DeleteDevicePreviewRunRequest
- Optional initOverrides: RequestInit
Returns Promise<DeleteDevicePreviewRunResult>

deleteDevicePreviewRunRaw

deleteDevicePreviewRunRaw(requestParameters: DeleteDevicePreviewRunRequest, initOverrides?: RequestInit): Promise<ApiResponse<DeleteDevicePreviewRunResult>>
Delete local device preview run data
Parameters
- requestParameters: DeleteDevicePreviewRunRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DeleteDevicePreviewRunResult>>

deleteDevicePreviewShareLink

deleteDevicePreviewShareLink(requestParameters: DeleteDevicePreviewShareLinkRequest, initOverrides?: RequestInit): Promise<DeleteDevicePreviewShareLinkResult>
Revoke a device preview share link
Parameters
- requestParameters: DeleteDevicePreviewShareLinkRequest
- Optional initOverrides: RequestInit
Returns Promise<DeleteDevicePreviewShareLinkResult>

deleteDevicePreviewShareLinkRaw

deleteDevicePreviewShareLinkRaw(requestParameters: DeleteDevicePreviewShareLinkRequest, initOverrides?: RequestInit): Promise<ApiResponse<DeleteDevicePreviewShareLinkResult>>
Revoke a device preview share link
Parameters
- requestParameters: DeleteDevicePreviewShareLinkRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DeleteDevicePreviewShareLinkResult>>

downloadDevicePreviewEmailSubmissionSourceEmail

downloadDevicePreviewEmailSubmissionSourceEmail(requestParameters: DownloadDevicePreviewEmailSubmissionSourceEmailRequest, initOverrides?: RequestInit): Promise<Blob>
Download the original RFC822 email for a device preview submission
Parameters
- requestParameters: DownloadDevicePreviewEmailSubmissionSourceEmailRequest
- Optional initOverrides: RequestInit
Returns Promise<Blob>

downloadDevicePreviewEmailSubmissionSourceEmailRaw

downloadDevicePreviewEmailSubmissionSourceEmailRaw(requestParameters: DownloadDevicePreviewEmailSubmissionSourceEmailRequest, initOverrides?: RequestInit): Promise<ApiResponse<Blob>>
Download the original RFC822 email for a device preview submission
Parameters
- requestParameters: DownloadDevicePreviewEmailSubmissionSourceEmailRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<Blob>>

downloadDevicePreviewRunSourceEmail

downloadDevicePreviewRunSourceEmail(requestParameters: DownloadDevicePreviewRunSourceEmailRequest, initOverrides?: RequestInit): Promise<Blob>
Download the original RFC822 email for a device preview run
Parameters
- requestParameters: DownloadDevicePreviewRunSourceEmailRequest
- Optional initOverrides: RequestInit
Returns Promise<Blob>

downloadDevicePreviewRunSourceEmailRaw

downloadDevicePreviewRunSourceEmailRaw(requestParameters: DownloadDevicePreviewRunSourceEmailRequest, initOverrides?: RequestInit): Promise<ApiResponse<Blob>>
Download the original RFC822 email for a device preview run
Parameters
- requestParameters: DownloadDevicePreviewRunSourceEmailRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<Blob>>

ensureDevicePreviewRun

ensureDevicePreviewRun(requestParameters: EnsureDevicePreviewRunRequest, initOverrides?: RequestInit): Promise<CreateDevicePreviewRunResult>
Return active run for email or create one when none exists
Parameters
- requestParameters: EnsureDevicePreviewRunRequest
- Optional initOverrides: RequestInit
Returns Promise<CreateDevicePreviewRunResult>

ensureDevicePreviewRunRaw

ensureDevicePreviewRunRaw(requestParameters: EnsureDevicePreviewRunRequest, initOverrides?: RequestInit): Promise<ApiResponse<CreateDevicePreviewRunResult>>
Return active run for email or create one when none exists
Parameters
- requestParameters: EnsureDevicePreviewRunRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<CreateDevicePreviewRunResult>>

getDevicePreviewEmailDomainOrCreate

getDevicePreviewEmailDomainOrCreate(initOverrides?: RequestInit): Promise<DevicePreviewAccountSettingsDto>
Return account device preview email domain setup or create one
Parameters
- Optional initOverrides: RequestInit
Returns Promise<DevicePreviewAccountSettingsDto>

getDevicePreviewEmailDomainOrCreateRaw

getDevicePreviewEmailDomainOrCreateRaw(initOverrides?: RequestInit): Promise<ApiResponse<DevicePreviewAccountSettingsDto>>
Return account device preview email domain setup or create one
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DevicePreviewAccountSettingsDto>>

getDevicePreviewEmailRuns

getDevicePreviewEmailRuns(requestParameters: GetDevicePreviewEmailRunsRequest, initOverrides?: RequestInit): Promise<DevicePreviewRunDto[]>
List device preview runs created from account email domains
Parameters
- requestParameters: GetDevicePreviewEmailRunsRequest
- Optional initOverrides: RequestInit
Returns Promise<DevicePreviewRunDto[]>

getDevicePreviewEmailRunsRaw

getDevicePreviewEmailRunsRaw(requestParameters: GetDevicePreviewEmailRunsRequest, initOverrides?: RequestInit): Promise<ApiResponse<DevicePreviewRunDto[]>>
List device preview runs created from account email domains
Parameters
- requestParameters: GetDevicePreviewEmailRunsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DevicePreviewRunDto[]>>

getDevicePreviewEmailSubmissionSourceEmail

getDevicePreviewEmailSubmissionSourceEmail(requestParameters: GetDevicePreviewEmailSubmissionSourceEmailRequest, initOverrides?: RequestInit): Promise<DevicePreviewSourceEmailDto>
Get the original email content for a device preview submission
Parameters
- requestParameters: GetDevicePreviewEmailSubmissionSourceEmailRequest
- Optional initOverrides: RequestInit
Returns Promise<DevicePreviewSourceEmailDto>

getDevicePreviewEmailSubmissionSourceEmailRaw

getDevicePreviewEmailSubmissionSourceEmailRaw(requestParameters: GetDevicePreviewEmailSubmissionSourceEmailRequest, initOverrides?: RequestInit): Promise<ApiResponse<DevicePreviewSourceEmailDto>>
Get the original email content for a device preview submission
Parameters
- requestParameters: GetDevicePreviewEmailSubmissionSourceEmailRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DevicePreviewSourceEmailDto>>

getDevicePreviewEmailSubmissions

getDevicePreviewEmailSubmissions(requestParameters: GetDevicePreviewEmailSubmissionsRequest, initOverrides?: RequestInit): Promise<DevicePreviewEmailSubmissionDto[]>
List received device preview email submissions
Parameters
- requestParameters: GetDevicePreviewEmailSubmissionsRequest
- Optional initOverrides: RequestInit
Returns Promise<DevicePreviewEmailSubmissionDto[]>

getDevicePreviewEmailSubmissionsRaw

getDevicePreviewEmailSubmissionsRaw(requestParameters: GetDevicePreviewEmailSubmissionsRequest, initOverrides?: RequestInit): Promise<ApiResponse<DevicePreviewEmailSubmissionDto[]>>
List received device preview email submissions
Parameters
- requestParameters: GetDevicePreviewEmailSubmissionsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DevicePreviewEmailSubmissionDto[]>>

getDevicePreviewFeedback

getDevicePreviewFeedback(requestParameters: GetDevicePreviewFeedbackRequest, initOverrides?: RequestInit): Promise<DevicePreviewFeedbackDto>
Get a single device preview feedback item
Parameters
- requestParameters: GetDevicePreviewFeedbackRequest
- Optional initOverrides: RequestInit
Returns Promise<DevicePreviewFeedbackDto>

getDevicePreviewFeedbackItems

getDevicePreviewFeedbackItems(requestParameters: GetDevicePreviewFeedbackItemsRequest, initOverrides?: RequestInit): Promise<DevicePreviewFeedbackListDto>
List device preview feedback
Parameters
- requestParameters: GetDevicePreviewFeedbackItemsRequest
- Optional initOverrides: RequestInit
Returns Promise<DevicePreviewFeedbackListDto>

getDevicePreviewFeedbackItemsRaw

getDevicePreviewFeedbackItemsRaw(requestParameters: GetDevicePreviewFeedbackItemsRequest, initOverrides?: RequestInit): Promise<ApiResponse<DevicePreviewFeedbackListDto>>
List device preview feedback
Parameters
- requestParameters: GetDevicePreviewFeedbackItemsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DevicePreviewFeedbackListDto>>

getDevicePreviewFeedbackRaw

getDevicePreviewFeedbackRaw(requestParameters: GetDevicePreviewFeedbackRequest, initOverrides?: RequestInit): Promise<ApiResponse<DevicePreviewFeedbackDto>>
Get a single device preview feedback item
Parameters
- requestParameters: GetDevicePreviewFeedbackRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DevicePreviewFeedbackDto>>

getDevicePreviewImportAddress

getDevicePreviewImportAddress(requestParameters: GetDevicePreviewImportAddressRequest, initOverrides?: RequestInit): Promise<DevicePreviewIngestAddressDto>
Get temporary device preview import address status
Parameters
- requestParameters: GetDevicePreviewImportAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<DevicePreviewIngestAddressDto>

getDevicePreviewImportAddressRaw

getDevicePreviewImportAddressRaw(requestParameters: GetDevicePreviewImportAddressRequest, initOverrides?: RequestInit): Promise<ApiResponse<DevicePreviewIngestAddressDto>>
Get temporary device preview import address status
Parameters
- requestParameters: GetDevicePreviewImportAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DevicePreviewIngestAddressDto>>

getDevicePreviewNativeTargetAvailability

getDevicePreviewNativeTargetAvailability(initOverrides?: RequestInit): Promise<DevicePreviewNativeTargetAvailabilityListDto>
Returns live native device preview target availability for authenticated API clients, including worker health, queue, timeout, and status fields. Use /device-preview-targets when you need the stable catalog without transient availability data. Get native device preview target availability
Parameters
- Optional initOverrides: RequestInit
Returns Promise<DevicePreviewNativeTargetAvailabilityListDto>

getDevicePreviewNativeTargetAvailabilityRaw

getDevicePreviewNativeTargetAvailabilityRaw(initOverrides?: RequestInit): Promise<ApiResponse<DevicePreviewNativeTargetAvailabilityListDto>>
Returns live native device preview target availability for authenticated API clients, including worker health, queue, timeout, and status fields. Use /device-preview-targets when you need the stable catalog without transient availability data. Get native device preview target availability
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DevicePreviewNativeTargetAvailabilityListDto>>

getDevicePreviewProfile

getDevicePreviewProfile(requestParameters: GetDevicePreviewProfileRequest, initOverrides?: RequestInit): Promise<DevicePreviewProfileDto>
Get a device preview profile
Parameters
- requestParameters: GetDevicePreviewProfileRequest
- Optional initOverrides: RequestInit
Returns Promise<DevicePreviewProfileDto>

getDevicePreviewProfileRaw

getDevicePreviewProfileRaw(requestParameters: GetDevicePreviewProfileRequest, initOverrides?: RequestInit): Promise<ApiResponse<DevicePreviewProfileDto>>
Get a device preview profile
Parameters
- requestParameters: GetDevicePreviewProfileRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DevicePreviewProfileDto>>

getDevicePreviewProfiles

getDevicePreviewProfiles(initOverrides?: RequestInit): Promise<DevicePreviewProfileDto[]>
List device preview profiles
Parameters
- Optional initOverrides: RequestInit
Returns Promise<DevicePreviewProfileDto[]>

getDevicePreviewProfilesRaw

getDevicePreviewProfilesRaw(initOverrides?: RequestInit): Promise<ApiResponse<DevicePreviewProfileDto[]>>
List device preview profiles
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DevicePreviewProfileDto[]>>

getDevicePreviewRun

getDevicePreviewRun(requestParameters: GetDevicePreviewRunRequest, initOverrides?: RequestInit): Promise<DevicePreviewRunDto>
Get device preview run status
Parameters
- requestParameters: GetDevicePreviewRunRequest
- Optional initOverrides: RequestInit
Returns Promise<DevicePreviewRunDto>

getDevicePreviewRunProviderProgress

getDevicePreviewRunProviderProgress(requestParameters: GetDevicePreviewRunProviderProgressRequest, initOverrides?: RequestInit): Promise<DevicePreviewProviderProgressDto>
Get provider-level progress for a device preview run
Parameters
- requestParameters: GetDevicePreviewRunProviderProgressRequest
- Optional initOverrides: RequestInit
Returns Promise<DevicePreviewProviderProgressDto>

getDevicePreviewRunProviderProgressRaw

getDevicePreviewRunProviderProgressRaw(requestParameters: GetDevicePreviewRunProviderProgressRequest, initOverrides?: RequestInit): Promise<ApiResponse<DevicePreviewProviderProgressDto>>
Get provider-level progress for a device preview run
Parameters
- requestParameters: GetDevicePreviewRunProviderProgressRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DevicePreviewProviderProgressDto>>

getDevicePreviewRunRaw

getDevicePreviewRunRaw(requestParameters: GetDevicePreviewRunRequest, initOverrides?: RequestInit): Promise<ApiResponse<DevicePreviewRunDto>>
Get device preview run status
Parameters
- requestParameters: GetDevicePreviewRunRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DevicePreviewRunDto>>

getDevicePreviewRunResults

getDevicePreviewRunResults(requestParameters: GetDevicePreviewRunResultsRequest, initOverrides?: RequestInit): Promise<DevicePreviewRunResultsDto>
Get device preview run results
Parameters
- requestParameters: GetDevicePreviewRunResultsRequest
- Optional initOverrides: RequestInit
Returns Promise<DevicePreviewRunResultsDto>

getDevicePreviewRunResultsRaw

getDevicePreviewRunResultsRaw(requestParameters: GetDevicePreviewRunResultsRequest, initOverrides?: RequestInit): Promise<ApiResponse<DevicePreviewRunResultsDto>>
Get device preview run results
Parameters
- requestParameters: GetDevicePreviewRunResultsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DevicePreviewRunResultsDto>>

getDevicePreviewRunScreenshot

getDevicePreviewRunScreenshot(requestParameters: GetDevicePreviewRunScreenshotRequest, initOverrides?: RequestInit): Promise<string>
Get a device preview screenshot image
Parameters
- requestParameters: GetDevicePreviewRunScreenshotRequest
- Optional initOverrides: RequestInit
Returns Promise<string>

getDevicePreviewRunScreenshotRaw

getDevicePreviewRunScreenshotRaw(requestParameters: GetDevicePreviewRunScreenshotRequest, initOverrides?: RequestInit): Promise<ApiResponse<string>>
Get a device preview screenshot image
Parameters
- requestParameters: GetDevicePreviewRunScreenshotRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<string>>

getDevicePreviewRunSourceEmail

getDevicePreviewRunSourceEmail(requestParameters: GetDevicePreviewRunSourceEmailRequest, initOverrides?: RequestInit): Promise<DevicePreviewSourceEmailDto>
Get the original email content for a device preview run
Parameters
- requestParameters: GetDevicePreviewRunSourceEmailRequest
- Optional initOverrides: RequestInit
Returns Promise<DevicePreviewSourceEmailDto>

getDevicePreviewRunSourceEmailRaw

getDevicePreviewRunSourceEmailRaw(requestParameters: GetDevicePreviewRunSourceEmailRequest, initOverrides?: RequestInit): Promise<ApiResponse<DevicePreviewSourceEmailDto>>
Get the original email content for a device preview run
Parameters
- requestParameters: GetDevicePreviewRunSourceEmailRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DevicePreviewSourceEmailDto>>

getDevicePreviewRuns

getDevicePreviewRuns(requestParameters: GetDevicePreviewRunsRequest, initOverrides?: RequestInit): Promise<DevicePreviewRunDto[]>
List previous device preview runs for an email
Parameters
- requestParameters: GetDevicePreviewRunsRequest
- Optional initOverrides: RequestInit
Returns Promise<DevicePreviewRunDto[]>

getDevicePreviewRunsForAccount

getDevicePreviewRunsForAccount(requestParameters: GetDevicePreviewRunsForAccountRequest, initOverrides?: RequestInit): Promise<DevicePreviewRunDto[]>
List previous device preview runs for account
Parameters
- requestParameters: GetDevicePreviewRunsForAccountRequest
- Optional initOverrides: RequestInit
Returns Promise<DevicePreviewRunDto[]>

getDevicePreviewRunsForAccountOffsetPaginated

getDevicePreviewRunsForAccountOffsetPaginated(requestParameters: GetDevicePreviewRunsForAccountOffsetPaginatedRequest, initOverrides?: RequestInit): Promise<PageDevicePreviewRunProjection>
List previous device preview runs for account in paginated form
Parameters
- requestParameters: GetDevicePreviewRunsForAccountOffsetPaginatedRequest
- Optional initOverrides: RequestInit
Returns Promise<PageDevicePreviewRunProjection>

getDevicePreviewRunsForAccountOffsetPaginatedRaw

getDevicePreviewRunsForAccountOffsetPaginatedRaw(requestParameters: GetDevicePreviewRunsForAccountOffsetPaginatedRequest, initOverrides?: RequestInit): Promise<ApiResponse<PageDevicePreviewRunProjection>>
List previous device preview runs for account in paginated form
Parameters
- requestParameters: GetDevicePreviewRunsForAccountOffsetPaginatedRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PageDevicePreviewRunProjection>>

getDevicePreviewRunsForAccountRaw

getDevicePreviewRunsForAccountRaw(requestParameters: GetDevicePreviewRunsForAccountRequest, initOverrides?: RequestInit): Promise<ApiResponse<DevicePreviewRunDto[]>>
List previous device preview runs for account
Parameters
- requestParameters: GetDevicePreviewRunsForAccountRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DevicePreviewRunDto[]>>

getDevicePreviewRunsOffsetPaginated

getDevicePreviewRunsOffsetPaginated(requestParameters: GetDevicePreviewRunsOffsetPaginatedRequest, initOverrides?: RequestInit): Promise<PageDevicePreviewRunProjection>
List previous device preview runs for an email in paginated form
Parameters
- requestParameters: GetDevicePreviewRunsOffsetPaginatedRequest
- Optional initOverrides: RequestInit
Returns Promise<PageDevicePreviewRunProjection>

getDevicePreviewRunsOffsetPaginatedRaw

getDevicePreviewRunsOffsetPaginatedRaw(requestParameters: GetDevicePreviewRunsOffsetPaginatedRequest, initOverrides?: RequestInit): Promise<ApiResponse<PageDevicePreviewRunProjection>>
List previous device preview runs for an email in paginated form
Parameters
- requestParameters: GetDevicePreviewRunsOffsetPaginatedRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PageDevicePreviewRunProjection>>

getDevicePreviewRunsRaw

getDevicePreviewRunsRaw(requestParameters: GetDevicePreviewRunsRequest, initOverrides?: RequestInit): Promise<ApiResponse<DevicePreviewRunDto[]>>
List previous device preview runs for an email
Parameters
- requestParameters: GetDevicePreviewRunsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DevicePreviewRunDto[]>>

getDevicePreviewShareLinks

getDevicePreviewShareLinks(requestParameters: GetDevicePreviewShareLinksRequest, initOverrides?: RequestInit): Promise<DevicePreviewShareLinkDto[]>
List share links for a device preview run
Parameters
- requestParameters: GetDevicePreviewShareLinksRequest
- Optional initOverrides: RequestInit
Returns Promise<DevicePreviewShareLinkDto[]>

getDevicePreviewShareLinksRaw

getDevicePreviewShareLinksRaw(requestParameters: GetDevicePreviewShareLinksRequest, initOverrides?: RequestInit): Promise<ApiResponse<DevicePreviewShareLinkDto[]>>
List share links for a device preview run
Parameters
- requestParameters: GetDevicePreviewShareLinksRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DevicePreviewShareLinkDto[]>>

getDevicePreviewSharedResult

getDevicePreviewSharedResult(requestParameters: GetDevicePreviewSharedResultRequest, initOverrides?: RequestInit): Promise<DevicePreviewSharedResultDto>
Get a public shared device preview result
Parameters
- requestParameters: GetDevicePreviewSharedResultRequest
- Optional initOverrides: RequestInit
Returns Promise<DevicePreviewSharedResultDto>

getDevicePreviewSharedResultRaw

getDevicePreviewSharedResultRaw(requestParameters: GetDevicePreviewSharedResultRequest, initOverrides?: RequestInit): Promise<ApiResponse<DevicePreviewSharedResultDto>>
Get a public shared device preview result
Parameters
- requestParameters: GetDevicePreviewSharedResultRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DevicePreviewSharedResultDto>>

getDevicePreviewSharedResultScreenshot

getDevicePreviewSharedResultScreenshot(requestParameters: GetDevicePreviewSharedResultScreenshotRequest, initOverrides?: RequestInit): Promise<string>
Get a public shared device preview screenshot image
Parameters
- requestParameters: GetDevicePreviewSharedResultScreenshotRequest
- Optional initOverrides: RequestInit
Returns Promise<string>

getDevicePreviewSharedResultScreenshotRaw

getDevicePreviewSharedResultScreenshotRaw(requestParameters: GetDevicePreviewSharedResultScreenshotRequest, initOverrides?: RequestInit): Promise<ApiResponse<string>>
Get a public shared device preview screenshot image
Parameters
- requestParameters: GetDevicePreviewSharedResultScreenshotRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<string>>

getDevicePreviewTargets

getDevicePreviewTargets(initOverrides?: RequestInit): Promise<DevicePreviewNativeTargetListDto>
Returns visible native device preview target metadata without worker availability, queue, or health fields. List device preview targets
Parameters
- Optional initOverrides: RequestInit
Returns Promise<DevicePreviewNativeTargetListDto>

getDevicePreviewTargetsRaw

getDevicePreviewTargetsRaw(initOverrides?: RequestInit): Promise<ApiResponse<DevicePreviewNativeTargetListDto>>
Returns visible native device preview target metadata without worker availability, queue, or health fields. List device preview targets
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DevicePreviewNativeTargetListDto>>

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit
Returns Promise<Response>

Inherited from BaseAPI.request

rerunDevicePreviewTargets

rerunDevicePreviewTargets(requestParameters: RerunDevicePreviewTargetsRequest, initOverrides?: RequestInit): Promise<RerunDevicePreviewTargetsResult>
Set failedOnly=false to rerun a successful target. Successful targets consume their configured credit cost again. Rerun selected device preview targets in the same run
Parameters
- requestParameters: RerunDevicePreviewTargetsRequest
- Optional initOverrides: RequestInit
Returns Promise<RerunDevicePreviewTargetsResult>

rerunDevicePreviewTargetsRaw

rerunDevicePreviewTargetsRaw(requestParameters: RerunDevicePreviewTargetsRequest, initOverrides?: RequestInit): Promise<ApiResponse<RerunDevicePreviewTargetsResult>>
Set failedOnly=false to rerun a successful target. Successful targets consume their configured credit cost again. Rerun selected device preview targets in the same run
Parameters
- requestParameters: RerunDevicePreviewTargetsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<RerunDevicePreviewTargetsResult>>

updateDevicePreviewEmailDomainSubdomain

updateDevicePreviewEmailDomainSubdomain(requestParameters: UpdateDevicePreviewEmailDomainSubdomainRequest, initOverrides?: RequestInit): Promise<DevicePreviewAccountSettingsDto>
Update account device preview email subdomain
Parameters
- requestParameters: UpdateDevicePreviewEmailDomainSubdomainRequest
- Optional initOverrides: RequestInit
Returns Promise<DevicePreviewAccountSettingsDto>

updateDevicePreviewEmailDomainSubdomainRaw

updateDevicePreviewEmailDomainSubdomainRaw(requestParameters: UpdateDevicePreviewEmailDomainSubdomainRequest, initOverrides?: RequestInit): Promise<ApiResponse<DevicePreviewAccountSettingsDto>>
Update account device preview email subdomain
Parameters
- requestParameters: UpdateDevicePreviewEmailDomainSubdomainRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DevicePreviewAccountSettingsDto>>

updateDevicePreviewFeedback

updateDevicePreviewFeedback(requestParameters: UpdateDevicePreviewFeedbackRequest, initOverrides?: RequestInit): Promise<DevicePreviewFeedbackDto>
Update device preview feedback
Parameters
- requestParameters: UpdateDevicePreviewFeedbackRequest
- Optional initOverrides: RequestInit
Returns Promise<DevicePreviewFeedbackDto>

updateDevicePreviewFeedbackRaw

updateDevicePreviewFeedbackRaw(requestParameters: UpdateDevicePreviewFeedbackRequest, initOverrides?: RequestInit): Promise<ApiResponse<DevicePreviewFeedbackDto>>
Update device preview feedback
Parameters
- requestParameters: UpdateDevicePreviewFeedbackRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DevicePreviewFeedbackDto>>

updateDevicePreviewProfile

updateDevicePreviewProfile(requestParameters: UpdateDevicePreviewProfileRequest, initOverrides?: RequestInit): Promise<DevicePreviewProfileDto>
Update a device preview profile
Parameters
- requestParameters: UpdateDevicePreviewProfileRequest
- Optional initOverrides: RequestInit
Returns Promise<DevicePreviewProfileDto>

updateDevicePreviewProfileRaw

updateDevicePreviewProfileRaw(requestParameters: UpdateDevicePreviewProfileRequest, initOverrides?: RequestInit): Promise<ApiResponse<DevicePreviewProfileDto>>
Update a device preview profile
Parameters
- requestParameters: UpdateDevicePreviewProfileRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DevicePreviewProfileDto>>

waitForDevicePreviewEmailRuns

waitForDevicePreviewEmailRuns(requestParameters: WaitForDevicePreviewEmailRunsRequest, initOverrides?: RequestInit): Promise<DevicePreviewIngestRunWaitResult>
Wait for device preview runs created from account email domains
Parameters
- requestParameters: WaitForDevicePreviewEmailRunsRequest
- Optional initOverrides: RequestInit
Returns Promise<DevicePreviewIngestRunWaitResult>

waitForDevicePreviewEmailRunsRaw

waitForDevicePreviewEmailRunsRaw(requestParameters: WaitForDevicePreviewEmailRunsRequest, initOverrides?: RequestInit): Promise<ApiResponse<DevicePreviewIngestRunWaitResult>>
Wait for device preview runs created from account email domains
Parameters
- requestParameters: WaitForDevicePreviewEmailRunsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DevicePreviewIngestRunWaitResult>>

waitForDevicePreviewEmailSubmissions

waitForDevicePreviewEmailSubmissions(requestParameters: WaitForDevicePreviewEmailSubmissionsRequest, initOverrides?: RequestInit): Promise<DevicePreviewEmailSubmissionWaitResult>
Wait for received device preview email submissions
Parameters
- requestParameters: WaitForDevicePreviewEmailSubmissionsRequest
- Optional initOverrides: RequestInit
Returns Promise<DevicePreviewEmailSubmissionWaitResult>

waitForDevicePreviewEmailSubmissionsRaw

waitForDevicePreviewEmailSubmissionsRaw(requestParameters: WaitForDevicePreviewEmailSubmissionsRequest, initOverrides?: RequestInit): Promise<ApiResponse<DevicePreviewEmailSubmissionWaitResult>>
Wait for received device preview email submissions
Parameters
- requestParameters: WaitForDevicePreviewEmailSubmissionsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DevicePreviewEmailSubmissionWaitResult>>

waitForDevicePreviewRun

waitForDevicePreviewRun(requestParameters: WaitForDevicePreviewRunRequest, initOverrides?: RequestInit): Promise<DevicePreviewRunWaitResult>
Wait for device preview run to complete
Parameters
- requestParameters: WaitForDevicePreviewRunRequest
- Optional initOverrides: RequestInit
Returns Promise<DevicePreviewRunWaitResult>

waitForDevicePreviewRunRaw

waitForDevicePreviewRunRaw(requestParameters: WaitForDevicePreviewRunRequest, initOverrides?: RequestInit): Promise<ApiResponse<DevicePreviewRunWaitResult>>
Wait for device preview run to complete
Parameters
- requestParameters: WaitForDevicePreviewRunRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<DevicePreviewRunWaitResult>>

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T

Inherited from BaseAPI.withMiddleware

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T

Inherited from BaseAPI.withPostMiddleware

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T

Inherited from BaseAPI.withPreMiddleware

Class DevicePreviewsControllerApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = ...

Returns DevicePreviewsControllerApi

Properties

Protected configuration

Methods

cancelDevicePreviewRun

Parameters

requestParameters: CancelDevicePreviewRunRequest

Optional initOverrides: RequestInit

Returns Promise<CancelDevicePreviewRunResult>

cancelDevicePreviewRunRaw

Parameters

requestParameters: CancelDevicePreviewRunRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<CancelDevicePreviewRunResult>>

createDevicePreviewFeedback

Parameters

requestParameters: CreateDevicePreviewFeedbackRequest

Optional initOverrides: RequestInit

Returns Promise<DevicePreviewFeedbackDto>

createDevicePreviewFeedbackRaw

Parameters

requestParameters: CreateDevicePreviewFeedbackRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<DevicePreviewFeedbackDto>>

createDevicePreviewImportAddress

Parameters

requestParameters: CreateDevicePreviewImportAddressRequest

Optional initOverrides: RequestInit

Returns Promise<DevicePreviewIngestAddressDto>

createDevicePreviewImportAddressRaw

Parameters

requestParameters: CreateDevicePreviewImportAddressRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<DevicePreviewIngestAddressDto>>

createDevicePreviewProfile

Parameters

requestParameters: CreateDevicePreviewProfileRequest

Optional initOverrides: RequestInit

Returns Promise<DevicePreviewProfileDto>

createDevicePreviewProfileRaw

Parameters

requestParameters: CreateDevicePreviewProfileRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<DevicePreviewProfileDto>>

createDevicePreviewRun

Parameters

requestParameters: CreateDevicePreviewRunRequest

Optional initOverrides: RequestInit

Returns Promise<CreateDevicePreviewRunResult>

createDevicePreviewRunFromFile

Parameters

requestParameters: CreateDevicePreviewRunFromFileRequest

Optional initOverrides: RequestInit

Returns Promise<CreateDevicePreviewRunResult>

createDevicePreviewRunFromFileRaw

Parameters

requestParameters: CreateDevicePreviewRunFromFileRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<CreateDevicePreviewRunResult>>

createDevicePreviewRunFromHtmlImport

Parameters

requestParameters: CreateDevicePreviewRunFromHtmlImportRequest

Optional initOverrides: RequestInit

Returns Promise<CreateDevicePreviewRunResult>

createDevicePreviewRunFromHtmlImportRaw

Parameters

requestParameters: CreateDevicePreviewRunFromHtmlImportRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<CreateDevicePreviewRunResult>>

createDevicePreviewRunFromImport

`Protected` configuration

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit