@salesforce/b2c-cli 1.11.0 → 1.12.0

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/CampaignMgr.d.ts

@@ -0,0 +1,192 @@
+import Campaign = require('./Campaign');
+import Promotion = require('./Promotion');
+import Collection = require('../util/Collection');
+import Product = require('../catalog/Product');
+import LineItemCtnr = require('../order/LineItemCtnr');
+
+/**
+ * CampaignMgr provides static methods for managing campaign-specific operations
+ * such as accessing promotions or updating promotion line items.
+ * @deprecated Use dw.campaign.PromotionMgr instead.
+ */
+declare class CampaignMgr {
+    /**
+     * 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 dw.campaign.PromotionMgr.getActiveCustomerPromotions and
+     * dw.campaign.PromotionPlan.getPromotions
+     */
+    static readonly applicablePromotions: Collection<Promotion>;
+    private constructor();
+    /**
+     * This method has been deprecated and should not be used anymore.
+     * Instead, use dw.campaign.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 and
+     * applyOrderPromotions.
+     * 
+     * The method returns 'true' if any the line item container contains
+     * any bonus product line items, and otherwise false.
+     * @deprecated Use dw.campaign.PromotionMgr instead.
+     */
+    static applyBonusPromotions(lineItemCtnr: LineItemCtnr<any>, promotions: Collection<any>): boolean;
+    /**
+     * 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 dw.campaign.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).
+     * @deprecated Use dw.campaign.PromotionMgr
+     */
+    static applyOrderPromotions(lineItemCtnr: LineItemCtnr<any>, promotions: Collection<any>): boolean;
+    /**
+     * 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 dw.campaign.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).
+     * @deprecated Use dw.campaign.PromotionMgr
+     */
+    static applyProductPromotions(lineItemCtnr: LineItemCtnr<any>, promotions: Collection<any>): boolean;
+    /**
+     * 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 dw.campaign.PromotionMgr to apply promotions to
+     * line item containers.
+     * @deprecated Use dw.campaign.PromotionMgr
+     */
+    static applyShippingPromotions(lineItemCtnr: LineItemCtnr<any>, promotions: Collection<any>): boolean;
+    /**
+     * 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
+     * dw.campaign.PromotionMgr.getActiveCustomerPromotions and
+     * dw.campaign.PromotionPlan.getProductPromotions.
+     * Unlike getApplicableConditionalPromotions,
+     * dw.campaign.PromotionPlan.getProductPromotions
+     * 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 dw.campaign.PromotionMgr.getActiveCustomerPromotions and
+     * dw.campaign.PromotionPlan.getProductPromotions
+     */
+    static getApplicableConditionalPromotions(product: Product<any>): Collection<Promotion>;
+    /**
+     * 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
+     * dw.campaign.PromotionMgr.getActiveCustomerPromotions and
+     * dw.campaign.PromotionPlan.getProductPromotions.
+     * Unlike getApplicablePromotions,
+     * dw.campaign.PromotionPlan.getProductPromotions
+     * 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 dw.campaign.PromotionMgr.getActiveCustomerPromotions and
+     * dw.campaign.PromotionPlan.getProductPromotions
+     */
+    static getApplicablePromotions(product: Product<any>): Collection<Promotion>;
+    /**
+     * 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.
+     */
+    static getApplicablePromotions(lineItemCtnr: LineItemCtnr<any>): Collection<Promotion>;
+    /**
+     * 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 dw.campaign.PromotionMgr.getActiveCustomerPromotions and
+     * dw.campaign.PromotionPlan.getPromotions
+     */
+    static getApplicablePromotions(): Collection<Promotion>;
+    /**
+     * Returns the campaign identified by the specified ID.
+     * @deprecated Use dw.campaign.PromotionMgr.getCampaign
+     */
+    static getCampaignByID(id: string): Campaign | null;
+    /**
+     * 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
+     * dw.campaign.PromotionMgr.getActiveCustomerPromotions and
+     * dw.campaign.PromotionPlan.getProductPromotions.
+     * Unlike getConditionalPromotions,
+     * dw.campaign.PromotionPlan.getProductPromotions
+     * 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 dw.campaign.PromotionMgr.getActivePromotions and
+     * dw.campaign.PromotionPlan.getProductPromotions
+     */
+    static getConditionalPromotions(product: Product<any>): Collection<Promotion>;
+    /**
+     * 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.
+     */
+    static getPromotion(couponCode: string): Promotion | null;
+    /**
+     * 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
+     */
+    static getPromotionByCouponCode(couponCode: string): Promotion | null;
+    /**
+     * Returns the promotion identified by the specified ID.
+     * @deprecated Use dw.campaign.PromotionMgr.getPromotion
+     */
+    static getPromotionByID(id: string): Promotion | null;
+    /**
+     * 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
+     * dw.campaign.PromotionMgr.getActiveCustomerPromotions and
+     * dw.campaign.PromotionPlan.getProductPromotions.
+     * Unlike getPromotions,
+     * dw.campaign.PromotionPlan.getProductPromotions
+     * 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 dw.campaign.PromotionMgr.getActivePromotions and
+     * dw.campaign.PromotionPlan.getProductPromotions
+     */
+    static getPromotions(product: Product<any>): Collection<Promotion>;
+}
+
+export = CampaignMgr;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/CampaignStatusCodes.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Deprecated. Formerly used to contain the various statuses that a coupon may
+ * be in.
+ * @deprecated Use dw.campaign.CouponStatusCodes instead.
+ */
+declare class CampaignStatusCodes {
+    /**
+     * Indicates that the coupon has already been applied to the basket.
+     * @deprecated Use dw.campaign.CouponStatusCodes.COUPON_CODE_ALREADY_IN_BASKET,
+     * dw.campaign.CouponStatusCodes.COUPON_ALREADY_IN_BASKET instead.
+     */
+    static readonly COUPON_ALREADY_APPLIED = "COUPON_ALREADY_APPLIED";
+    /**
+     * Indicates that the coupon has already been redeemed.
+     * @deprecated Use dw.campaign.CouponStatusCodes.COUPON_CODE_ALREADY_REDEEMED instead.
+     */
+    static readonly COUPON_ALREADY_REDEEMED = "COUPON_ALREADY_REDEEMED";
+    /**
+     * Indicates that the coupon is not currently redeemable.
+     * @deprecated Use dw.campaign.CouponStatusCodes.COUPON_DISABLED,
+     * dw.campaign.CouponStatusCodes.COUPON_CODE_UNKNOWN,
+     * dw.campaign.CouponStatusCodes.REDEMPTION_LIMIT_EXCEEDED,
+     * dw.campaign.CouponStatusCodes.CUSTOMER_REDEMPTION_LIMIT_EXCEEDED,
+     * dw.campaign.CouponStatusCodes.TIMEFRAME_REDEMPTION_LIMIT_EXCEEDED or
+     * dw.campaign.CouponStatusCodes.NO_APPLICABLE_PROMOTION
+     */
+    static readonly COUPON_NOT_REDEEMABLE = "COUPON_NOT_REDEEMABLE";
+    /**
+     * Indicates that the coupon code is not valid.
+     * @deprecated Use dw.campaign.CouponStatusCodes.COUPON_CODE_UNKNOWN instead
+     */
+    static readonly COUPON_UNKNOWN = "COUPON_UNKNOWN";
+    private constructor();
+}
+
+export = CampaignStatusCodes;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/Coupon.d.ts

