Package io.voucherify.client.model

Class Discount

java.lang.Object

io.voucherify.client.model.Discount

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

Discount

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Discount.CustomTypeAdapterFactory
static enum	Discount.EffectEnum	Gets or Sets effect
static enum	Discount.TypeEnum	Gets or Sets type

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_AGGREGATED_AMOUNT_LIMIT
static final String	SERIALIZED_NAME_AMOUNT_LIMIT
static final String	SERIALIZED_NAME_AMOUNT_OFF
static final String	SERIALIZED_NAME_AMOUNT_OFF_FORMULA
static final String	SERIALIZED_NAME_EFFECT
static final String	SERIALIZED_NAME_FIXED_AMOUNT
static final String	SERIALIZED_NAME_FIXED_AMOUNT_FORMULA
static final String	SERIALIZED_NAME_IS_DYNAMIC
static final String	SERIALIZED_NAME_PERCENT_OFF
static final String	SERIALIZED_NAME_PERCENT_OFF_FORMULA
static final String	SERIALIZED_NAME_PRODUCT
static final String	SERIALIZED_NAME_SKU
static final String	SERIALIZED_NAME_TYPE
static final String	SERIALIZED_NAME_UNIT_OFF
static final String	SERIALIZED_NAME_UNIT_OFF_FORMULA
static final String	SERIALIZED_NAME_UNIT_TYPE
static final String	SERIALIZED_NAME_UNITS

Constructor Summary

Constructors

Constructor	Description
Discount()

Method Summary

