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.
56 lines (55 loc) • 2.19 kB
TypeScript
/**
* MailSlurp API
* MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. 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.
*/
/**
* Options for matching SMS messages in a phone number. Each match option object contains a `field`, `should` and `value` property. Together they form logical conditions such as `BODY` should `CONTAIN` value.
* @export
* @interface SmsMatchOption
*/
export interface SmsMatchOption {
/**
* Fields of an SMS object that can be used to filter results
* @type {string}
* @memberof SmsMatchOption
*/
field: SmsMatchOptionFieldEnum;
/**
* How the value of the email field specified should be compared to the value given in the match options.
* @type {string}
* @memberof SmsMatchOption
*/
should: SmsMatchOptionShouldEnum;
/**
* The value you wish to compare with the value of the field specified using the `should` value passed. For example `BODY` should `CONTAIN` a value passed.
* @type {string}
* @memberof SmsMatchOption
*/
value: string;
}
/**
* @export
* @enum {string}
*/
export declare enum SmsMatchOptionFieldEnum {
BODY = "BODY",
FROM = "FROM"
}
/**
* @export
* @enum {string}
*/
export declare enum SmsMatchOptionShouldEnum {
CONTAIN = "CONTAIN",
EQUAL = "EQUAL"
}
export declare function SmsMatchOptionFromJSON(json: any): SmsMatchOption;
export declare function SmsMatchOptionFromJSONTyped(json: any, ignoreDiscriminator: boolean): SmsMatchOption;
export declare function SmsMatchOptionToJSON(value?: SmsMatchOption | null): any;