@aifeatures/backend 0.10.0 → 0.12.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.d.ts CHANGED
@@ -1079,6 +1079,23 @@ type Order = {
1079
1079
  status: "pending" | "paid" | "failed" | "expired" | "refunded" | "partially_refunded" | "disputed" | "voided";
1080
1080
  stripe_checkout_session_id: string | null;
1081
1081
  stripe_payment_intent_id: string | null;
1082
+ amount_subtotal: number | null;
1083
+ discount_total: number;
1084
+ exclusive_tax_total: number | null;
1085
+ subscription_history_only: boolean;
1086
+ /**
1087
+ * Cash collected after account credit; null for historical orders without a cash snapshot.
1088
+ */
1089
+ amount_paid: number | null;
1090
+ /**
1091
+ * Account credit applied to the total; separate from promotion discounts.
1092
+ */
1093
+ credit_applied: number | null;
1094
+ application_fee_original: number | null;
1095
+ application_fee_returned: number | null;
1096
+ application_fee_retained: number | null;
1097
+ application_fee_currency: string | null;
1098
+ application_fee_state: "pending" | "complete" | "manual_attention" | null;
1082
1099
  /**
1083
1100
  * GOODS ONLY, in minor units — the sum of the line values, with postage EXCLUDED (the platform fee base is pinned to this figure). What the buyer's card was actually charged is amount_total + (shipping_total ?? 0); reconcile against a Stripe payout with that sum, never with this field alone. base_amount_total mirrors this one, so it is goods-only too.
1084
1101
  */
@@ -1329,6 +1346,12 @@ type SettledTotals = {
1329
1346
  * GROSS platform fees (refunds return application fees too; nothing is netted). Sums only orders charged in the settlement currency — a localized order's platform fee has no known settlement-side value.
1330
1347
  */
1331
1348
  application_fees: number;
1349
+ application_fees_returned: number | null;
1350
+ application_fees_retained: number | null;
1351
+ /**
1352
+ * False when fee observations are missing, pending repair, or cannot be expressed in the reported settlement currency. Independent of settlement completeness.
1353
+ */
1354
+ application_fees_complete: boolean;
1332
1355
  currency: string;
1333
1356
  complete: boolean;
1334
1357
  };
@@ -1456,7 +1479,15 @@ type SalesSummary = {
1456
1479
  aov: number;
1457
1480
  application_fees_gross: number;
1458
1481
  /**
1459
- * False when any in-range order in this currency lacks the fee snapshot — the fee figure then under-counts and consumers omit the line rather than guess.
1482
+ * Observed fee returns, or null when legacy returns are unknown or reconciliation is incomplete.
1483
+ */
1484
+ application_fees_returned: number | null;
1485
+ /**
1486
+ * Observed fees still retained, or null when legacy returns are unknown or reconciliation is incomplete.
1487
+ */
1488
+ application_fees_retained: number | null;
1489
+ /**
1490
+ * False when any in-range order lacks an actual fee snapshot, has pending fee repair, or has a mismatched fee currency. Legacy return history may remain unknown even when gross fees are complete.
1460
1491
  */
1461
1492
  application_fees_complete: boolean;
1462
1493
  }>;
@@ -3223,6 +3254,9 @@ type OrderSessionStatus = {
3223
3254
  * True for a simulated owner-initiated test purchase (no money moved).
3224
3255
  */
3225
3256
  is_test: boolean;
3257
+ amount_subtotal: number | null;
3258
+ discount_total: number;
3259
+ exclusive_tax_total: number | null;
3226
3260
  /**
3227
3261
  * What the buyer was CHARGED, in minor units of `currency` — goods plus postage (`shipping_total`) plus exclusive automatic tax (`tax_total` when Stripe Tax priced it on top; Unit T2), the number on their card statement. Deliberately NOT the same decomposition as the management API's Order.amount_total, which is line values only because the platform fee is pinned to it: this is the buyer's receipt surface, and a confirmation page that showed line values alone would disagree with the statement on every shipped order. Do NOT add shipping_total or tax_total to this — they are already inside.
3228
3262
  */
@@ -3249,8 +3283,15 @@ type OrderSessionStatus = {
3249
3283
  */
3250
3284
  name: string;
3251
3285
  quantity: number;
3286
+ amount_subtotal?: number;
3287
+ amount_discount?: number;
3288
+ amount_net?: number;
3289
+ amount_tax?: number;
3290
+ amount_total?: number;
3291
+ exclusive_tax?: number;
3292
+ unavailable_reason?: "oversold";
3252
3293
  /**
3253
- * What ONE unit cost, in minor units of `currency`, snapshotted at checkout — multiply by `quantity` for the line total. Absent on rows written before the field existed. It is a LINE figure: the per-line values need not sum to `amount_total`, which also carries postage, exclusive tax, and any promotion-code discount — render `amount_total` as the total paid rather than adding lines up.
3294
+ * Original price of ONE unit in minor units of `currency`, before discounts. Use finalized `amount_net` for the discounted line value, including when it is zero; use `unit_amount * quantity` only as a legacy fallback when `amount_net` is absent. Absent on rows written before the field existed. It is a LINE figure: the per-line values need not sum to `amount_total`, which also carries postage, exclusive tax, and any promotion-code discount — render `amount_total` as the total paid rather than adding lines up.
3254
3295
  */
3255
3296
  unit_amount?: number;
3256
3297
  /**
@@ -4900,6 +4941,14 @@ type GetAnalyticsSummaryData = {
4900
4941
  * 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.
4901
4942
  */
4902
4943
  period?: "7" | "30" | "90";
4944
+ /**
4945
+ * 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.
4946
+ */
4947
+ from?: string;
4948
+ /**
4949
+ * 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.
4950
+ */
4951
+ to?: string;
4903
4952
  /**
4904
4953
  * 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.
4905
4954
  */
@@ -4936,6 +4985,14 @@ type GetAnalyticsTimeseriesData = {
4936
4985
  * 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.
4937
4986
  */
4938
4987
  period?: "7" | "30" | "90";
4988
+ /**
4989
+ * 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.
4990
+ */
4991
+ from?: string;
4992
+ /**
4993
+ * 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.
4994
+ */
4995
+ to?: string;
4939
4996
  /**
4940
4997
  * 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.
4941
4998
  */
@@ -4994,8 +5051,20 @@ type GetAnalyticsSourcesData = {
4994
5051
  query?: {
4995
5052
  site_id?: string;
4996
5053
  period?: "7" | "30" | "90";
5054
+ /**
5055
+ * 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.
5056
+ */
5057
+ from?: string;
5058
+ /**
5059
+ * 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.
5060
+ */
5061
+ to?: string;
4997
5062
  limit?: string;
4998
5063
  filters?: string;
5064
+ /**
5065
+ * 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.
5066
+ */
5067
+ dimension2?: string;
4999
5068
  };
5000
5069
  url: "/api/v1/analytics/sources";
5001
5070
  };
@@ -5022,8 +5091,20 @@ type GetAnalyticsCampaignsData = {
5022
5091
  query?: {
5023
5092
  site_id?: string;
5024
5093
  period?: "7" | "30" | "90";
5094
+ /**
5095
+ * 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.
5096
+ */
5097
+ from?: string;
5098
+ /**
5099
+ * 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.
5100
+ */
5101
+ to?: string;
5025
5102
  limit?: string;
5026
5103
  filters?: string;
5104
+ /**
5105
+ * 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.
5106
+ */
5107
+ dimension2?: string;
5027
5108
  };
5028
5109
  url: "/api/v1/analytics/campaigns";
5029
5110
  };
@@ -5050,8 +5131,20 @@ type GetAnalyticsUtmMediumData = {
5050
5131
  query?: {
5051
5132
  site_id?: string;
5052
5133
  period?: "7" | "30" | "90";
5134
+ /**
5135
+ * 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.
5136
+ */
5137
+ from?: string;
5138
+ /**
5139
+ * 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.
5140
+ */
5141
+ to?: string;
5053
5142
  limit?: string;
5054
5143
  filters?: string;
5144
+ /**
5145
+ * 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.
5146
+ */
5147
+ dimension2?: string;
5055
5148
  };
5056
5149
  url: "/api/v1/analytics/utm/medium";
5057
5150
  };
@@ -5078,8 +5171,20 @@ type GetAnalyticsUtmSourceData = {
5078
5171
  query?: {
5079
5172
  site_id?: string;
5080
5173
  period?: "7" | "30" | "90";
5174
+ /**
5175
+ * 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.
5176
+ */
5177
+ from?: string;
5178
+ /**
5179
+ * 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.
5180
+ */
5181
+ to?: string;
5081
5182
  limit?: string;
5082
5183
  filters?: string;
5184
+ /**
5185
+ * 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.
5186
+ */
5187
+ dimension2?: string;
5083
5188
  };
5084
5189
  url: "/api/v1/analytics/utm/source";
5085
5190
  };
@@ -5106,8 +5211,20 @@ type GetAnalyticsUtmCampaignData = {
5106
5211
  query?: {
5107
5212
  site_id?: string;
5108
5213
  period?: "7" | "30" | "90";
5214
+ /**
5215
+ * 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.
5216
+ */
5217
+ from?: string;
5218
+ /**
5219
+ * 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.
5220
+ */
5221
+ to?: string;
5109
5222
  limit?: string;
5110
5223
  filters?: string;
5224
+ /**
5225
+ * 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.
5226
+ */
5227
+ dimension2?: string;
5111
5228
  };
5112
5229
  url: "/api/v1/analytics/utm/campaign";
5113
5230
  };
@@ -5134,8 +5251,20 @@ type GetAnalyticsUtmContentData = {
5134
5251
  query?: {
5135
5252
  site_id?: string;
5136
5253
  period?: "7" | "30" | "90";
5254
+ /**
5255
+ * 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.
5256
+ */
5257
+ from?: string;
5258
+ /**
5259
+ * 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.
5260
+ */
5261
+ to?: string;
5137
5262
  limit?: string;
5138
5263
  filters?: string;
5264
+ /**
5265
+ * 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.
5266
+ */
5267
+ dimension2?: string;
5139
5268
  };
5140
5269
  url: "/api/v1/analytics/utm/content";
5141
5270
  };
@@ -5162,8 +5291,20 @@ type GetAnalyticsUtmTermData = {
5162
5291
  query?: {
5163
5292
  site_id?: string;
5164
5293
  period?: "7" | "30" | "90";
5294
+ /**
5295
+ * 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.
5296
+ */
5297
+ from?: string;
5298
+ /**
5299
+ * 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.
5300
+ */
5301
+ to?: string;
5165
5302
  limit?: string;
5166
5303
  filters?: string;
5304
+ /**
5305
+ * 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.
5306
+ */
5307
+ dimension2?: string;
5167
5308
  };
5168
5309
  url: "/api/v1/analytics/utm/term";
5169
5310
  };
@@ -5190,8 +5331,20 @@ type GetAnalyticsPagesData = {
5190
5331
  query?: {
5191
5332
  site_id?: string;
5192
5333
  period?: "7" | "30" | "90";
5334
+ /**
5335
+ * 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.
5336
+ */
5337
+ from?: string;
5338
+ /**
5339
+ * 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.
5340
+ */
5341
+ to?: string;
5193
5342
  limit?: string;
5194
5343
  filters?: string;
5344
+ /**
5345
+ * 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.
5346
+ */
5347
+ dimension2?: string;
5195
5348
  };
5196
5349
  url: "/api/v1/analytics/pages";
5197
5350
  };
@@ -5218,8 +5371,20 @@ type GetAnalyticsEntryPagesData = {
5218
5371
  query?: {
5219
5372
  site_id?: string;
5220
5373
  period?: "7" | "30" | "90";
5374
+ /**
5375
+ * 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.
5376
+ */
5377
+ from?: string;
5378
+ /**
5379
+ * 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.
5380
+ */
5381
+ to?: string;
5221
5382
  limit?: string;
5222
5383
  filters?: string;
5384
+ /**
5385
+ * 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.
5386
+ */
5387
+ dimension2?: string;
5223
5388
  };
5224
5389
  url: "/api/v1/analytics/entry-pages";
5225
5390
  };
@@ -5246,8 +5411,20 @@ type GetAnalyticsExitPagesData = {
5246
5411
  query?: {
5247
5412
  site_id?: string;
5248
5413
  period?: "7" | "30" | "90";
5414
+ /**
5415
+ * 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.
5416
+ */
5417
+ from?: string;
5418
+ /**
5419
+ * 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.
5420
+ */
5421
+ to?: string;
5249
5422
  limit?: string;
5250
5423
  filters?: string;
5424
+ /**
5425
+ * 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.
5426
+ */
5427
+ dimension2?: string;
5251
5428
  };
5252
5429
  url: "/api/v1/analytics/exit-pages";
5253
5430
  };
@@ -5274,8 +5451,20 @@ type GetAnalyticsCountriesData = {
5274
5451
  query?: {
5275
5452
  site_id?: string;
5276
5453
  period?: "7" | "30" | "90";
5454
+ /**
5455
+ * 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.
5456
+ */
5457
+ from?: string;
5458
+ /**
5459
+ * 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.
5460
+ */
5461
+ to?: string;
5277
5462
  limit?: string;
5278
5463
  filters?: string;
5464
+ /**
5465
+ * 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.
5466
+ */
5467
+ dimension2?: string;
5279
5468
  };
5280
5469
  url: "/api/v1/analytics/countries";
5281
5470
  };
@@ -5302,8 +5491,20 @@ type GetAnalyticsRegionsData = {
5302
5491
  query?: {
5303
5492
  site_id?: string;
5304
5493
  period?: "7" | "30" | "90";
5494
+ /**
5495
+ * 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.
5496
+ */
5497
+ from?: string;
5498
+ /**
5499
+ * 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.
5500
+ */
5501
+ to?: string;
5305
5502
  limit?: string;
5306
5503
  filters?: string;
5504
+ /**
5505
+ * 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.
5506
+ */
5507
+ dimension2?: string;
5307
5508
  };
5308
5509
  url: "/api/v1/analytics/regions";
5309
5510
  };
@@ -5330,8 +5531,20 @@ type GetAnalyticsCitiesData = {
5330
5531
  query?: {
5331
5532
  site_id?: string;
5332
5533
  period?: "7" | "30" | "90";
5534
+ /**
5535
+ * 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.
5536
+ */
5537
+ from?: string;
5538
+ /**
5539
+ * 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.
5540
+ */
5541
+ to?: string;
5333
5542
  limit?: string;
5334
5543
  filters?: string;
5544
+ /**
5545
+ * 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.
5546
+ */
5547
+ dimension2?: string;
5335
5548
  };
5336
5549
  url: "/api/v1/analytics/cities";
5337
5550
  };
@@ -5358,8 +5571,20 @@ type GetAnalyticsDevicesData = {
5358
5571
  query?: {
5359
5572
  site_id?: string;
5360
5573
  period?: "7" | "30" | "90";
5574
+ /**
5575
+ * 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.
5576
+ */
5577
+ from?: string;
5578
+ /**
5579
+ * 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.
5580
+ */
5581
+ to?: string;
5361
5582
  limit?: string;
5362
5583
  filters?: string;
5584
+ /**
5585
+ * 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.
5586
+ */
5587
+ dimension2?: string;
5363
5588
  };
5364
5589
  url: "/api/v1/analytics/devices";
5365
5590
  };
@@ -5386,8 +5611,20 @@ type GetAnalyticsBrowsersData = {
5386
5611
  query?: {
5387
5612
  site_id?: string;
5388
5613
  period?: "7" | "30" | "90";
5614
+ /**
5615
+ * 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.
5616
+ */
5617
+ from?: string;
5618
+ /**
5619
+ * 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.
5620
+ */
5621
+ to?: string;
5389
5622
  limit?: string;
5390
5623
  filters?: string;
5624
+ /**
5625
+ * 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.
5626
+ */
5627
+ dimension2?: string;
5391
5628
  };
5392
5629
  url: "/api/v1/analytics/browsers";
5393
5630
  };
@@ -5414,8 +5651,20 @@ type GetAnalyticsOperatingSystemsData = {
5414
5651
  query?: {
5415
5652
  site_id?: string;
5416
5653
  period?: "7" | "30" | "90";
5654
+ /**
5655
+ * 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.
5656
+ */
5657
+ from?: string;
5658
+ /**
5659
+ * 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.
5660
+ */
5661
+ to?: string;
5417
5662
  limit?: string;
5418
5663
  filters?: string;
5664
+ /**
5665
+ * 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.
5666
+ */
5667
+ dimension2?: string;
5419
5668
  };
5420
5669
  url: "/api/v1/analytics/operating-systems";
5421
5670
  };
@@ -5442,6 +5691,14 @@ type GetAnalyticsChannelsData = {
5442
5691
  query?: {
5443
5692
  site_id?: string;
5444
5693
  period?: "7" | "30" | "90";
5694
+ /**
5695
+ * First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
5696
+ */
5697
+ from?: string;
5698
+ /**
5699
+ * 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.
5700
+ */
5701
+ to?: string;
5445
5702
  filters?: string;
5446
5703
  };
5447
5704
  url: "/api/v1/analytics/channels";
@@ -7368,6 +7625,10 @@ type DeleteSiteErrors = {
7368
7625
  * 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.
7369
7626
  */
7370
7627
  404: Error;
7628
+ /**
7629
+ * Promotion cleanup could not complete; retry deletion. The live site remains accessible until its remote promotions are disabled.
7630
+ */
7631
+ 503: Error;
7371
7632
  };
7372
7633
  type DeleteSiteError = DeleteSiteErrors[keyof DeleteSiteErrors];
7373
7634
  type DeleteSiteResponses = {
@@ -9512,6 +9773,459 @@ type ResubmitProductReviewResponses = {
9512
9773
  };
9513
9774
  };
9514
9775
  type ResubmitProductReviewResponse = ResubmitProductReviewResponses[keyof ResubmitProductReviewResponses];
9776
+ type Promo = {
9777
+ id: string;
9778
+ site_id: string;
9779
+ stripe_account_id: string;
9780
+ code: string;
9781
+ name: string;
9782
+ percent_off: number | null;
9783
+ amount_off: number | null;
9784
+ currency: string | null;
9785
+ minimum_amount: number | null;
9786
+ expires_at: string | null;
9787
+ max_redemptions: number | null;
9788
+ duration: "once" | "forever" | "repeating";
9789
+ duration_in_months: number | null;
9790
+ status: "active" | "inactive" | "expired" | "exhausted" | "pending" | "unavailable";
9791
+ times_redeemed: number | null;
9792
+ eligibility_scope: "connected_account";
9793
+ checkout_enabled: boolean;
9794
+ replaces_id: string | null;
9795
+ created_at: string;
9796
+ };
9797
+ type PromosList = {
9798
+ promos: Array<Promo>;
9799
+ next_cursor: string | null;
9800
+ checkout_enabled: boolean;
9801
+ };
9802
+ type PromoError = {
9803
+ error: string;
9804
+ code: string;
9805
+ promo_id?: string;
9806
+ retryable: boolean;
9807
+ };
9808
+ type CreatePromo = {
9809
+ /**
9810
+ * Stable client-generated request ID. Retry unchanged after an unknown result.
9811
+ */
9812
+ request_id: string;
9813
+ code: string;
9814
+ name: string;
9815
+ percent_off?: number;
9816
+ amount_off?: number;
9817
+ currency?: string;
9818
+ minimum_amount?: number;
9819
+ expires_at?: string;
9820
+ max_redemptions?: number;
9821
+ duration?: "once" | "forever" | "repeating";
9822
+ duration_in_months?: number;
9823
+ };
9824
+ type ListPromosData = {
9825
+ body?: never;
9826
+ path?: never;
9827
+ query?: {
9828
+ limit?: number;
9829
+ cursor?: string;
9830
+ };
9831
+ url: "/api/v1/promos";
9832
+ };
9833
+ type ListPromosErrors = {
9834
+ /**
9835
+ * Invalid promotion rules
9836
+ */
9837
+ 400: PromoError;
9838
+ /**
9839
+ * Authentication required
9840
+ */
9841
+ 401: PromoError | {
9842
+ error: string;
9843
+ };
9844
+ /**
9845
+ * Site or owned promotion not found
9846
+ */
9847
+ 404: PromoError;
9848
+ /**
9849
+ * Conflicting request or promotion state
9850
+ */
9851
+ 409: PromoError;
9852
+ /**
9853
+ * Unknown Stripe result; retry the same request
9854
+ */
9855
+ 503: PromoError;
9856
+ };
9857
+ type ListPromosError = ListPromosErrors[keyof ListPromosErrors];
9858
+ type ListPromosResponses = {
9859
+ /**
9860
+ * Owned promotions
9861
+ */
9862
+ 200: PromosList;
9863
+ };
9864
+ type ListPromosResponse = ListPromosResponses[keyof ListPromosResponses];
9865
+ type CreatePromoData = {
9866
+ body: CreatePromo;
9867
+ path?: never;
9868
+ query?: never;
9869
+ url: "/api/v1/promos";
9870
+ };
9871
+ type CreatePromoErrors = {
9872
+ /**
9873
+ * Invalid promotion rules
9874
+ */
9875
+ 400: PromoError;
9876
+ /**
9877
+ * Authentication required
9878
+ */
9879
+ 401: PromoError | {
9880
+ error: string;
9881
+ };
9882
+ /**
9883
+ * Site or owned promotion not found
9884
+ */
9885
+ 404: PromoError;
9886
+ /**
9887
+ * Conflicting request or promotion state
9888
+ */
9889
+ 409: PromoError;
9890
+ /**
9891
+ * Unknown Stripe result; retry the same request
9892
+ */
9893
+ 503: PromoError;
9894
+ };
9895
+ type CreatePromoError = CreatePromoErrors[keyof CreatePromoErrors];
9896
+ type CreatePromoResponses = {
9897
+ /**
9898
+ * Created or previously completed promotion
9899
+ */
9900
+ 200: Promo;
9901
+ };
9902
+ type CreatePromoResponse = CreatePromoResponses[keyof CreatePromoResponses];
9903
+ type GetPromoData = {
9904
+ body?: never;
9905
+ path: {
9906
+ promoId: string;
9907
+ };
9908
+ query?: never;
9909
+ url: "/api/v1/promos/{promoId}";
9910
+ };
9911
+ type GetPromoErrors = {
9912
+ /**
9913
+ * Invalid promotion rules
9914
+ */
9915
+ 400: PromoError;
9916
+ /**
9917
+ * Authentication required
9918
+ */
9919
+ 401: PromoError | {
9920
+ error: string;
9921
+ };
9922
+ /**
9923
+ * Site or owned promotion not found
9924
+ */
9925
+ 404: PromoError;
9926
+ /**
9927
+ * Conflicting request or promotion state
9928
+ */
9929
+ 409: PromoError;
9930
+ /**
9931
+ * Unknown Stripe result; retry the same request
9932
+ */
9933
+ 503: PromoError;
9934
+ };
9935
+ type GetPromoError = GetPromoErrors[keyof GetPromoErrors];
9936
+ type GetPromoResponses = {
9937
+ /**
9938
+ * Owned promotion
9939
+ */
9940
+ 200: Promo;
9941
+ };
9942
+ type GetPromoResponse = GetPromoResponses[keyof GetPromoResponses];
9943
+ type DisablePromoData = {
9944
+ body?: never;
9945
+ path: {
9946
+ promoId: string;
9947
+ };
9948
+ query?: never;
9949
+ url: "/api/v1/promos/{promoId}/disable";
9950
+ };
9951
+ type DisablePromoErrors = {
9952
+ /**
9953
+ * Invalid promotion rules
9954
+ */
9955
+ 400: PromoError;
9956
+ /**
9957
+ * Authentication required
9958
+ */
9959
+ 401: PromoError | {
9960
+ error: string;
9961
+ };
9962
+ /**
9963
+ * Site or owned promotion not found
9964
+ */
9965
+ 404: PromoError;
9966
+ /**
9967
+ * Conflicting request or promotion state
9968
+ */
9969
+ 409: PromoError;
9970
+ /**
9971
+ * Unknown Stripe result; retry the same request
9972
+ */
9973
+ 503: PromoError;
9974
+ };
9975
+ type DisablePromoError = DisablePromoErrors[keyof DisablePromoErrors];
9976
+ type DisablePromoResponses = {
9977
+ /**
9978
+ * Disabled promotion
9979
+ */
9980
+ 200: Promo;
9981
+ };
9982
+ type DisablePromoResponse = DisablePromoResponses[keyof DisablePromoResponses];
9983
+ type ReplacePromoData = {
9984
+ body: CreatePromo;
9985
+ path: {
9986
+ promoId: string;
9987
+ };
9988
+ query?: never;
9989
+ url: "/api/v1/promos/{promoId}/replace";
9990
+ };
9991
+ type ReplacePromoErrors = {
9992
+ /**
9993
+ * Invalid promotion rules
9994
+ */
9995
+ 400: PromoError;
9996
+ /**
9997
+ * Authentication required
9998
+ */
9999
+ 401: PromoError | {
10000
+ error: string;
10001
+ };
10002
+ /**
10003
+ * Site or owned promotion not found
10004
+ */
10005
+ 404: PromoError;
10006
+ /**
10007
+ * Conflicting request or promotion state
10008
+ */
10009
+ 409: PromoError;
10010
+ /**
10011
+ * Unknown Stripe result; retry the same request
10012
+ */
10013
+ 503: PromoError;
10014
+ };
10015
+ type ReplacePromoError = ReplacePromoErrors[keyof ReplacePromoErrors];
10016
+ type ReplacePromoResponses = {
10017
+ /**
10018
+ * Replacement created and predecessor disabled
10019
+ */
10020
+ 200: Promo;
10021
+ };
10022
+ type ReplacePromoResponse = ReplacePromoResponses[keyof ReplacePromoResponses];
10023
+ type ListPromosForSiteData = {
10024
+ body?: never;
10025
+ path: {
10026
+ siteId: string;
10027
+ };
10028
+ query?: {
10029
+ limit?: number;
10030
+ cursor?: string;
10031
+ };
10032
+ url: "/api/v1/sites/{siteId}/promos";
10033
+ };
10034
+ type ListPromosForSiteErrors = {
10035
+ /**
10036
+ * Invalid promotion rules
10037
+ */
10038
+ 400: PromoError;
10039
+ /**
10040
+ * Authentication required
10041
+ */
10042
+ 401: PromoError | {
10043
+ error: string;
10044
+ };
10045
+ /**
10046
+ * Site or owned promotion not found
10047
+ */
10048
+ 404: PromoError;
10049
+ /**
10050
+ * Conflicting request or promotion state
10051
+ */
10052
+ 409: PromoError;
10053
+ /**
10054
+ * Unknown Stripe result; retry the same request
10055
+ */
10056
+ 503: PromoError;
10057
+ };
10058
+ type ListPromosForSiteError = ListPromosForSiteErrors[keyof ListPromosForSiteErrors];
10059
+ type ListPromosForSiteResponses = {
10060
+ /**
10061
+ * Owned promotions
10062
+ */
10063
+ 200: PromosList;
10064
+ };
10065
+ type ListPromosForSiteResponse = ListPromosForSiteResponses[keyof ListPromosForSiteResponses];
10066
+ type CreatePromoForSiteData = {
10067
+ body: CreatePromo;
10068
+ path: {
10069
+ siteId: string;
10070
+ };
10071
+ query?: never;
10072
+ url: "/api/v1/sites/{siteId}/promos";
10073
+ };
10074
+ type CreatePromoForSiteErrors = {
10075
+ /**
10076
+ * Invalid promotion rules
10077
+ */
10078
+ 400: PromoError;
10079
+ /**
10080
+ * Authentication required
10081
+ */
10082
+ 401: PromoError | {
10083
+ error: string;
10084
+ };
10085
+ /**
10086
+ * Site or owned promotion not found
10087
+ */
10088
+ 404: PromoError;
10089
+ /**
10090
+ * Conflicting request or promotion state
10091
+ */
10092
+ 409: PromoError;
10093
+ /**
10094
+ * Unknown Stripe result; retry the same request
10095
+ */
10096
+ 503: PromoError;
10097
+ };
10098
+ type CreatePromoForSiteError = CreatePromoForSiteErrors[keyof CreatePromoForSiteErrors];
10099
+ type CreatePromoForSiteResponses = {
10100
+ /**
10101
+ * Created or previously completed promotion
10102
+ */
10103
+ 200: Promo;
10104
+ };
10105
+ type CreatePromoForSiteResponse = CreatePromoForSiteResponses[keyof CreatePromoForSiteResponses];
10106
+ type GetPromoForSiteData = {
10107
+ body?: never;
10108
+ path: {
10109
+ siteId: string;
10110
+ promoId: string;
10111
+ };
10112
+ query?: never;
10113
+ url: "/api/v1/sites/{siteId}/promos/{promoId}";
10114
+ };
10115
+ type GetPromoForSiteErrors = {
10116
+ /**
10117
+ * Invalid promotion rules
10118
+ */
10119
+ 400: PromoError;
10120
+ /**
10121
+ * Authentication required
10122
+ */
10123
+ 401: PromoError | {
10124
+ error: string;
10125
+ };
10126
+ /**
10127
+ * Site or owned promotion not found
10128
+ */
10129
+ 404: PromoError;
10130
+ /**
10131
+ * Conflicting request or promotion state
10132
+ */
10133
+ 409: PromoError;
10134
+ /**
10135
+ * Unknown Stripe result; retry the same request
10136
+ */
10137
+ 503: PromoError;
10138
+ };
10139
+ type GetPromoForSiteError = GetPromoForSiteErrors[keyof GetPromoForSiteErrors];
10140
+ type GetPromoForSiteResponses = {
10141
+ /**
10142
+ * Owned promotion
10143
+ */
10144
+ 200: Promo;
10145
+ };
10146
+ type GetPromoForSiteResponse = GetPromoForSiteResponses[keyof GetPromoForSiteResponses];
10147
+ type DisablePromoForSiteData = {
10148
+ body?: never;
10149
+ path: {
10150
+ siteId: string;
10151
+ promoId: string;
10152
+ };
10153
+ query?: never;
10154
+ url: "/api/v1/sites/{siteId}/promos/{promoId}/disable";
10155
+ };
10156
+ type DisablePromoForSiteErrors = {
10157
+ /**
10158
+ * Invalid promotion rules
10159
+ */
10160
+ 400: PromoError;
10161
+ /**
10162
+ * Authentication required
10163
+ */
10164
+ 401: PromoError | {
10165
+ error: string;
10166
+ };
10167
+ /**
10168
+ * Site or owned promotion not found
10169
+ */
10170
+ 404: PromoError;
10171
+ /**
10172
+ * Conflicting request or promotion state
10173
+ */
10174
+ 409: PromoError;
10175
+ /**
10176
+ * Unknown Stripe result; retry the same request
10177
+ */
10178
+ 503: PromoError;
10179
+ };
10180
+ type DisablePromoForSiteError = DisablePromoForSiteErrors[keyof DisablePromoForSiteErrors];
10181
+ type DisablePromoForSiteResponses = {
10182
+ /**
10183
+ * Disabled promotion
10184
+ */
10185
+ 200: Promo;
10186
+ };
10187
+ type DisablePromoForSiteResponse = DisablePromoForSiteResponses[keyof DisablePromoForSiteResponses];
10188
+ type ReplacePromoForSiteData = {
10189
+ body: CreatePromo;
10190
+ path: {
10191
+ siteId: string;
10192
+ promoId: string;
10193
+ };
10194
+ query?: never;
10195
+ url: "/api/v1/sites/{siteId}/promos/{promoId}/replace";
10196
+ };
10197
+ type ReplacePromoForSiteErrors = {
10198
+ /**
10199
+ * Invalid promotion rules
10200
+ */
10201
+ 400: PromoError;
10202
+ /**
10203
+ * Authentication required
10204
+ */
10205
+ 401: PromoError | {
10206
+ error: string;
10207
+ };
10208
+ /**
10209
+ * Site or owned promotion not found
10210
+ */
10211
+ 404: PromoError;
10212
+ /**
10213
+ * Conflicting request or promotion state
10214
+ */
10215
+ 409: PromoError;
10216
+ /**
10217
+ * Unknown Stripe result; retry the same request
10218
+ */
10219
+ 503: PromoError;
10220
+ };
10221
+ type ReplacePromoForSiteError = ReplacePromoForSiteErrors[keyof ReplacePromoForSiteErrors];
10222
+ type ReplacePromoForSiteResponses = {
10223
+ /**
10224
+ * Replacement created and predecessor disabled
10225
+ */
10226
+ 200: Promo;
10227
+ };
10228
+ type ReplacePromoForSiteResponse = ReplacePromoForSiteResponses[keyof ReplacePromoForSiteResponses];
9515
10229
 
9516
10230
  type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options$1<TData, ThrowOnError> & {
9517
10231
  /**
@@ -9787,13 +10501,13 @@ declare const getAnalyticsStatus: <ThrowOnError extends boolean = false>(options
9787
10501
  /**
9788
10502
  * Top-line metrics with period-over-period comparison
9789
10503
  *
9790
- * 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.
10504
+ * 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.
9791
10505
  */
9792
10506
  declare const getAnalyticsSummary: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsSummaryData, ThrowOnError>) => RequestResult<GetAnalyticsSummaryResponses, GetAnalyticsSummaryErrors, ThrowOnError, "fields">;
9793
10507
  /**
9794
10508
  * Visitors by day for the period
9795
10509
  *
9796
- * One row per local day with traffic, bucketed in the site's reporting timezone. Days with no traffic are omitted rather than zero-filled.
10510
+ * 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.
9797
10511
  */
9798
10512
  declare const getAnalyticsTimeseries: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsTimeseriesData, ThrowOnError>) => RequestResult<GetAnalyticsTimeseriesResponses, GetAnalyticsTimeseriesErrors, ThrowOnError, "fields">;
9799
10513
  /**
@@ -9805,97 +10519,97 @@ declare const getAnalyticsRealtime: <ThrowOnError extends boolean = false>(optio
9805
10519
  /**
9806
10520
  * source breakdown for the period
9807
10521
  *
9808
- * 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.
10522
+ * 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.
9809
10523
  */
9810
10524
  declare const getAnalyticsSources: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsSourcesData, ThrowOnError>) => RequestResult<GetAnalyticsSourcesResponses, GetAnalyticsSourcesErrors, ThrowOnError, "fields">;
9811
10525
  /**
9812
10526
  * campaign breakdown for the period
9813
10527
  *
9814
- * 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.
10528
+ * 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.
9815
10529
  */
9816
10530
  declare const getAnalyticsCampaigns: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsCampaignsData, ThrowOnError>) => RequestResult<GetAnalyticsCampaignsResponses, GetAnalyticsCampaignsErrors, ThrowOnError, "fields">;
9817
10531
  /**
9818
10532
  * utm_medium breakdown for the period
9819
10533
  *
9820
- * 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.
10534
+ * 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.
9821
10535
  */
9822
10536
  declare const getAnalyticsUtmMedium: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsUtmMediumData, ThrowOnError>) => RequestResult<GetAnalyticsUtmMediumResponses, GetAnalyticsUtmMediumErrors, ThrowOnError, "fields">;
9823
10537
  /**
9824
10538
  * utm_source breakdown for the period
9825
10539
  *
9826
- * 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.
10540
+ * 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.
9827
10541
  */
9828
10542
  declare const getAnalyticsUtmSource: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsUtmSourceData, ThrowOnError>) => RequestResult<GetAnalyticsUtmSourceResponses, GetAnalyticsUtmSourceErrors, ThrowOnError, "fields">;
