Package io.voucherify.client.model

Class LoyaltiesUpdateCampaignRequestBody

java.lang.Object

io.voucherify.client.model.LoyaltiesUpdateCampaignRequestBody

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

Request body schema for **PUT** `/loyalties/{campaignId}`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LoyaltiesUpdateCampaignRequestBody.CustomTypeAdapterFactory
static enum	LoyaltiesUpdateCampaignRequestBody.TypeEnum	Defines whether the campaign can be updated with new vouchers after campaign creation.
static enum	LoyaltiesUpdateCampaignRequestBody.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_LOYALTY_TIERS_EXPIRATION
static final String	SERIALIZED_NAME_METADATA
static final String	SERIALIZED_NAME_OPTIONS
static final String	SERIALIZED_NAME_START_DATE
static final String	SERIALIZED_NAME_TYPE
static final String	SERIALIZED_NAME_UNSET_METADATA_FIELDS
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
LoyaltiesUpdateCampaignRequestBody()

Method Summary

Modifier and Type	Method	Description
LoyaltiesUpdateCampaignRequestBody	activityDurationAfterPublishing(String activityDurationAfterPublishing)
LoyaltiesUpdateCampaignRequestBody	addUnsetMetadataFieldsItem(String unsetMetadataFieldsItem)
LoyaltiesUpdateCampaignRequestBody	addValidityDayOfWeekItem(LoyaltiesUpdateCampaignRequestBody.ValidityDayOfWeekEnum validityDayOfWeekItem)
LoyaltiesUpdateCampaignRequestBody	autoJoin(Boolean autoJoin)
LoyaltiesUpdateCampaignRequestBody	category(String category)
LoyaltiesUpdateCampaignRequestBody	categoryId(String categoryId)
LoyaltiesUpdateCampaignRequestBody	description(String description)
boolean	equals(Object o)
LoyaltiesUpdateCampaignRequestBody	expirationDate(OffsetDateTime expirationDate)
static LoyaltiesUpdateCampaignRequestBody	fromJson(String jsonString)	Create an instance of LoyaltiesUpdateCampaignRequestBody 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.
LoyaltyTiersExpirationAll	getLoyaltyTiersExpiration()	Get loyaltyTiersExpiration
Object	getMetadata()	The metadata object stores all custom attributes assigned to the campaign.
LoyaltiesUpdateCampaignRequestBodyOptions	getOptions()	Get options
OffsetDateTime	getStartDate()	Activation timestamp defines when the campaign starts to be active in ISO 8601 format.
LoyaltiesUpdateCampaignRequestBody.TypeEnum	getType()	Defines whether the campaign can be updated with new vouchers after campaign creation.
List<String>	getUnsetMetadataFields()	Determine which metadata should be removed from campaign.
List<LoyaltiesUpdateCampaignRequestBody.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()
LoyaltiesUpdateCampaignRequestBody	joinOnce(Boolean joinOnce)
LoyaltiesUpdateCampaignRequestBody	loyaltyTiersExpiration(LoyaltyTiersExpirationAll loyaltyTiersExpiration)
LoyaltiesUpdateCampaignRequestBody	metadata(Object metadata)
LoyaltiesUpdateCampaignRequestBody	options(LoyaltiesUpdateCampaignRequestBodyOptions options)
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	setLoyaltyTiersExpiration(LoyaltyTiersExpirationAll loyaltyTiersExpiration)
void	setMetadata(Object metadata)
void	setOptions(LoyaltiesUpdateCampaignRequestBodyOptions options)
void	setStartDate(OffsetDateTime startDate)
void	setType(LoyaltiesUpdateCampaignRequestBody.TypeEnum type)
void	setUnsetMetadataFields(List<String> unsetMetadataFields)
void	setValidityDayOfWeek(List<LoyaltiesUpdateCampaignRequestBody.ValidityDayOfWeekEnum> validityDayOfWeek)
void	setValidityHours(ValidityHours validityHours)
void	setValidityTimeframe(ValidityTimeframe validityTimeframe)
LoyaltiesUpdateCampaignRequestBody	startDate(OffsetDateTime startDate)
String	toJson()	Convert an instance of LoyaltiesUpdateCampaignRequestBody to an JSON string
String	toString()
LoyaltiesUpdateCampaignRequestBody	type(LoyaltiesUpdateCampaignRequestBody.TypeEnum type)
LoyaltiesUpdateCampaignRequestBody	unsetMetadataFields(List<String> unsetMetadataFields)
LoyaltiesUpdateCampaignRequestBody	validityDayOfWeek(List<LoyaltiesUpdateCampaignRequestBody.ValidityDayOfWeekEnum> validityDayOfWeek)
LoyaltiesUpdateCampaignRequestBody	validityHours(ValidityHours validityHours)
LoyaltiesUpdateCampaignRequestBody	validityTimeframe(ValidityTimeframe validityTimeframe)

