@salesforce/b2c-cli 1.11.0 → 1.12.0

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/ProductInventoryList.d.ts

@@ -0,0 +1,65 @@
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+import ProductInventoryRecord = require('./ProductInventoryRecord');
+import Product = require('./Product');
+
+declare global {
+    module ICustomAttributes {
+        interface ProductInventoryList extends CustomAttributes {
+        }
+    }
+}
+
+/**
+ * The ProductInventoryList provides access to ID, description and defaultInStockFlag of the list. Furthermore inventory
+ * records can be accessed by product or product ID.
+ * 
+ * When using Omnichannel Inventory (OCI):
+ * 
+ * - B2C Commerce uses ProductInventoryLists to reference and expose OCI Locations and Location Groups. They're
+ * required for synchronizing availability data and creating reservations.
+ * - Create a ProductInventoryList in B2C Commerce for each OCI Location and Location Group that B2C Commerce will
+ * access. The ProductInventoryList ID must match the External Reference field on the corresponding Location or Location
+ * Group.
+ * - A ProductInventoryList ID/External Reference must have between 2 and 128 characters (inclusive). It can include
+ * only lowercase letters, uppercase letters, digits, hyphens, and underscores.
+ */
+declare class ProductInventoryList extends ExtensibleObject<ICustomAttributes.ProductInventoryList> {
+    /**
+     * Returns the ID of the inventory list.
+     */
+    readonly ID: string;
+    /**
+     * Returns the default in-stock flag of the inventory list.
+     */
+    readonly defaultInStockFlag: boolean;
+    /**
+     * Returns the description of the inventory list.
+     */
+    readonly description: string;
+    private constructor();
+    /**
+     * Returns the default in-stock flag of the inventory list.
+     */
+    getDefaultInStockFlag(): boolean;
+    /**
+     * Returns the description of the inventory list.
+     */
+    getDescription(): string;
+    /**
+     * Returns the ID of the inventory list.
+     */
+    getID(): string;
+    /**
+     * Returns the inventory record for the specified product or null
+     * if there is no record for the product in this list.
+     */
+    getRecord(product: Product<any>): ProductInventoryRecord | null;
+    /**
+     * Returns the inventory record for the specified product ID or null
+     * if there is no record for the product id in this list.
+     */
+    getRecord(productID: string): ProductInventoryRecord | null;
+}
+
+export = ProductInventoryList;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/ProductInventoryMgr.d.ts

@@ -0,0 +1,53 @@
+import ProductInventoryList = require('./ProductInventoryList');
+
+/**
+ * This manager provides access to inventory-related objects.
+ */
+declare class ProductInventoryMgr {
+    /**
+     * Integration mode 'B2C' - using B2C inventory, no integration with Omnichannel Inventory
+     */
+    static readonly INTEGRATIONMODE_B2C = "B2C";
+    /**
+     * Integration mode 'OCI' - integration with Omnichannel Inventory enabled
+     */
+    static readonly INTEGRATIONMODE_OCI = "OCI";
+    /**
+     * Integration mode 'OCI_CACHE' - using B2C inventory, initializing cache as preparation for integration with
+     * Omnichannel Inventory
+     */
+    static readonly INTEGRATIONMODE_OCI_CACHE = "OCI_CACHE";
+    /**
+     * Returns the current inventory integration mode as one of
+     * 
+     * - ProductInventoryMgr.INTEGRATIONMODE_B2C
+     * - ProductInventoryMgr.INTEGRATIONMODE_OCI_CACHE
+     * - ProductInventoryMgr.INTEGRATIONMODE_OCI
+     */
+    static readonly inventoryIntegrationMode: string;
+    /**
+     * Returns the inventory list assigned to the current site or null if no inventory list is assigned to the current
+     * site.
+     */
+    static readonly inventoryList: ProductInventoryList | null;
+    private constructor();
+    /**
+     * Returns the current inventory integration mode as one of
+     * 
+     * - ProductInventoryMgr.INTEGRATIONMODE_B2C
+     * - ProductInventoryMgr.INTEGRATIONMODE_OCI_CACHE
+     * - ProductInventoryMgr.INTEGRATIONMODE_OCI
+     */
+    static getInventoryIntegrationMode(): string;
+    /**
+     * Returns the inventory list assigned to the current site or null if no inventory list is assigned to the current
+     * site.
+     */
+    static getInventoryList(): ProductInventoryList | null;
+    /**
+     * Returns the inventory list with the passed ID or null if no inventory list exists with that ID.
+     */
+    static getInventoryList(listID: string): ProductInventoryList | null;
+}
+
+export = ProductInventoryMgr;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/ProductInventoryRecord.d.ts

