@salesforce/b2c-cli 1.11.0 → 1.12.0

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/ProductListItem.d.ts

@@ -0,0 +1,204 @@
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+import Quantity = require('../value/Quantity');
+import Product = require('../catalog/Product');
+import ProductList = require('./ProductList');
+import ProductListItemPurchase = require('./ProductListItemPurchase');
+import Collection = require('../util/Collection');
+import ProductOptionModel = require('../catalog/ProductOptionModel');
+
+declare global {
+    module ICustomAttributes {
+        interface ProductListItem extends CustomAttributes {
+        }
+    }
+}
+
+/**
+ * An item in a product list.  Types of items are:
+ * 
+ * - An item that references a product via the product's SKU.
+ * - An item that represents a gift certificate.
+ */
+declare class ProductListItem extends ExtensibleObject<ICustomAttributes.ProductListItem> {
+    /**
+     * Constant representing a gift certificate list item type.
+     */
+    static readonly TYPE_GIFT_CERTIFICATE: number;
+    /**
+     * Constant representing a product list item type.
+     */
+    static readonly TYPE_PRODUCT: number;
+    /**
+     * Returns the unique system generated ID of the object.
+     */
+    readonly ID: string;
+    /**
+     * Returns the product list that this item belongs to.
+     */
+    readonly list: ProductList;
+    /**
+     * Specify the priority level for the item.  Typically the lower the
+     * number, the higher the priority. This can be used by the owner of the product list
+     * to express which items he/she likes to get purchased first.
+     */
+    priority: number;
+    /**
+     * Returns the referenced product for this item.  The reference is made
+     * via the product ID attribute.  This method returns null if there is
+     * no such product in the system or if the product exists but is not
+     * assigned to the site catalog.
+     */
+    product: Product<any> | null;
+    /**
+     * Returns the ID of the product referenced by this item.
+     * This attribute is set when a product is assigned via setProduct().
+     * It is possible for the ID to reference a product that doesn't exist
+     * anymore.  In this case getProduct() would return null.
+     */
+    readonly productID: string | null;
+    /**
+     * Returns the ProductOptionModel for the product associated with this item,
+     * or null if there is no valid product associated with this item.
+     */
+    productOptionModel: ProductOptionModel | null;
+    /**
+     * A flag, typically used to determine whether the item should display
+     * in a customer's view of the list (as opposed to the list owner's view).
+     */
+    public: boolean;
+    /**
+     * Returns the sum of the quantities of all the individual purchase records
+     * for this item.
+     */
+    readonly purchasedQuantity: Quantity;
+    /**
+     * Returns the value part of the underlying purchased quantity object, as distinct
+     * from the unit.
+     */
+    readonly purchasedQuantityValue: number;
+    /**
+     * Returns all purchases made for this item.
+     */
+    readonly purchases: Collection<ProductListItemPurchase>;
+    /**
+     * Returns the quantity of the item.
+     * The quantity is the number of products or gift certificates
+     * that get shipped when purchasing this product list item.
+     */
+    quantity: Quantity;
+    /**
+     * Returns the value part of the underlying quantity object, as distinct
+     * from the unit.
+     */
+    quantityValue: number;
+    /**
+     * Returns the type of this product list item.
+     */
+    readonly type: number;
+    private constructor();
+    /**
+     * Create a purchase record for this item.
+     */
+    createPurchase(quantity: number, purchaserName: string): ProductListItemPurchase;
+    /**
+     * Returns the unique system generated ID of the object.
+     */
+    getID(): string;
+    /**
+     * Returns the product list that this item belongs to.
+     */
+    getList(): ProductList;
+    /**
+     * Specify the priority level for the item.  Typically the lower the
+     * number, the higher the priority. This can be used by the owner of the product list
+     * to express which items he/she likes to get purchased first.
+     */
+    getPriority(): number;
+    /**
+     * Returns the referenced product for this item.  The reference is made
+     * via the product ID attribute.  This method returns null if there is
+     * no such product in the system or if the product exists but is not
+     * assigned to the site catalog.
+     */
+    getProduct(): Product<any> | null;
+    /**
+     * Returns the ID of the product referenced by this item.
+     * This attribute is set when a product is assigned via setProduct().
+     * It is possible for the ID to reference a product that doesn't exist
+     * anymore.  In this case getProduct() would return null.
+     */
+    getProductID(): string | null;
+    /**
+     * Returns the ProductOptionModel for the product associated with this item,
+     * or null if there is no valid product associated with this item.
+     */
+    getProductOptionModel(): ProductOptionModel | null;
+    /**
+     * Returns the sum of the quantities of all the individual purchase records
+     * for this item.
+     */
+    getPurchasedQuantity(): Quantity;
+    /**
+     * Returns the value part of the underlying purchased quantity object, as distinct
+     * from the unit.
+     */
+    getPurchasedQuantityValue(): number;
+    /**
+     * Returns all purchases made for this item.
+     */
+    getPurchases(): Collection<ProductListItemPurchase>;
+    /**
+     * Returns the quantity of the item.
+     * The quantity is the number of products or gift certificates
+     * that get shipped when purchasing this product list item.
+     */
+    getQuantity(): Quantity;
+    /**
+     * Returns the value part of the underlying quantity object, as distinct
+     * from the unit.
+     */
+    getQuantityValue(): number;
+    /**
+     * Returns the type of this product list item.
+     */
+    getType(): number;
+    /**
+     * A flag, typically used to determine whether the item should display
+     * in a customer's view of the list (as opposed to the list owner's view).
+     */
+    isPublic(): boolean;
+    /**
+     * Specify the priority level for the item.  Typically the lower the
+     * number, the higher the priority. This can be used by the owner of the product list
+     * to express which items he/she likes to get purchased first.
+     */
+    setPriority(priority: number): void;
+    /**
+     * Sets the referenced product for this item by storing the product's id.
+     * If null is specified, then the id is set to null.
+     * @deprecated Use dw.customer.ProductList.createProductItem instead.
+     */
+    setProduct(product: Product<any>): void;
+    /**
+     * Store a product option model with this object.  This stores a copy
+     * of the specified model, rather than an assocation to the same instance.
+     */
+    setProductOptionModel(productOptionModel: ProductOptionModel): void;
+    /**
+     * Typically used to determine if the item is visible to other customers.
+     */
+    setPublic(flag: boolean): void;
+    /**
+     * Sets the quantity of the item.
+     * @deprecated Use setQuantityValue instead.
+     */
+    setQuantity(value: Quantity): void;
+    /**
+     * Set the value part of the underlying quantity object, as distinct from
+     * the unit.
+     */
+    setQuantityValue(value: number): void;
+}
+
+export = ProductListItem;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/ProductListItemPurchase.d.ts

