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

package/lib/index.esm.d.ts

@@ -20570,6 +20570,490 @@ declare namespace ShopperBasketsV2Types {
     type TaxItems = ShopperBasketsV2ModelTypes.TaxItems;
     type Taxes = ShopperBasketsV2ModelTypes.Taxes;
 }
+/**
+ * @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 {
+    // API types
+    type ShopperConfigurationsPathParameters = ShopperConfigurationsApiTypes.ShopperConfigurationsPathParameters;
+    type ShopperConfigurationsQueryParameters = ShopperConfigurationsApiTypes.ShopperConfigurationsQueryParameters;
+    type getConfigurationsQueryParameters = ShopperConfigurationsApiTypes.getConfigurationsQueryParameters;
+    type getConfigurationsPathParameters = ShopperConfigurationsApiTypes.getConfigurationsPathParameters;
+    // Model types
+    type ErrorResponse = ShopperConfigurationsModelTypes.ErrorResponse;
+    type ModelConfiguration = ShopperConfigurationsModelTypes.ModelConfiguration;
+    type SiteConfiguration = ShopperConfigurationsModelTypes.SiteConfiguration;
+}
 /**
  * The consent status of the subscription as supplied or recorded by this system
  */
@@ -24883,6 +25367,34 @@ type CustomerPaymentInstrumentRequest = {
 } & {
     [key: string]: any;
 };
+/**
+ * @type CustomerPaymentInstrumentUpdateRequestPaymentCard: The payment card expiration information.
+ *
+ * @property expirationMonth: The month when the payment card expires.
+ *
+ * @property expirationYear: The year when the payment card expires.
+ *
+ */
+type CustomerPaymentInstrumentUpdateRequestPaymentCard = {
+    expirationMonth?: number;
+    expirationYear?: number;
+} & {
+    [key: string]: any;
+};
+/**
+ * @type CustomerPaymentInstrumentUpdateRequest: Document representing a customer payment instrument update request. Only allows updating the default flag and card expiration date.
+ *
+ * @property default: The default payment instrument.
+ *
+ * @property paymentCard:
+ *
+ */
+type CustomerPaymentInstrumentUpdateRequest = {
+    default?: boolean;
+    paymentCard?: CustomerPaymentInstrumentUpdateRequestPaymentCard;
+} & {
+    [key: string]: any;
+};
 /**
  * @type ProductListEvent: Document representing a product list event.
  *
@@ -25471,6 +25983,14 @@ type updateCustomerPasswordPathParameters = {
     customerId: string;
     organizationId: string;
 };
+type updateCustomerPaymentInstrumentQueryParameters = {
+    siteId: string;
+};
+type updateCustomerPaymentInstrumentPathParameters = {
+    paymentInstrumentId: string;
+    customerId: string;
+    organizationId: string;
+};
 type updateCustomerProductListQueryParameters = {
     siteId: string;
 };
@@ -25491,11 +26011,11 @@ type updateCustomerProductListItemPathParameters = {
 /**
  * All path parameters that are used by at least one ShopperCustomers method.
  */
