@salesforce/b2c-tooling-sdk 1.19.0 → 1.20.0

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

@@ -1,174 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class URL
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.web.URL](dw.web.URL.md)
-
-Represents a URL in Commerce Cloud Digital.
-
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [abs](dw.web.URL.md#abs)() | Makes the URL absolute and ensures that the protocol of the request is used  or http in a mail context. |
-| [append](dw.web.URL.md#appendstring-string)([String](TopLevel.String.md), [String](TopLevel.String.md)) | Append a request parameter to this URL. |
-| [appendCSRFTokenBM](dw.web.URL.md#appendcsrftokenbm)() | <p>Appends, if applicable, a CSRF protection token to this URL. |
-| [host](dw.web.URL.md#hoststring)([String](TopLevel.String.md)) | Updates the URL with the specified host name  Note: This method is not applicable for static content or image transformation  URLs. |
-| [http](dw.web.URL.md#http)() | Makes the URL absolute and ensures that the protocol http is used. |
-| [https](dw.web.URL.md#https)() | Makes the URL absolute and ensures that the protocol https is used. |
-| [relative](dw.web.URL.md#relative)() | Makes the URL relative. |
-| [remove](dw.web.URL.md#removestring)([String](TopLevel.String.md)) | Remove a request parameter from this URL. |
-| [siteHost](dw.web.URL.md#sitehost)() | Updates the URL with the site host name  Note: This method is not applicable for static content or image transformation  URLs. |
-| [toString](dw.web.URL.md#tostring)() | Return String representation of the URL. |
-
-### 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)
-## Method Details
-
-### abs()
-- abs(): [URL](dw.web.URL.md)
-  - : Makes the URL absolute and ensures that the protocol of the request is used
-      or http in a mail context.
-      Note: This method is not applicable for static content or image transformation
-      URLs. In this case a runtime exception is thrown.
-
-
-    **Returns:**
-    - A new URL instance.
-
-
----
-
-### append(String, String)
-- append(name: [String](TopLevel.String.md), value: [String](TopLevel.String.md)): [URL](dw.web.URL.md)
-  - : Append a request parameter to this URL.
-
-    **Parameters:**
-    - name - The parameter name.  Must not be null.
-    - value - The parameter value.  If null, then treated as empty value.
-
-    **Returns:**
-    - A reference to this URL.
-
-
----
-
-### appendCSRFTokenBM()
-- appendCSRFTokenBM(): [URL](dw.web.URL.md)
-  - : 
-      Appends, if applicable, a CSRF protection token to this URL. The CSRF token will only be appended under the following conditions:
-      
-      
-      - the URL is a pipeline URL
-      - the URL is for Business Manager
-      
-      
-      
-      If a CSRF token already exists in the URL, it will be replaced with a newly generated one.
-
-
-    **Returns:**
-    - a reference to this URL, with a CSRF token appended if applicable.
-
-
----
-
-### host(String)
-- host(host: [String](TopLevel.String.md)): [URL](dw.web.URL.md)
-  - : Updates the URL with the specified host name
-      Note: This method is not applicable for static content or image transformation
-      URLs. In this case a runtime exception is thrown.
-
-
-    **Parameters:**
-    - host - The host name that is used to update the URL.
-
-    **Returns:**
-    - A new URL instance.
-
-
----
-
-### http()
-- http(): [URL](dw.web.URL.md)
-  - : Makes the URL absolute and ensures that the protocol http is used.
-      Note: This method is not applicable for static content or image transformation
-      URLs. In this case a runtime exception is thrown.
-
-
-    **Returns:**
-    - A new URL instance.
-
-
----
-
-### https()
-- https(): [URL](dw.web.URL.md)
-  - : Makes the URL absolute and ensures that the protocol https is used.
-      Note: This method is not applicable for static content or image transformation
-      URLs. In this case a runtime exception is thrown.
-
-
-    **Returns:**
-    - A new URL instance.
-
-
----
-
-### relative()
-- relative(): [URL](dw.web.URL.md)
-  - : Makes the URL relative.
-      Note: This method is not applicable for static content or image transformation
-      URLs. In this case a runtime exception is thrown.
-
-
-    **Returns:**
-    - A new URL instance.
-
-
----
-
-### remove(String)
-- remove(name: [String](TopLevel.String.md)): [URL](dw.web.URL.md)
-  - : Remove a request parameter from this URL. If the parameter is not part
-      of the URL, nothing is done.
-
-
-    **Parameters:**
-    - name - The parameter name.  Must not be null.
-
-    **Returns:**
-    - A reference to this URL.
-
-
----
-
-### siteHost()
-- siteHost(): [URL](dw.web.URL.md)
-  - : Updates the URL with the site host name
-      Note: This method is not applicable for static content or image transformation
-      URLs. In this case a runtime exception is thrown.
-
-
-    **Returns:**
-    - A new URL instance.
-
-
----
-
-### toString()
-- toString(): [String](TopLevel.String.md)
-  - : Return String representation of the URL.
-
-    **Returns:**
-    - the URL as a string.
-
-
----
-
-<!-- prettier-ignore-end -->

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

@@ -1,95 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class URLAction
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.web.URLAction](dw.web.URLAction.md)
-
-The class is needed for the URL creation within template processing. It
-represents a reference to a pipeline name and start node, usually used in a
-HREF or a FORM action. URLAction instances are usually passed to one of the
-methods in [URLUtils](dw.web.URLUtils.md) in order to generate an appropriately
-constructed Commerce Cloud Digital URL.  For example:
-
-
-`
-  var urlAction : URLAction = new URLAction("SimplePipeline-Start", "SampleSite");
-
-  var url : URL = URLUtils.abs(false, urlAction1);
-
-  // url.toString() equals "http://" + request.httpHost + "/on/demandware.store/Sites-SampleSite-Site/default/SimplePipeline-Start"
-
- `
-
-
-
-## Constructor Summary
-
-| Constructor | Description |
-| --- | --- |
-| [URLAction](#urlactionstring)([String](TopLevel.String.md)) | Constructs an action for the current site and locale. |
-| [URLAction](#urlactionstring-string)([String](TopLevel.String.md), [String](TopLevel.String.md)) | Constructs an action for the specified site and the current locale. |
-| [URLAction](#urlactionstring-string-string)([String](TopLevel.String.md), [String](TopLevel.String.md), [String](TopLevel.String.md)) | Constructs an action for the specified site and locale. |
-| [URLAction](#urlactionstring-string-string-string)([String](TopLevel.String.md), [String](TopLevel.String.md), [String](TopLevel.String.md), [String](TopLevel.String.md)) | Constructs an URL action for the specified site, locale and hostname. |
-
-## 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)
-## Constructor Details
-
-### URLAction(String)
-- URLAction(action: [String](TopLevel.String.md))
-  - : Constructs an action for the current site and locale.
-
-    **Parameters:**
-    - action - the target pipeline/controller, e.g. 'Default-Start'
-
-
----
-
-### URLAction(String, String)
-- URLAction(action: [String](TopLevel.String.md), siteName: [String](TopLevel.String.md))
-  - : Constructs an action for the specified site and the current locale.
-
-    **Parameters:**
-    - action - the target pipeline/controller, e.g. 'Default-Start'
-    - siteName - the target site, e.g. 'SampleSite'
-
-
----
-
-### URLAction(String, String, String)
-- URLAction(action: [String](TopLevel.String.md), siteName: [String](TopLevel.String.md), locale: [String](TopLevel.String.md))
-  - : Constructs an action for the specified site and locale.
-
-    **Parameters:**
-    - action - the target pipeline/controller, e.g.: 'Default-Start'
-    - siteName - the target site, e.g. 'SampleSite'
-    - locale - the target locale, e.g. 'default'
-
-
----
-
-### URLAction(String, String, String, String)
-- URLAction(action: [String](TopLevel.String.md), siteName: [String](TopLevel.String.md), locale: [String](TopLevel.String.md), hostName: [String](TopLevel.String.md))
-  - : Constructs an URL action for the specified site, locale and hostname. 
-      
-      The hostname must be defined in the site alias settings. If no hostname is provided, the HTTP/HTTPS
-      host defined in the site alias settings will be used. If no HTTP/HTTPS host is defined in the site alias
-      settings, the hostname of the current request is used.
-
-
-    **Parameters:**
-    - action - the target pipeline/controller, e.g.: 'Default-Start'
-    - siteName - the target site, e.g. 'SampleSite'
-    - locale - the target locale, e.g. 'default'
-    - hostName - the host name, e.g. ‘www.shop.com'
-
-    **Throws:**
-    - Exception - if hostName is not defined in site alias settings
-
-
----
-
-<!-- prettier-ignore-end -->

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

@@ -1,52 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class URLParameter
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.web.URLParameter](dw.web.URLParameter.md)
-
-This class represents a key-value-pair for URL parameters.
-
-
-## Constructor Summary
-
-| Constructor | Description |
-| --- | --- |
-| [URLParameter](#urlparameterstring-string)([String](TopLevel.String.md), [String](TopLevel.String.md)) | Constructs the parameter using the specified name and value and endocded  in the form "name=value". |
-| [URLParameter](#urlparameterstring-string-boolean)([String](TopLevel.String.md), [String](TopLevel.String.md), [Boolean](TopLevel.Boolean.md)) | Constructs the parameter using the specified name and value. |
-
-## 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)
-## Constructor Details
-
-### URLParameter(String, String)
-- URLParameter(aName: [String](TopLevel.String.md), aValue: [String](TopLevel.String.md))
-  - : Constructs the parameter using the specified name and value and endocded
-      in the form "name=value".
-
-
-    **Parameters:**
-    - aName - the name
-    - aValue - the value
-
-
----
-
-### URLParameter(String, String, Boolean)
-- URLParameter(aName: [String](TopLevel.String.md), aValue: [String](TopLevel.String.md), encodeName: [Boolean](TopLevel.Boolean.md))
-  - : Constructs the parameter using the specified name and value. If the "encodeName" is set to true,
-      the parameter is encoded in the form "name=value". Otherwise, it only
-      contains the "value" (needed for URL patterns).
-
-
-    **Parameters:**
-    - aName - the name
-    - aValue - the value
-    - encodeName - if true, the name will be part of the string form
-
-
----
-
-<!-- prettier-ignore-end -->

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

@@ -1,72 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class URLRedirect
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.web.URLRedirect](dw.web.URLRedirect.md)
-
-Represents a URLRedirect in Commerce Cloud Digital.
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [location](#location): [String](TopLevel.String.md) `(read-only)` | Returns the URL which was calculated to be the redirect URL. |
-| [status](#status): [Number](TopLevel.Number.md) `(read-only)` | Returns the corresponding status code for the redirect location. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getLocation](dw.web.URLRedirect.md#getlocation)() | Returns the URL which was calculated to be the redirect URL. |
-| [getStatus](dw.web.URLRedirect.md#getstatus)() | Returns the corresponding status code for the redirect location. |
-
-### 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
-
-### location
-- location: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the URL which was calculated to be the redirect URL.
-      The Location parameter can be directly used as value for an redirect location.
-
-
-
----
-
-### status
-- status: [Number](TopLevel.Number.md) `(read-only)`
-  - : Returns the corresponding status code for the redirect location.
-
-
----
-
-## Method Details
-
-### getLocation()
-- getLocation(): [String](TopLevel.String.md)
-  - : Returns the URL which was calculated to be the redirect URL.
-      The Location parameter can be directly used as value for an redirect location.
-
-
-    **Returns:**
-    - redirect location
-
-
----
-
-### getStatus()
-- getStatus(): [Number](TopLevel.Number.md)
-  - : Returns the corresponding status code for the redirect location.
-
-    **Returns:**
-    - status code
-
-
----
-
-<!-- prettier-ignore-end -->

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

@@ -1,86 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class URLRedirectMgr
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.web.URLRedirectMgr](dw.web.URLRedirectMgr.md)
-
-URLRedirect manager class. Methods in this class generate URLRedirects based on the
-current configuration for Static, Dynamic and URLRedirect mappings in Commerce
-Cloud Digital.
-
-Information used to calculate URLRedirects are determined from the current HTTP
-request. The URL which is used to find a redirect can be accessed with [getRedirectOrigin()](dw.web.URLRedirectMgr.md#getredirectorigin).
-
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [redirect](#redirect): [URLRedirect](dw.web.URLRedirect.md) `(read-only)` | Returns an URLRedirect object, containing a location and status. |
-| [redirectOrigin](#redirectorigin): [String](TopLevel.String.md) `(read-only)` | Returns the relative origin url (without protocol, port, hostname and site path information)  which will be used in [getRedirect()](dw.web.URLRedirectMgr.md#getredirect) to calculate a redirect location for. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| static [getRedirect](dw.web.URLRedirectMgr.md#getredirect)() | Returns an URLRedirect object, containing a location and status. |
-| static [getRedirectOrigin](dw.web.URLRedirectMgr.md#getredirectorigin)() | Returns the relative origin url (without protocol, port, hostname and site path information)  which will be used in [getRedirect()](dw.web.URLRedirectMgr.md#getredirect) to calculate a redirect location for. |
-
-### 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
-
-### redirect
-- redirect: [URLRedirect](dw.web.URLRedirect.md) `(read-only)`
-  - : Returns an URLRedirect object, containing a location and status. The redirect is calculated
-      based on origin url of current request and the configured Static, Dynamic and URLRedirect mappings for
-      the requested site.
-
-
-
----
-
-### redirectOrigin
-- redirectOrigin: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the relative origin url (without protocol, port, hostname and site path information)
-      which will be used in [getRedirect()](dw.web.URLRedirectMgr.md#getredirect) to calculate a redirect location for.
-
-
-
----
-
-## Method Details
-
-### getRedirect()
-- static getRedirect(): [URLRedirect](dw.web.URLRedirect.md)
-  - : Returns an URLRedirect object, containing a location and status. The redirect is calculated
-      based on origin url of current request and the configured Static, Dynamic and URLRedirect mappings for
-      the requested site.
-
-
-    **Returns:**
-    - URLRedirect containing the location and status code,
-        null in case of no redirect was found
-
-
-
----
-
-### getRedirectOrigin()
-- static getRedirectOrigin(): [String](TopLevel.String.md)
-  - : Returns the relative origin url (without protocol, port, hostname and site path information)
-      which will be used in [getRedirect()](dw.web.URLRedirectMgr.md#getredirect) to calculate a redirect location for.
-
-
-    **Returns:**
-    - relative origin url
-
-
----
-
-<!-- prettier-ignore-end -->