Package io.voucherify.client.model

Class CampaignsGetResponseBody

java.lang.Object

io.voucherify.client.model.CampaignsGetResponseBody

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

Response body schema for **GET** `v1/campaigns/{campaignId}`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CampaignsGetResponseBody.CampaignTypeEnum	Type of campaign.
static enum	CampaignsGetResponseBody.CreationStatusEnum	Indicates the status of the campaign creation.
static class	CampaignsGetResponseBody.CustomTypeAdapterFactory
static enum	CampaignsGetResponseBody.TypeEnum	Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers.
static enum	CampaignsGetResponseBody.ValidityDayOfWeekEnum	Gets or Sets validityDayOfWeek
static enum	CampaignsGetResponseBody.VouchersGenerationStatusEnum	Indicates the status of the campaign's voucher generation.

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_ACCESS_SETTINGS_ASSIGNMENTS
static final String	SERIALIZED_NAME_ACTIVE
static final String	SERIALIZED_NAME_ACTIVITY_DURATION_AFTER_PUBLISHING
static final String	SERIALIZED_NAME_AUTO_JOIN
static final String	SERIALIZED_NAME_CAMPAIGN_TYPE
static final String	SERIALIZED_NAME_CATEGORIES
static final String	SERIALIZED_NAME_CATEGORY
static final String	SERIALIZED_NAME_CATEGORY_ID
static final String	SERIALIZED_NAME_CREATED_AT
static final String	SERIALIZED_NAME_CREATION_STATUS
static final String	SERIALIZED_NAME_DESCRIPTION
static final String	SERIALIZED_NAME_EXPIRATION_DATE
static final String	SERIALIZED_NAME_ID
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_NAME
static final String	SERIALIZED_NAME_OBJECT
static final String	SERIALIZED_NAME_PROMOTION
static final String	SERIALIZED_NAME_PROTECTED
static final String	SERIALIZED_NAME_READONLY
static final String	SERIALIZED_NAME_REFERRAL_PROGRAM
static final String	SERIALIZED_NAME_START_DATE
static final String	SERIALIZED_NAME_TYPE
static final String	SERIALIZED_NAME_UPDATED_AT
static final String	SERIALIZED_NAME_USE_VOUCHER_METADATA_SCHEMA
static final String	SERIALIZED_NAME_VALIDATION_RULES_ASSIGNMENTS
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
static final String	SERIALIZED_NAME_VOUCHERS_GENERATION_STATUS

Constructor Summary

Constructors

Constructor	Description
CampaignsGetResponseBody()

Method Summary

