sfcc-dev-mcp 1.0.19 → 1.0.21

package/docs/dw_catalog/CategoryAssignment.md

@@ -1,192 +0,0 @@
-## Package: dw.catalog
-
-# Class CategoryAssignment
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.object.PersistentObject
-  - dw.object.ExtensibleObject
-    - dw.catalog.CategoryAssignment
-
-## Description
-
-Represents a category assignment in Commerce Cloud Digital.
-
-## Properties
-
-### calloutMsg
-
-**Type:** MarkupText (Read Only)
-
-The category assignment's callout message in the current locale.
-
-### category
-
-**Type:** Category (Read Only)
-
-The category to which this category assignment is bound.
-
-### image
-
-**Type:** MediaFile (Read Only)
-
-The category assignment's image.
-
-### longDescription
-
-**Type:** MarkupText (Read Only)
-
-The category assignment's long description in the current locale.
-
-### name
-
-**Type:** String (Read Only)
-
-The name of the category assignment in the current locale.
-
-### product
-
-**Type:** Product (Read Only)
-
-The product to which this category assignment is bound.
-
-### shortDescription
-
-**Type:** MarkupText (Read Only)
-
-The category assignment's short description in the current locale.
-
-## Constructor Summary
-
-## Method Summary
-
-### getCalloutMsg
-
-**Signature:** `getCalloutMsg() : MarkupText`
-
-Returns the category assignment's callout message in the current locale.
-
-### getCategory
-
-**Signature:** `getCategory() : Category`
-
-Returns the category to which this category assignment is bound.
-
-### getImage
-
-**Signature:** `getImage() : MediaFile`
-
-Returns the category assignment's image.
-
-### getLongDescription
-
-**Signature:** `getLongDescription() : MarkupText`
-
-Returns the category assignment's long description in the current locale.
-
-### getName
-
-**Signature:** `getName() : String`
-
-Returns the name of the category assignment in the current locale.
-
-### getProduct
-
-**Signature:** `getProduct() : Product`
-
-Returns the product to which this category assignment is bound.
-
-### getShortDescription
-
-**Signature:** `getShortDescription() : MarkupText`
-
-Returns the category assignment's short description in the current locale.
-
-## Method Detail
-
-## Method Details
-
-### getCalloutMsg
-
-**Signature:** `getCalloutMsg() : MarkupText`
-
-**Description:** Returns the category assignment's callout message in the current locale.
-
-**Returns:**
-
-the category assignment's callout message in the current locale, or null if it wasn't found.
-
----
-
-### getCategory
-
-**Signature:** `getCategory() : Category`
-
-**Description:** Returns the category to which this category assignment is bound.
-
-**Returns:**
-
-The category to which this category assignment is bound.
-
----
-
-### getImage
-
-**Signature:** `getImage() : MediaFile`
-
-**Description:** Returns the category assignment's image.
-
-**Returns:**
-
-the category assignment's image.
-
----
-
-### getLongDescription
-
-**Signature:** `getLongDescription() : MarkupText`
-
-**Description:** Returns the category assignment's long description in the current locale.
-
-**Returns:**
-
-The category assignment's long description in the current locale, or null if it wasn't found.
-
----
-
-### getName
-
-**Signature:** `getName() : String`
-
-**Description:** Returns the name of the category assignment in the current locale.
-
-**Returns:**
-
-The name of the category assignment for the current locale, or null if it wasn't found.
-
----
-
-### getProduct
-
-**Signature:** `getProduct() : Product`
-
-**Description:** Returns the product to which this category assignment is bound.
-
-**Returns:**
-
-The product to which this category assignment is bound.
-
----
-
-### getShortDescription
-
-**Signature:** `getShortDescription() : MarkupText`
-
-**Description:** Returns the category assignment's short description in the current locale.
-
-**Returns:**
-
-the category assignment's short description in the current locale, or null if it wasn't found.
-
----

package/docs/dw_catalog/CategoryLink.md

@@ -1,126 +0,0 @@
-## Package: dw.catalog
-
-# Class CategoryLink
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.catalog.CategoryLink
-
-## Description
-
-A CategoryLink represents a directed relationship between two catalog categories. Merchants create category links in order to market similar or related groups of products.
-
-## Constants
-
-### LINKTYPE_ACCESSORY
-
-**Type:** Number = 2
-
-Represents an accessory category link.
-
-### LINKTYPE_CROSS_SELL
-
-**Type:** Number = 4
-
-Represents a cross-sell category link.
-
-### LINKTYPE_OTHER
-
-**Type:** Number = 1
-
-Represents a miscellaneous category link.
-
-### LINKTYPE_SPARE_PART
-
-**Type:** Number = 6
-
-Represents a spare part category link.
-
-### LINKTYPE_UP_SELL
-
-**Type:** Number = 5
-
-Represents an up-sell category link.
-
-## Properties
-
-### sourceCategory
-
-**Type:** Category (Read Only)
-
-The object for the relation 'sourceCategory'.
-
-### targetCategory
-
-**Type:** Category (Read Only)
-
-The object for the relation 'targetCategory'.
-
-### typeCode
-
-**Type:** Number (Read Only)
-
-The type of this category link (see constants).
-
-## Constructor Summary
-
-## Method Summary
-
-### getSourceCategory
-
-**Signature:** `getSourceCategory() : Category`
-
-Returns the object for the relation 'sourceCategory'.
-
-### getTargetCategory
-
-**Signature:** `getTargetCategory() : Category`
-
-Returns the object for the relation 'targetCategory'.
-
-### getTypeCode
-
-**Signature:** `getTypeCode() : Number`
-
-Returns the type of this category link (see constants).
-
-## Method Detail
-
-## Method Details
-
-### getSourceCategory
-
-**Signature:** `getSourceCategory() : Category`
-
-**Description:** Returns the object for the relation 'sourceCategory'.
-
-**Returns:**
-
-the object for the relation 'sourceCategory'
-
----
-
-### getTargetCategory
-
-**Signature:** `getTargetCategory() : Category`
-
-**Description:** Returns the object for the relation 'targetCategory'.
-
-**Returns:**
-
-the object for the relation 'targetCategory'
-
----
-
-### getTypeCode
-
-**Signature:** `getTypeCode() : Number`
-
-**Description:** Returns the type of this category link (see constants).
-
-**Returns:**
-
-the type of the link.
-
----

