@salesforce/b2c-cli 1.10.0 → 1.12.0

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

@@ -0,0 +1,304 @@
+import AbstractItemCtnr = require('./AbstractItemCtnr');
+import EnumValue = require('../value/EnumValue');
+import Invoice = require('./Invoice');
+import ShippingMethod = require('./ShippingMethod');
+import OrderAddress = require('./OrderAddress');
+import FilteringCollection = require('../util/FilteringCollection');
+import ShippingOrderItem = require('./ShippingOrderItem');
+import Collection = require('../util/Collection');
+import TrackingInfo = require('./TrackingInfo');
+import OrderItem = require('./OrderItem');
+import Quantity = require('../value/Quantity');
+
+/**
+ * A shipping order is used to specify items that should be shipped, and is
+ * typically exported to, and updated by a back-office warehouse management
+ * system.
+ * 
+ * An dw.order.Order can have n shipping orders expressing how the order
+ * is to be shipped. The creation, export and update of shipping orders is
+ * largely handled by custom logic in scripts by implementing
+ * dw.order.hooks.ShippingOrderHooks. Use method
+ * dw.order.Order.createShippingOrder for creation and add items using
+ * createShippingOrderItem - each item is related
+ * to an order item which in turn represents a product- or shipping- line item
+ * in the order.
+ * 
+ * A shipping order has a status calculated from its item status, one of
+ * 
+ * - CONFIRMED - shipping order not yet exported, with 0 items, or all items
+ * in status CONFIRMED.
+ * - WAREHOUSE - shipping order exported, with all items in status WAREHOUSE.
+ * - SHIPPED - exported shipping order has been updated, with 1-n items in
+ * status SHIPPED and 0-n CANCELLED.
+ * - CANCELLED - exported shipping order has been updated, with all items in
+ * status CANCELLED.
+ * 
+ * The following status transitions are supported. Every status transition is
+ * documented by the addition of an order note such as 'Shipping order 123456
+ * status changed to WAREHOUSE.':
+ * 
+ * From
+ * To
+ * When
+ * Use
+ * 
+ * CONFIRMED
+ * WAREHOUSE
+ * Shipping order exported
+ * Call setStatusWarehouse - note this is the only way to set the
+ * items to status WAREHOUSE
+ * 
+ * WAREHOUSE
+ * SHIPPED
+ * One or more items have been SHIPPED
+ * Call dw.order.ShippingOrderItem.setStatus using
+ * dw.order.ShippingOrderItem.STATUS_SHIPPED
+ * 
+ * WAREHOUSE
+ * CANCELLED
+ * All items have been CANCELLED
+ * Call dw.order.ShippingOrderItem.setStatus using
+ * dw.order.ShippingOrderItem.STATUS_CANCELLED
+ * 
+ * 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.
+ */
+declare class ShippingOrder extends AbstractItemCtnr {
+    /**
+     * Sorting by item id. Use with method getItems as an argument to
+     * method dw.util.FilteringCollection.sort.
+     */
+    static readonly ORDERBY_ITEMID: any;
+    /**
+     * Sorting by the position of the related oder item. Use with method
+     * getItems as an argument to method
+     * dw.util.FilteringCollection.sort.
+     */
+    static readonly ORDERBY_ITEMPOSITION: any;
+    /**
+     * Unsorted , as it is. Use with method getItems as an argument
+     * to method dw.util.FilteringCollection.sort.
+     */
+    static readonly ORDERBY_UNSORTED: any;
+    /**
+     * Selects the product items. Use with method getItems as an
+     * argument to method dw.util.FilteringCollection.select.
+     */
+    static readonly QUALIFIER_PRODUCTITEMS: any;
+    /**
+     * Selects for the service items. Use with method getItems as an
+     * argument to method dw.util.FilteringCollection.select.
+     */
+    static readonly QUALIFIER_SERVICEITEMS: any;
+    /**
+     * Constant for Shipping Order Status CANCELLED
+     */
+    static readonly STATUS_CANCELLED: string;
+    /**
+     * Constant for Shipping Order Status CONFIRMED
+     */
+    static readonly STATUS_CONFIRMED: string;
+    /**
+     * Constant for Shipping Order Status SHIPPED
+     */
+    static readonly STATUS_SHIPPED: string;
+    /**
+     * Constant for Shipping Order Status WAREHOUSE
+     */
+    static readonly STATUS_WAREHOUSE: string;
+    /**
+     * Returns null or the previously created dw.order.Invoice.
+     * @see createInvoice
+     */
+    readonly invoice: Invoice | null;
+    /**
+     * Returns `null` or the invoice-number.
+     * @see createInvoice
+     */
+    readonly invoiceNumber: string | null;
+    /**
+     * Gets the shipping date.
+     * 
+     * Returns `null` if this shipping order is not yet shipped.
+     */
+    shipDate: Date | null;
+    /**
+     * Returns the shipping address (optional, can be null).
+     * 
+     * Note: the shipping address is not copied into the
+     * ShippingOrder but is a link to a
+     * dw.order.OrderAddress held in the dw.order.Order.
+     */
+    shippingAddress: OrderAddress | null;
+    /**
+     * Returns the shipping method of the shipping order.
+     * 
+     * Can be `null`.
+     */
+    readonly shippingMethod: ShippingMethod | null;
+    /**
+     * Gets the shipping order number.
+     */
+    readonly shippingOrderNumber: string;
+    /**
+     * Gets the status of this shipping order. The status is read-only and
+     * calculated from the item status. See class documentation for more
+     * details.
+     * 
+     * The possible values are STATUS_CONFIRMED,
+     * STATUS_WAREHOUSE, STATUS_SHIPPED,
+     * STATUS_CANCELLED.
+     */
+    readonly status: EnumValue;
+    /**
+     * Gets all tracking informations for this shipping order.
+     * @see dw.order.TrackingInfo
+     */
+    readonly trackingInfos: Collection<any>;
+    private constructor();
+    /**
+     * Adds a tracking info to this shipping order with the given ID.
+     * @see dw.order.TrackingInfo
+     */
+    addTrackingInfo(trackingInfoID: string): TrackingInfo;
+    /**
+     * Creates a new dw.order.Invoice based on this
+     * ShippingOrder.
+     * 
+     * The shipping-order-number will be used as the
+     * invoice-number. The Invoice can then be accessed using
+     * getInvoice or getInvoiceNumber can be used.
+     * The method must not be called more than once for a ShippingOrder,
+     * nor may 2 Invoices exist with the same invoice-number.
+     * 
+     * The new Invoice is a debit-invoice with a status
+     * dw.order.Invoice.STATUS_NOT_PAID, and will be passed to the
+     * capture payment-hook in a separate database transaction for processing.
+     */
+    createInvoice(): Invoice;
+    /**
+     * Creates a new dw.order.Invoice based on this ShippingOrder.
+     * 
+     * The invoice-number must be specified as an argument.The Invoice can then be accessed using
+     * getInvoice or getInvoiceNumber can be used.
+     * The method must not be called more than once for a ShippingOrder,
+     * nor may 2 Invoices exist with the same invoice-number.
+     * 
+     * The new Invoice is a debit-invoice with a status dw.order.Invoice.STATUS_NOT_PAID, and
+     * will be passed to the capture payment-hook in a separate database
+     * transaction for processing.
+     */
+    createInvoice(invoiceNumber: string): Invoice;
+    /**
+     * Create a dw.order.ShippingOrderItem in the shipping order with
+     * the number `shippingOrderNumber`.
+     * 
+     * The quantity of the new item can be optionally specified. A quantity of
+     * `null` indicates the new item should be based on the entire order item and
+     * is recommended for dw.order.ShippingLineItems. If a quantity is
+     * specified for a dw.order.ProductLineItem which is less than
+     * ProductLineItem.getQuantity the
+     * ProductLineItem will be split, creating a new
+     * ProductLineItem. The new
+     * ShippingOrderItem will be associated with the new
+     * ProductLineItem, which will receive the specified
+     * quantity.
+     * See also createShippingOrderItem.
+     */
+    createShippingOrderItem(orderItem: OrderItem, quantity: Quantity): ShippingOrderItem;
+    /**
+     * Create a dw.order.ShippingOrderItem in the shipping order with
+     * the number `shippingOrderNumber`.
+     * 
+     * The quantity of the new item can be optionally specified. A quantity of
+     * `null` indicates the new item should be based on the entire order item and
+     * is recommended for dw.order.ShippingLineItems.
+     * If the specified quantity is less than ProductLineItem.getQuantity the
+     * ProductLineItem will be split or not depending on `splitIfPartial` parameter.
+     * When `split` is `true`, the method is equivalent to
+     * createShippingOrderItem.
+     */
+    createShippingOrderItem(orderItem: OrderItem, quantity: Quantity, splitIfPartial: boolean): ShippingOrderItem;
+    /**
+     * Returns null or the previously created dw.order.Invoice.
+     * @see createInvoice
+     */
+    getInvoice(): Invoice | null;
+    /**
+     * Returns `null` or the invoice-number.
+     * @see createInvoice
+     */
+    getInvoiceNumber(): string | null;
+    /**
+     * Gets the shipping date.
+     * 
+     * Returns `null` if this shipping order is not yet shipped.
+     */
+    getShipDate(): Date | null;
+    /**
+     * Returns the shipping address (optional, can be null).
+     * 
+     * Note: the shipping address is not copied into the
+     * ShippingOrder but is a link to a
+     * dw.order.OrderAddress held in the dw.order.Order.
+     */
+    getShippingAddress(): OrderAddress | null;
+    /**
+     * Returns the shipping method of the shipping order.
+     * 
+     * Can be `null`.
+     */
+    getShippingMethod(): ShippingMethod | null;
+    /**
+     * Gets the shipping order number.
+     */
+    getShippingOrderNumber(): string;
+    /**
+     * Gets the status of this shipping order. The status is read-only and
+     * calculated from the item status. See class documentation for more
+     * details.
+     * 
+     * The possible values are STATUS_CONFIRMED,
+     * STATUS_WAREHOUSE, STATUS_SHIPPED,
+     * STATUS_CANCELLED.
+     */
+    getStatus(): EnumValue;
+    /**
+     * Gets a tracking info for this shipping order.
+     * @see dw.order.TrackingInfo
+     */
+    getTrackingInfo(trackingInfoID: string): TrackingInfo | null;
+    /**
+     * Gets all tracking informations for this shipping order.
+     * @see dw.order.TrackingInfo
+     */
+    getTrackingInfos(): Collection<any>;
+    /**
+     * Sets the shipping date.
+     */
+    setShipDate(date: Date): void;
+    /**
+     * Set a shipping address for the shipping order.
+     * @see getShippingAddress
+     */
+    setShippingAddress(address: OrderAddress): void;
+    /**
+     * Set the id of shipping method.
+     * @see dw.order.ShippingMethod.getID
+     */
+    setShippingMethodID(shippingMethodID: string): void;
+    /**
+     * Set a CONFIRMED shipping order (all items in status CONFIRMED) to status
+     * WAREHOUSE (all items in status WAREHOUSE).
+     * 
+     * Note - this method is the only way to transition a shipping order from
+     * CONFIRMED to WAREHOUSE.
+     * @throws IllegalArgumentException if the shipping order is in a status other than CONFIRMED.
+     */
+    setStatusWarehouse(): void;
+}
+
+export = ShippingOrder;

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

