@salesforce/b2c-cli 1.10.0 → 1.12.0

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/consent/ShopperConsentMgr.d.ts

@@ -0,0 +1,78 @@
+import Collection = require('../../util/Collection');
+import MarketingConsentSubscription = require('./MarketingConsentSubscription');
+import List = require('../../util/List');
+
+/**
+ * Provides static helper methods for managing shopper marketing consent subscriptions.
+ * 
+ * This API enables retrieving and updating marketing consent preferences.
+ * Consent subscriptions define communication categories (e.g., "Newsletter", "Product Updates")
+ * and the channels (EMAIL, SMS, WHATSAPP) through which marketing communications can be sent.
+ * 
+ * Prerequisites:
+ * 
+ * - The Marketing Consent feature must be enabled and configured
+ * - For consent status retrieval, the current request must have a customer context
+ * 
+ * Example usage:
+ * @example
+ * `
+ * var ShopperConsentMgr = require('dw/customer/consent/ShopperConsentMgr');
+ * 
+ * // Get all subscriptions for the current site
+ * var subscriptions = ShopperConsentMgr.getSubscriptions();
+ * 
+ * for each (var sub in subscriptions) {
+ * trace('Subscription: ' + sub.subscriptionId + ' - ' + sub.title);
+ * trace('Available channels: ' + sub.channels.join(', '));
+ * }
+ * 
+ * // Get subscriptions with consent status (for authenticated customers)
+ * var subsWithStatus = ShopperConsentMgr.getSubscriptions(null, true);
+ * 
+ * // Update consent for a specific subscription
+ * ShopperConsentMgr.updateSubscription(
+ * 'customer@example.com',
+ * 'newsletter-subscription',
+ * 'EMAIL',
+ * 'OPT_IN'
+ * );
+ * `
+ * @see MarketingConsentSubscription
+ * @see ConsentStatusEntry
+ */
+declare class ShopperConsentMgr {
+    /**
+     * Retrieves marketing consent subscriptions for the current site.
+     * 
+     * This method returns all available consent subscriptions without consent status information.
+     * @throws ShopperConsentException if the consent feature is not enabled or retrieval fails.
+     */
+    static readonly subscriptions: Collection<MarketingConsentSubscription>;
+    private constructor();
+    /**
+     * Retrieves marketing consent subscriptions for the current site.
+     * 
+     * This method returns all available consent subscriptions without consent status information.
+     * @throws ShopperConsentException if the consent feature is not enabled or retrieval fails.
+     */
+    static getSubscriptions(): Collection<MarketingConsentSubscription>;
+    /**
+     * Retrieves marketing consent subscriptions for the current site with optional filtering and status.
+     * 
+     * Use this method to retrieve subscriptions filtered by tags and optionally include
+     * the current consent status for authenticated customers.
+     * @throws ShopperConsentException if the consent feature is not enabled, retrieval fails, or consent status retrieval fails.
+     */
+    static getSubscriptions(tags: List<any>, includeConsentStatus: boolean): Collection<MarketingConsentSubscription>;
+    /**
+     * Updates consent status for a subscription.
+     * 
+     * This method updates the consent status in Salesforce Core for the specified
+     * contact point and subscription channel combination.
+     * @throws ShopperConsentException if the consent feature is not enabled or update fails.
+     */
+    static updateSubscription(contactPointValue: string, subscriptionId: string, channel: string, status: string): void;
+}
+
+export = ShopperConsentMgr;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/consent/index.d.ts

@@ -0,0 +1,13 @@
+import ConsentStatusEntry = require('./ConsentStatusEntry');
+import MarketingConsentSubscription = require('./MarketingConsentSubscription');
+import ShopperConsentErrorCodes = require('./ShopperConsentErrorCodes');
+import ShopperConsentException = require('./ShopperConsentException');
+import ShopperConsentMgr = require('./ShopperConsentMgr');
+
+export {
+    ConsentStatusEntry,
+    MarketingConsentSubscription,
+    ShopperConsentErrorCodes,
+    ShopperConsentException,
+    ShopperConsentMgr
+};

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/index.d.ts

