sfcc-dev-mcp 1.0.19 → 1.0.21

package/docs/dw_rpc/Stub.md

@@ -1,289 +0,0 @@
-## Package: dw.rpc
-
-# Class Stub
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.rpc.Stub
-
-## Description
-
-This is the base class for all service stubs accessible through a WebReference object. The Stub provides access to the WSDL operations. Demandware recommends a low timeout to ensure responsiveness of the site and to avoid thread exhaustion. Use the Services module in Business Manager to set timeout values, not the methods for this class. The Services module provides better analytics and timeout management. The default timeout, if not set, is 15 minutes when the web service is used in a job, and 2 minutes otherwise. If the timeout of the calling script is lower, the script timeout is used. // get WebReference var webref : WebReference = webreferences.myWSDLname; // get service stub var stub : Stub = webref.defaultService;
-
-## Constants
-
-### CONNECTION_TIMEOUT
-
-**Type:** String
-
-This property allows the user to set the web service connection timeout value in milliseconds. By default, the web service connection timeout is 5000 milliseconds (5 seconds). The minimum allowed value is 100 milliseconds and the maximum allowed value is 15000 milliseconds (15 seconds). Demandware recommends setting timeout values in Business Manager Services module as it provides better analytics and timeout management.
-
-### ENDPOINT_ADDRESS_PROPERTY
-
-**Type:** String
-
-Standard property: target service endpoint address. The URI scheme for the endpoint address specification must correspond to the protocol/transport binding for this stub class.
-
-### PASSWORD_PROPERTY
-
-**Type:** String
-
-Standard property: password for authentication.
-
-### SESSION_MAINTAIN_PROPERTY
-
-**Type:** String
-
-Standard property: this boolean property is used by a service client to indicate whether or not it wants to participate in a session with a service endpoint. If this property is set to true, the service client indicates that it wants the session to be maintained. If set to false, the session is not maintained. The default value for this property is false.
-
-### USERNAME_PROPERTY
-
-**Type:** String
-
-Standard property: user name for authentication.
-
-## Properties
-
-### password
-
-**Type:** String
-
-The password.
-
-### timeout
-
-**Type:** Number
-
-The current read timeout value in milliseconds for this Stub.
-
-### username
-
-**Type:** String
-
-The user name.
- 
- Note: this method handles sensitive security-related data.
- Pay special attention to PCI DSS v3. requirements 2, 4, and 12.
-
-## Constructor Summary
-
-Stub()
-
-## Method Summary
-
-### _getProperty
-
-**Signature:** `_getProperty(name : String) : Object`
-
-Gets the value of a specific configuration property.
-
-### _setProperty
-
-**Signature:** `_setProperty(name : String, value : Object) : void`
-
-Sets the name and value of a configuration property for this Stub instance.
-
-### getPassword
-
-**Signature:** `getPassword() : String`
-
-Returns the password.
-
-### getTimeout
-
-**Signature:** `getTimeout() : Number`
-
-Returns the current read timeout value in milliseconds for this Stub.
-
-### getUsername
-
-**Signature:** `getUsername() : String`
-
-Returns the user name.
-
-### setHeader
-
-**Signature:** `setHeader(namespace : String, name : String, value : Object) : void`
-
-Sets an additional SOAP header value for the next operation.
-
-### setPassword
-
-**Signature:** `setPassword(password : String) : void`
-
-Sets the password.
-
-### setTimeout
-
-**Signature:** `setTimeout(timeout : Number) : void`
-
-Sets the timeout in milliseconds for the next call through this Stub.
-
-### setUsername
-
-**Signature:** `setUsername(username : String) : void`
-
-Sets the user name.
-
-## Constructor Detail
-
-## Method Detail
-
-## Method Details
-
-### _getProperty
-
-**Signature:** `_getProperty(name : String) : Object`
-
-**Description:** Gets the value of a specific configuration property.
-
-**Deprecated:**
-
-use webreferences2 instead
-
-**Parameters:**
-
-- `name`: Name of the property whose value is to be retrieved
-
-**Returns:**
-
-Value of the configuration property
-
----
-
-### _setProperty
-
-**Signature:** `_setProperty(name : String, value : Object) : void`
-
-**Description:** Sets the name and value of a configuration property for this Stub instance. If the Stub instance contains a value for the same property, the old value is replaced. Note: the _setProperty method may not perform a validity check on a configured property value. An example is the standard property for the target service endpoint address, which is not checked for validity in the _setProperty method. In this case, stub configuration errors are detected at the remote method invocation.
-
-**Deprecated:**
-
-use webreferences2 instead
-
-**Parameters:**
-
-- `name`: Name of the configuration property
-- `value`: Value of the property
-
----
-
-### getPassword
-
-**Signature:** `getPassword() : String`
-
-**Description:** Returns the password.
-
-**Deprecated:**
-
-use webreferences2 instead
-
-**Returns:**
-
-the password. Note: this method handles sensitive security-related data. Pay special attention to PCI DSS v3. requirements 2, 4, and 12.
-
----
-
-### getTimeout
-
-**Signature:** `getTimeout() : Number`
-
-**Description:** Returns the current read timeout value in milliseconds for this Stub.
-
-**Deprecated:**
-
-use webreferences2 instead
-
-**Returns:**
-
-the current timeout value for this Stub.
-
----
-
-### getUsername
-
-**Signature:** `getUsername() : String`
-
-**Description:** Returns the user name. Note: this method handles sensitive security-related data. Pay special attention to PCI DSS v3. requirements 2, 4, and 12.
-
-**Deprecated:**
-
-use webreferences2 instead
-
-**Returns:**
-
-the user name.
-
----
-
-### setHeader
-
-**Signature:** `setHeader(namespace : String, name : String, value : Object) : void`
-
-**Description:** Sets an additional SOAP header value for the next operation.
-
-**Deprecated:**
-
-use webreferences2 instead
-
-**Parameters:**
-
-- `namespace`: the namespace to use.
-- `name`: the name of the header item.
-- `value`: the value for the header item.
-
----
-
-### setPassword
-
-**Signature:** `setPassword(password : String) : void`
-
-**Description:** Sets the password.
-
-**Deprecated:**
-
-use webreferences2 instead
-
-**Parameters:**
-
-- `password`: the password to set.
-
----
-
-### setTimeout
-
-**Signature:** `setTimeout(timeout : Number) : void`
-
-**Description:** Sets the timeout in milliseconds for the next call through this Stub. This timeout value controls "read timeout" (how long, after connecting, it will wait without any data being read). To control "connection timeout" you use the _setProperty(String, Object) method where the name parameter is CONNECTION_TIMEOUT.
-
-**Deprecated:**
-
-use webreferences2 instead
-
-**Parameters:**
-
-- `timeout`: the timeout for the next call through this stub.
-
-**See Also:**
-
-_setProperty(String, Object)
-CONNECTION_TIMEOUT
-
----
-
-### setUsername
-
-**Signature:** `setUsername(username : String) : void`
-
-**Description:** Sets the user name.
-
-**Deprecated:**
-
-use webreferences2 instead
-
-**Parameters:**
-
-- `username`: the user name to set.
-
----

