sfcc-dev-mcp 1.0.19 → 1.0.20

package/docs/dw_suggest/SuggestedTerm.md

@@ -1,143 +0,0 @@
-## Package: dw.suggest
-
-# Class SuggestedTerm
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.suggest.SuggestedTerm
-
-## Description
-
-A single suggested term. Each user input term of the search phrase is being processed separately by the suggestion engine. For each original term, a list of terms will be suggested, either completed terms, corrected terms or even the exact term if it is known to the engine. Each suggested term is represented by a instance of this class. The list of suggested terms belonging to a single original term is represented by a instance of SuggestedTerms class. The suggested term value can either be the completed version of the original term, the corrected version of the original term or exactly the original term.
-
-## Properties
-
-### additional
-
-**Type:** boolean (Read Only)
-
-Returns whether this suggested term is a additional term that has no corresponding term in the original search phrase.
-
-### completed
-
-**Type:** boolean (Read Only)
-
-Returns whether this suggested term is a auto completed version of the original term.
- In other words, this method returns true if the original term is a prefix of this suggested term.
-
-### corrected
-
-**Type:** boolean (Read Only)
-
-Returns whether this suggested term is a corrected version of the original term.
-
-### exactMatch
-
-**Type:** boolean (Read Only)
-
-Returns whether this suggested term is exactly matching the original term.
-
-### value
-
-**Type:** String (Read Only)
-
-Returns this suggested term as String value.
-
-## Constructor Summary
-
-## Method Summary
-
-### getValue
-
-**Signature:** `getValue() : String`
-
-Returns this suggested term as String value.
-
-### isAdditional
-
-**Signature:** `isAdditional() : boolean`
-
-Returns whether this suggested term is a additional term that has no corresponding term in the original search phrase.
-
-### isCompleted
-
-**Signature:** `isCompleted() : boolean`
-
-Returns whether this suggested term is a auto completed version of the original term.
-
-### isCorrected
-
-**Signature:** `isCorrected() : boolean`
-
-Returns whether this suggested term is a corrected version of the original term.
-
-### isExactMatch
-
-**Signature:** `isExactMatch() : boolean`
-
-Returns whether this suggested term is exactly matching the original term.
-
-## Method Detail
-
-## Method Details
-
-### getValue
-
-**Signature:** `getValue() : String`
-
-**Description:** Returns this suggested term as String value.
-
-**Returns:**
-
-the string representation of this suggested term
-
----
-
-### isAdditional
-
-**Signature:** `isAdditional() : boolean`
-
-**Description:** Returns whether this suggested term is a additional term that has no corresponding term in the original search phrase.
-
-**Returns:**
-
-true if this suggested term is a additional term, false otherwise
-
----
-
-### isCompleted
-
-**Signature:** `isCompleted() : boolean`
-
-**Description:** Returns whether this suggested term is a auto completed version of the original term. In other words, this method returns true if the original term is a prefix of this suggested term.
-
-**Returns:**
-
-true if this suggested term is evaluated by auto completion, false otherwise
-
----
-
-### isCorrected
-
-**Signature:** `isCorrected() : boolean`
-
-**Description:** Returns whether this suggested term is a corrected version of the original term.
-
-**Returns:**
-
-true if this suggested term is a corrected version of the original term, false otherwise
-
----
-
-### isExactMatch
-
-**Signature:** `isExactMatch() : boolean`
-
-**Description:** Returns whether this suggested term is exactly matching the original term.
-
-**Returns:**
-
-true if this suggested term exactly matches the original term, false otherwise
-
----

package/docs/dw_suggest/SuggestedTerms.md

