Package software.xdev.brevo.model

Class GetCampaignOverview

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

  • Field Details

  • Constructor Details

    • GetCampaignOverview

      public GetCampaignOverview()

  • Method Details

    • id

      public GetCampaignOverview id(@Nonnull Long id)

    • getId

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

    • setId

      public void setId(@Nonnull Long id)

    • name

      public GetCampaignOverview name(@Nonnull String name)

    • getName

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

    • setName

      public void setName(@Nonnull String name)

    • subject

      public GetCampaignOverview subject(@Nullable 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(@Nullable String subject)

    • previewText

      public GetCampaignOverview previewText(@Nullable String previewText)

    • getPreviewText

      @Nullable public String getPreviewText()
      Preview text or preheader of the email campaign
      Returns:
      previewText

    • setPreviewText

      public void setPreviewText(@Nullable String previewText)

    • type

      public GetCampaignOverview type(@Nonnull GetCampaignOverview.TypeEnum type)

    • getType

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

    • setType

      public void setType(@Nonnull GetCampaignOverview.TypeEnum type)

    • status

      public GetCampaignOverview status(@Nonnull GetCampaignOverview.StatusEnum status)

    • getStatus

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

    • setStatus

      public void setStatus(@Nonnull GetCampaignOverview.StatusEnum status)

    • scheduledAt

      public GetCampaignOverview scheduledAt(@Nullable 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(@Nullable String scheduledAt)

    • abTesting

      public GetCampaignOverview abTesting(@Nullable 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(@Nullable Boolean abTesting)

    • subjectA

      public GetCampaignOverview subjectA(@Nullable 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(@Nullable String subjectA)

    • subjectB

      public GetCampaignOverview subjectB(@Nullable 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(@Nullable String subjectB)

    • splitRule

      public GetCampaignOverview splitRule(@Nullable 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(@Nullable Integer splitRule)

    • winnerCriteria

      public GetCampaignOverview winnerCriteria(@Nullable 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(@Nullable String winnerCriteria)

    • winnerDelay

      public GetCampaignOverview winnerDelay(@Nullable 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(@Nullable Integer winnerDelay)

    • sendAtBestTime

      public GetCampaignOverview sendAtBestTime(@Nullable 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(@Nullable Boolean sendAtBestTime)

    • 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