Package io.voucherify.client.model

Class PromotionTierCreateParams

java.lang.Object

io.voucherify.client.model.PromotionTierCreateParams

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

This is an object representing a promotion tier create params. Promotion tiers are always assigned to a campaign and cannot be used standalone.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PromotionTierCreateParams.CustomTypeAdapterFactory
static enum	PromotionTierCreateParams.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_ACTION
static final String	SERIALIZED_NAME_ACTIVE
static final String	SERIALIZED_NAME_BANNER
static final String	SERIALIZED_NAME_CATEGORY
static final String	SERIALIZED_NAME_CATEGORY_ID
static final String	SERIALIZED_NAME_EXPIRATION_DATE
static final String	SERIALIZED_NAME_HIERARCHY
static final String	SERIALIZED_NAME_METADATA
static final String	SERIALIZED_NAME_NAME
static final String	SERIALIZED_NAME_START_DATE
static final String	SERIALIZED_NAME_VALIDATION_RULES
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
PromotionTierCreateParams()

Method Summary

Modifier and Type	Method	Description
PromotionTierCreateParams	action(PromotionTierCreateParamsAction action)
PromotionTierCreateParams	active(Boolean active)
PromotionTierCreateParams	addValidationRulesItem(String validationRulesItem)
PromotionTierCreateParams	addValidityDayOfWeekItem(PromotionTierCreateParams.ValidityDayOfWeekEnum validityDayOfWeekItem)
PromotionTierCreateParams	banner(String banner)
PromotionTierCreateParams	category(String category)
PromotionTierCreateParams	categoryId(String categoryId)
boolean	equals(Object o)
PromotionTierCreateParams	expirationDate(OffsetDateTime expirationDate)
static PromotionTierCreateParams	fromJson(String jsonString)	Create an instance of PromotionTierCreateParams given an JSON string
PromotionTierCreateParamsAction	getAction()	Get action
Boolean	getActive()	A flag to toggle the promotion tier on or off.
String	getBanner()	Text to be displayed to your customers on your website.
String	getCategory()	Assign category to the promotion tier.
String	getCategoryId()	Instead of using the category name, you can alternatively assign a new category to a promotion tier using a unique category ID, i.e.
OffsetDateTime	getExpirationDate()	Activation timestamp defines when the promotion tier expires in ISO 8601 format.
Integer	getHierarchy()	The promotions hierarchy defines the order in which the discounts from different tiers will be applied to a customer's order.
Object	getMetadata()	The metadata object stores all custom attributes assigned to the promotion tier.
String	getName()	Name of the promotion tier.
OffsetDateTime	getStartDate()	Activation timestamp defines when the promotion tier starts to be active in ISO 8601 format.
List<String>	getValidationRules()	Array containing the ID of the validation rule associated with the promotion tier.
List<PromotionTierCreateParams.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()
PromotionTierCreateParams	hierarchy(Integer hierarchy)
PromotionTierCreateParams	metadata(Object metadata)
PromotionTierCreateParams	name(String name)
void	setAction(PromotionTierCreateParamsAction action)
void	setActive(Boolean active)
void	setBanner(String banner)
void	setCategory(String category)
void	setCategoryId(String categoryId)
void	setExpirationDate(OffsetDateTime expirationDate)
void	setHierarchy(Integer hierarchy)
void	setMetadata(Object metadata)
void	setName(String name)
void	setStartDate(OffsetDateTime startDate)
void	setValidationRules(List<String> validationRules)
void	setValidityDayOfWeek(List<PromotionTierCreateParams.ValidityDayOfWeekEnum> validityDayOfWeek)
void	setValidityHours(ValidityHours validityHours)
void	setValidityTimeframe(ValidityTimeframe validityTimeframe)
PromotionTierCreateParams	startDate(OffsetDateTime startDate)
String	toJson()	Convert an instance of PromotionTierCreateParams to an JSON string
String	toString()
PromotionTierCreateParams	validationRules(List<String> validationRules)
PromotionTierCreateParams	validityDayOfWeek(List<PromotionTierCreateParams.ValidityDayOfWeekEnum> validityDayOfWeek)
PromotionTierCreateParams	validityHours(ValidityHours validityHours)
PromotionTierCreateParams	validityTimeframe(ValidityTimeframe validityTimeframe)

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZED_NAME_NAME

public static final String SERIALIZED_NAME_NAME

See Also:

• Constant Field Values

SERIALIZED_NAME_BANNER

public static final String SERIALIZED_NAME_BANNER

See Also:

• Constant Field Values

SERIALIZED_NAME_ACTION

public static final String SERIALIZED_NAME_ACTION

See Also:

• Constant Field Values

SERIALIZED_NAME_METADATA

public static final String SERIALIZED_NAME_METADATA

See Also:

• Constant Field Values

SERIALIZED_NAME_VALIDATION_RULES

public static final String SERIALIZED_NAME_VALIDATION_RULES

See Also:

• Constant Field Values

SERIALIZED_NAME_ACTIVE

public static final String SERIALIZED_NAME_ACTIVE

See Also:

• Constant Field Values

