sfcc-dev-mcp 1.0.19 → 1.0.20

package/docs/dw_svc/Service.md

@@ -1,295 +0,0 @@
-## Package: dw.svc
-
-# Class Service
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.svc.Service
-
-## Description
-
-Base class of Services. A service represents a call-specific configuration. Any configuration set here is local to the currently executing call.
-
-## Properties
-
-### configuration
-
-**Type:** ServiceConfig (Read Only)
-
-The Service Configuration.
-
-### credentialID
-
-**Type:** String
-
-The ID of the currently associated Credential.
-
-### mock
-
-**Type:** boolean
-
-The status of whether this service is executing in mock mode.
-
-### requestData
-
-**Type:** Object (Read Only)
-
-The property that stores the object returned by createRequest.
-
-### response
-
-**Type:** Object (Read Only)
-
-The property that stores the object returned by the service.
- 
- This property is only useful after the service call(Object...) completes, and is the same as the object
- inside the Result.
-
-### throwOnError
-
-**Type:** boolean
-
-The status of whether this service will throw an error when encountering a problem.
-
-### URL
-
-**Type:** String
-
-The current URL, excluding any custom query parameters.
-
-## Constructor Summary
-
-## Method Summary
-
-### call
-
-**Signature:** `call(args : Object...) : Result`
-
-Invokes the service.
-
-### getConfiguration
-
-**Signature:** `getConfiguration() : ServiceConfig`
-
-Returns the Service Configuration.
-
-### getCredentialID
-
-**Signature:** `getCredentialID() : String`
-
-Returns the ID of the currently associated Credential.
-
-### getRequestData
-
-**Signature:** `getRequestData() : Object`
-
-Returns the property that stores the object returned by createRequest.
-
-### getResponse
-
-**Signature:** `getResponse() : Object`
-
-Returns the property that stores the object returned by the service.
-
-### getURL
-
-**Signature:** `getURL() : String`
-
-Returns the current URL, excluding any custom query parameters.
-
-### isMock
-
-**Signature:** `isMock() : boolean`
-
-Returns the status of whether this service is executing in mock mode.
-
-### isThrowOnError
-
-**Signature:** `isThrowOnError() : boolean`
-
-Returns the status of whether this service will throw an error when encountering a problem.
-
-### setCredentialID
-
-**Signature:** `setCredentialID(id : String) : Service`
-
-Override the Credential by the credential object with the given ID.
-
-### setMock
-
-**Signature:** `setMock() : Service`
-
-Forces the mock mode to be enabled.
-
-### setThrowOnError
-
-**Signature:** `setThrowOnError() : Service`
-
-Forces a Service to throw an error when there is a problem instead of returning a Result with non-OK status.
-
-### setURL
-
-**Signature:** `setURL(url : String) : Service`
-
-Override the URL to the given value.
-
-## Method Detail
-
-## Method Details
-
-### call
-
-**Signature:** `call(args : Object...) : Result`
-
-**Description:** Invokes the service.
-
-**Parameters:**
-
-- `args`: Arguments to pass. If there is a single argument and that argument is an array, then each item in the array will become a separate argument. For example, the following results in three separate arguments to the service: svc.call( [1,2,3] ) and is functionally equivalent to svc.call( 1, 2, 3 ) This can be avoided by explicitly forming a List, enclosing the array in another array, or by sending a second argument. The following will all send the array as a List in the first argument. svc.call( ArrayList([1,2,3]) ) svc.call( [[1,2,3]] ) svc.call( [1,2,3], "" ) Another option is to change the definition of the associated ServiceCallback.createRequest(Service, Object...) to accept an object instead, and pass the array as a field of that object: svc.call( { 'data': [1,2,3] } )
-
-**Returns:**
-
-Result of the service.
-
----
-
-### getConfiguration
-
-**Signature:** `getConfiguration() : ServiceConfig`
-
-**Description:** Returns the Service Configuration.
-
-**Returns:**
-
-Service Configuration.
-
----
-
-### getCredentialID
-
-**Signature:** `getCredentialID() : String`
-
-**Description:** Returns the ID of the currently associated Credential.
-
-**Returns:**
-
-Credential Name.
-
----
-
-### getRequestData
-
-**Signature:** `getRequestData() : Object`
-
-**Description:** Returns the property that stores the object returned by createRequest.
-
-**Returns:**
-
-Object returned by createRequest.
-
----
-
-### getResponse
-
-**Signature:** `getResponse() : Object`
-
-**Description:** Returns the property that stores the object returned by the service. This property is only useful after the service call(Object...) completes, and is the same as the object inside the Result.
-
-**Returns:**
-
-Object returned by the service.
-
----
-
-### getURL
-
-**Signature:** `getURL() : String`
-
-**Description:** Returns the current URL, excluding any custom query parameters.
-
-**Returns:**
-
-URL.
-
----
-
-### isMock
-
-**Signature:** `isMock() : boolean`
-
-**Description:** Returns the status of whether this service is executing in mock mode.
-
-**Returns:**
-
-true for mock mode, false otherwise.
-
----
-
-### isThrowOnError
-
-**Signature:** `isThrowOnError() : boolean`
-
-**Description:** Returns the status of whether this service will throw an error when encountering a problem.
-
-**Returns:**
-
-true to throw an error, false otherwise.
-
----
-
-### setCredentialID
-
-**Signature:** `setCredentialID(id : String) : Service`
-
-**Description:** Override the Credential by the credential object with the given ID. If the URL is also overridden, that URL will continue to override the URL in this credential.
-
-**Parameters:**
-
-- `id`: Credential ID. It must exist.
-
-**Returns:**
-
-this Service.
-
----
-
-### setMock
-
-**Signature:** `setMock() : Service`
-
-**Description:** Forces the mock mode to be enabled.
-
-**Returns:**
-
-this Service.
-
----
-
-### setThrowOnError
-
-**Signature:** `setThrowOnError() : Service`
-
-**Description:** Forces a Service to throw an error when there is a problem instead of returning a Result with non-OK status.
-
-**Returns:**
-
-this Service.
-
----
-
-### setURL
-
-**Signature:** `setURL(url : String) : Service`
-
-**Description:** Override the URL to the given value. Any query parameters (if applicable) will be appended to this URL.
-
-**Parameters:**
-
-- `url`: Force the URL to the given value.
-
-**Returns:**
-
-this Service.
-
----

