@salesforce/b2c-cli 1.11.0 → 1.12.1

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

@@ -0,0 +1,151 @@
+import LineItem = require('./LineItem');
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+import Collection = require('../util/Collection');
+import PriceAdjustment = require('./PriceAdjustment');
+import Discount = require('../campaign/Discount');
+import Money = require('../value/Money');
+import OrderItem = require('./OrderItem');
+
+declare global {
+    module ICustomAttributes {
+        interface ShippingLineItem extends ICustomAttributes.LineItem {
+        }
+    }
+}
+
+/**
+ * Represents a specific line item in a shipment. The ShippingLineItem defines
+ * the general shipping costs of a shipment.
+ */
+declare class ShippingLineItem extends LineItem<ICustomAttributes.ShippingLineItem> {
+    /**
+     * Constant used to get the standard shipping line item.
+     */
+    static readonly STANDARD_SHIPPING_ID = "STANDARD_SHIPPING";
+    /**
+     * Returns the ID of this ShippingLineItem.
+     */
+    readonly ID: string;
+    /**
+     * Returns the price of this shipping line item including tax after
+     * shipping adjustments have been applied.
+     */
+    readonly adjustedGrossPrice: Money;
+    /**
+     * Returns the price of this shipping line item, excluding tax after
+     * shipping adjustments have been applied.
+     */
+    readonly adjustedNetPrice: Money;
+    /**
+     * Returns the adjusted price of this shipping line item. If the line item
+     * container is based on net pricing, the adjusted net price is returned. If
+     * the line item container is based on gross pricing, the adjusted gross
+     * price is returned.
+     */
+    readonly adjustedPrice: Money;
+    /**
+     * Returns the tax of this shipping line item after shipping adjustments
+     * have been applied.
+     */
+    readonly adjustedTax: Money;
+    /**
+     * Returns the dw.order.OrderItem order-item extension for this item, or `null`.
+     * An order-item extension will only exist for a ShippingLineItem which
+     * belongs to an dw.order.Order.
+     * 
+     * Order post-processing APIs (gillian) are now inactive by default and will throw
+     * an exception if accessed. Activation needs preliminary approval by Product Management.
+     * Please contact support in this case. Existing customers using these APIs are not
+     * affected by this change and can use the APIs until further notice.
+     */
+    readonly orderItem: OrderItem | null;
+    /**
+     * Returns the collection of shipping price adjustments that have been
+     * applied to this shipping line item.
+     */
+    readonly shippingPriceAdjustments: Collection<PriceAdjustment>;
+    private constructor();
+    /**
+     * Creates a shipping price adjustment to be applied to the shipping line item.
+     * 
+     * The promotion ID is mandatory and must not be the ID of any actual promotion defined in B2C Commerce.
+     * 
+     * If there already exists a shipping price adjustment on this shipping line item referring to the specified
+     * promotion ID, an exception is thrown.
+     */
+    createShippingPriceAdjustment(promotionID: string): PriceAdjustment;
+    /**
+     * Creates a shipping price adjustment to be applied to the shipping line item.
+     * 
+     * The promotion ID is mandatory and must not be the ID of any actual promotion defined in B2C Commerce. If a
+     * shipping price adjustment on this shipping line item referring to the specified promotion ID already exists, an
+     * exception is thrown.
+     * 
+     * The possible values for discount are dw.campaign.PercentageDiscount, dw.campaign.AmountDiscount,
+     * dw.campaign.FixedPriceShippingDiscount.
+     * 
+     * Examples:
+     * 
+     * `
+     * var myShippingItem : dw.order.ShippingLineItem; // assume known
+     * 
+     * var paFixedShippingPrice12 : dw.order.PriceAdjustment = myShippingItem.createPriceAdjustment("myPromotionID1", new FixedPriceShippingDiscount(12));
+     * 
+     * var paTenPercent : dw.order.PriceAdjustment = myShippingItem.createPriceAdjustment("myPromotionID2", new PercentageDiscount(10));
+     * 
+     * var paReduceBy2 : dw.order.PriceAdjustment = myShippingItem.createPriceAdjustment("myPromotionID3", new AmountDiscount(2));
+     * 
+     * `
+     */
+    createShippingPriceAdjustment(promotionID: string, discount: Discount): PriceAdjustment;
+    /**
+     * Returns the price of this shipping line item including tax after
+     * shipping adjustments have been applied.
+     */
+    getAdjustedGrossPrice(): Money;
+    /**
+     * Returns the price of this shipping line item, excluding tax after
+     * shipping adjustments have been applied.
+     */
+    getAdjustedNetPrice(): Money;
+    /**
+     * Returns the adjusted price of this shipping line item. If the line item
+     * container is based on net pricing, the adjusted net price is returned. If
+     * the line item container is based on gross pricing, the adjusted gross
+     * price is returned.
+     */
+    getAdjustedPrice(): Money;
+    /**
+     * Returns the tax of this shipping line item after shipping adjustments
+     * have been applied.
+     */
+    getAdjustedTax(): Money;
+    /**
+     * Returns the ID of this ShippingLineItem.
+     */
+    getID(): string;
+    /**
+     * Returns the dw.order.OrderItem order-item extension for this item, or `null`.
+     * An order-item extension will only exist for a ShippingLineItem which
+     * belongs to an dw.order.Order.
+     * 
+     * Order post-processing APIs (gillian) are now inactive by default and will throw
+     * an exception if accessed. Activation needs preliminary approval by Product Management.
+     * Please contact support in this case. Existing customers using these APIs are not
+     * affected by this change and can use the APIs until further notice.
+     */
+    getOrderItem(): OrderItem | null;
+    /**
+     * Returns the collection of shipping price adjustments that have been
+     * applied to this shipping line item.
+     */
+    getShippingPriceAdjustments(): Collection<PriceAdjustment>;
+    /**
+     * Removes the specified shipping price adjustment from this shipping line
+     * item.
+     */
+    removeShippingPriceAdjustment(priceAdjustment: PriceAdjustment): void;
+}
+
+export = ShippingLineItem;

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

