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

package/lib/shopperGiftCertificates.cjs.d.ts

@@ -0,0 +1,729 @@
+/*
+* 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/pricing/shopper-gift-certificates/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;
+}
+/**
+ * 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;
+}
+/**
+ * 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.  It will not change from occurrence to occurrence of the  problem, except for purposes of localization
+ * - **Max Length:** 256
+ *
+ * @property type: A URI reference [RFC3986] that identifies the problem type.  This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]).  When this member is not present, its value is assumed to be \"about:blank\". It accepts relative URIs; this means that they must be resolved relative to the document\'s base URI, as per [RFC3986], Section 5.
+ * - **Max Length:** 2048
+ *
+ * @property detail: A human-readable explanation specific to this occurrence of the problem.
+ *
+ * @property instance: A URI reference that identifies the specific occurrence of the problem.  It may or may not yield further information if dereferenced.  It accepts relative URIs; this means that they must be resolved relative to the document\'s base URI, as per [RFC3986], Section 5.
+ * - **Max Length:** 2048
+ *
+ */
+type ErrorResponse = {
+    title: string;
+    type: string;
+    detail: string;
+    instance?: string;
+} & {
+    [key: string]: any;
+};
+/**
+ * @type GiftCertificate: Document representing a gift certificate.
+ *
+ * @property amount: The gift certificate original amount.
+ *
+ * @property balance: The gift certificate remaining balance.
+ *
+ * @property description: The gift certificate description.
+ *
+ * @property enabled: Is the gift certificate is enabled?
+ *
+ * @property maskedGiftCertificateCode: The masked gift certificate code.
+ *
+ * @property merchantId: The merchant ID.
+ *
+ * @property message: The message.
+ *
+ * @property recipientEmail: The recipient email.
+ *
+ * @property recipientName: The recipient name.
+ *
+ * @property senderName: The sender name.
+ *
+ * @property status: The gift certificate status.
+ *
+ */
+type GiftCertificate = {
+    amount: number;
+    balance: number;
+    description?: string;
+    enabled: boolean;
+    maskedGiftCertificateCode: string;
+    merchantId: string;
+    message?: string;
+    recipientEmail: string;
+    recipientName: string;
+    senderName: string;
+    status: GiftCertificateStatusEnum;
+} & {
+    [key: string]: any;
+};
+type GiftCertificateStatusEnum = "pending" | "issued" | "partially_redeemed" | "redeemed";
+/**
+ * @type GiftCertificateRequest: Document representing a gift certificate request data.
+ *
+ * @property giftCertificateCode: The gift certificate code.
+ *
+ */
+type GiftCertificateRequest = {
+    giftCertificateCode: string;
+} & {
+    [key: string]: any;
+};
+type getGiftCertificateQueryParameters = {
+    siteId: string;
+};
+type getGiftCertificatePathParameters = {
+    organizationId: string;
+};
+/**
+ * All path parameters that are used by at least one ShopperGiftCertificates method.
+ */
+type ShopperGiftCertificatesPathParameters = Partial<getGiftCertificatePathParameters & {}>;
+/**
+ * All query parameters that are used by at least one ShopperGiftCertificates method.
+ */
+type ShopperGiftCertificatesQueryParameters = Partial<getGiftCertificateQueryParameters & {}>;
+/**
+ * All parameters that are used by ShopperGiftCertificates.
+ */
+type ShopperGiftCertificatesParameters = ShopperGiftCertificatesPathParameters & BaseUriParameters & ShopperGiftCertificatesQueryParameters;
+/**
+ * [Shopper Gift Certificates](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-gift-certificates:Summary)
+ * ==================================
+ *
+ * *# API Overview
+ 
+ Use the Shopper Gift Certificates API to obtain gift certificate details.
+ 
+ ## Authentication & Authorization
+ 
+ The Shopper Gift Certificates API requires a JSON Web Token acquired via the Shopper Customers endpoint:
+ 
+ ```
+ https://{{shortCode}}.api.commercecloud.salesforce.com/customer/shopper-customers/v1/organizations/{{organizationId}}/customers/actions/login
+ ```
+ 
+ You must include the relevant scope(s) in the client ID used to generate the SLAS token. For details, see [Authorization Scopes Catalog.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/auth-z-scope-catalog.html)
+ 
+ ## Use Cases
+ 
+ ### Retrieve Existing Gift Certificate Details
+ 
+ A shopper who received a code identifying a gift certificate can use the gift certificate code to query information, such as the status or remaining balance.
+ 
+ ### Use Hooks
+ 
+ For details working with hooks, see [Extensibility with Hooks.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/extensibility_via_hooks.html)*<br />
+ *
+ * Simple example:
+ *
+ * ```typescript
+ *   import { ShopperGiftCertificates } from "commerce-sdk-isomorphic";
+ *
+ *   const clientConfig = {
+ *     parameters: {
+ *       clientId: "XXXXXX",
+ *       organizationId: "XXXX",
+ *       shortCode: "XXX",
+ *       siteId: "XX"
+ *     }
+ *   };
+ *   const shopperGiftCertificatesClient = new ShopperGiftCertificates(clientConfig);
+ * ```
+ *
+ * <span style="font-size:.7em; display:block; text-align: right">
+ * API Version: 0.0.33<br />
+ * Last Updated: <br />
+ * </span>
+ *
+ *
+ */
+declare class ShopperGiftCertificates<ConfigParameters extends ShopperGiftCertificatesParameters & 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/pricing/shopper-gift-certificates/v1";
+    static readonly apiPaths: {
+        getGiftCertificate: string;
+    };
+    constructor(config: ClientConfigInit<ConfigParameters>);
+    static readonly paramKeys: {
+        readonly getGiftCertificate: readonly [
+            "organizationId",
+            "siteId"
+        ];
+        readonly getGiftCertificateRequired: readonly [
+            "organizationId",
+            "siteId"
+        ];
+    };
+    /**
+     *
+     *
+     * If you would like to get a raw Response object use the other getGiftCertificate 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.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 GiftCertificate.
+     */
+    getGiftCertificate(options: RequireParametersUnlessAllAreOptional<{
+        parameters?: CompositeParameters<{
+            organizationId: string;
+            siteId: string;
+        } & QueryParameters, ConfigParameters>;
+        headers?: {
+            [key: string]: string;
+        };
+        body: GiftCertificateRequest & CustomRequestBody;
+    }>): Promise<GiftCertificate>;
+    /**
+     *
+     *
+     * @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.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 GiftCertificate otherwise.
+     */
+    getGiftCertificate<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
+        parameters?: CompositeParameters<{
+            organizationId: string;
+            siteId: string;
+        } & QueryParameters, ConfigParameters>;
+        headers?: {
+            [key: string]: string;
+        };
+        body: GiftCertificateRequest & CustomRequestBody;
+    }>, rawResponse?: T): Promise<T extends true ? Response : GiftCertificate>;
+}
+declare namespace ShopperGiftCertificatesApiTypes {
+    /*
+    * 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.  It will not change from occurrence to occurrence of the  problem, except for purposes of localization
+     * - **Max Length:** 256
+     *
+     * @property type: A URI reference [RFC3986] that identifies the problem type.  This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]).  When this member is not present, its value is assumed to be \"about:blank\". It accepts relative URIs; this means that they must be resolved relative to the document\'s base URI, as per [RFC3986], Section 5.
+     * - **Max Length:** 2048
+     *
+     * @property detail: A human-readable explanation specific to this occurrence of the problem.
+     *
+     * @property instance: A URI reference that identifies the specific occurrence of the problem.  It may or may not yield further information if dereferenced.  It accepts relative URIs; this means that they must be resolved relative to the document\'s base URI, as per [RFC3986], Section 5.
+     * - **Max Length:** 2048
+     *
+     */
+    type ErrorResponse = {
+        title: string;
+        type: string;
+        detail: string;
+        instance?: string;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type GiftCertificate: Document representing a gift certificate.
+     *
+     * @property amount: The gift certificate original amount.
+     *
+     * @property balance: The gift certificate remaining balance.
+     *
+     * @property description: The gift certificate description.
+     *
+     * @property enabled: Is the gift certificate is enabled?
+     *
+     * @property maskedGiftCertificateCode: The masked gift certificate code.
+     *
+     * @property merchantId: The merchant ID.
+     *
+     * @property message: The message.
+     *
+     * @property recipientEmail: The recipient email.
+     *
+     * @property recipientName: The recipient name.
+     *
+     * @property senderName: The sender name.
+     *
+     * @property status: The gift certificate status.
+     *
+     */
+    type GiftCertificate = {
+        amount: number;
+        balance: number;
+        description?: string;
+        enabled: boolean;
+        maskedGiftCertificateCode: string;
+        merchantId: string;
+        message?: string;
+        recipientEmail: string;
+        recipientName: string;
+        senderName: string;
+        status: GiftCertificateStatusEnum;
+    } & {
+        [key: string]: any;
+    };
+    type GiftCertificateStatusEnum = "pending" | "issued" | "partially_redeemed" | "redeemed";
+    /**
+     * @type GiftCertificateRequest: Document representing a gift certificate request data.
+     *
+     * @property giftCertificateCode: The gift certificate code.
+     *
+     */
+    type GiftCertificateRequest = {
+        giftCertificateCode: string;
+    } & {
+        [key: string]: any;
+    };
+    type getGiftCertificateQueryParameters = {
+        siteId: string;
+    };
+    type getGiftCertificatePathParameters = {
+        organizationId: string;
+    };
+    /**
+     * All path parameters that are used by at least one ShopperGiftCertificates method.
+     */
+    type ShopperGiftCertificatesPathParameters = Partial<getGiftCertificatePathParameters & {}>;
+    /**
+     * All query parameters that are used by at least one ShopperGiftCertificates method.
+     */
+    type ShopperGiftCertificatesQueryParameters = Partial<getGiftCertificateQueryParameters & {}>;
+    /**
+     * All parameters that are used by ShopperGiftCertificates.
+     */
+    type ShopperGiftCertificatesParameters = ShopperGiftCertificatesPathParameters & BaseUriParameters & ShopperGiftCertificatesQueryParameters;
+    /**
+     * [Shopper Gift Certificates](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-gift-certificates:Summary)
+     * ==================================
+     *
+     * *# API Overview
+     
+     Use the Shopper Gift Certificates API to obtain gift certificate details.
+     
+     ## Authentication & Authorization
+     
+     The Shopper Gift Certificates API requires a JSON Web Token acquired via the Shopper Customers endpoint:
+     
+     ```
+     https://{{shortCode}}.api.commercecloud.salesforce.com/customer/shopper-customers/v1/organizations/{{organizationId}}/customers/actions/login
+     ```
+     
+     You must include the relevant scope(s) in the client ID used to generate the SLAS token. For details, see [Authorization Scopes Catalog.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/auth-z-scope-catalog.html)
+     
+     ## Use Cases
+     
+     ### Retrieve Existing Gift Certificate Details
+     
+     A shopper who received a code identifying a gift certificate can use the gift certificate code to query information, such as the status or remaining balance.
+     
+     ### Use Hooks
+     
+     For details working with hooks, see [Extensibility with Hooks.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/extensibility_via_hooks.html)*<br />
+     *
+     * Simple example:
+     *
+     * ```typescript
+     *   import { ShopperGiftCertificates } from "commerce-sdk-isomorphic";
+     *
+     *   const clientConfig = {
+     *     parameters: {
+     *       clientId: "XXXXXX",
+     *       organizationId: "XXXX",
+     *       shortCode: "XXX",
+     *       siteId: "XX"
+     *     }
+     *   };
+     *   const shopperGiftCertificatesClient = new ShopperGiftCertificates(clientConfig);
+     * ```
+     *
+     * <span style="font-size:.7em; display:block; text-align: right">
+     * API Version: 0.0.33<br />
+     * Last Updated: <br />
+     * </span>
+     *
+     *
+     */
+    class ShopperGiftCertificates<ConfigParameters extends ShopperGiftCertificatesParameters & 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/pricing/shopper-gift-certificates/v1";
+        static readonly apiPaths: {
+            getGiftCertificate: string;
+        };
+        constructor(config: ClientConfigInit<ConfigParameters>);
+        static readonly paramKeys: {
+            readonly getGiftCertificate: readonly [
+                "organizationId",
+                "siteId"
+            ];
+            readonly getGiftCertificateRequired: readonly [
+                "organizationId",
+                "siteId"
+            ];
+        };
+        /**
+         *
+         *
+         * If you would like to get a raw Response object use the other getGiftCertificate 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.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 GiftCertificate.
+         */
+        getGiftCertificate(options: RequireParametersUnlessAllAreOptional<{
+            parameters?: CompositeParameters<{
+                organizationId: string;
+                siteId: string;
+            } & QueryParameters, ConfigParameters>;
+            headers?: {
+                [key: string]: string;
+            };
+            body: GiftCertificateRequest & CustomRequestBody;
+        }>): Promise<GiftCertificate>;
+        /**
+         *
+         *
+         * @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.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 GiftCertificate otherwise.
+         */
+        getGiftCertificate<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
+            parameters?: CompositeParameters<{
+                organizationId: string;
+                siteId: string;
+            } & QueryParameters, ConfigParameters>;
+            headers?: {
+                [key: string]: string;
+            };
+            body: GiftCertificateRequest & CustomRequestBody;
+        }>, rawResponse?: T): Promise<T extends true ? Response : GiftCertificate>;
+    }
+}
+declare namespace ShopperGiftCertificatesModelTypes {
+    /**
+     * @type ErrorResponse:
+     *
+     * @property title: A short, human-readable summary of the problem type.  It will not change from occurrence to occurrence of the  problem, except for purposes of localization
+     * - **Max Length:** 256
+     *
+     * @property type: A URI reference [RFC3986] that identifies the problem type.  This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]).  When this member is not present, its value is assumed to be \"about:blank\". It accepts relative URIs; this means that they must be resolved relative to the document\'s base URI, as per [RFC3986], Section 5.
+     * - **Max Length:** 2048
+     *
+     * @property detail: A human-readable explanation specific to this occurrence of the problem.
+     *
+     * @property instance: A URI reference that identifies the specific occurrence of the problem.  It may or may not yield further information if dereferenced.  It accepts relative URIs; this means that they must be resolved relative to the document\'s base URI, as per [RFC3986], Section 5.
+     * - **Max Length:** 2048
+     *
+     */
+    type ErrorResponse = {
+        title: string;
+        type: string;
+        detail: string;
+        instance?: string;
+    } & {
+        [key: string]: any;
+    };
+    /**
+     * @type GiftCertificate: Document representing a gift certificate.
+     *
+     * @property amount: The gift certificate original amount.
+     *
+     * @property balance: The gift certificate remaining balance.
+     *
+     * @property description: The gift certificate description.
+     *
+     * @property enabled: Is the gift certificate is enabled?
+     *
+     * @property maskedGiftCertificateCode: The masked gift certificate code.
+     *
+     * @property merchantId: The merchant ID.
+     *
+     * @property message: The message.
+     *
+     * @property recipientEmail: The recipient email.
+     *
+     * @property recipientName: The recipient name.
+     *
+     * @property senderName: The sender name.
+     *
+     * @property status: The gift certificate status.
+     *
+     */
+    type GiftCertificate = {
+        amount: number;
+        balance: number;
+        description?: string;
+        enabled: boolean;
+        maskedGiftCertificateCode: string;
+        merchantId: string;
+        message?: string;
+        recipientEmail: string;
+        recipientName: string;
+        senderName: string;
+        status: GiftCertificateStatusEnum;
+    } & {
+        [key: string]: any;
+    };
+    type GiftCertificateStatusEnum = "pending" | "issued" | "partially_redeemed" | "redeemed";
+    /**
+     * @type GiftCertificateRequest: Document representing a gift certificate request data.
+     *
+     * @property giftCertificateCode: The gift certificate code.
+     *
+     */
+    type GiftCertificateRequest = {
+        giftCertificateCode: string;
+    } & {
+        [key: string]: any;
+    };
+}
+declare namespace ShopperGiftCertificatesTypes {
+    type ShopperGiftCertificatesPathParameters = ShopperGiftCertificatesApiTypes.ShopperGiftCertificatesPathParameters;
+    type ShopperGiftCertificatesQueryParameters = ShopperGiftCertificatesApiTypes.ShopperGiftCertificatesQueryParameters;
+    type getGiftCertificateQueryParameters = ShopperGiftCertificatesApiTypes.getGiftCertificateQueryParameters;
+    type getGiftCertificatePathParameters = ShopperGiftCertificatesApiTypes.getGiftCertificatePathParameters;
+    type ErrorResponse = ShopperGiftCertificatesModelTypes.ErrorResponse;
+    type GiftCertificate = ShopperGiftCertificatesModelTypes.GiftCertificate;
+    type GiftCertificateStatusEnum = ShopperGiftCertificatesModelTypes.GiftCertificateStatusEnum;
+    type GiftCertificateRequest = ShopperGiftCertificatesModelTypes.GiftCertificateRequest;
+}
+export { defaultBaseUri, getGiftCertificateQueryParameters, getGiftCertificatePathParameters, ShopperGiftCertificatesPathParameters, ShopperGiftCertificatesQueryParameters, ShopperGiftCertificatesParameters, ShopperGiftCertificates, ErrorResponse, GiftCertificate, GiftCertificateStatusEnum, GiftCertificateRequest, ShopperGiftCertificatesTypes };