Package io.voucherify.client.model

Class SimpleVoucher

java.lang.Object

io.voucherify.client.model.SimpleVoucher

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

Simplified voucher data.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SimpleVoucher.CustomTypeAdapterFactory
static enum	SimpleVoucher.ObjectEnum	The type of the object represented by JSON.
static enum	SimpleVoucher.TypeEnum	Type of the voucher.

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_CAMPAIGN
static final String	SERIALIZED_NAME_CAMPAIGN_ID
static final String	SERIALIZED_NAME_CATEGORIES
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_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

Constructor Summary

Constructors

Constructor	Description
SimpleVoucher()

Method Summary

Modifier and Type	Method	Description
SimpleVoucher	_object(SimpleVoucher.ObjectEnum _object)
SimpleVoucher	active(Boolean active)
SimpleVoucher	addCategoriesItem(Category categoriesItem)
SimpleVoucher	campaign(String campaign)
SimpleVoucher	campaignId(String campaignId)
SimpleVoucher	categories(List<Category> categories)
SimpleVoucher	categoryId(String categoryId)
SimpleVoucher	code(String code)
SimpleVoucher	createdAt(OffsetDateTime createdAt)
SimpleVoucher	discount(Discount discount)
boolean	equals(Object o)
SimpleVoucher	expirationDate(OffsetDateTime expirationDate)
static SimpleVoucher	fromJson(String jsonString)	Create an instance of SimpleVoucher given an JSON string
Boolean	getActive()	Shows whether the voucher is on or off.
String	getCampaign()	Campaign name.
String	getCampaignId()	Campaign unique ID.
List<Category>	getCategories()	Contains details about the category.
String	getCategoryId()	Unique identifier of the category that this voucher belongs to.
String	getCode()	Voucher code.
OffsetDateTime	getCreatedAt()	Timestamp representing the date and time when the order was created in the ISO 8601 format.
Discount	getDiscount()	Get discount
OffsetDateTime	getExpirationDate()	Expiration timestamp defines when the code expires in ISO 8601 format.
Gift	getGift()	Get gift
String	getHolderId()	Unique customer identifier of the redeemable holder.
String	getId()	A unique identifier that represents the voucher assigned by Voucherify.
Boolean	getIsReferralCode()	Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`.
SimpleLoyaltyCard	getLoyaltyCard()	Get loyaltyCard
Object	getMetadata()	A set of custom key/value pairs that you can attach to a voucher.
SimpleVoucher.ObjectEnum	getObject()	The type of the object represented by JSON.
SimpleVoucherRedemption	getRedemption()	Get redemption
String	getReferrerId()	Unique identifier of the referrer assigned by Voucherify.
OffsetDateTime	getStartDate()	Activation timestamp defines when the code starts to be active in ISO 8601 format.
SimpleVoucher.TypeEnum	getType()	Type of the voucher.
OffsetDateTime	getUpdatedAt()	Timestamp representing the date and time when the order was created.
SimpleVoucher	gift(Gift gift)
int	hashCode()
SimpleVoucher	holderId(String holderId)
SimpleVoucher	id(String id)
SimpleVoucher	isReferralCode(Boolean isReferralCode)
SimpleVoucher	loyaltyCard(SimpleLoyaltyCard loyaltyCard)
SimpleVoucher	metadata(Object metadata)
SimpleVoucher	redemption(SimpleVoucherRedemption redemption)
SimpleVoucher	referrerId(String referrerId)
void	setActive(Boolean active)
void	setCampaign(String campaign)
void	setCampaignId(String campaignId)
void	setCategories(List<Category> categories)
void	setCategoryId(String categoryId)
void	setCode(String code)
void	setCreatedAt(OffsetDateTime createdAt)
void	setDiscount(Discount discount)
void	setExpirationDate(OffsetDateTime expirationDate)
void	setGift(Gift gift)
void	setHolderId(String holderId)
void	setId(String id)
void	setIsReferralCode(Boolean isReferralCode)
void	setLoyaltyCard(SimpleLoyaltyCard loyaltyCard)
void	setMetadata(Object metadata)
void	setObject(SimpleVoucher.ObjectEnum _object)
void	setRedemption(SimpleVoucherRedemption redemption)
void	setReferrerId(String referrerId)
void	setStartDate(OffsetDateTime startDate)
void	setType(SimpleVoucher.TypeEnum type)
void	setUpdatedAt(OffsetDateTime updatedAt)
SimpleVoucher	startDate(OffsetDateTime startDate)
String	toJson()	Convert an instance of SimpleVoucher to an JSON string
String	toString()
SimpleVoucher	type(SimpleVoucher.TypeEnum type)
SimpleVoucher	updatedAt(OffsetDateTime updatedAt)

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_GIFT

public static final String SERIALIZED_NAME_GIFT

See Also:

• Constant Field Values

SERIALIZED_NAME_DISCOUNT

public static final String SERIALIZED_NAME_DISCOUNT

See Also:

• Constant Field Values

SERIALIZED_NAME_LOYALTY_CARD

public static final String SERIALIZED_NAME_LOYALTY_CARD

See Also:

• Constant Field Values

SERIALIZED_NAME_TYPE

public static final String SERIALIZED_NAME_TYPE

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_IS_REFERRAL_CODE

public static final String SERIALIZED_NAME_IS_REFERRAL_CODE

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

public static final String SERIALIZED_NAME_ACTIVE

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_REDEMPTION

public static final String SERIALIZED_NAME_REDEMPTION

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_METADATA

public static final String SERIALIZED_NAME_METADATA

See Also:

• Constant Field Values

SERIALIZED_NAME_OBJECT

public static final String SERIALIZED_NAME_OBJECT

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

SimpleVoucher

public SimpleVoucher()

Method Details

id

public SimpleVoucher id(String id)

getId

@Nullable
public String getId()

A unique identifier that represents the voucher assigned by Voucherify.

Returns:

id

setId

public void setId(String id)

code

public SimpleVoucher code(String code)

getCode

@Nullable
public String getCode()

Voucher code.

Returns:

code

setCode

public void setCode(String code)

gift

public SimpleVoucher gift(Gift gift)

getGift

@Nullable
public Gift getGift()

Get gift

Returns:

gift

setGift

public void setGift(Gift gift)

discount

public SimpleVoucher discount(Discount discount)

getDiscount

@Nullable
public Discount getDiscount()

Get discount

Returns:

discount

setDiscount

public void setDiscount(Discount discount)

loyaltyCard

public SimpleVoucher loyaltyCard(SimpleLoyaltyCard loyaltyCard)

getLoyaltyCard

@Nullable
public SimpleLoyaltyCard getLoyaltyCard()

Get loyaltyCard

Returns:

loyaltyCard

setLoyaltyCard

public void setLoyaltyCard(SimpleLoyaltyCard loyaltyCard)

type

public SimpleVoucher type(SimpleVoucher.TypeEnum type)

getType

@Nullable
public SimpleVoucher.TypeEnum getType()

Type of the voucher.

Returns:

type

setType

public void setType(SimpleVoucher.TypeEnum type)

campaign

public SimpleVoucher campaign(String campaign)

getCampaign

@Nullable
public String getCampaign()

Campaign name.

Returns:

campaign

setCampaign

public void setCampaign(String campaign)

campaignId

public SimpleVoucher campaignId(String campaignId)

getCampaignId

@Nullable
public String getCampaignId()

Campaign unique ID.

Returns:

campaignId

setCampaignId

public void setCampaignId(String campaignId)

isReferralCode

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

holderId

public SimpleVoucher 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 SimpleVoucher referrerId(String referrerId)

getReferrerId

@Nullable
public String getReferrerId()

Unique identifier of the referrer assigned by Voucherify.

Returns:

referrerId

setReferrerId

public void setReferrerId(String referrerId)

categoryId

public SimpleVoucher categoryId(String categoryId)

getCategoryId

@Nullable
public String getCategoryId()

Unique identifier of the category that this voucher belongs to.

Returns:

categoryId

setCategoryId

public void setCategoryId(String categoryId)

categories

public SimpleVoucher categories(List<Category> categories)

addCategoriesItem

public SimpleVoucher addCategoriesItem(Category categoriesItem)

getCategories

@Nullable
public List<Category> getCategories()

Contains details about the category.

Returns:

categories

setCategories

public void setCategories(List<Category> categories)

active

public SimpleVoucher active(Boolean active)

getActive

@Nullable
public Boolean getActive()

Shows whether the voucher is on or off. `true` indicates an *active* voucher and `false` indicates an *inactive* voucher.

Returns:

active

setActive

public void setActive(Boolean active)

createdAt

public SimpleVoucher createdAt(OffsetDateTime createdAt)

getCreatedAt

@Nullable
public OffsetDateTime getCreatedAt()

Timestamp representing the date and time when the order was created in the ISO 8601 format.

Returns:

createdAt

setCreatedAt

public void setCreatedAt(OffsetDateTime createdAt)

updatedAt

public SimpleVoucher updatedAt(OffsetDateTime updatedAt)

getUpdatedAt

@Nullable
public OffsetDateTime getUpdatedAt()

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

Returns:

updatedAt

setUpdatedAt

public void setUpdatedAt(OffsetDateTime updatedAt)

redemption

public SimpleVoucher redemption(SimpleVoucherRedemption redemption)

getRedemption

@Nullable
public SimpleVoucherRedemption getRedemption()

Get redemption

Returns:

redemption

setRedemption

public void setRedemption(SimpleVoucherRedemption redemption)

startDate

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

metadata

public SimpleVoucher metadata(Object metadata)

getMetadata

@Nullable
public Object getMetadata()

A set of custom key/value pairs that you can attach to a voucher. The metadata object stores all custom attributes assigned to the voucher.

Returns:

metadata

setMetadata

public void setMetadata(Object metadata)

_object

public SimpleVoucher _object(SimpleVoucher.ObjectEnum _object)

getObject

@Nullable
public SimpleVoucher.ObjectEnum getObject()

The type of the object represented by JSON.

Returns:

_object

setObject

public void setObject(SimpleVoucher.ObjectEnum _object)

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

Create an instance of SimpleVoucher given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of SimpleVoucher

Throws:

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

toJson

public String toJson()

Convert an instance of SimpleVoucher to an JSON string

Returns:

JSON string