@@ -0,0 +1,296 @@
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+import Quantity = require('../value/Quantity');
+import ObjectTypeDefinition = require('../object/ObjectTypeDefinition');
+
+declare global {
+    module ICustomAttributes {
+        interface ProductInventoryRecord extends CustomAttributes {
+        }
+    }
+}
+
+/**
+ * The ProductInventoryRecord holds information about a Product's inventory, and availability.
+ * 
+ * When using Omnichannel Inventory (OCI):
+ * 
+ * - All ProductInventoryRecord properties are read-only. Calling any setter method throws an
+ * IllegalStateException.
+ * - The ProductInventoryRecord class does not support custom properties.
+ * - isPerpetual and isPreorderable always return false.
+ */
+declare class ProductInventoryRecord extends ExtensibleObject<ICustomAttributes.ProductInventoryRecord> {
+    /**
+     * Returns the quantity of items available to sell (ATS). This is calculated as the allocation
+     * (getAllocation) plus the preorderBackorderAllocation (getPreorderBackorderAllocation) minus
+     * the turnover (getTurnover) minus the on order quantity (getOnOrder).
+     * 
+     * When using OCI, corresponds to the ATO (Available To Order) quantity in OCI.
+     */
+    readonly ATS: Quantity;
+    /**
+     * Returns the allocation quantity that is currently set. The quantity unit is the same unit as the product itself.
+     * 
+     * When using OCI, returns the physically available quantity. Corresponds to the On Hand quantity in OCI.
+     */
+    allocation: Quantity;
+    /**
+     * Returns the date the allocation quantity was initialized or reset.
+     * 
+     * When using OCI, corresponds to the Effective Date in OCI. The value can be null.
+     */
+    readonly allocationResetDate: Date;
+    /**
+     * Determines if the product is backorderable.
+     * 
+     * When using OCI, returns true if the product has at least one Future quantity in OCI.
+     */
+    backorderable: boolean;
+    /**
+     * Returns the date that the item is expected to be in stock.
+     * 
+     * When using OCI, returns the date of the earliest Future quantity. If the product has no Future quantities, it
+     * returns null.
+     */
+    inStockDate: Date;
+    /**
+     * Returns the on-hand quantity, the actual quantity of available (on-hand) items.
+     * @deprecated Use getStockLevel instead.
+     */
+    readonly onHand: Quantity;
+    /**
+     * Returns the quantity that is currently on order.
+     * 
+     * This is only relevant when On Order Inventory is turned on for the related inventory list. On Order is a bucket
+     * of inventory used for the time between order creation and order export to external (warehouse) systems. On Order
+     * value is increased when an order is created. It will be decreased and with that turnover will be increased when
+     * the order is exported, see getTurnover. Notice that dw.order.Order.setExportStatus and
+     * dw.order.OrderItem.allocateInventory will decrease the On Order value. On order will be included
+     * in the ATS calculation, see getATS.
+     * 
+     * When using OCI, always returns zero. OCI doesn't support On Order inventory.
+     */
+    readonly onOrder: Quantity;
+    /**
+     * Determines if the product is perpetually in stock.
+     * 
+     * When using OCI, always returns false.
+     */
+    perpetual: boolean;
+    /**
+     * Returns the quantity of items that are allocated for sale, beyond the initial stock allocation.
+     * 
+     * When using OCI, returns the sum of all Future quantities. If the product has no Future quantities, it returns
+     * zero.
+     */
+    preorderBackorderAllocation: Quantity;
+    /**
+     * Determines if the product is preorderable.
+     * 
+     * When using OCI, always returns false.
+     */
+    preorderable: boolean;
+    /**
+     * Returns the quantity of items that are reserved.
+     * 
+     * Note that for products with high velocity and concurrency, the return value is extremely volatile and the
+     * retrieval will be expensive.
+     * 
+     * When using OCI, always returns zero.
+     */
+    readonly reserved: Quantity;
+    /**
+     * Returns the current stock level. This is calculated as the allocation minus the turnover.
+     * 
+     * When using OCI, corresponds to the ATF (Available To Fulfill) quantity in OCI.
+     */
+    readonly stockLevel: Quantity;
+    /**
+     * Returns the sum of all inventory transactions (decrements and increments) recorded after the allocation reset
+     * date. If the total decremented quantity is greater than the total incremented quantity, then this value is
+     * negative.
+     * 
+     * When using OCI, returns the total reserved quantity, including order, basket, and temporary reservations.
+     */
+    readonly turnover: Quantity;
+    private constructor();
+    /**
+     * Returns the meta data of this object. If no meta data is available the method returns null. The returned
+     * ObjectTypeDefinition can be used to retrieve the metadata for any of the custom attributes.
+     * 
+     * When using Omnichannel Inventory (OCI), this class doesn't support custom attributes. If OCI is enabled, then
+     * attempting to set or modify a custom attribute value throws an UnsupportedOperationException.
+     */
+    describe(): ObjectTypeDefinition;
+    /**
+     * Returns the quantity of items available to sell (ATS). This is calculated as the allocation
+     * (getAllocation) plus the preorderBackorderAllocation (getPreorderBackorderAllocation) minus
+     * the turnover (getTurnover) minus the on order quantity (getOnOrder).
+     * 
+     * When using OCI, corresponds to the ATO (Available To Order) quantity in OCI.
+     */
+    getATS(): Quantity;
+    /**
+     * Returns the allocation quantity that is currently set. The quantity unit is the same unit as the product itself.
+     * 
+     * When using OCI, returns the physically available quantity. Corresponds to the On Hand quantity in OCI.
+     */
+    getAllocation(): Quantity;
+    /**
+     * Returns the date the allocation quantity was initialized or reset.
+     * 
+     * When using OCI, corresponds to the Effective Date in OCI. The value can be null.
+     */
+    getAllocationResetDate(): Date;
+    /**
+     * Returns the date that the item is expected to be in stock.
+     * 
+     * When using OCI, returns the date of the earliest Future quantity. If the product has no Future quantities, it
+     * returns null.
+     */
+    getInStockDate(): Date;
+    /**
+     * Returns the on-hand quantity, the actual quantity of available (on-hand) items.
+     * @deprecated Use getStockLevel instead.
+     */
+    getOnHand(): Quantity;
+    /**
+     * Returns the quantity that is currently on order.
+     * 
+     * This is only relevant when On Order Inventory is turned on for the related inventory list. On Order is a bucket
+     * of inventory used for the time between order creation and order export to external (warehouse) systems. On Order
+     * value is increased when an order is created. It will be decreased and with that turnover will be increased when
+     * the order is exported, see getTurnover. Notice that dw.order.Order.setExportStatus and
+     * dw.order.OrderItem.allocateInventory will decrease the On Order value. On order will be included
+     * in the ATS calculation, see getATS.
+     * 
+     * When using OCI, always returns zero. OCI doesn't support On Order inventory.
+     */
+    getOnOrder(): Quantity;
+    /**
+     * Returns the quantity of items that are allocated for sale, beyond the initial stock allocation.
+     * 
+     * When using OCI, returns the sum of all Future quantities. If the product has no Future quantities, it returns
+     * zero.
+     */
+    getPreorderBackorderAllocation(): Quantity;
+    /**
+     * Returns the quantity of items that are reserved.
+     * 
+     * Note that for products with high velocity and concurrency, the return value is extremely volatile and the
+     * retrieval will be expensive.
+     * 
+     * When using OCI, always returns zero.
+     */
+    getReserved(): Quantity;
+    /**
+     * Returns the current stock level. This is calculated as the allocation minus the turnover.
+     * 
+     * When using OCI, corresponds to the ATF (Available To Fulfill) quantity in OCI.
+     */
+    getStockLevel(): Quantity;
+    /**
+     * Returns the sum of all inventory transactions (decrements and increments) recorded after the allocation reset
+     * date. If the total decremented quantity is greater than the total incremented quantity, then this value is
+     * negative.
+     * 
+     * When using OCI, returns the total reserved quantity, including order, basket, and temporary reservations.
+     */
+    getTurnover(): Quantity;
+    /**
+     * Determines if the product is backorderable.
+     * 
+     * When using OCI, returns true if the product has at least one Future quantity in OCI.
+     */
+    isBackorderable(): boolean;
+    /**
+     * Determines if the product is perpetually in stock.
+     * 
+     * When using OCI, always returns false.
+     */
+    isPerpetual(): boolean;
+    /**
+     * Determines if the product is preorderable.
+     * 
+     * When using OCI, always returns false.
+     */
+    isPreorderable(): boolean;
+    /**
+     * Sets the allocation quantity. This also updates the allocation reset date.
+     * 
+     * All final reservations will be considered as expired and will therefore no longer be considered for ATS.
+     * 
+     * When using OCI, throws an IllegalStateException.
+     * 
+     * This method should not be called within a storefront request.
+     */
+    setAllocation(quantity: number): void;
+    /**
+     * Sets the allocation quantity. This also updates the allocation reset date.
+     * 
+     * Any final reservations made prior to the allocation reset date will be considered as expired and will therefore
+     * no longer be considered for ATS.
+     * 
+     * When using OCI, throws an IllegalStateException.
+     * 
+     * This method must not be called within a storefront request.
+     */
+    setAllocation(quantity: number, allocationResetDate: Date): void;
+    /**
+     * The method is used to set whether the product is backorderable. Setting the backorderable flag to true will clear
+     * the preorderable flag. If the record's preorderable flag is set to true, calling this method with
+     * backorderableFlag==false will have no effect.
+     * 
+     * When using OCI, throws an IllegalStateException.
+     * 
+     * This method should not be called within a storefront request.
+     * 
+     * This method must not be called within a storefront request when the API version is 21.7 or later.
+     */
+    setBackorderable(backorderableFlag: boolean): void;
+    /**
+     * Sets the date that the item is expected to be in stock.
+     * 
+     * When using OCI, throws an IllegalStateException.
+     * 
+     * This method should not be called within a storefront request.
+     * 
+     * This method must not be called within a storefront request when the API version is 21.7 or later.
+     */
+    setInStockDate(inStockDate: Date): void;
+    /**
+     * Sets if the product is perpetually in stock.
+     * 
+     * When using OCI, throws an IllegalStateException.
+     * 
+     * This method should not be called within a storefront request.
+     * 
+     * This method must not be called within a storefront request when the API version is 21.7 or later.
+     */
+    setPerpetual(perpetualFlag: boolean): void;
+    /**
+     * Sets the quantity of items that are allocated for sale, beyond the initial stock allocation.
+     * 
+     * When using OCI, throws an IllegalStateException.
+     * 
+     * This method should not be called within a storefront request.
+     * 
+     * This method must not be called within a storefront request when the API version is 21.7 or later.
+     */
+    setPreorderBackorderAllocation(quantity: number): void;
+    /**
+     * The method is used to set whether the product is preorderable. Setting the preorderable flag to true will clear
+     * the backorderable flag. If the record's backorderable flag is set to true, calling this method with
+     * preorderableFlag==false will have no effect.
+     * 
+     * When using OCI, throws an IllegalStateException.
+     * 
+     * This method should not be called within a storefront request.
+     * 
+     * This method must not be called within a storefront request when the API version is 21.7 or later.
+     */
+    setPreorderable(preorderableFlag: boolean): void;
+}
+
+export = ProductInventoryRecord;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/ProductLink.d.ts

