@rechargeapps/storefront-client 1.48.0 → 1.49.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/api/auth.js +1 -1
- package/dist/cjs/api/bundle.js.map +1 -1
- package/dist/cjs/api/bundleData.js +44 -0
- package/dist/cjs/api/bundleData.js.map +1 -0
- package/dist/cjs/index.js +2 -0
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/utils/bundleData.js +224 -0
- package/dist/cjs/utils/bundleData.js.map +1 -0
- package/dist/cjs/utils/request.js +1 -1
- package/dist/esm/api/auth.js +1 -1
- package/dist/esm/api/bundle.js.map +1 -1
- package/dist/esm/api/bundleData.js +42 -0
- package/dist/esm/api/bundleData.js.map +1 -0
- package/dist/esm/index.js +1 -0
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/utils/bundleData.js +222 -0
- package/dist/esm/utils/bundleData.js.map +1 -0
- package/dist/esm/utils/request.js +1 -1
- package/dist/index.d.ts +487 -11
- package/dist/umd/recharge-client.min.js +11 -11
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -590,32 +590,171 @@ type BundlePurchaseItem = Subscription & {
|
|
|
590
590
|
interface BundlePurchaseItemParams {
|
|
591
591
|
commit?: boolean;
|
|
592
592
|
}
|
|
593
|
-
|
|
594
|
-
|
|
593
|
+
/** @internal */
|
|
594
|
+
interface BaseProductVariant {
|
|
595
595
|
id: number;
|
|
596
596
|
title: string;
|
|
597
|
+
price: number;
|
|
598
|
+
compare_at_price: number | null;
|
|
599
|
+
options: string[];
|
|
600
|
+
available: boolean;
|
|
601
|
+
}
|
|
602
|
+
interface BundleDataCollectionProductVariant extends BaseProductVariant {
|
|
597
603
|
handle: string;
|
|
604
|
+
sku: string;
|
|
605
|
+
requires_shipping: boolean;
|
|
606
|
+
taxable: boolean;
|
|
607
|
+
featured_image: string | null;
|
|
608
|
+
public_title: string | null;
|
|
609
|
+
requires_selling_plan: boolean;
|
|
610
|
+
selling_plan_allocations: {
|
|
611
|
+
selling_plan_id: number;
|
|
612
|
+
selling_plan_group_id: string;
|
|
613
|
+
price: number;
|
|
614
|
+
compare_at_price: number | null;
|
|
615
|
+
}[];
|
|
616
|
+
option1: string;
|
|
617
|
+
option2: string | null;
|
|
618
|
+
option3: string | null;
|
|
598
619
|
}
|
|
599
|
-
|
|
620
|
+
/** @internal */
|
|
621
|
+
interface BaseProduct {
|
|
600
622
|
id: number;
|
|
601
|
-
handle: string;
|
|
602
|
-
available: boolean;
|
|
603
623
|
title: string;
|
|
624
|
+
description: string | null;
|
|
625
|
+
available: boolean;
|
|
626
|
+
featured_image: string | null;
|
|
627
|
+
images: string[];
|
|
628
|
+
requires_selling_plan: boolean;
|
|
629
|
+
selling_plan_groups: SellingPlanGroup$1[];
|
|
630
|
+
}
|
|
631
|
+
interface BundleDataCollectionProduct extends BaseProduct {
|
|
632
|
+
handle: string;
|
|
633
|
+
tags: string[];
|
|
634
|
+
options: string[];
|
|
604
635
|
variants: BundleDataCollectionProductVariant[];
|
|
636
|
+
compare_at_price_max: number;
|
|
637
|
+
compare_at_price_min: number;
|
|
638
|
+
price_max: number;
|
|
639
|
+
price_min: number;
|
|
605
640
|
}
|
|
606
|
-
interface
|
|
641
|
+
interface AddonProduct$1 extends BaseProduct {
|
|
642
|
+
price: number;
|
|
643
|
+
compare_at_price: number | null;
|
|
644
|
+
options: {
|
|
645
|
+
name: string;
|
|
646
|
+
position: number;
|
|
647
|
+
values: string[];
|
|
648
|
+
}[];
|
|
649
|
+
variants: ({
|
|
650
|
+
image: string;
|
|
651
|
+
selling_plan_allocations: {
|
|
652
|
+
selling_plan_group_id: string;
|
|
653
|
+
selling_plan: SellingPlan$1;
|
|
654
|
+
price: number;
|
|
655
|
+
compare_at_price: number | null;
|
|
656
|
+
}[];
|
|
657
|
+
} & BaseProductVariant)[];
|
|
658
|
+
}
|
|
659
|
+
interface BundleDataCollection$1 {
|
|
607
660
|
id: number;
|
|
608
661
|
handle: string;
|
|
609
662
|
title: string;
|
|
610
663
|
products: BundleDataCollectionProduct[];
|
|
611
664
|
}
|
|
665
|
+
interface Incentives$1 {
|
|
666
|
+
tiered_discounts: TieredDiscount$1[];
|
|
667
|
+
}
|
|
668
|
+
/** Line item types eligible for tiered discounts */
|
|
669
|
+
type EligibleLineItemType$1 = 'subscription' | 'onetime';
|
|
670
|
+
/** Charge types eligible for tiered discounts */
|
|
671
|
+
type EligibleChargeType$1 = 'checkout' | 'recurring';
|
|
672
|
+
/** Tiered discount status */
|
|
673
|
+
type Status$1 = 'draft' | 'unpublished' | 'published' | 'inactive';
|
|
674
|
+
/**
|
|
675
|
+
* Discount tier configuration
|
|
676
|
+
*/
|
|
677
|
+
type Tier$1 = {
|
|
678
|
+
discount_type: 'percentage' | 'fixed_amount';
|
|
679
|
+
discount_value: number | string;
|
|
680
|
+
condition_quantity_gte: number | string;
|
|
681
|
+
};
|
|
682
|
+
/**
|
|
683
|
+
* Tiered discount configuration
|
|
684
|
+
*/
|
|
685
|
+
interface TieredDiscount$1 {
|
|
686
|
+
eligible_charge_types: EligibleChargeType$1[];
|
|
687
|
+
eligible_line_item_types: EligibleLineItemType$1[];
|
|
688
|
+
external_product_id: string;
|
|
689
|
+
name: string;
|
|
690
|
+
status: Status$1;
|
|
691
|
+
tiers: Tier$1[];
|
|
692
|
+
}
|
|
693
|
+
interface SellingPlan$1 {
|
|
694
|
+
id: number;
|
|
695
|
+
name: string;
|
|
696
|
+
options: {
|
|
697
|
+
name: string;
|
|
698
|
+
position: number;
|
|
699
|
+
values: string[];
|
|
700
|
+
}[];
|
|
701
|
+
recurring_deliveries: boolean;
|
|
702
|
+
price_adjustments: {
|
|
703
|
+
value_type: 'percentage' | 'fixed_amount';
|
|
704
|
+
value: number;
|
|
705
|
+
}[];
|
|
706
|
+
}
|
|
707
|
+
interface SellingPlanGroup$1 {
|
|
708
|
+
id: string;
|
|
709
|
+
name: string;
|
|
710
|
+
options: {
|
|
711
|
+
name: string;
|
|
712
|
+
values: string[];
|
|
713
|
+
}[];
|
|
714
|
+
selling_plans: SellingPlan$1[];
|
|
715
|
+
}
|
|
612
716
|
interface BundleData {
|
|
613
717
|
id: number;
|
|
614
718
|
handle: string;
|
|
615
719
|
title: string;
|
|
616
|
-
collections: Record<string, BundleDataCollection>;
|
|
617
|
-
|
|
618
|
-
|
|
720
|
+
collections: Record<string, BundleDataCollection$1>;
|
|
721
|
+
options: {
|
|
722
|
+
name: string;
|
|
723
|
+
position: number;
|
|
724
|
+
values: string[];
|
|
725
|
+
}[];
|
|
726
|
+
available: boolean;
|
|
727
|
+
requires_selling_plan: boolean;
|
|
728
|
+
selling_plan_groups: SellingPlanGroup$1[];
|
|
729
|
+
bundle_settings: {
|
|
730
|
+
max_quantity_per_variant: BundleProduct['max_quantity_per_variant'];
|
|
731
|
+
is_customizable: BundleProduct['is_customizable'];
|
|
732
|
+
default_bundle_variant_id: BundleProduct['default_bundle_variant_id'];
|
|
733
|
+
price_rule: BundleProduct['price_rule'];
|
|
734
|
+
customization_window: BundleProduct['customization_window'];
|
|
735
|
+
customization_window_disabled_message: BundleProduct['customization_window_disabled_message'];
|
|
736
|
+
layout_settings: Pick<BundleProduct['layout_settings'], 'addons' | 'crossSells'>;
|
|
737
|
+
variants: {
|
|
738
|
+
ranges: BundleProduct['variants'][number]['ranges'];
|
|
739
|
+
enabled: BundleProduct['variants'][number]['enabled'];
|
|
740
|
+
items_count: BundleProduct['variants'][number]['items_count'];
|
|
741
|
+
external_variant_id: BundleProduct['variants'][number]['external_variant_id'];
|
|
742
|
+
selection_defaults: ({
|
|
743
|
+
sku: string;
|
|
744
|
+
handle: string;
|
|
745
|
+
product: {
|
|
746
|
+
id: number;
|
|
747
|
+
title: string;
|
|
748
|
+
description: string;
|
|
749
|
+
images: string[];
|
|
750
|
+
};
|
|
751
|
+
variant: {
|
|
752
|
+
id: number;
|
|
753
|
+
title: string;
|
|
754
|
+
featured_image: string | null;
|
|
755
|
+
sku: string;
|
|
756
|
+
};
|
|
757
|
+
} & BundleProduct['variants'][number]['selection_defaults'][number])[];
|
|
619
758
|
option_sources: {
|
|
620
759
|
id: number;
|
|
621
760
|
option_source_id: string;
|
|
@@ -626,7 +765,29 @@ interface BundleData {
|
|
|
626
765
|
updated_at: IsoDateString;
|
|
627
766
|
created_at: IsoDateString;
|
|
628
767
|
}[];
|
|
629
|
-
}
|
|
768
|
+
}[];
|
|
769
|
+
};
|
|
770
|
+
incentives: Incentives$1;
|
|
771
|
+
variants: {
|
|
772
|
+
id: number;
|
|
773
|
+
title: string;
|
|
774
|
+
price: number;
|
|
775
|
+
compare_at_price: number | null;
|
|
776
|
+
image: string | null;
|
|
777
|
+
available: boolean;
|
|
778
|
+
options: string[];
|
|
779
|
+
requires_selling_plan: boolean;
|
|
780
|
+
selling_plan_allocations: {
|
|
781
|
+
price: number;
|
|
782
|
+
compare_at_price: number | null;
|
|
783
|
+
selling_plan: SellingPlan$1;
|
|
784
|
+
}[];
|
|
785
|
+
}[];
|
|
786
|
+
addons: {
|
|
787
|
+
products: AddonProduct$1[];
|
|
788
|
+
};
|
|
789
|
+
cross_sells: {
|
|
790
|
+
products: BundleDataCollectionProduct[];
|
|
630
791
|
};
|
|
631
792
|
}
|
|
632
793
|
|
|
@@ -1542,6 +1703,268 @@ interface PasswordlessValidateResponse {
|
|
|
1542
1703
|
errors?: string;
|
|
1543
1704
|
}
|
|
1544
1705
|
|
|
1706
|
+
/**
|
|
1707
|
+
* Complete bundle data structure containing all information needed to render a bundle
|
|
1708
|
+
*/
|
|
1709
|
+
interface PublicBundleData {
|
|
1710
|
+
/** External product ID (from Shopify) */
|
|
1711
|
+
id: string;
|
|
1712
|
+
title: string;
|
|
1713
|
+
handle: string;
|
|
1714
|
+
/** Product options (size, color, etc.) */
|
|
1715
|
+
options: {
|
|
1716
|
+
name: string;
|
|
1717
|
+
position: number;
|
|
1718
|
+
values: string[];
|
|
1719
|
+
}[];
|
|
1720
|
+
default_variant_id: string | null;
|
|
1721
|
+
/** Whether the bundle is available for purchase */
|
|
1722
|
+
available_for_sale: boolean;
|
|
1723
|
+
/** Whether the bundle requires a selling plan (subscription) */
|
|
1724
|
+
requires_selling_plan: boolean;
|
|
1725
|
+
bundle_settings: BundleSettings;
|
|
1726
|
+
variants: BundleDataVariant[];
|
|
1727
|
+
selling_plan_groups: BundleDataSellingPlanGroup[];
|
|
1728
|
+
/** Collections that contain products for this bundle */
|
|
1729
|
+
collections: Record<string, BundleDataCollection>;
|
|
1730
|
+
addons: AddonsSection | null;
|
|
1731
|
+
cross_sells: CrossSellsSection | null;
|
|
1732
|
+
incentives: Incentives | null;
|
|
1733
|
+
}
|
|
1734
|
+
type PriceRule = 'FIXED' | 'DYNAMIC';
|
|
1735
|
+
/**
|
|
1736
|
+
* Bundle-specific settings and configuration
|
|
1737
|
+
*/
|
|
1738
|
+
interface BundleSettings {
|
|
1739
|
+
is_customizable: boolean;
|
|
1740
|
+
price_rule: PriceRule;
|
|
1741
|
+
max_quantity_per_variant: number | null;
|
|
1742
|
+
customization_window: {
|
|
1743
|
+
active_days: number;
|
|
1744
|
+
disabled_message: string;
|
|
1745
|
+
} | null;
|
|
1746
|
+
}
|
|
1747
|
+
/**
|
|
1748
|
+
* A specific variant of a bundle product
|
|
1749
|
+
*/
|
|
1750
|
+
interface BundleDataVariant {
|
|
1751
|
+
/** External variant ID (from Shopify) */
|
|
1752
|
+
id: string;
|
|
1753
|
+
title: string;
|
|
1754
|
+
price: number;
|
|
1755
|
+
compare_at_price: number | null;
|
|
1756
|
+
image: string;
|
|
1757
|
+
available_for_sale: boolean;
|
|
1758
|
+
options: string[];
|
|
1759
|
+
requires_selling_plan: boolean;
|
|
1760
|
+
selling_plan_allocations: SellingPlanAllocation[];
|
|
1761
|
+
ranges: QuantityRange[];
|
|
1762
|
+
collections: CollectionBinding[];
|
|
1763
|
+
default_selections: DefaultSelection[];
|
|
1764
|
+
position: number;
|
|
1765
|
+
}
|
|
1766
|
+
/**
|
|
1767
|
+
* Pricing information for a specific selling plan
|
|
1768
|
+
*/
|
|
1769
|
+
interface SellingPlanAllocation {
|
|
1770
|
+
price: number;
|
|
1771
|
+
compare_at_price: number | null;
|
|
1772
|
+
selling_plan: BundleDataSellingPlan;
|
|
1773
|
+
}
|
|
1774
|
+
/**
|
|
1775
|
+
* Quantity constraints
|
|
1776
|
+
*/
|
|
1777
|
+
interface QuantityRange {
|
|
1778
|
+
/** Minimum quantity (0 = no minimum) */
|
|
1779
|
+
min: number;
|
|
1780
|
+
/** Maximum quantity (null = no maximum) */
|
|
1781
|
+
max: number | null;
|
|
1782
|
+
}
|
|
1783
|
+
/**
|
|
1784
|
+
* Collection that serves as a source for bundle contents
|
|
1785
|
+
*/
|
|
1786
|
+
interface CollectionBinding extends QuantityRange {
|
|
1787
|
+
id: string;
|
|
1788
|
+
source_platform: 'shopify';
|
|
1789
|
+
}
|
|
1790
|
+
/**
|
|
1791
|
+
* Default selection for a bundle variant
|
|
1792
|
+
*/
|
|
1793
|
+
interface DefaultSelection {
|
|
1794
|
+
quantity: number;
|
|
1795
|
+
product: DefaultProduct;
|
|
1796
|
+
variant: DefaultVariant;
|
|
1797
|
+
}
|
|
1798
|
+
/**
|
|
1799
|
+
* Product information for default selections
|
|
1800
|
+
*/
|
|
1801
|
+
interface DefaultProduct {
|
|
1802
|
+
id: string;
|
|
1803
|
+
handle: string;
|
|
1804
|
+
title: string;
|
|
1805
|
+
description: string;
|
|
1806
|
+
images: string[];
|
|
1807
|
+
}
|
|
1808
|
+
/**
|
|
1809
|
+
* Variant information for default selections
|
|
1810
|
+
*/
|
|
1811
|
+
interface DefaultVariant {
|
|
1812
|
+
id: string;
|
|
1813
|
+
title: string;
|
|
1814
|
+
featured_image: string | null;
|
|
1815
|
+
sku: string;
|
|
1816
|
+
}
|
|
1817
|
+
/**
|
|
1818
|
+
* Group of related selling plans (subscription options)
|
|
1819
|
+
*/
|
|
1820
|
+
interface BundleDataSellingPlanGroup {
|
|
1821
|
+
/** Group name */
|
|
1822
|
+
name: string;
|
|
1823
|
+
/** Available selling plans in this group */
|
|
1824
|
+
selling_plans: BundleDataSellingPlan[];
|
|
1825
|
+
/** Configuration options for this group */
|
|
1826
|
+
options: {
|
|
1827
|
+
name: string;
|
|
1828
|
+
values: string[];
|
|
1829
|
+
}[];
|
|
1830
|
+
}
|
|
1831
|
+
/**
|
|
1832
|
+
* A specific selling plan (subscription option)
|
|
1833
|
+
*/
|
|
1834
|
+
interface BundleDataSellingPlan {
|
|
1835
|
+
id: number;
|
|
1836
|
+
name: string;
|
|
1837
|
+
options: {
|
|
1838
|
+
name: string;
|
|
1839
|
+
values: string[];
|
|
1840
|
+
}[];
|
|
1841
|
+
recurring_deliveries: boolean;
|
|
1842
|
+
price_adjustments: {
|
|
1843
|
+
value_type: 'percentage' | 'fixed_amount';
|
|
1844
|
+
value: number;
|
|
1845
|
+
}[];
|
|
1846
|
+
}
|
|
1847
|
+
/**
|
|
1848
|
+
* Collection containing products for bundle selection
|
|
1849
|
+
*/
|
|
1850
|
+
interface BundleDataCollection {
|
|
1851
|
+
id: string;
|
|
1852
|
+
title: string;
|
|
1853
|
+
handle: string;
|
|
1854
|
+
products: Product[];
|
|
1855
|
+
}
|
|
1856
|
+
/**
|
|
1857
|
+
* Price range for products
|
|
1858
|
+
*/
|
|
1859
|
+
type PriceRange = {
|
|
1860
|
+
max: number | null;
|
|
1861
|
+
min: number;
|
|
1862
|
+
};
|
|
1863
|
+
/** @internal */
|
|
1864
|
+
interface BundleDataBaseProduct {
|
|
1865
|
+
/** External product ID */
|
|
1866
|
+
id: string;
|
|
1867
|
+
title: string;
|
|
1868
|
+
description: string | null;
|
|
1869
|
+
/** Whether the product is available for sale */
|
|
1870
|
+
available_for_sale: boolean;
|
|
1871
|
+
featured_image: string | null;
|
|
1872
|
+
images: string[];
|
|
1873
|
+
requires_selling_plan: boolean;
|
|
1874
|
+
selling_plan_groups: BundleDataSellingPlanGroup[];
|
|
1875
|
+
}
|
|
1876
|
+
/**
|
|
1877
|
+
* Product available for selection in a bundle
|
|
1878
|
+
*/
|
|
1879
|
+
interface Product extends BundleDataBaseProduct {
|
|
1880
|
+
handle: string;
|
|
1881
|
+
tags: string[];
|
|
1882
|
+
price_range: PriceRange;
|
|
1883
|
+
compare_at_price_range: PriceRange;
|
|
1884
|
+
options: string[];
|
|
1885
|
+
variants: Variant[];
|
|
1886
|
+
}
|
|
1887
|
+
/** @internal */
|
|
1888
|
+
interface BaseVariant {
|
|
1889
|
+
/** External variant ID */
|
|
1890
|
+
id: string;
|
|
1891
|
+
title: string;
|
|
1892
|
+
options: string[];
|
|
1893
|
+
price: number;
|
|
1894
|
+
compare_at_price: number | null;
|
|
1895
|
+
/** Whether the product variant is available for sale */
|
|
1896
|
+
available_for_sale: boolean;
|
|
1897
|
+
selling_plan_allocations: SellingPlanAllocation[];
|
|
1898
|
+
}
|
|
1899
|
+
/**
|
|
1900
|
+
* Product variant
|
|
1901
|
+
*/
|
|
1902
|
+
interface Variant extends BaseVariant {
|
|
1903
|
+
option1: string;
|
|
1904
|
+
option2: string | null;
|
|
1905
|
+
option3: string | null;
|
|
1906
|
+
sku: string;
|
|
1907
|
+
requires_shipping: boolean;
|
|
1908
|
+
taxable: boolean;
|
|
1909
|
+
featured_image: string | null;
|
|
1910
|
+
public_title: string | null;
|
|
1911
|
+
requires_selling_plan: boolean;
|
|
1912
|
+
}
|
|
1913
|
+
interface AddonProduct extends BundleDataBaseProduct {
|
|
1914
|
+
price_range: PriceRange;
|
|
1915
|
+
compare_at_price_range: PriceRange;
|
|
1916
|
+
variants: ({
|
|
1917
|
+
image: string;
|
|
1918
|
+
} & BaseVariant)[];
|
|
1919
|
+
}
|
|
1920
|
+
/**
|
|
1921
|
+
* Add-ons section configuration and products
|
|
1922
|
+
*/
|
|
1923
|
+
interface AddonsSection {
|
|
1924
|
+
collection_id: string;
|
|
1925
|
+
collection_handle: string;
|
|
1926
|
+
products: AddonProduct[];
|
|
1927
|
+
}
|
|
1928
|
+
/**
|
|
1929
|
+
* Cross-sells section configuration and products
|
|
1930
|
+
*/
|
|
1931
|
+
interface CrossSellsSection {
|
|
1932
|
+
collection_id: string;
|
|
1933
|
+
collection_handle: string;
|
|
1934
|
+
products: Product[];
|
|
1935
|
+
}
|
|
1936
|
+
/**
|
|
1937
|
+
* Bundle incentives and promotions
|
|
1938
|
+
*/
|
|
1939
|
+
interface Incentives {
|
|
1940
|
+
tiered_discounts: TieredDiscount[];
|
|
1941
|
+
}
|
|
1942
|
+
/** Line item types eligible for tiered discounts */
|
|
1943
|
+
type EligibleLineItemType = 'subscription' | 'onetime';
|
|
1944
|
+
/** Charge types eligible for tiered discounts */
|
|
1945
|
+
type EligibleChargeType = 'checkout' | 'recurring';
|
|
1946
|
+
/** Tiered discount status */
|
|
1947
|
+
type Status = 'draft' | 'unpublished' | 'published' | 'inactive';
|
|
1948
|
+
/**
|
|
1949
|
+
* Discount tier configuration
|
|
1950
|
+
*/
|
|
1951
|
+
type Tier = {
|
|
1952
|
+
discount_type: 'percentage' | 'fixed_amount';
|
|
1953
|
+
discount_value: number | string;
|
|
1954
|
+
condition_quantity_gte: number | string;
|
|
1955
|
+
};
|
|
1956
|
+
/**
|
|
1957
|
+
* Tiered discount configuration
|
|
1958
|
+
*/
|
|
1959
|
+
interface TieredDiscount {
|
|
1960
|
+
eligible_charge_types: EligibleChargeType[];
|
|
1961
|
+
eligible_line_item_types: EligibleLineItemType[];
|
|
1962
|
+
external_product_id: string;
|
|
1963
|
+
name: string;
|
|
1964
|
+
status: Status;
|
|
1965
|
+
tiers: Tier[];
|
|
1966
|
+
}
|
|
1967
|
+
|
|
1545
1968
|
type ProductInclude = 'collections';
|
|
1546
1969
|
type ProductSource = 'all' | 'in_recharge' | 'not_in_recharge';
|
|
1547
1970
|
type PublishStatus = 'published' | 'unpublished' | 'any';
|
|
@@ -2916,6 +3339,59 @@ declare function updateBundleSelection(session: Session, id: string | number, up
|
|
|
2916
3339
|
declare function deleteBundleSelection(session: Session, id: string | number): Promise<void>;
|
|
2917
3340
|
declare function updateBundle(session: Session, purchase_item_id: string | number, updateRequest: UpdateBundlePurchaseItem, query?: BundlePurchaseItemParams): Promise<BundlePurchaseItem>;
|
|
2918
3341
|
|
|
3342
|
+
type BaseOptions = {
|
|
3343
|
+
country_code?: string;
|
|
3344
|
+
};
|
|
3345
|
+
/**
|
|
3346
|
+
* Options for loading bundle data from online store endpoint (bundle-data)
|
|
3347
|
+
*/
|
|
3348
|
+
type OnlineStoreOptions = {
|
|
3349
|
+
source: 'online_store';
|
|
3350
|
+
} & BaseOptions;
|
|
3351
|
+
/**
|
|
3352
|
+
* Options for loading bundle data from Shopify Storefront API
|
|
3353
|
+
*/
|
|
3354
|
+
type ShopifyStorefrontOptions = {
|
|
3355
|
+
source: 'shopify_storefront';
|
|
3356
|
+
shopify_storefront_access_token: string;
|
|
3357
|
+
} & BaseOptions;
|
|
3358
|
+
type Options = OnlineStoreOptions | ShopifyStorefrontOptions;
|
|
3359
|
+
/**
|
|
3360
|
+
* Load bundle data from the specified source
|
|
3361
|
+
*
|
|
3362
|
+
* @param id - The external product ID (Shopify product ID)
|
|
3363
|
+
* @param options - Configuration for data source and parameters
|
|
3364
|
+
* @param options.source - The source of the data (online_store or shopify_storefront)
|
|
3365
|
+
* @param options.country_code - The country code for the online store
|
|
3366
|
+
* @param options.storefront_access_token - The storefront access token for the Shopify Storefront API
|
|
3367
|
+
* @returns Promise resolving to bundle data result with success/error handling
|
|
3368
|
+
*
|
|
3369
|
+
* @example
|
|
3370
|
+
* ```typescript
|
|
3371
|
+
* // Load from online store
|
|
3372
|
+
* const result = await loadBundleData({
|
|
3373
|
+
* source: 'online_store',
|
|
3374
|
+
* external_product_id: '123456789',
|
|
3375
|
+
* country_code: 'US'
|
|
3376
|
+
* });
|
|
3377
|
+
*
|
|
3378
|
+
* if (result.success) {
|
|
3379
|
+
* console.log('Bundle data:', result.data);
|
|
3380
|
+
* } else {
|
|
3381
|
+
* console.error('Error:', result.error.message);
|
|
3382
|
+
* }
|
|
3383
|
+
*
|
|
3384
|
+
* // Load from Shopify Storefront API
|
|
3385
|
+
* const result2 = await loadBundleData({
|
|
3386
|
+
* source: 'shopify_storefront',
|
|
3387
|
+
* external_product_id: '123456789',
|
|
3388
|
+
* country_code: 'US',
|
|
3389
|
+
* shopify_storefront_access_token: 'your-token-here'
|
|
3390
|
+
* });
|
|
3391
|
+
* ```
|
|
3392
|
+
*/
|
|
3393
|
+
declare function loadBundleData(id: string, options?: Options): Promise<PublicBundleData>;
|
|
3394
|
+
|
|
2919
3395
|
declare function getCDNProduct<T extends CDNProductQuery_2020_12 | CDNProductQuery_2022_06 = CDNProductQuery_2020_12>(externalProductId: string | number, query?: T): Promise<CDNProductType<T>>;
|
|
2920
3396
|
declare function getCDNStoreSettings(): Promise<CDNStoreSettings>;
|
|
2921
3397
|
declare function getCDNWidgetSettings(): Promise<CDNWidgetSettings>;
|
|
@@ -3102,4 +3578,4 @@ declare const api: {
|
|
|
3102
3578
|
};
|
|
3103
3579
|
declare function initRecharge(opt?: InitOptions): void;
|
|
3104
3580
|
|
|
3105
|
-
export { type ActivateMembershipRequest, type AddToCartCallbackSettings, type AddonSettings, type Address, type AddressIncludes, type AddressListParams, type AddressListResponse, type AddressResponse, type AddressSortBy, type AnalyticsData, type ApplyCreditOptions, type AssociatedAddress, type BasicSubscriptionParams, type BooleanLike, type BooleanNumbers, type BooleanString, type BooleanStringNumbers, type BulkSubscriptionParams, type BundleAppProxy, type BundleData, type BundlePriceRule, type BundleProduct, type BundleProductLayoutSettings, type BundlePurchaseItem, type BundlePurchaseItemParams, type BundleSelection, type BundleSelectionAppProxy, type BundleSelectionItem, type BundleSelectionItemRequiredCreateProps, type BundleSelectionListParams, type BundleSelectionsResponse, type BundleSelectionsSortBy, type BundleTemplateSettings, type BundleTemplateType, type BundleTranslations, type BundleVariant, type BundleVariantOptionSource, type BundleVariantRange, type BundleVariantSelectionDefault, type CDNBaseWidgetSettings, type CDNBundleSettings, type CDNBundleVariant, type CDNBundleVariantOptionSource, type CDNPlan, type CDNProduct, type CDNProductAndSettings, type CDNProductKeyObject, type CDNProductQuery_2020_12, type CDNProductQuery_2022_06, type CDNProductRaw, type CDNProductResource, type CDNProductResponseType, type CDNProductType, type CDNProductVariant_2022_06, type CDNProduct_2022_06, type CDNProductsAndSettings, type CDNProductsAndSettingsResource, type CDNStoreSettings, type CDNSubscriptionOption, type CDNVariant, type CDNVersion, type CDNWidgetSettings, type CDNWidgetSettingsRaw, type CDNWidgetSettingsResource, type CRUDRequestOptions, type CancelMembershipRequest, type CancelSubscriptionRequest, type ChangeMembershipRequest, type ChannelSettings, type Charge, type ChargeIncludes, type ChargeListParams, type ChargeListResponse, type ChargeResponse, type ChargeSortBy, type ChargeStatus, type Collection, type CollectionListParams, type CollectionTypes, type CollectionsResponse, type CollectionsSortBy, type ColorString, type CreateAddressRequest, type CreateBundleSelectionRequest, type CreateMetafieldRequest, type CreateOnetimeRequest, type CreatePaymentMethodRequest, type CreateRecipientAddress, type CreateSubscriptionRequest, type CreateSubscriptionsParams, type CreateSubscriptionsRequest, type CreditAccount, type CreditAccountIncludes, type CreditAccountListParams, type CreditAccountType, type CreditAccountsResponse, type CreditAccountsSortBy, type CreditSummaryIncludes, type CrossSellsSettings, type CurrencyPriceSet, type Customer, type CustomerCreditSummary, type CustomerDeliveryScheduleParams, type CustomerDeliveryScheduleResponse, type CustomerIncludes, type CustomerNotification, type CustomerNotificationOptions, type CustomerNotificationTemplate, type CustomerNotificationType, type CustomerPortalAccessOptions, type CustomerPortalAccessResponse, type CustomerPortalSettings, type DeleteSubscriptionsParams, type DeleteSubscriptionsRequest, type Delivery, type DeliveryLineItem, type DeliveryOrder, type DeliveryPaymentMethod, type Discount, type DiscountType, type DynamicBundleItemAppProxy, type DynamicBundlePropertiesAppProxy, type ExternalAttributeSchema, type ExternalId, type ExternalProductStatus, type ExternalTransactionId, type FirstOption, type GetAddressOptions, type GetChargeOptions, type GetCreditSummaryOptions, type GetCustomerOptions, type GetMembershipProgramOptions, type GetPaymentMethodOptions, type GetRequestOptions, type GetSubscriptionOptions, type GiftPurchase, type GiftPurchasesParams, type GiftPurchasesResponse, type HTMLString, type InitOptions, type InternalSession, type IntervalUnit, type IsoDateString, type LineItem, type ListParams, type LoginResponse, type Membership, type MembershipBenefit, type MembershipIncludes, type MembershipListParams, type MembershipListResponse, type MembershipProgram, type MembershipProgramIncludes, type MembershipProgramListParams, type MembershipProgramListResponse, type MembershipProgramResponse, type MembershipProgramSortBy, type MembershipProgramStatus, type MembershipResponse, type MembershipStatus, type MembershipsSortBy, type MergeAddressesRequest, type Metafield, type MetafieldOptionalCreateProps, type MetafieldOwnerResource, type MetafieldRequiredCreateProps, type Method, type Modifier, type MultiStepSettings, type OfferAttributes, type OnePageSettings, type Onetime, type OnetimeIncludes, type OnetimeListParams, type OnetimeOptionalCreateProps, type OnetimeRequiredCreateProps, type OnetimeSubscription, type OnetimesResponse, type OnetimesSortBy, type Order, type OrderIncludes, type OrderListParams, type OrderSortBy, type OrderStatus, type OrderType, type OrdersResponse, type PasswordlessCodeResponse, type PasswordlessOptions, type PasswordlessValidateResponse, type PaymentDetails, type PaymentMethod, type PaymentMethodIncludes, type PaymentMethodListParams, type PaymentMethodOptionalCreateProps, type PaymentMethodRequiredCreateProps, type PaymentMethodSortBy, type PaymentMethodStatus, type PaymentMethodsResponse, type PaymentType, type Plan, type PlanListParams, type PlanSortBy, type PlanType, type PlansResponse, type PriceSet, type ProcessorName, type ProductImage, type ProductInclude, type ProductListResponse, type ProductOption, type ProductSearchParams_2020_12, type ProductSearchParams_2022_06, type ProductSearchResponse_2020_12, type ProductSearchResponse_2022_06, type ProductSearchType, type ProductSource, type ProductValueOption, type ProductVariant_2020_12, type ProductVariant_2022_06, type Product_2020_12, type Product_2022_06, type Property, type PublishStatus, type RecurringSubscription, type ReferralInfo, type ReferralUrl, type Request, type RequestHeaders, type RequestOptions, type SellingPlan, type SellingPlanGroup, type Session, type ShippingCountriesOptions, type ShippingCountriesResponse, type ShippingCountry, type ShippingLine, type ShippingProvince, type ShopifyUpdatePaymentInfoOptions, type SkipChargeParams, type SkipFutureChargeAddressRequest, type SkipFutureChargeAddressResponse, type SortBy, type SortField, type SortKeys, type StepSettings, type StepSettingsCommon, type StepSettingsTypes, type StoreSettings, type StorefrontEnvironment, type StorefrontOptions, type StorefrontPurchaseOption, type SubType, type Subscription, type SubscriptionBase, type SubscriptionCancelled, type SubscriptionIncludes, type SubscriptionListParams, type SubscriptionOption, type SubscriptionOptionalCreateProps, type SubscriptionPreferences, type SubscriptionRequiredCreateProps, type SubscriptionSortBy, type SubscriptionStatus, type Subscription_2021_01, type SubscriptionsResponse, type TaxLine, type Translations, type UpdateAddressParams, type UpdateAddressRequest, type UpdateBundlePurchaseItem, type UpdateBundleSelectionRequest, type UpdateCustomerRequest, type UpdateMetafieldRequest, type UpdateOnetimeRequest, type UpdatePaymentMethodRequest, type UpdateSubscriptionChargeDateParams, type UpdateSubscriptionParams, type UpdateSubscriptionRequest, type UpdateSubscriptionsParams, type UpdateSubscriptionsRequest, type VariantSelector, type VariantSelectorStepSetting, type WidgetIconColor, type WidgetTemplateType, type WidgetVisibility, activateMembership, activateSubscription, api, applyDiscountToAddress, applyDiscountToCharge, cancelMembership, cancelSubscription, changeMembership, createAddress, createBundleSelection, createMetafield, createOnetime, createPaymentMethod, createSubscription, createSubscriptions, delayOrder, deleteAddress, deleteBundleSelection, deleteMetafield, deleteOnetime, deleteSubscriptions, getActiveChurnLandingPageURL, getAddress, getBundleId, getBundleSelection, getBundleSelectionId, getCDNBundleSettings, getCDNProduct, getCDNProductAndSettings, getCDNProducts, getCDNProductsAndSettings, getCDNStoreSettings, getCDNWidgetSettings, getCharge, getCollection, getCreditSummary, getCustomer, getCustomerPortalAccess, getDeliverySchedule, getDynamicBundleItems, getFailedPaymentMethodRecoveryLandingPageURL, getGiftPurchase, getGiftRedemptionLandingPageURL, getMembership, getMembershipProgram, getOnetime, getOrder, getPaymentMethod, getPlan, getShippingCountries, getStoreSettings, getSubscription, initRecharge, type intervalUnit, listAddresses, listBundleSelections, listCharges, listCollectionProducts, listCollections, listCreditAccounts, listGiftPurchases, listMembershipPrograms, listMemberships, listOnetimes, listOrders, listPaymentMethods, listPlans, listSubscriptions, loginCustomerPortal, loginShopifyApi, loginShopifyAppProxy, loginWithShopifyCustomerAccount, loginWithShopifyStorefront, type membershipIncludes, mergeAddresses, processCharge, productSearch, removeDiscountsFromAddress, removeDiscountsFromCharge, resetCDNCache, sendCustomerNotification, sendPasswordlessCode, sendPasswordlessCodeAppProxy, setApplyCreditsToNextCharge, skipCharge, skipFutureCharge, skipGiftSubscriptionCharge, skipSubscriptionCharge, unskipCharge, updateAddress, updateBundle, updateBundleSelection, updateCustomer, updateMetafield, updateOnetime, updatePaymentMethod, updateSubscription, updateSubscriptionAddress, updateSubscriptionChargeDate, updateSubscriptions, validateBundle, validateBundleSelection, validateDynamicBundle, validatePasswordlessCode, validatePasswordlessCodeAppProxy };
|
|
3581
|
+
export { type ActivateMembershipRequest, type AddToCartCallbackSettings, type AddonProduct, type AddonSettings, type AddonsSection, type Address, type AddressIncludes, type AddressListParams, type AddressListResponse, type AddressResponse, type AddressSortBy, type AnalyticsData, type ApplyCreditOptions, type AssociatedAddress, type BaseProduct, type BaseProductVariant, type BaseVariant, type BasicSubscriptionParams, type BooleanLike, type BooleanNumbers, type BooleanString, type BooleanStringNumbers, type BulkSubscriptionParams, type BundleAppProxy, type BundleData, type BundleDataBaseProduct, type BundleDataCollection, type BundleDataSellingPlan, type BundleDataSellingPlanGroup, type BundleDataVariant, type BundlePriceRule, type BundleProduct, type BundleProductLayoutSettings, type BundlePurchaseItem, type BundlePurchaseItemParams, type BundleSelection, type BundleSelectionAppProxy, type BundleSelectionItem, type BundleSelectionItemRequiredCreateProps, type BundleSelectionListParams, type BundleSelectionsResponse, type BundleSelectionsSortBy, type BundleSettings, type BundleTemplateSettings, type BundleTemplateType, type BundleTranslations, type BundleVariant, type BundleVariantOptionSource, type BundleVariantRange, type BundleVariantSelectionDefault, type CDNBaseWidgetSettings, type CDNBundleSettings, type CDNBundleVariant, type CDNBundleVariantOptionSource, type CDNPlan, type CDNProduct, type CDNProductAndSettings, type CDNProductKeyObject, type CDNProductQuery_2020_12, type CDNProductQuery_2022_06, type CDNProductRaw, type CDNProductResource, type CDNProductResponseType, type CDNProductType, type CDNProductVariant_2022_06, type CDNProduct_2022_06, type CDNProductsAndSettings, type CDNProductsAndSettingsResource, type CDNStoreSettings, type CDNSubscriptionOption, type CDNVariant, type CDNVersion, type CDNWidgetSettings, type CDNWidgetSettingsRaw, type CDNWidgetSettingsResource, type CRUDRequestOptions, type CancelMembershipRequest, type CancelSubscriptionRequest, type ChangeMembershipRequest, type ChannelSettings, type Charge, type ChargeIncludes, type ChargeListParams, type ChargeListResponse, type ChargeResponse, type ChargeSortBy, type ChargeStatus, type Collection, type CollectionBinding, type CollectionListParams, type CollectionTypes, type CollectionsResponse, type CollectionsSortBy, type ColorString, type CreateAddressRequest, type CreateBundleSelectionRequest, type CreateMetafieldRequest, type CreateOnetimeRequest, type CreatePaymentMethodRequest, type CreateRecipientAddress, type CreateSubscriptionRequest, type CreateSubscriptionsParams, type CreateSubscriptionsRequest, type CreditAccount, type CreditAccountIncludes, type CreditAccountListParams, type CreditAccountType, type CreditAccountsResponse, type CreditAccountsSortBy, type CreditSummaryIncludes, type CrossSellsSection, type CrossSellsSettings, type CurrencyPriceSet, type Customer, type CustomerCreditSummary, type CustomerDeliveryScheduleParams, type CustomerDeliveryScheduleResponse, type CustomerIncludes, type CustomerNotification, type CustomerNotificationOptions, type CustomerNotificationTemplate, type CustomerNotificationType, type CustomerPortalAccessOptions, type CustomerPortalAccessResponse, type CustomerPortalSettings, type DefaultProduct, type DefaultSelection, type DefaultVariant, type DeleteSubscriptionsParams, type DeleteSubscriptionsRequest, type Delivery, type DeliveryLineItem, type DeliveryOrder, type DeliveryPaymentMethod, type Discount, type DiscountType, type DynamicBundleItemAppProxy, type DynamicBundlePropertiesAppProxy, type EligibleChargeType, type EligibleLineItemType, type ExternalAttributeSchema, type ExternalId, type ExternalProductStatus, type ExternalTransactionId, type FirstOption, type GetAddressOptions, type GetChargeOptions, type GetCreditSummaryOptions, type GetCustomerOptions, type GetMembershipProgramOptions, type GetPaymentMethodOptions, type GetRequestOptions, type GetSubscriptionOptions, type GiftPurchase, type GiftPurchasesParams, type GiftPurchasesResponse, type HTMLString, type Incentives, type InitOptions, type InternalSession, type IntervalUnit, type IsoDateString, type LineItem, type ListParams, type LoginResponse, type Membership, type MembershipBenefit, type MembershipIncludes, type MembershipListParams, type MembershipListResponse, type MembershipProgram, type MembershipProgramIncludes, type MembershipProgramListParams, type MembershipProgramListResponse, type MembershipProgramResponse, type MembershipProgramSortBy, type MembershipProgramStatus, type MembershipResponse, type MembershipStatus, type MembershipsSortBy, type MergeAddressesRequest, type Metafield, type MetafieldOptionalCreateProps, type MetafieldOwnerResource, type MetafieldRequiredCreateProps, type Method, type Modifier, type MultiStepSettings, type OfferAttributes, type OnePageSettings, type Onetime, type OnetimeIncludes, type OnetimeListParams, type OnetimeOptionalCreateProps, type OnetimeRequiredCreateProps, type OnetimeSubscription, type OnetimesResponse, type OnetimesSortBy, type Order, type OrderIncludes, type OrderListParams, type OrderSortBy, type OrderStatus, type OrderType, type OrdersResponse, type PasswordlessCodeResponse, type PasswordlessOptions, type PasswordlessValidateResponse, type PaymentDetails, type PaymentMethod, type PaymentMethodIncludes, type PaymentMethodListParams, type PaymentMethodOptionalCreateProps, type PaymentMethodRequiredCreateProps, type PaymentMethodSortBy, type PaymentMethodStatus, type PaymentMethodsResponse, type PaymentType, type Plan, type PlanListParams, type PlanSortBy, type PlanType, type PlansResponse, type PriceRange, type PriceRule, type PriceSet, type ProcessorName, type Product, type ProductImage, type ProductInclude, type ProductListResponse, type ProductOption, type ProductSearchParams_2020_12, type ProductSearchParams_2022_06, type ProductSearchResponse_2020_12, type ProductSearchResponse_2022_06, type ProductSearchType, type ProductSource, type ProductValueOption, type ProductVariant_2020_12, type ProductVariant_2022_06, type Product_2020_12, type Product_2022_06, type Property, type PublicBundleData, type PublishStatus, type QuantityRange, type RecurringSubscription, type ReferralInfo, type ReferralUrl, type Request, type RequestHeaders, type RequestOptions, type SellingPlan, type SellingPlanAllocation, type SellingPlanGroup, type Session, type ShippingCountriesOptions, type ShippingCountriesResponse, type ShippingCountry, type ShippingLine, type ShippingProvince, type ShopifyUpdatePaymentInfoOptions, type SkipChargeParams, type SkipFutureChargeAddressRequest, type SkipFutureChargeAddressResponse, type SortBy, type SortField, type SortKeys, type Status, type StepSettings, type StepSettingsCommon, type StepSettingsTypes, type StoreSettings, type StorefrontEnvironment, type StorefrontOptions, type StorefrontPurchaseOption, type SubType, type Subscription, type SubscriptionBase, type SubscriptionCancelled, type SubscriptionIncludes, type SubscriptionListParams, type SubscriptionOption, type SubscriptionOptionalCreateProps, type SubscriptionPreferences, type SubscriptionRequiredCreateProps, type SubscriptionSortBy, type SubscriptionStatus, type Subscription_2021_01, type SubscriptionsResponse, type TaxLine, type Tier, type TieredDiscount, type Translations, type UpdateAddressParams, type UpdateAddressRequest, type UpdateBundlePurchaseItem, type UpdateBundleSelectionRequest, type UpdateCustomerRequest, type UpdateMetafieldRequest, type UpdateOnetimeRequest, type UpdatePaymentMethodRequest, type UpdateSubscriptionChargeDateParams, type UpdateSubscriptionParams, type UpdateSubscriptionRequest, type UpdateSubscriptionsParams, type UpdateSubscriptionsRequest, type Variant, type VariantSelector, type VariantSelectorStepSetting, type WidgetIconColor, type WidgetTemplateType, type WidgetVisibility, activateMembership, activateSubscription, api, applyDiscountToAddress, applyDiscountToCharge, cancelMembership, cancelSubscription, changeMembership, createAddress, createBundleSelection, createMetafield, createOnetime, createPaymentMethod, createSubscription, createSubscriptions, delayOrder, deleteAddress, deleteBundleSelection, deleteMetafield, deleteOnetime, deleteSubscriptions, getActiveChurnLandingPageURL, getAddress, getBundleId, getBundleSelection, getBundleSelectionId, getCDNBundleSettings, getCDNProduct, getCDNProductAndSettings, getCDNProducts, getCDNProductsAndSettings, getCDNStoreSettings, getCDNWidgetSettings, getCharge, getCollection, getCreditSummary, getCustomer, getCustomerPortalAccess, getDeliverySchedule, getDynamicBundleItems, getFailedPaymentMethodRecoveryLandingPageURL, getGiftPurchase, getGiftRedemptionLandingPageURL, getMembership, getMembershipProgram, getOnetime, getOrder, getPaymentMethod, getPlan, getShippingCountries, getStoreSettings, getSubscription, initRecharge, type intervalUnit, listAddresses, listBundleSelections, listCharges, listCollectionProducts, listCollections, listCreditAccounts, listGiftPurchases, listMembershipPrograms, listMemberships, listOnetimes, listOrders, listPaymentMethods, listPlans, listSubscriptions, loadBundleData, loginCustomerPortal, loginShopifyApi, loginShopifyAppProxy, loginWithShopifyCustomerAccount, loginWithShopifyStorefront, type membershipIncludes, mergeAddresses, processCharge, productSearch, removeDiscountsFromAddress, removeDiscountsFromCharge, resetCDNCache, sendCustomerNotification, sendPasswordlessCode, sendPasswordlessCodeAppProxy, setApplyCreditsToNextCharge, skipCharge, skipFutureCharge, skipGiftSubscriptionCharge, skipSubscriptionCharge, unskipCharge, updateAddress, updateBundle, updateBundleSelection, updateCustomer, updateMetafield, updateOnetime, updatePaymentMethod, updateSubscription, updateSubscriptionAddress, updateSubscriptionChargeDate, updateSubscriptions, validateBundle, validateBundleSelection, validateDynamicBundle, validatePasswordlessCode, validatePasswordlessCodeAppProxy };
|