Package io.voucherify.client.model

Class LoyaltiesEarningRulesCreateRequestBodyItem

java.lang.Object

io.voucherify.client.model.LoyaltiesEarningRulesCreateRequestBodyItem

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

LoyaltiesEarningRulesCreateRequestBodyItem

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LoyaltiesEarningRulesCreateRequestBodyItem.CustomTypeAdapterFactory
static enum	LoyaltiesEarningRulesCreateRequestBodyItem.ValidityDayOfWeekEnum	Gets or Sets validityDayOfWeek

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_ACTIVE
static final String	SERIALIZED_NAME_CUSTOM_EVENT
static final String	SERIALIZED_NAME_EVENT
static final String	SERIALIZED_NAME_EXPIRATION_DATE
static final String	SERIALIZED_NAME_LOYALTY
static final String	SERIALIZED_NAME_LOYALTY_TIER
static final String	SERIALIZED_NAME_METADATA
static final String	SERIALIZED_NAME_SEGMENT
static final String	SERIALIZED_NAME_SOURCE
static final String	SERIALIZED_NAME_START_DATE
static final String	SERIALIZED_NAME_VALIDATION_RULE_ID
static final String	SERIALIZED_NAME_VALIDITY_DAY_OF_WEEK
static final String	SERIALIZED_NAME_VALIDITY_HOURS
static final String	SERIALIZED_NAME_VALIDITY_TIMEFRAME

Constructor Summary

Constructors

Constructor	Description
LoyaltiesEarningRulesCreateRequestBodyItem()

Method Summary

Modifier and Type	Method	Description
LoyaltiesEarningRulesCreateRequestBodyItem	active(Boolean active)
LoyaltiesEarningRulesCreateRequestBodyItem	addValidityDayOfWeekItem(LoyaltiesEarningRulesCreateRequestBodyItem.ValidityDayOfWeekEnum validityDayOfWeekItem)
LoyaltiesEarningRulesCreateRequestBodyItem	customEvent(LoyaltiesEarningRulesCreateRequestBodyItemCustomEvent customEvent)
boolean	equals(Object o)
LoyaltiesEarningRulesCreateRequestBodyItem	event(String event)
LoyaltiesEarningRulesCreateRequestBodyItem	expirationDate(OffsetDateTime expirationDate)
static LoyaltiesEarningRulesCreateRequestBodyItem	fromJson(String jsonString)	Create an instance of LoyaltiesEarningRulesCreateRequestBodyItem given an JSON string
Boolean	getActive()	A flag to toggle the earning rule on or off.
LoyaltiesEarningRulesCreateRequestBodyItemCustomEvent	getCustomEvent()	Get customEvent
String	getEvent()	Get event
OffsetDateTime	getExpirationDate()	Expiration date defines when the earning rule expires.
LoyaltiesEarningRulesCreateRequestBodyItemLoyalty	getLoyalty()	Get loyalty
LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyTier	getLoyaltyTier()	Get loyaltyTier
Object	getMetadata()	The metadata object stores all custom attributes assigned to the earning rule.
LoyaltiesEarningRulesCreateRequestBodyItemSegment	getSegment()	Get segment
LoyaltiesEarningRulesCreateRequestBodyItemSource	getSource()	Get source
OffsetDateTime	getStartDate()	Start date defines when the earning rule starts to be active.
String	getValidationRuleId()	A unique validation rule identifier assigned by the Voucherify API.
List<LoyaltiesEarningRulesCreateRequestBodyItem.ValidityDayOfWeekEnum>	getValidityDayOfWeek()	Integer array corresponding to the particular days of the week in which the voucher is valid.
ValidityHours	getValidityHours()	Get validityHours
ValidityTimeframe	getValidityTimeframe()	Get validityTimeframe
int	hashCode()
LoyaltiesEarningRulesCreateRequestBodyItem	loyalty(LoyaltiesEarningRulesCreateRequestBodyItemLoyalty loyalty)
LoyaltiesEarningRulesCreateRequestBodyItem	loyaltyTier(LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyTier loyaltyTier)
LoyaltiesEarningRulesCreateRequestBodyItem	metadata(Object metadata)
LoyaltiesEarningRulesCreateRequestBodyItem	segment(LoyaltiesEarningRulesCreateRequestBodyItemSegment segment)
void	setActive(Boolean active)
void	setCustomEvent(LoyaltiesEarningRulesCreateRequestBodyItemCustomEvent customEvent)
void	setEvent(String event)
void	setExpirationDate(OffsetDateTime expirationDate)
void	setLoyalty(LoyaltiesEarningRulesCreateRequestBodyItemLoyalty loyalty)
void	setLoyaltyTier(LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyTier loyaltyTier)
void	setMetadata(Object metadata)
void	setSegment(LoyaltiesEarningRulesCreateRequestBodyItemSegment segment)
void	setSource(LoyaltiesEarningRulesCreateRequestBodyItemSource source)
void	setStartDate(OffsetDateTime startDate)
void	setValidationRuleId(String validationRuleId)
void	setValidityDayOfWeek(List<LoyaltiesEarningRulesCreateRequestBodyItem.ValidityDayOfWeekEnum> validityDayOfWeek)
void	setValidityHours(ValidityHours validityHours)
void	setValidityTimeframe(ValidityTimeframe validityTimeframe)
LoyaltiesEarningRulesCreateRequestBodyItem	source(LoyaltiesEarningRulesCreateRequestBodyItemSource source)
LoyaltiesEarningRulesCreateRequestBodyItem	startDate(OffsetDateTime startDate)
String	toJson()	Convert an instance of LoyaltiesEarningRulesCreateRequestBodyItem to an JSON string
String	toString()
LoyaltiesEarningRulesCreateRequestBodyItem	validationRuleId(String validationRuleId)
LoyaltiesEarningRulesCreateRequestBodyItem	validityDayOfWeek(List<LoyaltiesEarningRulesCreateRequestBodyItem.ValidityDayOfWeekEnum> validityDayOfWeek)
LoyaltiesEarningRulesCreateRequestBodyItem	validityHours(ValidityHours validityHours)
LoyaltiesEarningRulesCreateRequestBodyItem	validityTimeframe(ValidityTimeframe validityTimeframe)

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZED_NAME_VALIDATION_RULE_ID

