Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 1.97 KB

CheckBudgetBlock.md

File metadata and controls

49 lines (34 loc) · 1.97 KB

CheckBudgetBlock

A block that verifies if a specific budget has sufficient limit available, and whether this limit meets or exceeds a specific value.

Properties

Name Type Description Notes
id String Unique identifier for this block. [optional] [readonly]
type String Identifies the block variant and determines which additional properties are present in it.
tags List<String> Semantic labels attached to this block. [optional] [readonly]
operator OperatorEnum The comparison operator applied to the limit. `available` checks if there is budget available for a given limitable action; `enoughFor` checks if the available budget meets or exceeds a specific value limit.
action ActionEnum The limitable action to check.
value BigDecimal The value to check against when using the `enoughFor` operator. [optional]
onFailure List<Object> Promotion blocks evaluated when this block fails or returns false. [optional]

Enum: OperatorEnum

Name Value
AVAILABLE "available"
ENOUGHFOR "enoughFor"

Enum: ActionEnum

Name Value
REDEEMCOUPON "redeemCoupon"
REDEEMREFERRAL "redeemReferral"
SETDISCOUNT "setDiscount"
CREATECOUPON "createCoupon"
CREATEREFERRAL "createReferral"
SETDISCOUNTEFFECT "setDiscountEffect"
CREATELOYALTYPOINTS "createLoyaltyPoints"
CREATELOYALTYPOINTSEFFECT "createLoyaltyPointsEffect"
REDEEMLOYALTYPOINTS "redeemLoyaltyPoints"
REDEEMLOYALTYPOINTSEFFECT "redeemLoyaltyPointsEffect"
AWARDGIVEAWAY "awardGiveaway"
ADDFREEITEMEFFECT "addFreeItemEffect"
CUSTOMEFFECT "customEffect"
CALLAPI "callApi"