9829
10543
  /**
9830
10544
  * campaign breakdown for the period
9831
10545
  *
9832
- * 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.
10546
+ * 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.
9833
10547
  */
9834
10548
  declare const getAnalyticsUtmCampaign: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsUtmCampaignData, ThrowOnError>) => RequestResult<GetAnalyticsUtmCampaignResponses, GetAnalyticsUtmCampaignErrors, ThrowOnError, "fields">;
9835
10549
  /**
9836
10550
  * utm_content breakdown for the period
9837
10551
  *
9838
- * 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.
10552
+ * 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.
9839
10553
  */
9840
10554
  declare const getAnalyticsUtmContent: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsUtmContentData, ThrowOnError>) => RequestResult<GetAnalyticsUtmContentResponses, GetAnalyticsUtmContentErrors, ThrowOnError, "fields">;
9841
10555
  /**
9842
10556
  * utm_term breakdown for the period
9843
10557
  *
9844
- * 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.
10558
+ * 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.
9845
10559
  */
9846
10560
  declare const getAnalyticsUtmTerm: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsUtmTermData, ThrowOnError>) => RequestResult<GetAnalyticsUtmTermResponses, GetAnalyticsUtmTermErrors, ThrowOnError, "fields">;
9847
10561
  /**
9848
10562
  * pathname breakdown for the period
9849
10563
  *
9850
- * 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.
10564
+ * 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.
9851
10565
  */
