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.
76 lines (75 loc) • 2.56 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 creating an email contact in address book
* @export
* @interface CreateContactOptions
*/
export interface CreateContactOptions {
/**
*
* @type {string}
* @memberof CreateContactOptions
*/
firstName?: string | null;
/**
*
* @type {string}
* @memberof CreateContactOptions
*/
lastName?: string | null;
/**
*
* @type {string}
* @memberof CreateContactOptions
*/
company?: string | null;
/**
* Set of email addresses belonging to the contact
* @type {Array<string>}
* @memberof CreateContactOptions
*/
emailAddresses?: Array<string> | null;
/**
* Tags that can be used to search and group contacts
* @type {Array<string>}
* @memberof CreateContactOptions
*/
tags?: Array<string> | null;
/**
*
* @type {object}
* @memberof CreateContactOptions
*/
metaData?: object | null;
/**
* Has the user explicitly or implicitly opted out of being contacted? If so MailSlurp will ignore them in all actions.
* @type {boolean}
* @memberof CreateContactOptions
*/
optOut?: boolean | null;
/**
* Group IDs that contact belongs to
* @type {string}
* @memberof CreateContactOptions
*/
groupId?: string | null;
/**
* Whether to validate contact email address exists
* @type {boolean}
* @memberof CreateContactOptions
*/
verifyEmailAddresses?: boolean | null;
}
export declare function CreateContactOptionsFromJSON(json: any): CreateContactOptions;
export declare function CreateContactOptionsFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateContactOptions;
export declare function CreateContactOptionsToJSON(value?: CreateContactOptions | null): any;