Package io.voucherify.client.model

Class TemplatesCampaignsTierSetupCreateRequestBody

java.lang.Object

io.voucherify.client.model.TemplatesCampaignsTierSetupCreateRequestBody

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TemplatesCampaignsTierSetupCreateRequestBody.CustomTypeAdapterFactory
static enum	TemplatesCampaignsTierSetupCreateRequestBody.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_BANNER
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_EXPIRATION_DATE
static final String	SERIALIZED_NAME_HIERARCHY
static final String	SERIALIZED_NAME_METADATA
static final String	SERIALIZED_NAME_NAME
static final String	SERIALIZED_NAME_START_DATE
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
TemplatesCampaignsTierSetupCreateRequestBody()

Method Summary

Modifier and Type	Method	Description
TemplatesCampaignsTierSetupCreateRequestBody	active(Boolean active)
TemplatesCampaignsTierSetupCreateRequestBody	addValidityDayOfWeekItem(TemplatesCampaignsTierSetupCreateRequestBody.ValidityDayOfWeekEnum validityDayOfWeekItem)
TemplatesCampaignsTierSetupCreateRequestBody	banner(String banner)
TemplatesCampaignsTierSetupCreateRequestBody	campaignId(String campaignId)
TemplatesCampaignsTierSetupCreateRequestBody	category(String category)
TemplatesCampaignsTierSetupCreateRequestBody	categoryId(String categoryId)
boolean	equals(Object o)
TemplatesCampaignsTierSetupCreateRequestBody	expirationDate(OffsetDateTime expirationDate)
static TemplatesCampaignsTierSetupCreateRequestBody	fromJson(String jsonString)	Create an instance of TemplatesCampaignsTierSetupCreateRequestBody given an JSON string
Boolean	getActive()	A flag to toggle the promotion tier on or off.
String	getBanner()	Text to be displayed to your customers on your website.
String	getCampaignId()	Unique campaign identifier, assigned by Voucherify.
String	getCategory()	Assign a new or update the promotion tier's category using name.
String	getCategoryId()	Assign a new or update the promotion tier's category using id
OffsetDateTime	getExpirationDate()	Activation timestamp defines when the promotion tier expires in ISO 8601 format.
Integer	getHierarchy()	The promotions hierarchy defines the order in which the discounts from different tiers will be applied to a customer's order.
Object	getMetadata()	The metadata object stores all custom attributes assigned to the promotion tier.
String	getName()	Name of the promotion tier.
OffsetDateTime	getStartDate()	Activation timestamp defines when the promotion tier starts to be active in ISO 8601 format.
List<TemplatesCampaignsTierSetupCreateRequestBody.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
int	hashCode()
TemplatesCampaignsTierSetupCreateRequestBody	hierarchy(Integer hierarchy)
TemplatesCampaignsTierSetupCreateRequestBody	metadata(Object metadata)
TemplatesCampaignsTierSetupCreateRequestBody	name(String name)
void	setActive(Boolean active)
void	setBanner(String banner)
void	setCampaignId(String campaignId)
void	setCategory(String category)
void	setCategoryId(String categoryId)
void	setExpirationDate(OffsetDateTime expirationDate)
void	setHierarchy(Integer hierarchy)
void	setMetadata(Object metadata)
void	setName(String name)
void	setStartDate(OffsetDateTime startDate)
void	setValidityDayOfWeek(List<TemplatesCampaignsTierSetupCreateRequestBody.ValidityDayOfWeekEnum> validityDayOfWeek)
void	setValidityHours(ValidityHours validityHours)
void	setValidityTimeframe(ValidityTimeframe validityTimeframe)
TemplatesCampaignsTierSetupCreateRequestBody	startDate(OffsetDateTime startDate)
String	toJson()	Convert an instance of TemplatesCampaignsTierSetupCreateRequestBody to an JSON string
String	toString()
TemplatesCampaignsTierSetupCreateRequestBody	validityDayOfWeek(List<TemplatesCampaignsTierSetupCreateRequestBody.ValidityDayOfWeekEnum> validityDayOfWeek)
TemplatesCampaignsTierSetupCreateRequestBody	validityHours(ValidityHours validityHours)
TemplatesCampaignsTierSetupCreateRequestBody	validityTimeframe(ValidityTimeframe validityTimeframe)

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZED_NAME_CAMPAIGN_ID

public static final String SERIALIZED_NAME_CAMPAIGN_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_NAME

public static final String SERIALIZED_NAME_NAME

See Also:

• Constant Field Values

SERIALIZED_NAME_BANNER

public static final String SERIALIZED_NAME_BANNER

See Also:

• Constant Field Values

SERIALIZED_NAME_METADATA

public static final String SERIALIZED_NAME_METADATA

See Also:

• Constant Field Values

SERIALIZED_NAME_HIERARCHY

