Package io.voucherify.client.model

Class VouchersCreateRequestBody

java.lang.Object

io.voucherify.client.model.VouchersCreateRequestBody

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

VouchersCreateRequestBody

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VouchersCreateRequestBody.CustomTypeAdapterFactory
static enum	VouchersCreateRequestBody.TypeEnum	Gets or Sets type
static enum	VouchersCreateRequestBody.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_CODE
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_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
VouchersCreateRequestBody()

Method Summary

Modifier and Type	Method	Description
VouchersCreateRequestBody	active(Boolean active)
VouchersCreateRequestBody	additionalInfo(String additionalInfo)
VouchersCreateRequestBody	addValidationRulesItem(String validationRulesItem)
VouchersCreateRequestBody	addValidityDayOfWeekItem(VouchersCreateRequestBody.ValidityDayOfWeekEnum validityDayOfWeekItem)
VouchersCreateRequestBody	campaign(String campaign)
VouchersCreateRequestBody	campaignId(String campaignId)
VouchersCreateRequestBody	category(String category)
VouchersCreateRequestBody	categoryId(String categoryId)
VouchersCreateRequestBody	code(String code)
VouchersCreateRequestBody	codeConfig(CodeConfig codeConfig)
VouchersCreateRequestBody	discount(Discount discount)
boolean	equals(Object o)
VouchersCreateRequestBody	expirationDate(OffsetDateTime expirationDate)
static VouchersCreateRequestBody	fromJson(String jsonString)	Create an instance of VouchersCreateRequestBody 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.
String	getCode()	Code that identifies a voucher.
CodeConfig	getCodeConfig()	Get codeConfig
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.
VouchersCreateRequestBodyRedemption	getRedemption()	Get redemption
OffsetDateTime	getStartDate()	Start date defines when the code starts to be active.
VouchersCreateRequestBody.TypeEnum	getType()	Get type
List<String>	getValidationRules()	Array containing the ID of the validation rule associated with the voucher.
List<VouchersCreateRequestBody.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
VouchersCreateRequestBody	gift(Gift gift)
int	hashCode()
VouchersCreateRequestBody	loyaltyCard(SimpleLoyaltyCard loyaltyCard)
VouchersCreateRequestBody	metadata(Object metadata)
VouchersCreateRequestBody	redemption(VouchersCreateRequestBodyRedemption 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	setCode(String code)
void	setCodeConfig(CodeConfig codeConfig)
void	setDiscount(Discount discount)
void	setExpirationDate(OffsetDateTime expirationDate)
void	setGift(Gift gift)
void	setLoyaltyCard(SimpleLoyaltyCard loyaltyCard)
void	setMetadata(Object metadata)
void	setRedemption(VouchersCreateRequestBodyRedemption redemption)
void	setStartDate(OffsetDateTime startDate)
void	setType(VouchersCreateRequestBody.TypeEnum type)
void	setValidationRules(List<String> validationRules)
void	setValidityDayOfWeek(List<VouchersCreateRequestBody.ValidityDayOfWeekEnum> validityDayOfWeek)
void	setValidityHours(ValidityHours validityHours)
void	setValidityTimeframe(ValidityTimeframe validityTimeframe)
VouchersCreateRequestBody	startDate(OffsetDateTime startDate)
String	toJson()	Convert an instance of VouchersCreateRequestBody to an JSON string
String	toString()
VouchersCreateRequestBody	type(VouchersCreateRequestBody.TypeEnum type)
VouchersCreateRequestBody	validationRules(List<String> validationRules)
VouchersCreateRequestBody	validityDayOfWeek(List<VouchersCreateRequestBody.ValidityDayOfWeekEnum> validityDayOfWeek)
VouchersCreateRequestBody	validityHours(ValidityHours validityHours)
VouchersCreateRequestBody	validityTimeframe(ValidityTimeframe validityTimeframe)

Methods inherited from class java.lang.Object

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

Field Details

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

public static final String SERIALIZED_NAME_CODE_CONFIG

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

VouchersCreateRequestBody

public VouchersCreateRequestBody()

Method Details

code

public VouchersCreateRequestBody code(String code)

getCode

@Nullable
public String getCode()

Code that identifies a voucher. The pattern can use all the letters of the English alphabet, Arabic numerals, and special characters. Pass this attribute in the request body to create a distinct code. Otherwise, either use the `code_config` object to set the rules that the Voucherify API will use to create a random code, or don't pass any code and Voucherify will generate a random code.

Returns:

code

setCode

public void setCode(String code)

campaign

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

getValidityTimeframe

@Nullable
public ValidityTimeframe getValidityTimeframe()

Get validityTimeframe

Returns:

validityTimeframe

setValidityTimeframe

public void setValidityTimeframe(ValidityTimeframe validityTimeframe)

validityDayOfWeek

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

addValidityDayOfWeekItem

public VouchersCreateRequestBody addValidityDayOfWeekItem(VouchersCreateRequestBody.ValidityDayOfWeekEnum validityDayOfWeekItem)

getValidityDayOfWeek

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

validityHours

public VouchersCreateRequestBody validityHours(ValidityHours validityHours)

getValidityHours

@Nullable
public ValidityHours getValidityHours()

Get validityHours

Returns:

validityHours

setValidityHours

public void setValidityHours(ValidityHours validityHours)

active

public VouchersCreateRequestBody 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 VouchersCreateRequestBody 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 VouchersCreateRequestBody 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 VouchersCreateRequestBody validationRules(List<String> validationRules)

addValidationRulesItem

public VouchersCreateRequestBody 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 VouchersCreateRequestBody redemption(VouchersCreateRequestBodyRedemption redemption)

getRedemption

@Nullable
public VouchersCreateRequestBodyRedemption getRedemption()

Get redemption

Returns:

redemption

setRedemption

public void setRedemption(VouchersCreateRequestBodyRedemption redemption)

type

public VouchersCreateRequestBody type(VouchersCreateRequestBody.TypeEnum type)

getType

@Nullable
public VouchersCreateRequestBody.TypeEnum getType()

Get type

Returns:

type

setType

public void setType(VouchersCreateRequestBody.TypeEnum type)

loyaltyCard

public VouchersCreateRequestBody loyaltyCard(SimpleLoyaltyCard loyaltyCard)

getLoyaltyCard

@Nullable
public SimpleLoyaltyCard getLoyaltyCard()

Get loyaltyCard

Returns:

loyaltyCard

setLoyaltyCard

public void setLoyaltyCard(SimpleLoyaltyCard loyaltyCard)

codeConfig

public VouchersCreateRequestBody codeConfig(CodeConfig codeConfig)

getCodeConfig

@Nullable
public CodeConfig getCodeConfig()

Get codeConfig

Returns:

codeConfig

setCodeConfig

public void setCodeConfig(CodeConfig codeConfig)

gift

public VouchersCreateRequestBody gift(Gift gift)

getGift

@Nullable
public Gift getGift()

Get gift

Returns:

gift

setGift

public void setGift(Gift gift)

discount

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

Create an instance of VouchersCreateRequestBody given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of VouchersCreateRequestBody

Throws:

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

toJson

public String toJson()

Convert an instance of VouchersCreateRequestBody to an JSON string

Returns:

JSON string