Package io.voucherify.client.model
Class PromotionsTiersEnableResponseBodyCampaign
java.lang.Object
io.voucherify.client.model.PromotionsTiersEnableResponseBodyCampaign
@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class PromotionsTiersEnableResponseBodyCampaign
extends Object
Contains details about promotion tier's parent campaign.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic enumGets or Sets validityDayOfWeek -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddValidityDayOfWeekItem(PromotionsTiersEnableResponseBodyCampaign.ValidityDayOfWeekEnum validityDayOfWeekItem) categoryId(String categoryId) booleanexpirationDate(OffsetDateTime expirationDate) Create an instance of PromotionsTiersEnableResponseBodyCampaign given an JSON stringA flag indicating whether the campaign is active or not active.Unique category ID that this campaign belongs to.Expiration timestamp defines when the campaign expires in ISO 8601 format.getId()Unique campaign ID.The type of the object represented by the campaign object.Activation timestamp defines when the campaign starts to be active in ISO 8601 format.Integer array corresponding to the particular days of the week in which the voucher is valid.Get validityHoursGet validityTimeframeinthashCode()voidvoidsetCategoryId(String categoryId) voidsetExpirationDate(OffsetDateTime expirationDate) voidvoidvoidsetStartDate(OffsetDateTime startDate) voidsetValidityDayOfWeek(List<PromotionsTiersEnableResponseBodyCampaign.ValidityDayOfWeekEnum> validityDayOfWeek) voidsetValidityHours(ValidityHours validityHours) voidsetValidityTimeframe(ValidityTimeframe validityTimeframe) startDate(OffsetDateTime startDate) toJson()Convert an instance of PromotionsTiersEnableResponseBodyCampaign to an JSON stringtoString()validityDayOfWeek(List<PromotionsTiersEnableResponseBodyCampaign.ValidityDayOfWeekEnum> validityDayOfWeek) validityHours(ValidityHours validityHours) validityTimeframe(ValidityTimeframe validityTimeframe)
-
Field Details
-
SERIALIZED_NAME_ID
- See Also:
-
SERIALIZED_NAME_START_DATE
- See Also:
-
SERIALIZED_NAME_EXPIRATION_DATE
- See Also:
-
SERIALIZED_NAME_VALIDITY_TIMEFRAME
- See Also:
-
SERIALIZED_NAME_VALIDITY_DAY_OF_WEEK
- See Also:
-
SERIALIZED_NAME_VALIDITY_HOURS
- See Also:
-
SERIALIZED_NAME_ACTIVE
- See Also:
-
SERIALIZED_NAME_CATEGORY_ID
- See Also:
-
SERIALIZED_NAME_OBJECT
- See Also:
-
openapiFields
-
openapiRequiredFields
-
-
Constructor Details
-
PromotionsTiersEnableResponseBodyCampaign
public PromotionsTiersEnableResponseBodyCampaign()
-
-
Method Details
-
id
-
getId
Unique campaign ID.- Returns:
- id
-
setId
-
startDate
-
getStartDate
Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is *inactive before* this date.- Returns:
- startDate
-
setStartDate
-
expirationDate
-
getExpirationDate
Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is *inactive after* this date.- Returns:
- expirationDate
-
setExpirationDate
-
validityTimeframe
public PromotionsTiersEnableResponseBodyCampaign validityTimeframe(ValidityTimeframe validityTimeframe) -
getValidityTimeframe
Get validityTimeframe- Returns:
- validityTimeframe
-
setValidityTimeframe
-
validityDayOfWeek
public PromotionsTiersEnableResponseBodyCampaign validityDayOfWeek(List<PromotionsTiersEnableResponseBodyCampaign.ValidityDayOfWeekEnum> validityDayOfWeek) -
addValidityDayOfWeekItem
public PromotionsTiersEnableResponseBodyCampaign addValidityDayOfWeekItem(PromotionsTiersEnableResponseBodyCampaign.ValidityDayOfWeekEnum validityDayOfWeekItem) -
getValidityDayOfWeek
@Nullable public List<PromotionsTiersEnableResponseBodyCampaign.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<PromotionsTiersEnableResponseBodyCampaign.ValidityDayOfWeekEnum> validityDayOfWeek) -
validityHours
-
getValidityHours
Get validityHours- Returns:
- validityHours
-
setValidityHours
-
active
-
getActive
A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the <!-- [Disable Campaign](OpenAPI.json/paths/~1campaigns~1{campaignId}~1disable) -->[Disable Campaign](ref:disable-campaign) endpoint. - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign- Returns:
- active
-
setActive
-
categoryId
-
getCategoryId
Unique category ID that this campaign belongs to.- Returns:
- categoryId
-
setCategoryId
-
_object
-
getObject
The type of the object represented by the campaign object. This object stores information about the campaign.- Returns:
- _object
-
setObject
-
equals
-
hashCode
public int hashCode() -
toString
-
fromJson
public static PromotionsTiersEnableResponseBodyCampaign fromJson(String jsonString) throws IOException Create an instance of PromotionsTiersEnableResponseBodyCampaign given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of PromotionsTiersEnableResponseBodyCampaign
- Throws:
IOException- if the JSON string is invalid with respect to PromotionsTiersEnableResponseBodyCampaign
-
toJson
Convert an instance of PromotionsTiersEnableResponseBodyCampaign to an JSON string- Returns:
- JSON string
-