Package software.xdev.brevo.model

Class GetEmailCampaignsCampaignsInner

java.lang.Object

software.xdev.brevo.model.GetEmailCampaignsCampaignsInner

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class GetEmailCampaignsCampaignsInner
extends Object

GetEmailCampaignsCampaignsInner

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	GetEmailCampaignsCampaignsInner.StatusEnum	Status of the campaign
static enum	GetEmailCampaignsCampaignsInner.TypeEnum	Type of campaign

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_AB_TESTING
static final String	JSON_PROPERTY_CREATED_AT
static final String	JSON_PROPERTY_FOOTER
static final String	JSON_PROPERTY_HEADER
static final String	JSON_PROPERTY_HTML_CONTENT
static final String	JSON_PROPERTY_ID
static final String	JSON_PROPERTY_INLINE_IMAGE_ACTIVATION
static final String	JSON_PROPERTY_MIRROR_ACTIVE
static final String	JSON_PROPERTY_MODIFIED_AT
static final String	JSON_PROPERTY_NAME
static final String	JSON_PROPERTY_PREVIEW_TEXT
static final String	JSON_PROPERTY_RECIPIENTS
static final String	JSON_PROPERTY_RECURRING
static final String	JSON_PROPERTY_REPLY_TO
static final String	JSON_PROPERTY_RETURN_BOUNCE
static final String	JSON_PROPERTY_SCHEDULED_AT
static final String	JSON_PROPERTY_SEND_AT_BEST_TIME
static final String	JSON_PROPERTY_SENDER
static final String	JSON_PROPERTY_SENT_DATE
static final String	JSON_PROPERTY_SHARE_LINK
static final String	JSON_PROPERTY_SPLIT_RULE
static final String	JSON_PROPERTY_STATISTICS
static final String	JSON_PROPERTY_STATUS
static final String	JSON_PROPERTY_SUBJECT
static final String	JSON_PROPERTY_SUBJECT_A
static final String	JSON_PROPERTY_SUBJECT_B
static final String	JSON_PROPERTY_TAG
static final String	JSON_PROPERTY_TEST_SENT
static final String	JSON_PROPERTY_TO_FIELD
static final String	JSON_PROPERTY_TYPE
static final String	JSON_PROPERTY_WINNER_CRITERIA
static final String	JSON_PROPERTY_WINNER_DELAY

Constructor Summary

Constructors

Constructor	Description
GetEmailCampaignsCampaignsInner()

Method Summary

