@salesforce/b2c-tooling-sdk 1.16.0 → 1.17.0

package/data/job-steps/job-steps.md

@@ -0,0 +1,96 @@
+<!-- prettier-ignore-start -->
+# Standard Job Step Catalog
+
+Catalog of built-in (standard / system) job step **type IDs** that the B2C Commerce platform ships for use in Business Manager job flows and `jobs.xml` site-import flows. Each step below has its own page with purpose and configuration parameters — read it with `b2c docs read <TypeID>` (for example `b2c docs read ImportCatalog`).
+
+These are the standard counterparts to authoring your own steps (see the `b2c:b2c-custom-job-steps` skill) and to the CLI import/export commands (see the `b2c-cli:b2c-job` skill).
+
+## Import Steps
+
+| Type ID | Scope | Purpose |
+| --- | --- | --- |
+| `ImportABTests` | Site | Imports A/B tests. |
+| `ImportActiveData` | Site | Imports active data from the provided CSV files. |
+| `ImportAssignments` | Organization | Imports assignments |
+| `ImportCatalog` | Organization | Imports catalog data. |
+| `ImportContent` | Site | Imports content. If no library-id is specified in the import file, the data is imported into the private library of the... |
+| `ImportContentSlots` | Site | Imports content slot configurations in the specified mode. |
+| `ImportCouponCodeRedemptions` | Site | Imports the coupon code redemptions based on the couponredemption.xsd. Note: Coupon redemptions are evaluated during... |
+| `ImportCoupons` | Site | Imports coupons in the specified mode. |
+| `ImportCustomerGroups` | Site | Imports customer groups in the specified mode. |
+| `ImportCustomerList` | Organization | Deprecated. Imports customer list data. Use ImportCustomerLists instead. |
+| `ImportCustomerLists` | Organization | Imports customer lists. |
+| `ImportCustomers` | Site | Imports Customers based on customer.xsd |
+| `ImportCustomObjects` | Organization & Sites | Imports Custom Objects. |
+| `ImportGiftCertificates` | Site | Import the Gift Certificates contained in ImportFile in the specified mode. |
+| `ImportInventoryLists` | Organization | Imports inventory data. |
+| `ImportKeyValueMapping` | Organization | Import or delete a key/value mapping in the Generic Mapping high-performance data store. Key/value mappings are exposed... |
+| `ImportPageLocalization` | Site | Import translated page content for localization purposes |
+| `ImportPriceBook` | Organization | Imports price data. |
+| `ImportProductLists` | Site | Imports product lists. |
+| `ImportPromotions` | Site | Imports promotions in the specified mode. |
+| `ImportShippingMethods` | Site | Imports shipping methods in the specified mode. |
+| `ImportSiteArchive` | Organization | Imports a site import archive file into the current instance. |
+| `ImportSourceCodeGroups` | Site | Imports source code groups in the specified mode. |
+| `ImportStores` | Site | Imports Stores based on store.xsd |
+| `ImportTaxTable` | Site | Imports Tax Classes, Tax Jurisdictions and Tax Rates from the given ImportFile in the specified mode. |
+
+## Export Steps
+
+| Type ID | Scope | Purpose |
+| --- | --- | --- |
+| `CatalogDeltaExport` | Site | Creates Delta Export for Catalogs. Support must be contacted to enable delta exports. |
+| `CustomerListsDeltaExport` | Site | Creates Delta Export for Customer Lists. Support must be contacted to enable delta exports. |
+| `ExportABTests` | Site | Exports A/B tests. |
+| `ExportAssignments` | Organization | Exports all assignments in the system. |
+| `ExportCatalog` | Organization | Exports catalog data. |
+| `ExportContent` | Organization & Sites | Exports the folders in the specified content Library. |
+| `ExportContentSlots` | Site | Exports all content slot data. |
+| `ExportCouponCodes` | Site | Exports the codes of a specified coupon. |
+| `ExportCoupons` | Site | Exports coupons. |
+| `ExportCustomerGroups` | Site | Exports all customer groups. |
+| `ExportCustomerList` | Organization | Exports a customer list, it's preferences as well as the customers assigned to the customer list. |
+| `ExportCustomers` | Site | Exports the customer profiles from the default customer list of the given site. |
+| `ExportCustomObjects` | Organization & Sites | Exports custom objects of a specified type and scope. The scope of the job flow (Organization or Sites) must match the... |
+| `ExportFacebookFeed` | Site | Exports Catalog Feed for Facebook. |
+| `ExportGiftCertificates` | Site | Exports Gift Certificates. |
+| `ExportInventoryLists` | Site | Exports inventory lists. |
+| `ExportMetaData` | Organization | Export System Object Type extensions and Custom Object Type definitions. |
+| `ExportOrders` | Site | Exports all orders matching the selected criteria using Search Service, with a maximum of 1000 orders per run. After an... |
+| `ExportPageLocalization` | Site | Export page content for localization purposes |
+| `ExportPriceBook` | Organization | Exports price data. |
+| `ExportProductLists` | Site | Exports product lists of a site. If all the options are selected, all product lists that were created by anonymous or... |
+| `ExportPromotions` | Site | Exports promotions. |
+| `ExportShippingMethods` | Site | Exports shipping methods. |
+| `ExportSourceCodeGroups` | Site | Exports source code groups. |
+| `ExportStores` | Site | Exports stores. |
+| `ExportTaxTable` | Site | Exports tax data. |
+| `LibraryDeltaExport` | Organization | Creates Delta Export for Libraries. Support must be contacted to enable delta exports. |
+| `SiteExport` | Organization | Exports site data. The DataUnits parameter defines which objects are included in the export. Its function is similar to... |
+
+## Processing Steps
+
+| Type ID | Scope | Purpose |
+| --- | --- | --- |
+| `CreateSitemap` | Site | Creates Sitemap. |
+| `DownloadActiveDataFromStorage` | Site | Download active data from storage system to current site. This step downloads active data to the new site from storage... |
+| `ExecuteCategorizationRules` | Organization | Executes the Categorization based on the Categorization Rules and Conditions defined on a CatalogCategory. |
+| `ExecuteDataReplication` | Organization | Replicates data to a target system. The ReplicationConfiguration parameter requires a string in JSON format that... |
+| `ExecutePipeline` | Organization & Sites | Executes a pipeline. The name and start node of the pipeline has to be configured at parameter... |
+| `ExecutePreconfiguredCodeReplicationProcess` | Organization | Executes the preconfigured code replication process with the ID defined at parameter 'ReplicationProcessID'. The code... |
+| `ExecutePreconfiguredDataReplicationProcess` | Organization | Executes the preconfigured data replication process with the ID defined at parameter 'ReplicationProcessID'. The data... |
+| `ExecuteScriptModule` | Organization & Sites | Executes a function exported by a script module. The module ID has to be configured at parameter... |
+| `IncludeStepsFromJob` | Organization & Sites | Includes steps from another job. This step makes it easy to create a set of standard steps that you can execute in... |
+| `InvalidateCache` | Site | Invalidate Page and Static Content Cache Invalidates the page cache and/or static content cache (images, styles, etc.)... |
+| `SearchReindex` | Site | Rebuilds or updates search indexes. The number of search indexes that can be rebuilt or updated in parallel is globally... |
+| `UndoPreconfiguredCodeReplicationProcess` | Organization | Undo the preconfigured code replication process with the ID defined at parameter 'ReplicationProcessID'. The given code... |
+| `UndoPreconfiguredDataReplicationProcess` | Organization | Undo the preconfigured data replication process with the ID defined at parameter 'ReplicationProcessID'. The given data... |
+| `UpdateStorefrontURLs` | Site | Updates the Storefront URLs for objects like categories, products, folders and content assets. This will update the... |
+| `UploadActiveDataBackupToStorage` | Site | Upload current site's active data to storage system (as a backup). This step uploads active data as a backup to storage... |
+| `UploadActiveDataToStorage` | Site | Upload current site's active data to storage system. This step uploads active data from an old site to storage system... |
+
+## Provenance
+
+Generated from the public B2C Commerce Job Step API documentation (the jobstepapi section of the Script API documentation archive obtained via `b2c docs download`). Each step lists its purpose, execution scope, and input parameters (required, description, allowed values, default) as published in that documentation.
+
+<!-- prettier-ignore-end -->