@@ -0,0 +1,55 @@
+import AddressBook = require('./AddressBook');
+import AgentUserMgr = require('./AgentUserMgr');
+import AgentUserStatusCodes = require('./AgentUserStatusCodes');
+import AuthenticationStatus = require('./AuthenticationStatus');
+import Credentials = require('./Credentials');
+import Customer = require('./Customer');
+import CustomerActiveData = require('./CustomerActiveData');
+import CustomerAddress = require('./CustomerAddress');
+import CustomerCDPData = require('./CustomerCDPData');
+import CustomerContextMgr = require('./CustomerContextMgr');
+import CustomerGroup = require('./CustomerGroup');
+import CustomerList = require('./CustomerList');
+import CustomerMgr = require('./CustomerMgr');
+import CustomerPasswordConstraints = require('./CustomerPasswordConstraints');
+import CustomerPaymentInstrument = require('./CustomerPaymentInstrument');
+import CustomerStatusCodes = require('./CustomerStatusCodes');
+import EncryptedObject = require('./EncryptedObject');
+import ExternalProfile = require('./ExternalProfile');
+import OrderHistory = require('./OrderHistory');
+import ProductList = require('./ProductList');
+import ProductListItem = require('./ProductListItem');
+import ProductListItemPurchase = require('./ProductListItemPurchase');
+import ProductListMgr = require('./ProductListMgr');
+import ProductListRegistrant = require('./ProductListRegistrant');
+import Profile = require('./Profile');
+import Wallet = require('./Wallet');
+
+export {
+    AddressBook,
+    AgentUserMgr,
+    AgentUserStatusCodes,
+    AuthenticationStatus,
+    Credentials,
+    Customer,
+    CustomerActiveData,
+    CustomerAddress,
+    CustomerCDPData,
+    CustomerContextMgr,
+    CustomerGroup,
+    CustomerList,
+    CustomerMgr,
+    CustomerPasswordConstraints,
+    CustomerPaymentInstrument,
+    CustomerStatusCodes,
+    EncryptedObject,
+    ExternalProfile,
+    OrderHistory,
+    ProductList,
+    ProductListItem,
+    ProductListItemPurchase,
+    ProductListMgr,
+    ProductListRegistrant,
+    Profile,
+    Wallet
+};

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/oauth/OAuthAccessTokenResponse.d.ts

@@ -0,0 +1,71 @@
+import utilMap = require('../../util/Map');
+
+/**
+ * Contains OAuth-related artifacts from the HTTP response from the third-party
+ * OAuth server when requesting an access token
+ */
+declare class OAuthAccessTokenResponse {
+    /**
+     * Returns the ID token, if available
+     */
+    readonly IDToken: string | null;
+    /**
+     * Returns the access token
+     */
+    readonly accessToken: string | null;
+    /**
+     * Returns the access token expiration
+     */
+    readonly accessTokenExpiry: number;
+    /**
+     * Returns the error status.
+     * In cases of errors - more detailed error information
+     * can be seen in the error log files (specifity of error details vary by OAuth provider).
+     */
+    readonly errorStatus: string | null;
+    /**
+     * Returns a map of additional tokens found in the response.
+     */
+    readonly extraTokens: utilMap<any, any> | null;
+    /**
+     * Returns the OAuth provider id
+     */
+    readonly oauthProviderId: string;
+    /**
+     * Returns the refresh token
+     */
+    readonly refreshToken: string | null;
+    private constructor();
+    /**
+     * Returns the access token
+     */
+    getAccessToken(): string | null;
+    /**
+     * Returns the access token expiration
+     */
+    getAccessTokenExpiry(): number;
+    /**
+     * Returns the error status.
+     * In cases of errors - more detailed error information
+     * can be seen in the error log files (specifity of error details vary by OAuth provider).
+     */
+    getErrorStatus(): string | null;
+    /**
+     * Returns a map of additional tokens found in the response.
+     */
+    getExtraTokens(): utilMap<any, any> | null;
+    /**
+     * Returns the ID token, if available
+     */
+    getIDToken(): string | null;
+    /**
+     * Returns the OAuth provider id
+     */
+    getOauthProviderId(): string;
+    /**
+     * Returns the refresh token
+     */
+    getRefreshToken(): string | null;
+}
+
+export = OAuthAccessTokenResponse;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/oauth/OAuthFinalizedResponse.d.ts