Methods inherited from class java.lang.Object

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

Field Details

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_DESCRIPTION

public static final String SERIALIZED_NAME_DESCRIPTION

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_UNSET_METADATA_FIELDS

public static final String SERIALIZED_NAME_UNSET_METADATA_FIELDS

See Also:

• Constant Field Values

SERIALIZED_NAME_CATEGORY_ID

public static final String SERIALIZED_NAME_CATEGORY_ID

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

public static final String SERIALIZED_NAME_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_LOYALTY_TIERS_EXPIRATION

public static final String SERIALIZED_NAME_LOYALTY_TIERS_EXPIRATION

See Also:

• Constant Field Values

SERIALIZED_NAME_OPTIONS

public static final String SERIALIZED_NAME_OPTIONS

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

LoyaltiesUpdateCampaignRequestBody

public LoyaltiesUpdateCampaignRequestBody()

Method Details

startDate

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

getValidityTimeframe

@Nullable
public ValidityTimeframe getValidityTimeframe()

Get validityTimeframe

Returns:

validityTimeframe

setValidityTimeframe

public void setValidityTimeframe(ValidityTimeframe validityTimeframe)

validityDayOfWeek

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

addValidityDayOfWeekItem

public LoyaltiesUpdateCampaignRequestBody addValidityDayOfWeekItem(LoyaltiesUpdateCampaignRequestBody.ValidityDayOfWeekEnum validityDayOfWeekItem)

getValidityDayOfWeek

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

validityHours

public LoyaltiesUpdateCampaignRequestBody validityHours(ValidityHours validityHours)

getValidityHours

@Nullable
public ValidityHours getValidityHours()

Get validityHours

Returns:

validityHours

setValidityHours

public void setValidityHours(ValidityHours validityHours)

description

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

category

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

unsetMetadataFields

public LoyaltiesUpdateCampaignRequestBody unsetMetadataFields(List<String> unsetMetadataFields)

addUnsetMetadataFieldsItem

public LoyaltiesUpdateCampaignRequestBody addUnsetMetadataFieldsItem(String unsetMetadataFieldsItem)

getUnsetMetadataFields

@Nullable
public List<String> getUnsetMetadataFields()

Determine which metadata should be removed from campaign.

Returns:

unsetMetadataFields

setUnsetMetadataFields

public void setUnsetMetadataFields(List<String> unsetMetadataFields)

categoryId

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

activityDurationAfterPublishing

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

joinOnce

public LoyaltiesUpdateCampaignRequestBody 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. It is always `false` for standalone voucher campaigns and it cannot be changed in them.

Returns:

joinOnce

setJoinOnce

public void setJoinOnce(Boolean joinOnce)

autoJoin

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

type

public LoyaltiesUpdateCampaignRequestBody type(LoyaltiesUpdateCampaignRequestBody.TypeEnum type)

getType

@Nullable
public LoyaltiesUpdateCampaignRequestBody.TypeEnum getType()

Defines whether the campaign can be updated with new vouchers after campaign creation. - `AUTO_UPDATE`: By choosing the auto update option you will create a campaign that can be enhanced by new vouchers after the time of creation (e.g. by publish vouchers method). - `STATIC`: vouchers need to be manually published. If the `type` of the campaign is `STANDALONE`, the type cannot be changed. Also, the `type` cannot be changed to `STANDALONE`.

Returns:

type

setType

public void setType(LoyaltiesUpdateCampaignRequestBody.TypeEnum type)

loyaltyTiersExpiration

public LoyaltiesUpdateCampaignRequestBody loyaltyTiersExpiration(LoyaltyTiersExpirationAll loyaltyTiersExpiration)

getLoyaltyTiersExpiration

@Nullable
public LoyaltyTiersExpirationAll getLoyaltyTiersExpiration()

Get loyaltyTiersExpiration

Returns:

loyaltyTiersExpiration

setLoyaltyTiersExpiration

public void setLoyaltyTiersExpiration(LoyaltyTiersExpirationAll loyaltyTiersExpiration)

options

public LoyaltiesUpdateCampaignRequestBody options(LoyaltiesUpdateCampaignRequestBodyOptions options)

getOptions

@Nullable
public LoyaltiesUpdateCampaignRequestBodyOptions getOptions()

Get options

Returns:

options

setOptions

public void setOptions(LoyaltiesUpdateCampaignRequestBodyOptions options)

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

Create an instance of LoyaltiesUpdateCampaignRequestBody given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of LoyaltiesUpdateCampaignRequestBody

Throws:

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

toJson

public String toJson()

Convert an instance of LoyaltiesUpdateCampaignRequestBody to an JSON string

Returns:

JSON string