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 ClassesModifier and TypeClassDescriptionstatic classstatic enumDefines whether the campaign can be updated with new vouchers after campaign creation.static enumGets or Sets validityDayOfWeek -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final String -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionactivityDurationAfterPublishing(String activityDurationAfterPublishing) addUnsetMetadataFieldsItem(String unsetMetadataFieldsItem) addValidityDayOfWeekItem(LoyaltiesUpdateCampaignRequestBody.ValidityDayOfWeekEnum validityDayOfWeekItem) categoryId(String categoryId) description(String description) booleanexpirationDate(OffsetDateTime expirationDate) Create an instance of LoyaltiesUpdateCampaignRequestBody given an JSON stringDefines the amount of time the vouchers will be active after publishing.Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled.The category assigned to the campaign.Unique category ID that this campaign belongs to.An optional field to keep any extra textual information about the campaign such as a campaign description and details.Expiration timestamp defines when the campaign expires in ISO 8601 format.If this value is set to `true`, customers will be able to join the campaign only once.Get loyaltyTiersExpirationThe metadata object stores all custom attributes assigned to the campaign.Get optionsActivation timestamp defines when the campaign starts to be active in ISO 8601 format.getType()Defines whether the campaign can be updated with new vouchers after campaign creation.Determine which metadata should be removed from campaign.Integer array corresponding to the particular days of the week in which the voucher is valid.Get validityHoursGet validityTimeframeinthashCode()loyaltyTiersExpiration(LoyaltyTiersExpirationAll loyaltyTiersExpiration) voidsetActivityDurationAfterPublishing(String activityDurationAfterPublishing) voidsetAutoJoin(Boolean autoJoin) voidsetCategory(String category) voidsetCategoryId(String categoryId) voidsetDescription(String description) voidsetExpirationDate(OffsetDateTime expirationDate) voidsetJoinOnce(Boolean joinOnce) voidsetLoyaltyTiersExpiration(LoyaltyTiersExpirationAll loyaltyTiersExpiration) voidsetMetadata(Object metadata) voidvoidsetStartDate(OffsetDateTime startDate) voidvoidsetUnsetMetadataFields(List<String> unsetMetadataFields) voidsetValidityDayOfWeek(List<LoyaltiesUpdateCampaignRequestBody.ValidityDayOfWeekEnum> validityDayOfWeek) voidsetValidityHours(ValidityHours validityHours) voidsetValidityTimeframe(ValidityTimeframe validityTimeframe) startDate(OffsetDateTime startDate) toJson()Convert an instance of LoyaltiesUpdateCampaignRequestBody to an JSON stringtoString()unsetMetadataFields(List<String> unsetMetadataFields) validityDayOfWeek(List<LoyaltiesUpdateCampaignRequestBody.ValidityDayOfWeekEnum> validityDayOfWeek) validityHours(ValidityHours validityHours) validityTimeframe(ValidityTimeframe validityTimeframe)
-
Field Details
-
SERIALIZED_NAME_START_DATE
- See Also:
-
SERIALIZED_NAME_EXPIRATION_DATE
- See Also:
-
SERIALIZED_NAME_VALIDITY_TIMEFRAME
- See Also:
-
SERIALIZED_NAME_VALIDITY_DAY_OF_WEEK
- See Also:
-
SERIALIZED_NAME_VALIDITY_HOURS
- See Also:
-
SERIALIZED_NAME_DESCRIPTION
- See Also:
-
SERIALIZED_NAME_CATEGORY
- See Also:
-
SERIALIZED_NAME_METADATA
- See Also:
-
SERIALIZED_NAME_UNSET_METADATA_FIELDS
- See Also:
-
SERIALIZED_NAME_CATEGORY_ID
- See Also:
-
SERIALIZED_NAME_ACTIVITY_DURATION_AFTER_PUBLISHING
- See Also:
-
SERIALIZED_NAME_JOIN_ONCE
- See Also:
-
SERIALIZED_NAME_AUTO_JOIN
- See Also:
-
SERIALIZED_NAME_TYPE
- See Also:
-
SERIALIZED_NAME_LOYALTY_TIERS_EXPIRATION
- See Also:
-
SERIALIZED_NAME_OPTIONS
- See Also:
-
openapiFields
-
openapiRequiredFields
-
-
Constructor Details
-
LoyaltiesUpdateCampaignRequestBody
public LoyaltiesUpdateCampaignRequestBody()
-
-
Method Details
-
startDate
-
getStartDate
Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is *inactive before* this date.- Returns:
- startDate
-
setStartDate
-
expirationDate
-
getExpirationDate
Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is *inactive after* this date.- Returns:
- expirationDate
-
setExpirationDate
-
validityTimeframe
-
getValidityTimeframe
Get validityTimeframe- Returns:
- validityTimeframe
-
setValidityTimeframe
-
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
-
getValidityHours
Get validityHours- Returns:
- validityHours
-
setValidityHours
-
description
-
getDescription
An optional field to keep any extra textual information about the campaign such as a campaign description and details.- Returns:
- description
-
setDescription
-
category
-
getCategory
The category assigned to the campaign. Either pass this parameter OR the `category_id`.- Returns:
- category
-
setCategory
-
metadata
-
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
-
unsetMetadataFields
-
addUnsetMetadataFieldsItem
public LoyaltiesUpdateCampaignRequestBody addUnsetMetadataFieldsItem(String unsetMetadataFieldsItem) -
getUnsetMetadataFields
Determine which metadata should be removed from campaign.- Returns:
- unsetMetadataFields
-
setUnsetMetadataFields
-
categoryId
-
getCategoryId
Unique category ID that this campaign belongs to. Either pass this parameter OR the `category`.- Returns:
- categoryId
-
setCategoryId
-
activityDurationAfterPublishing
public LoyaltiesUpdateCampaignRequestBody activityDurationAfterPublishing(String activityDurationAfterPublishing) -
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
-
joinOnce
-
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
-
autoJoin
-
getAutoJoin
Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled.- Returns:
- autoJoin
-
setAutoJoin
-
type
-
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
-
loyaltyTiersExpiration
public LoyaltiesUpdateCampaignRequestBody loyaltyTiersExpiration(LoyaltyTiersExpirationAll loyaltyTiersExpiration) -
getLoyaltyTiersExpiration
Get loyaltyTiersExpiration- Returns:
- loyaltyTiersExpiration
-
setLoyaltyTiersExpiration
-
options
public LoyaltiesUpdateCampaignRequestBody options(LoyaltiesUpdateCampaignRequestBodyOptions options) -
getOptions
Get options- Returns:
- options
-
setOptions
-
equals
-
hashCode
public int hashCode() -
toString
-
fromJson
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
Convert an instance of LoyaltiesUpdateCampaignRequestBody to an JSON string- Returns:
- JSON string
-