Package io.voucherify.client.model

Class PromotionsTiersCreateRequestBody

java.lang.Object

io.voucherify.client.model.PromotionsTiersCreateRequestBody

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

Request body schema for **POST** `v1/v1/promotions/{campaignId}/tiers`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PromotionsTiersCreateRequestBody.CustomTypeAdapterFactory
static enum	PromotionsTiersCreateRequestBody.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_RULE_ASSIGNMENTS
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
PromotionsTiersCreateRequestBody()

Method Summary

Modifier and Type	Method	Description
PromotionsTiersCreateRequestBody	action(PromotionsTiersCreateRequestBodyAction action)
PromotionsTiersCreateRequestBody	active(Boolean active)
PromotionsTiersCreateRequestBody	addValidityDayOfWeekItem(PromotionsTiersCreateRequestBody.ValidityDayOfWeekEnum validityDayOfWeekItem)
PromotionsTiersCreateRequestBody	banner(String banner)
PromotionsTiersCreateRequestBody	category(String category)
PromotionsTiersCreateRequestBody	categoryId(String categoryId)
boolean	equals(Object o)
PromotionsTiersCreateRequestBody	expirationDate(OffsetDateTime expirationDate)
static PromotionsTiersCreateRequestBody	fromJson(String jsonString)	Create an instance of PromotionsTiersCreateRequestBody given an JSON string
PromotionsTiersCreateRequestBodyAction	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 a new or update the promotion tier's category using name.
String	getCategoryId()	Assign a new or update the promotion tier's category using id
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.
ValidationRuleAssignmentsList	getValidationRuleAssignments()	Get validationRuleAssignments
List<PromotionsTiersCreateRequestBody.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()
PromotionsTiersCreateRequestBody	hierarchy(Integer hierarchy)
PromotionsTiersCreateRequestBody	metadata(Object metadata)
PromotionsTiersCreateRequestBody	name(String name)
void	setAction(PromotionsTiersCreateRequestBodyAction 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	setValidationRuleAssignments(ValidationRuleAssignmentsList validationRuleAssignments)
void	setValidityDayOfWeek(List<PromotionsTiersCreateRequestBody.ValidityDayOfWeekEnum> validityDayOfWeek)
void	setValidityHours(ValidityHours validityHours)
void	setValidityTimeframe(ValidityTimeframe validityTimeframe)
PromotionsTiersCreateRequestBody	startDate(OffsetDateTime startDate)
String	toJson()	Convert an instance of PromotionsTiersCreateRequestBody to an JSON string
String	toString()
PromotionsTiersCreateRequestBody	validationRuleAssignments(ValidationRuleAssignmentsList validationRuleAssignments)
PromotionsTiersCreateRequestBody	validityDayOfWeek(List<PromotionsTiersCreateRequestBody.ValidityDayOfWeekEnum> validityDayOfWeek)
PromotionsTiersCreateRequestBody	validityHours(ValidityHours validityHours)
PromotionsTiersCreateRequestBody	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_METADATA

public static final String SERIALIZED_NAME_METADATA

See Also:

• Constant Field Values

SERIALIZED_NAME_HIERARCHY

public static final String SERIALIZED_NAME_HIERARCHY

See Also:

• Constant Field Values

SERIALIZED_NAME_ACTIVE

public static final String SERIALIZED_NAME_ACTIVE

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

SERIALIZED_NAME_ACTION

public static final String SERIALIZED_NAME_ACTION

See Also:

• Constant Field Values

SERIALIZED_NAME_VALIDATION_RULE_ASSIGNMENTS

public static final String SERIALIZED_NAME_VALIDATION_RULE_ASSIGNMENTS

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

PromotionsTiersCreateRequestBody

public PromotionsTiersCreateRequestBody()

Method Details

name

public PromotionsTiersCreateRequestBody name(String name)

getName

@Nullable
public String getName()

Name of the promotion tier.

Returns:

name

setName

public void setName(String name)

banner

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

metadata

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

hierarchy

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

active

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

startDate

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

getValidityTimeframe

@Nullable
public ValidityTimeframe getValidityTimeframe()

Get validityTimeframe

Returns:

validityTimeframe

setValidityTimeframe

public void setValidityTimeframe(ValidityTimeframe validityTimeframe)

validityDayOfWeek

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

addValidityDayOfWeekItem

public PromotionsTiersCreateRequestBody addValidityDayOfWeekItem(PromotionsTiersCreateRequestBody.ValidityDayOfWeekEnum validityDayOfWeekItem)

getValidityDayOfWeek

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

validityHours

public PromotionsTiersCreateRequestBody validityHours(ValidityHours validityHours)

getValidityHours

@Nullable
public ValidityHours getValidityHours()

Get validityHours

Returns:

validityHours

setValidityHours

public void setValidityHours(ValidityHours validityHours)

category

public PromotionsTiersCreateRequestBody category(String category)

getCategory

@Nullable
public String getCategory()

Assign a new or update the promotion tier's category using name.

Returns:

category

setCategory

public void setCategory(String category)

categoryId

public PromotionsTiersCreateRequestBody categoryId(String categoryId)

getCategoryId

@Nullable
public String getCategoryId()

Assign a new or update the promotion tier's category using id

Returns:

categoryId

setCategoryId

public void setCategoryId(String categoryId)

action

public PromotionsTiersCreateRequestBody action(PromotionsTiersCreateRequestBodyAction action)

getAction

@Nullable
public PromotionsTiersCreateRequestBodyAction getAction()

Get action

Returns:

action

setAction

public void setAction(PromotionsTiersCreateRequestBodyAction action)

validationRuleAssignments

public PromotionsTiersCreateRequestBody validationRuleAssignments(ValidationRuleAssignmentsList validationRuleAssignments)

getValidationRuleAssignments

@Nullable
public ValidationRuleAssignmentsList getValidationRuleAssignments()

Get validationRuleAssignments

Returns:

validationRuleAssignments

setValidationRuleAssignments

public void setValidationRuleAssignments(ValidationRuleAssignmentsList validationRuleAssignments)

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

Create an instance of PromotionsTiersCreateRequestBody given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of PromotionsTiersCreateRequestBody

Throws:

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

toJson

public String toJson()

Convert an instance of PromotionsTiersCreateRequestBody to an JSON string

Returns:

JSON string