package/data/script-api/TopLevel.APIException.md

@@ -23,7 +23,7 @@ access to some more details about this internal Java exception.
 
 
 ## All Known Subclasses
-[AspectAttributeValidationException](dw.experience.AspectAttributeValidationException.md), [CreateAgentBasketLimitExceededException](dw.order.CreateAgentBasketLimitExceededException.md), [CreateBasketFromOrderException](dw.order.CreateBasketFromOrderException.md), [CreateCouponLineItemException](dw.order.CreateCouponLineItemException.md), [CreateOrderException](dw.order.CreateOrderException.md), [CreateTemporaryBasketLimitExceededException](dw.order.CreateTemporaryBasketLimitExceededException.md), [ShopperContextException](dw.customer.shoppercontext.ShopperContextException.md)
+[AspectAttributeValidationException](dw.experience.AspectAttributeValidationException.md), [CreateAgentBasketLimitExceededException](dw.order.CreateAgentBasketLimitExceededException.md), [CreateBasketFromOrderException](dw.order.CreateBasketFromOrderException.md), [CreateCouponLineItemException](dw.order.CreateCouponLineItemException.md), [CreateOrderException](dw.order.CreateOrderException.md), [CreateTemporaryBasketLimitExceededException](dw.order.CreateTemporaryBasketLimitExceededException.md), [ShopperConsentException](dw.customer.consent.ShopperConsentException.md), [ShopperContextException](dw.customer.shoppercontext.ShopperContextException.md)
 ## Property Summary
 
 | Property | Description |

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

