@salesforce/b2c-tooling-sdk 0.0.1 → 0.0.3

package/data/script-api/dw.catalog.SearchRefinementDefinition.md

@@ -0,0 +1,145 @@
+<!-- prettier-ignore-start -->
+# Class SearchRefinementDefinition
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.object.PersistentObject](dw.object.PersistentObject.md)
+    - [dw.object.ExtensibleObject](dw.object.ExtensibleObject.md)
+      - [dw.catalog.SearchRefinementDefinition](dw.catalog.SearchRefinementDefinition.md)
+
+Common search refinement definition base class.
+
+
+## All Known Subclasses
+[ContentSearchRefinementDefinition](dw.content.ContentSearchRefinementDefinition.md), [ProductSearchRefinementDefinition](dw.catalog.ProductSearchRefinementDefinition.md)
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [attributeID](#attributeid): [String](TopLevel.String.md) `(read-only)` | Returns the attribute ID. |
+| [attributeRefinement](#attributerefinement): [Boolean](TopLevel.Boolean.md) `(read-only)` | Identifies if this is an attribute refinement. |
+| [cutoffThreshold](#cutoffthreshold): [Number](TopLevel.Number.md) `(read-only)` | Returns the cut-off threshold. |
+| [displayName](#displayname): [String](TopLevel.String.md) `(read-only)` | Returns the display name. |
+| [valueTypeCode](#valuetypecode): [Number](TopLevel.Number.md) `(read-only)` | Returns a code for the data type used for this search refinement definition. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getAttributeID](dw.catalog.SearchRefinementDefinition.md#getattributeid)() | Returns the attribute ID. |
+| [getCutoffThreshold](dw.catalog.SearchRefinementDefinition.md#getcutoffthreshold)() | Returns the cut-off threshold. |
+| [getDisplayName](dw.catalog.SearchRefinementDefinition.md#getdisplayname)() | Returns the display name. |
+| [getValueTypeCode](dw.catalog.SearchRefinementDefinition.md#getvaluetypecode)() | Returns a code for the data type used for this search refinement definition. |
+| [isAttributeRefinement](dw.catalog.SearchRefinementDefinition.md#isattributerefinement)() | Identifies if this is an attribute refinement. |
+
+### Methods inherited from class ExtensibleObject
+
+[describe](dw.object.ExtensibleObject.md#describe), [getCustom](dw.object.ExtensibleObject.md#getcustom)
+### Methods inherited from class PersistentObject
+
+[getCreationDate](dw.object.PersistentObject.md#getcreationdate), [getLastModified](dw.object.PersistentObject.md#getlastmodified), [getUUID](dw.object.PersistentObject.md#getuuid)
+### 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
+
+### attributeID
+- attributeID: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the attribute ID. If the refinement definition is not an
+      attribute refinement, the method returns an empty string.
+
+
+
+---
+
+### attributeRefinement
+- attributeRefinement: [Boolean](TopLevel.Boolean.md) `(read-only)`
+  - : Identifies if this is an attribute refinement.
+
+
+---
+
+### cutoffThreshold
+- cutoffThreshold: [Number](TopLevel.Number.md) `(read-only)`
+  - : Returns the cut-off threshold.
+
+
+---
+
+### displayName
+- displayName: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the display name.
+
+
+---
+
+### valueTypeCode
+- valueTypeCode: [Number](TopLevel.Number.md) `(read-only)`
+  - : Returns a code for the data type used for this search refinement definition. See constants
+      defined in ObjectAttributeDefinition.
+
+
+
+---
+
+## Method Details
+
+### getAttributeID()
+- getAttributeID(): [String](TopLevel.String.md)
+  - : Returns the attribute ID. If the refinement definition is not an
+      attribute refinement, the method returns an empty string.
+
+
+    **Returns:**
+    - the attribute ID.
+
+
+---
+
+### getCutoffThreshold()
+- getCutoffThreshold(): [Number](TopLevel.Number.md)
+  - : Returns the cut-off threshold.
+
+    **Returns:**
+    - the cut-off threshold.
+
+
+---
+
+### getDisplayName()
+- getDisplayName(): [String](TopLevel.String.md)
+  - : Returns the display name.
+
+    **Returns:**
+    - the display name.
+
+
+---
+
+### getValueTypeCode()
+- getValueTypeCode(): [Number](TopLevel.Number.md)
+  - : Returns a code for the data type used for this search refinement definition. See constants
+      defined in ObjectAttributeDefinition.
+
+
+    **Returns:**
+    - a code for the data type used for this search refinement definition. See constants
+      defined in ObjectAttributeDefinition.
+
+
+
+---
+
+### isAttributeRefinement()
+- isAttributeRefinement(): [Boolean](TopLevel.Boolean.md)
+  - : Identifies if this is an attribute refinement.
+
+    **Returns:**
+    - true if this is an attribute refinement, false otherwise.
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.catalog.SearchRefinementValue.md

@@ -0,0 +1,194 @@
+<!-- prettier-ignore-start -->
+# Class SearchRefinementValue
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.catalog.SearchRefinementValue](dw.catalog.SearchRefinementValue.md)
+
+Represents the value of a product or content search refinement.
+
+
+## All Known Subclasses
+[ContentSearchRefinementValue](dw.content.ContentSearchRefinementValue.md), [ProductSearchRefinementValue](dw.catalog.ProductSearchRefinementValue.md)
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [ID](#id): [String](TopLevel.String.md) `(read-only)` | Returns the refinement value's ID. |
+| [description](#description): [String](TopLevel.String.md) `(read-only)` | Returns the optional refinement value description in the current locale. |
+| [displayValue](#displayvalue): [String](TopLevel.String.md) `(read-only)` | Returns the refinement display value. |
+| [hitCount](#hitcount): [Number](TopLevel.Number.md) `(read-only)` | Returns the hit count value. |
+| [presentationID](#presentationid): [String](TopLevel.String.md) `(read-only)` | Returns the optional presentation ID associated with this refinement  value. |
+| [value](#value): [String](TopLevel.String.md) `(read-only)` | Returns the refinement value. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getDescription](dw.catalog.SearchRefinementValue.md#getdescription)() | Returns the optional refinement value description in the current locale. |
+| [getDisplayValue](dw.catalog.SearchRefinementValue.md#getdisplayvalue)() | Returns the refinement display value. |
+| [getHitCount](dw.catalog.SearchRefinementValue.md#gethitcount)() | Returns the hit count value. |
+| [getID](dw.catalog.SearchRefinementValue.md#getid)() | Returns the refinement value's ID. |
+| [getPresentationID](dw.catalog.SearchRefinementValue.md#getpresentationid)() | Returns the optional presentation ID associated with this refinement  value. |
+| [getValue](dw.catalog.SearchRefinementValue.md#getvalue)() | Returns the refinement value. |
+
+### 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
+
+### ID
+- ID: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the refinement value's ID. For attribute refinements, this will
+      be the ID of the corresponding
+      [ObjectAttributeDefinition](dw.object.ObjectAttributeDefinition.md). This ID is included in the
+      querystring parameter names returned by the URL-generating methods of
+      [SearchModel](dw.catalog.SearchModel.md). For price and category refinements, this
+      value will be empty.
+
+
+
+---
+
+### description
+- description: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the optional refinement value description in the current locale.
+
+
+---
+
+### displayValue
+- displayValue: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the refinement display value. For attribute refinements, this is
+      the appropriate display value based on optional value display names
+      within the object attribute definition. If no display name is defined,
+      the value itself is returned. For category refinements, this is the
+      display name of the category in the current locale. For price
+      refinements, this is a string representation of the range appropriate for
+      display.
+
+
+
+---
+
+### hitCount
+- hitCount: [Number](TopLevel.Number.md) `(read-only)`
+  - : Returns the hit count value.
+
+
+---
+
+### presentationID
+- presentationID: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the optional presentation ID associated with this refinement
+      value. The presentation ID can be used, for example, to associate an ID
+      with an HTML widget.
+
+
+
+---
+
+### value
+- value: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the refinement value. For attribute refinements, this is the
+      attribute value if the refinement values are unbucketed, or the bucket
+      display name if the values are bucketed. This value is included in the
+      querystring parameter values returned by the URL-generating methods of
+      [SearchModel](dw.catalog.SearchModel.md). For price refinements, the value will be
+      a string representation of the price range lower bound. For category
+      refinements, the value will be a category ID.
+
+
+
+---
+
+## Method Details
+
+### getDescription()
+- getDescription(): [String](TopLevel.String.md)
+  - : Returns the optional refinement value description in the current locale.
+
+    **Returns:**
+    - the optional refinement value description in the current locale,
+              or null if none is defined.
+
+
+
+---
+
+### getDisplayValue()
+- getDisplayValue(): [String](TopLevel.String.md)
+  - : Returns the refinement display value. For attribute refinements, this is
+      the appropriate display value based on optional value display names
+      within the object attribute definition. If no display name is defined,
+      the value itself is returned. For category refinements, this is the
+      display name of the category in the current locale. For price
+      refinements, this is a string representation of the range appropriate for
+      display.
+
+
+    **Returns:**
+    - the refinement display value in the current locale.
+
+
+---
+
+### getHitCount()
+- getHitCount(): [Number](TopLevel.Number.md)
+  - : Returns the hit count value.
+
+    **Returns:**
+    - the hit count value.
+
+
+---
+
+### getID()
+- getID(): [String](TopLevel.String.md)
+  - : Returns the refinement value's ID. For attribute refinements, this will
+      be the ID of the corresponding
+      [ObjectAttributeDefinition](dw.object.ObjectAttributeDefinition.md). This ID is included in the
+      querystring parameter names returned by the URL-generating methods of
+      [SearchModel](dw.catalog.SearchModel.md). For price and category refinements, this
+      value will be empty.
+
+
+    **Returns:**
+    - the refinement value's ID.
+
+
+---
+
+### getPresentationID()
+- getPresentationID(): [String](TopLevel.String.md)
+  - : Returns the optional presentation ID associated with this refinement
+      value. The presentation ID can be used, for example, to associate an ID
+      with an HTML widget.
+
+
+    **Returns:**
+    - the presentation ID, or null if none is defined.
+
+
+---
+
+### getValue()
+- getValue(): [String](TopLevel.String.md)
+  - : Returns the refinement value. For attribute refinements, this is the
+      attribute value if the refinement values are unbucketed, or the bucket
+      display name if the values are bucketed. This value is included in the
+      querystring parameter values returned by the URL-generating methods of
+      [SearchModel](dw.catalog.SearchModel.md). For price refinements, the value will be
+      a string representation of the price range lower bound. For category
+      refinements, the value will be a category ID.
+
+
+    **Returns:**
+    - the refinement value.
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.catalog.SearchRefinements.md

@@ -0,0 +1,238 @@
+<!-- prettier-ignore-start -->
+# Class SearchRefinements
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.catalog.SearchRefinements](dw.catalog.SearchRefinements.md)
+
+Common search refinements base class.
+
+
+## All Known Subclasses
+[ContentSearchRefinements](dw.content.ContentSearchRefinements.md), [ProductSearchRefinements](dw.catalog.ProductSearchRefinements.md)
+## Constant Summary
+
+| Constant | Description |
+| --- | --- |
+| [ASCENDING](#ascending): [Number](TopLevel.Number.md) = 0 | Flag for an ascending sort. |
+| [DESCENDING](#descending): [Number](TopLevel.Number.md) = 1 | Flag for a descending sort. |
+| [SORT_VALUE_COUNT](#sort_value_count): [Number](TopLevel.Number.md) = 1 | Flag for sorting on value count. |
+| [SORT_VALUE_NAME](#sort_value_name): [Number](TopLevel.Number.md) = 0 | Flag for sorting on value name. |
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [allRefinementDefinitions](#allrefinementdefinitions): [Collection](dw.util.Collection.md) `(read-only)` | Returns a sorted list of refinement definitions that are appropriate for  the deepest common category (or deepest common folder) of the search  result. |
+| [refinementDefinitions](#refinementdefinitions): [Collection](dw.util.Collection.md) `(read-only)` | Returns a sorted list of refinement definitions that are appropriate for  the deepest common category (or deepest common folder) of the search  result. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getAllRefinementDefinitions](dw.catalog.SearchRefinements.md#getallrefinementdefinitions)() | Returns a sorted list of refinement definitions that are appropriate for  the deepest common category (or deepest common folder) of the search  result. |
+| [getAllRefinementValues](dw.catalog.SearchRefinements.md#getallrefinementvaluesstring)([String](TopLevel.String.md)) | Returns a sorted collection of refinement values for the given refinement  attribute. |
+| [getAllRefinementValues](dw.catalog.SearchRefinements.md#getallrefinementvaluesstring-number-number)([String](TopLevel.String.md), [Number](TopLevel.Number.md), [Number](TopLevel.Number.md)) | Returns a sorted collection of refinement values for the given refinement  attribute. |
+| [getRefinementDefinitions](dw.catalog.SearchRefinements.md#getrefinementdefinitions)() | Returns a sorted list of refinement definitions that are appropriate for  the deepest common category (or deepest common folder) of the search  result. |
+| [getRefinementValues](dw.catalog.SearchRefinements.md#getrefinementvaluesstring-number-number)([String](TopLevel.String.md), [Number](TopLevel.Number.md), [Number](TopLevel.Number.md)) | Returns a collection of refinement values for the given refinement  attribute, sorting mode and sorting direction. |
+
+### 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
+
+### ASCENDING
+
+- ASCENDING: [Number](TopLevel.Number.md) = 0
+  - : Flag for an ascending sort.
+
+
+---
+
+### DESCENDING
+
+- DESCENDING: [Number](TopLevel.Number.md) = 1
+  - : Flag for a descending sort.
+
+
+---
+
+### SORT_VALUE_COUNT
+
+- SORT_VALUE_COUNT: [Number](TopLevel.Number.md) = 1
+  - : Flag for sorting on value count.
+
+
+---
+
+### SORT_VALUE_NAME
+
+- SORT_VALUE_NAME: [Number](TopLevel.Number.md) = 0
+  - : Flag for sorting on value name.
+
+
+---
+
+## Property Details
+
+### allRefinementDefinitions
+- allRefinementDefinitions: [Collection](dw.util.Collection.md) `(read-only)`
+  - : Returns a sorted list of refinement definitions that are appropriate for
+      the deepest common category (or deepest common folder) of the search
+      result. The method concatenates the sorted refinement definitions per
+      category starting at the root category until reaching the deepest common
+      category.
+      
+      The method does not filter out refinement definitions that do
+      not provide values for the current search result and can therefore also
+      be used on empty search results.
+
+
+
+---
+
+### refinementDefinitions
+- refinementDefinitions: [Collection](dw.util.Collection.md) `(read-only)`
+  - : Returns a sorted list of refinement definitions that are appropriate for
+      the deepest common category (or deepest common folder) of the search
+      result. The method concatenates the sorted refinement definitions per category
+      starting at the root category until reaching the deepest common category.
+      
+      The method also filters out refinement definitions that do not provide
+      any values for the current search result.
+
+
+
+---
+
+## Method Details
+
+### getAllRefinementDefinitions()
+- getAllRefinementDefinitions(): [Collection](dw.util.Collection.md)
+  - : Returns a sorted list of refinement definitions that are appropriate for
+      the deepest common category (or deepest common folder) of the search
+      result. The method concatenates the sorted refinement definitions per
+      category starting at the root category until reaching the deepest common
+      category.
+      
+      The method does not filter out refinement definitions that do
+      not provide values for the current search result and can therefore also
+      be used on empty search results.
+
+
+    **Returns:**
+    - A sorted list of refinement definitions appropriate for the
+              search result (based on its deepest common category)
+
+
+
+---
+
+### getAllRefinementValues(String)
+- getAllRefinementValues(attributeName: [String](TopLevel.String.md)): [Collection](dw.util.Collection.md)
+  - : Returns a sorted collection of refinement values for the given refinement
+      attribute. The returned collection includes all refinement values for
+      which the hit count is greater than 0 within the search result when the
+      passed attribute is excluded from filtering the search hits but all other
+      refinement filters are still applied. This method is useful for rendering
+      broadening options for attributes that the search is currently refined
+      by. This method does NOT return refinement values independent of the
+      search result.
+      
+      
+      For product search refinements, this method may return slightly different
+      results based on the "value set" property of the refinement definition.
+      See
+      [ProductSearchRefinements.getAllRefinementValues(ProductSearchRefinementDefinition)](dw.catalog.ProductSearchRefinements.md#getallrefinementvaluesproductsearchrefinementdefinition)
+      for details.
+
+
+    **Parameters:**
+    - attributeName - The name of the attribute to return refinement values             for.
+
+    **Returns:**
+    - The collection of SearchRefinementValue instances, sorted
+              according to the settings of the refinement definition, or null
+              if there is no refinement definition for the passed attribute
+              name.
+
+
+
+---
+
+### getAllRefinementValues(String, Number, Number)
+- getAllRefinementValues(attributeName: [String](TopLevel.String.md), sortMode: [Number](TopLevel.Number.md), sortDirection: [Number](TopLevel.Number.md)): [Collection](dw.util.Collection.md)
+  - : Returns a sorted collection of refinement values for the given refinement
+      attribute. In general, the returned collection includes all refinement
+      values for which hit count is greater than 0 within the search result
+      assuming that:
+      
+      
+      - The passed refinement attribute is NOT used to filter the search  hits.
+      - All other refinements are still applied.
+      
+      
+      This is useful for rendering broadening options for the refinement
+      definitions that the search is already refined by. It is important to
+      note that this method does NOT return refinement values independent of
+      the search result.
+      
+      
+      For product search refinements, this method may return slightly different
+      results based on the "value set" of the refinement definition. See
+      [ProductSearchRefinements.getAllRefinementValues(ProductSearchRefinementDefinition)](dw.catalog.ProductSearchRefinements.md#getallrefinementvaluesproductsearchrefinementdefinition)
+      for details.
+
+
+    **Parameters:**
+    - attributeName - The name of the attribute to return refinement values             for.
+    - sortMode - The sort mode to use to control how the collection is             sorted.
+    - sortDirection - The sort direction to use.
+
+    **Returns:**
+    - The collection of SearchRefinementValue instances, sorted
+              according to the passed parameters.
+
+
+
+---
+
+### getRefinementDefinitions()
+- getRefinementDefinitions(): [Collection](dw.util.Collection.md)
+  - : Returns a sorted list of refinement definitions that are appropriate for
+      the deepest common category (or deepest common folder) of the search
+      result. The method concatenates the sorted refinement definitions per category
+      starting at the root category until reaching the deepest common category.
+      
+      The method also filters out refinement definitions that do not provide
+      any values for the current search result.
+
+
+    **Returns:**
+    - A sorted list of refinement definitions appropriate for the
+              search result (based on its deepest common category)
+
+
+
+---
+
+### getRefinementValues(String, Number, Number)
+- getRefinementValues(attributeName: [String](TopLevel.String.md), sortMode: [Number](TopLevel.Number.md), sortDirection: [Number](TopLevel.Number.md)): [Collection](dw.util.Collection.md)
+  - : Returns a collection of refinement values for the given refinement
+      attribute, sorting mode and sorting direction.
+
+
+    **Parameters:**
+    - attributeName - The attribute name to use when collection refinement values.
+    - sortMode - The sort mode to use to control how the collection is sorted.
+    - sortDirection - The sort direction to use.
+
+    **Returns:**
+    - The collection of refinement values.
+
+
+---
+
+<!-- prettier-ignore-end -->