@@ -0,0 +1,146 @@
+import PersistentObject = require('../object/PersistentObject');
+import Collection = require('../util/Collection');
+import Promotion = require('./Promotion');
+
+/**
+ * Represents a coupon in Commerce Cloud Digital.
+ */
+declare class Coupon extends PersistentObject {
+    /**
+     * Constant representing coupon type multiple-codes.
+     */
+    static readonly TYPE_MULTIPLE_CODES: string;
+    /**
+     * Constant representing coupon type single-code.
+     */
+    static readonly TYPE_SINGLE_CODE: string;
+    /**
+     * Constant representing coupon type system-codes.
+     */
+    static readonly TYPE_SYSTEM_CODES: string;
+    /**
+     * Returns the ID of the coupon.
+     */
+    readonly ID: 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.
+     */
+    readonly codePrefix: string | null;
+    /**
+     * Returns true if coupon is enabled, else false.
+     */
+    readonly enabled: boolean;
+    /**
+     * 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.
+     */
+    readonly nextCouponCode: string | null;
+    /**
+     * Returns the coupon-based promotions directly or indirectly (through
+     * campaigns) assigned to this coupon.
+     */
+    readonly promotions: Collection<Promotion>;
+    /**
+     * 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.
+     */
+    readonly redemptionLimitPerCode: number;
+    /**
+     * 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.
+     */
+    readonly redemptionLimitPerCustomer: number;
+    /**
+     * 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.
+     * @see getRedemptionLimitTimeFrame
+     */
+    readonly redemptionLimitPerTimeFrame: number;
+    /**
+     * 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 getRedemptionLimitPerTimeFrame
+     */
+    readonly redemptionLimitTimeFrame: number;
+    /**
+     * Returns the coupon type.
+     * Possible values are TYPE_SINGLE_CODE, TYPE_MULTIPLE_CODES
+     * and TYPE_SYSTEM_CODES.
+     */
+    readonly type: string;
+    private constructor();
+    /**
+     * 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.
+     */
+    getCodePrefix(): string | null;
+    /**
+     * Returns the ID of the coupon.
+     */
+    getID(): string;
+    /**
+     * 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.
+     */
+    getNextCouponCode(): string | null;
+    /**
+     * Returns the coupon-based promotions directly or indirectly (through
+     * campaigns) assigned to this coupon.
+     */
+    getPromotions(): Collection<Promotion>;
+    /**
+     * 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.
+     */
+    getRedemptionLimitPerCode(): number;
+    /**
+     * 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.
+     */
+    getRedemptionLimitPerCustomer(): number;
+    /**
+     * 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.
+     * @see getRedemptionLimitTimeFrame
+     */
+    getRedemptionLimitPerTimeFrame(): number;
+    /**
+     * 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 getRedemptionLimitPerTimeFrame
+     */
+    getRedemptionLimitTimeFrame(): number;
+    /**
+     * Returns the coupon type.
+     * Possible values are TYPE_SINGLE_CODE, TYPE_MULTIPLE_CODES
+     * and TYPE_SYSTEM_CODES.
+     */
+    getType(): string;
+    /**
+     * Returns true if coupon is enabled, else false.
+     */
+    isEnabled(): boolean;
+}
+
+export = Coupon;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/CouponMgr.d.ts

