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.
130 lines (129 loc) • 3.54 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.
*/
/**
* Run-level metrics for analytics tables
* @export
* @interface DeliverabilityAnalyticsRunDto
*/
export interface DeliverabilityAnalyticsRunDto {
/**
*
* @type {string}
* @memberof DeliverabilityAnalyticsRunDto
*/
id: string;
/**
*
* @type {string}
* @memberof DeliverabilityAnalyticsRunDto
*/
name?: string | null;
/**
*
* @type {string}
* @memberof DeliverabilityAnalyticsRunDto
*/
scope: DeliverabilityAnalyticsRunDtoScopeEnum;
/**
*
* @type {string}
* @memberof DeliverabilityAnalyticsRunDto
*/
status: DeliverabilityAnalyticsRunDtoStatusEnum;
/**
*
* @type {Date}
* @memberof DeliverabilityAnalyticsRunDto
*/
createdAt: Date;
/**
*
* @type {Date}
* @memberof DeliverabilityAnalyticsRunDto
*/
startAt: Date;
/**
*
* @type {Date}
* @memberof DeliverabilityAnalyticsRunDto
*/
completedAt?: Date | null;
/**
*
* @type {number}
* @memberof DeliverabilityAnalyticsRunDto
*/
totalEntities: number;
/**
*
* @type {number}
* @memberof DeliverabilityAnalyticsRunDto
*/
matchedEntities: number;
/**
*
* @type {number}
* @memberof DeliverabilityAnalyticsRunDto
*/
unmatchedEntities: number;
/**
*
* @type {number}
* @memberof DeliverabilityAnalyticsRunDto
*/
completionPercentage: number;
/**
*
* @type {number}
* @memberof DeliverabilityAnalyticsRunDto
*/
successThresholdPercent?: number | null;
/**
*
* @type {string}
* @memberof DeliverabilityAnalyticsRunDto
*/
thresholdStatus: DeliverabilityAnalyticsRunDtoThresholdStatusEnum;
}
/**
* @export
* @enum {string}
*/
export declare enum DeliverabilityAnalyticsRunDtoScopeEnum {
INBOX = "INBOX",
PHONE = "PHONE"
}
/**
* @export
* @enum {string}
*/
export declare enum DeliverabilityAnalyticsRunDtoStatusEnum {
CREATED = "CREATED",
SCHEDULED = "SCHEDULED",
RUNNING = "RUNNING",
PAUSED = "PAUSED",
STOPPED = "STOPPED",
COMPLETE = "COMPLETE",
FAILED = "FAILED"
}
/**
* @export
* @enum {string}
*/
export declare enum DeliverabilityAnalyticsRunDtoThresholdStatusEnum {
NOT_CONFIGURED = "NOT_CONFIGURED",
PASSING = "PASSING",
FAILING = "FAILING"
}
export declare function DeliverabilityAnalyticsRunDtoFromJSON(json: any): DeliverabilityAnalyticsRunDto;
export declare function DeliverabilityAnalyticsRunDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeliverabilityAnalyticsRunDto;
export declare function DeliverabilityAnalyticsRunDtoToJSON(value?: DeliverabilityAnalyticsRunDto | null): any;