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

package/lib/shopperSeo.cjs.d.ts

@@ -1,769 +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/site/shopper-seo/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">;
-}
-/**
- * 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 UrlMapping: The URL mapping information for a URL that a shopper clicked or typed in.
- *
- * @property resourceType: The type of resource that corresponds to the requested URL. If you set up a URL redirect in Business Manager,  resourceType returns the corresponding destination type value from the redirect. If there\'s a URI redirect, resourceType isn\'t returned.  The URL redirect feature is available from B2C Commerce version 24.3.
- * - **Min Length:** 1
- * - **Max Length:** 256
- *
- * @property resourceSubType: If the resourceType is CONTENT_ASSET, this field tells you whether the resource is a standard content asset or a Page Designer content asset.  This output is available from B2C Commerce version 24.2.
- * - **Min Length:** 1
- * - **Max Length:** 256
- *
- * @property resourceId: The identifier for the resource that corresponds to the requested URL. If you set up a URL redirect in Business Manager,  resourceId returns the corresponding destination ID value from the redirect.  If there\'s a URI redirect, resourceId isn\'t returned. The URL redirect feature is available from B2C Commerce version 24.3.
- * - **Min Length:** 1
- * - **Max Length:** 256
- *
- * @property refinements: The refinement filters that correspond to the URL and resourceType.  Refinements are returned only if all of these conditions are met - a) the resourceType is CATEGORY, b) refinements are included in the urlSegment, and c) the refinements are configured in Business Manager.  This field returns a key-value pair of refinement name and refinement value. If there’s a matching URL redirect for the requested URL. the refinements output isn’t returned. The URL redirect feature is available from B2C Commerce version 24.3.
- *
- * @property statusCode: This field is populated only if you set up a URL redirect in Business Manager. It specifies whether the redirect is temporary (302 or 307) or permanent (301).  See [Create a Redirect from a B2C Commerce URL.](https://help.salesforce.com/s/articleView?id=cc.b2c_creating_a_redirect_from_a_digital_url.htm&type=5)  This parameter is available from B2C Commerce version 24.3.
- *
- * @property destinationUrl: This field is populated if the urlSegment resolves to a redirect. Specifies the URL you want to redirect to as an absolute or relative URL.  The destinationUrl is based on your configuration in Business Manager. It\'s either a calculated value indicating the Commerce Cloud object (product, category, or content asset) URL or your specified URL.  Note that an object\'s path may not necessarily match your headless storefront URLs but can be used as a reference for calculating the destinationUrl.  See [Create a Redirect from a B2C Commerce URL.](https://help.salesforce.com/s/articleView?id=cc.b2c_creating_a_redirect_from_a_digital_url.htm&type=5).  Available from B2C Commerce 24.3.
- * - **Min Length:** 1
- * - **Max Length:** 2048
- *
- * @property copySourceParams: This field is populated only if you set up a URL redirect in Business Manager.  It’s a flag that shows whether the parameters of the source URL have been copied to the destination URL.  This parameter is available from B2C Commerce version 24.3.
- *
- * @property additionalUrlParams: This field is populated only if you set up a URL redirect in Business Manager.  It returns the parameters you want to add to the end of the URL.  This parameter is available from B2C Commerce version 24.3.
- * - **Min Length:** 1
- * - **Max Length:** 2048
- *
- * @property productCategoryId: This field is populated only if you set up a URL redirect in Business Manager.  It identifies the destination product\'s category ID. This field is returned only when the destination type is product.  This parameter is available from B2C Commerce version 24.3.
- * - **Min Length:** 1
- * - **Max Length:** 256
- *
- */
-type UrlMapping = {
-    resourceType?: string;
-    resourceSubType?: string;
-    resourceId?: string;
-    refinements?: {
-        [key: string]: any;
-    };
-    statusCode?: number;
-    destinationUrl?: string;
-    copySourceParams?: boolean;
-    additionalUrlParams?: string;
-    productCategoryId?: string;
-} & {
-    [key: string]: any;
-};
-type getUrlMappingQueryParameters = {
-    urlSegment: string;
-    siteId: string;
-    locale?: LocaleCode$0;
-};
-type getUrlMappingPathParameters = {
-    organizationId: string;
-};
-/**
- * All path parameters that are used by at least one ShopperSEO method.
- */
-type ShopperSEOPathParameters = Partial<getUrlMappingPathParameters & {}>;
-/**
- * All query parameters that are used by at least one ShopperSEO method.
- */
-type ShopperSEOQueryParameters = Partial<getUrlMappingQueryParameters & {}>;
-/**
- * All parameters that are used by ShopperSEO.
- */
-type ShopperSEOParameters = ShopperSEOPathParameters & BaseUriParameters & ShopperSEOQueryParameters;
-/**
- * [Shopper SEO](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-seo:Summary)
- * ==================================
- *
- * *# API Overview
- 
- The Shopper SEO API Provides access to SEO-related information, such as URL mapping information.
- 
- ## Authentication & Authorization
- 
- The Shopper SEO API requires a shopper access token from the [Shopper Login and API Access Service (SLAS).](https://developer.salesforce.com/docs/commerce/commerce-api/guide/authorization-for-shopper-apis.html)
- 
- You must include the relevant scope(s) in the client ID used to generate the SLAS token. For details, see [Authorization Scopes Catalog.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/auth-z-scope-catalog.html)
- 
- ## Use Cases
- 
- ### URL Resolution
- 
- For information on setting up URL rules and URL redirects in Business Manager, see [URL Resolution.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/url-resolution.html)
- 
- ### Caching
- 
- Caching capabilities are available for the Shopper SEO API. For details, see [Server-Side Web-Tier Caching.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html)
- 
- ### Using Hooks
- 
- For details working with hooks, see [Extensibility with Hooks.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/extensibility_via_hooks.html)*<br />
- *
- * Simple example:
- *
- * ```typescript
- *   import { ShopperSEO } from "commerce-sdk-isomorphic";
- *
- *   const clientConfig = {
- *     parameters: {
- *       clientId: "XXXXXX",
- *       organizationId: "XXXX",
- *       shortCode: "XXX",
- *       siteId: "XX"
- *     }
- *   };
- *   const shopperSEOClient = new ShopperSEO(clientConfig);
- * ```
- *
- * <span style="font-size:.7em; display:block; text-align: right">
- * API Version: 0.0.33<br />
- * Last Updated: <br />
- * </span>
- *
- *
- */
-declare class ShopperSEO<ConfigParameters extends ShopperSEOParameters & 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/site/shopper-seo/v1";
-    static readonly apiPaths: {
-        getUrlMapping: string;
-    };
-    constructor(config: ClientConfigInit<ConfigParameters>);
-    static readonly paramKeys: {
-        readonly getUrlMapping: readonly [
-            "organizationId",
-            "urlSegment",
-            "siteId",
-            "locale"
-        ];
-        readonly getUrlMappingRequired: readonly [
-            "organizationId",
-            "urlSegment",
-            "siteId"
-        ];
-    };
-    /**
-     * The mapping information is based on URL rules and redirects that are set up in Business Manager.
-     For more information about prerequisites and sample usage, see [URL Resolution](/docs/commerce/commerce-api/guide/url-resolution.html).
-     You can customize the behavior of this endpoint by using hooks. For details, refer to the [Hook List](https://developer.salesforce.com/docs/commerce/commerce-api/guide/hook_list.html).
-     *
-     * If you would like to get a raw Response object use the other getUrlMapping 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.urlSegment - The part of the requested URL that comes after the domain name. For example, the urlSegment for \"www.abc.com/blue/new-arrivals/tops\" is \"blue/new-arrivals/tops\".
-     There's no limit on the length of the urlSegment. However, for this endpoint, the maximum allowed length of the URL (after URL encoding) is 2047 characters.
-     Make this field URL-encoded so that it properly handles special values such as whitespace. If a urlSegment includes a query string, a 404 error code is returned.
-     * @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.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 UrlMapping.
-     */
-    getUrlMapping(options?: RequireParametersUnlessAllAreOptional<{
-        parameters?: CompositeParameters<{
-            organizationId: string;
-            urlSegment: string;
-            siteId: string;
-            locale?: LocaleCode$0;
-        } & QueryParameters, ConfigParameters>;
-        headers?: {
-            [key: string]: string;
-        };
-    }>): Promise<UrlMapping>;
-    /**
-     * The mapping information is based on URL rules and redirects that are set up in Business Manager.
-     For more information about prerequisites and sample usage, see [URL Resolution](/docs/commerce/commerce-api/guide/url-resolution.html).
-     You can customize the behavior of this endpoint by using hooks. For details, refer to the [Hook List](https://developer.salesforce.com/docs/commerce/commerce-api/guide/hook_list.html).
-     *
-     * @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.urlSegment - The part of the requested URL that comes after the domain name. For example, the urlSegment for \"www.abc.com/blue/new-arrivals/tops\" is \"blue/new-arrivals/tops\".
-     There's no limit on the length of the urlSegment. However, for this endpoint, the maximum allowed length of the URL (after URL encoding) is 2047 characters.
-     Make this field URL-encoded so that it properly handles special values such as whitespace. If a urlSegment includes a query string, a 404 error code is returned.
-     * @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.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 UrlMapping otherwise.
-     */
-    getUrlMapping<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
-        parameters?: CompositeParameters<{
-            organizationId: string;
-            urlSegment: string;
-            siteId: string;
-            locale?: LocaleCode$0;
-        } & QueryParameters, ConfigParameters>;
-        headers?: {
-            [key: string]: string;
-        };
-    }>, rawResponse?: T): Promise<T extends true ? Response : UrlMapping>;
-}
-declare namespace ShopperSEOApiTypes {
-    /*
-    * 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">;
-    }
-    /**
-     * 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 UrlMapping: The URL mapping information for a URL that a shopper clicked or typed in.
-     *
-     * @property resourceType: The type of resource that corresponds to the requested URL. If you set up a URL redirect in Business Manager,  resourceType returns the corresponding destination type value from the redirect. If there\'s a URI redirect, resourceType isn\'t returned.  The URL redirect feature is available from B2C Commerce version 24.3.
-     * - **Min Length:** 1
-     * - **Max Length:** 256
-     *
-     * @property resourceSubType: If the resourceType is CONTENT_ASSET, this field tells you whether the resource is a standard content asset or a Page Designer content asset.  This output is available from B2C Commerce version 24.2.
-     * - **Min Length:** 1
-     * - **Max Length:** 256
-     *
-     * @property resourceId: The identifier for the resource that corresponds to the requested URL. If you set up a URL redirect in Business Manager,  resourceId returns the corresponding destination ID value from the redirect.  If there\'s a URI redirect, resourceId isn\'t returned. The URL redirect feature is available from B2C Commerce version 24.3.
-     * - **Min Length:** 1
-     * - **Max Length:** 256
-     *
-     * @property refinements: The refinement filters that correspond to the URL and resourceType.  Refinements are returned only if all of these conditions are met - a) the resourceType is CATEGORY, b) refinements are included in the urlSegment, and c) the refinements are configured in Business Manager.  This field returns a key-value pair of refinement name and refinement value. If there’s a matching URL redirect for the requested URL. the refinements output isn’t returned. The URL redirect feature is available from B2C Commerce version 24.3.
-     *
-     * @property statusCode: This field is populated only if you set up a URL redirect in Business Manager. It specifies whether the redirect is temporary (302 or 307) or permanent (301).  See [Create a Redirect from a B2C Commerce URL.](https://help.salesforce.com/s/articleView?id=cc.b2c_creating_a_redirect_from_a_digital_url.htm&type=5)  This parameter is available from B2C Commerce version 24.3.
-     *
-     * @property destinationUrl: This field is populated if the urlSegment resolves to a redirect. Specifies the URL you want to redirect to as an absolute or relative URL.  The destinationUrl is based on your configuration in Business Manager. It\'s either a calculated value indicating the Commerce Cloud object (product, category, or content asset) URL or your specified URL.  Note that an object\'s path may not necessarily match your headless storefront URLs but can be used as a reference for calculating the destinationUrl.  See [Create a Redirect from a B2C Commerce URL.](https://help.salesforce.com/s/articleView?id=cc.b2c_creating_a_redirect_from_a_digital_url.htm&type=5).  Available from B2C Commerce 24.3.
-     * - **Min Length:** 1
-     * - **Max Length:** 2048
-     *
-     * @property copySourceParams: This field is populated only if you set up a URL redirect in Business Manager.  It’s a flag that shows whether the parameters of the source URL have been copied to the destination URL.  This parameter is available from B2C Commerce version 24.3.
-     *
-     * @property additionalUrlParams: This field is populated only if you set up a URL redirect in Business Manager.  It returns the parameters you want to add to the end of the URL.  This parameter is available from B2C Commerce version 24.3.
-     * - **Min Length:** 1
-     * - **Max Length:** 2048
-     *
-     * @property productCategoryId: This field is populated only if you set up a URL redirect in Business Manager.  It identifies the destination product\'s category ID. This field is returned only when the destination type is product.  This parameter is available from B2C Commerce version 24.3.
-     * - **Min Length:** 1
-     * - **Max Length:** 256
-     *
-     */
-    type UrlMapping = {
-        resourceType?: string;
-        resourceSubType?: string;
-        resourceId?: string;
-        refinements?: {
-            [key: string]: any;
-        };
-        statusCode?: number;
-        destinationUrl?: string;
-        copySourceParams?: boolean;
-        additionalUrlParams?: string;
-        productCategoryId?: string;
-    } & {
-        [key: string]: any;
-    };
-    type getUrlMappingQueryParameters = {
-        urlSegment: string;
-        siteId: string;
-        locale?: LocaleCode$0;
-    };
-    type getUrlMappingPathParameters = {
-        organizationId: string;
-    };
-    /**
-     * All path parameters that are used by at least one ShopperSEO method.
-     */
-    type ShopperSEOPathParameters = Partial<getUrlMappingPathParameters & {}>;
-    /**
-     * All query parameters that are used by at least one ShopperSEO method.
-     */
-    type ShopperSEOQueryParameters = Partial<getUrlMappingQueryParameters & {}>;
-    /**
-     * All parameters that are used by ShopperSEO.
-     */
-    type ShopperSEOParameters = ShopperSEOPathParameters & BaseUriParameters & ShopperSEOQueryParameters;
-    /**
-     * [Shopper SEO](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-seo:Summary)
-     * ==================================
-     *
-     * *# API Overview
-     
-     The Shopper SEO API Provides access to SEO-related information, such as URL mapping information.
-     
-     ## Authentication & Authorization
-     
-     The Shopper SEO API requires a shopper access token from the [Shopper Login and API Access Service (SLAS).](https://developer.salesforce.com/docs/commerce/commerce-api/guide/authorization-for-shopper-apis.html)
-     
-     You must include the relevant scope(s) in the client ID used to generate the SLAS token. For details, see [Authorization Scopes Catalog.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/auth-z-scope-catalog.html)
-     
-     ## Use Cases
-     
-     ### URL Resolution
-     
-     For information on setting up URL rules and URL redirects in Business Manager, see [URL Resolution.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/url-resolution.html)
-     
-     ### Caching
-     
-     Caching capabilities are available for the Shopper SEO API. For details, see [Server-Side Web-Tier Caching.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html)
-     
-     ### Using Hooks
-     
-     For details working with hooks, see [Extensibility with Hooks.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/extensibility_via_hooks.html)*<br />
-     *
-     * Simple example:
-     *
-     * ```typescript
-     *   import { ShopperSEO } from "commerce-sdk-isomorphic";
-     *
-     *   const clientConfig = {
-     *     parameters: {
-     *       clientId: "XXXXXX",
-     *       organizationId: "XXXX",
-     *       shortCode: "XXX",
-     *       siteId: "XX"
-     *     }
-     *   };
-     *   const shopperSEOClient = new ShopperSEO(clientConfig);
-     * ```
-     *
-     * <span style="font-size:.7em; display:block; text-align: right">
-     * API Version: 0.0.33<br />
-     * Last Updated: <br />
-     * </span>
-     *
-     *
-     */
-    class ShopperSEO<ConfigParameters extends ShopperSEOParameters & 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/site/shopper-seo/v1";
-        static readonly apiPaths: {
-            getUrlMapping: string;
-        };
-        constructor(config: ClientConfigInit<ConfigParameters>);
-        static readonly paramKeys: {
-            readonly getUrlMapping: readonly [
-                "organizationId",
-                "urlSegment",
-                "siteId",
-                "locale"
-            ];
-            readonly getUrlMappingRequired: readonly [
-                "organizationId",
-                "urlSegment",
-                "siteId"
-            ];
-        };
-        /**
-         * The mapping information is based on URL rules and redirects that are set up in Business Manager.
-         For more information about prerequisites and sample usage, see [URL Resolution](/docs/commerce/commerce-api/guide/url-resolution.html).
-         You can customize the behavior of this endpoint by using hooks. For details, refer to the [Hook List](https://developer.salesforce.com/docs/commerce/commerce-api/guide/hook_list.html).
-         *
-         * If you would like to get a raw Response object use the other getUrlMapping 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.urlSegment - The part of the requested URL that comes after the domain name. For example, the urlSegment for \"www.abc.com/blue/new-arrivals/tops\" is \"blue/new-arrivals/tops\".
-         There's no limit on the length of the urlSegment. However, for this endpoint, the maximum allowed length of the URL (after URL encoding) is 2047 characters.
-         Make this field URL-encoded so that it properly handles special values such as whitespace. If a urlSegment includes a query string, a 404 error code is returned.
-         * @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.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 UrlMapping.
-         */
-        getUrlMapping(options?: RequireParametersUnlessAllAreOptional<{
-            parameters?: CompositeParameters<{
-                organizationId: string;
-                urlSegment: string;
-                siteId: string;
-                locale?: LocaleCode$0;
-            } & QueryParameters, ConfigParameters>;
-            headers?: {
-                [key: string]: string;
-            };
-        }>): Promise<UrlMapping>;
-        /**
-         * The mapping information is based on URL rules and redirects that are set up in Business Manager.
-         For more information about prerequisites and sample usage, see [URL Resolution](/docs/commerce/commerce-api/guide/url-resolution.html).
-         You can customize the behavior of this endpoint by using hooks. For details, refer to the [Hook List](https://developer.salesforce.com/docs/commerce/commerce-api/guide/hook_list.html).
-         *
-         * @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.urlSegment - The part of the requested URL that comes after the domain name. For example, the urlSegment for \"www.abc.com/blue/new-arrivals/tops\" is \"blue/new-arrivals/tops\".
-         There's no limit on the length of the urlSegment. However, for this endpoint, the maximum allowed length of the URL (after URL encoding) is 2047 characters.
-         Make this field URL-encoded so that it properly handles special values such as whitespace. If a urlSegment includes a query string, a 404 error code is returned.
-         * @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.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 UrlMapping otherwise.
-         */
-        getUrlMapping<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
-            parameters?: CompositeParameters<{
-                organizationId: string;
-                urlSegment: string;
-                siteId: string;
-                locale?: LocaleCode$0;
-            } & QueryParameters, ConfigParameters>;
-            headers?: {
-                [key: string]: string;
-            };
-        }>, rawResponse?: T): Promise<T extends true ? Response : UrlMapping>;
-    }
-}
-declare namespace ShopperSEOModelTypes {
-    /**
-     * 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 UrlMapping: The URL mapping information for a URL that a shopper clicked or typed in.
-     *
-     * @property resourceType: The type of resource that corresponds to the requested URL. If you set up a URL redirect in Business Manager,  resourceType returns the corresponding destination type value from the redirect. If there\'s a URI redirect, resourceType isn\'t returned.  The URL redirect feature is available from B2C Commerce version 24.3.
-     * - **Min Length:** 1
-     * - **Max Length:** 256
-     *
-     * @property resourceSubType: If the resourceType is CONTENT_ASSET, this field tells you whether the resource is a standard content asset or a Page Designer content asset.  This output is available from B2C Commerce version 24.2.
-     * - **Min Length:** 1
-     * - **Max Length:** 256
-     *
-     * @property resourceId: The identifier for the resource that corresponds to the requested URL. If you set up a URL redirect in Business Manager,  resourceId returns the corresponding destination ID value from the redirect.  If there\'s a URI redirect, resourceId isn\'t returned. The URL redirect feature is available from B2C Commerce version 24.3.
-     * - **Min Length:** 1
-     * - **Max Length:** 256
-     *
-     * @property refinements: The refinement filters that correspond to the URL and resourceType.  Refinements are returned only if all of these conditions are met - a) the resourceType is CATEGORY, b) refinements are included in the urlSegment, and c) the refinements are configured in Business Manager.  This field returns a key-value pair of refinement name and refinement value. If there’s a matching URL redirect for the requested URL. the refinements output isn’t returned. The URL redirect feature is available from B2C Commerce version 24.3.
-     *
-     * @property statusCode: This field is populated only if you set up a URL redirect in Business Manager. It specifies whether the redirect is temporary (302 or 307) or permanent (301).  See [Create a Redirect from a B2C Commerce URL.](https://help.salesforce.com/s/articleView?id=cc.b2c_creating_a_redirect_from_a_digital_url.htm&type=5)  This parameter is available from B2C Commerce version 24.3.
-     *
-     * @property destinationUrl: This field is populated if the urlSegment resolves to a redirect. Specifies the URL you want to redirect to as an absolute or relative URL.  The destinationUrl is based on your configuration in Business Manager. It\'s either a calculated value indicating the Commerce Cloud object (product, category, or content asset) URL or your specified URL.  Note that an object\'s path may not necessarily match your headless storefront URLs but can be used as a reference for calculating the destinationUrl.  See [Create a Redirect from a B2C Commerce URL.](https://help.salesforce.com/s/articleView?id=cc.b2c_creating_a_redirect_from_a_digital_url.htm&type=5).  Available from B2C Commerce 24.3.
-     * - **Min Length:** 1
-     * - **Max Length:** 2048
-     *
-     * @property copySourceParams: This field is populated only if you set up a URL redirect in Business Manager.  It’s a flag that shows whether the parameters of the source URL have been copied to the destination URL.  This parameter is available from B2C Commerce version 24.3.
-     *
-     * @property additionalUrlParams: This field is populated only if you set up a URL redirect in Business Manager.  It returns the parameters you want to add to the end of the URL.  This parameter is available from B2C Commerce version 24.3.
-     * - **Min Length:** 1
-     * - **Max Length:** 2048
-     *
-     * @property productCategoryId: This field is populated only if you set up a URL redirect in Business Manager.  It identifies the destination product\'s category ID. This field is returned only when the destination type is product.  This parameter is available from B2C Commerce version 24.3.
-     * - **Min Length:** 1
-     * - **Max Length:** 256
-     *
-     */
-    type UrlMapping = {
-        resourceType?: string;
-        resourceSubType?: string;
-        resourceId?: string;
-        refinements?: {
-            [key: string]: any;
-        };
-        statusCode?: number;
-        destinationUrl?: string;
-        copySourceParams?: boolean;
-        additionalUrlParams?: string;
-        productCategoryId?: string;
-    } & {
-        [key: string]: any;
-    };
-}
-declare namespace ShopperSEOTypes {
-    type ShopperSEOPathParameters = ShopperSEOApiTypes.ShopperSEOPathParameters;
-    type ShopperSEOQueryParameters = ShopperSEOApiTypes.ShopperSEOQueryParameters;
-    type getUrlMappingQueryParameters = ShopperSEOApiTypes.getUrlMappingQueryParameters;
-    type getUrlMappingPathParameters = ShopperSEOApiTypes.getUrlMappingPathParameters;
-    type DefaultFallback = ShopperSEOModelTypes.DefaultFallback;
-    type ErrorResponse = ShopperSEOModelTypes.ErrorResponse;
-    type LocaleCode = ShopperSEOModelTypes.LocaleCode;
-    type UrlMapping = ShopperSEOModelTypes.UrlMapping;
-}
-export { defaultBaseUri, getUrlMappingQueryParameters, getUrlMappingPathParameters, ShopperSEOPathParameters, ShopperSEOQueryParameters, ShopperSEOParameters, ShopperSEO, DefaultFallback, ErrorResponse, LocaleCode$0 as LocaleCode, UrlMapping, ShopperSEOTypes };