9852
10566
  declare const getAnalyticsPages: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsPagesData, ThrowOnError>) => RequestResult<GetAnalyticsPagesResponses, GetAnalyticsPagesErrors, ThrowOnError, "fields">;
9853
10567
  /**
9854
10568
  * pathname breakdown for the period
9855
10569
  *
9856
- * 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.
10570
+ * 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.
9857
10571
  */
9858
10572
  declare const getAnalyticsEntryPages: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsEntryPagesData, ThrowOnError>) => RequestResult<GetAnalyticsEntryPagesResponses, GetAnalyticsEntryPagesErrors, ThrowOnError, "fields">;
9859
10573
  /**
9860
10574
  * pathname breakdown for the period
9861
10575
  *
9862
- * 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.
10576
+ * 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.
9863
10577
  */
9864
10578
  declare const getAnalyticsExitPages: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsExitPagesData, ThrowOnError>) => RequestResult<GetAnalyticsExitPagesResponses, GetAnalyticsExitPagesErrors, ThrowOnError, "fields">;
9865
10579
  /**
9866
10580
  * country breakdown for the period
9867
10581
  *
9868
- * 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.
10582
+ * 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.
9869
10583
  */
9870
10584
  declare const getAnalyticsCountries: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsCountriesData, ThrowOnError>) => RequestResult<GetAnalyticsCountriesResponses, GetAnalyticsCountriesErrors, ThrowOnError, "fields">;
