@salesforce/b2c-tooling-sdk 0.0.0-nightly.20260119053920

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

@@ -0,0 +1,216 @@
+<!-- prettier-ignore-start -->
+# Class Logger
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.system.Logger](dw.system.Logger.md)
+
+The Logger class provides logging utility methods.
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [debugEnabled](#debugenabled): [Boolean](TopLevel.Boolean.md) `(read-only)` | This method returns true if debug logging is enabled. |
+| [errorEnabled](#errorenabled): [Boolean](TopLevel.Boolean.md) `(read-only)` | This method returns true if error logging is enabled. |
+| [infoEnabled](#infoenabled): [Boolean](TopLevel.Boolean.md) `(read-only)` | This method returns true if info logging is enabled. |
+| [rootLogger](#rootlogger): [Log](dw.system.Log.md) `(read-only)` | Returns the root logger object. |
+| [warnEnabled](#warnenabled): [Boolean](TopLevel.Boolean.md) `(read-only)` | This method returns true if warning logging is enabled. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| static [debug](dw.system.Logger.md#debugstring-object)([String](TopLevel.String.md), [Object...](TopLevel.Object.md)) | The method reports an debug level message. |
+| static [error](dw.system.Logger.md#errorstring-object)([String](TopLevel.String.md), [Object...](TopLevel.Object.md)) | The method reports an error level message. |
+| static [getLogger](dw.system.Logger.md#getloggerstring)([String](TopLevel.String.md)) | Returns the logger object for the given category. |
+| static [getLogger](dw.system.Logger.md#getloggerstring-string)([String](TopLevel.String.md), [String](TopLevel.String.md)) | Returns the logger object for the given file name prefix and category. |
+| static [getRootLogger](dw.system.Logger.md#getrootlogger)() | Returns the root logger object. |
+| static [info](dw.system.Logger.md#infostring-object)([String](TopLevel.String.md), [Object...](TopLevel.Object.md)) | The method reports an information level message. |
+| static [isDebugEnabled](dw.system.Logger.md#isdebugenabled)() | This method returns true if debug logging is enabled. |
+| static [isErrorEnabled](dw.system.Logger.md#iserrorenabled)() | This method returns true if error logging is enabled. |
+| static [isInfoEnabled](dw.system.Logger.md#isinfoenabled)() | This method returns true if info logging is enabled. |
+| static [isWarnEnabled](dw.system.Logger.md#iswarnenabled)() | This method returns true if warning logging is enabled. |
+| static [warn](dw.system.Logger.md#warnstring-object)([String](TopLevel.String.md), [Object...](TopLevel.Object.md)) | The method reports an warning level message. |
+
+### 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
+
+### debugEnabled
+- debugEnabled: [Boolean](TopLevel.Boolean.md) `(read-only)`
+  - : This method returns true if debug logging is enabled.
+
+
+---
+
+### errorEnabled
+- errorEnabled: [Boolean](TopLevel.Boolean.md) `(read-only)`
+  - : This method returns true if error logging is enabled.
+
+
+---
+
+### infoEnabled
+- infoEnabled: [Boolean](TopLevel.Boolean.md) `(read-only)`
+  - : This method returns true if info logging is enabled.
+
+
+---
+
+### rootLogger
+- rootLogger: [Log](dw.system.Log.md) `(read-only)`
+  - : Returns the root logger object.
+
+
+---
+
+### warnEnabled
+- warnEnabled: [Boolean](TopLevel.Boolean.md) `(read-only)`
+  - : This method returns true if warning logging is enabled.
+
+
+---
+
+## Method Details
+
+### debug(String, Object...)
+- static debug(msg: [String](TopLevel.String.md), args: [Object...](TopLevel.Object.md)): void
+  - : The method reports an debug level message. Arguments can be embedded
+      into the message, e.g. like "Failure {0} in {1}". The method implements
+      the Java MessageFormat.format() syntax.
+
+
+    **Parameters:**
+    - msg - the message to log.
+    - args - the arguments to insert into the message.
+
+
+---
+
+### error(String, Object...)
+- static error(msg: [String](TopLevel.String.md), args: [Object...](TopLevel.Object.md)): void
+  - : The method reports an error level message. Arguments can be embedded
+      into the message, e.g. like "Failure {0} in {1}". The method implements
+      the Java MessageFormat.format() syntax.
+
+
+    **Parameters:**
+    - msg - the message to log.
+    - args - the arguments to insert into the message.
+
+
+---
+
+### getLogger(String)
+- static getLogger(category: [String](TopLevel.String.md)): [Log](dw.system.Log.md)
+  - : Returns the logger object for the given category.
+
+    **Parameters:**
+    - category - - the category to get the logger for
+
+    **Returns:**
+    - the logger object for the given category.
+
+
+---
+
+### getLogger(String, String)
+- static getLogger(fileNamePrefix: [String](TopLevel.String.md), category: [String](TopLevel.String.md)): [Log](dw.system.Log.md)
+  - : Returns the logger object for the given file name prefix and category.
+      Throws an exception if maximum number of custom log files per day has already been obtained.
+
+
+    **Parameters:**
+    - fileNamePrefix - - the file name prefix to identify the logger  must not be null or an empty string,  must be at least 3 characters long,  can contain characters a-z A-Z 0-9 '-' '\_' only,  can have up to 25 characters  must not start or end with '-' or '\_'  can only start or end with a-z A-Z 0-9
+    - category - - the category to get the logger for, must not be null
+
+    **Returns:**
+    - the logger object for the given category.
+
+
+---
+
+### getRootLogger()
+- static getRootLogger(): [Log](dw.system.Log.md)
+  - : Returns the root logger object.
+
+    **Returns:**
+    - the root logger object.
+
+
+---
+
+### info(String, Object...)
+- static info(msg: [String](TopLevel.String.md), args: [Object...](TopLevel.Object.md)): void
+  - : The method reports an information level message. Arguments can be embedded
+      into the message, e.g. like "Failure {0} in {1}". The method implements
+      the Java MessageFormat.format() syntax.
+
+
+    **Parameters:**
+    - msg - the message to log.
+    - args - the arguments to insert into the message.
+
+
+---
+
+### isDebugEnabled()
+- static isDebugEnabled(): [Boolean](TopLevel.Boolean.md)
+  - : This method returns true if debug logging is enabled.
+
+    **Returns:**
+    - true if logging of debug messages is enabled, false otherwise.
+
+
+---
+
+### isErrorEnabled()
+- static isErrorEnabled(): [Boolean](TopLevel.Boolean.md)
+  - : This method returns true if error logging is enabled.
+
+    **Returns:**
+    - true if logging of error messages is enabled, false otherwise.
+
+
+---
+
+### isInfoEnabled()
+- static isInfoEnabled(): [Boolean](TopLevel.Boolean.md)
+  - : This method returns true if info logging is enabled.
+
+    **Returns:**
+    - true if logging of info messages is enabled, false otherwise.
+
+
+---
+
+### isWarnEnabled()
+- static isWarnEnabled(): [Boolean](TopLevel.Boolean.md)
+  - : This method returns true if warning logging is enabled.
+
+    **Returns:**
+    - true if logging of warn messages is enabled, false otherwise.
+
+
+---
+
+### warn(String, Object...)
+- static warn(msg: [String](TopLevel.String.md), args: [Object...](TopLevel.Object.md)): void
+  - : The method reports an warning level message. Arguments can be embedded
+      into the message, e.g. like "Failure {0} in {1}". The method implements
+      the Java MessageFormat.format() syntax.
+
+
+    **Parameters:**
+    - msg - the message to log.
+    - args - the arguments to insert into the message.
+
+
+---
+
+<!-- prettier-ignore-end -->

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

@@ -0,0 +1,53 @@
+<!-- prettier-ignore-start -->
+# Class OrganizationPreferences
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.object.PersistentObject](dw.object.PersistentObject.md)
+    - [dw.object.ExtensibleObject](dw.object.ExtensibleObject.md)
+      - [dw.system.OrganizationPreferences](dw.system.OrganizationPreferences.md)
+
+OrganizationPreferences is a container for custom global (i.e.
+organization-level) attributes. The object corresponds with system object
+definition "OrganizationPreferences". It has no system attributes and exists
+only as a place for merchants to define custom attributes which need to be
+available to all of their sites.
+
+
+An instance is obtained by calling [System.getPreferences()](dw.system.System.md#getpreferences).
+Once an instance of the container is obtained, it is possible to read/write
+organization preference values by using the usual syntax for
+[ExtensibleObject](dw.object.ExtensibleObject.md) instances. For example:
+
+```
+var orgPrefs : OrganizationPreferences = dw.system.System.getPreferences();
+var myOrgPrefValue : String = orgPrefs.getCustom()["myOrgPref"];
+```
+
+
+
+**Note:** this class allows access to sensitive security-related data.
+Pay special attention to PCI DSS v3. requirements 2, 4, and 12.
+
+
+Commerce Cloud Digital defines many organization-level preferences, relating to
+locale, timezone, geolocations, etc, which can be managed within the
+"Global Preferences" module of the Business Manager, but these preferences
+are not accessible through this object.
+
+
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+### 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)
+<!-- prettier-ignore-end -->

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

@@ -0,0 +1,94 @@
+<!-- prettier-ignore-start -->
+# Class Pipeline
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.system.Pipeline](dw.system.Pipeline.md)
+
+A helper for executing pipelines from JavaScript. The main purpose for this API is to invoke process pipelines from
+JavaScript controllers, e.g. pipelines that return with an end node and that do not perform user interactions.
+Pipelines that span across multiple requests (e.g. that contain Interaction-Continue-Nodes) are not supported and may
+not work as expected. The pipeline will be executed within the current request and not by a remote call, so this API
+works roughly like a Call node in a pipeline. The called pipeline will get its own local pipeline dictionary. The
+dictionary can be populated with initial values from an argument object. Any results from the pipeline can be read
+from the pipeline dictionary that is returned by the [execute(String)](dw.system.Pipeline.md#executestring) methods.
+
+
+If an exception occurs during the pipeline processing, the Error-branch of the pipeline will be called. If no error
+handling exists for the pipeline, the exception will be propagated and can be handled by the script code.
+
+
+If the pipeline finishes with an End node, the name of the end node can be obtained from the returned pipeline
+dictionary under the key 'EndNodeName'.
+
+
+Example:
+
+
+```
+let Pipeline = require('dw/system/Pipeline');
+let pdict = Pipeline.execute('MyPipeline-Start', {
+    MyArgString:     'someStringValue',
+    MyArgNumber:     12345,
+    MyArgBoolean:    true
+});
+let result = pdict.MyReturnValue;
+```
+
+
+This feature requires an API version >=15.5.
+
+
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| static [execute](dw.system.Pipeline.md#executestring)([String](TopLevel.String.md)) | Executes a pipeline. |
+| static [execute](dw.system.Pipeline.md#executestring-object)([String](TopLevel.String.md), [Object](TopLevel.Object.md)) | Executes a pipeline. |
+
+### 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
+
+### execute(String)
+- static execute(pipeline: [String](TopLevel.String.md)): [PipelineDictionary](dw.system.PipelineDictionary.md)
+  - : Executes a pipeline.
+
+    **Parameters:**
+    - pipeline - the pipeline identifier, must consist of the pipeline name and the start node name, like             'PipelineName-StartNodeName'
+
+    **Returns:**
+    - the pipeline dictionary with the pipeline results
+
+    **API Version:**
+:::note
+Available from version 15.5.
+New convenience method for easier migration of pipeline-based systems to JavaScript controllers.
+:::
+
+---
+
+### execute(String, Object)
+- static execute(pipeline: [String](TopLevel.String.md), args: [Object](TopLevel.Object.md)): [PipelineDictionary](dw.system.PipelineDictionary.md)
+  - : Executes a pipeline. The pipeline dictionary will be initialized with the provided arguments.
+
+    **Parameters:**
+    - pipeline - the pipeline identifier, must consist of a pipeline name and a start node name, like             'PipelineName-StartNodeName'
+    - args - an object whose properties represent the initial values of the pipeline dictionary
+
+    **Returns:**
+    - the pipeline dictionary with the pipeline results
+
+    **API Version:**
+:::note
+Available from version 15.5.
+New convenience method for easier migration of pipeline-based systems to JavaScript controllers.
+:::
+
+---
+
+<!-- prettier-ignore-end -->

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

@@ -0,0 +1,42 @@
+<!-- prettier-ignore-start -->
+# Class PipelineDictionary
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.system.PipelineDictionary](dw.system.PipelineDictionary.md)
+
+The class provides access to the values in the pipeline dictionary. You use
+dynamic properties to access values, such as pdict.myvalue or
+pdict\['myvalue'\];
+
+
+The class is used in two different contexts, one where access is limited to
+the declared input/output values and second to a context with full access.
+Inside scripts, the PipelineDictionary allows you to access declared in/out
+values (regardless of the alias used in the pipeline and the actual key under
+which the value is stored). In templates and pipelines, all values can be
+accessed. In templates the pipeline dictionary is exposed as variable pdict
+(e.g. ${pdict.Product.ID}).
+
+
+There are several values that are automatically stored in the
+PipelineDictionary with each request. These include but are not limited to:
+
+
+- CurrentSession
+- CurrentRequest
+- CurrentHttpParameterMap
+- CurrentForms
+- CurrentCustomer
+- etc.
+
+
+
+## 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.system.RESTErrorResponse.md

@@ -0,0 +1,102 @@
+<!-- prettier-ignore-start -->
+# Class RESTErrorResponse
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.system.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). It can only be instantiated using the
+`createError` methods in [RESTResponseMgr](dw.system.RESTResponseMgr.md).
+
+
+Here is an example:
+
+
+```
+
+var error = RESTResponseMgr.createError(400);
+error.custom.foo = "bar";
+error.render();
+```
+
+
+The above script would result in an HTTP response with status code 400 and the following body:
+
+
+```
+
+{
+    "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/custom-errors/bad-request",
+    "c_foo": "bar"
+}
+```
+
+
+NOTE:
+
+- Custom attributes are rendered with "c\_" prefix as shown in the example above.
+- Rendering works as described in [JSON.stringify(Object)](TopLevel.JSON.md#stringifyobject).
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [custom](#custom): [CustomAttributes](dw.object.CustomAttributes.md) `(read-only)` | Returns all the custom attributes associated with the error response object. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getCustom](dw.system.RESTErrorResponse.md#getcustom)() | Returns all the custom attributes associated with the error response object. |
+| [render](dw.system.RESTErrorResponse.md#render)() | Sends the [RESTErrorResponse](dw.system.RESTErrorResponse.md) object as an HTTP error response to the client, adhering to  [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457). |
+
+### 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 all the custom attributes associated with the error response object. The attributes are stored for the
+      lifetime of the error response object.
+
+
+
+---
+
+## Method Details
+
+### getCustom()
+- getCustom(): [CustomAttributes](dw.object.CustomAttributes.md)
+  - : Returns all the custom attributes associated with the error response object. The attributes are stored for the
+      lifetime of the error response object.
+
+
+    **Returns:**
+    - All the custom attributes associated with the error response object.
+
+
+---
+
+### render()
+- render(): void
+  - : Sends the [RESTErrorResponse](dw.system.RESTErrorResponse.md) object as an HTTP error response to the client, adhering to
+      [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457). This method sets the "Content-Type" header to
+      "application/problem+json", HTTP Status Code to statusCode attribute and constructs the body from type, title,
+      detail and custom attributes of the object. Custom attributes are rendered with "c\_" prefix to the attribute
+      name.
+
+
+    **Throws:**
+    - IllegalStateException - If the RESTErrorResponse object is already rendered.
+    - Exception - If there is an error while serializing the RESTErrorResponse object.
+
+
+---
+
+<!-- prettier-ignore-end -->