@@ -0,0 +1,123 @@
+import CustomerAddress = require('../customer/CustomerAddress');
+import OrderAddress = require('./OrderAddress');
+
+/**
+ * Represents a specific location for a shipment.
+ * 
+ * Note: this class allows access to sensitive personal and private information.
+ * Pay attention to appropriate legal and regulatory requirements related to this data.
+ */
+declare class ShippingLocation {
+    /**
+     * Returns the shipping location's first address.
+     */
+    address1: string;
+    /**
+     * Returns the shipping location's second address.
+     */
+    address2: string;
+    /**
+     * Returns the shipping location's city.
+     */
+    city: string;
+    /**
+     * Returns the shipping location's country code.
+     */
+    countryCode: string;
+    /**
+     * Returns the shipping location's post box.
+     */
+    postBox: string;
+    /**
+     * Returns the shipping location's postal code.
+     */
+    postalCode: string;
+    /**
+     * Returns the shipping location's state code.
+     */
+    stateCode: string;
+    /**
+     * Returns the shipping location's suite.
+     */
+    suite: string;
+    /**
+     * Constructs a new shipping location.
+     */
+    constructor();
+    /**
+     * Constructs a new shipping location and initializes it with the values of the
+     * specified address object.
+     */
+    constructor(address: CustomerAddress);
+    /**
+     * Constructs a new shipping location and initializes it with the values of the
+     * specified address object.
+     */
+    constructor(address: OrderAddress);
+    /**
+     * Returns the shipping location's first address.
+     */
+    getAddress1(): string;
+    /**
+     * Returns the shipping location's second address.
+     */
+    getAddress2(): string;
+    /**
+     * Returns the shipping location's city.
+     */
+    getCity(): string;
+    /**
+     * Returns the shipping location's country code.
+     */
+    getCountryCode(): string;
+    /**
+     * Returns the shipping location's post box.
+     */
+    getPostBox(): string;
+    /**
+     * Returns the shipping location's postal code.
+     */
+    getPostalCode(): string;
+    /**
+     * Returns the shipping location's state code.
+     */
+    getStateCode(): string;
+    /**
+     * Returns the shipping location's suite.
+     */
+    getSuite(): string;
+    /**
+     * Sets the shipping location's first address.
+     */
+    setAddress1(aValue: string): void;
+    /**
+     * Sets the shipping location's second address.
+     */
+    setAddress2(aValue: string): void;
+    /**
+     * Sets the shipping location's city.
+     */
+    setCity(aValue: string): void;
+    /**
+     * Sets the shipping location's country code.
+     */
+    setCountryCode(aValue: string): void;
+    /**
+     * Sets the shipping location's post box.
+     */
+    setPostBox(aValue: string): void;
+    /**
+     * Sets the shipping location's postal code.
+     */
+    setPostalCode(aValue: string): void;
+    /**
+     * Sets the shipping location's state code.
+     */
+    setStateCode(aValue: string): void;
+    /**
+     * Sets the shipping location's suite.
+     */
+    setSuite(aValue: string): void;
+}
+
+export = ShippingLocation;

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

