@salesforce/b2c-tooling-sdk 1.19.1 → 1.20.0

package/data/script-api/dw.svc.HTTPServiceDefinition.md

@@ -1,290 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class HTTPServiceDefinition
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.svc.ServiceDefinition](dw.svc.ServiceDefinition.md)
-    - [dw.svc.HTTPServiceDefinition](dw.svc.HTTPServiceDefinition.md)
-
-Represents an HTTP Service Definition.
-
-
-The HTTP Service will use the return value of the createRequest callback as the request body (if supported by the
-HTTP method). If this is an array of non-null [HTTPRequestPart](dw.net.HTTPRequestPart.md) objects, then a multi-part request will
-be formed. Otherwise the object is converted to a String and used.
-
-
-See also [XML.toXMLString()](TopLevel.XML.md#toxmlstring) and [JSON.stringify(Object)](TopLevel.JSON.md#stringifyobject), which must be
-explicitly called if needed.
-
-
-**Deprecated:**
-:::warning
-This class is only used with the deprecated [ServiceRegistry](dw.svc.ServiceRegistry.md). Use the [LocalServiceRegistry](dw.svc.LocalServiceRegistry.md)
-            instead, which allows configuration on the [HTTPService](dw.svc.HTTPService.md) directly.
-
-:::
-**API Version:**
-:::note
-No longer available as of version 19.10.
-:::
-
-## All Known Subclasses
-[HTTPFormServiceDefinition](dw.svc.HTTPFormServiceDefinition.md)
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [authentication](#authentication): [String](TopLevel.String.md) | Returns the authentication type. |
-| [cachingTTL](#cachingttl): [Number](TopLevel.Number.md) | Returns the caching time to live value. |
-| [encoding](#encoding): [String](TopLevel.String.md) | Returns the request body encoding to declare. |
-| [outFile](#outfile): [File](dw.io.File.md) | Returns the output file, or null if there is none. |
-| [requestMethod](#requestmethod): [String](TopLevel.String.md) | Returns the request method. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [addHeader](dw.svc.HTTPServiceDefinition.md#addheaderstring-string)([String](TopLevel.String.md), [String](TopLevel.String.md)) | Adds an HTTP Header. |
-| [addParam](dw.svc.HTTPServiceDefinition.md#addparamstring-string)([String](TopLevel.String.md), [String](TopLevel.String.md)) | Adds a query parameter that will be appended to the URL. |
-| [getAuthentication](dw.svc.HTTPServiceDefinition.md#getauthentication)() | Returns the authentication type. |
-| [getCachingTTL](dw.svc.HTTPServiceDefinition.md#getcachingttl)() | Returns the caching time to live value. |
-| [getEncoding](dw.svc.HTTPServiceDefinition.md#getencoding)() | Returns the request body encoding to declare. |
-| [getOutFile](dw.svc.HTTPServiceDefinition.md#getoutfile)() | Returns the output file, or null if there is none. |
-| [getRequestMethod](dw.svc.HTTPServiceDefinition.md#getrequestmethod)() | Returns the request method. |
-| [setAuthentication](dw.svc.HTTPServiceDefinition.md#setauthenticationstring)([String](TopLevel.String.md)) | Sets the type of authentication. |
-| [setCachingTTL](dw.svc.HTTPServiceDefinition.md#setcachingttlnumber)([Number](TopLevel.Number.md)) | Enables caching for GET requests. |
-| [setEncoding](dw.svc.HTTPServiceDefinition.md#setencodingstring)([String](TopLevel.String.md)) | Sets the encoding of the request body (if any). |
-| [setOutFile](dw.svc.HTTPServiceDefinition.md#setoutfilefile)([File](dw.io.File.md)) | Sets the output file in which to write the HTTP response body. |
-| [setRequestMethod](dw.svc.HTTPServiceDefinition.md#setrequestmethodstring)([String](TopLevel.String.md)) | Sets the HTTP request method. |
-
-### Methods inherited from class ServiceDefinition
-
-[configure](dw.svc.ServiceDefinition.md#configureobject), [getConfiguration](dw.svc.ServiceDefinition.md#getconfiguration), [getServiceName](dw.svc.ServiceDefinition.md#getservicename), [isMock](dw.svc.ServiceDefinition.md#ismock), [isThrowOnError](dw.svc.ServiceDefinition.md#isthrowonerror), [setMock](dw.svc.ServiceDefinition.md#setmock), [setThrowOnError](dw.svc.ServiceDefinition.md#setthrowonerror)
-### 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
-
-### authentication
-- authentication: [String](TopLevel.String.md)
-  - : Returns the authentication type.
-
-
----
-
-### cachingTTL
-- cachingTTL: [Number](TopLevel.Number.md)
-  - : Returns the caching time to live value.
-
-    **See Also:**
-    - [setCachingTTL(Number)](dw.svc.HTTPServiceDefinition.md#setcachingttlnumber)
-
-
----
-
-### encoding
-- encoding: [String](TopLevel.String.md)
-  - : Returns the request body encoding to declare.
-
-
----
-
-### outFile
-- outFile: [File](dw.io.File.md)
-  - : Returns the output file, or null if there is none.
-
-
----
-
-### requestMethod
-- requestMethod: [String](TopLevel.String.md)
-  - : Returns the request method.
-
-
----
-
-## Method Details
-
-### addHeader(String, String)
-- addHeader(name: [String](TopLevel.String.md), val: [String](TopLevel.String.md)): [HTTPServiceDefinition](dw.svc.HTTPServiceDefinition.md)
-  - : Adds an HTTP Header.
-
-    **Parameters:**
-    - name - Header name.
-    - val - Header value.
-
-    **Returns:**
-    - this HTTP Service Definition.
-
-
----
-
-### addParam(String, String)
-- addParam(name: [String](TopLevel.String.md), val: [String](TopLevel.String.md)): [HTTPServiceDefinition](dw.svc.HTTPServiceDefinition.md)
-  - : Adds a query parameter that will be appended to the URL.
-
-    **Parameters:**
-    - name - Parameter name.
-    - val - Parameter value.
-
-    **Returns:**
-    - this HTTP Service Definition.
-
-
----
-
-### getAuthentication()
-- getAuthentication(): [String](TopLevel.String.md)
-  - : Returns the authentication type.
-
-    **Returns:**
-    - Authentication type.
-
-
----
-
-### getCachingTTL()
-- getCachingTTL(): [Number](TopLevel.Number.md)
-  - : Returns the caching time to live value.
-
-    **Returns:**
-    - The caching time to live value in seconds.
-
-    **See Also:**
-    - [setCachingTTL(Number)](dw.svc.HTTPServiceDefinition.md#setcachingttlnumber)
-
-
----
-
-### getEncoding()
-- getEncoding(): [String](TopLevel.String.md)
-  - : Returns the request body encoding to declare.
-
-    **Returns:**
-    - Request encoding.
-
-
----
-
-### getOutFile()
-- getOutFile(): [File](dw.io.File.md)
-  - : Returns the output file, or null if there is none.
-
-    **Returns:**
-    - Output file or null.
-
-
----
-
-### getRequestMethod()
-- getRequestMethod(): [String](TopLevel.String.md)
-  - : Returns the request method.
-
-    **Returns:**
-    - HTTP Request method.
-
-
----
-
-### setAuthentication(String)
-- setAuthentication(authentication: [String](TopLevel.String.md)): [HTTPServiceDefinition](dw.svc.HTTPServiceDefinition.md)
-  - : Sets the type of authentication. Valid values include "BASIC" and "NONE".
-      
-      
-      The default value is BASIC.
-
-
-    **Parameters:**
-    - authentication - Type of authentication.
-
-    **Returns:**
-    - this HTTP Service Definition.
-
-
----
-
-### setCachingTTL(Number)
-- setCachingTTL(ttl: [Number](TopLevel.Number.md)): [HTTPServiceDefinition](dw.svc.HTTPServiceDefinition.md)
-  - : Enables caching for GET requests.
-      
-      
-      This only caches status codes 2xx with a content length and size of less than 50k that are not immediately
-      written to file. The URL and the user name are used as cache keys. The total size of cacheable content and the
-      number of cached items is limited and automatically managed by the system.
-      
-      
-      Cache control information sent by the remote server is ignored.
-      
-      
-      Caching HTTP responses should be done very carefully. It is important to ensure that the response really depends
-      only on the URL and doesn't contain any remote state information or time information which is independent of the
-      URL. It is also important to verify that the application sends exactly the same URL multiple times.
-
-
-    **Parameters:**
-    - ttl - The time to live for the cached content in seconds. A value of 0 or less disables caching.
-
-    **See Also:**
-    - [HTTPClient.enableCaching(Number)](dw.net.HTTPClient.md#enablecachingnumber)
-
-
----
-
-### setEncoding(String)
-- setEncoding(encoding: [String](TopLevel.String.md)): [HTTPServiceDefinition](dw.svc.HTTPServiceDefinition.md)
-  - : Sets the encoding of the request body (if any).
-      
-      
-      The default value is UTF-8.
-
-
-    **Parameters:**
-    - encoding - Encoding of the request body.
-
-    **Returns:**
-    - this HTTP Service Definition.
-
-
----
-
-### setOutFile(File)
-- setOutFile(outFile: [File](dw.io.File.md)): [HTTPServiceDefinition](dw.svc.HTTPServiceDefinition.md)
-  - : Sets the output file in which to write the HTTP response body.
-      
-      
-      The default behavior is to not write a file.
-
-
-    **Parameters:**
-    - outFile - Output file, or null to disable.
-
-    **Returns:**
-    - this HTTP Service Definition.
-
-
----
-
-### setRequestMethod(String)
-- setRequestMethod(requestMethod: [String](TopLevel.String.md)): [HTTPServiceDefinition](dw.svc.HTTPServiceDefinition.md)
-  - : Sets the HTTP request method.
-      
-      
-      Valid values include GET, PUT, POST, and DELETE.
-      
-      
-      The default value is POST.
-
-
-    **Parameters:**
-    - requestMethod - HTTP request method.
-
-    **Returns:**
-    - this HTTP Service Definition.
-
-
----
-
-<!-- prettier-ignore-end -->

package/data/script-api/dw.svc.LocalServiceRegistry.md

@@ -1,63 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class LocalServiceRegistry
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.svc.LocalServiceRegistry](dw.svc.LocalServiceRegistry.md)
-
-The LocalServiceRegistry is responsible for managing Service instances.
-
-
-Typical usage involves several steps:
-
-1. The service is defined in the Business Manager and configured with necessary credentials.
-2. An instance of the service is created and configured in a script:      
-   ```
-   var myFTPService = LocalServiceRegistry.createService("MyFTPService", {    mockExec : function(svc:FTPService, params) {        return [            { "name": "file1", "timestamp": new Date(2011, 02, 21)},            { "name": "file2", "timestamp": new Date(2012, 02, 21)},            { "name": "file3", "timestamp": new Date(2013, 02, 21)}        ];    },    createRequest: function(svc:FTPService, params) {        svc.setOperation("list", "/");    },    parseResponse : function(svc:FTPService, listOutput) {        var x : Array = [];        var resp : Array = listOutput;        for(var i = 0; i <resp.length; i++) {            var f = resp[i];            x.push( { "name": f['name'], "timestamp": f['timestamp'] } );        }        return x;    }});
-   ```
-
-3. The service is called in order to perform the operation:      
-   ```
-   var result : Result = myFTPService.call();if(result.status == 'OK') {    // The result.object is the object returned by the 'after' callback.} else {    // Handle the error. See result.error for more information.}
-   ```
-
-
-
-Unlike [ServiceRegistry](dw.svc.ServiceRegistry.md), the configured service is local to the current script call,
-so this deals directly with [Service](dw.svc.Service.md) instances rather than the intermediate [ServiceDefinition](dw.svc.ServiceDefinition.md).
-This means that a cartridge-level initialization script (and the package.json) is no longer needed.
-
-
-See [ServiceCallback](dw.svc.ServiceCallback.md) for all the callback options, and individual [Service](dw.svc.Service.md)
-classes for customization specific to a service type.
-
-
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| static [createService](dw.svc.LocalServiceRegistry.md#createservicestring-object)([String](TopLevel.String.md), [Object](TopLevel.Object.md)) | Constructs and configures a service with a callback. |
-
-### 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
-
-### createService(String, Object)
-- static createService(serviceID: [String](TopLevel.String.md), configObj: [Object](TopLevel.Object.md)): [Service](dw.svc.Service.md)
-  - : Constructs and configures a service with a callback.
-
-    **Parameters:**
-    - serviceID - Unique Service ID.
-    - configObj - Configuration callback. See [ServiceCallback](dw.svc.ServiceCallback.md) for a description of available callback methods.
-
-    **Returns:**
-    - Associated [Service](dw.svc.Service.md), which can be used for further protocol-specific configuration.
-
-
----
-
-<!-- prettier-ignore-end -->

package/data/script-api/dw.svc.Result.md

@@ -1,320 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class Result
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.svc.Result](dw.svc.Result.md)
-
-Represents the result of a service call.
-
-
-## Constant Summary
-
-| Constant | Description |
-| --- | --- |
-| [ERROR](#error): [String](TopLevel.String.md) = "ERROR" | Status indicating a general service error. |
-| [OK](#ok): [String](TopLevel.String.md) = "OK" | Status indicating a successful service call. |
-| [SERVICE_UNAVAILABLE](#service_unavailable): [String](TopLevel.String.md) = "SERVICE_UNAVAILABLE" | Status indicating the service is unavailable. |
-| [UNAVAILABLE_CIRCUIT_BROKEN](#unavailable_circuit_broken): [String](TopLevel.String.md) = "CIRCUIT_BROKEN" | Unavailable reason: No call was made because the circuit breaker prevented it. |
-| [UNAVAILABLE_CONFIG_PROBLEM](#unavailable_config_problem): [String](TopLevel.String.md) = "CONFIG_PROBLEM" | Unavailable reason: No call was made because the service was not configured correctly. |
-| [UNAVAILABLE_DISABLED](#unavailable_disabled): [String](TopLevel.String.md) = "DISABLED" | Unavailable reason: No call was made because the service is disabled. |
-| [UNAVAILABLE_RATE_LIMITED](#unavailable_rate_limited): [String](TopLevel.String.md) = "RATE_LIMITED" | Unavailable reason: No call was made because the rate limit was hit. |
-| [UNAVAILABLE_TIMEOUT](#unavailable_timeout): [String](TopLevel.String.md) = "TIMEOUT" | Unavailable reason: A real call was made but a timeout occurred. |
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [error](#error): [Number](TopLevel.Number.md) `(read-only)` | Returns an error-specific code if applicable. |
-| [errorMessage](#errormessage): [String](TopLevel.String.md) `(read-only)` | Returns an error message on a non-OK status. |
-| [mockResult](#mockresult): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns the status of whether the response is the result of a "mock" service call. |
-| [msg](#msg): [String](TopLevel.String.md) `(read-only)` | Returns an extra error message on failure (if any). |
-| [object](#object): [Object](TopLevel.Object.md) `(read-only)` | Returns the actual object returned by the service when the status is OK. |
-| [ok](#ok): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns the status of whether the service call was successful. |
-| [status](#status): [String](TopLevel.String.md) `(read-only)` | Returns the status. |
-| [unavailableReason](#unavailablereason): [String](TopLevel.String.md) `(read-only)` | Returns the reason the status is SERVICE\_UNAVAILABLE. |
-
-## Constructor Summary
-
-| Constructor | Description |
-| --- | --- |
-| [Result](#result)() | Constructs a new result instance. |
-
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getError](dw.svc.Result.md#geterror)() | Returns an error-specific code if applicable. |
-| [getErrorMessage](dw.svc.Result.md#geterrormessage)() | Returns an error message on a non-OK status. |
-| [getMsg](dw.svc.Result.md#getmsg)() | Returns an extra error message on failure (if any). |
-| [getObject](dw.svc.Result.md#getobject)() | Returns the actual object returned by the service when the status is OK. |
-| [getStatus](dw.svc.Result.md#getstatus)() | Returns the status. |
-| [getUnavailableReason](dw.svc.Result.md#getunavailablereason)() | Returns the reason the status is SERVICE\_UNAVAILABLE. |
-| [isMockResult](dw.svc.Result.md#ismockresult)() | Returns the status of whether the response is the result of a "mock" service call. |
-| [isOk](dw.svc.Result.md#isok)() | Returns the status of whether the service call was successful. |
-| [toString](dw.svc.Result.md#tostring)() | Returns a string representation of the result. |
-
-### 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
-
-### ERROR
-
-- ERROR: [String](TopLevel.String.md) = "ERROR"
-  - : Status indicating a general service error.
-
-
----
-
-### OK
-
-- OK: [String](TopLevel.String.md) = "OK"
-  - : Status indicating a successful service call.
-
-
----
-
-### SERVICE_UNAVAILABLE
-
-- SERVICE_UNAVAILABLE: [String](TopLevel.String.md) = "SERVICE_UNAVAILABLE"
-  - : Status indicating the service is unavailable. This includes timeouts, rate limits, and remote server issues.
-
-
----
-
-### UNAVAILABLE_CIRCUIT_BROKEN
-
-- UNAVAILABLE_CIRCUIT_BROKEN: [String](TopLevel.String.md) = "CIRCUIT_BROKEN"
-  - : Unavailable reason: No call was made because the circuit breaker prevented it.
-
-
----
-
-### UNAVAILABLE_CONFIG_PROBLEM
-
-- UNAVAILABLE_CONFIG_PROBLEM: [String](TopLevel.String.md) = "CONFIG_PROBLEM"
-  - : Unavailable reason: No call was made because the service was not configured correctly.
-
-
----
-
-### UNAVAILABLE_DISABLED
-
-- UNAVAILABLE_DISABLED: [String](TopLevel.String.md) = "DISABLED"
-  - : Unavailable reason: No call was made because the service is disabled.
-
-
----
-
-### UNAVAILABLE_RATE_LIMITED
-
-- UNAVAILABLE_RATE_LIMITED: [String](TopLevel.String.md) = "RATE_LIMITED"
-  - : Unavailable reason: No call was made because the rate limit was hit.
-
-
----
-
-### UNAVAILABLE_TIMEOUT
-
-- UNAVAILABLE_TIMEOUT: [String](TopLevel.String.md) = "TIMEOUT"
-  - : Unavailable reason: A real call was made but a timeout occurred.
-
-
----
-
-## Property Details
-
-### error
-- error: [Number](TopLevel.Number.md) `(read-only)`
-  - : Returns an error-specific code if applicable. For example, this is the HTTP response code for an
-      [HTTPService](dw.svc.HTTPService.md).
-
-
-
----
-
-### errorMessage
-- errorMessage: [String](TopLevel.String.md) `(read-only)`
-  - : Returns an error message on a non-OK status.
-
-
----
-
-### mockResult
-- mockResult: [Boolean](TopLevel.Boolean.md) `(read-only)`
-  - : Returns the status of whether the response is the result of a "mock" service call.
-
-
----
-
-### msg
-- msg: [String](TopLevel.String.md) `(read-only)`
-  - : Returns an extra error message on failure (if any).
-
-
----
-
-### object
-- object: [Object](TopLevel.Object.md) `(read-only)`
-  - : Returns the actual object returned by the service when the status is OK.
-
-
----
-
-### ok
-- ok: [Boolean](TopLevel.Boolean.md) `(read-only)`
-  - : Returns the status of whether the service call was successful.
-
-
----
-
-### status
-- status: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the status. This is "OK" on success. Failure codes include "ERROR" and "SERVICE\_UNAVAILABLE".
-      
-      
-      If the status is "SERVICE\_UNAVAILABLE", then the unavailableReason is guaranteed to be non-null.
-
-
-    **See Also:**
-    - [OK](dw.svc.Result.md#ok)
-    - [ERROR](dw.svc.Result.md#error)
-    - [SERVICE_UNAVAILABLE](dw.svc.Result.md#service_unavailable)
-
-
----
-
-### unavailableReason
-- unavailableReason: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the reason the status is SERVICE\_UNAVAILABLE.
-
-    **See Also:**
-    - [UNAVAILABLE_TIMEOUT](dw.svc.Result.md#unavailable_timeout)
-    - [UNAVAILABLE_CIRCUIT_BROKEN](dw.svc.Result.md#unavailable_circuit_broken)
-    - [UNAVAILABLE_RATE_LIMITED](dw.svc.Result.md#unavailable_rate_limited)
-    - [UNAVAILABLE_DISABLED](dw.svc.Result.md#unavailable_disabled)
-    - [UNAVAILABLE_CONFIG_PROBLEM](dw.svc.Result.md#unavailable_config_problem)
-
-
----
-
-## Constructor Details
-
-### Result()
-- Result()
-  - : Constructs a new result instance.
-
-
----
-
-## Method Details
-
-### getError()
-- getError(): [Number](TopLevel.Number.md)
-  - : Returns an error-specific code if applicable. For example, this is the HTTP response code for an
-      [HTTPService](dw.svc.HTTPService.md).
-
-
-    **Returns:**
-    - Error-specific code (if applicable).
-
-
----
-
-### getErrorMessage()
-- getErrorMessage(): [String](TopLevel.String.md)
-  - : Returns an error message on a non-OK status.
-
-    **Returns:**
-    - Error message.
-
-
----
-
-### getMsg()
-- getMsg(): [String](TopLevel.String.md)
-  - : Returns an extra error message on failure (if any).
-
-    **Returns:**
-    - Error message, or null.
-
-
----
-
-### getObject()
-- getObject(): [Object](TopLevel.Object.md)
-  - : Returns the actual object returned by the service when the status is OK.
-
-    **Returns:**
-    - Object returned by the service.
-
-
----
-
-### getStatus()
-- getStatus(): [String](TopLevel.String.md)
-  - : Returns the status. This is "OK" on success. Failure codes include "ERROR" and "SERVICE\_UNAVAILABLE".
-      
-      
-      If the status is "SERVICE\_UNAVAILABLE", then the unavailableReason is guaranteed to be non-null.
-
-
-    **Returns:**
-    - Status code.
-
-    **See Also:**
-    - [OK](dw.svc.Result.md#ok)
-    - [ERROR](dw.svc.Result.md#error)
-    - [SERVICE_UNAVAILABLE](dw.svc.Result.md#service_unavailable)
-
-
----
-
-### getUnavailableReason()
-- getUnavailableReason(): [String](TopLevel.String.md)
-  - : Returns the reason the status is SERVICE\_UNAVAILABLE.
-
-    **Returns:**
-    - Unavailable reason code, or null if the status is not SERVICE\_UNAVAILABLE.
-
-    **See Also:**
-    - [UNAVAILABLE_TIMEOUT](dw.svc.Result.md#unavailable_timeout)
-    - [UNAVAILABLE_CIRCUIT_BROKEN](dw.svc.Result.md#unavailable_circuit_broken)
-    - [UNAVAILABLE_RATE_LIMITED](dw.svc.Result.md#unavailable_rate_limited)
-    - [UNAVAILABLE_DISABLED](dw.svc.Result.md#unavailable_disabled)
-    - [UNAVAILABLE_CONFIG_PROBLEM](dw.svc.Result.md#unavailable_config_problem)
-
-
----
-
-### isMockResult()
-- isMockResult(): [Boolean](TopLevel.Boolean.md)
-  - : Returns the status of whether the response is the result of a "mock" service call.
-
-    **Returns:**
-    - true if this was a mock service call, false otherwise.
-
-
----
-
-### isOk()
-- isOk(): [Boolean](TopLevel.Boolean.md)
-  - : Returns the status of whether the service call was successful.
-
-    **Returns:**
-    - true on success, false otherwise.
-
-
----
-
-### toString()
-- toString(): [String](TopLevel.String.md)
-  - : Returns a string representation of the result.
-
-    **Returns:**
-    - a string representation of the result.
-
-
----
-
-<!-- prettier-ignore-end -->