@salesforce/b2c-tooling-sdk 0.0.1 → 0.0.2

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

@@ -0,0 +1,471 @@
+<!-- prettier-ignore-start -->
+# Class SuggestModel
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.suggest.SuggestModel](dw.suggest.SuggestModel.md)
+
+The Suggest model provides methods and functions
+to access search suggestions.
+
+
+The search suggestion feature basically covers two functional areas.
+First is just to suggest words, based on the users input,
+utilizing spell correction or prediction (also known as auto completion).
+The second functional area is also often referred to as search-as-you-type,
+where, based on the users input, specific items are
+already looked up, before the user actually has completed typing a word
+or even fired up the search.
+
+
+This model combines both functional areas and provides access to both - the
+suggested words and the items found while using the predicted words.
+
+
+This model supports various types of items that are being suggested, like
+products, categories, brands, content pages as well merchant provided search phrases.
+For each type, there is a [Suggestions](dw.suggest.Suggestions.md) implementation
+available and accessible through this model: [ProductSuggestions](dw.suggest.ProductSuggestions.md),
+[CategorySuggestions](dw.suggest.CategorySuggestions.md), [BrandSuggestions](dw.suggest.BrandSuggestions.md), [ContentSuggestions](dw.suggest.ContentSuggestions.md),
+and [CustomSuggestions](dw.suggest.CustomSuggestions.md).
+
+
+For each type of suggestions, the actual suggested items (like
+products) can by obtained, and, on the other hand, a list of terms
+is provided which were used to lookup the found items.
+The terms can be used to present a advanced user experience in the
+storefront, e.g. show auto completed words, spell corrections and so on.
+The SuggestModel script API will always create suggestions with Autocorrections
+regardless of the value of "Search Autocorrections" search preference.
+
+
+
+## Constant Summary
+
+| Constant | Description |
+| --- | --- |
+| [MAX_SUGGESTIONS](#max_suggestions): [Number](TopLevel.Number.md) = 10 | The maximum number of suggestions that can be obtain from this model: `10` |
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [brandSuggestions](#brandsuggestions): [BrandSuggestions](dw.suggest.BrandSuggestions.md) `(read-only)` | Returns a [BrandSuggestions](dw.suggest.BrandSuggestions.md) container for the current search phrase. |
+| [categorySuggestions](#categorysuggestions): [CategorySuggestions](dw.suggest.CategorySuggestions.md) `(read-only)` | Returns a [CategorySuggestions](dw.suggest.CategorySuggestions.md) container for the current search phrase. |
+| [contentSuggestions](#contentsuggestions): [ContentSuggestions](dw.suggest.ContentSuggestions.md) `(read-only)` | Returns a [ContentSuggestions](dw.suggest.ContentSuggestions.md) container for the current search phrase. |
+| [customSuggestions](#customsuggestions): [CustomSuggestions](dw.suggest.CustomSuggestions.md) `(read-only)` | Returns a [CustomSuggestions](dw.suggest.CustomSuggestions.md) container for the current search phrase. |
+| [filteredByFolder](#filteredbyfolder): [Boolean](TopLevel.Boolean.md) | The method returns true, if the search suggestions are filtered by the folder. |
+| [popularSearchPhrases](#popularsearchphrases): [Iterator](dw.util.Iterator.md) `(read-only)` | Use this method to obtain a list of search phrases  that currently are very popular among all users across the Site. |
+| [productSuggestions](#productsuggestions): [ProductSuggestions](dw.suggest.ProductSuggestions.md) `(read-only)` | Returns a [ProductSuggestions](dw.suggest.ProductSuggestions.md) container for the current search phrase. |
+| [recentSearchPhrases](#recentsearchphrases): [Iterator](dw.util.Iterator.md) `(read-only)` | Use this method to obtain a list of personalized search phrases  that the current user entered recently. |
+
+## Constructor Summary
+
+| Constructor | Description |
+| --- | --- |
+| [SuggestModel](#suggestmodel)() | Constructs a new SuggestModel. |
+
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [addRefinementValues](dw.suggest.SuggestModel.md#addrefinementvaluesstring-string)([String](TopLevel.String.md), [String](TopLevel.String.md)) | Adds a refinement for product suggestions. |
+| [getBrandSuggestions](dw.suggest.SuggestModel.md#getbrandsuggestions)() | Returns a [BrandSuggestions](dw.suggest.BrandSuggestions.md) container for the current search phrase. |
+| [getCategorySuggestions](dw.suggest.SuggestModel.md#getcategorysuggestions)() | Returns a [CategorySuggestions](dw.suggest.CategorySuggestions.md) container for the current search phrase. |
+| [getContentSuggestions](dw.suggest.SuggestModel.md#getcontentsuggestions)() | Returns a [ContentSuggestions](dw.suggest.ContentSuggestions.md) container for the current search phrase. |
+| [getCustomSuggestions](dw.suggest.SuggestModel.md#getcustomsuggestions)() | Returns a [CustomSuggestions](dw.suggest.CustomSuggestions.md) container for the current search phrase. |
+| [getPopularSearchPhrases](dw.suggest.SuggestModel.md#getpopularsearchphrases)() | Use this method to obtain a list of search phrases  that currently are very popular among all users across the Site. |
+| [getProductSuggestions](dw.suggest.SuggestModel.md#getproductsuggestions)() | Returns a [ProductSuggestions](dw.suggest.ProductSuggestions.md) container for the current search phrase. |
+| [getRecentSearchPhrases](dw.suggest.SuggestModel.md#getrecentsearchphrases)() | Use this method to obtain a list of personalized search phrases  that the current user entered recently. |
+| [isFilteredByFolder](dw.suggest.SuggestModel.md#isfilteredbyfolder)() | The method returns true, if the search suggestions are filtered by the folder. |
+| [removeRefinementValues](dw.suggest.SuggestModel.md#removerefinementvaluesstring-string)([String](TopLevel.String.md), [String](TopLevel.String.md)) | Removes a refinement. |
+| [setCategoryID](dw.suggest.SuggestModel.md#setcategoryidstring)([String](TopLevel.String.md)) | Apply a category ID to filter product, brand and category suggestions. |
+| [setFilteredByFolder](dw.suggest.SuggestModel.md#setfilteredbyfolderboolean)([Boolean](TopLevel.Boolean.md)) | Set a flag to indicate if the search suggestions filter for elements that do not belong to a folder. |
+| [setMaxSuggestions](dw.suggest.SuggestModel.md#setmaxsuggestionsnumber)([Number](TopLevel.Number.md)) | Use this method to setup the maximum number of returned suggested  items. |
+| [setRefinementValues](dw.suggest.SuggestModel.md#setrefinementvaluesstring-string)([String](TopLevel.String.md), [String](TopLevel.String.md)) | Sets product suggestion refinement values for an attribute. |
+| [setSearchPhrase](dw.suggest.SuggestModel.md#setsearchphrasestring)([String](TopLevel.String.md)) | Sets the user input search phrase. |
+
+### 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)
+## Constant Details
+
+### MAX_SUGGESTIONS
+
+- MAX_SUGGESTIONS: [Number](TopLevel.Number.md) = 10
+  - : The maximum number of suggestions that can be obtain from this model: `10`
+
+
+---
+
+## Property Details
+
+### brandSuggestions
+- brandSuggestions: [BrandSuggestions](dw.suggest.BrandSuggestions.md) `(read-only)`
+  - : Returns a [BrandSuggestions](dw.suggest.BrandSuggestions.md) container for the current search phrase.
+      The [BrandSuggestions](dw.suggest.BrandSuggestions.md) container provides access to the found brands (if any) and
+      the terms suggested by the system with respect to the known product brands in the catalog.
+
+
+    **See Also:**
+    - [setMaxSuggestions(Number)](dw.suggest.SuggestModel.md#setmaxsuggestionsnumber)
+    - [setSearchPhrase(String)](dw.suggest.SuggestModel.md#setsearchphrasestring)
+
+
+---
+
+### categorySuggestions
+- categorySuggestions: [CategorySuggestions](dw.suggest.CategorySuggestions.md) `(read-only)`
+  - : Returns a [CategorySuggestions](dw.suggest.CategorySuggestions.md) container for the current search phrase.
+      The [CategorySuggestions](dw.suggest.CategorySuggestions.md) container provides access to the found categories (if any) and
+      the terms suggested by the system with respect to the known categories in the catalog.
+
+
+    **See Also:**
+    - [setMaxSuggestions(Number)](dw.suggest.SuggestModel.md#setmaxsuggestionsnumber)
+    - [setSearchPhrase(String)](dw.suggest.SuggestModel.md#setsearchphrasestring)
+
+
+---
+
+### contentSuggestions
+- contentSuggestions: [ContentSuggestions](dw.suggest.ContentSuggestions.md) `(read-only)`
+  - : Returns a [ContentSuggestions](dw.suggest.ContentSuggestions.md) container for the current search phrase.
+      The [ContentSuggestions](dw.suggest.ContentSuggestions.md) container provides access to the found content pages (if any) and
+      the terms suggested by the system with respect to the known content in the library.
+
+
+    **See Also:**
+    - [setMaxSuggestions(Number)](dw.suggest.SuggestModel.md#setmaxsuggestionsnumber)
+    - [setSearchPhrase(String)](dw.suggest.SuggestModel.md#setsearchphrasestring)
+
+
+---
+
+### customSuggestions
+- customSuggestions: [CustomSuggestions](dw.suggest.CustomSuggestions.md) `(read-only)`
+  - : Returns a [CustomSuggestions](dw.suggest.CustomSuggestions.md) container for the current search phrase.
+      The [CustomSuggestions](dw.suggest.CustomSuggestions.md) container provides access to matching
+      custom phrases (if any) and the terms suggested
+      by the system with respect to the merchant provided custom phrases.
+
+
+    **See Also:**
+    - [setMaxSuggestions(Number)](dw.suggest.SuggestModel.md#setmaxsuggestionsnumber)
+    - [setSearchPhrase(String)](dw.suggest.SuggestModel.md#setsearchphrasestring)
+
+
+---
+
+### filteredByFolder
+- filteredByFolder: [Boolean](TopLevel.Boolean.md)
+  - : The method returns true, if the search suggestions are filtered by the folder. If this returns true it is not
+      possible for search suggestions to contain Page Designer content as it belongs to no folder.
+
+
+
+---
+
+### popularSearchPhrases
+- popularSearchPhrases: [Iterator](dw.util.Iterator.md) `(read-only)`
+  - : Use this method to obtain a list of search phrases
+      that currently are very popular among all users across the Site.
+      
+      The search phrases are specific to the region (based on user's IP address),
+      language (locale) and the user's browser type (agent).
+
+
+
+---
+
+### productSuggestions
+- productSuggestions: [ProductSuggestions](dw.suggest.ProductSuggestions.md) `(read-only)`
+  - : Returns a [ProductSuggestions](dw.suggest.ProductSuggestions.md) container for the current search phrase.
+      The [ProductSuggestions](dw.suggest.ProductSuggestions.md) container provides access to the found products (if any) and
+      the terms suggested by the system with respect to the known products in the catalog.
+
+
+    **See Also:**
+    - [setMaxSuggestions(Number)](dw.suggest.SuggestModel.md#setmaxsuggestionsnumber)
+    - [setSearchPhrase(String)](dw.suggest.SuggestModel.md#setsearchphrasestring)
+
+
+---
+
+### recentSearchPhrases
+- recentSearchPhrases: [Iterator](dw.util.Iterator.md) `(read-only)`
+  - : Use this method to obtain a list of personalized search phrases
+      that the current user entered recently.
+      
+      The user is being identified by the CQuotient tracking cookie.
+
+
+
+---
+
+## Constructor Details
+
+### SuggestModel()
+- SuggestModel()
+  - : Constructs a new SuggestModel.
+
+
+---
+
+## Method Details
+
+### addRefinementValues(String, String)
+- addRefinementValues(attributeID: [String](TopLevel.String.md), values: [String](TopLevel.String.md)): void
+  - : Adds a refinement for product suggestions.
+      The method can be called to add an additional query
+      parameter specified as name-value pair. The values string may encode
+      multiple values delimited by the pipe symbol ('|').
+
+
+    **Parameters:**
+    - attributeID - The ID of the refinement attribute.
+    - values - the refinement value to set
+
+
+---
+
+### getBrandSuggestions()
+- getBrandSuggestions(): [BrandSuggestions](dw.suggest.BrandSuggestions.md)
+  - : Returns a [BrandSuggestions](dw.suggest.BrandSuggestions.md) container for the current search phrase.
+      The [BrandSuggestions](dw.suggest.BrandSuggestions.md) container provides access to the found brands (if any) and
+      the terms suggested by the system with respect to the known product brands in the catalog.
+
+
+    **Returns:**
+    - a brand suggestions container for the current search phrase,
+               returns `null` for insufficient search input
+
+
+    **See Also:**
+    - [setMaxSuggestions(Number)](dw.suggest.SuggestModel.md#setmaxsuggestionsnumber)
+    - [setSearchPhrase(String)](dw.suggest.SuggestModel.md#setsearchphrasestring)
+
+
+---
+
+### getCategorySuggestions()
+- getCategorySuggestions(): [CategorySuggestions](dw.suggest.CategorySuggestions.md)
+  - : Returns a [CategorySuggestions](dw.suggest.CategorySuggestions.md) container for the current search phrase.
+      The [CategorySuggestions](dw.suggest.CategorySuggestions.md) container provides access to the found categories (if any) and
+      the terms suggested by the system with respect to the known categories in the catalog.
+
+
+    **Returns:**
+    - a category suggestions container for the current search phrase,
+               returns `null` for insufficient search input
+
+
+    **See Also:**
+    - [setMaxSuggestions(Number)](dw.suggest.SuggestModel.md#setmaxsuggestionsnumber)
+    - [setSearchPhrase(String)](dw.suggest.SuggestModel.md#setsearchphrasestring)
+
+
+---
+
+### getContentSuggestions()
+- getContentSuggestions(): [ContentSuggestions](dw.suggest.ContentSuggestions.md)
+  - : Returns a [ContentSuggestions](dw.suggest.ContentSuggestions.md) container for the current search phrase.
+      The [ContentSuggestions](dw.suggest.ContentSuggestions.md) container provides access to the found content pages (if any) and
+      the terms suggested by the system with respect to the known content in the library.
+
+
+    **Returns:**
+    - a content suggestions container for the current search phrase,
+               returns `null` for insufficient search input
+
+
+    **See Also:**
+    - [setMaxSuggestions(Number)](dw.suggest.SuggestModel.md#setmaxsuggestionsnumber)
+    - [setSearchPhrase(String)](dw.suggest.SuggestModel.md#setsearchphrasestring)
+
+
+---
+
+### getCustomSuggestions()
+- getCustomSuggestions(): [CustomSuggestions](dw.suggest.CustomSuggestions.md)
+  - : Returns a [CustomSuggestions](dw.suggest.CustomSuggestions.md) container for the current search phrase.
+      The [CustomSuggestions](dw.suggest.CustomSuggestions.md) container provides access to matching
+      custom phrases (if any) and the terms suggested
+      by the system with respect to the merchant provided custom phrases.
+
+
+    **Returns:**
+    - a custom suggestions container for the current search phrase,
+               returns `null` for insufficient search input
+
+
+    **See Also:**
+    - [setMaxSuggestions(Number)](dw.suggest.SuggestModel.md#setmaxsuggestionsnumber)
+    - [setSearchPhrase(String)](dw.suggest.SuggestModel.md#setsearchphrasestring)
+
+
+---
+
+### getPopularSearchPhrases()
+- getPopularSearchPhrases(): [Iterator](dw.util.Iterator.md)
+  - : Use this method to obtain a list of search phrases
+      that currently are very popular among all users across the Site.
+      
+      The search phrases are specific to the region (based on user's IP address),
+      language (locale) and the user's browser type (agent).
+
+
+    **Returns:**
+    - a list of personalized popular search phrases
+
+
+---
+
+### getProductSuggestions()
+- getProductSuggestions(): [ProductSuggestions](dw.suggest.ProductSuggestions.md)
+  - : Returns a [ProductSuggestions](dw.suggest.ProductSuggestions.md) container for the current search phrase.
+      The [ProductSuggestions](dw.suggest.ProductSuggestions.md) container provides access to the found products (if any) and
+      the terms suggested by the system with respect to the known products in the catalog.
+
+
+    **Returns:**
+    - a product suggestions container for the current search phrase,
+               returns `null` for insufficient search input
+
+
+    **See Also:**
+    - [setMaxSuggestions(Number)](dw.suggest.SuggestModel.md#setmaxsuggestionsnumber)
+    - [setSearchPhrase(String)](dw.suggest.SuggestModel.md#setsearchphrasestring)
+
+
+---
+
+### getRecentSearchPhrases()
+- getRecentSearchPhrases(): [Iterator](dw.util.Iterator.md)
+  - : Use this method to obtain a list of personalized search phrases
+      that the current user entered recently.
+      
+      The user is being identified by the CQuotient tracking cookie.
+
+
+    **Returns:**
+    - a list of recent search phrases of the current user
+
+
+---
+
+### isFilteredByFolder()
+- isFilteredByFolder(): [Boolean](TopLevel.Boolean.md)
+  - : The method returns true, if the search suggestions are filtered by the folder. If this returns true it is not
+      possible for search suggestions to contain Page Designer content as it belongs to no folder.
+
+
+    **Returns:**
+    - True if search suggestions are filtered by the folder of the content asset.
+
+
+---
+
+### removeRefinementValues(String, String)
+- removeRefinementValues(attributeID: [String](TopLevel.String.md), values: [String](TopLevel.String.md)): void
+  - : Removes a refinement. The method can be called to remove previously added
+      refinement values. The values string may encode multiple values delimited
+      by the pipe symbol ('|').
+
+
+    **Parameters:**
+    - attributeID - The ID of the refinement attribute.
+    - values - the refinement value to remove or null to remove all values
+
+
+---
+
+### setCategoryID(String)
+- setCategoryID(categoryID: [String](TopLevel.String.md)): void
+  - : Apply a category ID to filter product, brand and category suggestions.
+      
+      
+      Suggested products, brands and categories, as well as corrected and completed
+      terms are specific to the given category or one of it's sub categories.
+      
+      
+      For example, in the specified category "television", the search term "pla"
+      will be auto completed to "plasma" (instead of e.g. "player") and
+      only televisions will be included in the list of suggested products.
+
+
+    **Parameters:**
+    - categoryID - the category to filter suggestions for
+
+
+---
+
+### setFilteredByFolder(Boolean)
+- setFilteredByFolder(filteredByFolder: [Boolean](TopLevel.Boolean.md)): void
+  - : Set a flag to indicate if the search suggestions filter for elements that do not belong to a folder.
+      Must be set to false to return content assets that do not belong to any folder.
+
+
+    **Parameters:**
+    - filteredByFolder - filter the search suggestions by folder
+
+
+---
+
+### setMaxSuggestions(Number)
+- setMaxSuggestions(maxSuggestions: [Number](TopLevel.Number.md)): void
+  - : Use this method to setup the maximum number of returned suggested
+      items. For example, set this to 3 in order to only retrieve the
+      3 most relevant suggested products.
+      
+      
+      The maximum number of suggestions that can be queried are defined as [MAX_SUGGESTIONS](dw.suggest.SuggestModel.md#max_suggestions).
+
+
+    **Parameters:**
+    - maxSuggestions - the number of suggested items to be returned by this model instance
+
+
+---
+
+### setRefinementValues(String, String)
+- setRefinementValues(attributeID: [String](TopLevel.String.md), values: [String](TopLevel.String.md)): void
+  - : Sets product suggestion refinement values for an attribute.
+      The method can be called to set
+      an additional query parameter specified as name-value pair. The value
+      string may encode multiple values delimited by the pipe symbol ('|').
+      Existing refinement values for the attribute will be removed.
+
+
+    **Parameters:**
+    - attributeID - The ID of the refinement attribute.
+    - values - the refinement values to set (delimited by '|') or null to             remove all values
+
+
+---
+
+### setSearchPhrase(String)
+- setSearchPhrase(searchPhrase: [String](TopLevel.String.md)): void
+  - : Sets the user input search phrase. This search phrase is being processed
+      by applying auto completion, spell correction and enhancement with alternative
+      similar search terms.
+      
+      
+      The resulting search phrase is used to lookup the actual items,
+      like products or categories (search-as-you-type).
+      
+      
+      In order to access the processed terms, one can use the
+      [SearchPhraseSuggestions.getSuggestedTerms()](dw.suggest.SearchPhraseSuggestions.md#getsuggestedterms) method of each of the respective
+      results returned by the methods in this model.
+
+
+    **Parameters:**
+    - searchPhrase - the user input search phrase
+
+    **See Also:**
+    - [SearchPhraseSuggestions.getSuggestedTerms()](dw.suggest.SearchPhraseSuggestions.md#getsuggestedterms)
+
+
+---
+
+<!-- prettier-ignore-end -->

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

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

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

@@ -0,0 +1,51 @@
+<!-- prettier-ignore-start -->
+# Class SuggestedContent
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.suggest.SuggestedContent](dw.suggest.SuggestedContent.md)
+
+This class represents a suggested content page.
+Use [getContent()](dw.suggest.SuggestedContent.md#getcontent) method to get access to the actual [Content](dw.content.Content.md) object.
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [content](#content): [Content](dw.content.Content.md) `(read-only)` | This method returns the actual [Content](dw.content.Content.md) object corresponding to this suggested content. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getContent](dw.suggest.SuggestedContent.md#getcontent)() | This method returns the actual [Content](dw.content.Content.md) object corresponding to this suggested content. |
+
+### 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
+
+### content
+- content: [Content](dw.content.Content.md) `(read-only)`
+  - : This method returns the actual [Content](dw.content.Content.md) object corresponding to this suggested content.
+
+
+---
+
+## Method Details
+
+### getContent()
+- getContent(): [Content](dw.content.Content.md)
+  - : This method returns the actual [Content](dw.content.Content.md) object corresponding to this suggested content.
+
+    **Returns:**
+    - the content object corresponding to this suggested content
+
+
+---
+
+<!-- prettier-ignore-end -->

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

@@ -0,0 +1,70 @@
+<!-- prettier-ignore-start -->
+# Class SuggestedPhrase
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.suggest.SuggestedPhrase](dw.suggest.SuggestedPhrase.md)
+
+This class represents a suggested phrase.
+Use [getPhrase()](dw.suggest.SuggestedPhrase.md#getphrase) method to get access to the phrase.
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [exactMatch](#exactmatch): [Boolean](TopLevel.Boolean.md) `(read-only)` | This method returns a flag signaling whether this phrase is a exact match. |
+| [phrase](#phrase): [String](TopLevel.String.md) `(read-only)` | This method returns the actual phrase as a string value. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getPhrase](dw.suggest.SuggestedPhrase.md#getphrase)() | This method returns the actual phrase as a string value. |
+| [isExactMatch](dw.suggest.SuggestedPhrase.md#isexactmatch)() | This method returns a flag signaling whether this phrase is a exact match. |
+
+### 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
+
+### exactMatch
+- exactMatch: [Boolean](TopLevel.Boolean.md) `(read-only)`
+  - : This method returns a flag signaling whether this phrase is a exact match.
+
+
+---
+
+### phrase
+- phrase: [String](TopLevel.String.md) `(read-only)`
+  - : This method returns the actual phrase as a string value.
+
+
+---
+
+## Method Details
+
+### getPhrase()
+- getPhrase(): [String](TopLevel.String.md)
+  - : This method returns the actual phrase as a string value.
+
+    **Returns:**
+    - the phrase
+
+
+---
+
+### isExactMatch()
+- isExactMatch(): [Boolean](TopLevel.Boolean.md)
+  - : This method returns a flag signaling whether this phrase is a exact match.
+
+    **Returns:**
+    - true if this phrase is a exact match, false otherwise
+
+
+---
+
+<!-- prettier-ignore-end -->