@@ -0,0 +1,62 @@
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+import Quantity = require('../value/Quantity');
+import ProductListItem = require('./ProductListItem');
+
+declare global {
+    module ICustomAttributes {
+        interface ProductListItemPurchase extends CustomAttributes {
+        }
+    }
+}
+
+/**
+ * A record of the purchase of an item contained in a product list.
+ */
+declare class ProductListItemPurchase extends ExtensibleObject<ICustomAttributes.ProductListItemPurchase> {
+    /**
+     * Returns the item that was purchased.
+     */
+    readonly item: ProductListItem;
+    /**
+     * Returns the number of the order in which the
+     * product list item was purchased.
+     */
+    readonly orderNo: string;
+    /**
+     * Returns the date on which the product list item was purchased.
+     */
+    readonly purchaseDate: Date;
+    /**
+     * Returns the name of the purchaser of the product list item.
+     */
+    readonly purchaserName: string;
+    /**
+     * Returns the quantity of the product list item that was purchased.
+     */
+    readonly quantity: Quantity;
+    private constructor();
+    /**
+     * Returns the item that was purchased.
+     */
+    getItem(): ProductListItem;
+    /**
+     * Returns the number of the order in which the
+     * product list item was purchased.
+     */
+    getOrderNo(): string;
+    /**
+     * Returns the date on which the product list item was purchased.
+     */
+    getPurchaseDate(): Date;
+    /**
+     * Returns the name of the purchaser of the product list item.
+     */
+    getPurchaserName(): string;
+    /**
+     * Returns the quantity of the product list item that was purchased.
+     */
+    getQuantity(): Quantity;
+}
+
+export = ProductListItemPurchase;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/ProductListMgr.d.ts

