@salesforce/b2c-cli 1.10.0 → 1.12.0

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/BasketMgr.d.ts

@@ -0,0 +1,406 @@
+import Basket = require('./Basket');
+import Order = require('./Order');
+import List = require('../util/List');
+
+/**
+ * Provides static helper methods for managing baskets.
+ */
+declare class BasketMgr {
+    /**
+     * 
+     * 
+     * Retrieve all open baskets for the logged in customer including the temporary baskets.
+     * 
+     * Restricted to agent scenario use cases: The returned list contains all agent baskets created with
+     * createAgentBasket and the current storefront basket which can also be retrieved with
+     * getCurrentBasket. This method will result in an exception if called by a user without permission
+     * Create_Order_On_Behalf_Of or if no customer is logged in the session.
+     * 
+     * Please notice that baskets are invalidated after a certain amount of time and may not be returned anymore.
+     */
+    static readonly baskets: List<Basket>;
+    /**
+     * This method returns the current valid basket of the session customer or `null` if no current valid
+     * basket exists.
+     * 
+     * The methods getCurrentBasket and getCurrentOrNewBasket work based on the selected basket
+     * persistence, which can be configured in the Business Manager site preferences / baskets section. A basket is
+     * valid for the configured basket lifetime.
+     * 
+     * In hybrid storefront scenarios (Phased Launch sites that utilize SFRA/SiteGenesis for some part while also
+     * utilizing PWA Kit or other custom headless solution for another part of the same site), this method must
+     * NOT be used. Instead, retrieve baskets via `GET baskets/{basketId}` or
+     * `GET customers/{customerId}/baskets`. Do not use getCurrentOrNewBasket for basket creation
+     * in any scenario.
+     * 
+     * The current basket, if one exists, is usually updated by the method. In particular the last-modified date is
+     * updated. No update is done when method getCurrentBasket is used within a read-only hook
+     * implementation (such as a beforeGet or a modifyResponse hook). The lifetime of a basket can be extended
+     * in 2 ways:
+     * 
+     * - The basket is modified in some way, e.g. a product is added resulting in the basket total being newly
+     * calculated. This results in the basket lifetime being reset.
+     * - The basket has not been modified for 60 minutes, then using this method to access the basket will also reset
+     * the basket lifetime.
+     * 
+     * What happens when a customer logs in? Personal data held inside the basket such as addresses, email addresses and
+     * payment settings is associated with the customer to whom the basket belongs. If the basket being updated belongs
+     * to a different customer this data is removed. This happens when a guest customer that has a basket logs in and
+     * hence identifies as a registered customer. In this case the basket which was previously created by the guest
+     * customer gets transferred to the (now logged in) registered customer. Should the registered customer already have
+     * a basket, this basket is effectively invalidated, but made available using getStoredBasket allowing
+     * the script to merge content from it if desired.
+     * 
+     * What happens when a customer logs out or when the customer session times out? After the customer logs out, a
+     * basket belonging to the registered customer (now logged out) is stored (where applicable) and this method
+     * returns `null`. Personal data is also cleared when the session times out for a guest customer.
+     * 
+     * The following personal data is cleared:
+     * 
+     * - product line items that were added from a wish list
+     * - shipping method
+     * - coupon line items
+     * - gift certificate line items
+     * - billing and shipping addresses
+     * - payment instruments
+     * - buyer email
+     * 
+     * If the session currency no longer matches the basket currency, the basket currency should be updated with
+     * dw.order.Basket.updateCurrency.
+     * 
+     * Typical usage:
+     * 
+     * ```
+     * var basket : Basket = BasketMgr.getCurrentBasket();
+     * if (basket) {
+     * // do something with basket
+     * }
+     * ```
+     * 
+     * Constraints:
+     * 
+     * - The method only accesses the basket for the session customer, an exception is thrown when the session
+     * customer is `null`.
+     * - Method getCurrentOrNewBasket only creates a basket when method getCurrentBasket returns
+     * `null`.
+     */
+    static readonly currentBasket: Basket | null;
+    /**
+     * 
+     * 
+     * This method returns the current valid basket of the session customer or creates a new one if no current valid
+     * basket exists. See getCurrentBasket for more details.
+     * 
+     * In hybrid storefront scenarios (Phased Launch sites that utilize SFRA/SiteGenesis for some part while also
+     * utilizing PWA Kit or other custom headless solution for another part of the same site), this method must
+     * NOT be used. For these scenarios, create baskets via `POST baskets` REST calls.
+     */
+    static readonly currentOrNewBasket: Basket;
+    /**
+     * 
+     * 
+     * This method returns the stored basket of the session customer or `null` if none is found. A stored
+     * basket is returned in the following situation:
+     * 
+     * - During one visit, a customer-Q logs in and creates a basket-A by adding products to it.
+     * - During a subsequent visit, a second basket-B is created for a guest customer who then logs in as
+     * customer-Q.
+     * 
+     * In this case, basket-B is reassigned to customer-Q and basket-A is accessible as the stored basket using this
+     * method. It is now possible to merge the information from the stored basket (basket-A) to the active basket
+     * (basket-B). If this method returns `null` in the previous scenario, verify that:
+     * 
+     * - The session handling between the two visits is correct - the first visit and second visit must be in
+     * different sessions. Furthermore, the second session must contain both basket creations: as guest and the customer
+     * login.
+     * - The stored basket is not expired.
+     * - Basket persistence settings are configured correctly in the Business Manager.
+     * 
+     * A stored basket exists only if the corresponding setting is selected in Business Manager. preferences' baskets
+     * section. A basket is valid for the configured basket lifetime.
+     * 
+     * Typical usage:
+     * 
+     * ```
+     * var currentBasket : Basket = BasketMgr.getCurrentOrNewBasket();
+     * var storedBasket : Basket = BasketMgr.getStoredBasket();
+     * if (storedBasket) {
+     * // transfer all the data needed from the stored to the active basket
+     * }
+     * ```
+     * 
+     * A exhaustive example on how to use this method in the context of the Merge Basket functionality can be found
+     * here: Merge Basket utility
+     * functions using Script API
+     */
+    static readonly storedBasket: Basket | null;
+    /**
+     * Retrieve all open temporary baskets for the logged in customer.
+     * 
+     * Please notice that baskets are invalidated after a certain amount of time and may not be returned anymore.
+     */
+    static readonly temporaryBaskets: List<Basket>;
+    private constructor();
+    /**
+     * Creates a new agent basket for the current session customer.
+     * 
+     * By default only 4 open agent baskets are allowed per customer. If this is exceeded a
+     * CreateAgentBasketLimitExceededException will be thrown.
+     * 
+     * This method will result in an exception if called by a user without permission Create_Order_On_Behalf_Of or if no
+     * customer is logged in the session.
+     * @throws CreateAgentBasketLimitExceededException indicates that no agent basket could be created because the agent basket limit is already exceeded
+     */
+    static createAgentBasket(): Basket;
+    /**
+     * 
+     * 
+     * Creates a Basket from an existing Order for the purposes of changing an Order. When an Order is later created
+     * from the Basket, the original Order is changed to status dw.order.Order.ORDER_STATUS_REPLACED. Restricted
+     * to agent scenario use cases.
+     * 
+     * In case a storefront customer is using it the created storefront basket cannot be retrieved via
+     * 
+     * - getCurrentBasket (ScriptAPI),
+     * - GET /baskets/<basketid> (REST APIs) or
+     * - DELETE /baskets/<basketid> (REST APIs) or
+     * - GetBasket (Pipelet) or
+     * - Basket-related CSC Operations from BM (these also use OCAPI REST API).
+     * 
+     * Baskets containing an "orderNumberBeingEdited" are explicitly excluded from the list of baskets that can be
+     * retrieved. Responsible for this behavior (this kind of basket cannot be used as general purpose shopping baskets)
+     * - see dw.order.Basket.getOrderNoBeingEdited / dw.order.Basket.getOrderBeingEdited.
+     * 
+     * In case a Business Manager user is logged in into the session the basket will be marked as an agent basket. See
+     * dw.order.Basket.isAgentBasket</>.
+     * 
+     * Any inventory reservation associated with the order will be canceled either early when
+     * dw.order.Basket.reserveInventory is called for the new basket or (later) when a new replacement order
+     * is created from the basket. Consider reserving the basket following its creation.
+     * 
+     * The method only succeeds for an Order
+     * 
+     * - without gift certificates,
+     * - status is not cancelled,
+     * - was not previously replaced and
+     * - was not previously exported.
+     * 
+     * Failures are indicated by throwing an APIException of type CreateBasketFromOrderException which provides one of
+     * these errorCodes:
+     * 
+     * - Code dw.order.OrderProcessStatusCodes.ORDER_CONTAINS_GC - the Order contains a gift certificate and
+     * cannot be replaced.
+     * - Code dw.order.OrderProcessStatusCodes.ORDER_ALREADY_REPLACED - the Order was already replaced.
+     * - Code dw.order.OrderProcessStatusCodes.ORDER_ALREADY_CANCELLED - the Order was cancelled.
+     * - Code dw.order.OrderProcessStatusCodes.ORDER_ALREADY_EXPORTED - the Order has already been
+     * exported.
+     * 
+     * Usage:
+     * @example
+     * var order : Order; // known
+     * try
+     * {
+     * var basket : Basket = BasketMgr.createBasketFromOrder(order);
+     * }
+     * catch (e)
+     * {
+     * if (e instanceof APIException && e.type === 'CreateBasketFromOrderException')
+     * {
+     * // handle e.errorCode
+     * }
+     * }
+     * @throws dw.order.CreateBasketFromOrderException indicates the Order is in an invalid state.
+     * @see dw.customer.AgentUserMgr.loginAgentUser
+     * @see dw.customer.AgentUserMgr.loginOnBehalfOfCustomer
+     */
+    static createBasketFromOrder(order: Order): Basket;
+    /**
+     * Creates a new temporary basket for the current session customer. Temporary baskets are separate from shopper
+     * storefront and agent baskets, and are intended for use to perform calculations or create an order without
+     * disturbing a shopper's open storefront basket. Temporary baskets are automatically deleted after a time duration
+     * of 15 minutes.
+     * 
+     * By default only 4 open temporary baskets are allowed per customer. If this is exceeded a
+     * CreateTemporaryBasketLimitExceededException will be thrown.
+     */
+    static createTemporaryBasket(): Basket;
+    /**
+     * Remove a customer basket including a temporary basket.
+     * 
+     * This method will result in an exception if called by a user without permission Create_Order_On_Behalf_Of or if no
+     * customer is logged in the session.
+     * @see dw.customer.AgentUserMgr.loginAgentUser
+     * @see dw.customer.AgentUserMgr.loginOnBehalfOfCustomer
+     */
+    static deleteBasket(basket: Basket): void;
+    /**
+     * Remove a customer temporary basket.
+     */
+    static deleteTemporaryBasket(basket: Basket): void;
+    /**
+     * This method returns a valid basket of the session customer or `null` if none is found. This method can
+     * also be used to get a temporary basket for the session customer.
+     * 
+     * If the basket does not belong to the session customer, the method returns `null`.
+     * 
+     * If the registered customer is not logged in, the method returns `null`.
+     * 
+     * Restricted to agent scenario use cases: This method will result in an exception if called by a user without
+     * permission Create_Order_On_Behalf_Of or if no customer is logged in the session.
+     * 
+     * The basket, if accessible, is usually updated in the same way as getCurrentBasket.
+     * 
+     * If the session currency no longer matches the basket currency, the basket currency should be updated with
+     * dw.order.Basket.updateCurrency.
+     */
+    static getBasket(uuid: string): Basket | null;
+    /**
+     * 
+     * 
+     * Retrieve all open baskets for the logged in customer including the temporary baskets.
+     * 
+     * Restricted to agent scenario use cases: The returned list contains all agent baskets created with
+     * createAgentBasket and the current storefront basket which can also be retrieved with
+     * getCurrentBasket. This method will result in an exception if called by a user without permission
+     * Create_Order_On_Behalf_Of or if no customer is logged in the session.
+     * 
+     * Please notice that baskets are invalidated after a certain amount of time and may not be returned anymore.
+     */
+    static getBaskets(): List<Basket>;
+    /**
+     * This method returns the current valid basket of the session customer or `null` if no current valid
+     * basket exists.
+     * 
+     * The methods getCurrentBasket and getCurrentOrNewBasket work based on the selected basket
+     * persistence, which can be configured in the Business Manager site preferences / baskets section. A basket is
+     * valid for the configured basket lifetime.
+     * 
+     * In hybrid storefront scenarios (Phased Launch sites that utilize SFRA/SiteGenesis for some part while also
+     * utilizing PWA Kit or other custom headless solution for another part of the same site), this method must
+     * NOT be used. Instead, retrieve baskets via `GET baskets/{basketId}` or
+     * `GET customers/{customerId}/baskets`. Do not use getCurrentOrNewBasket for basket creation
+     * in any scenario.
+     * 
+     * The current basket, if one exists, is usually updated by the method. In particular the last-modified date is
+     * updated. No update is done when method getCurrentBasket is used within a read-only hook
+     * implementation (such as a beforeGet or a modifyResponse hook). The lifetime of a basket can be extended
+     * in 2 ways:
+     * 
+     * - The basket is modified in some way, e.g. a product is added resulting in the basket total being newly
+     * calculated. This results in the basket lifetime being reset.
+     * - The basket has not been modified for 60 minutes, then using this method to access the basket will also reset
+     * the basket lifetime.
+     * 
+     * What happens when a customer logs in? Personal data held inside the basket such as addresses, email addresses and
+     * payment settings is associated with the customer to whom the basket belongs. If the basket being updated belongs
+     * to a different customer this data is removed. This happens when a guest customer that has a basket logs in and
+     * hence identifies as a registered customer. In this case the basket which was previously created by the guest
+     * customer gets transferred to the (now logged in) registered customer. Should the registered customer already have
+     * a basket, this basket is effectively invalidated, but made available using getStoredBasket allowing
+     * the script to merge content from it if desired.
+     * 
+     * What happens when a customer logs out or when the customer session times out? After the customer logs out, a
+     * basket belonging to the registered customer (now logged out) is stored (where applicable) and this method
+     * returns `null`. Personal data is also cleared when the session times out for a guest customer.
+     * 
+     * The following personal data is cleared:
+     * 
+     * - product line items that were added from a wish list
+     * - shipping method
+     * - coupon line items
+     * - gift certificate line items
+     * - billing and shipping addresses
+     * - payment instruments
+     * - buyer email
+     * 
+     * If the session currency no longer matches the basket currency, the basket currency should be updated with
+     * dw.order.Basket.updateCurrency.
+     * 
+     * Typical usage:
+     * 
+     * ```
+     * var basket : Basket = BasketMgr.getCurrentBasket();
+     * if (basket) {
+     * // do something with basket
+     * }
+     * ```
+     * 
+     * Constraints:
+     * 
+     * - The method only accesses the basket for the session customer, an exception is thrown when the session
+     * customer is `null`.
+     * - Method getCurrentOrNewBasket only creates a basket when method getCurrentBasket returns
+     * `null`.
+     */
+    static getCurrentBasket(): Basket | null;
+    /**
+     * 
+     * 
+     * This method returns the current valid basket of the session customer or creates a new one if no current valid
+     * basket exists. See getCurrentBasket for more details.
+     * 
+     * In hybrid storefront scenarios (Phased Launch sites that utilize SFRA/SiteGenesis for some part while also
+     * utilizing PWA Kit or other custom headless solution for another part of the same site), this method must
+     * NOT be used. For these scenarios, create baskets via `POST baskets` REST calls.
+     */
+    static getCurrentOrNewBasket(): Basket;
+    /**
+     * 
+     * 
+     * This method returns the stored basket of the session customer or `null` if none is found. A stored
+     * basket is returned in the following situation:
+     * 
+     * - During one visit, a customer-Q logs in and creates a basket-A by adding products to it.
+     * - During a subsequent visit, a second basket-B is created for a guest customer who then logs in as
+     * customer-Q.
+     * 
+     * In this case, basket-B is reassigned to customer-Q and basket-A is accessible as the stored basket using this
+     * method. It is now possible to merge the information from the stored basket (basket-A) to the active basket
+     * (basket-B). If this method returns `null` in the previous scenario, verify that:
+     * 
+     * - The session handling between the two visits is correct - the first visit and second visit must be in
+     * different sessions. Furthermore, the second session must contain both basket creations: as guest and the customer
+     * login.
+     * - The stored basket is not expired.
+     * - Basket persistence settings are configured correctly in the Business Manager.
+     * 
+     * A stored basket exists only if the corresponding setting is selected in Business Manager. preferences' baskets
+     * section. A basket is valid for the configured basket lifetime.
+     * 
+     * Typical usage:
+     * 
+     * ```
+     * var currentBasket : Basket = BasketMgr.getCurrentOrNewBasket();
+     * var storedBasket : Basket = BasketMgr.getStoredBasket();
+     * if (storedBasket) {
+     * // transfer all the data needed from the stored to the active basket
+     * }
+     * ```
+     * 
+     * A exhaustive example on how to use this method in the context of the Merge Basket functionality can be found
+     * here: Merge Basket utility
+     * functions using Script API
+     */
+    static getStoredBasket(): Basket | null;
+    /**
+     * This method returns a valid temporary basket of the session customer or `null` if none is found.
+     * 
+     * If the basket does not belong to the session customer, the method returns `null`.
+     * 
+     * If the basket is not a temporary basket, the method returns `null`.
+     * 
+     * The basket, if accessible, is usually updated in the same way as getCurrentBasket.
+     * 
+     * If the session currency no longer matches the basket currency, the basket currency should be updated with
+     * dw.order.Basket.updateCurrency.
+     */
+    static getTemporaryBasket(uuid: string): Basket | null;
+    /**
+     * Retrieve all open temporary baskets for the logged in customer.
+     * 
+     * Please notice that baskets are invalidated after a certain amount of time and may not be returned anymore.
+     */
+    static getTemporaryBaskets(): List<Basket>;
+}
+
+export = BasketMgr;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/BonusDiscountLineItem.d.ts

