@salesforce/b2c-tooling-sdk 1.19.0 → 1.20.0

package/data/script-api/dw.campaign.ABTestSegment.md

@@ -1,107 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class ABTestSegment
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.object.PersistentObject](dw.object.PersistentObject.md)
-    - [dw.campaign.ABTestSegment](dw.campaign.ABTestSegment.md)
-
-Object representing an AB-test segment in the Commerce Cloud Digital.
-
-
-Each AB-test defines 1 or more segments to which customers are randomly
-assigned by the platform when they qualify for the AB-test. Customers are
-assigned to segments according to allocation percentages controlled by the
-merchant. Each AB-test segment defines a set of "experiences" that the
-merchant is testing and which which apply only to the customers in that
-segment.  There is always one "control" segment which contains only the
-default set of experiences for that site.
-
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [ABTest](#abtest): [ABTest](dw.campaign.ABTest.md) `(read-only)` | Get the AB-test to which this segment belongs. |
-| [ID](#id): [String](TopLevel.String.md) `(read-only)` | Get the ID of the AB-test segment. |
-| [controlSegment](#controlsegment): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns true if this is the "control segment" for the AB-test, meaning  the segment that has no experiences associated with it. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getABTest](dw.campaign.ABTestSegment.md#getabtest)() | Get the AB-test to which this segment belongs. |
-| [getID](dw.campaign.ABTestSegment.md#getid)() | Get the ID of the AB-test segment. |
-| [isControlSegment](dw.campaign.ABTestSegment.md#iscontrolsegment)() | Returns true if this is the "control segment" for the AB-test, meaning  the segment that has no experiences associated with it. |
-
-### Methods inherited from class PersistentObject
-
-[getCreationDate](dw.object.PersistentObject.md#getcreationdate), [getLastModified](dw.object.PersistentObject.md#getlastmodified), [getUUID](dw.object.PersistentObject.md#getuuid)
-### Methods inherited from class Object
-
-[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
-## Property Details
-
-### ABTest
-- ABTest: [ABTest](dw.campaign.ABTest.md) `(read-only)`
-  - : Get the AB-test to which this segment belongs.
-
-
----
-
-### ID
-- ID: [String](TopLevel.String.md) `(read-only)`
-  - : Get the ID of the AB-test segment.
-
-
----
-
-### controlSegment
-- controlSegment: [Boolean](TopLevel.Boolean.md) `(read-only)`
-  - : Returns true if this is the "control segment" for the AB-test, meaning
-      the segment that has no experiences associated with it.
-
-
-
----
-
-## Method Details
-
-### getABTest()
-- getABTest(): [ABTest](dw.campaign.ABTest.md)
-  - : Get the AB-test to which this segment belongs.
-
-    **Returns:**
-    - the AB-test to which this segment belongs.
-
-
----
-
-### getID()
-- getID(): [String](TopLevel.String.md)
-  - : Get the ID of the AB-test segment.
-
-    **Returns:**
-    - the ID of the AB-test segment.
-
-
----
-
-### isControlSegment()
-- isControlSegment(): [Boolean](TopLevel.Boolean.md)
-  - : Returns true if this is the "control segment" for the AB-test, meaning
-      the segment that has no experiences associated with it.
-
-
-    **Returns:**
-    - true if this segment is the "control segment" for the AB-test, or
-              false otherwise.
-
-
-
----
-
-<!-- prettier-ignore-end -->

package/data/script-api/dw.campaign.AmountDiscount.md

@@ -1,70 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class AmountDiscount
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.campaign.Discount](dw.campaign.Discount.md)
-    - [dw.campaign.AmountDiscount](dw.campaign.AmountDiscount.md)
-
-Represents an _amount-off_ discount in the discount plan, for example
-"$10 off all orders $100 or more".
-
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [amount](#amount): [Number](TopLevel.Number.md) `(read-only)` | Returns the discount amount, for example 10.00 for a "$10 off" discount. |
-
-## Constructor Summary
-
-| Constructor | Description |
-| --- | --- |
-| [AmountDiscount](#amountdiscountnumber)([Number](TopLevel.Number.md)) | Create an amount-discount on the fly. |
-
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getAmount](dw.campaign.AmountDiscount.md#getamount)() | Returns the discount amount, for example 10.00 for a "$10 off" discount. |
-
-### Methods inherited from class Discount
-
-[getItemPromotionTiers](dw.campaign.Discount.md#getitempromotiontiers), [getPromotion](dw.campaign.Discount.md#getpromotion), [getPromotionTier](dw.campaign.Discount.md#getpromotiontier), [getQuantity](dw.campaign.Discount.md#getquantity), [getType](dw.campaign.Discount.md#gettype)
-### Methods inherited from class Object
-
-[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
-## Property Details
-
-### amount
-- amount: [Number](TopLevel.Number.md) `(read-only)`
-  - : Returns the discount amount, for example 10.00 for a "$10 off" discount.
-
-
----
-
-## Constructor Details
-
-### AmountDiscount(Number)
-- AmountDiscount(amount: [Number](TopLevel.Number.md))
-  - : Create an amount-discount on the fly. Can be used to create a custom price adjustment.
-
-    **Parameters:**
-    - amount - amount off, e.g. 15.00 for a "15$ off" discount
-
-
----
-
-## Method Details
-
-### getAmount()
-- getAmount(): [Number](TopLevel.Number.md)
-  - : Returns the discount amount, for example 10.00 for a "$10 off" discount.
-
-    **Returns:**
-    - Discount amount
-
-
----
-
-<!-- prettier-ignore-end -->

package/data/script-api/dw.campaign.ApproachingDiscount.md

@@ -1,157 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class ApproachingDiscount
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.campaign.ApproachingDiscount](dw.campaign.ApproachingDiscount.md)
-
-Transient class representing a discount that a [LineItemCtnr](dw.order.LineItemCtnr.md)
-"almost" qualifies for based on the amount of merchandise in it. Storefronts
-can display information about approaching discounts to customers in order to
-entice them to buy more merchandise.
-
-
-Approaching discounts are calculated on the basis of a
-[DiscountPlan](dw.campaign.DiscountPlan.md) instead of a LineItemCtnr itself. When one
-of [PromotionMgr.getDiscounts(LineItemCtnr)](dw.campaign.PromotionMgr.md#getdiscountslineitemctnr) or
-[PromotionMgr.getDiscounts(LineItemCtnr, PromotionPlan)](dw.campaign.PromotionMgr.md#getdiscountslineitemctnr-promotionplan) is
-called, the promotions engine calculates the discounts the LineItemCtnr
-receives based on the promotions in context, and also tries to determine the
-discounts the LineItemCtnr would receive if additional merchandise were
-added. DiscountPlan provides different methods to retrieve this approaching
-discount info. Merchants can use these fine-grained methods to display
-information about approaching order discounts on the cart page, and
-approaching shipping discounts on the shipping method page during checkout,
-for example.
-
-
-The merchant may include or exclude individual promotions from being included
-in this list, and define distance thresholds when configuring their
-promotions.
-
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [conditionThreshold](#conditionthreshold): [Money](dw.value.Money.md) `(read-only)` | The amount of merchandise required in the cart in order to receive the  discount. |
-| [discount](#discount): [Discount](dw.campaign.Discount.md) `(read-only)` | The discount that the customer will receive if he adds more merchandise  to the cart. |
-| [distanceFromConditionThreshold](#distancefromconditionthreshold): [Money](dw.value.Money.md) `(read-only)` | Convenience method that returns  `getConditionThreshold().subtract(getMerchandiseValue())` |
-| [merchandiseTotal](#merchandisetotal): [Money](dw.value.Money.md) `(read-only)` | The amount of merchandise in the cart contributing towards the condition  threshold. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getConditionThreshold](dw.campaign.ApproachingDiscount.md#getconditionthreshold)() | The amount of merchandise required in the cart in order to receive the  discount. |
-| [getDiscount](dw.campaign.ApproachingDiscount.md#getdiscount)() | The discount that the customer will receive if he adds more merchandise  to the cart. |
-| [getDistanceFromConditionThreshold](dw.campaign.ApproachingDiscount.md#getdistancefromconditionthreshold)() | Convenience method that returns  `getConditionThreshold().subtract(getMerchandiseValue())` |
-| [getMerchandiseTotal](dw.campaign.ApproachingDiscount.md#getmerchandisetotal)() | The amount of merchandise in the cart contributing towards the condition  threshold. |
-
-### Methods inherited from class Object
-
-[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
-## Property Details
-
-### conditionThreshold
-- conditionThreshold: [Money](dw.value.Money.md) `(read-only)`
-  - : The amount of merchandise required in the cart in order to receive the
-      discount. For an order promotion "Get 15% off orders of $100 or more",
-      the condition threshold is $100.00.
-
-
-
----
-
-### discount
-- discount: [Discount](dw.campaign.Discount.md) `(read-only)`
-  - : The discount that the customer will receive if he adds more merchandise
-      to the cart. For an order promotion "Get 15% off orders of $100 or more",
-      the discount is a PercentageDiscount object.
-
-
-
----
-
-### distanceFromConditionThreshold
-- distanceFromConditionThreshold: [Money](dw.value.Money.md) `(read-only)`
-  - : Convenience method that returns
-      `getConditionThreshold().subtract(getMerchandiseValue())`
-
-
-
----
-
-### merchandiseTotal
-- merchandiseTotal: [Money](dw.value.Money.md) `(read-only)`
-  - : The amount of merchandise in the cart contributing towards the condition
-      threshold. This will always be less than the condition threshold.
-
-
-
----
-
-## Method Details
-
-### getConditionThreshold()
-- getConditionThreshold(): [Money](dw.value.Money.md)
-  - : The amount of merchandise required in the cart in order to receive the
-      discount. For an order promotion "Get 15% off orders of $100 or more",
-      the condition threshold is $100.00.
-
-
-    **Returns:**
-    - The amount of merchandise required in the cart in order to
-              receive the discount.
-
-
-
----
-
-### getDiscount()
-- getDiscount(): [Discount](dw.campaign.Discount.md)
-  - : The discount that the customer will receive if he adds more merchandise
-      to the cart. For an order promotion "Get 15% off orders of $100 or more",
-      the discount is a PercentageDiscount object.
-
-
-    **Returns:**
-    - The discount that the customer will receive if he adds more
-              merchandise to the cart.
-
-
-
----
-
-### getDistanceFromConditionThreshold()
-- getDistanceFromConditionThreshold(): [Money](dw.value.Money.md)
-  - : Convenience method that returns
-      `getConditionThreshold().subtract(getMerchandiseValue())`
-
-
-    **Returns:**
-    - The amount of money needed to add to the order or shipment in
-              order to receive the discount.
-
-
-
----
-
-### getMerchandiseTotal()
-- getMerchandiseTotal(): [Money](dw.value.Money.md)
-  - : The amount of merchandise in the cart contributing towards the condition
-      threshold. This will always be less than the condition threshold.
-
-
-    **Returns:**
-    - The amount of merchandise in the cart contributing towards the
-              condition threshold.
-
-
-
----
-
-<!-- prettier-ignore-end -->

package/data/script-api/dw.campaign.BonusChoiceDiscount.md

@@ -1,190 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class BonusChoiceDiscount
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.campaign.Discount](dw.campaign.Discount.md)
-    - [dw.campaign.BonusChoiceDiscount](dw.campaign.BonusChoiceDiscount.md)
-
-Represents a _choice of bonus products_ discount in the discount plan,
-for example "Choose 3 DVDs from a list of 20 options with your purchase of
-any DVD player."
-
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [bonusProducts](#bonusproducts): [List](dw.util.List.md) `(read-only)` | Get the list of bonus products which the customer is allowed to choose  from for this discount. |
-| [maxBonusItems](#maxbonusitems): [Number](TopLevel.Number.md) `(read-only)` | Returns the maximum number of bonus items that a customer is entitled to  select for this discount. |
-| [ruleBased](#rulebased): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns true if this is a "rule based" bonus choice discount. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getBonusProductPrice](dw.campaign.BonusChoiceDiscount.md#getbonusproductpriceproduct)([Product](dw.catalog.Product.md)) | Get the effective price for the passed bonus product. |
-| [getBonusProducts](dw.campaign.BonusChoiceDiscount.md#getbonusproducts)() | Get the list of bonus products which the customer is allowed to choose  from for this discount. |
-| [getMaxBonusItems](dw.campaign.BonusChoiceDiscount.md#getmaxbonusitems)() | Returns the maximum number of bonus items that a customer is entitled to  select for this discount. |
-| [isRuleBased](dw.campaign.BonusChoiceDiscount.md#isrulebased)() | Returns true if this is a "rule based" bonus choice discount. |
-
-### Methods inherited from class Discount
-
-[getItemPromotionTiers](dw.campaign.Discount.md#getitempromotiontiers), [getPromotion](dw.campaign.Discount.md#getpromotion), [getPromotionTier](dw.campaign.Discount.md#getpromotiontier), [getQuantity](dw.campaign.Discount.md#getquantity), [getType](dw.campaign.Discount.md#gettype)
-### Methods inherited from class Object
-
-[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
-## Property Details
-
-### bonusProducts
-- bonusProducts: [List](dw.util.List.md) `(read-only)`
-  - : Get the list of bonus products which the customer is allowed to choose
-      from for this discount. This list is configured by a merchant entering a
-      list of SKUs for the discount. Products which do not exist in the system,
-      or are offline, or are not assigned to a category in the site catalog are
-      filtered out. Unavailable (i.e. out-of-stock) products are NOT filtered
-      out. This allows merchants to display out-of-stock bonus products with
-      appropriate messaging.
-      
-      
-      If a returned product is a master product, the customer is entitled to
-      choose from any variant. If the product is an option product, the
-      customer is entitled to choose any value for each option. Since the
-      promotions engine does not touch the value of the product option line
-      items, it is the responsibility of custom code to set option prices.
-      
-      
-      If the promotion is rule based, then this method will return an empty list.
-      A ProductSearchModel should be used to return the bonus products the
-      customer may choose from instead. See
-      [ProductSearchModel.PROMOTION_PRODUCT_TYPE_BONUS](dw.catalog.ProductSearchModel.md#promotion_product_type_bonus) and
-      [ProductSearchModel.setPromotionID(String)](dw.catalog.ProductSearchModel.md#setpromotionidstring)
-
-
-
----
-
-### maxBonusItems
-- maxBonusItems: [Number](TopLevel.Number.md) `(read-only)`
-  - : Returns the maximum number of bonus items that a customer is entitled to
-      select for this discount.
-
-
-
----
-
-### ruleBased
-- ruleBased: [Boolean](TopLevel.Boolean.md) `(read-only)`
-  - : Returns true if this is a "rule based" bonus choice discount.
-      For such discounts, there is no static list of bonus products
-      associated with the discount but rather a discounted product
-      rule associated with the promotion which defines the bonus
-      products. To retrieve the list of selectable bonus products for
-      display in the storefront, it is necessary to search for the
-      bonus products using the [ProductSearchModel](dw.catalog.ProductSearchModel.md)
-      API since the method [getBonusProducts()](dw.campaign.BonusChoiceDiscount.md#getbonusproducts) in this class
-      will always return an empty list. Furthermore, for rule based
-      bonus-choice discounts, [getBonusProductPrice(Product)](dw.campaign.BonusChoiceDiscount.md#getbonusproductpriceproduct)
-      will always return a price of 0.00 for bonus products.
-
-
-
----
-
-## Method Details
-
-### getBonusProductPrice(Product)
-- getBonusProductPrice(product: [Product](dw.catalog.Product.md)): [Number](TopLevel.Number.md)
-  - : Get the effective price for the passed bonus product. This is expected to
-      be one of the products returned by [getBonusProducts()](dw.campaign.BonusChoiceDiscount.md#getbonusproducts) with one
-      exception: If a master product is configured as a bonus product, this
-      implies that a customer may choose from any of its variants. In this
-      case, it is allowed to pass in a variant to this method and a price will
-      be returned. If the passed product is not a valid bonus product, this
-      method throws an exception.
-
-
-    **Parameters:**
-    - product - The bonus product to retrieve a price for, must not be             null.
-
-    **Returns:**
-    - The price of the passed bonus product as a Number.
-
-
----
-
-### getBonusProducts()
-- getBonusProducts(): [List](dw.util.List.md)
-  - : Get the list of bonus products which the customer is allowed to choose
-      from for this discount. This list is configured by a merchant entering a
-      list of SKUs for the discount. Products which do not exist in the system,
-      or are offline, or are not assigned to a category in the site catalog are
-      filtered out. Unavailable (i.e. out-of-stock) products are NOT filtered
-      out. This allows merchants to display out-of-stock bonus products with
-      appropriate messaging.
-      
-      
-      If a returned product is a master product, the customer is entitled to
-      choose from any variant. If the product is an option product, the
-      customer is entitled to choose any value for each option. Since the
-      promotions engine does not touch the value of the product option line
-      items, it is the responsibility of custom code to set option prices.
-      
-      
-      If the promotion is rule based, then this method will return an empty list.
-      A ProductSearchModel should be used to return the bonus products the
-      customer may choose from instead. See
-      [ProductSearchModel.PROMOTION_PRODUCT_TYPE_BONUS](dw.catalog.ProductSearchModel.md#promotion_product_type_bonus) and
-      [ProductSearchModel.setPromotionID(String)](dw.catalog.ProductSearchModel.md#setpromotionidstring)
-
-
-    **Returns:**
-    - An ordered list of bonus products that the customer may choose
-              from for this discount.
-
-
-
----
-
-### getMaxBonusItems()
-- getMaxBonusItems(): [Number](TopLevel.Number.md)
-  - : Returns the maximum number of bonus items that a customer is entitled to
-      select for this discount.
-
-
-    **Returns:**
-    - The maximum number of bonus items that this discount permits a
-              customer to select.
-
-
-
----
-
-### isRuleBased()
-- isRuleBased(): [Boolean](TopLevel.Boolean.md)
-  - : Returns true if this is a "rule based" bonus choice discount.
-      For such discounts, there is no static list of bonus products
-      associated with the discount but rather a discounted product
-      rule associated with the promotion which defines the bonus
-      products. To retrieve the list of selectable bonus products for
-      display in the storefront, it is necessary to search for the
-      bonus products using the [ProductSearchModel](dw.catalog.ProductSearchModel.md)
-      API since the method [getBonusProducts()](dw.campaign.BonusChoiceDiscount.md#getbonusproducts) in this class
-      will always return an empty list. Furthermore, for rule based
-      bonus-choice discounts, [getBonusProductPrice(Product)](dw.campaign.BonusChoiceDiscount.md#getbonusproductpriceproduct)
-      will always return a price of 0.00 for bonus products.
-
-
-    **Returns:**
-    - True if this is a rule-based bonus-choice discount, or
-              false if this discount defines a simple static list of
-              bonus products.
-
-
-
----
-
-<!-- prettier-ignore-end -->

package/data/script-api/dw.campaign.BonusDiscount.md

@@ -1,59 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class BonusDiscount
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.campaign.Discount](dw.campaign.Discount.md)
-    - [dw.campaign.BonusDiscount](dw.campaign.BonusDiscount.md)
-
-Represents a _bonus_ discount in the discount plan, for example
-"Get a free DVD with your purchase of any DVD player."
-
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [bonusProducts](#bonusproducts): [Collection](dw.util.Collection.md) `(read-only)` | Returns the bonus products associated with this discount that are in  stock, online and assigned to site catalog. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getBonusProducts](dw.campaign.BonusDiscount.md#getbonusproducts)() | Returns the bonus products associated with this discount that are in  stock, online and assigned to site catalog. |
-
-### Methods inherited from class Discount
-
-[getItemPromotionTiers](dw.campaign.Discount.md#getitempromotiontiers), [getPromotion](dw.campaign.Discount.md#getpromotion), [getPromotionTier](dw.campaign.Discount.md#getpromotiontier), [getQuantity](dw.campaign.Discount.md#getquantity), [getType](dw.campaign.Discount.md#gettype)
-### Methods inherited from class Object
-
-[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
-## Property Details
-
-### bonusProducts
-- bonusProducts: [Collection](dw.util.Collection.md) `(read-only)`
-  - : Returns the bonus products associated with this discount that are in
-      stock, online and assigned to site catalog.
-
-
-
----
-
-## Method Details
-
-### getBonusProducts()
-- getBonusProducts(): [Collection](dw.util.Collection.md)
-  - : Returns the bonus products associated with this discount that are in
-      stock, online and assigned to site catalog.
-
-
-    **Returns:**
-    - Collection of bonus products
-
-
----
-
-<!-- prettier-ignore-end -->