Modifier and Type	Method	Description
GetEmailCampaignsCampaignsInner	abTesting(Boolean abTesting)
GetEmailCampaignsCampaignsInner	createdAt(String createdAt)
boolean	equals(Object o)
GetEmailCampaignsCampaignsInner	footer(String footer)
Boolean	getAbTesting()	Status of A/B Test for the campaign.
String	getCreatedAt()	Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
String	getFooter()	Footer of the campaign
String	getHeader()	Header of the campaign
String	getHtmlContent()	HTML content of the campaign
Long	getId()	ID of the campaign
Boolean	getInlineImageActivation()	Status of inline image.
Boolean	getMirrorActive()	Status of mirror links in campaign.
String	getModifiedAt()	UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
String	getName()	Name of the campaign
String	getPreviewText()	Preview text or preheader of the email campaign
GetCampaignRecipients	getRecipients()	Get recipients
Boolean	getRecurring()	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
String	getReplyTo()	Email defined as the \"Reply to\" of the campaign
Long	getReturnBounce()	Total number of non-delivered campaigns for a particular campaign id.
String	getScheduledAt()	UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ)
Boolean	getSendAtBestTime()	It is true if you have chosen to send your campaign at best time, otherwise it is false
GetExtendedCampaignOverviewAllOfSender	getSender()	Get sender
String	getSentDate()	Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ).
String	getShareLink()	Link to share the campaign on social medias
Integer	getSplitRule()	The size of your ab-test groups.
GetExtendedCampaignStats	getStatistics()	Get statistics
GetEmailCampaignsCampaignsInner.StatusEnum	getStatus()	Status of the campaign
String	getSubject()	Subject of the campaign.
String	getSubjectA()	Subject A of the ab-test campaign.
String	getSubjectB()	Subject B of the ab-test campaign.
String	getTag()	Tag of the campaign
Boolean	getTestSent()	Retrieved the status of test email sending.
String	getToField()	Customisation of the \"to\" field of the campaign
GetEmailCampaignsCampaignsInner.TypeEnum	getType()	Type of campaign
String	getWinnerCriteria()	Criteria for the winning version.
Integer	getWinnerDelay()	The duration of the test in hours at the end of which the winning version will be sent.
int	hashCode()
GetEmailCampaignsCampaignsInner	header(String header)
GetEmailCampaignsCampaignsInner	htmlContent(String htmlContent)
GetEmailCampaignsCampaignsInner	id(Long id)
GetEmailCampaignsCampaignsInner	inlineImageActivation(Boolean inlineImageActivation)
GetEmailCampaignsCampaignsInner	mirrorActive(Boolean mirrorActive)
GetEmailCampaignsCampaignsInner	modifiedAt(String modifiedAt)
GetEmailCampaignsCampaignsInner	name(String name)
GetEmailCampaignsCampaignsInner	previewText(String previewText)
GetEmailCampaignsCampaignsInner	recipients(GetCampaignRecipients recipients)
GetEmailCampaignsCampaignsInner	recurring(Boolean recurring)
GetEmailCampaignsCampaignsInner	replyTo(String replyTo)
GetEmailCampaignsCampaignsInner	returnBounce(Long returnBounce)
GetEmailCampaignsCampaignsInner	scheduledAt(String scheduledAt)
GetEmailCampaignsCampaignsInner	sendAtBestTime(Boolean sendAtBestTime)
GetEmailCampaignsCampaignsInner	sender(GetExtendedCampaignOverviewAllOfSender sender)
GetEmailCampaignsCampaignsInner	sentDate(String sentDate)
void	setAbTesting(Boolean abTesting)
void	setCreatedAt(String createdAt)
void	setFooter(String footer)
void	setHeader(String header)
void	setHtmlContent(String htmlContent)
void	setId(Long id)
void	setInlineImageActivation(Boolean inlineImageActivation)
void	setMirrorActive(Boolean mirrorActive)
void	setModifiedAt(String modifiedAt)
void	setName(String name)
void	setPreviewText(String previewText)
void	setRecipients(GetCampaignRecipients recipients)
void	setRecurring(Boolean recurring)
void	setReplyTo(String replyTo)
void	setReturnBounce(Long returnBounce)
void	setScheduledAt(String scheduledAt)
void	setSendAtBestTime(Boolean sendAtBestTime)
void	setSender(GetExtendedCampaignOverviewAllOfSender sender)
void	setSentDate(String sentDate)
void	setShareLink(String shareLink)
void	setSplitRule(Integer splitRule)
void	setStatistics(GetExtendedCampaignStats statistics)
void	setStatus(GetEmailCampaignsCampaignsInner.StatusEnum status)
void	setSubject(String subject)
void	setSubjectA(String subjectA)
void	setSubjectB(String subjectB)
void	setTag(String tag)
void	setTestSent(Boolean testSent)
void	setToField(String toField)
void	setType(GetEmailCampaignsCampaignsInner.TypeEnum type)
void	setWinnerCriteria(String winnerCriteria)
void	setWinnerDelay(Integer winnerDelay)
GetEmailCampaignsCampaignsInner	shareLink(String shareLink)
GetEmailCampaignsCampaignsInner	splitRule(Integer splitRule)
GetEmailCampaignsCampaignsInner	statistics(GetExtendedCampaignStats statistics)
GetEmailCampaignsCampaignsInner	status(GetEmailCampaignsCampaignsInner.StatusEnum status)
GetEmailCampaignsCampaignsInner	subject(String subject)
GetEmailCampaignsCampaignsInner	subjectA(String subjectA)
GetEmailCampaignsCampaignsInner	subjectB(String subjectB)
GetEmailCampaignsCampaignsInner	tag(String tag)
GetEmailCampaignsCampaignsInner	testSent(Boolean testSent)
GetEmailCampaignsCampaignsInner	toField(String toField)
String	toString()
String	toUrlQueryString()	Convert the instance into URL query string.
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.
GetEmailCampaignsCampaignsInner	type(GetEmailCampaignsCampaignsInner.TypeEnum type)
GetEmailCampaignsCampaignsInner	winnerCriteria(String winnerCriteria)
GetEmailCampaignsCampaignsInner	winnerDelay(Integer winnerDelay)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON_PROPERTY_ID

public static final String JSON_PROPERTY_ID

See Also:

• Constant Field Values

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_SUBJECT