9871
10585
  /**
9872
10586
  * region breakdown for the period
9873
10587
  *
9874
- * 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.
10588
+ * 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.
9875
10589
  */
9876
10590
  declare const getAnalyticsRegions: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsRegionsData, ThrowOnError>) => RequestResult<GetAnalyticsRegionsResponses, GetAnalyticsRegionsErrors, ThrowOnError, "fields">;
9877
10591
  /**
9878
10592
  * city breakdown for the period
9879
10593
  *
9880
- * 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.
10594
+ * 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.
9881
10595
  */
9882
10596
  declare const getAnalyticsCities: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsCitiesData, ThrowOnError>) => RequestResult<GetAnalyticsCitiesResponses, GetAnalyticsCitiesErrors, ThrowOnError, "fields">;
9883
10597
  /**
9884
10598
  * device breakdown for the period
9885
10599
  *
9886
- * 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.
10600
+ * 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.
9887
10601
  */
9888
10602
  declare const getAnalyticsDevices: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsDevicesData, ThrowOnError>) => RequestResult<GetAnalyticsDevicesResponses, GetAnalyticsDevicesErrors, ThrowOnError, "fields">;
9889
10603
  /**
9890
10604
  * browser breakdown for the period
9891
10605
  *
9892
- * 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.
10606
+ * 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.
9893
10607
  */
