@rechargeapps/storefront-client 0.14.0 → 0.15.1

package/dist/index.d.ts

@@ -1,1485 +0,0 @@
-/** HEXA, RGBA, HSLA */
-declare type ColorString = string;
-/** HTML String */
-declare type HTMLString = string;
-/** ISO 8601 date time, YYYY-MM-DD */
-declare type IsoDateString = string;
-interface Property {
-    name: string;
-    value: string;
-}
-interface ListParams<T> {
-    /** default is 50, max is 250 */
-    limit?: number;
-    /** next or previous cursor returned by previous list call */
-    cursor?: number;
-    /** sort list by option */
-    sort_by?: T;
-}
-interface ExternalId {
-    /** The order ID as it appears in the external e-commerce platform. */
-    ecommerce: string | null;
-}
-interface ExternalTransactionId {
-    /** The ID of the associated transaction in a payment processor system (like Stripe). */
-    payment_processor: number | null;
-}
-interface AssociatedAddress {
-    address1: string;
-    address2: string | null;
-    city: string;
-    company: string | null;
-    country_code: string;
-    country?: string;
-    first_name: string;
-    last_name: string;
-    phone: string | null;
-    province: string;
-    zip: string;
-}
-interface ProductImage {
-    /** The url where a large image file is located. */
-    large?: string;
-    /** The url where a medium image file is located. */
-    medium?: string;
-    /** The url of the original sized product image. */
-    original?: string;
-    /** The url where a small image file is located. */
-    small?: string;
-    /** The sort order in which the x image from the array should appear when displayed. */
-    sort_order?: number;
-}
-interface LineItem {
-    subscription_id?: number;
-    /** The Subscription or Onetime ID associated with the line_item. */
-    purchase_item_id: number;
-    /** An object containing the associated product ID as it appears in the external system. */
-    external_product_id: ExternalId;
-    /** An object containing the associated variant ID as it appears in the external system. */
-    external_variant_id: ExternalId;
-    /** The weight of the item in grams. */
-    grams: number;
-    /** A unique, human-friendly string for the Product. */
-    handle: string | null;
-    /** An object containing URLs of the Product image. */
-    images: ProductImage;
-    /** An array of name value pairs of additional line_item attributes. */
-    properties: Property[];
-    /** An indicator of the type of the purchase item. */
-    purchase_item_type: 'subscription' | 'onetime';
-    /** The quantity of the line_item. */
-    quantity: number;
-    /** The SKU (stock keeping unit) of the Product associated with the line_item. */
-    sku: string | null;
-    /** The total tax due associated with the line_item. */
-    tax_due: string;
-    /** an array containing tax_line objects associated with this line_item. */
-    tax_lines: TaxLine[];
-    /** A boolean indicating if the line_item is taxable or non-taxable. */
-    taxable: boolean;
-    /** The taxable revenue associated with the line_item. */
-    taxable_amount: string;
-    /** The title of the Product of this line_item. */
-    title: string;
-    /** The total price of the line_item including tax. */
-    total_price: string;
-    /** The unit price of the line_item. */
-    unit_price: string;
-    /** A boolean indicator if tax is included in the price of an item. */
-    unit_price_includes_tax: boolean;
-    /** The name of a variant of the Product of this line_item. */
-    variant_title: string | null;
-}
-interface TaxLine {
-    /** The total tax associated with the listed jurisdiction. */
-    price: string;
-    /** The tax rate associated with the listed jurisdiction. */
-    rate: string;
-    /** The title/name of the taxing jurisdiction. */
-    title: string;
-}
-interface Discount {
-    /** The ID of the Discount. */
-    id: string;
-    /** The code of the Discount. */
-    code: string;
-    /** The value of the Discount. */
-    value: number;
-    /** The type of the value of the Discount. */
-    value_type: 'percentage' | 'fixed_amount';
-}
-interface AnalyticsData {
-    utm_params: {
-        utm_campaign: string;
-        utm_content: string;
-        utm_data_source: string;
-        utm_source: string;
-        utm_medium: string;
-        utm_term: string;
-        utm_timestamp: string;
-    }[];
-}
-declare type SubType<T, TRequired extends keyof T = keyof T, TOptional extends keyof T = keyof T> = Required<Pick<T, TRequired>> & Partial<Pick<T, TOptional>>;
-
-interface ShippingLine {
-    /** The code associated with the shipping_line of a Charge. */
-    code: string;
-    /** The price of the shipping_line. */
-    price: string;
-    /** The source of the shipping_line. */
-    source: string;
-    /** The title of the shipping_line. */
-    title: string;
-    /** A boolean indicating if the shipping_line is taxable. */
-    taxable: boolean;
-    /** An array of tax lines associated with the shipping_line. */
-    tax_lines: TaxLine[];
-}
-declare type OrderStatus = 'success' | 'error' | 'queued' | 'cancelled' | 'pending_charge_status';
-declare type OrderType = 'checkout' | 'recurring';
-interface Order {
-    /** The unique numeric identifier for the order. */
-    id: number;
-    /** The id of the associated Address within Recharge. */
-    address_id: number;
-    /** The billing address at the time the order was created. See Addresses for detailed address information. */
-    billing_address: AssociatedAddress;
-    /** An object containing parameters of the Charge. */
-    charge: {
-        /** The id of the charge associated with this order. */
-        id: number;
-        /** An object containing external transaction ids associated with this charge, as they appear in external platforms. */
-        external_transaction_id: ExternalTransactionId;
-    };
-    /** Details of the access method used by the purchase. */
-    client_details: {
-        /** The IP address of the buyer as detected in Checkout. */
-        browser_ip: string;
-        /** The user agent detected during Checkout. */
-        user_agent: string;
-    };
-    /** The date when the order was created. */
-    created_at: IsoDateString;
-    /** The currency of the payment used to create the order. */
-    currency: string;
-    /** Object that contains information about the Customer. */
-    customer: {
-        /** The ID of the associated customer record. */
-        id: number;
-        /** The user email. */
-        email: string;
-        /** An object containing customer information associated with this charge. */
-        external_customer_id: ExternalId;
-        /** The hash of the Customer associated with the Charge. */
-        hash: string;
-    };
-    /** An array of Discounts associated with the Order. */
-    discounts: Discount[];
-    /** The cart token as it appears in an external system. */
-    external_cart_token: string;
-    /** An object containing external order ids. */
-    external_order_id?: ExternalId;
-    /** An object containing the external order numbers. */
-    external_order_number: ExternalId;
-    /** A boolean representing if this Order is generated from a prepaid purchase. */
-    is_prepaid?: boolean;
-    /** A list of line_item objects. */
-    line_items: LineItem[];
-    /** Notes associated with the Order. */
-    note: string;
-    /** An array of name value pairs of note attributes on the Order. */
-    order_attributes: Property[];
-    /** The date time that the associated charge was processed at. */
-    processed_at: IsoDateString | null;
-    /** The date time of when the associated charge is/was scheduled to process. */
-    scheduled_at: IsoDateString;
-    /** The shipping address where the order will be shipped. See Addresses for detailed Address information. */
-    shipping_address: AssociatedAddress;
-    /** An array of shipping lines associated with the order. */
-    shipping_lines: ShippingLine[];
-    /** The status of creating the Order. */
-    status: OrderStatus;
-    /** The subtotal price (sum of all line items * their quantity) of the order less discounts. */
-    subtotal_price: string;
-    /** A comma separated list of tags on the Order. */
-    tags: string;
-    /** An array of tax lines that apply to the Order. */
-    tax_lines: TaxLine[];
-    /** A boolean indicator of the taxability of the Order. */
-    taxable: boolean;
-    /** The total discounted dollar value of the Order. */
-    total_discounts: string;
-    /** The total price of all line items of the Order. */
-    total_line_items_price: string;
-    /** The total amount due of the Order. */
-    total_price: string;
-    /** The total dollar amount of refunds associated with the Order. */
-    total_refunds: string;
-    /** The total tax due associated with the Order. */
-    total_tax: string;
-    /** The total weight of the order in grams. */
-    total_weight_grams: number;
-    /** An indicator of the order’s type. */
-    type: OrderType;
-    /** The date time at which the order was most recently updated. */
-    updated_at: IsoDateString;
-    /** Error information about the order if status is 'error' */
-    error: string | null;
-}
-interface OrdersResponse {
-    next_cursor: null | string;
-    previous_cursor: null | string;
-    orders: Order[];
-}
-declare type OrderSortBy = 'id-asc' | 'id-desc' | 'updated_at-asc' | 'updated_at-desc' | 'processed_at-asc' | 'processed_at-desc' | 'scheduled_at-asc' | 'scheduled_at-desc';
-interface OrderListParams extends ListParams<OrderSortBy> {
-    address_id?: string;
-    charge_id?: string;
-    created_at_min?: IsoDateString;
-    created_at_max?: IsoDateString;
-    customer_id?: string;
-    external_customer_id?: string;
-    ids?: string[];
-    scheduled_at_max?: IsoDateString;
-    scheduled_at_min?: IsoDateString;
-    has_external_order?: string;
-    status?: OrderStatus;
-    type?: OrderType;
-    purchase_item_id?: string;
-    updated_at_max?: IsoDateString;
-    updated_at_min?: IsoDateString;
-}
-
-declare type ChargeStatus = 'success' | 'error' | 'queued' | 'skipped' | 'refunded' | 'partially_refunded' | 'pending_manual_payment' | 'pending';
-interface Charge {
-    /** The unique numeric identifier for the Charge. */
-    id: number;
-    /** The ID of the shipping Address tied to the Charge.*/
-    address_id: number;
-    /** An object containing analytics data associated with the Charge. */
-    analytics_data: AnalyticsData;
-    /** All the billing information related to the charge. */
-    billing_address: AssociatedAddress;
-    /** Details of the access method used by the purchaser. */
-    client_details: {
-        /** The IP address of the buyer as detected in Checkout. */
-        browser_ip: string;
-        /** The user agent detected during Checkout. */
-        user_agent: string;
-    };
-    /** The date and time when the transaction was created. */
-    created_at: IsoDateString;
-    /** The code of the currency for this Charge, such as USD. */
-    currency: string;
-    /** An object containing Customer information associated with this Charge. */
-    customer: {
-        /** The ID of the associated customer record. */
-        id: number;
-        /** The user email. */
-        email: string;
-        /** An object containing customer information associated with this charge. */
-        external_customer_id: string;
-        /** The hash of the Customer associated with the Charge. */
-        hash: string;
-    };
-    /** An array of Discounts associated with the Charge. */
-    discounts: Discount[];
-    /** An object containing the associated external order ID. */
-    external_order_id: ExternalId;
-    /** An object containing the associated external transaction ID. */
-    external_transaction_id: ExternalTransactionId;
-    /** A list of line_item objects, each containing information about a distinct purchase item. */
-    line_items: LineItem;
-    /** Notes associated with the Charge. */
-    note: string;
-    /** An array of name-value pairs of order attributes on the Charge. */
-    order_attributes: Property[];
-    /** The number of Orders generated from this Charge (>1 for prepaid Subscriptions). */
-    orders_count: number;
-    /** The payment processor used for this Charge. */
-    payment_processor: string;
-    /** The date and time when the transaction was processed. */
-    processed_at: IsoDateString;
-    /** The date when the next attempt will be placed. */
-    retry_date: IsoDateString;
-    /** The date time of when the Charge is/was scheduled to process. */
-    scheduled_at: IsoDateString;
-    /** The shipping Address of the Charge. */
-    shipping_address: AssociatedAddress;
-    /** An array of shipping lines associated with the Charge. */
-    shipping_lines: ShippingLine[];
-    /** The status of the Charge. */
-    status: ChargeStatus;
-    /** The combined price of all line_items without taxes and shipping. */
-    subtotal_price: string;
-    /** A comma-separated list of tags on the Charge. */
-    tags: string;
-    /** An array of tax lines that apply to the Charge. */
-    tax_lines: TaxLine[];
-    /** A boolean indicator of the taxability of the Charge. */
-    taxable: boolean;
-    /** The sum of the Discounts applied to the Charge. */
-    total_discounts: string;
-    /** The total price of all line items of the Charge. */
-    total_line_items_price: string;
-    /** The sum of all the prices of all the items in the Charge, taxes and discounts included (must be positive). */
-    total_price: string;
-    /** The sum of all refunds that were applied to the Charge. */
-    total_refunds: string;
-    /** The total tax due associated with the Charge. */
-    total_tax: string;
-    /** The total weight of the Charge’s line items in grams. */
-    total_weight_grams: number;
-    /** An indicator of the Charge’s type, either checkout or recurring. */
-    type: 'checkout' | 'recurring';
-    /** The date time at which the Charge was most recently updated. */
-    updated_at: IsoDateString;
-}
-interface ChargeResponse {
-    charge: Charge;
-}
-interface ChargeListResponse {
-    next_cursor: null | string;
-    previous_cursor: null | string;
-    charges: Charge[];
-}
-interface ApplyDiscountRequest {
-    /** Code of the Discount you want to apply to a Charge. */
-    discount_code?: string;
-    /** ID of the Discount you want to apply to a Charge. */
-    discount_id?: number;
-}
-declare type ChargeSortBy = 'id-asc' | 'id-desc' | 'updated_at-asc' | 'updated_at-desc' | 'scheduled_at-asc' | 'scheduled_at-desc';
-interface ChargeListParams extends ListParams<ChargeSortBy> {
-    /** Filter Charges by Address. */
-    address_id?: string;
-    /** Filter Charges by Customer. */
-    customer_id?: string;
-    /** List Charges that contain the given discount_id. */
-    discount_id?: string;
-    /** List Charges that contain the given discount_code. */
-    discount_code?: string;
-    /** Filter Charges by the associated order ID in the external e-commerce platform. */
-    external_order_id?: string;
-    /**
-     * Filter Charges by ID.
-     * If passing multiple values, must be comma separated. Non-integer values will result in a 422 error.
-     */
-    ids?: string;
-    /** Filter Charges by a Subscription or Onetime ID. */
-    purchase_item_id?: string;
-    /** Filter Charges by a comma-separated list of Subscription or Onetime IDs. */
-    purchase_item_ids?: string;
-    /** Filter Charges by specific scheduled charge date. */
-    scheduled_at?: IsoDateString;
-    /** Show Charges scheduled to be processed before the given date. */
-    scheduled_at_max?: IsoDateString;
-    /** Show Charges scheduled to be processed after the given date. */
-    scheduled_at_min?: IsoDateString;
-    /** Filter charges by status. */
-    status?: ChargeStatus;
-    /** Show charges updated before the given date. */
-    updated_at_max?: IsoDateString;
-    /** Show charges updated after the given date. */
-    updated_at_min?: IsoDateString;
-    /** Show charges processed after, and including, the given date. */
-    processed_at_max?: IsoDateString;
-    /** Show charges processed before, and including, the given date. */
-    processed_at_min?: IsoDateString;
-    /** Show Charges created after the given date. */
-    created_at_min?: IsoDateString;
-    /** Show Charges created before the given date. */
-    created_at_max?: IsoDateString;
-}
-
-interface CreateAddressRequest {
-    /** Unique numeric identifier for the customer associated with the address. */
-    customer_id: number;
-    /** The street associated with the Address. Minimum length is 1 character. */
-    address1: string;
-    /** Any additional information associated with the Address. */
-    address2?: string;
-    /** The city associated with the address. */
-    city: string;
-    /** The company associated with the address. */
-    company?: string;
-    /** 2-letter country code. */
-    country_code: string;
-    /** A list of discounts applied on the address. These discounts will apply to future recurring charges associated with this address. */
-    discounts?: {
-        id: number;
-    }[];
-    /** The customer’s first name associated with the address. */
-    first_name: string;
-    /** The customer’s last name associated with the address. */
-    last_name: string;
-    /** Replaces cart_attributes. Extra information that is added to the order. */
-    order_attributes?: Property[];
-    /** Notes to be added to all orders associated with the address. */
-    order_note?: string | null;
-    /** Payment method id for the Payment_method to be associated to this address. */
-    payment_method_id?: number;
-    /** The phone number associated with the address. Must be included in the request schema but can be an empty string. */
-    phone: string;
-    /** The currency on the subscription contract in Shopify. Only set if the currency is different from the store-level currency. Else, will be null. */
-    presentment_currency?: string | null;
-    /** The state or province associated with the address. */
-    province: string | null;
-    /** Used when shipping rates need to be overridden. If this parameter has value null, rates will be fetched when Charge is created or regenerated */
-    shipping_lines_override?: {
-        code: string;
-        price: string;
-        title: string;
-    }[] | null;
-    /** The zip or postal code associated with the address. */
-    zip: string;
-}
-declare type UpdateAddressRequest = Omit<Partial<CreateAddressRequest>, 'presentment_currency' | 'customer_id'>;
-interface MergeAddressesRequest {
-    /** Indicates whether source addresses should be deleted. */
-    delete_source_addresses?: boolean;
-    /** Specifies the next charge date of the associated subscriptions on the target address. */
-    next_charge_date?: string;
-    /** The address all of the subscriptions should be moved to. */
-    target_address: Address | {
-        id: number;
-    };
-    /** The list of addresses that the subscriptions should move from. */
-    source_addresses: (Address | {
-        id: number;
-    })[];
-}
-interface SkipFutureChargeAddressRequest {
-    /**
-     * The date in the future of the Charge to be skipped.
-     * This date must be within the delivery schedules of the Customer.
-     */
-    date: IsoDateString;
-    /** A list containing the Subscription IDs to be skipped. */
-    subscription_ids: string;
-}
-interface Address {
-    /** Unique numeric identifier for the Address. */
-    id: number;
-    /** The street associated with the Address. */
-    address1: string;
-    /** Any additional information associated with the Address. */
-    address2?: string;
-    /** The city associated with the address. */
-    city: string;
-    /** The company associated with the address. */
-    company: string;
-    /** 2-letter country code. */
-    country_code: string;
-    /** Unique numeric identifier for the customer associated with the address. */
-    customer_id: number;
-    /** A list of discounts applied on the address. These discounts will apply to future recurring charges associated with this address. */
-    discounts?: {
-        id: number;
-    }[];
-    /** The customer’s first name associated with the address. */
-    first_name: string;
-    /** The customer’s last name associated with the address. */
-    last_name: string;
-    /** Replaces cart_attributes. Extra information that is added to the order. */
-    order_attributes: Property[];
-    /** Notes to be added to all orders associated with the address. */
-    order_note: string | null;
-    /** Unique numeric identifier for the Payment Method associated to the Address. */
-    payment_method_id: number;
-    /** The phone number associated with the address. */
-    phone: string;
-    /** The currency on the subscription contract in Shopify. Only set if the currency is different from the store-level currency. Else, will be null. */
-    presentment_currency: string | null;
-    /** The state or province associated with the address. */
-    province: string | null;
-    /** Used when shipping rates need to be overridden. If this parameter has value null, rates will be fetched when Charge is created or regenerated */
-    shipping_lines_override: {
-        code: string;
-        price: string;
-        title: string;
-    }[] | null;
-    /** The zip or postal code associated with the address. */
-    zip?: string | null;
-    /** The date and time when the address was created. */
-    created_at: IsoDateString;
-    /** The date and time when the address was last updated. */
-    updated_at: IsoDateString;
-}
-interface SkipFutureChargeAddressResponse {
-    charge: Charge;
-}
-interface AddressResponse {
-    address: Address;
-}
-interface AddressListResponse {
-    next_cursor: null | string;
-    previous_cursor: null | string;
-    addresses: Address[];
-}
-declare type AddressSortBy = 'id-asc' | 'id-desc' | 'updated_at-asc' | 'updated_at-desc';
-interface AddressListParams extends ListParams<AddressSortBy> {
-    customer_id?: string;
-    discount_id?: string;
-    discount_code?: string;
-    created_at_min?: IsoDateString;
-    created_at_max?: IsoDateString;
-}
-
-interface Session {
-    apiToken: string;
-    customerId?: string;
-}
-
-/** Returns all addresses from the store, or addresses for the customer given in the parameter. */
-declare function listAddresses(session: Session, query?: AddressListParams): Promise<AddressListResponse>;
-/** Retrieves address for customer based on specified address id. */
-declare function getAddress(session: Session, id: string | number): Promise<Address>;
-/** Create a new address for a customer. */
-declare function createAddress(session: Session, createRequest: CreateAddressRequest): Promise<Address>;
-/** Updates an existing address to match the specified parameters. */
-declare function updateAddress(session: Session, id: string | number, updateRequest: UpdateAddressRequest): Promise<Address>;
-/** Deletes an address. Only Addresses with no active Subscriptions can be deleted. */
-declare function deleteAddress(session: Session, id: string | number): Promise<void>;
-/**
- * Merges up to 10 source addresses into 1 target address.
- */
-declare function mergeAddresses(session: Session, mergeRequest: MergeAddressesRequest): Promise<Address>;
-/**
- * Skip a Charge in the future for one or multiple Subscriptions associated with the Address.
- */
-declare function skipFutureCharge(session: Session, id: string | number, skipRequest: SkipFutureChargeAddressRequest): Promise<Charge>;
-
-declare function loginShopifyAppProxy(): Promise<Session>;
-declare function loginShopifyApi(customerAccessToken: string, storefrontAccessToken: string): Promise<Session | null>;
-
-declare function getCharge(session: Session, id: number | string): Promise<Charge>;
-/** Lists charges */
-declare function listCharges(session: Session, query?: ChargeListParams): Promise<ChargeListResponse>;
-/**
- * You cannot add a Discount to an existing queued Charge if the Charge or the associated Address already has one.
- * You can provide either discount_id or discount_code. If both parameters are passed, the value for discount_id will take precedence.
- * If a Charge has a Discount and it gets updated, or a regeneration occurs, the Discount will be lost. Regeneration is a process that refreshes the Charge JSON with new data in the case of the Subscription or Address being updated.
- */
-declare function applyDiscount(session: Session, id: number | string, applyRequest: ApplyDiscountRequest): Promise<Charge>;
-/**
- * Remove a Discount from a Charge without destroying the Discount.
- * In most cases the Discount should be removed from the Address. When the Discount is removed from the Address, the Discount is also removed from any future Charges.
- * If the Discount is on the parent Address, you cannot remove it using charge_id.
- * When removing your Discount, it is preferable to pass the address_id so that the Discount stays removed if the Charge is regenerated. Only pass charge_id in edge cases in which there are two or more Charges on a parent Address and you only want to remove the Discount from one Charge.
- * If you pass both parameters, it will remove the Discount from the Address.
- */
-declare function removeDiscount(session: Session, id: number | string): Promise<Charge>;
-declare function skipCharge(session: Session, id: number | string): Promise<Charge>;
-declare function unskipCharge(session: Session, id: number | string): Promise<Charge>;
-
-declare type Method = 'get' | 'post' | 'put' | 'delete';
-declare type Request = <T>(method: Method, url: string, options?: RequestOptions) => Promise<T>;
-interface GetRequestOptions {
-    id?: string | number;
-    query?: unknown;
-}
-interface CRUDRequestOptions {
-    id?: string | number;
-    data?: unknown;
-    query?: unknown;
-}
-/** Custom headers we use within our storefront client */
-interface CustomHeaders {
-    ['X-Recharge-App']?: 'storefront-client';
-}
-/** We only support headers with an object syntax */
-declare type RequestHeaders = Record<string, string> & CustomHeaders;
-interface RequestOptionsHeaders {
-    headers?: RequestHeaders;
-}
-declare type RequestOptions = GetRequestOptions & CRUDRequestOptions & RequestOptionsHeaders;
-
-interface LoginResponse {
-    api_token: string;
-    customer_id?: string;
-}
-
-interface BundleSelection {
-    collectionId: string;
-    externalProductId: string;
-    externalVariantId: string;
-    quantity: number;
-}
-interface Bundle {
-    externalVariantId: string;
-    externalProductId: string;
-    selections: BundleSelection[];
-}
-
-declare type FirstOption = 'onetime' | 'autodeliver';
-declare type IntervalUnit = 'day' | 'week' | 'month';
-declare type PriceAdjustmentsType = 'percentage';
-declare type StorefrontPurchaseOption = 'subscription_and_onetime' | 'subscription_only' | 'onetime_only' | 'inactive';
-interface BundleTranslations {
-    cpb_add: string;
-    cpb_add_items_to_continue: string;
-    cpb_add_more_items: string;
-    cpb_apply_filters: string;
-    cpb_cancel: string;
-    cpb_clear_all_filters: string;
-    cpb_contents_for: string;
-    cpb_day: string;
-    cpb_filters: string;
-    cpb_frequency: string;
-    cpb_frequency_values: string;
-    cpb_items_selected: string;
-    cpb_items_selected_filters: string;
-    cpb_month: string;
-    cpb_remove: string;
-    cpb_remove_items_to_continue: string;
-    cpb_remove_some_items: string;
-    cpb_save_button_text: string;
-    cpb_saved_message: string;
-    cpb_saving_message: string;
-    cpb_select_bundle_contents: string;
-    cpb_select_your_contents_to_continue_message_modal: string;
-    cpb_select_your_contents_to_continue_title_modal: string;
-    cpb_selection_count_alert: string;
-    cpb_update_bundle_contents: string;
-    cpb_week: string;
-    cpb_your: string;
-    cpb_your_next_order: string;
-    pdp_add: string;
-    pdp_add_items_to_continue: string;
-    'pdp_add_one-off_extras': string;
-    'pdp_add_one-off_extras_description': string;
-    'pdp_add_repeating_add-ons': string;
-    'pdp_add_repeating_add-ons_description': string;
-    pdp_add_to_cart: string;
-    pdp_add_to_cart_alert: string;
-    pdp_add_to_cart_extras: string;
-    pdp_add_to_cart_failed: string;
-    pdp_apply_filters: string;
-    pdp_back: string;
-    pdp_bundle_contents: string;
-    pdp_cancel: string;
-    pdp_choose_items: string;
-    pdp_choose_items_alert: string;
-    pdp_choose_maximum: string;
-    pdp_choose_range: string;
-    pdp_clear_all_filters: string;
-    pdp_day: string;
-    pdp_filters: string;
-    pdp_frequency: string;
-    pdp_frequency_value: string;
-    pdp_items_selected: string;
-    pdp_items_selected_filters: string;
-    pdp_max_per_item_reached_alert: string;
-    pdp_month: string;
-    pdp_next: string;
-    'pdp_one-off_extras': string;
-    pdp_only_once: string;
-    pdp_order_summary: string;
-    pdp_plan_changed_alert: string;
-    pdp_proceed_to_cart: string;
-    pdp_product_added: string;
-    pdp_regular_delivery: string;
-    pdp_remove: string;
-    pdp_remove_items_alert: string;
-    pdp_remove_items_to_continue: string;
-    'pdp_repeating_add-ons': string;
-    pdp_selection_completed_alert: string;
-    pdp_selection_count_alert: string;
-    pdp_sold_out: string;
-    pdp_subscribe: string;
-    pdp_total: string;
-    pdp_update_your_selections_to_continue: string;
-    pdp_week: string;
-}
-interface Translations {
-    days: string;
-    week: string;
-    weeks: string;
-    month: string;
-    months: string;
-}
-declare type WidgetTemplateType = 'radio' | 'checkbox' | 'button_group' | 'radio_group';
-declare type WidgetIconColor = '#191D48' | 'white' | 'black' | '#ffffff';
-/****************** 2020-12 **********************/
-interface CDNProductResource {
-    product: CDNProductRaw;
-    meta: {
-        version: '2020-12';
-    };
-}
-interface CDNProductKeyObject {
-    [key: string]: CDNProduct;
-}
-interface CDNProductsAndSettingsResource {
-    products: {
-        [key: string]: CDNProductRaw;
-    }[];
-    widget_settings: CDNWidgetSettingsRaw;
-    store_settings?: CDNStoreSettings;
-    meta?: {
-        status: string;
-        message: string;
-    };
-}
-interface CDNSellingPlan {
-    order_interval_frequency: string | number;
-    created_at?: IsoDateString;
-    order_interval_unit_type: IntervalUnit;
-    updated_at?: IsoDateString;
-    id: number;
-    selling_plan_id: number;
-    selling_plan_name: string;
-    price_adjustments_value_type: PriceAdjustmentsType;
-    price_adjustments_value: number;
-}
-interface CDNSellingPlanGroup {
-    selling_plan_group_id: string | number;
-    selling_plans: CDNSellingPlan[];
-    subscription_product_id: number;
-}
-interface CDNSubscriptionOption {
-    storefront_purchase_options: StorefrontPurchaseOption;
-    updated_at: IsoDateString;
-    is_prepaid?: boolean;
-}
-interface CDNSellingPlanAllocations {
-    selling_plan_group_id: string | number;
-    selling_plan_id: number;
-    discounted_price: string;
-}
-interface CDNPrices {
-    compare_at_price: string | null;
-    unit_price: string;
-    discounted_price: string;
-    zero_decimal_currency: boolean;
-}
-interface CDNVariantOptionValue {
-    id: number;
-    label: string;
-}
-interface CDNVariant {
-    id: number;
-    option_values: CDNVariantOptionValue[];
-    prices: CDNPrices;
-    selling_plan_allocations: CDNSellingPlanAllocations[];
-}
-interface CDNProductOptionValue {
-    id?: number | null;
-    label: string;
-    position: number;
-}
-interface CDNProductOption {
-    id: number;
-    name: string;
-    position: number;
-    values: CDNProductOptionValue[];
-}
-interface CDNProductRaw {
-    id: number | null;
-    bundle_product?: CDNBundleSettings | null;
-    external_product_id: number;
-    in_recharge: boolean;
-    options: CDNProductOption[];
-    variants: CDNVariant[];
-    subscription_options: CDNSubscriptionOption;
-    selling_plan_groups: CDNSellingPlanGroup[];
-}
-interface CDNProduct extends CDNProductRaw {
-    /** @deprecated */
-    isSubscriptionOnly: boolean;
-    is_subscription_only: boolean;
-}
-interface CDNProductAndSettings {
-    product: CDNProduct;
-    widget_settings: CDNWidgetSettings;
-    store_settings: CDNStoreSettings;
-    /** @deprecated */
-    widgetSettings: CDNWidgetSettings;
-    /** @deprecated */
-    storeSettings: CDNStoreSettings;
-}
-interface CDNProductsAndSettings {
-    products: CDNProductKeyObject[];
-    widget_settings: CDNWidgetSettings;
-    store_settings: Partial<CDNStoreSettings>;
-}
-interface CDNBaseWidgetSettings {
-    active_color: ColorString;
-    auto_inject?: boolean;
-    background_color: ColorString;
-    bundle_translations?: BundleTranslations;
-    delivery_dropdown_label: string;
-    display_on: string[];
-    first_option: FirstOption;
-    font_color: ColorString;
-    form_type: string;
-    how_it_works: HTMLString;
-    learnmore_url: string;
-    learnmore_verbiage: string;
-    onetime_message: string;
-    popup_background_color: ColorString;
-    popup_link_color: ColorString;
-    popup_text_color: ColorString;
-    poweredby_url: string;
-    published: boolean;
-    select_subscription_first: boolean;
-    show_learnmore: boolean;
-    show_poweredby: boolean;
-    show_subscription_details: boolean;
-    show_subscription_details_icon: boolean;
-    sub_and_save_ext_label: string;
-    subscribe_message: string;
-    subscribe_without_discount_message: string;
-    subscription_details_verbiage: string;
-    translations: Translations;
-    widget_charge_every: string;
-    widget_deliver_every: string;
-    widget_icon: WidgetIconColor;
-    widget_template_type: WidgetTemplateType;
-}
-declare type CDNExcludedWidgetSettings = 'display_on' | 'first_option';
-interface CDNWidgetSettings extends Omit<CDNBaseWidgetSettings, CDNExcludedWidgetSettings> {
-    /** @deprecated */
-    autoInject: boolean;
-    /** @deprecated */
-    validPages: string[];
-    /** @deprecated */
-    isSubscriptionFirst: boolean;
-    auto_inject: boolean;
-    valid_pages: string[];
-    is_subscription_first: boolean;
-}
-declare type CDNWidgetSettingsRaw = {
-    [key in keyof CDNBaseWidgetSettings]: string;
-};
-interface CDNWidgetSettingsResource {
-    widget_settings: CDNWidgetSettingsRaw;
-    meta: {
-        version: string;
-    };
-}
-interface CDNStoreSettings {
-    store_currency: {
-        currency_code: string;
-        currency_symbol: string;
-        decimal_separator: string;
-        thousands_separator: string;
-        currency_symbol_location: string;
-        zero_decimal_currency?: boolean;
-    };
-}
-/****************** 2021-08 **********************/
-/**************** Bundles ****************/
-interface CDNBundleStepOption {
-    content: string;
-    defaultImage: string;
-}
-interface CDNBundleStep {
-    data?: {
-        optionsMeta: {
-            [key: string]: CDNBundleStepOption;
-        };
-    };
-    disable: boolean;
-    index: string;
-    name: string;
-    title: string;
-    type: 'variantSelector' | 'all-collections' | 'addons' | 'summary' | 'cross-sells';
-}
-interface CDNBundleLayoutSettings {
-    addToCartCallback: {
-        type: 'none';
-        value: string;
-    };
-    addons: {
-        collectionHandle: string;
-        collectionId: string;
-        enabled: boolean;
-    };
-    collapsibleSections: boolean;
-    crossSells: {
-        collectionId: string;
-        enabled: boolean;
-        collectionHandle: string;
-    };
-    defaultFrequency: string;
-    defaultVariantId: string;
-    description: string;
-    filters: any[];
-    learnMoreModal: boolean;
-    published: boolean;
-    showVariants: boolean;
-    template: 'one-page' | 'multi-step';
-    templateSettings: {
-        onePage: {
-            frequencySelector: 'dropdown';
-        };
-        multiStep?: {
-            steps: CDNBundleStep[];
-            optionImages: string;
-        };
-    };
-    title: string;
-    visibility: {
-        portal: boolean;
-        signup: boolean;
-    };
-}
-interface CDNBundleVariantOptionSource {
-    id: number;
-    collection_id: string;
-    quantity_max: number | null;
-    quantity_min: number | null;
-}
-interface CDNBundleVariantSelectionDefault {
-    id: number;
-    quantity: number;
-    external_variant_id: string;
-}
-interface CDNBundleVariant {
-    enabled: boolean;
-    external_variant_id: string;
-    id: number;
-    items_count: number;
-    option_sources: CDNBundleVariantOptionSource[];
-    selection_defaults?: CDNBundleVariantSelectionDefault[];
-}
-interface CDNBundleSettings {
-    customization_window_disabled_message: string | null;
-    customization_window?: number;
-    default_bundle_variant_id?: number;
-    description: string | null;
-    external_product_id: string;
-    id: number;
-    is_customizable?: boolean;
-    layout_settings: CDNBundleLayoutSettings;
-    layout_settings_version: '2021-11';
-    max_quantity_per_variant: number | null;
-    reset_box_contents?: boolean;
-    variants: CDNBundleVariant[];
-}
-
-interface PaymentDetails {
-    /** Payment_method brand or company powering it. valid for CREDIT_CARD only. */
-    brand?: string;
-    /** Payment_method expiry month. valid for CREDIT_CARD only. */
-    exp_month?: string;
-    /** Payment_method expiry year. valid for CREDIT_CARD only. */
-    exp_year?: string;
-    /** last 4-digits of the identifier. valid for CREDIT_CARD only. */
-    last4?: string;
-    /** email linked to paypal. valid for PAYPAL only. */
-    paypal_email?: string;
-    /** paypal user identifier. valid for PAYPAL only. */
-    paypal_payer_id?: string;
-    /** If a digital wallet. */
-    wallet_type?: string;
-    /** Type of funding for the Payment Method. */
-    funding_type?: string;
-}
-declare type PaymentType = 'CREDIT_CARD' | 'PAYPAL' | 'APPLE_PAY' | 'GOOGLE_PAY' | 'SEPA_DEBIT';
-declare type ProcessorName = 'stripe' | 'braintree' | 'authorize' | 'shopify_payments' | 'mollie';
-declare type PaymentMethodStatus = 'not_validated' | 'valid' | 'invalid';
-interface PaymentMethod {
-    /** The unique payment method id for a customer. */
-    id: number;
-    /** An object with the customer’s address information. */
-    billing_address: AssociatedAddress;
-    /** The Recharge customer_id */
-    customer_id: number;
-    /** The time the payment method was created. */
-    created_at: IsoDateString;
-    /** If this is the default payment method for the customer */
-    default: boolean;
-    /** Details about the specific payment method */
-    payment_details: PaymentDetails;
-    /**
-     * The type of payment this is.
-     * If passed, must also be accompanied by one of stripe_customer_token, paypal_customer_token or authorizedotnet_customer_token in processor_payment_method_token.
-     */
-    payment_type: PaymentType;
-    /** The customer token at the processor. */
-    processor_customer_token: string;
-    /**
-     * This will impact validation on billing_details.
-     * Currently, shopify_payments is in read-only mode and can only be managed by Shopify.
-     */
-    processor_name: ProcessorName;
-    /** The payment token at the processor. */
-    processor_payment_method_token: string;
-    /** State of the Payment Method. */
-    status: PaymentMethodStatus;
-    /**
-     * The status reason for the payment method.
-     * Often used when invalid to provide background details in invalidity.
-     */
-    status_reason: string;
-    /** The time the payment method was last updated. */
-    updated_at: IsoDateString;
-}
-interface PaymentMethodsResponse {
-    next_cursor: null | string;
-    previous_cursor: null | string;
-    payment_methods: PaymentMethod[];
-}
-declare type PaymentMethodOptionalUpdateProps = 'billing_address' | 'default';
-declare type UpdatePaymentMethodRequest = Partial<Pick<PaymentMethod, PaymentMethodOptionalUpdateProps>>;
-/** no sorting options for payment_methods, always by id-desc */
-declare type PaymentMethodSortBy = null;
-interface PaymentMethodListParams extends ListParams<PaymentMethodSortBy> {
-    customer_id?: string;
-    processor_name?: ProcessorName;
-    address_id?: string;
-    processor_payment_method_token?: string;
-}
-
-interface Subscription {
-    /** Unique numeric identifier for the subscription. */
-    id: number;
-    /** Unique numeric identifier for the address the subscription is associated with. */
-    address_id: number;
-    /** Unique numeric identifier for the customer the subscription is tied to. */
-    customer_id: number;
-    /** An object used to contain analytics data such as utm parameters. */
-    analytics_data: AnalyticsData;
-    /** Reason provided for cancellation. */
-    cancellation_reason: string | null;
-    /** Additional comment for cancellation. */
-    cancellation_reason_comments: string | null;
-    /** The time the subscription was cancelled. */
-    cancelled_at: string | null;
-    /**
-     * The number of units (specified in order_interval_unit) between each Charge. For example, order_interval_unit=month and charge_interval_frequency=3, indicate charge every 3 months.
-     * Charges must use the same unit types as orders.
-     * Max: 1000
-     */
-    charge_interval_frequency: number;
-    /** The time the subscription was created. */
-    created_at: IsoDateString;
-    /** Set the number of charges until subscription expires. */
-    expire_after_specific_number_of_charges: number | null;
-    /** An object containing the product id as it appears in external platforms. */
-    external_product_id: ExternalId;
-    /** An object containing the variant id as it appears in external platforms. */
-    external_variant_id: ExternalId;
-    /** Retrieves true if there is queued charge. Otherwise, retrieves false. */
-    has_queued_charges: boolean;
-    /** Value is set to true if it is a prepaid item. */
-    is_prepaid: boolean;
-    /** Value is set to true if it is not a prepaid item */
-    is_skippable: boolean;
-    /** Value is set to true if it is not a prepaid item and if in Customer portal settings swap is allowed for customers. */
-    is_swappable: boolean;
-    /** Retrieves true if charge has an error max retries reached. Otherwise, retrieves false. */
-    max_retries_reached: boolean;
-    /** Date of the next charge for the subscription. */
-    next_charge_scheduled_at: IsoDateString;
-    /**
-     * The set day of the month order is created. Default is that there isn’t a strict day of the month when the order is created.
-     * This is only applicable to subscriptions with order_interval_unit:“month”.
-     */
-    order_day_of_month: number | null;
-    /**
-     * The set day of the week order is created. Default is that there isn’t a strict day of the week order is created.
-     * This is only applicable to subscriptions with order_interval_unit = “week”.
-     * Value of 0 equals to Monday, 1 to Tuesday etc.
-     */
-    order_day_of_week: number | null;
-    /**
-     * The number of units (specified in order_interval_unit) between each order. For example, order_interval_unit=month and order_interval_frequency=3, indicate order every 3 months. Max value: 1000
-     */
-    order_interval_frequency: number;
-    /** The frequency unit used to determine when a subscription’s order is created. */
-    order_interval_unit: 'day' | 'week' | 'month';
-    /** The presentment currency of the subscription. */
-    presentment_currency: string | null;
-    /** The price of the item before discounts, taxes, or shipping have been applied. */
-    price: string;
-    /** The name of the product in a store’s catalog. */
-    product_title: string | null;
-    /** A list of line item objects, each one containing information about the subscription. Custom key-value pairs can be installed here, they will appear on the connected queued charge and after it is processed on the order itself. */
-    properties: Property[];
-    /** The number of items in the subscription. */
-    quantity: number;
-    /** A unique identifier of the item in the fulfillment. In cases where SKU is blank, it will be dynamically pulled whenever it is used. */
-    sku: string | null;
-    /** Flag that is automatically updated to true when SKU is passed on create or update. When sku_override is true, the SKU on the subscription will be used to generate charges and orders. When sku_override is false, Recharge will dynamically fetch the SKU from the corresponding external platform variant. */
-    sku_override: boolean;
-    /**
-     * The status of the subscription.
-     * expired - This status occurs when the maximum number of charges for a product has been reached.
-     */
-    status: 'active' | 'cancelled' | 'expired';
-    /** The date time at which the purchase_item record was last updated. */
-    updated_at: IsoDateString;
-    /** The name of the variant in a shop’s catalog. */
-    variant_title: string;
-}
-interface SubscriptionsResponse {
-    next_cursor: null | string;
-    previous_cursor: null | string;
-    subscriptions: Subscription[];
-}
-declare type SubscriptionSortBy = 'id-asc' | 'id-desc' | 'created_at-asc' | 'created_at-desc' | 'updated_at-asc' | 'updated_at-desc';
-interface SubscriptionListParams extends ListParams<SubscriptionSortBy> {
-    created_at_min?: IsoDateString;
-    created_at_max?: IsoDateString;
-    customer_id?: string;
-}
-declare type SubscriptionRequiredCreateProps = 'address_id' | 'charge_interval_frequency' | 'external_variant_id' | 'next_charge_scheduled_at' | 'order_interval_frequency' | 'order_interval_unit' | 'quantity';
-declare type SubscriptionOptionalCreateProps = 'expire_after_specific_number_of_charges' | 'order_day_of_month' | 'order_day_of_week' | 'external_product_id' | 'product_title' | 'properties' | 'status';
-declare type CreateSubscriptionRequest = SubType<Subscription, SubscriptionRequiredCreateProps, SubscriptionOptionalCreateProps>;
-declare type SubscriptionOptionalUpdateProps = 'charge_interval_frequency' | 'expire_after_specific_number_of_charges' | 'order_day_of_month' | 'order_day_of_week' | 'order_interval_frequency' | 'order_interval_unit' | 'quantity' | 'external_product_id' | 'external_variant_id' | 'properties' | 'sku' | 'sku_override';
-declare type UpdateSubscriptionRequest = Partial<Pick<Subscription, SubscriptionOptionalUpdateProps>>;
-interface UpdateSubscriptionParams {
-    /** Controls whether the QUEUED charges linked to the subscription should be regenerated upon subscription update. By default the flag is set to false which will delay charge regeneration 5 seconds. This enables running multiple calls to perform changes and receive responses much faster since the API won’t wait for a charge regeneration to complete. Setting this parameter to true will cause charge regeneration to complete before returning a response. */
-    commit?: boolean;
-}
-interface CancelSubscriptionRequest {
-    cancellation_reason: string;
-    cancellation_reason_comments?: string;
-    send_email?: boolean;
-}
-
-declare type CustomerIncludes = 'addresses' | 'payment_methods' | 'subscriptions';
-interface GetCustomerOptions {
-    include: CustomerIncludes[];
-}
-interface Customer {
-    /** Unique numeric identifier for the Customer. */
-    id: number;
-    /** An object containing analytics data associated with the customer. */
-    analytics_data: AnalyticsData;
-    /** The date and time when the customer was created. */
-    created_at: IsoDateString;
-    /** The email address of the customer. */
-    email: string;
-    /** An object containing external ids for the customer record. */
-    external_customer_id: ExternalId;
-    /** Date when first charge was processed for the customer. */
-    first_charge_processed_at: IsoDateString;
-    /** The customer’s first name. */
-    first_name: string;
-    /** A boolean that indicates if the customer has a payment method that is in dunning (failed charge). */
-    has_payment_method_in_dunning: boolean;
-    /** Is the payment method valid or not. */
-    has_valid_payment_method: boolean;
-    /** The unique string identifier used in a customers portal link. */
-    hash: string;
-    /** The customer’s last name. */
-    last_name: string;
-    /** The number of active subscriptions on addresses associated with the customer. */
-    subscriptions_active_count: number;
-    /** The total number of subscriptions created on addresses associated with the customer. */
-    subscriptions_total_count: number;
-    /** The date and time when the customer was last updated. */
-    updated_at: IsoDateString;
-    /** Additional information as requested */
-    include?: {
-        addresses?: Address[];
-        payment_methods?: PaymentMethod[];
-        subscriptions?: Subscription[];
-    };
-}
-declare type CustomerOptionalUpdateProps = 'email' | 'first_name' | 'last_name' | 'external_customer_id';
-declare type UpdateCustomerRequest = Partial<Pick<Customer, CustomerOptionalUpdateProps>>;
-interface CustomerDeliveryScheduleParams {
-    delivery_count_future?: number;
-    future_internal?: number;
-    date_max?: IsoDateString;
-}
-interface Delivery {
-    date: IsoDateString;
-    orders: Order[];
-}
-interface CustomerDeliveryScheduleResponse {
-    customer: {
-        id: number;
-        email: string;
-        first_name: string;
-        last_name: string;
-    };
-    deliveries: Delivery[];
-}
-
-/** @internal */
-declare type MembershipStatus = 'active' | 'inactive';
-/** @internal */
-interface Membership {
-    id: string;
-    store_id: number;
-    customer_id: number;
-    membership_program_id: number;
-    purchase_item_id: number | null;
-    status: MembershipStatus;
-    created_at: IsoDateString;
-    deleted_at: IsoDateString | null;
-    expires_at: IsoDateString | null;
-    subscription_cancelled_at: IsoDateString | null;
-    image?: string;
-}
-/** @internal */
-interface MembershipResponse {
-    membership: Membership;
-}
-/** @internal */
-interface MembershipListResponse {
-    next_cursor: null | string;
-    previous_cursor: null | string;
-    memberships: Membership[];
-}
-/** @internal */
-declare type MembershipsSortBy = 'id-asc' | 'id-desc';
-/** @internal */
-declare type membershipIncludes = 'customer' | 'subscriptions';
-/** @internal */
-declare type MembershipIncludes = `${membershipIncludes}` | `${membershipIncludes},${membershipIncludes}`;
-/** @internal */
-interface MembershipListParams extends ListParams<MembershipsSortBy> {
-    include?: MembershipIncludes;
-    customer_id?: number;
-    customer_name?: string;
-    customer_email?: string;
-    membership_program_ids?: string;
-    status?: MembershipStatus;
-    created_at_min?: IsoDateString;
-    created_at_max?: IsoDateString;
-    expires_at_min?: IsoDateString;
-    expires_at_max?: IsoDateString;
-    include_cancelled?: boolean;
-    include_deleted?: boolean;
-}
-/** @internal */
-interface ActivateMembershipRequest {
-    expires_at: string | null;
-}
-/** @internal */
-interface CancelMembershipRequest {
-    cancel_immediately: boolean;
-    cancellation_reason: string;
-    cancellation_reason_comments: string;
-    expires_at: IsoDateString;
-}
-
-interface Onetime {
-    /** Unique numeric identifier for the Onetime purchase. */
-    id: number;
-    /** Unique numeric identifier for the address the Onetime Purchase is associated with (cannot be used with next_charge_scheduled_at) */
-    address_id: number;
-    /** The time the Onetime item was first created. */
-    created_at: IsoDateString;
-    /** Unique numeric identifier for the customer the Onetime purchase is tied to. */
-    customer_id: number;
-    /** An object containing the product id as it appears in external platforms. */
-    external_product_id: ExternalId;
-    /** An object containing the variant id as it appears in external platforms. */
-    external_variant_id: ExternalId;
-    /** Flag indicating if the the onetime is cancelled. */
-    is_cancelled: boolean;
-    /**
-     * Date of the Onetime purchase execution.
-     * Cannot be used with add_to_next_charge
-     */
-    next_charge_scheduled_at: IsoDateString;
-    /** The price of the item before discounts, taxes, or shipping have been applied. */
-    price: string;
-    /** The name of the product in a shop’s catalog. */
-    product_title: string;
-    /** An array containing key value pairs for any supplementary data. */
-    properties: Property[];
-    /** The number of items in the Onetime purchase. */
-    quantity: number;
-    /** A unique identifier of the item in the fulfillment. */
-    sku: string;
-    /** Flag that is automatically updated to true when SKU is passed on POST or PUT. */
-    sku_override: boolean;
-    /** The time the Onetime purchase was last updated. */
-    updated_at: IsoDateString;
-    /** The name of the variant in a shop’s catalog. */
-    variant_title: string;
-    /** Presentment currency */
-    presentment_currency: string | null;
-}
-declare type OnetimeRequiredCreateProps = 'address_id' | 'external_variant_id' | 'next_charge_scheduled_at' | 'product_title' | 'quantity';
-declare type OnetimeOptionalCreateProps = 'external_product_id' | 'properties' | 'sku';
-interface OnetimeCreateProps {
-    /** Instructs to add the Onetime to the next charge scheduled under this Address. */
-    add_to_next_charge?: boolean;
-}
-declare type CreateOnetimeRequest = SubType<Onetime, OnetimeRequiredCreateProps, OnetimeOptionalCreateProps> & OnetimeCreateProps;
-declare type OnetimeOptionalUpdateProps = 'address_id' | 'next_charge_scheduled_at' | 'properties' | 'quantity' | 'external_variant_id' | 'sku';
-declare type UpdateOnetimeRequest = Partial<Pick<Onetime, OnetimeOptionalUpdateProps>>;
-interface OnetimesResponse {
-    next_cursor: null | string;
-    previous_cursor: null | string;
-    onetimes: Onetime[];
-}
-declare type OnetimesSortBy = 'id-asc' | 'id-desc' | 'created_at-asc' | 'created_at-desc' | 'updated_at-asc' | 'updated_at-desc';
-declare type OnetimeListParams = ListParams<OnetimesSortBy>;
-
-/** @internal */
-declare type StorefrontEnvironment = 'stage' | 'prod';
-/** @internal */
-interface StorefrontOptions {
-    storeIdentifier: string;
-    /** Recharge storefront access token */
-    storefrontAccessToken?: string;
-    /** This is only for internal use. Sets the environment where data is fetched from. */
-    environment: StorefrontEnvironment;
-}
-interface InitOptions {
-    storeIdentifier?: string;
-    /** Recharge storefront access token */
-    storefrontAccessToken?: string;
-}
-
-interface ChannelSettings {
-    api: {
-        display: boolean;
-    };
-    checkout_page: {
-        display: boolean;
-    };
-    customer_portal: {
-        display: boolean;
-    };
-    merchant_portal: {
-        display: boolean;
-    };
-}
-interface SubscriptionPreferences {
-    charge_interval_frequency: number;
-    cutoff_day_of_month: null | number;
-    cutoff_day_of_week: null | number;
-    expire_after_specific_number_of_charges: null | number;
-    interval_unit: 'day' | 'week' | 'month';
-    order_day_of_month: number;
-    order_day_of_week: null | number;
-    order_interval_frequency: number;
-}
-declare type PlanType = 'subscription' | 'prepaid' | 'onetime';
-interface Plan {
-    /** Unique numeric identifier for the Plan. */
-    id: number;
-    /** An object containing the availability of the plan through various supported channels. */
-    channel_settings: ChannelSettings;
-    /** The time the plan was created. */
-    created_at: IsoDateString;
-    /** If deleted, the time the plan was deleted. */
-    deleted_at: IsoDateString;
-    /** The discount amount applied to the product price when purchased through this Plan. All Plans for a product must have the same discount amount. */
-    discount_amount: string;
-    /** Used in combination with discount amount to determine the discount applied on a product price when purchased through this Plan. */
-    discount_type: 'percentage';
-    /** An object containing the product id as it appears in external platforms. */
-    external_product_id: ExternalId;
-    /** The number indicating the order which the plan will be in a list of related plans. */
-    sort_order: number;
-    /** An object containing the various subscription preferences associated with this plan. */
-    subscription_preferences: SubscriptionPreferences;
-    /** The title of the plan. All Plans for a product must have the same title. */
-    title: string;
-    /** The type of the plan. Products with a prepaid plan cannot have plans of other types. */
-    type: PlanType;
-    /** The time the plan was last updated. */
-    updated_at: IsoDateString;
-}
-interface PlansResponse {
-    next_cursor: null | string;
-    previous_cursor: null | string;
-    plans: Plan[];
-}
-declare type PlanSortBy = 'id-asc' | 'id-desc' | 'updated_at-asc' | 'updated_at-desc';
-interface PlanListParams extends ListParams<PlanSortBy> {
-    external_product_id?: string;
-    updated_at_max?: IsoDateString;
-    updated_at_min?: IsoDateString;
-    type?: PlanType;
-}
-
-declare function getCDNProduct(externalProductId: string | number): Promise<CDNProduct>;
-declare function getCDNStoreSettings(): Promise<CDNStoreSettings>;
-declare function getCDNWidgetSettings(): Promise<CDNWidgetSettings>;
-declare function getCDNProductsAndSettings(): Promise<CDNProductsAndSettings>;
-declare function getCDNProducts(): Promise<CDNProductKeyObject[]>;
-declare function getCDNProductAndSettings(externalProductId: string | number): Promise<CDNProductAndSettings>;
-declare function getCDNBundleSettings(externalProductId: string | number): Promise<CDNBundleSettings | null | undefined>;
-declare function resetCDNCache(): Promise<void>;
-
-declare function getBundleId(bundle: Bundle): Promise<string>;
-declare function validateBundle(bundle: Bundle): Promise<boolean>;
-
-/** @internal Retrieves membership information for passed in id */
-declare function getMembership(session: Session, id: string | number): Promise<Membership>;
-/** @internal Retrieves a list of memberships */
-declare function listMemberships(session: Session, query?: MembershipListParams): Promise<MembershipListResponse>;
-/** @internal Cancels a membership */
-declare function cancelMembership(session: Session, id: string | number, cancelRequest: CancelMembershipRequest): Promise<Membership>;
-/** @internal Activates a membership */
-declare function activateMembership(session: Session, id: string | number, activateRequest: ActivateMembershipRequest): Promise<Membership>;
-
-declare function getOnetime(session: Session, id: string | number): Promise<Onetime>;
-declare function listOnetimes(session: Session, query?: OnetimeListParams): Promise<OnetimesResponse>;
-declare function createOnetime(session: Session, createRequest: CreateOnetimeRequest): Promise<Onetime>;
-declare function updateOnetime(session: Session, id: string | number, updateRequest: UpdateOnetimeRequest): Promise<Onetime>;
-declare function deleteOnetime(session: Session, id: string | number): Promise<void>;
-
-declare function getOrder(session: Session, id: string | number): Promise<Order>;
-declare function listOrders(session: Session, query?: OrderListParams): Promise<OrdersResponse>;
-
-declare function getPaymentMethod(session: Session, id: string | number): Promise<PaymentMethod>;
-declare function updatePaymentMethod(session: Session, id: string | number, updateRequest: UpdatePaymentMethodRequest): Promise<PaymentMethod>;
-declare function listPaymentMethods(session: Session, query?: PaymentMethodListParams): Promise<PaymentMethodsResponse>;
-
-declare function getPlan(session: Session, id: string | number): Promise<Plan>;
-declare function listPlans(session: Session, query?: PlanListParams): Promise<PlansResponse>;
-
-declare function getSubscription(session: Session, id: string | number): Promise<Subscription>;
-declare function listSubscriptions(session: Session, query?: SubscriptionListParams): Promise<SubscriptionsResponse>;
-/**
- * When creating a subscription via API, order_interval_frequency and charge_interval_frequency values do not necessarily
- * need to match the values set in the respective Plans. The product, however, does need to have at least one Plan in order
- * to be added to a subscription.
- */
-declare function createSubscription(session: Session, createRequest: CreateSubscriptionRequest): Promise<Subscription>;
-/**
- * Updating parameters like frequency, charge_interval_frequency, order_interval_frequency, order_interval_unit will cause our algorithm to automatically recalculate the next charge date (next_charge_scheduled_at).
- * WARNING: This update will remove skipped and manually changed charges.
- * If you want to change the next charge date (next_charge_scheduled_at) we recommend you to update these parameters first.
- * When updating order_interval_unit OR order_interval_frequency OR charge_interval_frequency all three parameters are required.
- */
-declare function updateSubscription(session: Session, id: string | number, updateRequest: UpdateSubscriptionRequest, query?: UpdateSubscriptionParams): Promise<Subscription>;
-/**
- * If there are two active subscriptions with the same address_id, and you update their
- * next_charge_date parameters to match, their charges will get merged into a new charge
- * with a new id
- */
-declare function updateSubscriptionChargeDate(session: Session, id: string | number, date: IsoDateString): Promise<Subscription>;
-declare function updateSubscriptionAddress(session: Session, id: string | number, address_id: string | number): Promise<Subscription>;
-/**
- * An involuntary subscription cancelled due to max retries reached will trigger the
- * charge/max_retries_reached webhook. If this leads to the subscription being cancelled,
- * the subscription/cancelled webhook will trigger.
- */
-declare function cancelSubscription(session: Session, id: string | number, cancelRequest: CancelSubscriptionRequest): Promise<Subscription>;
-/**
- * When activating subscription, following attributes will be set to null: cancelled_at, cancellation_reason
- * and cancellation_reason_comments.
- */
-declare function activateSubscription(session: Session, id: string | number): Promise<Subscription>;
-declare function skipSubscriptionCharge(session: Session, id: number | string, date: IsoDateString): Promise<Charge>;
-
-declare function getCustomer(session: Session, options?: GetCustomerOptions): Promise<Customer>;
-declare function updateCustomer(session: Session, updateRequest: UpdateCustomerRequest): Promise<Customer>;
-declare function getDeliverySchedule(session: Session, query?: CustomerDeliveryScheduleParams): Promise<Delivery[]>;
-
-declare const api: {
-    get<T>(url: string, requestOptions?: GetRequestOptions): Promise<T>;
-    post<T_1>(url: string, requestOptions?: CRUDRequestOptions): Promise<T_1>;
-    put<T_2>(url: string, requestOptions?: CRUDRequestOptions): Promise<T_2>;
-    delete<T_3>(url: string, requestOptions?: CRUDRequestOptions): Promise<T_3>;
-};
-declare function initRecharge(opt?: InitOptions): void;
-
-export { ActivateMembershipRequest, Address, AddressListParams, AddressListResponse, AddressResponse, AddressSortBy, AnalyticsData, ApplyDiscountRequest, AssociatedAddress, Bundle, BundleSelection, BundleTranslations, CDNBaseWidgetSettings, CDNBundleLayoutSettings, CDNBundleSettings, CDNBundleStep, CDNBundleStepOption, CDNBundleVariant, CDNBundleVariantOptionSource, CDNBundleVariantSelectionDefault, CDNPrices, CDNProduct, CDNProductAndSettings, CDNProductKeyObject, CDNProductOption, CDNProductOptionValue, CDNProductRaw, CDNProductResource, CDNProductsAndSettings, CDNProductsAndSettingsResource, CDNSellingPlan, CDNSellingPlanAllocations, CDNSellingPlanGroup, CDNStoreSettings, CDNSubscriptionOption, CDNVariant, CDNVariantOptionValue, CDNWidgetSettings, CDNWidgetSettingsRaw, CDNWidgetSettingsResource, CRUDRequestOptions, CancelMembershipRequest, CancelSubscriptionRequest, ChannelSettings, Charge, ChargeListParams, ChargeListResponse, ChargeResponse, ChargeSortBy, ChargeStatus, ColorString, CreateAddressRequest, CreateOnetimeRequest, CreateSubscriptionRequest, Customer, CustomerDeliveryScheduleParams, CustomerDeliveryScheduleResponse, CustomerIncludes, CustomerOptionalUpdateProps, Delivery, Discount, ExternalId, ExternalTransactionId, FirstOption, GetCustomerOptions, GetRequestOptions, HTMLString, InitOptions, IntervalUnit, IsoDateString, LineItem, ListParams, LoginResponse, Membership, MembershipIncludes, MembershipListParams, MembershipListResponse, MembershipResponse, MembershipStatus, MembershipsSortBy, MergeAddressesRequest, Method, Onetime, OnetimeCreateProps, OnetimeListParams, OnetimeOptionalCreateProps, OnetimeOptionalUpdateProps, OnetimeRequiredCreateProps, OnetimesResponse, OnetimesSortBy, Order, OrderListParams, OrderSortBy, OrderStatus, OrderType, OrdersResponse, PaymentDetails, PaymentMethod, PaymentMethodListParams, PaymentMethodOptionalUpdateProps, PaymentMethodSortBy, PaymentMethodStatus, PaymentMethodsResponse, PaymentType, Plan, PlanListParams, PlanSortBy, PlanType, PlansResponse, PriceAdjustmentsType, ProcessorName, ProductImage, Property, Request, RequestHeaders, RequestOptions, RequestOptionsHeaders, Session, ShippingLine, SkipFutureChargeAddressRequest, SkipFutureChargeAddressResponse, StorefrontEnvironment, StorefrontOptions, StorefrontPurchaseOption, SubType, Subscription, SubscriptionListParams, SubscriptionOptionalCreateProps, SubscriptionOptionalUpdateProps, SubscriptionPreferences, SubscriptionRequiredCreateProps, SubscriptionSortBy, SubscriptionsResponse, TaxLine, Translations, UpdateAddressRequest, UpdateCustomerRequest, UpdateOnetimeRequest, UpdatePaymentMethodRequest, UpdateSubscriptionParams, UpdateSubscriptionRequest, WidgetIconColor, WidgetTemplateType, activateMembership, activateSubscription, api, applyDiscount, cancelMembership, cancelSubscription, createAddress, createOnetime, createSubscription, deleteAddress, deleteOnetime, getAddress, getBundleId, getCDNBundleSettings, getCDNProduct, getCDNProductAndSettings, getCDNProducts, getCDNProductsAndSettings, getCDNStoreSettings, getCDNWidgetSettings, getCharge, getCustomer, getDeliverySchedule, getMembership, getOnetime, getOrder, getPaymentMethod, getPlan, getSubscription, initRecharge, listAddresses, listCharges, listMemberships, listOnetimes, listOrders, listPaymentMethods, listPlans, listSubscriptions, loginShopifyApi, loginShopifyAppProxy, membershipIncludes, mergeAddresses, removeDiscount, resetCDNCache, skipCharge, skipFutureCharge, skipSubscriptionCharge, unskipCharge, updateAddress, updateCustomer, updateOnetime, updatePaymentMethod, updateSubscription, updateSubscriptionAddress, updateSubscriptionChargeDate, validateBundle };