Package io.voucherify.client.model

Class CampaignsImportVoucherItem

java.lang.Object

io.voucherify.client.model.CampaignsImportVoucherItem

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

CampaignsImportVoucherItem

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CampaignsImportVoucherItem.CustomTypeAdapterFactory
static enum	CampaignsImportVoucherItem.TypeEnum	Gets or Sets type
static enum	CampaignsImportVoucherItem.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_CATEGORY
static final String	SERIALIZED_NAME_CODE
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_VALIDITY_DAY_OF_WEEK
static final String	SERIALIZED_NAME_VALIDITY_TIMEFRAME

Constructor Summary

Constructors

Constructor	Description
CampaignsImportVoucherItem()

Method Summary

Modifier and Type	Method	Description
CampaignsImportVoucherItem	active(Boolean active)
CampaignsImportVoucherItem	additionalInfo(String additionalInfo)
CampaignsImportVoucherItem	addValidityDayOfWeekItem(CampaignsImportVoucherItem.ValidityDayOfWeekEnum validityDayOfWeekItem)
CampaignsImportVoucherItem	category(String category)
CampaignsImportVoucherItem	code(String code)
CampaignsImportVoucherItem	discount(Discount discount)
boolean	equals(Object o)
CampaignsImportVoucherItem	expirationDate(OffsetDateTime expirationDate)
static CampaignsImportVoucherItem	fromJson(String jsonString)	Create an instance of CampaignsImportVoucherItem 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	getCategory()	Tag defining the category that this voucher belongs to.
String	getCode()	Value representing the imported code.
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.
CampaignsImportVoucherItemRedemption	getRedemption()	Get redemption
OffsetDateTime	getStartDate()	Activation timestamp presented in the ISO 8601 format.
CampaignsImportVoucherItem.TypeEnum	getType()	Get type
List<CampaignsImportVoucherItem.ValidityDayOfWeekEnum>	getValidityDayOfWeek()	Integer array corresponding to the particular days of the week in which the voucher is valid.
ValidityTimeframe	getValidityTimeframe()	Get validityTimeframe
CampaignsImportVoucherItem	gift(Gift gift)
int	hashCode()
CampaignsImportVoucherItem	loyaltyCard(SimpleLoyaltyCard loyaltyCard)
CampaignsImportVoucherItem	metadata(Object metadata)
CampaignsImportVoucherItem	redemption(CampaignsImportVoucherItemRedemption redemption)
void	setActive(Boolean active)
void	setAdditionalInfo(String additionalInfo)
void	setCategory(String category)
void	setCode(String code)
void	setDiscount(Discount discount)
void	setExpirationDate(OffsetDateTime expirationDate)
void	setGift(Gift gift)
void	setLoyaltyCard(SimpleLoyaltyCard loyaltyCard)
void	setMetadata(Object metadata)
void	setRedemption(CampaignsImportVoucherItemRedemption redemption)
void	setStartDate(OffsetDateTime startDate)
void	setType(CampaignsImportVoucherItem.TypeEnum type)
void	setValidityDayOfWeek(List<CampaignsImportVoucherItem.ValidityDayOfWeekEnum> validityDayOfWeek)
void	setValidityTimeframe(ValidityTimeframe validityTimeframe)
CampaignsImportVoucherItem	startDate(OffsetDateTime startDate)
String	toJson()	Convert an instance of CampaignsImportVoucherItem to an JSON string
String	toString()
CampaignsImportVoucherItem	type(CampaignsImportVoucherItem.TypeEnum type)
CampaignsImportVoucherItem	validityDayOfWeek(List<CampaignsImportVoucherItem.ValidityDayOfWeekEnum> validityDayOfWeek)
CampaignsImportVoucherItem	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_REDEMPTION

public static final String SERIALIZED_NAME_REDEMPTION

See Also:

• Constant Field Values

SERIALIZED_NAME_ACTIVE

public static final String SERIALIZED_NAME_ACTIVE

See Also:

• Constant Field Values

SERIALIZED_NAME_METADATA

public static final String SERIALIZED_NAME_METADATA

See Also:

• Constant Field Values

SERIALIZED_NAME_CATEGORY

public static final String SERIALIZED_NAME_CATEGORY

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_ADDITIONAL_INFO

public static final String SERIALIZED_NAME_ADDITIONAL_INFO

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

CampaignsImportVoucherItem

public CampaignsImportVoucherItem()

Method Details

code

public CampaignsImportVoucherItem code(String code)

getCode

@Nullable
public String getCode()

Value representing the imported code.

Returns:

code

setCode

public void setCode(String code)

redemption

public CampaignsImportVoucherItem redemption(CampaignsImportVoucherItemRedemption redemption)

getRedemption

@Nullable
public CampaignsImportVoucherItemRedemption getRedemption()

Get redemption

Returns:

redemption

setRedemption

public void setRedemption(CampaignsImportVoucherItemRedemption redemption)

active

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

metadata

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

category

public CampaignsImportVoucherItem 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](ref:list-vouchers) endpoint.

Returns:

category

setCategory

public void setCategory(String category)

startDate

public CampaignsImportVoucherItem startDate(OffsetDateTime startDate)

getStartDate

@Nullable
public OffsetDateTime getStartDate()

Activation timestamp presented in the ISO 8601 format. Voucher is *inactive before* this date. Start date defines when the code starts to be active. Allowed date formats are: - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ

Returns:

startDate

setStartDate

public void setStartDate(OffsetDateTime startDate)

expirationDate

public CampaignsImportVoucherItem 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. Allowed date formats are: - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ

Returns:

expirationDate

setExpirationDate

public void setExpirationDate(OffsetDateTime expirationDate)

validityTimeframe

public CampaignsImportVoucherItem validityTimeframe(ValidityTimeframe validityTimeframe)

getValidityTimeframe

@Nullable
public ValidityTimeframe getValidityTimeframe()

Get validityTimeframe

Returns:

validityTimeframe

setValidityTimeframe

public void setValidityTimeframe(ValidityTimeframe validityTimeframe)

validityDayOfWeek

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

addValidityDayOfWeekItem

public CampaignsImportVoucherItem addValidityDayOfWeekItem(CampaignsImportVoucherItem.ValidityDayOfWeekEnum validityDayOfWeekItem)

getValidityDayOfWeek

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

additionalInfo

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

type

public CampaignsImportVoucherItem type(CampaignsImportVoucherItem.TypeEnum type)

getType

@Nullable
public CampaignsImportVoucherItem.TypeEnum getType()

Get type

Returns:

type

setType

public void setType(CampaignsImportVoucherItem.TypeEnum type)

loyaltyCard

public CampaignsImportVoucherItem loyaltyCard(SimpleLoyaltyCard loyaltyCard)

getLoyaltyCard

@Nullable
public SimpleLoyaltyCard getLoyaltyCard()

Get loyaltyCard

Returns:

loyaltyCard

setLoyaltyCard

public void setLoyaltyCard(SimpleLoyaltyCard loyaltyCard)

gift

public CampaignsImportVoucherItem gift(Gift gift)

getGift

@Nullable
public Gift getGift()

Get gift

Returns:

gift

setGift

public void setGift(Gift gift)

discount

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

Create an instance of CampaignsImportVoucherItem given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of CampaignsImportVoucherItem

Throws:

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

toJson

public String toJson()

Convert an instance of CampaignsImportVoucherItem to an JSON string

Returns:

JSON string