Modifier and Type	Method	Description
CampaignsGetResponseBody	_object(String _object)
CampaignsGetResponseBody	_protected(Boolean _protected)
CampaignsGetResponseBody	accessSettingsAssignments(AccessSettingsCampaignAssignmentsList accessSettingsAssignments)
CampaignsGetResponseBody	active(Boolean active)
CampaignsGetResponseBody	activityDurationAfterPublishing(String activityDurationAfterPublishing)
CampaignsGetResponseBody	addCategoriesItem(Category categoriesItem)
CampaignsGetResponseBody	addValidityDayOfWeekItem(CampaignsGetResponseBody.ValidityDayOfWeekEnum validityDayOfWeekItem)
CampaignsGetResponseBody	autoJoin(Boolean autoJoin)
CampaignsGetResponseBody	campaignType(CampaignsGetResponseBody.CampaignTypeEnum campaignType)
CampaignsGetResponseBody	categories(List<Category> categories)
CampaignsGetResponseBody	category(String category)
CampaignsGetResponseBody	categoryId(String categoryId)
CampaignsGetResponseBody	createdAt(OffsetDateTime createdAt)
CampaignsGetResponseBody	creationStatus(CampaignsGetResponseBody.CreationStatusEnum creationStatus)
CampaignsGetResponseBody	description(String description)
boolean	equals(Object o)
CampaignsGetResponseBody	expirationDate(OffsetDateTime expirationDate)
static CampaignsGetResponseBody	fromJson(String jsonString)	Create an instance of CampaignsGetResponseBody given an JSON string
AccessSettingsCampaignAssignmentsList	getAccessSettingsAssignments()	Get accessSettingsAssignments
Boolean	getActive()	A flag to toggle the campaign on or off.
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.
CampaignsGetResponseBody.CampaignTypeEnum	getCampaignType()	Type of campaign.
List<Category>	getCategories()	Contains details about the category.
String	getCategory()	Unique category name.
String	getCategoryId()	Unique category ID that this campaign belongs to.
OffsetDateTime	getCreatedAt()	Timestamp representing the date and time when the campaign was created.
CampaignsGetResponseBody.CreationStatusEnum	getCreationStatus()	Indicates the status of the campaign creation.
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.
String	getId()	Unique campaign ID, assigned by Voucherify.
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.
String	getName()	Campaign name.
String	getObject()	The type of the object represented by JSON.
PromotionTiersList	getPromotion()	Get promotion
Boolean	getProtected()	Indicates whether the resource can be deleted.
Boolean	getReadonly()	Indicates whether the campaign can be only read by a restricted user in the Areas and Stores enterprise feature.
ReferralProgram	getReferralProgram()	Get referralProgram
OffsetDateTime	getStartDate()	Activation timestamp defines when the campaign starts to be active in ISO 8601 format.
CampaignsGetResponseBody.TypeEnum	getType()	Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers.
OffsetDateTime	getUpdatedAt()	Timestamp representing the date and time when the campaign was last updated in ISO 8601 format.
Boolean	getUseVoucherMetadataSchema()	Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema.
ValidationRulesAssignmentsList	getValidationRulesAssignments()	Get validationRulesAssignments
List<CampaignsGetResponseBody.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
CampaignVoucher	getVoucher()	Get voucher
Integer	getVouchersCount()	Total number of unique vouchers in campaign.
CampaignsGetResponseBody.VouchersGenerationStatusEnum	getVouchersGenerationStatus()	Indicates the status of the campaign's voucher generation.
int	hashCode()
CampaignsGetResponseBody	id(String id)
CampaignsGetResponseBody	joinOnce(Boolean joinOnce)
CampaignsGetResponseBody	loyaltyTiersExpiration(LoyaltyTiersExpirationAll loyaltyTiersExpiration)
CampaignsGetResponseBody	metadata(Object metadata)
CampaignsGetResponseBody	name(String name)
CampaignsGetResponseBody	promotion(PromotionTiersList promotion)
CampaignsGetResponseBody	readonly(Boolean readonly)
CampaignsGetResponseBody	referralProgram(ReferralProgram referralProgram)
void	setAccessSettingsAssignments(AccessSettingsCampaignAssignmentsList accessSettingsAssignments)
void	setActive(Boolean active)
void	setActivityDurationAfterPublishing(String activityDurationAfterPublishing)
void	setAutoJoin(Boolean autoJoin)
void	setCampaignType(CampaignsGetResponseBody.CampaignTypeEnum campaignType)
void	setCategories(List<Category> categories)
void	setCategory(String category)
void	setCategoryId(String categoryId)
void	setCreatedAt(OffsetDateTime createdAt)
void	setCreationStatus(CampaignsGetResponseBody.CreationStatusEnum creationStatus)
void	setDescription(String description)
void	setExpirationDate(OffsetDateTime expirationDate)
void	setId(String id)
void	setJoinOnce(Boolean joinOnce)
void	setLoyaltyTiersExpiration(LoyaltyTiersExpirationAll loyaltyTiersExpiration)
void	setMetadata(Object metadata)
void	setName(String name)
void	setObject(String _object)
void	setPromotion(PromotionTiersList promotion)
void	setProtected(Boolean _protected)
void	setReadonly(Boolean readonly)
void	setReferralProgram(ReferralProgram referralProgram)
void	setStartDate(OffsetDateTime startDate)
void	setType(CampaignsGetResponseBody.TypeEnum type)
void	setUpdatedAt(OffsetDateTime updatedAt)
void	setUseVoucherMetadataSchema(Boolean useVoucherMetadataSchema)
void	setValidationRulesAssignments(ValidationRulesAssignmentsList validationRulesAssignments)
void	setValidityDayOfWeek(List<CampaignsGetResponseBody.ValidityDayOfWeekEnum> validityDayOfWeek)
void	setValidityHours(ValidityHours validityHours)
void	setValidityTimeframe(ValidityTimeframe validityTimeframe)
void	setVoucher(CampaignVoucher voucher)
void	setVouchersCount(Integer vouchersCount)
void	setVouchersGenerationStatus(CampaignsGetResponseBody.VouchersGenerationStatusEnum vouchersGenerationStatus)
CampaignsGetResponseBody	startDate(OffsetDateTime startDate)
String	toJson()	Convert an instance of CampaignsGetResponseBody to an JSON string
String	toString()
CampaignsGetResponseBody	type(CampaignsGetResponseBody.TypeEnum type)
CampaignsGetResponseBody	updatedAt(OffsetDateTime updatedAt)
CampaignsGetResponseBody	useVoucherMetadataSchema(Boolean useVoucherMetadataSchema)
CampaignsGetResponseBody	validationRulesAssignments(ValidationRulesAssignmentsList validationRulesAssignments)
CampaignsGetResponseBody	validityDayOfWeek(List<CampaignsGetResponseBody.ValidityDayOfWeekEnum> validityDayOfWeek)
CampaignsGetResponseBody	validityHours(ValidityHours validityHours)
CampaignsGetResponseBody	validityTimeframe(ValidityTimeframe validityTimeframe)
CampaignsGetResponseBody	voucher(CampaignVoucher voucher)
CampaignsGetResponseBody	vouchersCount(Integer vouchersCount)
CampaignsGetResponseBody	vouchersGenerationStatus(CampaignsGetResponseBody.VouchersGenerationStatusEnum vouchersGenerationStatus)

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZED_NAME_ID