@@ -0,0 +1,114 @@
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+import Collection = require('../util/Collection');
+import CustomerGroup = require('../customer/CustomerGroup');
+
+declare global {
+    module ICustomAttributes {
+        interface ShippingMethod extends CustomAttributes {
+        }
+    }
+}
+
+/**
+ * ShippingMethod represents how the shipment will be shipped.
+ */
+declare class ShippingMethod extends ExtensibleObject<ICustomAttributes.ShippingMethod> {
+    /**
+     * Returns the ID of the shipping method.
+     */
+    readonly ID: string;
+    /**
+     * Returns the base shipping method or null if undefined.
+     */
+    readonly baseMethod: ShippingMethod | null;
+    /**
+     * Returns the currency code associated with the shipping method
+     */
+    readonly currencyCode: string;
+    /**
+     * Returns the customer groups assigned to the shipping method.
+     * Assigned ids that do not belong to an existing customer group are ignored.
+     */
+    readonly customerGroups: Collection<CustomerGroup>;
+    /**
+     * Returns 'true' if the shipping method is marked as 'default' for the current session's currency.
+     * Otherwise 'false' is returned.
+     */
+    readonly defaultMethod: boolean;
+    /**
+     * Returns the dependent shipping methods of this shipping method,
+     * regardless of the online status of the methods.
+     * 
+     * Dependent shipping methods have this method as their base method.
+     */
+    readonly dependentMethods: Collection<ShippingMethod>;
+    /**
+     * Returns the description of the shipping method as specified in the current locale or
+     * null if it could not be found.
+     */
+    readonly description: string | null;
+    /**
+     * Returns the display name of the shipping method in the current locale or
+     * null if it could not be found.
+     */
+    readonly displayName: string | null;
+    /**
+     * Returns true if shipping method is online, false otherwise
+     */
+    readonly online: boolean;
+    /**
+     * Returns the tax class id of the shipping method.
+     */
+    readonly taxClassID: string;
+    private constructor();
+    /**
+     * Returns the base shipping method or null if undefined.
+     */
+    getBaseMethod(): ShippingMethod | null;
+    /**
+     * Returns the currency code associated with the shipping method
+     */
+    getCurrencyCode(): string;
+    /**
+     * Returns the customer groups assigned to the shipping method.
+     * Assigned ids that do not belong to an existing customer group are ignored.
+     */
+    getCustomerGroups(): Collection<CustomerGroup>;
+    /**
+     * Returns the dependent shipping methods of this shipping method,
+     * regardless of the online status of the methods.
+     * 
+     * Dependent shipping methods have this method as their base method.
+     */
+    getDependentMethods(): Collection<ShippingMethod>;
+    /**
+     * Returns the description of the shipping method as specified in the current locale or
+     * null if it could not be found.
+     */
+    getDescription(): string | null;
+    /**
+     * Returns the display name of the shipping method in the current locale or
+     * null if it could not be found.
+     */
+    getDisplayName(): string | null;
+    /**
+     * Returns the ID of the shipping method.
+     */
+    getID(): string;
+    /**
+     * Returns the tax class id of the shipping method.
+     */
+    getTaxClassID(): string;
+    /**
+     * Returns 'true' if the shipping method is marked as 'default' for the current session's currency.
+     * Otherwise 'false' is returned.
+     */
+    isDefaultMethod(): boolean;
+    /**
+     * Returns true if shipping method is online, false otherwise
+     */
+    isOnline(): boolean;
+}
+
+export = ShippingMethod;

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