@@ -0,0 +1,49 @@
+import Coupon = require('./Coupon');
+import Collection = require('../util/Collection');
+import CouponRedemption = require('./CouponRedemption');
+import Status = require('../system/Status');
+
+/**
+ * Manager to access coupons.
+ */
+declare class CouponMgr {
+    /**
+     * Indicates that an error occurred because a valid data domain cannot be found for given siteID.
+     */
+    static readonly MR_ERROR_INVALID_SITE_ID = "MASKREDEMPTIONS_SITE_NOT_FOUND";
+    /**
+     * Returns all coupons in the current site in no specific order.
+     */
+    static readonly coupons: Collection<Coupon>;
+    private constructor();
+    /**
+     * Returns the coupon with the specified ID.
+     */
+    static getCoupon(couponID: string): Coupon | null;
+    /**
+     * 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.
+     */
+    static getCouponByCode(couponCode: string): Coupon | null;
+    /**
+     * Returns all coupons in the current site in no specific order.
+     */
+    static getCoupons(): Collection<Coupon>;
+    /**
+     * 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.
+     */
+    static getRedemptions(couponID: string, couponCode: string): Collection<CouponRedemption>;
+    /**
+     * Mask customer email address in coupon redemptions for the given siteID and email address
+     */
+    static maskRedemptions(siteID: string, email: string): Status;
+}
+
+export = CouponMgr;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/CouponRedemption.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Represents a redeemed coupon.
+ */
+declare class CouponRedemption {
+    /**
+     * Returns email of redeeming customer.
+     */
+    readonly customerEmail: string;
+    /**
+     * Returns number of the order the code was redeemed with.
+     */
+    readonly orderNo: string;
+    /**
+     * Returns date of redemption.
+     */
+    readonly redemptionDate: Date;
+    private constructor();
+    /**
+     * Returns email of redeeming customer.
+     */
+    getCustomerEmail(): string;
+    /**
+     * Returns number of the order the code was redeemed with.
+     */
+    getOrderNo(): string;
+    /**
+     * Returns date of redemption.
+     */
+    getRedemptionDate(): Date;
+}
+
+export = CouponRedemption;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/CouponStatusCodes.d.ts

