Package io.voucherify.client.model

Class VoucherBalance

java.lang.Object

io.voucherify.client.model.VoucherBalance

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

Contains information on how the balance was affected by the transaction.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VoucherBalance.CustomTypeAdapterFactory
static enum	VoucherBalance.ObjectEnum	The type of the object represented by the JSON.
static enum	VoucherBalance.OperationTypeEnum	The type of the operation being performed.
static enum	VoucherBalance.TypeEnum	The type of voucher whose balance is being adjusted due to the transaction.

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_BALANCE
static final String	SERIALIZED_NAME_OBJECT
static final String	SERIALIZED_NAME_OPERATION_TYPE
static final String	SERIALIZED_NAME_POINTS
static final String	SERIALIZED_NAME_RELATED_OBJECT
static final String	SERIALIZED_NAME_TOTAL
static final String	SERIALIZED_NAME_TYPE

Constructor Summary

Constructors

Constructor	Description
VoucherBalance()

Method Summary

Modifier and Type	Method	Description
VoucherBalance	_object(VoucherBalance.ObjectEnum _object)
VoucherBalance	balance(Integer balance)
boolean	equals(Object o)
static VoucherBalance	fromJson(String jsonString)	Create an instance of VoucherBalance given an JSON string
Integer	getBalance()	The available points or credits on the card after the transaction as affected by redemption or rollback.
VoucherBalance.ObjectEnum	getObject()	The type of the object represented by the JSON.
VoucherBalance.OperationTypeEnum	getOperationType()	The type of the operation being performed.
Integer	getPoints()	Points added or subtracted in the transaction of a loyalty card.
VoucherBalanceRelatedObject	getRelatedObject()	Get relatedObject
Integer	getTotal()	The number of all points or credits accumulated on the card as affected by add or subtract operations.
VoucherBalance.TypeEnum	getType()	The type of voucher whose balance is being adjusted due to the transaction.
int	hashCode()
VoucherBalance	operationType(VoucherBalance.OperationTypeEnum operationType)
VoucherBalance	points(Integer points)
VoucherBalance	relatedObject(VoucherBalanceRelatedObject relatedObject)
void	setBalance(Integer balance)
void	setObject(VoucherBalance.ObjectEnum _object)
void	setOperationType(VoucherBalance.OperationTypeEnum operationType)
void	setPoints(Integer points)
void	setRelatedObject(VoucherBalanceRelatedObject relatedObject)
void	setTotal(Integer total)
void	setType(VoucherBalance.TypeEnum type)
String	toJson()	Convert an instance of VoucherBalance to an JSON string
String	toString()
VoucherBalance	total(Integer total)
VoucherBalance	type(VoucherBalance.TypeEnum type)

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_TOTAL

public static final String SERIALIZED_NAME_TOTAL

See Also:

• Constant Field Values

SERIALIZED_NAME_OBJECT

public static final String SERIALIZED_NAME_OBJECT

See Also:

• Constant Field Values

SERIALIZED_NAME_POINTS

public static final String SERIALIZED_NAME_POINTS

See Also:

• Constant Field Values

SERIALIZED_NAME_BALANCE

public static final String SERIALIZED_NAME_BALANCE

See Also:

• Constant Field Values

SERIALIZED_NAME_OPERATION_TYPE

public static final String SERIALIZED_NAME_OPERATION_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_RELATED_OBJECT

public static final String SERIALIZED_NAME_RELATED_OBJECT

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

VoucherBalance

public VoucherBalance()

Method Details

type

public VoucherBalance type(VoucherBalance.TypeEnum type)

getType

@Nullable
public VoucherBalance.TypeEnum getType()

The type of voucher whose balance is being adjusted due to the transaction.

Returns:

type

setType

public void setType(VoucherBalance.TypeEnum type)

total

public VoucherBalance total(Integer total)

getTotal

@Nullable
public Integer getTotal()

The number of all points or credits accumulated on the card as affected by add or subtract operations.

Returns:

total

setTotal

public void setTotal(Integer total)

_object

public VoucherBalance _object(VoucherBalance.ObjectEnum _object)

getObject

@Nullable
public VoucherBalance.ObjectEnum getObject()

The type of the object represented by the JSON.

Returns:

_object

setObject

public void setObject(VoucherBalance.ObjectEnum _object)

points

public VoucherBalance points(Integer points)

getPoints

@Nullable
public Integer getPoints()

Points added or subtracted in the transaction of a loyalty card.

Returns:

points

setPoints

public void setPoints(Integer points)

balance

public VoucherBalance balance(Integer balance)

getBalance

@Nullable
public Integer getBalance()

The available points or credits on the card after the transaction as affected by redemption or rollback.

Returns:

balance

setBalance

public void setBalance(Integer balance)

operationType

public VoucherBalance operationType(VoucherBalance.OperationTypeEnum operationType)

getOperationType

@Nullable
public VoucherBalance.OperationTypeEnum getOperationType()

The type of the operation being performed. The operation type is `AUTOMATIC` if it is an automatic redemption.

Returns:

operationType

setOperationType

public void setOperationType(VoucherBalance.OperationTypeEnum operationType)

relatedObject

public VoucherBalance relatedObject(VoucherBalanceRelatedObject relatedObject)

getRelatedObject

@Nullable
public VoucherBalanceRelatedObject getRelatedObject()

Get relatedObject

Returns:

relatedObject

setRelatedObject

public void setRelatedObject(VoucherBalanceRelatedObject relatedObject)

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

Create an instance of VoucherBalance given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of VoucherBalance

Throws:

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

toJson

public String toJson()

Convert an instance of VoucherBalance to an JSON string

Returns:

JSON string