@salesforce/b2c-tooling-sdk 1.19.0 → 1.20.0

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

@@ -1,166 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class ProductLink
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.catalog.ProductLink](dw.catalog.ProductLink.md)
-
-The class represents a link between two products.
-
-
-## Constant Summary
-
-| Constant | Description |
-| --- | --- |
-| [LINKTYPE_ACCESSORY](#linktype_accessory): [Number](TopLevel.Number.md) = 4 | Represents an accessory product link. |
-| [LINKTYPE_ALT_ORDERUNIT](#linktype_alt_orderunit): [Number](TopLevel.Number.md) = 6 | Represents an alternative order unit product link. |
-| [LINKTYPE_CROSS_SELL](#linktype_cross_sell): [Number](TopLevel.Number.md) = 1 | Represents a cross-sell product link. |
-| [LINKTYPE_NEWER_VERSION](#linktype_newer_version): [Number](TopLevel.Number.md) = 5 | Represents a newer verion link. |
-| [LINKTYPE_OTHER](#linktype_other): [Number](TopLevel.Number.md) = 8 | Represents a miscellaneous product link. |
-| [LINKTYPE_REPLACEMENT](#linktype_replacement): [Number](TopLevel.Number.md) = 2 | Represents a replacement product link. |
-| [LINKTYPE_SPARE_PART](#linktype_spare_part): [Number](TopLevel.Number.md) = 7 | Represents a spare part product link. |
-| [LINKTYPE_UP_SELL](#linktype_up_sell): [Number](TopLevel.Number.md) = 3 | Represents an up-sell product link. |
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [sourceProduct](#sourceproduct): [Product](dw.catalog.Product.md) `(read-only)` | Returns the source product for this link. |
-| [targetProduct](#targetproduct): [Product](dw.catalog.Product.md) `(read-only)` | Returns the target product for this link. |
-| [typeCode](#typecode): [Number](TopLevel.Number.md) `(read-only)` | Returns the type of this link (see constants). |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getSourceProduct](dw.catalog.ProductLink.md#getsourceproduct)() | Returns the source product for this link. |
-| [getTargetProduct](dw.catalog.ProductLink.md#gettargetproduct)() | Returns the target product for this link. |
-| [getTypeCode](dw.catalog.ProductLink.md#gettypecode)() | Returns the type of this link (see constants). |
-
-### 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
-
-### LINKTYPE_ACCESSORY
-
-- LINKTYPE_ACCESSORY: [Number](TopLevel.Number.md) = 4
-  - : Represents an accessory product link.
-
-
----
-
-### LINKTYPE_ALT_ORDERUNIT
-
-- LINKTYPE_ALT_ORDERUNIT: [Number](TopLevel.Number.md) = 6
-  - : Represents an alternative order unit product link.
-
-
----
-
-### LINKTYPE_CROSS_SELL
-
-- LINKTYPE_CROSS_SELL: [Number](TopLevel.Number.md) = 1
-  - : Represents a cross-sell product link.
-
-
----
-
-### LINKTYPE_NEWER_VERSION
-
-- LINKTYPE_NEWER_VERSION: [Number](TopLevel.Number.md) = 5
-  - : Represents a newer verion link.
-
-
----
-
-### LINKTYPE_OTHER
-
-- LINKTYPE_OTHER: [Number](TopLevel.Number.md) = 8
-  - : Represents a miscellaneous product link.
-
-
----
-
-### LINKTYPE_REPLACEMENT
-
-- LINKTYPE_REPLACEMENT: [Number](TopLevel.Number.md) = 2
-  - : Represents a replacement product link.
-
-
----
-
-### LINKTYPE_SPARE_PART
-
-- LINKTYPE_SPARE_PART: [Number](TopLevel.Number.md) = 7
-  - : Represents a spare part product link.
-
-
----
-
-### LINKTYPE_UP_SELL
-
-- LINKTYPE_UP_SELL: [Number](TopLevel.Number.md) = 3
-  - : Represents an up-sell product link.
-
-
----
-
-## Property Details
-
-### sourceProduct
-- sourceProduct: [Product](dw.catalog.Product.md) `(read-only)`
-  - : Returns the source product for this link.
-
-
----
-
-### targetProduct
-- targetProduct: [Product](dw.catalog.Product.md) `(read-only)`
-  - : Returns the target product for this link.
-
-
----
-
-### typeCode
-- typeCode: [Number](TopLevel.Number.md) `(read-only)`
-  - : Returns the type of this link (see constants).
-
-
----
-
-## Method Details
-
-### getSourceProduct()
-- getSourceProduct(): [Product](dw.catalog.Product.md)
-  - : Returns the source product for this link.
-
-    **Returns:**
-    - the source product for this link.
-
-
----
-
-### getTargetProduct()
-- getTargetProduct(): [Product](dw.catalog.Product.md)
-  - : Returns the target product for this link.
-
-    **Returns:**
-    - the target product for this link.
-
-
----
-
-### getTypeCode()
-- getTypeCode(): [Number](TopLevel.Number.md)
-  - : Returns the type of this link (see constants).
-
-    **Returns:**
-    - the type of the link.
-
-
----
-
-<!-- prettier-ignore-end -->

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

@@ -1,136 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class ProductMgr
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.catalog.ProductMgr](dw.catalog.ProductMgr.md)
-
-Provides helper methods for getting products based on Product ID or [Catalog](dw.catalog.Catalog.md).
-
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| static [getProduct](dw.catalog.ProductMgr.md#getproductstring)([String](TopLevel.String.md)) | Returns the product with the specified id. |
-| static [queryAllSiteProducts](dw.catalog.ProductMgr.md#queryallsiteproducts)() | Returns all products assigned to the current site. |
-| static [queryAllSiteProductsSorted](dw.catalog.ProductMgr.md#queryallsiteproductssorted)() | Returns all products assigned to the current site. |
-| static [queryProductsInCatalog](dw.catalog.ProductMgr.md#queryproductsincatalogcatalog)([Catalog](dw.catalog.Catalog.md)) | Returns all products assigned to the the specified catalog, where  assignment has the same meaning as it does for queryAllSiteProducts(). |
-| static [queryProductsInCatalogSorted](dw.catalog.ProductMgr.md#queryproductsincatalogsortedcatalog)([Catalog](dw.catalog.Catalog.md)) | Returns all products assigned to the the specified catalog. |
-
-### 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)
-## Method Details
-
-### getProduct(String)
-- static getProduct(productID: [String](TopLevel.String.md)): [Product](dw.catalog.Product.md)
-  - : Returns the product with the specified id.
-
-    **Parameters:**
-    - productID - the product identifier.
-
-    **Returns:**
-    - Product for specified id or null
-
-
----
-
-### queryAllSiteProducts()
-- static queryAllSiteProducts(): [SeekableIterator](dw.util.SeekableIterator.md)
-  - : Returns all products assigned to the current site.
-      
-      
-      A product is assigned to a site if 
-      
-      
-      - it is assigned to at least one category of the site catalog or
-      - it is a variant and it's master product is assigned to the current site
-      
-      
-      
-      It is strongly recommended to call `close()` on the returned SeekableIterator
-      if not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.
-
-
-    **Returns:**
-    - Iterator of all site products
-
-    **See Also:**
-    - [SeekableIterator.close()](dw.util.SeekableIterator.md#close)
-
-
----
-
-### queryAllSiteProductsSorted()
-- static queryAllSiteProductsSorted(): [SeekableIterator](dw.util.SeekableIterator.md)
-  - : Returns all products assigned to the current site.
-      
-      
-      Works like queryAllSiteProducts(), but additionally sorts the result set
-      by product ID.
-      
-      
-      It is strongly recommended to call `close()` on the returned SeekableIterator
-      if not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.
-
-
-    **Returns:**
-    - Iterator of all site products sorted by product ID.
-
-    **See Also:**
-    - [SeekableIterator.close()](dw.util.SeekableIterator.md#close)
-
-
----
-
-### queryProductsInCatalog(Catalog)
-- static queryProductsInCatalog(catalog: [Catalog](dw.catalog.Catalog.md)): [SeekableIterator](dw.util.SeekableIterator.md)
-  - : Returns all products assigned to the the specified catalog, where
-      assignment has the same meaning as it does for queryAllSiteProducts().
-      
-      
-      It is strongly recommended to call `close()` on the returned SeekableIterator
-      if not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.
-
-
-    **Parameters:**
-    - catalog - The catalog whose assigned products should be returned.
-
-    **Returns:**
-    - Iterator of all products assigned to specified catalog.
-
-    **See Also:**
-    - [SeekableIterator.close()](dw.util.SeekableIterator.md#close)
-
-
----
-
-### queryProductsInCatalogSorted(Catalog)
-- static queryProductsInCatalogSorted(catalog: [Catalog](dw.catalog.Catalog.md)): [SeekableIterator](dw.util.SeekableIterator.md)
-  - : Returns all products assigned to the the specified catalog.
-      Works like queryProductsInCatalog(), but additionally sorts the result
-      set by product ID.
-      
-      
-      It is strongly recommended to call `close()` on the returned SeekableIterator
-      if not all of its elements are being retrieved. This will ensure the proper cleanup of system resources.
-
-
-    **Parameters:**
-    - catalog - The catalog whose assigned products should be returned.
-
-    **Returns:**
-    - Iterator of all products assigned to specified catalog sorted by
-              product ID.
-
-
-    **See Also:**
-    - [SeekableIterator.close()](dw.util.SeekableIterator.md#close)
-
-
----
-
-<!-- prettier-ignore-end -->

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

@@ -1,189 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class ProductOption
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.object.PersistentObject](dw.object.PersistentObject.md)
-    - [dw.object.ExtensibleObject](dw.object.ExtensibleObject.md)
-      - [dw.catalog.ProductOption](dw.catalog.ProductOption.md)
-
-Represents a product option.
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [ID](#id): [String](TopLevel.String.md) `(read-only)` | Returns the product option ID. |
-| [defaultValue](#defaultvalue): [ProductOptionValue](dw.catalog.ProductOptionValue.md) `(read-only)` | Returns the default value for the product option. |
-| [description](#description): [String](TopLevel.String.md) `(read-only)` | Returns the product option's short description in the current locale. |
-| [displayName](#displayname): [String](TopLevel.String.md) `(read-only)` | Returns the product option's display name in the current locale. |
-| [htmlName](#htmlname): [String](TopLevel.String.md) `(read-only)` | Returns an HTML representation of the option id. |
-| [image](#image): [MediaFile](dw.content.MediaFile.md) `(read-only)` | Returns the product option's image. |
-| [optionValues](#optionvalues): [Collection](dw.util.Collection.md) `(read-only)` | Returns a collection containing the product option values. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getDefaultValue](dw.catalog.ProductOption.md#getdefaultvalue)() | Returns the default value for the product option. |
-| [getDescription](dw.catalog.ProductOption.md#getdescription)() | Returns the product option's short description in the current locale. |
-| [getDisplayName](dw.catalog.ProductOption.md#getdisplayname)() | Returns the product option's display name in the current locale. |
-| [getHtmlName](dw.catalog.ProductOption.md#gethtmlname)() | Returns an HTML representation of the option id. |
-| [getHtmlName](dw.catalog.ProductOption.md#gethtmlnamestring)([String](TopLevel.String.md)) | Returns an HTML representation of the option id with the custom prefix. |
-| [getID](dw.catalog.ProductOption.md#getid)() | Returns the product option ID. |
-| [getImage](dw.catalog.ProductOption.md#getimage)() | Returns the product option's image. |
-| [getOptionValues](dw.catalog.ProductOption.md#getoptionvalues)() | Returns a collection containing the product option values. |
-
-### 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
-
-### ID
-- ID: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the product option ID.
-
-
----
-
-### defaultValue
-- defaultValue: [ProductOptionValue](dw.catalog.ProductOptionValue.md) `(read-only)`
-  - : Returns the default value for the product option.
-
-
----
-
-### description
-- description: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the product option's short description in the current locale.
-
-
----
-
-### displayName
-- displayName: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the product option's display name in the current locale.
-
-
----
-
-### htmlName
-- htmlName: [String](TopLevel.String.md) `(read-only)`
-  - : Returns an HTML representation of the option id.
-
-
----
-
-### image
-- image: [MediaFile](dw.content.MediaFile.md) `(read-only)`
-  - : Returns the product option's image.
-
-
----
-
-### optionValues
-- optionValues: [Collection](dw.util.Collection.md) `(read-only)`
-  - : Returns a collection containing the product option values.
-
-
----
-
-## Method Details
-
-### getDefaultValue()
-- getDefaultValue(): [ProductOptionValue](dw.catalog.ProductOptionValue.md)
-  - : Returns the default value for the product option.
-
-    **Returns:**
-    - the object for the relation 'defaultValue'
-
-
----
-
-### getDescription()
-- getDescription(): [String](TopLevel.String.md)
-  - : Returns the product option's short description in the current locale.
-
-    **Returns:**
-    - The value of the short description in the current locale,
-                   or null if it wasn't found.
-
-
-
----
-
-### getDisplayName()
-- getDisplayName(): [String](TopLevel.String.md)
-  - : Returns the product option's display name in the current locale.
-
-    **Returns:**
-    - The value of the display name in the current locale,
-                   or null if it wasn't found.
-
-
-
----
-
-### getHtmlName()
-- getHtmlName(): [String](TopLevel.String.md)
-  - : Returns an HTML representation of the option id.
-
-    **Returns:**
-    - an HTML representation of the option id.
-
-
----
-
-### getHtmlName(String)
-- getHtmlName(prefix: [String](TopLevel.String.md)): [String](TopLevel.String.md)
-  - : Returns an HTML representation of the option id with the custom prefix.
-
-    **Parameters:**
-    - prefix - a custom prefix for the html name.
-
-    **Returns:**
-    - an HTML representation of the option id.
-
-
----
-
-### getID()
-- getID(): [String](TopLevel.String.md)
-  - : Returns the product option ID.
-
-    **Returns:**
-    - the product option identifier.
-
-
----
-
-### getImage()
-- getImage(): [MediaFile](dw.content.MediaFile.md)
-  - : Returns the product option's image.
-
-    **Returns:**
-    - the product option's image.
-
-
----
-
-### getOptionValues()
-- getOptionValues(): [Collection](dw.util.Collection.md)
-  - : Returns a collection containing the product option values.
-
-    **Returns:**
-    - a collection containing the product option values.
-
-
----
-
-<!-- prettier-ignore-end -->