Package io.voucherify.client.model

Class CustomersRedeemablesListResponseBody

java.lang.Object

io.voucherify.client.model.CustomersRedeemablesListResponseBody

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

Response body schema for **GET** `v1/customers/{customerId}/redeemables`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CustomersRedeemablesListResponseBody.CustomTypeAdapterFactory

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_DATA
static final String	SERIALIZED_NAME_DATA_REF
static final String	SERIALIZED_NAME_HAS_MORE
static final String	SERIALIZED_NAME_MORE_STARTING_AFTER
static final String	SERIALIZED_NAME_OBJECT
static final String	SERIALIZED_NAME_TOTAL

Constructor Summary

Constructors

Constructor	Description
CustomersRedeemablesListResponseBody()

Method Summary

Modifier and Type	Method	Description
CustomersRedeemablesListResponseBody	_object(String _object)
CustomersRedeemablesListResponseBody	addDataItem(CustomerRedeemable dataItem)
CustomersRedeemablesListResponseBody	data(List<CustomerRedeemable> data)
CustomersRedeemablesListResponseBody	dataRef(String dataRef)
boolean	equals(Object o)
static CustomersRedeemablesListResponseBody	fromJson(String jsonString)	Create an instance of CustomersRedeemablesListResponseBody given an JSON string
List<CustomerRedeemable>	getData()	A dictionary that contains an array of redeemables.
String	getDataRef()	Identifies the name of the JSON property that contains the array of redeemables.
Boolean	getHasMore()	As query results are always limited (by the limit parameter), the `has_more` flag indicates if there are more records for given filter parameters.
String	getMoreStartingAfter()	Returns an ID that can be used to return another page of results.
String	getObject()	The type of the object represented by JSON.
Integer	getTotal()	Total number of results returned.
int	hashCode()
CustomersRedeemablesListResponseBody	hasMore(Boolean hasMore)
CustomersRedeemablesListResponseBody	moreStartingAfter(String moreStartingAfter)
void	setData(List<CustomerRedeemable> data)
void	setDataRef(String dataRef)
void	setHasMore(Boolean hasMore)
void	setMoreStartingAfter(String moreStartingAfter)
void	setObject(String _object)
void	setTotal(Integer total)
String	toJson()	Convert an instance of CustomersRedeemablesListResponseBody to an JSON string
String	toString()
CustomersRedeemablesListResponseBody	total(Integer total)

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_DATA

public static final String SERIALIZED_NAME_DATA

See Also:

• Constant Field Values

SERIALIZED_NAME_TOTAL

public static final String SERIALIZED_NAME_TOTAL

See Also:

• Constant Field Values

SERIALIZED_NAME_HAS_MORE

public static final String SERIALIZED_NAME_HAS_MORE

See Also:

• Constant Field Values

SERIALIZED_NAME_MORE_STARTING_AFTER

public static final String SERIALIZED_NAME_MORE_STARTING_AFTER

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

CustomersRedeemablesListResponseBody

public CustomersRedeemablesListResponseBody()

Method Details

_object

public CustomersRedeemablesListResponseBody _object(String _object)

getObject

@Nullable
public String getObject()

The type of the object represented by JSON. This object stores information about customer redeemables.

Returns:

_object

setObject

public void setObject(String _object)

dataRef

public CustomersRedeemablesListResponseBody dataRef(String dataRef)

getDataRef

@Nullable
public String getDataRef()

Identifies the name of the JSON property that contains the array of redeemables.

Returns:

dataRef

setDataRef

public void setDataRef(String dataRef)

data

public CustomersRedeemablesListResponseBody data(List<CustomerRedeemable> data)

addDataItem

public CustomersRedeemablesListResponseBody addDataItem(CustomerRedeemable dataItem)

getData

@Nullable
public List<CustomerRedeemable> getData()

A dictionary that contains an array of redeemables.

Returns:

data

setData

public void setData(List<CustomerRedeemable> data)

total

public CustomersRedeemablesListResponseBody total(Integer total)

getTotal

@Nullable
public Integer getTotal()

Total number of results returned.

Returns:

total

setTotal

public void setTotal(Integer total)

hasMore

public CustomersRedeemablesListResponseBody hasMore(Boolean hasMore)

getHasMore

@Nullable
public Boolean getHasMore()

As query results are always limited (by the limit parameter), the `has_more` flag indicates if there are more records for given filter parameters. This lets you know if you can run another request with a `starting_after_id` query or a different limit to get more records returned in the results.

Returns:

hasMore

setHasMore

public void setHasMore(Boolean hasMore)

moreStartingAfter

public CustomersRedeemablesListResponseBody moreStartingAfter(String moreStartingAfter)

getMoreStartingAfter

@Nullable
public String getMoreStartingAfter()

Returns an ID that can be used to return another page of results. Use the ID in the `starting_after_id` query parameter to display another page of the results occuring after the field with that ID.

Returns:

moreStartingAfter

setMoreStartingAfter

public void setMoreStartingAfter(String moreStartingAfter)

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

Create an instance of CustomersRedeemablesListResponseBody given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of CustomersRedeemablesListResponseBody

Throws:

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

toJson

public String toJson()

Convert an instance of CustomersRedeemablesListResponseBody to an JSON string

Returns:

JSON string