@salesforce/b2c-tooling-sdk 1.19.1 → 1.20.1

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

@@ -1,179 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class CategoryAssignment
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.object.PersistentObject](dw.object.PersistentObject.md)
-    - [dw.object.ExtensibleObject](dw.object.ExtensibleObject.md)
-      - [dw.catalog.CategoryAssignment](dw.catalog.CategoryAssignment.md)
-
-Represents a category assignment in Commerce Cloud Digital.
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [calloutMsg](#calloutmsg): [MarkupText](dw.content.MarkupText.md) `(read-only)` | Returns the category assignment's callout message in the current locale. |
-| [category](#category): [Category](dw.catalog.Category.md) `(read-only)` | Returns the category to which this category assignment is bound. |
-| [image](#image): [MediaFile](dw.content.MediaFile.md) `(read-only)` | Returns the category assignment's image. |
-| [longDescription](#longdescription): [MarkupText](dw.content.MarkupText.md) `(read-only)` | Returns the category assignment's long description in the current locale. |
-| [name](#name): [String](TopLevel.String.md) `(read-only)` | Returns the name of the category assignment in the current locale. |
-| [product](#product): [Product](dw.catalog.Product.md) `(read-only)` | Returns the product to which this category assignment is bound. |
-| [shortDescription](#shortdescription): [MarkupText](dw.content.MarkupText.md) `(read-only)` | Returns the category assignment's short description in the current locale. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getCalloutMsg](dw.catalog.CategoryAssignment.md#getcalloutmsg)() | Returns the category assignment's callout message in the current locale. |
-| [getCategory](dw.catalog.CategoryAssignment.md#getcategory)() | Returns the category to which this category assignment is bound. |
-| [getImage](dw.catalog.CategoryAssignment.md#getimage)() | Returns the category assignment's image. |
-| [getLongDescription](dw.catalog.CategoryAssignment.md#getlongdescription)() | Returns the category assignment's long description in the current locale. |
-| [getName](dw.catalog.CategoryAssignment.md#getname)() | Returns the name of the category assignment in the current locale. |
-| [getProduct](dw.catalog.CategoryAssignment.md#getproduct)() | Returns the product to which this category assignment is bound. |
-| [getShortDescription](dw.catalog.CategoryAssignment.md#getshortdescription)() | Returns the category assignment's short description in the current locale. |
-
-### 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
-
-### calloutMsg
-- calloutMsg: [MarkupText](dw.content.MarkupText.md) `(read-only)`
-  - : Returns the category assignment's callout message in the current locale.
-
-
----
-
-### category
-- category: [Category](dw.catalog.Category.md) `(read-only)`
-  - : Returns the category to which this category assignment is bound.
-
-
----
-
-### image
-- image: [MediaFile](dw.content.MediaFile.md) `(read-only)`
-  - : Returns the category assignment's image.
-
-
----
-
-### longDescription
-- longDescription: [MarkupText](dw.content.MarkupText.md) `(read-only)`
-  - : Returns the category assignment's long description in the current locale.
-
-
----
-
-### name
-- name: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the name of the category assignment in the current locale.
-
-
----
-
-### product
-- product: [Product](dw.catalog.Product.md) `(read-only)`
-  - : Returns the product to which this category assignment is bound.
-
-
----
-
-### shortDescription
-- shortDescription: [MarkupText](dw.content.MarkupText.md) `(read-only)`
-  - : Returns the category assignment's short description in the current locale.
-
-
----
-
-## Method Details
-
-### getCalloutMsg()
-- getCalloutMsg(): [MarkupText](dw.content.MarkupText.md)
-  - : Returns the category assignment's callout message in the current locale.
-
-    **Returns:**
-    - the category assignment's callout message in the current locale, or null if it
-              wasn't found.
-
-
-
----
-
-### getCategory()
-- getCategory(): [Category](dw.catalog.Category.md)
-  - : Returns the category to which this category assignment is bound.
-
-    **Returns:**
-    - The category to which this category assignment is bound.
-
-
----
-
-### getImage()
-- getImage(): [MediaFile](dw.content.MediaFile.md)
-  - : Returns the category assignment's image.
-
-    **Returns:**
-    - the category assignment's image.
-
-
----
-
-### getLongDescription()
-- getLongDescription(): [MarkupText](dw.content.MarkupText.md)
-  - : Returns the category assignment's long description in the current locale.
-
-    **Returns:**
-    - The category assignment's long description in the current locale, or null if it
-              wasn't found.
-
-
-
----
-
-### getName()
-- getName(): [String](TopLevel.String.md)
-  - : Returns the name of the category assignment in the current locale.
-
-    **Returns:**
-    - The name of the category assignment for the current locale, or null if it
-              wasn't found.
-
-
-
----
-
-### getProduct()
-- getProduct(): [Product](dw.catalog.Product.md)
-  - : Returns the product to which this category assignment is bound.
-
-    **Returns:**
-    - The product to which this category assignment is bound.
-
-
----
-
-### getShortDescription()
-- getShortDescription(): [MarkupText](dw.content.MarkupText.md)
-  - : Returns the category assignment's short description in the current locale.
-
-    **Returns:**
-    - the category assignment's short description in the current locale, or null if it
-              wasn't found.
-
-
-
----
-
-<!-- prettier-ignore-end -->

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

@@ -1,142 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class CategoryLink
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.catalog.CategoryLink](dw.catalog.CategoryLink.md)
-
-A CategoryLink represents a directed relationship between two catalog
-categories.  Merchants create category links in order to market similar or
-related groups of products.
-
-
-
-## Constant Summary
-
-| Constant | Description |
-| --- | --- |
-| [LINKTYPE_ACCESSORY](#linktype_accessory): [Number](TopLevel.Number.md) = 2 | Represents an accessory category link. |
-| [LINKTYPE_CROSS_SELL](#linktype_cross_sell): [Number](TopLevel.Number.md) = 4 | Represents a cross-sell category link. |
-| [LINKTYPE_OTHER](#linktype_other): [Number](TopLevel.Number.md) = 1 | Represents a miscellaneous category link. |
-| [LINKTYPE_SPARE_PART](#linktype_spare_part): [Number](TopLevel.Number.md) = 6 | Represents a spare part category link. |
-| [LINKTYPE_UP_SELL](#linktype_up_sell): [Number](TopLevel.Number.md) = 5 | Represents an up-sell category link. |
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [sourceCategory](#sourcecategory): [Category](dw.catalog.Category.md) `(read-only)` | Returns the object for the relation 'sourceCategory'. |
-| [targetCategory](#targetcategory): [Category](dw.catalog.Category.md) `(read-only)` | Returns the object for the relation 'targetCategory'. |
-| [typeCode](#typecode): [Number](TopLevel.Number.md) `(read-only)` | Returns the type of this category link (see constants). |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getSourceCategory](dw.catalog.CategoryLink.md#getsourcecategory)() | Returns the object for the relation 'sourceCategory'. |
-| [getTargetCategory](dw.catalog.CategoryLink.md#gettargetcategory)() | Returns the object for the relation 'targetCategory'. |
-| [getTypeCode](dw.catalog.CategoryLink.md#gettypecode)() | Returns the type of this category 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) = 2
-  - : Represents an accessory category link.
-
-
----
-
-### LINKTYPE_CROSS_SELL
-
-- LINKTYPE_CROSS_SELL: [Number](TopLevel.Number.md) = 4
-  - : Represents a cross-sell category link.
-
-
----
-
-### LINKTYPE_OTHER
-
-- LINKTYPE_OTHER: [Number](TopLevel.Number.md) = 1
-  - : Represents a miscellaneous category link.
-
-
----
-
-### LINKTYPE_SPARE_PART
-
-- LINKTYPE_SPARE_PART: [Number](TopLevel.Number.md) = 6
-  - : Represents a spare part category link.
-
-
----
-
-### LINKTYPE_UP_SELL
-
-- LINKTYPE_UP_SELL: [Number](TopLevel.Number.md) = 5
-  - : Represents an up-sell category link.
-
-
----
-
-## Property Details
-
-### sourceCategory
-- sourceCategory: [Category](dw.catalog.Category.md) `(read-only)`
-  - : Returns the object for the relation 'sourceCategory'.
-
-
----
-
-### targetCategory
-- targetCategory: [Category](dw.catalog.Category.md) `(read-only)`
-  - : Returns the object for the relation 'targetCategory'.
-
-
----
-
-### typeCode
-- typeCode: [Number](TopLevel.Number.md) `(read-only)`
-  - : Returns the type of this category link (see constants).
-
-
----
-
-## Method Details
-
-### getSourceCategory()
-- getSourceCategory(): [Category](dw.catalog.Category.md)
-  - : Returns the object for the relation 'sourceCategory'.
-
-    **Returns:**
-    - the object for the relation 'sourceCategory'
-
-
----
-
-### getTargetCategory()
-- getTargetCategory(): [Category](dw.catalog.Category.md)
-  - : Returns the object for the relation 'targetCategory'.
-
-    **Returns:**
-    - the object for the relation 'targetCategory'
-
-
----
-
-### getTypeCode()
-- getTypeCode(): [Number](TopLevel.Number.md)
-  - : Returns the type of this category link (see constants).
-
-    **Returns:**
-    - the type of the link.
-
-
----
-
-<!-- prettier-ignore-end -->

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

@@ -1,215 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class PriceBook
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.object.PersistentObject](dw.object.PersistentObject.md)
-    - [dw.object.ExtensibleObject](dw.object.ExtensibleObject.md)
-      - [dw.catalog.PriceBook](dw.catalog.PriceBook.md)
-
-Represents a price book.
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [ID](#id): [String](TopLevel.String.md) `(read-only)` | Returns the ID of the price book. |
-| [currencyCode](#currencycode): [String](TopLevel.String.md) `(read-only)` | Returns the currency code of the price book. |
-| [description](#description): [String](TopLevel.String.md) `(read-only)` | Returns the description of the price book. |
-| [displayName](#displayname): [String](TopLevel.String.md) `(read-only)` | Returns the display name of the price book. |
-| [online](#online): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns the online status of the price book. |
-| [onlineFlag](#onlineflag): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns the online status flag of the price book. |
-| [onlineFrom](#onlinefrom): [Date](TopLevel.Date.md) `(read-only)` | Returns the date from which the price book is online or valid. |
-| [onlineTo](#onlineto): [Date](TopLevel.Date.md) `(read-only)` | Returns the date until which the price book is online or valid. |
-| [parentPriceBook](#parentpricebook): [PriceBook](dw.catalog.PriceBook.md) `(read-only)` | Returns the parent price book. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getCurrencyCode](dw.catalog.PriceBook.md#getcurrencycode)() | Returns the currency code of the price book. |
-| [getDescription](dw.catalog.PriceBook.md#getdescription)() | Returns the description of the price book. |
-| [getDisplayName](dw.catalog.PriceBook.md#getdisplayname)() | Returns the display name of the price book. |
-| [getID](dw.catalog.PriceBook.md#getid)() | Returns the ID of the price book. |
-| [getOnlineFlag](dw.catalog.PriceBook.md#getonlineflag)() | Returns the online status flag of the price book. |
-| [getOnlineFrom](dw.catalog.PriceBook.md#getonlinefrom)() | Returns the date from which the price book is online or valid. |
-| [getOnlineTo](dw.catalog.PriceBook.md#getonlineto)() | Returns the date until which the price book is online or valid. |
-| [getParentPriceBook](dw.catalog.PriceBook.md#getparentpricebook)() | Returns the parent price book. |
-| [isOnline](dw.catalog.PriceBook.md#isonline)() | Returns the online status of the price book. |
-
-### 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 ID of the price book.
-
-
----
-
-### currencyCode
-- currencyCode: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the currency code of the price book.
-
-
----
-
-### description
-- description: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the description of the price book.
-
-
----
-
-### displayName
-- displayName: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the display name of the price book.
-
-
----
-
-### online
-- online: [Boolean](TopLevel.Boolean.md) `(read-only)`
-  - : Returns the online status of the price book. The online status
-      is calculated from the online status flag and the onlineFrom
-      onlineTo dates defined for the price book.
-
-
-
----
-
-### onlineFlag
-- onlineFlag: [Boolean](TopLevel.Boolean.md) `(read-only)`
-  - : Returns the online status flag of the price book.
-
-
----
-
-### onlineFrom
-- onlineFrom: [Date](TopLevel.Date.md) `(read-only)`
-  - : Returns the date from which the price book is online or valid.
-
-
----
-
-### onlineTo
-- onlineTo: [Date](TopLevel.Date.md) `(read-only)`
-  - : Returns the date until which the price book is online or valid.
-
-
----
-
-### parentPriceBook
-- parentPriceBook: [PriceBook](dw.catalog.PriceBook.md) `(read-only)`
-  - : Returns the parent price book.
-
-
----
-
-## Method Details
-
-### getCurrencyCode()
-- getCurrencyCode(): [String](TopLevel.String.md)
-  - : Returns the currency code of the price book.
-
-    **Returns:**
-    - Currency code of the price book
-
-
----
-
-### getDescription()
-- getDescription(): [String](TopLevel.String.md)
-  - : Returns the description of the price book.
-
-    **Returns:**
-    - Currency code of the price book
-
-
----
-
-### getDisplayName()
-- getDisplayName(): [String](TopLevel.String.md)
-  - : Returns the display name of the price book.
-
-    **Returns:**
-    - Display name of the price book
-
-
----
-
-### getID()
-- getID(): [String](TopLevel.String.md)
-  - : Returns the ID of the price book.
-
-    **Returns:**
-    - ID of the price book
-
-
----
-
-### getOnlineFlag()
-- getOnlineFlag(): [Boolean](TopLevel.Boolean.md)
-  - : Returns the online status flag of the price book.
-
-    **Returns:**
-    - the online status flag of the price book.
-
-
----
-
-### getOnlineFrom()
-- getOnlineFrom(): [Date](TopLevel.Date.md)
-  - : Returns the date from which the price book is online or valid.
-
-    **Returns:**
-    - the date from which the price book is online or valid.
-
-
----
-
-### getOnlineTo()
-- getOnlineTo(): [Date](TopLevel.Date.md)
-  - : Returns the date until which the price book is online or valid.
-
-    **Returns:**
-    - the date until which the price book is online or valid.
-
-
----
-
-### getParentPriceBook()
-- getParentPriceBook(): [PriceBook](dw.catalog.PriceBook.md)
-  - : Returns the parent price book.
-
-    **Returns:**
-    - Parent price book
-
-
----
-
-### isOnline()
-- isOnline(): [Boolean](TopLevel.Boolean.md)
-  - : Returns the online status of the price book. The online status
-      is calculated from the online status flag and the onlineFrom
-      onlineTo dates defined for the price book.
-
-
-    **Returns:**
-    - The online status of the price book.
-
-
----
-
-<!-- prettier-ignore-end -->