-type ShopperCustomersPathParameters = Partial<createCustomerAddressPathParameters & createCustomerPaymentInstrumentPathParameters & createCustomerProductListPathParameters & createCustomerProductListItemPathParameters & deleteCustomerPaymentInstrumentPathParameters & deleteCustomerProductListPathParameters & deleteCustomerProductListItemPathParameters & getCustomerPathParameters & getCustomerAddressPathParameters & getCustomerBasketsPathParameters & getCustomerOrdersPathParameters & getCustomerPaymentInstrumentPathParameters & getCustomerProductListPathParameters & getCustomerProductListItemPathParameters & getCustomerProductListsPathParameters & getExternalProfilePathParameters & getProductListItemPathParameters & getPublicProductListPathParameters & getPublicProductListsBySearchTermPathParameters & getResetPasswordTokenPathParameters & registerCustomerPathParameters & registerExternalProfilePathParameters & removeCustomerAddressPathParameters & resetPasswordPathParameters & updateCustomerPathParameters & updateCustomerAddressPathParameters & updateCustomerPasswordPathParameters & updateCustomerProductListPathParameters & updateCustomerProductListItemPathParameters & {}>;
+type ShopperCustomersPathParameters = Partial<createCustomerAddressPathParameters & createCustomerPaymentInstrumentPathParameters & createCustomerProductListPathParameters & createCustomerProductListItemPathParameters & deleteCustomerPaymentInstrumentPathParameters & deleteCustomerProductListPathParameters & deleteCustomerProductListItemPathParameters & getCustomerPathParameters & getCustomerAddressPathParameters & getCustomerBasketsPathParameters & getCustomerOrdersPathParameters & getCustomerPaymentInstrumentPathParameters & getCustomerProductListPathParameters & getCustomerProductListItemPathParameters & getCustomerProductListsPathParameters & getExternalProfilePathParameters & getProductListItemPathParameters & getPublicProductListPathParameters & getPublicProductListsBySearchTermPathParameters & getResetPasswordTokenPathParameters & registerCustomerPathParameters & registerExternalProfilePathParameters & removeCustomerAddressPathParameters & resetPasswordPathParameters & updateCustomerPathParameters & updateCustomerAddressPathParameters & updateCustomerPasswordPathParameters & updateCustomerPaymentInstrumentPathParameters & updateCustomerProductListPathParameters & updateCustomerProductListItemPathParameters & {}>;
 /**
  * All query parameters that are used by at least one ShopperCustomers method.
  */
-type ShopperCustomersQueryParameters = Partial<createCustomerAddressQueryParameters & createCustomerPaymentInstrumentQueryParameters & createCustomerProductListQueryParameters & createCustomerProductListItemQueryParameters & deleteCustomerPaymentInstrumentQueryParameters & deleteCustomerProductListQueryParameters & deleteCustomerProductListItemQueryParameters & getCustomerQueryParameters & getCustomerAddressQueryParameters & getCustomerBasketsQueryParameters & getCustomerOrdersQueryParameters & getCustomerPaymentInstrumentQueryParameters & getCustomerProductListQueryParameters & getCustomerProductListItemQueryParameters & getCustomerProductListsQueryParameters & getExternalProfileQueryParameters & getProductListItemQueryParameters & getPublicProductListQueryParameters & getPublicProductListsBySearchTermQueryParameters & getResetPasswordTokenQueryParameters & registerCustomerQueryParameters & registerExternalProfileQueryParameters & removeCustomerAddressQueryParameters & resetPasswordQueryParameters & updateCustomerQueryParameters & updateCustomerAddressQueryParameters & updateCustomerPasswordQueryParameters & updateCustomerProductListQueryParameters & updateCustomerProductListItemQueryParameters & {}>;
+type ShopperCustomersQueryParameters = Partial<createCustomerAddressQueryParameters & createCustomerPaymentInstrumentQueryParameters & createCustomerProductListQueryParameters & createCustomerProductListItemQueryParameters & deleteCustomerPaymentInstrumentQueryParameters & deleteCustomerProductListQueryParameters & deleteCustomerProductListItemQueryParameters & getCustomerQueryParameters & getCustomerAddressQueryParameters & getCustomerBasketsQueryParameters & getCustomerOrdersQueryParameters & getCustomerPaymentInstrumentQueryParameters & getCustomerProductListQueryParameters & getCustomerProductListItemQueryParameters & getCustomerProductListsQueryParameters & getExternalProfileQueryParameters & getProductListItemQueryParameters & getPublicProductListQueryParameters & getPublicProductListsBySearchTermQueryParameters & getResetPasswordTokenQueryParameters & registerCustomerQueryParameters & registerExternalProfileQueryParameters & removeCustomerAddressQueryParameters & resetPasswordQueryParameters & updateCustomerQueryParameters & updateCustomerAddressQueryParameters & updateCustomerPasswordQueryParameters & updateCustomerPaymentInstrumentQueryParameters & updateCustomerProductListQueryParameters & updateCustomerProductListItemQueryParameters & {}>;
 /**
  * All parameters that are used by ShopperCustomers.
  */