package/docs/dw_rpc/WebReference.md

@@ -1,83 +0,0 @@
-## Package: dw.rpc
-
-# Class WebReference
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.rpc.WebReference
-
-## Description
-
-Represents a web service defined in a WSDL file. The implementation is backed by a JAX-RPC framework. You should use the newer dw.ws package and WebReference2 class instead, which is based on JAX-WS. Use the Services module in Business Manager to set timeout values, not the methods for this class. The Services module provides better analytics and timeout management. To create an instance of a WebReference object, in a B2C Commerce Script file, reference a WSDL file in the webreferences directory and request the service Stub using one of the get service methods. For example, if your WSDL file is MyWSDL.wsdl, to create an instance of WebReference and access the Stub: var webref : WebReference = webreferences.MyWSDL; var stub : Stub = webref.getDefaultService(); Note: script classes representing your WSDL file are are generated by the platform and then placed in the WebReferences package. You do not need to include the importPackage statement in your B2C Commerce Script file to use classes in the WebReferences package.
-
-## Properties
-
-### defaultService
-
-**Type:** Stub (Read Only)
-
-The default service of the WebReference object. If you have more than one service
- defined in your WSDL, the default service is the first service alphabetically. If the service
- has multiple ports defined, the default service uses the SOAP port name that is first alphabetically.
-
-## Constructor Summary
-
-WebReference()
-
-## Method Summary
-
-### getDefaultService
-
-**Signature:** `getDefaultService() : Stub`
-
-Returns the default service of the WebReference object.
-
-### getService
-
-**Signature:** `getService(service : String, port : String) : Stub`
-
-Returns a specific service from this WebReference.
-
-## Constructor Detail
-
-## Method Detail
-
-## Method Details
-
-### getDefaultService
-
-**Signature:** `getDefaultService() : Stub`
-
-**Description:** Returns the default service of the WebReference object. If you have more than one service defined in your WSDL, the default service is the first service alphabetically. If the service has multiple ports defined, the default service uses the SOAP port name that is first alphabetically.
-
-**Deprecated:**
-
-use webreferences2 instead
-
-**Returns:**
-
-the default service of the WebReference object.
-
----
-
-### getService
-
-**Signature:** `getService(service : String, port : String) : Stub`
-
-**Description:** Returns a specific service from this WebReference.
-
-**Deprecated:**
-
-use webreferences2 instead
-
-**Parameters:**
-
-- `service`: the service to locate.
-- `port`: the port name to use. var port = webref.getService("SampleServiceName","SamplePortName");
-
-**Returns:**
-
-a specific service from this WebReference.
-
----