Modifier and Type	Method	Description
Discount	addUnitsItem(DiscountUnitMultipleOneUnit unitsItem)
Discount	aggregatedAmountLimit(Integer aggregatedAmountLimit)
Discount	amountLimit(BigDecimal amountLimit)
Discount	amountOff(BigDecimal amountOff)
Discount	amountOffFormula(String amountOffFormula)
Discount	effect(Discount.EffectEnum effect)
boolean	equals(Object o)
Discount	fixedAmount(BigDecimal fixedAmount)
Discount	fixedAmountFormula(String fixedAmountFormula)
static Discount	fromJson(String jsonString)	Create an instance of Discount given an JSON string
Integer	getAggregatedAmountLimit()	Maximum discount amount per order.
BigDecimal	getAmountLimit()	Upper limit allowed to be applied as a discount.
BigDecimal	getAmountOff()	Amount taken off the subtotal of a price.
String	getAmountOffFormula()	Get amountOffFormula
Discount.EffectEnum	getEffect()	Get effect
BigDecimal	getFixedAmount()	Sets a fixed value for an order total or the item price.
String	getFixedAmountFormula()	Get fixedAmountFormula
Boolean	getIsDynamic()	Flag indicating whether the discount was calculated using a formula.
BigDecimal	getPercentOff()	The percent discount that the customer will receive.
String	getPercentOffFormula()	Get percentOffFormula
SimpleProductDiscountUnit	getProduct()	Get product
SimpleSkuDiscountUnit	getSku()	Get sku
Discount.TypeEnum	getType()	Get type
Integer	getUnitOff()	Number of units to be granted a full value discount.
String	getUnitOffFormula()	Get unitOffFormula
List<DiscountUnitMultipleOneUnit>	getUnits()	Get units
String	getUnitType()	The product deemed as free, chosen from product inventory (e.g.
int	hashCode()
Discount	isDynamic(Boolean isDynamic)
Discount	percentOff(BigDecimal percentOff)
Discount	percentOffFormula(String percentOffFormula)
Discount	product(SimpleProductDiscountUnit product)
void	setAggregatedAmountLimit(Integer aggregatedAmountLimit)
void	setAmountLimit(BigDecimal amountLimit)
void	setAmountOff(BigDecimal amountOff)
void	setAmountOffFormula(String amountOffFormula)
void	setEffect(Discount.EffectEnum effect)
void	setFixedAmount(BigDecimal fixedAmount)
void	setFixedAmountFormula(String fixedAmountFormula)
void	setIsDynamic(Boolean isDynamic)
void	setPercentOff(BigDecimal percentOff)
void	setPercentOffFormula(String percentOffFormula)
void	setProduct(SimpleProductDiscountUnit product)
void	setSku(SimpleSkuDiscountUnit sku)
void	setType(Discount.TypeEnum type)
void	setUnitOff(Integer unitOff)
void	setUnitOffFormula(String unitOffFormula)
void	setUnits(List<DiscountUnitMultipleOneUnit> units)
void	setUnitType(String unitType)
Discount	sku(SimpleSkuDiscountUnit sku)
String	toJson()	Convert an instance of Discount to an JSON string
String	toString()
Discount	type(Discount.TypeEnum type)
Discount	unitOff(Integer unitOff)
Discount	unitOffFormula(String unitOffFormula)
Discount	units(List<DiscountUnitMultipleOneUnit> units)
Discount	unitType(String unitType)

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZED_NAME_TYPE

public static final String SERIALIZED_NAME_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_AMOUNT_OFF

public static final String SERIALIZED_NAME_AMOUNT_OFF

See Also:

• Constant Field Values

SERIALIZED_NAME_AMOUNT_OFF_FORMULA

public static final String SERIALIZED_NAME_AMOUNT_OFF_FORMULA

See Also:

• Constant Field Values

SERIALIZED_NAME_AGGREGATED_AMOUNT_LIMIT

public static final String SERIALIZED_NAME_AGGREGATED_AMOUNT_LIMIT

See Also:

• Constant Field Values

SERIALIZED_NAME_EFFECT

public static final String SERIALIZED_NAME_EFFECT

See Also:

• Constant Field Values

SERIALIZED_NAME_IS_DYNAMIC

public static final String SERIALIZED_NAME_IS_DYNAMIC

See Also:

• Constant Field Values

SERIALIZED_NAME_UNIT_OFF

public static final String SERIALIZED_NAME_UNIT_OFF

See Also:

• Constant Field Values

SERIALIZED_NAME_UNIT_OFF_FORMULA

public static final String SERIALIZED_NAME_UNIT_OFF_FORMULA

See Also:

• Constant Field Values

SERIALIZED_NAME_UNIT_TYPE

public static final String SERIALIZED_NAME_UNIT_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_PRODUCT

public static final String SERIALIZED_NAME_PRODUCT

See Also:

• Constant Field Values

SERIALIZED_NAME_SKU

public static final String SERIALIZED_NAME_SKU

See Also:

• Constant Field Values

SERIALIZED_NAME_UNITS

public static final String SERIALIZED_NAME_UNITS

See Also:

• Constant Field Values

SERIALIZED_NAME_PERCENT_OFF

public static final String SERIALIZED_NAME_PERCENT_OFF

See Also:

• Constant Field Values

SERIALIZED_NAME_PERCENT_OFF_FORMULA

public static final String SERIALIZED_NAME_PERCENT_OFF_FORMULA

See Also:

• Constant Field Values

SERIALIZED_NAME_AMOUNT_LIMIT

public static final String SERIALIZED_NAME_AMOUNT_LIMIT

See Also:

• Constant Field Values

SERIALIZED_NAME_FIXED_AMOUNT

public static final String SERIALIZED_NAME_FIXED_AMOUNT

See Also:

• Constant Field Values

SERIALIZED_NAME_FIXED_AMOUNT_FORMULA

public static final String SERIALIZED_NAME_FIXED_AMOUNT_FORMULA

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

Discount

public Discount()

Method Details

type

public Discount type(Discount.TypeEnum type)

getType

@Nullable
public Discount.TypeEnum getType()

Get type

Returns:

type

setType

public void setType(Discount.TypeEnum type)

amountOff

public Discount amountOff(BigDecimal amountOff)

getAmountOff

@Nullable
public BigDecimal getAmountOff()

Amount taken off the subtotal of a price. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000.

Returns:

amountOff

setAmountOff

public void setAmountOff(BigDecimal amountOff)

amountOffFormula

public Discount amountOffFormula(String amountOffFormula)

getAmountOffFormula

@Nullable
public String getAmountOffFormula()

Get amountOffFormula

Returns:

amountOffFormula

setAmountOffFormula

public void setAmountOffFormula(String amountOffFormula)

aggregatedAmountLimit

public Discount aggregatedAmountLimit(Integer aggregatedAmountLimit)

getAggregatedAmountLimit

@Nullable
public Integer getAggregatedAmountLimit()

Maximum discount amount per order.

Returns:

aggregatedAmountLimit

setAggregatedAmountLimit

public void setAggregatedAmountLimit(Integer aggregatedAmountLimit)

effect

public Discount effect(Discount.EffectEnum effect)

getEffect

@Nullable
public Discount.EffectEnum getEffect()

Get effect

Returns:

effect

setEffect

public void setEffect(Discount.EffectEnum effect)

isDynamic

public Discount isDynamic(Boolean isDynamic)

getIsDynamic

@Nullable
public Boolean getIsDynamic()

Flag indicating whether the discount was calculated using a formula.

Returns:

isDynamic

setIsDynamic

public void setIsDynamic(Boolean isDynamic)

unitOff

public Discount unitOff(Integer unitOff)

getUnitOff

@Nullable
public Integer getUnitOff()

Number of units to be granted a full value discount.

Returns:

unitOff

setUnitOff

public void setUnitOff(Integer unitOff)

unitOffFormula

public Discount unitOffFormula(String unitOffFormula)

getUnitOffFormula

@Nullable
public String getUnitOffFormula()

Get unitOffFormula

Returns:

unitOffFormula

setUnitOffFormula

public void setUnitOffFormula(String unitOffFormula)

unitType

public Discount unitType(String unitType)

getUnitType

@Nullable
public String getUnitType()

The product deemed as free, chosen from product inventory (e.g. time, items).

Returns:

unitType

setUnitType

public void setUnitType(String unitType)

product

public Discount product(SimpleProductDiscountUnit product)

getProduct

@Nullable
public SimpleProductDiscountUnit getProduct()

Get product

Returns:

product

setProduct

public void setProduct(SimpleProductDiscountUnit product)

sku

public Discount sku(SimpleSkuDiscountUnit sku)

getSku

@Nullable
public SimpleSkuDiscountUnit getSku()

Get sku

Returns:

sku

setSku

public void setSku(SimpleSkuDiscountUnit sku)

units

public Discount units(List<DiscountUnitMultipleOneUnit> units)

addUnitsItem

public Discount addUnitsItem(DiscountUnitMultipleOneUnit unitsItem)

getUnits

@Nullable
public List<DiscountUnitMultipleOneUnit> getUnits()

Get units

Returns:

units

setUnits

public void setUnits(List<DiscountUnitMultipleOneUnit> units)

percentOff

public Discount percentOff(BigDecimal percentOff)

getPercentOff

@Nullable
public BigDecimal getPercentOff()

The percent discount that the customer will receive.

Returns:

percentOff

setPercentOff

public void setPercentOff(BigDecimal percentOff)

percentOffFormula

public Discount percentOffFormula(String percentOffFormula)

getPercentOffFormula

@Nullable
public String getPercentOffFormula()

Get percentOffFormula

Returns:

percentOffFormula

setPercentOffFormula

public void setPercentOffFormula(String percentOffFormula)

amountLimit

public Discount amountLimit(BigDecimal amountLimit)

getAmountLimit

@Nullable
public BigDecimal getAmountLimit()

Upper limit allowed to be applied as a discount. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount is written as 600.

Returns:

amountLimit

setAmountLimit

public void setAmountLimit(BigDecimal amountLimit)

fixedAmount

public Discount fixedAmount(BigDecimal fixedAmount)

getFixedAmount

@Nullable
public BigDecimal getFixedAmount()

Sets a fixed value for an order total or the item price. The value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000. If the fixed amount is calculated by the formula, i.e. the `fixed_amount_formula` parameter is present in the fixed amount definition, this value becomes the **fallback value**. As a result, if the formula cannot be calculated due to missing metadata, for example, this value will be used as the fixed value.

Returns:

fixedAmount

setFixedAmount

public void setFixedAmount(BigDecimal fixedAmount)

fixedAmountFormula

public Discount fixedAmountFormula(String fixedAmountFormula)

getFixedAmountFormula

@Nullable
public String getFixedAmountFormula()

Get fixedAmountFormula

Returns:

fixedAmountFormula

setFixedAmountFormula

public void setFixedAmountFormula(String fixedAmountFormula)

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

Create an instance of Discount given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of Discount

Throws:

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

toJson

public String toJson()

Convert an instance of Discount to an JSON string

Returns:

JSON string