@aifeatures/backend 0.9.0 → 0.11.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 +4 -4
- package/dist/index.d.cts +2391 -1054
- package/dist/index.d.ts +2391 -1054
- package/dist/index.js +3 -3
- package/package.json +9 -8
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: "https://aifeatures.dev" | "http://localhost:8788" | (string & {});
|
|
313
313
|
};
|
|
314
314
|
type SitePayments = {
|
|
315
315
|
site_id: string;
|
|
@@ -403,6 +403,16 @@ type ProductFulfillment = {
|
|
|
403
403
|
content_type: string | null;
|
|
404
404
|
size: number | null;
|
|
405
405
|
};
|
|
406
|
+
type SubscriptionPlan = {
|
|
407
|
+
id: string;
|
|
408
|
+
interval: "week" | "month" | "year";
|
|
409
|
+
interval_count: number;
|
|
410
|
+
percent_off_bps: number | null;
|
|
411
|
+
unit_amount: number | null;
|
|
412
|
+
title: string | null;
|
|
413
|
+
position: number;
|
|
414
|
+
active: boolean;
|
|
415
|
+
};
|
|
406
416
|
type Product = {
|
|
407
417
|
id: string;
|
|
408
418
|
site_id: string;
|
|
@@ -675,16 +685,6 @@ type AttachProductFileMultipart = {
|
|
|
675
685
|
*/
|
|
676
686
|
file?: Blob | File;
|
|
677
687
|
};
|
|
678
|
-
type SubscriptionPlan = {
|
|
679
|
-
id: string;
|
|
680
|
-
interval: "week" | "month" | "year";
|
|
681
|
-
interval_count: number;
|
|
682
|
-
percent_off_bps: number | null;
|
|
683
|
-
unit_amount: number | null;
|
|
684
|
-
title: string | null;
|
|
685
|
-
position: number;
|
|
686
|
-
active: boolean;
|
|
687
|
-
};
|
|
688
688
|
type ProductSubscriptionConfig = {
|
|
689
689
|
product_id: string;
|
|
690
690
|
subscription_required: boolean;
|
|
@@ -1620,6 +1620,14 @@ type AnalyticsSummary = {
|
|
|
1620
1620
|
bounce_rate: number;
|
|
1621
1621
|
visit_duration_seconds: number;
|
|
1622
1622
|
} | null;
|
|
1623
|
+
/**
|
|
1624
|
+
* True when the comparison could not be COMPUTED, as opposed to not existing. A channel filter resolves per window, so the previous one can hold more distinct acquisition tuples than can be resolved while the current one is fine — the current reports are then perfectly good and only the delta is lost. Null `previous` alone cannot express that: it already means 'deliberately not comparable', and a client that reads the two as one renders a failure as a decision. Same distinction `first_seen_unavailable` draws.
|
|
1625
|
+
*/
|
|
1626
|
+
previous_unavailable: boolean;
|
|
1627
|
+
/**
|
|
1628
|
+
* WHY the comparison could not be computed, when it could not. `coverage` means the first-seen lookup failed, so whether the previous window is covered is unknown — an outage, which will pass. `filter` means the previous window holds more distinct acquisition tuples than a channel filter can resolve there, which will not pass until the period is narrowed or the filter changed. The two suggest different actions, and a client that renders one sentence for both will name a cause that may not apply.
|
|
1629
|
+
*/
|
|
1630
|
+
previous_unavailable_reason?: "coverage" | "filter";
|
|
1623
1631
|
};
|
|
1624
1632
|
/**
|
|
1625
1633
|
* The half-open UTC window the values were measured over: from inclusive, to exclusive. Resolved from the site's reporting timezone.
|
|
@@ -1683,7 +1691,7 @@ type AnalyticsRealtime = {
|
|
|
1683
1691
|
type AnalyticsBreakdown = {
|
|
1684
1692
|
status: "ok";
|
|
1685
1693
|
data: Array<{
|
|
1686
|
-
[key: string]: string | number | null
|
|
1694
|
+
[key: string]: string | number | null | Array<string>;
|
|
1687
1695
|
}>;
|
|
1688
1696
|
window: {
|
|
1689
1697
|
from: string;
|
|
@@ -2349,6 +2357,27 @@ type UpdateRetainer = {
|
|
|
2349
2357
|
type RetainerSiteBody = {
|
|
2350
2358
|
site_id: string;
|
|
2351
2359
|
};
|
|
2360
|
+
type ProductReview = {
|
|
2361
|
+
id: string;
|
|
2362
|
+
rating: number;
|
|
2363
|
+
display_name: string;
|
|
2364
|
+
title: string | null;
|
|
2365
|
+
body: string;
|
|
2366
|
+
created_at: string;
|
|
2367
|
+
updated_at: string;
|
|
2368
|
+
verified_purchase: boolean;
|
|
2369
|
+
reply: string | null;
|
|
2370
|
+
reply_updated_at: string | null;
|
|
2371
|
+
};
|
|
2372
|
+
type OwnProductReview = ProductReview & {
|
|
2373
|
+
revision: number;
|
|
2374
|
+
moderation_state: "published" | "hidden";
|
|
2375
|
+
withdrawn_at: string | null;
|
|
2376
|
+
product_id: string;
|
|
2377
|
+
product_path: string | null;
|
|
2378
|
+
product_name: string | null;
|
|
2379
|
+
product_available: boolean;
|
|
2380
|
+
};
|
|
2352
2381
|
type ConsentConfig = {
|
|
2353
2382
|
mode: "adaptive" | "adaptive-with-notice" | "strict-everywhere" | "off";
|
|
2354
2383
|
policy_path: string | null;
|
|
@@ -2373,7 +2402,7 @@ type ConsentConfigResult = {
|
|
|
2373
2402
|
};
|
|
2374
2403
|
type UpsertConsentConfig = {
|
|
2375
2404
|
/**
|
|
2376
|
-
* 'adaptive' (default) follows the server's
|
|
2405
|
+
* 'adaptive' (default) follows the server's geographic policy: EEA, UK, Switzerland, or unknown country is strict; US risk, missing, or unrecognized region is strict-trackers; every other country and 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
2406
|
*/
|
|
2378
2407
|
mode: "adaptive" | "adaptive-with-notice" | "strict-everywhere" | "off";
|
|
2379
2408
|
/**
|
|
@@ -2454,6 +2483,14 @@ type Site = {
|
|
|
2454
2483
|
* Stripe Tax (automatic tax) is on for this store's checkout: Stripe calculates and collects real jurisdiction-based tax on the merchant's connected account, using the registrations and settings the merchant manages in their own Stripe Dashboard. tax_behavior decides whether tax is itemized out of the stored prices ('inclusive') or added at checkout ('exclusive').
|
|
2455
2484
|
*/
|
|
2456
2485
|
stripe_tax_enabled: boolean;
|
|
2486
|
+
/**
|
|
2487
|
+
* Soft-delete timestamp. Non-null = the site is deleted and awaiting the retention-window purge; its site token no longer authenticates and public surfaces refuse. Null for live sites. Only org-key reads ever see a deleted site. While purged_at is null the deletion is reversible (support clears deleted_at); once purged_at is set it is not.
|
|
2488
|
+
*/
|
|
2489
|
+
deleted_at: string | null;
|
|
2490
|
+
/**
|
|
2491
|
+
* Retention-window purge timestamp. Non-null = the purge already ran on this deleted site and its row was kept only because billing records (orders, subscriptions, retainers) depend on it: forms, submissions, catalog and non-financial config are gone and the row is a tombstone that CANNOT be restored. Null for live sites and for deleted sites still inside the window. Always null when deleted_at is null.
|
|
2492
|
+
*/
|
|
2493
|
+
purged_at: string | null;
|
|
2457
2494
|
/**
|
|
2458
2495
|
* The store's selling currency (lowercase ISO 4217). Every stored amount — prices, shipping rates, thresholds — is in MINOR units of this currency.
|
|
2459
2496
|
*/
|
|
@@ -3269,6 +3306,14 @@ type AccountLoginResult = {
|
|
|
3269
3306
|
};
|
|
3270
3307
|
type AccountLoginRequest = {
|
|
3271
3308
|
email: string;
|
|
3309
|
+
/**
|
|
3310
|
+
* Active same-site product to return to after login. Supply together with review_return_path.
|
|
3311
|
+
*/
|
|
3312
|
+
review_product_id?: string;
|
|
3313
|
+
/**
|
|
3314
|
+
* Local product pathname and bounded product-routing query only; no fragment, external destination, or credential parameters.
|
|
3315
|
+
*/
|
|
3316
|
+
review_return_path?: string;
|
|
3272
3317
|
};
|
|
3273
3318
|
type AccountVerifyResult = {
|
|
3274
3319
|
/**
|
|
@@ -3280,6 +3325,15 @@ type AccountVerifyResult = {
|
|
|
3280
3325
|
name: string | null;
|
|
3281
3326
|
};
|
|
3282
3327
|
expires_at: string;
|
|
3328
|
+
/**
|
|
3329
|
+
* Validated review navigation. Store the session on account_origin, then replace navigation to path with #product-review-form. Unavailable means normal sign-in succeeded but the product editor is no longer available.
|
|
3330
|
+
*/
|
|
3331
|
+
review_return?: {
|
|
3332
|
+
product_id: string;
|
|
3333
|
+
path: string | null;
|
|
3334
|
+
account_origin: string;
|
|
3335
|
+
status: "available" | "unavailable";
|
|
3336
|
+
};
|
|
3283
3337
|
};
|
|
3284
3338
|
type AccountVerifyRequest = {
|
|
3285
3339
|
code: string;
|
|
@@ -3423,6 +3477,14 @@ type ManageLinkAction = {
|
|
|
3423
3477
|
*/
|
|
3424
3478
|
token: string;
|
|
3425
3479
|
};
|
|
3480
|
+
type ReviewReadiness = {
|
|
3481
|
+
site_id: string;
|
|
3482
|
+
collection_available: boolean;
|
|
3483
|
+
editing_available: boolean;
|
|
3484
|
+
reason: string | null;
|
|
3485
|
+
turnstile_site_key: string | null;
|
|
3486
|
+
account_origin: string | null;
|
|
3487
|
+
};
|
|
3426
3488
|
type UpdateSitePaymentsData = {
|
|
3427
3489
|
body: UpdateSitePayments;
|
|
3428
3490
|
path: {
|
|
@@ -4838,6 +4900,18 @@ type GetAnalyticsSummaryData = {
|
|
|
4838
4900
|
* 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
4901
|
*/
|
|
4840
4902
|
period?: "7" | "30" | "90";
|
|
4903
|
+
/**
|
|
4904
|
+
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
4905
|
+
*/
|
|
4906
|
+
from?: string;
|
|
4907
|
+
/**
|
|
4908
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
4909
|
+
*/
|
|
4910
|
+
to?: string;
|
|
4911
|
+
/**
|
|
4912
|
+
* Drill-down filters as a JSON array, ANDed with each other: [{"dimension":"page","operator":"is","values":["/pricing"]}]. `operator` is `is` or `is_not` and defaults to `is`; `values` are ORed within one filter. At most 3 filters, 100 values each. JSON rather than a delimited string because the values are merchant data - URLs with commas, campaign names with equals signs - and every delimiter worth choosing appears inside some legitimate value. Dimensions: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term, channel. `channel` is not a stored column: it is resolved against the window's real acquisition tuples using the same classifier the Channels card uses, so clicking a channel row cannot select a different set than that row claimed. THE SAME FILTERS MUST BE SENT TO EVERY REPORT ON A PAGE - a filtered chart beside an unfiltered tile is worse than no filtering, because the tiles are the numbers a merchant quotes.
|
|
4913
|
+
*/
|
|
4914
|
+
filters?: string;
|
|
4841
4915
|
};
|
|
4842
4916
|
url: "/api/v1/analytics/summary";
|
|
4843
4917
|
};
|
|
@@ -4870,6 +4944,18 @@ type GetAnalyticsTimeseriesData = {
|
|
|
4870
4944
|
* 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
4945
|
*/
|
|
4872
4946
|
period?: "7" | "30" | "90";
|
|
4947
|
+
/**
|
|
4948
|
+
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
4949
|
+
*/
|
|
4950
|
+
from?: string;
|
|
4951
|
+
/**
|
|
4952
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
4953
|
+
*/
|
|
4954
|
+
to?: string;
|
|
4955
|
+
/**
|
|
4956
|
+
* Drill-down filters as a JSON array, ANDed with each other: [{"dimension":"page","operator":"is","values":["/pricing"]}]. `operator` is `is` or `is_not` and defaults to `is`; `values` are ORed within one filter. At most 3 filters, 100 values each. JSON rather than a delimited string because the values are merchant data - URLs with commas, campaign names with equals signs - and every delimiter worth choosing appears inside some legitimate value. Dimensions: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term, channel. `channel` is not a stored column: it is resolved against the window's real acquisition tuples using the same classifier the Channels card uses, so clicking a channel row cannot select a different set than that row claimed. THE SAME FILTERS MUST BE SENT TO EVERY REPORT ON A PAGE - a filtered chart beside an unfiltered tile is worse than no filtering, because the tiles are the numbers a merchant quotes.
|
|
4957
|
+
*/
|
|
4958
|
+
filters?: string;
|
|
4873
4959
|
};
|
|
4874
4960
|
url: "/api/v1/analytics/timeseries";
|
|
4875
4961
|
};
|
|
@@ -4924,7 +5010,20 @@ type GetAnalyticsSourcesData = {
|
|
|
4924
5010
|
query?: {
|
|
4925
5011
|
site_id?: string;
|
|
4926
5012
|
period?: "7" | "30" | "90";
|
|
5013
|
+
/**
|
|
5014
|
+
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5015
|
+
*/
|
|
5016
|
+
from?: string;
|
|
5017
|
+
/**
|
|
5018
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5019
|
+
*/
|
|
5020
|
+
to?: string;
|
|
4927
5021
|
limit?: string;
|
|
5022
|
+
filters?: string;
|
|
5023
|
+
/**
|
|
5024
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5025
|
+
*/
|
|
5026
|
+
dimension2?: string;
|
|
4928
5027
|
};
|
|
4929
5028
|
url: "/api/v1/analytics/sources";
|
|
4930
5029
|
};
|
|
@@ -4951,7 +5050,20 @@ type GetAnalyticsCampaignsData = {
|
|
|
4951
5050
|
query?: {
|
|
4952
5051
|
site_id?: string;
|
|
4953
5052
|
period?: "7" | "30" | "90";
|
|
5053
|
+
/**
|
|
5054
|
+
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5055
|
+
*/
|
|
5056
|
+
from?: string;
|
|
5057
|
+
/**
|
|
5058
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5059
|
+
*/
|
|
5060
|
+
to?: string;
|
|
4954
5061
|
limit?: string;
|
|
5062
|
+
filters?: string;
|
|
5063
|
+
/**
|
|
5064
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5065
|
+
*/
|
|
5066
|
+
dimension2?: string;
|
|
4955
5067
|
};
|
|
4956
5068
|
url: "/api/v1/analytics/campaigns";
|
|
4957
5069
|
};
|
|
@@ -4978,7 +5090,20 @@ type GetAnalyticsUtmMediumData = {
|
|
|
4978
5090
|
query?: {
|
|
4979
5091
|
site_id?: string;
|
|
4980
5092
|
period?: "7" | "30" | "90";
|
|
5093
|
+
/**
|
|
5094
|
+
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5095
|
+
*/
|
|
5096
|
+
from?: string;
|
|
5097
|
+
/**
|
|
5098
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5099
|
+
*/
|
|
5100
|
+
to?: string;
|
|
4981
5101
|
limit?: string;
|
|
5102
|
+
filters?: string;
|
|
5103
|
+
/**
|
|
5104
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5105
|
+
*/
|
|
5106
|
+
dimension2?: string;
|
|
4982
5107
|
};
|
|
4983
5108
|
url: "/api/v1/analytics/utm/medium";
|
|
4984
5109
|
};
|
|
@@ -5005,7 +5130,20 @@ type GetAnalyticsUtmSourceData = {
|
|
|
5005
5130
|
query?: {
|
|
5006
5131
|
site_id?: string;
|
|
5007
5132
|
period?: "7" | "30" | "90";
|
|
5133
|
+
/**
|
|
5134
|
+
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5135
|
+
*/
|
|
5136
|
+
from?: string;
|
|
5137
|
+
/**
|
|
5138
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5139
|
+
*/
|
|
5140
|
+
to?: string;
|
|
5008
5141
|
limit?: string;
|
|
5142
|
+
filters?: string;
|
|
5143
|
+
/**
|
|
5144
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5145
|
+
*/
|
|
5146
|
+
dimension2?: string;
|
|
5009
5147
|
};
|
|
5010
5148
|
url: "/api/v1/analytics/utm/source";
|
|
5011
5149
|
};
|
|
@@ -5032,7 +5170,20 @@ type GetAnalyticsUtmCampaignData = {
|
|
|
5032
5170
|
query?: {
|
|
5033
5171
|
site_id?: string;
|
|
5034
5172
|
period?: "7" | "30" | "90";
|
|
5173
|
+
/**
|
|
5174
|
+
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5175
|
+
*/
|
|
5176
|
+
from?: string;
|
|
5177
|
+
/**
|
|
5178
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5179
|
+
*/
|
|
5180
|
+
to?: string;
|
|
5035
5181
|
limit?: string;
|
|
5182
|
+
filters?: string;
|
|
5183
|
+
/**
|
|
5184
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5185
|
+
*/
|
|
5186
|
+
dimension2?: string;
|
|
5036
5187
|
};
|
|
5037
5188
|
url: "/api/v1/analytics/utm/campaign";
|
|
5038
5189
|
};
|
|
@@ -5059,7 +5210,20 @@ type GetAnalyticsUtmContentData = {
|
|
|
5059
5210
|
query?: {
|
|
5060
5211
|
site_id?: string;
|
|
5061
5212
|
period?: "7" | "30" | "90";
|
|
5213
|
+
/**
|
|
5214
|
+
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5215
|
+
*/
|
|
5216
|
+
from?: string;
|
|
5217
|
+
/**
|
|
5218
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5219
|
+
*/
|
|
5220
|
+
to?: string;
|
|
5062
5221
|
limit?: string;
|
|
5222
|
+
filters?: string;
|
|
5223
|
+
/**
|
|
5224
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5225
|
+
*/
|
|
5226
|
+
dimension2?: string;
|
|
5063
5227
|
};
|
|
5064
5228
|
url: "/api/v1/analytics/utm/content";
|
|
5065
5229
|
};
|
|
@@ -5086,7 +5250,20 @@ type GetAnalyticsUtmTermData = {
|
|
|
5086
5250
|
query?: {
|
|
5087
5251
|
site_id?: string;
|
|
5088
5252
|
period?: "7" | "30" | "90";
|
|
5253
|
+
/**
|
|
5254
|
+
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5255
|
+
*/
|
|
5256
|
+
from?: string;
|
|
5257
|
+
/**
|
|
5258
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5259
|
+
*/
|
|
5260
|
+
to?: string;
|
|
5089
5261
|
limit?: string;
|
|
5262
|
+
filters?: string;
|
|
5263
|
+
/**
|
|
5264
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5265
|
+
*/
|
|
5266
|
+
dimension2?: string;
|
|
5090
5267
|
};
|
|
5091
5268
|
url: "/api/v1/analytics/utm/term";
|
|
5092
5269
|
};
|
|
@@ -5113,7 +5290,20 @@ type GetAnalyticsPagesData = {
|
|
|
5113
5290
|
query?: {
|
|
5114
5291
|
site_id?: string;
|
|
5115
5292
|
period?: "7" | "30" | "90";
|
|
5293
|
+
/**
|
|
5294
|
+
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5295
|
+
*/
|
|
5296
|
+
from?: string;
|
|
5297
|
+
/**
|
|
5298
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5299
|
+
*/
|
|
5300
|
+
to?: string;
|
|
5116
5301
|
limit?: string;
|
|
5302
|
+
filters?: string;
|
|
5303
|
+
/**
|
|
5304
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5305
|
+
*/
|
|
5306
|
+
dimension2?: string;
|
|
5117
5307
|
};
|
|
5118
5308
|
url: "/api/v1/analytics/pages";
|
|
5119
5309
|
};
|
|
@@ -5140,7 +5330,20 @@ type GetAnalyticsEntryPagesData = {
|
|
|
5140
5330
|
query?: {
|
|
5141
5331
|
site_id?: string;
|
|
5142
5332
|
period?: "7" | "30" | "90";
|
|
5333
|
+
/**
|
|
5334
|
+
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5335
|
+
*/
|
|
5336
|
+
from?: string;
|
|
5337
|
+
/**
|
|
5338
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5339
|
+
*/
|
|
5340
|
+
to?: string;
|
|
5143
5341
|
limit?: string;
|
|
5342
|
+
filters?: string;
|
|
5343
|
+
/**
|
|
5344
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5345
|
+
*/
|
|
5346
|
+
dimension2?: string;
|
|
5144
5347
|
};
|
|
5145
5348
|
url: "/api/v1/analytics/entry-pages";
|
|
5146
5349
|
};
|
|
@@ -5167,7 +5370,20 @@ type GetAnalyticsExitPagesData = {
|
|
|
5167
5370
|
query?: {
|
|
5168
5371
|
site_id?: string;
|
|
5169
5372
|
period?: "7" | "30" | "90";
|
|
5373
|
+
/**
|
|
5374
|
+
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5375
|
+
*/
|
|
5376
|
+
from?: string;
|
|
5377
|
+
/**
|
|
5378
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5379
|
+
*/
|
|
5380
|
+
to?: string;
|
|
5170
5381
|
limit?: string;
|
|
5382
|
+
filters?: string;
|
|
5383
|
+
/**
|
|
5384
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5385
|
+
*/
|
|
5386
|
+
dimension2?: string;
|
|
5171
5387
|
};
|
|
5172
5388
|
url: "/api/v1/analytics/exit-pages";
|
|
5173
5389
|
};
|
|
@@ -5188,40 +5404,26 @@ type GetAnalyticsExitPagesResponses = {
|
|
|
5188
5404
|
200: AnalyticsBreakdown;
|
|
5189
5405
|
};
|
|
5190
5406
|
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
5407
|
type GetAnalyticsCountriesData = {
|
|
5219
5408
|
body?: never;
|
|
5220
5409
|
path?: never;
|
|
5221
5410
|
query?: {
|
|
5222
5411
|
site_id?: string;
|
|
5223
5412
|
period?: "7" | "30" | "90";
|
|
5413
|
+
/**
|
|
5414
|
+
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5415
|
+
*/
|
|
5416
|
+
from?: string;
|
|
5417
|
+
/**
|
|
5418
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5419
|
+
*/
|
|
5420
|
+
to?: string;
|
|
5224
5421
|
limit?: string;
|
|
5422
|
+
filters?: string;
|
|
5423
|
+
/**
|
|
5424
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5425
|
+
*/
|
|
5426
|
+
dimension2?: string;
|
|
5225
5427
|
};
|
|
5226
5428
|
url: "/api/v1/analytics/countries";
|
|
5227
5429
|
};
|
|
@@ -5248,7 +5450,20 @@ type GetAnalyticsRegionsData = {
|
|
|
5248
5450
|
query?: {
|
|
5249
5451
|
site_id?: string;
|
|
5250
5452
|
period?: "7" | "30" | "90";
|
|
5453
|
+
/**
|
|
5454
|
+
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5455
|
+
*/
|
|
5456
|
+
from?: string;
|
|
5457
|
+
/**
|
|
5458
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5459
|
+
*/
|
|
5460
|
+
to?: string;
|
|
5251
5461
|
limit?: string;
|
|
5462
|
+
filters?: string;
|
|
5463
|
+
/**
|
|
5464
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5465
|
+
*/
|
|
5466
|
+
dimension2?: string;
|
|
5252
5467
|
};
|
|
5253
5468
|
url: "/api/v1/analytics/regions";
|
|
5254
5469
|
};
|
|
@@ -5275,7 +5490,20 @@ type GetAnalyticsCitiesData = {
|
|
|
5275
5490
|
query?: {
|
|
5276
5491
|
site_id?: string;
|
|
5277
5492
|
period?: "7" | "30" | "90";
|
|
5493
|
+
/**
|
|
5494
|
+
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5495
|
+
*/
|
|
5496
|
+
from?: string;
|
|
5497
|
+
/**
|
|
5498
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5499
|
+
*/
|
|
5500
|
+
to?: string;
|
|
5278
5501
|
limit?: string;
|
|
5502
|
+
filters?: string;
|
|
5503
|
+
/**
|
|
5504
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5505
|
+
*/
|
|
5506
|
+
dimension2?: string;
|
|
5279
5507
|
};
|
|
5280
5508
|
url: "/api/v1/analytics/cities";
|
|
5281
5509
|
};
|
|
@@ -5302,7 +5530,20 @@ type GetAnalyticsDevicesData = {
|
|
|
5302
5530
|
query?: {
|
|
5303
5531
|
site_id?: string;
|
|
5304
5532
|
period?: "7" | "30" | "90";
|
|
5533
|
+
/**
|
|
5534
|
+
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5535
|
+
*/
|
|
5536
|
+
from?: string;
|
|
5537
|
+
/**
|
|
5538
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5539
|
+
*/
|
|
5540
|
+
to?: string;
|
|
5305
5541
|
limit?: string;
|
|
5542
|
+
filters?: string;
|
|
5543
|
+
/**
|
|
5544
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5545
|
+
*/
|
|
5546
|
+
dimension2?: string;
|
|
5306
5547
|
};
|
|
5307
5548
|
url: "/api/v1/analytics/devices";
|
|
5308
5549
|
};
|
|
@@ -5329,7 +5570,20 @@ type GetAnalyticsBrowsersData = {
|
|
|
5329
5570
|
query?: {
|
|
5330
5571
|
site_id?: string;
|
|
5331
5572
|
period?: "7" | "30" | "90";
|
|
5573
|
+
/**
|
|
5574
|
+
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5575
|
+
*/
|
|
5576
|
+
from?: string;
|
|
5577
|
+
/**
|
|
5578
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5579
|
+
*/
|
|
5580
|
+
to?: string;
|
|
5332
5581
|
limit?: string;
|
|
5582
|
+
filters?: string;
|
|
5583
|
+
/**
|
|
5584
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5585
|
+
*/
|
|
5586
|
+
dimension2?: string;
|
|
5333
5587
|
};
|
|
5334
5588
|
url: "/api/v1/analytics/browsers";
|
|
5335
5589
|
};
|
|
@@ -5356,7 +5610,20 @@ type GetAnalyticsOperatingSystemsData = {
|
|
|
5356
5610
|
query?: {
|
|
5357
5611
|
site_id?: string;
|
|
5358
5612
|
period?: "7" | "30" | "90";
|
|
5613
|
+
/**
|
|
5614
|
+
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5615
|
+
*/
|
|
5616
|
+
from?: string;
|
|
5617
|
+
/**
|
|
5618
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5619
|
+
*/
|
|
5620
|
+
to?: string;
|
|
5359
5621
|
limit?: string;
|
|
5622
|
+
filters?: string;
|
|
5623
|
+
/**
|
|
5624
|
+
* Cross this report against a second dimension, giving one row per PAIR instead of a ranked list. One of: page, entry_page, exit_page, country, region, city, browser, os, device, source, campaign, utm_source, utm_medium, utm_content, utm_term. The pair's second value is carried under a field named after the dimension - the same shape the regions and cities reports have always had, since those were cross-tabs against country before this parameter was exposed. THE METRIC DOES NOT CHANGE: the count beside `visitors` is still the one this report's OWN dimension decides (pageviews for page and geo reports, visits for acquisition ones), because the primary dimension picks how the pipe scans. `channel` is rejected - it is derived from the acquisition tuple rather than stored, so it cannot be grouped by; filter by channel instead. The regions and cities reports are also rejected: the pipe carries ONE second dimension and those two already spend it on country, without which their values cannot be told apart. `region` and `city` are rejected in the SECOND position too, for the same missing column, unless the report's own dimension is `country` - a region or city name is unique only within one (Georgia is a US state and a country, and there is a Springfield in Illinois and another in Missouri), and the one second slot spent on the name leaves nothing to carry the country. Ask for /analytics/regions or /analytics/cities, which carry that column, or /analytics/countries?dimension2=city, which puts country in the primary position and so needs no extra column. The sources report is rejected as well, for a different reason of the same kind: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. In all three cases ask for the other report crossed the other way up - /analytics/countries?dimension2=source rather than /analytics/sources?dimension2=country - which is the same pairs with values that claim nothing. The summary, timeseries and channels endpoints reject it too, rather than ignoring it.
|
|
5625
|
+
*/
|
|
5626
|
+
dimension2?: string;
|
|
5360
5627
|
};
|
|
5361
5628
|
url: "/api/v1/analytics/operating-systems";
|
|
5362
5629
|
};
|
|
@@ -5383,6 +5650,15 @@ type GetAnalyticsChannelsData = {
|
|
|
5383
5650
|
query?: {
|
|
5384
5651
|
site_id?: string;
|
|
5385
5652
|
period?: "7" | "30" | "90";
|
|
5653
|
+
/**
|
|
5654
|
+
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5655
|
+
*/
|
|
5656
|
+
from?: string;
|
|
5657
|
+
/**
|
|
5658
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5659
|
+
*/
|
|
5660
|
+
to?: string;
|
|
5661
|
+
filters?: string;
|
|
5386
5662
|
};
|
|
5387
5663
|
url: "/api/v1/analytics/channels";
|
|
5388
5664
|
};
|
|
@@ -5520,6 +5796,10 @@ type ReactivateSiteSubscriptionsTeardownErrors = {
|
|
|
5520
5796
|
* 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
5797
|
*/
|
|
5522
5798
|
404: Error;
|
|
5799
|
+
/**
|
|
5800
|
+
* The site is soft-deleted (`code: 'site_deleted'`): a deleted store never resumes charging, so nothing is reactivated. Terminal for the caller — a restore (clearing deleted_at) is a support action.
|
|
5801
|
+
*/
|
|
5802
|
+
409: Error;
|
|
5523
5803
|
};
|
|
5524
5804
|
type ReactivateSiteSubscriptionsTeardownError = ReactivateSiteSubscriptionsTeardownErrors[keyof ReactivateSiteSubscriptionsTeardownErrors];
|
|
5525
5805
|
type ReactivateSiteSubscriptionsTeardownResponses = {
|
|
@@ -6574,152 +6854,940 @@ type CancelRetainerResponses = {
|
|
|
6574
6854
|
200: Retainer;
|
|
6575
6855
|
};
|
|
6576
6856
|
type CancelRetainerResponse = CancelRetainerResponses[keyof CancelRetainerResponses];
|
|
6577
|
-
type
|
|
6857
|
+
type ListMerchantReviewsData = {
|
|
6578
6858
|
body?: never;
|
|
6579
|
-
path
|
|
6580
|
-
|
|
6581
|
-
|
|
6859
|
+
path: {
|
|
6860
|
+
siteId: string;
|
|
6861
|
+
};
|
|
6862
|
+
query?: {
|
|
6863
|
+
product_id?: string;
|
|
6864
|
+
rating?: number;
|
|
6865
|
+
state?: "published" | "hidden" | "withdrawn";
|
|
6866
|
+
cursor?: string;
|
|
6867
|
+
limit?: number;
|
|
6868
|
+
};
|
|
6869
|
+
url: "/api/v1/sites/{siteId}/reviews";
|
|
6582
6870
|
};
|
|
6583
|
-
type
|
|
6871
|
+
type ListMerchantReviewsErrors = {
|
|
6584
6872
|
/**
|
|
6585
|
-
*
|
|
6873
|
+
* Invalid input
|
|
6586
6874
|
*/
|
|
6587
|
-
|
|
6875
|
+
400: {
|
|
6876
|
+
error: string;
|
|
6877
|
+
code?: string;
|
|
6878
|
+
review?: OwnProductReview & {
|
|
6879
|
+
customer_id: string;
|
|
6880
|
+
};
|
|
6881
|
+
};
|
|
6588
6882
|
/**
|
|
6589
|
-
*
|
|
6883
|
+
* Organization key required
|
|
6590
6884
|
*/
|
|
6591
|
-
|
|
6592
|
-
|
|
6593
|
-
|
|
6594
|
-
|
|
6885
|
+
403: {
|
|
6886
|
+
error: string;
|
|
6887
|
+
code?: string;
|
|
6888
|
+
review?: OwnProductReview & {
|
|
6889
|
+
customer_id: string;
|
|
6890
|
+
};
|
|
6891
|
+
};
|
|
6595
6892
|
/**
|
|
6596
|
-
*
|
|
6893
|
+
* Resource not found
|
|
6597
6894
|
*/
|
|
6598
|
-
|
|
6895
|
+
404: {
|
|
6896
|
+
error: string;
|
|
6897
|
+
code?: string;
|
|
6898
|
+
review?: OwnProductReview & {
|
|
6899
|
+
customer_id: string;
|
|
6900
|
+
};
|
|
6901
|
+
};
|
|
6902
|
+
/**
|
|
6903
|
+
* Review changed; read the current revision
|
|
6904
|
+
*/
|
|
6905
|
+
409: {
|
|
6906
|
+
error: string;
|
|
6907
|
+
code?: string;
|
|
6908
|
+
review?: OwnProductReview & {
|
|
6909
|
+
customer_id: string;
|
|
6910
|
+
};
|
|
6911
|
+
};
|
|
6599
6912
|
};
|
|
6600
|
-
type
|
|
6913
|
+
type ListMerchantReviewsError = ListMerchantReviewsErrors[keyof ListMerchantReviewsErrors];
|
|
6914
|
+
type ListMerchantReviewsResponses = {
|
|
6915
|
+
/**
|
|
6916
|
+
* Success
|
|
6917
|
+
*/
|
|
6918
|
+
200: {
|
|
6919
|
+
reviews: Array<OwnProductReview & {
|
|
6920
|
+
customer_id: string;
|
|
6921
|
+
}>;
|
|
6922
|
+
pagination: {
|
|
6923
|
+
next_cursor: string | null;
|
|
6924
|
+
has_more: boolean;
|
|
6925
|
+
};
|
|
6926
|
+
};
|
|
6927
|
+
};
|
|
6928
|
+
type ListMerchantReviewsResponse = ListMerchantReviewsResponses[keyof ListMerchantReviewsResponses];
|
|
6929
|
+
type GetMerchantReviewData = {
|
|
6930
|
+
body?: never;
|
|
6931
|
+
path: {
|
|
6932
|
+
siteId: string;
|
|
6933
|
+
reviewId: string;
|
|
6934
|
+
};
|
|
6935
|
+
query?: never;
|
|
6936
|
+
url: "/api/v1/sites/{siteId}/reviews/{reviewId}";
|
|
6937
|
+
};
|
|
6938
|
+
type GetMerchantReviewErrors = {
|
|
6939
|
+
/**
|
|
6940
|
+
* Invalid input
|
|
6941
|
+
*/
|
|
6942
|
+
400: {
|
|
6943
|
+
error: string;
|
|
6944
|
+
code?: string;
|
|
6945
|
+
review?: OwnProductReview & {
|
|
6946
|
+
customer_id: string;
|
|
6947
|
+
};
|
|
6948
|
+
};
|
|
6949
|
+
/**
|
|
6950
|
+
* Organization key required
|
|
6951
|
+
*/
|
|
6952
|
+
403: {
|
|
6953
|
+
error: string;
|
|
6954
|
+
code?: string;
|
|
6955
|
+
review?: OwnProductReview & {
|
|
6956
|
+
customer_id: string;
|
|
6957
|
+
};
|
|
6958
|
+
};
|
|
6959
|
+
/**
|
|
6960
|
+
* Resource not found
|
|
6961
|
+
*/
|
|
6962
|
+
404: {
|
|
6963
|
+
error: string;
|
|
6964
|
+
code?: string;
|
|
6965
|
+
review?: OwnProductReview & {
|
|
6966
|
+
customer_id: string;
|
|
6967
|
+
};
|
|
6968
|
+
};
|
|
6969
|
+
/**
|
|
6970
|
+
* Review changed; read the current revision
|
|
6971
|
+
*/
|
|
6972
|
+
409: {
|
|
6973
|
+
error: string;
|
|
6974
|
+
code?: string;
|
|
6975
|
+
review?: OwnProductReview & {
|
|
6976
|
+
customer_id: string;
|
|
6977
|
+
};
|
|
6978
|
+
};
|
|
6979
|
+
};
|
|
6980
|
+
type GetMerchantReviewError = GetMerchantReviewErrors[keyof GetMerchantReviewErrors];
|
|
6981
|
+
type GetMerchantReviewResponses = {
|
|
6982
|
+
/**
|
|
6983
|
+
* Success
|
|
6984
|
+
*/
|
|
6985
|
+
200: {
|
|
6986
|
+
review: OwnProductReview & {
|
|
6987
|
+
customer_id: string;
|
|
6988
|
+
};
|
|
6989
|
+
events: Array<{
|
|
6990
|
+
id: string;
|
|
6991
|
+
actor_type: string;
|
|
6992
|
+
actor_id: string;
|
|
6993
|
+
action: string;
|
|
6994
|
+
reason: string | null;
|
|
6995
|
+
note: string | null;
|
|
6996
|
+
revision: number;
|
|
6997
|
+
created_at: string;
|
|
6998
|
+
}>;
|
|
6999
|
+
events_truncated: boolean;
|
|
7000
|
+
};
|
|
7001
|
+
};
|
|
7002
|
+
type GetMerchantReviewResponse = GetMerchantReviewResponses[keyof GetMerchantReviewResponses];
|
|
7003
|
+
type ModerateMerchantReviewData = {
|
|
7004
|
+
body: {
|
|
7005
|
+
revision: number;
|
|
7006
|
+
action: "hide" | "restore";
|
|
7007
|
+
reason: "spam" | "abuse" | "personal_information" | "off_topic" | "suspected_fraud";
|
|
7008
|
+
note?: string;
|
|
7009
|
+
};
|
|
7010
|
+
path: {
|
|
7011
|
+
siteId: string;
|
|
7012
|
+
reviewId: string;
|
|
7013
|
+
};
|
|
7014
|
+
query?: never;
|
|
7015
|
+
url: "/api/v1/sites/{siteId}/reviews/{reviewId}/moderate";
|
|
7016
|
+
};
|
|
7017
|
+
type ModerateMerchantReviewErrors = {
|
|
7018
|
+
/**
|
|
7019
|
+
* Invalid input
|
|
7020
|
+
*/
|
|
7021
|
+
400: {
|
|
7022
|
+
error: string;
|
|
7023
|
+
code?: string;
|
|
7024
|
+
review?: OwnProductReview & {
|
|
7025
|
+
customer_id: string;
|
|
7026
|
+
};
|
|
7027
|
+
};
|
|
7028
|
+
/**
|
|
7029
|
+
* Organization key required
|
|
7030
|
+
*/
|
|
7031
|
+
403: {
|
|
7032
|
+
error: string;
|
|
7033
|
+
code?: string;
|
|
7034
|
+
review?: OwnProductReview & {
|
|
7035
|
+
customer_id: string;
|
|
7036
|
+
};
|
|
7037
|
+
};
|
|
7038
|
+
/**
|
|
7039
|
+
* Resource not found
|
|
7040
|
+
*/
|
|
7041
|
+
404: {
|
|
7042
|
+
error: string;
|
|
7043
|
+
code?: string;
|
|
7044
|
+
review?: OwnProductReview & {
|
|
7045
|
+
customer_id: string;
|
|
7046
|
+
};
|
|
7047
|
+
};
|
|
7048
|
+
/**
|
|
7049
|
+
* Review changed; read the current revision
|
|
7050
|
+
*/
|
|
7051
|
+
409: {
|
|
7052
|
+
error: string;
|
|
7053
|
+
code?: string;
|
|
7054
|
+
review?: OwnProductReview & {
|
|
7055
|
+
customer_id: string;
|
|
7056
|
+
};
|
|
7057
|
+
};
|
|
7058
|
+
};
|
|
7059
|
+
type ModerateMerchantReviewError = ModerateMerchantReviewErrors[keyof ModerateMerchantReviewErrors];
|
|
7060
|
+
type ModerateMerchantReviewResponses = {
|
|
7061
|
+
/**
|
|
7062
|
+
* Success
|
|
7063
|
+
*/
|
|
7064
|
+
200: {
|
|
7065
|
+
review: OwnProductReview & {
|
|
7066
|
+
customer_id: string;
|
|
7067
|
+
};
|
|
7068
|
+
};
|
|
7069
|
+
};
|
|
7070
|
+
type ModerateMerchantReviewResponse = ModerateMerchantReviewResponses[keyof ModerateMerchantReviewResponses];
|
|
7071
|
+
type ReplyToMerchantReviewData = {
|
|
7072
|
+
body: {
|
|
7073
|
+
revision: number;
|
|
7074
|
+
body: string | null;
|
|
7075
|
+
};
|
|
7076
|
+
path: {
|
|
7077
|
+
siteId: string;
|
|
7078
|
+
reviewId: string;
|
|
7079
|
+
};
|
|
7080
|
+
query?: never;
|
|
7081
|
+
url: "/api/v1/sites/{siteId}/reviews/{reviewId}/reply";
|
|
7082
|
+
};
|
|
7083
|
+
type ReplyToMerchantReviewErrors = {
|
|
7084
|
+
/**
|
|
7085
|
+
* Invalid input
|
|
7086
|
+
*/
|
|
7087
|
+
400: {
|
|
7088
|
+
error: string;
|
|
7089
|
+
code?: string;
|
|
7090
|
+
review?: OwnProductReview & {
|
|
7091
|
+
customer_id: string;
|
|
7092
|
+
};
|
|
7093
|
+
};
|
|
7094
|
+
/**
|
|
7095
|
+
* Organization key required
|
|
7096
|
+
*/
|
|
7097
|
+
403: {
|
|
7098
|
+
error: string;
|
|
7099
|
+
code?: string;
|
|
7100
|
+
review?: OwnProductReview & {
|
|
7101
|
+
customer_id: string;
|
|
7102
|
+
};
|
|
7103
|
+
};
|
|
7104
|
+
/**
|
|
7105
|
+
* Resource not found
|
|
7106
|
+
*/
|
|
7107
|
+
404: {
|
|
7108
|
+
error: string;
|
|
7109
|
+
code?: string;
|
|
7110
|
+
review?: OwnProductReview & {
|
|
7111
|
+
customer_id: string;
|
|
7112
|
+
};
|
|
7113
|
+
};
|
|
7114
|
+
/**
|
|
7115
|
+
* Review changed; read the current revision
|
|
7116
|
+
*/
|
|
7117
|
+
409: {
|
|
7118
|
+
error: string;
|
|
7119
|
+
code?: string;
|
|
7120
|
+
review?: OwnProductReview & {
|
|
7121
|
+
customer_id: string;
|
|
7122
|
+
};
|
|
7123
|
+
};
|
|
7124
|
+
};
|
|
7125
|
+
type ReplyToMerchantReviewError = ReplyToMerchantReviewErrors[keyof ReplyToMerchantReviewErrors];
|
|
7126
|
+
type ReplyToMerchantReviewResponses = {
|
|
7127
|
+
/**
|
|
7128
|
+
* Success
|
|
7129
|
+
*/
|
|
7130
|
+
200: {
|
|
7131
|
+
review: OwnProductReview & {
|
|
7132
|
+
customer_id: string;
|
|
7133
|
+
};
|
|
7134
|
+
};
|
|
7135
|
+
};
|
|
7136
|
+
type ReplyToMerchantReviewResponse = ReplyToMerchantReviewResponses[keyof ReplyToMerchantReviewResponses];
|
|
7137
|
+
type GetReviewSettingsData = {
|
|
7138
|
+
body?: never;
|
|
7139
|
+
path: {
|
|
7140
|
+
siteId: string;
|
|
7141
|
+
};
|
|
7142
|
+
query?: never;
|
|
7143
|
+
url: "/api/v1/sites/{siteId}/review-settings";
|
|
7144
|
+
};
|
|
7145
|
+
type GetReviewSettingsErrors = {
|
|
7146
|
+
/**
|
|
7147
|
+
* Invalid input
|
|
7148
|
+
*/
|
|
7149
|
+
400: {
|
|
7150
|
+
error: string;
|
|
7151
|
+
code?: string;
|
|
7152
|
+
review?: OwnProductReview & {
|
|
7153
|
+
customer_id: string;
|
|
7154
|
+
};
|
|
7155
|
+
};
|
|
7156
|
+
/**
|
|
7157
|
+
* Organization key required
|
|
7158
|
+
*/
|
|
7159
|
+
403: {
|
|
7160
|
+
error: string;
|
|
7161
|
+
code?: string;
|
|
7162
|
+
review?: OwnProductReview & {
|
|
7163
|
+
customer_id: string;
|
|
7164
|
+
};
|
|
7165
|
+
};
|
|
7166
|
+
/**
|
|
7167
|
+
* Resource not found
|
|
7168
|
+
*/
|
|
7169
|
+
404: {
|
|
7170
|
+
error: string;
|
|
7171
|
+
code?: string;
|
|
7172
|
+
review?: OwnProductReview & {
|
|
7173
|
+
customer_id: string;
|
|
7174
|
+
};
|
|
7175
|
+
};
|
|
7176
|
+
/**
|
|
7177
|
+
* Review changed; read the current revision
|
|
7178
|
+
*/
|
|
7179
|
+
409: {
|
|
7180
|
+
error: string;
|
|
7181
|
+
code?: string;
|
|
7182
|
+
review?: OwnProductReview & {
|
|
7183
|
+
customer_id: string;
|
|
7184
|
+
};
|
|
7185
|
+
};
|
|
7186
|
+
};
|
|
7187
|
+
type GetReviewSettingsError = GetReviewSettingsErrors[keyof GetReviewSettingsErrors];
|
|
7188
|
+
type GetReviewSettingsResponses = {
|
|
7189
|
+
/**
|
|
7190
|
+
* Success
|
|
7191
|
+
*/
|
|
7192
|
+
200: {
|
|
7193
|
+
site_id: string;
|
|
7194
|
+
reviews_enabled: boolean;
|
|
7195
|
+
collection_available: boolean;
|
|
7196
|
+
editing_available: boolean;
|
|
7197
|
+
reason: string | null;
|
|
7198
|
+
turnstile_site_key: string | null;
|
|
7199
|
+
account_origin: string | null;
|
|
7200
|
+
};
|
|
7201
|
+
};
|
|
7202
|
+
type GetReviewSettingsResponse = GetReviewSettingsResponses[keyof GetReviewSettingsResponses];
|
|
7203
|
+
type UpdateReviewSettingsData = {
|
|
7204
|
+
body: {
|
|
7205
|
+
reviews_enabled: boolean;
|
|
7206
|
+
};
|
|
7207
|
+
path: {
|
|
7208
|
+
siteId: string;
|
|
7209
|
+
};
|
|
7210
|
+
query?: never;
|
|
7211
|
+
url: "/api/v1/sites/{siteId}/review-settings";
|
|
7212
|
+
};
|
|
7213
|
+
type UpdateReviewSettingsErrors = {
|
|
7214
|
+
/**
|
|
7215
|
+
* Invalid input
|
|
7216
|
+
*/
|
|
7217
|
+
400: {
|
|
7218
|
+
error: string;
|
|
7219
|
+
code?: string;
|
|
7220
|
+
review?: OwnProductReview & {
|
|
7221
|
+
customer_id: string;
|
|
7222
|
+
};
|
|
7223
|
+
};
|
|
7224
|
+
/**
|
|
7225
|
+
* Organization key required
|
|
7226
|
+
*/
|
|
7227
|
+
403: {
|
|
7228
|
+
error: string;
|
|
7229
|
+
code?: string;
|
|
7230
|
+
review?: OwnProductReview & {
|
|
7231
|
+
customer_id: string;
|
|
7232
|
+
};
|
|
7233
|
+
};
|
|
7234
|
+
/**
|
|
7235
|
+
* Resource not found
|
|
7236
|
+
*/
|
|
7237
|
+
404: {
|
|
7238
|
+
error: string;
|
|
7239
|
+
code?: string;
|
|
7240
|
+
review?: OwnProductReview & {
|
|
7241
|
+
customer_id: string;
|
|
7242
|
+
};
|
|
7243
|
+
};
|
|
7244
|
+
/**
|
|
7245
|
+
* Review changed; read the current revision
|
|
7246
|
+
*/
|
|
7247
|
+
409: {
|
|
7248
|
+
error: string;
|
|
7249
|
+
code?: string;
|
|
7250
|
+
review?: OwnProductReview & {
|
|
7251
|
+
customer_id: string;
|
|
7252
|
+
};
|
|
7253
|
+
};
|
|
7254
|
+
};
|
|
7255
|
+
type UpdateReviewSettingsError = UpdateReviewSettingsErrors[keyof UpdateReviewSettingsErrors];
|
|
7256
|
+
type UpdateReviewSettingsResponses = {
|
|
7257
|
+
/**
|
|
7258
|
+
* Success
|
|
7259
|
+
*/
|
|
7260
|
+
200: {
|
|
7261
|
+
site_id: string;
|
|
7262
|
+
reviews_enabled: boolean;
|
|
7263
|
+
collection_available: boolean;
|
|
7264
|
+
editing_available: boolean;
|
|
7265
|
+
reason: string | null;
|
|
7266
|
+
turnstile_site_key: string | null;
|
|
7267
|
+
account_origin: string | null;
|
|
7268
|
+
};
|
|
7269
|
+
};
|
|
7270
|
+
type UpdateReviewSettingsResponse = UpdateReviewSettingsResponses[keyof UpdateReviewSettingsResponses];
|
|
7271
|
+
type EraseCustomerReviewsData = {
|
|
7272
|
+
body?: never;
|
|
7273
|
+
path: {
|
|
7274
|
+
siteId: string;
|
|
7275
|
+
customerId: string;
|
|
7276
|
+
};
|
|
7277
|
+
query?: never;
|
|
7278
|
+
url: "/api/v1/sites/{siteId}/customers/{customerId}/reviews";
|
|
7279
|
+
};
|
|
7280
|
+
type EraseCustomerReviewsErrors = {
|
|
7281
|
+
/**
|
|
7282
|
+
* Invalid input
|
|
7283
|
+
*/
|
|
7284
|
+
400: {
|
|
7285
|
+
error: string;
|
|
7286
|
+
code?: string;
|
|
7287
|
+
review?: OwnProductReview & {
|
|
7288
|
+
customer_id: string;
|
|
7289
|
+
};
|
|
7290
|
+
};
|
|
7291
|
+
/**
|
|
7292
|
+
* Organization key required
|
|
7293
|
+
*/
|
|
7294
|
+
403: {
|
|
7295
|
+
error: string;
|
|
7296
|
+
code?: string;
|
|
7297
|
+
review?: OwnProductReview & {
|
|
7298
|
+
customer_id: string;
|
|
7299
|
+
};
|
|
7300
|
+
};
|
|
7301
|
+
/**
|
|
7302
|
+
* Resource not found
|
|
7303
|
+
*/
|
|
7304
|
+
404: {
|
|
7305
|
+
error: string;
|
|
7306
|
+
code?: string;
|
|
7307
|
+
review?: OwnProductReview & {
|
|
7308
|
+
customer_id: string;
|
|
7309
|
+
};
|
|
7310
|
+
};
|
|
7311
|
+
/**
|
|
7312
|
+
* Review changed; read the current revision
|
|
7313
|
+
*/
|
|
7314
|
+
409: {
|
|
7315
|
+
error: string;
|
|
7316
|
+
code?: string;
|
|
7317
|
+
review?: OwnProductReview & {
|
|
7318
|
+
customer_id: string;
|
|
7319
|
+
};
|
|
7320
|
+
};
|
|
7321
|
+
};
|
|
7322
|
+
type EraseCustomerReviewsError = EraseCustomerReviewsErrors[keyof EraseCustomerReviewsErrors];
|
|
7323
|
+
type EraseCustomerReviewsResponses = {
|
|
7324
|
+
/**
|
|
7325
|
+
* Success
|
|
7326
|
+
*/
|
|
7327
|
+
200: {
|
|
7328
|
+
erased: number;
|
|
7329
|
+
};
|
|
7330
|
+
};
|
|
7331
|
+
type EraseCustomerReviewsResponse = EraseCustomerReviewsResponses[keyof EraseCustomerReviewsResponses];
|
|
7332
|
+
type PurgeSiteReviewsData = {
|
|
7333
|
+
body?: never;
|
|
7334
|
+
path: {
|
|
7335
|
+
siteId: string;
|
|
7336
|
+
};
|
|
7337
|
+
query?: never;
|
|
7338
|
+
url: "/api/v1/sites/{siteId}/reviews/purge";
|
|
7339
|
+
};
|
|
7340
|
+
type PurgeSiteReviewsErrors = {
|
|
7341
|
+
/**
|
|
7342
|
+
* Invalid input
|
|
7343
|
+
*/
|
|
7344
|
+
400: {
|
|
7345
|
+
error: string;
|
|
7346
|
+
code?: string;
|
|
7347
|
+
review?: OwnProductReview & {
|
|
7348
|
+
customer_id: string;
|
|
7349
|
+
};
|
|
7350
|
+
};
|
|
7351
|
+
/**
|
|
7352
|
+
* Organization key required
|
|
7353
|
+
*/
|
|
7354
|
+
403: {
|
|
7355
|
+
error: string;
|
|
7356
|
+
code?: string;
|
|
7357
|
+
review?: OwnProductReview & {
|
|
7358
|
+
customer_id: string;
|
|
7359
|
+
};
|
|
7360
|
+
};
|
|
7361
|
+
/**
|
|
7362
|
+
* Resource not found
|
|
7363
|
+
*/
|
|
7364
|
+
404: {
|
|
7365
|
+
error: string;
|
|
7366
|
+
code?: string;
|
|
7367
|
+
review?: OwnProductReview & {
|
|
7368
|
+
customer_id: string;
|
|
7369
|
+
};
|
|
7370
|
+
};
|
|
7371
|
+
/**
|
|
7372
|
+
* Review changed; read the current revision
|
|
7373
|
+
*/
|
|
7374
|
+
409: {
|
|
7375
|
+
error: string;
|
|
7376
|
+
code?: string;
|
|
7377
|
+
review?: OwnProductReview & {
|
|
7378
|
+
customer_id: string;
|
|
7379
|
+
};
|
|
7380
|
+
};
|
|
7381
|
+
};
|
|
7382
|
+
type PurgeSiteReviewsError = PurgeSiteReviewsErrors[keyof PurgeSiteReviewsErrors];
|
|
7383
|
+
type PurgeSiteReviewsResponses = {
|
|
7384
|
+
/**
|
|
7385
|
+
* Success
|
|
7386
|
+
*/
|
|
7387
|
+
200: {
|
|
7388
|
+
purged: number;
|
|
7389
|
+
reviews_enabled: false;
|
|
7390
|
+
};
|
|
7391
|
+
};
|
|
7392
|
+
type PurgeSiteReviewsResponse = PurgeSiteReviewsResponses[keyof PurgeSiteReviewsResponses];
|
|
7393
|
+
type GetConsentConfigWithSiteTokenData = {
|
|
7394
|
+
body?: never;
|
|
7395
|
+
path?: never;
|
|
7396
|
+
query?: never;
|
|
7397
|
+
url: "/api/v1/site-prefs";
|
|
7398
|
+
};
|
|
7399
|
+
type GetConsentConfigWithSiteTokenErrors = {
|
|
7400
|
+
/**
|
|
7401
|
+
* Unauthorized - requires site token
|
|
7402
|
+
*/
|
|
7403
|
+
401: Error;
|
|
7404
|
+
/**
|
|
7405
|
+
* No consent config exists for this site yet
|
|
7406
|
+
*/
|
|
7407
|
+
404: Error;
|
|
7408
|
+
};
|
|
7409
|
+
type GetConsentConfigWithSiteTokenError = GetConsentConfigWithSiteTokenErrors[keyof GetConsentConfigWithSiteTokenErrors];
|
|
7410
|
+
type GetConsentConfigWithSiteTokenResponses = {
|
|
7411
|
+
/**
|
|
7412
|
+
* The site's consent configuration
|
|
7413
|
+
*/
|
|
7414
|
+
200: ConsentConfig;
|
|
7415
|
+
};
|
|
7416
|
+
type GetConsentConfigWithSiteTokenResponse = GetConsentConfigWithSiteTokenResponses[keyof GetConsentConfigWithSiteTokenResponses];
|
|
6601
7417
|
type UpsertConsentConfigWithSiteTokenData = {
|
|
6602
7418
|
body: UpsertConsentConfig;
|
|
6603
7419
|
path?: never;
|
|
6604
7420
|
query?: never;
|
|
6605
|
-
url: "/api/v1/site-prefs";
|
|
7421
|
+
url: "/api/v1/site-prefs";
|
|
7422
|
+
};
|
|
7423
|
+
type UpsertConsentConfigWithSiteTokenErrors = {
|
|
7424
|
+
/**
|
|
7425
|
+
* Validation error
|
|
7426
|
+
*/
|
|
7427
|
+
400: Error;
|
|
7428
|
+
/**
|
|
7429
|
+
* Unauthorized - requires site token
|
|
7430
|
+
*/
|
|
7431
|
+
401: Error;
|
|
7432
|
+
};
|
|
7433
|
+
type UpsertConsentConfigWithSiteTokenError = UpsertConsentConfigWithSiteTokenErrors[keyof UpsertConsentConfigWithSiteTokenErrors];
|
|
7434
|
+
type UpsertConsentConfigWithSiteTokenResponses = {
|
|
7435
|
+
/**
|
|
7436
|
+
* The upserted consent configuration
|
|
7437
|
+
*/
|
|
7438
|
+
200: ConsentConfigResult;
|
|
7439
|
+
};
|
|
7440
|
+
type UpsertConsentConfigWithSiteTokenResponse = UpsertConsentConfigWithSiteTokenResponses[keyof UpsertConsentConfigWithSiteTokenResponses];
|
|
7441
|
+
type ListFormsWithSiteTokenData = {
|
|
7442
|
+
body?: never;
|
|
7443
|
+
path?: never;
|
|
7444
|
+
query?: never;
|
|
7445
|
+
url: "/api/v1/forms";
|
|
7446
|
+
};
|
|
7447
|
+
type ListFormsWithSiteTokenErrors = {
|
|
7448
|
+
/**
|
|
7449
|
+
* Unauthorized - requires site token
|
|
7450
|
+
*/
|
|
7451
|
+
401: Error;
|
|
7452
|
+
/**
|
|
7453
|
+
* Site not found
|
|
7454
|
+
*/
|
|
7455
|
+
404: Error;
|
|
7456
|
+
};
|
|
7457
|
+
type ListFormsWithSiteTokenError = ListFormsWithSiteTokenErrors[keyof ListFormsWithSiteTokenErrors];
|
|
7458
|
+
type ListFormsWithSiteTokenResponses = {
|
|
7459
|
+
/**
|
|
7460
|
+
* List of forms
|
|
7461
|
+
*/
|
|
7462
|
+
200: FormsList;
|
|
7463
|
+
};
|
|
7464
|
+
type ListFormsWithSiteTokenResponse = ListFormsWithSiteTokenResponses[keyof ListFormsWithSiteTokenResponses];
|
|
7465
|
+
type CreateFormWithSiteTokenData = {
|
|
7466
|
+
body: CreateForm;
|
|
7467
|
+
path?: never;
|
|
7468
|
+
query?: never;
|
|
7469
|
+
url: "/api/v1/forms";
|
|
7470
|
+
};
|
|
7471
|
+
type CreateFormWithSiteTokenErrors = {
|
|
7472
|
+
/**
|
|
7473
|
+
* Form name indicates credential/payment collection, which is not supported
|
|
7474
|
+
*/
|
|
7475
|
+
400: Error;
|
|
7476
|
+
/**
|
|
7477
|
+
* Unauthorized - requires site token
|
|
7478
|
+
*/
|
|
7479
|
+
401: Error;
|
|
7480
|
+
/**
|
|
7481
|
+
* Site not found
|
|
7482
|
+
*/
|
|
7483
|
+
404: Error;
|
|
7484
|
+
};
|
|
7485
|
+
type CreateFormWithSiteTokenError = CreateFormWithSiteTokenErrors[keyof CreateFormWithSiteTokenErrors];
|
|
7486
|
+
type CreateFormWithSiteTokenResponses = {
|
|
7487
|
+
/**
|
|
7488
|
+
* Form created successfully
|
|
7489
|
+
*/
|
|
7490
|
+
201: Form;
|
|
7491
|
+
};
|
|
7492
|
+
type CreateFormWithSiteTokenResponse = CreateFormWithSiteTokenResponses[keyof CreateFormWithSiteTokenResponses];
|
|
7493
|
+
type ListSitesData = {
|
|
7494
|
+
body?: never;
|
|
7495
|
+
path?: never;
|
|
7496
|
+
query?: {
|
|
7497
|
+
/**
|
|
7498
|
+
* Exact match on the consumer-side id (the landingsite website id) — the lookup for "which aifeatures site is this website?"
|
|
7499
|
+
*/
|
|
7500
|
+
external_id?: string;
|
|
7501
|
+
/**
|
|
7502
|
+
* Maximum number of sites to return (default 50, max 100)
|
|
7503
|
+
*/
|
|
7504
|
+
limit?: string;
|
|
7505
|
+
/**
|
|
7506
|
+
* Number of sites to skip
|
|
7507
|
+
*/
|
|
7508
|
+
offset?: string;
|
|
7509
|
+
/**
|
|
7510
|
+
* Pass 'true' to include soft-deleted sites — hidden by default. Two kinds come back: rows with deleted_at set and purged_at null are inside the retention window and restorable; rows with purged_at ALSO set are tombstones the purge kept for their billing records — forms, catalog and config are gone and they cannot be restored. Because external_id may be reused by a successor site after a delete, an external_id lookup with include_deleted=true can return a live site beside its purged predecessor; read purged_at to tell them apart.
|
|
7511
|
+
*/
|
|
7512
|
+
include_deleted?: string;
|
|
7513
|
+
};
|
|
7514
|
+
url: "/api/v1/sites";
|
|
7515
|
+
};
|
|
7516
|
+
type ListSitesErrors = {
|
|
7517
|
+
/**
|
|
7518
|
+
* Unauthorized
|
|
7519
|
+
*/
|
|
7520
|
+
401: Error;
|
|
7521
|
+
/**
|
|
7522
|
+
* Forbidden - site tokens cannot list sites
|
|
7523
|
+
*/
|
|
7524
|
+
403: Error;
|
|
7525
|
+
};
|
|
7526
|
+
type ListSitesError = ListSitesErrors[keyof ListSitesErrors];
|
|
7527
|
+
type ListSitesResponses = {
|
|
7528
|
+
/**
|
|
7529
|
+
* List of sites
|
|
7530
|
+
*/
|
|
7531
|
+
200: SitesList;
|
|
7532
|
+
};
|
|
7533
|
+
type ListSitesResponse = ListSitesResponses[keyof ListSitesResponses];
|
|
7534
|
+
type CreateSiteData = {
|
|
7535
|
+
body: CreateSite;
|
|
7536
|
+
path?: never;
|
|
7537
|
+
query?: never;
|
|
7538
|
+
url: "/api/v1/sites";
|
|
7539
|
+
};
|
|
7540
|
+
type CreateSiteErrors = {
|
|
7541
|
+
/**
|
|
7542
|
+
* `timezone` is not a usable IANA zone name (code invalid_timezone). Nothing is minted — a rejected create leaves no half-provisioned site for the retry to collide with.
|
|
7543
|
+
*/
|
|
7544
|
+
400: Error;
|
|
7545
|
+
/**
|
|
7546
|
+
* Unauthorized
|
|
7547
|
+
*/
|
|
7548
|
+
401: Error;
|
|
7549
|
+
/**
|
|
7550
|
+
* Forbidden - site tokens cannot create sites
|
|
7551
|
+
*/
|
|
7552
|
+
403: Error;
|
|
7553
|
+
/**
|
|
7554
|
+
* 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.
|
|
7555
|
+
*/
|
|
7556
|
+
409: Error;
|
|
7557
|
+
};
|
|
7558
|
+
type CreateSiteError = CreateSiteErrors[keyof CreateSiteErrors];
|
|
7559
|
+
type CreateSiteResponses = {
|
|
7560
|
+
/**
|
|
7561
|
+
* Site created successfully. The api_token is only returned once!
|
|
7562
|
+
*/
|
|
7563
|
+
201: SiteWithToken;
|
|
7564
|
+
};
|
|
7565
|
+
type CreateSiteResponse = CreateSiteResponses[keyof CreateSiteResponses];
|
|
7566
|
+
type DeleteSiteData = {
|
|
7567
|
+
body?: never;
|
|
7568
|
+
path: {
|
|
7569
|
+
siteId: string;
|
|
7570
|
+
};
|
|
7571
|
+
query?: never;
|
|
7572
|
+
url: "/api/v1/sites/{siteId}";
|
|
7573
|
+
};
|
|
7574
|
+
type DeleteSiteErrors = {
|
|
7575
|
+
/**
|
|
7576
|
+
* Unauthorized
|
|
7577
|
+
*/
|
|
7578
|
+
401: Error;
|
|
7579
|
+
/**
|
|
7580
|
+
* Forbidden - site tokens cannot delete sites
|
|
7581
|
+
*/
|
|
7582
|
+
403: Error;
|
|
7583
|
+
/**
|
|
7584
|
+
* Site not found. `code` distinguishes `site_not_found` (no such site — an idempotent re-delete of an already-purged site is complete) from `site_not_accessible` (the site exists under another organization — a wrong or rotated key; retry with the right one). Safe to disclose here because this route is org-key-only.
|
|
7585
|
+
*/
|
|
7586
|
+
404: Error;
|
|
7587
|
+
};
|
|
7588
|
+
type DeleteSiteError = DeleteSiteErrors[keyof DeleteSiteErrors];
|
|
7589
|
+
type DeleteSiteResponses = {
|
|
7590
|
+
/**
|
|
7591
|
+
* Site deleted successfully
|
|
7592
|
+
*/
|
|
7593
|
+
204: void;
|
|
7594
|
+
};
|
|
7595
|
+
type DeleteSiteResponse = DeleteSiteResponses[keyof DeleteSiteResponses];
|
|
7596
|
+
type GetSiteData = {
|
|
7597
|
+
body?: never;
|
|
7598
|
+
path: {
|
|
7599
|
+
siteId: string;
|
|
7600
|
+
};
|
|
7601
|
+
query?: never;
|
|
7602
|
+
url: "/api/v1/sites/{siteId}";
|
|
6606
7603
|
};
|
|
6607
|
-
type
|
|
7604
|
+
type GetSiteErrors = {
|
|
6608
7605
|
/**
|
|
6609
|
-
*
|
|
7606
|
+
* Unauthorized
|
|
7607
|
+
*/
|
|
7608
|
+
401: Error;
|
|
7609
|
+
/**
|
|
7610
|
+
* Site not found
|
|
7611
|
+
*/
|
|
7612
|
+
404: Error;
|
|
7613
|
+
};
|
|
7614
|
+
type GetSiteError = GetSiteErrors[keyof GetSiteErrors];
|
|
7615
|
+
type GetSiteResponses = {
|
|
7616
|
+
/**
|
|
7617
|
+
* Site details
|
|
7618
|
+
*/
|
|
7619
|
+
200: Site;
|
|
7620
|
+
};
|
|
7621
|
+
type GetSiteResponse = GetSiteResponses[keyof GetSiteResponses];
|
|
7622
|
+
type UpdateSiteData = {
|
|
7623
|
+
body: UpdateSite;
|
|
7624
|
+
path: {
|
|
7625
|
+
siteId: string;
|
|
7626
|
+
};
|
|
7627
|
+
query?: never;
|
|
7628
|
+
url: "/api/v1/sites/{siteId}";
|
|
7629
|
+
};
|
|
7630
|
+
type UpdateSiteErrors = {
|
|
7631
|
+
/**
|
|
7632
|
+
* Invalid shipping configuration (a rate amount out of bounds or an invalid free_shipping_over — the message names the offending rate), a currency outside Stripe's presentment allowlist, or `currency` combined with shipping_rates/free_shipping_over in one request (change currency first, then set rates).
|
|
6610
7633
|
*/
|
|
6611
7634
|
400: Error;
|
|
6612
7635
|
/**
|
|
6613
|
-
* Unauthorized
|
|
7636
|
+
* Unauthorized
|
|
6614
7637
|
*/
|
|
6615
7638
|
401: Error;
|
|
7639
|
+
/**
|
|
7640
|
+
* `currency` sent with an organization API key. Setting the store currency here is a merchant-explicit write (it PINS the currency against platform sync) and requires the site's own token; platform/operator currency changes go through PATCH /sites/{siteId}/payments.
|
|
7641
|
+
*/
|
|
7642
|
+
403: Error;
|
|
7643
|
+
/**
|
|
7644
|
+
* Site not found
|
|
7645
|
+
*/
|
|
7646
|
+
404: Error;
|
|
7647
|
+
/**
|
|
7648
|
+
* Currency changed too recently — each accepted change restates the whole catalogue, so changes are rate-limited per site. Retry after the cooldown.
|
|
7649
|
+
*/
|
|
7650
|
+
429: Error;
|
|
6616
7651
|
};
|
|
6617
|
-
type
|
|
6618
|
-
type
|
|
7652
|
+
type UpdateSiteError = UpdateSiteErrors[keyof UpdateSiteErrors];
|
|
7653
|
+
type UpdateSiteResponses = {
|
|
6619
7654
|
/**
|
|
6620
|
-
*
|
|
7655
|
+
* Site updated. When the request carried `currency`, `currency_restatement` reports the outcome — including blocked outcomes (orders exist, an amount can't survive the move): those are 200s with the block described, and any other fields in the request still applied.
|
|
6621
7656
|
*/
|
|
6622
|
-
200:
|
|
7657
|
+
200: SiteWithRestatement;
|
|
6623
7658
|
};
|
|
6624
|
-
type
|
|
6625
|
-
type
|
|
7659
|
+
type UpdateSiteResponse = UpdateSiteResponses[keyof UpdateSiteResponses];
|
|
7660
|
+
type GetSiteCheckoutPauseData = {
|
|
6626
7661
|
body?: never;
|
|
6627
|
-
path
|
|
7662
|
+
path: {
|
|
7663
|
+
siteId: string;
|
|
7664
|
+
};
|
|
6628
7665
|
query?: never;
|
|
6629
|
-
url: "/api/v1/
|
|
7666
|
+
url: "/api/v1/sites/{siteId}/checkout-pause";
|
|
6630
7667
|
};
|
|
6631
|
-
type
|
|
7668
|
+
type GetSiteCheckoutPauseErrors = {
|
|
6632
7669
|
/**
|
|
6633
|
-
* Unauthorized
|
|
7670
|
+
* Unauthorized
|
|
6634
7671
|
*/
|
|
6635
7672
|
401: Error;
|
|
7673
|
+
/**
|
|
7674
|
+
* Forbidden - site tokens cannot read checkout pause state
|
|
7675
|
+
*/
|
|
7676
|
+
403: Error;
|
|
6636
7677
|
/**
|
|
6637
7678
|
* Site not found
|
|
6638
7679
|
*/
|
|
6639
7680
|
404: Error;
|
|
6640
7681
|
};
|
|
6641
|
-
type
|
|
6642
|
-
type
|
|
7682
|
+
type GetSiteCheckoutPauseError = GetSiteCheckoutPauseErrors[keyof GetSiteCheckoutPauseErrors];
|
|
7683
|
+
type GetSiteCheckoutPauseResponses = {
|
|
6643
7684
|
/**
|
|
6644
|
-
*
|
|
7685
|
+
* Current pause state
|
|
6645
7686
|
*/
|
|
6646
|
-
200:
|
|
7687
|
+
200: CheckoutPauseState;
|
|
6647
7688
|
};
|
|
6648
|
-
type
|
|
6649
|
-
type
|
|
6650
|
-
body:
|
|
6651
|
-
path
|
|
7689
|
+
type GetSiteCheckoutPauseResponse = GetSiteCheckoutPauseResponses[keyof GetSiteCheckoutPauseResponses];
|
|
7690
|
+
type PauseSiteCheckoutData = {
|
|
7691
|
+
body: CheckoutPauseRequest;
|
|
7692
|
+
path: {
|
|
7693
|
+
siteId: string;
|
|
7694
|
+
};
|
|
6652
7695
|
query?: never;
|
|
6653
|
-
url: "/api/v1/
|
|
7696
|
+
url: "/api/v1/sites/{siteId}/checkout-pause";
|
|
6654
7697
|
};
|
|
6655
|
-
type
|
|
7698
|
+
type PauseSiteCheckoutErrors = {
|
|
6656
7699
|
/**
|
|
6657
|
-
*
|
|
7700
|
+
* Unauthorized
|
|
6658
7701
|
*/
|
|
6659
|
-
|
|
7702
|
+
401: Error;
|
|
6660
7703
|
/**
|
|
6661
|
-
*
|
|
7704
|
+
* Forbidden - site tokens cannot change checkout pause state
|
|
7705
|
+
*/
|
|
7706
|
+
403: Error;
|
|
7707
|
+
/**
|
|
7708
|
+
* Site not found
|
|
7709
|
+
*/
|
|
7710
|
+
404: Error;
|
|
7711
|
+
};
|
|
7712
|
+
type PauseSiteCheckoutError = PauseSiteCheckoutErrors[keyof PauseSiteCheckoutErrors];
|
|
7713
|
+
type PauseSiteCheckoutResponses = {
|
|
7714
|
+
/**
|
|
7715
|
+
* Pause state updated (idempotent — re-pausing refreshes the timestamp and reason)
|
|
7716
|
+
*/
|
|
7717
|
+
200: CheckoutPauseState;
|
|
7718
|
+
};
|
|
7719
|
+
type PauseSiteCheckoutResponse = PauseSiteCheckoutResponses[keyof PauseSiteCheckoutResponses];
|
|
7720
|
+
type UpdateSiteDomainsData = {
|
|
7721
|
+
body: UpdateSiteDomains;
|
|
7722
|
+
path: {
|
|
7723
|
+
siteId: string;
|
|
7724
|
+
};
|
|
7725
|
+
query?: never;
|
|
7726
|
+
url: "/api/v1/sites/{siteId}/domains";
|
|
7727
|
+
};
|
|
7728
|
+
type UpdateSiteDomainsErrors = {
|
|
7729
|
+
/**
|
|
7730
|
+
* Unauthorized
|
|
6662
7731
|
*/
|
|
6663
7732
|
401: Error;
|
|
7733
|
+
/**
|
|
7734
|
+
* Forbidden - site tokens cannot modify the domains allowlist
|
|
7735
|
+
*/
|
|
7736
|
+
403: Error;
|
|
6664
7737
|
/**
|
|
6665
7738
|
* Site not found
|
|
6666
7739
|
*/
|
|
6667
7740
|
404: Error;
|
|
6668
7741
|
};
|
|
6669
|
-
type
|
|
6670
|
-
type
|
|
7742
|
+
type UpdateSiteDomainsError = UpdateSiteDomainsErrors[keyof UpdateSiteDomainsErrors];
|
|
7743
|
+
type UpdateSiteDomainsResponses = {
|
|
6671
7744
|
/**
|
|
6672
|
-
*
|
|
7745
|
+
* Site domains updated successfully
|
|
6673
7746
|
*/
|
|
6674
|
-
|
|
7747
|
+
200: SiteDomains;
|
|
6675
7748
|
};
|
|
6676
|
-
type
|
|
6677
|
-
type
|
|
7749
|
+
type UpdateSiteDomainsResponse = UpdateSiteDomainsResponses[keyof UpdateSiteDomainsResponses];
|
|
7750
|
+
type GetSiteAnalyticsData = {
|
|
6678
7751
|
body?: never;
|
|
6679
|
-
path
|
|
6680
|
-
|
|
6681
|
-
/**
|
|
6682
|
-
* Exact match on the consumer-side id (the landingsite website id) — the lookup for "which aifeatures site is this website?"
|
|
6683
|
-
*/
|
|
6684
|
-
external_id?: string;
|
|
6685
|
-
/**
|
|
6686
|
-
* Maximum number of sites to return (default 50, max 100)
|
|
6687
|
-
*/
|
|
6688
|
-
limit?: string;
|
|
6689
|
-
/**
|
|
6690
|
-
* Number of sites to skip
|
|
6691
|
-
*/
|
|
6692
|
-
offset?: string;
|
|
7752
|
+
path: {
|
|
7753
|
+
siteId: string;
|
|
6693
7754
|
};
|
|
6694
|
-
|
|
7755
|
+
query?: never;
|
|
7756
|
+
url: "/api/v1/sites/{siteId}/analytics";
|
|
6695
7757
|
};
|
|
6696
|
-
type
|
|
7758
|
+
type GetSiteAnalyticsErrors = {
|
|
6697
7759
|
/**
|
|
6698
7760
|
* Unauthorized
|
|
6699
7761
|
*/
|
|
6700
7762
|
401: Error;
|
|
6701
7763
|
/**
|
|
6702
|
-
* Forbidden - site tokens cannot
|
|
7764
|
+
* Forbidden - site tokens cannot read the analytics identity
|
|
6703
7765
|
*/
|
|
6704
7766
|
403: Error;
|
|
7767
|
+
/**
|
|
7768
|
+
* Site not found
|
|
7769
|
+
*/
|
|
7770
|
+
404: Error;
|
|
6705
7771
|
};
|
|
6706
|
-
type
|
|
6707
|
-
type
|
|
7772
|
+
type GetSiteAnalyticsError = GetSiteAnalyticsErrors[keyof GetSiteAnalyticsErrors];
|
|
7773
|
+
type GetSiteAnalyticsResponses = {
|
|
6708
7774
|
/**
|
|
6709
|
-
*
|
|
7775
|
+
* The site's analytics identity and resolved reporting zone
|
|
6710
7776
|
*/
|
|
6711
|
-
200:
|
|
7777
|
+
200: SiteAnalytics;
|
|
6712
7778
|
};
|
|
6713
|
-
type
|
|
6714
|
-
type
|
|
6715
|
-
body:
|
|
6716
|
-
path
|
|
7779
|
+
type GetSiteAnalyticsResponse = GetSiteAnalyticsResponses[keyof GetSiteAnalyticsResponses];
|
|
7780
|
+
type UpdateSiteAnalyticsData = {
|
|
7781
|
+
body: UpdateSiteAnalytics;
|
|
7782
|
+
path: {
|
|
7783
|
+
siteId: string;
|
|
7784
|
+
};
|
|
6717
7785
|
query?: never;
|
|
6718
|
-
url: "/api/v1/sites";
|
|
7786
|
+
url: "/api/v1/sites/{siteId}/analytics";
|
|
6719
7787
|
};
|
|
6720
|
-
type
|
|
7788
|
+
type UpdateSiteAnalyticsErrors = {
|
|
6721
7789
|
/**
|
|
6722
|
-
* `timezone` is not a usable IANA zone name (code invalid_timezone)
|
|
7790
|
+
* `timezone` is not a usable IANA zone name (code invalid_timezone), or `analytics_id` is blank/over-length. NOTHING from the request lands — a half-applied identity write is how a site ends up pointed at traffic it then reports in the wrong local days.
|
|
6723
7791
|
*/
|
|
6724
7792
|
400: Error;
|
|
6725
7793
|
/**
|
|
@@ -6727,89 +7795,145 @@ type CreateSiteErrors = {
|
|
|
6727
7795
|
*/
|
|
6728
7796
|
401: Error;
|
|
6729
7797
|
/**
|
|
6730
|
-
* Forbidden - site tokens cannot
|
|
7798
|
+
* Forbidden - site tokens cannot write the analytics identity or the reporting timezone
|
|
7799
|
+
*/
|
|
7800
|
+
403: Error;
|
|
7801
|
+
/**
|
|
7802
|
+
* Site not found
|
|
7803
|
+
*/
|
|
7804
|
+
404: Error;
|
|
7805
|
+
/**
|
|
7806
|
+
* 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.
|
|
7807
|
+
*/
|
|
7808
|
+
409: Error;
|
|
7809
|
+
};
|
|
7810
|
+
type UpdateSiteAnalyticsError = UpdateSiteAnalyticsErrors[keyof UpdateSiteAnalyticsErrors];
|
|
7811
|
+
type UpdateSiteAnalyticsResponses = {
|
|
7812
|
+
/**
|
|
7813
|
+
* Analytics identity updated (an empty body is a plain read)
|
|
7814
|
+
*/
|
|
7815
|
+
200: SiteAnalytics;
|
|
7816
|
+
};
|
|
7817
|
+
type UpdateSiteAnalyticsResponse = UpdateSiteAnalyticsResponses[keyof UpdateSiteAnalyticsResponses];
|
|
7818
|
+
type ListFormsData = {
|
|
7819
|
+
body?: never;
|
|
7820
|
+
path: {
|
|
7821
|
+
siteId: string;
|
|
7822
|
+
};
|
|
7823
|
+
query?: never;
|
|
7824
|
+
url: "/api/v1/sites/{siteId}/forms";
|
|
7825
|
+
};
|
|
7826
|
+
type ListFormsErrors = {
|
|
7827
|
+
/**
|
|
7828
|
+
* Unauthorized
|
|
7829
|
+
*/
|
|
7830
|
+
401: Error;
|
|
7831
|
+
/**
|
|
7832
|
+
* Site not found
|
|
7833
|
+
*/
|
|
7834
|
+
404: Error;
|
|
7835
|
+
};
|
|
7836
|
+
type ListFormsError = ListFormsErrors[keyof ListFormsErrors];
|
|
7837
|
+
type ListFormsResponses = {
|
|
7838
|
+
/**
|
|
7839
|
+
* List of forms
|
|
7840
|
+
*/
|
|
7841
|
+
200: FormsList;
|
|
7842
|
+
};
|
|
7843
|
+
type ListFormsResponse = ListFormsResponses[keyof ListFormsResponses];
|
|
7844
|
+
type CreateFormData = {
|
|
7845
|
+
body: CreateForm;
|
|
7846
|
+
path: {
|
|
7847
|
+
siteId: string;
|
|
7848
|
+
};
|
|
7849
|
+
query?: never;
|
|
7850
|
+
url: "/api/v1/sites/{siteId}/forms";
|
|
7851
|
+
};
|
|
7852
|
+
type CreateFormErrors = {
|
|
7853
|
+
/**
|
|
7854
|
+
* Form name indicates credential/payment collection, which is not supported
|
|
7855
|
+
*/
|
|
7856
|
+
400: Error;
|
|
7857
|
+
/**
|
|
7858
|
+
* Unauthorized
|
|
6731
7859
|
*/
|
|
6732
|
-
|
|
7860
|
+
401: Error;
|
|
6733
7861
|
/**
|
|
6734
|
-
*
|
|
7862
|
+
* Site not found
|
|
6735
7863
|
*/
|
|
6736
|
-
|
|
7864
|
+
404: Error;
|
|
6737
7865
|
};
|
|
6738
|
-
type
|
|
6739
|
-
type
|
|
7866
|
+
type CreateFormError = CreateFormErrors[keyof CreateFormErrors];
|
|
7867
|
+
type CreateFormResponses = {
|
|
6740
7868
|
/**
|
|
6741
|
-
*
|
|
7869
|
+
* Form created successfully
|
|
6742
7870
|
*/
|
|
6743
|
-
201:
|
|
7871
|
+
201: Form;
|
|
6744
7872
|
};
|
|
6745
|
-
type
|
|
6746
|
-
type
|
|
7873
|
+
type CreateFormResponse = CreateFormResponses[keyof CreateFormResponses];
|
|
7874
|
+
type DeleteFormData = {
|
|
6747
7875
|
body?: never;
|
|
6748
7876
|
path: {
|
|
6749
|
-
|
|
7877
|
+
formId: string;
|
|
6750
7878
|
};
|
|
6751
7879
|
query?: never;
|
|
6752
|
-
url: "/api/v1/
|
|
7880
|
+
url: "/api/v1/forms/{formId}";
|
|
6753
7881
|
};
|
|
6754
|
-
type
|
|
7882
|
+
type DeleteFormErrors = {
|
|
6755
7883
|
/**
|
|
6756
7884
|
* Unauthorized
|
|
6757
7885
|
*/
|
|
6758
7886
|
401: Error;
|
|
6759
7887
|
/**
|
|
6760
|
-
*
|
|
6761
|
-
*/
|
|
6762
|
-
403: Error;
|
|
6763
|
-
/**
|
|
6764
|
-
* Site not found
|
|
7888
|
+
* Form not found
|
|
6765
7889
|
*/
|
|
6766
7890
|
404: Error;
|
|
6767
7891
|
};
|
|
6768
|
-
type
|
|
6769
|
-
type
|
|
7892
|
+
type DeleteFormError = DeleteFormErrors[keyof DeleteFormErrors];
|
|
7893
|
+
type DeleteFormResponses = {
|
|
6770
7894
|
/**
|
|
6771
|
-
*
|
|
7895
|
+
* Form deleted successfully
|
|
6772
7896
|
*/
|
|
6773
7897
|
204: void;
|
|
6774
7898
|
};
|
|
6775
|
-
type
|
|
6776
|
-
type
|
|
7899
|
+
type DeleteFormResponse = DeleteFormResponses[keyof DeleteFormResponses];
|
|
7900
|
+
type GetFormData = {
|
|
6777
7901
|
body?: never;
|
|
6778
7902
|
path: {
|
|
6779
|
-
|
|
7903
|
+
formId: string;
|
|
6780
7904
|
};
|
|
6781
7905
|
query?: never;
|
|
6782
|
-
url: "/api/v1/
|
|
7906
|
+
url: "/api/v1/forms/{formId}";
|
|
6783
7907
|
};
|
|
6784
|
-
type
|
|
7908
|
+
type GetFormErrors = {
|
|
6785
7909
|
/**
|
|
6786
7910
|
* Unauthorized
|
|
6787
7911
|
*/
|
|
6788
7912
|
401: Error;
|
|
6789
7913
|
/**
|
|
6790
|
-
*
|
|
7914
|
+
* Form not found
|
|
6791
7915
|
*/
|
|
6792
7916
|
404: Error;
|
|
6793
7917
|
};
|
|
6794
|
-
type
|
|
6795
|
-
type
|
|
7918
|
+
type GetFormError = GetFormErrors[keyof GetFormErrors];
|
|
7919
|
+
type GetFormResponses = {
|
|
6796
7920
|
/**
|
|
6797
|
-
*
|
|
7921
|
+
* Form details
|
|
6798
7922
|
*/
|
|
6799
|
-
200:
|
|
7923
|
+
200: Form;
|
|
6800
7924
|
};
|
|
6801
|
-
type
|
|
6802
|
-
type
|
|
6803
|
-
body:
|
|
7925
|
+
type GetFormResponse = GetFormResponses[keyof GetFormResponses];
|
|
7926
|
+
type UpdateFormData = {
|
|
7927
|
+
body: UpdateForm;
|
|
6804
7928
|
path: {
|
|
6805
|
-
|
|
7929
|
+
formId: string;
|
|
6806
7930
|
};
|
|
6807
7931
|
query?: never;
|
|
6808
|
-
url: "/api/v1/
|
|
7932
|
+
url: "/api/v1/forms/{formId}";
|
|
6809
7933
|
};
|
|
6810
|
-
type
|
|
7934
|
+
type UpdateFormErrors = {
|
|
6811
7935
|
/**
|
|
6812
|
-
*
|
|
7936
|
+
* Form name indicates credential/payment collection, which is not supported
|
|
6813
7937
|
*/
|
|
6814
7938
|
400: Error;
|
|
6815
7939
|
/**
|
|
@@ -6817,510 +7941,505 @@ type UpdateSiteErrors = {
|
|
|
6817
7941
|
*/
|
|
6818
7942
|
401: Error;
|
|
6819
7943
|
/**
|
|
6820
|
-
*
|
|
7944
|
+
* Form not found
|
|
6821
7945
|
*/
|
|
6822
|
-
|
|
7946
|
+
404: Error;
|
|
7947
|
+
};
|
|
7948
|
+
type UpdateFormError = UpdateFormErrors[keyof UpdateFormErrors];
|
|
7949
|
+
type UpdateFormResponses = {
|
|
6823
7950
|
/**
|
|
6824
|
-
*
|
|
7951
|
+
* Form updated successfully
|
|
6825
7952
|
*/
|
|
6826
|
-
|
|
7953
|
+
200: Form;
|
|
7954
|
+
};
|
|
7955
|
+
type UpdateFormResponse = UpdateFormResponses[keyof UpdateFormResponses];
|
|
7956
|
+
type ListSubmissionsData = {
|
|
7957
|
+
body?: never;
|
|
7958
|
+
path: {
|
|
7959
|
+
formId: string;
|
|
7960
|
+
};
|
|
7961
|
+
query?: {
|
|
7962
|
+
/**
|
|
7963
|
+
* Maximum number of submissions to return (max 100)
|
|
7964
|
+
*/
|
|
7965
|
+
limit?: string;
|
|
7966
|
+
/**
|
|
7967
|
+
* Number of submissions to skip
|
|
7968
|
+
*/
|
|
7969
|
+
offset?: string;
|
|
7970
|
+
/**
|
|
7971
|
+
* Include spam submissions (default: false)
|
|
7972
|
+
*/
|
|
7973
|
+
include_spam?: string;
|
|
7974
|
+
};
|
|
7975
|
+
url: "/api/v1/forms/{formId}/submissions";
|
|
7976
|
+
};
|
|
7977
|
+
type ListSubmissionsErrors = {
|
|
6827
7978
|
/**
|
|
6828
|
-
*
|
|
7979
|
+
* Unauthorized
|
|
6829
7980
|
*/
|
|
6830
|
-
|
|
7981
|
+
401: Error;
|
|
7982
|
+
/**
|
|
7983
|
+
* Form not found
|
|
7984
|
+
*/
|
|
7985
|
+
404: Error;
|
|
6831
7986
|
};
|
|
6832
|
-
type
|
|
6833
|
-
type
|
|
7987
|
+
type ListSubmissionsError = ListSubmissionsErrors[keyof ListSubmissionsErrors];
|
|
7988
|
+
type ListSubmissionsResponses = {
|
|
6834
7989
|
/**
|
|
6835
|
-
*
|
|
7990
|
+
* List of submissions
|
|
6836
7991
|
*/
|
|
6837
|
-
200:
|
|
7992
|
+
200: SubmissionsList;
|
|
6838
7993
|
};
|
|
6839
|
-
type
|
|
6840
|
-
type
|
|
7994
|
+
type ListSubmissionsResponse = ListSubmissionsResponses[keyof ListSubmissionsResponses];
|
|
7995
|
+
type DeleteSubmissionData = {
|
|
6841
7996
|
body?: never;
|
|
6842
7997
|
path: {
|
|
6843
|
-
|
|
7998
|
+
submissionId: string;
|
|
6844
7999
|
};
|
|
6845
8000
|
query?: never;
|
|
6846
|
-
url: "/api/v1/
|
|
8001
|
+
url: "/api/v1/submissions/{submissionId}";
|
|
6847
8002
|
};
|
|
6848
|
-
type
|
|
8003
|
+
type DeleteSubmissionErrors = {
|
|
6849
8004
|
/**
|
|
6850
8005
|
* Unauthorized
|
|
6851
8006
|
*/
|
|
6852
8007
|
401: Error;
|
|
6853
8008
|
/**
|
|
6854
|
-
*
|
|
6855
|
-
*/
|
|
6856
|
-
403: Error;
|
|
6857
|
-
/**
|
|
6858
|
-
* Site not found
|
|
8009
|
+
* Submission not found
|
|
6859
8010
|
*/
|
|
6860
8011
|
404: Error;
|
|
6861
8012
|
};
|
|
6862
|
-
type
|
|
6863
|
-
type
|
|
8013
|
+
type DeleteSubmissionError = DeleteSubmissionErrors[keyof DeleteSubmissionErrors];
|
|
8014
|
+
type DeleteSubmissionResponses = {
|
|
6864
8015
|
/**
|
|
6865
|
-
*
|
|
8016
|
+
* Submission deleted successfully
|
|
6866
8017
|
*/
|
|
6867
|
-
|
|
8018
|
+
204: void;
|
|
6868
8019
|
};
|
|
6869
|
-
type
|
|
6870
|
-
type
|
|
6871
|
-
body
|
|
8020
|
+
type DeleteSubmissionResponse = DeleteSubmissionResponses[keyof DeleteSubmissionResponses];
|
|
8021
|
+
type GetSubmissionData = {
|
|
8022
|
+
body?: never;
|
|
6872
8023
|
path: {
|
|
6873
|
-
|
|
8024
|
+
submissionId: string;
|
|
6874
8025
|
};
|
|
6875
8026
|
query?: never;
|
|
6876
|
-
url: "/api/v1/
|
|
8027
|
+
url: "/api/v1/submissions/{submissionId}";
|
|
6877
8028
|
};
|
|
6878
|
-
type
|
|
8029
|
+
type GetSubmissionErrors = {
|
|
6879
8030
|
/**
|
|
6880
8031
|
* Unauthorized
|
|
6881
8032
|
*/
|
|
6882
8033
|
401: Error;
|
|
6883
8034
|
/**
|
|
6884
|
-
*
|
|
6885
|
-
*/
|
|
6886
|
-
403: Error;
|
|
6887
|
-
/**
|
|
6888
|
-
* Site not found
|
|
8035
|
+
* Submission not found
|
|
6889
8036
|
*/
|
|
6890
8037
|
404: Error;
|
|
6891
8038
|
};
|
|
6892
|
-
type
|
|
6893
|
-
type
|
|
8039
|
+
type GetSubmissionError = GetSubmissionErrors[keyof GetSubmissionErrors];
|
|
8040
|
+
type GetSubmissionResponses = {
|
|
6894
8041
|
/**
|
|
6895
|
-
*
|
|
8042
|
+
* Submission details
|
|
6896
8043
|
*/
|
|
6897
|
-
200:
|
|
8044
|
+
200: Submission;
|
|
6898
8045
|
};
|
|
6899
|
-
type
|
|
6900
|
-
type
|
|
6901
|
-
body
|
|
8046
|
+
type GetSubmissionResponse = GetSubmissionResponses[keyof GetSubmissionResponses];
|
|
8047
|
+
type DownloadAttachmentData = {
|
|
8048
|
+
body?: never;
|
|
6902
8049
|
path: {
|
|
6903
|
-
|
|
8050
|
+
submissionId: string;
|
|
8051
|
+
/**
|
|
8052
|
+
* Attachment id, or a filename for legacy submissions without ids
|
|
8053
|
+
*/
|
|
8054
|
+
attachmentId: string;
|
|
6904
8055
|
};
|
|
6905
8056
|
query?: never;
|
|
6906
|
-
url: "/api/v1/
|
|
8057
|
+
url: "/api/v1/submissions/{submissionId}/attachments/{attachmentId}";
|
|
6907
8058
|
};
|
|
6908
|
-
type
|
|
8059
|
+
type DownloadAttachmentErrors = {
|
|
6909
8060
|
/**
|
|
6910
8061
|
* Unauthorized
|
|
6911
8062
|
*/
|
|
6912
8063
|
401: Error;
|
|
6913
8064
|
/**
|
|
6914
|
-
*
|
|
6915
|
-
*/
|
|
6916
|
-
403: Error;
|
|
6917
|
-
/**
|
|
6918
|
-
* Site not found
|
|
8065
|
+
* Submission or attachment not found
|
|
6919
8066
|
*/
|
|
6920
8067
|
404: Error;
|
|
6921
8068
|
};
|
|
6922
|
-
type
|
|
6923
|
-
type
|
|
8069
|
+
type DownloadAttachmentError = DownloadAttachmentErrors[keyof DownloadAttachmentErrors];
|
|
8070
|
+
type DownloadAttachmentResponses = {
|
|
6924
8071
|
/**
|
|
6925
|
-
*
|
|
8072
|
+
* File content
|
|
6926
8073
|
*/
|
|
6927
|
-
200:
|
|
8074
|
+
200: unknown;
|
|
6928
8075
|
};
|
|
6929
|
-
type
|
|
6930
|
-
type GetSiteAnalyticsData = {
|
|
8076
|
+
type ListEventDestinationsData = {
|
|
6931
8077
|
body?: never;
|
|
6932
8078
|
path: {
|
|
6933
8079
|
siteId: string;
|
|
6934
8080
|
};
|
|
6935
8081
|
query?: never;
|
|
6936
|
-
url: "/api/v1/sites/{siteId}/
|
|
8082
|
+
url: "/api/v1/sites/{siteId}/event-destinations";
|
|
6937
8083
|
};
|
|
6938
|
-
type
|
|
8084
|
+
type ListEventDestinationsErrors = {
|
|
6939
8085
|
/**
|
|
6940
8086
|
* Unauthorized
|
|
6941
8087
|
*/
|
|
6942
8088
|
401: Error;
|
|
6943
|
-
/**
|
|
6944
|
-
* Forbidden - site tokens cannot read the analytics identity
|
|
6945
|
-
*/
|
|
6946
|
-
403: Error;
|
|
6947
8089
|
/**
|
|
6948
8090
|
* Site not found
|
|
6949
8091
|
*/
|
|
6950
8092
|
404: Error;
|
|
6951
8093
|
};
|
|
6952
|
-
type
|
|
6953
|
-
type
|
|
8094
|
+
type ListEventDestinationsError = ListEventDestinationsErrors[keyof ListEventDestinationsErrors];
|
|
8095
|
+
type ListEventDestinationsResponses = {
|
|
6954
8096
|
/**
|
|
6955
|
-
*
|
|
8097
|
+
* Destinations
|
|
6956
8098
|
*/
|
|
6957
|
-
200:
|
|
8099
|
+
200: EventDestinationsList;
|
|
6958
8100
|
};
|
|
6959
|
-
type
|
|
6960
|
-
type
|
|
6961
|
-
body:
|
|
8101
|
+
type ListEventDestinationsResponse = ListEventDestinationsResponses[keyof ListEventDestinationsResponses];
|
|
8102
|
+
type CreateEventDestinationData = {
|
|
8103
|
+
body: CreateEventDestination;
|
|
6962
8104
|
path: {
|
|
6963
8105
|
siteId: string;
|
|
6964
8106
|
};
|
|
6965
8107
|
query?: never;
|
|
6966
|
-
url: "/api/v1/sites/{siteId}/
|
|
8108
|
+
url: "/api/v1/sites/{siteId}/event-destinations";
|
|
6967
8109
|
};
|
|
6968
|
-
type
|
|
8110
|
+
type CreateEventDestinationErrors = {
|
|
6969
8111
|
/**
|
|
6970
|
-
*
|
|
8112
|
+
* Invalid URL, unknown topic, or unknown form
|
|
6971
8113
|
*/
|
|
6972
8114
|
400: Error;
|
|
6973
8115
|
/**
|
|
6974
8116
|
* Unauthorized
|
|
6975
8117
|
*/
|
|
6976
8118
|
401: Error;
|
|
6977
|
-
/**
|
|
6978
|
-
* Forbidden - site tokens cannot write the analytics identity or the reporting timezone
|
|
6979
|
-
*/
|
|
6980
|
-
403: Error;
|
|
6981
8119
|
/**
|
|
6982
8120
|
* Site not found
|
|
6983
8121
|
*/
|
|
6984
8122
|
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;
|
|
6989
8123
|
};
|
|
6990
|
-
type
|
|
6991
|
-
type
|
|
8124
|
+
type CreateEventDestinationError = CreateEventDestinationErrors[keyof CreateEventDestinationErrors];
|
|
8125
|
+
type CreateEventDestinationResponses = {
|
|
6992
8126
|
/**
|
|
6993
|
-
*
|
|
8127
|
+
* Destination created
|
|
6994
8128
|
*/
|
|
6995
|
-
|
|
8129
|
+
201: EventDestination;
|
|
6996
8130
|
};
|
|
6997
|
-
type
|
|
6998
|
-
type
|
|
8131
|
+
type CreateEventDestinationResponse = CreateEventDestinationResponses[keyof CreateEventDestinationResponses];
|
|
8132
|
+
type DeleteEventDestinationData = {
|
|
6999
8133
|
body?: never;
|
|
7000
8134
|
path: {
|
|
7001
8135
|
siteId: string;
|
|
8136
|
+
destinationId: string;
|
|
7002
8137
|
};
|
|
7003
8138
|
query?: never;
|
|
7004
|
-
url: "/api/v1/sites/{siteId}/
|
|
8139
|
+
url: "/api/v1/sites/{siteId}/event-destinations/{destinationId}";
|
|
7005
8140
|
};
|
|
7006
|
-
type
|
|
8141
|
+
type DeleteEventDestinationErrors = {
|
|
7007
8142
|
/**
|
|
7008
8143
|
* Unauthorized
|
|
7009
8144
|
*/
|
|
7010
8145
|
401: Error;
|
|
7011
8146
|
/**
|
|
7012
|
-
*
|
|
8147
|
+
* Not found
|
|
7013
8148
|
*/
|
|
7014
8149
|
404: Error;
|
|
7015
8150
|
};
|
|
7016
|
-
type
|
|
7017
|
-
type
|
|
8151
|
+
type DeleteEventDestinationError = DeleteEventDestinationErrors[keyof DeleteEventDestinationErrors];
|
|
8152
|
+
type DeleteEventDestinationResponses = {
|
|
7018
8153
|
/**
|
|
7019
|
-
*
|
|
8154
|
+
* Deleted
|
|
7020
8155
|
*/
|
|
7021
|
-
200:
|
|
8156
|
+
200: {
|
|
8157
|
+
success: boolean;
|
|
8158
|
+
};
|
|
7022
8159
|
};
|
|
7023
|
-
type
|
|
7024
|
-
type
|
|
7025
|
-
body
|
|
8160
|
+
type DeleteEventDestinationResponse = DeleteEventDestinationResponses[keyof DeleteEventDestinationResponses];
|
|
8161
|
+
type GetEventDestinationData = {
|
|
8162
|
+
body?: never;
|
|
7026
8163
|
path: {
|
|
7027
8164
|
siteId: string;
|
|
8165
|
+
destinationId: string;
|
|
7028
8166
|
};
|
|
7029
8167
|
query?: never;
|
|
7030
|
-
url: "/api/v1/sites/{siteId}/
|
|
8168
|
+
url: "/api/v1/sites/{siteId}/event-destinations/{destinationId}";
|
|
7031
8169
|
};
|
|
7032
|
-
type
|
|
7033
|
-
/**
|
|
7034
|
-
* Form name indicates credential/payment collection, which is not supported
|
|
7035
|
-
*/
|
|
7036
|
-
400: Error;
|
|
8170
|
+
type GetEventDestinationErrors = {
|
|
7037
8171
|
/**
|
|
7038
8172
|
* Unauthorized
|
|
7039
8173
|
*/
|
|
7040
8174
|
401: Error;
|
|
7041
8175
|
/**
|
|
7042
|
-
*
|
|
8176
|
+
* Not found
|
|
7043
8177
|
*/
|
|
7044
8178
|
404: Error;
|
|
7045
8179
|
};
|
|
7046
|
-
type
|
|
7047
|
-
type
|
|
8180
|
+
type GetEventDestinationError = GetEventDestinationErrors[keyof GetEventDestinationErrors];
|
|
8181
|
+
type GetEventDestinationResponses = {
|
|
7048
8182
|
/**
|
|
7049
|
-
*
|
|
8183
|
+
* Destination
|
|
7050
8184
|
*/
|
|
7051
|
-
|
|
8185
|
+
200: EventDestination;
|
|
7052
8186
|
};
|
|
7053
|
-
type
|
|
7054
|
-
type
|
|
7055
|
-
body
|
|
8187
|
+
type GetEventDestinationResponse = GetEventDestinationResponses[keyof GetEventDestinationResponses];
|
|
8188
|
+
type UpdateEventDestinationData = {
|
|
8189
|
+
body: UpdateEventDestination;
|
|
7056
8190
|
path: {
|
|
7057
|
-
|
|
8191
|
+
siteId: string;
|
|
8192
|
+
destinationId: string;
|
|
7058
8193
|
};
|
|
7059
8194
|
query?: never;
|
|
7060
|
-
url: "/api/v1/
|
|
8195
|
+
url: "/api/v1/sites/{siteId}/event-destinations/{destinationId}";
|
|
7061
8196
|
};
|
|
7062
|
-
type
|
|
8197
|
+
type UpdateEventDestinationErrors = {
|
|
8198
|
+
/**
|
|
8199
|
+
* Invalid URL or unknown topic
|
|
8200
|
+
*/
|
|
8201
|
+
400: Error;
|
|
7063
8202
|
/**
|
|
7064
8203
|
* Unauthorized
|
|
7065
8204
|
*/
|
|
7066
8205
|
401: Error;
|
|
7067
8206
|
/**
|
|
7068
|
-
*
|
|
8207
|
+
* Not found
|
|
7069
8208
|
*/
|
|
7070
8209
|
404: Error;
|
|
7071
8210
|
};
|
|
7072
|
-
type
|
|
7073
|
-
type
|
|
8211
|
+
type UpdateEventDestinationError = UpdateEventDestinationErrors[keyof UpdateEventDestinationErrors];
|
|
8212
|
+
type UpdateEventDestinationResponses = {
|
|
7074
8213
|
/**
|
|
7075
|
-
*
|
|
8214
|
+
* Updated
|
|
7076
8215
|
*/
|
|
7077
|
-
|
|
8216
|
+
200: EventDestination;
|
|
7078
8217
|
};
|
|
7079
|
-
type
|
|
7080
|
-
type
|
|
8218
|
+
type UpdateEventDestinationResponse = UpdateEventDestinationResponses[keyof UpdateEventDestinationResponses];
|
|
8219
|
+
type RotateEventDestinationSecretData = {
|
|
7081
8220
|
body?: never;
|
|
7082
8221
|
path: {
|
|
7083
|
-
|
|
8222
|
+
siteId: string;
|
|
8223
|
+
destinationId: string;
|
|
7084
8224
|
};
|
|
7085
8225
|
query?: never;
|
|
7086
|
-
url: "/api/v1/
|
|
8226
|
+
url: "/api/v1/sites/{siteId}/event-destinations/{destinationId}/rotate-secret";
|
|
7087
8227
|
};
|
|
7088
|
-
type
|
|
8228
|
+
type RotateEventDestinationSecretErrors = {
|
|
7089
8229
|
/**
|
|
7090
8230
|
* Unauthorized
|
|
7091
8231
|
*/
|
|
7092
8232
|
401: Error;
|
|
7093
8233
|
/**
|
|
7094
|
-
*
|
|
8234
|
+
* Not found
|
|
7095
8235
|
*/
|
|
7096
8236
|
404: Error;
|
|
7097
8237
|
};
|
|
7098
|
-
type
|
|
7099
|
-
type
|
|
8238
|
+
type RotateEventDestinationSecretError = RotateEventDestinationSecretErrors[keyof RotateEventDestinationSecretErrors];
|
|
8239
|
+
type RotateEventDestinationSecretResponses = {
|
|
7100
8240
|
/**
|
|
7101
|
-
*
|
|
8241
|
+
* Secret rotated
|
|
7102
8242
|
*/
|
|
7103
|
-
200:
|
|
8243
|
+
200: EventDestination;
|
|
7104
8244
|
};
|
|
7105
|
-
type
|
|
7106
|
-
type
|
|
7107
|
-
body
|
|
8245
|
+
type RotateEventDestinationSecretResponse = RotateEventDestinationSecretResponses[keyof RotateEventDestinationSecretResponses];
|
|
8246
|
+
type GetEventDestinationSecretData = {
|
|
8247
|
+
body?: never;
|
|
7108
8248
|
path: {
|
|
7109
|
-
|
|
8249
|
+
siteId: string;
|
|
8250
|
+
destinationId: string;
|
|
7110
8251
|
};
|
|
7111
8252
|
query?: never;
|
|
7112
|
-
url: "/api/v1/
|
|
8253
|
+
url: "/api/v1/sites/{siteId}/event-destinations/{destinationId}/secret";
|
|
7113
8254
|
};
|
|
7114
|
-
type
|
|
7115
|
-
/**
|
|
7116
|
-
* Form name indicates credential/payment collection, which is not supported
|
|
7117
|
-
*/
|
|
7118
|
-
400: Error;
|
|
8255
|
+
type GetEventDestinationSecretErrors = {
|
|
7119
8256
|
/**
|
|
7120
8257
|
* Unauthorized
|
|
7121
8258
|
*/
|
|
7122
8259
|
401: Error;
|
|
7123
8260
|
/**
|
|
7124
|
-
*
|
|
8261
|
+
* Not found
|
|
7125
8262
|
*/
|
|
7126
8263
|
404: Error;
|
|
7127
8264
|
};
|
|
7128
|
-
type
|
|
7129
|
-
type
|
|
8265
|
+
type GetEventDestinationSecretError = GetEventDestinationSecretErrors[keyof GetEventDestinationSecretErrors];
|
|
8266
|
+
type GetEventDestinationSecretResponses = {
|
|
7130
8267
|
/**
|
|
7131
|
-
*
|
|
8268
|
+
* The signing secret
|
|
7132
8269
|
*/
|
|
7133
|
-
200:
|
|
8270
|
+
200: EventDestinationSecret;
|
|
7134
8271
|
};
|
|
7135
|
-
type
|
|
7136
|
-
type
|
|
8272
|
+
type GetEventDestinationSecretResponse = GetEventDestinationSecretResponses[keyof GetEventDestinationSecretResponses];
|
|
8273
|
+
type ListEventDeliveriesData = {
|
|
7137
8274
|
body?: never;
|
|
7138
8275
|
path: {
|
|
7139
|
-
|
|
8276
|
+
siteId: string;
|
|
8277
|
+
destinationId: string;
|
|
7140
8278
|
};
|
|
7141
8279
|
query?: {
|
|
7142
|
-
|
|
7143
|
-
* Maximum number of submissions to return (max 100)
|
|
7144
|
-
*/
|
|
7145
|
-
limit?: string;
|
|
7146
|
-
/**
|
|
7147
|
-
* Number of submissions to skip
|
|
7148
|
-
*/
|
|
7149
|
-
offset?: string;
|
|
7150
|
-
/**
|
|
7151
|
-
* Include spam submissions (default: false)
|
|
7152
|
-
*/
|
|
7153
|
-
include_spam?: string;
|
|
8280
|
+
limit?: number;
|
|
7154
8281
|
};
|
|
7155
|
-
url: "/api/v1/
|
|
8282
|
+
url: "/api/v1/sites/{siteId}/event-destinations/{destinationId}/deliveries";
|
|
7156
8283
|
};
|
|
7157
|
-
type
|
|
8284
|
+
type ListEventDeliveriesErrors = {
|
|
7158
8285
|
/**
|
|
7159
8286
|
* Unauthorized
|
|
7160
8287
|
*/
|
|
7161
8288
|
401: Error;
|
|
7162
8289
|
/**
|
|
7163
|
-
*
|
|
8290
|
+
* Not found
|
|
7164
8291
|
*/
|
|
7165
8292
|
404: Error;
|
|
7166
8293
|
};
|
|
7167
|
-
type
|
|
7168
|
-
type
|
|
8294
|
+
type ListEventDeliveriesError = ListEventDeliveriesErrors[keyof ListEventDeliveriesErrors];
|
|
8295
|
+
type ListEventDeliveriesResponses = {
|
|
7169
8296
|
/**
|
|
7170
|
-
*
|
|
8297
|
+
* Deliveries
|
|
7171
8298
|
*/
|
|
7172
|
-
200:
|
|
8299
|
+
200: EventDeliveriesList;
|
|
7173
8300
|
};
|
|
7174
|
-
type
|
|
7175
|
-
type
|
|
8301
|
+
type ListEventDeliveriesResponse = ListEventDeliveriesResponses[keyof ListEventDeliveriesResponses];
|
|
8302
|
+
type RetryEventDeliveryData = {
|
|
7176
8303
|
body?: never;
|
|
7177
8304
|
path: {
|
|
7178
|
-
|
|
8305
|
+
siteId: string;
|
|
8306
|
+
destinationId: string;
|
|
8307
|
+
deliveryId: string;
|
|
7179
8308
|
};
|
|
7180
8309
|
query?: never;
|
|
7181
|
-
url: "/api/v1/
|
|
8310
|
+
url: "/api/v1/sites/{siteId}/event-destinations/{destinationId}/deliveries/{deliveryId}/retry";
|
|
7182
8311
|
};
|
|
7183
|
-
type
|
|
8312
|
+
type RetryEventDeliveryErrors = {
|
|
7184
8313
|
/**
|
|
7185
8314
|
* Unauthorized
|
|
7186
8315
|
*/
|
|
7187
8316
|
401: Error;
|
|
7188
8317
|
/**
|
|
7189
|
-
*
|
|
8318
|
+
* Not found
|
|
7190
8319
|
*/
|
|
7191
8320
|
404: Error;
|
|
7192
8321
|
};
|
|
7193
|
-
type
|
|
7194
|
-
type
|
|
8322
|
+
type RetryEventDeliveryError = RetryEventDeliveryErrors[keyof RetryEventDeliveryErrors];
|
|
8323
|
+
type RetryEventDeliveryResponses = {
|
|
7195
8324
|
/**
|
|
7196
|
-
*
|
|
8325
|
+
* Retry attempted; the row reflects the outcome
|
|
7197
8326
|
*/
|
|
7198
|
-
|
|
8327
|
+
200: EventDelivery;
|
|
7199
8328
|
};
|
|
7200
|
-
type
|
|
7201
|
-
type
|
|
8329
|
+
type RetryEventDeliveryResponse = RetryEventDeliveryResponses[keyof RetryEventDeliveryResponses];
|
|
8330
|
+
type ListEventDestinationsWithSiteTokenData = {
|
|
7202
8331
|
body?: never;
|
|
7203
|
-
path
|
|
7204
|
-
submissionId: string;
|
|
7205
|
-
};
|
|
8332
|
+
path?: never;
|
|
7206
8333
|
query?: never;
|
|
7207
|
-
url: "/api/v1/
|
|
8334
|
+
url: "/api/v1/event-destinations";
|
|
7208
8335
|
};
|
|
7209
|
-
type
|
|
8336
|
+
type ListEventDestinationsWithSiteTokenErrors = {
|
|
7210
8337
|
/**
|
|
7211
|
-
* Unauthorized
|
|
8338
|
+
* Unauthorized - requires site token
|
|
7212
8339
|
*/
|
|
7213
8340
|
401: Error;
|
|
7214
|
-
/**
|
|
7215
|
-
* Submission not found
|
|
7216
|
-
*/
|
|
7217
|
-
404: Error;
|
|
7218
8341
|
};
|
|
7219
|
-
type
|
|
7220
|
-
type
|
|
8342
|
+
type ListEventDestinationsWithSiteTokenError = ListEventDestinationsWithSiteTokenErrors[keyof ListEventDestinationsWithSiteTokenErrors];
|
|
8343
|
+
type ListEventDestinationsWithSiteTokenResponses = {
|
|
7221
8344
|
/**
|
|
7222
|
-
*
|
|
8345
|
+
* Destinations
|
|
7223
8346
|
*/
|
|
7224
|
-
200:
|
|
8347
|
+
200: EventDestinationsList;
|
|
7225
8348
|
};
|
|
7226
|
-
type
|
|
7227
|
-
type
|
|
7228
|
-
body
|
|
7229
|
-
path
|
|
7230
|
-
submissionId: string;
|
|
7231
|
-
/**
|
|
7232
|
-
* Attachment id, or a filename for legacy submissions without ids
|
|
7233
|
-
*/
|
|
7234
|
-
attachmentId: string;
|
|
7235
|
-
};
|
|
8349
|
+
type ListEventDestinationsWithSiteTokenResponse = ListEventDestinationsWithSiteTokenResponses[keyof ListEventDestinationsWithSiteTokenResponses];
|
|
8350
|
+
type CreateEventDestinationWithSiteTokenData = {
|
|
8351
|
+
body: CreateEventDestination;
|
|
8352
|
+
path?: never;
|
|
7236
8353
|
query?: never;
|
|
7237
|
-
url: "/api/v1/
|
|
8354
|
+
url: "/api/v1/event-destinations";
|
|
7238
8355
|
};
|
|
7239
|
-
type
|
|
8356
|
+
type CreateEventDestinationWithSiteTokenErrors = {
|
|
7240
8357
|
/**
|
|
7241
|
-
*
|
|
8358
|
+
* Invalid URL, unknown topic, or unknown form
|
|
7242
8359
|
*/
|
|
7243
|
-
|
|
8360
|
+
400: Error;
|
|
7244
8361
|
/**
|
|
7245
|
-
*
|
|
8362
|
+
* Unauthorized - requires site token
|
|
7246
8363
|
*/
|
|
7247
|
-
|
|
8364
|
+
401: Error;
|
|
7248
8365
|
};
|
|
7249
|
-
type
|
|
7250
|
-
type
|
|
8366
|
+
type CreateEventDestinationWithSiteTokenError = CreateEventDestinationWithSiteTokenErrors[keyof CreateEventDestinationWithSiteTokenErrors];
|
|
8367
|
+
type CreateEventDestinationWithSiteTokenResponses = {
|
|
7251
8368
|
/**
|
|
7252
|
-
*
|
|
8369
|
+
* Created
|
|
7253
8370
|
*/
|
|
7254
|
-
|
|
8371
|
+
201: EventDestination;
|
|
7255
8372
|
};
|
|
7256
|
-
type
|
|
8373
|
+
type CreateEventDestinationWithSiteTokenResponse = CreateEventDestinationWithSiteTokenResponses[keyof CreateEventDestinationWithSiteTokenResponses];
|
|
8374
|
+
type DeleteEventDestinationWithSiteTokenData = {
|
|
7257
8375
|
body?: never;
|
|
7258
8376
|
path: {
|
|
7259
|
-
|
|
8377
|
+
destinationId: string;
|
|
7260
8378
|
};
|
|
7261
8379
|
query?: never;
|
|
7262
|
-
url: "/api/v1/
|
|
8380
|
+
url: "/api/v1/event-destinations/{destinationId}";
|
|
7263
8381
|
};
|
|
7264
|
-
type
|
|
8382
|
+
type DeleteEventDestinationWithSiteTokenErrors = {
|
|
7265
8383
|
/**
|
|
7266
|
-
* Unauthorized
|
|
8384
|
+
* Unauthorized - requires site token
|
|
7267
8385
|
*/
|
|
7268
8386
|
401: Error;
|
|
7269
8387
|
/**
|
|
7270
|
-
*
|
|
8388
|
+
* Not found
|
|
7271
8389
|
*/
|
|
7272
8390
|
404: Error;
|
|
7273
8391
|
};
|
|
7274
|
-
type
|
|
7275
|
-
type
|
|
8392
|
+
type DeleteEventDestinationWithSiteTokenError = DeleteEventDestinationWithSiteTokenErrors[keyof DeleteEventDestinationWithSiteTokenErrors];
|
|
8393
|
+
type DeleteEventDestinationWithSiteTokenResponses = {
|
|
7276
8394
|
/**
|
|
7277
|
-
*
|
|
8395
|
+
* Deleted
|
|
7278
8396
|
*/
|
|
7279
|
-
200:
|
|
7280
|
-
|
|
7281
|
-
|
|
7282
|
-
|
|
7283
|
-
|
|
8397
|
+
200: {
|
|
8398
|
+
success: boolean;
|
|
8399
|
+
};
|
|
8400
|
+
};
|
|
8401
|
+
type DeleteEventDestinationWithSiteTokenResponse = DeleteEventDestinationWithSiteTokenResponses[keyof DeleteEventDestinationWithSiteTokenResponses];
|
|
8402
|
+
type UpdateEventDestinationWithSiteTokenData = {
|
|
8403
|
+
body: UpdateEventDestination;
|
|
7284
8404
|
path: {
|
|
7285
|
-
|
|
8405
|
+
destinationId: string;
|
|
7286
8406
|
};
|
|
7287
8407
|
query?: never;
|
|
7288
|
-
url: "/api/v1/
|
|
8408
|
+
url: "/api/v1/event-destinations/{destinationId}";
|
|
7289
8409
|
};
|
|
7290
|
-
type
|
|
8410
|
+
type UpdateEventDestinationWithSiteTokenErrors = {
|
|
7291
8411
|
/**
|
|
7292
|
-
* Invalid URL
|
|
8412
|
+
* Invalid URL or unknown topic
|
|
7293
8413
|
*/
|
|
7294
8414
|
400: Error;
|
|
7295
8415
|
/**
|
|
7296
|
-
* Unauthorized
|
|
8416
|
+
* Unauthorized - requires site token
|
|
7297
8417
|
*/
|
|
7298
8418
|
401: Error;
|
|
7299
8419
|
/**
|
|
7300
|
-
*
|
|
8420
|
+
* Not found
|
|
7301
8421
|
*/
|
|
7302
8422
|
404: Error;
|
|
7303
8423
|
};
|
|
7304
|
-
type
|
|
7305
|
-
type
|
|
8424
|
+
type UpdateEventDestinationWithSiteTokenError = UpdateEventDestinationWithSiteTokenErrors[keyof UpdateEventDestinationWithSiteTokenErrors];
|
|
8425
|
+
type UpdateEventDestinationWithSiteTokenResponses = {
|
|
7306
8426
|
/**
|
|
7307
|
-
*
|
|
8427
|
+
* Updated
|
|
7308
8428
|
*/
|
|
7309
|
-
|
|
8429
|
+
200: EventDestination;
|
|
7310
8430
|
};
|
|
7311
|
-
type
|
|
7312
|
-
type
|
|
8431
|
+
type UpdateEventDestinationWithSiteTokenResponse = UpdateEventDestinationWithSiteTokenResponses[keyof UpdateEventDestinationWithSiteTokenResponses];
|
|
8432
|
+
type RotateEventDestinationSecretWithSiteTokenData = {
|
|
7313
8433
|
body?: never;
|
|
7314
8434
|
path: {
|
|
7315
|
-
siteId: string;
|
|
7316
8435
|
destinationId: string;
|
|
7317
8436
|
};
|
|
7318
8437
|
query?: never;
|
|
7319
|
-
url: "/api/v1/
|
|
8438
|
+
url: "/api/v1/event-destinations/{destinationId}/rotate-secret";
|
|
7320
8439
|
};
|
|
7321
|
-
type
|
|
8440
|
+
type RotateEventDestinationSecretWithSiteTokenErrors = {
|
|
7322
8441
|
/**
|
|
7323
|
-
* Unauthorized
|
|
8442
|
+
* Unauthorized - requires site token
|
|
7324
8443
|
*/
|
|
7325
8444
|
401: Error;
|
|
7326
8445
|
/**
|
|
@@ -7328,28 +8447,25 @@ type DeleteEventDestinationErrors = {
|
|
|
7328
8447
|
*/
|
|
7329
8448
|
404: Error;
|
|
7330
8449
|
};
|
|
7331
|
-
type
|
|
7332
|
-
type
|
|
8450
|
+
type RotateEventDestinationSecretWithSiteTokenError = RotateEventDestinationSecretWithSiteTokenErrors[keyof RotateEventDestinationSecretWithSiteTokenErrors];
|
|
8451
|
+
type RotateEventDestinationSecretWithSiteTokenResponses = {
|
|
7333
8452
|
/**
|
|
7334
|
-
*
|
|
8453
|
+
* Secret rotated
|
|
7335
8454
|
*/
|
|
7336
|
-
200:
|
|
7337
|
-
success: boolean;
|
|
7338
|
-
};
|
|
8455
|
+
200: EventDestination;
|
|
7339
8456
|
};
|
|
7340
|
-
type
|
|
7341
|
-
type
|
|
8457
|
+
type RotateEventDestinationSecretWithSiteTokenResponse = RotateEventDestinationSecretWithSiteTokenResponses[keyof RotateEventDestinationSecretWithSiteTokenResponses];
|
|
8458
|
+
type GetEventDestinationSecretWithSiteTokenData = {
|
|
7342
8459
|
body?: never;
|
|
7343
8460
|
path: {
|
|
7344
|
-
siteId: string;
|
|
7345
8461
|
destinationId: string;
|
|
7346
8462
|
};
|
|
7347
8463
|
query?: never;
|
|
7348
|
-
url: "/api/v1/
|
|
8464
|
+
url: "/api/v1/event-destinations/{destinationId}/secret";
|
|
7349
8465
|
};
|
|
7350
|
-
type
|
|
8466
|
+
type GetEventDestinationSecretWithSiteTokenErrors = {
|
|
7351
8467
|
/**
|
|
7352
|
-
* Unauthorized
|
|
8468
|
+
* Unauthorized - requires site token
|
|
7353
8469
|
*/
|
|
7354
8470
|
401: Error;
|
|
7355
8471
|
/**
|
|
@@ -7357,30 +8473,27 @@ type GetEventDestinationErrors = {
|
|
|
7357
8473
|
*/
|
|
7358
8474
|
404: Error;
|
|
7359
8475
|
};
|
|
7360
|
-
type
|
|
7361
|
-
type
|
|
8476
|
+
type GetEventDestinationSecretWithSiteTokenError = GetEventDestinationSecretWithSiteTokenErrors[keyof GetEventDestinationSecretWithSiteTokenErrors];
|
|
8477
|
+
type GetEventDestinationSecretWithSiteTokenResponses = {
|
|
7362
8478
|
/**
|
|
7363
|
-
*
|
|
8479
|
+
* The signing secret
|
|
7364
8480
|
*/
|
|
7365
|
-
200:
|
|
8481
|
+
200: EventDestinationSecret;
|
|
7366
8482
|
};
|
|
7367
|
-
type
|
|
7368
|
-
type
|
|
7369
|
-
body
|
|
8483
|
+
type GetEventDestinationSecretWithSiteTokenResponse = GetEventDestinationSecretWithSiteTokenResponses[keyof GetEventDestinationSecretWithSiteTokenResponses];
|
|
8484
|
+
type ListEventDeliveriesWithSiteTokenData = {
|
|
8485
|
+
body?: never;
|
|
7370
8486
|
path: {
|
|
7371
|
-
siteId: string;
|
|
7372
8487
|
destinationId: string;
|
|
7373
8488
|
};
|
|
7374
|
-
query?:
|
|
7375
|
-
|
|
8489
|
+
query?: {
|
|
8490
|
+
limit?: number;
|
|
8491
|
+
};
|
|
8492
|
+
url: "/api/v1/event-destinations/{destinationId}/deliveries";
|
|
7376
8493
|
};
|
|
7377
|
-
type
|
|
7378
|
-
/**
|
|
7379
|
-
* Invalid URL or unknown topic
|
|
7380
|
-
*/
|
|
7381
|
-
400: Error;
|
|
8494
|
+
type ListEventDeliveriesWithSiteTokenErrors = {
|
|
7382
8495
|
/**
|
|
7383
|
-
* Unauthorized
|
|
8496
|
+
* Unauthorized - requires site token
|
|
7384
8497
|
*/
|
|
7385
8498
|
401: Error;
|
|
7386
8499
|
/**
|
|
@@ -7388,26 +8501,26 @@ type UpdateEventDestinationErrors = {
|
|
|
7388
8501
|
*/
|
|
7389
8502
|
404: Error;
|
|
7390
8503
|
};
|
|
7391
|
-
type
|
|
7392
|
-
type
|
|
8504
|
+
type ListEventDeliveriesWithSiteTokenError = ListEventDeliveriesWithSiteTokenErrors[keyof ListEventDeliveriesWithSiteTokenErrors];
|
|
8505
|
+
type ListEventDeliveriesWithSiteTokenResponses = {
|
|
7393
8506
|
/**
|
|
7394
|
-
*
|
|
8507
|
+
* Deliveries
|
|
7395
8508
|
*/
|
|
7396
|
-
200:
|
|
8509
|
+
200: EventDeliveriesList;
|
|
7397
8510
|
};
|
|
7398
|
-
type
|
|
7399
|
-
type
|
|
8511
|
+
type ListEventDeliveriesWithSiteTokenResponse = ListEventDeliveriesWithSiteTokenResponses[keyof ListEventDeliveriesWithSiteTokenResponses];
|
|
8512
|
+
type RetryEventDeliveryWithSiteTokenData = {
|
|
7400
8513
|
body?: never;
|
|
7401
8514
|
path: {
|
|
7402
|
-
siteId: string;
|
|
7403
8515
|
destinationId: string;
|
|
8516
|
+
deliveryId: string;
|
|
7404
8517
|
};
|
|
7405
8518
|
query?: never;
|
|
7406
|
-
url: "/api/v1/
|
|
8519
|
+
url: "/api/v1/event-destinations/{destinationId}/deliveries/{deliveryId}/retry";
|
|
7407
8520
|
};
|
|
7408
|
-
type
|
|
8521
|
+
type RetryEventDeliveryWithSiteTokenErrors = {
|
|
7409
8522
|
/**
|
|
7410
|
-
* Unauthorized
|
|
8523
|
+
* Unauthorized - requires site token
|
|
7411
8524
|
*/
|
|
7412
8525
|
401: Error;
|
|
7413
8526
|
/**
|
|
@@ -7415,362 +8528,394 @@ type RotateEventDestinationSecretErrors = {
|
|
|
7415
8528
|
*/
|
|
7416
8529
|
404: Error;
|
|
7417
8530
|
};
|
|
7418
|
-
type
|
|
7419
|
-
type
|
|
8531
|
+
type RetryEventDeliveryWithSiteTokenError = RetryEventDeliveryWithSiteTokenErrors[keyof RetryEventDeliveryWithSiteTokenErrors];
|
|
8532
|
+
type RetryEventDeliveryWithSiteTokenResponses = {
|
|
7420
8533
|
/**
|
|
7421
|
-
*
|
|
8534
|
+
* Retry attempted
|
|
7422
8535
|
*/
|
|
7423
|
-
200:
|
|
8536
|
+
200: EventDelivery;
|
|
7424
8537
|
};
|
|
7425
|
-
type
|
|
7426
|
-
type
|
|
8538
|
+
type RetryEventDeliveryWithSiteTokenResponse = RetryEventDeliveryWithSiteTokenResponses[keyof RetryEventDeliveryWithSiteTokenResponses];
|
|
8539
|
+
type GetPublicProductData = {
|
|
7427
8540
|
body?: never;
|
|
7428
8541
|
path: {
|
|
7429
|
-
|
|
7430
|
-
|
|
8542
|
+
productId: string;
|
|
8543
|
+
};
|
|
8544
|
+
query?: {
|
|
8545
|
+
/**
|
|
8546
|
+
* Buyer-declared market country (ISO 3166-1 alpha-2). Present: prices convert to that market's currency when supported. Absent: the site's own currency — the default response is identical for every visitor worldwide.
|
|
8547
|
+
*/
|
|
8548
|
+
country?: string;
|
|
8549
|
+
};
|
|
8550
|
+
url: "/v1/p/{productId}";
|
|
8551
|
+
};
|
|
8552
|
+
type GetPublicProductErrors = {
|
|
8553
|
+
/**
|
|
8554
|
+
* Product not found
|
|
8555
|
+
*/
|
|
8556
|
+
404: Error;
|
|
8557
|
+
};
|
|
8558
|
+
type GetPublicProductError = GetPublicProductErrors[keyof GetPublicProductErrors];
|
|
8559
|
+
type GetPublicProductResponses = {
|
|
8560
|
+
/**
|
|
8561
|
+
* Public product configuration
|
|
8562
|
+
*/
|
|
8563
|
+
200: PublicProduct & {
|
|
8564
|
+
/**
|
|
8565
|
+
* False exactly when the product has variant rows but none is active (sold out / all disabled) — render a disabled buy button; checkout would 409. True for legacy no-variant products and products with at least one active variant.
|
|
8566
|
+
*/
|
|
8567
|
+
purchasable: boolean;
|
|
8568
|
+
};
|
|
8569
|
+
};
|
|
8570
|
+
type GetPublicProductResponse = GetPublicProductResponses[keyof GetPublicProductResponses];
|
|
8571
|
+
type CreateCheckoutData = {
|
|
8572
|
+
body: CheckoutRequest;
|
|
8573
|
+
path: {
|
|
8574
|
+
productId: string;
|
|
7431
8575
|
};
|
|
7432
8576
|
query?: never;
|
|
7433
|
-
url: "/
|
|
8577
|
+
url: "/v1/p/{productId}/checkout";
|
|
7434
8578
|
};
|
|
7435
|
-
type
|
|
8579
|
+
type CreateCheckoutErrors = {
|
|
7436
8580
|
/**
|
|
7437
|
-
*
|
|
8581
|
+
* Invalid request (bad quantity/amount/metadata/urls/email, or non-JSON body)
|
|
7438
8582
|
*/
|
|
7439
|
-
|
|
8583
|
+
400: Error;
|
|
7440
8584
|
/**
|
|
7441
|
-
*
|
|
8585
|
+
* Product not found (unknown or deleted)
|
|
7442
8586
|
*/
|
|
7443
8587
|
404: Error;
|
|
8588
|
+
/**
|
|
8589
|
+
* Product/variant inactive, insufficient stock for the requested quantity, the store can't accept payments right now, a subscription-only product bought with no plan_id (code subscription_required) — or, when expectation fields were sent and the price moved, error 'price_changed' with current_unit_amount and currency alongside it
|
|
8590
|
+
*/
|
|
8591
|
+
409: Error;
|
|
8592
|
+
/**
|
|
8593
|
+
* Too many requests from this IP — retry shortly
|
|
8594
|
+
*/
|
|
8595
|
+
429: Error;
|
|
8596
|
+
/**
|
|
8597
|
+
* Stripe rejected or failed the session creation
|
|
8598
|
+
*/
|
|
8599
|
+
502: Error;
|
|
7444
8600
|
};
|
|
7445
|
-
type
|
|
7446
|
-
type
|
|
8601
|
+
type CreateCheckoutError = CreateCheckoutErrors[keyof CreateCheckoutErrors];
|
|
8602
|
+
type CreateCheckoutResponses = {
|
|
7447
8603
|
/**
|
|
7448
|
-
*
|
|
8604
|
+
* Checkout session created — redirect the buyer to url
|
|
7449
8605
|
*/
|
|
7450
|
-
200:
|
|
8606
|
+
200: CheckoutResult;
|
|
7451
8607
|
};
|
|
7452
|
-
type
|
|
7453
|
-
type
|
|
7454
|
-
body
|
|
7455
|
-
path
|
|
7456
|
-
|
|
7457
|
-
|
|
7458
|
-
|
|
7459
|
-
|
|
7460
|
-
|
|
8608
|
+
type CreateCheckoutResponse = CreateCheckoutResponses[keyof CreateCheckoutResponses];
|
|
8609
|
+
type CreateCartCheckoutData = {
|
|
8610
|
+
body: CartCheckoutRequest;
|
|
8611
|
+
path?: never;
|
|
8612
|
+
query?: never;
|
|
8613
|
+
url: "/v1/p/checkout";
|
|
8614
|
+
};
|
|
8615
|
+
type CreateCartCheckoutErrors = {
|
|
8616
|
+
/**
|
|
8617
|
+
* Structural or validation failure (see the `code` values), or invalid urls/email/metadata
|
|
8618
|
+
*/
|
|
8619
|
+
400: Error & {
|
|
8620
|
+
/**
|
|
8621
|
+
* Machine-readable failure code: invalid_items, too_many_items, invalid_variant_id, duplicate_variant, invalid_quantity, custom_amount_not_allowed, cross_site_items, multiple_redirects, mixed_currency, or preview_domain. Absent on plain validation messages (URLs, email, metadata).
|
|
8622
|
+
*/
|
|
8623
|
+
code?: string;
|
|
7461
8624
|
};
|
|
7462
|
-
|
|
8625
|
+
/**
|
|
8626
|
+
* cart_conflict carrying every currently-known per-line conflict — including `subscription_only` for a line the merchant sells on a plan only (the cart has no plan support) — shipping_option_unavailable when the buyer's chosen postage no longer exists, or the store can't accept payments right now
|
|
8627
|
+
*/
|
|
8628
|
+
409: CartConflict | ShippingOptionUnavailable | Error;
|
|
8629
|
+
/**
|
|
8630
|
+
* Too many requests from this IP — retry shortly
|
|
8631
|
+
*/
|
|
8632
|
+
429: Error;
|
|
8633
|
+
/**
|
|
8634
|
+
* Stripe rejected or failed the session creation
|
|
8635
|
+
*/
|
|
8636
|
+
502: Error;
|
|
7463
8637
|
};
|
|
7464
|
-
type
|
|
8638
|
+
type CreateCartCheckoutError = CreateCartCheckoutErrors[keyof CreateCartCheckoutErrors];
|
|
8639
|
+
type CreateCartCheckoutResponses = {
|
|
7465
8640
|
/**
|
|
7466
|
-
*
|
|
8641
|
+
* Checkout session created — redirect the buyer to url
|
|
7467
8642
|
*/
|
|
7468
|
-
|
|
8643
|
+
200: CheckoutResult;
|
|
8644
|
+
};
|
|
8645
|
+
type CreateCartCheckoutResponse = CreateCartCheckoutResponses[keyof CreateCartCheckoutResponses];
|
|
8646
|
+
type GetCartSummaryData = {
|
|
8647
|
+
body: CartSummaryRequest;
|
|
8648
|
+
path?: never;
|
|
8649
|
+
query?: never;
|
|
8650
|
+
url: "/v1/p/checkout/summary";
|
|
8651
|
+
};
|
|
8652
|
+
type GetCartSummaryErrors = {
|
|
7469
8653
|
/**
|
|
7470
|
-
*
|
|
8654
|
+
* Structural failure: invalid_items, too_many_items, invalid_variant_id, invalid_quantity, or cross_site_items
|
|
7471
8655
|
*/
|
|
7472
|
-
|
|
8656
|
+
400: Error & {
|
|
8657
|
+
/**
|
|
8658
|
+
* Machine-readable failure code: invalid_items, too_many_items, invalid_variant_id, duplicate_variant, invalid_quantity, custom_amount_not_allowed, cross_site_items, multiple_redirects, mixed_currency, or preview_domain. Absent on plain validation messages (URLs, email, metadata).
|
|
8659
|
+
*/
|
|
8660
|
+
code?: string;
|
|
8661
|
+
};
|
|
8662
|
+
/**
|
|
8663
|
+
* The cart cannot be priced — the store's shipping configuration is unreadable, or the lines do not share one currency. Show no total rather than a wrong one.
|
|
8664
|
+
*/
|
|
8665
|
+
409: Error;
|
|
8666
|
+
/**
|
|
8667
|
+
* Too many requests from this IP — retry shortly
|
|
8668
|
+
*/
|
|
8669
|
+
429: Error;
|
|
7473
8670
|
};
|
|
7474
|
-
type
|
|
7475
|
-
type
|
|
8671
|
+
type GetCartSummaryError = GetCartSummaryErrors[keyof GetCartSummaryErrors];
|
|
8672
|
+
type GetCartSummaryResponses = {
|
|
7476
8673
|
/**
|
|
7477
|
-
*
|
|
8674
|
+
* The priced cart
|
|
7478
8675
|
*/
|
|
7479
|
-
200:
|
|
8676
|
+
200: CartSummaryResult;
|
|
7480
8677
|
};
|
|
7481
|
-
type
|
|
7482
|
-
type
|
|
8678
|
+
type GetCartSummaryResponse = GetCartSummaryResponses[keyof GetCartSummaryResponses];
|
|
8679
|
+
type GetOrderSessionData = {
|
|
7483
8680
|
body?: never;
|
|
7484
8681
|
path: {
|
|
7485
|
-
|
|
7486
|
-
destinationId: string;
|
|
7487
|
-
deliveryId: string;
|
|
8682
|
+
sessionId: string;
|
|
7488
8683
|
};
|
|
7489
8684
|
query?: never;
|
|
7490
|
-
url: "/
|
|
8685
|
+
url: "/v1/o/session/{sessionId}";
|
|
7491
8686
|
};
|
|
7492
|
-
type
|
|
7493
|
-
/**
|
|
7494
|
-
* Unauthorized
|
|
7495
|
-
*/
|
|
7496
|
-
401: Error;
|
|
8687
|
+
type GetOrderSessionErrors = {
|
|
7497
8688
|
/**
|
|
7498
|
-
*
|
|
8689
|
+
* No order for this checkout session
|
|
7499
8690
|
*/
|
|
7500
8691
|
404: Error;
|
|
7501
8692
|
};
|
|
7502
|
-
type
|
|
7503
|
-
type
|
|
8693
|
+
type GetOrderSessionError = GetOrderSessionErrors[keyof GetOrderSessionErrors];
|
|
8694
|
+
type GetOrderSessionResponses = {
|
|
7504
8695
|
/**
|
|
7505
|
-
*
|
|
8696
|
+
* Order status and fulfillment pointers
|
|
7506
8697
|
*/
|
|
7507
|
-
200:
|
|
8698
|
+
200: OrderSessionStatus;
|
|
7508
8699
|
};
|
|
7509
|
-
type
|
|
7510
|
-
type
|
|
8700
|
+
type GetOrderSessionResponse = GetOrderSessionResponses[keyof GetOrderSessionResponses];
|
|
8701
|
+
type DownloadFileData = {
|
|
7511
8702
|
body?: never;
|
|
7512
|
-
path
|
|
7513
|
-
|
|
7514
|
-
|
|
8703
|
+
path: {
|
|
8704
|
+
token: string;
|
|
8705
|
+
};
|
|
8706
|
+
query?: {
|
|
8707
|
+
/**
|
|
8708
|
+
* Index of the line to download (position in the order's line_items — the same index /v1/o/session `files` entries carry). Omit for single-download orders; on multi-download orders the bare URL renders the file list.
|
|
8709
|
+
*/
|
|
8710
|
+
file?: string;
|
|
8711
|
+
};
|
|
8712
|
+
url: "/v1/d/{token}";
|
|
7515
8713
|
};
|
|
7516
|
-
type
|
|
8714
|
+
type DownloadFileErrors = {
|
|
7517
8715
|
/**
|
|
7518
|
-
*
|
|
8716
|
+
* Download revoked (order refunded/disputed) or link expired — HTML error page
|
|
7519
8717
|
*/
|
|
7520
|
-
|
|
8718
|
+
403: string;
|
|
8719
|
+
/**
|
|
8720
|
+
* Unknown token (rendered identically to revoked) — HTML error page
|
|
8721
|
+
*/
|
|
8722
|
+
404: string;
|
|
8723
|
+
/**
|
|
8724
|
+
* Download limit reached for this order — HTML error page
|
|
8725
|
+
*/
|
|
8726
|
+
429: string;
|
|
7521
8727
|
};
|
|
7522
|
-
type
|
|
7523
|
-
type
|
|
8728
|
+
type DownloadFileError = DownloadFileErrors[keyof DownloadFileErrors];
|
|
8729
|
+
type DownloadFileResponses = {
|
|
7524
8730
|
/**
|
|
7525
|
-
*
|
|
8731
|
+
* The purchased file, served as an attachment (Content-Disposition: attachment) — or, for a multi-download order with no ?file selected, the HTML file-list page
|
|
7526
8732
|
*/
|
|
7527
|
-
200:
|
|
8733
|
+
200: Blob | File;
|
|
7528
8734
|
};
|
|
7529
|
-
type
|
|
7530
|
-
type
|
|
7531
|
-
body
|
|
8735
|
+
type DownloadFileResponse = DownloadFileResponses[keyof DownloadFileResponses];
|
|
8736
|
+
type GetGeoData = {
|
|
8737
|
+
body?: never;
|
|
7532
8738
|
path?: never;
|
|
7533
8739
|
query?: never;
|
|
7534
|
-
url: "/
|
|
8740
|
+
url: "/v1/geo";
|
|
7535
8741
|
};
|
|
7536
|
-
type
|
|
7537
|
-
/**
|
|
7538
|
-
* Invalid URL, unknown topic, or unknown form
|
|
7539
|
-
*/
|
|
7540
|
-
400: Error;
|
|
8742
|
+
type GetGeoErrors = {
|
|
7541
8743
|
/**
|
|
7542
|
-
*
|
|
8744
|
+
* Too many requests from this IP — retry after the Retry-After interval
|
|
7543
8745
|
*/
|
|
7544
|
-
|
|
8746
|
+
429: Error;
|
|
7545
8747
|
};
|
|
7546
|
-
type
|
|
7547
|
-
type
|
|
8748
|
+
type GetGeoError = GetGeoErrors[keyof GetGeoErrors];
|
|
8749
|
+
type GetGeoResponses = {
|
|
7548
8750
|
/**
|
|
7549
|
-
*
|
|
8751
|
+
* The visitor's country/region (or nulls) and the consent shape verdict
|
|
7550
8752
|
*/
|
|
7551
|
-
|
|
8753
|
+
200: GeoSuggestion;
|
|
7552
8754
|
};
|
|
7553
|
-
type
|
|
7554
|
-
type
|
|
8755
|
+
type GetGeoResponse = GetGeoResponses[keyof GetGeoResponses];
|
|
8756
|
+
type GetPublicConsentPrefsData = {
|
|
7555
8757
|
body?: never;
|
|
7556
8758
|
path: {
|
|
7557
|
-
|
|
8759
|
+
configId: string;
|
|
7558
8760
|
};
|
|
7559
8761
|
query?: never;
|
|
7560
|
-
url: "/
|
|
8762
|
+
url: "/v1/prefs/{configId}";
|
|
7561
8763
|
};
|
|
7562
|
-
type
|
|
8764
|
+
type GetPublicConsentPrefsErrors = {
|
|
7563
8765
|
/**
|
|
7564
|
-
*
|
|
8766
|
+
* Config not found
|
|
7565
8767
|
*/
|
|
7566
|
-
|
|
8768
|
+
404: Error;
|
|
7567
8769
|
/**
|
|
7568
|
-
*
|
|
8770
|
+
* Too many requests for this config from this IP — retry after the Retry-After interval
|
|
7569
8771
|
*/
|
|
7570
|
-
|
|
8772
|
+
429: Error;
|
|
7571
8773
|
};
|
|
7572
|
-
type
|
|
7573
|
-
type
|
|
8774
|
+
type GetPublicConsentPrefsError = GetPublicConsentPrefsErrors[keyof GetPublicConsentPrefsErrors];
|
|
8775
|
+
type GetPublicConsentPrefsResponses = {
|
|
7574
8776
|
/**
|
|
7575
|
-
*
|
|
8777
|
+
* Public consent configuration
|
|
7576
8778
|
*/
|
|
7577
|
-
200:
|
|
7578
|
-
success: boolean;
|
|
7579
|
-
};
|
|
8779
|
+
200: ConsentPrefs;
|
|
7580
8780
|
};
|
|
7581
|
-
type
|
|
7582
|
-
type
|
|
7583
|
-
body:
|
|
7584
|
-
path
|
|
7585
|
-
destinationId: string;
|
|
7586
|
-
};
|
|
8781
|
+
type GetPublicConsentPrefsResponse = GetPublicConsentPrefsResponses[keyof GetPublicConsentPrefsResponses];
|
|
8782
|
+
type AccountLoginData = {
|
|
8783
|
+
body: AccountLoginRequest;
|
|
8784
|
+
path?: never;
|
|
7587
8785
|
query?: never;
|
|
7588
|
-
url: "/
|
|
8786
|
+
url: "/v1/account/login";
|
|
7589
8787
|
};
|
|
7590
|
-
type
|
|
8788
|
+
type AccountLoginErrors = {
|
|
7591
8789
|
/**
|
|
7592
|
-
*
|
|
8790
|
+
* Missing or malformed email or review navigation context
|
|
7593
8791
|
*/
|
|
7594
8792
|
400: Error;
|
|
7595
8793
|
/**
|
|
7596
|
-
*
|
|
8794
|
+
* Too many requests from this IP
|
|
7597
8795
|
*/
|
|
7598
|
-
|
|
8796
|
+
429: Error;
|
|
7599
8797
|
/**
|
|
7600
|
-
*
|
|
8798
|
+
* The send could not be recorded (database unavailable). Deliberately NOT folded into the uniform 200: this outcome is identical for every address on every site, so it discloses nothing, and answering ok would leave the buyer watching an inbox nothing is coming to. Safe to retry.
|
|
7601
8799
|
*/
|
|
7602
|
-
|
|
8800
|
+
500: Error;
|
|
7603
8801
|
};
|
|
7604
|
-
type
|
|
7605
|
-
type
|
|
8802
|
+
type AccountLoginError = AccountLoginErrors[keyof AccountLoginErrors];
|
|
8803
|
+
type AccountLoginResponses = {
|
|
7606
8804
|
/**
|
|
7607
|
-
*
|
|
8805
|
+
* Accepted — a link may or may not have been sent (uniform by design)
|
|
7608
8806
|
*/
|
|
7609
|
-
200:
|
|
8807
|
+
200: AccountLoginResult;
|
|
7610
8808
|
};
|
|
7611
|
-
type
|
|
7612
|
-
type
|
|
7613
|
-
body
|
|
7614
|
-
path
|
|
7615
|
-
destinationId: string;
|
|
7616
|
-
};
|
|
8809
|
+
type AccountLoginResponse = AccountLoginResponses[keyof AccountLoginResponses];
|
|
8810
|
+
type AccountVerifyData = {
|
|
8811
|
+
body: AccountVerifyRequest;
|
|
8812
|
+
path?: never;
|
|
7617
8813
|
query?: never;
|
|
7618
|
-
url: "/
|
|
8814
|
+
url: "/v1/account/verify";
|
|
7619
8815
|
};
|
|
7620
|
-
type
|
|
7621
|
-
/**
|
|
7622
|
-
* Unauthorized - requires site token
|
|
7623
|
-
*/
|
|
7624
|
-
401: Error;
|
|
8816
|
+
type AccountVerifyErrors = {
|
|
7625
8817
|
/**
|
|
7626
|
-
*
|
|
8818
|
+
* Missing or malformed body
|
|
7627
8819
|
*/
|
|
7628
|
-
|
|
7629
|
-
};
|
|
7630
|
-
type RotateEventDestinationSecretWithSiteTokenError = RotateEventDestinationSecretWithSiteTokenErrors[keyof RotateEventDestinationSecretWithSiteTokenErrors];
|
|
7631
|
-
type RotateEventDestinationSecretWithSiteTokenResponses = {
|
|
8820
|
+
400: Error;
|
|
7632
8821
|
/**
|
|
7633
|
-
*
|
|
8822
|
+
* Unknown, expired or already-used code (code invalid_code)
|
|
7634
8823
|
*/
|
|
7635
|
-
|
|
7636
|
-
};
|
|
7637
|
-
type RotateEventDestinationSecretWithSiteTokenResponse = RotateEventDestinationSecretWithSiteTokenResponses[keyof RotateEventDestinationSecretWithSiteTokenResponses];
|
|
7638
|
-
type GetEventDestinationSecretWithSiteTokenData = {
|
|
7639
|
-
body?: never;
|
|
7640
|
-
path: {
|
|
7641
|
-
destinationId: string;
|
|
7642
|
-
};
|
|
7643
|
-
query?: never;
|
|
7644
|
-
url: "/api/v1/event-destinations/{destinationId}/secret";
|
|
7645
|
-
};
|
|
7646
|
-
type GetEventDestinationSecretWithSiteTokenErrors = {
|
|
8824
|
+
401: Error;
|
|
7647
8825
|
/**
|
|
7648
|
-
*
|
|
8826
|
+
* Review login must be exchanged on the trusted account origin; the code remains unconsumed
|
|
7649
8827
|
*/
|
|
7650
|
-
|
|
8828
|
+
403: Error;
|
|
7651
8829
|
/**
|
|
7652
|
-
*
|
|
8830
|
+
* Too many attempts from this IP
|
|
7653
8831
|
*/
|
|
7654
|
-
|
|
8832
|
+
429: Error;
|
|
7655
8833
|
};
|
|
7656
|
-
type
|
|
7657
|
-
type
|
|
8834
|
+
type AccountVerifyError = AccountVerifyErrors[keyof AccountVerifyErrors];
|
|
8835
|
+
type AccountVerifyResponses = {
|
|
7658
8836
|
/**
|
|
7659
|
-
*
|
|
8837
|
+
* Signed in
|
|
7660
8838
|
*/
|
|
7661
|
-
200:
|
|
8839
|
+
200: AccountVerifyResult;
|
|
7662
8840
|
};
|
|
7663
|
-
type
|
|
7664
|
-
type
|
|
8841
|
+
type AccountVerifyResponse = AccountVerifyResponses[keyof AccountVerifyResponses];
|
|
8842
|
+
type AccountLogoutData = {
|
|
7665
8843
|
body?: never;
|
|
7666
|
-
path
|
|
7667
|
-
|
|
7668
|
-
|
|
7669
|
-
query?: {
|
|
7670
|
-
limit?: number;
|
|
7671
|
-
};
|
|
7672
|
-
url: "/api/v1/event-destinations/{destinationId}/deliveries";
|
|
8844
|
+
path?: never;
|
|
8845
|
+
query?: never;
|
|
8846
|
+
url: "/v1/account/logout";
|
|
7673
8847
|
};
|
|
7674
|
-
type
|
|
8848
|
+
type AccountLogoutErrors = {
|
|
7675
8849
|
/**
|
|
7676
|
-
*
|
|
8850
|
+
* Session expired (code session_expired)
|
|
7677
8851
|
*/
|
|
7678
8852
|
401: Error;
|
|
7679
8853
|
/**
|
|
7680
|
-
*
|
|
8854
|
+
* Wrong origin for this session (code origin_mismatch)
|
|
7681
8855
|
*/
|
|
7682
|
-
|
|
8856
|
+
403: Error;
|
|
7683
8857
|
};
|
|
7684
|
-
type
|
|
7685
|
-
type
|
|
8858
|
+
type AccountLogoutError = AccountLogoutErrors[keyof AccountLogoutErrors];
|
|
8859
|
+
type AccountLogoutResponses = {
|
|
7686
8860
|
/**
|
|
7687
|
-
*
|
|
8861
|
+
* Signed out
|
|
7688
8862
|
*/
|
|
7689
|
-
200:
|
|
8863
|
+
200: AccountLogoutResult;
|
|
7690
8864
|
};
|
|
7691
|
-
type
|
|
7692
|
-
type
|
|
8865
|
+
type AccountLogoutResponse = AccountLogoutResponses[keyof AccountLogoutResponses];
|
|
8866
|
+
type AccountMeData = {
|
|
7693
8867
|
body?: never;
|
|
7694
|
-
path
|
|
7695
|
-
destinationId: string;
|
|
7696
|
-
deliveryId: string;
|
|
7697
|
-
};
|
|
8868
|
+
path?: never;
|
|
7698
8869
|
query?: never;
|
|
7699
|
-
url: "/
|
|
8870
|
+
url: "/v1/account/me";
|
|
7700
8871
|
};
|
|
7701
|
-
type
|
|
8872
|
+
type AccountMeErrors = {
|
|
7702
8873
|
/**
|
|
7703
|
-
*
|
|
8874
|
+
* Session expired (code session_expired)
|
|
7704
8875
|
*/
|
|
7705
8876
|
401: Error;
|
|
7706
8877
|
/**
|
|
7707
|
-
*
|
|
8878
|
+
* Wrong origin for this session (code origin_mismatch)
|
|
7708
8879
|
*/
|
|
7709
|
-
|
|
8880
|
+
403: Error;
|
|
7710
8881
|
};
|
|
7711
|
-
type
|
|
7712
|
-
type
|
|
8882
|
+
type AccountMeError = AccountMeErrors[keyof AccountMeErrors];
|
|
8883
|
+
type AccountMeResponses = {
|
|
7713
8884
|
/**
|
|
7714
|
-
*
|
|
8885
|
+
* The account shelf
|
|
7715
8886
|
*/
|
|
7716
|
-
200:
|
|
8887
|
+
200: AccountMeResult;
|
|
7717
8888
|
};
|
|
7718
|
-
type
|
|
7719
|
-
type
|
|
7720
|
-
body
|
|
7721
|
-
path
|
|
7722
|
-
|
|
7723
|
-
|
|
7724
|
-
query?: {
|
|
7725
|
-
/**
|
|
7726
|
-
* Buyer-declared market country (ISO 3166-1 alpha-2). Present: prices convert to that market's currency when supported. Absent: the site's own currency — the default response is identical for every visitor worldwide.
|
|
7727
|
-
*/
|
|
7728
|
-
country?: string;
|
|
7729
|
-
};
|
|
7730
|
-
url: "/v1/p/{productId}";
|
|
8889
|
+
type AccountMeResponse = AccountMeResponses[keyof AccountMeResponses];
|
|
8890
|
+
type AccountSubscribeData = {
|
|
8891
|
+
body: AccountSubscribeRequest;
|
|
8892
|
+
path?: never;
|
|
8893
|
+
query?: never;
|
|
8894
|
+
url: "/v1/account/subscribe";
|
|
7731
8895
|
};
|
|
7732
|
-
type
|
|
8896
|
+
type AccountSubscribeErrors = {
|
|
7733
8897
|
/**
|
|
7734
|
-
*
|
|
8898
|
+
* Invalid request (urls, variant, body shape)
|
|
7735
8899
|
*/
|
|
7736
|
-
|
|
7737
|
-
};
|
|
7738
|
-
type GetPublicProductError = GetPublicProductErrors[keyof GetPublicProductErrors];
|
|
7739
|
-
type GetPublicProductResponses = {
|
|
8900
|
+
400: Error;
|
|
7740
8901
|
/**
|
|
7741
|
-
*
|
|
8902
|
+
* Session expired — sign in again (code session_expired)
|
|
7742
8903
|
*/
|
|
7743
|
-
|
|
7744
|
-
/**
|
|
7745
|
-
* False exactly when the product has variant rows but none is active (sold out / all disabled) — render a disabled buy button; checkout would 409. True for legacy no-variant products and products with at least one active variant.
|
|
7746
|
-
*/
|
|
7747
|
-
purchasable: boolean;
|
|
7748
|
-
};
|
|
7749
|
-
};
|
|
7750
|
-
type GetPublicProductResponse = GetPublicProductResponses[keyof GetPublicProductResponses];
|
|
7751
|
-
type CreateCheckoutData = {
|
|
7752
|
-
body: CheckoutRequest;
|
|
7753
|
-
path: {
|
|
7754
|
-
productId: string;
|
|
7755
|
-
};
|
|
7756
|
-
query?: never;
|
|
7757
|
-
url: "/v1/p/{productId}/checkout";
|
|
7758
|
-
};
|
|
7759
|
-
type CreateCheckoutErrors = {
|
|
8904
|
+
401: Error;
|
|
7760
8905
|
/**
|
|
7761
|
-
*
|
|
8906
|
+
* Wrong origin for this session (code origin_mismatch), or an editor preview session (code preview_session)
|
|
7762
8907
|
*/
|
|
7763
|
-
|
|
8908
|
+
403: Error;
|
|
7764
8909
|
/**
|
|
7765
|
-
* Product not found
|
|
8910
|
+
* Product not found on this site
|
|
7766
8911
|
*/
|
|
7767
8912
|
404: Error;
|
|
7768
8913
|
/**
|
|
7769
|
-
*
|
|
8914
|
+
* Plan/store not available (plan_not_available, subscription_not_ready, plan_currency_mismatch, store disabled)
|
|
7770
8915
|
*/
|
|
7771
8916
|
409: Error;
|
|
7772
8917
|
/**
|
|
7773
|
-
* Too many requests from this IP
|
|
8918
|
+
* Too many requests from this IP
|
|
7774
8919
|
*/
|
|
7775
8920
|
429: Error;
|
|
7776
8921
|
/**
|
|
@@ -7778,659 +8923,811 @@ type CreateCheckoutErrors = {
|
|
|
7778
8923
|
*/
|
|
7779
8924
|
502: Error;
|
|
7780
8925
|
};
|
|
7781
|
-
type
|
|
7782
|
-
type
|
|
8926
|
+
type AccountSubscribeError = AccountSubscribeErrors[keyof AccountSubscribeErrors];
|
|
8927
|
+
type AccountSubscribeResponses = {
|
|
7783
8928
|
/**
|
|
7784
8929
|
* Checkout session created — redirect the buyer to url
|
|
7785
8930
|
*/
|
|
7786
8931
|
200: CheckoutResult;
|
|
7787
8932
|
};
|
|
7788
|
-
type
|
|
7789
|
-
type
|
|
7790
|
-
body
|
|
7791
|
-
path
|
|
8933
|
+
type AccountSubscribeResponse = AccountSubscribeResponses[keyof AccountSubscribeResponses];
|
|
8934
|
+
type AccountCancelSubscriptionData = {
|
|
8935
|
+
body?: never;
|
|
8936
|
+
path: {
|
|
8937
|
+
subscriptionId: string;
|
|
8938
|
+
};
|
|
7792
8939
|
query?: never;
|
|
7793
|
-
url: "/v1/
|
|
8940
|
+
url: "/v1/account/subscriptions/{subscriptionId}/cancel";
|
|
7794
8941
|
};
|
|
7795
|
-
type
|
|
8942
|
+
type AccountCancelSubscriptionErrors = {
|
|
7796
8943
|
/**
|
|
7797
|
-
*
|
|
8944
|
+
* Session expired (code session_expired)
|
|
7798
8945
|
*/
|
|
7799
|
-
|
|
7800
|
-
/**
|
|
7801
|
-
* Machine-readable failure code: invalid_items, too_many_items, invalid_variant_id, duplicate_variant, invalid_quantity, custom_amount_not_allowed, cross_site_items, multiple_redirects, mixed_currency, or preview_domain. Absent on plain validation messages (URLs, email, metadata).
|
|
7802
|
-
*/
|
|
7803
|
-
code?: string;
|
|
7804
|
-
};
|
|
8946
|
+
401: Error;
|
|
7805
8947
|
/**
|
|
7806
|
-
*
|
|
8948
|
+
* Not this customer's subscription on this site
|
|
7807
8949
|
*/
|
|
7808
|
-
|
|
8950
|
+
404: Error;
|
|
7809
8951
|
/**
|
|
7810
|
-
*
|
|
8952
|
+
* Already ended (code ended)
|
|
8953
|
+
*/
|
|
8954
|
+
409: Error;
|
|
8955
|
+
/**
|
|
8956
|
+
* Too many requests from this IP
|
|
7811
8957
|
*/
|
|
7812
8958
|
429: Error;
|
|
7813
8959
|
/**
|
|
7814
|
-
* Stripe
|
|
8960
|
+
* Stripe failure — retry
|
|
7815
8961
|
*/
|
|
7816
8962
|
502: Error;
|
|
7817
8963
|
};
|
|
7818
|
-
type
|
|
7819
|
-
type
|
|
8964
|
+
type AccountCancelSubscriptionError = AccountCancelSubscriptionErrors[keyof AccountCancelSubscriptionErrors];
|
|
8965
|
+
type AccountCancelSubscriptionResponses = {
|
|
7820
8966
|
/**
|
|
7821
|
-
*
|
|
8967
|
+
* Cancellation scheduled
|
|
7822
8968
|
*/
|
|
7823
|
-
200:
|
|
8969
|
+
200: SubscriberActionResult;
|
|
7824
8970
|
};
|
|
7825
|
-
type
|
|
7826
|
-
type
|
|
7827
|
-
body
|
|
7828
|
-
path
|
|
8971
|
+
type AccountCancelSubscriptionResponse = AccountCancelSubscriptionResponses[keyof AccountCancelSubscriptionResponses];
|
|
8972
|
+
type AccountReactivateSubscriptionData = {
|
|
8973
|
+
body?: never;
|
|
8974
|
+
path: {
|
|
8975
|
+
subscriptionId: string;
|
|
8976
|
+
};
|
|
7829
8977
|
query?: never;
|
|
7830
|
-
url: "/v1/
|
|
8978
|
+
url: "/v1/account/subscriptions/{subscriptionId}/reactivate";
|
|
7831
8979
|
};
|
|
7832
|
-
type
|
|
8980
|
+
type AccountReactivateSubscriptionErrors = {
|
|
7833
8981
|
/**
|
|
7834
|
-
*
|
|
8982
|
+
* Session expired (code session_expired)
|
|
7835
8983
|
*/
|
|
7836
|
-
|
|
7837
|
-
/**
|
|
7838
|
-
* Machine-readable failure code: invalid_items, too_many_items, invalid_variant_id, duplicate_variant, invalid_quantity, custom_amount_not_allowed, cross_site_items, multiple_redirects, mixed_currency, or preview_domain. Absent on plain validation messages (URLs, email, metadata).
|
|
7839
|
-
*/
|
|
7840
|
-
code?: string;
|
|
7841
|
-
};
|
|
8984
|
+
401: Error;
|
|
7842
8985
|
/**
|
|
7843
|
-
*
|
|
8986
|
+
* Not this customer's subscription on this site
|
|
8987
|
+
*/
|
|
8988
|
+
404: Error;
|
|
8989
|
+
/**
|
|
8990
|
+
* Ended — cannot be reactivated (code ended)
|
|
7844
8991
|
*/
|
|
7845
8992
|
409: Error;
|
|
7846
8993
|
/**
|
|
7847
|
-
* Too many requests from this IP
|
|
8994
|
+
* Too many requests from this IP
|
|
7848
8995
|
*/
|
|
7849
8996
|
429: Error;
|
|
8997
|
+
/**
|
|
8998
|
+
* Stripe failure — retry
|
|
8999
|
+
*/
|
|
9000
|
+
502: Error;
|
|
7850
9001
|
};
|
|
7851
|
-
type
|
|
7852
|
-
type
|
|
9002
|
+
type AccountReactivateSubscriptionError = AccountReactivateSubscriptionErrors[keyof AccountReactivateSubscriptionErrors];
|
|
9003
|
+
type AccountReactivateSubscriptionResponses = {
|
|
7853
9004
|
/**
|
|
7854
|
-
*
|
|
9005
|
+
* Subscription will continue
|
|
7855
9006
|
*/
|
|
7856
|
-
200:
|
|
9007
|
+
200: SubscriberActionResult;
|
|
7857
9008
|
};
|
|
7858
|
-
type
|
|
7859
|
-
type
|
|
7860
|
-
body
|
|
9009
|
+
type AccountReactivateSubscriptionResponse = AccountReactivateSubscriptionResponses[keyof AccountReactivateSubscriptionResponses];
|
|
9010
|
+
type AccountUpdateSubscriptionAddressData = {
|
|
9011
|
+
body: UpdateSubscriptionAddressRequest;
|
|
7861
9012
|
path: {
|
|
7862
|
-
|
|
9013
|
+
subscriptionId: string;
|
|
7863
9014
|
};
|
|
7864
9015
|
query?: never;
|
|
7865
|
-
url: "/v1/
|
|
9016
|
+
url: "/v1/account/subscriptions/{subscriptionId}/address";
|
|
7866
9017
|
};
|
|
7867
|
-
type
|
|
9018
|
+
type AccountUpdateSubscriptionAddressErrors = {
|
|
7868
9019
|
/**
|
|
7869
|
-
*
|
|
9020
|
+
* Invalid address shape
|
|
9021
|
+
*/
|
|
9022
|
+
400: Error;
|
|
9023
|
+
/**
|
|
9024
|
+
* Session expired (code session_expired)
|
|
9025
|
+
*/
|
|
9026
|
+
401: Error;
|
|
9027
|
+
/**
|
|
9028
|
+
* Not this customer's subscription on this site
|
|
7870
9029
|
*/
|
|
7871
9030
|
404: Error;
|
|
9031
|
+
/**
|
|
9032
|
+
* Too many requests from this IP
|
|
9033
|
+
*/
|
|
9034
|
+
429: Error;
|
|
7872
9035
|
};
|
|
7873
|
-
type
|
|
7874
|
-
type
|
|
9036
|
+
type AccountUpdateSubscriptionAddressError = AccountUpdateSubscriptionAddressErrors[keyof AccountUpdateSubscriptionAddressErrors];
|
|
9037
|
+
type AccountUpdateSubscriptionAddressResponses = {
|
|
7875
9038
|
/**
|
|
7876
|
-
*
|
|
9039
|
+
* Address updated
|
|
7877
9040
|
*/
|
|
7878
|
-
200:
|
|
9041
|
+
200: SubscriberActionResult;
|
|
7879
9042
|
};
|
|
7880
|
-
type
|
|
7881
|
-
type
|
|
9043
|
+
type AccountUpdateSubscriptionAddressResponse = AccountUpdateSubscriptionAddressResponses[keyof AccountUpdateSubscriptionAddressResponses];
|
|
9044
|
+
type AccountCreatePortalSessionData = {
|
|
7882
9045
|
body?: never;
|
|
7883
9046
|
path: {
|
|
7884
|
-
|
|
7885
|
-
};
|
|
7886
|
-
query?: {
|
|
7887
|
-
/**
|
|
7888
|
-
* Index of the line to download (position in the order's line_items — the same index /v1/o/session `files` entries carry). Omit for single-download orders; on multi-download orders the bare URL renders the file list.
|
|
7889
|
-
*/
|
|
7890
|
-
file?: string;
|
|
9047
|
+
subscriptionId: string;
|
|
7891
9048
|
};
|
|
7892
|
-
|
|
9049
|
+
query?: never;
|
|
9050
|
+
url: "/v1/account/subscriptions/{subscriptionId}/portal-session";
|
|
7893
9051
|
};
|
|
7894
|
-
type
|
|
9052
|
+
type AccountCreatePortalSessionErrors = {
|
|
7895
9053
|
/**
|
|
7896
|
-
*
|
|
9054
|
+
* Session expired (code session_expired)
|
|
7897
9055
|
*/
|
|
7898
|
-
|
|
9056
|
+
401: Error;
|
|
7899
9057
|
/**
|
|
7900
|
-
*
|
|
9058
|
+
* Not this customer's subscription on this site
|
|
7901
9059
|
*/
|
|
7902
|
-
404:
|
|
9060
|
+
404: Error;
|
|
7903
9061
|
/**
|
|
7904
|
-
*
|
|
9062
|
+
* Too many requests from this IP
|
|
7905
9063
|
*/
|
|
7906
|
-
429:
|
|
9064
|
+
429: Error;
|
|
9065
|
+
/**
|
|
9066
|
+
* Card update temporarily unavailable (code portal_unavailable)
|
|
9067
|
+
*/
|
|
9068
|
+
503: Error;
|
|
7907
9069
|
};
|
|
7908
|
-
type
|
|
7909
|
-
type
|
|
9070
|
+
type AccountCreatePortalSessionError = AccountCreatePortalSessionErrors[keyof AccountCreatePortalSessionErrors];
|
|
9071
|
+
type AccountCreatePortalSessionResponses = {
|
|
7910
9072
|
/**
|
|
7911
|
-
*
|
|
9073
|
+
* Portal session created
|
|
7912
9074
|
*/
|
|
7913
|
-
200:
|
|
9075
|
+
200: PortalSessionResult;
|
|
7914
9076
|
};
|
|
7915
|
-
type
|
|
7916
|
-
type
|
|
7917
|
-
body
|
|
9077
|
+
type AccountCreatePortalSessionResponse = AccountCreatePortalSessionResponses[keyof AccountCreatePortalSessionResponses];
|
|
9078
|
+
type AccountManageVerifyData = {
|
|
9079
|
+
body: ManageVerifyRequest;
|
|
7918
9080
|
path?: never;
|
|
7919
9081
|
query?: never;
|
|
7920
|
-
url: "/v1/
|
|
9082
|
+
url: "/v1/account/manage/verify";
|
|
7921
9083
|
};
|
|
7922
|
-
type
|
|
9084
|
+
type AccountManageVerifyErrors = {
|
|
7923
9085
|
/**
|
|
7924
|
-
*
|
|
9086
|
+
* Invalid or expired code (code invalid_code)
|
|
9087
|
+
*/
|
|
9088
|
+
400: Error;
|
|
9089
|
+
/**
|
|
9090
|
+
* Too many requests from this IP
|
|
7925
9091
|
*/
|
|
7926
9092
|
429: Error;
|
|
7927
9093
|
};
|
|
7928
|
-
type
|
|
7929
|
-
type
|
|
9094
|
+
type AccountManageVerifyError = AccountManageVerifyErrors[keyof AccountManageVerifyErrors];
|
|
9095
|
+
type AccountManageVerifyResponses = {
|
|
7930
9096
|
/**
|
|
7931
|
-
*
|
|
9097
|
+
* Grant token minted
|
|
7932
9098
|
*/
|
|
7933
|
-
200:
|
|
9099
|
+
200: ManageVerifyResult;
|
|
7934
9100
|
};
|
|
7935
|
-
type
|
|
7936
|
-
type
|
|
9101
|
+
type AccountManageVerifyResponse = AccountManageVerifyResponses[keyof AccountManageVerifyResponses];
|
|
9102
|
+
type AccountManageGetSubscriptionData = {
|
|
7937
9103
|
body?: never;
|
|
7938
|
-
path
|
|
7939
|
-
configId: string;
|
|
7940
|
-
};
|
|
9104
|
+
path?: never;
|
|
7941
9105
|
query?: never;
|
|
7942
|
-
url: "/v1/
|
|
9106
|
+
url: "/v1/account/manage/subscription";
|
|
7943
9107
|
};
|
|
7944
|
-
type
|
|
9108
|
+
type AccountManageGetSubscriptionErrors = {
|
|
7945
9109
|
/**
|
|
7946
|
-
*
|
|
9110
|
+
* Manage link invalid or expired (code manage_expired)
|
|
7947
9111
|
*/
|
|
7948
|
-
|
|
9112
|
+
401: Error;
|
|
7949
9113
|
/**
|
|
7950
|
-
*
|
|
9114
|
+
* Wrong origin for this grant (code origin_mismatch)
|
|
9115
|
+
*/
|
|
9116
|
+
403: Error;
|
|
9117
|
+
/**
|
|
9118
|
+
* Too many requests from this IP
|
|
7951
9119
|
*/
|
|
7952
9120
|
429: Error;
|
|
7953
9121
|
};
|
|
7954
|
-
type
|
|
7955
|
-
type
|
|
9122
|
+
type AccountManageGetSubscriptionError = AccountManageGetSubscriptionErrors[keyof AccountManageGetSubscriptionErrors];
|
|
9123
|
+
type AccountManageGetSubscriptionResponses = {
|
|
7956
9124
|
/**
|
|
7957
|
-
*
|
|
9125
|
+
* The granted subscription
|
|
7958
9126
|
*/
|
|
7959
|
-
200:
|
|
9127
|
+
200: ManagedSubscriptionResult;
|
|
7960
9128
|
};
|
|
7961
|
-
type
|
|
7962
|
-
type
|
|
7963
|
-
body
|
|
9129
|
+
type AccountManageGetSubscriptionResponse = AccountManageGetSubscriptionResponses[keyof AccountManageGetSubscriptionResponses];
|
|
9130
|
+
type AccountManageCancelData = {
|
|
9131
|
+
body?: never;
|
|
7964
9132
|
path?: never;
|
|
7965
9133
|
query?: never;
|
|
7966
|
-
url: "/v1/account/
|
|
9134
|
+
url: "/v1/account/manage/cancel";
|
|
7967
9135
|
};
|
|
7968
|
-
type
|
|
9136
|
+
type AccountManageCancelErrors = {
|
|
7969
9137
|
/**
|
|
7970
|
-
*
|
|
9138
|
+
* Manage link invalid or expired (code manage_expired)
|
|
7971
9139
|
*/
|
|
7972
|
-
|
|
9140
|
+
401: Error;
|
|
9141
|
+
/**
|
|
9142
|
+
* Already ended (code ended)
|
|
9143
|
+
*/
|
|
9144
|
+
409: Error;
|
|
7973
9145
|
/**
|
|
7974
9146
|
* Too many requests from this IP
|
|
7975
9147
|
*/
|
|
7976
9148
|
429: Error;
|
|
7977
9149
|
/**
|
|
7978
|
-
*
|
|
9150
|
+
* Stripe failure — retry
|
|
7979
9151
|
*/
|
|
7980
|
-
|
|
9152
|
+
502: Error;
|
|
7981
9153
|
};
|
|
7982
|
-
type
|
|
7983
|
-
type
|
|
9154
|
+
type AccountManageCancelError = AccountManageCancelErrors[keyof AccountManageCancelErrors];
|
|
9155
|
+
type AccountManageCancelResponses = {
|
|
7984
9156
|
/**
|
|
7985
|
-
*
|
|
9157
|
+
* Cancellation scheduled
|
|
7986
9158
|
*/
|
|
7987
|
-
200:
|
|
9159
|
+
200: ManageCancelResult;
|
|
7988
9160
|
};
|
|
7989
|
-
type
|
|
7990
|
-
type
|
|
7991
|
-
body
|
|
9161
|
+
type AccountManageCancelResponse = AccountManageCancelResponses[keyof AccountManageCancelResponses];
|
|
9162
|
+
type AccountManagePortalSessionData = {
|
|
9163
|
+
body?: never;
|
|
7992
9164
|
path?: never;
|
|
7993
9165
|
query?: never;
|
|
7994
|
-
url: "/v1/account/
|
|
9166
|
+
url: "/v1/account/manage/portal-session";
|
|
7995
9167
|
};
|
|
7996
|
-
type
|
|
7997
|
-
/**
|
|
7998
|
-
* Missing or malformed body
|
|
7999
|
-
*/
|
|
8000
|
-
400: Error;
|
|
9168
|
+
type AccountManagePortalSessionErrors = {
|
|
8001
9169
|
/**
|
|
8002
|
-
*
|
|
9170
|
+
* Manage link invalid or expired (code manage_expired)
|
|
8003
9171
|
*/
|
|
8004
9172
|
401: Error;
|
|
8005
9173
|
/**
|
|
8006
|
-
* Too many
|
|
9174
|
+
* Too many requests from this IP
|
|
8007
9175
|
*/
|
|
8008
9176
|
429: Error;
|
|
9177
|
+
/**
|
|
9178
|
+
* Card update temporarily unavailable (code portal_unavailable)
|
|
9179
|
+
*/
|
|
9180
|
+
503: Error;
|
|
8009
9181
|
};
|
|
8010
|
-
type
|
|
8011
|
-
type
|
|
9182
|
+
type AccountManagePortalSessionError = AccountManagePortalSessionErrors[keyof AccountManagePortalSessionErrors];
|
|
9183
|
+
type AccountManagePortalSessionResponses = {
|
|
8012
9184
|
/**
|
|
8013
|
-
*
|
|
9185
|
+
* Portal session created
|
|
8014
9186
|
*/
|
|
8015
|
-
200:
|
|
9187
|
+
200: PortalSessionResult;
|
|
8016
9188
|
};
|
|
8017
|
-
type
|
|
8018
|
-
type
|
|
9189
|
+
type AccountManagePortalSessionResponse = AccountManagePortalSessionResponses[keyof AccountManagePortalSessionResponses];
|
|
9190
|
+
type ResolveManageLinkData = {
|
|
8019
9191
|
body?: never;
|
|
8020
|
-
path
|
|
9192
|
+
path: {
|
|
9193
|
+
token: string;
|
|
9194
|
+
};
|
|
8021
9195
|
query?: never;
|
|
8022
|
-
url: "/v1/
|
|
9196
|
+
url: "/v1/m/{token}";
|
|
8023
9197
|
};
|
|
8024
|
-
type
|
|
9198
|
+
type ResolveManageLinkErrors = {
|
|
8025
9199
|
/**
|
|
8026
|
-
*
|
|
9200
|
+
* Unknown or expired link (rendered identically) — HTML page
|
|
8027
9201
|
*/
|
|
8028
|
-
|
|
9202
|
+
404: string;
|
|
8029
9203
|
/**
|
|
8030
|
-
*
|
|
9204
|
+
* Rate limited — HTML page
|
|
8031
9205
|
*/
|
|
8032
|
-
|
|
9206
|
+
429: string;
|
|
9207
|
+
/**
|
|
9208
|
+
* Temporarily unavailable (inert page, no controls)
|
|
9209
|
+
*/
|
|
9210
|
+
503: string;
|
|
8033
9211
|
};
|
|
8034
|
-
type
|
|
8035
|
-
type
|
|
9212
|
+
type ResolveManageLinkError = ResolveManageLinkErrors[keyof ResolveManageLinkErrors];
|
|
9213
|
+
type ResolveManageLinkResponses = {
|
|
8036
9214
|
/**
|
|
8037
|
-
*
|
|
9215
|
+
* Platform fallback manage page
|
|
8038
9216
|
*/
|
|
8039
|
-
200:
|
|
9217
|
+
200: string;
|
|
8040
9218
|
};
|
|
8041
|
-
type
|
|
8042
|
-
type
|
|
8043
|
-
body
|
|
8044
|
-
path
|
|
9219
|
+
type ResolveManageLinkResponse = ResolveManageLinkResponses[keyof ResolveManageLinkResponses];
|
|
9220
|
+
type ActOnManageLinkData = {
|
|
9221
|
+
body: ManageLinkAction;
|
|
9222
|
+
path: {
|
|
9223
|
+
token: string;
|
|
9224
|
+
};
|
|
8045
9225
|
query?: never;
|
|
8046
|
-
url: "/v1/
|
|
9226
|
+
url: "/v1/m/{token}";
|
|
8047
9227
|
};
|
|
8048
|
-
type
|
|
9228
|
+
type ActOnManageLinkErrors = {
|
|
8049
9229
|
/**
|
|
8050
|
-
*
|
|
9230
|
+
* Unknown action or unreadable form body — HTML page, nothing changed
|
|
8051
9231
|
*/
|
|
8052
|
-
|
|
9232
|
+
400: string;
|
|
8053
9233
|
/**
|
|
8054
|
-
*
|
|
9234
|
+
* Unknown/expired token, or a hidden token that does not match the path (rendered identically) — HTML page
|
|
8055
9235
|
*/
|
|
8056
|
-
|
|
9236
|
+
404: string;
|
|
9237
|
+
/**
|
|
9238
|
+
* Rate limited — HTML page
|
|
9239
|
+
*/
|
|
9240
|
+
429: string;
|
|
9241
|
+
/**
|
|
9242
|
+
* Stripe refused the action — HTML page, nothing changed
|
|
9243
|
+
*/
|
|
9244
|
+
502: string;
|
|
9245
|
+
/**
|
|
9246
|
+
* Temporarily unavailable (inert page, no controls)
|
|
9247
|
+
*/
|
|
9248
|
+
503: string;
|
|
8057
9249
|
};
|
|
8058
|
-
type
|
|
8059
|
-
type
|
|
9250
|
+
type ActOnManageLinkError = ActOnManageLinkErrors[keyof ActOnManageLinkErrors];
|
|
9251
|
+
type ActOnManageLinkResponses = {
|
|
8060
9252
|
/**
|
|
8061
|
-
* The
|
|
9253
|
+
* The resulting manage page (status view, cancel confirmation, or cancel receipt)
|
|
8062
9254
|
*/
|
|
8063
|
-
200:
|
|
9255
|
+
200: string;
|
|
8064
9256
|
};
|
|
8065
|
-
type
|
|
8066
|
-
type
|
|
8067
|
-
body
|
|
8068
|
-
path
|
|
8069
|
-
|
|
8070
|
-
|
|
9257
|
+
type ActOnManageLinkResponse = ActOnManageLinkResponses[keyof ActOnManageLinkResponses];
|
|
9258
|
+
type GetProductReviewsData = {
|
|
9259
|
+
body?: never;
|
|
9260
|
+
path: {
|
|
9261
|
+
productId: string;
|
|
9262
|
+
};
|
|
9263
|
+
query?: {
|
|
9264
|
+
limit?: number;
|
|
9265
|
+
cursor?: string;
|
|
9266
|
+
sort?: "newest" | "highest" | "lowest";
|
|
9267
|
+
rating?: number;
|
|
9268
|
+
};
|
|
9269
|
+
url: "/v1/p/{productId}/reviews";
|
|
8071
9270
|
};
|
|
8072
|
-
type
|
|
9271
|
+
type GetProductReviewsErrors = {
|
|
8073
9272
|
/**
|
|
8074
|
-
* Invalid
|
|
9273
|
+
* Invalid input or cursor
|
|
8075
9274
|
*/
|
|
8076
|
-
400:
|
|
9275
|
+
400: unknown;
|
|
8077
9276
|
/**
|
|
8078
|
-
*
|
|
9277
|
+
* Customer session expired
|
|
8079
9278
|
*/
|
|
8080
|
-
401:
|
|
9279
|
+
401: unknown;
|
|
8081
9280
|
/**
|
|
8082
|
-
*
|
|
9281
|
+
* Origin, preview, or challenge refused
|
|
8083
9282
|
*/
|
|
8084
|
-
403:
|
|
9283
|
+
403: unknown;
|
|
8085
9284
|
/**
|
|
8086
|
-
*
|
|
9285
|
+
* Resource unavailable
|
|
8087
9286
|
*/
|
|
8088
|
-
404:
|
|
9287
|
+
404: unknown;
|
|
8089
9288
|
/**
|
|
8090
|
-
*
|
|
9289
|
+
* Revision conflict; latest saved review included
|
|
8091
9290
|
*/
|
|
8092
|
-
409:
|
|
9291
|
+
409: {
|
|
9292
|
+
error: "review_conflict";
|
|
9293
|
+
review: OwnProductReview;
|
|
9294
|
+
};
|
|
8093
9295
|
/**
|
|
8094
|
-
*
|
|
9296
|
+
* Customer attempt budget exhausted
|
|
8095
9297
|
*/
|
|
8096
|
-
429:
|
|
9298
|
+
429: unknown;
|
|
8097
9299
|
/**
|
|
8098
|
-
*
|
|
9300
|
+
* Collection or spam protection unavailable
|
|
8099
9301
|
*/
|
|
8100
|
-
|
|
9302
|
+
503: unknown;
|
|
8101
9303
|
};
|
|
8102
|
-
type
|
|
8103
|
-
type
|
|
9304
|
+
type GetProductReviewsError = GetProductReviewsErrors[keyof GetProductReviewsErrors];
|
|
9305
|
+
type GetProductReviewsResponses = {
|
|
8104
9306
|
/**
|
|
8105
|
-
*
|
|
9307
|
+
* Public reviews
|
|
8106
9308
|
*/
|
|
8107
|
-
200:
|
|
9309
|
+
200: {
|
|
9310
|
+
reviews: Array<ProductReview>;
|
|
9311
|
+
summary: {
|
|
9312
|
+
count: number;
|
|
9313
|
+
average: number | null;
|
|
9314
|
+
distribution: {
|
|
9315
|
+
1: number;
|
|
9316
|
+
2: number;
|
|
9317
|
+
3: number;
|
|
9318
|
+
4: number;
|
|
9319
|
+
5: number;
|
|
9320
|
+
};
|
|
9321
|
+
};
|
|
9322
|
+
pagination: {
|
|
9323
|
+
next_cursor: string | null;
|
|
9324
|
+
has_more: boolean;
|
|
9325
|
+
};
|
|
9326
|
+
};
|
|
8108
9327
|
};
|
|
8109
|
-
type
|
|
8110
|
-
type
|
|
9328
|
+
type GetProductReviewsResponse = GetProductReviewsResponses[keyof GetProductReviewsResponses];
|
|
9329
|
+
type GetProductReviewAvailabilityData = {
|
|
8111
9330
|
body?: never;
|
|
8112
9331
|
path: {
|
|
8113
|
-
|
|
9332
|
+
productId: string;
|
|
8114
9333
|
};
|
|
8115
9334
|
query?: never;
|
|
8116
|
-
url: "/v1/
|
|
9335
|
+
url: "/v1/p/{productId}/reviews/availability";
|
|
8117
9336
|
};
|
|
8118
|
-
type
|
|
9337
|
+
type GetProductReviewAvailabilityErrors = {
|
|
8119
9338
|
/**
|
|
8120
|
-
*
|
|
9339
|
+
* Invalid input or cursor
|
|
8121
9340
|
*/
|
|
8122
|
-
|
|
9341
|
+
400: unknown;
|
|
8123
9342
|
/**
|
|
8124
|
-
*
|
|
9343
|
+
* Customer session expired
|
|
8125
9344
|
*/
|
|
8126
|
-
|
|
9345
|
+
401: unknown;
|
|
8127
9346
|
/**
|
|
8128
|
-
*
|
|
9347
|
+
* Origin, preview, or challenge refused
|
|
8129
9348
|
*/
|
|
8130
|
-
|
|
9349
|
+
403: unknown;
|
|
8131
9350
|
/**
|
|
8132
|
-
*
|
|
9351
|
+
* Resource unavailable
|
|
8133
9352
|
*/
|
|
8134
|
-
|
|
9353
|
+
404: unknown;
|
|
8135
9354
|
/**
|
|
8136
|
-
*
|
|
9355
|
+
* Revision conflict; latest saved review included
|
|
8137
9356
|
*/
|
|
8138
|
-
|
|
9357
|
+
409: {
|
|
9358
|
+
error: "review_conflict";
|
|
9359
|
+
review: OwnProductReview;
|
|
9360
|
+
};
|
|
9361
|
+
/**
|
|
9362
|
+
* Customer attempt budget exhausted
|
|
9363
|
+
*/
|
|
9364
|
+
429: unknown;
|
|
9365
|
+
/**
|
|
9366
|
+
* Collection or spam protection unavailable
|
|
9367
|
+
*/
|
|
9368
|
+
503: unknown;
|
|
8139
9369
|
};
|
|
8140
|
-
type
|
|
8141
|
-
type
|
|
9370
|
+
type GetProductReviewAvailabilityError = GetProductReviewAvailabilityErrors[keyof GetProductReviewAvailabilityErrors];
|
|
9371
|
+
type GetProductReviewAvailabilityResponses = {
|
|
8142
9372
|
/**
|
|
8143
|
-
*
|
|
9373
|
+
* Collection availability
|
|
8144
9374
|
*/
|
|
8145
|
-
200:
|
|
9375
|
+
200: ReviewReadiness & {
|
|
9376
|
+
product_id: string;
|
|
9377
|
+
};
|
|
8146
9378
|
};
|
|
8147
|
-
type
|
|
8148
|
-
type
|
|
9379
|
+
type GetProductReviewAvailabilityResponse = GetProductReviewAvailabilityResponses[keyof GetProductReviewAvailabilityResponses];
|
|
9380
|
+
type GetAccountReviewsData = {
|
|
8149
9381
|
body?: never;
|
|
8150
|
-
path
|
|
8151
|
-
|
|
9382
|
+
path?: never;
|
|
9383
|
+
query?: {
|
|
9384
|
+
limit?: number;
|
|
9385
|
+
cursor?: string;
|
|
8152
9386
|
};
|
|
8153
|
-
|
|
8154
|
-
url: "/v1/account/subscriptions/{subscriptionId}/reactivate";
|
|
9387
|
+
url: "/v1/account/reviews";
|
|
8155
9388
|
};
|
|
8156
|
-
type
|
|
9389
|
+
type GetAccountReviewsErrors = {
|
|
9390
|
+
/**
|
|
9391
|
+
* Invalid input or cursor
|
|
9392
|
+
*/
|
|
9393
|
+
400: unknown;
|
|
9394
|
+
/**
|
|
9395
|
+
* Customer session expired
|
|
9396
|
+
*/
|
|
9397
|
+
401: unknown;
|
|
8157
9398
|
/**
|
|
8158
|
-
*
|
|
9399
|
+
* Origin, preview, or challenge refused
|
|
8159
9400
|
*/
|
|
8160
|
-
|
|
9401
|
+
403: unknown;
|
|
8161
9402
|
/**
|
|
8162
|
-
*
|
|
9403
|
+
* Resource unavailable
|
|
8163
9404
|
*/
|
|
8164
|
-
404:
|
|
9405
|
+
404: unknown;
|
|
8165
9406
|
/**
|
|
8166
|
-
*
|
|
9407
|
+
* Revision conflict; latest saved review included
|
|
8167
9408
|
*/
|
|
8168
|
-
409:
|
|
9409
|
+
409: {
|
|
9410
|
+
error: "review_conflict";
|
|
9411
|
+
review: OwnProductReview;
|
|
9412
|
+
};
|
|
8169
9413
|
/**
|
|
8170
|
-
*
|
|
9414
|
+
* Customer attempt budget exhausted
|
|
8171
9415
|
*/
|
|
8172
|
-
429:
|
|
9416
|
+
429: unknown;
|
|
8173
9417
|
/**
|
|
8174
|
-
*
|
|
9418
|
+
* Collection or spam protection unavailable
|
|
8175
9419
|
*/
|
|
8176
|
-
|
|
9420
|
+
503: unknown;
|
|
8177
9421
|
};
|
|
8178
|
-
type
|
|
8179
|
-
type
|
|
9422
|
+
type GetAccountReviewsError = GetAccountReviewsErrors[keyof GetAccountReviewsErrors];
|
|
9423
|
+
type GetAccountReviewsResponses = {
|
|
8180
9424
|
/**
|
|
8181
|
-
*
|
|
9425
|
+
* Own reviews
|
|
8182
9426
|
*/
|
|
8183
|
-
200:
|
|
9427
|
+
200: {
|
|
9428
|
+
reviews: Array<OwnProductReview>;
|
|
9429
|
+
pagination: {
|
|
9430
|
+
next_cursor: string | null;
|
|
9431
|
+
has_more: boolean;
|
|
9432
|
+
};
|
|
9433
|
+
};
|
|
8184
9434
|
};
|
|
8185
|
-
type
|
|
8186
|
-
type
|
|
8187
|
-
body
|
|
9435
|
+
type GetAccountReviewsResponse = GetAccountReviewsResponses[keyof GetAccountReviewsResponses];
|
|
9436
|
+
type GetOwnProductReviewData = {
|
|
9437
|
+
body?: never;
|
|
8188
9438
|
path: {
|
|
8189
|
-
|
|
9439
|
+
productId: string;
|
|
8190
9440
|
};
|
|
8191
9441
|
query?: never;
|
|
8192
|
-
url: "/v1/account/
|
|
9442
|
+
url: "/v1/account/reviews/product/{productId}";
|
|
8193
9443
|
};
|
|
8194
|
-
type
|
|
9444
|
+
type GetOwnProductReviewErrors = {
|
|
8195
9445
|
/**
|
|
8196
|
-
* Invalid
|
|
9446
|
+
* Invalid input or cursor
|
|
8197
9447
|
*/
|
|
8198
|
-
400:
|
|
9448
|
+
400: unknown;
|
|
8199
9449
|
/**
|
|
8200
|
-
*
|
|
9450
|
+
* Customer session expired
|
|
8201
9451
|
*/
|
|
8202
|
-
401:
|
|
9452
|
+
401: unknown;
|
|
8203
9453
|
/**
|
|
8204
|
-
*
|
|
9454
|
+
* Origin, preview, or challenge refused
|
|
8205
9455
|
*/
|
|
8206
|
-
|
|
9456
|
+
403: unknown;
|
|
8207
9457
|
/**
|
|
8208
|
-
*
|
|
9458
|
+
* Resource unavailable
|
|
8209
9459
|
*/
|
|
8210
|
-
|
|
8211
|
-
};
|
|
8212
|
-
type AccountUpdateSubscriptionAddressError = AccountUpdateSubscriptionAddressErrors[keyof AccountUpdateSubscriptionAddressErrors];
|
|
8213
|
-
type AccountUpdateSubscriptionAddressResponses = {
|
|
9460
|
+
404: unknown;
|
|
8214
9461
|
/**
|
|
8215
|
-
*
|
|
9462
|
+
* Revision conflict; latest saved review included
|
|
8216
9463
|
*/
|
|
8217
|
-
|
|
9464
|
+
409: {
|
|
9465
|
+
error: "review_conflict";
|
|
9466
|
+
review: OwnProductReview;
|
|
9467
|
+
};
|
|
9468
|
+
/**
|
|
9469
|
+
* Customer attempt budget exhausted
|
|
9470
|
+
*/
|
|
9471
|
+
429: unknown;
|
|
9472
|
+
/**
|
|
9473
|
+
* Collection or spam protection unavailable
|
|
9474
|
+
*/
|
|
9475
|
+
503: unknown;
|
|
8218
9476
|
};
|
|
8219
|
-
type
|
|
8220
|
-
type
|
|
8221
|
-
|
|
9477
|
+
type GetOwnProductReviewError = GetOwnProductReviewErrors[keyof GetOwnProductReviewErrors];
|
|
9478
|
+
type GetOwnProductReviewResponses = {
|
|
9479
|
+
/**
|
|
9480
|
+
* Saved review or none
|
|
9481
|
+
*/
|
|
9482
|
+
200: {
|
|
9483
|
+
review: OwnProductReview & ProductReview & ({
|
|
9484
|
+
revision: number;
|
|
9485
|
+
moderation_state: "published" | "hidden";
|
|
9486
|
+
withdrawn_at: string | null;
|
|
9487
|
+
product_id: string;
|
|
9488
|
+
product_path: string | null;
|
|
9489
|
+
product_name: string | null;
|
|
9490
|
+
product_available: boolean;
|
|
9491
|
+
} | null);
|
|
9492
|
+
product_available: boolean;
|
|
9493
|
+
};
|
|
9494
|
+
};
|
|
9495
|
+
type GetOwnProductReviewResponse = GetOwnProductReviewResponses[keyof GetOwnProductReviewResponses];
|
|
9496
|
+
type CreateProductReviewData = {
|
|
9497
|
+
body: {
|
|
9498
|
+
rating: number;
|
|
9499
|
+
display_name: string;
|
|
9500
|
+
title?: string | null;
|
|
9501
|
+
body: string;
|
|
9502
|
+
product_path?: string;
|
|
9503
|
+
turnstile_token: string;
|
|
9504
|
+
};
|
|
8222
9505
|
path: {
|
|
8223
|
-
|
|
9506
|
+
productId: string;
|
|
8224
9507
|
};
|
|
8225
9508
|
query?: never;
|
|
8226
|
-
url: "/v1/account/
|
|
9509
|
+
url: "/v1/account/reviews/product/{productId}";
|
|
8227
9510
|
};
|
|
8228
|
-
type
|
|
9511
|
+
type CreateProductReviewErrors = {
|
|
8229
9512
|
/**
|
|
8230
|
-
*
|
|
9513
|
+
* Invalid input or cursor
|
|
8231
9514
|
*/
|
|
8232
|
-
|
|
9515
|
+
400: unknown;
|
|
8233
9516
|
/**
|
|
8234
|
-
*
|
|
9517
|
+
* Customer session expired
|
|
8235
9518
|
*/
|
|
8236
|
-
|
|
9519
|
+
401: unknown;
|
|
8237
9520
|
/**
|
|
8238
|
-
*
|
|
9521
|
+
* Origin, preview, or challenge refused
|
|
8239
9522
|
*/
|
|
8240
|
-
|
|
9523
|
+
403: unknown;
|
|
8241
9524
|
/**
|
|
8242
|
-
*
|
|
9525
|
+
* Resource unavailable
|
|
8243
9526
|
*/
|
|
8244
|
-
|
|
8245
|
-
};
|
|
8246
|
-
type AccountCreatePortalSessionError = AccountCreatePortalSessionErrors[keyof AccountCreatePortalSessionErrors];
|
|
8247
|
-
type AccountCreatePortalSessionResponses = {
|
|
9527
|
+
404: unknown;
|
|
8248
9528
|
/**
|
|
8249
|
-
*
|
|
9529
|
+
* Revision conflict; latest saved review included
|
|
8250
9530
|
*/
|
|
8251
|
-
|
|
8252
|
-
|
|
8253
|
-
|
|
8254
|
-
|
|
8255
|
-
body: ManageVerifyRequest;
|
|
8256
|
-
path?: never;
|
|
8257
|
-
query?: never;
|
|
8258
|
-
url: "/v1/account/manage/verify";
|
|
8259
|
-
};
|
|
8260
|
-
type AccountManageVerifyErrors = {
|
|
9531
|
+
409: {
|
|
9532
|
+
error: "review_conflict";
|
|
9533
|
+
review: OwnProductReview;
|
|
9534
|
+
};
|
|
8261
9535
|
/**
|
|
8262
|
-
*
|
|
9536
|
+
* Customer attempt budget exhausted
|
|
8263
9537
|
*/
|
|
8264
|
-
|
|
9538
|
+
429: unknown;
|
|
8265
9539
|
/**
|
|
8266
|
-
*
|
|
9540
|
+
* Collection or spam protection unavailable
|
|
8267
9541
|
*/
|
|
8268
|
-
|
|
9542
|
+
503: unknown;
|
|
8269
9543
|
};
|
|
8270
|
-
type
|
|
8271
|
-
type
|
|
9544
|
+
type CreateProductReviewError = CreateProductReviewErrors[keyof CreateProductReviewErrors];
|
|
9545
|
+
type CreateProductReviewResponses = {
|
|
8272
9546
|
/**
|
|
8273
|
-
*
|
|
9547
|
+
* Existing saved review
|
|
8274
9548
|
*/
|
|
8275
|
-
200:
|
|
9549
|
+
200: {
|
|
9550
|
+
review: OwnProductReview;
|
|
9551
|
+
};
|
|
9552
|
+
/**
|
|
9553
|
+
* Review created
|
|
9554
|
+
*/
|
|
9555
|
+
201: {
|
|
9556
|
+
review: OwnProductReview;
|
|
9557
|
+
};
|
|
8276
9558
|
};
|
|
8277
|
-
type
|
|
8278
|
-
type
|
|
8279
|
-
body
|
|
8280
|
-
|
|
9559
|
+
type CreateProductReviewResponse = CreateProductReviewResponses[keyof CreateProductReviewResponses];
|
|
9560
|
+
type EditProductReviewData = {
|
|
9561
|
+
body: {
|
|
9562
|
+
rating: number;
|
|
9563
|
+
display_name: string;
|
|
9564
|
+
title?: string | null;
|
|
9565
|
+
body: string;
|
|
9566
|
+
product_path?: string;
|
|
9567
|
+
turnstile_token: string;
|
|
9568
|
+
revision: number;
|
|
9569
|
+
};
|
|
9570
|
+
path: {
|
|
9571
|
+
reviewId: string;
|
|
9572
|
+
};
|
|
8281
9573
|
query?: never;
|
|
8282
|
-
url: "/v1/account/
|
|
9574
|
+
url: "/v1/account/reviews/{reviewId}/edit";
|
|
8283
9575
|
};
|
|
8284
|
-
type
|
|
8285
|
-
/**
|
|
8286
|
-
* Manage link invalid or expired (code manage_expired)
|
|
8287
|
-
*/
|
|
8288
|
-
401: Error;
|
|
9576
|
+
type EditProductReviewErrors = {
|
|
8289
9577
|
/**
|
|
8290
|
-
*
|
|
9578
|
+
* Invalid input or cursor
|
|
8291
9579
|
*/
|
|
8292
|
-
|
|
9580
|
+
400: unknown;
|
|
8293
9581
|
/**
|
|
8294
|
-
*
|
|
9582
|
+
* Customer session expired
|
|
8295
9583
|
*/
|
|
8296
|
-
|
|
8297
|
-
};
|
|
8298
|
-
type AccountManageGetSubscriptionError = AccountManageGetSubscriptionErrors[keyof AccountManageGetSubscriptionErrors];
|
|
8299
|
-
type AccountManageGetSubscriptionResponses = {
|
|
9584
|
+
401: unknown;
|
|
8300
9585
|
/**
|
|
8301
|
-
*
|
|
9586
|
+
* Origin, preview, or challenge refused
|
|
8302
9587
|
*/
|
|
8303
|
-
|
|
8304
|
-
};
|
|
8305
|
-
type AccountManageGetSubscriptionResponse = AccountManageGetSubscriptionResponses[keyof AccountManageGetSubscriptionResponses];
|
|
8306
|
-
type AccountManageCancelData = {
|
|
8307
|
-
body?: never;
|
|
8308
|
-
path?: never;
|
|
8309
|
-
query?: never;
|
|
8310
|
-
url: "/v1/account/manage/cancel";
|
|
8311
|
-
};
|
|
8312
|
-
type AccountManageCancelErrors = {
|
|
9588
|
+
403: unknown;
|
|
8313
9589
|
/**
|
|
8314
|
-
*
|
|
9590
|
+
* Resource unavailable
|
|
8315
9591
|
*/
|
|
8316
|
-
|
|
9592
|
+
404: unknown;
|
|
8317
9593
|
/**
|
|
8318
|
-
*
|
|
9594
|
+
* Revision conflict; latest saved review included
|
|
8319
9595
|
*/
|
|
8320
|
-
409:
|
|
9596
|
+
409: {
|
|
9597
|
+
error: "review_conflict";
|
|
9598
|
+
review: OwnProductReview;
|
|
9599
|
+
};
|
|
8321
9600
|
/**
|
|
8322
|
-
*
|
|
9601
|
+
* Customer attempt budget exhausted
|
|
8323
9602
|
*/
|
|
8324
|
-
429:
|
|
9603
|
+
429: unknown;
|
|
8325
9604
|
/**
|
|
8326
|
-
*
|
|
9605
|
+
* Collection or spam protection unavailable
|
|
8327
9606
|
*/
|
|
8328
|
-
|
|
9607
|
+
503: unknown;
|
|
8329
9608
|
};
|
|
8330
|
-
type
|
|
8331
|
-
type
|
|
9609
|
+
type EditProductReviewError = EditProductReviewErrors[keyof EditProductReviewErrors];
|
|
9610
|
+
type EditProductReviewResponses = {
|
|
8332
9611
|
/**
|
|
8333
|
-
*
|
|
9612
|
+
* Updated review
|
|
8334
9613
|
*/
|
|
8335
|
-
200:
|
|
9614
|
+
200: {
|
|
9615
|
+
review: OwnProductReview;
|
|
9616
|
+
};
|
|
8336
9617
|
};
|
|
8337
|
-
type
|
|
8338
|
-
type
|
|
8339
|
-
body
|
|
8340
|
-
|
|
9618
|
+
type EditProductReviewResponse = EditProductReviewResponses[keyof EditProductReviewResponses];
|
|
9619
|
+
type WithdrawProductReviewData = {
|
|
9620
|
+
body: {
|
|
9621
|
+
revision: number;
|
|
9622
|
+
};
|
|
9623
|
+
path: {
|
|
9624
|
+
reviewId: string;
|
|
9625
|
+
};
|
|
8341
9626
|
query?: never;
|
|
8342
|
-
url: "/v1/account/
|
|
9627
|
+
url: "/v1/account/reviews/{reviewId}/withdraw";
|
|
8343
9628
|
};
|
|
8344
|
-
type
|
|
9629
|
+
type WithdrawProductReviewErrors = {
|
|
8345
9630
|
/**
|
|
8346
|
-
*
|
|
9631
|
+
* Invalid input or cursor
|
|
8347
9632
|
*/
|
|
8348
|
-
|
|
9633
|
+
400: unknown;
|
|
8349
9634
|
/**
|
|
8350
|
-
*
|
|
9635
|
+
* Customer session expired
|
|
8351
9636
|
*/
|
|
8352
|
-
|
|
9637
|
+
401: unknown;
|
|
8353
9638
|
/**
|
|
8354
|
-
*
|
|
9639
|
+
* Origin, preview, or challenge refused
|
|
8355
9640
|
*/
|
|
8356
|
-
|
|
8357
|
-
};
|
|
8358
|
-
type AccountManagePortalSessionError = AccountManagePortalSessionErrors[keyof AccountManagePortalSessionErrors];
|
|
8359
|
-
type AccountManagePortalSessionResponses = {
|
|
9641
|
+
403: unknown;
|
|
8360
9642
|
/**
|
|
8361
|
-
*
|
|
9643
|
+
* Resource unavailable
|
|
8362
9644
|
*/
|
|
8363
|
-
|
|
8364
|
-
};
|
|
8365
|
-
type AccountManagePortalSessionResponse = AccountManagePortalSessionResponses[keyof AccountManagePortalSessionResponses];
|
|
8366
|
-
type ResolveManageLinkData = {
|
|
8367
|
-
body?: never;
|
|
8368
|
-
path: {
|
|
8369
|
-
token: string;
|
|
8370
|
-
};
|
|
8371
|
-
query?: never;
|
|
8372
|
-
url: "/v1/m/{token}";
|
|
8373
|
-
};
|
|
8374
|
-
type ResolveManageLinkErrors = {
|
|
9645
|
+
404: unknown;
|
|
8375
9646
|
/**
|
|
8376
|
-
*
|
|
9647
|
+
* Revision conflict; latest saved review included
|
|
8377
9648
|
*/
|
|
8378
|
-
|
|
9649
|
+
409: {
|
|
9650
|
+
error: "review_conflict";
|
|
9651
|
+
review: OwnProductReview;
|
|
9652
|
+
};
|
|
8379
9653
|
/**
|
|
8380
|
-
*
|
|
9654
|
+
* Customer attempt budget exhausted
|
|
8381
9655
|
*/
|
|
8382
|
-
429:
|
|
9656
|
+
429: unknown;
|
|
8383
9657
|
/**
|
|
8384
|
-
*
|
|
9658
|
+
* Collection or spam protection unavailable
|
|
8385
9659
|
*/
|
|
8386
|
-
503:
|
|
9660
|
+
503: unknown;
|
|
8387
9661
|
};
|
|
8388
|
-
type
|
|
8389
|
-
type
|
|
9662
|
+
type WithdrawProductReviewError = WithdrawProductReviewErrors[keyof WithdrawProductReviewErrors];
|
|
9663
|
+
type WithdrawProductReviewResponses = {
|
|
8390
9664
|
/**
|
|
8391
|
-
*
|
|
9665
|
+
* Updated review
|
|
8392
9666
|
*/
|
|
8393
|
-
200:
|
|
9667
|
+
200: {
|
|
9668
|
+
review: OwnProductReview;
|
|
9669
|
+
};
|
|
8394
9670
|
};
|
|
8395
|
-
type
|
|
8396
|
-
type
|
|
8397
|
-
body:
|
|
9671
|
+
type WithdrawProductReviewResponse = WithdrawProductReviewResponses[keyof WithdrawProductReviewResponses];
|
|
9672
|
+
type ResubmitProductReviewData = {
|
|
9673
|
+
body: {
|
|
9674
|
+
rating: number;
|
|
9675
|
+
display_name: string;
|
|
9676
|
+
title?: string | null;
|
|
9677
|
+
body: string;
|
|
9678
|
+
product_path?: string;
|
|
9679
|
+
turnstile_token: string;
|
|
9680
|
+
revision: number;
|
|
9681
|
+
};
|
|
8398
9682
|
path: {
|
|
8399
|
-
|
|
9683
|
+
reviewId: string;
|
|
8400
9684
|
};
|
|
8401
9685
|
query?: never;
|
|
8402
|
-
url: "/v1/
|
|
9686
|
+
url: "/v1/account/reviews/{reviewId}/resubmit";
|
|
8403
9687
|
};
|
|
8404
|
-
type
|
|
9688
|
+
type ResubmitProductReviewErrors = {
|
|
8405
9689
|
/**
|
|
8406
|
-
*
|
|
9690
|
+
* Invalid input or cursor
|
|
8407
9691
|
*/
|
|
8408
|
-
400:
|
|
9692
|
+
400: unknown;
|
|
8409
9693
|
/**
|
|
8410
|
-
*
|
|
9694
|
+
* Customer session expired
|
|
8411
9695
|
*/
|
|
8412
|
-
|
|
9696
|
+
401: unknown;
|
|
8413
9697
|
/**
|
|
8414
|
-
*
|
|
9698
|
+
* Origin, preview, or challenge refused
|
|
8415
9699
|
*/
|
|
8416
|
-
|
|
9700
|
+
403: unknown;
|
|
8417
9701
|
/**
|
|
8418
|
-
*
|
|
9702
|
+
* Resource unavailable
|
|
8419
9703
|
*/
|
|
8420
|
-
|
|
9704
|
+
404: unknown;
|
|
8421
9705
|
/**
|
|
8422
|
-
*
|
|
9706
|
+
* Revision conflict; latest saved review included
|
|
8423
9707
|
*/
|
|
8424
|
-
|
|
9708
|
+
409: {
|
|
9709
|
+
error: "review_conflict";
|
|
9710
|
+
review: OwnProductReview;
|
|
9711
|
+
};
|
|
9712
|
+
/**
|
|
9713
|
+
* Customer attempt budget exhausted
|
|
9714
|
+
*/
|
|
9715
|
+
429: unknown;
|
|
9716
|
+
/**
|
|
9717
|
+
* Collection or spam protection unavailable
|
|
9718
|
+
*/
|
|
9719
|
+
503: unknown;
|
|
8425
9720
|
};
|
|
8426
|
-
type
|
|
8427
|
-
type
|
|
9721
|
+
type ResubmitProductReviewError = ResubmitProductReviewErrors[keyof ResubmitProductReviewErrors];
|
|
9722
|
+
type ResubmitProductReviewResponses = {
|
|
8428
9723
|
/**
|
|
8429
|
-
*
|
|
9724
|
+
* Updated review
|
|
8430
9725
|
*/
|
|
8431
|
-
200:
|
|
9726
|
+
200: {
|
|
9727
|
+
review: OwnProductReview;
|
|
9728
|
+
};
|
|
8432
9729
|
};
|
|
8433
|
-
type
|
|
9730
|
+
type ResubmitProductReviewResponse = ResubmitProductReviewResponses[keyof ResubmitProductReviewResponses];
|
|
8434
9731
|
|
|
8435
9732
|
type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options$1<TData, ThrowOnError> & {
|
|
8436
9733
|
/**
|
|
@@ -8706,13 +10003,13 @@ declare const getAnalyticsStatus: <ThrowOnError extends boolean = false>(options
|
|
|
8706
10003
|
/**
|
|
8707
10004
|
* Top-line metrics with period-over-period comparison
|
|
8708
10005
|
*
|
|
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.
|
|
10006
|
+
* 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. Use `from`/`to` in place of `period` for an explicit range; the comparison is then the same number of days immediately before it.
|
|
8710
10007
|
*/
|
|
8711
10008
|
declare const getAnalyticsSummary: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsSummaryData, ThrowOnError>) => RequestResult<GetAnalyticsSummaryResponses, GetAnalyticsSummaryErrors, ThrowOnError, "fields">;
|
|
8712
10009
|
/**
|
|
8713
10010
|
* Visitors by day for the period
|
|
8714
10011
|
*
|
|
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.
|
|
10012
|
+
* One row per local day with traffic, bucketed in the site's reporting timezone. Days with no traffic are omitted rather than zero-filled. Use `from`/`to` in place of `period` for an explicit range. Day is the only bucket size: sub-day and multi-day buckets would need a pipe change, not a parameter.
|
|
8716
10013
|
*/
|
|
8717
10014
|
declare const getAnalyticsTimeseries: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsTimeseriesData, ThrowOnError>) => RequestResult<GetAnalyticsTimeseriesResponses, GetAnalyticsTimeseriesErrors, ThrowOnError, "fields">;
|
|
8718
10015
|
/**
|
|
@@ -8724,103 +10021,97 @@ declare const getAnalyticsRealtime: <ThrowOnError extends boolean = false>(optio
|
|
|
8724
10021
|
/**
|
|
8725
10022
|
* source breakdown for the period
|
|
8726
10023
|
*
|
|
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.
|
|
10024
|
+
* 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. This report rejects `dimension2` whatever is asked for: it folds the many spellings of one platform into a single label, and folding over a ranked page of PAIRS would sum only the pairs that made the cut while the label still reads as the platform's whole total. Ask for the other report crossed the other way up instead. The 400 names the alternative for the dimension asked for.
|
|
8728
10025
|
*/
|
|
8729
10026
|
declare const getAnalyticsSources: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsSourcesData, ThrowOnError>) => RequestResult<GetAnalyticsSourcesResponses, GetAnalyticsSourcesErrors, ThrowOnError, "fields">;
|
|
8730
10027
|
/**
|
|
8731
10028
|
* campaign breakdown for the period
|
|
8732
10029
|
*
|
|
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.
|
|
10030
|
+
* 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. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (visits) — crossing never changes what the count means.
|
|
8734
10031
|
*/
|
|
8735
10032
|
declare const getAnalyticsCampaigns: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsCampaignsData, ThrowOnError>) => RequestResult<GetAnalyticsCampaignsResponses, GetAnalyticsCampaignsErrors, ThrowOnError, "fields">;
|
|
8736
10033
|
/**
|
|
8737
10034
|
* utm_medium breakdown for the period
|
|
8738
10035
|
*
|
|
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.
|
|
10036
|
+
* 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. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (visits) — crossing never changes what the count means.
|
|
8740
10037
|
*/
|
|
8741
10038
|
declare const getAnalyticsUtmMedium: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsUtmMediumData, ThrowOnError>) => RequestResult<GetAnalyticsUtmMediumResponses, GetAnalyticsUtmMediumErrors, ThrowOnError, "fields">;
|
|
8742
10039
|
/**
|
|
8743
10040
|
* utm_source breakdown for the period
|
|
8744
10041
|
*
|
|
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.
|
|
10042
|
+
* 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. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (visits) — crossing never changes what the count means.
|
|
8746
10043
|
*/
|
|
8747
10044
|
declare const getAnalyticsUtmSource: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsUtmSourceData, ThrowOnError>) => RequestResult<GetAnalyticsUtmSourceResponses, GetAnalyticsUtmSourceErrors, ThrowOnError, "fields">;
|
|
8748
10045
|
/**
|
|
8749
10046
|
* campaign breakdown for the period
|
|
8750
10047
|
*
|
|
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.
|
|
10048
|
+
* 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. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (visits) — crossing never changes what the count means.
|
|
8752
10049
|
*/
|
|
8753
10050
|
declare const getAnalyticsUtmCampaign: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsUtmCampaignData, ThrowOnError>) => RequestResult<GetAnalyticsUtmCampaignResponses, GetAnalyticsUtmCampaignErrors, ThrowOnError, "fields">;
|
|
8754
10051
|
/**
|
|
8755
10052
|
* utm_content breakdown for the period
|
|
8756
10053
|
*
|
|
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.
|
|
10054
|
+
* 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. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (visits) — crossing never changes what the count means.
|
|
8758
10055
|
*/
|
|
8759
10056
|
declare const getAnalyticsUtmContent: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsUtmContentData, ThrowOnError>) => RequestResult<GetAnalyticsUtmContentResponses, GetAnalyticsUtmContentErrors, ThrowOnError, "fields">;
|
|
8760
10057
|
/**
|
|
8761
10058
|
* utm_term breakdown for the period
|
|
8762
10059
|
*
|
|
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.
|
|
10060
|
+
* 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. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (visits) — crossing never changes what the count means.
|
|
8764
10061
|
*/
|
|
8765
10062
|
declare const getAnalyticsUtmTerm: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsUtmTermData, ThrowOnError>) => RequestResult<GetAnalyticsUtmTermResponses, GetAnalyticsUtmTermErrors, ThrowOnError, "fields">;
|
|
8766
10063
|
/**
|
|
8767
10064
|
* pathname breakdown for the period
|
|
8768
10065
|
*
|
|
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.
|
|
10066
|
+
* 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. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (pageviews) — crossing never changes what the count means.
|
|
8770
10067
|
*/
|
|
8771
10068
|
declare const getAnalyticsPages: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsPagesData, ThrowOnError>) => RequestResult<GetAnalyticsPagesResponses, GetAnalyticsPagesErrors, ThrowOnError, "fields">;
|
|
8772
10069
|
/**
|
|
8773
10070
|
* pathname breakdown for the period
|
|
8774
10071
|
*
|
|
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.
|
|
10072
|
+
* 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. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (entries) — crossing never changes what the count means.
|
|
8776
10073
|
*/
|
|
8777
10074
|
declare const getAnalyticsEntryPages: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsEntryPagesData, ThrowOnError>) => RequestResult<GetAnalyticsEntryPagesResponses, GetAnalyticsEntryPagesErrors, ThrowOnError, "fields">;
|
|
8778
10075
|
/**
|
|
8779
10076
|
* pathname breakdown for the period
|
|
8780
10077
|
*
|
|
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.
|
|
10078
|
+
* 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. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (exits) — crossing never changes what the count means.
|
|
8782
10079
|
*/
|
|
8783
10080
|
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
10081
|
/**
|
|
8791
10082
|
* country breakdown for the period
|
|
8792
10083
|
*
|
|
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.
|
|
10084
|
+
* 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. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (pageviews) — crossing never changes what the count means.
|
|
8794
10085
|
*/
|
|
8795
10086
|
declare const getAnalyticsCountries: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsCountriesData, ThrowOnError>) => RequestResult<GetAnalyticsCountriesResponses, GetAnalyticsCountriesErrors, ThrowOnError, "fields">;
|
|
8796
10087
|
/**
|
|
8797
10088
|
* region breakdown for the period
|
|
8798
10089
|
*
|
|
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.
|
|
10090
|
+
* 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. This report rejects `dimension2` whatever is asked for: it already spends the pipe's one second slot on country, without which its values cannot be told apart. Ask for the other report crossed the other way up instead. The 400 names the alternative for the dimension asked for.
|
|
8800
10091
|
*/
|
|
8801
10092
|
declare const getAnalyticsRegions: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsRegionsData, ThrowOnError>) => RequestResult<GetAnalyticsRegionsResponses, GetAnalyticsRegionsErrors, ThrowOnError, "fields">;
|
|
8802
10093
|
/**
|
|
8803
10094
|
* city breakdown for the period
|
|
8804
10095
|
*
|
|
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.
|
|
10096
|
+
* 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. This report rejects `dimension2` whatever is asked for: it already spends the pipe's one second slot on country, without which its values cannot be told apart. Ask for the other report crossed the other way up instead. The 400 names the alternative for the dimension asked for.
|
|
8806
10097
|
*/
|
|
8807
10098
|
declare const getAnalyticsCities: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsCitiesData, ThrowOnError>) => RequestResult<GetAnalyticsCitiesResponses, GetAnalyticsCitiesErrors, ThrowOnError, "fields">;
|
|
8808
10099
|
/**
|
|
8809
10100
|
* device breakdown for the period
|
|
8810
10101
|
*
|
|
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.
|
|
10102
|
+
* 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. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (pageviews) — crossing never changes what the count means.
|
|
8812
10103
|
*/
|
|
8813
10104
|
declare const getAnalyticsDevices: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsDevicesData, ThrowOnError>) => RequestResult<GetAnalyticsDevicesResponses, GetAnalyticsDevicesErrors, ThrowOnError, "fields">;
|
|
8814
10105
|
/**
|
|
8815
10106
|
* browser breakdown for the period
|
|
8816
10107
|
*
|
|
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.
|
|
10108
|
+
* 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. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (pageviews) — crossing never changes what the count means.
|
|
8818
10109
|
*/
|
|
8819
10110
|
declare const getAnalyticsBrowsers: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsBrowsersData, ThrowOnError>) => RequestResult<GetAnalyticsBrowsersResponses, GetAnalyticsBrowsersErrors, ThrowOnError, "fields">;
|
|
8820
10111
|
/**
|
|
8821
10112
|
* os breakdown for the period
|
|
8822
10113
|
*
|
|
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.
|
|
10114
|
+
* 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. Pass `dimension2` to cross this report against a second dimension: the result is one row per pair, and the metric beside `visitors` stays the one THIS report's dimension decides (pageviews) — crossing never changes what the count means.
|
|
8824
10115
|
*/
|
|
8825
10116
|
declare const getAnalyticsOperatingSystems: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsOperatingSystemsData, ThrowOnError>) => RequestResult<GetAnalyticsOperatingSystemsResponses, GetAnalyticsOperatingSystemsErrors, ThrowOnError, "fields">;
|
|
8826
10117
|
/**
|
|
@@ -8975,6 +10266,20 @@ declare const resumeRetainer: <ThrowOnError extends boolean = false>(options: Op
|
|
|
8975
10266
|
* End a retainer at the end of its current period; the open cycle stays payable (org key only)
|
|
8976
10267
|
*/
|
|
8977
10268
|
declare const cancelRetainer: <ThrowOnError extends boolean = false>(options: Options<CancelRetainerData, ThrowOnError>) => RequestResult<CancelRetainerResponses, CancelRetainerErrors, ThrowOnError, "fields">;
|
|
10269
|
+
declare const listMerchantReviews: <ThrowOnError extends boolean = false>(options: Options<ListMerchantReviewsData, ThrowOnError>) => RequestResult<ListMerchantReviewsResponses, ListMerchantReviewsErrors, ThrowOnError, "fields">;
|
|
10270
|
+
declare const getMerchantReview: <ThrowOnError extends boolean = false>(options: Options<GetMerchantReviewData, ThrowOnError>) => RequestResult<GetMerchantReviewResponses, GetMerchantReviewErrors, ThrowOnError, "fields">;
|
|
10271
|
+
declare const moderateMerchantReview: <ThrowOnError extends boolean = false>(options: Options<ModerateMerchantReviewData, ThrowOnError>) => RequestResult<ModerateMerchantReviewResponses, ModerateMerchantReviewErrors, ThrowOnError, "fields">;
|
|
10272
|
+
declare const replyToMerchantReview: <ThrowOnError extends boolean = false>(options: Options<ReplyToMerchantReviewData, ThrowOnError>) => RequestResult<ReplyToMerchantReviewResponses, ReplyToMerchantReviewErrors, ThrowOnError, "fields">;
|
|
10273
|
+
declare const getReviewSettings: <ThrowOnError extends boolean = false>(options: Options<GetReviewSettingsData, ThrowOnError>) => RequestResult<GetReviewSettingsResponses, GetReviewSettingsErrors, ThrowOnError, "fields">;
|
|
10274
|
+
declare const updateReviewSettings: <ThrowOnError extends boolean = false>(options: Options<UpdateReviewSettingsData, ThrowOnError>) => RequestResult<UpdateReviewSettingsResponses, UpdateReviewSettingsErrors, ThrowOnError, "fields">;
|
|
10275
|
+
/**
|
|
10276
|
+
* Operator privacy erasure; permanently removes review content and events, retaining customer and financial records. Not an AI moderation action.
|
|
10277
|
+
*/
|
|
10278
|
+
declare const eraseCustomerReviews: <ThrowOnError extends boolean = false>(options: Options<EraseCustomerReviewsData, ThrowOnError>) => RequestResult<EraseCustomerReviewsResponses, EraseCustomerReviewsErrors, ThrowOnError, "fields">;
|
|
10279
|
+
/**
|
|
10280
|
+
* Idempotently pause collection and erase review content before website deletion. Does not remove orders.
|
|
10281
|
+
*/
|
|
10282
|
+
declare const purgeSiteReviews: <ThrowOnError extends boolean = false>(options: Options<PurgeSiteReviewsData, ThrowOnError>) => RequestResult<PurgeSiteReviewsResponses, PurgeSiteReviewsErrors, ThrowOnError, "fields">;
|
|
8978
10283
|
/**
|
|
8979
10284
|
* Get the site's consent config (site token)
|
|
8980
10285
|
*
|
|
@@ -9014,7 +10319,7 @@ declare const createSite: <ThrowOnError extends boolean = false>(options: Option
|
|
|
9014
10319
|
/**
|
|
9015
10320
|
* Delete a site (org key only)
|
|
9016
10321
|
*
|
|
9017
|
-
*
|
|
10322
|
+
* Soft-deletes a site: its token stops authenticating and public surfaces (form info/submit, product pages, checkout) refuse immediately, its domain and analytics_id claims are released (so the same external_id can be provisioned again right away), then all forms, submissions, uploaded attachments, and catalog data are permanently purged after a 30-day retention window (sites with orders keep a minimal site row so order history and refunds survive). Idempotent. Requires an organization API key (sk_xxx) — site tokens (including the site's own) are explicitly rejected.
|
|
9018
10323
|
*/
|
|
9019
10324
|
declare const deleteSite: <ThrowOnError extends boolean = false>(options: Options<DeleteSiteData, ThrowOnError>) => RequestResult<DeleteSiteResponses, DeleteSiteErrors, ThrowOnError, "fields">;
|
|
9020
10325
|
/**
|
|
@@ -9337,5 +10642,37 @@ declare const resolveManageLink: <ThrowOnError extends boolean = false>(options:
|
|
|
9337
10642
|
* The POST-to-act target of the platform fallback page's forms (the MUTATING twin of GET /v1/m/{token} — it cancels billing or opens Stripe's card-update portal). Body is a form post carrying `action` (view | confirm_cancel | cancel | reactivate | card_update) and `token`, which must equal the path token — a form scraped into another page cannot be re-pointed at a different subscription. `reactivate` is accepted ONLY while the store cannot serve its own /account page: where signing in is possible, restarting billing requires a session rather than an emailed bearer, and the action answers with the status page instead. Responses are HTML for the same reason the GET's are: this is a browser form submission from an emailed page, never a fetch(). Unknown, expired and revoked tokens render identically to the GET's.
|
|
9338
10643
|
*/
|
|
9339
10644
|
declare const actOnManageLink: <ThrowOnError extends boolean = false>(options: Options<ActOnManageLinkData, ThrowOnError>) => RequestResult<ActOnManageLinkResponses, ActOnManageLinkErrors, ThrowOnError, "fields">;
|
|
10645
|
+
/**
|
|
10646
|
+
* Read public product reviews and the full visible rating summary
|
|
10647
|
+
*/
|
|
10648
|
+
declare const getProductReviews: <ThrowOnError extends boolean = false>(options: Options<GetProductReviewsData, ThrowOnError>) => RequestResult<GetProductReviewsResponses, GetProductReviewsErrors, ThrowOnError, "fields">;
|
|
10649
|
+
/**
|
|
10650
|
+
* Check review collection setup
|
|
10651
|
+
*/
|
|
10652
|
+
declare const getProductReviewAvailability: <ThrowOnError extends boolean = false>(options: Options<GetProductReviewAvailabilityData, ThrowOnError>) => RequestResult<GetProductReviewAvailabilityResponses, GetProductReviewAvailabilityErrors, ThrowOnError, "fields">;
|
|
10653
|
+
/**
|
|
10654
|
+
* Read your reviews, including hidden, withdrawn and unavailable products
|
|
10655
|
+
*/
|
|
10656
|
+
declare const getAccountReviews: <ThrowOnError extends boolean = false>(options?: Options<GetAccountReviewsData, ThrowOnError>) => RequestResult<GetAccountReviewsResponses, GetAccountReviewsErrors, ThrowOnError, "fields">;
|
|
10657
|
+
/**
|
|
10658
|
+
* Read your saved review for a product
|
|
10659
|
+
*/
|
|
10660
|
+
declare const getOwnProductReview: <ThrowOnError extends boolean = false>(options: Options<GetOwnProductReviewData, ThrowOnError>) => RequestResult<GetOwnProductReviewResponses, GetOwnProductReviewErrors, ThrowOnError, "fields">;
|
|
10661
|
+
/**
|
|
10662
|
+
* Create a review with a fresh review_write challenge; duplicate creates recover the saved row
|
|
10663
|
+
*/
|
|
10664
|
+
declare const createProductReview: <ThrowOnError extends boolean = false>(options: Options<CreateProductReviewData, ThrowOnError>) => RequestResult<CreateProductReviewResponses, CreateProductReviewErrors, ThrowOnError, "fields">;
|
|
10665
|
+
/**
|
|
10666
|
+
* edit your review at the saved revision
|
|
10667
|
+
*/
|
|
10668
|
+
declare const editProductReview: <ThrowOnError extends boolean = false>(options: Options<EditProductReviewData, ThrowOnError>) => RequestResult<EditProductReviewResponses, EditProductReviewErrors, ThrowOnError, "fields">;
|
|
10669
|
+
/**
|
|
10670
|
+
* withdraw your review at the saved revision
|
|
10671
|
+
*/
|
|
10672
|
+
declare const withdrawProductReview: <ThrowOnError extends boolean = false>(options: Options<WithdrawProductReviewData, ThrowOnError>) => RequestResult<WithdrawProductReviewResponses, WithdrawProductReviewErrors, ThrowOnError, "fields">;
|
|
10673
|
+
/**
|
|
10674
|
+
* resubmit your review at the saved revision
|
|
10675
|
+
*/
|
|
10676
|
+
declare const resubmitProductReview: <ThrowOnError extends boolean = false>(options: Options<ResubmitProductReviewData, ThrowOnError>) => RequestResult<ResubmitProductReviewResponses, ResubmitProductReviewErrors, ThrowOnError, "fields">;
|
|
9340
10677
|
|
|
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 };
|
|
10678
|
+
export { type AccountCancelSubscriptionData, type AccountCancelSubscriptionError, type AccountCancelSubscriptionErrors, type AccountCancelSubscriptionResponse, type AccountCancelSubscriptionResponses, type AccountCreatePortalSessionData, type AccountCreatePortalSessionError, type AccountCreatePortalSessionErrors, type AccountCreatePortalSessionResponse, type AccountCreatePortalSessionResponses, type AccountLoginData, type AccountLoginError, type AccountLoginErrors, type AccountLoginRequest, type AccountLoginResponse, type AccountLoginResponses, type AccountLoginResult, type AccountLogoutData, type AccountLogoutError, type AccountLogoutErrors, type AccountLogoutResponse, type AccountLogoutResponses, type AccountLogoutResult, type AccountManageCancelData, type AccountManageCancelError, type AccountManageCancelErrors, type AccountManageCancelResponse, type AccountManageCancelResponses, type AccountManageGetSubscriptionData, type AccountManageGetSubscriptionError, type AccountManageGetSubscriptionErrors, type AccountManageGetSubscriptionResponse, type AccountManageGetSubscriptionResponses, type AccountManagePortalSessionData, type AccountManagePortalSessionError, type AccountManagePortalSessionErrors, type AccountManagePortalSessionResponse, type AccountManagePortalSessionResponses, type AccountManageVerifyData, type AccountManageVerifyError, type AccountManageVerifyErrors, type AccountManageVerifyResponse, type AccountManageVerifyResponses, type AccountMeData, type AccountMeError, type AccountMeErrors, type AccountMeResponse, type AccountMeResponses, type AccountMeResult, type AccountReactivateSubscriptionData, type AccountReactivateSubscriptionError, type AccountReactivateSubscriptionErrors, type AccountReactivateSubscriptionResponse, type AccountReactivateSubscriptionResponses, type AccountSubscribeData, type AccountSubscribeError, type AccountSubscribeErrors, type AccountSubscribeRequest, type AccountSubscribeResponse, type AccountSubscribeResponses, type AccountUpdateSubscriptionAddressData, type AccountUpdateSubscriptionAddressError, type AccountUpdateSubscriptionAddressErrors, type AccountUpdateSubscriptionAddressResponse, type AccountUpdateSubscriptionAddressResponses, type AccountVerifyData, type AccountVerifyError, type AccountVerifyErrors, type AccountVerifyRequest, type AccountVerifyResponse, type AccountVerifyResponses, type AccountVerifyResult, type ActOnManageLinkData, type ActOnManageLinkError, type ActOnManageLinkErrors, type ActOnManageLinkResponse, type ActOnManageLinkResponses, type AdjustInventory, type AdjustVariantInventoryData, type AdjustVariantInventoryError, type AdjustVariantInventoryErrors, type AdjustVariantInventoryResponse, type AdjustVariantInventoryResponses, type AnalyticsBreakdown, type AnalyticsChannels, type AnalyticsRealtime, type AnalyticsStatus, type AnalyticsSummary, type AnalyticsTimeseries, type AttachProductFileData, type AttachProductFileError, type AttachProductFileErrors, type AttachProductFileFromUrl, type AttachProductFileMultipart, type AttachProductFileResponse, type AttachProductFileResponses, type Attachment, type BusinessSummary, type CancelRetainerData, type CancelRetainerError, type CancelRetainerErrors, type CancelRetainerResponse, type CancelRetainerResponses, type CancelSubscriptionData, type CancelSubscriptionErrors, type CancelSubscriptionResponse, type CancelSubscriptionResponses, type CartCheckoutRequest, type CartConflict, type CartConflictItem, type CartSummaryRequest, type CartSummaryResult, type ChangedField, type CheckoutPauseRequest, type CheckoutPauseState, type CheckoutRequest, type CheckoutResult, type Client, type ClientOptions$1 as ClientConfig, type ClientOptions, type Config, type ConsentConfig, type ConsentConfigResult, type ConsentPrefs, type CreateCartCheckoutData, type CreateCartCheckoutError, type CreateCartCheckoutErrors, type CreateCartCheckoutResponse, type CreateCartCheckoutResponses, type CreateCheckoutData, type CreateCheckoutError, type CreateCheckoutErrors, type CreateCheckoutResponse, type CreateCheckoutResponses, type CreateCustomer, type CreateCustomerData, type CreateCustomerError, type CreateCustomerErrors, type CreateCustomerResponse, type CreateCustomerResponses, type CreateEventDestination, type CreateEventDestinationData, type CreateEventDestinationError, type CreateEventDestinationErrors, type CreateEventDestinationResponse, type CreateEventDestinationResponses, type CreateEventDestinationWithSiteTokenData, type CreateEventDestinationWithSiteTokenError, type CreateEventDestinationWithSiteTokenErrors, type CreateEventDestinationWithSiteTokenResponse, type CreateEventDestinationWithSiteTokenResponses, type CreateForm, type CreateFormData, type CreateFormError, type CreateFormErrors, type CreateFormResponse, type CreateFormResponses, type CreateFormWithSiteTokenData, type CreateFormWithSiteTokenError, type CreateFormWithSiteTokenErrors, type CreateFormWithSiteTokenResponse, type CreateFormWithSiteTokenResponses, type CreateInvoice, type CreateInvoiceData, type CreateInvoiceError, type CreateInvoiceErrors, type CreateInvoiceLine, type CreateInvoiceResponse, type CreateInvoiceResponses, type CreateInvoiceResult, type CreateMultiItemTestOrder, type CreateMultiItemTestOrderData, type CreateMultiItemTestOrderError, type CreateMultiItemTestOrderErrors, type CreateMultiItemTestOrderResponse, type CreateMultiItemTestOrderResponses, type CreateOption, type CreateOptionData, type CreateOptionError, type CreateOptionErrors, type CreateOptionResponse, type CreateOptionResponses, type CreatePreviewSession, type CreatePreviewSessionData, type CreatePreviewSessionError, type CreatePreviewSessionErrors, type CreatePreviewSessionResponse, type CreatePreviewSessionResponses, type CreateProduct, type CreateProductData, type CreateProductError, type CreateProductErrors, type CreateProductResponse, type CreateProductResponses, type CreateProductReviewData, type CreateProductReviewError, type CreateProductReviewErrors, type CreateProductReviewResponse, type CreateProductReviewResponses, type CreateProductWithSiteTokenData, type CreateProductWithSiteTokenError, type CreateProductWithSiteTokenErrors, type CreateProductWithSiteTokenResponse, type CreateProductWithSiteTokenResponses, type CreateRetainer, type CreateRetainerData, type CreateRetainerError, type CreateRetainerErrors, type CreateRetainerResponse, type CreateRetainerResponses, type CreateRetainerResult, type CreateSite, type CreateSiteData, type CreateSiteError, type CreateSiteErrors, type CreateSiteResponse, type CreateSiteResponses, type CreateTestOrder, type CreateTestOrderData, type CreateTestOrderError, type CreateTestOrderErrors, type CreateTestOrderResponse, type CreateTestOrderResponses, type CreateTestSubscription, type CreateTestSubscriptionData, type CreateTestSubscriptionError, type CreateTestSubscriptionErrors, type CreateTestSubscriptionResponse, type CreateTestSubscriptionResponses, type CreateVariant, type CreateVariantData, type CreateVariantError, type CreateVariantErrors, type CreateVariantResponse, type CreateVariantResponses, type CurrencyRestatement, type CurrencyTotals, type Customer, type CustomerAddress, type CustomerBilling, type CustomerDetail, type CustomersList, type DeleteEventDestinationData, type DeleteEventDestinationError, type DeleteEventDestinationErrors, type DeleteEventDestinationResponse, type DeleteEventDestinationResponses, type DeleteEventDestinationWithSiteTokenData, type DeleteEventDestinationWithSiteTokenError, type DeleteEventDestinationWithSiteTokenErrors, type DeleteEventDestinationWithSiteTokenResponse, type DeleteEventDestinationWithSiteTokenResponses, type DeleteFormData, type DeleteFormError, type DeleteFormErrors, type DeleteFormResponse, type DeleteFormResponses, type DeleteOptionData, type DeleteOptionError, type DeleteOptionErrors, type DeleteOptionResponse, type DeleteOptionResponses, type DeleteProductData, type DeleteProductError, type DeleteProductErrors, type DeleteProductResponse, type DeleteProductResponses, type DeleteSiteData, type DeleteSiteError, type DeleteSiteErrors, type DeleteSiteResponse, type DeleteSiteResponses, type DeleteSubmissionData, type DeleteSubmissionError, type DeleteSubmissionErrors, type DeleteSubmissionResponse, type DeleteSubmissionResponses, type DeleteVariantData, type DeleteVariantError, type DeleteVariantErrors, type DeleteVariantResponse, type DeleteVariantResponses, type DownloadAttachmentData, type DownloadAttachmentError, type DownloadAttachmentErrors, type DownloadAttachmentResponses, type DownloadFileData, type DownloadFileError, type DownloadFileErrors, type DownloadFileResponse, type DownloadFileResponses, type EditProductReviewData, type EditProductReviewError, type EditProductReviewErrors, type EditProductReviewResponse, type EditProductReviewResponses, type EmailDelivery, type EraseCustomerReviewsData, type EraseCustomerReviewsError, type EraseCustomerReviewsErrors, type EraseCustomerReviewsResponse, type EraseCustomerReviewsResponses, type Error, type EventDeliveriesList, type EventDelivery, type EventDestination, type EventDestinationSecret, type EventDestinationsList, type Form, type FormsList, type GenerateVariants, type GenerateVariantsData, type GenerateVariantsError, type GenerateVariantsErrors, type GenerateVariantsResponse, type GenerateVariantsResponses, type GenerateVariantsResult, type GeoSuggestion, type GetAccountReviewsData, type GetAccountReviewsError, type GetAccountReviewsErrors, type GetAccountReviewsResponse, type GetAccountReviewsResponses, type GetAnalyticsBrowsersData, type GetAnalyticsBrowsersErrors, type GetAnalyticsBrowsersResponse, type GetAnalyticsBrowsersResponses, type GetAnalyticsCampaignsData, type GetAnalyticsCampaignsErrors, type GetAnalyticsCampaignsResponse, type GetAnalyticsCampaignsResponses, type GetAnalyticsChannelsData, type GetAnalyticsChannelsErrors, type GetAnalyticsChannelsResponse, type GetAnalyticsChannelsResponses, type GetAnalyticsCitiesData, type GetAnalyticsCitiesErrors, type GetAnalyticsCitiesResponse, type GetAnalyticsCitiesResponses, type GetAnalyticsCountriesData, type GetAnalyticsCountriesErrors, type GetAnalyticsCountriesResponse, type GetAnalyticsCountriesResponses, type GetAnalyticsDevicesData, type GetAnalyticsDevicesErrors, type GetAnalyticsDevicesResponse, type GetAnalyticsDevicesResponses, type GetAnalyticsEntryPagesData, type GetAnalyticsEntryPagesErrors, type GetAnalyticsEntryPagesResponse, type GetAnalyticsEntryPagesResponses, type GetAnalyticsExitPagesData, type GetAnalyticsExitPagesErrors, type GetAnalyticsExitPagesResponse, type GetAnalyticsExitPagesResponses, type GetAnalyticsOperatingSystemsData, type GetAnalyticsOperatingSystemsErrors, type GetAnalyticsOperatingSystemsResponse, type GetAnalyticsOperatingSystemsResponses, type GetAnalyticsPagesData, type GetAnalyticsPagesErrors, type GetAnalyticsPagesResponse, type GetAnalyticsPagesResponses, type GetAnalyticsRealtimeData, type GetAnalyticsRealtimeErrors, type GetAnalyticsRealtimeResponse, type GetAnalyticsRealtimeResponses, type GetAnalyticsRegionsData, type GetAnalyticsRegionsErrors, type GetAnalyticsRegionsResponse, type GetAnalyticsRegionsResponses, type GetAnalyticsSourcesData, type GetAnalyticsSourcesErrors, type GetAnalyticsSourcesResponse, type GetAnalyticsSourcesResponses, type GetAnalyticsStatusData, type GetAnalyticsStatusErrors, type GetAnalyticsStatusResponse, type GetAnalyticsStatusResponses, type GetAnalyticsSummaryData, type GetAnalyticsSummaryErrors, type GetAnalyticsSummaryResponse, type GetAnalyticsSummaryResponses, type GetAnalyticsTimeseriesData, type GetAnalyticsTimeseriesErrors, type GetAnalyticsTimeseriesResponse, type GetAnalyticsTimeseriesResponses, type GetAnalyticsUtmCampaignData, type GetAnalyticsUtmCampaignErrors, type GetAnalyticsUtmCampaignResponse, type GetAnalyticsUtmCampaignResponses, type GetAnalyticsUtmContentData, type GetAnalyticsUtmContentErrors, type GetAnalyticsUtmContentResponse, type GetAnalyticsUtmContentResponses, type GetAnalyticsUtmMediumData, type GetAnalyticsUtmMediumErrors, type GetAnalyticsUtmMediumResponse, type GetAnalyticsUtmMediumResponses, type GetAnalyticsUtmSourceData, type GetAnalyticsUtmSourceErrors, type GetAnalyticsUtmSourceResponse, type GetAnalyticsUtmSourceResponses, type GetAnalyticsUtmTermData, type GetAnalyticsUtmTermErrors, type GetAnalyticsUtmTermResponse, type GetAnalyticsUtmTermResponses, type GetBusinessSummaryData, type GetBusinessSummaryErrors, type GetBusinessSummaryResponse, type GetBusinessSummaryResponses, type GetCartSummaryData, type GetCartSummaryError, type GetCartSummaryErrors, type GetCartSummaryResponse, type GetCartSummaryResponses, type GetConsentConfigWithSiteTokenData, type GetConsentConfigWithSiteTokenError, type GetConsentConfigWithSiteTokenErrors, type GetConsentConfigWithSiteTokenResponse, type GetConsentConfigWithSiteTokenResponses, type GetCustomerData, type GetCustomerError, type GetCustomerErrors, type GetCustomerResponse, type GetCustomerResponses, type GetEventDestinationData, type GetEventDestinationError, type GetEventDestinationErrors, type GetEventDestinationResponse, type GetEventDestinationResponses, type GetEventDestinationSecretData, type GetEventDestinationSecretError, type GetEventDestinationSecretErrors, type GetEventDestinationSecretResponse, type GetEventDestinationSecretResponses, type GetEventDestinationSecretWithSiteTokenData, type GetEventDestinationSecretWithSiteTokenError, type GetEventDestinationSecretWithSiteTokenErrors, type GetEventDestinationSecretWithSiteTokenResponse, type GetEventDestinationSecretWithSiteTokenResponses, type GetFormData, type GetFormError, type GetFormErrors, type GetFormResponse, type GetFormResponses, type GetGeoData, type GetGeoError, type GetGeoErrors, type GetGeoResponse, type GetGeoResponses, type GetInvoiceData, type GetInvoiceError, type GetInvoiceErrors, type GetInvoicePreviewData, type GetInvoicePreviewError, type GetInvoicePreviewErrors, type GetInvoicePreviewResponse, type GetInvoicePreviewResponses, type GetInvoiceResponse, type GetInvoiceResponses, type GetInvoiceSettingsData, type GetInvoiceSettingsError, type GetInvoiceSettingsErrors, type GetInvoiceSettingsResponse, type GetInvoiceSettingsResponses, type GetInvoiceSettingsWithSiteTokenData, type GetInvoiceSettingsWithSiteTokenError, type GetInvoiceSettingsWithSiteTokenErrors, type GetInvoiceSettingsWithSiteTokenResponse, type GetInvoiceSettingsWithSiteTokenResponses, type GetMerchantReviewData, type GetMerchantReviewError, type GetMerchantReviewErrors, type GetMerchantReviewResponse, type GetMerchantReviewResponses, type GetNextPayoutData, type GetNextPayoutErrors, type GetNextPayoutResponse, type GetNextPayoutResponses, type GetOrderData, type GetOrderError, type GetOrderErrors, type GetOrderResponse, type GetOrderResponses, type GetOrderSessionData, type GetOrderSessionError, type GetOrderSessionErrors, type GetOrderSessionResponse, type GetOrderSessionResponses, type GetOwnProductReviewData, type GetOwnProductReviewError, type GetOwnProductReviewErrors, type GetOwnProductReviewResponse, type GetOwnProductReviewResponses, type GetPaymentsStatusData, type GetPaymentsStatusError, type GetPaymentsStatusErrors, type GetPaymentsStatusResponse, type GetPaymentsStatusResponses, type GetPersonData, type GetPersonErrors, type GetPersonResponse, type GetPersonResponses, type GetProductData, type GetProductError, type GetProductErrors, type GetProductResponse, type GetProductResponses, type GetProductReviewAvailabilityData, type GetProductReviewAvailabilityError, type GetProductReviewAvailabilityErrors, type GetProductReviewAvailabilityResponse, type GetProductReviewAvailabilityResponses, type GetProductReviewsData, type GetProductReviewsError, type GetProductReviewsErrors, type GetProductReviewsResponse, type GetProductReviewsResponses, type GetPublicConsentPrefsData, type GetPublicConsentPrefsError, type GetPublicConsentPrefsErrors, type GetPublicConsentPrefsResponse, type GetPublicConsentPrefsResponses, type GetPublicProductData, type GetPublicProductError, type GetPublicProductErrors, type GetPublicProductResponse, type GetPublicProductResponses, type GetRetainerData, type GetRetainerError, type GetRetainerErrors, type GetRetainerResponse, type GetRetainerResponses, type GetReviewSettingsData, type GetReviewSettingsError, type GetReviewSettingsErrors, type GetReviewSettingsResponse, type GetReviewSettingsResponses, type GetSalesSummaryData, type GetSalesSummaryErrors, type GetSalesSummaryResponse, type GetSalesSummaryResponses, type GetSiteAnalyticsData, type GetSiteAnalyticsError, type GetSiteAnalyticsErrors, type GetSiteAnalyticsResponse, type GetSiteAnalyticsResponses, type GetSiteCheckoutPauseData, type GetSiteCheckoutPauseError, type GetSiteCheckoutPauseErrors, type GetSiteCheckoutPauseResponse, type GetSiteCheckoutPauseResponses, type GetSiteData, type GetSiteError, type GetSiteErrors, type GetSiteResponse, type GetSiteResponses, type GetSubmissionData, type GetSubmissionError, type GetSubmissionErrors, type GetSubmissionResponse, type GetSubmissionResponses, type Inventory, type InventoryInput, type Invoice, type InvoiceAggregates, type InvoiceBillTo, type InvoiceError, type InvoiceLineItem, type InvoicePreview, type InvoiceSettings, type InvoiceSiteBody, type InvoicesList, type ListCustomersData, type ListCustomersError, type ListCustomersErrors, type ListCustomersResponse, type ListCustomersResponses, type ListEventDeliveriesData, type ListEventDeliveriesError, type ListEventDeliveriesErrors, type ListEventDeliveriesResponse, type ListEventDeliveriesResponses, type ListEventDeliveriesWithSiteTokenData, type ListEventDeliveriesWithSiteTokenError, type ListEventDeliveriesWithSiteTokenErrors, type ListEventDeliveriesWithSiteTokenResponse, type ListEventDeliveriesWithSiteTokenResponses, type ListEventDestinationsData, type ListEventDestinationsError, type ListEventDestinationsErrors, type ListEventDestinationsResponse, type ListEventDestinationsResponses, type ListEventDestinationsWithSiteTokenData, type ListEventDestinationsWithSiteTokenError, type ListEventDestinationsWithSiteTokenErrors, type ListEventDestinationsWithSiteTokenResponse, type ListEventDestinationsWithSiteTokenResponses, type ListFormsData, type ListFormsError, type ListFormsErrors, type ListFormsResponse, type ListFormsResponses, type ListFormsWithSiteTokenData, type ListFormsWithSiteTokenError, type ListFormsWithSiteTokenErrors, type ListFormsWithSiteTokenResponse, type ListFormsWithSiteTokenResponses, type ListInvoicesData, type ListInvoicesError, type ListInvoicesErrors, type ListInvoicesResponse, type ListInvoicesResponses, type ListMerchantReviewsData, type ListMerchantReviewsError, type ListMerchantReviewsErrors, type ListMerchantReviewsResponse, type ListMerchantReviewsResponses, type ListOrdersWithSiteTokenData, type ListOrdersWithSiteTokenError, type ListOrdersWithSiteTokenErrors, type ListOrdersWithSiteTokenResponse, type ListOrdersWithSiteTokenResponses, type ListPeopleData, type ListPeopleErrors, type ListPeopleResponse, type ListPeopleResponses, type ListProductsData, type ListProductsError, type ListProductsErrors, type ListProductsResponse, type ListProductsResponses, type ListProductsWithSiteTokenData, type ListProductsWithSiteTokenError, type ListProductsWithSiteTokenErrors, type ListProductsWithSiteTokenResponse, type ListProductsWithSiteTokenResponses, type ListRetainersData, type ListRetainersError, type ListRetainersErrors, type ListRetainersResponse, type ListRetainersResponses, type ListSitesData, type ListSitesError, type ListSitesErrors, type ListSitesResponse, type ListSitesResponses, type ListSubmissionsData, type ListSubmissionsError, type ListSubmissionsErrors, type ListSubmissionsResponse, type ListSubmissionsResponses, type ListSubscriptionsData, type ListSubscriptionsErrors, type ListSubscriptionsResponse, type ListSubscriptionsResponses, type ManageCancelResult, type ManageLinkAction, type ManageVerifyRequest, type ManageVerifyResult, type ManagedSubscription, type ManagedSubscriptionResult, type MarkInvoicePaid, type MarkInvoicePaidData, type MarkInvoicePaidError, type MarkInvoicePaidErrors, type MarkInvoicePaidResponse, type MarkInvoicePaidResponses, type MarkInvoicePaidResult, type MarkInvoiceUncollectibleData, type MarkInvoiceUncollectibleError, type MarkInvoiceUncollectibleErrors, type MarkInvoiceUncollectibleResponse, type MarkInvoiceUncollectibleResponses, type ModerateMerchantReviewData, type ModerateMerchantReviewError, type ModerateMerchantReviewErrors, type ModerateMerchantReviewResponse, type ModerateMerchantReviewResponses, type NeedsAttentionItem, type NestedOptionInput, type NestedVariantInput, type NextPayout, type Option, type Options, type Order, type OrderCustomer, type OrderFulfillmentRequest, type OrderSessionStatus, type OrdersList, type OwnProductReview, type PauseRetainerData, type PauseRetainerError, type PauseRetainerErrors, type PauseRetainerResponse, type PauseRetainerResponses, type PauseSiteCheckoutData, type PauseSiteCheckoutError, type PauseSiteCheckoutErrors, type PauseSiteCheckoutResponse, type PauseSiteCheckoutResponses, type PaymentsStatus, type PeopleList, type PersonDetail, type PersonRow, type PortalSessionResult, type PreviewInvoice, type PreviewInvoiceData, type PreviewInvoiceError, type PreviewInvoiceErrors, type PreviewInvoiceResponse, type PreviewInvoiceResponses, type PreviewSessionResult, type Product, type ProductDetail, type ProductFulfillment, type ProductFulfillmentInput, type ProductReview, type ProductSubscriptionConfig, type ProductsList, type PublicOption, type PublicProduct, type PublicSubscription, type PublicSubscriptionPlan, type PublicVariant, type PurgeSiteReviewsData, type PurgeSiteReviewsError, type PurgeSiteReviewsErrors, type PurgeSiteReviewsResponse, type PurgeSiteReviewsResponses, type ReactivateSiteSubscriptionsTeardownData, type ReactivateSiteSubscriptionsTeardownError, type ReactivateSiteSubscriptionsTeardownErrors, type ReactivateSiteSubscriptionsTeardownResponse, type ReactivateSiteSubscriptionsTeardownResponses, type RecipientCooldownError, type ReconcileOptionInput, type ReconcileOptionValueInput, type ReconcileVariantInput, type RefundOrder, type RefundOrderData, type RefundOrderError, type RefundOrderErrors, type RefundOrderResponse, type RefundOrderResponses, type RefundResult, type ReissueResult, type RemindInvoiceData, type RemindInvoiceError, type RemindInvoiceErrors, type RemindInvoiceResponse, type RemindInvoiceResponses, type RemindInvoiceResult, type ReplyToMerchantReviewData, type ReplyToMerchantReviewError, type ReplyToMerchantReviewErrors, type ReplyToMerchantReviewResponse, type ReplyToMerchantReviewResponses, type ResendInvoiceData, type ResendInvoiceError, type ResendInvoiceErrors, type ResendInvoiceResponse, type ResendInvoiceResponses, type ResendOrderReceiptData, type ResendOrderReceiptError, type ResendOrderReceiptErrors, type ResendOrderReceiptResponse, type ResendOrderReceiptResponses, type ResendReceiptResult, type ResetOrderDownloadsData, type ResetOrderDownloadsError, type ResetOrderDownloadsErrors, type ResetOrderDownloadsResponse, type ResetOrderDownloadsResponses, type ResetWebhookEventData, type ResetWebhookEventError, type ResetWebhookEventErrors, type ResetWebhookEventResponse, type ResetWebhookEventResponses, type ResolveManageLinkData, type ResolveManageLinkError, type ResolveManageLinkErrors, type ResolveManageLinkResponse, type ResolveManageLinkResponses, type ResubmitProductReviewData, type ResubmitProductReviewError, type ResubmitProductReviewErrors, type ResubmitProductReviewResponse, type ResubmitProductReviewResponses, type ResumeRetainerData, type ResumeRetainerError, type ResumeRetainerErrors, type ResumeRetainerResponse, type ResumeRetainerResponses, type Retainer, type RetainerError, type RetainerSiteBody, type RetainersList, type RetryEventDeliveryData, type RetryEventDeliveryError, type RetryEventDeliveryErrors, type RetryEventDeliveryResponse, type RetryEventDeliveryResponses, type RetryEventDeliveryWithSiteTokenData, type RetryEventDeliveryWithSiteTokenError, type RetryEventDeliveryWithSiteTokenErrors, type RetryEventDeliveryWithSiteTokenResponse, type RetryEventDeliveryWithSiteTokenResponses, type ReviewReadiness, type RevokeCustomerAccessData, type RevokeCustomerAccessError, type RevokeCustomerAccessErrors, type RevokeCustomerAccessResponse, type RevokeCustomerAccessResponses, type RevokeCustomerAccessResult, type RotateEventDestinationSecretData, type RotateEventDestinationSecretError, type RotateEventDestinationSecretErrors, type RotateEventDestinationSecretResponse, type RotateEventDestinationSecretResponses, type RotateEventDestinationSecretWithSiteTokenData, type RotateEventDestinationSecretWithSiteTokenError, type RotateEventDestinationSecretWithSiteTokenErrors, type RotateEventDestinationSecretWithSiteTokenResponse, type RotateEventDestinationSecretWithSiteTokenResponses, type SalesSummary, type SalesSummaryProductRow, type SalesSummarySeriesEntry, type SetInventory, type SetInvoiceReminders, type SetInvoiceRemindersData, type SetInvoiceRemindersError, type SetInvoiceRemindersErrors, type SetInvoiceRemindersResponse, type SetInvoiceRemindersResponses, type SetOrderFulfillmentData, type SetOrderFulfillmentErrors, type SetOrderFulfillmentResponse, type SetOrderFulfillmentResponses, type SetProductSubscription, type SetProductSubscriptionData, type SetProductSubscriptionError, type SetProductSubscriptionErrors, type SetProductSubscriptionResponse, type SetProductSubscriptionResponses, type SetProductVariants, type SetProductVariantsConflict, type SetProductVariantsData, type SetProductVariantsError, type SetProductVariantsErrors, type SetProductVariantsResponse, type SetProductVariantsResponses, type SetProductVariantsResult, type SetVariantInventoryData, type SetVariantInventoryError, type SetVariantInventoryErrors, type SetVariantInventoryResponse, type SetVariantInventoryResponses, type SettledTotals, type ShippingOptionUnavailable, type ShippingRateInput, type Site, type SiteAccountRoute, type SiteAnalytics, type SiteDomains, type SitePayments, type SiteWithRestatement, type SiteWithToken, type SitesList, type SkipNextRetainerCycleData, type SkipNextRetainerCycleError, type SkipNextRetainerCycleErrors, type SkipNextRetainerCycleResponse, type SkipNextRetainerCycleResponses, type SnoozeInvoice, type SnoozeInvoiceData, type SnoozeInvoiceError, type SnoozeInvoiceErrors, type SnoozeInvoiceResponse, type SnoozeInvoiceResponses, type Submission, type SubmissionMetadata, type SubmissionsList, type SubscriberActionResult, type SubscriberSubscription, type SubscriptionPlan, type SubscriptionPlanInput, type SubscriptionSummary, type SubscriptionsList, type SubscriptionsReactivateBody, type SubscriptionsReactivateResult, type SubscriptionsTeardownBody, type SubscriptionsTeardownResult, type SummaryPeriod, type TeardownReason, type TeardownSiteSubscriptionsData, type TeardownSiteSubscriptionsError, type TeardownSiteSubscriptionsErrors, type TeardownSiteSubscriptionsResponse, type TeardownSiteSubscriptionsResponses, type TestOrderResult, type TestShippingAddress, type TestSubscriptionResult, type UpdateCustomer, type UpdateCustomerBilling, type UpdateCustomerBillingData, type UpdateCustomerBillingError, type UpdateCustomerBillingErrors, type UpdateCustomerBillingResponse, type UpdateCustomerBillingResponses, type UpdateCustomerData, type UpdateCustomerError, type UpdateCustomerErrors, type UpdateCustomerResponse, type UpdateCustomerResponses, type UpdateEventDestination, type UpdateEventDestinationData, type UpdateEventDestinationError, type UpdateEventDestinationErrors, type UpdateEventDestinationResponse, type UpdateEventDestinationResponses, type UpdateEventDestinationWithSiteTokenData, type UpdateEventDestinationWithSiteTokenError, type UpdateEventDestinationWithSiteTokenErrors, type UpdateEventDestinationWithSiteTokenResponse, type UpdateEventDestinationWithSiteTokenResponses, type UpdateForm, type UpdateFormData, type UpdateFormError, type UpdateFormErrors, type UpdateFormResponse, type UpdateFormResponses, type UpdateInvoiceRecipient, type UpdateInvoiceRecipientData, type UpdateInvoiceRecipientError, type UpdateInvoiceRecipientErrors, type UpdateInvoiceRecipientResponse, type UpdateInvoiceRecipientResponses, type UpdateInvoiceSettings, type UpdateInvoiceSettingsData, type UpdateInvoiceSettingsError, type UpdateInvoiceSettingsErrors, type UpdateInvoiceSettingsResponse, type UpdateInvoiceSettingsResponses, type UpdateOption, type UpdateOptionData, type UpdateOptionError, type UpdateOptionErrors, type UpdateOptionResponse, type UpdateOptionResponses, type UpdateProduct, type UpdateProductData, type UpdateProductError, type UpdateProductErrors, type UpdateProductResponse, type UpdateProductResponses, type UpdateRecipientResult, type UpdateRetainer, type UpdateRetainerData, type UpdateRetainerError, type UpdateRetainerErrors, type UpdateRetainerResponse, type UpdateRetainerResponses, type UpdateReviewSettingsData, type UpdateReviewSettingsError, type UpdateReviewSettingsErrors, type UpdateReviewSettingsResponse, type UpdateReviewSettingsResponses, type UpdateSite, type UpdateSiteAccountRoute, type UpdateSiteAccountRouteData, type UpdateSiteAccountRouteError, type UpdateSiteAccountRouteErrors, type UpdateSiteAccountRouteResponse, type UpdateSiteAccountRouteResponses, type UpdateSiteAnalytics, type UpdateSiteAnalyticsData, type UpdateSiteAnalyticsError, type UpdateSiteAnalyticsErrors, type UpdateSiteAnalyticsResponse, type UpdateSiteAnalyticsResponses, type UpdateSiteData, type UpdateSiteDomains, type UpdateSiteDomainsData, type UpdateSiteDomainsError, type UpdateSiteDomainsErrors, type UpdateSiteDomainsResponse, type UpdateSiteDomainsResponses, type UpdateSiteError, type UpdateSiteErrors, type UpdateSiteInvoicing, type UpdateSiteInvoicingData, type UpdateSiteInvoicingError, type UpdateSiteInvoicingErrors, type UpdateSiteInvoicingResponse, type UpdateSiteInvoicingResponses, type UpdateSitePayments, type UpdateSitePaymentsData, type UpdateSitePaymentsError, type UpdateSitePaymentsErrors, type UpdateSitePaymentsResponse, type UpdateSitePaymentsResponses, type UpdateSiteResponse, type UpdateSiteResponses, type UpdateSubscriptionAddressRequest, type UpdateVariant, type UpdateVariantData, type UpdateVariantError, type UpdateVariantErrors, type UpdateVariantResponse, type UpdateVariantResponses, type UpsertConsentConfig, type UpsertConsentConfigWithSiteTokenData, type UpsertConsentConfigWithSiteTokenError, type UpsertConsentConfigWithSiteTokenErrors, type UpsertConsentConfigWithSiteTokenResponse, type UpsertConsentConfigWithSiteTokenResponses, type Variant, type VariantOptionValue, type VoidInvoice, type VoidInvoiceData, type VoidInvoiceError, type VoidInvoiceErrors, type VoidInvoiceResponse, type VoidInvoiceResponses, type VoidInvoiceResult, type WebhookEventResetResult, type WithdrawProductReviewData, type WithdrawProductReviewError, type WithdrawProductReviewErrors, type WithdrawProductReviewResponse, type WithdrawProductReviewResponses, accountCancelSubscription, accountCreatePortalSession, accountLogin, accountLogout, accountManageCancel, accountManageGetSubscription, accountManagePortalSession, accountManageVerify, accountMe, accountReactivateSubscription, accountSubscribe, accountUpdateSubscriptionAddress, accountVerify, actOnManageLink, adjustVariantInventory, attachProductFile, cancelRetainer, cancelSubscription, createCartCheckout, createCheckout, createClient, createConfig, createCustomer, createEventDestination, createEventDestinationWithSiteToken, createForm, createFormWithSiteToken, createInvoice, createMultiItemTestOrder, createOption, createPreviewSession, createProduct, createProductReview, createProductWithSiteToken, createRetainer, createSite, createTestOrder, createTestSubscription, createVariant, deleteEventDestination, deleteEventDestinationWithSiteToken, deleteForm, deleteOption, deleteProduct, deleteSite, deleteSubmission, deleteVariant, downloadAttachment, downloadFile, editProductReview, eraseCustomerReviews, generateVariants, getAccountReviews, getAnalyticsBrowsers, getAnalyticsCampaigns, getAnalyticsChannels, getAnalyticsCities, getAnalyticsCountries, getAnalyticsDevices, getAnalyticsEntryPages, getAnalyticsExitPages, getAnalyticsOperatingSystems, getAnalyticsPages, getAnalyticsRealtime, getAnalyticsRegions, getAnalyticsSources, getAnalyticsStatus, getAnalyticsSummary, getAnalyticsTimeseries, getAnalyticsUtmCampaign, getAnalyticsUtmContent, getAnalyticsUtmMedium, getAnalyticsUtmSource, getAnalyticsUtmTerm, getBusinessSummary, getCartSummary, getConsentConfigWithSiteToken, getCustomer, getEventDestination, getEventDestinationSecret, getEventDestinationSecretWithSiteToken, getForm, getGeo, getInvoice, getInvoicePreview, getInvoiceSettings, getInvoiceSettingsWithSiteToken, getMerchantReview, getNextPayout, getOrder, getOrderSession, getOwnProductReview, getPaymentsStatus, getPerson, getProduct, getProductReviewAvailability, getProductReviews, getPublicConsentPrefs, getPublicProduct, getRetainer, getReviewSettings, getSalesSummary, getSite, getSiteAnalytics, getSiteCheckoutPause, getSubmission, listCustomers, listEventDeliveries, listEventDeliveriesWithSiteToken, listEventDestinations, listEventDestinationsWithSiteToken, listForms, listFormsWithSiteToken, listInvoices, listMerchantReviews, listOrdersWithSiteToken, listPeople, listProducts, listProductsWithSiteToken, listRetainers, listSites, listSubmissions, listSubscriptions, markInvoicePaid, markInvoiceUncollectible, moderateMerchantReview, pauseRetainer, pauseSiteCheckout, previewInvoice, purgeSiteReviews, reactivateSiteSubscriptionsTeardown, refundOrder, remindInvoice, replyToMerchantReview, resendInvoice, resendOrderReceipt, resetOrderDownloads, resetWebhookEvent, resolveManageLink, resubmitProductReview, resumeRetainer, retryEventDelivery, retryEventDeliveryWithSiteToken, revokeCustomerAccess, rotateEventDestinationSecret, rotateEventDestinationSecretWithSiteToken, setInvoiceReminders, setOrderFulfillment, setProductSubscription, setProductVariants, setVariantInventory, skipNextRetainerCycle, snoozeInvoice, teardownSiteSubscriptions, updateCustomer, updateCustomerBilling, updateEventDestination, updateEventDestinationWithSiteToken, updateForm, updateInvoiceRecipient, updateInvoiceSettings, updateOption, updateProduct, updateRetainer, updateReviewSettings, updateSite, updateSiteAccountRoute, updateSiteAnalytics, updateSiteDomains, updateSiteInvoicing, updateSitePayments, updateVariant, upsertConsentConfigWithSiteToken, voidInvoice, withdrawProductReview };
|