package/docs/dw_suggest/BrandSuggestions.md

@@ -1,17 +0,0 @@
-## Package: dw.suggest
-
-# Class BrandSuggestions
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.suggest.Suggestions
-  - dw.suggest.BrandSuggestions
-
-## Description
-
-The brands suggestion container provides access to brands found using the suggested terms. The method SearchPhraseSuggestions.getSuggestedPhrases() can be used to get the list of found brand names. The brand lookup is being executed in the current catalog and locale. Furthermore the list of suggested terms, after processing the original user input search query, is accessible through SearchPhraseSuggestions.getSuggestedTerms() method.
-
-## Constructor Summary
-
-## Method Summary

package/docs/dw_suggest/CategorySuggestions.md

@@ -1,53 +0,0 @@
-## Package: dw.suggest
-
-# Class CategorySuggestions
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.suggest.Suggestions
-  - dw.suggest.CategorySuggestions
-
-## Description
-
-The category suggestion container provides access to categories found using the suggested terms as search criteria. The method getSuggestedCategories() can be used to get the list of found categories. Furthermore the list of suggested terms, after processing the original user input search query, is accessible through SearchPhraseSuggestions.getSuggestedTerms() method.
-
-## Properties
-
-### suggestedCategories
-
-**Type:** Iterator (Read Only)
-
-This method returns a list of categories which were found
- using the suggested terms as search criteria.
- The category lookup is being executed in the current catalog and locale.
-
-## Constructor Summary
-
-## Method Summary
-
-### getSuggestedCategories
-
-**Signature:** `getSuggestedCategories() : Iterator`
-
-This method returns a list of categories which were found using the suggested terms as search criteria.
-
-## Method Detail
-
-## Method Details
-
-### getSuggestedCategories
-
-**Signature:** `getSuggestedCategories() : Iterator`
-
-**Description:** This method returns a list of categories which were found using the suggested terms as search criteria. The category lookup is being executed in the current catalog and locale.
-
-**Returns:**
-
-a iterator containing a SuggestedCategory instance for each found category, the iterator might be empty
-
-**See Also:**
-
-Suggestions.hasSuggestions()
-
----

package/docs/dw_suggest/ContentSuggestions.md

