@salesforce/b2c-cli 1.11.0 → 1.12.0

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

@@ -0,0 +1,284 @@
+import AbstractItemCtnr = require('./AbstractItemCtnr');
+import EnumValue = require('../value/EnumValue');
+import FilteringCollection = require('../util/FilteringCollection');
+import InvoiceItem = require('./InvoiceItem');
+import PaymentTransaction = require('./PaymentTransaction');
+import OrderPaymentInstrument = require('./OrderPaymentInstrument');
+import Money = require('../value/Money');
+
+/**
+ * The Invoice can be a debit or credit invoice, and is created
+ * from custom scripts using one of the methods
+ * dw.order.ShippingOrder.createInvoice,
+ * dw.order.Appeasement.createInvoice,
+ * dw.order.ReturnCase.createInvoice or
+ * dw.order.Return.createInvoice.
+ * 
+ * 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 Invoice extends AbstractItemCtnr {
+    /**
+     * Sorting by creation date. Use with method getPaymentTransactions as an argument to
+     * method dw.util.FilteringCollection.sort.
+     */
+    static readonly ORDERBY_CREATION_DATE: any;
+    /**
+     * 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;
+    /**
+     * Reverse orders. Use as an argument
+     * to method dw.util.FilteringCollection.sort.
+     */
+    static readonly ORDERBY_REVERSE: 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 capture transactions. Use with method getPaymentTransactions as an
+     * argument to method dw.util.FilteringCollection.select.
+     */
+    static readonly QUALIFIER_CAPTURE: 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 refund transactions. Use with method getPaymentTransactions as an
+     * argument to method dw.util.FilteringCollection.select.
+     */
+    static readonly QUALIFIER_REFUND: 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 Invoice Status Failed.
+     * 
+     * The invoice handling failed.
+     */
+    static readonly STATUS_FAILED: string;
+    /**
+     * Constant for Invoice Status Manual.
+     * 
+     * The invoice is not paid but will not be handled automatically.
+     * 
+     * A manual invoice handling (capture or refund) is necessary.
+     */
+    static readonly STATUS_MANUAL: string;
+    /**
+     * Constant for Invoice Status Not Paid.
+     * 
+     * The invoice is not paid and will be handled automatically.
+     */
+    static readonly STATUS_NOT_PAID: string;
+    /**
+     * Constant for Invoice Status Paid.
+     * 
+     * The invoice was successfully paid.
+     */
+    static readonly STATUS_PAID: string;
+    /**
+     * Constant for Invoice Type Appeasement.
+     * 
+     * The invoice was created for an appeasement.
+     * 
+     * The invoice amount needs to be refunded.
+     */
+    static readonly TYPE_APPEASEMENT: string;
+    /**
+     * Constant for Invoice Type Return.
+     * 
+     * The invoice was created for a return.
+     * 
+     * The invoice amount needs to be refunded.
+     */
+    static readonly TYPE_RETURN: string;
+    /**
+     * Constant for Invoice Type Return Case.
+     * 
+     * The invoice was created for a return case.
+     * 
+     * The invoice amount needs to be refunded.
+     */
+    static readonly TYPE_RETURN_CASE: string;
+    /**
+     * Constant for Invoice Type Shipping.
+     * 
+     * The invoice was created for a shipping order.
+     * 
+     * The invoice amount needs to be captured.
+     */
+    static readonly TYPE_SHIPPING: string;
+    /**
+     * Returns the sum of the captured amounts. The captured amounts are
+     * calculated on the fly.
+     * 
+     * Associate a payment capture for a dw.order.OrderPaymentInstrument
+     * with an Invoice using
+     * addCaptureTransaction.
+     */
+    readonly capturedAmount: Money;
+    /**
+     * Returns the invoice number.
+     */
+    readonly invoiceNumber: string;
+    /**
+     * Returns the payment transactions belonging to this Invoice.
+     * 
+     * This dw.util.FilteringCollection can be sorted / filtered using:
+     * 
+     * - dw.util.FilteringCollection.sort with
+     * ORDERBY_CREATION_DATE
+     * - dw.util.FilteringCollection.sort with
+     * ORDERBY_UNSORTED
+     * - dw.util.FilteringCollection.select with
+     * QUALIFIER_CAPTURE
+     * - dw.util.FilteringCollection.select with
+     * QUALIFIER_REFUND
+     * @see dw.order.PaymentTransaction
+     */
+    readonly paymentTransactions: FilteringCollection<PaymentTransaction>;
+    /**
+     * Returns the sum of the refunded amounts. The refunded amounts are
+     * calculated on the fly.
+     * 
+     * Associate a payment capture for a dw.order.OrderPaymentInstrument
+     * with an Invoice using
+     * addRefundTransaction.
+     */
+    readonly refundedAmount: Money;
+    /**
+     * Returns the invoice status.
+     * 
+     * The possible values are STATUS_NOT_PAID, STATUS_MANUAL,
+     * STATUS_PAID, STATUS_FAILED.
+     */
+    status: EnumValue;
+    /**
+     * Returns the invoice type.
+     * 
+     * The possible values are TYPE_SHIPPING, TYPE_RETURN,
+     * TYPE_RETURN_CASE, TYPE_APPEASEMENT.
+     */
+    readonly type: EnumValue;
+    private constructor();
+    /**
+     * 
+     * 
+     * The invoice will be accounted.
+     * 
+     * It will be captured in case of a shipping invoice and it will be refunded in
+     * case of an appeasement, return case or return invoice.
+     * 
+     * The accounting will be handled in the payment hooks
+     * dw.order.hooks.PaymentHooks.capture or
+     * dw.order.hooks.PaymentHooks.refund. The implementing script could add
+     * payment transactions to the invoice. The accompanying business logic will
+     * set the status to `PAID` or `FAILED`.
+     * 
+     * The accounting will fail when the invoice state is different to
+     * STATUS_NOT_PAID or STATUS_FAILED.
+     * 
+     * The method implements its own transaction handling. The method must not
+     * be called inside a transaction.
+     */
+    account(): boolean;
+    /**
+     * Calling this method registers an amount captured for a given
+     * order payment instrument. The authorization for the
+     * capture is associated with the payment transaction belonging to the
+     * instrument. Calling this method allows the Invoice, the
+     * dw.order.OrderPaymentInstrument and the dw.order.Order to
+     * return their captured amount as a sum calculated on the fly. The method
+     * may be called multiple times for the same instrument (multiple capture
+     * for one authorization) or for different instruments (invoice settlement
+     * using multiple payments).
+     */
+    addCaptureTransaction(instrument: OrderPaymentInstrument, capturedAmount: Money): PaymentTransaction;
+    /**
+     * Calling this method registers an amount refunded for a given
+     * order payment instrument. Calling this method allows the
+     * Invoice, the dw.order.OrderPaymentInstrument and
+     * the dw.order.Order to return their refunded amount as a sum
+     * calculated on the fly. The method may be called multiple times for the
+     * same instrument (multiple refunds of one payment) or for different
+     * instruments (invoice settlement using multiple payments).
+     */
+    addRefundTransaction(instrument: OrderPaymentInstrument, refundedAmount: Money): PaymentTransaction;
+    /**
+     * Returns the sum of the captured amounts. The captured amounts are
+     * calculated on the fly.
+     * 
+     * Associate a payment capture for a dw.order.OrderPaymentInstrument
+     * with an Invoice using
+     * addCaptureTransaction.
+     */
+    getCapturedAmount(): Money;
+    /**
+     * Returns the invoice number.
+     */
+    getInvoiceNumber(): string;
+    /**
+     * Returns the payment transactions belonging to this Invoice.
+     * 
+     * This dw.util.FilteringCollection can be sorted / filtered using:
+     * 
+     * - dw.util.FilteringCollection.sort with
+     * ORDERBY_CREATION_DATE
+     * - dw.util.FilteringCollection.sort with
+     * ORDERBY_UNSORTED
+     * - dw.util.FilteringCollection.select with
+     * QUALIFIER_CAPTURE
+     * - dw.util.FilteringCollection.select with
+     * QUALIFIER_REFUND
+     * @see dw.order.PaymentTransaction
+     */
+    getPaymentTransactions(): FilteringCollection<PaymentTransaction>;
+    /**
+     * Returns the sum of the refunded amounts. The refunded amounts are
+     * calculated on the fly.
+     * 
+     * Associate a payment capture for a dw.order.OrderPaymentInstrument
+     * with an Invoice using
+     * addRefundTransaction.
+     */
+    getRefundedAmount(): Money;
+    /**
+     * Returns the invoice status.
+     * 
+     * The possible values are STATUS_NOT_PAID, STATUS_MANUAL,
+     * STATUS_PAID, STATUS_FAILED.
+     */
+    getStatus(): EnumValue;
+    /**
+     * Returns the invoice type.
+     * 
+     * The possible values are TYPE_SHIPPING, TYPE_RETURN,
+     * TYPE_RETURN_CASE, TYPE_APPEASEMENT.
+     */
+    getType(): EnumValue;
+    /**
+     * Sets the invoice status.
+     * 
+     * The possible values are STATUS_NOT_PAID, STATUS_MANUAL,
+     * STATUS_PAID, STATUS_FAILED.
+     */
+    setStatus(status: string): void;
+}
+
+export = Invoice;

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