@@ -44,7 +44,10 @@ This class does not have a constructor, so you cannot create it directly.
 
 ### sortingOptions
 - sortingOptions: [List](dw.util.List.md) `(read-only)`
-  - : Returns a list containing the sorting options configured for this site.
+  - : Returns a list containing the sorting options configured for this site. On a Cimulate-enabled site, restricts
+      the result to the Cimulate-managed rule IDs so the storefront "Sort by" dropdown matches what the buyer
+      actually gets back from Cimulate.
+
 
 
 ---
@@ -119,7 +122,10 @@ This class does not have a constructor, so you cannot create it directly.
 
 ### getSortingOptions()
 - static getSortingOptions(): [List](dw.util.List.md)
-  - : Returns a list containing the sorting options configured for this site.
+  - : Returns a list containing the sorting options configured for this site. On a Cimulate-enabled site, restricts
+      the result to the Cimulate-managed rule IDs so the storefront "Sort by" dropdown matches what the buyer
+      actually gets back from Cimulate.
+
 
     **Returns:**
     - a list of SortingOption objects

package/data/script-api/dw.crypto.Cipher.md

@@ -1213,7 +1213,11 @@ Does not use a default initialization vector.
     - message - A string to encrypt (will be first converted with UTF-8 encoding           into a byte stream)
     - key - A string ready for use with the algorithm.           The key's format depends on the algorithm specified and the           keys are assumed to be correctly formulated for the algorithm           used, for example that the lengths are correct.           Keys are _not_ checked for validity.            The cryptographic algorithms can be partitioned into _symmetric_           and _asymmetric_ (or public key/private key). Symmetric algorithms           include _password-based_ algorithms.           Symmetric keys are usually a base64-encoded array of bytes.           Asymmetric keys are "key pairs" with a public key and a private key.           To encrypt using asymmetric algorithms, provide the public key.           To decrypt using asymmetric algorithms, provide the private key from           the same pair in PKCS\#8 format, base64-encoded.           See class documentation on how to generate a key pair.           If the cryptographic algorithm is _symmetric_           (for example, AES)           or _asymmetric_ (for example, RSA), the key needs to be passed as a           base64-encoded string. The only exception is the _symmetric_ cryptographic           algorithms _Password Based Encryption_ (PBE). With PBE the key needs           to be passed as plain string (_without_ any encoding).
     - transformation - The transformation has to be in _"algorithm/mode/padding"_ format.           Symmetric or "secret key" algorithms use the same key to encrypt           and to decrypt the data. Asymmetric or "public key" cryptography           uses a public/private key pair, and then publishes the public key.           Only the holder of the private key will be able to decrypt.           The public key and private key are also known as a "key pair".            Supported Symmetric transformations include:                       <li>"AES" or Rijndael, Advanced Encryption Standard as specified by NIST           **AES with key length of 256 is the preferred choice for symmetric encryption**           Keysizes: 128, 192, or 256           Modes: "GCM","ECB","CBC","PCBC","CTR","CTS","CFB","CFB8","CFB16","CFB24".."CFB64", "OFB","OFB8","OFB16","OFB24".."OFB64"           Padding: "PKCS5Padding" or "NoPadding" (GCM only)           </li>           </ul>            Note that ARCFOUR, Blowfish, DES, RC2, DESede, DESedeWrap, PBEWithMD5AndDES, PBEWithMD5AndTripleDES1,           PBEWithSHA1AndDESede and PBEWithSHA1AndRC2\_40 transformations have been deprecated. PKCS5Padding is           the only supported Padding for most modes. NOPADDING is only supported for GCM, and ISO10126PADDING has been deprecated.            Supported Asymmetric transformations include:                       <li>"RSA"           Mode: "ECB"           Padding: "OAEPWITHSHA-256ANDMGF1PADDING", "OAEPWITHSHA-384ANDMGF1PADDING", "OAEPWITHSHA-512ANDMGF1PADDING"           </li>           </ul>            Note that for RSA the key length should be at least 2048 bits. Also, the following Padding options have           been deprecated: NOPADDING, PKCS1PADDING, OAEPWITHMD5ANDMGF1PADDING, OAEPWITHSHA1ANDMGF1PADDING and OAEPWITHSHA-1ANDMGF1PADDING.
