Package io.voucherify.client.model

Class CampaignsUpdateRequestBody

java.lang.Object
io.voucherify.client.model.CampaignsUpdateRequestBody
@Generated("org.openapitools.codegen.languages.JavaClientCodegen") public class CampaignsUpdateRequestBody extends Object
CampaignsUpdateRequestBody

  • Field Details

  • Constructor Details

    • CampaignsUpdateRequestBody

      public CampaignsUpdateRequestBody()

  • Method Details

    • startDate

      public CampaignsUpdateRequestBody startDate(OffsetDateTime startDate)

    • getStartDate

      @Nullable public OffsetDateTime getStartDate()
      Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is *inactive before* this date.
      Returns:
      startDate

    • setStartDate

      public void setStartDate(OffsetDateTime startDate)

    • expirationDate

      public CampaignsUpdateRequestBody expirationDate(OffsetDateTime expirationDate)

    • getExpirationDate

      @Nullable public OffsetDateTime getExpirationDate()
      Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is *inactive after* this date.
      Returns:
      expirationDate

    • setExpirationDate

      public void setExpirationDate(OffsetDateTime expirationDate)

    • validityTimeframe

      public CampaignsUpdateRequestBody validityTimeframe(ValidityTimeframe validityTimeframe)

    • getValidityTimeframe

      @Nullable public ValidityTimeframe getValidityTimeframe()
      Get validityTimeframe
      Returns:
      validityTimeframe

    • setValidityTimeframe

      public void setValidityTimeframe(ValidityTimeframe validityTimeframe)

    • validityDayOfWeek

      public CampaignsUpdateRequestBody validityDayOfWeek(List<CampaignsUpdateRequestBody.ValidityDayOfWeekEnum> validityDayOfWeek)

    • addValidityDayOfWeekItem

      public CampaignsUpdateRequestBody addValidityDayOfWeekItem(CampaignsUpdateRequestBody.ValidityDayOfWeekEnum validityDayOfWeekItem)

    • getValidityDayOfWeek

      @Nullable public List<CampaignsUpdateRequestBody.ValidityDayOfWeekEnum> getValidityDayOfWeek()
      Integer array corresponding to the particular days of the week in which the voucher is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday
      Returns:
      validityDayOfWeek

    • setValidityDayOfWeek

      public void setValidityDayOfWeek(List<CampaignsUpdateRequestBody.ValidityDayOfWeekEnum> validityDayOfWeek)

    • validityHours

      public CampaignsUpdateRequestBody validityHours(ValidityHours validityHours)

    • getValidityHours

      @Nullable public ValidityHours getValidityHours()
      Get validityHours
      Returns:
      validityHours

    • setValidityHours

      public void setValidityHours(ValidityHours validityHours)

    • description

      public CampaignsUpdateRequestBody description(String description)

    • getDescription

      @Nullable public String getDescription()
      An optional field to keep any extra textual information about the campaign such as a campaign description and details.
      Returns:
      description

    • setDescription

      public void setDescription(String description)

    • category

      public CampaignsUpdateRequestBody category(String category)

    • getCategory

      @Nullable public String getCategory()
      The category assigned to the campaign. Either pass this parameter OR the `category_id`.
      Returns:
      category

    • setCategory

      public void setCategory(String category)

    • metadata

      public CampaignsUpdateRequestBody metadata(Object metadata)

    • getMetadata

      @Nullable public Object getMetadata()
      The metadata object stores all custom attributes assigned to the campaign. A set of key/value pairs that you can attach to a campaign object. It can be useful for storing additional information about the campaign in a structured format.
      Returns:
      metadata

    • setMetadata

      public void setMetadata(Object metadata)

    • unsetMetadataFields

      public CampaignsUpdateRequestBody unsetMetadataFields(List<String> unsetMetadataFields)

    • addUnsetMetadataFieldsItem

      public CampaignsUpdateRequestBody addUnsetMetadataFieldsItem(String unsetMetadataFieldsItem)

    • getUnsetMetadataFields

      @Nullable public List<String> getUnsetMetadataFields()
      Determine which metadata should be removed from campaign.
      Returns:
      unsetMetadataFields

    • setUnsetMetadataFields

      public void setUnsetMetadataFields(List<String> unsetMetadataFields)

    • categoryId

      public CampaignsUpdateRequestBody categoryId(String categoryId)

    • getCategoryId

      @Nullable public String getCategoryId()
      Unique category ID that this campaign belongs to. Either pass this parameter OR the `category`.
      Returns:
      categoryId

    • setCategoryId

      public void setCategoryId(String categoryId)

    • activityDurationAfterPublishing

      public CampaignsUpdateRequestBody activityDurationAfterPublishing(String activityDurationAfterPublishing)

    • getActivityDurationAfterPublishing

      @Nullable public String getActivityDurationAfterPublishing()
      Defines the amount of time the vouchers will be active after publishing. The value is shown in the ISO 8601 format. For example, a voucher with the value of P24D will be valid for a duration of 24 days.
      Returns:
      activityDurationAfterPublishing

    • setActivityDurationAfterPublishing

      public void setActivityDurationAfterPublishing(String activityDurationAfterPublishing)

    • joinOnce

      public CampaignsUpdateRequestBody joinOnce(Boolean joinOnce)

    • getJoinOnce

      @Nullable public Boolean getJoinOnce()
      If this value is set to `true`, customers will be able to join the campaign only once. It is always `false` for standalone voucher campaigns and it cannot be changed in them.
      Returns:
      joinOnce

    • setJoinOnce

      public void setJoinOnce(Boolean joinOnce)

    • autoJoin

      public CampaignsUpdateRequestBody autoJoin(Boolean autoJoin)

    • getAutoJoin

      @Nullable public Boolean getAutoJoin()
      Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled.
      Returns:
      autoJoin

    • setAutoJoin

      public void setAutoJoin(Boolean autoJoin)

    • type

      public CampaignsUpdateRequestBody type(CampaignsUpdateRequestBody.TypeEnum type)

    • getType

      @Nullable public CampaignsUpdateRequestBody.TypeEnum getType()
      Defines whether the campaign can be updated with new vouchers after campaign creation. - `AUTO_UPDATE`: By choosing the auto update option you will create a campaign that can be enhanced by new vouchers after the time of creation (e.g. by publish vouchers method). - `STATIC`: vouchers need to be manually published. If the `type` of the campaign is `STANDALONE`, the type cannot be changed. Also, the `type` cannot be changed to `STANDALONE`.
      Returns:
      type

    • setType

      public void setType(CampaignsUpdateRequestBody.TypeEnum type)

    • discount

      public CampaignsUpdateRequestBody discount(Discount discount)

    • getDiscount

      @Nullable public Discount getDiscount()
      Get discount
      Returns:
      discount

    • setDiscount

      public void setDiscount(Discount discount)

    • referralProgram

      public CampaignsUpdateRequestBody referralProgram(ReferralProgram referralProgram)

    • getReferralProgram

      @Nullable public ReferralProgram getReferralProgram()
      Get referralProgram
      Returns:
      referralProgram

    • setReferralProgram

      public void setReferralProgram(ReferralProgram referralProgram)

    • gift

      public CampaignsUpdateRequestBody gift(Gift gift)

    • getGift

      @Nullable public Gift getGift()
      Get gift
      Returns:
      gift

    • setGift

      public void setGift(Gift gift)

    • loyaltyTiersExpiration

      public CampaignsUpdateRequestBody loyaltyTiersExpiration(LoyaltyTiersExpirationAll loyaltyTiersExpiration)

    • getLoyaltyTiersExpiration

      @Nullable public LoyaltyTiersExpirationAll getLoyaltyTiersExpiration()
      Get loyaltyTiersExpiration
      Returns:
      loyaltyTiersExpiration

    • setLoyaltyTiersExpiration

      public void setLoyaltyTiersExpiration(LoyaltyTiersExpirationAll loyaltyTiersExpiration)

    • options

      public CampaignsUpdateRequestBody options(CampaignsUpdateRequestBodyOptions options)

    • getOptions

      @Nullable public CampaignsUpdateRequestBodyOptions getOptions()
      Get options
      Returns:
      options

    • setOptions

      public void setOptions(CampaignsUpdateRequestBodyOptions options)

    • 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

    • fromJson

      public static CampaignsUpdateRequestBody fromJson(String jsonString) throws IOException
      Create an instance of CampaignsUpdateRequestBody given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of CampaignsUpdateRequestBody
      Throws:
      IOException - if the JSON string is invalid with respect to CampaignsUpdateRequestBody

    • toJson

      public String toJson()
      Convert an instance of CampaignsUpdateRequestBody to an JSON string
      Returns:
      JSON string