sfcc-dev-mcp 1.0.0

package/docs/dw_catalog/CategoryAssignment.md

@@ -0,0 +1,192 @@
+## 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

@@ -0,0 +1,96 @@
+## 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
+
+## 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

@@ -0,0 +1,242 @@
+## 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.
+
+---

package/docs/dw_catalog/PriceBookMgr.md

@@ -0,0 +1,205 @@
+## Package: dw.catalog
+
+# Class PriceBookMgr
+
+## Inheritance Hierarchy
+
+- Object
+  - dw.catalog.PriceBookMgr
+
+## Description
+
+Price book manager provides methods to access price books.
+
+## Properties
+
+### allPriceBooks
+
+**Type:** Collection (Read Only)
+
+All price books defined for the organization.
+
+### applicablePriceBooks
+
+**Type:** Collection
+
+A collection of price books that are set in the user session.
+
+### sitePriceBooks
+
+**Type:** Collection (Read Only)
+
+All price books assigned to the current site. 
+
+ Please note that this doesn't include parent price books not assigned
+ to the site, but considered by the price lookup.
+
+## Constructor Summary
+
+## Method Summary
+
+### assignPriceBookToSite
+
+**Signature:** `static assignPriceBookToSite(priceBook : PriceBook, siteId : String) : boolean`
+
+Assign a price book to a site.
+
+### getAllPriceBooks
+
+**Signature:** `static getAllPriceBooks() : Collection`
+
+Returns all price books defined for the organization.
+
+### getApplicablePriceBooks
+
+**Signature:** `static getApplicablePriceBooks() : Collection`
+
+Returns a collection of price books that are set in the user session.
+
+### getPriceBook
+
+**Signature:** `static getPriceBook(priceBookID : String) : PriceBook`
+
+Returns the price book of the current organization matching the specified ID.
+
+### getSitePriceBooks
+
+**Signature:** `static getSitePriceBooks() : Collection`
+
+Returns all price books assigned to the current site.
+
+### setApplicablePriceBooks
+
+**Signature:** `static setApplicablePriceBooks(priceBooks : PriceBook...) : void`
+
+Sets one or more price books to be considered by the product price lookup.
+
+### unassignPriceBookFromAllSites
+
+**Signature:** `static unassignPriceBookFromAllSites(priceBook : PriceBook) : boolean`
+
+Unassign a price book from all sites.
+
+### unassignPriceBookFromSite
+
+**Signature:** `static unassignPriceBookFromSite(priceBook : PriceBook, siteId : String) : boolean`
+
+Unassign a price book from a site.
+
+## Method Detail
+
+## Method Details
+
+### assignPriceBookToSite
+
+**Signature:** `static assignPriceBookToSite(priceBook : PriceBook, siteId : String) : boolean`
+
+**Description:** Assign a price book to a site. This requires a transaction, see Transaction.wrap(Function)
+
+**Parameters:**
+
+- `priceBook`: price book to be assigned
+- `siteId`: id of the site to be assigned to, such as 'SiteGenesis'. The site has to be a storefront site.
+
+**Returns:**
+
+true if price book is assigned to site. Throws an exception if price book doesn't exist or site doesn't exist or site is not a storefront site.
+
+---
+
+### getAllPriceBooks
+
+**Signature:** `static getAllPriceBooks() : Collection`
+
+**Description:** Returns all price books defined for the organization.
+
+**Returns:**
+
+All price books of the organization.
+
+---
+
+### getApplicablePriceBooks
+
+**Signature:** `static getApplicablePriceBooks() : Collection`
+
+**Description:** Returns a collection of price books that are set in the user session.
+
+**Returns:**
+
+Collection of applicable price books set in the session.
+
+---
+
+### getPriceBook
+
+**Signature:** `static getPriceBook(priceBookID : String) : PriceBook`
+
+**Description:** Returns the price book of the current organization matching the specified ID.
+
+**Parameters:**
+
+- `priceBookID`: The price book id.
+
+**Returns:**
+
+Price book or null of not found
+
+---
+
+### getSitePriceBooks
+
+**Signature:** `static getSitePriceBooks() : Collection`
+
+**Description:** Returns all price books assigned to the current site. Please note that this doesn't include parent price books not assigned to the site, but considered by the price lookup.
+
+**Returns:**
+
+All price books assigned to the current site.
+
+---
+
+### setApplicablePriceBooks
+
+**Signature:** `static setApplicablePriceBooks(priceBooks : PriceBook...) : void`
+
+**Description:** Sets one or more price books to be considered by the product price lookup. The information is stored in the user session. If no price book is set in the user session, all active and valid price books assigned to the site are used for the price lookup. If price books are set, only those price books are considered by the price lookup. Note that the system does not assure that a price book set by this API is assigned to the current site.
+
+**Parameters:**
+
+- `priceBooks`: The price books that are set in the session as applicable price books.
+
+---
+
+### unassignPriceBookFromAllSites
+
+**Signature:** `static unassignPriceBookFromAllSites(priceBook : PriceBook) : boolean`
+
+**Description:** Unassign a price book from all sites. This requires a transaction, see Transaction.wrap(Function)
+
+**Parameters:**
+
+- `priceBook`: price book to be unassigned
+
+**Returns:**
+
+true if price book is unassigned from all sites. Throws an exception if price book doesn't exist
+
+---
+
+### unassignPriceBookFromSite
+
+**Signature:** `static unassignPriceBookFromSite(priceBook : PriceBook, siteId : String) : boolean`
+
+**Description:** Unassign a price book from a site. This requires a transaction, see Transaction.wrap(Function)
+
+**Parameters:**
+
+- `priceBook`: price book to be unassigned
+- `siteId`: id of the site to be unassigned from, such as 'SiteGenesis'. The site has to be a storefront site.
+
+**Returns:**
+
+true if price book is unassigned from site. Throws an exception if price book doesn't exist or site doesn't exist or site is not a storefront site.
+
+---