Package io.voucherify.client.model

Class ManagementProjectsStackingRulesCreateRequestBody

java.lang.Object

io.voucherify.client.model.ManagementProjectsStackingRulesCreateRequestBody

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

Request body schema for **POST** `/management/v1/projects/{projectId}/stacking-rules`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ManagementProjectsStackingRulesCreateRequestBody.CustomTypeAdapterFactory
static enum	ManagementProjectsStackingRulesCreateRequestBody.DiscountCalculationModeEnum	Defines if the discounts are applied by taking into account the initial order amount or the discounted order amount.
static enum	ManagementProjectsStackingRulesCreateRequestBody.RedeemablesApplicationModeEnum	Defines the application mode for redeemables.
static enum	ManagementProjectsStackingRulesCreateRequestBody.RedeemablesSortingRuleEnum	Defines the sorting rule for redeemables.

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_APPLICABLE_EXCLUSIVE_REDEEMABLES_LIMIT
static final String	SERIALIZED_NAME_APPLICABLE_EXCLUSIVE_REDEEMABLES_PER_CATEGORY_LIMIT
static final String	SERIALIZED_NAME_APPLICABLE_REDEEMABLES_LIMIT
static final String	SERIALIZED_NAME_APPLICABLE_REDEEMABLES_PER_CATEGORY_LIMIT
static final String	SERIALIZED_NAME_DISCOUNT_CALCULATION_MODE
static final String	SERIALIZED_NAME_DISCOUNTED_AMOUNT_MODE_CATEGORIES
static final String	SERIALIZED_NAME_EXCLUSIVE_CATEGORIES
static final String	SERIALIZED_NAME_INITIAL_AMOUNT_MODE_CATEGORIES
static final String	SERIALIZED_NAME_JOINT_CATEGORIES
static final String	SERIALIZED_NAME_REDEEMABLES_APPLICATION_MODE
static final String	SERIALIZED_NAME_REDEEMABLES_LIMIT
static final String	SERIALIZED_NAME_REDEEMABLES_SORTING_RULE

Constructor Summary

Constructors

Constructor	Description
ManagementProjectsStackingRulesCreateRequestBody()

Method Summary