@@ -1,132 +0,0 @@
-## Package: dw.suggest
-
-# Class SuggestedTerms
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.suggest.SuggestedTerms
-
-## Description
-
-This container represents a list of suggested terms, all belonging to a particular single original term of the users input search phrase. Each user input term of the search phrase is being processed separately by the suggestion engine. For each original term, a list of terms will be suggested, either completed terms, corrected terms or even the exact term if they are known to the engine as they are. A instance of this class refers to the original unmodified term, as well as to a list of SuggestedTerms objects representing a single suggested term.
-
-## Properties
-
-### empty
-
-**Type:** boolean (Read Only)
-
-Returns true if this set of suggested terms is empty.
-
-### firstTerm
-
-**Type:** SuggestedTerm (Read Only)
-
-This method returns the suggested term which is considered best matching
- with the original term. See getTerms() for a note on ordering of
- suggested terms.
-
-### originalTerm
-
-**Type:** String (Read Only)
-
-The original term of the user input, for which this instance
- provides a list of suggested terms. Suggested terms can either be corrected,
- or completed or exact matching.
-
-### terms
-
-**Type:** Iterator (Read Only)
-
-The list of SuggestedTerms suggested for the original term.
-
-## Constructor Summary
-
-## Method Summary
-
-### getFirstTerm
-
-**Signature:** `getFirstTerm() : SuggestedTerm`
-
-This method returns the suggested term which is considered best matching with the original term.
-
-### getOriginalTerm
-
-**Signature:** `getOriginalTerm() : String`
-
-Returns the original term of the user input, for which this instance provides a list of suggested terms.
-
-### getTerms
-
-**Signature:** `getTerms() : Iterator`
-
-Returns the list of SuggestedTerms suggested for the original term.
-
-### isEmpty
-
-**Signature:** `isEmpty() : boolean`
-
-Returns true if this set of suggested terms is empty.
-
-## Method Detail
-
-## Method Details
-
-### getFirstTerm
-
-**Signature:** `getFirstTerm() : SuggestedTerm`
-
-**Description:** This method returns the suggested term which is considered best matching with the original term. See getTerms() for a note on ordering of suggested terms.
-
-**Returns:**
-
-the best matching term
-
-**See Also:**
-
-getOriginalTerm()
-getTerms()
-
----
-
-### getOriginalTerm
-
-**Signature:** `getOriginalTerm() : String`
-
-**Description:** Returns the original term of the user input, for which this instance provides a list of suggested terms. Suggested terms can either be corrected, or completed or exact matching.
-
-**Returns:**
-
-the original unmodified term of the user input search phrase
-
----
-
-### getTerms
-
-**Signature:** `getTerms() : Iterator`
-
-**Description:** Returns the list of SuggestedTerms suggested for the original term.
-
-**Returns:**
-
-a iterator of suggested terms, might be empty
-
-**See Also:**
-
-getOriginalTerm()
-isEmpty()
-
----
-
-### isEmpty
-
-**Signature:** `isEmpty() : boolean`
-
-**Description:** Returns true if this set of suggested terms is empty.
-
-**Returns:**
-
-true if no suggested term is contained in this set, false otherwise
-
----

package/docs/dw_suggest/Suggestions.md