public static final String SERIALIZED_NAME_VALIDATION_RULE_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_LOYALTY

public static final String SERIALIZED_NAME_LOYALTY

See Also:

• Constant Field Values

SERIALIZED_NAME_EVENT

public static final String SERIALIZED_NAME_EVENT

See Also:

• Constant Field Values

SERIALIZED_NAME_SOURCE

public static final String SERIALIZED_NAME_SOURCE

See Also:

• Constant Field Values

SERIALIZED_NAME_ACTIVE

public static final String SERIALIZED_NAME_ACTIVE

See Also:

• Constant Field Values

SERIALIZED_NAME_START_DATE

public static final String SERIALIZED_NAME_START_DATE

See Also:

• Constant Field Values

SERIALIZED_NAME_EXPIRATION_DATE

public static final String SERIALIZED_NAME_EXPIRATION_DATE

See Also:

• Constant Field Values

SERIALIZED_NAME_VALIDITY_TIMEFRAME

public static final String SERIALIZED_NAME_VALIDITY_TIMEFRAME

See Also:

• Constant Field Values

SERIALIZED_NAME_VALIDITY_DAY_OF_WEEK

public static final String SERIALIZED_NAME_VALIDITY_DAY_OF_WEEK

See Also:

• Constant Field Values

SERIALIZED_NAME_VALIDITY_HOURS

public static final String SERIALIZED_NAME_VALIDITY_HOURS

See Also:

• Constant Field Values

SERIALIZED_NAME_METADATA

public static final String SERIALIZED_NAME_METADATA

See Also:

• Constant Field Values

SERIALIZED_NAME_SEGMENT

public static final String SERIALIZED_NAME_SEGMENT

See Also:

• Constant Field Values

SERIALIZED_NAME_CUSTOM_EVENT

public static final String SERIALIZED_NAME_CUSTOM_EVENT

See Also:

• Constant Field Values

SERIALIZED_NAME_LOYALTY_TIER

public static final String SERIALIZED_NAME_LOYALTY_TIER

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

LoyaltiesEarningRulesCreateRequestBodyItem

public LoyaltiesEarningRulesCreateRequestBodyItem()

Method Details

validationRuleId

public LoyaltiesEarningRulesCreateRequestBodyItem validationRuleId(String validationRuleId)

getValidationRuleId

@Nullable
public String getValidationRuleId()

A unique validation rule identifier assigned by the Voucherify API. The validation rule is verified before points are added to the balance.

Returns:

validationRuleId

setValidationRuleId

public void setValidationRuleId(String validationRuleId)

loyalty

public LoyaltiesEarningRulesCreateRequestBodyItem loyalty(LoyaltiesEarningRulesCreateRequestBodyItemLoyalty loyalty)

getLoyalty

@Nullable
public LoyaltiesEarningRulesCreateRequestBodyItemLoyalty getLoyalty()

Get loyalty

Returns:

loyalty

setLoyalty

public void setLoyalty(LoyaltiesEarningRulesCreateRequestBodyItemLoyalty loyalty)

event

public LoyaltiesEarningRulesCreateRequestBodyItem event(String event)

getEvent

@Nullable
public String getEvent()

Get event

Returns:

event

setEvent

public void setEvent(String event)

source

public LoyaltiesEarningRulesCreateRequestBodyItem source(LoyaltiesEarningRulesCreateRequestBodyItemSource source)

getSource

@Nullable
public LoyaltiesEarningRulesCreateRequestBodyItemSource getSource()

Get source

Returns:

source

setSource

public void setSource(LoyaltiesEarningRulesCreateRequestBodyItemSource source)

active

public LoyaltiesEarningRulesCreateRequestBodyItem active(Boolean active)

getActive

@Nullable
public Boolean getActive()