public static final String JSON_PROPERTY_SUBJECT

See Also:

• Constant Field Values

JSON_PROPERTY_PREVIEW_TEXT

public static final String JSON_PROPERTY_PREVIEW_TEXT

See Also:

• Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_STATUS

public static final String JSON_PROPERTY_STATUS

See Also:

• Constant Field Values

JSON_PROPERTY_SCHEDULED_AT

public static final String JSON_PROPERTY_SCHEDULED_AT

See Also:

• Constant Field Values

JSON_PROPERTY_AB_TESTING

public static final String JSON_PROPERTY_AB_TESTING

See Also:

• Constant Field Values

JSON_PROPERTY_SUBJECT_A

public static final String JSON_PROPERTY_SUBJECT_A

See Also:

• Constant Field Values

JSON_PROPERTY_SUBJECT_B

public static final String JSON_PROPERTY_SUBJECT_B

See Also:

• Constant Field Values

JSON_PROPERTY_SPLIT_RULE

public static final String JSON_PROPERTY_SPLIT_RULE

See Also:

• Constant Field Values

JSON_PROPERTY_WINNER_CRITERIA

public static final String JSON_PROPERTY_WINNER_CRITERIA

See Also:

• Constant Field Values

JSON_PROPERTY_WINNER_DELAY

public static final String JSON_PROPERTY_WINNER_DELAY

See Also:

• Constant Field Values

JSON_PROPERTY_SEND_AT_BEST_TIME

public static final String JSON_PROPERTY_SEND_AT_BEST_TIME

See Also:

• Constant Field Values

JSON_PROPERTY_TEST_SENT

public static final String JSON_PROPERTY_TEST_SENT

See Also:

• Constant Field Values

JSON_PROPERTY_HEADER

public static final String JSON_PROPERTY_HEADER

See Also:

• Constant Field Values

JSON_PROPERTY_FOOTER

public static final String JSON_PROPERTY_FOOTER

See Also:

• Constant Field Values

JSON_PROPERTY_SENDER

public static final String JSON_PROPERTY_SENDER

See Also:

• Constant Field Values

JSON_PROPERTY_REPLY_TO

public static final String JSON_PROPERTY_REPLY_TO

See Also:

• Constant Field Values

JSON_PROPERTY_TO_FIELD

public static final String JSON_PROPERTY_TO_FIELD

See Also:

• Constant Field Values

JSON_PROPERTY_HTML_CONTENT

public static final String JSON_PROPERTY_HTML_CONTENT

See Also:

• Constant Field Values

JSON_PROPERTY_SHARE_LINK

public static final String JSON_PROPERTY_SHARE_LINK

See Also:

• Constant Field Values

JSON_PROPERTY_TAG

public static final String JSON_PROPERTY_TAG

See Also:

• Constant Field Values

JSON_PROPERTY_CREATED_AT

public static final String JSON_PROPERTY_CREATED_AT

See Also:

• Constant Field Values

JSON_PROPERTY_MODIFIED_AT

public static final String JSON_PROPERTY_MODIFIED_AT

See Also:

• Constant Field Values

JSON_PROPERTY_INLINE_IMAGE_ACTIVATION

public static final String JSON_PROPERTY_INLINE_IMAGE_ACTIVATION

See Also:

• Constant Field Values

JSON_PROPERTY_MIRROR_ACTIVE

public static final String JSON_PROPERTY_MIRROR_ACTIVE

See Also:

• Constant Field Values

JSON_PROPERTY_RECURRING

public static final String JSON_PROPERTY_RECURRING

See Also:

• Constant Field Values

JSON_PROPERTY_SENT_DATE

public static final String JSON_PROPERTY_SENT_DATE

See Also:

• Constant Field Values

JSON_PROPERTY_RETURN_BOUNCE

public static final String JSON_PROPERTY_RETURN_BOUNCE

See Also:

• Constant Field Values

JSON_PROPERTY_RECIPIENTS

public static final String JSON_PROPERTY_RECIPIENTS

See Also:

• Constant Field Values

JSON_PROPERTY_STATISTICS

public static final String JSON_PROPERTY_STATISTICS

See Also:

• Constant Field Values

Constructor Details

GetEmailCampaignsCampaignsInner

public GetEmailCampaignsCampaignsInner()

Method Details

id

public GetEmailCampaignsCampaignsInner id(Long id)

getId

@Nonnull
public Long getId()

