Package io.voucherify.client.model

Class PromotionTierCampaign

java.lang.Object

io.voucherify.client.model.PromotionTierCampaign

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class PromotionTierCampaign
extends Object

Contains details about promotion tier's parent campaign.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PromotionTierCampaign.CustomTypeAdapterFactory
static enum	PromotionTierCampaign.ValidityDayOfWeekEnum	Gets or Sets validityDayOfWeek

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_ACTIVE
static final String	SERIALIZED_NAME_CATEGORY_ID
static final String	SERIALIZED_NAME_EXPIRATION_DATE
static final String	SERIALIZED_NAME_ID
static final String	SERIALIZED_NAME_OBJECT
static final String	SERIALIZED_NAME_START_DATE
static final String	SERIALIZED_NAME_VALIDITY_DAY_OF_WEEK
static final String	SERIALIZED_NAME_VALIDITY_HOURS
static final String	SERIALIZED_NAME_VALIDITY_TIMEFRAME

Constructor Summary

Constructors

Constructor	Description
PromotionTierCampaign()

Method Summary

Modifier and Type	Method	Description
PromotionTierCampaign	_object(String _object)
PromotionTierCampaign	active(Boolean active)
PromotionTierCampaign	addValidityDayOfWeekItem(PromotionTierCampaign.ValidityDayOfWeekEnum validityDayOfWeekItem)
PromotionTierCampaign	categoryId(String categoryId)
boolean	equals(Object o)
PromotionTierCampaign	expirationDate(OffsetDateTime expirationDate)
static PromotionTierCampaign	fromJson(String jsonString)	Create an instance of PromotionTierCampaign given an JSON string
Boolean	getActive()	A flag indicating whether the campaign is active or not active.
String	getCategoryId()	Unique category ID that this campaign belongs to.
OffsetDateTime	getExpirationDate()	Expiration timestamp defines when the campaign expires in ISO 8601 format.
String	getId()	Unique campaign ID.
String	getObject()	The type of the object represented by the campaign object.
OffsetDateTime	getStartDate()	Activation timestamp defines when the campaign starts to be active in ISO 8601 format.
List<PromotionTierCampaign.ValidityDayOfWeekEnum>	getValidityDayOfWeek()	Integer array corresponding to the particular days of the week in which the voucher is valid.
ValidityHours	getValidityHours()	Get validityHours
ValidityTimeframe	getValidityTimeframe()	Get validityTimeframe
int	hashCode()
PromotionTierCampaign	id(String id)
void	setActive(Boolean active)
void	setCategoryId(String categoryId)
void	setExpirationDate(OffsetDateTime expirationDate)
void	setId(String id)
void	setObject(String _object)
void	setStartDate(OffsetDateTime startDate)
void	setValidityDayOfWeek(List<PromotionTierCampaign.ValidityDayOfWeekEnum> validityDayOfWeek)
void	setValidityHours(ValidityHours validityHours)
void	setValidityTimeframe(ValidityTimeframe validityTimeframe)
PromotionTierCampaign	startDate(OffsetDateTime startDate)
String	toJson()	Convert an instance of PromotionTierCampaign to an JSON string
String	toString()
PromotionTierCampaign	validityDayOfWeek(List<PromotionTierCampaign.ValidityDayOfWeekEnum> validityDayOfWeek)
PromotionTierCampaign	validityHours(ValidityHours validityHours)
PromotionTierCampaign	validityTimeframe(ValidityTimeframe validityTimeframe)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

SERIALIZED_NAME_ID

public static final String SERIALIZED_NAME_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_START_DATE

public static final String SERIALIZED_NAME_START_DATE

See Also:

• Constant Field Values

SERIALIZED_NAME_EXPIRATION_DATE

public static final String SERIALIZED_NAME_EXPIRATION_DATE

See Also:

• Constant Field Values

SERIALIZED_NAME_VALIDITY_TIMEFRAME

public static final String SERIALIZED_NAME_VALIDITY_TIMEFRAME

See Also:

• Constant Field Values

SERIALIZED_NAME_VALIDITY_DAY_OF_WEEK

public static final String SERIALIZED_NAME_VALIDITY_DAY_OF_WEEK

See Also:

• Constant Field Values

SERIALIZED_NAME_VALIDITY_HOURS

public static final String SERIALIZED_NAME_VALIDITY_HOURS

See Also:

• Constant Field Values

SERIALIZED_NAME_ACTIVE

public static final String SERIALIZED_NAME_ACTIVE

See Also:

• Constant Field Values

SERIALIZED_NAME_CATEGORY_ID

public static final String SERIALIZED_NAME_CATEGORY_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_OBJECT

public static final String SERIALIZED_NAME_OBJECT

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

PromotionTierCampaign

public PromotionTierCampaign()

Method Details

id

public PromotionTierCampaign id(String id)

getId

@Nullable
public String getId()

Unique campaign ID.

Returns:

id

setId

public void setId(String id)

startDate

public PromotionTierCampaign 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 PromotionTierCampaign 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 PromotionTierCampaign validityTimeframe(ValidityTimeframe validityTimeframe)

getValidityTimeframe

@Nullable
public ValidityTimeframe getValidityTimeframe()

Get validityTimeframe

Returns:

validityTimeframe

setValidityTimeframe

public void setValidityTimeframe(ValidityTimeframe validityTimeframe)

validityDayOfWeek

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

addValidityDayOfWeekItem

public PromotionTierCampaign addValidityDayOfWeekItem(PromotionTierCampaign.ValidityDayOfWeekEnum validityDayOfWeekItem)

getValidityDayOfWeek

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

validityHours

public PromotionTierCampaign validityHours(ValidityHours validityHours)

getValidityHours

@Nullable
public ValidityHours getValidityHours()

Get validityHours

Returns:

validityHours

setValidityHours

public void setValidityHours(ValidityHours validityHours)

active

public PromotionTierCampaign active(Boolean active)

getActive

@Nullable
public Boolean 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

public void setActive(Boolean active)

categoryId

public PromotionTierCampaign categoryId(String categoryId)

getCategoryId

@Nullable
public String getCategoryId()

Unique category ID that this campaign belongs to.

Returns:

categoryId

setCategoryId

public void setCategoryId(String categoryId)

_object

public PromotionTierCampaign _object(String _object)

getObject

@Nullable
public String getObject()

The type of the object represented by the campaign object. This object stores information about the campaign.

Returns:

_object

setObject

public void setObject(String _object)

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 PromotionTierCampaign fromJson(String jsonString)
                                      throws IOException

Create an instance of PromotionTierCampaign given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of PromotionTierCampaign

Throws:

IOException - if the JSON string is invalid with respect to PromotionTierCampaign

toJson

public String toJson()

Convert an instance of PromotionTierCampaign to an JSON string

Returns:

JSON string