SERIALIZED_NAME_HIERARCHY

public static final String SERIALIZED_NAME_HIERARCHY

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_CATEGORY

public static final String SERIALIZED_NAME_CATEGORY

See Also:

• Constant Field Values

SERIALIZED_NAME_CATEGORY_ID

public static final String SERIALIZED_NAME_CATEGORY_ID

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

PromotionTierCreateParams

public PromotionTierCreateParams()

Method Details

name

public PromotionTierCreateParams name(String name)

getName

@Nullable
public String getName()

Name of the promotion tier.

Returns:

name

setName

public void setName(String name)

banner

public PromotionTierCreateParams banner(String banner)

getBanner

@Nullable
public String getBanner()

Text to be displayed to your customers on your website.

Returns:

banner

setBanner

public void setBanner(String banner)

action

public PromotionTierCreateParams action(PromotionTierCreateParamsAction action)

getAction

@Nullable
public PromotionTierCreateParamsAction getAction()

Get action

Returns:

action

setAction

public void setAction(PromotionTierCreateParamsAction action)

metadata

public PromotionTierCreateParams metadata(Object metadata)

getMetadata

@Nullable
public Object getMetadata()

The metadata object stores all custom attributes assigned to the promotion tier. A set of key/value pairs that you can attach to a promotion tier object. It can be useful for storing additional information about the promotion tier in a structured format.

Returns:

metadata

setMetadata

public void setMetadata(Object metadata)

validationRules

public PromotionTierCreateParams validationRules(List<String> validationRules)

addValidationRulesItem

public PromotionTierCreateParams addValidationRulesItem(String validationRulesItem)

getValidationRules

@Nullable
public List<String> getValidationRules()

Array containing the ID of the validation rule associated with the promotion tier.

Returns:

validationRules

setValidationRules

public void setValidationRules(List<String> validationRules)

active

public PromotionTierCreateParams active(Boolean active)

getActive

@Nullable
public Boolean getActive()

A flag to toggle the promotion tier on or off. You can disable a promotion tier even though it's within the active period defined by the `start_date` and `expiration_date`. - `true` indicates an *active* promotion tier - `false` indicates an *inactive* promotion tier

Returns:

active

setActive

public void setActive(Boolean active)

hierarchy

public PromotionTierCreateParams hierarchy(Integer hierarchy)

getHierarchy

@Nullable
public Integer getHierarchy()

The promotions hierarchy defines the order in which the discounts from different tiers will be applied to a customer's order. If a customer qualifies for discounts from more than one tier, discounts will be applied in the order defined in the hierarchy.

Returns:

hierarchy

setHierarchy

public void setHierarchy(Integer hierarchy)

startDate

public PromotionTierCreateParams startDate(OffsetDateTime startDate)

getStartDate

@Nullable
public OffsetDateTime getStartDate()

Activation timestamp defines when the promotion tier starts to be active in ISO 8601 format. Promotion tier is *inactive before* this date.

Returns:

startDate

setStartDate

public void setStartDate(OffsetDateTime startDate)

expirationDate

public PromotionTierCreateParams expirationDate(OffsetDateTime expirationDate)

getExpirationDate

@Nullable
public OffsetDateTime getExpirationDate()

Activation timestamp defines when the promotion tier expires in ISO 8601 format. Promotion tier is *inactive after* this date.

Returns:

expirationDate

setExpirationDate

public void setExpirationDate(OffsetDateTime expirationDate)

validityTimeframe

public PromotionTierCreateParams validityTimeframe(ValidityTimeframe validityTimeframe)

getValidityTimeframe

@Nullable
public ValidityTimeframe getValidityTimeframe()

Get validityTimeframe

Returns:

validityTimeframe

setValidityTimeframe

public void setValidityTimeframe(ValidityTimeframe validityTimeframe)

validityDayOfWeek

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

addValidityDayOfWeekItem

public PromotionTierCreateParams addValidityDayOfWeekItem(PromotionTierCreateParams.ValidityDayOfWeekEnum validityDayOfWeekItem)

getValidityDayOfWeek

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

validityHours

public PromotionTierCreateParams validityHours(ValidityHours validityHours)

getValidityHours

@Nullable
public ValidityHours getValidityHours()

Get validityHours

Returns:

validityHours

setValidityHours

public void setValidityHours(ValidityHours validityHours)

category

public PromotionTierCreateParams category(String category)

getCategory

@Nullable
public String getCategory()

Assign category to the promotion tier.

Returns:

category

setCategory

public void setCategory(String category)

categoryId

public PromotionTierCreateParams categoryId(String categoryId)

getCategoryId

@Nullable
public String getCategoryId()

Instead of using the category name, you can alternatively assign a new category to a promotion tier using a unique category ID, i.e. `cat_0c9da30e7116ba6bba`.

Returns:

categoryId

setCategoryId

public void setCategoryId(String categoryId)

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

Create an instance of PromotionTierCreateParams given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of PromotionTierCreateParams

Throws:

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

toJson

public String toJson()

Convert an instance of PromotionTierCreateParams to an JSON string

Returns:

JSON string