Modifier and Type	Method	Description
ManagementProjectsStackingRulesCreateRequestBody	addDiscountedAmountModeCategoriesItem(String discountedAmountModeCategoriesItem)
ManagementProjectsStackingRulesCreateRequestBody	addExclusiveCategoriesItem(String exclusiveCategoriesItem)
ManagementProjectsStackingRulesCreateRequestBody	addInitialAmountModeCategoriesItem(String initialAmountModeCategoriesItem)
ManagementProjectsStackingRulesCreateRequestBody	addJointCategoriesItem(String jointCategoriesItem)
ManagementProjectsStackingRulesCreateRequestBody	applicableExclusiveRedeemablesLimit(Integer applicableExclusiveRedeemablesLimit)
ManagementProjectsStackingRulesCreateRequestBody	applicableExclusiveRedeemablesPerCategoryLimit(Integer applicableExclusiveRedeemablesPerCategoryLimit)
ManagementProjectsStackingRulesCreateRequestBody	applicableRedeemablesLimit(Integer applicableRedeemablesLimit)
ManagementProjectsStackingRulesCreateRequestBody	applicableRedeemablesPerCategoryLimit(Integer applicableRedeemablesPerCategoryLimit)
ManagementProjectsStackingRulesCreateRequestBody	discountCalculationMode(ManagementProjectsStackingRulesCreateRequestBody.DiscountCalculationModeEnum discountCalculationMode)
ManagementProjectsStackingRulesCreateRequestBody	discountedAmountModeCategories(List<String> discountedAmountModeCategories)
boolean	equals(Object o)
ManagementProjectsStackingRulesCreateRequestBody	exclusiveCategories(List<String> exclusiveCategories)
static ManagementProjectsStackingRulesCreateRequestBody	fromJson(String jsonString)	Create an instance of ManagementProjectsStackingRulesCreateRequestBody given an JSON string
Integer	getApplicableExclusiveRedeemablesLimit()	Defines how many redeemables with an assigned exclusive category can be applied at the same time.
Integer	getApplicableExclusiveRedeemablesPerCategoryLimit()	Defines how many exclusive redeemables with the same category can be applied at the same time.
Integer	getApplicableRedeemablesLimit()	Defines how many redeemables can be applied at the same time.
Integer	getApplicableRedeemablesPerCategoryLimit()	Defines how many redeemables with the same category can be applied at the same time.
ManagementProjectsStackingRulesCreateRequestBody.DiscountCalculationModeEnum	getDiscountCalculationMode()	Defines if the discounts are applied by taking into account the initial order amount or the discounted order amount.
List<String>	getDiscountedAmountModeCategories()	Lists the IDs of the categories that apply a discount based on the discounted amount.
List<String>	getExclusiveCategories()	Lists the IDs of the categories that are exclusive.
List<String>	getInitialAmountModeCategories()	Lists the IDs of the categories that apply a discount based on the initial amount.
List<String>	getJointCategories()	Lists the IDs of the categories that are joint.
ManagementProjectsStackingRulesCreateRequestBody.RedeemablesApplicationModeEnum	getRedeemablesApplicationMode()	Defines the application mode for redeemables.
Integer	getRedeemablesLimit()	Defines how many redeemables can be sent to Voucherify for validation at the same time.
ManagementProjectsStackingRulesCreateRequestBody.RedeemablesSortingRuleEnum	getRedeemablesSortingRule()	Defines the sorting rule for redeemables.
int	hashCode()
ManagementProjectsStackingRulesCreateRequestBody	initialAmountModeCategories(List<String> initialAmountModeCategories)
ManagementProjectsStackingRulesCreateRequestBody	jointCategories(List<String> jointCategories)
ManagementProjectsStackingRulesCreateRequestBody	redeemablesApplicationMode(ManagementProjectsStackingRulesCreateRequestBody.RedeemablesApplicationModeEnum redeemablesApplicationMode)
ManagementProjectsStackingRulesCreateRequestBody	redeemablesLimit(Integer redeemablesLimit)
ManagementProjectsStackingRulesCreateRequestBody	redeemablesSortingRule(ManagementProjectsStackingRulesCreateRequestBody.RedeemablesSortingRuleEnum redeemablesSortingRule)
void	setApplicableExclusiveRedeemablesLimit(Integer applicableExclusiveRedeemablesLimit)
void	setApplicableExclusiveRedeemablesPerCategoryLimit(Integer applicableExclusiveRedeemablesPerCategoryLimit)
void	setApplicableRedeemablesLimit(Integer applicableRedeemablesLimit)
void	setApplicableRedeemablesPerCategoryLimit(Integer applicableRedeemablesPerCategoryLimit)
void	setDiscountCalculationMode(ManagementProjectsStackingRulesCreateRequestBody.DiscountCalculationModeEnum discountCalculationMode)
void	setDiscountedAmountModeCategories(List<String> discountedAmountModeCategories)
void	setExclusiveCategories(List<String> exclusiveCategories)
void	setInitialAmountModeCategories(List<String> initialAmountModeCategories)
void	setJointCategories(List<String> jointCategories)
void	setRedeemablesApplicationMode(ManagementProjectsStackingRulesCreateRequestBody.RedeemablesApplicationModeEnum redeemablesApplicationMode)
void	setRedeemablesLimit(Integer redeemablesLimit)
void	setRedeemablesSortingRule(ManagementProjectsStackingRulesCreateRequestBody.RedeemablesSortingRuleEnum redeemablesSortingRule)
String	toJson()	Convert an instance of ManagementProjectsStackingRulesCreateRequestBody to an JSON string
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZED_NAME_EXCLUSIVE_CATEGORIES

public static final String SERIALIZED_NAME_EXCLUSIVE_CATEGORIES

See Also:

• Constant Field Values

SERIALIZED_NAME_JOINT_CATEGORIES

public static final String SERIALIZED_NAME_JOINT_CATEGORIES

See Also:

• Constant Field Values

SERIALIZED_NAME_REDEEMABLES_LIMIT

public static final String SERIALIZED_NAME_REDEEMABLES_LIMIT

See Also:

• Constant Field Values

SERIALIZED_NAME_APPLICABLE_REDEEMABLES_LIMIT

public static final String SERIALIZED_NAME_APPLICABLE_REDEEMABLES_LIMIT

See Also:

• Constant Field Values

SERIALIZED_NAME_APPLICABLE_REDEEMABLES_PER_CATEGORY_LIMIT

public static final String SERIALIZED_NAME_APPLICABLE_REDEEMABLES_PER_CATEGORY_LIMIT

See Also:

• Constant Field Values

SERIALIZED_NAME_APPLICABLE_EXCLUSIVE_REDEEMABLES_LIMIT

public static final String SERIALIZED_NAME_APPLICABLE_EXCLUSIVE_REDEEMABLES_LIMIT

See Also:

• Constant Field Values

SERIALIZED_NAME_APPLICABLE_EXCLUSIVE_REDEEMABLES_PER_CATEGORY_LIMIT

public static final String SERIALIZED_NAME_APPLICABLE_EXCLUSIVE_REDEEMABLES_PER_CATEGORY_LIMIT

See Also:

• Constant Field Values

SERIALIZED_NAME_DISCOUNT_CALCULATION_MODE

