sibModel

Class GetEmailCampaign

java.lang.Object

sibModel.GetEmailCampaign

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2021-03-12T11:46:32.800+05:30")
public class GetEmailCampaign
extends Object

GetEmailCampaign

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetEmailCampaign.StatusEnum Status of the campaign
static class	GetEmailCampaign.TypeEnum Type of campaign

Constructor Summary

Constructors

Constructor and Description
GetEmailCampaign()

Method Summary

Modifier and Type	Method and Description
GetEmailCampaign	abTesting(Boolean abTesting)
GetEmailCampaign	createdAt(String createdAt)
boolean	equals(Object o)
GetEmailCampaign	footer(String footer)
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
String	getModifiedAt() UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
String	getName() Name of the campaign
Object	getRecipients() Get recipients
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)
GetExtendedCampaignOverviewSender	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.
Object	getStatistics() Get statistics
GetEmailCampaign.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
String	getToField() Customisation of the "to" field of the campaign
GetEmailCampaign.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()
GetEmailCampaign	header(String header)
GetEmailCampaign	htmlContent(String htmlContent)
GetEmailCampaign	id(Long id)
GetEmailCampaign	inlineImageActivation(Boolean inlineImageActivation)
Boolean	isAbTesting() Status of A/B Test for the campaign.
Boolean	isInlineImageActivation() Status of inline image.
Boolean	isMirrorActive() Status of mirror links in campaign.
Boolean	isRecurring() 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
Boolean	isSendAtBestTime() It is true if you have chosen to send your campaign at best time, otherwise it is false
Boolean	isTestSent() Retrieved the status of test email sending.
GetEmailCampaign	mirrorActive(Boolean mirrorActive)
GetEmailCampaign	modifiedAt(String modifiedAt)
GetEmailCampaign	name(String name)
GetEmailCampaign	recipients(Object recipients)
GetEmailCampaign	recurring(Boolean recurring)
GetEmailCampaign	replyTo(String replyTo)
GetEmailCampaign	returnBounce(Long returnBounce)
GetEmailCampaign	scheduledAt(String scheduledAt)
GetEmailCampaign	sendAtBestTime(Boolean sendAtBestTime)
GetEmailCampaign	sender(GetExtendedCampaignOverviewSender sender)
GetEmailCampaign	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	setRecipients(Object recipients)
void	setRecurring(Boolean recurring)
void	setReplyTo(String replyTo)
void	setReturnBounce(Long returnBounce)
void	setScheduledAt(String scheduledAt)
void	setSendAtBestTime(Boolean sendAtBestTime)
void	setSender(GetExtendedCampaignOverviewSender sender)
void	setSentDate(String sentDate)
void	setShareLink(String shareLink)
void	setSplitRule(Integer splitRule)
void	setStatistics(Object statistics)
void	setStatus(GetEmailCampaign.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(GetEmailCampaign.TypeEnum type)
void	setWinnerCriteria(String winnerCriteria)
void	setWinnerDelay(Integer winnerDelay)
GetEmailCampaign	shareLink(String shareLink)
GetEmailCampaign	splitRule(Integer splitRule)
GetEmailCampaign	statistics(Object statistics)
GetEmailCampaign	status(GetEmailCampaign.StatusEnum status)
GetEmailCampaign	subject(String subject)
GetEmailCampaign	subjectA(String subjectA)
GetEmailCampaign	subjectB(String subjectB)
GetEmailCampaign	tag(String tag)
GetEmailCampaign	testSent(Boolean testSent)
GetEmailCampaign	toField(String toField)
String	toString()
GetEmailCampaign	type(GetEmailCampaign.TypeEnum type)
GetEmailCampaign	winnerCriteria(String winnerCriteria)
GetEmailCampaign	winnerDelay(Integer winnerDelay)

Methods inherited from class java.lang.Object

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

Constructor Detail

GetEmailCampaign

public GetEmailCampaign()

Method Detail

id

public GetEmailCampaign id(Long id)

getId

public Long getId()

ID of the campaign

Returns:

id

setId

public void setId(Long id)

name

public GetEmailCampaign name(String name)

getName

public String getName()

Name of the campaign

Returns:

name

setName

public void setName(String name)

subject

public GetEmailCampaign subject(String subject)

getSubject

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)

type

