types.d.ts — SureCart – Ecommerce Made Easy For Selling Physical Products, Digital Downloads, Subscriptions, Donations, & Payments 4.7.1

surecart / dist / components / types / types.d.ts

surecart / dist / components / types Last commit date

components 4 days ago functions 1 week ago global 4 years ago services 1 month ago store 1 month ago testing 1 year ago components.d.ts 1 week ago global.d.ts 4 years ago index.d.ts 1 month ago stencil-public-runtime.d.ts 1 year ago types.d.ts 1 week ago

types.d.ts

1554 lines

1	import { ObservableMap } from '@stencil/store';
2	import { StripeElementChangeEvent } from '@stripe/stripe-js';
3	export type IconLibraryResolver = (name: string) => string;
4	export type IconLibraryMutator = (svg: SVGElement) => void;
5	export interface IconLibraryOptions {
6	resolver: IconLibraryResolver;
7	mutator?: IconLibraryMutator;
8	}
9	declare global {
10	interface Window {
11	grecaptcha: any;
12	surecart?: {
13	product?: {
14	store: ObservableMap<any>;
15	state: any;
16	update: Function;
17	};
18	};
19	wp: {
20	apiFetch: any;
21	blocks: any;
22	i18n: any;
23	hooks: {
24	applyFilters?: (filterName: string, defaultValue: any, ...args: any[]) => any;
25	};
26	};
27	dataLayer: any;
28	gtag: any;
29	fbq: any;
30	sc?: {
31	store?: {
32	product?: any;
33	products?: any;
34	};
35	checkout?: {
36	addLineItem: (data: any) => void;
37	};
38	cart?: {
39	toggle: (open: boolean) => void;
40	};
41	};
42	scStore: any;
43	registerSureCartIconPath: (path: string) => void;
44	registerSureCartIconLibrary: (name: string, options: IconLibraryOptions) => void;
45	scIcons: {
46	path: string;
47	};
48	scData: {
49	cdn_root: string;
50	root_url: string;
51	account_id: string;
52	account_slug: string;
53	locale: string;
54	api_url: string;
55	home_url: string;
56	plugin_url: string;
57	page_id: string;
58	persist_cart: 'browser' \| 'url' \| false;
59	nonce: string;
60	base_url: string;
61	nonce_endpoint: string;
62	recaptcha_site_key: string;
63	theme: string;
64	product_data: {
65	checkout_link: string;
66	mode: 'live' \| 'test';
67	form: {
68	ID: number;
69	};
70	product: Product;
71	};
72	pages: {
73	dashboard: string;
74	checkout: string;
75	};
76	currency: string;
77	is_claimed: string;
78	claim_url: string;
79	admin_url: string;
80	user_permissions: {
81	manage_sc_shop_settings: boolean;
82	};
83	google_map_api_key: string;
84	current_user_roles: string[];
85	tracking?: {
86	facebook?: boolean;
87	google?: boolean;
88	};
89	};
90	ceRegisterIconLibrary: any;
91	ResizeObserver: any;
92	scIconLibraries: IconLibrary[];
93	}
94	}
95	export type RecursivePartial<T> = {
96	[P in keyof T]?: RecursivePartial<T[P]>;
97	};
98	interface Model {
99	created_at: number;
100	updated_at: number;
101	}
102	export interface IconLibrary extends IconLibraryOptions {
103	name: string;
104	}
105	export interface ChoiceItem extends Object {
106	value: string;
107	label: string;
108	description?: string;
109	disabled?: boolean;
110	checked?: boolean;
111	unavailable?: boolean;
112	choices?: ChoiceItem[];
113	suffix?: string;
114	suffixDescription?: string;
115	icon?: string;
116	}
117	export type ChoiceType = 'all' \| 'single' \| 'multiple';
118	export interface Swap {
119	id: string;
120	object: 'swap';
121	archived: boolean;
122	archived_at?: string;
123	description: string;
124	metadata: {
125	[key: string]: string;
126	};
127	price: string \| Price;
128	swap_price: string \| Price;
129	discarded_at?: number;
130	created_at: number;
131	updated_at: number;
132	}
133	export interface Price {
134	id: string;
135	name: string;
136	description?: string;
137	amount: number;
138	display_amount: string;
139	setup_fee_display_amount: string;
140	setup_fee_text: string;
141	full_amount: number;
142	currency: string;
143	recurring: boolean;
144	recurring_interval?: 'week' \| 'month' \| 'year' \| 'never';
145	recurring_interval_count?: number;
146	trial_duration_days?: number;
147	trial_text?: string;
148	ad_hoc: boolean;
149	ad_hoc_max_amount: number;
150	ad_hoc_min_amount: number;
151	scratch_amount: number;
152	scratch_display_amount: string;
153	setup_fee_enabled: boolean;
154	setup_fee_amount: number;
155	short_interval_text: string;
156	short_interval_count_text: string;
157	interval_text: string;
158	interval_count_text: string;
159	setup_fee_name: string;
160	setup_fee_trial_enabled: boolean;
161	recurring_period_count: number;
162	archived: boolean;
163	product_id?: string;
164	archived_at?: string;
165	created_at: number;
166	updated_at: number;
167	product?: Product \| string;
168	position: number;
169	portal_subscription_update_enabled: boolean;
170	metadata: {
171	[key: string]: string;
172	};
173	current_swap?: Swap;
174	}
175	export interface VariantOption {
176	id: string;
177	object: string;
178	name: string;
179	position: number;
180	product: Product \| string;
181	display_type: 'dropdown' \| 'pills';
182	updated_at: number;
183	created_at: number;
184	label: string;
185	labels: string;
186	values: Array<string>;
187	}
188	export interface Bump {
189	id: string;
190	object: 'bump';
191	amount_off: number;
192	amount_off_display_amount: string;
193	subtotal_display_amount: string;
194	subtotal_amount: number;
195	total_display_amount: string;
196	total_amount: number;
197	archived: boolean;
198	archived_at: number;
199	auto_apply: boolean;
200	filter_match_type: 'all' \| 'any' \| 'none';
201	filters: any;
202	metadata: any;
203	rendered_description: string;
204	name: string;
205	percent_off: number;
206	price: string \| Price;
207	priority: 1 \| 2 \| 3 \| 4 \| 5;
208	created_at: number;
209	updated_at: number;
210	}
211	export interface UpsellFunnel {
212	id: string;
213	object: 'upsell_funnel';
214	archived: boolean;
215	enabled: boolean;
216	filter_match_type: 'all' \| 'any' \| 'none';
217	filter_price_ids: string[];
218	filter_product_ids: string[];
219	metadata: any;
220	name: string;
221	priority: number;
222	upsells: {
223	object: 'list';
224	pagination: Pagination;
225	data: Array<Upsell>;
226	};
227	archived_at: number;
228	discarded_at: number;
229	created_at: number;
230	updated_at: number;
231	}
232	export interface Upsell {
233	id: string;
234	object: 'upsell';
235	amount_off: number;
236	metadata: any;
237	fee_description: string;
238	duplicate_purchase_behavior: 'allow' \| 'block' \| 'block_within_checkout';
239	percent_off: number;
240	price: string \| Price;
241	step: 'initial' \| 'accepted' \| 'declined';
242	upsell_funnel: string \| UpsellFunnel;
243	permalink: string;
244	discarded_at: number;
245	created_at: number;
246	updated_at: number;
247	}
248	export type Prices = {
249	[id: string]: Price;
250	};
251	export interface Media {
252	id: string;
253	object: 'media';
254	byte_size: number;
255	content_type: string;
256	extension: string;
257	filename: string;
258	public_access: boolean;
259	release_json: any;
260	alt: string;
261	title: string;
262	url?: string;
263	url_expires_at?: number;
264	updated_at: number;
265	created_at: number;
266	}
267	export interface Download {
268	id: string;
269	object: 'download';
270	archived: boolean;
271	archived_at?: number;
272	media: string \| Media;
273	name?: string;
274	product: string \| Product;
275	update_at: number;
276	created_at: number;
277	url?: string;
278	}
279	export type FormState = 'idle' \| 'loading' \| 'draft' \| 'updating' \| 'finalizing' \| 'paying' \| 'confirming' \| 'confirmed' \| 'paid' \| 'failure' \| 'expired' \| 'redirecting';
280	export type FormStateSetter = 'RESOLVE' \| 'REJECT' \| 'FINALIZE' \| 'PAYING' \| 'PAID' \| 'EXPIRE' \| 'FETCH';
281	export interface License {
282	id: string;
283	object: 'license';
284	activation_limit: number;
285	activation_count: number;
286	key: string;
287	activations?: {
288	object: 'list';
289	pagination: Pagination;
290	data: Array<Activation>;
291	};
292	status: 'inactive' \| 'active' \| 'revoked';
293	purchase: string \| Purchase;
294	created_at: number;
295	created_at_date: string;
296	updated_at: number;
297	updated_at_date: string;
298	}
299	export interface CancellationReason {
300	id: string;
301	object: 'cancellation_reason';
302	archived: boolean;
303	comment_enabled: false;
304	comment_prompt: string \| null;
305	coupon_enabled: boolean;
306	label: string;
307	position: number;
308	archived_at: number;
309	discarded_at: number;
310	created_at: number;
311	updated_at: number;
312	}
313	export interface Period {
314	id: string;
315	object: 'period';
316	ad_hoc_amount?: number;
317	checkout: string \| Checkout;
318	customer_id: string \| Customer;
319	end_at?: number;
320	end_at_date?: string;
321	next_payment_retry_at: number;
322	payment_retry_count: number;
323	price: string \| Price;
324	purchase_id: string \| Purchase;
325	quantity: number;
326	renewal: boolean;
327	skip_proration: boolean;
328	start_at: number;
329	start_at_date?: string;
330	status: 'draft';
331	subscription: string \| Subscription;
332	created_at: number;
333	created_at_date: string;
334	updated_at: number;
335	updated_at_date: string;
336	}
337	export interface Activation {
338	id: string;
339	object: 'activation';
340	name: string;
341	counted: boolean;
342	fingerprint: string;
343	license: string \| License;
344	created_at: number;
345	created_at_date: string;
346	updated_at: number;
347	updated_at_date: string;
348	}
349	export interface Variant {
350	id: string;
351	amount: number;
352	available_stock: number;
353	currency: string;
354	current_version: boolean;
355	held_stock: number;
356	stock: number;
357	object: 'variant';
358	image?: string \| Media;
359	image_url?: string;
360	option_1?: string \| null;
361	option_2?: string \| null;
362	option_3?: string \| null;
363	position: number;
364	product: string \| Product;
365	sku?: string \| null;
366	display_amount?: string;
367	has_unlimited_stock?: boolean \| null;
368	downloads_enabled?: boolean \| null;
369	current_release_download?: string \| Download \| null;
370	downloads?: {
371	object: 'list';
372	pagination: Pagination;
373	data: Array<Download>;
374	};
375	created_at: number;
376	updated_at: number;
377	}
378	export interface ProductMetrics {
379	currency: string;
380	max_price_amount: number;
381	min_price_amount: number;
382	prices_count: number;
383	}
384	export interface Product extends Object {
385	id: string;
386	name: string;
387	description: string;
388	archived: boolean;
389	archived_at: string;
390	metadata: any;
391	image_url: string;
392	recurring: boolean;
393	tax_category: string;
394	tax_enabled: boolean;
395	purchase_limit: number;
396	metrics: ProductMetrics;
397	line_item_image: ImageAttributes;
398	permalink: string;
399	weight: number;
400	weight_unit: 'kg' \| 'lb' \| 'g' \| 'oz';
401	shipping_enabled?: boolean;
402	featured_product_media?: string \| ProductMedia;
403	prices: {
404	object: 'list';
405	pagination: Pagination;
406	data: Array<Price>;
407	};
408	variants: {
409	object: 'list';
410	pagination: Pagination;
411	data: Array<Variant>;
412	};
413	variant_options: {
414	object: 'list';
415	pagination: Pagination;
416	data: Array<VariantOption>;
417	};
418	/**
419	* Whether this product is a bundle. Set on create, immutable thereafter.
420	* A bundle product owns BundleItems pointing at component products.
421	*/
422	bundle?: boolean;
423	bundle_items?: {
424	object: 'list';
425	pagination: Pagination;
426	data: Array<BundleItem>;
427	};
428	product_medias: {
429	object: 'list';
430	pagination: Pagination;
431	data: Array<ProductMedia>;
432	};
433	downloads: {
434	object: 'list';
435	pagination: Pagination;
436	data: Array<Download>;
437	};
438	product_collections: {
439	object: 'list';
440	pagination: Pagination;
441	data: Array<Collection>;
442	};
443	stock_enabled: boolean;
444	allow_out_of_stock_purchases: boolean;
445	has_unlimited_stock: boolean;
446	stock: number;
447	available_stock: number;
448	held_stock: number;
449	review_url?: string;
450	created_at: number;
451	updated_at: number;
452	}
453	export type Products = {
454	[id: string]: Product;
455	};
456	export interface Collection extends Object {
457	id: string;
458	name: string;
459	description: string;
460	image_url: string;
461	created_at: number;
462	updated_at: number;
463	}
464	export interface Coupon extends Model {
465	id: string;
466	object: 'coupon';
467	amount_off: number;
468	valid?: boolean;
469	expired: boolean;
470	currency: string;
471	duration: string;
472	duration_in_months: number;
473	max_redemptions: number;
474	metadata: Object;
475	name: string;
476	percent_off: number;
477	redeem_by: number;
478	times_redeemed: number;
479	}
480	export interface LineItemData extends Object {
481	id?: string;
482	price_id?: string;
483	variant_id?: string;
484	bump?: string;
485	quantity: number;
486	ad_hoc_amount?: number;
487	variant?: string;
488	bundle_component_variants?: Record<string, string>;
489	}
490	export type LineItemsData = {
491	[id: string]: Array<LineItemData>;
492	};
493	export interface ImageAttributes {
494	src: string;
495	alt?: string;
496	class?: string;
497	decoding?: string;
498	height?: number;
499	loading?: string;
500	sizes?: string;
501	srcset?: string;
502	width?: number;
503	type?: string;
504	}
505	export interface LineItem extends Object {
506	id?: string;
507	ad_hoc_amount?: number;
508	ad_hoc_display_amount?: string;
509	name: string;
510	object: string;
511	quantity: number;
512	currency: string;
513	checkout: string \| Checkout;
514	bump: string \| Bump;
515	image: ImageAttributes;
516	fees?: {
517	object: 'list';
518	pagination: Pagination;
519	data: Array<Fee>;
520	};
521	bump_amount: number;
522	bump_display_amount: string;
523	discount_amount: number;
524	subtotal_amount: number;
525	subtotal_display_amount?: string;
526	total_amount: number;
527	total_default_currency_display_amount: string;
528	total_display_amount: string;
529	trial_amount: number;
530	tax_amount: number;
531	tax_display_amount: string;
532	fees_amount: number;
533	scratch_amount: number;
534	scratch_display_amount?: string;
535	subtotal_with_upsell_discount_display_amount?: string;
536	subtotal_with_upsell_discount_amount?: number;
537	trial: boolean;
538	total_savings_amount: number;
539	created_at: number;
540	updated_at: number;
541	price?: Price;
542	price_id: string;
543	sku: string;
544	purchasable_status: 'price_gone' \| 'price_old_version' \| 'variant_mising' \| 'variant_gone' \| 'variant_old_version' \| 'out_of_stock' \| 'exceeds_purchase_limit' \| 'purchasable';
545	purchasable_status_display: string;
546	variant_options: Array<string>;
547	variant_display_options: string;
548	variant?: Variant;
549	locked: boolean;
550	swap?: Swap;
551	is_swappable?: boolean;
552	note?: string;
553	display_note?: string;
554	component_line_item?: boolean;
555	component_line_items?: {
556	data: LineItem[];
557	};
558	/** Sort order within the bundle, mirroring the bundle item's position. */
559	position?: number;
560	/** Id of the bundle parent line item (set on bundle component line items). */
561	bundle_line_item?: string \| null;
562	bundle_component_variants?: Record<string, string>;
563	bundle_allocated_unit_amount?: number;
564	is_bundle_parent?: boolean;
565	is_bundle_component?: boolean;
566	tax_rate?: number;
567	}
568	export interface DeletedItem {
569	cache_status: string;
570	deleted: boolean;
571	id: string;
572	object: string;
573	}
574	export interface Fee {
575	id: string;
576	object: 'fee';
577	amount: number;
578	display_amount: string;
579	description: string;
580	fee_type: 'manual' \| 'bump' \| 'setup' \| 'upsell';
581	line_item: string \| LineItem;
582	created_at: number;
583	updated_at: number;
584	}
585	/**
586	* BundleItem — a join between a bundle Product and one of its component Products.
587	*
588	* Variant selection is NOT pinned here; the shopper picks at checkout via
589	* `bundle_component_variants` on the bundle line item. Components are always
590	* Products, never Prices or Variants.
591	*/
592	export interface BundleItem {
593	id: string;
594	object: 'bundle_item';
595	/** The parent bundle product (the one with bundle: true). */
596	bundle_product: string \| Product;
597	/** The component product included in the bundle. Must not itself be a bundle. */
598	component_product: string \| Product;
599	/**
600	* Shortcut association: the component product's variants with live stock,
601	* one level shallower than the (dropped) component_product.variants expand.
602	*/
603	component_variants?: {
604	object: 'list';
605	pagination?: Pagination;
606	data: Variant[];
607	};
608	/** Shortcut association: the component product's variant option dimensions. */
609	component_variant_options?: {
610	object: 'list';
611	pagination?: Pagination;
612	data: VariantOption[];
613	};
614	quantity: number;
615	/** Optional weighting input (cents) for tax allocation. Nil → even split by quantity. */
616	basis_amount?: number \| null;
617	position: number;
618	/** Whether this is the current version of the bundle item. */
619	current_version?: boolean;
620	metadata?: {
621	[key: string]: string;
622	};
623	created_at: number;
624	updated_at: number;
625	}
626	export interface BundleComponentRow {
627	id: string;
628	name: string;
629	variants: string;
630	qty: number;
631	}
632	export interface InvoiceItem extends LineItem {
633	}
634	export interface PriceChoice {
635	id: string;
636	product_id: string;
637	quantity: number;
638	enabled: boolean;
639	selected?: boolean;
640	variant?: string \| null;
641	}
642	export type CheckoutState = 'idle' \| 'loading' \| 'draft' \| 'updating' \| 'finalized' \| 'paid' \| 'failure';
643	export type TaxStatus = 'disabled' \| 'address_invalid' \| 'reverse_charged' \| 'tax_registration_not_found' \| 'tax_zone_not_found' \| 'estimated' \| 'calculated';
644	export interface Invoice extends Object {
645	id: string;
646	object: 'invoice';
647	automatic_collection: boolean;
648	due_date?: number;
649	due_date_date?: string;
650	issue_date?: number;
651	issue_date_date?: string;
652	footer?: string;
653	memo?: string;
654	live_mode: boolean;
655	status: InvoiceStatus;
656	checkout: Checkout \| string;
657	metadata: object;
658	order_number: string;
659	created_at: number;
660	created_at_date: string;
661	updated_at: number;
662	updated_at_date: string;
663	}
664	export interface BillingAddress extends Address {
665	}
666	export interface ShippingAddress extends Address {
667	}
668	export interface ProductGroup {
669	id: string;
670	object: 'product_group';
671	archived: boolean;
672	archived_at: number;
673	metadata: object;
674	name: string;
675	created_at: number;
676	updated_at: number;
677	}
678	export interface ProductMedia {
679	id: string;
680	object: 'product_media';
681	position: number;
682	url: null;
683	media: string \| Media;
684	product: string \| Product;
685	created_at: number;
686	updated_at: number;
687	}
688	export interface Charge extends Object {
689	amount: number;
690	created_at: number;
691	created_at_date: string;
692	currency: string;
693	display_amount: string;
694	customer: string \| Customer;
695	external_charge_id: string;
696	fully_refunded: boolean;
697	id: string;
698	invoice: string \| Invoice;
699	live_mode: boolean;
700	object: 'charge';
701	checkout: string \| Checkout;
702	payment_method: string \| PaymentMethod;
703	refunded_amount: number;
704	disputed_amount: number;
705	status: 'pending' \| 'succeeded' \| 'failed';
706	updated_at: number;
707	updated_at_date: string;
708	}
709	export interface TaxIdentifier {
710	id: string;
711	number: string;
712	number_type: string;
713	object: 'tax_identifier';
714	eu_vat_verified: boolean;
715	created_at: number;
716	updated_at: number;
717	}
718	export interface TaxProtocol {
719	id: string;
720	object: 'tax_protocol';
721	ca_tax_enabled: boolean;
722	eu_micro_exemption_enabled: boolean;
723	eu_tax_enabled: boolean;
724	eu_vat_required: boolean;
725	eu_vat_unverified_behavior: 'error' \| 'apply_reverse_charge' \| 'skip_reverse_charge';
726	eu_vat_local_reverse_charge: boolean;
727	tax_enabled: boolean;
728	address: string \| Address;
729	ca_tax_identifier: string \| TaxIdentifier;
730	eu_tax_identifier: string \| TaxIdentifier;
731	created_at: number;
732	updated_at: number;
733	}
734	export interface Order extends Object {
735	id?: string;
736	object: 'order';
737	number?: string;
738	order_type?: 'checkout' \| 'subscription';
739	statement_url?: string;
740	status?: OrderStatus;
741	shipment_status?: OrderShipmentStatus;
742	checkout?: Checkout \| string;
743	invoice?: Invoice \| string;
744	created_at: number;
745	created_at_date: string;
746	updated_at: number;
747	updated_at_date: string;
748	}
749	export interface ShippingChoice {
750	amount: number;
751	display_amount: string;
752	checkout: string \| Checkout;
753	currency: string;
754	id: string;
755	object: 'shipping_choice';
756	shipping_method: string \| ShippingMethod;
757	created_at: number;
758	updated_at: number;
759	}
760	export interface ShippingMethod {
761	name: string;
762	description: string;
763	id: string;
764	object: 'shipping_method';
765	position: number;
766	created_at: number;
767	updated_at: number;
768	}
769	export interface Checkout extends Object {
770	id?: string;
771	status?: 'canceled' \| 'draft' \| 'finalized' \| 'paid' \| 'payment_intent_canceled' \| 'payment_failed' \| 'processing';
772	tax_amount: number;
773	tax_display_amount: string;
774	tax_inclusive_amount: number;
775	tax_exclusive_amount: number;
776	tax_status: 'disabled' \| 'address_invalid' \| 'estimated' \| 'calculated';
777	tax_label: string;
778	tax_percent: number;
779	tax_enabled: boolean;
780	email_exists: boolean;
781	show_converted_total: boolean;
782	staged_payment_intents: {
783	object: 'list';
784	pagination: Pagination;
785	data: Array<PaymentIntent>;
786	};
787	abandoned_checkout_enabled: boolean;
788	billing_matches_shipping: boolean;
789	bump_amount: number;
790	bump_display_amount: string;
791	payment_method_required?: boolean;
792	manual_payment: boolean;
793	manual_payment_method?: string \| ManualPaymentMethod;
794	reusable_payment_method_required?: boolean;
795	number?: string;
796	amount_due?: number;
797	amount_due_display_amount?: string;
798	/** PHP model accessor: line item count excluding bundle containers. */
799	delivered_items_count?: number;
800	amount_due_default_currency_display_amount?: string;
801	remaining_amount_due?: number;
802	remaining_amount_due_display_amount?: string;
803	trial_amount?: number;
804	trial_display_amount?: string;
805	charge?: string \| Charge;
806	name?: string;
807	first_name?: string;
808	last_name?: string;
809	email?: string;
810	phone?: string;
811	live_mode?: boolean;
812	currency?: string;
813	current_currency?: string;
814	discounts_display_amount?: string;
815	discounts_display?: string;
816	tax_exclusive_display_amount?: string;
817	tax_inclusive_display_amount?: string;
818	total_amount?: number;
819	total_display_amount?: string;
820	subtotal_amount?: number;
821	subtotal_display_amount?: string;
822	full_amount?: number;
823	full_display_amount?: string;
824	paid_amount?: number;
825	paid_display_amount?: string;
826	proration_amount?: number;
827	proration_display_amount?: string;
828	total_savings_amount?: number;
829	total_savings_display_amount?: string;
830	total_scratch_display_amount?: string;
831	applied_balance_amount?: number;
832	applied_balance_display_amount?: string;
833	scratch_display_amount?: string;
834	discounts?: number;
835	shipping_address_required?: boolean;
836	shipping_address_accuracy_requirement?: 'full' \| 'tax' \| 'none';
837	line_items: lineItems;
838	recommended_bumps?: {
839	object: 'list';
840	pagination: Pagination;
841	data: Array<Bump>;
842	};
843	current_upsell: Upsell;
844	recommended_upsells?: {
845	object: 'list';
846	pagination: Pagination;
847	data: Array<Upsell>;
848	};
849	metadata?: any;
850	payment_intent?: PaymentIntent;
851	payment_method?: PaymentMethod;
852	order?: string \| Order;
853	customer: string \| Customer;
854	subscriptions: {
855	object: 'list';
856	pagination: Pagination;
857	data: Array<Subscription>;
858	};
859	checkout_fees: {
860	object: 'list';
861	pagination: Pagination;
862	data: Array<Fee>;
863	};
864	shipping_fees: {
865	object: 'list';
866	pagination: Pagination;
867	data: Array<Fee>;
868	};
869	purchases: {
870	object: 'list';
871	pagination: Pagination;
872	data: Array<Purchase>;
873	};
874	discount_amount?: number;
875	discount?: DiscountResponse;
876	billing_address?: string \| Address;
877	geo_address?: string \| Address;
878	latitude?: number;
879	longitude?: number;
880	shipping_amount?: number;
881	shipping_display_amount?: string;
882	shipping_address?: string \| Address;
883	shipping_enabled?: boolean;
884	shipping_choices?: {
885	object: 'list';
886	pagination: Pagination;
887	data: Array<ShippingChoice>;
888	};
889	selected_shipping_choice?: string \| ShippingChoice;
890	selected_shipping_choice_required: boolean;
891	processor_data?: ProcessorData;
892	tax_identifier?: {
893	number: string;
894	number_type: string;
895	};
896	url: string;
897	created_at?: number;
898	updated_at: number;
899	variant: string;
900	upsells_expire_at?: number;
901	invoice?: string \| Invoice;
902	pdf_url?: string;
903	refunded_amount?: number;
904	refunded_display_amount?: string;
905	net_paid_amount?: number;
906	net_paid_display_amount?: string;
907	credited_balance_amount?: number;
908	credited_balance_display_amount?: string;
909	tax_reverse_charged_amount?: number;
910	tax_reverse_charged_display_amount?: string;
911	}
912	export interface ShippingMethod {
913	id: string;
914	object: 'shipping_method';
915	description: string \| null;
916	name: string;
917	position: number;
918	created_at: number;
919	updated_at: number;
920	}
921	export interface ShippingChoice {
922	id: string;
923	object: 'shipping_choice';
924	amount: number;
925	currency: string;
926	checkout: string \| Checkout;
927	shipping_method: string \| ShippingMethod;
928	created_at: number;
929	updated_at: number;
930	}
931	export interface ProcessorData {
932	stripe: {
933	account_id: string;
934	publishable_key: string;
935	client_secret?: string;
936	type: 'payment' \| 'setup';
937	};
938	paypal: {
939	account_id: string;
940	client_id: string;
941	merchant_initiated: boolean;
942	};
943	mollie?: {
944	account_id: 'string';
945	checkout_url: 'string';
946	};
947	paystack: {
948	account_id: string;
949	public_key: string;
950	access_code: string;
951	};
952	razorpay?: {
953	account_id: string;
954	key_id: string;
955	order_id: string;
956	public_key: string;
957	access_code: string;
958	customer_id: string;
959	};
960	}
961	export interface RazorpayOptions {
962	key: string;
963	order_id: string;
964	prefill?: {
965	name?: string;
966	email?: string;
967	contact?: string;
968	};
969	customer_id?: string;
970	recurring?: boolean;
971	handler: (response: any) => void;
972	modal?: {
973	ondismiss: () => void;
974	};
975	}
976	export interface RazorpayInstance {
977	open: () => void;
978	on: (event: string, callback: (response: any) => void) => void;
979	}
980	export type RazorpayConstructor = new (options: RazorpayOptions) => RazorpayInstance;
981	export interface ManualPaymentMethod {
982	id: string;
983	object: 'manual_payment_method';
984	archived: boolean;
985	archived_at: number;
986	description: string;
987	instructions: string;
988	name: string;
989	created_at: number;
990	updated_at: number;
991	}
992	export interface PaymentMethodType {
993	id: string;
994	description: string;
995	image: string;
996	}
997	export interface Processor {
998	id: string;
999	live_mode: boolean;
1000	processor_data: {
1001	account_id: string;
1002	recurring_enabled: boolean;
1003	client_id: string;
1004	merchant_initiated?: boolean;
1005	};
1006	recurring_enabled: boolean;
1007	supported_currencies: Array<string>;
1008	processor_type: 'paypal' \| 'stripe' \| 'mollie' \| 'mock';
1009	}
1010	export interface Purchase {
1011	id: string;
1012	object: 'purchase';
1013	live_mode: boolean;
1014	quantity: number;
1015	revoked: boolean;
1016	revoked_at: number;
1017	customer: string \| Customer;
1018	invoice_item: string \| InvoiceItem;
1019	invoice: string \| Invoice;
1020	line_item: string \| LineItem;
1021	order: string \| Order;
1022	product: string \| Product;
1023	variant?: string \| Variant;
1024	refund: string \| Refund;
1025	subscription: string \| Subscription;
1026	license: string \| License;
1027	created_at: number;
1028	updated_at: number;
1029	}
1030	export interface Refund {
1031	id: string;
1032	object: 'refund';
1033	amount: number;
1034	currency: string;
1035	external_refund_id: string;
1036	live_mode: boolean;
1037	metadata: object;
1038	reason: 'duplicate' \| 'fraudulent' \| 'requested_by_customer' \| 'expired_uncaptured_charge';
1039	status: 'pending' \| 'succeeded' \| 'failed' \| 'canceled';
1040	charge: string \| Charge;
1041	customer: string \| Customer;
1042	revoked_purchases: null \| Array<Purchase>;
1043	created_at: number;
1044	updated_at: number;
1045	}
1046	export interface Subscription extends Object {
1047	id: string;
1048	object: 'subscription';
1049	currency?: string;
1050	status: SubscriptionStatus;
1051	live_mode: boolean;
1052	external_subscription_id: string;
1053	current_cancellation_act: string \| CancellationAct;
1054	trial_end_at: number;
1055	trial_end_at_date: string;
1056	trial_end_at_date_time: string;
1057	processor_type: 'stripe' \| 'paypal';
1058	order: Order;
1059	customer: Customer;
1060	discount: DiscountResponse;
1061	finite: boolean;
1062	pending_update: {
1063	ad_hoc_amount?: number;
1064	price?: string;
1065	quantity?: number;
1066	variant?: string;
1067	};
1068	purchase: Purchase \| string;
1069	cancel_at_period_end: number \| false;
1070	current_period: string \| Period;
1071	current_period_end_at: number \| false;
1072	current_period_end_at_date: string;
1073	current_period_end_at_date_time: string;
1074	current_period_start_at: number \| false;
1075	current_period_start_at_date: string;
1076	remaining_period_count: number \| null;
1077	remaining_period_text: string;
1078	ended_at: number;
1079	ended_at_date: string;
1080	end_behavior: 'cancel' \| 'complete';
1081	payment_method: PaymentMethod \| string;
1082	manual_payment_method: ManualPaymentMethod \| string;
1083	manual_payment: boolean;
1084	price: Price;
1085	ad_hoc_amount: number;
1086	variant?: Variant \| string;
1087	variant_options?: Array<string>;
1088	created_at: number;
1089	created_at_date: string;
1090	updated_at: number;
1091	updated_at_date: string;
1092	restore_at?: number;
1093	can_modify?: boolean;
1094	}
1095	export interface CancellationAct {
1096	id: string;
1097	object: 'cancellation_act';
1098	cancellation_reason: string \| CancellationReason;
1099	comment: string;
1100	coupon_applied: boolean;
1101	preserved: boolean;
1102	subscription: string \| Subscription;
1103	performed_at: number;
1104	created_at: number;
1105	updated_at: number;
1106	}
1107	export interface SubscriptionProtocol {
1108	id: string;
1109	object: 'subscription_protocol';
1110	cancel_behavior: 'pending' \| 'immediate';
1111	downgrade_behavior: 'pending' \| 'immediate';
1112	payment_retry_window_weeks: number;
1113	upgrade_behavior: 'pending' \| 'immediate';
1114	preservation_enabled: boolean;
1115	preservation_locales: {
1116	reasons_title: string;
1117	reasons_description: string;
1118	skip_link: string;
1119	preserve_title: string;
1120	preserve_description: string;
1121	preserve_button: string;
1122	cancel_link: string;
1123	};
1124	preservation_coupon: Coupon \| string;
1125	created_at: number;
1126	updated_at: number;
1127	}
1128	export type SubscriptionStatus = 'incomplete' \| 'trialing' \| 'active' \| 'past_due' \| 'canceled' \| 'unpaid' \| 'completed';
1129	export type CheckoutStatus = 'draft' \| 'finalized' \| 'paid' \| 'payment_intent_canceled' \| 'payment_failed' \| 'requires_approval';
1130	export type OrderStatus = 'paid' \| 'payment_failed' \| 'processing' \| 'void' \| 'canceled' \| 'draft';
1131	export type InvoiceStatus = 'paid' \| 'open' \| 'draft';
1132	export type OrderFulFillmentStatus = 'fulfilled' \| 'unfulfilled' \| 'partially_fulfilled' \| 'scheduled' \| 'on_hold';
1133	export type OrderShipmentStatus = 'unshipped' \| 'shipped' \| 'partially_shipped' \| 'delivered' \| 'unshippable' \| 'label_purchased' \| 'in_transit';
1134	export type FulfillmentStatus = 'unshipped' \| 'shipped' \| 'delivered' \| 'unshippable' \| 'label_purchased' \| 'in_transit' \| 'returned' \| 'failed' \| 'voided';
1135	export type ReturnRequestStatus = 'open' \| 'completed';
1136	export interface PaymentMethod extends Object {
1137	id: string;
1138	object: 'payment_method';
1139	live_mode: boolean;
1140	external_payment_method_id: string;
1141	processor_type: 'stripe' \| 'paypal';
1142	paypal_account: any;
1143	type: string;
1144	bank_account: BankAccount \| string;
1145	payment_instrument: PaymentInstrument \| string;
1146	payment_method_name: string;
1147	payment_intent: PaymentIntent \| string;
1148	billing_agreement?: BillingAgreement \| string;
1149	card: any;
1150	customer: Customer \| string;
1151	created_at: number;
1152	updated_at: number;
1153	}
1154	export interface BankAccount {
1155	id: string;
1156	account_type: 'checking' \| 'savings';
1157	account_holder_type: 'individual' \| 'company';
1158	bank_name: string;
1159	last4: string;
1160	created_at: number;
1161	updated_at: number;
1162	}
1163	export interface PaymentInstrument {
1164	id: string;
1165	instrument_type: string;
1166	metadata: any;
1167	object: 'payment_instrument';
1168	created_at: number;
1169	updated_at: number;
1170	}
1171	export interface BillingAgreement {
1172	email: string;
1173	external_customer_id: string;
1174	first_name: string;
1175	id: string;
1176	last_name: string;
1177	phone: string;
1178	object: 'billing_agreement';
1179	created_at: number;
1180	updated_at: number;
1181	}
1182	export interface Pagination {
1183	count: number;
1184	limit: number;
1185	page: number;
1186	url: string;
1187	}
1188	export interface lineItems extends Object {
1189	object: 'list';
1190	pagination: Pagination;
1191	data: Array<LineItem>;
1192	}
1193	export interface Promotion extends Object {
1194	code: string;
1195	created_at: number;
1196	expired: boolean;
1197	id: string;
1198	max_redemptions: number;
1199	metadata: Object;
1200	object: 'promotion';
1201	redeem_by: string;
1202	times_redeemed: number;
1203	}
1204	export interface DiscountResponse {
1205	coupon?: Coupon;
1206	id: string;
1207	object: 'discount';
1208	promotion: Promotion;
1209	redeemable_status: string;
1210	}
1211	export interface ResponseError {
1212	code?: string;
1213	message: string;
1214	data?: {
1215	http_status: string;
1216	status?: number;
1217	type: string;
1218	};
1219	additional_errors?: Array<{
1220	code: string;
1221	message: string;
1222	data: {
1223	attribute: string;
1224	options: Array<string>;
1225	type: string;
1226	};
1227	}>;
1228	}
1229	export type ProcessorName = 'stripe' \| 'paypal' \| 'paypal-card';
1230	export interface VerificationCode {
1231	id: string;
1232	object: 'verification_code';
1233	code: number;
1234	verified: boolean;
1235	verified_at: number \| null;
1236	redirect_url: string \| null;
1237	created_at: number;
1238	updated_at: number;
1239	}
1240	export interface PaymentIntent extends Object {
1241	id: string;
1242	object: 'payment_intent';
1243	amount: number;
1244	currency: string;
1245	processor_type: 'stripe' \| 'paypal';
1246	status: 'pending' \| 'succeeded' \| 'canceled';
1247	external_intent_id: string;
1248	live_mode: boolean;
1249	processor_data: ProcessorData;
1250	customer: Customer \| string;
1251	created_at: number;
1252	updated_at: number;
1253	payment_method: PaymentMethod \| string;
1254	reusable: boolean;
1255	}
1256	export interface PaymentIntents {
1257	stripe?: PaymentIntent;
1258	paypal?: PaymentIntent;
1259	}
1260	export interface SetupIntent extends Object {
1261	id: string;
1262	object: 'setup_intent';
1263	processor_type: 'stripe' \| 'paypal';
1264	status: 'pending' \| 'succeeded' \| 'canceled';
1265	external_intent_id: string;
1266	live_mode: boolean;
1267	processor_data: ProcessorData;
1268	customer: Customer \| string;
1269	created_at: number;
1270	updated_at: number;
1271	}
1272	export interface WordPressUser {
1273	id: number;
1274	display_name: string;
1275	first_name: string;
1276	last_name: string;
1277	email: string;
1278	}
1279	export interface Customer extends Object {
1280	id: string;
1281	email: string;
1282	name?: string;
1283	first_name?: string;
1284	last_name?: string;
1285	phone?: string;
1286	billing_address?: string \| Address;
1287	billing_address_display?: string \| Address;
1288	shipping_address?: string \| Address;
1289	shipping_address_display?: string \| Address;
1290	billing_matches_shipping: boolean;
1291	live_mode: boolean;
1292	unsubscribed: boolean;
1293	default_payment_method: string \| PaymentMethod;
1294	tax_identifier: {
1295	number: string;
1296	number_type: string;
1297	};
1298	created_at: number;
1299	updated_at: number;
1300	}
1301	export interface Address extends Object {
1302	name?: string \| null;
1303	line_1?: string \| null;
1304	line_2?: string \| null;
1305	city?: string \| null;
1306	state?: string \| null;
1307	postal_code?: string \| null;
1308	country?: string \| null;
1309	}
1310	export interface GeoCapture {
1311	title?: string;
1312	content?: string;
1313	allowLabel?: string;
1314	declineLabel?: string;
1315	}
1316	export interface GeoCoordinates {
1317	latitude: number;
1318	longitude: number;
1319	}
1320	export interface GoogleMapAddressComponents extends Object {
1321	languageCode: string;
1322	longText: string;
1323	shortText: string;
1324	types: string[];
1325	}
1326	export interface GoogleMapAutocompletePrediction extends Object {
1327	placeId: string;
1328	text?: {
1329	text: string;
1330	};
1331	structuredFormat?: {
1332	mainText?: {
1333	text: string;
1334	};
1335	secondaryText?: {
1336	text: string;
1337	};
1338	};
1339	}
1340	export interface AddressSuggestion extends Object {
1341	displayName: string;
1342	fullDisplayName: string;
1343	placeId: string;
1344	addressComponents?: GoogleMapAddressComponents[];
1345	}
1346	export interface Fulfillment {
1347	id: string;
1348	object: 'fulfillment';
1349	number: string;
1350	shipment_status: FulfillmentStatus;
1351	trackings: {
1352	object: 'list';
1353	pagination: Pagination;
1354	data: Array<Tracking>;
1355	};
1356	fulfillment_items: {
1357	object: 'list';
1358	pagination: Pagination;
1359	data: Array<FulfillmentItem>;
1360	};
1361	shipments?: {
1362	object: 'list';
1363	pagination: Pagination;
1364	data: Array<Shipment>;
1365	};
1366	}
1367	export interface Shipment {
1368	id?: string;
1369	status?: 'draft' \| 'quoted' \| 'purchased' \| 'voided';
1370	tracking_number?: string;
1371	tracking_url?: string;
1372	carrier?: string;
1373	label_url?: string;
1374	}
1375	export interface FulfillmentItem {
1376	id: string;
1377	line_item: LineItem;
1378	quantity: number;
1379	fulfillment: string \| Fulfillment;
1380	}
1381	export interface Tracking {
1382	courier_name?: string;
1383	number: string;
1384	url: string;
1385	}
1386	export interface PriceData extends Object {
1387	price_id: string;
1388	quantity: number;
1389	removeable: boolean;
1390	}
1391	export type TaxZone = {
1392	label: string;
1393	label_small: string;
1394	};
1395	export type TaxZones = {
1396	[key in 'ca_gst' \| 'au_abn' \| 'gb_vat' \| 'eu_vat' \| 'other']: TaxZone;
1397	};
1398	export type RuleName = 'total' \| 'coupons' \| 'products' \| 'prices' \| 'shipping_country' \| 'billing_country' \| 'processors';
1399	export type ArrayOperators = 'all' \| 'any' \| 'none' \| 'exist' \| 'not_exist';
1400	export type NumberOperators = '==' \| '!=' \| '<' \| '>' \| '<=' \| '>=';
1401	export interface RuleGroup {
1402	group_id: string;
1403	rules: Rule[];
1404	}
1405	export interface Rule {
1406	condition: RuleName;
1407	operator: NumberOperators \| ArrayOperators;
1408	value: string \| string[] \| {
1409	value: string;
1410	}[];
1411	}
1412	export interface ProductCollection {
1413	id: string;
1414	object: string;
1415	name: string;
1416	description?: string;
1417	position?: number;
1418	slug: string;
1419	image?: string;
1420	products_count: number;
1421	products?: Product[];
1422	}
1423	export interface GoogleAnalyticsItem {
1424	item_id: string;
1425	item_name: string;
1426	item_variant?: string;
1427	item_category?: string;
1428	item_category2?: string;
1429	item_category3?: string;
1430	item_category4?: string;
1431	item_category5?: string;
1432	price: number;
1433	quantity: number;
1434	coupon?: string;
1435	currency: string;
1436	discount?: number;
1437	}
1438	export interface ProductState {
1439	formId: number;
1440	mode: 'live' \| 'test';
1441	product: Product;
1442	prices: Price[];
1443	variants: Variant[];
1444	variant_options: VariantOption[];
1445	quantity: number;
1446	selectedPrice: Price;
1447	total: number;
1448	range_display_amount: string;
1449	busy: boolean;
1450	disabled: boolean;
1451	checkoutUrl: string;
1452	adHocAmount: number;
1453	dialog: string;
1454	line_item: LineItemData;
1455	error: string;
1456	selectedVariant?: Variant;
1457	variantValues: {
1458	option_1?: string;
1459	option_2?: string;
1460	option_3?: string;
1461	};
1462	isProductPage?: boolean;
1463	note?: string;
1464	bundleComponentVariants?: Record<string, string>;
1465	}
1466	export interface FeaturedProductMediaAttributes {
1467	alt: string;
1468	url: string;
1469	title: string;
1470	}
1471	export interface PaymentInfoAddedParams {
1472	checkout_id: string;
1473	processor_type: 'paypal' \| 'stripe' \| 'mollie' \| 'paystack';
1474	currency: string;
1475	total_amount: number;
1476	line_items?: lineItems;
1477	payment_method: {
1478	billing_details: {
1479	name: string;
1480	email: string;
1481	};
1482	};
1483	}
1484	export interface CheckoutInitiatedParams {
1485	transaction_id: string;
1486	value: number;
1487	currency: string;
1488	coupon?: string;
1489	tax?: number;
1490	items: Array<{
1491	item_name: string;
1492	discount: number;
1493	price: number;
1494	quantity: number;
1495	}>;
1496	}
1497	export interface ProductsSearchedParams {
1498	searchString: string;
1499	searchCollections?: string[];
1500	searchResultCount: number;
1501	searchResultIds: string[];
1502	}
1503	export interface ProductsViewedParams {
1504	products: Product[];
1505	pageTitle: string;
1506	collectionId?: string;
1507	}
1508	export type NoticeType = 'default' \| 'info' \| 'success' \| 'warning' \| 'error';
1509	interface AdditionalError {
1510	code: string;
1511	message: string;
1512	data: {
1513	attribute: string;
1514	type: string;
1515	options: {
1516	if: string[];
1517	value: string;
1518	};
1519	};
1520	}
1521	export interface ScNoticeStore {
1522	type: NoticeType \| 'default';
1523	code: string;
1524	message: string;
1525	data?: {
1526	status: number;
1527	type: string;
1528	http_status: string;
1529	};
1530	additional_errors?: AdditionalError[] \| null;
1531	dismissible?: boolean;
1532	}
1533	export interface CustomStripeElementChangeEvent extends StripeElementChangeEvent {
1534	value?: {
1535	type: string;
1536	};
1537	}
1538	export interface CountryLocaleFieldValue {
1539	name: string;
1540	priority?: number;
1541	label: string;
1542	}
1543	export interface CountryLocaleField {
1544	[key: string]: {
1545	name: CountryLocaleFieldValue;
1546	address_1: CountryLocaleFieldValue;
1547	address_2: CountryLocaleFieldValue;
1548	city: CountryLocaleFieldValue;
1549	state: CountryLocaleFieldValue;
1550	postcode: CountryLocaleFieldValue;
1551	};
1552	}
1553	export {};
1554