Package io.voucherify.client.model

Class VouchersListResponseBody

java.lang.Object

io.voucherify.client.model.VouchersListResponseBody

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

Response body schema for **GET** `v1/vouchers`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VouchersListResponseBody.CustomTypeAdapterFactory
static enum	VouchersListResponseBody.DataRefEnum	Identifies the name of the attribute that contains the array of voucher objects.
static enum	VouchersListResponseBody.ObjectEnum	The type of the object represented by JSON.

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_TOTAL
static final String	SERIALIZED_NAME_VOUCHERS

Constructor Summary

Constructors

Constructor	Description
VouchersListResponseBody()

Method Summary

Modifier and Type	Method	Description
VouchersListResponseBody	_object(VouchersListResponseBody.ObjectEnum _object)
VouchersListResponseBody	addVouchersItem(VoucherWithCategories vouchersItem)
VouchersListResponseBody	dataRef(VouchersListResponseBody.DataRefEnum dataRef)
boolean	equals(Object o)
static VouchersListResponseBody	fromJson(String jsonString)	Create an instance of VouchersListResponseBody given an JSON string
VouchersListResponseBody.DataRefEnum	getDataRef()	Identifies the name of the attribute that contains the array of voucher objects.
VouchersListResponseBody.ObjectEnum	getObject()	The type of the object represented by JSON.
Integer	getTotal()	Returns how many vouchers in the project meet the limits defined by the query parameter definitions.
List<VoucherWithCategories>	getVouchers()	A dictionary that contains an array of vouchers.
int	hashCode()
void	setDataRef(VouchersListResponseBody.DataRefEnum dataRef)
void	setObject(VouchersListResponseBody.ObjectEnum _object)
void	setTotal(Integer total)
void	setVouchers(List<VoucherWithCategories> vouchers)
String	toJson()	Convert an instance of VouchersListResponseBody to an JSON string
String	toString()
VouchersListResponseBody	total(Integer total)
VouchersListResponseBody	vouchers(List<VoucherWithCategories> vouchers)

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZED_NAME_OBJECT

public static final String SERIALIZED_NAME_OBJECT

See Also:

• Constant Field Values

SERIALIZED_NAME_DATA_REF

public static final String SERIALIZED_NAME_DATA_REF

See Also:

• Constant Field Values

SERIALIZED_NAME_VOUCHERS

public static final String SERIALIZED_NAME_VOUCHERS

See Also:

• Constant Field Values

SERIALIZED_NAME_TOTAL

public static final String SERIALIZED_NAME_TOTAL

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

VouchersListResponseBody

public VouchersListResponseBody()

Method Details

_object

public VouchersListResponseBody _object(VouchersListResponseBody.ObjectEnum _object)

getObject

@Nullable
public VouchersListResponseBody.ObjectEnum getObject()

The type of the object represented by JSON.

Returns:

_object

setObject

public void setObject(VouchersListResponseBody.ObjectEnum _object)

dataRef

public VouchersListResponseBody dataRef(VouchersListResponseBody.DataRefEnum dataRef)

getDataRef

@Nullable
public VouchersListResponseBody.DataRefEnum getDataRef()

Identifies the name of the attribute that contains the array of voucher objects.

Returns:

dataRef

setDataRef

public void setDataRef(VouchersListResponseBody.DataRefEnum dataRef)

vouchers

public VouchersListResponseBody vouchers(List<VoucherWithCategories> vouchers)

addVouchersItem

public VouchersListResponseBody addVouchersItem(VoucherWithCategories vouchersItem)

getVouchers

@Nullable
public List<VoucherWithCategories> getVouchers()

A dictionary that contains an array of vouchers. Each entry in the array is a separate voucher object.

Returns:

vouchers

setVouchers

public void setVouchers(List<VoucherWithCategories> vouchers)

total

public VouchersListResponseBody total(Integer total)

getTotal

@Nullable
public Integer getTotal()

Returns how many vouchers in the project meet the limits defined by the query parameter definitions.

Returns:

total

setTotal

public void setTotal(Integer total)

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

Create an instance of VouchersListResponseBody given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of VouchersListResponseBody

Throws:

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

toJson

public String toJson()

Convert an instance of VouchersListResponseBody to an JSON string

Returns:

JSON string