@salesforce/b2c-tooling-sdk 0.0.1 → 0.0.2

package/data/script-api/dw.catalog.md

@@ -0,0 +1,50 @@
+# Package dw.catalog
+
+## Classes
+| Class | Description |
+| --- | --- |
+| [Catalog](dw.catalog.Catalog.md) | Represents a Commerce Cloud Digital Catalog. |
+| [CatalogMgr](dw.catalog.CatalogMgr.md) | Provides helper methods for getting categories. |
+| [Category](dw.catalog.Category.md) | Represents a category in a product catalog. |
+| [CategoryAssignment](dw.catalog.CategoryAssignment.md) | Represents a category assignment in Commerce Cloud Digital. |
+| [CategoryLink](dw.catalog.CategoryLink.md) | A CategoryLink represents a directed relationship between two catalog  categories. |
+| [PriceBook](dw.catalog.PriceBook.md) | Represents a price book. |
+| [PriceBookMgr](dw.catalog.PriceBookMgr.md) | Price book manager provides methods to access price books. |
+| [Product](dw.catalog.Product.md) | Represents a product in Commerce Cloud Digital. |
+| [ProductActiveData](dw.catalog.ProductActiveData.md) | Represents the active data for a [Product](dw.catalog.Product.md) in Commerce Cloud Digital. |
+| [ProductAttributeModel](dw.catalog.ProductAttributeModel.md) | Class representing the complete attribute model for products in the system. |
+| [ProductAvailabilityLevels](dw.catalog.ProductAvailabilityLevels.md) | Encapsulates the quantity of items available for each availability status. |
+| [ProductAvailabilityModel](dw.catalog.ProductAvailabilityModel.md) | The ProductAvailabilityModel provides methods for retrieving all information  on availability of a single product. |
+| [ProductInventoryList](dw.catalog.ProductInventoryList.md) | The ProductInventoryList provides access to ID, description and defaultInStockFlag of the list. |
+| [ProductInventoryMgr](dw.catalog.ProductInventoryMgr.md) | This manager provides access to inventory-related objects. |
+| [ProductInventoryRecord](dw.catalog.ProductInventoryRecord.md) | The ProductInventoryRecord holds information about a Product's inventory, and availability. |
+| [ProductLink](dw.catalog.ProductLink.md) | The class represents a link between two products. |
+| [ProductMgr](dw.catalog.ProductMgr.md) | Provides helper methods for getting products based on Product ID or [Catalog](dw.catalog.Catalog.md). |
+| [ProductOption](dw.catalog.ProductOption.md) | Represents a product option. |
+| [ProductOptionModel](dw.catalog.ProductOptionModel.md) | This class represents the option model of a specific product and  for a specific currency. |
+| [ProductOptionValue](dw.catalog.ProductOptionValue.md) | Represents the value of a product option. |
+| [ProductPriceInfo](dw.catalog.ProductPriceInfo.md) | Simple class representing a product price point. |
+| [ProductPriceModel](dw.catalog.ProductPriceModel.md) | ProductPriceModel provides methods to access all the  [PriceBook](dw.catalog.PriceBook.md) information of a product. |
+| [ProductPriceTable](dw.catalog.ProductPriceTable.md) | A ProductPriceTable is a map of quantities to prices representing the  potentially tiered prices of a product in Commerce Cloud Digital. |
+| [ProductSearchHit](dw.catalog.ProductSearchHit.md) | ProductSearchHit is the result of a executed search query and wraps the actual product found by the search. |
+| [ProductSearchModel](dw.catalog.ProductSearchModel.md) | The class is the central interface to a product search result and a product  search refinement. |
+| [ProductSearchRefinementDefinition](dw.catalog.ProductSearchRefinementDefinition.md) | This class provides an interface to refinement options for the product search. |
+| [ProductSearchRefinements](dw.catalog.ProductSearchRefinements.md) | This class provides an interface to refinement options for the product  search. |
+| [ProductSearchRefinementValue](dw.catalog.ProductSearchRefinementValue.md) | Represents the value of a product search refinement. |
+| [ProductVariationAttribute](dw.catalog.ProductVariationAttribute.md) | Represents a product variation attribute |
+| [ProductVariationAttributeValue](dw.catalog.ProductVariationAttributeValue.md) | Represents a product variation attribute |
+| [ProductVariationModel](dw.catalog.ProductVariationModel.md) | Class representing the complete variation information for a master product in  the system. |
+| [Recommendation](dw.catalog.Recommendation.md) | Represents a recommendation in Commerce Cloud Digital. |
+| [SearchModel](dw.catalog.SearchModel.md) | Common search model base class. |
+| [SearchRefinementDefinition](dw.catalog.SearchRefinementDefinition.md) | Common search refinement definition base class. |
+| [SearchRefinements](dw.catalog.SearchRefinements.md) | Common search refinements base class. |
+| [SearchRefinementValue](dw.catalog.SearchRefinementValue.md) | Represents the value of a product or content search refinement. |
+| [SortingOption](dw.catalog.SortingOption.md) | Represents an option for how to sort products in storefront search results. |
+| [SortingRule](dw.catalog.SortingRule.md) | Represents a product sorting rule for use with the [ProductSearchModel](dw.catalog.ProductSearchModel.md). |
+| [Store](dw.catalog.Store.md) | Represents a store in Commerce Cloud Digital. |
+| [StoreGroup](dw.catalog.StoreGroup.md) | Represents a store group. |
+| [StoreInventoryFilter](dw.catalog.StoreInventoryFilter.md) | <p>  This class represents a store inventory filter, which can be used at  [ProductSearchModel.setStoreInventoryFilter(StoreInventoryFilter)](dw.catalog.ProductSearchModel.md#setstoreinventoryfilterstoreinventoryfilter) to filter the search result by one or more  store inventories. |
+| [StoreInventoryFilterValue](dw.catalog.StoreInventoryFilterValue.md) | <p>  This class represents a store inventory filter value, which can be used for a [StoreInventoryFilter](dw.catalog.StoreInventoryFilter.md) to filter  the search result by one or more store inventory list IDs via  [ProductSearchModel.setStoreInventoryFilter(StoreInventoryFilter)](dw.catalog.ProductSearchModel.md#setstoreinventoryfilterstoreinventoryfilter). |
+| [StoreMgr](dw.catalog.StoreMgr.md) | Provides helper methods for getting stores based on id and querying for  stores based on geolocation. |
+| [Variant](dw.catalog.Variant.md) | Represents a variant of a product variation. |
+| [VariationGroup](dw.catalog.VariationGroup.md) | Class representing a group of variants within a master product who share a  common value for one or more variation attribute values. |

package/data/script-api/dw.content.Content.md

@@ -0,0 +1,481 @@
+<!-- prettier-ignore-start -->
+# Class Content
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.object.PersistentObject](dw.object.PersistentObject.md)
+    - [dw.object.ExtensibleObject](dw.object.ExtensibleObject.md)
+      - [dw.content.Content](dw.content.Content.md)
+
+Class representing a Content asset in Commerce Cloud Digital.
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [ID](#id): [String](TopLevel.String.md) `(read-only)` | Returns the ID of the content asset. |
+| [classificationFolder](#classificationfolder): [Folder](dw.content.Folder.md) `(read-only)` | Returns the Folder associated with this Content. |
+| [description](#description): [String](TopLevel.String.md) `(read-only)` | Returns the description in the current locale or null. |
+| [folders](#folders): [Collection](dw.util.Collection.md) `(read-only)` | Returns all folders to which this content is assigned. |
+| [name](#name): [String](TopLevel.String.md) `(read-only)` | Returns the name of the content asset. |
+| [online](#online): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns the online status of the content. |
+| [onlineFlag](#onlineflag): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns the online status flag of the content. |
+| [page](#page): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns if the content is a [Page](dw.experience.Page.md) or not. |
+| [pageDescription](#pagedescription): [String](TopLevel.String.md) `(read-only)` | Returns the page description for the content in the current locale  or null if there is no page description. |
+| [pageKeywords](#pagekeywords): [String](TopLevel.String.md) `(read-only)` | Returns the page keywords for the content in the current locale  or null if there is no page title. |
+| [pageMetaTags](#pagemetatags): [Array](TopLevel.Array.md) `(read-only)` | Returns all page meta tags, defined for this instance for which content can be generated. |
+| [pageTitle](#pagetitle): [String](TopLevel.String.md) `(read-only)` | Returns the page title for the content in the current locale  or null if there is no page title. |
+| [pageURL](#pageurl): [String](TopLevel.String.md) `(read-only)` | Returns the page URL for the content in the current locale  or null if there is no page URL. |
+| [searchable](#searchable): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns the search status of the content. |
+| [searchableFlag](#searchableflag): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns the online status flag of the content. |
+| [siteMapChangeFrequency](#sitemapchangefrequency): [String](TopLevel.String.md) `(read-only)` | Returns the contents change frequency needed for the sitemap creation. |
+| [siteMapIncluded](#sitemapincluded): [Number](TopLevel.Number.md) `(read-only)` | Returns the status if the content is included into the sitemap. |
+| [siteMapPriority](#sitemappriority): [Number](TopLevel.Number.md) `(read-only)` | Returns the contents priority needed for the sitemap creation. |
+| [template](#template): [String](TopLevel.String.md) `(read-only)` | Returns the value of attribute 'template'. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getClassificationFolder](dw.content.Content.md#getclassificationfolder)() | Returns the Folder associated with this Content. |
+| [getDescription](dw.content.Content.md#getdescription)() | Returns the description in the current locale or null. |
+| [getFolders](dw.content.Content.md#getfolders)() | Returns all folders to which this content is assigned. |
+| [getID](dw.content.Content.md#getid)() | Returns the ID of the content asset. |
+| [getName](dw.content.Content.md#getname)() | Returns the name of the content asset. |
+| [getOnlineFlag](dw.content.Content.md#getonlineflag)() | Returns the online status flag of the content. |
+| [getPageDescription](dw.content.Content.md#getpagedescription)() | Returns the page description for the content in the current locale  or null if there is no page description. |
+| [getPageKeywords](dw.content.Content.md#getpagekeywords)() | Returns the page keywords for the content in the current locale  or null if there is no page title. |
+| [getPageMetaTag](dw.content.Content.md#getpagemetatagstring)([String](TopLevel.String.md)) | Returns the page meta tag for the specified id. |
+| [getPageMetaTags](dw.content.Content.md#getpagemetatags)() | Returns all page meta tags, defined for this instance for which content can be generated. |
+| [getPageTitle](dw.content.Content.md#getpagetitle)() | Returns the page title for the content in the current locale  or null if there is no page title. |
+| [getPageURL](dw.content.Content.md#getpageurl)() | Returns the page URL for the content in the current locale  or null if there is no page URL. |
+| [getSearchableFlag](dw.content.Content.md#getsearchableflag)() | Returns the online status flag of the content. |
+| [getSiteMapChangeFrequency](dw.content.Content.md#getsitemapchangefrequency)() | Returns the contents change frequency needed for the sitemap creation. |
+| [getSiteMapIncluded](dw.content.Content.md#getsitemapincluded)() | Returns the status if the content is included into the sitemap. |
+| [getSiteMapPriority](dw.content.Content.md#getsitemappriority)() | Returns the contents priority needed for the sitemap creation. |
+| [getTemplate](dw.content.Content.md#gettemplate)() | Returns the value of attribute 'template'. |
+| [isOnline](dw.content.Content.md#isonline)() | Returns the online status of the content. |
+| [isPage](dw.content.Content.md#ispage)() | Returns if the content is a [Page](dw.experience.Page.md) or not. |
+| [isSearchable](dw.content.Content.md#issearchable)() | Returns the search status of the content. |
+| [toPage](dw.content.Content.md#topage)() | Converts the content into the [Page](dw.experience.Page.md) representation if [isPage()](dw.content.Content.md#ispage) yields true. |
+
+### Methods inherited from class ExtensibleObject
+
+[describe](dw.object.ExtensibleObject.md#describe), [getCustom](dw.object.ExtensibleObject.md#getcustom)
+### Methods inherited from class PersistentObject
+
+[getCreationDate](dw.object.PersistentObject.md#getcreationdate), [getLastModified](dw.object.PersistentObject.md#getlastmodified), [getUUID](dw.object.PersistentObject.md#getuuid)
+### Methods inherited from class Object
+
+[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
+## Property Details
+
+### ID
+- ID: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the ID of the content asset.
+
+
+---
+
+### classificationFolder
+- classificationFolder: [Folder](dw.content.Folder.md) `(read-only)`
+  - : Returns the Folder associated with this Content. The folder is
+      used to determine the classification of the content.
+
+
+
+---
+
+### description
+- description: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the description in the current locale or null.
+
+
+---
+
+### folders
+- folders: [Collection](dw.util.Collection.md) `(read-only)`
+  - : Returns all folders to which this content is assigned.
+
+
+---
+
+### name
+- name: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the name of the content asset.
+
+
+---
+
+### online
+- online: [Boolean](TopLevel.Boolean.md) `(read-only)`
+  - : Returns the online status of the content.
+
+
+---
+
+### onlineFlag
+- onlineFlag: [Boolean](TopLevel.Boolean.md) `(read-only)`
+  - : Returns the online status flag of the content.
+
+
+---
+
+### page
+- page: [Boolean](TopLevel.Boolean.md) `(read-only)`
+  - : Returns if the content is a [Page](dw.experience.Page.md) or not.
+
+
+---
+
+### pageDescription
+- pageDescription: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the page description for the content in the current locale
+      or null if there is no page description.
+
+
+
+---
+
+### pageKeywords
+- pageKeywords: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the page keywords for the content in the current locale
+      or null if there is no page title.
+
+
+
+---
+
+### pageMetaTags
+- pageMetaTags: [Array](TopLevel.Array.md) `(read-only)`
+  - : Returns all page meta tags, defined for this instance for which content can be generated.
+      
+      
+      The meta tag content is generated based on the content detail page meta tag context and rules.
+      The rules are obtained from the current content or inherited from the default folder,
+      up to the root folder.
+
+
+
+---
+
+### pageTitle
+- pageTitle: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the page title for the content in the current locale
+      or null if there is no page title.
+
+
+
+---
+
+### pageURL
+- pageURL: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the page URL for the content in the current locale
+      or null if there is no page URL.
+
+
+
+---
+
+### searchable
+- searchable: [Boolean](TopLevel.Boolean.md) `(read-only)`
+  - : Returns the search status of the content.
+
+
+---
+
+### searchableFlag
+- searchableFlag: [Boolean](TopLevel.Boolean.md) `(read-only)`
+  - : Returns the online status flag of the content.
+
+
+---
+
+### siteMapChangeFrequency
+- siteMapChangeFrequency: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the contents change frequency needed for the sitemap creation.
+
+
+---
+
+### siteMapIncluded
+- siteMapIncluded: [Number](TopLevel.Number.md) `(read-only)`
+  - : Returns the status if the content is included into the sitemap.
+
+
+---
+
+### siteMapPriority
+- siteMapPriority: [Number](TopLevel.Number.md) `(read-only)`
+  - : Returns the contents priority needed for the sitemap creation.
+      If no priority is defined, the method returns 0.0.
+
+
+
+---
+
+### template
+- template: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the value of attribute 'template'.
+
+
+---
+
+## Method Details
+
+### getClassificationFolder()
+- getClassificationFolder(): [Folder](dw.content.Folder.md)
+  - : Returns the Folder associated with this Content. The folder is
+      used to determine the classification of the content.
+
+
+    **Returns:**
+    - the classification Folder.
+
+
+---
+
+### getDescription()
+- getDescription(): [String](TopLevel.String.md)
+  - : Returns the description in the current locale or null.
+
+    **Returns:**
+    - the description in the current locale or null.
+
+
+---
+
+### getFolders()
+- getFolders(): [Collection](dw.util.Collection.md)
+  - : Returns all folders to which this content is assigned.
+
+    **Returns:**
+    - Collection of Folder objects.
+
+
+---
+
+### getID()
+- getID(): [String](TopLevel.String.md)
+  - : Returns the ID of the content asset.
+
+    **Returns:**
+    - the ID of the content asset.
+
+
+---
+
+### getName()
+- getName(): [String](TopLevel.String.md)
+  - : Returns the name of the content asset.
+
+    **Returns:**
+    - the name of the content asset.
+
+
+---
+
+### getOnlineFlag()
+- getOnlineFlag(): [Boolean](TopLevel.Boolean.md)
+  - : Returns the online status flag of the content.
+
+    **Returns:**
+    - true if the content is online, false otherwise.
+
+
+---
+
+### getPageDescription()
+- getPageDescription(): [String](TopLevel.String.md)
+  - : Returns the page description for the content in the current locale
+      or null if there is no page description.
+
+
+    **Returns:**
+    - the page description for the content in the current locale
+      or null if there is no page description.
+
+
+
+---
+
+### getPageKeywords()
+- getPageKeywords(): [String](TopLevel.String.md)
+  - : Returns the page keywords for the content in the current locale
+      or null if there is no page title.
+
+
+    **Returns:**
+    - the page keywords for the content in the current locale
+      or null if there is no page title.
+
+
+
+---
+
+### getPageMetaTag(String)
+- getPageMetaTag(id: [String](TopLevel.String.md)): [PageMetaTag](dw.web.PageMetaTag.md)
+  - : Returns the page meta tag for the specified id.
+      
+      
+      The meta tag content is generated based on the content detail page meta tag context and rule.
+      The rule is obtained from the current content or inherited from the default folder,
+      up to the root folder.
+      
+      
+      Null will be returned if the meta tag is undefined on the current instance, or if no rule can be found for the
+      current context, or if the rule resolves to an empty string.
+
+
+    **Parameters:**
+    - id - the ID to get the page meta tag for
+
+    **Returns:**
+    - page meta tag containing content generated based on rules
+
+
+---
+
+### getPageMetaTags()
+- getPageMetaTags(): [Array](TopLevel.Array.md)
+  - : Returns all page meta tags, defined for this instance for which content can be generated.
+      
+      
+      The meta tag content is generated based on the content detail page meta tag context and rules.
+      The rules are obtained from the current content or inherited from the default folder,
+      up to the root folder.
+
+
+    **Returns:**
+    - page meta tags defined for this instance, containing content generated based on rules
+
+
+---
+
+### getPageTitle()
+- getPageTitle(): [String](TopLevel.String.md)
+  - : Returns the page title for the content in the current locale
+      or null if there is no page title.
+
+
+    **Returns:**
+    - the page title for the content in the current locale
+      or null if there is no page title.
+
+
+
+---
+
+### getPageURL()
+- getPageURL(): [String](TopLevel.String.md)
+  - : Returns the page URL for the content in the current locale
+      or null if there is no page URL.
+
+
+    **Returns:**
+    - the page URL for the content in the current locale
+      or null if there is no page URL.
+
+
+
+---
+
+### getSearchableFlag()
+- getSearchableFlag(): [Boolean](TopLevel.Boolean.md)
+  - : Returns the online status flag of the content.
+
+    **Returns:**
+    - true if the content is searchable, false otherwise.
+
+
+---
+
+### getSiteMapChangeFrequency()
+- getSiteMapChangeFrequency(): [String](TopLevel.String.md)
+  - : Returns the contents change frequency needed for the sitemap creation.
+
+    **Returns:**
+    - The contents sitemap change frequency.
+
+
+---
+
+### getSiteMapIncluded()
+- getSiteMapIncluded(): [Number](TopLevel.Number.md)
+  - : Returns the status if the content is included into the sitemap.
+
+    **Returns:**
+    - the value of the attribute 'siteMapIncluded'
+
+
+---
+
+### getSiteMapPriority()
+- getSiteMapPriority(): [Number](TopLevel.Number.md)
+  - : Returns the contents priority needed for the sitemap creation.
+      If no priority is defined, the method returns 0.0.
+
+
+    **Returns:**
+    - The contents sitemap priority.
+
+
+---
+
+### getTemplate()
+- getTemplate(): [String](TopLevel.String.md)
+  - : Returns the value of attribute 'template'.
+
+    **Returns:**
+    - the value of the attribute 'template'
+
+
+---
+
+### isOnline()
+- isOnline(): [Boolean](TopLevel.Boolean.md)
+  - : Returns the online status of the content.
+
+    **Returns:**
+    - true if the content is online, false otherwise.
+
+
+---
+
+### isPage()
+- isPage(): [Boolean](TopLevel.Boolean.md)
+  - : Returns if the content is a [Page](dw.experience.Page.md) or not.
+
+    **Returns:**
+    - true if the content is a [Page](dw.experience.Page.md), false otherwise.
+
+
+---
+
+### isSearchable()
+- isSearchable(): [Boolean](TopLevel.Boolean.md)
+  - : Returns the search status of the content.
+
+    **Returns:**
+    - true if the content is searchable, false otherwise.
+
+
+---
+
+### toPage()
+- toPage(): [Page](dw.experience.Page.md)
+  - : Converts the content into the [Page](dw.experience.Page.md) representation if [isPage()](dw.content.Content.md#ispage) yields true.
+
+    **Returns:**
+    - the [Page](dw.experience.Page.md) representation of the content if it is a page, `null` otherwise.
+
+    **See Also:**
+    - [PageMgr.getPage(String)](dw.experience.PageMgr.md#getpagestring)
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.content.ContentMgr.md

@@ -0,0 +1,147 @@
+<!-- prettier-ignore-start -->
+# Class ContentMgr
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.content.ContentMgr](dw.content.ContentMgr.md)
+
+Provides helper methods for getting content assets, library folders and the
+content library of the current site.
+
+
+
+## Constant Summary
+
+| Constant | Description |
+| --- | --- |
+| [PRIVATE_LIBRARY](#private_library): [String](TopLevel.String.md) = "PrivateLibrary" | The input string to identify that the library is a private site library when invoking [getLibrary(String)](dw.content.ContentMgr.md#getlibrarystring). |
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [siteLibrary](#sitelibrary): [Library](dw.content.Library.md) `(read-only)` | Returns the content library of the current site. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| static [getContent](dw.content.ContentMgr.md#getcontentlibrary-string)([Library](dw.content.Library.md), [String](TopLevel.String.md)) | Returns the content with the corresponding identifier within the specified library. |
+| static [getContent](dw.content.ContentMgr.md#getcontentstring)([String](TopLevel.String.md)) | Returns the content with the corresponding identifier within the current  site's site library. |
+| static [getFolder](dw.content.ContentMgr.md#getfolderlibrary-string)([Library](dw.content.Library.md), [String](TopLevel.String.md)) | Returns the folder identified by the specified id within the specified library. |
+| static [getFolder](dw.content.ContentMgr.md#getfolderstring)([String](TopLevel.String.md)) | Returns the folder identified by the specified id within the current  site's site library. |
+| static [getLibrary](dw.content.ContentMgr.md#getlibrarystring)([String](TopLevel.String.md)) | Returns the content library specified by the given id. |
+| static [getSiteLibrary](dw.content.ContentMgr.md#getsitelibrary)() | Returns the content library of the current site. |
+
+### Methods inherited from class Object
+
+[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
+## Constant Details
+
+### PRIVATE_LIBRARY
+
+- PRIVATE_LIBRARY: [String](TopLevel.String.md) = "PrivateLibrary"
+  - : The input string to identify that the library is a private site library when invoking [getLibrary(String)](dw.content.ContentMgr.md#getlibrarystring).
+
+
+---
+
+## Property Details
+
+### siteLibrary
+- siteLibrary: [Library](dw.content.Library.md) `(read-only)`
+  - : Returns the content library of the current site.
+
+
+---
+
+## Method Details
+
+### getContent(Library, String)
+- static getContent(library: [Library](dw.content.Library.md), id: [String](TopLevel.String.md)): [Content](dw.content.Content.md)
+  - : Returns the content with the corresponding identifier within the specified library.
+
+    **Parameters:**
+    - library - the content library to look for the content in
+    - id - the ID of the content asset to find.
+
+    **Returns:**
+    - the content if found, or null if not found.
+
+
+---
+
+### getContent(String)
+- static getContent(id: [String](TopLevel.String.md)): [Content](dw.content.Content.md)
+  - : Returns the content with the corresponding identifier within the current
+      site's site library.
+
+
+    **Parameters:**
+    - id - the ID of the content asset to find.
+
+    **Returns:**
+    - the content if found, or null if not found.
+
+
+---
+
+### getFolder(Library, String)
+- static getFolder(library: [Library](dw.content.Library.md), id: [String](TopLevel.String.md)): [Folder](dw.content.Folder.md)
+  - : Returns the folder identified by the specified id within the specified library.
+
+    **Parameters:**
+    - library - the content library to look for the folder in
+    - id - the ID of the folder to find.
+
+    **Returns:**
+    - the folder, or null if not found.
+
+
+---
+
+### getFolder(String)
+- static getFolder(id: [String](TopLevel.String.md)): [Folder](dw.content.Folder.md)
+  - : Returns the folder identified by the specified id within the current
+      site's site library.
+
+
+    **Parameters:**
+    - id - the ID of the folder to find.
+
+    **Returns:**
+    - the folder, or null if not found.
+
+
+---
+
+### getLibrary(String)
+- static getLibrary(libraryId: [String](TopLevel.String.md)): [Library](dw.content.Library.md)
+  - : Returns the content library specified by the given id. If [PRIVATE_LIBRARY](dw.content.ContentMgr.md#private_library) is used, then the current
+      site's private library will be returned.
+
+
+    **Parameters:**
+    - libraryId - the id of the library to return.
+
+    **Returns:**
+    - the library for the passed id. Returns null if there is no content library with that id.
+
+
+---
+
+### getSiteLibrary()
+- static getSiteLibrary(): [Library](dw.content.Library.md)
+  - : Returns the content library of the current site.
+
+    **Returns:**
+    - the content library of the current site, or null if there is not
+              content library assigned to the current site.
+
+
+
+---
+
+<!-- prettier-ignore-end -->