@rechargeapps/storefront-client 1.7.0 → 1.8.0

package/dist/index.d.ts

@@ -1,3 +1,80 @@
+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;
+}
+type PlanType = 'prepaid' | 'subscription' | 'onetime' | 'membership_subscription';
+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: DiscountType;
+    /** External plan group id */
+    external_plan_group_id: number | null;
+    /** External plan id */
+    external_plan_id: number | null;
+    /** External plan name */
+    external_plan_name: string | null;
+    /** An object containing the product id as it appears in external platforms. */
+    external_product_id: ExternalId;
+    /** External variant ids related to this plan */
+    external_variant_ids: number[] | null;
+    has_variant_restrictions: boolean;
+    /** 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[];
+}
+type PlanSortBy = 'id-asc' | 'id-desc' | 'updated_at-asc' | 'updated_at-desc';
+interface PlanListParams extends ListParams<PlanSortBy> {
+    /** Return the Plans linked to the Product record in Recharge with the indicated external_product_id */
+    external_product_id?: string | number;
+    /** Return the plans updated before the given date. */
+    updated_at_max?: IsoDateString;
+    /** Return the plans updated after the given date. */
+    updated_at_min?: IsoDateString;
+    /** Return the plans that are of a specific type. */
+    type?: PlanType;
+}
+
 /** HEXA, RGBA, HSLA */
 type ColorString = string;
 /** HTML String */