@@ -0,0 +1,190 @@
+import ProductList = require('./ProductList');
+import Customer = require('./Customer');
+import Collection = require('../util/Collection');
+import Profile = require('./Profile');
+import CustomerAddress = require('./CustomerAddress');
+import SeekableIterator = require('../util/SeekableIterator');
+import utilMap = require('../util/Map');
+
+/**
+ * ProductListMgr provides methods for retrieving, creating, searching for, and
+ * removing product lists.
+ */
+declare class ProductListMgr {
+    private constructor();
+    /**
+     * Creates a new instance of a product list, of the specified type.
+     */
+    static createProductList(customer: Customer, type: number): ProductList;
+    /**
+     * Gets the product list by its ID.
+     */
+    static getProductList(ID: string): ProductList | null;
+    /**
+     * Returns the first product list belonging to the customer with the
+     * specified profile.
+     * @deprecated Use getProductLists or getProductLists instead.
+     */
+    static getProductList(profile: Profile, type: number): ProductList | null;
+    /**
+     * Retrieve all product lists of the specified type owned by the
+     * specified customer.
+     */
+    static getProductLists(customer: Customer, type: number): Collection<ProductList>;
+    /**
+     * Retrieve all the product lists of the specified type and event type
+     * belonging to the specified customer.
+     */
+    static getProductLists(customer: Customer, type: number, eventType: string): Collection<ProductList>;
+    /**
+     * Returns the collection of product lists that have the specified address
+     * as the shipping address.
+     */
+    static getProductLists(customerAddress: CustomerAddress): Collection<ProductList>;
+    /**
+     * 
+     * Searches for product list instances.
+     * 
+     * The search can be configured with a map, which key-value pairs are
+     * converted into a query expression. The key-value pairs are turned into a
+     * sequence of '=' or 'like' conditions, which are combined with AND
+     * statements.
+     * 
+     * Example:
+     * 
+     * A map with the key/value pairs: 'name'/'tom*', 'age'/66
+     * will be converted as follows: `"name like 'tom*' and age = 66"`
+     * 
+     * The identifier for an attribute  to use in a query condition is always the
+     * ID of the  attribute as defined in the type definition. For custom defined attributes
+     * the prefix custom is required in the search term (e.g. `custom.color = {1}`),
+     * while for system attributes no prefix is used (e.g. `name = {4}`).
+     * 
+     * Supported attribute value types with sample expression values:
+     * - String `'String', 'Str*', 'Strin?'`
+     * - Integer `1, 3E4`
+     * - Number `1.0, 3.99E5`
+     * - Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`
+     * - DateTime `yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`
+     * - Boolean `true, false`
+     * - Email `'search@demandware.com', '*@demandware.com'`
+     * - Set of String `'String', 'Str*', 'Strin?'`
+     * - Set of Integer `1, 3E4`
+     * - Set of Number `1.0, 3.99E5`
+     * - Enum of String `'String', 'Str*', 'Strin?'`
+     * - Enum of Integer `1, 3E4`
+     * 
+     * The following types of attributes are not queryable:
+     * 
+     * - Image
+     * - HTML
+     * - Text
+     * - Quantity
+     * - Password
+     * 
+     * Note, that some system attributes are not queryable by default regardless of the
+     * actual value type code.
+     * 
+     * The sorting parameter is optional and may contain a comma separated list of
+     * attribute names to sort by. Each sort attribute name may be followed by an
+     * optional sort direction specifier ('asc' | 'desc'). Default sorting directions is
+     * ascending, if no direction was specified.
+     * 
+     * Example: `age desc, name`
+     * 
+     * Please note that specifying a localized custom attribute as the sorting attribute is
+     * currently not supported.
+     * 
+     * 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 queryProductLists(queryAttributes: utilMap<any, any>, sortString: string | null): SeekableIterator<ProductList>;
+    /**
+     * 
+     * Searches for product list instances.
+     * 
+     * The search can be configured using a simple query language, which
+     * provides most common filter and operator functionality.
+     * 
+     * The identifier for an attribute  to use in a query condition is always the
+     * ID of the  attribute as defined in the type definition. For custom defined attributes
+     * the prefix custom is required in the search term (e.g. `custom.color = {1}`),
+     * while for system attributes no prefix is used (e.g. `name = {4}`).
+     * 
+     * Supported attribute value types with sample expression values:
+     * - String `'String', 'Str*', 'Strin?'`
+     * - Integer `1, 3E4`
+     * - Number `1.0, 3.99E5`
+     * - Date `yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC)`
+     * - DateTime `yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00`
+     * - Boolean `true, false`
+     * - Email `'search@demandware.com', '*@demandware.com'`
+     * - Set of String `'String', 'Str*', 'Strin?'`
+     * - Set of Integer `1, 3E4`
+     * - Set of Number `1.0, 3.99E5`
+     * - Enum of String `'String', 'Str*', 'Strin?'`
+     * - Enum of Integer `1, 3E4`
+     * 
+     * The following types of attributes are not queryable:
+     * 
+     * - Image
+     * - HTML
+     * - Text
+     * - Quantity
+     * - Password
+     * 
+     * Note, that some system attributes are not queryable by default regardless of the
+     * actual value type code.
+     * 
+     * The following operators are supported in a condition:
+     * 
+     * - `=` Equals - All types; supports NULL value (`thumbnail = NULL`)
+     * - `!=` Not equals - All types; supports NULL value (`thumbnail != NULL`)
+     * - `<` Less than  - Integer, Number and Date types only
+     * - `>` Greater than - Integer, Number and Date types only
+     * - `<=` Less or equals than - Integer, Number and Date types only
+     * - `>=` Greater or equals than  - Integer, Number and Date types only
+     * - `LIKE` Like - String types and Email only; use if leading or trailing
+     * wildcards will be used to support substring search(`custom.country LIKE 'US*'`)
+     * - `ILIKE` Caseindependent Like - String types and Email only, use to support
+     * case insensitive query (`custom.country ILIKE 'usa'`), does also support wildcards for
+     * substring matching
+     * 
+     * Conditions can be combined using logical expressions 'AND', 'OR' and 'NOT'
+     * and nested using parenthesis e.g.
+     * `gender = {1} AND (age >= {2} OR (NOT profession LIKE {3}))`.
+     * 
+     * The query language provides a placeholder syntax to pass objects as
+     * additional search parameters. Each passed object is related to a
+     * placeholder in the query string. The placeholder must be an Integer that
+     * is surrounded by braces. The first Integer value must be '0', the second
+     * '1' and so on, e.g.
+     * `querySystemObjects("sample", "age = {0} or creationDate >= {1}", 18, date)`
+     * 
+     * The sorting parameter is optional and may contain a comma separated list of
+     * attribute names to sort by. Each sort attribute name may be followed by an
+     * optional sort direction specifier ('asc' | 'desc'). Default sorting directions is
+     * ascending, if no direction was specified.
+     * 
+     * Example: `age desc, name`
+     * 
+     * Please note that specifying a localized custom attribute as the sorting attribute is
+     * currently not supported.
+     * 
+     * Sometimes it is desired to get all instances with a special sorting condition.
+     * This can be easily done by providing the 'sortString' in combination with
+     * an empty 'queryString', e.g. `querySystemObjects("sample", "", "ID asc")`
+     * 
+     * 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 queryProductLists(queryString: string, sortString: string | null, ...args: any[]): SeekableIterator<ProductList>;
+    /**
+     * Removes the specified product list from the system.
+     */
+    static removeProductList(productList: ProductList): void;
+}
+
+export = ProductListMgr;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/ProductListRegistrant.d.ts