public static final String SERIALIZED_NAME_DISCOUNT_CALCULATION_MODE

See Also:

• Constant Field Values

SERIALIZED_NAME_INITIAL_AMOUNT_MODE_CATEGORIES

public static final String SERIALIZED_NAME_INITIAL_AMOUNT_MODE_CATEGORIES

See Also:

• Constant Field Values

SERIALIZED_NAME_DISCOUNTED_AMOUNT_MODE_CATEGORIES

public static final String SERIALIZED_NAME_DISCOUNTED_AMOUNT_MODE_CATEGORIES

See Also:

• Constant Field Values

SERIALIZED_NAME_REDEEMABLES_APPLICATION_MODE

public static final String SERIALIZED_NAME_REDEEMABLES_APPLICATION_MODE

See Also:

• Constant Field Values

SERIALIZED_NAME_REDEEMABLES_SORTING_RULE

public static final String SERIALIZED_NAME_REDEEMABLES_SORTING_RULE

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

ManagementProjectsStackingRulesCreateRequestBody

public ManagementProjectsStackingRulesCreateRequestBody()

Method Details

exclusiveCategories

public ManagementProjectsStackingRulesCreateRequestBody exclusiveCategories(List<String> exclusiveCategories)

addExclusiveCategoriesItem

public ManagementProjectsStackingRulesCreateRequestBody addExclusiveCategoriesItem(String exclusiveCategoriesItem)

getExclusiveCategories

@Nullable
public List<String> getExclusiveCategories()

Lists the IDs of the categories that are exclusive.

Returns:

exclusiveCategories

setExclusiveCategories

public void setExclusiveCategories(List<String> exclusiveCategories)

jointCategories

public ManagementProjectsStackingRulesCreateRequestBody jointCategories(List<String> jointCategories)

addJointCategoriesItem

public ManagementProjectsStackingRulesCreateRequestBody addJointCategoriesItem(String jointCategoriesItem)

getJointCategories

@Nullable
public List<String> getJointCategories()

Lists the IDs of the categories that are joint.

Returns:

jointCategories

setJointCategories

public void setJointCategories(List<String> jointCategories)

redeemablesLimit

public ManagementProjectsStackingRulesCreateRequestBody redeemablesLimit(Integer redeemablesLimit)

getRedeemablesLimit

@Nullable
public Integer getRedeemablesLimit()

Defines how many redeemables can be sent to Voucherify for validation at the same time. minimum: 1 maximum: 30

Returns:

redeemablesLimit

setRedeemablesLimit

public void setRedeemablesLimit(Integer redeemablesLimit)

applicableRedeemablesLimit

public ManagementProjectsStackingRulesCreateRequestBody applicableRedeemablesLimit(Integer applicableRedeemablesLimit)

getApplicableRedeemablesLimit

@Nullable
public Integer getApplicableRedeemablesLimit()

Defines how many redeemables can be applied at the same time. The number must be less than or equal to `\"redeemables_limit\"`. minimum: 1

Returns:

applicableRedeemablesLimit

setApplicableRedeemablesLimit

public void setApplicableRedeemablesLimit(Integer applicableRedeemablesLimit)

applicableRedeemablesPerCategoryLimit

public ManagementProjectsStackingRulesCreateRequestBody applicableRedeemablesPerCategoryLimit(Integer applicableRedeemablesPerCategoryLimit)

getApplicableRedeemablesPerCategoryLimit

@Nullable
public Integer getApplicableRedeemablesPerCategoryLimit()

Defines how many redeemables with the same category can be applied at the same time. The number must be less than or equal to `\"applicable_redeemables_limit\"`.

Returns:

applicableRedeemablesPerCategoryLimit

setApplicableRedeemablesPerCategoryLimit

public void setApplicableRedeemablesPerCategoryLimit(Integer applicableRedeemablesPerCategoryLimit)

applicableExclusiveRedeemablesLimit

public ManagementProjectsStackingRulesCreateRequestBody applicableExclusiveRedeemablesLimit(Integer applicableExclusiveRedeemablesLimit)

getApplicableExclusiveRedeemablesLimit

@Nullable
public Integer getApplicableExclusiveRedeemablesLimit()

Defines how many redeemables with an assigned exclusive category can be applied at the same time. minimum: 1 maximum: 5

Returns:

applicableExclusiveRedeemablesLimit

setApplicableExclusiveRedeemablesLimit

public void setApplicableExclusiveRedeemablesLimit(Integer applicableExclusiveRedeemablesLimit)

applicableExclusiveRedeemablesPerCategoryLimit

public ManagementProjectsStackingRulesCreateRequestBody applicableExclusiveRedeemablesPerCategoryLimit(Integer applicableExclusiveRedeemablesPerCategoryLimit)