@@ -0,0 +1,55 @@
+/**
+ * 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.
+ */
+declare class CouponStatusCodes {
+    /**
+     * Coupon is currently applied in basket = Coupon code is valid for redemption and
+     * Coupon is assigned to one or multiple applicable promotions.
+     */
+    static readonly APPLIED: string;
+    /**
+     * Indicates that another code of the same MultiCode/System coupon has already been added to basket.
+     */
+    static readonly COUPON_ALREADY_IN_BASKET: string;
+    /**
+     * Indicates that coupon code has already been added to basket.
+     */
+    static readonly COUPON_CODE_ALREADY_IN_BASKET: string;
+    /**
+     * Indicates that code of MultiCode/System coupon has already been redeemed.
+     */
+    static readonly COUPON_CODE_ALREADY_REDEEMED: string;
+    /**
+     * Indicates that coupon not found for given coupon code or that the code itself was not found.
+     */
+    static readonly COUPON_CODE_UNKNOWN: string;
+    /**
+     * Indicates that coupon is not enabled.
+     */
+    static readonly COUPON_DISABLED: string;
+    /**
+     * Indicates that No. of redemptions per code & customer exceeded.
+     */
+    static readonly CUSTOMER_REDEMPTION_LIMIT_EXCEEDED: string;
+    /**
+     * Indicates that coupon is not assigned to an active promotion.
+     */
+    static readonly NO_ACTIVE_PROMOTION: string;
+    /**
+     * Coupon is assigned to one or multiple active promotions, but none of these promotions is currently applicable.
+     */
+    static readonly NO_APPLICABLE_PROMOTION: string;
+    /**
+     * Indicates that no. of redemptions per code exceeded.
+     * Usually happens for single code coupons
+     */
+    static readonly REDEMPTION_LIMIT_EXCEEDED: string;
+    /**
+     * Indicates that No. of redemptions per code,customer & time exceeded.
+     */
+    static readonly TIMEFRAME_REDEMPTION_LIMIT_EXCEEDED: string;
+    private constructor();
+}
+
+export = CouponStatusCodes;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/Discount.d.ts

@@ -0,0 +1,122 @@
+import Promotion = require('./Promotion');
+import utilMap = require('../util/Map');
+
+/**
+ * Superclass of all specific discount classes.
+ */
+declare abstract class Discount {
+    /**
+     * Constant representing discounts of type amount.
+     */
+    static readonly TYPE_AMOUNT: string;
+    /**
+     * Constant representing discounts of type bonus.
+     */
+    static readonly TYPE_BONUS: string;
+    /**
+     * Constant representing discounts of type bonus choice.
+     */
+    static readonly TYPE_BONUS_CHOICE: string;
+    /**
+     * Constant representing discounts of type fixed-price.
+     */
+    static readonly TYPE_FIXED_PRICE: string;
+    /**
+     * Constant representing discounts of type fixed price shipping.
+     */
+    static readonly TYPE_FIXED_PRICE_SHIPPING: string;
+    /**
+     * Constant representing discounts of type free.
+     */
+    static readonly TYPE_FREE: string;
+    /**
+     * Constant representing discounts of type free shipping.
+     */
+    static readonly TYPE_FREE_SHIPPING: string;
+    /**
+     * Constant representing discounts of type percentage.
+     */
+    static readonly TYPE_PERCENTAGE: string;
+    /**
+     * Constant representing discounts of type percent off options.
+     */
+    static readonly TYPE_PERCENTAGE_OFF_OPTIONS: string;
+    /**
+     * Constant representing discounts of type price book price.
+     */
+    static readonly TYPE_PRICEBOOK_PRICE: string;
+    /**
+     * Constant representing discounts of type total fixed price.
+     */
+    static readonly TYPE_TOTAL_FIXED_PRICE: string;
+    /**
+     * 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.
+     * @see getPromotionTier
+     */
+    readonly itemPromotionTiers: utilMap<any, any>;
+    /**
+     * Returns the promotion this discount is based on.
+     */
+    readonly promotion: Promotion;
+    /**
+     * 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.
+     */
+    readonly promotionTier: number;
+    /**
+     * 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.
+     */
+    readonly quantity: number;
+    /**
+     * Returns the type of the discount.
+     */
+    readonly type: string;
+    /**
+     * 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.
+     * @see getPromotionTier
+     */
+    getItemPromotionTiers(): utilMap<any, any>;
+    /**
+     * Returns the promotion this discount is based on.
+     */
+    getPromotion(): Promotion;
+    /**
+     * 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.
+     */
+    getPromotionTier(): number;
+    /**
+     * 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.
+     */
+    getQuantity(): number;
+    /**
+     * Returns the type of the discount.
+     */
+    getType(): string;
+}
+
+export = Discount;