@@ -0,0 +1,70 @@
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+
+declare global {
+    module ICustomAttributes {
+        interface ProductListRegistrant extends CustomAttributes {
+        }
+    }
+}
+
+/**
+ * A ProductListRegistrant is typically associated with an event related product list
+ * such as a gift registry. It holds information about a person associated with the
+ * event such as a bride or groom.
+ */
+declare class ProductListRegistrant extends ExtensibleObject<ICustomAttributes.ProductListRegistrant> {
+    /**
+     * Returns the email address of the registrant or null.
+     */
+    email: string | null;
+    /**
+     * Returns the first name of the registrant or null.
+     */
+    firstName: string | null;
+    /**
+     * Returns the last name of the registrant or null.
+     */
+    lastName: string | null;
+    /**
+     * Returns the role of the registrant or null. The role of a registrant
+     * can be for example the bride of a bridal couple.
+     */
+    role: string | null;
+    private constructor();
+    /**
+     * Returns the email address of the registrant or null.
+     */
+    getEmail(): string | null;
+    /**
+     * Returns the first name of the registrant or null.
+     */
+    getFirstName(): string | null;
+    /**
+     * Returns the last name of the registrant or null.
+     */
+    getLastName(): string | null;
+    /**
+     * Returns the role of the registrant or null. The role of a registrant
+     * can be for example the bride of a bridal couple.
+     */
+    getRole(): string | null;
+    /**
+     * Sets the email address of the registrant.
+     */
+    setEmail(email: string): void;
+    /**
+     * Sets the first name of the registrant.
+     */
+    setFirstName(firstName: string): void;
+    /**
+     * Sets the last name of the registrant.
+     */
+    setLastName(lastName: string): void;
+    /**
+     * Sets the role of the registrant.
+     */
+    setRole(role: string): void;
+}
+
+export = ProductListRegistrant;