@aifeatures/backend 0.7.1 → 0.8.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 +1164 -115
- package/dist/index.d.ts +1164 -115
- package/dist/index.js +5 -5
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -309,7 +309,7 @@ type Options$1<TData extends TDataShape = TDataShape, ThrowOnError extends boole
|
|
|
309
309
|
declare const createClient: (config?: Config) => Client;
|
|
310
310
|
|
|
311
311
|
type ClientOptions = {
|
|
312
|
-
baseUrl:
|
|
312
|
+
baseUrl: `${string}://${string}` | (string & {});
|
|
313
313
|
};
|
|
314
314
|
type SitePayments = {
|
|
315
315
|
site_id: string;
|
|
@@ -422,6 +422,13 @@ type Product = {
|
|
|
422
422
|
fulfillment: ProductFulfillment;
|
|
423
423
|
collect_shipping_address: boolean;
|
|
424
424
|
active: boolean;
|
|
425
|
+
/**
|
|
426
|
+
* Subscription configuration on catalog list/detail responses, including before Stripe setup. Plans are active selling plans in display order. required:true means checkout needs a selected plan_id. Missing configuration is unknown, not proof of one-time-only sales. Live checkout readiness is separate from this configuration.
|
|
427
|
+
*/
|
|
428
|
+
subscription?: {
|
|
429
|
+
required: boolean;
|
|
430
|
+
plans: Array<SubscriptionPlan>;
|
|
431
|
+
};
|
|
425
432
|
metadata: {
|
|
426
433
|
[key: string]: unknown;
|
|
427
434
|
};
|
|
@@ -802,6 +809,13 @@ type CreateTestSubscription = {
|
|
|
802
809
|
* Recorded as the subscriber (a test customer record is created/reused for it) and receives the [TEST]-labeled receipt. Defaults to the site owner's email.
|
|
803
810
|
*/
|
|
804
811
|
customer_email?: string;
|
|
812
|
+
/**
|
|
813
|
+
* Opaque passthrough stored on the order, exactly as the real checkout stores it — this is what the merchant sale email's details block renders. Same caps: max 20 keys, 40-char keys, 400-char string values, 4 KB serialized.
|
|
814
|
+
*/
|
|
815
|
+
metadata?: {
|
|
816
|
+
[key: string]: string;
|
|
817
|
+
};
|
|
818
|
+
shipping_address?: TestShippingAddress & unknown;
|
|
805
819
|
};
|
|
806
820
|
type CreateMultiItemTestOrder = {
|
|
807
821
|
/**
|
|
@@ -1376,9 +1390,28 @@ type BusinessSummary = {
|
|
|
1376
1390
|
}>;
|
|
1377
1391
|
};
|
|
1378
1392
|
/**
|
|
1379
|
-
*
|
|
1393
|
+
* The 7-day traffic tile, or null when the site has no analytics id or the source is unreachable. Null costs the merchant this tile and nothing else: the commerce figures beside it are unaffected by a Tinybird outage.
|
|
1380
1394
|
*/
|
|
1381
|
-
visitors:
|
|
1395
|
+
visitors: {
|
|
1396
|
+
/**
|
|
1397
|
+
* DISTINCT visitors over the whole window — NOT the sum of `sparkline`, which double-counts anyone who visited on more than one day.
|
|
1398
|
+
*/
|
|
1399
|
+
d7: number;
|
|
1400
|
+
/**
|
|
1401
|
+
* One entry per local day in the window, zero-filled — days with no traffic are present with 0 rather than omitted.
|
|
1402
|
+
*/
|
|
1403
|
+
sparkline: Array<{
|
|
1404
|
+
date: string;
|
|
1405
|
+
visitors: number;
|
|
1406
|
+
}>;
|
|
1407
|
+
/**
|
|
1408
|
+
* Half-open, whole local days in the site's reporting timezone — the same window `GET /analytics/summary?period=7` resolves, so the two surfaces cannot disagree.
|
|
1409
|
+
*/
|
|
1410
|
+
window: {
|
|
1411
|
+
from: string;
|
|
1412
|
+
to: string;
|
|
1413
|
+
};
|
|
1414
|
+
} | null;
|
|
1382
1415
|
};
|
|
1383
1416
|
type SalesSummarySeriesEntry = {
|
|
1384
1417
|
date: string;
|
|
@@ -1532,6 +1565,146 @@ type OrderFulfillmentRequest = {
|
|
|
1532
1565
|
*/
|
|
1533
1566
|
tracking_number?: string;
|
|
1534
1567
|
};
|
|
1568
|
+
type AnalyticsStatus = {
|
|
1569
|
+
/**
|
|
1570
|
+
* Whether this site can collect at all — it has an analytics identity. False means no events will ever arrive until one is minted and a publish embeds it, which is a different state from 'collecting but no traffic yet'.
|
|
1571
|
+
*/
|
|
1572
|
+
collecting: boolean;
|
|
1573
|
+
analytics_id: string | null;
|
|
1574
|
+
/**
|
|
1575
|
+
* The IANA zone reports are bucketed and bounded in. Always usable: falls back to UTC when the site has none stored.
|
|
1576
|
+
*/
|
|
1577
|
+
timezone: string;
|
|
1578
|
+
/**
|
|
1579
|
+
* True when the zone above is the UTC fallback rather than a stored value, so the panel can say reports are in UTC rather than implying the merchant chose it.
|
|
1580
|
+
*/
|
|
1581
|
+
timezone_defaulted: boolean;
|
|
1582
|
+
/**
|
|
1583
|
+
* ISO timestamp of the earliest event ever recorded for this site, or null if nothing has been collected. Distinguishes 'collecting, no traffic yet' from 'not collecting'. Also bounds which period-over-period deltas are honest (R15). READ IT WITH `first_seen_unavailable`: null alone does not mean nothing was ever collected.
|
|
1584
|
+
*/
|
|
1585
|
+
first_seen: string | null;
|
|
1586
|
+
/**
|
|
1587
|
+
* True when the first-seen lookup itself FAILED, so `first_seen` is null because we could not ask rather than because nothing has arrived. The two are opposite claims: one says the pipeline is healthy and idle, the other says we do not know. A client that treats an unavailable lookup as 'no traffic yet' will hide working reports behind a reassuring empty state.
|
|
1588
|
+
*/
|
|
1589
|
+
first_seen_unavailable: boolean;
|
|
1590
|
+
/**
|
|
1591
|
+
* True when the first recorded event falls inside the window the reports actually cover. Reports end at the most recent local midnight and so cover COMPLETE DAYS ONLY, which means a site whose first visit arrived today has a real first_seen and yet cannot appear in any summary, chart or breakdown until the next local midnight. Without this flag a client reads non-null first_seen as 'there is data to show' and renders a wall of zeros as the site's traffic on its opening day. Computed here because the window it is asking about is resolved here.
|
|
1592
|
+
*/
|
|
1593
|
+
first_seen_in_reports: boolean;
|
|
1594
|
+
};
|
|
1595
|
+
type AnalyticsSummary = {
|
|
1596
|
+
status: "ok";
|
|
1597
|
+
data: {
|
|
1598
|
+
current: {
|
|
1599
|
+
visitors: number;
|
|
1600
|
+
visits: number;
|
|
1601
|
+
pageviews: number;
|
|
1602
|
+
views_per_visit: number;
|
|
1603
|
+
/**
|
|
1604
|
+
* Fraction in [0,1].
|
|
1605
|
+
*/
|
|
1606
|
+
bounce_rate: number;
|
|
1607
|
+
visit_duration_seconds: number;
|
|
1608
|
+
};
|
|
1609
|
+
/**
|
|
1610
|
+
* The immediately preceding same-length window, or null when it is not fully covered by collection (its start predates first_seen). Partial coverage suppresses the delta exactly as absent coverage does: a window one-seventh covered produces a confident wrong delta, which is worse than no delta.
|
|
1611
|
+
*/
|
|
1612
|
+
previous: {
|
|
1613
|
+
visitors: number;
|
|
1614
|
+
visits: number;
|
|
1615
|
+
pageviews: number;
|
|
1616
|
+
views_per_visit: number;
|
|
1617
|
+
/**
|
|
1618
|
+
* Fraction in [0,1].
|
|
1619
|
+
*/
|
|
1620
|
+
bounce_rate: number;
|
|
1621
|
+
visit_duration_seconds: number;
|
|
1622
|
+
} | null;
|
|
1623
|
+
};
|
|
1624
|
+
/**
|
|
1625
|
+
* The half-open UTC window the values were measured over: from inclusive, to exclusive. Resolved from the site's reporting timezone.
|
|
1626
|
+
*/
|
|
1627
|
+
window: {
|
|
1628
|
+
from: string;
|
|
1629
|
+
to: string;
|
|
1630
|
+
};
|
|
1631
|
+
} | {
|
|
1632
|
+
status: "unreachable";
|
|
1633
|
+
};
|
|
1634
|
+
type AnalyticsTimeseries = {
|
|
1635
|
+
status: "ok";
|
|
1636
|
+
/**
|
|
1637
|
+
* One row per local day WITH traffic; empty days are omitted rather than zero-filled, so the client decides how to render a gap.
|
|
1638
|
+
*/
|
|
1639
|
+
data: Array<{
|
|
1640
|
+
date: string;
|
|
1641
|
+
visitors: number;
|
|
1642
|
+
visits: number;
|
|
1643
|
+
pageviews: number;
|
|
1644
|
+
/**
|
|
1645
|
+
* Pageviews per visit over the visits this day owns. Deliberately NOT pageviews/visits from this same row: pageviews is event-scoped and counts pageviews belonging to a visit that started the day before, so dividing the two adjacent fields averages a numerator and a denominator describing different visits.
|
|
1646
|
+
*/
|
|
1647
|
+
views_per_visit: number;
|
|
1648
|
+
/**
|
|
1649
|
+
* Fraction in [0,1] of the day's visits that saw a single page.
|
|
1650
|
+
*/
|
|
1651
|
+
bounce_rate: number;
|
|
1652
|
+
/**
|
|
1653
|
+
* Mean visit length in seconds, over the visits this day owns.
|
|
1654
|
+
*/
|
|
1655
|
+
visit_duration_seconds: number;
|
|
1656
|
+
}>;
|
|
1657
|
+
/**
|
|
1658
|
+
* The half-open UTC window the values were measured over: from inclusive, to exclusive. Resolved from the site's reporting timezone.
|
|
1659
|
+
*/
|
|
1660
|
+
window: {
|
|
1661
|
+
from: string;
|
|
1662
|
+
to: string;
|
|
1663
|
+
};
|
|
1664
|
+
/**
|
|
1665
|
+
* The IANA zone these dates are bucketed in. Carried on the payload so the client never has to pair it with a separate /status call: the window bounds are UTC instants standing for LOCAL midnights, so a client that zero-fills the calendar in the wrong zone silently shifts a site east of UTC by a day. Same value /status reports.
|
|
1666
|
+
*/
|
|
1667
|
+
timezone: string;
|
|
1668
|
+
} | {
|
|
1669
|
+
status: "unreachable";
|
|
1670
|
+
};
|
|
1671
|
+
type AnalyticsRealtime = {
|
|
1672
|
+
status: "ok";
|
|
1673
|
+
data: {
|
|
1674
|
+
current_visitors: number;
|
|
1675
|
+
};
|
|
1676
|
+
/**
|
|
1677
|
+
* When this count was taken. Realtime sits OUTSIDE the historical window, so it carries an as-of instant rather than a window — and the panel shows that freshness, because a stale count with no as-of is indistinguishable from a live zero.
|
|
1678
|
+
*/
|
|
1679
|
+
as_of: string;
|
|
1680
|
+
} | {
|
|
1681
|
+
status: "unreachable";
|
|
1682
|
+
};
|
|
1683
|
+
type AnalyticsBreakdown = {
|
|
1684
|
+
status: "ok";
|
|
1685
|
+
data: Array<{
|
|
1686
|
+
[key: string]: string | number | null;
|
|
1687
|
+
}>;
|
|
1688
|
+
window: {
|
|
1689
|
+
from: string;
|
|
1690
|
+
to: string;
|
|
1691
|
+
};
|
|
1692
|
+
} | {
|
|
1693
|
+
status: "unreachable";
|
|
1694
|
+
};
|
|
1695
|
+
type AnalyticsChannels = {
|
|
1696
|
+
status: "ok";
|
|
1697
|
+
data: Array<{
|
|
1698
|
+
channel: string;
|
|
1699
|
+
visits: number;
|
|
1700
|
+
}>;
|
|
1701
|
+
window: {
|
|
1702
|
+
from: string;
|
|
1703
|
+
to: string;
|
|
1704
|
+
};
|
|
1705
|
+
} | {
|
|
1706
|
+
status: "unreachable";
|
|
1707
|
+
};
|
|
1535
1708
|
type SubscriptionSummary = {
|
|
1536
1709
|
/**
|
|
1537
1710
|
* Latest email delivery observation per kind. Independent of payment and send-retry status; absent for older deployments.
|
|
@@ -2176,6 +2349,38 @@ type UpdateRetainer = {
|
|
|
2176
2349
|
type RetainerSiteBody = {
|
|
2177
2350
|
site_id: string;
|
|
2178
2351
|
};
|
|
2352
|
+
type ConsentConfig = {
|
|
2353
|
+
mode: "adaptive" | "adaptive-with-notice" | "strict-everywhere" | "off";
|
|
2354
|
+
policy_path: string | null;
|
|
2355
|
+
taxonomy_version: number;
|
|
2356
|
+
/**
|
|
2357
|
+
* The public config id — the value the site's ConsentProvider fetches at /v1/prefs/{id}. Unguessable by design; treat it as the only handle to this config.
|
|
2358
|
+
*/
|
|
2359
|
+
id: string;
|
|
2360
|
+
};
|
|
2361
|
+
type ConsentConfigResult = {
|
|
2362
|
+
mode: "adaptive" | "adaptive-with-notice" | "strict-everywhere" | "off";
|
|
2363
|
+
policy_path: string | null;
|
|
2364
|
+
taxonomy_version: number;
|
|
2365
|
+
/**
|
|
2366
|
+
* The public config id — the value the site's ConsentProvider fetches at /v1/prefs/{id}. Unguessable by design; treat it as the only handle to this config.
|
|
2367
|
+
*/
|
|
2368
|
+
id: string;
|
|
2369
|
+
/**
|
|
2370
|
+
* true when this call created the config, false when it updated an existing one — the agent tool's setup-vs-update branch keys on this.
|
|
2371
|
+
*/
|
|
2372
|
+
created: boolean;
|
|
2373
|
+
};
|
|
2374
|
+
type UpsertConsentConfig = {
|
|
2375
|
+
/**
|
|
2376
|
+
* 'adaptive' (default) follows the server's conservative geographic policy: non-US or unknown country is strict; US risk, missing, or unrecognized region is strict-trackers; other recognized US states/DC are opt-out without a banner. 'adaptive-with-notice' adds a notice in that opt-out group. 'strict-everywhere' requires a choice globally. 'off' hides the banner; stored decisions and GPC still apply.
|
|
2377
|
+
*/
|
|
2378
|
+
mode: "adaptive" | "adaptive-with-notice" | "strict-everywhere" | "off";
|
|
2379
|
+
/**
|
|
2380
|
+
* Same-site relative path to the cookie policy page, or null to clear it. Omit to leave the stored value unchanged.
|
|
2381
|
+
*/
|
|
2382
|
+
policy_path?: string | null;
|
|
2383
|
+
};
|
|
2179
2384
|
type Form = {
|
|
2180
2385
|
id: string;
|
|
2181
2386
|
name: string;
|
|
@@ -3050,10 +3255,14 @@ type OrderSessionStatus = {
|
|
|
3050
3255
|
};
|
|
3051
3256
|
};
|
|
3052
3257
|
type GeoSuggestion = {
|
|
3053
|
-
/**
|
|
3054
|
-
* ISO 3166-1 alpha-2 country of the visitor, or null when the edge provides none.
|
|
3055
|
-
*/
|
|
3056
3258
|
country: string | null;
|
|
3259
|
+
region: string | null;
|
|
3260
|
+
shape: "strict" | "strict-trackers" | "soft";
|
|
3261
|
+
};
|
|
3262
|
+
type ConsentPrefs = {
|
|
3263
|
+
mode: "adaptive" | "adaptive-with-notice" | "strict-everywhere" | "off";
|
|
3264
|
+
policy_path: string | null;
|
|
3265
|
+
taxonomy_version: number;
|
|
3057
3266
|
};
|
|
3058
3267
|
type AccountLoginResult = {
|
|
3059
3268
|
ok: true;
|
|
@@ -4589,29 +4798,20 @@ type SetOrderFulfillmentResponses = {
|
|
|
4589
4798
|
200: Order;
|
|
4590
4799
|
};
|
|
4591
4800
|
type SetOrderFulfillmentResponse = SetOrderFulfillmentResponses[keyof SetOrderFulfillmentResponses];
|
|
4592
|
-
type
|
|
4801
|
+
type GetAnalyticsStatusData = {
|
|
4593
4802
|
body?: never;
|
|
4594
4803
|
path?: never;
|
|
4595
4804
|
query?: {
|
|
4596
4805
|
/**
|
|
4597
|
-
* Required with an
|
|
4806
|
+
* 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.
|
|
4598
4807
|
*/
|
|
4599
4808
|
site_id?: string;
|
|
4600
|
-
/**
|
|
4601
|
-
* Exact status filter (verbatim Stripe values).
|
|
4602
|
-
*/
|
|
4603
|
-
status?: string;
|
|
4604
|
-
/**
|
|
4605
|
-
* Max rows (default 50, max 100).
|
|
4606
|
-
*/
|
|
4607
|
-
limit?: string;
|
|
4608
|
-
offset?: string;
|
|
4609
4809
|
};
|
|
4610
|
-
url: "/api/v1/
|
|
4810
|
+
url: "/api/v1/analytics/status";
|
|
4611
4811
|
};
|
|
4612
|
-
type
|
|
4812
|
+
type GetAnalyticsStatusErrors = {
|
|
4613
4813
|
/**
|
|
4614
|
-
* site_id mismatch
|
|
4814
|
+
* site_id mismatch
|
|
4615
4815
|
*/
|
|
4616
4816
|
400: unknown;
|
|
4617
4817
|
/**
|
|
@@ -4619,146 +4819,760 @@ type ListSubscriptionsErrors = {
|
|
|
4619
4819
|
*/
|
|
4620
4820
|
401: unknown;
|
|
4621
4821
|
};
|
|
4622
|
-
type
|
|
4822
|
+
type GetAnalyticsStatusResponses = {
|
|
4623
4823
|
/**
|
|
4624
|
-
*
|
|
4824
|
+
* Collection status
|
|
4625
4825
|
*/
|
|
4626
|
-
200:
|
|
4826
|
+
200: AnalyticsStatus;
|
|
4627
4827
|
};
|
|
4628
|
-
type
|
|
4629
|
-
type
|
|
4828
|
+
type GetAnalyticsStatusResponse = GetAnalyticsStatusResponses[keyof GetAnalyticsStatusResponses];
|
|
4829
|
+
type GetAnalyticsSummaryData = {
|
|
4630
4830
|
body?: never;
|
|
4631
|
-
path
|
|
4632
|
-
|
|
4831
|
+
path?: never;
|
|
4832
|
+
query?: {
|
|
4833
|
+
/**
|
|
4834
|
+
* 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.
|
|
4835
|
+
*/
|
|
4836
|
+
site_id?: string;
|
|
4837
|
+
/**
|
|
4838
|
+
* 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.
|
|
4839
|
+
*/
|
|
4840
|
+
period?: "7" | "30" | "90";
|
|
4633
4841
|
};
|
|
4634
|
-
|
|
4635
|
-
url: "/api/v1/subscriptions/{subscriptionId}/cancel";
|
|
4842
|
+
url: "/api/v1/analytics/summary";
|
|
4636
4843
|
};
|
|
4637
|
-
type
|
|
4638
|
-
/**
|
|
4639
|
-
* Site tokens are not permitted
|
|
4640
|
-
*/
|
|
4641
|
-
403: unknown;
|
|
4844
|
+
type GetAnalyticsSummaryErrors = {
|
|
4642
4845
|
/**
|
|
4643
|
-
*
|
|
4644
|
-
*/
|
|
4645
|
-
404: unknown;
|
|
4646
|
-
/**
|
|
4647
|
-
* Subscription already ended (code ended) — terminal locally, or Stripe says it is already canceled
|
|
4846
|
+
* site_id mismatch / unsupported period
|
|
4648
4847
|
*/
|
|
4649
|
-
|
|
4848
|
+
400: unknown;
|
|
4650
4849
|
/**
|
|
4651
|
-
*
|
|
4850
|
+
* Missing or invalid token
|
|
4652
4851
|
*/
|
|
4653
|
-
|
|
4852
|
+
401: unknown;
|
|
4654
4853
|
};
|
|
4655
|
-
type
|
|
4854
|
+
type GetAnalyticsSummaryResponses = {
|
|
4656
4855
|
/**
|
|
4657
|
-
*
|
|
4856
|
+
* Summary, or an unreachable source
|
|
4658
4857
|
*/
|
|
4659
|
-
200:
|
|
4858
|
+
200: AnalyticsSummary;
|
|
4660
4859
|
};
|
|
4661
|
-
type
|
|
4662
|
-
type
|
|
4663
|
-
body?:
|
|
4664
|
-
path
|
|
4665
|
-
|
|
4860
|
+
type GetAnalyticsSummaryResponse = GetAnalyticsSummaryResponses[keyof GetAnalyticsSummaryResponses];
|
|
4861
|
+
type GetAnalyticsTimeseriesData = {
|
|
4862
|
+
body?: never;
|
|
4863
|
+
path?: never;
|
|
4864
|
+
query?: {
|
|
4865
|
+
/**
|
|
4866
|
+
* 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.
|
|
4867
|
+
*/
|
|
4868
|
+
site_id?: string;
|
|
4869
|
+
/**
|
|
4870
|
+
* 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.
|
|
4871
|
+
*/
|
|
4872
|
+
period?: "7" | "30" | "90";
|
|
4666
4873
|
};
|
|
4667
|
-
|
|
4668
|
-
url: "/api/v1/sites/{siteId}/subscriptions/teardown";
|
|
4874
|
+
url: "/api/v1/analytics/timeseries";
|
|
4669
4875
|
};
|
|
4670
|
-
type
|
|
4876
|
+
type GetAnalyticsTimeseriesErrors = {
|
|
4671
4877
|
/**
|
|
4672
|
-
*
|
|
4878
|
+
* site_id mismatch / unsupported period
|
|
4673
4879
|
*/
|
|
4674
|
-
|
|
4880
|
+
400: unknown;
|
|
4675
4881
|
/**
|
|
4676
|
-
*
|
|
4882
|
+
* Missing or invalid token
|
|
4677
4883
|
*/
|
|
4678
|
-
|
|
4884
|
+
401: unknown;
|
|
4679
4885
|
};
|
|
4680
|
-
type
|
|
4681
|
-
type TeardownSiteSubscriptionsResponses = {
|
|
4886
|
+
type GetAnalyticsTimeseriesResponses = {
|
|
4682
4887
|
/**
|
|
4683
|
-
*
|
|
4888
|
+
* Timeseries, or an unreachable source
|
|
4684
4889
|
*/
|
|
4685
|
-
200:
|
|
4890
|
+
200: AnalyticsTimeseries;
|
|
4686
4891
|
};
|
|
4687
|
-
type
|
|
4688
|
-
type
|
|
4689
|
-
body?:
|
|
4690
|
-
path
|
|
4691
|
-
|
|
4892
|
+
type GetAnalyticsTimeseriesResponse = GetAnalyticsTimeseriesResponses[keyof GetAnalyticsTimeseriesResponses];
|
|
4893
|
+
type GetAnalyticsRealtimeData = {
|
|
4894
|
+
body?: never;
|
|
4895
|
+
path?: never;
|
|
4896
|
+
query?: {
|
|
4897
|
+
/**
|
|
4898
|
+
* 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.
|
|
4899
|
+
*/
|
|
4900
|
+
site_id?: string;
|
|
4692
4901
|
};
|
|
4693
|
-
|
|
4694
|
-
url: "/api/v1/sites/{siteId}/subscriptions/reactivate-teardown";
|
|
4902
|
+
url: "/api/v1/analytics/realtime";
|
|
4695
4903
|
};
|
|
4696
|
-
type
|
|
4697
|
-
/**
|
|
4698
|
-
* Unknown key in the body (a misspelled `reason` is refused, never ignored)
|
|
4699
|
-
*/
|
|
4700
|
-
400: Error;
|
|
4904
|
+
type GetAnalyticsRealtimeErrors = {
|
|
4701
4905
|
/**
|
|
4702
|
-
*
|
|
4906
|
+
* site_id mismatch
|
|
4703
4907
|
*/
|
|
4704
|
-
|
|
4908
|
+
400: unknown;
|
|
4705
4909
|
/**
|
|
4706
|
-
*
|
|
4910
|
+
* Missing or invalid token
|
|
4707
4911
|
*/
|
|
4708
|
-
|
|
4912
|
+
401: unknown;
|
|
4709
4913
|
};
|
|
4710
|
-
type
|
|
4711
|
-
type ReactivateSiteSubscriptionsTeardownResponses = {
|
|
4914
|
+
type GetAnalyticsRealtimeResponses = {
|
|
4712
4915
|
/**
|
|
4713
|
-
*
|
|
4916
|
+
* Current visitors, or an unreachable source
|
|
4714
4917
|
*/
|
|
4715
|
-
200:
|
|
4918
|
+
200: AnalyticsRealtime;
|
|
4716
4919
|
};
|
|
4717
|
-
type
|
|
4718
|
-
type
|
|
4719
|
-
body
|
|
4720
|
-
path
|
|
4721
|
-
|
|
4920
|
+
type GetAnalyticsRealtimeResponse = GetAnalyticsRealtimeResponses[keyof GetAnalyticsRealtimeResponses];
|
|
4921
|
+
type GetAnalyticsSourcesData = {
|
|
4922
|
+
body?: never;
|
|
4923
|
+
path?: never;
|
|
4924
|
+
query?: {
|
|
4925
|
+
site_id?: string;
|
|
4926
|
+
period?: "7" | "30" | "90";
|
|
4927
|
+
limit?: string;
|
|
4722
4928
|
};
|
|
4723
|
-
|
|
4724
|
-
url: "/api/v1/sites/{siteId}/preview-session";
|
|
4929
|
+
url: "/api/v1/analytics/sources";
|
|
4725
4930
|
};
|
|
4726
|
-
type
|
|
4931
|
+
type GetAnalyticsSourcesErrors = {
|
|
4727
4932
|
/**
|
|
4728
|
-
*
|
|
4933
|
+
* site_id mismatch / unsupported period
|
|
4934
|
+
*/
|
|
4935
|
+
400: unknown;
|
|
4936
|
+
/**
|
|
4937
|
+
* Missing or invalid token
|
|
4729
4938
|
*/
|
|
4730
4939
|
401: unknown;
|
|
4940
|
+
};
|
|
4941
|
+
type GetAnalyticsSourcesResponses = {
|
|
4731
4942
|
/**
|
|
4732
|
-
*
|
|
4943
|
+
* Breakdown rows, or an unreachable source
|
|
4733
4944
|
*/
|
|
4734
|
-
|
|
4945
|
+
200: AnalyticsBreakdown;
|
|
4946
|
+
};
|
|
4947
|
+
type GetAnalyticsSourcesResponse = GetAnalyticsSourcesResponses[keyof GetAnalyticsSourcesResponses];
|
|
4948
|
+
type GetAnalyticsCampaignsData = {
|
|
4949
|
+
body?: never;
|
|
4950
|
+
path?: never;
|
|
4951
|
+
query?: {
|
|
4952
|
+
site_id?: string;
|
|
4953
|
+
period?: "7" | "30" | "90";
|
|
4954
|
+
limit?: string;
|
|
4955
|
+
};
|
|
4956
|
+
url: "/api/v1/analytics/campaigns";
|
|
4957
|
+
};
|
|
4958
|
+
type GetAnalyticsCampaignsErrors = {
|
|
4735
4959
|
/**
|
|
4736
|
-
*
|
|
4960
|
+
* site_id mismatch / unsupported period
|
|
4737
4961
|
*/
|
|
4738
|
-
|
|
4962
|
+
400: unknown;
|
|
4739
4963
|
/**
|
|
4740
|
-
*
|
|
4964
|
+
* Missing or invalid token
|
|
4741
4965
|
*/
|
|
4742
|
-
|
|
4966
|
+
401: unknown;
|
|
4743
4967
|
};
|
|
4744
|
-
type
|
|
4745
|
-
type CreatePreviewSessionResponses = {
|
|
4968
|
+
type GetAnalyticsCampaignsResponses = {
|
|
4746
4969
|
/**
|
|
4747
|
-
*
|
|
4970
|
+
* Breakdown rows, or an unreachable source
|
|
4748
4971
|
*/
|
|
4749
|
-
200:
|
|
4972
|
+
200: AnalyticsBreakdown;
|
|
4750
4973
|
};
|
|
4751
|
-
type
|
|
4752
|
-
type
|
|
4974
|
+
type GetAnalyticsCampaignsResponse = GetAnalyticsCampaignsResponses[keyof GetAnalyticsCampaignsResponses];
|
|
4975
|
+
type GetAnalyticsUtmMediumData = {
|
|
4753
4976
|
body?: never;
|
|
4754
4977
|
path?: never;
|
|
4755
4978
|
query?: {
|
|
4756
4979
|
site_id?: string;
|
|
4757
|
-
|
|
4758
|
-
|
|
4759
|
-
|
|
4760
|
-
|
|
4761
|
-
|
|
4980
|
+
period?: "7" | "30" | "90";
|
|
4981
|
+
limit?: string;
|
|
4982
|
+
};
|
|
4983
|
+
url: "/api/v1/analytics/utm/medium";
|
|
4984
|
+
};
|
|
4985
|
+
type GetAnalyticsUtmMediumErrors = {
|
|
4986
|
+
/**
|
|
4987
|
+
* site_id mismatch / unsupported period
|
|
4988
|
+
*/
|
|
4989
|
+
400: unknown;
|
|
4990
|
+
/**
|
|
4991
|
+
* Missing or invalid token
|
|
4992
|
+
*/
|
|
4993
|
+
401: unknown;
|
|
4994
|
+
};
|
|
4995
|
+
type GetAnalyticsUtmMediumResponses = {
|
|
4996
|
+
/**
|
|
4997
|
+
* Breakdown rows, or an unreachable source
|
|
4998
|
+
*/
|
|
4999
|
+
200: AnalyticsBreakdown;
|
|
5000
|
+
};
|
|
5001
|
+
type GetAnalyticsUtmMediumResponse = GetAnalyticsUtmMediumResponses[keyof GetAnalyticsUtmMediumResponses];
|
|
5002
|
+
type GetAnalyticsUtmSourceData = {
|
|
5003
|
+
body?: never;
|
|
5004
|
+
path?: never;
|
|
5005
|
+
query?: {
|
|
5006
|
+
site_id?: string;
|
|
5007
|
+
period?: "7" | "30" | "90";
|
|
5008
|
+
limit?: string;
|
|
5009
|
+
};
|
|
5010
|
+
url: "/api/v1/analytics/utm/source";
|
|
5011
|
+
};
|
|
5012
|
+
type GetAnalyticsUtmSourceErrors = {
|
|
5013
|
+
/**
|
|
5014
|
+
* site_id mismatch / unsupported period
|
|
5015
|
+
*/
|
|
5016
|
+
400: unknown;
|
|
5017
|
+
/**
|
|
5018
|
+
* Missing or invalid token
|
|
5019
|
+
*/
|
|
5020
|
+
401: unknown;
|
|
5021
|
+
};
|
|
5022
|
+
type GetAnalyticsUtmSourceResponses = {
|
|
5023
|
+
/**
|
|
5024
|
+
* Breakdown rows, or an unreachable source
|
|
5025
|
+
*/
|
|
5026
|
+
200: AnalyticsBreakdown;
|
|
5027
|
+
};
|
|
5028
|
+
type GetAnalyticsUtmSourceResponse = GetAnalyticsUtmSourceResponses[keyof GetAnalyticsUtmSourceResponses];
|
|
5029
|
+
type GetAnalyticsUtmCampaignData = {
|
|
5030
|
+
body?: never;
|
|
5031
|
+
path?: never;
|
|
5032
|
+
query?: {
|
|
5033
|
+
site_id?: string;
|
|
5034
|
+
period?: "7" | "30" | "90";
|
|
5035
|
+
limit?: string;
|
|
5036
|
+
};
|
|
5037
|
+
url: "/api/v1/analytics/utm/campaign";
|
|
5038
|
+
};
|
|
5039
|
+
type GetAnalyticsUtmCampaignErrors = {
|
|
5040
|
+
/**
|
|
5041
|
+
* site_id mismatch / unsupported period
|
|
5042
|
+
*/
|
|
5043
|
+
400: unknown;
|
|
5044
|
+
/**
|
|
5045
|
+
* Missing or invalid token
|
|
5046
|
+
*/
|
|
5047
|
+
401: unknown;
|
|
5048
|
+
};
|
|
5049
|
+
type GetAnalyticsUtmCampaignResponses = {
|
|
5050
|
+
/**
|
|
5051
|
+
* Breakdown rows, or an unreachable source
|
|
5052
|
+
*/
|
|
5053
|
+
200: AnalyticsBreakdown;
|
|
5054
|
+
};
|
|
5055
|
+
type GetAnalyticsUtmCampaignResponse = GetAnalyticsUtmCampaignResponses[keyof GetAnalyticsUtmCampaignResponses];
|
|
5056
|
+
type GetAnalyticsUtmContentData = {
|
|
5057
|
+
body?: never;
|
|
5058
|
+
path?: never;
|
|
5059
|
+
query?: {
|
|
5060
|
+
site_id?: string;
|
|
5061
|
+
period?: "7" | "30" | "90";
|
|
5062
|
+
limit?: string;
|
|
5063
|
+
};
|
|
5064
|
+
url: "/api/v1/analytics/utm/content";
|
|
5065
|
+
};
|
|
5066
|
+
type GetAnalyticsUtmContentErrors = {
|
|
5067
|
+
/**
|
|
5068
|
+
* site_id mismatch / unsupported period
|
|
5069
|
+
*/
|
|
5070
|
+
400: unknown;
|
|
5071
|
+
/**
|
|
5072
|
+
* Missing or invalid token
|
|
5073
|
+
*/
|
|
5074
|
+
401: unknown;
|
|
5075
|
+
};
|
|
5076
|
+
type GetAnalyticsUtmContentResponses = {
|
|
5077
|
+
/**
|
|
5078
|
+
* Breakdown rows, or an unreachable source
|
|
5079
|
+
*/
|
|
5080
|
+
200: AnalyticsBreakdown;
|
|
5081
|
+
};
|
|
5082
|
+
type GetAnalyticsUtmContentResponse = GetAnalyticsUtmContentResponses[keyof GetAnalyticsUtmContentResponses];
|
|
5083
|
+
type GetAnalyticsUtmTermData = {
|
|
5084
|
+
body?: never;
|
|
5085
|
+
path?: never;
|
|
5086
|
+
query?: {
|
|
5087
|
+
site_id?: string;
|
|
5088
|
+
period?: "7" | "30" | "90";
|
|
5089
|
+
limit?: string;
|
|
5090
|
+
};
|
|
5091
|
+
url: "/api/v1/analytics/utm/term";
|
|
5092
|
+
};
|
|
5093
|
+
type GetAnalyticsUtmTermErrors = {
|
|
5094
|
+
/**
|
|
5095
|
+
* site_id mismatch / unsupported period
|
|
5096
|
+
*/
|
|
5097
|
+
400: unknown;
|
|
5098
|
+
/**
|
|
5099
|
+
* Missing or invalid token
|
|
5100
|
+
*/
|
|
5101
|
+
401: unknown;
|
|
5102
|
+
};
|
|
5103
|
+
type GetAnalyticsUtmTermResponses = {
|
|
5104
|
+
/**
|
|
5105
|
+
* Breakdown rows, or an unreachable source
|
|
5106
|
+
*/
|
|
5107
|
+
200: AnalyticsBreakdown;
|
|
5108
|
+
};
|
|
5109
|
+
type GetAnalyticsUtmTermResponse = GetAnalyticsUtmTermResponses[keyof GetAnalyticsUtmTermResponses];
|
|
5110
|
+
type GetAnalyticsPagesData = {
|
|
5111
|
+
body?: never;
|
|
5112
|
+
path?: never;
|
|
5113
|
+
query?: {
|
|
5114
|
+
site_id?: string;
|
|
5115
|
+
period?: "7" | "30" | "90";
|
|
5116
|
+
limit?: string;
|
|
5117
|
+
};
|
|
5118
|
+
url: "/api/v1/analytics/pages";
|
|
5119
|
+
};
|
|
5120
|
+
type GetAnalyticsPagesErrors = {
|
|
5121
|
+
/**
|
|
5122
|
+
* site_id mismatch / unsupported period
|
|
5123
|
+
*/
|
|
5124
|
+
400: unknown;
|
|
5125
|
+
/**
|
|
5126
|
+
* Missing or invalid token
|
|
5127
|
+
*/
|
|
5128
|
+
401: unknown;
|
|
5129
|
+
};
|
|
5130
|
+
type GetAnalyticsPagesResponses = {
|
|
5131
|
+
/**
|
|
5132
|
+
* Breakdown rows, or an unreachable source
|
|
5133
|
+
*/
|
|
5134
|
+
200: AnalyticsBreakdown;
|
|
5135
|
+
};
|
|
5136
|
+
type GetAnalyticsPagesResponse = GetAnalyticsPagesResponses[keyof GetAnalyticsPagesResponses];
|
|
5137
|
+
type GetAnalyticsEntryPagesData = {
|
|
5138
|
+
body?: never;
|
|
5139
|
+
path?: never;
|
|
5140
|
+
query?: {
|
|
5141
|
+
site_id?: string;
|
|
5142
|
+
period?: "7" | "30" | "90";
|
|
5143
|
+
limit?: string;
|
|
5144
|
+
};
|
|
5145
|
+
url: "/api/v1/analytics/entry-pages";
|
|
5146
|
+
};
|
|
5147
|
+
type GetAnalyticsEntryPagesErrors = {
|
|
5148
|
+
/**
|
|
5149
|
+
* site_id mismatch / unsupported period
|
|
5150
|
+
*/
|
|
5151
|
+
400: unknown;
|
|
5152
|
+
/**
|
|
5153
|
+
* Missing or invalid token
|
|
5154
|
+
*/
|
|
5155
|
+
401: unknown;
|
|
5156
|
+
};
|
|
5157
|
+
type GetAnalyticsEntryPagesResponses = {
|
|
5158
|
+
/**
|
|
5159
|
+
* Breakdown rows, or an unreachable source
|
|
5160
|
+
*/
|
|
5161
|
+
200: AnalyticsBreakdown;
|
|
5162
|
+
};
|
|
5163
|
+
type GetAnalyticsEntryPagesResponse = GetAnalyticsEntryPagesResponses[keyof GetAnalyticsEntryPagesResponses];
|
|
5164
|
+
type GetAnalyticsExitPagesData = {
|
|
5165
|
+
body?: never;
|
|
5166
|
+
path?: never;
|
|
5167
|
+
query?: {
|
|
5168
|
+
site_id?: string;
|
|
5169
|
+
period?: "7" | "30" | "90";
|
|
5170
|
+
limit?: string;
|
|
5171
|
+
};
|
|
5172
|
+
url: "/api/v1/analytics/exit-pages";
|
|
5173
|
+
};
|
|
5174
|
+
type GetAnalyticsExitPagesErrors = {
|
|
5175
|
+
/**
|
|
5176
|
+
* site_id mismatch / unsupported period
|
|
5177
|
+
*/
|
|
5178
|
+
400: unknown;
|
|
5179
|
+
/**
|
|
5180
|
+
* Missing or invalid token
|
|
5181
|
+
*/
|
|
5182
|
+
401: unknown;
|
|
5183
|
+
};
|
|
5184
|
+
type GetAnalyticsExitPagesResponses = {
|
|
5185
|
+
/**
|
|
5186
|
+
* Breakdown rows, or an unreachable source
|
|
5187
|
+
*/
|
|
5188
|
+
200: AnalyticsBreakdown;
|
|
5189
|
+
};
|
|
5190
|
+
type GetAnalyticsExitPagesResponse = GetAnalyticsExitPagesResponses[keyof GetAnalyticsExitPagesResponses];
|
|
5191
|
+
type GetAnalyticsReferrersData = {
|
|
5192
|
+
body?: never;
|
|
5193
|
+
path?: never;
|
|
5194
|
+
query?: {
|
|
5195
|
+
site_id?: string;
|
|
5196
|
+
period?: "7" | "30" | "90";
|
|
5197
|
+
limit?: string;
|
|
5198
|
+
};
|
|
5199
|
+
url: "/api/v1/analytics/referrers";
|
|
5200
|
+
};
|
|
5201
|
+
type GetAnalyticsReferrersErrors = {
|
|
5202
|
+
/**
|
|
5203
|
+
* site_id mismatch / unsupported period
|
|
5204
|
+
*/
|
|
5205
|
+
400: unknown;
|
|
5206
|
+
/**
|
|
5207
|
+
* Missing or invalid token
|
|
5208
|
+
*/
|
|
5209
|
+
401: unknown;
|
|
5210
|
+
};
|
|
5211
|
+
type GetAnalyticsReferrersResponses = {
|
|
5212
|
+
/**
|
|
5213
|
+
* Breakdown rows, or an unreachable source
|
|
5214
|
+
*/
|
|
5215
|
+
200: AnalyticsBreakdown;
|
|
5216
|
+
};
|
|
5217
|
+
type GetAnalyticsReferrersResponse = GetAnalyticsReferrersResponses[keyof GetAnalyticsReferrersResponses];
|
|
5218
|
+
type GetAnalyticsCountriesData = {
|
|
5219
|
+
body?: never;
|
|
5220
|
+
path?: never;
|
|
5221
|
+
query?: {
|
|
5222
|
+
site_id?: string;
|
|
5223
|
+
period?: "7" | "30" | "90";
|
|
5224
|
+
limit?: string;
|
|
5225
|
+
};
|
|
5226
|
+
url: "/api/v1/analytics/countries";
|
|
5227
|
+
};
|
|
5228
|
+
type GetAnalyticsCountriesErrors = {
|
|
5229
|
+
/**
|
|
5230
|
+
* site_id mismatch / unsupported period
|
|
5231
|
+
*/
|
|
5232
|
+
400: unknown;
|
|
5233
|
+
/**
|
|
5234
|
+
* Missing or invalid token
|
|
5235
|
+
*/
|
|
5236
|
+
401: unknown;
|
|
5237
|
+
};
|
|
5238
|
+
type GetAnalyticsCountriesResponses = {
|
|
5239
|
+
/**
|
|
5240
|
+
* Breakdown rows, or an unreachable source
|
|
5241
|
+
*/
|
|
5242
|
+
200: AnalyticsBreakdown;
|
|
5243
|
+
};
|
|
5244
|
+
type GetAnalyticsCountriesResponse = GetAnalyticsCountriesResponses[keyof GetAnalyticsCountriesResponses];
|
|
5245
|
+
type GetAnalyticsRegionsData = {
|
|
5246
|
+
body?: never;
|
|
5247
|
+
path?: never;
|
|
5248
|
+
query?: {
|
|
5249
|
+
site_id?: string;
|
|
5250
|
+
period?: "7" | "30" | "90";
|
|
5251
|
+
limit?: string;
|
|
5252
|
+
};
|
|
5253
|
+
url: "/api/v1/analytics/regions";
|
|
5254
|
+
};
|
|
5255
|
+
type GetAnalyticsRegionsErrors = {
|
|
5256
|
+
/**
|
|
5257
|
+
* site_id mismatch / unsupported period
|
|
5258
|
+
*/
|
|
5259
|
+
400: unknown;
|
|
5260
|
+
/**
|
|
5261
|
+
* Missing or invalid token
|
|
5262
|
+
*/
|
|
5263
|
+
401: unknown;
|
|
5264
|
+
};
|
|
5265
|
+
type GetAnalyticsRegionsResponses = {
|
|
5266
|
+
/**
|
|
5267
|
+
* Breakdown rows, or an unreachable source
|
|
5268
|
+
*/
|
|
5269
|
+
200: AnalyticsBreakdown;
|
|
5270
|
+
};
|
|
5271
|
+
type GetAnalyticsRegionsResponse = GetAnalyticsRegionsResponses[keyof GetAnalyticsRegionsResponses];
|
|
5272
|
+
type GetAnalyticsCitiesData = {
|
|
5273
|
+
body?: never;
|
|
5274
|
+
path?: never;
|
|
5275
|
+
query?: {
|
|
5276
|
+
site_id?: string;
|
|
5277
|
+
period?: "7" | "30" | "90";
|
|
5278
|
+
limit?: string;
|
|
5279
|
+
};
|
|
5280
|
+
url: "/api/v1/analytics/cities";
|
|
5281
|
+
};
|
|
5282
|
+
type GetAnalyticsCitiesErrors = {
|
|
5283
|
+
/**
|
|
5284
|
+
* site_id mismatch / unsupported period
|
|
5285
|
+
*/
|
|
5286
|
+
400: unknown;
|
|
5287
|
+
/**
|
|
5288
|
+
* Missing or invalid token
|
|
5289
|
+
*/
|
|
5290
|
+
401: unknown;
|
|
5291
|
+
};
|
|
5292
|
+
type GetAnalyticsCitiesResponses = {
|
|
5293
|
+
/**
|
|
5294
|
+
* Breakdown rows, or an unreachable source
|
|
5295
|
+
*/
|
|
5296
|
+
200: AnalyticsBreakdown;
|
|
5297
|
+
};
|
|
5298
|
+
type GetAnalyticsCitiesResponse = GetAnalyticsCitiesResponses[keyof GetAnalyticsCitiesResponses];
|
|
5299
|
+
type GetAnalyticsDevicesData = {
|
|
5300
|
+
body?: never;
|
|
5301
|
+
path?: never;
|
|
5302
|
+
query?: {
|
|
5303
|
+
site_id?: string;
|
|
5304
|
+
period?: "7" | "30" | "90";
|
|
5305
|
+
limit?: string;
|
|
5306
|
+
};
|
|
5307
|
+
url: "/api/v1/analytics/devices";
|
|
5308
|
+
};
|
|
5309
|
+
type GetAnalyticsDevicesErrors = {
|
|
5310
|
+
/**
|
|
5311
|
+
* site_id mismatch / unsupported period
|
|
5312
|
+
*/
|
|
5313
|
+
400: unknown;
|
|
5314
|
+
/**
|
|
5315
|
+
* Missing or invalid token
|
|
5316
|
+
*/
|
|
5317
|
+
401: unknown;
|
|
5318
|
+
};
|
|
5319
|
+
type GetAnalyticsDevicesResponses = {
|
|
5320
|
+
/**
|
|
5321
|
+
* Breakdown rows, or an unreachable source
|
|
5322
|
+
*/
|
|
5323
|
+
200: AnalyticsBreakdown;
|
|
5324
|
+
};
|
|
5325
|
+
type GetAnalyticsDevicesResponse = GetAnalyticsDevicesResponses[keyof GetAnalyticsDevicesResponses];
|
|
5326
|
+
type GetAnalyticsBrowsersData = {
|
|
5327
|
+
body?: never;
|
|
5328
|
+
path?: never;
|
|
5329
|
+
query?: {
|
|
5330
|
+
site_id?: string;
|
|
5331
|
+
period?: "7" | "30" | "90";
|
|
5332
|
+
limit?: string;
|
|
5333
|
+
};
|
|
5334
|
+
url: "/api/v1/analytics/browsers";
|
|
5335
|
+
};
|
|
5336
|
+
type GetAnalyticsBrowsersErrors = {
|
|
5337
|
+
/**
|
|
5338
|
+
* site_id mismatch / unsupported period
|
|
5339
|
+
*/
|
|
5340
|
+
400: unknown;
|
|
5341
|
+
/**
|
|
5342
|
+
* Missing or invalid token
|
|
5343
|
+
*/
|
|
5344
|
+
401: unknown;
|
|
5345
|
+
};
|
|
5346
|
+
type GetAnalyticsBrowsersResponses = {
|
|
5347
|
+
/**
|
|
5348
|
+
* Breakdown rows, or an unreachable source
|
|
5349
|
+
*/
|
|
5350
|
+
200: AnalyticsBreakdown;
|
|
5351
|
+
};
|
|
5352
|
+
type GetAnalyticsBrowsersResponse = GetAnalyticsBrowsersResponses[keyof GetAnalyticsBrowsersResponses];
|
|
5353
|
+
type GetAnalyticsOperatingSystemsData = {
|
|
5354
|
+
body?: never;
|
|
5355
|
+
path?: never;
|
|
5356
|
+
query?: {
|
|
5357
|
+
site_id?: string;
|
|
5358
|
+
period?: "7" | "30" | "90";
|
|
5359
|
+
limit?: string;
|
|
5360
|
+
};
|
|
5361
|
+
url: "/api/v1/analytics/operating-systems";
|
|
5362
|
+
};
|
|
5363
|
+
type GetAnalyticsOperatingSystemsErrors = {
|
|
5364
|
+
/**
|
|
5365
|
+
* site_id mismatch / unsupported period
|
|
5366
|
+
*/
|
|
5367
|
+
400: unknown;
|
|
5368
|
+
/**
|
|
5369
|
+
* Missing or invalid token
|
|
5370
|
+
*/
|
|
5371
|
+
401: unknown;
|
|
5372
|
+
};
|
|
5373
|
+
type GetAnalyticsOperatingSystemsResponses = {
|
|
5374
|
+
/**
|
|
5375
|
+
* Breakdown rows, or an unreachable source
|
|
5376
|
+
*/
|
|
5377
|
+
200: AnalyticsBreakdown;
|
|
5378
|
+
};
|
|
5379
|
+
type GetAnalyticsOperatingSystemsResponse = GetAnalyticsOperatingSystemsResponses[keyof GetAnalyticsOperatingSystemsResponses];
|
|
5380
|
+
type GetAnalyticsChannelsData = {
|
|
5381
|
+
body?: never;
|
|
5382
|
+
path?: never;
|
|
5383
|
+
query?: {
|
|
5384
|
+
site_id?: string;
|
|
5385
|
+
period?: "7" | "30" | "90";
|
|
5386
|
+
};
|
|
5387
|
+
url: "/api/v1/analytics/channels";
|
|
5388
|
+
};
|
|
5389
|
+
type GetAnalyticsChannelsErrors = {
|
|
5390
|
+
/**
|
|
5391
|
+
* site_id mismatch / unsupported period
|
|
5392
|
+
*/
|
|
5393
|
+
400: unknown;
|
|
5394
|
+
/**
|
|
5395
|
+
* Missing or invalid token
|
|
5396
|
+
*/
|
|
5397
|
+
401: unknown;
|
|
5398
|
+
};
|
|
5399
|
+
type GetAnalyticsChannelsResponses = {
|
|
5400
|
+
/**
|
|
5401
|
+
* Channel rows, or an unreachable source
|
|
5402
|
+
*/
|
|
5403
|
+
200: AnalyticsChannels;
|
|
5404
|
+
};
|
|
5405
|
+
type GetAnalyticsChannelsResponse = GetAnalyticsChannelsResponses[keyof GetAnalyticsChannelsResponses];
|
|
5406
|
+
type ListSubscriptionsData = {
|
|
5407
|
+
body?: never;
|
|
5408
|
+
path?: never;
|
|
5409
|
+
query?: {
|
|
5410
|
+
/**
|
|
5411
|
+
* Required with an org key (sk_xxx); must match the token's site when using a site token.
|
|
5412
|
+
*/
|
|
5413
|
+
site_id?: string;
|
|
5414
|
+
/**
|
|
5415
|
+
* Exact status filter (verbatim Stripe values).
|
|
5416
|
+
*/
|
|
5417
|
+
status?: string;
|
|
5418
|
+
/**
|
|
5419
|
+
* Max rows (default 50, max 100).
|
|
5420
|
+
*/
|
|
5421
|
+
limit?: string;
|
|
5422
|
+
offset?: string;
|
|
5423
|
+
};
|
|
5424
|
+
url: "/api/v1/subscriptions";
|
|
5425
|
+
};
|
|
5426
|
+
type ListSubscriptionsErrors = {
|
|
5427
|
+
/**
|
|
5428
|
+
* site_id mismatch / does not belong to this organization
|
|
5429
|
+
*/
|
|
5430
|
+
400: unknown;
|
|
5431
|
+
/**
|
|
5432
|
+
* Missing or invalid token
|
|
5433
|
+
*/
|
|
5434
|
+
401: unknown;
|
|
5435
|
+
};
|
|
5436
|
+
type ListSubscriptionsResponses = {
|
|
5437
|
+
/**
|
|
5438
|
+
* The subscriptions
|
|
5439
|
+
*/
|
|
5440
|
+
200: SubscriptionsList;
|
|
5441
|
+
};
|
|
5442
|
+
type ListSubscriptionsResponse = ListSubscriptionsResponses[keyof ListSubscriptionsResponses];
|
|
5443
|
+
type CancelSubscriptionData = {
|
|
5444
|
+
body?: never;
|
|
5445
|
+
path: {
|
|
5446
|
+
subscriptionId: string;
|
|
5447
|
+
};
|
|
5448
|
+
query?: never;
|
|
5449
|
+
url: "/api/v1/subscriptions/{subscriptionId}/cancel";
|
|
5450
|
+
};
|
|
5451
|
+
type CancelSubscriptionErrors = {
|
|
5452
|
+
/**
|
|
5453
|
+
* Site tokens are not permitted
|
|
5454
|
+
*/
|
|
5455
|
+
403: unknown;
|
|
5456
|
+
/**
|
|
5457
|
+
* Subscription not found (or belongs to another org)
|
|
5458
|
+
*/
|
|
5459
|
+
404: unknown;
|
|
5460
|
+
/**
|
|
5461
|
+
* Subscription already ended (code ended) — terminal locally, or Stripe says it is already canceled
|
|
5462
|
+
*/
|
|
5463
|
+
409: unknown;
|
|
5464
|
+
/**
|
|
5465
|
+
* Stripe unreachable — retry
|
|
5466
|
+
*/
|
|
5467
|
+
502: unknown;
|
|
5468
|
+
};
|
|
5469
|
+
type CancelSubscriptionResponses = {
|
|
5470
|
+
/**
|
|
5471
|
+
* The updated subscription
|
|
5472
|
+
*/
|
|
5473
|
+
200: SubscriptionSummary;
|
|
5474
|
+
};
|
|
5475
|
+
type CancelSubscriptionResponse = CancelSubscriptionResponses[keyof CancelSubscriptionResponses];
|
|
5476
|
+
type TeardownSiteSubscriptionsData = {
|
|
5477
|
+
body?: SubscriptionsTeardownBody;
|
|
5478
|
+
path: {
|
|
5479
|
+
siteId: string;
|
|
5480
|
+
};
|
|
5481
|
+
query?: never;
|
|
5482
|
+
url: "/api/v1/sites/{siteId}/subscriptions/teardown";
|
|
5483
|
+
};
|
|
5484
|
+
type TeardownSiteSubscriptionsErrors = {
|
|
5485
|
+
/**
|
|
5486
|
+
* Site tokens are not permitted
|
|
5487
|
+
*/
|
|
5488
|
+
403: unknown;
|
|
5489
|
+
/**
|
|
5490
|
+
* 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).
|
|
5491
|
+
*/
|
|
5492
|
+
404: Error;
|
|
5493
|
+
};
|
|
5494
|
+
type TeardownSiteSubscriptionsError = TeardownSiteSubscriptionsErrors[keyof TeardownSiteSubscriptionsErrors];
|
|
5495
|
+
type TeardownSiteSubscriptionsResponses = {
|
|
5496
|
+
/**
|
|
5497
|
+
* Teardown outcome
|
|
5498
|
+
*/
|
|
5499
|
+
200: SubscriptionsTeardownResult;
|
|
5500
|
+
};
|
|
5501
|
+
type TeardownSiteSubscriptionsResponse = TeardownSiteSubscriptionsResponses[keyof TeardownSiteSubscriptionsResponses];
|
|
5502
|
+
type ReactivateSiteSubscriptionsTeardownData = {
|
|
5503
|
+
body?: SubscriptionsReactivateBody;
|
|
5504
|
+
path: {
|
|
5505
|
+
siteId: string;
|
|
5506
|
+
};
|
|
5507
|
+
query?: never;
|
|
5508
|
+
url: "/api/v1/sites/{siteId}/subscriptions/reactivate-teardown";
|
|
5509
|
+
};
|
|
5510
|
+
type ReactivateSiteSubscriptionsTeardownErrors = {
|
|
5511
|
+
/**
|
|
5512
|
+
* Unknown key in the body (a misspelled `reason` is refused, never ignored)
|
|
5513
|
+
*/
|
|
5514
|
+
400: Error;
|
|
5515
|
+
/**
|
|
5516
|
+
* Site tokens are not permitted
|
|
5517
|
+
*/
|
|
5518
|
+
403: unknown;
|
|
5519
|
+
/**
|
|
5520
|
+
* 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).
|
|
5521
|
+
*/
|
|
5522
|
+
404: Error;
|
|
5523
|
+
};
|
|
5524
|
+
type ReactivateSiteSubscriptionsTeardownError = ReactivateSiteSubscriptionsTeardownErrors[keyof ReactivateSiteSubscriptionsTeardownErrors];
|
|
5525
|
+
type ReactivateSiteSubscriptionsTeardownResponses = {
|
|
5526
|
+
/**
|
|
5527
|
+
* Reactivation outcome
|
|
5528
|
+
*/
|
|
5529
|
+
200: SubscriptionsReactivateResult;
|
|
5530
|
+
};
|
|
5531
|
+
type ReactivateSiteSubscriptionsTeardownResponse = ReactivateSiteSubscriptionsTeardownResponses[keyof ReactivateSiteSubscriptionsTeardownResponses];
|
|
5532
|
+
type CreatePreviewSessionData = {
|
|
5533
|
+
body: CreatePreviewSession;
|
|
5534
|
+
path: {
|
|
5535
|
+
siteId: string;
|
|
5536
|
+
};
|
|
5537
|
+
query?: never;
|
|
5538
|
+
url: "/api/v1/sites/{siteId}/preview-session";
|
|
5539
|
+
};
|
|
5540
|
+
type CreatePreviewSessionErrors = {
|
|
5541
|
+
/**
|
|
5542
|
+
* Unauthorized
|
|
5543
|
+
*/
|
|
5544
|
+
401: unknown;
|
|
5545
|
+
/**
|
|
5546
|
+
* Site tokens are not permitted — org API key only
|
|
5547
|
+
*/
|
|
5548
|
+
403: unknown;
|
|
5549
|
+
/**
|
|
5550
|
+
* Site not found — `code` is 'site_not_found' (no such site) or 'site_not_accessible' (another organization's site).
|
|
5551
|
+
*/
|
|
5552
|
+
404: Error;
|
|
5553
|
+
/**
|
|
5554
|
+
* Preview customer record could not be created
|
|
5555
|
+
*/
|
|
5556
|
+
500: unknown;
|
|
5557
|
+
};
|
|
5558
|
+
type CreatePreviewSessionError = CreatePreviewSessionErrors[keyof CreatePreviewSessionErrors];
|
|
5559
|
+
type CreatePreviewSessionResponses = {
|
|
5560
|
+
/**
|
|
5561
|
+
* Preview session minted
|
|
5562
|
+
*/
|
|
5563
|
+
200: PreviewSessionResult;
|
|
5564
|
+
};
|
|
5565
|
+
type CreatePreviewSessionResponse = CreatePreviewSessionResponses[keyof CreatePreviewSessionResponses];
|
|
5566
|
+
type ListInvoicesData = {
|
|
5567
|
+
body?: never;
|
|
5568
|
+
path?: never;
|
|
5569
|
+
query?: {
|
|
5570
|
+
site_id?: string;
|
|
5571
|
+
/**
|
|
5572
|
+
* Comma-separated derived labels to keep (awaiting_payment, overdue, paid, voided, …)
|
|
5573
|
+
*/
|
|
5574
|
+
label?: string;
|
|
5575
|
+
/**
|
|
4762
5576
|
* Comma-separated raw statuses
|
|
4763
5577
|
*/
|
|
4764
5578
|
status?: string;
|
|
@@ -5760,6 +6574,54 @@ type CancelRetainerResponses = {
|
|
|
5760
6574
|
200: Retainer;
|
|
5761
6575
|
};
|
|
5762
6576
|
type CancelRetainerResponse = CancelRetainerResponses[keyof CancelRetainerResponses];
|
|
6577
|
+
type GetConsentConfigWithSiteTokenData = {
|
|
6578
|
+
body?: never;
|
|
6579
|
+
path?: never;
|
|
6580
|
+
query?: never;
|
|
6581
|
+
url: "/api/v1/site-prefs";
|
|
6582
|
+
};
|
|
6583
|
+
type GetConsentConfigWithSiteTokenErrors = {
|
|
6584
|
+
/**
|
|
6585
|
+
* Unauthorized - requires site token
|
|
6586
|
+
*/
|
|
6587
|
+
401: Error;
|
|
6588
|
+
/**
|
|
6589
|
+
* No consent config exists for this site yet
|
|
6590
|
+
*/
|
|
6591
|
+
404: Error;
|
|
6592
|
+
};
|
|
6593
|
+
type GetConsentConfigWithSiteTokenError = GetConsentConfigWithSiteTokenErrors[keyof GetConsentConfigWithSiteTokenErrors];
|
|
6594
|
+
type GetConsentConfigWithSiteTokenResponses = {
|
|
6595
|
+
/**
|
|
6596
|
+
* The site's consent configuration
|
|
6597
|
+
*/
|
|
6598
|
+
200: ConsentConfig;
|
|
6599
|
+
};
|
|
6600
|
+
type GetConsentConfigWithSiteTokenResponse = GetConsentConfigWithSiteTokenResponses[keyof GetConsentConfigWithSiteTokenResponses];
|
|
6601
|
+
type UpsertConsentConfigWithSiteTokenData = {
|
|
6602
|
+
body: UpsertConsentConfig;
|
|
6603
|
+
path?: never;
|
|
6604
|
+
query?: never;
|
|
6605
|
+
url: "/api/v1/site-prefs";
|
|
6606
|
+
};
|
|
6607
|
+
type UpsertConsentConfigWithSiteTokenErrors = {
|
|
6608
|
+
/**
|
|
6609
|
+
* Validation error
|
|
6610
|
+
*/
|
|
6611
|
+
400: Error;
|
|
6612
|
+
/**
|
|
6613
|
+
* Unauthorized - requires site token
|
|
6614
|
+
*/
|
|
6615
|
+
401: Error;
|
|
6616
|
+
};
|
|
6617
|
+
type UpsertConsentConfigWithSiteTokenError = UpsertConsentConfigWithSiteTokenErrors[keyof UpsertConsentConfigWithSiteTokenErrors];
|
|
6618
|
+
type UpsertConsentConfigWithSiteTokenResponses = {
|
|
6619
|
+
/**
|
|
6620
|
+
* The upserted consent configuration
|
|
6621
|
+
*/
|
|
6622
|
+
200: ConsentConfigResult;
|
|
6623
|
+
};
|
|
6624
|
+
type UpsertConsentConfigWithSiteTokenResponse = UpsertConsentConfigWithSiteTokenResponses[keyof UpsertConsentConfigWithSiteTokenResponses];
|
|
5763
6625
|
type ListFormsWithSiteTokenData = {
|
|
5764
6626
|
body?: never;
|
|
5765
6627
|
path?: never;
|
|
@@ -5869,7 +6731,7 @@ type CreateSiteErrors = {
|
|
|
5869
6731
|
*/
|
|
5870
6732
|
403: Error;
|
|
5871
6733
|
/**
|
|
5872
|
-
*
|
|
6734
|
+
* Conflict. Either a site with this external_id already exists, or (code `analytics_id_taken`) the analytics_id is already claimed by another site — the latter is permanent, so do not retry it.
|
|
5873
6735
|
*/
|
|
5874
6736
|
409: Error;
|
|
5875
6737
|
};
|
|
@@ -6120,6 +6982,10 @@ type UpdateSiteAnalyticsErrors = {
|
|
|
6120
6982
|
* Site not found
|
|
6121
6983
|
*/
|
|
6122
6984
|
404: Error;
|
|
6985
|
+
/**
|
|
6986
|
+
* The analytics_id is already claimed by another site. Permanent: the id belongs to that site until a human moves it, so do not retry.
|
|
6987
|
+
*/
|
|
6988
|
+
409: Error;
|
|
6123
6989
|
};
|
|
6124
6990
|
type UpdateSiteAnalyticsError = UpdateSiteAnalyticsErrors[keyof UpdateSiteAnalyticsErrors];
|
|
6125
6991
|
type UpdateSiteAnalyticsResponses = {
|
|
@@ -7053,13 +7919,46 @@ type GetGeoData = {
|
|
|
7053
7919
|
query?: never;
|
|
7054
7920
|
url: "/v1/geo";
|
|
7055
7921
|
};
|
|
7922
|
+
type GetGeoErrors = {
|
|
7923
|
+
/**
|
|
7924
|
+
* Too many requests from this IP — retry after the Retry-After interval
|
|
7925
|
+
*/
|
|
7926
|
+
429: Error;
|
|
7927
|
+
};
|
|
7928
|
+
type GetGeoError = GetGeoErrors[keyof GetGeoErrors];
|
|
7056
7929
|
type GetGeoResponses = {
|
|
7057
7930
|
/**
|
|
7058
|
-
* The visitor's country
|
|
7931
|
+
* The visitor's country/region (or nulls) and the consent shape verdict
|
|
7059
7932
|
*/
|
|
7060
7933
|
200: GeoSuggestion;
|
|
7061
7934
|
};
|
|
7062
7935
|
type GetGeoResponse = GetGeoResponses[keyof GetGeoResponses];
|
|
7936
|
+
type GetPublicConsentPrefsData = {
|
|
7937
|
+
body?: never;
|
|
7938
|
+
path: {
|
|
7939
|
+
configId: string;
|
|
7940
|
+
};
|
|
7941
|
+
query?: never;
|
|
7942
|
+
url: "/v1/prefs/{configId}";
|
|
7943
|
+
};
|
|
7944
|
+
type GetPublicConsentPrefsErrors = {
|
|
7945
|
+
/**
|
|
7946
|
+
* Config not found
|
|
7947
|
+
*/
|
|
7948
|
+
404: Error;
|
|
7949
|
+
/**
|
|
7950
|
+
* Too many requests for this config from this IP — retry after the Retry-After interval
|
|
7951
|
+
*/
|
|
7952
|
+
429: Error;
|
|
7953
|
+
};
|
|
7954
|
+
type GetPublicConsentPrefsError = GetPublicConsentPrefsErrors[keyof GetPublicConsentPrefsErrors];
|
|
7955
|
+
type GetPublicConsentPrefsResponses = {
|
|
7956
|
+
/**
|
|
7957
|
+
* Public consent configuration
|
|
7958
|
+
*/
|
|
7959
|
+
200: ConsentPrefs;
|
|
7960
|
+
};
|
|
7961
|
+
type GetPublicConsentPrefsResponse = GetPublicConsentPrefsResponses[keyof GetPublicConsentPrefsResponses];
|
|
7063
7962
|
type AccountLoginData = {
|
|
7064
7963
|
body: AccountLoginRequest;
|
|
7065
7964
|
path?: never;
|
|
@@ -7765,7 +8664,7 @@ declare const revokeCustomerAccess: <ThrowOnError extends boolean = false>(optio
|
|
|
7765
8664
|
/**
|
|
7766
8665
|
* One-call business summary (site token, or org key with site_id)
|
|
7767
8666
|
*
|
|
7768
|
-
* Revenue (today / rolling 7d / rolling 30d), needs-attention items, product counts and low stock — ONE call answering "how's my business?". Money aggregates cover the revenue family (paid/partially_refunded/refunded/disputed, test orders excluded), grouped per charge currency with the site currency first; the `settled` block is Stripe's own settlement-currency conversion and matches the Stripe dashboard exactly when `complete`. `visitors`
|
|
8667
|
+
* Revenue (today / rolling 7d / rolling 30d), needs-attention items, product counts and low stock — ONE call answering "how's my business?". Money aggregates cover the revenue family (paid/partially_refunded/refunded/disputed, test orders excluded), grouped per charge currency with the site currency first; the `settled` block is Stripe's own settlement-currency conversion and matches the Stripe dashboard exactly when `complete`. `visitors` carries the 7-day traffic tile — a DISTINCT visitor count (not the sum of its sparkline) plus one point per local day, over the same window `GET /analytics/summary?period=7` resolves, so the two surfaces cannot disagree. It is null when the site has no analytics identity or the source is unreachable: a traffic outage costs that tile and nothing else on this response.
|
|
7769
8668
|
*/
|
|
7770
8669
|
declare const getBusinessSummary: <ThrowOnError extends boolean = false>(options?: Options<GetBusinessSummaryData, ThrowOnError>) => RequestResult<GetBusinessSummaryResponses, GetBusinessSummaryErrors, ThrowOnError, "fields">;
|
|
7771
8670
|
/**
|
|
@@ -7798,6 +8697,138 @@ declare const getNextPayout: <ThrowOnError extends boolean = false>(options?: Op
|
|
|
7798
8697
|
* Sets/clears merchant_fulfilled_at (+ optional tracking_number) — the merchant's own "I shipped it", ONE flag for the whole order. Allowed while the order is paid, partially_refunded, or disputed (disputed deliberately: dispute evidence wants the tracking number recorded); 409 on pending/failed/expired/refunded. Feeds the Orders view's unfulfilled filter and the needs-attention feed.
|
|
7799
8698
|
*/
|
|
7800
8699
|
declare const setOrderFulfillment: <ThrowOnError extends boolean = false>(options: Options<SetOrderFulfillmentData, ThrowOnError>) => RequestResult<SetOrderFulfillmentResponses, SetOrderFulfillmentErrors, ThrowOnError, "fields">;
|
|
8700
|
+
/**
|
|
8701
|
+
* Collection status for a site (site token, or org key with site_id)
|
|
8702
|
+
*
|
|
8703
|
+
* Whether this site can collect at all, the zone its reports are bucketed in, and when it first recorded anything. Ask this before rendering an empty panel: it separates 'not collecting' (no analytics identity - nothing will ever arrive) from 'collecting, no traffic yet', which need different things said to the merchant.
|
|
8704
|
+
*/
|
|
8705
|
+
declare const getAnalyticsStatus: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsStatusData, ThrowOnError>) => RequestResult<GetAnalyticsStatusResponses, GetAnalyticsStatusErrors, ThrowOnError, "fields">;
|
|
8706
|
+
/**
|
|
8707
|
+
* Top-line metrics with period-over-period comparison
|
|
8708
|
+
*
|
|
8709
|
+
* Visitors, visits, pageviews, views per visit, bounce rate and mean visit duration for the period, plus the immediately preceding same-length window for deltas. `previous` is null when that window is not fully covered by collection. Note the two scopings: visits, bounce rate and duration describe visits that STARTED in the window; pageviews and visitors count events INSIDE it, which is what keeps this tile agreeing with the chart beside it.
|
|
8710
|
+
*/
|
|
8711
|
+
declare const getAnalyticsSummary: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsSummaryData, ThrowOnError>) => RequestResult<GetAnalyticsSummaryResponses, GetAnalyticsSummaryErrors, ThrowOnError, "fields">;
|
|
8712
|
+
/**
|
|
8713
|
+
* Visitors by day for the period
|
|
8714
|
+
*
|
|
8715
|
+
* One row per local day with traffic, bucketed in the site's reporting timezone. Days with no traffic are omitted rather than zero-filled.
|
|
8716
|
+
*/
|
|
8717
|
+
declare const getAnalyticsTimeseries: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsTimeseriesData, ThrowOnError>) => RequestResult<GetAnalyticsTimeseriesResponses, GetAnalyticsTimeseriesErrors, ThrowOnError, "fields">;
|
|
8718
|
+
/**
|
|
8719
|
+
* Visitors active in the last 5 minutes
|
|
8720
|
+
*
|
|
8721
|
+
* Distinct visitors seen in the last 5 minutes, with the instant the count was taken. Throttled harder than the report endpoints because it is polled. Carries `as_of` rather than a window: a stale count with no freshness is indistinguishable from a live zero.
|
|
8722
|
+
*/
|
|
8723
|
+
declare const getAnalyticsRealtime: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsRealtimeData, ThrowOnError>) => RequestResult<GetAnalyticsRealtimeResponses, GetAnalyticsRealtimeErrors, ThrowOnError, "fields">;
|
|
8724
|
+
/**
|
|
8725
|
+
* source breakdown for the period
|
|
8726
|
+
*
|
|
8727
|
+
* Ranked source rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
8728
|
+
*/
|
|
8729
|
+
declare const getAnalyticsSources: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsSourcesData, ThrowOnError>) => RequestResult<GetAnalyticsSourcesResponses, GetAnalyticsSourcesErrors, ThrowOnError, "fields">;
|
|
8730
|
+
/**
|
|
8731
|
+
* campaign breakdown for the period
|
|
8732
|
+
*
|
|
8733
|
+
* Ranked campaign rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
8734
|
+
*/
|
|
8735
|
+
declare const getAnalyticsCampaigns: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsCampaignsData, ThrowOnError>) => RequestResult<GetAnalyticsCampaignsResponses, GetAnalyticsCampaignsErrors, ThrowOnError, "fields">;
|
|
8736
|
+
/**
|
|
8737
|
+
* utm_medium breakdown for the period
|
|
8738
|
+
*
|
|
8739
|
+
* Ranked utm_medium rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
8740
|
+
*/
|
|
8741
|
+
declare const getAnalyticsUtmMedium: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsUtmMediumData, ThrowOnError>) => RequestResult<GetAnalyticsUtmMediumResponses, GetAnalyticsUtmMediumErrors, ThrowOnError, "fields">;
|
|
8742
|
+
/**
|
|
8743
|
+
* utm_source breakdown for the period
|
|
8744
|
+
*
|
|
8745
|
+
* Ranked utm_source rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
8746
|
+
*/
|
|
8747
|
+
declare const getAnalyticsUtmSource: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsUtmSourceData, ThrowOnError>) => RequestResult<GetAnalyticsUtmSourceResponses, GetAnalyticsUtmSourceErrors, ThrowOnError, "fields">;
|
|
8748
|
+
/**
|
|
8749
|
+
* campaign breakdown for the period
|
|
8750
|
+
*
|
|
8751
|
+
* Ranked campaign rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
8752
|
+
*/
|
|
8753
|
+
declare const getAnalyticsUtmCampaign: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsUtmCampaignData, ThrowOnError>) => RequestResult<GetAnalyticsUtmCampaignResponses, GetAnalyticsUtmCampaignErrors, ThrowOnError, "fields">;
|
|
8754
|
+
/**
|
|
8755
|
+
* utm_content breakdown for the period
|
|
8756
|
+
*
|
|
8757
|
+
* Ranked utm_content rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
8758
|
+
*/
|
|
8759
|
+
declare const getAnalyticsUtmContent: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsUtmContentData, ThrowOnError>) => RequestResult<GetAnalyticsUtmContentResponses, GetAnalyticsUtmContentErrors, ThrowOnError, "fields">;
|
|
8760
|
+
/**
|
|
8761
|
+
* utm_term breakdown for the period
|
|
8762
|
+
*
|
|
8763
|
+
* Ranked utm_term rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
8764
|
+
*/
|
|
8765
|
+
declare const getAnalyticsUtmTerm: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsUtmTermData, ThrowOnError>) => RequestResult<GetAnalyticsUtmTermResponses, GetAnalyticsUtmTermErrors, ThrowOnError, "fields">;
|
|
8766
|
+
/**
|
|
8767
|
+
* pathname breakdown for the period
|
|
8768
|
+
*
|
|
8769
|
+
* Ranked pathname rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
8770
|
+
*/
|
|
8771
|
+
declare const getAnalyticsPages: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsPagesData, ThrowOnError>) => RequestResult<GetAnalyticsPagesResponses, GetAnalyticsPagesErrors, ThrowOnError, "fields">;
|
|
8772
|
+
/**
|
|
8773
|
+
* pathname breakdown for the period
|
|
8774
|
+
*
|
|
8775
|
+
* Ranked pathname rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
8776
|
+
*/
|
|
8777
|
+
declare const getAnalyticsEntryPages: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsEntryPagesData, ThrowOnError>) => RequestResult<GetAnalyticsEntryPagesResponses, GetAnalyticsEntryPagesErrors, ThrowOnError, "fields">;
|
|
8778
|
+
/**
|
|
8779
|
+
* pathname breakdown for the period
|
|
8780
|
+
*
|
|
8781
|
+
* Ranked pathname rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
8782
|
+
*/
|
|
8783
|
+
declare const getAnalyticsExitPages: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsExitPagesData, ThrowOnError>) => RequestResult<GetAnalyticsExitPagesResponses, GetAnalyticsExitPagesErrors, ThrowOnError, "fields">;
|
|
8784
|
+
/**
|
|
8785
|
+
* referrer_host breakdown for the period
|
|
8786
|
+
*
|
|
8787
|
+
* Ranked referrer_host rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
8788
|
+
*/
|
|
8789
|
+
declare const getAnalyticsReferrers: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsReferrersData, ThrowOnError>) => RequestResult<GetAnalyticsReferrersResponses, GetAnalyticsReferrersErrors, ThrowOnError, "fields">;
|
|
8790
|
+
/**
|
|
8791
|
+
* country breakdown for the period
|
|
8792
|
+
*
|
|
8793
|
+
* Ranked country rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
8794
|
+
*/
|
|
8795
|
+
declare const getAnalyticsCountries: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsCountriesData, ThrowOnError>) => RequestResult<GetAnalyticsCountriesResponses, GetAnalyticsCountriesErrors, ThrowOnError, "fields">;
|
|
8796
|
+
/**
|
|
8797
|
+
* region breakdown for the period
|
|
8798
|
+
*
|
|
8799
|
+
* Ranked region rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
8800
|
+
*/
|
|
8801
|
+
declare const getAnalyticsRegions: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsRegionsData, ThrowOnError>) => RequestResult<GetAnalyticsRegionsResponses, GetAnalyticsRegionsErrors, ThrowOnError, "fields">;
|
|
8802
|
+
/**
|
|
8803
|
+
* city breakdown for the period
|
|
8804
|
+
*
|
|
8805
|
+
* Ranked city rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
8806
|
+
*/
|
|
8807
|
+
declare const getAnalyticsCities: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsCitiesData, ThrowOnError>) => RequestResult<GetAnalyticsCitiesResponses, GetAnalyticsCitiesErrors, ThrowOnError, "fields">;
|
|
8808
|
+
/**
|
|
8809
|
+
* device breakdown for the period
|
|
8810
|
+
*
|
|
8811
|
+
* Ranked device rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
8812
|
+
*/
|
|
8813
|
+
declare const getAnalyticsDevices: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsDevicesData, ThrowOnError>) => RequestResult<GetAnalyticsDevicesResponses, GetAnalyticsDevicesErrors, ThrowOnError, "fields">;
|
|
8814
|
+
/**
|
|
8815
|
+
* browser breakdown for the period
|
|
8816
|
+
*
|
|
8817
|
+
* Ranked browser rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
8818
|
+
*/
|
|
8819
|
+
declare const getAnalyticsBrowsers: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsBrowsersData, ThrowOnError>) => RequestResult<GetAnalyticsBrowsersResponses, GetAnalyticsBrowsersErrors, ThrowOnError, "fields">;
|
|
8820
|
+
/**
|
|
8821
|
+
* os breakdown for the period
|
|
8822
|
+
*
|
|
8823
|
+
* Ranked os rows for the window. A null dimension is preserved as null rather than rendered server-side, and an empty result is an empty list, not an error.
|
|
8824
|
+
*/
|
|
8825
|
+
declare const getAnalyticsOperatingSystems: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsOperatingSystemsData, ThrowOnError>) => RequestResult<GetAnalyticsOperatingSystemsResponses, GetAnalyticsOperatingSystemsErrors, ThrowOnError, "fields">;
|
|
8826
|
+
/**
|
|
8827
|
+
* Acquisition channels for the period
|
|
8828
|
+
*
|
|
8829
|
+
* 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.
|
|
8830
|
+
*/
|
|
8831
|
+
declare const getAnalyticsChannels: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsChannelsData, ThrowOnError>) => RequestResult<GetAnalyticsChannelsResponses, GetAnalyticsChannelsErrors, ThrowOnError, "fields">;
|
|
7801
8832
|
/**
|
|
7802
8833
|
* List subscriptions (site token, or org key with site_id)
|
|
7803
8834
|
*
|
|
@@ -7944,6 +8975,18 @@ declare const resumeRetainer: <ThrowOnError extends boolean = false>(options: Op
|
|
|
7944
8975
|
* End a retainer at the end of its current period; the open cycle stays payable (org key only)
|
|
7945
8976
|
*/
|
|
7946
8977
|
declare const cancelRetainer: <ThrowOnError extends boolean = false>(options: Options<CancelRetainerData, ThrowOnError>) => RequestResult<CancelRetainerResponses, CancelRetainerErrors, ThrowOnError, "fields">;
|
|
8978
|
+
/**
|
|
8979
|
+
* Get the site's consent config (site token)
|
|
8980
|
+
*
|
|
8981
|
+
* Returns the cookie-consent configuration for the site associated with your site token, including the public config id its ConsentProvider fetches at /v1/prefs/{id}. Requires a site token (st_xxx), not an org API key.
|
|
8982
|
+
*/
|
|
8983
|
+
declare const getConsentConfigWithSiteToken: <ThrowOnError extends boolean = false>(options?: Options<GetConsentConfigWithSiteTokenData, ThrowOnError>) => RequestResult<GetConsentConfigWithSiteTokenResponses, GetConsentConfigWithSiteTokenErrors, ThrowOnError, "fields">;
|
|
8984
|
+
/**
|
|
8985
|
+
* Create or update the site's consent config (site token)
|
|
8986
|
+
*
|
|
8987
|
+
* Upserts the cookie-consent configuration for the site associated with your site token: the first call creates it (created: true), later calls update mode/policy path in place (created: false) — the config id never changes. policy_path is tri-state: omit to leave unchanged, null to clear, string to set. Mode changes reach published sites within ~60 seconds (the public config cache TTL), no republish needed. Every successful write is audited. Requires a site token (st_xxx), not an org API key.
|
|
8988
|
+
*/
|
|
8989
|
+
declare const upsertConsentConfigWithSiteToken: <ThrowOnError extends boolean = false>(options: Options<UpsertConsentConfigWithSiteTokenData, ThrowOnError>) => RequestResult<UpsertConsentConfigWithSiteTokenResponses, UpsertConsentConfigWithSiteTokenErrors, ThrowOnError, "fields">;
|
|
7947
8990
|
/**
|
|
7948
8991
|
* List all forms (site token)
|
|
7949
8992
|
*
|
|
@@ -8013,7 +9056,7 @@ declare const getSiteAnalytics: <ThrowOnError extends boolean = false>(options:
|
|
|
8013
9056
|
/**
|
|
8014
9057
|
* Set the site's analytics identity and reporting timezone (org key only)
|
|
8015
9058
|
*
|
|
8016
|
-
* Points an existing site at its analytics identity and/or SEEDS its reporting timezone — the write path landingsite-app's sync and one-time backfill use for sites provisioned before analytics existed. Omitted fields are left alone, so a backfill can patch only what is missing. `timezone` is seed-only: it fills an unset zone and never overwrites or clears one, because invoicing owns that column and reads it for due dates and reminder times — deliberate changes go to PATCH /sites/{siteId}/invoice-settings. `analytics_id` does overwrite (null clears it),
|
|
9059
|
+
* Points an existing site at its analytics identity and/or SEEDS its reporting timezone — the write path landingsite-app's sync and one-time backfill use for sites provisioned before analytics existed. Omitted fields are left alone, so a backfill can patch only what is missing. `timezone` is seed-only: it fills an unset zone and never overwrites or clears one, because invoicing owns that column and reads it for due dates and reminder times — deliberate changes go to PATCH /sites/{siteId}/invoice-settings. `analytics_id` does overwrite (null clears it), but it is UNIQUE across sites: a claim on an id another site already holds is REFUSED with 409, not merely alerted. That refusal is permanent — the id belongs to the other site until a human moves it — so do not retry it. Requires an organization API key (sk_xxx); site tokens are explicitly rejected, because this endpoint can repoint a merchant's panel at another tenant's traffic.
|
|
8017
9060
|
*/
|
|
8018
9061
|
declare const updateSiteAnalytics: <ThrowOnError extends boolean = false>(options: Options<UpdateSiteAnalyticsData, ThrowOnError>) => RequestResult<UpdateSiteAnalyticsResponses, UpdateSiteAnalyticsErrors, ThrowOnError, "fields">;
|
|
8019
9062
|
/**
|
|
@@ -8193,11 +9236,17 @@ declare const getOrderSession: <ThrowOnError extends boolean = false>(options: O
|
|
|
8193
9236
|
*/
|
|
8194
9237
|
declare const downloadFile: <ThrowOnError extends boolean = false>(options: Options<DownloadFileData, ThrowOnError>) => RequestResult<DownloadFileResponses, DownloadFileErrors, ThrowOnError, "fields">;
|
|
8195
9238
|
/**
|
|
8196
|
-
* Get the visitor's country (market suggestion)
|
|
9239
|
+
* Get the visitor's country (market suggestion + consent shape)
|
|
9240
|
+
*
|
|
9241
|
+
* Public (unauthenticated) market-suggestion hint: the visitor's country as seen by the edge, for the storefront's currency picker to SUGGEST a local market. Nothing converts until the buyer explicitly chooses — product reads and checkout stay in the site's currency unless they carry an explicit country. This is deliberately the only endpoint that reads request geography. Also carries the cookie-consent shape verdict: region (ISO 3166-2 subdivision) and shape ('strict' | 'strict-trackers' | 'soft'), computed server-side so the membership lists can change without republishing sites. Per-requester geography — served private, no-store, never shared-cached. Best-effort rate-limited per IP.
|
|
9242
|
+
*/
|
|
9243
|
+
declare const getGeo: <ThrowOnError extends boolean = false>(options?: Options<GetGeoData, ThrowOnError>) => RequestResult<GetGeoResponses, GetGeoErrors, ThrowOnError, "fields">;
|
|
9244
|
+
/**
|
|
9245
|
+
* Get public consent config
|
|
8197
9246
|
*
|
|
8198
|
-
* Public (unauthenticated)
|
|
9247
|
+
* Public (unauthenticated) cookie-consent config self-fetch — what a published site's ConsentProvider reads at runtime. The unguessable config id is the enumeration control; the response is public-by-design and allowlisted to exactly these fields. Shared-cacheable for 60 seconds (the propagation bound for mode changes); the 404 is cacheable too. Best-effort rate-limited per IP.
|
|
8199
9248
|
*/
|
|
8200
|
-
declare const
|
|
9249
|
+
declare const getPublicConsentPrefs: <ThrowOnError extends boolean = false>(options: Options<GetPublicConsentPrefsData, ThrowOnError>) => RequestResult<GetPublicConsentPrefsResponses, GetPublicConsentPrefsErrors, ThrowOnError, "fields">;
|
|
8201
9250
|
/**
|
|
8202
9251
|
* Email a sign-in link
|
|
8203
9252
|
*
|
|
@@ -8289,4 +9338,4 @@ declare const resolveManageLink: <ThrowOnError extends boolean = false>(options:
|
|
|
8289
9338
|
*/
|
|
8290
9339
|
declare const actOnManageLink: <ThrowOnError extends boolean = false>(options: Options<ActOnManageLinkData, ThrowOnError>) => RequestResult<ActOnManageLinkResponses, ActOnManageLinkErrors, ThrowOnError, "fields">;
|
|
8291
9340
|
|
|
8292
|
-
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 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 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 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 EmailDelivery, 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 GetBusinessSummaryData, type GetBusinessSummaryErrors, type GetBusinessSummaryResponse, type GetBusinessSummaryResponses, type GetCartSummaryData, type GetCartSummaryError, type GetCartSummaryErrors, type GetCartSummaryResponse, type GetCartSummaryResponses, 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 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 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 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 GetPublicProductData, type GetPublicProductError, type GetPublicProductErrors, type GetPublicProductResponse, type GetPublicProductResponses, type GetRetainerData, type GetRetainerError, type GetRetainerErrors, type GetRetainerResponse, type GetRetainerResponses, 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 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 NeedsAttentionItem, type NestedOptionInput, type NestedVariantInput, type NextPayout, type Option, type Options, type Order, type OrderCustomer, type OrderFulfillmentRequest, type OrderSessionStatus, type OrdersList, 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 ProductSubscriptionConfig, type ProductsList, type PublicOption, type PublicProduct, type PublicSubscription, type PublicSubscriptionPlan, type PublicVariant, 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 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 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 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 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 Variant, type VariantOptionValue, type VoidInvoice, type VoidInvoiceData, type VoidInvoiceError, type VoidInvoiceErrors, type VoidInvoiceResponse, type VoidInvoiceResponses, type VoidInvoiceResult, type WebhookEventResetResult, 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, createProductWithSiteToken, createRetainer, createSite, createTestOrder, createTestSubscription, createVariant, deleteEventDestination, deleteEventDestinationWithSiteToken, deleteForm, deleteOption, deleteProduct, deleteSite, deleteSubmission, deleteVariant, downloadAttachment, downloadFile, generateVariants, getBusinessSummary, getCartSummary, getCustomer, getEventDestination, getEventDestinationSecret, getEventDestinationSecretWithSiteToken, getForm, getGeo, getInvoice, getInvoicePreview, getInvoiceSettings, getInvoiceSettingsWithSiteToken, getNextPayout, getOrder, getOrderSession, getPaymentsStatus, getPerson, getProduct, getPublicProduct, getRetainer, getSalesSummary, getSite, getSiteAnalytics, getSiteCheckoutPause, getSubmission, listCustomers, listEventDeliveries, listEventDeliveriesWithSiteToken, listEventDestinations, listEventDestinationsWithSiteToken, listForms, listFormsWithSiteToken, listInvoices, listOrdersWithSiteToken, listPeople, listProducts, listProductsWithSiteToken, listRetainers, listSites, listSubmissions, listSubscriptions, markInvoicePaid, markInvoiceUncollectible, pauseRetainer, pauseSiteCheckout, previewInvoice, reactivateSiteSubscriptionsTeardown, refundOrder, remindInvoice, resendInvoice, resendOrderReceipt, resetOrderDownloads, resetWebhookEvent, resolveManageLink, resumeRetainer, retryEventDelivery, retryEventDeliveryWithSiteToken, revokeCustomerAccess, rotateEventDestinationSecret, rotateEventDestinationSecretWithSiteToken, setInvoiceReminders, setOrderFulfillment, setProductSubscription, setProductVariants, setVariantInventory, skipNextRetainerCycle, snoozeInvoice, teardownSiteSubscriptions, updateCustomer, updateCustomerBilling, updateEventDestination, updateEventDestinationWithSiteToken, updateForm, updateInvoiceRecipient, updateInvoiceSettings, updateOption, updateProduct, updateRetainer, updateSite, updateSiteAccountRoute, updateSiteAnalytics, updateSiteDomains, updateSiteInvoicing, updateSitePayments, updateVariant, voidInvoice };
|
|
9341
|
+
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 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 EmailDelivery, 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 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 GetAnalyticsReferrersData, type GetAnalyticsReferrersErrors, type GetAnalyticsReferrersResponse, type GetAnalyticsReferrersResponses, 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 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 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 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 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 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 NeedsAttentionItem, type NestedOptionInput, type NestedVariantInput, type NextPayout, type Option, type Options, type Order, type OrderCustomer, type OrderFulfillmentRequest, type OrderSessionStatus, type OrdersList, 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 ProductSubscriptionConfig, type ProductsList, type PublicOption, type PublicProduct, type PublicSubscription, type PublicSubscriptionPlan, type PublicVariant, 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 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 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 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 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, 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, createProductWithSiteToken, createRetainer, createSite, createTestOrder, createTestSubscription, createVariant, deleteEventDestination, deleteEventDestinationWithSiteToken, deleteForm, deleteOption, deleteProduct, deleteSite, deleteSubmission, deleteVariant, downloadAttachment, downloadFile, generateVariants, getAnalyticsBrowsers, getAnalyticsCampaigns, getAnalyticsChannels, getAnalyticsCities, getAnalyticsCountries, getAnalyticsDevices, getAnalyticsEntryPages, getAnalyticsExitPages, getAnalyticsOperatingSystems, getAnalyticsPages, getAnalyticsRealtime, getAnalyticsReferrers, getAnalyticsRegions, getAnalyticsSources, getAnalyticsStatus, getAnalyticsSummary, getAnalyticsTimeseries, getAnalyticsUtmCampaign, getAnalyticsUtmContent, getAnalyticsUtmMedium, getAnalyticsUtmSource, getAnalyticsUtmTerm, getBusinessSummary, getCartSummary, getConsentConfigWithSiteToken, getCustomer, getEventDestination, getEventDestinationSecret, getEventDestinationSecretWithSiteToken, getForm, getGeo, getInvoice, getInvoicePreview, getInvoiceSettings, getInvoiceSettingsWithSiteToken, getNextPayout, getOrder, getOrderSession, getPaymentsStatus, getPerson, getProduct, getPublicConsentPrefs, getPublicProduct, getRetainer, getSalesSummary, getSite, getSiteAnalytics, getSiteCheckoutPause, getSubmission, listCustomers, listEventDeliveries, listEventDeliveriesWithSiteToken, listEventDestinations, listEventDestinationsWithSiteToken, listForms, listFormsWithSiteToken, listInvoices, listOrdersWithSiteToken, listPeople, listProducts, listProductsWithSiteToken, listRetainers, listSites, listSubmissions, listSubscriptions, markInvoicePaid, markInvoiceUncollectible, pauseRetainer, pauseSiteCheckout, previewInvoice, reactivateSiteSubscriptionsTeardown, refundOrder, remindInvoice, resendInvoice, resendOrderReceipt, resetOrderDownloads, resetWebhookEvent, resolveManageLink, resumeRetainer, retryEventDelivery, retryEventDeliveryWithSiteToken, revokeCustomerAccess, rotateEventDestinationSecret, rotateEventDestinationSecretWithSiteToken, setInvoiceReminders, setOrderFulfillment, setProductSubscription, setProductVariants, setVariantInventory, skipNextRetainerCycle, snoozeInvoice, teardownSiteSubscriptions, updateCustomer, updateCustomerBilling, updateEventDestination, updateEventDestinationWithSiteToken, updateForm, updateInvoiceRecipient, updateInvoiceSettings, updateOption, updateProduct, updateRetainer, updateSite, updateSiteAccountRoute, updateSiteAnalytics, updateSiteDomains, updateSiteInvoicing, updateSitePayments, updateVariant, upsertConsentConfigWithSiteToken, voidInvoice };
|