Package io.voucherify.client.model

Class RedeemableVoucher

java.lang.Object

io.voucherify.client.model.RedeemableVoucher

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

This is an object representing a voucher.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RedeemableVoucher.CustomTypeAdapterFactory
static enum	RedeemableVoucher.TypeEnum	Defines the type of the voucher.
static enum	RedeemableVoucher.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_CATEGORIES
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_REFERRER_ID
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
RedeemableVoucher()

Method Summary

Modifier and Type	Method	Description
RedeemableVoucher	_object(String _object)
RedeemableVoucher	active(Boolean active)
RedeemableVoucher	addCategoriesItem(Object categoriesItem)
RedeemableVoucher	additionalInfo(String additionalInfo)
RedeemableVoucher	addValidityDayOfWeekItem(RedeemableVoucher.ValidityDayOfWeekEnum validityDayOfWeekItem)
RedeemableVoucher	assets(VoucherAssets assets)
RedeemableVoucher	campaign(String campaign)
RedeemableVoucher	campaignId(String campaignId)
RedeemableVoucher	categories(List<Object> categories)
RedeemableVoucher	category(String category)
RedeemableVoucher	categoryId(String categoryId)
RedeemableVoucher	code(String code)
RedeemableVoucher	createdAt(OffsetDateTime createdAt)
RedeemableVoucher	discount(Discount discount)
boolean	equals(Object o)
RedeemableVoucher	expirationDate(OffsetDateTime expirationDate)
static RedeemableVoucher	fromJson(String jsonString)	Create an instance of RedeemableVoucher 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.
List<Object>	getCategories()	Contains an empty array.
String	getCategory()	The value is null.
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.
Discount	getDiscount()	Get discount
OffsetDateTime	getExpirationDate()	Expiration timestamp defines when the code expires in ISO 8601 format.
RedeemableVoucherGift	getGift()	Get gift
String	getHolderId()	Unique customer identifier of the redeemable holder.
String	getId()	Assigned by the Voucherify API, identifies the voucher.
Boolean	getIsReferralCode()	Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`.
RedeemableVoucherLoyaltyCard	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.
RedeemableVoucherPublish	getPublish()	Get publish
RedeemableVoucherRedemption	getRedemption()	Get redemption
String	getReferrerId()	Unique identifier of the referring person.
OffsetDateTime	getStartDate()	Activation timestamp defines when the code starts to be active in ISO 8601 format.
RedeemableVoucher.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<RedeemableVoucher.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
RedeemableVoucher	gift(RedeemableVoucherGift gift)
int	hashCode()
RedeemableVoucher	holderId(String holderId)
RedeemableVoucher	id(String id)
RedeemableVoucher	isReferralCode(Boolean isReferralCode)
RedeemableVoucher	loyaltyCard(RedeemableVoucherLoyaltyCard loyaltyCard)
RedeemableVoucher	metadata(Object metadata)
RedeemableVoucher	publish(RedeemableVoucherPublish publish)
RedeemableVoucher	redemption(RedeemableVoucherRedemption redemption)
RedeemableVoucher	referrerId(String referrerId)
void	setActive(Boolean active)
void	setAdditionalInfo(String additionalInfo)
void	setAssets(VoucherAssets assets)
void	setCampaign(String campaign)
void	setCampaignId(String campaignId)
void	setCategories(List<Object> categories)
void	setCategory(String category)
void	setCategoryId(String categoryId)
void	setCode(String code)
void	setCreatedAt(OffsetDateTime createdAt)
void	setDiscount(Discount discount)
void	setExpirationDate(OffsetDateTime expirationDate)
void	setGift(RedeemableVoucherGift gift)
void	setHolderId(String holderId)
void	setId(String id)
void	setIsReferralCode(Boolean isReferralCode)
void	setLoyaltyCard(RedeemableVoucherLoyaltyCard loyaltyCard)
void	setMetadata(Object metadata)
void	setObject(String _object)
void	setPublish(RedeemableVoucherPublish publish)
void	setRedemption(RedeemableVoucherRedemption redemption)
void	setReferrerId(String referrerId)
void	setStartDate(OffsetDateTime startDate)
void	setType(RedeemableVoucher.TypeEnum type)
void	setUpdatedAt(OffsetDateTime updatedAt)
void	setValidityDayOfWeek(List<RedeemableVoucher.ValidityDayOfWeekEnum> validityDayOfWeek)
void	setValidityHours(ValidityHours validityHours)
void	setValidityTimeframe(ValidityTimeframe validityTimeframe)
RedeemableVoucher	startDate(OffsetDateTime startDate)
String	toJson()	Convert an instance of RedeemableVoucher to an JSON string
String	toString()
RedeemableVoucher	type(RedeemableVoucher.TypeEnum type)
RedeemableVoucher	updatedAt(OffsetDateTime updatedAt)
RedeemableVoucher	validityDayOfWeek(List<RedeemableVoucher.ValidityDayOfWeekEnum> validityDayOfWeek)
RedeemableVoucher	validityHours(ValidityHours validityHours)
RedeemableVoucher	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_CATEGORIES

public static final String SERIALIZED_NAME_CATEGORIES

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_REFERRER_ID

public static final String SERIALIZED_NAME_REFERRER_ID

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

RedeemableVoucher

public RedeemableVoucher()

Method Details

id

public RedeemableVoucher 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 RedeemableVoucher 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 RedeemableVoucher 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 RedeemableVoucher 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 RedeemableVoucher category(String category)

getCategory

@Nullable
public String getCategory()

The value is null.

Returns:

category

setCategory

public void setCategory(String category)

categoryId

public RedeemableVoucher categoryId(String categoryId)

getCategoryId

@Nullable
public String getCategoryId()

Unique category ID assigned by Voucherify.

Returns:

categoryId

setCategoryId

public void setCategoryId(String categoryId)

categories

public RedeemableVoucher categories(List<Object> categories)

addCategoriesItem

public RedeemableVoucher addCategoriesItem(Object categoriesItem)

getCategories

@Nullable
public List<Object> getCategories()

Contains an empty array.

Returns:

categories

setCategories

public void setCategories(List<Object> categories)

type

public RedeemableVoucher type(RedeemableVoucher.TypeEnum type)

getType

@Nullable
public RedeemableVoucher.TypeEnum getType()

Defines the type of the voucher.

Returns:

type

setType

public void setType(RedeemableVoucher.TypeEnum type)

discount

public RedeemableVoucher discount(Discount discount)

getDiscount

@Nullable
public Discount getDiscount()

Get discount

Returns:

discount

setDiscount

public void setDiscount(Discount discount)

gift

public RedeemableVoucher gift(RedeemableVoucherGift gift)

getGift

@Nullable
public RedeemableVoucherGift getGift()

Get gift

Returns:

gift

setGift

public void setGift(RedeemableVoucherGift gift)

loyaltyCard

public RedeemableVoucher loyaltyCard(RedeemableVoucherLoyaltyCard loyaltyCard)

getLoyaltyCard

@Nullable
public RedeemableVoucherLoyaltyCard getLoyaltyCard()

Get loyaltyCard

Returns:

loyaltyCard

setLoyaltyCard

public void setLoyaltyCard(RedeemableVoucherLoyaltyCard loyaltyCard)

startDate

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

getValidityTimeframe

@Nullable
public ValidityTimeframe getValidityTimeframe()

Get validityTimeframe

Returns:

validityTimeframe

setValidityTimeframe

public void setValidityTimeframe(ValidityTimeframe validityTimeframe)

validityDayOfWeek

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

addValidityDayOfWeekItem

public RedeemableVoucher addValidityDayOfWeekItem(RedeemableVoucher.ValidityDayOfWeekEnum validityDayOfWeekItem)

getValidityDayOfWeek

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

validityHours

public RedeemableVoucher validityHours(ValidityHours validityHours)

getValidityHours

@Nullable
public ValidityHours getValidityHours()

Get validityHours

Returns:

validityHours

setValidityHours

public void setValidityHours(ValidityHours validityHours)

active

public RedeemableVoucher 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 RedeemableVoucher 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 RedeemableVoucher 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 RedeemableVoucher assets(VoucherAssets assets)

getAssets

@Nullable
public VoucherAssets getAssets()

Get assets

Returns:

assets

setAssets

public void setAssets(VoucherAssets assets)

isReferralCode

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

createdAt

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

referrerId

public RedeemableVoucher referrerId(String referrerId)

getReferrerId

@Nullable
public String getReferrerId()

Unique identifier of the referring person.

Returns:

referrerId

setReferrerId

public void setReferrerId(String referrerId)

holderId

public RedeemableVoucher holderId(String holderId)

getHolderId

@Nullable
public String getHolderId()

Unique customer identifier of the redeemable holder. It equals to the customer ID assigned by Voucherify.

Returns:

holderId

setHolderId

public void setHolderId(String holderId)

_object

public RedeemableVoucher _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 RedeemableVoucher publish(RedeemableVoucherPublish publish)

getPublish

@Nullable
public RedeemableVoucherPublish getPublish()

Get publish

Returns:

publish

setPublish

public void setPublish(RedeemableVoucherPublish publish)

redemption

public RedeemableVoucher redemption(RedeemableVoucherRedemption redemption)

getRedemption

@Nullable
public RedeemableVoucherRedemption getRedemption()

Get redemption

Returns:

redemption

setRedemption

public void setRedemption(RedeemableVoucherRedemption 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 RedeemableVoucher fromJson(String jsonString)
                                  throws IOException

Create an instance of RedeemableVoucher given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of RedeemableVoucher

Throws:

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

toJson

public String toJson()

Convert an instance of RedeemableVoucher to an JSON string

Returns:

JSON string