@salesforce/b2c-cli 1.10.0 → 1.12.0

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/campaign/index.d.ts

@@ -0,0 +1,65 @@
+import ABTest = require('./ABTest');
+import ABTestMgr = require('./ABTestMgr');
+import ABTestSegment = require('./ABTestSegment');
+import AmountDiscount = require('./AmountDiscount');
+import ApproachingDiscount = require('./ApproachingDiscount');
+import BonusChoiceDiscount = require('./BonusChoiceDiscount');
+import BonusDiscount = require('./BonusDiscount');
+import Campaign = require('./Campaign');
+import CampaignMgr = require('./CampaignMgr');
+import CampaignStatusCodes = require('./CampaignStatusCodes');
+import Coupon = require('./Coupon');
+import CouponMgr = require('./CouponMgr');
+import CouponRedemption = require('./CouponRedemption');
+import CouponStatusCodes = require('./CouponStatusCodes');
+import Discount = require('./Discount');
+import DiscountPlan = require('./DiscountPlan');
+import FixedPriceDiscount = require('./FixedPriceDiscount');
+import FixedPriceShippingDiscount = require('./FixedPriceShippingDiscount');
+import FreeDiscount = require('./FreeDiscount');
+import FreeShippingDiscount = require('./FreeShippingDiscount');
+import PercentageDiscount = require('./PercentageDiscount');
+import PercentageOptionDiscount = require('./PercentageOptionDiscount');
+import PriceBookPriceDiscount = require('./PriceBookPriceDiscount');
+import Promotion = require('./Promotion');
+import PromotionMgr = require('./PromotionMgr');
+import PromotionPlan = require('./PromotionPlan');
+import SlotContent = require('./SlotContent');
+import SourceCodeGroup = require('./SourceCodeGroup');
+import SourceCodeInfo = require('./SourceCodeInfo');
+import SourceCodeStatusCodes = require('./SourceCodeStatusCodes');
+import TotalFixedPriceDiscount = require('./TotalFixedPriceDiscount');
+
+export {
+    ABTest,
+    ABTestMgr,
+    ABTestSegment,
+    AmountDiscount,
+    ApproachingDiscount,
+    BonusChoiceDiscount,
+    BonusDiscount,
+    Campaign,
+    CampaignMgr,
+    CampaignStatusCodes,
+    Coupon,
+    CouponMgr,
+    CouponRedemption,
+    CouponStatusCodes,
+    Discount,
+    DiscountPlan,
+    FixedPriceDiscount,
+    FixedPriceShippingDiscount,
+    FreeDiscount,
+    FreeShippingDiscount,
+    PercentageDiscount,
+    PercentageOptionDiscount,
+    PriceBookPriceDiscount,
+    Promotion,
+    PromotionMgr,
+    PromotionPlan,
+    SlotContent,
+    SourceCodeGroup,
+    SourceCodeInfo,
+    SourceCodeStatusCodes,
+    TotalFixedPriceDiscount
+};

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

