commerce-sdk-isomorphic 4.0.1-preview-shopper-configurations.0 → 4.0.1

package/lib/shopperProducts.d.ts

@@ -1,3479 +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/product/shopper-products/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;
-/**
- * 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 Image: Product image
- *
- * @property alt: The localized alternative text of the image.
- *
- * @property disBaseLink: Base URL for the Dynamic Image Service (DIS) address. This is only shown if the image is stored on the server and DIS is enabled.
- *
- * @property link: The URL of the actual image.
- * - **Min Length:** 1
- *
- * @property title: The localized title of the image.
- *
- */
-type Image = {
-    alt?: string;
-    disBaseLink?: string;
-    link: string;
-    title?: string;
-} & {
-    [key: string]: any;
-};
-/**
- * @type VariationAttributeValue: Document representing a variation attribute value.
- *
- * @property description: The localized description of the variation value.
- *
- * @property image: The first product image for the configured viewtype and this variation value.
- *
- * @property imageSwatch: The first product image for the configured viewtype and this variation value (typically the swatch image).
- *
- * @property name: The localized display name of the variation value.
- *
- * @property orderable: A flag indicating whether at least one variant with this variation attribute value is available to sell.
- *
- * @property value: The actual variation value.
- * - **Min Length:** 1
- *
- */
-type VariationAttributeValue = {
-    description?: string;
-    image?: Image;
-    imageSwatch?: Image;
-    name?: string;
-    orderable?: boolean;
-    value: string;
-} & {
-    [key: string]: any;
-};
-/**
- * @type VariationAttribute: Document representing a variation attribute.
- *
- * @property id: The ID of the variation attribute.
- * - **Min Length:** 1
- *
- * @property name: The localized display name of the variation attribute.
- *
- * @property values: The sorted array of variation values. This array can be empty.
- *
- */
-type VariationAttribute = {
-    id: string;
-    name?: string;
-    values?: Array<VariationAttributeValue>;
-} & {
-    [key: string]: any;
-};
-/**
- * @type VariationGroup: Representation of a group of variant products by an attribute. This is a non-buyable entity, provides inheritable attributes for its product variants, and is used for navigation. *Doesn\'t have a SKU.*
- *
- * @property orderable: A flag indicating whether the variation group is orderable.
- *
- * @property price: The sales price of the variation group.
- *
- * @property productId: The ID (SKU) of the variation group.
- * - **Min Length:** 1
- * - **Max Length:** 100
- *
- * @property variationValues: The actual variation attribute ID - value pairs.
- *
- */
-type VariationGroup = {
-    orderable: boolean;
-    price: number;
-    productId: string;
-    variationValues: {
-        [key: string]: string;
-    };
-} & {
-    [key: string]: any;
-};
-/**
- * @type ProductType: Document representing a product type.
- *
- * @property bundle: A flag indicating whether the product is a bundle.
- *
- * @property item: A flag indicating whether the product is a standard item.
- *
- * @property master: A flag indicating whether the product is a master.
- *
- * @property option: A flag indicating whether the product is an option.
- *
- * @property set: A flag indicating whether the product is a set.
- *
- * @property variant: A flag indicating whether the product is a variant.
- *
- * @property variationGroup: A flag indicating whether the product is a variation group.
- *
- */
-type ProductType = {
-    bundle?: boolean;
-    item?: boolean;
-    master?: boolean;
-    option?: boolean;
-    set?: boolean;
-    variant?: boolean;
-    variationGroup?: boolean;
-} & {
-    [key: string]: any;
-};
-/**
- * @type ProductPriceTable: Tiered Price Level Object
- *
- * @property price: Price for the product for the specified tier for the specified pricebook
- *
- * @property pricebook: The active pricebook for which this price is defined
- *
- * @property quantity: Quantity tier for which the price is defined.
- *
- */
-type ProductPriceTable = {
-    price?: number;
-    pricebook?: string;
-    quantity?: number;
-} & {
-    [key: string]: any;
-};
-/**
- * @type RecommendationType: Document representing a recommendation type.
- *
- * @property displayValue: The localized display value of the recommendation type.
- *
- * @property value: The value of the recommendation type.
- *
- */
-type RecommendationType = {
-    displayValue: string;
-    value: number;
-} & {
-    [key: string]: any;
-};
-/**
- * @type Recommendation: Document representing a product recommendation.
- *
- * @property calloutMsg: The localized callout message of the recommendation.
- *
- * @property image:
- *
- * @property longDescription: The localized long description of the recommendation.
- *
- * @property name: The localized name of the recommendation.
- *
- * @property recommendationType:
- *
- * @property recommendedItemId: The recommended item ID of the recommendation.
- *
- * @property shortDescription: The localized short description of the recommendation.
- *
- */
-type Recommendation = {
-    calloutMsg?: string;
-    image?: Image;
-    longDescription?: string;
-    name?: string;
-    recommendationType: RecommendationType;
-    recommendedItemId?: string;
-    shortDescription?: string;
-} & {
-    [key: string]: any;
-};
-/**
- * @type PriceRange: Document representing price ranges for a product which happens to be a master product (per Pricebook)
- *
- * @property maxPrice: Maximum price for the given pricebook (usually for a master Product would be the price for the Variant which has the highest price out of all Variants in that pricebook)
- *
- * @property minPrice: Minimum price for the given pricebook (usually for a master Product would be the price for the Variant which has the least price out of all Variants in that pricebook)
- *
- * @property pricebook: The active pricebook from which the min and the max prices are calculated. The pricebook is based on the site context of the request as defined in ECOM.
- *
- */
-type PriceRange = {
-    maxPrice?: number;
-    minPrice?: number;
-    pricebook?: string;
-} & {
-    [key: string]: any;
-};
-/**
- * @type ProductPromotion: Document representing a product promotion.
- *
- * @property calloutMsg: The localized call-out message of the promotion.
- *
- * @property promotionId: The unique ID of the promotion.
- *
- * @property promotionalPrice: The promotional price for this product.
- *
- */
-type ProductPromotion = {
-    calloutMsg: string;
-    promotionId: string;
-    promotionalPrice: number;
-} & {
-    [key: string]: any;
-};
-/**
- * A specialized value indicating the lack of definition of a currency, for example, if the value of the monetary value of the currency is an undefined number.
- */
-type NoValue = "N/A";
-/**
- * @type CurrencyCode
- * A three letter uppercase currency code conforming to the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard, or the string `N/A` indicating that a currency is not applicable.
- */
-type CurrencyCode = NoValue | string;
-/**
- * @type Master: The master product is a representation of a group of variant products. This is a non-buyable entity, provides inheritable attributes for its product variants, and is used for navigation. *Doesn\'t have a SKU.*
- *
- * @property masterId: The ID (SKU) of the master product.
- * - **Min Length:** 1
- * - **Max Length:** 100
- *
- * @property orderable: A flag indicating whether at least one of the variants can be ordered.
- *
- * @property price: The minimum sales price of the related variants.
- *
- * @property priceMax: The maximum sales price of the related variants.
- *
- * @property prices: List of sale prices.
- *
- */
-type Master = {
-    masterId: string;
-    orderable?: boolean;
-    price?: number;
-    priceMax?: number;
-    prices?: {
-        [key: string]: number;
-    };
-} & {
-    [key: string]: any;
-};
-/**
- * @type Variant: A product which is a variation within a master product that describes different colors, sizes, or other variation attributes. *Has a SKU.*
- *
- * @property orderable: A flag indicating whether the variant is orderable.
- *
- * @property price: The sales price of the variant.
- *
- * @property productId: The ID (SKU) of the variant.
- * - **Min Length:** 1
- * - **Max Length:** 100
- *
- * @property tieredPrices: List of tiered prices if the product is a variant
- *
- * @property variationValues: The actual variation attribute ID - value pairs.
- *
- */
-type Variant = {
-    orderable?: boolean;
-    price?: number;
-    productId: string;
-    tieredPrices?: Array<ProductPriceTable>;
-    variationValues?: {
-        [key: string]: string;
-    };
-} & {
-    [key: string]: any;
-};
-/**
- * @type PageMetaTag: Document representing a Page Meta Tag object.
- *
- * @property id: The ID of the Page Meta Tag.
- *
- * @property value: Locale-specific value of the Page Meta Tag, evaluated by resolving the rule set for the given Business Manager ID.
- *
- */
-type PageMetaTag = {
-    id?: string;
-    value?: string;
-} & {
-    [key: string]: any;
-};
-/**
- * @type ProductLink: Document representing a link between two products. It contains the ID of the source and target products, the type of  product link, and the URLs to retrieve product data.
- *
- * @property sourceProductId: The semantic ID of the product this product link is coming from.
- * - **Min Length:** 1
- * - **Max Length:** 100
- *
- * @property sourceProductLink: The URL addressing the product this product link is coming from.
- *
- * @property targetProductId: The semantic ID of the product this product link is pointing to.
- * - **Min Length:** 1
- * - **Max Length:** 100
- *
- * @property targetProductLink: The URL addressing the product this product link is pointing to.
- *
- * @property type: The type of product link.
- *
- */
-type ProductLink = {
-    sourceProductId: string;
-    sourceProductLink: string;
-    targetProductId: string;
-    targetProductLink: string;
-    type: ProductLinkTypeEnum;
-} & {
-    [key: string]: any;
-};
-type ProductLinkTypeEnum = "cross_sell" | "replacement" | "up_sell" | "accessory" | "newer_version" | "alt_orderunit" | "spare_part" | "other";
-/**
- * @type OptionValue: Document representing an option value.
- *
- * @property default: A flag indicating whether this option value is the default one.
- *
- * @property id: The ID of the option value.
- * - **Min Length:** 1
- * - **Max Length:** 100
- *
- * @property name: The localized name of the option value.
- *
- * @property price: The effective price of the option value.
- *
- */
-type OptionValue = {
-    default?: boolean;
-    id: string;
-    name?: string;
-    price?: number;
-} & {
-    [key: string]: any;
-};
-/**
- * @type Option: Product options enable you to sell configurable products that have optional accessories, upgrades, or additional services. Options are always purchased with a product and can\'t be purchased separately. *Product Option has a SKU and a price associated with it.*
- *
- * @property description: The localized description of the option.
- *
- * @property id: The ID of the option.
- * - **Min Length:** 1
- * - **Max Length:** 100
- *
- * @property image: The URL to the option image.
- *
- * @property name: The localized name of the option.
- *
- * @property values: The array of option values. This array can be empty.
- *
- */
-type Option = {
-    description?: string;
-    id: string;
-    image?: string;
-    name?: string;
-    values?: Array<OptionValue>;
-} & {
-    [key: string]: any;
-};
-/**
- * @type ImageGroup: Document representing an image group containing a list of images for a particular view type and an optional variation value.
- *
- * @property images: The images of the image group.
- *
- * @property variationAttributes: Returns a list of variation attributes applying to this image group.
- *
- * @property viewType: The image view type.
- *
- */
-type ImageGroup = {
-    images: Array<Image>;
-    variationAttributes?: Array<VariationAttribute>;
-    viewType: string;
-} & {
-    [key: string]: any;
-};
-/**
- * @type Inventory: Document representing inventory information of the current product for a particular inventory list.
- *
- * @property ats: The Available To Sell (ATS) of the product. If it is infinity, the return value is 999999. The value can be overwritten by the  OCAPI setting \'product.inventory.ats.max_threshold\'.
- *
- * @property backorderable: A flag indicating whether the product is backorderable.
- *
- * @property id: The inventory ID.
- * - **Min Length:** 1
- * - **Max Length:** 256
- *
- * @property inStockDate: A flag indicating the date when the product will be in stock.
- *
- * @property orderable: A flag indicating whether at least one of the products is available to sell.
- *
- * @property preorderable: A flag indicating whether the product is preorderable.
- *
- * @property stockLevel: The stock level of the product. If it is infinity, the return value is 999999. The value can be overwritten by the  OCAPI setting \'product.inventory.stock_level.max_threshold\'.
- *
- */
-type Inventory = {
-    ats?: number;
-    backorderable?: boolean;
-    id: string;
-    inStockDate?: string;
-    orderable?: boolean;
-    preorderable?: boolean;
-    stockLevel?: number;
-} & {
-    [key: string]: any;
-};
-/**
- * @type Product: Any product that is sold, shown alone, and does not have variations such as different sizes or colors. A product has no reliance on any other product for inheritance. *A product has a SKU and can have a product option, which has a different SKU*.
- *
- * @property brand: The product\'s brand.
- *
- * @property bundledProducts: The array of all bundled products of this product.
- *
- * @property currency:
- *
- * @property ean: The European Article Number of the product.
- *
- * @property fetchDate:
- *
- * @property id: The id (SKU) of the product.
- * - **Min Length:** 1
- * - **Max Length:** 100
- *
- * @property imageGroups: The array of product image groups.
- *
- * @property inventories: The array of product inventories explicitly requested via the \'inventory_ids\' query parameter. This property  is only returned in context of the \'availability\' expansion.
- *
- * @property inventory: The site default inventory information. This property is only  returned in context of the \'availability\' expansion.
- *
- * @property longDescription: The localized product\'s long description.
- *
- * @property manufacturerName: The product\'s manufacturer name.
- *
- * @property manufacturerSku: The product\'s manufacturer SKU.
- *
- * @property master: The master product information, only for types: master, variation group, and variant.
- *
- * @property minOrderQuantity: The minimum order quantity for this product.
- *
- * @property name: The localized product name.
- *
- * @property options: The array of product options, only for type option. This array can be empty.
- *
- * @property pageDescription: The localized product\'s page description.
- *
- * @property pageKeywords: The localized product\'s page description.
- *
- * @property pageTitle: The localized product\'s page title.
- *
- * @property pageMetaTags: Page Meta tags associated with the given product.
- *
- * @property price: The sales price of the product. In case of complex products, like master or set, this is the minimum price of  related child products.
- *
- * @property pricePerUnit: The price per unit if defined for the product
- *
- * @property pricePerUnitMax: The max price per unit typically for a master product\'s variant.
- *
- * @property priceMax: The maximum sales of related child products in complex products like master or set.
- *
- * @property priceRanges: Array of one or more price range objects representing one or more Pricebooks in context for the site.
- *
- * @property prices: The prices map with pricebook IDs and their values.
- *
- * @property primaryCategoryId: The ID of the products primary category.
- *
- * @property productLinks: The array of source and target product links information.
- *
- * @property productPromotions: An array of active customer product promotions for this product, sorted by promotion priority using SORT_BY_EXCLUSIVITY ordering (exclusivity → rank → promotion class → discount type → best discount → ID). This array can be empty. Coupon promotions are not returned in this array. See [PromotionPlan.SORT_BY_EXCLUSIVITY](https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/scriptapi/html/index.html?target=class_dw_campaign_PromotionPlan.html) for more details.
- *
- * @property recommendations: Returns a list of recommendations.
- *
- * @property setProducts: The array of set products of this product.
- *
- * @property shortDescription: The localized product short description.
- *
- * @property slugUrl: The complete link to this product\'s storefront page.
- *
- * @property stepQuantity: The steps in which the order amount of the product can be  increased.
- *
- * @property tieredPrices: The document represents list of tiered prices if the product is a variant
- *
- * @property type: The product type information. Can be one or more of the following values: item, master, variation_group, variant, bundle, and set.
- *
- * @property unit: The sales unit of the product.
- *
- * @property upc: The Universal Product Code (UPC).
- *
- * @property validFrom: The time a product is valid from.
- *
- * @property validTo: The time a product is valid to.
- *
- * @property variants: The array of actual variants. Only for master, variation group, and variant types. This array can be empty.
- *
- * @property variationAttributes: Sorted array of variation attributes information. Only for master,  variation group, and variant types. This array can be empty.
- *
- * @property variationGroups: The array of actual variation groups. Only for master, variation group, and variant types. This array can be empty.
- *
- * @property variationValues: The actual variation attribute ID - value pairs. Only for variant and  variation group types.
- *
- */
-type Product = {
-    brand?: string;
-    bundledProducts?: Array<BundledProduct>;
-    currency?: CurrencyCode;
-    ean?: string;
-    fetchDate?: number;
-    id: string;
-    imageGroups?: Array<ImageGroup>;
-    inventories?: Array<Inventory>;
-    inventory?: Inventory;
-    longDescription?: string;
-    manufacturerName?: string;
-    manufacturerSku?: string;
-    master?: Master;
-    minOrderQuantity?: number;
-    name?: string;
-    options?: Array<Option>;
-    pageDescription?: string;
-    pageKeywords?: string;
-    pageTitle?: string;
-    pageMetaTags?: Array<PageMetaTag>;
-    price?: number;
-    pricePerUnit?: number;
-    pricePerUnitMax?: number;
-    priceMax?: number;
-    priceRanges?: Array<PriceRange>;
-    prices?: {
-        [key: string]: number;
-    };
-    primaryCategoryId?: string;
-    productLinks?: Array<ProductLink>;
-    productPromotions?: Array<ProductPromotion>;
-    recommendations?: Array<Recommendation>;
-    setProducts?: Array<Product>;
-    shortDescription?: string;
-    slugUrl?: string;
-    stepQuantity?: number;
-    tieredPrices?: Array<ProductPriceTable>;
-    type?: ProductType;
-    unit?: string;
-    upc?: string;
-    validFrom?: string;
-    validTo?: string;
-    variants?: Array<Variant>;
-    variationAttributes?: Array<VariationAttribute>;
-    variationGroups?: Array<VariationGroup>;
-    variationValues?: {
-        [key: string]: string;
-    };
-} & {
-    [key: string]: any;
-};
-/**
- * @type BundledProduct: A bundle of products that can be bought together (all or nothing). Each product in the bundle can itself be bought independently, but this is outside of the context of the bundle. A bundle is a purchasing convenience. *Product bundle has a SKU and price.*
- *
- * @property id:
- *
- * @property product: The product being bundled.
- *
- * @property quantity: For the product being bundled, the quantity added to the bundle.
- *
- */
-type BundledProduct = {
-    id: string;
-    product: Product;
-    quantity: number;
-} & {
-    [key: string]: any;
-};
-/**
- * @type PathRecord: Document representing most basic info (id and name) of a category or catalog.
- *
- * @property id: The id of the category path.
- *
- * @property name: The name of the category path.
- *
- */
-type PathRecord = {
-    id?: string;
-    name?: string;
-} & {
-    [key: string]: any;
-};
-/**
- * @type Category: Categories allow products to be organized into hierarchical structures. Categories can have relationships to other parent categories. Each category can also provide a context inherited by subcategories. For example, a category may have an attribute value assigned to it, and any product assigned to the category or a subcategory would inherit the attribute value as long as the product is assigned. Once the product is removed from the category those attribute values would no longer be in the context of the product. Linking of categories is also used for Site hierarchical navigation. For example, inside \'Clothing\' you may have \'Mens\', and inside \'Mens\' you may have \'Pants\'. Categories are not *Tags.*
- *
- * @property categories: Array of subcategories. Can be empty.
- *
- * @property description: The localized description of the category.
- *
- * @property id: The ID of the category.
- * - **Min Length:** 1
- * - **Max Length:** 256
- *
- * @property image: The URL of the category image.
- *
- * @property name: The localized name of the category.
- *
- * @property onlineSubCategoriesCount: The total number of online sub-categories. This information will be available from B2C Commerce version 24.5.
- *
- * @property pageDescription: The localized page description of the category.
- *
- * @property pageKeywords: The localized page keywords of the category.
- *
- * @property pageTitle: The localized page title of the category.
- *
- * @property parentCategoryId: The ID of the parent category.
- *
- * @property parentCategoryTree: The List of the parent categories.
- *
- * @property thumbnail: The URL of the category thumbnail.
- *
- */
-type Category = {
-    categories?: Array<Category>;
-    description?: string;
-    id: string;
-    image?: string;
-    name?: string;
-    onlineSubCategoriesCount?: number;
-    pageDescription?: string;
-    pageKeywords?: string;
-    pageTitle?: string;
-    parentCategoryId?: string;
-    parentCategoryTree?: Array<PathRecord>;
-    thumbnail?: string;
-} & {
-    [key: string]: any;
-};
-/**
- * @type CategoryResult: Result document containing an array of categories.
- *
- * @property data: The array of category 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 CategoryResult = {
-    data: Array<Category>;
-    limit: number;
-    total: number;
-} & {
-    [key: string]: any;
-};
-/**
- * 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 ProductResult: Result document containing an array of products.
- *
- * @property limit: The number of returned documents.
- *
- * @property data: The array of product documents.
- *
- * @property total: The total number of documents.
- *
- */
-type ProductResult = {
-    limit: number;
-    data: Array<Product>;
-    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 GetCategoriesLevelsEnum = 0 | 1 | 2;
-type GetCategoryLevelsEnum = 0 | 1 | 2;
-type GetProductExpandEnum = "none" | "availability" | "bundled_products" | "links" | "promotions" | "options" | "images" | "prices" | "variations" | "set_products" | "recommendations" | "page_meta_tags";
-type GetProductsExpandEnum = "none" | "availability" | "links" | "promotions" | "options" | "images" | "prices" | "variations" | "recommendations" | "page_meta_tags";
-type getCategoriesQueryParameters = {
-    ids: Array<string>;
-    levels?: 0 | 1 | 2;
-    locale?: LocaleCode$0;
-    siteId: string;
-};
-type getCategoriesPathParameters = {
-    organizationId: string;
-};
-type getCategoryQueryParameters = {
-    levels?: 0 | 1 | 2;
-    locale?: LocaleCode$0;
-    siteId: string;
-};
-type getCategoryPathParameters = {
-    id: string;
-    organizationId: string;
-};
-type getProductQueryParameters = {
-    inventoryIds?: Array<string>;
-    expand?: Array<"none" | "availability" | "bundled_products" | "links" | "promotions" | "options" | "images" | "prices" | "variations" | "set_products" | "recommendations" | "page_meta_tags">;
-    allImages?: boolean;
-    perPricebook?: boolean;
-    select?: string;
-    currency?: CurrencyCode;
-    locale?: LocaleCode$0;
-    siteId: string;
-};
-type getProductPathParameters = {
-    organizationId: string;
-    id: string;
-};
-type getProductsQueryParameters = {
-    ids: Array<string>;
-    inventoryIds?: Array<string>;
-    expand?: Array<"none" | "availability" | "links" | "promotions" | "options" | "images" | "prices" | "variations" | "recommendations" | "page_meta_tags">;
-    allImages?: boolean;
-    perPricebook?: boolean;
-    siteId: string;
-    select?: string;
-    locale?: LocaleCode$0;
-    currency?: CurrencyCode;
-};
-type getProductsPathParameters = {
-    organizationId: string;
-};
-/**
- * All path parameters that are used by at least one ShopperProducts method.
- */
-type ShopperProductsPathParameters = Partial<getCategoriesPathParameters & getCategoryPathParameters & getProductPathParameters & getProductsPathParameters & {}>;
-/**
- * All query parameters that are used by at least one ShopperProducts method.
- */
-type ShopperProductsQueryParameters = Partial<getCategoriesQueryParameters & getCategoryQueryParameters & getProductQueryParameters & getProductsQueryParameters & {}>;
-/**
- * All parameters that are used by ShopperProducts.
- */
-type ShopperProductsParameters = ShopperProductsPathParameters & BaseUriParameters & ShopperProductsQueryParameters;
-/**
- * [Shopper Products](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-products:Summary)
- * ==================================
- *
- * *# API Overview
- 
- The Shopper Products API enables you to access product details for products that are online, merchandised to a particular site catalog, and ready to be sold. You can use these product details to merchandise the product on other ecommerce channels. To set up category navigation paths on other commerce apps or storefronts, you can use the Categories API.
- 
- Caching is provided for the Shopper Products 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 client requesting the product information must have access to the Products resource. The Shopper Products 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#guest-user) and [private clients](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas-private-client.html#guest-user) in the SLAS guides.
- 
- ## Use Cases
- 
- ### Populate Product Listing Pages
- 
- Use the Shopper Product API so that a customer, browsing on a commerce shopping app built using Commerce Cloud APIs, can see a list of products. For example, hydrate a list of products (max 24). The API returns product details including images, prices, promotions, and product availability.
- 
- ![b2c-commerce-shopper-products-screenshot-1.png](https://resources.docs.salesforce.com/rel1/doc/en-us/static/misc/b2c-commerce-shopper-products-screenshot-1.png)
- 
- ### Get Variation Product Details on an Ecommerce Channel
- 
- Use the API so that a customer, browsing on a commerce shopping app built using Commerce Cloud APIs, can switch between different variation products. The API returns product details including images, prices, promotions, and available to sell inventory.
- 
- ![b2c-commerce-shopper-products-screenshot-2.png](https://resources.docs.salesforce.com/rel1/doc/en-us/static/misc/b2c-commerce-shopper-products-screenshot-2.png)
- 
- ### Retrieve Promotion Information
- 
- Promotions provide discounts to shoppers when they meet certain purchase requirements.
- 
- Promotion information is described in detail in [Promotion Details](https://developer.salesforce.com/docs/commerce/commerce-api/guide/promotion-details.html), but the following list provides several key points:
- 
- - Pricing discounts for basket and shipping promotions are NEVER returned by the 'getProduct' or 'getProducts' endpoint.
- - Promotional pricing is ONLY returned for products that are included with non-conditional promotions.
- - Callout messages are ALWAYS returned by the 'getProduct' and 'getProducts' endpoints.
- 
- By default, 'getProduct' and 'getProducts' return promotion information for a queried product. Promotion information includes both pricing and callout message information. However, the specific pricing and callout information that is fetched is determined by:
- 
- - Promotion Type
- - Product Type
- - Product Purchase Requirements
- 
- Some promotions can be displayed on a Product Data Page (PDP) or Product Listing page (PLP), while other promotions are displayed in the context of a basket, such as an order level promotion: "add the product to your basket to view price information". It is important to understand what is included in the response when designing a PDP or PLP on top of SCAPI to ensure your design aligns with implementable features.
- 
- #### Shopper Personalization
- 
- The SCAPI response can be personalized using the Shopper Context API or hooks. By setting specific values in the Shopper Context API, you can modify the response of the 'getProduct' or 'getProducts' endpoint based on the shopper's context. For instance, you can offer a 5% discount or free shipping to shoppers using mobile devices.
- 
- #### JWA Caching
- 
- The response is cached in JWA, which means promotion data contained in the response is also cached based on the TTL (Time to Live) specified in the Business Manager [Feature Switches](https://help.salesforce.com/s/articleView?id=cc.b2c_feature_switches.htm&type=5) configuration.
- When the shopper context value is updated, a check is conducted to see if the updated shopper context affects the retrieval of product-promotion data. If it does, then the response is fetched from the source and cached in the JWA.
- 
- For details, see [Server-Side Web-Tier Caching.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html)
- 
- ### Use Hooks
- 
- For details working with hooks, see [Extensibility with Hooks.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/extensibility_via_hooks.html)
- 
- ### Test Description Changes
- 
- uoweefhewihpfhweipfiphwefhipwehfiewpifhewifiphehipeipwhfhipewfhiihpefipew
- 
- ## Resources
- 
- ### Product
- 
- A full representation of a product or service that is to merchandise. A ready to merchandise product is one that is online, categorized, and published to a channel. The information associated with a product includes, the product name, description, custom and system attributes, variations, price, availability, and images.
- 
- ### Category
- 
- Categories and subcategories are the structure by which products are organized and grouped in a catalog and on a storefront. Categories can have relationships to other categories. Further, each category can provide context that is inherited by subcategories. For example, a category can have an assigned attribute. A product assigned to that category or any subcategory inherits the categories’s attribute value. Once the product is removed from the category, the attribute value is no longer inherited by the product. You can also use category linking for site hierarchical navigation. For example, inside the Clothing category you may have Men’s, and inside the Men’s category you may have Pants.
- 
- Categories are not tags.
- 
- ## Endpoints
- 
- ### GET /products
- 
- Returns product details for up to 24 products in one API request. You can use this API for use cases that require populating or hydrating multiple products at a time, such as populating the Product Listing Pages.
- 
- The response data includes availability, promotions, images, and prices, along with the basic product information for the products requested.
- 
- ### GET /products/{id}
- 
- Returns product details about a single product. Use this API for use cases that require populating or hydrating one product at a time, such as the Product Detail Pages.
- 
- The response data includes availability, promotions, options, images, prices, variations, bundled_products, set_products, recommendations, and the basic product information for the product requested.
- 
- ### GET /categories
- 
- Returns category details including the parent child relationships for one or more categories. The limit on depth for the parent-child relationship is 2.*<br />
- *
- * Simple example:
- *
- * ```typescript
- *   import { ShopperProducts } from "commerce-sdk-isomorphic";
- *
- *   const clientConfig = {
- *     parameters: {
- *       clientId: "XXXXXX",
- *       organizationId: "XXXX",
- *       shortCode: "XXX",
- *       siteId: "XX"
- *     }
- *   };
- *   const shopperProductsClient = new ShopperProducts(clientConfig);
- * ```
- *
- * <span style="font-size:.7em; display:block; text-align: right">
- * API Version: 0.0.33<br />
- * Last Updated: <br />
- * </span>
- *
- *
- */
-declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters & 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/product/shopper-products/v1";
-    static readonly apiPaths: {
-        getCategories: string;
-        getCategory: string;
-        getProduct: string;
-        getProducts: string;
-    };
-    constructor(config: ClientConfigInit<ConfigParameters>);
-    static readonly paramKeys: {
-        readonly getCategories: readonly [
-            "organizationId",
-            "ids",
-            "siteId",
-            "levels",
-            "locale"
-        ];
-        readonly getCategoriesRequired: readonly [
-            "organizationId",
-            "ids",
-            "siteId"
-        ];
-        readonly getCategory: readonly [
-            "id",
-            "organizationId",
-            "siteId",
-            "levels",
-            "locale"
-        ];
-        readonly getCategoryRequired: readonly [
-            "id",
-            "organizationId",
-            "siteId"
-        ];
-        readonly getProduct: readonly [
-            "organizationId",
-            "id",
-            "siteId",
-            "inventoryIds",
-            "expand",
-            "allImages",
-            "perPricebook",
-            "select",
-            "currency",
-            "locale"
-        ];
-        readonly getProductRequired: readonly [
-            "organizationId",
-            "id",
-            "siteId"
-        ];
-        readonly getProducts: readonly [
-            "organizationId",
-            "ids",
-            "siteId",
-            "inventoryIds",
-            "expand",
-            "allImages",
-            "perPricebook",
-            "select",
-            "locale",
-            "currency"
-        ];
-        readonly getProductsRequired: readonly [
-            "organizationId",
-            "ids",
-            "siteId"
-        ];
-    };
-    /**
-     * When you use the URL template, the server returns multiple categories (a result object of category documents). You can use this template to obtain up to 50 categories in a single request. You must enclose the list of IDs in parentheses. If a category identifier contains parenthesis or the separator sign, you must URL encode the character.
-     *
-     * If you would like to get a raw Response object use the other getCategories 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.ids - The comma separated list of category IDs (max 50).
-     * @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.levels - Specifies how many levels of nested subcategories you want the server to return. The default value is 1. Valid values are 0, 1, or 2. Only online subcategories are returned.
-     * @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 CategoryResult.
-     */
-    getCategories(options?: RequireParametersUnlessAllAreOptional<{
-        parameters?: CompositeParameters<{
-            organizationId: string;
-            ids: Array<string>;
-            siteId: string;
-            levels?: GetCategoriesLevelsEnum;
-            locale?: LocaleCode$0;
-        } & QueryParameters, ConfigParameters>;
-        headers?: {
-            [key: string]: string;
-        };
-    }>): Promise<CategoryResult>;
-    /**
-     * When you use the URL template, the server returns multiple categories (a result object of category documents). You can use this template to obtain up to 50 categories in a single request. You must enclose the list of IDs in parentheses. If a category identifier contains parenthesis or the separator sign, you must URL encode the character.
-     *
-     * @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.ids - The comma separated list of category IDs (max 50).
-     * @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.levels - Specifies how many levels of nested subcategories you want the server to return. The default value is 1. Valid values are 0, 1, or 2. Only online subcategories are returned.
-     * @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 CategoryResult otherwise.
-     */
-    getCategories<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
-        parameters?: CompositeParameters<{
-            organizationId: string;
-            ids: Array<string>;
-            siteId: string;
-            levels?: GetCategoriesLevelsEnum;
-            locale?: LocaleCode$0;
-        } & QueryParameters, ConfigParameters>;
-        headers?: {
-            [key: string]: string;
-        };
-    }>, rawResponse?: T): Promise<T extends true ? Response : CategoryResult>;
-    /**
-     * When you use the URL template, the server returns a category identified by the ID. By default, the server
-     also returns the first level of subcategories, but you can specify an additional level using the levels
-     parameter.
-     
-     This endpoint fetches both online and offline categories. For offline categories, only the top-level
-     category is returned, not offline subcategories.
-     
-     Using a large value for levels can cause performance issues when there is a large and deep category tree.
-     *
-     * If you would like to get a raw Response object use the other getCategory 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.id - The ID of the requested category.
-     * @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.levels - Specifies how many levels of nested subcategories you want the server to return. The default value is 1. Valid values are 0, 1, or 2. Only online subcategories are returned.
-     * @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 Category.
-     */
-    getCategory(options?: RequireParametersUnlessAllAreOptional<{
-        parameters?: CompositeParameters<{
-            id: string;
-            organizationId: string;
-            siteId: string;
-            levels?: GetCategoryLevelsEnum;
-            locale?: LocaleCode$0;
-        } & QueryParameters, ConfigParameters>;
-        headers?: {
-            [key: string]: string;
-        };
-    }>): Promise<Category>;
-    /**
-     * When you use the URL template, the server returns a category identified by the ID. By default, the server
-     also returns the first level of subcategories, but you can specify an additional level using the levels
-     parameter.
-     
-     This endpoint fetches both online and offline categories. For offline categories, only the top-level
-     category is returned, not offline subcategories.
-     
-     Using a large value for levels can cause performance issues when there is a large and deep category tree.
-     *
-     * @param options - An object containing the options for this method.
-     * @param options.parameters - An object containing the parameters for this method.
-     * @param options.parameters.id - The ID of the requested category.
-     * @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.levels - Specifies how many levels of nested subcategories you want the server to return. The default value is 1. Valid values are 0, 1, or 2. Only online subcategories are returned.
-     * @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 Category otherwise.
-     */
-    getCategory<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
-        parameters?: CompositeParameters<{
-            id: string;
-            organizationId: string;
-            siteId: string;
-            levels?: GetCategoryLevelsEnum;
-            locale?: LocaleCode$0;
-        } & QueryParameters, ConfigParameters>;
-        headers?: {
-            [key: string]: string;
-        };
-    }>, rawResponse?: T): Promise<T extends true ? Response : Category>;
-    /**
-     * Allows access to product details for a single product ID. Only products that are online and assigned to a site catalog are returned. In addition to product details, the availability, images, price, bundled_products, set_products, recommedations, product options, variations, and promotions for the products are included, as applicable.
-     *
-     * If you would like to get a raw Response object use the other getProduct 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.id - The ID of the requested product.
-     * @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.inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
-     * @param options.parameters.expand - All expand parameters except page_meta_tags are used for the request when no expand parameter is provided.
-     The value "none" may be used to turn off all expand options.
-     The page_meta_tags expand value is optional and available starting from B2C Commerce version 25.2.
-     * @param options.parameters.allImages - The flag that indicates whether to retrieve the whole image model for the requested product.
-     * @param options.parameters.perPricebook - The flag that indicates whether to retrieve the per PriceBook prices and tiered prices (if available) for requested Products. Available end of June, 2021.
-     * @param options.parameters.select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names or work with wildcards. You can also specify array operations and filter expressions. The actual selector value must be enclosed within parentheses.
-     * @param options.parameters.currency - A three letter uppercase currency code conforming to the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard, or the string `N/A` indicating that a currency is not applicable.
-     * @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 Product.
-     */
-    getProduct(options?: RequireParametersUnlessAllAreOptional<{
-        parameters?: CompositeParameters<{
-            organizationId: string;
-            id: string;
-            siteId: string;
-            inventoryIds?: Array<string>;
-            expand?: Array<GetProductExpandEnum>;
-            allImages?: boolean;
-            perPricebook?: boolean;
-            select?: string;
-            currency?: CurrencyCode;
-            locale?: LocaleCode$0;
-        } & QueryParameters, ConfigParameters>;
-        headers?: {
-            [key: string]: string;
-        };
-    }>): Promise<Product>;
-    /**
-     * Allows access to product details for a single product ID. Only products that are online and assigned to a site catalog are returned. In addition to product details, the availability, images, price, bundled_products, set_products, recommedations, product options, variations, and promotions for the products are included, as applicable.
-     *
-     * @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.id - The ID of the requested product.
-     * @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.inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
-     * @param options.parameters.expand - All expand parameters except page_meta_tags are used for the request when no expand parameter is provided.
-     The value "none" may be used to turn off all expand options.
-     The page_meta_tags expand value is optional and available starting from B2C Commerce version 25.2.
-     * @param options.parameters.allImages - The flag that indicates whether to retrieve the whole image model for the requested product.
-     * @param options.parameters.perPricebook - The flag that indicates whether to retrieve the per PriceBook prices and tiered prices (if available) for requested Products. Available end of June, 2021.
-     * @param options.parameters.select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names or work with wildcards. You can also specify array operations and filter expressions. The actual selector value must be enclosed within parentheses.
-     * @param options.parameters.currency - A three letter uppercase currency code conforming to the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard, or the string `N/A` indicating that a currency is not applicable.
-     * @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 Product otherwise.
-     */
-    getProduct<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
-        parameters?: CompositeParameters<{
-            organizationId: string;
-            id: string;
-            siteId: string;
-            inventoryIds?: Array<string>;
-            expand?: Array<GetProductExpandEnum>;
-            allImages?: boolean;
-            perPricebook?: boolean;
-            select?: string;
-            currency?: CurrencyCode;
-            locale?: LocaleCode$0;
-        } & QueryParameters, ConfigParameters>;
-        headers?: {
-            [key: string]: string;
-        };
-    }>, rawResponse?: T): Promise<T extends true ? Response : Product>;
-    /**
-     * Allows access to multiple product details with a single request. Only products that are online and assigned to a site catalog are returned. The maximum number of product IDs that you can request is 24. In addition to product details, the availability, product options, images, price, promotions, and variations for the valid products are included, as applicable.
-     *
-     * If you would like to get a raw Response object use the other getProducts 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.ids - The IDs of the requested products (comma-separated, max 24 IDs).
-     * @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.inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
-     * @param options.parameters.expand - All expand parameters except page_meta_tags are used for the request when no expand parameter is provided.
-     The value "none" may be used to turn off all expand options.
-     The page_meta_tags expand value is optional and available starting from B2C Commerce version 25.2.
-     * @param options.parameters.allImages - The flag that indicates whether to retrieve the whole image model for the requested product.
-     * @param options.parameters.perPricebook - The flag that indicates whether to retrieve the per PriceBook prices and tiered prices (if available) for requested Products. Available end of June, 2021.
-     * @param options.parameters.select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names or work with wildcards. You can also specify array operations and filter expressions. The actual selector value must be enclosed within parentheses.
-     * @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.parameters.currency - A three letter uppercase currency code conforming to the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard, or the string `N/A` indicating that a currency is not applicable.
-     * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
-     *
-     * @returns A promise of type ProductResult.
-     */
-    getProducts(options?: RequireParametersUnlessAllAreOptional<{
-        parameters?: CompositeParameters<{
-            organizationId: string;
-            ids: Array<string>;
-            siteId: string;
-            inventoryIds?: Array<string>;
-            expand?: Array<GetProductsExpandEnum>;
-            allImages?: boolean;
-            perPricebook?: boolean;
-            select?: string;
-            locale?: LocaleCode$0;
-            currency?: CurrencyCode;
-        } & QueryParameters, ConfigParameters>;
-        headers?: {
-            [key: string]: string;
-        };
-    }>): Promise<ProductResult>;
-    /**
-     * Allows access to multiple product details with a single request. Only products that are online and assigned to a site catalog are returned. The maximum number of product IDs that you can request is 24. In addition to product details, the availability, product options, images, price, promotions, and variations for the valid products are included, as applicable.
-     *
-     * @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.ids - The IDs of the requested products (comma-separated, max 24 IDs).
-     * @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.inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
-     * @param options.parameters.expand - All expand parameters except page_meta_tags are used for the request when no expand parameter is provided.
-     The value "none" may be used to turn off all expand options.
-     The page_meta_tags expand value is optional and available starting from B2C Commerce version 25.2.
-     * @param options.parameters.allImages - The flag that indicates whether to retrieve the whole image model for the requested product.
-     * @param options.parameters.perPricebook - The flag that indicates whether to retrieve the per PriceBook prices and tiered prices (if available) for requested Products. Available end of June, 2021.
-     * @param options.parameters.select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names or work with wildcards. You can also specify array operations and filter expressions. The actual selector value must be enclosed within parentheses.
-     * @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.parameters.currency - A three letter uppercase currency code conforming to the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard, or the string `N/A` indicating that a currency is not applicable.
-     * @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 ProductResult otherwise.
-     */
-    getProducts<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
-        parameters?: CompositeParameters<{
-            organizationId: string;
-            ids: Array<string>;
-            siteId: string;
-            inventoryIds?: Array<string>;
-            expand?: Array<GetProductsExpandEnum>;
-            allImages?: boolean;
-            perPricebook?: boolean;
-            select?: string;
-            locale?: LocaleCode$0;
-            currency?: CurrencyCode;
-        } & QueryParameters, ConfigParameters>;
-        headers?: {
-            [key: string]: string;
-        };
-    }>, rawResponse?: T): Promise<T extends true ? Response : ProductResult>;
-}
-declare namespace ShopperProductsApiTypes {
-    /*
-    * 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 Image: Product image
-     *
-     * @property alt: The localized alternative text of the image.
-     *
-     * @property disBaseLink: Base URL for the Dynamic Image Service (DIS) address. This is only shown if the image is stored on the server and DIS is enabled.
-     *
-     * @property link: The URL of the actual image.
-     * - **Min Length:** 1
-     *
-     * @property title: The localized title of the image.
-     *
-     */
-    type Image = {
-        alt?: string;
-        disBaseLink?: string;
-        link: string;
-        title?: string;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type VariationAttributeValue: Document representing a variation attribute value.
-     *
-     * @property description: The localized description of the variation value.
-     *
-     * @property image: The first product image for the configured viewtype and this variation value.
-     *
-     * @property imageSwatch: The first product image for the configured viewtype and this variation value (typically the swatch image).
-     *
-     * @property name: The localized display name of the variation value.
-     *
-     * @property orderable: A flag indicating whether at least one variant with this variation attribute value is available to sell.
-     *
-     * @property value: The actual variation value.
-     * - **Min Length:** 1
-     *
-     */
-    type VariationAttributeValue = {
-        description?: string;
-        image?: Image;
-        imageSwatch?: Image;
-        name?: string;
-        orderable?: boolean;
-        value: string;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type VariationAttribute: Document representing a variation attribute.
-     *
-     * @property id: The ID of the variation attribute.
-     * - **Min Length:** 1
-     *
-     * @property name: The localized display name of the variation attribute.
-     *
-     * @property values: The sorted array of variation values. This array can be empty.
-     *
-     */
-    type VariationAttribute = {
-        id: string;
-        name?: string;
-        values?: Array<VariationAttributeValue>;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type VariationGroup: Representation of a group of variant products by an attribute. This is a non-buyable entity, provides inheritable attributes for its product variants, and is used for navigation. *Doesn\'t have a SKU.*
-     *
-     * @property orderable: A flag indicating whether the variation group is orderable.
-     *
-     * @property price: The sales price of the variation group.
-     *
-     * @property productId: The ID (SKU) of the variation group.
-     * - **Min Length:** 1
-     * - **Max Length:** 100
-     *
-     * @property variationValues: The actual variation attribute ID - value pairs.
-     *
-     */
-    type VariationGroup = {
-        orderable: boolean;
-        price: number;
-        productId: string;
-        variationValues: {
-            [key: string]: string;
-        };
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type ProductType: Document representing a product type.
-     *
-     * @property bundle: A flag indicating whether the product is a bundle.
-     *
-     * @property item: A flag indicating whether the product is a standard item.
-     *
-     * @property master: A flag indicating whether the product is a master.
-     *
-     * @property option: A flag indicating whether the product is an option.
-     *
-     * @property set: A flag indicating whether the product is a set.
-     *
-     * @property variant: A flag indicating whether the product is a variant.
-     *
-     * @property variationGroup: A flag indicating whether the product is a variation group.
-     *
-     */
-    type ProductType = {
-        bundle?: boolean;
-        item?: boolean;
-        master?: boolean;
-        option?: boolean;
-        set?: boolean;
-        variant?: boolean;
-        variationGroup?: boolean;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type ProductPriceTable: Tiered Price Level Object
-     *
-     * @property price: Price for the product for the specified tier for the specified pricebook
-     *
-     * @property pricebook: The active pricebook for which this price is defined
-     *
-     * @property quantity: Quantity tier for which the price is defined.
-     *
-     */
-    type ProductPriceTable = {
-        price?: number;
-        pricebook?: string;
-        quantity?: number;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type RecommendationType: Document representing a recommendation type.
-     *
-     * @property displayValue: The localized display value of the recommendation type.
-     *
-     * @property value: The value of the recommendation type.
-     *
-     */
-    type RecommendationType = {
-        displayValue: string;
-        value: number;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type Recommendation: Document representing a product recommendation.
-     *
-     * @property calloutMsg: The localized callout message of the recommendation.
-     *
-     * @property image:
-     *
-     * @property longDescription: The localized long description of the recommendation.
-     *
-     * @property name: The localized name of the recommendation.
-     *
-     * @property recommendationType:
-     *
-     * @property recommendedItemId: The recommended item ID of the recommendation.
-     *
-     * @property shortDescription: The localized short description of the recommendation.
-     *
-     */
-    type Recommendation = {
-        calloutMsg?: string;
-        image?: Image;
-        longDescription?: string;
-        name?: string;
-        recommendationType: RecommendationType;
-        recommendedItemId?: string;
-        shortDescription?: string;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type PriceRange: Document representing price ranges for a product which happens to be a master product (per Pricebook)
-     *
-     * @property maxPrice: Maximum price for the given pricebook (usually for a master Product would be the price for the Variant which has the highest price out of all Variants in that pricebook)
-     *
-     * @property minPrice: Minimum price for the given pricebook (usually for a master Product would be the price for the Variant which has the least price out of all Variants in that pricebook)
-     *
-     * @property pricebook: The active pricebook from which the min and the max prices are calculated. The pricebook is based on the site context of the request as defined in ECOM.
-     *
-     */
-    type PriceRange = {
-        maxPrice?: number;
-        minPrice?: number;
-        pricebook?: string;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type ProductPromotion: Document representing a product promotion.
-     *
-     * @property calloutMsg: The localized call-out message of the promotion.
-     *
-     * @property promotionId: The unique ID of the promotion.
-     *
-     * @property promotionalPrice: The promotional price for this product.
-     *
-     */
-    type ProductPromotion = {
-        calloutMsg: string;
-        promotionId: string;
-        promotionalPrice: number;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * A specialized value indicating the lack of definition of a currency, for example, if the value of the monetary value of the currency is an undefined number.
-     */
-    type NoValue = "N/A";
-    /**
-     * @type CurrencyCode
-     * A three letter uppercase currency code conforming to the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard, or the string `N/A` indicating that a currency is not applicable.
-     */
-    type CurrencyCode = NoValue | string;
-    /**
-     * @type Master: The master product is a representation of a group of variant products. This is a non-buyable entity, provides inheritable attributes for its product variants, and is used for navigation. *Doesn\'t have a SKU.*
-     *
-     * @property masterId: The ID (SKU) of the master product.
-     * - **Min Length:** 1
-     * - **Max Length:** 100
-     *
-     * @property orderable: A flag indicating whether at least one of the variants can be ordered.
-     *
-     * @property price: The minimum sales price of the related variants.
-     *
-     * @property priceMax: The maximum sales price of the related variants.
-     *
-     * @property prices: List of sale prices.
-     *
-     */
-    type Master = {
-        masterId: string;
-        orderable?: boolean;
-        price?: number;
-        priceMax?: number;
-        prices?: {
-            [key: string]: number;
-        };
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type Variant: A product which is a variation within a master product that describes different colors, sizes, or other variation attributes. *Has a SKU.*
-     *
-     * @property orderable: A flag indicating whether the variant is orderable.
-     *
-     * @property price: The sales price of the variant.
-     *
-     * @property productId: The ID (SKU) of the variant.
-     * - **Min Length:** 1
-     * - **Max Length:** 100
-     *
-     * @property tieredPrices: List of tiered prices if the product is a variant
-     *
-     * @property variationValues: The actual variation attribute ID - value pairs.
-     *
-     */
-    type Variant = {
-        orderable?: boolean;
-        price?: number;
-        productId: string;
-        tieredPrices?: Array<ProductPriceTable>;
-        variationValues?: {
-            [key: string]: string;
-        };
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type PageMetaTag: Document representing a Page Meta Tag object.
-     *
-     * @property id: The ID of the Page Meta Tag.
-     *
-     * @property value: Locale-specific value of the Page Meta Tag, evaluated by resolving the rule set for the given Business Manager ID.
-     *
-     */
-    type PageMetaTag = {
-        id?: string;
-        value?: string;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type ProductLink: Document representing a link between two products. It contains the ID of the source and target products, the type of  product link, and the URLs to retrieve product data.
-     *
-     * @property sourceProductId: The semantic ID of the product this product link is coming from.
-     * - **Min Length:** 1
-     * - **Max Length:** 100
-     *
-     * @property sourceProductLink: The URL addressing the product this product link is coming from.
-     *
-     * @property targetProductId: The semantic ID of the product this product link is pointing to.
-     * - **Min Length:** 1
-     * - **Max Length:** 100
-     *
-     * @property targetProductLink: The URL addressing the product this product link is pointing to.
-     *
-     * @property type: The type of product link.
-     *
-     */
-    type ProductLink = {
-        sourceProductId: string;
-        sourceProductLink: string;
-        targetProductId: string;
-        targetProductLink: string;
-        type: ProductLinkTypeEnum;
-    } & {
-        [key: string]: any;
-    };
-    type ProductLinkTypeEnum = "cross_sell" | "replacement" | "up_sell" | "accessory" | "newer_version" | "alt_orderunit" | "spare_part" | "other";
-    /**
-     * @type OptionValue: Document representing an option value.
-     *
-     * @property default: A flag indicating whether this option value is the default one.
-     *
-     * @property id: The ID of the option value.
-     * - **Min Length:** 1
-     * - **Max Length:** 100
-     *
-     * @property name: The localized name of the option value.
-     *
-     * @property price: The effective price of the option value.
-     *
-     */
-    type OptionValue = {
-        default?: boolean;
-        id: string;
-        name?: string;
-        price?: number;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type Option: Product options enable you to sell configurable products that have optional accessories, upgrades, or additional services. Options are always purchased with a product and can\'t be purchased separately. *Product Option has a SKU and a price associated with it.*
-     *
-     * @property description: The localized description of the option.
-     *
-     * @property id: The ID of the option.
-     * - **Min Length:** 1
-     * - **Max Length:** 100
-     *
-     * @property image: The URL to the option image.
-     *
-     * @property name: The localized name of the option.
-     *
-     * @property values: The array of option values. This array can be empty.
-     *
-     */
-    type Option = {
-        description?: string;
-        id: string;
-        image?: string;
-        name?: string;
-        values?: Array<OptionValue>;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type ImageGroup: Document representing an image group containing a list of images for a particular view type and an optional variation value.
-     *
-     * @property images: The images of the image group.
-     *
-     * @property variationAttributes: Returns a list of variation attributes applying to this image group.
-     *
-     * @property viewType: The image view type.
-     *
-     */
-    type ImageGroup = {
-        images: Array<Image>;
-        variationAttributes?: Array<VariationAttribute>;
-        viewType: string;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type Inventory: Document representing inventory information of the current product for a particular inventory list.
-     *
-     * @property ats: The Available To Sell (ATS) of the product. If it is infinity, the return value is 999999. The value can be overwritten by the  OCAPI setting \'product.inventory.ats.max_threshold\'.
-     *
-     * @property backorderable: A flag indicating whether the product is backorderable.
-     *
-     * @property id: The inventory ID.
-     * - **Min Length:** 1
-     * - **Max Length:** 256
-     *
-     * @property inStockDate: A flag indicating the date when the product will be in stock.
-     *
-     * @property orderable: A flag indicating whether at least one of the products is available to sell.
-     *
-     * @property preorderable: A flag indicating whether the product is preorderable.
-     *
-     * @property stockLevel: The stock level of the product. If it is infinity, the return value is 999999. The value can be overwritten by the  OCAPI setting \'product.inventory.stock_level.max_threshold\'.
-     *
-     */
-    type Inventory = {
-        ats?: number;
-        backorderable?: boolean;
-        id: string;
-        inStockDate?: string;
-        orderable?: boolean;
-        preorderable?: boolean;
-        stockLevel?: number;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type Product: Any product that is sold, shown alone, and does not have variations such as different sizes or colors. A product has no reliance on any other product for inheritance. *A product has a SKU and can have a product option, which has a different SKU*.
-     *
-     * @property brand: The product\'s brand.
-     *
-     * @property bundledProducts: The array of all bundled products of this product.
-     *
-     * @property currency:
-     *
-     * @property ean: The European Article Number of the product.
-     *
-     * @property fetchDate:
-     *
-     * @property id: The id (SKU) of the product.
-     * - **Min Length:** 1
-     * - **Max Length:** 100
-     *
-     * @property imageGroups: The array of product image groups.
-     *
-     * @property inventories: The array of product inventories explicitly requested via the \'inventory_ids\' query parameter. This property  is only returned in context of the \'availability\' expansion.
-     *
-     * @property inventory: The site default inventory information. This property is only  returned in context of the \'availability\' expansion.
-     *
-     * @property longDescription: The localized product\'s long description.
-     *
-     * @property manufacturerName: The product\'s manufacturer name.
-     *
-     * @property manufacturerSku: The product\'s manufacturer SKU.
-     *
-     * @property master: The master product information, only for types: master, variation group, and variant.
-     *
-     * @property minOrderQuantity: The minimum order quantity for this product.
-     *
-     * @property name: The localized product name.
-     *
-     * @property options: The array of product options, only for type option. This array can be empty.
-     *
-     * @property pageDescription: The localized product\'s page description.
-     *
-     * @property pageKeywords: The localized product\'s page description.
-     *
-     * @property pageTitle: The localized product\'s page title.
-     *
-     * @property pageMetaTags: Page Meta tags associated with the given product.
-     *
-     * @property price: The sales price of the product. In case of complex products, like master or set, this is the minimum price of  related child products.
-     *
-     * @property pricePerUnit: The price per unit if defined for the product
-     *
-     * @property pricePerUnitMax: The max price per unit typically for a master product\'s variant.
-     *
-     * @property priceMax: The maximum sales of related child products in complex products like master or set.
-     *
-     * @property priceRanges: Array of one or more price range objects representing one or more Pricebooks in context for the site.
-     *
-     * @property prices: The prices map with pricebook IDs and their values.
-     *
-     * @property primaryCategoryId: The ID of the products primary category.
-     *
-     * @property productLinks: The array of source and target product links information.
-     *
-     * @property productPromotions: An array of active customer product promotions for this product, sorted by promotion priority using SORT_BY_EXCLUSIVITY ordering (exclusivity → rank → promotion class → discount type → best discount → ID). This array can be empty. Coupon promotions are not returned in this array. See [PromotionPlan.SORT_BY_EXCLUSIVITY](https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/scriptapi/html/index.html?target=class_dw_campaign_PromotionPlan.html) for more details.
-     *
-     * @property recommendations: Returns a list of recommendations.
-     *
-     * @property setProducts: The array of set products of this product.
-     *
-     * @property shortDescription: The localized product short description.
-     *
-     * @property slugUrl: The complete link to this product\'s storefront page.
-     *
-     * @property stepQuantity: The steps in which the order amount of the product can be  increased.
-     *
-     * @property tieredPrices: The document represents list of tiered prices if the product is a variant
-     *
-     * @property type: The product type information. Can be one or more of the following values: item, master, variation_group, variant, bundle, and set.
-     *
-     * @property unit: The sales unit of the product.
-     *
-     * @property upc: The Universal Product Code (UPC).
-     *
-     * @property validFrom: The time a product is valid from.
-     *
-     * @property validTo: The time a product is valid to.
-     *
-     * @property variants: The array of actual variants. Only for master, variation group, and variant types. This array can be empty.
-     *
-     * @property variationAttributes: Sorted array of variation attributes information. Only for master,  variation group, and variant types. This array can be empty.
-     *
-     * @property variationGroups: The array of actual variation groups. Only for master, variation group, and variant types. This array can be empty.
-     *
-     * @property variationValues: The actual variation attribute ID - value pairs. Only for variant and  variation group types.
-     *
-     */
-    type Product = {
-        brand?: string;
-        bundledProducts?: Array<BundledProduct>;
-        currency?: CurrencyCode;
-        ean?: string;
-        fetchDate?: number;
-        id: string;
-        imageGroups?: Array<ImageGroup>;
-        inventories?: Array<Inventory>;
-        inventory?: Inventory;
-        longDescription?: string;
-        manufacturerName?: string;
-        manufacturerSku?: string;
-        master?: Master;
-        minOrderQuantity?: number;
-        name?: string;
-        options?: Array<Option>;
-        pageDescription?: string;
-        pageKeywords?: string;
-        pageTitle?: string;
-        pageMetaTags?: Array<PageMetaTag>;
-        price?: number;
-        pricePerUnit?: number;
-        pricePerUnitMax?: number;
-        priceMax?: number;
-        priceRanges?: Array<PriceRange>;
-        prices?: {
-            [key: string]: number;
-        };
-        primaryCategoryId?: string;
-        productLinks?: Array<ProductLink>;
-        productPromotions?: Array<ProductPromotion>;
-        recommendations?: Array<Recommendation>;
-        setProducts?: Array<Product>;
-        shortDescription?: string;
-        slugUrl?: string;
-        stepQuantity?: number;
-        tieredPrices?: Array<ProductPriceTable>;
-        type?: ProductType;
-        unit?: string;
-        upc?: string;
-        validFrom?: string;
-        validTo?: string;
-        variants?: Array<Variant>;
-        variationAttributes?: Array<VariationAttribute>;
-        variationGroups?: Array<VariationGroup>;
-        variationValues?: {
-            [key: string]: string;
-        };
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type BundledProduct: A bundle of products that can be bought together (all or nothing). Each product in the bundle can itself be bought independently, but this is outside of the context of the bundle. A bundle is a purchasing convenience. *Product bundle has a SKU and price.*
-     *
-     * @property id:
-     *
-     * @property product: The product being bundled.
-     *
-     * @property quantity: For the product being bundled, the quantity added to the bundle.
-     *
-     */
-    type BundledProduct = {
-        id: string;
-        product: Product;
-        quantity: number;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type PathRecord: Document representing most basic info (id and name) of a category or catalog.
-     *
-     * @property id: The id of the category path.
-     *
-     * @property name: The name of the category path.
-     *
-     */
-    type PathRecord = {
-        id?: string;
-        name?: string;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type Category: Categories allow products to be organized into hierarchical structures. Categories can have relationships to other parent categories. Each category can also provide a context inherited by subcategories. For example, a category may have an attribute value assigned to it, and any product assigned to the category or a subcategory would inherit the attribute value as long as the product is assigned. Once the product is removed from the category those attribute values would no longer be in the context of the product. Linking of categories is also used for Site hierarchical navigation. For example, inside \'Clothing\' you may have \'Mens\', and inside \'Mens\' you may have \'Pants\'. Categories are not *Tags.*
-     *
-     * @property categories: Array of subcategories. Can be empty.
-     *
-     * @property description: The localized description of the category.
-     *
-     * @property id: The ID of the category.
-     * - **Min Length:** 1
-     * - **Max Length:** 256
-     *
-     * @property image: The URL of the category image.
-     *
-     * @property name: The localized name of the category.
-     *
-     * @property onlineSubCategoriesCount: The total number of online sub-categories. This information will be available from B2C Commerce version 24.5.
-     *
-     * @property pageDescription: The localized page description of the category.
-     *
-     * @property pageKeywords: The localized page keywords of the category.
-     *
-     * @property pageTitle: The localized page title of the category.
-     *
-     * @property parentCategoryId: The ID of the parent category.
-     *
-     * @property parentCategoryTree: The List of the parent categories.
-     *
-     * @property thumbnail: The URL of the category thumbnail.
-     *
-     */
-    type Category = {
-        categories?: Array<Category>;
-        description?: string;
-        id: string;
-        image?: string;
-        name?: string;
-        onlineSubCategoriesCount?: number;
-        pageDescription?: string;
-        pageKeywords?: string;
-        pageTitle?: string;
-        parentCategoryId?: string;
-        parentCategoryTree?: Array<PathRecord>;
-        thumbnail?: string;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type CategoryResult: Result document containing an array of categories.
-     *
-     * @property data: The array of category 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 CategoryResult = {
-        data: Array<Category>;
-        limit: number;
-        total: number;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * 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 ProductResult: Result document containing an array of products.
-     *
-     * @property limit: The number of returned documents.
-     *
-     * @property data: The array of product documents.
-     *
-     * @property total: The total number of documents.
-     *
-     */
-    type ProductResult = {
-        limit: number;
-        data: Array<Product>;
-        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 GetCategoriesLevelsEnum = 0 | 1 | 2;
-    type GetCategoryLevelsEnum = 0 | 1 | 2;
-    type GetProductExpandEnum = "none" | "availability" | "bundled_products" | "links" | "promotions" | "options" | "images" | "prices" | "variations" | "set_products" | "recommendations" | "page_meta_tags";
-    type GetProductsExpandEnum = "none" | "availability" | "links" | "promotions" | "options" | "images" | "prices" | "variations" | "recommendations" | "page_meta_tags";
-    type getCategoriesQueryParameters = {
-        ids: Array<string>;
-        levels?: 0 | 1 | 2;
-        locale?: LocaleCode$0;
-        siteId: string;
-    };
-    type getCategoriesPathParameters = {
-        organizationId: string;
-    };
-    type getCategoryQueryParameters = {
-        levels?: 0 | 1 | 2;
-        locale?: LocaleCode$0;
-        siteId: string;
-    };
-    type getCategoryPathParameters = {
-        id: string;
-        organizationId: string;
-    };
-    type getProductQueryParameters = {
-        inventoryIds?: Array<string>;
-        expand?: Array<"none" | "availability" | "bundled_products" | "links" | "promotions" | "options" | "images" | "prices" | "variations" | "set_products" | "recommendations" | "page_meta_tags">;
-        allImages?: boolean;
-        perPricebook?: boolean;
-        select?: string;
-        currency?: CurrencyCode;
-        locale?: LocaleCode$0;
-        siteId: string;
-    };
-    type getProductPathParameters = {
-        organizationId: string;
-        id: string;
-    };
-    type getProductsQueryParameters = {
-        ids: Array<string>;
-        inventoryIds?: Array<string>;
-        expand?: Array<"none" | "availability" | "links" | "promotions" | "options" | "images" | "prices" | "variations" | "recommendations" | "page_meta_tags">;
-        allImages?: boolean;
-        perPricebook?: boolean;
-        siteId: string;
-        select?: string;
-        locale?: LocaleCode$0;
-        currency?: CurrencyCode;
-    };
-    type getProductsPathParameters = {
-        organizationId: string;
-    };
-    /**
-     * All path parameters that are used by at least one ShopperProducts method.
-     */
-    type ShopperProductsPathParameters = Partial<getCategoriesPathParameters & getCategoryPathParameters & getProductPathParameters & getProductsPathParameters & {}>;
-    /**
-     * All query parameters that are used by at least one ShopperProducts method.
-     */
-    type ShopperProductsQueryParameters = Partial<getCategoriesQueryParameters & getCategoryQueryParameters & getProductQueryParameters & getProductsQueryParameters & {}>;
-    /**
-     * All parameters that are used by ShopperProducts.
-     */
-    type ShopperProductsParameters = ShopperProductsPathParameters & BaseUriParameters & ShopperProductsQueryParameters;
-    /**
-     * [Shopper Products](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-products:Summary)
-     * ==================================
-     *
-     * *# API Overview
-     
-     The Shopper Products API enables you to access product details for products that are online, merchandised to a particular site catalog, and ready to be sold. You can use these product details to merchandise the product on other ecommerce channels. To set up category navigation paths on other commerce apps or storefronts, you can use the Categories API.
-     
-     Caching is provided for the Shopper Products 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 client requesting the product information must have access to the Products resource. The Shopper Products 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#guest-user) and [private clients](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas-private-client.html#guest-user) in the SLAS guides.
-     
-     ## Use Cases
-     
-     ### Populate Product Listing Pages
-     
-     Use the Shopper Product API so that a customer, browsing on a commerce shopping app built using Commerce Cloud APIs, can see a list of products. For example, hydrate a list of products (max 24). The API returns product details including images, prices, promotions, and product availability.
-     
-     ![b2c-commerce-shopper-products-screenshot-1.png](https://resources.docs.salesforce.com/rel1/doc/en-us/static/misc/b2c-commerce-shopper-products-screenshot-1.png)
-     
-     ### Get Variation Product Details on an Ecommerce Channel
-     
-     Use the API so that a customer, browsing on a commerce shopping app built using Commerce Cloud APIs, can switch between different variation products. The API returns product details including images, prices, promotions, and available to sell inventory.
-     
-     ![b2c-commerce-shopper-products-screenshot-2.png](https://resources.docs.salesforce.com/rel1/doc/en-us/static/misc/b2c-commerce-shopper-products-screenshot-2.png)
-     
-     ### Retrieve Promotion Information
-     
-     Promotions provide discounts to shoppers when they meet certain purchase requirements.
-     
-     Promotion information is described in detail in [Promotion Details](https://developer.salesforce.com/docs/commerce/commerce-api/guide/promotion-details.html), but the following list provides several key points:
-     
-     - Pricing discounts for basket and shipping promotions are NEVER returned by the 'getProduct' or 'getProducts' endpoint.
-     - Promotional pricing is ONLY returned for products that are included with non-conditional promotions.
-     - Callout messages are ALWAYS returned by the 'getProduct' and 'getProducts' endpoints.
-     
-     By default, 'getProduct' and 'getProducts' return promotion information for a queried product. Promotion information includes both pricing and callout message information. However, the specific pricing and callout information that is fetched is determined by:
-     
-     - Promotion Type
-     - Product Type
-     - Product Purchase Requirements
-     
-     Some promotions can be displayed on a Product Data Page (PDP) or Product Listing page (PLP), while other promotions are displayed in the context of a basket, such as an order level promotion: "add the product to your basket to view price information". It is important to understand what is included in the response when designing a PDP or PLP on top of SCAPI to ensure your design aligns with implementable features.
-     
-     #### Shopper Personalization
-     
-     The SCAPI response can be personalized using the Shopper Context API or hooks. By setting specific values in the Shopper Context API, you can modify the response of the 'getProduct' or 'getProducts' endpoint based on the shopper's context. For instance, you can offer a 5% discount or free shipping to shoppers using mobile devices.
-     
-     #### JWA Caching
-     
-     The response is cached in JWA, which means promotion data contained in the response is also cached based on the TTL (Time to Live) specified in the Business Manager [Feature Switches](https://help.salesforce.com/s/articleView?id=cc.b2c_feature_switches.htm&type=5) configuration.
-     When the shopper context value is updated, a check is conducted to see if the updated shopper context affects the retrieval of product-promotion data. If it does, then the response is fetched from the source and cached in the JWA.
-     
-     For details, see [Server-Side Web-Tier Caching.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html)
-     
-     ### Use Hooks
-     
-     For details working with hooks, see [Extensibility with Hooks.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/extensibility_via_hooks.html)
-     
-     ### Test Description Changes
-     
-     uoweefhewihpfhweipfiphwefhipwehfiewpifhewifiphehipeipwhfhipewfhiihpefipew
-     
-     ## Resources
-     
-     ### Product
-     
-     A full representation of a product or service that is to merchandise. A ready to merchandise product is one that is online, categorized, and published to a channel. The information associated with a product includes, the product name, description, custom and system attributes, variations, price, availability, and images.
-     
-     ### Category
-     
-     Categories and subcategories are the structure by which products are organized and grouped in a catalog and on a storefront. Categories can have relationships to other categories. Further, each category can provide context that is inherited by subcategories. For example, a category can have an assigned attribute. A product assigned to that category or any subcategory inherits the categories’s attribute value. Once the product is removed from the category, the attribute value is no longer inherited by the product. You can also use category linking for site hierarchical navigation. For example, inside the Clothing category you may have Men’s, and inside the Men’s category you may have Pants.
-     
-     Categories are not tags.
-     
-     ## Endpoints
-     
-     ### GET /products
-     
-     Returns product details for up to 24 products in one API request. You can use this API for use cases that require populating or hydrating multiple products at a time, such as populating the Product Listing Pages.
-     
-     The response data includes availability, promotions, images, and prices, along with the basic product information for the products requested.
-     
-     ### GET /products/{id}
-     
-     Returns product details about a single product. Use this API for use cases that require populating or hydrating one product at a time, such as the Product Detail Pages.
-     
-     The response data includes availability, promotions, options, images, prices, variations, bundled_products, set_products, recommendations, and the basic product information for the product requested.
-     
-     ### GET /categories
-     
-     Returns category details including the parent child relationships for one or more categories. The limit on depth for the parent-child relationship is 2.*<br />
-     *
-     * Simple example:
-     *
-     * ```typescript
-     *   import { ShopperProducts } from "commerce-sdk-isomorphic";
-     *
-     *   const clientConfig = {
-     *     parameters: {
-     *       clientId: "XXXXXX",
-     *       organizationId: "XXXX",
-     *       shortCode: "XXX",
-     *       siteId: "XX"
-     *     }
-     *   };
-     *   const shopperProductsClient = new ShopperProducts(clientConfig);
-     * ```
-     *
-     * <span style="font-size:.7em; display:block; text-align: right">
-     * API Version: 0.0.33<br />
-     * Last Updated: <br />
-     * </span>
-     *
-     *
-     */
-    class ShopperProducts<ConfigParameters extends ShopperProductsParameters & 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/product/shopper-products/v1";
-        static readonly apiPaths: {
-            getCategories: string;
-            getCategory: string;
-            getProduct: string;
-            getProducts: string;
-        };
-        constructor(config: ClientConfigInit<ConfigParameters>);
-        static readonly paramKeys: {
-            readonly getCategories: readonly [
-                "organizationId",
-                "ids",
-                "siteId",
-                "levels",
-                "locale"
-            ];
-            readonly getCategoriesRequired: readonly [
-                "organizationId",
-                "ids",
-                "siteId"
-            ];
-            readonly getCategory: readonly [
-                "id",
-                "organizationId",
-                "siteId",
-                "levels",
-                "locale"
-            ];
-            readonly getCategoryRequired: readonly [
-                "id",
-                "organizationId",
-                "siteId"
-            ];
-            readonly getProduct: readonly [
-                "organizationId",
-                "id",
-                "siteId",
-                "inventoryIds",
-                "expand",
-                "allImages",
-                "perPricebook",
-                "select",
-                "currency",
-                "locale"
-            ];
-            readonly getProductRequired: readonly [
-                "organizationId",
-                "id",
-                "siteId"
-            ];
-            readonly getProducts: readonly [
-                "organizationId",
-                "ids",
-                "siteId",
-                "inventoryIds",
-                "expand",
-                "allImages",
-                "perPricebook",
-                "select",
-                "locale",
-                "currency"
-            ];
-            readonly getProductsRequired: readonly [
-                "organizationId",
-                "ids",
-                "siteId"
-            ];
-        };
-        /**
-         * When you use the URL template, the server returns multiple categories (a result object of category documents). You can use this template to obtain up to 50 categories in a single request. You must enclose the list of IDs in parentheses. If a category identifier contains parenthesis or the separator sign, you must URL encode the character.
-         *
-         * If you would like to get a raw Response object use the other getCategories 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.ids - The comma separated list of category IDs (max 50).
-         * @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.levels - Specifies how many levels of nested subcategories you want the server to return. The default value is 1. Valid values are 0, 1, or 2. Only online subcategories are returned.
-         * @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 CategoryResult.
-         */
-        getCategories(options?: RequireParametersUnlessAllAreOptional<{
-            parameters?: CompositeParameters<{
-                organizationId: string;
-                ids: Array<string>;
-                siteId: string;
-                levels?: GetCategoriesLevelsEnum;
-                locale?: LocaleCode$0;
-            } & QueryParameters, ConfigParameters>;
-            headers?: {
-                [key: string]: string;
-            };
-        }>): Promise<CategoryResult>;
-        /**
-         * When you use the URL template, the server returns multiple categories (a result object of category documents). You can use this template to obtain up to 50 categories in a single request. You must enclose the list of IDs in parentheses. If a category identifier contains parenthesis or the separator sign, you must URL encode the character.
-         *
-         * @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.ids - The comma separated list of category IDs (max 50).
-         * @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.levels - Specifies how many levels of nested subcategories you want the server to return. The default value is 1. Valid values are 0, 1, or 2. Only online subcategories are returned.
-         * @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 CategoryResult otherwise.
-         */
-        getCategories<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
-            parameters?: CompositeParameters<{
-                organizationId: string;
-                ids: Array<string>;
-                siteId: string;
-                levels?: GetCategoriesLevelsEnum;
-                locale?: LocaleCode$0;
-            } & QueryParameters, ConfigParameters>;
-            headers?: {
-                [key: string]: string;
-            };
-        }>, rawResponse?: T): Promise<T extends true ? Response : CategoryResult>;
-        /**
-         * When you use the URL template, the server returns a category identified by the ID. By default, the server
-         also returns the first level of subcategories, but you can specify an additional level using the levels
-         parameter.
-         
-         This endpoint fetches both online and offline categories. For offline categories, only the top-level
-         category is returned, not offline subcategories.
-         
-         Using a large value for levels can cause performance issues when there is a large and deep category tree.
-         *
-         * If you would like to get a raw Response object use the other getCategory 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.id - The ID of the requested category.
-         * @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.levels - Specifies how many levels of nested subcategories you want the server to return. The default value is 1. Valid values are 0, 1, or 2. Only online subcategories are returned.
-         * @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 Category.
-         */
-        getCategory(options?: RequireParametersUnlessAllAreOptional<{
-            parameters?: CompositeParameters<{
-                id: string;
-                organizationId: string;
-                siteId: string;
-                levels?: GetCategoryLevelsEnum;
-                locale?: LocaleCode$0;
-            } & QueryParameters, ConfigParameters>;
-            headers?: {
-                [key: string]: string;
-            };
-        }>): Promise<Category>;
-        /**
-         * When you use the URL template, the server returns a category identified by the ID. By default, the server
-         also returns the first level of subcategories, but you can specify an additional level using the levels
-         parameter.
-         
-         This endpoint fetches both online and offline categories. For offline categories, only the top-level
-         category is returned, not offline subcategories.
-         
-         Using a large value for levels can cause performance issues when there is a large and deep category tree.
-         *
-         * @param options - An object containing the options for this method.
-         * @param options.parameters - An object containing the parameters for this method.
-         * @param options.parameters.id - The ID of the requested category.
-         * @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.levels - Specifies how many levels of nested subcategories you want the server to return. The default value is 1. Valid values are 0, 1, or 2. Only online subcategories are returned.
-         * @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 Category otherwise.
-         */
-        getCategory<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
-            parameters?: CompositeParameters<{
-                id: string;
-                organizationId: string;
-                siteId: string;
-                levels?: GetCategoryLevelsEnum;
-                locale?: LocaleCode$0;
-            } & QueryParameters, ConfigParameters>;
-            headers?: {
-                [key: string]: string;
-            };
-        }>, rawResponse?: T): Promise<T extends true ? Response : Category>;
-        /**
-         * Allows access to product details for a single product ID. Only products that are online and assigned to a site catalog are returned. In addition to product details, the availability, images, price, bundled_products, set_products, recommedations, product options, variations, and promotions for the products are included, as applicable.
-         *
-         * If you would like to get a raw Response object use the other getProduct 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.id - The ID of the requested product.
-         * @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.inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
-         * @param options.parameters.expand - All expand parameters except page_meta_tags are used for the request when no expand parameter is provided.
-         The value "none" may be used to turn off all expand options.
-         The page_meta_tags expand value is optional and available starting from B2C Commerce version 25.2.
-         * @param options.parameters.allImages - The flag that indicates whether to retrieve the whole image model for the requested product.
-         * @param options.parameters.perPricebook - The flag that indicates whether to retrieve the per PriceBook prices and tiered prices (if available) for requested Products. Available end of June, 2021.
-         * @param options.parameters.select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names or work with wildcards. You can also specify array operations and filter expressions. The actual selector value must be enclosed within parentheses.
-         * @param options.parameters.currency - A three letter uppercase currency code conforming to the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard, or the string `N/A` indicating that a currency is not applicable.
-         * @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 Product.
-         */
-        getProduct(options?: RequireParametersUnlessAllAreOptional<{
-            parameters?: CompositeParameters<{
-                organizationId: string;
-                id: string;
-                siteId: string;
-                inventoryIds?: Array<string>;
-                expand?: Array<GetProductExpandEnum>;
-                allImages?: boolean;
-                perPricebook?: boolean;
-                select?: string;
-                currency?: CurrencyCode;
-                locale?: LocaleCode$0;
-            } & QueryParameters, ConfigParameters>;
-            headers?: {
-                [key: string]: string;
-            };
-        }>): Promise<Product>;
-        /**
-         * Allows access to product details for a single product ID. Only products that are online and assigned to a site catalog are returned. In addition to product details, the availability, images, price, bundled_products, set_products, recommedations, product options, variations, and promotions for the products are included, as applicable.
-         *
-         * @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.id - The ID of the requested product.
-         * @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.inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
-         * @param options.parameters.expand - All expand parameters except page_meta_tags are used for the request when no expand parameter is provided.
-         The value "none" may be used to turn off all expand options.
-         The page_meta_tags expand value is optional and available starting from B2C Commerce version 25.2.
-         * @param options.parameters.allImages - The flag that indicates whether to retrieve the whole image model for the requested product.
-         * @param options.parameters.perPricebook - The flag that indicates whether to retrieve the per PriceBook prices and tiered prices (if available) for requested Products. Available end of June, 2021.
-         * @param options.parameters.select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names or work with wildcards. You can also specify array operations and filter expressions. The actual selector value must be enclosed within parentheses.
-         * @param options.parameters.currency - A three letter uppercase currency code conforming to the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard, or the string `N/A` indicating that a currency is not applicable.
-         * @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 Product otherwise.
-         */
-        getProduct<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
-            parameters?: CompositeParameters<{
-                organizationId: string;
-                id: string;
-                siteId: string;
-                inventoryIds?: Array<string>;
-                expand?: Array<GetProductExpandEnum>;
-                allImages?: boolean;
-                perPricebook?: boolean;
-                select?: string;
-                currency?: CurrencyCode;
-                locale?: LocaleCode$0;
-            } & QueryParameters, ConfigParameters>;
-            headers?: {
-                [key: string]: string;
-            };
-        }>, rawResponse?: T): Promise<T extends true ? Response : Product>;
-        /**
-         * Allows access to multiple product details with a single request. Only products that are online and assigned to a site catalog are returned. The maximum number of product IDs that you can request is 24. In addition to product details, the availability, product options, images, price, promotions, and variations for the valid products are included, as applicable.
-         *
-         * If you would like to get a raw Response object use the other getProducts 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.ids - The IDs of the requested products (comma-separated, max 24 IDs).
-         * @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.inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
-         * @param options.parameters.expand - All expand parameters except page_meta_tags are used for the request when no expand parameter is provided.
-         The value "none" may be used to turn off all expand options.
-         The page_meta_tags expand value is optional and available starting from B2C Commerce version 25.2.
-         * @param options.parameters.allImages - The flag that indicates whether to retrieve the whole image model for the requested product.
-         * @param options.parameters.perPricebook - The flag that indicates whether to retrieve the per PriceBook prices and tiered prices (if available) for requested Products. Available end of June, 2021.
-         * @param options.parameters.select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names or work with wildcards. You can also specify array operations and filter expressions. The actual selector value must be enclosed within parentheses.
-         * @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.parameters.currency - A three letter uppercase currency code conforming to the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard, or the string `N/A` indicating that a currency is not applicable.
-         * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
-         *
-         * @returns A promise of type ProductResult.
-         */
-        getProducts(options?: RequireParametersUnlessAllAreOptional<{
-            parameters?: CompositeParameters<{
-                organizationId: string;
-                ids: Array<string>;
-                siteId: string;
-                inventoryIds?: Array<string>;
-                expand?: Array<GetProductsExpandEnum>;
-                allImages?: boolean;
-                perPricebook?: boolean;
-                select?: string;
-                locale?: LocaleCode$0;
-                currency?: CurrencyCode;
-            } & QueryParameters, ConfigParameters>;
-            headers?: {
-                [key: string]: string;
-            };
-        }>): Promise<ProductResult>;
-        /**
-         * Allows access to multiple product details with a single request. Only products that are online and assigned to a site catalog are returned. The maximum number of product IDs that you can request is 24. In addition to product details, the availability, product options, images, price, promotions, and variations for the valid products are included, as applicable.
-         *
-         * @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.ids - The IDs of the requested products (comma-separated, max 24 IDs).
-         * @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.inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
-         * @param options.parameters.expand - All expand parameters except page_meta_tags are used for the request when no expand parameter is provided.
-         The value "none" may be used to turn off all expand options.
-         The page_meta_tags expand value is optional and available starting from B2C Commerce version 25.2.
-         * @param options.parameters.allImages - The flag that indicates whether to retrieve the whole image model for the requested product.
-         * @param options.parameters.perPricebook - The flag that indicates whether to retrieve the per PriceBook prices and tiered prices (if available) for requested Products. Available end of June, 2021.
-         * @param options.parameters.select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names or work with wildcards. You can also specify array operations and filter expressions. The actual selector value must be enclosed within parentheses.
-         * @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.parameters.currency - A three letter uppercase currency code conforming to the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard, or the string `N/A` indicating that a currency is not applicable.
-         * @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 ProductResult otherwise.
-         */
-        getProducts<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
-            parameters?: CompositeParameters<{
-                organizationId: string;
-                ids: Array<string>;
-                siteId: string;
-                inventoryIds?: Array<string>;
-                expand?: Array<GetProductsExpandEnum>;
-                allImages?: boolean;
-                perPricebook?: boolean;
-                select?: string;
-                locale?: LocaleCode$0;
-                currency?: CurrencyCode;
-            } & QueryParameters, ConfigParameters>;
-            headers?: {
-                [key: string]: string;
-            };
-        }>, rawResponse?: T): Promise<T extends true ? Response : ProductResult>;
-    }
-}
-declare namespace ShopperProductsModelTypes {
-    /**
-     * @type Image: Product image
-     *
-     * @property alt: The localized alternative text of the image.
-     *
-     * @property disBaseLink: Base URL for the Dynamic Image Service (DIS) address. This is only shown if the image is stored on the server and DIS is enabled.
-     *
-     * @property link: The URL of the actual image.
-     * - **Min Length:** 1
-     *
-     * @property title: The localized title of the image.
-     *
-     */
-    type Image = {
-        alt?: string;
-        disBaseLink?: string;
-        link: string;
-        title?: string;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type VariationAttributeValue: Document representing a variation attribute value.
-     *
-     * @property description: The localized description of the variation value.
-     *
-     * @property image: The first product image for the configured viewtype and this variation value.
-     *
-     * @property imageSwatch: The first product image for the configured viewtype and this variation value (typically the swatch image).
-     *
-     * @property name: The localized display name of the variation value.
-     *
-     * @property orderable: A flag indicating whether at least one variant with this variation attribute value is available to sell.
-     *
-     * @property value: The actual variation value.
-     * - **Min Length:** 1
-     *
-     */
-    type VariationAttributeValue = {
-        description?: string;
-        image?: Image;
-        imageSwatch?: Image;
-        name?: string;
-        orderable?: boolean;
-        value: string;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type VariationAttribute: Document representing a variation attribute.
-     *
-     * @property id: The ID of the variation attribute.
-     * - **Min Length:** 1
-     *
-     * @property name: The localized display name of the variation attribute.
-     *
-     * @property values: The sorted array of variation values. This array can be empty.
-     *
-     */
-    type VariationAttribute = {
-        id: string;
-        name?: string;
-        values?: Array<VariationAttributeValue>;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type VariationGroup: Representation of a group of variant products by an attribute. This is a non-buyable entity, provides inheritable attributes for its product variants, and is used for navigation. *Doesn\'t have a SKU.*
-     *
-     * @property orderable: A flag indicating whether the variation group is orderable.
-     *
-     * @property price: The sales price of the variation group.
-     *
-     * @property productId: The ID (SKU) of the variation group.
-     * - **Min Length:** 1
-     * - **Max Length:** 100
-     *
-     * @property variationValues: The actual variation attribute ID - value pairs.
-     *
-     */
-    type VariationGroup = {
-        orderable: boolean;
-        price: number;
-        productId: string;
-        variationValues: {
-            [key: string]: string;
-        };
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type ProductType: Document representing a product type.
-     *
-     * @property bundle: A flag indicating whether the product is a bundle.
-     *
-     * @property item: A flag indicating whether the product is a standard item.
-     *
-     * @property master: A flag indicating whether the product is a master.
-     *
-     * @property option: A flag indicating whether the product is an option.
-     *
-     * @property set: A flag indicating whether the product is a set.
-     *
-     * @property variant: A flag indicating whether the product is a variant.
-     *
-     * @property variationGroup: A flag indicating whether the product is a variation group.
-     *
-     */
-    type ProductType = {
-        bundle?: boolean;
-        item?: boolean;
-        master?: boolean;
-        option?: boolean;
-        set?: boolean;
-        variant?: boolean;
-        variationGroup?: boolean;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type ProductPriceTable: Tiered Price Level Object
-     *
-     * @property price: Price for the product for the specified tier for the specified pricebook
-     *
-     * @property pricebook: The active pricebook for which this price is defined
-     *
-     * @property quantity: Quantity tier for which the price is defined.
-     *
-     */
-    type ProductPriceTable = {
-        price?: number;
-        pricebook?: string;
-        quantity?: number;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type RecommendationType: Document representing a recommendation type.
-     *
-     * @property displayValue: The localized display value of the recommendation type.
-     *
-     * @property value: The value of the recommendation type.
-     *
-     */
-    type RecommendationType = {
-        displayValue: string;
-        value: number;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type Recommendation: Document representing a product recommendation.
-     *
-     * @property calloutMsg: The localized callout message of the recommendation.
-     *
-     * @property image:
-     *
-     * @property longDescription: The localized long description of the recommendation.
-     *
-     * @property name: The localized name of the recommendation.
-     *
-     * @property recommendationType:
-     *
-     * @property recommendedItemId: The recommended item ID of the recommendation.
-     *
-     * @property shortDescription: The localized short description of the recommendation.
-     *
-     */
-    type Recommendation = {
-        calloutMsg?: string;
-        image?: Image;
-        longDescription?: string;
-        name?: string;
-        recommendationType: RecommendationType;
-        recommendedItemId?: string;
-        shortDescription?: string;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type PriceRange: Document representing price ranges for a product which happens to be a master product (per Pricebook)
-     *
-     * @property maxPrice: Maximum price for the given pricebook (usually for a master Product would be the price for the Variant which has the highest price out of all Variants in that pricebook)
-     *
-     * @property minPrice: Minimum price for the given pricebook (usually for a master Product would be the price for the Variant which has the least price out of all Variants in that pricebook)
-     *
-     * @property pricebook: The active pricebook from which the min and the max prices are calculated. The pricebook is based on the site context of the request as defined in ECOM.
-     *
-     */
-    type PriceRange = {
-        maxPrice?: number;
-        minPrice?: number;
-        pricebook?: string;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type ProductPromotion: Document representing a product promotion.
-     *
-     * @property calloutMsg: The localized call-out message of the promotion.
-     *
-     * @property promotionId: The unique ID of the promotion.
-     *
-     * @property promotionalPrice: The promotional price for this product.
-     *
-     */
-    type ProductPromotion = {
-        calloutMsg: string;
-        promotionId: string;
-        promotionalPrice: number;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * A specialized value indicating the lack of definition of a currency, for example, if the value of the monetary value of the currency is an undefined number.
-     */
-    type NoValue = "N/A";
-    /**
-     * @type CurrencyCode
-     * A three letter uppercase currency code conforming to the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard, or the string `N/A` indicating that a currency is not applicable.
-     */
-    type CurrencyCode = NoValue | string;
-    /**
-     * @type Master: The master product is a representation of a group of variant products. This is a non-buyable entity, provides inheritable attributes for its product variants, and is used for navigation. *Doesn\'t have a SKU.*
-     *
-     * @property masterId: The ID (SKU) of the master product.
-     * - **Min Length:** 1
-     * - **Max Length:** 100
-     *
-     * @property orderable: A flag indicating whether at least one of the variants can be ordered.
-     *
-     * @property price: The minimum sales price of the related variants.
-     *
-     * @property priceMax: The maximum sales price of the related variants.
-     *
-     * @property prices: List of sale prices.
-     *
-     */
-    type Master = {
-        masterId: string;
-        orderable?: boolean;
-        price?: number;
-        priceMax?: number;
-        prices?: {
-            [key: string]: number;
-        };
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type Variant: A product which is a variation within a master product that describes different colors, sizes, or other variation attributes. *Has a SKU.*
-     *
-     * @property orderable: A flag indicating whether the variant is orderable.
-     *
-     * @property price: The sales price of the variant.
-     *
-     * @property productId: The ID (SKU) of the variant.
-     * - **Min Length:** 1
-     * - **Max Length:** 100
-     *
-     * @property tieredPrices: List of tiered prices if the product is a variant
-     *
-     * @property variationValues: The actual variation attribute ID - value pairs.
-     *
-     */
-    type Variant = {
-        orderable?: boolean;
-        price?: number;
-        productId: string;
-        tieredPrices?: Array<ProductPriceTable>;
-        variationValues?: {
-            [key: string]: string;
-        };
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type PageMetaTag: Document representing a Page Meta Tag object.
-     *
-     * @property id: The ID of the Page Meta Tag.
-     *
-     * @property value: Locale-specific value of the Page Meta Tag, evaluated by resolving the rule set for the given Business Manager ID.
-     *
-     */
-    type PageMetaTag = {
-        id?: string;
-        value?: string;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type ProductLink: Document representing a link between two products. It contains the ID of the source and target products, the type of  product link, and the URLs to retrieve product data.
-     *
-     * @property sourceProductId: The semantic ID of the product this product link is coming from.
-     * - **Min Length:** 1
-     * - **Max Length:** 100
-     *
-     * @property sourceProductLink: The URL addressing the product this product link is coming from.
-     *
-     * @property targetProductId: The semantic ID of the product this product link is pointing to.
-     * - **Min Length:** 1
-     * - **Max Length:** 100
-     *
-     * @property targetProductLink: The URL addressing the product this product link is pointing to.
-     *
-     * @property type: The type of product link.
-     *
-     */
-    type ProductLink = {
-        sourceProductId: string;
-        sourceProductLink: string;
-        targetProductId: string;
-        targetProductLink: string;
-        type: ProductLinkTypeEnum;
-    } & {
-        [key: string]: any;
-    };
-    type ProductLinkTypeEnum = "cross_sell" | "replacement" | "up_sell" | "accessory" | "newer_version" | "alt_orderunit" | "spare_part" | "other";
-    /**
-     * @type OptionValue: Document representing an option value.
-     *
-     * @property default: A flag indicating whether this option value is the default one.
-     *
-     * @property id: The ID of the option value.
-     * - **Min Length:** 1
-     * - **Max Length:** 100
-     *
-     * @property name: The localized name of the option value.
-     *
-     * @property price: The effective price of the option value.
-     *
-     */
-    type OptionValue = {
-        default?: boolean;
-        id: string;
-        name?: string;
-        price?: number;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type Option: Product options enable you to sell configurable products that have optional accessories, upgrades, or additional services. Options are always purchased with a product and can\'t be purchased separately. *Product Option has a SKU and a price associated with it.*
-     *
-     * @property description: The localized description of the option.
-     *
-     * @property id: The ID of the option.
-     * - **Min Length:** 1
-     * - **Max Length:** 100
-     *
-     * @property image: The URL to the option image.
-     *
-     * @property name: The localized name of the option.
-     *
-     * @property values: The array of option values. This array can be empty.
-     *
-     */
-    type Option = {
-        description?: string;
-        id: string;
-        image?: string;
-        name?: string;
-        values?: Array<OptionValue>;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type ImageGroup: Document representing an image group containing a list of images for a particular view type and an optional variation value.
-     *
-     * @property images: The images of the image group.
-     *
-     * @property variationAttributes: Returns a list of variation attributes applying to this image group.
-     *
-     * @property viewType: The image view type.
-     *
-     */
-    type ImageGroup = {
-        images: Array<Image>;
-        variationAttributes?: Array<VariationAttribute>;
-        viewType: string;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type Inventory: Document representing inventory information of the current product for a particular inventory list.
-     *
-     * @property ats: The Available To Sell (ATS) of the product. If it is infinity, the return value is 999999. The value can be overwritten by the  OCAPI setting \'product.inventory.ats.max_threshold\'.
-     *
-     * @property backorderable: A flag indicating whether the product is backorderable.
-     *
-     * @property id: The inventory ID.
-     * - **Min Length:** 1
-     * - **Max Length:** 256
-     *
-     * @property inStockDate: A flag indicating the date when the product will be in stock.
-     *
-     * @property orderable: A flag indicating whether at least one of the products is available to sell.
-     *
-     * @property preorderable: A flag indicating whether the product is preorderable.
-     *
-     * @property stockLevel: The stock level of the product. If it is infinity, the return value is 999999. The value can be overwritten by the  OCAPI setting \'product.inventory.stock_level.max_threshold\'.
-     *
-     */
-    type Inventory = {
-        ats?: number;
-        backorderable?: boolean;
-        id: string;
-        inStockDate?: string;
-        orderable?: boolean;
-        preorderable?: boolean;
-        stockLevel?: number;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type Product: Any product that is sold, shown alone, and does not have variations such as different sizes or colors. A product has no reliance on any other product for inheritance. *A product has a SKU and can have a product option, which has a different SKU*.
-     *
-     * @property brand: The product\'s brand.
-     *
-     * @property bundledProducts: The array of all bundled products of this product.
-     *
-     * @property currency:
-     *
-     * @property ean: The European Article Number of the product.
-     *
-     * @property fetchDate:
-     *
-     * @property id: The id (SKU) of the product.
-     * - **Min Length:** 1
-     * - **Max Length:** 100
-     *
-     * @property imageGroups: The array of product image groups.
-     *
-     * @property inventories: The array of product inventories explicitly requested via the \'inventory_ids\' query parameter. This property  is only returned in context of the \'availability\' expansion.
-     *
-     * @property inventory: The site default inventory information. This property is only  returned in context of the \'availability\' expansion.
-     *
-     * @property longDescription: The localized product\'s long description.
-     *
-     * @property manufacturerName: The product\'s manufacturer name.
-     *
-     * @property manufacturerSku: The product\'s manufacturer SKU.
-     *
-     * @property master: The master product information, only for types: master, variation group, and variant.
-     *
-     * @property minOrderQuantity: The minimum order quantity for this product.
-     *
-     * @property name: The localized product name.
-     *
-     * @property options: The array of product options, only for type option. This array can be empty.
-     *
-     * @property pageDescription: The localized product\'s page description.
-     *
-     * @property pageKeywords: The localized product\'s page description.
-     *
-     * @property pageTitle: The localized product\'s page title.
-     *
-     * @property pageMetaTags: Page Meta tags associated with the given product.
-     *
-     * @property price: The sales price of the product. In case of complex products, like master or set, this is the minimum price of  related child products.
-     *
-     * @property pricePerUnit: The price per unit if defined for the product
-     *
-     * @property pricePerUnitMax: The max price per unit typically for a master product\'s variant.
-     *
-     * @property priceMax: The maximum sales of related child products in complex products like master or set.
-     *
-     * @property priceRanges: Array of one or more price range objects representing one or more Pricebooks in context for the site.
-     *
-     * @property prices: The prices map with pricebook IDs and their values.
-     *
-     * @property primaryCategoryId: The ID of the products primary category.
-     *
-     * @property productLinks: The array of source and target product links information.
-     *
-     * @property productPromotions: An array of active customer product promotions for this product, sorted by promotion priority using SORT_BY_EXCLUSIVITY ordering (exclusivity → rank → promotion class → discount type → best discount → ID). This array can be empty. Coupon promotions are not returned in this array. See [PromotionPlan.SORT_BY_EXCLUSIVITY](https://salesforcecommercecloud.github.io/b2c-dev-doc/docs/current/scriptapi/html/index.html?target=class_dw_campaign_PromotionPlan.html) for more details.
-     *
-     * @property recommendations: Returns a list of recommendations.
-     *
-     * @property setProducts: The array of set products of this product.
-     *
-     * @property shortDescription: The localized product short description.
-     *
-     * @property slugUrl: The complete link to this product\'s storefront page.
-     *
-     * @property stepQuantity: The steps in which the order amount of the product can be  increased.
-     *
-     * @property tieredPrices: The document represents list of tiered prices if the product is a variant
-     *
-     * @property type: The product type information. Can be one or more of the following values: item, master, variation_group, variant, bundle, and set.
-     *
-     * @property unit: The sales unit of the product.
-     *
-     * @property upc: The Universal Product Code (UPC).
-     *
-     * @property validFrom: The time a product is valid from.
-     *
-     * @property validTo: The time a product is valid to.
-     *
-     * @property variants: The array of actual variants. Only for master, variation group, and variant types. This array can be empty.
-     *
-     * @property variationAttributes: Sorted array of variation attributes information. Only for master,  variation group, and variant types. This array can be empty.
-     *
-     * @property variationGroups: The array of actual variation groups. Only for master, variation group, and variant types. This array can be empty.
-     *
-     * @property variationValues: The actual variation attribute ID - value pairs. Only for variant and  variation group types.
-     *
-     */
-    type Product = {
-        brand?: string;
-        bundledProducts?: Array<BundledProduct>;
-        currency?: CurrencyCode;
-        ean?: string;
-        fetchDate?: number;
-        id: string;
-        imageGroups?: Array<ImageGroup>;
-        inventories?: Array<Inventory>;
-        inventory?: Inventory;
-        longDescription?: string;
-        manufacturerName?: string;
-        manufacturerSku?: string;
-        master?: Master;
-        minOrderQuantity?: number;
-        name?: string;
-        options?: Array<Option>;
-        pageDescription?: string;
-        pageKeywords?: string;
-        pageTitle?: string;
-        pageMetaTags?: Array<PageMetaTag>;
-        price?: number;
-        pricePerUnit?: number;
-        pricePerUnitMax?: number;
-        priceMax?: number;
-        priceRanges?: Array<PriceRange>;
-        prices?: {
-            [key: string]: number;
-        };
-        primaryCategoryId?: string;
-        productLinks?: Array<ProductLink>;
-        productPromotions?: Array<ProductPromotion>;
-        recommendations?: Array<Recommendation>;
-        setProducts?: Array<Product>;
-        shortDescription?: string;
-        slugUrl?: string;
-        stepQuantity?: number;
-        tieredPrices?: Array<ProductPriceTable>;
-        type?: ProductType;
-        unit?: string;
-        upc?: string;
-        validFrom?: string;
-        validTo?: string;
-        variants?: Array<Variant>;
-        variationAttributes?: Array<VariationAttribute>;
-        variationGroups?: Array<VariationGroup>;
-        variationValues?: {
-            [key: string]: string;
-        };
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type BundledProduct: A bundle of products that can be bought together (all or nothing). Each product in the bundle can itself be bought independently, but this is outside of the context of the bundle. A bundle is a purchasing convenience. *Product bundle has a SKU and price.*
-     *
-     * @property id:
-     *
-     * @property product: The product being bundled.
-     *
-     * @property quantity: For the product being bundled, the quantity added to the bundle.
-     *
-     */
-    type BundledProduct = {
-        id: string;
-        product: Product;
-        quantity: number;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type PathRecord: Document representing most basic info (id and name) of a category or catalog.
-     *
-     * @property id: The id of the category path.
-     *
-     * @property name: The name of the category path.
-     *
-     */
-    type PathRecord = {
-        id?: string;
-        name?: string;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type Category: Categories allow products to be organized into hierarchical structures. Categories can have relationships to other parent categories. Each category can also provide a context inherited by subcategories. For example, a category may have an attribute value assigned to it, and any product assigned to the category or a subcategory would inherit the attribute value as long as the product is assigned. Once the product is removed from the category those attribute values would no longer be in the context of the product. Linking of categories is also used for Site hierarchical navigation. For example, inside \'Clothing\' you may have \'Mens\', and inside \'Mens\' you may have \'Pants\'. Categories are not *Tags.*
-     *
-     * @property categories: Array of subcategories. Can be empty.
-     *
-     * @property description: The localized description of the category.
-     *
-     * @property id: The ID of the category.
-     * - **Min Length:** 1
-     * - **Max Length:** 256
-     *
-     * @property image: The URL of the category image.
-     *
-     * @property name: The localized name of the category.
-     *
-     * @property onlineSubCategoriesCount: The total number of online sub-categories. This information will be available from B2C Commerce version 24.5.
-     *
-     * @property pageDescription: The localized page description of the category.
-     *
-     * @property pageKeywords: The localized page keywords of the category.
-     *
-     * @property pageTitle: The localized page title of the category.
-     *
-     * @property parentCategoryId: The ID of the parent category.
-     *
-     * @property parentCategoryTree: The List of the parent categories.
-     *
-     * @property thumbnail: The URL of the category thumbnail.
-     *
-     */
-    type Category = {
-        categories?: Array<Category>;
-        description?: string;
-        id: string;
-        image?: string;
-        name?: string;
-        onlineSubCategoriesCount?: number;
-        pageDescription?: string;
-        pageKeywords?: string;
-        pageTitle?: string;
-        parentCategoryId?: string;
-        parentCategoryTree?: Array<PathRecord>;
-        thumbnail?: string;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type CategoryResult: Result document containing an array of categories.
-     *
-     * @property data: The array of category 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 CategoryResult = {
-        data: Array<Category>;
-        limit: number;
-        total: number;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * 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 ProductResult: Result document containing an array of products.
-     *
-     * @property limit: The number of returned documents.
-     *
-     * @property data: The array of product documents.
-     *
-     * @property total: The total number of documents.
-     *
-     */
-    type ProductResult = {
-        limit: number;
-        data: Array<Product>;
-        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 ShopperProductsTypes {
-    type ShopperProductsPathParameters = ShopperProductsApiTypes.ShopperProductsPathParameters;
-    type ShopperProductsQueryParameters = ShopperProductsApiTypes.ShopperProductsQueryParameters;
-    type GetCategoriesLevelsEnum = ShopperProductsApiTypes.GetCategoriesLevelsEnum;
-    type getCategoriesQueryParameters = ShopperProductsApiTypes.getCategoriesQueryParameters;
-    type getCategoriesPathParameters = ShopperProductsApiTypes.getCategoriesPathParameters;
-    type GetCategoryLevelsEnum = ShopperProductsApiTypes.GetCategoryLevelsEnum;
-    type getCategoryQueryParameters = ShopperProductsApiTypes.getCategoryQueryParameters;
-    type getCategoryPathParameters = ShopperProductsApiTypes.getCategoryPathParameters;
-    type GetProductExpandEnum = ShopperProductsApiTypes.GetProductExpandEnum;
-    type getProductQueryParameters = ShopperProductsApiTypes.getProductQueryParameters;
-    type getProductPathParameters = ShopperProductsApiTypes.getProductPathParameters;
-    type GetProductsExpandEnum = ShopperProductsApiTypes.GetProductsExpandEnum;
-    type getProductsQueryParameters = ShopperProductsApiTypes.getProductsQueryParameters;
-    type getProductsPathParameters = ShopperProductsApiTypes.getProductsPathParameters;
-    type BundledProduct = ShopperProductsModelTypes.BundledProduct;
-    type Category = ShopperProductsModelTypes.Category;
-    type CategoryResult = ShopperProductsModelTypes.CategoryResult;
-    type CurrencyCode = ShopperProductsModelTypes.CurrencyCode;
-    type DefaultFallback = ShopperProductsModelTypes.DefaultFallback;
-    type ErrorResponse = ShopperProductsModelTypes.ErrorResponse;
-    type Image = ShopperProductsModelTypes.Image;
-    type ImageGroup = ShopperProductsModelTypes.ImageGroup;
-    type Inventory = ShopperProductsModelTypes.Inventory;
-    type LocaleCode = ShopperProductsModelTypes.LocaleCode;
-    type Master = ShopperProductsModelTypes.Master;
-    type NoValue = ShopperProductsModelTypes.NoValue;
-    type Option = ShopperProductsModelTypes.Option;
-    type OptionValue = ShopperProductsModelTypes.OptionValue;
-    type PageMetaTag = ShopperProductsModelTypes.PageMetaTag;
-    type PathRecord = ShopperProductsModelTypes.PathRecord;
-    type PriceRange = ShopperProductsModelTypes.PriceRange;
-    type Product = ShopperProductsModelTypes.Product;
-    type ProductLink = ShopperProductsModelTypes.ProductLink;
-    type ProductLinkTypeEnum = ShopperProductsModelTypes.ProductLinkTypeEnum;
-    type ProductPriceTable = ShopperProductsModelTypes.ProductPriceTable;
-    type ProductPromotion = ShopperProductsModelTypes.ProductPromotion;
-    type ProductResult = ShopperProductsModelTypes.ProductResult;
-    type ProductType = ShopperProductsModelTypes.ProductType;
-    type Recommendation = ShopperProductsModelTypes.Recommendation;
-    type RecommendationType = ShopperProductsModelTypes.RecommendationType;
-    type ResultBase = ShopperProductsModelTypes.ResultBase;
-    type Variant = ShopperProductsModelTypes.Variant;
-    type VariationAttribute = ShopperProductsModelTypes.VariationAttribute;
-    type VariationAttributeValue = ShopperProductsModelTypes.VariationAttributeValue;
-    type VariationGroup = ShopperProductsModelTypes.VariationGroup;
-}
-export { defaultBaseUri, GetCategoriesLevelsEnum, GetCategoryLevelsEnum, GetProductExpandEnum, GetProductsExpandEnum, getCategoriesQueryParameters, getCategoriesPathParameters, getCategoryQueryParameters, getCategoryPathParameters, getProductQueryParameters, getProductPathParameters, getProductsQueryParameters, getProductsPathParameters, ShopperProductsPathParameters, ShopperProductsQueryParameters, ShopperProductsParameters, ShopperProducts, BundledProduct, Category, CategoryResult, CurrencyCode, DefaultFallback, ErrorResponse, Image, ImageGroup, Inventory, LocaleCode$0 as LocaleCode, Master, NoValue, Option, OptionValue, PageMetaTag, PathRecord, PriceRange, Product, ProductLink, ProductLinkTypeEnum, ProductPriceTable, ProductPromotion, ProductResult, ProductType, Recommendation, RecommendationType, ResultBase, Variant, VariationAttribute, VariationAttributeValue, VariationGroup, ShopperProductsTypes };