@@ -0,0 +1,66 @@
+import Product = require('./Product');
+
+/**
+ * The class represents a link between two products.
+ */
+declare class ProductLink {
+    /**
+     * Represents an accessory product link.
+     */
+    static readonly LINKTYPE_ACCESSORY = 4;
+    /**
+     * Represents an alternative order unit product link.
+     */
+    static readonly LINKTYPE_ALT_ORDERUNIT = 6;
+    /**
+     * Represents a cross-sell product link.
+     */
+    static readonly LINKTYPE_CROSS_SELL = 1;
+    /**
+     * Represents a newer verion link.
+     */
+    static readonly LINKTYPE_NEWER_VERSION = 5;
+    /**
+     * Represents a miscellaneous product link.
+     */
+    static readonly LINKTYPE_OTHER = 8;
+    /**
+     * Represents a replacement product link.
+     */
+    static readonly LINKTYPE_REPLACEMENT = 2;
+    /**
+     * Represents a spare part product link.
+     */
+    static readonly LINKTYPE_SPARE_PART = 7;
+    /**
+     * Represents an up-sell product link.
+     */
+    static readonly LINKTYPE_UP_SELL = 3;
+    /**
+     * Returns the source product for this link.
+     */
+    readonly sourceProduct: Product<any>;
+    /**
+     * Returns the target product for this link.
+     */
+    readonly targetProduct: Product<any>;
+    /**
+     * Returns the type of this link (see constants).
+     */
+    readonly typeCode: number;
+    private constructor();
+    /**
+     * Returns the source product for this link.
+     */
+    getSourceProduct(): Product<any>;
+    /**
+     * Returns the target product for this link.
+     */
+    getTargetProduct(): Product<any>;
+    /**
+     * Returns the type of this link (see constants).
+     */
+    getTypeCode(): number;
+}
+
+export = ProductLink;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/ProductMgr.d.ts

