/** * 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, CreateDevicePreviewOptions, CreateDevicePreviewRunResult, DeleteDevicePreviewRunResult, DevicePreviewFeedbackDto, DevicePreviewFeedbackListDto, DevicePreviewProviderProgressDto, DevicePreviewRunDto, DevicePreviewRunResultsDto, PageDevicePreviewRunProjection, UpdateDevicePreviewFeedbackOptions } from '../models'; export interface CancelDevicePreviewRunRequest { runId: string; cancelDevicePreviewRunOptions?: CancelDevicePreviewRunOptions; } export interface CreateDevicePreviewFeedbackRequest { createDevicePreviewFeedbackOptions: CreateDevicePreviewFeedbackOptions; } export interface CreateDevicePreviewRunRequest { emailId: string; createDevicePreviewOptions?: CreateDevicePreviewOptions; } export interface DeleteDevicePreviewRunRequest { runId: string; } export interface EnsureDevicePreviewRunRequest { emailId: string; createDevicePreviewOptions?: CreateDevicePreviewOptions; } 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 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; } export interface GetDevicePreviewRunsForAccountRequest { limit?: number; } export interface GetDevicePreviewRunsOffsetPaginatedRequest { emailId: string; page?: number; size?: number; sort?: GetDevicePreviewRunsOffsetPaginatedSortEnum; } export interface UpdateDevicePreviewFeedbackRequest { feedbackId: string; updateDevicePreviewFeedbackOptions: UpdateDevicePreviewFeedbackOptions; } /** * */ 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 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; /** * Delete local device preview run data */ deleteDevicePreviewRunRaw(requestParameters: DeleteDevicePreviewRunRequest, initOverrides?: RequestInit): Promise>; /** * Delete local device preview run data */ deleteDevicePreviewRun(requestParameters: DeleteDevicePreviewRunRequest, 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; /** * 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 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 seeded device preview screenshot image */ getDevicePreviewRunScreenshotRaw(requestParameters: GetDevicePreviewRunScreenshotRequest, initOverrides?: RequestInit): Promise>; /** * Get a seeded 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 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; /** * Update device preview feedback */ updateDevicePreviewFeedbackRaw(requestParameters: UpdateDevicePreviewFeedbackRequest, initOverrides?: RequestInit): Promise>; /** * Update device preview feedback */ updateDevicePreviewFeedback(requestParameters: UpdateDevicePreviewFeedbackRequest, 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 GetDevicePreviewRunsOffsetPaginatedSortEnum { ASC = "ASC", DESC = "DESC" }