@aifeatures/backend 0.12.0 → 0.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +4 -4
- package/dist/index.d.cts +2041 -1426
- package/dist/index.d.ts +2041 -1426
- package/dist/index.js +2 -2
- package/package.json +9 -8
package/dist/index.d.cts
CHANGED
|
@@ -1744,6 +1744,85 @@ type AnalyticsChannels = {
|
|
|
1744
1744
|
} | {
|
|
1745
1745
|
status: "unreachable";
|
|
1746
1746
|
};
|
|
1747
|
+
type AnalyticsGoal = {
|
|
1748
|
+
/**
|
|
1749
|
+
* null for a built-in goal, which is not a row and cannot be renamed or deleted
|
|
1750
|
+
*/
|
|
1751
|
+
id: string | null;
|
|
1752
|
+
kind: "pageview" | "scroll" | "event";
|
|
1753
|
+
display_name: string;
|
|
1754
|
+
path_pattern: string | null;
|
|
1755
|
+
scroll_threshold: number | null;
|
|
1756
|
+
event_name: string | null;
|
|
1757
|
+
builtin: boolean;
|
|
1758
|
+
};
|
|
1759
|
+
type AnalyticsGoalList = {
|
|
1760
|
+
goals: Array<AnalyticsGoal>;
|
|
1761
|
+
/**
|
|
1762
|
+
* Maximum goals this site may define
|
|
1763
|
+
*/
|
|
1764
|
+
limit: number;
|
|
1765
|
+
/**
|
|
1766
|
+
* How many of the limit are used
|
|
1767
|
+
*/
|
|
1768
|
+
defined: number;
|
|
1769
|
+
};
|
|
1770
|
+
type AnalyticsGoalInput = {
|
|
1771
|
+
kind: "pageview" | "scroll" | "event";
|
|
1772
|
+
display_name: string;
|
|
1773
|
+
path_pattern?: string | null;
|
|
1774
|
+
scroll_threshold?: number | null;
|
|
1775
|
+
event_name?: string | null;
|
|
1776
|
+
};
|
|
1777
|
+
type AnalyticsFunnel = {
|
|
1778
|
+
id: string;
|
|
1779
|
+
display_name: string;
|
|
1780
|
+
/**
|
|
1781
|
+
* How many steps the funnel was DEFINED with. Normally equal to the length of `steps`; larger when a goal a step referenced has been deleted, which cascades the step away.
|
|
1782
|
+
*/
|
|
1783
|
+
declared_steps: number;
|
|
1784
|
+
/**
|
|
1785
|
+
* True when a step is missing because its goal was deleted. The funnel CANNOT be reported in that state, and `steps` then has a gap in its positions rather than being dense — an editor must not save it back as-is, or it would save a shorter path the merchant never defined.
|
|
1786
|
+
*/
|
|
1787
|
+
broken: boolean;
|
|
1788
|
+
/**
|
|
1789
|
+
* The first declared position with no surviving step, or null when nothing is missing.
|
|
1790
|
+
*/
|
|
1791
|
+
missing_step: number | null;
|
|
1792
|
+
steps: Array<{
|
|
1793
|
+
/**
|
|
1794
|
+
* 1-based, and dense UNLESS `broken` is true — a cascaded deletion leaves a gap, and the surviving positions are reported as they are rather than renumbered, so the gap is visible.
|
|
1795
|
+
*/
|
|
1796
|
+
position: number;
|
|
1797
|
+
goal_id: string | null;
|
|
1798
|
+
builtin_goal: string | null;
|
|
1799
|
+
/**
|
|
1800
|
+
* The step's goal as a display name, resolved server-side so a client never has to join goals itself.
|
|
1801
|
+
*/
|
|
1802
|
+
goal: string;
|
|
1803
|
+
}>;
|
|
1804
|
+
};
|
|
1805
|
+
type AnalyticsFunnelStepInput = {
|
|
1806
|
+
/**
|
|
1807
|
+
* A goal of this site, by id. Exactly one of goal_id and builtin_goal must be set — they are different kinds of reference: a stored goal's id survives a rename, a built-in goal has no row to point at.
|
|
1808
|
+
*/
|
|
1809
|
+
goal_id?: string | null;
|
|
1810
|
+
/**
|
|
1811
|
+
* A built-in goal, by name: one of Form: Submission, Outbound Link: Click, File Download, Contact, Purchase, Form: Received. Safe to reference by name because built-ins cannot be renamed.
|
|
1812
|
+
*/
|
|
1813
|
+
builtin_goal?: string | null;
|
|
1814
|
+
};
|
|
1815
|
+
type AnalyticsFunnelInput = {
|
|
1816
|
+
display_name: string;
|
|
1817
|
+
/**
|
|
1818
|
+
* Ordered, 2 to 8 steps. Array order IS the step order; positions are assigned from it and stay dense.
|
|
1819
|
+
*/
|
|
1820
|
+
steps: Array<AnalyticsFunnelStepInput>;
|
|
1821
|
+
};
|
|
1822
|
+
type AnalyticsFunnelPatch = {
|
|
1823
|
+
display_name?: string;
|
|
1824
|
+
steps?: Array<AnalyticsFunnelStepInput>;
|
|
1825
|
+
};
|
|
1747
1826
|
type SubscriptionSummary = {
|
|
1748
1827
|
/**
|
|
1749
1828
|
* Latest email delivery observation per kind. Independent of payment and send-retry status; absent for older deployments.
|
|
@@ -2409,6 +2488,54 @@ type OwnProductReview = ProductReview & {
|
|
|
2409
2488
|
product_name: string | null;
|
|
2410
2489
|
product_available: boolean;
|
|
2411
2490
|
};
|
|
2491
|
+
type Promo = {
|
|
2492
|
+
id: string;
|
|
2493
|
+
site_id: string;
|
|
2494
|
+
stripe_account_id: string;
|
|
2495
|
+
code: string;
|
|
2496
|
+
name: string;
|
|
2497
|
+
percent_off: number | null;
|
|
2498
|
+
amount_off: number | null;
|
|
2499
|
+
currency: string | null;
|
|
2500
|
+
minimum_amount: number | null;
|
|
2501
|
+
expires_at: string | null;
|
|
2502
|
+
max_redemptions: number | null;
|
|
2503
|
+
duration: "once" | "forever" | "repeating";
|
|
2504
|
+
duration_in_months: number | null;
|
|
2505
|
+
status: "active" | "inactive" | "expired" | "exhausted" | "pending" | "unavailable";
|
|
2506
|
+
times_redeemed: number | null;
|
|
2507
|
+
eligibility_scope: "connected_account";
|
|
2508
|
+
checkout_enabled: boolean;
|
|
2509
|
+
replaces_id: string | null;
|
|
2510
|
+
created_at: string;
|
|
2511
|
+
};
|
|
2512
|
+
type PromosList = {
|
|
2513
|
+
promos: Array<Promo>;
|
|
2514
|
+
next_cursor: string | null;
|
|
2515
|
+
checkout_enabled: boolean;
|
|
2516
|
+
};
|
|
2517
|
+
type PromoError = {
|
|
2518
|
+
error: string;
|
|
2519
|
+
code: string;
|
|
2520
|
+
promo_id?: string;
|
|
2521
|
+
retryable: boolean;
|
|
2522
|
+
};
|
|
2523
|
+
type CreatePromo = {
|
|
2524
|
+
/**
|
|
2525
|
+
* Stable client-generated request ID. Retry unchanged after an unknown result.
|
|
2526
|
+
*/
|
|
2527
|
+
request_id: string;
|
|
2528
|
+
code: string;
|
|
2529
|
+
name: string;
|
|
2530
|
+
percent_off?: number;
|
|
2531
|
+
amount_off?: number;
|
|
2532
|
+
currency?: string;
|
|
2533
|
+
minimum_amount?: number;
|
|
2534
|
+
expires_at?: string;
|
|
2535
|
+
max_redemptions?: number;
|
|
2536
|
+
duration?: "once" | "forever" | "repeating";
|
|
2537
|
+
duration_in_months?: number;
|
|
2538
|
+
};
|
|
2412
2539
|
type ConsentConfig = {
|
|
2413
2540
|
mode: "adaptive" | "adaptive-with-notice" | "strict-everywhere" | "off";
|
|
2414
2541
|
policy_path: string | null;
|
|
@@ -5720,29 +5847,32 @@ type GetAnalyticsChannelsResponses = {
|
|
|
5720
5847
|
200: AnalyticsChannels;
|
|
5721
5848
|
};
|
|
5722
5849
|
type GetAnalyticsChannelsResponse = GetAnalyticsChannelsResponses[keyof GetAnalyticsChannelsResponses];
|
|
5723
|
-
type
|
|
5850
|
+
type GetAnalyticsConversionsData = {
|
|
5724
5851
|
body?: never;
|
|
5725
5852
|
path?: never;
|
|
5726
5853
|
query?: {
|
|
5727
5854
|
/**
|
|
5728
|
-
* Required with an
|
|
5855
|
+
* Required when authenticating with an organization API key — scopes the call to one site in your org. Optional with a site token, and must match that token's site.
|
|
5729
5856
|
*/
|
|
5730
5857
|
site_id?: string;
|
|
5731
5858
|
/**
|
|
5732
|
-
*
|
|
5859
|
+
* Days covered, ending at the most recent midnight in the site's reporting timezone. Today's partial day is EXCLUDED - including it would compare a complete period against a few hours and read as a traffic collapse every morning. Defaults to 30.
|
|
5733
5860
|
*/
|
|
5734
|
-
|
|
5861
|
+
period?: "7" | "30" | "90";
|
|
5735
5862
|
/**
|
|
5736
|
-
*
|
|
5863
|
+
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5737
5864
|
*/
|
|
5738
|
-
|
|
5739
|
-
|
|
5865
|
+
from?: string;
|
|
5866
|
+
/**
|
|
5867
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5868
|
+
*/
|
|
5869
|
+
to?: string;
|
|
5740
5870
|
};
|
|
5741
|
-
url: "/api/v1/
|
|
5871
|
+
url: "/api/v1/analytics/conversions";
|
|
5742
5872
|
};
|
|
5743
|
-
type
|
|
5873
|
+
type GetAnalyticsConversionsErrors = {
|
|
5744
5874
|
/**
|
|
5745
|
-
* site_id mismatch /
|
|
5875
|
+
* site_id mismatch / unsupported period
|
|
5746
5876
|
*/
|
|
5747
5877
|
400: unknown;
|
|
5748
5878
|
/**
|
|
@@ -5750,421 +5880,645 @@ type ListSubscriptionsErrors = {
|
|
|
5750
5880
|
*/
|
|
5751
5881
|
401: unknown;
|
|
5752
5882
|
};
|
|
5753
|
-
type
|
|
5883
|
+
type GetAnalyticsConversionsResponses = {
|
|
5754
5884
|
/**
|
|
5755
|
-
*
|
|
5885
|
+
* Conversions per goal, or an unreachable source
|
|
5756
5886
|
*/
|
|
5757
|
-
200:
|
|
5887
|
+
200: {
|
|
5888
|
+
status: "ok";
|
|
5889
|
+
/**
|
|
5890
|
+
* One row per goal, INCLUDING goals that matched nothing, which read zero rather than being omitted. A goal absent from this list does not exist; a goal with zeros exists and had no conversions.
|
|
5891
|
+
*/
|
|
5892
|
+
data: Array<{
|
|
5893
|
+
/**
|
|
5894
|
+
* The goal's display name. Names are resolved server-side: the query itself works on positions, so a name containing a comma cannot be split in transit.
|
|
5895
|
+
*/
|
|
5896
|
+
goal: string;
|
|
5897
|
+
/**
|
|
5898
|
+
* What the goal matches. `pageview` matches a path pattern against pageviews only, `scroll` matches an engagement beacon past a depth threshold, `event` matches an event name exactly. Each kind is scoped to the rows it can legitimately match, so a path-based goal cannot absorb another goal's conversions.
|
|
5899
|
+
*/
|
|
5900
|
+
kind: "pageview" | "scroll" | "event";
|
|
5901
|
+
/**
|
|
5902
|
+
* True for every goal a site has without defining anything, which is now two families and they differ in one important way. The COLLECTED ones — form submissions, outbound clicks, downloads, and Contact (phone and email taps together) — are matched at query time over events the collector has always accepted, so they cover the site's ENTIRE history. The SERVER-WRITTEN ones — `Purchase` and `Form: Received` — are events we write rather than collect, so they exist only from the deploy that started writing them. Do not read `implicit` as meaning historically complete: read `counts_from`, which is null for the first family and a date for the second.
|
|
5903
|
+
*/
|
|
5904
|
+
implicit: boolean;
|
|
5905
|
+
/**
|
|
5906
|
+
* Unique visitors who converted. Plausible calls this a unique conversion.
|
|
5907
|
+
*/
|
|
5908
|
+
visitors: number;
|
|
5909
|
+
/**
|
|
5910
|
+
* Total conversion events. Scroll goals are deduplicated to one per (visitor, path) for the window, because the engagement beacon refires on visibility changes and on every depth increase — raw, a scroll goal read 1.50x its honest value beside a form submission counted once.
|
|
5911
|
+
*/
|
|
5912
|
+
events: number;
|
|
5913
|
+
/**
|
|
5914
|
+
* visitors divided by SITE-WIDE unique visitors for the window — see `denominator`. NOT a share of anything: rows do not sum to 1, and two goals can each be converted by most of the site's visitors. Null, never 0, when the window had no visitors at all, because a rate of zero asserts that visitors came and did not convert.
|
|
5915
|
+
*/
|
|
5916
|
+
conversion_rate: number | null;
|
|
5917
|
+
/**
|
|
5918
|
+
* The whole date (YYYY-MM-DD) this goal's events begin, or null when it covers the site's ENTIRE history. Goals are matched at read time, so a goal reports across everything already recorded — but `Purchase` and `Form: Received` are events we WRITE rather than collect, and they exist only from the deploy that started writing them. Say so wherever a merchant could otherwise read a truthful zero for an earlier period as a broken feature. A DATE rather than a flag, because "counted from 30 September" is something a merchant can act on and "not retroactive" is not.
|
|
5919
|
+
*/
|
|
5920
|
+
counts_from: string | null;
|
|
5921
|
+
}>;
|
|
5922
|
+
/**
|
|
5923
|
+
* The half-open UTC window the values were measured over: from inclusive, to exclusive. Resolved from the site's reporting timezone.
|
|
5924
|
+
*/
|
|
5925
|
+
window: {
|
|
5926
|
+
from: string;
|
|
5927
|
+
to: string;
|
|
5928
|
+
};
|
|
5929
|
+
/**
|
|
5930
|
+
* Site-wide unique visitors for the window, with no goal filtering — the denominator every `conversion_rate` above divides by. Say what the rate is a ratio of wherever you show one: this is Plausible's definition and it surprises people, because the rates do not sum to 100%.
|
|
5931
|
+
*/
|
|
5932
|
+
denominator: number;
|
|
5933
|
+
/**
|
|
5934
|
+
* The site's earliest recorded event, or null if it has never recorded one. Present so a zero can be told apart from a window that predates collection — see `window_precedes_collection`.
|
|
5935
|
+
*/
|
|
5936
|
+
first_seen: string | null;
|
|
5937
|
+
/**
|
|
5938
|
+
* True when the earliest-event lookup could not be made. Distinguishes 'we could not ask' from 'nothing was ever collected', which are opposite claims.
|
|
5939
|
+
*/
|
|
5940
|
+
first_seen_unavailable: boolean;
|
|
5941
|
+
/**
|
|
5942
|
+
* True when the window starts before this site's first recorded event, so low or zero conversions are partly an artifact of the range rather than a fact about the site. False when collection covers the whole window, and false when `first_seen_unavailable` — never guess coverage from a failed lookup.
|
|
5943
|
+
*/
|
|
5944
|
+
window_precedes_collection: boolean;
|
|
5945
|
+
} | {
|
|
5946
|
+
status: "unreachable";
|
|
5947
|
+
};
|
|
5758
5948
|
};
|
|
5759
|
-
type
|
|
5760
|
-
type
|
|
5949
|
+
type GetAnalyticsConversionsResponse = GetAnalyticsConversionsResponses[keyof GetAnalyticsConversionsResponses];
|
|
5950
|
+
type GetAnalyticsFunnelReportData = {
|
|
5761
5951
|
body?: never;
|
|
5762
5952
|
path: {
|
|
5763
|
-
|
|
5953
|
+
id: string;
|
|
5764
5954
|
};
|
|
5765
|
-
query?:
|
|
5766
|
-
|
|
5955
|
+
query?: {
|
|
5956
|
+
site_id?: string;
|
|
5957
|
+
period?: "7" | "30" | "90";
|
|
5958
|
+
/**
|
|
5959
|
+
* First day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD read in the site's reporting timezone. Send it with `to` and without `period` - a request carrying both a period and a range is refused rather than silently resolved to one of them. The same boundary rules as a preset apply: whole local days, and today is excluded because it is partial, so a range ending today ends at the most recent local midnight instead.
|
|
5960
|
+
*/
|
|
5961
|
+
from?: string;
|
|
5962
|
+
/**
|
|
5963
|
+
* Last day of an explicit range, INCLUSIVE, as a whole date YYYY-MM-DD in the site's reporting timezone - so `from=2026-03-01&to=2026-03-31` covers all of March. The comparison window is the same number of days immediately before the range, exactly as it is for a preset. A range may span at most 366 days: these are metered queries, the comparison window doubles the scan, and 366 covers a year-over-year question including a leap year. A longer span is refused with `range_invalid` rather than trimmed, because a silently shortened window is a number the caller would quote as the one they asked for.
|
|
5964
|
+
*/
|
|
5965
|
+
to?: string;
|
|
5966
|
+
};
|
|
5967
|
+
url: "/api/v1/analytics/funnels/{id}/report";
|
|
5767
5968
|
};
|
|
5768
|
-
type
|
|
5769
|
-
/**
|
|
5770
|
-
* Site tokens are not permitted
|
|
5771
|
-
*/
|
|
5772
|
-
403: unknown;
|
|
5969
|
+
type GetAnalyticsFunnelReportErrors = {
|
|
5773
5970
|
/**
|
|
5774
|
-
*
|
|
5971
|
+
* site_id mismatch / unsupported period / a step's goal is gone / the range ends before the funnel's steps existed
|
|
5775
5972
|
*/
|
|
5776
|
-
|
|
5973
|
+
400: unknown;
|
|
5777
5974
|
/**
|
|
5778
|
-
*
|
|
5975
|
+
* Missing or invalid token
|
|
5779
5976
|
*/
|
|
5780
|
-
|
|
5977
|
+
401: unknown;
|
|
5781
5978
|
/**
|
|
5782
|
-
*
|
|
5979
|
+
* No such funnel on this site
|
|
5783
5980
|
*/
|
|
5784
|
-
|
|
5981
|
+
404: unknown;
|
|
5785
5982
|
};
|
|
5786
|
-
type
|
|
5983
|
+
type GetAnalyticsFunnelReportResponses = {
|
|
5787
5984
|
/**
|
|
5788
|
-
*
|
|
5985
|
+
* Funnel steps, or an unreachable source
|
|
5789
5986
|
*/
|
|
5790
|
-
200:
|
|
5987
|
+
200: {
|
|
5988
|
+
status: "ok";
|
|
5989
|
+
/**
|
|
5990
|
+
* One row per declared step, in order.
|
|
5991
|
+
*/
|
|
5992
|
+
data: Array<{
|
|
5993
|
+
/**
|
|
5994
|
+
* 1-based and always dense.
|
|
5995
|
+
*/
|
|
5996
|
+
position: number;
|
|
5997
|
+
/**
|
|
5998
|
+
* The step's goal, by display name.
|
|
5999
|
+
*/
|
|
6000
|
+
goal: string;
|
|
6001
|
+
/**
|
|
6002
|
+
* Visitors who reached AT LEAST this step, in order. Cumulative, because that is what a drop-off is measured from.
|
|
6003
|
+
*/
|
|
6004
|
+
visitors: number;
|
|
6005
|
+
/**
|
|
6006
|
+
* Visitors who reached the previous step and not this one. Zero at step one, which has no previous step.
|
|
6007
|
+
*/
|
|
6008
|
+
dropoff: number;
|
|
6009
|
+
/**
|
|
6010
|
+
* dropoff as a fraction of the PREVIOUS step's visitors. Null at step one, and null when the previous step had no visitors — a drop-off out of zero is undefined, not 100%.
|
|
6011
|
+
*/
|
|
6012
|
+
dropoff_rate: number | null;
|
|
6013
|
+
/**
|
|
6014
|
+
* visitors as a fraction of STEP ONE's visitors — not of site-wide visitors. A funnel's rate is about the path; the conversions report is the one that divides by site-wide uniques. Null when nobody entered.
|
|
6015
|
+
*/
|
|
6016
|
+
conversion_rate: number | null;
|
|
6017
|
+
}>;
|
|
6018
|
+
/**
|
|
6019
|
+
* The half-open UTC window the values were measured over: from inclusive, to exclusive. Resolved from the site's reporting timezone.
|
|
6020
|
+
*/
|
|
6021
|
+
window: {
|
|
6022
|
+
from: string;
|
|
6023
|
+
to: string;
|
|
6024
|
+
};
|
|
6025
|
+
funnel: {
|
|
6026
|
+
id: string;
|
|
6027
|
+
display_name: string;
|
|
6028
|
+
};
|
|
6029
|
+
/**
|
|
6030
|
+
* Visitors in the window who matched NO step. Not a step and not cumulative: it is what makes step one's rate honest, since step one alone cannot tell a funnel nobody entered from one everybody completed.
|
|
6031
|
+
*/
|
|
6032
|
+
never_entered: number;
|
|
6033
|
+
/**
|
|
6034
|
+
* Unique visitors on the site for the window, for context only. Deliberately NOT the denominator of any rate above.
|
|
6035
|
+
*/
|
|
6036
|
+
site_visitors: number;
|
|
6037
|
+
/**
|
|
6038
|
+
* The window you ASKED for, when it differs from the one above, and null when nothing was shortened. A funnel is clamped to the first date EVERY step could have fired, because drop-off is a comparison between steps: a window reaching back before one step's instrumentation counts entrants at step one from days the later step could not fire and reports the difference as people who dropped out. The number is therefore moved rather than annotated — render this whenever it is non-null, because a merchant asking why their 90-day funnel starts in October deserves the answer, and a client comparing two periods must not compare one it asked for against one it did not.
|
|
6039
|
+
*/
|
|
6040
|
+
requested_window: {
|
|
6041
|
+
from: string;
|
|
6042
|
+
to: string;
|
|
6043
|
+
} | null;
|
|
6044
|
+
/**
|
|
6045
|
+
* The step date that set the floor, when the window was clamped. Non-null exactly when `requested_window` is. A funnel ending on `Purchase` or `Form: Received` cannot report on days before those events were being written — see `counts_from` on the conversions report, which is the same fact stated as a caveat where a caveat is enough.
|
|
6046
|
+
*/
|
|
6047
|
+
coverage_from: string | null;
|
|
6048
|
+
/**
|
|
6049
|
+
* The hard limit of what a funnel can observe, in the response rather than only in the docs (R13). It bounds each SEQUENCE, not the report: the report covers the whole window in `window` — which is not always the one you asked for, see `requested_window` — but one visitor's run through the steps must finish within 24 hours AND within one visitor identity, which rotates daily. So a 90-day report counts completions from all 90 days, and a visitor who starts the path before midnight and finishes after it is not one of them. Render this wherever you render the funnel.
|
|
6050
|
+
*/
|
|
6051
|
+
bounded_to: "visitor-day";
|
|
6052
|
+
} | {
|
|
6053
|
+
status: "unreachable";
|
|
6054
|
+
};
|
|
5791
6055
|
};
|
|
5792
|
-
type
|
|
5793
|
-
type
|
|
5794
|
-
body?:
|
|
5795
|
-
path
|
|
5796
|
-
|
|
6056
|
+
type GetAnalyticsFunnelReportResponse = GetAnalyticsFunnelReportResponses[keyof GetAnalyticsFunnelReportResponses];
|
|
6057
|
+
type ListAnalyticsGoalsData = {
|
|
6058
|
+
body?: never;
|
|
6059
|
+
path?: never;
|
|
6060
|
+
query?: {
|
|
6061
|
+
site_id?: string;
|
|
5797
6062
|
};
|
|
5798
|
-
|
|
5799
|
-
url: "/api/v1/sites/{siteId}/subscriptions/teardown";
|
|
6063
|
+
url: "/api/v1/analytics/goals";
|
|
5800
6064
|
};
|
|
5801
|
-
type
|
|
6065
|
+
type ListAnalyticsGoalsErrors = {
|
|
5802
6066
|
/**
|
|
5803
|
-
*
|
|
6067
|
+
* site_id mismatch
|
|
5804
6068
|
*/
|
|
5805
|
-
|
|
6069
|
+
400: unknown;
|
|
5806
6070
|
/**
|
|
5807
|
-
*
|
|
6071
|
+
* Missing or invalid token
|
|
5808
6072
|
*/
|
|
5809
|
-
|
|
6073
|
+
401: unknown;
|
|
5810
6074
|
};
|
|
5811
|
-
type
|
|
5812
|
-
type TeardownSiteSubscriptionsResponses = {
|
|
6075
|
+
type ListAnalyticsGoalsResponses = {
|
|
5813
6076
|
/**
|
|
5814
|
-
*
|
|
6077
|
+
* Goals
|
|
5815
6078
|
*/
|
|
5816
|
-
200:
|
|
6079
|
+
200: AnalyticsGoalList;
|
|
5817
6080
|
};
|
|
5818
|
-
type
|
|
5819
|
-
type
|
|
5820
|
-
body?:
|
|
5821
|
-
path
|
|
5822
|
-
|
|
6081
|
+
type ListAnalyticsGoalsResponse = ListAnalyticsGoalsResponses[keyof ListAnalyticsGoalsResponses];
|
|
6082
|
+
type CreateAnalyticsGoalData = {
|
|
6083
|
+
body?: AnalyticsGoalInput;
|
|
6084
|
+
path?: never;
|
|
6085
|
+
query?: {
|
|
6086
|
+
site_id?: string;
|
|
5823
6087
|
};
|
|
5824
|
-
|
|
5825
|
-
url: "/api/v1/sites/{siteId}/subscriptions/reactivate-teardown";
|
|
6088
|
+
url: "/api/v1/analytics/goals";
|
|
5826
6089
|
};
|
|
5827
|
-
type
|
|
6090
|
+
type CreateAnalyticsGoalErrors = {
|
|
5828
6091
|
/**
|
|
5829
|
-
*
|
|
6092
|
+
* Invalid goal, or site_id mismatch
|
|
5830
6093
|
*/
|
|
5831
|
-
400:
|
|
6094
|
+
400: unknown;
|
|
5832
6095
|
/**
|
|
5833
|
-
*
|
|
6096
|
+
* Missing or invalid token
|
|
5834
6097
|
*/
|
|
5835
|
-
|
|
6098
|
+
401: unknown;
|
|
5836
6099
|
/**
|
|
5837
|
-
*
|
|
6100
|
+
* Duplicate name, or the per-site goal limit is reached
|
|
5838
6101
|
*/
|
|
5839
|
-
|
|
6102
|
+
409: unknown;
|
|
6103
|
+
};
|
|
6104
|
+
type CreateAnalyticsGoalResponses = {
|
|
5840
6105
|
/**
|
|
5841
|
-
*
|
|
6106
|
+
* Created
|
|
5842
6107
|
*/
|
|
5843
|
-
|
|
6108
|
+
201: AnalyticsGoal;
|
|
5844
6109
|
};
|
|
5845
|
-
type
|
|
5846
|
-
type
|
|
6110
|
+
type CreateAnalyticsGoalResponse = CreateAnalyticsGoalResponses[keyof CreateAnalyticsGoalResponses];
|
|
6111
|
+
type DeleteAnalyticsGoalData = {
|
|
6112
|
+
body?: never;
|
|
6113
|
+
path: {
|
|
6114
|
+
id: string;
|
|
6115
|
+
};
|
|
6116
|
+
query?: {
|
|
6117
|
+
site_id?: string;
|
|
6118
|
+
};
|
|
6119
|
+
url: "/api/v1/analytics/goals/{id}";
|
|
6120
|
+
};
|
|
6121
|
+
type DeleteAnalyticsGoalErrors = {
|
|
5847
6122
|
/**
|
|
5848
|
-
*
|
|
6123
|
+
* site_id mismatch
|
|
5849
6124
|
*/
|
|
5850
|
-
|
|
6125
|
+
400: unknown;
|
|
6126
|
+
/**
|
|
6127
|
+
* Missing or invalid token
|
|
6128
|
+
*/
|
|
6129
|
+
401: unknown;
|
|
6130
|
+
/**
|
|
6131
|
+
* No such goal on this site
|
|
6132
|
+
*/
|
|
6133
|
+
404: unknown;
|
|
5851
6134
|
};
|
|
5852
|
-
type
|
|
5853
|
-
|
|
5854
|
-
|
|
6135
|
+
type DeleteAnalyticsGoalResponses = {
|
|
6136
|
+
/**
|
|
6137
|
+
* Deleted
|
|
6138
|
+
*/
|
|
6139
|
+
204: void;
|
|
6140
|
+
};
|
|
6141
|
+
type DeleteAnalyticsGoalResponse = DeleteAnalyticsGoalResponses[keyof DeleteAnalyticsGoalResponses];
|
|
6142
|
+
type UpdateAnalyticsGoalData = {
|
|
6143
|
+
body?: AnalyticsGoalInput;
|
|
5855
6144
|
path: {
|
|
5856
|
-
|
|
6145
|
+
id: string;
|
|
5857
6146
|
};
|
|
5858
|
-
query?:
|
|
5859
|
-
|
|
6147
|
+
query?: {
|
|
6148
|
+
site_id?: string;
|
|
6149
|
+
};
|
|
6150
|
+
url: "/api/v1/analytics/goals/{id}";
|
|
5860
6151
|
};
|
|
5861
|
-
type
|
|
6152
|
+
type UpdateAnalyticsGoalErrors = {
|
|
5862
6153
|
/**
|
|
5863
|
-
*
|
|
6154
|
+
* Invalid goal, or site_id mismatch
|
|
5864
6155
|
*/
|
|
5865
|
-
|
|
6156
|
+
400: unknown;
|
|
5866
6157
|
/**
|
|
5867
|
-
*
|
|
6158
|
+
* Missing or invalid token
|
|
5868
6159
|
*/
|
|
5869
|
-
|
|
6160
|
+
401: unknown;
|
|
5870
6161
|
/**
|
|
5871
|
-
*
|
|
6162
|
+
* No such goal on this site
|
|
5872
6163
|
*/
|
|
5873
|
-
404:
|
|
6164
|
+
404: unknown;
|
|
5874
6165
|
/**
|
|
5875
|
-
*
|
|
6166
|
+
* Duplicate name
|
|
5876
6167
|
*/
|
|
5877
|
-
|
|
6168
|
+
409: unknown;
|
|
5878
6169
|
};
|
|
5879
|
-
type
|
|
5880
|
-
type CreatePreviewSessionResponses = {
|
|
6170
|
+
type UpdateAnalyticsGoalResponses = {
|
|
5881
6171
|
/**
|
|
5882
|
-
*
|
|
6172
|
+
* Updated
|
|
5883
6173
|
*/
|
|
5884
|
-
200:
|
|
6174
|
+
200: AnalyticsGoal;
|
|
5885
6175
|
};
|
|
5886
|
-
type
|
|
5887
|
-
type
|
|
6176
|
+
type UpdateAnalyticsGoalResponse = UpdateAnalyticsGoalResponses[keyof UpdateAnalyticsGoalResponses];
|
|
6177
|
+
type ListAnalyticsFunnelsData = {
|
|
5888
6178
|
body?: never;
|
|
5889
6179
|
path?: never;
|
|
5890
6180
|
query?: {
|
|
5891
6181
|
site_id?: string;
|
|
5892
|
-
/**
|
|
5893
|
-
* Comma-separated derived labels to keep (awaiting_payment, overdue, paid, voided, …)
|
|
5894
|
-
*/
|
|
5895
|
-
label?: string;
|
|
5896
|
-
/**
|
|
5897
|
-
* Comma-separated raw statuses
|
|
5898
|
-
*/
|
|
5899
|
-
status?: string;
|
|
5900
|
-
customer_email?: string;
|
|
5901
|
-
customer_id?: string;
|
|
5902
|
-
retainer_id?: string;
|
|
5903
|
-
/**
|
|
5904
|
-
* Case-insensitive substring on the invoice number, the recipient's name or email — "ACME-0007", "bob"
|
|
5905
|
-
*/
|
|
5906
|
-
q?: string;
|
|
5907
|
-
/**
|
|
5908
|
-
* Created on/after (YYYY-MM-DD)
|
|
5909
|
-
*/
|
|
5910
|
-
from?: string;
|
|
5911
|
-
/**
|
|
5912
|
-
* Created on/before (YYYY-MM-DD)
|
|
5913
|
-
*/
|
|
5914
|
-
to?: string;
|
|
5915
|
-
include?: string;
|
|
5916
|
-
limit?: string;
|
|
5917
|
-
offset?: string;
|
|
5918
6182
|
};
|
|
5919
|
-
url: "/api/v1/
|
|
6183
|
+
url: "/api/v1/analytics/funnels";
|
|
5920
6184
|
};
|
|
5921
|
-
type
|
|
6185
|
+
type ListAnalyticsFunnelsErrors = {
|
|
5922
6186
|
/**
|
|
5923
|
-
*
|
|
6187
|
+
* site_id mismatch
|
|
5924
6188
|
*/
|
|
5925
|
-
400:
|
|
6189
|
+
400: unknown;
|
|
5926
6190
|
/**
|
|
5927
|
-
*
|
|
6191
|
+
* Missing or invalid token
|
|
5928
6192
|
*/
|
|
5929
|
-
401:
|
|
6193
|
+
401: unknown;
|
|
5930
6194
|
};
|
|
5931
|
-
type
|
|
5932
|
-
type ListInvoicesResponses = {
|
|
6195
|
+
type ListAnalyticsFunnelsResponses = {
|
|
5933
6196
|
/**
|
|
5934
|
-
*
|
|
6197
|
+
* Funnels for the site
|
|
5935
6198
|
*/
|
|
5936
|
-
200:
|
|
6199
|
+
200: {
|
|
6200
|
+
funnels: Array<AnalyticsFunnel>;
|
|
6201
|
+
limit: number;
|
|
6202
|
+
defined: number;
|
|
6203
|
+
};
|
|
5937
6204
|
};
|
|
5938
|
-
type
|
|
5939
|
-
type
|
|
5940
|
-
body
|
|
6205
|
+
type ListAnalyticsFunnelsResponse = ListAnalyticsFunnelsResponses[keyof ListAnalyticsFunnelsResponses];
|
|
6206
|
+
type CreateAnalyticsFunnelData = {
|
|
6207
|
+
body?: AnalyticsFunnelInput;
|
|
5941
6208
|
path?: never;
|
|
5942
|
-
query?:
|
|
5943
|
-
|
|
6209
|
+
query?: {
|
|
6210
|
+
site_id?: string;
|
|
6211
|
+
};
|
|
6212
|
+
url: "/api/v1/analytics/funnels";
|
|
5944
6213
|
};
|
|
5945
|
-
type
|
|
5946
|
-
/**
|
|
5947
|
-
* Invalid input, content rule, or billing_address_required
|
|
5948
|
-
*/
|
|
5949
|
-
400: InvoiceError;
|
|
6214
|
+
type CreateAnalyticsFunnelErrors = {
|
|
5950
6215
|
/**
|
|
5951
|
-
*
|
|
6216
|
+
* Invalid definition
|
|
5952
6217
|
*/
|
|
5953
|
-
|
|
6218
|
+
400: unknown;
|
|
5954
6219
|
/**
|
|
5955
|
-
*
|
|
6220
|
+
* Missing or invalid token
|
|
5956
6221
|
*/
|
|
5957
|
-
|
|
6222
|
+
401: unknown;
|
|
5958
6223
|
/**
|
|
5959
|
-
*
|
|
6224
|
+
* Duplicate name, or the per-site limit is reached
|
|
5960
6225
|
*/
|
|
5961
|
-
|
|
6226
|
+
409: unknown;
|
|
6227
|
+
};
|
|
6228
|
+
type CreateAnalyticsFunnelResponses = {
|
|
5962
6229
|
/**
|
|
5963
|
-
*
|
|
6230
|
+
* Created
|
|
5964
6231
|
*/
|
|
5965
|
-
|
|
6232
|
+
201: AnalyticsFunnel;
|
|
6233
|
+
};
|
|
6234
|
+
type CreateAnalyticsFunnelResponse = CreateAnalyticsFunnelResponses[keyof CreateAnalyticsFunnelResponses];
|
|
6235
|
+
type DeleteAnalyticsFunnelData = {
|
|
6236
|
+
body?: never;
|
|
6237
|
+
path: {
|
|
6238
|
+
id: string;
|
|
6239
|
+
};
|
|
6240
|
+
query?: {
|
|
6241
|
+
site_id?: string;
|
|
6242
|
+
};
|
|
6243
|
+
url: "/api/v1/analytics/funnels/{id}";
|
|
6244
|
+
};
|
|
6245
|
+
type DeleteAnalyticsFunnelErrors = {
|
|
5966
6246
|
/**
|
|
5967
|
-
*
|
|
6247
|
+
* Missing or invalid token
|
|
5968
6248
|
*/
|
|
5969
|
-
|
|
6249
|
+
401: unknown;
|
|
5970
6250
|
/**
|
|
5971
|
-
*
|
|
6251
|
+
* No such funnel on this site
|
|
5972
6252
|
*/
|
|
5973
|
-
|
|
6253
|
+
404: unknown;
|
|
5974
6254
|
};
|
|
5975
|
-
type
|
|
5976
|
-
type CreateInvoiceResponses = {
|
|
5977
|
-
/**
|
|
5978
|
-
* Created and sent
|
|
5979
|
-
*/
|
|
5980
|
-
201: CreateInvoiceResult;
|
|
6255
|
+
type DeleteAnalyticsFunnelResponses = {
|
|
5981
6256
|
/**
|
|
5982
|
-
*
|
|
6257
|
+
* Deleted
|
|
5983
6258
|
*/
|
|
5984
|
-
|
|
6259
|
+
204: void;
|
|
5985
6260
|
};
|
|
5986
|
-
type
|
|
5987
|
-
type
|
|
5988
|
-
body?:
|
|
6261
|
+
type DeleteAnalyticsFunnelResponse = DeleteAnalyticsFunnelResponses[keyof DeleteAnalyticsFunnelResponses];
|
|
6262
|
+
type UpdateAnalyticsFunnelData = {
|
|
6263
|
+
body?: AnalyticsFunnelPatch;
|
|
5989
6264
|
path: {
|
|
5990
|
-
|
|
6265
|
+
id: string;
|
|
5991
6266
|
};
|
|
5992
|
-
query?:
|
|
5993
|
-
|
|
6267
|
+
query?: {
|
|
6268
|
+
site_id?: string;
|
|
6269
|
+
};
|
|
6270
|
+
url: "/api/v1/analytics/funnels/{id}";
|
|
5994
6271
|
};
|
|
5995
|
-
type
|
|
6272
|
+
type UpdateAnalyticsFunnelErrors = {
|
|
5996
6273
|
/**
|
|
5997
|
-
*
|
|
6274
|
+
* Invalid definition, or a patch with neither field
|
|
5998
6275
|
*/
|
|
5999
|
-
|
|
6276
|
+
400: unknown;
|
|
6000
6277
|
/**
|
|
6001
|
-
*
|
|
6278
|
+
* Missing or invalid token
|
|
6002
6279
|
*/
|
|
6003
|
-
|
|
6280
|
+
401: unknown;
|
|
6281
|
+
/**
|
|
6282
|
+
* No such funnel on this site
|
|
6283
|
+
*/
|
|
6284
|
+
404: unknown;
|
|
6285
|
+
/**
|
|
6286
|
+
* Duplicate name
|
|
6287
|
+
*/
|
|
6288
|
+
409: unknown;
|
|
6004
6289
|
};
|
|
6005
|
-
type
|
|
6006
|
-
type GetInvoiceResponses = {
|
|
6290
|
+
type UpdateAnalyticsFunnelResponses = {
|
|
6007
6291
|
/**
|
|
6008
|
-
*
|
|
6292
|
+
* Updated
|
|
6009
6293
|
*/
|
|
6010
|
-
200:
|
|
6294
|
+
200: AnalyticsFunnel;
|
|
6011
6295
|
};
|
|
6012
|
-
type
|
|
6013
|
-
type
|
|
6014
|
-
body
|
|
6296
|
+
type UpdateAnalyticsFunnelResponse = UpdateAnalyticsFunnelResponses[keyof UpdateAnalyticsFunnelResponses];
|
|
6297
|
+
type ListSubscriptionsData = {
|
|
6298
|
+
body?: never;
|
|
6299
|
+
path?: never;
|
|
6300
|
+
query?: {
|
|
6301
|
+
/**
|
|
6302
|
+
* Required with an org key (sk_xxx); must match the token's site when using a site token.
|
|
6303
|
+
*/
|
|
6015
6304
|
site_id?: string;
|
|
6305
|
+
/**
|
|
6306
|
+
* Exact status filter (verbatim Stripe values).
|
|
6307
|
+
*/
|
|
6308
|
+
status?: string;
|
|
6309
|
+
/**
|
|
6310
|
+
* Max rows (default 50, max 100).
|
|
6311
|
+
*/
|
|
6312
|
+
limit?: string;
|
|
6313
|
+
offset?: string;
|
|
6016
6314
|
};
|
|
6017
|
-
|
|
6018
|
-
query?: never;
|
|
6019
|
-
url: "/api/v1/invoices/preview";
|
|
6315
|
+
url: "/api/v1/subscriptions";
|
|
6020
6316
|
};
|
|
6021
|
-
type
|
|
6317
|
+
type ListSubscriptionsErrors = {
|
|
6022
6318
|
/**
|
|
6023
|
-
*
|
|
6319
|
+
* site_id mismatch / does not belong to this organization
|
|
6024
6320
|
*/
|
|
6025
|
-
400:
|
|
6321
|
+
400: unknown;
|
|
6026
6322
|
/**
|
|
6027
|
-
*
|
|
6323
|
+
* Missing or invalid token
|
|
6028
6324
|
*/
|
|
6029
|
-
401:
|
|
6325
|
+
401: unknown;
|
|
6030
6326
|
};
|
|
6031
|
-
type
|
|
6032
|
-
type PreviewInvoiceResponses = {
|
|
6327
|
+
type ListSubscriptionsResponses = {
|
|
6033
6328
|
/**
|
|
6034
|
-
*
|
|
6329
|
+
* The subscriptions
|
|
6035
6330
|
*/
|
|
6036
|
-
200:
|
|
6331
|
+
200: SubscriptionsList;
|
|
6037
6332
|
};
|
|
6038
|
-
type
|
|
6039
|
-
type
|
|
6333
|
+
type ListSubscriptionsResponse = ListSubscriptionsResponses[keyof ListSubscriptionsResponses];
|
|
6334
|
+
type CancelSubscriptionData = {
|
|
6040
6335
|
body?: never;
|
|
6041
6336
|
path: {
|
|
6042
|
-
|
|
6337
|
+
subscriptionId: string;
|
|
6043
6338
|
};
|
|
6044
6339
|
query?: never;
|
|
6045
|
-
url: "/api/v1/
|
|
6340
|
+
url: "/api/v1/subscriptions/{subscriptionId}/cancel";
|
|
6046
6341
|
};
|
|
6047
|
-
type
|
|
6342
|
+
type CancelSubscriptionErrors = {
|
|
6048
6343
|
/**
|
|
6049
|
-
*
|
|
6344
|
+
* Site tokens are not permitted
|
|
6050
6345
|
*/
|
|
6051
|
-
|
|
6346
|
+
403: unknown;
|
|
6052
6347
|
/**
|
|
6053
|
-
*
|
|
6348
|
+
* Subscription not found (or belongs to another org)
|
|
6054
6349
|
*/
|
|
6055
|
-
404:
|
|
6056
|
-
};
|
|
6057
|
-
type GetInvoicePreviewError = GetInvoicePreviewErrors[keyof GetInvoicePreviewErrors];
|
|
6058
|
-
type GetInvoicePreviewResponses = {
|
|
6350
|
+
404: unknown;
|
|
6059
6351
|
/**
|
|
6060
|
-
*
|
|
6352
|
+
* Subscription already ended (code ended) — terminal locally, or Stripe says it is already canceled
|
|
6061
6353
|
*/
|
|
6062
|
-
|
|
6063
|
-
|
|
6064
|
-
|
|
6065
|
-
|
|
6066
|
-
|
|
6354
|
+
409: unknown;
|
|
6355
|
+
/**
|
|
6356
|
+
* Stripe unreachable — retry
|
|
6357
|
+
*/
|
|
6358
|
+
502: unknown;
|
|
6359
|
+
};
|
|
6360
|
+
type CancelSubscriptionResponses = {
|
|
6361
|
+
/**
|
|
6362
|
+
* The updated subscription
|
|
6363
|
+
*/
|
|
6364
|
+
200: SubscriptionSummary;
|
|
6365
|
+
};
|
|
6366
|
+
type CancelSubscriptionResponse = CancelSubscriptionResponses[keyof CancelSubscriptionResponses];
|
|
6367
|
+
type TeardownSiteSubscriptionsData = {
|
|
6368
|
+
body?: SubscriptionsTeardownBody;
|
|
6067
6369
|
path: {
|
|
6068
|
-
|
|
6370
|
+
siteId: string;
|
|
6069
6371
|
};
|
|
6070
6372
|
query?: never;
|
|
6071
|
-
url: "/api/v1/
|
|
6373
|
+
url: "/api/v1/sites/{siteId}/subscriptions/teardown";
|
|
6072
6374
|
};
|
|
6073
|
-
type
|
|
6375
|
+
type TeardownSiteSubscriptionsErrors = {
|
|
6074
6376
|
/**
|
|
6075
|
-
*
|
|
6377
|
+
* Site tokens are not permitted
|
|
6076
6378
|
*/
|
|
6077
|
-
|
|
6379
|
+
403: unknown;
|
|
6078
6380
|
/**
|
|
6079
|
-
*
|
|
6381
|
+
* Site not found. `code` distinguishes the two cases: 'site_not_found' (no such site — terminal, stop retrying) vs 'site_not_accessible' (the site exists but belongs to another organization — your key is wrong or rotated, so RETRY rather than discarding state).
|
|
6080
6382
|
*/
|
|
6081
|
-
|
|
6383
|
+
404: Error;
|
|
6384
|
+
};
|
|
6385
|
+
type TeardownSiteSubscriptionsError = TeardownSiteSubscriptionsErrors[keyof TeardownSiteSubscriptionsErrors];
|
|
6386
|
+
type TeardownSiteSubscriptionsResponses = {
|
|
6082
6387
|
/**
|
|
6083
|
-
*
|
|
6388
|
+
* Teardown outcome
|
|
6084
6389
|
*/
|
|
6085
|
-
|
|
6390
|
+
200: SubscriptionsTeardownResult;
|
|
6391
|
+
};
|
|
6392
|
+
type TeardownSiteSubscriptionsResponse = TeardownSiteSubscriptionsResponses[keyof TeardownSiteSubscriptionsResponses];
|
|
6393
|
+
type ReactivateSiteSubscriptionsTeardownData = {
|
|
6394
|
+
body?: SubscriptionsReactivateBody;
|
|
6395
|
+
path: {
|
|
6396
|
+
siteId: string;
|
|
6397
|
+
};
|
|
6398
|
+
query?: never;
|
|
6399
|
+
url: "/api/v1/sites/{siteId}/subscriptions/reactivate-teardown";
|
|
6400
|
+
};
|
|
6401
|
+
type ReactivateSiteSubscriptionsTeardownErrors = {
|
|
6086
6402
|
/**
|
|
6087
|
-
*
|
|
6403
|
+
* Unknown key in the body (a misspelled `reason` is refused, never ignored)
|
|
6088
6404
|
*/
|
|
6089
|
-
|
|
6405
|
+
400: Error;
|
|
6090
6406
|
/**
|
|
6091
|
-
*
|
|
6407
|
+
* Site tokens are not permitted
|
|
6092
6408
|
*/
|
|
6093
|
-
|
|
6409
|
+
403: unknown;
|
|
6094
6410
|
/**
|
|
6095
|
-
*
|
|
6411
|
+
* Site not found. `code` distinguishes the two cases: 'site_not_found' (no such site — terminal) vs 'site_not_accessible' (exists, another organization — wrong or rotated key, retry).
|
|
6096
6412
|
*/
|
|
6097
|
-
|
|
6413
|
+
404: Error;
|
|
6098
6414
|
/**
|
|
6099
|
-
*
|
|
6415
|
+
* The site is soft-deleted (`code: 'site_deleted'`): a deleted store never resumes charging, so nothing is reactivated. Terminal for the caller — a restore (clearing deleted_at) is a support action.
|
|
6100
6416
|
*/
|
|
6101
|
-
|
|
6417
|
+
409: Error;
|
|
6102
6418
|
};
|
|
6103
|
-
type
|
|
6104
|
-
type
|
|
6419
|
+
type ReactivateSiteSubscriptionsTeardownError = ReactivateSiteSubscriptionsTeardownErrors[keyof ReactivateSiteSubscriptionsTeardownErrors];
|
|
6420
|
+
type ReactivateSiteSubscriptionsTeardownResponses = {
|
|
6105
6421
|
/**
|
|
6106
|
-
*
|
|
6422
|
+
* Reactivation outcome
|
|
6107
6423
|
*/
|
|
6108
|
-
200:
|
|
6424
|
+
200: SubscriptionsReactivateResult;
|
|
6109
6425
|
};
|
|
6110
|
-
type
|
|
6111
|
-
type
|
|
6112
|
-
body:
|
|
6426
|
+
type ReactivateSiteSubscriptionsTeardownResponse = ReactivateSiteSubscriptionsTeardownResponses[keyof ReactivateSiteSubscriptionsTeardownResponses];
|
|
6427
|
+
type CreatePreviewSessionData = {
|
|
6428
|
+
body: CreatePreviewSession;
|
|
6113
6429
|
path: {
|
|
6114
|
-
|
|
6430
|
+
siteId: string;
|
|
6115
6431
|
};
|
|
6116
6432
|
query?: never;
|
|
6117
|
-
url: "/api/v1/
|
|
6433
|
+
url: "/api/v1/sites/{siteId}/preview-session";
|
|
6118
6434
|
};
|
|
6119
|
-
type
|
|
6435
|
+
type CreatePreviewSessionErrors = {
|
|
6120
6436
|
/**
|
|
6121
|
-
*
|
|
6437
|
+
* Unauthorized
|
|
6122
6438
|
*/
|
|
6123
|
-
|
|
6439
|
+
401: unknown;
|
|
6124
6440
|
/**
|
|
6125
|
-
*
|
|
6441
|
+
* Site tokens are not permitted — org API key only
|
|
6126
6442
|
*/
|
|
6127
|
-
|
|
6443
|
+
403: unknown;
|
|
6128
6444
|
/**
|
|
6129
|
-
* Site
|
|
6445
|
+
* Site not found — `code` is 'site_not_found' (no such site) or 'site_not_accessible' (another organization's site).
|
|
6130
6446
|
*/
|
|
6131
|
-
|
|
6447
|
+
404: Error;
|
|
6132
6448
|
/**
|
|
6133
|
-
*
|
|
6449
|
+
* Preview customer record could not be created
|
|
6134
6450
|
*/
|
|
6135
|
-
|
|
6451
|
+
500: unknown;
|
|
6452
|
+
};
|
|
6453
|
+
type CreatePreviewSessionError = CreatePreviewSessionErrors[keyof CreatePreviewSessionErrors];
|
|
6454
|
+
type CreatePreviewSessionResponses = {
|
|
6136
6455
|
/**
|
|
6137
|
-
*
|
|
6456
|
+
* Preview session minted
|
|
6138
6457
|
*/
|
|
6139
|
-
|
|
6458
|
+
200: PreviewSessionResult;
|
|
6459
|
+
};
|
|
6460
|
+
type CreatePreviewSessionResponse = CreatePreviewSessionResponses[keyof CreatePreviewSessionResponses];
|
|
6461
|
+
type ListInvoicesData = {
|
|
6462
|
+
body?: never;
|
|
6463
|
+
path?: never;
|
|
6464
|
+
query?: {
|
|
6465
|
+
site_id?: string;
|
|
6466
|
+
/**
|
|
6467
|
+
* Comma-separated derived labels to keep (awaiting_payment, overdue, paid, voided, …)
|
|
6468
|
+
*/
|
|
6469
|
+
label?: string;
|
|
6470
|
+
/**
|
|
6471
|
+
* Comma-separated raw statuses
|
|
6472
|
+
*/
|
|
6473
|
+
status?: string;
|
|
6474
|
+
customer_email?: string;
|
|
6475
|
+
customer_id?: string;
|
|
6476
|
+
retainer_id?: string;
|
|
6477
|
+
/**
|
|
6478
|
+
* Case-insensitive substring on the invoice number, the recipient's name or email — "ACME-0007", "bob"
|
|
6479
|
+
*/
|
|
6480
|
+
q?: string;
|
|
6481
|
+
/**
|
|
6482
|
+
* Created on/after (YYYY-MM-DD)
|
|
6483
|
+
*/
|
|
6484
|
+
from?: string;
|
|
6485
|
+
/**
|
|
6486
|
+
* Created on/before (YYYY-MM-DD)
|
|
6487
|
+
*/
|
|
6488
|
+
to?: string;
|
|
6489
|
+
include?: string;
|
|
6490
|
+
limit?: string;
|
|
6491
|
+
offset?: string;
|
|
6492
|
+
};
|
|
6493
|
+
url: "/api/v1/invoices";
|
|
6494
|
+
};
|
|
6495
|
+
type ListInvoicesErrors = {
|
|
6140
6496
|
/**
|
|
6141
|
-
*
|
|
6497
|
+
* Bad scope
|
|
6142
6498
|
*/
|
|
6143
|
-
|
|
6499
|
+
400: InvoiceError;
|
|
6144
6500
|
/**
|
|
6145
|
-
*
|
|
6501
|
+
* Unauthorized
|
|
6146
6502
|
*/
|
|
6147
|
-
|
|
6503
|
+
401: InvoiceError;
|
|
6148
6504
|
};
|
|
6149
|
-
type
|
|
6150
|
-
type
|
|
6505
|
+
type ListInvoicesError = ListInvoicesErrors[keyof ListInvoicesErrors];
|
|
6506
|
+
type ListInvoicesResponses = {
|
|
6151
6507
|
/**
|
|
6152
|
-
*
|
|
6508
|
+
* Invoices
|
|
6153
6509
|
*/
|
|
6154
|
-
|
|
6510
|
+
200: InvoicesList;
|
|
6155
6511
|
};
|
|
6156
|
-
type
|
|
6157
|
-
type
|
|
6158
|
-
body:
|
|
6159
|
-
path
|
|
6160
|
-
invoiceId: string;
|
|
6161
|
-
};
|
|
6512
|
+
type ListInvoicesResponse = ListInvoicesResponses[keyof ListInvoicesResponses];
|
|
6513
|
+
type CreateInvoiceData = {
|
|
6514
|
+
body: CreateInvoice;
|
|
6515
|
+
path?: never;
|
|
6162
6516
|
query?: never;
|
|
6163
|
-
url: "/api/v1/invoices
|
|
6517
|
+
url: "/api/v1/invoices";
|
|
6164
6518
|
};
|
|
6165
|
-
type
|
|
6519
|
+
type CreateInvoiceErrors = {
|
|
6166
6520
|
/**
|
|
6167
|
-
* Invalid
|
|
6521
|
+
* Invalid input, content rule, or billing_address_required
|
|
6168
6522
|
*/
|
|
6169
6523
|
400: InvoiceError;
|
|
6170
6524
|
/**
|
|
@@ -6184,91 +6538,311 @@ type RemindInvoiceErrors = {
|
|
|
6184
6538
|
*/
|
|
6185
6539
|
409: InvoiceError;
|
|
6186
6540
|
/**
|
|
6187
|
-
*
|
|
6541
|
+
* Per-site invoice budget exceeded
|
|
6188
6542
|
*/
|
|
6189
|
-
429:
|
|
6543
|
+
429: InvoiceError;
|
|
6190
6544
|
/**
|
|
6191
6545
|
* Stripe unreachable — retry
|
|
6192
6546
|
*/
|
|
6193
6547
|
502: InvoiceError;
|
|
6194
6548
|
};
|
|
6195
|
-
type
|
|
6196
|
-
type
|
|
6549
|
+
type CreateInvoiceError = CreateInvoiceErrors[keyof CreateInvoiceErrors];
|
|
6550
|
+
type CreateInvoiceResponses = {
|
|
6197
6551
|
/**
|
|
6198
|
-
*
|
|
6552
|
+
* Created and sent
|
|
6199
6553
|
*/
|
|
6200
|
-
|
|
6554
|
+
201: CreateInvoiceResult;
|
|
6555
|
+
/**
|
|
6556
|
+
* Creation continues in the background
|
|
6557
|
+
*/
|
|
6558
|
+
202: CreateInvoiceResult;
|
|
6201
6559
|
};
|
|
6202
|
-
type
|
|
6203
|
-
type
|
|
6204
|
-
body
|
|
6560
|
+
type CreateInvoiceResponse = CreateInvoiceResponses[keyof CreateInvoiceResponses];
|
|
6561
|
+
type GetInvoiceData = {
|
|
6562
|
+
body?: never;
|
|
6205
6563
|
path: {
|
|
6206
6564
|
invoiceId: string;
|
|
6207
6565
|
};
|
|
6208
6566
|
query?: never;
|
|
6209
|
-
url: "/api/v1/invoices/{invoiceId}
|
|
6567
|
+
url: "/api/v1/invoices/{invoiceId}";
|
|
6210
6568
|
};
|
|
6211
|
-
type
|
|
6212
|
-
/**
|
|
6213
|
-
* Invalid date
|
|
6214
|
-
*/
|
|
6215
|
-
400: InvoiceError;
|
|
6569
|
+
type GetInvoiceErrors = {
|
|
6216
6570
|
/**
|
|
6217
6571
|
* Unauthorized
|
|
6218
6572
|
*/
|
|
6219
6573
|
401: InvoiceError;
|
|
6220
6574
|
/**
|
|
6221
|
-
*
|
|
6222
|
-
*/
|
|
6223
|
-
403: InvoiceError;
|
|
6224
|
-
/**
|
|
6225
|
-
* Invoice not found
|
|
6575
|
+
* Not found
|
|
6226
6576
|
*/
|
|
6227
6577
|
404: InvoiceError;
|
|
6228
|
-
/**
|
|
6229
|
-
* The invoice is not in a state that allows this
|
|
6230
|
-
*/
|
|
6231
|
-
409: InvoiceError;
|
|
6232
|
-
/**
|
|
6233
|
-
* Stripe unreachable — retry
|
|
6234
|
-
*/
|
|
6235
|
-
502: InvoiceError;
|
|
6236
6578
|
};
|
|
6237
|
-
type
|
|
6238
|
-
type
|
|
6579
|
+
type GetInvoiceError = GetInvoiceErrors[keyof GetInvoiceErrors];
|
|
6580
|
+
type GetInvoiceResponses = {
|
|
6239
6581
|
/**
|
|
6240
|
-
*
|
|
6582
|
+
* The invoice
|
|
6241
6583
|
*/
|
|
6242
6584
|
200: Invoice;
|
|
6243
6585
|
};
|
|
6244
|
-
type
|
|
6245
|
-
type
|
|
6246
|
-
body:
|
|
6247
|
-
|
|
6248
|
-
invoiceId: string;
|
|
6586
|
+
type GetInvoiceResponse = GetInvoiceResponses[keyof GetInvoiceResponses];
|
|
6587
|
+
type PreviewInvoiceData = {
|
|
6588
|
+
body: PreviewInvoice & {
|
|
6589
|
+
site_id?: string;
|
|
6249
6590
|
};
|
|
6591
|
+
path?: never;
|
|
6250
6592
|
query?: never;
|
|
6251
|
-
url: "/api/v1/invoices/
|
|
6593
|
+
url: "/api/v1/invoices/preview";
|
|
6252
6594
|
};
|
|
6253
|
-
type
|
|
6595
|
+
type PreviewInvoiceErrors = {
|
|
6254
6596
|
/**
|
|
6255
|
-
* Invalid
|
|
6597
|
+
* Invalid proposal
|
|
6256
6598
|
*/
|
|
6257
6599
|
400: InvoiceError;
|
|
6258
6600
|
/**
|
|
6259
6601
|
* Unauthorized
|
|
6260
6602
|
*/
|
|
6261
6603
|
401: InvoiceError;
|
|
6604
|
+
};
|
|
6605
|
+
type PreviewInvoiceError = PreviewInvoiceErrors[keyof PreviewInvoiceErrors];
|
|
6606
|
+
type PreviewInvoiceResponses = {
|
|
6262
6607
|
/**
|
|
6263
|
-
*
|
|
6264
|
-
*/
|
|
6265
|
-
403: InvoiceError;
|
|
6266
|
-
/**
|
|
6267
|
-
* Invoice not found
|
|
6608
|
+
* Rendered email
|
|
6268
6609
|
*/
|
|
6269
|
-
|
|
6270
|
-
|
|
6271
|
-
|
|
6610
|
+
200: InvoicePreview;
|
|
6611
|
+
};
|
|
6612
|
+
type PreviewInvoiceResponse = PreviewInvoiceResponses[keyof PreviewInvoiceResponses];
|
|
6613
|
+
type GetInvoicePreviewData = {
|
|
6614
|
+
body?: never;
|
|
6615
|
+
path: {
|
|
6616
|
+
invoiceId: string;
|
|
6617
|
+
};
|
|
6618
|
+
query?: never;
|
|
6619
|
+
url: "/api/v1/invoices/{invoiceId}/preview";
|
|
6620
|
+
};
|
|
6621
|
+
type GetInvoicePreviewErrors = {
|
|
6622
|
+
/**
|
|
6623
|
+
* Unauthorized
|
|
6624
|
+
*/
|
|
6625
|
+
401: InvoiceError;
|
|
6626
|
+
/**
|
|
6627
|
+
* Not found
|
|
6628
|
+
*/
|
|
6629
|
+
404: InvoiceError;
|
|
6630
|
+
};
|
|
6631
|
+
type GetInvoicePreviewError = GetInvoicePreviewErrors[keyof GetInvoicePreviewErrors];
|
|
6632
|
+
type GetInvoicePreviewResponses = {
|
|
6633
|
+
/**
|
|
6634
|
+
* Rendered email
|
|
6635
|
+
*/
|
|
6636
|
+
200: InvoicePreview;
|
|
6637
|
+
};
|
|
6638
|
+
type GetInvoicePreviewResponse = GetInvoicePreviewResponses[keyof GetInvoicePreviewResponses];
|
|
6639
|
+
type VoidInvoiceData = {
|
|
6640
|
+
body: VoidInvoice;
|
|
6641
|
+
path: {
|
|
6642
|
+
invoiceId: string;
|
|
6643
|
+
};
|
|
6644
|
+
query?: never;
|
|
6645
|
+
url: "/api/v1/invoices/{invoiceId}/void";
|
|
6646
|
+
};
|
|
6647
|
+
type VoidInvoiceErrors = {
|
|
6648
|
+
/**
|
|
6649
|
+
* Invalid reissue (refused BEFORE the original is voided — it is left untouched)
|
|
6650
|
+
*/
|
|
6651
|
+
400: InvoiceError;
|
|
6652
|
+
/**
|
|
6653
|
+
* Unauthorized
|
|
6654
|
+
*/
|
|
6655
|
+
401: InvoiceError;
|
|
6656
|
+
/**
|
|
6657
|
+
* Site tokens are not permitted, or invoicing is disabled
|
|
6658
|
+
*/
|
|
6659
|
+
403: InvoiceError;
|
|
6660
|
+
/**
|
|
6661
|
+
* Invoice not found
|
|
6662
|
+
*/
|
|
6663
|
+
404: InvoiceError;
|
|
6664
|
+
/**
|
|
6665
|
+
* The invoice is not in a state that allows this
|
|
6666
|
+
*/
|
|
6667
|
+
409: InvoiceError;
|
|
6668
|
+
/**
|
|
6669
|
+
* Reissue refused: the site's invoice budget is spent — the original is left untouched
|
|
6670
|
+
*/
|
|
6671
|
+
429: InvoiceError;
|
|
6672
|
+
/**
|
|
6673
|
+
* Stripe unreachable — retry
|
|
6674
|
+
*/
|
|
6675
|
+
502: InvoiceError;
|
|
6676
|
+
};
|
|
6677
|
+
type VoidInvoiceError = VoidInvoiceErrors[keyof VoidInvoiceErrors];
|
|
6678
|
+
type VoidInvoiceResponses = {
|
|
6679
|
+
/**
|
|
6680
|
+
* Voided
|
|
6681
|
+
*/
|
|
6682
|
+
200: VoidInvoiceResult;
|
|
6683
|
+
};
|
|
6684
|
+
type VoidInvoiceResponse = VoidInvoiceResponses[keyof VoidInvoiceResponses];
|
|
6685
|
+
type ResendInvoiceData = {
|
|
6686
|
+
body: InvoiceSiteBody;
|
|
6687
|
+
path: {
|
|
6688
|
+
invoiceId: string;
|
|
6689
|
+
};
|
|
6690
|
+
query?: never;
|
|
6691
|
+
url: "/api/v1/invoices/{invoiceId}/resend";
|
|
6692
|
+
};
|
|
6693
|
+
type ResendInvoiceErrors = {
|
|
6694
|
+
/**
|
|
6695
|
+
* Invalid request
|
|
6696
|
+
*/
|
|
6697
|
+
400: InvoiceError;
|
|
6698
|
+
/**
|
|
6699
|
+
* Unauthorized
|
|
6700
|
+
*/
|
|
6701
|
+
401: InvoiceError;
|
|
6702
|
+
/**
|
|
6703
|
+
* Site tokens are not permitted, or invoicing is disabled
|
|
6704
|
+
*/
|
|
6705
|
+
403: InvoiceError;
|
|
6706
|
+
/**
|
|
6707
|
+
* Invoice not found
|
|
6708
|
+
*/
|
|
6709
|
+
404: InvoiceError;
|
|
6710
|
+
/**
|
|
6711
|
+
* The invoice is not in a state that allows this
|
|
6712
|
+
*/
|
|
6713
|
+
409: InvoiceError;
|
|
6714
|
+
/**
|
|
6715
|
+
* This recipient was emailed recently — the per-recipient cooldown (one buyer email an hour, six a day, first send of an invoice exempt)
|
|
6716
|
+
*/
|
|
6717
|
+
429: RecipientCooldownError;
|
|
6718
|
+
/**
|
|
6719
|
+
* Stripe unreachable — retry
|
|
6720
|
+
*/
|
|
6721
|
+
502: InvoiceError;
|
|
6722
|
+
};
|
|
6723
|
+
type ResendInvoiceError = ResendInvoiceErrors[keyof ResendInvoiceErrors];
|
|
6724
|
+
type ResendInvoiceResponses = {
|
|
6725
|
+
/**
|
|
6726
|
+
* Queued
|
|
6727
|
+
*/
|
|
6728
|
+
202: RemindInvoiceResult;
|
|
6729
|
+
};
|
|
6730
|
+
type ResendInvoiceResponse = ResendInvoiceResponses[keyof ResendInvoiceResponses];
|
|
6731
|
+
type RemindInvoiceData = {
|
|
6732
|
+
body: InvoiceSiteBody;
|
|
6733
|
+
path: {
|
|
6734
|
+
invoiceId: string;
|
|
6735
|
+
};
|
|
6736
|
+
query?: never;
|
|
6737
|
+
url: "/api/v1/invoices/{invoiceId}/remind";
|
|
6738
|
+
};
|
|
6739
|
+
type RemindInvoiceErrors = {
|
|
6740
|
+
/**
|
|
6741
|
+
* Invalid request
|
|
6742
|
+
*/
|
|
6743
|
+
400: InvoiceError;
|
|
6744
|
+
/**
|
|
6745
|
+
* Unauthorized
|
|
6746
|
+
*/
|
|
6747
|
+
401: InvoiceError;
|
|
6748
|
+
/**
|
|
6749
|
+
* Site tokens are not permitted, or invoicing is disabled
|
|
6750
|
+
*/
|
|
6751
|
+
403: InvoiceError;
|
|
6752
|
+
/**
|
|
6753
|
+
* Invoice not found
|
|
6754
|
+
*/
|
|
6755
|
+
404: InvoiceError;
|
|
6756
|
+
/**
|
|
6757
|
+
* The invoice is not in a state that allows this
|
|
6758
|
+
*/
|
|
6759
|
+
409: InvoiceError;
|
|
6760
|
+
/**
|
|
6761
|
+
* This recipient was emailed recently — the per-recipient cooldown (one buyer email an hour, six a day, first send of an invoice exempt)
|
|
6762
|
+
*/
|
|
6763
|
+
429: RecipientCooldownError;
|
|
6764
|
+
/**
|
|
6765
|
+
* Stripe unreachable — retry
|
|
6766
|
+
*/
|
|
6767
|
+
502: InvoiceError;
|
|
6768
|
+
};
|
|
6769
|
+
type RemindInvoiceError = RemindInvoiceErrors[keyof RemindInvoiceErrors];
|
|
6770
|
+
type RemindInvoiceResponses = {
|
|
6771
|
+
/**
|
|
6772
|
+
* Queued
|
|
6773
|
+
*/
|
|
6774
|
+
202: RemindInvoiceResult;
|
|
6775
|
+
};
|
|
6776
|
+
type RemindInvoiceResponse = RemindInvoiceResponses[keyof RemindInvoiceResponses];
|
|
6777
|
+
type SnoozeInvoiceData = {
|
|
6778
|
+
body: SnoozeInvoice;
|
|
6779
|
+
path: {
|
|
6780
|
+
invoiceId: string;
|
|
6781
|
+
};
|
|
6782
|
+
query?: never;
|
|
6783
|
+
url: "/api/v1/invoices/{invoiceId}/snooze";
|
|
6784
|
+
};
|
|
6785
|
+
type SnoozeInvoiceErrors = {
|
|
6786
|
+
/**
|
|
6787
|
+
* Invalid date
|
|
6788
|
+
*/
|
|
6789
|
+
400: InvoiceError;
|
|
6790
|
+
/**
|
|
6791
|
+
* Unauthorized
|
|
6792
|
+
*/
|
|
6793
|
+
401: InvoiceError;
|
|
6794
|
+
/**
|
|
6795
|
+
* Site tokens are not permitted, or invoicing is disabled
|
|
6796
|
+
*/
|
|
6797
|
+
403: InvoiceError;
|
|
6798
|
+
/**
|
|
6799
|
+
* Invoice not found
|
|
6800
|
+
*/
|
|
6801
|
+
404: InvoiceError;
|
|
6802
|
+
/**
|
|
6803
|
+
* The invoice is not in a state that allows this
|
|
6804
|
+
*/
|
|
6805
|
+
409: InvoiceError;
|
|
6806
|
+
/**
|
|
6807
|
+
* Stripe unreachable — retry
|
|
6808
|
+
*/
|
|
6809
|
+
502: InvoiceError;
|
|
6810
|
+
};
|
|
6811
|
+
type SnoozeInvoiceError = SnoozeInvoiceErrors[keyof SnoozeInvoiceErrors];
|
|
6812
|
+
type SnoozeInvoiceResponses = {
|
|
6813
|
+
/**
|
|
6814
|
+
* Updated
|
|
6815
|
+
*/
|
|
6816
|
+
200: Invoice;
|
|
6817
|
+
};
|
|
6818
|
+
type SnoozeInvoiceResponse = SnoozeInvoiceResponses[keyof SnoozeInvoiceResponses];
|
|
6819
|
+
type SetInvoiceRemindersData = {
|
|
6820
|
+
body: SetInvoiceReminders;
|
|
6821
|
+
path: {
|
|
6822
|
+
invoiceId: string;
|
|
6823
|
+
};
|
|
6824
|
+
query?: never;
|
|
6825
|
+
url: "/api/v1/invoices/{invoiceId}/reminders";
|
|
6826
|
+
};
|
|
6827
|
+
type SetInvoiceRemindersErrors = {
|
|
6828
|
+
/**
|
|
6829
|
+
* Invalid schedule
|
|
6830
|
+
*/
|
|
6831
|
+
400: InvoiceError;
|
|
6832
|
+
/**
|
|
6833
|
+
* Unauthorized
|
|
6834
|
+
*/
|
|
6835
|
+
401: InvoiceError;
|
|
6836
|
+
/**
|
|
6837
|
+
* Site tokens are not permitted, or invoicing is disabled
|
|
6838
|
+
*/
|
|
6839
|
+
403: InvoiceError;
|
|
6840
|
+
/**
|
|
6841
|
+
* Invoice not found
|
|
6842
|
+
*/
|
|
6843
|
+
404: InvoiceError;
|
|
6844
|
+
/**
|
|
6845
|
+
* The invoice is not in a state that allows this
|
|
6272
6846
|
*/
|
|
6273
6847
|
409: InvoiceError;
|
|
6274
6848
|
/**
|
|
@@ -7431,472 +8005,561 @@ type PurgeSiteReviewsResponses = {
|
|
|
7431
8005
|
};
|
|
7432
8006
|
};
|
|
7433
8007
|
type PurgeSiteReviewsResponse = PurgeSiteReviewsResponses[keyof PurgeSiteReviewsResponses];
|
|
7434
|
-
type
|
|
8008
|
+
type ListPromosData = {
|
|
7435
8009
|
body?: never;
|
|
7436
8010
|
path?: never;
|
|
7437
|
-
query?:
|
|
7438
|
-
|
|
8011
|
+
query?: {
|
|
8012
|
+
limit?: number;
|
|
8013
|
+
cursor?: string;
|
|
8014
|
+
};
|
|
8015
|
+
url: "/api/v1/promos";
|
|
7439
8016
|
};
|
|
7440
|
-
type
|
|
8017
|
+
type ListPromosErrors = {
|
|
7441
8018
|
/**
|
|
7442
|
-
*
|
|
8019
|
+
* Invalid promotion rules
|
|
7443
8020
|
*/
|
|
7444
|
-
|
|
8021
|
+
400: PromoError;
|
|
7445
8022
|
/**
|
|
7446
|
-
*
|
|
8023
|
+
* Authentication required
|
|
7447
8024
|
*/
|
|
7448
|
-
|
|
7449
|
-
|
|
7450
|
-
|
|
7451
|
-
type GetConsentConfigWithSiteTokenResponses = {
|
|
8025
|
+
401: PromoError | {
|
|
8026
|
+
error: string;
|
|
8027
|
+
};
|
|
7452
8028
|
/**
|
|
7453
|
-
*
|
|
8029
|
+
* Site or owned promotion not found
|
|
7454
8030
|
*/
|
|
7455
|
-
|
|
7456
|
-
};
|
|
7457
|
-
type GetConsentConfigWithSiteTokenResponse = GetConsentConfigWithSiteTokenResponses[keyof GetConsentConfigWithSiteTokenResponses];
|
|
7458
|
-
type UpsertConsentConfigWithSiteTokenData = {
|
|
7459
|
-
body: UpsertConsentConfig;
|
|
7460
|
-
path?: never;
|
|
7461
|
-
query?: never;
|
|
7462
|
-
url: "/api/v1/site-prefs";
|
|
7463
|
-
};
|
|
7464
|
-
type UpsertConsentConfigWithSiteTokenErrors = {
|
|
8031
|
+
404: PromoError;
|
|
7465
8032
|
/**
|
|
7466
|
-
*
|
|
8033
|
+
* Conflicting request or promotion state
|
|
7467
8034
|
*/
|
|
7468
|
-
|
|
8035
|
+
409: PromoError;
|
|
7469
8036
|
/**
|
|
7470
|
-
*
|
|
8037
|
+
* Unknown Stripe result; retry the same request
|
|
7471
8038
|
*/
|
|
7472
|
-
|
|
8039
|
+
503: PromoError;
|
|
7473
8040
|
};
|
|
7474
|
-
type
|
|
7475
|
-
type
|
|
8041
|
+
type ListPromosError = ListPromosErrors[keyof ListPromosErrors];
|
|
8042
|
+
type ListPromosResponses = {
|
|
7476
8043
|
/**
|
|
7477
|
-
*
|
|
8044
|
+
* Owned promotions
|
|
7478
8045
|
*/
|
|
7479
|
-
200:
|
|
8046
|
+
200: PromosList;
|
|
7480
8047
|
};
|
|
7481
|
-
type
|
|
7482
|
-
type
|
|
7483
|
-
body
|
|
8048
|
+
type ListPromosResponse = ListPromosResponses[keyof ListPromosResponses];
|
|
8049
|
+
type CreatePromoData = {
|
|
8050
|
+
body: CreatePromo;
|
|
7484
8051
|
path?: never;
|
|
7485
8052
|
query?: never;
|
|
7486
|
-
url: "/api/v1/
|
|
8053
|
+
url: "/api/v1/promos";
|
|
7487
8054
|
};
|
|
7488
|
-
type
|
|
7489
|
-
/**
|
|
7490
|
-
* Unauthorized - requires site token
|
|
7491
|
-
*/
|
|
7492
|
-
401: Error;
|
|
8055
|
+
type CreatePromoErrors = {
|
|
7493
8056
|
/**
|
|
7494
|
-
*
|
|
8057
|
+
* Invalid promotion rules
|
|
7495
8058
|
*/
|
|
7496
|
-
|
|
7497
|
-
};
|
|
7498
|
-
type ListFormsWithSiteTokenError = ListFormsWithSiteTokenErrors[keyof ListFormsWithSiteTokenErrors];
|
|
7499
|
-
type ListFormsWithSiteTokenResponses = {
|
|
8059
|
+
400: PromoError;
|
|
7500
8060
|
/**
|
|
7501
|
-
*
|
|
8061
|
+
* Authentication required
|
|
7502
8062
|
*/
|
|
7503
|
-
|
|
7504
|
-
|
|
7505
|
-
|
|
7506
|
-
type CreateFormWithSiteTokenData = {
|
|
7507
|
-
body: CreateForm;
|
|
7508
|
-
path?: never;
|
|
7509
|
-
query?: never;
|
|
7510
|
-
url: "/api/v1/forms";
|
|
7511
|
-
};
|
|
7512
|
-
type CreateFormWithSiteTokenErrors = {
|
|
8063
|
+
401: PromoError | {
|
|
8064
|
+
error: string;
|
|
8065
|
+
};
|
|
7513
8066
|
/**
|
|
7514
|
-
*
|
|
8067
|
+
* Site or owned promotion not found
|
|
7515
8068
|
*/
|
|
7516
|
-
|
|
8069
|
+
404: PromoError;
|
|
7517
8070
|
/**
|
|
7518
|
-
*
|
|
8071
|
+
* Conflicting request or promotion state
|
|
7519
8072
|
*/
|
|
7520
|
-
|
|
8073
|
+
409: PromoError;
|
|
7521
8074
|
/**
|
|
7522
|
-
*
|
|
8075
|
+
* Unknown Stripe result; retry the same request
|
|
7523
8076
|
*/
|
|
7524
|
-
|
|
8077
|
+
503: PromoError;
|
|
7525
8078
|
};
|
|
7526
|
-
type
|
|
7527
|
-
type
|
|
8079
|
+
type CreatePromoError = CreatePromoErrors[keyof CreatePromoErrors];
|
|
8080
|
+
type CreatePromoResponses = {
|
|
7528
8081
|
/**
|
|
7529
|
-
*
|
|
8082
|
+
* Created or previously completed promotion
|
|
7530
8083
|
*/
|
|
7531
|
-
|
|
8084
|
+
200: Promo;
|
|
7532
8085
|
};
|
|
7533
|
-
type
|
|
7534
|
-
type
|
|
8086
|
+
type CreatePromoResponse = CreatePromoResponses[keyof CreatePromoResponses];
|
|
8087
|
+
type GetPromoData = {
|
|
7535
8088
|
body?: never;
|
|
7536
|
-
path
|
|
7537
|
-
|
|
7538
|
-
/**
|
|
7539
|
-
* Exact match on the consumer-side id (the landingsite website id) — the lookup for "which aifeatures site is this website?"
|
|
7540
|
-
*/
|
|
7541
|
-
external_id?: string;
|
|
7542
|
-
/**
|
|
7543
|
-
* Maximum number of sites to return (default 50, max 100)
|
|
7544
|
-
*/
|
|
7545
|
-
limit?: string;
|
|
7546
|
-
/**
|
|
7547
|
-
* Number of sites to skip
|
|
7548
|
-
*/
|
|
7549
|
-
offset?: string;
|
|
7550
|
-
/**
|
|
7551
|
-
* Pass 'true' to include soft-deleted sites — hidden by default. Two kinds come back: rows with deleted_at set and purged_at null are inside the retention window and restorable; rows with purged_at ALSO set are tombstones the purge kept for their billing records — forms, catalog and config are gone and they cannot be restored. Because external_id may be reused by a successor site after a delete, an external_id lookup with include_deleted=true can return a live site beside its purged predecessor; read purged_at to tell them apart.
|
|
7552
|
-
*/
|
|
7553
|
-
include_deleted?: string;
|
|
8089
|
+
path: {
|
|
8090
|
+
promoId: string;
|
|
7554
8091
|
};
|
|
7555
|
-
|
|
8092
|
+
query?: never;
|
|
8093
|
+
url: "/api/v1/promos/{promoId}";
|
|
7556
8094
|
};
|
|
7557
|
-
type
|
|
8095
|
+
type GetPromoErrors = {
|
|
7558
8096
|
/**
|
|
7559
|
-
*
|
|
8097
|
+
* Invalid promotion rules
|
|
7560
8098
|
*/
|
|
7561
|
-
|
|
8099
|
+
400: PromoError;
|
|
7562
8100
|
/**
|
|
7563
|
-
*
|
|
8101
|
+
* Authentication required
|
|
7564
8102
|
*/
|
|
7565
|
-
|
|
8103
|
+
401: PromoError | {
|
|
8104
|
+
error: string;
|
|
8105
|
+
};
|
|
8106
|
+
/**
|
|
8107
|
+
* Site or owned promotion not found
|
|
8108
|
+
*/
|
|
8109
|
+
404: PromoError;
|
|
8110
|
+
/**
|
|
8111
|
+
* Conflicting request or promotion state
|
|
8112
|
+
*/
|
|
8113
|
+
409: PromoError;
|
|
8114
|
+
/**
|
|
8115
|
+
* Unknown Stripe result; retry the same request
|
|
8116
|
+
*/
|
|
8117
|
+
503: PromoError;
|
|
7566
8118
|
};
|
|
7567
|
-
type
|
|
7568
|
-
type
|
|
8119
|
+
type GetPromoError = GetPromoErrors[keyof GetPromoErrors];
|
|
8120
|
+
type GetPromoResponses = {
|
|
7569
8121
|
/**
|
|
7570
|
-
*
|
|
8122
|
+
* Owned promotion
|
|
7571
8123
|
*/
|
|
7572
|
-
200:
|
|
8124
|
+
200: Promo;
|
|
7573
8125
|
};
|
|
7574
|
-
type
|
|
7575
|
-
type
|
|
7576
|
-
body
|
|
7577
|
-
path
|
|
8126
|
+
type GetPromoResponse = GetPromoResponses[keyof GetPromoResponses];
|
|
8127
|
+
type DisablePromoData = {
|
|
8128
|
+
body?: never;
|
|
8129
|
+
path: {
|
|
8130
|
+
promoId: string;
|
|
8131
|
+
};
|
|
7578
8132
|
query?: never;
|
|
7579
|
-
url: "/api/v1/
|
|
8133
|
+
url: "/api/v1/promos/{promoId}/disable";
|
|
7580
8134
|
};
|
|
7581
|
-
type
|
|
8135
|
+
type DisablePromoErrors = {
|
|
7582
8136
|
/**
|
|
7583
|
-
*
|
|
8137
|
+
* Invalid promotion rules
|
|
7584
8138
|
*/
|
|
7585
|
-
400:
|
|
8139
|
+
400: PromoError;
|
|
7586
8140
|
/**
|
|
7587
|
-
*
|
|
8141
|
+
* Authentication required
|
|
7588
8142
|
*/
|
|
7589
|
-
401:
|
|
8143
|
+
401: PromoError | {
|
|
8144
|
+
error: string;
|
|
8145
|
+
};
|
|
7590
8146
|
/**
|
|
7591
|
-
*
|
|
8147
|
+
* Site or owned promotion not found
|
|
7592
8148
|
*/
|
|
7593
|
-
|
|
8149
|
+
404: PromoError;
|
|
7594
8150
|
/**
|
|
7595
|
-
*
|
|
8151
|
+
* Conflicting request or promotion state
|
|
7596
8152
|
*/
|
|
7597
|
-
409:
|
|
8153
|
+
409: PromoError;
|
|
8154
|
+
/**
|
|
8155
|
+
* Unknown Stripe result; retry the same request
|
|
8156
|
+
*/
|
|
8157
|
+
503: PromoError;
|
|
7598
8158
|
};
|
|
7599
|
-
type
|
|
7600
|
-
type
|
|
8159
|
+
type DisablePromoError = DisablePromoErrors[keyof DisablePromoErrors];
|
|
8160
|
+
type DisablePromoResponses = {
|
|
7601
8161
|
/**
|
|
7602
|
-
*
|
|
8162
|
+
* Disabled promotion
|
|
7603
8163
|
*/
|
|
7604
|
-
|
|
8164
|
+
200: Promo;
|
|
7605
8165
|
};
|
|
7606
|
-
type
|
|
7607
|
-
type
|
|
7608
|
-
body
|
|
8166
|
+
type DisablePromoResponse = DisablePromoResponses[keyof DisablePromoResponses];
|
|
8167
|
+
type ReplacePromoData = {
|
|
8168
|
+
body: CreatePromo;
|
|
7609
8169
|
path: {
|
|
7610
|
-
|
|
8170
|
+
promoId: string;
|
|
7611
8171
|
};
|
|
7612
8172
|
query?: never;
|
|
7613
|
-
url: "/api/v1/
|
|
8173
|
+
url: "/api/v1/promos/{promoId}/replace";
|
|
7614
8174
|
};
|
|
7615
|
-
type
|
|
8175
|
+
type ReplacePromoErrors = {
|
|
7616
8176
|
/**
|
|
7617
|
-
*
|
|
8177
|
+
* Invalid promotion rules
|
|
7618
8178
|
*/
|
|
7619
|
-
|
|
8179
|
+
400: PromoError;
|
|
7620
8180
|
/**
|
|
7621
|
-
*
|
|
8181
|
+
* Authentication required
|
|
7622
8182
|
*/
|
|
7623
|
-
|
|
8183
|
+
401: PromoError | {
|
|
8184
|
+
error: string;
|
|
8185
|
+
};
|
|
7624
8186
|
/**
|
|
7625
|
-
* Site
|
|
8187
|
+
* Site or owned promotion not found
|
|
7626
8188
|
*/
|
|
7627
|
-
404:
|
|
8189
|
+
404: PromoError;
|
|
7628
8190
|
/**
|
|
7629
|
-
*
|
|
8191
|
+
* Conflicting request or promotion state
|
|
7630
8192
|
*/
|
|
7631
|
-
|
|
8193
|
+
409: PromoError;
|
|
8194
|
+
/**
|
|
8195
|
+
* Unknown Stripe result; retry the same request
|
|
8196
|
+
*/
|
|
8197
|
+
503: PromoError;
|
|
7632
8198
|
};
|
|
7633
|
-
type
|
|
7634
|
-
type
|
|
8199
|
+
type ReplacePromoError = ReplacePromoErrors[keyof ReplacePromoErrors];
|
|
8200
|
+
type ReplacePromoResponses = {
|
|
7635
8201
|
/**
|
|
7636
|
-
*
|
|
8202
|
+
* Replacement created and predecessor disabled
|
|
7637
8203
|
*/
|
|
7638
|
-
|
|
8204
|
+
200: Promo;
|
|
7639
8205
|
};
|
|
7640
|
-
type
|
|
7641
|
-
type
|
|
8206
|
+
type ReplacePromoResponse = ReplacePromoResponses[keyof ReplacePromoResponses];
|
|
8207
|
+
type ListPromosForSiteData = {
|
|
7642
8208
|
body?: never;
|
|
7643
8209
|
path: {
|
|
7644
8210
|
siteId: string;
|
|
7645
8211
|
};
|
|
7646
|
-
query?:
|
|
7647
|
-
|
|
8212
|
+
query?: {
|
|
8213
|
+
limit?: number;
|
|
8214
|
+
cursor?: string;
|
|
8215
|
+
};
|
|
8216
|
+
url: "/api/v1/sites/{siteId}/promos";
|
|
7648
8217
|
};
|
|
7649
|
-
type
|
|
8218
|
+
type ListPromosForSiteErrors = {
|
|
7650
8219
|
/**
|
|
7651
|
-
*
|
|
8220
|
+
* Invalid promotion rules
|
|
7652
8221
|
*/
|
|
7653
|
-
|
|
8222
|
+
400: PromoError;
|
|
7654
8223
|
/**
|
|
7655
|
-
*
|
|
8224
|
+
* Authentication required
|
|
7656
8225
|
*/
|
|
7657
|
-
|
|
7658
|
-
|
|
7659
|
-
|
|
7660
|
-
type GetSiteResponses = {
|
|
8226
|
+
401: PromoError | {
|
|
8227
|
+
error: string;
|
|
8228
|
+
};
|
|
7661
8229
|
/**
|
|
7662
|
-
* Site
|
|
8230
|
+
* Site or owned promotion not found
|
|
7663
8231
|
*/
|
|
7664
|
-
|
|
8232
|
+
404: PromoError;
|
|
8233
|
+
/**
|
|
8234
|
+
* Conflicting request or promotion state
|
|
8235
|
+
*/
|
|
8236
|
+
409: PromoError;
|
|
8237
|
+
/**
|
|
8238
|
+
* Unknown Stripe result; retry the same request
|
|
8239
|
+
*/
|
|
8240
|
+
503: PromoError;
|
|
7665
8241
|
};
|
|
7666
|
-
type
|
|
7667
|
-
type
|
|
7668
|
-
|
|
8242
|
+
type ListPromosForSiteError = ListPromosForSiteErrors[keyof ListPromosForSiteErrors];
|
|
8243
|
+
type ListPromosForSiteResponses = {
|
|
8244
|
+
/**
|
|
8245
|
+
* Owned promotions
|
|
8246
|
+
*/
|
|
8247
|
+
200: PromosList;
|
|
8248
|
+
};
|
|
8249
|
+
type ListPromosForSiteResponse = ListPromosForSiteResponses[keyof ListPromosForSiteResponses];
|
|
8250
|
+
type CreatePromoForSiteData = {
|
|
8251
|
+
body: CreatePromo;
|
|
7669
8252
|
path: {
|
|
7670
8253
|
siteId: string;
|
|
7671
8254
|
};
|
|
7672
8255
|
query?: never;
|
|
7673
|
-
url: "/api/v1/sites/{siteId}";
|
|
8256
|
+
url: "/api/v1/sites/{siteId}/promos";
|
|
7674
8257
|
};
|
|
7675
|
-
type
|
|
8258
|
+
type CreatePromoForSiteErrors = {
|
|
7676
8259
|
/**
|
|
7677
|
-
* Invalid
|
|
8260
|
+
* Invalid promotion rules
|
|
7678
8261
|
*/
|
|
7679
|
-
400:
|
|
8262
|
+
400: PromoError;
|
|
7680
8263
|
/**
|
|
7681
|
-
*
|
|
8264
|
+
* Authentication required
|
|
7682
8265
|
*/
|
|
7683
|
-
401:
|
|
8266
|
+
401: PromoError | {
|
|
8267
|
+
error: string;
|
|
8268
|
+
};
|
|
7684
8269
|
/**
|
|
7685
|
-
*
|
|
8270
|
+
* Site or owned promotion not found
|
|
7686
8271
|
*/
|
|
7687
|
-
|
|
8272
|
+
404: PromoError;
|
|
7688
8273
|
/**
|
|
7689
|
-
*
|
|
8274
|
+
* Conflicting request or promotion state
|
|
7690
8275
|
*/
|
|
7691
|
-
|
|
8276
|
+
409: PromoError;
|
|
7692
8277
|
/**
|
|
7693
|
-
*
|
|
8278
|
+
* Unknown Stripe result; retry the same request
|
|
7694
8279
|
*/
|
|
7695
|
-
|
|
8280
|
+
503: PromoError;
|
|
7696
8281
|
};
|
|
7697
|
-
type
|
|
7698
|
-
type
|
|
8282
|
+
type CreatePromoForSiteError = CreatePromoForSiteErrors[keyof CreatePromoForSiteErrors];
|
|
8283
|
+
type CreatePromoForSiteResponses = {
|
|
7699
8284
|
/**
|
|
7700
|
-
*
|
|
8285
|
+
* Created or previously completed promotion
|
|
7701
8286
|
*/
|
|
7702
|
-
200:
|
|
8287
|
+
200: Promo;
|
|
7703
8288
|
};
|
|
7704
|
-
type
|
|
7705
|
-
type
|
|
8289
|
+
type CreatePromoForSiteResponse = CreatePromoForSiteResponses[keyof CreatePromoForSiteResponses];
|
|
8290
|
+
type GetPromoForSiteData = {
|
|
7706
8291
|
body?: never;
|
|
7707
8292
|
path: {
|
|
7708
8293
|
siteId: string;
|
|
8294
|
+
promoId: string;
|
|
7709
8295
|
};
|
|
7710
8296
|
query?: never;
|
|
7711
|
-
url: "/api/v1/sites/{siteId}/
|
|
8297
|
+
url: "/api/v1/sites/{siteId}/promos/{promoId}";
|
|
7712
8298
|
};
|
|
7713
|
-
type
|
|
8299
|
+
type GetPromoForSiteErrors = {
|
|
7714
8300
|
/**
|
|
7715
|
-
*
|
|
8301
|
+
* Invalid promotion rules
|
|
7716
8302
|
*/
|
|
7717
|
-
|
|
8303
|
+
400: PromoError;
|
|
7718
8304
|
/**
|
|
7719
|
-
*
|
|
8305
|
+
* Authentication required
|
|
7720
8306
|
*/
|
|
7721
|
-
|
|
8307
|
+
401: PromoError | {
|
|
8308
|
+
error: string;
|
|
8309
|
+
};
|
|
7722
8310
|
/**
|
|
7723
|
-
* Site not found
|
|
8311
|
+
* Site or owned promotion not found
|
|
7724
8312
|
*/
|
|
7725
|
-
404:
|
|
8313
|
+
404: PromoError;
|
|
8314
|
+
/**
|
|
8315
|
+
* Conflicting request or promotion state
|
|
8316
|
+
*/
|
|
8317
|
+
409: PromoError;
|
|
8318
|
+
/**
|
|
8319
|
+
* Unknown Stripe result; retry the same request
|
|
8320
|
+
*/
|
|
8321
|
+
503: PromoError;
|
|
7726
8322
|
};
|
|
7727
|
-
type
|
|
7728
|
-
type
|
|
8323
|
+
type GetPromoForSiteError = GetPromoForSiteErrors[keyof GetPromoForSiteErrors];
|
|
8324
|
+
type GetPromoForSiteResponses = {
|
|
7729
8325
|
/**
|
|
7730
|
-
*
|
|
8326
|
+
* Owned promotion
|
|
7731
8327
|
*/
|
|
7732
|
-
200:
|
|
8328
|
+
200: Promo;
|
|
7733
8329
|
};
|
|
7734
|
-
type
|
|
7735
|
-
type
|
|
7736
|
-
body
|
|
8330
|
+
type GetPromoForSiteResponse = GetPromoForSiteResponses[keyof GetPromoForSiteResponses];
|
|
8331
|
+
type DisablePromoForSiteData = {
|
|
8332
|
+
body?: never;
|
|
7737
8333
|
path: {
|
|
7738
8334
|
siteId: string;
|
|
8335
|
+
promoId: string;
|
|
7739
8336
|
};
|
|
7740
8337
|
query?: never;
|
|
7741
|
-
url: "/api/v1/sites/{siteId}/
|
|
8338
|
+
url: "/api/v1/sites/{siteId}/promos/{promoId}/disable";
|
|
7742
8339
|
};
|
|
7743
|
-
type
|
|
8340
|
+
type DisablePromoForSiteErrors = {
|
|
7744
8341
|
/**
|
|
7745
|
-
*
|
|
8342
|
+
* Invalid promotion rules
|
|
7746
8343
|
*/
|
|
7747
|
-
|
|
8344
|
+
400: PromoError;
|
|
7748
8345
|
/**
|
|
7749
|
-
*
|
|
8346
|
+
* Authentication required
|
|
7750
8347
|
*/
|
|
7751
|
-
|
|
8348
|
+
401: PromoError | {
|
|
8349
|
+
error: string;
|
|
8350
|
+
};
|
|
7752
8351
|
/**
|
|
7753
|
-
* Site not found
|
|
8352
|
+
* Site or owned promotion not found
|
|
7754
8353
|
*/
|
|
7755
|
-
404:
|
|
8354
|
+
404: PromoError;
|
|
8355
|
+
/**
|
|
8356
|
+
* Conflicting request or promotion state
|
|
8357
|
+
*/
|
|
8358
|
+
409: PromoError;
|
|
8359
|
+
/**
|
|
8360
|
+
* Unknown Stripe result; retry the same request
|
|
8361
|
+
*/
|
|
8362
|
+
503: PromoError;
|
|
7756
8363
|
};
|
|
7757
|
-
type
|
|
7758
|
-
type
|
|
8364
|
+
type DisablePromoForSiteError = DisablePromoForSiteErrors[keyof DisablePromoForSiteErrors];
|
|
8365
|
+
type DisablePromoForSiteResponses = {
|
|
7759
8366
|
/**
|
|
7760
|
-
*
|
|
8367
|
+
* Disabled promotion
|
|
7761
8368
|
*/
|
|
7762
|
-
200:
|
|
8369
|
+
200: Promo;
|
|
7763
8370
|
};
|
|
7764
|
-
type
|
|
7765
|
-
type
|
|
7766
|
-
body:
|
|
8371
|
+
type DisablePromoForSiteResponse = DisablePromoForSiteResponses[keyof DisablePromoForSiteResponses];
|
|
8372
|
+
type ReplacePromoForSiteData = {
|
|
8373
|
+
body: CreatePromo;
|
|
7767
8374
|
path: {
|
|
7768
8375
|
siteId: string;
|
|
8376
|
+
promoId: string;
|
|
7769
8377
|
};
|
|
7770
8378
|
query?: never;
|
|
7771
|
-
url: "/api/v1/sites/{siteId}/
|
|
8379
|
+
url: "/api/v1/sites/{siteId}/promos/{promoId}/replace";
|
|
7772
8380
|
};
|
|
7773
|
-
type
|
|
8381
|
+
type ReplacePromoForSiteErrors = {
|
|
7774
8382
|
/**
|
|
7775
|
-
*
|
|
8383
|
+
* Invalid promotion rules
|
|
7776
8384
|
*/
|
|
7777
|
-
|
|
8385
|
+
400: PromoError;
|
|
7778
8386
|
/**
|
|
7779
|
-
*
|
|
8387
|
+
* Authentication required
|
|
7780
8388
|
*/
|
|
7781
|
-
|
|
8389
|
+
401: PromoError | {
|
|
8390
|
+
error: string;
|
|
8391
|
+
};
|
|
7782
8392
|
/**
|
|
7783
|
-
* Site not found
|
|
8393
|
+
* Site or owned promotion not found
|
|
7784
8394
|
*/
|
|
7785
|
-
404:
|
|
8395
|
+
404: PromoError;
|
|
8396
|
+
/**
|
|
8397
|
+
* Conflicting request or promotion state
|
|
8398
|
+
*/
|
|
8399
|
+
409: PromoError;
|
|
8400
|
+
/**
|
|
8401
|
+
* Unknown Stripe result; retry the same request
|
|
8402
|
+
*/
|
|
8403
|
+
503: PromoError;
|
|
7786
8404
|
};
|
|
7787
|
-
type
|
|
7788
|
-
type
|
|
8405
|
+
type ReplacePromoForSiteError = ReplacePromoForSiteErrors[keyof ReplacePromoForSiteErrors];
|
|
8406
|
+
type ReplacePromoForSiteResponses = {
|
|
7789
8407
|
/**
|
|
7790
|
-
*
|
|
8408
|
+
* Replacement created and predecessor disabled
|
|
7791
8409
|
*/
|
|
7792
|
-
200:
|
|
8410
|
+
200: Promo;
|
|
7793
8411
|
};
|
|
7794
|
-
type
|
|
7795
|
-
type
|
|
8412
|
+
type ReplacePromoForSiteResponse = ReplacePromoForSiteResponses[keyof ReplacePromoForSiteResponses];
|
|
8413
|
+
type GetConsentConfigWithSiteTokenData = {
|
|
7796
8414
|
body?: never;
|
|
7797
|
-
path
|
|
7798
|
-
siteId: string;
|
|
7799
|
-
};
|
|
8415
|
+
path?: never;
|
|
7800
8416
|
query?: never;
|
|
7801
|
-
url: "/api/v1/
|
|
8417
|
+
url: "/api/v1/site-prefs";
|
|
7802
8418
|
};
|
|
7803
|
-
type
|
|
8419
|
+
type GetConsentConfigWithSiteTokenErrors = {
|
|
7804
8420
|
/**
|
|
7805
|
-
* Unauthorized
|
|
8421
|
+
* Unauthorized - requires site token
|
|
7806
8422
|
*/
|
|
7807
8423
|
401: Error;
|
|
7808
8424
|
/**
|
|
7809
|
-
*
|
|
7810
|
-
*/
|
|
7811
|
-
403: Error;
|
|
7812
|
-
/**
|
|
7813
|
-
* Site not found
|
|
8425
|
+
* No consent config exists for this site yet
|
|
7814
8426
|
*/
|
|
7815
8427
|
404: Error;
|
|
7816
8428
|
};
|
|
7817
|
-
type
|
|
7818
|
-
type
|
|
8429
|
+
type GetConsentConfigWithSiteTokenError = GetConsentConfigWithSiteTokenErrors[keyof GetConsentConfigWithSiteTokenErrors];
|
|
8430
|
+
type GetConsentConfigWithSiteTokenResponses = {
|
|
7819
8431
|
/**
|
|
7820
|
-
* The site's
|
|
8432
|
+
* The site's consent configuration
|
|
7821
8433
|
*/
|
|
7822
|
-
200:
|
|
8434
|
+
200: ConsentConfig;
|
|
7823
8435
|
};
|
|
7824
|
-
type
|
|
7825
|
-
type
|
|
7826
|
-
body:
|
|
7827
|
-
path
|
|
7828
|
-
siteId: string;
|
|
7829
|
-
};
|
|
8436
|
+
type GetConsentConfigWithSiteTokenResponse = GetConsentConfigWithSiteTokenResponses[keyof GetConsentConfigWithSiteTokenResponses];
|
|
8437
|
+
type UpsertConsentConfigWithSiteTokenData = {
|
|
8438
|
+
body: UpsertConsentConfig;
|
|
8439
|
+
path?: never;
|
|
7830
8440
|
query?: never;
|
|
7831
|
-
url: "/api/v1/
|
|
8441
|
+
url: "/api/v1/site-prefs";
|
|
7832
8442
|
};
|
|
7833
|
-
type
|
|
8443
|
+
type UpsertConsentConfigWithSiteTokenErrors = {
|
|
7834
8444
|
/**
|
|
7835
|
-
*
|
|
8445
|
+
* Validation error
|
|
7836
8446
|
*/
|
|
7837
8447
|
400: Error;
|
|
7838
8448
|
/**
|
|
7839
|
-
* Unauthorized
|
|
8449
|
+
* Unauthorized - requires site token
|
|
7840
8450
|
*/
|
|
7841
8451
|
401: Error;
|
|
8452
|
+
};
|
|
8453
|
+
type UpsertConsentConfigWithSiteTokenError = UpsertConsentConfigWithSiteTokenErrors[keyof UpsertConsentConfigWithSiteTokenErrors];
|
|
8454
|
+
type UpsertConsentConfigWithSiteTokenResponses = {
|
|
7842
8455
|
/**
|
|
7843
|
-
*
|
|
8456
|
+
* The upserted consent configuration
|
|
7844
8457
|
*/
|
|
7845
|
-
|
|
8458
|
+
200: ConsentConfigResult;
|
|
8459
|
+
};
|
|
8460
|
+
type UpsertConsentConfigWithSiteTokenResponse = UpsertConsentConfigWithSiteTokenResponses[keyof UpsertConsentConfigWithSiteTokenResponses];
|
|
8461
|
+
type ListFormsWithSiteTokenData = {
|
|
8462
|
+
body?: never;
|
|
8463
|
+
path?: never;
|
|
8464
|
+
query?: never;
|
|
8465
|
+
url: "/api/v1/forms";
|
|
8466
|
+
};
|
|
8467
|
+
type ListFormsWithSiteTokenErrors = {
|
|
8468
|
+
/**
|
|
8469
|
+
* Unauthorized - requires site token
|
|
8470
|
+
*/
|
|
8471
|
+
401: Error;
|
|
7846
8472
|
/**
|
|
7847
8473
|
* Site not found
|
|
7848
8474
|
*/
|
|
7849
8475
|
404: Error;
|
|
8476
|
+
};
|
|
8477
|
+
type ListFormsWithSiteTokenError = ListFormsWithSiteTokenErrors[keyof ListFormsWithSiteTokenErrors];
|
|
8478
|
+
type ListFormsWithSiteTokenResponses = {
|
|
7850
8479
|
/**
|
|
7851
|
-
*
|
|
8480
|
+
* List of forms
|
|
7852
8481
|
*/
|
|
7853
|
-
|
|
8482
|
+
200: FormsList;
|
|
7854
8483
|
};
|
|
7855
|
-
type
|
|
7856
|
-
type
|
|
8484
|
+
type ListFormsWithSiteTokenResponse = ListFormsWithSiteTokenResponses[keyof ListFormsWithSiteTokenResponses];
|
|
8485
|
+
type CreateFormWithSiteTokenData = {
|
|
8486
|
+
body: CreateForm;
|
|
8487
|
+
path?: never;
|
|
8488
|
+
query?: never;
|
|
8489
|
+
url: "/api/v1/forms";
|
|
8490
|
+
};
|
|
8491
|
+
type CreateFormWithSiteTokenErrors = {
|
|
7857
8492
|
/**
|
|
7858
|
-
*
|
|
8493
|
+
* Form name indicates credential/payment collection, which is not supported
|
|
7859
8494
|
*/
|
|
7860
|
-
|
|
8495
|
+
400: Error;
|
|
8496
|
+
/**
|
|
8497
|
+
* Unauthorized - requires site token
|
|
8498
|
+
*/
|
|
8499
|
+
401: Error;
|
|
8500
|
+
/**
|
|
8501
|
+
* Site not found
|
|
8502
|
+
*/
|
|
8503
|
+
404: Error;
|
|
7861
8504
|
};
|
|
7862
|
-
type
|
|
7863
|
-
type
|
|
8505
|
+
type CreateFormWithSiteTokenError = CreateFormWithSiteTokenErrors[keyof CreateFormWithSiteTokenErrors];
|
|
8506
|
+
type CreateFormWithSiteTokenResponses = {
|
|
8507
|
+
/**
|
|
8508
|
+
* Form created successfully
|
|
8509
|
+
*/
|
|
8510
|
+
201: Form;
|
|
8511
|
+
};
|
|
8512
|
+
type CreateFormWithSiteTokenResponse = CreateFormWithSiteTokenResponses[keyof CreateFormWithSiteTokenResponses];
|
|
8513
|
+
type ListSitesData = {
|
|
7864
8514
|
body?: never;
|
|
7865
|
-
path
|
|
7866
|
-
|
|
8515
|
+
path?: never;
|
|
8516
|
+
query?: {
|
|
8517
|
+
/**
|
|
8518
|
+
* Exact match on the consumer-side id (the landingsite website id) — the lookup for "which aifeatures site is this website?"
|
|
8519
|
+
*/
|
|
8520
|
+
external_id?: string;
|
|
8521
|
+
/**
|
|
8522
|
+
* Maximum number of sites to return (default 50, max 100)
|
|
8523
|
+
*/
|
|
8524
|
+
limit?: string;
|
|
8525
|
+
/**
|
|
8526
|
+
* Number of sites to skip
|
|
8527
|
+
*/
|
|
8528
|
+
offset?: string;
|
|
8529
|
+
/**
|
|
8530
|
+
* Pass 'true' to include soft-deleted sites — hidden by default. Two kinds come back: rows with deleted_at set and purged_at null are inside the retention window and restorable; rows with purged_at ALSO set are tombstones the purge kept for their billing records — forms, catalog and config are gone and they cannot be restored. Because external_id may be reused by a successor site after a delete, an external_id lookup with include_deleted=true can return a live site beside its purged predecessor; read purged_at to tell them apart.
|
|
8531
|
+
*/
|
|
8532
|
+
include_deleted?: string;
|
|
7867
8533
|
};
|
|
7868
|
-
|
|
7869
|
-
url: "/api/v1/sites/{siteId}/forms";
|
|
8534
|
+
url: "/api/v1/sites";
|
|
7870
8535
|
};
|
|
7871
|
-
type
|
|
8536
|
+
type ListSitesErrors = {
|
|
7872
8537
|
/**
|
|
7873
8538
|
* Unauthorized
|
|
7874
8539
|
*/
|
|
7875
8540
|
401: Error;
|
|
7876
8541
|
/**
|
|
7877
|
-
*
|
|
8542
|
+
* Forbidden - site tokens cannot list sites
|
|
7878
8543
|
*/
|
|
7879
|
-
|
|
8544
|
+
403: Error;
|
|
7880
8545
|
};
|
|
7881
|
-
type
|
|
7882
|
-
type
|
|
8546
|
+
type ListSitesError = ListSitesErrors[keyof ListSitesErrors];
|
|
8547
|
+
type ListSitesResponses = {
|
|
7883
8548
|
/**
|
|
7884
|
-
* List of
|
|
8549
|
+
* List of sites
|
|
7885
8550
|
*/
|
|
7886
|
-
200:
|
|
8551
|
+
200: SitesList;
|
|
7887
8552
|
};
|
|
7888
|
-
type
|
|
7889
|
-
type
|
|
7890
|
-
body:
|
|
7891
|
-
path
|
|
7892
|
-
siteId: string;
|
|
7893
|
-
};
|
|
8553
|
+
type ListSitesResponse = ListSitesResponses[keyof ListSitesResponses];
|
|
8554
|
+
type CreateSiteData = {
|
|
8555
|
+
body: CreateSite;
|
|
8556
|
+
path?: never;
|
|
7894
8557
|
query?: never;
|
|
7895
|
-
url: "/api/v1/sites
|
|
8558
|
+
url: "/api/v1/sites";
|
|
7896
8559
|
};
|
|
7897
|
-
type
|
|
8560
|
+
type CreateSiteErrors = {
|
|
7898
8561
|
/**
|
|
7899
|
-
*
|
|
8562
|
+
* `timezone` is not a usable IANA zone name (code invalid_timezone). Nothing is minted — a rejected create leaves no half-provisioned site for the retry to collide with.
|
|
7900
8563
|
*/
|
|
7901
8564
|
400: Error;
|
|
7902
8565
|
/**
|
|
@@ -7904,81 +8567,93 @@ type CreateFormErrors = {
|
|
|
7904
8567
|
*/
|
|
7905
8568
|
401: Error;
|
|
7906
8569
|
/**
|
|
7907
|
-
*
|
|
8570
|
+
* Forbidden - site tokens cannot create sites
|
|
7908
8571
|
*/
|
|
7909
|
-
|
|
8572
|
+
403: Error;
|
|
8573
|
+
/**
|
|
8574
|
+
* Conflict. Either a site with this external_id already exists, or (code `analytics_id_taken`) the analytics_id is already claimed by another site — the latter is permanent, so do not retry it.
|
|
8575
|
+
*/
|
|
8576
|
+
409: Error;
|
|
7910
8577
|
};
|
|
7911
|
-
type
|
|
7912
|
-
type
|
|
8578
|
+
type CreateSiteError = CreateSiteErrors[keyof CreateSiteErrors];
|
|
8579
|
+
type CreateSiteResponses = {
|
|
7913
8580
|
/**
|
|
7914
|
-
*
|
|
8581
|
+
* Site created successfully. The api_token is only returned once!
|
|
7915
8582
|
*/
|
|
7916
|
-
201:
|
|
8583
|
+
201: SiteWithToken;
|
|
7917
8584
|
};
|
|
7918
|
-
type
|
|
7919
|
-
type
|
|
8585
|
+
type CreateSiteResponse = CreateSiteResponses[keyof CreateSiteResponses];
|
|
8586
|
+
type DeleteSiteData = {
|
|
7920
8587
|
body?: never;
|
|
7921
8588
|
path: {
|
|
7922
|
-
|
|
8589
|
+
siteId: string;
|
|
7923
8590
|
};
|
|
7924
8591
|
query?: never;
|
|
7925
|
-
url: "/api/v1/
|
|
8592
|
+
url: "/api/v1/sites/{siteId}";
|
|
7926
8593
|
};
|
|
7927
|
-
type
|
|
8594
|
+
type DeleteSiteErrors = {
|
|
7928
8595
|
/**
|
|
7929
8596
|
* Unauthorized
|
|
7930
8597
|
*/
|
|
7931
8598
|
401: Error;
|
|
7932
8599
|
/**
|
|
7933
|
-
*
|
|
8600
|
+
* Forbidden - site tokens cannot delete sites
|
|
8601
|
+
*/
|
|
8602
|
+
403: Error;
|
|
8603
|
+
/**
|
|
8604
|
+
* Site not found. `code` distinguishes `site_not_found` (no such site — an idempotent re-delete of an already-purged site is complete) from `site_not_accessible` (the site exists under another organization — a wrong or rotated key; retry with the right one). Safe to disclose here because this route is org-key-only.
|
|
7934
8605
|
*/
|
|
7935
8606
|
404: Error;
|
|
8607
|
+
/**
|
|
8608
|
+
* Promotion cleanup could not complete; retry deletion. The live site remains accessible until its remote promotions are disabled.
|
|
8609
|
+
*/
|
|
8610
|
+
503: Error;
|
|
7936
8611
|
};
|
|
7937
|
-
type
|
|
7938
|
-
type
|
|
8612
|
+
type DeleteSiteError = DeleteSiteErrors[keyof DeleteSiteErrors];
|
|
8613
|
+
type DeleteSiteResponses = {
|
|
7939
8614
|
/**
|
|
7940
|
-
*
|
|
8615
|
+
* Site deleted successfully
|
|
7941
8616
|
*/
|
|
7942
8617
|
204: void;
|
|
7943
8618
|
};
|
|
7944
|
-
type
|
|
7945
|
-
type
|
|
8619
|
+
type DeleteSiteResponse = DeleteSiteResponses[keyof DeleteSiteResponses];
|
|
8620
|
+
type GetSiteData = {
|
|
7946
8621
|
body?: never;
|
|
7947
8622
|
path: {
|
|
7948
|
-
|
|
8623
|
+
siteId: string;
|
|
7949
8624
|
};
|
|
7950
8625
|
query?: never;
|
|
7951
|
-
url: "/api/v1/
|
|
8626
|
+
url: "/api/v1/sites/{siteId}";
|
|
7952
8627
|
};
|
|
7953
|
-
type
|
|
8628
|
+
type GetSiteErrors = {
|
|
7954
8629
|
/**
|
|
7955
8630
|
* Unauthorized
|
|
7956
8631
|
*/
|
|
7957
8632
|
401: Error;
|
|
7958
8633
|
/**
|
|
7959
|
-
*
|
|
8634
|
+
* Site not found
|
|
7960
8635
|
*/
|
|
7961
8636
|
404: Error;
|
|
7962
8637
|
};
|
|
7963
|
-
type
|
|
7964
|
-
type
|
|
8638
|
+
type GetSiteError = GetSiteErrors[keyof GetSiteErrors];
|
|
8639
|
+
type GetSiteResponses = {
|
|
7965
8640
|
/**
|
|
7966
|
-
*
|
|
8641
|
+
* Site details
|
|
7967
8642
|
*/
|
|
7968
|
-
200:
|
|
8643
|
+
200: Site;
|
|
7969
8644
|
};
|
|
7970
|
-
type
|
|
7971
|
-
type
|
|
7972
|
-
body:
|
|
8645
|
+
type GetSiteResponse = GetSiteResponses[keyof GetSiteResponses];
|
|
8646
|
+
type UpdateSiteData = {
|
|
8647
|
+
body: UpdateSite;
|
|
7973
8648
|
path: {
|
|
7974
|
-
|
|
8649
|
+
siteId: string;
|
|
7975
8650
|
};
|
|
7976
8651
|
query?: never;
|
|
7977
|
-
url: "/api/v1/
|
|
8652
|
+
url: "/api/v1/sites/{siteId}";
|
|
7978
8653
|
};
|
|
7979
|
-
type
|
|
8654
|
+
type UpdateSiteErrors = {
|
|
7980
8655
|
/**
|
|
7981
|
-
*
|
|
8656
|
+
* Invalid shipping configuration (a rate amount out of bounds or an invalid free_shipping_over — the message names the offending rate), a currency outside Stripe's presentment allowlist, or `currency` combined with shipping_rates/free_shipping_over in one request (change currency first, then set rates).
|
|
7982
8657
|
*/
|
|
7983
8658
|
400: Error;
|
|
7984
8659
|
/**
|
|
@@ -7986,447 +8661,510 @@ type UpdateFormErrors = {
|
|
|
7986
8661
|
*/
|
|
7987
8662
|
401: Error;
|
|
7988
8663
|
/**
|
|
7989
|
-
*
|
|
8664
|
+
* `currency` sent with an organization API key. Setting the store currency here is a merchant-explicit write (it PINS the currency against platform sync) and requires the site's own token; platform/operator currency changes go through PATCH /sites/{siteId}/payments.
|
|
8665
|
+
*/
|
|
8666
|
+
403: Error;
|
|
8667
|
+
/**
|
|
8668
|
+
* Site not found
|
|
7990
8669
|
*/
|
|
7991
8670
|
404: Error;
|
|
8671
|
+
/**
|
|
8672
|
+
* Currency changed too recently — each accepted change restates the whole catalogue, so changes are rate-limited per site. Retry after the cooldown.
|
|
8673
|
+
*/
|
|
8674
|
+
429: Error;
|
|
7992
8675
|
};
|
|
7993
|
-
type
|
|
7994
|
-
type
|
|
8676
|
+
type UpdateSiteError = UpdateSiteErrors[keyof UpdateSiteErrors];
|
|
8677
|
+
type UpdateSiteResponses = {
|
|
7995
8678
|
/**
|
|
7996
|
-
*
|
|
8679
|
+
* Site updated. When the request carried `currency`, `currency_restatement` reports the outcome — including blocked outcomes (orders exist, an amount can't survive the move): those are 200s with the block described, and any other fields in the request still applied.
|
|
7997
8680
|
*/
|
|
7998
|
-
200:
|
|
8681
|
+
200: SiteWithRestatement;
|
|
7999
8682
|
};
|
|
8000
|
-
type
|
|
8001
|
-
type
|
|
8683
|
+
type UpdateSiteResponse = UpdateSiteResponses[keyof UpdateSiteResponses];
|
|
8684
|
+
type GetSiteCheckoutPauseData = {
|
|
8002
8685
|
body?: never;
|
|
8003
8686
|
path: {
|
|
8004
|
-
|
|
8005
|
-
};
|
|
8006
|
-
query?: {
|
|
8007
|
-
/**
|
|
8008
|
-
* Maximum number of submissions to return (max 100)
|
|
8009
|
-
*/
|
|
8010
|
-
limit?: string;
|
|
8011
|
-
/**
|
|
8012
|
-
* Number of submissions to skip
|
|
8013
|
-
*/
|
|
8014
|
-
offset?: string;
|
|
8015
|
-
/**
|
|
8016
|
-
* Include spam submissions (default: false)
|
|
8017
|
-
*/
|
|
8018
|
-
include_spam?: string;
|
|
8687
|
+
siteId: string;
|
|
8019
8688
|
};
|
|
8020
|
-
|
|
8689
|
+
query?: never;
|
|
8690
|
+
url: "/api/v1/sites/{siteId}/checkout-pause";
|
|
8021
8691
|
};
|
|
8022
|
-
type
|
|
8692
|
+
type GetSiteCheckoutPauseErrors = {
|
|
8023
8693
|
/**
|
|
8024
8694
|
* Unauthorized
|
|
8025
8695
|
*/
|
|
8026
8696
|
401: Error;
|
|
8027
8697
|
/**
|
|
8028
|
-
*
|
|
8698
|
+
* Forbidden - site tokens cannot read checkout pause state
|
|
8699
|
+
*/
|
|
8700
|
+
403: Error;
|
|
8701
|
+
/**
|
|
8702
|
+
* Site not found
|
|
8029
8703
|
*/
|
|
8030
8704
|
404: Error;
|
|
8031
8705
|
};
|
|
8032
|
-
type
|
|
8033
|
-
type
|
|
8706
|
+
type GetSiteCheckoutPauseError = GetSiteCheckoutPauseErrors[keyof GetSiteCheckoutPauseErrors];
|
|
8707
|
+
type GetSiteCheckoutPauseResponses = {
|
|
8034
8708
|
/**
|
|
8035
|
-
*
|
|
8709
|
+
* Current pause state
|
|
8036
8710
|
*/
|
|
8037
|
-
200:
|
|
8711
|
+
200: CheckoutPauseState;
|
|
8038
8712
|
};
|
|
8039
|
-
type
|
|
8040
|
-
type
|
|
8041
|
-
body
|
|
8713
|
+
type GetSiteCheckoutPauseResponse = GetSiteCheckoutPauseResponses[keyof GetSiteCheckoutPauseResponses];
|
|
8714
|
+
type PauseSiteCheckoutData = {
|
|
8715
|
+
body: CheckoutPauseRequest;
|
|
8042
8716
|
path: {
|
|
8043
|
-
|
|
8717
|
+
siteId: string;
|
|
8044
8718
|
};
|
|
8045
8719
|
query?: never;
|
|
8046
|
-
url: "/api/v1/
|
|
8720
|
+
url: "/api/v1/sites/{siteId}/checkout-pause";
|
|
8047
8721
|
};
|
|
8048
|
-
type
|
|
8722
|
+
type PauseSiteCheckoutErrors = {
|
|
8049
8723
|
/**
|
|
8050
8724
|
* Unauthorized
|
|
8051
8725
|
*/
|
|
8052
8726
|
401: Error;
|
|
8053
8727
|
/**
|
|
8054
|
-
*
|
|
8728
|
+
* Forbidden - site tokens cannot change checkout pause state
|
|
8729
|
+
*/
|
|
8730
|
+
403: Error;
|
|
8731
|
+
/**
|
|
8732
|
+
* Site not found
|
|
8055
8733
|
*/
|
|
8056
8734
|
404: Error;
|
|
8057
8735
|
};
|
|
8058
|
-
type
|
|
8059
|
-
type
|
|
8736
|
+
type PauseSiteCheckoutError = PauseSiteCheckoutErrors[keyof PauseSiteCheckoutErrors];
|
|
8737
|
+
type PauseSiteCheckoutResponses = {
|
|
8060
8738
|
/**
|
|
8061
|
-
*
|
|
8739
|
+
* Pause state updated (idempotent — re-pausing refreshes the timestamp and reason)
|
|
8062
8740
|
*/
|
|
8063
|
-
|
|
8741
|
+
200: CheckoutPauseState;
|
|
8064
8742
|
};
|
|
8065
|
-
type
|
|
8066
|
-
type
|
|
8067
|
-
body
|
|
8743
|
+
type PauseSiteCheckoutResponse = PauseSiteCheckoutResponses[keyof PauseSiteCheckoutResponses];
|
|
8744
|
+
type UpdateSiteDomainsData = {
|
|
8745
|
+
body: UpdateSiteDomains;
|
|
8068
8746
|
path: {
|
|
8069
|
-
|
|
8747
|
+
siteId: string;
|
|
8070
8748
|
};
|
|
8071
8749
|
query?: never;
|
|
8072
|
-
url: "/api/v1/
|
|
8750
|
+
url: "/api/v1/sites/{siteId}/domains";
|
|
8073
8751
|
};
|
|
8074
|
-
type
|
|
8752
|
+
type UpdateSiteDomainsErrors = {
|
|
8075
8753
|
/**
|
|
8076
8754
|
* Unauthorized
|
|
8077
8755
|
*/
|
|
8078
8756
|
401: Error;
|
|
8079
8757
|
/**
|
|
8080
|
-
*
|
|
8081
|
-
*/
|
|
8082
|
-
404: Error;
|
|
8083
|
-
};
|
|
8084
|
-
type GetSubmissionError = GetSubmissionErrors[keyof GetSubmissionErrors];
|
|
8085
|
-
type GetSubmissionResponses = {
|
|
8086
|
-
/**
|
|
8087
|
-
* Submission details
|
|
8088
|
-
*/
|
|
8089
|
-
200: Submission;
|
|
8090
|
-
};
|
|
8091
|
-
type GetSubmissionResponse = GetSubmissionResponses[keyof GetSubmissionResponses];
|
|
8092
|
-
type DownloadAttachmentData = {
|
|
8093
|
-
body?: never;
|
|
8094
|
-
path: {
|
|
8095
|
-
submissionId: string;
|
|
8096
|
-
/**
|
|
8097
|
-
* Attachment id, or a filename for legacy submissions without ids
|
|
8098
|
-
*/
|
|
8099
|
-
attachmentId: string;
|
|
8100
|
-
};
|
|
8101
|
-
query?: never;
|
|
8102
|
-
url: "/api/v1/submissions/{submissionId}/attachments/{attachmentId}";
|
|
8103
|
-
};
|
|
8104
|
-
type DownloadAttachmentErrors = {
|
|
8105
|
-
/**
|
|
8106
|
-
* Unauthorized
|
|
8758
|
+
* Forbidden - site tokens cannot modify the domains allowlist
|
|
8107
8759
|
*/
|
|
8108
|
-
|
|
8760
|
+
403: Error;
|
|
8109
8761
|
/**
|
|
8110
|
-
*
|
|
8762
|
+
* Site not found
|
|
8111
8763
|
*/
|
|
8112
8764
|
404: Error;
|
|
8113
8765
|
};
|
|
8114
|
-
type
|
|
8115
|
-
type
|
|
8766
|
+
type UpdateSiteDomainsError = UpdateSiteDomainsErrors[keyof UpdateSiteDomainsErrors];
|
|
8767
|
+
type UpdateSiteDomainsResponses = {
|
|
8116
8768
|
/**
|
|
8117
|
-
*
|
|
8769
|
+
* Site domains updated successfully
|
|
8118
8770
|
*/
|
|
8119
|
-
200:
|
|
8771
|
+
200: SiteDomains;
|
|
8120
8772
|
};
|
|
8121
|
-
type
|
|
8773
|
+
type UpdateSiteDomainsResponse = UpdateSiteDomainsResponses[keyof UpdateSiteDomainsResponses];
|
|
8774
|
+
type GetSiteAnalyticsData = {
|
|
8122
8775
|
body?: never;
|
|
8123
8776
|
path: {
|
|
8124
8777
|
siteId: string;
|
|
8125
8778
|
};
|
|
8126
8779
|
query?: never;
|
|
8127
|
-
url: "/api/v1/sites/{siteId}/
|
|
8780
|
+
url: "/api/v1/sites/{siteId}/analytics";
|
|
8128
8781
|
};
|
|
8129
|
-
type
|
|
8782
|
+
type GetSiteAnalyticsErrors = {
|
|
8130
8783
|
/**
|
|
8131
8784
|
* Unauthorized
|
|
8132
8785
|
*/
|
|
8133
8786
|
401: Error;
|
|
8787
|
+
/**
|
|
8788
|
+
* Forbidden - site tokens cannot read the analytics identity
|
|
8789
|
+
*/
|
|
8790
|
+
403: Error;
|
|
8134
8791
|
/**
|
|
8135
8792
|
* Site not found
|
|
8136
8793
|
*/
|
|
8137
8794
|
404: Error;
|
|
8138
8795
|
};
|
|
8139
|
-
type
|
|
8140
|
-
type
|
|
8796
|
+
type GetSiteAnalyticsError = GetSiteAnalyticsErrors[keyof GetSiteAnalyticsErrors];
|
|
8797
|
+
type GetSiteAnalyticsResponses = {
|
|
8141
8798
|
/**
|
|
8142
|
-
*
|
|
8799
|
+
* The site's analytics identity and resolved reporting zone
|
|
8143
8800
|
*/
|
|
8144
|
-
200:
|
|
8801
|
+
200: SiteAnalytics;
|
|
8145
8802
|
};
|
|
8146
|
-
type
|
|
8147
|
-
type
|
|
8148
|
-
body:
|
|
8803
|
+
type GetSiteAnalyticsResponse = GetSiteAnalyticsResponses[keyof GetSiteAnalyticsResponses];
|
|
8804
|
+
type UpdateSiteAnalyticsData = {
|
|
8805
|
+
body: UpdateSiteAnalytics;
|
|
8149
8806
|
path: {
|
|
8150
8807
|
siteId: string;
|
|
8151
8808
|
};
|
|
8152
8809
|
query?: never;
|
|
8153
|
-
url: "/api/v1/sites/{siteId}/
|
|
8810
|
+
url: "/api/v1/sites/{siteId}/analytics";
|
|
8154
8811
|
};
|
|
8155
|
-
type
|
|
8812
|
+
type UpdateSiteAnalyticsErrors = {
|
|
8156
8813
|
/**
|
|
8157
|
-
*
|
|
8814
|
+
* `timezone` is not a usable IANA zone name (code invalid_timezone), or `analytics_id` is blank/over-length. NOTHING from the request lands — a half-applied identity write is how a site ends up pointed at traffic it then reports in the wrong local days.
|
|
8158
8815
|
*/
|
|
8159
8816
|
400: Error;
|
|
8160
8817
|
/**
|
|
8161
8818
|
* Unauthorized
|
|
8162
8819
|
*/
|
|
8163
8820
|
401: Error;
|
|
8821
|
+
/**
|
|
8822
|
+
* Forbidden - site tokens cannot write the analytics identity or the reporting timezone
|
|
8823
|
+
*/
|
|
8824
|
+
403: Error;
|
|
8164
8825
|
/**
|
|
8165
8826
|
* Site not found
|
|
8166
8827
|
*/
|
|
8167
8828
|
404: Error;
|
|
8829
|
+
/**
|
|
8830
|
+
* The analytics_id is already claimed by another site. Permanent: the id belongs to that site until a human moves it, so do not retry.
|
|
8831
|
+
*/
|
|
8832
|
+
409: Error;
|
|
8168
8833
|
};
|
|
8169
|
-
type
|
|
8170
|
-
type
|
|
8834
|
+
type UpdateSiteAnalyticsError = UpdateSiteAnalyticsErrors[keyof UpdateSiteAnalyticsErrors];
|
|
8835
|
+
type UpdateSiteAnalyticsResponses = {
|
|
8171
8836
|
/**
|
|
8172
|
-
*
|
|
8837
|
+
* Analytics identity updated (an empty body is a plain read)
|
|
8173
8838
|
*/
|
|
8174
|
-
|
|
8839
|
+
200: SiteAnalytics;
|
|
8175
8840
|
};
|
|
8176
|
-
type
|
|
8177
|
-
type
|
|
8841
|
+
type UpdateSiteAnalyticsResponse = UpdateSiteAnalyticsResponses[keyof UpdateSiteAnalyticsResponses];
|
|
8842
|
+
type ListFormsData = {
|
|
8178
8843
|
body?: never;
|
|
8179
8844
|
path: {
|
|
8180
8845
|
siteId: string;
|
|
8181
|
-
destinationId: string;
|
|
8182
8846
|
};
|
|
8183
8847
|
query?: never;
|
|
8184
|
-
url: "/api/v1/sites/{siteId}/
|
|
8848
|
+
url: "/api/v1/sites/{siteId}/forms";
|
|
8185
8849
|
};
|
|
8186
|
-
type
|
|
8850
|
+
type ListFormsErrors = {
|
|
8187
8851
|
/**
|
|
8188
8852
|
* Unauthorized
|
|
8189
8853
|
*/
|
|
8190
8854
|
401: Error;
|
|
8191
8855
|
/**
|
|
8192
|
-
*
|
|
8856
|
+
* Site not found
|
|
8193
8857
|
*/
|
|
8194
8858
|
404: Error;
|
|
8195
8859
|
};
|
|
8196
|
-
type
|
|
8197
|
-
type
|
|
8860
|
+
type ListFormsError = ListFormsErrors[keyof ListFormsErrors];
|
|
8861
|
+
type ListFormsResponses = {
|
|
8198
8862
|
/**
|
|
8199
|
-
*
|
|
8863
|
+
* List of forms
|
|
8200
8864
|
*/
|
|
8201
|
-
200:
|
|
8202
|
-
success: boolean;
|
|
8203
|
-
};
|
|
8865
|
+
200: FormsList;
|
|
8204
8866
|
};
|
|
8205
|
-
type
|
|
8206
|
-
type
|
|
8207
|
-
body
|
|
8867
|
+
type ListFormsResponse = ListFormsResponses[keyof ListFormsResponses];
|
|
8868
|
+
type CreateFormData = {
|
|
8869
|
+
body: CreateForm;
|
|
8208
8870
|
path: {
|
|
8209
8871
|
siteId: string;
|
|
8210
|
-
destinationId: string;
|
|
8211
8872
|
};
|
|
8212
8873
|
query?: never;
|
|
8213
|
-
url: "/api/v1/sites/{siteId}/
|
|
8874
|
+
url: "/api/v1/sites/{siteId}/forms";
|
|
8214
8875
|
};
|
|
8215
|
-
type
|
|
8876
|
+
type CreateFormErrors = {
|
|
8877
|
+
/**
|
|
8878
|
+
* Form name indicates credential/payment collection, which is not supported
|
|
8879
|
+
*/
|
|
8880
|
+
400: Error;
|
|
8216
8881
|
/**
|
|
8217
8882
|
* Unauthorized
|
|
8218
8883
|
*/
|
|
8219
8884
|
401: Error;
|
|
8220
8885
|
/**
|
|
8221
|
-
*
|
|
8886
|
+
* Site not found
|
|
8222
8887
|
*/
|
|
8223
8888
|
404: Error;
|
|
8224
8889
|
};
|
|
8225
|
-
type
|
|
8226
|
-
type
|
|
8890
|
+
type CreateFormError = CreateFormErrors[keyof CreateFormErrors];
|
|
8891
|
+
type CreateFormResponses = {
|
|
8227
8892
|
/**
|
|
8228
|
-
*
|
|
8893
|
+
* Form created successfully
|
|
8229
8894
|
*/
|
|
8230
|
-
|
|
8895
|
+
201: Form;
|
|
8231
8896
|
};
|
|
8232
|
-
type
|
|
8233
|
-
type
|
|
8234
|
-
body
|
|
8897
|
+
type CreateFormResponse = CreateFormResponses[keyof CreateFormResponses];
|
|
8898
|
+
type DeleteFormData = {
|
|
8899
|
+
body?: never;
|
|
8235
8900
|
path: {
|
|
8236
|
-
|
|
8237
|
-
destinationId: string;
|
|
8901
|
+
formId: string;
|
|
8238
8902
|
};
|
|
8239
8903
|
query?: never;
|
|
8240
|
-
url: "/api/v1/
|
|
8904
|
+
url: "/api/v1/forms/{formId}";
|
|
8241
8905
|
};
|
|
8242
|
-
type
|
|
8243
|
-
/**
|
|
8244
|
-
* Invalid URL or unknown topic
|
|
8245
|
-
*/
|
|
8246
|
-
400: Error;
|
|
8906
|
+
type DeleteFormErrors = {
|
|
8247
8907
|
/**
|
|
8248
8908
|
* Unauthorized
|
|
8249
8909
|
*/
|
|
8250
8910
|
401: Error;
|
|
8251
8911
|
/**
|
|
8252
|
-
*
|
|
8912
|
+
* Form not found
|
|
8253
8913
|
*/
|
|
8254
8914
|
404: Error;
|
|
8255
8915
|
};
|
|
8256
|
-
type
|
|
8257
|
-
type
|
|
8916
|
+
type DeleteFormError = DeleteFormErrors[keyof DeleteFormErrors];
|
|
8917
|
+
type DeleteFormResponses = {
|
|
8258
8918
|
/**
|
|
8259
|
-
*
|
|
8919
|
+
* Form deleted successfully
|
|
8260
8920
|
*/
|
|
8261
|
-
|
|
8921
|
+
204: void;
|
|
8262
8922
|
};
|
|
8263
|
-
type
|
|
8264
|
-
type
|
|
8923
|
+
type DeleteFormResponse = DeleteFormResponses[keyof DeleteFormResponses];
|
|
8924
|
+
type GetFormData = {
|
|
8265
8925
|
body?: never;
|
|
8266
8926
|
path: {
|
|
8267
|
-
|
|
8268
|
-
destinationId: string;
|
|
8927
|
+
formId: string;
|
|
8269
8928
|
};
|
|
8270
8929
|
query?: never;
|
|
8271
|
-
url: "/api/v1/
|
|
8930
|
+
url: "/api/v1/forms/{formId}";
|
|
8272
8931
|
};
|
|
8273
|
-
type
|
|
8932
|
+
type GetFormErrors = {
|
|
8274
8933
|
/**
|
|
8275
8934
|
* Unauthorized
|
|
8276
8935
|
*/
|
|
8277
8936
|
401: Error;
|
|
8278
8937
|
/**
|
|
8279
|
-
*
|
|
8938
|
+
* Form not found
|
|
8280
8939
|
*/
|
|
8281
8940
|
404: Error;
|
|
8282
8941
|
};
|
|
8283
|
-
type
|
|
8284
|
-
type
|
|
8942
|
+
type GetFormError = GetFormErrors[keyof GetFormErrors];
|
|
8943
|
+
type GetFormResponses = {
|
|
8285
8944
|
/**
|
|
8286
|
-
*
|
|
8945
|
+
* Form details
|
|
8287
8946
|
*/
|
|
8288
|
-
200:
|
|
8947
|
+
200: Form;
|
|
8289
8948
|
};
|
|
8290
|
-
type
|
|
8291
|
-
type
|
|
8292
|
-
body
|
|
8949
|
+
type GetFormResponse = GetFormResponses[keyof GetFormResponses];
|
|
8950
|
+
type UpdateFormData = {
|
|
8951
|
+
body: UpdateForm;
|
|
8293
8952
|
path: {
|
|
8294
|
-
|
|
8295
|
-
destinationId: string;
|
|
8953
|
+
formId: string;
|
|
8296
8954
|
};
|
|
8297
8955
|
query?: never;
|
|
8298
|
-
url: "/api/v1/
|
|
8956
|
+
url: "/api/v1/forms/{formId}";
|
|
8299
8957
|
};
|
|
8300
|
-
type
|
|
8958
|
+
type UpdateFormErrors = {
|
|
8959
|
+
/**
|
|
8960
|
+
* Form name indicates credential/payment collection, which is not supported
|
|
8961
|
+
*/
|
|
8962
|
+
400: Error;
|
|
8301
8963
|
/**
|
|
8302
8964
|
* Unauthorized
|
|
8303
8965
|
*/
|
|
8304
8966
|
401: Error;
|
|
8305
8967
|
/**
|
|
8306
|
-
*
|
|
8968
|
+
* Form not found
|
|
8307
8969
|
*/
|
|
8308
8970
|
404: Error;
|
|
8309
8971
|
};
|
|
8310
|
-
type
|
|
8311
|
-
type
|
|
8972
|
+
type UpdateFormError = UpdateFormErrors[keyof UpdateFormErrors];
|
|
8973
|
+
type UpdateFormResponses = {
|
|
8312
8974
|
/**
|
|
8313
|
-
*
|
|
8975
|
+
* Form updated successfully
|
|
8314
8976
|
*/
|
|
8315
|
-
200:
|
|
8977
|
+
200: Form;
|
|
8316
8978
|
};
|
|
8317
|
-
type
|
|
8318
|
-
type
|
|
8979
|
+
type UpdateFormResponse = UpdateFormResponses[keyof UpdateFormResponses];
|
|
8980
|
+
type ListSubmissionsData = {
|
|
8319
8981
|
body?: never;
|
|
8320
8982
|
path: {
|
|
8321
|
-
|
|
8322
|
-
destinationId: string;
|
|
8983
|
+
formId: string;
|
|
8323
8984
|
};
|
|
8324
8985
|
query?: {
|
|
8325
|
-
|
|
8986
|
+
/**
|
|
8987
|
+
* Maximum number of submissions to return (max 100)
|
|
8988
|
+
*/
|
|
8989
|
+
limit?: string;
|
|
8990
|
+
/**
|
|
8991
|
+
* Number of submissions to skip
|
|
8992
|
+
*/
|
|
8993
|
+
offset?: string;
|
|
8994
|
+
/**
|
|
8995
|
+
* Include spam submissions (default: false)
|
|
8996
|
+
*/
|
|
8997
|
+
include_spam?: string;
|
|
8326
8998
|
};
|
|
8327
|
-
url: "/api/v1/
|
|
8999
|
+
url: "/api/v1/forms/{formId}/submissions";
|
|
8328
9000
|
};
|
|
8329
|
-
type
|
|
9001
|
+
type ListSubmissionsErrors = {
|
|
8330
9002
|
/**
|
|
8331
9003
|
* Unauthorized
|
|
8332
9004
|
*/
|
|
8333
9005
|
401: Error;
|
|
8334
9006
|
/**
|
|
8335
|
-
*
|
|
9007
|
+
* Form not found
|
|
8336
9008
|
*/
|
|
8337
9009
|
404: Error;
|
|
8338
9010
|
};
|
|
8339
|
-
type
|
|
8340
|
-
type
|
|
9011
|
+
type ListSubmissionsError = ListSubmissionsErrors[keyof ListSubmissionsErrors];
|
|
9012
|
+
type ListSubmissionsResponses = {
|
|
8341
9013
|
/**
|
|
8342
|
-
*
|
|
9014
|
+
* List of submissions
|
|
8343
9015
|
*/
|
|
8344
|
-
200:
|
|
9016
|
+
200: SubmissionsList;
|
|
8345
9017
|
};
|
|
8346
|
-
type
|
|
8347
|
-
type
|
|
9018
|
+
type ListSubmissionsResponse = ListSubmissionsResponses[keyof ListSubmissionsResponses];
|
|
9019
|
+
type DeleteSubmissionData = {
|
|
8348
9020
|
body?: never;
|
|
8349
9021
|
path: {
|
|
8350
|
-
|
|
8351
|
-
destinationId: string;
|
|
8352
|
-
deliveryId: string;
|
|
9022
|
+
submissionId: string;
|
|
8353
9023
|
};
|
|
8354
9024
|
query?: never;
|
|
8355
|
-
url: "/api/v1/
|
|
9025
|
+
url: "/api/v1/submissions/{submissionId}";
|
|
8356
9026
|
};
|
|
8357
|
-
type
|
|
9027
|
+
type DeleteSubmissionErrors = {
|
|
8358
9028
|
/**
|
|
8359
9029
|
* Unauthorized
|
|
8360
9030
|
*/
|
|
8361
9031
|
401: Error;
|
|
8362
9032
|
/**
|
|
8363
|
-
*
|
|
9033
|
+
* Submission not found
|
|
8364
9034
|
*/
|
|
8365
9035
|
404: Error;
|
|
8366
9036
|
};
|
|
8367
|
-
type
|
|
8368
|
-
type
|
|
9037
|
+
type DeleteSubmissionError = DeleteSubmissionErrors[keyof DeleteSubmissionErrors];
|
|
9038
|
+
type DeleteSubmissionResponses = {
|
|
8369
9039
|
/**
|
|
8370
|
-
*
|
|
9040
|
+
* Submission deleted successfully
|
|
8371
9041
|
*/
|
|
8372
|
-
|
|
9042
|
+
204: void;
|
|
8373
9043
|
};
|
|
8374
|
-
type
|
|
8375
|
-
type
|
|
9044
|
+
type DeleteSubmissionResponse = DeleteSubmissionResponses[keyof DeleteSubmissionResponses];
|
|
9045
|
+
type GetSubmissionData = {
|
|
8376
9046
|
body?: never;
|
|
8377
|
-
path
|
|
9047
|
+
path: {
|
|
9048
|
+
submissionId: string;
|
|
9049
|
+
};
|
|
8378
9050
|
query?: never;
|
|
8379
|
-
url: "/api/v1/
|
|
9051
|
+
url: "/api/v1/submissions/{submissionId}";
|
|
8380
9052
|
};
|
|
8381
|
-
type
|
|
9053
|
+
type GetSubmissionErrors = {
|
|
8382
9054
|
/**
|
|
8383
|
-
* Unauthorized
|
|
9055
|
+
* Unauthorized
|
|
8384
9056
|
*/
|
|
8385
9057
|
401: Error;
|
|
9058
|
+
/**
|
|
9059
|
+
* Submission not found
|
|
9060
|
+
*/
|
|
9061
|
+
404: Error;
|
|
8386
9062
|
};
|
|
8387
|
-
type
|
|
8388
|
-
type
|
|
9063
|
+
type GetSubmissionError = GetSubmissionErrors[keyof GetSubmissionErrors];
|
|
9064
|
+
type GetSubmissionResponses = {
|
|
9065
|
+
/**
|
|
9066
|
+
* Submission details
|
|
9067
|
+
*/
|
|
9068
|
+
200: Submission;
|
|
9069
|
+
};
|
|
9070
|
+
type GetSubmissionResponse = GetSubmissionResponses[keyof GetSubmissionResponses];
|
|
9071
|
+
type DownloadAttachmentData = {
|
|
9072
|
+
body?: never;
|
|
9073
|
+
path: {
|
|
9074
|
+
submissionId: string;
|
|
9075
|
+
/**
|
|
9076
|
+
* Attachment id, or a filename for legacy submissions without ids
|
|
9077
|
+
*/
|
|
9078
|
+
attachmentId: string;
|
|
9079
|
+
};
|
|
9080
|
+
query?: never;
|
|
9081
|
+
url: "/api/v1/submissions/{submissionId}/attachments/{attachmentId}";
|
|
9082
|
+
};
|
|
9083
|
+
type DownloadAttachmentErrors = {
|
|
9084
|
+
/**
|
|
9085
|
+
* Unauthorized
|
|
9086
|
+
*/
|
|
9087
|
+
401: Error;
|
|
9088
|
+
/**
|
|
9089
|
+
* Submission or attachment not found
|
|
9090
|
+
*/
|
|
9091
|
+
404: Error;
|
|
9092
|
+
};
|
|
9093
|
+
type DownloadAttachmentError = DownloadAttachmentErrors[keyof DownloadAttachmentErrors];
|
|
9094
|
+
type DownloadAttachmentResponses = {
|
|
9095
|
+
/**
|
|
9096
|
+
* File content
|
|
9097
|
+
*/
|
|
9098
|
+
200: unknown;
|
|
9099
|
+
};
|
|
9100
|
+
type ListEventDestinationsData = {
|
|
9101
|
+
body?: never;
|
|
9102
|
+
path: {
|
|
9103
|
+
siteId: string;
|
|
9104
|
+
};
|
|
9105
|
+
query?: never;
|
|
9106
|
+
url: "/api/v1/sites/{siteId}/event-destinations";
|
|
9107
|
+
};
|
|
9108
|
+
type ListEventDestinationsErrors = {
|
|
9109
|
+
/**
|
|
9110
|
+
* Unauthorized
|
|
9111
|
+
*/
|
|
9112
|
+
401: Error;
|
|
9113
|
+
/**
|
|
9114
|
+
* Site not found
|
|
9115
|
+
*/
|
|
9116
|
+
404: Error;
|
|
9117
|
+
};
|
|
9118
|
+
type ListEventDestinationsError = ListEventDestinationsErrors[keyof ListEventDestinationsErrors];
|
|
9119
|
+
type ListEventDestinationsResponses = {
|
|
8389
9120
|
/**
|
|
8390
9121
|
* Destinations
|
|
8391
9122
|
*/
|
|
8392
9123
|
200: EventDestinationsList;
|
|
8393
9124
|
};
|
|
8394
|
-
type
|
|
8395
|
-
type
|
|
9125
|
+
type ListEventDestinationsResponse = ListEventDestinationsResponses[keyof ListEventDestinationsResponses];
|
|
9126
|
+
type CreateEventDestinationData = {
|
|
8396
9127
|
body: CreateEventDestination;
|
|
8397
|
-
path
|
|
9128
|
+
path: {
|
|
9129
|
+
siteId: string;
|
|
9130
|
+
};
|
|
8398
9131
|
query?: never;
|
|
8399
|
-
url: "/api/v1/event-destinations";
|
|
9132
|
+
url: "/api/v1/sites/{siteId}/event-destinations";
|
|
8400
9133
|
};
|
|
8401
|
-
type
|
|
9134
|
+
type CreateEventDestinationErrors = {
|
|
8402
9135
|
/**
|
|
8403
9136
|
* Invalid URL, unknown topic, or unknown form
|
|
8404
9137
|
*/
|
|
8405
9138
|
400: Error;
|
|
8406
9139
|
/**
|
|
8407
|
-
* Unauthorized
|
|
9140
|
+
* Unauthorized
|
|
8408
9141
|
*/
|
|
8409
9142
|
401: Error;
|
|
9143
|
+
/**
|
|
9144
|
+
* Site not found
|
|
9145
|
+
*/
|
|
9146
|
+
404: Error;
|
|
8410
9147
|
};
|
|
8411
|
-
type
|
|
8412
|
-
type
|
|
9148
|
+
type CreateEventDestinationError = CreateEventDestinationErrors[keyof CreateEventDestinationErrors];
|
|
9149
|
+
type CreateEventDestinationResponses = {
|
|
8413
9150
|
/**
|
|
8414
|
-
*
|
|
9151
|
+
* Destination created
|
|
8415
9152
|
*/
|
|
8416
9153
|
201: EventDestination;
|
|
8417
9154
|
};
|
|
8418
|
-
type
|
|
8419
|
-
type
|
|
9155
|
+
type CreateEventDestinationResponse = CreateEventDestinationResponses[keyof CreateEventDestinationResponses];
|
|
9156
|
+
type DeleteEventDestinationData = {
|
|
8420
9157
|
body?: never;
|
|
8421
9158
|
path: {
|
|
9159
|
+
siteId: string;
|
|
8422
9160
|
destinationId: string;
|
|
8423
9161
|
};
|
|
8424
9162
|
query?: never;
|
|
8425
|
-
url: "/api/v1/event-destinations/{destinationId}";
|
|
9163
|
+
url: "/api/v1/sites/{siteId}/event-destinations/{destinationId}";
|
|
8426
9164
|
};
|
|
8427
|
-
type
|
|
9165
|
+
type DeleteEventDestinationErrors = {
|
|
8428
9166
|
/**
|
|
8429
|
-
* Unauthorized
|
|
9167
|
+
* Unauthorized
|
|
8430
9168
|
*/
|
|
8431
9169
|
401: Error;
|
|
8432
9170
|
/**
|
|
@@ -8434,8 +9172,8 @@ type DeleteEventDestinationWithSiteTokenErrors = {
|
|
|
8434
9172
|
*/
|
|
8435
9173
|
404: Error;
|
|
8436
9174
|
};
|
|
8437
|
-
type
|
|
8438
|
-
type
|
|
9175
|
+
type DeleteEventDestinationError = DeleteEventDestinationErrors[keyof DeleteEventDestinationErrors];
|
|
9176
|
+
type DeleteEventDestinationResponses = {
|
|
8439
9177
|
/**
|
|
8440
9178
|
* Deleted
|
|
8441
9179
|
*/
|
|
@@ -8443,22 +9181,50 @@ type DeleteEventDestinationWithSiteTokenResponses = {
|
|
|
8443
9181
|
success: boolean;
|
|
8444
9182
|
};
|
|
8445
9183
|
};
|
|
8446
|
-
type
|
|
8447
|
-
type
|
|
9184
|
+
type DeleteEventDestinationResponse = DeleteEventDestinationResponses[keyof DeleteEventDestinationResponses];
|
|
9185
|
+
type GetEventDestinationData = {
|
|
9186
|
+
body?: never;
|
|
9187
|
+
path: {
|
|
9188
|
+
siteId: string;
|
|
9189
|
+
destinationId: string;
|
|
9190
|
+
};
|
|
9191
|
+
query?: never;
|
|
9192
|
+
url: "/api/v1/sites/{siteId}/event-destinations/{destinationId}";
|
|
9193
|
+
};
|
|
9194
|
+
type GetEventDestinationErrors = {
|
|
9195
|
+
/**
|
|
9196
|
+
* Unauthorized
|
|
9197
|
+
*/
|
|
9198
|
+
401: Error;
|
|
9199
|
+
/**
|
|
9200
|
+
* Not found
|
|
9201
|
+
*/
|
|
9202
|
+
404: Error;
|
|
9203
|
+
};
|
|
9204
|
+
type GetEventDestinationError = GetEventDestinationErrors[keyof GetEventDestinationErrors];
|
|
9205
|
+
type GetEventDestinationResponses = {
|
|
9206
|
+
/**
|
|
9207
|
+
* Destination
|
|
9208
|
+
*/
|
|
9209
|
+
200: EventDestination;
|
|
9210
|
+
};
|
|
9211
|
+
type GetEventDestinationResponse = GetEventDestinationResponses[keyof GetEventDestinationResponses];
|
|
9212
|
+
type UpdateEventDestinationData = {
|
|
8448
9213
|
body: UpdateEventDestination;
|
|
8449
9214
|
path: {
|
|
9215
|
+
siteId: string;
|
|
8450
9216
|
destinationId: string;
|
|
8451
9217
|
};
|
|
8452
9218
|
query?: never;
|
|
8453
|
-
url: "/api/v1/event-destinations/{destinationId}";
|
|
9219
|
+
url: "/api/v1/sites/{siteId}/event-destinations/{destinationId}";
|
|
8454
9220
|
};
|
|
8455
|
-
type
|
|
9221
|
+
type UpdateEventDestinationErrors = {
|
|
8456
9222
|
/**
|
|
8457
9223
|
* Invalid URL or unknown topic
|
|
8458
9224
|
*/
|
|
8459
9225
|
400: Error;
|
|
8460
9226
|
/**
|
|
8461
|
-
* Unauthorized
|
|
9227
|
+
* Unauthorized
|
|
8462
9228
|
*/
|
|
8463
9229
|
401: Error;
|
|
8464
9230
|
/**
|
|
@@ -8466,25 +9232,26 @@ type UpdateEventDestinationWithSiteTokenErrors = {
|
|
|
8466
9232
|
*/
|
|
8467
9233
|
404: Error;
|
|
8468
9234
|
};
|
|
8469
|
-
type
|
|
8470
|
-
type
|
|
9235
|
+
type UpdateEventDestinationError = UpdateEventDestinationErrors[keyof UpdateEventDestinationErrors];
|
|
9236
|
+
type UpdateEventDestinationResponses = {
|
|
8471
9237
|
/**
|
|
8472
9238
|
* Updated
|
|
8473
9239
|
*/
|
|
8474
9240
|
200: EventDestination;
|
|
8475
9241
|
};
|
|
8476
|
-
type
|
|
8477
|
-
type
|
|
9242
|
+
type UpdateEventDestinationResponse = UpdateEventDestinationResponses[keyof UpdateEventDestinationResponses];
|
|
9243
|
+
type RotateEventDestinationSecretData = {
|
|
8478
9244
|
body?: never;
|
|
8479
9245
|
path: {
|
|
9246
|
+
siteId: string;
|
|
8480
9247
|
destinationId: string;
|
|
8481
9248
|
};
|
|
8482
9249
|
query?: never;
|
|
8483
|
-
url: "/api/v1/event-destinations/{destinationId}/rotate-secret";
|
|
9250
|
+
url: "/api/v1/sites/{siteId}/event-destinations/{destinationId}/rotate-secret";
|
|
8484
9251
|
};
|
|
8485
|
-
type
|
|
9252
|
+
type RotateEventDestinationSecretErrors = {
|
|
8486
9253
|
/**
|
|
8487
|
-
* Unauthorized
|
|
9254
|
+
* Unauthorized
|
|
8488
9255
|
*/
|
|
8489
9256
|
401: Error;
|
|
8490
9257
|
/**
|
|
@@ -8492,25 +9259,26 @@ type RotateEventDestinationSecretWithSiteTokenErrors = {
|
|
|
8492
9259
|
*/
|
|
8493
9260
|
404: Error;
|
|
8494
9261
|
};
|
|
8495
|
-
type
|
|
8496
|
-
type
|
|
9262
|
+
type RotateEventDestinationSecretError = RotateEventDestinationSecretErrors[keyof RotateEventDestinationSecretErrors];
|
|
9263
|
+
type RotateEventDestinationSecretResponses = {
|
|
8497
9264
|
/**
|
|
8498
9265
|
* Secret rotated
|
|
8499
9266
|
*/
|
|
8500
9267
|
200: EventDestination;
|
|
8501
9268
|
};
|
|
8502
|
-
type
|
|
8503
|
-
type
|
|
9269
|
+
type RotateEventDestinationSecretResponse = RotateEventDestinationSecretResponses[keyof RotateEventDestinationSecretResponses];
|
|
9270
|
+
type GetEventDestinationSecretData = {
|
|
8504
9271
|
body?: never;
|
|
8505
9272
|
path: {
|
|
9273
|
+
siteId: string;
|
|
8506
9274
|
destinationId: string;
|
|
8507
9275
|
};
|
|
8508
9276
|
query?: never;
|
|
8509
|
-
url: "/api/v1/event-destinations/{destinationId}/secret";
|
|
9277
|
+
url: "/api/v1/sites/{siteId}/event-destinations/{destinationId}/secret";
|
|
8510
9278
|
};
|
|
8511
|
-
type
|
|
9279
|
+
type GetEventDestinationSecretErrors = {
|
|
8512
9280
|
/**
|
|
8513
|
-
* Unauthorized
|
|
9281
|
+
* Unauthorized
|
|
8514
9282
|
*/
|
|
8515
9283
|
401: Error;
|
|
8516
9284
|
/**
|
|
@@ -8518,27 +9286,28 @@ type GetEventDestinationSecretWithSiteTokenErrors = {
|
|
|
8518
9286
|
*/
|
|
8519
9287
|
404: Error;
|
|
8520
9288
|
};
|
|
8521
|
-
type
|
|
8522
|
-
type
|
|
9289
|
+
type GetEventDestinationSecretError = GetEventDestinationSecretErrors[keyof GetEventDestinationSecretErrors];
|
|
9290
|
+
type GetEventDestinationSecretResponses = {
|
|
8523
9291
|
/**
|
|
8524
9292
|
* The signing secret
|
|
8525
9293
|
*/
|
|
8526
9294
|
200: EventDestinationSecret;
|
|
8527
9295
|
};
|
|
8528
|
-
type
|
|
8529
|
-
type
|
|
9296
|
+
type GetEventDestinationSecretResponse = GetEventDestinationSecretResponses[keyof GetEventDestinationSecretResponses];
|
|
9297
|
+
type ListEventDeliveriesData = {
|
|
8530
9298
|
body?: never;
|
|
8531
9299
|
path: {
|
|
9300
|
+
siteId: string;
|
|
8532
9301
|
destinationId: string;
|
|
8533
9302
|
};
|
|
8534
9303
|
query?: {
|
|
8535
9304
|
limit?: number;
|
|
8536
9305
|
};
|
|
8537
|
-
url: "/api/v1/event-destinations/{destinationId}/deliveries";
|
|
9306
|
+
url: "/api/v1/sites/{siteId}/event-destinations/{destinationId}/deliveries";
|
|
8538
9307
|
};
|
|
8539
|
-
type
|
|
9308
|
+
type ListEventDeliveriesErrors = {
|
|
8540
9309
|
/**
|
|
8541
|
-
* Unauthorized
|
|
9310
|
+
* Unauthorized
|
|
8542
9311
|
*/
|
|
8543
9312
|
401: Error;
|
|
8544
9313
|
/**
|
|
@@ -8546,26 +9315,27 @@ type ListEventDeliveriesWithSiteTokenErrors = {
|
|
|
8546
9315
|
*/
|
|
8547
9316
|
404: Error;
|
|
8548
9317
|
};
|
|
8549
|
-
type
|
|
8550
|
-
type
|
|
9318
|
+
type ListEventDeliveriesError = ListEventDeliveriesErrors[keyof ListEventDeliveriesErrors];
|
|
9319
|
+
type ListEventDeliveriesResponses = {
|
|
8551
9320
|
/**
|
|
8552
9321
|
* Deliveries
|
|
8553
9322
|
*/
|
|
8554
9323
|
200: EventDeliveriesList;
|
|
8555
9324
|
};
|
|
8556
|
-
type
|
|
8557
|
-
type
|
|
9325
|
+
type ListEventDeliveriesResponse = ListEventDeliveriesResponses[keyof ListEventDeliveriesResponses];
|
|
9326
|
+
type RetryEventDeliveryData = {
|
|
8558
9327
|
body?: never;
|
|
8559
9328
|
path: {
|
|
9329
|
+
siteId: string;
|
|
8560
9330
|
destinationId: string;
|
|
8561
9331
|
deliveryId: string;
|
|
8562
9332
|
};
|
|
8563
9333
|
query?: never;
|
|
8564
|
-
url: "/api/v1/event-destinations/{destinationId}/deliveries/{deliveryId}/retry";
|
|
9334
|
+
url: "/api/v1/sites/{siteId}/event-destinations/{destinationId}/deliveries/{deliveryId}/retry";
|
|
8565
9335
|
};
|
|
8566
|
-
type
|
|
9336
|
+
type RetryEventDeliveryErrors = {
|
|
8567
9337
|
/**
|
|
8568
|
-
* Unauthorized
|
|
9338
|
+
* Unauthorized
|
|
8569
9339
|
*/
|
|
8570
9340
|
401: Error;
|
|
8571
9341
|
/**
|
|
@@ -8573,36 +9343,245 @@ type RetryEventDeliveryWithSiteTokenErrors = {
|
|
|
8573
9343
|
*/
|
|
8574
9344
|
404: Error;
|
|
8575
9345
|
};
|
|
8576
|
-
type
|
|
8577
|
-
type
|
|
9346
|
+
type RetryEventDeliveryError = RetryEventDeliveryErrors[keyof RetryEventDeliveryErrors];
|
|
9347
|
+
type RetryEventDeliveryResponses = {
|
|
8578
9348
|
/**
|
|
8579
|
-
* Retry attempted
|
|
9349
|
+
* Retry attempted; the row reflects the outcome
|
|
8580
9350
|
*/
|
|
8581
9351
|
200: EventDelivery;
|
|
8582
9352
|
};
|
|
8583
|
-
type
|
|
8584
|
-
type
|
|
9353
|
+
type RetryEventDeliveryResponse = RetryEventDeliveryResponses[keyof RetryEventDeliveryResponses];
|
|
9354
|
+
type ListEventDestinationsWithSiteTokenData = {
|
|
8585
9355
|
body?: never;
|
|
8586
|
-
path
|
|
8587
|
-
|
|
8588
|
-
|
|
8589
|
-
query?: {
|
|
8590
|
-
/**
|
|
8591
|
-
* Buyer-declared market country (ISO 3166-1 alpha-2). Present: prices convert to that market's currency when supported. Absent: the site's own currency — the default response is identical for every visitor worldwide.
|
|
8592
|
-
*/
|
|
8593
|
-
country?: string;
|
|
8594
|
-
};
|
|
8595
|
-
url: "/v1/p/{productId}";
|
|
9356
|
+
path?: never;
|
|
9357
|
+
query?: never;
|
|
9358
|
+
url: "/api/v1/event-destinations";
|
|
8596
9359
|
};
|
|
8597
|
-
type
|
|
9360
|
+
type ListEventDestinationsWithSiteTokenErrors = {
|
|
8598
9361
|
/**
|
|
8599
|
-
*
|
|
9362
|
+
* Unauthorized - requires site token
|
|
8600
9363
|
*/
|
|
8601
|
-
|
|
9364
|
+
401: Error;
|
|
8602
9365
|
};
|
|
8603
|
-
type
|
|
8604
|
-
type
|
|
8605
|
-
/**
|
|
9366
|
+
type ListEventDestinationsWithSiteTokenError = ListEventDestinationsWithSiteTokenErrors[keyof ListEventDestinationsWithSiteTokenErrors];
|
|
9367
|
+
type ListEventDestinationsWithSiteTokenResponses = {
|
|
9368
|
+
/**
|
|
9369
|
+
* Destinations
|
|
9370
|
+
*/
|
|
9371
|
+
200: EventDestinationsList;
|
|
9372
|
+
};
|
|
9373
|
+
type ListEventDestinationsWithSiteTokenResponse = ListEventDestinationsWithSiteTokenResponses[keyof ListEventDestinationsWithSiteTokenResponses];
|
|
9374
|
+
type CreateEventDestinationWithSiteTokenData = {
|
|
9375
|
+
body: CreateEventDestination;
|
|
9376
|
+
path?: never;
|
|
9377
|
+
query?: never;
|
|
9378
|
+
url: "/api/v1/event-destinations";
|
|
9379
|
+
};
|
|
9380
|
+
type CreateEventDestinationWithSiteTokenErrors = {
|
|
9381
|
+
/**
|
|
9382
|
+
* Invalid URL, unknown topic, or unknown form
|
|
9383
|
+
*/
|
|
9384
|
+
400: Error;
|
|
9385
|
+
/**
|
|
9386
|
+
* Unauthorized - requires site token
|
|
9387
|
+
*/
|
|
9388
|
+
401: Error;
|
|
9389
|
+
};
|
|
9390
|
+
type CreateEventDestinationWithSiteTokenError = CreateEventDestinationWithSiteTokenErrors[keyof CreateEventDestinationWithSiteTokenErrors];
|
|
9391
|
+
type CreateEventDestinationWithSiteTokenResponses = {
|
|
9392
|
+
/**
|
|
9393
|
+
* Created
|
|
9394
|
+
*/
|
|
9395
|
+
201: EventDestination;
|
|
9396
|
+
};
|
|
9397
|
+
type CreateEventDestinationWithSiteTokenResponse = CreateEventDestinationWithSiteTokenResponses[keyof CreateEventDestinationWithSiteTokenResponses];
|
|
9398
|
+
type DeleteEventDestinationWithSiteTokenData = {
|
|
9399
|
+
body?: never;
|
|
9400
|
+
path: {
|
|
9401
|
+
destinationId: string;
|
|
9402
|
+
};
|
|
9403
|
+
query?: never;
|
|
9404
|
+
url: "/api/v1/event-destinations/{destinationId}";
|
|
9405
|
+
};
|
|
9406
|
+
type DeleteEventDestinationWithSiteTokenErrors = {
|
|
9407
|
+
/**
|
|
9408
|
+
* Unauthorized - requires site token
|
|
9409
|
+
*/
|
|
9410
|
+
401: Error;
|
|
9411
|
+
/**
|
|
9412
|
+
* Not found
|
|
9413
|
+
*/
|
|
9414
|
+
404: Error;
|
|
9415
|
+
};
|
|
9416
|
+
type DeleteEventDestinationWithSiteTokenError = DeleteEventDestinationWithSiteTokenErrors[keyof DeleteEventDestinationWithSiteTokenErrors];
|
|
9417
|
+
type DeleteEventDestinationWithSiteTokenResponses = {
|
|
9418
|
+
/**
|
|
9419
|
+
* Deleted
|
|
9420
|
+
*/
|
|
9421
|
+
200: {
|
|
9422
|
+
success: boolean;
|
|
9423
|
+
};
|
|
9424
|
+
};
|
|
9425
|
+
type DeleteEventDestinationWithSiteTokenResponse = DeleteEventDestinationWithSiteTokenResponses[keyof DeleteEventDestinationWithSiteTokenResponses];
|
|
9426
|
+
type UpdateEventDestinationWithSiteTokenData = {
|
|
9427
|
+
body: UpdateEventDestination;
|
|
9428
|
+
path: {
|
|
9429
|
+
destinationId: string;
|
|
9430
|
+
};
|
|
9431
|
+
query?: never;
|
|
9432
|
+
url: "/api/v1/event-destinations/{destinationId}";
|
|
9433
|
+
};
|
|
9434
|
+
type UpdateEventDestinationWithSiteTokenErrors = {
|
|
9435
|
+
/**
|
|
9436
|
+
* Invalid URL or unknown topic
|
|
9437
|
+
*/
|
|
9438
|
+
400: Error;
|
|
9439
|
+
/**
|
|
9440
|
+
* Unauthorized - requires site token
|
|
9441
|
+
*/
|
|
9442
|
+
401: Error;
|
|
9443
|
+
/**
|
|
9444
|
+
* Not found
|
|
9445
|
+
*/
|
|
9446
|
+
404: Error;
|
|
9447
|
+
};
|
|
9448
|
+
type UpdateEventDestinationWithSiteTokenError = UpdateEventDestinationWithSiteTokenErrors[keyof UpdateEventDestinationWithSiteTokenErrors];
|
|
9449
|
+
type UpdateEventDestinationWithSiteTokenResponses = {
|
|
9450
|
+
/**
|
|
9451
|
+
* Updated
|
|
9452
|
+
*/
|
|
9453
|
+
200: EventDestination;
|
|
9454
|
+
};
|
|
9455
|
+
type UpdateEventDestinationWithSiteTokenResponse = UpdateEventDestinationWithSiteTokenResponses[keyof UpdateEventDestinationWithSiteTokenResponses];
|
|
9456
|
+
type RotateEventDestinationSecretWithSiteTokenData = {
|
|
9457
|
+
body?: never;
|
|
9458
|
+
path: {
|
|
9459
|
+
destinationId: string;
|
|
9460
|
+
};
|
|
9461
|
+
query?: never;
|
|
9462
|
+
url: "/api/v1/event-destinations/{destinationId}/rotate-secret";
|
|
9463
|
+
};
|
|
9464
|
+
type RotateEventDestinationSecretWithSiteTokenErrors = {
|
|
9465
|
+
/**
|
|
9466
|
+
* Unauthorized - requires site token
|
|
9467
|
+
*/
|
|
9468
|
+
401: Error;
|
|
9469
|
+
/**
|
|
9470
|
+
* Not found
|
|
9471
|
+
*/
|
|
9472
|
+
404: Error;
|
|
9473
|
+
};
|
|
9474
|
+
type RotateEventDestinationSecretWithSiteTokenError = RotateEventDestinationSecretWithSiteTokenErrors[keyof RotateEventDestinationSecretWithSiteTokenErrors];
|
|
9475
|
+
type RotateEventDestinationSecretWithSiteTokenResponses = {
|
|
9476
|
+
/**
|
|
9477
|
+
* Secret rotated
|
|
9478
|
+
*/
|
|
9479
|
+
200: EventDestination;
|
|
9480
|
+
};
|
|
9481
|
+
type RotateEventDestinationSecretWithSiteTokenResponse = RotateEventDestinationSecretWithSiteTokenResponses[keyof RotateEventDestinationSecretWithSiteTokenResponses];
|
|
9482
|
+
type GetEventDestinationSecretWithSiteTokenData = {
|
|
9483
|
+
body?: never;
|
|
9484
|
+
path: {
|
|
9485
|
+
destinationId: string;
|
|
9486
|
+
};
|
|
9487
|
+
query?: never;
|
|
9488
|
+
url: "/api/v1/event-destinations/{destinationId}/secret";
|
|
9489
|
+
};
|
|
9490
|
+
type GetEventDestinationSecretWithSiteTokenErrors = {
|
|
9491
|
+
/**
|
|
9492
|
+
* Unauthorized - requires site token
|
|
9493
|
+
*/
|
|
9494
|
+
401: Error;
|
|
9495
|
+
/**
|
|
9496
|
+
* Not found
|
|
9497
|
+
*/
|
|
9498
|
+
404: Error;
|
|
9499
|
+
};
|
|
9500
|
+
type GetEventDestinationSecretWithSiteTokenError = GetEventDestinationSecretWithSiteTokenErrors[keyof GetEventDestinationSecretWithSiteTokenErrors];
|
|
9501
|
+
type GetEventDestinationSecretWithSiteTokenResponses = {
|
|
9502
|
+
/**
|
|
9503
|
+
* The signing secret
|
|
9504
|
+
*/
|
|
9505
|
+
200: EventDestinationSecret;
|
|
9506
|
+
};
|
|
9507
|
+
type GetEventDestinationSecretWithSiteTokenResponse = GetEventDestinationSecretWithSiteTokenResponses[keyof GetEventDestinationSecretWithSiteTokenResponses];
|
|
9508
|
+
type ListEventDeliveriesWithSiteTokenData = {
|
|
9509
|
+
body?: never;
|
|
9510
|
+
path: {
|
|
9511
|
+
destinationId: string;
|
|
9512
|
+
};
|
|
9513
|
+
query?: {
|
|
9514
|
+
limit?: number;
|
|
9515
|
+
};
|
|
9516
|
+
url: "/api/v1/event-destinations/{destinationId}/deliveries";
|
|
9517
|
+
};
|
|
9518
|
+
type ListEventDeliveriesWithSiteTokenErrors = {
|
|
9519
|
+
/**
|
|
9520
|
+
* Unauthorized - requires site token
|
|
9521
|
+
*/
|
|
9522
|
+
401: Error;
|
|
9523
|
+
/**
|
|
9524
|
+
* Not found
|
|
9525
|
+
*/
|
|
9526
|
+
404: Error;
|
|
9527
|
+
};
|
|
9528
|
+
type ListEventDeliveriesWithSiteTokenError = ListEventDeliveriesWithSiteTokenErrors[keyof ListEventDeliveriesWithSiteTokenErrors];
|
|
9529
|
+
type ListEventDeliveriesWithSiteTokenResponses = {
|
|
9530
|
+
/**
|
|
9531
|
+
* Deliveries
|
|
9532
|
+
*/
|
|
9533
|
+
200: EventDeliveriesList;
|
|
9534
|
+
};
|
|
9535
|
+
type ListEventDeliveriesWithSiteTokenResponse = ListEventDeliveriesWithSiteTokenResponses[keyof ListEventDeliveriesWithSiteTokenResponses];
|
|
9536
|
+
type RetryEventDeliveryWithSiteTokenData = {
|
|
9537
|
+
body?: never;
|
|
9538
|
+
path: {
|
|
9539
|
+
destinationId: string;
|
|
9540
|
+
deliveryId: string;
|
|
9541
|
+
};
|
|
9542
|
+
query?: never;
|
|
9543
|
+
url: "/api/v1/event-destinations/{destinationId}/deliveries/{deliveryId}/retry";
|
|
9544
|
+
};
|
|
9545
|
+
type RetryEventDeliveryWithSiteTokenErrors = {
|
|
9546
|
+
/**
|
|
9547
|
+
* Unauthorized - requires site token
|
|
9548
|
+
*/
|
|
9549
|
+
401: Error;
|
|
9550
|
+
/**
|
|
9551
|
+
* Not found
|
|
9552
|
+
*/
|
|
9553
|
+
404: Error;
|
|
9554
|
+
};
|
|
9555
|
+
type RetryEventDeliveryWithSiteTokenError = RetryEventDeliveryWithSiteTokenErrors[keyof RetryEventDeliveryWithSiteTokenErrors];
|
|
9556
|
+
type RetryEventDeliveryWithSiteTokenResponses = {
|
|
9557
|
+
/**
|
|
9558
|
+
* Retry attempted
|
|
9559
|
+
*/
|
|
9560
|
+
200: EventDelivery;
|
|
9561
|
+
};
|
|
9562
|
+
type RetryEventDeliveryWithSiteTokenResponse = RetryEventDeliveryWithSiteTokenResponses[keyof RetryEventDeliveryWithSiteTokenResponses];
|
|
9563
|
+
type GetPublicProductData = {
|
|
9564
|
+
body?: never;
|
|
9565
|
+
path: {
|
|
9566
|
+
productId: string;
|
|
9567
|
+
};
|
|
9568
|
+
query?: {
|
|
9569
|
+
/**
|
|
9570
|
+
* Buyer-declared market country (ISO 3166-1 alpha-2). Present: prices convert to that market's currency when supported. Absent: the site's own currency — the default response is identical for every visitor worldwide.
|
|
9571
|
+
*/
|
|
9572
|
+
country?: string;
|
|
9573
|
+
};
|
|
9574
|
+
url: "/v1/p/{productId}";
|
|
9575
|
+
};
|
|
9576
|
+
type GetPublicProductErrors = {
|
|
9577
|
+
/**
|
|
9578
|
+
* Product not found
|
|
9579
|
+
*/
|
|
9580
|
+
404: Error;
|
|
9581
|
+
};
|
|
9582
|
+
type GetPublicProductError = GetPublicProductErrors[keyof GetPublicProductErrors];
|
|
9583
|
+
type GetPublicProductResponses = {
|
|
9584
|
+
/**
|
|
8606
9585
|
* Public product configuration
|
|
8607
9586
|
*/
|
|
8608
9587
|
200: PublicProduct & {
|
|
@@ -9618,614 +10597,161 @@ type EditProductReviewData = {
|
|
|
9618
10597
|
query?: never;
|
|
9619
10598
|
url: "/v1/account/reviews/{reviewId}/edit";
|
|
9620
10599
|
};
|
|
9621
|
-
type EditProductReviewErrors = {
|
|
9622
|
-
/**
|
|
9623
|
-
* Invalid input or cursor
|
|
9624
|
-
*/
|
|
9625
|
-
400: unknown;
|
|
9626
|
-
/**
|
|
9627
|
-
* Customer session expired
|
|
9628
|
-
*/
|
|
9629
|
-
401: unknown;
|
|
9630
|
-
/**
|
|
9631
|
-
* Origin, preview, or challenge refused
|
|
9632
|
-
*/
|
|
9633
|
-
403: unknown;
|
|
9634
|
-
/**
|
|
9635
|
-
* Resource unavailable
|
|
9636
|
-
*/
|
|
9637
|
-
404: unknown;
|
|
9638
|
-
/**
|
|
9639
|
-
* Revision conflict; latest saved review included
|
|
9640
|
-
*/
|
|
9641
|
-
409: {
|
|
9642
|
-
error: "review_conflict";
|
|
9643
|
-
review: OwnProductReview;
|
|
9644
|
-
};
|
|
9645
|
-
/**
|
|
9646
|
-
* Customer attempt budget exhausted
|
|
9647
|
-
*/
|
|
9648
|
-
429: unknown;
|
|
9649
|
-
/**
|
|
9650
|
-
* Collection or spam protection unavailable
|
|
9651
|
-
*/
|
|
9652
|
-
503: unknown;
|
|
9653
|
-
};
|
|
9654
|
-
type EditProductReviewError = EditProductReviewErrors[keyof EditProductReviewErrors];
|
|
9655
|
-
type EditProductReviewResponses = {
|
|
9656
|
-
/**
|
|
9657
|
-
* Updated review
|
|
9658
|
-
*/
|
|
9659
|
-
200: {
|
|
9660
|
-
review: OwnProductReview;
|
|
9661
|
-
};
|
|
9662
|
-
};
|
|
9663
|
-
type EditProductReviewResponse = EditProductReviewResponses[keyof EditProductReviewResponses];
|
|
9664
|
-
type WithdrawProductReviewData = {
|
|
9665
|
-
body: {
|
|
9666
|
-
revision: number;
|
|
9667
|
-
};
|
|
9668
|
-
path: {
|
|
9669
|
-
reviewId: string;
|
|
9670
|
-
};
|
|
9671
|
-
query?: never;
|
|
9672
|
-
url: "/v1/account/reviews/{reviewId}/withdraw";
|
|
9673
|
-
};
|
|
9674
|
-
type WithdrawProductReviewErrors = {
|
|
9675
|
-
/**
|
|
9676
|
-
* Invalid input or cursor
|
|
9677
|
-
*/
|
|
9678
|
-
400: unknown;
|
|
9679
|
-
/**
|
|
9680
|
-
* Customer session expired
|
|
9681
|
-
*/
|
|
9682
|
-
401: unknown;
|
|
9683
|
-
/**
|
|
9684
|
-
* Origin, preview, or challenge refused
|
|
9685
|
-
*/
|
|
9686
|
-
403: unknown;
|
|
9687
|
-
/**
|
|
9688
|
-
* Resource unavailable
|
|
9689
|
-
*/
|
|
9690
|
-
404: unknown;
|
|
9691
|
-
/**
|
|
9692
|
-
* Revision conflict; latest saved review included
|
|
9693
|
-
*/
|
|
9694
|
-
409: {
|
|
9695
|
-
error: "review_conflict";
|
|
9696
|
-
review: OwnProductReview;
|
|
9697
|
-
};
|
|
9698
|
-
/**
|
|
9699
|
-
* Customer attempt budget exhausted
|
|
9700
|
-
*/
|
|
9701
|
-
429: unknown;
|
|
9702
|
-
/**
|
|
9703
|
-
* Collection or spam protection unavailable
|
|
9704
|
-
*/
|
|
9705
|
-
503: unknown;
|
|
9706
|
-
};
|
|
9707
|
-
type WithdrawProductReviewError = WithdrawProductReviewErrors[keyof WithdrawProductReviewErrors];
|
|
9708
|
-
type WithdrawProductReviewResponses = {
|
|
9709
|
-
/**
|
|
9710
|
-
* Updated review
|
|
9711
|
-
*/
|
|
9712
|
-
200: {
|
|
9713
|
-
review: OwnProductReview;
|
|
9714
|
-
};
|
|
9715
|
-
};
|
|
9716
|
-
type WithdrawProductReviewResponse = WithdrawProductReviewResponses[keyof WithdrawProductReviewResponses];
|
|
9717
|
-
type ResubmitProductReviewData = {
|
|
9718
|
-
body: {
|
|
9719
|
-
rating: number;
|
|
9720
|
-
display_name: string;
|
|
9721
|
-
title?: string | null;
|
|
9722
|
-
body: string;
|
|
9723
|
-
product_path?: string;
|
|
9724
|
-
turnstile_token: string;
|
|
9725
|
-
revision: number;
|
|
9726
|
-
};
|
|
9727
|
-
path: {
|
|
9728
|
-
reviewId: string;
|
|
9729
|
-
};
|
|
9730
|
-
query?: never;
|
|
9731
|
-
url: "/v1/account/reviews/{reviewId}/resubmit";
|
|
9732
|
-
};
|
|
9733
|
-
type ResubmitProductReviewErrors = {
|
|
9734
|
-
/**
|
|
9735
|
-
* Invalid input or cursor
|
|
9736
|
-
*/
|
|
9737
|
-
400: unknown;
|
|
9738
|
-
/**
|
|
9739
|
-
* Customer session expired
|
|
9740
|
-
*/
|
|
9741
|
-
401: unknown;
|
|
9742
|
-
/**
|
|
9743
|
-
* Origin, preview, or challenge refused
|
|
9744
|
-
*/
|
|
9745
|
-
403: unknown;
|
|
9746
|
-
/**
|
|
9747
|
-
* Resource unavailable
|
|
9748
|
-
*/
|
|
9749
|
-
404: unknown;
|
|
9750
|
-
/**
|
|
9751
|
-
* Revision conflict; latest saved review included
|
|
9752
|
-
*/
|
|
9753
|
-
409: {
|
|
9754
|
-
error: "review_conflict";
|
|
9755
|
-
review: OwnProductReview;
|
|
9756
|
-
};
|
|
9757
|
-
/**
|
|
9758
|
-
* Customer attempt budget exhausted
|
|
9759
|
-
*/
|
|
9760
|
-
429: unknown;
|
|
9761
|
-
/**
|
|
9762
|
-
* Collection or spam protection unavailable
|
|
9763
|
-
*/
|
|
9764
|
-
503: unknown;
|
|
9765
|
-
};
|
|
9766
|
-
type ResubmitProductReviewError = ResubmitProductReviewErrors[keyof ResubmitProductReviewErrors];
|
|
9767
|
-
type ResubmitProductReviewResponses = {
|
|
9768
|
-
/**
|
|
9769
|
-
* Updated review
|
|
9770
|
-
*/
|
|
9771
|
-
200: {
|
|
9772
|
-
review: OwnProductReview;
|
|
9773
|
-
};
|
|
9774
|
-
};
|
|
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;
|
|
10600
|
+
type EditProductReviewErrors = {
|
|
10089
10601
|
/**
|
|
10090
|
-
*
|
|
10602
|
+
* Invalid input or cursor
|
|
10091
10603
|
*/
|
|
10092
|
-
|
|
10604
|
+
400: unknown;
|
|
10093
10605
|
/**
|
|
10094
|
-
*
|
|
10606
|
+
* Customer session expired
|
|
10095
10607
|
*/
|
|
10096
|
-
|
|
10097
|
-
};
|
|
10098
|
-
type CreatePromoForSiteError = CreatePromoForSiteErrors[keyof CreatePromoForSiteErrors];
|
|
10099
|
-
type CreatePromoForSiteResponses = {
|
|
10608
|
+
401: unknown;
|
|
10100
10609
|
/**
|
|
10101
|
-
*
|
|
10610
|
+
* Origin, preview, or challenge refused
|
|
10102
10611
|
*/
|
|
10103
|
-
|
|
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 = {
|
|
10612
|
+
403: unknown;
|
|
10116
10613
|
/**
|
|
10117
|
-
*
|
|
10614
|
+
* Resource unavailable
|
|
10118
10615
|
*/
|
|
10119
|
-
|
|
10616
|
+
404: unknown;
|
|
10120
10617
|
/**
|
|
10121
|
-
*
|
|
10618
|
+
* Revision conflict; latest saved review included
|
|
10122
10619
|
*/
|
|
10123
|
-
|
|
10124
|
-
error:
|
|
10620
|
+
409: {
|
|
10621
|
+
error: "review_conflict";
|
|
10622
|
+
review: OwnProductReview;
|
|
10125
10623
|
};
|
|
10126
10624
|
/**
|
|
10127
|
-
*
|
|
10128
|
-
*/
|
|
10129
|
-
404: PromoError;
|
|
10130
|
-
/**
|
|
10131
|
-
* Conflicting request or promotion state
|
|
10625
|
+
* Customer attempt budget exhausted
|
|
10132
10626
|
*/
|
|
10133
|
-
|
|
10627
|
+
429: unknown;
|
|
10134
10628
|
/**
|
|
10135
|
-
*
|
|
10629
|
+
* Collection or spam protection unavailable
|
|
10136
10630
|
*/
|
|
10137
|
-
503:
|
|
10631
|
+
503: unknown;
|
|
10138
10632
|
};
|
|
10139
|
-
type
|
|
10140
|
-
type
|
|
10633
|
+
type EditProductReviewError = EditProductReviewErrors[keyof EditProductReviewErrors];
|
|
10634
|
+
type EditProductReviewResponses = {
|
|
10141
10635
|
/**
|
|
10142
|
-
*
|
|
10636
|
+
* Updated review
|
|
10143
10637
|
*/
|
|
10144
|
-
200:
|
|
10638
|
+
200: {
|
|
10639
|
+
review: OwnProductReview;
|
|
10640
|
+
};
|
|
10145
10641
|
};
|
|
10146
|
-
type
|
|
10147
|
-
type
|
|
10148
|
-
body
|
|
10642
|
+
type EditProductReviewResponse = EditProductReviewResponses[keyof EditProductReviewResponses];
|
|
10643
|
+
type WithdrawProductReviewData = {
|
|
10644
|
+
body: {
|
|
10645
|
+
revision: number;
|
|
10646
|
+
};
|
|
10149
10647
|
path: {
|
|
10150
|
-
|
|
10151
|
-
promoId: string;
|
|
10648
|
+
reviewId: string;
|
|
10152
10649
|
};
|
|
10153
10650
|
query?: never;
|
|
10154
|
-
url: "/
|
|
10651
|
+
url: "/v1/account/reviews/{reviewId}/withdraw";
|
|
10155
10652
|
};
|
|
10156
|
-
type
|
|
10653
|
+
type WithdrawProductReviewErrors = {
|
|
10157
10654
|
/**
|
|
10158
|
-
* Invalid
|
|
10655
|
+
* Invalid input or cursor
|
|
10159
10656
|
*/
|
|
10160
|
-
400:
|
|
10657
|
+
400: unknown;
|
|
10161
10658
|
/**
|
|
10162
|
-
*
|
|
10659
|
+
* Customer session expired
|
|
10163
10660
|
*/
|
|
10164
|
-
401:
|
|
10165
|
-
error: string;
|
|
10166
|
-
};
|
|
10661
|
+
401: unknown;
|
|
10167
10662
|
/**
|
|
10168
|
-
*
|
|
10663
|
+
* Origin, preview, or challenge refused
|
|
10169
10664
|
*/
|
|
10170
|
-
|
|
10665
|
+
403: unknown;
|
|
10171
10666
|
/**
|
|
10172
|
-
*
|
|
10667
|
+
* Resource unavailable
|
|
10173
10668
|
*/
|
|
10174
|
-
|
|
10669
|
+
404: unknown;
|
|
10175
10670
|
/**
|
|
10176
|
-
*
|
|
10671
|
+
* Revision conflict; latest saved review included
|
|
10177
10672
|
*/
|
|
10178
|
-
|
|
10673
|
+
409: {
|
|
10674
|
+
error: "review_conflict";
|
|
10675
|
+
review: OwnProductReview;
|
|
10676
|
+
};
|
|
10677
|
+
/**
|
|
10678
|
+
* Customer attempt budget exhausted
|
|
10679
|
+
*/
|
|
10680
|
+
429: unknown;
|
|
10681
|
+
/**
|
|
10682
|
+
* Collection or spam protection unavailable
|
|
10683
|
+
*/
|
|
10684
|
+
503: unknown;
|
|
10179
10685
|
};
|
|
10180
|
-
type
|
|
10181
|
-
type
|
|
10686
|
+
type WithdrawProductReviewError = WithdrawProductReviewErrors[keyof WithdrawProductReviewErrors];
|
|
10687
|
+
type WithdrawProductReviewResponses = {
|
|
10182
10688
|
/**
|
|
10183
|
-
*
|
|
10689
|
+
* Updated review
|
|
10184
10690
|
*/
|
|
10185
|
-
200:
|
|
10691
|
+
200: {
|
|
10692
|
+
review: OwnProductReview;
|
|
10693
|
+
};
|
|
10186
10694
|
};
|
|
10187
|
-
type
|
|
10188
|
-
type
|
|
10189
|
-
body:
|
|
10695
|
+
type WithdrawProductReviewResponse = WithdrawProductReviewResponses[keyof WithdrawProductReviewResponses];
|
|
10696
|
+
type ResubmitProductReviewData = {
|
|
10697
|
+
body: {
|
|
10698
|
+
rating: number;
|
|
10699
|
+
display_name: string;
|
|
10700
|
+
title?: string | null;
|
|
10701
|
+
body: string;
|
|
10702
|
+
product_path?: string;
|
|
10703
|
+
turnstile_token: string;
|
|
10704
|
+
revision: number;
|
|
10705
|
+
};
|
|
10190
10706
|
path: {
|
|
10191
|
-
|
|
10192
|
-
promoId: string;
|
|
10707
|
+
reviewId: string;
|
|
10193
10708
|
};
|
|
10194
10709
|
query?: never;
|
|
10195
|
-
url: "/
|
|
10710
|
+
url: "/v1/account/reviews/{reviewId}/resubmit";
|
|
10196
10711
|
};
|
|
10197
|
-
type
|
|
10712
|
+
type ResubmitProductReviewErrors = {
|
|
10198
10713
|
/**
|
|
10199
|
-
* Invalid
|
|
10714
|
+
* Invalid input or cursor
|
|
10200
10715
|
*/
|
|
10201
|
-
400:
|
|
10716
|
+
400: unknown;
|
|
10202
10717
|
/**
|
|
10203
|
-
*
|
|
10718
|
+
* Customer session expired
|
|
10204
10719
|
*/
|
|
10205
|
-
401:
|
|
10206
|
-
error: string;
|
|
10207
|
-
};
|
|
10720
|
+
401: unknown;
|
|
10208
10721
|
/**
|
|
10209
|
-
*
|
|
10722
|
+
* Origin, preview, or challenge refused
|
|
10210
10723
|
*/
|
|
10211
|
-
|
|
10724
|
+
403: unknown;
|
|
10212
10725
|
/**
|
|
10213
|
-
*
|
|
10726
|
+
* Resource unavailable
|
|
10214
10727
|
*/
|
|
10215
|
-
|
|
10728
|
+
404: unknown;
|
|
10216
10729
|
/**
|
|
10217
|
-
*
|
|
10730
|
+
* Revision conflict; latest saved review included
|
|
10218
10731
|
*/
|
|
10219
|
-
|
|
10732
|
+
409: {
|
|
10733
|
+
error: "review_conflict";
|
|
10734
|
+
review: OwnProductReview;
|
|
10735
|
+
};
|
|
10736
|
+
/**
|
|
10737
|
+
* Customer attempt budget exhausted
|
|
10738
|
+
*/
|
|
10739
|
+
429: unknown;
|
|
10740
|
+
/**
|
|
10741
|
+
* Collection or spam protection unavailable
|
|
10742
|
+
*/
|
|
10743
|
+
503: unknown;
|
|
10220
10744
|
};
|
|
10221
|
-
type
|
|
10222
|
-
type
|
|
10745
|
+
type ResubmitProductReviewError = ResubmitProductReviewErrors[keyof ResubmitProductReviewErrors];
|
|
10746
|
+
type ResubmitProductReviewResponses = {
|
|
10223
10747
|
/**
|
|
10224
|
-
*
|
|
10748
|
+
* Updated review
|
|
10225
10749
|
*/
|
|
10226
|
-
200:
|
|
10750
|
+
200: {
|
|
10751
|
+
review: OwnProductReview;
|
|
10752
|
+
};
|
|
10227
10753
|
};
|
|
10228
|
-
type
|
|
10754
|
+
type ResubmitProductReviewResponse = ResubmitProductReviewResponses[keyof ResubmitProductReviewResponses];
|
|
10229
10755
|
|
|
10230
10756
|
type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options$1<TData, ThrowOnError> & {
|
|
10231
10757
|
/**
|
|
@@ -10618,6 +11144,66 @@ declare const getAnalyticsOperatingSystems: <ThrowOnError extends boolean = fals
|
|
|
10618
11144
|
* First-touch acquisition folded into Plausible's 19 channels. Carries VISITS, not visitors: visitor counts are computed per acquisition tuple, so they do not sum across the tuples that fold into one channel — ordinary referrer-host and UTM variance would inflate the biggest channels. Visits are additive and exact.
|
|
10619
11145
|
*/
|
|
10620
11146
|
declare const getAnalyticsChannels: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsChannelsData, ThrowOnError>) => RequestResult<GetAnalyticsChannelsResponses, GetAnalyticsChannelsErrors, ThrowOnError, "fields">;
|
|
11147
|
+
/**
|
|
11148
|
+
* Conversions per goal for the period
|
|
11149
|
+
*
|
|
11150
|
+
* Unique and total conversions for every goal this site has, plus the rate each converted at. Goals are DEFINITIONS matched as the query runs, never stored on the events, so editing or deleting one changes all of its past numbers — there is no backfill and no window in which a goal exists but its numbers do not. MATCHING IS RETROACTIVE; THE DATA IS NOT ALWAYS. A goal reports over every event already recorded, which for most goals is the site's entire history — but `Purchase` and `Form: Received` are events we WRITE rather than collect, so they exist only from the deploy that started writing them. Read `counts_from` on each row: null means the whole history, a date means from there. Do not infer completeness from `implicit`. Every collecting site has rows here without configuring anything: form submissions, outbound clicks, file downloads and Contact (phone and email taps under one name), plus `Form: Received` for server-confirmed form deliveries and `Purchase` for sales through our checkout. `Form: Received` is a DIFFERENT MEASUREMENT from `Form: Submission`, not a later stage of it — deliveries can exceed attempts, so never subtract one from the other. A goal that matched nothing is present and reads zero; a goal that is absent does not exist. `conversion_rate` divides by SITE-WIDE unique visitors for the window, not by anything about the goal, so the rates do not sum to 100% — state what the rate is a ratio of wherever you show one. Use `from`/`to` in place of `period` for an explicit range.
|
|
11151
|
+
*/
|
|
11152
|
+
declare const getAnalyticsConversions: <ThrowOnError extends boolean = false>(options?: Options<GetAnalyticsConversionsData, ThrowOnError>) => RequestResult<GetAnalyticsConversionsResponses, GetAnalyticsConversionsErrors, ThrowOnError, "fields">;
|
|
11153
|
+
/**
|
|
11154
|
+
* Visitors reaching each step of a funnel
|
|
11155
|
+
*
|
|
11156
|
+
* Cumulative visitors per step with drop-off. READ `window`, NOT THE PERIOD YOU ASKED FOR: a funnel whose steps include `Purchase` or `Form: Received` cannot report on days before those events were being written, so the window is moved forward to the first day EVERY step could have fired. When that happens `requested_window` holds what you asked for and `coverage_from` says which date set the floor; both are null when nothing was shortened. The window had to move rather than carry a caveat, because drop-off is a comparison BETWEEN steps — a window reaching back past one step's instrumentation would count entrants at step one from days the later step could not fire and report the difference as people dropping out. Label a result with `window`, and if `requested_window` is set, say the period was shortened. A window with no covered days at all is refused by name rather than answered. BOUNDED TO A VISITOR-DAY, which bounds each SEQUENCE and not the report: the numbers cover the whole window, but one visitor's run through the steps must finish within 24 hours AND within one visitor identity, which rotates daily. So a 90-day report counts completions from all 90 days, and a visitor who starts the path before midnight and finishes after it is not one of them — say that wherever you show a funnel. `never_entered` counts visitors in the window who matched no step, which is what makes the first step's rate meaningful. `conversion_rate` on each step divides by STEP ONE's visitors, not by site-wide visitors: a funnel's rate is about the path, unlike a conversion rate. Steps are definitions matched at read time, so reordering a funnel changes every past number.
|
|
11157
|
+
*/
|
|
11158
|
+
declare const getAnalyticsFunnelReport: <ThrowOnError extends boolean = false>(options: Options<GetAnalyticsFunnelReportData, ThrowOnError>) => RequestResult<GetAnalyticsFunnelReportResponses, GetAnalyticsFunnelReportErrors, ThrowOnError, "fields">;
|
|
11159
|
+
/**
|
|
11160
|
+
* Goals defined for a site, plus the built-ins (site token, or org key with site_id)
|
|
11161
|
+
*
|
|
11162
|
+
* Every goal this site reports on. A goal is a definition matched at query time, never stored on the events, so creating, renaming or deleting one changes every historical report immediately with no backfill. Three kinds: `pageview` (a path with `*` wildcards), `scroll` (a path plus a depth threshold from 1 to 100), and `event` (one of the collected event types). A pageview goal matches only pageview rows and a scroll goal only the engagement rows that carry scroll depth, so its counts never absorb another goal's conversions. The built-in goals (Form: Submission, Outbound Link: Click, File Download, Contact) are always present, are not rows, and cannot be renamed or deleted; `Contact` reports phone and email taps together. Two more provision themselves from events we write rather than collect: `Form: Received` counts form DELIVERIES confirmed by our server, which is a different measurement from the tracker's `Form: Submission` attempts and must never be subtracted from it; `Purchase` counts sales through our checkout. Both are present on every site whether or not it has recorded one — a zero is a real answer, and tying a goal's existence to a mutable payment setting would have made past sales disappear from analytics the moment payments were suspended. Both carry a `counts_from` date in the report because, unlike every other goal, they only exist from the deploy that started writing them. An `event` goal may only name a collected type (Form: Submission, Outbound Link: Click, File Download, Phone Link: Click, Email Link: Click) — any other name would be dropped by the collection endpoint and report zero forever.
|
|
11163
|
+
*/
|
|
11164
|
+
declare const listAnalyticsGoals: <ThrowOnError extends boolean = false>(options?: Options<ListAnalyticsGoalsData, ThrowOnError>) => RequestResult<ListAnalyticsGoalsResponses, ListAnalyticsGoalsErrors, ThrowOnError, "fields">;
|
|
11165
|
+
/**
|
|
11166
|
+
* Define a goal (site token, or org key with site_id)
|
|
11167
|
+
*
|
|
11168
|
+
* A goal is a definition matched at query time, never stored on the events, so creating, renaming or deleting one changes every historical report immediately with no backfill. Three kinds: `pageview` (a path with `*` wildcards), `scroll` (a path plus a depth threshold from 1 to 100), and `event` (one of the collected event types). A pageview goal matches only pageview rows and a scroll goal only the engagement rows that carry scroll depth, so its counts never absorb another goal's conversions. The built-in goals (Form: Submission, Outbound Link: Click, File Download, Contact) are always present, are not rows, and cannot be renamed or deleted; `Contact` reports phone and email taps together. Two more provision themselves from events we write rather than collect: `Form: Received` counts form DELIVERIES confirmed by our server, which is a different measurement from the tracker's `Form: Submission` attempts and must never be subtracted from it; `Purchase` counts sales through our checkout. Both are present on every site whether or not it has recorded one — a zero is a real answer, and tying a goal's existence to a mutable payment setting would have made past sales disappear from analytics the moment payments were suspended. Both carry a `counts_from` date in the report because, unlike every other goal, they only exist from the deploy that started writing them. An `event` goal may only name a collected type (Form: Submission, Outbound Link: Click, File Download, Phone Link: Click, Email Link: Click) — any other name would be dropped by the collection endpoint and report zero forever. The path pattern is stored exactly as written; `*` is the only wildcard and every other character is literal.
|
|
11169
|
+
*/
|
|
11170
|
+
declare const createAnalyticsGoal: <ThrowOnError extends boolean = false>(options?: Options<CreateAnalyticsGoalData, ThrowOnError>) => RequestResult<CreateAnalyticsGoalResponses, CreateAnalyticsGoalErrors, ThrowOnError, "fields">;
|
|
11171
|
+
/**
|
|
11172
|
+
* Delete a goal (site token, or org key with site_id)
|
|
11173
|
+
*
|
|
11174
|
+
* Removes the definition. No event is deleted and no history is rewritten — the goal simply stops being reported. A built-in goal has no id and cannot be deleted.
|
|
11175
|
+
*/
|
|
11176
|
+
declare const deleteAnalyticsGoal: <ThrowOnError extends boolean = false>(options: Options<DeleteAnalyticsGoalData, ThrowOnError>) => RequestResult<DeleteAnalyticsGoalResponses, DeleteAnalyticsGoalErrors, ThrowOnError, "fields">;
|
|
11177
|
+
/**
|
|
11178
|
+
* Rename or edit a goal (site token, or org key with site_id)
|
|
11179
|
+
*
|
|
11180
|
+
* Renaming a goal relabels it in every historical report immediately, because matching is query-time and the display name is the key reports are keyed by. Nothing is destroyed and a rename can be reversed, but last quarter's report will say the new name. A built-in goal has no id and cannot be edited.
|
|
11181
|
+
*/
|
|
11182
|
+
declare const updateAnalyticsGoal: <ThrowOnError extends boolean = false>(options: Options<UpdateAnalyticsGoalData, ThrowOnError>) => RequestResult<UpdateAnalyticsGoalResponses, UpdateAnalyticsGoalErrors, ThrowOnError, "fields">;
|
|
11183
|
+
/**
|
|
11184
|
+
* This site's funnels (site token, or org key with site_id)
|
|
11185
|
+
*
|
|
11186
|
+
* Funnel definitions with their ordered steps. A funnel is a definition matched at read time, so creating or reordering one changes every historical number with no backfill. Funnels are bounded to a VISITOR-DAY, not a visitor history, because the visitor identifier rotates daily — say so wherever you show a funnel.
|
|
11187
|
+
*/
|
|
11188
|
+
declare const listAnalyticsFunnels: <ThrowOnError extends boolean = false>(options?: Options<ListAnalyticsFunnelsData, ThrowOnError>) => RequestResult<ListAnalyticsFunnelsResponses, ListAnalyticsFunnelsErrors, ThrowOnError, "fields">;
|
|
11189
|
+
/**
|
|
11190
|
+
* Define a funnel (site token, or org key with site_id)
|
|
11191
|
+
*
|
|
11192
|
+
* An ordered path of 2 to 8 goals. Array order is step order. Steps are validated as a SET — the count, the references and the ordering are one judgement — so every problem is returned at once rather than one per round-trip.
|
|
11193
|
+
*/
|
|
11194
|
+
declare const createAnalyticsFunnel: <ThrowOnError extends boolean = false>(options?: Options<CreateAnalyticsFunnelData, ThrowOnError>) => RequestResult<CreateAnalyticsFunnelResponses, CreateAnalyticsFunnelErrors, ThrowOnError, "fields">;
|
|
11195
|
+
/**
|
|
11196
|
+
* Delete a funnel
|
|
11197
|
+
*
|
|
11198
|
+
* Removes the definition. The underlying events are untouched, so the same funnel recreated with the same steps reports the same history.
|
|
11199
|
+
*/
|
|
11200
|
+
declare const deleteAnalyticsFunnel: <ThrowOnError extends boolean = false>(options: Options<DeleteAnalyticsFunnelData, ThrowOnError>) => RequestResult<DeleteAnalyticsFunnelResponses, DeleteAnalyticsFunnelErrors, ThrowOnError, "fields">;
|
|
11201
|
+
/**
|
|
11202
|
+
* Rename a funnel or replace its steps
|
|
11203
|
+
*
|
|
11204
|
+
* Steps are replaced WHOLE when supplied, never patched individually: a funnel is an ordered path, so an edit to one step is an edit to the path and the set has to be judged together. Omit `steps` to rename only.
|
|
11205
|
+
*/
|
|
11206
|
+
declare const updateAnalyticsFunnel: <ThrowOnError extends boolean = false>(options: Options<UpdateAnalyticsFunnelData, ThrowOnError>) => RequestResult<UpdateAnalyticsFunnelResponses, UpdateAnalyticsFunnelErrors, ThrowOnError, "fields">;
|
|
10621
11207
|
/**
|
|
10622
11208
|
* List subscriptions (site token, or org key with site_id)
|
|
10623
11209
|
*
|
|
@@ -10778,6 +11364,46 @@ declare const eraseCustomerReviews: <ThrowOnError extends boolean = false>(optio
|
|
|
10778
11364
|
* Idempotently pause collection and erase review content before website deletion. Does not remove orders.
|
|
10779
11365
|
*/
|
|
10780
11366
|
declare const purgeSiteReviews: <ThrowOnError extends boolean = false>(options: Options<PurgeSiteReviewsData, ThrowOnError>) => RequestResult<PurgeSiteReviewsResponses, PurgeSiteReviewsErrors, ThrowOnError, "fields">;
|
|
11367
|
+
/**
|
|
11368
|
+
* List site-managed promos with live Stripe status (eligibility is connected-account wide)
|
|
11369
|
+
*/
|
|
11370
|
+
declare const listPromos: <ThrowOnError extends boolean = false>(options?: Options<ListPromosData, ThrowOnError>) => RequestResult<ListPromosResponses, ListPromosErrors, ThrowOnError, "fields">;
|
|
11371
|
+
/**
|
|
11372
|
+
* Create a Stripe-backed account-wide promo; retry the same request_id after unknown outcomes
|
|
11373
|
+
*/
|
|
11374
|
+
declare const createPromo: <ThrowOnError extends boolean = false>(options: Options<CreatePromoData, ThrowOnError>) => RequestResult<CreatePromoResponses, CreatePromoErrors, ThrowOnError, "fields">;
|
|
11375
|
+
/**
|
|
11376
|
+
* Read live status and usage of an owned promo
|
|
11377
|
+
*/
|
|
11378
|
+
declare const getPromo: <ThrowOnError extends boolean = false>(options: Options<GetPromoData, ThrowOnError>) => RequestResult<GetPromoResponses, GetPromoErrors, ThrowOnError, "fields">;
|
|
11379
|
+
/**
|
|
11380
|
+
* Disable new redemptions; existing subscription discounts are unaffected
|
|
11381
|
+
*/
|
|
11382
|
+
declare const disablePromo: <ThrowOnError extends boolean = false>(options: Options<DisablePromoData, ThrowOnError>) => RequestResult<DisablePromoResponses, DisablePromoErrors, ThrowOnError, "fields">;
|
|
11383
|
+
/**
|
|
11384
|
+
* Create different-code replacement then disable predecessor; retry same request_id if incomplete
|
|
11385
|
+
*/
|
|
11386
|
+
declare const replacePromo: <ThrowOnError extends boolean = false>(options: Options<ReplacePromoData, ThrowOnError>) => RequestResult<ReplacePromoResponses, ReplacePromoErrors, ThrowOnError, "fields">;
|
|
11387
|
+
/**
|
|
11388
|
+
* List site-managed promos with live Stripe status (eligibility is connected-account wide)
|
|
11389
|
+
*/
|
|
11390
|
+
declare const listPromosForSite: <ThrowOnError extends boolean = false>(options: Options<ListPromosForSiteData, ThrowOnError>) => RequestResult<ListPromosForSiteResponses, ListPromosForSiteErrors, ThrowOnError, "fields">;
|
|
11391
|
+
/**
|
|
11392
|
+
* Create a Stripe-backed account-wide promo; retry the same request_id after unknown outcomes
|
|
11393
|
+
*/
|
|
11394
|
+
declare const createPromoForSite: <ThrowOnError extends boolean = false>(options: Options<CreatePromoForSiteData, ThrowOnError>) => RequestResult<CreatePromoForSiteResponses, CreatePromoForSiteErrors, ThrowOnError, "fields">;
|
|
11395
|
+
/**
|
|
11396
|
+
* Read live status and usage of an owned promo
|
|
11397
|
+
*/
|
|
11398
|
+
declare const getPromoForSite: <ThrowOnError extends boolean = false>(options: Options<GetPromoForSiteData, ThrowOnError>) => RequestResult<GetPromoForSiteResponses, GetPromoForSiteErrors, ThrowOnError, "fields">;
|
|
11399
|
+
/**
|
|
11400
|
+
* Disable new redemptions; existing subscription discounts are unaffected
|
|
11401
|
+
*/
|
|
11402
|
+
declare const disablePromoForSite: <ThrowOnError extends boolean = false>(options: Options<DisablePromoForSiteData, ThrowOnError>) => RequestResult<DisablePromoForSiteResponses, DisablePromoForSiteErrors, ThrowOnError, "fields">;
|
|
11403
|
+
/**
|
|
11404
|
+
* Create different-code replacement then disable predecessor; retry same request_id if incomplete
|
|
11405
|
+
*/
|
|
11406
|
+
declare const replacePromoForSite: <ThrowOnError extends boolean = false>(options: Options<ReplacePromoForSiteData, ThrowOnError>) => RequestResult<ReplacePromoForSiteResponses, ReplacePromoForSiteErrors, ThrowOnError, "fields">;
|
|
10781
11407
|
/**
|
|
10782
11408
|
* Get the site's consent config (site token)
|
|
10783
11409
|
*
|
|
@@ -11173,15 +11799,4 @@ declare const withdrawProductReview: <ThrowOnError extends boolean = false>(opti
|
|
|
11173
11799
|
*/
|
|
11174
11800
|
declare const resubmitProductReview: <ThrowOnError extends boolean = false>(options: Options<ResubmitProductReviewData, ThrowOnError>) => RequestResult<ResubmitProductReviewResponses, ResubmitProductReviewErrors, ThrowOnError, "fields">;
|
|
11175
11801
|
|
|
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 };
|
|
11802
|
+
export { type AccountCancelSubscriptionData, type AccountCancelSubscriptionError, type AccountCancelSubscriptionErrors, type AccountCancelSubscriptionResponse, type AccountCancelSubscriptionResponses, type AccountCreatePortalSessionData, type AccountCreatePortalSessionError, type AccountCreatePortalSessionErrors, type AccountCreatePortalSessionResponse, type AccountCreatePortalSessionResponses, type AccountLoginData, type AccountLoginError, type AccountLoginErrors, type AccountLoginRequest, type AccountLoginResponse, type AccountLoginResponses, type AccountLoginResult, type AccountLogoutData, type AccountLogoutError, type AccountLogoutErrors, type AccountLogoutResponse, type AccountLogoutResponses, type AccountLogoutResult, type AccountManageCancelData, type AccountManageCancelError, type AccountManageCancelErrors, type AccountManageCancelResponse, type AccountManageCancelResponses, type AccountManageGetSubscriptionData, type AccountManageGetSubscriptionError, type AccountManageGetSubscriptionErrors, type AccountManageGetSubscriptionResponse, type AccountManageGetSubscriptionResponses, type AccountManagePortalSessionData, type AccountManagePortalSessionError, type AccountManagePortalSessionErrors, type AccountManagePortalSessionResponse, type AccountManagePortalSessionResponses, type AccountManageVerifyData, type AccountManageVerifyError, type AccountManageVerifyErrors, type AccountManageVerifyResponse, type AccountManageVerifyResponses, type AccountMeData, type AccountMeError, type AccountMeErrors, type AccountMeResponse, type AccountMeResponses, type AccountMeResult, type AccountReactivateSubscriptionData, type AccountReactivateSubscriptionError, type AccountReactivateSubscriptionErrors, type AccountReactivateSubscriptionResponse, type AccountReactivateSubscriptionResponses, type AccountSubscribeData, type AccountSubscribeError, type AccountSubscribeErrors, type AccountSubscribeRequest, type AccountSubscribeResponse, type AccountSubscribeResponses, type AccountUpdateSubscriptionAddressData, type AccountUpdateSubscriptionAddressError, type AccountUpdateSubscriptionAddressErrors, type AccountUpdateSubscriptionAddressResponse, type AccountUpdateSubscriptionAddressResponses, type AccountVerifyData, type AccountVerifyError, type AccountVerifyErrors, type AccountVerifyRequest, type AccountVerifyResponse, type AccountVerifyResponses, type AccountVerifyResult, type ActOnManageLinkData, type ActOnManageLinkError, type ActOnManageLinkErrors, type ActOnManageLinkResponse, type ActOnManageLinkResponses, type AdjustInventory, type AdjustVariantInventoryData, type AdjustVariantInventoryError, type AdjustVariantInventoryErrors, type AdjustVariantInventoryResponse, type AdjustVariantInventoryResponses, type AnalyticsBreakdown, type AnalyticsChannels, type AnalyticsFunnel, type AnalyticsFunnelInput, type AnalyticsFunnelPatch, type AnalyticsFunnelStepInput, type AnalyticsGoal, type AnalyticsGoalInput, type AnalyticsGoalList, type AnalyticsRealtime, type AnalyticsStatus, type AnalyticsSummary, type AnalyticsTimeseries, type AttachProductFileData, type AttachProductFileError, type AttachProductFileErrors, type AttachProductFileFromUrl, type AttachProductFileMultipart, type AttachProductFileResponse, type AttachProductFileResponses, type Attachment, type BusinessSummary, type CancelRetainerData, type CancelRetainerError, type CancelRetainerErrors, type CancelRetainerResponse, type CancelRetainerResponses, type CancelSubscriptionData, type CancelSubscriptionErrors, type CancelSubscriptionResponse, type CancelSubscriptionResponses, type CartCheckoutRequest, type CartConflict, type CartConflictItem, type CartSummaryRequest, type CartSummaryResult, type ChangedField, type CheckoutPauseRequest, type CheckoutPauseState, type CheckoutRequest, type CheckoutResult, type Client, type ClientOptions$1 as ClientConfig, type ClientOptions, type Config, type ConsentConfig, type ConsentConfigResult, type ConsentPrefs, type CreateAnalyticsFunnelData, type CreateAnalyticsFunnelErrors, type CreateAnalyticsFunnelResponse, type CreateAnalyticsFunnelResponses, type CreateAnalyticsGoalData, type CreateAnalyticsGoalErrors, type CreateAnalyticsGoalResponse, type CreateAnalyticsGoalResponses, type CreateCartCheckoutData, type CreateCartCheckoutError, type CreateCartCheckoutErrors, type CreateCartCheckoutResponse, type CreateCartCheckoutResponses, type CreateCheckoutData, type CreateCheckoutError, type CreateCheckoutErrors, type CreateCheckoutResponse, type CreateCheckoutResponses, type CreateCustomer, type CreateCustomerData, type CreateCustomerError, type CreateCustomerErrors, type CreateCustomerResponse, type CreateCustomerResponses, type CreateEventDestination, type CreateEventDestinationData, type CreateEventDestinationError, type CreateEventDestinationErrors, type CreateEventDestinationResponse, type CreateEventDestinationResponses, type CreateEventDestinationWithSiteTokenData, type CreateEventDestinationWithSiteTokenError, type CreateEventDestinationWithSiteTokenErrors, type CreateEventDestinationWithSiteTokenResponse, type CreateEventDestinationWithSiteTokenResponses, type CreateForm, type CreateFormData, type CreateFormError, type CreateFormErrors, type CreateFormResponse, type CreateFormResponses, type CreateFormWithSiteTokenData, type CreateFormWithSiteTokenError, type CreateFormWithSiteTokenErrors, type CreateFormWithSiteTokenResponse, type CreateFormWithSiteTokenResponses, type CreateInvoice, type CreateInvoiceData, type CreateInvoiceError, type CreateInvoiceErrors, type CreateInvoiceLine, type CreateInvoiceResponse, type CreateInvoiceResponses, type CreateInvoiceResult, type CreateMultiItemTestOrder, type CreateMultiItemTestOrderData, type CreateMultiItemTestOrderError, type CreateMultiItemTestOrderErrors, type CreateMultiItemTestOrderResponse, type CreateMultiItemTestOrderResponses, type CreateOption, type CreateOptionData, type CreateOptionError, type CreateOptionErrors, type CreateOptionResponse, type CreateOptionResponses, type CreatePreviewSession, type CreatePreviewSessionData, type CreatePreviewSessionError, type CreatePreviewSessionErrors, type CreatePreviewSessionResponse, type CreatePreviewSessionResponses, type CreateProduct, type CreateProductData, type CreateProductError, type CreateProductErrors, type CreateProductResponse, type CreateProductResponses, type CreateProductReviewData, type CreateProductReviewError, type CreateProductReviewErrors, type CreateProductReviewResponse, type CreateProductReviewResponses, type CreateProductWithSiteTokenData, type CreateProductWithSiteTokenError, type CreateProductWithSiteTokenErrors, type CreateProductWithSiteTokenResponse, type CreateProductWithSiteTokenResponses, type CreatePromo, type CreatePromoData, type CreatePromoError, type CreatePromoErrors, type CreatePromoForSiteData, type CreatePromoForSiteError, type CreatePromoForSiteErrors, type CreatePromoForSiteResponse, type CreatePromoForSiteResponses, type CreatePromoResponse, type CreatePromoResponses, type CreateRetainer, type CreateRetainerData, type CreateRetainerError, type CreateRetainerErrors, type CreateRetainerResponse, type CreateRetainerResponses, type CreateRetainerResult, type CreateSite, type CreateSiteData, type CreateSiteError, type CreateSiteErrors, type CreateSiteResponse, type CreateSiteResponses, type CreateTestOrder, type CreateTestOrderData, type CreateTestOrderError, type CreateTestOrderErrors, type CreateTestOrderResponse, type CreateTestOrderResponses, type CreateTestSubscription, type CreateTestSubscriptionData, type CreateTestSubscriptionError, type CreateTestSubscriptionErrors, type CreateTestSubscriptionResponse, type CreateTestSubscriptionResponses, type CreateVariant, type CreateVariantData, type CreateVariantError, type CreateVariantErrors, type CreateVariantResponse, type CreateVariantResponses, type CurrencyRestatement, type CurrencyTotals, type Customer, type CustomerAddress, type CustomerBilling, type CustomerDetail, type CustomersList, type DeleteAnalyticsFunnelData, type DeleteAnalyticsFunnelErrors, type DeleteAnalyticsFunnelResponse, type DeleteAnalyticsFunnelResponses, type DeleteAnalyticsGoalData, type DeleteAnalyticsGoalErrors, type DeleteAnalyticsGoalResponse, type DeleteAnalyticsGoalResponses, type DeleteEventDestinationData, type DeleteEventDestinationError, type DeleteEventDestinationErrors, type DeleteEventDestinationResponse, type DeleteEventDestinationResponses, type DeleteEventDestinationWithSiteTokenData, type DeleteEventDestinationWithSiteTokenError, type DeleteEventDestinationWithSiteTokenErrors, type DeleteEventDestinationWithSiteTokenResponse, type DeleteEventDestinationWithSiteTokenResponses, type DeleteFormData, type DeleteFormError, type DeleteFormErrors, type DeleteFormResponse, type DeleteFormResponses, type DeleteOptionData, type DeleteOptionError, type DeleteOptionErrors, type DeleteOptionResponse, type DeleteOptionResponses, type DeleteProductData, type DeleteProductError, type DeleteProductErrors, type DeleteProductResponse, type DeleteProductResponses, type DeleteSiteData, type DeleteSiteError, type DeleteSiteErrors, type DeleteSiteResponse, type DeleteSiteResponses, type DeleteSubmissionData, type DeleteSubmissionError, type DeleteSubmissionErrors, type DeleteSubmissionResponse, type DeleteSubmissionResponses, type DeleteVariantData, type DeleteVariantError, type DeleteVariantErrors, type DeleteVariantResponse, type DeleteVariantResponses, type DisablePromoData, type DisablePromoError, type DisablePromoErrors, type DisablePromoForSiteData, type DisablePromoForSiteError, type DisablePromoForSiteErrors, type DisablePromoForSiteResponse, type DisablePromoForSiteResponses, type DisablePromoResponse, type DisablePromoResponses, type DownloadAttachmentData, type DownloadAttachmentError, type DownloadAttachmentErrors, type DownloadAttachmentResponses, type DownloadFileData, type DownloadFileError, type DownloadFileErrors, type DownloadFileResponse, type DownloadFileResponses, type EditProductReviewData, type EditProductReviewError, type EditProductReviewErrors, type EditProductReviewResponse, type EditProductReviewResponses, type EmailDelivery, type EraseCustomerReviewsData, type EraseCustomerReviewsError, type EraseCustomerReviewsErrors, type EraseCustomerReviewsResponse, type EraseCustomerReviewsResponses, type Error, type EventDeliveriesList, type EventDelivery, type EventDestination, type EventDestinationSecret, type EventDestinationsList, type Form, type FormsList, type GenerateVariants, type GenerateVariantsData, type GenerateVariantsError, type GenerateVariantsErrors, type GenerateVariantsResponse, type GenerateVariantsResponses, type GenerateVariantsResult, type GeoSuggestion, type GetAccountReviewsData, type GetAccountReviewsError, type GetAccountReviewsErrors, type GetAccountReviewsResponse, type GetAccountReviewsResponses, type GetAnalyticsBrowsersData, type GetAnalyticsBrowsersErrors, type GetAnalyticsBrowsersResponse, type GetAnalyticsBrowsersResponses, type GetAnalyticsCampaignsData, type GetAnalyticsCampaignsErrors, type GetAnalyticsCampaignsResponse, type GetAnalyticsCampaignsResponses, type GetAnalyticsChannelsData, type GetAnalyticsChannelsErrors, type GetAnalyticsChannelsResponse, type GetAnalyticsChannelsResponses, type GetAnalyticsCitiesData, type GetAnalyticsCitiesErrors, type GetAnalyticsCitiesResponse, type GetAnalyticsCitiesResponses, type GetAnalyticsConversionsData, type GetAnalyticsConversionsErrors, type GetAnalyticsConversionsResponse, type GetAnalyticsConversionsResponses, type GetAnalyticsCountriesData, type GetAnalyticsCountriesErrors, type GetAnalyticsCountriesResponse, type GetAnalyticsCountriesResponses, type GetAnalyticsDevicesData, type GetAnalyticsDevicesErrors, type GetAnalyticsDevicesResponse, type GetAnalyticsDevicesResponses, type GetAnalyticsEntryPagesData, type GetAnalyticsEntryPagesErrors, type GetAnalyticsEntryPagesResponse, type GetAnalyticsEntryPagesResponses, type GetAnalyticsExitPagesData, type GetAnalyticsExitPagesErrors, type GetAnalyticsExitPagesResponse, type GetAnalyticsExitPagesResponses, type GetAnalyticsFunnelReportData, type GetAnalyticsFunnelReportErrors, type GetAnalyticsFunnelReportResponse, type GetAnalyticsFunnelReportResponses, type GetAnalyticsOperatingSystemsData, type GetAnalyticsOperatingSystemsErrors, type GetAnalyticsOperatingSystemsResponse, type GetAnalyticsOperatingSystemsResponses, type GetAnalyticsPagesData, type GetAnalyticsPagesErrors, type GetAnalyticsPagesResponse, type GetAnalyticsPagesResponses, type GetAnalyticsRealtimeData, type GetAnalyticsRealtimeErrors, type GetAnalyticsRealtimeResponse, type GetAnalyticsRealtimeResponses, type GetAnalyticsRegionsData, type GetAnalyticsRegionsErrors, type GetAnalyticsRegionsResponse, type GetAnalyticsRegionsResponses, type GetAnalyticsSourcesData, type GetAnalyticsSourcesErrors, type GetAnalyticsSourcesResponse, type GetAnalyticsSourcesResponses, type GetAnalyticsStatusData, type GetAnalyticsStatusErrors, type GetAnalyticsStatusResponse, type GetAnalyticsStatusResponses, type GetAnalyticsSummaryData, type GetAnalyticsSummaryErrors, type GetAnalyticsSummaryResponse, type GetAnalyticsSummaryResponses, type GetAnalyticsTimeseriesData, type GetAnalyticsTimeseriesErrors, type GetAnalyticsTimeseriesResponse, type GetAnalyticsTimeseriesResponses, type GetAnalyticsUtmCampaignData, type GetAnalyticsUtmCampaignErrors, type GetAnalyticsUtmCampaignResponse, type GetAnalyticsUtmCampaignResponses, type GetAnalyticsUtmContentData, type GetAnalyticsUtmContentErrors, type GetAnalyticsUtmContentResponse, type GetAnalyticsUtmContentResponses, type GetAnalyticsUtmMediumData, type GetAnalyticsUtmMediumErrors, type GetAnalyticsUtmMediumResponse, type GetAnalyticsUtmMediumResponses, type GetAnalyticsUtmSourceData, type GetAnalyticsUtmSourceErrors, type GetAnalyticsUtmSourceResponse, type GetAnalyticsUtmSourceResponses, type GetAnalyticsUtmTermData, type GetAnalyticsUtmTermErrors, type GetAnalyticsUtmTermResponse, type GetAnalyticsUtmTermResponses, type GetBusinessSummaryData, type GetBusinessSummaryErrors, type GetBusinessSummaryResponse, type GetBusinessSummaryResponses, type GetCartSummaryData, type GetCartSummaryError, type GetCartSummaryErrors, type GetCartSummaryResponse, type GetCartSummaryResponses, type GetConsentConfigWithSiteTokenData, type GetConsentConfigWithSiteTokenError, type GetConsentConfigWithSiteTokenErrors, type GetConsentConfigWithSiteTokenResponse, type GetConsentConfigWithSiteTokenResponses, type GetCustomerData, type GetCustomerError, type GetCustomerErrors, type GetCustomerResponse, type GetCustomerResponses, type GetEventDestinationData, type GetEventDestinationError, type GetEventDestinationErrors, type GetEventDestinationResponse, type GetEventDestinationResponses, type GetEventDestinationSecretData, type GetEventDestinationSecretError, type GetEventDestinationSecretErrors, type GetEventDestinationSecretResponse, type GetEventDestinationSecretResponses, type GetEventDestinationSecretWithSiteTokenData, type GetEventDestinationSecretWithSiteTokenError, type GetEventDestinationSecretWithSiteTokenErrors, type GetEventDestinationSecretWithSiteTokenResponse, type GetEventDestinationSecretWithSiteTokenResponses, type GetFormData, type GetFormError, type GetFormErrors, type GetFormResponse, type GetFormResponses, type GetGeoData, type GetGeoError, type GetGeoErrors, type GetGeoResponse, type GetGeoResponses, type GetInvoiceData, type GetInvoiceError, type GetInvoiceErrors, type GetInvoicePreviewData, type GetInvoicePreviewError, type GetInvoicePreviewErrors, type GetInvoicePreviewResponse, type GetInvoicePreviewResponses, type GetInvoiceResponse, type GetInvoiceResponses, type GetInvoiceSettingsData, type GetInvoiceSettingsError, type GetInvoiceSettingsErrors, type GetInvoiceSettingsResponse, type GetInvoiceSettingsResponses, type GetInvoiceSettingsWithSiteTokenData, type GetInvoiceSettingsWithSiteTokenError, type GetInvoiceSettingsWithSiteTokenErrors, type GetInvoiceSettingsWithSiteTokenResponse, type GetInvoiceSettingsWithSiteTokenResponses, type GetMerchantReviewData, type GetMerchantReviewError, type GetMerchantReviewErrors, type GetMerchantReviewResponse, type GetMerchantReviewResponses, type GetNextPayoutData, type GetNextPayoutErrors, type GetNextPayoutResponse, type GetNextPayoutResponses, type GetOrderData, type GetOrderError, type GetOrderErrors, type GetOrderResponse, type GetOrderResponses, type GetOrderSessionData, type GetOrderSessionError, type GetOrderSessionErrors, type GetOrderSessionResponse, type GetOrderSessionResponses, type GetOwnProductReviewData, type GetOwnProductReviewError, type GetOwnProductReviewErrors, type GetOwnProductReviewResponse, type GetOwnProductReviewResponses, type GetPaymentsStatusData, type GetPaymentsStatusError, type GetPaymentsStatusErrors, type GetPaymentsStatusResponse, type GetPaymentsStatusResponses, type GetPersonData, type GetPersonErrors, type GetPersonResponse, type GetPersonResponses, type GetProductData, type GetProductError, type GetProductErrors, type GetProductResponse, type GetProductResponses, type GetProductReviewAvailabilityData, type GetProductReviewAvailabilityError, type GetProductReviewAvailabilityErrors, type GetProductReviewAvailabilityResponse, type GetProductReviewAvailabilityResponses, type GetProductReviewsData, type GetProductReviewsError, type GetProductReviewsErrors, type GetProductReviewsResponse, type GetProductReviewsResponses, type GetPromoData, type GetPromoError, type GetPromoErrors, type GetPromoForSiteData, type GetPromoForSiteError, type GetPromoForSiteErrors, type GetPromoForSiteResponse, type GetPromoForSiteResponses, type GetPromoResponse, type GetPromoResponses, type GetPublicConsentPrefsData, type GetPublicConsentPrefsError, type GetPublicConsentPrefsErrors, type GetPublicConsentPrefsResponse, type GetPublicConsentPrefsResponses, type GetPublicProductData, type GetPublicProductError, type GetPublicProductErrors, type GetPublicProductResponse, type GetPublicProductResponses, type GetRetainerData, type GetRetainerError, type GetRetainerErrors, type GetRetainerResponse, type GetRetainerResponses, type GetReviewSettingsData, type GetReviewSettingsError, type GetReviewSettingsErrors, type GetReviewSettingsResponse, type GetReviewSettingsResponses, type GetSalesSummaryData, type GetSalesSummaryErrors, type GetSalesSummaryResponse, type GetSalesSummaryResponses, type GetSiteAnalyticsData, type GetSiteAnalyticsError, type GetSiteAnalyticsErrors, type GetSiteAnalyticsResponse, type GetSiteAnalyticsResponses, type GetSiteCheckoutPauseData, type GetSiteCheckoutPauseError, type GetSiteCheckoutPauseErrors, type GetSiteCheckoutPauseResponse, type GetSiteCheckoutPauseResponses, type GetSiteData, type GetSiteError, type GetSiteErrors, type GetSiteResponse, type GetSiteResponses, type GetSubmissionData, type GetSubmissionError, type GetSubmissionErrors, type GetSubmissionResponse, type GetSubmissionResponses, type Inventory, type InventoryInput, type Invoice, type InvoiceAggregates, type InvoiceBillTo, type InvoiceError, type InvoiceLineItem, type InvoicePreview, type InvoiceSettings, type InvoiceSiteBody, type InvoicesList, type ListAnalyticsFunnelsData, type ListAnalyticsFunnelsErrors, type ListAnalyticsFunnelsResponse, type ListAnalyticsFunnelsResponses, type ListAnalyticsGoalsData, type ListAnalyticsGoalsErrors, type ListAnalyticsGoalsResponse, type ListAnalyticsGoalsResponses, type ListCustomersData, type ListCustomersError, type ListCustomersErrors, type ListCustomersResponse, type ListCustomersResponses, type ListEventDeliveriesData, type ListEventDeliveriesError, type ListEventDeliveriesErrors, type ListEventDeliveriesResponse, type ListEventDeliveriesResponses, type ListEventDeliveriesWithSiteTokenData, type ListEventDeliveriesWithSiteTokenError, type ListEventDeliveriesWithSiteTokenErrors, type ListEventDeliveriesWithSiteTokenResponse, type ListEventDeliveriesWithSiteTokenResponses, type ListEventDestinationsData, type ListEventDestinationsError, type ListEventDestinationsErrors, type ListEventDestinationsResponse, type ListEventDestinationsResponses, type ListEventDestinationsWithSiteTokenData, type ListEventDestinationsWithSiteTokenError, type ListEventDestinationsWithSiteTokenErrors, type ListEventDestinationsWithSiteTokenResponse, type ListEventDestinationsWithSiteTokenResponses, type ListFormsData, type ListFormsError, type ListFormsErrors, type ListFormsResponse, type ListFormsResponses, type ListFormsWithSiteTokenData, type ListFormsWithSiteTokenError, type ListFormsWithSiteTokenErrors, type ListFormsWithSiteTokenResponse, type ListFormsWithSiteTokenResponses, type ListInvoicesData, type ListInvoicesError, type ListInvoicesErrors, type ListInvoicesResponse, type ListInvoicesResponses, type ListMerchantReviewsData, type ListMerchantReviewsError, type ListMerchantReviewsErrors, type ListMerchantReviewsResponse, type ListMerchantReviewsResponses, type ListOrdersWithSiteTokenData, type ListOrdersWithSiteTokenError, type ListOrdersWithSiteTokenErrors, type ListOrdersWithSiteTokenResponse, type ListOrdersWithSiteTokenResponses, type ListPeopleData, type ListPeopleErrors, type ListPeopleResponse, type ListPeopleResponses, type ListProductsData, type ListProductsError, type ListProductsErrors, type ListProductsResponse, type ListProductsResponses, type ListProductsWithSiteTokenData, type ListProductsWithSiteTokenError, type ListProductsWithSiteTokenErrors, type ListProductsWithSiteTokenResponse, type ListProductsWithSiteTokenResponses, type ListPromosData, type ListPromosError, type ListPromosErrors, type ListPromosForSiteData, type ListPromosForSiteError, type ListPromosForSiteErrors, type ListPromosForSiteResponse, type ListPromosForSiteResponses, type ListPromosResponse, type ListPromosResponses, type ListRetainersData, type ListRetainersError, type ListRetainersErrors, type ListRetainersResponse, type ListRetainersResponses, type ListSitesData, type ListSitesError, type ListSitesErrors, type ListSitesResponse, type ListSitesResponses, type ListSubmissionsData, type ListSubmissionsError, type ListSubmissionsErrors, type ListSubmissionsResponse, type ListSubmissionsResponses, type ListSubscriptionsData, type ListSubscriptionsErrors, type ListSubscriptionsResponse, type ListSubscriptionsResponses, type ManageCancelResult, type ManageLinkAction, type ManageVerifyRequest, type ManageVerifyResult, type ManagedSubscription, type ManagedSubscriptionResult, type MarkInvoicePaid, type MarkInvoicePaidData, type MarkInvoicePaidError, type MarkInvoicePaidErrors, type MarkInvoicePaidResponse, type MarkInvoicePaidResponses, type MarkInvoicePaidResult, type MarkInvoiceUncollectibleData, type MarkInvoiceUncollectibleError, type MarkInvoiceUncollectibleErrors, type MarkInvoiceUncollectibleResponse, type MarkInvoiceUncollectibleResponses, type ModerateMerchantReviewData, type ModerateMerchantReviewError, type ModerateMerchantReviewErrors, type ModerateMerchantReviewResponse, type ModerateMerchantReviewResponses, type NeedsAttentionItem, type NestedOptionInput, type NestedVariantInput, type NextPayout, type Option, type Options, type Order, type OrderCustomer, type OrderFulfillmentRequest, type OrderSessionStatus, type OrdersList, type OwnProductReview, type PauseRetainerData, type PauseRetainerError, type PauseRetainerErrors, type PauseRetainerResponse, type PauseRetainerResponses, type PauseSiteCheckoutData, type PauseSiteCheckoutError, type PauseSiteCheckoutErrors, type PauseSiteCheckoutResponse, type PauseSiteCheckoutResponses, type PaymentsStatus, type PeopleList, type PersonDetail, type PersonRow, type PortalSessionResult, type PreviewInvoice, type PreviewInvoiceData, type PreviewInvoiceError, type PreviewInvoiceErrors, type PreviewInvoiceResponse, type PreviewInvoiceResponses, type PreviewSessionResult, type Product, type ProductDetail, type ProductFulfillment, type ProductFulfillmentInput, type ProductReview, type ProductSubscriptionConfig, type ProductsList, type Promo, type PromoError, type PromosList, type PublicOption, type PublicProduct, type PublicSubscription, type PublicSubscriptionPlan, type PublicVariant, type PurgeSiteReviewsData, type PurgeSiteReviewsError, type PurgeSiteReviewsErrors, type PurgeSiteReviewsResponse, type PurgeSiteReviewsResponses, type ReactivateSiteSubscriptionsTeardownData, type ReactivateSiteSubscriptionsTeardownError, type ReactivateSiteSubscriptionsTeardownErrors, type ReactivateSiteSubscriptionsTeardownResponse, type ReactivateSiteSubscriptionsTeardownResponses, type RecipientCooldownError, type ReconcileOptionInput, type ReconcileOptionValueInput, type ReconcileVariantInput, type RefundOrder, type RefundOrderData, type RefundOrderError, type RefundOrderErrors, type RefundOrderResponse, type RefundOrderResponses, type RefundResult, type ReissueResult, type RemindInvoiceData, type RemindInvoiceError, type RemindInvoiceErrors, type RemindInvoiceResponse, type RemindInvoiceResponses, type RemindInvoiceResult, type ReplacePromoData, type ReplacePromoError, type ReplacePromoErrors, type ReplacePromoForSiteData, type ReplacePromoForSiteError, type ReplacePromoForSiteErrors, type ReplacePromoForSiteResponse, type ReplacePromoForSiteResponses, type ReplacePromoResponse, type ReplacePromoResponses, type ReplyToMerchantReviewData, type ReplyToMerchantReviewError, type ReplyToMerchantReviewErrors, type ReplyToMerchantReviewResponse, type ReplyToMerchantReviewResponses, type ResendInvoiceData, type ResendInvoiceError, type ResendInvoiceErrors, type ResendInvoiceResponse, type ResendInvoiceResponses, type ResendOrderReceiptData, type ResendOrderReceiptError, type ResendOrderReceiptErrors, type ResendOrderReceiptResponse, type ResendOrderReceiptResponses, type ResendReceiptResult, type ResetOrderDownloadsData, type ResetOrderDownloadsError, type ResetOrderDownloadsErrors, type ResetOrderDownloadsResponse, type ResetOrderDownloadsResponses, type ResetWebhookEventData, type ResetWebhookEventError, type ResetWebhookEventErrors, type ResetWebhookEventResponse, type ResetWebhookEventResponses, type ResolveManageLinkData, type ResolveManageLinkError, type ResolveManageLinkErrors, type ResolveManageLinkResponse, type ResolveManageLinkResponses, type ResubmitProductReviewData, type ResubmitProductReviewError, type ResubmitProductReviewErrors, type ResubmitProductReviewResponse, type ResubmitProductReviewResponses, type ResumeRetainerData, type ResumeRetainerError, type ResumeRetainerErrors, type ResumeRetainerResponse, type ResumeRetainerResponses, type Retainer, type RetainerError, type RetainerSiteBody, type RetainersList, type RetryEventDeliveryData, type RetryEventDeliveryError, type RetryEventDeliveryErrors, type RetryEventDeliveryResponse, type RetryEventDeliveryResponses, type RetryEventDeliveryWithSiteTokenData, type RetryEventDeliveryWithSiteTokenError, type RetryEventDeliveryWithSiteTokenErrors, type RetryEventDeliveryWithSiteTokenResponse, type RetryEventDeliveryWithSiteTokenResponses, type ReviewReadiness, type RevokeCustomerAccessData, type RevokeCustomerAccessError, type RevokeCustomerAccessErrors, type RevokeCustomerAccessResponse, type RevokeCustomerAccessResponses, type RevokeCustomerAccessResult, type RotateEventDestinationSecretData, type RotateEventDestinationSecretError, type RotateEventDestinationSecretErrors, type RotateEventDestinationSecretResponse, type RotateEventDestinationSecretResponses, type RotateEventDestinationSecretWithSiteTokenData, type RotateEventDestinationSecretWithSiteTokenError, type RotateEventDestinationSecretWithSiteTokenErrors, type RotateEventDestinationSecretWithSiteTokenResponse, type RotateEventDestinationSecretWithSiteTokenResponses, type SalesSummary, type SalesSummaryProductRow, type SalesSummarySeriesEntry, type SetInventory, type SetInvoiceReminders, type SetInvoiceRemindersData, type SetInvoiceRemindersError, type SetInvoiceRemindersErrors, type SetInvoiceRemindersResponse, type SetInvoiceRemindersResponses, type SetOrderFulfillmentData, type SetOrderFulfillmentErrors, type SetOrderFulfillmentResponse, type SetOrderFulfillmentResponses, type SetProductSubscription, type SetProductSubscriptionData, type SetProductSubscriptionError, type SetProductSubscriptionErrors, type SetProductSubscriptionResponse, type SetProductSubscriptionResponses, type SetProductVariants, type SetProductVariantsConflict, type SetProductVariantsData, type SetProductVariantsError, type SetProductVariantsErrors, type SetProductVariantsResponse, type SetProductVariantsResponses, type SetProductVariantsResult, type SetVariantInventoryData, type SetVariantInventoryError, type SetVariantInventoryErrors, type SetVariantInventoryResponse, type SetVariantInventoryResponses, type SettledTotals, type ShippingOptionUnavailable, type ShippingRateInput, type Site, type SiteAccountRoute, type SiteAnalytics, type SiteDomains, type SitePayments, type SiteWithRestatement, type SiteWithToken, type SitesList, type SkipNextRetainerCycleData, type SkipNextRetainerCycleError, type SkipNextRetainerCycleErrors, type SkipNextRetainerCycleResponse, type SkipNextRetainerCycleResponses, type SnoozeInvoice, type SnoozeInvoiceData, type SnoozeInvoiceError, type SnoozeInvoiceErrors, type SnoozeInvoiceResponse, type SnoozeInvoiceResponses, type Submission, type SubmissionMetadata, type SubmissionsList, type SubscriberActionResult, type SubscriberSubscription, type SubscriptionPlan, type SubscriptionPlanInput, type SubscriptionSummary, type SubscriptionsList, type SubscriptionsReactivateBody, type SubscriptionsReactivateResult, type SubscriptionsTeardownBody, type SubscriptionsTeardownResult, type SummaryPeriod, type TeardownReason, type TeardownSiteSubscriptionsData, type TeardownSiteSubscriptionsError, type TeardownSiteSubscriptionsErrors, type TeardownSiteSubscriptionsResponse, type TeardownSiteSubscriptionsResponses, type TestOrderResult, type TestShippingAddress, type TestSubscriptionResult, type UpdateAnalyticsFunnelData, type UpdateAnalyticsFunnelErrors, type UpdateAnalyticsFunnelResponse, type UpdateAnalyticsFunnelResponses, type UpdateAnalyticsGoalData, type UpdateAnalyticsGoalErrors, type UpdateAnalyticsGoalResponse, type UpdateAnalyticsGoalResponses, type UpdateCustomer, type UpdateCustomerBilling, type UpdateCustomerBillingData, type UpdateCustomerBillingError, type UpdateCustomerBillingErrors, type UpdateCustomerBillingResponse, type UpdateCustomerBillingResponses, type UpdateCustomerData, type UpdateCustomerError, type UpdateCustomerErrors, type UpdateCustomerResponse, type UpdateCustomerResponses, type UpdateEventDestination, type UpdateEventDestinationData, type UpdateEventDestinationError, type UpdateEventDestinationErrors, type UpdateEventDestinationResponse, type UpdateEventDestinationResponses, type UpdateEventDestinationWithSiteTokenData, type UpdateEventDestinationWithSiteTokenError, type UpdateEventDestinationWithSiteTokenErrors, type UpdateEventDestinationWithSiteTokenResponse, type UpdateEventDestinationWithSiteTokenResponses, type UpdateForm, type UpdateFormData, type UpdateFormError, type UpdateFormErrors, type UpdateFormResponse, type UpdateFormResponses, type UpdateInvoiceRecipient, type UpdateInvoiceRecipientData, type UpdateInvoiceRecipientError, type UpdateInvoiceRecipientErrors, type UpdateInvoiceRecipientResponse, type UpdateInvoiceRecipientResponses, type UpdateInvoiceSettings, type UpdateInvoiceSettingsData, type UpdateInvoiceSettingsError, type UpdateInvoiceSettingsErrors, type UpdateInvoiceSettingsResponse, type UpdateInvoiceSettingsResponses, type UpdateOption, type UpdateOptionData, type UpdateOptionError, type UpdateOptionErrors, type UpdateOptionResponse, type UpdateOptionResponses, type UpdateProduct, type UpdateProductData, type UpdateProductError, type UpdateProductErrors, type UpdateProductResponse, type UpdateProductResponses, type UpdateRecipientResult, type UpdateRetainer, type UpdateRetainerData, type UpdateRetainerError, type UpdateRetainerErrors, type UpdateRetainerResponse, type UpdateRetainerResponses, type UpdateReviewSettingsData, type UpdateReviewSettingsError, type UpdateReviewSettingsErrors, type UpdateReviewSettingsResponse, type UpdateReviewSettingsResponses, type UpdateSite, type UpdateSiteAccountRoute, type UpdateSiteAccountRouteData, type UpdateSiteAccountRouteError, type UpdateSiteAccountRouteErrors, type UpdateSiteAccountRouteResponse, type UpdateSiteAccountRouteResponses, type UpdateSiteAnalytics, type UpdateSiteAnalyticsData, type UpdateSiteAnalyticsError, type UpdateSiteAnalyticsErrors, type UpdateSiteAnalyticsResponse, type UpdateSiteAnalyticsResponses, type UpdateSiteData, type UpdateSiteDomains, type UpdateSiteDomainsData, type UpdateSiteDomainsError, type UpdateSiteDomainsErrors, type UpdateSiteDomainsResponse, type UpdateSiteDomainsResponses, type UpdateSiteError, type UpdateSiteErrors, type UpdateSiteInvoicing, type UpdateSiteInvoicingData, type UpdateSiteInvoicingError, type UpdateSiteInvoicingErrors, type UpdateSiteInvoicingResponse, type UpdateSiteInvoicingResponses, type UpdateSitePayments, type UpdateSitePaymentsData, type UpdateSitePaymentsError, type UpdateSitePaymentsErrors, type UpdateSitePaymentsResponse, type UpdateSitePaymentsResponses, type UpdateSiteResponse, type UpdateSiteResponses, type UpdateSubscriptionAddressRequest, type UpdateVariant, type UpdateVariantData, type UpdateVariantError, type UpdateVariantErrors, type UpdateVariantResponse, type UpdateVariantResponses, type UpsertConsentConfig, type UpsertConsentConfigWithSiteTokenData, type UpsertConsentConfigWithSiteTokenError, type UpsertConsentConfigWithSiteTokenErrors, type UpsertConsentConfigWithSiteTokenResponse, type UpsertConsentConfigWithSiteTokenResponses, type Variant, type VariantOptionValue, type VoidInvoice, type VoidInvoiceData, type VoidInvoiceError, type VoidInvoiceErrors, type VoidInvoiceResponse, type VoidInvoiceResponses, type VoidInvoiceResult, type WebhookEventResetResult, type WithdrawProductReviewData, type WithdrawProductReviewError, type WithdrawProductReviewErrors, type WithdrawProductReviewResponse, type WithdrawProductReviewResponses, accountCancelSubscription, accountCreatePortalSession, accountLogin, accountLogout, accountManageCancel, accountManageGetSubscription, accountManagePortalSession, accountManageVerify, accountMe, accountReactivateSubscription, accountSubscribe, accountUpdateSubscriptionAddress, accountVerify, actOnManageLink, adjustVariantInventory, attachProductFile, cancelRetainer, cancelSubscription, createAnalyticsFunnel, createAnalyticsGoal, createCartCheckout, createCheckout, createClient, createConfig, createCustomer, createEventDestination, createEventDestinationWithSiteToken, createForm, createFormWithSiteToken, createInvoice, createMultiItemTestOrder, createOption, createPreviewSession, createProduct, createProductReview, createProductWithSiteToken, createPromo, createPromoForSite, createRetainer, createSite, createTestOrder, createTestSubscription, createVariant, deleteAnalyticsFunnel, deleteAnalyticsGoal, deleteEventDestination, deleteEventDestinationWithSiteToken, deleteForm, deleteOption, deleteProduct, deleteSite, deleteSubmission, deleteVariant, disablePromo, disablePromoForSite, downloadAttachment, downloadFile, editProductReview, eraseCustomerReviews, generateVariants, getAccountReviews, getAnalyticsBrowsers, getAnalyticsCampaigns, getAnalyticsChannels, getAnalyticsCities, getAnalyticsConversions, getAnalyticsCountries, getAnalyticsDevices, getAnalyticsEntryPages, getAnalyticsExitPages, getAnalyticsFunnelReport, getAnalyticsOperatingSystems, getAnalyticsPages, getAnalyticsRealtime, getAnalyticsRegions, getAnalyticsSources, getAnalyticsStatus, getAnalyticsSummary, getAnalyticsTimeseries, getAnalyticsUtmCampaign, getAnalyticsUtmContent, getAnalyticsUtmMedium, getAnalyticsUtmSource, getAnalyticsUtmTerm, getBusinessSummary, getCartSummary, getConsentConfigWithSiteToken, getCustomer, getEventDestination, getEventDestinationSecret, getEventDestinationSecretWithSiteToken, getForm, getGeo, getInvoice, getInvoicePreview, getInvoiceSettings, getInvoiceSettingsWithSiteToken, getMerchantReview, getNextPayout, getOrder, getOrderSession, getOwnProductReview, getPaymentsStatus, getPerson, getProduct, getProductReviewAvailability, getProductReviews, getPromo, getPromoForSite, getPublicConsentPrefs, getPublicProduct, getRetainer, getReviewSettings, getSalesSummary, getSite, getSiteAnalytics, getSiteCheckoutPause, getSubmission, listAnalyticsFunnels, listAnalyticsGoals, listCustomers, listEventDeliveries, listEventDeliveriesWithSiteToken, listEventDestinations, listEventDestinationsWithSiteToken, listForms, listFormsWithSiteToken, listInvoices, listMerchantReviews, listOrdersWithSiteToken, listPeople, listProducts, listProductsWithSiteToken, listPromos, listPromosForSite, listRetainers, listSites, listSubmissions, listSubscriptions, markInvoicePaid, markInvoiceUncollectible, moderateMerchantReview, pauseRetainer, pauseSiteCheckout, previewInvoice, purgeSiteReviews, reactivateSiteSubscriptionsTeardown, refundOrder, remindInvoice, replacePromo, replacePromoForSite, replyToMerchantReview, resendInvoice, resendOrderReceipt, resetOrderDownloads, resetWebhookEvent, resolveManageLink, resubmitProductReview, resumeRetainer, retryEventDelivery, retryEventDeliveryWithSiteToken, revokeCustomerAccess, rotateEventDestinationSecret, rotateEventDestinationSecretWithSiteToken, setInvoiceReminders, setOrderFulfillment, setProductSubscription, setProductVariants, setVariantInventory, skipNextRetainerCycle, snoozeInvoice, teardownSiteSubscriptions, updateAnalyticsFunnel, updateAnalyticsGoal, updateCustomer, updateCustomerBilling, updateEventDestination, updateEventDestinationWithSiteToken, updateForm, updateInvoiceRecipient, updateInvoiceSettings, updateOption, updateProduct, updateRetainer, updateReviewSettings, updateSite, updateSiteAccountRoute, updateSiteAnalytics, updateSiteDomains, updateSiteInvoicing, updateSitePayments, updateVariant, upsertConsentConfigWithSiteToken, voidInvoice, withdrawProductReview };
|