sfcc-dev-mcp 1.0.19 → 1.0.21

package/docs/dw_campaign/Discount.md

@@ -1,226 +0,0 @@
-## Package: dw.campaign
-
-# Class Discount
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.campaign.Discount
-
-## Description
-
-Superclass of all specific discount classes.
-
-## Constants
-
-### TYPE_AMOUNT
-
-**Type:** String = "AMOUNT"
-
-Constant representing discounts of type amount.
-
-### TYPE_BONUS
-
-**Type:** String = "BONUS"
-
-Constant representing discounts of type bonus.
-
-### TYPE_BONUS_CHOICE
-
-**Type:** String = "BONUS_CHOICE"
-
-Constant representing discounts of type bonus choice.
-
-### TYPE_FIXED_PRICE
-
-**Type:** String = "FIXED_PRICE"
-
-Constant representing discounts of type fixed-price.
-
-### TYPE_FIXED_PRICE_SHIPPING
-
-**Type:** String = "FIXED_PRICE_SHIPPING"
-
-Constant representing discounts of type fixed price shipping.
-
-### TYPE_FREE
-
-**Type:** String = "FREE"
-
-Constant representing discounts of type free.
-
-### TYPE_FREE_SHIPPING
-
-**Type:** String = "FREE_SHIPPING"
-
-Constant representing discounts of type free shipping.
-
-### TYPE_PERCENTAGE
-
-**Type:** String = "PERCENTAGE"
-
-Constant representing discounts of type percentage.
-
-### TYPE_PERCENTAGE_OFF_OPTIONS
-
-**Type:** String = "PERCENTAGE_OFF_OPTIONS"
-
-Constant representing discounts of type percent off options.
-
-### TYPE_PRICEBOOK_PRICE
-
-**Type:** String = "PRICE_BOOK_PRICE"
-
-Constant representing discounts of type price book price.
-
-### TYPE_TOTAL_FIXED_PRICE
-
-**Type:** String = "TOTAL_FIXED_PRICE"
-
-Constant representing discounts of type total fixed price.
-
-## Properties
-
-### itemPromotionTiers
-
-**Type:** Map (Read Only)
-
-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()  method.
-
-### promotion
-
-**Type:** Promotion (Read Only)
-
-The promotion this discount is based on.
-
-### promotionTier
-
-**Type:** Number (Read Only)
-
-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
-
-**Type:** Number (Read Only)
-
-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 (Read Only)
-
-The type of the discount.
-
-## Constructor Summary
-
-## Method Summary
-
-### getItemPromotionTiers
-
-**Signature:** `getItemPromotionTiers() : Map`
-
-Returns the tier index by quantity Id of Product promotion.
-
-### getPromotion
-
-**Signature:** `getPromotion() : Promotion`
-
-Returns the promotion this discount is based on.
-
-### getPromotionTier
-
-**Signature:** `getPromotionTier() : Number`
-
-Returns the tier index for promotion at order level or bonus product.
-
-### getQuantity
-
-**Signature:** `getQuantity() : Number`
-
-Returns the quantity of the discount.
-
-### getType
-
-**Signature:** `getType() : String`
-
-Returns the type of the discount.
-
-## Method Detail
-
-## Method Details
-
-### getItemPromotionTiers
-
-**Signature:** `getItemPromotionTiers() : Map`
-
-**Description:** 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() method.
-
-**Returns:**
-
-Map of Tier index by quantity Id or empty map
-
-**See Also:**
-
-getPromotionTier()
-
----
-
-### getPromotion
-
-**Signature:** `getPromotion() : Promotion`
-
-**Description:** Returns the promotion this discount is based on.
-
-**Returns:**
-
-Promotion related to this discount
-
----
-
-### getPromotionTier
-
-**Signature:** `getPromotionTier() : Number`
-
-**Description:** 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
-
-**Signature:** `getQuantity() : Number`
-
-**Description:** 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
-
-**Signature:** `getType() : String`
-
-**Description:** Returns the type of the discount.
-
-**Returns:**
-
-Discount type
-
----

package/docs/dw_campaign/DiscountPlan.md

