Package io.voucherify.client.model

Class VouchersCreateWithSpecificCodeRequestBody

java.lang.Object

io.voucherify.client.model.VouchersCreateWithSpecificCodeRequestBody

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

VouchersCreateWithSpecificCodeRequestBody

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VouchersCreateWithSpecificCodeRequestBody.CustomTypeAdapterFactory
static enum	VouchersCreateWithSpecificCodeRequestBody.TypeEnum	Gets or Sets type
static enum	VouchersCreateWithSpecificCodeRequestBody.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_CAMPAIGN
static final String	SERIALIZED_NAME_CAMPAIGN_ID
static final String	SERIALIZED_NAME_CATEGORY
static final String	SERIALIZED_NAME_CATEGORY_ID
static final String	SERIALIZED_NAME_DISCOUNT
static final String	SERIALIZED_NAME_EXPIRATION_DATE
static final String	SERIALIZED_NAME_GIFT
static final String	SERIALIZED_NAME_LOYALTY_CARD
static final String	SERIALIZED_NAME_METADATA
static final String	SERIALIZED_NAME_REDEMPTION
static final String	SERIALIZED_NAME_START_DATE
static final String	SERIALIZED_NAME_TYPE
static final String	SERIALIZED_NAME_VALIDATION_RULES
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
VouchersCreateWithSpecificCodeRequestBody()

Method Summary

Modifier and Type	Method	Description
VouchersCreateWithSpecificCodeRequestBody	active(Boolean active)
VouchersCreateWithSpecificCodeRequestBody	additionalInfo(String additionalInfo)
VouchersCreateWithSpecificCodeRequestBody	addValidationRulesItem(String validationRulesItem)
VouchersCreateWithSpecificCodeRequestBody	addValidityDayOfWeekItem(VouchersCreateWithSpecificCodeRequestBody.ValidityDayOfWeekEnum validityDayOfWeekItem)
VouchersCreateWithSpecificCodeRequestBody	campaign(String campaign)
VouchersCreateWithSpecificCodeRequestBody	campaignId(String campaignId)
VouchersCreateWithSpecificCodeRequestBody	category(String category)
VouchersCreateWithSpecificCodeRequestBody	categoryId(String categoryId)
VouchersCreateWithSpecificCodeRequestBody	discount(Discount discount)
boolean	equals(Object o)
VouchersCreateWithSpecificCodeRequestBody	expirationDate(OffsetDateTime expirationDate)
static VouchersCreateWithSpecificCodeRequestBody	fromJson(String jsonString)	Create an instance of VouchersCreateWithSpecificCodeRequestBody 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.
String	getCampaign()	Identifies the voucher's parent campaign using a unique campaign name.
String	getCampaignId()	Identifies the voucher's parent campaign using a unique campaign ID assigned by the Voucherify API.
String	getCategory()	The name of the category that this voucher belongs to.
String	getCategoryId()	Unique identifier assigned by Voucherify to the name of the category that this voucher belongs to.
Discount	getDiscount()	Get discount
OffsetDateTime	getExpirationDate()	Expiration date defines when the code expires.
Gift	getGift()	Get gift
SimpleLoyaltyCard	getLoyaltyCard()	Get loyaltyCard
Object	getMetadata()	The metadata object stores all custom attributes assigned to the code.
VouchersCreateWithSpecificCodeRequestBodyRedemption	getRedemption()	Get redemption
OffsetDateTime	getStartDate()	Start date defines when the code starts to be active.
VouchersCreateWithSpecificCodeRequestBody.TypeEnum	getType()	Get type
List<String>	getValidationRules()	Array containing the ID of the validation rule associated with the voucher.
List<VouchersCreateWithSpecificCodeRequestBody.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
VouchersCreateWithSpecificCodeRequestBody	gift(Gift gift)
int	hashCode()
VouchersCreateWithSpecificCodeRequestBody	loyaltyCard(SimpleLoyaltyCard loyaltyCard)
VouchersCreateWithSpecificCodeRequestBody	metadata(Object metadata)
VouchersCreateWithSpecificCodeRequestBody	redemption(VouchersCreateWithSpecificCodeRequestBodyRedemption redemption)
void	setActive(Boolean active)
void	setAdditionalInfo(String additionalInfo)
void	setCampaign(String campaign)
void	setCampaignId(String campaignId)
void	setCategory(String category)
void	setCategoryId(String categoryId)
void	setDiscount(Discount discount)
void	setExpirationDate(OffsetDateTime expirationDate)
void	setGift(Gift gift)
void	setLoyaltyCard(SimpleLoyaltyCard loyaltyCard)
void	setMetadata(Object metadata)
void	setRedemption(VouchersCreateWithSpecificCodeRequestBodyRedemption redemption)
void	setStartDate(OffsetDateTime startDate)
void	setType(VouchersCreateWithSpecificCodeRequestBody.TypeEnum type)
void	setValidationRules(List<String> validationRules)
void	setValidityDayOfWeek(List<VouchersCreateWithSpecificCodeRequestBody.ValidityDayOfWeekEnum> validityDayOfWeek)
void	setValidityHours(ValidityHours validityHours)
void	setValidityTimeframe(ValidityTimeframe validityTimeframe)
VouchersCreateWithSpecificCodeRequestBody	startDate(OffsetDateTime startDate)
String	toJson()	Convert an instance of VouchersCreateWithSpecificCodeRequestBody to an JSON string
String	toString()
VouchersCreateWithSpecificCodeRequestBody	type(VouchersCreateWithSpecificCodeRequestBody.TypeEnum type)
VouchersCreateWithSpecificCodeRequestBody	validationRules(List<String> validationRules)
VouchersCreateWithSpecificCodeRequestBody	validityDayOfWeek(List<VouchersCreateWithSpecificCodeRequestBody.ValidityDayOfWeekEnum> validityDayOfWeek)
VouchersCreateWithSpecificCodeRequestBody	validityHours(ValidityHours validityHours)
VouchersCreateWithSpecificCodeRequestBody	validityTimeframe(ValidityTimeframe validityTimeframe)

