Package io.voucherify.client.model

Class TemplatesCampaignsCampaignSetupCreateRequestBody

java.lang.Object

io.voucherify.client.model.TemplatesCampaignsCampaignSetupCreateRequestBody

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

Request body schema for **POST** `/v1/templates/campaigns/{campaignTemplateId}/campaign-setup`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TemplatesCampaignsCampaignSetupCreateRequestBody.CustomTypeAdapterFactory
static enum	TemplatesCampaignsCampaignSetupCreateRequestBody.TypeEnum	Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers.
static enum	TemplatesCampaignsCampaignSetupCreateRequestBody.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_ACTIVITY_DURATION_AFTER_PUBLISHING
static final String	SERIALIZED_NAME_AUTO_JOIN
static final String	SERIALIZED_NAME_CATEGORY
static final String	SERIALIZED_NAME_CATEGORY_ID
static final String	SERIALIZED_NAME_DESCRIPTION
static final String	SERIALIZED_NAME_EXPIRATION_DATE
static final String	SERIALIZED_NAME_JOIN_ONCE
static final String	SERIALIZED_NAME_METADATA
static final String	SERIALIZED_NAME_NAME
static final String	SERIALIZED_NAME_START_DATE
static final String	SERIALIZED_NAME_TYPE
static final String	SERIALIZED_NAME_USE_VOUCHER_METADATA_SCHEMA
static final String	SERIALIZED_NAME_VALIDITY_DAY_OF_WEEK
static final String	SERIALIZED_NAME_VALIDITY_HOURS
static final String	SERIALIZED_NAME_VALIDITY_TIMEFRAME
static final String	SERIALIZED_NAME_VOUCHER
static final String	SERIALIZED_NAME_VOUCHERS_COUNT

Constructor Summary

Constructors

Constructor	Description
TemplatesCampaignsCampaignSetupCreateRequestBody()

Method Summary

Modifier and Type	Method	Description
TemplatesCampaignsCampaignSetupCreateRequestBody	activityDurationAfterPublishing(String activityDurationAfterPublishing)
TemplatesCampaignsCampaignSetupCreateRequestBody	addValidityDayOfWeekItem(TemplatesCampaignsCampaignSetupCreateRequestBody.ValidityDayOfWeekEnum validityDayOfWeekItem)
TemplatesCampaignsCampaignSetupCreateRequestBody	autoJoin(Boolean autoJoin)
TemplatesCampaignsCampaignSetupCreateRequestBody	category(String category)
TemplatesCampaignsCampaignSetupCreateRequestBody	categoryId(String categoryId)
TemplatesCampaignsCampaignSetupCreateRequestBody	description(String description)
boolean	equals(Object o)
TemplatesCampaignsCampaignSetupCreateRequestBody	expirationDate(OffsetDateTime expirationDate)
static TemplatesCampaignsCampaignSetupCreateRequestBody	fromJson(String jsonString)	Create an instance of TemplatesCampaignsCampaignSetupCreateRequestBody given an JSON string
String	getActivityDurationAfterPublishing()	Defines the amount of time the vouchers will be active after publishing.
Boolean	getAutoJoin()	Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled.
String	getCategory()	The category assigned to the campaign.
String	getCategoryId()	Unique category ID that this campaign belongs to.
String	getDescription()	An optional field to keep any extra textual information about the campaign such as a campaign description and details.
OffsetDateTime	getExpirationDate()	Expiration timestamp defines when the campaign expires in ISO 8601 format.
Boolean	getJoinOnce()	If this value is set to `true`, customers will be able to join the campaign only once.
Object	getMetadata()	The metadata object stores all custom attributes assigned to the campaign.
String	getName()	Campaign name.
OffsetDateTime	getStartDate()	Activation timestamp defines when the campaign starts to be active in ISO 8601 format.
TemplatesCampaignsCampaignSetupCreateRequestBody.TypeEnum	getType()	Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers.
Boolean	getUseVoucherMetadataSchema()	Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema.
List<TemplatesCampaignsCampaignSetupCreateRequestBody.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
TemplatesCampaignsCampaignSetupCreateRequestBodyVoucher	getVoucher()	Get voucher
Integer	getVouchersCount()	Total number of unique vouchers in campaign (size of campaign).
int	hashCode()
TemplatesCampaignsCampaignSetupCreateRequestBody	joinOnce(Boolean joinOnce)
TemplatesCampaignsCampaignSetupCreateRequestBody	metadata(Object metadata)
TemplatesCampaignsCampaignSetupCreateRequestBody	name(String name)
void	setActivityDurationAfterPublishing(String activityDurationAfterPublishing)
void	setAutoJoin(Boolean autoJoin)
void	setCategory(String category)
void	setCategoryId(String categoryId)
void	setDescription(String description)
void	setExpirationDate(OffsetDateTime expirationDate)
void	setJoinOnce(Boolean joinOnce)
void	setMetadata(Object metadata)
void	setName(String name)
void	setStartDate(OffsetDateTime startDate)
void	setType(TemplatesCampaignsCampaignSetupCreateRequestBody.TypeEnum type)
void	setUseVoucherMetadataSchema(Boolean useVoucherMetadataSchema)
void	setValidityDayOfWeek(List<TemplatesCampaignsCampaignSetupCreateRequestBody.ValidityDayOfWeekEnum> validityDayOfWeek)
void	setValidityHours(ValidityHours validityHours)
void	setValidityTimeframe(ValidityTimeframe validityTimeframe)
void	setVoucher(TemplatesCampaignsCampaignSetupCreateRequestBodyVoucher voucher)
void	setVouchersCount(Integer vouchersCount)
TemplatesCampaignsCampaignSetupCreateRequestBody	startDate(OffsetDateTime startDate)
String	toJson()	Convert an instance of TemplatesCampaignsCampaignSetupCreateRequestBody to an JSON string
String	toString()
TemplatesCampaignsCampaignSetupCreateRequestBody	type(TemplatesCampaignsCampaignSetupCreateRequestBody.TypeEnum type)
TemplatesCampaignsCampaignSetupCreateRequestBody	useVoucherMetadataSchema(Boolean useVoucherMetadataSchema)
TemplatesCampaignsCampaignSetupCreateRequestBody	validityDayOfWeek(List<TemplatesCampaignsCampaignSetupCreateRequestBody.ValidityDayOfWeekEnum> validityDayOfWeek)
TemplatesCampaignsCampaignSetupCreateRequestBody	validityHours(ValidityHours validityHours)
TemplatesCampaignsCampaignSetupCreateRequestBody	validityTimeframe(ValidityTimeframe validityTimeframe)
TemplatesCampaignsCampaignSetupCreateRequestBody	voucher(TemplatesCampaignsCampaignSetupCreateRequestBodyVoucher voucher)
TemplatesCampaignsCampaignSetupCreateRequestBody	vouchersCount(Integer vouchersCount)

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZED_NAME_NAME

