mailslurp-client/dist/generated/models/DeliverabilityTestDto.d.ts

Official client for MailSlurp Email and SMS API. Create email addresses and phone numbers in Javascript without a mail server. Send and receive real emails in applications or tests.

/**
 * 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 { DeliverabilityExpectation, DeliverabilitySelectorOptions } from './';
/**
 * Deliverability test configuration and progress summary
 * @export
 * @interface DeliverabilityTestDto
 */
export interface DeliverabilityTestDto {
    /**
     *
     * @type {string}
     * @memberof DeliverabilityTestDto
     */
    id: string;
    /**
     *
     * @type {string}
     * @memberof DeliverabilityTestDto
     */
    name?: string | null;
    /**
     *
     * @type {string}
     * @memberof DeliverabilityTestDto
     */
    description?: string | null;
    /**
     *
     * @type {string}
     * @memberof DeliverabilityTestDto
     */
    scope: DeliverabilityTestDtoScopeEnum;
    /**
     *
     * @type {DeliverabilitySelectorOptions}
     * @memberof DeliverabilityTestDto
     */
    selector: DeliverabilitySelectorOptions;
    /**
     *
     * @type {number}
     * @memberof DeliverabilityTestDto
     */
    selectedEntityCount: number;
    /**
     *
     * @type {Array<DeliverabilityExpectation>}
     * @memberof DeliverabilityTestDto
     */
    expectations: Array<DeliverabilityExpectation>;
    /**
     *
     * @type {string}
     * @memberof DeliverabilityTestDto
     */
    status: DeliverabilityTestDtoStatusEnum;
    /**
     *
     * @type {Date}
     * @memberof DeliverabilityTestDto
     */
    startAt: Date;
    /**
     *
     * @type {Date}
     * @memberof DeliverabilityTestDto
     */
    startedAt?: Date | null;
    /**
     *
     * @type {Date}
     * @memberof DeliverabilityTestDto
     */
    completedAt?: Date | null;
    /**
     *
     * @type {number}
     * @memberof DeliverabilityTestDto
     */
    maxDurationSeconds?: number | null;
    /**
     *
     * @type {number}
     * @memberof DeliverabilityTestDto
     */
    successThresholdPercent?: number | null;
    /**
     *
     * @type {string}
     * @memberof DeliverabilityTestDto
     */
    thresholdStatus: DeliverabilityTestDtoThresholdStatusEnum;
    /**
     *
     * @type {boolean}
     * @memberof DeliverabilityTestDto
     */
    thresholdMet?: boolean | null;
    /**
     *
     * @type {Date}
     * @memberof DeliverabilityTestDto
     */
    lastEvaluatedAt?: Date | null;
    /**
     *
     * @type {number}
     * @memberof DeliverabilityTestDto
     */
    totalEntities: number;
    /**
     *
     * @type {number}
     * @memberof DeliverabilityTestDto
     */
    matchedEntities: number;
    /**
     *
     * @type {number}
     * @memberof DeliverabilityTestDto
     */
    unmatchedEntities: number;
    /**
     *
     * @type {number}
     * @memberof DeliverabilityTestDto
     */
    completionPercentage: number;
    /**
     *
     * @type {boolean}
     * @memberof DeliverabilityTestDto
     */
    timedOut: boolean;
    /**
     *
     * @type {string}
     * @memberof DeliverabilityTestDto
     */
    failureReason?: string | null;
    /**
     *
     * @type {Date}
     * @memberof DeliverabilityTestDto
     */
    createdAt: Date;
    /**
     *
     * @type {Date}
     * @memberof DeliverabilityTestDto
     */
    updatedAt: Date;
}
/**
 * @export
 * @enum {string}
 */
export declare enum DeliverabilityTestDtoScopeEnum {
    INBOX = "INBOX",
    PHONE = "PHONE"
}
/**
 * @export
 * @enum {string}
 */
export declare enum DeliverabilityTestDtoStatusEnum {
    CREATED = "CREATED",
    SCHEDULED = "SCHEDULED",
    RUNNING = "RUNNING",
    PAUSED = "PAUSED",
    STOPPED = "STOPPED",
    COMPLETE = "COMPLETE",
    FAILED = "FAILED"
}
/**
 * @export
 * @enum {string}
 */
export declare enum DeliverabilityTestDtoThresholdStatusEnum {
    NOT_CONFIGURED = "NOT_CONFIGURED",
    PASSING = "PASSING",
    FAILING = "FAILING"
}
export declare function DeliverabilityTestDtoFromJSON(json: any): DeliverabilityTestDto;
export declare function DeliverabilityTestDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeliverabilityTestDto;
export declare function DeliverabilityTestDtoToJSON(value?: DeliverabilityTestDto | null): any;