/** * MailSlurp API * MailSlurp is an API for sending and receiving emails and SMS from dynamically allocated email addresses and phone numbers. It\'s designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository * * The version of the OpenAPI document: 6.5.2 * Contact: contact@mailslurp.dev * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import { CancelDevicePreviewRunOptions, CancelDevicePreviewRunResult, CreateDevicePreviewFeedbackOptions, CreateDevicePreviewHtmlImportOptions, CreateDevicePreviewImportOptions, CreateDevicePreviewIngestAddressOptions, CreateDevicePreviewOptions, CreateDevicePreviewProfileOptions, CreateDevicePreviewRunResult, CreateDevicePreviewShareLinkOptions, DeleteDevicePreviewProfileResult, DeleteDevicePreviewRunResult, DeleteDevicePreviewShareLinkResult, DevicePreviewAccountSettingsDto, DevicePreviewEmailSubmissionDto, DevicePreviewEmailSubmissionWaitResult, DevicePreviewFeedbackDto, DevicePreviewFeedbackListDto, DevicePreviewIngestAddressDto, DevicePreviewIngestRunWaitResult, DevicePreviewNativeTargetAvailabilityListDto, DevicePreviewProfileDto, DevicePreviewProviderProgressDto, DevicePreviewRunDto, DevicePreviewRunResultsDto, DevicePreviewRunWaitResult, DevicePreviewShareLinkDto, DevicePreviewSharedResultDto, PageDevicePreviewRunProjection, RerunDevicePreviewTargetsOptions, RerunDevicePreviewTargetsResult, UpdateDevicePreviewFeedbackOptions, UpdateDevicePreviewIngestDomainOptions, UpdateDevicePreviewProfileOptions } from '../models'; export interface CancelDevicePreviewRunRequest { runId: string; cancelDevicePreviewRunOptions?: CancelDevicePreviewRunOptions; } export interface CreateDevicePreviewFeedbackRequest { createDevicePreviewFeedbackOptions: CreateDevicePreviewFeedbackOptions; } export interface CreateDevicePreviewImportAddressRequest { createDevicePreviewIngestAddressOptions?: CreateDevicePreviewIngestAddressOptions; } export interface CreateDevicePreviewProfileRequest { createDevicePreviewProfileOptions: CreateDevicePreviewProfileOptions; } export interface CreateDevicePreviewRunRequest { emailId: string; createDevicePreviewOptions?: CreateDevicePreviewOptions; } export interface CreateDevicePreviewRunFromHtmlImportRequest { createDevicePreviewHtmlImportOptions: CreateDevicePreviewHtmlImportOptions; } export interface CreateDevicePreviewRunFromImportRequest { createDevicePreviewImportOptions: CreateDevicePreviewImportOptions; } export interface CreateDevicePreviewRunFromMultipartImportRequest { file: Blob; sourceAlias?: string; externalId?: string; nativeTargets?: Array; } export interface CreateDevicePreviewRunFromRawImportRequest { sourceAlias?: string; externalId?: string; nativeTargets?: Array; } export interface CreateDevicePreviewShareLinkRequest { runId: string; createDevicePreviewShareLinkOptions?: CreateDevicePreviewShareLinkOptions; } export interface DeleteDevicePreviewProfileRequest { profileId: string; } export interface DeleteDevicePreviewRunRequest { runId: string; } export interface DeleteDevicePreviewShareLinkRequest { shareLinkId: string; } export interface EnsureDevicePreviewRunRequest { emailId: string; createDevicePreviewOptions?: CreateDevicePreviewOptions; } export interface GetDevicePreviewEmailRunsRequest { since: Date; emailDomainId?: string; profileId?: string; localPart?: string; limit?: number; hydrateThumbnail?: boolean; } export interface GetDevicePreviewEmailSubmissionsRequest { since: Date; emailDomainId?: string; profileId?: string; localPart?: string; limit?: number; } export interface GetDevicePreviewFeedbackRequest { feedbackId: string; } export interface GetDevicePreviewFeedbackItemsRequest { page?: number; size?: number; source?: GetDevicePreviewFeedbackItemsSourceEnum; runId?: string; status?: GetDevicePreviewFeedbackItemsStatusEnum; provider?: GetDevicePreviewFeedbackItemsProviderEnum; category?: GetDevicePreviewFeedbackItemsCategoryEnum; search?: string; } export interface GetDevicePreviewImportAddressRequest { sessionId: string; } export interface GetDevicePreviewProfileRequest { profileId: string; } export interface GetDevicePreviewRunRequest { runId: string; } export interface GetDevicePreviewRunProviderProgressRequest { runId: string; provider: GetDevicePreviewRunProviderProgressProviderEnum; } export interface GetDevicePreviewRunResultsRequest { runId: string; } export interface GetDevicePreviewRunScreenshotRequest { runId: string; screenshotId: string; } export interface GetDevicePreviewRunsRequest { emailId: string; limit?: number; hydrateThumbnail?: boolean; } export interface GetDevicePreviewRunsForAccountRequest { limit?: number; hydrateThumbnail?: boolean; } export interface GetDevicePreviewRunsForAccountOffsetPaginatedRequest { page?: number; size?: number; sort?: GetDevicePreviewRunsForAccountOffsetPaginatedSortEnum; hydrateThumbnail?: boolean; } export interface GetDevicePreviewRunsOffsetPaginatedRequest { emailId: string; page?: number; size?: number; sort?: GetDevicePreviewRunsOffsetPaginatedSortEnum; hydrateThumbnail?: boolean; } export interface GetDevicePreviewShareLinksRequest { runId: string; } export interface GetDevicePreviewSharedResultRequest { shareToken: string; } export interface GetDevicePreviewSharedResultScreenshotRequest { shareToken: string; screenshotId: string; } export interface RerunDevicePreviewTargetsRequest { runId: string; rerunDevicePreviewTargetsOptions: RerunDevicePreviewTargetsOptions; } export interface UpdateDevicePreviewEmailDomainSubdomainRequest { updateDevicePreviewIngestDomainOptions: UpdateDevicePreviewIngestDomainOptions; } export interface UpdateDevicePreviewFeedbackRequest { feedbackId: string; updateDevicePreviewFeedbackOptions: UpdateDevicePreviewFeedbackOptions; } export interface UpdateDevicePreviewProfileRequest { profileId: string; updateDevicePreviewProfileOptions: UpdateDevicePreviewProfileOptions; } export interface WaitForDevicePreviewEmailRunsRequest { since: Date; emailDomainId?: string; profileId?: string; localPart?: string; limit?: number; timeoutMillis?: number; pollIntervalMillis?: number; hydrateThumbnail?: boolean; } export interface WaitForDevicePreviewEmailSubmissionsRequest { since: Date; emailDomainId?: string; profileId?: string; localPart?: string; limit?: number; timeoutMillis?: number; pollIntervalMillis?: number; } export interface WaitForDevicePreviewRunRequest { runId: string; timeoutMillis?: number; pollIntervalMillis?: number; } /** * */ export declare class DevicePreviewsControllerApi extends runtime.BaseAPI { /** * Cancel a running device preview run */ cancelDevicePreviewRunRaw(requestParameters: CancelDevicePreviewRunRequest, initOverrides?: RequestInit): Promise>; /** * Cancel a running device preview run */ cancelDevicePreviewRun(requestParameters: CancelDevicePreviewRunRequest, initOverrides?: RequestInit): Promise; /** * Create device preview feedback */ createDevicePreviewFeedbackRaw(requestParameters: CreateDevicePreviewFeedbackRequest, initOverrides?: RequestInit): Promise>; /** * Create device preview feedback */ createDevicePreviewFeedback(requestParameters: CreateDevicePreviewFeedbackRequest, initOverrides?: RequestInit): Promise; /** * Create a temporary email address for device preview import */ createDevicePreviewImportAddressRaw(requestParameters: CreateDevicePreviewImportAddressRequest, initOverrides?: RequestInit): Promise>; /** * Create a temporary email address for device preview import */ createDevicePreviewImportAddress(requestParameters: CreateDevicePreviewImportAddressRequest, initOverrides?: RequestInit): Promise; /** * Create a device preview profile */ createDevicePreviewProfileRaw(requestParameters: CreateDevicePreviewProfileRequest, initOverrides?: RequestInit): Promise>; /** * Create a device preview profile */ createDevicePreviewProfile(requestParameters: CreateDevicePreviewProfileRequest, initOverrides?: RequestInit): Promise; /** * Create a new device preview run for an email */ createDevicePreviewRunRaw(requestParameters: CreateDevicePreviewRunRequest, initOverrides?: RequestInit): Promise>; /** * Create a new device preview run for an email */ createDevicePreviewRun(requestParameters: CreateDevicePreviewRunRequest, initOverrides?: RequestInit): Promise; /** * Create a device preview run from HTML */ createDevicePreviewRunFromHtmlImportRaw(requestParameters: CreateDevicePreviewRunFromHtmlImportRequest, initOverrides?: RequestInit): Promise>; /** * Create a device preview run from HTML */ createDevicePreviewRunFromHtmlImport(requestParameters: CreateDevicePreviewRunFromHtmlImportRequest, initOverrides?: RequestInit): Promise; /** * Create a device preview run from imported raw MIME */ createDevicePreviewRunFromImportRaw(requestParameters: CreateDevicePreviewRunFromImportRequest, initOverrides?: RequestInit): Promise>; /** * Create a device preview run from imported raw MIME */ createDevicePreviewRunFromImport(requestParameters: CreateDevicePreviewRunFromImportRequest, initOverrides?: RequestInit): Promise; /** * Create a device preview run from multipart EML upload */ createDevicePreviewRunFromMultipartImportRaw(requestParameters: CreateDevicePreviewRunFromMultipartImportRequest, initOverrides?: RequestInit): Promise>; /** * Create a device preview run from multipart EML upload */ createDevicePreviewRunFromMultipartImport(requestParameters: CreateDevicePreviewRunFromMultipartImportRequest, initOverrides?: RequestInit): Promise; /** * Create a device preview run from raw MIME bytes */ createDevicePreviewRunFromRawImportRaw(requestParameters: CreateDevicePreviewRunFromRawImportRequest, initOverrides?: RequestInit): Promise>; /** * Create a device preview run from raw MIME bytes */ createDevicePreviewRunFromRawImport(requestParameters: CreateDevicePreviewRunFromRawImportRequest, initOverrides?: RequestInit): Promise; /** * Create a share link for a device preview run */ createDevicePreviewShareLinkRaw(requestParameters: CreateDevicePreviewShareLinkRequest, initOverrides?: RequestInit): Promise>; /** * Create a share link for a device preview run */ createDevicePreviewShareLink(requestParameters: CreateDevicePreviewShareLinkRequest, initOverrides?: RequestInit): Promise; /** * Delete a device preview profile */ deleteDevicePreviewProfileRaw(requestParameters: DeleteDevicePreviewProfileRequest, initOverrides?: RequestInit): Promise>; /** * Delete a device preview profile */ deleteDevicePreviewProfile(requestParameters: DeleteDevicePreviewProfileRequest, initOverrides?: RequestInit): Promise; /** * Delete local device preview run data */ deleteDevicePreviewRunRaw(requestParameters: DeleteDevicePreviewRunRequest, initOverrides?: RequestInit): Promise>; /** * Delete local device preview run data */ deleteDevicePreviewRun(requestParameters: DeleteDevicePreviewRunRequest, initOverrides?: RequestInit): Promise; /** * Revoke a device preview share link */ deleteDevicePreviewShareLinkRaw(requestParameters: DeleteDevicePreviewShareLinkRequest, initOverrides?: RequestInit): Promise>; /** * Revoke a device preview share link */ deleteDevicePreviewShareLink(requestParameters: DeleteDevicePreviewShareLinkRequest, initOverrides?: RequestInit): Promise; /** * Return active run for email or create one when none exists */ ensureDevicePreviewRunRaw(requestParameters: EnsureDevicePreviewRunRequest, initOverrides?: RequestInit): Promise>; /** * Return active run for email or create one when none exists */ ensureDevicePreviewRun(requestParameters: EnsureDevicePreviewRunRequest, initOverrides?: RequestInit): Promise; /** * Return account device preview email domain setup or create one */ getDevicePreviewEmailDomainOrCreateRaw(initOverrides?: RequestInit): Promise>; /** * Return account device preview email domain setup or create one */ getDevicePreviewEmailDomainOrCreate(initOverrides?: RequestInit): Promise; /** * List device preview runs created from account email domains */ getDevicePreviewEmailRunsRaw(requestParameters: GetDevicePreviewEmailRunsRequest, initOverrides?: RequestInit): Promise>>; /** * List device preview runs created from account email domains */ getDevicePreviewEmailRuns(requestParameters: GetDevicePreviewEmailRunsRequest, initOverrides?: RequestInit): Promise>; /** * List received device preview email submissions */ getDevicePreviewEmailSubmissionsRaw(requestParameters: GetDevicePreviewEmailSubmissionsRequest, initOverrides?: RequestInit): Promise>>; /** * List received device preview email submissions */ getDevicePreviewEmailSubmissions(requestParameters: GetDevicePreviewEmailSubmissionsRequest, initOverrides?: RequestInit): Promise>; /** * Get a single device preview feedback item */ getDevicePreviewFeedbackRaw(requestParameters: GetDevicePreviewFeedbackRequest, initOverrides?: RequestInit): Promise>; /** * Get a single device preview feedback item */ getDevicePreviewFeedback(requestParameters: GetDevicePreviewFeedbackRequest, initOverrides?: RequestInit): Promise; /** * List device preview feedback */ getDevicePreviewFeedbackItemsRaw(requestParameters: GetDevicePreviewFeedbackItemsRequest, initOverrides?: RequestInit): Promise>; /** * List device preview feedback */ getDevicePreviewFeedbackItems(requestParameters: GetDevicePreviewFeedbackItemsRequest, initOverrides?: RequestInit): Promise; /** * Get temporary device preview import address status */ getDevicePreviewImportAddressRaw(requestParameters: GetDevicePreviewImportAddressRequest, initOverrides?: RequestInit): Promise>; /** * Get temporary device preview import address status */ getDevicePreviewImportAddress(requestParameters: GetDevicePreviewImportAddressRequest, initOverrides?: RequestInit): Promise; /** * Get native device preview target availability */ getDevicePreviewNativeTargetAvailabilityRaw(initOverrides?: RequestInit): Promise>; /** * Get native device preview target availability */ getDevicePreviewNativeTargetAvailability(initOverrides?: RequestInit): Promise; /** * Get a device preview profile */ getDevicePreviewProfileRaw(requestParameters: GetDevicePreviewProfileRequest, initOverrides?: RequestInit): Promise>; /** * Get a device preview profile */ getDevicePreviewProfile(requestParameters: GetDevicePreviewProfileRequest, initOverrides?: RequestInit): Promise; /** * List device preview profiles */ getDevicePreviewProfilesRaw(initOverrides?: RequestInit): Promise>>; /** * List device preview profiles */ getDevicePreviewProfiles(initOverrides?: RequestInit): Promise>; /** * Get device preview run status */ getDevicePreviewRunRaw(requestParameters: GetDevicePreviewRunRequest, initOverrides?: RequestInit): Promise>; /** * Get device preview run status */ getDevicePreviewRun(requestParameters: GetDevicePreviewRunRequest, initOverrides?: RequestInit): Promise; /** * Get provider-level progress for a device preview run */ getDevicePreviewRunProviderProgressRaw(requestParameters: GetDevicePreviewRunProviderProgressRequest, initOverrides?: RequestInit): Promise>; /** * Get provider-level progress for a device preview run */ getDevicePreviewRunProviderProgress(requestParameters: GetDevicePreviewRunProviderProgressRequest, initOverrides?: RequestInit): Promise; /** * Get device preview run results */ getDevicePreviewRunResultsRaw(requestParameters: GetDevicePreviewRunResultsRequest, initOverrides?: RequestInit): Promise>; /** * Get device preview run results */ getDevicePreviewRunResults(requestParameters: GetDevicePreviewRunResultsRequest, initOverrides?: RequestInit): Promise; /** * Get a device preview screenshot image */ getDevicePreviewRunScreenshotRaw(requestParameters: GetDevicePreviewRunScreenshotRequest, initOverrides?: RequestInit): Promise>; /** * Get a device preview screenshot image */ getDevicePreviewRunScreenshot(requestParameters: GetDevicePreviewRunScreenshotRequest, initOverrides?: RequestInit): Promise; /** * List previous device preview runs for an email */ getDevicePreviewRunsRaw(requestParameters: GetDevicePreviewRunsRequest, initOverrides?: RequestInit): Promise>>; /** * List previous device preview runs for an email */ getDevicePreviewRuns(requestParameters: GetDevicePreviewRunsRequest, initOverrides?: RequestInit): Promise>; /** * List previous device preview runs for account */ getDevicePreviewRunsForAccountRaw(requestParameters: GetDevicePreviewRunsForAccountRequest, initOverrides?: RequestInit): Promise>>; /** * List previous device preview runs for account */ getDevicePreviewRunsForAccount(requestParameters: GetDevicePreviewRunsForAccountRequest, initOverrides?: RequestInit): Promise>; /** * List previous device preview runs for account in paginated form */ getDevicePreviewRunsForAccountOffsetPaginatedRaw(requestParameters: GetDevicePreviewRunsForAccountOffsetPaginatedRequest, initOverrides?: RequestInit): Promise>; /** * List previous device preview runs for account in paginated form */ getDevicePreviewRunsForAccountOffsetPaginated(requestParameters: GetDevicePreviewRunsForAccountOffsetPaginatedRequest, initOverrides?: RequestInit): Promise; /** * List previous device preview runs for an email in paginated form */ getDevicePreviewRunsOffsetPaginatedRaw(requestParameters: GetDevicePreviewRunsOffsetPaginatedRequest, initOverrides?: RequestInit): Promise>; /** * List previous device preview runs for an email in paginated form */ getDevicePreviewRunsOffsetPaginated(requestParameters: GetDevicePreviewRunsOffsetPaginatedRequest, initOverrides?: RequestInit): Promise; /** * List share links for a device preview run */ getDevicePreviewShareLinksRaw(requestParameters: GetDevicePreviewShareLinksRequest, initOverrides?: RequestInit): Promise>>; /** * List share links for a device preview run */ getDevicePreviewShareLinks(requestParameters: GetDevicePreviewShareLinksRequest, initOverrides?: RequestInit): Promise>; /** * Get a public shared device preview result */ getDevicePreviewSharedResultRaw(requestParameters: GetDevicePreviewSharedResultRequest, initOverrides?: RequestInit): Promise>; /** * Get a public shared device preview result */ getDevicePreviewSharedResult(requestParameters: GetDevicePreviewSharedResultRequest, initOverrides?: RequestInit): Promise; /** * Get a public shared device preview screenshot image */ getDevicePreviewSharedResultScreenshotRaw(requestParameters: GetDevicePreviewSharedResultScreenshotRequest, initOverrides?: RequestInit): Promise>; /** * Get a public shared device preview screenshot image */ getDevicePreviewSharedResultScreenshot(requestParameters: GetDevicePreviewSharedResultScreenshotRequest, initOverrides?: RequestInit): Promise; /** * Rerun selected failed device preview targets in the same run */ rerunDevicePreviewTargetsRaw(requestParameters: RerunDevicePreviewTargetsRequest, initOverrides?: RequestInit): Promise>; /** * Rerun selected failed device preview targets in the same run */ rerunDevicePreviewTargets(requestParameters: RerunDevicePreviewTargetsRequest, initOverrides?: RequestInit): Promise; /** * Update account device preview email subdomain */ updateDevicePreviewEmailDomainSubdomainRaw(requestParameters: UpdateDevicePreviewEmailDomainSubdomainRequest, initOverrides?: RequestInit): Promise>; /** * Update account device preview email subdomain */ updateDevicePreviewEmailDomainSubdomain(requestParameters: UpdateDevicePreviewEmailDomainSubdomainRequest, initOverrides?: RequestInit): Promise; /** * Update device preview feedback */ updateDevicePreviewFeedbackRaw(requestParameters: UpdateDevicePreviewFeedbackRequest, initOverrides?: RequestInit): Promise>; /** * Update device preview feedback */ updateDevicePreviewFeedback(requestParameters: UpdateDevicePreviewFeedbackRequest, initOverrides?: RequestInit): Promise; /** * Update a device preview profile */ updateDevicePreviewProfileRaw(requestParameters: UpdateDevicePreviewProfileRequest, initOverrides?: RequestInit): Promise>; /** * Update a device preview profile */ updateDevicePreviewProfile(requestParameters: UpdateDevicePreviewProfileRequest, initOverrides?: RequestInit): Promise; /** * Wait for device preview runs created from account email domains */ waitForDevicePreviewEmailRunsRaw(requestParameters: WaitForDevicePreviewEmailRunsRequest, initOverrides?: RequestInit): Promise>; /** * Wait for device preview runs created from account email domains */ waitForDevicePreviewEmailRuns(requestParameters: WaitForDevicePreviewEmailRunsRequest, initOverrides?: RequestInit): Promise; /** * Wait for received device preview email submissions */ waitForDevicePreviewEmailSubmissionsRaw(requestParameters: WaitForDevicePreviewEmailSubmissionsRequest, initOverrides?: RequestInit): Promise>; /** * Wait for received device preview email submissions */ waitForDevicePreviewEmailSubmissions(requestParameters: WaitForDevicePreviewEmailSubmissionsRequest, initOverrides?: RequestInit): Promise; /** * Wait for device preview run to complete */ waitForDevicePreviewRunRaw(requestParameters: WaitForDevicePreviewRunRequest, initOverrides?: RequestInit): Promise>; /** * Wait for device preview run to complete */ waitForDevicePreviewRun(requestParameters: WaitForDevicePreviewRunRequest, initOverrides?: RequestInit): Promise; } /** * @export * @enum {string} */ export declare enum GetDevicePreviewFeedbackItemsSourceEnum { API_SERVICE = "API_SERVICE", LAB_USER = "LAB_USER", END_USER = "END_USER", SYSTEM = "SYSTEM" } /** * @export * @enum {string} */ export declare enum GetDevicePreviewFeedbackItemsStatusEnum { OPEN = "OPEN", ACKNOWLEDGED = "ACKNOWLEDGED", RESOLVED = "RESOLVED", DISMISSED = "DISMISSED" } /** * @export * @enum {string} */ export declare enum GetDevicePreviewFeedbackItemsProviderEnum { GMAIL = "GMAIL", OUTLOOK = "OUTLOOK", YAHOO = "YAHOO" } /** * @export * @enum {string} */ export declare enum GetDevicePreviewFeedbackItemsCategoryEnum { GENERAL = "GENERAL", RUN_QUALITY = "RUN_QUALITY", SCREENSHOT_QUALITY = "SCREENSHOT_QUALITY", PROVIDER_ISSUE = "PROVIDER_ISSUE", BUG_REPORT = "BUG_REPORT", FEATURE_REQUEST = "FEATURE_REQUEST", NOTE = "NOTE" } /** * @export * @enum {string} */ export declare enum GetDevicePreviewRunProviderProgressProviderEnum { GMAIL = "GMAIL", OUTLOOK = "OUTLOOK", YAHOO = "YAHOO" } /** * @export * @enum {string} */ export declare enum GetDevicePreviewRunsForAccountOffsetPaginatedSortEnum { ASC = "ASC", DESC = "DESC" } /** * @export * @enum {string} */ export declare enum GetDevicePreviewRunsOffsetPaginatedSortEnum { ASC = "ASC", DESC = "DESC" }