Package io.voucherify.client.model

Class CampaignBase

java.lang.Object
io.voucherify.client.model.CampaignBase
@Generated("org.openapitools.codegen.languages.JavaClientCodegen") public class CampaignBase extends Object
This is an object representing a campaign.

  • Field Details

  • Constructor Details

    • CampaignBase

      public CampaignBase()

  • Method Details

    • id

      public CampaignBase id(String id)

    • getId

      @Nullable public String getId()
      Unique campaign ID, assigned by Voucherify.
      Returns:
      id

    • setId

      public void setId(String id)

    • name

      public CampaignBase name(String name)

    • getName

      @Nullable public String getName()
      Campaign name.
      Returns:
      name

    • setName

      public void setName(String name)

    • description

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

    • campaignType

      public CampaignBase campaignType(CampaignBase.CampaignTypeEnum campaignType)

    • getCampaignType

      @Nullable public CampaignBase.CampaignTypeEnum getCampaignType()
      Type of campaign.
      Returns:
      campaignType

    • setCampaignType

      public void setCampaignType(CampaignBase.CampaignTypeEnum campaignType)

    • type

      public CampaignBase type(CampaignBase.TypeEnum type)

    • getType

      @Nullable public CampaignBase.TypeEnum getType()
      Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers. - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria - `STATIC`: vouchers need to be manually published - `STANDALONE`: campaign for single vouchers
      Returns:
      type

    • setType

      public void setType(CampaignBase.TypeEnum type)

    • voucher

      public CampaignBase voucher(CampaignVoucher voucher)

    • getVoucher

      @Nullable public CampaignVoucher getVoucher()
      Get voucher
      Returns:
      voucher

    • setVoucher

      public void setVoucher(CampaignVoucher voucher)

    • autoJoin

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

    • joinOnce

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

    • useVoucherMetadataSchema

      public CampaignBase useVoucherMetadataSchema(Boolean useVoucherMetadataSchema)

    • getUseVoucherMetadataSchema

      @Nullable public Boolean getUseVoucherMetadataSchema()
      Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema.
      Returns:
      useVoucherMetadataSchema

    • setUseVoucherMetadataSchema

      public void setUseVoucherMetadataSchema(Boolean useVoucherMetadataSchema)

    • validityTimeframe

      public CampaignBase validityTimeframe(ValidityTimeframe validityTimeframe)

    • getValidityTimeframe

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

    • setValidityTimeframe

      public void setValidityTimeframe(ValidityTimeframe validityTimeframe)

    • validityDayOfWeek

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

    • addValidityDayOfWeekItem

      public CampaignBase addValidityDayOfWeekItem(CampaignBase.ValidityDayOfWeekEnum validityDayOfWeekItem)

    • getValidityDayOfWeek

      @Nullable public List<CampaignBase.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<CampaignBase.ValidityDayOfWeekEnum> validityDayOfWeek)

    • validityHours

      public CampaignBase validityHours(ValidityHours validityHours)

    • getValidityHours

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

    • setValidityHours

      public void setValidityHours(ValidityHours validityHours)

    • activityDurationAfterPublishing

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

    • vouchersCount

      public CampaignBase vouchersCount(Integer vouchersCount)

    • getVouchersCount

      @Nullable public Integer getVouchersCount()
      Total number of unique vouchers in campaign.
      Returns:
      vouchersCount

    • setVouchersCount

      public void setVouchersCount(Integer vouchersCount)

    • startDate

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

    • active

      public CampaignBase active(Boolean active)

    • getActive

      @Nullable public Boolean getActive()
      A flag to toggle the campaign on or off. You can disable a campaign even though it's within the active period defined by the `start_date` and `expiration_date`. - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign
      Returns:
      active

    • setActive

      public void setActive(Boolean active)

    • metadata

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

    • createdAt

      public CampaignBase createdAt(OffsetDateTime createdAt)

    • getCreatedAt

      @Nullable public OffsetDateTime getCreatedAt()
      Timestamp representing the date and time when the campaign was created. The value is shown in the ISO 8601 format.
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(OffsetDateTime createdAt)

    • updatedAt

      public CampaignBase updatedAt(OffsetDateTime updatedAt)

    • getUpdatedAt

      @Nullable public OffsetDateTime getUpdatedAt()
      Timestamp representing the date and time when the campaign was last updated in ISO 8601 format.
      Returns:
      updatedAt

    • setUpdatedAt

      public void setUpdatedAt(OffsetDateTime updatedAt)

    • category

      public CampaignBase category(String category)

    • getCategory

      @Nullable public String getCategory()
      Unique category name.
      Returns:
      category

    • setCategory

      public void setCategory(String category)

    • creationStatus

      public CampaignBase creationStatus(CampaignBase.CreationStatusEnum creationStatus)

    • getCreationStatus

      @Nullable public CampaignBase.CreationStatusEnum getCreationStatus()
      Indicates the status of the campaign creation.
      Returns:
      creationStatus

    • setCreationStatus

      public void setCreationStatus(CampaignBase.CreationStatusEnum creationStatus)

    • vouchersGenerationStatus

      public CampaignBase vouchersGenerationStatus(CampaignBase.VouchersGenerationStatusEnum vouchersGenerationStatus)

    • getVouchersGenerationStatus

      @Nullable public CampaignBase.VouchersGenerationStatusEnum getVouchersGenerationStatus()
      Indicates the status of the campaign's voucher generation.
      Returns:
      vouchersGenerationStatus

    • setVouchersGenerationStatus

      public void setVouchersGenerationStatus(CampaignBase.VouchersGenerationStatusEnum vouchersGenerationStatus)

    • readonly

      public CampaignBase readonly(Boolean readonly)

    • getReadonly

      @Nullable public Boolean getReadonly()
      Indicates whether the campaign can be only read by a restricted user in the Areas and Stores enterprise feature. It is returned only to restricted users; this field is not returned for users with other roles.
      Returns:
      readonly

    • setReadonly

      public void setReadonly(Boolean readonly)

    • _protected

      public CampaignBase _protected(Boolean _protected)

    • getProtected

      @Nullable public Boolean getProtected()
      Indicates whether the resource can be deleted.
      Returns:
      _protected

    • setProtected

      public void setProtected(Boolean _protected)

    • categoryId

      public CampaignBase categoryId(String categoryId)

    • getCategoryId

      @Nullable public String getCategoryId()
      Unique category ID that this campaign belongs to.
      Returns:
      categoryId

    • setCategoryId

      public void setCategoryId(String categoryId)

    • categories

      public CampaignBase categories(List<Category> categories)

    • addCategoriesItem

      public CampaignBase addCategoriesItem(Category categoriesItem)

    • getCategories

      @Nullable public List<Category> getCategories()
      Contains details about the category.
      Returns:
      categories

    • setCategories

      public void setCategories(List<Category> categories)

    • _object

      public CampaignBase _object(String _object)

    • getObject

      @Nullable public String getObject()
      The type of the object represented by JSON. This object stores information about the campaign.
      Returns:
      _object

    • setObject

      public void setObject(String _object)

    • referralProgram

      public CampaignBase referralProgram(ReferralProgram referralProgram)

    • getReferralProgram

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

    • setReferralProgram

      public void setReferralProgram(ReferralProgram referralProgram)

    • loyaltyTiersExpiration

      public CampaignBase loyaltyTiersExpiration(LoyaltyTiersExpirationAll loyaltyTiersExpiration)

    • getLoyaltyTiersExpiration

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

    • setLoyaltyTiersExpiration

      public void setLoyaltyTiersExpiration(LoyaltyTiersExpirationAll loyaltyTiersExpiration)

    • 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 CampaignBase fromJson(String jsonString) throws IOException
      Create an instance of CampaignBase given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of CampaignBase
      Throws:
      IOException - if the JSON string is invalid with respect to CampaignBase

    • toJson

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