Methods inherited from class java.lang.Object

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

Field Details

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

public static final String SERIALIZED_NAME_VALIDATION_RULES

See Also:

• Constant Field Values

SERIALIZED_NAME_REDEMPTION

public static final String SERIALIZED_NAME_REDEMPTION

See Also:

• Constant Field Values

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

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

VouchersCreateWithSpecificCodeRequestBody

public VouchersCreateWithSpecificCodeRequestBody()

Method Details

campaign

public VouchersCreateWithSpecificCodeRequestBody campaign(String campaign)

getCampaign

@Nullable
public String getCampaign()

Identifies the voucher's parent campaign using a unique campaign name.

Returns:

campaign

setCampaign

public void setCampaign(String campaign)

campaignId

public VouchersCreateWithSpecificCodeRequestBody campaignId(String campaignId)

getCampaignId

@Nullable
public String getCampaignId()

Identifies the voucher's parent campaign using a unique campaign ID assigned by the Voucherify API.

Returns:

campaignId

setCampaignId

public void setCampaignId(String campaignId)

category

public VouchersCreateWithSpecificCodeRequestBody category(String category)

getCategory

@Nullable
public String getCategory()

The name of the category that this voucher belongs to. Useful when listing vouchers with the [List Vouchers](ref:list-vouchers) endpoint.

Returns:

category

setCategory

public void setCategory(String category)

categoryId

public VouchersCreateWithSpecificCodeRequestBody categoryId(String categoryId)

getCategoryId

@Nullable
public String getCategoryId()

Unique identifier assigned by Voucherify to the name of the category that this voucher belongs to. Useful when listing vouchers with the [List Vouchers](ref:list-vouchers) endpoint.

Returns:

categoryId

setCategoryId

public void setCategoryId(String categoryId)

startDate

public VouchersCreateWithSpecificCodeRequestBody startDate(OffsetDateTime startDate)

getStartDate

@Nullable
public OffsetDateTime getStartDate()

