@vandenberghinc/volt 1.1.2

package/frontend/dist/modules/paddle.d.ts

@@ -0,0 +1,1403 @@
+declare const Payments: {
+    client_key: string;
+    sandbox: boolean;
+    tax_inclusive: boolean;
+    countries: {
+        AD: {
+            name: string;
+            calling_code: string;
+        };
+        AE: {
+            name: string;
+            calling_code: string;
+        };
+        AF: {
+            name: string;
+            calling_code: string;
+        };
+        AG: {
+            name: string;
+            calling_code: string;
+        };
+        AI: {
+            name: string;
+            calling_code: string;
+        };
+        AL: {
+            name: string;
+            calling_code: string;
+        };
+        AM: {
+            name: string;
+            calling_code: string;
+        };
+        AO: {
+            name: string;
+            calling_code: string;
+        };
+        AQ: {
+            name: string;
+            calling_code: string;
+        };
+        AR: {
+            name: string;
+            calling_code: string;
+        };
+        AS: {
+            name: string;
+            calling_code: string;
+        };
+        AT: {
+            name: string;
+            calling_code: string;
+        };
+        AU: {
+            name: string;
+            calling_code: string;
+        };
+        AW: {
+            name: string;
+            calling_code: string;
+        };
+        AX: {
+            name: string;
+            calling_code: string;
+        };
+        AZ: {
+            name: string;
+            calling_code: string;
+        };
+        BA: {
+            name: string;
+            calling_code: string;
+        };
+        BB: {
+            name: string;
+            calling_code: string;
+        };
+        BD: {
+            name: string;
+            calling_code: string;
+        };
+        BE: {
+            name: string;
+            calling_code: string;
+        };
+        BF: {
+            name: string;
+            calling_code: string;
+        };
+        BG: {
+            name: string;
+            calling_code: string;
+        };
+        BH: {
+            name: string;
+            calling_code: string;
+        };
+        BI: {
+            name: string;
+            calling_code: string;
+        };
+        BJ: {
+            name: string;
+            calling_code: string;
+        };
+        BL: {
+            name: string;
+            calling_code: string;
+        };
+        BM: {
+            name: string;
+            calling_code: string;
+        };
+        BN: {
+            name: string;
+            calling_code: string;
+        };
+        BO: {
+            name: string;
+            calling_code: string;
+        };
+        BQ: {
+            name: string;
+            calling_code: string;
+        };
+        BR: {
+            name: string;
+            calling_code: string;
+        };
+        BS: {
+            name: string;
+            calling_code: string;
+        };
+        BT: {
+            name: string;
+            calling_code: string;
+        };
+        BV: {
+            name: string;
+            calling_code: string;
+        };
+        BW: {
+            name: string;
+            calling_code: string;
+        };
+        BY: {
+            name: string;
+            calling_code: string;
+        };
+        BZ: {
+            name: string;
+            calling_code: string;
+        };
+        CA: {
+            name: string;
+            calling_code: string;
+        };
+        CC: {
+            name: string;
+            calling_code: string;
+        };
+        CD: {
+            name: string;
+            calling_code: string;
+        };
+        CF: {
+            name: string;
+            calling_code: string;
+        };
+        CG: {
+            name: string;
+            calling_code: string;
+        };
+        CH: {
+            name: string;
+            calling_code: string;
+        };
+        CI: {
+            name: string;
+            calling_code: string;
+        };
+        CK: {
+            name: string;
+            calling_code: string;
+        };
+        CL: {
+            name: string;
+            calling_code: string;
+        };
+        CM: {
+            name: string;
+            calling_code: string;
+        };
+        CN: {
+            name: string;
+            calling_code: string;
+        };
+        CO: {
+            name: string;
+            calling_code: string;
+        };
+        CR: {
+            name: string;
+            calling_code: string;
+        };
+        CU: {
+            name: string;
+            calling_code: string;
+        };
+        CV: {
+            name: string;
+            calling_code: string;
+        };
+        CW: {
+            name: string;
+            calling_code: string;
+        };
+        CX: {
+            name: string;
+            calling_code: string;
+        };
+        CY: {
+            name: string;
+            calling_code: string;
+        };
+        CZ: {
+            name: string;
+            calling_code: string;
+        };
+        DE: {
+            name: string;
+            calling_code: string;
+        };
+        DJ: {
+            name: string;
+            calling_code: string;
+        };
+        DK: {
+            name: string;
+            calling_code: string;
+        };
+        DM: {
+            name: string;
+            calling_code: string;
+        };
+        DO: {
+            name: string;
+            calling_code: string;
+        };
+        DZ: {
+            name: string;
+            calling_code: string;
+        };
+        EC: {
+            name: string;
+            calling_code: string;
+        };
+        EE: {
+            name: string;
+            calling_code: string;
+        };
+        EG: {
+            name: string;
+            calling_code: string;
+        };
+        EH: {
+            name: string;
+            calling_code: string;
+        };
+        ER: {
+            name: string;
+            calling_code: string;
+        };
+        ES: {
+            name: string;
+            calling_code: string;
+        };
+        ET: {
+            name: string;
+            calling_code: string;
+        };
+        FI: {
+            name: string;
+            calling_code: string;
+        };
+        FJ: {
+            name: string;
+            calling_code: string;
+        };
+        FK: {
+            name: string;
+            calling_code: string;
+        };
+        FM: {
+            name: string;
+            calling_code: string;
+        };
+        FO: {
+            name: string;
+            calling_code: string;
+        };
+        FR: {
+            name: string;
+            calling_code: string;
+        };
+        GA: {
+            name: string;
+            calling_code: string;
+        };
+        GB: {
+            name: string;
+            calling_code: string;
+        };
+        GD: {
+            name: string;
+            calling_code: string;
+        };
+        GE: {
+            name: string;
+            calling_code: string;
+        };
+        GF: {
+            name: string;
+            calling_code: string;
+        };
+        GG: {
+            name: string;
+            calling_code: string;
+        };
+        GH: {
+            name: string;
+            calling_code: string;
+        };
+        GI: {
+            name: string;
+            calling_code: string;
+        };
+        GL: {
+            name: string;
+            calling_code: string;
+        };
+        GM: {
+            name: string;
+            calling_code: string;
+        };
+        GN: {
+            name: string;
+            calling_code: string;
+        };
+        GP: {
+            name: string;
+            calling_code: string;
+        };
+        GQ: {
+            name: string;
+            calling_code: string;
+        };
+        GR: {
+            name: string;
+            calling_code: string;
+        };
+        GS: {
+            name: string;
+            calling_code: string;
+        };
+        GT: {
+            name: string;
+            calling_code: string;
+        };
+        GU: {
+            name: string;
+            calling_code: string;
+        };
+        GW: {
+            name: string;
+            calling_code: string;
+        };
+        GY: {
+            name: string;
+            calling_code: string;
+        };
+        HK: {
+            name: string;
+            calling_code: string;
+        };
+        HM: {
+            name: string;
+            calling_code: string;
+        };
+        HN: {
+            name: string;
+            calling_code: string;
+        };
+        HR: {
+            name: string;
+            calling_code: string;
+        };
+        HT: {
+            name: string;
+            calling_code: string;
+        };
+        HU: {
+            name: string;
+            calling_code: string;
+        };
+        ID: {
+            name: string;
+            calling_code: string;
+        };
+        IE: {
+            name: string;
+            calling_code: string;
+        };
+        IL: {
+            name: string;
+            calling_code: string;
+        };
+        IM: {
+            name: string;
+            calling_code: string;
+        };
+        IN: {
+            name: string;
+            calling_code: string;
+        };
+        IO: {
+            name: string;
+            calling_code: string;
+        };
+        IQ: {
+            name: string;
+            calling_code: string;
+        };
+        IR: {
+            name: string;
+            calling_code: string;
+        };
+        IS: {
+            name: string;
+            calling_code: string;
+        };
+        IT: {
+            name: string;
+            calling_code: string;
+        };
+        JE: {
+            name: string;
+            calling_code: string;
+        };
+        JM: {
+            name: string;
+            calling_code: string;
+        };
+        JO: {
+            name: string;
+            calling_code: string;
+        };
+        JP: {
+            name: string;
+            calling_code: string;
+        };
+        KE: {
+            name: string;
+            calling_code: string;
+        };
+        KG: {
+            name: string;
+            calling_code: string;
+        };
+        KH: {
+            name: string;
+            calling_code: string;
+        };
+        KI: {
+            name: string;
+            calling_code: string;
+        };
+        KM: {
+            name: string;
+            calling_code: string;
+        };
+        KN: {
+            name: string;
+            calling_code: string;
+        };
+        KP: {
+            name: string;
+            calling_code: string;
+        };
+        KR: {
+            name: string;
+            calling_code: string;
+        };
+        KW: {
+            name: string;
+            calling_code: string;
+        };
+        KY: {
+            name: string;
+            calling_code: string;
+        };
+        KZ: {
+            name: string;
+            calling_code: string;
+        };
+        LA: {
+            name: string;
+            calling_code: string;
+        };
+        LB: {
+            name: string;
+            calling_code: string;
+        };
+        LC: {
+            name: string;
+            calling_code: string;
+        };
+        LI: {
+            name: string;
+            calling_code: string;
+        };
+        LK: {
+            name: string;
+            calling_code: string;
+        };
+        LR: {
+            name: string;
+            calling_code: string;
+        };
+        LS: {
+            name: string;
+            calling_code: string;
+        };
+        LT: {
+            name: string;
+            calling_code: string;
+        };
+        LU: {
+            name: string;
+            calling_code: string;
+        };
+        LV: {
+            name: string;
+            calling_code: string;
+        };
+        LY: {
+            name: string;
+            calling_code: string;
+        };
+        MA: {
+            name: string;
+            calling_code: string;
+        };
+        MC: {
+            name: string;
+            calling_code: string;
+        };
+        MD: {
+            name: string;
+            calling_code: string;
+        };
+        ME: {
+            name: string;
+            calling_code: string;
+        };
+        MF: {
+            name: string;
+            calling_code: string;
+        };
+        MG: {
+            name: string;
+            calling_code: string;
+        };
+        MH: {
+            name: string;
+            calling_code: string;
+        };
+        MK: {
+            name: string;
+            calling_code: string;
+        };
+        ML: {
+            name: string;
+            calling_code: string;
+        };
+        MM: {
+            name: string;
+            calling_code: string;
+        };
+        MN: {
+            name: string;
+            calling_code: string;
+        };
+        MO: {
+            name: string;
+            calling_code: string;
+        };
+        MP: {
+            name: string;
+            calling_code: string;
+        };
+        MQ: {
+            name: string;
+            calling_code: string;
+        };
+        MR: {
+            name: string;
+            calling_code: string;
+        };
+        MS: {
+            name: string;
+            calling_code: string;
+        };
+        MT: {
+            name: string;
+            calling_code: string;
+        };
+        MU: {
+            name: string;
+            calling_code: string;
+        };
+        MV: {
+            name: string;
+            calling_code: string;
+        };
+        MW: {
+            name: string;
+            calling_code: string;
+        };
+        MX: {
+            name: string;
+            calling_code: string;
+        };
+        MY: {
+            name: string;
+            calling_code: string;
+        };
+        MZ: {
+            name: string;
+            calling_code: string;
+        };
+        NA: {
+            name: string;
+            calling_code: string;
+        };
+        NC: {
+            name: string;
+            calling_code: string;
+        };
+        NE: {
+            name: string;
+            calling_code: string;
+        };
+        NF: {
+            name: string;
+            calling_code: string;
+        };
+        NG: {
+            name: string;
+            calling_code: string;
+        };
+        NI: {
+            name: string;
+            calling_code: string;
+        };
+        NL: {
+            name: string;
+            calling_code: string;
+        };
+        NO: {
+            name: string;
+            calling_code: string;
+        };
+        NP: {
+            name: string;
+            calling_code: string;
+        };
+        NR: {
+            name: string;
+            calling_code: string;
+        };
+        NU: {
+            name: string;
+            calling_code: string;
+        };
+        NZ: {
+            name: string;
+            calling_code: string;
+        };
+        OM: {
+            name: string;
+            calling_code: string;
+        };
+        PA: {
+            name: string;
+            calling_code: string;
+        };
+        PE: {
+            name: string;
+            calling_code: string;
+        };
+        PF: {
+            name: string;
+            calling_code: string;
+        };
+        PG: {
+            name: string;
+            calling_code: string;
+        };
+        PH: {
+            name: string;
+            calling_code: string;
+        };
+        PK: {
+            name: string;
+            calling_code: string;
+        };
+        PL: {
+            name: string;
+            calling_code: string;
+        };
+        PM: {
+            name: string;
+            calling_code: string;
+        };
+        PN: {
+            name: string;
+            calling_code: string;
+        };
+        PR: {
+            name: string;
+            calling_code: string;
+        };
+        PS: {
+            name: string;
+            calling_code: string;
+        };
+        PT: {
+            name: string;
+            calling_code: string;
+        };
+        PW: {
+            name: string;
+            calling_code: string;
+        };
+        PY: {
+            name: string;
+            calling_code: string;
+        };
+        QA: {
+            name: string;
+            calling_code: string;
+        };
+        RE: {
+            name: string;
+            calling_code: string;
+        };
+        RO: {
+            name: string;
+            calling_code: string;
+        };
+        RS: {
+            name: string;
+            calling_code: string;
+        };
+        RU: {
+            name: string;
+            calling_code: string;
+        };
+        RW: {
+            name: string;
+            calling_code: string;
+        };
+        SA: {
+            name: string;
+            calling_code: string;
+        };
+        SB: {
+            name: string;
+            calling_code: string;
+        };
+        SC: {
+            name: string;
+            calling_code: string;
+        };
+        SD: {
+            name: string;
+            calling_code: string;
+        };
+        SE: {
+            name: string;
+            calling_code: string;
+        };
+        SG: {
+            name: string;
+            calling_code: string;
+        };
+        SH: {
+            name: string;
+            calling_code: string;
+        };
+        SI: {
+            name: string;
+            calling_code: string;
+        };
+        SJ: {
+            name: string;
+            calling_code: string;
+        };
+        SK: {
+            name: string;
+            calling_code: string;
+        };
+        SL: {
+            name: string;
+            calling_code: string;
+        };
+        SM: {
+            name: string;
+            calling_code: string;
+        };
+        SN: {
+            name: string;
+            calling_code: string;
+        };
+        SO: {
+            name: string;
+            calling_code: string;
+        };
+        SR: {
+            name: string;
+            calling_code: string;
+        };
+        SS: {
+            name: string;
+            calling_code: string;
+        };
+        ST: {
+            name: string;
+            calling_code: string;
+        };
+        SV: {
+            name: string;
+            calling_code: string;
+        };
+        SX: {
+            name: string;
+            calling_code: string;
+        };
+        SY: {
+            name: string;
+            calling_code: string;
+        };
+        SZ: {
+            name: string;
+            calling_code: string;
+        };
+        TC: {
+            name: string;
+            calling_code: string;
+        };
+        TD: {
+            name: string;
+            calling_code: string;
+        };
+        TF: {
+            name: string;
+            calling_code: string;
+        };
+        TG: {
+            name: string;
+            calling_code: string;
+        };
+        TH: {
+            name: string;
+            calling_code: string;
+        };
+        TJ: {
+            name: string;
+            calling_code: string;
+        };
+        TK: {
+            name: string;
+            calling_code: string;
+        };
+        TL: {
+            name: string;
+            calling_code: string;
+        };
+        TM: {
+            name: string;
+            calling_code: string;
+        };
+        TN: {
+            name: string;
+            calling_code: string;
+        };
+        TO: {
+            name: string;
+            calling_code: string;
+        };
+        TR: {
+            name: string;
+            calling_code: string;
+        };
+        TT: {
+            name: string;
+            calling_code: string;
+        };
+        TV: {
+            name: string;
+            calling_code: string;
+        };
+        TW: {
+            name: string;
+            calling_code: string;
+        };
+        TZ: {
+            name: string;
+            calling_code: string;
+        };
+        UA: {
+            name: string;
+            calling_code: string;
+        };
+        UG: {
+            name: string;
+            calling_code: string;
+        };
+        UM: {
+            name: string;
+            calling_code: string;
+        };
+        US: {
+            name: string;
+            calling_code: string;
+        };
+        UY: {
+            name: string;
+            calling_code: string;
+        };
+        UZ: {
+            name: string;
+            calling_code: string;
+        };
+        VA: {
+            name: string;
+            calling_code: string;
+        };
+        VC: {
+            name: string;
+            calling_code: string;
+        };
+        VE: {
+            name: string;
+            calling_code: string;
+        };
+        VG: {
+            name: string;
+            calling_code: string;
+        };
+        VI: {
+            name: string;
+            calling_code: string;
+        };
+        VN: {
+            name: string;
+            calling_code: string;
+        };
+        VU: {
+            name: string;
+            calling_code: string;
+        };
+        WF: {
+            name: string;
+            calling_code: string;
+        };
+        WS: {
+            name: string;
+            calling_code: string;
+        };
+        YE: {
+            name: string;
+            calling_code: string;
+        };
+        YT: {
+            name: string;
+            calling_code: string;
+        };
+        ZA: {
+            name: string;
+            calling_code: string;
+        };
+        ZM: {
+            name: string;
+            calling_code: string;
+        };
+        ZW: {
+            name: string;
+            calling_code: string;
+        };
+    };
+    _paddle_initialized: boolean;
+    _payment_element: any;
+    _sign_in_redirect: string | undefined | null;
+    _step: number;
+    _steps_element: any;
+    _steps_container: any;
+    _overview_container: any;
+    _order_container: any;
+    _billing_container: any;
+    _payment_container: any;
+    _processing_container: any;
+    _checkout_button: any;
+    _prev_step_button: any;
+    _style: any;
+    _currency_symbol: string | undefined;
+    _render_payment_element_reject: undefined | Function;
+    _render_payment_element_resolve: undefined | Function;
+    _refunds_element: any;
+    _refunds_container: any;
+    _processing_element: any;
+    _theme: any;
+    _products: any;
+    _days_refundable: number;
+    on_error: (data: string | Error) => void;
+    _refund_policy: string | undefined;
+    _cancellation_policy: string | undefined;
+    _billing_element: any;
+    _billing_details: any;
+    _overview_subtotal: any;
+    _overview_total: any;
+    _overview_subtotal_tax: any;
+    _overview_tax_container: any;
+    _overview_incl_excl_tax: any;
+    _overview_element: any;
+    _order_element: any;
+    /**
+     * Initialize Paddle with the provided client key and set up event callbacks.
+     */
+    _initialize_paddle: () => void;
+    /**
+     * Reset the payment element by removing it if it exists.
+     */
+    _reset: () => void;
+    /**
+     * Initialize the order by verifying authentication and making a POST request.
+     */
+    _init_order: () => Promise<void>;
+    /**
+     * Set the current step in the payment process.
+     */
+    _set_step: () => Promise<void | null>;
+    /**
+     * Navigate to the next step in the payment process.
+     */
+    _next: () => Promise<void | null>;
+    /**
+     * Navigate to the previous step in the payment process.
+     */
+    _prev: () => Promise<void | null>;
+    /**
+     * Render the steps element in the UI.
+     */
+    _render_steps_element: () => void;
+    /**
+     * Render the overview element in the UI.
+     */
+    _render_overview_element: () => void;
+    /**
+     * Render the order element in the UI.
+     */
+    _render_order_element: () => void;
+    _render_refunds_element: () => void;
+    _render_billing_element: () => void;
+    _render_payment_element: () => Promise<void>;
+    _render_processing_element: () => void;
+    _show_processing: (status?: string | null) => Promise<void>;
+    _update_processing: (status: string) => Promise<void>;
+    style: ({ theme, font_size, border_radius, bg, bg_1, divider_bg, fg, fg_1, fg_2, theme_fg, missing_fg, selected, button, }?: {
+        theme?: string | undefined;
+        font_size?: number | undefined;
+        border_radius?: number | undefined;
+        bg?: string | undefined;
+        bg_1?: string | undefined;
+        divider_bg?: string | undefined;
+        fg?: string | undefined;
+        fg_1?: string | undefined;
+        fg_2?: string | undefined;
+        theme_fg?: string | undefined;
+        missing_fg?: string | undefined;
+        selected?: {
+            fg: null | string;
+            bg: null | string;
+        } | undefined;
+        button?: {
+            fg: null | string;
+            bg: null | string;
+            border_color: null | string;
+            border_radius: null | number;
+            border_width: null | number | string;
+            border_inset: boolean;
+            hover_brightness: number[];
+        } | undefined;
+    }) => void;
+    create_checkout_dropin: ({ steps_container, order_container, billing_container, payment_container, processing_container, overview_container, sign_in_redirect, on_error, }: {
+        steps_container: any;
+        order_container: any;
+        billing_container: any;
+        payment_container: any;
+        processing_container: any;
+        overview_container: any;
+        sign_in_redirect?: string | null;
+        on_error?: (error: string | Error) => void;
+    }) => void;
+    create_refunds_dropin: ({ refunds_container, days_refundable, on_error, }: {
+        refunds_container: any;
+        days_refundable?: number;
+        on_error?: (error: any) => void;
+    }) => void;
+    /**
+     * @docs:
+     * @nav: Frontend
+     * @chapter: Payments
+     * @title: Get Currency Symbol
+     * @description: Get the currency symbol for a product currency.
+     * @type: string | null
+     * @return: Returns the currency symbol when the currency is supported, otherwise `null`
+     * @param:
+     *   @name: currency
+     *   @description: The currency from the product object.
+     */
+    get_currency_symbol: (currency: string) => string | null;
+    /**
+     * @docs:
+     * @nav: Frontend
+     * @chapter: Payments
+     * @title: Payment Products
+     * @description: Get the backend defined payment products asynchronously.
+     * @type: array[object]
+     * @return: Returns the backend defined payment products.
+     */
+    get_products: () => Promise<any[]>;
+    /**
+     * @docs:
+     * @nav: Frontend
+     * @chapter: Payments
+     * @title: Get Payment Product
+     * @description: Get the backend defined payment product by id asynchronously.
+     * @type: object
+     * @return: Returns the backend defined payment product.
+     * @param:
+     *   @name: id
+     *   @required: true
+     *   @type: string
+     *   @desc: The id of the payment product.
+     */
+    get_product: (id: string) => Promise<any>;
+    /**
+     * @docs:
+     * @nav: Frontend
+     * @chapter: Payments
+     * @title: Get Payment.
+     * @desc: Get a payment by id.
+     * @param:
+     *   @name: id
+     *   @required: true
+     *   @type: string
+     *   @desc: The id of the payment.
+     */
+    get_payment: (id: string) => Promise<any>;
+    /**
+     * @docs:
+     * @nav: Frontend
+     * @chapter: Payments
+     * @title: Get Refunded Payments.
+     * @desc:
+     *   Get all payments of the authenticated user
+     *
+     *   All failed payments are no longer stored in the database.
+     * @param:
+     *   @name: days
+     *   @type: number
+     *   @desc: Retrieve payments from the last amount of days.
+     * @param:
+     *   @name: limit
+     *   @type: number
+     *   @desc: Limit the amount of response payment objects.
+     * @param:
+     *   @name: status
+     *   @type: string
+     *   @desc: Filter the payments by status. Be aware that the line items of a payment also have a status with possible values of `open`, `cancelled`, `refunding` or `refunded.`
+     *   @enum:
+     *     @value: "open"
+     *     @desc: Payments that are still open and unpaid.
+     *   @enum:
+     *     @value: "paid"
+     *     @desc: Payments that are paid.
+     */
+    get_payments: ({ days, limit, status, }?: {
+        days?: number | undefined;
+        limit?: null | undefined;
+        status?: null | undefined;
+    }) => Promise<any>;
+    /**
+     * @docs:
+     * @nav: Frontend
+     * @chapter: Payments
+     * @title: Get Refundable Payments.
+     * @desc: Get all payments that are refundable for the authenticated user.
+     * @param:
+     *   @name: days
+     *   @type: number
+     *   @desc: Retrieve payments from the last amount of days.
+     * @param:
+     *   @name: limit
+     *   @type: number
+     *   @desc: Limit the amount of response payment objects.
+     */
+    get_refundable_payments: ({ days, limit, }?: {
+        days?: number | undefined;
+        limit?: null | undefined;
+    }) => Promise<any>;
+    /**
+     * @docs:
+     * @nav: Frontend
+     * @chapter: Payments
+     * @title: Get Refunded Payments.
+     * @desc: Get all successfully refunded payments of the authenticated user.
+     * @param:
+     *   @name: days
+     *   @type: number
+     *   @desc: Retrieve payments from the last amount of days.
+     * @param:
+     *   @name: limit
+     *   @type: number
+     *   @desc: Limit the amount of response payment objects.
+     */
+    get_refunded_payments: ({ days, limit, }?: {
+        days?: number | undefined;
+        limit?: null | undefined;
+    }) => Promise<any>;
+    /**
+     * @docs:
+     * @nav: Frontend
+     * @chapter: Payments
+     * @title: Get Refunding Payments.
+     * @desc: Get all payments that are currently in the refunding process of the authenticated user.
+     * @param:
+     *   @name: days
+     *   @type: number
+     *   @desc: Retrieve payments from the last amount of days.
+     * @param:
+     *   @name: limit
+     *   @type: number
+     *   @desc: Limit the amount of response payment objects.
+     */
+    get_refunding_payments: ({ days, limit, }?: {
+        days?: null | undefined;
+        limit?: null | undefined;
+    }) => Promise<any>;
+    /**
+     * @docs:
+     * @nav: Frontend
+     * @chapter: Payments
+     * @title: Refund Payment.
+     * @desc: Refund a payment based on the payment id for the authenticated user.
+     * @warning: Refunding a subscription will also cancel all other subscriptions that were created by the same payment request.
+     * @param:
+     *   @name: payment
+     *   @required: true
+     *   @type: number | string
+     *   @desc: The id of the payment object or the payment object itself.
+     * @param:
+     *   @name: line_items
+     *   @required: true
+     *   @type: array[object]
+     *   @desc: The line items to refund, these must be retrieved from the original payment line items otherwise it may cause undefined behaviour. When undefined the entire payment will be refunded.
+     * @param:
+     *   @name: reason
+     *   @type: string
+     *   @desc: The refund reason.
+     */
+    create_refund: (payment: number | string, line_items?: any[] | null, reason?: string) => Promise<any>;
+    /**
+     * @docs:
+     * @nav: Frontend
+     * @chapter: Payments
+     * @title: Cancel Subscription.
+     * @desc: Cancel a subscription based on the product id.
+     * @warning: Cancelling a subscription will also cancel all other subscriptions that were created by the same payment request.
+     * @param:
+     *   @name: product
+     *   @required: true
+     *   @type: string
+     *   @desc: The product id.
+     */
+    cancel_subscription: (product: string) => Promise<any>;
+    /**
+     * @docs:
+     * @nav: Frontend
+     * @chapter: Payments
+     * @title: Is Subscribed.
+     * @desc: Check if the authenticated user is subscribed to a product plan.
+     * @param:
+     *   @name: product
+     *   @required: true
+     *   @type: string
+     *   @desc: The product id.
+     */
+    is_subscribed: (product: string) => Promise<any>;
+    /**
+     * @docs:
+     * @nav: Frontend
+     * @chapter: Payments
+     * @title: Get active subscriptions
+     * @desc: Get the active subscriptions of the authenticated user.
+     */
+    get_active_subscriptions: () => Promise<any>;
+    cart: {
+        items: any[];
+        /**
+         * @docs:
+         * @nav: Frontend
+         * @chapter: Payments
+         * @title: Refresh Cart
+         * @description:
+         *   Refresh the shopping cart.
+         *
+         *   The current cart items are accessible as `Payments.cart.items`.
+         */
+        refresh: () => void;
+        /**
+         * @docs:
+         * @nav: Frontend
+         * @chapter: Payments
+         * @title: Save Cart
+         * @description:
+         *   Save the shopping cart in the local storage.
+         *
+         *   The current cart items are accessible as `Payments.cart.items`.
+         */
+        save: () => void;
+        /**
+         * @docs:
+         * @nav: Frontend
+         * @chapter: Payments
+         * @title: Add to Cart
+         * @description:
+         *   Add a product to the shopping cart.
+         *
+         *   When the product was already added to the shopping cart only the quantity will be incremented.
+         *
+         *   An error will be thrown if the product id does not exist.
+         *
+         *   The current cart items are accessible as `Payments.cart.items`.
+         * @param:
+         *   @name: id
+         *   @description: The product's id.
+         *   @type: string
+         * @param:
+         *   @name: quantity
+         *   @description: The quantity to add.
+         *   @type: number
+         */
+        add: (id: string, quantity?: number) => Promise<void>;
+        /**
+         * @docs:
+         * @nav: Frontend
+         * @chapter: Payments
+         * @title: Remove from Cart
+         * @description:
+         *   Remove a product from the shopping cart.
+         *
+         *   Does not throw an error when the product was not added to the shopping cart.
+         *
+         *   The current cart items are accessible as `Payments.cart.items`.
+         * @param:
+         *   @name: id
+         *   @description: The product's id.
+         *   @type: string
+         * @param:
+         *   @name: quantity
+         *   @description: The quantity to remove. When the quantity value is "all", the entire product will be removed from the shopping cart.
+         *   @type: number | "all"
+         */
+        remove: (id: string, quantity?: number | "all") => Promise<void>;
+        /**
+         * @docs:
+         * @nav: Frontend
+         * @chapter: Payments
+         * @title: Clear Cart
+         * @description:
+         *   Clear the shopping cart.
+         *
+         *   Will automatically be called if `Payments.confirm_charge()` finishes without any errors.
+         *
+         *   The current cart items are accessible as `Payments.cart.items`.
+         */
+        clear: () => Promise<void>;
+    };
+};
+export { Payments };