@salesforce/b2c-tooling-sdk 0.0.1 → 0.0.2

package/data/script-api/dw.campaign.SourceCodeInfo.md

@@ -0,0 +1,167 @@
+<!-- prettier-ignore-start -->
+# Class SourceCodeInfo
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.campaign.SourceCodeInfo](dw.campaign.SourceCodeInfo.md)
+
+Class representing a code (i.e. a "source code") that has been applied to a
+customer's session. Source codes can qualify customers for different
+campaigns, promotions, and other site experiences from those that the typical
+customer sees. Codes are organized into source code groups.
+
+
+Typically, a code is applied to a customer's session automatically by
+Commerce Cloud Digital when a customer accesses a Digital URL with a well
+known request parameter in the querystring.  A code may also be explicitly
+applied to a customer session using the `SetSourceCode`
+pipelet.
+
+
+
+## Constant Summary
+
+| Constant | Description |
+| --- | --- |
+| [STATUS_ACTIVE](#status_active): [Number](TopLevel.Number.md) = 2 | The literal source-code is found and currently active. |
+| [STATUS_INACTIVE](#status_inactive): [Number](TopLevel.Number.md) = 1 | The literal source-code is found but not active. |
+| [STATUS_INVALID](#status_invalid): [Number](TopLevel.Number.md) = 0 | The literal source-code is not found in the system. |
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [code](#code): [String](TopLevel.String.md) `(read-only)` | The literal source-code. |
+| [group](#group): [SourceCodeGroup](dw.campaign.SourceCodeGroup.md) `(read-only)` | The associated source-code group. |
+| [redirect](#redirect): [URLRedirect](dw.web.URLRedirect.md) `(read-only)` | Retrieves the redirect information from the last processed SourceCodeGroup (active or inactive). |
+| [status](#status): [Number](TopLevel.Number.md) `(read-only)` | The status of the source-code. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getCode](dw.campaign.SourceCodeInfo.md#getcode)() | The literal source-code. |
+| [getGroup](dw.campaign.SourceCodeInfo.md#getgroup)() | The associated source-code group. |
+| [getRedirect](dw.campaign.SourceCodeInfo.md#getredirect)() | Retrieves the redirect information from the last processed SourceCodeGroup (active or inactive). |
+| [getStatus](dw.campaign.SourceCodeInfo.md#getstatus)() | The status of the source-code. |
+
+### 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
+
+### STATUS_ACTIVE
+
+- STATUS_ACTIVE: [Number](TopLevel.Number.md) = 2
+  - : The literal source-code is found and currently active.
+
+
+---
+
+### STATUS_INACTIVE
+
+- STATUS_INACTIVE: [Number](TopLevel.Number.md) = 1
+  - : The literal source-code is found but not active.
+
+
+---
+
+### STATUS_INVALID
+
+- STATUS_INVALID: [Number](TopLevel.Number.md) = 0
+  - : The literal source-code is not found in the system.
+
+
+---
+
+## Property Details
+
+### code
+- code: [String](TopLevel.String.md) `(read-only)`
+  - : The literal source-code.
+
+
+---
+
+### group
+- group: [SourceCodeGroup](dw.campaign.SourceCodeGroup.md) `(read-only)`
+  - : The associated source-code group.
+
+
+---
+
+### redirect
+- redirect: [URLRedirect](dw.web.URLRedirect.md) `(read-only)`
+  - : Retrieves the redirect information from the last processed SourceCodeGroup (active or inactive). If none exists,
+      then the redirect information is retrieved from the source-code preferences, based on the active/inactive status
+      of the SourceCodeGroup. The redirect information is then resolved to the output URL. If the redirect information
+      cannot be resolved to a URL, or there is an error retrieving the preferences, then null is returned.
+
+
+
+---
+
+### status
+- status: [Number](TopLevel.Number.md) `(read-only)`
+  - : The status of the source-code.  One of the following:
+      STATUS\_INVALID - The source code is not found in the system.
+      STATUS\_INACTIVE - The source code is found but not active.
+      STATUS\_INACTIVE - The source code is found and active.
+
+
+
+---
+
+## Method Details
+
+### getCode()
+- getCode(): [String](TopLevel.String.md)
+  - : The literal source-code.
+
+    **Returns:**
+    - the source-code.
+
+
+---
+
+### getGroup()
+- getGroup(): [SourceCodeGroup](dw.campaign.SourceCodeGroup.md)
+  - : The associated source-code group.
+
+    **Returns:**
+    - the source-code group.
+
+
+---
+
+### getRedirect()
+- getRedirect(): [URLRedirect](dw.web.URLRedirect.md)
+  - : Retrieves the redirect information from the last processed SourceCodeGroup (active or inactive). If none exists,
+      then the redirect information is retrieved from the source-code preferences, based on the active/inactive status
+      of the SourceCodeGroup. The redirect information is then resolved to the output URL. If the redirect information
+      cannot be resolved to a URL, or there is an error retrieving the preferences, then null is returned.
+
+
+    **Returns:**
+    - URLRedirect containing the location and status code, null in case of no redirect was found
+
+
+---
+
+### getStatus()
+- getStatus(): [Number](TopLevel.Number.md)
+  - : The status of the source-code.  One of the following:
+      STATUS\_INVALID - The source code is not found in the system.
+      STATUS\_INACTIVE - The source code is found but not active.
+      STATUS\_INACTIVE - The source code is found and active.
+
+
+    **Returns:**
+    - the status.
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.campaign.SourceCodeStatusCodes.md

@@ -0,0 +1,61 @@
+<!-- prettier-ignore-start -->
+# Class SourceCodeStatusCodes
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.campaign.SourceCodeStatusCodes](dw.campaign.SourceCodeStatusCodes.md)
+
+Helper class which contains error result codes returned by the SetSourceCode
+pipelet.
+
+
+
+## Constant Summary
+
+| Constant | Description |
+| --- | --- |
+| [CODE_INACTIVE](#code_inactive): [String](TopLevel.String.md) = "CODE_INACTIVE" | Indicates that the specified source code was found in one or more  source-code groups, none of which are active. |
+| [CODE_INVALID](#code_invalid): [String](TopLevel.String.md) = "CODE_INVALID" | Indicates that the specified source code is not contained  in any source-code group. |
+
+## Constructor Summary
+
+| Constructor | Description |
+| --- | --- |
+| [SourceCodeStatusCodes](#sourcecodestatuscodes)() |  |
+
+## Method Summary
+
+### 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
+
+### CODE_INACTIVE
+
+- CODE_INACTIVE: [String](TopLevel.String.md) = "CODE_INACTIVE"
+  - : Indicates that the specified source code was found in one or more
+      source-code groups, none of which are active.
+
+
+
+---
+
+### CODE_INVALID
+
+- CODE_INVALID: [String](TopLevel.String.md) = "CODE_INVALID"
+  - : Indicates that the specified source code is not contained
+      in any source-code group.
+
+
+
+---
+
+## Constructor Details
+
+### SourceCodeStatusCodes()
+- SourceCodeStatusCodes()
+  - : 
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.campaign.TotalFixedPriceDiscount.md

@@ -0,0 +1,56 @@
+<!-- prettier-ignore-start -->
+# Class TotalFixedPriceDiscount
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.campaign.Discount](dw.campaign.Discount.md)
+    - [dw.campaign.TotalFixedPriceDiscount](dw.campaign.TotalFixedPriceDiscount.md)
+
+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".
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [totalFixedPrice](#totalfixedprice): [Number](TopLevel.Number.md) `(read-only)` | Returns the total fixed price amount. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getTotalFixedPrice](dw.campaign.TotalFixedPriceDiscount.md#gettotalfixedprice)() | Returns the total fixed price amount. |
+
+### Methods inherited from class Discount
+
+[getItemPromotionTiers](dw.campaign.Discount.md#getitempromotiontiers), [getPromotion](dw.campaign.Discount.md#getpromotion), [getPromotionTier](dw.campaign.Discount.md#getpromotiontier), [getQuantity](dw.campaign.Discount.md#getquantity), [getType](dw.campaign.Discount.md#gettype)
+### 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
+
+### totalFixedPrice
+- totalFixedPrice: [Number](TopLevel.Number.md) `(read-only)`
+  - : Returns the total fixed price amount.
+
+
+---
+
+## Method Details
+
+### getTotalFixedPrice()
+- getTotalFixedPrice(): [Number](TopLevel.Number.md)
+  - : Returns the total fixed price amount.
+
+    **Returns:**
+    - Total fixed price amount
+
+
+---
+
+<!-- prettier-ignore-end -->

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

@@ -0,0 +1,36 @@
+# Package dw.campaign
+
+## Classes
+| Class | Description |
+| --- | --- |
+| [ABTest](dw.campaign.ABTest.md) | Object representing an AB-test in Commerce Cloud Digital. |
+| [ABTestMgr](dw.campaign.ABTestMgr.md) | Manager class used to access AB-test information in the storefront. |
+| [ABTestSegment](dw.campaign.ABTestSegment.md) | Object representing an AB-test segment in the Commerce Cloud Digital. |
+| [AmountDiscount](dw.campaign.AmountDiscount.md) | Represents an _amount-off_ discount in the discount plan, for example  "$10 off all orders $100 or more". |
+| [ApproachingDiscount](dw.campaign.ApproachingDiscount.md) | Transient class representing a discount that a [LineItemCtnr](dw.order.LineItemCtnr.md)  "almost" qualifies for based on the amount of merchandise in it. |
+| [BonusChoiceDiscount](dw.campaign.BonusChoiceDiscount.md) | Represents a _choice of bonus products_ discount in the discount plan,  for example "Choose 3 DVDs from a list of 20 options with your purchase of  any DVD player." |
+| [BonusDiscount](dw.campaign.BonusDiscount.md) | Represents a _bonus_ discount in the discount plan, for example  "Get a free DVD with your purchase of any DVD player." |
+| [Campaign](dw.campaign.Campaign.md) | A Campaign is a set of experiences (or site configurations) which may be  deployed as a single unit for a given time frame. |
+| [CampaignMgr](dw.campaign.CampaignMgr.md) | CampaignMgr provides static methods for managing campaign-specific operations  such as accessing promotions or updating promotion line items. |
+| [CampaignStatusCodes](dw.campaign.CampaignStatusCodes.md) | Deprecated. |
+| [Coupon](dw.campaign.Coupon.md) | Represents a coupon in Commerce Cloud Digital. |
+| [CouponMgr](dw.campaign.CouponMgr.md) | Manager to access coupons. |
+| [CouponRedemption](dw.campaign.CouponRedemption.md) | Represents a redeemed coupon. |
+| [CouponStatusCodes](dw.campaign.CouponStatusCodes.md) | Helper class containing status codes for why a coupon code cannot be added  to cart or why a coupon code already in cart is not longer valid for redemption. |
+| [Discount](dw.campaign.Discount.md) | Superclass of all specific discount classes. |
+| [DiscountPlan](dw.campaign.DiscountPlan.md) | DiscountPlan represents a set of [Discount](dw.campaign.Discount.md)s. |
+| [FixedPriceDiscount](dw.campaign.FixedPriceDiscount.md) | Represents a _fix price_ discount in the discount plan, for example  "Shipping only 0.99 all orders $25 or more." |
+| [FixedPriceShippingDiscount](dw.campaign.FixedPriceShippingDiscount.md) | Represents a _fixed price shipping_ discount in the discount plan, for  example "Shipping only 0.99 for iPods." |
+| [FreeDiscount](dw.campaign.FreeDiscount.md) | Represents a _free_ discount in the discount plan, for example  "Free shipping on all orders $25 or more." |
+| [FreeShippingDiscount](dw.campaign.FreeShippingDiscount.md) | Represents a _free shipping_ discount in the discount plan, for example  "Free shipping on all iPods." |
+| [PercentageDiscount](dw.campaign.PercentageDiscount.md) | Represents a _percentage-off_ discount in the discount plan, for example  "10% off all T-Shirts". |
+| [PercentageOptionDiscount](dw.campaign.PercentageOptionDiscount.md) | Represents a _percentage-off options_ discount in the discount plan, for  example "50% off monogramming on shirts". |
+| [PriceBookPriceDiscount](dw.campaign.PriceBookPriceDiscount.md) | Discount representing that a product's price has been calculated from a  separate sales price book other than the standard price book assigned to the  site. |
+| [Promotion](dw.campaign.Promotion.md) | This class represents a promotion in Commerce Cloud Digital. |
+| [PromotionMgr](dw.campaign.PromotionMgr.md) | [PromotionMgr](dw.campaign.PromotionMgr.md) is used to access campaigns and promotion  definitions, display active or upcoming promotions in a storefront, and to  calculate and apply promotional discounts to line item containers. |
+| [PromotionPlan](dw.campaign.PromotionPlan.md) | PromotionPlan represents a set of [Promotion](dw.campaign.Promotion.md) instances and  is used to display active or upcoming promotions on storefront pages, or to  pass it to the [PromotionMgr](dw.campaign.PromotionMgr.md) to calculate a  [DiscountPlan](dw.campaign.DiscountPlan.md) and subsequently apply discounts to a line  item container. |
+| [SlotContent](dw.campaign.SlotContent.md) | Represents content for a slot. |
+| [SourceCodeGroup](dw.campaign.SourceCodeGroup.md) | A source code group defines a collection of source codes. |
+| [SourceCodeInfo](dw.campaign.SourceCodeInfo.md) | Class representing a code (i.e. |
+| [SourceCodeStatusCodes](dw.campaign.SourceCodeStatusCodes.md) | Helper class which contains error result codes returned by the SetSourceCode  pipelet. |
+| [TotalFixedPriceDiscount](dw.campaign.TotalFixedPriceDiscount.md) | Represents a _total fix price_ discount on a group of products in the  discount plan. |

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

@@ -0,0 +1,158 @@
+<!-- prettier-ignore-start -->
+# Class Catalog
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.object.PersistentObject](dw.object.PersistentObject.md)
+    - [dw.object.ExtensibleObject](dw.object.ExtensibleObject.md)
+      - [dw.catalog.Catalog](dw.catalog.Catalog.md)
+
+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()](dw.catalog.CatalogMgr.md#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.
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [ID](#id): [String](TopLevel.String.md) `(read-only)` | Returns the value of attribute 'id'. |
+| [description](#description): [String](TopLevel.String.md) `(read-only)` | Returns the value of the localized extensible object attribute  "shortDescription" for the current locale. |
+| [displayName](#displayname): [String](TopLevel.String.md) `(read-only)` | Returns the value of the localized extensible object attribute  "displayName" for the current locale. |
+| [root](#root): [Category](dw.catalog.Category.md) `(read-only)` | Returns the object for the relation 'root'. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getDescription](dw.catalog.Catalog.md#getdescription)() | Returns the value of the localized extensible object attribute  "shortDescription" for the current locale. |
+| [getDisplayName](dw.catalog.Catalog.md#getdisplayname)() | Returns the value of the localized extensible object attribute  "displayName" for the current locale. |
+| [getID](dw.catalog.Catalog.md#getid)() | Returns the value of attribute 'id'. |
+| [getRoot](dw.catalog.Catalog.md#getroot)() | Returns the object for the relation 'root'. |
+
+### 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 value of attribute 'id'.
+
+
+---
+
+### description
+- description: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the value of the localized extensible object attribute
+      "shortDescription" for the current locale.
+
+
+
+---
+
+### displayName
+- displayName: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the value of the localized extensible object attribute
+      "displayName" for the current locale.
+
+
+
+---
+
+### root
+- root: [Category](dw.catalog.Category.md) `(read-only)`
+  - : Returns the object for the relation 'root'.
+
+
+---
+
+## Method Details
+
+### getDescription()
+- getDescription(): [String](TopLevel.String.md)
+  - : 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()
+- getDisplayName(): [String](TopLevel.String.md)
+  - : 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()
+- getID(): [String](TopLevel.String.md)
+  - : Returns the value of attribute 'id'.
+
+    **Returns:**
+    - the value of the attribute 'id'
+
+
+---
+
+### getRoot()
+- getRoot(): [Category](dw.catalog.Category.md)
+  - : Returns the object for the relation 'root'.
+
+    **Returns:**
+    - the object for the relation 'root'.
+
+
+---
+
+<!-- prettier-ignore-end -->

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

@@ -0,0 +1,155 @@
+<!-- prettier-ignore-start -->
+# Class CatalogMgr
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.catalog.CatalogMgr](dw.catalog.CatalogMgr.md)
+
+Provides helper methods for getting categories.
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [siteCatalog](#sitecatalog): [Catalog](dw.catalog.Catalog.md) `(read-only)` | Returns the catalog of the current site or null if no catalog is assigned to the site. |
+| [sortingOptions](#sortingoptions): [List](dw.util.List.md) `(read-only)` | Returns a list containing the sorting options configured for this site. |
+| [sortingRules](#sortingrules): [Collection](dw.util.Collection.md) `(read-only)` | Returns a collection containing all of the sorting rules for this site, including global sorting rules. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| static [getCatalog](dw.catalog.CatalogMgr.md#getcatalogstring)([String](TopLevel.String.md)) | Returns the catalog identified by the specified catalog id. |
+| static [getCategory](dw.catalog.CatalogMgr.md#getcategorystring)([String](TopLevel.String.md)) | Returns the category of the site catalog identified by the specified  category id. |
+| static [getSiteCatalog](dw.catalog.CatalogMgr.md#getsitecatalog)() | Returns the catalog of the current site or null if no catalog is assigned to the site. |
+| static [getSortingOption](dw.catalog.CatalogMgr.md#getsortingoptionstring)([String](TopLevel.String.md)) | Returns the sorting option with the given ID for this site, or  `null` if there is no such option. |
+| static [getSortingOptions](dw.catalog.CatalogMgr.md#getsortingoptions)() | Returns a list containing the sorting options configured for this site. |
+| static [getSortingRule](dw.catalog.CatalogMgr.md#getsortingrulestring)([String](TopLevel.String.md)) | Returns the sorting rule with the given ID for this site,  or `null` if there is no such rule. |
+| static [getSortingRules](dw.catalog.CatalogMgr.md#getsortingrules)() | Returns a collection containing all of the sorting rules for this site, including global sorting rules. |
+
+### 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
+
+### siteCatalog
+- siteCatalog: [Catalog](dw.catalog.Catalog.md) `(read-only)`
+  - : Returns the catalog of the current site or null if no catalog is assigned to the site.
+
+
+---
+
+### sortingOptions
+- sortingOptions: [List](dw.util.List.md) `(read-only)`
+  - : Returns a list containing the sorting options configured for this site.
+
+
+---
+
+### sortingRules
+- sortingRules: [Collection](dw.util.Collection.md) `(read-only)`
+  - : Returns a collection containing all of the sorting rules for this site, including global sorting rules.
+
+
+---
+
+## Method Details
+
+### getCatalog(String)
+- static getCatalog(id: [String](TopLevel.String.md)): [Catalog](dw.catalog.Catalog.md)
+  - : 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(String)
+- static getCategory(id: [String](TopLevel.String.md)): [Category](dw.catalog.Category.md)
+  - : 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()
+- static getSiteCatalog(): [Catalog](dw.catalog.Catalog.md)
+  - : 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(String)
+- static getSortingOption(id: [String](TopLevel.String.md)): [SortingOption](dw.catalog.SortingOption.md)
+  - : 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()
+- static getSortingOptions(): [List](dw.util.List.md)
+  - : Returns a list containing the sorting options configured for this site.
+
+    **Returns:**
+    - a list of SortingOption objects
+
+
+---
+
+### getSortingRule(String)
+- static getSortingRule(id: [String](TopLevel.String.md)): [SortingRule](dw.catalog.SortingRule.md)
+  - : 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()
+- static getSortingRules(): [Collection](dw.util.Collection.md)
+  - : Returns a collection containing all of the sorting rules for this site, including global sorting rules.
+
+    **Returns:**
+    - a collection of SortingRule objects
+
+
+---
+
+<!-- prettier-ignore-end -->