Package io.voucherify.client.model

Class VouchersImportCreateItemRequestBody

java.lang.Object

io.voucherify.client.model.VouchersImportCreateItemRequestBody

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

VouchersImportCreateItemRequestBody

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
VouchersImportCreateItemRequestBody	active(Boolean active)
VouchersImportCreateItemRequestBody	additionalInfo(String additionalInfo)
VouchersImportCreateItemRequestBody	addValidityDayOfWeekItem(VouchersImportCreateItemRequestBody.ValidityDayOfWeekEnum validityDayOfWeekItem)
VouchersImportCreateItemRequestBody	category(String category)
VouchersImportCreateItemRequestBody	code(String code)
VouchersImportCreateItemRequestBody	discount(Discount discount)
boolean	equals(Object o)
VouchersImportCreateItemRequestBody	expirationDate(OffsetDateTime expirationDate)
static VouchersImportCreateItemRequestBody	fromJson(String jsonString)	Create an instance of VouchersImportCreateItemRequestBody 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
Object	getMetadata()	The metadata object stores all custom attributes assigned to the code.
VouchersImportCreateItemRequestBodyRedemption	getRedemption()	Get redemption
OffsetDateTime	getStartDate()	Activation timestamp presented in the ISO 8601 format.
VouchersImportCreateItemRequestBody.TypeEnum	getType()	Get type
List<VouchersImportCreateItemRequestBody.ValidityDayOfWeekEnum>	getValidityDayOfWeek()	Integer array corresponding to the particular days of the week in which the voucher is valid.
ValidityTimeframe	getValidityTimeframe()	Get validityTimeframe
VouchersImportCreateItemRequestBody	gift(Gift gift)
int	hashCode()
VouchersImportCreateItemRequestBody	metadata(Object metadata)
VouchersImportCreateItemRequestBody	redemption(VouchersImportCreateItemRequestBodyRedemption 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	setMetadata(Object metadata)
void	setRedemption(VouchersImportCreateItemRequestBodyRedemption redemption)
void	setStartDate(OffsetDateTime startDate)
void	setType(VouchersImportCreateItemRequestBody.TypeEnum type)
void	setValidityDayOfWeek(List<VouchersImportCreateItemRequestBody.ValidityDayOfWeekEnum> validityDayOfWeek)
void	setValidityTimeframe(ValidityTimeframe validityTimeframe)
VouchersImportCreateItemRequestBody	startDate(OffsetDateTime startDate)
String	toJson()	Convert an instance of VouchersImportCreateItemRequestBody to an JSON string
String	toString()
VouchersImportCreateItemRequestBody	type(VouchersImportCreateItemRequestBody.TypeEnum type)
VouchersImportCreateItemRequestBody	validityDayOfWeek(List<VouchersImportCreateItemRequestBody.ValidityDayOfWeekEnum> validityDayOfWeek)
VouchersImportCreateItemRequestBody	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_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

VouchersImportCreateItemRequestBody

public VouchersImportCreateItemRequestBody()

Method Details

code

public VouchersImportCreateItemRequestBody code(String code)

getCode

@Nullable
public String getCode()

Value representing the imported code.

Returns:

code

setCode

public void setCode(String code)

redemption

public VouchersImportCreateItemRequestBody redemption(VouchersImportCreateItemRequestBodyRedemption redemption)

getRedemption

@Nullable
public VouchersImportCreateItemRequestBodyRedemption getRedemption()

Get redemption

Returns:

redemption

setRedemption

public void setRedemption(VouchersImportCreateItemRequestBodyRedemption redemption)

active

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

getValidityTimeframe

@Nullable
public ValidityTimeframe getValidityTimeframe()

Get validityTimeframe

Returns:

validityTimeframe

setValidityTimeframe

public void setValidityTimeframe(ValidityTimeframe validityTimeframe)

validityDayOfWeek

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

addValidityDayOfWeekItem

public VouchersImportCreateItemRequestBody addValidityDayOfWeekItem(VouchersImportCreateItemRequestBody.ValidityDayOfWeekEnum validityDayOfWeekItem)

getValidityDayOfWeek

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

additionalInfo

public VouchersImportCreateItemRequestBody 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 VouchersImportCreateItemRequestBody type(VouchersImportCreateItemRequestBody.TypeEnum type)

getType

@Nullable
public VouchersImportCreateItemRequestBody.TypeEnum getType()

Get type

Returns:

type

setType

public void setType(VouchersImportCreateItemRequestBody.TypeEnum type)

gift

public VouchersImportCreateItemRequestBody gift(Gift gift)

getGift

@Nullable
public Gift getGift()

Get gift

Returns:

gift

setGift

public void setGift(Gift gift)

discount

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

Create an instance of VouchersImportCreateItemRequestBody given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of VouchersImportCreateItemRequestBody

Throws:

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

toJson

public String toJson()

Convert an instance of VouchersImportCreateItemRequestBody to an JSON string

Returns:

JSON string