sfcc-dev-mcp 1.0.0

package/docs/dw_campaign/CampaignMgr.md

@@ -0,0 +1,395 @@
+## Package: dw.campaign
+
+# Class CampaignMgr
+
+## Inheritance Hierarchy
+
+- Object
+  - dw.campaign.CampaignMgr
+
+## Description
+
+CampaignMgr provides static methods for managing campaign-specific operations such as accessing promotions or updating promotion line items.
+
+## Properties
+
+### applicablePromotions
+
+**Type:** Collection (Read Only)
+
+The enabled promotions of active campaigns applicable for the
+ current customer and source code.
+ 
+ Note that this method does not return any coupon-based promotions.
+
+## Constructor Summary
+
+## Method Summary
+
+### applyBonusPromotions
+
+**Signature:** `static applyBonusPromotions(lineItemCtnr : LineItemCtnr, promotions : Collection) : boolean`
+
+This method has been deprecated and should not be used anymore.
+
+### applyOrderPromotions
+
+**Signature:** `static applyOrderPromotions(lineItemCtnr : LineItemCtnr, promotions : Collection) : boolean`
+
+Applies the applicable order promotions in the specified collection to the specified line item container.
+
+### applyProductPromotions
+
+**Signature:** `static applyProductPromotions(lineItemCtnr : LineItemCtnr, promotions : Collection) : boolean`
+
+Applies all applicable product promotions in the specified collection to the specified line item container.
+
+### applyShippingPromotions
+
+**Signature:** `static applyShippingPromotions(lineItemCtnr : LineItemCtnr, promotions : Collection) : boolean`
+
+Applies all applicable shipping promotions in the specified collection to the specified line item container.
+
+### getApplicableConditionalPromotions
+
+**Signature:** `static getApplicableConditionalPromotions(product : Product) : Collection`
+
+Returns the enabled promotions of active campaigns applicable for the current customer and source code for which the specified product is a qualifiying product.
+
+### getApplicablePromotions
+
+**Signature:** `static getApplicablePromotions(product : Product) : Collection`
+
+Returns the enabled promotions of active campaigns applicable for the current customer and source code for which the specified product is a discounted product.
+
+### getApplicablePromotions
+
+**Signature:** `static getApplicablePromotions(lineItemCtnr : LineItemCtnr) : Collection`
+
+Returns the enabled promotions of active campaigns applicable for the current customer, source code and any coupon contained in the specified line item container.
+
+### getApplicablePromotions
+
+**Signature:** `static getApplicablePromotions() : Collection`
+
+Returns the enabled promotions of active campaigns applicable for the current customer and source code.
+
+### getCampaignByID
+
+**Signature:** `static getCampaignByID(id : String) : Campaign`
+
+Returns the campaign identified by the specified ID.
+
+### getConditionalPromotions
+
+**Signature:** `static getConditionalPromotions(product : Product) : Collection`
+
+Returns the enabled promotions of active campaigns for which the specified product is a qualifiying product.
+
+### getPromotion
+
+**Signature:** `static getPromotion(couponCode : String) : Promotion`
+
+Returns the promotion associated with the specified coupon code.
+
+### getPromotionByCouponCode
+
+**Signature:** `static getPromotionByCouponCode(couponCode : String) : Promotion`
+
+Returns the promotion associated with the specified coupon code.
+
+### getPromotionByID
+
+**Signature:** `static getPromotionByID(id : String) : Promotion`
+
+Returns the promotion identified by the specified ID.
+
+### getPromotions
+
+**Signature:** `static getPromotions(product : Product) : Collection`
+
+Returns the enabled promotions of active campaigns for which the specified product is a discounted product.
+
+## Method Detail
+
+## Method Details
+
+### applyBonusPromotions
+
+**Signature:** `static applyBonusPromotions(lineItemCtnr : LineItemCtnr, promotions : Collection) : boolean`
+
+**Description:** This method has been deprecated and should not be used anymore. Instead, use PromotionMgr to apply promotions to line item containers. The method does nothing, since bonus promotions are applied as product or order promotions using methods applyProductPromotions(LineItemCtnr, Collection) and applyOrderPromotions(LineItemCtnr, Collection). The method returns 'true' if any the line item container contains any bonus product line items, and otherwise false.
+
+**Deprecated:**
+
+Use PromotionMgr instead.
+
+**Parameters:**
+
+- `lineItemCtnr`: Basket or order
+- `promotions`: Parameter not used, can be null
+
+**Returns:**
+
+True if line item container contains bonus product line items, else false
+
+---
+
+### applyOrderPromotions
+
+**Signature:** `static applyOrderPromotions(lineItemCtnr : LineItemCtnr, promotions : Collection) : boolean`
+
+**Description:** Applies the applicable order promotions in the specified collection to the specified line item container. This method has been deprecated and should not be used anymore. Instead, use PromotionMgr to apply promotions to line item containers. Note that the method does also apply any bonus discounts defined as order promotions (see also applyBonusPromotions(LineItemCtnr, Collection)).
+
+**Deprecated:**
+
+Use PromotionMgr
+
+**Parameters:**
+
+- `lineItemCtnr`: basket or order
+- `promotions`: list of all promotions to be applied
+
+**Returns:**
+
+true if changes were made to the line item container, false otherwise.
+
+---
+
+### applyProductPromotions
+
+**Signature:** `static applyProductPromotions(lineItemCtnr : LineItemCtnr, promotions : Collection) : boolean`
+
+**Description:** Applies all applicable product promotions in the specified collection to the specified line item container. This method has been deprecated and should not be used anymore. Instead, use PromotionMgr to apply promotions to line item containers. Note that the method does also apply any bonus discounts defined as product promotions (see also applyBonusPromotions(LineItemCtnr, Collection)).
+
+**Deprecated:**
+
+Use PromotionMgr
+
+**Parameters:**
+
+- `lineItemCtnr`: basket or order
+- `promotions`: list of all promotions to be applied
+
+**Returns:**
+
+true if changes were made to the line item container, false otherwise.
+
+---
+
+### applyShippingPromotions
+
+**Signature:** `static applyShippingPromotions(lineItemCtnr : LineItemCtnr, promotions : Collection) : boolean`
+
+**Description:** Applies all applicable shipping promotions in the specified collection to the specified line item container. This method has been deprecated and should not be used anymore. Instead, use PromotionMgr to apply promotions to line item containers.
+
+**Deprecated:**
+
+Use PromotionMgr
+
+**Parameters:**
+
+- `lineItemCtnr`: basket or order
+- `promotions`: list of all promotions to be applied
+
+**Returns:**
+
+true if changes were made to the line item container, false otherwise.
+
+---
+
+### getApplicableConditionalPromotions
+
+**Signature:** `static getApplicableConditionalPromotions(product : Product) : Collection`
+
+**Description:** Returns the enabled promotions of active campaigns applicable for the current customer and source code for which the specified product is a qualifiying product. As a replacement of this deprecated method, use PromotionMgr.getActiveCustomerPromotions() and PromotionPlan.getProductPromotions(Product). Unlike getApplicableConditionalPromotions(Product), PromotionPlan.getProductPromotions(Product) returns all promotions related to the specified product, regardless of whether the product is qualifying, discounted, or both, and also returns promotions where the product is a bonus product.
+
+**Deprecated:**
+
+Use PromotionMgr.getActiveCustomerPromotions() and PromotionPlan.getProductPromotions(Product)
+
+**Parameters:**
+
+- `product`: Qualifying product
+
+**Returns:**
+
+List of active promotions
+
+---
+
+### getApplicablePromotions
+
+**Signature:** `static getApplicablePromotions(product : Product) : Collection`
+
+**Description:** Returns the enabled promotions of active campaigns applicable for the current customer and source code for which the specified product is a discounted product. Note that this method does not return any coupon-based promotions. As a replacement of this deprecated method, use PromotionMgr.getActiveCustomerPromotions() and PromotionPlan.getProductPromotions(Product). Unlike getApplicablePromotions(Product), PromotionPlan.getProductPromotions(Product) returns all promotions related to the specified product, regardless of whether the product is qualifying, discounted, or both, and also returns promotions where the product is a bonus product.
+
+**Deprecated:**
+
+Use PromotionMgr.getActiveCustomerPromotions() and PromotionPlan.getProductPromotions(Product)
+
+**Parameters:**
+
+- `product`: The product whose promotions are returned.
+
+**Returns:**
+
+A list of promotions
+
+---
+
+### getApplicablePromotions
+
+**Signature:** `static getApplicablePromotions(lineItemCtnr : LineItemCtnr) : Collection`
+
+**Description:** Returns the enabled promotions of active campaigns applicable for the current customer, source code and any coupon contained in the specified line item container. Note that although the method has been deprecated, no replacement method is provided.
+
+**Deprecated:**
+
+There is no replacement for this method.
+
+**Parameters:**
+
+- `lineItemCtnr`: the basket or order
+
+**Returns:**
+
+list of all applicable promotion for the given basket or order
+
+---
+
+### getApplicablePromotions
+
+**Signature:** `static getApplicablePromotions() : Collection`
+
+**Description:** Returns the enabled promotions of active campaigns applicable for the current customer and source code. Note that this method does not return any coupon-based promotions.
+
+**Deprecated:**
+
+Use PromotionMgr.getActiveCustomerPromotions() and PromotionPlan.getPromotions()
+
+**Returns:**
+
+List of active promotions
+
+---
+
+### getCampaignByID
+
+**Signature:** `static getCampaignByID(id : String) : Campaign`
+
+**Description:** Returns the campaign identified by the specified ID.
+
+**Deprecated:**
+
+Use PromotionMgr.getCampaign(String)
+
+**Parameters:**
+
+- `id`: Campaign ID
+
+**Returns:**
+
+Campaign or null if not found
+
+---
+
+### getConditionalPromotions
+
+**Signature:** `static getConditionalPromotions(product : Product) : Collection`
+
+**Description:** Returns the enabled promotions of active campaigns for which the specified product is a qualifiying product. Note that the method also returns coupon-based promotions. As a replacement of this deprecated method, use PromotionMgr.getActiveCustomerPromotions() and PromotionPlan.getProductPromotions(Product). Unlike getConditionalPromotions(Product), PromotionPlan.getProductPromotions(Product) returns all promotions related to the specified product, regardless of whether the product is qualifying, discounted, or both, and also returns promotions where the product is a bonus product.
+
+**Deprecated:**
+
+Use PromotionMgr.getActivePromotions() and PromotionPlan.getProductPromotions(Product)
+
+**Parameters:**
+
+- `product`: The product whose conditional promotions are returned.
+
+**Returns:**
+
+A list of promotions
+
+---
+
+### getPromotion
+
+**Signature:** `static getPromotion(couponCode : String) : Promotion`
+
+**Description:** Returns the promotion associated with the specified coupon code.
+
+**Deprecated:**
+
+Coupons are now related to multiple promotions. Method returns the first promotion associated with the coupon code in case of multiple assigned promotions.
+
+**Parameters:**
+
+- `couponCode`: The coupon code used to lookup the promotion
+
+**Returns:**
+
+The resolved promotion object or null if none was found
+
+---
+
+### getPromotionByCouponCode
+
+**Signature:** `static getPromotionByCouponCode(couponCode : String) : Promotion`
+
+**Description:** Returns the promotion associated with the specified coupon code.
+
+**Deprecated:**
+
+Coupons are now related to multiple promotions. Method returns the first promotion associated with the coupon in case of multiple assigned promotions
+
+**Parameters:**
+
+- `couponCode`: Coupon code
+
+**Returns:**
+
+The associated promotion or null
+
+---
+
+### getPromotionByID
+
+**Signature:** `static getPromotionByID(id : String) : Promotion`
+
+**Description:** Returns the promotion identified by the specified ID.
+
+**Deprecated:**
+
+Use PromotionMgr.getPromotion(String)
+
+**Parameters:**
+
+- `id`: Promotion ID
+
+**Returns:**
+
+Promotion or null if not found
+
+---
+
+### getPromotions
+
+**Signature:** `static getPromotions(product : Product) : Collection`
+
+**Description:** Returns the enabled promotions of active campaigns for which the specified product is a discounted product. Note that method does only return promotions based on customer groups or source codes. As a replacement of this deprecated method, use PromotionMgr.getActiveCustomerPromotions() and PromotionPlan.getProductPromotions(Product). Unlike getPromotions(Product), PromotionPlan.getProductPromotions(Product) returns all promotions related to the specified product, regardless of whether the product is qualifying, discounted, or both, and also returns promotions where the product is a bonus product.
+
+**Deprecated:**
+
+Use PromotionMgr.getActivePromotions() and PromotionPlan.getProductPromotions(Product)
+
+**Parameters:**
+
+- `product`: Discounted product
+
+**Returns:**
+
+List of promotions
+
+---