@@ -0,0 +1,59 @@
+import Product = require('./Product');
+import SeekableIterator = require('../util/SeekableIterator');
+import Catalog = require('./Catalog');
+
+/**
+ * Provides helper methods for getting products based on Product ID or dw.catalog.Catalog.
+ */
+declare class ProductMgr {
+    private constructor();
+    /**
+     * Returns the product with the specified id.
+     */
+    static getProduct(productID: string): Product<any> | null;
+    /**
+     * Returns all products assigned to the current site.
+     * 
+     * A product is assigned to a site if
+     * 
+     * - it is assigned to at least one category of the site catalog or
+     * - it is a variant and it's master product is assigned to the current site
+     * 
+     * It is strongly recommended to call `close()` on the returned SeekableIterator
+     * if not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.
+     * @see dw.util.SeekableIterator.close
+     */
+    static queryAllSiteProducts(): SeekableIterator<Product<any>>;
+    /**
+     * Returns all products assigned to the current site.
+     * 
+     * Works like queryAllSiteProducts(), but additionally sorts the result set
+     * by product ID.
+     * 
+     * It is strongly recommended to call `close()` on the returned SeekableIterator
+     * if not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.
+     * @see dw.util.SeekableIterator.close
+     */
+    static queryAllSiteProductsSorted(): SeekableIterator<Product<any>>;
+    /**
+     * Returns all products assigned to the the specified catalog, where
+     * assignment has the same meaning as it does for queryAllSiteProducts().
+     * 
+     * It is strongly recommended to call `close()` on the returned SeekableIterator
+     * if not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.
+     * @see dw.util.SeekableIterator.close
+     */
+    static queryProductsInCatalog(catalog: Catalog): SeekableIterator<Product<any>>;
+    /**
+     * Returns all products assigned to the the specified catalog.
+     * Works like queryProductsInCatalog(), but additionally sorts the result
+     * set by product ID.
+     * 
+     * It is strongly recommended to call `close()` on the returned SeekableIterator
+     * if not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.
+     * @see dw.util.SeekableIterator.close
+     */
+    static queryProductsInCatalogSorted(catalog: Catalog): SeekableIterator<Product<any>>;
+}
+
+export = ProductMgr;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/catalog/ProductOption.d.ts

