@salesforce/b2c-tooling-sdk 0.0.1 → 0.0.3

package/data/script-api/dw.sitemap.SitemapMgr.md

@@ -0,0 +1,142 @@
+<!-- prettier-ignore-start -->
+# Class SitemapMgr
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.sitemap.SitemapMgr](dw.sitemap.SitemapMgr.md)
+
+[SitemapMgr](dw.sitemap.SitemapMgr.md) is used to access and modify custom sitemap files.
+
+
+To access custom sitemap files, use methods [getCustomSitemapFiles()](dw.sitemap.SitemapMgr.md#getcustomsitemapfiles).
+
+
+To delete custom sitemap files, use methods [deleteCustomSitemapFile(SitemapFile)](dw.sitemap.SitemapMgr.md#deletecustomsitemapfilesitemapfile),
+[deleteCustomSitemapFiles(String)](dw.sitemap.SitemapMgr.md#deletecustomsitemapfilesstring) and [deleteCustomSitemapFiles()](dw.sitemap.SitemapMgr.md#deletecustomsitemapfiles).
+
+
+To add custom sitemap files, use methods [addCustomSitemapFile(String, File)](dw.sitemap.SitemapMgr.md#addcustomsitemapfilestring-file). The file will be copied from
+WebDAV ([File](dw.io.File.md) represent a file in WebDAV) to the appservers shared file system.
+
+
+Please note that all provided methods are operating in appservers shared file system. These modifications are visible
+via "Custom Sitemaps" tab under _Merchant Tools_ => _SEO_ => _Sitemaps - Custom Sitemaps_ in
+Business Manager. To publish all changes, execute job under Merchant Tools => SEO => Sitemaps => Job.
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [customSitemapFiles](#customsitemapfiles): [Map](dw.util.Map.md) `(read-only)` | Reads all existing custom sitemap files from files system of the appservers custom sitemap directory into memory  and returns them in a Map containing mappings like  <ul>  <li>Hostname 1 => \[SitemapFile hostname1\_sitemapfile1, SitemapFile hostname1\_sitemapfile2\]</li>  <li>Hostname 2 => \[SitemapFile hostname2\_sitemapfile1\]</li>  </ul> |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| static [addCustomSitemapFile](dw.sitemap.SitemapMgr.md#addcustomsitemapfilestring-file)([String](TopLevel.String.md), [File](dw.io.File.md)) | Adds the given [File](dw.io.File.md) to the appservers custom sitemap directory. |
+| static [deleteCustomSitemapFile](dw.sitemap.SitemapMgr.md#deletecustomsitemapfilesitemapfile)([SitemapFile](dw.sitemap.SitemapFile.md)) | Deletes the given custom sitemap file from the appservers shared file system. |
+| static [deleteCustomSitemapFiles](dw.sitemap.SitemapMgr.md#deletecustomsitemapfiles)() | Deletes all custom sitemap files for all hostnames from the appservers shared file system. |
+| static [deleteCustomSitemapFiles](dw.sitemap.SitemapMgr.md#deletecustomsitemapfilesstring)([String](TopLevel.String.md)) | Deletes all custom sitemap files for the given hostname from the appservers shared file system. |
+| static [getCustomSitemapFiles](dw.sitemap.SitemapMgr.md#getcustomsitemapfiles)() | Reads all existing custom sitemap files from files system of the appservers custom sitemap directory into memory  and returns them in a Map containing mappings like  <ul>  <li>Hostname 1 => \[SitemapFile hostname1\_sitemapfile1, SitemapFile hostname1\_sitemapfile2\]</li>  <li>Hostname 2 => \[SitemapFile hostname2\_sitemapfile1\]</li>  </ul> |
+
+### 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
+
+### customSitemapFiles
+- customSitemapFiles: [Map](dw.util.Map.md) `(read-only)`
+  - : Reads all existing custom sitemap files from files system of the appservers custom sitemap directory into memory
+      and returns them in a Map containing mappings like
+      
+      - Hostname 1 =>\[SitemapFile hostname1\_sitemapfile1, SitemapFile hostname1\_sitemapfile2\]
+      - Hostname 2 =>\[SitemapFile hostname2\_sitemapfile1\]
+
+
+
+---
+
+## Method Details
+
+### addCustomSitemapFile(String, File)
+- static addCustomSitemapFile(hostName: [String](TopLevel.String.md), file: [File](dw.io.File.md)): void
+  - : Adds the given [File](dw.io.File.md) to the appservers custom sitemap directory. All content of the appservers
+      custom sitemap directory is considered by the system job "Create Sitemap Schedule".
+      
+      
+      The files are added to the directory which is accessible via "Custom Sitemaps" tab under _Merchant Tools_ =>
+      _SEO_ => _Sitemaps - Custom Sitemaps_ in Business Manager. To publish that change, execute job under Merchant Tools => SEO => Sitemaps => Job.
+
+
+    **Parameters:**
+    - hostName - The hostName to copy the `File` to. The hostName must be configured in sites alias             file.
+    - file - The `File` to copy.
+
+    **Throws:**
+    - Exception - 
+
+
+---
+
+### deleteCustomSitemapFile(SitemapFile)
+- static deleteCustomSitemapFile(sitemapFile: [SitemapFile](dw.sitemap.SitemapFile.md)): void
+  - : Deletes the given custom sitemap file from the appservers shared file system.
+      
+      
+      The file is deleted from the directory which is accessible via "Custom Sitemaps" tab under _Merchant Tools_
+      => _SEO_ => _Sitemaps - Custom Sitemaps_ in Business Manager. To publish that change, execute job under Merchant Tools => SEO => Sitemaps => Job.
+
+
+    **Parameters:**
+    - sitemapFile - - The sitemapFile to delete.
+
+
+---
+
+### deleteCustomSitemapFiles()
+- static deleteCustomSitemapFiles(): void
+  - : Deletes all custom sitemap files for all hostnames from the appservers shared file system.
+      
+      
+      The files are deleted from the directory which is accessible via "Custom Sitemaps" tab under _Merchant
+       Tools_ => _SEO_ => _Sitemaps - Custom Sitemaps_ in Business Manager. To publish that change, execute job under Merchant Tools => SEO => Sitemaps => Job.
+
+
+
+---
+
+### deleteCustomSitemapFiles(String)
+- static deleteCustomSitemapFiles(hostName: [String](TopLevel.String.md)): void
+  - : Deletes all custom sitemap files for the given hostname from the appservers shared file system.
+      
+      
+      The files are deleted from the directory which is accessible via "Custom Sitemaps" tab under _Merchant
+       Tools_ => _SEO_ => _Sitemaps - Custom Sitemaps_ in Business Manager. To publish that change, execute job under Merchant Tools => SEO => Sitemaps => Job.
+
+
+    **Parameters:**
+    - hostName - The hostName to delete the custom sitemap files for.
+
+
+---
+
+### getCustomSitemapFiles()
+- static getCustomSitemapFiles(): [Map](dw.util.Map.md)
+  - : Reads all existing custom sitemap files from files system of the appservers custom sitemap directory into memory
+      and returns them in a Map containing mappings like
+      
+      - Hostname 1 =>\[SitemapFile hostname1\_sitemapfile1, SitemapFile hostname1\_sitemapfile2\]
+      - Hostname 2 =>\[SitemapFile hostname2\_sitemapfile1\]
+
+
+    **Returns:**
+    - The created map containing the list of SitemapFiles.
+
+
+---
+
+<!-- prettier-ignore-end -->

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

@@ -0,0 +1,7 @@
+# Package dw.sitemap
+
+## Classes
+| Class | Description |
+| --- | --- |
+| [SitemapFile](dw.sitemap.SitemapFile.md) | Instances of this class represent sitemap files located in the appservers shared file system. |
+| [SitemapMgr](dw.sitemap.SitemapMgr.md) | [SitemapMgr](dw.sitemap.SitemapMgr.md) is used to access and modify custom sitemap files. |

package/data/script-api/dw.suggest.BrandSuggestions.md

@@ -0,0 +1,34 @@
+<!-- prettier-ignore-start -->
+# Class BrandSuggestions
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.suggest.Suggestions](dw.suggest.Suggestions.md)
+    - [dw.suggest.BrandSuggestions](dw.suggest.BrandSuggestions.md)
+
+The brands suggestion container provides access to
+brands found using the suggested terms.
+
+
+The method [SearchPhraseSuggestions.getSuggestedPhrases()](dw.suggest.SearchPhraseSuggestions.md#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()](dw.suggest.SearchPhraseSuggestions.md#getsuggestedterms) method.
+
+
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+### Methods inherited from class Suggestions
+
+[getSearchPhraseSuggestions](dw.suggest.Suggestions.md#getsearchphrasesuggestions), [getSuggestedPhrases](dw.suggest.Suggestions.md#getsuggestedphrases), [getSuggestedTerms](dw.suggest.Suggestions.md#getsuggestedterms), [hasSuggestedPhrases](dw.suggest.Suggestions.md#hassuggestedphrases), [hasSuggestedTerms](dw.suggest.Suggestions.md#hassuggestedterms), [hasSuggestions](dw.suggest.Suggestions.md#hassuggestions)
+### 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)
+<!-- prettier-ignore-end -->

package/data/script-api/dw.suggest.CategorySuggestions.md

@@ -0,0 +1,76 @@
+<!-- prettier-ignore-start -->
+# Class CategorySuggestions
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.suggest.Suggestions](dw.suggest.Suggestions.md)
+    - [dw.suggest.CategorySuggestions](dw.suggest.CategorySuggestions.md)
+
+The category suggestion container provides access to
+categories found using the suggested terms as search criteria.
+The method [getSuggestedCategories()](dw.suggest.CategorySuggestions.md#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()](dw.suggest.SearchPhraseSuggestions.md#getsuggestedterms) method.
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [suggestedCategories](#suggestedcategories): [Iterator](dw.util.Iterator.md) `(read-only)` | This method returns a list of categories which were found  using the suggested terms as search criteria. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getSuggestedCategories](dw.suggest.CategorySuggestions.md#getsuggestedcategories)() | This method returns a list of categories which were found  using the suggested terms as search criteria. |
+
+### Methods inherited from class Suggestions
+
+[getSearchPhraseSuggestions](dw.suggest.Suggestions.md#getsearchphrasesuggestions), [getSuggestedPhrases](dw.suggest.Suggestions.md#getsuggestedphrases), [getSuggestedTerms](dw.suggest.Suggestions.md#getsuggestedterms), [hasSuggestedPhrases](dw.suggest.Suggestions.md#hassuggestedphrases), [hasSuggestedTerms](dw.suggest.Suggestions.md#hassuggestedterms), [hasSuggestions](dw.suggest.Suggestions.md#hassuggestions)
+### 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
+
+### suggestedCategories
+- suggestedCategories: [Iterator](dw.util.Iterator.md) `(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.
+
+
+    **See Also:**
+    - [Suggestions.hasSuggestions()](dw.suggest.Suggestions.md#hassuggestions)
+
+
+---
+
+## Method Details
+
+### getSuggestedCategories()
+- getSuggestedCategories(): [Iterator](dw.util.Iterator.md)
+  - : 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](dw.suggest.SuggestedCategory.md) instance for
+               each found category, the iterator might be empty
+
+
+    **See Also:**
+    - [Suggestions.hasSuggestions()](dw.suggest.Suggestions.md#hassuggestions)
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.suggest.ContentSuggestions.md

@@ -0,0 +1,76 @@
+<!-- prettier-ignore-start -->
+# Class ContentSuggestions
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.suggest.Suggestions](dw.suggest.Suggestions.md)
+    - [dw.suggest.ContentSuggestions](dw.suggest.ContentSuggestions.md)
+
+The content suggestion container provides access to
+content pages found using the suggested terms as search criteria.
+The method [getSuggestedContent()](dw.suggest.ContentSuggestions.md#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()](dw.suggest.SearchPhraseSuggestions.md#getsuggestedterms) method.
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [suggestedContent](#suggestedcontent): [Iterator](dw.util.Iterator.md) `(read-only)` | This method returns a list of content pages which were found  using the suggested terms as search criteria. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getSuggestedContent](dw.suggest.ContentSuggestions.md#getsuggestedcontent)() | This method returns a list of content pages which were found  using the suggested terms as search criteria. |
+
+### Methods inherited from class Suggestions
+
+[getSearchPhraseSuggestions](dw.suggest.Suggestions.md#getsearchphrasesuggestions), [getSuggestedPhrases](dw.suggest.Suggestions.md#getsuggestedphrases), [getSuggestedTerms](dw.suggest.Suggestions.md#getsuggestedterms), [hasSuggestedPhrases](dw.suggest.Suggestions.md#hassuggestedphrases), [hasSuggestedTerms](dw.suggest.Suggestions.md#hassuggestedterms), [hasSuggestions](dw.suggest.Suggestions.md#hassuggestions)
+### 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
+
+### suggestedContent
+- suggestedContent: [Iterator](dw.util.Iterator.md) `(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.
+
+
+    **See Also:**
+    - [Suggestions.hasSuggestions()](dw.suggest.Suggestions.md#hassuggestions)
+
+
+---
+
+## Method Details
+
+### getSuggestedContent()
+- getSuggestedContent(): [Iterator](dw.util.Iterator.md)
+  - : 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](dw.suggest.SuggestedContent.md) instance for
+               each found content, the iterator might be empty
+
+
+    **See Also:**
+    - [Suggestions.hasSuggestions()](dw.suggest.Suggestions.md#hassuggestions)
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.suggest.CustomSuggestions.md

@@ -0,0 +1,34 @@
+<!-- prettier-ignore-start -->
+# Class CustomSuggestions
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.suggest.Suggestions](dw.suggest.Suggestions.md)
+    - [dw.suggest.CustomSuggestions](dw.suggest.CustomSuggestions.md)
+
+The custom suggestion container provides access to
+merchant provided search phrases
+found using the suggested terms as search criteria.
+
+
+The method [SearchPhraseSuggestions.getSuggestedPhrases()](dw.suggest.SearchPhraseSuggestions.md#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()](dw.suggest.SearchPhraseSuggestions.md#getsuggestedterms) method.
+
+
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+### Methods inherited from class Suggestions
+
+[getSearchPhraseSuggestions](dw.suggest.Suggestions.md#getsearchphrasesuggestions), [getSuggestedPhrases](dw.suggest.Suggestions.md#getsuggestedphrases), [getSuggestedTerms](dw.suggest.Suggestions.md#getsuggestedterms), [hasSuggestedPhrases](dw.suggest.Suggestions.md#hassuggestedphrases), [hasSuggestedTerms](dw.suggest.Suggestions.md#hassuggestedterms), [hasSuggestions](dw.suggest.Suggestions.md#hassuggestions)
+### 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)
+<!-- prettier-ignore-end -->

package/data/script-api/dw.suggest.ProductSuggestions.md

@@ -0,0 +1,76 @@
+<!-- prettier-ignore-start -->
+# Class ProductSuggestions
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.suggest.Suggestions](dw.suggest.Suggestions.md)
+    - [dw.suggest.ProductSuggestions](dw.suggest.ProductSuggestions.md)
+
+The product suggestion container provides access to
+products found using the suggested terms.
+The method [getSuggestedProducts()](dw.suggest.ProductSuggestions.md#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()](dw.suggest.SearchPhraseSuggestions.md#getsuggestedterms) method.
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [suggestedProducts](#suggestedproducts): [Iterator](dw.util.Iterator.md) `(read-only)` | This method returns a list of products which were found  using the suggested terms as search criteria. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getSuggestedProducts](dw.suggest.ProductSuggestions.md#getsuggestedproducts)() | This method returns a list of products which were found  using the suggested terms as search criteria. |
+
+### Methods inherited from class Suggestions
+
+[getSearchPhraseSuggestions](dw.suggest.Suggestions.md#getsearchphrasesuggestions), [getSuggestedPhrases](dw.suggest.Suggestions.md#getsuggestedphrases), [getSuggestedTerms](dw.suggest.Suggestions.md#getsuggestedterms), [hasSuggestedPhrases](dw.suggest.Suggestions.md#hassuggestedphrases), [hasSuggestedTerms](dw.suggest.Suggestions.md#hassuggestedterms), [hasSuggestions](dw.suggest.Suggestions.md#hassuggestions)
+### 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
+
+### suggestedProducts
+- suggestedProducts: [Iterator](dw.util.Iterator.md) `(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.
+
+
+    **See Also:**
+    - [Suggestions.hasSuggestions()](dw.suggest.Suggestions.md#hassuggestions)
+
+
+---
+
+## Method Details
+
+### getSuggestedProducts()
+- getSuggestedProducts(): [Iterator](dw.util.Iterator.md)
+  - : 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](dw.suggest.SuggestedProduct.md) instance for
+               each found product, the iterator might be empty
+
+
+    **See Also:**
+    - [Suggestions.hasSuggestions()](dw.suggest.Suggestions.md#hassuggestions)
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.suggest.SearchPhraseSuggestions.md

@@ -0,0 +1,126 @@
+<!-- prettier-ignore-start -->
+# Class SearchPhraseSuggestions
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.suggest.SearchPhraseSuggestions](dw.suggest.SearchPhraseSuggestions.md)
+
+The search phrase suggestions contain a list of suggested search phrases
+(see [SuggestedPhrase](dw.suggest.SuggestedPhrase.md))
+as well as, for each of the search phrase terms, a list with corrected and
+completed alternative terms.
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [suggestedPhrases](#suggestedphrases): [Iterator](dw.util.Iterator.md) `(read-only)` | Returns a list of [SuggestedPhrase](dw.suggest.SuggestedPhrase.md) objects that relates to the  user input search phrase. |
+| [suggestedTerms](#suggestedterms): [Iterator](dw.util.Iterator.md) `(read-only)` | Returns a list of [SuggestedTerms](dw.suggest.SuggestedTerms.md) objects. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getSuggestedPhrases](dw.suggest.SearchPhraseSuggestions.md#getsuggestedphrases)() | Returns a list of [SuggestedPhrase](dw.suggest.SuggestedPhrase.md) objects that relates to the  user input search phrase. |
+| [getSuggestedTerms](dw.suggest.SearchPhraseSuggestions.md#getsuggestedterms)() | Returns a list of [SuggestedTerms](dw.suggest.SuggestedTerms.md) objects. |
+| [hasSuggestedPhrases](dw.suggest.SearchPhraseSuggestions.md#hassuggestedphrases)() | Returns whether this suggestions container has any suggested phrases. |
+| [hasSuggestedTerms](dw.suggest.SearchPhraseSuggestions.md#hassuggestedterms)() | Returns whether this suggestions container has any suggested terms. |
+
+### 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
+
+### suggestedPhrases
+- suggestedPhrases: [Iterator](dw.util.Iterator.md) `(read-only)`
+  - : Returns a list of [SuggestedPhrase](dw.suggest.SuggestedPhrase.md) objects that relates to the
+      user input search phrase.
+
+
+    **See Also:**
+    - [hasSuggestedPhrases()](dw.suggest.SearchPhraseSuggestions.md#hassuggestedphrases)
+
+
+---
+
+### suggestedTerms
+- suggestedTerms: [Iterator](dw.util.Iterator.md) `(read-only)`
+  - : Returns a list of [SuggestedTerms](dw.suggest.SuggestedTerms.md) objects. Each of the returned
+      instances represents a set of terms suggested for a particular single term
+      of the user input search phrase.
+
+
+    **See Also:**
+    - [hasSuggestedTerms()](dw.suggest.SearchPhraseSuggestions.md#hassuggestedterms)
+
+
+---
+
+## Method Details
+
+### getSuggestedPhrases()
+- getSuggestedPhrases(): [Iterator](dw.util.Iterator.md)
+  - : Returns a list of [SuggestedPhrase](dw.suggest.SuggestedPhrase.md) objects that relates to the
+      user input search phrase.
+
+
+    **Returns:**
+    - a list of [SuggestedPhrase](dw.suggest.SuggestedPhrase.md)s
+
+    **See Also:**
+    - [hasSuggestedPhrases()](dw.suggest.SearchPhraseSuggestions.md#hassuggestedphrases)
+
+
+---
+
+### getSuggestedTerms()
+- getSuggestedTerms(): [Iterator](dw.util.Iterator.md)
+  - : Returns a list of [SuggestedTerms](dw.suggest.SuggestedTerms.md) 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](dw.suggest.SuggestedTerms.md) for each term of the user input search phrase
+
+    **See Also:**
+    - [hasSuggestedTerms()](dw.suggest.SearchPhraseSuggestions.md#hassuggestedterms)
+
+
+---
+
+### hasSuggestedPhrases()
+- hasSuggestedPhrases(): [Boolean](TopLevel.Boolean.md)
+  - : 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()
+- hasSuggestedTerms(): [Boolean](TopLevel.Boolean.md)
+  - : 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
+
+
+---
+
+<!-- prettier-ignore-end -->