@@ -0,0 +1,210 @@
+import AbstractItem = require('./AbstractItem');
+import EnumValue = require('../value/EnumValue');
+import Quantity = require('../value/Quantity');
+import TrackingRef = require('./TrackingRef');
+import FilteringCollection = require('../util/FilteringCollection');
+import Money = require('../value/Money');
+import Decimal = require('../util/Decimal');
+
+/**
+ * One or more ShippingOrderItems are contained in a
+ * dw.order.ShippingOrder, created using
+ * dw.order.ShippingOrder.createShippingOrderItem
+ * and can be retrieved by
+ * dw.order.ShippingOrder.getItems. A
+ * ShippingOrderItem references a single
+ * dw.order.OrderItem which in turn references a
+ * dw.order.LineItem associated with 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.
+ */
+declare class ShippingOrderItem extends AbstractItem {
+    /**
+     * Constant for Order Item Status CANCELLED
+     */
+    static readonly STATUS_CANCELLED: string;
+    /**
+     * Constant for Order Item Status CONFIRMED
+     */
+    static readonly STATUS_CONFIRMED: string;
+    /**
+     * Constant for Order Item Status SHIPPED
+     */
+    static readonly STATUS_SHIPPED: string;
+    /**
+     * Constant for Order Item Status WAREHOUSE
+     */
+    static readonly STATUS_WAREHOUSE: string;
+    /**
+     * Price of a single unit before discount application.
+     */
+    readonly basePrice: Money;
+    /**
+     * Returns null or the parent item.
+     */
+    parentItem: ShippingOrderItem | null;
+    /**
+     * The quantity of the shipping order item.
+     * 
+     * The dw.value.Quantity is equal to the related line item quantity.
+     */
+    readonly quantity: Quantity;
+    /**
+     * The mandatory shipping order number of the related
+     * dw.order.ShippingOrder.
+     */
+    readonly shippingOrderNumber: string;
+    /**
+     * Gets the order item status.
+     * 
+     * The possible values are STATUS_CONFIRMED,
+     * STATUS_WAREHOUSE, STATUS_SHIPPED,
+     * STATUS_CANCELLED.
+     */
+    status: EnumValue;
+    /**
+     * Gets the tracking refs (tracking infos) the shipping order item is
+     * assigned to.
+     * @see dw.order.TrackingRef
+     */
+    readonly trackingRefs: FilteringCollection<TrackingRef>;
+    private constructor();
+    /**
+     * A shipping order item can be assigned
+     * to one or many dw.order.TrackingInfo tracking infos with
+     * different quantities. For example an item with quantity 3 may have been
+     * shipped in 2 packages, each represented by its own
+     * tracking info - 2
+     * dw.order.TrackingRefs would exist with quantities 1 and 2.
+     * 
+     * This method creates and adds a new tracking
+     * reference to this shipping order item for a given
+     * tracking info and quantity. The new
+     * instance is returned.
+     * @see dw.order.TrackingRef
+     */
+    addTrackingRef(trackingInfoID: string, quantity: Quantity): TrackingRef;
+    /**
+     * Apply a rate of (factor / divisor) to the prices in this item, with the option to half round up or half round down to the
+     * nearest cent if necessary.
+     * 
+     * Examples:
+     * 
+     * TaxBasis before  factor  divisor  roundup  Calculation  TaxBasis after
+     * $10.00  1  2  true  10*1/2=  $5.00
+     * $10.00  9  10  true  10*9/10=  $9.00
+     * $10.00  1  3  true  10*1/3=3.3333=  $3.33
+     * $2.47  1  2  true  2.47*1/2=1.235=  $1.24
+     * $2.47  1  2  false  2.47*1/2=1.235=  $1.23
+     * 
+     * Which prices are updated?:
+     * 
+     * The rate described above is applied to tax-basis and tax then the net-price and gross-price are recalculated by adding / subtracting
+     * depending on whether the order is based on net price.
+     * 
+     * Example (order based on net price)
+     * 
+     * New TaxBasis:$10.00, Tax:$1.00, NetPrice=TaxBasis=$10.00, GrossPrice=TaxBasis+Tax=$11.00
+     * 
+     * Example (order based on gross price)
+     * 
+     * New TaxBasis:$10.00, Tax:$1.00, NetPrice=TaxBasis-tax=$9.00, GrossPrice=TaxBasis=$10.00
+     * @see dw.order.AbstractItem.getTaxBasis
+     * @see dw.order.AbstractItem.getTax
+     * @see dw.order.AbstractItem.getNetPrice
+     * @see dw.order.AbstractItem.getGrossPrice
+     * @see dw.order.TaxMgr.getTaxationPolicy
+     */
+    applyPriceRate(factor: Decimal, divisor: Decimal, roundUp: boolean): void;
+    /**
+     * Price of a single unit before discount application.
+     */
+    getBasePrice(): Money;
+    /**
+     * Returns null or the parent item.
+     */
+    getParentItem(): ShippingOrderItem | null;
+    /**
+     * The quantity of the shipping order item.
+     * 
+     * The dw.value.Quantity is equal to the related line item quantity.
+     */
+    getQuantity(): Quantity;
+    /**
+     * The mandatory shipping order number of the related
+     * dw.order.ShippingOrder.
+     */
+    getShippingOrderNumber(): string;
+    /**
+     * Gets the order item status.
+     * 
+     * The possible values are STATUS_CONFIRMED,
+     * STATUS_WAREHOUSE, STATUS_SHIPPED,
+     * STATUS_CANCELLED.
+     */
+    getStatus(): EnumValue;
+    /**
+     * Gets the tracking refs (tracking infos) the shipping order item is
+     * assigned to.
+     * @see dw.order.TrackingRef
+     */
+    getTrackingRefs(): FilteringCollection<TrackingRef>;
+    /**
+     * Set a parent item. The parent item must belong to the same
+     * dw.order.ShippingOrder. An infinite parent-child loop is disallowed
+     * as is a parent-child depth greater than 10. Setting a parent item
+     * indicates a dependency of the child item on the parent item, and can be
+     * used to form a parallel structure to that accessed using
+     * dw.order.ProductLineItem.getParent.
+     */
+    setParentItem(parentItem: ShippingOrderItem): void;
+    /**
+     * Sets the status. See dw.order.ShippingOrder for details of
+     * shipping order status transitions. Do not use this method to set a
+     * shipping order to status WAREHOUSE, instead use
+     * dw.order.ShippingOrder.setStatusWarehouse
+     * 
+     * This also triggers the setting of the status of the
+     * dw.order.LineItem when appropriate. Setting this status can also have an impact on
+     * the order status, accessed using dw.order.Order.getStatus and the
+     * shipping order status, accessed using dw.order.ShippingOrder.getStatus.
+     * @throws NullPointerException if status is  null
+     * @throws IllegalArgumentException if the status transition to the status is not allowed
+     */
+    setStatus(status: string): void;
+    /**
+     * Split the shipping order item.
+     * 
+     * This will also lead to a split of the related dw.order.LineItem.
+     * Split means that for the passed quantity a new item is created with this
+     * quantity as an exact copy of this item. The remaining amount will stay in
+     * this item.
+     * 
+     * If quantity is equal to getQuantity no split is done and this
+     * item is returned itself.
+     * 
+     * This method is equivalent to split called
+     * with `splitOrderItem` equals to `true`.
+     * @throws IllegalArgumentException if quantity is greater than  getQuantity
+     */
+    split(quantity: Quantity): ShippingOrderItem;
+    /**
+     * Split the shipping order item.
+     * 
+     * This will also lead to a split of the related dw.order.LineItem
+     * when `splitOrderItem` is `true`.
+     * Split means that for the passed quantity a new item is created with this
+     * quantity as an exact copy of this item. The remaining amount will stay in
+     * this item.
+     * 
+     * If quantity is equal to getQuantity no split is done and this
+     * item is returned itself.
+     * @throws IllegalArgumentException if quantity is greater than  getQuantity
+     */
+    split(quantity: Quantity, splitOrderItem: boolean): ShippingOrderItem;
+}
+
+export = ShippingOrderItem;

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

