GetExtendedCampaignOverview (sib-api-v3-sdk 5.3.0 API)

java.lang.Object
- sibModel.GetExtendedCampaignOverview

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

GetExtendedCampaignOverview

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`GetExtendedCampaignOverview.StatusEnum` Status of the campaign
`static class`	`GetExtendedCampaignOverview.TypeEnum` Type of campaign

Constructor Summary

Constructors
Constructor and Description

GetExtendedCampaignOverview()

Constructors
Constructor and Description
`GetExtendedCampaignOverview()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetExtendedCampaignOverview`	`abTesting(Boolean abTesting)`
`GetExtendedCampaignOverview`	`createdAt(String createdAt)`
`boolean`	`equals(Object o)`
`GetExtendedCampaignOverview`	`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
`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.
`GetExtendedCampaignOverview.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
`GetExtendedCampaignOverview.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()`
`GetExtendedCampaignOverview`	`header(String header)`
`GetExtendedCampaignOverview`	`htmlContent(String htmlContent)`
`GetExtendedCampaignOverview`	`id(Long id)`
`GetExtendedCampaignOverview`	`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.
`GetExtendedCampaignOverview`	`mirrorActive(Boolean mirrorActive)`
`GetExtendedCampaignOverview`	`modifiedAt(String modifiedAt)`
`GetExtendedCampaignOverview`	`name(String name)`
`GetExtendedCampaignOverview`	`recurring(Boolean recurring)`
`GetExtendedCampaignOverview`	`replyTo(String replyTo)`
`GetExtendedCampaignOverview`	`returnBounce(Long returnBounce)`
`GetExtendedCampaignOverview`	`scheduledAt(String scheduledAt)`
`GetExtendedCampaignOverview`	`sendAtBestTime(Boolean sendAtBestTime)`
`GetExtendedCampaignOverview`	`sender(GetExtendedCampaignOverviewSender sender)`
`GetExtendedCampaignOverview`	`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`	`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`	`setStatus(GetExtendedCampaignOverview.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(GetExtendedCampaignOverview.TypeEnum type)`
`void`	`setWinnerCriteria(String winnerCriteria)`
`void`	`setWinnerDelay(Integer winnerDelay)`
`GetExtendedCampaignOverview`	`shareLink(String shareLink)`
`GetExtendedCampaignOverview`	`splitRule(Integer splitRule)`
`GetExtendedCampaignOverview`	`status(GetExtendedCampaignOverview.StatusEnum status)`
`GetExtendedCampaignOverview`	`subject(String subject)`
`GetExtendedCampaignOverview`	`subjectA(String subjectA)`
`GetExtendedCampaignOverview`	`subjectB(String subjectB)`
`GetExtendedCampaignOverview`	`tag(String tag)`
`GetExtendedCampaignOverview`	`testSent(Boolean testSent)`
`GetExtendedCampaignOverview`	`toField(String toField)`
`String`	`toString()`
`GetExtendedCampaignOverview`	`type(GetExtendedCampaignOverview.TypeEnum type)`
`GetExtendedCampaignOverview`	`winnerCriteria(String winnerCriteria)`
`GetExtendedCampaignOverview`	`winnerDelay(Integer winnerDelay)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail
- GetExtendedCampaignOverview
```
public GetExtendedCampaignOverview()
```

Method Detail

id

public GetExtendedCampaignOverview id(Long id)

getId
```
public Long getId()
```
ID of the campaign

Returns:

id

setId
```
public void setId(Long id)
```

name

public GetExtendedCampaignOverview name(String name)

getName
```
public String getName()
```
Name of the campaign

Returns:

name

setName
```
public void setName(String name)
```

subject

public GetExtendedCampaignOverview 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 GetExtendedCampaignOverview type(GetExtendedCampaignOverview.TypeEnum type)

getType

public GetExtendedCampaignOverview.TypeEnum getType()

Type of campaign

Returns:: type

setType

public void setType(GetExtendedCampaignOverview.TypeEnum type)

status

public GetExtendedCampaignOverview status(GetExtendedCampaignOverview.StatusEnum status)

getStatus

public GetExtendedCampaignOverview.StatusEnum getStatus()

Status of the campaign

Returns:: status

setStatus

public void setStatus(GetExtendedCampaignOverview.StatusEnum status)

scheduledAt

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

getHeader
```
public String getHeader()
```
Header of the campaign

Returns:

header

setHeader
```
public void setHeader(String header)
```

footer

public GetExtendedCampaignOverview footer(String footer)

getFooter
```
public String getFooter()
```
Footer of the campaign

Returns:

footer

setFooter
```
public void setFooter(String footer)
```

sender

public GetExtendedCampaignOverview sender(GetExtendedCampaignOverviewSender sender)

getSender

public GetExtendedCampaignOverviewSender getSender()

Get sender

Returns:: sender

setSender

public void setSender(GetExtendedCampaignOverviewSender sender)

replyTo

public GetExtendedCampaignOverview 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 GetExtendedCampaignOverview 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 GetExtendedCampaignOverview htmlContent(String htmlContent)

getHtmlContent
```
public String getHtmlContent()
```
HTML content of the campaign

Returns:

htmlContent

setHtmlContent

public void setHtmlContent(String htmlContent)

shareLink

public GetExtendedCampaignOverview 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 GetExtendedCampaignOverview tag(String tag)

getTag
```
public String getTag()
```
Tag of the campaign

Returns:

tag

setTag
```
public void setTag(String tag)
```

createdAt

public GetExtendedCampaignOverview 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 GetExtendedCampaignOverview 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 GetExtendedCampaignOverview 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 GetExtendedCampaignOverview 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 GetExtendedCampaignOverview 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 GetExtendedCampaignOverview 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 GetExtendedCampaignOverview 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)

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

Class GetExtendedCampaignOverview

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GetExtendedCampaignOverview

Method Detail

id

getId

setId

name

getName

setName

subject

getSubject

setSubject

type

getType

setType

status

getStatus

setStatus

scheduledAt

getScheduledAt

setScheduledAt

abTesting

isAbTesting

setAbTesting

subjectA

getSubjectA

setSubjectA

subjectB

getSubjectB

setSubjectB

splitRule

getSplitRule

setSplitRule

winnerCriteria

getWinnerCriteria

setWinnerCriteria

winnerDelay

getWinnerDelay

setWinnerDelay

sendAtBestTime

isSendAtBestTime

setSendAtBestTime

testSent

isTestSent

setTestSent

header

getHeader

setHeader

footer

getFooter

setFooter

sender

getSender

setSender

replyTo

getReplyTo

setReplyTo

toField

getToField

setToField

htmlContent

getHtmlContent

setHtmlContent

shareLink

getShareLink

setShareLink

tag

getTag

setTag

createdAt

getCreatedAt

setCreatedAt

modifiedAt

getModifiedAt

setModifiedAt