Package io.voucherify.client.model

Class PromotionsTiersGetResponseBody

java.lang.Object

io.voucherify.client.model.PromotionsTiersGetResponseBody

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

Response body schema for **GET** `v1/promotions/tiers/{promotionTierId}`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PromotionsTiersGetResponseBody.CustomTypeAdapterFactory
static enum	PromotionsTiersGetResponseBody.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_CAMPAIGN
static final String	SERIALIZED_NAME_CAMPAIGN_ID
static final String	SERIALIZED_NAME_CATEGORIES
static final String	SERIALIZED_NAME_CATEGORY_ID
static final String	SERIALIZED_NAME_CREATED_AT
static final String	SERIALIZED_NAME_EXPIRATION_DATE
static final String	SERIALIZED_NAME_HIERARCHY
static final String	SERIALIZED_NAME_ID
static final String	SERIALIZED_NAME_METADATA
static final String	SERIALIZED_NAME_NAME
static final String	SERIALIZED_NAME_OBJECT
static final String	SERIALIZED_NAME_PROMOTION_ID
static final String	SERIALIZED_NAME_START_DATE
static final String	SERIALIZED_NAME_SUMMARY
static final String	SERIALIZED_NAME_UPDATED_AT
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
PromotionsTiersGetResponseBody()

Method Summary

Modifier and Type	Method	Description
PromotionsTiersGetResponseBody	_object(String _object)
PromotionsTiersGetResponseBody	action(PromotionsTiersGetResponseBodyAction action)
PromotionsTiersGetResponseBody	active(Boolean active)
PromotionsTiersGetResponseBody	addCategoriesItem(Category categoriesItem)
PromotionsTiersGetResponseBody	addValidityDayOfWeekItem(PromotionsTiersGetResponseBody.ValidityDayOfWeekEnum validityDayOfWeekItem)
PromotionsTiersGetResponseBody	banner(String banner)
PromotionsTiersGetResponseBody	campaign(PromotionsTiersGetResponseBodyCampaign campaign)
PromotionsTiersGetResponseBody	campaignId(String campaignId)
PromotionsTiersGetResponseBody	categories(List<Category> categories)
PromotionsTiersGetResponseBody	categoryId(String categoryId)
PromotionsTiersGetResponseBody	createdAt(OffsetDateTime createdAt)
boolean	equals(Object o)
PromotionsTiersGetResponseBody	expirationDate(OffsetDateTime expirationDate)
static PromotionsTiersGetResponseBody	fromJson(String jsonString)	Create an instance of PromotionsTiersGetResponseBody given an JSON string
PromotionsTiersGetResponseBodyAction	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.
PromotionsTiersGetResponseBodyCampaign	getCampaign()	Get campaign
String	getCampaignId()	Promotion tier's parent campaign's unique ID.
List<Category>	getCategories()	Get categories
String	getCategoryId()	Promotion tier category ID.
OffsetDateTime	getCreatedAt()	Timestamp representing the date and time when the promotion tier was created.
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.
String	getId()	Unique promotion tier ID.
Object	getMetadata()	The metadata object stores all custom attributes assigned to the promotion tier.
String	getName()	Name of the promotion tier.
String	getObject()	The type of the object represented by JSON.
String	getPromotionId()	Promotion unique ID.
OffsetDateTime	getStartDate()	Activation timestamp defines when the promotion tier starts to be active in ISO 8601 format.
PromotionsTiersGetResponseBodySummary	getSummary()	Get summary
OffsetDateTime	getUpdatedAt()	Timestamp representing the date and time when the promotion tier was updated.
ValidationRuleAssignmentsList	getValidationRuleAssignments()	Get validationRuleAssignments
List<PromotionsTiersGetResponseBody.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()
PromotionsTiersGetResponseBody	hierarchy(Integer hierarchy)
PromotionsTiersGetResponseBody	id(String id)
PromotionsTiersGetResponseBody	metadata(Object metadata)
PromotionsTiersGetResponseBody	name(String name)
PromotionsTiersGetResponseBody	promotionId(String promotionId)
void	setAction(PromotionsTiersGetResponseBodyAction action)
void	setActive(Boolean active)
void	setBanner(String banner)
void	setCampaign(PromotionsTiersGetResponseBodyCampaign campaign)
void	setCampaignId(String campaignId)
void	setCategories(List<Category> categories)
void	setCategoryId(String categoryId)
void	setCreatedAt(OffsetDateTime createdAt)
void	setExpirationDate(OffsetDateTime expirationDate)
void	setHierarchy(Integer hierarchy)
void	setId(String id)
void	setMetadata(Object metadata)
void	setName(String name)
void	setObject(String _object)
void	setPromotionId(String promotionId)
void	setStartDate(OffsetDateTime startDate)
void	setSummary(PromotionsTiersGetResponseBodySummary summary)
void	setUpdatedAt(OffsetDateTime updatedAt)
void	setValidationRuleAssignments(ValidationRuleAssignmentsList validationRuleAssignments)
void	setValidityDayOfWeek(List<PromotionsTiersGetResponseBody.ValidityDayOfWeekEnum> validityDayOfWeek)
void	setValidityHours(ValidityHours validityHours)
void	setValidityTimeframe(ValidityTimeframe validityTimeframe)
PromotionsTiersGetResponseBody	startDate(OffsetDateTime startDate)
PromotionsTiersGetResponseBody	summary(PromotionsTiersGetResponseBodySummary summary)
String	toJson()	Convert an instance of PromotionsTiersGetResponseBody to an JSON string
String	toString()
PromotionsTiersGetResponseBody	updatedAt(OffsetDateTime updatedAt)
PromotionsTiersGetResponseBody	validationRuleAssignments(ValidationRuleAssignmentsList validationRuleAssignments)
PromotionsTiersGetResponseBody	validityDayOfWeek(List<PromotionsTiersGetResponseBody.ValidityDayOfWeekEnum> validityDayOfWeek)
PromotionsTiersGetResponseBody	validityHours(ValidityHours validityHours)
PromotionsTiersGetResponseBody	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_CREATED_AT

