sfcc-dev-mcp 1.0.19 → 1.0.21

package/dist/docs/dw_extensions.payments/SalesforcePaymentsZone.md

@@ -0,0 +1,458 @@
+## Package: dw.extensions.payments
+
+# Class SalesforcePaymentsZone
+
+## Inheritance Hierarchy
+
+- Object
+  - dw.extensions.payments.SalesforcePaymentsZone
+
+## Description
+
+Salesforce Payments representation of a payments zone. See Salesforce Payments documentation for how to gain access and configure payment zones and assign them to sites. A payments zone contains information about the payment zone for a site and country.
+
+## Properties
+
+### afterpayClearpayEnabled
+
+**Type:** boolean (Read Only)
+
+Returns true if Afterpay Clearpay presentment is enabled, or false if not.
+
+### applePayEnabled
+
+**Type:** boolean (Read Only)
+
+Returns true if Apple Pay presentment is enabled, or false if not.
+
+### bancontactEnabled
+
+**Type:** boolean (Read Only)
+
+Returns true if Bancontact presentment is enabled, or false if not. Note: For Adyen
+ merchant accounts, this setting refers to the "Bancontact Card" payment method.
+
+### bancontactMobileEnabled
+
+**Type:** boolean (Read Only)
+
+Returns true if Bancontact Mobile presentment is enabled, or false if not. Note: This
+ setting is only applicable for Adyen Merchant Accounts
+
+### cardEnabled
+
+**Type:** boolean (Read Only)
+
+Returns true if credit card presentment is enabled, or false if not.
+
+### epsEnabled
+
+**Type:** boolean (Read Only)
+
+Returns true if EPS presentment is enabled, or false if not.
+
+### idealEnabled
+
+**Type:** boolean (Read Only)
+
+Returns true if iDEAL presentment is enabled, or false if not.
+
+### klarnaEnabled
+
+**Type:** boolean (Read Only)
+
+Returns true if Klarna presentment is enabled, or false if not. Note: For Adyen
+ merchant accounts, this setting applies to the Klarna Pay Later payment method.
+
+### klarnaPayInInstallmentsEnabled
+
+**Type:** boolean (Read Only)
+
+Returns true if Klarna Pay in Installments presentment is enabled, or false if not.
+ Note: This setting is only applicable for Adyen Merchant Accounts.
+
+### klarnaPayNowEnabled
+
+**Type:** boolean (Read Only)
+
+Returns true if Klarna Pay Now presentment is enabled, or false if not. Note: This
+ setting is only applicable for Adyen Merchant Accounts.
+
+### paymentRequestEnabled
+
+**Type:** boolean (Read Only)
+
+Returns true if W3C Payment Request API button presentment is enabled, or false if not.
+
+### payPalEnabled
+
+**Type:** boolean (Read Only)
+
+Returns true if PayPal multi-step checkout presentment is enabled, or false if not.
+
+### payPalExpressEnabled
+
+**Type:** boolean (Read Only)
+
+Returns true if PayPal express checkout presentment is enabled, or false if not.
+
+### sepaDebitEnabled
+
+**Type:** boolean (Read Only)
+
+Returns true if SEPA Debit presentment is enabled, or false if not.
+
+### venmoEnabled
+
+**Type:** boolean (Read Only)
+
+Returns true if Venmo multi-step checkout presentment is enabled, or false if not.
+
+### venmoExpressEnabled
+
+**Type:** boolean (Read Only)
+
+Returns true if Venmo express checkout presentment is enabled, or false if not.
+
+### zoneId
+
+**Type:** String (Read Only)
+
+The id of the payments zone.
+
+## Constructor Summary
+
+## Method Summary
+
+### getPaymentMethods
+
+**Signature:** `getPaymentMethods(countryCode : String, amount : Money) : Collection`
+
+Returns a collection containing the merchant account payment methods to be presented for this payments zone.
+
+### getZoneId
+
+**Signature:** `getZoneId() : String`
+
+Returns the id of the payments zone.
+
+### isAfterpayClearpayEnabled
+
+**Signature:** `isAfterpayClearpayEnabled() : boolean`
+
+Returns true if Afterpay Clearpay presentment is enabled, or false if not.
+
+### isApplePayEnabled
+
+**Signature:** `isApplePayEnabled() : boolean`
+
+Returns true if Apple Pay presentment is enabled, or false if not.
+
+### isBancontactEnabled
+
+**Signature:** `isBancontactEnabled() : boolean`
+
+Returns true if Bancontact presentment is enabled, or false if not.
+
+### isBancontactMobileEnabled
+
+**Signature:** `isBancontactMobileEnabled() : boolean`
+
+Returns true if Bancontact Mobile presentment is enabled, or false if not.
+
+### isCardEnabled
+
+**Signature:** `isCardEnabled() : boolean`
+
+Returns true if credit card presentment is enabled, or false if not.
+
+### isEpsEnabled
+
+**Signature:** `isEpsEnabled() : boolean`
+
+Returns true if EPS presentment is enabled, or false if not.
+
+### isIdealEnabled
+
+**Signature:** `isIdealEnabled() : boolean`
+
+Returns true if iDEAL presentment is enabled, or false if not.
+
+### isKlarnaEnabled
+
+**Signature:** `isKlarnaEnabled() : boolean`
+
+Returns true if Klarna presentment is enabled, or false if not.
+
+### isKlarnaPayInInstallmentsEnabled
+
+**Signature:** `isKlarnaPayInInstallmentsEnabled() : boolean`
+
+Returns true if Klarna Pay in Installments presentment is enabled, or false if not.
+
+### isKlarnaPayNowEnabled
+
+**Signature:** `isKlarnaPayNowEnabled() : boolean`
+
+Returns true if Klarna Pay Now presentment is enabled, or false if not.
+
+### isPaymentRequestEnabled
+
+**Signature:** `isPaymentRequestEnabled() : boolean`
+
+Returns true if W3C Payment Request API button presentment is enabled, or false if not.
+
+### isPayPalEnabled
+
+**Signature:** `isPayPalEnabled() : boolean`
+
+Returns true if PayPal multi-step checkout presentment is enabled, or false if not.
+
+### isPayPalExpressEnabled
+
+**Signature:** `isPayPalExpressEnabled() : boolean`
+
+Returns true if PayPal express checkout presentment is enabled, or false if not.
+
+### isSepaDebitEnabled
+
+**Signature:** `isSepaDebitEnabled() : boolean`
+
+Returns true if SEPA Debit presentment is enabled, or false if not.
+
+### isVenmoEnabled
+
+**Signature:** `isVenmoEnabled() : boolean`
+
+Returns true if Venmo multi-step checkout presentment is enabled, or false if not.
+
+### isVenmoExpressEnabled
+
+**Signature:** `isVenmoExpressEnabled() : boolean`
+
+Returns true if Venmo express checkout presentment is enabled, or false if not.
+
+## Method Detail
+
+## Method Details
+
+### getPaymentMethods
+
+**Signature:** `getPaymentMethods(countryCode : String, amount : Money) : Collection`
+
+**Description:** Returns a collection containing the merchant account payment methods to be presented for this payments zone.
+
+**Parameters:**
+
+- `countryCode`: No Comment In JavaDoc
+- `amount`: No Comment In JavaDoc
+
+**Returns:**
+
+collection of merchant account payment methods
+
+---
+
+### getZoneId
+
+**Signature:** `getZoneId() : String`
+
+**Description:** Returns the id of the payments zone.
+
+**Returns:**
+
+zone id
+
+---
+
+### isAfterpayClearpayEnabled
+
+**Signature:** `isAfterpayClearpayEnabled() : boolean`
+
+**Description:** Returns true if Afterpay Clearpay presentment is enabled, or false if not.
+
+**Returns:**
+
+if Afterpay Clearpay presentment is enabled
+
+---
+
+### isApplePayEnabled
+
+**Signature:** `isApplePayEnabled() : boolean`
+
+**Description:** Returns true if Apple Pay presentment is enabled, or false if not.
+
+**Returns:**
+
+if Apple Pay presentment is enabled
+
+---
+
+### isBancontactEnabled
+
+**Signature:** `isBancontactEnabled() : boolean`
+
+**Description:** Returns true if Bancontact presentment is enabled, or false if not. Note: For Adyen merchant accounts, this setting refers to the "Bancontact Card" payment method.
+
+**Returns:**
+
+if Bancontact presentment is enabled
+
+---
+
+### isBancontactMobileEnabled
+
+**Signature:** `isBancontactMobileEnabled() : boolean`
+
+**Description:** Returns true if Bancontact Mobile presentment is enabled, or false if not. Note: This setting is only applicable for Adyen Merchant Accounts
+
+**Returns:**
+
+if Bancontact Mobile presentment is enabled
+
+---
+
+### isCardEnabled
+
+**Signature:** `isCardEnabled() : boolean`
+
+**Description:** Returns true if credit card presentment is enabled, or false if not.
+
+**Returns:**
+
+if credit card presentment is enabled
+
+---
+
+### isEpsEnabled
+
+**Signature:** `isEpsEnabled() : boolean`
+
+**Description:** Returns true if EPS presentment is enabled, or false if not.
+
+**Returns:**
+
+if EPS presentment is enabled
+
+---
+
+### isIdealEnabled
+
+**Signature:** `isIdealEnabled() : boolean`
+
+**Description:** Returns true if iDEAL presentment is enabled, or false if not.
+
+**Returns:**
+
+if iDEAL presentment is enabled
+
+---
+
+### isKlarnaEnabled
+
+**Signature:** `isKlarnaEnabled() : boolean`
+
+**Description:** Returns true if Klarna presentment is enabled, or false if not. Note: For Adyen merchant accounts, this setting applies to the Klarna Pay Later payment method.
+
+**Returns:**
+
+if Klarna presentment is enabled
+
+---
+
+### isKlarnaPayInInstallmentsEnabled
+
+**Signature:** `isKlarnaPayInInstallmentsEnabled() : boolean`
+
+**Description:** Returns true if Klarna Pay in Installments presentment is enabled, or false if not. Note: This setting is only applicable for Adyen Merchant Accounts.
+
+**Returns:**
+
+if Klarna Pay in Installments presentment is enabled
+
+---
+
+### isKlarnaPayNowEnabled
+
+**Signature:** `isKlarnaPayNowEnabled() : boolean`
+
+**Description:** Returns true if Klarna Pay Now presentment is enabled, or false if not. Note: This setting is only applicable for Adyen Merchant Accounts.
+
+**Returns:**
+
+if Klarna Pay Now presentment is enabled
+
+---
+
+### isPaymentRequestEnabled
+
+**Signature:** `isPaymentRequestEnabled() : boolean`
+
+**Description:** Returns true if W3C Payment Request API button presentment is enabled, or false if not.
+
+**Returns:**
+
+if W3C Payment Request API presentment is enabled
+
+---
+
+### isPayPalEnabled
+
+**Signature:** `isPayPalEnabled() : boolean`
+
+**Description:** Returns true if PayPal multi-step checkout presentment is enabled, or false if not.
+
+**Returns:**
+
+if PayPal multi-step checkout presentment is enabled
+
+---
+
+### isPayPalExpressEnabled
+
+**Signature:** `isPayPalExpressEnabled() : boolean`
+
+**Description:** Returns true if PayPal express checkout presentment is enabled, or false if not.
+
+**Returns:**
+
+if PayPal express checkout presentment is enabled
+
+---
+
+### isSepaDebitEnabled
+
+**Signature:** `isSepaDebitEnabled() : boolean`
+
+**Description:** Returns true if SEPA Debit presentment is enabled, or false if not.
+
+**Returns:**
+
+if SEPA Debit presentment is enabled
+
+---
+
+### isVenmoEnabled
+
+**Signature:** `isVenmoEnabled() : boolean`
+
+**Description:** Returns true if Venmo multi-step checkout presentment is enabled, or false if not.
+
+**Returns:**
+
+if Venmo multi-step checkout presentment is enabled
+
+---
+
+### isVenmoExpressEnabled
+
+**Signature:** `isVenmoExpressEnabled() : boolean`
+
+**Description:** Returns true if Venmo express checkout presentment is enabled, or false if not.
+
+**Returns:**
+
+if Venmo express checkout presentment is enabled
+
+---

