mailslurp-client
Version:
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.
156 lines (155 loc) • 4.22 kB
TypeScript
/**
* 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 { DeliverabilitySimulationJobConfigDto, DeliverabilitySimulationJobErrorSummaryDto } from './';
/**
* Deliverability simulation job status
* @export
* @interface DeliverabilitySimulationJobDto
*/
export interface DeliverabilitySimulationJobDto {
/**
*
* @type {string}
* @memberof DeliverabilitySimulationJobDto
*/
id: string;
/**
*
* @type {string}
* @memberof DeliverabilitySimulationJobDto
*/
testId: string;
/**
*
* @type {string}
* @memberof DeliverabilitySimulationJobDto
*/
scope: DeliverabilitySimulationJobDtoScopeEnum;
/**
*
* @type {string}
* @memberof DeliverabilitySimulationJobDto
*/
status: DeliverabilitySimulationJobDtoStatusEnum;
/**
*
* @type {Date}
* @memberof DeliverabilitySimulationJobDto
*/
createdAt: Date;
/**
*
* @type {Date}
* @memberof DeliverabilitySimulationJobDto
*/
updatedAt: Date;
/**
*
* @type {Date}
* @memberof DeliverabilitySimulationJobDto
*/
startedAt?: Date | null;
/**
*
* @type {Date}
* @memberof DeliverabilitySimulationJobDto
*/
completedAt?: Date | null;
/**
*
* @type {number}
* @memberof DeliverabilitySimulationJobDto
*/
totalTargets: number;
/**
*
* @type {number}
* @memberof DeliverabilitySimulationJobDto
*/
totalPlannedSends: number;
/**
*
* @type {number}
* @memberof DeliverabilitySimulationJobDto
*/
nextSendIndex: number;
/**
*
* @type {number}
* @memberof DeliverabilitySimulationJobDto
*/
sentCount: number;
/**
*
* @type {number}
* @memberof DeliverabilitySimulationJobDto
*/
successCount: number;
/**
*
* @type {number}
* @memberof DeliverabilitySimulationJobDto
*/
failureCount: number;
/**
*
* @type {number}
* @memberof DeliverabilitySimulationJobDto
*/
progressPercent: number;
/**
*
* @type {string}
* @memberof DeliverabilitySimulationJobDto
*/
activeTargetLabel?: string | null;
/**
*
* @type {number}
* @memberof DeliverabilitySimulationJobDto
*/
estimatedRemainingMs?: number | null;
/**
*
* @type {DeliverabilitySimulationJobConfigDto}
* @memberof DeliverabilitySimulationJobDto
*/
configSnapshot: DeliverabilitySimulationJobConfigDto;
/**
*
* @type {DeliverabilitySimulationJobErrorSummaryDto}
* @memberof DeliverabilitySimulationJobDto
*/
errorSummary: DeliverabilitySimulationJobErrorSummaryDto;
}
/**
* @export
* @enum {string}
*/
export declare enum DeliverabilitySimulationJobDtoScopeEnum {
INBOX = "INBOX",
PHONE = "PHONE"
}
/**
* @export
* @enum {string}
*/
export declare enum DeliverabilitySimulationJobDtoStatusEnum {
RUNNING = "RUNNING",
PAUSED = "PAUSED",
CANCELLED = "CANCELLED",
COMPLETED = "COMPLETED",
FAILED = "FAILED"
}
export declare function DeliverabilitySimulationJobDtoFromJSON(json: any): DeliverabilitySimulationJobDto;
export declare function DeliverabilitySimulationJobDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeliverabilitySimulationJobDto;
export declare function DeliverabilitySimulationJobDtoToJSON(value?: DeliverabilitySimulationJobDto | null): any;