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

package/lib/shopperStores.d.ts

@@ -0,0 +1,1289 @@
+/*
+* 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/store/shopper-stores/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";
+/**
+ * The unit the distance attribute is measured in (either in miles or kilometers).
+ */
+type DistanceUnit = "km" | "mi";
+/**
+ * @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 PaginatedResultBase: Schema defining generic pageable result. Each response schema of a resource requiring pagination should extend this schema.  If you use this extend this schema directly, it needs to be defined what data is returned. Allowed names for the data field is `data`.
+ *
+ * @property offset: The zero-based index of the first hit/data to include in the result.
+ *
+ * @property limit: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).
+ *
+ * @property total: The total number of hits that match the search\'s criteria. This can be greater than the number of results returned as search results are pagenated.
+ *
+ */
+type PaginatedResultBase = {
+    offset: number;
+    limit: number;
+    total: number;
+} & {
+    [key: string]: any;
+};
+/**
+ * @type ResultBase: Schema defining generic list result. Each response schema of a resource requiring a list response should extend this schema.  Additionally it needs to be defined what data is returned.
+ *
+ * @property limit: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).
+ *
+ * @property total: The total number of hits that match the search\'s criteria. This can be greater than the number of results returned as search results are pagenated.
+ *
+ */
+type ResultBase = {
+    limit: number;
+    total: number;
+} & {
+    [key: string]: any;
+};
+/**
+ * @type Store: Document representing a store.
+ *
+ * @property address1: The primary address of the store.
+ * - **Min Length:** 1
+ *
+ * @property address2: The secondary address of the store.
+ *
+ * @property city: The city of the store.
+ *
+ * @property countryCode: A two letter uppercase country code conforming to the [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) alpha-2 standard.
+ * - **Pattern:** /^[A-Z][A-Z]$/
+ *
+ * @property distance: The distance to the given geolocation where the stores will be searched, using the unit given in the attribute \'DistanceUnit\' (miles or kilometers).
+ *
+ * @property distanceUnit:
+ *
+ * @property email: The email address of the store.
+ *
+ * @property fax: The fax number of the store.
+ *
+ * @property id: The id of the store.
+ * - **Min Length:** 1
+ * - **Max Length:** 256
+ *
+ * @property image: The store image.
+ *
+ * @property inventoryId: The inventory list id associated with this store.
+ * - **Max Length:** 256
+ *
+ * @property latitude: The latitude of the store.
+ *
+ * @property longitude: The longitude of the store.
+ *
+ * @property name: The store name.
+ *
+ * @property phone: The phone number of the store.
+ *
+ * @property posEnabled: Whether this store uses Store Point-of-Sale.
+ *
+ * @property postalCode: The postal code of the store.
+ * - **Min Length:** 3
+ * - **Max Length:** 10
+ *
+ * @property stateCode: The state code of the store.
+ *
+ * @property storeEvents: The store events.
+ *
+ * @property storeHours: The opening hours of the store.
+ *
+ * @property storeLocatorEnabled: Whether this store should show up in store locator results.
+ *
+ */
+type Store = {
+    address1?: string;
+    address2?: string;
+    city?: string;
+    countryCode?: string;
+    distance?: number;
+    distanceUnit?: DistanceUnit;
+    email?: string;
+    fax?: string;
+    id: string;
+    image?: string;
+    inventoryId?: string;
+    latitude?: number;
+    longitude?: number;
+    name?: string;
+    phone?: string;
+    posEnabled?: boolean;
+    postalCode?: string;
+    stateCode?: string;
+    storeEvents?: string;
+    storeHours?: string;
+    storeLocatorEnabled?: boolean;
+} & {
+    [key: string]: any;
+};
+/**
+ * @type StoreResult: Result object containing an array of stores.
+ *
+ * @property data: The list of stores in the search result.
+ *
+ * @property limit: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).
+ *
+ * @property total: The total number of hits that match the search\'s criteria. This can be greater than the number of results returned as search results are pagenated.
+ *
+ */
+type StoreResult = {
+    data?: Array<Store>;
+    limit: number;
+    total: number;
+} & {
+    [key: string]: any;
+};
+/**
+ * @type Stores: Result object containing an paginated array of stores.
+ *
+ * @property data: The list of stores in the search result.
+ *
+ * @property offset: The zero-based index of the first hit/data to include in the result.
+ *
+ * @property limit: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).
+ *
+ * @property total: The total number of hits that match the search\'s criteria. This can be greater than the number of results returned as search results are pagenated.
+ *
+ */
+type Stores = {
+    data?: Array<Store>;
+    offset: number;
+    limit: number;
+    total: number;
+} & {
+    [key: string]: any;
+};
+type getStoresQueryParameters = {
+    ids: string;
+    siteId: string;
+    locale?: LocaleCode$0;
+};
+type getStoresPathParameters = {
+    organizationId: string;
+};
+type searchStoresQueryParameters = {
+    countryCode?: string;
+    distanceUnit?: DistanceUnit;
+    latitude?: number;
+    longitude?: number;
+    maxDistance?: number;
+    postalCode?: string;
+    siteId: string;
+    locale?: LocaleCode$0;
+    limit?: number;
+    offset?: number;
+};
+type searchStoresPathParameters = {
+    organizationId: string;
+};
+/**
+ * All path parameters that are used by at least one ShopperStores method.
+ */
+type ShopperStoresPathParameters = Partial<getStoresPathParameters & searchStoresPathParameters & {}>;
+/**
+ * All query parameters that are used by at least one ShopperStores method.
+ */
+type ShopperStoresQueryParameters = Partial<getStoresQueryParameters & searchStoresQueryParameters & {}>;
+/**
+ * All parameters that are used by ShopperStores.
+ */
+type ShopperStoresParameters = ShopperStoresPathParameters & BaseUriParameters & ShopperStoresQueryParameters;
+/**
+ * [Shopper Stores](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-stores:Summary)
+ * ==================================
+ *
+ * *# API Overview
+ 
+ Provides access to stores via search or ID lookup.
+ 
+ 
+ ## Authentication & Authorization
+ 
+ The Shopper Stores 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)*<br />
+ *
+ * Simple example:
+ *
+ * ```typescript
+ *   import { ShopperStores } from "commerce-sdk-isomorphic";
+ *
+ *   const clientConfig = {
+ *     parameters: {
+ *       clientId: "XXXXXX",
+ *       organizationId: "XXXX",
+ *       shortCode: "XXX",
+ *       siteId: "XX"
+ *     }
+ *   };
+ *   const shopperStoresClient = new ShopperStores(clientConfig);
+ * ```
+ *
+ * <span style="font-size:.7em; display:block; text-align: right">
+ * API Version: 0.0.33<br />
+ * Last Updated: <br />
+ * </span>
+ *
+ *
+ */
+declare class ShopperStores<ConfigParameters extends ShopperStoresParameters & 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/store/shopper-stores/v1";
+    static readonly apiPaths: {
+        getStores: string;
+        searchStores: string;
+    };
+    constructor(config: ClientConfigInit<ConfigParameters>);
+    static readonly paramKeys: {
+        readonly getStores: readonly [
+            "organizationId",
+            "ids",
+            "siteId",
+            "locale"
+        ];
+        readonly getStoresRequired: readonly [
+            "organizationId",
+            "ids",
+            "siteId"
+        ];
+        readonly searchStores: readonly [
+            "organizationId",
+            "siteId",
+            "countryCode",
+            "distanceUnit",
+            "latitude",
+            "longitude",
+            "maxDistance",
+            "postalCode",
+            "locale",
+            "limit",
+            "offset"
+        ];
+        readonly searchStoresRequired: readonly [
+            "organizationId",
+            "siteId"
+        ];
+    };
+    /**
+     *
+     *
+     * If you would like to get a raw Response object use the other getStores function.
+     *
+     * @param options - An object containing the options for this method.
+     * @param options.parameters - An object containing the parameters for this method.
+     * @param options.parameters.organizationId - An identifier for the organization the request is being made by
+     * @param options.parameters.ids - The IDs of a requested stores (comma separated, max 50 IDs).
+     * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
+     * @param options.parameters.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 StoreResult.
+     */
+    getStores(options?: RequireParametersUnlessAllAreOptional<{
+        parameters?: CompositeParameters<{
+            organizationId: string;
+            ids: string;
+            siteId: string;
+            locale?: LocaleCode$0;
+        } & QueryParameters, ConfigParameters>;
+        headers?: {
+            [key: string]: string;
+        };
+    }>): Promise<StoreResult>;
+    /**
+     *
+     *
+     * @param options - An object containing the options for this method.
+     * @param options.parameters - An object containing the parameters for this method.
+     * @param options.parameters.organizationId - An identifier for the organization the request is being made by
+     * @param options.parameters.ids - The IDs of a requested stores (comma separated, max 50 IDs).
+     * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
+     * @param options.parameters.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 StoreResult otherwise.
+     */
+    getStores<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
+        parameters?: CompositeParameters<{
+            organizationId: string;
+            ids: string;
+            siteId: string;
+            locale?: LocaleCode$0;
+        } & QueryParameters, ConfigParameters>;
+        headers?: {
+            [key: string]: string;
+        };
+    }>, rawResponse?: T): Promise<T extends true ? Response : StoreResult>;
+    /**
+     * - The distance is interpreted either in miles or kilometers, depending on the `distanceUnit` input parameter.
+     - The location is specified by either directly providing a latitude and longitude coordinate pair, or by providing a country and a postal code. If a postal code is passed, the resource looks in the system's geolocation mappings in Business Manager to find the coordinates for this postal code. If no matching geolocation is found, the resource returns an empty list of stores. If coordinates are passed, the values for country and postal code are ignored.
+     
+     To verify site latitude and longitude information in Business Manager:
+     - Navigate to **Merchant Tools -> Online Marketing -> Stores**.
+     - Select the applicable site.
+     - In the **Address** tab, verify that valid information is provided in the following fields: **Address**, **City**, **Postal Code**, **State**, and **Country**. For latitude and longitude values, you can manually enter values or provide all field values to auto-populate **Latitude** and **Longitude**. You must provide valid values for all of the previous fields for latitude and longitude to auto-populate **Latitude** and **Longitude** values.
+     
+     *
+     * If you would like to get a raw Response object use the other searchStores function.
+     *
+     * @param options - An object containing the options for this method.
+     * @param options.parameters - An object containing the parameters for this method.
+     * @param options.parameters.organizationId - An identifier for the organization the request is being made by
+     * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
+     * @param options.parameters.countryCode - The two letter ISO country code, such as "US". This value is required when a postalCode is provided.
+     * @param options.parameters.distanceUnit - The distance unit. Supported values are "mi" (miles) and "km" (kilometers). The default is "km".
+     * @param options.parameters.latitude - The geographical latitude to search for stores (value range -90.00 .. 90.00). This value is required when a longitude is provided.
+     * @param options.parameters.longitude - The geographical longitude to search for stores (value range -180.00 .. 180.00). You must provide a longitude when a latitude is provided.
+     * @param options.parameters.maxDistance - The area (radius) in distanceUnit where stores will be searched.
+     * @param options.parameters.postalCode - The postal code, such as "84121". You must provide a countryCode when a postalCode is provided.
+     * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
+     * @param options.parameters.limit - Maximum records to retrieve per request, not to exceed 200. Defaults to 25.
+     * @param options.parameters.offset - Used to retrieve the results based on a particular resource offset.
+     * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
+     *
+     * @returns A promise of type Stores.
+     */
+    searchStores(options?: RequireParametersUnlessAllAreOptional<{
+        parameters?: CompositeParameters<{
+            organizationId: string;
+            siteId: string;
+            countryCode?: string;
+            distanceUnit?: DistanceUnit;
+            latitude?: number;
+            longitude?: number;
+            maxDistance?: number;
+            postalCode?: string;
+            locale?: LocaleCode$0;
+            limit?: number;
+            offset?: number;
+        } & QueryParameters, ConfigParameters>;
+        headers?: {
+            [key: string]: string;
+        };
+    }>): Promise<Stores>;
+    /**
+     * - The distance is interpreted either in miles or kilometers, depending on the `distanceUnit` input parameter.
+     - The location is specified by either directly providing a latitude and longitude coordinate pair, or by providing a country and a postal code. If a postal code is passed, the resource looks in the system's geolocation mappings in Business Manager to find the coordinates for this postal code. If no matching geolocation is found, the resource returns an empty list of stores. If coordinates are passed, the values for country and postal code are ignored.
+     
+     To verify site latitude and longitude information in Business Manager:
+     - Navigate to **Merchant Tools -> Online Marketing -> Stores**.
+     - Select the applicable site.
+     - In the **Address** tab, verify that valid information is provided in the following fields: **Address**, **City**, **Postal Code**, **State**, and **Country**. For latitude and longitude values, you can manually enter values or provide all field values to auto-populate **Latitude** and **Longitude**. You must provide valid values for all of the previous fields for latitude and longitude to auto-populate **Latitude** and **Longitude** values.
+     
+     *
+     * @param options - An object containing the options for this method.
+     * @param options.parameters - An object containing the parameters for this method.
+     * @param options.parameters.organizationId - An identifier for the organization the request is being made by
+     * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
+     * @param options.parameters.countryCode - The two letter ISO country code, such as "US". This value is required when a postalCode is provided.
+     * @param options.parameters.distanceUnit - The distance unit. Supported values are "mi" (miles) and "km" (kilometers). The default is "km".
+     * @param options.parameters.latitude - The geographical latitude to search for stores (value range -90.00 .. 90.00). This value is required when a longitude is provided.
+     * @param options.parameters.longitude - The geographical longitude to search for stores (value range -180.00 .. 180.00). You must provide a longitude when a latitude is provided.
+     * @param options.parameters.maxDistance - The area (radius) in distanceUnit where stores will be searched.
+     * @param options.parameters.postalCode - The postal code, such as "84121". You must provide a countryCode when a postalCode is provided.
+     * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
+     * @param options.parameters.limit - Maximum records to retrieve per request, not to exceed 200. Defaults to 25.
+     * @param options.parameters.offset - Used to retrieve the results based on a particular resource offset.
+     * @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 Stores otherwise.
+     */
+    searchStores<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
+        parameters?: CompositeParameters<{
+            organizationId: string;
+            siteId: string;
+            countryCode?: string;
+            distanceUnit?: DistanceUnit;
+            latitude?: number;
+            longitude?: number;
+            maxDistance?: number;
+            postalCode?: string;
+            locale?: LocaleCode$0;
+            limit?: number;
+            offset?: number;
+        } & QueryParameters, ConfigParameters>;
+        headers?: {
+            [key: string]: string;
+        };
+    }>, rawResponse?: T): Promise<T extends true ? Response : Stores>;
+}
+declare namespace ShopperStoresApiTypes {
+    /*
+    * 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";
+    /**
+     * The unit the distance attribute is measured in (either in miles or kilometers).
+     */
+    type DistanceUnit = "km" | "mi";
+    /**
+     * @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 PaginatedResultBase: Schema defining generic pageable result. Each response schema of a resource requiring pagination should extend this schema.  If you use this extend this schema directly, it needs to be defined what data is returned. Allowed names for the data field is `data`.
+     *
+     * @property offset: The zero-based index of the first hit/data to include in the result.
+     *
+     * @property limit: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).
+     *
+     * @property total: The total number of hits that match the search\'s criteria. This can be greater than the number of results returned as search results are pagenated.
+     *
+     */
+    type PaginatedResultBase = {
+        offset: number;
+        limit: number;
+        total: number;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type ResultBase: Schema defining generic list result. Each response schema of a resource requiring a list response should extend this schema.  Additionally it needs to be defined what data is returned.
+     *
+     * @property limit: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).
+     *
+     * @property total: The total number of hits that match the search\'s criteria. This can be greater than the number of results returned as search results are pagenated.
+     *
+     */
+    type ResultBase = {
+        limit: number;
+        total: number;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type Store: Document representing a store.
+     *
+     * @property address1: The primary address of the store.
+     * - **Min Length:** 1
+     *
+     * @property address2: The secondary address of the store.
+     *
+     * @property city: The city of the store.
+     *
+     * @property countryCode: A two letter uppercase country code conforming to the [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) alpha-2 standard.
+     * - **Pattern:** /^[A-Z][A-Z]$/
+     *
+     * @property distance: The distance to the given geolocation where the stores will be searched, using the unit given in the attribute \'DistanceUnit\' (miles or kilometers).
+     *
+     * @property distanceUnit:
+     *
+     * @property email: The email address of the store.
+     *
+     * @property fax: The fax number of the store.
+     *
+     * @property id: The id of the store.
+     * - **Min Length:** 1
+     * - **Max Length:** 256
+     *
+     * @property image: The store image.
+     *
+     * @property inventoryId: The inventory list id associated with this store.
+     * - **Max Length:** 256
+     *
+     * @property latitude: The latitude of the store.
+     *
+     * @property longitude: The longitude of the store.
+     *
+     * @property name: The store name.
+     *
+     * @property phone: The phone number of the store.
+     *
+     * @property posEnabled: Whether this store uses Store Point-of-Sale.
+     *
+     * @property postalCode: The postal code of the store.
+     * - **Min Length:** 3
+     * - **Max Length:** 10
+     *
+     * @property stateCode: The state code of the store.
+     *
+     * @property storeEvents: The store events.
+     *
+     * @property storeHours: The opening hours of the store.
+     *
+     * @property storeLocatorEnabled: Whether this store should show up in store locator results.
+     *
+     */
+    type Store = {
+        address1?: string;
+        address2?: string;
+        city?: string;
+        countryCode?: string;
+        distance?: number;
+        distanceUnit?: DistanceUnit;
+        email?: string;
+        fax?: string;
+        id: string;
+        image?: string;
+        inventoryId?: string;
+        latitude?: number;
+        longitude?: number;
+        name?: string;
+        phone?: string;
+        posEnabled?: boolean;
+        postalCode?: string;
+        stateCode?: string;
+        storeEvents?: string;
+        storeHours?: string;
+        storeLocatorEnabled?: boolean;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type StoreResult: Result object containing an array of stores.
+     *
+     * @property data: The list of stores in the search result.
+     *
+     * @property limit: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).
+     *
+     * @property total: The total number of hits that match the search\'s criteria. This can be greater than the number of results returned as search results are pagenated.
+     *
+     */
+    type StoreResult = {
+        data?: Array<Store>;
+        limit: number;
+        total: number;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type Stores: Result object containing an paginated array of stores.
+     *
+     * @property data: The list of stores in the search result.
+     *
+     * @property offset: The zero-based index of the first hit/data to include in the result.
+     *
+     * @property limit: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).
+     *
+     * @property total: The total number of hits that match the search\'s criteria. This can be greater than the number of results returned as search results are pagenated.
+     *
+     */
+    type Stores = {
+        data?: Array<Store>;
+        offset: number;
+        limit: number;
+        total: number;
+    } & {
+        [key: string]: any;
+    };
+    type getStoresQueryParameters = {
+        ids: string;
+        siteId: string;
+        locale?: LocaleCode$0;
+    };
+    type getStoresPathParameters = {
+        organizationId: string;
+    };
+    type searchStoresQueryParameters = {
+        countryCode?: string;
+        distanceUnit?: DistanceUnit;
+        latitude?: number;
+        longitude?: number;
+        maxDistance?: number;
+        postalCode?: string;
+        siteId: string;
+        locale?: LocaleCode$0;
+        limit?: number;
+        offset?: number;
+    };
+    type searchStoresPathParameters = {
+        organizationId: string;
+    };
+    /**
+     * All path parameters that are used by at least one ShopperStores method.
+     */
+    type ShopperStoresPathParameters = Partial<getStoresPathParameters & searchStoresPathParameters & {}>;
+    /**
+     * All query parameters that are used by at least one ShopperStores method.
+     */
+    type ShopperStoresQueryParameters = Partial<getStoresQueryParameters & searchStoresQueryParameters & {}>;
+    /**
+     * All parameters that are used by ShopperStores.
+     */
+    type ShopperStoresParameters = ShopperStoresPathParameters & BaseUriParameters & ShopperStoresQueryParameters;
+    /**
+     * [Shopper Stores](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-stores:Summary)
+     * ==================================
+     *
+     * *# API Overview
+     
+     Provides access to stores via search or ID lookup.
+     
+     
+     ## Authentication & Authorization
+     
+     The Shopper Stores 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)*<br />
+     *
+     * Simple example:
+     *
+     * ```typescript
+     *   import { ShopperStores } from "commerce-sdk-isomorphic";
+     *
+     *   const clientConfig = {
+     *     parameters: {
+     *       clientId: "XXXXXX",
+     *       organizationId: "XXXX",
+     *       shortCode: "XXX",
+     *       siteId: "XX"
+     *     }
+     *   };
+     *   const shopperStoresClient = new ShopperStores(clientConfig);
+     * ```
+     *
+     * <span style="font-size:.7em; display:block; text-align: right">
+     * API Version: 0.0.33<br />
+     * Last Updated: <br />
+     * </span>
+     *
+     *
+     */
+    class ShopperStores<ConfigParameters extends ShopperStoresParameters & 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/store/shopper-stores/v1";
+        static readonly apiPaths: {
+            getStores: string;
+            searchStores: string;
+        };
+        constructor(config: ClientConfigInit<ConfigParameters>);
+        static readonly paramKeys: {
+            readonly getStores: readonly [
+                "organizationId",
+                "ids",
+                "siteId",
+                "locale"
+            ];
+            readonly getStoresRequired: readonly [
+                "organizationId",
+                "ids",
+                "siteId"
+            ];
+            readonly searchStores: readonly [
+                "organizationId",
+                "siteId",
+                "countryCode",
+                "distanceUnit",
+                "latitude",
+                "longitude",
+                "maxDistance",
+                "postalCode",
+                "locale",
+                "limit",
+                "offset"
+            ];
+            readonly searchStoresRequired: readonly [
+                "organizationId",
+                "siteId"
+            ];
+        };
+        /**
+         *
+         *
+         * If you would like to get a raw Response object use the other getStores function.
+         *
+         * @param options - An object containing the options for this method.
+         * @param options.parameters - An object containing the parameters for this method.
+         * @param options.parameters.organizationId - An identifier for the organization the request is being made by
+         * @param options.parameters.ids - The IDs of a requested stores (comma separated, max 50 IDs).
+         * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
+         * @param options.parameters.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 StoreResult.
+         */
+        getStores(options?: RequireParametersUnlessAllAreOptional<{
+            parameters?: CompositeParameters<{
+                organizationId: string;
+                ids: string;
+                siteId: string;
+                locale?: LocaleCode$0;
+            } & QueryParameters, ConfigParameters>;
+            headers?: {
+                [key: string]: string;
+            };
+        }>): Promise<StoreResult>;
+        /**
+         *
+         *
+         * @param options - An object containing the options for this method.
+         * @param options.parameters - An object containing the parameters for this method.
+         * @param options.parameters.organizationId - An identifier for the organization the request is being made by
+         * @param options.parameters.ids - The IDs of a requested stores (comma separated, max 50 IDs).
+         * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
+         * @param options.parameters.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 StoreResult otherwise.
+         */
+        getStores<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
+            parameters?: CompositeParameters<{
+                organizationId: string;
+                ids: string;
+                siteId: string;
+                locale?: LocaleCode$0;
+            } & QueryParameters, ConfigParameters>;
+            headers?: {
+                [key: string]: string;
+            };
+        }>, rawResponse?: T): Promise<T extends true ? Response : StoreResult>;
+        /**
+         * - The distance is interpreted either in miles or kilometers, depending on the `distanceUnit` input parameter.
+         - The location is specified by either directly providing a latitude and longitude coordinate pair, or by providing a country and a postal code. If a postal code is passed, the resource looks in the system's geolocation mappings in Business Manager to find the coordinates for this postal code. If no matching geolocation is found, the resource returns an empty list of stores. If coordinates are passed, the values for country and postal code are ignored.
+         
+         To verify site latitude and longitude information in Business Manager:
+         - Navigate to **Merchant Tools -> Online Marketing -> Stores**.
+         - Select the applicable site.
+         - In the **Address** tab, verify that valid information is provided in the following fields: **Address**, **City**, **Postal Code**, **State**, and **Country**. For latitude and longitude values, you can manually enter values or provide all field values to auto-populate **Latitude** and **Longitude**. You must provide valid values for all of the previous fields for latitude and longitude to auto-populate **Latitude** and **Longitude** values.
+         
+         *
+         * If you would like to get a raw Response object use the other searchStores function.
+         *
+         * @param options - An object containing the options for this method.
+         * @param options.parameters - An object containing the parameters for this method.
+         * @param options.parameters.organizationId - An identifier for the organization the request is being made by
+         * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
+         * @param options.parameters.countryCode - The two letter ISO country code, such as "US". This value is required when a postalCode is provided.
+         * @param options.parameters.distanceUnit - The distance unit. Supported values are "mi" (miles) and "km" (kilometers). The default is "km".
+         * @param options.parameters.latitude - The geographical latitude to search for stores (value range -90.00 .. 90.00). This value is required when a longitude is provided.
+         * @param options.parameters.longitude - The geographical longitude to search for stores (value range -180.00 .. 180.00). You must provide a longitude when a latitude is provided.
+         * @param options.parameters.maxDistance - The area (radius) in distanceUnit where stores will be searched.
+         * @param options.parameters.postalCode - The postal code, such as "84121". You must provide a countryCode when a postalCode is provided.
+         * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
+         * @param options.parameters.limit - Maximum records to retrieve per request, not to exceed 200. Defaults to 25.
+         * @param options.parameters.offset - Used to retrieve the results based on a particular resource offset.
+         * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
+         *
+         * @returns A promise of type Stores.
+         */
+        searchStores(options?: RequireParametersUnlessAllAreOptional<{
+            parameters?: CompositeParameters<{
+                organizationId: string;
+                siteId: string;
+                countryCode?: string;
+                distanceUnit?: DistanceUnit;
+                latitude?: number;
+                longitude?: number;
+                maxDistance?: number;
+                postalCode?: string;
+                locale?: LocaleCode$0;
+                limit?: number;
+                offset?: number;
+            } & QueryParameters, ConfigParameters>;
+            headers?: {
+                [key: string]: string;
+            };
+        }>): Promise<Stores>;
+        /**
+         * - The distance is interpreted either in miles or kilometers, depending on the `distanceUnit` input parameter.
+         - The location is specified by either directly providing a latitude and longitude coordinate pair, or by providing a country and a postal code. If a postal code is passed, the resource looks in the system's geolocation mappings in Business Manager to find the coordinates for this postal code. If no matching geolocation is found, the resource returns an empty list of stores. If coordinates are passed, the values for country and postal code are ignored.
+         
+         To verify site latitude and longitude information in Business Manager:
+         - Navigate to **Merchant Tools -> Online Marketing -> Stores**.
+         - Select the applicable site.
+         - In the **Address** tab, verify that valid information is provided in the following fields: **Address**, **City**, **Postal Code**, **State**, and **Country**. For latitude and longitude values, you can manually enter values or provide all field values to auto-populate **Latitude** and **Longitude**. You must provide valid values for all of the previous fields for latitude and longitude to auto-populate **Latitude** and **Longitude** values.
+         
+         *
+         * @param options - An object containing the options for this method.
+         * @param options.parameters - An object containing the parameters for this method.
+         * @param options.parameters.organizationId - An identifier for the organization the request is being made by
+         * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
+         * @param options.parameters.countryCode - The two letter ISO country code, such as "US". This value is required when a postalCode is provided.
+         * @param options.parameters.distanceUnit - The distance unit. Supported values are "mi" (miles) and "km" (kilometers). The default is "km".
+         * @param options.parameters.latitude - The geographical latitude to search for stores (value range -90.00 .. 90.00). This value is required when a longitude is provided.
+         * @param options.parameters.longitude - The geographical longitude to search for stores (value range -180.00 .. 180.00). You must provide a longitude when a latitude is provided.
+         * @param options.parameters.maxDistance - The area (radius) in distanceUnit where stores will be searched.
+         * @param options.parameters.postalCode - The postal code, such as "84121". You must provide a countryCode when a postalCode is provided.
+         * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
+         * @param options.parameters.limit - Maximum records to retrieve per request, not to exceed 200. Defaults to 25.
+         * @param options.parameters.offset - Used to retrieve the results based on a particular resource offset.
+         * @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 Stores otherwise.
+         */
+        searchStores<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
+            parameters?: CompositeParameters<{
+                organizationId: string;
+                siteId: string;
+                countryCode?: string;
+                distanceUnit?: DistanceUnit;
+                latitude?: number;
+                longitude?: number;
+                maxDistance?: number;
+                postalCode?: string;
+                locale?: LocaleCode$0;
+                limit?: number;
+                offset?: number;
+            } & QueryParameters, ConfigParameters>;
+            headers?: {
+                [key: string]: string;
+            };
+        }>, rawResponse?: T): Promise<T extends true ? Response : Stores>;
+    }
+}
+declare namespace ShopperStoresModelTypes {
+    /**
+     * A specialized value indicating the system default values for locales.
+     */
+    type DefaultFallback = "default";
+    /**
+     * The unit the distance attribute is measured in (either in miles or kilometers).
+     */
+    type DistanceUnit = "km" | "mi";
+    /**
+     * @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 PaginatedResultBase: Schema defining generic pageable result. Each response schema of a resource requiring pagination should extend this schema.  If you use this extend this schema directly, it needs to be defined what data is returned. Allowed names for the data field is `data`.
+     *
+     * @property offset: The zero-based index of the first hit/data to include in the result.
+     *
+     * @property limit: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).
+     *
+     * @property total: The total number of hits that match the search\'s criteria. This can be greater than the number of results returned as search results are pagenated.
+     *
+     */
+    type PaginatedResultBase = {
+        offset: number;
+        limit: number;
+        total: number;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type ResultBase: Schema defining generic list result. Each response schema of a resource requiring a list response should extend this schema.  Additionally it needs to be defined what data is returned.
+     *
+     * @property limit: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).
+     *
+     * @property total: The total number of hits that match the search\'s criteria. This can be greater than the number of results returned as search results are pagenated.
+     *
+     */
+    type ResultBase = {
+        limit: number;
+        total: number;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type Store: Document representing a store.
+     *
+     * @property address1: The primary address of the store.
+     * - **Min Length:** 1
+     *
+     * @property address2: The secondary address of the store.
+     *
+     * @property city: The city of the store.
+     *
+     * @property countryCode: A two letter uppercase country code conforming to the [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) alpha-2 standard.
+     * - **Pattern:** /^[A-Z][A-Z]$/
+     *
+     * @property distance: The distance to the given geolocation where the stores will be searched, using the unit given in the attribute \'DistanceUnit\' (miles or kilometers).
+     *
+     * @property distanceUnit:
+     *
+     * @property email: The email address of the store.
+     *
+     * @property fax: The fax number of the store.
+     *
+     * @property id: The id of the store.
+     * - **Min Length:** 1
+     * - **Max Length:** 256
+     *
+     * @property image: The store image.
+     *
+     * @property inventoryId: The inventory list id associated with this store.
+     * - **Max Length:** 256
+     *
+     * @property latitude: The latitude of the store.
+     *
+     * @property longitude: The longitude of the store.
+     *
+     * @property name: The store name.
+     *
+     * @property phone: The phone number of the store.
+     *
+     * @property posEnabled: Whether this store uses Store Point-of-Sale.
+     *
+     * @property postalCode: The postal code of the store.
+     * - **Min Length:** 3
+     * - **Max Length:** 10
+     *
+     * @property stateCode: The state code of the store.
+     *
+     * @property storeEvents: The store events.
+     *
+     * @property storeHours: The opening hours of the store.
+     *
+     * @property storeLocatorEnabled: Whether this store should show up in store locator results.
+     *
+     */
+    type Store = {
+        address1?: string;
+        address2?: string;
+        city?: string;
+        countryCode?: string;
+        distance?: number;
+        distanceUnit?: DistanceUnit;
+        email?: string;
+        fax?: string;
+        id: string;
+        image?: string;
+        inventoryId?: string;
+        latitude?: number;
+        longitude?: number;
+        name?: string;
+        phone?: string;
+        posEnabled?: boolean;
+        postalCode?: string;
+        stateCode?: string;
+        storeEvents?: string;
+        storeHours?: string;
+        storeLocatorEnabled?: boolean;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type StoreResult: Result object containing an array of stores.
+     *
+     * @property data: The list of stores in the search result.
+     *
+     * @property limit: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).
+     *
+     * @property total: The total number of hits that match the search\'s criteria. This can be greater than the number of results returned as search results are pagenated.
+     *
+     */
+    type StoreResult = {
+        data?: Array<Store>;
+        limit: number;
+        total: number;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type Stores: Result object containing an paginated array of stores.
+     *
+     * @property data: The list of stores in the search result.
+     *
+     * @property offset: The zero-based index of the first hit/data to include in the result.
+     *
+     * @property limit: Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).
+     *
+     * @property total: The total number of hits that match the search\'s criteria. This can be greater than the number of results returned as search results are pagenated.
+     *
+     */
+    type Stores = {
+        data?: Array<Store>;
+        offset: number;
+        limit: number;
+        total: number;
+    } & {
+        [key: string]: any;
+    };
+}
+declare namespace ShopperStoresTypes {
+    type ShopperStoresPathParameters = ShopperStoresApiTypes.ShopperStoresPathParameters;
+    type ShopperStoresQueryParameters = ShopperStoresApiTypes.ShopperStoresQueryParameters;
+    type getStoresQueryParameters = ShopperStoresApiTypes.getStoresQueryParameters;
+    type getStoresPathParameters = ShopperStoresApiTypes.getStoresPathParameters;
+    type searchStoresQueryParameters = ShopperStoresApiTypes.searchStoresQueryParameters;
+    type searchStoresPathParameters = ShopperStoresApiTypes.searchStoresPathParameters;
+    type DefaultFallback = ShopperStoresModelTypes.DefaultFallback;
+    type DistanceUnit = ShopperStoresModelTypes.DistanceUnit;
+    type ErrorResponse = ShopperStoresModelTypes.ErrorResponse;
+    type LocaleCode = ShopperStoresModelTypes.LocaleCode;
+    type PaginatedResultBase = ShopperStoresModelTypes.PaginatedResultBase;
+    type ResultBase = ShopperStoresModelTypes.ResultBase;
+    type Store = ShopperStoresModelTypes.Store;
+    type StoreResult = ShopperStoresModelTypes.StoreResult;
+    type Stores = ShopperStoresModelTypes.Stores;
+}
+export { defaultBaseUri, getStoresQueryParameters, getStoresPathParameters, searchStoresQueryParameters, searchStoresPathParameters, ShopperStoresPathParameters, ShopperStoresQueryParameters, ShopperStoresParameters, ShopperStores, DefaultFallback, DistanceUnit, ErrorResponse, LocaleCode$0 as LocaleCode, PaginatedResultBase, ResultBase, Store, StoreResult, Stores, ShopperStoresTypes };