package/docs/dw_svc/ServiceCallback.md

@@ -1,268 +0,0 @@
-## Package: dw.svc
-
-# Class ServiceCallback
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.svc.ServiceCallback
-
-## Description
-
-Defines callbacks for use with the LocalServiceRegistry. Note this class itself is not used directly, and is present only for documentation of the available callback methods. These methods are called in sequence when a service is called: initServiceClient(Service) -- Creates the underlying client that will be used to make the call. This is intended for SOAP Services and optionally for setting configuration options on the HTTP client. Other client types will be created automatically. createRequest(Service, Object...) -- Given arguments to the Service.call(Object...), configure the actual service request. This may include setting request headers, defining the message body, etc. execute(Service, Object) -- Perform the actual request. At this point the client has been configured with the relevant credentials, so the call should be made. This is required for SOAP services. parseResponse(Service, Object) -- Convert the result of the call into an object to be returned from the Service.call(Object...) method. If the service is mocked (see Service.isMock()), then mockFull(Service, Object...) takes the place of this entire sequence. If that is not implemented, then mockCall(Service, Object) takes the place of just the execute(Service, Object) method. The URL, request, and response objects may be logged. To avoid logging sensitive data, filterLogMessage(String) and/or getRequestLogMessage(Object) and getResponseLogMessage(Object) must be implemented. If they are not implemented then this logging will not be done on Production environments. There are some special considerations for the combination of service type and callback: Service Type initServiceClient createRequest execute parseResponse HTTP This is only required to use non-default options. It must return either a HTTPClient or a Map containing the HTTPClient.HTTPClient(Object) options. Required unless execute is provided. The return value is expected to be either a String or array of HTTPRequestPart, which will be used as the request body Not called unless a boolean "executeOverride:true" is set on the callback. This is a temporary limitation, a future release will always call this callback if it is present Required unless execute is provided. HTTPForm Not normally implemented. Must return a HTTPClient Not normally implemented. Default behavior constructs an "application/x-www-form-urlencoded" request based on a Map given as an argument. Not normally implemented. The same limitations as HTTP regarding the "executeOverride" flag apply here. Optional. Default behavior is to return the response body as a String. SOAP Optional. This must return the Webservice stub or port Required. If initServiceClient was not provided, then this function must call SOAPService.setServiceClient(Object) with the stub or port Required. A typical implementation will call the webservice via a method on the service client Optional. Default behavior returns the output of execute FTP Not normally implemented. Must return a FTPClient or SFTPClient Required unless execute is defined. If present, it should call FTPService.setOperation(String, Object...) Optional. An implementation may call any required methods on the given client. The default implementation calls the Operation that was set up and returns the result. Optional. Default behavior returns the output of execute GENERIC Optional. Optional. Required. The GENERIC type allows any code to be wrapped in the service framework layer, and it's up to this execute method to define what that logic is. Optional.
-
-## Properties
-
-### URL
-
-**Type:** String (Read Only)
-
-Allows overriding the URL provided by the service configuration.
- 
- It is usually better to call Service.setURL(String) within createRequest(Service, Object...)
- because that allows you to modify the existing URL based on call parameters.
-
-## Constructor Summary
-
-## Method Summary
-
-### createRequest
-
-**Signature:** `createRequest(service : Service, params : Object...) : Object`
-
-Creates a request object to be used when calling the service.
-
-### execute
-
-**Signature:** `execute(service : Service, request : Object) : Object`
-
-Provides service-specific execution logic.
-
-### filterLogMessage
-
-**Signature:** `filterLogMessage(msg : String) : String`
-
-Allows filtering communication URL, request, and response log messages.
-
-### getRequestLogMessage
-
-**Signature:** `getRequestLogMessage(request : Object) : String`
-
-Creates a communication log message for the given request.
-
-### getResponseLogMessage
-
-**Signature:** `getResponseLogMessage(response : Object) : String`
-
-Creates a response log message for the given request.
-
-### getURL
-
-**Signature:** `getURL() : String`
-
-Allows overriding the URL provided by the service configuration.
-
-### initServiceClient
-
-**Signature:** `initServiceClient(service : Service) : Object`
-
-Creates a protocol-specific client object.
-
-### mockCall
-
-**Signature:** `mockCall(service : Service, requestObj : Object) : Object`
-
-Override this method to mock the remote portion of the service call.
-
-### mockFull
-
-**Signature:** `mockFull(service : Service, args : Object...) : Object`
-
-Override this method to mock the entire service call, including the createRequest, execute, and parseResponse phases.
-
-### parseResponse
-
-**Signature:** `parseResponse(service : Service, response : Object) : Object`
-
-Creates a response object from a successful service call.
-
-## Method Detail
-
-## Method Details
-
-### createRequest
-
-**Signature:** `createRequest(service : Service, params : Object...) : Object`
-
-**Description:** Creates a request object to be used when calling the service. The type of the object expected is dependent on the service. For example, the HTTPService expects the HTTP request body to be returned. This is required unless the execute method is implemented. It is not recommended to have a service accept a single array or list as a parameter, since doing so requires some extra work when actually calling the service. See Service.call(Object...) for more details.
-
-**Parameters:**
-
-- `service`: Service being executed.
-- `params`: Parameters given to the call method.
-
-**Returns:**
-
-Request object to give to the execute method.
-
----
-
-### execute
-
-**Signature:** `execute(service : Service, request : Object) : Object`
-
-**Description:** Provides service-specific execution logic. This can be overridden to execute a chain of FTP commands in the FTPService, or perform the actual remote call on a webservice stub in the SOAPService.
-
-**Parameters:**
-
-- `service`: Service being executed.
-- `request`: Request object returned by createRequest(Service, Object...).
-
-**Returns:**
-
-Response from the underlying call, to be sent to parseResponse(Service, Object).
-
-**Throws:**
-
-- Exception
-
----
-
-### filterLogMessage
-
-**Signature:** `filterLogMessage(msg : String) : String`
-
-**Description:** Allows filtering communication URL, request, and response log messages. If not implemented, then no filtering will be performed and the message will be logged as-is.
-
-**Parameters:**
-
-- `msg`: Original log message.
-
-**Returns:**
-
-Message to be logged.
-
----
-
-### getRequestLogMessage
-
-**Signature:** `getRequestLogMessage(request : Object) : String`
-
-**Description:** Creates a communication log message for the given request. If not implemented then the default logic will be used to convert the request into a log message.
-
-**Parameters:**
-
-- `request`: Request object.
-
-**Returns:**
-
-Log message, or null to create and use the default message.
-
----
-
-### getResponseLogMessage
-
-**Signature:** `getResponseLogMessage(response : Object) : String`
-
-**Description:** Creates a response log message for the given request. If not implemented then the default logic will be used to convert the response into a log message.
-
-**Parameters:**
-
-- `response`: Response object.
-
-**Returns:**
-
-Log message, or null to create and use the default message.
-
----
-
-### getURL
-
-**Signature:** `getURL() : String`
-
-**Description:** Allows overriding the URL provided by the service configuration. It is usually better to call Service.setURL(String) within createRequest(Service, Object...) because that allows you to modify the existing URL based on call parameters.
-
-**Returns:**
-
-URL to use. The default behavior is to use the URL from the service configuration.
-
----
-
-### initServiceClient
-
-**Signature:** `initServiceClient(service : Service) : Object`
-
-**Description:** Creates a protocol-specific client object. This does not normally need to be implemented, except in the case of SOAP services. It may also be used for HTTP services to override the default configuration. Example SOAP service: initServiceClient: function( svc ) { return webreferences2.MyWSDL.getDefaultService(); } Example configuration override for an HTTP service: initServiceClient: function( svc ) { return { allowHTTP2: true }; }
-
-**Parameters:**
-
-- `service`: the Service object.
-
-**Returns:**
-
-Client object
-
-**Throws:**
-
-- Exception
-
----
-
-### mockCall
-
-**Signature:** `mockCall(service : Service, requestObj : Object) : Object`
-
-**Description:** Override this method to mock the remote portion of the service call. Other callbacks like createRequest and parseResponse are still called.
-
-**Parameters:**
-
-- `service`: Service being executed.
-- `requestObj`: Request object returned by createRequest(Service, Object...).
-
-**Returns:**
-
-Mock response, to be sent to parseResponse(Service, Object).
-
-**Throws:**
-
-- Exception
-
----
-
-### mockFull
-
-**Signature:** `mockFull(service : Service, args : Object...) : Object`
-
-**Description:** Override this method to mock the entire service call, including the createRequest, execute, and parseResponse phases.
-
-**Parameters:**
-
-- `service`: Service being executed.
-- `args`: Arguments from the Service call method.
-
-**Returns:**
-
-Object to return in the service call's Result.
-
-**Throws:**
-
-- Exception
-
----
-
-### parseResponse
-
-**Signature:** `parseResponse(service : Service, response : Object) : Object`
-
-**Description:** Creates a response object from a successful service call. This response object will be the output object of the call method's Result.
-
-**Parameters:**
-
-- `service`: Service being executed.
-- `response`: Service-specific response object. For example, the HTTPService service provides the underlying HTTPClient object that made the HTTP call.
-
-**Returns:**
-
-Object to return in the service call's Result.
-
----