@@ -0,0 +1,75 @@
+import Money = require('../value/Money');
+import Collection = require('../util/Collection');
+import TaxItem = require('./TaxItem');
+
+/**
+ * Container used to represent an subtotal or grandtotal item which contains various prices and a tax breakdown
+ * held in a collection of tax-items.
+ * 
+ * Usage example:
+ * @example
+ * var invoice : Invoice = ...;
+ * var productNet = invoice.productSubTotal.netPrice;
+ * var serviceNet = invoice.serviceSubTotal.netPrice;
+ * var grandNet   = invoice.grandTotal.netPrice;
+ * var grandTax   = invoice.grandTotal.tax;
+ * var grandGross = invoice.grandTotal.grossPrice;
+ * 
+ * # tax breakdown
+ * for each(taxItem : TaxItem in invoice.grandTotal.taxItems) {
+ * var tax : Money         = taxItem.amount;
+ * var taxGroup : TaxGroup = taxItem.taxGroup;
+ * var rate : Double       = taxGroup.rate;
+ * var caption :String     = taxGroup.caption;
+ * var taxType :String     = taxGroup.taxType;
+ * }
+ */
+declare class SumItem {
+    /**
+     * Gross price of SumItem.
+     */
+    readonly grossPrice: Money;
+    /**
+     * Net price of SumItem.
+     */
+    readonly netPrice: Money;
+    /**
+     * Total tax for SumItem.
+     */
+    readonly tax: Money;
+    /**
+     * Price of entire SumItem on which tax calculation is based. Same as getNetPrice
+     * or getGrossPrice depending on whether the order is based on net or gross prices.
+     */
+    readonly taxBasis: Money;
+    /**
+     * Tax items representing a tax breakdown for the SumItem.
+     * @see dw.order.TaxItem
+     */
+    readonly taxItems: Collection<TaxItem>;
+    private constructor();
+    /**
+     * Gross price of SumItem.
+     */
+    getGrossPrice(): Money;
+    /**
+     * Net price of SumItem.
+     */
+    getNetPrice(): Money;
+    /**
+     * Total tax for SumItem.
+     */
+    getTax(): Money;
+    /**
+     * Price of entire SumItem on which tax calculation is based. Same as getNetPrice
+     * or getGrossPrice depending on whether the order is based on net or gross prices.
+     */
+    getTaxBasis(): Money;
+    /**
+     * Tax items representing a tax breakdown for the SumItem.
+     * @see dw.order.TaxItem
+     */
+    getTaxItems(): Collection<TaxItem>;
+}
+
+export = SumItem;

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

