sfcc-dev-mcp 1.0.19 → 1.0.21

package/docs/dw_campaign/SourceCodeStatusCodes.md

@@ -1,36 +0,0 @@
-## Package: dw.campaign
-
-# Class SourceCodeStatusCodes
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.campaign.SourceCodeStatusCodes
-
-## Description
-
-Helper class which contains error result codes returned by the SetSourceCode pipelet.
-
-## Constants
-
-### CODE_INACTIVE
-
-**Type:** String = "CODE_INACTIVE"
-
-Indicates that the specified source code was found in one or more source-code groups, none of which are active.
-
-### CODE_INVALID
-
-**Type:** String = "CODE_INVALID"
-
-Indicates that the specified source code is not contained in any source-code group.
-
-## Properties
-
-## Constructor Summary
-
-SourceCodeStatusCodes()
-
-## Method Summary
-
-## Constructor Detail

package/docs/dw_campaign/TotalFixedPriceDiscount.md

@@ -1,47 +0,0 @@
-## Package: dw.campaign
-
-# Class TotalFixedPriceDiscount
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.campaign.Discount
-  - dw.campaign.TotalFixedPriceDiscount
-
-## Description
-
-Represents a total fix price discount on a group of products in the discount plan. For example: "buy 3 products of type X for a total price of $29.99".
-
-## Properties
-
-### totalFixedPrice
-
-**Type:** Number (Read Only)
-
-The total fixed price amount.
-
-## Constructor Summary
-
-## Method Summary
-
-### getTotalFixedPrice
-
-**Signature:** `getTotalFixedPrice() : Number`
-
-Returns the total fixed price amount.
-
-## Method Detail
-
-## Method Details
-
-### getTotalFixedPrice
-
-**Signature:** `getTotalFixedPrice() : Number`
-
-**Description:** Returns the total fixed price amount.
-
-**Returns:**
-
-Total fixed price amount
-
----

package/docs/dw_catalog/Catalog.md

@@ -1,122 +0,0 @@
-## Package: dw.catalog
-
-# Class Catalog
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.object.PersistentObject
-  - dw.object.ExtensibleObject
-    - dw.catalog.Catalog
-
-## Description
-
-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 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.
-
-## Properties
-
-### description
-
-**Type:** String (Read Only)
-
-The value of the localized extensible object attribute
- "shortDescription" for the current locale.
-
-### displayName
-
-**Type:** String (Read Only)
-
-The value of the localized extensible object attribute
- "displayName" for the current locale.
-
-### ID
-
-**Type:** String (Read Only)
-
-The value of attribute 'id'.
-
-### root
-
-**Type:** Category (Read Only)
-
-The object for the relation 'root'.
-
-## Constructor Summary
-
-## Method Summary
-
-### getDescription
-
-**Signature:** `getDescription() : String`
-
-Returns the value of the localized extensible object attribute "shortDescription" for the current locale.
-
-### getDisplayName
-
-**Signature:** `getDisplayName() : String`
-
-Returns the value of the localized extensible object attribute "displayName" for the current locale.
-
-### getID
-
-**Signature:** `getID() : String`
-
-Returns the value of attribute 'id'.
-
-### getRoot
-
-**Signature:** `getRoot() : Category`
-
-Returns the object for the relation 'root'.
-
-## Method Detail
-
-## Method Details
-
-### getDescription
-
-**Signature:** `getDescription() : String`
-
-**Description:** Returns the value of the localized extensible object attribute "shortDescription" for the current locale.
-
-**Returns:**
-
-The value of the attribute for the current locale, or null if it wasn't found.
-
----
-
-### getDisplayName
-
-**Signature:** `getDisplayName() : String`
-
-**Description:** Returns the value of the localized extensible object attribute "displayName" for the current locale.
-
-**Returns:**
-
-The value of the attribute for the current locale, or null if it wasn't found.
-
----
-
-### getID
-
-**Signature:** `getID() : String`
-
-**Description:** Returns the value of attribute 'id'.
-
-**Returns:**
-
-the value of the attribute 'id'
-
----
-
-### getRoot
-
-**Signature:** `getRoot() : Category`
-
-**Description:** Returns the object for the relation 'root'.
-
-**Returns:**
-
-the object for the relation 'root'.
-
----

