@salesforce/b2c-tooling-sdk 1.19.1 → 1.20.0

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

@@ -1,211 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class ServiceDefinition
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.svc.ServiceDefinition](dw.svc.ServiceDefinition.md)
-
-Base class of Service Definitions.
-
-
-A service definition represents configuration that is shared across all [Service](dw.svc.Service.md) instances.
-
-
-**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 [Service](dw.svc.Service.md) directly.
-
-:::
-**API Version:**
-:::note
-No longer available as of version 19.10.
-:::
-
-## All Known Subclasses
-[FTPServiceDefinition](dw.svc.FTPServiceDefinition.md), [HTTPFormServiceDefinition](dw.svc.HTTPFormServiceDefinition.md), [HTTPServiceDefinition](dw.svc.HTTPServiceDefinition.md), [SOAPServiceDefinition](dw.svc.SOAPServiceDefinition.md)
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [configuration](#configuration): [ServiceConfig](dw.svc.ServiceConfig.md) `(read-only)` | Returns the Service Configuration stored in the database. |
-| [mock](#mock): [Boolean](TopLevel.Boolean.md) | Returns the status of whether mock mode is enabled for all instances of this definition. |
-| [serviceName](#servicename): [String](TopLevel.String.md) `(read-only)` | Returns the name of this service. |
-| [throwOnError](#throwonerror): [Boolean](TopLevel.Boolean.md) | Returns the status of whether the shared throwOnError flag is set. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [configure](dw.svc.ServiceDefinition.md#configureobject)([Object](TopLevel.Object.md)) | Register a callback to handle custom portions of the service. |
-| [getConfiguration](dw.svc.ServiceDefinition.md#getconfiguration)() | Returns the Service Configuration stored in the database. |
-| [getServiceName](dw.svc.ServiceDefinition.md#getservicename)() | Returns the name of this service. |
-| [isMock](dw.svc.ServiceDefinition.md#ismock)() | Returns the status of whether mock mode is enabled for all instances of this definition. |
-| [isThrowOnError](dw.svc.ServiceDefinition.md#isthrowonerror)() | Returns the status of whether the shared throwOnError flag is set. |
-| [setMock](dw.svc.ServiceDefinition.md#setmock)() | Sets the mock mode for all Service instances that use this definition. |
-| [setThrowOnError](dw.svc.ServiceDefinition.md#setthrowonerror)() | Sets the throwOnError flag to true for all Service instances that use this definition. |
-
-### 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
-
-### configuration
-- configuration: [ServiceConfig](dw.svc.ServiceConfig.md) `(read-only)`
-  - : Returns the Service Configuration stored in the database.
-
-
----
-
-### mock
-- mock: [Boolean](TopLevel.Boolean.md)
-  - : Returns the status of whether mock mode is enabled for all instances of this definition.
-
-
----
-
-### serviceName
-- serviceName: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the name of this service.
-
-
----
-
-### throwOnError
-- throwOnError: [Boolean](TopLevel.Boolean.md)
-  - : Returns the status of whether the shared throwOnError flag is set.
-
-
----
-
-## Method Details
-
-### configure(Object)
-- configure(config: [Object](TopLevel.Object.md)): [ServiceDefinition](dw.svc.ServiceDefinition.md)
-  - : Register a callback to handle custom portions of the service.
-      
-      
-      This callback may declare multiple methods:
-      
-      
-      ```
-      {
-        initServiceClient: function() {
-            // Create and return the internal service client object.
-            // This is usually optional, except in the case of SOAP services.
-        },
-      
-        // svc is the call-specific Service instance. For example, it may be an HTTPService or FTPService.
-        // params are the arguments passed to the call method (if any).
-        createRequest: function(svc:Service, params) {
-             // Perform any required call-time configuration.
-             // Optionally return a Service-specific object
-        },
-      
-        // svc is the call-specific Service instance.
-        // arg is the output of createRequest.
-        execute: function(svc:Service, arg:Object) {
-             // Execute the service call and return a result
-             // This method is not used by default for HTTP-related services unless executeOverride is set.
-        },
-      
-        // Use the execute function if it is present. This is only required to use the functionality with HTTP services.
-        executeOverride: true,
-      
-        // svc is the call-specific Service instance.
-        // response is the output of execute.
-        parseResponse: function(svc:Service, response: Object) {
-             // Process the response object as needed.
-             // The return value of this method will be the return value of the outer call method.
-        },
-      
-        // svc is the call-specific Service instance.
-        // arg is the output of createRequest.
-        mockCall: function(svc:Service, arg:Object) {
-             // This method takes the place of the 'execute' phase when mocking is enabled.
-             // Note initServiceClient, createRequest, and parseResponse still invoked.
-        },
-      
-        // svc is the call-specific Service instance.
-        // params are the arguments passed to the call method (if any).
-        mockFull: function(svc:Service, params) {
-             // This method takes the place of the entire service call when mocking is enabled.
-             // No other callbacks are invoked. The output of this method becomes the output of call.
-        }
-      
-      }
-      ```
-
-
-    **Parameters:**
-    - config - Callback object.
-
-    **Returns:**
-    - this
-
-
----
-
-### getConfiguration()
-- getConfiguration(): [ServiceConfig](dw.svc.ServiceConfig.md)
-  - : Returns the Service Configuration stored in the database.
-
-    **Returns:**
-    - Service Configuration.
-
-
----
-
-### getServiceName()
-- getServiceName(): [String](TopLevel.String.md)
-  - : Returns the name of this service.
-
-    **Returns:**
-    - Service name.
-
-
----
-
-### isMock()
-- isMock(): [Boolean](TopLevel.Boolean.md)
-  - : Returns the status of whether mock mode is enabled for all instances of this definition.
-
-    **Returns:**
-    - true for mock mode, false otherwise.
-
-
----
-
-### isThrowOnError()
-- isThrowOnError(): [Boolean](TopLevel.Boolean.md)
-  - : Returns the status of whether the shared throwOnError flag is set.
-
-    **Returns:**
-    - throwOnError flag.
-
-
----
-
-### setMock()
-- setMock(): [ServiceDefinition](dw.svc.ServiceDefinition.md)
-  - : Sets the mock mode for all Service instances that use this definition.
-
-    **Returns:**
-    - this Service Definition.
-
-
----
-
-### setThrowOnError()
-- setThrowOnError(): [ServiceDefinition](dw.svc.ServiceDefinition.md)
-  - : Sets the throwOnError flag to true for all Service instances that use this definition.
-
-    **Returns:**
-    - this Service Definition.
-
-
----
-
-<!-- prettier-ignore-end -->

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

@@ -1,152 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class ServiceProfile
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.object.PersistentObject](dw.object.PersistentObject.md)
-    - [dw.object.ExtensibleObject](dw.object.ExtensibleObject.md)
-      - [dw.svc.ServiceProfile](dw.svc.ServiceProfile.md)
-
-Configuration object for Service Profiles.
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [ID](#id): [String](TopLevel.String.md) `(read-only)` | Returns the unique Service ID. |
-| [cbCalls](#cbcalls): [Number](TopLevel.Number.md) `(read-only)` | Returns the maximum number of errors in an interval allowed by the circuit breaker. |
-| [cbMillis](#cbmillis): [Number](TopLevel.Number.md) `(read-only)` | Returns the interval of the circuit breaker in milliseconds. |
-| [rateLimitCalls](#ratelimitcalls): [Number](TopLevel.Number.md) `(read-only)` | Returns the maximum number of calls in an interval allowed by the rate limiter. |
-| [rateLimitMillis](#ratelimitmillis): [Number](TopLevel.Number.md) `(read-only)` | Returns the interval of the rate limiter in milliseconds. |
-| [timeoutMillis](#timeoutmillis): [Number](TopLevel.Number.md) `(read-only)` | Returns the service call timeout in milliseconds. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getCbCalls](dw.svc.ServiceProfile.md#getcbcalls)() | Returns the maximum number of errors in an interval allowed by the circuit breaker. |
-| [getCbMillis](dw.svc.ServiceProfile.md#getcbmillis)() | Returns the interval of the circuit breaker in milliseconds. |
-| [getID](dw.svc.ServiceProfile.md#getid)() | Returns the unique Service ID. |
-| [getRateLimitCalls](dw.svc.ServiceProfile.md#getratelimitcalls)() | Returns the maximum number of calls in an interval allowed by the rate limiter. |
-| [getRateLimitMillis](dw.svc.ServiceProfile.md#getratelimitmillis)() | Returns the interval of the rate limiter in milliseconds. |
-| [getTimeoutMillis](dw.svc.ServiceProfile.md#gettimeoutmillis)() | Returns the service call timeout in milliseconds. |
-
-### Methods inherited from class ExtensibleObject
-
-[describe](dw.object.ExtensibleObject.md#describe), [getCustom](dw.object.ExtensibleObject.md#getcustom)
-### Methods inherited from class PersistentObject
-
-[getCreationDate](dw.object.PersistentObject.md#getcreationdate), [getLastModified](dw.object.PersistentObject.md#getlastmodified), [getUUID](dw.object.PersistentObject.md#getuuid)
-### Methods inherited from class Object
-
-[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
-## Property Details
-
-### ID
-- ID: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the unique Service ID.
-
-
----
-
-### cbCalls
-- cbCalls: [Number](TopLevel.Number.md) `(read-only)`
-  - : Returns the maximum number of errors in an interval allowed by the circuit breaker.
-
-
----
-
-### cbMillis
-- cbMillis: [Number](TopLevel.Number.md) `(read-only)`
-  - : Returns the interval of the circuit breaker in milliseconds.
-
-
----
-
-### rateLimitCalls
-- rateLimitCalls: [Number](TopLevel.Number.md) `(read-only)`
-  - : Returns the maximum number of calls in an interval allowed by the rate limiter.
-
-
----
-
-### rateLimitMillis
-- rateLimitMillis: [Number](TopLevel.Number.md) `(read-only)`
-  - : Returns the interval of the rate limiter in milliseconds.
-
-
----
-
-### timeoutMillis
-- timeoutMillis: [Number](TopLevel.Number.md) `(read-only)`
-  - : Returns the service call timeout in milliseconds.
-
-
----
-
-## Method Details
-
-### getCbCalls()
-- getCbCalls(): [Number](TopLevel.Number.md)
-  - : Returns the maximum number of errors in an interval allowed by the circuit breaker.
-
-    **Returns:**
-    - Maximum number of errors in an interval allowed by the circuit breaker.
-
-
----
-
-### getCbMillis()
-- getCbMillis(): [Number](TopLevel.Number.md)
-  - : Returns the interval of the circuit breaker in milliseconds.
-
-    **Returns:**
-    - Circuit breaker interval in milliseconds.
-
-
----
-
-### getID()
-- getID(): [String](TopLevel.String.md)
-  - : Returns the unique Service ID.
-
-    **Returns:**
-    - unique Service ID
-
-
----
-
-### getRateLimitCalls()
-- getRateLimitCalls(): [Number](TopLevel.Number.md)
-  - : Returns the maximum number of calls in an interval allowed by the rate limiter.
-
-    **Returns:**
-    - Maximum number of calls in an interval allowed by the rate limiter.
-
-
----
-
-### getRateLimitMillis()
-- getRateLimitMillis(): [Number](TopLevel.Number.md)
-  - : Returns the interval of the rate limiter in milliseconds.
-
-    **Returns:**
-    - Interval of the rate limiter in milliseconds.
-
-
----
-
-### getTimeoutMillis()
-- getTimeoutMillis(): [Number](TopLevel.Number.md)
-  - : Returns the service call timeout in milliseconds.
-
-    **Returns:**
-    - Service call timeout in milliseconds.
-
-
----
-
-<!-- prettier-ignore-end -->

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

@@ -1,118 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class ServiceRegistry
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.svc.ServiceRegistry](dw.svc.ServiceRegistry.md)
-
-The ServiceRegistry is responsible for managing Service definitions and their instances.
-
-
-Typical usage involves several steps:
-
-1. The service is defined in the Business Manager and configured with necessary credentials.
-2. The service callback is configured once during cartridge initialization:      
-   ```
-   ServiceRegistry.configure("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. A new service instance is created and called in order to perform the operation:      
-   ```
-   var result : Result = ServiceRegistry.get("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.}
-   ```
-
-
-
-See [ServiceCallback](dw.svc.ServiceCallback.md) for all the callback options, and individual [ServiceDefinition](dw.svc.ServiceDefinition.md)
-classes for customization specific to a service type.
-
-
-**Deprecated:**
-:::warning
-It is recommended to use the [LocalServiceRegistry](dw.svc.LocalServiceRegistry.md) instead of this class.
-:::
-**API Version:**
-:::note
-No longer available as of version 19.10.
-:::
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| static [configure](dw.svc.ServiceRegistry.md#configurestring-object)([String](TopLevel.String.md), [Object](TopLevel.Object.md)) | Configure the given serviceId with a callback. |
-| static [get](dw.svc.ServiceRegistry.md#getstring)([String](TopLevel.String.md)) | Constructs a new instance of the given service. |
-| static [getDefinition](dw.svc.ServiceRegistry.md#getdefinitionstring)([String](TopLevel.String.md)) | Gets a Service Definition. |
-| static [isConfigured](dw.svc.ServiceRegistry.md#isconfiguredstring)([String](TopLevel.String.md)) | Returns the status of whether the given service has been configured 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
-
-### configure(String, Object)
-- static configure(serviceID: [String](TopLevel.String.md), configObj: [Object](TopLevel.Object.md)): [ServiceDefinition](dw.svc.ServiceDefinition.md)
-  - : Configure the given serviceId with a callback.
-      
-      
-      If the service is already configured, the given callback will replace any existing one.
-
-
-    **Parameters:**
-    - serviceID - Unique Service ID.
-    - configObj - Configuration callback. See [ServiceCallback](dw.svc.ServiceCallback.md) for a description of available callback methods.
-
-    **Returns:**
-    - Associated [ServiceDefinition](dw.svc.ServiceDefinition.md), which can be used for further protocol-specific
-              configuration.
-
-
-
----
-
-### get(String)
-- static get(serviceID: [String](TopLevel.String.md)): [Service](dw.svc.Service.md)
-  - : Constructs a new instance of the given service.
-
-    **Parameters:**
-    - serviceID - Unique Service ID.
-
-    **Returns:**
-    - Service instance.
-
-
----
-
-### getDefinition(String)
-- static getDefinition(serviceID: [String](TopLevel.String.md)): [ServiceDefinition](dw.svc.ServiceDefinition.md)
-  - : Gets a Service Definition.
-      
-      
-      This Service Definition is shared across all Service instances returned by [get(String)](dw.svc.ServiceRegistry.md#getstring).
-
-
-    **Parameters:**
-    - serviceID - Unique Service ID.
-
-    **Returns:**
-    - ServiceDefinition
-
-
----
-
-### isConfigured(String)
-- static isConfigured(serviceID: [String](TopLevel.String.md)): [Boolean](TopLevel.Boolean.md)
-  - : Returns the status of whether the given service has been configured with a callback.
-
-    **Parameters:**
-    - serviceID - Unique Service ID.
-
-    **Returns:**
-    - true if configure has already been called, false otherwise.
-
-
----
-
-<!-- prettier-ignore-end -->

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

@@ -1,22 +0,0 @@
-# Package dw.svc
-
-## Classes
-| Class | Description |
-| --- | --- |
-| [FTPService](dw.svc.FTPService.md) | Represents an FTP or SFTP Service. |
-| [FTPServiceDefinition](dw.svc.FTPServiceDefinition.md) | Represents an FTP or SFTP Service Definition. |
-| [HTTPFormService](dw.svc.HTTPFormService.md) | Represents an HTTP Form POST Service. |
-| [HTTPFormServiceDefinition](dw.svc.HTTPFormServiceDefinition.md) | Represents an HTTP Form POST Service Definition. |
-| [HTTPService](dw.svc.HTTPService.md) | Represents an HTTP Service. |
-| [HTTPServiceDefinition](dw.svc.HTTPServiceDefinition.md) | Represents an HTTP Service Definition. |
-| [LocalServiceRegistry](dw.svc.LocalServiceRegistry.md) | The LocalServiceRegistry is responsible for managing Service instances. |
-| [Result](dw.svc.Result.md) | Represents the result of a service call. |
-| [Service](dw.svc.Service.md) | Base class of Services. |
-| [ServiceCallback](dw.svc.ServiceCallback.md) | Defines callbacks for use with the [LocalServiceRegistry](dw.svc.LocalServiceRegistry.md). |
-| [ServiceConfig](dw.svc.ServiceConfig.md) | Configuration object for Services. |
-| [ServiceCredential](dw.svc.ServiceCredential.md) | Configuration object for Service Credentials. |
-| [ServiceDefinition](dw.svc.ServiceDefinition.md) | Base class of Service Definitions. |
-| [ServiceProfile](dw.svc.ServiceProfile.md) | Configuration object for Service Profiles. |
-| [ServiceRegistry](dw.svc.ServiceRegistry.md) | The ServiceRegistry is responsible for managing Service definitions and their instances. |
-| [SOAPService](dw.svc.SOAPService.md) | Represents a SOAP WebService. |
-| [SOAPServiceDefinition](dw.svc.SOAPServiceDefinition.md) | Represents a SOAP WebService definition. |

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

@@ -1,41 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class AgentUserStatusCodes
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.customer.AgentUserStatusCodes](dw.customer.AgentUserStatusCodes.md)
-    - [dw.system.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.
-
-
-**See Also:**
-- [Status](dw.system.Status.md)
-
-**Deprecated:**
-:::warning
-see [AgentUserStatusCodes](dw.customer.AgentUserStatusCodes.md) - this class should only be used for the LoginAgentUser / LoginOnBehalfCustomer pipelets
-:::
-
-## Constructor Summary
-
-| Constructor | Description |
-| --- | --- |
-| [AgentUserStatusCodes](#agentuserstatuscodes)() |  |
-
-## 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)
-## Constructor Details
-
-### AgentUserStatusCodes()
-- AgentUserStatusCodes()
-  - : 
-
-
----
-
-<!-- prettier-ignore-end -->

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

@@ -1,126 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class Cache
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.system.Cache](dw.system.Cache.md)
-
-The Cache class represents a custom cache.
-
-
-A cache stores data over multiple requests. Each cartridge can define its own
-caches for different business requirements. To limit the
-visibility of cache entries by scope, for example, by site, catalog, or
-external system, include the scope reference when constructing the
-key. For example:
-
-
-```
-   var cache = CacheMgr.getCache( 'SiteConfigurations' );
-   cache.get( Site.current.ID + "config", function loadSiteConfiguration() {return loadCfg( Site.current );} );
-```
-
-
-
-
-Do not build the cache key using personal user data, since the key might be
-visible in log messages.
-
-
-
-There is never a guarantee that a stored object can be retrieved from the
-cache. The storage allocated for entries is limited and clearing or
-invalidation might occur at any time. To maintain the cache size limits, the
-cache evicts entries that are less likely to be used again. For example, the
-cache might evict an entry because it hasn't been used recently or very
-often. Cache entries aren't synchronized between different application
-servers.
-
-
-
-The cache returns immutable copies of the original objects put into the
-cache. Lists are converted to arrays during this process. Only JavaScript
-primitive values and tree-like object structures can be stored as entries.
-Object structures can consist of arrays, lists, and basic JavaScript
-objects. Script API classes are not supported, except [List](dw.util.List.md)
-and its subclasses. `null` can be stored as a value.
-`undefined` can't be stored.
-
-
-
-See [CacheMgr](dw.system.CacheMgr.md) for details about how to configure a custom cache.
-
-
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [get](dw.system.Cache.md#getstring)([String](TopLevel.String.md)) | Returns the value associated with key in this cache. |
-| [get](dw.system.Cache.md#getstring-function)([String](TopLevel.String.md), [Function](TopLevel.Function.md)) | Returns the value associated with key in this cache, or invokes the loader function to generate the entry if  there is no entry found. |
-| [invalidate](dw.system.Cache.md#invalidatestring)([String](TopLevel.String.md)) | Removes the cache entry for key (if one exists) manually before the cache's eviction strategy goes into effect. |
-| [put](dw.system.Cache.md#putstring-object)([String](TopLevel.String.md), [Object](TopLevel.Object.md)) | Stores the specified entry directly into the cache, replacing any previously cached entry for key if one exists. |
-
-### 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
-
-### get(String)
-- get(key: [String](TopLevel.String.md)): [Object](TopLevel.Object.md)
-  - : Returns the value associated with key in this cache. If there is no entry in the cache then
-      `undefined` is returned.
-
-
-    **Parameters:**
-    - key - The cache key.
-
-    **Returns:**
-    - The stored value or `undefined` if no value is found in the cache.
-
-
----
-
-### get(String, Function)
-- get(key: [String](TopLevel.String.md), loader: [Function](TopLevel.Function.md)): [Object](TopLevel.Object.md)
-  - : Returns the value associated with key in this cache, or invokes the loader function to generate the entry if
-      there is no entry found. The generated entry is stored for future retrieval. If the loader function returns
-      `undefined`, this value is not stored in the cache.
-
-
-    **Parameters:**
-    - key - The cache key.
-    - loader - The loader function that is called if no value is stored in the cache.
-
-    **Returns:**
-    - The value found in the cache or the value returned from the loader function call.
-
-
----
-
-### invalidate(String)
-- invalidate(key: [String](TopLevel.String.md)): void
-  - : Removes the cache entry for key (if one exists) manually before the cache's eviction strategy goes into effect.
-
-    **Parameters:**
-    - key - The cache key.
-
-
----
-
-### put(String, Object)
-- put(key: [String](TopLevel.String.md), value: [Object](TopLevel.Object.md)): void
-  - : Stores the specified entry directly into the cache, replacing any previously cached entry for key if one exists.
-      Storing `undefined` as value has the same effect as calling [invalidate(String)](dw.system.Cache.md#invalidatestring) for that key.
-
-
-    **Parameters:**
-    - key - The cache key.
-    - value - The value to be store in the cache.
-
-
----
-
-<!-- prettier-ignore-end -->