@@ -1,53 +0,0 @@
-## Package: dw.suggest
-
-# Class ContentSuggestions
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.suggest.Suggestions
-  - dw.suggest.ContentSuggestions
-
-## Description
-
-The content suggestion container provides access to content pages found using the suggested terms as search criteria. The method getSuggestedContent() can be used to get the list of found content pages. Furthermore the list of suggested terms, after processing the original user input search query, is accessible through SearchPhraseSuggestions.getSuggestedTerms() method.
-
-## Properties
-
-### suggestedContent
-
-**Type:** Iterator (Read Only)
-
-This method returns a list of content pages which were found
- using the suggested terms as search criteria.
- The content lookup is being executed in the current library and locale.
-
-## Constructor Summary
-
-## Method Summary
-
-### getSuggestedContent
-
-**Signature:** `getSuggestedContent() : Iterator`
-
-This method returns a list of content pages which were found using the suggested terms as search criteria.
-
-## Method Detail
-
-## Method Details
-
-### getSuggestedContent
-
-**Signature:** `getSuggestedContent() : Iterator`
-
-**Description:** This method returns a list of content pages which were found using the suggested terms as search criteria. The content lookup is being executed in the current library and locale.
-
-**Returns:**
-
-a iterator containing a SuggestedContent instance for each found content, the iterator might be empty
-
-**See Also:**
-
-Suggestions.hasSuggestions()
-
----

package/docs/dw_suggest/CustomSuggestions.md

@@ -1,17 +0,0 @@
-## Package: dw.suggest
-
-# Class CustomSuggestions
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.suggest.Suggestions
-  - dw.suggest.CustomSuggestions
-
-## Description
-
-The custom suggestion container provides access to merchant provided search phrases found using the suggested terms as search criteria. The method SearchPhraseSuggestions.getSuggestedPhrases() can be used to get the list of found search phrases. The custom phrases lookup is being executed in the current site. Furthermore the list of suggested terms is accessible through SearchPhraseSuggestions.getSuggestedTerms() method.
-
-## Constructor Summary
-
-## Method Summary

package/docs/dw_suggest/ProductSuggestions.md

@@ -1,53 +0,0 @@
-## Package: dw.suggest
-
-# Class ProductSuggestions
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.suggest.Suggestions
-  - dw.suggest.ProductSuggestions
-
-## Description
-
-The product suggestion container provides access to products found using the suggested terms. The method getSuggestedProducts() can be used to get the list of found products. Furthermore the list of suggested terms, after processing the original user input search query, is accessible through SearchPhraseSuggestions.getSuggestedTerms() method.
-
-## Properties
-
-### suggestedProducts
-
-**Type:** Iterator (Read Only)
-
-This method returns a list of products which were found
- using the suggested terms as search criteria.
- The product lookup is being executed in the current catalog and locale.
-
-## Constructor Summary
-
-## Method Summary
-
-### getSuggestedProducts
-
-**Signature:** `getSuggestedProducts() : Iterator`
-
-This method returns a list of products which were found using the suggested terms as search criteria.
-
-## Method Detail
-
-## Method Details
-
-### getSuggestedProducts
-
-**Signature:** `getSuggestedProducts() : Iterator`
-
-**Description:** This method returns a list of products which were found using the suggested terms as search criteria. The product lookup is being executed in the current catalog and locale.
-
-**Returns:**
-
-a iterator containing a SuggestedProduct instance for each found product, the iterator might be empty
-
-**See Also:**
-
-Suggestions.hasSuggestions()
-
----

package/docs/dw_suggest/SearchPhraseSuggestions.md

@@ -1,117 +0,0 @@
-## Package: dw.suggest
-
-# Class SearchPhraseSuggestions
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.suggest.SearchPhraseSuggestions
-
-## Description
-
-The search phrase suggestions contain a list of suggested search phrases (see SuggestedPhrase) as well as, for each of the search phrase terms, a list with corrected and completed alternative terms.
-
-## Properties
-
-### 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
-
-### 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.
-
-## Method Detail
-
-## Method Details
-
-### getSuggestedPhrases
-
-**Signature:** `getSuggestedPhrases() : Iterator`
-
-**Description:** Returns a list of SuggestedPhrase objects that relates to the user input search phrase.
-
-**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.
-
-**Returns:**
-
-a list of SuggestedTerms for each term of the user input search phrase
-
-**See Also:**
-
-hasSuggestedTerms()
-
----
-
-### 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.
-
-**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.
-
-**Returns:**
-
-true only if there are terms available
-
----