A flag to toggle the earning rule on or off. You can disable an earning rule even though it's within the active period defined by the `start_date` and `expiration_date` of the campaign or the earning rule's own `start_date` and `expiration_date`. - `true` indicates an *active* earning rule - `false` indicates an *inactive* earning rule

Returns:

active

setActive

public void setActive(Boolean active)

startDate

public LoyaltiesEarningRulesCreateRequestBodyItem startDate(OffsetDateTime startDate)

getStartDate

@Nullable
public OffsetDateTime getStartDate()

Start date defines when the earning rule starts to be active. Activation timestamp is presented in the ISO 8601 format. Earning rule is *inactive before* this date. If you don't define the start date for an earning rule, it'll inherit the campaign start date by default.

Returns:

startDate

setStartDate

public void setStartDate(OffsetDateTime startDate)

expirationDate

public LoyaltiesEarningRulesCreateRequestBodyItem expirationDate(OffsetDateTime expirationDate)

getExpirationDate

@Nullable
public OffsetDateTime getExpirationDate()

Expiration date defines when the earning rule expires. Expiration timestamp is presented in the ISO 8601 format. Earning rule is *inactive after* this date.If you don't define the expiration date for an earning rule, it'll inherit the campaign expiration date by default.

Returns:

expirationDate

setExpirationDate

public void setExpirationDate(OffsetDateTime expirationDate)

validityTimeframe

public LoyaltiesEarningRulesCreateRequestBodyItem validityTimeframe(ValidityTimeframe validityTimeframe)

getValidityTimeframe

@Nullable
public ValidityTimeframe getValidityTimeframe()

Get validityTimeframe

Returns:

validityTimeframe

setValidityTimeframe

public void setValidityTimeframe(ValidityTimeframe validityTimeframe)

validityDayOfWeek

public LoyaltiesEarningRulesCreateRequestBodyItem validityDayOfWeek(List<LoyaltiesEarningRulesCreateRequestBodyItem.ValidityDayOfWeekEnum> validityDayOfWeek)

addValidityDayOfWeekItem

public LoyaltiesEarningRulesCreateRequestBodyItem addValidityDayOfWeekItem(LoyaltiesEarningRulesCreateRequestBodyItem.ValidityDayOfWeekEnum validityDayOfWeekItem)

getValidityDayOfWeek

@Nullable
public List<LoyaltiesEarningRulesCreateRequestBodyItem.ValidityDayOfWeekEnum> getValidityDayOfWeek()

Integer array corresponding to the particular days of the week in which the voucher is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday

Returns:

validityDayOfWeek

setValidityDayOfWeek

public void setValidityDayOfWeek(List<LoyaltiesEarningRulesCreateRequestBodyItem.ValidityDayOfWeekEnum> validityDayOfWeek)

validityHours

public LoyaltiesEarningRulesCreateRequestBodyItem validityHours(ValidityHours validityHours)

getValidityHours

@Nullable
public ValidityHours getValidityHours()

Get validityHours

Returns:

validityHours

setValidityHours

public void setValidityHours(ValidityHours validityHours)

metadata

public LoyaltiesEarningRulesCreateRequestBodyItem metadata(Object metadata)

getMetadata

@Nullable
public Object getMetadata()

The metadata object stores all custom attributes assigned to the earning rule. A set of key/value pairs that you can attach to an earning rule object. It can be useful for storing additional information about the earning rule in a structured format.

Returns:

metadata

setMetadata

public void setMetadata(Object metadata)

segment

public LoyaltiesEarningRulesCreateRequestBodyItem segment(LoyaltiesEarningRulesCreateRequestBodyItemSegment segment)

getSegment

@Nullable
public LoyaltiesEarningRulesCreateRequestBodyItemSegment getSegment()

Get segment

Returns:

segment

setSegment

public void setSegment(LoyaltiesEarningRulesCreateRequestBodyItemSegment segment)

customEvent

public LoyaltiesEarningRulesCreateRequestBodyItem customEvent(LoyaltiesEarningRulesCreateRequestBodyItemCustomEvent customEvent)

getCustomEvent

@Nullable
public LoyaltiesEarningRulesCreateRequestBodyItemCustomEvent getCustomEvent()

Get customEvent

Returns:

customEvent

setCustomEvent

public void setCustomEvent(LoyaltiesEarningRulesCreateRequestBodyItemCustomEvent customEvent)

loyaltyTier

public LoyaltiesEarningRulesCreateRequestBodyItem loyaltyTier(LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyTier loyaltyTier)

getLoyaltyTier

@Nullable
public LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyTier getLoyaltyTier()

Get loyaltyTier

Returns:

loyaltyTier

setLoyaltyTier

public void setLoyaltyTier(LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyTier loyaltyTier)

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

Create an instance of LoyaltiesEarningRulesCreateRequestBodyItem given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of LoyaltiesEarningRulesCreateRequestBodyItem

Throws:

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

toJson

public String toJson()

Convert an instance of LoyaltiesEarningRulesCreateRequestBodyItem to an JSON string

Returns:

JSON string