/** * 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 { CreateDeliverabilitySimulationJobOptions, CreateDeliverabilityTestOptions, DeleteResult, DeliverabilityAnalyticsSeriesDto, DeliverabilityEntityResultPageDto, DeliverabilityFailureHotspotsDto, DeliverabilityPollStatusResultDto, DeliverabilitySimulationJobDto, DeliverabilitySimulationJobEventPageDto, DeliverabilityTestDto, DeliverabilityTestPageDto, UpdateDeliverabilityTestOptions } from '../models'; export interface CancelDeliverabilitySimulationJobRequest { testId: string; jobId: string; } export interface CreateDeliverabilitySimulationJobRequest { testId: string; createDeliverabilitySimulationJobOptions: CreateDeliverabilitySimulationJobOptions; } export interface CreateDeliverabilityTestRequest { createDeliverabilityTestOptions: CreateDeliverabilityTestOptions; } export interface DeleteDeliverabilityTestRequest { testId: string; } export interface DuplicateDeliverabilityTestRequest { testId: string; } export interface ExportDeliverabilityTestReportRequest { testId: string; } export interface ExportDeliverabilityTestResultsRequest { testId: string; matched?: boolean; } export interface GetDeliverabilityAnalyticsSeriesRequest { since?: Date; before?: Date; scope?: GetDeliverabilityAnalyticsSeriesScopeEnum; bucket?: GetDeliverabilityAnalyticsSeriesBucketEnum; runLimit?: number; } export interface GetDeliverabilityFailureHotspotsRequest { since?: Date; before?: Date; scope?: GetDeliverabilityFailureHotspotsScopeEnum; limit?: number; } export interface GetDeliverabilitySimulationJobRequest { testId: string; jobId: string; } export interface GetDeliverabilitySimulationJobEventsRequest { testId: string; jobId: string; page?: number; size?: number; sort?: GetDeliverabilitySimulationJobEventsSortEnum; } export interface GetDeliverabilityTestRequest { testId: string; } export interface GetDeliverabilityTestResultsRequest { testId: string; matched?: boolean; page?: number; size?: number; sort?: GetDeliverabilityTestResultsSortEnum; } export interface GetDeliverabilityTestsRequest { page?: number; size?: number; sort?: GetDeliverabilityTestsSortEnum; } export interface GetLatestDeliverabilitySimulationJobRequest { testId: string; } export interface PauseDeliverabilitySimulationJobRequest { testId: string; jobId: string; } export interface PauseDeliverabilityTestRequest { testId: string; } export interface PollDeliverabilityTestStatusRequest { testId: string; } export interface ResumeDeliverabilitySimulationJobRequest { testId: string; jobId: string; } export interface StartDeliverabilityTestRequest { testId: string; } export interface StopDeliverabilityTestRequest { testId: string; } export interface UpdateDeliverabilityTestRequest { testId: string; updateDeliverabilityTestOptions: UpdateDeliverabilityTestOptions; } /** * */ export declare class DeliverabilityTestControllerApi extends runtime.BaseAPI { /** * Cancel a running or paused simulation job. * Cancel deliverability simulation job */ cancelDeliverabilitySimulationJobRaw(requestParameters: CancelDeliverabilitySimulationJobRequest, initOverrides?: RequestInit): Promise>; /** * Cancel a running or paused simulation job. * Cancel deliverability simulation job */ cancelDeliverabilitySimulationJob(requestParameters: CancelDeliverabilitySimulationJobRequest, initOverrides?: RequestInit): Promise; /** * Create and start a simulation job for a running deliverability test. Only one active simulation job is allowed per user. * Create deliverability simulation job */ createDeliverabilitySimulationJobRaw(requestParameters: CreateDeliverabilitySimulationJobRequest, initOverrides?: RequestInit): Promise>; /** * Create and start a simulation job for a running deliverability test. Only one active simulation job is allowed per user. * Create deliverability simulation job */ createDeliverabilitySimulationJob(requestParameters: CreateDeliverabilitySimulationJobRequest, initOverrides?: RequestInit): Promise; /** * Create a deliverability test for inboxes or phone numbers using ALL, PATTERN, or EXPLICIT selector scope. * Create deliverability/load test */ createDeliverabilityTestRaw(requestParameters: CreateDeliverabilityTestRequest, initOverrides?: RequestInit): Promise>; /** * Create a deliverability test for inboxes or phone numbers using ALL, PATTERN, or EXPLICIT selector scope. * Create deliverability/load test */ createDeliverabilityTest(requestParameters: CreateDeliverabilityTestRequest, initOverrides?: RequestInit): Promise; /** * Delete test and all persisted entity-level results. * Delete deliverability/load test */ deleteDeliverabilityTestRaw(requestParameters: DeleteDeliverabilityTestRequest, initOverrides?: RequestInit): Promise>; /** * Delete test and all persisted entity-level results. * Delete deliverability/load test */ deleteDeliverabilityTest(requestParameters: DeleteDeliverabilityTestRequest, initOverrides?: RequestInit): Promise; /** * Create a fresh deliverability test using an existing test configuration, including selector scope, exclusions, and expectations. * Duplicate deliverability/load test */ duplicateDeliverabilityTestRaw(requestParameters: DuplicateDeliverabilityTestRequest, initOverrides?: RequestInit): Promise>; /** * Create a fresh deliverability test using an existing test configuration, including selector scope, exclusions, and expectations. * Duplicate deliverability/load test */ duplicateDeliverabilityTest(requestParameters: DuplicateDeliverabilityTestRequest, initOverrides?: RequestInit): Promise; /** * Export a PDF report for a terminal deliverability test (COMPLETE, FAILED, or STOPPED), including configuration, summary outcomes, and detailed entity-level results. * Export deliverability/load test report as PDF */ exportDeliverabilityTestReportRaw(requestParameters: ExportDeliverabilityTestReportRequest, initOverrides?: RequestInit): Promise>; /** * Export a PDF report for a terminal deliverability test (COMPLETE, FAILED, or STOPPED), including configuration, summary outcomes, and detailed entity-level results. * Export deliverability/load test report as PDF */ exportDeliverabilityTestReport(requestParameters: ExportDeliverabilityTestReportRequest, initOverrides?: RequestInit): Promise; /** * Export per-entity deliverability results including expectation-level pass/fail counts. The latest status is evaluated with the same polling safeguards before export. * Export deliverability/load test entity results as CSV */ exportDeliverabilityTestResultsRaw(requestParameters: ExportDeliverabilityTestResultsRequest, initOverrides?: RequestInit): Promise>; /** * Export per-entity deliverability results including expectation-level pass/fail counts. The latest status is evaluated with the same polling safeguards before export. * Export deliverability/load test entity results as CSV */ exportDeliverabilityTestResults(requestParameters: ExportDeliverabilityTestResultsRequest, initOverrides?: RequestInit): Promise; /** * Compare deliverability runs over a time range with bucketed chart metrics and run-level rows for table views. * Get deliverability analytics time series */ getDeliverabilityAnalyticsSeriesRaw(requestParameters: GetDeliverabilityAnalyticsSeriesRequest, initOverrides?: RequestInit): Promise>; /** * Compare deliverability runs over a time range with bucketed chart metrics and run-level rows for table views. * Get deliverability analytics time series */ getDeliverabilityAnalyticsSeries(requestParameters: GetDeliverabilityAnalyticsSeriesRequest, initOverrides?: RequestInit): Promise; /** * Find commonly failing entities and phone country/variant dimensions across deliverability runs in a time range. * Get deliverability failure hotspots */ getDeliverabilityFailureHotspotsRaw(requestParameters: GetDeliverabilityFailureHotspotsRequest, initOverrides?: RequestInit): Promise>; /** * Find commonly failing entities and phone country/variant dimensions across deliverability runs in a time range. * Get deliverability failure hotspots */ getDeliverabilityFailureHotspots(requestParameters: GetDeliverabilityFailureHotspotsRequest, initOverrides?: RequestInit): Promise; /** * Get simulation job status and progress counters. * Get deliverability simulation job */ getDeliverabilitySimulationJobRaw(requestParameters: GetDeliverabilitySimulationJobRequest, initOverrides?: RequestInit): Promise>; /** * Get simulation job status and progress counters. * Get deliverability simulation job */ getDeliverabilitySimulationJob(requestParameters: GetDeliverabilitySimulationJobRequest, initOverrides?: RequestInit): Promise; /** * Get paged simulation events including send successes and failures. * Get deliverability simulation job events */ getDeliverabilitySimulationJobEventsRaw(requestParameters: GetDeliverabilitySimulationJobEventsRequest, initOverrides?: RequestInit): Promise>; /** * Get paged simulation events including send successes and failures. * Get deliverability simulation job events */ getDeliverabilitySimulationJobEvents(requestParameters: GetDeliverabilitySimulationJobEventsRequest, initOverrides?: RequestInit): Promise; /** * Get deliverability test configuration and latest progress counters. * Get deliverability/load test */ getDeliverabilityTestRaw(requestParameters: GetDeliverabilityTestRequest, initOverrides?: RequestInit): Promise>; /** * Get deliverability test configuration and latest progress counters. * Get deliverability/load test */ getDeliverabilityTest(requestParameters: GetDeliverabilityTestRequest, initOverrides?: RequestInit): Promise; /** * Get paged per-entity expectation results with optional matched/unmatched filtering. * Get deliverability/load test entity results */ getDeliverabilityTestResultsRaw(requestParameters: GetDeliverabilityTestResultsRequest, initOverrides?: RequestInit): Promise>; /** * Get paged per-entity expectation results with optional matched/unmatched filtering. * Get deliverability/load test entity results */ getDeliverabilityTestResults(requestParameters: GetDeliverabilityTestResultsRequest, initOverrides?: RequestInit): Promise; /** * List deliverability tests for the authenticated account. * List deliverability/load tests */ getDeliverabilityTestsRaw(requestParameters: GetDeliverabilityTestsRequest, initOverrides?: RequestInit): Promise>; /** * List deliverability tests for the authenticated account. * List deliverability/load tests */ getDeliverabilityTests(requestParameters: GetDeliverabilityTestsRequest, initOverrides?: RequestInit): Promise; /** * Get the most recent simulation job for a deliverability test. * Get latest deliverability simulation job */ getLatestDeliverabilitySimulationJobRaw(requestParameters: GetLatestDeliverabilitySimulationJobRequest, initOverrides?: RequestInit): Promise>; /** * Get the most recent simulation job for a deliverability test. * Get latest deliverability simulation job */ getLatestDeliverabilitySimulationJob(requestParameters: GetLatestDeliverabilitySimulationJobRequest, initOverrides?: RequestInit): Promise; /** * Pause a running simulation job. * Pause deliverability simulation job */ pauseDeliverabilitySimulationJobRaw(requestParameters: PauseDeliverabilitySimulationJobRequest, initOverrides?: RequestInit): Promise>; /** * Pause a running simulation job. * Pause deliverability simulation job */ pauseDeliverabilitySimulationJob(requestParameters: PauseDeliverabilitySimulationJobRequest, initOverrides?: RequestInit): Promise; /** * Pause a RUNNING or SCHEDULED deliverability test. * Pause deliverability/load test */ pauseDeliverabilityTestRaw(requestParameters: PauseDeliverabilityTestRequest, initOverrides?: RequestInit): Promise>; /** * Pause a RUNNING or SCHEDULED deliverability test. * Pause deliverability/load test */ pauseDeliverabilityTest(requestParameters: PauseDeliverabilityTestRequest, initOverrides?: RequestInit): Promise; /** * Poll test progress. Evaluation is throttled with a 5-second cache window to protect backing data stores. * Poll deliverability/load test status */ pollDeliverabilityTestStatusRaw(requestParameters: PollDeliverabilityTestStatusRequest, initOverrides?: RequestInit): Promise>; /** * Poll test progress. Evaluation is throttled with a 5-second cache window to protect backing data stores. * Poll deliverability/load test status */ pollDeliverabilityTestStatus(requestParameters: PollDeliverabilityTestStatusRequest, initOverrides?: RequestInit): Promise; /** * Resume a paused simulation job. * Resume deliverability simulation job */ resumeDeliverabilitySimulationJobRaw(requestParameters: ResumeDeliverabilitySimulationJobRequest, initOverrides?: RequestInit): Promise>; /** * Resume a paused simulation job. * Resume deliverability simulation job */ resumeDeliverabilitySimulationJob(requestParameters: ResumeDeliverabilitySimulationJobRequest, initOverrides?: RequestInit): Promise; /** * Start a CREATED test or resume a PAUSED/SCHEDULED test. * Start or resume deliverability/load test */ startDeliverabilityTestRaw(requestParameters: StartDeliverabilityTestRequest, initOverrides?: RequestInit): Promise>; /** * Start a CREATED test or resume a PAUSED/SCHEDULED test. * Start or resume deliverability/load test */ startDeliverabilityTest(requestParameters: StartDeliverabilityTestRequest, initOverrides?: RequestInit): Promise; /** * Stop a deliverability test and mark it terminal. * Stop deliverability/load test */ stopDeliverabilityTestRaw(requestParameters: StopDeliverabilityTestRequest, initOverrides?: RequestInit): Promise>; /** * Stop a deliverability test and mark it terminal. * Stop deliverability/load test */ stopDeliverabilityTest(requestParameters: StopDeliverabilityTestRequest, initOverrides?: RequestInit): Promise; /** * Update metadata, timeout, and expectations for a non-running non-terminal test. * Update deliverability/load test */ updateDeliverabilityTestRaw(requestParameters: UpdateDeliverabilityTestRequest, initOverrides?: RequestInit): Promise>; /** * Update metadata, timeout, and expectations for a non-running non-terminal test. * Update deliverability/load test */ updateDeliverabilityTest(requestParameters: UpdateDeliverabilityTestRequest, initOverrides?: RequestInit): Promise; } /** * @export * @enum {string} */ export declare enum GetDeliverabilityAnalyticsSeriesScopeEnum { INBOX = "INBOX", PHONE = "PHONE" } /** * @export * @enum {string} */ export declare enum GetDeliverabilityAnalyticsSeriesBucketEnum { HOUR = "HOUR", DAY = "DAY" } /** * @export * @enum {string} */ export declare enum GetDeliverabilityFailureHotspotsScopeEnum { INBOX = "INBOX", PHONE = "PHONE" } /** * @export * @enum {string} */ export declare enum GetDeliverabilitySimulationJobEventsSortEnum { ASC = "ASC", DESC = "DESC" } /** * @export * @enum {string} */ export declare enum GetDeliverabilityTestResultsSortEnum { ASC = "ASC", DESC = "DESC" } /** * @export * @enum {string} */ export declare enum GetDeliverabilityTestsSortEnum { ASC = "ASC", DESC = "DESC" }