@@ -25615,6 +26135,7 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
         updateCustomer: string;
         updateCustomerAddress: string;
         updateCustomerPassword: string;
+        updateCustomerPaymentInstrument: string;
         updateCustomerProductList: string;
         updateCustomerProductListItem: string;
     };
@@ -25917,6 +26438,18 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
             "organizationId",
             "siteId"
         ];
+        readonly updateCustomerPaymentInstrument: readonly [
+            "paymentInstrumentId",
+            "customerId",
+            "organizationId",
+            "siteId"
+        ];
+        readonly updateCustomerPaymentInstrumentRequired: readonly [
+            "paymentInstrumentId",
+            "customerId",
+            "organizationId",
+            "siteId"
+        ];
         readonly updateCustomerProductList: readonly [
             "listId",
             "customerId",
@@ -27351,6 +27884,61 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
         };
         body: PasswordChangeRequest & CustomRequestBody;
     }>, rawResponse?: T): Promise<T extends true ? Response : void>;
+    /**
+     *
+     *
+     * If you would like to get a raw Response object use the other updateCustomerPaymentInstrument 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.paymentInstrumentId - The ID of the payment instrument to be retrievedCustomer.
+     * @param options.parameters.customerId - The customer ID.
+     * @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.headers - An object literal of key value pairs of the headers to be sent with this request.
+     * @param options.body - The data to send as the request body.
+     *
+     * @returns A promise of type CustomerPaymentInstrument.
+     */
+    updateCustomerPaymentInstrument(options: RequireParametersUnlessAllAreOptional<{
+        parameters?: CompositeParameters<{
+            paymentInstrumentId: string;
+            customerId: string;
+            organizationId: string;
+            siteId: string;
+        } & QueryParameters, ConfigParameters>;
+        headers?: {
+            [key: string]: string;
+        };
+        body: CustomerPaymentInstrumentUpdateRequest & CustomRequestBody;
+    }>): Promise<CustomerPaymentInstrument>;
+    /**
+     *
+     *
+     * @param options - An object containing the options for this method.
+     * @param options.parameters - An object containing the parameters for this method.
+     * @param options.parameters.paymentInstrumentId - The ID of the payment instrument to be retrievedCustomer.
+     * @param options.parameters.customerId - The customer ID.
+     * @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.headers - An object literal of key value pairs of the headers to be sent with this request.
+     * @param options.body - The data to send as the request body.
+     * @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 CustomerPaymentInstrument otherwise.
+     */
+    updateCustomerPaymentInstrument<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
+        parameters?: CompositeParameters<{
+            paymentInstrumentId: string;
+            customerId: string;
+            organizationId: string;
+            siteId: string;
+        } & QueryParameters, ConfigParameters>;
+        headers?: {
+            [key: string]: string;
+        };
+        body: CustomerPaymentInstrumentUpdateRequest & CustomRequestBody;
+    }>, rawResponse?: T): Promise<T extends true ? Response : CustomerPaymentInstrument>;
     /**
      *
      *
@@ -29615,6 +30203,34 @@ declare namespace ShopperCustomersApiTypes {
     } & {
         [key: string]: any;
     };
+    /**
+     * @type CustomerPaymentInstrumentUpdateRequestPaymentCard: The payment card expiration information.
+     *
+     * @property expirationMonth: The month when the payment card expires.
+     *
+     * @property expirationYear: The year when the payment card expires.
+     *
+     */
+    type CustomerPaymentInstrumentUpdateRequestPaymentCard = {
+        expirationMonth?: number;
+        expirationYear?: number;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type CustomerPaymentInstrumentUpdateRequest: Document representing a customer payment instrument update request. Only allows updating the default flag and card expiration date.
+     *
+     * @property default: The default payment instrument.
+     *
+     * @property paymentCard:
+     *
+     */
+    type CustomerPaymentInstrumentUpdateRequest = {
+        default?: boolean;
+        paymentCard?: CustomerPaymentInstrumentUpdateRequestPaymentCard;
+    } & {
+        [key: string]: any;
+    };
     /**
      * @type ProductListEvent: Document representing a product list event.
      *
@@ -30257,6 +30873,14 @@ declare namespace ShopperCustomersApiTypes {
         customerId: string;
         organizationId: string;
     };
+    type updateCustomerPaymentInstrumentQueryParameters = {
+        siteId: string;
+    };
+    type updateCustomerPaymentInstrumentPathParameters = {
+        paymentInstrumentId: string;
+        customerId: string;
+        organizationId: string;
+    };
     type updateCustomerProductListQueryParameters = {
         siteId: string;
     };
@@ -30277,11 +30901,11 @@ declare namespace ShopperCustomersApiTypes {
     /**
      * All path parameters that are used by at least one ShopperCustomers method.
      */
-    type ShopperCustomersPathParameters = Partial<createCustomerAddressPathParameters & createCustomerPaymentInstrumentPathParameters & createCustomerProductListPathParameters & createCustomerProductListItemPathParameters & deleteCustomerPaymentInstrumentPathParameters & deleteCustomerProductListPathParameters & deleteCustomerProductListItemPathParameters & getCustomerPathParameters & getCustomerAddressPathParameters & getCustomerBasketsPathParameters & getCustomerOrdersPathParameters & getCustomerPaymentInstrumentPathParameters & getCustomerProductListPathParameters & getCustomerProductListItemPathParameters & getCustomerProductListsPathParameters & getExternalProfilePathParameters & getProductListItemPathParameters & getPublicProductListPathParameters & getPublicProductListsBySearchTermPathParameters & getResetPasswordTokenPathParameters & registerCustomerPathParameters & registerExternalProfilePathParameters & removeCustomerAddressPathParameters & resetPasswordPathParameters & updateCustomerPathParameters & updateCustomerAddressPathParameters & updateCustomerPasswordPathParameters & updateCustomerProductListPathParameters & updateCustomerProductListItemPathParameters & {}>;
+    type ShopperCustomersPathParameters = Partial<createCustomerAddressPathParameters & createCustomerPaymentInstrumentPathParameters & createCustomerProductListPathParameters & createCustomerProductListItemPathParameters & deleteCustomerPaymentInstrumentPathParameters & deleteCustomerProductListPathParameters & deleteCustomerProductListItemPathParameters & getCustomerPathParameters & getCustomerAddressPathParameters & getCustomerBasketsPathParameters & getCustomerOrdersPathParameters & getCustomerPaymentInstrumentPathParameters & getCustomerProductListPathParameters & getCustomerProductListItemPathParameters & getCustomerProductListsPathParameters & getExternalProfilePathParameters & getProductListItemPathParameters & getPublicProductListPathParameters & getPublicProductListsBySearchTermPathParameters & getResetPasswordTokenPathParameters & registerCustomerPathParameters & registerExternalProfilePathParameters & removeCustomerAddressPathParameters & resetPasswordPathParameters & updateCustomerPathParameters & updateCustomerAddressPathParameters & updateCustomerPasswordPathParameters & updateCustomerPaymentInstrumentPathParameters & updateCustomerProductListPathParameters & updateCustomerProductListItemPathParameters & {}>;
     /**
      * All query parameters that are used by at least one ShopperCustomers method.
      */
-    type ShopperCustomersQueryParameters = Partial<createCustomerAddressQueryParameters & createCustomerPaymentInstrumentQueryParameters & createCustomerProductListQueryParameters & createCustomerProductListItemQueryParameters & deleteCustomerPaymentInstrumentQueryParameters & deleteCustomerProductListQueryParameters & deleteCustomerProductListItemQueryParameters & getCustomerQueryParameters & getCustomerAddressQueryParameters & getCustomerBasketsQueryParameters & getCustomerOrdersQueryParameters & getCustomerPaymentInstrumentQueryParameters & getCustomerProductListQueryParameters & getCustomerProductListItemQueryParameters & getCustomerProductListsQueryParameters & getExternalProfileQueryParameters & getProductListItemQueryParameters & getPublicProductListQueryParameters & getPublicProductListsBySearchTermQueryParameters & getResetPasswordTokenQueryParameters & registerCustomerQueryParameters & registerExternalProfileQueryParameters & removeCustomerAddressQueryParameters & resetPasswordQueryParameters & updateCustomerQueryParameters & updateCustomerAddressQueryParameters & updateCustomerPasswordQueryParameters & updateCustomerProductListQueryParameters & updateCustomerProductListItemQueryParameters & {}>;
+    type ShopperCustomersQueryParameters = Partial<createCustomerAddressQueryParameters & createCustomerPaymentInstrumentQueryParameters & createCustomerProductListQueryParameters & createCustomerProductListItemQueryParameters & deleteCustomerPaymentInstrumentQueryParameters & deleteCustomerProductListQueryParameters & deleteCustomerProductListItemQueryParameters & getCustomerQueryParameters & getCustomerAddressQueryParameters & getCustomerBasketsQueryParameters & getCustomerOrdersQueryParameters & getCustomerPaymentInstrumentQueryParameters & getCustomerProductListQueryParameters & getCustomerProductListItemQueryParameters & getCustomerProductListsQueryParameters & getExternalProfileQueryParameters & getProductListItemQueryParameters & getPublicProductListQueryParameters & getPublicProductListsBySearchTermQueryParameters & getResetPasswordTokenQueryParameters & registerCustomerQueryParameters & registerExternalProfileQueryParameters & removeCustomerAddressQueryParameters & resetPasswordQueryParameters & updateCustomerQueryParameters & updateCustomerAddressQueryParameters & updateCustomerPasswordQueryParameters & updateCustomerPaymentInstrumentQueryParameters & updateCustomerProductListQueryParameters & updateCustomerProductListItemQueryParameters & {}>;
     /**
      * All parameters that are used by ShopperCustomers.
      */
@@ -30401,6 +31025,7 @@ declare namespace ShopperCustomersApiTypes {
             updateCustomer: string;
             updateCustomerAddress: string;
             updateCustomerPassword: string;
+            updateCustomerPaymentInstrument: string;
             updateCustomerProductList: string;
             updateCustomerProductListItem: string;
         };
@@ -30703,6 +31328,18 @@ declare namespace ShopperCustomersApiTypes {
                 "organizationId",
                 "siteId"
             ];
+            readonly updateCustomerPaymentInstrument: readonly [
+                "paymentInstrumentId",
+                "customerId",
+                "organizationId",
+                "siteId"
+            ];
+            readonly updateCustomerPaymentInstrumentRequired: readonly [
+                "paymentInstrumentId",
+                "customerId",
+                "organizationId",
+                "siteId"
+            ];
             readonly updateCustomerProductList: readonly [
                 "listId",
                 "customerId",
@@ -32137,6 +32774,61 @@ declare namespace ShopperCustomersApiTypes {
             };
             body: PasswordChangeRequest & CustomRequestBody;
         }>, rawResponse?: T): Promise<T extends true ? Response : void>;
