commerce-sdk-isomorphic 4.1.0 → 4.2.0

package/lib/shopperPromotions.d.ts

@@ -1,1006 +0,0 @@
-/*
-* 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/pricing/shopper-promotions/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;
-}
-/**
- * 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;
-type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
-/**
- * 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;
-    fetch?: FetchFunction;
-    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;
-    fetch?: FetchFunction;
-    transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
-    throwOnBadResponse: boolean;
-    constructor(config: ClientConfigInit<Params>);
-    static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
-}
-/**
- * A specialized value indicating the system default values for locales.
- */
-type DefaultFallback = "default";
-/**
- * @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 LocaleCode
- * A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
- */
-type LocaleCode$0 = DefaultFallback | string;
-/**
- * @type Promotion: Document representing a promotion.
- *
- * @property calloutMsg: The localized call-out message of the promotion.
- *
- * @property currency: The currency that a promotion can be applied to. A null value means that the promotion applies to all allowed  currencies.
- *
- * @property details: The localized detailed description of the promotion.
- *
- * @property endDate: The end date of the promotion. This property follows the ISO8601 date time format: yyyy-MM-dd\'T\'HH:mmZ . The time  zone of the date time is always UTC.
- *
- * @property id: The unique ID of the promotion.
- *
- * @property image: The URL to the promotion image.
- *
- * @property name: The localized name of the promotion.
- *
- * @property startDate: The start date of the promotion. This property follows the ISO8601 date time format: yyyy-MM-dd\'T\'HH:mmZ. The  time zone of the date time is always UTC.
- *
- */
-type Promotion = {
-    calloutMsg?: string;
-    currency?: string;
-    details?: string;
-    endDate?: string;
-    id: string;
-    image?: string;
-    name?: string;
-    startDate?: string;
-} & {
-    [key: string]: any;
-};
-/**
- * @type PromotionResult: Result document containing an array of promotions.
- *
- * @property data: The array of promotion documents.
- *
- * @property limit: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).
- *
- * @property total: The total number of hits that match the search\'s criteria. This can be greater than the number of results returned as search results are pagenated.
- *
- */
-type PromotionResult = {
-    data: Array<Promotion>;
-    limit: number;
-    total: number;
-} & {
-    [key: string]: any;
-};
-/**
- * @type ResultBase: Schema defining generic list result. Each response schema of a resource requiring a list response should extend this schema.  Additionally it needs to be defined what data is returned.
- *
- * @property limit: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).
- *
- * @property total: The total number of hits that match the search\'s criteria. This can be greater than the number of results returned as search results are pagenated.
- *
- */
-type ResultBase = {
-    limit: number;
-    total: number;
-} & {
-    [key: string]: any;
-};
-type getPromotionsQueryParameters = {
-    siteId: string;
-    ids: Array<string>;
-    locale?: LocaleCode$0;
-};
-type getPromotionsPathParameters = {
-    organizationId: string;
-};
-type getPromotionsForCampaignQueryParameters = {
-    siteId: string;
-    startDate?: string;
-    endDate?: string;
-    currency?: string;
-};
-type getPromotionsForCampaignPathParameters = {
-    campaignId: string;
-    organizationId: string;
-};
-/**
- * All path parameters that are used by at least one ShopperPromotions method.
- */
-type ShopperPromotionsPathParameters = Partial<getPromotionsPathParameters & getPromotionsForCampaignPathParameters & {}>;
-/**
- * All query parameters that are used by at least one ShopperPromotions method.
- */
-type ShopperPromotionsQueryParameters = Partial<getPromotionsQueryParameters & getPromotionsForCampaignQueryParameters & {}>;
-/**
- * All parameters that are used by ShopperPromotions.
- */
-type ShopperPromotionsParameters = ShopperPromotionsPathParameters & BaseUriParameters & ShopperPromotionsQueryParameters;
-/**
- * [Shopper Promotions](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-promotions:Summary)
- * ==================================
- *
- * *# API Overview
- 
- Retrieve information about active promotions within the context of a shopper and a site. You can use this API to retrieve promotions that you configured in the commerce platform by searching for specific promotion IDs or by searching for promotions associated with a campaign.
- 
- Caching is provided for the Shopper Promotions API. For details, see [Server-Side Web-Tier Caching.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html)
- 
- ## Authentication & Authorization
- 
- The Shopper Promotions API requires a JSON Web Token acquired via the Shopper Customers endpoint:
- 
- ```
- https://{{shortcode}}.api.commercecloud.salesforce.com/customer/shopper-customers/v1/organizations/{{organizationId}}/customers/actions/login
- ```
- 
- You must include the relevant scope(s) in the client ID used to generate the SLAS token. For details, see [Authorization Scopes Catalog.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/auth-z-scope-catalog.html)
- 
- ## Use Cases
- 
- ### Get Promotion by Promotion ID
- 
- Use the Shopper Promotions API to find promotion information by the promotion ID.
- 
- For example, a customer who is browsing on a commerce shopping app built using Commerce Cloud APIs can see the details about the applied promotions in the cart.
- 
- ### Get Promotion by Campaign ID
- 
- Use the Shopper Promotions API to find promotion information by the campaign ID.
- 
- For example, a customer who is browsing on a commerce shopping app built using Commerce Cloud APIs can see the possible promotions that can be applied in the cart.
- 
- ### Use Hooks
- 
- For details working with hooks, see [Extensibility with Hooks.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/extensibility_via_hooks.html)*<br />
- *
- * Simple example:
- *
- * ```typescript
- *   import { ShopperPromotions } from "commerce-sdk-isomorphic";
- *
- *   const clientConfig = {
- *     parameters: {
- *       clientId: "XXXXXX",
- *       organizationId: "XXXX",
- *       shortCode: "XXX",
- *       siteId: "XX"
- *     }
- *   };
- *   const shopperPromotionsClient = new ShopperPromotions(clientConfig);
- * ```
- *
- * <span style="font-size:.7em; display:block; text-align: right">
- * API Version: 0.0.33<br />
- * Last Updated: <br />
- * </span>
- *
- *
- */
-declare class ShopperPromotions<ConfigParameters extends ShopperPromotionsParameters & 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/pricing/shopper-promotions/v1";
-    static readonly apiPaths: {
-        getPromotions: string;
-        getPromotionsForCampaign: string;
-    };
-    constructor(config: ClientConfigInit<ConfigParameters>);
-    static readonly paramKeys: {
-        readonly getPromotions: readonly [
-            "organizationId",
-            "siteId",
-            "ids",
-            "locale"
-        ];
-        readonly getPromotionsRequired: readonly [
-            "organizationId",
-            "siteId",
-            "ids"
-        ];
-        readonly getPromotionsForCampaign: readonly [
-            "campaignId",
-            "organizationId",
-            "siteId",
-            "startDate",
-            "endDate",
-            "currency"
-        ];
-        readonly getPromotionsForCampaignRequired: readonly [
-            "campaignId",
-            "organizationId",
-            "siteId"
-        ];
-    };
-    /**
-     * In the request URL, you can specify up to 50 IDs. If you specify an ID that contains either parentheses or the separator characters, you must URL encode these characters.
-     Each request returns only enabled promotions as the server does not consider promotion qualifiers or schedules.
-     *
-     * If you would like to get a raw Response object use the other getPromotions 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.organizationId - An identifier for the organization the request is being made by
-     * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
-     * @param options.parameters.ids -
-     * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
-     * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
-     *
-     * @returns A promise of type PromotionResult.
-     */
-    getPromotions(options?: RequireParametersUnlessAllAreOptional<{
-        parameters?: CompositeParameters<{
-            organizationId: string;
-            siteId: string;
-            ids: Array<string>;
-            locale?: LocaleCode$0;
-        } & QueryParameters, ConfigParameters>;
-        headers?: {
-            [key: string]: string;
-        };
-    }>): Promise<PromotionResult>;
-    /**
-     * In the request URL, you can specify up to 50 IDs. If you specify an ID that contains either parentheses or the separator characters, you must URL encode these characters.
-     Each request returns only enabled promotions as the server does not consider promotion qualifiers or schedules.
-     *
-     * @param options - An object containing the options for this method.
-     * @param options.parameters - An object containing the parameters for this method.
-     * @param options.parameters.organizationId - An identifier for the organization the request is being made by
-     * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
-     * @param options.parameters.ids -
-     * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
-     * @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 PromotionResult otherwise.
-     */
-    getPromotions<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
-        parameters?: CompositeParameters<{
-            organizationId: string;
-            siteId: string;
-            ids: Array<string>;
-            locale?: LocaleCode$0;
-        } & QueryParameters, ConfigParameters>;
-        headers?: {
-            [key: string]: string;
-        };
-    }>, rawResponse?: T): Promise<T extends true ? Response : PromotionResult>;
-    /**
-     * Retrieves promotion information using filter criteria. In the request URL, you must provide a campaign_id parameter, and you can optionally specify a date
-     range by providing start_date and end_date parameters. Both parameters are required to specify a date range, and
-     omitting one causes the server to return a MissingParameterException fault. Each request returns only enabled
-     promotions, since the server does not consider promotion qualifiers or schedules.
-     *
-     * If you would like to get a raw Response object use the other getPromotionsForCampaign 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.campaignId - Find the promotions assigned to this campaign (mandatory).
-     * @param options.parameters.organizationId - An identifier for the organization the request is being made by
-     * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
-     * @param options.parameters.startDate - The start date of the promotion in ISO8601 date time format: yyyy-MM-dd'T'HH:mmZ
-     * @param options.parameters.endDate - The end date of the promotion in ISO8601 date time format: yyyy-MM-dd'T'HH:mmZ
-     * @param options.parameters.currency - The currency mnemonic specified for price. This parameter is effective only for product suggestions.
-     * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
-     *
-     * @returns A promise of type PromotionResult.
-     */
-    getPromotionsForCampaign(options?: RequireParametersUnlessAllAreOptional<{
-        parameters?: CompositeParameters<{
-            campaignId: string;
-            organizationId: string;
-            siteId: string;
-            startDate?: string;
-            endDate?: string;
-            currency?: string;
-        } & QueryParameters, ConfigParameters>;
-        headers?: {
-            [key: string]: string;
-        };
-    }>): Promise<PromotionResult>;
-    /**
-     * Retrieves promotion information using filter criteria. In the request URL, you must provide a campaign_id parameter, and you can optionally specify a date
-     range by providing start_date and end_date parameters. Both parameters are required to specify a date range, and
-     omitting one causes the server to return a MissingParameterException fault. Each request returns only enabled
-     promotions, since the server does not consider promotion qualifiers or schedules.
-     *
-     * @param options - An object containing the options for this method.
-     * @param options.parameters - An object containing the parameters for this method.
-     * @param options.parameters.campaignId - Find the promotions assigned to this campaign (mandatory).
-     * @param options.parameters.organizationId - An identifier for the organization the request is being made by
-     * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
-     * @param options.parameters.startDate - The start date of the promotion in ISO8601 date time format: yyyy-MM-dd'T'HH:mmZ
-     * @param options.parameters.endDate - The end date of the promotion in ISO8601 date time format: yyyy-MM-dd'T'HH:mmZ
-     * @param options.parameters.currency - The currency mnemonic specified for price. This parameter is effective only for product suggestions.
-     * @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 PromotionResult otherwise.
-     */
-    getPromotionsForCampaign<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
-        parameters?: CompositeParameters<{
-            campaignId: string;
-            organizationId: string;
-            siteId: string;
-            startDate?: string;
-            endDate?: string;
-            currency?: string;
-        } & QueryParameters, ConfigParameters>;
-        headers?: {
-            [key: string]: string;
-        };
-    }>, rawResponse?: T): Promise<T extends true ? Response : PromotionResult>;
-}
-declare namespace ShopperPromotionsApiTypes {
-    /*
-    * 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;
-    type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
-    /**
-     * 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;
-        fetch?: FetchFunction;
-        transformRequest?: (data: unknown, headers: {
-            [key: string]: string;
-        }) => Required<FetchOptions>["body"];
-        throwOnBadResponse?: boolean;
-    }
-    /**
-     * 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;
-        fetch?: FetchFunction;
-        transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
-        throwOnBadResponse: boolean;
-        constructor(config: ClientConfigInit<Params>);
-        static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
-    }
-    /**
-     * A specialized value indicating the system default values for locales.
-     */
-    type DefaultFallback = "default";
-    /**
-     * @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 LocaleCode
-     * A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
-     */
-    type LocaleCode$0 = DefaultFallback | string;
-    /**
-     * @type Promotion: Document representing a promotion.
-     *
-     * @property calloutMsg: The localized call-out message of the promotion.
-     *
-     * @property currency: The currency that a promotion can be applied to. A null value means that the promotion applies to all allowed  currencies.
-     *
-     * @property details: The localized detailed description of the promotion.
-     *
-     * @property endDate: The end date of the promotion. This property follows the ISO8601 date time format: yyyy-MM-dd\'T\'HH:mmZ . The time  zone of the date time is always UTC.
-     *
-     * @property id: The unique ID of the promotion.
-     *
-     * @property image: The URL to the promotion image.
-     *
-     * @property name: The localized name of the promotion.
-     *
-     * @property startDate: The start date of the promotion. This property follows the ISO8601 date time format: yyyy-MM-dd\'T\'HH:mmZ. The  time zone of the date time is always UTC.
-     *
-     */
-    type Promotion = {
-        calloutMsg?: string;
-        currency?: string;
-        details?: string;
-        endDate?: string;
-        id: string;
-        image?: string;
-        name?: string;
-        startDate?: string;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type PromotionResult: Result document containing an array of promotions.
-     *
-     * @property data: The array of promotion documents.
-     *
-     * @property limit: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).
-     *
-     * @property total: The total number of hits that match the search\'s criteria. This can be greater than the number of results returned as search results are pagenated.
-     *
-     */
-    type PromotionResult = {
-        data: Array<Promotion>;
-        limit: number;
-        total: number;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type ResultBase: Schema defining generic list result. Each response schema of a resource requiring a list response should extend this schema.  Additionally it needs to be defined what data is returned.
-     *
-     * @property limit: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).
-     *
-     * @property total: The total number of hits that match the search\'s criteria. This can be greater than the number of results returned as search results are pagenated.
-     *
-     */
-    type ResultBase = {
-        limit: number;
-        total: number;
-    } & {
-        [key: string]: any;
-    };
-    type getPromotionsQueryParameters = {
-        siteId: string;
-        ids: Array<string>;
-        locale?: LocaleCode$0;
-    };
-    type getPromotionsPathParameters = {
-        organizationId: string;
-    };
-    type getPromotionsForCampaignQueryParameters = {
-        siteId: string;
-        startDate?: string;
-        endDate?: string;
-        currency?: string;
-    };
-    type getPromotionsForCampaignPathParameters = {
-        campaignId: string;
-        organizationId: string;
-    };
-    /**
-     * All path parameters that are used by at least one ShopperPromotions method.
-     */
-    type ShopperPromotionsPathParameters = Partial<getPromotionsPathParameters & getPromotionsForCampaignPathParameters & {}>;
-    /**
-     * All query parameters that are used by at least one ShopperPromotions method.
-     */
-    type ShopperPromotionsQueryParameters = Partial<getPromotionsQueryParameters & getPromotionsForCampaignQueryParameters & {}>;
-    /**
-     * All parameters that are used by ShopperPromotions.
-     */
-    type ShopperPromotionsParameters = ShopperPromotionsPathParameters & BaseUriParameters & ShopperPromotionsQueryParameters;
-    /**
-     * [Shopper Promotions](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-promotions:Summary)
-     * ==================================
-     *
-     * *# API Overview
-     
-     Retrieve information about active promotions within the context of a shopper and a site. You can use this API to retrieve promotions that you configured in the commerce platform by searching for specific promotion IDs or by searching for promotions associated with a campaign.
-     
-     Caching is provided for the Shopper Promotions API. For details, see [Server-Side Web-Tier Caching.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html)
-     
-     ## Authentication & Authorization
-     
-     The Shopper Promotions API requires a JSON Web Token acquired via the Shopper Customers endpoint:
-     
-     ```
-     https://{{shortcode}}.api.commercecloud.salesforce.com/customer/shopper-customers/v1/organizations/{{organizationId}}/customers/actions/login
-     ```
-     
-     You must include the relevant scope(s) in the client ID used to generate the SLAS token. For details, see [Authorization Scopes Catalog.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/auth-z-scope-catalog.html)
-     
-     ## Use Cases
-     
-     ### Get Promotion by Promotion ID
-     
-     Use the Shopper Promotions API to find promotion information by the promotion ID.
-     
-     For example, a customer who is browsing on a commerce shopping app built using Commerce Cloud APIs can see the details about the applied promotions in the cart.
-     
-     ### Get Promotion by Campaign ID
-     
-     Use the Shopper Promotions API to find promotion information by the campaign ID.
-     
-     For example, a customer who is browsing on a commerce shopping app built using Commerce Cloud APIs can see the possible promotions that can be applied in the cart.
-     
-     ### Use Hooks
-     
-     For details working with hooks, see [Extensibility with Hooks.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/extensibility_via_hooks.html)*<br />
-     *
-     * Simple example:
-     *
-     * ```typescript
-     *   import { ShopperPromotions } from "commerce-sdk-isomorphic";
-     *
-     *   const clientConfig = {
-     *     parameters: {
-     *       clientId: "XXXXXX",
-     *       organizationId: "XXXX",
-     *       shortCode: "XXX",
-     *       siteId: "XX"
-     *     }
-     *   };
-     *   const shopperPromotionsClient = new ShopperPromotions(clientConfig);
-     * ```
-     *
-     * <span style="font-size:.7em; display:block; text-align: right">
-     * API Version: 0.0.33<br />
-     * Last Updated: <br />
-     * </span>
-     *
-     *
-     */
-    class ShopperPromotions<ConfigParameters extends ShopperPromotionsParameters & 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/pricing/shopper-promotions/v1";
-        static readonly apiPaths: {
-            getPromotions: string;
-            getPromotionsForCampaign: string;
-        };
-        constructor(config: ClientConfigInit<ConfigParameters>);
-        static readonly paramKeys: {
-            readonly getPromotions: readonly [
-                "organizationId",
-                "siteId",
-                "ids",
-                "locale"
-            ];
-            readonly getPromotionsRequired: readonly [
-                "organizationId",
-                "siteId",
-                "ids"
-            ];
-            readonly getPromotionsForCampaign: readonly [
-                "campaignId",
-                "organizationId",
-                "siteId",
-                "startDate",
-                "endDate",
-                "currency"
-            ];
-            readonly getPromotionsForCampaignRequired: readonly [
-                "campaignId",
-                "organizationId",
-                "siteId"
-            ];
-        };
-        /**
-         * In the request URL, you can specify up to 50 IDs. If you specify an ID that contains either parentheses or the separator characters, you must URL encode these characters.
-         Each request returns only enabled promotions as the server does not consider promotion qualifiers or schedules.
-         *
-         * If you would like to get a raw Response object use the other getPromotions 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.organizationId - An identifier for the organization the request is being made by
-         * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
-         * @param options.parameters.ids -
-         * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
-         * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
-         *
-         * @returns A promise of type PromotionResult.
-         */
-        getPromotions(options?: RequireParametersUnlessAllAreOptional<{
-            parameters?: CompositeParameters<{
-                organizationId: string;
-                siteId: string;
-                ids: Array<string>;
-                locale?: LocaleCode$0;
-            } & QueryParameters, ConfigParameters>;
-            headers?: {
-                [key: string]: string;
-            };
-        }>): Promise<PromotionResult>;
-        /**
-         * In the request URL, you can specify up to 50 IDs. If you specify an ID that contains either parentheses or the separator characters, you must URL encode these characters.
-         Each request returns only enabled promotions as the server does not consider promotion qualifiers or schedules.
-         *
-         * @param options - An object containing the options for this method.
-         * @param options.parameters - An object containing the parameters for this method.
-         * @param options.parameters.organizationId - An identifier for the organization the request is being made by
-         * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
-         * @param options.parameters.ids -
-         * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
-         * @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 PromotionResult otherwise.
-         */
-        getPromotions<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
-            parameters?: CompositeParameters<{
-                organizationId: string;
-                siteId: string;
-                ids: Array<string>;
-                locale?: LocaleCode$0;
-            } & QueryParameters, ConfigParameters>;
-            headers?: {
-                [key: string]: string;
-            };
-        }>, rawResponse?: T): Promise<T extends true ? Response : PromotionResult>;
-        /**
-         * Retrieves promotion information using filter criteria. In the request URL, you must provide a campaign_id parameter, and you can optionally specify a date
-         range by providing start_date and end_date parameters. Both parameters are required to specify a date range, and
-         omitting one causes the server to return a MissingParameterException fault. Each request returns only enabled
-         promotions, since the server does not consider promotion qualifiers or schedules.
-         *
-         * If you would like to get a raw Response object use the other getPromotionsForCampaign 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.campaignId - Find the promotions assigned to this campaign (mandatory).
-         * @param options.parameters.organizationId - An identifier for the organization the request is being made by
-         * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
-         * @param options.parameters.startDate - The start date of the promotion in ISO8601 date time format: yyyy-MM-dd'T'HH:mmZ
-         * @param options.parameters.endDate - The end date of the promotion in ISO8601 date time format: yyyy-MM-dd'T'HH:mmZ
-         * @param options.parameters.currency - The currency mnemonic specified for price. This parameter is effective only for product suggestions.
-         * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
-         *
-         * @returns A promise of type PromotionResult.
-         */
-        getPromotionsForCampaign(options?: RequireParametersUnlessAllAreOptional<{
-            parameters?: CompositeParameters<{
-                campaignId: string;
-                organizationId: string;
-                siteId: string;
-                startDate?: string;
-                endDate?: string;
-                currency?: string;
-            } & QueryParameters, ConfigParameters>;
-            headers?: {
-                [key: string]: string;
-            };
-        }>): Promise<PromotionResult>;
-        /**
-         * Retrieves promotion information using filter criteria. In the request URL, you must provide a campaign_id parameter, and you can optionally specify a date
-         range by providing start_date and end_date parameters. Both parameters are required to specify a date range, and
-         omitting one causes the server to return a MissingParameterException fault. Each request returns only enabled
-         promotions, since the server does not consider promotion qualifiers or schedules.
-         *
-         * @param options - An object containing the options for this method.
-         * @param options.parameters - An object containing the parameters for this method.
-         * @param options.parameters.campaignId - Find the promotions assigned to this campaign (mandatory).
-         * @param options.parameters.organizationId - An identifier for the organization the request is being made by
-         * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
-         * @param options.parameters.startDate - The start date of the promotion in ISO8601 date time format: yyyy-MM-dd'T'HH:mmZ
-         * @param options.parameters.endDate - The end date of the promotion in ISO8601 date time format: yyyy-MM-dd'T'HH:mmZ
-         * @param options.parameters.currency - The currency mnemonic specified for price. This parameter is effective only for product suggestions.
-         * @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 PromotionResult otherwise.
-         */
-        getPromotionsForCampaign<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
-            parameters?: CompositeParameters<{
-                campaignId: string;
-                organizationId: string;
-                siteId: string;
-                startDate?: string;
-                endDate?: string;
-                currency?: string;
-            } & QueryParameters, ConfigParameters>;
-            headers?: {
-                [key: string]: string;
-            };
-        }>, rawResponse?: T): Promise<T extends true ? Response : PromotionResult>;
-    }
-}
-declare namespace ShopperPromotionsModelTypes {
-    /**
-     * A specialized value indicating the system default values for locales.
-     */
-    type DefaultFallback = "default";
-    /**
-     * @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 LocaleCode
-     * A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
-     */
-    type LocaleCode = DefaultFallback | string;
-    /**
-     * @type Promotion: Document representing a promotion.
-     *
-     * @property calloutMsg: The localized call-out message of the promotion.
-     *
-     * @property currency: The currency that a promotion can be applied to. A null value means that the promotion applies to all allowed  currencies.
-     *
-     * @property details: The localized detailed description of the promotion.
-     *
-     * @property endDate: The end date of the promotion. This property follows the ISO8601 date time format: yyyy-MM-dd\'T\'HH:mmZ . The time  zone of the date time is always UTC.
-     *
-     * @property id: The unique ID of the promotion.
-     *
-     * @property image: The URL to the promotion image.
-     *
-     * @property name: The localized name of the promotion.
-     *
-     * @property startDate: The start date of the promotion. This property follows the ISO8601 date time format: yyyy-MM-dd\'T\'HH:mmZ. The  time zone of the date time is always UTC.
-     *
-     */
-    type Promotion = {
-        calloutMsg?: string;
-        currency?: string;
-        details?: string;
-        endDate?: string;
-        id: string;
-        image?: string;
-        name?: string;
-        startDate?: string;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type PromotionResult: Result document containing an array of promotions.
-     *
-     * @property data: The array of promotion documents.
-     *
-     * @property limit: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).
-     *
-     * @property total: The total number of hits that match the search\'s criteria. This can be greater than the number of results returned as search results are pagenated.
-     *
-     */
-    type PromotionResult = {
-        data: Array<Promotion>;
-        limit: number;
-        total: number;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type ResultBase: Schema defining generic list result. Each response schema of a resource requiring a list response should extend this schema.  Additionally it needs to be defined what data is returned.
-     *
-     * @property limit: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).
-     *
-     * @property total: The total number of hits that match the search\'s criteria. This can be greater than the number of results returned as search results are pagenated.
-     *
-     */
-    type ResultBase = {
-        limit: number;
-        total: number;
-    } & {
-        [key: string]: any;
-    };
-}
-declare namespace ShopperPromotionsTypes {
-    type ShopperPromotionsPathParameters = ShopperPromotionsApiTypes.ShopperPromotionsPathParameters;
-    type ShopperPromotionsQueryParameters = ShopperPromotionsApiTypes.ShopperPromotionsQueryParameters;
-    type getPromotionsQueryParameters = ShopperPromotionsApiTypes.getPromotionsQueryParameters;
-    type getPromotionsPathParameters = ShopperPromotionsApiTypes.getPromotionsPathParameters;
-    type getPromotionsForCampaignQueryParameters = ShopperPromotionsApiTypes.getPromotionsForCampaignQueryParameters;
-    type getPromotionsForCampaignPathParameters = ShopperPromotionsApiTypes.getPromotionsForCampaignPathParameters;
-    type DefaultFallback = ShopperPromotionsModelTypes.DefaultFallback;
-    type ErrorResponse = ShopperPromotionsModelTypes.ErrorResponse;
-    type LocaleCode = ShopperPromotionsModelTypes.LocaleCode;
-    type Promotion = ShopperPromotionsModelTypes.Promotion;
-    type PromotionResult = ShopperPromotionsModelTypes.PromotionResult;
-    type ResultBase = ShopperPromotionsModelTypes.ResultBase;
-}
-export { defaultBaseUri, getPromotionsQueryParameters, getPromotionsPathParameters, getPromotionsForCampaignQueryParameters, getPromotionsForCampaignPathParameters, ShopperPromotionsPathParameters, ShopperPromotionsQueryParameters, ShopperPromotionsParameters, ShopperPromotions, DefaultFallback, ErrorResponse, LocaleCode$0 as LocaleCode, Promotion, PromotionResult, ResultBase, ShopperPromotionsTypes };