@salesforce/b2c-cli 1.11.0 → 1.12.0

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

@@ -0,0 +1,91 @@
+import Extensible = require('../object/Extensible');
+import OrderItem = require('./OrderItem');
+import LineItem = require('./LineItem');
+import Money = require('../value/Money');
+import Collection = require('../util/Collection');
+
+/**
+ * An item which references, or in other words is based upon, an dw.order.OrderItem. Provides methods to access the
+ * OrderItem, the order dw.order.LineItem which has been extended, and the dw.order.Order. In addition it defines
+ * methods to access item level prices and the item id. Supports custom-properties.
+ */
+declare abstract class AbstractItem extends Extensible {
+    /**
+     * Gross price of item.
+     */
+    readonly grossPrice: Money;
+    /**
+     * The item-id used for referencing between items
+     */
+    readonly itemID: string;
+    /**
+     * Returns the Order Product- or Shipping- LineItem associated with this item. Should never return null.
+     */
+    readonly lineItem: LineItem<any>;
+    /**
+     * Net price of item.
+     */
+    readonly netPrice: Money;
+    /**
+     * Returns the order item extensions related to this item. Should never return null.
+     */
+    readonly orderItem: OrderItem;
+    /**
+     * The order-item-id used for referencing the dw.order.OrderItem
+     */
+    readonly orderItemID: string;
+    /**
+     * Total tax for item.
+     */
+    readonly tax: Money;
+    /**
+     * Price of entire item 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
+     * @see dw.order.TaxItem
+     */
+    readonly taxItems: Collection<any>;
+    /**
+     * Gross price of item.
+     */
+    getGrossPrice(): Money;
+    /**
+     * The item-id used for referencing between items
+     */
+    getItemID(): string;
+    /**
+     * Returns the Order Product- or Shipping- LineItem associated with this item. Should never return null.
+     */
+    getLineItem(): LineItem<any>;
+    /**
+     * Net price of item.
+     */
+    getNetPrice(): Money;
+    /**
+     * Returns the order item extensions related to this item. Should never return null.
+     */
+    getOrderItem(): OrderItem;
+    /**
+     * The order-item-id used for referencing the dw.order.OrderItem
+     */
+    getOrderItemID(): string;
+    /**
+     * Total tax for item.
+     */
+    getTax(): Money;
+    /**
+     * Price of entire item 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
+     * @see dw.order.TaxItem
+     */
+    getTaxItems(): Collection<any>;
+}
+
+export = AbstractItem;

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

@@ -0,0 +1,100 @@
+import Extensible = require('../object/Extensible');
+import Order = require('./Order');
+import FilteringCollection = require('../util/FilteringCollection');
+import OrderItem = require('./OrderItem');
+import SumItem = require('./SumItem');
+
+/**
+ * Basis for item-based objects stemming from a single dw.order.Order, with these common
+ * properties (Invoice is used as an example):
+ * 
+ * -
+ * The object has been created from an Order accessible using getOrder
+ * - Contains a collection of getItems, each item related to exactly one dw.order.OrderItem which in turn represents
+ * an extension to one of the order dw.order.ProductLineItem or one dw.order.ShippingLineItem.
+ * Example: an dw.order.Invoice has dw.order.InvoiceItems
+ * -
+ * The items hold various prices which are summed, resulting in a
+ * getProductSubtotal, a
+ * getServiceSubtotal and a getGrandTotal,
+ * each represented by a dw.order.SumItem.
+ * - The object is customizable using custom properties
+ */
+declare abstract class AbstractItemCtnr extends Extensible {
+    /**
+     * Created by this user.
+     */
+    readonly createdBy: string;
+    /**
+     * The time of creation.
+     */
+    readonly creationDate: Date;
+    /**
+     * Returns the sum-item representing the grandtotal for all items.
+     */
+    readonly grandTotal: SumItem;
+    /**
+     * Returns the unsorted collection of items
+     */
+    readonly items: FilteringCollection<OrderItem>;
+    /**
+     * The last modification time.
+     */
+    readonly lastModified: Date;
+    /**
+     * Last modified by this user.
+     */
+    readonly modifiedBy: string;
+    /**
+     * Returns the dw.order.Order this object was created for.
+     */
+    readonly order: Order;
+    /**
+     * Returns the sum-item representing the subtotal for product items.
+     */
+    readonly productSubtotal: SumItem;
+    /**
+     * Returns the sum-item representing the subtotal for service items such as
+     * shipping.
+     */
+    readonly serviceSubtotal: SumItem;
+    /**
+     * Created by this user.
+     */
+    getCreatedBy(): string;
+    /**
+     * The time of creation.
+     */
+    getCreationDate(): Date;
+    /**
+     * Returns the sum-item representing the grandtotal for all items.
+     */
+    getGrandTotal(): SumItem;
+    /**
+     * Returns the unsorted collection of items
+     */
+    getItems(): FilteringCollection<OrderItem>;
+    /**
+     * The last modification time.
+     */
+    getLastModified(): Date;
+    /**
+     * Last modified by this user.
+     */
+    getModifiedBy(): string;
+    /**
+     * Returns the dw.order.Order this object was created for.
+     */
+    getOrder(): Order;
+    /**
+     * Returns the sum-item representing the subtotal for product items.
+     */
+    getProductSubtotal(): SumItem;
+    /**
+     * Returns the sum-item representing the subtotal for service items such as
+     * shipping.
+     */
+    getServiceSubtotal(): SumItem;
+}
+
+export = AbstractItemCtnr;

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