+        /**
+         *
+         *
+         * If you would like to get a raw Response object use the other updateCustomerPaymentInstrument 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.paymentInstrumentId - The ID of the payment instrument to be retrievedCustomer.
+         * @param options.parameters.customerId - The customer ID.
+         * @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.headers - An object literal of key value pairs of the headers to be sent with this request.
+         * @param options.body - The data to send as the request body.
+         *
+         * @returns A promise of type CustomerPaymentInstrument.
+         */
+        updateCustomerPaymentInstrument(options: RequireParametersUnlessAllAreOptional<{
+            parameters?: CompositeParameters<{
+                paymentInstrumentId: string;
+                customerId: string;
+                organizationId: string;
+                siteId: string;
+            } & QueryParameters, ConfigParameters>;
+            headers?: {
+                [key: string]: string;
+            };
+            body: CustomerPaymentInstrumentUpdateRequest & CustomRequestBody;
+        }>): Promise<CustomerPaymentInstrument>;
+        /**
+         *
+         *
+         * @param options - An object containing the options for this method.
+         * @param options.parameters - An object containing the parameters for this method.
+         * @param options.parameters.paymentInstrumentId - The ID of the payment instrument to be retrievedCustomer.
+         * @param options.parameters.customerId - The customer ID.
+         * @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.headers - An object literal of key value pairs of the headers to be sent with this request.
+         * @param options.body - The data to send as the request body.
+         * @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 CustomerPaymentInstrument otherwise.
+         */
+        updateCustomerPaymentInstrument<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
+            parameters?: CompositeParameters<{
+                paymentInstrumentId: string;
+                customerId: string;
+                organizationId: string;
+                siteId: string;
+            } & QueryParameters, ConfigParameters>;
+            headers?: {
+                [key: string]: string;
+            };
+            body: CustomerPaymentInstrumentUpdateRequest & CustomRequestBody;
+        }>, rawResponse?: T): Promise<T extends true ? Response : CustomerPaymentInstrument>;
         /**
          *
          *
@@ -34294,6 +34986,34 @@ declare namespace ShopperCustomersModelTypes {
     } & {
         [key: string]: any;
     };
+    /**
+     * @type CustomerPaymentInstrumentUpdateRequestPaymentCard: The payment card expiration information.
+     *
+     * @property expirationMonth: The month when the payment card expires.
+     *
+     * @property expirationYear: The year when the payment card expires.
+     *
+     */
+    type CustomerPaymentInstrumentUpdateRequestPaymentCard = {
+        expirationMonth?: number;
+        expirationYear?: number;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type CustomerPaymentInstrumentUpdateRequest: Document representing a customer payment instrument update request. Only allows updating the default flag and card expiration date.
+     *
+     * @property default: The default payment instrument.
+     *
+     * @property paymentCard:
+     *
+     */
+    type CustomerPaymentInstrumentUpdateRequest = {
+        default?: boolean;
+        paymentCard?: CustomerPaymentInstrumentUpdateRequestPaymentCard;
+    } & {
+        [key: string]: any;
+    };
     /**
      * @type ProductListEvent: Document representing a product list event.
      *
@@ -34788,6 +35508,8 @@ declare namespace ShopperCustomersTypes {
     type updateCustomerAddressPathParameters = ShopperCustomersApiTypes.updateCustomerAddressPathParameters;
     type updateCustomerPasswordQueryParameters = ShopperCustomersApiTypes.updateCustomerPasswordQueryParameters;
     type updateCustomerPasswordPathParameters = ShopperCustomersApiTypes.updateCustomerPasswordPathParameters;
+    type updateCustomerPaymentInstrumentQueryParameters = ShopperCustomersApiTypes.updateCustomerPaymentInstrumentQueryParameters;
+    type updateCustomerPaymentInstrumentPathParameters = ShopperCustomersApiTypes.updateCustomerPaymentInstrumentPathParameters;
     type updateCustomerProductListQueryParameters = ShopperCustomersApiTypes.updateCustomerProductListQueryParameters;
     type updateCustomerProductListPathParameters = ShopperCustomersApiTypes.updateCustomerProductListPathParameters;
     type updateCustomerProductListItemQueryParameters = ShopperCustomersApiTypes.updateCustomerProductListItemQueryParameters;
@@ -34813,6 +35535,8 @@ declare namespace ShopperCustomersTypes {
     type CustomerPaymentCardRequest = ShopperCustomersModelTypes.CustomerPaymentCardRequest;
     type CustomerPaymentInstrument = ShopperCustomersModelTypes.CustomerPaymentInstrument;
     type CustomerPaymentInstrumentRequest = ShopperCustomersModelTypes.CustomerPaymentInstrumentRequest;
+    type CustomerPaymentInstrumentUpdateRequest = ShopperCustomersModelTypes.CustomerPaymentInstrumentUpdateRequest;
+    type CustomerPaymentInstrumentUpdateRequestPaymentCard = ShopperCustomersModelTypes.CustomerPaymentInstrumentUpdateRequestPaymentCard;
     type CustomerProductList = ShopperCustomersModelTypes.CustomerProductList;
     type CustomerProductListTypeEnum = ShopperCustomersModelTypes.CustomerProductListTypeEnum;
     type CustomerProductListItem = ShopperCustomersModelTypes.CustomerProductListItem;
@@ -54886,6 +55610,7 @@ declare namespace helpers {
     const isNode: boolean;
     const globalObject: typeof globalThis;
     const hasFetchAvailable: boolean;
+    // TODO: Remove this function in the next major version
     // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
     const fetch: FetchFunction;
     /**
@@ -57011,5 +57736,22 @@ declare namespace helpers {
      */
     const encodeSCAPISpecialCharacters: (str: string) => string;
 }
