@salesforce/b2c-tooling-sdk 1.19.1 → 1.20.0

package/data/script-api/dw.web.LoopIterator.md

@@ -1,231 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class LoopIterator
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.util.Iterator](dw.util.Iterator.md)
-    - [dw.web.LoopIterator](dw.web.LoopIterator.md)
-
-Iterator used in <ISLOOP> implementation. It defines properties used to determine loop status.
-LoopIterator object is assigned to variable declared in "status" attribute of the <ISLOOP> tag.
-
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [begin](#begin): [Number](TopLevel.Number.md) `(read-only)` | Return begin iteration index. |
-| [count](#count): [Number](TopLevel.Number.md) `(read-only)` | Return iteration count, starting with 1. |
-| [end](#end): [Number](TopLevel.Number.md) `(read-only)` | Return end iteration index. |
-| [even](#even): [Boolean](TopLevel.Boolean.md) `(read-only)` | Identifies if count is an even value. |
-| [first](#first): [Boolean](TopLevel.Boolean.md) `(read-only)` | Identifies if the iterator is positioned at first iteratable item. |
-| [index](#index): [Number](TopLevel.Number.md) `(read-only)` | Return iteration index, which is the position of the iterator in the underlying iteratable object. |
-| [last](#last): [Boolean](TopLevel.Boolean.md) `(read-only)` | Identifies if the iterator is positioned at last iteratable item. |
-| [length](#length): [Number](TopLevel.Number.md) `(read-only)` | Return the length of the object. |
-| [odd](#odd): [Boolean](TopLevel.Boolean.md) `(read-only)` | Identifies if count is an odd value. |
-| [step](#step): [Number](TopLevel.Number.md) `(read-only)` | Return iterator step. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getBegin](dw.web.LoopIterator.md#getbegin)() | Return begin iteration index. |
-| [getCount](dw.web.LoopIterator.md#getcount)() | Return iteration count, starting with 1. |
-| [getEnd](dw.web.LoopIterator.md#getend)() | Return end iteration index. |
-| [getIndex](dw.web.LoopIterator.md#getindex)() | Return iteration index, which is the position of the iterator in the underlying iteratable object. |
-| [getLength](dw.web.LoopIterator.md#getlength)() | Return the length of the object. |
-| [getStep](dw.web.LoopIterator.md#getstep)() | Return iterator step. |
-| [isEven](dw.web.LoopIterator.md#iseven)() | Identifies if count is an even value. |
-| [isFirst](dw.web.LoopIterator.md#isfirst)() | Identifies if the iterator is positioned at first iteratable item. |
-| [isLast](dw.web.LoopIterator.md#islast)() | Identifies if the iterator is positioned at last iteratable item. |
-| [isOdd](dw.web.LoopIterator.md#isodd)() | Identifies if count is an odd value. |
-
-### Methods inherited from class Iterator
-
-[asList](dw.util.Iterator.md#aslist), [asList](dw.util.Iterator.md#aslistnumber-number), [hasNext](dw.util.Iterator.md#hasnext), [next](dw.util.Iterator.md#next)
-### 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
-
-### begin
-- begin: [Number](TopLevel.Number.md) `(read-only)`
-  - : Return begin iteration index. By default begin index is 0.
-
-
----
-
-### count
-- count: [Number](TopLevel.Number.md) `(read-only)`
-  - : Return iteration count, starting with 1.
-
-
----
-
-### end
-- end: [Number](TopLevel.Number.md) `(read-only)`
-  - : Return end iteration index. By default end index equals 'length - 1', provided that length is determined.
-      If length cannot be determined end index is -1.
-
-
-
----
-
-### even
-- even: [Boolean](TopLevel.Boolean.md) `(read-only)`
-  - : Identifies if count is an even value.
-
-
----
-
-### first
-- first: [Boolean](TopLevel.Boolean.md) `(read-only)`
-  - : Identifies if the iterator is positioned at first iteratable item.
-
-
----
-
-### index
-- index: [Number](TopLevel.Number.md) `(read-only)`
-  - : Return iteration index, which is the position of the iterator in the underlying iteratable object.
-      Index is 0-based and is calculated according the following formula: Index = (Count - 1) \* Step.
-
-
-
----
-
-### last
-- last: [Boolean](TopLevel.Boolean.md) `(read-only)`
-  - : Identifies if the iterator is positioned at last iteratable item.
-
-
----
-
-### length
-- length: [Number](TopLevel.Number.md) `(read-only)`
-  - : Return the length of the object. If length cannot be determined, -1 is returned.
-
-
----
-
-### odd
-- odd: [Boolean](TopLevel.Boolean.md) `(read-only)`
-  - : Identifies if count is an odd value.
-
-
----
-
-### step
-- step: [Number](TopLevel.Number.md) `(read-only)`
-  - : Return iterator step.
-
-
----
-
-## Method Details
-
-### getBegin()
-- getBegin(): [Number](TopLevel.Number.md)
-  - : Return begin iteration index. By default begin index is 0.
-
-    **Returns:**
-    - the begin iteration index.
-
-
----
-
-### getCount()
-- getCount(): [Number](TopLevel.Number.md)
-  - : Return iteration count, starting with 1.
-
-    **Returns:**
-    - the iteration count.
-
-
----
-
-### getEnd()
-- getEnd(): [Number](TopLevel.Number.md)
-  - : Return end iteration index. By default end index equals 'length - 1', provided that length is determined.
-      If length cannot be determined end index is -1.
-
-
-
----
-
-### getIndex()
-- getIndex(): [Number](TopLevel.Number.md)
-  - : Return iteration index, which is the position of the iterator in the underlying iteratable object.
-      Index is 0-based and is calculated according the following formula: Index = (Count - 1) \* Step.
-
-
-    **Returns:**
-    - the iteration index.
-
-
----
-
-### getLength()
-- getLength(): [Number](TopLevel.Number.md)
-  - : Return the length of the object. If length cannot be determined, -1 is returned.
-
-    **Returns:**
-    - the length of the object
-
-
----
-
-### getStep()
-- getStep(): [Number](TopLevel.Number.md)
-  - : Return iterator step.
-
-    **Returns:**
-    - the iterator step.
-
-
----
-
-### isEven()
-- isEven(): [Boolean](TopLevel.Boolean.md)
-  - : Identifies if count is an even value.
-
-    **Returns:**
-    - true if count is even, false otherwise.
-
-
----
-
-### isFirst()
-- isFirst(): [Boolean](TopLevel.Boolean.md)
-  - : Identifies if the iterator is positioned at first iteratable item.
-
-    **Returns:**
-    - true if the iterator is at first item, false otherwise.
-
-
----
-
-### isLast()
-- isLast(): [Boolean](TopLevel.Boolean.md)
-  - : Identifies if the iterator is positioned at last iteratable item.
-
-    **Returns:**
-    - true if iterator is at last item, false otherwise.
-
-
----
-
-### isOdd()
-- isOdd(): [Boolean](TopLevel.Boolean.md)
-  - : Identifies if count is an odd value.
-
-    **Returns:**
-    - true if count is odd, false otherwise.
-
-
----
-
-<!-- prettier-ignore-end -->

package/data/script-api/dw.web.PageMetaData.md

@@ -1,197 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class PageMetaData
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.web.PageMetaData](dw.web.PageMetaData.md)
-
-Contains meta data about the page.
-
-For each request an instance of this class will be placed in the pipeline
-dictionary under the key "CurrentPageMetaData".
-The information stored in CurrentPageMetaData can be referenced in templates
-and rendered in an HTML head section:
-for example:
-
-```
-
-<head>
-<title>${pdict.CurrentPageMetaData.title}</title>
-<meta name="description" content="${pdict.CurrentPageMetaData.description}"/>
-.
-.
-.
-</head>
-```
-
-
-To update the CurrentPageMetaData there is the pipelet UpdatePageMetaData
-provided.
-
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [description](#description): [String](TopLevel.String.md) | Returns the page's description. |
-| [keywords](#keywords): [String](TopLevel.String.md) | Returns the page's key words. |
-| [pageMetaTags](#pagemetatags): [Array](TopLevel.Array.md) `(read-only)` | Returns all page meta tags added to this container. |
-| [title](#title): [String](TopLevel.String.md) | Returns the page's title. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [addPageMetaTag](dw.web.PageMetaData.md#addpagemetatagpagemetatag)([PageMetaTag](dw.web.PageMetaTag.md)) | Adds a page meta tag to this container. |
-| [addPageMetaTags](dw.web.PageMetaData.md#addpagemetatagsarray)([Array](TopLevel.Array.md)) | Adds a page meta tags list to this container. |
-| [getDescription](dw.web.PageMetaData.md#getdescription)() | Returns the page's description. |
-| [getKeywords](dw.web.PageMetaData.md#getkeywords)() | Returns the page's key words. |
-| [getPageMetaTags](dw.web.PageMetaData.md#getpagemetatags)() | Returns all page meta tags added to this container. |
-| [getTitle](dw.web.PageMetaData.md#gettitle)() | Returns the page's title. |
-| [isPageMetaTagSet](dw.web.PageMetaData.md#ispagemetatagsetstring)([String](TopLevel.String.md)) | Returns true if a page meta tag with the given ID is set, false otherwise. |
-| [setDescription](dw.web.PageMetaData.md#setdescriptionstring)([String](TopLevel.String.md)) | Sets the page's description. |
-| [setKeywords](dw.web.PageMetaData.md#setkeywordsstring)([String](TopLevel.String.md)) | Sets the page's key words. |
-| [setTitle](dw.web.PageMetaData.md#settitlestring)([String](TopLevel.String.md)) | Sets the page's title. |
-
-### 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
-
-### description
-- description: [String](TopLevel.String.md)
-  - : Returns the page's description.
-
-
----
-
-### keywords
-- keywords: [String](TopLevel.String.md)
-  - : Returns the page's key words.
-
-
----
-
-### pageMetaTags
-- pageMetaTags: [Array](TopLevel.Array.md) `(read-only)`
-  - : Returns all page meta tags added to this container.
-
-
----
-
-### title
-- title: [String](TopLevel.String.md)
-  - : Returns the page's title.
-
-
----
-
-## Method Details
-
-### addPageMetaTag(PageMetaTag)
-- addPageMetaTag(pageMetaTag: [PageMetaTag](dw.web.PageMetaTag.md)): void
-  - : Adds a page meta tag to this container.
-
-    **Parameters:**
-    - pageMetaTag - the page meta tag to be added
-
-
----
-
-### addPageMetaTags(Array)
-- addPageMetaTags(pageMetaTags: [Array](TopLevel.Array.md)): void
-  - : Adds a page meta tags list to this container.
-
-    **Parameters:**
-    - pageMetaTags - the page meta tags list to be added
-
-
----
-
-### getDescription()
-- getDescription(): [String](TopLevel.String.md)
-  - : Returns the page's description.
-
-    **Returns:**
-    - the page's description.
-
-
----
-
-### getKeywords()
-- getKeywords(): [String](TopLevel.String.md)
-  - : Returns the page's key words.
-
-    **Returns:**
-    - the page's key words.
-
-
----
-
-### getPageMetaTags()
-- getPageMetaTags(): [Array](TopLevel.Array.md)
-  - : Returns all page meta tags added to this container.
-
-    **Returns:**
-    - page meta tags
-
-
----
-
-### getTitle()
-- getTitle(): [String](TopLevel.String.md)
-  - : Returns the page's title.
-
-    **Returns:**
-    - the page's title.
-
-
----
-
-### isPageMetaTagSet(String)
-- isPageMetaTagSet(id: [String](TopLevel.String.md)): [Boolean](TopLevel.Boolean.md)
-  - : Returns true if a page meta tag with the given ID is set, false otherwise.
-
-    **Parameters:**
-    - id - the ID to be check if a page meta tag is set
-
-    **Returns:**
-    - true if a page meta tag with the given ID is set, false otherwise
-
-
----
-
-### setDescription(String)
-- setDescription(description: [String](TopLevel.String.md)): void
-  - : Sets the page's description.
-
-    **Parameters:**
-    - description - the page's description.
-
-
----
-
-### setKeywords(String)
-- setKeywords(keywords: [String](TopLevel.String.md)): void
-  - : Sets the page's key words.
-
-    **Parameters:**
-    - keywords - the page's key words.
-
-
----
-
-### setTitle(String)
-- setTitle(title: [String](TopLevel.String.md)): void
-  - : Sets the page's title.
-
-    **Parameters:**
-    - title - the page's title.
-
-
----
-
-<!-- prettier-ignore-end -->

package/data/script-api/dw.web.PageMetaTag.md

@@ -1,173 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class PageMetaTag
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.web.PageMetaTag](dw.web.PageMetaTag.md)
-
-Page meta tags are used in HTML documents to provide structured data about a web
-page. They are usually part of the head section. Common tags are for example robots,
-description or social tags like open graph (e.g. 'og:title'), or additionally
-adding json-ld (JSON for linked data) and provides structured data that is easily crawlable. 
-
-
-Page meta tags can be obtained within:
-
-
-- home page context
-
-- [Site](dw.system.Site.md)
-- detail page context
-
-- [Product](dw.catalog.Product.md)
-- [Content](dw.content.Content.md)
-- listing page context
-
-- [ProductSearchModel](dw.catalog.ProductSearchModel.md)
-- [ContentSearchModel](dw.content.ContentSearchModel.md)
-
-
-and can be set at [PageMetaData](dw.web.PageMetaData.md) container object, which is always available
-in the pipeline dictionary and is used as transfer object to fill the head area with meaningful
-page meta tag elements.
-
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [ID](#id): [String](TopLevel.String.md) `(read-only)` | Returns the page meta tag ID. |
-| [content](#content): [String](TopLevel.String.md) `(read-only)` | Returns the page meta tag content. |
-| [jsonLd](#jsonld): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns true if the page meta tag type is json-ld (JSON for linked data) and provides  structured data about the page for crawlers, false otherwise. |
-| [name](#name): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns true if the page meta tag type is name, false otherwise. |
-| [property](#property): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns true if the page meta tag type is property, false otherwise. |
-| [title](#title): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns true if the page meta tag type is title, false otherwise. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getContent](dw.web.PageMetaTag.md#getcontent)() | Returns the page meta tag content. |
-| [getID](dw.web.PageMetaTag.md#getid)() | Returns the page meta tag ID. |
-| [isJsonLd](dw.web.PageMetaTag.md#isjsonld)() | Returns true if the page meta tag type is json-ld (JSON for linked data) and provides  structured data about the page for crawlers, false otherwise. |
-| [isName](dw.web.PageMetaTag.md#isname)() | Returns true if the page meta tag type is name, false otherwise. |
-| [isProperty](dw.web.PageMetaTag.md#isproperty)() | Returns true if the page meta tag type is property, false otherwise. |
-| [isTitle](dw.web.PageMetaTag.md#istitle)() | Returns true if the page meta tag type is title, false otherwise. |
-
-### 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 page meta tag ID.
-
-
----
-
-### content
-- content: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the page meta tag content.
-
-
----
-
-### jsonLd
-- jsonLd: [Boolean](TopLevel.Boolean.md) `(read-only)`
-  - : Returns true if the page meta tag type is json-ld (JSON for linked data) and provides
-      structured data about the page for crawlers, false otherwise.
-
-
-
----
-
-### name
-- name: [Boolean](TopLevel.Boolean.md) `(read-only)`
-  - : Returns true if the page meta tag type is name, false otherwise.
-
-
----
-
-### property
-- property: [Boolean](TopLevel.Boolean.md) `(read-only)`
-  - : Returns true if the page meta tag type is property, false otherwise.
-
-
----
-
-### title
-- title: [Boolean](TopLevel.Boolean.md) `(read-only)`
-  - : Returns true if the page meta tag type is title, false otherwise.
-
-
----
-
-## Method Details
-
-### getContent()
-- getContent(): [String](TopLevel.String.md)
-  - : Returns the page meta tag content.
-
-    **Returns:**
-    - page meta tag content
-
-
----
-
-### getID()
-- getID(): [String](TopLevel.String.md)
-  - : Returns the page meta tag ID.
-
-    **Returns:**
-    - page meta tag ID
-
-
----
-
-### isJsonLd()
-- isJsonLd(): [Boolean](TopLevel.Boolean.md)
-  - : Returns true if the page meta tag type is json-ld (JSON for linked data) and provides
-      structured data about the page for crawlers, false otherwise.
-
-
-    **Returns:**
-    - true if the page meta tag type is json-ld, false otherwise
-
-
----
-
-### isName()
-- isName(): [Boolean](TopLevel.Boolean.md)
-  - : Returns true if the page meta tag type is name, false otherwise.
-
-    **Returns:**
-    - true if the page meta tag type is name, false otherwise
-
-
----
-
-### isProperty()
-- isProperty(): [Boolean](TopLevel.Boolean.md)
-  - : Returns true if the page meta tag type is property, false otherwise.
-
-    **Returns:**
-    - true if the page meta tag type is property, false otherwise
-
-
----
-
-### isTitle()
-- isTitle(): [Boolean](TopLevel.Boolean.md)
-  - : Returns true if the page meta tag type is title, false otherwise.
-
-    **Returns:**
-    - true if the page meta tag type is title, false otherwise
-
-
----
-
-<!-- prettier-ignore-end -->