@@ -0,0 +1,95 @@
+import Money = require('../value/Money');
+import ShippingMethod = require('./ShippingMethod');
+import ProductShippingModel = require('./ProductShippingModel');
+import Product = require('../catalog/Product');
+import ShipmentShippingModel = require('./ShipmentShippingModel');
+import Shipment = require('./Shipment');
+import Collection = require('../util/Collection');
+import LineItemCtnr = require('./LineItemCtnr');
+
+/**
+ * Provides methods to access the shipping information.
+ */
+declare class ShippingMgr {
+    /**
+     * Returns the active shipping methods of the current site applicable to the session currency and current customer group.
+     */
+    static readonly allShippingMethods: Collection<ShippingMethod>;
+    /**
+     * Returns the default shipping method of the current site applicable to the session currency.
+     * 
+     * Does an additional check if there is a base method and if their currencies are
+     * the same. Returns NULL if the two currencies are different.
+     */
+    static readonly defaultShippingMethod: ShippingMethod | null;
+    private constructor();
+    /**
+     * Applies product and shipment-level shipping cost to the specified line
+     * item container.
+     * 
+     * For each product line item in the specified line item container, a
+     * product shipping line item is created if product-level shipping cost is
+     * defined for the product. If no product-level shipping cost is defined for
+     * the product, an existing product shipping line item is removed.
+     * 
+     * For each shipment in the specified line item container, shipment-level
+     * shipping cost is calculated. This cost is determined based on the
+     * merchandise total of the shipment after all product and order discounts.
+     * Only products without or with surcharge product-specific shipping cost
+     * count towards this merchandise total. Products with fixed
+     * product-specific shipping cost don't count towards the merchandise total
+     * used to calculate shipment-level shipping cost. The calculated shipping
+     * cost is set at the standard shipping line item of the shipment.
+     * 
+     * If 'net' taxation is configured for the site, the merchandise total
+     * before tax is used. If 'gross' taxation is configured for the site, the
+     * merchandise total after tax is used.
+     * 
+     * If no shipping method is set for a shipment, neither product nor
+     * shipment-level shipping cost can be calculated. In this case, the amount
+     * of the standard shipment shipping line item will be set to N/A, and
+     * shipping line items of product line items in this shipment will be
+     * removed from the line item container.
+     * 
+     * Special cases for product-level shipping cost:
+     * 
+     * - if a product is member of multiple shipping cost groups, the lowest
+     * shipping cost takes precedence
+     * - if fixed and surcharge shipping cost is defined for a product, the
+     * fixed cost takes precedence
+     * - shipping cost defined for a master product is also defined for all
+     * variants of this master
+     * - shipping cost is not applied to bundled product line items or options
+     * line items
+     */
+    static applyShippingCost(lineItemCtnr: LineItemCtnr<any>): void;
+    /**
+     * Returns the active shipping methods of the current site applicable to the session currency and current customer group.
+     */
+    static getAllShippingMethods(): Collection<ShippingMethod>;
+    /**
+     * Returns the default shipping method of the current site applicable to the session currency.
+     * 
+     * Does an additional check if there is a base method and if their currencies are
+     * the same. Returns NULL if the two currencies are different.
+     */
+    static getDefaultShippingMethod(): ShippingMethod | null;
+    /**
+     * Returns the shipping model for the specified product.
+     */
+    static getProductShippingModel(product: Product<any>): ProductShippingModel;
+    /**
+     * Returns the shipping model for the specified shipment.
+     */
+    static getShipmentShippingModel(shipment: Shipment): ShipmentShippingModel;
+    /**
+     * Returns the shipping cost amount for the specified shipping method and
+     * the specified order value.
+     * 
+     * If shipping cost cannot be calculated for any reason, Money.NA is
+     * returned.
+     */
+    static getShippingCost(shippingMethod: ShippingMethod, orderValue: Money): Money;
+}
+
+export = ShippingMgr;