Package io.voucherify.client.model

Class QualificationsOption

java.lang.Object

io.voucherify.client.model.QualificationsOption

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

Configure parameters returned in the response.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QualificationsOption.CustomTypeAdapterFactory
static enum	QualificationsOption.ExpandEnum	Gets or Sets expand
static enum	QualificationsOption.SortingRuleEnum	Is used to determine the order in which data is displayed in the result array.

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_EXPAND
static final String	SERIALIZED_NAME_FILTERS
static final String	SERIALIZED_NAME_LIMIT
static final String	SERIALIZED_NAME_SORTING_RULE
static final String	SERIALIZED_NAME_STARTING_AFTER

Constructor Summary

Constructors

Constructor	Description
QualificationsOption()

Method Summary

Modifier and Type	Method	Description
QualificationsOption	addExpandItem(QualificationsOption.ExpandEnum expandItem)
boolean	equals(Object o)
QualificationsOption	expand(List<QualificationsOption.ExpandEnum> expand)
QualificationsOption	filters(QualificationsOptionFilters filters)
static QualificationsOption	fromJson(String jsonString)	Create an instance of QualificationsOption given an JSON string
List<QualificationsOption.ExpandEnum>	getExpand()	The expand array lets you configure the parameters included in the response.
QualificationsOptionFilters	getFilters()	Get filters
Integer	getLimit()	The maximum number of redeemables to be returned in the API request.
QualificationsOption.SortingRuleEnum	getSortingRule()	Is used to determine the order in which data is displayed in the result array.
OffsetDateTime	getStartingAfter()	Cursor used for paging.
int	hashCode()
QualificationsOption	limit(Integer limit)
void	setExpand(List<QualificationsOption.ExpandEnum> expand)
void	setFilters(QualificationsOptionFilters filters)
void	setLimit(Integer limit)
void	setSortingRule(QualificationsOption.SortingRuleEnum sortingRule)
void	setStartingAfter(OffsetDateTime startingAfter)
QualificationsOption	sortingRule(QualificationsOption.SortingRuleEnum sortingRule)
QualificationsOption	startingAfter(OffsetDateTime startingAfter)
String	toJson()	Convert an instance of QualificationsOption to an JSON string
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZED_NAME_LIMIT

public static final String SERIALIZED_NAME_LIMIT

See Also:

• Constant Field Values

SERIALIZED_NAME_STARTING_AFTER

public static final String SERIALIZED_NAME_STARTING_AFTER

See Also:

• Constant Field Values

SERIALIZED_NAME_FILTERS

public static final String SERIALIZED_NAME_FILTERS

See Also:

• Constant Field Values

SERIALIZED_NAME_EXPAND

public static final String SERIALIZED_NAME_EXPAND

See Also:

• Constant Field Values

SERIALIZED_NAME_SORTING_RULE

public static final String SERIALIZED_NAME_SORTING_RULE

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

QualificationsOption

public QualificationsOption()

Method Details

limit

public QualificationsOption limit(Integer limit)

getLimit

@Nullable
public Integer getLimit()

The maximum number of redeemables to be returned in the API request. The actual number of returned redeemables will be determined by the API. The default value is set to 5 maximum: 100

Returns:

limit

setLimit

public void setLimit(Integer limit)

startingAfter

public QualificationsOption startingAfter(OffsetDateTime startingAfter)

getStartingAfter

@Nullable
public OffsetDateTime getStartingAfter()

Cursor used for paging.

Returns:

startingAfter

setStartingAfter

public void setStartingAfter(OffsetDateTime startingAfter)

filters

public QualificationsOption filters(QualificationsOptionFilters filters)

getFilters

@Nullable
public QualificationsOptionFilters getFilters()

Get filters

Returns:

filters

setFilters

public void setFilters(QualificationsOptionFilters filters)

expand

public QualificationsOption expand(List<QualificationsOption.ExpandEnum> expand)

addExpandItem

public QualificationsOption addExpandItem(QualificationsOption.ExpandEnum expandItem)

getExpand

@Nullable
public List<QualificationsOption.ExpandEnum> getExpand()

The expand array lets you configure the parameters included in the response. Depending on the strings included in the array, the response will contain different details. | **Expand Option** | **Response Body** | |:---|:---| | [`\"redeemable\"`] | Returns the redeemables':<br>- metadata<br>- redeemable name,<br>- campaign name,<br>- campaign ID| | [`\"category\"`] | - Returns an expanded `categories` object, showing details about the category. | | [`\"validation_rules\"`] | - Returns an expanded `validation_rules` object, showing details about the validation rules. |

Returns:

expand

setExpand

public void setExpand(List<QualificationsOption.ExpandEnum> expand)

sortingRule

public QualificationsOption sortingRule(QualificationsOption.SortingRuleEnum sortingRule)

getSortingRule

@Nullable
public QualificationsOption.SortingRuleEnum getSortingRule()

Is used to determine the order in which data is displayed in the result array. - `DEFAULT` - Sorting descending by `created_at` - `BEST_DEAL` - Sorting descending by `total_applied_discount_amount` - `LEAST_DEAL` - Sorting ascending by `total_applied_discount_amount`

Returns:

sortingRule

setSortingRule

public void setSortingRule(QualificationsOption.SortingRuleEnum sortingRule)

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

Create an instance of QualificationsOption given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of QualificationsOption

Throws:

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

toJson

public String toJson()

Convert an instance of QualificationsOption to an JSON string

Returns:

JSON string