Package io.voucherify.client.model

Class LoyaltyCampaignVoucher

java.lang.Object

io.voucherify.client.model.LoyaltyCampaignVoucher

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

Schema model for a campaign voucher.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LoyaltyCampaignVoucher.CustomTypeAdapterFactory
static enum	LoyaltyCampaignVoucher.TypeEnum	Type of voucher.
static enum	LoyaltyCampaignVoucher.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_CODE_CONFIG
static final String	SERIALIZED_NAME_EXPIRATION_DATE
static final String	SERIALIZED_NAME_IS_REFERRAL_CODE
static final String	SERIALIZED_NAME_LOYALTY_CARD
static final String	SERIALIZED_NAME_REDEMPTION
static final String	SERIALIZED_NAME_START_DATE
static final String	SERIALIZED_NAME_TYPE
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
LoyaltyCampaignVoucher()

Method Summary

Modifier and Type	Method	Description
LoyaltyCampaignVoucher	addValidityDayOfWeekItem(LoyaltyCampaignVoucher.ValidityDayOfWeekEnum validityDayOfWeekItem)
LoyaltyCampaignVoucher	codeConfig(CodeConfig codeConfig)
boolean	equals(Object o)
LoyaltyCampaignVoucher	expirationDate(OffsetDateTime expirationDate)
static LoyaltyCampaignVoucher	fromJson(String jsonString)	Create an instance of LoyaltyCampaignVoucher given an JSON string
CodeConfig	getCodeConfig()	Get codeConfig
OffsetDateTime	getExpirationDate()	Expiration timestamp defines when the campaign expires in ISO 8601 format.
Boolean	getIsReferralCode()	Always `false` for a loyalty card voucher
CampaignLoyaltyCard	getLoyaltyCard()	Get loyaltyCard
LoyaltyCampaignVoucherRedemption	getRedemption()	Get redemption
OffsetDateTime	getStartDate()	Activation timestamp defines when the campaign starts to be active in ISO 8601 format.
LoyaltyCampaignVoucher.TypeEnum	getType()	Type of voucher.
List<LoyaltyCampaignVoucher.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()
LoyaltyCampaignVoucher	isReferralCode(Boolean isReferralCode)
LoyaltyCampaignVoucher	loyaltyCard(CampaignLoyaltyCard loyaltyCard)
LoyaltyCampaignVoucher	redemption(LoyaltyCampaignVoucherRedemption redemption)
void	setCodeConfig(CodeConfig codeConfig)
void	setExpirationDate(OffsetDateTime expirationDate)
void	setIsReferralCode(Boolean isReferralCode)
void	setLoyaltyCard(CampaignLoyaltyCard loyaltyCard)
void	setRedemption(LoyaltyCampaignVoucherRedemption redemption)
void	setStartDate(OffsetDateTime startDate)
void	setType(LoyaltyCampaignVoucher.TypeEnum type)
void	setValidityDayOfWeek(List<LoyaltyCampaignVoucher.ValidityDayOfWeekEnum> validityDayOfWeek)
void	setValidityHours(ValidityHours validityHours)
void	setValidityTimeframe(ValidityTimeframe validityTimeframe)
LoyaltyCampaignVoucher	startDate(OffsetDateTime startDate)
String	toJson()	Convert an instance of LoyaltyCampaignVoucher to an JSON string
String	toString()
LoyaltyCampaignVoucher	type(LoyaltyCampaignVoucher.TypeEnum type)
LoyaltyCampaignVoucher	validityDayOfWeek(List<LoyaltyCampaignVoucher.ValidityDayOfWeekEnum> validityDayOfWeek)
LoyaltyCampaignVoucher	validityHours(ValidityHours validityHours)
LoyaltyCampaignVoucher	validityTimeframe(ValidityTimeframe validityTimeframe)

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZED_NAME_TYPE

public static final String SERIALIZED_NAME_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_LOYALTY_CARD

