Package io.voucherify.client.model

Class VouchersRedemptionGetResponseBody

java.lang.Object

io.voucherify.client.model.VouchersRedemptionGetResponseBody

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

Response body schema for **GET** `v1/vouchers/{code}/redemption`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VouchersRedemptionGetResponseBody.CustomTypeAdapterFactory

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
VouchersRedemptionGetResponseBody()

Method Summary

Modifier and Type	Method	Description
VouchersRedemptionGetResponseBody	_object(String _object)
VouchersRedemptionGetResponseBody	addRedemptionEntriesItem(RedemptionEntry redemptionEntriesItem)
VouchersRedemptionGetResponseBody	dataRef(String dataRef)
boolean	equals(Object o)
static VouchersRedemptionGetResponseBody	fromJson(String jsonString)	Create an instance of VouchersRedemptionGetResponseBody given an JSON string
String	getDataRef()	Identifies the name of the attribute that contains the array of `redemption_entries`.
String	getObject()	The type of the object represented by JSON.
Integer	getQuantity()	The maximum number of times a voucher can be redeemed.
Integer	getRedeemedQuantity()	The number of times the voucher was redeemed successfully.
List<RedemptionEntry>	getRedemptionEntries()	Contains the array of successful and failed redemption objects.
Integer	getTotal()	Total number of redemption objects.
String	getUrl()	URL
int	hashCode()
VouchersRedemptionGetResponseBody	quantity(Integer quantity)
VouchersRedemptionGetResponseBody	redeemedQuantity(Integer redeemedQuantity)
VouchersRedemptionGetResponseBody	redemptionEntries(List<RedemptionEntry> redemptionEntries)
void	setDataRef(String dataRef)
void	setObject(String _object)
void	setQuantity(Integer quantity)
void	setRedeemedQuantity(Integer redeemedQuantity)
void	setRedemptionEntries(List<RedemptionEntry> redemptionEntries)
void	setTotal(Integer total)
void	setUrl(String url)
String	toJson()	Convert an instance of VouchersRedemptionGetResponseBody to an JSON string
String	toString()
VouchersRedemptionGetResponseBody	total(Integer total)
VouchersRedemptionGetResponseBody	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_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

SERIALIZED_NAME_DATA_REF

public static final String SERIALIZED_NAME_DATA_REF

See Also:

• Constant Field Values

SERIALIZED_NAME_TOTAL

public static final String SERIALIZED_NAME_TOTAL

See Also:

• Constant Field Values

SERIALIZED_NAME_REDEMPTION_ENTRIES

public static final String SERIALIZED_NAME_REDEMPTION_ENTRIES

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

VouchersRedemptionGetResponseBody

public VouchersRedemptionGetResponseBody()

Method Details

quantity

public VouchersRedemptionGetResponseBody quantity(Integer quantity)

getQuantity

@Nullable
public Integer getQuantity()

The maximum number of times a voucher can be redeemed.

Returns:

quantity

setQuantity

public void setQuantity(Integer quantity)

redeemedQuantity

public VouchersRedemptionGetResponseBody redeemedQuantity(Integer redeemedQuantity)

getRedeemedQuantity

@Nullable
public Integer getRedeemedQuantity()

The number of times the voucher was redeemed successfully.

Returns:

redeemedQuantity

setRedeemedQuantity

public void setRedeemedQuantity(Integer redeemedQuantity)

_object

public VouchersRedemptionGetResponseBody _object(String _object)

getObject

@Nullable
public String getObject()

The type of the object represented by JSON. This object stores information about redemptions in a dictionary.

Returns:

_object

setObject

public void setObject(String _object)

url

public VouchersRedemptionGetResponseBody url(String url)

getUrl

@Nullable
public String getUrl()

URL

Returns:

url

setUrl

public void setUrl(String url)

dataRef

public VouchersRedemptionGetResponseBody dataRef(String dataRef)

getDataRef

@Nullable
public String getDataRef()

Identifies the name of the attribute that contains the array of `redemption_entries`.

Returns:

dataRef

setDataRef

public void setDataRef(String dataRef)

total

public VouchersRedemptionGetResponseBody total(Integer total)

getTotal

@Nullable
public Integer getTotal()

Total number of redemption objects.

Returns:

total

setTotal

public void setTotal(Integer total)

redemptionEntries

public VouchersRedemptionGetResponseBody redemptionEntries(List<RedemptionEntry> redemptionEntries)

addRedemptionEntriesItem

public VouchersRedemptionGetResponseBody addRedemptionEntriesItem(RedemptionEntry redemptionEntriesItem)

getRedemptionEntries

@Nonnull
public List<RedemptionEntry> getRedemptionEntries()

Contains the array of successful and failed redemption objects.

Returns:

redemptionEntries

setRedemptionEntries

public void setRedemptionEntries(List<RedemptionEntry> redemptionEntries)

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

Create an instance of VouchersRedemptionGetResponseBody given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of VouchersRedemptionGetResponseBody

Throws:

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

toJson

public String toJson()

Convert an instance of VouchersRedemptionGetResponseBody to an JSON string

Returns:

JSON string