Package io.voucherify.client.model

Class LoyaltyMember

java.lang.Object

io.voucherify.client.model.LoyaltyMember

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

This is an object representing a loyalty member.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LoyaltyMember.CustomTypeAdapterFactory
static enum	LoyaltyMember.TypeEnum	Defines the type of the voucher.
static enum	LoyaltyMember.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_ADDITIONAL_INFO
static final String	SERIALIZED_NAME_ASSETS
static final String	SERIALIZED_NAME_CAMPAIGN
static final String	SERIALIZED_NAME_CAMPAIGN_ID
static final String	SERIALIZED_NAME_CATEGORY
static final String	SERIALIZED_NAME_CATEGORY_ID
static final String	SERIALIZED_NAME_CODE
static final String	SERIALIZED_NAME_CREATED_AT
static final String	SERIALIZED_NAME_DISCOUNT
static final String	SERIALIZED_NAME_EXPIRATION_DATE
static final String	SERIALIZED_NAME_GIFT
static final String	SERIALIZED_NAME_HOLDER_ID
static final String	SERIALIZED_NAME_ID
static final String	SERIALIZED_NAME_IS_REFERRAL_CODE
static final String	SERIALIZED_NAME_LOYALTY_CARD
static final String	SERIALIZED_NAME_METADATA
static final String	SERIALIZED_NAME_OBJECT
static final String	SERIALIZED_NAME_PUBLISH
static final String	SERIALIZED_NAME_REDEMPTION
static final String	SERIALIZED_NAME_START_DATE
static final String	SERIALIZED_NAME_TYPE
static final String	SERIALIZED_NAME_UPDATED_AT
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
LoyaltyMember()

Method Summary

