@salesforce/b2c-tooling-sdk 1.19.1 → 1.20.0

package/data/script-api/dw.net.WebDAVFileInfo.md

@@ -1,163 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class WebDAVFileInfo
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.net.WebDAVFileInfo](dw.net.WebDAVFileInfo.md)
-
-Simple class representing a file on a remote WebDAV location.  The class
-possesses only read-only attributes of the file and does not permit any
-manipulation of the file itself.  Instances of this class are returned
-by [WebDAVClient.propfind(String)](dw.net.WebDAVClient.md#propfindstring) which is used to get a
-listing of files in a WebDAV directory.
-
-
-**Note:** when this class is used with sensitive data, be careful in persisting sensitive information to disk.
-
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [contentType](#contenttype): [String](TopLevel.String.md) `(read-only)` | Returns the content type of the file. |
-| [creationDate](#creationdate): [Date](TopLevel.Date.md) `(read-only)` | Returns the creationDate of the file. |
-| [directory](#directory): [Boolean](TopLevel.Boolean.md) `(read-only)` | Identifies if the file is a directory. |
-| [name](#name): [String](TopLevel.String.md) `(read-only)` | Returns the name of the file. |
-| [path](#path): [String](TopLevel.String.md) `(read-only)` | Returns the path of the file. |
-| [size](#size): [Number](TopLevel.Number.md) `(read-only)` | Returns the size of the file. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getContentType](dw.net.WebDAVFileInfo.md#getcontenttype)() | Returns the content type of the file. |
-| [getCreationDate](dw.net.WebDAVFileInfo.md#getcreationdate)() | Returns the creationDate of the file. |
-| [getName](dw.net.WebDAVFileInfo.md#getname)() | Returns the name of the file. |
-| [getPath](dw.net.WebDAVFileInfo.md#getpath)() | Returns the path of the file. |
-| [getSize](dw.net.WebDAVFileInfo.md#getsize)() | Returns the size of the file. |
-| [isDirectory](dw.net.WebDAVFileInfo.md#isdirectory)() | Identifies if the file is a directory. |
-| [lastModified](dw.net.WebDAVFileInfo.md#lastmodified)() | Returns the lastModified date of the file. |
-
-### 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
-
-### contentType
-- contentType: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the content type of the file.
-
-
----
-
-### creationDate
-- creationDate: [Date](TopLevel.Date.md) `(read-only)`
-  - : Returns the creationDate of the file.
-
-
----
-
-### directory
-- directory: [Boolean](TopLevel.Boolean.md) `(read-only)`
-  - : Identifies if the file is a directory.
-
-
----
-
-### name
-- name: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the name of the file.
-
-
----
-
-### path
-- path: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the path of the file.
-
-
----
-
-### size
-- size: [Number](TopLevel.Number.md) `(read-only)`
-  - : Returns the size of the file.
-
-
----
-
-## Method Details
-
-### getContentType()
-- getContentType(): [String](TopLevel.String.md)
-  - : Returns the content type of the file.
-
-    **Returns:**
-    - the content type of the file.
-
-
----
-
-### getCreationDate()
-- getCreationDate(): [Date](TopLevel.Date.md)
-  - : Returns the creationDate of the file.
-
-    **Returns:**
-    - the creationDate of the file.
-
-
----
-
-### getName()
-- getName(): [String](TopLevel.String.md)
-  - : Returns the name of the file.
-
-    **Returns:**
-    - the name of the file.
-
-
----
-
-### getPath()
-- getPath(): [String](TopLevel.String.md)
-  - : Returns the path of the file.
-
-    **Returns:**
-    - the path of the file.
-
-
----
-
-### getSize()
-- getSize(): [Number](TopLevel.Number.md)
-  - : Returns the size of the file.
-
-    **Returns:**
-    - the size of the file.
-
-
----
-
-### isDirectory()
-- isDirectory(): [Boolean](TopLevel.Boolean.md)
-  - : Identifies if the file is a directory.
-
-    **Returns:**
-    - true if the file is a directory, false otherwise.
-
-
----
-
-### lastModified()
-- lastModified(): [Date](TopLevel.Date.md)
-  - : Returns the lastModified date of the file.
-
-    **Returns:**
-    - the lastModified date of the file.
-
-
----
-
-<!-- prettier-ignore-end -->

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

@@ -1,15 +0,0 @@
-# Package dw.net
-
-## Classes
-| Class | Description |
-| --- | --- |
-| [FTPClient](dw.net.FTPClient.md) | The FTPClient class supports the FTP commands CD, GET, PUT, DEL, MKDIR, RENAME, and LIST. |
-| [FTPFileInfo](dw.net.FTPFileInfo.md) | The class is used to store information about a remote file. |
-| [HTTPClient](dw.net.HTTPClient.md) | The HTTPClient class supports the HTTP methods GET, POST, HEAD, PUT, PATCH, OPTIONS, and DELETE. |
-| [HTTPClientLoggingConfig](dw.net.HTTPClientLoggingConfig.md) | Script API for configuring HTTP client logging and sensitive data redaction. |
-| [HTTPRequestPart](dw.net.HTTPRequestPart.md) | This represents a part in a multi-part HTTP POST request. |
-| [Mail](dw.net.Mail.md) | This class is used to send an email with either plain text or MimeEncodedText content. |
-| [SFTPClient](dw.net.SFTPClient.md) | The SFTPClient class supports the SFTP commands GET, PUT, DEL, MKDIR, RENAME, and LIST. |
-| [SFTPFileInfo](dw.net.SFTPFileInfo.md) | The class is used to store information about a remote file. |
-| [WebDAVClient](dw.net.WebDAVClient.md) | The WebDAVClient class supports the WebDAV methods GET, PUT, MKCOL, MOVE,  COPY, PROPFIND,OPTIONS and DELETE. |
-| [WebDAVFileInfo](dw.net.WebDAVFileInfo.md) | Simple class representing a file on a remote WebDAV location. |

package/data/script-api/dw.object.ActiveData.md

@@ -1,86 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class ActiveData
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.object.PersistentObject](dw.object.PersistentObject.md)
-    - [dw.object.ExtensibleObject](dw.object.ExtensibleObject.md)
-      - [dw.object.ActiveData](dw.object.ActiveData.md)
-
-Represents the active data for an object in Commerce Cloud Digital.
-
-
-## All Known Subclasses
-[CustomerActiveData](dw.customer.CustomerActiveData.md), [ProductActiveData](dw.catalog.ProductActiveData.md)
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [custom](#custom): [CustomAttributes](dw.object.CustomAttributes.md) `(read-only)` | Returns the custom attributes for this object. |
-| [empty](#empty): [Boolean](TopLevel.Boolean.md) `(read-only)` | Return true if the ActiveData doesn't exist for the object |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getCustom](dw.object.ActiveData.md#getcustom)() | Returns the custom attributes for this object. |
-| [isEmpty](dw.object.ActiveData.md#isempty)() | Return true if the ActiveData doesn't exist for the object |
-
-### Methods inherited from class ExtensibleObject
-
-[describe](dw.object.ExtensibleObject.md#describe), [getCustom](dw.object.ExtensibleObject.md#getcustom)
-### Methods inherited from class PersistentObject
-
-[getCreationDate](dw.object.PersistentObject.md#getcreationdate), [getLastModified](dw.object.PersistentObject.md#getlastmodified), [getUUID](dw.object.PersistentObject.md#getuuid)
-### 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
-
-### custom
-- custom: [CustomAttributes](dw.object.CustomAttributes.md) `(read-only)`
-  - : Returns the custom attributes for this object. The returned object can
-      only be used for retrieving attribute values, not storing them. See
-      [CustomAttributes](dw.object.CustomAttributes.md) for a detailed example of the syntax for
-      working with custom attributes.
-
-
-
----
-
-### empty
-- empty: [Boolean](TopLevel.Boolean.md) `(read-only)`
-  - : Return true if the ActiveData doesn't exist for the object
-
-
----
-
-## Method Details
-
-### getCustom()
-- getCustom(): [CustomAttributes](dw.object.CustomAttributes.md)
-  - : Returns the custom attributes for this object. The returned object can
-      only be used for retrieving attribute values, not storing them. See
-      [CustomAttributes](dw.object.CustomAttributes.md) for a detailed example of the syntax for
-      working with custom attributes.
-
-
-    **Returns:**
-    - the custom attributes for this object.
-
-
----
-
-### isEmpty()
-- isEmpty(): [Boolean](TopLevel.Boolean.md)
-  - : Return true if the ActiveData doesn't exist for the object
-
-    **Returns:**
-    - true if ActiveData is empty, false otherwise
-
-
----
-
-<!-- prettier-ignore-end -->

package/data/script-api/dw.object.CustomAttributes.md

@@ -1,165 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class CustomAttributes
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.object.CustomAttributes](dw.object.CustomAttributes.md)
-
-This class is used together with other classes that contain custom attributes and is used to read and write these
-attributes. The actual attributes are accessible as ECMA properties. The syntax for setting and retrieving the value
-of a custom attribute depends upon the type of the attribute. An exception will be thrown, if the wrong syntax is
-used to set an individual attribute.
-
-
-The following script examples demonstrate how to work with custom attributes. Suppose we have an ExtensibleObject
-named "eo" possessing attributes of all the different types supported by the Commerce Cloud Digital metadata system.
-The following script snippet shows that setting single-valued attributes is simply a matter of using the assignment
-operator and standard ECMA primitives and built-in types:
-
-
-
-
-```
-// attribute of value type 'Boolean'
-eo.custom.bvalue = true;
-var b : Boolean = eo.custom.bvalue;
-
-// attribute of value type 'Integer'
-eo.custom.ivalue = 10;
-var i : Number = eo.custom.ivalue;
-
-// attribute of value type 'Number'
-eo.custom.dvalue = 99.99;
-var d : Number = eo.custom.dvalue;
-
-// attribute of value type 'String'
-eo.custom.svalue = "String1";
-var s : String = eo.custom.svalue;
-
-// attribute of value type 'Email'
-eo.custom.emailvalue = "email@demandware.com";
-var e : String = eo.custom.emailvalue;
-
-// attribute of value type 'Text'
-eo.custom.tvalue = "laaaaaaaaaaaarge text";
-var t : String = eo.custom.tvalue;
-
-// attribute of value type 'Date'
-eo.custom.dtvalue = new Date;
-var date : Date = eo.custom.dtvalue;
-```
-
-
-
-**Retrieving multi-value attributes and working with Java-backed arrays**
-
-Multi-value attributes return Java-backed arrays, which contain copies of the internal data. In contrast to native
-JavaScript arrays, a Java-backed array behaves differently in the following ways:
-
-- `Array.isArray( javaBackedArray )`will return `false`. If you want to do something based  on the value type, use `javaBackedArray instanceof Array`instead.
-- Adding to or removing elements from a Java-backed array is not supported. You need to create a new native  JavaScript array based on the Java-backed array, e.g. with `Array.from( javaBackedArray )`and do the  modifications there.
-
-
-
-```
-var setofstring : Array = eo.custom.setofstringvalue;
-if( Array.isArray( setofstring ) ) // returns false
-{
-  // this will never be reached, since setofstring is a Java-backed array and not a native JavaScript array
-}
-if( setofstring instanceof Array ) // returns true
-{
-  // this will be reached, since setofstring is a Java-backed array
-}
-```
-
-
-
-**Updating multi-value attributes**
-
-Retrieved data from a multi-value attribute returns a Java-backed array, which contains a copy of the internal data,
-so changes made to the Java-backed array do not affect the multi-value attribute. To update the multi-value attribute
-(e.g. adding a new element), it needs to be reassigned.
-
-
-```
-// retrieve a Java-backed array and convert it to a native JavaScript array
-var setofstring : Array = eo.custom.setofstringvalue;
-var newValue = Array.from( setofstring );
-
-// add new element
-newValue.append( "new element" );
-
-// reassign the new array to the multi-value attribute to persist the change
-eo.custom.setofstringvalue = newValue;
-```
-
-
-If you only want to change individual elements without appending or removing elements from the Java-backed array, you
-may even modify it directly.
-
-
-```
-// retrieve a Java-backed array
-var setofstring : Array = eo.custom.setofstringvalue;
-
-// change individual element
-setofstring[0] = "updated element";
-
-// reassign the array to the multi-value attribute to persist the change
-eo.custom.setofstringvalue = setofstring;
-```
-
-
-
-**Set-of attributes and enum-of attributes**
-
-Set-of attributes and enum-of attributes are handled in a very similar manner. The chief difference is that enum-of
-attributes are limited to a prescribed set of value definitions whereas set-of attributes are open-ended.
-Furthermore, each value in an enum-of attribute has a value and a display name which affects the retrieval logic.
-
-
-
-
-```
-// attribute of value type 'Set of String'
-// set the attribute value only if it hasn't been already set
-if( !('setofstringvalue' in eo.custom) )
-{
-    eo.custom.setofstringvalue = new Array("abc","def","ghi");
-}
-
-// returns an Array of String instances
-var setofstring : Array = eo.custom.setofstringvalue;
-var s1 : String = setofstring[0];
-var s2 : String = setofstring[1];
-var s3 : String = setofstring[2];
-
-// attribute of value type 'Enum of Integer' with multi-value handling
-eo.custom.enumofintmultivalue = new Array(1, 2, 3);
-
-// returns an Array of EnumValue instances
-var enumofintmulti : Array = eo.custom.enumofintmultivalue;
-var value1 : Number = enumofintmulti[0].getValue();
-var displayvalue1 : String = enumofintmulti[0].getDisplayValue();
-var value2 : Number = enumofintmulti[1].getValue();
-var displayvalue2 : String = enumofintmulti[1].getDisplayValue();
-var value3 : Number = enumofintmulti[2].getValue();
-var displayvalue3 : String = enumofintmulti[2].getDisplayValue();
-```
-
-
-
-For further details on the Commerce Cloud Digital attribute system, see the core Commerce Cloud Digital
-documentation.
-
-
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## 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)
-<!-- prettier-ignore-end -->

package/data/script-api/dw.object.CustomObject.md

@@ -1,82 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class CustomObject
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.object.PersistentObject](dw.object.PersistentObject.md)
-    - [dw.object.ExtensibleObject](dw.object.ExtensibleObject.md)
-      - [dw.object.CustomObject](dw.object.CustomObject.md)
-
-Represents a custom object and its corresponding attributes.
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [custom](#custom): [CustomAttributes](dw.object.CustomAttributes.md) `(read-only)` | Returns the custom attributes of this  object. |
-| [type](#type): [String](TopLevel.String.md) `(read-only)` | Returns the type of the CustomObject. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getCustom](dw.object.CustomObject.md#getcustom)() | Returns the custom attributes of this  object. |
-| [getType](dw.object.CustomObject.md#gettype)() | Returns the type of the CustomObject. |
-
-### Methods inherited from class ExtensibleObject
-
-[describe](dw.object.ExtensibleObject.md#describe), [getCustom](dw.object.ExtensibleObject.md#getcustom)
-### Methods inherited from class PersistentObject
-
-[getCreationDate](dw.object.PersistentObject.md#getcreationdate), [getLastModified](dw.object.PersistentObject.md#getlastmodified), [getUUID](dw.object.PersistentObject.md#getuuid)
-### 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
-
-### custom
-- custom: [CustomAttributes](dw.object.CustomAttributes.md) `(read-only)`
-  - : Returns the custom attributes of this
-      object.
-
-
-
----
-
-### type
-- type: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the type of the CustomObject.
-
-
----
-
-## Method Details
-
-### getCustom()
-- getCustom(): [CustomAttributes](dw.object.CustomAttributes.md)
-  - : Returns the custom attributes of this
-      object.
-
-
-    **Returns:**
-    - the custom attributes of this
-      object.
-
-
-
----
-
-### getType()
-- getType(): [String](TopLevel.String.md)
-  - : Returns the type of the CustomObject.
-
-    **Returns:**
-    - the type of the CustomObject.
-
-
----
-
-<!-- prettier-ignore-end -->