Package io.voucherify.client.model

Class ClientQualificationsCheckEligibilityRequestBody

java.lang.Object

io.voucherify.client.model.ClientQualificationsCheckEligibilityRequestBody

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

Request body schema for **POST** `v1/qualifications`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClientQualificationsCheckEligibilityRequestBody.CustomTypeAdapterFactory
static enum	ClientQualificationsCheckEligibilityRequestBody.ScenarioEnum	Defines the scenario Voucherify should consider during the qualification process.

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_CUSTOMER
static final String	SERIALIZED_NAME_METADATA
static final String	SERIALIZED_NAME_OPTIONS
static final String	SERIALIZED_NAME_ORDER
static final String	SERIALIZED_NAME_SCENARIO
static final String	SERIALIZED_NAME_TRACKING_ID

Constructor Summary

Constructors

Constructor	Description
ClientQualificationsCheckEligibilityRequestBody()

Method Summary

Modifier and Type	Method	Description
ClientQualificationsCheckEligibilityRequestBody	customer(Customer customer)
boolean	equals(Object o)
static ClientQualificationsCheckEligibilityRequestBody	fromJson(String jsonString)	Create an instance of ClientQualificationsCheckEligibilityRequestBody given an JSON string
Customer	getCustomer()	Get customer
Object	getMetadata()	A set of key/value pairs that you can send in the request body to check against redeemables requiring **redemption** metadata validation rules to be satisfied.
QualificationsOption	getOptions()	Get options
Order	getOrder()	Get order
ClientQualificationsCheckEligibilityRequestBody.ScenarioEnum	getScenario()	Defines the scenario Voucherify should consider during the qualification process.
String	getTrackingId()	Is correspondent to Customer's source_id
int	hashCode()
ClientQualificationsCheckEligibilityRequestBody	metadata(Object metadata)
ClientQualificationsCheckEligibilityRequestBody	options(QualificationsOption options)
ClientQualificationsCheckEligibilityRequestBody	order(Order order)
ClientQualificationsCheckEligibilityRequestBody	scenario(ClientQualificationsCheckEligibilityRequestBody.ScenarioEnum scenario)
void	setCustomer(Customer customer)
void	setMetadata(Object metadata)
void	setOptions(QualificationsOption options)
void	setOrder(Order order)
void	setScenario(ClientQualificationsCheckEligibilityRequestBody.ScenarioEnum scenario)
void	setTrackingId(String trackingId)
String	toJson()	Convert an instance of ClientQualificationsCheckEligibilityRequestBody to an JSON string
String	toString()
ClientQualificationsCheckEligibilityRequestBody	trackingId(String trackingId)

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZED_NAME_CUSTOMER

public static final String SERIALIZED_NAME_CUSTOMER

See Also:

• Constant Field Values

SERIALIZED_NAME_ORDER

public static final String SERIALIZED_NAME_ORDER

See Also:

• Constant Field Values

SERIALIZED_NAME_TRACKING_ID

public static final String SERIALIZED_NAME_TRACKING_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_SCENARIO

public static final String SERIALIZED_NAME_SCENARIO

See Also:

• Constant Field Values

SERIALIZED_NAME_OPTIONS

public static final String SERIALIZED_NAME_OPTIONS

See Also:

• Constant Field Values

SERIALIZED_NAME_METADATA

public static final String SERIALIZED_NAME_METADATA

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

ClientQualificationsCheckEligibilityRequestBody

public ClientQualificationsCheckEligibilityRequestBody()

Method Details

customer

public ClientQualificationsCheckEligibilityRequestBody customer(Customer customer)

getCustomer

@Nullable
public Customer getCustomer()

Get customer

Returns:

customer

setCustomer

public void setCustomer(Customer customer)

order

public ClientQualificationsCheckEligibilityRequestBody order(Order order)

getOrder

@Nullable
public Order getOrder()

Get order

Returns:

order

setOrder

public void setOrder(Order order)

trackingId

public ClientQualificationsCheckEligibilityRequestBody trackingId(String trackingId)

getTrackingId

@Nullable
public String getTrackingId()

Is correspondent to Customer's source_id

Returns:

trackingId

setTrackingId

public void setTrackingId(String trackingId)

scenario

public ClientQualificationsCheckEligibilityRequestBody scenario(ClientQualificationsCheckEligibilityRequestBody.ScenarioEnum scenario)

getScenario

@Nullable
public ClientQualificationsCheckEligibilityRequestBody.ScenarioEnum getScenario()

Defines the scenario Voucherify should consider during the qualification process. - `ALL` - Scenario that returns all redeemables available for the customer in one API request. This scenario is used by default when no value is selected. - `CUSTOMER_WALLET` - returns vouchers applicable to the customer's cart based on the vouchers assigned to the customer's profile. - `AUDIENCE_ONLY` - returns all vouchers, promotion tiers, and campaigns available to the customer. Voucherify validates the rules based on the customer profile only. - `PRODUCTS` - returns all promotions available for the products (when a discount is defined to be applied to the item or when the item is required in the validation rule). - `PRODUCTS_DISCOUNT` - returns all promotions available for products when a discount is defined as applicable to specific item(s). - `PROMOTION_STACKS` - returns the applicable promotion stacks. - `PRODUCTS_BY_CUSTOMER` - returns all promotions available for a customer for the products (when a discount is defined to be applied to the item or when the item is required in the validation rule). - `PRODUCTS_DISCOUNT_BY_CUSTOMER` - returns all promotions available for a customer for products when a discount is defined as applicable to specific item(s).

Returns:

scenario

setScenario

public void setScenario(ClientQualificationsCheckEligibilityRequestBody.ScenarioEnum scenario)

options

public ClientQualificationsCheckEligibilityRequestBody options(QualificationsOption options)

getOptions

@Nullable
public QualificationsOption getOptions()

Get options

Returns:

options

setOptions

public void setOptions(QualificationsOption options)

metadata

public ClientQualificationsCheckEligibilityRequestBody metadata(Object metadata)

getMetadata

@Nullable
public Object getMetadata()

A set of key/value pairs that you can send in the request body to check against redeemables requiring **redemption** metadata validation rules to be satisfied. The validation runs against rules that are defined through the <!-- [Create Validation Rules](https://docs.voucherify.io/reference/create-validation-rules) -->[Create Validation Rules](ref:create-validation-rules) endpoint or via the Dashboard; in the _Advanced Rule Builder_ &rarr; _Advanced_ &rarr; _Redemption metadata satisfy_ or _Basic Builder_ &rarr; _Attributes match_ &rarr; _REDEMPTION METADATA_. [Read more](https://support.voucherify.io/article/148-how-to-build-a-rule).

Returns:

metadata

setMetadata

public void setMetadata(Object metadata)

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

Create an instance of ClientQualificationsCheckEligibilityRequestBody given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of ClientQualificationsCheckEligibilityRequestBody

Throws:

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

toJson

public String toJson()

Convert an instance of ClientQualificationsCheckEligibilityRequestBody to an JSON string

Returns:

JSON string