Package software.xdev.brevo.model

Class UpdateBalanceDefinitionPayload

java.lang.Object

software.xdev.brevo.model.UpdateBalanceDefinitionPayload

public class UpdateBalanceDefinitionPayload
extends Object

Payload for updating an existing balance definition, including expiry rules, rounding strategies, and constraints.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	UpdateBalanceDefinitionPayload.BalanceAvailabilityDurationModifierEnum	Defines when the balance expires within the selected duration.
static enum	UpdateBalanceDefinitionPayload.BalanceAvailabilityDurationUnitEnum	Unit of time for balance validity.
static enum	UpdateBalanceDefinitionPayload.BalanceOptionAmountOvertakingStrategyEnum	Defines whether partial credit is allowed when reaching max balance.
static enum	UpdateBalanceDefinitionPayload.BalanceOptionCreditRoundingEnum	Rounding strategy for credit transactions.
static enum	UpdateBalanceDefinitionPayload.BalanceOptionDebitRoundingEnum	Rounding strategy for debit transactions.
static enum	UpdateBalanceDefinitionPayload.UnitEnum	Unit of balance measurement.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_BALANCE_AVAILABILITY_DURATION_MODIFIER
static final String	JSON_PROPERTY_BALANCE_AVAILABILITY_DURATION_UNIT
static final String	JSON_PROPERTY_BALANCE_AVAILABILITY_DURATION_VALUE
static final String	JSON_PROPERTY_BALANCE_EXPIRATION_DATE
static final String	JSON_PROPERTY_BALANCE_OPTION_AMOUNT_OVERTAKING_STRATEGY
static final String	JSON_PROPERTY_BALANCE_OPTION_CREDIT_ROUNDING
static final String	JSON_PROPERTY_BALANCE_OPTION_DEBIT_ROUNDING
static final String	JSON_PROPERTY_DESCRIPTION
static final String	JSON_PROPERTY_IMAGE_REF
static final String	JSON_PROPERTY_MAX_AMOUNT
static final String	JSON_PROPERTY_MAX_CREDIT_AMOUNT_LIMIT
static final String	JSON_PROPERTY_MAX_DEBIT_AMOUNT_LIMIT
static final String	JSON_PROPERTY_META
static final String	JSON_PROPERTY_MIN_AMOUNT
static final String	JSON_PROPERTY_NAME
static final String	JSON_PROPERTY_UNIT

Constructor Summary

Constructors

Constructor	Description
UpdateBalanceDefinitionPayload()

Method Summary