package/docs/dw_catalog/CatalogMgr.md

@@ -1,182 +0,0 @@
-## Package: dw.catalog
-
-# Class CatalogMgr
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.catalog.CatalogMgr
-
-## Description
-
-Provides helper methods for getting categories.
-
-## Properties
-
-### siteCatalog
-
-**Type:** Catalog (Read Only)
-
-The catalog of the current site or null if no catalog is assigned to the site.
-
-### sortingOptions
-
-**Type:** List (Read Only)
-
-A list containing the sorting options configured for this site.
-
-### sortingRules
-
-**Type:** Collection (Read Only)
-
-A collection containing all of the sorting rules for this site, including global sorting rules.
-
-## Constructor Summary
-
-## Method Summary
-
-### getCatalog
-
-**Signature:** `static getCatalog(id : String) : Catalog`
-
-Returns the catalog identified by the specified catalog id.
-
-### getCategory
-
-**Signature:** `static getCategory(id : String) : Category`
-
-Returns the category of the site catalog identified by the specified category id.
-
-### getSiteCatalog
-
-**Signature:** `static getSiteCatalog() : Catalog`
-
-Returns the catalog of the current site or null if no catalog is assigned to the site.
-
-### getSortingOption
-
-**Signature:** `static getSortingOption(id : String) : SortingOption`
-
-Returns the sorting option with the given ID for this site, or null if there is no such option.
-
-### getSortingOptions
-
-**Signature:** `static getSortingOptions() : List`
-
-Returns a list containing the sorting options configured for this site.
-
-### getSortingRule
-
-**Signature:** `static getSortingRule(id : String) : SortingRule`
-
-Returns the sorting rule with the given ID for this site, or null if there is no such rule.
-
-### getSortingRules
-
-**Signature:** `static getSortingRules() : Collection`
-
-Returns a collection containing all of the sorting rules for this site, including global sorting rules.
-
-## Method Detail
-
-## Method Details
-
-### getCatalog
-
-**Signature:** `static getCatalog(id : String) : Catalog`
-
-**Description:** Returns the catalog identified by the specified catalog id. Returns null if no catalog with the specified id exists in the current organization context.
-
-**Parameters:**
-
-- `id`: Catalog id
-
-**Returns:**
-
-the catalog or null.
-
----
-
-### getCategory
-
-**Signature:** `static getCategory(id : String) : Category`
-
-**Description:** 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.
-
-**Parameters:**
-
-- `id`: the category identifier.
-
-**Returns:**
-
-the category of the site catalog identified by the specified category id or null if no site catalog is found.
-
----
-
-### getSiteCatalog
-
-**Signature:** `static getSiteCatalog() : Catalog`
-
-**Description:** Returns the catalog of the current site or null if no catalog is assigned to the site.
-
-**Returns:**
-
-the catalog of the current site or null.
-
----
-
-### getSortingOption
-
-**Signature:** `static getSortingOption(id : String) : SortingOption`
-
-**Description:** Returns the sorting option with the given ID for this site, or null if there is no such option.
-
-**Parameters:**
-
-- `id`: the ID of the sorting option
-
-**Returns:**
-
-a SortingOption or null.
-
----
-
-### getSortingOptions
-
-**Signature:** `static getSortingOptions() : List`
-
-**Description:** Returns a list containing the sorting options configured for this site.
-
-**Returns:**
-
-a list of SortingOption objects
-
----
-
-### getSortingRule
-
-**Signature:** `static getSortingRule(id : String) : SortingRule`
-
-**Description:** Returns the sorting rule with the given ID for this site, or null if there is no such rule.
-
-**Parameters:**
-
-- `id`: the ID of the sorting rule
-
-**Returns:**
-
-a SortingRule or null.
-
----
-
-### getSortingRules
-
-**Signature:** `static getSortingRules() : Collection`
-
-**Description:** Returns a collection containing all of the sorting rules for this site, including global sorting rules.
-
-**Returns:**
-
-a collection of SortingRule objects
-
----