@@ -1,282 +0,0 @@
-## Package: dw.campaign
-
-# Class DiscountPlan
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.campaign.DiscountPlan
-
-## Description
-
-DiscountPlan represents a set of Discounts. Instances of the class are returned by the PromotionMgr when requesting applicable discounts for a specified set of promotions and a line item container (see PromotionMgr.getDiscounts(LineItemCtnr, 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.
-
-## Properties
-
-### approachingOrderDiscounts
-
-**Type:** Collection (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
-
-**Type:** Collection (Read Only)
-
-All bonus discounts contained in the discount plan.
-
-### lineItemCtnr
-
-**Type:** LineItemCtnr (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
-
-**Type:** Collection (Read Only)
-
-The percentage and amount order discounts contained in the
- discount plan.
-
-## Constructor Summary
-
-## Method Summary
-
-### getApproachingOrderDiscounts
-
-**Signature:** `getApproachingOrderDiscounts() : Collection`
-
-Get the collection of order discounts that the LineItemCtnr "almost" qualifies for based on the merchandise total in the cart.
-
-### getApproachingShippingDiscounts
-
-**Signature:** `getApproachingShippingDiscounts(shipment : Shipment) : Collection`
-
-Get the collection of shipping discounts that the passed shipment "almost" qualifies for based on the merchandise total in the shipment.
-
-### getApproachingShippingDiscounts
-
-**Signature:** `getApproachingShippingDiscounts(shipment : Shipment, shippingMethod : ShippingMethod) : Collection`
-
-Get the collection of shipping discounts that the passed shipment "almost" qualifies for based on the merchandise total in the shipment.
-
-### getApproachingShippingDiscounts
-
-**Signature:** `getApproachingShippingDiscounts(shipment : Shipment, shippingMethods : Collection) : Collection`
-
-Get the collection of shipping discounts that the passed shipment "almost" qualifies for based on the merchandise total in the shipment.
-
-### getBonusDiscounts
-
-**Signature:** `getBonusDiscounts() : Collection`
-
-Returns all bonus discounts contained in the discount plan.
-
-### getLineItemCtnr
-
-**Signature:** `getLineItemCtnr() : LineItemCtnr`
-
-Returns line item container associated with discount plan.
-
-### getOrderDiscounts
-
-**Signature:** `getOrderDiscounts() : Collection`
-
-Returns the percentage and amount order discounts contained in the discount plan.
-
-### getProductDiscounts
-
-**Signature:** `getProductDiscounts(productLineItem : ProductLineItem) : Collection`
-
-Returns the percentage, amount and fix price discounts associated with the specified product line item.
-
-### getProductShippingDiscounts
-
-**Signature:** `getProductShippingDiscounts(productLineItem : ProductLineItem) : Collection`
-
-Returns the product-shipping discounts associated with the specified product line item.
-
-### getShippingDiscounts
-
-**Signature:** `getShippingDiscounts(shipment : Shipment) : Collection`
-
-Returns the percentage, amount and fix price discounts associated with the specified shipment.
-
-### removeDiscount
-
-**Signature:** `removeDiscount(discount : Discount) : void`
-
-Removes the specified discount from the discount plan.
-
-## Method Detail
-
-## Method Details
-
-### getApproachingOrderDiscounts
-
-**Signature:** `getApproachingOrderDiscounts() : Collection`
-
-**Description:** 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
-
-**Signature:** `getApproachingShippingDiscounts(shipment : Shipment) : Collection`
-
-**Description:** 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
-
-**Signature:** `getApproachingShippingDiscounts(shipment : Shipment, shippingMethod : ShippingMethod) : Collection`
-
-**Description:** 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
-
-**Signature:** `getApproachingShippingDiscounts(shipment : Shipment, shippingMethods : Collection) : Collection`
-
-**Description:** 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
-
-**Signature:** `getBonusDiscounts() : Collection`
-
-**Description:** Returns all bonus discounts contained in the discount plan.
-
-**Returns:**
-
-All bonus discounts contained in discount plan
-
----
-
-### getLineItemCtnr
-
-**Signature:** `getLineItemCtnr() : LineItemCtnr`
-
-**Description:** 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
-
-**Signature:** `getOrderDiscounts() : Collection`
-
-**Description:** Returns the percentage and amount order discounts contained in the discount plan.
-
-**Returns:**
-
-Order discounts contained in the discount plan
-
----
-
-### getProductDiscounts
-
-**Signature:** `getProductDiscounts(productLineItem : ProductLineItem) : Collection`
-
-**Description:** 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
-
-**Signature:** `getProductShippingDiscounts(productLineItem : ProductLineItem) : Collection`
-
-**Description:** 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
-
-**Signature:** `getShippingDiscounts(shipment : Shipment) : Collection`
-
-**Description:** 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
-
-**Signature:** `removeDiscount(discount : Discount) : void`
-
-**Description:** 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
-
----

package/docs/dw_campaign/FixedPriceDiscount.md

@@ -1,52 +0,0 @@
-## Package: dw.campaign
-
-# Class FixedPriceDiscount
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.campaign.Discount
-  - dw.campaign.FixedPriceDiscount
-
-## Description
-
-Represents a fix price discount in the discount plan, for example "Shipping only 0.99 all orders $25 or more."
-
-## Properties
-
-### fixedPrice
-
-**Type:** Number (Read Only)
-
-The fixed price amount, for example 0.99 for a "Shipping only $0.99"
- discount.
-
-## Constructor Summary
-
-FixedPriceDiscount(amount : Number) Create a fixed-price-discount on the fly.
-
-## Method Summary
-
-### getFixedPrice
-
-**Signature:** `getFixedPrice() : Number`
-
-Returns the fixed price amount, for example 0.99 for a "Shipping only $0.99" discount.
-
-## Constructor Detail
-
-## Method Detail
-
-## Method Details
-
-### getFixedPrice
-
-**Signature:** `getFixedPrice() : Number`
-
-**Description:** Returns the fixed price amount, for example 0.99 for a "Shipping only $0.99" discount.
-
-**Returns:**
-
-Fixed price amount
-
----

package/docs/dw_campaign/FixedPriceShippingDiscount.md

@@ -1,52 +0,0 @@
-## Package: dw.campaign
-
-# Class FixedPriceShippingDiscount
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.campaign.Discount
-  - dw.campaign.FixedPriceShippingDiscount
-
-## Description
-
-Represents a fixed price shipping discount in the discount plan, for example "Shipping only 0.99 for iPods."
-
-## Properties
-
-### fixedPrice
-
-**Type:** Number (Read Only)
-
-The fixed price amount, for example 0.99 for a "Shipping only $0.99"
- discount.
-
-## Constructor Summary
-
-FixedPriceShippingDiscount(amount : Number) Create a fixed-price-shipping-discount on the fly.
-
-## Method Summary
-
-### getFixedPrice
-
-**Signature:** `getFixedPrice() : Number`
-
-Returns the fixed price amount, for example 0.99 for a "Shipping only $0.99" discount.
-
-## Constructor Detail
-
-## Method Detail
-
-## Method Details
-
-### getFixedPrice
-
-**Signature:** `getFixedPrice() : Number`
-
-**Description:** Returns the fixed price amount, for example 0.99 for a "Shipping only $0.99" discount.
-
-**Returns:**
-
-Fixed price amount
-
----

package/docs/dw_campaign/FreeDiscount.md

@@ -1,17 +0,0 @@
-## Package: dw.campaign
-
-# Class FreeDiscount
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.campaign.Discount
-  - dw.campaign.FreeDiscount
-
-## Description
-
-Represents a free discount in the discount plan, for example "Free shipping on all orders $25 or more."
-
-## Constructor Summary
-
-## Method Summary

package/docs/dw_campaign/FreeShippingDiscount.md

@@ -1,17 +0,0 @@
-## Package: dw.campaign
-
-# Class FreeShippingDiscount
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.campaign.Discount
-  - dw.campaign.FreeShippingDiscount
-
-## Description
-
-Represents a free shipping discount in the discount plan, for example "Free shipping on all iPods."
-
-## Constructor Summary
-
-## Method Summary

package/docs/dw_campaign/PercentageDiscount.md

@@ -1,52 +0,0 @@
-## Package: dw.campaign
-
-# Class PercentageDiscount
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.campaign.Discount
-  - dw.campaign.PercentageDiscount
-
-## Description
-
-Represents a percentage-off discount in the discount plan, for example "10% off all T-Shirts".
-
-## Properties
-
-### percentage
-
-**Type:** Number (Read Only)
-
-The percentage discount value, for example 10.00 for a "10% off"
- discount.
-
-## Constructor Summary
-
-PercentageDiscount(percentage : Number) Create a percentage-discount on the fly.
-
-## Method Summary
-
-### getPercentage
-
-**Signature:** `getPercentage() : Number`
-
-Returns the percentage discount value, for example 10.00 for a "10% off" discount.
-
-## Constructor Detail
-
-## Method Detail
-
-## Method Details
-
-### getPercentage
-
-**Signature:** `getPercentage() : Number`
-
-**Description:** Returns the percentage discount value, for example 10.00 for a "10% off" discount.
-
-**Returns:**
-
-Discount percentage value
-
----