@@ -0,0 +1,49 @@
+import Decimal = require('../util/Decimal');
+
+/**
+ * Contains the formal definition of a tax including a type (it's just the key), a getRate
+ * if provided, a getCaption and a getDescription.
+ */
+declare class TaxGroup {
+    /**
+     * Gets the caption.
+     */
+    readonly caption: string;
+    /**
+     * Gets the description.
+     */
+    readonly description: string;
+    /**
+     * Gets the percentage amount of the rate.
+     */
+    readonly rate: number;
+    /**
+     * Gets the tax type.
+     */
+    readonly taxType: string;
+    private constructor();
+    /**
+     * Creates a TaxGroup.
+     * 
+     * This TaxGroup can be used for example in ReturnItem.addTaxItem.
+     */
+    static create(taxType: string, caption: string, description: string, taxRate: Decimal): TaxGroup;
+    /**
+     * Gets the caption.
+     */
+    getCaption(): string;
+    /**
+     * Gets the description.
+     */
+    getDescription(): string;
+    /**
+     * Gets the percentage amount of the rate.
+     */
+    getRate(): number;
+    /**
+     * Gets the tax type.
+     */
+    getTaxType(): string;
+}
+
+export = TaxGroup;

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

@@ -0,0 +1,29 @@
+import Money = require('../value/Money');
+import TaxGroup = require('./TaxGroup');
+
+/**
+ * An item containing tax information allowing a tax breakdown between a number of dw.order.TaxGroups.
+ */
+declare class TaxItem {
+    /**
+     * Gets the amount.
+     */
+    readonly amount: Money;
+    /**
+     * Returns the TaxGroup tax group.
+     * @see dw.order.TaxGroup
+     */
+    readonly taxGroup: TaxGroup;
+    private constructor();
+    /**
+     * Gets the amount.
+     */
+    getAmount(): Money;
+    /**
+     * Returns the TaxGroup tax group.
+     * @see dw.order.TaxGroup
+     */
+    getTaxGroup(): TaxGroup;
+}
+
+export = TaxItem;