@@ -0,0 +1,32 @@
+import OAuthUserInfoResponse = require('./OAuthUserInfoResponse');
+import OAuthAccessTokenResponse = require('./OAuthAccessTokenResponse');
+
+/**
+ * Contains the combined responses from the third-party OAuth server when
+ * finalizing the authentication.
+ * 
+ * Contains both the dw.customer.oauth.OAuthAccessTokenResponse
+ * 
+ * and the dw.customer.oauth.OAuthUserInfoResponse
+ */
+declare class OAuthFinalizedResponse {
+    /**
+     * Returns the access token response
+     */
+    readonly accessTokenResponse: OAuthAccessTokenResponse;
+    /**
+     * Returns the user info response
+     */
+    readonly userInfoResponse: OAuthUserInfoResponse;
+    private constructor();
+    /**
+     * Returns the access token response
+     */
+    getAccessTokenResponse(): OAuthAccessTokenResponse;
+    /**
+     * Returns the user info response
+     */
+    getUserInfoResponse(): OAuthUserInfoResponse;
+}
+
+export = OAuthFinalizedResponse;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/oauth/OAuthLoginFlowMgr.d.ts

@@ -0,0 +1,100 @@
+import URLRedirect = require('../../web/URLRedirect');
+import OAuthFinalizedResponse = require('./OAuthFinalizedResponse');
+import OAuthAccessTokenResponse = require('./OAuthAccessTokenResponse');
+import OAuthUserInfoResponse = require('./OAuthUserInfoResponse');
+
+/**
+ * The OAuthLoginFlowMgr encapsulates interactions with third party
+ * OAuth providers to support the Authorization Code Flow.
+ * 
+ * The way to use is:
+ * 
+ * - call initiateOAuthLogin
+ * - redirect the user to the returned link
+ * - when the user authenticates there the server will call back to
+ * a URL configured on the provider's web site
+ * - when processing the request made from the provider's web site
+ * you have two choices - either call the obtainAccessToken
+ * and obtainUserInfo
+ * methods one after another separately (gives you more flexibility),
+ * or call the finalizeOAuthLogin method which internally
+ * calls the other two (simpler to use).
+ * 
+ * Sample code for using it:
+ * 
+ * ```
+ * `
+ * var finalizedResponse : OAuthFinalizedResponse = OAuthLoginFlowMgr.finalizeOAuthLogin();
+ * var userInfo = finalizedResponse.userInfoResponse.userInfo;
+ * `
+ * ```
+ * 
+ * or:
+ * @example
+ * `
+ * var accessTokenResponse : OAuthAccessTokenResponse = OAuthLoginFlowMgr.obtainAccessToken();
+ * var userInfoResponse : OAuthUserInfoResponse = OAuthLoginFlowMgr.obtainUserInfo(
+ * accessTokenResponse.oauthProviderId, accessTokenResponse.accessToken);
+ * var userInfo = userInfoResponse.userInfo;
+ * `
+ */
+declare class OAuthLoginFlowMgr {
+    private constructor();
+    /**
+     * This method works in tandem with the initiateOAuthLogin method.
+     * After the user has been redirected to the URL returned by that method
+     * to the external OAuth2 provider and the user has interacted with the provider's
+     * site, the browser is redirected to a URL configured on the provider's web
+     * site. This URL should be that of a pipeline that contains
+     * a script invoking the finalizeOAuthLogin method.
+     * 
+     * At this point the user has either been authenticated by the external provider
+     * or not (forgot password, or simply refused to provide credentials). If the user
+     * has been authenticated by the external provider and the provider returns an
+     * authentication code, this method exchanges the code for a token and with that
+     * token it requests from the provider the user information specified by the
+     * configured scope (id, first/last name, email, etc.).
+     * 
+     * The method is aggregation of two other methods - obtainAccessToken
+     * and obtainUserInfo
+     * and is provided for convenience. You may want to
+     * use the two individual methods instead if you need more flexibility.
+     * 
+     * This supports the Authorization Code Flow.
+     */
+    static finalizeOAuthLogin(): OAuthFinalizedResponse | null;
+    /**
+     * This method works in tandem with another method - finalizeOAuthLogin.
+     * It starts the process of authentication via an external OAuth2 provider. It
+     * takes one parameter - OAuthProviderId (as configured in the system). Outputs
+     * an URL pointing to the OAuth2 provider's web page to which the browser should
+     * redirect to initiate the actual user authentication or NULL if there is an
+     * invalid configuration or an error occurs.
+     * The method stores a few key/values in the session
+     * (dw.system.Session.getPrivacy, implementation specific parameters and may change at any time)
+     * to be picked up by the finalizeOAuthLogin method  when the provider redirects back.
+     * 
+     * This supports the Authorization Code Flow.
+     */
+    static initiateOAuthLogin(oauthProviderId: string): URLRedirect | null;
+    /**
+     * This method is called internally by finalizeOAuthLogin.
+     * There are customer requests to expose a more granular way of
+     * doing the interactions that finalizeOAuthLogin is currently doing
+     * with the third party OAuth server to accommodate certain providers.
+     * 
+     * This supports the Authorization Code Flow.
+     */
+    static obtainAccessToken(): OAuthAccessTokenResponse;
+    /**
+     * This method is called internally by finalizeOAuthLogin.
+     * There are customer requests to expose a more granular way of
+     * doing the interactions that finalizeOAuthLogin is currently doing
+     * with the third party OAuth server to accommodate certain providers.
+     * 
+     * This supports the Authorization Code Flow.
+     */
+    static obtainUserInfo(oauthProviderId: string, accessToken: string): OAuthUserInfoResponse;
+}
+
+export = OAuthLoginFlowMgr;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/oauth/OAuthUserInfoResponse.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Contains the response from the third-party OAuth server when
+ * requesting user info. Refer to the corresponding OAuth provider documentation
+ * regarding what the format might be (in most cases it would be JSON).
+ * The data returned would also vary depending on the scope.
+ */
+declare class OAuthUserInfoResponse {
+    /**
+     * Returns the error status
+     * In cases of errors - more detailed error information
+     * can be seen in the error log files (specificity of error details vary by OAuth provider).
+     */
+    readonly errorStatus: string;
+    /**
+     * Returns the user info as a String. Refer to the corresponding OAuth provider documentation
+     * regarding what the format might be (in most cases it would be JSON).
+     * The data returned would also vary depending on the configured 'scope'.
+     */
+    readonly userInfo: string;
+    private constructor();
+    /**
+     * Returns the error status
+     * In cases of errors - more detailed error information
+     * can be seen in the error log files (specificity of error details vary by OAuth provider).
+     */
+    getErrorStatus(): string;
+    /**
+     * Returns the user info as a String. Refer to the corresponding OAuth provider documentation
+     * regarding what the format might be (in most cases it would be JSON).
+     * The data returned would also vary depending on the configured 'scope'.
+     */
+    getUserInfo(): string;
+}
+
+export = OAuthUserInfoResponse;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/oauth/index.d.ts