@@ -1,179 +0,0 @@
-## Package: dw.suggest
-
-# Class Suggestions
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.suggest.Suggestions
-
-## Description
-
-This is the base class for suggestions containers. For each type of items, a sub class provides methods to access the actual items. See the sub classes for more specific information.
-
-## Properties
-
-### searchPhraseSuggestions
-
-**Type:** SearchPhraseSuggestions (Read Only)
-
-The suggested search phrases that are associated to this suggestions.
- 
- In contrast to the suggested items, the suggested phrases contains the corrected and
- completed versions of the original search phrase.
-
-### suggestedPhrases
-
-**Type:** Iterator (Read Only)
-
-A list of SuggestedPhrase objects that relates to the
- user input search phrase.
-
-### suggestedTerms
-
-**Type:** Iterator (Read Only)
-
-A list of SuggestedTerms objects. Each of the returned
- instances represents a set of terms suggested for a particular single term
- of the user input search phrase.
-
-## Constructor Summary
-
-## Method Summary
-
-### getSearchPhraseSuggestions
-
-**Signature:** `getSearchPhraseSuggestions() : SearchPhraseSuggestions`
-
-Returns the suggested search phrases that are associated to this suggestions.
-
-### getSuggestedPhrases
-
-**Signature:** `getSuggestedPhrases() : Iterator`
-
-Returns a list of SuggestedPhrase objects that relates to the user input search phrase.
-
-### getSuggestedTerms
-
-**Signature:** `getSuggestedTerms() : Iterator`
-
-Returns a list of SuggestedTerms objects.
-
-### hasSuggestedPhrases
-
-**Signature:** `hasSuggestedPhrases() : boolean`
-
-Returns whether this suggestions container has any suggested phrases.
-
-### hasSuggestedTerms
-
-**Signature:** `hasSuggestedTerms() : boolean`
-
-Returns whether this suggestions container has any suggested terms.
-
-### hasSuggestions
-
-**Signature:** `hasSuggestions() : boolean`
-
-Returns whether this suggestions container has any suggested items, i.e.
-
-## Method Detail
-
-## Method Details
-
-### getSearchPhraseSuggestions
-
-**Signature:** `getSearchPhraseSuggestions() : SearchPhraseSuggestions`
-
-**Description:** Returns the suggested search phrases that are associated to this suggestions. In contrast to the suggested items, the suggested phrases contains the corrected and completed versions of the original search phrase.
-
-**Returns:**
-
-the suggested search phrases for this suggestions
-
----
-
-### getSuggestedPhrases
-
-**Signature:** `getSuggestedPhrases() : Iterator`
-
-**Description:** Returns a list of SuggestedPhrase objects that relates to the user input search phrase.
-
-**Deprecated:**
-
-Please use method getSearchPhraseSuggestions() to obtain the suggested search phrases.
-
-**Returns:**
-
-a list of SuggestedPhrases
-
-**See Also:**
-
-hasSuggestedPhrases()
-
----
-
-### getSuggestedTerms
-
-**Signature:** `getSuggestedTerms() : Iterator`
-
-**Description:** Returns a list of SuggestedTerms objects. Each of the returned instances represents a set of terms suggested for a particular single term of the user input search phrase.
-
-**Deprecated:**
-
-Please use method getSearchPhraseSuggestions() to obtain the suggested search phrases.
-
-**Returns:**
-
-a list of SuggestedTerms for each term of the user input search phrase
-
----
-
-### hasSuggestedPhrases
-
-**Signature:** `hasSuggestedPhrases() : boolean`
-
-**Description:** Returns whether this suggestions container has any suggested phrases. Note that this method only looks for suggested phrases. It does not account for suggested terms or suggested objects. In other words, even if there are suggested terms or objects, this method will return false if this suggestions container has no phrases.
-
-**Deprecated:**
-
-Please use method getSearchPhraseSuggestions() to obtain the suggested search phrases.
-
-**Returns:**
-
-true only if there are phrases available
-
----
-
-### hasSuggestedTerms
-
-**Signature:** `hasSuggestedTerms() : boolean`
-
-**Description:** Returns whether this suggestions container has any suggested terms. Note that this method checks suggested terms only, but not suggested phrases or suggested objects.
-
-**Deprecated:**
-
-Please use method getSearchPhraseSuggestions() to obtain the suggested search phrases.
-
-**Returns:**
-
-true only if there are terms available
-
----
-
-### hasSuggestions
-
-**Signature:** `hasSuggestions() : boolean`
-
-**Description:** Returns whether this suggestions container has any suggested items, i.e. products. Note that this method only looks for concrete suggested items. It does not account for suggested terms. In other words, even if there are suggested terms, this method will return false if no matching items, like products or categories, were found for the suggested terms. To find out whether there are suggested terms and how they match with respect to the original search phrase, one can use getSuggestedTerms() to obtain a list of SuggestedTerms.
-
-**Returns:**
-
-true only if there are items found using the suggested terms
-
-**See Also:**
-
-getSuggestedTerms()
-SuggestedTerms.isEmpty()
-
----

package/docs/dw_svc/FTPService.md

@@ -1,118 +0,0 @@
-## Package: dw.svc
-
-# Class FTPService
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.svc.Service
-  - dw.svc.FTPService
-
-## Description
-
-Represents an FTP or SFTP Service. There are two basic styles of configuration for this service. In the first style, createRequest is implemented to call the setOperation method on the Service. This will cause the single operation to be performed and returned as the data object in the parseResponse method. Any error status is set automatically based on the returned value of the operation. In the second style, execute is implemented to perform one or more operations using the serviceClient available on the Service object. This serviceClient will be either an FTPClient or an SFTPClient. The return value of execute will be passed as the data object in the parseResponse method. Note that the use of the FTP client is deprecated, and SFTP should be used instead.
-
-## Properties
-
-### autoDisconnect
-
-**Type:** boolean
-
-The status of whether the underlying FTP connection will be disconnected after the service call.
-
-### client
-
-**Type:** Object (Read Only)
-
-The underlying client object.
- 
- This is either an FTPClient or SFTPClient, depending on the protocol.
-
-## Constructor Summary
-
-## Method Summary
-
-### getClient
-
-**Signature:** `getClient() : Object`
-
-Returns the underlying client object.
-
-### isAutoDisconnect
-
-**Signature:** `isAutoDisconnect() : boolean`
-
-Returns the status of whether the underlying FTP connection will be disconnected after the service call.
-
-### setAutoDisconnect
-
-**Signature:** `setAutoDisconnect(b : boolean) : FTPService`
-
-Sets the auto-disconnect flag.
-
-### setOperation
-
-**Signature:** `setOperation(name : String, args : Object...) : FTPService`
-
-Sets a single operation to perform during the execute phase of the service.
-
-## Method Detail
-
-## Method Details
-
-### getClient
-
-**Signature:** `getClient() : Object`
-
-**Description:** Returns the underlying client object. This is either an FTPClient or SFTPClient, depending on the protocol.
-
-**Returns:**
-
-(S)FTP Client object.
-
----
-
-### isAutoDisconnect
-
-**Signature:** `isAutoDisconnect() : boolean`
-
-**Description:** Returns the status of whether the underlying FTP connection will be disconnected after the service call.
-
-**Returns:**
-
-The auto-disconnect flag.
-
----
-
-### setAutoDisconnect
-
-**Signature:** `setAutoDisconnect(b : boolean) : FTPService`
-
-**Description:** Sets the auto-disconnect flag. If true, the underlying FTP connection will be disconnected after the service call. If false then it will remain open. The default value is true.
-
-**Parameters:**
-
-- `b`: true to enable auto-disconnect, false otherwise.
-
-**Returns:**
-
-this FTP or SFTP Service.
-
----
-
-### setOperation
-
-**Signature:** `setOperation(name : String, args : Object...) : FTPService`
-
-**Description:** Sets a single operation to perform during the execute phase of the service. The given arguments make up a method name and arguments on the underlying getClient() object. This method will be invoked during execution, with the result passed into the callback's parseResponse method. This is required unless the callback defines an execute method.
-
-**Parameters:**
-
-- `name`: Method name.
-- `args`: Method arguments.
-
-**Returns:**
-
-this FTP or SFTP Service.
-
----

