sfcc-dev-mcp 1.0.19 → 1.0.21

package/docs/dw_campaign/AmountDiscount.md

@@ -1,51 +0,0 @@
-## Package: dw.campaign
-
-# Class AmountDiscount
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.campaign.Discount
-  - dw.campaign.AmountDiscount
-
-## Description
-
-Represents an amount-off discount in the discount plan, for example "$10 off all orders $100 or more".
-
-## Properties
-
-### amount
-
-**Type:** Number (Read Only)
-
-The discount amount, for example 10.00 for a "$10 off" discount.
-
-## Constructor Summary
-
-AmountDiscount(amount : Number) Create an amount-discount on the fly.
-
-## Method Summary
-
-### getAmount
-
-**Signature:** `getAmount() : Number`
-
-Returns the discount amount, for example 10.00 for a "$10 off" discount.
-
-## Constructor Detail
-
-## Method Detail
-
-## Method Details
-
-### getAmount
-
-**Signature:** `getAmount() : Number`
-
-**Description:** Returns the discount amount, for example 10.00 for a "$10 off" discount.
-
-**Returns:**
-
-Discount amount
-
----

package/docs/dw_campaign/ApproachingDiscount.md

@@ -1,124 +0,0 @@
-## Package: dw.campaign
-
-# Class ApproachingDiscount
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.campaign.ApproachingDiscount
-
-## Description
-
-Transient class representing a discount that a LineItemCtnr "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 instead of a LineItemCtnr itself. When one of PromotionMgr.getDiscounts(LineItemCtnr) or PromotionMgr.getDiscounts(LineItemCtnr, 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.
-
-## Properties
-
-### conditionThreshold
-
-**Type:** Money (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
-
-**Type:** Discount (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
-
-**Type:** Money (Read Only)
-
-Convenience method that returns
- getConditionThreshold().subtract(getMerchandiseValue())
-
-### merchandiseTotal
-
-**Type:** Money (Read Only)
-
-The amount of merchandise in the cart contributing towards the condition
- threshold. This will always be less than the condition threshold.
-
-## Constructor Summary
-
-## Method Summary
-
-### getConditionThreshold
-
-**Signature:** `getConditionThreshold() : Money`
-
-The amount of merchandise required in the cart in order to receive the discount.
-
-### getDiscount
-
-**Signature:** `getDiscount() : Discount`
-
-The discount that the customer will receive if he adds more merchandise to the cart.
-
-### getDistanceFromConditionThreshold
-
-**Signature:** `getDistanceFromConditionThreshold() : Money`
-
-Convenience method that returns getConditionThreshold().subtract(getMerchandiseValue())
-
-### getMerchandiseTotal
-
-**Signature:** `getMerchandiseTotal() : Money`
-
-The amount of merchandise in the cart contributing towards the condition threshold.
-
-## Method Detail
-
-## Method Details
-
-### getConditionThreshold
-
-**Signature:** `getConditionThreshold() : Money`
-
-**Description:** 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
-
-**Signature:** `getDiscount() : Discount`
-
-**Description:** 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
-
-**Signature:** `getDistanceFromConditionThreshold() : Money`
-
-**Description:** 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
-
-**Signature:** `getMerchandiseTotal() : Money`
-
-**Description:** 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.
-
----

package/docs/dw_campaign/BonusChoiceDiscount.md

@@ -1,146 +0,0 @@
-## Package: dw.campaign
-
-# Class BonusChoiceDiscount
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.campaign.Discount
-  - dw.campaign.BonusChoiceDiscount
-
-## Description
-
-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."
-
-## Properties
-
-### bonusProducts
-
-**Type:** List (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 and
- ProductSearchModel.setPromotionID(String)
-
-### maxBonusItems
-
-**Type:** Number (Read Only)
-
-The maximum number of bonus items that a customer is entitled to
- select for this discount.
-
-### ruleBased
-
-**Type:** ProductSearchModel (Static) (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
- API since the method getBonusProducts() in this class
- will always return an empty list. Furthermore, for rule based
- bonus-choice discounts, getBonusProductPrice(Product)
- will always return a price of 0.00 for bonus products.
-
-## Constructor Summary
-
-## Method Summary
-
-### getBonusProductPrice
-
-**Signature:** `getBonusProductPrice(product : Product) : Number`
-
-Get the effective price for the passed bonus product.
-
-### getBonusProducts
-
-**Signature:** `getBonusProducts() : List`
-
-Get the list of bonus products which the customer is allowed to choose from for this discount.
-
-### getMaxBonusItems
-
-**Signature:** `getMaxBonusItems() : Number`
-
-Returns the maximum number of bonus items that a customer is entitled to select for this discount.
-
-### isRuleBased
-
-**Signature:** `isRuleBased() : boolean`
-
-Returns true if this is a "rule based" bonus choice discount.
-
-## Method Detail
-
-## Method Details
-
-### getBonusProductPrice
-
-**Signature:** `getBonusProductPrice(product : Product) : Number`
-
-**Description:** Get the effective price for the passed bonus product. This is expected to be one of the products returned by 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
-
-**Signature:** `getBonusProducts() : List`
-
-**Description:** 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 and ProductSearchModel.setPromotionID(String)
-
-**Returns:**
-
-An ordered list of bonus products that the customer may choose from for this discount.
-
----
-
-### getMaxBonusItems
-
-**Signature:** `getMaxBonusItems() : Number`
-
-**Description:** 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
-
-**Signature:** `isRuleBased() : boolean`
-
-**Description:** 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 API since the method getBonusProducts() in this class will always return an empty list. Furthermore, for rule based bonus-choice discounts, getBonusProductPrice(Product) 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.
-
----

package/docs/dw_campaign/BonusDiscount.md

@@ -1,48 +0,0 @@
-## Package: dw.campaign
-
-# Class BonusDiscount
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.campaign.Discount
-  - dw.campaign.BonusDiscount
-
-## Description
-
-Represents a bonus discount in the discount plan, for example "Get a free DVD with your purchase of any DVD player."
-
-## Properties
-
-### bonusProducts
-
-**Type:** Collection (Read Only)
-
-The bonus products associated with this discount that are in
- stock, online and assigned to site catalog.
-
-## Constructor Summary
-
-## Method Summary
-
-### getBonusProducts
-
-**Signature:** `getBonusProducts() : Collection`
-
-Returns the bonus products associated with this discount that are in stock, online and assigned to site catalog.
-
-## Method Detail
-
-## Method Details
-
-### getBonusProducts
-
-**Signature:** `getBonusProducts() : Collection`
-
-**Description:** Returns the bonus products associated with this discount that are in stock, online and assigned to site catalog.
-
-**Returns:**
-
-Collection of bonus products
-
----