Modifier and Type	Method	Description
LoyaltyMember	_object(String _object)
LoyaltyMember	active(Boolean active)
LoyaltyMember	additionalInfo(String additionalInfo)
LoyaltyMember	addValidityDayOfWeekItem(LoyaltyMember.ValidityDayOfWeekEnum validityDayOfWeekItem)
LoyaltyMember	assets(VoucherAssets assets)
LoyaltyMember	campaign(String campaign)
LoyaltyMember	campaignId(String campaignId)
LoyaltyMember	category(String category)
LoyaltyMember	categoryId(String categoryId)
LoyaltyMember	code(String code)
LoyaltyMember	createdAt(OffsetDateTime createdAt)
LoyaltyMember	discount(Object discount)
boolean	equals(Object o)
LoyaltyMember	expirationDate(OffsetDateTime expirationDate)
static LoyaltyMember	fromJson(String jsonString)	Create an instance of LoyaltyMember given an JSON string
Boolean	getActive()	A flag to toggle the voucher on or off.
String	getAdditionalInfo()	An optional field to keep any extra textual information about the code such as a code description and details.
VoucherAssets	getAssets()	Get assets
String	getCampaign()	A unique campaign name, identifies the voucher's parent campaign.
String	getCampaignId()	Assigned by the Voucherify API, identifies the voucher's parent campaign.
String	getCategory()	Tag defining the category that this voucher belongs to.
String	getCategoryId()	Unique category ID assigned by Voucherify.
String	getCode()	A code that identifies a voucher.
OffsetDateTime	getCreatedAt()	Timestamp representing the date and time when the voucher was created.
Object	getDiscount()	Get discount
OffsetDateTime	getExpirationDate()	Expiration timestamp defines when the code expires in ISO 8601 format.
Object	getGift()	Get gift
String	getHolderId()	Unique identifier of the customer who owns the voucher.
String	getId()	Assigned by the Voucherify API, identifies the voucher.
Boolean	getIsReferralCode()	This is always false for loyalty members.
LoyaltyMemberLoyaltyCard	getLoyaltyCard()	Get loyaltyCard
Object	getMetadata()	The metadata object stores all custom attributes assigned to the code.
String	getObject()	The type of the object represented by JSON.
LoyaltyMemberPublish	getPublish()	Get publish
LoyaltyMemberRedemption	getRedemption()	Get redemption
OffsetDateTime	getStartDate()	Activation timestamp defines when the code starts to be active in ISO 8601 format.
LoyaltyMember.TypeEnum	getType()	Defines the type of the voucher.
OffsetDateTime	getUpdatedAt()	Timestamp representing the date and time when the voucher was last updated in ISO 8601 format.
List<LoyaltyMember.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
LoyaltyMember	gift(Object gift)
int	hashCode()
LoyaltyMember	holderId(String holderId)
LoyaltyMember	id(String id)
LoyaltyMember	isReferralCode(Boolean isReferralCode)
LoyaltyMember	loyaltyCard(LoyaltyMemberLoyaltyCard loyaltyCard)
LoyaltyMember	metadata(Object metadata)
LoyaltyMember	publish(LoyaltyMemberPublish publish)
LoyaltyMember	redemption(LoyaltyMemberRedemption redemption)
void	setActive(Boolean active)
void	setAdditionalInfo(String additionalInfo)
void	setAssets(VoucherAssets assets)
void	setCampaign(String campaign)
void	setCampaignId(String campaignId)
void	setCategory(String category)
void	setCategoryId(String categoryId)
void	setCode(String code)
void	setCreatedAt(OffsetDateTime createdAt)
void	setDiscount(Object discount)
void	setExpirationDate(OffsetDateTime expirationDate)
void	setGift(Object gift)
void	setHolderId(String holderId)
void	setId(String id)
void	setIsReferralCode(Boolean isReferralCode)
void	setLoyaltyCard(LoyaltyMemberLoyaltyCard loyaltyCard)
void	setMetadata(Object metadata)
void	setObject(String _object)
void	setPublish(LoyaltyMemberPublish publish)
void	setRedemption(LoyaltyMemberRedemption redemption)
void	setStartDate(OffsetDateTime startDate)
void	setType(LoyaltyMember.TypeEnum type)
void	setUpdatedAt(OffsetDateTime updatedAt)
void	setValidityDayOfWeek(List<LoyaltyMember.ValidityDayOfWeekEnum> validityDayOfWeek)
void	setValidityHours(ValidityHours validityHours)
void	setValidityTimeframe(ValidityTimeframe validityTimeframe)
LoyaltyMember	startDate(OffsetDateTime startDate)
String	toJson()	Convert an instance of LoyaltyMember to an JSON string
String	toString()
LoyaltyMember	type(LoyaltyMember.TypeEnum type)
LoyaltyMember	updatedAt(OffsetDateTime updatedAt)
LoyaltyMember	validityDayOfWeek(List<LoyaltyMember.ValidityDayOfWeekEnum> validityDayOfWeek)
LoyaltyMember	validityHours(ValidityHours validityHours)
LoyaltyMember	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_CODE

public static final String SERIALIZED_NAME_CODE

See Also:

• Constant Field Values

SERIALIZED_NAME_CAMPAIGN

public static final String SERIALIZED_NAME_CAMPAIGN

See Also:

• Constant Field Values

SERIALIZED_NAME_CAMPAIGN_ID

public static final String SERIALIZED_NAME_CAMPAIGN_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_CATEGORY

public static final String SERIALIZED_NAME_CATEGORY

See Also:

• Constant Field Values

SERIALIZED_NAME_CATEGORY_ID

public static final String SERIALIZED_NAME_CATEGORY_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_TYPE

public static final String SERIALIZED_NAME_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_DISCOUNT

public static final String SERIALIZED_NAME_DISCOUNT

See Also:

• Constant Field Values

SERIALIZED_NAME_GIFT

public static final String SERIALIZED_NAME_GIFT

See Also:

• Constant Field Values

SERIALIZED_NAME_LOYALTY_CARD

public static final String SERIALIZED_NAME_LOYALTY_CARD

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_ACTIVE

public static final String SERIALIZED_NAME_ACTIVE

See Also:

• Constant Field Values

SERIALIZED_NAME_ADDITIONAL_INFO

public static final String SERIALIZED_NAME_ADDITIONAL_INFO

See Also:

• Constant Field Values