-    - saltOrIV - Initialization value appropriate for the algorithm, this might           be a Binary Salt or AlgorithmParameter or InitializationVector.           (As binary values cannot be passed, the equivalent Base64 String           should be passed for any binary salt value).            Should be appropriate for the algorithm being used.           The same value used to Encrypt needs to be supplied to the           Decrypt function for many algorithms to successfully decrypt           the data, so it is best practice to specify an appropriate value.            Requirements for the size and generation of DES initialization           vectors (IV) are derived from FIPS 74 and FIPS 81 from the National           Institute of Standards and Technology. CBC mode requires an IV           with length 64 bits; CFB uses 48-64 bits; OFB uses 64 bits; GCM uses 96 bits.           If the IV is to be used with DES in the OFB mode, then it is not           acceptable for the IV to remain fixed for multiple encryptions,           if the same key is used for those encryptions.            For Block Encryption algorithms this is the encoded Base64           String equivalent to the a random number to use as a "salt"           to use with the algorithm.           The algorithm must contain a Feedback Mode other than ECB.           This must be a binary value that is exactly the same size           as the algorithm block size.           RC5 uses an optional 8-byte initialization vector (IV),           but only in feedback mode (see CFB above).           For Password Based Encryption algorithms, the salt is the encoded           Base64 String equivalent to a random number value to transform the           password into a key. PBE derives an encryption key from a password.           In order to make the task of getting from password to key very           time-consuming for an attacker, most PBE implementations will           mix in a random number, known as a salt, to create the key. The salt           value and the iteration count are then combined into a           PBEParameterSpecification to initialize the cipher.            The PKCS\#5 spec from RSA Labs defines the parameters for           password-based encryption (PBE).           The RSA algorithm requires a salt with length as defined in PKCS\#1.           DSA has a specific initialization that uses three integers to           build a DSAParameterSpec (a prime, a sub-prime and a base).           To use this algorithm you should use the JCE or another           provider to supply a DSAParameterSpec and then supply the           Base64 equivalent string as the "salt". Please see the           documentation from the provider for additional restrictions.           For GCM the base64-encoded initialization vector may be optionally suffixed           with a vertical pipe followed by the number of bits in the tag length. If not           present then the tag length will be 128 bits. This syntax is only supported           for the GCM mode.
+    - saltOrIV - Initialization value appropriate for the algorithm, this might           be a Binary Salt or AlgorithmParameter or InitializationVector.           (As binary values cannot be passed, the equivalent Base64 String           should be passed for any binary salt value).            Should be appropriate for the algorithm being used.           The same value used to Encrypt needs to be supplied to the           Decrypt function for many algorithms to successfully decrypt           the data, so it is best practice to specify an appropriate value.            Requirements for the size and generation of DES initialization           vectors (IV) are derived from FIPS 74 and FIPS 81 from the National           Institute of Standards and Technology. CBC mode requires an IV           with length 64 bits; CFB uses 48-64 bits; OFB uses 64 bits; GCM uses 96 bits.           If the IV is to be used with DES in the OFB mode, then it is not           acceptable for the IV to remain fixed for multiple encryptions,           if the same key is used for those encryptions.            For Block Encryption algorithms this is the encoded Base64           String equivalent to the a random number to use as a "salt"           to use with the algorithm.           The algorithm must contain a Feedback Mode other than ECB.           This must be a binary value that is exactly the same size           as the algorithm block size.           RC5 uses an optional 8-byte initialization vector (IV),           but only in feedback mode (see CFB above).           For Password Based Encryption algorithms, the salt is the encoded           Base64 String equivalent to a random number value to transform the           password into a key. PBE derives an encryption key from a password.           In order to make the task of getting from password to key very           time-consuming for an attacker, most PBE implementations will           mix in a random number, known as a salt, to create the key. The salt           value and the iteration count are then combined into a           PBEParameterSpecification to initialize the cipher.            The PKCS\#5 spec from RSA Labs defines the parameters for           password-based encryption (PBE).           The RSA algorithm requires a salt with length as defined in PKCS\#1.           DSA has a specific initialization that uses three integers to           build a DSAParameterSpec (a prime, a sub-prime and a base).           To use this algorithm you should use the JCE or another           provider to supply a DSAParameterSpec and then supply the           Base64 equivalent string as the "salt". Please see the           documentation from the provider for additional restrictions.           Extra algorithm parameters may be configured using this field. Each parameter is given as           `<name>=<value>`, and multiple parameters may be separated by a vertical           pipe. Unknown parameters will result in an error. Any parameters MUST be given after the salt, even           if the salt is empty. For example, RSA does not use a salt, so to set the MGF1 digest algorithm           to SHA-256, use `|MGFDigest=SHA-256`           Supported Parameters:           | Parameter | Type | Description |
+| --- |--- |--- |
+| `MGFDigest` | `String` | Overrides the digest algorithm used by the mask generation function when using OAEP padding.                   Valid values include SHA-1, SHA-224, SHA-256, SHA-384, and SHA-512. The default value is SHA-1. |
+| `TagLength` | `Integer` | Overrides the tag length in bits used for GCM mode. Note if a number is given                   without a parameter name, it is treated as the tag length for backward compatibility. The                   default tag length is 128 bits. |
+
     - iterations - The number of passes to make when turning a passphrase into a key.           This is only applicable for some types of algorithm.           Password Based Encryption (PBE) algorithms use this parameter,           and Block Encryption algorithms do not.           If this value is relevant to the algorithm it would be best           practice to supply it, as the same value would be needed to           decrypt the data.
 
     **Returns:**

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