package/docs/dw_catalog/PriceBook.md

@@ -1,242 +0,0 @@
-## Package: dw.catalog
-
-# Class PriceBook
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.object.PersistentObject
-  - dw.object.ExtensibleObject
-    - dw.catalog.PriceBook
-
-## Description
-
-Represents a price book.
-
-## Properties
-
-### currencyCode
-
-**Type:** String (Read Only)
-
-The currency code of the price book.
-
-### description
-
-**Type:** String (Read Only)
-
-The description of the price book.
-
-### displayName
-
-**Type:** String (Read Only)
-
-The display name of the price book.
-
-### ID
-
-**Type:** String (Read Only)
-
-The ID of the price book.
-
-### online
-
-**Type:** boolean (Read Only)
-
-The online status of the price book. The online status
- is calculated from the online status flag and the onlineFrom
- onlineTo dates defined for the price book.
-
-### onlineFlag
-
-**Type:** boolean (Read Only)
-
-The online status flag of the price book.
-
-### onlineFrom
-
-**Type:** Date (Read Only)
-
-The date from which the price book is online or valid.
-
-### onlineTo
-
-**Type:** Date (Read Only)
-
-The date until which the price book is online or valid.
-
-### parentPriceBook
-
-**Type:** PriceBook (Read Only)
-
-The parent price book.
-
-## Constructor Summary
-
-## Method Summary
-
-### getCurrencyCode
-
-**Signature:** `getCurrencyCode() : String`
-
-Returns the currency code of the price book.
-
-### getDescription
-
-**Signature:** `getDescription() : String`
-
-Returns the description of the price book.
-
-### getDisplayName
-
-**Signature:** `getDisplayName() : String`
-
-Returns the display name of the price book.
-
-### getID
-
-**Signature:** `getID() : String`
-
-Returns the ID of the price book.
-
-### getOnlineFlag
-
-**Signature:** `getOnlineFlag() : boolean`
-
-Returns the online status flag of the price book.
-
-### getOnlineFrom
-
-**Signature:** `getOnlineFrom() : Date`
-
-Returns the date from which the price book is online or valid.
-
-### getOnlineTo
-
-**Signature:** `getOnlineTo() : Date`
-
-Returns the date until which the price book is online or valid.
-
-### getParentPriceBook
-
-**Signature:** `getParentPriceBook() : PriceBook`
-
-Returns the parent price book.
-
-### isOnline
-
-**Signature:** `isOnline() : boolean`
-
-Returns the online status of the price book.
-
-## Method Detail
-
-## Method Details
-
-### getCurrencyCode
-
-**Signature:** `getCurrencyCode() : String`
-
-**Description:** Returns the currency code of the price book.
-
-**Returns:**
-
-Currency code of the price book
-
----
-
-### getDescription
-
-**Signature:** `getDescription() : String`
-
-**Description:** Returns the description of the price book.
-
-**Returns:**
-
-Currency code of the price book
-
----
-
-### getDisplayName
-
-**Signature:** `getDisplayName() : String`
-
-**Description:** Returns the display name of the price book.
-
-**Returns:**
-
-Display name of the price book
-
----
-
-### getID
-
-**Signature:** `getID() : String`
-
-**Description:** Returns the ID of the price book.
-
-**Returns:**
-
-ID of the price book
-
----
-
-### getOnlineFlag
-
-**Signature:** `getOnlineFlag() : boolean`
-
-**Description:** Returns the online status flag of the price book.
-
-**Returns:**
-
-the online status flag of the price book.
-
----
-
-### getOnlineFrom
-
-**Signature:** `getOnlineFrom() : Date`
-
-**Description:** Returns the date from which the price book is online or valid.
-
-**Returns:**
-
-the date from which the price book is online or valid.
-
----
-
-### getOnlineTo
-
-**Signature:** `getOnlineTo() : Date`
-
-**Description:** Returns the date until which the price book is online or valid.
-
-**Returns:**
-
-the date until which the price book is online or valid.
-
----
-
-### getParentPriceBook
-
-**Signature:** `getParentPriceBook() : PriceBook`
-
-**Description:** Returns the parent price book.
-
-**Returns:**
-
-Parent price book
-
----
-
-### isOnline
-
-**Signature:** `isOnline() : boolean`
-
-**Description:** Returns the online status of the price book. The online status is calculated from the online status flag and the onlineFrom onlineTo dates defined for the price book.
-
-**Returns:**
-
-The online status of the price book.
-
----