-export { ShopperBaskets, ShopperBasketsV2, ShopperConsents, ShopperContexts, ShopperCustomers, ShopperExperience, ShopperGiftCertificates, ShopperLogin, ShopperOrders, ShopperProducts, ShopperPromotions, ShopperSearch, ShopperSEO, ShopperStores, ClientConfig, TemplateURL, helpers };
-export type { ShopperBasketsTypes, ShopperBasketsV2Types, ShopperConsentsTypes, ShopperContextsTypes, ShopperCustomersTypes, ShopperExperienceTypes, ShopperGiftCertificatesTypes, ShopperLoginTypes, ShopperOrdersTypes, ShopperProductsTypes, ShopperPromotionsTypes, ShopperSearchTypes, ShopperSEOTypes, ShopperStoresTypes, ClientConfigInit, FetchFunction, FetchOptions };
+declare const pkg: {
+    ShopperBaskets: typeof ShopperBaskets;
+    ShopperBasketsV2: typeof ShopperBasketsV2;
+    ShopperConfigurations: typeof ShopperConfigurations;
+    ShopperConsents: typeof ShopperConsents;
+    ShopperContexts: typeof ShopperContexts;
+    ShopperCustomers: typeof ShopperCustomers;
+    ShopperExperience: typeof ShopperExperience;
+    ShopperGiftCertificates: typeof ShopperGiftCertificates;
+    ShopperLogin: typeof ShopperLogin;
+    ShopperOrders: typeof ShopperOrders;
+    ShopperProducts: typeof ShopperProducts;
+    ShopperPromotions: typeof ShopperPromotions;
+    ShopperSearch: typeof ShopperSearch;
+    ShopperSEO: typeof ShopperSEO;
+    ShopperStores: typeof ShopperStores;
+};
+export { pkg as default, ShopperBaskets, ShopperBasketsV2, ShopperConfigurations, ShopperConsents, ShopperContexts, ShopperCustomers, ShopperExperience, ShopperGiftCertificates, ShopperLogin, ShopperOrders, ShopperProducts, ShopperPromotions, ShopperSearch, ShopperSEO, ShopperStores, ClientConfig, TemplateURL, helpers };
+export type { ShopperBasketsTypes, ShopperBasketsV2Types, ShopperConfigurationsTypes, ShopperConsentsTypes, ShopperContextsTypes, ShopperCustomersTypes, ShopperExperienceTypes, ShopperGiftCertificatesTypes, ShopperLoginTypes, ShopperOrdersTypes, ShopperProductsTypes, ShopperPromotionsTypes, ShopperSearchTypes, ShopperSEOTypes, ShopperStoresTypes, ClientConfigInit, FetchFunction, FetchOptions };