@@ -27,6 +27,7 @@ Pay special attention to PCI DSS v3. requirements 2, 4, and 12.
 | [customer](#customer): [Customer](dw.customer.Customer.md) `(read-only)` | Returns the customer object related to this profile. |
 | [customerNo](#customerno): [String](TopLevel.String.md) `(read-only)` | Returns the customer's number, which is a number used to identify the Customer. |
 | [email](#email): [String](TopLevel.String.md) | Returns the customer's email address. |
+| [emailVerified](#emailverified): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns whether the customer's email has been verified. |
 | [fax](#fax): [String](TopLevel.String.md) | Returns the fax number to use for the customer. |
 | [female](#female): [Boolean](TopLevel.Boolean.md) `(read-only)` | Indicates that the customer is female when set to true. |
 | [firstName](#firstname): [String](TopLevel.String.md) | Returns the customer's first name. |
@@ -88,6 +89,7 @@ This class does not have a constructor, so you cannot create it directly.
 | [getTaxIDType](dw.customer.Profile.md#gettaxidtype)() | Returns the tax ID type. |
 | [getTitle](dw.customer.Profile.md#gettitle)() | Returns the customer's title, such as "Mrs" or "Mr". |
 | [getWallet](dw.customer.Profile.md#getwallet)() | Returns the wallet of this customer. |
+| [isEmailVerified](dw.customer.Profile.md#isemailverified)() | Returns whether the customer's email has been verified. |
 | [isFemale](dw.customer.Profile.md#isfemale)() | Indicates that the customer is female when set to true. |
 | [isMale](dw.customer.Profile.md#ismale)() | Indicates that the customer is male when set to true. |
 | [setBirthday](dw.customer.Profile.md#setbirthdaydate)([Date](TopLevel.Date.md)) | Sets the customer's birthday as a date. |
@@ -168,6 +170,26 @@ This class does not have a constructor, so you cannot create it directly.
   - : Returns the customer's email address.
 
 
+---
+
+### emailVerified
+- emailVerified: [Boolean](TopLevel.Boolean.md) `(read-only)`
+  - : Returns whether the customer's email has been verified.
+      
+      
+      This is a read-only field. The field value cannot be set externally and will be set in platform based on
+      following rules:
+      
+      
+      
+      - If the Email Verification Site Preference under LoginPreferences is disabled: the value for this field will  always be NULL;
+      - If the Email Verification Site Preference under LoginPreferences is enabled:  
+        - If the incoming email value is the same as existing email and email was previously verified, the value for    this field will remain unchanged as TRUE;
+        - If the incoming email value is the same as existing email and email was not previously verified, the value    for this field will remain unchanged as FALSE;
+        - If the incoming email value is not the same as existing email, the value for this field will be set to FALSE    no matter the previous state;
+
+
+
 ---
 
 ### fax
@@ -664,6 +686,29 @@ This class does not have a constructor, so you cannot create it directly.
     - the wallet of this customer.
 
 
+---
+
+### isEmailVerified()
+- isEmailVerified(): [Boolean](TopLevel.Boolean.md)
+  - : Returns whether the customer's email has been verified.
+      
+      
+      This is a read-only field. The field value cannot be set externally and will be set in platform based on
+      following rules:
+      
+      
+      
+      - If the Email Verification Site Preference under LoginPreferences is disabled: the value for this field will  always be NULL;
+      - If the Email Verification Site Preference under LoginPreferences is enabled:  
+        - If the incoming email value is the same as existing email and email was previously verified, the value for    this field will remain unchanged as TRUE;
+        - If the incoming email value is the same as existing email and email was not previously verified, the value    for this field will remain unchanged as FALSE;
+        - If the incoming email value is not the same as existing email, the value for this field will be set to FALSE    no matter the previous state;
+
+
+    **Returns:**
+    - true if the email is verified, false if not verified, or null if the verification status has not been set.
+
+
 ---
 
 ### isFemale()

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

@@ -0,0 +1,92 @@
+<!-- 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

@@ -0,0 +1,247 @@
+<!-- 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

@@ -0,0 +1,74 @@
+<!-- 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 -->