@@ -0,0 +1,170 @@
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+import Promotion = require('../campaign/Promotion');
+import CouponLineItem = require('./CouponLineItem');
+import List = require('../util/List');
+import Product = require('../catalog/Product');
+import Money = require('../value/Money');
+import ProductLineItem = require('./ProductLineItem');
+
+declare global {
+    module ICustomAttributes {
+        interface BonusDiscountLineItem extends CustomAttributes {
+        }
+    }
+}
+
+/**
+ * Line item representing an applied dw.campaign.BonusChoiceDiscount in a LineItemCtnr. This type of line item
+ * can only be created by the B2C Commerce promotions engine when applying a BonusChoiceDiscount.
+ * A BonusDiscountLineItem is basically a placeholder in the cart which entitles a customer to add one or more bonus
+ * products to his basket from a configured list of products. Merchants typically display this type of line item in the
+ * cart by showing the corresponding promotion callout message. They typically provide links to the bonus products that
+ * the customer can choose from. This line item can be removed from the cart but will be re-added each time the
+ * promotions engine re-applies discounts. Merchants may however add custom logic to show/hide this line item since it
+ * just a placeholder and not an actual product line item.
+ * 
+ * The number of products that a customer is allowed to choose from is determined by getMaxBonusItems. The
+ * collection of products the customer can choose from is determined by getBonusProducts. When a customer
+ * chooses a bonus product in the storefront, it is necessary to use the `AddBonusProductToBasket` pipelet
+ * instead of the usual `AddProductToBasket` pipelet, in order to associate this BonusDiscountLineItem with
+ * the newly created bonus ProductLineItem. Alternatively, the API method
+ * dw.order.LineItemCtnr.createBonusProductLineItem
+ * can be used instead. The system does proper validations in order to prevent incorrect or too many bonus products from
+ * being associated with this BonusDiscountLineItem. Once a customer has selected bonus products, the product line items
+ * representing the chosen bonus products can be retrieved with getBonusProductLineItems.
+ * @see dw.campaign.BonusChoiceDiscount
+ */
+declare class BonusDiscountLineItem extends ExtensibleObject<ICustomAttributes.BonusDiscountLineItem> {
+    /**
+     * Returns whether the promotion that triggered the creation of this line item uses a rule to determine the list of
+     * bonus products.
+     * 
+     * If the promotion is rule based, then a ProductSearchModel should be used to return the bonus products the
+     * customer may choose from, as the methods that return lists will return nothing. See getBonusProducts
+     */
+    readonly bonusChoiceRuleBased: boolean;
+    /**
+     * Get the product line items in the current LineItemCtnr representing the
+     * bonus products that the customer has selected for this discount.
+     * @see dw.order.LineItemCtnr.createBonusProductLineItem
+     */
+    readonly bonusProductLineItems: List<ProductLineItem>;
+    /**
+     * Get the list of bonus products which the customer is allowed to choose
+     * from for this discount. This list is configured by a merchant entering a
+     * list of SKUs for the discount. Products which do not exist in the system,
+     * or are offline, or are not assigned to a category in the site catalog are
+     * filtered out. Unavailable (i.e. out-of-stock) products are NOT filtered
+     * out. This allows merchants to display out-of-stock bonus products with
+     * appropriate messaging.
+     * 
+     * If the promotion which triggered this discount does not exist, or this
+     * promotion is rule based, then this method returns an empty list.
+     * 
+     * If the promotion is rule based, then this method will return an empty list.
+     * A ProductSearchModel should be used to return the bonus products the
+     * customer may choose from instead. See
+     * dw.catalog.ProductSearchModel.PROMOTION_PRODUCT_TYPE_BONUS and
+     * dw.catalog.ProductSearchModel.setPromotionID
+     * 
+     * If a returned product is a master product, the customer is entitled to
+     * choose from any variant. If the product is an option product, the
+     * customer is entitled to choose any value for each option. Since the
+     * promotions engine does not touch the value of the product option line
+     * items, it is the responsibility of custom code to set option prices.
+     */
+    readonly bonusProducts: List<Product<any>>;
+    /**
+     * Get the coupon line item associated with this discount.
+     */
+    readonly couponLineItem: CouponLineItem | null;
+    /**
+     * Get the maximum number of bonus items that the customer is permitted to
+     * select for this bonus discount.
+     * 
+     * If the promotion which triggered this discount does not exist, then this
+     * method returns 0.
+     */
+    readonly maxBonusItems: number;
+    /**
+     * Get the promotion associated with this discount.
+     */
+    readonly promotion: Promotion | null;
+    /**
+     * Get the promotion ID associated with this discount.
+     */
+    readonly promotionID: string;
+    private constructor();
+    /**
+     * Get the product line items in the current LineItemCtnr representing the
+     * bonus products that the customer has selected for this discount.
+     * @see dw.order.LineItemCtnr.createBonusProductLineItem
+     */
+    getBonusProductLineItems(): List<ProductLineItem>;
+    /**
+     * Get the effective price for the passed bonus product. This is expected to
+     * be one of the products returned by getBonusProducts with one
+     * exception: If a master product is configured as a bonus product, this
+     * implies that a customer may choose from any of its variants. In this
+     * case, it is allowed to pass in a variant to this method and a price will
+     * be returned. If the passed product is not a valid bonus product, this
+     * method throws an exception.
+     */
+    getBonusProductPrice(product: Product<any>): Money;
+    /**
+     * Get the list of bonus products which the customer is allowed to choose
+     * from for this discount. This list is configured by a merchant entering a
+     * list of SKUs for the discount. Products which do not exist in the system,
+     * or are offline, or are not assigned to a category in the site catalog are
+     * filtered out. Unavailable (i.e. out-of-stock) products are NOT filtered
+     * out. This allows merchants to display out-of-stock bonus products with
+     * appropriate messaging.
+     * 
+     * If the promotion which triggered this discount does not exist, or this
+     * promotion is rule based, then this method returns an empty list.
+     * 
+     * If the promotion is rule based, then this method will return an empty list.
+     * A ProductSearchModel should be used to return the bonus products the
+     * customer may choose from instead. See
+     * dw.catalog.ProductSearchModel.PROMOTION_PRODUCT_TYPE_BONUS and
+     * dw.catalog.ProductSearchModel.setPromotionID
+     * 
+     * If a returned product is a master product, the customer is entitled to
+     * choose from any variant. If the product is an option product, the
+     * customer is entitled to choose any value for each option. Since the
+     * promotions engine does not touch the value of the product option line
+     * items, it is the responsibility of custom code to set option prices.
+     */
+    getBonusProducts(): List<Product<any>>;
+    /**
+     * Get the coupon line item associated with this discount.
+     */
+    getCouponLineItem(): CouponLineItem | null;
+    /**
+     * Get the maximum number of bonus items that the customer is permitted to
+     * select for this bonus discount.
+     * 
+     * If the promotion which triggered this discount does not exist, then this
+     * method returns 0.
+     */
+    getMaxBonusItems(): number;
+    /**
+     * Get the promotion associated with this discount.
+     */
+    getPromotion(): Promotion | null;
+    /**
+     * Get the promotion ID associated with this discount.
+     */
+    getPromotionID(): string;
+    /**
+     * Returns whether the promotion that triggered the creation of this line item uses a rule to determine the list of
+     * bonus products.
+     * 
+     * If the promotion is rule based, then a ProductSearchModel should be used to return the bonus products the
+     * customer may choose from, as the methods that return lists will return nothing. See getBonusProducts
+     */
+    isBonusChoiceRuleBased(): boolean;
+}
+
+export = BonusDiscountLineItem;