@salesforce/b2c-tooling-sdk 0.0.1 → 0.0.2

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

@@ -0,0 +1,99 @@
+<!-- prettier-ignore-start -->
+# Class ProductSearchRefinementDefinition
+
+- [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)
+        - [dw.catalog.ProductSearchRefinementDefinition](dw.catalog.ProductSearchRefinementDefinition.md)
+
+This class provides an interface to refinement options for the product search.
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [categoryRefinement](#categoryrefinement): [Boolean](TopLevel.Boolean.md) `(read-only)` | Identifies if this is a category refinement. |
+| [priceRefinement](#pricerefinement): [Boolean](TopLevel.Boolean.md) `(read-only)` | Identifies if this is a price refinement. |
+| [promotionRefinement](#promotionrefinement): [Boolean](TopLevel.Boolean.md) `(read-only)` | Identifies if this is a promotion refinement. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [isCategoryRefinement](dw.catalog.ProductSearchRefinementDefinition.md#iscategoryrefinement)() | Identifies if this is a category refinement. |
+| [isPriceRefinement](dw.catalog.ProductSearchRefinementDefinition.md#ispricerefinement)() | Identifies if this is a price refinement. |
+| [isPromotionRefinement](dw.catalog.ProductSearchRefinementDefinition.md#ispromotionrefinement)() | Identifies if this is a promotion refinement. |
+
+### Methods inherited from class SearchRefinementDefinition
+
+[getAttributeID](dw.catalog.SearchRefinementDefinition.md#getattributeid), [getCutoffThreshold](dw.catalog.SearchRefinementDefinition.md#getcutoffthreshold), [getDisplayName](dw.catalog.SearchRefinementDefinition.md#getdisplayname), [getValueTypeCode](dw.catalog.SearchRefinementDefinition.md#getvaluetypecode), [isAttributeRefinement](dw.catalog.SearchRefinementDefinition.md#isattributerefinement)
+### 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
+
+### categoryRefinement
+- categoryRefinement: [Boolean](TopLevel.Boolean.md) `(read-only)`
+  - : Identifies if this is a category refinement.
+
+
+---
+
+### priceRefinement
+- priceRefinement: [Boolean](TopLevel.Boolean.md) `(read-only)`
+  - : Identifies if this is a price refinement.
+
+
+---
+
+### promotionRefinement
+- promotionRefinement: [Boolean](TopLevel.Boolean.md) `(read-only)`
+  - : Identifies if this is a promotion refinement.
+
+
+---
+
+## Method Details
+
+### isCategoryRefinement()
+- isCategoryRefinement(): [Boolean](TopLevel.Boolean.md)
+  - : Identifies if this is a category refinement.
+
+    **Returns:**
+    - true if this is a category refinement, false otherwise.
+
+
+---
+
+### isPriceRefinement()
+- isPriceRefinement(): [Boolean](TopLevel.Boolean.md)
+  - : Identifies if this is a price refinement.
+
+    **Returns:**
+    - true if this is a price refinement, false otherwise.
+
+
+---
+
+### isPromotionRefinement()
+- isPromotionRefinement(): [Boolean](TopLevel.Boolean.md)
+  - : Identifies if this is a promotion refinement.
+
+    **Returns:**
+    - true if this is a promotion refinement, false otherwise.
+
+
+---
+
+<!-- prettier-ignore-end -->

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

@@ -0,0 +1,80 @@
+<!-- prettier-ignore-start -->
+# Class ProductSearchRefinementValue
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.catalog.SearchRefinementValue](dw.catalog.SearchRefinementValue.md)
+    - [dw.catalog.ProductSearchRefinementValue](dw.catalog.ProductSearchRefinementValue.md)
+
+Represents the value of a product search refinement.
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [valueFrom](#valuefrom): [Number](TopLevel.Number.md) `(read-only)` | Returns the lower bound for price refinements. |
+| [valueTo](#valueto): [Number](TopLevel.Number.md) `(read-only)` | Returns the upper bound for price refinements. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getValueFrom](dw.catalog.ProductSearchRefinementValue.md#getvaluefrom)() | Returns the lower bound for price refinements. |
+| [getValueTo](dw.catalog.ProductSearchRefinementValue.md#getvalueto)() | Returns the upper bound for price refinements. |
+
+### Methods inherited from class SearchRefinementValue
+
+[getDescription](dw.catalog.SearchRefinementValue.md#getdescription), [getDisplayValue](dw.catalog.SearchRefinementValue.md#getdisplayvalue), [getHitCount](dw.catalog.SearchRefinementValue.md#gethitcount), [getID](dw.catalog.SearchRefinementValue.md#getid), [getPresentationID](dw.catalog.SearchRefinementValue.md#getpresentationid), [getValue](dw.catalog.SearchRefinementValue.md#getvalue)
+### 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
+
+### valueFrom
+- valueFrom: [Number](TopLevel.Number.md) `(read-only)`
+  - : Returns the lower bound for price refinements.  For example, 50.00
+      for a range of $50.00 - $99.99.
+
+
+
+---
+
+### valueTo
+- valueTo: [Number](TopLevel.Number.md) `(read-only)`
+  - : Returns the upper bound for price refinements.  For example, 99.99
+      for a range of $50.00 - $99.99.
+
+
+
+---
+
+## Method Details
+
+### getValueFrom()
+- getValueFrom(): [Number](TopLevel.Number.md)
+  - : Returns the lower bound for price refinements.  For example, 50.00
+      for a range of $50.00 - $99.99.
+
+
+    **Returns:**
+    - the lower bound for price refinements.
+
+
+---
+
+### getValueTo()
+- getValueTo(): [Number](TopLevel.Number.md)
+  - : Returns the upper bound for price refinements.  For example, 99.99
+      for a range of $50.00 - $99.99.
+
+
+    **Returns:**
+    - the upper bound for price refinements.
+
+
+---
+
+<!-- prettier-ignore-end -->

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

@@ -0,0 +1,265 @@
+<!-- prettier-ignore-start -->
+# Class ProductSearchRefinements
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.catalog.SearchRefinements](dw.catalog.SearchRefinements.md)
+    - [dw.catalog.ProductSearchRefinements](dw.catalog.ProductSearchRefinements.md)
+
+This class provides an interface to refinement options for the product
+search. In a typical usage, the client application UI displays the search
+refinements along with the search results and allows customers to "refine"
+the results (i.e. limit the results that are shown) by specifying additional
+product criteria, or "relax" (i.e. broaden) the results after previously
+refining. The four types of product search refinements are:
+
+
+- **Refine By Category:**Limit the products to those assigned to  specific child/ancestor categories of the search category.
+- **Refine By Attribute:**Limit the products to those with specific  values for a given attribute. Values may be grouped into "buckets" so that a  given set of values are represented as a single refinement option.
+- **Refine By Price:**Limit the products to those whose prices fall in  a specific range.
+- **Refine By Promotion:**Limit the products to those which are related  to a specific promotion.
+
+
+Rendering a product search refinement UI typically begins with iterating the
+refinement definitions for the search result. Call
+[SearchRefinements.getRefinementDefinitions()](dw.catalog.SearchRefinements.md#getrefinementdefinitions) or
+[SearchRefinements.getAllRefinementDefinitions()](dw.catalog.SearchRefinements.md#getallrefinementdefinitions) to
+retrieve the appropriate collection of refinement definitions. For each
+definition, display the available refinement values by calling
+[getAllRefinementValues(ProductSearchRefinementDefinition)](dw.catalog.ProductSearchRefinements.md#getallrefinementvaluesproductsearchrefinementdefinition). Depending
+on the type of the refinement definition, the application must use slightly
+different logic to display the refinement widgets. For all 4 types, methods
+in [ProductSearchModel](dw.catalog.ProductSearchModel.md) are used to generate URLs to render
+hyperlinks in the UI. When clicked, these links trigger a call to the Search
+pipelet which in turn applies the appropriate filters to the native search
+result.
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [categoryRefinementDefinition](#categoryrefinementdefinition): [ProductSearchRefinementDefinition](dw.catalog.ProductSearchRefinementDefinition.md) `(read-only)` | Returns the appropriate category refinement definition based on the search  result. |
+| [priceRefinementDefinition](#pricerefinementdefinition): [ProductSearchRefinementDefinition](dw.catalog.ProductSearchRefinementDefinition.md) `(read-only)` | Returns the appropriate price refinement definition based on the search  result. |
+| [promotionRefinementDefinition](#promotionrefinementdefinition): [ProductSearchRefinementDefinition](dw.catalog.ProductSearchRefinementDefinition.md) `(read-only)` | Returns the appropriate promotion refinement definition based on the search  result. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getAllRefinementValues](dw.catalog.ProductSearchRefinements.md#getallrefinementvaluesproductsearchrefinementdefinition)([ProductSearchRefinementDefinition](dw.catalog.ProductSearchRefinementDefinition.md)) | Returns a sorted collection of refinement values for the passed  refinement definition. |
+| [getCategoryRefinementDefinition](dw.catalog.ProductSearchRefinements.md#getcategoryrefinementdefinition)() | Returns the appropriate category refinement definition based on the search  result. |
+| [getNextLevelCategoryRefinementValues](dw.catalog.ProductSearchRefinements.md#getnextlevelcategoryrefinementvaluescategory)([Category](dw.catalog.Category.md)) | Returns category refinement values based on the current search result  filtered such that only category refinements representing children of the  given category are present. |
+| [getPriceRefinementDefinition](dw.catalog.ProductSearchRefinements.md#getpricerefinementdefinition)() | Returns the appropriate price refinement definition based on the search  result. |
+| [getPromotionRefinementDefinition](dw.catalog.ProductSearchRefinements.md#getpromotionrefinementdefinition)() | Returns the appropriate promotion refinement definition based on the search  result. |
+| [getRefinementValue](dw.catalog.ProductSearchRefinements.md#getrefinementvalueproductsearchrefinementdefinition-string)([ProductSearchRefinementDefinition](dw.catalog.ProductSearchRefinementDefinition.md), [String](TopLevel.String.md)) | Returns the refinement value (incl. |
+| [getRefinementValue](dw.catalog.ProductSearchRefinements.md#getrefinementvaluestring-string)([String](TopLevel.String.md), [String](TopLevel.String.md)) | Returns the refinement value (incl. |
+| [getRefinementValues](dw.catalog.ProductSearchRefinements.md#getrefinementvaluesproductsearchrefinementdefinition)([ProductSearchRefinementDefinition](dw.catalog.ProductSearchRefinementDefinition.md)) | Returns a collection of refinement values for the given refinement  definition. |
+
+### Methods inherited from class SearchRefinements
+
+[getAllRefinementDefinitions](dw.catalog.SearchRefinements.md#getallrefinementdefinitions), [getAllRefinementValues](dw.catalog.SearchRefinements.md#getallrefinementvaluesstring), [getAllRefinementValues](dw.catalog.SearchRefinements.md#getallrefinementvaluesstring-number-number), [getRefinementDefinitions](dw.catalog.SearchRefinements.md#getrefinementdefinitions), [getRefinementValues](dw.catalog.SearchRefinements.md#getrefinementvaluesstring-number-number)
+### 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
+
+### categoryRefinementDefinition
+- categoryRefinementDefinition: [ProductSearchRefinementDefinition](dw.catalog.ProductSearchRefinementDefinition.md) `(read-only)`
+  - : Returns the appropriate category refinement definition based on the search
+      result. The category refinement definition returned will be the first that
+      can be found traversing the category tree upward starting at the deepest
+      common category of the search result.
+
+
+
+---
+
+### priceRefinementDefinition
+- priceRefinementDefinition: [ProductSearchRefinementDefinition](dw.catalog.ProductSearchRefinementDefinition.md) `(read-only)`
+  - : Returns the appropriate price refinement definition based on the search
+      result. The price refinement definition returned will be the first that
+      can be found traversing the category tree upward starting at the deepest
+      common category of the search result.
+
+
+
+---
+
+### promotionRefinementDefinition
+- promotionRefinementDefinition: [ProductSearchRefinementDefinition](dw.catalog.ProductSearchRefinementDefinition.md) `(read-only)`
+  - : Returns the appropriate promotion refinement definition based on the search
+      result. The promotion refinement definition returned will be the first that
+      can be found traversing the category tree upward starting at the deepest
+      common category of the search result.
+
+
+
+---
+
+## Method Details
+
+### getAllRefinementValues(ProductSearchRefinementDefinition)
+- getAllRefinementValues(definition: [ProductSearchRefinementDefinition](dw.catalog.ProductSearchRefinementDefinition.md)): [Collection](dw.util.Collection.md)
+  - : Returns a sorted collection of refinement values for the passed
+      refinement definition. The returned collection includes all refinement
+      values for which the hit count is greater than 0 within the search result
+      when the passed refinement definition is excluded from filtering the
+      search hits but all other refinement filters are still applied. This
+      method is useful for rendering broadening options for definitions that
+      the search is currently refined by. If the search is not currently
+      restricted by the passed refinement definition, then this method will
+      return the same result as
+      [getRefinementValues(ProductSearchRefinementDefinition)](dw.catalog.ProductSearchRefinements.md#getrefinementvaluesproductsearchrefinementdefinition).
+      
+      
+      For attribute-based refinement definitions, the returned collection
+      depends upon how the "value set" property is configured. (Category and
+      price refinement definitions do not have such a property.) If this
+      property is set to "search result values", the behavior is as described
+      above. If this property is set to "all values of category", then the
+      returned collection will also include all refinement values for products
+      in the category subtree rooted at the search definition's category. This
+      setting is useful for refinements whose visualization is supposed to
+      remain constant for a certain subtree of a catalog (e.g. color pickers or
+      size charts). These additional values are independent of the search
+      result and do not contribute towards the value hit counts. If the search
+      result is further refined by one of these values, it is possible to get
+      an empty search result. Except for this one case this method does NOT
+      return refinement values independent of the search result.
+
+
+    **Parameters:**
+    - definition - The refinement definition to return refinement values             for. Must not be null.
+
+    **Returns:**
+    - The collection of ProductSearchRefinementValue instances, sorted
+              according to the settings of the refinement definition.
+
+
+
+---
+
+### getCategoryRefinementDefinition()
+- getCategoryRefinementDefinition(): [ProductSearchRefinementDefinition](dw.catalog.ProductSearchRefinementDefinition.md)
+  - : Returns the appropriate category refinement definition based on the search
+      result. The category refinement definition returned will be the first that
+      can be found traversing the category tree upward starting at the deepest
+      common category of the search result.
+
+
+    **Returns:**
+    - The category refinement definition or `null` if none can
+              be found.
+
+
+
+---
+
+### getNextLevelCategoryRefinementValues(Category)
+- getNextLevelCategoryRefinementValues(category: [Category](dw.catalog.Category.md)): [Collection](dw.util.Collection.md)
+  - : Returns category refinement values based on the current search result
+      filtered such that only category refinements representing children of the
+      given category are present. If no category is given, the method uses the
+      catalog's root category. The refinement value product counts represent
+      all hits contained in the catalog tree starting at the corresponding
+      child category.
+
+
+    **Parameters:**
+    - category - The category to return child category refinement values for.
+
+    **Returns:**
+    - The refinement values for all child categories of the given
+              category.
+
+
+
+---
+
+### getPriceRefinementDefinition()
+- getPriceRefinementDefinition(): [ProductSearchRefinementDefinition](dw.catalog.ProductSearchRefinementDefinition.md)
+  - : Returns the appropriate price refinement definition based on the search
+      result. The price refinement definition returned will be the first that
+      can be found traversing the category tree upward starting at the deepest
+      common category of the search result.
+
+
+    **Returns:**
+    - The price refinement definition or `null` if none can
+              be found.
+
+
+
+---
+
+### getPromotionRefinementDefinition()
+- getPromotionRefinementDefinition(): [ProductSearchRefinementDefinition](dw.catalog.ProductSearchRefinementDefinition.md)
+  - : Returns the appropriate promotion refinement definition based on the search
+      result. The promotion refinement definition returned will be the first that
+      can be found traversing the category tree upward starting at the deepest
+      common category of the search result.
+
+
+    **Returns:**
+    - The promotion refinement definition or `null` if none can
+              be found.
+
+
+
+---
+
+### getRefinementValue(ProductSearchRefinementDefinition, String)
+- getRefinementValue(definition: [ProductSearchRefinementDefinition](dw.catalog.ProductSearchRefinementDefinition.md), value: [String](TopLevel.String.md)): [ProductSearchRefinementValue](dw.catalog.ProductSearchRefinementValue.md)
+  - : Returns the refinement value (incl. product hit count) for the given
+      refinement definition and the given (selected) value.
+
+
+    **Parameters:**
+    - definition - The definition to return the refinement for.
+    - value - The value to return the refinement for.
+
+    **Returns:**
+    - The refinement value.
+
+
+---
+
+### getRefinementValue(String, String)
+- getRefinementValue(name: [String](TopLevel.String.md), value: [String](TopLevel.String.md)): [ProductSearchRefinementValue](dw.catalog.ProductSearchRefinementValue.md)
+  - : Returns the refinement value (incl. product hit count) for the given
+      refinement attribute and the given (selected) value.
+
+
+    **Parameters:**
+    - name - The name of the refinement attribute.
+    - value - The value to return the refinement for.
+
+    **Returns:**
+    - The refinement value.
+
+
+---
+
+### getRefinementValues(ProductSearchRefinementDefinition)
+- getRefinementValues(definition: [ProductSearchRefinementDefinition](dw.catalog.ProductSearchRefinementDefinition.md)): [Collection](dw.util.Collection.md)
+  - : Returns a collection of refinement values for the given refinement
+      definition. The returned refinement values only include those that are
+      part of the actual search result (i.e. hit count will always be > 0).
+
+
+    **Parameters:**
+    - definition - The refinement definition to return refinement values for.
+
+    **Returns:**
+    - The collection of refinement values sorted according to the
+              settings of the definition.
+
+
+
+---
+
+<!-- prettier-ignore-end -->

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

@@ -0,0 +1,107 @@
+<!-- prettier-ignore-start -->
+# Class ProductVariationAttribute
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.catalog.ProductVariationAttribute](dw.catalog.ProductVariationAttribute.md)
+
+Represents a product variation attribute
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [ID](#id): [String](TopLevel.String.md) `(read-only)` | Returns the ID of the product variation attribute. |
+| [attributeID](#attributeid): [String](TopLevel.String.md) `(read-only)` | Returns the ID of the product attribute defintion related to   this variation attribute. |
+| [displayName](#displayname): [String](TopLevel.String.md) `(read-only)` | Returns the display name for the product variation attribute, which can be used in the  user interface. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getAttributeID](dw.catalog.ProductVariationAttribute.md#getattributeid)() | Returns the ID of the product attribute defintion related to   this variation attribute. |
+| [getDisplayName](dw.catalog.ProductVariationAttribute.md#getdisplayname)() | Returns the display name for the product variation attribute, which can be used in the  user interface. |
+| [getID](dw.catalog.ProductVariationAttribute.md#getid)() | Returns the ID of the product variation attribute. |
+
+### 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 ID of the product variation attribute.
+
+
+---
+
+### attributeID
+- attributeID: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the ID of the product attribute defintion related to 
+      this variation attribute.  This ID matches the
+      value returned by [ObjectAttributeDefinition.getID()](dw.object.ObjectAttributeDefinition.md#getid)  
+      for the appropriate product attribute definition.
+      This ID is generally different than the ID returned by 
+      [getID()](dw.catalog.ProductVariationAttribute.md#getid).
+
+
+
+---
+
+### displayName
+- displayName: [String](TopLevel.String.md) `(read-only)`
+  - : Returns the display name for the product variation attribute, which can be used in the
+      user interface.
+
+
+
+---
+
+## Method Details
+
+### getAttributeID()
+- getAttributeID(): [String](TopLevel.String.md)
+  - : Returns the ID of the product attribute defintion related to 
+      this variation attribute.  This ID matches the
+      value returned by [ObjectAttributeDefinition.getID()](dw.object.ObjectAttributeDefinition.md#getid)  
+      for the appropriate product attribute definition.
+      This ID is generally different than the ID returned by 
+      [getID()](dw.catalog.ProductVariationAttribute.md#getid).
+
+
+    **Returns:**
+    - the ID of the product attribute definition of this variation
+      attribute.
+
+
+
+---
+
+### getDisplayName()
+- getDisplayName(): [String](TopLevel.String.md)
+  - : Returns the display name for the product variation attribute, which can be used in the
+      user interface.
+
+
+    **Returns:**
+    - the display name for the product variation attribute, which can be used in the
+      user interface.
+
+
+
+---
+
+### getID()
+- getID(): [String](TopLevel.String.md)
+  - : Returns the ID of the product variation attribute.
+
+    **Returns:**
+    - the ID of the product variation attribute.
+
+
+---
+
+<!-- prettier-ignore-end -->