Package software.xdev.brevo.model

Class BalanceDefinition

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

  • Field Details

  • Constructor Details

    • BalanceDefinition

      public BalanceDefinition()

  • Method Details

    • balanceAvailabilityDurationModifier

      public BalanceDefinition balanceAvailabilityDurationModifier(@Nullable BalanceDefinition.BalanceAvailabilityDurationModifierEnum balanceAvailabilityDurationModifier)

    • getBalanceAvailabilityDurationModifier

      @Nullable public BalanceDefinition.BalanceAvailabilityDurationModifierEnum getBalanceAvailabilityDurationModifier()
      startOfPeriod depicts the balancy expiry on start of day/week/month/year. endOfPeriod depicts the balancy expiry on end of day/week/month/year
      Returns:
      balanceAvailabilityDurationModifier

    • setBalanceAvailabilityDurationModifier

      public void setBalanceAvailabilityDurationModifier(@Nullable BalanceDefinition.BalanceAvailabilityDurationModifierEnum balanceAvailabilityDurationModifier)

    • balanceAvailabilityDurationUnit

      public BalanceDefinition balanceAvailabilityDurationUnit(@Nullable String balanceAvailabilityDurationUnit)

    • getBalanceAvailabilityDurationUnit

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

    • setBalanceAvailabilityDurationUnit

      public void setBalanceAvailabilityDurationUnit(@Nullable String balanceAvailabilityDurationUnit)

    • balanceAvailabilityDurationValue

      public BalanceDefinition balanceAvailabilityDurationValue(@Nullable Integer balanceAvailabilityDurationValue)

    • getBalanceAvailabilityDurationValue

      @Nullable public Integer getBalanceAvailabilityDurationValue()
      Number of days/weeks/month/year for balance expiry
      Returns:
      balanceAvailabilityDurationValue

    • setBalanceAvailabilityDurationValue

      public void setBalanceAvailabilityDurationValue(@Nullable Integer balanceAvailabilityDurationValue)

    • balanceExpirationDate

      public BalanceDefinition balanceExpirationDate(@Nullable OffsetDateTime balanceExpirationDate)

    • getBalanceExpirationDate

      @Nullable public OffsetDateTime getBalanceExpirationDate()
      Date when the balance expires and can no longer be used, in dd/mm format. The balance will be expired when this date appears next in the calendar and only one of balanceExpirationDate or balance availability fields can be used.
      Returns:
      balanceExpirationDate

    • setBalanceExpirationDate

      public void setBalanceExpirationDate(@Nullable OffsetDateTime balanceExpirationDate)

    • balanceOptionAmountOvertakingStrategy

      public BalanceDefinition balanceOptionAmountOvertakingStrategy(@Nullable String balanceOptionAmountOvertakingStrategy)

    • getBalanceOptionAmountOvertakingStrategy

      @Nullable public String getBalanceOptionAmountOvertakingStrategy()
      Partial enables partial credit of balance if maximum balance limit is reaching. Strict enables rejection of transaction if it will breach the max credit amount limit.
      Returns:
      balanceOptionAmountOvertakingStrategy

    • setBalanceOptionAmountOvertakingStrategy

      public void setBalanceOptionAmountOvertakingStrategy(@Nullable String balanceOptionAmountOvertakingStrategy)

    • balanceOptionCreditRounding

      public BalanceDefinition balanceOptionCreditRounding(@Nullable String balanceOptionCreditRounding)

    • getBalanceOptionCreditRounding

      @Nullable public String getBalanceOptionCreditRounding()
      Rounding strategy for credit transactions.
      Returns:
      balanceOptionCreditRounding

    • setBalanceOptionCreditRounding

      public void setBalanceOptionCreditRounding(@Nullable String balanceOptionCreditRounding)

    • balanceOptionDebitRounding

      public BalanceDefinition balanceOptionDebitRounding(@Nullable String balanceOptionDebitRounding)

    • getBalanceOptionDebitRounding

      @Nullable public String getBalanceOptionDebitRounding()
      Rounding strategy for debit transactions.
      Returns:
      balanceOptionDebitRounding

    • setBalanceOptionDebitRounding

      public void setBalanceOptionDebitRounding(@Nullable String balanceOptionDebitRounding)

    • createdAt

      public BalanceDefinition createdAt(@Nullable OffsetDateTime createdAt)

    • getCreatedAt

      @Nullable public OffsetDateTime getCreatedAt()
      Timestamp of balance definition creation.
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(@Nullable OffsetDateTime createdAt)

    • deletedAt

      public BalanceDefinition deletedAt(@Nullable String deletedAt)

    • getDeletedAt

      @Nullable public String getDeletedAt()
      Timestamp of balance definition deletion (nullable).
      Returns:
      deletedAt

    • setDeletedAt

      public void setDeletedAt(@Nullable String deletedAt)

    • description

      public BalanceDefinition description(@Nullable String description)

    • getDescription

      @Nullable public String getDescription()
      Short description of the balance definition.
      Returns:
      description

    • setDescription

      public void setDescription(@Nullable String description)

    • id

      public BalanceDefinition id(@Nullable String id)

    • getId

      @Nullable public String getId()
      Unique identifier for the balance definition.
      Returns:
      id

    • setId

      public void setId(@Nullable String id)

    • imageRef

      public BalanceDefinition imageRef(@Nullable String imageRef)

    • getImageRef

      @Nullable public String getImageRef()
      Optional image reference URL.
      Returns:
      imageRef

    • setImageRef

      public void setImageRef(@Nullable String imageRef)

    • maxAmount

      public BalanceDefinition maxAmount(@Nullable BigDecimal maxAmount)

    • getMaxAmount

      @Nullable public BigDecimal getMaxAmount()
      Maximum allowable balance.
      Returns:
      maxAmount

    • setMaxAmount

      public void setMaxAmount(@Nullable BigDecimal maxAmount)

    • maxCreditAmountLimit

      public BalanceDefinition maxCreditAmountLimit(@Nullable BigDecimal maxCreditAmountLimit)

    • getMaxCreditAmountLimit

      @Nullable public BigDecimal getMaxCreditAmountLimit()
      Max credit allowed per operation.
      Returns:
      maxCreditAmountLimit

    • setMaxCreditAmountLimit

      public void setMaxCreditAmountLimit(@Nullable BigDecimal maxCreditAmountLimit)

    • maxDebitAmountLimit

      public BalanceDefinition maxDebitAmountLimit(@Nullable BigDecimal maxDebitAmountLimit)

    • getMaxDebitAmountLimit

      @Nullable public BigDecimal getMaxDebitAmountLimit()
      Max debit allowed per operation.
      Returns:
      maxDebitAmountLimit

    • setMaxDebitAmountLimit

      public void setMaxDebitAmountLimit(@Nullable BigDecimal maxDebitAmountLimit)

    • meta

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

    • putMetaItem

      public BalanceDefinition putMetaItem(String key, Object metaItem)

    • getMeta

      @Nullable public Map<String,Object> getMeta()
      Additional metadata for the balance definition.
      Returns:
      meta

    • setMeta

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

    • minAmount

      public BalanceDefinition minAmount(@Nullable BigDecimal minAmount)

    • getMinAmount

      @Nullable public BigDecimal getMinAmount()
      Minimum allowable balance.
      Returns:
      minAmount

    • setMinAmount

      public void setMinAmount(@Nullable BigDecimal minAmount)

    • name

      public BalanceDefinition name(@Nullable String name)

    • getName

      @Nullable public String getName()
      Name of the balance definition.
      Returns:
      name

    • setName

      public void setName(@Nullable String name)

    • unit

      public BalanceDefinition unit(@Nullable String unit)

    • getUnit

      @Nullable public String getUnit()
      Unit of balance (e.g., points, currency).
      Returns:
      unit

    • setUnit

      public void setUnit(@Nullable String unit)

    • updatedAt

      public BalanceDefinition updatedAt(@Nullable String updatedAt)

    • getUpdatedAt

      @Nullable public String getUpdatedAt()
      Timestamp of the last update.
      Returns:
      updatedAt

    • setUpdatedAt

      public void setUpdatedAt(@Nullable String updatedAt)

    • 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