@salesforce/b2c-tooling-sdk 0.0.1 → 0.0.2

package/data/script-api/dw.util.Template.md

@@ -0,0 +1,141 @@
+<!-- prettier-ignore-start -->
+# Class Template
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.util.Template](dw.util.Template.md)
+
+Reads an ISML template from the file system and renders it into a
+[MimeEncodedText](dw.value.MimeEncodedText.md) object. Optional substitution values can be
+passed to the isml template via the [render(Map)](dw.util.Template.md#rendermap)
+method. Substitution parameters can be accessed within the template through
+
+
+```
+    <isprint value="${param.parameter}">
+```
+
+
+or for backward compatibility through
+
+
+```
+    <isprint value="${pdict.parameter}">
+```
+
+
+The access through pdict only gives access to the parameter map provided at
+rendering time and doesn't offer access to the system PipelineDictionary. The
+pdict access to the property map is only considered to ease the transition
+from SendMail pipelet API based templates. If the PipelineDictionary or
+properties of the PipelineDictionary are needed, they need to be included in
+the Property map passed to the render method.
+
+
+
+## Constructor Summary
+
+| Constructor | Description |
+| --- | --- |
+| [Template](#templatestring)([String](TopLevel.String.md)) | Creates a new template. |
+| [Template](#templatestring-string)([String](TopLevel.String.md), [String](TopLevel.String.md)) | Creates a new template with the locale being set to the given localeID. |
+
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [render](dw.util.Template.md#render)() | Renders the template specified at instantiation time, without any  substitution parameters. |
+| [render](dw.util.Template.md#rendermap)([Map](dw.util.Map.md)) | Renders the template specified at instantiation time with the given  substitution parameters. |
+| [setLocale](dw.util.Template.md#setlocalestring)([String](TopLevel.String.md)) | Sets an optional localeID which is used instead of the current requests  localeID. |
+
+### 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
+
+### Template(String)
+- Template(templateName: [String](TopLevel.String.md))
+  - : Creates a new template. Doesn't render the template until
+      [render()](dw.util.Template.md#render) or [render(Map)](dw.util.Template.md#rendermap)
+      is invoked. The current request localeID will be used for Rendering.
+
+
+    **Parameters:**
+    - templateName - file system path to the ISML template
+
+
+---
+
+### Template(String, String)
+- Template(templateName: [String](TopLevel.String.md), localeID: [String](TopLevel.String.md))
+  - : Creates a new template with the locale being set to the given localeID.
+      Rendering doesn't happen until [render()](dw.util.Template.md#render) or
+      [render(Map)](dw.util.Template.md#rendermap) is invoked.
+
+
+    **Parameters:**
+    - templateName - file system path to the ISML template
+    - localeID - localeID to be used for Rendering
+
+
+---
+
+## Method Details
+
+### render()
+- render(): [MimeEncodedText](dw.value.MimeEncodedText.md)
+  - : Renders the template specified at instantiation time, without any
+      substitution parameters. Any isprint tags referring to param/pdict will
+      be unresolved and will be replaced with empty strings. If there's an
+      explicit localeID set through [setLocale(String)](dw.util.Template.md#setlocalestring),
+      it takes precedence over the localeID associated with the current
+      request.
+
+
+    **Returns:**
+    - MimeEncodedText with isprint tags referring to param/pdict
+              replaced with an empty String
+
+
+
+---
+
+### render(Map)
+- render(params: [Map](dw.util.Map.md)): [MimeEncodedText](dw.value.MimeEncodedText.md)
+  - : Renders the template specified at instantiation time with the given
+      substitution parameters. These parameters are available to ISML templates
+      through variables named 'param' and 'pdict'. Note that in this context,
+      pdict is not referring to the system PipelineDictionary, as the System
+      Pipeline Dictionary is not accessible from this script API. If there's an
+      explicit localeID set through [setLocale(String)](dw.util.Template.md#setlocalestring),
+      it takes precedence over the localeID associated with the current
+      request.
+
+
+    **Parameters:**
+    - params - Map of substitution parameters which are specified within the             ISML template. Access is available from within the ISML             template through named variables param or pdict.
+
+    **Returns:**
+    - MimeEncodedText containing the rendered template. Variables in
+              the template referring to param/pdict are replaced with the value
+              from the params map or empty if the value isn't found in the map
+
+
+
+---
+
+### setLocale(String)
+- setLocale(localeID: [String](TopLevel.String.md)): [Template](dw.util.Template.md)
+  - : Sets an optional localeID which is used instead of the current requests
+      localeID.
+
+
+    **Parameters:**
+    - localeID - to be used for processing this template. Throws an exception             if localeID is blank
+
+    **Returns:**
+    - this Template object
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.util.UUIDUtils.md

@@ -0,0 +1,34 @@
+<!-- prettier-ignore-start -->
+# Class UUIDUtils
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.util.UUIDUtils](dw.util.UUIDUtils.md)
+
+Utility methods around generating unique IDs.
+
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| static [createUUID](dw.util.UUIDUtils.md#createuuid)() | The method generates a unique id. |
+
+### 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
+
+### createUUID()
+- static createUUID(): [String](TopLevel.String.md)
+  - : The method generates a unique id.
+
+    **Returns:**
+    - the generated unique id
+
+
+---
+
+<!-- prettier-ignore-end -->

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

@@ -0,0 +1,37 @@
+# Package dw.util
+
+## Classes
+| Class | Description |
+| --- | --- |
+| [ArrayList](dw.util.ArrayList.md) | The ArrayList class is a container for a list of objects. |
+| [Assert](dw.util.Assert.md) | The Assert class provides utility methods for assertion events. |
+| [BigInteger](dw.util.BigInteger.md) | The BigInteger class is a helper class to represent an arbitrary long integer number. |
+| [Bytes](dw.util.Bytes.md) | A simple immutable class representing an array of bytes, used for working  with binary data in a scripting context. |
+| [Calendar](dw.util.Calendar.md) | Represents a Calendar and is based on the java.util.Calendar  class. |
+| [Collection](dw.util.Collection.md) | Represents a collection of objects. |
+| [Currency](dw.util.Currency.md) | Represents a currency supported by the system. |
+| [DateUtils](dw.util.DateUtils.md) | A class with several utility methods for Date objects. |
+| [Decimal](dw.util.Decimal.md) | The Decimal class is a helper class to perform decimal arithmetic in  scripts and to represent a decimal number with arbitrary length. |
+| [FilteringCollection](dw.util.FilteringCollection.md) | [FilteringCollection](dw.util.FilteringCollection.md) is an extension of  [Collection](dw.util.Collection.md) which provides possibilities to   <ul>  <li>_filter_ the elements to return a new  [FilteringCollection](dw.util.FilteringCollection.md) with a filtered set of elements</li>  <li>_sort_ the elements to return a new  [FilteringCollection](dw.util.FilteringCollection.md) with a defined sort order</li>  <li>_transform_ the elements to return a new  [FilteringCollection](dw.util.FilteringCollection.md) containing related elements</li>  <li>_provide a map_ of the elements against a predefined key</li>  </ul> |
+| [Geolocation](dw.util.Geolocation.md) | Read-only class representing a position on the earth (latitude and longitude)  and information associated with that location (e.g. |
+| [HashMap](dw.util.HashMap.md) | Represents a hash map of objects. |
+| [HashSet](dw.util.HashSet.md) | Represents a HashSet |
+| [Iterator](dw.util.Iterator.md) | The Iterator class allows you to access items in a collection. |
+| [LinkedHashMap](dw.util.LinkedHashMap.md) | This class implements a HashMap, which guarantees a iteration order  according the put-order of the elements in the map. |
+| [LinkedHashSet](dw.util.LinkedHashSet.md) | The class LinkedHashSet implements a hash set with a guaranteed iteration  order. |
+| [List](dw.util.List.md) | An ordered collection of objects. |
+| [Locale](dw.util.Locale.md) | Represents a Locale supported by the system. |
+| [Map](dw.util.Map.md) | Represents a Map of objects. |
+| [MapEntry](dw.util.MapEntry.md) | The class represent an entry within a Map. |
+| [MappingKey](dw.util.MappingKey.md) | Encapsulates the key for a mapping read in with the ImportKeyValueMapping job step. |
+| [MappingMgr](dw.util.MappingMgr.md) | Used to manage and interface with mappings loaded into the system via the ImportKeyValueMapping job step. |
+| [PropertyComparator](dw.util.PropertyComparator.md) | This comparator can be used for the List sort() methods and for the SortSet  and SortedMap classes. |
+| [SecureEncoder](dw.util.SecureEncoder.md) | SecureEncoder contains many methods for manipulating untrusted data Strings  into RFC-Compliant Strings for a given context by encoding "bad" data into  the proper format. |
+| [SecureFilter](dw.util.SecureFilter.md) | SecureFilter contains many methods for manipulating untrusted data Strings  into RFC-Compliant Strings for a given context by removing "bad" data from  the untrusted data. |
+| [SeekableIterator](dw.util.SeekableIterator.md) | A special Iterator, which is returned by the system to iterate through large  sets of data. |
+| [Set](dw.util.Set.md) | Represents a set of objects. |
+| [SortedMap](dw.util.SortedMap.md) | A map that further guarantees that it will be in ascending key order,  sorted according to the natural ordering of its keys,  or by a comparator provided at sorted map creation time. |
+| [SortedSet](dw.util.SortedSet.md) | A set that further guarantees that its iterator  will traverse the set in ascending element order,  sorted according to the natural ordering of its  elements (only supported for Number, String,  Date, Money and Quantity), or by a comparator  provided at sorted set creation time. |
+| [StringUtils](dw.util.StringUtils.md) | String utility class. |
+| [Template](dw.util.Template.md) | Reads an ISML template from the file system and renders it into a  [MimeEncodedText](dw.value.MimeEncodedText.md) object. |
+| [UUIDUtils](dw.util.UUIDUtils.md) | Utility methods around generating unique IDs. |

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

@@ -0,0 +1,105 @@
+<!-- prettier-ignore-start -->
+# Class EnumValue
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.value.EnumValue](dw.value.EnumValue.md)
+
+The class represents a single value for an Enumeration type. Enumeration
+types can be configured through the business manager for custom attributes.
+Some system attributes, e.g. the order status, are also of Enumeration types.
+
+
+Each EnumValue has a base value and a display value.  The type of the base
+value can be either String or Integer. Every EnumValue has a display value.
+
+
+
+If the value of an Enumeration type object attribute is
+`null`, when that attribute is accessed an EnumValue is returned
+that has a base value of `null`, rather than `null`
+itself.  This means that `empty(object.attribute)` would be
+`false`, and `empty(object.attribute.value)` would be
+`true`
+.
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [displayValue](#displayvalue): [String](TopLevel.String.md) `(read-only)` | Returns the display value of the enumeration value. |
+| [value](#value): [Object](TopLevel.Object.md) `(read-only)` | Returns the value of the enumeration value. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getDisplayValue](dw.value.EnumValue.md#getdisplayvalue)() | Returns the display value of the enumeration value. |
+| [getValue](dw.value.EnumValue.md#getvalue)() | Returns the value of the enumeration value. |
+| [toString](dw.value.EnumValue.md#tostring)() | Same as getDisplayValue(). |
+| [valueOf](dw.value.EnumValue.md#valueof)() | According the ECMA specification, this method returns the "natural"  primitive value of this object. |
+
+### 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
+
+### displayValue
+- displayValue: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the display value of the enumeration value. If no display value
+      is configured the method return the string representation of the value.
+
+
+
+---
+
+### value
+- value: [Object](TopLevel.Object.md) `(read-only)`
+  - : Returns the value of the enumeration value. This is either an integer
+      value or a string.
+
+
+
+---
+
+## Method Details
+
+### getDisplayValue()
+- getDisplayValue(): [String](TopLevel.String.md)
+  - : Returns the display value of the enumeration value. If no display value
+      is configured the method return the string representation of the value.
+
+
+
+---
+
+### getValue()
+- getValue(): [Object](TopLevel.Object.md)
+  - : Returns the value of the enumeration value. This is either an integer
+      value or a string.
+
+
+
+---
+
+### toString()
+- toString(): [String](TopLevel.String.md)
+  - : Same as getDisplayValue().
+
+
+---
+
+### valueOf()
+- valueOf(): [Object](TopLevel.Object.md)
+  - : According the ECMA specification, this method returns the "natural"
+      primitive value of this object. Here it is equivalent to getValue().
+
+
+
+---
+
+<!-- prettier-ignore-end -->

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

@@ -0,0 +1,131 @@
+<!-- prettier-ignore-start -->
+# Class MimeEncodedText
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.value.MimeEncodedText](dw.value.MimeEncodedText.md)
+
+Container for an arbitrary text string its mime type, and encoding
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [encoding](#encoding): [String](TopLevel.String.md) `(read-only)` | Returns the encoding of the text. |
+| [mimeType](#mimetype): [String](TopLevel.String.md) `(read-only)` | Returns the mime type of the text. |
+| [text](#text): [String](TopLevel.String.md) `(read-only)` | Returns the text. |
+
+## Constructor Summary
+
+| Constructor | Description |
+| --- | --- |
+| [MimeEncodedText](#mimeencodedtextstring-string-string)([String](TopLevel.String.md), [String](TopLevel.String.md), [String](TopLevel.String.md)) | Creates a new MimeEncodedText with explicit values for mime type and  encoding. |
+| [MimeEncodedText](#mimeencodedtextstring)([String](TopLevel.String.md)) | Creates a new MimeEncodedText with the given String as text, mime type of  "text/plain;charset=UTF-8" and encoding of "UTF-8" |
+
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getEncoding](dw.value.MimeEncodedText.md#getencoding)() | Returns the encoding of the text. |
+| [getMimeType](dw.value.MimeEncodedText.md#getmimetype)() | Returns the mime type of the text. |
+| [getText](dw.value.MimeEncodedText.md#gettext)() | Returns the text. |
+
+### 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
+
+### encoding
+- encoding: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the encoding of the text. Encoding is set at creation time and
+      can't be changed afterwards
+
+
+
+---
+
+### mimeType
+- mimeType: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the mime type of the text. Mime type is set at creation time and
+      can't be changed afterwards.
+
+
+
+---
+
+### text
+- text: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the text. Text is set at creation time and can't be changed
+      afterwards.
+
+
+
+---
+
+## Constructor Details
+
+### MimeEncodedText(String, String, String)
+- MimeEncodedText(text: [String](TopLevel.String.md), mimeType: [String](TopLevel.String.md), encoding: [String](TopLevel.String.md))
+  - : Creates a new MimeEncodedText with explicit values for mime type and
+      encoding.
+
+
+    **Parameters:**
+    - text - text to be stored
+    - mimeType - mime type of the text. For example, "text/plain" or             "text/html"
+    - encoding - Encoding of the text. For example, "UTF-8" or "ISO-8859-1"
+
+
+---
+
+### MimeEncodedText(String)
+- MimeEncodedText(text: [String](TopLevel.String.md))
+  - : Creates a new MimeEncodedText with the given String as text, mime type of
+      "text/plain;charset=UTF-8" and encoding of "UTF-8"
+
+
+    **Parameters:**
+    - text - text to be stored
+
+
+---
+
+## Method Details
+
+### getEncoding()
+- getEncoding(): [String](TopLevel.String.md)
+  - : Returns the encoding of the text. Encoding is set at creation time and
+      can't be changed afterwards
+
+
+    **Returns:**
+    - encoding of the text
+
+
+---
+
+### getMimeType()
+- getMimeType(): [String](TopLevel.String.md)
+  - : Returns the mime type of the text. Mime type is set at creation time and
+      can't be changed afterwards.
+
+
+    **Returns:**
+    - the MimeType of the text
+
+
+---
+
+### getText()
+- getText(): [String](TopLevel.String.md)
+  - : Returns the text. Text is set at creation time and can't be changed
+      afterwards.
+
+
+    **Returns:**
+    - text stored
+
+
+---
+
+<!-- prettier-ignore-end -->