/** * 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 { CampaignProbeDto, CampaignProbeInsightsDto, CampaignProbeRunComparisonDto, CampaignProbeRunDto, CampaignProbeRunDueResult, CampaignProbeRunNowResult, CampaignProbeSeriesDto, CreateCampaignProbeOptions, CreateCampaignProbeRunOptions, UpdateCampaignProbeOptions } from '../models'; export interface CompareCampaignProbeRunsRequest { probeId: string; runId: string; otherRunId: string; } export interface CreateCampaignProbeRequest { createCampaignProbeOptions: CreateCampaignProbeOptions; } export interface DeleteCampaignProbeRequest { probeId: string; } export interface GetCampaignProbeRequest { probeId: string; } export interface GetCampaignProbeInsightsRequest { probeId: string; since?: Date; before?: Date; } export interface GetCampaignProbeRunRequest { probeId: string; runId: string; } export interface GetCampaignProbeRunsRequest { probeId: string; since?: Date; before?: Date; status?: GetCampaignProbeRunsStatusEnum; limit?: number; } export interface GetCampaignProbeSeriesRequest { probeId: string; since?: Date; before?: Date; bucket?: GetCampaignProbeSeriesBucketEnum; } export interface RunCampaignProbeNowRequest { probeId: string; createCampaignProbeRunOptions: CreateCampaignProbeRunOptions; } export interface RunDueCampaignProbesRequest { maxRuns?: number; } export interface UpdateCampaignProbeRequest { probeId: string; updateCampaignProbeOptions: UpdateCampaignProbeOptions; } /** * */ export declare class CampaignProbeControllerApi extends runtime.BaseAPI { /** * Compare two campaign probe runs */ compareCampaignProbeRunsRaw(requestParameters: CompareCampaignProbeRunsRequest, initOverrides?: RequestInit): Promise>; /** * Compare two campaign probe runs */ compareCampaignProbeRuns(requestParameters: CompareCampaignProbeRunsRequest, initOverrides?: RequestInit): Promise; /** * Create campaign probe */ createCampaignProbeRaw(requestParameters: CreateCampaignProbeRequest, initOverrides?: RequestInit): Promise>; /** * Create campaign probe */ createCampaignProbe(requestParameters: CreateCampaignProbeRequest, initOverrides?: RequestInit): Promise; /** * Delete campaign probe */ deleteCampaignProbeRaw(requestParameters: DeleteCampaignProbeRequest, initOverrides?: RequestInit): Promise>; /** * Delete campaign probe */ deleteCampaignProbe(requestParameters: DeleteCampaignProbeRequest, initOverrides?: RequestInit): Promise; /** * Get campaign probe */ getCampaignProbeRaw(requestParameters: GetCampaignProbeRequest, initOverrides?: RequestInit): Promise>; /** * Get campaign probe */ getCampaignProbe(requestParameters: GetCampaignProbeRequest, initOverrides?: RequestInit): Promise; /** * Get campaign probe insights */ getCampaignProbeInsightsRaw(requestParameters: GetCampaignProbeInsightsRequest, initOverrides?: RequestInit): Promise>; /** * Get campaign probe insights */ getCampaignProbeInsights(requestParameters: GetCampaignProbeInsightsRequest, initOverrides?: RequestInit): Promise; /** * Get campaign probe run */ getCampaignProbeRunRaw(requestParameters: GetCampaignProbeRunRequest, initOverrides?: RequestInit): Promise>; /** * Get campaign probe run */ getCampaignProbeRun(requestParameters: GetCampaignProbeRunRequest, initOverrides?: RequestInit): Promise; /** * List campaign probe runs */ getCampaignProbeRunsRaw(requestParameters: GetCampaignProbeRunsRequest, initOverrides?: RequestInit): Promise>>; /** * List campaign probe runs */ getCampaignProbeRuns(requestParameters: GetCampaignProbeRunsRequest, initOverrides?: RequestInit): Promise>; /** * Get campaign probe trend series */ getCampaignProbeSeriesRaw(requestParameters: GetCampaignProbeSeriesRequest, initOverrides?: RequestInit): Promise>; /** * Get campaign probe trend series */ getCampaignProbeSeries(requestParameters: GetCampaignProbeSeriesRequest, initOverrides?: RequestInit): Promise; /** * List campaign probes */ getCampaignProbesRaw(initOverrides?: RequestInit): Promise>>; /** * List campaign probes */ getCampaignProbes(initOverrides?: RequestInit): Promise>; /** * Run campaign probe now */ runCampaignProbeNowRaw(requestParameters: RunCampaignProbeNowRequest, initOverrides?: RequestInit): Promise>; /** * Run campaign probe now */ runCampaignProbeNow(requestParameters: RunCampaignProbeNowRequest, initOverrides?: RequestInit): Promise; /** * Run due campaign probes for user */ runDueCampaignProbesRaw(requestParameters: RunDueCampaignProbesRequest, initOverrides?: RequestInit): Promise>; /** * Run due campaign probes for user */ runDueCampaignProbes(requestParameters: RunDueCampaignProbesRequest, initOverrides?: RequestInit): Promise; /** * Update campaign probe */ updateCampaignProbeRaw(requestParameters: UpdateCampaignProbeRequest, initOverrides?: RequestInit): Promise>; /** * Update campaign probe */ updateCampaignProbe(requestParameters: UpdateCampaignProbeRequest, initOverrides?: RequestInit): Promise; } /** * @export * @enum {string} */ export declare enum GetCampaignProbeRunsStatusEnum { HEALTHY = "HEALTHY", WARNING = "WARNING", FAILED = "FAILED" } /** * @export * @enum {string} */ export declare enum GetCampaignProbeSeriesBucketEnum { HOUR = "HOUR", DAY = "DAY" }