Modifier and Type	Method	Description
UpdateBalanceDefinitionPayload	balanceAvailabilityDurationModifier(UpdateBalanceDefinitionPayload.BalanceAvailabilityDurationModifierEnum balanceAvailabilityDurationModifier)
UpdateBalanceDefinitionPayload	balanceAvailabilityDurationUnit(UpdateBalanceDefinitionPayload.BalanceAvailabilityDurationUnitEnum balanceAvailabilityDurationUnit)
UpdateBalanceDefinitionPayload	balanceAvailabilityDurationValue(Integer balanceAvailabilityDurationValue)
UpdateBalanceDefinitionPayload	balanceExpirationDate(String balanceExpirationDate)
UpdateBalanceDefinitionPayload	balanceOptionAmountOvertakingStrategy(UpdateBalanceDefinitionPayload.BalanceOptionAmountOvertakingStrategyEnum balanceOptionAmountOvertakingStrategy)
UpdateBalanceDefinitionPayload	balanceOptionCreditRounding(UpdateBalanceDefinitionPayload.BalanceOptionCreditRoundingEnum balanceOptionCreditRounding)
UpdateBalanceDefinitionPayload	balanceOptionDebitRounding(UpdateBalanceDefinitionPayload.BalanceOptionDebitRoundingEnum balanceOptionDebitRounding)
UpdateBalanceDefinitionPayload	description(String description)
boolean	equals(Object o)
UpdateBalanceDefinitionPayload.BalanceAvailabilityDurationModifierEnum	getBalanceAvailabilityDurationModifier()	Defines when the balance expires within the selected duration.
UpdateBalanceDefinitionPayload.BalanceAvailabilityDurationUnitEnum	getBalanceAvailabilityDurationUnit()	Unit of time for balance validity.
Integer	getBalanceAvailabilityDurationValue()	Number of time units before the balance expires.
String	getBalanceExpirationDate()	Expiration date (`dd/mm` format) or empty if not applicable.
UpdateBalanceDefinitionPayload.BalanceOptionAmountOvertakingStrategyEnum	getBalanceOptionAmountOvertakingStrategy()	Defines whether partial credit is allowed when reaching max balance.
UpdateBalanceDefinitionPayload.BalanceOptionCreditRoundingEnum	getBalanceOptionCreditRounding()	Rounding strategy for credit transactions.
UpdateBalanceDefinitionPayload.BalanceOptionDebitRoundingEnum	getBalanceOptionDebitRounding()	Rounding strategy for debit transactions.
String	getDescription()	Short description of the balance definition.
String	getImageRef()	URL of an optional image reference.
BigDecimal	getMaxAmount()	Maximum allowable balance amount.
BigDecimal	getMaxCreditAmountLimit()	Maximum credit allowed per operation.
BigDecimal	getMaxDebitAmountLimit()	Maximum debit allowed per operation.
Map<String,Object>	getMeta()	Optional metadata for the balance definition.
BigDecimal	getMinAmount()	Minimum allowable balance amount.
String	getName()	Name of the balance definition.
UpdateBalanceDefinitionPayload.UnitEnum	getUnit()	Unit of balance measurement.
int	hashCode()
UpdateBalanceDefinitionPayload	imageRef(String imageRef)
UpdateBalanceDefinitionPayload	maxAmount(BigDecimal maxAmount)
UpdateBalanceDefinitionPayload	maxCreditAmountLimit(BigDecimal maxCreditAmountLimit)
UpdateBalanceDefinitionPayload	maxDebitAmountLimit(BigDecimal maxDebitAmountLimit)
UpdateBalanceDefinitionPayload	meta(Map<String,Object> meta)
UpdateBalanceDefinitionPayload	minAmount(BigDecimal minAmount)
UpdateBalanceDefinitionPayload	name(String name)
UpdateBalanceDefinitionPayload	putMetaItem(String key, Object metaItem)
void	setBalanceAvailabilityDurationModifier(UpdateBalanceDefinitionPayload.BalanceAvailabilityDurationModifierEnum balanceAvailabilityDurationModifier)
void	setBalanceAvailabilityDurationUnit(UpdateBalanceDefinitionPayload.BalanceAvailabilityDurationUnitEnum balanceAvailabilityDurationUnit)
void	setBalanceAvailabilityDurationValue(Integer balanceAvailabilityDurationValue)
void	setBalanceExpirationDate(String balanceExpirationDate)
void	setBalanceOptionAmountOvertakingStrategy(UpdateBalanceDefinitionPayload.BalanceOptionAmountOvertakingStrategyEnum balanceOptionAmountOvertakingStrategy)
void	setBalanceOptionCreditRounding(UpdateBalanceDefinitionPayload.BalanceOptionCreditRoundingEnum balanceOptionCreditRounding)
void	setBalanceOptionDebitRounding(UpdateBalanceDefinitionPayload.BalanceOptionDebitRoundingEnum balanceOptionDebitRounding)
void	setDescription(String description)
void	setImageRef(String imageRef)
void	setMaxAmount(BigDecimal maxAmount)
void	setMaxCreditAmountLimit(BigDecimal maxCreditAmountLimit)
void	setMaxDebitAmountLimit(BigDecimal maxDebitAmountLimit)
void	setMeta(Map<String,Object> meta)
void	setMinAmount(BigDecimal minAmount)
void	setName(String name)
void	setUnit(UpdateBalanceDefinitionPayload.UnitEnum unit)
String	toString()
String	toUrlQueryString()	Convert the instance into URL query string.
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.
UpdateBalanceDefinitionPayload	unit(UpdateBalanceDefinitionPayload.UnitEnum unit)

Methods inherited from class java.lang.Object

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

Field Details

JSON_PROPERTY_BALANCE_AVAILABILITY_DURATION_MODIFIER

public static final String JSON_PROPERTY_BALANCE_AVAILABILITY_DURATION_MODIFIER

See Also:

• Constant Field Values

JSON_PROPERTY_BALANCE_AVAILABILITY_DURATION_UNIT

public static final String JSON_PROPERTY_BALANCE_AVAILABILITY_DURATION_UNIT

See Also:

• Constant Field Values

JSON_PROPERTY_BALANCE_AVAILABILITY_DURATION_VALUE

public static final String JSON_PROPERTY_BALANCE_AVAILABILITY_DURATION_VALUE

See Also:

• Constant Field Values

JSON_PROPERTY_BALANCE_EXPIRATION_DATE

public static final String JSON_PROPERTY_BALANCE_EXPIRATION_DATE

See Also:

• Constant Field Values

JSON_PROPERTY_BALANCE_OPTION_AMOUNT_OVERTAKING_STRATEGY

public static final String JSON_PROPERTY_BALANCE_OPTION_AMOUNT_OVERTAKING_STRATEGY

See Also:

• Constant Field Values

JSON_PROPERTY_BALANCE_OPTION_CREDIT_ROUNDING

public static final String JSON_PROPERTY_BALANCE_OPTION_CREDIT_ROUNDING

See Also:

• Constant Field Values

