@salesforce/b2c-tooling-sdk 1.19.1 → 1.20.0

package/data/script-api/dw.experience.PageScriptContext.md

@@ -1,200 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class PageScriptContext
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.experience.PageScriptContext](dw.experience.PageScriptContext.md)
-
-This is the context that is handed over to the `render` and `serialize` function of the respective page type
-script.
-
-
-```
-    String : render( [PageScriptContext](dw.experience.PageScriptContext.md) context)
-    Object : serialize( [PageScriptContext](dw.experience.PageScriptContext.md) context)
-```
-
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [content](#content): [Map](dw.util.Map.md) `(read-only)` | Returns the processed version of the underlying unprocessed raw values (also see [Page.getAttribute(String)](dw.experience.Page.md#getattributestring))  of this page's attributes which you can use in your respective page type `render` and `serialize` function  implementing your business and rendering/serialization functionality. |
-| [page](#page): [Page](dw.experience.Page.md) `(read-only)` | Returns the page for which the corresponding page type script is currently executed. |
-| ~~[renderParameters](#renderparameters): [String](TopLevel.String.md)~~ `(read-only)` | Returns the `parameters` argument as passed when kicking off page rendering via  <ul>   <li>[PageMgr.renderPage(String, String)](dw.experience.PageMgr.md#renderpagestring-string)</li>   <li>[PageMgr.renderPage(String, Map, String)](dw.experience.PageMgr.md#renderpagestring-map-string)</li>  </ul>  and serialization  <ul>   <li>[PageMgr.serializePage(String, String)](dw.experience.PageMgr.md#serializepagestring-string)</li>   <li>[PageMgr.serializePage(String, Map, String)](dw.experience.PageMgr.md#serializepagestring-map-string)</li>  </ul> |
-| [runtimeParameters](#runtimeparameters): [String](TopLevel.String.md) `(read-only)` | Returns the `parameters` argument as passed when kicking off page rendering via  <ul>   <li>[PageMgr.renderPage(String, String)](dw.experience.PageMgr.md#renderpagestring-string)</li>   <li>[PageMgr.renderPage(String, Map, String)](dw.experience.PageMgr.md#renderpagestring-map-string)</li>  </ul>  and page serialization via  <ul>   <li>[PageMgr.serializePage(String, String)](dw.experience.PageMgr.md#serializepagestring-string)</li>   <li>[PageMgr.serializePage(String, Map, String)](dw.experience.PageMgr.md#serializepagestring-map-string)</li>  </ul> |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getContent](dw.experience.PageScriptContext.md#getcontent)() | Returns the processed version of the underlying unprocessed raw values (also see [Page.getAttribute(String)](dw.experience.Page.md#getattributestring))  of this page's attributes which you can use in your respective page type `render` and `serialize` function  implementing your business and rendering/serialization functionality. |
-| [getPage](dw.experience.PageScriptContext.md#getpage)() | Returns the page for which the corresponding page type script is currently executed. |
-| ~~[getRenderParameters](dw.experience.PageScriptContext.md#getrenderparameters)()~~ | Returns the `parameters` argument as passed when kicking off page rendering via  <ul>   <li>[PageMgr.renderPage(String, String)](dw.experience.PageMgr.md#renderpagestring-string)</li>   <li>[PageMgr.renderPage(String, Map, String)](dw.experience.PageMgr.md#renderpagestring-map-string)</li>  </ul>  and serialization  <ul>   <li>[PageMgr.serializePage(String, String)](dw.experience.PageMgr.md#serializepagestring-string)</li>   <li>[PageMgr.serializePage(String, Map, String)](dw.experience.PageMgr.md#serializepagestring-map-string)</li>  </ul> |
-| [getRuntimeParameters](dw.experience.PageScriptContext.md#getruntimeparameters)() | Returns the `parameters` argument as passed when kicking off page rendering via  <ul>   <li>[PageMgr.renderPage(String, String)](dw.experience.PageMgr.md#renderpagestring-string)</li>   <li>[PageMgr.renderPage(String, Map, String)](dw.experience.PageMgr.md#renderpagestring-map-string)</li>  </ul>  and page serialization via  <ul>   <li>[PageMgr.serializePage(String, String)](dw.experience.PageMgr.md#serializepagestring-string)</li>   <li>[PageMgr.serializePage(String, Map, String)](dw.experience.PageMgr.md#serializepagestring-map-string)</li>  </ul> |
-
-### 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
-
-### content
-- content: [Map](dw.util.Map.md) `(read-only)`
-  - : Returns the processed version of the underlying unprocessed raw values (also see [Page.getAttribute(String)](dw.experience.Page.md#getattributestring))
-      of this page's attributes which you can use in your respective page type `render` and `serialize` function
-      implementing your business and rendering/serialization functionality. Processing the raw value is comprised of **expansion**
-      and **conversion**, in this order.
-      
-      1. **expansion**- dynamic placeholders are transformed into actual values, for example url/link placeholders in       markup text are resolved to real URLs
-      2. **conversion**- the raw value (see [Page.getAttribute(String)](dw.experience.Page.md#getattributestring)) is resolved into an actual       DWScript object depending on the type of the attribute as specified in its respective attribute definition        
-         - `boolean`-> boolean
-         - `category`-> [Category](dw.catalog.Category.md)
-         - `custom`-> [Map](dw.util.Map.md)
-         - `cms_record`-> [CMSRecord](dw.experience.cms.CMSRecord.md)
-         - `enum`-> either string or integer 
-         - `file`-> [MediaFile](dw.content.MediaFile.md)
-         - `image`-> [Image](dw.experience.image.Image.md)
-         - `integer`-> integer
-         - `markup`-> string
-         - `page`-> string
-         - `product`-> [Product](dw.catalog.Product.md)
-         - `string`-> string
-         - `text`-> string
-         - `url`-> string
-
-
-
----
-
-### page
-- page: [Page](dw.experience.Page.md) `(read-only)`
-  - : Returns the page for which the corresponding page type script is currently executed.
-
-
----
-
-### renderParameters
-- ~~renderParameters: [String](TopLevel.String.md)~~ `(read-only)`
-  - : Returns the `parameters` argument as passed when kicking off page rendering via
-      
-      - [PageMgr.renderPage(String, String)](dw.experience.PageMgr.md#renderpagestring-string)
-      - [PageMgr.renderPage(String, Map, String)](dw.experience.PageMgr.md#renderpagestring-map-string)
-      
-      and serialization
-      
-      - [PageMgr.serializePage(String, String)](dw.experience.PageMgr.md#serializepagestring-string)
-      - [PageMgr.serializePage(String, Map, String)](dw.experience.PageMgr.md#serializepagestring-map-string)
-
-
-    **Deprecated:**
-:::warning
-Please use [getRuntimeParameters()](dw.experience.PageScriptContext.md#getruntimeparameters) instead.
-:::
-
----
-
-### runtimeParameters
-- runtimeParameters: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the `parameters` argument as passed when kicking off page rendering via
-      
-      - [PageMgr.renderPage(String, String)](dw.experience.PageMgr.md#renderpagestring-string)
-      - [PageMgr.renderPage(String, Map, String)](dw.experience.PageMgr.md#renderpagestring-map-string)
-      
-      and page serialization via
-      
-      - [PageMgr.serializePage(String, String)](dw.experience.PageMgr.md#serializepagestring-string)
-      - [PageMgr.serializePage(String, Map, String)](dw.experience.PageMgr.md#serializepagestring-map-string)
-
-
-
----
-
-## Method Details
-
-### getContent()
-- getContent(): [Map](dw.util.Map.md)
-  - : Returns the processed version of the underlying unprocessed raw values (also see [Page.getAttribute(String)](dw.experience.Page.md#getattributestring))
-      of this page's attributes which you can use in your respective page type `render` and `serialize` function
-      implementing your business and rendering/serialization functionality. Processing the raw value is comprised of **expansion**
-      and **conversion**, in this order.
-      
-      1. **expansion**- dynamic placeholders are transformed into actual values, for example url/link placeholders in       markup text are resolved to real URLs
-      2. **conversion**- the raw value (see [Page.getAttribute(String)](dw.experience.Page.md#getattributestring)) is resolved into an actual       DWScript object depending on the type of the attribute as specified in its respective attribute definition        
-         - `boolean`-> boolean
-         - `category`-> [Category](dw.catalog.Category.md)
-         - `custom`-> [Map](dw.util.Map.md)
-         - `cms_record`-> [CMSRecord](dw.experience.cms.CMSRecord.md)
-         - `enum`-> either string or integer 
-         - `file`-> [MediaFile](dw.content.MediaFile.md)
-         - `image`-> [Image](dw.experience.image.Image.md)
-         - `integer`-> integer
-         - `markup`-> string
-         - `page`-> string
-         - `product`-> [Product](dw.catalog.Product.md)
-         - `string`-> string
-         - `text`-> string
-         - `url`-> string
-
-
-    **Returns:**
-    - processed content attributes of the page
-
-
----
-
-### getPage()
-- getPage(): [Page](dw.experience.Page.md)
-  - : Returns the page for which the corresponding page type script is currently executed.
-
-    **Returns:**
-    - the currently rendered page
-
-
----
-
-### getRenderParameters()
-- ~~getRenderParameters(): [String](TopLevel.String.md)~~
-  - : Returns the `parameters` argument as passed when kicking off page rendering via
-      
-      - [PageMgr.renderPage(String, String)](dw.experience.PageMgr.md#renderpagestring-string)
-      - [PageMgr.renderPage(String, Map, String)](dw.experience.PageMgr.md#renderpagestring-map-string)
-      
-      and serialization
-      
-      - [PageMgr.serializePage(String, String)](dw.experience.PageMgr.md#serializepagestring-string)
-      - [PageMgr.serializePage(String, Map, String)](dw.experience.PageMgr.md#serializepagestring-map-string)
-
-
-    **Returns:**
-    - the parameters passed to page rendering and serialization
-
-    **Deprecated:**
-:::warning
-Please use [getRuntimeParameters()](dw.experience.PageScriptContext.md#getruntimeparameters) instead.
-:::
-
----
-
-### getRuntimeParameters()
-- getRuntimeParameters(): [String](TopLevel.String.md)
-  - : Returns the `parameters` argument as passed when kicking off page rendering via
-      
-      - [PageMgr.renderPage(String, String)](dw.experience.PageMgr.md#renderpagestring-string)
-      - [PageMgr.renderPage(String, Map, String)](dw.experience.PageMgr.md#renderpagestring-map-string)
-      
-      and page serialization via
-      
-      - [PageMgr.serializePage(String, String)](dw.experience.PageMgr.md#serializepagestring-string)
-      - [PageMgr.serializePage(String, Map, String)](dw.experience.PageMgr.md#serializepagestring-map-string)
-
-
-    **Returns:**
-    - the parameters passed to page rendering and serialization
-
-
----
-
-<!-- prettier-ignore-end -->

package/data/script-api/dw.experience.Region.md

@@ -1,119 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class Region
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.experience.Region](dw.experience.Region.md)
-
-This class represents a region which serves as container of components.
-Using the [PageMgr.renderRegion(Region)](dw.experience.PageMgr.md#renderregionregion) or [PageMgr.renderRegion(Region, RegionRenderSettings)](dw.experience.PageMgr.md#renderregionregion-regionrendersettings)
-a region can be rendered.
-
-
-**See Also:**
-- [Page](dw.experience.Page.md)
-- [Component](dw.experience.Component.md)
-- [PageMgr](dw.experience.PageMgr.md)
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [ID](#id): [String](TopLevel.String.md) `(read-only)` | Returns the id of this region. |
-| [size](#size): [Number](TopLevel.Number.md) `(read-only)` | Returns the number of components that would be rendered by this region  when calling [PageMgr.renderRegion(Region)](dw.experience.PageMgr.md#renderregionregion) or [PageMgr.renderRegion(Region, RegionRenderSettings)](dw.experience.PageMgr.md#renderregionregion-regionrendersettings). |
-| [visibleComponents](#visiblecomponents): [Collection](dw.util.Collection.md) `(read-only)` | Returns the components that would be rendered by this region  when calling [PageMgr.renderRegion(Region)](dw.experience.PageMgr.md#renderregionregion) or [PageMgr.renderRegion(Region, RegionRenderSettings)](dw.experience.PageMgr.md#renderregionregion-regionrendersettings). |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getID](dw.experience.Region.md#getid)() | Returns the id of this region. |
-| [getSize](dw.experience.Region.md#getsize)() | Returns the number of components that would be rendered by this region  when calling [PageMgr.renderRegion(Region)](dw.experience.PageMgr.md#renderregionregion) or [PageMgr.renderRegion(Region, RegionRenderSettings)](dw.experience.PageMgr.md#renderregionregion-regionrendersettings). |
-| [getVisibleComponents](dw.experience.Region.md#getvisiblecomponents)() | Returns the components that would be rendered by this region  when calling [PageMgr.renderRegion(Region)](dw.experience.PageMgr.md#renderregionregion) or [PageMgr.renderRegion(Region, RegionRenderSettings)](dw.experience.PageMgr.md#renderregionregion-regionrendersettings). |
-
-### 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 this region.
-
-
----
-
-### size
-- size: [Number](TopLevel.Number.md) `(read-only)`
-  - : Returns the number of components that would be rendered by this region
-      when calling [PageMgr.renderRegion(Region)](dw.experience.PageMgr.md#renderregionregion) or [PageMgr.renderRegion(Region, RegionRenderSettings)](dw.experience.PageMgr.md#renderregionregion-regionrendersettings).
-      
-      
-      Due to its time and customer group depending nature this call should NOT happen in a pagecached context
-      outside of the processing induced by the above mentioned render methods.
-
-
-
----
-
-### visibleComponents
-- visibleComponents: [Collection](dw.util.Collection.md) `(read-only)`
-  - : Returns the components that would be rendered by this region
-      when calling [PageMgr.renderRegion(Region)](dw.experience.PageMgr.md#renderregionregion) or [PageMgr.renderRegion(Region, RegionRenderSettings)](dw.experience.PageMgr.md#renderregionregion-regionrendersettings).
-      
-      
-      As visibility is driven by the merchant configured dynamic visibility rules, e.g. scheduling and custom segmentation, this
-      call should NOT happen in a pagecached context outside of the processing induced by the above mentioned render methods.
-
-
-
----
-
-## Method Details
-
-### getID()
-- getID(): [String](TopLevel.String.md)
-  - : Returns the id of this region.
-
-    **Returns:**
-    - the region id
-
-
----
-
-### getSize()
-- getSize(): [Number](TopLevel.Number.md)
-  - : Returns the number of components that would be rendered by this region
-      when calling [PageMgr.renderRegion(Region)](dw.experience.PageMgr.md#renderregionregion) or [PageMgr.renderRegion(Region, RegionRenderSettings)](dw.experience.PageMgr.md#renderregionregion-regionrendersettings).
-      
-      
-      Due to its time and customer group depending nature this call should NOT happen in a pagecached context
-      outside of the processing induced by the above mentioned render methods.
-
-
-    **Returns:**
-    - the number of visible (i.e. renderable or serializable) components in this region
-
-
----
-
-### getVisibleComponents()
-- getVisibleComponents(): [Collection](dw.util.Collection.md)
-  - : Returns the components that would be rendered by this region
-      when calling [PageMgr.renderRegion(Region)](dw.experience.PageMgr.md#renderregionregion) or [PageMgr.renderRegion(Region, RegionRenderSettings)](dw.experience.PageMgr.md#renderregionregion-regionrendersettings).
-      
-      
-      As visibility is driven by the merchant configured dynamic visibility rules, e.g. scheduling and custom segmentation, this
-      call should NOT happen in a pagecached context outside of the processing induced by the above mentioned render methods.
-
-
-    **Returns:**
-    - the visible (i.e. renderable or serializable) components in this region
-
-
----
-
-<!-- prettier-ignore-end -->

package/data/script-api/dw.experience.RegionRenderSettings.md

@@ -1,207 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class RegionRenderSettings
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.experience.RegionRenderSettings](dw.experience.RegionRenderSettings.md)
-
-A config that drives how the region is rendered. One can basically decide which kind of tag is used as wrapper
-element (e.g. `<div>...</div>`) and which attributes are to be placed into this wrapper
-element (e.g. `class="foo bar"`).
-
-
-If no attributes are provided for the region render settings then the system default ones will apply. Also if no tag
-name is provided then the system default one will apply.
-
-- tag\_name : div
-- attributes : {"class":"experience-region experience-\[REGION\_ID\]"}
-
-Furthermore the render settings for components in this region can be specified - in case nothing is set per component
-then the default component render setting will be applied during rendering. If also no default component render
-setting is provided then the system default one will apply (see [ComponentRenderSettings](dw.experience.ComponentRenderSettings.md)).
-
-
-**See Also:**
-- [PageMgr.renderRegion(Region)](dw.experience.PageMgr.md#renderregionregion)
-- [PageMgr.renderRegion(Region, RegionRenderSettings)](dw.experience.PageMgr.md#renderregionregion-regionrendersettings)
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [attributes](#attributes): [Object](TopLevel.Object.md) | Returns the configured attributes of the wrapper element as set by [setAttributes(Object)](dw.experience.RegionRenderSettings.md#setattributesobject). |
-| [defaultComponentRenderSettings](#defaultcomponentrendersettings): [ComponentRenderSettings](dw.experience.ComponentRenderSettings.md) | Returns the default component render settings. |
-| [tagName](#tagname): [String](TopLevel.String.md) | Returns the tag name of the region wrapper element. |
-
-## Constructor Summary
-
-| Constructor | Description |
-| --- | --- |
-| [RegionRenderSettings](#regionrendersettings)() | Creates region render settings which can then be configured further. |
-
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getAttributes](dw.experience.RegionRenderSettings.md#getattributes)() | Returns the configured attributes of the wrapper element as set by [setAttributes(Object)](dw.experience.RegionRenderSettings.md#setattributesobject). |
-| [getComponentRenderSettings](dw.experience.RegionRenderSettings.md#getcomponentrendersettingscomponent)([Component](dw.experience.Component.md)) | Returns the component render settings for the given component. |
-| [getDefaultComponentRenderSettings](dw.experience.RegionRenderSettings.md#getdefaultcomponentrendersettings)() | Returns the default component render settings. |
-| [getTagName](dw.experience.RegionRenderSettings.md#gettagname)() | Returns the tag name of the region wrapper element. |
-| [setAttributes](dw.experience.RegionRenderSettings.md#setattributesobject)([Object](TopLevel.Object.md)) | Sets the to be configured <String,String> attributes of the wrapper element. |
-| [setComponentRenderSettings](dw.experience.RegionRenderSettings.md#setcomponentrendersettingscomponent-componentrendersettings)([Component](dw.experience.Component.md), [ComponentRenderSettings](dw.experience.ComponentRenderSettings.md)) | Sets the component render settings for the given component. |
-| [setDefaultComponentRenderSettings](dw.experience.RegionRenderSettings.md#setdefaultcomponentrendersettingscomponentrendersettings)([ComponentRenderSettings](dw.experience.ComponentRenderSettings.md)) | Sets the default component render settings. |
-| [setTagName](dw.experience.RegionRenderSettings.md#settagnamestring)([String](TopLevel.String.md)) | Sets the tag name of the region wrapper element. |
-
-### 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
-
-### attributes
-- attributes: [Object](TopLevel.Object.md)
-  - : Returns the configured attributes of the wrapper element as set by [setAttributes(Object)](dw.experience.RegionRenderSettings.md#setattributesobject).
-
-
----
-
-### defaultComponentRenderSettings
-- defaultComponentRenderSettings: [ComponentRenderSettings](dw.experience.ComponentRenderSettings.md)
-  - : Returns the default component render settings. These will be used during rendering of the components contained in
-      the region in case no dedicated component render settings were provided per component. If also no default is
-      supplied then the system default will be used during rendering.
-
-
-
----
-
-### tagName
-- tagName: [String](TopLevel.String.md)
-  - : Returns the tag name of the region wrapper element. Defaults to 'div'.
-
-
----
-
-## Constructor Details
-
-### RegionRenderSettings()
-- RegionRenderSettings()
-  - : Creates region render settings which can then be configured further. They are to be used for
-      [PageMgr.renderRegion(Region, RegionRenderSettings)](dw.experience.PageMgr.md#renderregionregion-regionrendersettings) calls.
-
-
-    **See Also:**
-    - [ComponentRenderSettings](dw.experience.ComponentRenderSettings.md)
-
-
----
-
-## Method Details
-
-### getAttributes()
-- getAttributes(): [Object](TopLevel.Object.md)
-  - : Returns the configured attributes of the wrapper element as set by [setAttributes(Object)](dw.experience.RegionRenderSettings.md#setattributesobject).
-
-    **Returns:**
-    - the configured attributes of the wrapper element
-
-
----
-
-### getComponentRenderSettings(Component)
-- getComponentRenderSettings(component: [Component](dw.experience.Component.md)): [ComponentRenderSettings](dw.experience.ComponentRenderSettings.md)
-  - : Returns the component render settings for the given component. In case no explicitly specified settings are found
-      for this component then the default one will be provided.
-
-
-    **Parameters:**
-    - component - the component to retrieve the render settings for
-
-    **Returns:**
-    - the component render settings or default component render settings if none were found for the given
-              component
-
-
-
----
-
-### getDefaultComponentRenderSettings()
-- getDefaultComponentRenderSettings(): [ComponentRenderSettings](dw.experience.ComponentRenderSettings.md)
-  - : Returns the default component render settings. These will be used during rendering of the components contained in
-      the region in case no dedicated component render settings were provided per component. If also no default is
-      supplied then the system default will be used during rendering.
-
-
-    **Returns:**
-    - the default component render settings
-
-
----
-
-### getTagName()
-- getTagName(): [String](TopLevel.String.md)
-  - : Returns the tag name of the region wrapper element. Defaults to 'div'.
-
-    **Returns:**
-    - the tag name of the region wrapper element
-
-
----
-
-### setAttributes(Object)
-- setAttributes(attributes: [Object](TopLevel.Object.md)): [RegionRenderSettings](dw.experience.RegionRenderSettings.md)
-  - : Sets the to be configured <String,String> attributes of the wrapper element. Set to `null` in case you
-      want to system defaults to be applied.
-
-
-    **Parameters:**
-    - attributes - the to be configured attributes of the wrapper element
-
-    **Returns:**
-    - this
-
-
----
-
-### setComponentRenderSettings(Component, ComponentRenderSettings)
-- setComponentRenderSettings(component: [Component](dw.experience.Component.md), componentRenderSettings: [ComponentRenderSettings](dw.experience.ComponentRenderSettings.md)): [RegionRenderSettings](dw.experience.RegionRenderSettings.md)
-  - : Sets the component render settings for the given component.
-
-    **Parameters:**
-    - component - the component to set the render settings for
-    - componentRenderSettings - the desired render settings
-
-    **Returns:**
-    - this
-
-
----
-
-### setDefaultComponentRenderSettings(ComponentRenderSettings)
-- setDefaultComponentRenderSettings(defaultComponentRenderSettings: [ComponentRenderSettings](dw.experience.ComponentRenderSettings.md)): [RegionRenderSettings](dw.experience.RegionRenderSettings.md)
-  - : Sets the default component render settings. These will be used during rendering of the components contained in
-      the region in case no dedicated component render settings were provided per component.
-
-
-    **Parameters:**
-    - defaultComponentRenderSettings - the default component render settings
-
-    **Returns:**
-    - this
-
-
----
-
-### setTagName(String)
-- setTagName(tagName: [String](TopLevel.String.md)): [RegionRenderSettings](dw.experience.RegionRenderSettings.md)
-  - : Sets the tag name of the region wrapper element. Must not be empty.
-
-    **Parameters:**
-    - tagName - the tag name of the region wrapper element
-
-    **Returns:**
-    - this
-
-
----
-
-<!-- prettier-ignore-end -->

package/data/script-api/dw.experience.cms.CMSRecord.md

@@ -1,125 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class CMSRecord
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.experience.cms.CMSRecord](dw.experience.cms.CMSRecord.md)
-
-This class represents a Salesforce CMS record, exposing its:
-
-- `id`, see [getID()](dw.experience.cms.CMSRecord.md#getid)
-- `type`, see [getType()](dw.experience.cms.CMSRecord.md#gettype)
-- `attributes`, see [getAttributes()](dw.experience.cms.CMSRecord.md#getattributes)
-
-The `attributes` are key value pairs:
-
-- the key being the attribute id as given in the `type.attribute_definitions`entries
-- the value being a DWScript API object resolved from the raw attribute value based on the attribute type as given in the `type.attribute_definitions`entries          (similar to how [ComponentScriptContext.getContent()](dw.experience.ComponentScriptContext.md#getcontent)exposes the raw attribute value of a [Component.getAttribute(String)](dw.experience.Component.md#getattributestring)in shape of a DWScript API object based on the attribute type)
-
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [ID](#id): [String](TopLevel.String.md) `(read-only)` | Return the id of the Salesforce CMS record. |
-| [attributes](#attributes): [Map](dw.util.Map.md) `(read-only)` | Return the Salesforce CMS record attributes as key value pairs:  <ul>      <li>the key being the attribute id as given in the `[getType()](dw.experience.cms.CMSRecord.md#gettype).attribute_definitions` entries</li>      <li>the value being a DWScript API object resolved from the raw attribute value based on the attribute type as given in the `[getType()](dw.experience.cms.CMSRecord.md#gettype).attribute_definitions` entries          (similar to how [ComponentScriptContext.getContent()](dw.experience.ComponentScriptContext.md#getcontent) exposes the raw attribute value of a [Component.getAttribute(String)](dw.experience.Component.md#getattributestring) in shape of a DWScript API object based on the attribute type)</li>  </ul>   The attributes are also conveniently accessible through named property support. |
-| [type](#type): [Map](dw.util.Map.md) `(read-only)` | Return the type of the Salesforce CMS record sufficing the `content/schema/cmsrecord.json#/definitions/cms_content_type` schema. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getAttributes](dw.experience.cms.CMSRecord.md#getattributes)() | Return the Salesforce CMS record attributes as key value pairs:  <ul>      <li>the key being the attribute id as given in the `[getType()](dw.experience.cms.CMSRecord.md#gettype).attribute_definitions` entries</li>      <li>the value being a DWScript API object resolved from the raw attribute value based on the attribute type as given in the `[getType()](dw.experience.cms.CMSRecord.md#gettype).attribute_definitions` entries          (similar to how [ComponentScriptContext.getContent()](dw.experience.ComponentScriptContext.md#getcontent) exposes the raw attribute value of a [Component.getAttribute(String)](dw.experience.Component.md#getattributestring) in shape of a DWScript API object based on the attribute type)</li>  </ul>   The attributes are also conveniently accessible through named property support. |
-| [getID](dw.experience.cms.CMSRecord.md#getid)() | Return the id of the Salesforce CMS record. |
-| [getType](dw.experience.cms.CMSRecord.md#gettype)() | Return the type of the Salesforce CMS record sufficing the `content/schema/cmsrecord.json#/definitions/cms_content_type` schema. |
-
-### 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)`
-  - : Return the id of the Salesforce CMS record.
-
-
----
-
-### attributes
-- attributes: [Map](dw.util.Map.md) `(read-only)`
-  - : Return the Salesforce CMS record attributes as key value pairs:
-      
-      - the key being the attribute id as given in the `[getType()](dw.experience.cms.CMSRecord.md#gettype).attribute_definitions`entries
-      - the value being a DWScript API object resolved from the raw attribute value based on the attribute type as given in the `[getType()](dw.experience.cms.CMSRecord.md#gettype).attribute_definitions`entries          (similar to how [ComponentScriptContext.getContent()](dw.experience.ComponentScriptContext.md#getcontent)exposes the raw attribute value of a [Component.getAttribute(String)](dw.experience.Component.md#getattributestring)in shape of a DWScript API object based on the attribute type)
-      
-      
-      The attributes are also conveniently accessible through named property support. That means if `myCmsRecord.getAttributes().get('foo')` yields value `'bar'`,
-      then `myCmsRecord.foo` will give the same results.
-
-
-
----
-
-### type
-- type: [Map](dw.util.Map.md) `(read-only)`
-  - : Return the type of the Salesforce CMS record sufficing the `content/schema/cmsrecord.json#/definitions/cms_content_type` schema. Properties
-      can be accessed accordingly:
-      
-      - `getType().id : string`
-      - `getType().name : string`
-      - `getType().attribute_definitions : Map`(see `content/schema/attributedefinition.json`)
-
-
-
----
-
-## Method Details
-
-### getAttributes()
-- getAttributes(): [Map](dw.util.Map.md)
-  - : Return the Salesforce CMS record attributes as key value pairs:
-      
-      - the key being the attribute id as given in the `[getType()](dw.experience.cms.CMSRecord.md#gettype).attribute_definitions`entries
-      - the value being a DWScript API object resolved from the raw attribute value based on the attribute type as given in the `[getType()](dw.experience.cms.CMSRecord.md#gettype).attribute_definitions`entries          (similar to how [ComponentScriptContext.getContent()](dw.experience.ComponentScriptContext.md#getcontent)exposes the raw attribute value of a [Component.getAttribute(String)](dw.experience.Component.md#getattributestring)in shape of a DWScript API object based on the attribute type)
-      
-      
-      The attributes are also conveniently accessible through named property support. That means if `myCmsRecord.getAttributes().get('foo')` yields value `'bar'`,
-      then `myCmsRecord.foo` will give the same results.
-
-
-    **Returns:**
-    - the cms record attributes
-
-
----
-
-### getID()
-- getID(): [String](TopLevel.String.md)
-  - : Return the id of the Salesforce CMS record.
-
-    **Returns:**
-    - the id of the Salesforce CMS record
-
-
----
-
-### getType()
-- getType(): [Map](dw.util.Map.md)
-  - : Return the type of the Salesforce CMS record sufficing the `content/schema/cmsrecord.json#/definitions/cms_content_type` schema. Properties
-      can be accessed accordingly:
-      
-      - `getType().id : string`
-      - `getType().name : string`
-      - `getType().attribute_definitions : Map`(see `content/schema/attributedefinition.json`)
-
-
-    **Returns:**
-    - the type of the cms record
-
-
----
-
-<!-- prettier-ignore-end -->

package/data/script-api/dw.experience.cms.md

@@ -1,6 +0,0 @@
-# Package dw.experience.cms
-
-## Classes
-| Class | Description |
-| --- | --- |
-| [CMSRecord](dw.experience.cms.CMSRecord.md) | This class represents a Salesforce CMS record, exposing its:  <ul>      <li>`id`, see [getID()](dw.experience.cms.CMSRecord.md#getid)</li>      <li>`type`, see [getType()](dw.experience.cms.CMSRecord.md#gettype)</li>      <li>`attributes`, see [getAttributes()](dw.experience.cms.CMSRecord.md#getattributes)</li>  </ul>  The `attributes` are key value pairs:  <ul>      <li>the key being the attribute id as given in the `type.attribute_definitions` entries</li>      <li>the value being a DWScript API object resolved from the raw attribute value based on the attribute type as given in the `type.attribute_definitions` entries          (similar to how [ComponentScriptContext.getContent()](dw.experience.ComponentScriptContext.md#getcontent) exposes the raw attribute value of a [Component.getAttribute(String)](dw.experience.Component.md#getattributestring) in shape of a DWScript API object based on the attribute type)</li>  </ul> |