@@ -0,0 +1,83 @@
+import AbstractItem = require('./AbstractItem');
+import Quantity = require('../value/Quantity');
+import Money = require('../value/Money');
+
+/**
+ * Represents a specific item in an dw.order.Invoice. Invoice items are added to the invoice
+ * on its creation, each item references exactly one order-item.
+ * 
+ * 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 InvoiceItem extends AbstractItem {
+    /**
+     * Price of a single unit before discount application.
+     */
+    readonly basePrice: Money;
+    /**
+     * Returns the captured amount for this item.
+     */
+    capturedAmount: Money;
+    /**
+     * Returns the number of the invoice to which this item belongs.
+     */
+    readonly invoiceNumber: string;
+    /**
+     * Returns null or the parent item.
+     */
+    parentItem: InvoiceItem | null;
+    /**
+     * Returns the quantity of this item.
+     */
+    readonly quantity: Quantity;
+    /**
+     * Returns the refunded amount for this item.
+     */
+    refundedAmount: Money;
+    private constructor();
+    /**
+     * Price of a single unit before discount application.
+     */
+    getBasePrice(): Money;
+    /**
+     * Returns the captured amount for this item.
+     */
+    getCapturedAmount(): Money;
+    /**
+     * Returns the number of the invoice to which this item belongs.
+     */
+    getInvoiceNumber(): string;
+    /**
+     * Returns null or the parent item.
+     */
+    getParentItem(): InvoiceItem | null;
+    /**
+     * Returns the quantity of this item.
+     */
+    getQuantity(): Quantity;
+    /**
+     * Returns the refunded amount for this item.
+     */
+    getRefundedAmount(): Money;
+    /**
+     * Updates the captured amount for this item.
+     */
+    setCapturedAmount(capturedAmount: Money): void;
+    /**
+     * Set a parent item. The parent item must belong to the same
+     * dw.order.Invoice. 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: InvoiceItem): void;
+    /**
+     * Updates the refunded amount for this item.
+     */
+    setRefundedAmount(refundedAmount: Money): void;
+}
+
+export = InvoiceItem;

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