JSON_PROPERTY_BALANCE_OPTION_DEBIT_ROUNDING

public static final String JSON_PROPERTY_BALANCE_OPTION_DEBIT_ROUNDING

See Also:

• Constant Field Values

JSON_PROPERTY_DESCRIPTION

public static final String JSON_PROPERTY_DESCRIPTION

See Also:

• Constant Field Values

JSON_PROPERTY_IMAGE_REF

public static final String JSON_PROPERTY_IMAGE_REF

See Also:

• Constant Field Values

JSON_PROPERTY_MAX_AMOUNT

public static final String JSON_PROPERTY_MAX_AMOUNT

See Also:

• Constant Field Values

JSON_PROPERTY_MAX_CREDIT_AMOUNT_LIMIT

public static final String JSON_PROPERTY_MAX_CREDIT_AMOUNT_LIMIT

See Also:

• Constant Field Values

JSON_PROPERTY_MAX_DEBIT_AMOUNT_LIMIT

public static final String JSON_PROPERTY_MAX_DEBIT_AMOUNT_LIMIT

See Also:

• Constant Field Values

JSON_PROPERTY_META

public static final String JSON_PROPERTY_META

See Also:

• Constant Field Values

JSON_PROPERTY_MIN_AMOUNT

public static final String JSON_PROPERTY_MIN_AMOUNT

See Also:

• Constant Field Values

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_UNIT

public static final String JSON_PROPERTY_UNIT

See Also:

• Constant Field Values

Constructor Details

UpdateBalanceDefinitionPayload

public UpdateBalanceDefinitionPayload()

Method Details

balanceAvailabilityDurationModifier

public UpdateBalanceDefinitionPayload balanceAvailabilityDurationModifier(@Nullable
 UpdateBalanceDefinitionPayload.BalanceAvailabilityDurationModifierEnum balanceAvailabilityDurationModifier)

getBalanceAvailabilityDurationModifier

@Nullable
public UpdateBalanceDefinitionPayload.BalanceAvailabilityDurationModifierEnum getBalanceAvailabilityDurationModifier()

Defines when the balance expires within the selected duration.

Returns:

balanceAvailabilityDurationModifier

setBalanceAvailabilityDurationModifier

public void setBalanceAvailabilityDurationModifier(@Nullable
 UpdateBalanceDefinitionPayload.BalanceAvailabilityDurationModifierEnum balanceAvailabilityDurationModifier)

balanceAvailabilityDurationUnit

public UpdateBalanceDefinitionPayload balanceAvailabilityDurationUnit(@Nullable
 UpdateBalanceDefinitionPayload.BalanceAvailabilityDurationUnitEnum balanceAvailabilityDurationUnit)

getBalanceAvailabilityDurationUnit

@Nullable
public UpdateBalanceDefinitionPayload.BalanceAvailabilityDurationUnitEnum getBalanceAvailabilityDurationUnit()

Unit of time for balance validity.

Returns:

balanceAvailabilityDurationUnit

setBalanceAvailabilityDurationUnit

public void setBalanceAvailabilityDurationUnit(@Nullable
 UpdateBalanceDefinitionPayload.BalanceAvailabilityDurationUnitEnum balanceAvailabilityDurationUnit)

balanceAvailabilityDurationValue

public UpdateBalanceDefinitionPayload balanceAvailabilityDurationValue(@Nullable
 Integer balanceAvailabilityDurationValue)

getBalanceAvailabilityDurationValue

@Nullable
public Integer getBalanceAvailabilityDurationValue()

Number of time units before the balance expires.

Returns:

balanceAvailabilityDurationValue

setBalanceAvailabilityDurationValue

public void setBalanceAvailabilityDurationValue(@Nullable
 Integer balanceAvailabilityDurationValue)

balanceExpirationDate

public UpdateBalanceDefinitionPayload balanceExpirationDate(@Nullable
 String balanceExpirationDate)

getBalanceExpirationDate

@Nullable
public String getBalanceExpirationDate()

Expiration date (`dd/mm` format) or empty if not applicable.

Returns:

balanceExpirationDate

setBalanceExpirationDate

public void setBalanceExpirationDate(@Nullable
 String balanceExpirationDate)

balanceOptionAmountOvertakingStrategy

public UpdateBalanceDefinitionPayload balanceOptionAmountOvertakingStrategy(@Nullable
 UpdateBalanceDefinitionPayload.BalanceOptionAmountOvertakingStrategyEnum balanceOptionAmountOvertakingStrategy)

getBalanceOptionAmountOvertakingStrategy

@Nullable
public UpdateBalanceDefinitionPayload.BalanceOptionAmountOvertakingStrategyEnum getBalanceOptionAmountOvertakingStrategy()

Defines whether partial credit is allowed when reaching max balance.

Returns:

balanceOptionAmountOvertakingStrategy