public static final String SERIALIZED_NAME_ID

See Also:

• Constant Field Values

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_CAMPAIGN_TYPE

public static final String SERIALIZED_NAME_CAMPAIGN_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_TYPE

public static final String SERIALIZED_NAME_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_VOUCHER

public static final String SERIALIZED_NAME_VOUCHER

See Also:

• Constant Field Values

SERIALIZED_NAME_AUTO_JOIN

public static final String SERIALIZED_NAME_AUTO_JOIN

See Also:

• Constant Field Values

SERIALIZED_NAME_JOIN_ONCE

public static final String SERIALIZED_NAME_JOIN_ONCE

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

public static final String SERIALIZED_NAME_CREATED_AT

See Also:

• Constant Field Values

SERIALIZED_NAME_UPDATED_AT

public static final String SERIALIZED_NAME_UPDATED_AT

See Also:

• Constant Field Values

SERIALIZED_NAME_CATEGORY

public static final String SERIALIZED_NAME_CATEGORY

See Also:

• Constant Field Values

SERIALIZED_NAME_CREATION_STATUS

public static final String SERIALIZED_NAME_CREATION_STATUS

See Also:

• Constant Field Values

SERIALIZED_NAME_VOUCHERS_GENERATION_STATUS

public static final String SERIALIZED_NAME_VOUCHERS_GENERATION_STATUS

See Also:

• Constant Field Values

SERIALIZED_NAME_READONLY

public static final String SERIALIZED_NAME_READONLY

See Also:

• Constant Field Values

SERIALIZED_NAME_PROTECTED

public static final String SERIALIZED_NAME_PROTECTED

See Also:

• Constant Field Values

SERIALIZED_NAME_CATEGORY_ID

public static final String SERIALIZED_NAME_CATEGORY_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_CATEGORIES

public static final String SERIALIZED_NAME_CATEGORIES

See Also:

• Constant Field Values

SERIALIZED_NAME_OBJECT

public static final String SERIALIZED_NAME_OBJECT

See Also:

• Constant Field Values

SERIALIZED_NAME_REFERRAL_PROGRAM

public static final String SERIALIZED_NAME_REFERRAL_PROGRAM

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_PROMOTION

public static final String SERIALIZED_NAME_PROMOTION

See Also:

• Constant Field Values

SERIALIZED_NAME_VALIDATION_RULES_ASSIGNMENTS

public static final String SERIALIZED_NAME_VALIDATION_RULES_ASSIGNMENTS

See Also:

• Constant Field Values

SERIALIZED_NAME_ACCESS_SETTINGS_ASSIGNMENTS

public static final String SERIALIZED_NAME_ACCESS_SETTINGS_ASSIGNMENTS

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

CampaignsGetResponseBody

public CampaignsGetResponseBody()

Method Details

id

