@salesforce/b2c-cli 1.10.0 → 1.12.0

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

@@ -0,0 +1,214 @@
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+import EnumValue = require('../value/EnumValue');
+import MarkupText = require('../content/MarkupText');
+import MediaFile = require('../content/MediaFile');
+import ProductInventoryList = require('./ProductInventoryList');
+import Collection = require('../util/Collection');
+import StoreGroup = require('./StoreGroup');
+
+declare global {
+    module ICustomAttributes {
+        interface Store extends CustomAttributes {
+        }
+    }
+}
+
+/**
+ * Represents a store in Commerce Cloud Digital.
+ */
+declare class Store extends ExtensibleObject<ICustomAttributes.Store> {
+    /**
+     * Returns the ID of the store.
+     */
+    readonly ID: string;
+    /**
+     * Returns the address1 of the store.
+     */
+    readonly address1: string;
+    /**
+     * Returns the address2 of the store.
+     */
+    readonly address2: string;
+    /**
+     * Returns the city of the store.
+     */
+    readonly city: string;
+    /**
+     * Returns the countryCode of the store.
+     */
+    readonly countryCode: EnumValue;
+    /**
+     * Returns the demandwarePosEnabled flag for the store.
+     * Indicates that this store uses Commerce Cloud Store for point-of-sale.
+     * @deprecated Use isPosEnabled instead
+     */
+    readonly demandwarePosEnabled: boolean;
+    /**
+     * Returns the email of the store.
+     */
+    readonly email: string;
+    /**
+     * Returns the fax of the store.
+     */
+    readonly fax: string;
+    /**
+     * Returns the store image.
+     */
+    readonly image: MediaFile;
+    /**
+     * Returns the inventory list the store is associated with. If the
+     * store is not associated with a inventory list, or the inventory list does not
+     * exist, the method returns null.
+     */
+    readonly inventoryList: ProductInventoryList | null;
+    /**
+     * Returns the inventory list id the store is associated with. If the
+     * store is not associated with a inventory list, or the inventory list does not
+     * exist, the method returns null.
+     */
+    readonly inventoryListID: string;
+    /**
+     * Returns the latitude of the store.
+     */
+    readonly latitude: number;
+    /**
+     * Returns the longitude of the store.
+     */
+    readonly longitude: number;
+    /**
+     * Returns the name of the store.
+     */
+    readonly name: string;
+    /**
+     * Returns the phone of the store.
+     */
+    readonly phone: string;
+    /**
+     * Returns the posEnabled flag for the Store.
+     * Indicates that this store uses Commerce Cloud Store for point-of-sale.
+     */
+    readonly posEnabled: boolean;
+    /**
+     * Returns the postalCode of the store.
+     */
+    readonly postalCode: string;
+    /**
+     * Returns the stateCode of the store.
+     */
+    readonly stateCode: string;
+    /**
+     * Returns the storeEvents of the store.
+     */
+    readonly storeEvents: MarkupText;
+    /**
+     * Returns all the store groups this store belongs to.
+     */
+    readonly storeGroups: Collection<StoreGroup>;
+    /**
+     * Returns the storeHours of the store.
+     */
+    readonly storeHours: MarkupText;
+    /**
+     * Returns the storeLocatorEnabled flag for the store.
+     */
+    readonly storeLocatorEnabled: boolean;
+    private constructor();
+    /**
+     * Returns the address1 of the store.
+     */
+    getAddress1(): string;
+    /**
+     * Returns the address2 of the store.
+     */
+    getAddress2(): string;
+    /**
+     * Returns the city of the store.
+     */
+    getCity(): string;
+    /**
+     * Returns the countryCode of the store.
+     */
+    getCountryCode(): EnumValue;
+    /**
+     * Returns the email of the store.
+     */
+    getEmail(): string;
+    /**
+     * Returns the fax of the store.
+     */
+    getFax(): string;
+    /**
+     * Returns the ID of the store.
+     */
+    getID(): string;
+    /**
+     * Returns the store image.
+     */
+    getImage(): MediaFile;
+    /**
+     * Returns the inventory list the store is associated with. If the
+     * store is not associated with a inventory list, or the inventory list does not
+     * exist, the method returns null.
+     */
+    getInventoryList(): ProductInventoryList | null;
+    /**
+     * Returns the inventory list id the store is associated with. If the
+     * store is not associated with a inventory list, or the inventory list does not
+     * exist, the method returns null.
+     */
+    getInventoryListID(): string;
+    /**
+     * Returns the latitude of the store.
+     */
+    getLatitude(): number;
+    /**
+     * Returns the longitude of the store.
+     */
+    getLongitude(): number;
+    /**
+     * Returns the name of the store.
+     */
+    getName(): string;
+    /**
+     * Returns the phone of the store.
+     */
+    getPhone(): string;
+    /**
+     * Returns the postalCode of the store.
+     */
+    getPostalCode(): string;
+    /**
+     * Returns the stateCode of the store.
+     */
+    getStateCode(): string;
+    /**
+     * Returns the storeEvents of the store.
+     */
+    getStoreEvents(): MarkupText;
+    /**
+     * Returns all the store groups this store belongs to.
+     */
+    getStoreGroups(): Collection<StoreGroup>;
+    /**
+     * Returns the storeHours of the store.
+     */
+    getStoreHours(): MarkupText;
+    /**
+     * Returns the demandwarePosEnabled flag for the store.
+     * Indicates that this store uses Commerce Cloud Store for point-of-sale.
+     * @deprecated Use isPosEnabled instead
+     */
+    isDemandwarePosEnabled(): boolean;
+    /**
+     * Returns the posEnabled flag for the Store.
+     * Indicates that this store uses Commerce Cloud Store for point-of-sale.
+     */
+    isPosEnabled(): boolean;
+    /**
+     * Returns the storeLocatorEnabled flag for the store.
+     */
+    isStoreLocatorEnabled(): boolean;
+}
+
+export = Store;

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