9894
10608
  declare const getAnalyticsBrowsers: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsBrowsersData, ThrowOnError>) => RequestResult<GetAnalyticsBrowsersResponses, GetAnalyticsBrowsersErrors, ThrowOnError, "fields">;
9895
10609
  /**
9896
10610
  * os breakdown for the period
9897
10611
  *
9898
- * 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.
10612
+ * 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.
9899
10613
  */
9900
10614
  declare const getAnalyticsOperatingSystems: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsOperatingSystemsData, ThrowOnError>) => RequestResult<GetAnalyticsOperatingSystemsResponses, GetAnalyticsOperatingSystemsErrors, ThrowOnError, "fields">;
9901
10615
  /**
@@ -10459,4 +11173,15 @@ declare const withdrawProductReview: <ThrowOnError extends boolean = false>(opti
10459
11173
  */
10460
11174
  declare const resubmitProductReview: <ThrowOnError extends boolean = false>(options: Options<ResubmitProductReviewData, ThrowOnError>) => RequestResult<ResubmitProductReviewResponses, ResubmitProductReviewErrors, ThrowOnError, "fields">;
10461
11175
 
10462
- 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 };
11176
+ declare const listPromos: <ThrowOnError extends boolean = false>(options?: Options<ListPromosData, ThrowOnError>) => RequestResult<ListPromosResponses, ListPromosErrors, ThrowOnError, "fields">;
11177
+ declare const createPromo: <ThrowOnError extends boolean = false>(options: Options<CreatePromoData, ThrowOnError>) => RequestResult<CreatePromoResponses, CreatePromoErrors, ThrowOnError, "fields">;
11178
+ declare const getPromo: <ThrowOnError extends boolean = false>(options: Options<GetPromoData, ThrowOnError>) => RequestResult<GetPromoResponses, GetPromoErrors, ThrowOnError, "fields">;
11179
+ declare const disablePromo: <ThrowOnError extends boolean = false>(options: Options<DisablePromoData, ThrowOnError>) => RequestResult<DisablePromoResponses, DisablePromoErrors, ThrowOnError, "fields">;
11180
+ declare const replacePromo: <ThrowOnError extends boolean = false>(options: Options<ReplacePromoData, ThrowOnError>) => RequestResult<ReplacePromoResponses, ReplacePromoErrors, ThrowOnError, "fields">;
11181
+ declare const listPromosForSite: <ThrowOnError extends boolean = false>(options: Options<ListPromosForSiteData, ThrowOnError>) => RequestResult<ListPromosForSiteResponses, ListPromosForSiteErrors, ThrowOnError, "fields">;
11182
+ declare const createPromoForSite: <ThrowOnError extends boolean = false>(options: Options<CreatePromoForSiteData, ThrowOnError>) => RequestResult<CreatePromoForSiteResponses, CreatePromoForSiteErrors, ThrowOnError, "fields">;
11183
+ declare const getPromoForSite: <ThrowOnError extends boolean = false>(options: Options<GetPromoForSiteData, ThrowOnError>) => RequestResult<GetPromoForSiteResponses, GetPromoForSiteErrors, ThrowOnError, "fields">;
11184
+ declare const disablePromoForSite: <ThrowOnError extends boolean = false>(options: Options<DisablePromoForSiteData, ThrowOnError>) => RequestResult<DisablePromoForSiteResponses, DisablePromoForSiteErrors, ThrowOnError, "fields">;
11185
+ declare const replacePromoForSite: <ThrowOnError extends boolean = false>(options: Options<ReplacePromoForSiteData, ThrowOnError>) => RequestResult<ReplacePromoForSiteResponses, ReplacePromoForSiteErrors, ThrowOnError, "fields">;
11186
+
11187
+ 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 CreatePromo, type CreatePromoData, type CreatePromoError, type CreatePromoErrors, type CreatePromoForSiteData, type CreatePromoForSiteError, type CreatePromoForSiteErrors, type CreatePromoForSiteResponse, type CreatePromoForSiteResponses, type CreatePromoResponse, type CreatePromoResponses, type CreateRetainer, type CreateRetainerData, type CreateRetainerError, type CreateRetainerErrors, type CreateRetainerResponse, type CreateRetainerResponses, type CreateRetainerResult, type CreateSite, type CreateSiteData, type CreateSiteError, type CreateSiteErrors, type CreateSiteResponse, type CreateSiteResponses, type CreateTestOrder, type CreateTestOrderData, type CreateTestOrderError, type CreateTestOrderErrors, type CreateTestOrderResponse, type CreateTestOrderResponses, type CreateTestSubscription, type CreateTestSubscriptionData, type CreateTestSubscriptionError, type CreateTestSubscriptionErrors, type CreateTestSubscriptionResponse, type CreateTestSubscriptionResponses, type CreateVariant, type CreateVariantData, type CreateVariantError, type CreateVariantErrors, type CreateVariantResponse, type CreateVariantResponses, type CurrencyRestatement, type CurrencyTotals, type Customer, type CustomerAddress, type CustomerBilling, type CustomerDetail, type CustomersList, type DeleteEventDestinationData, type DeleteEventDestinationError, type DeleteEventDestinationErrors, type DeleteEventDestinationResponse, type DeleteEventDestinationResponses, type DeleteEventDestinationWithSiteTokenData, type DeleteEventDestinationWithSiteTokenError, type DeleteEventDestinationWithSiteTokenErrors, type DeleteEventDestinationWithSiteTokenResponse, type DeleteEventDestinationWithSiteTokenResponses, type DeleteFormData, type DeleteFormError, type DeleteFormErrors, type DeleteFormResponse, type DeleteFormResponses, type DeleteOptionData, type DeleteOptionError, type DeleteOptionErrors, type DeleteOptionResponse, type DeleteOptionResponses, type DeleteProductData, type DeleteProductError, type DeleteProductErrors, type DeleteProductResponse, type DeleteProductResponses, type DeleteSiteData, type DeleteSiteError, type DeleteSiteErrors, type DeleteSiteResponse, type DeleteSiteResponses, type DeleteSubmissionData, type DeleteSubmissionError, type DeleteSubmissionErrors, type DeleteSubmissionResponse, type DeleteSubmissionResponses, type DeleteVariantData, type DeleteVariantError, type DeleteVariantErrors, type DeleteVariantResponse, type DeleteVariantResponses, type DisablePromoData, type DisablePromoError, type DisablePromoErrors, type DisablePromoForSiteData, type DisablePromoForSiteError, type DisablePromoForSiteErrors, type DisablePromoForSiteResponse, type DisablePromoForSiteResponses, type DisablePromoResponse, type DisablePromoResponses, type DownloadAttachmentData, type DownloadAttachmentError, type DownloadAttachmentErrors, type DownloadAttachmentResponses, type DownloadFileData, type DownloadFileError, type DownloadFileErrors, type DownloadFileResponse, type DownloadFileResponses, type EditProductReviewData, type EditProductReviewError, type EditProductReviewErrors, type EditProductReviewResponse, type EditProductReviewResponses, type EmailDelivery, type EraseCustomerReviewsData, type EraseCustomerReviewsError, type EraseCustomerReviewsErrors, type EraseCustomerReviewsResponse, type EraseCustomerReviewsResponses, type Error, type EventDeliveriesList, type EventDelivery, type EventDestination, type EventDestinationSecret, type EventDestinationsList, type Form, type FormsList, type GenerateVariants, type GenerateVariantsData, type GenerateVariantsError, type GenerateVariantsErrors, type GenerateVariantsResponse, type GenerateVariantsResponses, type GenerateVariantsResult, type GeoSuggestion, type GetAccountReviewsData, type GetAccountReviewsError, type GetAccountReviewsErrors, type GetAccountReviewsResponse, type GetAccountReviewsResponses, type GetAnalyticsBrowsersData, type GetAnalyticsBrowsersErrors, type GetAnalyticsBrowsersResponse, type GetAnalyticsBrowsersResponses, type GetAnalyticsCampaignsData, type GetAnalyticsCampaignsErrors, type GetAnalyticsCampaignsResponse, type GetAnalyticsCampaignsResponses, type GetAnalyticsChannelsData, type GetAnalyticsChannelsErrors, type GetAnalyticsChannelsResponse, type GetAnalyticsChannelsResponses, type GetAnalyticsCitiesData, type GetAnalyticsCitiesErrors, type GetAnalyticsCitiesResponse, type GetAnalyticsCitiesResponses, type 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 GetPromoData, type GetPromoError, type GetPromoErrors, type GetPromoForSiteData, type GetPromoForSiteError, type GetPromoForSiteErrors, type GetPromoForSiteResponse, type GetPromoForSiteResponses, type GetPromoResponse, type GetPromoResponses, type GetPublicConsentPrefsData, type GetPublicConsentPrefsError, type GetPublicConsentPrefsErrors, type GetPublicConsentPrefsResponse, type GetPublicConsentPrefsResponses, type GetPublicProductData, type GetPublicProductError, type GetPublicProductErrors, type GetPublicProductResponse, type GetPublicProductResponses, type GetRetainerData, type GetRetainerError, type GetRetainerErrors, type GetRetainerResponse, type GetRetainerResponses, type GetReviewSettingsData, type GetReviewSettingsError, type GetReviewSettingsErrors, type GetReviewSettingsResponse, type GetReviewSettingsResponses, type GetSalesSummaryData, type GetSalesSummaryErrors, type GetSalesSummaryResponse, type GetSalesSummaryResponses, type GetSiteAnalyticsData, type GetSiteAnalyticsError, type GetSiteAnalyticsErrors, type GetSiteAnalyticsResponse, type GetSiteAnalyticsResponses, type GetSiteCheckoutPauseData, type GetSiteCheckoutPauseError, type GetSiteCheckoutPauseErrors, type GetSiteCheckoutPauseResponse, type GetSiteCheckoutPauseResponses, type GetSiteData, type GetSiteError, type GetSiteErrors, type GetSiteResponse, type GetSiteResponses, type GetSubmissionData, type GetSubmissionError, type GetSubmissionErrors, type GetSubmissionResponse, type GetSubmissionResponses, type Inventory, type InventoryInput, type Invoice, type InvoiceAggregates, type InvoiceBillTo, type InvoiceError, type InvoiceLineItem, type InvoicePreview, type InvoiceSettings, type InvoiceSiteBody, type InvoicesList, type ListCustomersData, type ListCustomersError, type ListCustomersErrors, type ListCustomersResponse, type ListCustomersResponses, type ListEventDeliveriesData, type ListEventDeliveriesError, type ListEventDeliveriesErrors, type ListEventDeliveriesResponse, type ListEventDeliveriesResponses, type ListEventDeliveriesWithSiteTokenData, type ListEventDeliveriesWithSiteTokenError, type ListEventDeliveriesWithSiteTokenErrors, type ListEventDeliveriesWithSiteTokenResponse, type ListEventDeliveriesWithSiteTokenResponses, type ListEventDestinationsData, type ListEventDestinationsError, type ListEventDestinationsErrors, type ListEventDestinationsResponse, type ListEventDestinationsResponses, type ListEventDestinationsWithSiteTokenData, type ListEventDestinationsWithSiteTokenError, type ListEventDestinationsWithSiteTokenErrors, type ListEventDestinationsWithSiteTokenResponse, type ListEventDestinationsWithSiteTokenResponses, type ListFormsData, type ListFormsError, type ListFormsErrors, type ListFormsResponse, type ListFormsResponses, type ListFormsWithSiteTokenData, type ListFormsWithSiteTokenError, type ListFormsWithSiteTokenErrors, type ListFormsWithSiteTokenResponse, type ListFormsWithSiteTokenResponses, type ListInvoicesData, type ListInvoicesError, type ListInvoicesErrors, type ListInvoicesResponse, type ListInvoicesResponses, type ListMerchantReviewsData, type ListMerchantReviewsError, type ListMerchantReviewsErrors, type ListMerchantReviewsResponse, type ListMerchantReviewsResponses, type ListOrdersWithSiteTokenData, type ListOrdersWithSiteTokenError, type ListOrdersWithSiteTokenErrors, type ListOrdersWithSiteTokenResponse, type ListOrdersWithSiteTokenResponses, type ListPeopleData, type ListPeopleErrors, type ListPeopleResponse, type ListPeopleResponses, type ListProductsData, type ListProductsError, type ListProductsErrors, type ListProductsResponse, type ListProductsResponses, type ListProductsWithSiteTokenData, type ListProductsWithSiteTokenError, type ListProductsWithSiteTokenErrors, type ListProductsWithSiteTokenResponse, type ListProductsWithSiteTokenResponses, type ListPromosData, type ListPromosError, type ListPromosErrors, type ListPromosForSiteData, type ListPromosForSiteError, type ListPromosForSiteErrors, type ListPromosForSiteResponse, type ListPromosForSiteResponses, type ListPromosResponse, type ListPromosResponses, type ListRetainersData, type ListRetainersError, type ListRetainersErrors, type ListRetainersResponse, type ListRetainersResponses, type ListSitesData, type ListSitesError, type ListSitesErrors, type ListSitesResponse, type ListSitesResponses, type ListSubmissionsData, type ListSubmissionsError, type ListSubmissionsErrors, type ListSubmissionsResponse, type ListSubmissionsResponses, type ListSubscriptionsData, type ListSubscriptionsErrors, type ListSubscriptionsResponse, type ListSubscriptionsResponses, type ManageCancelResult, type ManageLinkAction, type ManageVerifyRequest, type ManageVerifyResult, type ManagedSubscription, type ManagedSubscriptionResult, type MarkInvoicePaid, type MarkInvoicePaidData, type MarkInvoicePaidError, type MarkInvoicePaidErrors, type MarkInvoicePaidResponse, type MarkInvoicePaidResponses, type MarkInvoicePaidResult, type MarkInvoiceUncollectibleData, type MarkInvoiceUncollectibleError, type MarkInvoiceUncollectibleErrors, type MarkInvoiceUncollectibleResponse, type MarkInvoiceUncollectibleResponses, type ModerateMerchantReviewData, type ModerateMerchantReviewError, type ModerateMerchantReviewErrors, type ModerateMerchantReviewResponse, type ModerateMerchantReviewResponses, type NeedsAttentionItem, type NestedOptionInput, type NestedVariantInput, type NextPayout, type Option, type Options, type Order, type OrderCustomer, type OrderFulfillmentRequest, type OrderSessionStatus, type OrdersList, type OwnProductReview, type PauseRetainerData, type PauseRetainerError, type PauseRetainerErrors, type PauseRetainerResponse, type PauseRetainerResponses, type PauseSiteCheckoutData, type PauseSiteCheckoutError, type PauseSiteCheckoutErrors, type PauseSiteCheckoutResponse, type PauseSiteCheckoutResponses, type PaymentsStatus, type PeopleList, type PersonDetail, type PersonRow, type PortalSessionResult, type PreviewInvoice, type PreviewInvoiceData, type PreviewInvoiceError, type PreviewInvoiceErrors, type PreviewInvoiceResponse, type PreviewInvoiceResponses, type PreviewSessionResult, type Product, type ProductDetail, type ProductFulfillment, type ProductFulfillmentInput, type ProductReview, type ProductSubscriptionConfig, type ProductsList, type Promo, type PromoError, type PromosList, type PublicOption, type PublicProduct, type PublicSubscription, type PublicSubscriptionPlan, type PublicVariant, type PurgeSiteReviewsData, type PurgeSiteReviewsError, type PurgeSiteReviewsErrors, type PurgeSiteReviewsResponse, type PurgeSiteReviewsResponses, type ReactivateSiteSubscriptionsTeardownData, type ReactivateSiteSubscriptionsTeardownError, type ReactivateSiteSubscriptionsTeardownErrors, type ReactivateSiteSubscriptionsTeardownResponse, type ReactivateSiteSubscriptionsTeardownResponses, type RecipientCooldownError, type ReconcileOptionInput, type ReconcileOptionValueInput, type ReconcileVariantInput, type RefundOrder, type RefundOrderData, type RefundOrderError, type RefundOrderErrors, type RefundOrderResponse, type RefundOrderResponses, type RefundResult, type ReissueResult, type RemindInvoiceData, type RemindInvoiceError, type RemindInvoiceErrors, type RemindInvoiceResponse, type RemindInvoiceResponses, type RemindInvoiceResult, type ReplacePromoData, type ReplacePromoError, type ReplacePromoErrors, type ReplacePromoForSiteData, type ReplacePromoForSiteError, type ReplacePromoForSiteErrors, type ReplacePromoForSiteResponse, type ReplacePromoForSiteResponses, type ReplacePromoResponse, type ReplacePromoResponses, type ReplyToMerchantReviewData, type ReplyToMerchantReviewError, type ReplyToMerchantReviewErrors, type ReplyToMerchantReviewResponse, type ReplyToMerchantReviewResponses, type ResendInvoiceData, type ResendInvoiceError, type ResendInvoiceErrors, type ResendInvoiceResponse, type ResendInvoiceResponses, type ResendOrderReceiptData, type ResendOrderReceiptError, type ResendOrderReceiptErrors, type ResendOrderReceiptResponse, type ResendOrderReceiptResponses, type ResendReceiptResult, type ResetOrderDownloadsData, type ResetOrderDownloadsError, type ResetOrderDownloadsErrors, type ResetOrderDownloadsResponse, type ResetOrderDownloadsResponses, type ResetWebhookEventData, type ResetWebhookEventError, type ResetWebhookEventErrors, type ResetWebhookEventResponse, type ResetWebhookEventResponses, type ResolveManageLinkData, type ResolveManageLinkError, type ResolveManageLinkErrors, type ResolveManageLinkResponse, type ResolveManageLinkResponses, type ResubmitProductReviewData, type ResubmitProductReviewError, type ResubmitProductReviewErrors, type ResubmitProductReviewResponse, type ResubmitProductReviewResponses, type ResumeRetainerData, type ResumeRetainerError, type ResumeRetainerErrors, type ResumeRetainerResponse, type ResumeRetainerResponses, type Retainer, type RetainerError, type RetainerSiteBody, type RetainersList, type RetryEventDeliveryData, type RetryEventDeliveryError, type RetryEventDeliveryErrors, type RetryEventDeliveryResponse, type RetryEventDeliveryResponses, type RetryEventDeliveryWithSiteTokenData, type RetryEventDeliveryWithSiteTokenError, type RetryEventDeliveryWithSiteTokenErrors, type RetryEventDeliveryWithSiteTokenResponse, type RetryEventDeliveryWithSiteTokenResponses, type ReviewReadiness, type RevokeCustomerAccessData, type RevokeCustomerAccessError, type RevokeCustomerAccessErrors, type RevokeCustomerAccessResponse, type RevokeCustomerAccessResponses, type RevokeCustomerAccessResult, type RotateEventDestinationSecretData, type RotateEventDestinationSecretError, type RotateEventDestinationSecretErrors, type RotateEventDestinationSecretResponse, type RotateEventDestinationSecretResponses, type RotateEventDestinationSecretWithSiteTokenData, type RotateEventDestinationSecretWithSiteTokenError, type RotateEventDestinationSecretWithSiteTokenErrors, type RotateEventDestinationSecretWithSiteTokenResponse, type RotateEventDestinationSecretWithSiteTokenResponses, type SalesSummary, type SalesSummaryProductRow, type SalesSummarySeriesEntry, type SetInventory, type SetInvoiceReminders, type SetInvoiceRemindersData, type SetInvoiceRemindersError, type SetInvoiceRemindersErrors, type SetInvoiceRemindersResponse, type SetInvoiceRemindersResponses, type SetOrderFulfillmentData, type SetOrderFulfillmentErrors, type SetOrderFulfillmentResponse, type SetOrderFulfillmentResponses, type SetProductSubscription, type SetProductSubscriptionData, type SetProductSubscriptionError, type SetProductSubscriptionErrors, type SetProductSubscriptionResponse, type SetProductSubscriptionResponses, type SetProductVariants, type SetProductVariantsConflict, type SetProductVariantsData, type SetProductVariantsError, type SetProductVariantsErrors, type SetProductVariantsResponse, type SetProductVariantsResponses, type SetProductVariantsResult, type SetVariantInventoryData, type SetVariantInventoryError, type SetVariantInventoryErrors, type SetVariantInventoryResponse, type SetVariantInventoryResponses, type SettledTotals, type ShippingOptionUnavailable, type ShippingRateInput, type Site, type SiteAccountRoute, type SiteAnalytics, type SiteDomains, type SitePayments, type SiteWithRestatement, type SiteWithToken, type SitesList, type SkipNextRetainerCycleData, type SkipNextRetainerCycleError, type SkipNextRetainerCycleErrors, type SkipNextRetainerCycleResponse, type SkipNextRetainerCycleResponses, type SnoozeInvoice, type SnoozeInvoiceData, type SnoozeInvoiceError, type SnoozeInvoiceErrors, type SnoozeInvoiceResponse, type SnoozeInvoiceResponses, type Submission, type SubmissionMetadata, type SubmissionsList, type SubscriberActionResult, type SubscriberSubscription, type SubscriptionPlan, type SubscriptionPlanInput, type SubscriptionSummary, type SubscriptionsList, type SubscriptionsReactivateBody, type SubscriptionsReactivateResult, type SubscriptionsTeardownBody, type SubscriptionsTeardownResult, type SummaryPeriod, type TeardownReason, type TeardownSiteSubscriptionsData, type TeardownSiteSubscriptionsError, type TeardownSiteSubscriptionsErrors, type TeardownSiteSubscriptionsResponse, type TeardownSiteSubscriptionsResponses, type TestOrderResult, type TestShippingAddress, type TestSubscriptionResult, type 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, createPromo, createPromoForSite, createRetainer, createSite, createTestOrder, createTestSubscription, createVariant, deleteEventDestination, deleteEventDestinationWithSiteToken, deleteForm, deleteOption, deleteProduct, deleteSite, deleteSubmission, deleteVariant, disablePromo, disablePromoForSite, 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, getPromo, getPromoForSite, getPublicConsentPrefs, getPublicProduct, getRetainer, getReviewSettings, getSalesSummary, getSite, getSiteAnalytics, getSiteCheckoutPause, getSubmission, listCustomers, listEventDeliveries, listEventDeliveriesWithSiteToken, listEventDestinations, listEventDestinationsWithSiteToken, listForms, listFormsWithSiteToken, listInvoices, listMerchantReviews, listOrdersWithSiteToken, listPeople, listProducts, listProductsWithSiteToken, listPromos, listPromosForSite, listRetainers, listSites, listSubmissions, listSubscriptions, markInvoicePaid, markInvoiceUncollectible, moderateMerchantReview, pauseRetainer, pauseSiteCheckout, previewInvoice, purgeSiteReviews, reactivateSiteSubscriptionsTeardown, refundOrder, remindInvoice, replacePromo, replacePromoForSite, replyToMerchantReview, resendInvoice, resendOrderReceipt, resetOrderDownloads, resetWebhookEvent, resolveManageLink, resubmitProductReview, resumeRetainer, retryEventDelivery, retryEventDeliveryWithSiteToken, revokeCustomerAccess, rotateEventDestinationSecret, rotateEventDestinationSecretWithSiteToken, setInvoiceReminders, setOrderFulfillment, setProductSubscription, setProductVariants, setVariantInventory, skipNextRetainerCycle, snoozeInvoice, teardownSiteSubscriptions, updateCustomer, updateCustomerBilling, updateEventDestination, updateEventDestinationWithSiteToken, updateForm, updateInvoiceRecipient, updateInvoiceSettings, updateOption, updateProduct, updateRetainer, updateReviewSettings, updateSite, updateSiteAccountRoute, updateSiteAnalytics, updateSiteDomains, updateSiteInvoicing, updateSitePayments, updateVariant, upsertConsentConfigWithSiteToken, voidInvoice, withdrawProductReview };