@salesforce/b2c-tooling-sdk 0.0.1 → 0.0.2

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

@@ -0,0 +1,55 @@
+<!-- prettier-ignore-start -->
+# Class SuggestedProduct
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.suggest.SuggestedProduct](dw.suggest.SuggestedProduct.md)
+
+This class represents a suggested product.
+Use [getProductSearchHit()](dw.suggest.SuggestedProduct.md#getproductsearchhit) method to get access to the actual [ProductSearchHit](dw.catalog.ProductSearchHit.md) object.
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [productSearchHit](#productsearchhit): [ProductSearchHit](dw.catalog.ProductSearchHit.md) `(read-only)` | This method returns the actual [ProductSearchHit](dw.catalog.ProductSearchHit.md) object  corresponding to this suggested product. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getProductSearchHit](dw.suggest.SuggestedProduct.md#getproductsearchhit)() | This method returns the actual [ProductSearchHit](dw.catalog.ProductSearchHit.md) object  corresponding to this suggested product. |
+
+### 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
+
+### productSearchHit
+- productSearchHit: [ProductSearchHit](dw.catalog.ProductSearchHit.md) `(read-only)`
+  - : This method returns the actual [ProductSearchHit](dw.catalog.ProductSearchHit.md) object
+      corresponding to this suggested product.
+
+
+
+---
+
+## Method Details
+
+### getProductSearchHit()
+- getProductSearchHit(): [ProductSearchHit](dw.catalog.ProductSearchHit.md)
+  - : This method returns the actual [ProductSearchHit](dw.catalog.ProductSearchHit.md) object
+      corresponding to this suggested product.
+
+
+    **Returns:**
+    - the product search hit corresponding to this suggested product
+
+
+---
+
+<!-- prettier-ignore-end -->

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

@@ -0,0 +1,143 @@
+<!-- prettier-ignore-start -->
+# Class SuggestedTerm
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.suggest.SuggestedTerm](dw.suggest.SuggestedTerm.md)
+
+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](dw.suggest.SuggestedTerms.md) 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.
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [additional](#additional): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns whether this suggested term is a additional term that has no corresponding term in the original search phrase. |
+| [completed](#completed): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns whether this suggested term is a auto completed version of the original term. |
+| [corrected](#corrected): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns whether this suggested term is a corrected version of the original term. |
+| [exactMatch](#exactmatch): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns whether this suggested term is exactly matching the original term. |
+| [value](#value): [String](TopLevel.String.md) `(read-only)` | Returns this suggested term as String value. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getValue](dw.suggest.SuggestedTerm.md#getvalue)() | Returns this suggested term as String value. |
+| [isAdditional](dw.suggest.SuggestedTerm.md#isadditional)() | Returns whether this suggested term is a additional term that has no corresponding term in the original search phrase. |
+| [isCompleted](dw.suggest.SuggestedTerm.md#iscompleted)() | Returns whether this suggested term is a auto completed version of the original term. |
+| [isCorrected](dw.suggest.SuggestedTerm.md#iscorrected)() | Returns whether this suggested term is a corrected version of the original term. |
+| [isExactMatch](dw.suggest.SuggestedTerm.md#isexactmatch)() | Returns whether this suggested term is exactly matching the original term. |
+
+### 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
+
+### additional
+- additional: [Boolean](TopLevel.Boolean.md) `(read-only)`
+  - : Returns whether this suggested term is a additional term that has no corresponding term in the original search phrase.
+
+
+---
+
+### completed
+- completed: [Boolean](TopLevel.Boolean.md) `(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
+- corrected: [Boolean](TopLevel.Boolean.md) `(read-only)`
+  - : Returns whether this suggested term is a corrected version of the original term.
+
+
+---
+
+### exactMatch
+- exactMatch: [Boolean](TopLevel.Boolean.md) `(read-only)`
+  - : Returns whether this suggested term is exactly matching the original term.
+
+
+---
+
+### value
+- value: [String](TopLevel.String.md) `(read-only)`
+  - : Returns this suggested term as String value.
+
+
+---
+
+## Method Details
+
+### getValue()
+- getValue(): [String](TopLevel.String.md)
+  - : Returns this suggested term as String value.
+
+    **Returns:**
+    - the string representation of this suggested term
+
+
+---
+
+### isAdditional()
+- isAdditional(): [Boolean](TopLevel.Boolean.md)
+  - : 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()
+- isCompleted(): [Boolean](TopLevel.Boolean.md)
+  - : 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()
+- isCorrected(): [Boolean](TopLevel.Boolean.md)
+  - : 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()
+- isExactMatch(): [Boolean](TopLevel.Boolean.md)
+  - : Returns whether this suggested term is exactly matching the original term.
+
+    **Returns:**
+    - `true` if this suggested term exactly matches the original term, `false` otherwise
+
+
+---
+
+<!-- prettier-ignore-end -->

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

@@ -0,0 +1,144 @@
+<!-- prettier-ignore-start -->
+# Class SuggestedTerms
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.suggest.SuggestedTerms](dw.suggest.SuggestedTerms.md)
+
+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 [SuggestedTerm](dw.suggest.SuggestedTerm.md)s objects representing a single suggested term.
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [empty](#empty): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns true if this set of suggested terms is empty. |
+| [firstTerm](#firstterm): [SuggestedTerm](dw.suggest.SuggestedTerm.md) `(read-only)` | This method returns the suggested term which is considered best matching  with the original term. |
+| [originalTerm](#originalterm): [String](TopLevel.String.md) `(read-only)` | Returns the original term of the user input, for which this instance  provides a list of suggested terms. |
+| [terms](#terms): [Iterator](dw.util.Iterator.md) `(read-only)` | Returns the list of [SuggestedTerm](dw.suggest.SuggestedTerm.md)s suggested for the original term. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getFirstTerm](dw.suggest.SuggestedTerms.md#getfirstterm)() | This method returns the suggested term which is considered best matching  with the original term. |
+| [getOriginalTerm](dw.suggest.SuggestedTerms.md#getoriginalterm)() | Returns the original term of the user input, for which this instance  provides a list of suggested terms. |
+| [getTerms](dw.suggest.SuggestedTerms.md#getterms)() | Returns the list of [SuggestedTerm](dw.suggest.SuggestedTerm.md)s suggested for the original term. |
+| [isEmpty](dw.suggest.SuggestedTerms.md#isempty)() | Returns true if this set of suggested terms is empty. |
+
+### 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
+
+### empty
+- empty: [Boolean](TopLevel.Boolean.md) `(read-only)`
+  - : Returns true if this set of suggested terms is empty.
+
+
+---
+
+### firstTerm
+- firstTerm: [SuggestedTerm](dw.suggest.SuggestedTerm.md) `(read-only)`
+  - : This method returns the suggested term which is considered best matching
+      with the original term. See [getTerms()](dw.suggest.SuggestedTerms.md#getterms) for a note on ordering of
+      suggested terms.
+
+
+    **See Also:**
+    - [getOriginalTerm()](dw.suggest.SuggestedTerms.md#getoriginalterm)
+    - [getTerms()](dw.suggest.SuggestedTerms.md#getterms)
+
+
+---
+
+### originalTerm
+- originalTerm: [String](TopLevel.String.md) `(read-only)`
+  - : 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.
+
+
+
+---
+
+### terms
+- terms: [Iterator](dw.util.Iterator.md) `(read-only)`
+  - : Returns the list of [SuggestedTerm](dw.suggest.SuggestedTerm.md)s suggested for the original term.
+
+    **See Also:**
+    - [getOriginalTerm()](dw.suggest.SuggestedTerms.md#getoriginalterm)
+    - [isEmpty()](dw.suggest.SuggestedTerms.md#isempty)
+
+
+---
+
+## Method Details
+
+### getFirstTerm()
+- getFirstTerm(): [SuggestedTerm](dw.suggest.SuggestedTerm.md)
+  - : This method returns the suggested term which is considered best matching
+      with the original term. See [getTerms()](dw.suggest.SuggestedTerms.md#getterms) for a note on ordering of
+      suggested terms.
+
+
+    **Returns:**
+    - the best matching term
+
+    **See Also:**
+    - [getOriginalTerm()](dw.suggest.SuggestedTerms.md#getoriginalterm)
+    - [getTerms()](dw.suggest.SuggestedTerms.md#getterms)
+
+
+---
+
+### getOriginalTerm()
+- getOriginalTerm(): [String](TopLevel.String.md)
+  - : 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()
+- getTerms(): [Iterator](dw.util.Iterator.md)
+  - : Returns the list of [SuggestedTerm](dw.suggest.SuggestedTerm.md)s suggested for the original term.
+
+    **Returns:**
+    - a iterator of suggested terms, might be empty
+
+    **See Also:**
+    - [getOriginalTerm()](dw.suggest.SuggestedTerms.md#getoriginalterm)
+    - [isEmpty()](dw.suggest.SuggestedTerms.md#isempty)
+
+
+---
+
+### isEmpty()
+- isEmpty(): [Boolean](TopLevel.Boolean.md)
+  - : Returns true if this set of suggested terms is empty.
+
+    **Returns:**
+    - true if no suggested term is contained in this set, false otherwise
+
+
+---
+
+<!-- prettier-ignore-end -->

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

@@ -0,0 +1,206 @@
+<!-- prettier-ignore-start -->
+# Class Suggestions
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.suggest.Suggestions](dw.suggest.Suggestions.md)
+
+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.
+
+
+
+## All Known Subclasses
+[BrandSuggestions](dw.suggest.BrandSuggestions.md), [CategorySuggestions](dw.suggest.CategorySuggestions.md), [ContentSuggestions](dw.suggest.ContentSuggestions.md), [CustomSuggestions](dw.suggest.CustomSuggestions.md), [ProductSuggestions](dw.suggest.ProductSuggestions.md)
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [searchPhraseSuggestions](#searchphrasesuggestions): [SearchPhraseSuggestions](dw.suggest.SearchPhraseSuggestions.md) `(read-only)` | Returns the suggested search phrases that are associated to this suggestions. |
+| ~~[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 |
+| --- | --- |
+| [getSearchPhraseSuggestions](dw.suggest.Suggestions.md#getsearchphrasesuggestions)() | Returns the suggested search phrases that are associated to this suggestions. |
+| ~~[getSuggestedPhrases](dw.suggest.Suggestions.md#getsuggestedphrases)()~~ | Returns a list of [SuggestedPhrase](dw.suggest.SuggestedPhrase.md) objects that relates to the  user input search phrase. |
+| ~~[getSuggestedTerms](dw.suggest.Suggestions.md#getsuggestedterms)()~~ | Returns a list of [SuggestedTerms](dw.suggest.SuggestedTerms.md) objects. |
+| ~~[hasSuggestedPhrases](dw.suggest.Suggestions.md#hassuggestedphrases)()~~ | Returns whether this suggestions container has any suggested phrases. |
+| ~~[hasSuggestedTerms](dw.suggest.Suggestions.md#hassuggestedterms)()~~ | Returns whether this suggestions container has any suggested terms. |
+| [hasSuggestions](dw.suggest.Suggestions.md#hassuggestions)() | Returns whether this suggestions container has any suggested items, i.e. |
+
+### 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
+
+### searchPhraseSuggestions
+- searchPhraseSuggestions: [SearchPhraseSuggestions](dw.suggest.SearchPhraseSuggestions.md) `(read-only)`
+  - : 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.
+
+
+
+---
+
+### 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.Suggestions.md#hassuggestedphrases)
+
+    **Deprecated:**
+:::warning
+Please use method [getSearchPhraseSuggestions()](dw.suggest.Suggestions.md#getsearchphrasesuggestions) to obtain the suggested search phrases.
+:::
+
+---
+
+### 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.
+
+
+    **Deprecated:**
+:::warning
+Please use method [getSearchPhraseSuggestions()](dw.suggest.Suggestions.md#getsearchphrasesuggestions) to obtain the suggested search phrases.
+:::
+
+---
+
+## Method Details
+
+### getSearchPhraseSuggestions()
+- getSearchPhraseSuggestions(): [SearchPhraseSuggestions](dw.suggest.SearchPhraseSuggestions.md)
+  - : 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()
+- ~~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.Suggestions.md#hassuggestedphrases)
+
+    **Deprecated:**
+:::warning
+Please use method [getSearchPhraseSuggestions()](dw.suggest.Suggestions.md#getsearchphrasesuggestions) to obtain the suggested search phrases.
+:::
+
+---
+
+### 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
+
+    **Deprecated:**
+:::warning
+Please use method [getSearchPhraseSuggestions()](dw.suggest.Suggestions.md#getsearchphrasesuggestions) to obtain the suggested search phrases.
+:::
+
+---
+
+### 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 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.
+
+
+    **Returns:**
+    - true only if there are phrases available
+
+    **Deprecated:**
+:::warning
+Please use method [getSearchPhraseSuggestions()](dw.suggest.Suggestions.md#getsearchphrasesuggestions) to obtain the suggested search phrases.
+:::
+
+---
+
+### 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 or suggested objects.
+
+
+    **Returns:**
+    - true only if there are terms available
+
+    **Deprecated:**
+:::warning
+Please use method [getSearchPhraseSuggestions()](dw.suggest.Suggestions.md#getsearchphrasesuggestions) to obtain the suggested search phrases.
+:::
+
+---
+
+### hasSuggestions()
+- hasSuggestions(): [Boolean](TopLevel.Boolean.md)
+  - : 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()](dw.suggest.Suggestions.md#getsuggestedterms) to obtain
+      a list of [SuggestedTerms](dw.suggest.SuggestedTerms.md).
+
+
+    **Returns:**
+    - true only if there are items found using the suggested terms
+
+    **See Also:**
+    - [getSuggestedTerms()](dw.suggest.Suggestions.md#getsuggestedterms)
+    - [SuggestedTerms.isEmpty()](dw.suggest.SuggestedTerms.md#isempty)
+
+
+---
+
+<!-- prettier-ignore-end -->

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

@@ -0,0 +1,19 @@
+# Package dw.suggest
+
+## Classes
+| Class | Description |
+| --- | --- |
+| [BrandSuggestions](dw.suggest.BrandSuggestions.md) | The brands suggestion container provides access to  brands found using the suggested terms. |
+| [CategorySuggestions](dw.suggest.CategorySuggestions.md) | The category suggestion container provides access to  categories found using the suggested terms as search criteria. |
+| [ContentSuggestions](dw.suggest.ContentSuggestions.md) | The content suggestion container provides access to  content pages found using the suggested terms as search criteria. |
+| [CustomSuggestions](dw.suggest.CustomSuggestions.md) | The custom suggestion container provides access to  merchant provided search phrases  found using the suggested terms as search criteria. |
+| [ProductSuggestions](dw.suggest.ProductSuggestions.md) | The product suggestion container provides access to  products found using the suggested terms. |
+| [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. |
+| [SuggestedCategory](dw.suggest.SuggestedCategory.md) | This class represents a suggested catalog category. |
+| [SuggestedContent](dw.suggest.SuggestedContent.md) | This class represents a suggested content page. |
+| [SuggestedPhrase](dw.suggest.SuggestedPhrase.md) | This class represents a suggested phrase. |
+| [SuggestedProduct](dw.suggest.SuggestedProduct.md) | This class represents a suggested product. |
+| [SuggestedTerm](dw.suggest.SuggestedTerm.md) | A single suggested term. |
+| [SuggestedTerms](dw.suggest.SuggestedTerms.md) | This container represents a list of suggested terms, all belonging to a  particular single original term of the users input search phrase. |
+| [Suggestions](dw.suggest.Suggestions.md) | This is the base class for suggestions containers. |
+| [SuggestModel](dw.suggest.SuggestModel.md) | The Suggest model provides methods and functions  to access search suggestions. |