@@ -0,0 +1,44 @@
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+import Collection = require('../util/Collection');
+import Store = require('./Store');
+
+declare global {
+    module ICustomAttributes {
+        interface StoreGroup extends CustomAttributes {
+        }
+    }
+}
+
+/**
+ * Represents a store group. Store groups can be used to group the stores for different marketing purposes.
+ */
+declare class StoreGroup extends ExtensibleObject<ICustomAttributes.StoreGroup> {
+    /**
+     * Returns the ID of the store group.
+     */
+    readonly ID: string;
+    /**
+     * Returns the name of the store group.
+     */
+    readonly name: string;
+    /**
+     * Returns all the stores that are assigned to the store group.
+     */
+    readonly stores: Collection<Store>;
+    private constructor();
+    /**
+     * Returns the ID of the store group.
+     */
+    getID(): string;
+    /**
+     * Returns the name of the store group.
+     */
+    getName(): string;
+    /**
+     * Returns all the stores that are assigned to the store group.
+     */
+    getStores(): Collection<Store>;
+}
+
+export = StoreGroup;

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

@@ -0,0 +1,49 @@
+import List = require('../util/List');
+import StoreInventoryFilterValue = require('./StoreInventoryFilterValue');
+
+/**
+ * 
+ * 
+ * This class represents a store inventory filter, which can be used at
+ * ProductSearchModel.setStoreInventoryFilter to filter the search result by one or more
+ * store inventories. Compared to the default parameter 'ilids' (Inventory List IDs) see
+ * (ProductSearchModel.INVENTORY_LIST_IDS_PARAMETER the store inventory filter allows a customization of the
+ * parameter name and the inventory list ID parameter values for the URL generations via all URLRefine and URLRelax
+ * methods e.g. for ProductSearchModel.urlRefineCategory,
+ * ProductSearchModel.urlRelaxPrice,
+ * SearchModel.urlRefineAttribute.
+ * 
+ * Example custom URL: city=Burlington|Boston
+ * @example
+ * new dw.catalog.StoreInventoryFilter( "city",
+ * new dw.util.ArrayList( new dw.catalog.StoreInventoryFilterValue( "Burlington", "inventory_store_store9" ),
+ * new dw.catalog.StoreInventoryFilterValue( "Boston", "inventory_store_store8" ) ) );
+ */
+declare class StoreInventoryFilter {
+    /**
+     * Returns the semantic URL parameter of this StoreInventoryFilter.
+     */
+    readonly semanticURLParameter: string;
+    /**
+     * Returns a list of StoreInventoryFilterValue instances used by this StoreInventoryFilter.
+     */
+    readonly storeInventoryFilterValues: List<StoreInventoryFilterValue>;
+    /**
+     * Creates a new StoreInventoryFilter instance for the given semantic URL parameter and a list of
+     * StoreInventoryFilterValue instances. The semantic URL parameter e.g. city, zip, store and the semantic
+     * store inventory values from the storeFilterValues will be used for URL generation. The mapped inventory list IDs
+     * from the storeFilterValues will be used for filtering. on the mapped
+     * @throws NullArgumentException in case of missing required parameter.
+     */
+    constructor(semanticURLParameter: string, storeFilterValues: List<any>);
+    /**
+     * Returns the semantic URL parameter of this StoreInventoryFilter.
+     */
+    getSemanticURLParameter(): string;
+    /**
+     * Returns a list of StoreInventoryFilterValue instances used by this StoreInventoryFilter.
+     */
+    getStoreInventoryFilterValues(): List<StoreInventoryFilterValue>;
+}
+
+export = StoreInventoryFilter;

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