public CampaignsGetResponseBody id(String id)

getId

@Nullable
public String getId()

Unique campaign ID, assigned by Voucherify.

Returns:

id

setId

public void setId(String id)

name

public CampaignsGetResponseBody name(String name)

getName

@Nullable
public String getName()

Campaign name.

Returns:

name

setName

public void setName(String name)

description

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

campaignType

public CampaignsGetResponseBody campaignType(CampaignsGetResponseBody.CampaignTypeEnum campaignType)

getCampaignType

@Nullable
public CampaignsGetResponseBody.CampaignTypeEnum getCampaignType()

Type of campaign.

Returns:

campaignType

setCampaignType

public void setCampaignType(CampaignsGetResponseBody.CampaignTypeEnum campaignType)

type

public CampaignsGetResponseBody type(CampaignsGetResponseBody.TypeEnum type)

getType

@Nullable
public CampaignsGetResponseBody.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 - `STANDALONE`: campaign for single vouchers

Returns:

type

setType

public void setType(CampaignsGetResponseBody.TypeEnum type)

voucher

public CampaignsGetResponseBody voucher(CampaignVoucher voucher)

getVoucher

@Nullable
public CampaignVoucher getVoucher()

Get voucher

Returns:

voucher

setVoucher

public void setVoucher(CampaignVoucher voucher)

autoJoin

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

joinOnce

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

useVoucherMetadataSchema

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

validityTimeframe

public CampaignsGetResponseBody validityTimeframe(ValidityTimeframe validityTimeframe)

getValidityTimeframe

@Nullable
public ValidityTimeframe getValidityTimeframe()

Get validityTimeframe

Returns:

validityTimeframe

setValidityTimeframe

public void setValidityTimeframe(ValidityTimeframe validityTimeframe)

validityDayOfWeek

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

addValidityDayOfWeekItem

public CampaignsGetResponseBody addValidityDayOfWeekItem(CampaignsGetResponseBody.ValidityDayOfWeekEnum validityDayOfWeekItem)

getValidityDayOfWeek

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

validityHours

public CampaignsGetResponseBody validityHours(ValidityHours validityHours)

getValidityHours

@Nullable
public ValidityHours getValidityHours()

Get validityHours

Returns:

validityHours

setValidityHours

public void setValidityHours(ValidityHours validityHours)

activityDurationAfterPublishing

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

vouchersCount

public CampaignsGetResponseBody vouchersCount(Integer vouchersCount)

getVouchersCount

@Nullable
public Integer getVouchersCount()

Total number of unique vouchers in campaign.

Returns:

vouchersCount

setVouchersCount

public void setVouchersCount(Integer vouchersCount)

startDate

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

active

public CampaignsGetResponseBody active(Boolean active)

getActive

@Nullable
public Boolean getActive()

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

Returns:

active

setActive

public void setActive(Boolean active)

metadata

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

createdAt

public CampaignsGetResponseBody createdAt(OffsetDateTime createdAt)

getCreatedAt

@Nullable
public OffsetDateTime getCreatedAt()

Timestamp representing the date and time when the campaign was created. The value is shown in the ISO 8601 format.

Returns:

createdAt

setCreatedAt

public void setCreatedAt(OffsetDateTime createdAt)

updatedAt

public CampaignsGetResponseBody updatedAt(OffsetDateTime updatedAt)

getUpdatedAt

@Nullable
public OffsetDateTime getUpdatedAt()

Timestamp representing the date and time when the campaign was last updated in ISO 8601 format.

Returns:

updatedAt

setUpdatedAt

public void setUpdatedAt(OffsetDateTime updatedAt)

category

public CampaignsGetResponseBody category(String category)

getCategory

@Nullable
public String getCategory()

Unique category name.

Returns:

category

setCategory

public void setCategory(String category)

creationStatus

public CampaignsGetResponseBody creationStatus(CampaignsGetResponseBody.CreationStatusEnum creationStatus)

getCreationStatus

@Nullable
public CampaignsGetResponseBody.CreationStatusEnum getCreationStatus()

Indicates the status of the campaign creation.

Returns:

creationStatus

setCreationStatus

public void setCreationStatus(CampaignsGetResponseBody.CreationStatusEnum creationStatus)

vouchersGenerationStatus