@@ -65,7 +142,7 @@ interface LineItem {
     /** 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';
+    purchase_item_type: PlanType;
     /** The quantity of the line_item. */
     quantity: number;
     /** The SKU (stock keeping unit) of the Product associated with the line_item. */
@@ -97,6 +174,7 @@ interface TaxLine {
     /** The title/name of the taxing jurisdiction. */
     title: string;
 }
+type DiscountType = 'percentage' | 'fixed_amount' | 'shipping';
 interface Discount {
     /** The ID of the Discount. */
     id: number;
@@ -105,7 +183,7 @@ interface Discount {
     /** The value of the Discount. */
     value?: number;
     /** The type of the value of the Discount. */
-    value_type?: 'percentage' | 'fixed_amount' | 'shipping';
+    value_type?: DiscountType;
 }
 interface AnalyticsData {
     utm_params: {
@@ -344,8 +422,8 @@ interface BundlePurchaseItemParams {
 }
 
 interface AddonSettings {
-    collectionId: string;
     collectionHandle: string;
+    collectionId: string;
     enabled: boolean;
 }
 interface AddToCartCallbackSettings {
@@ -458,6 +536,7 @@ interface BundleVariant {
     created_at: IsoDateString;
 }
 interface BundleProduct {
+    created_at: IsoDateString;
     custom_prices: boolean;
     customization_window_disabled_message: string | null;
     customization_window: number | null;
@@ -466,15 +545,14 @@ interface BundleProduct {
     external_product_id: string;
     id: number;
     is_customizable: boolean;
+    layout_settings: BundleProductLayoutSettings;
     layout_settings_version: '2021-11';
     max_quantity_per_variant: number | null;
+    price_rule: BundlePriceRule | null;
     reset_box_contents: boolean;
     title: string;
     updated_at: IsoDateString;
-    created_at: IsoDateString;
-    layout_settings: BundleProductLayoutSettings;
     variants: BundleVariant[];
-    price_rule: BundlePriceRule | null;
 }
 
 type SubscriptionStatus = 'active' | 'cancelled' | 'expired';
@@ -670,6 +748,9 @@ interface Subscription_2021_01 {
     status: 'ACTIVE' | 'CANCELLED' | 'EXPIRED';
 }
 
+type CustomerNotification = 'SHOPIFY_UPDATE_PAYMENT_INFO';
+type CustomerNotificationType = 'email' | 'sms';
+type CustomerNotificationTemplate = 'shopify_update_payment_information';
 type CustomerIncludes = 'addresses' | 'metafields' | 'payment_methods' | 'subscriptions';
 interface GetCustomerOptions {
     include?: CustomerIncludes[];
@@ -724,7 +805,7 @@ interface DeliveryLineItem extends Omit<LineItem, 'external_inventory_policy' |
     /** Value is set to true if the order is skipped. */
     is_skipped: boolean;
     /** The type of the plan. May return null value in certain cases. */
-    plan_type: 'subscription' | 'onetime';
+    plan_type: PlanType;
     /** Value is set to true if it is a prepaid item */
     is_prepaid: boolean;
     /** The name of the product in a store’s catalog. */
@@ -1313,9 +1394,379 @@ interface RequestOptions extends GetRequestOptions, CRUDRequestOptions {
     headers?: RequestHeaders;
 }
 
-type FirstOption = 'onetime' | 'autodeliver';
-type PriceAdjustmentsType = 'percentage';
+type ProductInclude = 'collections';
+type ProductSource = 'all' | 'in_recharge' | 'not_in_recharge';
+type PublishStatus = 'published' | 'unpublished' | 'any';
 type StorefrontPurchaseOption = 'subscription_and_onetime' | 'subscription_only' | 'onetime_only' | 'inactive';
+interface ProductValueOption {
+    id?: number | null;
+    label: string;
+    position?: number;
+}
+interface ProductOption {
+    id: number;
+    name: string;
+    position: number;
+    values: ProductValueOption[];
+}
+interface Modifier {
+    id: number;
+    type: 'dropdown' | 'multiple_choice' | 'radio_buttons' | 'rectangles' | 'checkbox' | 'text' | 'multi_line_text';
+    name: 'Subscribe' | string;
+    required: boolean;
+    option_values: {
+        id: number;
+        label: string;
+    }[];
+}
+interface SellingPlan {
+    created_at?: IsoDateString;
+    id: number;
+    order_interval_frequency: number;
+    order_interval_unit_type: IntervalUnit;
+    price_adjustments_value: number;
+    price_adjustments_value_type: 'percentage';
+    selling_plan_id: number;
+    selling_plan_name: string;
+    updated_at?: IsoDateString;
+}
+interface SellingPlanGroup {
+    selling_plan_group_id: string | number;
+    selling_plans: SellingPlan[];
+    subscription_product_id: number;
+}
+interface SubscriptionOption {
+    charge_interval_frequency: number | null;
+    cutoff_day_of_month: number | null;
+    cutoff_day_of_week: number | null;
+    expire_after_specific_number_of_charges: number | null;
+    is_prepaid: boolean;
+    modifiable_properties: string[];
+    number_charges_until_expiration: number | null;
+    order_day_of_month: number | null;
+    order_day_of_week: number | null;
+    order_interval_frequency_options: string[];
+    order_interval_unit: 'day' | 'week' | 'month';
+    storefront_purchase_options: StorefrontPurchaseOption;
+    updated_at: IsoDateString;
+}
+interface ProductVariant_2020_12 {
+    external_metafields: Record<string, unknown>;
+    external_product_id: number;
+    fulfillment_service: 'manual';
+    id: number;
+    image?: ProductImage;
+    inventory: {
+        inventory_level: number;
+        inventory_policy: 'deny' | string;
+        inventory_tracking: 'shopify' | string;
+    };
+    is_deleted: boolean;
+    is_published: boolean;
+    option_values: ProductValueOption[];
+    price_includes_tax: boolean;
+    prices: {
+        compare_at_price: string | null;
+        discounted_price: string;
+        unit_price: string;
+        zero_decimal_currency: boolean;
+        prices?: [
+            {
+                presentment_prices: {
+                    currency: string;
+                    discounted_price: string;
+                    unit_price: string;
+                }[];
+            }
+        ];
+    };
+    product_id: number;
+    requires_shipping: boolean;
+    selling_plan_allocations: {
+        selling_plan_group_id: string | number;
+        selling_plan_id: number;
+        discounted_price: string;
+    }[];
+    shipping_dimensions: {
+        depth: string;
+        height: string;
+        weight: number;
+        weight_unit: string;
+        width: string;
+    };
+    sku: string;
+    tax_code: string;
+    taxable: boolean;
+    title: string;
+}
+interface Product_2020_12 {
+    brand: string;
+    bundle_product: BundleProduct | null;
+    collection_ids: number[];
+    description: string;
+    discount_amount: number;
+    discount_type: DiscountType;
+    external_created_at: IsoDateString;
+    external_metafields: Record<string, unknown>;
+    external_product_id: number;
+    external_updated_at: IsoDateString;
+    handle: string | null;
+    id: number;
+    images: ProductImage[];
+    in_recharge: boolean;
+    is_deleted: boolean;
+    is_published: boolean;
+    minimum_variant_price: string;
+    modifiers: Modifier[];
+    more_than_one_price: boolean;
+    options: ProductOption[];
+    published_at: IsoDateString;
+    requires_shipping: boolean;
+    selling_plan_groups: SellingPlanGroup[];
+    subscription_options: SubscriptionOption;
+    tags: string[];
+    title: string;
+    type: string;
+    variants: ProductVariant_2020_12[];
+    vendor: string;
+}
+interface ProductVariant_2022_06 {
+    external_metafields: Record<string, unknown>;
+    external_product_id: string;
+    external_variant_id: string;
+    fulfillment_service: 'manual';
+    image?: ProductImage;
+    inventory: {
+        level: number;
+        policy: 'deny' | string;
+        tracking: 'shopify' | string;
+    };
+    is_deleted: boolean;
+    is_published: boolean;
+    option_values: string[];
+    price_includes_tax: boolean;
+    prices: {
+        compare_at_price: null | unknown;
+        currency: string;
+        plans: {
+            discount_value: string;
+            discounted_price: string;
+            id: number;
+        }[];
+        unit_price: string;
+    };
+    requires_shipping: boolean;
+    shipping_dimensions: {
+        depth: string | null;
+        height: string | null;
+        weight: number;
+        weight_unit: string;
+        width: string | null;
+    };
+    sku: string | null;
+    tax_code: string | null;
+    taxable: boolean;
+    title: string;
+}
+interface Product_2022_06 {
+    brand: string | null;
+    bundle_product_id: number | null;
+    collections: {
+        id: number;
+        position: unknown | null;
+    }[];
+    description: string | null;
+    external_created_at: IsoDateString;
+    external_metafields: Record<string, unknown>;
+    external_plan_group_id: number | null;
+    external_product_id: string;
+    external_updated_at: IsoDateString;
+    handle: string;
+    has_plans: boolean;
+    images: ProductImage[];
+    is_deleted: boolean;
+    is_published: boolean;
+    minimum_variant_prices: {
+        currency: string;
+        price: string;
+    }[];
+    modifiers: Modifier[];
+    more_than_one_price: boolean;
+    options: ProductOption[];
+    plans: Plan[];
+    published_at: IsoDateString;
+    requires_shipping: boolean;
+    store_id: number;
+    tags: string[];
+    title: string;
+    type: string | null;
+    variants: ProductVariant_2022_06[];
+    vendor: string;
+}
+interface ProductSearchResponse_2020_12 {
+    products: Product_2020_12[];
+    has_more: boolean;
+    total: number;
+}
+interface ProductSearchResponse_2022_06 {
+    products: Product_2022_06[];
+    total: number;
+    next_cursor: null | string;
+    previous_cursor: null | string;
+}
+interface ProductSearchParams_2020_12 {
+    /** Query by collection id, these are ReCharge collection_id’s. */
+    collection_ids?: (string | number)[];
+    /** If true, do NOT include products where subscription_options.is_prepaid is false. If true, ignore the value in subscription_options.is_prepaid. */
+    exclude_prepaids?: boolean;
+    /** Query by product id, these are external product id’s. */
+    external_product_ids?: (string | number)[];
+    /** Specifies the product format of the response. */
+    format_type?: 'vendor' | 'recharge';
+    /** Required. Product search version. */
+    format_version: '2020-12';
+    /** Whether to include deleted results, default false */
+    include_deleted?: boolean;
+    /** default is 50, max is 250 */
+    limit?: number;
+    /** Ignore given collection ids */
+    not_collection_ids?: (string | number)[];
+    /** Ignore given product ids */
+    not_product_ids?: (string | number)[];
+    /** Specifies the page of results to return for a query. Defaults to 1. */
+    page?: number;
+    /** Query by product id, these are ReCharge product_id’s. */
+    product_ids?: (string | number)[];
+    /** Return all products that have a matching type */
+    product_types?: PlanType[];
+    /** External platform published status. */
+    published_status?: PublishStatus;
+    /** Determines the sort order. Default is elasticsearch’s score. If sort_by = title, results will be sorted by the product title in ascending order. */
+    sort_by?: 'score' | 'title';
+    /** Query by source */
+    source?: ProductSource;
+    /** string representing at least 3 characters of the product title being queried. Should perform a like search ('%{querytext}%') */
+    title?: string;
+    /** Query by variant id, these are external variant ids */
+    variant_ids?: (string | number)[];
+    /**
+     * External platform published status for the variant. This really only comes into play with BigCommerce because in BC you can set purchaseability at the variant-level.
+     * If variant_published_status=published, the product-proxy's response only includes variants where variants[].is_published=true.
+     * If variant_published_status=unpublished, the product-proxy's response only includes variants where variants[].is_published=false.
+     * If variant_published_status=any, the product-proxy's response includes all variants irrespective of the value for variants[].is_published.
+     */
+    variant_published_status?: PublishStatus;
+}
+type SortField = 'external_product_id' | 'collection_position' | 'relevance' | 'product_title' | 'unit_price' | 'discounted_price' | 'minimum_variant_price' | 'inventory_level' | 'created_at' | 'updated_at';
+type SortKeys = 'asc' | 'desc';
+type SortBy = `${SortField}-${SortKeys}`;
+interface ProductSearchParams_2022_06 extends ListParams<SortBy> {
+    /** Return all products that have at least one non-deleted plan with a matching channel_setting{}.display set to true. */
+    channel_settings_display?: (keyof ChannelSettings)[];
+    /** Return products that are present in any of the passed in collection IDs. */
+    collection_ids?: (string | number)[];
+    /** Ignore given collection ids */
+    collection_ids_not?: (string | number)[];
+    /** Query on created_at. '<' */
+    created_at_lt?: IsoDateString;
+    /** Query on created_at. '<=' */
+    created_at_lte?: IsoDateString;
+    /** Query on created_at. '>' */
+    created_at_gt?: IsoDateString;
+    /** Query on created_at. '>=' */
+    created_at_gte?: IsoDateString;
+    /** Query on created_at. */
+    created_at?: IsoDateString;
+    /** Perform substring match on the product description. */
+    description?: string;
+    /** Filter on the variants[].prices.plans[].discounted_price. '<' */
+    discounted_price_lt?: number;
+    /** Filter on the variants[].prices.plans[].discounted_price. '<=' */
+    discounted_price_lte?: number;
+    /** Filter on the variants[].prices.plans[].discounted_price. '>' */
+    discounted_price_gt?: number;
+    /** Filter on the variants[].prices.plans[].discounted_price. '>=' */
+    discounted_price_gte?: number;
+    /** Filter on the variants[].prices.plans[].discounted_price. */
+    discounted_price?: number;
+    /** Exclude hidden results */
+    exclude_hidden?: boolean;
+    /** List of external_product_ids. */
+    external_product_ids?: (string | number)[];
+    /** List of external_variant_ids. */
+    external_variant_ids?: (string | number)[];
+    /** Required. Product search version. */
+    format_version: '2022-06';
+    /** If true, return only products that have at least one non-deleted plan in Recharge */
+    has_plans?: boolean;
+    /** Accepts either an external_product_id or an external_variant_id. Must perform exact match. */
+    id?: string | number;
+    /** If true, return products where at least one variant’s inventory.level > 0 OR inventory.policy=continue. */
+    in_stock?: boolean;
+    /** Whether to include deleted results, default false */
+    include_deleted?: boolean;
+    /** Query on the variants[].inventory.level. '<' */
+    inventory_level_lt?: number;
+    /** Query on the variants[].inventory.level. '<=' */
+    inventory_level_lte?: number;
+    /** Query on the variants[].inventory.level. '>' */
+    inventory_level_gt?: number;
+    /** Query on the variants[].inventory.level. '>=' */
+    inventory_level_gte?: number;
+    /** Query on the variants[].inventory.level. */
+    inventory_level?: number;
+    /** Filter on the minimum_variant_price. '<' */
+    minimum_variant_price_lt?: number;
+    /** Filter on the minimum_variant_price. '<=' */
+    minimum_variant_price_lte?: number;
+    /** Filter on the minimum_variant_price. '>' */
+    minimum_variant_price_gt?: number;
+    /** Filter on the minimum_variant_price. '>=' */
+    minimum_variant_price_gte?: number;
+    /** Filter on the minimum_variant_price. */
+    minimum_variant_price?: number;
+    /** Return all products that have a matching plan.type */
+    plan_types?: PlanType[];
+    /** Exclude given plan types */
+    plan_types_exclusive?: PlanType[];
+    /** Perform search on published status */
+    product_published_status?: PublishStatus;
+    /** Perform substring match on the product title */
+    product_title?: string;
+    /** Accept up to 256 characters. Should search on the following fields: title, description, tags, variants[].sku, variants[].title. */
+    search_term?: string;
+    /** Perform substring match on variants[].sku */
+    sku?: string;
+    /** Perform substring match on tags */
+    tags?: string[];
+    /** Filter on the variants[].prices.unit_price. '<' */
+    unit_price_lt?: number;
+    /** Filter on the variants[].prices.unit_price. '<=' */
+    unit_price_lte?: number;
+    /** Filter on the variants[].prices.unit_price. '>' */
+    unit_price_gt?: number;
+    /** Filter on the variants[].prices.unit_price. '>=' */
+    unit_price_gte?: number;
+    /** Filter on the variants[].prices.unit_price. */
+    unit_price?: number;
+    /** Query on updated_at. '<' */
+    updated_at_lt?: IsoDateString;
+    /** Query on updated_at. '<=' */
+    updated_at_lte?: IsoDateString;
+    /** Query on updated_at. '>' */
+    updated_at_gt?: IsoDateString;
+    /** Query on updated_at. '>=' */
+    updated_at_gte?: IsoDateString;
+    /** Query on updated_at. */
+    updated_at?: IsoDateString;
+    /** Return products where at least one variant’s is_published value matches the value passed in to this query param. */
+    variant_published_status?: Exclude<PublishStatus, 'any'>;
+    /** Perform substring match on the variants[].title */
+    variant_title?: string;
+}
+
+type CDNVersion = '2020-12' | '2022-06';
+type FirstOption = 'onetime' | 'autodeliver';
 interface BundleTranslations {
     cpb_add: string;
     cpb_add_items_to_continue: string;
@@ -1401,11 +1852,18 @@ interface Translations {
 }
 type WidgetTemplateType = 'radio' | 'checkbox' | 'button_group' | 'radio_group';
 type WidgetIconColor = '#191D48' | 'white' | 'black' | '#ffffff';
-/****************** 2020-12 **********************/
-interface CDNProductResource {
-    product: CDNProductRaw;
+type CDNProductType<T extends CDNProductQuery_2020_12 | CDNProductQuery_2022_06> = T extends CDNProductQuery_2020_12 ? CDNProduct : CDNProduct_2022_06;
+type CDNProductResponseType<T extends CDNProductQuery_2020_12 | CDNProductQuery_2022_06> = CDNProductResource<T>;
+interface CDNProductQuery_2020_12 {
+    version: '2020-12';
+}
+interface CDNProductQuery_2022_06 {
+    version: '2022-06';
+}
+interface CDNProductResource<T extends CDNProductQuery_2020_12 | CDNProductQuery_2022_06> {
+    product: T extends CDNProductQuery_2020_12 ? CDNProductRaw : CDNProduct_2022_06;
     meta: {
-        version: '2020-12';
+        version: T extends CDNProductQuery_2020_12 ? CDNProductQuery_2020_12['version'] : CDNProductQuery_2022_06['version'];
     };
 }
 interface CDNProductKeyObject {
@@ -1422,68 +1880,14 @@ interface CDNProductsAndSettingsResource {
         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 CDNSubscriptionOption extends Omit<SubscriptionOption, 'charge_interval_frequency' | 'cutoff_day_of_month' | 'cutoff_day_of_week' | 'expire_after_specific_number_of_charges' | 'modifiable_properties' | 'number_charges_until_expiration' | 'order_day_of_month' | 'order_day_of_week' | 'order_interval_frequency_options' | 'order_interval_unit'> {
 }
-interface CDNPrices {
-    compare_at_price: string | null;
-    unit_price: string;
-    discounted_price: string;
-    zero_decimal_currency: boolean;
+interface CDNVariant extends Omit<ProductVariant_2020_12, 'external_metafields' | 'external_product_id' | 'fulfillment_service' | 'image' | 'inventory' | 'is_deleted' | 'is_published' | 'price_includes_tax' | 'product_id' | 'requires_shipping' | 'shipping_dimensions' | 'sku' | 'tax_code' | 'taxable' | 'title'> {
 }
-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;
+interface CDNProductRaw extends Omit<Product_2020_12, 'brand' | 'bundle_product' | 'collection_ids' | 'description' | 'discount_amount' | 'discount_type' | 'external_created_at' | 'external_metafields' | 'external_updated_at' | 'handle' | 'images' | 'is_deleted' | 'is_published' | 'minimum_variant_price' | 'modifiers' | 'more_than_one_price' | 'published_at' | 'requires_shipping' | 'subscription_options' | 'tags' | 'title' | 'type' | 'variants' | 'vendor'> {
     bundle_product?: CDNBundleSettings | null;
-    external_product_id: number;
-    in_recharge: boolean;
-    options: CDNProductOption[];
-    variants: CDNVariant[];
     subscription_options: CDNSubscriptionOption;
-    selling_plan_groups: CDNSellingPlanGroup[];
+    variants: CDNVariant[];
 }
 interface CDNProduct extends CDNProductRaw {
     /** @deprecated */
@@ -1571,94 +1975,31 @@ interface CDNStoreSettings {
         zero_decimal_currency?: boolean;
     };
 }
-/****************** 2021-08 **********************/
-/**************** Bundles ****************/
-interface CDNBundleStepOption {
-    content: string;
-    defaultImage: string;
+interface CDNPlan extends Omit<Plan, 'channel_settings' | 'created_at' | 'deleted_at' | 'external_product_id' | 'subscription_preferences' | 'updated_at'> {
+    apply_custom_date_to_checkout: boolean;
+    charge_interval_frequency: number | null;
+    interval_unit: IntervalUnit | null;
+    order_interval_frequency: number | null;
+    pricing_progression: {
+        recurring_discount_type: DiscountType | null;
+        recurring_discount_amount: number | null;
+        recurring_discount_after_cycle: number | null;
+    }[];
 }
-interface CDNBundleStep {
-    data?: {
-        optionsMeta: {
-            [key: string]: CDNBundleStepOption;
-        };
-    };
-    disable: boolean;
-    index: string;
-    name: string;
-    title: string;
-    type: 'variantSelector' | 'all-collections' | 'addons' | 'summary' | 'cross-sells';
+interface CDNProductVariant_2022_06 extends Omit<ProductVariant_2022_06, 'external_metafields' | 'external_product_id' | 'fulfillment_service' | 'image' | 'inventory' | 'is_deleted' | 'is_published' | 'price_includes_tax' | 'requires_shipping' | 'shipping_dimensions' | 'sku' | 'tax_code' | 'taxable' | 'title'> {
 }
-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 CDNProduct_2022_06 extends Omit<Product_2022_06, 'brand' | 'bundle_product' | 'collections' | 'description' | 'external_created_at' | 'external_metafields' | 'external_updated_at' | 'handle' | 'images' | 'is_deleted' | 'is_published' | 'minimum_variant_prices' | 'modifiers' | 'more_than_one_price' | 'plans' | 'published_at' | 'requires_shipping' | 'store_id' | 'tags' | 'title' | 'type' | 'variants' | 'vendor'> {
+    bundle_product: CDNBundleSettings | null;
+    plans: CDNPlan[];
+    variants: CDNProductVariant_2022_06[];
 }
-interface CDNBundleVariantOptionSource {
-    id: number;
+interface CDNBundleVariantOptionSource extends Omit<BundleVariantOptionSource, 'created_at' | 'option_source_id' | 'position' | 'source_platform' | 'updated_at'> {
     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;
+interface CDNBundleVariant extends Omit<BundleVariant, 'created_at' | 'option_sources' | 'position' | 'ranges' | 'selection_defaults' | 'title' | 'updated_at'> {
     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;
+interface CDNBundleSettings extends Omit<BundleProduct, 'created_at' | 'custom_prices' | 'price_rule' | 'title' | 'updated_at' | 'variants'> {
     variants: CDNBundleVariant[];
 }
 
@@ -1937,74 +2278,6 @@ interface InitOptions {
     loginRetryFn?: () => Promise<Session | undefined>;
 }
 
-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;
-}
-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[];
-}
-type PlanSortBy = 'id-asc' | 'id-desc' | 'updated_at-asc' | 'updated_at-desc';
-interface PlanListParams extends ListParams<PlanSortBy> {
-    /** Return the Plans linked to the Product record in Recharge with the indicated external_product_id */
-    external_product_id?: string | number;
-    /** Return the plans updated before the given date. */
-    updated_at_max?: IsoDateString;
-    /** Return the plans updated after the given date. */
-    updated_at_min?: IsoDateString;
-    /** Return the plans that are of a specific type. */
-    type?: PlanType;
-}
-
 declare function getCharge(session: Session, id: number | string, options?: GetChargeOptions): Promise<Charge>;
 /** Lists charges */
 declare function listCharges(session: Session, query?: ChargeListParams): Promise<ChargeListResponse>;
@@ -2025,7 +2298,7 @@ declare function skipCharge(session: Session, id: number | string, purchaseItemI
 declare function unskipCharge(session: Session, id: number | string, purchaseItemIds: (string | number)[]): Promise<Charge>;
 declare function processCharge(session: Session, id: number | string): Promise<Charge>;
 
-declare function getCDNProduct(externalProductId: string | number): Promise<CDNProduct>;
+declare function getCDNProduct<T extends CDNProductQuery_2020_12 | CDNProductQuery_2022_06 = CDNProductQuery_2020_12>(externalProductId: string | number, query?: T): Promise<CDNProductType<T>>;
 declare function getCDNStoreSettings(): Promise<CDNStoreSettings>;
 declare function getCDNWidgetSettings(): Promise<CDNWidgetSettings>;
 declare function getCDNProductsAndSettings(): Promise<CDNProductsAndSettings>;
@@ -2092,6 +2365,9 @@ declare function listPaymentMethods(session: Session, query?: PaymentMethodListP
 declare function getPlan(session: Session, id: string | number): Promise<Plan>;
 declare function listPlans(session: Session, query?: PlanListParams): Promise<PlansResponse>;
 
+type ProductSearchType<T extends ProductSearchParams_2020_12 | ProductSearchParams_2022_06> = T extends ProductSearchParams_2020_12 ? ProductSearchResponse_2020_12 : ProductSearchResponse_2022_06;
+declare function productSearch<T extends ProductSearchParams_2020_12 | ProductSearchParams_2022_06>(session: Session, query: T): Promise<ProductSearchType<T>>;
+
 declare function getSubscription(session: Session, id: string | number, options?: GetSubscriptionOptions): Promise<Subscription>;
 declare function listSubscriptions(session: Session, query?: SubscriptionListParams): Promise<SubscriptionsResponse>;
 /**
@@ -2149,6 +2425,7 @@ declare function getCustomer(session: Session, options?: GetCustomerOptions): Pr
 declare function updateCustomer(session: Session, updateRequest: UpdateCustomerRequest): Promise<Customer>;
 declare function getDeliverySchedule(session: Session, query?: CustomerDeliveryScheduleParams): Promise<Delivery[]>;
 declare function getCustomerPortalAccess(session: Session): Promise<CustomerPortalAccessResponse>;
+declare function sendCustomerNotification(session: Session, notification: CustomerNotification): Promise<void>;
 
 declare const api: {
     get<T>(url: string, requestOptions?: GetRequestOptions): Promise<T>;
@@ -2158,4 +2435,4 @@ declare const api: {
 };
 declare function initRecharge(opt?: InitOptions): void;
 
-export { ActivateMembershipRequest, Address, AddressIncludes, AddressListParams, AddressListResponse, AddressResponse, AddressSortBy, AnalyticsData, AssociatedAddress, BasicSubscriptionParams, BooleanLike, BooleanNumbers, BooleanString, BooleanStringNumbers, BundleAppProxy, BundleProduct, BundlePurchaseItem, BundlePurchaseItemParams, BundleSelection, BundleSelectionAppProxy, BundleSelectionItem, BundleSelectionItemRequiredCreateProps, BundleSelectionListParams, BundleSelectionsResponse, BundleSelectionsSortBy, 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, ChangeMembershipRequest, ChannelSettings, Charge, ChargeIncludes, ChargeListParams, ChargeListResponse, ChargeResponse, ChargeSortBy, ChargeStatus, ColorString, CreateAddressRequest, CreateBundleSelectionRequest, CreateMetafieldRequest, CreateOnetimeRequest, CreateRecipientAddress, CreateSubscriptionRequest, Customer, CustomerDeliveryScheduleParams, CustomerDeliveryScheduleResponse, CustomerIncludes, CustomerPortalAccessResponse, Delivery, DeliveryLineItem, DeliveryOrder, DeliveryPaymentMethod, Discount, DynamicBundleItemAppProxy, DynamicBundlePropertiesAppProxy, ExternalAttributeSchema, ExternalId, ExternalTransactionId, FirstOption, GetAddressOptions, GetChargeOptions, GetCustomerOptions, GetMembershipProgramOptions, GetPaymentMethodOptions, GetRequestOptions, GetSubscriptionOptions, HTMLString, InitOptions, IntervalUnit, IsoDateString, LineItem, ListParams, LoginResponse, Membership, MembershipBenefit, MembershipIncludes, MembershipListParams, MembershipListResponse, MembershipProgram, MembershipProgramIncludes, MembershipProgramListParams, MembershipProgramListResponse, MembershipProgramResponse, MembershipProgramSortBy, MembershipProgramStatus, MembershipResponse, MembershipStatus, MembershipsSortBy, MergeAddressesRequest, Metafield, MetafieldOptionalCreateProps, MetafieldOwnerResource, MetafieldRequiredCreateProps, Method, Onetime, OnetimeListParams, OnetimeOptionalCreateProps, OnetimeRequiredCreateProps, OnetimesResponse, OnetimesSortBy, Order, OrderIncludes, OrderListParams, OrderSortBy, OrderStatus, OrderType, OrdersResponse, PasswordlessCodeResponse, PasswordlessOptions, PasswordlessValidateResponse, PaymentDetails, PaymentMethod, PaymentMethodIncludes, PaymentMethodListParams, PaymentMethodSortBy, PaymentMethodStatus, PaymentMethodsResponse, PaymentType, Plan, PlanListParams, PlanSortBy, PlanType, PlansResponse, PriceAdjustmentsType, ProcessorName, ProductImage, Property, Request, RequestHeaders, RequestOptions, Session, ShippingLine, SkipFutureChargeAddressRequest, SkipFutureChargeAddressResponse, StorefrontEnvironment, StorefrontOptions, StorefrontPurchaseOption, SubType, Subscription, SubscriptionIncludes, SubscriptionListParams, SubscriptionOptionalCreateProps, SubscriptionPreferences, SubscriptionRequiredCreateProps, SubscriptionSortBy, SubscriptionStatus, Subscription_2021_01, SubscriptionsResponse, TaxLine, Translations, UpdateAddressRequest, UpdateBundlePurchaseItem, UpdateBundleSelectionRequest, UpdateCustomerRequest, UpdateMetafieldRequest, UpdateOnetimeRequest, UpdatePaymentMethodRequest, UpdateSubscriptionParams, UpdateSubscriptionRequest, UpdateSubscriptionsParams, UpdateSubscriptionsRequest, WidgetIconColor, WidgetTemplateType, activateMembership, activateSubscription, api, applyDiscountToAddress, applyDiscountToCharge, cancelMembership, cancelSubscription, changeMembership, createAddress, createBundleSelection, createMetafield, createOnetime, createSubscription, createSubscriptions, deleteAddress, deleteBundleSelection, deleteMetafield, deleteOnetime, getAddress, getBundleId, getBundleSelection, getCDNBundleSettings, getCDNProduct, getCDNProductAndSettings, getCDNProducts, getCDNProductsAndSettings, getCDNStoreSettings, getCDNWidgetSettings, getCharge, getCustomer, getCustomerPortalAccess, getDeliverySchedule, getDynamicBundleItems, getMembership, getMembershipProgram, getOnetime, getOrder, getPaymentMethod, getPlan, getSubscription, initRecharge, intervalUnit, listAddresses, listBundleSelections, listCharges, listMembershipPrograms, listMemberships, listOnetimes, listOrders, listPaymentMethods, listPlans, listSubscriptions, loginCustomerPortal, loginShopifyApi, loginShopifyAppProxy, membershipIncludes, mergeAddresses, processCharge, removeDiscountsFromAddress, removeDiscountsFromCharge, resetCDNCache, sendPasswordlessCode, sendPasswordlessCodeAppProxy, skipCharge, skipFutureCharge, skipGiftSubscriptionCharge, skipSubscriptionCharge, unskipCharge, updateAddress, updateBundle, updateBundleSelection, updateCustomer, updateMetafield, updateOnetime, updatePaymentMethod, updateSubscription, updateSubscriptionAddress, updateSubscriptionChargeDate, updateSubscriptions, validateBundle, validateDynamicBundle, validatePasswordlessCode, validatePasswordlessCodeAppProxy };
+export { ActivateMembershipRequest, Address, AddressIncludes, AddressListParams, AddressListResponse, AddressResponse, AddressSortBy, AnalyticsData, AssociatedAddress, BasicSubscriptionParams, BooleanLike, BooleanNumbers, BooleanString, BooleanStringNumbers, BundleAppProxy, BundleProduct, BundlePurchaseItem, BundlePurchaseItemParams, BundleSelection, BundleSelectionAppProxy, BundleSelectionItem, BundleSelectionItemRequiredCreateProps, BundleSelectionListParams, BundleSelectionsResponse, BundleSelectionsSortBy, BundleTranslations, BundleVariant, BundleVariantOptionSource, CDNBaseWidgetSettings, CDNBundleSettings, CDNBundleVariant, CDNBundleVariantOptionSource, CDNPlan, CDNProduct, CDNProductAndSettings, CDNProductKeyObject, CDNProductQuery_2020_12, CDNProductQuery_2022_06, CDNProductRaw, CDNProductResource, CDNProductResponseType, CDNProductType, CDNProductVariant_2022_06, CDNProduct_2022_06, CDNProductsAndSettings, CDNProductsAndSettingsResource, CDNStoreSettings, CDNSubscriptionOption, CDNVariant, CDNVersion, CDNWidgetSettings, CDNWidgetSettingsRaw, CDNWidgetSettingsResource, CRUDRequestOptions, CancelMembershipRequest, CancelSubscriptionRequest, ChangeMembershipRequest, ChannelSettings, Charge, ChargeIncludes, ChargeListParams, ChargeListResponse, ChargeResponse, ChargeSortBy, ChargeStatus, ColorString, CreateAddressRequest, CreateBundleSelectionRequest, CreateMetafieldRequest, CreateOnetimeRequest, CreateRecipientAddress, CreateSubscriptionRequest, Customer, CustomerDeliveryScheduleParams, CustomerDeliveryScheduleResponse, CustomerIncludes, CustomerNotification, CustomerNotificationTemplate, CustomerNotificationType, CustomerPortalAccessResponse, Delivery, DeliveryLineItem, DeliveryOrder, DeliveryPaymentMethod, Discount, DiscountType, DynamicBundleItemAppProxy, DynamicBundlePropertiesAppProxy, ExternalAttributeSchema, ExternalId, ExternalTransactionId, FirstOption, GetAddressOptions, GetChargeOptions, GetCustomerOptions, GetMembershipProgramOptions, GetPaymentMethodOptions, GetRequestOptions, GetSubscriptionOptions, HTMLString, InitOptions, IntervalUnit, IsoDateString, LineItem, ListParams, LoginResponse, Membership, MembershipBenefit, MembershipIncludes, MembershipListParams, MembershipListResponse, MembershipProgram, MembershipProgramIncludes, MembershipProgramListParams, MembershipProgramListResponse, MembershipProgramResponse, MembershipProgramSortBy, MembershipProgramStatus, MembershipResponse, MembershipStatus, MembershipsSortBy, MergeAddressesRequest, Metafield, MetafieldOptionalCreateProps, MetafieldOwnerResource, MetafieldRequiredCreateProps, Method, Modifier, Onetime, OnetimeListParams, OnetimeOptionalCreateProps, OnetimeRequiredCreateProps, OnetimesResponse, OnetimesSortBy, Order, OrderIncludes, OrderListParams, OrderSortBy, OrderStatus, OrderType, OrdersResponse, PasswordlessCodeResponse, PasswordlessOptions, PasswordlessValidateResponse, PaymentDetails, PaymentMethod, PaymentMethodIncludes, PaymentMethodListParams, PaymentMethodSortBy, PaymentMethodStatus, PaymentMethodsResponse, PaymentType, Plan, PlanListParams, PlanSortBy, PlanType, PlansResponse, ProcessorName, ProductImage, ProductInclude, ProductOption, ProductSearchParams_2020_12, ProductSearchParams_2022_06, ProductSearchResponse_2020_12, ProductSearchResponse_2022_06, ProductSearchType, ProductSource, ProductValueOption, ProductVariant_2020_12, ProductVariant_2022_06, Product_2020_12, Product_2022_06, Property, PublishStatus, Request, RequestHeaders, RequestOptions, SellingPlan, SellingPlanGroup, Session, ShippingLine, SkipFutureChargeAddressRequest, SkipFutureChargeAddressResponse, SortBy, SortField, SortKeys, StorefrontEnvironment, StorefrontOptions, StorefrontPurchaseOption, SubType, Subscription, SubscriptionIncludes, SubscriptionListParams, SubscriptionOption, SubscriptionOptionalCreateProps, SubscriptionPreferences, SubscriptionRequiredCreateProps, SubscriptionSortBy, SubscriptionStatus, Subscription_2021_01, SubscriptionsResponse, TaxLine, Translations, UpdateAddressRequest, UpdateBundlePurchaseItem, UpdateBundleSelectionRequest, UpdateCustomerRequest, UpdateMetafieldRequest, UpdateOnetimeRequest, UpdatePaymentMethodRequest, UpdateSubscriptionParams, UpdateSubscriptionRequest, UpdateSubscriptionsParams, UpdateSubscriptionsRequest, WidgetIconColor, WidgetTemplateType, activateMembership, activateSubscription, api, applyDiscountToAddress, applyDiscountToCharge, cancelMembership, cancelSubscription, changeMembership, createAddress, createBundleSelection, createMetafield, createOnetime, createSubscription, createSubscriptions, deleteAddress, deleteBundleSelection, deleteMetafield, deleteOnetime, getAddress, getBundleId, getBundleSelection, getCDNBundleSettings, getCDNProduct, getCDNProductAndSettings, getCDNProducts, getCDNProductsAndSettings, getCDNStoreSettings, getCDNWidgetSettings, getCharge, getCustomer, getCustomerPortalAccess, getDeliverySchedule, getDynamicBundleItems, getMembership, getMembershipProgram, getOnetime, getOrder, getPaymentMethod, getPlan, getSubscription, initRecharge, intervalUnit, listAddresses, listBundleSelections, listCharges, listMembershipPrograms, listMemberships, listOnetimes, listOrders, listPaymentMethods, listPlans, listSubscriptions, loginCustomerPortal, loginShopifyApi, loginShopifyAppProxy, membershipIncludes, mergeAddresses, processCharge, productSearch, removeDiscountsFromAddress, removeDiscountsFromCharge, resetCDNCache, sendCustomerNotification, sendPasswordlessCode, sendPasswordlessCodeAppProxy, skipCharge, skipFutureCharge, skipGiftSubscriptionCharge, skipSubscriptionCharge, unskipCharge, updateAddress, updateBundle, updateBundleSelection, updateCustomer, updateMetafield, updateOnetime, updatePaymentMethod, updateSubscription, updateSubscriptionAddress, updateSubscriptionChargeDate, updateSubscriptions, validateBundle, validateDynamicBundle, validatePasswordlessCode, validatePasswordlessCodeAppProxy };