package/dist/docs/dw_order/OrderMgr.md

@@ -446,7 +446,7 @@ SeekableIterator.close()
 
 **Signature:** `static searchOrder(queryString : String, args : Object...) : Order`
 
-**Description:** Searches for a single order instance. Order access in the storefront can be limited; see the class description. The search can be configured using a simple query language, which provides most common filter and operator functionality. The identifier for an attribute to use in a query condition is always the ID of the attribute as defined in the type definition. For custom-defined attributes the prefix 'custom' is required in the search term (e.g. custom.color = {1}), while for system attributes no prefix is used (e.g. name = {4}). Supported attribute value types with sample expression values: String 'String', 'Str*', 'Strin?' Integer 1, 3E4 Number 1.0, 3.99E5 Date yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC) DateTime yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00 Boolean true, false Email 'search@demandware.com', '*@demandware.com' Set of String 'String', 'Str*', 'Strin?' Set of Integer 1, 3E4 Set of Number 1.0, 3.99E5 Enum of String 'String', 'Str*', 'Strin?' Enum of Integer 1, 3E4 The following types of attributes are not queryable: Image HTML Text Quantity Password Note that some system attributes are not queryable by default, regardless of the actual value type code. The following operators are supported in a condition: = Equals - All types; supports NULL value (thumbnail = NULL) != Not equals - All types; supports NULL value (thumbnail != NULL) < Less than - Integer, Number, and Date types only > Greater than - Integer, Number, and Date types only <= Less or equals than - Integer, Number, and Date types only >= Greater or equals than - Integer, Number, and Date types only LIKE Like - String types and Email only; use if leading or trailing wildcards will be used to support substring search (e.g. custom.country LIKE 'US*') ILIKE Caseindependent Like - String types and Email only; use to support case-insensitive queries (e.g. custom.country ILIKE 'usa'), also supports wildcards for substring matching Conditions can be combined using logical expressions 'AND', 'OR', and 'NOT', and nested using parentheses, e.g. gender = {1} AND (age >= {2} OR (NOT profession LIKE {3})). The query language provides a placeholder syntax to pass objects as additional search parameters. Each passed object is related to a placeholder in the query string. The placeholder must be an Integer that is surrounded by braces. The first Integer value must be '0', the second '1', and so on, e.g. querySystemObjects("sample", "age = {0} or creationDate >= {1}", 18, date). If there is more than one object matching the specified query criteria, the result is not deterministic. In order to retrieve a single object from a sorted result set, it is recommended to use the following code: queryOrders("", "custom.myAttr asc", null).first(). The method first() returns only the next element and closes the iterator. If the order search API is configured to use the new Search Service, the following differences apply: wildcards will be filtered from the query (*, %, +) and replaced by spaces LIKE and ILIKE queries will be executed as fulltext queries (working on whole words), not as substring searches LIKE queries will always be case-insensitive using logical operators may change the execution of LIKE/ILIKE clauses to exact string comparison, depending on how they are combined using logical operators may result in degraded performance, depending on how they are combined Order search index updates are asynchronous, triggered only by committing changes to the underlying system.
+**Description:** Searches for a single order instance. Order access in the storefront can be limited; see the class description. The search can be configured using a simple query language, which provides most common filter and operator functionality. The identifier for an attribute to use in a query condition is always the ID of the attribute as defined in the type definition. For custom-defined attributes the prefix 'custom' is required in the search term (e.g. custom.color = {1}), while for system attributes no prefix is used (e.g. name = {4}). Supported attribute value types with sample expression values: String 'String', 'Str*', 'Strin?' Integer 1, 3E4 Number 1.0, 3.99E5 Date yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC) DateTime yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00 Boolean true, false Email 'search@demandware.com', '*@demandware.com' Set of String 'String', 'Str*', 'Strin?' Set of Integer 1, 3E4 Set of Number 1.0, 3.99E5 Enum of String 'String', 'Str*', 'Strin?' Enum of Integer 1, 3E4 The following types of attributes are not queryable: Image HTML Text Quantity Password Note that some system attributes are not queryable by default, regardless of the actual value type code. The following operators are supported in a condition: = Equals - All types; supports NULL value (thumbnail = NULL) != Not equals - All types; supports NULL value (thumbnail != NULL) < Less than - Integer, Number, and Date types only > Greater than - Integer, Number, and Date types only <= Less or equals than - Integer, Number, and Date types only >= Greater or equals than - Integer, Number, and Date types only LIKE Like - String types and Email only; use if leading or trailing wildcards will be used to support substring search (e.g. custom.country LIKE 'US*') ILIKE Caseindependent Like - String types and Email only; use to support case-insensitive queries (e.g. custom.country ILIKE 'usa'), also supports wildcards for substring matching Conditions can be combined using logical expressions 'AND', 'OR', and 'NOT', and nested using parentheses, e.g. gender = {1} AND (age >= {2} OR (NOT profession LIKE {3})). The query language provides a placeholder syntax to pass objects as additional search parameters. Each passed object is related to a placeholder in the query string. The placeholder must be an Integer that is surrounded by braces. The first Integer value must be '0', the second '1', and so on, e.g. querySystemObjects("sample", "age = {0} or creationDate >= {1}", 18, date). If there is more than one object matching the specified query criteria, the result is not deterministic. In order to retrieve a single object from a sorted result set, it is recommended to use the following code: queryOrders("", "custom.myAttr asc", null).first(). The method first() returns only the next element and closes the iterator. If the order search API is configured to use the new Search Service, these differences apply: Search may match and return documents with missing (NULL) values in search fields, depending on how the query is structured, potentially leading to broader result sets. For example, a query like custom.searchField != "some value" also returns documents where custom.searchField is NULL — whereas in relational databases, such documents are excluded. Wildcards are filtered from the query (*, %, +) and replaced by spaces LIKE and ILIKE queries are executed as fulltext queries (working on whole words), not as substring searches LIKE queries are always case-insensitive Using logical operators may change the execution of LIKE/ILIKE clauses to exact string comparison, depending on how they are combined Using logical operators may result in degraded performance, depending on how they are combined Order search index updates are asynchronous, triggered only by committing changes to the underlying system.
 
 **Parameters:**
 
