@salesforce/b2c-tooling-sdk 1.19.0 → 1.20.0

package/data/script-api/dw.customer.Wallet.md

@@ -1,136 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class Wallet
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.customer.Wallet](dw.customer.Wallet.md)
-
-Represents a set of payment instruments associated with a registered customer.
-
-
-**Note:** this class allows access to sensitive personal and private
-information. Pay attention to appropriate legal and regulatory requirements
-when developing.
-
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [defaultPaymentInstrument](#defaultpaymentinstrument): [CustomerPaymentInstrument](dw.customer.CustomerPaymentInstrument.md) `(read-only)` | Returns the default payment instrument associated with the related customer. |
-| [paymentInstruments](#paymentinstruments): [Collection](dw.util.Collection.md) `(read-only)` | Returns a collection of all payment instruments associated with the  related customer. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [createPaymentInstrument](dw.customer.Wallet.md#createpaymentinstrumentstring)([String](TopLevel.String.md)) | Creates a new, empty payment instrument object associated with the  related customer for the given payment method. |
-| [getDefaultPaymentInstrument](dw.customer.Wallet.md#getdefaultpaymentinstrument)() | Returns the default payment instrument associated with the related customer. |
-| [getPaymentInstruments](dw.customer.Wallet.md#getpaymentinstruments)() | Returns a collection of all payment instruments associated with the  related customer. |
-| [getPaymentInstruments](dw.customer.Wallet.md#getpaymentinstrumentsstring)([String](TopLevel.String.md)) | Returns a collection of all payment instruments associated with the  related customer filtered by the given payment method id. |
-| [removePaymentInstrument](dw.customer.Wallet.md#removepaymentinstrumentcustomerpaymentinstrument)([CustomerPaymentInstrument](dw.customer.CustomerPaymentInstrument.md)) | Removes a payment instrument associated with the customer. |
-
-### 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
-
-### defaultPaymentInstrument
-- defaultPaymentInstrument: [CustomerPaymentInstrument](dw.customer.CustomerPaymentInstrument.md) `(read-only)`
-  - : Returns the default payment instrument associated with the related customer. If not available, returns the first
-      payment instrument or null if no payment instruments are associated with the customer.
-
-
-
----
-
-### paymentInstruments
-- paymentInstruments: [Collection](dw.util.Collection.md) `(read-only)`
-  - : Returns a collection of all payment instruments associated with the
-      related customer.
-
-
-
----
-
-## Method Details
-
-### createPaymentInstrument(String)
-- createPaymentInstrument(paymentMethodId: [String](TopLevel.String.md)): [CustomerPaymentInstrument](dw.customer.CustomerPaymentInstrument.md)
-  - : Creates a new, empty payment instrument object associated with the
-      related customer for the given payment method.
-
-
-    **Parameters:**
-    - paymentMethodId - the id of a payment method
-
-    **Returns:**
-    - the new payment instrument object.
-
-    **Throws:**
-    - NullArgumentException - If passed 'paymentMethodId' is null.
-
-
----
-
-### getDefaultPaymentInstrument()
-- getDefaultPaymentInstrument(): [CustomerPaymentInstrument](dw.customer.CustomerPaymentInstrument.md)
-  - : Returns the default payment instrument associated with the related customer. If not available, returns the first
-      payment instrument or null if no payment instruments are associated with the customer.
-
-
-    **Returns:**
-    - The default payment instrument object.
-
-
----
-
-### getPaymentInstruments()
-- getPaymentInstruments(): [Collection](dw.util.Collection.md)
-  - : Returns a collection of all payment instruments associated with the
-      related customer.
-
-
-    **Returns:**
-    - Collection of all payment instruments.
-
-
----
-
-### getPaymentInstruments(String)
-- getPaymentInstruments(paymentMethodID: [String](TopLevel.String.md)): [Collection](dw.util.Collection.md)
-  - : Returns a collection of all payment instruments associated with the
-      related customer filtered by the given payment method id. If
-      `null` is passed as payment method id all payment instruments
-      of the customer will be retrieved. If for the given payment method id no
-      payment instrument is associated with the customer an empty collection
-      will be returned.
-
-
-    **Parameters:**
-    - paymentMethodID - the paymentMethodID the payment method id to filter for
-
-    **Returns:**
-    - Collection of payment instruments for a payment method.
-
-
----
-
-### removePaymentInstrument(CustomerPaymentInstrument)
-- removePaymentInstrument(instrument: [CustomerPaymentInstrument](dw.customer.CustomerPaymentInstrument.md)): void
-  - : Removes a payment instrument associated with the customer.
-
-    **Parameters:**
-    - instrument - the instrument associated with this customer
-
-    **Throws:**
-    - NullArgumentException - If passed 'instrument' is null.
-    - IllegalArgumentException - If passed 'instrument' belongs to an other customer
-
-
----
-
-<!-- prettier-ignore-end -->

package/data/script-api/dw.customer.consent.ConsentStatusEntry.md

@@ -1,92 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class ConsentStatusEntry
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.customer.consent.ConsentStatusEntry](dw.customer.consent.ConsentStatusEntry.md)
-
-Represents the consent status for a specific channel and contact point.
-
-
-This class provides information about the shopper's consent status (OPT\_IN, OPT\_OUT)
-for a particular marketing communication channel.
-
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [channel](#channel): [String](TopLevel.String.md) `(read-only)` | Returns the channel type for this consent status entry. |
-| [contactPointValue](#contactpointvalue): [String](TopLevel.String.md) `(read-only)` | Returns the contact point value (email address or phone number) for this consent entry. |
-| [status](#status): [String](TopLevel.String.md) `(read-only)` | Returns the consent status. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getChannel](dw.customer.consent.ConsentStatusEntry.md#getchannel)() | Returns the channel type for this consent status entry. |
-| [getContactPointValue](dw.customer.consent.ConsentStatusEntry.md#getcontactpointvalue)() | Returns the contact point value (email address or phone number) for this consent entry. |
-| [getStatus](dw.customer.consent.ConsentStatusEntry.md#getstatus)() | Returns the consent status. |
-
-### 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
-
-### channel
-- channel: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the channel type for this consent status entry.
-
-
----
-
-### contactPointValue
-- contactPointValue: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the contact point value (email address or phone number) for this consent entry.
-
-
----
-
-### status
-- status: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the consent status.
-
-
----
-
-## Method Details
-
-### getChannel()
-- getChannel(): [String](TopLevel.String.md)
-  - : Returns the channel type for this consent status entry.
-
-    **Returns:**
-    - The channel type (e.g., "EMAIL", "SMS", "WHATSAPP").
-
-
----
-
-### getContactPointValue()
-- getContactPointValue(): [String](TopLevel.String.md)
-  - : Returns the contact point value (email address or phone number) for this consent entry.
-
-    **Returns:**
-    - The contact point value.
-
-
----
-
-### getStatus()
-- getStatus(): [String](TopLevel.String.md)
-  - : Returns the consent status.
-
-    **Returns:**
-    - The consent status (e.g., "OPT\_IN", "OPT\_OUT").
-
-
----
-
-<!-- prettier-ignore-end -->

package/data/script-api/dw.customer.consent.MarketingConsentSubscription.md

@@ -1,247 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class MarketingConsentSubscription
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.customer.consent.MarketingConsentSubscription](dw.customer.consent.MarketingConsentSubscription.md)
-
-Represents a marketing consent subscription for a shopper.
-
-
-A marketing consent subscription defines a communication preference category (e.g., "Newsletter", "Product Updates")
-with associated channels (EMAIL, SMS, WHATSAPP) through which the shopper can receive marketing communications.
-
-
-
-
-Example usage:
-
-
-```
-
-var subscriptions = dw.customer.consent.ShopperConsentMgr.getSubscriptions();
-for each (var sub in subscriptions) {
-    trace('Subscription: ' + sub.subscriptionId + ' - ' + sub.title);
-    trace('Channels: ' + sub.channels);
-}
-```
-
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [channels](#channels): [String\[\]](TopLevel.String.md) `(read-only)` | Returns the available channels for this subscription. |
-| [consentRequired](#consentrequired): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns whether consent is required for this subscription. |
-| [consentStatus](#consentstatus): [Collection](dw.util.Collection.md) `(read-only)` | Returns the consent status entries for this subscription. |
-| [consentType](#consenttype): [String](TopLevel.String.md) `(read-only)` | Returns the consent type for this subscription. |
-| [defaultStatus](#defaultstatus): [String](TopLevel.String.md) `(read-only)` | Returns the default consent status for this subscription. |
-| [subscriptionId](#subscriptionid): [String](TopLevel.String.md) `(read-only)` | Returns the unique identifier for this subscription. |
-| [subtitle](#subtitle): [String](TopLevel.String.md) `(read-only)` | Returns the localized subtitle of this subscription. |
-| [tags](#tags): [String\[\]](TopLevel.String.md) `(read-only)` | Returns the tags associated with this subscription. |
-| [title](#title): [String](TopLevel.String.md) `(read-only)` | Returns the localized title of this subscription. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getChannels](dw.customer.consent.MarketingConsentSubscription.md#getchannels)() | Returns the available channels for this subscription. |
-| [getConsentRequired](dw.customer.consent.MarketingConsentSubscription.md#getconsentrequired)() | Returns whether consent is required for this subscription. |
-| [getConsentStatus](dw.customer.consent.MarketingConsentSubscription.md#getconsentstatus)() | Returns the consent status entries for this subscription. |
-| [getConsentType](dw.customer.consent.MarketingConsentSubscription.md#getconsenttype)() | Returns the consent type for this subscription. |
-| [getDefaultStatus](dw.customer.consent.MarketingConsentSubscription.md#getdefaultstatus)() | Returns the default consent status for this subscription. |
-| [getSubscriptionId](dw.customer.consent.MarketingConsentSubscription.md#getsubscriptionid)() | Returns the unique identifier for this subscription. |
-| [getSubtitle](dw.customer.consent.MarketingConsentSubscription.md#getsubtitle)() | Returns the localized subtitle of this subscription. |
-| [getTags](dw.customer.consent.MarketingConsentSubscription.md#gettags)() | Returns the tags associated with this subscription. |
-| [getTitle](dw.customer.consent.MarketingConsentSubscription.md#gettitle)() | Returns the localized title of this subscription. |
-
-### 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
-
-### channels
-- channels: [String\[\]](TopLevel.String.md) `(read-only)`
-  - : Returns the available channels for this subscription.
-      
-      
-      Channels represent the communication methods (EMAIL, SMS, WHATSAPP) available for this subscription.
-
-
-
----
-
-### consentRequired
-- consentRequired: [Boolean](TopLevel.Boolean.md) `(read-only)`
-  - : Returns whether consent is required for this subscription.
-
-
----
-
-### consentStatus
-- consentStatus: [Collection](dw.util.Collection.md) `(read-only)`
-  - : Returns the consent status entries for this subscription.
-      
-      
-      This is only populated when the 'includeConsentStatus' parameter is true in the getSubscriptions call, and the
-      customer is authenticated.
-
-
-
----
-
-### consentType
-- consentType: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the consent type for this subscription.
-
-
----
-
-### defaultStatus
-- defaultStatus: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the default consent status for this subscription.
-
-
----
-
-### subscriptionId
-- subscriptionId: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the unique identifier for this subscription.
-
-
----
-
-### subtitle
-- subtitle: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the localized subtitle of this subscription.
-
-
----
-
-### tags
-- tags: [String\[\]](TopLevel.String.md) `(read-only)`
-  - : Returns the tags associated with this subscription.
-      
-      
-      Tags can be used to categorize and filter subscriptions.
-
-
-
----
-
-### title
-- title: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the localized title of this subscription.
-
-
----
-
-## Method Details
-
-### getChannels()
-- getChannels(): [String\[\]](TopLevel.String.md)
-  - : Returns the available channels for this subscription.
-      
-      
-      Channels represent the communication methods (EMAIL, SMS, WHATSAPP) available for this subscription.
-
-
-    **Returns:**
-    - A list of channel strings (lowercase).
-
-
----
-
-### getConsentRequired()
-- getConsentRequired(): [Boolean](TopLevel.Boolean.md)
-  - : Returns whether consent is required for this subscription.
-
-    **Returns:**
-    - True if consent is required, false otherwise.
-
-
----
-
-### getConsentStatus()
-- getConsentStatus(): [Collection](dw.util.Collection.md)
-  - : Returns the consent status entries for this subscription.
-      
-      
-      This is only populated when the 'includeConsentStatus' parameter is true in the getSubscriptions call, and the
-      customer is authenticated.
-
-
-    **Returns:**
-    - A collection of ConsentStatusEntry objects, or null if not requested.
-
-
----
-
-### getConsentType()
-- getConsentType(): [String](TopLevel.String.md)
-  - : Returns the consent type for this subscription.
-
-    **Returns:**
-    - The consent type (e.g., "SINGLE\_OPT\_IN", "DOUBLE\_OPT\_IN").
-
-
----
-
-### getDefaultStatus()
-- getDefaultStatus(): [String](TopLevel.String.md)
-  - : Returns the default consent status for this subscription.
-
-    **Returns:**
-    - The default status (e.g., "OPT\_IN", "OPT\_OUT").
-
-
----
-
-### getSubscriptionId()
-- getSubscriptionId(): [String](TopLevel.String.md)
-  - : Returns the unique identifier for this subscription.
-
-    **Returns:**
-    - The subscription ID.
-
-
----
-
-### getSubtitle()
-- getSubtitle(): [String](TopLevel.String.md)
-  - : Returns the localized subtitle of this subscription.
-
-    **Returns:**
-    - The subscription subtitle.
-
-
----
-
-### getTags()
-- getTags(): [String\[\]](TopLevel.String.md)
-  - : Returns the tags associated with this subscription.
-      
-      
-      Tags can be used to categorize and filter subscriptions.
-
-
-    **Returns:**
-    - A list of tag strings.
-
-
----
-
-### getTitle()
-- getTitle(): [String](TopLevel.String.md)
-  - : Returns the localized title of this subscription.
-
-    **Returns:**
-    - The subscription title.
-
-
----
-
-<!-- prettier-ignore-end -->

package/data/script-api/dw.customer.consent.ShopperConsentErrorCodes.md

@@ -1,74 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class ShopperConsentErrorCodes
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.customer.consent.ShopperConsentErrorCodes](dw.customer.consent.ShopperConsentErrorCodes.md)
-
-Error codes for [ShopperConsentException](dw.customer.consent.ShopperConsentException.md).
-
-
-These error codes indicate the reason why a shopper consent operation failed.
-
-
-
-## Constant Summary
-
-| Constant | Description |
-| --- | --- |
-| [CUSTOMER_NOT_AUTHENTICATED](#customer_not_authenticated): [String](TopLevel.String.md) = "CUSTOMER_NOT_AUTHENTICATED" | Indicates that the customer is not authenticated. |
-| [FEATURE_DISABLED](#feature_disabled): [String](TopLevel.String.md) = "FEATURE_DISABLED" | Indicates that the Marketing Consent feature is not enabled. |
-| [INTERNAL_ERROR](#internal_error): [String](TopLevel.String.md) = "INTERNAL_ERROR" | Indicates that an internal error occurred. |
-| [RETRIEVAL_ERROR](#retrieval_error): [String](TopLevel.String.md) = "RETRIEVAL_ERROR" | Indicates that an error occurred while retrieving consent subscriptions. |
-| [UPDATE_ERROR](#update_error): [String](TopLevel.String.md) = "UPDATE_ERROR" | Indicates that an error occurred while updating consent subscriptions. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-### 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
-
-### CUSTOMER_NOT_AUTHENTICATED
-
-- CUSTOMER_NOT_AUTHENTICATED: [String](TopLevel.String.md) = "CUSTOMER_NOT_AUTHENTICATED"
-  - : Indicates that the customer is not authenticated.
-
-
----
-
-### FEATURE_DISABLED
-
-- FEATURE_DISABLED: [String](TopLevel.String.md) = "FEATURE_DISABLED"
-  - : Indicates that the Marketing Consent feature is not enabled.
-
-
----
-
-### INTERNAL_ERROR
-
-- INTERNAL_ERROR: [String](TopLevel.String.md) = "INTERNAL_ERROR"
-  - : Indicates that an internal error occurred.
-
-
----
-
-### RETRIEVAL_ERROR
-
-- RETRIEVAL_ERROR: [String](TopLevel.String.md) = "RETRIEVAL_ERROR"
-  - : Indicates that an error occurred while retrieving consent subscriptions.
-
-
----
-
-### UPDATE_ERROR
-
-- UPDATE_ERROR: [String](TopLevel.String.md) = "UPDATE_ERROR"
-  - : Indicates that an error occurred while updating consent subscriptions.
-
-
----
-
-<!-- prettier-ignore-end -->

package/data/script-api/dw.customer.consent.ShopperConsentException.md

@@ -1,63 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class ShopperConsentException
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.customer.consent.ShopperConsentException](dw.customer.consent.ShopperConsentException.md)
-
-This exception is thrown by [ShopperConsentMgr](dw.customer.consent.ShopperConsentMgr.md) methods when an error occurs
-during consent subscription operations.
-
-
-The 'errorCode' property is set to one of the following values:
-
-- [ShopperConsentErrorCodes.FEATURE_DISABLED](dw.customer.consent.ShopperConsentErrorCodes.md#feature_disabled)- Indicates that the Marketing Consent  feature is not enabled.
-- [ShopperConsentErrorCodes.RETRIEVAL_ERROR](dw.customer.consent.ShopperConsentErrorCodes.md#retrieval_error)- Indicates that an error occurred while  retrieving consent subscriptions.
-- [ShopperConsentErrorCodes.UPDATE_ERROR](dw.customer.consent.ShopperConsentErrorCodes.md#update_error)- Indicates that an error occurred while  updating consent subscriptions.
-- [ShopperConsentErrorCodes.CUSTOMER_NOT_AUTHENTICATED](dw.customer.consent.ShopperConsentErrorCodes.md#customer_not_authenticated)- Indicates that the customer  is not authenticated (required for consent status retrieval).
-- [ShopperConsentErrorCodes.INTERNAL_ERROR](dw.customer.consent.ShopperConsentErrorCodes.md#internal_error)- Indicates that an internal error occurred.
-
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [errorCode](#errorcode): [String](TopLevel.String.md) `(read-only)` | Returns the error code indicating the reason for the failure. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getErrorCode](dw.customer.consent.ShopperConsentException.md#geterrorcode)() | Returns the error code indicating the reason for the failure. |
-
-### Methods inherited from class Error
-
-[captureStackTrace](TopLevel.Error.md#capturestacktraceerror-function), [toString](TopLevel.Error.md#tostring)
-### 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
-
-### errorCode
-- errorCode: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the error code indicating the reason for the failure.
-
-
----
-
-## Method Details
-
-### getErrorCode()
-- getErrorCode(): [String](TopLevel.String.md)
-  - : Returns the error code indicating the reason for the failure.
-
-    **Returns:**
-    - The error code.
-
-
----
-
-<!-- prettier-ignore-end -->