public static final String SERIALIZED_NAME_NAME

See Also:

• Constant Field Values

SERIALIZED_NAME_DESCRIPTION

public static final String SERIALIZED_NAME_DESCRIPTION

See Also:

• Constant Field Values

SERIALIZED_NAME_TYPE

public static final String SERIALIZED_NAME_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_JOIN_ONCE

public static final String SERIALIZED_NAME_JOIN_ONCE

See Also:

• Constant Field Values

SERIALIZED_NAME_AUTO_JOIN

public static final String SERIALIZED_NAME_AUTO_JOIN

See Also:

• Constant Field Values

SERIALIZED_NAME_USE_VOUCHER_METADATA_SCHEMA

public static final String SERIALIZED_NAME_USE_VOUCHER_METADATA_SCHEMA

See Also:

• Constant Field Values

SERIALIZED_NAME_VOUCHERS_COUNT

public static final String SERIALIZED_NAME_VOUCHERS_COUNT

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_ACTIVITY_DURATION_AFTER_PUBLISHING

public static final String SERIALIZED_NAME_ACTIVITY_DURATION_AFTER_PUBLISHING

See Also:

• Constant Field Values

SERIALIZED_NAME_CATEGORY_ID

public static final String SERIALIZED_NAME_CATEGORY_ID

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_VOUCHER

public static final String SERIALIZED_NAME_VOUCHER

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

TemplatesCampaignsCampaignSetupCreateRequestBody

public TemplatesCampaignsCampaignSetupCreateRequestBody()

Method Details

name

public TemplatesCampaignsCampaignSetupCreateRequestBody name(String name)

getName

@Nullable
public String getName()

Campaign name.

Returns:

name

setName

public void setName(String name)

description

public TemplatesCampaignsCampaignSetupCreateRequestBody description(String description)

getDescription

@Nullable
public String getDescription()

An optional field to keep any extra textual information about the campaign such as a campaign description and details.

Returns:

description

setDescription

public void setDescription(String description)

type

public TemplatesCampaignsCampaignSetupCreateRequestBody type(TemplatesCampaignsCampaignSetupCreateRequestBody.TypeEnum type)

getType

@Nullable
public TemplatesCampaignsCampaignSetupCreateRequestBody.TypeEnum getType()

Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers. - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria - `STATIC`: vouchers need to be manually published

Returns:

type

setType

public void setType(TemplatesCampaignsCampaignSetupCreateRequestBody.TypeEnum type)

joinOnce

public TemplatesCampaignsCampaignSetupCreateRequestBody joinOnce(Boolean joinOnce)

getJoinOnce

@Nullable
public Boolean getJoinOnce()

If this value is set to `true`, customers will be able to join the campaign only once.

Returns:

joinOnce

setJoinOnce

public void setJoinOnce(Boolean joinOnce)

autoJoin