package/docs/dw_campaign/CampaignStatusCodes.md

@@ -0,0 +1,24 @@
+## Package: dw.campaign
+
+# Class CampaignStatusCodes
+
+## Inheritance Hierarchy
+
+- Object
+  - dw.campaign.CampaignStatusCodes
+
+## Description
+
+Deprecated. Formerly used to contain the various statuses that a coupon may be in.
+
+## Constants
+
+## Properties
+
+## Constructor Summary
+
+CampaignStatusCodes()
+
+## Method Summary
+
+## Constructor Detail

package/docs/dw_campaign/Coupon.md

@@ -0,0 +1,292 @@
+## Package: dw.campaign
+
+# Class Coupon
+
+## Inheritance Hierarchy
+
+- Object
+  - dw.object.PersistentObject
+  - dw.campaign.Coupon
+
+## Description
+
+Represents a coupon in Commerce Cloud Digital.
+
+## Constants
+
+## Properties
+
+### codePrefix
+
+**Type:** String (Read Only)
+
+The prefix defined for coupons of type TYPE_SYSTEM_CODES
+ If no prefix is defined, or coupon is of type TYPE_SINGLE_CODE
+ or TYPE_MULTIPLE_CODES, null is returned.
+
+### enabled
+
+**Type:** boolean (Read Only)
+
+Returns true if coupon is enabled, else false.
+
+### ID
+
+**Type:** String (Read Only)
+
+The ID of the coupon.
+
+### nextCouponCode
+
+**Type:** String (Read Only)
+
+The next unissued code of this coupon.
+ For single-code coupons, the single fixed coupon code is returned.
+ For all multi-code coupons, the next available, unissued coupon code is returned.
+ If all codes of the coupon have been issued, then there is no next code, and null is returned.
+
+ A transaction is required when calling this method. This needs to be ensured by the calling script.
+
+### promotions
+
+**Type:** Collection (Read Only)
+
+The coupon-based promotions directly or indirectly (through
+ campaigns) assigned to this coupon.
+
+### redemptionLimitPerCode
+
+**Type:** Number (Read Only)
+
+The defined limit on redemption per coupon code. Null is
+ returned if no limit is defined, which means that each code can be
+ redeemed an unlimited number of times.
+
+### redemptionLimitPerCustomer
+
+**Type:** Number (Read Only)
+
+The defined limit on redemption of this coupon per customer.
+ Null is returned if no limit is defined, which means that customers can
+ redeem this coupon an unlimited number of times.
+
+### redemptionLimitPerTimeFrame
+
+**Type:** Number (Read Only)
+
+The defined limit on redemption per customer per time-frame (see
+ getRedemptionLimitTimeFrame(). Null is returned if no limit is
+ defined, which means that there is no time-specific redemption limit for
+ customers.
+
+### redemptionLimitTimeFrame
+
+**Type:** Number (Read Only)
+
+The time-frame (in days) of the defined limit on redemption per
+ customer per time-frame. Null is returned if no limit is defined, which
+ means that there is no time-specific redemption limit for customers.
+
+### type
+
+**Type:** String (Read Only)
+
+The coupon type.
+ Possible values are TYPE_SINGLE_CODE, TYPE_MULTIPLE_CODES
+ and TYPE_SYSTEM_CODES.
+
+## Constructor Summary
+
+## Method Summary
+
+### getCodePrefix
+
+**Signature:** `getCodePrefix() : String`
+
+Returns the prefix defined for coupons of type TYPE_SYSTEM_CODES If no prefix is defined, or coupon is of type TYPE_SINGLE_CODE or TYPE_MULTIPLE_CODES, null is returned.
+
+### getID
+
+**Signature:** `getID() : String`
+
+Returns the ID of the coupon.
+
+### getNextCouponCode
+
+**Signature:** `getNextCouponCode() : String`
+
+Returns the next unissued code of this coupon.
+
+### getPromotions
+
+**Signature:** `getPromotions() : Collection`
+
+Returns the coupon-based promotions directly or indirectly (through campaigns) assigned to this coupon.
+
+### getRedemptionLimitPerCode
+
+**Signature:** `getRedemptionLimitPerCode() : Number`
+
+Returns the defined limit on redemption per coupon code.
+
+### getRedemptionLimitPerCustomer
+
+**Signature:** `getRedemptionLimitPerCustomer() : Number`
+
+Returns the defined limit on redemption of this coupon per customer.
+
+### getRedemptionLimitPerTimeFrame
+
+**Signature:** `getRedemptionLimitPerTimeFrame() : Number`
+
+Returns the defined limit on redemption per customer per time-frame (see getRedemptionLimitTimeFrame().
+
+### getRedemptionLimitTimeFrame
+
+**Signature:** `getRedemptionLimitTimeFrame() : Number`
+
+Returns the time-frame (in days) of the defined limit on redemption per customer per time-frame.
+
+### getType
+
+**Signature:** `getType() : String`
+
+Returns the coupon type.
+
+### isEnabled
+
+**Signature:** `isEnabled() : boolean`
+
+Returns true if coupon is enabled, else false.
+
+## Method Detail
+
+## Method Details
+
+### getCodePrefix
+
+**Signature:** `getCodePrefix() : String`
+
+**Description:** Returns the prefix defined for coupons of type TYPE_SYSTEM_CODES If no prefix is defined, or coupon is of type TYPE_SINGLE_CODE or TYPE_MULTIPLE_CODES, null is returned.
+
+**Returns:**
+
+Coupon code prefix or null
+
+---
+
+### getID
+
+**Signature:** `getID() : String`
+
+**Description:** Returns the ID of the coupon.
+
+**Returns:**
+
+Coupon ID
+
+---
+
+### getNextCouponCode
+
+**Signature:** `getNextCouponCode() : String`
+
+**Description:** Returns the next unissued code of this coupon. For single-code coupons, the single fixed coupon code is returned. For all multi-code coupons, the next available, unissued coupon code is returned. If all codes of the coupon have been issued, then there is no next code, and null is returned. A transaction is required when calling this method. This needs to be ensured by the calling script.
+
+**Returns:**
+
+Next available code of this coupon, or null if there are no available codes.
+
+---
+
+### getPromotions
+
+**Signature:** `getPromotions() : Collection`
+
+**Description:** Returns the coupon-based promotions directly or indirectly (through campaigns) assigned to this coupon.
+
+**Returns:**
+
+Promotions assigned to the coupon in no particular order.
+
+---
+
+### getRedemptionLimitPerCode
+
+**Signature:** `getRedemptionLimitPerCode() : Number`
+
+**Description:** Returns the defined limit on redemption per coupon code. Null is returned if no limit is defined, which means that each code can be redeemed an unlimited number of times.
+
+**Returns:**
+
+The maximum number of redemption per coupon code
+
+---
+
+### getRedemptionLimitPerCustomer
+
+**Signature:** `getRedemptionLimitPerCustomer() : Number`
+
+**Description:** Returns the defined limit on redemption of this coupon per customer. Null is returned if no limit is defined, which means that customers can redeem this coupon an unlimited number of times.
+
+**Returns:**
+
+The maximum number of redemption per customer
+
+---
+
+### getRedemptionLimitPerTimeFrame
+
+**Signature:** `getRedemptionLimitPerTimeFrame() : Number`
+
+**Description:** Returns the defined limit on redemption per customer per time-frame (see getRedemptionLimitTimeFrame(). Null is returned if no limit is defined, which means that there is no time-specific redemption limit for customers.
+
+**Returns:**
+
+The maximum number of redemption per customer within time-frame
+
+**See Also:**
+
+getRedemptionLimitTimeFrame()
+
+---
+
+### getRedemptionLimitTimeFrame
+
+**Signature:** `getRedemptionLimitTimeFrame() : Number`
+
+**Description:** Returns the time-frame (in days) of the defined limit on redemption per customer per time-frame. Null is returned if no limit is defined, which means that there is no time-specific redemption limit for customers.
+
+**Returns:**
+
+Timeframe (days) of redemption per time
+
+**See Also:**
+
+getRedemptionLimitPerTimeFrame()
+
+---
+
+### getType
+
+**Signature:** `getType() : String`
+
+**Description:** Returns the coupon type. Possible values are TYPE_SINGLE_CODE, TYPE_MULTIPLE_CODES and TYPE_SYSTEM_CODES.
+
+**Returns:**
+
+Coupon type
+
+---
+
+### isEnabled
+
+**Signature:** `isEnabled() : boolean`
+
+**Description:** Returns true if coupon is enabled, else false.
+
+**Returns:**
+
+true if coupon is enabled.
+
+---