export interface GetExtendedCampaignOverview { /** Url of the attachment file. Only available if the campaign has an attachment. */ attachmentFile?: string | undefined; /** Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled. */ abTesting?: boolean | undefined; /** ID of the campaign */ id: number; /** Name of the campaign */ name: string; /** Preview text or preheader of the email campaign */ previewText?: string | undefined; /** UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ) */ scheduledAt?: string | undefined; /** It is true if you have chosen to send your campaign at best time, otherwise it is false */ sendAtBestTime?: boolean | undefined; /** The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true` */ splitRule?: number | undefined; /** Status of the campaign */ status: GetExtendedCampaignOverview.Status; /** Subject of the campaign. Only available if `abTesting` flag of the campaign is `false` */ subject?: string | undefined; /** Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` */ subjectA?: string | undefined; /** Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true` */ subjectB?: string | undefined; /** Type of campaign */ type: GetExtendedCampaignOverview.Type; /** Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true` */ winnerCriteria?: string | undefined; /** The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true` */ winnerDelay?: number | undefined; /** URL of the attachment file associated with the campaign. Empty string if no attachment is present. */ attachmentUrl?: string | undefined; /** Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) */ createdAt: string; /** Expiration date configuration for the email campaign, if set. Contains the duration and unit of the email expiry. */ emailExpirationDate?: GetExtendedCampaignOverview.EmailExpirationDate | undefined; /** Footer of the campaign */ footer: string; /** Header of the campaign */ header: string; /** HTML content of the campaign */ htmlContent: string; /** Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. */ inlineImageActivation?: boolean | undefined; /** Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign */ mirrorActive?: boolean | undefined; /** UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) */ modifiedAt: string; /** FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times */ recurring?: boolean | undefined; /** Email defined as the "Reply to" of the campaign */ replyTo: string; /** Total number of non-delivered campaigns for a particular campaign id. */ returnBounce?: number | undefined; sender: GetExtendedCampaignOverview.Sender; /** Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent' */ sentDate?: string | undefined; /** Link to share the campaign on social media. For trigger campaigns, this returns a descriptive message instead of a URL. For classic campaigns that have not been sent, this also returns a descriptive message. */ shareLink?: string | undefined; /** Tag of the campaign */ tag?: string | undefined; /** List of tags of the campaign */ tags?: string[] | undefined; /** Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent) */ testSent: boolean; /** Customisation of the "to" field of the campaign */ toField?: string | undefined; /** The utm_campaign value applied to the campaign's tracking links. Falls back to your account's global UTM settings when no custom value was set on the campaign, or the campaign name if neither is configured. Only returned when UTM tracking is enabled on the campaign. */ utmCampaignValue?: string | undefined; /** The utm_content value applied to the campaign's tracking links. Falls back to your account's global UTM settings when no custom value was set on the campaign. Only returned when UTM tracking is enabled on the campaign and a value is set at one of these levels. */ utmContent?: string | undefined; /** Legacy numeric utm_id value applied to the campaign's tracking links. Present only when UTM tracking is enabled on the campaign and the resolved utm_id is numeric (typically the campaign's ID). For customer-supplied non-numeric values (for example `promo_042`), read `utmId` (string) instead. Kept for backward compatibility. */ utmID?: number | undefined; /** The utm_id value applied to the campaign's tracking links, returned verbatim as a string. Falls back to your account's global UTM settings when no custom value was set on the campaign. Only returned when UTM tracking is enabled on the campaign and a value is set at one of these levels. Preferred field for new consumers — covers both numeric IDs and customer-supplied non-numeric strings. */ utmId?: string | undefined; /** The utm_medium value applied to the campaign's tracking links. Falls back to your account's global UTM settings when no custom value was set on the campaign, or the default `email` if neither is configured. Case is preserved verbatim. Only returned when UTM tracking is enabled on the campaign. */ utmMedium?: string | undefined; /** The utm_source value applied to the campaign's tracking links. Falls back to your account's global UTM settings when no custom value was set on the campaign, or the account default (`brevo` or `sendinblue`) if neither is configured. Case is preserved verbatim. Only returned when UTM tracking is enabled on the campaign. */ utmSource?: string | undefined; /** The utm_term value applied to the campaign's tracking links. Falls back to your account's global UTM settings when no custom value was set on the campaign. Only returned when UTM tracking is enabled on the campaign and a value is set at one of these levels. */ utmTerm?: string | undefined; } export declare namespace GetExtendedCampaignOverview { /** Status of the campaign */ const Status: { readonly Draft: "draft"; readonly Sent: "sent"; readonly Archive: "archive"; readonly Queued: "queued"; readonly Suspended: "suspended"; readonly InProcess: "in_process"; readonly InReview: "in_review"; readonly Cancelling: "cancelling"; readonly Cancelled: "cancelled"; }; type Status = (typeof Status)[keyof typeof Status]; /** Type of campaign */ const Type: { readonly Classic: "classic"; readonly Trigger: "trigger"; }; type Type = (typeof Type)[keyof typeof Type]; /** * Expiration date configuration for the email campaign, if set. Contains the duration and unit of the email expiry. */ interface EmailExpirationDate { /** Duration of the email expiry */ duration?: number | undefined; /** Unit of the duration */ unit?: EmailExpirationDate.Unit | undefined; } namespace EmailExpirationDate { /** Unit of the duration */ const Unit: { readonly Days: "days"; readonly Weeks: "weeks"; readonly Months: "months"; }; type Unit = (typeof Unit)[keyof typeof Unit]; } interface Sender { /** Sender email of the campaign */ email?: string | undefined; /** Sender id of the campaign */ id?: number | undefined; /** Sender name of the campaign */ name?: string | undefined; } }