@@ -0,0 +1,265 @@
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+import Money = require('../value/Money');
+import LineItemCtnr = require('./LineItemCtnr');
+import Collection = require('../util/Collection');
+import LineItemTax = require('./LineItemTax');
+
+declare global {
+    module ICustomAttributes {
+        interface LineItem extends CustomAttributes {
+        }
+    }
+}
+
+/**
+ * Common line item base class.
+ */
+declare class LineItem<T extends ICustomAttributes.LineItem = ICustomAttributes.LineItem> extends ExtensibleObject<T> {
+    /**
+     * Returns the base price for the line item, which is the price of the unit before applying adjustments, in the
+     * purchase currency. The base price may be net or gross of tax depending on the configured taxation policy.
+     */
+    basePrice: Money;
+    /**
+     * Returns the gross price for the line item, which is the price of the unit before applying adjustments, in the
+     * purchase currency, including tax.
+     */
+    grossPrice: Money;
+    /**
+     * Returns the line item ctnr of the line item.
+     */
+    readonly lineItemCtnr: LineItemCtnr<any>;
+    /**
+     * Returns the display text for the line item.
+     */
+    lineItemText: string;
+    /**
+     * Returns the net price for the line item, which is the price of the unit before applying adjustments, in the
+     * purchase currency, excluding tax.
+     */
+    netPrice: Money;
+    /**
+     * Get the price of the line item. If the line item is based on net pricing then the net price is returned. If the
+     * line item is based on gross pricing then the gross price is returned.
+     */
+    readonly price: Money;
+    /**
+     * Return the price amount for the line item. Same as getPrice().getValue().
+     */
+    priceValue: number;
+    /**
+     * Returns the tax for the line item, which is the tax of the unit before applying adjustments, in the purchase
+     * currency.
+     */
+    tax: Money;
+    /**
+     * Get the price used to calculate the tax for this line item.
+     */
+    readonly taxBasis: Money;
+    /**
+     * Returns the tax class ID for the line item or null if no tax class ID is associated with the line item. In the
+     * case where the tax class ID is null, you should use the default tax class ID.
+     * @see dw.order.TaxMgr.getDefaultTaxClassID
+     */
+    taxClassID: string | null;
+    /**
+     * Returns the tax rate, which is the decimal tax rate to be applied to the product represented by this line item. A
+     * value of 0.175 represents a percentage of 17.5%.
+     */
+    taxRate: number;
+    /**
+     * Returns the tax items for this line item. When taxes are set via setTaxes, the line item's
+     * tax amount and tax rate are updated as the sum and combined rate of all tax items. The tax items are preserved
+     * after order creation and can be retrieved on both baskets and orders.
+     * 
+     * Access is currently restricted to select pilot customers and controlled via feature toggle.
+     * @see setTaxes
+     * @see LineItemTax
+     */
+    taxes: Collection<LineItemTax>;
+    /**
+     * Returns the base price for the line item, which is the price of the unit before applying adjustments, in the
+     * purchase currency. The base price may be net or gross of tax depending on the configured taxation policy.
+     */
+    getBasePrice(): Money;
+    /**
+     * Returns the gross price for the line item, which is the price of the unit before applying adjustments, in the
+     * purchase currency, including tax.
+     */
+    getGrossPrice(): Money;
+    /**
+     * Returns the line item ctnr of the line item.
+     */
+    getLineItemCtnr(): LineItemCtnr<any>;
+    /**
+     * Returns the display text for the line item.
+     */
+    getLineItemText(): string;
+    /**
+     * Returns the net price for the line item, which is the price of the unit before applying adjustments, in the
+     * purchase currency, excluding tax.
+     */
+    getNetPrice(): Money;
+    /**
+     * Get the price of the line item. If the line item is based on net pricing then the net price is returned. If the
+     * line item is based on gross pricing then the gross price is returned.
+     */
+    getPrice(): Money;
+    /**
+     * Return the price amount for the line item. Same as getPrice().getValue().
+     */
+    getPriceValue(): number;
+    /**
+     * Returns the tax for the line item, which is the tax of the unit before applying adjustments, in the purchase
+     * currency.
+     */
+    getTax(): Money;
+    /**
+     * Get the price used to calculate the tax for this line item.
+     */
+    getTaxBasis(): Money;
+    /**
+     * Returns the tax class ID for the line item or null if no tax class ID is associated with the line item. In the
+     * case where the tax class ID is null, you should use the default tax class ID.
+     * @see dw.order.TaxMgr.getDefaultTaxClassID
+     */
+    getTaxClassID(): string | null;
+    /**
+     * Returns the tax rate, which is the decimal tax rate to be applied to the product represented by this line item. A
+     * value of 0.175 represents a percentage of 17.5%.
+     */
+    getTaxRate(): number;
+    /**
+     * Returns the tax items for this line item. When taxes are set via setTaxes, the line item's
+     * tax amount and tax rate are updated as the sum and combined rate of all tax items. The tax items are preserved
+     * after order creation and can be retrieved on both baskets and orders.
+     * 
+     * Access is currently restricted to select pilot customers and controlled via feature toggle.
+     * @see setTaxes
+     * @see LineItemTax
+     */
+    getTaxes(): Collection<LineItemTax>;
+    /**
+     * Sets the base price for the line item, which is the price of the unit before applying adjustments, in the
+     * purchase currency. The base price may be net or gross of tax depending on the configured taxation policy.
+     * @deprecated Use updatePrice instead.
+     */
+    setBasePrice(aValue: Money): void;
+    /**
+     * Sets the gross price for the line item, which is the Price of the unit before applying adjustments, in the
+     * purchase currency, including tax.
+     * @deprecated Use updatePrice which sets the base price and also the gross price if the line item
+     * is based on gross pricing.
+     */
+    setGrossPrice(aValue: Money): void;
+    /**
+     * Sets the display text for the line item.
+     */
+    setLineItemText(aText: string): void;
+    /**
+     * Sets the value for the net price, which is the price of the unit before applying adjustments, in the purchase
+     * currency, excluding tax.
+     * @deprecated Use updatePrice which sets the base price and also the net price if the line item is
+     * based on net pricing.
+     */
+    setNetPrice(aValue: Money): void;
+    /**
+     * Sets price attributes of the line item based on the current purchase currency and taxation policy.
+     * 
+     * The methods sets the 'basePrice' attribute of the line item. Additionally, it sets the 'netPrice' attribute of
+     * the line item if the current taxation policy is 'net', and the 'grossPrice' attribute, if the current taxation
+     * policy is 'gross'.
+     * 
+     * If null is specified as value, the price attributes are reset to Money.NOT_AVAILABLE.
+     */
+    setPriceValue(value: number): void;
+    /**
+     * Sets the value for the tax of the line item, which is the the tax of the unit before applying adjustments, in the
+     * purchase currency.
+     * 
+     * If tax items are already set (e.g. via setTaxes), calling this will clear them.
+     */
+    setTax(aValue: Money): void;
+    /**
+     * Sets the tax class ID for the line item.
+     */
+    setTaxClassID(aValue: string): void;
+    /**
+     * Sets the tax rate, which is the decimal tax rate to be applied to the product represented by this line item. A
+     * value of 0.175 represents a percentage of 17.5%.
+     * 
+     * If tax items are already set (e.g. via setTaxes), calling this will clear them.
+     */
+    setTaxRate(taxRate: number): void;
+    /**
+     * Sets the tax items for this line item. The container must be a basket. Persists the given items, then aggregates
+     * them (sum of tax values, combined tax rate) and updates this line item's tax amount and tax rate accordingly.
+     * 
+     * Each element in the collection must be a LineItemTax, for example created via
+     * LineItemTax.LineItemTax.
+     * 
+     * Use either multilevel tax items via setTaxes or
+     * setTax/setTaxRate/updateTax/updateTaxAmount,
+     * not both.
+     * 
+     * Access is currently restricted to select pilot customers and controlled via feature toggle.
+     * 
+     * The maximum number of tax items allowed per line item is 10.
+     * @throws IllegalArgumentException if the container is not a basket, or if more than 10 tax items are provided
+     * @see getTaxes
+     * @see LineItemTax
+     */
+    setTaxes(taxItems: Collection<any>): void;
+    /**
+     * Updates the price attributes of the line item based on the specified price. The base price is set to the
+     * specified value. If the line item is based on net pricing then the net price attribute is set. If the line item
+     * is based on gross pricing then the gross price attribute is set. Whether or not a line item is based on net or
+     * gross pricing is a site-wide configuration parameter.
+     * @deprecated Use setPriceValue instead.
+     */
+    updatePrice(price: Money): void;
+    /**
+     * Updates the tax-related attributes of the line item based on the specified tax rate, a tax basis determined by
+     * the system and the "Tax Rounding Mode" order preference. This method sets the tax basis as an attribute, and is
+     * not affected by the previous value of this attribute.
+     * 
+     * The value used as a basis depends on the type of line item this is and on the promotion preferences for the
+     * current site. If you tax products, shipping, and discounts based on price (default), then the tax basis will
+     * simply be equal to getPrice. If you tax products and shipping only based on adjusted price, then the
+     * tax basis depends upon line item type as follows:
+     * 
+     * - ProductLineItem: basis equals dw.order.ProductLineItem.getProratedPrice.
+     * - ShippingLineItem: basis equals dw.order.ShippingLineItem.getAdjustedPrice.
+     * - ProductShippingLineItem: basis equals
+     * dw.order.ProductShippingLineItem.getAdjustedPrice.
+     * - PriceAdjustment: basis equals 0.00.
+     * - All other line item types: basis equals getPrice.
+     * 
+     * If null is passed as tax rate, tax-related attribute fields are set to N/A.
+     */
+    updateTax(taxRate: number): void;
+    /**
+     * Updates the tax-related attributes of the line item based on the specified tax rate, the passed tax basis and the
+     * "Tax Rounding Mode" order preference. If null is passed as tax rate or tax basis, tax-related attribute fields
+     * are set to N/A.
+     * 
+     * If tax items are already set (e.g. via setTaxes), calling this will clear them.
+     */
+    updateTax(taxRate: number, taxBasis: Money | null): void;
+    /**
+     * Updates tax amount of the line item setting the provided value. Depending on the way how the tax is calculated
+     * (based on net or gross price), the corresponding gross or net price is updated accordingly. For tax calculation
+     * based on net price, the gross price is calculated by adding the tax to the net price. For tax calculation based
+     * on gross price, the net price is calculated by subtracting the tax from the gross price.
+     * 
+     * If null is passed as tax amount, the item tax and resulting net or gross price are set to N/A.
+     * 
+     * Note that tax rate is not calculated and it is not updated.
+     * 
+     * If tax items are already set (e.g. via setTaxes), calling this will clear them.
+     */
+    updateTaxAmount(tax: Money): void;
+}
+
+export = LineItem;