Start date defines when the code starts to be active. Activation timestamp is presented in the ISO 8601 format. Voucher is *inactive before* this date.

Returns:

startDate

setStartDate

public void setStartDate(OffsetDateTime startDate)

expirationDate

public VouchersCreateWithSpecificCodeRequestBody expirationDate(OffsetDateTime expirationDate)

getExpirationDate

@Nullable
public OffsetDateTime getExpirationDate()

Expiration date defines when the code expires. Expiration timestamp is presented in the ISO 8601 format. Voucher is *inactive after* this date.

Returns:

expirationDate

setExpirationDate

public void setExpirationDate(OffsetDateTime expirationDate)

validityTimeframe

public VouchersCreateWithSpecificCodeRequestBody validityTimeframe(ValidityTimeframe validityTimeframe)

getValidityTimeframe

@Nullable
public ValidityTimeframe getValidityTimeframe()

Get validityTimeframe

Returns:

validityTimeframe

setValidityTimeframe

public void setValidityTimeframe(ValidityTimeframe validityTimeframe)

validityDayOfWeek

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

addValidityDayOfWeekItem

public VouchersCreateWithSpecificCodeRequestBody addValidityDayOfWeekItem(VouchersCreateWithSpecificCodeRequestBody.ValidityDayOfWeekEnum validityDayOfWeekItem)

getValidityDayOfWeek

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

validityHours

public VouchersCreateWithSpecificCodeRequestBody validityHours(ValidityHours validityHours)

getValidityHours

@Nullable
public ValidityHours getValidityHours()

Get validityHours

Returns:

validityHours

setValidityHours

public void setValidityHours(ValidityHours validityHours)

active

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

validationRules

public VouchersCreateWithSpecificCodeRequestBody validationRules(List<String> validationRules)

addValidationRulesItem

public VouchersCreateWithSpecificCodeRequestBody addValidationRulesItem(String validationRulesItem)

getValidationRules

@Nullable
public List<String> getValidationRules()

Array containing the ID of the validation rule associated with the voucher.

Returns:

validationRules

setValidationRules

public void setValidationRules(List<String> validationRules)

redemption

public VouchersCreateWithSpecificCodeRequestBody redemption(VouchersCreateWithSpecificCodeRequestBodyRedemption redemption)

getRedemption

@Nullable
public VouchersCreateWithSpecificCodeRequestBodyRedemption getRedemption()

Get redemption

Returns:

redemption

setRedemption

public void setRedemption(VouchersCreateWithSpecificCodeRequestBodyRedemption redemption)

type

public VouchersCreateWithSpecificCodeRequestBody type(VouchersCreateWithSpecificCodeRequestBody.TypeEnum type)

getType

@Nullable
public VouchersCreateWithSpecificCodeRequestBody.TypeEnum getType()

Get type

Returns:

type

setType

public void setType(VouchersCreateWithSpecificCodeRequestBody.TypeEnum type)

loyaltyCard

public VouchersCreateWithSpecificCodeRequestBody loyaltyCard(SimpleLoyaltyCard loyaltyCard)

getLoyaltyCard

@Nullable
public SimpleLoyaltyCard getLoyaltyCard()

Get loyaltyCard

Returns:

loyaltyCard

setLoyaltyCard

public void setLoyaltyCard(SimpleLoyaltyCard loyaltyCard)

gift

public VouchersCreateWithSpecificCodeRequestBody gift(Gift gift)

getGift

@Nullable
public Gift getGift()

Get gift

Returns:

gift

setGift

public void setGift(Gift gift)

discount

public VouchersCreateWithSpecificCodeRequestBody discount(Discount discount)

getDiscount

@Nullable
public Discount getDiscount()

Get discount

Returns:

discount

setDiscount

public void setDiscount(Discount discount)

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

Create an instance of VouchersCreateWithSpecificCodeRequestBody given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of VouchersCreateWithSpecificCodeRequestBody

Throws:

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

toJson

public String toJson()

Convert an instance of VouchersCreateWithSpecificCodeRequestBody to an JSON string

Returns:

JSON string