public static final String SERIALIZED_NAME_CREATED_AT

See Also:

• Constant Field Values

SERIALIZED_NAME_UPDATED_AT

public static final String SERIALIZED_NAME_UPDATED_AT

See Also:

• Constant Field Values

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_HIERARCHY

public static final String SERIALIZED_NAME_HIERARCHY

See Also:

• Constant Field Values

SERIALIZED_NAME_PROMOTION_ID

public static final String SERIALIZED_NAME_PROMOTION_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_CAMPAIGN

public static final String SERIALIZED_NAME_CAMPAIGN

See Also:

• Constant Field Values

SERIALIZED_NAME_CAMPAIGN_ID

public static final String SERIALIZED_NAME_CAMPAIGN_ID

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_SUMMARY

public static final String SERIALIZED_NAME_SUMMARY

See Also:

• Constant Field Values

SERIALIZED_NAME_OBJECT

public static final String SERIALIZED_NAME_OBJECT

See Also:

• Constant Field Values

SERIALIZED_NAME_VALIDATION_RULE_ASSIGNMENTS

public static final String SERIALIZED_NAME_VALIDATION_RULE_ASSIGNMENTS

See Also:

• Constant Field Values

SERIALIZED_NAME_CATEGORY_ID

public static final String SERIALIZED_NAME_CATEGORY_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_CATEGORIES

public static final String SERIALIZED_NAME_CATEGORIES

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

PromotionsTiersGetResponseBody

public PromotionsTiersGetResponseBody()

Method Details

id

public PromotionsTiersGetResponseBody id(String id)

getId

@Nullable
public String getId()

Unique promotion tier ID.

Returns:

id

setId

public void setId(String id)

createdAt

public PromotionsTiersGetResponseBody createdAt(OffsetDateTime createdAt)

getCreatedAt

@Nullable
public OffsetDateTime getCreatedAt()

Timestamp representing the date and time when the promotion tier was created. The value is shown in the ISO 8601 format.

Returns:

createdAt

setCreatedAt

public void setCreatedAt(OffsetDateTime createdAt)

updatedAt

public PromotionsTiersGetResponseBody updatedAt(OffsetDateTime updatedAt)

getUpdatedAt

@Nullable
public OffsetDateTime getUpdatedAt()

Timestamp representing the date and time when the promotion tier was updated. The value is shown in the ISO 8601 format.

