Package io.voucherify.client.model

Class LoyaltiesEarningRulesGetResponseBody

java.lang.Object

io.voucherify.client.model.LoyaltiesEarningRulesGetResponseBody

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

Response body schema for **GET** `v1/loyalties/{campaignId}/earning-rules/{earningRuleId}`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LoyaltiesEarningRulesGetResponseBody.CustomTypeAdapterFactory
static enum	LoyaltiesEarningRulesGetResponseBody.ObjectEnum	The type of the object represented by JSON.
static enum	LoyaltiesEarningRulesGetResponseBody.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_AUTOMATION_ID
static final String	SERIALIZED_NAME_CREATED_AT
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_ID
static final String	SERIALIZED_NAME_LOYALTY
static final String	SERIALIZED_NAME_LOYALTY_TIER
static final String	SERIALIZED_NAME_METADATA
static final String	SERIALIZED_NAME_OBJECT
static final String	SERIALIZED_NAME_SEGMENT
static final String	SERIALIZED_NAME_SOURCE
static final String	SERIALIZED_NAME_START_DATE
static final String	SERIALIZED_NAME_UPDATED_AT
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
LoyaltiesEarningRulesGetResponseBody()

Method Summary

Modifier and Type	Method	Description
LoyaltiesEarningRulesGetResponseBody	_object(LoyaltiesEarningRulesGetResponseBody.ObjectEnum _object)
LoyaltiesEarningRulesGetResponseBody	active(Boolean active)
LoyaltiesEarningRulesGetResponseBody	addValidityDayOfWeekItem(LoyaltiesEarningRulesGetResponseBody.ValidityDayOfWeekEnum validityDayOfWeekItem)
LoyaltiesEarningRulesGetResponseBody	automationId(String automationId)
LoyaltiesEarningRulesGetResponseBody	createdAt(OffsetDateTime createdAt)
LoyaltiesEarningRulesGetResponseBody	customEvent(LoyaltiesEarningRulesGetResponseBodyCustomEvent customEvent)
boolean	equals(Object o)
LoyaltiesEarningRulesGetResponseBody	event(String event)
LoyaltiesEarningRulesGetResponseBody	expirationDate(String expirationDate)
static LoyaltiesEarningRulesGetResponseBody	fromJson(String jsonString)	Create an instance of LoyaltiesEarningRulesGetResponseBody given an JSON string
Boolean	getActive()	A flag to toggle the earning rule on or off.
String	getAutomationId()	For internal use by Voucherify.
OffsetDateTime	getCreatedAt()	Timestamp representing the date and time when the earning rule was created.
LoyaltiesEarningRulesGetResponseBodyCustomEvent	getCustomEvent()	Get customEvent
String	getEvent()	Get event
String	getExpirationDate()	Expiration date defines when the earning rule expires.
String	getId()	Assigned by the Voucherify API, identifies the earning rule object.
LoyaltiesEarningRulesGetResponseBodyLoyalty	getLoyalty()	Get loyalty
LoyaltiesEarningRulesGetResponseBodyLoyaltyTier	getLoyaltyTier()	Get loyaltyTier
Object	getMetadata()	The metadata object stores all custom attributes assigned to the earning rule.
LoyaltiesEarningRulesGetResponseBody.ObjectEnum	getObject()	The type of the object represented by JSON.
LoyaltiesEarningRulesGetResponseBodySegment	getSegment()	Get segment
LoyaltiesEarningRulesGetResponseBodySource	getSource()	Get source
String	getStartDate()	Start date defines when the earning rule starts to be active.
OffsetDateTime	getUpdatedAt()	Timestamp representing the date and time when the earning rule was last updated in ISO 8601 format.
String	getValidationRuleId()	A unique validation rule identifier assigned by the Voucherify API.
List<LoyaltiesEarningRulesGetResponseBody.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()
LoyaltiesEarningRulesGetResponseBody	id(String id)
LoyaltiesEarningRulesGetResponseBody	loyalty(LoyaltiesEarningRulesGetResponseBodyLoyalty loyalty)
LoyaltiesEarningRulesGetResponseBody	loyaltyTier(LoyaltiesEarningRulesGetResponseBodyLoyaltyTier loyaltyTier)
LoyaltiesEarningRulesGetResponseBody	metadata(Object metadata)
LoyaltiesEarningRulesGetResponseBody	segment(LoyaltiesEarningRulesGetResponseBodySegment segment)
void	setActive(Boolean active)
void	setAutomationId(String automationId)
void	setCreatedAt(OffsetDateTime createdAt)
void	setCustomEvent(LoyaltiesEarningRulesGetResponseBodyCustomEvent customEvent)
void	setEvent(String event)
void	setExpirationDate(String expirationDate)
void	setId(String id)
void	setLoyalty(LoyaltiesEarningRulesGetResponseBodyLoyalty loyalty)
void	setLoyaltyTier(LoyaltiesEarningRulesGetResponseBodyLoyaltyTier loyaltyTier)
void	setMetadata(Object metadata)
void	setObject(LoyaltiesEarningRulesGetResponseBody.ObjectEnum _object)
void	setSegment(LoyaltiesEarningRulesGetResponseBodySegment segment)
void	setSource(LoyaltiesEarningRulesGetResponseBodySource source)
void	setStartDate(String startDate)
void	setUpdatedAt(OffsetDateTime updatedAt)
void	setValidationRuleId(String validationRuleId)
void	setValidityDayOfWeek(List<LoyaltiesEarningRulesGetResponseBody.ValidityDayOfWeekEnum> validityDayOfWeek)
void	setValidityHours(ValidityHours validityHours)
void	setValidityTimeframe(ValidityTimeframe validityTimeframe)
LoyaltiesEarningRulesGetResponseBody	source(LoyaltiesEarningRulesGetResponseBodySource source)
LoyaltiesEarningRulesGetResponseBody	startDate(String startDate)
String	toJson()	Convert an instance of LoyaltiesEarningRulesGetResponseBody to an JSON string
String	toString()
LoyaltiesEarningRulesGetResponseBody	updatedAt(OffsetDateTime updatedAt)
LoyaltiesEarningRulesGetResponseBody	validationRuleId(String validationRuleId)
LoyaltiesEarningRulesGetResponseBody	validityDayOfWeek(List<LoyaltiesEarningRulesGetResponseBody.ValidityDayOfWeekEnum> validityDayOfWeek)
LoyaltiesEarningRulesGetResponseBody	validityHours(ValidityHours validityHours)
LoyaltiesEarningRulesGetResponseBody	validityTimeframe(ValidityTimeframe validityTimeframe)

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZED_NAME_ID

