Package io.voucherify.client.model

Class Gift

java.lang.Object

io.voucherify.client.model.Gift

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

Contains current gift card balance information.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Gift.CustomTypeAdapterFactory
static enum	Gift.EffectEnum	Defines how the credits are applied to the customer's order.

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_AMOUNT
static final String	SERIALIZED_NAME_BALANCE
static final String	SERIALIZED_NAME_EFFECT

Constructor Summary

Constructors

Constructor	Description
Gift()

Method Summary

Modifier and Type	Method	Description
Gift	amount(BigDecimal amount)
Gift	balance(BigDecimal balance)
Gift	effect(Gift.EffectEnum effect)
boolean	equals(Object o)
static Gift	fromJson(String jsonString)	Create an instance of Gift given an JSON string
BigDecimal	getAmount()	Total gift card income over the lifetime of the card.
BigDecimal	getBalance()	Available funds.
Gift.EffectEnum	getEffect()	Defines how the credits are applied to the customer's order.
int	hashCode()
void	setAmount(BigDecimal amount)
void	setBalance(BigDecimal balance)
void	setEffect(Gift.EffectEnum effect)
String	toJson()	Convert an instance of Gift 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_AMOUNT

public static final String SERIALIZED_NAME_AMOUNT

See Also:

• Constant Field Values

SERIALIZED_NAME_BALANCE

public static final String SERIALIZED_NAME_BALANCE

See Also:

• Constant Field Values

SERIALIZED_NAME_EFFECT

public static final String SERIALIZED_NAME_EFFECT

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

Gift

public Gift()

Method Details

amount

public Gift amount(BigDecimal amount)

getAmount

@Nullable
public BigDecimal getAmount()

Total gift card income over the lifetime of the card. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000.

Returns:

amount

setAmount

public void setAmount(BigDecimal amount)

balance

public Gift balance(BigDecimal balance)

getBalance

@Nullable
public BigDecimal getBalance()

Available funds. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000.

Returns:

balance

setBalance

public void setBalance(BigDecimal balance)

effect

public Gift effect(Gift.EffectEnum effect)

getEffect

@Nullable
public Gift.EffectEnum getEffect()

Defines how the credits are applied to the customer's order.

Returns:

effect

setEffect

public void setEffect(Gift.EffectEnum effect)

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

Create an instance of Gift given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of Gift

Throws:

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

toJson

public String toJson()

Convert an instance of Gift to an JSON string

Returns:

JSON string