@@ -0,0 +1,11 @@
+import OAuthAccessTokenResponse = require('./OAuthAccessTokenResponse');
+import OAuthFinalizedResponse = require('./OAuthFinalizedResponse');
+import OAuthLoginFlowMgr = require('./OAuthLoginFlowMgr');
+import OAuthUserInfoResponse = require('./OAuthUserInfoResponse');
+
+export {
+    OAuthAccessTokenResponse,
+    OAuthFinalizedResponse,
+    OAuthLoginFlowMgr,
+    OAuthUserInfoResponse
+};

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/shoppercontext/ShopperContext.d.ts

@@ -0,0 +1,171 @@
+import utilMap = require('../../util/Map');
+import utilSet = require('../../util/Set');
+import Geolocation = require('../../util/Geolocation');
+
+/**
+ * The class represents Shopper Context. It is used to manage personalized shopping experiences on your storefront.
+ * 
+ * Shopper Context is used to personalize shopper experiences with context values such as custom session attributes,
+ * assignment qualifiers, geolocation, clientIP address, effective date time, source code, coupon code and customer
+ * groups.
+ * 
+ * When Shopper Context is set for a shopper, the context is applied in the next request and can activate promotions or
+ * price books assigned to customer groups, source codes, or stores (via assignments).
+ * Also see: dw.customer.shoppercontext.ShopperContextMgr
+ */
+declare class ShopperContext {
+    /**
+     * Returns the assignment qualifiers from the Shopper Context. Assignment qualifiers are set when using the
+     * assignment framework to trigger pricing and promotion experiences for Products, Product Search, Basket, Shipping
+     * methods etc.
+     */
+    assignmentQualifiers: utilMap<any, any>;
+    /**
+     * Returns the IP address of the client from the Shopper Context.
+     */
+    clientIP: string;
+    /**
+     * Returns the Coupon codes from the Shopper Context.
+     */
+    couponCodes: utilSet<any>;
+    /**
+     * Returns the custom qualifiers from the Shopper Context. Custom qualifiers contain the custom session attributes
+     * set in the Shopper Context.
+     */
+    customQualifiers: utilMap<any, any>;
+    /**
+     * Returns customer group IDs from the Shopper Context to apply. The customer group IDs set in Shopper Context
+     * evaluate to customer groups that trigger the promotions (campaign assignment) assigned to the customer groups.
+     */
+    customerGroupIDs: utilSet<any>;
+    /**
+     * Returns the effective date time from the Shopper Context. With the effective date time you can retrieve
+     * promotions that are active at a particular time. For example, "Shop the Future" use cases.
+     */
+    effectiveDateTime: Date;
+    /**
+     * Returns the geographic location from the Shopper Context.
+     */
+    geolocation: Geolocation;
+    /**
+     * Returns the source code from the Shopper Context. The source code set in Shopper Context evaluates to source code
+     * group that triggers the promotion (campaign assignment) and Price books (assigned to Source code group).
+     */
+    sourceCode: string;
+    /**
+     * Constructor for ShopperContext.
+     * 
+     * This constructor is used to create an empty object. The object will be empty and must be populated with the
+     * appropriate setter methods. For example:
+     * @example
+     * `
+     * ShopperContext context = new ShopperContext();
+     * context.setSourceCode( "sourcecode" );
+     * ShopperContextMgr.setShopperContext( context, true );
+     * `
+     */
+    constructor();
+    /**
+     * Returns the assignment qualifiers from the Shopper Context. Assignment qualifiers are set when using the
+     * assignment framework to trigger pricing and promotion experiences for Products, Product Search, Basket, Shipping
+     * methods etc.
+     */
+    getAssignmentQualifiers(): utilMap<any, any>;
+    /**
+     * Returns the IP address of the client from the Shopper Context.
+     */
+    getClientIP(): string;
+    /**
+     * Returns the Coupon codes from the Shopper Context.
+     */
+    getCouponCodes(): utilSet<any>;
+    /**
+     * Returns the custom qualifiers from the Shopper Context. Custom qualifiers contain the custom session attributes
+     * set in the Shopper Context.
+     */
+    getCustomQualifiers(): utilMap<any, any>;
+    /**
+     * Returns customer group IDs from the Shopper Context to apply. The customer group IDs set in Shopper Context
+     * evaluate to customer groups that trigger the promotions (campaign assignment) assigned to the customer groups.
+     */
+    getCustomerGroupIDs(): utilSet<any>;
+    /**
+     * Returns the effective date time from the Shopper Context. With the effective date time you can retrieve
+     * promotions that are active at a particular time. For example, "Shop the Future" use cases.
+     */
+    getEffectiveDateTime(): Date;
+    /**
+     * Returns the geographic location from the Shopper Context.
+     */
+    getGeolocation(): Geolocation;
+    /**
+     * Returns the source code from the Shopper Context. The source code set in Shopper Context evaluates to source code
+     * group that triggers the promotion (campaign assignment) and Price books (assigned to Source code group).
+     */
+    getSourceCode(): string;
+    /**
+     * Sets the assignment qualifiers in the Shopper Context. Assignment qualifiers are set when using the assignment
+     * framework to trigger pricing and promotion experiences for Products, Product Search, Basket, Shipping methods
+     * etc.
+     * 
+     * Example: Assignment qualifier for store can be set as follows:
+     * @example
+     * `
+     * var assignmentQualifiers = new dw.util.HashMap();
+     * assignmentQualifiers.put( "storeId", "Boston" );
+     * ShopperContext context = new ShopperContext();
+     * context.setAssignmentQualifiers( customQualifiers );
+     * ShopperContextMgr.setShopperContext( context, true );
+     * `
+     */
+    setAssignmentQualifiers(assignmentQualifiers: utilMap<any, any>): void;
+    /**
+     * Sets the IP address of the client in the Shopper Context. The client IP evaluates to a geolocation. If the client
+     * IP address is not a valid IPv4/IPv6 address an error is thrown.
+     */
+    setClientIP(clientIP: string): void;
+    /**
+     * Sets the Coupon codes in the Shopper Context. When you set coupon codes, it is saved as context for subsequent
+     * requests and can then trigger promotions via the campaign which are tied to the coupon. A maximum of 5 coupon
+     * codes can be set in the ShopperContext.
+     */
+    setCouponCodes(couponCodes: utilSet<any>): void;
+    /**
+     * Sets the session custom attributes as custom qualifiers in the Shopper Context. Custom qualifiers are set when
+     * you want to trigger pricing and promotion experiences using a dynamic session-based customer groups.
+     * 
+     * Example: A session custom attribute 'device_type' can be saved as follows:
+     * @example
+     * `
+     * var customQualifiers = new dw.util.HashMap();
+     * customQualifiers.put( "deviceType", "iPad" );
+     * ShopperContext context = new ShopperContext();
+     * context.setCustomQualifiers( customQualifiers );
+     * ShopperContextMgr.setShopperContext( context, true );
+     * `
+     */
+    setCustomQualifiers(customQualifiers: utilMap<any, any>): void;
+    /**
+     * Sets the customer group IDs for the Shopper Context to apply. Set the customer group IDs to evaluate customer
+     * groups that trigger the promotions (campaign assignment) assigned to the customer groups.
+     */
+    setCustomerGroupIDs(customerGroupIDs: utilSet<any>): void;
+    /**
+     * Sets the effective date time for the context to apply. With the effective date time you can retrieve promotions
+     * that are active at a particular time. For example, "Shop the Future" use cases.
+     */
+    setEffectiveDateTime(effectiveDateTime: Date): void;
+    /**
+     * Sets the geographic location of the client in the Shopper Context. When you set a geolocation, it is saved as
+     * context for subsequent requests. This overrides any context previously saved using clientIP in the Shopper
+     * Context.
+     */
+    setGeolocation(geolocation: Geolocation): void;
+    /**
+     * Sets the source code for the Shopper Context to apply. Set the source code to evaluate source code group that
+     * triggers the promotion (campaign assignment) and Price books (assigned to Source code group).
+     */
+    setSourceCode(sourceCode: string): void;
+}
+
+export = ShopperContext;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/shoppercontext/ShopperContextErrorCodes.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Helper class containing error codes to indicate why a Shopper Context cannot be accessed, set or modified.
+ */
+declare class ShopperContextErrorCodes {
+    /**
+     * Indicates that the assignment qualifiers limit exceeded
+     */
+    static readonly ASSIGNMENT_QUALIFIERS_LIMIT_EXCEEDED = "ASSIGNMENT_QUALIFIERS_LIMIT_EXCEEDED";
+    /**
+     * Indicates that the coupon codes limit exceeded
+     */
+    static readonly COUPON_CODES_LIMIT_EXCEEDED = "COUPON_CODES_LIMIT_EXCEEDED";
+    /**
+     * Indicates that the custom qualifiers limit exceeded
+     */
+    static readonly CUSTOM_QUALIFIERS_LIMIT_EXCEEDED = "CUSTOM_QUALIFIERS_LIMIT_EXCEEDED";
+    /**
+     * Indicates that the feature toggle 'ShopperContextEnabled' is not enabled.
+     */
+    static readonly FEATURE_DISABLED = "FEATURE_DISABLED";
+    /**
+     * Indicates that an internal error occurred while setting, retrieving or deleting the shopper context
+     */
+    static readonly INTERNAL_ERROR = "INTERNAL_ERROR";
+    /**
+     * Indicates an invalid argument was provided
+     */
+    static readonly INVALID_ARGUMENT = "INVALID_ARGUMENT";
+    /**
+     * Indicates that the request type is invalid. Request must be a SCAPI request, or a hybrid storefront request, or
+     * an ocapi request using a SLAS token.
+     */
+    static readonly INVALID_REQUEST_TYPE = "INVALID_REQUEST_TYPE";
+    /**
+     * Indicates that the quota limit for the shopper context has been reached.
+     */
+    static readonly QUOTA_LIMIT_EXCEEDED = "QUOTA_LIMIT_EXCEEDED";
+    private constructor();
+}
+
+export = ShopperContextErrorCodes;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/shoppercontext/ShopperContextException.d.ts