@@ -0,0 +1,163 @@
+import AbstractItemCtnr = require('./AbstractItemCtnr');
+import EnumValue = require('../value/EnumValue');
+import Invoice = require('./Invoice');
+import Money = require('../value/Money');
+import List = require('../util/List');
+import FilteringCollection = require('../util/FilteringCollection');
+import AppeasementItem = require('./AppeasementItem');
+
+/**
+ * The Appeasement represents a shopper request for an order credit.
+ * 
+ * Example: The buyer finds any problem with the products but he agrees to preserve them, if he would be compensated,
+ * rather than return them.
+ * 
+ * The Appeasement contains 1..n appeasement items.
+ * Each appeasement item is associated with one dw.order.OrderItem usually representing an dw.order.Order
+ * dw.order.ProductLineItem.
+ * 
+ * An Appeasement can have one of these status values:
+ * 
+ * - OPEN - the appeasement is open and appeasement items could be added to it
+ * - COMPLETED - the appeasement is complete and it is not allowed to add new items to it, this is a precondition
+ * for refunding the customer for an appeasement.
+ * 
+ * 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 Appeasement 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 order 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 the service items. Use with method getItems as an argument to method dw.util.FilteringCollection.select.
+     */
+    static readonly QUALIFIER_SERVICEITEMS: any;
+    /**
+     * Constant for Appeasement Status COMPLETED
+     */
+    static readonly STATUS_COMPLETED: string;
+    /**
+     * Constant for Appeasement Status OPEN
+     */
+    static readonly STATUS_OPEN: string;
+    /**
+     * Returns the appeasement number.
+     */
+    readonly appeasementNumber: 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;
+    /**
+     * Returns the reason code for the appeasement. The list of reason codes can be updated
+     * by updating meta-data for Appeasement.
+     */
+    reasonCode: EnumValue;
+    /**
+     * Returns the reason note for the appeasement.
+     */
+    reasonNote: string | null;
+    /**
+     * Gets the status of this appeasement.
+     * 
+     * The possible values are STATUS_OPEN, STATUS_COMPLETED.
+     */
+    status: EnumValue;
+    private constructor();
+    /**
+     * Creates appeasement items corresponding to certain order items and adds them to the appeasement.
+     */
+    addItems(totalAmount: Money, orderItems: List<any>): void;
+    /**
+     * Creates a new dw.order.Invoice based on this Appeasement. The appeasement-number
+     * will be used as the invoice-number.
+     * 
+     * The method must not be called more than once for an Appeasement,
+     * nor may 2 invoices exist with the same invoice-number.
+     * 
+     * The new Invoice is a credit-invoice with a dw.order.Invoice.STATUS_NOT_PAID status, and
+     * should be passed to the refund payment-hook in a separate database transaction for processing.
+     */
+    createInvoice(): Invoice;
+    /**
+     * Creates a new dw.order.Invoice based on this Appeasement. The
+     * invoice-number must be specified as an argument.
+     * 
+     * The method must not be called more than once for an Appeasement,
+     * nor may 2 invoices exist with the same invoice-number.
+     * 
+     * The new Invoice is a credit-invoice with a dw.order.Invoice.STATUS_NOT_PAID status, and
+     * should be passed to the refund payment-hook in a separate database transaction for processing.
+     */
+    createInvoice(invoiceNumber: string): Invoice;
+    /**
+     * Returns the appeasement number.
+     */
+    getAppeasementNumber(): string;
+    /**
+     * 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;
+    /**
+     * Returns the reason code for the appeasement. The list of reason codes can be updated
+     * by updating meta-data for Appeasement.
+     */
+    getReasonCode(): EnumValue;
+    /**
+     * Returns the reason note for the appeasement.
+     */
+    getReasonNote(): string | null;
+    /**
+     * Gets the status of this appeasement.
+     * 
+     * The possible values are STATUS_OPEN, STATUS_COMPLETED.
+     */
+    getStatus(): EnumValue;
+    /**
+     * Set the reason code for the appeasement. The list of reason codes can be updated
+     * by updating meta-data for Appeasement.
+     */
+    setReasonCode(reasonCode: string): void;
+    /**
+     * Sets the reason note for the appeasement.
+     */
+    setReasonNote(reasonNote: string): void;
+    /**
+     * Sets the appeasement status.
+     * 
+     * The possible values are STATUS_OPEN, STATUS_COMPLETED.
+     * 
+     * When set to status COMPLETED, only the the custom attributes of its appeasement items can be changed.
+     */
+    setStatus(appeasementStatus: string): void;
+}
+
+export = Appeasement;

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

@@ -0,0 +1,43 @@
+import AbstractItem = require('./AbstractItem');
+
+/**
+ * Represents an item of an dw.order.Appeasement which is associated with one dw.order.OrderItem usually representing an dw.order.Order
+ * dw.order.ProductLineItem. Items are created using method dw.order.Appeasement.addItems
+ * 
+ * When the related Appeasement were set to status COMPLETED, only the the custom attributes of the appeasement item can be changed.
+ * 
+ * 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 AppeasementItem extends AbstractItem {
+    /**
+     * Returns the number of the dw.order.Appeasement to which this item belongs.
+     */
+    readonly appeasementNumber: string;
+    /**
+     * Returns null or the parent item.
+     */
+    parentItem: AppeasementItem | null;
+    private constructor();
+    /**
+     * Returns the number of the dw.order.Appeasement to which this item belongs.
+     */
+    getAppeasementNumber(): string;
+    /**
+     * Returns null or the parent item.
+     */
+    getParentItem(): AppeasementItem | null;
+    /**
+     * Set a parent item. The parent item must belong to the same
+     * dw.order.Appeasement. 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: AppeasementItem): void;
+}
+
+export = AppeasementItem;