/** * 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 { CreateInboxPlacementTestOptions, InboxPlacementAnalysisBundleDto, InboxPlacementAnalyticsBreakdownDto, InboxPlacementAnalyticsSeriesDto, InboxPlacementPublicShareDto, InboxPlacementTestResultsDto, InboxPlacementTestRunDto } from '../models'; export interface CreateInboxPlacementTestRequest { createInboxPlacementTestOptions: CreateInboxPlacementTestOptions; } export interface ExportInboxPlacementTestResultsRequest { id: string; } export interface GetInboxPlacementAnalyticsBreakdownRequest { since?: Date; before?: Date; senderDomain?: string; fromEmail?: string; limit?: number; } export interface GetInboxPlacementAnalyticsSeriesRequest { since?: Date; before?: Date; bucket?: GetInboxPlacementAnalyticsSeriesBucketEnum; groupBy?: GetInboxPlacementAnalyticsSeriesGroupByEnum; senderDomain?: string; fromEmail?: string; runLimit?: number; groupLimit?: number; } export interface GetInboxPlacementPublicShareRequest { shareToken: string; } export interface GetInboxPlacementPublicShareAnalysisRequest { shareToken: string; } export interface GetInboxPlacementTestRequest { id: string; } export interface GetInboxPlacementTestAnalysisRequest { id: string; } export interface GetInboxPlacementTestResultsRequest { id: string; } export interface GetInboxPlacementTestsRequest { limit?: number; } /** * */ export declare class ApiInboxPlacementTestControllerApi extends runtime.BaseAPI { /** * Create a new direct-send inbox placement test */ createInboxPlacementTestRaw(requestParameters: CreateInboxPlacementTestRequest, initOverrides?: RequestInit): Promise>; /** * Create a new direct-send inbox placement test */ createInboxPlacementTest(requestParameters: CreateInboxPlacementTestRequest, initOverrides?: RequestInit): Promise; /** * Export one row per placement target, including run-level delivery totals, 0-10 placement scores, and target placement outcome fields. * Export inbox placement test results as CSV */ exportInboxPlacementTestResultsRaw(requestParameters: ExportInboxPlacementTestResultsRequest, initOverrides?: RequestInit): Promise>; /** * Export one row per placement target, including run-level delivery totals, 0-10 placement scores, and target placement outcome fields. * Export inbox placement test results as CSV */ exportInboxPlacementTestResults(requestParameters: ExportInboxPlacementTestResultsRequest, initOverrides?: RequestInit): Promise; /** * Return aggregated folder, provider, sender-domain, and from-email breakdowns for inbox placement runs in a time range. * Get inbox placement analytics breakdowns */ getInboxPlacementAnalyticsBreakdownRaw(requestParameters: GetInboxPlacementAnalyticsBreakdownRequest, initOverrides?: RequestInit): Promise>; /** * Return aggregated folder, provider, sender-domain, and from-email breakdowns for inbox placement runs in a time range. * Get inbox placement analytics breakdowns */ getInboxPlacementAnalyticsBreakdown(requestParameters: GetInboxPlacementAnalyticsBreakdownRequest, initOverrides?: RequestInit): Promise; /** * Return chart-ready inbox placement metrics over time, with optional sender/domain filters and grouped comparisons for sender domains or from-email addresses. * Get inbox placement analytics time series */ getInboxPlacementAnalyticsSeriesRaw(requestParameters: GetInboxPlacementAnalyticsSeriesRequest, initOverrides?: RequestInit): Promise>; /** * Return chart-ready inbox placement metrics over time, with optional sender/domain filters and grouped comparisons for sender domains or from-email addresses. * Get inbox placement analytics time series */ getInboxPlacementAnalyticsSeries(requestParameters: GetInboxPlacementAnalyticsSeriesRequest, initOverrides?: RequestInit): Promise; /** * Get a public inbox placement share */ getInboxPlacementPublicShareRaw(requestParameters: GetInboxPlacementPublicShareRequest, initOverrides?: RequestInit): Promise>; /** * Get a public inbox placement share */ getInboxPlacementPublicShare(requestParameters: GetInboxPlacementPublicShareRequest, initOverrides?: RequestInit): Promise; /** * Get public inbox placement share analysis */ getInboxPlacementPublicShareAnalysisRaw(requestParameters: GetInboxPlacementPublicShareAnalysisRequest, initOverrides?: RequestInit): Promise>; /** * Get public inbox placement share analysis */ getInboxPlacementPublicShareAnalysis(requestParameters: GetInboxPlacementPublicShareAnalysisRequest, initOverrides?: RequestInit): Promise; /** * Get inbox placement test run */ getInboxPlacementTestRaw(requestParameters: GetInboxPlacementTestRequest, initOverrides?: RequestInit): Promise>; /** * Get inbox placement test run */ getInboxPlacementTest(requestParameters: GetInboxPlacementTestRequest, initOverrides?: RequestInit): Promise; /** * Get inbox placement run analysis */ getInboxPlacementTestAnalysisRaw(requestParameters: GetInboxPlacementTestAnalysisRequest, initOverrides?: RequestInit): Promise>; /** * Get inbox placement run analysis */ getInboxPlacementTestAnalysis(requestParameters: GetInboxPlacementTestAnalysisRequest, initOverrides?: RequestInit): Promise; /** * Get inbox placement test results */ getInboxPlacementTestResultsRaw(requestParameters: GetInboxPlacementTestResultsRequest, initOverrides?: RequestInit): Promise>; /** * Get inbox placement test results */ getInboxPlacementTestResults(requestParameters: GetInboxPlacementTestResultsRequest, initOverrides?: RequestInit): Promise; /** * List inbox placement test runs */ getInboxPlacementTestsRaw(requestParameters: GetInboxPlacementTestsRequest, initOverrides?: RequestInit): Promise>>; /** * List inbox placement test runs */ getInboxPlacementTests(requestParameters: GetInboxPlacementTestsRequest, initOverrides?: RequestInit): Promise>; } /** * @export * @enum {string} */ export declare enum GetInboxPlacementAnalyticsSeriesBucketEnum { HOUR = "HOUR", DAY = "DAY" } /** * @export * @enum {string} */ export declare enum GetInboxPlacementAnalyticsSeriesGroupByEnum { NONE = "NONE", SENDER_DOMAIN = "SENDER_DOMAIN", FROM_EMAIL = "FROM_EMAIL" }