@salesforce/b2c-tooling-sdk 1.19.0 → 1.20.0

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

@@ -1,324 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class Coupon
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.object.PersistentObject](dw.object.PersistentObject.md)
-    - [dw.campaign.Coupon](dw.campaign.Coupon.md)
-
-Represents a coupon in Commerce Cloud Digital.
-
-
-## Constant Summary
-
-| Constant | Description |
-| --- | --- |
-| [TYPE_MULTIPLE_CODES](#type_multiple_codes): [String](TopLevel.String.md) = "MULTIPLE_CODES" | Constant representing coupon type _multiple-codes_. |
-| [TYPE_SINGLE_CODE](#type_single_code): [String](TopLevel.String.md) = "SINGLE_CODE" | Constant representing coupon type _single-code_. |
-| [TYPE_SYSTEM_CODES](#type_system_codes): [String](TopLevel.String.md) = "SYSTEM_CODES" | Constant representing coupon type _system-codes_. |
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [ID](#id): [String](TopLevel.String.md) `(read-only)` | Returns the ID of the coupon. |
-| [codePrefix](#codeprefix): [String](TopLevel.String.md) `(read-only)` | Returns the prefix defined for coupons of type [TYPE_SYSTEM_CODES](dw.campaign.Coupon.md#type_system_codes)  If no prefix is defined, or coupon is of type [TYPE_SINGLE_CODE](dw.campaign.Coupon.md#type_single_code)  or [TYPE_MULTIPLE_CODES](dw.campaign.Coupon.md#type_multiple_codes), null is returned. |
-| [enabled](#enabled): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns true if coupon is enabled, else false. |
-| [nextCouponCode](#nextcouponcode): [String](TopLevel.String.md) `(read-only)` | Returns the next unissued code of this coupon. |
-| [promotions](#promotions): [Collection](dw.util.Collection.md) `(read-only)` | Returns the coupon-based promotions directly or indirectly (through  campaigns) assigned to this coupon. |
-| [redemptionLimitPerCode](#redemptionlimitpercode): [Number](TopLevel.Number.md) `(read-only)` | Returns the defined limit on redemption per coupon code. |
-| [redemptionLimitPerCustomer](#redemptionlimitpercustomer): [Number](TopLevel.Number.md) `(read-only)` | Returns the defined limit on redemption of this coupon per customer. |
-| [redemptionLimitPerTimeFrame](#redemptionlimitpertimeframe): [Number](TopLevel.Number.md) `(read-only)` | Returns the defined limit on redemption per customer per time-frame (see  [getRedemptionLimitTimeFrame()](dw.campaign.Coupon.md#getredemptionlimittimeframe). |
-| [redemptionLimitTimeFrame](#redemptionlimittimeframe): [Number](TopLevel.Number.md) `(read-only)` | Returns the time-frame (in days) of the defined limit on redemption per  customer per time-frame. |
-| [type](#type): [String](TopLevel.String.md) `(read-only)` | Returns the coupon type. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getCodePrefix](dw.campaign.Coupon.md#getcodeprefix)() | Returns the prefix defined for coupons of type [TYPE_SYSTEM_CODES](dw.campaign.Coupon.md#type_system_codes)  If no prefix is defined, or coupon is of type [TYPE_SINGLE_CODE](dw.campaign.Coupon.md#type_single_code)  or [TYPE_MULTIPLE_CODES](dw.campaign.Coupon.md#type_multiple_codes), null is returned. |
-| [getID](dw.campaign.Coupon.md#getid)() | Returns the ID of the coupon. |
-| [getNextCouponCode](dw.campaign.Coupon.md#getnextcouponcode)() | Returns the next unissued code of this coupon. |
-| [getPromotions](dw.campaign.Coupon.md#getpromotions)() | Returns the coupon-based promotions directly or indirectly (through  campaigns) assigned to this coupon. |
-| [getRedemptionLimitPerCode](dw.campaign.Coupon.md#getredemptionlimitpercode)() | Returns the defined limit on redemption per coupon code. |
-| [getRedemptionLimitPerCustomer](dw.campaign.Coupon.md#getredemptionlimitpercustomer)() | Returns the defined limit on redemption of this coupon per customer. |
-| [getRedemptionLimitPerTimeFrame](dw.campaign.Coupon.md#getredemptionlimitpertimeframe)() | Returns the defined limit on redemption per customer per time-frame (see  [getRedemptionLimitTimeFrame()](dw.campaign.Coupon.md#getredemptionlimittimeframe). |
-| [getRedemptionLimitTimeFrame](dw.campaign.Coupon.md#getredemptionlimittimeframe)() | Returns the time-frame (in days) of the defined limit on redemption per  customer per time-frame. |
-| [getType](dw.campaign.Coupon.md#gettype)() | Returns the coupon type. |
-| [isEnabled](dw.campaign.Coupon.md#isenabled)() | Returns true if coupon is enabled, else false. |
-
-### Methods inherited from class PersistentObject
-
-[getCreationDate](dw.object.PersistentObject.md#getcreationdate), [getLastModified](dw.object.PersistentObject.md#getlastmodified), [getUUID](dw.object.PersistentObject.md#getuuid)
-### 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_MULTIPLE_CODES
-
-- TYPE_MULTIPLE_CODES: [String](TopLevel.String.md) = "MULTIPLE_CODES"
-  - : Constant representing coupon type _multiple-codes_.
-
-
----
-
-### TYPE_SINGLE_CODE
-
-- TYPE_SINGLE_CODE: [String](TopLevel.String.md) = "SINGLE_CODE"
-  - : Constant representing coupon type _single-code_.
-
-
----
-
-### TYPE_SYSTEM_CODES
-
-- TYPE_SYSTEM_CODES: [String](TopLevel.String.md) = "SYSTEM_CODES"
-  - : Constant representing coupon type _system-codes_.
-
-
----
-
-## Property Details
-
-### ID
-- ID: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the ID of the coupon.
-
-
----
-
-### codePrefix
-- codePrefix: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the prefix defined for coupons of type [TYPE_SYSTEM_CODES](dw.campaign.Coupon.md#type_system_codes)
-      If no prefix is defined, or coupon is of type [TYPE_SINGLE_CODE](dw.campaign.Coupon.md#type_single_code)
-      or [TYPE_MULTIPLE_CODES](dw.campaign.Coupon.md#type_multiple_codes), null is returned.
-
-
-
----
-
-### enabled
-- enabled: [Boolean](TopLevel.Boolean.md) `(read-only)`
-  - : Returns true if coupon is enabled, else false.
-
-
----
-
-### nextCouponCode
-- nextCouponCode: [String](TopLevel.String.md) `(read-only)`
-  - : 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.
-
-
-
----
-
-### promotions
-- promotions: [Collection](dw.util.Collection.md) `(read-only)`
-  - : Returns the coupon-based promotions directly or indirectly (through
-      campaigns) assigned to this coupon.
-
-
-
----
-
-### redemptionLimitPerCode
-- redemptionLimitPerCode: [Number](TopLevel.Number.md) `(read-only)`
-  - : 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.
-
-
-
----
-
-### redemptionLimitPerCustomer
-- redemptionLimitPerCustomer: [Number](TopLevel.Number.md) `(read-only)`
-  - : 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.
-
-
-
----
-
-### redemptionLimitPerTimeFrame
-- redemptionLimitPerTimeFrame: [Number](TopLevel.Number.md) `(read-only)`
-  - : Returns the defined limit on redemption per customer per time-frame (see
-      [getRedemptionLimitTimeFrame()](dw.campaign.Coupon.md#getredemptionlimittimeframe). Null is returned if no limit is
-      defined, which means that there is no time-specific redemption limit for
-      customers.
-
-
-    **See Also:**
-    - [getRedemptionLimitTimeFrame()](dw.campaign.Coupon.md#getredemptionlimittimeframe)
-
-
----
-
-### redemptionLimitTimeFrame
-- redemptionLimitTimeFrame: [Number](TopLevel.Number.md) `(read-only)`
-  - : 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.
-
-
-    **See Also:**
-    - [getRedemptionLimitPerTimeFrame()](dw.campaign.Coupon.md#getredemptionlimitpertimeframe)
-
-
----
-
-### type
-- type: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the coupon type.
-      Possible values are [TYPE_SINGLE_CODE](dw.campaign.Coupon.md#type_single_code), [TYPE_MULTIPLE_CODES](dw.campaign.Coupon.md#type_multiple_codes)
-      and [TYPE_SYSTEM_CODES](dw.campaign.Coupon.md#type_system_codes).
-
-
-
----
-
-## Method Details
-
-### getCodePrefix()
-- getCodePrefix(): [String](TopLevel.String.md)
-  - : Returns the prefix defined for coupons of type [TYPE_SYSTEM_CODES](dw.campaign.Coupon.md#type_system_codes)
-      If no prefix is defined, or coupon is of type [TYPE_SINGLE_CODE](dw.campaign.Coupon.md#type_single_code)
-      or [TYPE_MULTIPLE_CODES](dw.campaign.Coupon.md#type_multiple_codes), null is returned.
-
-
-    **Returns:**
-    - Coupon code prefix or null
-
-
----
-
-### getID()
-- getID(): [String](TopLevel.String.md)
-  - : Returns the ID of the coupon.
-
-    **Returns:**
-    - Coupon ID
-
-
----
-
-### getNextCouponCode()
-- getNextCouponCode(): [String](TopLevel.String.md)
-  - : 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()
-- getPromotions(): [Collection](dw.util.Collection.md)
-  - : 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()
-- getRedemptionLimitPerCode(): [Number](TopLevel.Number.md)
-  - : 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()
-- getRedemptionLimitPerCustomer(): [Number](TopLevel.Number.md)
-  - : 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()
-- getRedemptionLimitPerTimeFrame(): [Number](TopLevel.Number.md)
-  - : Returns the defined limit on redemption per customer per time-frame (see
-      [getRedemptionLimitTimeFrame()](dw.campaign.Coupon.md#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()](dw.campaign.Coupon.md#getredemptionlimittimeframe)
-
-
----
-
-### getRedemptionLimitTimeFrame()
-- getRedemptionLimitTimeFrame(): [Number](TopLevel.Number.md)
-  - : 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()](dw.campaign.Coupon.md#getredemptionlimitpertimeframe)
-
-
----
-
-### getType()
-- getType(): [String](TopLevel.String.md)
-  - : Returns the coupon type.
-      Possible values are [TYPE_SINGLE_CODE](dw.campaign.Coupon.md#type_single_code), [TYPE_MULTIPLE_CODES](dw.campaign.Coupon.md#type_multiple_codes)
-      and [TYPE_SYSTEM_CODES](dw.campaign.Coupon.md#type_system_codes).
-
-
-    **Returns:**
-    - Coupon type
-
-
----
-
-### isEnabled()
-- isEnabled(): [Boolean](TopLevel.Boolean.md)
-  - : Returns true if coupon is enabled, else false.
-
-    **Returns:**
-    - true if coupon is enabled.
-
-
----
-
-<!-- prettier-ignore-end -->

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

@@ -1,137 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class CouponMgr
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.campaign.CouponMgr](dw.campaign.CouponMgr.md)
-
-Manager to access coupons.
-
-
-## Constant Summary
-
-| Constant | Description |
-| --- | --- |
-| [MR_ERROR_INVALID_SITE_ID](#mr_error_invalid_site_id): [String](TopLevel.String.md) = "MASKREDEMPTIONS_SITE_NOT_FOUND" | Indicates that an error occurred because a valid data domain cannot be found for given siteID. |
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [coupons](#coupons): [Collection](dw.util.Collection.md) `(read-only)` | Returns all coupons in the current site in no specific order. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| static [getCoupon](dw.campaign.CouponMgr.md#getcouponstring)([String](TopLevel.String.md)) | Returns the coupon with the specified ID. |
-| static [getCouponByCode](dw.campaign.CouponMgr.md#getcouponbycodestring)([String](TopLevel.String.md)) | Tries to find a coupon for the given coupon code. |
-| static [getCoupons](dw.campaign.CouponMgr.md#getcoupons)() | Returns all coupons in the current site in no specific order. |
-| static [getRedemptions](dw.campaign.CouponMgr.md#getredemptionsstring-string)([String](TopLevel.String.md), [String](TopLevel.String.md)) | Returns list of CouponRedemptions for the specified coupon and coupon code,  sorted by redemption date descending (i.e. |
-| static [maskRedemptions](dw.campaign.CouponMgr.md#maskredemptionsstring-string)([String](TopLevel.String.md), [String](TopLevel.String.md)) | Mask customer email address in coupon redemptions for the given siteID and email address |
-
-### 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
-
-### MR_ERROR_INVALID_SITE_ID
-
-- MR_ERROR_INVALID_SITE_ID: [String](TopLevel.String.md) = "MASKREDEMPTIONS_SITE_NOT_FOUND"
-  - : Indicates that an error occurred because a valid data domain cannot be found for given siteID.
-
-
----
-
-## Property Details
-
-### coupons
-- coupons: [Collection](dw.util.Collection.md) `(read-only)`
-  - : Returns all coupons in the current site in no specific order.
-
-
----
-
-## Method Details
-
-### getCoupon(String)
-- static getCoupon(couponID: [String](TopLevel.String.md)): [Coupon](dw.campaign.Coupon.md)
-  - : Returns the coupon with the specified ID.
-
-    **Parameters:**
-    - couponID - the coupon identifier.
-
-    **Returns:**
-    - Coupon with specified ID or null
-
-
----
-
-### getCouponByCode(String)
-- static getCouponByCode(couponCode: [String](TopLevel.String.md)): [Coupon](dw.campaign.Coupon.md)
-  - : 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()
-- static getCoupons(): [Collection](dw.util.Collection.md)
-  - : Returns all coupons in the current site in no specific order.
-
-    **Returns:**
-    - Coupons in current site
-
-
----
-
-### getRedemptions(String, String)
-- static getRedemptions(couponID: [String](TopLevel.String.md), couponCode: [String](TopLevel.String.md)): [Collection](dw.util.Collection.md)
-  - : 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(String, String)
-- static maskRedemptions(siteID: [String](TopLevel.String.md), email: [String](TopLevel.String.md)): [Status](dw.system.Status.md)
-  - : 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
-
-
----
-
-<!-- prettier-ignore-end -->

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

@@ -1,87 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class CouponRedemption
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.campaign.CouponRedemption](dw.campaign.CouponRedemption.md)
-
-Represents a redeemed coupon.
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [customerEmail](#customeremail): [String](TopLevel.String.md) `(read-only)` | Returns email of redeeming customer. |
-| [orderNo](#orderno): [String](TopLevel.String.md) `(read-only)` | Returns number of the order the code was redeemed with. |
-| [redemptionDate](#redemptiondate): [Date](TopLevel.Date.md) `(read-only)` | Returns date of redemption. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getCustomerEmail](dw.campaign.CouponRedemption.md#getcustomeremail)() | Returns email of redeeming customer. |
-| [getOrderNo](dw.campaign.CouponRedemption.md#getorderno)() | Returns number of the order the code was redeemed with. |
-| [getRedemptionDate](dw.campaign.CouponRedemption.md#getredemptiondate)() | Returns date of redemption. |
-
-### 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
-
-### customerEmail
-- customerEmail: [String](TopLevel.String.md) `(read-only)`
-  - : Returns email of redeeming customer.
-
-
----
-
-### orderNo
-- orderNo: [String](TopLevel.String.md) `(read-only)`
-  - : Returns number of the order the code was redeemed with.
-
-
----
-
-### redemptionDate
-- redemptionDate: [Date](TopLevel.Date.md) `(read-only)`
-  - : Returns date of redemption.
-
-
----
-
-## Method Details
-
-### getCustomerEmail()
-- getCustomerEmail(): [String](TopLevel.String.md)
-  - : Returns email of redeeming customer.
-
-    **Returns:**
-    - email of redeeming customer.
-
-
----
-
-### getOrderNo()
-- getOrderNo(): [String](TopLevel.String.md)
-  - : Returns number of the order the code was redeemed with.
-
-    **Returns:**
-    - number of the order the code was redeemed with.
-
-
----
-
-### getRedemptionDate()
-- getRedemptionDate(): [Date](TopLevel.Date.md)
-  - : Returns date of redemption.
-
-    **Returns:**
-    - date of redemption.
-
-
----
-
-<!-- prettier-ignore-end -->

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

@@ -1,130 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class CouponStatusCodes
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.campaign.CouponStatusCodes](dw.campaign.CouponStatusCodes.md)
-
-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.
-
-
-
-## Constant Summary
-
-| Constant | Description |
-| --- | --- |
-| [APPLIED](#applied): [String](TopLevel.String.md) = "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](#coupon_already_in_basket): [String](TopLevel.String.md) = "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](#coupon_code_already_in_basket): [String](TopLevel.String.md) = "COUPON_CODE_ALREADY_IN_BASKET" | Indicates that coupon code has already been added to basket. |
-| [COUPON_CODE_ALREADY_REDEEMED](#coupon_code_already_redeemed): [String](TopLevel.String.md) = "COUPON_CODE_ALREADY_REDEEMED" | Indicates that code of MultiCode/System coupon has already been redeemed. |
-| [COUPON_CODE_UNKNOWN](#coupon_code_unknown): [String](TopLevel.String.md) = "COUPON_CODE_UNKNOWN" | Indicates that coupon not found for given coupon code or that the code itself was not found. |
-| [COUPON_DISABLED](#coupon_disabled): [String](TopLevel.String.md) = "COUPON_DISABLED" | Indicates that coupon is not enabled. |
-| [CUSTOMER_REDEMPTION_LIMIT_EXCEEDED](#customer_redemption_limit_exceeded): [String](TopLevel.String.md) = "CUSTOMER_REDEMPTION_LIMIT_EXCEEDED" | Indicates that No. |
-| [NO_ACTIVE_PROMOTION](#no_active_promotion): [String](TopLevel.String.md) = "NO_ACTIVE_PROMOTION" | Indicates that coupon is not assigned to an active promotion. |
-| [NO_APPLICABLE_PROMOTION](#no_applicable_promotion): [String](TopLevel.String.md) = "NO_APPLICABLE_PROMOTION" | Coupon is assigned to one or multiple active promotions, but none of these promotions is currently applicable. |
-| [REDEMPTION_LIMIT_EXCEEDED](#redemption_limit_exceeded): [String](TopLevel.String.md) = "REDEMPTION_LIMIT_EXCEEDED" | Indicates that no. |
-| [TIMEFRAME_REDEMPTION_LIMIT_EXCEEDED](#timeframe_redemption_limit_exceeded): [String](TopLevel.String.md) = "TIMEFRAME_REDEMPTION_LIMIT_EXCEEDED" | Indicates that No. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-### 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
-
-### APPLIED
-
-- APPLIED: [String](TopLevel.String.md) = "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
-
-- COUPON_ALREADY_IN_BASKET: [String](TopLevel.String.md) = "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
-
-- COUPON_CODE_ALREADY_IN_BASKET: [String](TopLevel.String.md) = "COUPON_CODE_ALREADY_IN_BASKET"
-  - : Indicates that coupon code has already been added to basket.
-
-
----
-
-### COUPON_CODE_ALREADY_REDEEMED
-
-- COUPON_CODE_ALREADY_REDEEMED: [String](TopLevel.String.md) = "COUPON_CODE_ALREADY_REDEEMED"
-  - : Indicates that code of MultiCode/System coupon has already been redeemed.
-
-
----
-
-### COUPON_CODE_UNKNOWN
-
-- COUPON_CODE_UNKNOWN: [String](TopLevel.String.md) = "COUPON_CODE_UNKNOWN"
-  - : Indicates that coupon not found for given coupon code or that the code itself was not found.
-
-
----
-
-### COUPON_DISABLED
-
-- COUPON_DISABLED: [String](TopLevel.String.md) = "COUPON_DISABLED"
-  - : Indicates that coupon is not enabled.
-
-
----
-
-### CUSTOMER_REDEMPTION_LIMIT_EXCEEDED
-
-- CUSTOMER_REDEMPTION_LIMIT_EXCEEDED: [String](TopLevel.String.md) = "CUSTOMER_REDEMPTION_LIMIT_EXCEEDED"
-  - : Indicates that No. of redemptions per code & customer exceeded.
-
-
----
-
-### NO_ACTIVE_PROMOTION
-
-- NO_ACTIVE_PROMOTION: [String](TopLevel.String.md) = "NO_ACTIVE_PROMOTION"
-  - : Indicates that coupon is not assigned to an active promotion.
-
-
----
-
-### NO_APPLICABLE_PROMOTION
-
-- NO_APPLICABLE_PROMOTION: [String](TopLevel.String.md) = "NO_APPLICABLE_PROMOTION"
-  - : Coupon is assigned to one or multiple active promotions, but none of these promotions is currently applicable.
-
-
----
-
-### REDEMPTION_LIMIT_EXCEEDED
-
-- REDEMPTION_LIMIT_EXCEEDED: [String](TopLevel.String.md) = "REDEMPTION_LIMIT_EXCEEDED"
-  - : Indicates that no. of redemptions per code exceeded.
-      Usually happens for single code coupons
-
-
-
----
-
-### TIMEFRAME_REDEMPTION_LIMIT_EXCEEDED
-
-- TIMEFRAME_REDEMPTION_LIMIT_EXCEEDED: [String](TopLevel.String.md) = "TIMEFRAME_REDEMPTION_LIMIT_EXCEEDED"
-  - : Indicates that No. of redemptions per code,customer & time exceeded.
-
-
----
-
-<!-- prettier-ignore-end -->