Package io.voucherify.client.model

Class RedemptionVoucher

java.lang.Object

io.voucherify.client.model.RedemptionVoucher

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

Defines the details of the voucher being redeemed.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
RedemptionVoucher	_object(String _object)
RedemptionVoucher	active(Boolean active)
RedemptionVoucher	addCategoriesItem(CategoryWithStackingRulesType categoriesItem)
RedemptionVoucher	additionalInfo(String additionalInfo)
RedemptionVoucher	addValidityDayOfWeekItem(RedemptionVoucher.ValidityDayOfWeekEnum validityDayOfWeekItem)
RedemptionVoucher	assets(VoucherAssets assets)
RedemptionVoucher	campaign(String campaign)
RedemptionVoucher	campaignId(String campaignId)
RedemptionVoucher	categories(List<CategoryWithStackingRulesType> categories)
RedemptionVoucher	category(String category)
RedemptionVoucher	categoryId(String categoryId)
RedemptionVoucher	code(String code)
RedemptionVoucher	createdAt(OffsetDateTime createdAt)
RedemptionVoucher	discount(Discount discount)
boolean	equals(Object o)
RedemptionVoucher	expirationDate(OffsetDateTime expirationDate)
static RedemptionVoucher	fromJson(String jsonString)	Create an instance of RedemptionVoucher 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<CategoryWithStackingRulesType>	getCategories()	Contains details about the category.
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.
Discount	getDiscount()	Get discount
OffsetDateTime	getExpirationDate()	Expiration timestamp defines when the code expires in ISO 8601 format.
RedemptionVoucherGift	getGift()	Get gift
SimpleCustomer	getHolder()	Get holder
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`.
RedemptionVoucherLoyaltyCard	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.
RedemptionVoucherPublish	getPublish()	Get publish
RedemptionVoucherRedemption	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.
RedemptionVoucher.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.
ValidationRulesAssignmentsList	getValidationRulesAssignments()	Get validationRulesAssignments
List<RedemptionVoucher.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
RedemptionVoucher	gift(RedemptionVoucherGift gift)
int	hashCode()
RedemptionVoucher	holder(SimpleCustomer holder)
RedemptionVoucher	holderId(String holderId)
RedemptionVoucher	id(String id)
RedemptionVoucher	isReferralCode(Boolean isReferralCode)
RedemptionVoucher	loyaltyCard(RedemptionVoucherLoyaltyCard loyaltyCard)
RedemptionVoucher	metadata(Object metadata)
RedemptionVoucher	publish(RedemptionVoucherPublish publish)
RedemptionVoucher	redemption(RedemptionVoucherRedemption redemption)
RedemptionVoucher	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<CategoryWithStackingRulesType> 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(RedemptionVoucherGift gift)
void	setHolder(SimpleCustomer holder)
void	setHolderId(String holderId)
void	setId(String id)
void	setIsReferralCode(Boolean isReferralCode)
void	setLoyaltyCard(RedemptionVoucherLoyaltyCard loyaltyCard)
void	setMetadata(Object metadata)
void	setObject(String _object)
void	setPublish(RedemptionVoucherPublish publish)
void	setRedemption(RedemptionVoucherRedemption redemption)
void	setReferrerId(String referrerId)
void	setStartDate(OffsetDateTime startDate)
void	setType(RedemptionVoucher.TypeEnum type)
void	setUpdatedAt(OffsetDateTime updatedAt)
void	setValidationRulesAssignments(ValidationRulesAssignmentsList validationRulesAssignments)
void	setValidityDayOfWeek(List<RedemptionVoucher.ValidityDayOfWeekEnum> validityDayOfWeek)
void	setValidityHours(ValidityHours validityHours)
void	setValidityTimeframe(ValidityTimeframe validityTimeframe)
RedemptionVoucher	startDate(OffsetDateTime startDate)
String	toJson()	Convert an instance of RedemptionVoucher to an JSON string
String	toString()
RedemptionVoucher	type(RedemptionVoucher.TypeEnum type)
RedemptionVoucher	updatedAt(OffsetDateTime updatedAt)
RedemptionVoucher	validationRulesAssignments(ValidationRulesAssignmentsList validationRulesAssignments)
RedemptionVoucher	validityDayOfWeek(List<RedemptionVoucher.ValidityDayOfWeekEnum> validityDayOfWeek)
RedemptionVoucher	validityHours(ValidityHours validityHours)
RedemptionVoucher	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_REFERRER_ID

public static final String SERIALIZED_NAME_REFERRER_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

SERIALIZED_NAME_CATEGORIES

public static final String SERIALIZED_NAME_CATEGORIES

See Also:

• Constant Field Values

SERIALIZED_NAME_VALIDATION_RULES_ASSIGNMENTS

public static final String SERIALIZED_NAME_VALIDATION_RULES_ASSIGNMENTS

See Also:

• Constant Field Values

SERIALIZED_NAME_HOLDER

public static final String SERIALIZED_NAME_HOLDER

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

RedemptionVoucher

public RedemptionVoucher()

Method Details

id

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

getCategory

@Nullable
public String getCategory()

Tag defining the category that this voucher belongs to. Useful when listing vouchers using the List Vouchers endpoint.

Returns:

category

setCategory

public void setCategory(String category)

categoryId

public RedemptionVoucher categoryId(String categoryId)

getCategoryId

@Nullable
public String getCategoryId()

Unique category ID assigned by Voucherify.

Returns:

categoryId

setCategoryId

public void setCategoryId(String categoryId)

type

public RedemptionVoucher type(RedemptionVoucher.TypeEnum type)

getType

@Nullable
public RedemptionVoucher.TypeEnum getType()

Defines the type of the voucher.

Returns:

type

setType

public void setType(RedemptionVoucher.TypeEnum type)

discount

public RedemptionVoucher discount(Discount discount)

getDiscount

@Nullable
public Discount getDiscount()

Get discount

Returns:

discount

setDiscount

public void setDiscount(Discount discount)

gift

public RedemptionVoucher gift(RedemptionVoucherGift gift)

getGift

@Nullable
public RedemptionVoucherGift getGift()

Get gift

Returns:

gift

setGift

public void setGift(RedemptionVoucherGift gift)

loyaltyCard

public RedemptionVoucher loyaltyCard(RedemptionVoucherLoyaltyCard loyaltyCard)

getLoyaltyCard

@Nullable
public RedemptionVoucherLoyaltyCard getLoyaltyCard()

Get loyaltyCard

Returns:

loyaltyCard

setLoyaltyCard

public void setLoyaltyCard(RedemptionVoucherLoyaltyCard loyaltyCard)

startDate

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

getValidityTimeframe

@Nullable
public ValidityTimeframe getValidityTimeframe()

Get validityTimeframe

Returns:

validityTimeframe

setValidityTimeframe

public void setValidityTimeframe(ValidityTimeframe validityTimeframe)

validityDayOfWeek

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

addValidityDayOfWeekItem

public RedemptionVoucher addValidityDayOfWeekItem(RedemptionVoucher.ValidityDayOfWeekEnum validityDayOfWeekItem)

getValidityDayOfWeek

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

validityHours

public RedemptionVoucher validityHours(ValidityHours validityHours)

getValidityHours

@Nullable
public ValidityHours getValidityHours()

Get validityHours

Returns:

validityHours

setValidityHours

public void setValidityHours(ValidityHours validityHours)

active

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

getAssets

@Nullable
public VoucherAssets getAssets()

Get assets

Returns:

assets

setAssets

public void setAssets(VoucherAssets assets)

isReferralCode

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

referrerId

public RedemptionVoucher referrerId(String referrerId)

getReferrerId

@Nullable
public String getReferrerId()

Unique identifier of the referring person.

Returns:

referrerId

setReferrerId

public void setReferrerId(String referrerId)

_object

public RedemptionVoucher _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 RedemptionVoucher publish(RedemptionVoucherPublish publish)

getPublish

@Nullable
public RedemptionVoucherPublish getPublish()

Get publish

Returns:

publish

setPublish

public void setPublish(RedemptionVoucherPublish publish)

redemption

public RedemptionVoucher redemption(RedemptionVoucherRedemption redemption)

getRedemption

@Nullable
public RedemptionVoucherRedemption getRedemption()

Get redemption

Returns:

redemption

setRedemption

public void setRedemption(RedemptionVoucherRedemption redemption)

categories

public RedemptionVoucher categories(List<CategoryWithStackingRulesType> categories)

addCategoriesItem

public RedemptionVoucher addCategoriesItem(CategoryWithStackingRulesType categoriesItem)

getCategories

@Nullable
public List<CategoryWithStackingRulesType> getCategories()

Contains details about the category.

Returns:

categories

setCategories

public void setCategories(List<CategoryWithStackingRulesType> categories)

validationRulesAssignments

public RedemptionVoucher validationRulesAssignments(ValidationRulesAssignmentsList validationRulesAssignments)

getValidationRulesAssignments

@Nullable
public ValidationRulesAssignmentsList getValidationRulesAssignments()

Get validationRulesAssignments

Returns:

validationRulesAssignments

setValidationRulesAssignments

public void setValidationRulesAssignments(ValidationRulesAssignmentsList validationRulesAssignments)

holder

public RedemptionVoucher holder(SimpleCustomer holder)

getHolder

@Nullable
public SimpleCustomer getHolder()

Get holder

Returns:

holder

setHolder

public void setHolder(SimpleCustomer holder)

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

Create an instance of RedemptionVoucher given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of RedemptionVoucher

Throws:

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

toJson

public String toJson()

Convert an instance of RedemptionVoucher to an JSON string

Returns:

JSON string