Package software.xdev.brevo.model

Class MainReward

java.lang.Object
software.xdev.brevo.model.MainReward
public class MainReward extends Object
MainReward

  • Field Details

  • Constructor Details

    • MainReward

      public MainReward()

  • Method Details

    • attributionPerConsumer

      public MainReward attributionPerConsumer(@Nullable Integer attributionPerConsumer)

    • getAttributionPerConsumer

      @Nullable public Integer getAttributionPerConsumer()
      Maximum number of times a consumer can be attributed this reward
      Returns:
      attributionPerConsumer

    • setAttributionPerConsumer

      public void setAttributionPerConsumer(@Nullable Integer attributionPerConsumer)

    • balanceDefinitionId

      public MainReward balanceDefinitionId(@Nullable UUID balanceDefinitionId)

    • getBalanceDefinitionId

      @Nullable public UUID getBalanceDefinitionId()
      Unique identifier for the balance definition
      Returns:
      balanceDefinitionId

    • setBalanceDefinitionId

      public void setBalanceDefinitionId(@Nullable UUID balanceDefinitionId)

    • code

      public MainReward code(@Nullable String code)

    • getCode

      @Nullable public String getCode()
      Unique code for the reward
      Returns:
      code

    • setCode

      public void setCode(@Nullable String code)

    • codeCount

      public MainReward codeCount(@Nullable Long codeCount)

    • getCodeCount

      @Nullable public Long getCodeCount()
      Total number of codes generated
      Returns:
      codeCount

    • setCodeCount

      public void setCodeCount(@Nullable Long codeCount)

    • codeGeneratorId

      public MainReward codeGeneratorId(@Nullable UUID codeGeneratorId)

    • getCodeGeneratorId

      @Nullable public UUID getCodeGeneratorId()
      Unique identifier for the code generator
      Returns:
      codeGeneratorId

    • setCodeGeneratorId

      public void setCodeGeneratorId(@Nullable UUID codeGeneratorId)

    • codePoolId

      public MainReward codePoolId(@Nullable UUID codePoolId)

    • getCodePoolId

      @Nullable public UUID getCodePoolId()
      Unique identifier for the code pool
      Returns:
      codePoolId

    • setCodePoolId

      public void setCodePoolId(@Nullable UUID codePoolId)

    • config

      public MainReward config(@Nullable String config)

    • getConfig

      @Nullable public String getConfig()
      Configuration settings for the reward
      Returns:
      config

    • setConfig

      public void setConfig(@Nullable String config)

    • createdAt

      public MainReward createdAt(@Nullable OffsetDateTime createdAt)

    • getCreatedAt

      @Nullable public OffsetDateTime getCreatedAt()
      Timestamp when the reward was created
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(@Nullable OffsetDateTime createdAt)

    • disabledAt

      public MainReward disabledAt(@Nullable OffsetDateTime disabledAt)

    • getDisabledAt

      @Nullable public OffsetDateTime getDisabledAt()
      Disabled date of the reward
      Returns:
      disabledAt

    • setDisabledAt

      public void setDisabledAt(@Nullable OffsetDateTime disabledAt)

    • endDate

      public MainReward endDate(@Nullable OffsetDateTime endDate)

    • getEndDate

      @Nullable public OffsetDateTime getEndDate()
      End date of the reward validity
      Returns:
      endDate

    • setEndDate

      public void setEndDate(@Nullable OffsetDateTime endDate)

    • expirationDate

      public MainReward expirationDate(@Nullable OffsetDateTime expirationDate)

    • getExpirationDate

      @Nullable public OffsetDateTime getExpirationDate()
      Expiration date of the reward
      Returns:
      expirationDate

    • setExpirationDate

      public void setExpirationDate(@Nullable OffsetDateTime expirationDate)

    • expirationModifier

      public MainReward expirationModifier(@Nullable MainReward.ExpirationModifierEnum expirationModifier)

    • getExpirationModifier

      @Nullable public MainReward.ExpirationModifierEnum getExpirationModifier()
      Select startOfPeriod to configure rewards expiry on start of day/week/month/year. Select endOfPeriod to configure reward expiry on end of day/week/month/year, else select noModification
      Returns:
      expirationModifier

    • setExpirationModifier

      public void setExpirationModifier(@Nullable MainReward.ExpirationModifierEnum expirationModifier)

    • expirationUnit

      public MainReward expirationUnit(@Nullable String expirationUnit)

    • getExpirationUnit

      @Nullable public String getExpirationUnit()
      Unit of time for the rewards's availability (e.g., day/week/month/year).
      Returns:
      expirationUnit

    • setExpirationUnit

      public void setExpirationUnit(@Nullable String expirationUnit)

    • expirationValue

      public MainReward expirationValue(@Nullable Integer expirationValue)

    • getExpirationValue

      @Nullable public Integer getExpirationValue()
      Number of days/weeks/month/year for reward expiry
      Returns:
      expirationValue

    • setExpirationValue

      public void setExpirationValue(@Nullable Integer expirationValue)

    • generator

      public MainReward generator(@Nullable MainGenerator generator)

    • getGenerator

      @Nullable public MainGenerator getGenerator()
      object
      Returns:
      generator

    • setGenerator

      public void setGenerator(@Nullable MainGenerator generator)

    • id

      public MainReward id(@Nullable UUID id)

    • getId

      @Nullable public UUID getId()
      Unique identifier for the reward
      Returns:
      id

    • setId

      public void setId(@Nullable UUID id)

    • limits

      public MainReward limits(@Nullable List<MainLimit> limits)

    • addLimitsItem

      public MainReward addLimitsItem(MainLimit limitsItem)

    • getLimits

      @Nullable public List<MainLimit> getLimits()
      Attribution / Redeem Limits for the reward
      Returns:
      limits

    • setLimits

      public void setLimits(@Nullable List<MainLimit> limits)

    • loyaltyProgramId

      public MainReward loyaltyProgramId(@Nullable UUID loyaltyProgramId)

    • getLoyaltyProgramId

      @Nullable public UUID getLoyaltyProgramId()
      Id of the loyalty program to which the current reward belongs to
      Returns:
      loyaltyProgramId

    • setLoyaltyProgramId

      public void setLoyaltyProgramId(@Nullable UUID loyaltyProgramId)

    • meta

      public MainReward meta(@Nullable Map<String,Object> meta)

    • putMetaItem

      public MainReward putMetaItem(String key, Object metaItem)

    • getMeta

      @Nullable public Map<String,Object> getMeta()
      Additional data for reward definition
      Returns:
      meta

    • setMeta

      public void setMeta(@Nullable Map<String,Object> meta)

    • name

      public MainReward name(@Nullable String name)

    • getName

      @Nullable public String getName()
      Name of the reward
      Returns:
      name

    • setName

      public void setName(@Nullable String name)

    • products

      public MainReward products(@Nullable List<MainProduct> products)

    • addProductsItem

      public MainReward addProductsItem(MainProduct productsItem)

    • getProducts

      @Nullable public List<MainProduct> getProducts()
      Selected products for reward definition
      Returns:
      products

    • setProducts

      public void setProducts(@Nullable List<MainProduct> products)

    • publicDescription

      public MainReward publicDescription(@Nullable String publicDescription)

    • getPublicDescription

      @Nullable public String getPublicDescription()
      Public description for the reward
      Returns:
      publicDescription

    • setPublicDescription

      public void setPublicDescription(@Nullable String publicDescription)

    • publicImage

      public MainReward publicImage(@Nullable String publicImage)

    • getPublicImage

      @Nullable public String getPublicImage()
      Public Image for the reward
      Returns:
      publicImage

    • setPublicImage

      public void setPublicImage(@Nullable String publicImage)

    • publicName

      public MainReward publicName(@Nullable String publicName)

    • getPublicName

      @Nullable public String getPublicName()
      Public name for the reward
      Returns:
      publicName

    • setPublicName

      public void setPublicName(@Nullable String publicName)

    • redeemPerConsumer

      public MainReward redeemPerConsumer(@Nullable Integer redeemPerConsumer)

    • getRedeemPerConsumer

      @Nullable public Integer getRedeemPerConsumer()
      Defines the redeem limit for the consumer
      Returns:
      redeemPerConsumer

    • setRedeemPerConsumer

      public void setRedeemPerConsumer(@Nullable Integer redeemPerConsumer)

    • redeemRules

      public MainReward redeemRules(@Nullable List<String> redeemRules)

    • addRedeemRulesItem

      public MainReward addRedeemRulesItem(String redeemRulesItem)

    • getRedeemRules

      @Nullable public List<String> getRedeemRules()
      Rules defined to redeem a reward
      Returns:
      redeemRules

    • setRedeemRules

      public void setRedeemRules(@Nullable List<String> redeemRules)

    • rewardConfigs

      public MainReward rewardConfigs(@Nullable MainRewardConfigurations rewardConfigs)

    • getRewardConfigs

      @Nullable public MainRewardConfigurations getRewardConfigs()
      object
      Returns:
      rewardConfigs

    • setRewardConfigs

      public void setRewardConfigs(@Nullable MainRewardConfigurations rewardConfigs)

    • rule

      public MainReward rule(@Nullable MainRule rule)

    • getRule

      @Nullable public MainRule getRule()
      Rule to define the reward
      Returns:
      rule

    • setRule

      public void setRule(@Nullable MainRule rule)

    • startDate

      public MainReward startDate(@Nullable OffsetDateTime startDate)

    • getStartDate

      @Nullable public OffsetDateTime getStartDate()
      Start date of attribution of the reward
      Returns:
      startDate

    • setStartDate

      public void setStartDate(@Nullable OffsetDateTime startDate)

    • subtractBalanceDefinitionId

      public MainReward subtractBalanceDefinitionId(@Nullable String subtractBalanceDefinitionId)

    • getSubtractBalanceDefinitionId

      @Nullable public String getSubtractBalanceDefinitionId()
      Id of the selected balance while redeeming / attributing a reward
      Returns:
      subtractBalanceDefinitionId

    • setSubtractBalanceDefinitionId

      public void setSubtractBalanceDefinitionId(@Nullable String subtractBalanceDefinitionId)

    • subtractBalanceStrategy

      public MainReward subtractBalanceStrategy(@Nullable String subtractBalanceStrategy)

    • getSubtractBalanceStrategy

      @Nullable public String getSubtractBalanceStrategy()
      Strategy of the Balance while redeeming / attributing a reward
      Returns:
      subtractBalanceStrategy

    • setSubtractBalanceStrategy

      public void setSubtractBalanceStrategy(@Nullable String subtractBalanceStrategy)

    • subtractBalanceValue

      public MainReward subtractBalanceValue(@Nullable Integer subtractBalanceValue)

    • getSubtractBalanceValue

      @Nullable public Integer getSubtractBalanceValue()
      Amount of balance to be selected while redeeming / attributing a reward
      Returns:
      subtractBalanceValue

    • setSubtractBalanceValue

      public void setSubtractBalanceValue(@Nullable Integer subtractBalanceValue)

    • subtractTotalBalance

      public MainReward subtractTotalBalance(@Nullable Boolean subtractTotalBalance)

    • getSubtractTotalBalance

      @Nullable public Boolean getSubtractTotalBalance()
      Value to indicate to subtract full balance or not
      Returns:
      subtractTotalBalance

    • setSubtractTotalBalance

      public void setSubtractTotalBalance(@Nullable Boolean subtractTotalBalance)

    • totalAttribution

      public MainReward totalAttribution(@Nullable Integer totalAttribution)

    • getTotalAttribution

      @Nullable public Integer getTotalAttribution()
      Defines the limit to which a consumer can attribute a reward
      Returns:
      totalAttribution

    • setTotalAttribution

      public void setTotalAttribution(@Nullable Integer totalAttribution)

    • totalRedeem

      public MainReward totalRedeem(@Nullable Integer totalRedeem)

    • getTotalRedeem

      @Nullable public Integer getTotalRedeem()
      Defines the limit to which a consumer can redeem a reward
      Returns:
      totalRedeem

    • setTotalRedeem

      public void setTotalRedeem(@Nullable Integer totalRedeem)

    • triggerId

      public MainReward triggerId(@Nullable String triggerId)

    • getTriggerId

      @Nullable public String getTriggerId()
      Id of the Rule to be updated for that reward
      Returns:
      triggerId

    • setTriggerId

      public void setTriggerId(@Nullable String triggerId)

    • unit

      public MainReward unit(@Nullable String unit)

    • getUnit

      @Nullable public String getUnit()
      Selected unit of the balance
      Returns:
      unit

    • setUnit

      public void setUnit(@Nullable String unit)

    • updatedAt

      public MainReward updatedAt(@Nullable String updatedAt)

    • getUpdatedAt

      @Nullable public String getUpdatedAt()
      Timestamp for when this reward was last updated.
      Returns:
      updatedAt

    • setUpdatedAt

      public void setUpdatedAt(@Nullable String updatedAt)

    • value

      public MainReward value(@Nullable BigDecimal value)

    • getValue

      @Nullable public BigDecimal getValue()
      Value of metric in selected config for reward definition
      Returns:
      value

    • setValue

      public void setValue(@Nullable BigDecimal value)

    • valueType

      public MainReward valueType(@Nullable String valueType)

    • getValueType

      @Nullable public String getValueType()
      Type of config selected for reward definition
      Returns:
      valueType

    • setValueType

      public void setValueType(@Nullable String valueType)

    • 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

    • toUrlQueryString

      public String toUrlQueryString()
      Convert the instance into URL query string.
      Returns:
      URL query string

    • toUrlQueryString

      public String toUrlQueryString(String prefix)
      Convert the instance into URL query string.
      Parameters:
      prefix - prefix of the query string
      Returns:
      URL query string