Package software.xdev.brevo.model

Class GetEmailCampaign

java.lang.Object
software.xdev.brevo.model.GetEmailCampaign
public class GetEmailCampaign extends Object
GetEmailCampaign

  • Field Details

  • Constructor Details

    • GetEmailCampaign

      public GetEmailCampaign()

  • Method Details

    • id

      public GetEmailCampaign id(Long id)

    • getId

      @Nonnull public Long getId()
      ID of the campaign
      Returns:
      id

    • setId

      public void setId(Long id)

    • name

      public GetEmailCampaign name(String name)

    • getName

      @Nonnull public String getName()
      Name of the campaign
      Returns:
      name

    • setName

      public void setName(String name)

    • subject

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

    • getType

      @Nonnull public GetEmailCampaign.TypeEnum getType()
      Type of campaign
      Returns:
      type

    • setType

      public void setType(GetEmailCampaign.TypeEnum type)

    • status

      public GetEmailCampaign status(GetEmailCampaign.StatusEnum status)

    • getStatus

      @Nonnull public GetEmailCampaign.StatusEnum getStatus()
      Status of the campaign
      Returns:
      status

    • setStatus

      public void setStatus(GetEmailCampaign.StatusEnum status)

    • scheduledAt

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

    • getHeader

      @Nonnull public String getHeader()
      Header of the campaign
      Returns:
      header

    • setHeader

      public void setHeader(String header)

    • footer

      public GetEmailCampaign footer(String footer)

    • getFooter

      @Nonnull public String getFooter()
      Footer of the campaign
      Returns:
      footer

    • setFooter

      public void setFooter(String footer)

    • sender

      public GetEmailCampaign sender(GetExtendedCampaignOverviewAllOfSender sender)

    • getSender

      @Nonnull public GetExtendedCampaignOverviewAllOfSender getSender()
      Get sender
      Returns:
      sender

    • setSender

      public void setSender(GetExtendedCampaignOverviewAllOfSender sender)

    • replyTo

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

    • getHtmlContent

      @Nonnull public String getHtmlContent()
      HTML content of the campaign
      Returns:
      htmlContent

    • setHtmlContent

      public void setHtmlContent(String htmlContent)

    • shareLink

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

    • getTag

      @Nullable public String getTag()
      Tag of the campaign
      Returns:
      tag

    • setTag

      public void setTag(String tag)

    • createdAt

      public GetEmailCampaign 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 GetEmailCampaign 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 GetEmailCampaign 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 GetEmailCampaign 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 GetEmailCampaign 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 GetEmailCampaign 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 GetEmailCampaign 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 GetEmailCampaign recipients(Object recipients)

    • getRecipients

      @Nonnull public Object getRecipients()
      Get recipients
      Returns:
      recipients

    • setRecipients

      public void setRecipients(Object recipients)

    • statistics

      public GetEmailCampaign statistics(Object statistics)

    • getStatistics

      @Nonnull 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

    • 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