package/docs/dw_svc/FTPServiceDefinition.md

@@ -1,69 +0,0 @@
-## Package: dw.svc
-
-# Class FTPServiceDefinition
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.svc.ServiceDefinition
-  - dw.svc.FTPServiceDefinition
-
-## Description
-
-Represents an FTP or SFTP Service Definition. There are two basic styles of configuration for this service. In the first style, createRequest is implemented to call the setOperation method on the Service. This will cause the single operation to be performed and returned as the data object in the parseResponse method. Any error status is set automatically based on the returned value of the operation. In the second style, execute is implemented to perform one or more operations using the serviceClient available on the Service object. This serviceClient will be either an FTPClient or an SFTPClient. The return value of execute will be passed as the data object in the parseResponse method.
-
-## Properties
-
-### autoDisconnect
-
-**Type:** boolean
-
-The status of whether the underlying FTP connection will be disconnected after the service call.
-
-## Constructor Summary
-
-## Method Summary
-
-### isAutoDisconnect
-
-**Signature:** `isAutoDisconnect() : boolean`
-
-Returns the status of whether the underlying FTP connection will be disconnected after the service call.
-
-### setAutoDisconnect
-
-**Signature:** `setAutoDisconnect(b : boolean) : FTPServiceDefinition`
-
-Sets the auto-disconnect flag.
-
-## Method Detail
-
-## Method Details
-
-### isAutoDisconnect
-
-**Signature:** `isAutoDisconnect() : boolean`
-
-**Description:** Returns the status of whether the underlying FTP connection will be disconnected after the service call.
-
-**Returns:**
-
-The auto-disconnect flag.
-
----
-
-### setAutoDisconnect
-
-**Signature:** `setAutoDisconnect(b : boolean) : FTPServiceDefinition`
-
-**Description:** Sets the auto-disconnect flag. If true, the underlying FTP connection will be disconnected after the service call. If false then it will remain open. The default value is true.
-
-**Parameters:**
-
-- `b`: true to enable auto-disconnect, false otherwise.
-
-**Returns:**
-
-this FTP or SFTP Service Definition.
-
----

package/docs/dw_svc/HTTPFormService.md

@@ -1,18 +0,0 @@
-## Package: dw.svc
-
-# Class HTTPFormService
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.svc.Service
-  - dw.svc.HTTPService
-    - dw.svc.HTTPFormService
-
-## Description
-
-Represents an HTTP Form POST Service. All arguments passed to the call method will be URL-encoded and set as name/value pairs in the HTTP request body. The HTTP request will be a POST with a content-type of application/x-www-form-urlencoded.
-
-## Constructor Summary
-
-## Method Summary

package/docs/dw_svc/HTTPFormServiceDefinition.md

@@ -1,18 +0,0 @@
-## Package: dw.svc
-
-# Class HTTPFormServiceDefinition
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.svc.ServiceDefinition
-  - dw.svc.HTTPServiceDefinition
-    - dw.svc.HTTPFormServiceDefinition
-
-## Description
-
-Represents an HTTP Form POST Service Definition.
-
-## Constructor Summary
-
-## Method Summary