sfcc-dev-mcp 1.0.19 → 1.0.21

package/docs/dw_campaign/Coupon.md

@@ -1,310 +0,0 @@
-## Package: dw.campaign
-
-# Class Coupon
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.object.PersistentObject
-  - dw.campaign.Coupon
-
-## Description
-
-Represents a coupon in Commerce Cloud Digital.
-
-## Constants
-
-### TYPE_MULTIPLE_CODES
-
-**Type:** String = "MULTIPLE_CODES"
-
-Constant representing coupon type multiple-codes.
-
-### TYPE_SINGLE_CODE
-
-**Type:** String = "SINGLE_CODE"
-
-Constant representing coupon type single-code.
-
-### TYPE_SYSTEM_CODES
-
-**Type:** String = "SYSTEM_CODES"
-
-Constant representing coupon type system-codes.
-
-## 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.
-
----

package/docs/dw_campaign/CouponMgr.md

@@ -1,144 +0,0 @@
-## Package: dw.campaign
-
-# Class CouponMgr
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.campaign.CouponMgr
-
-## Description
-
-Manager to access coupons.
-
-## Constants
-
-### MR_ERROR_INVALID_SITE_ID
-
-**Type:** String = "MASKREDEMPTIONS_SITE_NOT_FOUND"
-
-Indicates that an error occurred because a valid data domain cannot be found for given siteID.
-
-## Properties
-
-### coupons
-
-**Type:** Collection (Read Only)
-
-All coupons in the current site in no specific order.
-
-## Constructor Summary
-
-## Method Summary
-
-### getCoupon
-
-**Signature:** `static getCoupon(couponID : String) : Coupon`
-
-Returns the coupon with the specified ID.
-
-### getCouponByCode
-
-**Signature:** `static getCouponByCode(couponCode : String) : Coupon`
-
-Tries to find a coupon for the given coupon code.
-
-### getCoupons
-
-**Signature:** `static getCoupons() : Collection`
-
-Returns all coupons in the current site in no specific order.
-
-### getRedemptions
-
-**Signature:** `static getRedemptions(couponID : String, couponCode : String) : Collection`
-
-Returns list of CouponRedemptions for the specified coupon and coupon code, sorted by redemption date descending (i.e.
-
-### maskRedemptions
-
-**Signature:** `static maskRedemptions(siteID : String, email : String) : Status`
-
-Mask customer email address in coupon redemptions for the given siteID and email address
-
-## Method Detail
-
-## Method Details
-
-### getCoupon
-
-**Signature:** `static getCoupon(couponID : String) : Coupon`
-
-**Description:** Returns the coupon with the specified ID.
-
-**Parameters:**
-
-- `couponID`: the coupon identifier.
-
-**Returns:**
-
-Coupon with specified ID or null
-
----
-
-### getCouponByCode
-
-**Signature:** `static getCouponByCode(couponCode : String) : Coupon`
-
-**Description:** Tries to find a coupon for the given coupon code. The method first searches for a coupon with a fixed code matching the passed value. If no such fixed coupon is found, it searches for a coupon with a system-generated code matching the passed value. If found, the coupon is returned. Otherwise, the method returns null.
-
-**Parameters:**
-
-- `couponCode`: The coupon code to get the coupon for.
-
-**Returns:**
-
-The coupon with the matching coupon code or null if no coupon was found.
-
----
-
-### getCoupons
-
-**Signature:** `static getCoupons() : Collection`
-
-**Description:** Returns all coupons in the current site in no specific order.
-
-**Returns:**
-
-Coupons in current site
-
----
-
-### getRedemptions
-
-**Signature:** `static getRedemptions(couponID : String, couponCode : String) : Collection`
-
-**Description:** Returns list of CouponRedemptions for the specified coupon and coupon code, sorted by redemption date descending (i.e. last redemption first). Usually, there should only either be 0 or 1 redemption. But if a coupon and code is removed and recreated and re-issued later, there might be multiple such redemption records. Returns an empty list if no redemption record exists in system for the specified coupon and code.
-
-**Parameters:**
-
-- `couponID`: The coupon id to find redemption for.
-- `couponCode`: The coupon code to find redemption for.
-
-**Returns:**
-
-A sorted list of CouponRedemptions for the specified coupon and coupon code or an empty list if no redemption record exists.
-
----
-
-### maskRedemptions
-
-**Signature:** `static maskRedemptions(siteID : String, email : String) : Status`
-
-**Description:** Mask customer email address in coupon redemptions for the given siteID and email address
-
-**Parameters:**
-
-- `siteID`: the site ID
-- `email`: the customer email address
-
-**Returns:**
-
-The status of the masking result
-
----

package/docs/dw_campaign/CouponRedemption.md

@@ -1,94 +0,0 @@
-## Package: dw.campaign
-
-# Class CouponRedemption
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.campaign.CouponRedemption
-
-## Description
-
-Represents a redeemed coupon.
-
-## Properties
-
-### customerEmail
-
-**Type:** String (Read Only)
-
-Returns email of redeeming customer.
-
-### orderNo
-
-**Type:** String (Read Only)
-
-Returns number of the order the code was redeemed with.
-
-### redemptionDate
-
-**Type:** Date (Read Only)
-
-Returns date of redemption.
-
-## Constructor Summary
-
-## Method Summary
-
-### getCustomerEmail
-
-**Signature:** `getCustomerEmail() : String`
-
-Returns email of redeeming customer.
-
-### getOrderNo
-
-**Signature:** `getOrderNo() : String`
-
-Returns number of the order the code was redeemed with.
-
-### getRedemptionDate
-
-**Signature:** `getRedemptionDate() : Date`
-
-Returns date of redemption.
-
-## Method Detail
-
-## Method Details
-
-### getCustomerEmail
-
-**Signature:** `getCustomerEmail() : String`
-
-**Description:** Returns email of redeeming customer.
-
-**Returns:**
-
-email of redeeming customer.
-
----
-
-### getOrderNo
-
-**Signature:** `getOrderNo() : String`
-
-**Description:** Returns number of the order the code was redeemed with.
-
-**Returns:**
-
-number of the order the code was redeemed with.
-
----
-
-### getRedemptionDate
-
-**Signature:** `getRedemptionDate() : Date`
-
-**Description:** Returns date of redemption.
-
-**Returns:**
-
-date of redemption.
-
----

package/docs/dw_campaign/CouponStatusCodes.md

@@ -1,86 +0,0 @@
-## Package: dw.campaign
-
-# Class CouponStatusCodes
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.campaign.CouponStatusCodes
-
-## Description
-
-Helper class containing status codes for why a coupon code cannot be added to cart or why a coupon code already in cart is not longer valid for redemption.
-
-## Constants
-
-### APPLIED
-
-**Type:** String = "APPLIED"
-
-Coupon is currently applied in basket = Coupon code is valid for redemption and Coupon is assigned to one or multiple applicable promotions.
-
-### COUPON_ALREADY_IN_BASKET
-
-**Type:** String = "COUPON_ALREADY_IN_BASKET"
-
-Indicates that another code of the same MultiCode/System coupon has already been added to basket.
-
-### COUPON_CODE_ALREADY_IN_BASKET
-
-**Type:** String = "COUPON_CODE_ALREADY_IN_BASKET"
-
-Indicates that coupon code has already been added to basket.
-
-### COUPON_CODE_ALREADY_REDEEMED
-
-**Type:** String = "COUPON_CODE_ALREADY_REDEEMED"
-
-Indicates that code of MultiCode/System coupon has already been redeemed.
-
-### COUPON_CODE_UNKNOWN
-
-**Type:** String = "COUPON_CODE_UNKNOWN"
-
-Indicates that coupon not found for given coupon code or that the code itself was not found.
-
-### COUPON_DISABLED
-
-**Type:** String = "COUPON_DISABLED"
-
-Indicates that coupon is not enabled.
-
-### CUSTOMER_REDEMPTION_LIMIT_EXCEEDED
-
-**Type:** String = "CUSTOMER_REDEMPTION_LIMIT_EXCEEDED"
-
-Indicates that No. of redemptions per code & customer exceeded.
-
-### NO_ACTIVE_PROMOTION
-
-**Type:** String = "NO_ACTIVE_PROMOTION"
-
-Indicates that coupon is not assigned to an active promotion.
-
-### NO_APPLICABLE_PROMOTION
-
-**Type:** String = "NO_APPLICABLE_PROMOTION"
-
-Coupon is assigned to one or multiple active promotions, but none of these promotions is currently applicable.
-
-### REDEMPTION_LIMIT_EXCEEDED
-
-**Type:** String = "REDEMPTION_LIMIT_EXCEEDED"
-
-Indicates that no. of redemptions per code exceeded. Usually happens for single code coupons
-
-### TIMEFRAME_REDEMPTION_LIMIT_EXCEEDED
-
-**Type:** String = "TIMEFRAME_REDEMPTION_LIMIT_EXCEEDED"
-
-Indicates that No. of redemptions per code,customer & time exceeded.
-
-## Properties
-
-## Constructor Summary
-
-## Method Summary