public static final String SERIALIZED_NAME_LOYALTY_CARD

See Also:

• Constant Field Values

SERIALIZED_NAME_REDEMPTION

public static final String SERIALIZED_NAME_REDEMPTION

See Also:

• Constant Field Values

SERIALIZED_NAME_CODE_CONFIG

public static final String SERIALIZED_NAME_CODE_CONFIG

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_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

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

LoyaltyCampaignVoucher

public LoyaltyCampaignVoucher()

Method Details

type

public LoyaltyCampaignVoucher type(LoyaltyCampaignVoucher.TypeEnum type)

getType

@Nullable
public LoyaltyCampaignVoucher.TypeEnum getType()

Type of voucher.

Returns:

type

setType

public void setType(LoyaltyCampaignVoucher.TypeEnum type)

loyaltyCard

public LoyaltyCampaignVoucher loyaltyCard(CampaignLoyaltyCard loyaltyCard)

getLoyaltyCard

@Nullable
public CampaignLoyaltyCard getLoyaltyCard()

Get loyaltyCard

Returns:

loyaltyCard

setLoyaltyCard

public void setLoyaltyCard(CampaignLoyaltyCard loyaltyCard)

redemption

public LoyaltyCampaignVoucher redemption(LoyaltyCampaignVoucherRedemption redemption)

getRedemption

@Nullable
public LoyaltyCampaignVoucherRedemption getRedemption()

Get redemption

Returns:

redemption

setRedemption

public void setRedemption(LoyaltyCampaignVoucherRedemption redemption)

codeConfig

public LoyaltyCampaignVoucher codeConfig(CodeConfig codeConfig)

getCodeConfig

@Nonnull
public CodeConfig getCodeConfig()

Get codeConfig

Returns:

codeConfig

setCodeConfig

public void setCodeConfig(CodeConfig codeConfig)

isReferralCode

public LoyaltyCampaignVoucher isReferralCode(Boolean isReferralCode)

getIsReferralCode

@Nullable
public Boolean getIsReferralCode()

Always `false` for a loyalty card voucher

Returns:

isReferralCode

setIsReferralCode

public void setIsReferralCode(Boolean isReferralCode)

startDate

public LoyaltyCampaignVoucher startDate(OffsetDateTime startDate)

getStartDate

@Nullable
public OffsetDateTime getStartDate()

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

Returns:

startDate

setStartDate

public void setStartDate(OffsetDateTime startDate)

expirationDate

public LoyaltyCampaignVoucher expirationDate(OffsetDateTime expirationDate)

getExpirationDate

@Nullable
public OffsetDateTime getExpirationDate()

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

Returns:

expirationDate

setExpirationDate

public void setExpirationDate(OffsetDateTime expirationDate)

validityTimeframe

public LoyaltyCampaignVoucher validityTimeframe(ValidityTimeframe validityTimeframe)

getValidityTimeframe

@Nullable
public ValidityTimeframe getValidityTimeframe()

Get validityTimeframe

Returns:

validityTimeframe

setValidityTimeframe

public void setValidityTimeframe(ValidityTimeframe validityTimeframe)

validityDayOfWeek

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

addValidityDayOfWeekItem

public LoyaltyCampaignVoucher addValidityDayOfWeekItem(LoyaltyCampaignVoucher.ValidityDayOfWeekEnum validityDayOfWeekItem)

getValidityDayOfWeek

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

validityHours

public LoyaltyCampaignVoucher validityHours(ValidityHours validityHours)

getValidityHours

@Nullable
public ValidityHours getValidityHours()

Get validityHours

Returns:

validityHours

setValidityHours

public void setValidityHours(ValidityHours validityHours)

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

Create an instance of LoyaltyCampaignVoucher given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of LoyaltyCampaignVoucher

Throws:

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

toJson

public String toJson()

Convert an instance of LoyaltyCampaignVoucher to an JSON string

Returns:

JSON string