Package io.voucherify.client.model

Class VoucherRedemption

java.lang.Object

io.voucherify.client.model.VoucherRedemption

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

Stores a summary of redemptions that have been applied to the voucher.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VoucherRedemption.CustomTypeAdapterFactory

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_OBJECT
static final String	SERIALIZED_NAME_QUANTITY
static final String	SERIALIZED_NAME_REDEEMED_POINTS
static final String	SERIALIZED_NAME_REDEEMED_QUANTITY
static final String	SERIALIZED_NAME_URL

Constructor Summary

Constructors

Constructor	Description
VoucherRedemption()

Method Summary

Modifier and Type	Method	Description
VoucherRedemption	_object(String _object)
boolean	equals(Object o)
static VoucherRedemption	fromJson(String jsonString)	Create an instance of VoucherRedemption given an JSON string
String	getObject()	The type of the object represented is by default `list`.
Integer	getQuantity()	How many times a voucher can be redeemed.
Integer	getRedeemedPoints()	Total loyalty points redeemed.
Integer	getRedeemedQuantity()	How many times a voucher has already been redeemed.
String	getUrl()	The endpoint where this list of redemptions can be accessed using a **GET** method.
int	hashCode()
VoucherRedemption	quantity(Integer quantity)
VoucherRedemption	redeemedPoints(Integer redeemedPoints)
VoucherRedemption	redeemedQuantity(Integer redeemedQuantity)
void	setObject(String _object)
void	setQuantity(Integer quantity)
void	setRedeemedPoints(Integer redeemedPoints)
void	setRedeemedQuantity(Integer redeemedQuantity)
void	setUrl(String url)
String	toJson()	Convert an instance of VoucherRedemption to an JSON string
String	toString()
VoucherRedemption	url(String url)

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZED_NAME_QUANTITY

public static final String SERIALIZED_NAME_QUANTITY

See Also:

• Constant Field Values

SERIALIZED_NAME_REDEEMED_QUANTITY

public static final String SERIALIZED_NAME_REDEEMED_QUANTITY

See Also:

• Constant Field Values

SERIALIZED_NAME_REDEEMED_POINTS

public static final String SERIALIZED_NAME_REDEEMED_POINTS

See Also:

• Constant Field Values

SERIALIZED_NAME_OBJECT

public static final String SERIALIZED_NAME_OBJECT

See Also:

• Constant Field Values

SERIALIZED_NAME_URL

public static final String SERIALIZED_NAME_URL

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

VoucherRedemption

public VoucherRedemption()

Method Details

quantity

public VoucherRedemption quantity(Integer quantity)

getQuantity

@Nullable
public Integer getQuantity()

How many times a voucher can be redeemed. A `null` value means unlimited.

Returns:

quantity

setQuantity

public void setQuantity(Integer quantity)

redeemedQuantity

public VoucherRedemption redeemedQuantity(Integer redeemedQuantity)

getRedeemedQuantity

@Nullable
public Integer getRedeemedQuantity()

How many times a voucher has already been redeemed.

Returns:

redeemedQuantity

setRedeemedQuantity

public void setRedeemedQuantity(Integer redeemedQuantity)

redeemedPoints

public VoucherRedemption redeemedPoints(Integer redeemedPoints)

getRedeemedPoints

@Nullable
public Integer getRedeemedPoints()

Total loyalty points redeemed.

Returns:

redeemedPoints

setRedeemedPoints

public void setRedeemedPoints(Integer redeemedPoints)

_object

public VoucherRedemption _object(String _object)

getObject

@Nullable
public String getObject()

The type of the object represented is by default `list`. To get this list, you need to make a call to the endpoint returned in the url attribute.

Returns:

_object

setObject

public void setObject(String _object)

url

public VoucherRedemption url(String url)

getUrl

@Nullable
public String getUrl()

The endpoint where this list of redemptions can be accessed using a **GET** method. `/v1/vouchers/{voucher_code}/redemptions`

Returns:

url

setUrl

public void setUrl(String url)

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

Create an instance of VoucherRedemption given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of VoucherRedemption

Throws:

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

toJson

public String toJson()

Convert an instance of VoucherRedemption to an JSON string

Returns:

JSON string