@@ -463,7 +463,7 @@ the order that was found when executing the queryString.
 
 **Signature:** `static searchOrders(queryString : String, sortString : String, args : Object...) : SeekableIterator`
 
-**Description:** Searches for order instances. Order access in the storefront can be limited; see the class description. The search can be configured using a simple query language, which provides most common filter and operator functionality. When implementing order history functionality, don't use the search or query methods in this class. Instead, use OrderHistory.getOrders(String, String, Object...). The identifier for an attribute to use in a query condition is always the ID of the attribute as defined in the type definition. For custom-defined attributes the prefix 'custom' is required in the search term (e.g. custom.color = {1}), while for system attributes no prefix is used (e.g. name = {4}). Supported attribute value types with sample expression values: String 'String', 'Str*', 'Strin?' Integer 1, 3E4 Number 1.0, 3.99E5 Date yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC) DateTime yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00 Boolean true, false Email 'search@demandware.com', '*@demandware.com' Set of String 'String', 'Str*', 'Strin?' Set of Integer 1, 3E4 Set of Number 1.0, 3.99E5 Enum of String 'String', 'Str*', 'Strin?' Enum of Integer 1, 3E4 The following types of attributes are not queryable: Image HTML Text Quantity Password Note that some system attributes are not queryable by default, regardless of the actual value type code. The following operators are supported in a condition: = Equals - All types; supports NULL value (thumbnail = NULL) != Not equals - All types; supports NULL value (thumbnail != NULL) < Less than - Integer, Number, and Date types only > Greater than - Integer, Number, and Date types only <= Less or equals than - Integer, Number, and Date types only >= Greater or equals than - Integer, Number, and Date types only LIKE Like - String types and Email only; use if leading or trailing wildcards will be used to support substring search (e.g. custom.country LIKE 'US*') ILIKE Caseindependent Like - String types and Email only; use to support case-insensitive queries (e.g. custom.country ILIKE 'usa'); also supports wildcards for substring matching Note that wildcards are not supported by Search Service. Conditions can be combined using logical expressions 'AND', 'OR', and 'NOT', and nested using parentheses, e.g. gender = {1} AND (age >= {2} OR (NOT profession LIKE {3})). The query language provides a placeholder syntax to pass objects as additional search parameters. Each passed object is related to a placeholder in the query string. The placeholder must be an Integer that is surrounded by braces. The first Integer value must be '0', the second '1', and so on, e.g. querySystemObjects("sample", "age = {0} or creationDate >= {1}", 18, date). The sorting parameter is optional and may contain a comma-separated list of attribute names to sort by. Each sort attribute name may be followed by an optional sort direction specifier ('asc' | 'desc'). The default sorting direction is ascending, if no direction was specified. Example: age desc, name Please note that specifying a localized custom attribute as the sorting attribute is currently not supported. Sometimes it is desired to get all instances of a specified type with a special sorting condition. This can be easily done by providing the 'type' of the custom object and the 'sortString' in combination with an empty 'queryString', e.g. queryOrders("sample", "", "custom.myAttr asc"). It is strongly recommended to call SeekableIterator.close() on the returned SeekableIterator if not all of its elements are being retrieved. This will ensure the proper cleanup of system resources. If the order search API is configured to use the new Search Service, the following differences apply: wildcards will be filtered from the query (*, %, +) and replaced by spaces LIKE and ILIKE queries will be executed as fulltext queries (working on whole words), not as substring searches LIKE queries will always be case-insensitive using logical operators may change the execution of LIKE/ILIKE clauses to exact string comparison, depending on how they are combined using logical operators may result in degraded performance, depending on how they are combined the result is limited to a maximum of 1000 orders Order search index updates are asynchronous, triggered only by committing changes to the underlying system.
+**Description:** Searches for order instances. Order access in the storefront can be limited; see the class description. The search can be configured using a simple query language, which provides most common filter and operator functionality. When implementing order history functionality, don't use the search or query methods in this class. Instead, use OrderHistory.getOrders(String, String, Object...). The identifier for an attribute to use in a query condition is always the ID of the attribute as defined in the type definition. For custom-defined attributes the prefix 'custom' is required in the search term (e.g. custom.color = {1}), while for system attributes no prefix is used (e.g. name = {4}). Supported attribute value types with sample expression values: String 'String', 'Str*', 'Strin?' Integer 1, 3E4 Number 1.0, 3.99E5 Date yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC) DateTime yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00 Boolean true, false Email 'search@demandware.com', '*@demandware.com' Set of String 'String', 'Str*', 'Strin?' Set of Integer 1, 3E4 Set of Number 1.0, 3.99E5 Enum of String 'String', 'Str*', 'Strin?' Enum of Integer 1, 3E4 The following types of attributes are not queryable: Image HTML Text Quantity Password Note that some system attributes are not queryable by default, regardless of the actual value type code. The following operators are supported in a condition: = Equals - All types; supports NULL value (thumbnail = NULL) != Not equals - All types; supports NULL value (thumbnail != NULL) < Less than - Integer, Number, and Date types only > Greater than - Integer, Number, and Date types only <= Less or equals than - Integer, Number, and Date types only >= Greater or equals than - Integer, Number, and Date types only LIKE Like - String types and Email only; use if leading or trailing wildcards will be used to support substring search (e.g. custom.country LIKE 'US*') ILIKE Caseindependent Like - String types and Email only; use to support case-insensitive queries (e.g. custom.country ILIKE 'usa'); also supports wildcards for substring matching Note that wildcards are not supported by Search Service. Conditions can be combined using logical expressions 'AND', 'OR', and 'NOT', and nested using parentheses, e.g. gender = {1} AND (age >= {2} OR (NOT profession LIKE {3})). The query language provides a placeholder syntax to pass objects as additional search parameters. Each passed object is related to a placeholder in the query string. The placeholder must be an Integer that is surrounded by braces. The first Integer value must be '0', the second '1', and so on, e.g. querySystemObjects("sample", "age = {0} or creationDate >= {1}", 18, date). The sorting parameter is optional and may contain a comma-separated list of attribute names to sort by. Each sort attribute name may be followed by an optional sort direction specifier ('asc' | 'desc'). The default sorting direction is ascending, if no direction was specified. Example: age desc, name Please note that specifying a localized custom attribute as the sorting attribute is currently not supported. Sometimes it is desired to get all instances of a specified type with a special sorting condition. This can be easily done by providing the 'type' of the custom object and the 'sortString' in combination with an empty 'queryString', e.g. queryOrders("sample", "", "custom.myAttr asc"). It is strongly recommended to call SeekableIterator.close() on the returned SeekableIterator if not all of its elements are being retrieved. This will ensure the proper cleanup of system resources. If the order search API is configured to use the new Search Service, these differences apply: Search may match and return documents with missing (NULL) values in search fields, depending on how the query is structured, potentially leading to broader result sets. For example, a query like custom.searchField != "some value" also returns documents where custom.searchField is NULL — whereas in relational databases, such documents are excluded. Wildcards are filtered from the query (*, %, +) and replaced by spaces LIKE and ILIKE queries are executed as fulltext queries (working on whole words), not as substring searches LIKE queries are always case-insensitive Using logical operators may change the execution of LIKE/ILIKE clauses to exact string comparison, depending on how they are combined Using logical operators may result in degraded performance, depending on how they are combined The result is limited to a maximum of 1000 orders Order search index updates are asynchronous, triggered only by committing changes to the underlying system.
 
 **Parameters:**
 