public GetEmailCampaign type(GetEmailCampaign.TypeEnum type)

getType

public GetEmailCampaign.TypeEnum getType()

Type of campaign

Returns:

type

setType

public void setType(GetEmailCampaign.TypeEnum type)

status

public GetEmailCampaign status(GetEmailCampaign.StatusEnum status)

getStatus

public GetEmailCampaign.StatusEnum getStatus()

Status of the campaign

Returns:

status

setStatus

public void setStatus(GetEmailCampaign.StatusEnum status)

scheduledAt

public GetEmailCampaign scheduledAt(String scheduledAt)

getScheduledAt

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 GetEmailCampaign abTesting(Boolean abTesting)

isAbTesting

public Boolean isAbTesting()

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 GetEmailCampaign subjectA(String subjectA)

getSubjectA

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 GetEmailCampaign subjectB(String subjectB)

getSubjectB

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 GetEmailCampaign splitRule(Integer splitRule)

getSplitRule

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 GetEmailCampaign winnerCriteria(String winnerCriteria)

getWinnerCriteria

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 GetEmailCampaign winnerDelay(Integer winnerDelay)

getWinnerDelay

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 GetEmailCampaign sendAtBestTime(Boolean sendAtBestTime)

isSendAtBestTime

public Boolean isSendAtBestTime()

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 GetEmailCampaign testSent(Boolean testSent)

isTestSent

public Boolean isTestSent()

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 GetEmailCampaign header(String header)

getHeader

public String getHeader()

Header of the campaign

Returns:

header

setHeader

public void setHeader(String header)

footer

public GetEmailCampaign footer(String footer)

getFooter

public String getFooter()

Footer of the campaign

Returns:

footer

setFooter

public void setFooter(String footer)

sender

public GetEmailCampaign sender(GetExtendedCampaignOverviewSender sender)

getSender

public GetExtendedCampaignOverviewSender getSender()

Get sender

Returns:

sender

setSender

public void setSender(GetExtendedCampaignOverviewSender sender)

replyTo

public GetEmailCampaign replyTo(String replyTo)

getReplyTo

public String getReplyTo()

Email defined as the "Reply to" of the campaign

Returns:

replyTo

setReplyTo

public void setReplyTo(String replyTo)

toField

public GetEmailCampaign toField(String toField)

getToField

public String getToField()

Customisation of the "to" field of the campaign

Returns:

toField

setToField

public void setToField(String toField)

htmlContent

public GetEmailCampaign htmlContent(String htmlContent)

getHtmlContent

public String getHtmlContent()

HTML content of the campaign

Returns:

htmlContent

setHtmlContent

public void setHtmlContent(String htmlContent)

shareLink

public GetEmailCampaign shareLink(String shareLink)

getShareLink

public String getShareLink()

Link to share the campaign on social medias

Returns:

shareLink

setShareLink

public void setShareLink(String shareLink)

tag

public GetEmailCampaign tag(String tag)

getTag

public String getTag()

Tag of the campaign

Returns:

tag

setTag

public void setTag(String tag)

createdAt

public GetEmailCampaign createdAt(String createdAt)

getCreatedAt

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 GetEmailCampaign modifiedAt(String modifiedAt)

getModifiedAt

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 GetEmailCampaign inlineImageActivation(Boolean inlineImageActivation)

isInlineImageActivation

public Boolean isInlineImageActivation()

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 GetEmailCampaign mirrorActive(Boolean mirrorActive)

isMirrorActive

public Boolean isMirrorActive()

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 GetEmailCampaign recurring(Boolean recurring)

isRecurring

public Boolean isRecurring()

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 GetEmailCampaign sentDate(String sentDate)

getSentDate

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 GetEmailCampaign returnBounce(Long returnBounce)

getReturnBounce

public Long getReturnBounce()

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

Returns:

returnBounce

setReturnBounce

public void setReturnBounce(Long returnBounce)

recipients

public GetEmailCampaign recipients(Object recipients)

getRecipients

public Object getRecipients()

Get recipients

Returns:

recipients

setRecipients

public void setRecipients(Object recipients)

statistics

public GetEmailCampaign statistics(Object statistics)

getStatistics

public Object getStatistics()

Get statistics

Returns:

statistics

setStatistics

public void setStatistics(Object 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