ID of the campaign

Returns:

id

setId

public void setId(Long id)

name

public GetEmailCampaignsCampaignsInner name(String name)

getName

@Nonnull
public String getName()

Name of the campaign

Returns:

name

setName

public void setName(String name)

subject

public GetEmailCampaignsCampaignsInner subject(String subject)

getSubject

@Nullable
public String getSubject()

Subject of the campaign. Only available if `abTesting` flag of the campaign is `false`

Returns:

subject

setSubject

public void setSubject(String subject)

previewText

public GetEmailCampaignsCampaignsInner previewText(String previewText)

getPreviewText

@Nullable
public String getPreviewText()

Preview text or preheader of the email campaign

Returns:

previewText

setPreviewText

public void setPreviewText(String previewText)

type

public GetEmailCampaignsCampaignsInner type(GetEmailCampaignsCampaignsInner.TypeEnum type)

getType

@Nonnull
public GetEmailCampaignsCampaignsInner.TypeEnum getType()

Type of campaign

Returns:

type

setType

public void setType(GetEmailCampaignsCampaignsInner.TypeEnum type)

status

public GetEmailCampaignsCampaignsInner status(GetEmailCampaignsCampaignsInner.StatusEnum status)

getStatus

@Nonnull
public GetEmailCampaignsCampaignsInner.StatusEnum getStatus()

Status of the campaign

Returns:

status

setStatus

public void setStatus(GetEmailCampaignsCampaignsInner.StatusEnum status)

scheduledAt

public GetEmailCampaignsCampaignsInner scheduledAt(String scheduledAt)

getScheduledAt

@Nullable
public String getScheduledAt()

UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ)

Returns:

scheduledAt

setScheduledAt

public void setScheduledAt(String scheduledAt)

abTesting

public GetEmailCampaignsCampaignsInner abTesting(Boolean abTesting)

getAbTesting

@Nullable
public Boolean getAbTesting()

Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled.

Returns:

abTesting

setAbTesting

public void setAbTesting(Boolean abTesting)

subjectA

public GetEmailCampaignsCampaignsInner subjectA(String subjectA)

getSubjectA

@Nullable
public String getSubjectA()

Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true`

Returns:

subjectA

setSubjectA

public void setSubjectA(String subjectA)

subjectB

public GetEmailCampaignsCampaignsInner subjectB(String subjectB)

getSubjectB

@Nullable
public String getSubjectB()

Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true`

Returns:

subjectB

setSubjectB

public void setSubjectB(String subjectB)

splitRule

public GetEmailCampaignsCampaignsInner splitRule(Integer splitRule)

getSplitRule

@Nullable
public Integer getSplitRule()

The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true`

Returns:

splitRule

setSplitRule

public void setSplitRule(Integer splitRule)

winnerCriteria

public GetEmailCampaignsCampaignsInner winnerCriteria(String winnerCriteria)

getWinnerCriteria

@Nullable
public String getWinnerCriteria()

Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true`

Returns:

winnerCriteria

setWinnerCriteria

public void setWinnerCriteria(String winnerCriteria)

winnerDelay

public GetEmailCampaignsCampaignsInner winnerDelay(Integer winnerDelay)

getWinnerDelay