SERIALIZED_NAME_METADATA

public static final String SERIALIZED_NAME_METADATA

See Also:

• Constant Field Values

SERIALIZED_NAME_ASSETS

public static final String SERIALIZED_NAME_ASSETS

See Also:

• Constant Field Values

SERIALIZED_NAME_IS_REFERRAL_CODE

public static final String SERIALIZED_NAME_IS_REFERRAL_CODE

See Also:

• Constant Field Values

SERIALIZED_NAME_CREATED_AT

public static final String SERIALIZED_NAME_CREATED_AT

See Also:

• Constant Field Values

SERIALIZED_NAME_UPDATED_AT

public static final String SERIALIZED_NAME_UPDATED_AT

See Also:

• Constant Field Values

SERIALIZED_NAME_HOLDER_ID

public static final String SERIALIZED_NAME_HOLDER_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_OBJECT

public static final String SERIALIZED_NAME_OBJECT

See Also:

• Constant Field Values

SERIALIZED_NAME_PUBLISH

public static final String SERIALIZED_NAME_PUBLISH

See Also:

• Constant Field Values

SERIALIZED_NAME_REDEMPTION

public static final String SERIALIZED_NAME_REDEMPTION

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

LoyaltyMember

public LoyaltyMember()

Method Details

id

public LoyaltyMember id(String id)

getId

@Nullable
public String getId()

Assigned by the Voucherify API, identifies the voucher.

Returns:

id

setId

public void setId(String id)

code

public LoyaltyMember code(String code)

getCode

@Nullable
public String getCode()

A code that identifies a voucher. Pattern can use all letters of the English alphabet, Arabic numerals, and special characters.

Returns:

code

setCode

public void setCode(String code)

campaign

public LoyaltyMember campaign(String campaign)

getCampaign

@Nullable
public String getCampaign()

A unique campaign name, identifies the voucher's parent campaign.

Returns:

campaign

setCampaign

public void setCampaign(String campaign)

campaignId

public LoyaltyMember campaignId(String campaignId)

getCampaignId

@Nullable
public String getCampaignId()

Assigned by the Voucherify API, identifies the voucher's parent campaign.

Returns:

campaignId

setCampaignId

public void setCampaignId(String campaignId)

category

public LoyaltyMember category(String category)

getCategory

@Nullable
public String getCategory()

Tag defining the category that this voucher belongs to.

Returns:

category

setCategory

public void setCategory(String category)

categoryId

public LoyaltyMember categoryId(String categoryId)

getCategoryId

@Nullable
public String getCategoryId()

Unique category ID assigned by Voucherify.

Returns:

categoryId

setCategoryId

public void setCategoryId(String categoryId)

type

public LoyaltyMember type(LoyaltyMember.TypeEnum type)

getType

@Nullable
public LoyaltyMember.TypeEnum getType()

Defines the type of the voucher.

Returns:

type

setType

public void setType(LoyaltyMember.TypeEnum type)

discount

public LoyaltyMember discount(Object discount)

getDiscount

@Nullable
public Object getDiscount()

Get discount

Returns:

discount

setDiscount

public void setDiscount(Object discount)

gift

public LoyaltyMember gift(Object gift)

getGift

@Nullable
public Object getGift()

Get gift

Returns:

gift

setGift

public void setGift(Object gift)

loyaltyCard

public LoyaltyMember loyaltyCard(LoyaltyMemberLoyaltyCard loyaltyCard)

getLoyaltyCard

@Nullable
public LoyaltyMemberLoyaltyCard getLoyaltyCard()

Get loyaltyCard

Returns:

loyaltyCard

setLoyaltyCard

public void setLoyaltyCard(LoyaltyMemberLoyaltyCard loyaltyCard)

startDate

public LoyaltyMember startDate(OffsetDateTime startDate)

getStartDate

@Nullable
public OffsetDateTime getStartDate()

Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is *inactive before* this date.

Returns:

startDate

setStartDate

public void setStartDate(OffsetDateTime startDate)

expirationDate

public LoyaltyMember expirationDate(OffsetDateTime expirationDate)