public static final String SERIALIZED_NAME_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_CREATED_AT

public static final String SERIALIZED_NAME_CREATED_AT

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_CUSTOM_EVENT

public static final String SERIALIZED_NAME_CUSTOM_EVENT

See Also:

• Constant Field Values

SERIALIZED_NAME_SEGMENT

public static final String SERIALIZED_NAME_SEGMENT

See Also:

• Constant Field Values

SERIALIZED_NAME_LOYALTY_TIER

public static final String SERIALIZED_NAME_LOYALTY_TIER

See Also:

• Constant Field Values

SERIALIZED_NAME_SOURCE

public static final String SERIALIZED_NAME_SOURCE

See Also:

• Constant Field Values

SERIALIZED_NAME_OBJECT

public static final String SERIALIZED_NAME_OBJECT

See Also:

• Constant Field Values

SERIALIZED_NAME_AUTOMATION_ID

public static final String SERIALIZED_NAME_AUTOMATION_ID

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_VALIDATION_RULE_ID

public static final String SERIALIZED_NAME_VALIDATION_RULE_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_UPDATED_AT

public static final String SERIALIZED_NAME_UPDATED_AT

See Also:

• Constant Field Values

SERIALIZED_NAME_ACTIVE

public static final String SERIALIZED_NAME_ACTIVE

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

LoyaltiesEarningRulesGetResponseBody

public LoyaltiesEarningRulesGetResponseBody()

Method Details

id

public LoyaltiesEarningRulesGetResponseBody id(String id)

getId

@Nullable
public String getId()

Assigned by the Voucherify API, identifies the earning rule object.

Returns:

id

setId

public void setId(String id)

createdAt

public LoyaltiesEarningRulesGetResponseBody createdAt(OffsetDateTime createdAt)

getCreatedAt

@Nullable
public OffsetDateTime getCreatedAt()

Timestamp representing the date and time when the earning rule was created. The value is shown in the ISO 8601 format.

Returns:

createdAt

setCreatedAt

public void setCreatedAt(OffsetDateTime createdAt)

loyalty

public LoyaltiesEarningRulesGetResponseBody loyalty(LoyaltiesEarningRulesGetResponseBodyLoyalty loyalty)

getLoyalty

@Nullable
public LoyaltiesEarningRulesGetResponseBodyLoyalty getLoyalty()

Get loyalty

Returns:

loyalty

setLoyalty

public void setLoyalty(LoyaltiesEarningRulesGetResponseBodyLoyalty loyalty)

event

public LoyaltiesEarningRulesGetResponseBody event(String event)

getEvent

@Nullable
public String getEvent()

Get event

Returns:

event

setEvent

public void setEvent(String event)

customEvent

public LoyaltiesEarningRulesGetResponseBody customEvent(LoyaltiesEarningRulesGetResponseBodyCustomEvent customEvent)

getCustomEvent

@Nullable
public LoyaltiesEarningRulesGetResponseBodyCustomEvent getCustomEvent()

Get customEvent

Returns:

customEvent

setCustomEvent

public void setCustomEvent(LoyaltiesEarningRulesGetResponseBodyCustomEvent customEvent)

segment