Returns:

updatedAt

setUpdatedAt

public void setUpdatedAt(OffsetDateTime updatedAt)

name

public PromotionsTiersGetResponseBody name(String name)

getName

@Nullable
public String getName()

Name of the promotion tier.

Returns:

name

setName

public void setName(String name)

banner

public PromotionsTiersGetResponseBody 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 PromotionsTiersGetResponseBody action(PromotionsTiersGetResponseBodyAction action)

getAction

@Nullable
public PromotionsTiersGetResponseBodyAction getAction()

Get action

Returns:

action

setAction

public void setAction(PromotionsTiersGetResponseBodyAction action)

metadata

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

promotionId

public PromotionsTiersGetResponseBody promotionId(String promotionId)

getPromotionId

@Nullable
public String getPromotionId()

Promotion unique ID.

Returns:

promotionId

setPromotionId

public void setPromotionId(String promotionId)

campaign

public PromotionsTiersGetResponseBody campaign(PromotionsTiersGetResponseBodyCampaign campaign)

getCampaign

@Nullable
public PromotionsTiersGetResponseBodyCampaign getCampaign()

Get campaign

Returns:

campaign

setCampaign

public void setCampaign(PromotionsTiersGetResponseBodyCampaign campaign)

campaignId

public PromotionsTiersGetResponseBody campaignId(String campaignId)

getCampaignId

@Nullable
public String getCampaignId()

Promotion tier's parent campaign's unique ID.

Returns:

campaignId

setCampaignId

public void setCampaignId(String campaignId)

active

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

getValidityTimeframe

@Nullable
public ValidityTimeframe getValidityTimeframe()

Get validityTimeframe

Returns:

validityTimeframe

setValidityTimeframe

public void setValidityTimeframe(ValidityTimeframe validityTimeframe)

validityDayOfWeek

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

addValidityDayOfWeekItem

public PromotionsTiersGetResponseBody addValidityDayOfWeekItem(PromotionsTiersGetResponseBody.ValidityDayOfWeekEnum validityDayOfWeekItem)

getValidityDayOfWeek

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

validityHours

public PromotionsTiersGetResponseBody validityHours(ValidityHours validityHours)

getValidityHours

@Nullable
public ValidityHours getValidityHours()

Get validityHours

Returns:

validityHours

setValidityHours

public void setValidityHours(ValidityHours validityHours)

summary

public PromotionsTiersGetResponseBody summary(PromotionsTiersGetResponseBodySummary summary)

getSummary

@Nullable
public PromotionsTiersGetResponseBodySummary getSummary()

Get summary

Returns:

summary

setSummary

public void setSummary(PromotionsTiersGetResponseBodySummary summary)

_object

public PromotionsTiersGetResponseBody _object(String _object)

getObject

@Nullable
public String getObject()

The type of the object represented by JSON. This object stores information about the promotion tier.

Returns:

_object

setObject

public void setObject(String _object)

validationRuleAssignments

public PromotionsTiersGetResponseBody validationRuleAssignments(ValidationRuleAssignmentsList validationRuleAssignments)

getValidationRuleAssignments

@Nullable
public ValidationRuleAssignmentsList getValidationRuleAssignments()

Get validationRuleAssignments

Returns:

validationRuleAssignments

setValidationRuleAssignments

public void setValidationRuleAssignments(ValidationRuleAssignmentsList validationRuleAssignments)

categoryId

public PromotionsTiersGetResponseBody categoryId(String categoryId)

getCategoryId

@Nullable
public String getCategoryId()

Promotion tier category ID.

Returns:

categoryId

setCategoryId

public void setCategoryId(String categoryId)

categories

public PromotionsTiersGetResponseBody categories(List<Category> categories)

addCategoriesItem

public PromotionsTiersGetResponseBody addCategoriesItem(Category categoriesItem)

getCategories

@Nullable
public List<Category> getCategories()

Get categories

Returns:

categories

setCategories

public void setCategories(List<Category> categories)

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

Create an instance of PromotionsTiersGetResponseBody given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of PromotionsTiersGetResponseBody

Throws:

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

toJson

public String toJson()

Convert an instance of PromotionsTiersGetResponseBody to an JSON string

Returns:

JSON string