@@ -0,0 +1,84 @@
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+import Category = require('./Category');
+
+declare global {
+    module ICustomAttributes {
+        interface Catalog extends CustomAttributes {
+        }
+    }
+}
+
+/**
+ * Represents a Commerce Cloud Digital Catalog. Catalogs are containers of products
+ * and other product-related information and can be shared between sites. Every
+ * product in the system is contained in (or "owned by") exactly one catalog.
+ * Every site has a single "site catalog" which defines the products that are
+ * available to purchase on that site. The static method
+ * dw.catalog.CatalogMgr.getSiteCatalog returns the site catalog for
+ * the current site.
+ * 
+ * Catalogs are organized into a tree of categories with a single top-level root
+ * category. Products are assigned to categories within catalogs. They can be
+ * assigned to categories in their owning catalog, or other catalogs. They can
+ * be assigned to multiple categories within the same catalog. Products that are
+ * not assigned to any categories are considered "uncategorized." A product has
+ * a single "classification category" in some catalog, and one
+ * "primary category" per catalog. The classification category defines the
+ * attribute set of the product. The primary category is used as standard
+ * presentation context within that catalog in the storefront.
+ * 
+ * While Commerce Cloud Digital does not currently distinguish different
+ * catalog types, it is common practice to have two general types of catalog:
+ * 
+ * - "Product catalogs" typically contain detailed product information and are
+ * frequently generated from some backend PIM system.
+ * - "Site Catalogs" define the category structure of the storefront and
+ * contain primarily the assignments of these categories to the products defined
+ * in the product catalogs. The site catalog is assigned to the site.
+ * 
+ * In addition to products and categories, catalogs contain recommendations,
+ * shared variation attributes which can be used by multiple master products,
+ * and shared product options which can be used by multiple option products.
+ */
+declare class Catalog extends ExtensibleObject<ICustomAttributes.Catalog> {
+    /**
+     * Returns the value of attribute 'id'.
+     */
+    readonly ID: string;
+    /**
+     * Returns the value of the localized extensible object attribute
+     * "shortDescription" for the current locale.
+     */
+    readonly description: string | null;
+    /**
+     * Returns the value of the localized extensible object attribute
+     * "displayName" for the current locale.
+     */
+    readonly displayName: string | null;
+    /**
+     * Returns the object for the relation 'root'.
+     */
+    readonly root: Category;
+    private constructor();
+    /**
+     * Returns the value of the localized extensible object attribute
+     * "shortDescription" for the current locale.
+     */
+    getDescription(): string | null;
+    /**
+     * Returns the value of the localized extensible object attribute
+     * "displayName" for the current locale.
+     */
+    getDisplayName(): string | null;
+    /**
+     * Returns the value of attribute 'id'.
+     */
+    getID(): string;
+    /**
+     * Returns the object for the relation 'root'.
+     */
+    getRoot(): Category;
+}
+
+export = Catalog;

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

@@ -0,0 +1,61 @@
+import Catalog = require('./Catalog');
+import Category = require('./Category');
+import Collection = require('../util/Collection');
+import SortingRule = require('./SortingRule');
+import List = require('../util/List');
+import SortingOption = require('./SortingOption');
+
+/**
+ * Provides helper methods for getting categories.
+ */
+declare class CatalogMgr {
+    /**
+     * Returns the catalog of the current site or null if no catalog is assigned to the site.
+     */
+    static readonly siteCatalog: Catalog | null;
+    /**
+     * Returns a list containing the sorting options configured for this site.
+     */
+    static readonly sortingOptions: List<SortingOption>;
+    /**
+     * Returns a collection containing all of the sorting rules for this site, including global sorting rules.
+     */
+    static readonly sortingRules: Collection<SortingRule>;
+    private constructor();
+    /**
+     * Returns the catalog identified by the specified catalog id.
+     * Returns null if no catalog with the specified id exists in the
+     * current organization context.
+     */
+    static getCatalog(id: string): Catalog | null;
+    /**
+     * Returns the category of the site catalog identified by the specified
+     * category id. Returns null if no site catalog is defined, or no category
+     * with the specified id is found in the site catalog.
+     */
+    static getCategory(id: string): Category | null;
+    /**
+     * Returns the catalog of the current site or null if no catalog is assigned to the site.
+     */
+    static getSiteCatalog(): Catalog | null;
+    /**
+     * Returns the sorting option with the given ID for this site, or
+     * `null` if there is no such option.
+     */
+    static getSortingOption(id: string): SortingOption | null;
+    /**
+     * Returns a list containing the sorting options configured for this site.
+     */
+    static getSortingOptions(): List<SortingOption>;
+    /**
+     * Returns the sorting rule with the given ID for this site,
+     * or `null` if there is no such rule.
+     */
+    static getSortingRule(id: string): SortingRule | null;
+    /**
+     * Returns a collection containing all of the sorting rules for this site, including global sorting rules.
+     */
+    static getSortingRules(): Collection<SortingRule>;
+}
+
+export = CatalogMgr;