@salesforce/b2c-tooling-sdk 1.19.0 → 1.20.0

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

@@ -1,243 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class RESTResponseMgr
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.system.RESTResponseMgr](dw.system.RESTResponseMgr.md)
-
-This class provides helper methods for creating REST error and success responses. It is mainly intended to be used to
-build Custom REST APIs. But, any controller implementation planning to provide REST-like responses can use these
-methods. If these methods are being used in the controllers, note that a few defaults like URL prefix for
-`type` in `createError` methods will correspond to Custom REST APIs.
-
-
-
-## Constructor Summary
-
-| Constructor | Description |
-| --- | --- |
-| [RESTResponseMgr](#restresponsemgr)() |  |
-
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| static [createEmptySuccess](dw.system.RESTResponseMgr.md#createemptysuccessnumber)([Number](TopLevel.Number.md)) | Constructs a new [RESTSuccessResponse](dw.system.RESTSuccessResponse.md) object. |
-| static [createError](dw.system.RESTResponseMgr.md#createerrornumber)([Number](TopLevel.Number.md)) | Constructs a new [RESTErrorResponse](dw.system.RESTErrorResponse.md) object. |
-| static [createError](dw.system.RESTResponseMgr.md#createerrornumber-string)([Number](TopLevel.Number.md), [String](TopLevel.String.md)) | Constructs a new [RESTErrorResponse](dw.system.RESTErrorResponse.md) object. |
-| static [createError](dw.system.RESTResponseMgr.md#createerrornumber-string-string)([Number](TopLevel.Number.md), [String](TopLevel.String.md), [String](TopLevel.String.md)) | Constructs a new [RESTErrorResponse](dw.system.RESTErrorResponse.md) object. |
-| static [createError](dw.system.RESTResponseMgr.md#createerrornumber-string-string-string)([Number](TopLevel.Number.md), [String](TopLevel.String.md), [String](TopLevel.String.md), [String](TopLevel.String.md)) | Constructs a new [RESTErrorResponse](dw.system.RESTErrorResponse.md) object. |
-| static [createScapiRemoteInclude](dw.system.RESTResponseMgr.md#createscapiremoteincludestring-string-string-string-urlparameter)([String](TopLevel.String.md), [String](TopLevel.String.md), [String](TopLevel.String.md), [String](TopLevel.String.md), [URLParameter...](dw.web.URLParameter.md)) | Constructs a new [RemoteInclude](dw.system.RemoteInclude.md) object specific for the SCAPI include path. |
-| static [createStorefrontControllerRemoteInclude](dw.system.RESTResponseMgr.md#createstorefrontcontrollerremoteincludeurlaction-urlparameter)([URLAction](dw.web.URLAction.md), [URLParameter...](dw.web.URLParameter.md)) | Constructs a new [RemoteInclude](dw.system.RemoteInclude.md) object specific for the Storefront Controller include path. |
-| static [createSuccess](dw.system.RESTResponseMgr.md#createsuccessobject)([Object](TopLevel.Object.md)) | Constructs a new [RESTSuccessResponse](dw.system.RESTSuccessResponse.md) object. |
-| static [createSuccess](dw.system.RESTResponseMgr.md#createsuccessobject-number)([Object](TopLevel.Object.md), [Number](TopLevel.Number.md)) | Constructs a new [RESTSuccessResponse](dw.system.RESTSuccessResponse.md) 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)
-## Constructor Details
-
-### RESTResponseMgr()
-- RESTResponseMgr()
-  - : 
-
-
----
-
-## Method Details
-
-### createEmptySuccess(Number)
-- static createEmptySuccess(statusCode: [Number](TopLevel.Number.md)): [RESTSuccessResponse](dw.system.RESTSuccessResponse.md)
-  - : Constructs a new [RESTSuccessResponse](dw.system.RESTSuccessResponse.md) object. This method is to be used in scenarios where response body
-      is not expected (e.g. statusCode is 204).
-
-
-    **Parameters:**
-    - statusCode - The http status code of the response. The statusCode parameter should conform to RFC standards             for a success.
-
-    **Returns:**
-    - A new [RESTSuccessResponse](dw.system.RESTSuccessResponse.md) object.
-
-    **Throws:**
-    - IllegalArgumentException - If the statusCode is not in the (100..299) range.
-
-
----
-
-### createError(Number)
-- static createError(statusCode: [Number](TopLevel.Number.md)): [RESTErrorResponse](dw.system.RESTErrorResponse.md)
-  - : Constructs a new [RESTErrorResponse](dw.system.RESTErrorResponse.md) object. This method should be used when you have just the statusCode
-      of the error and want the type of error to be inferred.
-      
-      
-      'type' of the error is inferred from the status code as follows: 
-      
-      
-      - `400`- `bad-request`
-      - `401`- `unauthorized`
-      - `403`- `forbidden`
-      - `404`- `resource-not-found`
-      - `409`- `conflict`
-      - `412`- `precondition-failed`
-      - `429`- `too-many-requests`
-      - `500`- `internal-server-error`
-      - `default`- `about:blank`
-
-
-    **Parameters:**
-    - statusCode - The error code of the response. The statusCode parameter should conform to RFC standards for an             error.
-
-    **Returns:**
-    - A new [RESTErrorResponse](dw.system.RESTErrorResponse.md) object.
-
-    **Throws:**
-    - IllegalArgumentException - If the statusCode is not in the (400..599) range.
-
-
----
-
-### createError(Number, String)
-- static createError(statusCode: [Number](TopLevel.Number.md), type: [String](TopLevel.String.md)): [RESTErrorResponse](dw.system.RESTErrorResponse.md)
-  - : Constructs a new [RESTErrorResponse](dw.system.RESTErrorResponse.md) object. This method should be used when you want to omit 'title' and
-      'detail' of the error. With this method, custom error codes and types apart from the standard ones can be
-      constructed.
-
-
-    **Parameters:**
-    - statusCode - The error code of the response. The statusCode parameter should conform to RFC standards for an             error.
-    - type - Type of the error according to RFC 9457. We enforce the following restrictions on top of the RFC:                          <li>If the provided type is not an absolute URL, it will be prepended with             `https://api.commercecloud.salesforce.com/documentation/error/v1/custom-errors/`.</li>             <li>Custom error types are not allowed to have SYSTEM error type prefix:             `https://api.commercecloud.salesforce.com/documentation/error/v1/errors/`.</li>             </ul>
-
-    **Returns:**
-    - A new [RESTErrorResponse](dw.system.RESTErrorResponse.md) object.
-
-    **Throws:**
-    - IllegalArgumentException - If the statusCode is not in the (400..599) range or if the error type is not a              valid URI or conflicts with the SYSTEM error type namespace.
-
-
----
-
-### createError(Number, String, String)
-- static createError(statusCode: [Number](TopLevel.Number.md), type: [String](TopLevel.String.md), title: [String](TopLevel.String.md)): [RESTErrorResponse](dw.system.RESTErrorResponse.md)
-  - : Constructs a new [RESTErrorResponse](dw.system.RESTErrorResponse.md) object. This method should be used when you want to omit 'detail' of
-      the error but want to have valid 'statusCode', 'type' and 'title'.
-
-
-    **Parameters:**
-    - statusCode - The error code of the response. The statusCode parameter should conform to RFC standards for an             error.
-    - type - Type of the error according to RFC 9457. We enforce the following restrictions on top of the RFC:                          <li>If the provided type is not an absolute URL, it will be prepended with             `https://api.commercecloud.salesforce.com/documentation/error/v1/custom-errors/`.</li>             <li>Custom error types are not allowed to have SYSTEM error type prefix:             `https://api.commercecloud.salesforce.com/documentation/error/v1/errors/`.</li>             </ul>
-    - title - Human-readable summary of the error type.
-
-    **Returns:**
-    - A new [RESTErrorResponse](dw.system.RESTErrorResponse.md) object.
-
-    **Throws:**
-    - IllegalArgumentException - If the statusCode is not in the (400..599) range or if the error type is not a              valid URI or conflicts with SYSTEM error type namespace.
-
-
----
-
-### createError(Number, String, String, String)
-- static createError(statusCode: [Number](TopLevel.Number.md), type: [String](TopLevel.String.md), title: [String](TopLevel.String.md), detail: [String](TopLevel.String.md)): [RESTErrorResponse](dw.system.RESTErrorResponse.md)
-  - : Constructs a new [RESTErrorResponse](dw.system.RESTErrorResponse.md) object. This method can be used to construct error responses with
-      valid 'statusCode', 'type', 'title' and 'detail'. If you want to omit title or detail, you can pass in
-      `null`.
-
-
-    **Parameters:**
-    - statusCode - The error code of the response. The statusCode parameter should conform to RFC standards for an             error.
-    - type - Type of the error according to RFC 9457. We enforce the following restrictions on top of the RFC:                          <li>If the provided type is not an absolute URL, it will be prepended with             `https://api.commercecloud.salesforce.com/documentation/error/v1/custom-errors/`.</li>             <li>Custom error types are not allowed to have SYSTEM error type prefix:             `https://api.commercecloud.salesforce.com/documentation/error/v1/errors/`.</li>             </ul>
-    - title - Human-readable summary of the error type.
-    - detail - Human-readable explanation of the specific occurrence of the error.
-
-    **Returns:**
-    - A new [RESTErrorResponse](dw.system.RESTErrorResponse.md) object.
-
-    **Throws:**
-    - IllegalArgumentException - If the statusCode is not in the (400..599) range or if the error type is not a              valid URI or conflicts with SYSTEM error type namespace.
-
-
----
-
-### createScapiRemoteInclude(String, String, String, String, URLParameter...)
-- static createScapiRemoteInclude(apiFamily: [String](TopLevel.String.md), apiName: [String](TopLevel.String.md), apiVersion: [String](TopLevel.String.md), resourcePath: [String](TopLevel.String.md), params: [URLParameter...](dw.web.URLParameter.md)): [RemoteInclude](dw.system.RemoteInclude.md)
-  - : Constructs a new [RemoteInclude](dw.system.RemoteInclude.md) object specific for the SCAPI include path.
-      Usage:
-      SCAPI remote include URL have following form:
-      
-      ```
-      BASE_PATH/{apiFamily}/{apiName}/{apiVersion}/organizations/ORG_ID/{resourcePath}[?params]
-      ```
-      
-      For the given SCAPI resource path:
-      
-      ```
-      BASE_PATH/product/shopper-products/v1/organizations/ORG_ID/categories/root?siteId=YourShopHere
-      ```
-      
-      RemoteInclude object can be constructed in a script like following:
-      
-      ```
-      let include = dw.system.RESTResponseMgr.createScapiRemoteInclude("product", "shopper-products", "v1", "categories/root",
-          dw.web.URLParameter("siteId", "YourShopHere"));
-      ```
-      
-      Please notice that **'BASE\_PATH'** and **'ORG\_ID'** are automatically resolved.
-
-
-    **Parameters:**
-    - apiFamily - an API Family name. **Example:** 'product'.
-    - apiName - an API Name. **Example:** 'shopper-products'.
-    - apiVersion - an API Version. **Example:** 'v1'.
-    - resourcePath - a Resource path. **Example:** 'categories/root'
-    - params - a query parameters _(optional)_
-
-    **Returns:**
-    - a new instance of [RemoteInclude](dw.system.RemoteInclude.md).
-
-
----
-
-### createStorefrontControllerRemoteInclude(URLAction, URLParameter...)
-- static createStorefrontControllerRemoteInclude(action: [URLAction](dw.web.URLAction.md), params: [URLParameter...](dw.web.URLParameter.md)): [RemoteInclude](dw.system.RemoteInclude.md)
-  - : Constructs a new [RemoteInclude](dw.system.RemoteInclude.md) object specific for the Storefront Controller include path.
-
-    **Parameters:**
-    - action - a container to specify target controller. Hostnames in URL actions are ignored.
-    - params - a query parameters _(optional)_.
-
-    **Returns:**
-    - a new instance of [RemoteInclude](dw.system.RemoteInclude.md).
-
-
----
-
-### createSuccess(Object)
-- static createSuccess(body: [Object](TopLevel.Object.md)): [RESTSuccessResponse](dw.system.RESTSuccessResponse.md)
-  - : Constructs a new [RESTSuccessResponse](dw.system.RESTSuccessResponse.md) object. HTTP status code of the response will be defaulted to 200.
-
-    **Parameters:**
-    - body - The body of the successful response. This should always be a valid JavaScript JSON object.
-
-    **Returns:**
-    - A new [RESTSuccessResponse](dw.system.RESTSuccessResponse.md) object.
-
-
----
-
-### createSuccess(Object, Number)
-- static createSuccess(body: [Object](TopLevel.Object.md), statusCode: [Number](TopLevel.Number.md)): [RESTSuccessResponse](dw.system.RESTSuccessResponse.md)
-  - : Constructs a new [RESTSuccessResponse](dw.system.RESTSuccessResponse.md) object.
-
-    **Parameters:**
-    - body - The body of the successful response. This should always be a valid JavaScript JSON object.
-    - statusCode - The http status code of the response. The statusCode parameter should conform to RFC standards             for a success.
-
-    **Returns:**
-    - A new [RESTSuccessResponse](dw.system.RESTSuccessResponse.md) object.
-
-    **Throws:**
-    - IllegalArgumentException - If the statusCode is not in the (100..299) range.
-
-
----
-
-<!-- prettier-ignore-end -->

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

@@ -1,62 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class RESTSuccessResponse
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.system.RESTSuccessResponse](dw.system.RESTSuccessResponse.md)
-
-This class represents a REST success response that is compliant with the RFC standards. It can only be instantiated
-using the `createSuccess` methods in [RESTResponseMgr](dw.system.RESTResponseMgr.md).
-
-
-Here is an example: 
-
-`
- var body = {"hello": "world"} 
-
- var success = RESTResponseMgr.createSuccess(body); 
-
- success.render(); 
-
- ` 
-
-The above script would result in an HTTP response with status code 200 and the following body:
-
-`
- {
-
- &emsp;"hello": "world" 
-
- } 
-
- ` 
-
-
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [render](dw.system.RESTSuccessResponse.md#render)() | Sends the [RESTSuccessResponse](dw.system.RESTSuccessResponse.md) object as an HTTP response to the client. |
-
-### 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
-
-### render()
-- render(): void
-  - : Sends the [RESTSuccessResponse](dw.system.RESTSuccessResponse.md) object as an HTTP response to the client. This sets the "Content-Type"
-      header to "application/json" and expects the body to be a valid JavaScript JSON object.
-
-
-    **Throws:**
-    - IllegalStateException - If the RESTSuccessResponse object is already rendered.
-    - Exception - If there is an error while serializing the body.
-
-
----
-
-<!-- prettier-ignore-end -->

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

@@ -1,146 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class RemoteInclude
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.system.RemoteInclude](dw.system.RemoteInclude.md)
-
-The class represents a remote include value that can be assigned to JSON Object properties.
-
-
-**Important notes:**
-
-- Authentication and authorization checks are performed only for the top  level request, but NOT for remote include requests.
-- The `RestResponseMgr`method `createScapiRemoteInclude()`allows only SCAPI URLs.
-- The `RestResponseMgr`method `createStorefrontControllerRemoteInclude()`allows only Controller URLs.
-- Correct rendering of RemoteInclude-containing objects is only performed  when processed by `dw.system.RESTSuccessResponse.render()`method. Please check the provided examples.
-
-
-
-
-
-**Example 1. Specify remote include properties.**
-
-
-```
-function specifyRemoteIncludeProperties() {
-   var includeValue0 = dw.system.RESTResponseMgr.createScapiRemoteInclude("custom", "sample", "v1", "resource/path/0", dw.web.URLParameter("siteId", "TestWapi"));
-   var includeValue1 = dw.system.RESTResponseMgr.createScapiRemoteInclude("custom", "sample", "v1", "resource/path/1", dw.web.URLParameter("siteId", "TestWapi"));
-   var greeting = { "hello": "world", "includeProperty0": includeValue0, "includeProperty1": includeValue1 };
-
-   dw.system.RESTResponseMgr.createSuccess(greeting).render();
-}
-```
-
-
-
-
-
-**Example 2. Specify array of remote include properties.**
-
-
-```
-function specifyArrayOfRemoteIncludes() {
-  var includeValue0 = dw.system.RESTResponseMgr.createScapiRemoteInclude("custom", "sample", "v1", "resource/path/0", dw.web.URLParameter("siteId", "TestWapi"));
-  var includeValue1 = dw.system.RESTResponseMgr.createScapiRemoteInclude("custom", "sample", "v1", "resource/path/1", dw.web.URLParameter("siteId", "TestWapi"));
-  var greeting = { "hello": "world", "includeArray": [includeValue0, includeValue1] };
-
-  dw.system.RESTResponseMgr.createSuccess(greeting).render();
-}
-```
-
-
-
-
-
-**Example 3. Storefront controller remote include.**
-
-
-```
-function storefrontRemoteInclude()
-{
-    let remoteInclude = dw.system.RESTResponseMgr.createStorefrontControllerRemoteInclude(new URLAction("Category-Show", "Sites-MyShop-Site", dw.web.URLParameter("cid", "root")));
-    let json = {
-        status: "JSONOK",
-        include: remoteInclude
-    };
-    dw.system.RESTResponseMgr.createSuccess(json).render();
-}
-```
-
-
-
-
-
-**Error handling:**
-
-**SCAPI:**
-
-
-- In case of 404 response received on included resource, an empty JSON object '{}' will be supplied in final JSON.
-- In case of 201..299, 3xx, 4xx (excluding 404), 5xx response from included resource, final response status will be 500 'Internal Server Error'
-
-**Controllers:**
-
-
-- In case of any non 200 response from the included resource an empty string will be included.
-- Note: In case your response format is JSON be aware that this can result in invalid JSON.
-
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [url](#url): [String](TopLevel.String.md) `(read-only)` | Returns the URL string value specified for the current instance. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getUrl](dw.system.RemoteInclude.md#geturl)() | Returns the URL string value specified for the current instance. |
-| [toString](dw.system.RemoteInclude.md#tostring)() | Returns the URL string value specified for the current instance, same as  [getUrl()](dw.system.RemoteInclude.md#geturl). |
-| [valueOf](dw.system.RemoteInclude.md#valueof)() | Returns the URL string value specified for the current instance, same as  [getUrl()](dw.system.RemoteInclude.md#geturl). |
-
-### 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
-
-### url
-- url: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the URL string value specified for the current instance.
-
-
----
-
-## Method Details
-
-### getUrl()
-- getUrl(): [String](TopLevel.String.md)
-  - : Returns the URL string value specified for the current instance.
-
-
----
-
-### toString()
-- toString(): [String](TopLevel.String.md)
-  - : Returns the URL string value specified for the current instance, same as
-      [getUrl()](dw.system.RemoteInclude.md#geturl).
-
-
-
----
-
-### valueOf()
-- valueOf(): [Object](TopLevel.Object.md)
-  - : Returns the URL string value specified for the current instance, same as
-      [getUrl()](dw.system.RemoteInclude.md#geturl).
-
-
-
----
-
-<!-- prettier-ignore-end -->