@delopay/sdk 0.95.0 → 0.97.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/{chunk-6BVLBNEZ.js → chunk-JBBUTXXY.js} +70 -1
- package/dist/chunk-JBBUTXXY.js.map +1 -0
- package/dist/index.cjs +69 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +521 -1
- package/dist/index.d.ts +521 -1
- package/dist/index.js +1 -1
- package/dist/internal.cjs +104 -0
- package/dist/internal.cjs.map +1 -1
- package/dist/internal.d.cts +24 -3
- package/dist/internal.d.ts +24 -3
- package/dist/internal.js +36 -1
- package/dist/internal.js.map +1 -1
- package/package.json +18 -17
- package/dist/chunk-6BVLBNEZ.js.map +0 -1
package/dist/index.d.cts
CHANGED
|
@@ -1231,6 +1231,12 @@ interface ShopUpdateRequest {
|
|
|
1231
1231
|
* `ORD-74219807`. `null` = default `pay_<random>` ids.
|
|
1232
1232
|
*/
|
|
1233
1233
|
payment_id_format?: PaymentIdFormatConfig | null;
|
|
1234
|
+
/**
|
|
1235
|
+
* The shop's home country (ISO alpha-2) for cross-border analytics.
|
|
1236
|
+
* `null` = international / no home country (the default; on updates,
|
|
1237
|
+
* explicit `null` clears, absent leaves unchanged).
|
|
1238
|
+
*/
|
|
1239
|
+
home_country?: string | null;
|
|
1234
1240
|
}
|
|
1235
1241
|
interface ShopResponse {
|
|
1236
1242
|
shop_id: string;
|
|
@@ -1252,6 +1258,12 @@ interface ShopResponse {
|
|
|
1252
1258
|
* `ORD-74219807`. `null` = default `pay_<random>` ids.
|
|
1253
1259
|
*/
|
|
1254
1260
|
payment_id_format?: PaymentIdFormatConfig | null;
|
|
1261
|
+
/**
|
|
1262
|
+
* The shop's home country (ISO alpha-2) for cross-border analytics.
|
|
1263
|
+
* `null` = international / no home country (the default; on updates,
|
|
1264
|
+
* explicit `null` clears, absent leaves unchanged).
|
|
1265
|
+
*/
|
|
1266
|
+
home_country?: string | null;
|
|
1255
1267
|
}
|
|
1256
1268
|
/**
|
|
1257
1269
|
* Branding and behavior overrides for a shop's hosted checkout.
|
|
@@ -2392,6 +2404,134 @@ interface CheckoutThemeProgramResponse {
|
|
|
2392
2404
|
*/
|
|
2393
2405
|
warnings?: string[];
|
|
2394
2406
|
}
|
|
2407
|
+
/**
|
|
2408
|
+
* Which dimension a conversion breakdown is grouped by.
|
|
2409
|
+
*
|
|
2410
|
+
* `hour` is the UTC hour of the render, 0-23, as a string - not the buyer's
|
|
2411
|
+
* local hour. A shop reading it has to know which clock it is.
|
|
2412
|
+
*/
|
|
2413
|
+
type CheckoutThemeConversionSegment = 'none' | 'device' | 'country' | 'hour';
|
|
2414
|
+
/**
|
|
2415
|
+
* How much a single measured rate can carry.
|
|
2416
|
+
*
|
|
2417
|
+
* - `too_small` - under the server's render floor. The rate is still reported,
|
|
2418
|
+
* because hiding it invites the reader to assume it is zero, but nothing may
|
|
2419
|
+
* be concluded from it.
|
|
2420
|
+
* - `indicative` - enough to quote, interval too wide to call a close race.
|
|
2421
|
+
* - `reliable` - interval tight enough that a clear difference is a real one.
|
|
2422
|
+
*/
|
|
2423
|
+
type CheckoutThemeSampleVerdict = 'too_small' | 'indicative' | 'reliable';
|
|
2424
|
+
/** Which side of a separated comparison converted better. */
|
|
2425
|
+
type CheckoutThemeComparisonSide = 'variant' | 'baseline';
|
|
2426
|
+
/**
|
|
2427
|
+
* What the `rendered` counts are counts of.
|
|
2428
|
+
*
|
|
2429
|
+
* A code rather than a sentence so the wording can be translated and reworded
|
|
2430
|
+
* without deploying the payments service. Treat an unrecognised value as
|
|
2431
|
+
* "unknown basis" rather than failing.
|
|
2432
|
+
*/
|
|
2433
|
+
type CheckoutThemeDenominatorBasis = 'deduplicated_checkout_opens';
|
|
2434
|
+
/**
|
|
2435
|
+
* A known way a conversion result is not the whole truth.
|
|
2436
|
+
*
|
|
2437
|
+
* Codes, not sentences - a consumer maps each to its own translated copy. The
|
|
2438
|
+
* list is additive: a client that does not know a code should render nothing
|
|
2439
|
+
* for it rather than throw.
|
|
2440
|
+
*/
|
|
2441
|
+
type CheckoutThemeConversionCaveat = 'renders_deduplicated_by_device' | 'automated_traffic_excluded' | 'undeclared_mode_reported_separately' | 'no_device_class_in_window' | 'every_render_used_the_default' | 'some_payments_declared_no_mode';
|
|
2442
|
+
/** One variant x segment cell of the rendered-to-paid funnel. */
|
|
2443
|
+
interface CheckoutThemeConversionCell {
|
|
2444
|
+
/**
|
|
2445
|
+
* The named appearance variant, or `null` for the shop default - a real and
|
|
2446
|
+
* usually the largest cohort, not missing data.
|
|
2447
|
+
*/
|
|
2448
|
+
variant?: string | null;
|
|
2449
|
+
/**
|
|
2450
|
+
* Content fingerprint of what was actually rendered. Distinguishes two
|
|
2451
|
+
* renders of the "same" variant across a branding edit, which a name cannot.
|
|
2452
|
+
*/
|
|
2453
|
+
appearance?: string | null;
|
|
2454
|
+
/**
|
|
2455
|
+
* The value of the grouped dimension - a device class, an ISO country, or a
|
|
2456
|
+
* UTC hour as a string. `null` means the dimension was not observed for
|
|
2457
|
+
* these renders, which is its own bucket and must not be folded into another.
|
|
2458
|
+
*/
|
|
2459
|
+
segment?: string | null;
|
|
2460
|
+
/**
|
|
2461
|
+
* `true` test, `false` live, `null` the merchant declared no mode at create.
|
|
2462
|
+
* Its own bucket deliberately: a merchant who never declares should see that
|
|
2463
|
+
* rather than have their traffic silently filed as live.
|
|
2464
|
+
*/
|
|
2465
|
+
test_mode?: boolean | null;
|
|
2466
|
+
rendered: number;
|
|
2467
|
+
paid: number;
|
|
2468
|
+
/**
|
|
2469
|
+
* Conversion rate in `[0, 1]`, `null` when nothing was rendered. Not a
|
|
2470
|
+
* percentage - multiply if you want one, and there is then no question about
|
|
2471
|
+
* how it was rounded.
|
|
2472
|
+
*/
|
|
2473
|
+
rate?: number | null;
|
|
2474
|
+
/** Wilson interval bounds at ~95%. Both or neither; `null` when nothing rendered. */
|
|
2475
|
+
interval_low?: number | null;
|
|
2476
|
+
interval_high?: number | null;
|
|
2477
|
+
verdict: CheckoutThemeSampleVerdict;
|
|
2478
|
+
}
|
|
2479
|
+
/**
|
|
2480
|
+
* One named variant measured against the shop's default appearance, inside one
|
|
2481
|
+
* segment and one mode.
|
|
2482
|
+
*
|
|
2483
|
+
* Only the comparison a merchant actually makes. Every-variant-against-every-
|
|
2484
|
+
* other would answer a question nobody asked and multiply the chance that one
|
|
2485
|
+
* pair separates by luck alone.
|
|
2486
|
+
*/
|
|
2487
|
+
interface CheckoutThemeConversionComparison {
|
|
2488
|
+
variant: string;
|
|
2489
|
+
segment?: string | null;
|
|
2490
|
+
test_mode?: boolean | null;
|
|
2491
|
+
variant_rate?: number | null;
|
|
2492
|
+
baseline_rate?: number | null;
|
|
2493
|
+
/**
|
|
2494
|
+
* Whether the two intervals are disjoint and both samples clear the floor.
|
|
2495
|
+
*
|
|
2496
|
+
* `false` means **"not shown to differ"**, never "shown not to differ".
|
|
2497
|
+
* Overlapping intervals are not evidence of equality, and rendering this as
|
|
2498
|
+
* "no difference" says something the data does not.
|
|
2499
|
+
*/
|
|
2500
|
+
separates: boolean;
|
|
2501
|
+
/**
|
|
2502
|
+
* Which side converted better - present only when `separates`. A direction on
|
|
2503
|
+
* a comparison that did not separate is the exact over-reading the interval
|
|
2504
|
+
* exists to prevent.
|
|
2505
|
+
*/
|
|
2506
|
+
higher?: CheckoutThemeComparisonSide | null;
|
|
2507
|
+
}
|
|
2508
|
+
/** Query for `GET /routing/checkout-theme/conversion`. */
|
|
2509
|
+
interface CheckoutThemeConversionQuery {
|
|
2510
|
+
/** Shop to report on. Omit to report every shop the caller can see. */
|
|
2511
|
+
profile_id?: string;
|
|
2512
|
+
/** Window start, RFC3339. Inclusive. */
|
|
2513
|
+
start: string;
|
|
2514
|
+
/** Window end, RFC3339. Exclusive. */
|
|
2515
|
+
end: string;
|
|
2516
|
+
/** Defaults to `none` server-side: one row per variant. */
|
|
2517
|
+
segment?: CheckoutThemeConversionSegment;
|
|
2518
|
+
}
|
|
2519
|
+
/** Response for `GET /routing/checkout-theme/conversion`. */
|
|
2520
|
+
interface CheckoutThemeConversionResponse {
|
|
2521
|
+
segment: CheckoutThemeConversionSegment;
|
|
2522
|
+
cells: CheckoutThemeConversionCell[];
|
|
2523
|
+
/**
|
|
2524
|
+
* Every named variant measured against the shop default in its own bucket.
|
|
2525
|
+
* Empty when the window has no named variant, or no default to compare to.
|
|
2526
|
+
*/
|
|
2527
|
+
comparisons: CheckoutThemeConversionComparison[];
|
|
2528
|
+
denominator: CheckoutThemeDenominatorBasis;
|
|
2529
|
+
/**
|
|
2530
|
+
* Known ways this is not the whole truth. Always present, possibly empty, so
|
|
2531
|
+
* a consumer can render the field unconditionally.
|
|
2532
|
+
*/
|
|
2533
|
+
caveats: CheckoutThemeConversionCaveat[];
|
|
2534
|
+
}
|
|
2395
2535
|
/** Full routing config returned by `GET /routing/{id}`. */
|
|
2396
2536
|
interface MerchantRoutingAlgorithm {
|
|
2397
2537
|
id: string;
|
|
@@ -3019,6 +3159,12 @@ interface ProfileCreateRequest {
|
|
|
3019
3159
|
* `ORD-74219807`. `null` = default `pay_<random>` ids.
|
|
3020
3160
|
*/
|
|
3021
3161
|
payment_id_format?: PaymentIdFormatConfig | null;
|
|
3162
|
+
/**
|
|
3163
|
+
* The shop's home country (ISO alpha-2) for cross-border analytics.
|
|
3164
|
+
* `null` = international / no home country (the default; on updates,
|
|
3165
|
+
* explicit `null` clears, absent leaves unchanged).
|
|
3166
|
+
*/
|
|
3167
|
+
home_country?: string | null;
|
|
3022
3168
|
}
|
|
3023
3169
|
interface ProfileUpdateRequest {
|
|
3024
3170
|
profile_name?: string | null;
|
|
@@ -3044,6 +3190,12 @@ interface ProfileUpdateRequest {
|
|
|
3044
3190
|
* `ORD-74219807`. `null` = default `pay_<random>` ids.
|
|
3045
3191
|
*/
|
|
3046
3192
|
payment_id_format?: PaymentIdFormatConfig | null;
|
|
3193
|
+
/**
|
|
3194
|
+
* The shop's home country (ISO alpha-2) for cross-border analytics.
|
|
3195
|
+
* `null` = international / no home country (the default; on updates,
|
|
3196
|
+
* explicit `null` clears, absent leaves unchanged).
|
|
3197
|
+
*/
|
|
3198
|
+
home_country?: string | null;
|
|
3047
3199
|
}
|
|
3048
3200
|
interface ProfileResponse {
|
|
3049
3201
|
merchant_id: string;
|
|
@@ -3077,6 +3229,12 @@ interface ProfileResponse {
|
|
|
3077
3229
|
* `ORD-74219807`. `null` = default `pay_<random>` ids.
|
|
3078
3230
|
*/
|
|
3079
3231
|
payment_id_format?: PaymentIdFormatConfig | null;
|
|
3232
|
+
/**
|
|
3233
|
+
* The shop's home country (ISO alpha-2) for cross-border analytics.
|
|
3234
|
+
* `null` = international / no home country (the default; on updates,
|
|
3235
|
+
* explicit `null` clears, absent leaves unchanged).
|
|
3236
|
+
*/
|
|
3237
|
+
home_country?: string | null;
|
|
3080
3238
|
[key: string]: unknown;
|
|
3081
3239
|
}
|
|
3082
3240
|
type BlocklistAddRequest = {
|
|
@@ -3802,6 +3960,20 @@ interface AnalyticsScopeRequest {
|
|
|
3802
3960
|
* daily buckets.
|
|
3803
3961
|
*/
|
|
3804
3962
|
granularity?: string | null;
|
|
3963
|
+
/**
|
|
3964
|
+
* Restrict to payments from one country (ISO alpha-2), matched against the
|
|
3965
|
+
* claim `country_source` names. A filtered request always aggregates live
|
|
3966
|
+
* (the rollup is unfiltered); payments without a client-context observation
|
|
3967
|
+
* don't match ip/device filters (`FilterRequiresClientContext` caveat).
|
|
3968
|
+
*/
|
|
3969
|
+
country?: string | null;
|
|
3970
|
+
/** Which country claim `country` filters on: `"ip"` (default) or `"billing"`. */
|
|
3971
|
+
country_source?: string | null;
|
|
3972
|
+
/**
|
|
3973
|
+
* Restrict to payments of one device class: `phone` | `tablet` | `desktop`
|
|
3974
|
+
* | `unknown` (rows whose render predates classification).
|
|
3975
|
+
*/
|
|
3976
|
+
device_class?: string | null;
|
|
3805
3977
|
}
|
|
3806
3978
|
/**
|
|
3807
3979
|
* One bucket of aggregated payment activity — a calendar day, or a single UTC
|
|
@@ -3909,6 +4081,283 @@ interface AnalyticsScopeResponse {
|
|
|
3909
4081
|
* backends that predate the method dimension.
|
|
3910
4082
|
*/
|
|
3911
4083
|
methods?: AnalyticsMethodSlice[];
|
|
4084
|
+
/**
|
|
4085
|
+
* Known ways this response is not the whole truth (populated by filtered
|
|
4086
|
+
* requests today); absent on older backends.
|
|
4087
|
+
*/
|
|
4088
|
+
caveats?: ClientAnalyticsCaveat[];
|
|
4089
|
+
/** The country/device filters this response was computed under. */
|
|
4090
|
+
filters?: ClientAnalyticsFilters;
|
|
4091
|
+
}
|
|
4092
|
+
/**
|
|
4093
|
+
* Query for the device/geo analytics endpoints. Same drill/window contract as
|
|
4094
|
+
* `AnalyticsScopeRequest`; `mode` applies to the geo endpoint only.
|
|
4095
|
+
*/
|
|
4096
|
+
interface ClientAnalyticsRequest {
|
|
4097
|
+
/** Trailing days for a rolling window ending now. Default 7, capped at 92. */
|
|
4098
|
+
days?: number | null;
|
|
4099
|
+
/** Naive ISO 8601 datetime for the window start (custom range; span ≤ 92 days). */
|
|
4100
|
+
start_date?: string | null;
|
|
4101
|
+
/** Naive ISO 8601 datetime for the inclusive last day. Defaults to now. */
|
|
4102
|
+
end_date?: string | null;
|
|
4103
|
+
/** Scope to a single merchant. Ignored (server-pinned) on the merchant routes. */
|
|
4104
|
+
merchant_id?: string | null;
|
|
4105
|
+
/** Scope to one project's shops. */
|
|
4106
|
+
project_id?: string | null;
|
|
4107
|
+
/** Scope to a single shop; wins over project_id. */
|
|
4108
|
+
shop_id?: string | null;
|
|
4109
|
+
/** `false` = live only, `true` = test only. Omit for both. */
|
|
4110
|
+
test_mode?: boolean | null;
|
|
4111
|
+
/**
|
|
4112
|
+
* Series bucket size: `"day"` (default) or `"hour"`. Hourly buckets require
|
|
4113
|
+
* a window of at most 48 hours and always aggregate live.
|
|
4114
|
+
*/
|
|
4115
|
+
granularity?: string | null;
|
|
4116
|
+
/**
|
|
4117
|
+
* Comma-separated response blocks to compute; omit for all. Devices:
|
|
4118
|
+
* `totals`, `browsers`, `platforms`, `classes`, `models`, `channels`,
|
|
4119
|
+
* `timing`, `children`. Geo: `totals`, `countries`, `cities`, `heatmap`,
|
|
4120
|
+
* `languages`, `children`.
|
|
4121
|
+
*/
|
|
4122
|
+
sections?: string | null;
|
|
4123
|
+
/**
|
|
4124
|
+
* Geo endpoint only: which location claim to aggregate — `"ip"` (default;
|
|
4125
|
+
* IP-derived country + city coordinates) or `"billing"` (plaintext
|
|
4126
|
+
* billing-address country/city, no coordinates). Never coalesced.
|
|
4127
|
+
*/
|
|
4128
|
+
mode?: string | null;
|
|
4129
|
+
/** Restrict to sessions from one country (ISO alpha-2). */
|
|
4130
|
+
country?: string | null;
|
|
4131
|
+
/** Which country claim `country` filters on: `"ip"` (default) or `"billing"`. */
|
|
4132
|
+
country_source?: string | null;
|
|
4133
|
+
/** Restrict to one device class: `phone` | `tablet` | `desktop` | `unknown`. */
|
|
4134
|
+
device_class?: string | null;
|
|
4135
|
+
}
|
|
4136
|
+
/**
|
|
4137
|
+
* Known ways a figure in an analytics response is not the whole truth. Codes,
|
|
4138
|
+
* not sentences — the dashboards map each to translated copy.
|
|
4139
|
+
*/
|
|
4140
|
+
type ClientAnalyticsCaveat = 'OptimisationUseDisabled' | 'DeviceTrackingDisabled' | 'GeoIpDisabled' | 'AutomatedTrafficExcluded' | 'RetentionWindowTruncatesWindow' | 'DeviceClassMissingInWindow' | 'BillingModeCountryLevelOnly' | 'BillingCityRedactedExcluded' | 'ShopHasNoHomeCountry' | 'NoObservationsInWindow' | 'FilterRequiresClientContext' | 'TimingDenominatorTruncated' | 'FxRateUnavailable';
|
|
4141
|
+
/** The filters a response was computed under, echoed back verbatim. */
|
|
4142
|
+
interface ClientAnalyticsFilters {
|
|
4143
|
+
country?: string | null;
|
|
4144
|
+
country_source?: string | null;
|
|
4145
|
+
device_class?: string | null;
|
|
4146
|
+
}
|
|
4147
|
+
/** Window totals for the device dashboard's KPI row. */
|
|
4148
|
+
interface DeviceAnalyticsTotals {
|
|
4149
|
+
/** Canonical sessions (one per payment), automated traffic excluded. */
|
|
4150
|
+
sessions: number;
|
|
4151
|
+
/** Sessions whose payment reached `succeeded`. */
|
|
4152
|
+
paid: number;
|
|
4153
|
+
/** `paid / sessions` (0 when there are no sessions). */
|
|
4154
|
+
conversion: number;
|
|
4155
|
+
/** Share of sessions on phone or tablet. */
|
|
4156
|
+
mobile_share: number;
|
|
4157
|
+
/** Share of raw observations that were automated and therefore excluded. */
|
|
4158
|
+
automated_share: number;
|
|
4159
|
+
}
|
|
4160
|
+
/** One series bucket of overall session/paid counts (KPI sparklines). */
|
|
4161
|
+
interface DeviceSessionBucket {
|
|
4162
|
+
/** Bucket start: `YYYY-MM-DD` (day grain) or `YYYY-MM-DDTHH:00:00Z` (hour grain). */
|
|
4163
|
+
bucket: string;
|
|
4164
|
+
sessions: number;
|
|
4165
|
+
paid: number;
|
|
4166
|
+
}
|
|
4167
|
+
/** One browser family's window totals. */
|
|
4168
|
+
interface DeviceBrowserSlice {
|
|
4169
|
+
/** `chrome` | `safari` | `edge` | `firefox` | `samsung_internet` | `in_app` | `other`. */
|
|
4170
|
+
family: string;
|
|
4171
|
+
sessions: number;
|
|
4172
|
+
paid: number;
|
|
4173
|
+
}
|
|
4174
|
+
/** One platform family's window totals. */
|
|
4175
|
+
interface DevicePlatformSlice {
|
|
4176
|
+
/** `android` | `ios` | `windows` | `macos` | `linux` | `other`. */
|
|
4177
|
+
os: string;
|
|
4178
|
+
sessions: number;
|
|
4179
|
+
paid: number;
|
|
4180
|
+
}
|
|
4181
|
+
/** One device class's window totals (`unknown` = rows predating classification). */
|
|
4182
|
+
interface DeviceClassSlice {
|
|
4183
|
+
/** `phone` | `tablet` | `desktop` | `unknown`. */
|
|
4184
|
+
class: string;
|
|
4185
|
+
sessions: number;
|
|
4186
|
+
}
|
|
4187
|
+
/**
|
|
4188
|
+
* One identifiable device model's window totals (top ~10 by sessions).
|
|
4189
|
+
* Sessions with no identifiable model are excluded and reported via
|
|
4190
|
+
* `unidentified_model_share`, never guessed.
|
|
4191
|
+
*/
|
|
4192
|
+
interface DeviceModelSlice {
|
|
4193
|
+
model: string;
|
|
4194
|
+
sessions: number;
|
|
4195
|
+
paid: number;
|
|
4196
|
+
}
|
|
4197
|
+
/** One series bucket of session counts per checkout channel. */
|
|
4198
|
+
interface DeviceChannelBucket {
|
|
4199
|
+
/** Bucket start: `YYYY-MM-DD` (day grain) or `YYYY-MM-DDTHH:00:00Z` (hour grain). */
|
|
4200
|
+
bucket: string;
|
|
4201
|
+
/** Hosted checkout page (top-level). */
|
|
4202
|
+
hosted: number;
|
|
4203
|
+
/** Hosted checkout embedded in the merchant's page. */
|
|
4204
|
+
embedded: number;
|
|
4205
|
+
/** API / server-initiated. */
|
|
4206
|
+
api: number;
|
|
4207
|
+
dashboard: number;
|
|
4208
|
+
sdk: number;
|
|
4209
|
+
/** Intents that declared no confirm source. */
|
|
4210
|
+
unknown: number;
|
|
4211
|
+
}
|
|
4212
|
+
/** One fixed histogram bucket of the time-to-pay distribution. */
|
|
4213
|
+
interface TimeToPayBucket {
|
|
4214
|
+
/** `lt_30s` | `s30_60s` | `m1_2` | `m2_5` | `m5_15` | `gt_15m`. */
|
|
4215
|
+
label: string;
|
|
4216
|
+
/** Share of measured paid sessions in this bucket. */
|
|
4217
|
+
share: number;
|
|
4218
|
+
}
|
|
4219
|
+
/**
|
|
4220
|
+
* Time from the first `checkout_open` observation to the first `succeeded`
|
|
4221
|
+
* status. Only payments with both endpoints count.
|
|
4222
|
+
*/
|
|
4223
|
+
interface TimeToPayStats {
|
|
4224
|
+
median_s?: number | null;
|
|
4225
|
+
p90_s?: number | null;
|
|
4226
|
+
buckets: TimeToPayBucket[];
|
|
4227
|
+
paid_with_timing: number;
|
|
4228
|
+
}
|
|
4229
|
+
/** A direct child of the current scope on the device dashboard's by-shop table. */
|
|
4230
|
+
interface DeviceAnalyticsChild {
|
|
4231
|
+
id: string;
|
|
4232
|
+
name: string;
|
|
4233
|
+
/** "merchant" | "project" | "shop". */
|
|
4234
|
+
type: string;
|
|
4235
|
+
sessions: number;
|
|
4236
|
+
conversion: number;
|
|
4237
|
+
/** Median time-to-pay in seconds; `null` when nothing measured. */
|
|
4238
|
+
median_ttp_s?: number | null;
|
|
4239
|
+
mobile_share: number;
|
|
4240
|
+
top_browser?: string | null;
|
|
4241
|
+
top_platform?: string | null;
|
|
4242
|
+
}
|
|
4243
|
+
/** Device-analytics response for one drill level. */
|
|
4244
|
+
interface DevicesAnalyticsResponse {
|
|
4245
|
+
/**
|
|
4246
|
+
* `false` when the purpose gate or device tracking is off — the caveats say
|
|
4247
|
+
* which — and every data block is empty.
|
|
4248
|
+
*/
|
|
4249
|
+
enabled: boolean;
|
|
4250
|
+
/** "root" | "merchant" | "project" | "shop". */
|
|
4251
|
+
level: string;
|
|
4252
|
+
days: number;
|
|
4253
|
+
end_date: string;
|
|
4254
|
+
/** `"day"` or `"hour"`, mirroring the request. */
|
|
4255
|
+
granularity: string;
|
|
4256
|
+
/** First bucket's UTC start when `granularity` is `"hour"`. */
|
|
4257
|
+
bucket_start?: string | null;
|
|
4258
|
+
totals: DeviceAnalyticsTotals;
|
|
4259
|
+
/** Per-bucket session/paid counts (the `series` section). */
|
|
4260
|
+
series: DeviceSessionBucket[];
|
|
4261
|
+
browsers: DeviceBrowserSlice[];
|
|
4262
|
+
platforms: DevicePlatformSlice[];
|
|
4263
|
+
device_classes: DeviceClassSlice[];
|
|
4264
|
+
device_models: DeviceModelSlice[];
|
|
4265
|
+
/** Share of sessions whose device model could not be identified. */
|
|
4266
|
+
unidentified_model_share: number;
|
|
4267
|
+
channel_series: DeviceChannelBucket[];
|
|
4268
|
+
time_to_pay: TimeToPayStats;
|
|
4269
|
+
children: DeviceAnalyticsChild[];
|
|
4270
|
+
caveats: ClientAnalyticsCaveat[];
|
|
4271
|
+
filters: ClientAnalyticsFilters;
|
|
4272
|
+
}
|
|
4273
|
+
/** Window totals for the geo dashboard's KPI row. */
|
|
4274
|
+
interface GeoAnalyticsTotals {
|
|
4275
|
+
/** Distinct countries observed in the selected mode. */
|
|
4276
|
+
countries: number;
|
|
4277
|
+
/**
|
|
4278
|
+
* Share of paid sessions from outside the shop's home country. `null` when
|
|
4279
|
+
* no shop in scope has a home country (`ShopHasNoHomeCountry`).
|
|
4280
|
+
*/
|
|
4281
|
+
cross_border_share?: number | null;
|
|
4282
|
+
/**
|
|
4283
|
+
* Share of paid sessions whose IP country and billing country disagree
|
|
4284
|
+
* (both present). `null` when no session carries both claims.
|
|
4285
|
+
*/
|
|
4286
|
+
mismatch_share?: number | null;
|
|
4287
|
+
/**
|
|
4288
|
+
* Successful volume (USD major units) from outside the shops' home
|
|
4289
|
+
* countries. `null` when no shop in scope has a home country.
|
|
4290
|
+
*/
|
|
4291
|
+
intl_volume_usd?: number | null;
|
|
4292
|
+
}
|
|
4293
|
+
/** One country's window totals in the selected mode. */
|
|
4294
|
+
interface GeoCountrySlice {
|
|
4295
|
+
/** ISO alpha-2. */
|
|
4296
|
+
country: string;
|
|
4297
|
+
sessions: number;
|
|
4298
|
+
paid: number;
|
|
4299
|
+
/** Successful volume, USD major units. */
|
|
4300
|
+
volume_usd: number;
|
|
4301
|
+
success_rate: number;
|
|
4302
|
+
}
|
|
4303
|
+
/**
|
|
4304
|
+
* One city bubble for the map (IP mode only). Always a server-side aggregate,
|
|
4305
|
+
* capped at the top ~200 cities — never per-transaction coordinates.
|
|
4306
|
+
*/
|
|
4307
|
+
interface GeoCitySlice {
|
|
4308
|
+
city: string;
|
|
4309
|
+
country: string;
|
|
4310
|
+
lat: number;
|
|
4311
|
+
lon: number;
|
|
4312
|
+
sessions: number;
|
|
4313
|
+
/** Paid sessions — the map's bubble size, per the approved design. */
|
|
4314
|
+
paid: number;
|
|
4315
|
+
}
|
|
4316
|
+
/** One buyer language's share (`accept_language` primary subtag). */
|
|
4317
|
+
interface GeoLanguageSlice {
|
|
4318
|
+
lang: string;
|
|
4319
|
+
share: number;
|
|
4320
|
+
}
|
|
4321
|
+
/** A direct child of the current scope on the geo dashboard's by-shop table. */
|
|
4322
|
+
interface GeoAnalyticsChild {
|
|
4323
|
+
id: string;
|
|
4324
|
+
name: string;
|
|
4325
|
+
/** "merchant" | "project" | "shop". */
|
|
4326
|
+
type: string;
|
|
4327
|
+
countries: number;
|
|
4328
|
+
top_country?: string | null;
|
|
4329
|
+
top_country_share: number;
|
|
4330
|
+
/** `null` when no shop under the child has a home country. */
|
|
4331
|
+
intl_share?: number | null;
|
|
4332
|
+
mismatch_share?: number | null;
|
|
4333
|
+
/** Successful volume, USD major units. */
|
|
4334
|
+
volume_usd: number;
|
|
4335
|
+
}
|
|
4336
|
+
/** Geo-analytics response for one drill level. */
|
|
4337
|
+
interface GeoAnalyticsResponse {
|
|
4338
|
+
/** `false` when the purpose gate or device tracking is off. */
|
|
4339
|
+
enabled: boolean;
|
|
4340
|
+
/** "root" | "merchant" | "project" | "shop". */
|
|
4341
|
+
level: string;
|
|
4342
|
+
/** `"ip"` or `"billing"`, mirroring the request. */
|
|
4343
|
+
mode: string;
|
|
4344
|
+
days: number;
|
|
4345
|
+
end_date: string;
|
|
4346
|
+
granularity: string;
|
|
4347
|
+
bucket_start?: string | null;
|
|
4348
|
+
totals: GeoAnalyticsTotals;
|
|
4349
|
+
countries: GeoCountrySlice[];
|
|
4350
|
+
/** IP mode only; empty in billing mode. */
|
|
4351
|
+
cities: GeoCitySlice[];
|
|
4352
|
+
/**
|
|
4353
|
+
* 7 rows (Mon..Sun) × 24 session counts on the buyer's own clock; all zeros
|
|
4354
|
+
* when no observation carries a time zone.
|
|
4355
|
+
*/
|
|
4356
|
+
local_hours: number[][];
|
|
4357
|
+
languages: GeoLanguageSlice[];
|
|
4358
|
+
children: GeoAnalyticsChild[];
|
|
4359
|
+
caveats: ClientAnalyticsCaveat[];
|
|
4360
|
+
filters: ClientAnalyticsFilters;
|
|
3912
4361
|
}
|
|
3913
4362
|
/** Payout progress of a settlement statement. */
|
|
3914
4363
|
type SettlementPayoutStatus = 'unpaid' | 'partial' | 'paid';
|
|
@@ -6018,6 +6467,8 @@ declare class Routing {
|
|
|
6018
6467
|
readonly surchargeRules: SurchargeRules;
|
|
6019
6468
|
/** Which stored appearance variant a buyer is shown. Decides a look, never a payment. */
|
|
6020
6469
|
readonly checkoutThemeRules: CheckoutThemeRules;
|
|
6470
|
+
/** Rendered-to-paid conversion per appearance variant and segment. */
|
|
6471
|
+
readonly checkoutThemeConversion: CheckoutThemeConversion;
|
|
6021
6472
|
constructor(request: RequestFn);
|
|
6022
6473
|
/**
|
|
6023
6474
|
* Create a new routing algorithm.
|
|
@@ -6289,6 +6740,56 @@ declare class CheckoutThemeRules {
|
|
|
6289
6740
|
*/
|
|
6290
6741
|
delete(profileId?: string): Promise<void>;
|
|
6291
6742
|
}
|
|
6743
|
+
/**
|
|
6744
|
+
* Rendered-to-paid conversion, per appearance variant and segment.
|
|
6745
|
+
*
|
|
6746
|
+
* Answers the one question theme targeting exists for: *does variant B convert
|
|
6747
|
+
* better than the house style, on phones, in Germany?*
|
|
6748
|
+
*
|
|
6749
|
+
* **What a rate here means.** The denominator is backend-observed checkout page
|
|
6750
|
+
* opens, deduplicated by device within the hosted checkout's cache window, with
|
|
6751
|
+
* automated traffic excluded from both sides. It is narrower than "paints", and
|
|
6752
|
+
* that is deliberate - counting one buyer's refresh as a second render would
|
|
6753
|
+
* understate conversion. The exact basis travels with every response in
|
|
6754
|
+
* `denominator`, and the ways it is not the whole truth travel in `caveats`.
|
|
6755
|
+
*
|
|
6756
|
+
* **The server decides what may be concluded, not you.** Rate, Wilson interval,
|
|
6757
|
+
* per-cell `verdict` and the variant-vs-default `separates` test are computed
|
|
6758
|
+
* once, server-side, and shipped as values. Do not recompute them: the first
|
|
6759
|
+
* client that rounds differently tells a merchant a difference is real when the
|
|
6760
|
+
* server says it is not.
|
|
6761
|
+
*/
|
|
6762
|
+
declare class CheckoutThemeConversion {
|
|
6763
|
+
private readonly request;
|
|
6764
|
+
constructor(request: RequestFn);
|
|
6765
|
+
/**
|
|
6766
|
+
* Rendered-to-paid conversion for a shop over a window.
|
|
6767
|
+
*
|
|
6768
|
+
* `GET /routing/checkout-theme/conversion`
|
|
6769
|
+
*
|
|
6770
|
+
* Requires `CheckoutBranding` read at profile scope - the same permission
|
|
6771
|
+
* that governs seeing how a checkout looks.
|
|
6772
|
+
*
|
|
6773
|
+
* @param params - Window (RFC3339, `start` inclusive / `end` exclusive), the
|
|
6774
|
+
* shop, and the dimension to group by.
|
|
6775
|
+
*
|
|
6776
|
+
* @example Which variant wins on which device, over the last 30 days.
|
|
6777
|
+
* ```typescript
|
|
6778
|
+
* const report = await delopay.routing.checkoutThemeConversion.retrieve({
|
|
6779
|
+
* profile_id: 'pro_...',
|
|
6780
|
+
* start: '2026-07-21T00:00:00Z',
|
|
6781
|
+
* end: '2026-08-20T00:00:00Z',
|
|
6782
|
+
* segment: 'device',
|
|
6783
|
+
* });
|
|
6784
|
+
*
|
|
6785
|
+
* for (const c of report.comparisons) {
|
|
6786
|
+
* if (!c.separates) continue; // "not shown to differ" - say nothing
|
|
6787
|
+
* console.log(`${c.variant} on ${c.segment}: ${c.higher} converts better`);
|
|
6788
|
+
* }
|
|
6789
|
+
* ```
|
|
6790
|
+
*/
|
|
6791
|
+
retrieve(params: CheckoutThemeConversionQuery): Promise<CheckoutThemeConversionResponse>;
|
|
6792
|
+
}
|
|
6292
6793
|
|
|
6293
6794
|
/** Index discriminator returned for each search result group. */
|
|
6294
6795
|
type SearchIndex = 'payment_attempts' | 'payment_intents' | 'refunds' | 'disputes' | 'payouts' | 'sessionizer_payment_attempts' | 'sessionizer_payment_intents' | 'sessionizer_refunds' | 'sessionizer_disputes' | 'routing_rules' | 'webhook_events' | 'audit_logs' | 'subscriptions';
|
|
@@ -6805,6 +7306,25 @@ declare class Analytics {
|
|
|
6805
7306
|
* processor mix and direct children. `GET /analytics/scope`
|
|
6806
7307
|
*/
|
|
6807
7308
|
scope(params?: AnalyticsScopeRequest): Promise<AnalyticsScopeResponse>;
|
|
7309
|
+
/**
|
|
7310
|
+
* Device analytics over the canonical client-context observation per
|
|
7311
|
+
* payment (browser/platform families, device classes and models, checkout
|
|
7312
|
+
* channel mix, time-to-pay), pinned server-side to your own merchant and
|
|
7313
|
+
* drillable via `project_id` / `shop_id` exactly like `scope`. Gated on the
|
|
7314
|
+
* client-context optimisation-use switch: when it is off the server answers
|
|
7315
|
+
* 200 with `enabled: false` and a caveat naming the switch.
|
|
7316
|
+
* `GET /analytics/devices`
|
|
7317
|
+
*/
|
|
7318
|
+
devices(params?: ClientAnalyticsRequest): Promise<DevicesAnalyticsResponse>;
|
|
7319
|
+
/**
|
|
7320
|
+
* Geo analytics over the canonical client-context observation per payment:
|
|
7321
|
+
* country totals, city bubbles (IP mode), buyer languages, buyer-local
|
|
7322
|
+
* purchase hours and the IP-vs-billing mismatch share. `mode` selects the
|
|
7323
|
+
* location claim (`ip` default, `billing`); the two are never coalesced.
|
|
7324
|
+
* Same drill, window and gating contract as `devices`.
|
|
7325
|
+
* `GET /analytics/geo`
|
|
7326
|
+
*/
|
|
7327
|
+
geo(params?: ClientAnalyticsRequest): Promise<GeoAnalyticsResponse>;
|
|
6808
7328
|
/** Global search. `POST /analytics/search` */
|
|
6809
7329
|
search(params: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
6810
7330
|
/** Domain-specific search. `POST /analytics/search/{domain}` */
|
|
@@ -8388,4 +8908,4 @@ declare function focusedCheckoutUrl(params: FocusedCheckoutUrlParams): string;
|
|
|
8388
8908
|
declare const CHECKOUT_EVENT_KINDS: readonly ["native_pane_selected", "native_pane_tab_opened", "native_pane_tab_blocked", "native_pane_abandoned", "native_pane_returned"];
|
|
8389
8909
|
type CheckoutEventKind = (typeof CHECKOUT_EVENT_KINDS)[number];
|
|
8390
8910
|
|
|
8391
|
-
export { ALL_CUSTOM_FIELD_CONDITION_SOURCES, ALL_CUSTOM_FIELD_OPERATORS, ALL_CUSTOM_FIELD_TYPES, type AddUserRequest, type AddUserResponse, type Address, type AddressDetails, type AllocationListResponse, type AllocationResponse, type AllocationTransferRequest, type AllocationTransferResponse, type AmountFilter, type AmountRange, Analytics, type AnalyticsChild, type AnalyticsConnectorDay, type AnalyticsConnectorSeries, AnalyticsDashboard, type AnalyticsDayBucket, type AnalyticsMethodSlice, type AnalyticsScopeRequest, type AnalyticsScopeResponse, type ApiKeyCreateRequest, type ApiKeyCreateResponse, type ApiKeyExpiration, type ApiKeyListConstraints, type ApiKeyResponse, type ApiKeyRevokeResponse, type ApiKeyUpdateRequest, type ApplePayVerificationRequest, type ApplePayVerificationResponse, type ApplePayVerifiedDomainsResponse, type AttemptStatus, type AuthResponse, type AuthenticationCreateRequest, type AuthenticationResponse, type AuthenticationStatus, type AuthenticationType, type AutoRechargeConfig, type AutoRechargeUpdateRequest, type AvailabilityOverrideCreateRequest, type AvailabilityOverrideResponse, AvailabilityOverrides, type AvailabilityPreviewMethod, type AvailabilityPreviewParams, type AvailabilityPreviewResponse, BRANDING_EXPORT_FORMAT, BRANDING_EXPORT_VERSION, type BankCodeResponse, type BankDebitTypes, type BankTransferTypes, type BillingCompleteSetupRequest, type BillingProfileResponse, type BillingSetupRequest, type BillingSetupResponse, type BlockedAttempt, type BlockedAttemptListParams, type BlockedAttemptListResponse, type BlocklistAddRequest, type BlocklistDataKind, type BlocklistResponse, type BrandingExport, type BrandingSource, type BuiltInRegionGroupResponse, type BusinessPaymentLinkConfig, CHECKBOX_CHECKED, CHECKBOX_UNCHECKED, CHECKOUT_EVENT_KINDS, CUSTOM_CSS_MAX_LENGTH, CUSTOM_FIELDS_MAX, CUSTOM_FIELD_CONDITIONS_MAX, CUSTOM_FIELD_KEY_PATTERN, CUSTOM_FIELD_OPERATORS_BY_SOURCE, CUSTOM_FIELD_VALUELESS_OPERATORS, type CancelSubscriptionRequest, type CancelSubscriptionResponse, type CaptureMethod, type CardDetail, type CardDetailFromLocker, type CardNetworkTypes, Cards, type ChangePasswordRequest, type CheckoutBranding, type CheckoutBrandingUpdate, type CheckoutCustomField, type CheckoutEventKind, CheckoutSession, type CheckoutSessionOptions, type CheckoutThemeDimension, type CheckoutThemeOutput, type CheckoutThemeProgram, type CheckoutThemeProgramRequest, type CheckoutThemeProgramResponse, type CheckoutThemeRule, type ConditionNode, type ConfirmSubscriptionPaymentDetails, type ConfirmSubscriptionRequest, type ConfirmSubscriptionResponse, type Connector, type ConnectorCloneRequest, type ConnectorCreateRequest, type ConnectorListResponse, type ConnectorOwnership, type ConnectorResponse, type ConnectorSelection, type ConnectorType, type ConnectorUpdateRequest, type ConnectorVolumeSplit, type ConnectorWebhookEntry, type ConnectorWebhookEventType, type ConnectorWebhookListResponse, type ConnectorWebhookRegisterRequest, type ConnectorWebhookRegisterResponse, type ConnectorWebhookSyncResponse, type ConnectorWebhookSyncResult, type CornerRadius, type CreateAndConfirmSubscriptionRequest, type CreateSubscriptionPaymentDetails, type CreateSubscriptionRequest, type Currency, type CurrencyRevenue, type CustomFieldCondition, type CustomFieldConditionSource, type CustomFieldContext, type CustomFieldOperator, type CustomFieldOption, type CustomFieldTranslations, type CustomFieldType, type CustomFieldVisibility, type CustomerCreateRequest, type CustomerListParams, type CustomerPaymentMethodsListParams, type CustomerPaymentMethodsListResponse, type CustomerResponse, type CustomerUpdateRequest, DEFAULT_BADGES, DEFAULT_BADGES_DARK, DEFAULT_BRANDING, DEFAULT_BRANDING_DARK, type DeleteAccountRequest, type DeleteUserRoleRequest, Delopay, DelopayAuthenticationError, DelopayError, type DelopayLogger, type DelopayOptions, type DisputeEvidenceBlock, type DisputeEvidenceRequest, type DisputeEvidenceType, type DisputeListParams, type DisputeResponse, type DisputeStage, type DisputeStatus, type EncodedBranding, type EpayoutsCatalogEntry, type EpayoutsCatalogResponse, type EpayoutsLocality, type EpayoutsMethod, type EpayoutsMethodsResponse, type EpayoutsRail, type EphemeralKeyCreateRequest, type EphemeralKeyCreateResponse, type EuclidComparison, type EuclidComparisonType, type EuclidIfStatement, type EuclidValue, type EventClass, type EventDeliveryAttemptResponse, type EventDetailResponse, type EventListParams, type EventListResponse, type EventResponse, type EventType, Export, FeatureMatrix, type FeeOwner, FeeProgramBuilder, type FeeRuleConditions, type FeeRuleDefaultPrecedence, type FeeRuleInput, type FeeRulePreviewRequest, type FeeRulePreviewResponse, type FeeScheduleCreateRequest, type FeeScheduleResponse, type FeeScheduleUpdateRequest, type FeeSpecInput, type FeeStatementDetail, type FeeStatementSummary, type FeeType, Files, type FocusedCheckoutUrlParams, type FontFamily, type FontWeight, Forex, type ForgotPasswordRequest, type FromEmailRequest, type FutureUsage, type GatewayConnectRequest, type GatewayResponse, type GetSubscriptionItemsParams, type GetSubscriptionItemsResponse, type GlobalSearchRequest, type GroupNode, type ImpersonateEmployeeRequest, type IntentStatus, type InviteUsersRequest, type InviteUsersResponse, type InvoiceStatus, type LabelStyle, type LayoutStyle, type LeafNode, type LedgerEntry, type LedgerListParams, type LedgerResponse, type LimitedOperation, type LinkedRoutingConfigRetrieveResponse, type ListInvitableRolesParams, type ListUsersInLineageParams, type LoginHistoryEntry, type LoginHistoryParams, type LoginHistoryResponse, type LogoShape, type LogoSize, type MandateListParams, type MandateResponse, type MandateRevokedResponse, type MandateStatus, type MandateType, type MerchantAccountCreateRequest, type MerchantAccountResponse, type MerchantAccountType, type MerchantAccountUpdateRequest, type MerchantOverviewResponse, type MerchantOverviewStat, type MerchantRoutingAlgorithm, type MethodSurcharge, type MinimalRoleInfo, NATIVE_PANES_MAX, NATIVE_PANE_CATEGORY_KEYS, NATIVE_PANE_ICON_KEYS, type NativePaneMethodInfo, type NativePaneOpenTarget, type NativePaneRail, type NativePaneView, type NativePaneVisibility, type NonPillRadius, type OperationLimitOnExceeded, type OperationLimitRule, type OperationLimitRuleDeleteResponse, type OperationLimitRuleListParams, type OperationLimitScope, type OperationLimitSettings, type OperationLimitWindowMode, OperationLimits, type OverrideAction, type OverrideScope, type ParentGroup, type ParentGroupInfo, type PauseSubscriptionRequest, type PauseSubscriptionResponse, type PaymentAttemptResponse, type PaymentAttemptsListResponse, type PaymentCancelRequest, type PaymentCaptureRequest, type PaymentClientContextEntry, type PaymentClientContextListResponse, type PaymentConfirmRequest, type PaymentCreateRequest, type PaymentErrorDetails, type PaymentExperience, type PaymentExperienceTypes, type PaymentIdFormatConfig, type PaymentIdStyle, type PaymentIntentStateMetadata, type PaymentLayout, type PaymentLinkBackgroundImageConfig, type PaymentLinkConfigRequest, type PaymentLinkListParams, type PaymentLinkListResponse, type PaymentLinkResponse, type PaymentLinkTransactionDetails, type PaymentListFilterConstraints, type PaymentListFilteredResponse, type PaymentListOrder, type PaymentListParams, type PaymentListResponse, type PaymentMethod, type PaymentMethodAmountLimits, type PaymentMethodCreateRequest, type PaymentMethodDeleteResponse, type PaymentMethodDisplayInfo, type PaymentMethodListInstallmentAmountDetails, type PaymentMethodListInstallmentOption, type PaymentMethodListInstallmentPlan, type PaymentMethodListIntentData, type PaymentMethodListParams, type PaymentMethodListResponse, type PaymentMethodResponse, type PaymentMethodType, type PaymentMethodUpdateRequest, type PaymentResponse, type PaymentRetrieveOptions, type PaymentStatusHistoryEntityType, type PaymentStatusHistoryEvent, type PaymentStatusHistoryResponse, type PaymentUpdateRequest, type PaymentsDeletePolicyResponse, type PaymentsDeleteResponse, type PayoutCreateRequest, type PayoutListParams, type PayoutListResponse, type PayoutResponse, type PayoutStatus, type PayoutType, type PayoutUpdateRequest, type PayseproMethod, type PayseproMethodsResponse, type PerMethodSurchargeItem, type PermissionScope, type PhoneDetails, type PhoneOtpRequest, type PhoneOtpResponse, type PhoneOtpVerifyRequest, type PhoneOtpVerifyResponse, type PlatformFeeKind, type PlatformFeeOutput, type PlatformFeeProgram, type PlatformFeeRule, type PlatformFeeRuleInput, type PlatformFeeRuleOutput, type PlatformFeeRuleRecord, type PlatformFeeRuleRequest, type PollStatus, type PollStatusResponse, type ProcessorCostSource, type ProfileAcquirerCreateRequest, type ProfileAcquirerResponse, type ProfileAcquirerUpdateRequest, type ProfileCreateRequest, type ProfileDefaultRoutingConfig, type ProfileDeniedConnectorsResponse, type ProfileLogoUploadResponse, type ProfileResponse, type ProfileUpdateRequest, type ProgramConnectorSelection, type ProjectCreateRequest, type ProjectResponse, type ProjectStats, type ProjectStatsResponse, type ProjectUpdateRequest, type PublishableKey, type RecordCheckoutEventRequest, type RecordCheckoutEventResponse, type RecoveryCodesResponse, type RefundAggregateResponse, type RefundCreateRequest, type RefundListParams, type RefundListResponse, type RefundResponse, type RefundStatus, type RefundType, type RefundUpdateRequest, type RegionCountriesResponse, type RegionCreateRequest, type RegionResponse, type RegionSetCountriesRequest, type RegionUpdateRequest, Regions, type RelayRequest, type RelayResponse, type RelayStatus, type RelayType, type RequestExtras, type RequestFn, type RequestOptions, type RequiredFieldInfo, type ResetPasswordRequest, type ResponsePaymentMethodTypes, type ResponsePaymentMethodsEnabled, type ResumeSubscriptionRequest, type ResumeSubscriptionResponse, type RoutableConnectorChoice, type RoutingActivatePayload, type RoutingConfigCreateRequest, type RoutingConfigResponse, type RoutingDeactivateRequest, type RoutingDictionary, type RoutingDictionaryRecord, type RuleConnectorSelection, STRIPE_NATIVE_PANE_METHODS, Search, type SearchGroupResponse, type SearchIndex, type SearchStatus, Settlement, type SettlementBackfillRequest, type SettlementBackfillResponse, type SettlementBucket, type SettlementCurrentParams, type SettlementCurrentResponse, type SettlementLine, type SettlementLineBase, type SettlementLineListParams, type SettlementLineListResponse, type SettlementLineWithProcessorCost, type SettlementLineWithoutProcessorCost, type SettlementOverviewParams, type SettlementOverviewResponse, type SettlementPayoutStatus, type SettlementStatementListParams, type SettlementStatementListResponse, type ShopCreateRequest, type ShopFeeConfigEntry, type ShopFeeConfigParams, type ShopFeeConfigResponse, type ShopResponse, type ShopSettlementOverview, type ShopStats, type ShopStatsResponse, type ShopUpdateRequest, type ShopVisibilityResponse, type ShopVisibilityUpdateRequest, type SignInRequest, type SignUpRequest, type SignUpWithMerchantIdRequest, type SignUpWithMerchantRequest, type SizeScale, type SpacingScale, type StatementAdjustment, type StatementAdjustmentCreateRequest, type StatementAdjustmentListResponse, type StatementGenerateRequest, type StatementPayoutUpdateRequest, type StatementPdfParams, type StaticRoutingAlgorithm, type StatsPeriod, type StripeConnectAccountRequest, type StripeConnectAccountResponse, type StripeConnectLinkRequest, type StripeConnectLinkResponse, type StripeNativePane, type StripePaymentMethodDomainResult, type StripePaymentMethodDomainStatus, type StripePaymentMethodDomainsRegisterRequest, type StripePaymentMethodDomainsRegisterResponse, type SubscriptionEstimateParams, type SubscriptionEstimateResponse, type SubscriptionInvoice, type SubscriptionItem, type SubscriptionItemPrice, type SubscriptionItemType, type SubscriptionLineItem, type SubscriptionListParams, type SubscriptionPaymentData, type SubscriptionPaymentDetails, type SubscriptionPaymentLink, type SubscriptionPaymentLookupRequest, type SubscriptionPaymentLookupResponse, type SubscriptionPeriodUnit, type SubscriptionResponse, type SubscriptionStatus, Subscriptions, type SummaryPosition, type SurchargeDetailsResponse, type SurchargeResponse, type SurchargeRuleRequest, type SurchargeRuleResponse, type SurfaceStyle, type SwitchMerchantRequest, type SwitchProfileRequest, type Terminate2faQueryParams, type ThemeBrowserLanguage, type ThemeCheckoutChannel, type ThemeChoice, type ThemeCondition, type ThemeDeviceClass, type ThemeEnumCondition, type ThemeIfStatement, type ThemeMetadataCondition, type ThemeNumberCondition, type ThemeTrafficSource, type ThreeDSDecision, type ThreeDsRuleExecuteRequest, type ThreeDsRuleResponse, type TierSummary, type TokenPurpose, type TokenResponse, type TopupRequest, type TopupResponse, type TotpResponse, type TransactionType, type TrustBadge, type UpdateMetadataRequest, type UpdateOperationLimitSettingsRequest, type UpdateSubscriptionRequest, type UpdateUserDetailsRequest, type UpdateUserRoleRequest, type UpsertOperationLimitRuleRequest, type UserInLineage, type UserResponse, type UserSessionEntry, type UserSessionListResponse, type UserSessionRevokeResponse, type VaultCheck, type VaultCheckId, type VaultCheckStatus, type VaultCollectSessionResponse, type VaultEnvironment, type VaultPaymentMethodRequest, type VaultPaymentMethodResponse, type VaultRouteApplyVerification, type VaultRouteChange, type VaultRouteChangeKind, type VaultRouteFieldChange, type VaultRouteIds, type VaultRoutePurpose, type VaultRouteWarning, type VaultRouteWarningCode, type VaultRoutesApplyRequest, type VaultRoutesApplyResponse, type VaultRoutesFingerprint, type VaultRoutesPreviewRequest, type VaultRoutesPreviewResponse, type VaultVerificationResponse, type VaultVerifyRequest, type VerifyTotpRequest, type WebhookDeliveryAttempt, type WebhookDeliveryTerminalReason, type WebhookDetails, type WebhookEvent, type WebhookRefundStatus, type WebhookRegistrationEnvironment, Webhooks, allOf, anyOf, applyBrandingVariables, buildBrandingExport, buttonPadValue, cloneBranding, cloneCustomField, cloneNativePane, customFieldContextFromMetadata, customFieldIsTextLike, customFieldOperatorTakesValue, customFieldOptionLabel, customFieldText, decodeBadges, decodeBranding, decodeCustomFields, decodeNativePanes, defaultBranding, defaultCustomFieldVisibility, defaultNativePane, defaultOperatorForSource, encodeBadges, encodeBranding, encodeCustomFields, encodeNativePanes, evaluateCustomFieldCondition, evaluateCustomFieldVisibility, feeProgram, focusedCheckoutUrl, fontStack, fontWeightValue, inputPadValue, isCheckboxChecked, isDarkSurface, isHexColor, leaf, logoDimensions, nativePaneMethodInfo, parseCustomFieldsLoose, parseImportedBranding, programToTree, radiusValue, ruleMatchToTree, sanitizeCustomCss, shadowFor, surfacePadValue, verticalGapValue, visibleCustomFields };
|
|
8911
|
+
export { ALL_CUSTOM_FIELD_CONDITION_SOURCES, ALL_CUSTOM_FIELD_OPERATORS, ALL_CUSTOM_FIELD_TYPES, type AddUserRequest, type AddUserResponse, type Address, type AddressDetails, type AllocationListResponse, type AllocationResponse, type AllocationTransferRequest, type AllocationTransferResponse, type AmountFilter, type AmountRange, Analytics, type AnalyticsChild, type AnalyticsConnectorDay, type AnalyticsConnectorSeries, AnalyticsDashboard, type AnalyticsDayBucket, type AnalyticsMethodSlice, type AnalyticsScopeRequest, type AnalyticsScopeResponse, type ApiKeyCreateRequest, type ApiKeyCreateResponse, type ApiKeyExpiration, type ApiKeyListConstraints, type ApiKeyResponse, type ApiKeyRevokeResponse, type ApiKeyUpdateRequest, type ApplePayVerificationRequest, type ApplePayVerificationResponse, type ApplePayVerifiedDomainsResponse, type AttemptStatus, type AuthResponse, type AuthenticationCreateRequest, type AuthenticationResponse, type AuthenticationStatus, type AuthenticationType, type AutoRechargeConfig, type AutoRechargeUpdateRequest, type AvailabilityOverrideCreateRequest, type AvailabilityOverrideResponse, AvailabilityOverrides, type AvailabilityPreviewMethod, type AvailabilityPreviewParams, type AvailabilityPreviewResponse, BRANDING_EXPORT_FORMAT, BRANDING_EXPORT_VERSION, type BankCodeResponse, type BankDebitTypes, type BankTransferTypes, type BillingCompleteSetupRequest, type BillingProfileResponse, type BillingSetupRequest, type BillingSetupResponse, type BlockedAttempt, type BlockedAttemptListParams, type BlockedAttemptListResponse, type BlocklistAddRequest, type BlocklistDataKind, type BlocklistResponse, type BrandingExport, type BrandingSource, type BuiltInRegionGroupResponse, type BusinessPaymentLinkConfig, CHECKBOX_CHECKED, CHECKBOX_UNCHECKED, CHECKOUT_EVENT_KINDS, CUSTOM_CSS_MAX_LENGTH, CUSTOM_FIELDS_MAX, CUSTOM_FIELD_CONDITIONS_MAX, CUSTOM_FIELD_KEY_PATTERN, CUSTOM_FIELD_OPERATORS_BY_SOURCE, CUSTOM_FIELD_VALUELESS_OPERATORS, type CancelSubscriptionRequest, type CancelSubscriptionResponse, type CaptureMethod, type CardDetail, type CardDetailFromLocker, type CardNetworkTypes, Cards, type ChangePasswordRequest, type CheckoutBranding, type CheckoutBrandingUpdate, type CheckoutCustomField, type CheckoutEventKind, CheckoutSession, type CheckoutSessionOptions, type CheckoutThemeComparisonSide, type CheckoutThemeConversionCaveat, type CheckoutThemeConversionCell, type CheckoutThemeConversionComparison, type CheckoutThemeConversionQuery, type CheckoutThemeConversionResponse, type CheckoutThemeConversionSegment, type CheckoutThemeDenominatorBasis, type CheckoutThemeDimension, type CheckoutThemeOutput, type CheckoutThemeProgram, type CheckoutThemeProgramRequest, type CheckoutThemeProgramResponse, type CheckoutThemeRule, type CheckoutThemeSampleVerdict, type ClientAnalyticsCaveat, type ClientAnalyticsFilters, type ClientAnalyticsRequest, type ConditionNode, type ConfirmSubscriptionPaymentDetails, type ConfirmSubscriptionRequest, type ConfirmSubscriptionResponse, type Connector, type ConnectorCloneRequest, type ConnectorCreateRequest, type ConnectorListResponse, type ConnectorOwnership, type ConnectorResponse, type ConnectorSelection, type ConnectorType, type ConnectorUpdateRequest, type ConnectorVolumeSplit, type ConnectorWebhookEntry, type ConnectorWebhookEventType, type ConnectorWebhookListResponse, type ConnectorWebhookRegisterRequest, type ConnectorWebhookRegisterResponse, type ConnectorWebhookSyncResponse, type ConnectorWebhookSyncResult, type CornerRadius, type CreateAndConfirmSubscriptionRequest, type CreateSubscriptionPaymentDetails, type CreateSubscriptionRequest, type Currency, type CurrencyRevenue, type CustomFieldCondition, type CustomFieldConditionSource, type CustomFieldContext, type CustomFieldOperator, type CustomFieldOption, type CustomFieldTranslations, type CustomFieldType, type CustomFieldVisibility, type CustomerCreateRequest, type CustomerListParams, type CustomerPaymentMethodsListParams, type CustomerPaymentMethodsListResponse, type CustomerResponse, type CustomerUpdateRequest, DEFAULT_BADGES, DEFAULT_BADGES_DARK, DEFAULT_BRANDING, DEFAULT_BRANDING_DARK, type DeleteAccountRequest, type DeleteUserRoleRequest, Delopay, DelopayAuthenticationError, DelopayError, type DelopayLogger, type DelopayOptions, type DeviceAnalyticsChild, type DeviceAnalyticsTotals, type DeviceBrowserSlice, type DeviceChannelBucket, type DeviceClassSlice, type DeviceModelSlice, type DevicePlatformSlice, type DeviceSessionBucket, type DevicesAnalyticsResponse, type DisputeEvidenceBlock, type DisputeEvidenceRequest, type DisputeEvidenceType, type DisputeListParams, type DisputeResponse, type DisputeStage, type DisputeStatus, type EncodedBranding, type EpayoutsCatalogEntry, type EpayoutsCatalogResponse, type EpayoutsLocality, type EpayoutsMethod, type EpayoutsMethodsResponse, type EpayoutsRail, type EphemeralKeyCreateRequest, type EphemeralKeyCreateResponse, type EuclidComparison, type EuclidComparisonType, type EuclidIfStatement, type EuclidValue, type EventClass, type EventDeliveryAttemptResponse, type EventDetailResponse, type EventListParams, type EventListResponse, type EventResponse, type EventType, Export, FeatureMatrix, type FeeOwner, FeeProgramBuilder, type FeeRuleConditions, type FeeRuleDefaultPrecedence, type FeeRuleInput, type FeeRulePreviewRequest, type FeeRulePreviewResponse, type FeeScheduleCreateRequest, type FeeScheduleResponse, type FeeScheduleUpdateRequest, type FeeSpecInput, type FeeStatementDetail, type FeeStatementSummary, type FeeType, Files, type FocusedCheckoutUrlParams, type FontFamily, type FontWeight, Forex, type ForgotPasswordRequest, type FromEmailRequest, type FutureUsage, type GatewayConnectRequest, type GatewayResponse, type GeoAnalyticsChild, type GeoAnalyticsResponse, type GeoAnalyticsTotals, type GeoCitySlice, type GeoCountrySlice, type GeoLanguageSlice, type GetSubscriptionItemsParams, type GetSubscriptionItemsResponse, type GlobalSearchRequest, type GroupNode, type ImpersonateEmployeeRequest, type IntentStatus, type InviteUsersRequest, type InviteUsersResponse, type InvoiceStatus, type LabelStyle, type LayoutStyle, type LeafNode, type LedgerEntry, type LedgerListParams, type LedgerResponse, type LimitedOperation, type LinkedRoutingConfigRetrieveResponse, type ListInvitableRolesParams, type ListUsersInLineageParams, type LoginHistoryEntry, type LoginHistoryParams, type LoginHistoryResponse, type LogoShape, type LogoSize, type MandateListParams, type MandateResponse, type MandateRevokedResponse, type MandateStatus, type MandateType, type MerchantAccountCreateRequest, type MerchantAccountResponse, type MerchantAccountType, type MerchantAccountUpdateRequest, type MerchantOverviewResponse, type MerchantOverviewStat, type MerchantRoutingAlgorithm, type MethodSurcharge, type MinimalRoleInfo, NATIVE_PANES_MAX, NATIVE_PANE_CATEGORY_KEYS, NATIVE_PANE_ICON_KEYS, type NativePaneMethodInfo, type NativePaneOpenTarget, type NativePaneRail, type NativePaneView, type NativePaneVisibility, type NonPillRadius, type OperationLimitOnExceeded, type OperationLimitRule, type OperationLimitRuleDeleteResponse, type OperationLimitRuleListParams, type OperationLimitScope, type OperationLimitSettings, type OperationLimitWindowMode, OperationLimits, type OverrideAction, type OverrideScope, type ParentGroup, type ParentGroupInfo, type PauseSubscriptionRequest, type PauseSubscriptionResponse, type PaymentAttemptResponse, type PaymentAttemptsListResponse, type PaymentCancelRequest, type PaymentCaptureRequest, type PaymentClientContextEntry, type PaymentClientContextListResponse, type PaymentConfirmRequest, type PaymentCreateRequest, type PaymentErrorDetails, type PaymentExperience, type PaymentExperienceTypes, type PaymentIdFormatConfig, type PaymentIdStyle, type PaymentIntentStateMetadata, type PaymentLayout, type PaymentLinkBackgroundImageConfig, type PaymentLinkConfigRequest, type PaymentLinkListParams, type PaymentLinkListResponse, type PaymentLinkResponse, type PaymentLinkTransactionDetails, type PaymentListFilterConstraints, type PaymentListFilteredResponse, type PaymentListOrder, type PaymentListParams, type PaymentListResponse, type PaymentMethod, type PaymentMethodAmountLimits, type PaymentMethodCreateRequest, type PaymentMethodDeleteResponse, type PaymentMethodDisplayInfo, type PaymentMethodListInstallmentAmountDetails, type PaymentMethodListInstallmentOption, type PaymentMethodListInstallmentPlan, type PaymentMethodListIntentData, type PaymentMethodListParams, type PaymentMethodListResponse, type PaymentMethodResponse, type PaymentMethodType, type PaymentMethodUpdateRequest, type PaymentResponse, type PaymentRetrieveOptions, type PaymentStatusHistoryEntityType, type PaymentStatusHistoryEvent, type PaymentStatusHistoryResponse, type PaymentUpdateRequest, type PaymentsDeletePolicyResponse, type PaymentsDeleteResponse, type PayoutCreateRequest, type PayoutListParams, type PayoutListResponse, type PayoutResponse, type PayoutStatus, type PayoutType, type PayoutUpdateRequest, type PayseproMethod, type PayseproMethodsResponse, type PerMethodSurchargeItem, type PermissionScope, type PhoneDetails, type PhoneOtpRequest, type PhoneOtpResponse, type PhoneOtpVerifyRequest, type PhoneOtpVerifyResponse, type PlatformFeeKind, type PlatformFeeOutput, type PlatformFeeProgram, type PlatformFeeRule, type PlatformFeeRuleInput, type PlatformFeeRuleOutput, type PlatformFeeRuleRecord, type PlatformFeeRuleRequest, type PollStatus, type PollStatusResponse, type ProcessorCostSource, type ProfileAcquirerCreateRequest, type ProfileAcquirerResponse, type ProfileAcquirerUpdateRequest, type ProfileCreateRequest, type ProfileDefaultRoutingConfig, type ProfileDeniedConnectorsResponse, type ProfileLogoUploadResponse, type ProfileResponse, type ProfileUpdateRequest, type ProgramConnectorSelection, type ProjectCreateRequest, type ProjectResponse, type ProjectStats, type ProjectStatsResponse, type ProjectUpdateRequest, type PublishableKey, type RecordCheckoutEventRequest, type RecordCheckoutEventResponse, type RecoveryCodesResponse, type RefundAggregateResponse, type RefundCreateRequest, type RefundListParams, type RefundListResponse, type RefundResponse, type RefundStatus, type RefundType, type RefundUpdateRequest, type RegionCountriesResponse, type RegionCreateRequest, type RegionResponse, type RegionSetCountriesRequest, type RegionUpdateRequest, Regions, type RelayRequest, type RelayResponse, type RelayStatus, type RelayType, type RequestExtras, type RequestFn, type RequestOptions, type RequiredFieldInfo, type ResetPasswordRequest, type ResponsePaymentMethodTypes, type ResponsePaymentMethodsEnabled, type ResumeSubscriptionRequest, type ResumeSubscriptionResponse, type RoutableConnectorChoice, type RoutingActivatePayload, type RoutingConfigCreateRequest, type RoutingConfigResponse, type RoutingDeactivateRequest, type RoutingDictionary, type RoutingDictionaryRecord, type RuleConnectorSelection, STRIPE_NATIVE_PANE_METHODS, Search, type SearchGroupResponse, type SearchIndex, type SearchStatus, Settlement, type SettlementBackfillRequest, type SettlementBackfillResponse, type SettlementBucket, type SettlementCurrentParams, type SettlementCurrentResponse, type SettlementLine, type SettlementLineBase, type SettlementLineListParams, type SettlementLineListResponse, type SettlementLineWithProcessorCost, type SettlementLineWithoutProcessorCost, type SettlementOverviewParams, type SettlementOverviewResponse, type SettlementPayoutStatus, type SettlementStatementListParams, type SettlementStatementListResponse, type ShopCreateRequest, type ShopFeeConfigEntry, type ShopFeeConfigParams, type ShopFeeConfigResponse, type ShopResponse, type ShopSettlementOverview, type ShopStats, type ShopStatsResponse, type ShopUpdateRequest, type ShopVisibilityResponse, type ShopVisibilityUpdateRequest, type SignInRequest, type SignUpRequest, type SignUpWithMerchantIdRequest, type SignUpWithMerchantRequest, type SizeScale, type SpacingScale, type StatementAdjustment, type StatementAdjustmentCreateRequest, type StatementAdjustmentListResponse, type StatementGenerateRequest, type StatementPayoutUpdateRequest, type StatementPdfParams, type StaticRoutingAlgorithm, type StatsPeriod, type StripeConnectAccountRequest, type StripeConnectAccountResponse, type StripeConnectLinkRequest, type StripeConnectLinkResponse, type StripeNativePane, type StripePaymentMethodDomainResult, type StripePaymentMethodDomainStatus, type StripePaymentMethodDomainsRegisterRequest, type StripePaymentMethodDomainsRegisterResponse, type SubscriptionEstimateParams, type SubscriptionEstimateResponse, type SubscriptionInvoice, type SubscriptionItem, type SubscriptionItemPrice, type SubscriptionItemType, type SubscriptionLineItem, type SubscriptionListParams, type SubscriptionPaymentData, type SubscriptionPaymentDetails, type SubscriptionPaymentLink, type SubscriptionPaymentLookupRequest, type SubscriptionPaymentLookupResponse, type SubscriptionPeriodUnit, type SubscriptionResponse, type SubscriptionStatus, Subscriptions, type SummaryPosition, type SurchargeDetailsResponse, type SurchargeResponse, type SurchargeRuleRequest, type SurchargeRuleResponse, type SurfaceStyle, type SwitchMerchantRequest, type SwitchProfileRequest, type Terminate2faQueryParams, type ThemeBrowserLanguage, type ThemeCheckoutChannel, type ThemeChoice, type ThemeCondition, type ThemeDeviceClass, type ThemeEnumCondition, type ThemeIfStatement, type ThemeMetadataCondition, type ThemeNumberCondition, type ThemeTrafficSource, type ThreeDSDecision, type ThreeDsRuleExecuteRequest, type ThreeDsRuleResponse, type TierSummary, type TimeToPayBucket, type TimeToPayStats, type TokenPurpose, type TokenResponse, type TopupRequest, type TopupResponse, type TotpResponse, type TransactionType, type TrustBadge, type UpdateMetadataRequest, type UpdateOperationLimitSettingsRequest, type UpdateSubscriptionRequest, type UpdateUserDetailsRequest, type UpdateUserRoleRequest, type UpsertOperationLimitRuleRequest, type UserInLineage, type UserResponse, type UserSessionEntry, type UserSessionListResponse, type UserSessionRevokeResponse, type VaultCheck, type VaultCheckId, type VaultCheckStatus, type VaultCollectSessionResponse, type VaultEnvironment, type VaultPaymentMethodRequest, type VaultPaymentMethodResponse, type VaultRouteApplyVerification, type VaultRouteChange, type VaultRouteChangeKind, type VaultRouteFieldChange, type VaultRouteIds, type VaultRoutePurpose, type VaultRouteWarning, type VaultRouteWarningCode, type VaultRoutesApplyRequest, type VaultRoutesApplyResponse, type VaultRoutesFingerprint, type VaultRoutesPreviewRequest, type VaultRoutesPreviewResponse, type VaultVerificationResponse, type VaultVerifyRequest, type VerifyTotpRequest, type WebhookDeliveryAttempt, type WebhookDeliveryTerminalReason, type WebhookDetails, type WebhookEvent, type WebhookRefundStatus, type WebhookRegistrationEnvironment, Webhooks, allOf, anyOf, applyBrandingVariables, buildBrandingExport, buttonPadValue, cloneBranding, cloneCustomField, cloneNativePane, customFieldContextFromMetadata, customFieldIsTextLike, customFieldOperatorTakesValue, customFieldOptionLabel, customFieldText, decodeBadges, decodeBranding, decodeCustomFields, decodeNativePanes, defaultBranding, defaultCustomFieldVisibility, defaultNativePane, defaultOperatorForSource, encodeBadges, encodeBranding, encodeCustomFields, encodeNativePanes, evaluateCustomFieldCondition, evaluateCustomFieldVisibility, feeProgram, focusedCheckoutUrl, fontStack, fontWeightValue, inputPadValue, isCheckboxChecked, isDarkSurface, isHexColor, leaf, logoDimensions, nativePaneMethodInfo, parseCustomFieldsLoose, parseImportedBranding, programToTree, radiusValue, ruleMatchToTree, sanitizeCustomCss, shadowFor, surfacePadValue, verticalGapValue, visibleCustomFields };
|