public LoyaltiesEarningRulesGetResponseBody segment(LoyaltiesEarningRulesGetResponseBodySegment segment)

getSegment

@Nullable
public LoyaltiesEarningRulesGetResponseBodySegment getSegment()

Get segment

Returns:

segment

setSegment

public void setSegment(LoyaltiesEarningRulesGetResponseBodySegment segment)

loyaltyTier

public LoyaltiesEarningRulesGetResponseBody loyaltyTier(LoyaltiesEarningRulesGetResponseBodyLoyaltyTier loyaltyTier)

getLoyaltyTier

@Nullable
public LoyaltiesEarningRulesGetResponseBodyLoyaltyTier getLoyaltyTier()

Get loyaltyTier

Returns:

loyaltyTier

setLoyaltyTier

public void setLoyaltyTier(LoyaltiesEarningRulesGetResponseBodyLoyaltyTier loyaltyTier)

source

public LoyaltiesEarningRulesGetResponseBody source(LoyaltiesEarningRulesGetResponseBodySource source)

getSource

@Nullable
public LoyaltiesEarningRulesGetResponseBodySource getSource()

Get source

Returns:

source

setSource

public void setSource(LoyaltiesEarningRulesGetResponseBodySource source)

_object

public LoyaltiesEarningRulesGetResponseBody _object(LoyaltiesEarningRulesGetResponseBody.ObjectEnum _object)

getObject

@Nullable
public LoyaltiesEarningRulesGetResponseBody.ObjectEnum getObject()

The type of the object represented by JSON. Default is earning_rule.

Returns:

_object

setObject

public void setObject(LoyaltiesEarningRulesGetResponseBody.ObjectEnum _object)

automationId

public LoyaltiesEarningRulesGetResponseBody automationId(String automationId)

getAutomationId

@Nullable
public String getAutomationId()

For internal use by Voucherify.

Returns:

automationId

setAutomationId

public void setAutomationId(String automationId)

startDate

public LoyaltiesEarningRulesGetResponseBody startDate(String startDate)

getStartDate

@Nullable
public String getStartDate()

Start date defines when the earning rule starts to be active. Activation timestamp is presented in the ISO 8601 format. The earning rule is inactive before this date. If you do not define the start date for an earning rule, it will inherit the campaign start date by default.

Returns:

startDate

setStartDate

public void setStartDate(String startDate)

expirationDate

public LoyaltiesEarningRulesGetResponseBody expirationDate(String expirationDate)

getExpirationDate

@Nullable
public String getExpirationDate()

Expiration date defines when the earning rule expires. Expiration timestamp is presented in the ISO 8601 format. The earning rule is inactive after this date. If you do not define the expiration date for an earning rule, it will inherit the campaign expiration date by default.

Returns:

expirationDate

setExpirationDate

public void setExpirationDate(String expirationDate)

validityTimeframe

public LoyaltiesEarningRulesGetResponseBody validityTimeframe(ValidityTimeframe validityTimeframe)

getValidityTimeframe

@Nullable
public ValidityTimeframe getValidityTimeframe()

Get validityTimeframe

Returns:

validityTimeframe

setValidityTimeframe

public void setValidityTimeframe(ValidityTimeframe validityTimeframe)

validityDayOfWeek

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

addValidityDayOfWeekItem

public LoyaltiesEarningRulesGetResponseBody addValidityDayOfWeekItem(LoyaltiesEarningRulesGetResponseBody.ValidityDayOfWeekEnum validityDayOfWeekItem)

getValidityDayOfWeek

@Nullable
public List<LoyaltiesEarningRulesGetResponseBody.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<LoyaltiesEarningRulesGetResponseBody.ValidityDayOfWeekEnum> validityDayOfWeek)

validityHours

public LoyaltiesEarningRulesGetResponseBody validityHours(ValidityHours validityHours)

getValidityHours

@Nullable
public ValidityHours getValidityHours()

Get validityHours

Returns:

validityHours

setValidityHours

public void setValidityHours(ValidityHours validityHours)

metadata

public LoyaltiesEarningRulesGetResponseBody 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)

validationRuleId

public LoyaltiesEarningRulesGetResponseBody 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)

updatedAt

public LoyaltiesEarningRulesGetResponseBody updatedAt(OffsetDateTime updatedAt)

getUpdatedAt

@Nullable
public OffsetDateTime getUpdatedAt()

Timestamp representing the date and time when the earning rule was last updated in ISO 8601 format.

Returns:

updatedAt

setUpdatedAt

public void setUpdatedAt(OffsetDateTime updatedAt)

active

public LoyaltiesEarningRulesGetResponseBody 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)

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

Create an instance of LoyaltiesEarningRulesGetResponseBody given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of LoyaltiesEarningRulesGetResponseBody

Throws:

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

toJson

public String toJson()

Convert an instance of LoyaltiesEarningRulesGetResponseBody to an JSON string

Returns:

JSON string