setBalanceOptionAmountOvertakingStrategy

public void setBalanceOptionAmountOvertakingStrategy(@Nullable
 UpdateBalanceDefinitionPayload.BalanceOptionAmountOvertakingStrategyEnum balanceOptionAmountOvertakingStrategy)

balanceOptionCreditRounding

public UpdateBalanceDefinitionPayload balanceOptionCreditRounding(@Nullable
 UpdateBalanceDefinitionPayload.BalanceOptionCreditRoundingEnum balanceOptionCreditRounding)

getBalanceOptionCreditRounding

@Nullable
public UpdateBalanceDefinitionPayload.BalanceOptionCreditRoundingEnum getBalanceOptionCreditRounding()

Rounding strategy for credit transactions.

Returns:

balanceOptionCreditRounding

setBalanceOptionCreditRounding

public void setBalanceOptionCreditRounding(@Nullable
 UpdateBalanceDefinitionPayload.BalanceOptionCreditRoundingEnum balanceOptionCreditRounding)

balanceOptionDebitRounding

public UpdateBalanceDefinitionPayload balanceOptionDebitRounding(@Nullable
 UpdateBalanceDefinitionPayload.BalanceOptionDebitRoundingEnum balanceOptionDebitRounding)

getBalanceOptionDebitRounding

@Nullable
public UpdateBalanceDefinitionPayload.BalanceOptionDebitRoundingEnum getBalanceOptionDebitRounding()

Rounding strategy for debit transactions.

Returns:

balanceOptionDebitRounding

setBalanceOptionDebitRounding

public void setBalanceOptionDebitRounding(@Nullable
 UpdateBalanceDefinitionPayload.BalanceOptionDebitRoundingEnum balanceOptionDebitRounding)

description

public UpdateBalanceDefinitionPayload description(@Nullable
 String description)

getDescription

@Nullable
public String getDescription()

Short description of the balance definition.

Returns:

description

setDescription

public void setDescription(@Nullable
 String description)

imageRef

public UpdateBalanceDefinitionPayload imageRef(@Nullable
 String imageRef)

getImageRef

@Nullable
public String getImageRef()

URL of an optional image reference.

Returns:

imageRef

setImageRef

public void setImageRef(@Nullable
 String imageRef)

maxAmount

public UpdateBalanceDefinitionPayload maxAmount(@Nullable
 BigDecimal maxAmount)

getMaxAmount

@Nullable
public BigDecimal getMaxAmount()

Maximum allowable balance amount.

Returns:

maxAmount

setMaxAmount

public void setMaxAmount(@Nullable
 BigDecimal maxAmount)

maxCreditAmountLimit

public UpdateBalanceDefinitionPayload maxCreditAmountLimit(@Nullable
 BigDecimal maxCreditAmountLimit)

getMaxCreditAmountLimit

@Nullable
public BigDecimal getMaxCreditAmountLimit()

Maximum credit allowed per operation.

Returns:

maxCreditAmountLimit

setMaxCreditAmountLimit

public void setMaxCreditAmountLimit(@Nullable
 BigDecimal maxCreditAmountLimit)

maxDebitAmountLimit

public UpdateBalanceDefinitionPayload maxDebitAmountLimit(@Nullable
 BigDecimal maxDebitAmountLimit)

getMaxDebitAmountLimit

@Nullable
public BigDecimal getMaxDebitAmountLimit()

Maximum debit allowed per operation.

Returns:

maxDebitAmountLimit

setMaxDebitAmountLimit

public void setMaxDebitAmountLimit(@Nullable
 BigDecimal maxDebitAmountLimit)

meta

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

putMetaItem

public UpdateBalanceDefinitionPayload putMetaItem(String key,
 Object metaItem)

getMeta

@Nullable
public Map<String,Object> getMeta()

Optional metadata for the balance definition.

Returns:

meta

setMeta

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

minAmount

public UpdateBalanceDefinitionPayload minAmount(@Nullable
 BigDecimal minAmount)

getMinAmount

@Nullable
public BigDecimal getMinAmount()

Minimum allowable balance amount.

Returns:

minAmount

setMinAmount

public void setMinAmount(@Nullable
 BigDecimal minAmount)

name

public UpdateBalanceDefinitionPayload name(@Nonnull
 String name)

getName

@Nonnull
public String getName()

Name of the balance definition.

Returns:

name

setName

public void setName(@Nonnull
 String name)

unit

public UpdateBalanceDefinitionPayload unit(@Nonnull
 UpdateBalanceDefinitionPayload.UnitEnum unit)

getUnit

@Nonnull
public UpdateBalanceDefinitionPayload.UnitEnum getUnit()

Unit of balance measurement.

Returns:

unit

setUnit

public void setUnit(@Nonnull
 UpdateBalanceDefinitionPayload.UnitEnum unit)

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