/* tslint:disable */
/* eslint-disable */
/**
 * Constant Contact API v3
 * Swagger build version 3.0.2475
 *
 * The version of the OpenAPI document: 1.0.116
 * Contact: webservices@constantcontact.com
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */


// May contain unused imports in some cases
// @ts-ignore
import { GetEmailCampaignActivity200ResponseDocumentProperties } from './get-email-campaign-activity200-response-document-properties';
// May contain unused imports in some cases
// @ts-ignore
import { GetEmailCampaignActivity200ResponsePhysicalAddressInFooter } from './get-email-campaign-activity200-response-physical-address-in-footer';

/**
 * 
 * @export
 * @interface EmailCampaignActivity
 */
export interface EmailCampaignActivity {
    /**
     * Identifies a campaign activity in the V3 API.
     * @type {string}
     * @memberof EmailCampaignActivity
     */
    'campaign_activity_id'?: string;
    /**
     * Identifies a campaign in the V3 API.
     * @type {string}
     * @memberof EmailCampaignActivity
     */
    'campaign_id'?: string;
    /**
     * The purpose of the individual campaign activity in the larger email campaign effort. Valid values are: <ul>   <li>primary_email — The main email marketing campaign that you send to contacts. The <code>primary_email</code> contains the complete email content.</li>   <li>permalink — A permanent link to a web accessible version of the <code>primary_email</code> content without any personalized email information. For example, permalinks do not contain any of the contact details that you add to the <code>primary_email</code> email content. </li>   <li>resend — An email campaign that you resend to contacts that did not open the email campaign.</li> </ul> Constant Contact creates a <code>primary_email</code> and a <code>permalink</code> role campaign activity when you create an email campaign. 
     * @type {string}
     * @memberof EmailCampaignActivity
     */
    'role'?: string;
    /**
     * The contacts that Constant Contact sends the email campaign activity to as an array of contact <code>list_id</code> values. You cannot use contact lists and segments at the same time in an email campaign activity.
     * @type {Array<string>}
     * @memberof EmailCampaignActivity
     */
    'contact_list_ids'?: Array<string>;
    /**
     * The contacts that Constant Contact sends the email campaign activity to as an array containing a single <code>segment_id</code> value. Only <code>format_type</code> 3, 4, and 5 email campaign activities support segments. You cannot use contact lists and segments at the same time in an email campaign activity.
     * @type {Array<number>}
     * @memberof EmailCampaignActivity
     */
    'segment_ids'?: Array<number>;
    /**
     * The current status of the email campaign activity. Valid values are: <ul>   <li>DRAFT — An email campaign activity that you have created but have not sent to contacts.</li>   <li>SCHEDULED — An email campaign activity that you have scheduled for Constant Contact to send to contacts.</li>   <li>EXECUTING — An email campaign activity Constant Contact is currently sending to contacts. Email campaign activities are only in this status briefly.</li>   <li>DONE — An email campaign activity that you successfully sent to contacts.</li>   <li>ERROR — An email campaign activity that encountered an error.</li>   <li>REMOVED — An email campaign that a user deleted. Users can view and restore deleted emails through the UI.</li> </ul> 
     * @type {string}
     * @memberof EmailCampaignActivity
     */
    'current_status'?: string;
    /**
     * Identifies the type of email format. Valid values are: <ul>   <li>1 - A legacy custom code email created using the V2 API, the V3 API, or the legacy UI HTML editor.</li>   <li>2 - An email created using the second generation email editor UI.</li>   <li>3 - An email created using the third generation email editor UI. This email editor features an improved drag and drop UI and mobile responsiveness.</li>   <li>4 - An email created using the fourth generation email editor UI.</li>   <li>5 - A custom code email created using the V3 API or the new UI HTML editor.</li> </ul> 
     * @type {number}
     * @memberof EmailCampaignActivity
     */
    'format_type'?: number;
    /**
     * The email \"From Email\" field for the email campaign activity. You must use a confirmed Constant Contact account email address. Make a GET call to <code>/account/emails</code> to return a collection of account emails and their confirmation status.
     * @type {string}
     * @memberof EmailCampaignActivity
     */
    'from_email': string;
    /**
     * The email \"From Name\" field for the email campaign activity.
     * @type {string}
     * @memberof EmailCampaignActivity
     */
    'from_name': string;
    /**
     * The email \"Reply To Email\" field for the email campaign activity. You must use a confirmed Constant Contact account email address. Make a GET call to <code>/account/emails</code> to return a collection of account emails and their confirmation status.
     * @type {string}
     * @memberof EmailCampaignActivity
     */
    'reply_to_email': string;
    /**
     * The email \"Subject\" field for the email campaign activity.
     * @type {string}
     * @memberof EmailCampaignActivity
     */
    'subject': string;
    /**
     * The HTML or XHTML content for the email campaign activity. Only <code>format_type</code> 1 and 5 (legacy custom code emails or modern custom code emails) can contain <code>html_content</code>.
     * @type {string}
     * @memberof EmailCampaignActivity
     */
    'html_content'?: string;
    /**
     * Identifies the email layout and design template that the email campaign activity is using as a base.
     * @type {string}
     * @memberof EmailCampaignActivity
     */
    'template_id'?: string;
    /**
     * The permanent link to a web accessible version of the email campaign content without any personalized email information. The permalink URL becomes accessible after you send an email campaign to contacts.
     * @type {string}
     * @memberof EmailCampaignActivity
     */
    'permalink_url'?: string;
    /**
     * The email preheader for the email campaign activity. Only <code>format_type</code> 3, 4, and 5 email campaign activities use the preheader property.
     * @type {string}
     * @memberof EmailCampaignActivity
     */
    'preheader'?: string;
    /**
     * 
     * @type {GetEmailCampaignActivity200ResponsePhysicalAddressInFooter}
     * @memberof EmailCampaignActivity
     */
    'physical_address_in_footer'?: GetEmailCampaignActivity200ResponsePhysicalAddressInFooter;
    /**
     * 
     * @type {GetEmailCampaignActivity200ResponseDocumentProperties}
     * @memberof EmailCampaignActivity
     */
    'document_properties'?: GetEmailCampaignActivity200ResponseDocumentProperties;
}