commerce-sdk-isomorphic 4.0.0-nightly-20251021080814 → 4.0.0-nightly-20251023080805

package/lib/shopperPayments.d.ts

@@ -0,0 +1,1010 @@
+/*
+* 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/checkout/shopper-payments/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 lack of definition of a currency, for example, if the value of the monetary value of the currency is an undefined number.
+ */
+type NoValue = "N/A";
+/**
+ * @type CurrencyCode
+ * A three letter uppercase currency code conforming to the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard, or the string `N/A` indicating that a currency is not applicable.
+ */
+type CurrencyCode = NoValue | string;
+/**
+ * @type PaymentConfigurationPaymentMethodsInner:
+ *
+ * @property accountId: Associated account identifier
+ * - **Min Length:** 1
+ *
+ * @property paymentMethodType: Type of payment method
+ *
+ * @property paymentModes: Supported payment modes
+ *
+ */
+type PaymentConfigurationPaymentMethodsInner = {
+    accountId: string;
+    paymentMethodType: string;
+    paymentModes: Array<string>;
+} & {
+    [key: string]: any;
+};
+/**
+ * @type PaymentConfigurationPaymentMethodSetAccountsInnerGatewayResponsePaymentMethodsInner:
+ *
+ * @property brands: Supported card brands
+ *
+ * @property type: Payment method type
+ *
+ */
+type PaymentConfigurationPaymentMethodSetAccountsInnerGatewayResponsePaymentMethodsInner = {
+    brands?: Array<string>;
+    type?: string;
+} & {
+    [key: string]: any;
+};
+/**
+ * @type PaymentConfigurationPaymentMethodSetAccountsInnerGatewayResponse: Gateway response data (optional, can be null)
+ *
+ * @property paymentMethods: Available payment methods from gateway
+ *
+ */
+type PaymentConfigurationPaymentMethodSetAccountsInnerGatewayResponse = {
+    paymentMethods?: Array<PaymentConfigurationPaymentMethodSetAccountsInnerGatewayResponsePaymentMethodsInner>;
+} & {
+    [key: string]: any;
+};
+/**
+ * @type PaymentConfigurationPaymentMethodSetAccountsInnerConfig: Account configuration
+ *
+ * @property key: API key for the payment processor
+ * - **Max Length:** 200
+ *
+ */
+type PaymentConfigurationPaymentMethodSetAccountsInnerConfig = {
+    key?: string;
+} & {
+    [key: string]: any;
+};
+/**
+ * @type PaymentConfigurationPaymentMethodSetAccountsInner:
+ *
+ * @property accountId: Account identifier
+ * - **Min Length:** 1
+ * - **Max Length:** 100
+ *
+ * @property config:
+ *
+ * @property gatewayId: Gateway identifier
+ * - **Min Length:** 1
+ *
+ * @property gatewayResponse:
+ *
+ * @property isLive: Whether the account is in live mode
+ *
+ * @property vendor: Payment vendor name
+ *
+ */
+type PaymentConfigurationPaymentMethodSetAccountsInner = {
+    accountId: string;
+    config?: PaymentConfigurationPaymentMethodSetAccountsInnerConfig;
+    gatewayId: string;
+    gatewayResponse?: PaymentConfigurationPaymentMethodSetAccountsInnerGatewayResponse | null;
+    isLive: boolean;
+    vendor: string;
+} & {
+    [key: string]: any;
+};
+/**
+ * @type PaymentConfiguration:
+ *
+ * @property zoneId: The unique identifier for a Payments zone.
+ * - **Pattern:** /^[a-zA-Z0-9\\-_]{1,100}$/
+ * - **Min Length:** 1
+ * - **Max Length:** 100
+ *
+ * @property paymentMethodSetAccounts: List of payment method set accounts
+ *
+ * @property paymentMethods: Configured payment methods
+ *
+ * @property sdkVersion: SDK version to use
+ *
+ */
+type PaymentConfiguration = {
+    zoneId?: string | null;
+    paymentMethodSetAccounts: Array<PaymentConfigurationPaymentMethodSetAccountsInner>;
+    paymentMethods: Array<PaymentConfigurationPaymentMethodsInner>;
+    sdkVersion: string;
+} & {
+    [key: string]: any;
+};
+type getPaymentConfigurationQueryParameters = {
+    siteId: string;
+    currency: CurrencyCode;
+    countryCode: string;
+};
+type getPaymentConfigurationPathParameters = {
+    organizationId: string;
+};
+/**
+ * All path parameters that are used by at least one ShopperPayments method.
+ */
+type ShopperPaymentsPathParameters = Partial<getPaymentConfigurationPathParameters & {}>;
+/**
+ * All query parameters that are used by at least one ShopperPayments method.
+ */
+type ShopperPaymentsQueryParameters = Partial<getPaymentConfigurationQueryParameters & {}>;
+/**
+ * All parameters that are used by ShopperPayments.
+ */
+type ShopperPaymentsParameters = ShopperPaymentsPathParameters & BaseUriParameters & ShopperPaymentsQueryParameters;
+/**
+ * [Shopper Payments](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-payments:Summary)
+ * ==================================
+ *
+ * *# API Overview
+ 
+ Use the Shopper Payments API to retrieve payment configuration information for organizations in the B2C Commerce system.
+ 
+ The Shopper Payments API provides access to comprehensive payment configuration data, including payment processor settings, gateway configurations, and payment method details.
+ 
+ ## Key Features
+ 
+ The Shopper Payments API includes the following capabilities:
+ 
+ - **Payment Configuration Retrieval**: Get complete payment configuration for an organization
+ - **Payment Method Set Information**: Access details about configured payment method set accounts
+ - **Gateway Response Data**: Retrieve payment processor gateway information and supported payment methods
+ - **Payment Modes Configuration**: View supported payment modes (Multistep, Express) for each payment method
+ - **SDK Version Information**: Get the current SDK version being used
+ 
+ ## Payment Configuration Endpoint
+ 
+ The main endpoint `/organizations/{organizationId}/payment-configuration` provides:
+ 
+ ### Configuration Settings
+ - Multi-step checkout enablement status
+ - Express checkout enablement status
+ - Automatic card capture settings
+ - Zone identification
+ - Saved payment method configuration
+ - Merchant account identification
+ 
+ ### Payment Method Set Accounts
+ - Account identifiers and configurations
+ - Payment processor API keys and settings
+ - Gateway identifiers and response data
+ - Live/test mode indicators
+ - Vendor information (Stripe, Adyen, PayPal, etc.)
+ 
+ ### Payment Methods
+ - Supported payment method types (card, paypal, applepay, etc.)
+ - Available payment modes for each method
+ - Account associations
+ 
+ ## Gateway Response Handling
+ 
+ The API handles varying gateway response formats:
+ - **Active Gateways**: Return detailed payment method information including supported card brands
+ - **Inactive/Pending Gateways**: May return null gateway response data
+ - **Multiple Vendors**: Support for different payment processors with vendor-specific configurations
+ 
+ ## Authentication & Authorization
+ 
+ The client requesting payment configuration information must have access to the `/payment-configuration` resource. The Shopper Payments API requires a shopper access token from the Shopper Login and API Access Service (SLAS).
+ 
+ For details on how to request a shopper access token from SLAS, see the guest user flows for [public clients](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas-public-client.html#guest-user) and [private clients](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas-private-client.html#guest-user) in the SLAS guides.
+ 
+ You must include the relevant scope(s) in the client ID used to generate the SLAS token. For details, see the [Authorization Scopes Catalog.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/auth-z-scope-catalog.html)
+ 
+ ## Getting Started
+ 
+ To use the Shopper Payments API:
+ 
+ 1. Authenticate with the appropriate scopes (`sfcc.shopper-payments.rw`)
+ 2. Make a GET request to `/organizations/{organizationId}/payment-configuration`
+ 3. Process the returned payment configuration data for your application
+ 
+ ## Use Cases
+ 
+ ### Payment Method Discovery
+ Retrieve available payment methods and their capabilities for dynamic payment form generation.
+ 
+ ### Gateway Status Monitoring
+ Check the status and configuration of payment gateways and processors.
+ 
+ ### Payment Flow Configuration
+ Determine supported payment modes (multi-step vs express) for different payment methods.
+ 
+ ### SDK Version Management
+ Ensure compatibility by checking the current SDK version requirements.
+ 
+ For detailed implementation examples and best practices, refer to the Commerce Cloud documentation. *<br />
+ *
+ * Simple example:
+ *
+ * ```typescript
+ *   import { ShopperPayments } from "commerce-sdk-isomorphic";
+ *
+ *   const clientConfig = {
+ *     parameters: {
+ *       clientId: "XXXXXX",
+ *       organizationId: "XXXX",
+ *       shortCode: "XXX",
+ *       siteId: "XX"
+ *     }
+ *   };
+ *   const shopperPaymentsClient = new ShopperPayments(clientConfig);
+ * ```
+ *
+ * <span style="font-size:.7em; display:block; text-align: right">
+ * API Version: 0.0.33<br />
+ * Last Updated: <br />
+ * </span>
+ *
+ *
+ */
+declare class ShopperPayments<ConfigParameters extends ShopperPaymentsParameters & 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/checkout/shopper-payments/v1";
+    static readonly apiPaths: {
+        getPaymentConfiguration: string;
+    };
+    constructor(config: ClientConfigInit<ConfigParameters>);
+    static readonly paramKeys: {
+        readonly getPaymentConfiguration: readonly [
+            "organizationId",
+            "siteId",
+            "currency",
+            "countryCode"
+        ];
+        readonly getPaymentConfigurationRequired: readonly [
+            "organizationId",
+            "siteId",
+            "currency",
+            "countryCode"
+        ];
+    };
+    /**
+     * Retrieves the payment configuration for the organization.
+     
+     **Parameters:**
+     - `siteId`: Required. The site identifier for context-specific configuration
+     - `currency`: Required. Three-letter currency code (ISO 4217) for payment method configuration
+     - `countryCode`: Required. Two-letter country code (ISO 3166-1 alpha-2) for country-specific payment configuration
+     
+     **Response Behavior:**
+     - Returns payment configuration data when available
+     - Returns null values for missing data (e.g., when account not found or payments zone not found)
+     *
+     * If you would like to get a raw Response object use the other getPaymentConfiguration 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.currency - A three letter uppercase currency code conforming to the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard, or the string `N/A` indicating that a currency is not applicable.
+     * @param options.parameters.countryCode - The country code (ISO 3166-1 alpha-2) for country-specific payment configuration filtering
+     * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
+     *
+     * @returns A promise of type PaymentConfiguration.
+     */
+    getPaymentConfiguration(options?: RequireParametersUnlessAllAreOptional<{
+        parameters?: CompositeParameters<{
+            organizationId: string;
+            siteId: string;
+            currency: CurrencyCode;
+            countryCode: string;
+        } & QueryParameters, ConfigParameters>;
+        headers?: {
+            [key: string]: string;
+        };
+    }>): Promise<PaymentConfiguration>;
+    /**
+     * Retrieves the payment configuration for the organization.
+     
+     **Parameters:**
+     - `siteId`: Required. The site identifier for context-specific configuration
+     - `currency`: Required. Three-letter currency code (ISO 4217) for payment method configuration
+     - `countryCode`: Required. Two-letter country code (ISO 3166-1 alpha-2) for country-specific payment configuration
+     
+     **Response Behavior:**
+     - Returns payment configuration data when available
+     - Returns null values for missing data (e.g., when account not found or payments zone not found)
+     *
+     * @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.currency - A three letter uppercase currency code conforming to the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard, or the string `N/A` indicating that a currency is not applicable.
+     * @param options.parameters.countryCode - The country code (ISO 3166-1 alpha-2) for country-specific payment configuration filtering
+     * @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 PaymentConfiguration otherwise.
+     */
+    getPaymentConfiguration<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
+        parameters?: CompositeParameters<{
+            organizationId: string;
+            siteId: string;
+            currency: CurrencyCode;
+            countryCode: string;
+        } & QueryParameters, ConfigParameters>;
+        headers?: {
+            [key: string]: string;
+        };
+    }>, rawResponse?: T): Promise<T extends true ? Response : PaymentConfiguration>;
+}
+declare namespace ShopperPaymentsApiTypes {
+    /*
+    * 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 lack of definition of a currency, for example, if the value of the monetary value of the currency is an undefined number.
+     */
+    type NoValue = "N/A";
+    /**
+     * @type CurrencyCode
+     * A three letter uppercase currency code conforming to the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard, or the string `N/A` indicating that a currency is not applicable.
+     */
+    type CurrencyCode = NoValue | string;
+    /**
+     * @type PaymentConfigurationPaymentMethodsInner:
+     *
+     * @property accountId: Associated account identifier
+     * - **Min Length:** 1
+     *
+     * @property paymentMethodType: Type of payment method
+     *
+     * @property paymentModes: Supported payment modes
+     *
+     */
+    type PaymentConfigurationPaymentMethodsInner = {
+        accountId: string;
+        paymentMethodType: string;
+        paymentModes: Array<string>;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type PaymentConfigurationPaymentMethodSetAccountsInnerGatewayResponsePaymentMethodsInner:
+     *
+     * @property brands: Supported card brands
+     *
+     * @property type: Payment method type
+     *
+     */
+    type PaymentConfigurationPaymentMethodSetAccountsInnerGatewayResponsePaymentMethodsInner = {
+        brands?: Array<string>;
+        type?: string;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type PaymentConfigurationPaymentMethodSetAccountsInnerGatewayResponse: Gateway response data (optional, can be null)
+     *
+     * @property paymentMethods: Available payment methods from gateway
+     *
+     */
+    type PaymentConfigurationPaymentMethodSetAccountsInnerGatewayResponse = {
+        paymentMethods?: Array<PaymentConfigurationPaymentMethodSetAccountsInnerGatewayResponsePaymentMethodsInner>;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type PaymentConfigurationPaymentMethodSetAccountsInnerConfig: Account configuration
+     *
+     * @property key: API key for the payment processor
+     * - **Max Length:** 200
+     *
+     */
+    type PaymentConfigurationPaymentMethodSetAccountsInnerConfig = {
+        key?: string;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type PaymentConfigurationPaymentMethodSetAccountsInner:
+     *
+     * @property accountId: Account identifier
+     * - **Min Length:** 1
+     * - **Max Length:** 100
+     *
+     * @property config:
+     *
+     * @property gatewayId: Gateway identifier
+     * - **Min Length:** 1
+     *
+     * @property gatewayResponse:
+     *
+     * @property isLive: Whether the account is in live mode
+     *
+     * @property vendor: Payment vendor name
+     *
+     */
+    type PaymentConfigurationPaymentMethodSetAccountsInner = {
+        accountId: string;
+        config?: PaymentConfigurationPaymentMethodSetAccountsInnerConfig;
+        gatewayId: string;
+        gatewayResponse?: PaymentConfigurationPaymentMethodSetAccountsInnerGatewayResponse | null;
+        isLive: boolean;
+        vendor: string;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type PaymentConfiguration:
+     *
+     * @property zoneId: The unique identifier for a Payments zone.
+     * - **Pattern:** /^[a-zA-Z0-9\\-_]{1,100}$/
+     * - **Min Length:** 1
+     * - **Max Length:** 100
+     *
+     * @property paymentMethodSetAccounts: List of payment method set accounts
+     *
+     * @property paymentMethods: Configured payment methods
+     *
+     * @property sdkVersion: SDK version to use
+     *
+     */
+    type PaymentConfiguration = {
+        zoneId?: string | null;
+        paymentMethodSetAccounts: Array<PaymentConfigurationPaymentMethodSetAccountsInner>;
+        paymentMethods: Array<PaymentConfigurationPaymentMethodsInner>;
+        sdkVersion: string;
+    } & {
+        [key: string]: any;
+    };
+    type getPaymentConfigurationQueryParameters = {
+        siteId: string;
+        currency: CurrencyCode;
+        countryCode: string;
+    };
+    type getPaymentConfigurationPathParameters = {
+        organizationId: string;
+    };
+    /**
+     * All path parameters that are used by at least one ShopperPayments method.
+     */
+    type ShopperPaymentsPathParameters = Partial<getPaymentConfigurationPathParameters & {}>;
+    /**
+     * All query parameters that are used by at least one ShopperPayments method.
+     */
+    type ShopperPaymentsQueryParameters = Partial<getPaymentConfigurationQueryParameters & {}>;
+    /**
+     * All parameters that are used by ShopperPayments.
+     */
+    type ShopperPaymentsParameters = ShopperPaymentsPathParameters & BaseUriParameters & ShopperPaymentsQueryParameters;
+    /**
+     * [Shopper Payments](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-payments:Summary)
+     * ==================================
+     *
+     * *# API Overview
+     
+     Use the Shopper Payments API to retrieve payment configuration information for organizations in the B2C Commerce system.
+     
+     The Shopper Payments API provides access to comprehensive payment configuration data, including payment processor settings, gateway configurations, and payment method details.
+     
+     ## Key Features
+     
+     The Shopper Payments API includes the following capabilities:
+     
+     - **Payment Configuration Retrieval**: Get complete payment configuration for an organization
+     - **Payment Method Set Information**: Access details about configured payment method set accounts
+     - **Gateway Response Data**: Retrieve payment processor gateway information and supported payment methods
+     - **Payment Modes Configuration**: View supported payment modes (Multistep, Express) for each payment method
+     - **SDK Version Information**: Get the current SDK version being used
+     
+     ## Payment Configuration Endpoint
+     
+     The main endpoint `/organizations/{organizationId}/payment-configuration` provides:
+     
+     ### Configuration Settings
+     - Multi-step checkout enablement status
+     - Express checkout enablement status
+     - Automatic card capture settings
+     - Zone identification
+     - Saved payment method configuration
+     - Merchant account identification
+     
+     ### Payment Method Set Accounts
+     - Account identifiers and configurations
+     - Payment processor API keys and settings
+     - Gateway identifiers and response data
+     - Live/test mode indicators
+     - Vendor information (Stripe, Adyen, PayPal, etc.)
+     
+     ### Payment Methods
+     - Supported payment method types (card, paypal, applepay, etc.)
+     - Available payment modes for each method
+     - Account associations
+     
+     ## Gateway Response Handling
+     
+     The API handles varying gateway response formats:
+     - **Active Gateways**: Return detailed payment method information including supported card brands
+     - **Inactive/Pending Gateways**: May return null gateway response data
+     - **Multiple Vendors**: Support for different payment processors with vendor-specific configurations
+     
+     ## Authentication & Authorization
+     
+     The client requesting payment configuration information must have access to the `/payment-configuration` resource. The Shopper Payments API requires a shopper access token from the Shopper Login and API Access Service (SLAS).
+     
+     For details on how to request a shopper access token from SLAS, see the guest user flows for [public clients](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas-public-client.html#guest-user) and [private clients](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas-private-client.html#guest-user) in the SLAS guides.
+     
+     You must include the relevant scope(s) in the client ID used to generate the SLAS token. For details, see the [Authorization Scopes Catalog.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/auth-z-scope-catalog.html)
+     
+     ## Getting Started
+     
+     To use the Shopper Payments API:
+     
+     1. Authenticate with the appropriate scopes (`sfcc.shopper-payments.rw`)
+     2. Make a GET request to `/organizations/{organizationId}/payment-configuration`
+     3. Process the returned payment configuration data for your application
+     
+     ## Use Cases
+     
+     ### Payment Method Discovery
+     Retrieve available payment methods and their capabilities for dynamic payment form generation.
+     
+     ### Gateway Status Monitoring
+     Check the status and configuration of payment gateways and processors.
+     
+     ### Payment Flow Configuration
+     Determine supported payment modes (multi-step vs express) for different payment methods.
+     
+     ### SDK Version Management
+     Ensure compatibility by checking the current SDK version requirements.
+     
+     For detailed implementation examples and best practices, refer to the Commerce Cloud documentation. *<br />
+     *
+     * Simple example:
+     *
+     * ```typescript
+     *   import { ShopperPayments } from "commerce-sdk-isomorphic";
+     *
+     *   const clientConfig = {
+     *     parameters: {
+     *       clientId: "XXXXXX",
+     *       organizationId: "XXXX",
+     *       shortCode: "XXX",
+     *       siteId: "XX"
+     *     }
+     *   };
+     *   const shopperPaymentsClient = new ShopperPayments(clientConfig);
+     * ```
+     *
+     * <span style="font-size:.7em; display:block; text-align: right">
+     * API Version: 0.0.33<br />
+     * Last Updated: <br />
+     * </span>
+     *
+     *
+     */
+    class ShopperPayments<ConfigParameters extends ShopperPaymentsParameters & 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/checkout/shopper-payments/v1";
+        static readonly apiPaths: {
+            getPaymentConfiguration: string;
+        };
+        constructor(config: ClientConfigInit<ConfigParameters>);
+        static readonly paramKeys: {
+            readonly getPaymentConfiguration: readonly [
+                "organizationId",
+                "siteId",
+                "currency",
+                "countryCode"
+            ];
+            readonly getPaymentConfigurationRequired: readonly [
+                "organizationId",
+                "siteId",
+                "currency",
+                "countryCode"
+            ];
+        };
+        /**
+         * Retrieves the payment configuration for the organization.
+         
+         **Parameters:**
+         - `siteId`: Required. The site identifier for context-specific configuration
+         - `currency`: Required. Three-letter currency code (ISO 4217) for payment method configuration
+         - `countryCode`: Required. Two-letter country code (ISO 3166-1 alpha-2) for country-specific payment configuration
+         
+         **Response Behavior:**
+         - Returns payment configuration data when available
+         - Returns null values for missing data (e.g., when account not found or payments zone not found)
+         *
+         * If you would like to get a raw Response object use the other getPaymentConfiguration 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.currency - A three letter uppercase currency code conforming to the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard, or the string `N/A` indicating that a currency is not applicable.
+         * @param options.parameters.countryCode - The country code (ISO 3166-1 alpha-2) for country-specific payment configuration filtering
+         * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
+         *
+         * @returns A promise of type PaymentConfiguration.
+         */
+        getPaymentConfiguration(options?: RequireParametersUnlessAllAreOptional<{
+            parameters?: CompositeParameters<{
+                organizationId: string;
+                siteId: string;
+                currency: CurrencyCode;
+                countryCode: string;
+            } & QueryParameters, ConfigParameters>;
+            headers?: {
+                [key: string]: string;
+            };
+        }>): Promise<PaymentConfiguration>;
+        /**
+         * Retrieves the payment configuration for the organization.
+         
+         **Parameters:**
+         - `siteId`: Required. The site identifier for context-specific configuration
+         - `currency`: Required. Three-letter currency code (ISO 4217) for payment method configuration
+         - `countryCode`: Required. Two-letter country code (ISO 3166-1 alpha-2) for country-specific payment configuration
+         
+         **Response Behavior:**
+         - Returns payment configuration data when available
+         - Returns null values for missing data (e.g., when account not found or payments zone not found)
+         *
+         * @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.currency - A three letter uppercase currency code conforming to the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard, or the string `N/A` indicating that a currency is not applicable.
+         * @param options.parameters.countryCode - The country code (ISO 3166-1 alpha-2) for country-specific payment configuration filtering
+         * @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 PaymentConfiguration otherwise.
+         */
+        getPaymentConfiguration<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
+            parameters?: CompositeParameters<{
+                organizationId: string;
+                siteId: string;
+                currency: CurrencyCode;
+                countryCode: string;
+            } & QueryParameters, ConfigParameters>;
+            headers?: {
+                [key: string]: string;
+            };
+        }>, rawResponse?: T): Promise<T extends true ? Response : PaymentConfiguration>;
+    }
+}
+declare namespace ShopperPaymentsModelTypes {
+    /**
+     * A specialized value indicating the lack of definition of a currency, for example, if the value of the monetary value of the currency is an undefined number.
+     */
+    type NoValue = "N/A";
+    /**
+     * @type CurrencyCode
+     * A three letter uppercase currency code conforming to the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard, or the string `N/A` indicating that a currency is not applicable.
+     */
+    type CurrencyCode = NoValue | string;
+    /**
+     * @type PaymentConfigurationPaymentMethodsInner:
+     *
+     * @property accountId: Associated account identifier
+     * - **Min Length:** 1
+     *
+     * @property paymentMethodType: Type of payment method
+     *
+     * @property paymentModes: Supported payment modes
+     *
+     */
+    type PaymentConfigurationPaymentMethodsInner = {
+        accountId: string;
+        paymentMethodType: string;
+        paymentModes: Array<string>;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type PaymentConfigurationPaymentMethodSetAccountsInnerGatewayResponsePaymentMethodsInner:
+     *
+     * @property brands: Supported card brands
+     *
+     * @property type: Payment method type
+     *
+     */
+    type PaymentConfigurationPaymentMethodSetAccountsInnerGatewayResponsePaymentMethodsInner = {
+        brands?: Array<string>;
+        type?: string;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type PaymentConfigurationPaymentMethodSetAccountsInnerGatewayResponse: Gateway response data (optional, can be null)
+     *
+     * @property paymentMethods: Available payment methods from gateway
+     *
+     */
+    type PaymentConfigurationPaymentMethodSetAccountsInnerGatewayResponse = {
+        paymentMethods?: Array<PaymentConfigurationPaymentMethodSetAccountsInnerGatewayResponsePaymentMethodsInner>;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type PaymentConfigurationPaymentMethodSetAccountsInnerConfig: Account configuration
+     *
+     * @property key: API key for the payment processor
+     * - **Max Length:** 200
+     *
+     */
+    type PaymentConfigurationPaymentMethodSetAccountsInnerConfig = {
+        key?: string;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type PaymentConfigurationPaymentMethodSetAccountsInner:
+     *
+     * @property accountId: Account identifier
+     * - **Min Length:** 1
+     * - **Max Length:** 100
+     *
+     * @property config:
+     *
+     * @property gatewayId: Gateway identifier
+     * - **Min Length:** 1
+     *
+     * @property gatewayResponse:
+     *
+     * @property isLive: Whether the account is in live mode
+     *
+     * @property vendor: Payment vendor name
+     *
+     */
+    type PaymentConfigurationPaymentMethodSetAccountsInner = {
+        accountId: string;
+        config?: PaymentConfigurationPaymentMethodSetAccountsInnerConfig;
+        gatewayId: string;
+        gatewayResponse?: PaymentConfigurationPaymentMethodSetAccountsInnerGatewayResponse | null;
+        isLive: boolean;
+        vendor: string;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type PaymentConfiguration:
+     *
+     * @property zoneId: The unique identifier for a Payments zone.
+     * - **Pattern:** /^[a-zA-Z0-9\\-_]{1,100}$/
+     * - **Min Length:** 1
+     * - **Max Length:** 100
+     *
+     * @property paymentMethodSetAccounts: List of payment method set accounts
+     *
+     * @property paymentMethods: Configured payment methods
+     *
+     * @property sdkVersion: SDK version to use
+     *
+     */
+    type PaymentConfiguration = {
+        zoneId?: string | null;
+        paymentMethodSetAccounts: Array<PaymentConfigurationPaymentMethodSetAccountsInner>;
+        paymentMethods: Array<PaymentConfigurationPaymentMethodsInner>;
+        sdkVersion: string;
+    } & {
+        [key: string]: any;
+    };
+}
+declare namespace ShopperPaymentsTypes {
+    type ShopperPaymentsPathParameters = ShopperPaymentsApiTypes.ShopperPaymentsPathParameters;
+    type ShopperPaymentsQueryParameters = ShopperPaymentsApiTypes.ShopperPaymentsQueryParameters;
+    type getPaymentConfigurationQueryParameters = ShopperPaymentsApiTypes.getPaymentConfigurationQueryParameters;
+    type getPaymentConfigurationPathParameters = ShopperPaymentsApiTypes.getPaymentConfigurationPathParameters;
+    type CurrencyCode = ShopperPaymentsModelTypes.CurrencyCode;
+    type NoValue = ShopperPaymentsModelTypes.NoValue;
+    type PaymentConfiguration = ShopperPaymentsModelTypes.PaymentConfiguration;
+    type PaymentConfigurationPaymentMethodSetAccountsInner = ShopperPaymentsModelTypes.PaymentConfigurationPaymentMethodSetAccountsInner;
+    type PaymentConfigurationPaymentMethodSetAccountsInnerConfig = ShopperPaymentsModelTypes.PaymentConfigurationPaymentMethodSetAccountsInnerConfig;
+    type PaymentConfigurationPaymentMethodSetAccountsInnerGatewayResponse = ShopperPaymentsModelTypes.PaymentConfigurationPaymentMethodSetAccountsInnerGatewayResponse;
+    type PaymentConfigurationPaymentMethodSetAccountsInnerGatewayResponsePaymentMethodsInner = ShopperPaymentsModelTypes.PaymentConfigurationPaymentMethodSetAccountsInnerGatewayResponsePaymentMethodsInner;
+    type PaymentConfigurationPaymentMethodsInner = ShopperPaymentsModelTypes.PaymentConfigurationPaymentMethodsInner;
+}
+export { defaultBaseUri, getPaymentConfigurationQueryParameters, getPaymentConfigurationPathParameters, ShopperPaymentsPathParameters, ShopperPaymentsQueryParameters, ShopperPaymentsParameters, ShopperPayments, CurrencyCode, NoValue, PaymentConfiguration, PaymentConfigurationPaymentMethodSetAccountsInner, PaymentConfigurationPaymentMethodSetAccountsInnerConfig, PaymentConfigurationPaymentMethodSetAccountsInnerGatewayResponse, PaymentConfigurationPaymentMethodSetAccountsInnerGatewayResponsePaymentMethodsInner, PaymentConfigurationPaymentMethodsInner, ShopperPaymentsTypes };