Package io.voucherify.client.model

Class CampaignsVouchersCreateInBulkRequestBody

java.lang.Object

io.voucherify.client.model.CampaignsVouchersCreateInBulkRequestBody

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

Request body schema for **POST** `v1/campaigns/{campaignId}/vouchers`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CampaignsVouchersCreateInBulkRequestBody.CustomTypeAdapterFactory

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_ADDITIONAL_INFO
static final String	SERIALIZED_NAME_CATEGORY
static final String	SERIALIZED_NAME_CODE
static final String	SERIALIZED_NAME_CODE_CONFIG
static final String	SERIALIZED_NAME_EXPIRATION_DATE
static final String	SERIALIZED_NAME_METADATA
static final String	SERIALIZED_NAME_REDEMPTION
static final String	SERIALIZED_NAME_START_DATE

Constructor Summary

Constructors

Constructor	Description
CampaignsVouchersCreateInBulkRequestBody()

Method Summary

Modifier and Type	Method	Description
CampaignsVouchersCreateInBulkRequestBody	additionalInfo(String additionalInfo)
CampaignsVouchersCreateInBulkRequestBody	category(String category)
CampaignsVouchersCreateInBulkRequestBody	code(String code)
CampaignsVouchersCreateInBulkRequestBody	codeConfig(CodeConfig codeConfig)
boolean	equals(Object o)
CampaignsVouchersCreateInBulkRequestBody	expirationDate(OffsetDateTime expirationDate)
static CampaignsVouchersCreateInBulkRequestBody	fromJson(String jsonString)	Create an instance of CampaignsVouchersCreateInBulkRequestBody given an JSON string
String	getAdditionalInfo()	An optional field to keep any extra textual information about the code such as a code description and details.
String	getCategory()	The category assigned to the campaign.
String	getCode()	Unique voucher code.
CodeConfig	getCodeConfig()	Get codeConfig
OffsetDateTime	getExpirationDate()	Expiration timestamp defines when the voucher expires in ISO 8601 format.
Object	getMetadata()	The metadata object stores all custom attributes assigned to the voucher.
CampaignsVouchersCreateInBulkRequestBodyRedemption	getRedemption()	Get redemption
OffsetDateTime	getStartDate()	Activation timestamp defines when the voucher starts to be active in ISO 8601 format.
int	hashCode()
CampaignsVouchersCreateInBulkRequestBody	metadata(Object metadata)
CampaignsVouchersCreateInBulkRequestBody	redemption(CampaignsVouchersCreateInBulkRequestBodyRedemption redemption)
void	setAdditionalInfo(String additionalInfo)
void	setCategory(String category)
void	setCode(String code)
void	setCodeConfig(CodeConfig codeConfig)
void	setExpirationDate(OffsetDateTime expirationDate)
void	setMetadata(Object metadata)
void	setRedemption(CampaignsVouchersCreateInBulkRequestBodyRedemption redemption)
void	setStartDate(OffsetDateTime startDate)
CampaignsVouchersCreateInBulkRequestBody	startDate(OffsetDateTime startDate)
String	toJson()	Convert an instance of CampaignsVouchersCreateInBulkRequestBody to an JSON string
String	toString()

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_CODE_CONFIG

public static final String SERIALIZED_NAME_CODE_CONFIG

See Also:

• Constant Field Values

SERIALIZED_NAME_CATEGORY

public static final String SERIALIZED_NAME_CATEGORY

See Also:

• Constant Field Values

SERIALIZED_NAME_METADATA

public static final String SERIALIZED_NAME_METADATA

See Also:

• Constant Field Values

SERIALIZED_NAME_REDEMPTION

public static final String SERIALIZED_NAME_REDEMPTION

See Also:

• Constant Field Values

SERIALIZED_NAME_ADDITIONAL_INFO

public static final String SERIALIZED_NAME_ADDITIONAL_INFO

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

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

CampaignsVouchersCreateInBulkRequestBody

public CampaignsVouchersCreateInBulkRequestBody()

Method Details

code

public CampaignsVouchersCreateInBulkRequestBody code(String code)

getCode

@Nullable
public String getCode()

Unique voucher code.

Returns:

code

setCode

public void setCode(String code)

codeConfig

public CampaignsVouchersCreateInBulkRequestBody codeConfig(CodeConfig codeConfig)

getCodeConfig

@Nullable
public CodeConfig getCodeConfig()

Get codeConfig

Returns:

codeConfig

setCodeConfig

public void setCodeConfig(CodeConfig codeConfig)

category

public CampaignsVouchersCreateInBulkRequestBody category(String category)

getCategory

@Nullable
public String getCategory()

The category assigned to the campaign. Either pass this parameter OR the `category_id`.

Returns:

category

setCategory

public void setCategory(String category)

metadata

public CampaignsVouchersCreateInBulkRequestBody metadata(Object metadata)

getMetadata

@Nullable
public Object getMetadata()

The metadata object stores all custom attributes assigned to the voucher. 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)

redemption

public CampaignsVouchersCreateInBulkRequestBody redemption(CampaignsVouchersCreateInBulkRequestBodyRedemption redemption)

getRedemption

@Nullable
public CampaignsVouchersCreateInBulkRequestBodyRedemption getRedemption()

Get redemption

Returns:

redemption

setRedemption

public void setRedemption(CampaignsVouchersCreateInBulkRequestBodyRedemption redemption)

additionalInfo

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

startDate

public CampaignsVouchersCreateInBulkRequestBody startDate(OffsetDateTime startDate)

getStartDate

@Nullable
public OffsetDateTime getStartDate()

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

Returns:

startDate

setStartDate

public void setStartDate(OffsetDateTime startDate)

expirationDate

public CampaignsVouchersCreateInBulkRequestBody expirationDate(OffsetDateTime expirationDate)

getExpirationDate

@Nullable
public OffsetDateTime getExpirationDate()

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

Returns:

expirationDate

setExpirationDate

public void setExpirationDate(OffsetDateTime expirationDate)

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

Create an instance of CampaignsVouchersCreateInBulkRequestBody given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of CampaignsVouchersCreateInBulkRequestBody

Throws:

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

toJson

public String toJson()

Convert an instance of CampaignsVouchersCreateInBulkRequestBody to an JSON string

Returns:

JSON string