@aifeatures/backend 0.11.0 → 0.13.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/index.cjs +5 -5
- package/dist/index.d.cts +1797 -673
- package/dist/index.d.ts +1797 -673
- package/dist/index.js +5 -5
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -1079,6 +1079,23 @@ type Order = {
|
|
|
1079
1079
|
status: "pending" | "paid" | "failed" | "expired" | "refunded" | "partially_refunded" | "disputed" | "voided";
|
|
1080
1080
|
stripe_checkout_session_id: string | null;
|
|
1081
1081
|
stripe_payment_intent_id: string | null;
|
|
1082
|
+
amount_subtotal: number | null;
|
|
1083
|
+
discount_total: number;
|
|
1084
|
+
exclusive_tax_total: number | null;
|
|
1085
|
+
subscription_history_only: boolean;
|
|
1086
|
+
/**
|
|
1087
|
+
* Cash collected after account credit; null for historical orders without a cash snapshot.
|
|
1088
|
+
*/
|
|
1089
|
+
amount_paid: number | null;
|
|
1090
|
+
/**
|
|
1091
|
+
* Account credit applied to the total; separate from promotion discounts.
|
|
1092
|
+
*/
|
|
1093
|
+
credit_applied: number | null;
|
|
1094
|
+
application_fee_original: number | null;
|
|
1095
|
+
application_fee_returned: number | null;
|
|
1096
|
+
application_fee_retained: number | null;
|
|
1097
|
+
application_fee_currency: string | null;
|
|
1098
|
+
application_fee_state: "pending" | "complete" | "manual_attention" | null;
|
|
1082
1099
|
/**
|
|
1083
1100
|
* GOODS ONLY, in minor units — the sum of the line values, with postage EXCLUDED (the platform fee base is pinned to this figure). What the buyer's card was actually charged is amount_total + (shipping_total ?? 0); reconcile against a Stripe payout with that sum, never with this field alone. base_amount_total mirrors this one, so it is goods-only too.
|
|
1084
1101
|
*/
|
|
@@ -1329,6 +1346,12 @@ type SettledTotals = {
|
|
|
1329
1346
|
* GROSS platform fees (refunds return application fees too; nothing is netted). Sums only orders charged in the settlement currency — a localized order's platform fee has no known settlement-side value.
|
|
1330
1347
|
*/
|
|
1331
1348
|
application_fees: number;
|
|
1349
|
+
application_fees_returned: number | null;
|
|
1350
|
+
application_fees_retained: number | null;
|
|
1351
|
+
/**
|
|
1352
|
+
* False when fee observations are missing, pending repair, or cannot be expressed in the reported settlement currency. Independent of settlement completeness.
|
|
1353
|
+
*/
|
|
1354
|
+
application_fees_complete: boolean;
|
|
1332
1355
|
currency: string;
|
|
1333
1356
|
complete: boolean;
|
|
1334
1357
|
};
|
|
@@ -1456,7 +1479,15 @@ type SalesSummary = {
|
|
|
1456
1479
|
aov: number;
|
|
1457
1480
|
application_fees_gross: number;
|
|
1458
1481
|
/**
|
|
1459
|
-
*
|
|
1482
|
+
* Observed fee returns, or null when legacy returns are unknown or reconciliation is incomplete.
|
|
1483
|
+
*/
|
|
1484
|
+
application_fees_returned: number | null;
|
|
1485
|
+
/**
|
|
1486
|
+
* Observed fees still retained, or null when legacy returns are unknown or reconciliation is incomplete.
|
|
1487
|
+
*/
|
|
1488
|
+
application_fees_retained: number | null;
|
|
1489
|
+
/**
|
|
1490
|
+
* False when any in-range order lacks an actual fee snapshot, has pending fee repair, or has a mismatched fee currency. Legacy return history may remain unknown even when gross fees are complete.
|
|
1460
1491
|
*/
|
|
1461
1492
|
application_fees_complete: boolean;
|
|
1462
1493
|
}>;
|
|
@@ -1713,6 +1744,85 @@ type AnalyticsChannels = {
|
|
|
1713
1744
|
} | {
|
|
1714
1745
|
status: "unreachable";
|
|
1715
1746
|
};
|
|
1747
|
+
type AnalyticsGoal = {
|
|
1748
|
+
/**
|
|
1749
|
+
* null for a built-in goal, which is not a row and cannot be renamed or deleted
|
|
1750
|
+
*/
|
|
1751
|
+
id: string | null;
|
|
1752
|
+
kind: "pageview" | "scroll" | "event";
|
|
1753
|
+
display_name: string;
|
|
1754
|
+
path_pattern: string | null;
|
|
1755
|
+
scroll_threshold: number | null;
|
|
1756
|
+
event_name: string | null;
|
|
1757
|
+
builtin: boolean;
|
|
1758
|
+
};
|
|
1759
|
+
type AnalyticsGoalList = {
|
|
1760
|
+
goals: Array<AnalyticsGoal>;
|
|
1761
|
+
/**
|
|
1762
|
+
* Maximum goals this site may define
|
|
1763
|
+
*/
|
|
1764
|
+
limit: number;
|
|
1765
|
+
/**
|
|
1766
|
+
* How many of the limit are used
|
|
1767
|
+
*/
|
|
1768
|
+
defined: number;
|
|
1769
|
+
};
|
|
1770
|
+
type AnalyticsGoalInput = {
|
|
1771
|
+
kind: "pageview" | "scroll" | "event";
|
|
1772
|
+
display_name: string;
|
|
1773
|
+
path_pattern?: string | null;
|
|
1774
|
+
scroll_threshold?: number | null;
|
|
1775
|
+
event_name?: string | null;
|
|
1776
|
+
};
|
|
1777
|
+
type AnalyticsFunnel = {
|
|
1778
|
+
id: string;
|
|
1779
|
+
display_name: string;
|
|
1780
|
+
/**
|
|
1781
|
+
* How many steps the funnel was DEFINED with. Normally equal to the length of `steps`; larger when a goal a step referenced has been deleted, which cascades the step away.
|
|
1782
|
+
*/
|
|
1783
|
+
declared_steps: number;
|
|
1784
|
+
/**
|
|
1785
|
+
* True when a step is missing because its goal was deleted. The funnel CANNOT be reported in that state, and `steps` then has a gap in its positions rather than being dense — an editor must not save it back as-is, or it would save a shorter path the merchant never defined.
|
|
1786
|
+
*/
|
|
1787
|
+
broken: boolean;
|
|
1788
|
+
/**
|
|
1789
|
+
* The first declared position with no surviving step, or null when nothing is missing.
|
|
1790
|
+
*/
|
|
1791
|
+
missing_step: number | null;
|
|
1792
|
+
steps: Array<{
|
|
1793
|
+
/**
|
|
1794
|
+
* 1-based, and dense UNLESS `broken` is true — a cascaded deletion leaves a gap, and the surviving positions are reported as they are rather than renumbered, so the gap is visible.
|
|
1795
|
+
*/
|
|
1796
|
+
position: number;
|
|
1797
|
+
goal_id: string | null;
|
|
1798
|
+
builtin_goal: string | null;
|
|
1799
|
+
/**
|
|
1800
|
+
* The step's goal as a display name, resolved server-side so a client never has to join goals itself.
|
|
1801
|
+
*/
|
|
1802
|
+
goal: string;
|
|
1803
|
+
}>;
|
|
1804
|
+
};
|
|
1805
|
+
type AnalyticsFunnelStepInput = {
|
|
1806
|
+
/**
|
|
1807
|
+
* A goal of this site, by id. Exactly one of goal_id and builtin_goal must be set — they are different kinds of reference: a stored goal's id survives a rename, a built-in goal has no row to point at.
|
|
1808
|
+
*/
|
|
1809
|
+
goal_id?: string | null;
|
|
1810
|
+
/**
|
|
1811
|
+
* A built-in goal, by name: one of Form: Submission, Outbound Link: Click, File Download, Contact, Purchase, Form: Received. Safe to reference by name because built-ins cannot be renamed.
|
|
1812
|
+
*/
|
|
1813
|
+
builtin_goal?: string | null;
|
|
1814
|
+
};
|
|
1815
|
+
type AnalyticsFunnelInput = {
|
|
1816
|
+
display_name: string;
|
|
1817
|
+
/**
|
|
1818
|
+
* Ordered, 2 to 8 steps. Array order IS the step order; positions are assigned from it and stay dense.
|
|
1819
|
+
*/
|
|
1820
|
+
steps: Array<AnalyticsFunnelStepInput>;
|
|
1821
|
+
};
|
|
1822
|
+
type AnalyticsFunnelPatch = {
|
|
1823
|
+
display_name?: string;
|
|
1824
|
+
steps?: Array<AnalyticsFunnelStepInput>;
|
|
1825
|
+
};
|
|
1716
1826
|
type SubscriptionSummary = {
|
|
1717
1827
|
/**
|
|
1718
1828
|
* Latest email delivery observation per kind. Independent of payment and send-retry status; absent for older deployments.
|
|
@@ -2378,6 +2488,54 @@ type OwnProductReview = ProductReview & {
|
|
|
2378
2488
|
product_name: string | null;
|
|
2379
2489
|
product_available: boolean;
|
|
2380
2490
|
};
|
|
2491
|
+
type Promo = {
|
|
2492
|
+
id: string;
|
|
2493
|
+
site_id: string;
|
|
2494
|
+
stripe_account_id: string;
|
|
2495
|
+
code: string;
|
|
2496
|
+
name: string;
|
|
2497
|
+
percent_off: number | null;
|
|
2498
|
+
amount_off: number | null;
|
|
2499
|
+
currency: string | null;
|
|
2500
|
+
minimum_amount: number | null;
|
|
2501
|
+
expires_at: string | null;
|
|
2502
|
+
max_redemptions: number | null;
|
|
2503
|
+
duration: "once" | "forever" | "repeating";
|
|
2504
|
+
duration_in_months: number | null;
|
|
2505
|
+
status: "active" | "inactive" | "expired" | "exhausted" | "pending" | "unavailable";
|
|
2506
|
+
times_redeemed: number | null;
|
|
2507
|
+
eligibility_scope: "connected_account";
|
|
2508
|
+
checkout_enabled: boolean;
|
|
2509
|
+
replaces_id: string | null;
|
|
2510
|
+
created_at: string;
|
|
2511
|
+
};
|
|
2512
|
+
type PromosList = {
|
|
2513
|
+
promos: Array<Promo>;
|
|
2514
|
+
next_cursor: string | null;
|
|
2515
|
+
checkout_enabled: boolean;
|
|
2516
|
+
};
|
|
2517
|
+
type PromoError = {
|
|
2518
|
+
error: string;
|
|
2519
|
+
code: string;
|
|
2520
|
+
promo_id?: string;
|
|
2521
|
+
retryable: boolean;
|
|
2522
|
+
};
|
|
2523
|
+
type CreatePromo = {
|
|
2524
|
+
/**
|
|
2525
|
+
* Stable client-generated request ID. Retry unchanged after an unknown result.
|
|
2526
|
+
*/
|
|
2527
|
+
request_id: string;
|
|
2528
|
+
code: string;
|
|
2529
|
+
name: string;
|
|
2530
|
+
percent_off?: number;
|
|
2531
|
+
amount_off?: number;
|
|
2532
|
+
currency?: string;
|
|
2533
|
+
minimum_amount?: number;
|
|
2534
|
+
expires_at?: string;
|
|
2535
|
+
max_redemptions?: number;
|
|
2536
|
+
duration?: "once" | "forever" | "repeating";
|
|
2537
|
+
duration_in_months?: number;
|
|
2538
|
+
};
|
|
2381
2539
|
type ConsentConfig = {
|
|
2382
2540
|
mode: "adaptive" | "adaptive-with-notice" | "strict-everywhere" | "off";
|
|
2383
2541
|
policy_path: string | null;
|
|
@@ -3223,6 +3381,9 @@ type OrderSessionStatus = {
|
|
|
3223
3381
|
* True for a simulated owner-initiated test purchase (no money moved).
|
|
3224
3382
|
*/
|
|
3225
3383
|
is_test: boolean;
|
|
3384
|
+
amount_subtotal: number | null;
|
|
3385
|
+
discount_total: number;
|
|
3386
|
+
exclusive_tax_total: number | null;
|
|
3226
3387
|
/**
|
|
3227
3388
|
* What the buyer was CHARGED, in minor units of `currency` — goods plus postage (`shipping_total`) plus exclusive automatic tax (`tax_total` when Stripe Tax priced it on top; Unit T2), the number on their card statement. Deliberately NOT the same decomposition as the management API's Order.amount_total, which is line values only because the platform fee is pinned to it: this is the buyer's receipt surface, and a confirmation page that showed line values alone would disagree with the statement on every shipped order. Do NOT add shipping_total or tax_total to this — they are already inside.
|
|
3228
3389
|
*/
|
|
@@ -3249,8 +3410,15 @@ type OrderSessionStatus = {
|
|
|
3249
3410
|
*/
|
|
3250
3411
|
name: string;
|
|
3251
3412
|
quantity: number;
|
|
3413
|
+
amount_subtotal?: number;
|
|
3414
|
+
amount_discount?: number;
|
|
3415
|
+
amount_net?: number;
|
|
3416
|
+
amount_tax?: number;
|
|
3417
|
+
amount_total?: number;
|
|
3418
|
+
exclusive_tax?: number;
|
|
3419
|
+
unavailable_reason?: "oversold";
|
|
3252
3420
|
/**
|
|
3253
|
-
*
|
|
3421
|
+
* Original price of ONE unit in minor units of `currency`, before discounts. Use finalized `amount_net` for the discounted line value, including when it is zero; use `unit_amount * quantity` only as a legacy fallback when `amount_net` is absent. Absent on rows written before the field existed. It is a LINE figure: the per-line values need not sum to `amount_total`, which also carries postage, exclusive tax, and any promotion-code discount — render `amount_total` as the total paid rather than adding lines up.
|
|
3254
3422
|
*/
|
|
3255
3423
|
unit_amount?: number;
|
|
3256
3424
|
/**
|
|
@@ -5679,29 +5847,32 @@ type GetAnalyticsChannelsResponses = {
|
|
|
5679
5847
|
200: AnalyticsChannels;
|
|
5680
5848
|
};
|
|
5681
5849
|
type GetAnalyticsChannelsResponse = GetAnalyticsChannelsResponses[keyof GetAnalyticsChannelsResponses];
|
|
5682
|
-
type
|
|
5850
|
+
type GetAnalyticsConversionsData = {
|
|
5683
5851
|
body?: never;
|
|
5684
5852
|
path?: never;
|
|
5685
5853
|
query?: {
|
|
5686
5854
|
/**
|
|
5687
|
-
* Required with an
|
|
5855
|
+
* Required when authenticating with an organization API key — scopes the call to one site in your org. Optional with a site token, and must match that token's site.
|
|
5688
5856
|
*/
|
|
5689
5857
|
site_id?: string;
|
|
5690
5858
|
/**
|
|
5691
|
-
*
|
|
5859
|
+
* Days covered, ending at the most recent midnight in the site's reporting timezone. Today's partial day is EXCLUDED - including it would compare a complete period against a few hours and read as a traffic collapse every morning. Defaults to 30.
|
|
5692
5860
|
*/
|
|
5693
|
-
|
|
5861
|
+
period?: "7" | "30" | "90";
|
|
5694
5862
|
/**
|
|
5695
|
-
*
|
|
5863
|
+
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5696
5864
|
*/
|
|
5697
|
-
|
|
5698
|
-
|
|
5865
|
+
from?: string;
|
|
5866
|
+
/**
|
|
5867
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5868
|
+
*/
|
|
5869
|
+
to?: string;
|
|
5699
5870
|
};
|
|
5700
|
-
url: "/api/v1/
|
|
5871
|
+
url: "/api/v1/analytics/conversions";
|
|
5701
5872
|
};
|
|
5702
|
-
type
|
|
5873
|
+
type GetAnalyticsConversionsErrors = {
|
|
5703
5874
|
/**
|
|
5704
|
-
* site_id mismatch /
|
|
5875
|
+
* site_id mismatch / unsupported period
|
|
5705
5876
|
*/
|
|
5706
5877
|
400: unknown;
|
|
5707
5878
|
/**
|
|
@@ -5709,467 +5880,645 @@ type ListSubscriptionsErrors = {
|
|
|
5709
5880
|
*/
|
|
5710
5881
|
401: unknown;
|
|
5711
5882
|
};
|
|
5712
|
-
type
|
|
5883
|
+
type GetAnalyticsConversionsResponses = {
|
|
5713
5884
|
/**
|
|
5714
|
-
*
|
|
5885
|
+
* Conversions per goal, or an unreachable source
|
|
5715
5886
|
*/
|
|
5716
|
-
200:
|
|
5887
|
+
200: {
|
|
5888
|
+
status: "ok";
|
|
5889
|
+
/**
|
|
5890
|
+
* One row per goal, INCLUDING goals that matched nothing, which read zero rather than being omitted. A goal absent from this list does not exist; a goal with zeros exists and had no conversions.
|
|
5891
|
+
*/
|
|
5892
|
+
data: Array<{
|
|
5893
|
+
/**
|
|
5894
|
+
* The goal's display name. Names are resolved server-side: the query itself works on positions, so a name containing a comma cannot be split in transit.
|
|
5895
|
+
*/
|
|
5896
|
+
goal: string;
|
|
5897
|
+
/**
|
|
5898
|
+
* What the goal matches. `pageview` matches a path pattern against pageviews only, `scroll` matches an engagement beacon past a depth threshold, `event` matches an event name exactly. Each kind is scoped to the rows it can legitimately match, so a path-based goal cannot absorb another goal's conversions.
|
|
5899
|
+
*/
|
|
5900
|
+
kind: "pageview" | "scroll" | "event";
|
|
5901
|
+
/**
|
|
5902
|
+
* True for every goal a site has without defining anything, which is now two families and they differ in one important way. The COLLECTED ones — form submissions, outbound clicks, downloads, and Contact (phone and email taps together) — are matched at query time over events the collector has always accepted, so they cover the site's ENTIRE history. The SERVER-WRITTEN ones — `Purchase` and `Form: Received` — are events we write rather than collect, so they exist only from the deploy that started writing them. Do not read `implicit` as meaning historically complete: read `counts_from`, which is null for the first family and a date for the second.
|
|
5903
|
+
*/
|
|
5904
|
+
implicit: boolean;
|
|
5905
|
+
/**
|
|
5906
|
+
* Unique visitors who converted. Plausible calls this a unique conversion.
|
|
5907
|
+
*/
|
|
5908
|
+
visitors: number;
|
|
5909
|
+
/**
|
|
5910
|
+
* Total conversion events. Scroll goals are deduplicated to one per (visitor, path) for the window, because the engagement beacon refires on visibility changes and on every depth increase — raw, a scroll goal read 1.50x its honest value beside a form submission counted once.
|
|
5911
|
+
*/
|
|
5912
|
+
events: number;
|
|
5913
|
+
/**
|
|
5914
|
+
* visitors divided by SITE-WIDE unique visitors for the window — see `denominator`. NOT a share of anything: rows do not sum to 1, and two goals can each be converted by most of the site's visitors. Null, never 0, when the window had no visitors at all, because a rate of zero asserts that visitors came and did not convert.
|
|
5915
|
+
*/
|
|
5916
|
+
conversion_rate: number | null;
|
|
5917
|
+
/**
|
|
5918
|
+
* The whole date (YYYY-MM-DD) this goal's events begin, or null when it covers the site's ENTIRE history. Goals are matched at read time, so a goal reports across everything already recorded — but `Purchase` and `Form: Received` are events we WRITE rather than collect, and they exist only from the deploy that started writing them. Say so wherever a merchant could otherwise read a truthful zero for an earlier period as a broken feature. A DATE rather than a flag, because "counted from 30 September" is something a merchant can act on and "not retroactive" is not.
|
|
5919
|
+
*/
|
|
5920
|
+
counts_from: string | null;
|
|
5921
|
+
}>;
|
|
5922
|
+
/**
|
|
5923
|
+
* The half-open UTC window the values were measured over: from inclusive, to exclusive. Resolved from the site's reporting timezone.
|
|
5924
|
+
*/
|
|
5925
|
+
window: {
|
|
5926
|
+
from: string;
|
|
5927
|
+
to: string;
|
|
5928
|
+
};
|
|
5929
|
+
/**
|
|
5930
|
+
* Site-wide unique visitors for the window, with no goal filtering — the denominator every `conversion_rate` above divides by. Say what the rate is a ratio of wherever you show one: this is Plausible's definition and it surprises people, because the rates do not sum to 100%.
|
|
5931
|
+
*/
|
|
5932
|
+
denominator: number;
|
|
5933
|
+
/**
|
|
5934
|
+
* The site's earliest recorded event, or null if it has never recorded one. Present so a zero can be told apart from a window that predates collection — see `window_precedes_collection`.
|
|
5935
|
+
*/
|
|
5936
|
+
first_seen: string | null;
|
|
5937
|
+
/**
|
|
5938
|
+
* True when the earliest-event lookup could not be made. Distinguishes 'we could not ask' from 'nothing was ever collected', which are opposite claims.
|
|
5939
|
+
*/
|
|
5940
|
+
first_seen_unavailable: boolean;
|
|
5941
|
+
/**
|
|
5942
|
+
* True when the window starts before this site's first recorded event, so low or zero conversions are partly an artifact of the range rather than a fact about the site. False when collection covers the whole window, and false when `first_seen_unavailable` — never guess coverage from a failed lookup.
|
|
5943
|
+
*/
|
|
5944
|
+
window_precedes_collection: boolean;
|
|
5945
|
+
} | {
|
|
5946
|
+
status: "unreachable";
|
|
5947
|
+
};
|
|
5717
5948
|
};
|
|
5718
|
-
type
|
|
5719
|
-
type
|
|
5949
|
+
type GetAnalyticsConversionsResponse = GetAnalyticsConversionsResponses[keyof GetAnalyticsConversionsResponses];
|
|
5950
|
+
type GetAnalyticsFunnelReportData = {
|
|
5720
5951
|
body?: never;
|
|
5721
5952
|
path: {
|
|
5722
|
-
|
|
5953
|
+
id: string;
|
|
5723
5954
|
};
|
|
5724
|
-
query?:
|
|
5725
|
-
|
|
5955
|
+
query?: {
|
|
5956
|
+
site_id?: string;
|
|
5957
|
+
period?: "7" | "30" | "90";
|
|
5958
|
+
/**
|
|
5959
|
+
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5960
|
+
*/
|
|
5961
|
+
from?: string;
|
|
5962
|
+
/**
|
|
5963
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5964
|
+
*/
|
|
5965
|
+
to?: string;
|
|
5966
|
+
};
|
|
5967
|
+
url: "/api/v1/analytics/funnels/{id}/report";
|
|
5726
5968
|
};
|
|
5727
|
-
type
|
|
5728
|
-
/**
|
|
5729
|
-
* Site tokens are not permitted
|
|
5730
|
-
*/
|
|
5731
|
-
403: unknown;
|
|
5969
|
+
type GetAnalyticsFunnelReportErrors = {
|
|
5732
5970
|
/**
|
|
5733
|
-
*
|
|
5971
|
+
* site_id mismatch / unsupported period / a step's goal is gone / the range ends before the funnel's steps existed
|
|
5734
5972
|
*/
|
|
5735
|
-
|
|
5973
|
+
400: unknown;
|
|
5736
5974
|
/**
|
|
5737
|
-
*
|
|
5975
|
+
* Missing or invalid token
|
|
5738
5976
|
*/
|
|
5739
|
-
|
|
5977
|
+
401: unknown;
|
|
5740
5978
|
/**
|
|
5741
|
-
*
|
|
5979
|
+
* No such funnel on this site
|
|
5742
5980
|
*/
|
|
5743
|
-
|
|
5981
|
+
404: unknown;
|
|
5744
5982
|
};
|
|
5745
|
-
type
|
|
5983
|
+
type GetAnalyticsFunnelReportResponses = {
|
|
5746
5984
|
/**
|
|
5747
|
-
*
|
|
5985
|
+
* Funnel steps, or an unreachable source
|
|
5748
5986
|
*/
|
|
5749
|
-
200:
|
|
5987
|
+
200: {
|
|
5988
|
+
status: "ok";
|
|
5989
|
+
/**
|
|
5990
|
+
* One row per declared step, in order.
|
|
5991
|
+
*/
|
|
5992
|
+
data: Array<{
|
|
5993
|
+
/**
|
|
5994
|
+
* 1-based and always dense.
|
|
5995
|
+
*/
|
|
5996
|
+
position: number;
|
|
5997
|
+
/**
|
|
5998
|
+
* The step's goal, by display name.
|
|
5999
|
+
*/
|
|
6000
|
+
goal: string;
|
|
6001
|
+
/**
|
|
6002
|
+
* Visitors who reached AT LEAST this step, in order. Cumulative, because that is what a drop-off is measured from.
|
|
6003
|
+
*/
|
|
6004
|
+
visitors: number;
|
|
6005
|
+
/**
|
|
6006
|
+
* Visitors who reached the previous step and not this one. Zero at step one, which has no previous step.
|
|
6007
|
+
*/
|
|
6008
|
+
dropoff: number;
|
|
6009
|
+
/**
|
|
6010
|
+
* dropoff as a fraction of the PREVIOUS step's visitors. Null at step one, and null when the previous step had no visitors — a drop-off out of zero is undefined, not 100%.
|
|
6011
|
+
*/
|
|
6012
|
+
dropoff_rate: number | null;
|
|
6013
|
+
/**
|
|
6014
|
+
* visitors as a fraction of STEP ONE's visitors — not of site-wide visitors. A funnel's rate is about the path; the conversions report is the one that divides by site-wide uniques. Null when nobody entered.
|
|
6015
|
+
*/
|
|
6016
|
+
conversion_rate: number | null;
|
|
6017
|
+
}>;
|
|
6018
|
+
/**
|
|
6019
|
+
* The half-open UTC window the values were measured over: from inclusive, to exclusive. Resolved from the site's reporting timezone.
|
|
6020
|
+
*/
|
|
6021
|
+
window: {
|
|
6022
|
+
from: string;
|
|
6023
|
+
to: string;
|
|
6024
|
+
};
|
|
6025
|
+
funnel: {
|
|
6026
|
+
id: string;
|
|
6027
|
+
display_name: string;
|
|
6028
|
+
};
|
|
6029
|
+
/**
|
|
6030
|
+
* Visitors in the window who matched NO step. Not a step and not cumulative: it is what makes step one's rate honest, since step one alone cannot tell a funnel nobody entered from one everybody completed.
|
|
6031
|
+
*/
|
|
6032
|
+
never_entered: number;
|
|
6033
|
+
/**
|
|
6034
|
+
* Unique visitors on the site for the window, for context only. Deliberately NOT the denominator of any rate above.
|
|
6035
|
+
*/
|
|
6036
|
+
site_visitors: number;
|
|
6037
|
+
/**
|
|
6038
|
+
* The window you ASKED for, when it differs from the one above, and null when nothing was shortened. A funnel is clamped to the first date EVERY step could have fired, because drop-off is a comparison between steps: a window reaching back before one step's instrumentation counts entrants at step one from days the later step could not fire and reports the difference as people who dropped out. The number is therefore moved rather than annotated — render this whenever it is non-null, because a merchant asking why their 90-day funnel starts in October deserves the answer, and a client comparing two periods must not compare one it asked for against one it did not.
|
|
6039
|
+
*/
|
|
6040
|
+
requested_window: {
|
|
6041
|
+
from: string;
|
|
6042
|
+
to: string;
|
|
6043
|
+
} | null;
|
|
6044
|
+
/**
|
|
6045
|
+
* The step date that set the floor, when the window was clamped. Non-null exactly when `requested_window` is. A funnel ending on `Purchase` or `Form: Received` cannot report on days before those events were being written — see `counts_from` on the conversions report, which is the same fact stated as a caveat where a caveat is enough.
|
|
6046
|
+
*/
|
|
6047
|
+
coverage_from: string | null;
|
|
6048
|
+
/**
|
|
6049
|
+
* The hard limit of what a funnel can observe, in the response rather than only in the docs (R13). It bounds each SEQUENCE, not the report: the report covers the whole window in `window` — which is not always the one you asked for, see `requested_window` — but one visitor's run through the steps must finish within 24 hours AND within one visitor identity, which rotates daily. So a 90-day report counts completions from all 90 days, and a visitor who starts the path before midnight and finishes after it is not one of them. Render this wherever you render the funnel.
|
|
6050
|
+
*/
|
|
6051
|
+
bounded_to: "visitor-day";
|
|
6052
|
+
} | {
|
|
6053
|
+
status: "unreachable";
|
|
6054
|
+
};
|
|
5750
6055
|
};
|
|
5751
|
-
type
|
|
5752
|
-
type
|
|
5753
|
-
body?:
|
|
5754
|
-
path
|
|
5755
|
-
|
|
6056
|
+
type GetAnalyticsFunnelReportResponse = GetAnalyticsFunnelReportResponses[keyof GetAnalyticsFunnelReportResponses];
|
|
6057
|
+
type ListAnalyticsGoalsData = {
|
|
6058
|
+
body?: never;
|
|
6059
|
+
path?: never;
|
|
6060
|
+
query?: {
|
|
6061
|
+
site_id?: string;
|
|
5756
6062
|
};
|
|
5757
|
-
|
|
5758
|
-
url: "/api/v1/sites/{siteId}/subscriptions/teardown";
|
|
6063
|
+
url: "/api/v1/analytics/goals";
|
|
5759
6064
|
};
|
|
5760
|
-
type
|
|
6065
|
+
type ListAnalyticsGoalsErrors = {
|
|
5761
6066
|
/**
|
|
5762
|
-
*
|
|
6067
|
+
* site_id mismatch
|
|
5763
6068
|
*/
|
|
5764
|
-
|
|
6069
|
+
400: unknown;
|
|
5765
6070
|
/**
|
|
5766
|
-
*
|
|
6071
|
+
* Missing or invalid token
|
|
5767
6072
|
*/
|
|
5768
|
-
|
|
6073
|
+
401: unknown;
|
|
5769
6074
|
};
|
|
5770
|
-
type
|
|
5771
|
-
type TeardownSiteSubscriptionsResponses = {
|
|
6075
|
+
type ListAnalyticsGoalsResponses = {
|
|
5772
6076
|
/**
|
|
5773
|
-
*
|
|
6077
|
+
* Goals
|
|
5774
6078
|
*/
|
|
5775
|
-
200:
|
|
6079
|
+
200: AnalyticsGoalList;
|
|
5776
6080
|
};
|
|
5777
|
-
type
|
|
5778
|
-
type
|
|
5779
|
-
body?:
|
|
5780
|
-
path
|
|
5781
|
-
|
|
6081
|
+
type ListAnalyticsGoalsResponse = ListAnalyticsGoalsResponses[keyof ListAnalyticsGoalsResponses];
|
|
6082
|
+
type CreateAnalyticsGoalData = {
|
|
6083
|
+
body?: AnalyticsGoalInput;
|
|
6084
|
+
path?: never;
|
|
6085
|
+
query?: {
|
|
6086
|
+
site_id?: string;
|
|
5782
6087
|
};
|
|
5783
|
-
|
|
5784
|
-
url: "/api/v1/sites/{siteId}/subscriptions/reactivate-teardown";
|
|
6088
|
+
url: "/api/v1/analytics/goals";
|
|
5785
6089
|
};
|
|
5786
|
-
type
|
|
5787
|
-
/**
|
|
5788
|
-
* Unknown key in the body (a misspelled `reason` is refused, never ignored)
|
|
5789
|
-
*/
|
|
5790
|
-
400: Error;
|
|
6090
|
+
type CreateAnalyticsGoalErrors = {
|
|
5791
6091
|
/**
|
|
5792
|
-
*
|
|
6092
|
+
* Invalid goal, or site_id mismatch
|
|
5793
6093
|
*/
|
|
5794
|
-
|
|
6094
|
+
400: unknown;
|
|
5795
6095
|
/**
|
|
5796
|
-
*
|
|
6096
|
+
* Missing or invalid token
|
|
5797
6097
|
*/
|
|
5798
|
-
|
|
6098
|
+
401: unknown;
|
|
5799
6099
|
/**
|
|
5800
|
-
*
|
|
6100
|
+
* Duplicate name, or the per-site goal limit is reached
|
|
5801
6101
|
*/
|
|
5802
|
-
409:
|
|
6102
|
+
409: unknown;
|
|
5803
6103
|
};
|
|
5804
|
-
type
|
|
5805
|
-
type ReactivateSiteSubscriptionsTeardownResponses = {
|
|
6104
|
+
type CreateAnalyticsGoalResponses = {
|
|
5806
6105
|
/**
|
|
5807
|
-
*
|
|
6106
|
+
* Created
|
|
5808
6107
|
*/
|
|
5809
|
-
|
|
6108
|
+
201: AnalyticsGoal;
|
|
5810
6109
|
};
|
|
5811
|
-
type
|
|
5812
|
-
type
|
|
5813
|
-
body
|
|
6110
|
+
type CreateAnalyticsGoalResponse = CreateAnalyticsGoalResponses[keyof CreateAnalyticsGoalResponses];
|
|
6111
|
+
type DeleteAnalyticsGoalData = {
|
|
6112
|
+
body?: never;
|
|
5814
6113
|
path: {
|
|
5815
|
-
|
|
6114
|
+
id: string;
|
|
5816
6115
|
};
|
|
5817
|
-
query?:
|
|
5818
|
-
|
|
6116
|
+
query?: {
|
|
6117
|
+
site_id?: string;
|
|
6118
|
+
};
|
|
6119
|
+
url: "/api/v1/analytics/goals/{id}";
|
|
5819
6120
|
};
|
|
5820
|
-
type
|
|
5821
|
-
/**
|
|
5822
|
-
* Unauthorized
|
|
5823
|
-
*/
|
|
5824
|
-
401: unknown;
|
|
6121
|
+
type DeleteAnalyticsGoalErrors = {
|
|
5825
6122
|
/**
|
|
5826
|
-
*
|
|
6123
|
+
* site_id mismatch
|
|
5827
6124
|
*/
|
|
5828
|
-
|
|
6125
|
+
400: unknown;
|
|
5829
6126
|
/**
|
|
5830
|
-
*
|
|
6127
|
+
* Missing or invalid token
|
|
5831
6128
|
*/
|
|
5832
|
-
|
|
6129
|
+
401: unknown;
|
|
5833
6130
|
/**
|
|
5834
|
-
*
|
|
6131
|
+
* No such goal on this site
|
|
5835
6132
|
*/
|
|
5836
|
-
|
|
6133
|
+
404: unknown;
|
|
5837
6134
|
};
|
|
5838
|
-
type
|
|
5839
|
-
type CreatePreviewSessionResponses = {
|
|
6135
|
+
type DeleteAnalyticsGoalResponses = {
|
|
5840
6136
|
/**
|
|
5841
|
-
*
|
|
6137
|
+
* Deleted
|
|
5842
6138
|
*/
|
|
5843
|
-
|
|
6139
|
+
204: void;
|
|
5844
6140
|
};
|
|
5845
|
-
type
|
|
5846
|
-
type
|
|
5847
|
-
body?:
|
|
5848
|
-
path
|
|
6141
|
+
type DeleteAnalyticsGoalResponse = DeleteAnalyticsGoalResponses[keyof DeleteAnalyticsGoalResponses];
|
|
6142
|
+
type UpdateAnalyticsGoalData = {
|
|
6143
|
+
body?: AnalyticsGoalInput;
|
|
6144
|
+
path: {
|
|
6145
|
+
id: string;
|
|
6146
|
+
};
|
|
5849
6147
|
query?: {
|
|
5850
6148
|
site_id?: string;
|
|
5851
|
-
/**
|
|
5852
|
-
* Comma-separated derived labels to keep (awaiting_payment, overdue, paid, voided, …)
|
|
5853
|
-
*/
|
|
5854
|
-
label?: string;
|
|
5855
|
-
/**
|
|
5856
|
-
* Comma-separated raw statuses
|
|
5857
|
-
*/
|
|
5858
|
-
status?: string;
|
|
5859
|
-
customer_email?: string;
|
|
5860
|
-
customer_id?: string;
|
|
5861
|
-
retainer_id?: string;
|
|
5862
|
-
/**
|
|
5863
|
-
* Case-insensitive substring on the invoice number, the recipient's name or email — "ACME-0007", "bob"
|
|
5864
|
-
*/
|
|
5865
|
-
q?: string;
|
|
5866
|
-
/**
|
|
5867
|
-
* Created on/after (YYYY-MM-DD)
|
|
5868
|
-
*/
|
|
5869
|
-
from?: string;
|
|
5870
|
-
/**
|
|
5871
|
-
* Created on/before (YYYY-MM-DD)
|
|
5872
|
-
*/
|
|
5873
|
-
to?: string;
|
|
5874
|
-
include?: string;
|
|
5875
|
-
limit?: string;
|
|
5876
|
-
offset?: string;
|
|
5877
6149
|
};
|
|
5878
|
-
url: "/api/v1/
|
|
6150
|
+
url: "/api/v1/analytics/goals/{id}";
|
|
5879
6151
|
};
|
|
5880
|
-
type
|
|
6152
|
+
type UpdateAnalyticsGoalErrors = {
|
|
5881
6153
|
/**
|
|
5882
|
-
*
|
|
6154
|
+
* Invalid goal, or site_id mismatch
|
|
5883
6155
|
*/
|
|
5884
|
-
400:
|
|
6156
|
+
400: unknown;
|
|
5885
6157
|
/**
|
|
5886
|
-
*
|
|
6158
|
+
* Missing or invalid token
|
|
5887
6159
|
*/
|
|
5888
|
-
401:
|
|
6160
|
+
401: unknown;
|
|
6161
|
+
/**
|
|
6162
|
+
* No such goal on this site
|
|
6163
|
+
*/
|
|
6164
|
+
404: unknown;
|
|
6165
|
+
/**
|
|
6166
|
+
* Duplicate name
|
|
6167
|
+
*/
|
|
6168
|
+
409: unknown;
|
|
5889
6169
|
};
|
|
5890
|
-
type
|
|
5891
|
-
type ListInvoicesResponses = {
|
|
6170
|
+
type UpdateAnalyticsGoalResponses = {
|
|
5892
6171
|
/**
|
|
5893
|
-
*
|
|
6172
|
+
* Updated
|
|
5894
6173
|
*/
|
|
5895
|
-
200:
|
|
6174
|
+
200: AnalyticsGoal;
|
|
5896
6175
|
};
|
|
5897
|
-
type
|
|
5898
|
-
type
|
|
5899
|
-
body
|
|
6176
|
+
type UpdateAnalyticsGoalResponse = UpdateAnalyticsGoalResponses[keyof UpdateAnalyticsGoalResponses];
|
|
6177
|
+
type ListAnalyticsFunnelsData = {
|
|
6178
|
+
body?: never;
|
|
5900
6179
|
path?: never;
|
|
5901
|
-
query?:
|
|
5902
|
-
|
|
6180
|
+
query?: {
|
|
6181
|
+
site_id?: string;
|
|
6182
|
+
};
|
|
6183
|
+
url: "/api/v1/analytics/funnels";
|
|
5903
6184
|
};
|
|
5904
|
-
type
|
|
5905
|
-
/**
|
|
5906
|
-
* Invalid input, content rule, or billing_address_required
|
|
5907
|
-
*/
|
|
5908
|
-
400: InvoiceError;
|
|
6185
|
+
type ListAnalyticsFunnelsErrors = {
|
|
5909
6186
|
/**
|
|
5910
|
-
*
|
|
6187
|
+
* site_id mismatch
|
|
5911
6188
|
*/
|
|
5912
|
-
|
|
6189
|
+
400: unknown;
|
|
5913
6190
|
/**
|
|
5914
|
-
*
|
|
6191
|
+
* Missing or invalid token
|
|
5915
6192
|
*/
|
|
5916
|
-
|
|
6193
|
+
401: unknown;
|
|
6194
|
+
};
|
|
6195
|
+
type ListAnalyticsFunnelsResponses = {
|
|
5917
6196
|
/**
|
|
5918
|
-
*
|
|
6197
|
+
* Funnels for the site
|
|
5919
6198
|
*/
|
|
5920
|
-
|
|
6199
|
+
200: {
|
|
6200
|
+
funnels: Array<AnalyticsFunnel>;
|
|
6201
|
+
limit: number;
|
|
6202
|
+
defined: number;
|
|
6203
|
+
};
|
|
6204
|
+
};
|
|
6205
|
+
type ListAnalyticsFunnelsResponse = ListAnalyticsFunnelsResponses[keyof ListAnalyticsFunnelsResponses];
|
|
6206
|
+
type CreateAnalyticsFunnelData = {
|
|
6207
|
+
body?: AnalyticsFunnelInput;
|
|
6208
|
+
path?: never;
|
|
6209
|
+
query?: {
|
|
6210
|
+
site_id?: string;
|
|
6211
|
+
};
|
|
6212
|
+
url: "/api/v1/analytics/funnels";
|
|
6213
|
+
};
|
|
6214
|
+
type CreateAnalyticsFunnelErrors = {
|
|
5921
6215
|
/**
|
|
5922
|
-
*
|
|
6216
|
+
* Invalid definition
|
|
5923
6217
|
*/
|
|
5924
|
-
|
|
6218
|
+
400: unknown;
|
|
5925
6219
|
/**
|
|
5926
|
-
*
|
|
6220
|
+
* Missing or invalid token
|
|
5927
6221
|
*/
|
|
5928
|
-
|
|
6222
|
+
401: unknown;
|
|
5929
6223
|
/**
|
|
5930
|
-
*
|
|
6224
|
+
* Duplicate name, or the per-site limit is reached
|
|
5931
6225
|
*/
|
|
5932
|
-
|
|
6226
|
+
409: unknown;
|
|
5933
6227
|
};
|
|
5934
|
-
type
|
|
5935
|
-
type CreateInvoiceResponses = {
|
|
6228
|
+
type CreateAnalyticsFunnelResponses = {
|
|
5936
6229
|
/**
|
|
5937
|
-
* Created
|
|
5938
|
-
*/
|
|
5939
|
-
201: CreateInvoiceResult;
|
|
5940
|
-
/**
|
|
5941
|
-
* Creation continues in the background
|
|
6230
|
+
* Created
|
|
5942
6231
|
*/
|
|
5943
|
-
|
|
6232
|
+
201: AnalyticsFunnel;
|
|
5944
6233
|
};
|
|
5945
|
-
type
|
|
5946
|
-
type
|
|
6234
|
+
type CreateAnalyticsFunnelResponse = CreateAnalyticsFunnelResponses[keyof CreateAnalyticsFunnelResponses];
|
|
6235
|
+
type DeleteAnalyticsFunnelData = {
|
|
5947
6236
|
body?: never;
|
|
5948
6237
|
path: {
|
|
5949
|
-
|
|
6238
|
+
id: string;
|
|
5950
6239
|
};
|
|
5951
|
-
query?:
|
|
5952
|
-
|
|
6240
|
+
query?: {
|
|
6241
|
+
site_id?: string;
|
|
6242
|
+
};
|
|
6243
|
+
url: "/api/v1/analytics/funnels/{id}";
|
|
5953
6244
|
};
|
|
5954
|
-
type
|
|
6245
|
+
type DeleteAnalyticsFunnelErrors = {
|
|
5955
6246
|
/**
|
|
5956
|
-
*
|
|
6247
|
+
* Missing or invalid token
|
|
5957
6248
|
*/
|
|
5958
|
-
401:
|
|
6249
|
+
401: unknown;
|
|
5959
6250
|
/**
|
|
5960
|
-
*
|
|
6251
|
+
* No such funnel on this site
|
|
5961
6252
|
*/
|
|
5962
|
-
404:
|
|
6253
|
+
404: unknown;
|
|
5963
6254
|
};
|
|
5964
|
-
type
|
|
5965
|
-
type GetInvoiceResponses = {
|
|
6255
|
+
type DeleteAnalyticsFunnelResponses = {
|
|
5966
6256
|
/**
|
|
5967
|
-
*
|
|
6257
|
+
* Deleted
|
|
5968
6258
|
*/
|
|
5969
|
-
|
|
6259
|
+
204: void;
|
|
5970
6260
|
};
|
|
5971
|
-
type
|
|
5972
|
-
type
|
|
5973
|
-
body
|
|
6261
|
+
type DeleteAnalyticsFunnelResponse = DeleteAnalyticsFunnelResponses[keyof DeleteAnalyticsFunnelResponses];
|
|
6262
|
+
type UpdateAnalyticsFunnelData = {
|
|
6263
|
+
body?: AnalyticsFunnelPatch;
|
|
6264
|
+
path: {
|
|
6265
|
+
id: string;
|
|
6266
|
+
};
|
|
6267
|
+
query?: {
|
|
5974
6268
|
site_id?: string;
|
|
5975
6269
|
};
|
|
5976
|
-
|
|
5977
|
-
query?: never;
|
|
5978
|
-
url: "/api/v1/invoices/preview";
|
|
6270
|
+
url: "/api/v1/analytics/funnels/{id}";
|
|
5979
6271
|
};
|
|
5980
|
-
type
|
|
6272
|
+
type UpdateAnalyticsFunnelErrors = {
|
|
5981
6273
|
/**
|
|
5982
|
-
* Invalid
|
|
6274
|
+
* Invalid definition, or a patch with neither field
|
|
5983
6275
|
*/
|
|
5984
|
-
400:
|
|
6276
|
+
400: unknown;
|
|
5985
6277
|
/**
|
|
5986
|
-
*
|
|
6278
|
+
* Missing or invalid token
|
|
5987
6279
|
*/
|
|
5988
|
-
401:
|
|
6280
|
+
401: unknown;
|
|
6281
|
+
/**
|
|
6282
|
+
* No such funnel on this site
|
|
6283
|
+
*/
|
|
6284
|
+
404: unknown;
|
|
6285
|
+
/**
|
|
6286
|
+
* Duplicate name
|
|
6287
|
+
*/
|
|
6288
|
+
409: unknown;
|
|
5989
6289
|
};
|
|
5990
|
-
type
|
|
5991
|
-
type PreviewInvoiceResponses = {
|
|
6290
|
+
type UpdateAnalyticsFunnelResponses = {
|
|
5992
6291
|
/**
|
|
5993
|
-
*
|
|
6292
|
+
* Updated
|
|
5994
6293
|
*/
|
|
5995
|
-
200:
|
|
6294
|
+
200: AnalyticsFunnel;
|
|
5996
6295
|
};
|
|
5997
|
-
type
|
|
5998
|
-
type
|
|
6296
|
+
type UpdateAnalyticsFunnelResponse = UpdateAnalyticsFunnelResponses[keyof UpdateAnalyticsFunnelResponses];
|
|
6297
|
+
type ListSubscriptionsData = {
|
|
5999
6298
|
body?: never;
|
|
6000
|
-
path
|
|
6001
|
-
|
|
6299
|
+
path?: never;
|
|
6300
|
+
query?: {
|
|
6301
|
+
/**
|
|
6302
|
+
* Required with an org key (sk_xxx); must match the token's site when using a site token.
|
|
6303
|
+
*/
|
|
6304
|
+
site_id?: string;
|
|
6305
|
+
/**
|
|
6306
|
+
* Exact status filter (verbatim Stripe values).
|
|
6307
|
+
*/
|
|
6308
|
+
status?: string;
|
|
6309
|
+
/**
|
|
6310
|
+
* Max rows (default 50, max 100).
|
|
6311
|
+
*/
|
|
6312
|
+
limit?: string;
|
|
6313
|
+
offset?: string;
|
|
6002
6314
|
};
|
|
6003
|
-
|
|
6004
|
-
url: "/api/v1/invoices/{invoiceId}/preview";
|
|
6315
|
+
url: "/api/v1/subscriptions";
|
|
6005
6316
|
};
|
|
6006
|
-
type
|
|
6317
|
+
type ListSubscriptionsErrors = {
|
|
6007
6318
|
/**
|
|
6008
|
-
*
|
|
6319
|
+
* site_id mismatch / does not belong to this organization
|
|
6009
6320
|
*/
|
|
6010
|
-
|
|
6321
|
+
400: unknown;
|
|
6011
6322
|
/**
|
|
6012
|
-
*
|
|
6323
|
+
* Missing or invalid token
|
|
6013
6324
|
*/
|
|
6014
|
-
|
|
6325
|
+
401: unknown;
|
|
6015
6326
|
};
|
|
6016
|
-
type
|
|
6017
|
-
type GetInvoicePreviewResponses = {
|
|
6327
|
+
type ListSubscriptionsResponses = {
|
|
6018
6328
|
/**
|
|
6019
|
-
*
|
|
6329
|
+
* The subscriptions
|
|
6020
6330
|
*/
|
|
6021
|
-
200:
|
|
6331
|
+
200: SubscriptionsList;
|
|
6022
6332
|
};
|
|
6023
|
-
type
|
|
6024
|
-
type
|
|
6025
|
-
body
|
|
6333
|
+
type ListSubscriptionsResponse = ListSubscriptionsResponses[keyof ListSubscriptionsResponses];
|
|
6334
|
+
type CancelSubscriptionData = {
|
|
6335
|
+
body?: never;
|
|
6026
6336
|
path: {
|
|
6027
|
-
|
|
6337
|
+
subscriptionId: string;
|
|
6028
6338
|
};
|
|
6029
6339
|
query?: never;
|
|
6030
|
-
url: "/api/v1/
|
|
6340
|
+
url: "/api/v1/subscriptions/{subscriptionId}/cancel";
|
|
6031
6341
|
};
|
|
6032
|
-
type
|
|
6342
|
+
type CancelSubscriptionErrors = {
|
|
6033
6343
|
/**
|
|
6034
|
-
*
|
|
6344
|
+
* Site tokens are not permitted
|
|
6035
6345
|
*/
|
|
6036
|
-
|
|
6346
|
+
403: unknown;
|
|
6037
6347
|
/**
|
|
6038
|
-
*
|
|
6348
|
+
* Subscription not found (or belongs to another org)
|
|
6039
6349
|
*/
|
|
6040
|
-
|
|
6350
|
+
404: unknown;
|
|
6041
6351
|
/**
|
|
6042
|
-
*
|
|
6352
|
+
* Subscription already ended (code ended) — terminal locally, or Stripe says it is already canceled
|
|
6043
6353
|
*/
|
|
6044
|
-
|
|
6354
|
+
409: unknown;
|
|
6045
6355
|
/**
|
|
6046
|
-
*
|
|
6356
|
+
* Stripe unreachable — retry
|
|
6047
6357
|
*/
|
|
6048
|
-
|
|
6049
|
-
/**
|
|
6050
|
-
* The invoice is not in a state that allows this
|
|
6051
|
-
*/
|
|
6052
|
-
409: InvoiceError;
|
|
6053
|
-
/**
|
|
6054
|
-
* Reissue refused: the site's invoice budget is spent — the original is left untouched
|
|
6055
|
-
*/
|
|
6056
|
-
429: InvoiceError;
|
|
6057
|
-
/**
|
|
6058
|
-
* Stripe unreachable — retry
|
|
6059
|
-
*/
|
|
6060
|
-
502: InvoiceError;
|
|
6358
|
+
502: unknown;
|
|
6061
6359
|
};
|
|
6062
|
-
type
|
|
6063
|
-
type VoidInvoiceResponses = {
|
|
6360
|
+
type CancelSubscriptionResponses = {
|
|
6064
6361
|
/**
|
|
6065
|
-
*
|
|
6362
|
+
* The updated subscription
|
|
6066
6363
|
*/
|
|
6067
|
-
200:
|
|
6364
|
+
200: SubscriptionSummary;
|
|
6068
6365
|
};
|
|
6069
|
-
type
|
|
6070
|
-
type
|
|
6071
|
-
body
|
|
6366
|
+
type CancelSubscriptionResponse = CancelSubscriptionResponses[keyof CancelSubscriptionResponses];
|
|
6367
|
+
type TeardownSiteSubscriptionsData = {
|
|
6368
|
+
body?: SubscriptionsTeardownBody;
|
|
6072
6369
|
path: {
|
|
6073
|
-
|
|
6370
|
+
siteId: string;
|
|
6074
6371
|
};
|
|
6075
6372
|
query?: never;
|
|
6076
|
-
url: "/api/v1/
|
|
6373
|
+
url: "/api/v1/sites/{siteId}/subscriptions/teardown";
|
|
6077
6374
|
};
|
|
6078
|
-
type
|
|
6375
|
+
type TeardownSiteSubscriptionsErrors = {
|
|
6079
6376
|
/**
|
|
6080
|
-
*
|
|
6377
|
+
* Site tokens are not permitted
|
|
6081
6378
|
*/
|
|
6082
|
-
|
|
6379
|
+
403: unknown;
|
|
6083
6380
|
/**
|
|
6084
|
-
*
|
|
6381
|
+
* Site not found. `code` distinguishes the two cases: 'site_not_found' (no such site — terminal, stop retrying) vs 'site_not_accessible' (the site exists but belongs to another organization — your key is wrong or rotated, so RETRY rather than discarding state).
|
|
6085
6382
|
*/
|
|
6086
|
-
|
|
6383
|
+
404: Error;
|
|
6384
|
+
};
|
|
6385
|
+
type TeardownSiteSubscriptionsError = TeardownSiteSubscriptionsErrors[keyof TeardownSiteSubscriptionsErrors];
|
|
6386
|
+
type TeardownSiteSubscriptionsResponses = {
|
|
6087
6387
|
/**
|
|
6088
|
-
*
|
|
6388
|
+
* Teardown outcome
|
|
6089
6389
|
*/
|
|
6090
|
-
|
|
6390
|
+
200: SubscriptionsTeardownResult;
|
|
6391
|
+
};
|
|
6392
|
+
type TeardownSiteSubscriptionsResponse = TeardownSiteSubscriptionsResponses[keyof TeardownSiteSubscriptionsResponses];
|
|
6393
|
+
type ReactivateSiteSubscriptionsTeardownData = {
|
|
6394
|
+
body?: SubscriptionsReactivateBody;
|
|
6395
|
+
path: {
|
|
6396
|
+
siteId: string;
|
|
6397
|
+
};
|
|
6398
|
+
query?: never;
|
|
6399
|
+
url: "/api/v1/sites/{siteId}/subscriptions/reactivate-teardown";
|
|
6400
|
+
};
|
|
6401
|
+
type ReactivateSiteSubscriptionsTeardownErrors = {
|
|
6091
6402
|
/**
|
|
6092
|
-
*
|
|
6403
|
+
* Unknown key in the body (a misspelled `reason` is refused, never ignored)
|
|
6093
6404
|
*/
|
|
6094
|
-
|
|
6405
|
+
400: Error;
|
|
6095
6406
|
/**
|
|
6096
|
-
*
|
|
6407
|
+
* Site tokens are not permitted
|
|
6097
6408
|
*/
|
|
6098
|
-
|
|
6409
|
+
403: unknown;
|
|
6099
6410
|
/**
|
|
6100
|
-
*
|
|
6411
|
+
* Site not found. `code` distinguishes the two cases: 'site_not_found' (no such site — terminal) vs 'site_not_accessible' (exists, another organization — wrong or rotated key, retry).
|
|
6101
6412
|
*/
|
|
6102
|
-
|
|
6413
|
+
404: Error;
|
|
6103
6414
|
/**
|
|
6104
|
-
*
|
|
6415
|
+
* The site is soft-deleted (`code: 'site_deleted'`): a deleted store never resumes charging, so nothing is reactivated. Terminal for the caller — a restore (clearing deleted_at) is a support action.
|
|
6105
6416
|
*/
|
|
6106
|
-
|
|
6417
|
+
409: Error;
|
|
6107
6418
|
};
|
|
6108
|
-
type
|
|
6109
|
-
type
|
|
6419
|
+
type ReactivateSiteSubscriptionsTeardownError = ReactivateSiteSubscriptionsTeardownErrors[keyof ReactivateSiteSubscriptionsTeardownErrors];
|
|
6420
|
+
type ReactivateSiteSubscriptionsTeardownResponses = {
|
|
6110
6421
|
/**
|
|
6111
|
-
*
|
|
6422
|
+
* Reactivation outcome
|
|
6112
6423
|
*/
|
|
6113
|
-
|
|
6424
|
+
200: SubscriptionsReactivateResult;
|
|
6114
6425
|
};
|
|
6115
|
-
type
|
|
6116
|
-
type
|
|
6117
|
-
body:
|
|
6426
|
+
type ReactivateSiteSubscriptionsTeardownResponse = ReactivateSiteSubscriptionsTeardownResponses[keyof ReactivateSiteSubscriptionsTeardownResponses];
|
|
6427
|
+
type CreatePreviewSessionData = {
|
|
6428
|
+
body: CreatePreviewSession;
|
|
6118
6429
|
path: {
|
|
6119
|
-
|
|
6430
|
+
siteId: string;
|
|
6120
6431
|
};
|
|
6121
6432
|
query?: never;
|
|
6122
|
-
url: "/api/v1/
|
|
6433
|
+
url: "/api/v1/sites/{siteId}/preview-session";
|
|
6123
6434
|
};
|
|
6124
|
-
type
|
|
6435
|
+
type CreatePreviewSessionErrors = {
|
|
6125
6436
|
/**
|
|
6126
|
-
*
|
|
6437
|
+
* Unauthorized
|
|
6127
6438
|
*/
|
|
6128
|
-
|
|
6439
|
+
401: unknown;
|
|
6129
6440
|
/**
|
|
6130
|
-
*
|
|
6441
|
+
* Site tokens are not permitted — org API key only
|
|
6131
6442
|
*/
|
|
6132
|
-
|
|
6443
|
+
403: unknown;
|
|
6133
6444
|
/**
|
|
6134
|
-
* Site
|
|
6445
|
+
* Site not found — `code` is 'site_not_found' (no such site) or 'site_not_accessible' (another organization's site).
|
|
6135
6446
|
*/
|
|
6136
|
-
|
|
6447
|
+
404: Error;
|
|
6137
6448
|
/**
|
|
6138
|
-
*
|
|
6449
|
+
* Preview customer record could not be created
|
|
6139
6450
|
*/
|
|
6140
|
-
|
|
6451
|
+
500: unknown;
|
|
6452
|
+
};
|
|
6453
|
+
type CreatePreviewSessionError = CreatePreviewSessionErrors[keyof CreatePreviewSessionErrors];
|
|
6454
|
+
type CreatePreviewSessionResponses = {
|
|
6141
6455
|
/**
|
|
6142
|
-
*
|
|
6456
|
+
* Preview session minted
|
|
6143
6457
|
*/
|
|
6144
|
-
|
|
6458
|
+
200: PreviewSessionResult;
|
|
6459
|
+
};
|
|
6460
|
+
type CreatePreviewSessionResponse = CreatePreviewSessionResponses[keyof CreatePreviewSessionResponses];
|
|
6461
|
+
type ListInvoicesData = {
|
|
6462
|
+
body?: never;
|
|
6463
|
+
path?: never;
|
|
6464
|
+
query?: {
|
|
6465
|
+
site_id?: string;
|
|
6466
|
+
/**
|
|
6467
|
+
* Comma-separated derived labels to keep (awaiting_payment, overdue, paid, voided, …)
|
|
6468
|
+
*/
|
|
6469
|
+
label?: string;
|
|
6470
|
+
/**
|
|
6471
|
+
* Comma-separated raw statuses
|
|
6472
|
+
*/
|
|
6473
|
+
status?: string;
|
|
6474
|
+
customer_email?: string;
|
|
6475
|
+
customer_id?: string;
|
|
6476
|
+
retainer_id?: string;
|
|
6477
|
+
/**
|
|
6478
|
+
* Case-insensitive substring on the invoice number, the recipient's name or email — "ACME-0007", "bob"
|
|
6479
|
+
*/
|
|
6480
|
+
q?: string;
|
|
6481
|
+
/**
|
|
6482
|
+
* Created on/after (YYYY-MM-DD)
|
|
6483
|
+
*/
|
|
6484
|
+
from?: string;
|
|
6485
|
+
/**
|
|
6486
|
+
* Created on/before (YYYY-MM-DD)
|
|
6487
|
+
*/
|
|
6488
|
+
to?: string;
|
|
6489
|
+
include?: string;
|
|
6490
|
+
limit?: string;
|
|
6491
|
+
offset?: string;
|
|
6492
|
+
};
|
|
6493
|
+
url: "/api/v1/invoices";
|
|
6494
|
+
};
|
|
6495
|
+
type ListInvoicesErrors = {
|
|
6145
6496
|
/**
|
|
6146
|
-
*
|
|
6497
|
+
* Bad scope
|
|
6147
6498
|
*/
|
|
6148
|
-
|
|
6499
|
+
400: InvoiceError;
|
|
6149
6500
|
/**
|
|
6150
|
-
*
|
|
6501
|
+
* Unauthorized
|
|
6151
6502
|
*/
|
|
6152
|
-
|
|
6503
|
+
401: InvoiceError;
|
|
6153
6504
|
};
|
|
6154
|
-
type
|
|
6155
|
-
type
|
|
6505
|
+
type ListInvoicesError = ListInvoicesErrors[keyof ListInvoicesErrors];
|
|
6506
|
+
type ListInvoicesResponses = {
|
|
6156
6507
|
/**
|
|
6157
|
-
*
|
|
6508
|
+
* Invoices
|
|
6158
6509
|
*/
|
|
6159
|
-
|
|
6510
|
+
200: InvoicesList;
|
|
6160
6511
|
};
|
|
6161
|
-
type
|
|
6162
|
-
type
|
|
6163
|
-
body:
|
|
6164
|
-
path
|
|
6165
|
-
invoiceId: string;
|
|
6166
|
-
};
|
|
6512
|
+
type ListInvoicesResponse = ListInvoicesResponses[keyof ListInvoicesResponses];
|
|
6513
|
+
type CreateInvoiceData = {
|
|
6514
|
+
body: CreateInvoice;
|
|
6515
|
+
path?: never;
|
|
6167
6516
|
query?: never;
|
|
6168
|
-
url: "/api/v1/invoices
|
|
6517
|
+
url: "/api/v1/invoices";
|
|
6169
6518
|
};
|
|
6170
|
-
type
|
|
6519
|
+
type CreateInvoiceErrors = {
|
|
6171
6520
|
/**
|
|
6172
|
-
* Invalid
|
|
6521
|
+
* Invalid input, content rule, or billing_address_required
|
|
6173
6522
|
*/
|
|
6174
6523
|
400: InvoiceError;
|
|
6175
6524
|
/**
|
|
@@ -6188,82 +6537,126 @@ type SnoozeInvoiceErrors = {
|
|
|
6188
6537
|
* The invoice is not in a state that allows this
|
|
6189
6538
|
*/
|
|
6190
6539
|
409: InvoiceError;
|
|
6540
|
+
/**
|
|
6541
|
+
* Per-site invoice budget exceeded
|
|
6542
|
+
*/
|
|
6543
|
+
429: InvoiceError;
|
|
6191
6544
|
/**
|
|
6192
6545
|
* Stripe unreachable — retry
|
|
6193
6546
|
*/
|
|
6194
6547
|
502: InvoiceError;
|
|
6195
6548
|
};
|
|
6196
|
-
type
|
|
6197
|
-
type
|
|
6549
|
+
type CreateInvoiceError = CreateInvoiceErrors[keyof CreateInvoiceErrors];
|
|
6550
|
+
type CreateInvoiceResponses = {
|
|
6198
6551
|
/**
|
|
6199
|
-
*
|
|
6552
|
+
* Created and sent
|
|
6200
6553
|
*/
|
|
6201
|
-
|
|
6554
|
+
201: CreateInvoiceResult;
|
|
6555
|
+
/**
|
|
6556
|
+
* Creation continues in the background
|
|
6557
|
+
*/
|
|
6558
|
+
202: CreateInvoiceResult;
|
|
6202
6559
|
};
|
|
6203
|
-
type
|
|
6204
|
-
type
|
|
6205
|
-
body
|
|
6560
|
+
type CreateInvoiceResponse = CreateInvoiceResponses[keyof CreateInvoiceResponses];
|
|
6561
|
+
type GetInvoiceData = {
|
|
6562
|
+
body?: never;
|
|
6206
6563
|
path: {
|
|
6207
6564
|
invoiceId: string;
|
|
6208
6565
|
};
|
|
6209
6566
|
query?: never;
|
|
6210
|
-
url: "/api/v1/invoices/{invoiceId}
|
|
6567
|
+
url: "/api/v1/invoices/{invoiceId}";
|
|
6211
6568
|
};
|
|
6212
|
-
type
|
|
6213
|
-
/**
|
|
6214
|
-
* Invalid schedule
|
|
6215
|
-
*/
|
|
6216
|
-
400: InvoiceError;
|
|
6569
|
+
type GetInvoiceErrors = {
|
|
6217
6570
|
/**
|
|
6218
6571
|
* Unauthorized
|
|
6219
6572
|
*/
|
|
6220
6573
|
401: InvoiceError;
|
|
6221
6574
|
/**
|
|
6222
|
-
*
|
|
6223
|
-
*/
|
|
6224
|
-
403: InvoiceError;
|
|
6225
|
-
/**
|
|
6226
|
-
* Invoice not found
|
|
6575
|
+
* Not found
|
|
6227
6576
|
*/
|
|
6228
6577
|
404: InvoiceError;
|
|
6229
|
-
/**
|
|
6230
|
-
* The invoice is not in a state that allows this
|
|
6231
|
-
*/
|
|
6232
|
-
409: InvoiceError;
|
|
6233
|
-
/**
|
|
6234
|
-
* Stripe unreachable — retry
|
|
6235
|
-
*/
|
|
6236
|
-
502: InvoiceError;
|
|
6237
6578
|
};
|
|
6238
|
-
type
|
|
6239
|
-
type
|
|
6579
|
+
type GetInvoiceError = GetInvoiceErrors[keyof GetInvoiceErrors];
|
|
6580
|
+
type GetInvoiceResponses = {
|
|
6240
6581
|
/**
|
|
6241
|
-
*
|
|
6582
|
+
* The invoice
|
|
6242
6583
|
*/
|
|
6243
6584
|
200: Invoice;
|
|
6244
6585
|
};
|
|
6245
|
-
type
|
|
6246
|
-
type
|
|
6247
|
-
body:
|
|
6248
|
-
|
|
6249
|
-
invoiceId: string;
|
|
6586
|
+
type GetInvoiceResponse = GetInvoiceResponses[keyof GetInvoiceResponses];
|
|
6587
|
+
type PreviewInvoiceData = {
|
|
6588
|
+
body: PreviewInvoice & {
|
|
6589
|
+
site_id?: string;
|
|
6250
6590
|
};
|
|
6591
|
+
path?: never;
|
|
6251
6592
|
query?: never;
|
|
6252
|
-
url: "/api/v1/invoices/
|
|
6593
|
+
url: "/api/v1/invoices/preview";
|
|
6253
6594
|
};
|
|
6254
|
-
type
|
|
6595
|
+
type PreviewInvoiceErrors = {
|
|
6255
6596
|
/**
|
|
6256
|
-
* Invalid
|
|
6597
|
+
* Invalid proposal
|
|
6257
6598
|
*/
|
|
6258
6599
|
400: InvoiceError;
|
|
6259
6600
|
/**
|
|
6260
6601
|
* Unauthorized
|
|
6261
6602
|
*/
|
|
6262
6603
|
401: InvoiceError;
|
|
6604
|
+
};
|
|
6605
|
+
type PreviewInvoiceError = PreviewInvoiceErrors[keyof PreviewInvoiceErrors];
|
|
6606
|
+
type PreviewInvoiceResponses = {
|
|
6263
6607
|
/**
|
|
6264
|
-
*
|
|
6608
|
+
* Rendered email
|
|
6265
6609
|
*/
|
|
6266
|
-
|
|
6610
|
+
200: InvoicePreview;
|
|
6611
|
+
};
|
|
6612
|
+
type PreviewInvoiceResponse = PreviewInvoiceResponses[keyof PreviewInvoiceResponses];
|
|
6613
|
+
type GetInvoicePreviewData = {
|
|
6614
|
+
body?: never;
|
|
6615
|
+
path: {
|
|
6616
|
+
invoiceId: string;
|
|
6617
|
+
};
|
|
6618
|
+
query?: never;
|
|
6619
|
+
url: "/api/v1/invoices/{invoiceId}/preview";
|
|
6620
|
+
};
|
|
6621
|
+
type GetInvoicePreviewErrors = {
|
|
6622
|
+
/**
|
|
6623
|
+
* Unauthorized
|
|
6624
|
+
*/
|
|
6625
|
+
401: InvoiceError;
|
|
6626
|
+
/**
|
|
6627
|
+
* Not found
|
|
6628
|
+
*/
|
|
6629
|
+
404: InvoiceError;
|
|
6630
|
+
};
|
|
6631
|
+
type GetInvoicePreviewError = GetInvoicePreviewErrors[keyof GetInvoicePreviewErrors];
|
|
6632
|
+
type GetInvoicePreviewResponses = {
|
|
6633
|
+
/**
|
|
6634
|
+
* Rendered email
|
|
6635
|
+
*/
|
|
6636
|
+
200: InvoicePreview;
|
|
6637
|
+
};
|
|
6638
|
+
type GetInvoicePreviewResponse = GetInvoicePreviewResponses[keyof GetInvoicePreviewResponses];
|
|
6639
|
+
type VoidInvoiceData = {
|
|
6640
|
+
body: VoidInvoice;
|
|
6641
|
+
path: {
|
|
6642
|
+
invoiceId: string;
|
|
6643
|
+
};
|
|
6644
|
+
query?: never;
|
|
6645
|
+
url: "/api/v1/invoices/{invoiceId}/void";
|
|
6646
|
+
};
|
|
6647
|
+
type VoidInvoiceErrors = {
|
|
6648
|
+
/**
|
|
6649
|
+
* Invalid reissue (refused BEFORE the original is voided — it is left untouched)
|
|
6650
|
+
*/
|
|
6651
|
+
400: InvoiceError;
|
|
6652
|
+
/**
|
|
6653
|
+
* Unauthorized
|
|
6654
|
+
*/
|
|
6655
|
+
401: InvoiceError;
|
|
6656
|
+
/**
|
|
6657
|
+
* Site tokens are not permitted, or invoicing is disabled
|
|
6658
|
+
*/
|
|
6659
|
+
403: InvoiceError;
|
|
6267
6660
|
/**
|
|
6268
6661
|
* Invoice not found
|
|
6269
6662
|
*/
|
|
@@ -6272,28 +6665,32 @@ type MarkInvoicePaidErrors = {
|
|
|
6272
6665
|
* The invoice is not in a state that allows this
|
|
6273
6666
|
*/
|
|
6274
6667
|
409: InvoiceError;
|
|
6668
|
+
/**
|
|
6669
|
+
* Reissue refused: the site's invoice budget is spent — the original is left untouched
|
|
6670
|
+
*/
|
|
6671
|
+
429: InvoiceError;
|
|
6275
6672
|
/**
|
|
6276
6673
|
* Stripe unreachable — retry
|
|
6277
6674
|
*/
|
|
6278
6675
|
502: InvoiceError;
|
|
6279
6676
|
};
|
|
6280
|
-
type
|
|
6281
|
-
type
|
|
6677
|
+
type VoidInvoiceError = VoidInvoiceErrors[keyof VoidInvoiceErrors];
|
|
6678
|
+
type VoidInvoiceResponses = {
|
|
6282
6679
|
/**
|
|
6283
|
-
*
|
|
6680
|
+
* Voided
|
|
6284
6681
|
*/
|
|
6285
|
-
200:
|
|
6682
|
+
200: VoidInvoiceResult;
|
|
6286
6683
|
};
|
|
6287
|
-
type
|
|
6288
|
-
type
|
|
6684
|
+
type VoidInvoiceResponse = VoidInvoiceResponses[keyof VoidInvoiceResponses];
|
|
6685
|
+
type ResendInvoiceData = {
|
|
6289
6686
|
body: InvoiceSiteBody;
|
|
6290
6687
|
path: {
|
|
6291
6688
|
invoiceId: string;
|
|
6292
6689
|
};
|
|
6293
6690
|
query?: never;
|
|
6294
|
-
url: "/api/v1/invoices/{invoiceId}/
|
|
6691
|
+
url: "/api/v1/invoices/{invoiceId}/resend";
|
|
6295
6692
|
};
|
|
6296
|
-
type
|
|
6693
|
+
type ResendInvoiceErrors = {
|
|
6297
6694
|
/**
|
|
6298
6695
|
* Invalid request
|
|
6299
6696
|
*/
|
|
@@ -6314,30 +6711,34 @@ type MarkInvoiceUncollectibleErrors = {
|
|
|
6314
6711
|
* The invoice is not in a state that allows this
|
|
6315
6712
|
*/
|
|
6316
6713
|
409: InvoiceError;
|
|
6714
|
+
/**
|
|
6715
|
+
* This recipient was emailed recently — the per-recipient cooldown (one buyer email an hour, six a day, first send of an invoice exempt)
|
|
6716
|
+
*/
|
|
6717
|
+
429: RecipientCooldownError;
|
|
6317
6718
|
/**
|
|
6318
6719
|
* Stripe unreachable — retry
|
|
6319
6720
|
*/
|
|
6320
6721
|
502: InvoiceError;
|
|
6321
6722
|
};
|
|
6322
|
-
type
|
|
6323
|
-
type
|
|
6723
|
+
type ResendInvoiceError = ResendInvoiceErrors[keyof ResendInvoiceErrors];
|
|
6724
|
+
type ResendInvoiceResponses = {
|
|
6324
6725
|
/**
|
|
6325
|
-
*
|
|
6726
|
+
* Queued
|
|
6326
6727
|
*/
|
|
6327
|
-
|
|
6728
|
+
202: RemindInvoiceResult;
|
|
6328
6729
|
};
|
|
6329
|
-
type
|
|
6330
|
-
type
|
|
6331
|
-
body:
|
|
6730
|
+
type ResendInvoiceResponse = ResendInvoiceResponses[keyof ResendInvoiceResponses];
|
|
6731
|
+
type RemindInvoiceData = {
|
|
6732
|
+
body: InvoiceSiteBody;
|
|
6332
6733
|
path: {
|
|
6333
6734
|
invoiceId: string;
|
|
6334
6735
|
};
|
|
6335
6736
|
query?: never;
|
|
6336
|
-
url: "/api/v1/invoices/{invoiceId}/
|
|
6737
|
+
url: "/api/v1/invoices/{invoiceId}/remind";
|
|
6337
6738
|
};
|
|
6338
|
-
type
|
|
6739
|
+
type RemindInvoiceErrors = {
|
|
6339
6740
|
/**
|
|
6340
|
-
* Invalid
|
|
6741
|
+
* Invalid request
|
|
6341
6742
|
*/
|
|
6342
6743
|
400: InvoiceError;
|
|
6343
6744
|
/**
|
|
@@ -6356,30 +6757,34 @@ type UpdateInvoiceRecipientErrors = {
|
|
|
6356
6757
|
* The invoice is not in a state that allows this
|
|
6357
6758
|
*/
|
|
6358
6759
|
409: InvoiceError;
|
|
6760
|
+
/**
|
|
6761
|
+
* This recipient was emailed recently — the per-recipient cooldown (one buyer email an hour, six a day, first send of an invoice exempt)
|
|
6762
|
+
*/
|
|
6763
|
+
429: RecipientCooldownError;
|
|
6359
6764
|
/**
|
|
6360
6765
|
* Stripe unreachable — retry
|
|
6361
6766
|
*/
|
|
6362
6767
|
502: InvoiceError;
|
|
6363
6768
|
};
|
|
6364
|
-
type
|
|
6365
|
-
type
|
|
6769
|
+
type RemindInvoiceError = RemindInvoiceErrors[keyof RemindInvoiceErrors];
|
|
6770
|
+
type RemindInvoiceResponses = {
|
|
6366
6771
|
/**
|
|
6367
|
-
*
|
|
6772
|
+
* Queued
|
|
6368
6773
|
*/
|
|
6369
|
-
|
|
6774
|
+
202: RemindInvoiceResult;
|
|
6370
6775
|
};
|
|
6371
|
-
type
|
|
6372
|
-
type
|
|
6373
|
-
body:
|
|
6776
|
+
type RemindInvoiceResponse = RemindInvoiceResponses[keyof RemindInvoiceResponses];
|
|
6777
|
+
type SnoozeInvoiceData = {
|
|
6778
|
+
body: SnoozeInvoice;
|
|
6374
6779
|
path: {
|
|
6375
|
-
|
|
6780
|
+
invoiceId: string;
|
|
6376
6781
|
};
|
|
6377
6782
|
query?: never;
|
|
6378
|
-
url: "/api/v1/
|
|
6783
|
+
url: "/api/v1/invoices/{invoiceId}/snooze";
|
|
6379
6784
|
};
|
|
6380
|
-
type
|
|
6785
|
+
type SnoozeInvoiceErrors = {
|
|
6381
6786
|
/**
|
|
6382
|
-
* Invalid
|
|
6787
|
+
* Invalid date
|
|
6383
6788
|
*/
|
|
6384
6789
|
400: InvoiceError;
|
|
6385
6790
|
/**
|
|
@@ -6403,45 +6808,67 @@ type UpdateCustomerBillingErrors = {
|
|
|
6403
6808
|
*/
|
|
6404
6809
|
502: InvoiceError;
|
|
6405
6810
|
};
|
|
6406
|
-
type
|
|
6407
|
-
type
|
|
6811
|
+
type SnoozeInvoiceError = SnoozeInvoiceErrors[keyof SnoozeInvoiceErrors];
|
|
6812
|
+
type SnoozeInvoiceResponses = {
|
|
6408
6813
|
/**
|
|
6409
6814
|
* Updated
|
|
6410
6815
|
*/
|
|
6411
|
-
200:
|
|
6816
|
+
200: Invoice;
|
|
6412
6817
|
};
|
|
6413
|
-
type
|
|
6414
|
-
type
|
|
6415
|
-
body
|
|
6416
|
-
path
|
|
6818
|
+
type SnoozeInvoiceResponse = SnoozeInvoiceResponses[keyof SnoozeInvoiceResponses];
|
|
6819
|
+
type SetInvoiceRemindersData = {
|
|
6820
|
+
body: SetInvoiceReminders;
|
|
6821
|
+
path: {
|
|
6822
|
+
invoiceId: string;
|
|
6823
|
+
};
|
|
6417
6824
|
query?: never;
|
|
6418
|
-
url: "/api/v1/
|
|
6825
|
+
url: "/api/v1/invoices/{invoiceId}/reminders";
|
|
6419
6826
|
};
|
|
6420
|
-
type
|
|
6827
|
+
type SetInvoiceRemindersErrors = {
|
|
6421
6828
|
/**
|
|
6422
|
-
*
|
|
6829
|
+
* Invalid schedule
|
|
6830
|
+
*/
|
|
6831
|
+
400: InvoiceError;
|
|
6832
|
+
/**
|
|
6833
|
+
* Unauthorized
|
|
6423
6834
|
*/
|
|
6424
6835
|
401: InvoiceError;
|
|
6836
|
+
/**
|
|
6837
|
+
* Site tokens are not permitted, or invoicing is disabled
|
|
6838
|
+
*/
|
|
6839
|
+
403: InvoiceError;
|
|
6840
|
+
/**
|
|
6841
|
+
* Invoice not found
|
|
6842
|
+
*/
|
|
6843
|
+
404: InvoiceError;
|
|
6844
|
+
/**
|
|
6845
|
+
* The invoice is not in a state that allows this
|
|
6846
|
+
*/
|
|
6847
|
+
409: InvoiceError;
|
|
6848
|
+
/**
|
|
6849
|
+
* Stripe unreachable — retry
|
|
6850
|
+
*/
|
|
6851
|
+
502: InvoiceError;
|
|
6425
6852
|
};
|
|
6426
|
-
type
|
|
6427
|
-
type
|
|
6853
|
+
type SetInvoiceRemindersError = SetInvoiceRemindersErrors[keyof SetInvoiceRemindersErrors];
|
|
6854
|
+
type SetInvoiceRemindersResponses = {
|
|
6428
6855
|
/**
|
|
6429
|
-
*
|
|
6856
|
+
* Updated
|
|
6430
6857
|
*/
|
|
6431
|
-
200:
|
|
6858
|
+
200: Invoice;
|
|
6432
6859
|
};
|
|
6433
|
-
type
|
|
6434
|
-
type
|
|
6435
|
-
body
|
|
6860
|
+
type SetInvoiceRemindersResponse = SetInvoiceRemindersResponses[keyof SetInvoiceRemindersResponses];
|
|
6861
|
+
type MarkInvoicePaidData = {
|
|
6862
|
+
body: MarkInvoicePaid;
|
|
6436
6863
|
path: {
|
|
6437
|
-
|
|
6864
|
+
invoiceId: string;
|
|
6438
6865
|
};
|
|
6439
6866
|
query?: never;
|
|
6440
|
-
url: "/api/v1/
|
|
6867
|
+
url: "/api/v1/invoices/{invoiceId}/mark-paid";
|
|
6441
6868
|
};
|
|
6442
|
-
type
|
|
6869
|
+
type MarkInvoicePaidErrors = {
|
|
6443
6870
|
/**
|
|
6444
|
-
*
|
|
6871
|
+
* Invalid request
|
|
6445
6872
|
*/
|
|
6446
6873
|
400: InvoiceError;
|
|
6447
6874
|
/**
|
|
@@ -6449,29 +6876,41 @@ type GetInvoiceSettingsErrors = {
|
|
|
6449
6876
|
*/
|
|
6450
6877
|
401: InvoiceError;
|
|
6451
6878
|
/**
|
|
6452
|
-
*
|
|
6879
|
+
* Site tokens are not permitted, or invoicing is disabled
|
|
6880
|
+
*/
|
|
6881
|
+
403: InvoiceError;
|
|
6882
|
+
/**
|
|
6883
|
+
* Invoice not found
|
|
6453
6884
|
*/
|
|
6454
6885
|
404: InvoiceError;
|
|
6886
|
+
/**
|
|
6887
|
+
* The invoice is not in a state that allows this
|
|
6888
|
+
*/
|
|
6889
|
+
409: InvoiceError;
|
|
6890
|
+
/**
|
|
6891
|
+
* Stripe unreachable — retry
|
|
6892
|
+
*/
|
|
6893
|
+
502: InvoiceError;
|
|
6455
6894
|
};
|
|
6456
|
-
type
|
|
6457
|
-
type
|
|
6895
|
+
type MarkInvoicePaidError = MarkInvoicePaidErrors[keyof MarkInvoicePaidErrors];
|
|
6896
|
+
type MarkInvoicePaidResponses = {
|
|
6458
6897
|
/**
|
|
6459
|
-
*
|
|
6898
|
+
* Recorded
|
|
6460
6899
|
*/
|
|
6461
|
-
200:
|
|
6900
|
+
200: MarkInvoicePaidResult;
|
|
6462
6901
|
};
|
|
6463
|
-
type
|
|
6464
|
-
type
|
|
6465
|
-
body:
|
|
6902
|
+
type MarkInvoicePaidResponse = MarkInvoicePaidResponses[keyof MarkInvoicePaidResponses];
|
|
6903
|
+
type MarkInvoiceUncollectibleData = {
|
|
6904
|
+
body: InvoiceSiteBody;
|
|
6466
6905
|
path: {
|
|
6467
|
-
|
|
6906
|
+
invoiceId: string;
|
|
6468
6907
|
};
|
|
6469
6908
|
query?: never;
|
|
6470
|
-
url: "/api/v1/
|
|
6909
|
+
url: "/api/v1/invoices/{invoiceId}/mark-uncollectible";
|
|
6471
6910
|
};
|
|
6472
|
-
type
|
|
6911
|
+
type MarkInvoiceUncollectibleErrors = {
|
|
6473
6912
|
/**
|
|
6474
|
-
* Invalid
|
|
6913
|
+
* Invalid request
|
|
6475
6914
|
*/
|
|
6476
6915
|
400: InvoiceError;
|
|
6477
6916
|
/**
|
|
@@ -6495,23 +6934,27 @@ type UpdateInvoiceSettingsErrors = {
|
|
|
6495
6934
|
*/
|
|
6496
6935
|
502: InvoiceError;
|
|
6497
6936
|
};
|
|
6498
|
-
type
|
|
6499
|
-
type
|
|
6937
|
+
type MarkInvoiceUncollectibleError = MarkInvoiceUncollectibleErrors[keyof MarkInvoiceUncollectibleErrors];
|
|
6938
|
+
type MarkInvoiceUncollectibleResponses = {
|
|
6500
6939
|
/**
|
|
6501
|
-
*
|
|
6940
|
+
* Written off
|
|
6502
6941
|
*/
|
|
6503
|
-
200:
|
|
6942
|
+
200: Invoice;
|
|
6504
6943
|
};
|
|
6505
|
-
type
|
|
6506
|
-
type
|
|
6507
|
-
body:
|
|
6944
|
+
type MarkInvoiceUncollectibleResponse = MarkInvoiceUncollectibleResponses[keyof MarkInvoiceUncollectibleResponses];
|
|
6945
|
+
type UpdateInvoiceRecipientData = {
|
|
6946
|
+
body: UpdateInvoiceRecipient;
|
|
6508
6947
|
path: {
|
|
6509
|
-
|
|
6948
|
+
invoiceId: string;
|
|
6510
6949
|
};
|
|
6511
6950
|
query?: never;
|
|
6512
|
-
url: "/api/v1/
|
|
6951
|
+
url: "/api/v1/invoices/{invoiceId}/recipient";
|
|
6513
6952
|
};
|
|
6514
|
-
type
|
|
6953
|
+
type UpdateInvoiceRecipientErrors = {
|
|
6954
|
+
/**
|
|
6955
|
+
* Invalid email
|
|
6956
|
+
*/
|
|
6957
|
+
400: InvoiceError;
|
|
6515
6958
|
/**
|
|
6516
6959
|
* Unauthorized
|
|
6517
6960
|
*/
|
|
@@ -6533,17 +6976,189 @@ type UpdateSiteInvoicingErrors = {
|
|
|
6533
6976
|
*/
|
|
6534
6977
|
502: InvoiceError;
|
|
6535
6978
|
};
|
|
6536
|
-
type
|
|
6537
|
-
type
|
|
6979
|
+
type UpdateInvoiceRecipientError = UpdateInvoiceRecipientErrors[keyof UpdateInvoiceRecipientErrors];
|
|
6980
|
+
type UpdateInvoiceRecipientResponses = {
|
|
6538
6981
|
/**
|
|
6539
|
-
* Updated
|
|
6982
|
+
* Updated — `communication_id` says whether a resend went out, `customer_updated` whether the customer record changed
|
|
6540
6983
|
*/
|
|
6541
|
-
200:
|
|
6984
|
+
200: UpdateRecipientResult;
|
|
6542
6985
|
};
|
|
6543
|
-
type
|
|
6544
|
-
type
|
|
6545
|
-
body
|
|
6546
|
-
path
|
|
6986
|
+
type UpdateInvoiceRecipientResponse = UpdateInvoiceRecipientResponses[keyof UpdateInvoiceRecipientResponses];
|
|
6987
|
+
type UpdateCustomerBillingData = {
|
|
6988
|
+
body: UpdateCustomerBilling;
|
|
6989
|
+
path: {
|
|
6990
|
+
customerId: string;
|
|
6991
|
+
};
|
|
6992
|
+
query?: never;
|
|
6993
|
+
url: "/api/v1/customers/{customerId}/billing";
|
|
6994
|
+
};
|
|
6995
|
+
type UpdateCustomerBillingErrors = {
|
|
6996
|
+
/**
|
|
6997
|
+
* Invalid bill-to
|
|
6998
|
+
*/
|
|
6999
|
+
400: InvoiceError;
|
|
7000
|
+
/**
|
|
7001
|
+
* Unauthorized
|
|
7002
|
+
*/
|
|
7003
|
+
401: InvoiceError;
|
|
7004
|
+
/**
|
|
7005
|
+
* Site tokens are not permitted, or invoicing is disabled
|
|
7006
|
+
*/
|
|
7007
|
+
403: InvoiceError;
|
|
7008
|
+
/**
|
|
7009
|
+
* Invoice not found
|
|
7010
|
+
*/
|
|
7011
|
+
404: InvoiceError;
|
|
7012
|
+
/**
|
|
7013
|
+
* The invoice is not in a state that allows this
|
|
7014
|
+
*/
|
|
7015
|
+
409: InvoiceError;
|
|
7016
|
+
/**
|
|
7017
|
+
* Stripe unreachable — retry
|
|
7018
|
+
*/
|
|
7019
|
+
502: InvoiceError;
|
|
7020
|
+
};
|
|
7021
|
+
type UpdateCustomerBillingError = UpdateCustomerBillingErrors[keyof UpdateCustomerBillingErrors];
|
|
7022
|
+
type UpdateCustomerBillingResponses = {
|
|
7023
|
+
/**
|
|
7024
|
+
* Updated
|
|
7025
|
+
*/
|
|
7026
|
+
200: CustomerBilling;
|
|
7027
|
+
};
|
|
7028
|
+
type UpdateCustomerBillingResponse = UpdateCustomerBillingResponses[keyof UpdateCustomerBillingResponses];
|
|
7029
|
+
type GetInvoiceSettingsWithSiteTokenData = {
|
|
7030
|
+
body?: never;
|
|
7031
|
+
path?: never;
|
|
7032
|
+
query?: never;
|
|
7033
|
+
url: "/api/v1/invoice-settings";
|
|
7034
|
+
};
|
|
7035
|
+
type GetInvoiceSettingsWithSiteTokenErrors = {
|
|
7036
|
+
/**
|
|
7037
|
+
* Requires a site token
|
|
7038
|
+
*/
|
|
7039
|
+
401: InvoiceError;
|
|
7040
|
+
};
|
|
7041
|
+
type GetInvoiceSettingsWithSiteTokenError = GetInvoiceSettingsWithSiteTokenErrors[keyof GetInvoiceSettingsWithSiteTokenErrors];
|
|
7042
|
+
type GetInvoiceSettingsWithSiteTokenResponses = {
|
|
7043
|
+
/**
|
|
7044
|
+
* Settings
|
|
7045
|
+
*/
|
|
7046
|
+
200: InvoiceSettings;
|
|
7047
|
+
};
|
|
7048
|
+
type GetInvoiceSettingsWithSiteTokenResponse = GetInvoiceSettingsWithSiteTokenResponses[keyof GetInvoiceSettingsWithSiteTokenResponses];
|
|
7049
|
+
type GetInvoiceSettingsData = {
|
|
7050
|
+
body?: never;
|
|
7051
|
+
path: {
|
|
7052
|
+
siteId: string;
|
|
7053
|
+
};
|
|
7054
|
+
query?: never;
|
|
7055
|
+
url: "/api/v1/sites/{siteId}/invoice-settings";
|
|
7056
|
+
};
|
|
7057
|
+
type GetInvoiceSettingsErrors = {
|
|
7058
|
+
/**
|
|
7059
|
+
* Bad scope
|
|
7060
|
+
*/
|
|
7061
|
+
400: InvoiceError;
|
|
7062
|
+
/**
|
|
7063
|
+
* Unauthorized
|
|
7064
|
+
*/
|
|
7065
|
+
401: InvoiceError;
|
|
7066
|
+
/**
|
|
7067
|
+
* Not found
|
|
7068
|
+
*/
|
|
7069
|
+
404: InvoiceError;
|
|
7070
|
+
};
|
|
7071
|
+
type GetInvoiceSettingsError = GetInvoiceSettingsErrors[keyof GetInvoiceSettingsErrors];
|
|
7072
|
+
type GetInvoiceSettingsResponses = {
|
|
7073
|
+
/**
|
|
7074
|
+
* Settings
|
|
7075
|
+
*/
|
|
7076
|
+
200: InvoiceSettings;
|
|
7077
|
+
};
|
|
7078
|
+
type GetInvoiceSettingsResponse = GetInvoiceSettingsResponses[keyof GetInvoiceSettingsResponses];
|
|
7079
|
+
type UpdateInvoiceSettingsData = {
|
|
7080
|
+
body: UpdateInvoiceSettings;
|
|
7081
|
+
path: {
|
|
7082
|
+
siteId: string;
|
|
7083
|
+
};
|
|
7084
|
+
query?: never;
|
|
7085
|
+
url: "/api/v1/sites/{siteId}/invoice-settings";
|
|
7086
|
+
};
|
|
7087
|
+
type UpdateInvoiceSettingsErrors = {
|
|
7088
|
+
/**
|
|
7089
|
+
* Invalid value
|
|
7090
|
+
*/
|
|
7091
|
+
400: InvoiceError;
|
|
7092
|
+
/**
|
|
7093
|
+
* Unauthorized
|
|
7094
|
+
*/
|
|
7095
|
+
401: InvoiceError;
|
|
7096
|
+
/**
|
|
7097
|
+
* Site tokens are not permitted, or invoicing is disabled
|
|
7098
|
+
*/
|
|
7099
|
+
403: InvoiceError;
|
|
7100
|
+
/**
|
|
7101
|
+
* Invoice not found
|
|
7102
|
+
*/
|
|
7103
|
+
404: InvoiceError;
|
|
7104
|
+
/**
|
|
7105
|
+
* The invoice is not in a state that allows this
|
|
7106
|
+
*/
|
|
7107
|
+
409: InvoiceError;
|
|
7108
|
+
/**
|
|
7109
|
+
* Stripe unreachable — retry
|
|
7110
|
+
*/
|
|
7111
|
+
502: InvoiceError;
|
|
7112
|
+
};
|
|
7113
|
+
type UpdateInvoiceSettingsError = UpdateInvoiceSettingsErrors[keyof UpdateInvoiceSettingsErrors];
|
|
7114
|
+
type UpdateInvoiceSettingsResponses = {
|
|
7115
|
+
/**
|
|
7116
|
+
* Updated
|
|
7117
|
+
*/
|
|
7118
|
+
200: InvoiceSettings;
|
|
7119
|
+
};
|
|
7120
|
+
type UpdateInvoiceSettingsResponse = UpdateInvoiceSettingsResponses[keyof UpdateInvoiceSettingsResponses];
|
|
7121
|
+
type UpdateSiteInvoicingData = {
|
|
7122
|
+
body: UpdateSiteInvoicing;
|
|
7123
|
+
path: {
|
|
7124
|
+
siteId: string;
|
|
7125
|
+
};
|
|
7126
|
+
query?: never;
|
|
7127
|
+
url: "/api/v1/sites/{siteId}/invoicing";
|
|
7128
|
+
};
|
|
7129
|
+
type UpdateSiteInvoicingErrors = {
|
|
7130
|
+
/**
|
|
7131
|
+
* Unauthorized
|
|
7132
|
+
*/
|
|
7133
|
+
401: InvoiceError;
|
|
7134
|
+
/**
|
|
7135
|
+
* Site tokens are not permitted, or invoicing is disabled
|
|
7136
|
+
*/
|
|
7137
|
+
403: InvoiceError;
|
|
7138
|
+
/**
|
|
7139
|
+
* Invoice not found
|
|
7140
|
+
*/
|
|
7141
|
+
404: InvoiceError;
|
|
7142
|
+
/**
|
|
7143
|
+
* The invoice is not in a state that allows this
|
|
7144
|
+
*/
|
|
7145
|
+
409: InvoiceError;
|
|
7146
|
+
/**
|
|
7147
|
+
* Stripe unreachable — retry
|
|
7148
|
+
*/
|
|
7149
|
+
502: InvoiceError;
|
|
7150
|
+
};
|
|
7151
|
+
type UpdateSiteInvoicingError = UpdateSiteInvoicingErrors[keyof UpdateSiteInvoicingErrors];
|
|
7152
|
+
type UpdateSiteInvoicingResponses = {
|
|
7153
|
+
/**
|
|
7154
|
+
* Updated
|
|
7155
|
+
*/
|
|
7156
|
+
200: InvoiceSettings;
|
|
7157
|
+
};
|
|
7158
|
+
type UpdateSiteInvoicingResponse = UpdateSiteInvoicingResponses[keyof UpdateSiteInvoicingResponses];
|
|
7159
|
+
type ListRetainersData = {
|
|
7160
|
+
body?: never;
|
|
7161
|
+
path?: never;
|
|
6547
7162
|
query?: {
|
|
6548
7163
|
site_id?: string;
|
|
6549
7164
|
/**
|
|
@@ -6846,29 +7461,303 @@ type CancelRetainerErrors = {
|
|
|
6846
7461
|
*/
|
|
6847
7462
|
502: RetainerError;
|
|
6848
7463
|
};
|
|
6849
|
-
type CancelRetainerError = CancelRetainerErrors[keyof CancelRetainerErrors];
|
|
6850
|
-
type CancelRetainerResponses = {
|
|
7464
|
+
type CancelRetainerError = CancelRetainerErrors[keyof CancelRetainerErrors];
|
|
7465
|
+
type CancelRetainerResponses = {
|
|
7466
|
+
/**
|
|
7467
|
+
* Canceling
|
|
7468
|
+
*/
|
|
7469
|
+
200: Retainer;
|
|
7470
|
+
};
|
|
7471
|
+
type CancelRetainerResponse = CancelRetainerResponses[keyof CancelRetainerResponses];
|
|
7472
|
+
type ListMerchantReviewsData = {
|
|
7473
|
+
body?: never;
|
|
7474
|
+
path: {
|
|
7475
|
+
siteId: string;
|
|
7476
|
+
};
|
|
7477
|
+
query?: {
|
|
7478
|
+
product_id?: string;
|
|
7479
|
+
rating?: number;
|
|
7480
|
+
state?: "published" | "hidden" | "withdrawn";
|
|
7481
|
+
cursor?: string;
|
|
7482
|
+
limit?: number;
|
|
7483
|
+
};
|
|
7484
|
+
url: "/api/v1/sites/{siteId}/reviews";
|
|
7485
|
+
};
|
|
7486
|
+
type ListMerchantReviewsErrors = {
|
|
7487
|
+
/**
|
|
7488
|
+
* Invalid input
|
|
7489
|
+
*/
|
|
7490
|
+
400: {
|
|
7491
|
+
error: string;
|
|
7492
|
+
code?: string;
|
|
7493
|
+
review?: OwnProductReview & {
|
|
7494
|
+
customer_id: string;
|
|
7495
|
+
};
|
|
7496
|
+
};
|
|
7497
|
+
/**
|
|
7498
|
+
* Organization key required
|
|
7499
|
+
*/
|
|
7500
|
+
403: {
|
|
7501
|
+
error: string;
|
|
7502
|
+
code?: string;
|
|
7503
|
+
review?: OwnProductReview & {
|
|
7504
|
+
customer_id: string;
|
|
7505
|
+
};
|
|
7506
|
+
};
|
|
7507
|
+
/**
|
|
7508
|
+
* Resource not found
|
|
7509
|
+
*/
|
|
7510
|
+
404: {
|
|
7511
|
+
error: string;
|
|
7512
|
+
code?: string;
|
|
7513
|
+
review?: OwnProductReview & {
|
|
7514
|
+
customer_id: string;
|
|
7515
|
+
};
|
|
7516
|
+
};
|
|
7517
|
+
/**
|
|
7518
|
+
* Review changed; read the current revision
|
|
7519
|
+
*/
|
|
7520
|
+
409: {
|
|
7521
|
+
error: string;
|
|
7522
|
+
code?: string;
|
|
7523
|
+
review?: OwnProductReview & {
|
|
7524
|
+
customer_id: string;
|
|
7525
|
+
};
|
|
7526
|
+
};
|
|
7527
|
+
};
|
|
7528
|
+
type ListMerchantReviewsError = ListMerchantReviewsErrors[keyof ListMerchantReviewsErrors];
|
|
7529
|
+
type ListMerchantReviewsResponses = {
|
|
7530
|
+
/**
|
|
7531
|
+
* Success
|
|
7532
|
+
*/
|
|
7533
|
+
200: {
|
|
7534
|
+
reviews: Array<OwnProductReview & {
|
|
7535
|
+
customer_id: string;
|
|
7536
|
+
}>;
|
|
7537
|
+
pagination: {
|
|
7538
|
+
next_cursor: string | null;
|
|
7539
|
+
has_more: boolean;
|
|
7540
|
+
};
|
|
7541
|
+
};
|
|
7542
|
+
};
|
|
7543
|
+
type ListMerchantReviewsResponse = ListMerchantReviewsResponses[keyof ListMerchantReviewsResponses];
|
|
7544
|
+
type GetMerchantReviewData = {
|
|
7545
|
+
body?: never;
|
|
7546
|
+
path: {
|
|
7547
|
+
siteId: string;
|
|
7548
|
+
reviewId: string;
|
|
7549
|
+
};
|
|
7550
|
+
query?: never;
|
|
7551
|
+
url: "/api/v1/sites/{siteId}/reviews/{reviewId}";
|
|
7552
|
+
};
|
|
7553
|
+
type GetMerchantReviewErrors = {
|
|
7554
|
+
/**
|
|
7555
|
+
* Invalid input
|
|
7556
|
+
*/
|
|
7557
|
+
400: {
|
|
7558
|
+
error: string;
|
|
7559
|
+
code?: string;
|
|
7560
|
+
review?: OwnProductReview & {
|
|
7561
|
+
customer_id: string;
|
|
7562
|
+
};
|
|
7563
|
+
};
|
|
7564
|
+
/**
|
|
7565
|
+
* Organization key required
|
|
7566
|
+
*/
|
|
7567
|
+
403: {
|
|
7568
|
+
error: string;
|
|
7569
|
+
code?: string;
|
|
7570
|
+
review?: OwnProductReview & {
|
|
7571
|
+
customer_id: string;
|
|
7572
|
+
};
|
|
7573
|
+
};
|
|
7574
|
+
/**
|
|
7575
|
+
* Resource not found
|
|
7576
|
+
*/
|
|
7577
|
+
404: {
|
|
7578
|
+
error: string;
|
|
7579
|
+
code?: string;
|
|
7580
|
+
review?: OwnProductReview & {
|
|
7581
|
+
customer_id: string;
|
|
7582
|
+
};
|
|
7583
|
+
};
|
|
7584
|
+
/**
|
|
7585
|
+
* Review changed; read the current revision
|
|
7586
|
+
*/
|
|
7587
|
+
409: {
|
|
7588
|
+
error: string;
|
|
7589
|
+
code?: string;
|
|
7590
|
+
review?: OwnProductReview & {
|
|
7591
|
+
customer_id: string;
|
|
7592
|
+
};
|
|
7593
|
+
};
|
|
7594
|
+
};
|
|
7595
|
+
type GetMerchantReviewError = GetMerchantReviewErrors[keyof GetMerchantReviewErrors];
|
|
7596
|
+
type GetMerchantReviewResponses = {
|
|
7597
|
+
/**
|
|
7598
|
+
* Success
|
|
7599
|
+
*/
|
|
7600
|
+
200: {
|
|
7601
|
+
review: OwnProductReview & {
|
|
7602
|
+
customer_id: string;
|
|
7603
|
+
};
|
|
7604
|
+
events: Array<{
|
|
7605
|
+
id: string;
|
|
7606
|
+
actor_type: string;
|
|
7607
|
+
actor_id: string;
|
|
7608
|
+
action: string;
|
|
7609
|
+
reason: string | null;
|
|
7610
|
+
note: string | null;
|
|
7611
|
+
revision: number;
|
|
7612
|
+
created_at: string;
|
|
7613
|
+
}>;
|
|
7614
|
+
events_truncated: boolean;
|
|
7615
|
+
};
|
|
7616
|
+
};
|
|
7617
|
+
type GetMerchantReviewResponse = GetMerchantReviewResponses[keyof GetMerchantReviewResponses];
|
|
7618
|
+
type ModerateMerchantReviewData = {
|
|
7619
|
+
body: {
|
|
7620
|
+
revision: number;
|
|
7621
|
+
action: "hide" | "restore";
|
|
7622
|
+
reason: "spam" | "abuse" | "personal_information" | "off_topic" | "suspected_fraud";
|
|
7623
|
+
note?: string;
|
|
7624
|
+
};
|
|
7625
|
+
path: {
|
|
7626
|
+
siteId: string;
|
|
7627
|
+
reviewId: string;
|
|
7628
|
+
};
|
|
7629
|
+
query?: never;
|
|
7630
|
+
url: "/api/v1/sites/{siteId}/reviews/{reviewId}/moderate";
|
|
7631
|
+
};
|
|
7632
|
+
type ModerateMerchantReviewErrors = {
|
|
7633
|
+
/**
|
|
7634
|
+
* Invalid input
|
|
7635
|
+
*/
|
|
7636
|
+
400: {
|
|
7637
|
+
error: string;
|
|
7638
|
+
code?: string;
|
|
7639
|
+
review?: OwnProductReview & {
|
|
7640
|
+
customer_id: string;
|
|
7641
|
+
};
|
|
7642
|
+
};
|
|
7643
|
+
/**
|
|
7644
|
+
* Organization key required
|
|
7645
|
+
*/
|
|
7646
|
+
403: {
|
|
7647
|
+
error: string;
|
|
7648
|
+
code?: string;
|
|
7649
|
+
review?: OwnProductReview & {
|
|
7650
|
+
customer_id: string;
|
|
7651
|
+
};
|
|
7652
|
+
};
|
|
7653
|
+
/**
|
|
7654
|
+
* Resource not found
|
|
7655
|
+
*/
|
|
7656
|
+
404: {
|
|
7657
|
+
error: string;
|
|
7658
|
+
code?: string;
|
|
7659
|
+
review?: OwnProductReview & {
|
|
7660
|
+
customer_id: string;
|
|
7661
|
+
};
|
|
7662
|
+
};
|
|
7663
|
+
/**
|
|
7664
|
+
* Review changed; read the current revision
|
|
7665
|
+
*/
|
|
7666
|
+
409: {
|
|
7667
|
+
error: string;
|
|
7668
|
+
code?: string;
|
|
7669
|
+
review?: OwnProductReview & {
|
|
7670
|
+
customer_id: string;
|
|
7671
|
+
};
|
|
7672
|
+
};
|
|
7673
|
+
};
|
|
7674
|
+
type ModerateMerchantReviewError = ModerateMerchantReviewErrors[keyof ModerateMerchantReviewErrors];
|
|
7675
|
+
type ModerateMerchantReviewResponses = {
|
|
7676
|
+
/**
|
|
7677
|
+
* Success
|
|
7678
|
+
*/
|
|
7679
|
+
200: {
|
|
7680
|
+
review: OwnProductReview & {
|
|
7681
|
+
customer_id: string;
|
|
7682
|
+
};
|
|
7683
|
+
};
|
|
7684
|
+
};
|
|
7685
|
+
type ModerateMerchantReviewResponse = ModerateMerchantReviewResponses[keyof ModerateMerchantReviewResponses];
|
|
7686
|
+
type ReplyToMerchantReviewData = {
|
|
7687
|
+
body: {
|
|
7688
|
+
revision: number;
|
|
7689
|
+
body: string | null;
|
|
7690
|
+
};
|
|
7691
|
+
path: {
|
|
7692
|
+
siteId: string;
|
|
7693
|
+
reviewId: string;
|
|
7694
|
+
};
|
|
7695
|
+
query?: never;
|
|
7696
|
+
url: "/api/v1/sites/{siteId}/reviews/{reviewId}/reply";
|
|
7697
|
+
};
|
|
7698
|
+
type ReplyToMerchantReviewErrors = {
|
|
7699
|
+
/**
|
|
7700
|
+
* Invalid input
|
|
7701
|
+
*/
|
|
7702
|
+
400: {
|
|
7703
|
+
error: string;
|
|
7704
|
+
code?: string;
|
|
7705
|
+
review?: OwnProductReview & {
|
|
7706
|
+
customer_id: string;
|
|
7707
|
+
};
|
|
7708
|
+
};
|
|
7709
|
+
/**
|
|
7710
|
+
* Organization key required
|
|
7711
|
+
*/
|
|
7712
|
+
403: {
|
|
7713
|
+
error: string;
|
|
7714
|
+
code?: string;
|
|
7715
|
+
review?: OwnProductReview & {
|
|
7716
|
+
customer_id: string;
|
|
7717
|
+
};
|
|
7718
|
+
};
|
|
7719
|
+
/**
|
|
7720
|
+
* Resource not found
|
|
7721
|
+
*/
|
|
7722
|
+
404: {
|
|
7723
|
+
error: string;
|
|
7724
|
+
code?: string;
|
|
7725
|
+
review?: OwnProductReview & {
|
|
7726
|
+
customer_id: string;
|
|
7727
|
+
};
|
|
7728
|
+
};
|
|
7729
|
+
/**
|
|
7730
|
+
* Review changed; read the current revision
|
|
7731
|
+
*/
|
|
7732
|
+
409: {
|
|
7733
|
+
error: string;
|
|
7734
|
+
code?: string;
|
|
7735
|
+
review?: OwnProductReview & {
|
|
7736
|
+
customer_id: string;
|
|
7737
|
+
};
|
|
7738
|
+
};
|
|
7739
|
+
};
|
|
7740
|
+
type ReplyToMerchantReviewError = ReplyToMerchantReviewErrors[keyof ReplyToMerchantReviewErrors];
|
|
7741
|
+
type ReplyToMerchantReviewResponses = {
|
|
6851
7742
|
/**
|
|
6852
|
-
*
|
|
7743
|
+
* Success
|
|
6853
7744
|
*/
|
|
6854
|
-
200:
|
|
7745
|
+
200: {
|
|
7746
|
+
review: OwnProductReview & {
|
|
7747
|
+
customer_id: string;
|
|
7748
|
+
};
|
|
7749
|
+
};
|
|
6855
7750
|
};
|
|
6856
|
-
type
|
|
6857
|
-
type
|
|
7751
|
+
type ReplyToMerchantReviewResponse = ReplyToMerchantReviewResponses[keyof ReplyToMerchantReviewResponses];
|
|
7752
|
+
type GetReviewSettingsData = {
|
|
6858
7753
|
body?: never;
|
|
6859
7754
|
path: {
|
|
6860
7755
|
siteId: string;
|
|
6861
7756
|
};
|
|
6862
|
-
query?:
|
|
6863
|
-
|
|
6864
|
-
rating?: number;
|
|
6865
|
-
state?: "published" | "hidden" | "withdrawn";
|
|
6866
|
-
cursor?: string;
|
|
6867
|
-
limit?: number;
|
|
6868
|
-
};
|
|
6869
|
-
url: "/api/v1/sites/{siteId}/reviews";
|
|
7757
|
+
query?: never;
|
|
7758
|
+
url: "/api/v1/sites/{siteId}/review-settings";
|
|
6870
7759
|
};
|
|
6871
|
-
type
|
|
7760
|
+
type GetReviewSettingsErrors = {
|
|
6872
7761
|
/**
|
|
6873
7762
|
* Invalid input
|
|
6874
7763
|
*/
|
|
@@ -6910,32 +7799,33 @@ type ListMerchantReviewsErrors = {
|
|
|
6910
7799
|
};
|
|
6911
7800
|
};
|
|
6912
7801
|
};
|
|
6913
|
-
type
|
|
6914
|
-
type
|
|
7802
|
+
type GetReviewSettingsError = GetReviewSettingsErrors[keyof GetReviewSettingsErrors];
|
|
7803
|
+
type GetReviewSettingsResponses = {
|
|
6915
7804
|
/**
|
|
6916
7805
|
* Success
|
|
6917
7806
|
*/
|
|
6918
7807
|
200: {
|
|
6919
|
-
|
|
6920
|
-
|
|
6921
|
-
|
|
6922
|
-
|
|
6923
|
-
|
|
6924
|
-
|
|
6925
|
-
|
|
7808
|
+
site_id: string;
|
|
7809
|
+
reviews_enabled: boolean;
|
|
7810
|
+
collection_available: boolean;
|
|
7811
|
+
editing_available: boolean;
|
|
7812
|
+
reason: string | null;
|
|
7813
|
+
turnstile_site_key: string | null;
|
|
7814
|
+
account_origin: string | null;
|
|
6926
7815
|
};
|
|
6927
7816
|
};
|
|
6928
|
-
type
|
|
6929
|
-
type
|
|
6930
|
-
body
|
|
7817
|
+
type GetReviewSettingsResponse = GetReviewSettingsResponses[keyof GetReviewSettingsResponses];
|
|
7818
|
+
type UpdateReviewSettingsData = {
|
|
7819
|
+
body: {
|
|
7820
|
+
reviews_enabled: boolean;
|
|
7821
|
+
};
|
|
6931
7822
|
path: {
|
|
6932
7823
|
siteId: string;
|
|
6933
|
-
reviewId: string;
|
|
6934
7824
|
};
|
|
6935
7825
|
query?: never;
|
|
6936
|
-
url: "/api/v1/sites/{siteId}/
|
|
7826
|
+
url: "/api/v1/sites/{siteId}/review-settings";
|
|
6937
7827
|
};
|
|
6938
|
-
type
|
|
7828
|
+
type UpdateReviewSettingsErrors = {
|
|
6939
7829
|
/**
|
|
6940
7830
|
* Invalid input
|
|
6941
7831
|
*/
|
|
@@ -6977,44 +7867,32 @@ type GetMerchantReviewErrors = {
|
|
|
6977
7867
|
};
|
|
6978
7868
|
};
|
|
6979
7869
|
};
|
|
6980
|
-
type
|
|
6981
|
-
type
|
|
7870
|
+
type UpdateReviewSettingsError = UpdateReviewSettingsErrors[keyof UpdateReviewSettingsErrors];
|
|
7871
|
+
type UpdateReviewSettingsResponses = {
|
|
6982
7872
|
/**
|
|
6983
7873
|
* Success
|
|
6984
7874
|
*/
|
|
6985
7875
|
200: {
|
|
6986
|
-
|
|
6987
|
-
|
|
6988
|
-
|
|
6989
|
-
|
|
6990
|
-
|
|
6991
|
-
|
|
6992
|
-
|
|
6993
|
-
action: string;
|
|
6994
|
-
reason: string | null;
|
|
6995
|
-
note: string | null;
|
|
6996
|
-
revision: number;
|
|
6997
|
-
created_at: string;
|
|
6998
|
-
}>;
|
|
6999
|
-
events_truncated: boolean;
|
|
7876
|
+
site_id: string;
|
|
7877
|
+
reviews_enabled: boolean;
|
|
7878
|
+
collection_available: boolean;
|
|
7879
|
+
editing_available: boolean;
|
|
7880
|
+
reason: string | null;
|
|
7881
|
+
turnstile_site_key: string | null;
|
|
7882
|
+
account_origin: string | null;
|
|
7000
7883
|
};
|
|
7001
7884
|
};
|
|
7002
|
-
type
|
|
7003
|
-
type
|
|
7004
|
-
body
|
|
7005
|
-
revision: number;
|
|
7006
|
-
action: "hide" | "restore";
|
|
7007
|
-
reason: "spam" | "abuse" | "personal_information" | "off_topic" | "suspected_fraud";
|
|
7008
|
-
note?: string;
|
|
7009
|
-
};
|
|
7885
|
+
type UpdateReviewSettingsResponse = UpdateReviewSettingsResponses[keyof UpdateReviewSettingsResponses];
|
|
7886
|
+
type EraseCustomerReviewsData = {
|
|
7887
|
+
body?: never;
|
|
7010
7888
|
path: {
|
|
7011
7889
|
siteId: string;
|
|
7012
|
-
|
|
7890
|
+
customerId: string;
|
|
7013
7891
|
};
|
|
7014
7892
|
query?: never;
|
|
7015
|
-
url: "/api/v1/sites/{siteId}/
|
|
7893
|
+
url: "/api/v1/sites/{siteId}/customers/{customerId}/reviews";
|
|
7016
7894
|
};
|
|
7017
|
-
type
|
|
7895
|
+
type EraseCustomerReviewsErrors = {
|
|
7018
7896
|
/**
|
|
7019
7897
|
* Invalid input
|
|
7020
7898
|
*/
|
|
@@ -7056,31 +7934,25 @@ type ModerateMerchantReviewErrors = {
|
|
|
7056
7934
|
};
|
|
7057
7935
|
};
|
|
7058
7936
|
};
|
|
7059
|
-
type
|
|
7060
|
-
type
|
|
7937
|
+
type EraseCustomerReviewsError = EraseCustomerReviewsErrors[keyof EraseCustomerReviewsErrors];
|
|
7938
|
+
type EraseCustomerReviewsResponses = {
|
|
7061
7939
|
/**
|
|
7062
7940
|
* Success
|
|
7063
7941
|
*/
|
|
7064
7942
|
200: {
|
|
7065
|
-
|
|
7066
|
-
customer_id: string;
|
|
7067
|
-
};
|
|
7943
|
+
erased: number;
|
|
7068
7944
|
};
|
|
7069
7945
|
};
|
|
7070
|
-
type
|
|
7071
|
-
type
|
|
7072
|
-
body
|
|
7073
|
-
revision: number;
|
|
7074
|
-
body: string | null;
|
|
7075
|
-
};
|
|
7946
|
+
type EraseCustomerReviewsResponse = EraseCustomerReviewsResponses[keyof EraseCustomerReviewsResponses];
|
|
7947
|
+
type PurgeSiteReviewsData = {
|
|
7948
|
+
body?: never;
|
|
7076
7949
|
path: {
|
|
7077
7950
|
siteId: string;
|
|
7078
|
-
reviewId: string;
|
|
7079
7951
|
};
|
|
7080
7952
|
query?: never;
|
|
7081
|
-
url: "/api/v1/sites/{siteId}/reviews/
|
|
7953
|
+
url: "/api/v1/sites/{siteId}/reviews/purge";
|
|
7082
7954
|
};
|
|
7083
|
-
type
|
|
7955
|
+
type PurgeSiteReviewsErrors = {
|
|
7084
7956
|
/**
|
|
7085
7957
|
* Invalid input
|
|
7086
7958
|
*/
|
|
@@ -7122,274 +7994,422 @@ type ReplyToMerchantReviewErrors = {
|
|
|
7122
7994
|
};
|
|
7123
7995
|
};
|
|
7124
7996
|
};
|
|
7125
|
-
type
|
|
7126
|
-
type
|
|
7997
|
+
type PurgeSiteReviewsError = PurgeSiteReviewsErrors[keyof PurgeSiteReviewsErrors];
|
|
7998
|
+
type PurgeSiteReviewsResponses = {
|
|
7999
|
+
/**
|
|
8000
|
+
* Success
|
|
8001
|
+
*/
|
|
8002
|
+
200: {
|
|
8003
|
+
purged: number;
|
|
8004
|
+
reviews_enabled: false;
|
|
8005
|
+
};
|
|
8006
|
+
};
|
|
8007
|
+
type PurgeSiteReviewsResponse = PurgeSiteReviewsResponses[keyof PurgeSiteReviewsResponses];
|
|
8008
|
+
type ListPromosData = {
|
|
8009
|
+
body?: never;
|
|
8010
|
+
path?: never;
|
|
8011
|
+
query?: {
|
|
8012
|
+
limit?: number;
|
|
8013
|
+
cursor?: string;
|
|
8014
|
+
};
|
|
8015
|
+
url: "/api/v1/promos";
|
|
8016
|
+
};
|
|
8017
|
+
type ListPromosErrors = {
|
|
8018
|
+
/**
|
|
8019
|
+
* Invalid promotion rules
|
|
8020
|
+
*/
|
|
8021
|
+
400: PromoError;
|
|
8022
|
+
/**
|
|
8023
|
+
* Authentication required
|
|
8024
|
+
*/
|
|
8025
|
+
401: PromoError | {
|
|
8026
|
+
error: string;
|
|
8027
|
+
};
|
|
8028
|
+
/**
|
|
8029
|
+
* Site or owned promotion not found
|
|
8030
|
+
*/
|
|
8031
|
+
404: PromoError;
|
|
8032
|
+
/**
|
|
8033
|
+
* Conflicting request or promotion state
|
|
8034
|
+
*/
|
|
8035
|
+
409: PromoError;
|
|
8036
|
+
/**
|
|
8037
|
+
* Unknown Stripe result; retry the same request
|
|
8038
|
+
*/
|
|
8039
|
+
503: PromoError;
|
|
8040
|
+
};
|
|
8041
|
+
type ListPromosError = ListPromosErrors[keyof ListPromosErrors];
|
|
8042
|
+
type ListPromosResponses = {
|
|
8043
|
+
/**
|
|
8044
|
+
* Owned promotions
|
|
8045
|
+
*/
|
|
8046
|
+
200: PromosList;
|
|
8047
|
+
};
|
|
8048
|
+
type ListPromosResponse = ListPromosResponses[keyof ListPromosResponses];
|
|
8049
|
+
type CreatePromoData = {
|
|
8050
|
+
body: CreatePromo;
|
|
8051
|
+
path?: never;
|
|
8052
|
+
query?: never;
|
|
8053
|
+
url: "/api/v1/promos";
|
|
8054
|
+
};
|
|
8055
|
+
type CreatePromoErrors = {
|
|
8056
|
+
/**
|
|
8057
|
+
* Invalid promotion rules
|
|
8058
|
+
*/
|
|
8059
|
+
400: PromoError;
|
|
8060
|
+
/**
|
|
8061
|
+
* Authentication required
|
|
8062
|
+
*/
|
|
8063
|
+
401: PromoError | {
|
|
8064
|
+
error: string;
|
|
8065
|
+
};
|
|
8066
|
+
/**
|
|
8067
|
+
* Site or owned promotion not found
|
|
8068
|
+
*/
|
|
8069
|
+
404: PromoError;
|
|
8070
|
+
/**
|
|
8071
|
+
* Conflicting request or promotion state
|
|
8072
|
+
*/
|
|
8073
|
+
409: PromoError;
|
|
8074
|
+
/**
|
|
8075
|
+
* Unknown Stripe result; retry the same request
|
|
8076
|
+
*/
|
|
8077
|
+
503: PromoError;
|
|
8078
|
+
};
|
|
8079
|
+
type CreatePromoError = CreatePromoErrors[keyof CreatePromoErrors];
|
|
8080
|
+
type CreatePromoResponses = {
|
|
8081
|
+
/**
|
|
8082
|
+
* Created or previously completed promotion
|
|
8083
|
+
*/
|
|
8084
|
+
200: Promo;
|
|
8085
|
+
};
|
|
8086
|
+
type CreatePromoResponse = CreatePromoResponses[keyof CreatePromoResponses];
|
|
8087
|
+
type GetPromoData = {
|
|
8088
|
+
body?: never;
|
|
8089
|
+
path: {
|
|
8090
|
+
promoId: string;
|
|
8091
|
+
};
|
|
8092
|
+
query?: never;
|
|
8093
|
+
url: "/api/v1/promos/{promoId}";
|
|
8094
|
+
};
|
|
8095
|
+
type GetPromoErrors = {
|
|
8096
|
+
/**
|
|
8097
|
+
* Invalid promotion rules
|
|
8098
|
+
*/
|
|
8099
|
+
400: PromoError;
|
|
8100
|
+
/**
|
|
8101
|
+
* Authentication required
|
|
8102
|
+
*/
|
|
8103
|
+
401: PromoError | {
|
|
8104
|
+
error: string;
|
|
8105
|
+
};
|
|
8106
|
+
/**
|
|
8107
|
+
* Site or owned promotion not found
|
|
8108
|
+
*/
|
|
8109
|
+
404: PromoError;
|
|
8110
|
+
/**
|
|
8111
|
+
* Conflicting request or promotion state
|
|
8112
|
+
*/
|
|
8113
|
+
409: PromoError;
|
|
8114
|
+
/**
|
|
8115
|
+
* Unknown Stripe result; retry the same request
|
|
8116
|
+
*/
|
|
8117
|
+
503: PromoError;
|
|
8118
|
+
};
|
|
8119
|
+
type GetPromoError = GetPromoErrors[keyof GetPromoErrors];
|
|
8120
|
+
type GetPromoResponses = {
|
|
8121
|
+
/**
|
|
8122
|
+
* Owned promotion
|
|
8123
|
+
*/
|
|
8124
|
+
200: Promo;
|
|
8125
|
+
};
|
|
8126
|
+
type GetPromoResponse = GetPromoResponses[keyof GetPromoResponses];
|
|
8127
|
+
type DisablePromoData = {
|
|
8128
|
+
body?: never;
|
|
8129
|
+
path: {
|
|
8130
|
+
promoId: string;
|
|
8131
|
+
};
|
|
8132
|
+
query?: never;
|
|
8133
|
+
url: "/api/v1/promos/{promoId}/disable";
|
|
8134
|
+
};
|
|
8135
|
+
type DisablePromoErrors = {
|
|
8136
|
+
/**
|
|
8137
|
+
* Invalid promotion rules
|
|
8138
|
+
*/
|
|
8139
|
+
400: PromoError;
|
|
8140
|
+
/**
|
|
8141
|
+
* Authentication required
|
|
8142
|
+
*/
|
|
8143
|
+
401: PromoError | {
|
|
8144
|
+
error: string;
|
|
8145
|
+
};
|
|
8146
|
+
/**
|
|
8147
|
+
* Site or owned promotion not found
|
|
8148
|
+
*/
|
|
8149
|
+
404: PromoError;
|
|
8150
|
+
/**
|
|
8151
|
+
* Conflicting request or promotion state
|
|
8152
|
+
*/
|
|
8153
|
+
409: PromoError;
|
|
8154
|
+
/**
|
|
8155
|
+
* Unknown Stripe result; retry the same request
|
|
8156
|
+
*/
|
|
8157
|
+
503: PromoError;
|
|
8158
|
+
};
|
|
8159
|
+
type DisablePromoError = DisablePromoErrors[keyof DisablePromoErrors];
|
|
8160
|
+
type DisablePromoResponses = {
|
|
8161
|
+
/**
|
|
8162
|
+
* Disabled promotion
|
|
8163
|
+
*/
|
|
8164
|
+
200: Promo;
|
|
8165
|
+
};
|
|
8166
|
+
type DisablePromoResponse = DisablePromoResponses[keyof DisablePromoResponses];
|
|
8167
|
+
type ReplacePromoData = {
|
|
8168
|
+
body: CreatePromo;
|
|
8169
|
+
path: {
|
|
8170
|
+
promoId: string;
|
|
8171
|
+
};
|
|
8172
|
+
query?: never;
|
|
8173
|
+
url: "/api/v1/promos/{promoId}/replace";
|
|
8174
|
+
};
|
|
8175
|
+
type ReplacePromoErrors = {
|
|
8176
|
+
/**
|
|
8177
|
+
* Invalid promotion rules
|
|
8178
|
+
*/
|
|
8179
|
+
400: PromoError;
|
|
8180
|
+
/**
|
|
8181
|
+
* Authentication required
|
|
8182
|
+
*/
|
|
8183
|
+
401: PromoError | {
|
|
8184
|
+
error: string;
|
|
8185
|
+
};
|
|
8186
|
+
/**
|
|
8187
|
+
* Site or owned promotion not found
|
|
8188
|
+
*/
|
|
8189
|
+
404: PromoError;
|
|
8190
|
+
/**
|
|
8191
|
+
* Conflicting request or promotion state
|
|
8192
|
+
*/
|
|
8193
|
+
409: PromoError;
|
|
8194
|
+
/**
|
|
8195
|
+
* Unknown Stripe result; retry the same request
|
|
8196
|
+
*/
|
|
8197
|
+
503: PromoError;
|
|
8198
|
+
};
|
|
8199
|
+
type ReplacePromoError = ReplacePromoErrors[keyof ReplacePromoErrors];
|
|
8200
|
+
type ReplacePromoResponses = {
|
|
8201
|
+
/**
|
|
8202
|
+
* Replacement created and predecessor disabled
|
|
8203
|
+
*/
|
|
8204
|
+
200: Promo;
|
|
8205
|
+
};
|
|
8206
|
+
type ReplacePromoResponse = ReplacePromoResponses[keyof ReplacePromoResponses];
|
|
8207
|
+
type ListPromosForSiteData = {
|
|
8208
|
+
body?: never;
|
|
8209
|
+
path: {
|
|
8210
|
+
siteId: string;
|
|
8211
|
+
};
|
|
8212
|
+
query?: {
|
|
8213
|
+
limit?: number;
|
|
8214
|
+
cursor?: string;
|
|
8215
|
+
};
|
|
8216
|
+
url: "/api/v1/sites/{siteId}/promos";
|
|
8217
|
+
};
|
|
8218
|
+
type ListPromosForSiteErrors = {
|
|
8219
|
+
/**
|
|
8220
|
+
* Invalid promotion rules
|
|
8221
|
+
*/
|
|
8222
|
+
400: PromoError;
|
|
8223
|
+
/**
|
|
8224
|
+
* Authentication required
|
|
8225
|
+
*/
|
|
8226
|
+
401: PromoError | {
|
|
8227
|
+
error: string;
|
|
8228
|
+
};
|
|
8229
|
+
/**
|
|
8230
|
+
* Site or owned promotion not found
|
|
8231
|
+
*/
|
|
8232
|
+
404: PromoError;
|
|
8233
|
+
/**
|
|
8234
|
+
* Conflicting request or promotion state
|
|
8235
|
+
*/
|
|
8236
|
+
409: PromoError;
|
|
8237
|
+
/**
|
|
8238
|
+
* Unknown Stripe result; retry the same request
|
|
8239
|
+
*/
|
|
8240
|
+
503: PromoError;
|
|
8241
|
+
};
|
|
8242
|
+
type ListPromosForSiteError = ListPromosForSiteErrors[keyof ListPromosForSiteErrors];
|
|
8243
|
+
type ListPromosForSiteResponses = {
|
|
7127
8244
|
/**
|
|
7128
|
-
*
|
|
8245
|
+
* Owned promotions
|
|
7129
8246
|
*/
|
|
7130
|
-
200:
|
|
7131
|
-
review: OwnProductReview & {
|
|
7132
|
-
customer_id: string;
|
|
7133
|
-
};
|
|
7134
|
-
};
|
|
8247
|
+
200: PromosList;
|
|
7135
8248
|
};
|
|
7136
|
-
type
|
|
7137
|
-
type
|
|
7138
|
-
body
|
|
8249
|
+
type ListPromosForSiteResponse = ListPromosForSiteResponses[keyof ListPromosForSiteResponses];
|
|
8250
|
+
type CreatePromoForSiteData = {
|
|
8251
|
+
body: CreatePromo;
|
|
7139
8252
|
path: {
|
|
7140
8253
|
siteId: string;
|
|
7141
8254
|
};
|
|
7142
8255
|
query?: never;
|
|
7143
|
-
url: "/api/v1/sites/{siteId}/
|
|
8256
|
+
url: "/api/v1/sites/{siteId}/promos";
|
|
7144
8257
|
};
|
|
7145
|
-
type
|
|
8258
|
+
type CreatePromoForSiteErrors = {
|
|
7146
8259
|
/**
|
|
7147
|
-
* Invalid
|
|
8260
|
+
* Invalid promotion rules
|
|
7148
8261
|
*/
|
|
7149
|
-
400:
|
|
7150
|
-
error: string;
|
|
7151
|
-
code?: string;
|
|
7152
|
-
review?: OwnProductReview & {
|
|
7153
|
-
customer_id: string;
|
|
7154
|
-
};
|
|
7155
|
-
};
|
|
8262
|
+
400: PromoError;
|
|
7156
8263
|
/**
|
|
7157
|
-
*
|
|
8264
|
+
* Authentication required
|
|
7158
8265
|
*/
|
|
7159
|
-
|
|
8266
|
+
401: PromoError | {
|
|
7160
8267
|
error: string;
|
|
7161
|
-
code?: string;
|
|
7162
|
-
review?: OwnProductReview & {
|
|
7163
|
-
customer_id: string;
|
|
7164
|
-
};
|
|
7165
8268
|
};
|
|
7166
8269
|
/**
|
|
7167
|
-
*
|
|
8270
|
+
* Site or owned promotion not found
|
|
7168
8271
|
*/
|
|
7169
|
-
404:
|
|
7170
|
-
error: string;
|
|
7171
|
-
code?: string;
|
|
7172
|
-
review?: OwnProductReview & {
|
|
7173
|
-
customer_id: string;
|
|
7174
|
-
};
|
|
7175
|
-
};
|
|
8272
|
+
404: PromoError;
|
|
7176
8273
|
/**
|
|
7177
|
-
*
|
|
8274
|
+
* Conflicting request or promotion state
|
|
7178
8275
|
*/
|
|
7179
|
-
409:
|
|
7180
|
-
|
|
7181
|
-
|
|
7182
|
-
|
|
7183
|
-
|
|
7184
|
-
};
|
|
7185
|
-
};
|
|
8276
|
+
409: PromoError;
|
|
8277
|
+
/**
|
|
8278
|
+
* Unknown Stripe result; retry the same request
|
|
8279
|
+
*/
|
|
8280
|
+
503: PromoError;
|
|
7186
8281
|
};
|
|
7187
|
-
type
|
|
7188
|
-
type
|
|
8282
|
+
type CreatePromoForSiteError = CreatePromoForSiteErrors[keyof CreatePromoForSiteErrors];
|
|
8283
|
+
type CreatePromoForSiteResponses = {
|
|
7189
8284
|
/**
|
|
7190
|
-
*
|
|
8285
|
+
* Created or previously completed promotion
|
|
7191
8286
|
*/
|
|
7192
|
-
200:
|
|
7193
|
-
site_id: string;
|
|
7194
|
-
reviews_enabled: boolean;
|
|
7195
|
-
collection_available: boolean;
|
|
7196
|
-
editing_available: boolean;
|
|
7197
|
-
reason: string | null;
|
|
7198
|
-
turnstile_site_key: string | null;
|
|
7199
|
-
account_origin: string | null;
|
|
7200
|
-
};
|
|
8287
|
+
200: Promo;
|
|
7201
8288
|
};
|
|
7202
|
-
type
|
|
7203
|
-
type
|
|
7204
|
-
body
|
|
7205
|
-
reviews_enabled: boolean;
|
|
7206
|
-
};
|
|
8289
|
+
type CreatePromoForSiteResponse = CreatePromoForSiteResponses[keyof CreatePromoForSiteResponses];
|
|
8290
|
+
type GetPromoForSiteData = {
|
|
8291
|
+
body?: never;
|
|
7207
8292
|
path: {
|
|
7208
8293
|
siteId: string;
|
|
8294
|
+
promoId: string;
|
|
7209
8295
|
};
|
|
7210
8296
|
query?: never;
|
|
7211
|
-
url: "/api/v1/sites/{siteId}/
|
|
8297
|
+
url: "/api/v1/sites/{siteId}/promos/{promoId}";
|
|
7212
8298
|
};
|
|
7213
|
-
type
|
|
8299
|
+
type GetPromoForSiteErrors = {
|
|
7214
8300
|
/**
|
|
7215
|
-
* Invalid
|
|
8301
|
+
* Invalid promotion rules
|
|
7216
8302
|
*/
|
|
7217
|
-
400:
|
|
7218
|
-
error: string;
|
|
7219
|
-
code?: string;
|
|
7220
|
-
review?: OwnProductReview & {
|
|
7221
|
-
customer_id: string;
|
|
7222
|
-
};
|
|
7223
|
-
};
|
|
8303
|
+
400: PromoError;
|
|
7224
8304
|
/**
|
|
7225
|
-
*
|
|
8305
|
+
* Authentication required
|
|
7226
8306
|
*/
|
|
7227
|
-
|
|
8307
|
+
401: PromoError | {
|
|
7228
8308
|
error: string;
|
|
7229
|
-
code?: string;
|
|
7230
|
-
review?: OwnProductReview & {
|
|
7231
|
-
customer_id: string;
|
|
7232
|
-
};
|
|
7233
8309
|
};
|
|
7234
8310
|
/**
|
|
7235
|
-
*
|
|
8311
|
+
* Site or owned promotion not found
|
|
7236
8312
|
*/
|
|
7237
|
-
404:
|
|
7238
|
-
error: string;
|
|
7239
|
-
code?: string;
|
|
7240
|
-
review?: OwnProductReview & {
|
|
7241
|
-
customer_id: string;
|
|
7242
|
-
};
|
|
7243
|
-
};
|
|
8313
|
+
404: PromoError;
|
|
7244
8314
|
/**
|
|
7245
|
-
*
|
|
8315
|
+
* Conflicting request or promotion state
|
|
7246
8316
|
*/
|
|
7247
|
-
409:
|
|
7248
|
-
|
|
7249
|
-
|
|
7250
|
-
|
|
7251
|
-
|
|
7252
|
-
};
|
|
7253
|
-
};
|
|
8317
|
+
409: PromoError;
|
|
8318
|
+
/**
|
|
8319
|
+
* Unknown Stripe result; retry the same request
|
|
8320
|
+
*/
|
|
8321
|
+
503: PromoError;
|
|
7254
8322
|
};
|
|
7255
|
-
type
|
|
7256
|
-
type
|
|
8323
|
+
type GetPromoForSiteError = GetPromoForSiteErrors[keyof GetPromoForSiteErrors];
|
|
8324
|
+
type GetPromoForSiteResponses = {
|
|
7257
8325
|
/**
|
|
7258
|
-
*
|
|
8326
|
+
* Owned promotion
|
|
7259
8327
|
*/
|
|
7260
|
-
200:
|
|
7261
|
-
site_id: string;
|
|
7262
|
-
reviews_enabled: boolean;
|
|
7263
|
-
collection_available: boolean;
|
|
7264
|
-
editing_available: boolean;
|
|
7265
|
-
reason: string | null;
|
|
7266
|
-
turnstile_site_key: string | null;
|
|
7267
|
-
account_origin: string | null;
|
|
7268
|
-
};
|
|
8328
|
+
200: Promo;
|
|
7269
8329
|
};
|
|
7270
|
-
type
|
|
7271
|
-
type
|
|
8330
|
+
type GetPromoForSiteResponse = GetPromoForSiteResponses[keyof GetPromoForSiteResponses];
|
|
8331
|
+
type DisablePromoForSiteData = {
|
|
7272
8332
|
body?: never;
|
|
7273
8333
|
path: {
|
|
7274
8334
|
siteId: string;
|
|
7275
|
-
|
|
8335
|
+
promoId: string;
|
|
7276
8336
|
};
|
|
7277
8337
|
query?: never;
|
|
7278
|
-
url: "/api/v1/sites/{siteId}/
|
|
8338
|
+
url: "/api/v1/sites/{siteId}/promos/{promoId}/disable";
|
|
7279
8339
|
};
|
|
7280
|
-
type
|
|
8340
|
+
type DisablePromoForSiteErrors = {
|
|
7281
8341
|
/**
|
|
7282
|
-
* Invalid
|
|
8342
|
+
* Invalid promotion rules
|
|
7283
8343
|
*/
|
|
7284
|
-
400:
|
|
7285
|
-
error: string;
|
|
7286
|
-
code?: string;
|
|
7287
|
-
review?: OwnProductReview & {
|
|
7288
|
-
customer_id: string;
|
|
7289
|
-
};
|
|
7290
|
-
};
|
|
8344
|
+
400: PromoError;
|
|
7291
8345
|
/**
|
|
7292
|
-
*
|
|
8346
|
+
* Authentication required
|
|
7293
8347
|
*/
|
|
7294
|
-
|
|
8348
|
+
401: PromoError | {
|
|
7295
8349
|
error: string;
|
|
7296
|
-
code?: string;
|
|
7297
|
-
review?: OwnProductReview & {
|
|
7298
|
-
customer_id: string;
|
|
7299
|
-
};
|
|
7300
8350
|
};
|
|
7301
8351
|
/**
|
|
7302
|
-
*
|
|
8352
|
+
* Site or owned promotion not found
|
|
7303
8353
|
*/
|
|
7304
|
-
404:
|
|
7305
|
-
error: string;
|
|
7306
|
-
code?: string;
|
|
7307
|
-
review?: OwnProductReview & {
|
|
7308
|
-
customer_id: string;
|
|
7309
|
-
};
|
|
7310
|
-
};
|
|
8354
|
+
404: PromoError;
|
|
7311
8355
|
/**
|
|
7312
|
-
*
|
|
8356
|
+
* Conflicting request or promotion state
|
|
7313
8357
|
*/
|
|
7314
|
-
409:
|
|
7315
|
-
|
|
7316
|
-
|
|
7317
|
-
|
|
7318
|
-
|
|
7319
|
-
};
|
|
7320
|
-
};
|
|
8358
|
+
409: PromoError;
|
|
8359
|
+
/**
|
|
8360
|
+
* Unknown Stripe result; retry the same request
|
|
8361
|
+
*/
|
|
8362
|
+
503: PromoError;
|
|
7321
8363
|
};
|
|
7322
|
-
type
|
|
7323
|
-
type
|
|
8364
|
+
type DisablePromoForSiteError = DisablePromoForSiteErrors[keyof DisablePromoForSiteErrors];
|
|
8365
|
+
type DisablePromoForSiteResponses = {
|
|
7324
8366
|
/**
|
|
7325
|
-
*
|
|
8367
|
+
* Disabled promotion
|
|
7326
8368
|
*/
|
|
7327
|
-
200:
|
|
7328
|
-
erased: number;
|
|
7329
|
-
};
|
|
8369
|
+
200: Promo;
|
|
7330
8370
|
};
|
|
7331
|
-
type
|
|
7332
|
-
type
|
|
7333
|
-
body
|
|
8371
|
+
type DisablePromoForSiteResponse = DisablePromoForSiteResponses[keyof DisablePromoForSiteResponses];
|
|
8372
|
+
type ReplacePromoForSiteData = {
|
|
8373
|
+
body: CreatePromo;
|
|
7334
8374
|
path: {
|
|
7335
8375
|
siteId: string;
|
|
8376
|
+
promoId: string;
|
|
7336
8377
|
};
|
|
7337
8378
|
query?: never;
|
|
7338
|
-
url: "/api/v1/sites/{siteId}/
|
|
8379
|
+
url: "/api/v1/sites/{siteId}/promos/{promoId}/replace";
|
|
7339
8380
|
};
|
|
7340
|
-
type
|
|
8381
|
+
type ReplacePromoForSiteErrors = {
|
|
7341
8382
|
/**
|
|
7342
|
-
* Invalid
|
|
8383
|
+
* Invalid promotion rules
|
|
7343
8384
|
*/
|
|
7344
|
-
400:
|
|
7345
|
-
error: string;
|
|
7346
|
-
code?: string;
|
|
7347
|
-
review?: OwnProductReview & {
|
|
7348
|
-
customer_id: string;
|
|
7349
|
-
};
|
|
7350
|
-
};
|
|
8385
|
+
400: PromoError;
|
|
7351
8386
|
/**
|
|
7352
|
-
*
|
|
8387
|
+
* Authentication required
|
|
7353
8388
|
*/
|
|
7354
|
-
|
|
8389
|
+
401: PromoError | {
|
|
7355
8390
|
error: string;
|
|
7356
|
-
code?: string;
|
|
7357
|
-
review?: OwnProductReview & {
|
|
7358
|
-
customer_id: string;
|
|
7359
|
-
};
|
|
7360
8391
|
};
|
|
7361
8392
|
/**
|
|
7362
|
-
*
|
|
8393
|
+
* Site or owned promotion not found
|
|
7363
8394
|
*/
|
|
7364
|
-
404:
|
|
7365
|
-
error: string;
|
|
7366
|
-
code?: string;
|
|
7367
|
-
review?: OwnProductReview & {
|
|
7368
|
-
customer_id: string;
|
|
7369
|
-
};
|
|
7370
|
-
};
|
|
8395
|
+
404: PromoError;
|
|
7371
8396
|
/**
|
|
7372
|
-
*
|
|
8397
|
+
* Conflicting request or promotion state
|
|
7373
8398
|
*/
|
|
7374
|
-
409:
|
|
7375
|
-
|
|
7376
|
-
|
|
7377
|
-
|
|
7378
|
-
|
|
7379
|
-
};
|
|
7380
|
-
};
|
|
8399
|
+
409: PromoError;
|
|
8400
|
+
/**
|
|
8401
|
+
* Unknown Stripe result; retry the same request
|
|
8402
|
+
*/
|
|
8403
|
+
503: PromoError;
|
|
7381
8404
|
};
|
|
7382
|
-
type
|
|
7383
|
-
type
|
|
8405
|
+
type ReplacePromoForSiteError = ReplacePromoForSiteErrors[keyof ReplacePromoForSiteErrors];
|
|
8406
|
+
type ReplacePromoForSiteResponses = {
|
|
7384
8407
|
/**
|
|
7385
|
-
*
|
|
8408
|
+
* Replacement created and predecessor disabled
|
|
7386
8409
|
*/
|
|
7387
|
-
200:
|
|
7388
|
-
purged: number;
|
|
7389
|
-
reviews_enabled: false;
|
|
7390
|
-
};
|
|
8410
|
+
200: Promo;
|
|
7391
8411
|
};
|
|
7392
|
-
type
|
|
8412
|
+
type ReplacePromoForSiteResponse = ReplacePromoForSiteResponses[keyof ReplacePromoForSiteResponses];
|
|
7393
8413
|
type GetConsentConfigWithSiteTokenData = {
|
|
7394
8414
|
body?: never;
|
|
7395
8415
|
path?: never;
|
|
@@ -7584,6 +8604,10 @@ type DeleteSiteErrors = {
|
|
|
7584
8604
|
* Site not found. `code` distinguishes `site_not_found` (no such site — an idempotent re-delete of an already-purged site is complete) from `site_not_accessible` (the site exists under another organization — a wrong or rotated key; retry with the right one). Safe to disclose here because this route is org-key-only.
|
|
7585
8605
|
*/
|
|
7586
8606
|
404: Error;
|
|
8607
|
+
/**
|
|
8608
|
+
* Promotion cleanup could not complete; retry deletion. The live site remains accessible until its remote promotions are disabled.
|
|
8609
|
+
*/
|
|
8610
|
+
503: Error;
|
|
7587
8611
|
};
|
|
7588
8612
|
type DeleteSiteError = DeleteSiteErrors[keyof DeleteSiteErrors];
|
|
7589
8613
|
type DeleteSiteResponses = {
|
|
@@ -10120,6 +11144,66 @@ declare const getAnalyticsOperatingSystems: <ThrowOnError extends boolean = fals
|
|
|
10120
11144
|
* First-touch acquisition folded into Plausible's 19 channels. Carries VISITS, not visitors: visitor counts are computed per acquisition tuple, so they do not sum across the tuples that fold into one channel — ordinary referrer-host and UTM variance would inflate the biggest channels. Visits are additive and exact.
|
|
10121
11145
|
*/
|
|
10122
11146
|
declare const getAnalyticsChannels: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsChannelsData, ThrowOnError>) => RequestResult<GetAnalyticsChannelsResponses, GetAnalyticsChannelsErrors, ThrowOnError, "fields">;
|
|
11147
|
+
/**
|
|
11148
|
+
* Conversions per goal for the period
|
|
11149
|
+
*
|
|
11150
|
+
* Unique and total conversions for every goal this site has, plus the rate each converted at. Goals are DEFINITIONS matched as the query runs, never stored on the events, so editing or deleting one changes all of its past numbers — there is no backfill and no window in which a goal exists but its numbers do not. MATCHING IS RETROACTIVE; THE DATA IS NOT ALWAYS. A goal reports over every event already recorded, which for most goals is the site's entire history — but `Purchase` and `Form: Received` are events we WRITE rather than collect, so they exist only from the deploy that started writing them. Read `counts_from` on each row: null means the whole history, a date means from there. Do not infer completeness from `implicit`. Every collecting site has rows here without configuring anything: form submissions, outbound clicks, file downloads and Contact (phone and email taps under one name), plus `Form: Received` for server-confirmed form deliveries and `Purchase` for sales through our checkout. `Form: Received` is a DIFFERENT MEASUREMENT from `Form: Submission`, not a later stage of it — deliveries can exceed attempts, so never subtract one from the other. A goal that matched nothing is present and reads zero; a goal that is absent does not exist. `conversion_rate` divides by SITE-WIDE unique visitors for the window, not by anything about the goal, so the rates do not sum to 100% — state what the rate is a ratio of wherever you show one. Use `from`/`to` in place of `period` for an explicit range.
|
|
11151
|
+
*/
|
|
11152
|
+
declare const getAnalyticsConversions: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsConversionsData, ThrowOnError>) => RequestResult<GetAnalyticsConversionsResponses, GetAnalyticsConversionsErrors, ThrowOnError, "fields">;
|
|
11153
|
+
/**
|
|
11154
|
+
* Visitors reaching each step of a funnel
|
|
11155
|
+
*
|
|
11156
|
+
* Cumulative visitors per step with drop-off. READ `window`, NOT THE PERIOD YOU ASKED FOR: a funnel whose steps include `Purchase` or `Form: Received` cannot report on days before those events were being written, so the window is moved forward to the first day EVERY step could have fired. When that happens `requested_window` holds what you asked for and `coverage_from` says which date set the floor; both are null when nothing was shortened. The window had to move rather than carry a caveat, because drop-off is a comparison BETWEEN steps — a window reaching back past one step's instrumentation would count entrants at step one from days the later step could not fire and report the difference as people dropping out. Label a result with `window`, and if `requested_window` is set, say the period was shortened. A window with no covered days at all is refused by name rather than answered. BOUNDED TO A VISITOR-DAY, which bounds each SEQUENCE and not the report: the numbers cover the whole window, but one visitor's run through the steps must finish within 24 hours AND within one visitor identity, which rotates daily. So a 90-day report counts completions from all 90 days, and a visitor who starts the path before midnight and finishes after it is not one of them — say that wherever you show a funnel. `never_entered` counts visitors in the window who matched no step, which is what makes the first step's rate meaningful. `conversion_rate` on each step divides by STEP ONE's visitors, not by site-wide visitors: a funnel's rate is about the path, unlike a conversion rate. Steps are definitions matched at read time, so reordering a funnel changes every past number.
|
|
11157
|
+
*/
|
|
11158
|
+
declare const getAnalyticsFunnelReport: <ThrowOnError extends boolean = false>(options: Options<GetAnalyticsFunnelReportData, ThrowOnError>) => RequestResult<GetAnalyticsFunnelReportResponses, GetAnalyticsFunnelReportErrors, ThrowOnError, "fields">;
|
|
11159
|
+
/**
|
|
11160
|
+
* Goals defined for a site, plus the built-ins (site token, or org key with site_id)
|
|
11161
|
+
*
|
|
11162
|
+
* Every goal this site reports on. A goal is a definition matched at query time, never stored on the events, so creating, renaming or deleting one changes every historical report immediately with no backfill. Three kinds: `pageview` (a path with `*` wildcards), `scroll` (a path plus a depth threshold from 1 to 100), and `event` (one of the collected event types). A pageview goal matches only pageview rows and a scroll goal only the engagement rows that carry scroll depth, so its counts never absorb another goal's conversions. The built-in goals (Form: Submission, Outbound Link: Click, File Download, Contact) are always present, are not rows, and cannot be renamed or deleted; `Contact` reports phone and email taps together. Two more provision themselves from events we write rather than collect: `Form: Received` counts form DELIVERIES confirmed by our server, which is a different measurement from the tracker's `Form: Submission` attempts and must never be subtracted from it; `Purchase` counts sales through our checkout. Both are present on every site whether or not it has recorded one — a zero is a real answer, and tying a goal's existence to a mutable payment setting would have made past sales disappear from analytics the moment payments were suspended. Both carry a `counts_from` date in the report because, unlike every other goal, they only exist from the deploy that started writing them. An `event` goal may only name a collected type (Form: Submission, Outbound Link: Click, File Download, Phone Link: Click, Email Link: Click) — any other name would be dropped by the collection endpoint and report zero forever.
|
|
11163
|
+
*/
|
|
11164
|
+
declare const listAnalyticsGoals: <ThrowOnError extends boolean = false>(options?: Options<ListAnalyticsGoalsData, ThrowOnError>) => RequestResult<ListAnalyticsGoalsResponses, ListAnalyticsGoalsErrors, ThrowOnError, "fields">;
|
|
11165
|
+
/**
|
|
11166
|
+
* Define a goal (site token, or org key with site_id)
|
|
11167
|
+
*
|
|
11168
|
+
* A goal is a definition matched at query time, never stored on the events, so creating, renaming or deleting one changes every historical report immediately with no backfill. Three kinds: `pageview` (a path with `*` wildcards), `scroll` (a path plus a depth threshold from 1 to 100), and `event` (one of the collected event types). A pageview goal matches only pageview rows and a scroll goal only the engagement rows that carry scroll depth, so its counts never absorb another goal's conversions. The built-in goals (Form: Submission, Outbound Link: Click, File Download, Contact) are always present, are not rows, and cannot be renamed or deleted; `Contact` reports phone and email taps together. Two more provision themselves from events we write rather than collect: `Form: Received` counts form DELIVERIES confirmed by our server, which is a different measurement from the tracker's `Form: Submission` attempts and must never be subtracted from it; `Purchase` counts sales through our checkout. Both are present on every site whether or not it has recorded one — a zero is a real answer, and tying a goal's existence to a mutable payment setting would have made past sales disappear from analytics the moment payments were suspended. Both carry a `counts_from` date in the report because, unlike every other goal, they only exist from the deploy that started writing them. An `event` goal may only name a collected type (Form: Submission, Outbound Link: Click, File Download, Phone Link: Click, Email Link: Click) — any other name would be dropped by the collection endpoint and report zero forever. The path pattern is stored exactly as written; `*` is the only wildcard and every other character is literal.
|
|
11169
|
+
*/
|
|
11170
|
+
declare const createAnalyticsGoal: <ThrowOnError extends boolean = false>(options?: Options<CreateAnalyticsGoalData, ThrowOnError>) => RequestResult<CreateAnalyticsGoalResponses, CreateAnalyticsGoalErrors, ThrowOnError, "fields">;
|
|
11171
|
+
/**
|
|
11172
|
+
* Delete a goal (site token, or org key with site_id)
|
|
11173
|
+
*
|
|
11174
|
+
* Removes the definition. No event is deleted and no history is rewritten — the goal simply stops being reported. A built-in goal has no id and cannot be deleted.
|
|
11175
|
+
*/
|
|
11176
|
+
declare const deleteAnalyticsGoal: <ThrowOnError extends boolean = false>(options: Options<DeleteAnalyticsGoalData, ThrowOnError>) => RequestResult<DeleteAnalyticsGoalResponses, DeleteAnalyticsGoalErrors, ThrowOnError, "fields">;
|
|
11177
|
+
/**
|
|
11178
|
+
* Rename or edit a goal (site token, or org key with site_id)
|
|
11179
|
+
*
|
|
11180
|
+
* Renaming a goal relabels it in every historical report immediately, because matching is query-time and the display name is the key reports are keyed by. Nothing is destroyed and a rename can be reversed, but last quarter's report will say the new name. A built-in goal has no id and cannot be edited.
|
|
11181
|
+
*/
|
|
11182
|
+
declare const updateAnalyticsGoal: <ThrowOnError extends boolean = false>(options: Options<UpdateAnalyticsGoalData, ThrowOnError>) => RequestResult<UpdateAnalyticsGoalResponses, UpdateAnalyticsGoalErrors, ThrowOnError, "fields">;
|
|
11183
|
+
/**
|
|
11184
|
+
* This site's funnels (site token, or org key with site_id)
|
|
11185
|
+
*
|
|
11186
|
+
* Funnel definitions with their ordered steps. A funnel is a definition matched at read time, so creating or reordering one changes every historical number with no backfill. Funnels are bounded to a VISITOR-DAY, not a visitor history, because the visitor identifier rotates daily — say so wherever you show a funnel.
|
|
11187
|
+
*/
|
|
11188
|
+
declare const listAnalyticsFunnels: <ThrowOnError extends boolean = false>(options?: Options<ListAnalyticsFunnelsData, ThrowOnError>) => RequestResult<ListAnalyticsFunnelsResponses, ListAnalyticsFunnelsErrors, ThrowOnError, "fields">;
|
|
11189
|
+
/**
|
|
11190
|
+
* Define a funnel (site token, or org key with site_id)
|
|
11191
|
+
*
|
|
11192
|
+
* An ordered path of 2 to 8 goals. Array order is step order. Steps are validated as a SET — the count, the references and the ordering are one judgement — so every problem is returned at once rather than one per round-trip.
|
|
11193
|
+
*/
|
|
11194
|
+
declare const createAnalyticsFunnel: <ThrowOnError extends boolean = false>(options?: Options<CreateAnalyticsFunnelData, ThrowOnError>) => RequestResult<CreateAnalyticsFunnelResponses, CreateAnalyticsFunnelErrors, ThrowOnError, "fields">;
|
|
11195
|
+
/**
|
|
11196
|
+
* Delete a funnel
|
|
11197
|
+
*
|
|
11198
|
+
* Removes the definition. The underlying events are untouched, so the same funnel recreated with the same steps reports the same history.
|
|
11199
|
+
*/
|
|
11200
|
+
declare const deleteAnalyticsFunnel: <ThrowOnError extends boolean = false>(options: Options<DeleteAnalyticsFunnelData, ThrowOnError>) => RequestResult<DeleteAnalyticsFunnelResponses, DeleteAnalyticsFunnelErrors, ThrowOnError, "fields">;
|
|
11201
|
+
/**
|
|
11202
|
+
* Rename a funnel or replace its steps
|
|
11203
|
+
*
|
|
11204
|
+
* Steps are replaced WHOLE when supplied, never patched individually: a funnel is an ordered path, so an edit to one step is an edit to the path and the set has to be judged together. Omit `steps` to rename only.
|
|
11205
|
+
*/
|
|
11206
|
+
declare const updateAnalyticsFunnel: <ThrowOnError extends boolean = false>(options: Options<UpdateAnalyticsFunnelData, ThrowOnError>) => RequestResult<UpdateAnalyticsFunnelResponses, UpdateAnalyticsFunnelErrors, ThrowOnError, "fields">;
|
|
10123
11207
|
/**
|
|
10124
11208
|
* List subscriptions (site token, or org key with site_id)
|
|
10125
11209
|
*
|
|
@@ -10280,6 +11364,46 @@ declare const eraseCustomerReviews: <ThrowOnError extends boolean = false>(optio
|
|
|
10280
11364
|
* Idempotently pause collection and erase review content before website deletion. Does not remove orders.
|
|
10281
11365
|
*/
|
|
10282
11366
|
declare const purgeSiteReviews: <ThrowOnError extends boolean = false>(options: Options<PurgeSiteReviewsData, ThrowOnError>) => RequestResult<PurgeSiteReviewsResponses, PurgeSiteReviewsErrors, ThrowOnError, "fields">;
|
|
11367
|
+
/**
|
|
11368
|
+
* List site-managed promos with live Stripe status (eligibility is connected-account wide)
|
|
11369
|
+
*/
|
|
11370
|
+
declare const listPromos: <ThrowOnError extends boolean = false>(options?: Options<ListPromosData, ThrowOnError>) => RequestResult<ListPromosResponses, ListPromosErrors, ThrowOnError, "fields">;
|
|
11371
|
+
/**
|
|
11372
|
+
* Create a Stripe-backed account-wide promo; retry the same request_id after unknown outcomes
|
|
11373
|
+
*/
|
|
11374
|
+
declare const createPromo: <ThrowOnError extends boolean = false>(options: Options<CreatePromoData, ThrowOnError>) => RequestResult<CreatePromoResponses, CreatePromoErrors, ThrowOnError, "fields">;
|
|
11375
|
+
/**
|
|
11376
|
+
* Read live status and usage of an owned promo
|
|
11377
|
+
*/
|
|
11378
|
+
declare const getPromo: <ThrowOnError extends boolean = false>(options: Options<GetPromoData, ThrowOnError>) => RequestResult<GetPromoResponses, GetPromoErrors, ThrowOnError, "fields">;
|
|
11379
|
+
/**
|
|
11380
|
+
* Disable new redemptions; existing subscription discounts are unaffected
|
|
11381
|
+
*/
|
|
11382
|
+
declare const disablePromo: <ThrowOnError extends boolean = false>(options: Options<DisablePromoData, ThrowOnError>) => RequestResult<DisablePromoResponses, DisablePromoErrors, ThrowOnError, "fields">;
|
|
11383
|
+
/**
|
|
11384
|
+
* Create different-code replacement then disable predecessor; retry same request_id if incomplete
|
|
11385
|
+
*/
|
|
11386
|
+
declare const replacePromo: <ThrowOnError extends boolean = false>(options: Options<ReplacePromoData, ThrowOnError>) => RequestResult<ReplacePromoResponses, ReplacePromoErrors, ThrowOnError, "fields">;
|
|
11387
|
+
/**
|
|
11388
|
+
* List site-managed promos with live Stripe status (eligibility is connected-account wide)
|
|
11389
|
+
*/
|
|
11390
|
+
declare const listPromosForSite: <ThrowOnError extends boolean = false>(options: Options<ListPromosForSiteData, ThrowOnError>) => RequestResult<ListPromosForSiteResponses, ListPromosForSiteErrors, ThrowOnError, "fields">;
|
|
11391
|
+
/**
|
|
11392
|
+
* Create a Stripe-backed account-wide promo; retry the same request_id after unknown outcomes
|
|
11393
|
+
*/
|
|
11394
|
+
declare const createPromoForSite: <ThrowOnError extends boolean = false>(options: Options<CreatePromoForSiteData, ThrowOnError>) => RequestResult<CreatePromoForSiteResponses, CreatePromoForSiteErrors, ThrowOnError, "fields">;
|
|
11395
|
+
/**
|
|
11396
|
+
* Read live status and usage of an owned promo
|
|
11397
|
+
*/
|
|
11398
|
+
declare const getPromoForSite: <ThrowOnError extends boolean = false>(options: Options<GetPromoForSiteData, ThrowOnError>) => RequestResult<GetPromoForSiteResponses, GetPromoForSiteErrors, ThrowOnError, "fields">;
|
|
11399
|
+
/**
|
|
11400
|
+
* Disable new redemptions; existing subscription discounts are unaffected
|
|
11401
|
+
*/
|
|
11402
|
+
declare const disablePromoForSite: <ThrowOnError extends boolean = false>(options: Options<DisablePromoForSiteData, ThrowOnError>) => RequestResult<DisablePromoForSiteResponses, DisablePromoForSiteErrors, ThrowOnError, "fields">;
|
|
11403
|
+
/**
|
|
11404
|
+
* Create different-code replacement then disable predecessor; retry same request_id if incomplete
|
|
11405
|
+
*/
|
|
11406
|
+
declare const replacePromoForSite: <ThrowOnError extends boolean = false>(options: Options<ReplacePromoForSiteData, ThrowOnError>) => RequestResult<ReplacePromoForSiteResponses, ReplacePromoForSiteErrors, ThrowOnError, "fields">;
|
|
10283
11407
|
/**
|
|
10284
11408
|
* Get the site's consent config (site token)
|
|
10285
11409
|
*
|
|
@@ -10675,4 +11799,4 @@ declare const withdrawProductReview: <ThrowOnError extends boolean = false>(opti
|
|
|
10675
11799
|
*/
|
|
10676
11800
|
declare const resubmitProductReview: <ThrowOnError extends boolean = false>(options: Options<ResubmitProductReviewData, ThrowOnError>) => RequestResult<ResubmitProductReviewResponses, ResubmitProductReviewErrors, ThrowOnError, "fields">;
|
|
10677
11801
|
|
|
10678
|
-
export { type AccountCancelSubscriptionData, type AccountCancelSubscriptionError, type AccountCancelSubscriptionErrors, type AccountCancelSubscriptionResponse, type AccountCancelSubscriptionResponses, type AccountCreatePortalSessionData, type AccountCreatePortalSessionError, type AccountCreatePortalSessionErrors, type AccountCreatePortalSessionResponse, type AccountCreatePortalSessionResponses, type AccountLoginData, type AccountLoginError, type AccountLoginErrors, type AccountLoginRequest, type AccountLoginResponse, type AccountLoginResponses, type AccountLoginResult, type AccountLogoutData, type AccountLogoutError, type AccountLogoutErrors, type AccountLogoutResponse, type AccountLogoutResponses, type AccountLogoutResult, type AccountManageCancelData, type AccountManageCancelError, type AccountManageCancelErrors, type AccountManageCancelResponse, type AccountManageCancelResponses, type AccountManageGetSubscriptionData, type AccountManageGetSubscriptionError, type AccountManageGetSubscriptionErrors, type AccountManageGetSubscriptionResponse, type AccountManageGetSubscriptionResponses, type AccountManagePortalSessionData, type AccountManagePortalSessionError, type AccountManagePortalSessionErrors, type AccountManagePortalSessionResponse, type AccountManagePortalSessionResponses, type AccountManageVerifyData, type AccountManageVerifyError, type AccountManageVerifyErrors, type AccountManageVerifyResponse, type AccountManageVerifyResponses, type AccountMeData, type AccountMeError, type AccountMeErrors, type AccountMeResponse, type AccountMeResponses, type AccountMeResult, type AccountReactivateSubscriptionData, type AccountReactivateSubscriptionError, type AccountReactivateSubscriptionErrors, type AccountReactivateSubscriptionResponse, type AccountReactivateSubscriptionResponses, type AccountSubscribeData, type AccountSubscribeError, type AccountSubscribeErrors, type AccountSubscribeRequest, type AccountSubscribeResponse, type AccountSubscribeResponses, type AccountUpdateSubscriptionAddressData, type AccountUpdateSubscriptionAddressError, type AccountUpdateSubscriptionAddressErrors, type AccountUpdateSubscriptionAddressResponse, type AccountUpdateSubscriptionAddressResponses, type AccountVerifyData, type AccountVerifyError, type AccountVerifyErrors, type AccountVerifyRequest, type AccountVerifyResponse, type AccountVerifyResponses, type AccountVerifyResult, type ActOnManageLinkData, type ActOnManageLinkError, type ActOnManageLinkErrors, type ActOnManageLinkResponse, type ActOnManageLinkResponses, type AdjustInventory, type AdjustVariantInventoryData, type AdjustVariantInventoryError, type AdjustVariantInventoryErrors, type AdjustVariantInventoryResponse, type AdjustVariantInventoryResponses, type AnalyticsBreakdown, type AnalyticsChannels, type AnalyticsRealtime, type AnalyticsStatus, type AnalyticsSummary, type AnalyticsTimeseries, type AttachProductFileData, type AttachProductFileError, type AttachProductFileErrors, type AttachProductFileFromUrl, type AttachProductFileMultipart, type AttachProductFileResponse, type AttachProductFileResponses, type Attachment, type BusinessSummary, type CancelRetainerData, type CancelRetainerError, type CancelRetainerErrors, type CancelRetainerResponse, type CancelRetainerResponses, type CancelSubscriptionData, type CancelSubscriptionErrors, type CancelSubscriptionResponse, type CancelSubscriptionResponses, type CartCheckoutRequest, type CartConflict, type CartConflictItem, type CartSummaryRequest, type CartSummaryResult, type ChangedField, type CheckoutPauseRequest, type CheckoutPauseState, type CheckoutRequest, type CheckoutResult, type Client, type ClientOptions$1 as ClientConfig, type ClientOptions, type Config, type ConsentConfig, type ConsentConfigResult, type ConsentPrefs, type CreateCartCheckoutData, type CreateCartCheckoutError, type CreateCartCheckoutErrors, type CreateCartCheckoutResponse, type CreateCartCheckoutResponses, type CreateCheckoutData, type CreateCheckoutError, type CreateCheckoutErrors, type CreateCheckoutResponse, type CreateCheckoutResponses, type CreateCustomer, type CreateCustomerData, type CreateCustomerError, type CreateCustomerErrors, type CreateCustomerResponse, type CreateCustomerResponses, type CreateEventDestination, type CreateEventDestinationData, type CreateEventDestinationError, type CreateEventDestinationErrors, type CreateEventDestinationResponse, type CreateEventDestinationResponses, type CreateEventDestinationWithSiteTokenData, type CreateEventDestinationWithSiteTokenError, type CreateEventDestinationWithSiteTokenErrors, type CreateEventDestinationWithSiteTokenResponse, type CreateEventDestinationWithSiteTokenResponses, type CreateForm, type CreateFormData, type CreateFormError, type CreateFormErrors, type CreateFormResponse, type CreateFormResponses, type CreateFormWithSiteTokenData, type CreateFormWithSiteTokenError, type CreateFormWithSiteTokenErrors, type CreateFormWithSiteTokenResponse, type CreateFormWithSiteTokenResponses, type CreateInvoice, type CreateInvoiceData, type CreateInvoiceError, type CreateInvoiceErrors, type CreateInvoiceLine, type CreateInvoiceResponse, type CreateInvoiceResponses, type CreateInvoiceResult, type CreateMultiItemTestOrder, type CreateMultiItemTestOrderData, type CreateMultiItemTestOrderError, type CreateMultiItemTestOrderErrors, type CreateMultiItemTestOrderResponse, type CreateMultiItemTestOrderResponses, type CreateOption, type CreateOptionData, type CreateOptionError, type CreateOptionErrors, type CreateOptionResponse, type CreateOptionResponses, type CreatePreviewSession, type CreatePreviewSessionData, type CreatePreviewSessionError, type CreatePreviewSessionErrors, type CreatePreviewSessionResponse, type CreatePreviewSessionResponses, type CreateProduct, type CreateProductData, type CreateProductError, type CreateProductErrors, type CreateProductResponse, type CreateProductResponses, type CreateProductReviewData, type CreateProductReviewError, type CreateProductReviewErrors, type CreateProductReviewResponse, type CreateProductReviewResponses, type CreateProductWithSiteTokenData, type CreateProductWithSiteTokenError, type CreateProductWithSiteTokenErrors, type CreateProductWithSiteTokenResponse, type CreateProductWithSiteTokenResponses, type CreateRetainer, type CreateRetainerData, type CreateRetainerError, type CreateRetainerErrors, type CreateRetainerResponse, type CreateRetainerResponses, type CreateRetainerResult, type CreateSite, type CreateSiteData, type CreateSiteError, type CreateSiteErrors, type CreateSiteResponse, type CreateSiteResponses, type CreateTestOrder, type CreateTestOrderData, type CreateTestOrderError, type CreateTestOrderErrors, type CreateTestOrderResponse, type CreateTestOrderResponses, type CreateTestSubscription, type CreateTestSubscriptionData, type CreateTestSubscriptionError, type CreateTestSubscriptionErrors, type CreateTestSubscriptionResponse, type CreateTestSubscriptionResponses, type CreateVariant, type CreateVariantData, type CreateVariantError, type CreateVariantErrors, type CreateVariantResponse, type CreateVariantResponses, type CurrencyRestatement, type CurrencyTotals, type Customer, type CustomerAddress, type CustomerBilling, type CustomerDetail, type CustomersList, type DeleteEventDestinationData, type DeleteEventDestinationError, type DeleteEventDestinationErrors, type DeleteEventDestinationResponse, type DeleteEventDestinationResponses, type DeleteEventDestinationWithSiteTokenData, type DeleteEventDestinationWithSiteTokenError, type DeleteEventDestinationWithSiteTokenErrors, type DeleteEventDestinationWithSiteTokenResponse, type DeleteEventDestinationWithSiteTokenResponses, type DeleteFormData, type DeleteFormError, type DeleteFormErrors, type DeleteFormResponse, type DeleteFormResponses, type DeleteOptionData, type DeleteOptionError, type DeleteOptionErrors, type DeleteOptionResponse, type DeleteOptionResponses, type DeleteProductData, type DeleteProductError, type DeleteProductErrors, type DeleteProductResponse, type DeleteProductResponses, type DeleteSiteData, type DeleteSiteError, type DeleteSiteErrors, type DeleteSiteResponse, type DeleteSiteResponses, type DeleteSubmissionData, type DeleteSubmissionError, type DeleteSubmissionErrors, type DeleteSubmissionResponse, type DeleteSubmissionResponses, type DeleteVariantData, type DeleteVariantError, type DeleteVariantErrors, type DeleteVariantResponse, type DeleteVariantResponses, type DownloadAttachmentData, type DownloadAttachmentError, type DownloadAttachmentErrors, type DownloadAttachmentResponses, type DownloadFileData, type DownloadFileError, type DownloadFileErrors, type DownloadFileResponse, type DownloadFileResponses, type EditProductReviewData, type EditProductReviewError, type EditProductReviewErrors, type EditProductReviewResponse, type EditProductReviewResponses, type EmailDelivery, type EraseCustomerReviewsData, type EraseCustomerReviewsError, type EraseCustomerReviewsErrors, type EraseCustomerReviewsResponse, type EraseCustomerReviewsResponses, type Error, type EventDeliveriesList, type EventDelivery, type EventDestination, type EventDestinationSecret, type EventDestinationsList, type Form, type FormsList, type GenerateVariants, type GenerateVariantsData, type GenerateVariantsError, type GenerateVariantsErrors, type GenerateVariantsResponse, type GenerateVariantsResponses, type GenerateVariantsResult, type GeoSuggestion, type GetAccountReviewsData, type GetAccountReviewsError, type GetAccountReviewsErrors, type GetAccountReviewsResponse, type GetAccountReviewsResponses, type GetAnalyticsBrowsersData, type GetAnalyticsBrowsersErrors, type GetAnalyticsBrowsersResponse, type GetAnalyticsBrowsersResponses, type GetAnalyticsCampaignsData, type GetAnalyticsCampaignsErrors, type GetAnalyticsCampaignsResponse, type GetAnalyticsCampaignsResponses, type GetAnalyticsChannelsData, type GetAnalyticsChannelsErrors, type GetAnalyticsChannelsResponse, type GetAnalyticsChannelsResponses, type GetAnalyticsCitiesData, type GetAnalyticsCitiesErrors, type GetAnalyticsCitiesResponse, type GetAnalyticsCitiesResponses, type GetAnalyticsCountriesData, type GetAnalyticsCountriesErrors, type GetAnalyticsCountriesResponse, type GetAnalyticsCountriesResponses, type GetAnalyticsDevicesData, type GetAnalyticsDevicesErrors, type GetAnalyticsDevicesResponse, type GetAnalyticsDevicesResponses, type GetAnalyticsEntryPagesData, type GetAnalyticsEntryPagesErrors, type GetAnalyticsEntryPagesResponse, type GetAnalyticsEntryPagesResponses, type GetAnalyticsExitPagesData, type GetAnalyticsExitPagesErrors, type GetAnalyticsExitPagesResponse, type GetAnalyticsExitPagesResponses, type GetAnalyticsOperatingSystemsData, type GetAnalyticsOperatingSystemsErrors, type GetAnalyticsOperatingSystemsResponse, type GetAnalyticsOperatingSystemsResponses, type GetAnalyticsPagesData, type GetAnalyticsPagesErrors, type GetAnalyticsPagesResponse, type GetAnalyticsPagesResponses, type GetAnalyticsRealtimeData, type GetAnalyticsRealtimeErrors, type GetAnalyticsRealtimeResponse, type GetAnalyticsRealtimeResponses, type GetAnalyticsRegionsData, type GetAnalyticsRegionsErrors, type GetAnalyticsRegionsResponse, type GetAnalyticsRegionsResponses, type GetAnalyticsSourcesData, type GetAnalyticsSourcesErrors, type GetAnalyticsSourcesResponse, type GetAnalyticsSourcesResponses, type GetAnalyticsStatusData, type GetAnalyticsStatusErrors, type GetAnalyticsStatusResponse, type GetAnalyticsStatusResponses, type GetAnalyticsSummaryData, type GetAnalyticsSummaryErrors, type GetAnalyticsSummaryResponse, type GetAnalyticsSummaryResponses, type GetAnalyticsTimeseriesData, type GetAnalyticsTimeseriesErrors, type GetAnalyticsTimeseriesResponse, type GetAnalyticsTimeseriesResponses, type GetAnalyticsUtmCampaignData, type GetAnalyticsUtmCampaignErrors, type GetAnalyticsUtmCampaignResponse, type GetAnalyticsUtmCampaignResponses, type GetAnalyticsUtmContentData, type GetAnalyticsUtmContentErrors, type GetAnalyticsUtmContentResponse, type GetAnalyticsUtmContentResponses, type GetAnalyticsUtmMediumData, type GetAnalyticsUtmMediumErrors, type GetAnalyticsUtmMediumResponse, type GetAnalyticsUtmMediumResponses, type GetAnalyticsUtmSourceData, type GetAnalyticsUtmSourceErrors, type GetAnalyticsUtmSourceResponse, type GetAnalyticsUtmSourceResponses, type GetAnalyticsUtmTermData, type GetAnalyticsUtmTermErrors, type GetAnalyticsUtmTermResponse, type GetAnalyticsUtmTermResponses, type GetBusinessSummaryData, type GetBusinessSummaryErrors, type GetBusinessSummaryResponse, type GetBusinessSummaryResponses, type GetCartSummaryData, type GetCartSummaryError, type GetCartSummaryErrors, type GetCartSummaryResponse, type GetCartSummaryResponses, type GetConsentConfigWithSiteTokenData, type GetConsentConfigWithSiteTokenError, type GetConsentConfigWithSiteTokenErrors, type GetConsentConfigWithSiteTokenResponse, type GetConsentConfigWithSiteTokenResponses, type GetCustomerData, type GetCustomerError, type GetCustomerErrors, type GetCustomerResponse, type GetCustomerResponses, type GetEventDestinationData, type GetEventDestinationError, type GetEventDestinationErrors, type GetEventDestinationResponse, type GetEventDestinationResponses, type GetEventDestinationSecretData, type GetEventDestinationSecretError, type GetEventDestinationSecretErrors, type GetEventDestinationSecretResponse, type GetEventDestinationSecretResponses, type GetEventDestinationSecretWithSiteTokenData, type GetEventDestinationSecretWithSiteTokenError, type GetEventDestinationSecretWithSiteTokenErrors, type GetEventDestinationSecretWithSiteTokenResponse, type GetEventDestinationSecretWithSiteTokenResponses, type GetFormData, type GetFormError, type GetFormErrors, type GetFormResponse, type GetFormResponses, type GetGeoData, type GetGeoError, type GetGeoErrors, type GetGeoResponse, type GetGeoResponses, type GetInvoiceData, type GetInvoiceError, type GetInvoiceErrors, type GetInvoicePreviewData, type GetInvoicePreviewError, type GetInvoicePreviewErrors, type GetInvoicePreviewResponse, type GetInvoicePreviewResponses, type GetInvoiceResponse, type GetInvoiceResponses, type GetInvoiceSettingsData, type GetInvoiceSettingsError, type GetInvoiceSettingsErrors, type GetInvoiceSettingsResponse, type GetInvoiceSettingsResponses, type GetInvoiceSettingsWithSiteTokenData, type GetInvoiceSettingsWithSiteTokenError, type GetInvoiceSettingsWithSiteTokenErrors, type GetInvoiceSettingsWithSiteTokenResponse, type GetInvoiceSettingsWithSiteTokenResponses, type GetMerchantReviewData, type GetMerchantReviewError, type GetMerchantReviewErrors, type GetMerchantReviewResponse, type GetMerchantReviewResponses, type GetNextPayoutData, type GetNextPayoutErrors, type GetNextPayoutResponse, type GetNextPayoutResponses, type GetOrderData, type GetOrderError, type GetOrderErrors, type GetOrderResponse, type GetOrderResponses, type GetOrderSessionData, type GetOrderSessionError, type GetOrderSessionErrors, type GetOrderSessionResponse, type GetOrderSessionResponses, type GetOwnProductReviewData, type GetOwnProductReviewError, type GetOwnProductReviewErrors, type GetOwnProductReviewResponse, type GetOwnProductReviewResponses, type GetPaymentsStatusData, type GetPaymentsStatusError, type GetPaymentsStatusErrors, type GetPaymentsStatusResponse, type GetPaymentsStatusResponses, type GetPersonData, type GetPersonErrors, type GetPersonResponse, type GetPersonResponses, type GetProductData, type GetProductError, type GetProductErrors, type GetProductResponse, type GetProductResponses, type GetProductReviewAvailabilityData, type GetProductReviewAvailabilityError, type GetProductReviewAvailabilityErrors, type GetProductReviewAvailabilityResponse, type GetProductReviewAvailabilityResponses, type GetProductReviewsData, type GetProductReviewsError, type GetProductReviewsErrors, type GetProductReviewsResponse, type GetProductReviewsResponses, type GetPublicConsentPrefsData, type GetPublicConsentPrefsError, type GetPublicConsentPrefsErrors, type GetPublicConsentPrefsResponse, type GetPublicConsentPrefsResponses, type GetPublicProductData, type GetPublicProductError, type GetPublicProductErrors, type GetPublicProductResponse, type GetPublicProductResponses, type GetRetainerData, type GetRetainerError, type GetRetainerErrors, type GetRetainerResponse, type GetRetainerResponses, type GetReviewSettingsData, type GetReviewSettingsError, type GetReviewSettingsErrors, type GetReviewSettingsResponse, type GetReviewSettingsResponses, type GetSalesSummaryData, type GetSalesSummaryErrors, type GetSalesSummaryResponse, type GetSalesSummaryResponses, type GetSiteAnalyticsData, type GetSiteAnalyticsError, type GetSiteAnalyticsErrors, type GetSiteAnalyticsResponse, type GetSiteAnalyticsResponses, type GetSiteCheckoutPauseData, type GetSiteCheckoutPauseError, type GetSiteCheckoutPauseErrors, type GetSiteCheckoutPauseResponse, type GetSiteCheckoutPauseResponses, type GetSiteData, type GetSiteError, type GetSiteErrors, type GetSiteResponse, type GetSiteResponses, type GetSubmissionData, type GetSubmissionError, type GetSubmissionErrors, type GetSubmissionResponse, type GetSubmissionResponses, type Inventory, type InventoryInput, type Invoice, type InvoiceAggregates, type InvoiceBillTo, type InvoiceError, type InvoiceLineItem, type InvoicePreview, type InvoiceSettings, type InvoiceSiteBody, type InvoicesList, type ListCustomersData, type ListCustomersError, type ListCustomersErrors, type ListCustomersResponse, type ListCustomersResponses, type ListEventDeliveriesData, type ListEventDeliveriesError, type ListEventDeliveriesErrors, type ListEventDeliveriesResponse, type ListEventDeliveriesResponses, type ListEventDeliveriesWithSiteTokenData, type ListEventDeliveriesWithSiteTokenError, type ListEventDeliveriesWithSiteTokenErrors, type ListEventDeliveriesWithSiteTokenResponse, type ListEventDeliveriesWithSiteTokenResponses, type ListEventDestinationsData, type ListEventDestinationsError, type ListEventDestinationsErrors, type ListEventDestinationsResponse, type ListEventDestinationsResponses, type ListEventDestinationsWithSiteTokenData, type ListEventDestinationsWithSiteTokenError, type ListEventDestinationsWithSiteTokenErrors, type ListEventDestinationsWithSiteTokenResponse, type ListEventDestinationsWithSiteTokenResponses, type ListFormsData, type ListFormsError, type ListFormsErrors, type ListFormsResponse, type ListFormsResponses, type ListFormsWithSiteTokenData, type ListFormsWithSiteTokenError, type ListFormsWithSiteTokenErrors, type ListFormsWithSiteTokenResponse, type ListFormsWithSiteTokenResponses, type ListInvoicesData, type ListInvoicesError, type ListInvoicesErrors, type ListInvoicesResponse, type ListInvoicesResponses, type ListMerchantReviewsData, type ListMerchantReviewsError, type ListMerchantReviewsErrors, type ListMerchantReviewsResponse, type ListMerchantReviewsResponses, type ListOrdersWithSiteTokenData, type ListOrdersWithSiteTokenError, type ListOrdersWithSiteTokenErrors, type ListOrdersWithSiteTokenResponse, type ListOrdersWithSiteTokenResponses, type ListPeopleData, type ListPeopleErrors, type ListPeopleResponse, type ListPeopleResponses, type ListProductsData, type ListProductsError, type ListProductsErrors, type ListProductsResponse, type ListProductsResponses, type ListProductsWithSiteTokenData, type ListProductsWithSiteTokenError, type ListProductsWithSiteTokenErrors, type ListProductsWithSiteTokenResponse, type ListProductsWithSiteTokenResponses, type ListRetainersData, type ListRetainersError, type ListRetainersErrors, type ListRetainersResponse, type ListRetainersResponses, type ListSitesData, type ListSitesError, type ListSitesErrors, type ListSitesResponse, type ListSitesResponses, type ListSubmissionsData, type ListSubmissionsError, type ListSubmissionsErrors, type ListSubmissionsResponse, type ListSubmissionsResponses, type ListSubscriptionsData, type ListSubscriptionsErrors, type ListSubscriptionsResponse, type ListSubscriptionsResponses, type ManageCancelResult, type ManageLinkAction, type ManageVerifyRequest, type ManageVerifyResult, type ManagedSubscription, type ManagedSubscriptionResult, type MarkInvoicePaid, type MarkInvoicePaidData, type MarkInvoicePaidError, type MarkInvoicePaidErrors, type MarkInvoicePaidResponse, type MarkInvoicePaidResponses, type MarkInvoicePaidResult, type MarkInvoiceUncollectibleData, type MarkInvoiceUncollectibleError, type MarkInvoiceUncollectibleErrors, type MarkInvoiceUncollectibleResponse, type MarkInvoiceUncollectibleResponses, type ModerateMerchantReviewData, type ModerateMerchantReviewError, type ModerateMerchantReviewErrors, type ModerateMerchantReviewResponse, type ModerateMerchantReviewResponses, type NeedsAttentionItem, type NestedOptionInput, type NestedVariantInput, type NextPayout, type Option, type Options, type Order, type OrderCustomer, type OrderFulfillmentRequest, type OrderSessionStatus, type OrdersList, type OwnProductReview, type PauseRetainerData, type PauseRetainerError, type PauseRetainerErrors, type PauseRetainerResponse, type PauseRetainerResponses, type PauseSiteCheckoutData, type PauseSiteCheckoutError, type PauseSiteCheckoutErrors, type PauseSiteCheckoutResponse, type PauseSiteCheckoutResponses, type PaymentsStatus, type PeopleList, type PersonDetail, type PersonRow, type PortalSessionResult, type PreviewInvoice, type PreviewInvoiceData, type PreviewInvoiceError, type PreviewInvoiceErrors, type PreviewInvoiceResponse, type PreviewInvoiceResponses, type PreviewSessionResult, type Product, type ProductDetail, type ProductFulfillment, type ProductFulfillmentInput, type ProductReview, type ProductSubscriptionConfig, type ProductsList, type PublicOption, type PublicProduct, type PublicSubscription, type PublicSubscriptionPlan, type PublicVariant, type PurgeSiteReviewsData, type PurgeSiteReviewsError, type PurgeSiteReviewsErrors, type PurgeSiteReviewsResponse, type PurgeSiteReviewsResponses, type ReactivateSiteSubscriptionsTeardownData, type ReactivateSiteSubscriptionsTeardownError, type ReactivateSiteSubscriptionsTeardownErrors, type ReactivateSiteSubscriptionsTeardownResponse, type ReactivateSiteSubscriptionsTeardownResponses, type RecipientCooldownError, type ReconcileOptionInput, type ReconcileOptionValueInput, type ReconcileVariantInput, type RefundOrder, type RefundOrderData, type RefundOrderError, type RefundOrderErrors, type RefundOrderResponse, type RefundOrderResponses, type RefundResult, type ReissueResult, type RemindInvoiceData, type RemindInvoiceError, type RemindInvoiceErrors, type RemindInvoiceResponse, type RemindInvoiceResponses, type RemindInvoiceResult, type ReplyToMerchantReviewData, type ReplyToMerchantReviewError, type ReplyToMerchantReviewErrors, type ReplyToMerchantReviewResponse, type ReplyToMerchantReviewResponses, type ResendInvoiceData, type ResendInvoiceError, type ResendInvoiceErrors, type ResendInvoiceResponse, type ResendInvoiceResponses, type ResendOrderReceiptData, type ResendOrderReceiptError, type ResendOrderReceiptErrors, type ResendOrderReceiptResponse, type ResendOrderReceiptResponses, type ResendReceiptResult, type ResetOrderDownloadsData, type ResetOrderDownloadsError, type ResetOrderDownloadsErrors, type ResetOrderDownloadsResponse, type ResetOrderDownloadsResponses, type ResetWebhookEventData, type ResetWebhookEventError, type ResetWebhookEventErrors, type ResetWebhookEventResponse, type ResetWebhookEventResponses, type ResolveManageLinkData, type ResolveManageLinkError, type ResolveManageLinkErrors, type ResolveManageLinkResponse, type ResolveManageLinkResponses, type ResubmitProductReviewData, type ResubmitProductReviewError, type ResubmitProductReviewErrors, type ResubmitProductReviewResponse, type ResubmitProductReviewResponses, type ResumeRetainerData, type ResumeRetainerError, type ResumeRetainerErrors, type ResumeRetainerResponse, type ResumeRetainerResponses, type Retainer, type RetainerError, type RetainerSiteBody, type RetainersList, type RetryEventDeliveryData, type RetryEventDeliveryError, type RetryEventDeliveryErrors, type RetryEventDeliveryResponse, type RetryEventDeliveryResponses, type RetryEventDeliveryWithSiteTokenData, type RetryEventDeliveryWithSiteTokenError, type RetryEventDeliveryWithSiteTokenErrors, type RetryEventDeliveryWithSiteTokenResponse, type RetryEventDeliveryWithSiteTokenResponses, type ReviewReadiness, type RevokeCustomerAccessData, type RevokeCustomerAccessError, type RevokeCustomerAccessErrors, type RevokeCustomerAccessResponse, type RevokeCustomerAccessResponses, type RevokeCustomerAccessResult, type RotateEventDestinationSecretData, type RotateEventDestinationSecretError, type RotateEventDestinationSecretErrors, type RotateEventDestinationSecretResponse, type RotateEventDestinationSecretResponses, type RotateEventDestinationSecretWithSiteTokenData, type RotateEventDestinationSecretWithSiteTokenError, type RotateEventDestinationSecretWithSiteTokenErrors, type RotateEventDestinationSecretWithSiteTokenResponse, type RotateEventDestinationSecretWithSiteTokenResponses, type SalesSummary, type SalesSummaryProductRow, type SalesSummarySeriesEntry, type SetInventory, type SetInvoiceReminders, type SetInvoiceRemindersData, type SetInvoiceRemindersError, type SetInvoiceRemindersErrors, type SetInvoiceRemindersResponse, type SetInvoiceRemindersResponses, type SetOrderFulfillmentData, type SetOrderFulfillmentErrors, type SetOrderFulfillmentResponse, type SetOrderFulfillmentResponses, type SetProductSubscription, type SetProductSubscriptionData, type SetProductSubscriptionError, type SetProductSubscriptionErrors, type SetProductSubscriptionResponse, type SetProductSubscriptionResponses, type SetProductVariants, type SetProductVariantsConflict, type SetProductVariantsData, type SetProductVariantsError, type SetProductVariantsErrors, type SetProductVariantsResponse, type SetProductVariantsResponses, type SetProductVariantsResult, type SetVariantInventoryData, type SetVariantInventoryError, type SetVariantInventoryErrors, type SetVariantInventoryResponse, type SetVariantInventoryResponses, type SettledTotals, type ShippingOptionUnavailable, type ShippingRateInput, type Site, type SiteAccountRoute, type SiteAnalytics, type SiteDomains, type SitePayments, type SiteWithRestatement, type SiteWithToken, type SitesList, type SkipNextRetainerCycleData, type SkipNextRetainerCycleError, type SkipNextRetainerCycleErrors, type SkipNextRetainerCycleResponse, type SkipNextRetainerCycleResponses, type SnoozeInvoice, type SnoozeInvoiceData, type SnoozeInvoiceError, type SnoozeInvoiceErrors, type SnoozeInvoiceResponse, type SnoozeInvoiceResponses, type Submission, type SubmissionMetadata, type SubmissionsList, type SubscriberActionResult, type SubscriberSubscription, type SubscriptionPlan, type SubscriptionPlanInput, type SubscriptionSummary, type SubscriptionsList, type SubscriptionsReactivateBody, type SubscriptionsReactivateResult, type SubscriptionsTeardownBody, type SubscriptionsTeardownResult, type SummaryPeriod, type TeardownReason, type TeardownSiteSubscriptionsData, type TeardownSiteSubscriptionsError, type TeardownSiteSubscriptionsErrors, type TeardownSiteSubscriptionsResponse, type TeardownSiteSubscriptionsResponses, type TestOrderResult, type TestShippingAddress, type TestSubscriptionResult, type UpdateCustomer, type UpdateCustomerBilling, type UpdateCustomerBillingData, type UpdateCustomerBillingError, type UpdateCustomerBillingErrors, type UpdateCustomerBillingResponse, type UpdateCustomerBillingResponses, type UpdateCustomerData, type UpdateCustomerError, type UpdateCustomerErrors, type UpdateCustomerResponse, type UpdateCustomerResponses, type UpdateEventDestination, type UpdateEventDestinationData, type UpdateEventDestinationError, type UpdateEventDestinationErrors, type UpdateEventDestinationResponse, type UpdateEventDestinationResponses, type UpdateEventDestinationWithSiteTokenData, type UpdateEventDestinationWithSiteTokenError, type UpdateEventDestinationWithSiteTokenErrors, type UpdateEventDestinationWithSiteTokenResponse, type UpdateEventDestinationWithSiteTokenResponses, type UpdateForm, type UpdateFormData, type UpdateFormError, type UpdateFormErrors, type UpdateFormResponse, type UpdateFormResponses, type UpdateInvoiceRecipient, type UpdateInvoiceRecipientData, type UpdateInvoiceRecipientError, type UpdateInvoiceRecipientErrors, type UpdateInvoiceRecipientResponse, type UpdateInvoiceRecipientResponses, type UpdateInvoiceSettings, type UpdateInvoiceSettingsData, type UpdateInvoiceSettingsError, type UpdateInvoiceSettingsErrors, type UpdateInvoiceSettingsResponse, type UpdateInvoiceSettingsResponses, type UpdateOption, type UpdateOptionData, type UpdateOptionError, type UpdateOptionErrors, type UpdateOptionResponse, type UpdateOptionResponses, type UpdateProduct, type UpdateProductData, type UpdateProductError, type UpdateProductErrors, type UpdateProductResponse, type UpdateProductResponses, type UpdateRecipientResult, type UpdateRetainer, type UpdateRetainerData, type UpdateRetainerError, type UpdateRetainerErrors, type UpdateRetainerResponse, type UpdateRetainerResponses, type UpdateReviewSettingsData, type UpdateReviewSettingsError, type UpdateReviewSettingsErrors, type UpdateReviewSettingsResponse, type UpdateReviewSettingsResponses, type UpdateSite, type UpdateSiteAccountRoute, type UpdateSiteAccountRouteData, type UpdateSiteAccountRouteError, type UpdateSiteAccountRouteErrors, type UpdateSiteAccountRouteResponse, type UpdateSiteAccountRouteResponses, type UpdateSiteAnalytics, type UpdateSiteAnalyticsData, type UpdateSiteAnalyticsError, type UpdateSiteAnalyticsErrors, type UpdateSiteAnalyticsResponse, type UpdateSiteAnalyticsResponses, type UpdateSiteData, type UpdateSiteDomains, type UpdateSiteDomainsData, type UpdateSiteDomainsError, type UpdateSiteDomainsErrors, type UpdateSiteDomainsResponse, type UpdateSiteDomainsResponses, type UpdateSiteError, type UpdateSiteErrors, type UpdateSiteInvoicing, type UpdateSiteInvoicingData, type UpdateSiteInvoicingError, type UpdateSiteInvoicingErrors, type UpdateSiteInvoicingResponse, type UpdateSiteInvoicingResponses, type UpdateSitePayments, type UpdateSitePaymentsData, type UpdateSitePaymentsError, type UpdateSitePaymentsErrors, type UpdateSitePaymentsResponse, type UpdateSitePaymentsResponses, type UpdateSiteResponse, type UpdateSiteResponses, type UpdateSubscriptionAddressRequest, type UpdateVariant, type UpdateVariantData, type UpdateVariantError, type UpdateVariantErrors, type UpdateVariantResponse, type UpdateVariantResponses, type UpsertConsentConfig, type UpsertConsentConfigWithSiteTokenData, type UpsertConsentConfigWithSiteTokenError, type UpsertConsentConfigWithSiteTokenErrors, type UpsertConsentConfigWithSiteTokenResponse, type UpsertConsentConfigWithSiteTokenResponses, type Variant, type VariantOptionValue, type VoidInvoice, type VoidInvoiceData, type VoidInvoiceError, type VoidInvoiceErrors, type VoidInvoiceResponse, type VoidInvoiceResponses, type VoidInvoiceResult, type WebhookEventResetResult, type WithdrawProductReviewData, type WithdrawProductReviewError, type WithdrawProductReviewErrors, type WithdrawProductReviewResponse, type WithdrawProductReviewResponses, accountCancelSubscription, accountCreatePortalSession, accountLogin, accountLogout, accountManageCancel, accountManageGetSubscription, accountManagePortalSession, accountManageVerify, accountMe, accountReactivateSubscription, accountSubscribe, accountUpdateSubscriptionAddress, accountVerify, actOnManageLink, adjustVariantInventory, attachProductFile, cancelRetainer, cancelSubscription, createCartCheckout, createCheckout, createClient, createConfig, createCustomer, createEventDestination, createEventDestinationWithSiteToken, createForm, createFormWithSiteToken, createInvoice, createMultiItemTestOrder, createOption, createPreviewSession, createProduct, createProductReview, createProductWithSiteToken, createRetainer, createSite, createTestOrder, createTestSubscription, createVariant, deleteEventDestination, deleteEventDestinationWithSiteToken, deleteForm, deleteOption, deleteProduct, deleteSite, deleteSubmission, deleteVariant, downloadAttachment, downloadFile, editProductReview, eraseCustomerReviews, generateVariants, getAccountReviews, getAnalyticsBrowsers, getAnalyticsCampaigns, getAnalyticsChannels, getAnalyticsCities, getAnalyticsCountries, getAnalyticsDevices, getAnalyticsEntryPages, getAnalyticsExitPages, getAnalyticsOperatingSystems, getAnalyticsPages, getAnalyticsRealtime, getAnalyticsRegions, getAnalyticsSources, getAnalyticsStatus, getAnalyticsSummary, getAnalyticsTimeseries, getAnalyticsUtmCampaign, getAnalyticsUtmContent, getAnalyticsUtmMedium, getAnalyticsUtmSource, getAnalyticsUtmTerm, getBusinessSummary, getCartSummary, getConsentConfigWithSiteToken, getCustomer, getEventDestination, getEventDestinationSecret, getEventDestinationSecretWithSiteToken, getForm, getGeo, getInvoice, getInvoicePreview, getInvoiceSettings, getInvoiceSettingsWithSiteToken, getMerchantReview, getNextPayout, getOrder, getOrderSession, getOwnProductReview, getPaymentsStatus, getPerson, getProduct, getProductReviewAvailability, getProductReviews, getPublicConsentPrefs, getPublicProduct, getRetainer, getReviewSettings, getSalesSummary, getSite, getSiteAnalytics, getSiteCheckoutPause, getSubmission, listCustomers, listEventDeliveries, listEventDeliveriesWithSiteToken, listEventDestinations, listEventDestinationsWithSiteToken, listForms, listFormsWithSiteToken, listInvoices, listMerchantReviews, listOrdersWithSiteToken, listPeople, listProducts, listProductsWithSiteToken, listRetainers, listSites, listSubmissions, listSubscriptions, markInvoicePaid, markInvoiceUncollectible, moderateMerchantReview, pauseRetainer, pauseSiteCheckout, previewInvoice, purgeSiteReviews, reactivateSiteSubscriptionsTeardown, refundOrder, remindInvoice, replyToMerchantReview, resendInvoice, resendOrderReceipt, resetOrderDownloads, resetWebhookEvent, resolveManageLink, resubmitProductReview, resumeRetainer, retryEventDelivery, retryEventDeliveryWithSiteToken, revokeCustomerAccess, rotateEventDestinationSecret, rotateEventDestinationSecretWithSiteToken, setInvoiceReminders, setOrderFulfillment, setProductSubscription, setProductVariants, setVariantInventory, skipNextRetainerCycle, snoozeInvoice, teardownSiteSubscriptions, updateCustomer, updateCustomerBilling, updateEventDestination, updateEventDestinationWithSiteToken, updateForm, updateInvoiceRecipient, updateInvoiceSettings, updateOption, updateProduct, updateRetainer, updateReviewSettings, updateSite, updateSiteAccountRoute, updateSiteAnalytics, updateSiteDomains, updateSiteInvoicing, updateSitePayments, updateVariant, upsertConsentConfigWithSiteToken, voidInvoice, withdrawProductReview };
|
|
11802
|
+
export { type AccountCancelSubscriptionData, type AccountCancelSubscriptionError, type AccountCancelSubscriptionErrors, type AccountCancelSubscriptionResponse, type AccountCancelSubscriptionResponses, type AccountCreatePortalSessionData, type AccountCreatePortalSessionError, type AccountCreatePortalSessionErrors, type AccountCreatePortalSessionResponse, type AccountCreatePortalSessionResponses, type AccountLoginData, type AccountLoginError, type AccountLoginErrors, type AccountLoginRequest, type AccountLoginResponse, type AccountLoginResponses, type AccountLoginResult, type AccountLogoutData, type AccountLogoutError, type AccountLogoutErrors, type AccountLogoutResponse, type AccountLogoutResponses, type AccountLogoutResult, type AccountManageCancelData, type AccountManageCancelError, type AccountManageCancelErrors, type AccountManageCancelResponse, type AccountManageCancelResponses, type AccountManageGetSubscriptionData, type AccountManageGetSubscriptionError, type AccountManageGetSubscriptionErrors, type AccountManageGetSubscriptionResponse, type AccountManageGetSubscriptionResponses, type AccountManagePortalSessionData, type AccountManagePortalSessionError, type AccountManagePortalSessionErrors, type AccountManagePortalSessionResponse, type AccountManagePortalSessionResponses, type AccountManageVerifyData, type AccountManageVerifyError, type AccountManageVerifyErrors, type AccountManageVerifyResponse, type AccountManageVerifyResponses, type AccountMeData, type AccountMeError, type AccountMeErrors, type AccountMeResponse, type AccountMeResponses, type AccountMeResult, type AccountReactivateSubscriptionData, type AccountReactivateSubscriptionError, type AccountReactivateSubscriptionErrors, type AccountReactivateSubscriptionResponse, type AccountReactivateSubscriptionResponses, type AccountSubscribeData, type AccountSubscribeError, type AccountSubscribeErrors, type AccountSubscribeRequest, type AccountSubscribeResponse, type AccountSubscribeResponses, type AccountUpdateSubscriptionAddressData, type AccountUpdateSubscriptionAddressError, type AccountUpdateSubscriptionAddressErrors, type AccountUpdateSubscriptionAddressResponse, type AccountUpdateSubscriptionAddressResponses, type AccountVerifyData, type AccountVerifyError, type AccountVerifyErrors, type AccountVerifyRequest, type AccountVerifyResponse, type AccountVerifyResponses, type AccountVerifyResult, type ActOnManageLinkData, type ActOnManageLinkError, type ActOnManageLinkErrors, type ActOnManageLinkResponse, type ActOnManageLinkResponses, type AdjustInventory, type AdjustVariantInventoryData, type AdjustVariantInventoryError, type AdjustVariantInventoryErrors, type AdjustVariantInventoryResponse, type AdjustVariantInventoryResponses, type AnalyticsBreakdown, type AnalyticsChannels, type AnalyticsFunnel, type AnalyticsFunnelInput, type AnalyticsFunnelPatch, type AnalyticsFunnelStepInput, type AnalyticsGoal, type AnalyticsGoalInput, type AnalyticsGoalList, type AnalyticsRealtime, type AnalyticsStatus, type AnalyticsSummary, type AnalyticsTimeseries, type AttachProductFileData, type AttachProductFileError, type AttachProductFileErrors, type AttachProductFileFromUrl, type AttachProductFileMultipart, type AttachProductFileResponse, type AttachProductFileResponses, type Attachment, type BusinessSummary, type CancelRetainerData, type CancelRetainerError, type CancelRetainerErrors, type CancelRetainerResponse, type CancelRetainerResponses, type CancelSubscriptionData, type CancelSubscriptionErrors, type CancelSubscriptionResponse, type CancelSubscriptionResponses, type CartCheckoutRequest, type CartConflict, type CartConflictItem, type CartSummaryRequest, type CartSummaryResult, type ChangedField, type CheckoutPauseRequest, type CheckoutPauseState, type CheckoutRequest, type CheckoutResult, type Client, type ClientOptions$1 as ClientConfig, type ClientOptions, type Config, type ConsentConfig, type ConsentConfigResult, type ConsentPrefs, type CreateAnalyticsFunnelData, type CreateAnalyticsFunnelErrors, type CreateAnalyticsFunnelResponse, type CreateAnalyticsFunnelResponses, type CreateAnalyticsGoalData, type CreateAnalyticsGoalErrors, type CreateAnalyticsGoalResponse, type CreateAnalyticsGoalResponses, type CreateCartCheckoutData, type CreateCartCheckoutError, type CreateCartCheckoutErrors, type CreateCartCheckoutResponse, type CreateCartCheckoutResponses, type CreateCheckoutData, type CreateCheckoutError, type CreateCheckoutErrors, type CreateCheckoutResponse, type CreateCheckoutResponses, type CreateCustomer, type CreateCustomerData, type CreateCustomerError, type CreateCustomerErrors, type CreateCustomerResponse, type CreateCustomerResponses, type CreateEventDestination, type CreateEventDestinationData, type CreateEventDestinationError, type CreateEventDestinationErrors, type CreateEventDestinationResponse, type CreateEventDestinationResponses, type CreateEventDestinationWithSiteTokenData, type CreateEventDestinationWithSiteTokenError, type CreateEventDestinationWithSiteTokenErrors, type CreateEventDestinationWithSiteTokenResponse, type CreateEventDestinationWithSiteTokenResponses, type CreateForm, type CreateFormData, type CreateFormError, type CreateFormErrors, type CreateFormResponse, type CreateFormResponses, type CreateFormWithSiteTokenData, type CreateFormWithSiteTokenError, type CreateFormWithSiteTokenErrors, type CreateFormWithSiteTokenResponse, type CreateFormWithSiteTokenResponses, type CreateInvoice, type CreateInvoiceData, type CreateInvoiceError, type CreateInvoiceErrors, type CreateInvoiceLine, type CreateInvoiceResponse, type CreateInvoiceResponses, type CreateInvoiceResult, type CreateMultiItemTestOrder, type CreateMultiItemTestOrderData, type CreateMultiItemTestOrderError, type CreateMultiItemTestOrderErrors, type CreateMultiItemTestOrderResponse, type CreateMultiItemTestOrderResponses, type CreateOption, type CreateOptionData, type CreateOptionError, type CreateOptionErrors, type CreateOptionResponse, type CreateOptionResponses, type CreatePreviewSession, type CreatePreviewSessionData, type CreatePreviewSessionError, type CreatePreviewSessionErrors, type CreatePreviewSessionResponse, type CreatePreviewSessionResponses, type CreateProduct, type CreateProductData, type CreateProductError, type CreateProductErrors, type CreateProductResponse, type CreateProductResponses, type CreateProductReviewData, type CreateProductReviewError, type CreateProductReviewErrors, type CreateProductReviewResponse, type CreateProductReviewResponses, type CreateProductWithSiteTokenData, type CreateProductWithSiteTokenError, type CreateProductWithSiteTokenErrors, type CreateProductWithSiteTokenResponse, type CreateProductWithSiteTokenResponses, type CreatePromo, type CreatePromoData, type CreatePromoError, type CreatePromoErrors, type CreatePromoForSiteData, type CreatePromoForSiteError, type CreatePromoForSiteErrors, type CreatePromoForSiteResponse, type CreatePromoForSiteResponses, type CreatePromoResponse, type CreatePromoResponses, type CreateRetainer, type CreateRetainerData, type CreateRetainerError, type CreateRetainerErrors, type CreateRetainerResponse, type CreateRetainerResponses, type CreateRetainerResult, type CreateSite, type CreateSiteData, type CreateSiteError, type CreateSiteErrors, type CreateSiteResponse, type CreateSiteResponses, type CreateTestOrder, type CreateTestOrderData, type CreateTestOrderError, type CreateTestOrderErrors, type CreateTestOrderResponse, type CreateTestOrderResponses, type CreateTestSubscription, type CreateTestSubscriptionData, type CreateTestSubscriptionError, type CreateTestSubscriptionErrors, type CreateTestSubscriptionResponse, type CreateTestSubscriptionResponses, type CreateVariant, type CreateVariantData, type CreateVariantError, type CreateVariantErrors, type CreateVariantResponse, type CreateVariantResponses, type CurrencyRestatement, type CurrencyTotals, type Customer, type CustomerAddress, type CustomerBilling, type CustomerDetail, type CustomersList, type DeleteAnalyticsFunnelData, type DeleteAnalyticsFunnelErrors, type DeleteAnalyticsFunnelResponse, type DeleteAnalyticsFunnelResponses, type DeleteAnalyticsGoalData, type DeleteAnalyticsGoalErrors, type DeleteAnalyticsGoalResponse, type DeleteAnalyticsGoalResponses, type DeleteEventDestinationData, type DeleteEventDestinationError, type DeleteEventDestinationErrors, type DeleteEventDestinationResponse, type DeleteEventDestinationResponses, type DeleteEventDestinationWithSiteTokenData, type DeleteEventDestinationWithSiteTokenError, type DeleteEventDestinationWithSiteTokenErrors, type DeleteEventDestinationWithSiteTokenResponse, type DeleteEventDestinationWithSiteTokenResponses, type DeleteFormData, type DeleteFormError, type DeleteFormErrors, type DeleteFormResponse, type DeleteFormResponses, type DeleteOptionData, type DeleteOptionError, type DeleteOptionErrors, type DeleteOptionResponse, type DeleteOptionResponses, type DeleteProductData, type DeleteProductError, type DeleteProductErrors, type DeleteProductResponse, type DeleteProductResponses, type DeleteSiteData, type DeleteSiteError, type DeleteSiteErrors, type DeleteSiteResponse, type DeleteSiteResponses, type DeleteSubmissionData, type DeleteSubmissionError, type DeleteSubmissionErrors, type DeleteSubmissionResponse, type DeleteSubmissionResponses, type DeleteVariantData, type DeleteVariantError, type DeleteVariantErrors, type DeleteVariantResponse, type DeleteVariantResponses, type DisablePromoData, type DisablePromoError, type DisablePromoErrors, type DisablePromoForSiteData, type DisablePromoForSiteError, type DisablePromoForSiteErrors, type DisablePromoForSiteResponse, type DisablePromoForSiteResponses, type DisablePromoResponse, type DisablePromoResponses, type DownloadAttachmentData, type DownloadAttachmentError, type DownloadAttachmentErrors, type DownloadAttachmentResponses, type DownloadFileData, type DownloadFileError, type DownloadFileErrors, type DownloadFileResponse, type DownloadFileResponses, type EditProductReviewData, type EditProductReviewError, type EditProductReviewErrors, type EditProductReviewResponse, type EditProductReviewResponses, type EmailDelivery, type EraseCustomerReviewsData, type EraseCustomerReviewsError, type EraseCustomerReviewsErrors, type EraseCustomerReviewsResponse, type EraseCustomerReviewsResponses, type Error, type EventDeliveriesList, type EventDelivery, type EventDestination, type EventDestinationSecret, type EventDestinationsList, type Form, type FormsList, type GenerateVariants, type GenerateVariantsData, type GenerateVariantsError, type GenerateVariantsErrors, type GenerateVariantsResponse, type GenerateVariantsResponses, type GenerateVariantsResult, type GeoSuggestion, type GetAccountReviewsData, type GetAccountReviewsError, type GetAccountReviewsErrors, type GetAccountReviewsResponse, type GetAccountReviewsResponses, type GetAnalyticsBrowsersData, type GetAnalyticsBrowsersErrors, type GetAnalyticsBrowsersResponse, type GetAnalyticsBrowsersResponses, type GetAnalyticsCampaignsData, type GetAnalyticsCampaignsErrors, type GetAnalyticsCampaignsResponse, type GetAnalyticsCampaignsResponses, type GetAnalyticsChannelsData, type GetAnalyticsChannelsErrors, type GetAnalyticsChannelsResponse, type GetAnalyticsChannelsResponses, type GetAnalyticsCitiesData, type GetAnalyticsCitiesErrors, type GetAnalyticsCitiesResponse, type GetAnalyticsCitiesResponses, type GetAnalyticsConversionsData, type GetAnalyticsConversionsErrors, type GetAnalyticsConversionsResponse, type GetAnalyticsConversionsResponses, type GetAnalyticsCountriesData, type GetAnalyticsCountriesErrors, type GetAnalyticsCountriesResponse, type GetAnalyticsCountriesResponses, type GetAnalyticsDevicesData, type GetAnalyticsDevicesErrors, type GetAnalyticsDevicesResponse, type GetAnalyticsDevicesResponses, type GetAnalyticsEntryPagesData, type GetAnalyticsEntryPagesErrors, type GetAnalyticsEntryPagesResponse, type GetAnalyticsEntryPagesResponses, type GetAnalyticsExitPagesData, type GetAnalyticsExitPagesErrors, type GetAnalyticsExitPagesResponse, type GetAnalyticsExitPagesResponses, type GetAnalyticsFunnelReportData, type GetAnalyticsFunnelReportErrors, type GetAnalyticsFunnelReportResponse, type GetAnalyticsFunnelReportResponses, type GetAnalyticsOperatingSystemsData, type GetAnalyticsOperatingSystemsErrors, type GetAnalyticsOperatingSystemsResponse, type GetAnalyticsOperatingSystemsResponses, type GetAnalyticsPagesData, type GetAnalyticsPagesErrors, type GetAnalyticsPagesResponse, type GetAnalyticsPagesResponses, type GetAnalyticsRealtimeData, type GetAnalyticsRealtimeErrors, type GetAnalyticsRealtimeResponse, type GetAnalyticsRealtimeResponses, type GetAnalyticsRegionsData, type GetAnalyticsRegionsErrors, type GetAnalyticsRegionsResponse, type GetAnalyticsRegionsResponses, type GetAnalyticsSourcesData, type GetAnalyticsSourcesErrors, type GetAnalyticsSourcesResponse, type GetAnalyticsSourcesResponses, type GetAnalyticsStatusData, type GetAnalyticsStatusErrors, type GetAnalyticsStatusResponse, type GetAnalyticsStatusResponses, type GetAnalyticsSummaryData, type GetAnalyticsSummaryErrors, type GetAnalyticsSummaryResponse, type GetAnalyticsSummaryResponses, type GetAnalyticsTimeseriesData, type GetAnalyticsTimeseriesErrors, type GetAnalyticsTimeseriesResponse, type GetAnalyticsTimeseriesResponses, type GetAnalyticsUtmCampaignData, type GetAnalyticsUtmCampaignErrors, type GetAnalyticsUtmCampaignResponse, type GetAnalyticsUtmCampaignResponses, type GetAnalyticsUtmContentData, type GetAnalyticsUtmContentErrors, type GetAnalyticsUtmContentResponse, type GetAnalyticsUtmContentResponses, type GetAnalyticsUtmMediumData, type GetAnalyticsUtmMediumErrors, type GetAnalyticsUtmMediumResponse, type GetAnalyticsUtmMediumResponses, type GetAnalyticsUtmSourceData, type GetAnalyticsUtmSourceErrors, type GetAnalyticsUtmSourceResponse, type GetAnalyticsUtmSourceResponses, type GetAnalyticsUtmTermData, type GetAnalyticsUtmTermErrors, type GetAnalyticsUtmTermResponse, type GetAnalyticsUtmTermResponses, type GetBusinessSummaryData, type GetBusinessSummaryErrors, type GetBusinessSummaryResponse, type GetBusinessSummaryResponses, type GetCartSummaryData, type GetCartSummaryError, type GetCartSummaryErrors, type GetCartSummaryResponse, type GetCartSummaryResponses, type GetConsentConfigWithSiteTokenData, type GetConsentConfigWithSiteTokenError, type GetConsentConfigWithSiteTokenErrors, type GetConsentConfigWithSiteTokenResponse, type GetConsentConfigWithSiteTokenResponses, type GetCustomerData, type GetCustomerError, type GetCustomerErrors, type GetCustomerResponse, type GetCustomerResponses, type GetEventDestinationData, type GetEventDestinationError, type GetEventDestinationErrors, type GetEventDestinationResponse, type GetEventDestinationResponses, type GetEventDestinationSecretData, type GetEventDestinationSecretError, type GetEventDestinationSecretErrors, type GetEventDestinationSecretResponse, type GetEventDestinationSecretResponses, type GetEventDestinationSecretWithSiteTokenData, type GetEventDestinationSecretWithSiteTokenError, type GetEventDestinationSecretWithSiteTokenErrors, type GetEventDestinationSecretWithSiteTokenResponse, type GetEventDestinationSecretWithSiteTokenResponses, type GetFormData, type GetFormError, type GetFormErrors, type GetFormResponse, type GetFormResponses, type GetGeoData, type GetGeoError, type GetGeoErrors, type GetGeoResponse, type GetGeoResponses, type GetInvoiceData, type GetInvoiceError, type GetInvoiceErrors, type GetInvoicePreviewData, type GetInvoicePreviewError, type GetInvoicePreviewErrors, type GetInvoicePreviewResponse, type GetInvoicePreviewResponses, type GetInvoiceResponse, type GetInvoiceResponses, type GetInvoiceSettingsData, type GetInvoiceSettingsError, type GetInvoiceSettingsErrors, type GetInvoiceSettingsResponse, type GetInvoiceSettingsResponses, type GetInvoiceSettingsWithSiteTokenData, type GetInvoiceSettingsWithSiteTokenError, type GetInvoiceSettingsWithSiteTokenErrors, type GetInvoiceSettingsWithSiteTokenResponse, type GetInvoiceSettingsWithSiteTokenResponses, type GetMerchantReviewData, type GetMerchantReviewError, type GetMerchantReviewErrors, type GetMerchantReviewResponse, type GetMerchantReviewResponses, type GetNextPayoutData, type GetNextPayoutErrors, type GetNextPayoutResponse, type GetNextPayoutResponses, type GetOrderData, type GetOrderError, type GetOrderErrors, type GetOrderResponse, type GetOrderResponses, type GetOrderSessionData, type GetOrderSessionError, type GetOrderSessionErrors, type GetOrderSessionResponse, type GetOrderSessionResponses, type GetOwnProductReviewData, type GetOwnProductReviewError, type GetOwnProductReviewErrors, type GetOwnProductReviewResponse, type GetOwnProductReviewResponses, type GetPaymentsStatusData, type GetPaymentsStatusError, type GetPaymentsStatusErrors, type GetPaymentsStatusResponse, type GetPaymentsStatusResponses, type GetPersonData, type GetPersonErrors, type GetPersonResponse, type GetPersonResponses, type GetProductData, type GetProductError, type GetProductErrors, type GetProductResponse, type GetProductResponses, type GetProductReviewAvailabilityData, type GetProductReviewAvailabilityError, type GetProductReviewAvailabilityErrors, type GetProductReviewAvailabilityResponse, type GetProductReviewAvailabilityResponses, type GetProductReviewsData, type GetProductReviewsError, type GetProductReviewsErrors, type GetProductReviewsResponse, type GetProductReviewsResponses, type GetPromoData, type GetPromoError, type GetPromoErrors, type GetPromoForSiteData, type GetPromoForSiteError, type GetPromoForSiteErrors, type GetPromoForSiteResponse, type GetPromoForSiteResponses, type GetPromoResponse, type GetPromoResponses, type GetPublicConsentPrefsData, type GetPublicConsentPrefsError, type GetPublicConsentPrefsErrors, type GetPublicConsentPrefsResponse, type GetPublicConsentPrefsResponses, type GetPublicProductData, type GetPublicProductError, type GetPublicProductErrors, type GetPublicProductResponse, type GetPublicProductResponses, type GetRetainerData, type GetRetainerError, type GetRetainerErrors, type GetRetainerResponse, type GetRetainerResponses, type GetReviewSettingsData, type GetReviewSettingsError, type GetReviewSettingsErrors, type GetReviewSettingsResponse, type GetReviewSettingsResponses, type GetSalesSummaryData, type GetSalesSummaryErrors, type GetSalesSummaryResponse, type GetSalesSummaryResponses, type GetSiteAnalyticsData, type GetSiteAnalyticsError, type GetSiteAnalyticsErrors, type GetSiteAnalyticsResponse, type GetSiteAnalyticsResponses, type GetSiteCheckoutPauseData, type GetSiteCheckoutPauseError, type GetSiteCheckoutPauseErrors, type GetSiteCheckoutPauseResponse, type GetSiteCheckoutPauseResponses, type GetSiteData, type GetSiteError, type GetSiteErrors, type GetSiteResponse, type GetSiteResponses, type GetSubmissionData, type GetSubmissionError, type GetSubmissionErrors, type GetSubmissionResponse, type GetSubmissionResponses, type Inventory, type InventoryInput, type Invoice, type InvoiceAggregates, type InvoiceBillTo, type InvoiceError, type InvoiceLineItem, type InvoicePreview, type InvoiceSettings, type InvoiceSiteBody, type InvoicesList, type ListAnalyticsFunnelsData, type ListAnalyticsFunnelsErrors, type ListAnalyticsFunnelsResponse, type ListAnalyticsFunnelsResponses, type ListAnalyticsGoalsData, type ListAnalyticsGoalsErrors, type ListAnalyticsGoalsResponse, type ListAnalyticsGoalsResponses, type ListCustomersData, type ListCustomersError, type ListCustomersErrors, type ListCustomersResponse, type ListCustomersResponses, type ListEventDeliveriesData, type ListEventDeliveriesError, type ListEventDeliveriesErrors, type ListEventDeliveriesResponse, type ListEventDeliveriesResponses, type ListEventDeliveriesWithSiteTokenData, type ListEventDeliveriesWithSiteTokenError, type ListEventDeliveriesWithSiteTokenErrors, type ListEventDeliveriesWithSiteTokenResponse, type ListEventDeliveriesWithSiteTokenResponses, type ListEventDestinationsData, type ListEventDestinationsError, type ListEventDestinationsErrors, type ListEventDestinationsResponse, type ListEventDestinationsResponses, type ListEventDestinationsWithSiteTokenData, type ListEventDestinationsWithSiteTokenError, type ListEventDestinationsWithSiteTokenErrors, type ListEventDestinationsWithSiteTokenResponse, type ListEventDestinationsWithSiteTokenResponses, type ListFormsData, type ListFormsError, type ListFormsErrors, type ListFormsResponse, type ListFormsResponses, type ListFormsWithSiteTokenData, type ListFormsWithSiteTokenError, type ListFormsWithSiteTokenErrors, type ListFormsWithSiteTokenResponse, type ListFormsWithSiteTokenResponses, type ListInvoicesData, type ListInvoicesError, type ListInvoicesErrors, type ListInvoicesResponse, type ListInvoicesResponses, type ListMerchantReviewsData, type ListMerchantReviewsError, type ListMerchantReviewsErrors, type ListMerchantReviewsResponse, type ListMerchantReviewsResponses, type ListOrdersWithSiteTokenData, type ListOrdersWithSiteTokenError, type ListOrdersWithSiteTokenErrors, type ListOrdersWithSiteTokenResponse, type ListOrdersWithSiteTokenResponses, type ListPeopleData, type ListPeopleErrors, type ListPeopleResponse, type ListPeopleResponses, type ListProductsData, type ListProductsError, type ListProductsErrors, type ListProductsResponse, type ListProductsResponses, type ListProductsWithSiteTokenData, type ListProductsWithSiteTokenError, type ListProductsWithSiteTokenErrors, type ListProductsWithSiteTokenResponse, type ListProductsWithSiteTokenResponses, type ListPromosData, type ListPromosError, type ListPromosErrors, type ListPromosForSiteData, type ListPromosForSiteError, type ListPromosForSiteErrors, type ListPromosForSiteResponse, type ListPromosForSiteResponses, type ListPromosResponse, type ListPromosResponses, type ListRetainersData, type ListRetainersError, type ListRetainersErrors, type ListRetainersResponse, type ListRetainersResponses, type ListSitesData, type ListSitesError, type ListSitesErrors, type ListSitesResponse, type ListSitesResponses, type ListSubmissionsData, type ListSubmissionsError, type ListSubmissionsErrors, type ListSubmissionsResponse, type ListSubmissionsResponses, type ListSubscriptionsData, type ListSubscriptionsErrors, type ListSubscriptionsResponse, type ListSubscriptionsResponses, type ManageCancelResult, type ManageLinkAction, type ManageVerifyRequest, type ManageVerifyResult, type ManagedSubscription, type ManagedSubscriptionResult, type MarkInvoicePaid, type MarkInvoicePaidData, type MarkInvoicePaidError, type MarkInvoicePaidErrors, type MarkInvoicePaidResponse, type MarkInvoicePaidResponses, type MarkInvoicePaidResult, type MarkInvoiceUncollectibleData, type MarkInvoiceUncollectibleError, type MarkInvoiceUncollectibleErrors, type MarkInvoiceUncollectibleResponse, type MarkInvoiceUncollectibleResponses, type ModerateMerchantReviewData, type ModerateMerchantReviewError, type ModerateMerchantReviewErrors, type ModerateMerchantReviewResponse, type ModerateMerchantReviewResponses, type NeedsAttentionItem, type NestedOptionInput, type NestedVariantInput, type NextPayout, type Option, type Options, type Order, type OrderCustomer, type OrderFulfillmentRequest, type OrderSessionStatus, type OrdersList, type OwnProductReview, type PauseRetainerData, type PauseRetainerError, type PauseRetainerErrors, type PauseRetainerResponse, type PauseRetainerResponses, type PauseSiteCheckoutData, type PauseSiteCheckoutError, type PauseSiteCheckoutErrors, type PauseSiteCheckoutResponse, type PauseSiteCheckoutResponses, type PaymentsStatus, type PeopleList, type PersonDetail, type PersonRow, type PortalSessionResult, type PreviewInvoice, type PreviewInvoiceData, type PreviewInvoiceError, type PreviewInvoiceErrors, type PreviewInvoiceResponse, type PreviewInvoiceResponses, type PreviewSessionResult, type Product, type ProductDetail, type ProductFulfillment, type ProductFulfillmentInput, type ProductReview, type ProductSubscriptionConfig, type ProductsList, type Promo, type PromoError, type PromosList, type PublicOption, type PublicProduct, type PublicSubscription, type PublicSubscriptionPlan, type PublicVariant, type PurgeSiteReviewsData, type PurgeSiteReviewsError, type PurgeSiteReviewsErrors, type PurgeSiteReviewsResponse, type PurgeSiteReviewsResponses, type ReactivateSiteSubscriptionsTeardownData, type ReactivateSiteSubscriptionsTeardownError, type ReactivateSiteSubscriptionsTeardownErrors, type ReactivateSiteSubscriptionsTeardownResponse, type ReactivateSiteSubscriptionsTeardownResponses, type RecipientCooldownError, type ReconcileOptionInput, type ReconcileOptionValueInput, type ReconcileVariantInput, type RefundOrder, type RefundOrderData, type RefundOrderError, type RefundOrderErrors, type RefundOrderResponse, type RefundOrderResponses, type RefundResult, type ReissueResult, type RemindInvoiceData, type RemindInvoiceError, type RemindInvoiceErrors, type RemindInvoiceResponse, type RemindInvoiceResponses, type RemindInvoiceResult, type ReplacePromoData, type ReplacePromoError, type ReplacePromoErrors, type ReplacePromoForSiteData, type ReplacePromoForSiteError, type ReplacePromoForSiteErrors, type ReplacePromoForSiteResponse, type ReplacePromoForSiteResponses, type ReplacePromoResponse, type ReplacePromoResponses, type ReplyToMerchantReviewData, type ReplyToMerchantReviewError, type ReplyToMerchantReviewErrors, type ReplyToMerchantReviewResponse, type ReplyToMerchantReviewResponses, type ResendInvoiceData, type ResendInvoiceError, type ResendInvoiceErrors, type ResendInvoiceResponse, type ResendInvoiceResponses, type ResendOrderReceiptData, type ResendOrderReceiptError, type ResendOrderReceiptErrors, type ResendOrderReceiptResponse, type ResendOrderReceiptResponses, type ResendReceiptResult, type ResetOrderDownloadsData, type ResetOrderDownloadsError, type ResetOrderDownloadsErrors, type ResetOrderDownloadsResponse, type ResetOrderDownloadsResponses, type ResetWebhookEventData, type ResetWebhookEventError, type ResetWebhookEventErrors, type ResetWebhookEventResponse, type ResetWebhookEventResponses, type ResolveManageLinkData, type ResolveManageLinkError, type ResolveManageLinkErrors, type ResolveManageLinkResponse, type ResolveManageLinkResponses, type ResubmitProductReviewData, type ResubmitProductReviewError, type ResubmitProductReviewErrors, type ResubmitProductReviewResponse, type ResubmitProductReviewResponses, type ResumeRetainerData, type ResumeRetainerError, type ResumeRetainerErrors, type ResumeRetainerResponse, type ResumeRetainerResponses, type Retainer, type RetainerError, type RetainerSiteBody, type RetainersList, type RetryEventDeliveryData, type RetryEventDeliveryError, type RetryEventDeliveryErrors, type RetryEventDeliveryResponse, type RetryEventDeliveryResponses, type RetryEventDeliveryWithSiteTokenData, type RetryEventDeliveryWithSiteTokenError, type RetryEventDeliveryWithSiteTokenErrors, type RetryEventDeliveryWithSiteTokenResponse, type RetryEventDeliveryWithSiteTokenResponses, type ReviewReadiness, type RevokeCustomerAccessData, type RevokeCustomerAccessError, type RevokeCustomerAccessErrors, type RevokeCustomerAccessResponse, type RevokeCustomerAccessResponses, type RevokeCustomerAccessResult, type RotateEventDestinationSecretData, type RotateEventDestinationSecretError, type RotateEventDestinationSecretErrors, type RotateEventDestinationSecretResponse, type RotateEventDestinationSecretResponses, type RotateEventDestinationSecretWithSiteTokenData, type RotateEventDestinationSecretWithSiteTokenError, type RotateEventDestinationSecretWithSiteTokenErrors, type RotateEventDestinationSecretWithSiteTokenResponse, type RotateEventDestinationSecretWithSiteTokenResponses, type SalesSummary, type SalesSummaryProductRow, type SalesSummarySeriesEntry, type SetInventory, type SetInvoiceReminders, type SetInvoiceRemindersData, type SetInvoiceRemindersError, type SetInvoiceRemindersErrors, type SetInvoiceRemindersResponse, type SetInvoiceRemindersResponses, type SetOrderFulfillmentData, type SetOrderFulfillmentErrors, type SetOrderFulfillmentResponse, type SetOrderFulfillmentResponses, type SetProductSubscription, type SetProductSubscriptionData, type SetProductSubscriptionError, type SetProductSubscriptionErrors, type SetProductSubscriptionResponse, type SetProductSubscriptionResponses, type SetProductVariants, type SetProductVariantsConflict, type SetProductVariantsData, type SetProductVariantsError, type SetProductVariantsErrors, type SetProductVariantsResponse, type SetProductVariantsResponses, type SetProductVariantsResult, type SetVariantInventoryData, type SetVariantInventoryError, type SetVariantInventoryErrors, type SetVariantInventoryResponse, type SetVariantInventoryResponses, type SettledTotals, type ShippingOptionUnavailable, type ShippingRateInput, type Site, type SiteAccountRoute, type SiteAnalytics, type SiteDomains, type SitePayments, type SiteWithRestatement, type SiteWithToken, type SitesList, type SkipNextRetainerCycleData, type SkipNextRetainerCycleError, type SkipNextRetainerCycleErrors, type SkipNextRetainerCycleResponse, type SkipNextRetainerCycleResponses, type SnoozeInvoice, type SnoozeInvoiceData, type SnoozeInvoiceError, type SnoozeInvoiceErrors, type SnoozeInvoiceResponse, type SnoozeInvoiceResponses, type Submission, type SubmissionMetadata, type SubmissionsList, type SubscriberActionResult, type SubscriberSubscription, type SubscriptionPlan, type SubscriptionPlanInput, type SubscriptionSummary, type SubscriptionsList, type SubscriptionsReactivateBody, type SubscriptionsReactivateResult, type SubscriptionsTeardownBody, type SubscriptionsTeardownResult, type SummaryPeriod, type TeardownReason, type TeardownSiteSubscriptionsData, type TeardownSiteSubscriptionsError, type TeardownSiteSubscriptionsErrors, type TeardownSiteSubscriptionsResponse, type TeardownSiteSubscriptionsResponses, type TestOrderResult, type TestShippingAddress, type TestSubscriptionResult, type UpdateAnalyticsFunnelData, type UpdateAnalyticsFunnelErrors, type UpdateAnalyticsFunnelResponse, type UpdateAnalyticsFunnelResponses, type UpdateAnalyticsGoalData, type UpdateAnalyticsGoalErrors, type UpdateAnalyticsGoalResponse, type UpdateAnalyticsGoalResponses, type UpdateCustomer, type UpdateCustomerBilling, type UpdateCustomerBillingData, type UpdateCustomerBillingError, type UpdateCustomerBillingErrors, type UpdateCustomerBillingResponse, type UpdateCustomerBillingResponses, type UpdateCustomerData, type UpdateCustomerError, type UpdateCustomerErrors, type UpdateCustomerResponse, type UpdateCustomerResponses, type UpdateEventDestination, type UpdateEventDestinationData, type UpdateEventDestinationError, type UpdateEventDestinationErrors, type UpdateEventDestinationResponse, type UpdateEventDestinationResponses, type UpdateEventDestinationWithSiteTokenData, type UpdateEventDestinationWithSiteTokenError, type UpdateEventDestinationWithSiteTokenErrors, type UpdateEventDestinationWithSiteTokenResponse, type UpdateEventDestinationWithSiteTokenResponses, type UpdateForm, type UpdateFormData, type UpdateFormError, type UpdateFormErrors, type UpdateFormResponse, type UpdateFormResponses, type UpdateInvoiceRecipient, type UpdateInvoiceRecipientData, type UpdateInvoiceRecipientError, type UpdateInvoiceRecipientErrors, type UpdateInvoiceRecipientResponse, type UpdateInvoiceRecipientResponses, type UpdateInvoiceSettings, type UpdateInvoiceSettingsData, type UpdateInvoiceSettingsError, type UpdateInvoiceSettingsErrors, type UpdateInvoiceSettingsResponse, type UpdateInvoiceSettingsResponses, type UpdateOption, type UpdateOptionData, type UpdateOptionError, type UpdateOptionErrors, type UpdateOptionResponse, type UpdateOptionResponses, type UpdateProduct, type UpdateProductData, type UpdateProductError, type UpdateProductErrors, type UpdateProductResponse, type UpdateProductResponses, type UpdateRecipientResult, type UpdateRetainer, type UpdateRetainerData, type UpdateRetainerError, type UpdateRetainerErrors, type UpdateRetainerResponse, type UpdateRetainerResponses, type UpdateReviewSettingsData, type UpdateReviewSettingsError, type UpdateReviewSettingsErrors, type UpdateReviewSettingsResponse, type UpdateReviewSettingsResponses, type UpdateSite, type UpdateSiteAccountRoute, type UpdateSiteAccountRouteData, type UpdateSiteAccountRouteError, type UpdateSiteAccountRouteErrors, type UpdateSiteAccountRouteResponse, type UpdateSiteAccountRouteResponses, type UpdateSiteAnalytics, type UpdateSiteAnalyticsData, type UpdateSiteAnalyticsError, type UpdateSiteAnalyticsErrors, type UpdateSiteAnalyticsResponse, type UpdateSiteAnalyticsResponses, type UpdateSiteData, type UpdateSiteDomains, type UpdateSiteDomainsData, type UpdateSiteDomainsError, type UpdateSiteDomainsErrors, type UpdateSiteDomainsResponse, type UpdateSiteDomainsResponses, type UpdateSiteError, type UpdateSiteErrors, type UpdateSiteInvoicing, type UpdateSiteInvoicingData, type UpdateSiteInvoicingError, type UpdateSiteInvoicingErrors, type UpdateSiteInvoicingResponse, type UpdateSiteInvoicingResponses, type UpdateSitePayments, type UpdateSitePaymentsData, type UpdateSitePaymentsError, type UpdateSitePaymentsErrors, type UpdateSitePaymentsResponse, type UpdateSitePaymentsResponses, type UpdateSiteResponse, type UpdateSiteResponses, type UpdateSubscriptionAddressRequest, type UpdateVariant, type UpdateVariantData, type UpdateVariantError, type UpdateVariantErrors, type UpdateVariantResponse, type UpdateVariantResponses, type UpsertConsentConfig, type UpsertConsentConfigWithSiteTokenData, type UpsertConsentConfigWithSiteTokenError, type UpsertConsentConfigWithSiteTokenErrors, type UpsertConsentConfigWithSiteTokenResponse, type UpsertConsentConfigWithSiteTokenResponses, type Variant, type VariantOptionValue, type VoidInvoice, type VoidInvoiceData, type VoidInvoiceError, type VoidInvoiceErrors, type VoidInvoiceResponse, type VoidInvoiceResponses, type VoidInvoiceResult, type WebhookEventResetResult, type WithdrawProductReviewData, type WithdrawProductReviewError, type WithdrawProductReviewErrors, type WithdrawProductReviewResponse, type WithdrawProductReviewResponses, accountCancelSubscription, accountCreatePortalSession, accountLogin, accountLogout, accountManageCancel, accountManageGetSubscription, accountManagePortalSession, accountManageVerify, accountMe, accountReactivateSubscription, accountSubscribe, accountUpdateSubscriptionAddress, accountVerify, actOnManageLink, adjustVariantInventory, attachProductFile, cancelRetainer, cancelSubscription, createAnalyticsFunnel, createAnalyticsGoal, createCartCheckout, createCheckout, createClient, createConfig, createCustomer, createEventDestination, createEventDestinationWithSiteToken, createForm, createFormWithSiteToken, createInvoice, createMultiItemTestOrder, createOption, createPreviewSession, createProduct, createProductReview, createProductWithSiteToken, createPromo, createPromoForSite, createRetainer, createSite, createTestOrder, createTestSubscription, createVariant, deleteAnalyticsFunnel, deleteAnalyticsGoal, deleteEventDestination, deleteEventDestinationWithSiteToken, deleteForm, deleteOption, deleteProduct, deleteSite, deleteSubmission, deleteVariant, disablePromo, disablePromoForSite, downloadAttachment, downloadFile, editProductReview, eraseCustomerReviews, generateVariants, getAccountReviews, getAnalyticsBrowsers, getAnalyticsCampaigns, getAnalyticsChannels, getAnalyticsCities, getAnalyticsConversions, getAnalyticsCountries, getAnalyticsDevices, getAnalyticsEntryPages, getAnalyticsExitPages, getAnalyticsFunnelReport, getAnalyticsOperatingSystems, getAnalyticsPages, getAnalyticsRealtime, getAnalyticsRegions, getAnalyticsSources, getAnalyticsStatus, getAnalyticsSummary, getAnalyticsTimeseries, getAnalyticsUtmCampaign, getAnalyticsUtmContent, getAnalyticsUtmMedium, getAnalyticsUtmSource, getAnalyticsUtmTerm, getBusinessSummary, getCartSummary, getConsentConfigWithSiteToken, getCustomer, getEventDestination, getEventDestinationSecret, getEventDestinationSecretWithSiteToken, getForm, getGeo, getInvoice, getInvoicePreview, getInvoiceSettings, getInvoiceSettingsWithSiteToken, getMerchantReview, getNextPayout, getOrder, getOrderSession, getOwnProductReview, getPaymentsStatus, getPerson, getProduct, getProductReviewAvailability, getProductReviews, getPromo, getPromoForSite, getPublicConsentPrefs, getPublicProduct, getRetainer, getReviewSettings, getSalesSummary, getSite, getSiteAnalytics, getSiteCheckoutPause, getSubmission, listAnalyticsFunnels, listAnalyticsGoals, listCustomers, listEventDeliveries, listEventDeliveriesWithSiteToken, listEventDestinations, listEventDestinationsWithSiteToken, listForms, listFormsWithSiteToken, listInvoices, listMerchantReviews, listOrdersWithSiteToken, listPeople, listProducts, listProductsWithSiteToken, listPromos, listPromosForSite, listRetainers, listSites, listSubmissions, listSubscriptions, markInvoicePaid, markInvoiceUncollectible, moderateMerchantReview, pauseRetainer, pauseSiteCheckout, previewInvoice, purgeSiteReviews, reactivateSiteSubscriptionsTeardown, refundOrder, remindInvoice, replacePromo, replacePromoForSite, replyToMerchantReview, resendInvoice, resendOrderReceipt, resetOrderDownloads, resetWebhookEvent, resolveManageLink, resubmitProductReview, resumeRetainer, retryEventDelivery, retryEventDeliveryWithSiteToken, revokeCustomerAccess, rotateEventDestinationSecret, rotateEventDestinationSecretWithSiteToken, setInvoiceReminders, setOrderFulfillment, setProductSubscription, setProductVariants, setVariantInventory, skipNextRetainerCycle, snoozeInvoice, teardownSiteSubscriptions, updateAnalyticsFunnel, updateAnalyticsGoal, updateCustomer, updateCustomerBilling, updateEventDestination, updateEventDestinationWithSiteToken, updateForm, updateInvoiceRecipient, updateInvoiceSettings, updateOption, updateProduct, updateRetainer, updateReviewSettings, updateSite, updateSiteAccountRoute, updateSiteAnalytics, updateSiteDomains, updateSiteInvoicing, updateSitePayments, updateVariant, upsertConsentConfigWithSiteToken, voidInvoice, withdrawProductReview };
|