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

package/lib/shopperExperience.cjs.d.ts

@@ -0,0 +1,1169 @@
+/*
+* 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/experience/shopper-experience/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 Region:
+ *
+ * @property id: Region identifier.
+ * - **Max Length:** 256
+ *
+ * @property components: The components in the region.
+ *
+ */
+type Region = {
+    id: string;
+    components?: Array<Component>;
+} & {
+    [key: string]: any;
+};
+/**
+ * @type Component:
+ *
+ * @property id: Component identifier.
+ * - **Max Length:** 256
+ *
+ * @property typeId: Component type identifier.
+ * - **Max Length:** 256
+ *
+ * @property data: The configuration data assigned to the component.
+ *
+ * @property custom: Any custom data added by the custom code for this component.
+ *
+ * @property regions: The regions (and their assigned components) for the component.
+ *
+ */
+type Component = {
+    id: string;
+    typeId: string;
+    data?: object;
+    custom?: object;
+    regions?: Array<Region>;
+} & {
+    [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 Page:
+ *
+ * @property id: Page identifier.
+ * - **Max Length:** 256
+ *
+ * @property typeId: Page type identifier.
+ * - **Max Length:** 256
+ *
+ * @property aspectTypeId: The aspect type assigned to the page.
+ * - **Max Length:** 256
+ *
+ * @property name: Display name of the page.
+ * - **Max Length:** 4000
+ *
+ * @property description: Description of the page.
+ * - **Max Length:** 4000
+ *
+ * @property pageTitle: The SEO title of the page.
+ * - **Max Length:** 4000
+ *
+ * @property pageDescription: The SEO description of the page.
+ * - **Max Length:** 4000
+ *
+ * @property pageKeywords: The SEO keywords of the page.
+ * - **Max Length:** 4000
+ *
+ * @property data: The configuration data assigned to the page.
+ *
+ * @property custom: Any custom data added by the custom code for the page type.
+ *
+ * @property regions: The regions (and their assigned components) for the page.
+ *
+ */
+type Page = {
+    id: string;
+    typeId: string;
+    aspectTypeId?: string;
+    name?: string;
+    description?: string;
+    pageTitle?: string;
+    pageDescription?: string;
+    pageKeywords?: string;
+    data?: object;
+    custom?: object;
+    regions?: Array<Region>;
+} & {
+    [key: string]: any;
+};
+/**
+ * @type PageResult:
+ *
+ * @property data: List of pages.
+ *
+ */
+type PageResult = {
+    data: Array<Page>;
+} & {
+    [key: string]: any;
+};
+type getPageQueryParameters = {
+    aspectAttributes?: string;
+    parameters?: string;
+    siteId: string;
+    locale?: LocaleCode$0;
+};
+type getPagePathParameters = {
+    pageId: string;
+    organizationId: string;
+};
+type getPagesQueryParameters = {
+    categoryId?: string;
+    productId?: string;
+    aspectTypeId: string;
+    aspectAttributes?: string;
+    parameters?: string;
+    siteId: string;
+    locale?: LocaleCode$0;
+};
+type getPagesPathParameters = {
+    organizationId: string;
+};
+/**
+ * All path parameters that are used by at least one ShopperExperience method.
+ */
+type ShopperExperiencePathParameters = Partial<getPagePathParameters & getPagesPathParameters & {}>;
+/**
+ * All query parameters that are used by at least one ShopperExperience method.
+ */
+type ShopperExperienceQueryParameters = Partial<getPageQueryParameters & getPagesQueryParameters & {}>;
+/**
+ * All parameters that are used by ShopperExperience.
+ */
+type ShopperExperienceParameters = ShopperExperiencePathParameters & BaseUriParameters & ShopperExperienceQueryParameters;
+/**
+ * [Shopper Experience](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-experience:Summary)
+ * ==================================
+ *
+ * *Use the Shopper Experience API to look up page information for pages that are created in Page Designer.
+ 
+ Responses include the following:
+ 
+ - The entire component hierarchy of the page at design time.
+ - All merchant data provided at design time.
+ - Server-side scripting data provided at run time.
+ 
+ Both the page and components contain the values of all native and custom attributes that have been populated during page authoring.
+ 
+ Only visible pages are returned. Because the visibility of components is driven by rules (scheduling or customer groups, for example), these rules are subject to evaluation when assembling the component hierarchy in the response. Only components that are visible for the current customer context appear in the response. The same rules apply to the page itself, which is only be processed and returned if it is visible.
+ 
+ **Important**: Currently, the Shopper Experience API can’t be used when the [storefront password protection](https://documentation.b2c.commercecloud.salesforce.com/DOC1/index.jsp?topic=%2Fcom.demandware.dochelp%2Fcontent%2Fb2c_commerce%2Ftopics%2Fpermissions%2Fb2c_storefront_password_protection.html&resultof=%22%73%74%6f%72%65%66%72%6f%6e%74%22%20%22%70%72%6f%74%65%63%74%69%6f%6e%22%20%22%70%72%6f%74%65%63%74%22%20) feature is enabled.
+ 
+ ## Authentication & Authorization
+ 
+ The Shopper Experience 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.
+ 
+ You must include the relevant scope(s) in the client ID used to generate the SLAS token. For details, see the [Authorization Scopes Catalog.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/auth-z-scope-catalog.html).*<br />
+ *
+ * Simple example:
+ *
+ * ```typescript
+ *   import { ShopperExperience } from "commerce-sdk-isomorphic";
+ *
+ *   const clientConfig = {
+ *     parameters: {
+ *       clientId: "XXXXXX",
+ *       organizationId: "XXXX",
+ *       shortCode: "XXX",
+ *       siteId: "XX"
+ *     }
+ *   };
+ *   const shopperExperienceClient = new ShopperExperience(clientConfig);
+ * ```
+ *
+ * <span style="font-size:.7em; display:block; text-align: right">
+ * API Version: 0.0.33<br />
+ * Last Updated: <br />
+ * </span>
+ *
+ *
+ */
+declare class ShopperExperience<ConfigParameters extends ShopperExperienceParameters & 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/experience/shopper-experience/v1";
+    static readonly apiPaths: {
+        getPage: string;
+        getPages: string;
+    };
+    constructor(config: ClientConfigInit<ConfigParameters>);
+    static readonly paramKeys: {
+        readonly getPage: readonly [
+            "pageId",
+            "organizationId",
+            "siteId",
+            "aspectAttributes",
+            "parameters",
+            "locale"
+        ];
+        readonly getPageRequired: readonly [
+            "pageId",
+            "organizationId",
+            "siteId"
+        ];
+        readonly getPages: readonly [
+            "organizationId",
+            "aspectTypeId",
+            "siteId",
+            "categoryId",
+            "productId",
+            "aspectAttributes",
+            "parameters",
+            "locale"
+        ];
+        readonly getPagesRequired: readonly [
+            "organizationId",
+            "aspectTypeId",
+            "siteId"
+        ];
+    };
+    /**
+     * Get a Page Designer page for a specific page ID. The results apply the visibility rules for the page's components, such as personalization or scheduled visibility.
+     
+     **Important**:
+     - Currently, you can't use the Shopper Experience API when the [storefront password protection](https://documentation.b2c.commercecloud.salesforce.com/DOC1/index.jsp?topic=%2Fcom.demandware.dochelp%2Fcontent%2Fb2c_commerce%2Ftopics%2Fpermissions%2Fb2c_storefront_password_protection.html&resultof=%22%73%74%6f%72%65%66%72%6f%6e%74%22%20%22%70%72%6f%74%65%63%74%69%6f%6e%22%20%22%70%72%6f%74%65%63%74%22%20) feature is enabled.
+     - Because this resource uses the GET method, you must not pass sensitive data, for example: payment card information, and must not perform transactional processes within the server-side scripts that are run for the page and components.
+     - Be aware that pagecache during fingerprint calculation will only be leveraged for pages and their components that don't use visibility rules. Furthermore the pagecaching of the actual response assembly solely depends on the response instrumentation with the serverside page type and component type script implementations. For more details also see the [Page Designer Caching Guide](https://developer.salesforce.com/docs/commerce/b2c-commerce/guide/b2c-dev-for-page-designer.html#page-caching).
+     *
+     * If you would like to get a raw Response object use the other getPage 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.pageId - Identifier for the requested page.
+     * @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.aspectAttributes - A JSON representation of aspect attributes. Each aspect attribute is a key/value pair. Aspect attributes serve as a runtime parameter contract between caller (for example, this API or the DWScript API) and callee (the page). This parameter must not contain more than 256 characters after URL decoding.
+     * @param options.parameters.parameters - A free-form definition of parameters that influences the page rendering according to its implementation. This parameter must not contain more than 256 characters after URL decoding.
+     * @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 Page.
+     */
+    getPage(options?: RequireParametersUnlessAllAreOptional<{
+        parameters?: CompositeParameters<{
+            pageId: string;
+            organizationId: string;
+            siteId: string;
+            aspectAttributes?: string;
+            parameters?: string;
+            locale?: LocaleCode$0;
+        } & QueryParameters, ConfigParameters>;
+        headers?: {
+            [key: string]: string;
+        };
+    }>): Promise<Page>;
+    /**
+     * Get a Page Designer page for a specific page ID. The results apply the visibility rules for the page's components, such as personalization or scheduled visibility.
+     
+     **Important**:
+     - Currently, you can't use the Shopper Experience API when the [storefront password protection](https://documentation.b2c.commercecloud.salesforce.com/DOC1/index.jsp?topic=%2Fcom.demandware.dochelp%2Fcontent%2Fb2c_commerce%2Ftopics%2Fpermissions%2Fb2c_storefront_password_protection.html&resultof=%22%73%74%6f%72%65%66%72%6f%6e%74%22%20%22%70%72%6f%74%65%63%74%69%6f%6e%22%20%22%70%72%6f%74%65%63%74%22%20) feature is enabled.
+     - Because this resource uses the GET method, you must not pass sensitive data, for example: payment card information, and must not perform transactional processes within the server-side scripts that are run for the page and components.
+     - Be aware that pagecache during fingerprint calculation will only be leveraged for pages and their components that don't use visibility rules. Furthermore the pagecaching of the actual response assembly solely depends on the response instrumentation with the serverside page type and component type script implementations. For more details also see the [Page Designer Caching Guide](https://developer.salesforce.com/docs/commerce/b2c-commerce/guide/b2c-dev-for-page-designer.html#page-caching).
+     *
+     * @param options - An object containing the options for this method.
+     * @param options.parameters - An object containing the parameters for this method.
+     * @param options.parameters.pageId - Identifier for the requested page.
+     * @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.aspectAttributes - A JSON representation of aspect attributes. Each aspect attribute is a key/value pair. Aspect attributes serve as a runtime parameter contract between caller (for example, this API or the DWScript API) and callee (the page). This parameter must not contain more than 256 characters after URL decoding.
+     * @param options.parameters.parameters - A free-form definition of parameters that influences the page rendering according to its implementation. This parameter must not contain more than 256 characters after URL decoding.
+     * @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 Page otherwise.
+     */
+    getPage<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
+        parameters?: CompositeParameters<{
+            pageId: string;
+            organizationId: string;
+            siteId: string;
+            aspectAttributes?: string;
+            parameters?: string;
+            locale?: LocaleCode$0;
+        } & QueryParameters, ConfigParameters>;
+        headers?: {
+            [key: string]: string;
+        };
+    }>, rawResponse?: T): Promise<T extends true ? Response : Page>;
+    /**
+     * Get Page Designer pages. The results apply the visibility rules for each page's components, such as personalization or scheduled visibility.
+     
+     You must provide the `aspectTypeId` along with either a `categoryId` or a `productId`. Since you can only create one page-to-product or page-to-category assignment per aspect type, the result contains at most one element.
+     
+     **Important**:
+     - Currently, you can't use the Shopper Experience API when the [storefront password protection](https://documentation.b2c.commercecloud.salesforce.com/DOC1/index.jsp?topic=%2Fcom.demandware.dochelp%2Fcontent%2Fb2c_commerce%2Ftopics%2Fpermissions%2Fb2c_storefront_password_protection.html&resultof=%22%73%74%6f%72%65%66%72%6f%6e%74%22%20%22%70%72%6f%74%65%63%74%69%6f%6e%22%20%22%70%72%6f%74%65%63%74%22%20) feature is enabled.
+     - Because this resource uses the GET method, you must not pass sensitive data, for example: payment card information, and must not perform transactional processes within the server-side scripts that are run for the page and components.
+     - Be aware that pagecache during fingerprint calculation will only be leveraged for pages and their components that don't use visibility rules. Furthermore the pagecaching of the actual response assembly solely depends on the response instrumentation with the serverside page type and component type script implementations. For more details also see the [Page Designer Caching Guide](https://developer.salesforce.com/docs/commerce/b2c-commerce/guide/b2c-dev-for-page-designer.html#page-caching).
+     *
+     * If you would like to get a raw Response object use the other getPages 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.aspectTypeId - Aspect type identifier that is used for searching the page assignment in conjunction with either the `productId` or `categoryId`.
+     * @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.categoryId - Category identifier that is used for searching the page assignment. Must be provided if no `productId` is provided.
+     * @param options.parameters.productId - Product identifier that is used for searching the page assignment. Must be provided if no `categoryId` is provided.
+     * @param options.parameters.aspectAttributes - A JSON representation of aspect attributes. Each aspect attribute is a key/value pair. Aspect attributes serve as a runtime parameter contract between caller (for example, this API or the DWScript API) and callee (the page). This parameter must not contain more than 256 characters after URL decoding.
+     * @param options.parameters.parameters - A free-form definition of parameters that influences the page rendering according to its implementation. This parameter must not contain more than 256 characters after URL decoding.
+     * @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 PageResult.
+     */
+    getPages(options?: RequireParametersUnlessAllAreOptional<{
+        parameters?: CompositeParameters<{
+            organizationId: string;
+            aspectTypeId: string;
+            siteId: string;
+            categoryId?: string;
+            productId?: string;
+            aspectAttributes?: string;
+            parameters?: string;
+            locale?: LocaleCode$0;
+        } & QueryParameters, ConfigParameters>;
+        headers?: {
+            [key: string]: string;
+        };
+    }>): Promise<PageResult>;
+    /**
+     * Get Page Designer pages. The results apply the visibility rules for each page's components, such as personalization or scheduled visibility.
+     
+     You must provide the `aspectTypeId` along with either a `categoryId` or a `productId`. Since you can only create one page-to-product or page-to-category assignment per aspect type, the result contains at most one element.
+     
+     **Important**:
+     - Currently, you can't use the Shopper Experience API when the [storefront password protection](https://documentation.b2c.commercecloud.salesforce.com/DOC1/index.jsp?topic=%2Fcom.demandware.dochelp%2Fcontent%2Fb2c_commerce%2Ftopics%2Fpermissions%2Fb2c_storefront_password_protection.html&resultof=%22%73%74%6f%72%65%66%72%6f%6e%74%22%20%22%70%72%6f%74%65%63%74%69%6f%6e%22%20%22%70%72%6f%74%65%63%74%22%20) feature is enabled.
+     - Because this resource uses the GET method, you must not pass sensitive data, for example: payment card information, and must not perform transactional processes within the server-side scripts that are run for the page and components.
+     - Be aware that pagecache during fingerprint calculation will only be leveraged for pages and their components that don't use visibility rules. Furthermore the pagecaching of the actual response assembly solely depends on the response instrumentation with the serverside page type and component type script implementations. For more details also see the [Page Designer Caching Guide](https://developer.salesforce.com/docs/commerce/b2c-commerce/guide/b2c-dev-for-page-designer.html#page-caching).
+     *
+     * @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.aspectTypeId - Aspect type identifier that is used for searching the page assignment in conjunction with either the `productId` or `categoryId`.
+     * @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.categoryId - Category identifier that is used for searching the page assignment. Must be provided if no `productId` is provided.
+     * @param options.parameters.productId - Product identifier that is used for searching the page assignment. Must be provided if no `categoryId` is provided.
+     * @param options.parameters.aspectAttributes - A JSON representation of aspect attributes. Each aspect attribute is a key/value pair. Aspect attributes serve as a runtime parameter contract between caller (for example, this API or the DWScript API) and callee (the page). This parameter must not contain more than 256 characters after URL decoding.
+     * @param options.parameters.parameters - A free-form definition of parameters that influences the page rendering according to its implementation. This parameter must not contain more than 256 characters after URL decoding.
+     * @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 PageResult otherwise.
+     */
+    getPages<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
+        parameters?: CompositeParameters<{
+            organizationId: string;
+            aspectTypeId: string;
+            siteId: string;
+            categoryId?: string;
+            productId?: string;
+            aspectAttributes?: string;
+            parameters?: string;
+            locale?: LocaleCode$0;
+        } & QueryParameters, ConfigParameters>;
+        headers?: {
+            [key: string]: string;
+        };
+    }>, rawResponse?: T): Promise<T extends true ? Response : PageResult>;
+}
+declare namespace ShopperExperienceApiTypes {
+    /*
+    * 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 Region:
+     *
+     * @property id: Region identifier.
+     * - **Max Length:** 256
+     *
+     * @property components: The components in the region.
+     *
+     */
+    type Region = {
+        id: string;
+        components?: Array<Component>;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type Component:
+     *
+     * @property id: Component identifier.
+     * - **Max Length:** 256
+     *
+     * @property typeId: Component type identifier.
+     * - **Max Length:** 256
+     *
+     * @property data: The configuration data assigned to the component.
+     *
+     * @property custom: Any custom data added by the custom code for this component.
+     *
+     * @property regions: The regions (and their assigned components) for the component.
+     *
+     */
+    type Component = {
+        id: string;
+        typeId: string;
+        data?: object;
+        custom?: object;
+        regions?: Array<Region>;
+    } & {
+        [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 Page:
+     *
+     * @property id: Page identifier.
+     * - **Max Length:** 256
+     *
+     * @property typeId: Page type identifier.
+     * - **Max Length:** 256
+     *
+     * @property aspectTypeId: The aspect type assigned to the page.
+     * - **Max Length:** 256
+     *
+     * @property name: Display name of the page.
+     * - **Max Length:** 4000
+     *
+     * @property description: Description of the page.
+     * - **Max Length:** 4000
+     *
+     * @property pageTitle: The SEO title of the page.
+     * - **Max Length:** 4000
+     *
+     * @property pageDescription: The SEO description of the page.
+     * - **Max Length:** 4000
+     *
+     * @property pageKeywords: The SEO keywords of the page.
+     * - **Max Length:** 4000
+     *
+     * @property data: The configuration data assigned to the page.
+     *
+     * @property custom: Any custom data added by the custom code for the page type.
+     *
+     * @property regions: The regions (and their assigned components) for the page.
+     *
+     */
+    type Page = {
+        id: string;
+        typeId: string;
+        aspectTypeId?: string;
+        name?: string;
+        description?: string;
+        pageTitle?: string;
+        pageDescription?: string;
+        pageKeywords?: string;
+        data?: object;
+        custom?: object;
+        regions?: Array<Region>;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type PageResult:
+     *
+     * @property data: List of pages.
+     *
+     */
+    type PageResult = {
+        data: Array<Page>;
+    } & {
+        [key: string]: any;
+    };
+    type getPageQueryParameters = {
+        aspectAttributes?: string;
+        parameters?: string;
+        siteId: string;
+        locale?: LocaleCode$0;
+    };
+    type getPagePathParameters = {
+        pageId: string;
+        organizationId: string;
+    };
+    type getPagesQueryParameters = {
+        categoryId?: string;
+        productId?: string;
+        aspectTypeId: string;
+        aspectAttributes?: string;
+        parameters?: string;
+        siteId: string;
+        locale?: LocaleCode$0;
+    };
+    type getPagesPathParameters = {
+        organizationId: string;
+    };
+    /**
+     * All path parameters that are used by at least one ShopperExperience method.
+     */
+    type ShopperExperiencePathParameters = Partial<getPagePathParameters & getPagesPathParameters & {}>;
+    /**
+     * All query parameters that are used by at least one ShopperExperience method.
+     */
+    type ShopperExperienceQueryParameters = Partial<getPageQueryParameters & getPagesQueryParameters & {}>;
+    /**
+     * All parameters that are used by ShopperExperience.
+     */
+    type ShopperExperienceParameters = ShopperExperiencePathParameters & BaseUriParameters & ShopperExperienceQueryParameters;
+    /**
+     * [Shopper Experience](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-experience:Summary)
+     * ==================================
+     *
+     * *Use the Shopper Experience API to look up page information for pages that are created in Page Designer.
+     
+     Responses include the following:
+     
+     - The entire component hierarchy of the page at design time.
+     - All merchant data provided at design time.
+     - Server-side scripting data provided at run time.
+     
+     Both the page and components contain the values of all native and custom attributes that have been populated during page authoring.
+     
+     Only visible pages are returned. Because the visibility of components is driven by rules (scheduling or customer groups, for example), these rules are subject to evaluation when assembling the component hierarchy in the response. Only components that are visible for the current customer context appear in the response. The same rules apply to the page itself, which is only be processed and returned if it is visible.
+     
+     **Important**: Currently, the Shopper Experience API can’t be used when the [storefront password protection](https://documentation.b2c.commercecloud.salesforce.com/DOC1/index.jsp?topic=%2Fcom.demandware.dochelp%2Fcontent%2Fb2c_commerce%2Ftopics%2Fpermissions%2Fb2c_storefront_password_protection.html&resultof=%22%73%74%6f%72%65%66%72%6f%6e%74%22%20%22%70%72%6f%74%65%63%74%69%6f%6e%22%20%22%70%72%6f%74%65%63%74%22%20) feature is enabled.
+     
+     ## Authentication & Authorization
+     
+     The Shopper Experience 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.
+     
+     You must include the relevant scope(s) in the client ID used to generate the SLAS token. For details, see the [Authorization Scopes Catalog.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/auth-z-scope-catalog.html).*<br />
+     *
+     * Simple example:
+     *
+     * ```typescript
+     *   import { ShopperExperience } from "commerce-sdk-isomorphic";
+     *
+     *   const clientConfig = {
+     *     parameters: {
+     *       clientId: "XXXXXX",
+     *       organizationId: "XXXX",
+     *       shortCode: "XXX",
+     *       siteId: "XX"
+     *     }
+     *   };
+     *   const shopperExperienceClient = new ShopperExperience(clientConfig);
+     * ```
+     *
+     * <span style="font-size:.7em; display:block; text-align: right">
+     * API Version: 0.0.33<br />
+     * Last Updated: <br />
+     * </span>
+     *
+     *
+     */
+    class ShopperExperience<ConfigParameters extends ShopperExperienceParameters & 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/experience/shopper-experience/v1";
+        static readonly apiPaths: {
+            getPage: string;
+            getPages: string;
+        };
+        constructor(config: ClientConfigInit<ConfigParameters>);
+        static readonly paramKeys: {
+            readonly getPage: readonly [
+                "pageId",
+                "organizationId",
+                "siteId",
+                "aspectAttributes",
+                "parameters",
+                "locale"
+            ];
+            readonly getPageRequired: readonly [
+                "pageId",
+                "organizationId",
+                "siteId"
+            ];
+            readonly getPages: readonly [
+                "organizationId",
+                "aspectTypeId",
+                "siteId",
+                "categoryId",
+                "productId",
+                "aspectAttributes",
+                "parameters",
+                "locale"
+            ];
+            readonly getPagesRequired: readonly [
+                "organizationId",
+                "aspectTypeId",
+                "siteId"
+            ];
+        };
+        /**
+         * Get a Page Designer page for a specific page ID. The results apply the visibility rules for the page's components, such as personalization or scheduled visibility.
+         
+         **Important**:
+         - Currently, you can't use the Shopper Experience API when the [storefront password protection](https://documentation.b2c.commercecloud.salesforce.com/DOC1/index.jsp?topic=%2Fcom.demandware.dochelp%2Fcontent%2Fb2c_commerce%2Ftopics%2Fpermissions%2Fb2c_storefront_password_protection.html&resultof=%22%73%74%6f%72%65%66%72%6f%6e%74%22%20%22%70%72%6f%74%65%63%74%69%6f%6e%22%20%22%70%72%6f%74%65%63%74%22%20) feature is enabled.
+         - Because this resource uses the GET method, you must not pass sensitive data, for example: payment card information, and must not perform transactional processes within the server-side scripts that are run for the page and components.
+         - Be aware that pagecache during fingerprint calculation will only be leveraged for pages and their components that don't use visibility rules. Furthermore the pagecaching of the actual response assembly solely depends on the response instrumentation with the serverside page type and component type script implementations. For more details also see the [Page Designer Caching Guide](https://developer.salesforce.com/docs/commerce/b2c-commerce/guide/b2c-dev-for-page-designer.html#page-caching).
+         *
+         * If you would like to get a raw Response object use the other getPage 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.pageId - Identifier for the requested page.
+         * @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.aspectAttributes - A JSON representation of aspect attributes. Each aspect attribute is a key/value pair. Aspect attributes serve as a runtime parameter contract between caller (for example, this API or the DWScript API) and callee (the page). This parameter must not contain more than 256 characters after URL decoding.
+         * @param options.parameters.parameters - A free-form definition of parameters that influences the page rendering according to its implementation. This parameter must not contain more than 256 characters after URL decoding.
+         * @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 Page.
+         */
+        getPage(options?: RequireParametersUnlessAllAreOptional<{
+            parameters?: CompositeParameters<{
+                pageId: string;
+                organizationId: string;
+                siteId: string;
+                aspectAttributes?: string;
+                parameters?: string;
+                locale?: LocaleCode$0;
+            } & QueryParameters, ConfigParameters>;
+            headers?: {
+                [key: string]: string;
+            };
+        }>): Promise<Page>;
+        /**
+         * Get a Page Designer page for a specific page ID. The results apply the visibility rules for the page's components, such as personalization or scheduled visibility.
+         
+         **Important**:
+         - Currently, you can't use the Shopper Experience API when the [storefront password protection](https://documentation.b2c.commercecloud.salesforce.com/DOC1/index.jsp?topic=%2Fcom.demandware.dochelp%2Fcontent%2Fb2c_commerce%2Ftopics%2Fpermissions%2Fb2c_storefront_password_protection.html&resultof=%22%73%74%6f%72%65%66%72%6f%6e%74%22%20%22%70%72%6f%74%65%63%74%69%6f%6e%22%20%22%70%72%6f%74%65%63%74%22%20) feature is enabled.
+         - Because this resource uses the GET method, you must not pass sensitive data, for example: payment card information, and must not perform transactional processes within the server-side scripts that are run for the page and components.
+         - Be aware that pagecache during fingerprint calculation will only be leveraged for pages and their components that don't use visibility rules. Furthermore the pagecaching of the actual response assembly solely depends on the response instrumentation with the serverside page type and component type script implementations. For more details also see the [Page Designer Caching Guide](https://developer.salesforce.com/docs/commerce/b2c-commerce/guide/b2c-dev-for-page-designer.html#page-caching).
+         *
+         * @param options - An object containing the options for this method.
+         * @param options.parameters - An object containing the parameters for this method.
+         * @param options.parameters.pageId - Identifier for the requested page.
+         * @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.aspectAttributes - A JSON representation of aspect attributes. Each aspect attribute is a key/value pair. Aspect attributes serve as a runtime parameter contract between caller (for example, this API or the DWScript API) and callee (the page). This parameter must not contain more than 256 characters after URL decoding.
+         * @param options.parameters.parameters - A free-form definition of parameters that influences the page rendering according to its implementation. This parameter must not contain more than 256 characters after URL decoding.
+         * @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 Page otherwise.
+         */
+        getPage<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
+            parameters?: CompositeParameters<{
+                pageId: string;
+                organizationId: string;
+                siteId: string;
+                aspectAttributes?: string;
+                parameters?: string;
+                locale?: LocaleCode$0;
+            } & QueryParameters, ConfigParameters>;
+            headers?: {
+                [key: string]: string;
+            };
+        }>, rawResponse?: T): Promise<T extends true ? Response : Page>;
+        /**
+         * Get Page Designer pages. The results apply the visibility rules for each page's components, such as personalization or scheduled visibility.
+         
+         You must provide the `aspectTypeId` along with either a `categoryId` or a `productId`. Since you can only create one page-to-product or page-to-category assignment per aspect type, the result contains at most one element.
+         
+         **Important**:
+         - Currently, you can't use the Shopper Experience API when the [storefront password protection](https://documentation.b2c.commercecloud.salesforce.com/DOC1/index.jsp?topic=%2Fcom.demandware.dochelp%2Fcontent%2Fb2c_commerce%2Ftopics%2Fpermissions%2Fb2c_storefront_password_protection.html&resultof=%22%73%74%6f%72%65%66%72%6f%6e%74%22%20%22%70%72%6f%74%65%63%74%69%6f%6e%22%20%22%70%72%6f%74%65%63%74%22%20) feature is enabled.
+         - Because this resource uses the GET method, you must not pass sensitive data, for example: payment card information, and must not perform transactional processes within the server-side scripts that are run for the page and components.
+         - Be aware that pagecache during fingerprint calculation will only be leveraged for pages and their components that don't use visibility rules. Furthermore the pagecaching of the actual response assembly solely depends on the response instrumentation with the serverside page type and component type script implementations. For more details also see the [Page Designer Caching Guide](https://developer.salesforce.com/docs/commerce/b2c-commerce/guide/b2c-dev-for-page-designer.html#page-caching).
+         *
+         * If you would like to get a raw Response object use the other getPages 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.aspectTypeId - Aspect type identifier that is used for searching the page assignment in conjunction with either the `productId` or `categoryId`.
+         * @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.categoryId - Category identifier that is used for searching the page assignment. Must be provided if no `productId` is provided.
+         * @param options.parameters.productId - Product identifier that is used for searching the page assignment. Must be provided if no `categoryId` is provided.
+         * @param options.parameters.aspectAttributes - A JSON representation of aspect attributes. Each aspect attribute is a key/value pair. Aspect attributes serve as a runtime parameter contract between caller (for example, this API or the DWScript API) and callee (the page). This parameter must not contain more than 256 characters after URL decoding.
+         * @param options.parameters.parameters - A free-form definition of parameters that influences the page rendering according to its implementation. This parameter must not contain more than 256 characters after URL decoding.
+         * @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 PageResult.
+         */
+        getPages(options?: RequireParametersUnlessAllAreOptional<{
+            parameters?: CompositeParameters<{
+                organizationId: string;
+                aspectTypeId: string;
+                siteId: string;
+                categoryId?: string;
+                productId?: string;
+                aspectAttributes?: string;
+                parameters?: string;
+                locale?: LocaleCode$0;
+            } & QueryParameters, ConfigParameters>;
+            headers?: {
+                [key: string]: string;
+            };
+        }>): Promise<PageResult>;
+        /**
+         * Get Page Designer pages. The results apply the visibility rules for each page's components, such as personalization or scheduled visibility.
+         
+         You must provide the `aspectTypeId` along with either a `categoryId` or a `productId`. Since you can only create one page-to-product or page-to-category assignment per aspect type, the result contains at most one element.
+         
+         **Important**:
+         - Currently, you can't use the Shopper Experience API when the [storefront password protection](https://documentation.b2c.commercecloud.salesforce.com/DOC1/index.jsp?topic=%2Fcom.demandware.dochelp%2Fcontent%2Fb2c_commerce%2Ftopics%2Fpermissions%2Fb2c_storefront_password_protection.html&resultof=%22%73%74%6f%72%65%66%72%6f%6e%74%22%20%22%70%72%6f%74%65%63%74%69%6f%6e%22%20%22%70%72%6f%74%65%63%74%22%20) feature is enabled.
+         - Because this resource uses the GET method, you must not pass sensitive data, for example: payment card information, and must not perform transactional processes within the server-side scripts that are run for the page and components.
+         - Be aware that pagecache during fingerprint calculation will only be leveraged for pages and their components that don't use visibility rules. Furthermore the pagecaching of the actual response assembly solely depends on the response instrumentation with the serverside page type and component type script implementations. For more details also see the [Page Designer Caching Guide](https://developer.salesforce.com/docs/commerce/b2c-commerce/guide/b2c-dev-for-page-designer.html#page-caching).
+         *
+         * @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.aspectTypeId - Aspect type identifier that is used for searching the page assignment in conjunction with either the `productId` or `categoryId`.
+         * @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.categoryId - Category identifier that is used for searching the page assignment. Must be provided if no `productId` is provided.
+         * @param options.parameters.productId - Product identifier that is used for searching the page assignment. Must be provided if no `categoryId` is provided.
+         * @param options.parameters.aspectAttributes - A JSON representation of aspect attributes. Each aspect attribute is a key/value pair. Aspect attributes serve as a runtime parameter contract between caller (for example, this API or the DWScript API) and callee (the page). This parameter must not contain more than 256 characters after URL decoding.
+         * @param options.parameters.parameters - A free-form definition of parameters that influences the page rendering according to its implementation. This parameter must not contain more than 256 characters after URL decoding.
+         * @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 PageResult otherwise.
+         */
+        getPages<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
+            parameters?: CompositeParameters<{
+                organizationId: string;
+                aspectTypeId: string;
+                siteId: string;
+                categoryId?: string;
+                productId?: string;
+                aspectAttributes?: string;
+                parameters?: string;
+                locale?: LocaleCode$0;
+            } & QueryParameters, ConfigParameters>;
+            headers?: {
+                [key: string]: string;
+            };
+        }>, rawResponse?: T): Promise<T extends true ? Response : PageResult>;
+    }
+}
+declare namespace ShopperExperienceModelTypes {
+    /**
+     * @type Region:
+     *
+     * @property id: Region identifier.
+     * - **Max Length:** 256
+     *
+     * @property components: The components in the region.
+     *
+     */
+    type Region = {
+        id: string;
+        components?: Array<Component>;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type Component:
+     *
+     * @property id: Component identifier.
+     * - **Max Length:** 256
+     *
+     * @property typeId: Component type identifier.
+     * - **Max Length:** 256
+     *
+     * @property data: The configuration data assigned to the component.
+     *
+     * @property custom: Any custom data added by the custom code for this component.
+     *
+     * @property regions: The regions (and their assigned components) for the component.
+     *
+     */
+    type Component = {
+        id: string;
+        typeId: string;
+        data?: object;
+        custom?: object;
+        regions?: Array<Region>;
+    } & {
+        [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 Page:
+     *
+     * @property id: Page identifier.
+     * - **Max Length:** 256
+     *
+     * @property typeId: Page type identifier.
+     * - **Max Length:** 256
+     *
+     * @property aspectTypeId: The aspect type assigned to the page.
+     * - **Max Length:** 256
+     *
+     * @property name: Display name of the page.
+     * - **Max Length:** 4000
+     *
+     * @property description: Description of the page.
+     * - **Max Length:** 4000
+     *
+     * @property pageTitle: The SEO title of the page.
+     * - **Max Length:** 4000
+     *
+     * @property pageDescription: The SEO description of the page.
+     * - **Max Length:** 4000
+     *
+     * @property pageKeywords: The SEO keywords of the page.
+     * - **Max Length:** 4000
+     *
+     * @property data: The configuration data assigned to the page.
+     *
+     * @property custom: Any custom data added by the custom code for the page type.
+     *
+     * @property regions: The regions (and their assigned components) for the page.
+     *
+     */
+    type Page = {
+        id: string;
+        typeId: string;
+        aspectTypeId?: string;
+        name?: string;
+        description?: string;
+        pageTitle?: string;
+        pageDescription?: string;
+        pageKeywords?: string;
+        data?: object;
+        custom?: object;
+        regions?: Array<Region>;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type PageResult:
+     *
+     * @property data: List of pages.
+     *
+     */
+    type PageResult = {
+        data: Array<Page>;
+    } & {
+        [key: string]: any;
+    };
+}
+declare namespace ShopperExperienceTypes {
+    type ShopperExperiencePathParameters = ShopperExperienceApiTypes.ShopperExperiencePathParameters;
+    type ShopperExperienceQueryParameters = ShopperExperienceApiTypes.ShopperExperienceQueryParameters;
+    type getPageQueryParameters = ShopperExperienceApiTypes.getPageQueryParameters;
+    type getPagePathParameters = ShopperExperienceApiTypes.getPagePathParameters;
+    type getPagesQueryParameters = ShopperExperienceApiTypes.getPagesQueryParameters;
+    type getPagesPathParameters = ShopperExperienceApiTypes.getPagesPathParameters;
+    type Component = ShopperExperienceModelTypes.Component;
+    type DefaultFallback = ShopperExperienceModelTypes.DefaultFallback;
+    type ErrorResponse = ShopperExperienceModelTypes.ErrorResponse;
+    type LocaleCode = ShopperExperienceModelTypes.LocaleCode;
+    type Page = ShopperExperienceModelTypes.Page;
+    type PageResult = ShopperExperienceModelTypes.PageResult;
+    type Region = ShopperExperienceModelTypes.Region;
+}
+export { defaultBaseUri, getPageQueryParameters, getPagePathParameters, getPagesQueryParameters, getPagesPathParameters, ShopperExperiencePathParameters, ShopperExperienceQueryParameters, ShopperExperienceParameters, ShopperExperience, Component, DefaultFallback, ErrorResponse, LocaleCode$0 as LocaleCode, Page, PageResult, Region, ShopperExperienceTypes };