@@ -0,0 +1,45 @@
+/**
+ * 
+ * 
+ * This class represents a store inventory filter value, which can be used for a StoreInventoryFilter to filter
+ * the search result by one or more store inventory list IDs via
+ * ProductSearchModel.setStoreInventoryFilter. Compared to
+ * ProductSearchModel.setInventoryListIDs the store inventory filter allows a customization of the
+ * inventory parameter name and the inventory list ID values for URL generations. A StoreInventoryFilterValue provides
+ * the mapping between a semantic value e.g. store1,store2 or Burlington,Boston to the related real inventory list ID.
+ * 
+ * Example custom URL: city=Burlington|Boston
+ * @example
+ * new dw.catalog.StoreInventoryFilter("city",
+ * new dw.util.ArrayList(
+ * new dw.catalog.StoreInventoryFilterValue("Burlington","inventory_store_store9"),
+ * new dw.catalog.StoreInventoryFilterValue("Boston","inventory_store_store8")
+ * ));
+ */
+declare class StoreInventoryFilterValue {
+    /**
+     * Returns the real inventory list ID of this store inventory filter value.
+     */
+    readonly inventoryListID: string;
+    /**
+     * Returns the semantic inventory ID of this store inventory filter value.
+     */
+    readonly semanticInventoryID: string;
+    /**
+     * 
+     * 
+     * Creates a new StoreInventoryFilterValue instance for the semantic inventory ID and real inventory list ID.
+     * @throws NullArgumentException in case of missing required parameter.
+     */
+    constructor(semanticInventoryListID: string, inventoryListID: string);
+    /**
+     * Returns the real inventory list ID of this store inventory filter value.
+     */
+    getInventoryListID(): string;
+    /**
+     * Returns the semantic inventory ID of this store inventory filter value.
+     */
+    getSemanticInventoryID(): string;
+}
+
+export = StoreInventoryFilterValue;

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