@Nullable
public Integer getWinnerDelay()

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`

Returns:

winnerDelay

setWinnerDelay

public void setWinnerDelay(Integer winnerDelay)

sendAtBestTime

public GetEmailCampaignsCampaignsInner sendAtBestTime(Boolean sendAtBestTime)

getSendAtBestTime

@Nullable
public Boolean getSendAtBestTime()

It is true if you have chosen to send your campaign at best time, otherwise it is false

Returns:

sendAtBestTime

setSendAtBestTime

public void setSendAtBestTime(Boolean sendAtBestTime)

testSent

public GetEmailCampaignsCampaignsInner testSent(Boolean testSent)

getTestSent

@Nonnull
public Boolean getTestSent()

Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent)

Returns:

testSent

setTestSent

public void setTestSent(Boolean testSent)

header

public GetEmailCampaignsCampaignsInner header(String header)

getHeader

@Nonnull
public String getHeader()

Header of the campaign

Returns:

header

setHeader

public void setHeader(String header)

footer

public GetEmailCampaignsCampaignsInner footer(String footer)

getFooter

@Nonnull
public String getFooter()

Footer of the campaign

Returns:

footer

setFooter

public void setFooter(String footer)

sender

public GetEmailCampaignsCampaignsInner sender(GetExtendedCampaignOverviewAllOfSender sender)

getSender

@Nonnull
public GetExtendedCampaignOverviewAllOfSender getSender()

Get sender

Returns:

sender

setSender

public void setSender(GetExtendedCampaignOverviewAllOfSender sender)

replyTo

public GetEmailCampaignsCampaignsInner replyTo(String replyTo)

getReplyTo

@Nonnull
public String getReplyTo()

Email defined as the \"Reply to\" of the campaign

Returns:

replyTo

setReplyTo

public void setReplyTo(String replyTo)

toField

public GetEmailCampaignsCampaignsInner toField(String toField)

getToField

@Nullable
public String getToField()

Customisation of the \"to\" field of the campaign

Returns:

toField

setToField

public void setToField(String toField)

htmlContent

public GetEmailCampaignsCampaignsInner htmlContent(String htmlContent)

getHtmlContent

@Nonnull
public String getHtmlContent()

HTML content of the campaign

Returns:

htmlContent

setHtmlContent

public void setHtmlContent(String htmlContent)

shareLink

public GetEmailCampaignsCampaignsInner shareLink(String shareLink)

getShareLink

@Nullable
public String getShareLink()

Link to share the campaign on social medias

Returns:

shareLink

setShareLink

public void setShareLink(String shareLink)

tag

public GetEmailCampaignsCampaignsInner tag(String tag)

getTag

@Nullable
public String getTag()

Tag of the campaign

Returns:

tag

setTag

public void setTag(String tag)

createdAt

public GetEmailCampaignsCampaignsInner createdAt(String createdAt)

getCreatedAt

@Nonnull
public String getCreatedAt()

Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)

Returns:

createdAt

setCreatedAt

public void setCreatedAt(String createdAt)

modifiedAt

public GetEmailCampaignsCampaignsInner modifiedAt(String modifiedAt)

getModifiedAt

@Nonnull
public String getModifiedAt()

UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)

Returns:

modifiedAt

setModifiedAt

public void setModifiedAt(String modifiedAt)

inlineImageActivation

public GetEmailCampaignsCampaignsInner inlineImageActivation(Boolean inlineImageActivation)

getInlineImageActivation

@Nullable
public Boolean getInlineImageActivation()

Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email.

Returns:

inlineImageActivation

setInlineImageActivation

public void setInlineImageActivation(Boolean inlineImageActivation)

mirrorActive

public GetEmailCampaignsCampaignsInner mirrorActive(Boolean mirrorActive)

getMirrorActive

@Nullable
public Boolean getMirrorActive()

Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign

Returns:

mirrorActive

setMirrorActive

public void setMirrorActive(Boolean mirrorActive)

recurring

public GetEmailCampaignsCampaignsInner recurring(Boolean recurring)

getRecurring

@Nullable
public Boolean getRecurring()

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

Returns:

recurring

setRecurring

public void setRecurring(Boolean recurring)

sentDate

public GetEmailCampaignsCampaignsInner sentDate(String sentDate)

getSentDate

@Nullable
public String getSentDate()

Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent'

Returns:

sentDate

setSentDate

public void setSentDate(String sentDate)

returnBounce

public GetEmailCampaignsCampaignsInner returnBounce(Long returnBounce)

getReturnBounce

@Nullable
public Long getReturnBounce()

Total number of non-delivered campaigns for a particular campaign id.

Returns:

returnBounce

setReturnBounce

public void setReturnBounce(Long returnBounce)

recipients

public GetEmailCampaignsCampaignsInner recipients(GetCampaignRecipients recipients)

getRecipients

@Nonnull
public GetCampaignRecipients getRecipients()

Get recipients

Returns:

recipients

setRecipients

public void setRecipients(GetCampaignRecipients recipients)

statistics

public GetEmailCampaignsCampaignsInner statistics(GetExtendedCampaignStats statistics)

getStatistics

@Nonnull
public GetExtendedCampaignStats getStatistics()

Get statistics

Returns:

statistics

setStatistics

public void setStatistics(GetExtendedCampaignStats statistics)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toUrlQueryString

public String toUrlQueryString()

Convert the instance into URL query string.

Returns:

URL query string

toUrlQueryString

public String toUrlQueryString(String prefix)

Convert the instance into URL query string.

Parameters:

prefix - prefix of the query string

Returns:

URL query string