package/docs/dw_svc/ServiceConfig.md

@@ -1,120 +0,0 @@
-## Package: dw.svc
-
-# Class ServiceConfig
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.object.PersistentObject
-  - dw.object.ExtensibleObject
-    - dw.svc.ServiceConfig
-
-## Description
-
-Configuration object for Services.
-
-## Properties
-
-### credential
-
-**Type:** ServiceCredential (Read Only)
-
-The related service credentials.
-
-### ID
-
-**Type:** String (Read Only)
-
-The unique Service ID.
-
-### profile
-
-**Type:** ServiceProfile (Read Only)
-
-The related service profile.
-
-### serviceType
-
-**Type:** String (Read Only)
-
-The type of the service, such as HTTP or SOAP.
-
-## Constructor Summary
-
-## Method Summary
-
-### getCredential
-
-**Signature:** `getCredential() : ServiceCredential`
-
-Returns the related service credentials.
-
-### getID
-
-**Signature:** `getID() : String`
-
-Returns the unique Service ID.
-
-### getProfile
-
-**Signature:** `getProfile() : ServiceProfile`
-
-Returns the related service profile.
-
-### getServiceType
-
-**Signature:** `getServiceType() : String`
-
-Returns the type of the service, such as HTTP or SOAP.
-
-## Method Detail
-
-## Method Details
-
-### getCredential
-
-**Signature:** `getCredential() : ServiceCredential`
-
-**Description:** Returns the related service credentials.
-
-**Returns:**
-
-Related service credentials.
-
----
-
-### getID
-
-**Signature:** `getID() : String`
-
-**Description:** Returns the unique Service ID.
-
-**Returns:**
-
-unique Service ID.
-
----
-
-### getProfile
-
-**Signature:** `getProfile() : ServiceProfile`
-
-**Description:** Returns the related service profile.
-
-**Returns:**
-
-Related service profile.
-
----
-
-### getServiceType
-
-**Signature:** `getServiceType() : String`
-
-**Description:** Returns the type of the service, such as HTTP or SOAP.
-
-**Returns:**
-
-Type of the service, such as HTTP or SOAP.
-
----