@salesforce/b2c-tooling-sdk 0.0.1 → 0.0.3

package/data/script-api/dw.system.System.md

@@ -0,0 +1,224 @@
+<!-- prettier-ignore-start -->
+# Class System
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.system.System](dw.system.System.md)
+
+Represents the Commerce Cloud Digital server instance. An application server instance is configured to be of one of three types,
+"development system", "staging system" or "production system".
+
+
+
+## Constant Summary
+
+| Constant | Description |
+| --- | --- |
+| [DEVELOPMENT_SYSTEM](#development_system): [Number](TopLevel.Number.md) = 0 | Represents the development system. |
+| [PRODUCTION_SYSTEM](#production_system): [Number](TopLevel.Number.md) = 2 | Represents the production system. |
+| [STAGING_SYSTEM](#staging_system): [Number](TopLevel.Number.md) = 1 | Represents the staging system. |
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [calendar](#calendar): [Calendar](dw.util.Calendar.md) `(read-only)` | Returns a new Calendar object in the time zone of the  current instance. |
+| [compatibilityMode](#compatibilitymode): [Number](TopLevel.Number.md) `(read-only)` | Returns the compatibility mode of the custom code version that is currently active. |
+| [instanceHostname](#instancehostname): [String](TopLevel.String.md) `(read-only)` | Returns instance hostname. |
+| [instanceTimeZone](#instancetimezone): [String](TopLevel.String.md) `(read-only)` | Returns the instance time zone. |
+| [instanceType](#instancetype): [Number](TopLevel.Number.md) `(read-only)` | Returns the type of the instance. |
+| [preferences](#preferences): [OrganizationPreferences](dw.system.OrganizationPreferences.md) `(read-only)` | This method returns a container of all global preferences of this  organization (instance). |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| static [getCalendar](dw.system.System.md#getcalendar)() | Returns a new Calendar object in the time zone of the  current instance. |
+| static [getCompatibilityMode](dw.system.System.md#getcompatibilitymode)() | Returns the compatibility mode of the custom code version that is currently active. |
+| static [getInstanceHostname](dw.system.System.md#getinstancehostname)() | Returns instance hostname. |
+| static [getInstanceTimeZone](dw.system.System.md#getinstancetimezone)() | Returns the instance time zone. |
+| static [getInstanceType](dw.system.System.md#getinstancetype)() | Returns the type of the instance. |
+| static [getPreferences](dw.system.System.md#getpreferences)() | This method returns a container of all global preferences of this  organization (instance). |
+
+### 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)
+## Constant Details
+
+### DEVELOPMENT_SYSTEM
+
+- DEVELOPMENT_SYSTEM: [Number](TopLevel.Number.md) = 0
+  - : Represents the development system.
+
+
+---
+
+### PRODUCTION_SYSTEM
+
+- PRODUCTION_SYSTEM: [Number](TopLevel.Number.md) = 2
+  - : Represents the production system.
+
+
+---
+
+### STAGING_SYSTEM
+
+- STAGING_SYSTEM: [Number](TopLevel.Number.md) = 1
+  - : Represents the staging system.
+
+
+---
+
+## Property Details
+
+### calendar
+- calendar: [Calendar](dw.util.Calendar.md) `(read-only)`
+  - : Returns a new Calendar object in the time zone of the
+      current instance.
+
+
+
+---
+
+### compatibilityMode
+- compatibilityMode: [Number](TopLevel.Number.md) `(read-only)`
+  - : Returns the compatibility mode of the custom code version that is currently active. The compatibility mode is
+      returned as a number, e.g. compatibility mode "15.5" is returned as 1505.
+
+
+
+---
+
+### instanceHostname
+- instanceHostname: [String](TopLevel.String.md) `(read-only)`
+  - : Returns instance hostname.
+
+
+---
+
+### instanceTimeZone
+- instanceTimeZone: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the instance time zone. The instance time zone is the time zone in which global actions like jobs or
+      reporting are specified in the system. Keep in mind that the instance time zone is cached at the current session.
+      Changes will affect only new sessions.
+
+
+
+---
+
+### instanceType
+- instanceType: [Number](TopLevel.Number.md) `(read-only)`
+  - : Returns the type of the instance. An application server instance is configured to be of one of three types,
+      "development system", "staging system" or "production system".
+      
+      This method returns a constant representing the instance type of **this**
+      application server.
+
+
+    **See Also:**
+    - [DEVELOPMENT_SYSTEM](dw.system.System.md#development_system)
+    - [PRODUCTION_SYSTEM](dw.system.System.md#production_system)
+    - [STAGING_SYSTEM](dw.system.System.md#staging_system)
+
+
+---
+
+### preferences
+- preferences: [OrganizationPreferences](dw.system.OrganizationPreferences.md) `(read-only)`
+  - : This method returns a container of all global preferences of this
+      organization (instance).
+
+
+
+---
+
+## Method Details
+
+### getCalendar()
+- static getCalendar(): [Calendar](dw.util.Calendar.md)
+  - : Returns a new Calendar object in the time zone of the
+      current instance.
+
+
+    **Returns:**
+    - a Calendar object in the time zone of the
+              instance.
+
+
+
+---
+
+### getCompatibilityMode()
+- static getCompatibilityMode(): [Number](TopLevel.Number.md)
+  - : Returns the compatibility mode of the custom code version that is currently active. The compatibility mode is
+      returned as a number, e.g. compatibility mode "15.5" is returned as 1505.
+
+
+    **Returns:**
+    - The currently active compatibility mode.
+
+
+---
+
+### getInstanceHostname()
+- static getInstanceHostname(): [String](TopLevel.String.md)
+  - : Returns instance hostname.
+
+    **Returns:**
+    - instance hostname.
+
+
+---
+
+### getInstanceTimeZone()
+- static getInstanceTimeZone(): [String](TopLevel.String.md)
+  - : Returns the instance time zone. The instance time zone is the time zone in which global actions like jobs or
+      reporting are specified in the system. Keep in mind that the instance time zone is cached at the current session.
+      Changes will affect only new sessions.
+
+
+    **Returns:**
+    - the instance time zone.
+
+
+---
+
+### getInstanceType()
+- static getInstanceType(): [Number](TopLevel.Number.md)
+  - : Returns the type of the instance. An application server instance is configured to be of one of three types,
+      "development system", "staging system" or "production system".
+      
+      This method returns a constant representing the instance type of **this**
+      application server.
+
+
+    **Returns:**
+    - the instance type of the application server where this method was
+              called.
+
+
+    **See Also:**
+    - [DEVELOPMENT_SYSTEM](dw.system.System.md#development_system)
+    - [PRODUCTION_SYSTEM](dw.system.System.md#production_system)
+    - [STAGING_SYSTEM](dw.system.System.md#staging_system)
+
+
+---
+
+### getPreferences()
+- static getPreferences(): [OrganizationPreferences](dw.system.OrganizationPreferences.md)
+  - : This method returns a container of all global preferences of this
+      organization (instance).
+
+
+    **Returns:**
+    - a preferences object containing all global system and custom
+              preferences of this instance
+
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.system.Transaction.md

@@ -0,0 +1,107 @@
+<!-- prettier-ignore-start -->
+# Class Transaction
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.system.Transaction](dw.system.Transaction.md)
+
+Represents the current transaction. A transaction provides a context for performing atomic changes to persistent
+business objects. Before a business object can be created, changed, or deleted, a transaction must be started using
+the [begin()](dw.system.Transaction.md#begin) method. All changes on the touched business objects will only be made durable when the
+transaction is committed with [commit()](dw.system.Transaction.md#commit). If a transaction is rolled back, all changes so far will be reverted
+and the business object will have their previous state again. It is possible to begin a transaction multiple times in
+a nested way (like begin-begin-commit-commit). In this case, in order to commit the changes the commit method must be
+called symmetrically as often as begin. It is also possible to run multiple transactions within a single request, one
+after another (like begin-commit-begin-commit). In case of any exception while working with business objects inside
+of a transaction, the transaction cannot be committed anymore, but only be rolled back. Business code may try to take
+appropriate actions if it expects business-related problems at commit (for example, constraint violations). When a
+transaction is still open at the end of a pipeline call, controller call, or job step, the remaining changes are
+committed unless an exception is thrown.
+
+
+The following best practices exist for using transactions:
+
+- Avoid long running transactions in jobs.
+- Use one transaction for changes that belong together and need a joint rollback. In most cases, one transaction  for all changes in a request is better than multiple transactions for each individual object.
+- Don’t begin and commit a huge number of small transactions in a loop.
+- Avoid changing the same objects in parallel transactions.
+
+
+
+Example 1 - explicit control:
+
+
+```
+var txn = require('dw/system/Transaction');
+txn.begin();
+// work with business objects here
+txn.commit();
+```
+
+
+
+Example 2 - implicit control:
+
+
+```
+var txn = require('dw/system/Transaction');
+txn.wrap(function(){
+    // work with business objects here
+});
+```
+
+
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| static [begin](dw.system.Transaction.md#begin)() | Begins a transaction. |
+| static [commit](dw.system.Transaction.md#commit)() | Commits the current transaction. |
+| static [rollback](dw.system.Transaction.md#rollback)() | Rolls back the current transaction. |
+| static [wrap](dw.system.Transaction.md#wrapfunction)([Function](TopLevel.Function.md)) | Encloses the provided callback function in a begin-commit transactional context. |
+
+### 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
+
+### begin()
+- static begin(): void
+  - : Begins a transaction.
+
+
+---
+
+### commit()
+- static commit(): void
+  - : Commits the current transaction. The transaction must have been started with [begin()](dw.system.Transaction.md#begin) before.
+
+
+---
+
+### rollback()
+- static rollback(): void
+  - : Rolls back the current transaction. The transaction must have been started with [begin()](dw.system.Transaction.md#begin) before.
+
+
+---
+
+### wrap(Function)
+- static wrap(callback: [Function](TopLevel.Function.md)): [Object](TopLevel.Object.md)
+  - : Encloses the provided callback function in a begin-commit transactional context. If the transaction cannot be
+      committed successfully, it is rolled back instead and an exception is thrown.
+
+
+    **Parameters:**
+    - callback - a function that should be executed within a transactional context
+
+    **Returns:**
+    - the result of the callback function, if it returns something
+
+
+---
+
+<!-- prettier-ignore-end -->

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

@@ -0,0 +1,32 @@
+# Package dw.system
+
+## Classes
+| Class | Description |
+| --- | --- |
+| [AgentUserStatusCodes](dw.system.AgentUserStatusCodes.md) | AgentUserStatusCodes contains constants representing status codes that can be  used with a [Status](dw.system.Status.md) object to indicate the success or failure of the agent  user login process. |
+| [Cache](dw.system.Cache.md) | The Cache class represents a custom cache. |
+| [CacheMgr](dw.system.CacheMgr.md) | The CacheMgr class is the entry point for using custom caches. |
+| [HookMgr](dw.system.HookMgr.md) | This class provides functionality to call hooks. |
+| [InternalObject](dw.system.InternalObject.md) | Class used to wrap internal objects to hide them from  B2C Commerce Script code. |
+| [JobProcessMonitor](dw.system.JobProcessMonitor.md) | **_Reserved for future use_**. |
+| [Log](dw.system.Log.md) | A log4j like logger instance. |
+| [Logger](dw.system.Logger.md) | The Logger class provides logging utility methods. |
+| [LogNDC](dw.system.LogNDC.md) | A Nested Diagnostic Context, or NDC in short, is an instrument to distinguish   interleaved log output from different sources. |
+| [OrganizationPreferences](dw.system.OrganizationPreferences.md) | OrganizationPreferences is a container for custom global (i.e. |
+| [Pipeline](dw.system.Pipeline.md) | A helper for executing pipelines from JavaScript. |
+| [PipelineDictionary](dw.system.PipelineDictionary.md) | The class provides access to the values in the pipeline dictionary. |
+| [RemoteInclude](dw.system.RemoteInclude.md) | The class represents a remote include value that can be assigned to JSON Object properties. |
+| [Request](dw.system.Request.md) | Represents a request in Commerce Cloud Digital. |
+| [RequestHooks](dw.system.RequestHooks.md) | This class represents all script hooks that can be registered to receive notifications about storefront requests. |
+| [Response](dw.system.Response.md) | Represents an HTTP response in Commerce Cloud Digital. |
+| [RESTErrorResponse](dw.system.RESTErrorResponse.md) | This class represents a REST error response that is compliant with  [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457). |
+| [RESTResponseMgr](dw.system.RESTResponseMgr.md) | This class provides helper methods for creating REST error and success responses. |
+| [RESTSuccessResponse](dw.system.RESTSuccessResponse.md) | This class represents a REST success response that is compliant with the RFC standards. |
+| [SearchStatus](dw.system.SearchStatus.md) | A SearchStatus is used for communicating a Search API status back to a client. |
+| [Session](dw.system.Session.md) | Represents a session in B2C Commerce. |
+| [Site](dw.system.Site.md) | This class represents a site in Commerce Cloud Digital and provides access to  several site-level configuration values which are managed from within the  Business Manager. |
+| [SitePreferences](dw.system.SitePreferences.md) | SitePreferences is a container for custom site-level attributes. |
+| [Status](dw.system.Status.md) | A Status is used for communicating an API status code back to a client. |
+| [StatusItem](dw.system.StatusItem.md) | A StatusItem holds all the status information. |
+| [System](dw.system.System.md) | Represents the Commerce Cloud Digital server instance. |
+| [Transaction](dw.system.Transaction.md) | Represents the current transaction. |

package/data/script-api/dw.template.ISML.md

@@ -0,0 +1,127 @@
+<!-- prettier-ignore-start -->
+# Class ISML
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.template.ISML](dw.template.ISML.md)
+
+This class provides support for rendering ISML templates. For more details about the ISML syntax, refer to the
+Commerce Cloud Digital developer documentation. Templates are stored as \*.isml files. They are located in a
+locale-specific folder under the '/cartridge/templates' folder, with '/cartridge/template/default' being the default
+locale. The template name arguments of the various render methods represent the template path (without file ending)
+within this folder structure.
+
+
+Example for rendering a template with arguments from JavaScript code:
+
+
+```
+let isml = require('dw/template/ISML');
+isml.renderTemplate('helloworld', {
+    Message: 'Hello, World!'
+});
+```
+
+
+Example code for accessing the template arguments in the 'helloworld.isml' template from the above code snippet:
+
+
+```
+The message is: <isprint value="${pdict.Message}" />
+```
+
+
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| static [renderTemplate](dw.template.ISML.md#rendertemplatestring---variant-1)([String](TopLevel.String.md)) | Renders an ISML template and writes the output to the current response. |
+| static [renderTemplate](dw.template.ISML.md#rendertemplatestring-object---variant-1)([String](TopLevel.String.md), [Object](TopLevel.Object.md)) | Renders an ISML template and writes the output to the current response. |
+| static [renderTemplate](dw.template.ISML.md#rendertemplatestring---variant-2)([String](TopLevel.String.md)) | Renders an ISML template and writes the output to the current response. |
+| static [renderTemplate](dw.template.ISML.md#rendertemplatestring-object---variant-2)([String](TopLevel.String.md), [Object](TopLevel.Object.md)) | Renders an ISML template and writes the output to the current response. |
+
+### 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
+
+### renderTemplate(String) - Variant 1
+- static renderTemplate(template: [String](TopLevel.String.md)): void
+  - : Renders an ISML template and writes the output to the current response. The template may contain ISML tags which
+      control the character encoding, content type, caching behavior and so on of the response (see ISML
+      documentation).
+
+
+    **Parameters:**
+    - template - the template path
+
+    **API Version:**
+:::note
+No longer available as of version 17.7.
+Puts template arguments into the global pipeline dictionary.
+:::
+
+---
+
+### renderTemplate(String, Object) - Variant 1
+- static renderTemplate(template: [String](TopLevel.String.md), templateArgs: [Object](TopLevel.Object.md)): void
+  - : Renders an ISML template and writes the output to the current response. The template may contain ISML tags which
+      control the character encoding, content type, caching behavior and so on of the response (see ISML
+      documentation). This method takes an additional JavaScript object as argument. Its properties are accessible for
+      script expressions in the template under the "pdict.\*" variable.
+
+
+    **Parameters:**
+    - template - the template path
+    - templateArgs - the template arguments object
+
+    **API Version:**
+:::note
+No longer available as of version 17.7.
+Puts template arguments into the global pipeline dictionary.
+:::
+
+---
+
+### renderTemplate(String) - Variant 2
+- static renderTemplate(template: [String](TopLevel.String.md)): void
+  - : Renders an ISML template and writes the output to the current response. The template may contain ISML tags which
+      control the character encoding, content type, caching behavior and so on of the response (see ISML
+      documentation).
+
+
+    **Parameters:**
+    - template - the template path
+
+    **API Version:**
+:::note
+Available from version 17.7.
+Keeps template arguments in a local pipeline dictionary scope. This avoids side-effects on other templates.
+:::
+
+---
+
+### renderTemplate(String, Object) - Variant 2
+- static renderTemplate(template: [String](TopLevel.String.md), templateArgs: [Object](TopLevel.Object.md)): void
+  - : Renders an ISML template and writes the output to the current response. The template may contain ISML tags which
+      control the character encoding, content type, caching behavior and so on of the response (see ISML
+      documentation). This method takes an additional JavaScript object as argument. Its properties are accessible for
+      script expressions in the template under the "pdict.\*" variable.
+
+
+    **Parameters:**
+    - template - the template path
+    - templateArgs - the template arguments object
+
+    **API Version:**
+:::note
+Available from version 17.7.
+Keeps template arguments in a local pipeline dictionary scope. This avoids side-effects on other templates.
+:::
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.template.Velocity.md

@@ -0,0 +1,168 @@
+<!-- prettier-ignore-start -->
+# Class Velocity
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.template.Velocity](dw.template.Velocity.md)
+
+This class renders an Apache Velocity template. For Velocity template syntax, see
+[Velocity 1.7](https://velocity.apache.org/engine/releases/velocity-1.7/).
+
+
+The render() methods identify the template to render from:
+
+- a template file name, which is resolved in the Dynamic WebDAV file location for the current site.  Template file names must end with either '.vm' or '.vs'.
+- a dw.io.File object, which can point to any file system location that is accessible from a script
+- a string that holds the template content directly
+
+**Note:** Files included from an ISML template (either via `#parse` or `#include`) are always resolved
+in the Dynamic location, and it is not possible to provide an absolute path.
+
+
+
+On the target side of rendering, by default the render() methods write to the current response writer. When needed,
+a `dw.io.Writer` can be supplied as a target.
+
+
+Parameters for rendering can be passed as a single object holding the parameters as properties.
+
+
+To create a URL, pass the `URLUtils` class.
+
+
+To access localized strings, pass the `Resource` class:
+
+```
+var urlUtil = require('dw/web/URLUtils');
+velocity.render("$url.abs('Foo-Bar','cgid',$res.msg('key')", {'url' : urlUtil, 'res' : dw.web.Resource});
+```
+
+The complete set of [VelocityTools](https://velocity.apache.org/tools/releases/2.0/generic.html)
+ are provided to the template. You can use the tools to escape dynamic data, format text, and for other common tasks.
+
+
+Template files are cached for different amounts of time, depending on the instance type.
+
+
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| static [remoteInclude](dw.template.Velocity.md#remoteincludestring-string)([String](TopLevel.String.md), [String...](TopLevel.String.md)) | Includes the rendered content of the specified action URL, which usually is a pipeline or controller. |
+| static [render](dw.template.Velocity.md#renderstring-object)([String](TopLevel.String.md), [Object](TopLevel.Object.md)) | Renders an inline template to the response writer. |
+| static [render](dw.template.Velocity.md#renderstring-object-writer)([String](TopLevel.String.md), [Object](TopLevel.Object.md), [Writer](dw.io.Writer.md)) | Renders an inline template to the provided writer. |
+| static [renderTemplate](dw.template.Velocity.md#rendertemplatefile-object)([File](dw.io.File.md), [Object](TopLevel.Object.md)) | Renders a template file to the response writer. |
+| static [renderTemplate](dw.template.Velocity.md#rendertemplatefile-object-writer)([File](dw.io.File.md), [Object](TopLevel.Object.md), [Writer](dw.io.Writer.md)) | Renders a template file to the provided writer. |
+| static [renderTemplate](dw.template.Velocity.md#rendertemplatestring-object)([String](TopLevel.String.md), [Object](TopLevel.Object.md)) | Renders a template file to the response writer. |
+| static [renderTemplate](dw.template.Velocity.md#rendertemplatestring-object-writer)([String](TopLevel.String.md), [Object](TopLevel.Object.md), [Writer](dw.io.Writer.md)) | Renders a template file to the provided writer. |
+
+### 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
+
+### remoteInclude(String, String...)
+- static remoteInclude(action: [String](TopLevel.String.md), namesAndParams: [String...](TopLevel.String.md)): [String](TopLevel.String.md)
+  - : Includes the rendered content of the specified action URL, which usually is a pipeline or controller. Must only be used inside a Velocity
+      template, such as `$velocity.remoteInclude('Product-Show','sku','42')`
+
+
+    **Parameters:**
+    - action - the URL (pipeline or controller) to be included
+    - namesAndParams - several strings with name=value pairs , e.g.: 'pid', 'value1', 'cgid', value2'.
+
+    **Returns:**
+    - the string that needs to be added to the Velocity template to execute the remote include
+
+
+---
+
+### render(String, Object)
+- static render(templateContent: [String](TopLevel.String.md), args: [Object](TopLevel.Object.md)): void
+  - : Renders an inline template to the response writer.
+
+    **Parameters:**
+    - templateContent - the template content
+    - args - the argument object
+
+
+---
+
+### render(String, Object, Writer)
+- static render(templateContent: [String](TopLevel.String.md), args: [Object](TopLevel.Object.md), writer: [Writer](dw.io.Writer.md)): void
+  - : Renders an inline template to the provided writer.
+
+    **Parameters:**
+    - templateContent - the template content
+    - args - the argument object
+    - writer - the target writer
+
+
+---
+
+### renderTemplate(File, Object)
+- static renderTemplate(templateFile: [File](dw.io.File.md), args: [Object](TopLevel.Object.md)): void
+  - : Renders a template file to the response writer.
+
+    **Parameters:**
+    - templateFile - the file object denoting the template
+    - args - the argument object
+
+
+---
+
+### renderTemplate(File, Object, Writer)
+- static renderTemplate(templateFile: [File](dw.io.File.md), args: [Object](TopLevel.Object.md), writer: [Writer](dw.io.Writer.md)): void
+  - : Renders a template file to the provided writer.
+
+    **Parameters:**
+    - templateFile - the file object denoting the template
+    - args - the argument object
+    - writer - the target writer
+
+
+---
+
+### renderTemplate(String, Object)
+- static renderTemplate(templateFileName: [String](TopLevel.String.md), args: [Object](TopLevel.Object.md)): void
+  - : Renders a template file to the response writer.
+
+    **Parameters:**
+    - templateFileName - the file name of the template, relative to the current sites Dynamic file location.  For example, for a file at a location similar to:  
+```
+https://mydomain.com/on/demandware.servlet/webdav/Sites/Dynamic/SiteGenesis/myfile.vm
+```
+  render the file in this way:   
+```
+velocity.renderTemplate("myfile.vm", null);
+```
+
+    - args - the argument object
+
+
+---
+
+### renderTemplate(String, Object, Writer)
+- static renderTemplate(templateFileName: [String](TopLevel.String.md), args: [Object](TopLevel.Object.md), writer: [Writer](dw.io.Writer.md)): void
+  - : Renders a template file to the provided writer.
+
+    **Parameters:**
+    - templateFileName - the file name of the template, relative to the current sites Dynamic file location.  For example, for a file at a location similar to:  
+```
+https://mydomain.com/on/demandware.servlet/webdav/Sites/Dynamic/SiteGenesis/mydir/myfile.vm
+```
+  render the file in this way:   
+```
+velocity.renderTemplate("mydir/myfile.vm", null, result);
+```
+
+    - args - the argument object to pass to the template
+    - writer - the target writer
+
+
+---
+
+<!-- prettier-ignore-end -->

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

@@ -0,0 +1,7 @@
+# Package dw.template
+
+## Classes
+| Class | Description |
+| --- | --- |
+| [ISML](dw.template.ISML.md) | This class provides support for rendering ISML templates. |
+| [Velocity](dw.template.Velocity.md) | This class renders an Apache Velocity template. |