Package io.voucherify.client.model

Class CampaignVoucher

java.lang.Object

io.voucherify.client.model.CampaignVoucher

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

Schema model for a campaign voucher.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CampaignVoucher.CustomTypeAdapterFactory
static enum	CampaignVoucher.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_DISCOUNT
static final String	SERIALIZED_NAME_EXPIRATION_DATE
static final String	SERIALIZED_NAME_GIFT
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
CampaignVoucher()

Method Summary

Modifier and Type	Method	Description
CampaignVoucher	addValidityDayOfWeekItem(CampaignVoucher.ValidityDayOfWeekEnum validityDayOfWeekItem)
CampaignVoucher	codeConfig(CodeConfig codeConfig)
CampaignVoucher	discount(Discount discount)
boolean	equals(Object o)
CampaignVoucher	expirationDate(OffsetDateTime expirationDate)
static CampaignVoucher	fromJson(String jsonString)	Create an instance of CampaignVoucher given an JSON string
CodeConfig	getCodeConfig()	Get codeConfig
Discount	getDiscount()	Get discount
OffsetDateTime	getExpirationDate()	Expiration timestamp defines when the campaign expires in ISO 8601 format.
Gift	getGift()	Get gift
Boolean	getIsReferralCode()	Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`.
CampaignLoyaltyCard	getLoyaltyCard()	Get loyaltyCard
CampaignVoucherRedemption	getRedemption()	Get redemption
OffsetDateTime	getStartDate()	Activation timestamp defines when the campaign starts to be active in ISO 8601 format.
String	getType()	Type of voucher.
List<CampaignVoucher.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
CampaignVoucher	gift(Gift gift)
int	hashCode()
CampaignVoucher	isReferralCode(Boolean isReferralCode)
CampaignVoucher	loyaltyCard(CampaignLoyaltyCard loyaltyCard)
CampaignVoucher	redemption(CampaignVoucherRedemption redemption)
void	setCodeConfig(CodeConfig codeConfig)
void	setDiscount(Discount discount)
void	setExpirationDate(OffsetDateTime expirationDate)
void	setGift(Gift gift)
void	setIsReferralCode(Boolean isReferralCode)
void	setLoyaltyCard(CampaignLoyaltyCard loyaltyCard)
void	setRedemption(CampaignVoucherRedemption redemption)
void	setStartDate(OffsetDateTime startDate)
void	setType(String type)
void	setValidityDayOfWeek(List<CampaignVoucher.ValidityDayOfWeekEnum> validityDayOfWeek)
void	setValidityHours(ValidityHours validityHours)
void	setValidityTimeframe(ValidityTimeframe validityTimeframe)
CampaignVoucher	startDate(OffsetDateTime startDate)
String	toJson()	Convert an instance of CampaignVoucher to an JSON string
String	toString()
CampaignVoucher	type(String type)
CampaignVoucher	validityDayOfWeek(List<CampaignVoucher.ValidityDayOfWeekEnum> validityDayOfWeek)
CampaignVoucher	validityHours(ValidityHours validityHours)
CampaignVoucher	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_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_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

CampaignVoucher

public CampaignVoucher()

Method Details

type

public CampaignVoucher type(String type)

getType

@Nullable
public String getType()

Type of voucher.

Returns:

type

setType

public void setType(String type)

discount

public CampaignVoucher discount(Discount discount)

getDiscount

@Nullable
public Discount getDiscount()

Get discount

Returns:

discount

setDiscount

public void setDiscount(Discount discount)

gift

public CampaignVoucher gift(Gift gift)

getGift

@Nullable
public Gift getGift()

Get gift

Returns:

gift

setGift

public void setGift(Gift gift)

loyaltyCard

public CampaignVoucher loyaltyCard(CampaignLoyaltyCard loyaltyCard)

getLoyaltyCard

@Nullable
public CampaignLoyaltyCard getLoyaltyCard()

Get loyaltyCard

Returns:

loyaltyCard

setLoyaltyCard

public void setLoyaltyCard(CampaignLoyaltyCard loyaltyCard)

redemption

public CampaignVoucher redemption(CampaignVoucherRedemption redemption)

getRedemption

@Nullable
public CampaignVoucherRedemption getRedemption()

Get redemption

Returns:

redemption

setRedemption

public void setRedemption(CampaignVoucherRedemption redemption)

codeConfig

public CampaignVoucher codeConfig(CodeConfig codeConfig)

getCodeConfig

@Nonnull
public CodeConfig getCodeConfig()

Get codeConfig

Returns:

codeConfig

setCodeConfig

public void setCodeConfig(CodeConfig codeConfig)

isReferralCode

public CampaignVoucher isReferralCode(Boolean isReferralCode)

getIsReferralCode

@Nullable
public Boolean getIsReferralCode()

Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`.

Returns:

isReferralCode

setIsReferralCode

public void setIsReferralCode(Boolean isReferralCode)

startDate

public CampaignVoucher 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 CampaignVoucher 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 CampaignVoucher validityTimeframe(ValidityTimeframe validityTimeframe)

getValidityTimeframe

@Nullable
public ValidityTimeframe getValidityTimeframe()

Get validityTimeframe

Returns:

validityTimeframe

setValidityTimeframe

public void setValidityTimeframe(ValidityTimeframe validityTimeframe)

validityDayOfWeek

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

addValidityDayOfWeekItem

public CampaignVoucher addValidityDayOfWeekItem(CampaignVoucher.ValidityDayOfWeekEnum validityDayOfWeekItem)

getValidityDayOfWeek

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

validityHours

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

Create an instance of CampaignVoucher given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of CampaignVoucher

Throws:

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

toJson

public String toJson()

Convert an instance of CampaignVoucher to an JSON string

Returns:

JSON string