@@ -485,7 +485,7 @@ SeekableIterator.close()
 
 **Signature:** `static searchOrders(queryAttributes : Map, sortString : String) : SeekableIterator`
 
-**Description:** Searches for order instances. Order access in the storefront can be limited; see the class description. The search can be configured with a map, which converts key-value pairs into a query expression. The key-value pairs are turned into a sequence of '=' or 'like' conditions, which are combined with AND statements. Example: A map with the key/value pairs: 'name'/'tom*', 'age'/66 will be converted as follows: "name like 'tom*' and age = 66" Note that wildcards are not supported by Search Service. The identifier for an attribute to use in a query condition is always the ID of the attribute as defined in the type definition. For custom-defined attributes, the prefix 'custom' is required in the search term (e.g. custom.color = {1}), while for system attributes no prefix is used (e.g. name = {4}). Supported attribute value types with sample expression values: String 'String', 'Str*', 'Strin?' Integer 1, 3E4 Number 1.0, 3.99E5 Date yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC) DateTime yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00 Boolean true, false Email 'search@demandware.com', '*@demandware.com' Set of String 'String', 'Str*', 'Strin?' Set of Integer 1, 3E4 Set of Number 1.0, 3.99E5 Enum of String 'String', 'Str*', 'Strin?' Enum of Integer 1, 3E4 The following types of attributes are not queryable: Image HTML Text Quantity Password Note that some system attributes are not queryable by default, regardless of the actual value type code. The sorting parameter is optional and may contain a comma-separated list of attribute names to sort by. Each sort attribute name may be followed by an optional sort direction specifier ('asc' | 'desc'). The default sorting direction is ascending, if no direction was specified. Example: age desc, name Please note that specifying a localized custom attribute as the sorting attribute is currently not supported. It is strongly recommended to call SeekableIterator.close() on the returned SeekableIterator if not all of its elements are being retrieved. This will ensure the proper cleanup of system resources. If the order search API is configured to use the new Search Service, the following differences apply: wildcards will be filtered from the query (*, %, +) and replaced by spaces LIKE and ILIKE queries will be executed as fulltext queries (working on whole words), not as substring searches LIKE queries will always be case-insensitive using logical operators may change the execution of LIKE/ILIKE clauses to exact string comparison, depending on how they are combined using logical operators may result in degraded performance, depending on how they are combined the result is limited to a maximum of 1000 orders Order search index updates are asynchronous, triggered only by committing changes to the underlying system.
+**Description:** Searches for order instances. Order access in the storefront can be limited; see the class description. The search can be configured with a map, which converts key-value pairs into a query expression. The key-value pairs are turned into a sequence of '=' or 'like' conditions, which are combined with AND statements. Example: A map with the key/value pairs: 'name'/'tom*', 'age'/66 will be converted as follows: "name like 'tom*' and age = 66" Note that wildcards are not supported by Search Service. The identifier for an attribute to use in a query condition is always the ID of the attribute as defined in the type definition. For custom-defined attributes, the prefix 'custom' is required in the search term (e.g. custom.color = {1}), while for system attributes no prefix is used (e.g. name = {4}). Supported attribute value types with sample expression values: String 'String', 'Str*', 'Strin?' Integer 1, 3E4 Number 1.0, 3.99E5 Date yyyy-MM-dd e.g. 2007-05-31 (Default TimeZone = UTC) DateTime yyyy-MM-dd'T'hh:mm:ss+Z e.g. 2007-05-31T00:00+Z (Z TimeZone = UTC) or 2007-05-31T00:00:00 Boolean true, false Email 'search@demandware.com', '*@demandware.com' Set of String 'String', 'Str*', 'Strin?' Set of Integer 1, 3E4 Set of Number 1.0, 3.99E5 Enum of String 'String', 'Str*', 'Strin?' Enum of Integer 1, 3E4 The following types of attributes are not queryable: Image HTML Text Quantity Password Note that some system attributes are not queryable by default, regardless of the actual value type code. The sorting parameter is optional and may contain a comma-separated list of attribute names to sort by. Each sort attribute name may be followed by an optional sort direction specifier ('asc' | 'desc'). The default sorting direction is ascending, if no direction was specified. Example: age desc, name Please note that specifying a localized custom attribute as the sorting attribute is currently not supported. It is strongly recommended to call SeekableIterator.close() on the returned SeekableIterator if not all of its elements are being retrieved. This will ensure the proper cleanup of system resources. If the order search API is configured to use the new Search Service, these differences apply: Search may match and return documents with missing (NULL) values in search fields, depending on how the query is structured, potentially leading to broader result sets. For example, a query like custom.searchField != "some value" also returns documents where custom.searchField is NULL — whereas in relational databases, such documents are excluded. Wildcards are filtered from the query (*, %, +) and replaced by spaces LIKE and ILIKE queries are executed as fulltext queries (working on whole words), not as substring searches LIKE queries are always case-insensitive Using logical operators may change the execution of LIKE/ILIKE clauses to exact string comparison, depending on how they are combined Using logical operators may result in degraded performance, depending on how they are combined The result is limited to a maximum of 1000 orders Order search index updates are asynchronous, triggered only by committing changes to the underlying system.
 
 **Parameters:**
 