@@ -0,0 +1,86 @@
+import Store = require('./Store');
+import LinkedHashMap = require('../util/LinkedHashMap');
+import StoreGroup = require('./StoreGroup');
+import Collection = require('../util/Collection');
+
+/**
+ * Provides helper methods for getting stores based on id and querying for
+ * stores based on geolocation.
+ */
+declare class StoreMgr {
+    /**
+     * Returns all the store groups of the current site.
+     */
+    static readonly allStoreGroups: Collection<StoreGroup>;
+    /**
+     * Get the store id associated with the current session. By default, the session store id is null.
+     */
+    static readonly storeIDFromSession: string | null;
+    private constructor();
+    /**
+     * Returns all the store groups of the current site.
+     */
+    static getAllStoreGroups(): Collection<StoreGroup>;
+    /**
+     * Returns the store object with the specified id or null if store with this
+     * id does not exist in the site.
+     */
+    static getStore(storeID: string): Store | null;
+    /**
+     * Returns the store group with the specified id or null if the store group with this id does not exist in the current site.
+     */
+    static getStoreGroup(storeGroupID: string): StoreGroup | null;
+    /**
+     * Get the store id associated with the current session. By default, the session store id is null.
+     */
+    static getStoreIDFromSession(): string | null;
+    /**
+     * Search for stores based on geo-coordinates. The method returns a list of
+     * stores for the current site that are within a specified distance of a
+     * location on the earth and which optionally satisfy additional filter
+     * criteria. If no additional criteria are specified, then this method
+     * behaves similar to GetNearestStores pipelet. The criteria are specified
+     * as a querystring, using the same syntax as
+     * dw.object.SystemObjectMgr.querySystemObjects
+     * 
+     * The stores and their distance from the specified location are returned as
+     * a LinkedHashMap of Store objects to distances, sorting in ascending order
+     * by distance. The distance is interpreted either in miles or kilometers
+     * depending on the "distanceUnit" parameter.
+     * 
+     * The latitude and longitude of each store is determined by first looking
+     * at dw.catalog.Store.getLatitude and
+     * dw.catalog.Store.getLongitude. If these are not set, then the
+     * system deduces the location of the store by looking for a configured
+     * geolocation matching the store's postal and country codes.
+     */
+    static searchStoresByCoordinates(latitude: number, longitude: number, distanceUnit: string, maxDistance: number, queryString: string, ...args: any[]): LinkedHashMap<any, any>;
+    /**
+     * Convenience method.  Same as searchStoresByCoordinates(latitude, longitude, distanceUnit, maxDistance, null).
+     */
+    static searchStoresByCoordinates(latitude: number, longitude: number, distanceUnit: string, maxDistance: number): LinkedHashMap<any, any>;
+    /**
+     * Search for stores by country/postal code and optionally by additional
+     * filter criteria. This method is analagous to
+     * dw.catalog.StoreMgr.searchStoresByCoordinates
+     * but identifies a location on the earth indirectly using country and
+     * postal code. The method will look first in the saved geolocations of the
+     * system to find a geolocation matching the passed country and postal code.
+     * If none is found, this method will return an empty map. If one is found,
+     * it will use the latitude/longitude of the found geolocation as the center
+     * of the search.
+     */
+    static searchStoresByPostalCode(countryCode: string, postalCode: string, distanceUnit: string, maxDistance: number, queryString: string, ...args: any[]): LinkedHashMap<any, any>;
+    /**
+     * Convenience method.  Same as searchStoresByPostalCode(countryCode, postalCode, distanceUnit, maxDistance, null).
+     */
+    static searchStoresByPostalCode(countryCode: string, postalCode: string, distanceUnit: string, maxDistance: number): LinkedHashMap<any, any>;
+    /**
+     * Set the store id for the current session. The store id is also saved on the cookie with the cookie name
+     * "dw_store" with no expiration time. Null is allowed to remove store id from session, when null is passed in, the
+     * cookie will be removed when browser exits.
+     */
+    static setStoreIDToSession(storeID: string): void;
+}
+
+export = StoreMgr;