public static final String SERIALIZED_NAME_HIERARCHY

See Also:

• Constant Field Values

SERIALIZED_NAME_ACTIVE

public static final String SERIALIZED_NAME_ACTIVE

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

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

TemplatesCampaignsTierSetupCreateRequestBody

public TemplatesCampaignsTierSetupCreateRequestBody()

Method Details

campaignId

public TemplatesCampaignsTierSetupCreateRequestBody campaignId(String campaignId)

getCampaignId

@Nullable
public String getCampaignId()

Unique campaign identifier, assigned by Voucherify. Defines the promotion campaign to which the promotion tier will be added.

Returns:

campaignId

setCampaignId

public void setCampaignId(String campaignId)

name

public TemplatesCampaignsTierSetupCreateRequestBody name(String name)

getName

@Nullable
public String getName()

Name of the promotion tier.

Returns:

name

setName

public void setName(String name)

banner

public TemplatesCampaignsTierSetupCreateRequestBody banner(String banner)

getBanner

@Nullable
public String getBanner()

Text to be displayed to your customers on your website.

Returns:

banner

setBanner

public void setBanner(String banner)

metadata

public TemplatesCampaignsTierSetupCreateRequestBody metadata(Object metadata)

getMetadata

@Nullable
public Object getMetadata()

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

Returns:

metadata

setMetadata

public void setMetadata(Object metadata)

hierarchy

public TemplatesCampaignsTierSetupCreateRequestBody hierarchy(Integer hierarchy)

getHierarchy

@Nullable
public Integer getHierarchy()

The promotions hierarchy defines the order in which the discounts from different tiers will be applied to a customer's order. If a customer qualifies for discounts from more than one tier, discounts will be applied in the order defined in the hierarchy.

Returns:

hierarchy

setHierarchy

public void setHierarchy(Integer hierarchy)

active

public TemplatesCampaignsTierSetupCreateRequestBody active(Boolean active)

getActive

@Nullable
public Boolean getActive()

A flag to toggle the promotion tier on or off. You can disable a promotion tier even though it's within the active period defined by the `start_date` and `expiration_date`. - `true` indicates an *active* promotion tier - `false` indicates an *inactive* promotion tier

Returns:

active

setActive

public void setActive(Boolean active)

startDate

public TemplatesCampaignsTierSetupCreateRequestBody startDate(OffsetDateTime startDate)

getStartDate

@Nullable
public OffsetDateTime getStartDate()

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

Returns:

startDate

setStartDate

public void setStartDate(OffsetDateTime startDate)

expirationDate

public TemplatesCampaignsTierSetupCreateRequestBody expirationDate(OffsetDateTime expirationDate)

getExpirationDate

@Nullable
public OffsetDateTime getExpirationDate()

Activation timestamp defines when the promotion tier expires in ISO 8601 format. Promotion tier is *inactive after* this date.

Returns:

expirationDate

setExpirationDate

public void setExpirationDate(OffsetDateTime expirationDate)

validityTimeframe

public TemplatesCampaignsTierSetupCreateRequestBody validityTimeframe(ValidityTimeframe validityTimeframe)

getValidityTimeframe

@Nullable
public ValidityTimeframe getValidityTimeframe()

Get validityTimeframe

Returns:

validityTimeframe

setValidityTimeframe

public void setValidityTimeframe(ValidityTimeframe validityTimeframe)

validityDayOfWeek

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

addValidityDayOfWeekItem

public TemplatesCampaignsTierSetupCreateRequestBody addValidityDayOfWeekItem(TemplatesCampaignsTierSetupCreateRequestBody.ValidityDayOfWeekEnum validityDayOfWeekItem)

getValidityDayOfWeek

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

validityHours

public TemplatesCampaignsTierSetupCreateRequestBody validityHours(ValidityHours validityHours)

getValidityHours

@Nullable
public ValidityHours getValidityHours()

Get validityHours

Returns:

validityHours

setValidityHours

public void setValidityHours(ValidityHours validityHours)

category

public TemplatesCampaignsTierSetupCreateRequestBody category(String category)

getCategory

@Nullable
public String getCategory()

Assign a new or update the promotion tier's category using name.

Returns:

category

setCategory

public void setCategory(String category)

categoryId

public TemplatesCampaignsTierSetupCreateRequestBody categoryId(String categoryId)

getCategoryId

@Nullable
public String getCategoryId()

Assign a new or update the promotion tier's category using id

Returns:

categoryId

setCategoryId

public void setCategoryId(String categoryId)

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

Create an instance of TemplatesCampaignsTierSetupCreateRequestBody given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of TemplatesCampaignsTierSetupCreateRequestBody

Throws:

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

toJson

public String toJson()

Convert an instance of TemplatesCampaignsTierSetupCreateRequestBody to an JSON string

Returns:

JSON string