@salesforce/b2c-tooling-sdk 1.19.1 → 1.20.0

package/data/script-api/dw.value.Quantity.md

@@ -1,299 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class Quantity
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.value.Quantity](dw.value.Quantity.md)
-
-Represents the quantity of an item.
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [available](#available): [Boolean](TopLevel.Boolean.md) `(read-only)` | Identifies if the instance contains settings for value and unit. |
-| [decimalValue](#decimalvalue): [Decimal](dw.util.Decimal.md) `(read-only)` | Returns the quantity as [Decimal](dw.util.Decimal.md), `null` is returned when the quantity is not available. |
-| [unit](#unit): [String](TopLevel.String.md) `(read-only)` | Returns the value for unit which identifies the  unit of measure for the quantity. |
-| [value](#value): [Number](TopLevel.Number.md) `(read-only)` | Returns the quantity value. |
-
-## Constructor Summary
-
-| Constructor | Description |
-| --- | --- |
-| [Quantity](#quantitynumber-string)([Number](TopLevel.Number.md), [String](TopLevel.String.md)) | Creates a new quantity instance with the specified value and unit. |
-
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [add](dw.value.Quantity.md#addquantity)([Quantity](dw.value.Quantity.md)) | Add Quantity object to the current object. |
-| [compareTo](dw.value.Quantity.md#comparetoquantity)([Quantity](dw.value.Quantity.md)) | Compares two Quantity values. |
-| [divide](dw.value.Quantity.md#dividenumber)([Number](TopLevel.Number.md)) | Divide Quantity object by specified divisor. |
-| [equals](dw.value.Quantity.md#equalsobject)([Object](TopLevel.Object.md)) | Compares two decimal values whether they are equivalent. |
-| [getDecimalValue](dw.value.Quantity.md#getdecimalvalue)() | Returns the quantity as [Decimal](dw.util.Decimal.md), `null` is returned when the quantity is not available. |
-| [getUnit](dw.value.Quantity.md#getunit)() | Returns the value for unit which identifies the  unit of measure for the quantity. |
-| [getValue](dw.value.Quantity.md#getvalue)() | Returns the quantity value. |
-| [hashCode](dw.value.Quantity.md#hashcode)() | Calculates the hash code for a decimal. |
-| [isAvailable](dw.value.Quantity.md#isavailable)() | Identifies if the instance contains settings for value and unit. |
-| [isOfSameUnit](dw.value.Quantity.md#isofsameunitquantity)([Quantity](dw.value.Quantity.md)) | Identifies if two Quantities have the same unit. |
-| [multiply](dw.value.Quantity.md#multiplynumber)([Number](TopLevel.Number.md)) | Multiply Quantity object by specified factor. |
-| [newQuantity](dw.value.Quantity.md#newquantitydecimal)([Decimal](dw.util.Decimal.md)) | Method returns a new instance of Quantity with the same unit but  different value. |
-| [round](dw.value.Quantity.md#roundnumber)([Number](TopLevel.Number.md)) | Rounds the Quantity value to the number of specified decimal digits. |
-| [subtract](dw.value.Quantity.md#subtractquantity)([Quantity](dw.value.Quantity.md)) | Subtract Quantity object from the current object. |
-| [toString](dw.value.Quantity.md#tostring)() | Returns a string representation of this quantity object. |
-| [valueOf](dw.value.Quantity.md#valueof)() | According to the ECMA spec returns the "natural" primitive value. |
-
-### 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
-
-### available
-- available: [Boolean](TopLevel.Boolean.md) `(read-only)`
-  - : Identifies if the instance contains settings for value and unit.
-
-
----
-
-### decimalValue
-- decimalValue: [Decimal](dw.util.Decimal.md) `(read-only)`
-  - : Returns the quantity as [Decimal](dw.util.Decimal.md), `null` is returned when the quantity is not available.
-
-
----
-
-### unit
-- unit: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the value for unit which identifies the
-      unit of measure for the quantity. Examples of unit
-      are 'inches' or 'pounds'.
-
-
-
----
-
-### value
-- value: [Number](TopLevel.Number.md) `(read-only)`
-  - : Returns the quantity value.
-
-    **See Also:**
-    - [getDecimalValue()](dw.value.Quantity.md#getdecimalvalue)
-
-
----
-
-## Constructor Details
-
-### Quantity(Number, String)
-- Quantity(value: [Number](TopLevel.Number.md), unit: [String](TopLevel.String.md))
-  - : Creates a new quantity instance with the specified value and unit.
-
-    **Parameters:**
-    - value - the actual quantity, must not be `null`
-    - unit - the unit identifier for the quantity, must not be `null`
-
-
----
-
-## Method Details
-
-### add(Quantity)
-- add(value: [Quantity](dw.value.Quantity.md)): [Quantity](dw.value.Quantity.md)
-  - : Add Quantity object to the current object. Only objects representing the same unit can be added.
-
-    **Parameters:**
-    - value - Quantity object
-
-    **Returns:**
-    - Quantity object representing the sum of the operands
-
-
----
-
-### compareTo(Quantity)
-- compareTo(other: [Quantity](dw.value.Quantity.md)): [Number](TopLevel.Number.md)
-  - : Compares two Quantity values. An exception is thrown if the two Quantities values
-      are of different unit. If one of the Quantity values represents the N/A value
-      it is treated as 0.0.
-
-
-    **Parameters:**
-    - other - the other quantity to compare.
-
-    **Returns:**
-    - the comparison.
-
-
----
-
-### divide(Number)
-- divide(divisor: [Number](TopLevel.Number.md)): [Quantity](dw.value.Quantity.md)
-  - : Divide Quantity object by specified divisor.
-
-    **Parameters:**
-    - divisor - divisor
-
-    **Returns:**
-    - Quantity object representing division result
-
-
----
-
-### equals(Object)
-- equals(other: [Object](TopLevel.Object.md)): [Boolean](TopLevel.Boolean.md)
-  - : Compares two decimal values whether they are equivalent.
-
-    **Parameters:**
-    - other - the object to compare against this quantity instance.
-
-    **Returns:**
-    - true if equal, false otherwise.
-
-
----
-
-### getDecimalValue()
-- getDecimalValue(): [Decimal](dw.util.Decimal.md)
-  - : Returns the quantity as [Decimal](dw.util.Decimal.md), `null` is returned when the quantity is not available.
-
-    **Returns:**
-    - the quantity as [Decimal](dw.util.Decimal.md)
-
-
----
-
-### getUnit()
-- getUnit(): [String](TopLevel.String.md)
-  - : Returns the value for unit which identifies the
-      unit of measure for the quantity. Examples of unit
-      are 'inches' or 'pounds'.
-
-
-    **Returns:**
-    - the unit value.
-
-
----
-
-### getValue()
-- getValue(): [Number](TopLevel.Number.md)
-  - : Returns the quantity value.
-
-    **Returns:**
-    - the quantity value.
-
-    **See Also:**
-    - [getDecimalValue()](dw.value.Quantity.md#getdecimalvalue)
-
-
----
-
-### hashCode()
-- hashCode(): [Number](TopLevel.Number.md)
-  - : Calculates the hash code for a decimal.
-
-    **Returns:**
-    - the hash code.
-
-
----
-
-### isAvailable()
-- isAvailable(): [Boolean](TopLevel.Boolean.md)
-  - : Identifies if the instance contains settings for value and unit.
-
-    **Returns:**
-    - true if the instance is initialized with value and
-              unit, false if the state is 'not available'.
-
-
-
----
-
-### isOfSameUnit(Quantity)
-- isOfSameUnit(value: [Quantity](dw.value.Quantity.md)): [Boolean](TopLevel.Boolean.md)
-  - : Identifies if two Quantities have the same unit.
-
-    **Parameters:**
-    - value - the second quantity for the comparison.
-
-    **Returns:**
-    - true if both quantities have the same unit, false otherwise.
-
-
----
-
-### multiply(Number)
-- multiply(factor: [Number](TopLevel.Number.md)): [Quantity](dw.value.Quantity.md)
-  - : Multiply Quantity object by specified factor.
-
-    **Parameters:**
-    - factor - multiplication factor
-
-    **Returns:**
-    - Quantity object representing multiplication result
-
-
----
-
-### newQuantity(Decimal)
-- newQuantity(value: [Decimal](dw.util.Decimal.md)): [Quantity](dw.value.Quantity.md)
-  - : Method returns a new instance of Quantity with the same unit but
-      different value. An N/A instance is returned if value is null.
-
-
-    **Parameters:**
-    - value - as a decimal
-
-    **Returns:**
-    - new Quantity instance with same unit
-
-
----
-
-### round(Number)
-- round(precision: [Number](TopLevel.Number.md)): [Quantity](dw.value.Quantity.md)
-  - : Rounds the Quantity value to the number of specified decimal digits.
-
-    **Parameters:**
-    - precision - number of decimal digits after the decimal point
-
-    **Returns:**
-    - the new rounded Quantity value
-
-
----
-
-### subtract(Quantity)
-- subtract(value: [Quantity](dw.value.Quantity.md)): [Quantity](dw.value.Quantity.md)
-  - : Subtract Quantity object from the current object. Only objects representing the same unit can be subtracted.
-
-    **Parameters:**
-    - value - Quantity object to subtract
-
-    **Returns:**
-    - Quantity object representing the result of subtraction
-
-
----
-
-### toString()
-- toString(): [String](TopLevel.String.md)
-  - : Returns a string representation of this quantity object.
-
-    **Returns:**
-    - a string representation of this quantity object.
-
-
----
-
-### valueOf()
-- valueOf(): [Object](TopLevel.Object.md)
-  - : According to the ECMA spec returns the "natural" primitive value. Here
-      the value portion of the Quantity is returned.
-
-
-
----
-
-<!-- prettier-ignore-end -->

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

@@ -1,9 +0,0 @@
-# Package dw.value
-
-## Classes
-| Class | Description |
-| --- | --- |
-| [EnumValue](dw.value.EnumValue.md) | The class represents a single value for an Enumeration type. |
-| [MimeEncodedText](dw.value.MimeEncodedText.md) | Container for an arbitrary text string its mime type, and encoding |
-| [Money](dw.value.Money.md) | Represents money in Commerce Cloud Digital. |
-| [Quantity](dw.value.Quantity.md) | Represents the quantity of an item. |

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

@@ -1,105 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class CSRFProtection
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.web.CSRFProtection](dw.web.CSRFProtection.md)
-
-Used to generate and validate CSRF tokens. CSRFProtection allows
-applications to protect themselves against CSRF attacks, using
-synchronizer tokens, a best practice. Once created, these tokens
-are tied to a user’s session and valid for 60 minutes.
-
-
-Usage:
-
-Adding CSRF token to forms:
-
-
-```
-//CSRF token generation
-<form ... action="<protected location>">
-  <input name="foo" value="bar">
-  <input name="${dw.web.CSRFProtection.getTokenName()}"
-            value="${dw.web.CSRFProtection.generateToken()">
-</form>
-```
-
-
-Then, in scripts call:
-
-
-```
-dw.web.CSRFProtection.validateRequest();
-```
-
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [tokenName](#tokenname): [String](TopLevel.String.md) `(read-only)` | Returns the system generated CSRF token name. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| static [generateToken](dw.web.CSRFProtection.md#generatetoken)() | Constructs a new unique CSRF token for this session. |
-| static [getTokenName](dw.web.CSRFProtection.md#gettokenname)() | Returns the system generated CSRF token name. |
-| static [validateRequest](dw.web.CSRFProtection.md#validaterequest)() | Verifies that a client request contains a valid CSRF token, and that  the token has not expired. |
-
-### 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
-
-### tokenName
-- tokenName: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the system generated CSRF token name. Currently, this name is not user configurable. Must be used for
-      [validateRequest()](dw.web.CSRFProtection.md#validaterequest) to work
-
-
-
----
-
-## Method Details
-
-### generateToken()
-- static generateToken(): [String](TopLevel.String.md)
-  - : Constructs a new unique CSRF token for this session.
-
-    **Returns:**
-    - a new CSRF token
-
-
----
-
-### getTokenName()
-- static getTokenName(): [String](TopLevel.String.md)
-  - : Returns the system generated CSRF token name. Currently, this name is not user configurable. Must be used for
-      [validateRequest()](dw.web.CSRFProtection.md#validaterequest) to work
-
-
-    **Returns:**
-    - System-generated CSRF token parameter name
-
-
----
-
-### validateRequest()
-- static validateRequest(): [Boolean](TopLevel.Boolean.md)
-  - : Verifies that a client request contains a valid CSRF token, and that
-      the token has not expired. Returns true if these conditions are met,
-      and false otherwise
-
-
-    **Returns:**
-    - true if request contains a valid CSRF token, false otherwise
-
-
----
-
-<!-- prettier-ignore-end -->

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

@@ -1,177 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class ClickStream
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.web.ClickStream](dw.web.ClickStream.md)
-
-Represents the click stream in the session. A maximum number of 50 clicks is
-recorded per session. After the maximum is reached, each time the customer
-clicks on a new link, the oldest click stream entry is purged. The
-ClickStream always remembers the first click.
-
-
-The click stream is consulted when the GetLastVisitedProducts pipelet is
-called to retrieve the products that the customer has recently visited.
-
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [clicks](#clicks): [List](dw.util.List.md) `(read-only)` | Returns a collection with all clicks. |
-| [enabled](#enabled): [Boolean](TopLevel.Boolean.md) `(read-only)` | Identifies if the clickstream recording is enabled or not. |
-| [first](#first): [ClickStreamEntry](dw.web.ClickStreamEntry.md) `(read-only)` | Returns the first click within this session. |
-| [last](#last): [ClickStreamEntry](dw.web.ClickStreamEntry.md) `(read-only)` | Returns the last recorded click stream, which is also typically  the current click. |
-| [partial](#partial): [Boolean](TopLevel.Boolean.md) `(read-only)` | Identifies if this is only a partial click stream. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getClicks](dw.web.ClickStream.md#getclicks)() | Returns a collection with all clicks. |
-| [getFirst](dw.web.ClickStream.md#getfirst)() | Returns the first click within this session. |
-| [getLast](dw.web.ClickStream.md#getlast)() | Returns the last recorded click stream, which is also typically  the current click. |
-| [isEnabled](dw.web.ClickStream.md#isenabled)() | Identifies if the clickstream recording is enabled or not. |
-| [isPartial](dw.web.ClickStream.md#ispartial)() | Identifies if this is only a partial click stream. |
-
-### 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
-
-### clicks
-- clicks: [List](dw.util.List.md) `(read-only)`
-  - : Returns a collection with all clicks. The first entry is the oldest
-      entry. The last entry is the latest entry. The method returns a copy of
-      the click stream, which makes it safe to work with the click stream,
-      while it might be modified.
-
-
-
----
-
-### enabled
-- enabled: [Boolean](TopLevel.Boolean.md) `(read-only)`
-  - : Identifies if the clickstream recording is enabled or not.
-      It is considered enabled if either:
-      - the method [Session.isTrackingAllowed()](dw.system.Session.md#istrackingallowed)returns true
-      - or if the above method returns false but the preference 'ClickstreamHonorDNT' is set to false.
-      
-      When clickstream tracking is not enabled the [getFirst()](dw.web.ClickStream.md#getfirst) method still operates as expected
-      but the rest of the clicks are not collected.
-
-
-
----
-
-### first
-- first: [ClickStreamEntry](dw.web.ClickStreamEntry.md) `(read-only)`
-  - : Returns the first click within this session. This first click
-      is stored independent of whether entries are purged.
-
-
-
----
-
-### last
-- last: [ClickStreamEntry](dw.web.ClickStreamEntry.md) `(read-only)`
-  - : Returns the last recorded click stream, which is also typically
-      the current click. In where rare cases (e.g. RedirectURL pipeline) this
-      is not the current click, but instead the last recorded click.
-
-
-
----
-
-### partial
-- partial: [Boolean](TopLevel.Boolean.md) `(read-only)`
-  - : Identifies if this is only a partial click stream. If the maximum number
-      of clicks (50) is recorded, the oldest entry is automatically purged with
-      each additional click. In this case, this flag indicates that the click
-      stream is only partial.
-
-
-
----
-
-## Method Details
-
-### getClicks()
-- getClicks(): [List](dw.util.List.md)
-  - : Returns a collection with all clicks. The first entry is the oldest
-      entry. The last entry is the latest entry. The method returns a copy of
-      the click stream, which makes it safe to work with the click stream,
-      while it might be modified.
-
-
-    **Returns:**
-    - a collection of ClickStreamEntry instances, sorted
-              chronologically.
-
-
-
----
-
-### getFirst()
-- getFirst(): [ClickStreamEntry](dw.web.ClickStreamEntry.md)
-  - : Returns the first click within this session. This first click
-      is stored independent of whether entries are purged.
-
-
-    **Returns:**
-    - the first click within this session.
-
-
----
-
-### getLast()
-- getLast(): [ClickStreamEntry](dw.web.ClickStreamEntry.md)
-  - : Returns the last recorded click stream, which is also typically
-      the current click. In where rare cases (e.g. RedirectURL pipeline) this
-      is not the current click, but instead the last recorded click.
-
-
-    **Returns:**
-    - the last recorded click stream, which is also typically
-      the current click.
-
-
-
----
-
-### isEnabled()
-- isEnabled(): [Boolean](TopLevel.Boolean.md)
-  - : Identifies if the clickstream recording is enabled or not.
-      It is considered enabled if either:
-      - the method [Session.isTrackingAllowed()](dw.system.Session.md#istrackingallowed)returns true
-      - or if the above method returns false but the preference 'ClickstreamHonorDNT' is set to false.
-      
-      When clickstream tracking is not enabled the [getFirst()](dw.web.ClickStream.md#getfirst) method still operates as expected
-      but the rest of the clicks are not collected.
-
-
-    **Returns:**
-    - whether clickstream tracking is enabled
-
-
----
-
-### isPartial()
-- isPartial(): [Boolean](TopLevel.Boolean.md)
-  - : Identifies if this is only a partial click stream. If the maximum number
-      of clicks (50) is recorded, the oldest entry is automatically purged with
-      each additional click. In this case, this flag indicates that the click
-      stream is only partial.
-
-
-    **Returns:**
-    - true if this click stream is partial, false otherwise.
-
-
----
-
-<!-- prettier-ignore-end -->