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

package/lib/shopperConfigurations.d.ts

@@ -1,601 +0,0 @@
-/*
-* Copyright (c) 2021, salesforce.com, inc.
-* All rights reserved.
-* SPDX-License-Identifier: BSD-3-Clause
-* For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
-*/
-import { RequestInit as NodeRequestInit } from "node-fetch";
-/*
-* Copyright (c) 2025, Salesforce, Inc.
-* All rights reserved.
-* SPDX-License-Identifier: BSD-3-Clause
-* For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
-*/
-declare const defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/configuration/shopper-configurations/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 ErrorResponse:
- *
- * @property title: A short, human-readable summary of the problem type.
- * - **Max Length:** 256
- *
- * @property type: A URI reference that identifies the problem type.
- * - **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.
- * - **Max Length:** 2048
- *
- */
-type ErrorResponse = {
-    title: string;
-    type: string;
-    detail: string;
-    instance?: string;
-} & {
-    [key: string]: any;
-};
-/**
- * @type ModelConfiguration: Configuration object
- *
- * @property id: identifier
- * - **Max Length:** 255
- *
- * @property value: value for identifier
- * - **Max Length:** 255
- *
- * @property configurationType: type of configuration value
- * - **Max Length:** 255
- *
- */
-type ModelConfiguration = {
-    id: string;
-    value: any | null;
-    configurationType?: string;
-} & {
-    [key: string]: any;
-};
-/**
- * @type SiteConfiguration: Site Configuration object
- *
- * @property configurations: List configurations for the instance and site
- *
- */
-type SiteConfiguration = {
-    configurations: Array<ModelConfiguration>;
-} & {
-    [key: string]: any;
-};
-type getConfigurationsQueryParameters = {
-    siteId: string;
-};
-type getConfigurationsPathParameters = {
-    organizationId: string;
-};
-/**
- * All path parameters that are used by at least one ShopperConfigurations method.
- */
-type ShopperConfigurationsPathParameters = Partial<getConfigurationsPathParameters & {}>;
-/**
- * All query parameters that are used by at least one ShopperConfigurations method.
- */
-type ShopperConfigurationsQueryParameters = Partial<getConfigurationsQueryParameters & {}>;
-/**
- * All parameters that are used by ShopperConfigurations.
- */
-type ShopperConfigurationsParameters = ShopperConfigurationsPathParameters & BaseUriParameters & ShopperConfigurationsQueryParameters;
-/**
- * [Shopper Configurations](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-configurations:Summary)
- * ==================================
- *
- * *<shopper-configurations-description.md>*<br />
- *
- * Simple example:
- *
- * ```typescript
- *   import { ShopperConfigurations } from "commerce-sdk-isomorphic";
- *
- *   const clientConfig = {
- *     parameters: {
- *       clientId: "XXXXXX",
- *       organizationId: "XXXX",
- *       shortCode: "XXX",
- *       siteId: "XX"
- *     }
- *   };
- *   const shopperConfigurationsClient = new ShopperConfigurations(clientConfig);
- * ```
- *
- * <span style="font-size:.7em; display:block; text-align: right">
- * API Version: 0.0.33<br />
- * Last Updated: <br />
- * </span>
- *
- *
- */
-declare class ShopperConfigurations<ConfigParameters extends ShopperConfigurationsParameters & 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/configuration/shopper-configurations/v1";
-    static readonly apiPaths: {
-        getConfigurations: string;
-    };
-    constructor(config: ClientConfigInit<ConfigParameters>);
-    static readonly paramKeys: {
-        readonly getConfigurations: readonly [
-            "organizationId",
-            "siteId"
-        ];
-        readonly getConfigurationsRequired: readonly [
-            "organizationId",
-            "siteId"
-        ];
-    };
-    /**
-     * Retrieves configurations for the specified organization and site.
-     *
-     * If you would like to get a raw Response object use the other getConfigurations 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.
-     * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
-     *
-     * @returns A promise of type SiteConfiguration.
-     */
-    getConfigurations(options?: RequireParametersUnlessAllAreOptional<{
-        parameters?: CompositeParameters<{
-            organizationId: string;
-            siteId: string;
-        } & QueryParameters, ConfigParameters>;
-        headers?: {
-            [key: string]: string;
-        };
-    }>): Promise<SiteConfiguration>;
-    /**
-     * Retrieves configurations for the specified organization and site.
-     *
-     * @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.
-     * @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 SiteConfiguration otherwise.
-     */
-    getConfigurations<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
-        parameters?: CompositeParameters<{
-            organizationId: string;
-            siteId: string;
-        } & QueryParameters, ConfigParameters>;
-        headers?: {
-            [key: string]: string;
-        };
-    }>, rawResponse?: T): Promise<T extends true ? Response : SiteConfiguration>;
-}
-declare namespace ShopperConfigurationsApiTypes {
-    /*
-    * 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 ErrorResponse:
-     *
-     * @property title: A short, human-readable summary of the problem type.
-     * - **Max Length:** 256
-     *
-     * @property type: A URI reference that identifies the problem type.
-     * - **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.
-     * - **Max Length:** 2048
-     *
-     */
-    type ErrorResponse = {
-        title: string;
-        type: string;
-        detail: string;
-        instance?: string;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type ModelConfiguration: Configuration object
-     *
-     * @property id: identifier
-     * - **Max Length:** 255
-     *
-     * @property value: value for identifier
-     * - **Max Length:** 255
-     *
-     * @property configurationType: type of configuration value
-     * - **Max Length:** 255
-     *
-     */
-    type ModelConfiguration = {
-        id: string;
-        value: any | null;
-        configurationType?: string;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type SiteConfiguration: Site Configuration object
-     *
-     * @property configurations: List configurations for the instance and site
-     *
-     */
-    type SiteConfiguration = {
-        configurations: Array<ModelConfiguration>;
-    } & {
-        [key: string]: any;
-    };
-    type getConfigurationsQueryParameters = {
-        siteId: string;
-    };
-    type getConfigurationsPathParameters = {
-        organizationId: string;
-    };
-    /**
-     * All path parameters that are used by at least one ShopperConfigurations method.
-     */
-    type ShopperConfigurationsPathParameters = Partial<getConfigurationsPathParameters & {}>;
-    /**
-     * All query parameters that are used by at least one ShopperConfigurations method.
-     */
-    type ShopperConfigurationsQueryParameters = Partial<getConfigurationsQueryParameters & {}>;
-    /**
-     * All parameters that are used by ShopperConfigurations.
-     */
-    type ShopperConfigurationsParameters = ShopperConfigurationsPathParameters & BaseUriParameters & ShopperConfigurationsQueryParameters;
-    /**
-     * [Shopper Configurations](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-configurations:Summary)
-     * ==================================
-     *
-     * *<shopper-configurations-description.md>*<br />
-     *
-     * Simple example:
-     *
-     * ```typescript
-     *   import { ShopperConfigurations } from "commerce-sdk-isomorphic";
-     *
-     *   const clientConfig = {
-     *     parameters: {
-     *       clientId: "XXXXXX",
-     *       organizationId: "XXXX",
-     *       shortCode: "XXX",
-     *       siteId: "XX"
-     *     }
-     *   };
-     *   const shopperConfigurationsClient = new ShopperConfigurations(clientConfig);
-     * ```
-     *
-     * <span style="font-size:.7em; display:block; text-align: right">
-     * API Version: 0.0.33<br />
-     * Last Updated: <br />
-     * </span>
-     *
-     *
-     */
-    class ShopperConfigurations<ConfigParameters extends ShopperConfigurationsParameters & 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/configuration/shopper-configurations/v1";
-        static readonly apiPaths: {
-            getConfigurations: string;
-        };
-        constructor(config: ClientConfigInit<ConfigParameters>);
-        static readonly paramKeys: {
-            readonly getConfigurations: readonly [
-                "organizationId",
-                "siteId"
-            ];
-            readonly getConfigurationsRequired: readonly [
-                "organizationId",
-                "siteId"
-            ];
-        };
-        /**
-         * Retrieves configurations for the specified organization and site.
-         *
-         * If you would like to get a raw Response object use the other getConfigurations 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.
-         * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
-         *
-         * @returns A promise of type SiteConfiguration.
-         */
-        getConfigurations(options?: RequireParametersUnlessAllAreOptional<{
-            parameters?: CompositeParameters<{
-                organizationId: string;
-                siteId: string;
-            } & QueryParameters, ConfigParameters>;
-            headers?: {
-                [key: string]: string;
-            };
-        }>): Promise<SiteConfiguration>;
-        /**
-         * Retrieves configurations for the specified organization and site.
-         *
-         * @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.
-         * @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 SiteConfiguration otherwise.
-         */
-        getConfigurations<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
-            parameters?: CompositeParameters<{
-                organizationId: string;
-                siteId: string;
-            } & QueryParameters, ConfigParameters>;
-            headers?: {
-                [key: string]: string;
-            };
-        }>, rawResponse?: T): Promise<T extends true ? Response : SiteConfiguration>;
-    }
-}
-declare namespace ShopperConfigurationsModelTypes {
-    /**
-     * @type ErrorResponse:
-     *
-     * @property title: A short, human-readable summary of the problem type.
-     * - **Max Length:** 256
-     *
-     * @property type: A URI reference that identifies the problem type.
-     * - **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.
-     * - **Max Length:** 2048
-     *
-     */
-    type ErrorResponse = {
-        title: string;
-        type: string;
-        detail: string;
-        instance?: string;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type ModelConfiguration: Configuration object
-     *
-     * @property id: identifier
-     * - **Max Length:** 255
-     *
-     * @property value: value for identifier
-     * - **Max Length:** 255
-     *
-     * @property configurationType: type of configuration value
-     * - **Max Length:** 255
-     *
-     */
-    type ModelConfiguration = {
-        id: string;
-        value: any | null;
-        configurationType?: string;
-    } & {
-        [key: string]: any;
-    };
-    /**
-     * @type SiteConfiguration: Site Configuration object
-     *
-     * @property configurations: List configurations for the instance and site
-     *
-     */
-    type SiteConfiguration = {
-        configurations: Array<ModelConfiguration>;
-    } & {
-        [key: string]: any;
-    };
-}
-declare namespace ShopperConfigurationsTypes {
-    type ShopperConfigurationsPathParameters = ShopperConfigurationsApiTypes.ShopperConfigurationsPathParameters;
-    type ShopperConfigurationsQueryParameters = ShopperConfigurationsApiTypes.ShopperConfigurationsQueryParameters;
-    type getConfigurationsQueryParameters = ShopperConfigurationsApiTypes.getConfigurationsQueryParameters;
-    type getConfigurationsPathParameters = ShopperConfigurationsApiTypes.getConfigurationsPathParameters;
-    type ErrorResponse = ShopperConfigurationsModelTypes.ErrorResponse;
-    type ModelConfiguration = ShopperConfigurationsModelTypes.ModelConfiguration;
-    type SiteConfiguration = ShopperConfigurationsModelTypes.SiteConfiguration;
-}
-export { defaultBaseUri, getConfigurationsQueryParameters, getConfigurationsPathParameters, ShopperConfigurationsPathParameters, ShopperConfigurationsQueryParameters, ShopperConfigurationsParameters, ShopperConfigurations, ErrorResponse, ModelConfiguration, SiteConfiguration, ShopperConfigurationsTypes };