commerce-sdk-isomorphic 3.4.0 → 4.0.1-preview-shopper-test.0

package/lib/shopperContext.d.ts

@@ -0,0 +1,1401 @@
+/*
+* Copyright (c) 2021, salesforce.com, inc.
+* All rights reserved.
+* SPDX-License-Identifier: BSD-3-Clause
+* For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+*/
+import { RequestInit as NodeRequestInit } from "node-fetch";
+/*
+* Copyright (c) 2025, Salesforce, Inc.
+* All rights reserved.
+* SPDX-License-Identifier: BSD-3-Clause
+* For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+*/
+declare const defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/shopper/shopper-context/v1";
+/**
+ * Makes a type easier to read.
+ */
+type Prettify<T> = NonNullable<{
+    [K in keyof T]: T[K];
+}>;
+/**
+ * Generates the types required on a method, based on those provided in the config.
+ */
+type CompositeParameters<MethodParameters extends Record<string, unknown>, ConfigParameters extends Record<string, unknown>> = Prettify<Omit<MethodParameters, keyof ConfigParameters> & Partial<MethodParameters>>;
+/**
+ * If an object has a `parameters` property, and the `parameters` object has required properties,
+ * then the `parameters` property on the root object is marked as required.
+ */
+type RequireParametersUnlessAllAreOptional<T extends {
+    parameters?: Record<string, unknown>;
+}> = Record<string, never> extends NonNullable<T["parameters"]> ? T : Prettify<T & Required<Pick<T, "parameters">>>;
+/**
+ * Template parameters used in the base URI of all API endpoints. `version` will default to `"v1"`
+ * if not specified.
+ */
+interface BaseUriParameters {
+    shortCode: string;
+}
+type LocaleCode = {
+    [key: string]: any;
+};
+/**
+ * Generic interface for path parameters.
+ */
+interface PathParameters {
+    [key: string]: string | number | boolean;
+}
+/**
+ * Generic interface for query parameters.
+ */
+interface QueryParameters {
+    [key: string]: string | number | boolean | string[] | number[] | LocaleCode;
+}
+/**
+ * Custom body request type with any string prefixed with `c_` as the key and the allowed
+ * types for the value.
+ */
+type CustomRequestBody = {
+    [key in `c_${string}`]: string | number | boolean | string[] | number[] | {
+        [key: string]: unknown;
+    };
+};
+/**
+ * Alias for `RequestInit` from TypeScript's DOM lib, to more clearly differentiate
+ * it from the `RequestInit` provided by node-fetch.
+ */
+type BrowserRequestInit = RequestInit;
+/**
+ * Any properties supported in either the browser or node are accepted.
+ * Using the right properties in the right context is left to the user.
+ */
+type FetchOptions = NodeRequestInit & BrowserRequestInit;
+/**
+ * Base options that can be passed to the `ClientConfig` class.
+ */
+interface ClientConfigInit<Params extends BaseUriParameters> {
+    baseUri?: string;
+    proxy?: string;
+    headers?: {
+        [key: string]: string;
+    };
+    parameters: Params;
+    fetchOptions?: FetchOptions;
+    transformRequest?: (data: unknown, headers: {
+        [key: string]: string;
+    }) => Required<FetchOptions>["body"];
+    throwOnBadResponse?: boolean;
+}
+/**
+ * Configuration parameters common to Commerce SDK clients
+ */
+declare class ClientConfig<Params extends BaseUriParameters> implements ClientConfigInit<Params> {
+    baseUri?: string;
+    proxy?: string;
+    headers: {
+        [key: string]: string;
+    };
+    parameters: Params;
+    fetchOptions: FetchOptions;
+    transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
+    throwOnBadResponse: boolean;
+    constructor(config: ClientConfigInit<Params>);
+    static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
+}
+/**
+ * @type ErrorResponse:
+ *
+ * @property title: A short, human-readable summary of the problem type.  It will not change from occurrence to occurrence of the  problem, except for purposes of localization
+ * - **Max Length:** 256
+ *
+ * @property type: A URI reference [RFC3986] that identifies the problem type.  This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]).  When this member is not present, its value is assumed to be \"about:blank\". It accepts relative URIs; this means that they must be resolved relative to the document\'s base URI, as per [RFC3986], Section 5.
+ * - **Max Length:** 2048
+ *
+ * @property detail: A human-readable explanation specific to this occurrence of the problem.
+ *
+ * @property instance: A URI reference that identifies the specific occurrence of the problem.  It may or may not yield further information if dereferenced.  It accepts relative URIs; this means that they must be resolved relative to the document\'s base URI, as per [RFC3986], Section 5.
+ * - **Max Length:** 2048
+ *
+ */
+type ErrorResponse = {
+    title: string;
+    type: string;
+    detail: string;
+    instance?: string;
+} & {
+    [key: string]: any;
+};
+/**
+ * @type ShopperContextGeoLocation: The geographic location of the client. When you set a geolocation, it is saved as context for subsequent requests. This overrides any geolocation context previously saved using `clientIp`. This property is available with B2C Commerce version 24.7.
+ *
+ * @property city: The city name associated with this location.
+ *
+ * @property country: The country name associated with this location.
+ *
+ * @property countryCode: The ISO country code associated with this location.
+ *
+ * @property latitude: The latitude coordinate, which is a number between -90.0 and +90.0, associated with this location.
+ *
+ * @property longitude: The longitude coordinate, which is a number between -180.0 and +180.0, associated with this location.
+ *
+ * @property metroCode: The metro code associated with this location.
+ *
+ * @property postalCode: The postal code associated with this location.
+ *
+ * @property region: The region (subdivision) name for this location. Corresponds with \"state\" in the USA.
+ *
+ * @property regionCode: The region (province or state) code for this location.
+ *
+ */
+type ShopperContextGeoLocation = {
+    city?: string;
+    country?: string;
+    countryCode?: string;
+    latitude?: number;
+    longitude?: number;
+    metroCode?: string;
+    postalCode?: string;
+    region?: string;
+    regionCode?: string;
+} & {
+    [key: string]: any;
+};
+/**
+ * @type ShopperContext: A shoppers\' context represented as key-value string pairs.
+ *
+ * @property effectiveDateTime: Qualifier to set the effective date time for the context to apply. For example, \"Shop the Future\" use cases. If not provided, the current dateTime will be assumed.
+ *
+ * @property sourceCode: Qualifier to set the source code for the 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).
+ *
+ * @property customerGroupIds: Qualifier to set the Customer Group Ids for the context to apply. Set the Customer Group Ids to evaluate customer groups that trigger the promotions (campaign assignment) assigned to the customer groups.
+ *
+ * @property customQualifiers: Map of custom qualifiers for the shopper context. Set this object to trigger pricing and promotion experiences using a dynamic session-based customer group. Object size is limited to 20 key-value pairs (properties).
+ *
+ * @property assignmentQualifiers: Map of assignment qualifiers for the shopper context. Set this object when using the assignment framework to activate experiences based on assignment qualifiers. Currently, only pricing and promotion experiences are supported. Object size is limited to 20 key-value pairs (properties).
+ *
+ * @property clientIp: The IP Address of the client. If the client IP is not a valid IPv4 address, a Bad Request (400) error is thrown. This property is available with B2C Commerce version 24.7.  When `clientIp` is set, the geolocation based on the `clientIp` is returned in the `X-Geolocation` header in the response. Note: Use/retrieve this header in a case insensitive manner.  However, if the `geoLocation` attribute is also set in the context, it takes precedence over the `clientIp`, and the `X-Geolocation` header returns the geolocation based on the `geoLocation` attribute.  The query parameter `evaluateContextWithClientIp` determines whether to evaluate the context using the provided `clientIp`.   - If `evaluateContextWithClientIp` is set to `true`:     - The `clientIp` is saved and used in subsequent requests.           Note: If `geoLocation` is also saved in the context, it takes precedence over the `clientIp`.   - If `evaluateContextWithClientIp` is set to `false`:     - The `clientIp` is not saved and is not used in subsequent requests.
+ *
+ * @property geoLocation:
+ *
+ */
+type ShopperContext = {
+    effectiveDateTime?: string | null;
+    sourceCode?: string | null;
+    customerGroupIds?: Array<string>;
+    customQualifiers?: {
+        [key: string]: string | null;
+    };
+    assignmentQualifiers?: {
+        [key: string]: string | null;
+    };
+    clientIp?: string;
+    geoLocation?: ShopperContextGeoLocation;
+} & {
+    [key: string]: any;
+};
+type createShopperContextQueryParameters = {
+    siteId: string;
+    evaluateContextWithClientIp?: boolean;
+};
+type createShopperContextPathParameters = {
+    usid: string;
+    organizationId: string;
+};
+type deleteShopperContextQueryParameters = {
+    siteId: string;
+};
+type deleteShopperContextPathParameters = {
+    usid: string;
+    organizationId: string;
+};
+type getShopperContextQueryParameters = {
+    siteId: string;
+};
+type getShopperContextPathParameters = {
+    usid: string;
+    organizationId: string;
+};
+type updateShopperContextQueryParameters = {
+    siteId: string;
+    evaluateContextWithClientIp?: boolean;
+};
+type updateShopperContextPathParameters = {
+    usid: string;
+    organizationId: string;
+};
+/**
+ * All path parameters that are used by at least one ShopperContext method.
+ */
+type ShopperContextPathParameters = Partial<createShopperContextPathParameters & deleteShopperContextPathParameters & getShopperContextPathParameters & updateShopperContextPathParameters & {}>;
+/**
+ * All query parameters that are used by at least one ShopperContext method.
+ */
+type ShopperContextQueryParameters = Partial<createShopperContextQueryParameters & deleteShopperContextQueryParameters & getShopperContextQueryParameters & updateShopperContextQueryParameters & {}>;
+/**
+ * All parameters that are used by ShopperContext.
+ */
+type ShopperContextParameters = ShopperContextPathParameters & BaseUriParameters & ShopperContextQueryParameters;
+/**
+ * [Shopper Context](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-context:Summary)
+ * ==================================
+ *
+ * *# API Overview
+ 
+ With the Shopper Context API, you can set any context information as a key/value pair and use it to retrieve personalized promotions, payment methods, and shipping methods. The context information that is set is evaluated against the customer group definitions to determine a customer group (shopper segment), and is then used to activate the experiences that are associated with a particular segment, such as promotions.
+ 
+ You can also get personalized API responses triggered by shopper context from the [Open Commerce API](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-commerce-ocapi/get-started-with-ocapi.html) (OCAPI). Support for both the B2C Commerce API and OCAPI allows shopper context to be used in hybrid deployments.
+ 
+ **Warning**
+ Access tokens with a scope that includes the Shopper Context API are powerful. They can activate specific promotions and can be used to see how a storefront would be displayed in the future. Don't share them with untrusted clients like web browsers or client apps.
+ 
+ Make Shopper Context calls with a private client and only set shopper context through a secure backend channel. To avoid misuse, do not make direct calls through a browser or similar client in which data can be viewed.
+ 
+ As part of this, when creating a SLAS public client for a tenant, if you attempt to add the Shopper Context API scope, a warning message is displayed to ensure you are aware of the pitfalls of doing so.
+ 
+ **Note**:
+ 
+ Shopper context is valid for 1 day for guest shoppers and 7 days for registered shoppers. To extend the context set, create a new context. As a best practice, refresh your contexts periodically to ensure that the right personalized experience is rendered for your shoppers.
+ 
+ ## Authentication & Authorization
+ 
+ The Shopper Context API requires a shopper access token from the Shopper Login and API Access Service (SLAS).
+ 
+ For details on how to request a shopper access token from SLAS, see the guest user flows for [public clients](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas-public-client.html) and [private clients](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas-private-client.html) in the SLAS guides.
+ 
+ Add `sfcc.shopper-context.rw` to the scopes configuration for the SLAS API client.
+ 
+ For more information, see [Authorization for Shopper APIs](https://developer.salesforce.com/docs/commerce/commerce-api/guide/authorization-for-shopper-apis.html) in the Get Started guides.
+ 
+ **Warning**: As with all APIs, never store access tokens in the browser because this creates a security vulnerability.
+ 
+ ## Use Cases
+ 
+ For detailed usage information, see the [Shopper Context guides](https://developer.salesforce.com/docs/commerce/commerce-api/guide/shopper-context-api.html).*<br />
+ *
+ * Simple example:
+ *
+ * ```typescript
+ *   import { ShopperContext } from "commerce-sdk-isomorphic";
+ *
+ *   const clientConfig = {
+ *     parameters: {
+ *       clientId: "XXXXXX",
+ *       organizationId: "XXXX",
+ *       shortCode: "XXX",
+ *       siteId: "XX"
+ *     }
+ *   };
+ *   const shopperContextClient = new ShopperContext(clientConfig);
+ * ```
+ *
+ * <span style="font-size:.7em; display:block; text-align: right">
+ * API Version: 0.0.33<br />
+ * Last Updated: <br />
+ * </span>
+ *
+ *
+ */
+declare class ShopperContexts<ConfigParameters extends ShopperContextParameters & Record<string, unknown>> {
+    // baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
+    clientConfig: ClientConfig<ConfigParameters> & {
+        baseUri: string;
+    };
+    static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/shopper/shopper-context/v1";
+    static readonly apiPaths: {
+        createShopperContext: string;
+        deleteShopperContext: string;
+        getShopperContext: string;
+        updateShopperContext: string;
+    };
+    constructor(config: ClientConfigInit<ConfigParameters>);
+    static readonly paramKeys: {
+        readonly createShopperContext: readonly [
+            "usid",
+            "organizationId",
+            "siteId",
+            "evaluateContextWithClientIp"
+        ];
+        readonly createShopperContextRequired: readonly [
+            "usid",
+            "organizationId",
+            "siteId"
+        ];
+        readonly deleteShopperContext: readonly [
+            "usid",
+            "organizationId",
+            "siteId"
+        ];
+        readonly deleteShopperContextRequired: readonly [
+            "usid",
+            "organizationId",
+            "siteId"
+        ];
+        readonly getShopperContext: readonly [
+            "usid",
+            "organizationId",
+            "siteId"
+        ];
+        readonly getShopperContextRequired: readonly [
+            "usid",
+            "organizationId",
+            "siteId"
+        ];
+        readonly updateShopperContext: readonly [
+            "usid",
+            "organizationId",
+            "siteId",
+            "evaluateContextWithClientIp"
+        ];
+        readonly updateShopperContextRequired: readonly [
+            "usid",
+            "organizationId",
+            "siteId"
+        ];
+    };
+    /**
+     *
+     *
+     * If you would like to get a raw Response object use the other createShopperContext function.
+     *
+     * @param options - An object containing the options for this method.
+     * @param options.parameters - An object containing the parameters for this method.
+     * @param options.parameters.usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
+     * @param options.parameters.organizationId - An identifier for the organization the request is being made by
+     * @param options.parameters.siteId - The site context.
+     * @param options.parameters.evaluateContextWithClientIp - Determines whether to evaluate the context using the provided `clientIp`.  This property is available with B2C Commerce version 24.7.
+     - If `evaluateContextWithClientIp` is set to `true`:
+     - The `clientIP` is saved and used in subsequent requests.
+     
+     - If `evaluateContextWithClientIp` is set to `false`:
+     - The `clientIP` is not saved and will not be used in subsequent requests.
+     
+     * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
+     * @param options.body - The data to send as the request body.
+     *
+     * @returns A promise of type void.
+     */
+    createShopperContext(options: RequireParametersUnlessAllAreOptional<{
+        parameters?: CompositeParameters<{
+            usid: string;
+            organizationId: string;
+            siteId: string;
+            evaluateContextWithClientIp?: boolean;
+        } & QueryParameters, ConfigParameters>;
+        headers?: {
+            [key: string]: string;
+        };
+        body: ShopperContext & CustomRequestBody;
+    }>): Promise<void>;
+    /**
+     *
+     *
+     * @param options - An object containing the options for this method.
+     * @param options.parameters - An object containing the parameters for this method.
+     * @param options.parameters.usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
+     * @param options.parameters.organizationId - An identifier for the organization the request is being made by
+     * @param options.parameters.siteId - The site context.
+     * @param options.parameters.evaluateContextWithClientIp - Determines whether to evaluate the context using the provided `clientIp`.  This property is available with B2C Commerce version 24.7.
+     - If `evaluateContextWithClientIp` is set to `true`:
+     - The `clientIP` is saved and used in subsequent requests.
+     
+     - If `evaluateContextWithClientIp` is set to `false`:
+     - The `clientIP` is not saved and will not be used in subsequent requests.
+     
+     * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
+     * @param options.body - The data to send as the request body.
+     * @param rawResponse - Set to true to return entire Response object instead of DTO.
+     *
+     * @returns A promise of type Response if rawResponse is true, a promise of type void otherwise.
+     */
+    createShopperContext<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
+        parameters?: CompositeParameters<{
+            usid: string;
+            organizationId: string;
+            siteId: string;
+            evaluateContextWithClientIp?: boolean;
+        } & QueryParameters, ConfigParameters>;
+        headers?: {
+            [key: string]: string;
+        };
+        body: ShopperContext & CustomRequestBody;
+    }>, rawResponse?: T): Promise<T extends true ? Response : void>;
+    /**
+     * Get a shopper's context based on the shopperJWT.
+     *
+     * If you would like to get a raw Response object use the other deleteShopperContext function.
+     *
+     * @param options - An object containing the options for this method.
+     * @param options.parameters - An object containing the parameters for this method.
+     * @param options.parameters.usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
+     * @param options.parameters.organizationId - An identifier for the organization the request is being made by
+     * @param options.parameters.siteId - The site context.
+     * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
+     *
+     * @returns A promise of type void.
+     */
+    deleteShopperContext(options?: RequireParametersUnlessAllAreOptional<{
+        parameters?: CompositeParameters<{
+            usid: string;
+            organizationId: string;
+            siteId: string;
+        } & QueryParameters, ConfigParameters>;
+        headers?: {
+            [key: string]: string;
+        };
+    }>): Promise<void>;
+    /**
+     * Get a shopper's context based on the shopperJWT.
+     *
+     * @param options - An object containing the options for this method.
+     * @param options.parameters - An object containing the parameters for this method.
+     * @param options.parameters.usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
+     * @param options.parameters.organizationId - An identifier for the organization the request is being made by
+     * @param options.parameters.siteId - The site context.
+     * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
+     * @param rawResponse - Set to true to return entire Response object instead of DTO.
+     *
+     * @returns A promise of type Response if rawResponse is true, a promise of type void otherwise.
+     */
+    deleteShopperContext<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
+        parameters?: CompositeParameters<{
+            usid: string;
+            organizationId: string;
+            siteId: string;
+        } & QueryParameters, ConfigParameters>;
+        headers?: {
+            [key: string]: string;
+        };
+    }>, rawResponse?: T): Promise<T extends true ? Response : void>;
+    /**
+     *
+     *
+     * If you would like to get a raw Response object use the other getShopperContext function.
+     *
+     * @param options - An object containing the options for this method.
+     * @param options.parameters - An object containing the parameters for this method.
+     * @param options.parameters.usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
+     * @param options.parameters.organizationId - An identifier for the organization the request is being made by
+     * @param options.parameters.siteId - The site context.
+     * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
+     *
+     * @returns A promise of type ShopperContext.
+     */
+    getShopperContext(options?: RequireParametersUnlessAllAreOptional<{
+        parameters?: CompositeParameters<{
+            usid: string;
+            organizationId: string;
+            siteId: string;
+        } & QueryParameters, ConfigParameters>;
+        headers?: {
+            [key: string]: string;
+        };
+    }>): Promise<ShopperContext>;
+    /**
+     *
+     *
+     * @param options - An object containing the options for this method.
+     * @param options.parameters - An object containing the parameters for this method.
+     * @param options.parameters.usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
+     * @param options.parameters.organizationId - An identifier for the organization the request is being made by
+     * @param options.parameters.siteId - The site context.
+     * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
+     * @param rawResponse - Set to true to return entire Response object instead of DTO.
+     *
+     * @returns A promise of type Response if rawResponse is true, a promise of type ShopperContext otherwise.
+     */
+    getShopperContext<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
+        parameters?: CompositeParameters<{
+            usid: string;
+            organizationId: string;
+            siteId: string;
+        } & QueryParameters, ConfigParameters>;
+        headers?: {
+            [key: string]: string;
+        };
+    }>, rawResponse?: T): Promise<T extends true ? Response : ShopperContext>;
+    /**
+     * If the shopper context exists, it's updated with the patch body.
+     - If a new attribute that does not exist in the existing shopper context is present, it is added to the context.
+     -If an attribute is already present in the existing shopper context, its value is replaced by the corresponding value from the new shopper context in the request body as follows:
+     - `custom qualifiers` or `assignment qualifiers`:
+     
+     If the individual qualifier key exists, it is overwritten with the new value.
+     
+     If the value of the key is set to null, it is deleted from the existing shopper context.
+     
+     If an empty `custom qualifiers` or `assignment qualifiers` object `{}` is passed, the entire qualifier object is deleted.
+     - `effectiveDateTime` or `sourceCode` or `clientIp`:
+     
+     If the new value is set to an empty string (""), it is deleted from the existing shopper context.
+     
+     If the new value is set to null, it is ignored.
+     
+     If the new value is not empty or null, it overwrites the existing value.
+     
+     - `customerGroupIds`:
+     
+     If a list of `customerGroupIds` exists, it is replaced by the new list of customer group IDs from the request.
+     
+     If `customerGroupIds` is set to an empty array [], the existing list in the shopper context is deleted.
+     
+     - `geoLocation`:
+     
+     If it exists, the entire `geoLocation` object is replaced with the new value.
+     
+     If the new value is set to null, it is ignored.
+     
+     If an empty `geoLocation` object `{}` is passed, it is deleted.
+     *
+     * If you would like to get a raw Response object use the other updateShopperContext function.
+     *
+     * @param options - An object containing the options for this method.
+     * @param options.parameters - An object containing the parameters for this method.
+     * @param options.parameters.usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
+     * @param options.parameters.organizationId - An identifier for the organization the request is being made by
+     * @param options.parameters.siteId - The site context.
+     * @param options.parameters.evaluateContextWithClientIp - Determines whether to evaluate the context using the provided `clientIp`.  This property is available with B2C Commerce version 24.7.
+     - If `evaluateContextWithClientIp` is set to `true`:
+     - The `clientIP` is saved and used in subsequent requests.
+     
+     - If `evaluateContextWithClientIp` is set to `false`:
+     - The `clientIP` is not saved and will not be used in subsequent requests.
+     
+     * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
+     * @param options.body - The data to send as the request body.
+     *
+     * @returns A promise of type ShopperContext.
+     */
+    updateShopperContext(options: RequireParametersUnlessAllAreOptional<{
+        parameters?: CompositeParameters<{
+            usid: string;
+            organizationId: string;
+            siteId: string;
+            evaluateContextWithClientIp?: boolean;
+        } & QueryParameters, ConfigParameters>;
+        headers?: {
+            [key: string]: string;
+        };
+        body: ShopperContext & CustomRequestBody;
+    }>): Promise<ShopperContext>;
+    /**
+     * If the shopper context exists, it's updated with the patch body.
+     - If a new attribute that does not exist in the existing shopper context is present, it is added to the context.
+     -If an attribute is already present in the existing shopper context, its value is replaced by the corresponding value from the new shopper context in the request body as follows:
+     - `custom qualifiers` or `assignment qualifiers`:
+     
+     If the individual qualifier key exists, it is overwritten with the new value.
+     
+     If the value of the key is set to null, it is deleted from the existing shopper context.
+     
+     If an empty `custom qualifiers` or `assignment qualifiers` object `{}` is passed, the entire qualifier object is deleted.
+     - `effectiveDateTime` or `sourceCode` or `clientIp`:
+     
+     If the new value is set to an empty string (""), it is deleted from the existing shopper context.
+     
+     If the new value is set to null, it is ignored.
+     
+     If the new value is not empty or null, it overwrites the existing value.
+     
+     - `customerGroupIds`:
+     
+     If a list of `customerGroupIds` exists, it is replaced by the new list of customer group IDs from the request.
+     
+     If `customerGroupIds` is set to an empty array [], the existing list in the shopper context is deleted.
+     
+     - `geoLocation`:
+     
+     If it exists, the entire `geoLocation` object is replaced with the new value.
+     
+     If the new value is set to null, it is ignored.
+     
+     If an empty `geoLocation` object `{}` is passed, it is deleted.
+     *
+     * @param options - An object containing the options for this method.
+     * @param options.parameters - An object containing the parameters for this method.
+     * @param options.parameters.usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
+     * @param options.parameters.organizationId - An identifier for the organization the request is being made by
+     * @param options.parameters.siteId - The site context.
+     * @param options.parameters.evaluateContextWithClientIp - Determines whether to evaluate the context using the provided `clientIp`.  This property is available with B2C Commerce version 24.7.
+     - If `evaluateContextWithClientIp` is set to `true`:
+     - The `clientIP` is saved and used in subsequent requests.
+     
+     - If `evaluateContextWithClientIp` is set to `false`:
+     - The `clientIP` is not saved and will not be used in subsequent requests.
+     
+     * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
+     * @param options.body - The data to send as the request body.
+     * @param rawResponse - Set to true to return entire Response object instead of DTO.
+     *
+     * @returns A promise of type Response if rawResponse is true, a promise of type ShopperContext otherwise.
+     */
+    updateShopperContext<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
+        parameters?: CompositeParameters<{
+            usid: string;
+            organizationId: string;
+            siteId: string;
+            evaluateContextWithClientIp?: boolean;
+        } & QueryParameters, ConfigParameters>;
+        headers?: {
+            [key: string]: string;
+        };
+        body: ShopperContext & CustomRequestBody;
+    }>, rawResponse?: T): Promise<T extends true ? Response : ShopperContext>;
+}
+declare namespace ShopperContextsApiTypes {
+    /*
+    * Copyright (c) 2023, Salesforce, Inc.
+    * All rights reserved.
+    * SPDX-License-Identifier: BSD-3-Clause
+    * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+    */
+    /**
+     * Makes a type easier to read.
+     */
+    type Prettify<T> = NonNullable<{
+        [K in keyof T]: T[K];
+    }>;
+    /**
+     * Generates the types required on a method, based on those provided in the config.
+     */
+    type CompositeParameters<MethodParameters extends Record<string, unknown>, ConfigParameters extends Record<string, unknown>> = Prettify<Omit<MethodParameters, keyof ConfigParameters> & Partial<MethodParameters>>;
+    /**
+     * If an object has a `parameters` property, and the `parameters` object has required properties,
+     * then the `parameters` property on the root object is marked as required.
+     */
+    type RequireParametersUnlessAllAreOptional<T extends {
+        parameters?: Record<string, unknown>;
+    }> = Record<string, never> extends NonNullable<T["parameters"]> ? T : Prettify<T & Required<Pick<T, "parameters">>>;
+    /**
+     * Template parameters used in the base URI of all API endpoints. `version` will default to `"v1"`
+     * if not specified.
+     */
+    interface BaseUriParameters {
+        shortCode: string;
+    }
+    type LocaleCode = {
+        [key: string]: any;
+    };
+    /**
+     * Generic interface for path parameters.
+     */
+    interface PathParameters {
+        [key: string]: string | number | boolean;
+    }
+    /**
+     * Generic interface for query parameters.
+     */
+    interface QueryParameters {
+        [key: string]: string | number | boolean | string[] | number[] | LocaleCode;
+    }
+    /**
+     * Generic interface for all parameter types.
+     */
+    type UrlParameters = PathParameters | QueryParameters;
+    /**
+     * Custom query parameter type with any string prefixed with `c_` as the key and the allowed
+     * types for query parameters for the value.
+     */
+    type CustomQueryParameters = {
+        [key in `c_${string}`]: string | number | boolean | string[] | number[];
+    };
+    /**
+     * Custom body request type with any string prefixed with `c_` as the key and the allowed
+     * types for the value.
+     */
+    type CustomRequestBody = {
+        [key in `c_${string}`]: string | number | boolean | string[] | number[] | {
+            [key: string]: unknown;
+        };
+    };
+    /**
+     * Alias for `RequestInit` from TypeScript's DOM lib, to more clearly differentiate
+     * it from the `RequestInit` provided by node-fetch.
+     */
+    type BrowserRequestInit = RequestInit;
+    /**
+     * Any properties supported in either the browser or node are accepted.
+     * Using the right properties in the right context is left to the user.
+     */
+    type FetchOptions = NodeRequestInit & BrowserRequestInit;
+    /**
+     * Base options that can be passed to the `ClientConfig` class.
+     */
+    interface ClientConfigInit<Params extends BaseUriParameters> {
+        baseUri?: string;
+        proxy?: string;
+        headers?: {
+            [key: string]: string;
+        };
+        parameters: Params;
+        fetchOptions?: FetchOptions;
+        transformRequest?: (data: unknown, headers: {
+            [key: string]: string;
+        }) => Required<FetchOptions>["body"];
+        throwOnBadResponse?: boolean;
+    }
+    type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
+    /**
+     * Configuration parameters common to Commerce SDK clients
+     */
+    class ClientConfig<Params extends BaseUriParameters> implements ClientConfigInit<Params> {
+        baseUri?: string;
+        proxy?: string;
+        headers: {
+            [key: string]: string;
+        };
+        parameters: Params;
+        fetchOptions: FetchOptions;
+        transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
+        throwOnBadResponse: boolean;
+        constructor(config: ClientConfigInit<Params>);
+        static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
+    }
+    /**
+     * @type ErrorResponse:
+     *
+     * @property title: A short, human-readable summary of the problem type.  It will not change from occurrence to occurrence of the  problem, except for purposes of localization
+     * - **Max Length:** 256
+     *
+     * @property type: A URI reference [RFC3986] that identifies the problem type.  This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]).  When this member is not present, its value is assumed to be \"about:blank\". It accepts relative URIs; this means that they must be resolved relative to the document\'s base URI, as per [RFC3986], Section 5.
+     * - **Max Length:** 2048
+     *
+     * @property detail: A human-readable explanation specific to this occurrence of the problem.
+     *
+     * @property instance: A URI reference that identifies the specific occurrence of the problem.  It may or may not yield further information if dereferenced.  It accepts relative URIs; this means that they must be resolved relative to the document\'s base URI, as per [RFC3986], Section 5.
+     * - **Max Length:** 2048
+     *
+     */
+    type ErrorResponse = {
+        title: string;
+        type: string;
+        detail: string;
+        instance?: string;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type ShopperContextGeoLocation: The geographic location of the client. When you set a geolocation, it is saved as context for subsequent requests. This overrides any geolocation context previously saved using `clientIp`. This property is available with B2C Commerce version 24.7.
+     *
+     * @property city: The city name associated with this location.
+     *
+     * @property country: The country name associated with this location.
+     *
+     * @property countryCode: The ISO country code associated with this location.
+     *
+     * @property latitude: The latitude coordinate, which is a number between -90.0 and +90.0, associated with this location.
+     *
+     * @property longitude: The longitude coordinate, which is a number between -180.0 and +180.0, associated with this location.
+     *
+     * @property metroCode: The metro code associated with this location.
+     *
+     * @property postalCode: The postal code associated with this location.
+     *
+     * @property region: The region (subdivision) name for this location. Corresponds with \"state\" in the USA.
+     *
+     * @property regionCode: The region (province or state) code for this location.
+     *
+     */
+    type ShopperContextGeoLocation = {
+        city?: string;
+        country?: string;
+        countryCode?: string;
+        latitude?: number;
+        longitude?: number;
+        metroCode?: string;
+        postalCode?: string;
+        region?: string;
+        regionCode?: string;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type ShopperContext: A shoppers\' context represented as key-value string pairs.
+     *
+     * @property effectiveDateTime: Qualifier to set the effective date time for the context to apply. For example, \"Shop the Future\" use cases. If not provided, the current dateTime will be assumed.
+     *
+     * @property sourceCode: Qualifier to set the source code for the 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).
+     *
+     * @property customerGroupIds: Qualifier to set the Customer Group Ids for the context to apply. Set the Customer Group Ids to evaluate customer groups that trigger the promotions (campaign assignment) assigned to the customer groups.
+     *
+     * @property customQualifiers: Map of custom qualifiers for the shopper context. Set this object to trigger pricing and promotion experiences using a dynamic session-based customer group. Object size is limited to 20 key-value pairs (properties).
+     *
+     * @property assignmentQualifiers: Map of assignment qualifiers for the shopper context. Set this object when using the assignment framework to activate experiences based on assignment qualifiers. Currently, only pricing and promotion experiences are supported. Object size is limited to 20 key-value pairs (properties).
+     *
+     * @property clientIp: The IP Address of the client. If the client IP is not a valid IPv4 address, a Bad Request (400) error is thrown. This property is available with B2C Commerce version 24.7.  When `clientIp` is set, the geolocation based on the `clientIp` is returned in the `X-Geolocation` header in the response. Note: Use/retrieve this header in a case insensitive manner.  However, if the `geoLocation` attribute is also set in the context, it takes precedence over the `clientIp`, and the `X-Geolocation` header returns the geolocation based on the `geoLocation` attribute.  The query parameter `evaluateContextWithClientIp` determines whether to evaluate the context using the provided `clientIp`.   - If `evaluateContextWithClientIp` is set to `true`:     - The `clientIp` is saved and used in subsequent requests.           Note: If `geoLocation` is also saved in the context, it takes precedence over the `clientIp`.   - If `evaluateContextWithClientIp` is set to `false`:     - The `clientIp` is not saved and is not used in subsequent requests.
+     *
+     * @property geoLocation:
+     *
+     */
+    type ShopperContext = {
+        effectiveDateTime?: string | null;
+        sourceCode?: string | null;
+        customerGroupIds?: Array<string>;
+        customQualifiers?: {
+            [key: string]: string | null;
+        };
+        assignmentQualifiers?: {
+            [key: string]: string | null;
+        };
+        clientIp?: string;
+        geoLocation?: ShopperContextGeoLocation;
+    } & {
+        [key: string]: any;
+    };
+    type createShopperContextQueryParameters = {
+        siteId: string;
+        evaluateContextWithClientIp?: boolean;
+    };
+    type createShopperContextPathParameters = {
+        usid: string;
+        organizationId: string;
+    };
+    type deleteShopperContextQueryParameters = {
+        siteId: string;
+    };
+    type deleteShopperContextPathParameters = {
+        usid: string;
+        organizationId: string;
+    };
+    type getShopperContextQueryParameters = {
+        siteId: string;
+    };
+    type getShopperContextPathParameters = {
+        usid: string;
+        organizationId: string;
+    };
+    type updateShopperContextQueryParameters = {
+        siteId: string;
+        evaluateContextWithClientIp?: boolean;
+    };
+    type updateShopperContextPathParameters = {
+        usid: string;
+        organizationId: string;
+    };
+    /**
+     * All path parameters that are used by at least one ShopperContext method.
+     */
+    type ShopperContextPathParameters = Partial<createShopperContextPathParameters & deleteShopperContextPathParameters & getShopperContextPathParameters & updateShopperContextPathParameters & {}>;
+    /**
+     * All query parameters that are used by at least one ShopperContext method.
+     */
+    type ShopperContextQueryParameters = Partial<createShopperContextQueryParameters & deleteShopperContextQueryParameters & getShopperContextQueryParameters & updateShopperContextQueryParameters & {}>;
+    /**
+     * All parameters that are used by ShopperContext.
+     */
+    type ShopperContextParameters = ShopperContextPathParameters & BaseUriParameters & ShopperContextQueryParameters;
+    /**
+     * [Shopper Context](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-context:Summary)
+     * ==================================
+     *
+     * *# API Overview
+     
+     With the Shopper Context API, you can set any context information as a key/value pair and use it to retrieve personalized promotions, payment methods, and shipping methods. The context information that is set is evaluated against the customer group definitions to determine a customer group (shopper segment), and is then used to activate the experiences that are associated with a particular segment, such as promotions.
+     
+     You can also get personalized API responses triggered by shopper context from the [Open Commerce API](https://developer.salesforce.com/docs/commerce/b2c-commerce/references/b2c-commerce-ocapi/get-started-with-ocapi.html) (OCAPI). Support for both the B2C Commerce API and OCAPI allows shopper context to be used in hybrid deployments.
+     
+     **Warning**
+     Access tokens with a scope that includes the Shopper Context API are powerful. They can activate specific promotions and can be used to see how a storefront would be displayed in the future. Don't share them with untrusted clients like web browsers or client apps.
+     
+     Make Shopper Context calls with a private client and only set shopper context through a secure backend channel. To avoid misuse, do not make direct calls through a browser or similar client in which data can be viewed.
+     
+     As part of this, when creating a SLAS public client for a tenant, if you attempt to add the Shopper Context API scope, a warning message is displayed to ensure you are aware of the pitfalls of doing so.
+     
+     **Note**:
+     
+     Shopper context is valid for 1 day for guest shoppers and 7 days for registered shoppers. To extend the context set, create a new context. As a best practice, refresh your contexts periodically to ensure that the right personalized experience is rendered for your shoppers.
+     
+     ## Authentication & Authorization
+     
+     The Shopper Context API requires a shopper access token from the Shopper Login and API Access Service (SLAS).
+     
+     For details on how to request a shopper access token from SLAS, see the guest user flows for [public clients](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas-public-client.html) and [private clients](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas-private-client.html) in the SLAS guides.
+     
+     Add `sfcc.shopper-context.rw` to the scopes configuration for the SLAS API client.
+     
+     For more information, see [Authorization for Shopper APIs](https://developer.salesforce.com/docs/commerce/commerce-api/guide/authorization-for-shopper-apis.html) in the Get Started guides.
+     
+     **Warning**: As with all APIs, never store access tokens in the browser because this creates a security vulnerability.
+     
+     ## Use Cases
+     
+     For detailed usage information, see the [Shopper Context guides](https://developer.salesforce.com/docs/commerce/commerce-api/guide/shopper-context-api.html).*<br />
+     *
+     * Simple example:
+     *
+     * ```typescript
+     *   import { ShopperContext } from "commerce-sdk-isomorphic";
+     *
+     *   const clientConfig = {
+     *     parameters: {
+     *       clientId: "XXXXXX",
+     *       organizationId: "XXXX",
+     *       shortCode: "XXX",
+     *       siteId: "XX"
+     *     }
+     *   };
+     *   const shopperContextClient = new ShopperContext(clientConfig);
+     * ```
+     *
+     * <span style="font-size:.7em; display:block; text-align: right">
+     * API Version: 0.0.33<br />
+     * Last Updated: <br />
+     * </span>
+     *
+     *
+     */
+    class ShopperContexts<ConfigParameters extends ShopperContextParameters & Record<string, unknown>> {
+        // baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
+        clientConfig: ClientConfig<ConfigParameters> & {
+            baseUri: string;
+        };
+        static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/shopper/shopper-context/v1";
+        static readonly apiPaths: {
+            createShopperContext: string;
+            deleteShopperContext: string;
+            getShopperContext: string;
+            updateShopperContext: string;
+        };
+        constructor(config: ClientConfigInit<ConfigParameters>);
+        static readonly paramKeys: {
+            readonly createShopperContext: readonly [
+                "usid",
+                "organizationId",
+                "siteId",
+                "evaluateContextWithClientIp"
+            ];
+            readonly createShopperContextRequired: readonly [
+                "usid",
+                "organizationId",
+                "siteId"
+            ];
+            readonly deleteShopperContext: readonly [
+                "usid",
+                "organizationId",
+                "siteId"
+            ];
+            readonly deleteShopperContextRequired: readonly [
+                "usid",
+                "organizationId",
+                "siteId"
+            ];
+            readonly getShopperContext: readonly [
+                "usid",
+                "organizationId",
+                "siteId"
+            ];
+            readonly getShopperContextRequired: readonly [
+                "usid",
+                "organizationId",
+                "siteId"
+            ];
+            readonly updateShopperContext: readonly [
+                "usid",
+                "organizationId",
+                "siteId",
+                "evaluateContextWithClientIp"
+            ];
+            readonly updateShopperContextRequired: readonly [
+                "usid",
+                "organizationId",
+                "siteId"
+            ];
+        };
+        /**
+         *
+         *
+         * If you would like to get a raw Response object use the other createShopperContext function.
+         *
+         * @param options - An object containing the options for this method.
+         * @param options.parameters - An object containing the parameters for this method.
+         * @param options.parameters.usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
+         * @param options.parameters.organizationId - An identifier for the organization the request is being made by
+         * @param options.parameters.siteId - The site context.
+         * @param options.parameters.evaluateContextWithClientIp - Determines whether to evaluate the context using the provided `clientIp`.  This property is available with B2C Commerce version 24.7.
+         - If `evaluateContextWithClientIp` is set to `true`:
+         - The `clientIP` is saved and used in subsequent requests.
+         
+         - If `evaluateContextWithClientIp` is set to `false`:
+         - The `clientIP` is not saved and will not be used in subsequent requests.
+         
+         * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
+         * @param options.body - The data to send as the request body.
+         *
+         * @returns A promise of type void.
+         */
+        createShopperContext(options: RequireParametersUnlessAllAreOptional<{
+            parameters?: CompositeParameters<{
+                usid: string;
+                organizationId: string;
+                siteId: string;
+                evaluateContextWithClientIp?: boolean;
+            } & QueryParameters, ConfigParameters>;
+            headers?: {
+                [key: string]: string;
+            };
+            body: ShopperContext & CustomRequestBody;
+        }>): Promise<void>;
+        /**
+         *
+         *
+         * @param options - An object containing the options for this method.
+         * @param options.parameters - An object containing the parameters for this method.
+         * @param options.parameters.usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
+         * @param options.parameters.organizationId - An identifier for the organization the request is being made by
+         * @param options.parameters.siteId - The site context.
+         * @param options.parameters.evaluateContextWithClientIp - Determines whether to evaluate the context using the provided `clientIp`.  This property is available with B2C Commerce version 24.7.
+         - If `evaluateContextWithClientIp` is set to `true`:
+         - The `clientIP` is saved and used in subsequent requests.
+         
+         - If `evaluateContextWithClientIp` is set to `false`:
+         - The `clientIP` is not saved and will not be used in subsequent requests.
+         
+         * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
+         * @param options.body - The data to send as the request body.
+         * @param rawResponse - Set to true to return entire Response object instead of DTO.
+         *
+         * @returns A promise of type Response if rawResponse is true, a promise of type void otherwise.
+         */
+        createShopperContext<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
+            parameters?: CompositeParameters<{
+                usid: string;
+                organizationId: string;
+                siteId: string;
+                evaluateContextWithClientIp?: boolean;
+            } & QueryParameters, ConfigParameters>;
+            headers?: {
+                [key: string]: string;
+            };
+            body: ShopperContext & CustomRequestBody;
+        }>, rawResponse?: T): Promise<T extends true ? Response : void>;
+        /**
+         * Get a shopper's context based on the shopperJWT.
+         *
+         * If you would like to get a raw Response object use the other deleteShopperContext function.
+         *
+         * @param options - An object containing the options for this method.
+         * @param options.parameters - An object containing the parameters for this method.
+         * @param options.parameters.usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
+         * @param options.parameters.organizationId - An identifier for the organization the request is being made by
+         * @param options.parameters.siteId - The site context.
+         * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
+         *
+         * @returns A promise of type void.
+         */
+        deleteShopperContext(options?: RequireParametersUnlessAllAreOptional<{
+            parameters?: CompositeParameters<{
+                usid: string;
+                organizationId: string;
+                siteId: string;
+            } & QueryParameters, ConfigParameters>;
+            headers?: {
+                [key: string]: string;
+            };
+        }>): Promise<void>;
+        /**
+         * Get a shopper's context based on the shopperJWT.
+         *
+         * @param options - An object containing the options for this method.
+         * @param options.parameters - An object containing the parameters for this method.
+         * @param options.parameters.usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
+         * @param options.parameters.organizationId - An identifier for the organization the request is being made by
+         * @param options.parameters.siteId - The site context.
+         * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
+         * @param rawResponse - Set to true to return entire Response object instead of DTO.
+         *
+         * @returns A promise of type Response if rawResponse is true, a promise of type void otherwise.
+         */
+        deleteShopperContext<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
+            parameters?: CompositeParameters<{
+                usid: string;
+                organizationId: string;
+                siteId: string;
+            } & QueryParameters, ConfigParameters>;
+            headers?: {
+                [key: string]: string;
+            };
+        }>, rawResponse?: T): Promise<T extends true ? Response : void>;
+        /**
+         *
+         *
+         * If you would like to get a raw Response object use the other getShopperContext function.
+         *
+         * @param options - An object containing the options for this method.
+         * @param options.parameters - An object containing the parameters for this method.
+         * @param options.parameters.usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
+         * @param options.parameters.organizationId - An identifier for the organization the request is being made by
+         * @param options.parameters.siteId - The site context.
+         * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
+         *
+         * @returns A promise of type ShopperContext.
+         */
+        getShopperContext(options?: RequireParametersUnlessAllAreOptional<{
+            parameters?: CompositeParameters<{
+                usid: string;
+                organizationId: string;
+                siteId: string;
+            } & QueryParameters, ConfigParameters>;
+            headers?: {
+                [key: string]: string;
+            };
+        }>): Promise<ShopperContext>;
+        /**
+         *
+         *
+         * @param options - An object containing the options for this method.
+         * @param options.parameters - An object containing the parameters for this method.
+         * @param options.parameters.usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
+         * @param options.parameters.organizationId - An identifier for the organization the request is being made by
+         * @param options.parameters.siteId - The site context.
+         * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
+         * @param rawResponse - Set to true to return entire Response object instead of DTO.
+         *
+         * @returns A promise of type Response if rawResponse is true, a promise of type ShopperContext otherwise.
+         */
+        getShopperContext<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
+            parameters?: CompositeParameters<{
+                usid: string;
+                organizationId: string;
+                siteId: string;
+            } & QueryParameters, ConfigParameters>;
+            headers?: {
+                [key: string]: string;
+            };
+        }>, rawResponse?: T): Promise<T extends true ? Response : ShopperContext>;
+        /**
+         * If the shopper context exists, it's updated with the patch body.
+         - If a new attribute that does not exist in the existing shopper context is present, it is added to the context.
+         -If an attribute is already present in the existing shopper context, its value is replaced by the corresponding value from the new shopper context in the request body as follows:
+         - `custom qualifiers` or `assignment qualifiers`:
+         
+         If the individual qualifier key exists, it is overwritten with the new value.
+         
+         If the value of the key is set to null, it is deleted from the existing shopper context.
+         
+         If an empty `custom qualifiers` or `assignment qualifiers` object `{}` is passed, the entire qualifier object is deleted.
+         - `effectiveDateTime` or `sourceCode` or `clientIp`:
+         
+         If the new value is set to an empty string (""), it is deleted from the existing shopper context.
+         
+         If the new value is set to null, it is ignored.
+         
+         If the new value is not empty or null, it overwrites the existing value.
+         
+         - `customerGroupIds`:
+         
+         If a list of `customerGroupIds` exists, it is replaced by the new list of customer group IDs from the request.
+         
+         If `customerGroupIds` is set to an empty array [], the existing list in the shopper context is deleted.
+         
+         - `geoLocation`:
+         
+         If it exists, the entire `geoLocation` object is replaced with the new value.
+         
+         If the new value is set to null, it is ignored.
+         
+         If an empty `geoLocation` object `{}` is passed, it is deleted.
+         *
+         * If you would like to get a raw Response object use the other updateShopperContext function.
+         *
+         * @param options - An object containing the options for this method.
+         * @param options.parameters - An object containing the parameters for this method.
+         * @param options.parameters.usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
+         * @param options.parameters.organizationId - An identifier for the organization the request is being made by
+         * @param options.parameters.siteId - The site context.
+         * @param options.parameters.evaluateContextWithClientIp - Determines whether to evaluate the context using the provided `clientIp`.  This property is available with B2C Commerce version 24.7.
+         - If `evaluateContextWithClientIp` is set to `true`:
+         - The `clientIP` is saved and used in subsequent requests.
+         
+         - If `evaluateContextWithClientIp` is set to `false`:
+         - The `clientIP` is not saved and will not be used in subsequent requests.
+         
+         * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
+         * @param options.body - The data to send as the request body.
+         *
+         * @returns A promise of type ShopperContext.
+         */
+        updateShopperContext(options: RequireParametersUnlessAllAreOptional<{
+            parameters?: CompositeParameters<{
+                usid: string;
+                organizationId: string;
+                siteId: string;
+                evaluateContextWithClientIp?: boolean;
+            } & QueryParameters, ConfigParameters>;
+            headers?: {
+                [key: string]: string;
+            };
+            body: ShopperContext & CustomRequestBody;
+        }>): Promise<ShopperContext>;
+        /**
+         * If the shopper context exists, it's updated with the patch body.
+         - If a new attribute that does not exist in the existing shopper context is present, it is added to the context.
+         -If an attribute is already present in the existing shopper context, its value is replaced by the corresponding value from the new shopper context in the request body as follows:
+         - `custom qualifiers` or `assignment qualifiers`:
+         
+         If the individual qualifier key exists, it is overwritten with the new value.
+         
+         If the value of the key is set to null, it is deleted from the existing shopper context.
+         
+         If an empty `custom qualifiers` or `assignment qualifiers` object `{}` is passed, the entire qualifier object is deleted.
+         - `effectiveDateTime` or `sourceCode` or `clientIp`:
+         
+         If the new value is set to an empty string (""), it is deleted from the existing shopper context.
+         
+         If the new value is set to null, it is ignored.
+         
+         If the new value is not empty or null, it overwrites the existing value.
+         
+         - `customerGroupIds`:
+         
+         If a list of `customerGroupIds` exists, it is replaced by the new list of customer group IDs from the request.
+         
+         If `customerGroupIds` is set to an empty array [], the existing list in the shopper context is deleted.
+         
+         - `geoLocation`:
+         
+         If it exists, the entire `geoLocation` object is replaced with the new value.
+         
+         If the new value is set to null, it is ignored.
+         
+         If an empty `geoLocation` object `{}` is passed, it is deleted.
+         *
+         * @param options - An object containing the options for this method.
+         * @param options.parameters - An object containing the parameters for this method.
+         * @param options.parameters.usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
+         * @param options.parameters.organizationId - An identifier for the organization the request is being made by
+         * @param options.parameters.siteId - The site context.
+         * @param options.parameters.evaluateContextWithClientIp - Determines whether to evaluate the context using the provided `clientIp`.  This property is available with B2C Commerce version 24.7.
+         - If `evaluateContextWithClientIp` is set to `true`:
+         - The `clientIP` is saved and used in subsequent requests.
+         
+         - If `evaluateContextWithClientIp` is set to `false`:
+         - The `clientIP` is not saved and will not be used in subsequent requests.
+         
+         * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
+         * @param options.body - The data to send as the request body.
+         * @param rawResponse - Set to true to return entire Response object instead of DTO.
+         *
+         * @returns A promise of type Response if rawResponse is true, a promise of type ShopperContext otherwise.
+         */
+        updateShopperContext<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
+            parameters?: CompositeParameters<{
+                usid: string;
+                organizationId: string;
+                siteId: string;
+                evaluateContextWithClientIp?: boolean;
+            } & QueryParameters, ConfigParameters>;
+            headers?: {
+                [key: string]: string;
+            };
+            body: ShopperContext & CustomRequestBody;
+        }>, rawResponse?: T): Promise<T extends true ? Response : ShopperContext>;
+    }
+}
+declare namespace ShopperContextsModelTypes {
+    /**
+     * @type ErrorResponse:
+     *
+     * @property title: A short, human-readable summary of the problem type.  It will not change from occurrence to occurrence of the  problem, except for purposes of localization
+     * - **Max Length:** 256
+     *
+     * @property type: A URI reference [RFC3986] that identifies the problem type.  This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]).  When this member is not present, its value is assumed to be \"about:blank\". It accepts relative URIs; this means that they must be resolved relative to the document\'s base URI, as per [RFC3986], Section 5.
+     * - **Max Length:** 2048
+     *
+     * @property detail: A human-readable explanation specific to this occurrence of the problem.
+     *
+     * @property instance: A URI reference that identifies the specific occurrence of the problem.  It may or may not yield further information if dereferenced.  It accepts relative URIs; this means that they must be resolved relative to the document\'s base URI, as per [RFC3986], Section 5.
+     * - **Max Length:** 2048
+     *
+     */
+    type ErrorResponse = {
+        title: string;
+        type: string;
+        detail: string;
+        instance?: string;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type ShopperContextGeoLocation: The geographic location of the client. When you set a geolocation, it is saved as context for subsequent requests. This overrides any geolocation context previously saved using `clientIp`. This property is available with B2C Commerce version 24.7.
+     *
+     * @property city: The city name associated with this location.
+     *
+     * @property country: The country name associated with this location.
+     *
+     * @property countryCode: The ISO country code associated with this location.
+     *
+     * @property latitude: The latitude coordinate, which is a number between -90.0 and +90.0, associated with this location.
+     *
+     * @property longitude: The longitude coordinate, which is a number between -180.0 and +180.0, associated with this location.
+     *
+     * @property metroCode: The metro code associated with this location.
+     *
+     * @property postalCode: The postal code associated with this location.
+     *
+     * @property region: The region (subdivision) name for this location. Corresponds with \"state\" in the USA.
+     *
+     * @property regionCode: The region (province or state) code for this location.
+     *
+     */
+    type ShopperContextGeoLocation = {
+        city?: string;
+        country?: string;
+        countryCode?: string;
+        latitude?: number;
+        longitude?: number;
+        metroCode?: string;
+        postalCode?: string;
+        region?: string;
+        regionCode?: string;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type ShopperContext: A shoppers\' context represented as key-value string pairs.
+     *
+     * @property effectiveDateTime: Qualifier to set the effective date time for the context to apply. For example, \"Shop the Future\" use cases. If not provided, the current dateTime will be assumed.
+     *
+     * @property sourceCode: Qualifier to set the source code for the 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).
+     *
+     * @property customerGroupIds: Qualifier to set the Customer Group Ids for the context to apply. Set the Customer Group Ids to evaluate customer groups that trigger the promotions (campaign assignment) assigned to the customer groups.
+     *
+     * @property customQualifiers: Map of custom qualifiers for the shopper context. Set this object to trigger pricing and promotion experiences using a dynamic session-based customer group. Object size is limited to 20 key-value pairs (properties).
+     *
+     * @property assignmentQualifiers: Map of assignment qualifiers for the shopper context. Set this object when using the assignment framework to activate experiences based on assignment qualifiers. Currently, only pricing and promotion experiences are supported. Object size is limited to 20 key-value pairs (properties).
+     *
+     * @property clientIp: The IP Address of the client. If the client IP is not a valid IPv4 address, a Bad Request (400) error is thrown. This property is available with B2C Commerce version 24.7.  When `clientIp` is set, the geolocation based on the `clientIp` is returned in the `X-Geolocation` header in the response. Note: Use/retrieve this header in a case insensitive manner.  However, if the `geoLocation` attribute is also set in the context, it takes precedence over the `clientIp`, and the `X-Geolocation` header returns the geolocation based on the `geoLocation` attribute.  The query parameter `evaluateContextWithClientIp` determines whether to evaluate the context using the provided `clientIp`.   - If `evaluateContextWithClientIp` is set to `true`:     - The `clientIp` is saved and used in subsequent requests.           Note: If `geoLocation` is also saved in the context, it takes precedence over the `clientIp`.   - If `evaluateContextWithClientIp` is set to `false`:     - The `clientIp` is not saved and is not used in subsequent requests.
+     *
+     * @property geoLocation:
+     *
+     */
+    type ShopperContext = {
+        effectiveDateTime?: string | null;
+        sourceCode?: string | null;
+        customerGroupIds?: Array<string>;
+        customQualifiers?: {
+            [key: string]: string | null;
+        };
+        assignmentQualifiers?: {
+            [key: string]: string | null;
+        };
+        clientIp?: string;
+        geoLocation?: ShopperContextGeoLocation;
+    } & {
+        [key: string]: any;
+    };
+}
+declare namespace ShopperContextsTypes {
+    type ShopperContextPathParameters = ShopperContextsApiTypes.ShopperContextPathParameters;
+    type ShopperContextQueryParameters = ShopperContextsApiTypes.ShopperContextQueryParameters;
+    type createShopperContextQueryParameters = ShopperContextsApiTypes.createShopperContextQueryParameters;
+    type createShopperContextPathParameters = ShopperContextsApiTypes.createShopperContextPathParameters;
+    type deleteShopperContextQueryParameters = ShopperContextsApiTypes.deleteShopperContextQueryParameters;
+    type deleteShopperContextPathParameters = ShopperContextsApiTypes.deleteShopperContextPathParameters;
+    type getShopperContextQueryParameters = ShopperContextsApiTypes.getShopperContextQueryParameters;
+    type getShopperContextPathParameters = ShopperContextsApiTypes.getShopperContextPathParameters;
+    type updateShopperContextQueryParameters = ShopperContextsApiTypes.updateShopperContextQueryParameters;
+    type updateShopperContextPathParameters = ShopperContextsApiTypes.updateShopperContextPathParameters;
+    type ErrorResponse = ShopperContextsModelTypes.ErrorResponse;
+    type ShopperContext = ShopperContextsModelTypes.ShopperContext;
+    type ShopperContextGeoLocation = ShopperContextsModelTypes.ShopperContextGeoLocation;
+}
+export { defaultBaseUri, createShopperContextQueryParameters, createShopperContextPathParameters, deleteShopperContextQueryParameters, deleteShopperContextPathParameters, getShopperContextQueryParameters, getShopperContextPathParameters, updateShopperContextQueryParameters, updateShopperContextPathParameters, ShopperContextPathParameters, ShopperContextQueryParameters, ShopperContextParameters, ShopperContexts, ErrorResponse, ShopperContext, ShopperContextGeoLocation, ShopperContextsTypes };