getApplicableExclusiveRedeemablesPerCategoryLimit

@Nullable
public Integer getApplicableExclusiveRedeemablesPerCategoryLimit()

Defines how many exclusive redeemables with the same category can be applied at the same time. The number must be less than or equal to `\"applicable_exclusive_redeemables_limit\"`.

Returns:

applicableExclusiveRedeemablesPerCategoryLimit

setApplicableExclusiveRedeemablesPerCategoryLimit

public void setApplicableExclusiveRedeemablesPerCategoryLimit(Integer applicableExclusiveRedeemablesPerCategoryLimit)

discountCalculationMode

public ManagementProjectsStackingRulesCreateRequestBody discountCalculationMode(ManagementProjectsStackingRulesCreateRequestBody.DiscountCalculationModeEnum discountCalculationMode)

getDiscountCalculationMode

@Nullable
public ManagementProjectsStackingRulesCreateRequestBody.DiscountCalculationModeEnum getDiscountCalculationMode()

Defines if the discounts are applied by taking into account the initial order amount or the discounted order amount.

Returns:

discountCalculationMode

setDiscountCalculationMode

public void setDiscountCalculationMode(ManagementProjectsStackingRulesCreateRequestBody.DiscountCalculationModeEnum discountCalculationMode)

initialAmountModeCategories

public ManagementProjectsStackingRulesCreateRequestBody initialAmountModeCategories(List<String> initialAmountModeCategories)

addInitialAmountModeCategoriesItem

public ManagementProjectsStackingRulesCreateRequestBody addInitialAmountModeCategoriesItem(String initialAmountModeCategoriesItem)

getInitialAmountModeCategories

@Nullable
public List<String> getInitialAmountModeCategories()

Lists the IDs of the categories that apply a discount based on the initial amount.

Returns:

initialAmountModeCategories

setInitialAmountModeCategories

public void setInitialAmountModeCategories(List<String> initialAmountModeCategories)

discountedAmountModeCategories

public ManagementProjectsStackingRulesCreateRequestBody discountedAmountModeCategories(List<String> discountedAmountModeCategories)

addDiscountedAmountModeCategoriesItem

public ManagementProjectsStackingRulesCreateRequestBody addDiscountedAmountModeCategoriesItem(String discountedAmountModeCategoriesItem)

getDiscountedAmountModeCategories

@Nullable
public List<String> getDiscountedAmountModeCategories()

Lists the IDs of the categories that apply a discount based on the discounted amount.

Returns:

discountedAmountModeCategories

setDiscountedAmountModeCategories

public void setDiscountedAmountModeCategories(List<String> discountedAmountModeCategories)

redeemablesApplicationMode

public ManagementProjectsStackingRulesCreateRequestBody redeemablesApplicationMode(ManagementProjectsStackingRulesCreateRequestBody.RedeemablesApplicationModeEnum redeemablesApplicationMode)

getRedeemablesApplicationMode

@Nullable
public ManagementProjectsStackingRulesCreateRequestBody.RedeemablesApplicationModeEnum getRedeemablesApplicationMode()

Defines the application mode for redeemables. `\"ALL\"` means that all redeemables must be validated for the redemption to be successful. `\"PARTIAL\"` means that only those redeemables that can be validated will be redeemed. The redeemables that fail validaton will be skipped.

Returns:

redeemablesApplicationMode

setRedeemablesApplicationMode

public void setRedeemablesApplicationMode(ManagementProjectsStackingRulesCreateRequestBody.RedeemablesApplicationModeEnum redeemablesApplicationMode)

redeemablesSortingRule

public ManagementProjectsStackingRulesCreateRequestBody redeemablesSortingRule(ManagementProjectsStackingRulesCreateRequestBody.RedeemablesSortingRuleEnum redeemablesSortingRule)

getRedeemablesSortingRule

@Nullable
public ManagementProjectsStackingRulesCreateRequestBody.RedeemablesSortingRuleEnum getRedeemablesSortingRule()

Defines the sorting rule for redeemables. `\"CATEGORY_HIERARCHY\"` means that redeemables are applied with the order established by the hierarchy of the categories. `\"REQUESTED_ORDER\"` means that redeemables are applied with the order established in the request.

Returns:

redeemablesSortingRule

setRedeemablesSortingRule

public void setRedeemablesSortingRule(ManagementProjectsStackingRulesCreateRequestBody.RedeemablesSortingRuleEnum redeemablesSortingRule)

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

Create an instance of ManagementProjectsStackingRulesCreateRequestBody given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of ManagementProjectsStackingRulesCreateRequestBody

Throws:

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

toJson

public String toJson()

Convert an instance of ManagementProjectsStackingRulesCreateRequestBody to an JSON string

Returns:

JSON string