@salesforce/b2c-tooling-sdk 0.0.1 → 0.0.3

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

@@ -0,0 +1,271 @@
+<!-- prettier-ignore-start -->
+# Class Discount
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.campaign.Discount](dw.campaign.Discount.md)
+
+Superclass of all specific discount classes.
+
+
+## All Known Subclasses
+[AmountDiscount](dw.campaign.AmountDiscount.md), [BonusChoiceDiscount](dw.campaign.BonusChoiceDiscount.md), [BonusDiscount](dw.campaign.BonusDiscount.md), [FixedPriceDiscount](dw.campaign.FixedPriceDiscount.md), [FixedPriceShippingDiscount](dw.campaign.FixedPriceShippingDiscount.md), [FreeDiscount](dw.campaign.FreeDiscount.md), [FreeShippingDiscount](dw.campaign.FreeShippingDiscount.md), [PercentageDiscount](dw.campaign.PercentageDiscount.md), [PercentageOptionDiscount](dw.campaign.PercentageOptionDiscount.md), [PriceBookPriceDiscount](dw.campaign.PriceBookPriceDiscount.md), [TotalFixedPriceDiscount](dw.campaign.TotalFixedPriceDiscount.md)
+## Constant Summary
+
+| Constant | Description |
+| --- | --- |
+| [TYPE_AMOUNT](#type_amount): [String](TopLevel.String.md) = "AMOUNT" | Constant representing discounts of type _amount_. |
+| [TYPE_BONUS](#type_bonus): [String](TopLevel.String.md) = "BONUS" | Constant representing discounts of type _bonus_. |
+| [TYPE_BONUS_CHOICE](#type_bonus_choice): [String](TopLevel.String.md) = "BONUS_CHOICE" | Constant representing discounts of type _bonus choice_. |
+| [TYPE_FIXED_PRICE](#type_fixed_price): [String](TopLevel.String.md) = "FIXED_PRICE" | Constant representing discounts of type _fixed-price_. |
+| [TYPE_FIXED_PRICE_SHIPPING](#type_fixed_price_shipping): [String](TopLevel.String.md) = "FIXED_PRICE_SHIPPING" | Constant representing discounts of type _fixed price shipping_. |
+| [TYPE_FREE](#type_free): [String](TopLevel.String.md) = "FREE" | Constant representing discounts of type _free_. |
+| [TYPE_FREE_SHIPPING](#type_free_shipping): [String](TopLevel.String.md) = "FREE_SHIPPING" | Constant representing discounts of type _free shipping_. |
+| [TYPE_PERCENTAGE](#type_percentage): [String](TopLevel.String.md) = "PERCENTAGE" | Constant representing discounts of type _percentage_. |
+| [TYPE_PERCENTAGE_OFF_OPTIONS](#type_percentage_off_options): [String](TopLevel.String.md) = "PERCENTAGE_OFF_OPTIONS" | Constant representing discounts of type _percent off options_. |
+| [TYPE_PRICEBOOK_PRICE](#type_pricebook_price): [String](TopLevel.String.md) = "PRICE_BOOK_PRICE" | Constant representing discounts of type _price book price_. |
+| [TYPE_TOTAL_FIXED_PRICE](#type_total_fixed_price): [String](TopLevel.String.md) = "TOTAL_FIXED_PRICE" | Constant representing discounts of type _total fixed price_. |
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [itemPromotionTiers](#itempromotiontiers): [Map](dw.util.Map.md) `(read-only)` | Returns the tier index by quantity Id of Product promotion. |
+| [promotion](#promotion): [Promotion](dw.campaign.Promotion.md) `(read-only)` | Returns the promotion this discount is based on. |
+| [promotionTier](#promotiontier): [Number](TopLevel.Number.md) `(read-only)` | Returns the tier index for promotion at order level or bonus product. |
+| [quantity](#quantity): [Number](TopLevel.Number.md) `(read-only)` | Returns the quantity of the discount. |
+| [type](#type): [String](TopLevel.String.md) `(read-only)` | Returns the type of the discount. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getItemPromotionTiers](dw.campaign.Discount.md#getitempromotiontiers)() | Returns the tier index by quantity Id of Product promotion. |
+| [getPromotion](dw.campaign.Discount.md#getpromotion)() | Returns the promotion this discount is based on. |
+| [getPromotionTier](dw.campaign.Discount.md#getpromotiontier)() | Returns the tier index for promotion at order level or bonus product. |
+| [getQuantity](dw.campaign.Discount.md#getquantity)() | Returns the quantity of the discount. |
+| [getType](dw.campaign.Discount.md#gettype)() | Returns the type of the discount. |
+
+### 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)
+## Constant Details
+
+### TYPE_AMOUNT
+
+- TYPE_AMOUNT: [String](TopLevel.String.md) = "AMOUNT"
+  - : Constant representing discounts of type _amount_.
+
+
+---
+
+### TYPE_BONUS
+
+- TYPE_BONUS: [String](TopLevel.String.md) = "BONUS"
+  - : Constant representing discounts of type _bonus_.
+
+
+---
+
+### TYPE_BONUS_CHOICE
+
+- TYPE_BONUS_CHOICE: [String](TopLevel.String.md) = "BONUS_CHOICE"
+  - : Constant representing discounts of type _bonus choice_.
+
+
+---
+
+### TYPE_FIXED_PRICE
+
+- TYPE_FIXED_PRICE: [String](TopLevel.String.md) = "FIXED_PRICE"
+  - : Constant representing discounts of type _fixed-price_.
+
+
+---
+
+### TYPE_FIXED_PRICE_SHIPPING
+
+- TYPE_FIXED_PRICE_SHIPPING: [String](TopLevel.String.md) = "FIXED_PRICE_SHIPPING"
+  - : Constant representing discounts of type _fixed price shipping_.
+
+
+---
+
+### TYPE_FREE
+
+- TYPE_FREE: [String](TopLevel.String.md) = "FREE"
+  - : Constant representing discounts of type _free_.
+
+
+---
+
+### TYPE_FREE_SHIPPING
+
+- TYPE_FREE_SHIPPING: [String](TopLevel.String.md) = "FREE_SHIPPING"
+  - : Constant representing discounts of type _free shipping_.
+
+
+---
+
+### TYPE_PERCENTAGE
+
+- TYPE_PERCENTAGE: [String](TopLevel.String.md) = "PERCENTAGE"
+  - : Constant representing discounts of type _percentage_.
+
+
+---
+
+### TYPE_PERCENTAGE_OFF_OPTIONS
+
+- TYPE_PERCENTAGE_OFF_OPTIONS: [String](TopLevel.String.md) = "PERCENTAGE_OFF_OPTIONS"
+  - : Constant representing discounts of type _percent off options_.
+
+
+---
+
+### TYPE_PRICEBOOK_PRICE
+
+- TYPE_PRICEBOOK_PRICE: [String](TopLevel.String.md) = "PRICE_BOOK_PRICE"
+  - : Constant representing discounts of type _price book price_.
+
+
+---
+
+### TYPE_TOTAL_FIXED_PRICE
+
+- TYPE_TOTAL_FIXED_PRICE: [String](TopLevel.String.md) = "TOTAL_FIXED_PRICE"
+  - : Constant representing discounts of type _total fixed price_.
+
+
+---
+
+## Property Details
+
+### itemPromotionTiers
+- itemPromotionTiers: [Map](dw.util.Map.md) `(read-only)`
+  - : Returns the tier index by quantity Id of Product promotion. ProductLineItems may have more than one quantity, but
+      not all items of that SKU may have received the same tier of promotion. Each quantity of the ProductLineItem is
+      indexed from 1 to n, where n is the quantity of the ProductLineItem, and this method returns a mapping from that
+      quantity index to the index of tier of the promotion that item received. For more information about tier indexes,
+      see [getPromotionTier()](dw.campaign.Discount.md#getpromotiontier)  method.
+
+
+    **See Also:**
+    - [getPromotionTier()](dw.campaign.Discount.md#getpromotiontier)
+
+
+---
+
+### promotion
+- promotion: [Promotion](dw.campaign.Promotion.md) `(read-only)`
+  - : Returns the promotion this discount is based on.
+
+
+---
+
+### promotionTier
+- promotionTier: [Number](TopLevel.Number.md) `(read-only)`
+  - : Returns the tier index for promotion at order level or bonus product.
+      Promotion tiers are always evaluated in the order of the highest threshold (e.g. quantity, or amount)
+      to the lowest threshold. The tier that is evaluated first (i.e. the highest quantity or amount) is indexed as 0,
+      the next tier 1, etc. The lowest tier will have index n - 1, where n is the total number of tiers.
+
+
+
+---
+
+### quantity
+- quantity: [Number](TopLevel.Number.md) `(read-only)`
+  - : Returns the quantity of the discount. This quantity specifies how often
+      this discount applies to its target object. For example, a 10% off
+      discount with quantity 2 associated to a product line item with
+      quantity 3 is applied to two items of the product line item. 
+      
+      Discounts of order and shipping promotions, and bonus discounts
+      have a fix quantity of 1.
+
+
+
+---
+
+### type
+- type: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the type of the discount.
+
+
+---
+
+## Method Details
+
+### getItemPromotionTiers()
+- getItemPromotionTiers(): [Map](dw.util.Map.md)
+  - : Returns the tier index by quantity Id of Product promotion. ProductLineItems may have more than one quantity, but
+      not all items of that SKU may have received the same tier of promotion. Each quantity of the ProductLineItem is
+      indexed from 1 to n, where n is the quantity of the ProductLineItem, and this method returns a mapping from that
+      quantity index to the index of tier of the promotion that item received. For more information about tier indexes,
+      see [getPromotionTier()](dw.campaign.Discount.md#getpromotiontier)  method.
+
+
+    **Returns:**
+    - Map of Tier index by quantity Id or `empty map`
+
+    **See Also:**
+    - [getPromotionTier()](dw.campaign.Discount.md#getpromotiontier)
+
+
+---
+
+### getPromotion()
+- getPromotion(): [Promotion](dw.campaign.Promotion.md)
+  - : Returns the promotion this discount is based on.
+
+    **Returns:**
+    - Promotion related to this discount
+
+
+---
+
+### getPromotionTier()
+- getPromotionTier(): [Number](TopLevel.Number.md)
+  - : Returns the tier index for promotion at order level or bonus product.
+      Promotion tiers are always evaluated in the order of the highest threshold (e.g. quantity, or amount)
+      to the lowest threshold. The tier that is evaluated first (i.e. the highest quantity or amount) is indexed as 0,
+      the next tier 1, etc. The lowest tier will have index n - 1, where n is the total number of tiers.
+
+
+    **Returns:**
+    - Tier index or `null`
+
+
+---
+
+### getQuantity()
+- getQuantity(): [Number](TopLevel.Number.md)
+  - : Returns the quantity of the discount. This quantity specifies how often
+      this discount applies to its target object. For example, a 10% off
+      discount with quantity 2 associated to a product line item with
+      quantity 3 is applied to two items of the product line item. 
+      
+      Discounts of order and shipping promotions, and bonus discounts
+      have a fix quantity of 1.
+
+
+    **Returns:**
+    - Discount quantity
+
+
+---
+
+### getType()
+- getType(): [String](TopLevel.String.md)
+  - : Returns the type of the discount.
+
+    **Returns:**
+    - Discount type
+
+
+---
+
+<!-- prettier-ignore-end -->

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

@@ -0,0 +1,322 @@
+<!-- prettier-ignore-start -->
+# Class DiscountPlan
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.campaign.DiscountPlan](dw.campaign.DiscountPlan.md)
+
+DiscountPlan represents a set of [Discount](dw.campaign.Discount.md)s. Instances of the class are
+returned by the [PromotionMgr](dw.campaign.PromotionMgr.md) when requesting applicable discounts
+for a specified set of promotions and a line item container
+(see [PromotionMgr.getDiscounts(LineItemCtnr, PromotionPlan)](dw.campaign.PromotionMgr.md#getdiscountslineitemctnr-promotionplan)).
+
+
+DiscountPlan provides methods to access the discounts contained in the plan,
+add additional discounts to the plan (future) or remove discounts from the plan.
+
+
+**See Also:**
+- [PromotionMgr](dw.campaign.PromotionMgr.md)
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [approachingOrderDiscounts](#approachingorderdiscounts): [Collection](dw.util.Collection.md) `(read-only)` | Get the collection of order discounts that the LineItemCtnr "almost"  qualifies for based on the merchandise total in the cart. |
+| [bonusDiscounts](#bonusdiscounts): [Collection](dw.util.Collection.md) `(read-only)` | Returns all bonus discounts contained in the discount plan. |
+| [lineItemCtnr](#lineitemctnr): [LineItemCtnr](dw.order.LineItemCtnr.md) `(read-only)` | Returns line item container associated with discount plan. |
+| [orderDiscounts](#orderdiscounts): [Collection](dw.util.Collection.md) `(read-only)` | Returns the percentage and amount order discounts contained in the  discount plan. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getApproachingOrderDiscounts](dw.campaign.DiscountPlan.md#getapproachingorderdiscounts)() | Get the collection of order discounts that the LineItemCtnr "almost"  qualifies for based on the merchandise total in the cart. |
+| [getApproachingShippingDiscounts](dw.campaign.DiscountPlan.md#getapproachingshippingdiscountsshipment)([Shipment](dw.order.Shipment.md)) | Get the collection of shipping discounts that the passed shipment  "almost" qualifies for based on the merchandise total in the shipment. |
+| [getApproachingShippingDiscounts](dw.campaign.DiscountPlan.md#getapproachingshippingdiscountsshipment-shippingmethod)([Shipment](dw.order.Shipment.md), [ShippingMethod](dw.order.ShippingMethod.md)) | Get the collection of shipping discounts that the passed shipment  "almost" qualifies for based on the merchandise total in the shipment. |
+| [getApproachingShippingDiscounts](dw.campaign.DiscountPlan.md#getapproachingshippingdiscountsshipment-collection)([Shipment](dw.order.Shipment.md), [Collection](dw.util.Collection.md)) | Get the collection of shipping discounts that the passed shipment  "almost" qualifies for based on the merchandise total in the shipment. |
+| [getBonusDiscounts](dw.campaign.DiscountPlan.md#getbonusdiscounts)() | Returns all bonus discounts contained in the discount plan. |
+| [getLineItemCtnr](dw.campaign.DiscountPlan.md#getlineitemctnr)() | Returns line item container associated with discount plan. |
+| [getOrderDiscounts](dw.campaign.DiscountPlan.md#getorderdiscounts)() | Returns the percentage and amount order discounts contained in the  discount plan. |
+| [getProductDiscounts](dw.campaign.DiscountPlan.md#getproductdiscountsproductlineitem)([ProductLineItem](dw.order.ProductLineItem.md)) | Returns the percentage, amount and fix price discounts associated  with the specified product line item. |
+| [getProductShippingDiscounts](dw.campaign.DiscountPlan.md#getproductshippingdiscountsproductlineitem)([ProductLineItem](dw.order.ProductLineItem.md)) | Returns the product-shipping discounts associated with the specified  product line item. |
+| [getShippingDiscounts](dw.campaign.DiscountPlan.md#getshippingdiscountsshipment)([Shipment](dw.order.Shipment.md)) | Returns the percentage, amount and fix price discounts associated with  the specified shipment. |
+| [removeDiscount](dw.campaign.DiscountPlan.md#removediscountdiscount)([Discount](dw.campaign.Discount.md)) | Removes the specified discount from the discount plan. |
+
+### 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
+
+### approachingOrderDiscounts
+- approachingOrderDiscounts: [Collection](dw.util.Collection.md) `(read-only)`
+  - : Get the collection of order discounts that the LineItemCtnr "almost"
+      qualifies for based on the merchandise total in the cart. Nearness is
+      controlled by thresholds configured at the promotion level.
+      
+      
+      The collection of returned approaching discounts is ordered by the
+      condition threshold of the promotion (e.g. "spend $100 and get 10% off"
+      discount is returned before "spend $150 and get 15% off" discount.) A
+      discount is not returned if it would be prevented from applying (because
+      of compatibility rules) by an order discount already in the DiscountPlan
+      or an approaching order discount with a lower condition threshold.
+
+
+
+---
+
+### bonusDiscounts
+- bonusDiscounts: [Collection](dw.util.Collection.md) `(read-only)`
+  - : Returns all bonus discounts contained in the discount plan.
+
+
+---
+
+### lineItemCtnr
+- lineItemCtnr: [LineItemCtnr](dw.order.LineItemCtnr.md) `(read-only)`
+  - : Returns line item container associated with discount plan. 
+      
+      A discount plan is created from and associated with a line item container.
+      This method returns the line item container associated with this discount plan.
+
+
+
+---
+
+### orderDiscounts
+- orderDiscounts: [Collection](dw.util.Collection.md) `(read-only)`
+  - : Returns the percentage and amount order discounts contained in the
+      discount plan.
+
+
+
+---
+
+## Method Details
+
+### getApproachingOrderDiscounts()
+- getApproachingOrderDiscounts(): [Collection](dw.util.Collection.md)
+  - : Get the collection of order discounts that the LineItemCtnr "almost"
+      qualifies for based on the merchandise total in the cart. Nearness is
+      controlled by thresholds configured at the promotion level.
+      
+      
+      The collection of returned approaching discounts is ordered by the
+      condition threshold of the promotion (e.g. "spend $100 and get 10% off"
+      discount is returned before "spend $150 and get 15% off" discount.) A
+      discount is not returned if it would be prevented from applying (because
+      of compatibility rules) by an order discount already in the DiscountPlan
+      or an approaching order discount with a lower condition threshold.
+
+
+    **Returns:**
+    - Collection of approaching order discounts ordered by the
+              condition threshold of the promotion ascending.
+
+
+
+---
+
+### getApproachingShippingDiscounts(Shipment)
+- getApproachingShippingDiscounts(shipment: [Shipment](dw.order.Shipment.md)): [Collection](dw.util.Collection.md)
+  - : Get the collection of shipping discounts that the passed shipment
+      "almost" qualifies for based on the merchandise total in the shipment.
+      Nearness is controlled by thresholds configured at the promotion level.
+      
+      
+      The collection of returned approaching discounts is ordered by the
+      condition threshold of the promotion (e.g.
+      "spend $100 and get free standard shipping" discount is returned before
+      "spend $150 and get free standard shipping" discount.) A discount is not
+      returned if it would be prevented from applying (because of compatibility
+      rules) by a shipping discount already in the DiscountPlan or an
+      approaching shipping discount with a lower condition threshold.
+
+
+    **Parameters:**
+    - shipment - The shipment to calculate approaching discounts for.
+
+    **Returns:**
+    - Collection of approaching shipping discounts ordered by the
+              condition threshold of the promotion ascending.
+
+
+
+---
+
+### getApproachingShippingDiscounts(Shipment, ShippingMethod)
+- getApproachingShippingDiscounts(shipment: [Shipment](dw.order.Shipment.md), shippingMethod: [ShippingMethod](dw.order.ShippingMethod.md)): [Collection](dw.util.Collection.md)
+  - : Get the collection of shipping discounts that the passed shipment
+      "almost" qualifies for based on the merchandise total in the shipment.
+      Here "almost" is controlled by thresholds configured at the promotion
+      level.
+      
+      
+      This method only returns discounts for shipping promotions which apply to
+      the passed shipping method.
+      
+      
+      The collection of returned approaching discounts is ordered by the
+      condition threshold of the promotion (e.g.
+      "spend $100 and get free standard shipping" discount is returned before
+      "spend $150 and get free standard shipping" discount.) A discount is not
+      returned if it would be prevented from applying (because of compatibility
+      rules) by a shipping discount already in the DiscountPlan or an
+      approaching shipping discount with a lower condition threshold.
+
+
+    **Parameters:**
+    - shipment - The shipment to calculate approaching discounts for.
+    - shippingMethod - The shipping method to filter by.
+
+    **Returns:**
+    - Collection of approaching shipping discounts ordered by the
+              condition threshold of the promotion, ascending.
+
+
+
+---
+
+### getApproachingShippingDiscounts(Shipment, Collection)
+- getApproachingShippingDiscounts(shipment: [Shipment](dw.order.Shipment.md), shippingMethods: [Collection](dw.util.Collection.md)): [Collection](dw.util.Collection.md)
+  - : Get the collection of shipping discounts that the passed shipment
+      "almost" qualifies for based on the merchandise total in the shipment.
+      Here "almost" is controlled by thresholds configured at the promotion
+      level.
+      
+      
+      This method only returns discounts for shipping promotions which apply to
+      one of the passed shipping methods.
+      
+      
+      The collection of returned approaching discounts is ordered by the
+      condition threshold of the promotion (e.g.
+      "spend $100 and get free standard shipping" discount is returned before
+      "spend $150 and get free standard shipping" discount.) A discount is not
+      returned if it would be prevented from applying (because of compatibility
+      rules) by a shipping discount already in the DiscountPlan or an
+      approaching shipping discount with a lower condition threshold.
+
+
+    **Parameters:**
+    - shipment - The shipment to calculate approaching discounts for.
+    - shippingMethods - The shipping methods to filter by.
+
+    **Returns:**
+    - Collection of approaching shipping discounts ordered by the
+              condition threshold of the promotion ascending.
+
+
+
+---
+
+### getBonusDiscounts()
+- getBonusDiscounts(): [Collection](dw.util.Collection.md)
+  - : Returns all bonus discounts contained in the discount plan.
+
+    **Returns:**
+    - All bonus discounts contained in discount plan
+
+
+---
+
+### getLineItemCtnr()
+- getLineItemCtnr(): [LineItemCtnr](dw.order.LineItemCtnr.md)
+  - : Returns line item container associated with discount plan. 
+      
+      A discount plan is created from and associated with a line item container.
+      This method returns the line item container associated with this discount plan.
+
+
+    **Returns:**
+    - Line item container associated with plan
+
+
+---
+
+### getOrderDiscounts()
+- getOrderDiscounts(): [Collection](dw.util.Collection.md)
+  - : Returns the percentage and amount order discounts contained in the
+      discount plan.
+
+
+    **Returns:**
+    - Order discounts contained in the discount plan
+
+
+---
+
+### getProductDiscounts(ProductLineItem)
+- getProductDiscounts(productLineItem: [ProductLineItem](dw.order.ProductLineItem.md)): [Collection](dw.util.Collection.md)
+  - : Returns the percentage, amount and fix price discounts associated
+      with the specified product line item. If the specified product line
+      item is not contained in the discount plan, an empty collection is
+      returned.
+
+
+    **Parameters:**
+    - productLineItem - Product line item
+
+    **Returns:**
+    - Discounts associated with specified product line item
+
+
+---
+
+### getProductShippingDiscounts(ProductLineItem)
+- getProductShippingDiscounts(productLineItem: [ProductLineItem](dw.order.ProductLineItem.md)): [Collection](dw.util.Collection.md)
+  - : Returns the product-shipping discounts associated with the specified
+      product line item. If the specified product line item is not contained in
+      the discount plan, an empty collection is returned.
+
+
+    **Parameters:**
+    - productLineItem - Product line item
+
+    **Returns:**
+    - Product-shipping discounts associated with specified product line
+              item
+
+
+
+---
+
+### getShippingDiscounts(Shipment)
+- getShippingDiscounts(shipment: [Shipment](dw.order.Shipment.md)): [Collection](dw.util.Collection.md)
+  - : Returns the percentage, amount and fix price discounts associated with
+      the specified shipment. If the specified shipment is not contained in
+      the discount plan, an empty collection is returned.
+
+
+    **Parameters:**
+    - shipment - the shipment for which to fetch discounts.
+
+    **Returns:**
+    - Discounts associated with specified shipment
+
+
+---
+
+### removeDiscount(Discount)
+- removeDiscount(discount: [Discount](dw.campaign.Discount.md)): void
+  - : Removes the specified discount from the discount plan. 
+      
+      
+      This method should only be used for very simple discount scenarios. It
+      is not recommended to use the method in case of stacked discounts
+      (i.e. multiple order or product discounts), or complex discount types
+      like Buy X Get Y or Total Fixed Price, since correct re-calculation of the
+      discount plan based on the promotion rules is not guaranteed.
+
+
+    **Parameters:**
+    - discount - Discount to be removed
+
+
+---
+
+<!-- prettier-ignore-end -->

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

@@ -0,0 +1,74 @@
+<!-- prettier-ignore-start -->
+# Class FixedPriceDiscount
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.campaign.Discount](dw.campaign.Discount.md)
+    - [dw.campaign.FixedPriceDiscount](dw.campaign.FixedPriceDiscount.md)
+
+Represents a _fix price_ discount in the discount plan, for example
+"Shipping only 0.99 all orders $25 or more."
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [fixedPrice](#fixedprice): [Number](TopLevel.Number.md) `(read-only)` | Returns the fixed price amount, for example 0.99 for a "Shipping only $0.99"  discount. |
+
+## Constructor Summary
+
+| Constructor | Description |
+| --- | --- |
+| [FixedPriceDiscount](#fixedpricediscountnumber)([Number](TopLevel.Number.md)) | Create a fixed-price-discount on the fly. |
+
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getFixedPrice](dw.campaign.FixedPriceDiscount.md#getfixedprice)() | Returns the fixed price amount, for example 0.99 for a "Shipping only $0.99"  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
+
+### fixedPrice
+- fixedPrice: [Number](TopLevel.Number.md) `(read-only)`
+  - : Returns the fixed price amount, for example 0.99 for a "Shipping only $0.99"
+      discount.
+
+
+
+---
+
+## Constructor Details
+
+### FixedPriceDiscount(Number)
+- FixedPriceDiscount(amount: [Number](TopLevel.Number.md))
+  - : Create a fixed-price-discount on the fly. Can be used to create a custom price adjustment.
+
+    **Parameters:**
+    - amount - fixed price e.g. 10.00
+
+
+---
+
+## Method Details
+
+### getFixedPrice()
+- getFixedPrice(): [Number](TopLevel.Number.md)
+  - : Returns the fixed price amount, for example 0.99 for a "Shipping only $0.99"
+      discount.
+
+
+    **Returns:**
+    - Fixed price amount
+
+
+---
+
+<!-- prettier-ignore-end -->