public CampaignsGetResponseBody vouchersGenerationStatus(CampaignsGetResponseBody.VouchersGenerationStatusEnum vouchersGenerationStatus)

getVouchersGenerationStatus

@Nullable
public CampaignsGetResponseBody.VouchersGenerationStatusEnum getVouchersGenerationStatus()

Indicates the status of the campaign's voucher generation.

Returns:

vouchersGenerationStatus

setVouchersGenerationStatus

public void setVouchersGenerationStatus(CampaignsGetResponseBody.VouchersGenerationStatusEnum vouchersGenerationStatus)

readonly

public CampaignsGetResponseBody readonly(Boolean readonly)

getReadonly

@Nullable
public Boolean getReadonly()

Indicates whether the campaign can be only read by a restricted user in the Areas and Stores enterprise feature. It is returned only to restricted users; this field is not returned for users with other roles.

Returns:

readonly

setReadonly

public void setReadonly(Boolean readonly)

_protected

public CampaignsGetResponseBody _protected(Boolean _protected)

getProtected

@Nullable
public Boolean getProtected()

Indicates whether the resource can be deleted.

Returns:

_protected

setProtected

public void setProtected(Boolean _protected)

categoryId

public CampaignsGetResponseBody categoryId(String categoryId)

getCategoryId

@Nullable
public String getCategoryId()

Unique category ID that this campaign belongs to.

Returns:

categoryId

setCategoryId

public void setCategoryId(String categoryId)

categories

public CampaignsGetResponseBody categories(List<Category> categories)

addCategoriesItem

public CampaignsGetResponseBody addCategoriesItem(Category categoriesItem)

getCategories

@Nullable
public List<Category> getCategories()

Contains details about the category.

Returns:

categories

setCategories

public void setCategories(List<Category> categories)

_object

public CampaignsGetResponseBody _object(String _object)

getObject

@Nullable
public String getObject()

The type of the object represented by JSON. This object stores information about the campaign.

Returns:

_object

setObject

public void setObject(String _object)

referralProgram

public CampaignsGetResponseBody referralProgram(ReferralProgram referralProgram)

getReferralProgram

@Nullable
public ReferralProgram getReferralProgram()

Get referralProgram

Returns:

referralProgram

setReferralProgram

public void setReferralProgram(ReferralProgram referralProgram)

loyaltyTiersExpiration

public CampaignsGetResponseBody loyaltyTiersExpiration(LoyaltyTiersExpirationAll loyaltyTiersExpiration)

getLoyaltyTiersExpiration

@Nullable
public LoyaltyTiersExpirationAll getLoyaltyTiersExpiration()

Get loyaltyTiersExpiration

Returns:

loyaltyTiersExpiration

setLoyaltyTiersExpiration

public void setLoyaltyTiersExpiration(LoyaltyTiersExpirationAll loyaltyTiersExpiration)

promotion

public CampaignsGetResponseBody promotion(PromotionTiersList promotion)

getPromotion

@Nullable
public PromotionTiersList getPromotion()

Get promotion

Returns:

promotion

setPromotion

public void setPromotion(PromotionTiersList promotion)

validationRulesAssignments

public CampaignsGetResponseBody validationRulesAssignments(ValidationRulesAssignmentsList validationRulesAssignments)

getValidationRulesAssignments

@Nullable
public ValidationRulesAssignmentsList getValidationRulesAssignments()

Get validationRulesAssignments

Returns:

validationRulesAssignments

setValidationRulesAssignments

public void setValidationRulesAssignments(ValidationRulesAssignmentsList validationRulesAssignments)

accessSettingsAssignments

public CampaignsGetResponseBody accessSettingsAssignments(AccessSettingsCampaignAssignmentsList accessSettingsAssignments)

getAccessSettingsAssignments

@Nullable
public AccessSettingsCampaignAssignmentsList getAccessSettingsAssignments()

Get accessSettingsAssignments

Returns:

accessSettingsAssignments

setAccessSettingsAssignments

public void setAccessSettingsAssignments(AccessSettingsCampaignAssignmentsList accessSettingsAssignments)

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

Create an instance of CampaignsGetResponseBody given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of CampaignsGetResponseBody

Throws:

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

toJson

public String toJson()

Convert an instance of CampaignsGetResponseBody to an JSON string

Returns:

JSON string