getExpirationDate

@Nullable
public OffsetDateTime getExpirationDate()

Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is *inactive after* this date.

Returns:

expirationDate

setExpirationDate

public void setExpirationDate(OffsetDateTime expirationDate)

validityTimeframe

public LoyaltyMember validityTimeframe(ValidityTimeframe validityTimeframe)

getValidityTimeframe

@Nullable
public ValidityTimeframe getValidityTimeframe()

Get validityTimeframe

Returns:

validityTimeframe

setValidityTimeframe

public void setValidityTimeframe(ValidityTimeframe validityTimeframe)

validityDayOfWeek

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

addValidityDayOfWeekItem

public LoyaltyMember addValidityDayOfWeekItem(LoyaltyMember.ValidityDayOfWeekEnum validityDayOfWeekItem)

getValidityDayOfWeek

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

validityHours

public LoyaltyMember validityHours(ValidityHours validityHours)

getValidityHours

@Nullable
public ValidityHours getValidityHours()

Get validityHours

Returns:

validityHours

setValidityHours

public void setValidityHours(ValidityHours validityHours)

active

public LoyaltyMember active(Boolean active)

getActive

@Nullable
public Boolean getActive()

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

Returns:

active

setActive

public void setActive(Boolean active)

additionalInfo

public LoyaltyMember additionalInfo(String additionalInfo)

getAdditionalInfo

@Nullable
public String getAdditionalInfo()

An optional field to keep any extra textual information about the code such as a code description and details.

Returns:

additionalInfo

setAdditionalInfo

public void setAdditionalInfo(String additionalInfo)

metadata

public LoyaltyMember metadata(Object metadata)

getMetadata

@Nullable
public Object getMetadata()

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

Returns:

metadata

setMetadata

public void setMetadata(Object metadata)

assets

public LoyaltyMember assets(VoucherAssets assets)

getAssets

@Nullable
public VoucherAssets getAssets()

Get assets

Returns:

assets

setAssets

public void setAssets(VoucherAssets assets)

isReferralCode

public LoyaltyMember isReferralCode(Boolean isReferralCode)

getIsReferralCode

@Nullable
public Boolean getIsReferralCode()

This is always false for loyalty members.

Returns:

isReferralCode

setIsReferralCode

public void setIsReferralCode(Boolean isReferralCode)

createdAt

public LoyaltyMember createdAt(OffsetDateTime createdAt)

getCreatedAt

@Nullable
public OffsetDateTime getCreatedAt()

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

Returns:

createdAt

setCreatedAt

public void setCreatedAt(OffsetDateTime createdAt)

updatedAt

public LoyaltyMember updatedAt(OffsetDateTime updatedAt)

getUpdatedAt

@Nullable
public OffsetDateTime getUpdatedAt()

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

Returns:

updatedAt

setUpdatedAt

public void setUpdatedAt(OffsetDateTime updatedAt)

holderId

public LoyaltyMember holderId(String holderId)

getHolderId

@Nullable
public String getHolderId()

Unique identifier of the customer who owns the voucher.

Returns:

holderId

setHolderId

public void setHolderId(String holderId)

_object

public LoyaltyMember _object(String _object)

getObject

@Nullable
public String getObject()

The type of the object represented by JSON. Default is `voucher`.

Returns:

_object

setObject

public void setObject(String _object)

publish

public LoyaltyMember publish(LoyaltyMemberPublish publish)

getPublish

@Nullable
public LoyaltyMemberPublish getPublish()

Get publish

Returns:

publish

setPublish

public void setPublish(LoyaltyMemberPublish publish)

redemption

public LoyaltyMember redemption(LoyaltyMemberRedemption redemption)

getRedemption

@Nullable
public LoyaltyMemberRedemption getRedemption()

Get redemption

Returns:

redemption

setRedemption

public void setRedemption(LoyaltyMemberRedemption redemption)

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

Create an instance of LoyaltyMember given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of LoyaltyMember

Throws:

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

toJson

public String toJson()

Convert an instance of LoyaltyMember to an JSON string

Returns:

JSON string