public TemplatesCampaignsCampaignSetupCreateRequestBody autoJoin(Boolean autoJoin)

getAutoJoin

@Nullable
public Boolean getAutoJoin()

Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled.

Returns:

autoJoin

setAutoJoin

public void setAutoJoin(Boolean autoJoin)

useVoucherMetadataSchema

public TemplatesCampaignsCampaignSetupCreateRequestBody useVoucherMetadataSchema(Boolean useVoucherMetadataSchema)

getUseVoucherMetadataSchema

@Nullable
public Boolean getUseVoucherMetadataSchema()

Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema.

Returns:

useVoucherMetadataSchema

setUseVoucherMetadataSchema

public void setUseVoucherMetadataSchema(Boolean useVoucherMetadataSchema)

vouchersCount

public TemplatesCampaignsCampaignSetupCreateRequestBody vouchersCount(Integer vouchersCount)

getVouchersCount

@Nullable
public Integer getVouchersCount()

Total number of unique vouchers in campaign (size of campaign).

Returns:

vouchersCount

setVouchersCount

public void setVouchersCount(Integer vouchersCount)

startDate

public TemplatesCampaignsCampaignSetupCreateRequestBody startDate(OffsetDateTime startDate)

getStartDate

@Nullable
public OffsetDateTime getStartDate()

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

Returns:

startDate

setStartDate

public void setStartDate(OffsetDateTime startDate)

expirationDate

public TemplatesCampaignsCampaignSetupCreateRequestBody expirationDate(OffsetDateTime expirationDate)

getExpirationDate

@Nullable
public OffsetDateTime getExpirationDate()

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

Returns:

expirationDate

setExpirationDate

public void setExpirationDate(OffsetDateTime expirationDate)

validityTimeframe

public TemplatesCampaignsCampaignSetupCreateRequestBody validityTimeframe(ValidityTimeframe validityTimeframe)

getValidityTimeframe

@Nullable
public ValidityTimeframe getValidityTimeframe()

Get validityTimeframe

Returns:

validityTimeframe

setValidityTimeframe

public void setValidityTimeframe(ValidityTimeframe validityTimeframe)

validityDayOfWeek

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

addValidityDayOfWeekItem

public TemplatesCampaignsCampaignSetupCreateRequestBody addValidityDayOfWeekItem(TemplatesCampaignsCampaignSetupCreateRequestBody.ValidityDayOfWeekEnum validityDayOfWeekItem)

getValidityDayOfWeek

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

validityHours

public TemplatesCampaignsCampaignSetupCreateRequestBody validityHours(ValidityHours validityHours)

getValidityHours

@Nullable
public ValidityHours getValidityHours()

Get validityHours

Returns:

validityHours

setValidityHours

public void setValidityHours(ValidityHours validityHours)

activityDurationAfterPublishing

public TemplatesCampaignsCampaignSetupCreateRequestBody activityDurationAfterPublishing(String activityDurationAfterPublishing)

getActivityDurationAfterPublishing

@Nullable
public String getActivityDurationAfterPublishing()

Defines the amount of time the vouchers will be active after publishing. The value is shown in the ISO 8601 format. For example, a voucher with the value of P24D will be valid for a duration of 24 days.

Returns:

activityDurationAfterPublishing

setActivityDurationAfterPublishing

public void setActivityDurationAfterPublishing(String activityDurationAfterPublishing)

categoryId

public TemplatesCampaignsCampaignSetupCreateRequestBody categoryId(String categoryId)

getCategoryId

@Nullable
public String getCategoryId()

Unique category ID that this campaign belongs to. Either pass this parameter OR the `category`.

Returns:

categoryId

setCategoryId

public void setCategoryId(String categoryId)

category

public TemplatesCampaignsCampaignSetupCreateRequestBody 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 TemplatesCampaignsCampaignSetupCreateRequestBody metadata(Object metadata)

getMetadata

@Nullable
public Object getMetadata()

The metadata object stores all custom attributes assigned to the campaign. A set of key/value pairs that you can attach to a campaign object. It can be useful for storing additional information about the campaign in a structured format.

Returns:

metadata

setMetadata

public void setMetadata(Object metadata)

voucher

public TemplatesCampaignsCampaignSetupCreateRequestBody voucher(TemplatesCampaignsCampaignSetupCreateRequestBodyVoucher voucher)

getVoucher

@Nullable
public TemplatesCampaignsCampaignSetupCreateRequestBodyVoucher getVoucher()

Get voucher

Returns:

voucher

setVoucher

public void setVoucher(TemplatesCampaignsCampaignSetupCreateRequestBodyVoucher voucher)

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

Create an instance of TemplatesCampaignsCampaignSetupCreateRequestBody given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of TemplatesCampaignsCampaignSetupCreateRequestBody

Throws:

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

toJson

public String toJson()

Convert an instance of TemplatesCampaignsCampaignSetupCreateRequestBody to an JSON string

Returns:

JSON string