@@ -0,0 +1,81 @@
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+import ProductOptionValue = require('./ProductOptionValue');
+import Collection = require('../util/Collection');
+import MediaFile = require('../content/MediaFile');
+
+declare global {
+    module ICustomAttributes {
+        interface ProductOption extends CustomAttributes {
+        }
+    }
+}
+
+/**
+ * Represents a product option.
+ */
+declare class ProductOption extends ExtensibleObject<ICustomAttributes.ProductOption> {
+    /**
+     * Returns the product option ID.
+     */
+    readonly ID: string;
+    /**
+     * Returns the default value for the product option.
+     */
+    readonly defaultValue: ProductOptionValue;
+    /**
+     * Returns the product option's short description in the current locale.
+     */
+    readonly description: string | null;
+    /**
+     * Returns the product option's display name in the current locale.
+     */
+    readonly displayName: string | null;
+    /**
+     * Returns an HTML representation of the option id.
+     */
+    readonly htmlName: string;
+    /**
+     * Returns the product option's image.
+     */
+    readonly image: MediaFile;
+    /**
+     * Returns a collection containing the product option values.
+     */
+    readonly optionValues: Collection<ProductOptionValue>;
+    private constructor();
+    /**
+     * Returns the default value for the product option.
+     */
+    getDefaultValue(): ProductOptionValue;
+    /**
+     * Returns the product option's short description in the current locale.
+     */
+    getDescription(): string | null;
+    /**
+     * Returns the product option's display name in the current locale.
+     */
+    getDisplayName(): string | null;
+    /**
+     * Returns an HTML representation of the option id.
+     */
+    getHtmlName(): string;
+    /**
+     * Returns an HTML representation of the option id with the custom prefix.
+     */
+    getHtmlName(prefix: string): string;
+    /**
+     * Returns the product option ID.
+     */
+    getID(): string;
+    /**
+     * Returns the product option's image.
+     */
+    getImage(): MediaFile;
+    /**
+     * Returns a collection containing the product option values.
+     */
+    getOptionValues(): Collection<ProductOptionValue>;
+}
+
+export = ProductOption;