@@ -0,0 +1,48 @@
+/**
+ * This exception could be thrown by
+ * dw.customer.shoppercontext.ShopperContextMgr.setShopperContext,
+ * dw.customer.shoppercontext.ShopperContextMgr.getShopperContext and
+ * ShopperContextMgr.removeShopperContext when an error occurs.
+ * 
+ * 'errorCode' property is set to one of the following values:
+ * 
+ * - dw.customer.shoppercontext.ShopperContextErrorCodes.FEATURE_DISABLED = Indicates that the Shopper Context
+ * Feature is not enabled.
+ * - dw.customer.shoppercontext.ShopperContextErrorCodes.CUSTOM_QUALIFIERS_LIMIT_EXCEEDED = Indicates that the
+ * number of custom qualifiers in dw.customer.shoppercontext.ShopperContext has exceeded the allowed limit.
+ * - dw.customer.shoppercontext.ShopperContextErrorCodes.ASSIGNMENT_QUALIFIERS_LIMIT_EXCEEDED = Indicates that
+ * the number of assignment qualifiers in dw.customer.shoppercontext.ShopperContext has exceeded the allowed
+ * limit.
+ * - dw.customer.shoppercontext.ShopperContextErrorCodes.QUOTA_LIMIT_EXCEEDED = Indicates that the quota limit
+ * for the Shopper Context has been reached.
+ * 
+ * For more information on shopper context quota limits please refer to:
+ * Shopper Context Quota Limits
+ * 
+ * - dw.customer.shoppercontext.ShopperContextErrorCodes.INTERNAL_ERROR = Indicates that an error occurred
+ * while setting, retrieving or deleting the shopper context.
+ * - dw.customer.shoppercontext.ShopperContextErrorCodes.INVALID_ARGUMENT = Indicates that an invalid client
+ * IP address was set in the Shopper Context.
+ * - dw.customer.shoppercontext.ShopperContextErrorCodes.INVALID_REQUEST_TYPE = Indicates that the request
+ * type is invalid. Request must be a SCAPI request, or a hybrid storefront request, or an OCAPI request using a SLAS
+ * token.
+ */
+declare class ShopperContextException {
+    /**
+     * Indicates reason why the following methods failed:
+     * dw.customer.shoppercontext.ShopperContextMgr.setShopperContext or
+     * dw.customer.shoppercontext.ShopperContextMgr.getShopperContext or
+     * dw.customer.shoppercontext.ShopperContextMgr.removeShopperContext failed.
+     */
+    readonly errorCode: string;
+    private constructor();
+    /**
+     * Indicates reason why the following methods failed:
+     * dw.customer.shoppercontext.ShopperContextMgr.setShopperContext or
+     * dw.customer.shoppercontext.ShopperContextMgr.getShopperContext or
+     * dw.customer.shoppercontext.ShopperContextMgr.removeShopperContext failed.
+     */
+    getErrorCode(): string;
+}
+
+export = ShopperContextException;