package/dist/docs/dw_order.hooks/BasketMergeHooks.md

@@ -22,7 +22,7 @@ This interface represents all script hooks that can be registered to merge baske
 
 **Signature:** `mergeBasket(source : Basket, currentBasket : Basket) : Status`
 
-Merges contents from a source basket (usually a former registered shopper's basket) to a destination basket (usually a former guest shopper basket that was transferred to the registered shopper upon login).
+Merges content from a source basket (typically a former registered shopper's basket) into the current basket (usually a former guest shopper's basket that was transferred to the registered shopper).
 
 ## Method Detail
 
@@ -32,11 +32,11 @@ Merges contents from a source basket (usually a former registered shopper's bask
 
 **Signature:** `mergeBasket(source : Basket, currentBasket : Basket) : Status`
 
-**Description:** Merges contents from a source basket (usually a former registered shopper's basket) to a destination basket (usually a former guest shopper basket that was transferred to the registered shopper upon login). In case of no implementation is registered, the default implementation is invoked. This method is automatically called for the following scenarios: After a successful call to the transfer Rest API with query parameter merge=true, whereby the guest and registered users, both had an active basket attached. In this scenario the registered shopper's basket will be the source of the merge and the transferred guest shopper's basket will be the destination.
+**Description:** Merges content from a source basket (typically a former registered shopper's basket) into the current basket (usually a former guest shopper's basket that was transferred to the registered shopper). If no override script is registered, the system defaults to the platform's standard basket merging logic. This method is automatically invoked after a successful execution of the /transfer REST API with the query parameter merge=true, if either the guest or the registered users had baskets assigned. The registered shopper's basket will be the source for the merge, and the transferred guest shopper's basket will be the current basket.
 
 **Parameters:**
 
-- `source`: the basket from which data should be merged into the destination, can be null e.g. in case the former guest shopper did not create a basket
-- `currentBasket`: the destination basket to merge data into
+- `source`: the basket from which data will be merged into the current basket. Will be null if the former guest shopper did not have an assigned basket.
+- `currentBasket`: the current basket to merge data into
 
 ---

package/dist/docs/dw_order.hooks/CheckoutHooks.md

@@ -0,0 +1,42 @@
+## Package: dw.order.hooks
+
+# Class CheckoutHooks
+
+## Inheritance Hierarchy
+
+- dw.order.hooks.CheckoutHooks
+
+## Description
+
+This interface represents script hooks that can be registered to populate customer details into a basket. It contains the extension points (hook names), and the functions that are called by each extension point. A function must be defined inside a JavaScript source and must be exported. The script with the exported hook function must be located inside a site cartridge. Inside the site cartridge a 'package.json' file with a 'hooks' entry must exist. "hooks": "./hooks.json" The hooks entry links to a json file, relative to the 'package.json' file. This file lists all registered hooks inside the hooks property: "hooks": [ {"name": "dw.order.populateCustomerDetails", "script": "./populateCustomerDetails.js"} ] A hook entry has a 'name' and a 'script' property. The 'name' contains the extension point, the hook name. The 'script' contains the script relative to the hooks file, with the exported hook function.
+
+## Constants
+
+## Properties
+
+## Constructor Summary
+
+## Method Summary
+
+### populateCustomerDetails
+
+**Signature:** `populateCustomerDetails(basket : Basket, customer : Customer) : Status`
+
+Populates registered customer details into a basket.
+
+## Method Detail
+
+## Method Details
+
+### populateCustomerDetails
+
+**Signature:** `populateCustomerDetails(basket : Basket, customer : Customer) : Status`
+
+**Description:** Populates registered customer details into a basket. This includes the default shipping address and default payment instrument from the registered customer's profile. If no override script is registered, the system defaults to the platform's standard population logic which copies the customer's default or first address to the basket's default shipment and billing address, then creates a payment instrument from the customer's default or first payment instrument. This method is automatically invoked when the populateCustomerDetails query parameter is set to true on createBasket and transferBasket endpoints.
+
+**Parameters:**
+
+- `basket`: the basket to populate with customer details
+- `customer`: the registered customer whose details should be populated into the basket
+
+---

package/dist/utils/path-resolver.d.ts

@@ -5,6 +5,11 @@
  * This abstraction allows for easier path management and testing.
  */
 export declare class PathResolver {
+    /**
+     * Resolve the first existing path from a list of candidates.
+     * Falls back to the first candidate when none exist.
+     */
+    private static resolveExistingPath;
     /**
      * Get the current working directory (project root)
      */

package/dist/utils/path-resolver.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"path-resolver.d.ts","sourceRoot":"","sources":["../../src/utils/path-resolver.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH,qBAAa,YAAY;IACvB;;OAEG;IACH,MAAM,CAAC,oBAAoB,IAAI,MAAM;IAWrC;;OAEG;IACH,MAAM,CAAC,qBAAqB,IAAI,MAAM;IAItC;;OAEG;IACH,MAAM,CAAC,yBAAyB,IAAI,MAAM;IAI1C;;OAEG;IACH,MAAM,CAAC,mBAAmB,IAAI,MAAM;IAIpC;;OAEG;IACH,MAAM,CAAC,eAAe,CAAC,GAAG,YAAY,EAAE,MAAM,EAAE,GAAG,MAAM;IAMzD;;OAEG;IACH,MAAM,CAAC,WAAW,IAAI,MAAM;IAI5B;;OAEG;IACH,MAAM,CAAC,eAAe,IAAI,MAAM;CAGjC"}
+{"version":3,"file":"path-resolver.d.ts","sourceRoot":"","sources":["../../src/utils/path-resolver.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAMH,qBAAa,YAAY;IACvB;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAUlC;;OAEG;IACH,MAAM,CAAC,oBAAoB,IAAI,MAAM;IAYrC;;OAEG;IACH,MAAM,CAAC,qBAAqB,IAAI,MAAM;IAQtC;;OAEG;IACH,MAAM,CAAC,yBAAyB,IAAI,MAAM;IAI1C;;OAEG;IACH,MAAM,CAAC,mBAAmB,IAAI,MAAM;IAIpC;;OAEG;IACH,MAAM,CAAC,eAAe,CAAC,GAAG,YAAY,EAAE,MAAM,EAAE,GAAG,MAAM;IAMzD;;OAEG;IACH,MAAM,CAAC,WAAW,IAAI,MAAM;IAQ5B;;OAEG;IACH,MAAM,CAAC,eAAe,IAAI,MAAM;CAGjC"}

package/dist/utils/path-resolver.js

@@ -5,15 +5,29 @@
  * This abstraction allows for easier path management and testing.
  */
 import path from 'path';
+import fs from 'fs';
 import { fileURLToPath } from 'url';
 export class PathResolver {
+    /**
+     * Resolve the first existing path from a list of candidates.
+     * Falls back to the first candidate when none exist.
+     */
+    static resolveExistingPath(candidates) {
+        for (const candidate of candidates) {
+            if (fs.existsSync(candidate)) {
+                return candidate;
+            }
+        }
+        return candidates[0];
+    }
     /**
      * Get the current working directory (project root)
      */
     static getCurrentWorkingDir() {
         // Get the directory of the current module file
-        // ts-jest may compile with a CommonJS module target in tests; suppress the
-        // diagnostic because runtime uses ESM (NodeNext) where import.meta is valid.
+        // ts-jest may compile with a CommonJS module target in tests.
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore TS1343: runtime uses ESM (NodeNext) where import.meta is valid.
         const __filename = fileURLToPath(import.meta.url);
         const __dirname = path.dirname(__filename);
         // Return the project root (handles both src/ and dist/ locations)
@@ -23,7 +37,11 @@ export class PathResolver {
      * Root path for bundled AI instructions (AGENTS.md + skills)
      */
     static getAiInstructionsPath() {
-        return this.getRelativePath('ai-instructions');
+        const root = this.getCurrentWorkingDir();
+        return this.resolveExistingPath([
+            path.join(root, 'ai-instructions'),
+            path.join(root, 'dist', 'ai-instructions'),
+        ]);
     }
     /**
      * Path to the bundled AGENTS.md
@@ -48,13 +66,17 @@ export class PathResolver {
      * Get the docs directory path relative to the current working directory
      */
     static getDocsPath() {
-        return this.getRelativePath('docs');
+        const root = this.getCurrentWorkingDir();
+        return this.resolveExistingPath([
+            path.join(root, 'docs'),
+            path.join(root, 'dist', 'docs'),
+        ]);
     }
     /**
      * Get the SFRA docs directory path relative to the current working directory
      */
     static getSFRADocsPath() {
-        return this.getRelativePath('docs', 'sfra');
+        return path.join(this.getDocsPath(), 'sfra');
     }
 }
 //# sourceMappingURL=path-resolver.js.map