@delopay/sdk 0.111.0 → 0.113.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-TS422PA3.js → chunk-NY5O6S5X.js} +64 -9
- package/dist/chunk-NY5O6S5X.js.map +1 -0
- package/dist/index.cjs +66 -8
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +451 -47
- package/dist/index.d.ts +451 -47
- package/dist/index.js +7 -1
- package/dist/internal.cjs +89 -8
- package/dist/internal.cjs.map +1 -1
- package/dist/internal.d.cts +60 -3
- package/dist/internal.d.ts +60 -3
- package/dist/internal.js +30 -1
- package/dist/internal.js.map +1 -1
- package/package.json +1 -1
- package/dist/chunk-TS422PA3.js.map +0 -1
package/dist/index.d.ts
CHANGED
|
@@ -17,7 +17,7 @@ type ConnectorType = 'payment_processor' | 'payment_vas' | 'fin_operations' | 'f
|
|
|
17
17
|
* to the API before the SDK is updated, so any name can be passed
|
|
18
18
|
* without a type error. Known names get IDE autocomplete.
|
|
19
19
|
*/
|
|
20
|
-
type Connector = 'aci' | 'adyen' | 'adyenplatform' | 'affirm' | 'airwallex' | 'amazonpay' | 'archipel' | 'authipay' | 'authorizedotnet' | 'bambora' | 'bamboraapac' | 'bankofamerica' | 'barclaycard' | 'billwerk' | 'bitpay' | 'blackhawknetwork' | 'bluesnap' | 'boku' | 'braintree' | 'breadpay' | 'calida' | 'cardinal' | 'cashtocode' | 'celero' | '
|
|
20
|
+
type Connector = 'aci' | 'adyen' | 'adyenplatform' | 'affirm' | 'airwallex' | 'amazonpay' | 'archipel' | 'authipay' | 'authorizedotnet' | 'bambora' | 'bamboraapac' | 'bankofamerica' | 'barclaycard' | 'billwerk' | 'bitpay' | 'blackhawknetwork' | 'bluesnap' | 'boku' | 'braintree' | 'breadpay' | 'calida' | 'cardinal' | 'cashtocode' | 'celero' | 'checkbook' | 'checkout' | 'coinbase' | 'coingate' | 'creem' | 'cryptomus' | 'cryptopay' | 'ctp_mastercard' | 'ctp_visa' | 'cybersource' | 'cybersourcedecisionmanager' | 'datatrans' | 'delopaythreedsserver' | 'deutschebank' | 'digitalvirgo' | 'dlocal' | 'dwolla' | 'ebanx' | 'elavon' | 'envoy' | 'epayouts' | 'facilitapay' | 'finix' | 'fiserv' | 'fiservcommercehub' | 'fiservemea' | 'fiuu' | 'flexiti' | 'forte' | 'getnet' | 'gigadat' | 'globalpay' | 'globepay' | 'gocardless' | 'gpayments' | 'helcim' | 'hipay' | 'hyperpg' | 'iatapay' | 'inespay' | 'itaubank' | 'jpmorgan' | 'klarna' | 'loonio' | 'mifinity' | 'mollie' | 'moneris' | 'multisafepay' | 'netcetera' | 'nexinets' | 'nexixpay' | 'nmi' | 'nomupay' | 'noon' | 'nordea' | 'novalnet' | 'nowpayments' | 'nuvei' | 'opennode' | 'paybox' | 'payload' | 'payme' | 'payone' | 'paypal' | 'paysafe' | 'paysepro' | 'paystack' | 'paytm' | 'payu' | 'payjustnow' | 'payjustnowinstore' | 'peachpayments' | 'phonepe' | 'placetopay' | 'plaid' | 'powertranz' | 'prophetpay' | 'rapyd' | 'razorpay' | 'recurly' | 'redsys' | 'revolv3' | 'riskified' | 'santander' | 'shift4' | 'signifyd' | 'silverflow' | 'skinsback' | 'square' | 'stax' | 'stripe' | 'stripebilling' | 'taxjar' | 'tesouro' | 'threedsecureio' | 'tokenex' | 'tokenio' | 'truelayer' | 'trustly' | 'trustpay' | 'trustpayments' | 'tsys' | 'vgs' | 'volt' | 'wellsfargo' | 'wise' | 'worldline' | 'worldpay' | 'worldpaymodular' | 'worldpayvantiv' | 'worldpayxml' | 'xendit' | 'zen' | 'zift' | 'zsl' | 'stripe_billing_test' | 'phonypay' | 'fauxpay' | 'pretendpay' | 'stripe_test' | 'adyen_test' | 'checkout_test' | 'paypal_test' | (string & {});
|
|
21
21
|
type DisputeStage = 'pre_dispute' | 'dispute' | 'pre_arbitration' | 'arbitration' | 'dispute_reversal';
|
|
22
22
|
type DisputeStatus = 'dispute_opened' | 'dispute_expired' | 'dispute_accepted' | 'dispute_cancelled' | 'dispute_challenged' | 'dispute_won' | 'dispute_lost';
|
|
23
23
|
type MandateStatus = 'active' | 'inactive' | 'pending' | 'revoked';
|
|
@@ -685,7 +685,7 @@ interface RefundListParams {
|
|
|
685
685
|
interface RefundListResponse {
|
|
686
686
|
count: number;
|
|
687
687
|
data: RefundResponse[];
|
|
688
|
-
total_count
|
|
688
|
+
total_count: number;
|
|
689
689
|
}
|
|
690
690
|
/** Parameters for creating a new customer. */
|
|
691
691
|
interface CustomerCreateRequest {
|
|
@@ -1054,6 +1054,14 @@ interface PaymentMethodDeleteResponse {
|
|
|
1054
1054
|
payment_method_id: string;
|
|
1055
1055
|
deleted: boolean;
|
|
1056
1056
|
}
|
|
1057
|
+
/**
|
|
1058
|
+
* Whether a processor tells DeloPay how a dispute ended. Four states rather
|
|
1059
|
+
* than a bool: "we have not checked" (`unknown`) is not "it does not report"
|
|
1060
|
+
* (`not_reported`), and "it reports a loss and never a win" (`loss_only`) is
|
|
1061
|
+
* neither — rounding it to `reported` would promise an outcome that never
|
|
1062
|
+
* comes for a dispute the merchant wins.
|
|
1063
|
+
*/
|
|
1064
|
+
type DisputeOutcomeReporting = 'reported' | 'loss_only' | 'not_reported' | 'unknown';
|
|
1057
1065
|
interface DisputeResponse {
|
|
1058
1066
|
dispute_id: string;
|
|
1059
1067
|
payment_id: string;
|
|
@@ -1066,12 +1074,14 @@ interface DisputeResponse {
|
|
|
1066
1074
|
connector_status: string;
|
|
1067
1075
|
connector_dispute_id: string;
|
|
1068
1076
|
is_already_refunded: boolean;
|
|
1077
|
+
/** Whether this dispute's processor reports outcomes — see {@link DisputeOutcomeReporting}. */
|
|
1078
|
+
outcome_reporting: DisputeOutcomeReporting;
|
|
1069
1079
|
connector_reason?: string | null;
|
|
1070
1080
|
connector_reason_code?: string | null;
|
|
1071
1081
|
challenge_required_by?: string | null;
|
|
1072
1082
|
connector_created_at?: string | null;
|
|
1073
1083
|
connector_updated_at?: string | null;
|
|
1074
|
-
created_at
|
|
1084
|
+
created_at: string;
|
|
1075
1085
|
updated_at?: string | null;
|
|
1076
1086
|
profile_id?: string | null;
|
|
1077
1087
|
merchant_connector_id?: string | null;
|
|
@@ -1157,6 +1167,18 @@ interface DisputeEvidenceBlock {
|
|
|
1157
1167
|
available?: boolean;
|
|
1158
1168
|
};
|
|
1159
1169
|
}
|
|
1170
|
+
/**
|
|
1171
|
+
* Body of `DELETE /disputes/evidence`.
|
|
1172
|
+
*
|
|
1173
|
+
* `deleteEvidence` was typed as `DisputeEvidenceRequest` — the body for
|
|
1174
|
+
* ATTACHING text evidence, which shares no field with this one. A caller
|
|
1175
|
+
* sending what the type asked for got a request the API rejects, and a caller
|
|
1176
|
+
* sending what the API wants did not compile.
|
|
1177
|
+
*/
|
|
1178
|
+
interface DeleteEvidenceRequest {
|
|
1179
|
+
dispute_id: string;
|
|
1180
|
+
evidence_type: DisputeEvidenceType;
|
|
1181
|
+
}
|
|
1160
1182
|
interface MandateResponse {
|
|
1161
1183
|
mandate_id: string;
|
|
1162
1184
|
status: MandateStatus;
|
|
@@ -1178,6 +1200,15 @@ interface MandateResponse {
|
|
|
1178
1200
|
} | null;
|
|
1179
1201
|
}
|
|
1180
1202
|
interface MandateListParams {
|
|
1203
|
+
/**
|
|
1204
|
+
* `MandateListConstraints` server-side also accepts `limit`, `offset`,
|
|
1205
|
+
* `connector` and the four `created_time.*` bounds, and `GET /mandates/list`
|
|
1206
|
+
* is a real route (`retrieve_mandates_list`, under `olap`). None of it is in
|
|
1207
|
+
* the generated OpenAPI spec — the route is not annotated at all — so it is
|
|
1208
|
+
* deliberately not published here. Widening the SDK past its own contract
|
|
1209
|
+
* would put the drift somewhere nothing checks, which is the failure this
|
|
1210
|
+
* whole PR is about.
|
|
1211
|
+
*/
|
|
1181
1212
|
mandate_status?: MandateStatus | null;
|
|
1182
1213
|
}
|
|
1183
1214
|
interface MandateRevokedResponse {
|
|
@@ -3252,6 +3283,17 @@ interface ConnectorCreateRequest {
|
|
|
3252
3283
|
}
|
|
3253
3284
|
interface ConnectorUpdateRequest {
|
|
3254
3285
|
connector_type: ConnectorType;
|
|
3286
|
+
/**
|
|
3287
|
+
* Required here because the generated OpenAPI contract lists it in
|
|
3288
|
+
* `MerchantConnectorUpdate.required`.
|
|
3289
|
+
*
|
|
3290
|
+
* The Rust field is `Option<ConnectorStatus>`, so the API itself accepts a
|
|
3291
|
+
* partial update without it — the contract says otherwise only because
|
|
3292
|
+
* `#[schema(value_type = ConnectorStatus)]` replaces the inferred type
|
|
3293
|
+
* INCLUDING its optionality. That is backend#1089, and until the spec is
|
|
3294
|
+
* regenerated this type must not contradict it: an SDK that is looser than
|
|
3295
|
+
* the published contract is its own kind of wrong.
|
|
3296
|
+
*/
|
|
3255
3297
|
status: string;
|
|
3256
3298
|
connector_label?: string | null;
|
|
3257
3299
|
connector_account_details?: Record<string, unknown> | null;
|
|
@@ -3735,6 +3777,12 @@ interface SubscriptionPaymentLink {
|
|
|
3735
3777
|
/** The invoice (billing cycle) the payment settles. */
|
|
3736
3778
|
invoice_id: string;
|
|
3737
3779
|
invoice_status: InvoiceStatus;
|
|
3780
|
+
/**
|
|
3781
|
+
* Whether the invoice's `amount` is a figure at all — see
|
|
3782
|
+
* {@link InvoiceAmountState}. An `unpriced` cycle is awaiting its first
|
|
3783
|
+
* charge; never render its zero as money.
|
|
3784
|
+
*/
|
|
3785
|
+
amount_state: InvoiceAmountState;
|
|
3738
3786
|
}
|
|
3739
3787
|
interface SubscriptionPaymentLookupResponse {
|
|
3740
3788
|
/**
|
|
@@ -3770,7 +3818,7 @@ interface SubscriptionInvoice {
|
|
|
3770
3818
|
/** ID of this invoice on the billing processor (Stripe Billing / PayPal). */
|
|
3771
3819
|
billing_processor_invoice_id?: string | null;
|
|
3772
3820
|
/** Connector (billing processor) this invoice was raised through, e.g. `paypal`. */
|
|
3773
|
-
provider_name
|
|
3821
|
+
provider_name: Connector;
|
|
3774
3822
|
/**
|
|
3775
3823
|
* Refunded against this cycle so far, in the invoice's currency and minor units.
|
|
3776
3824
|
*
|
|
@@ -3782,8 +3830,13 @@ interface SubscriptionInvoice {
|
|
|
3782
3830
|
* absence rather than defaulting it to zero.
|
|
3783
3831
|
*/
|
|
3784
3832
|
refunded_amount?: number | null;
|
|
3833
|
+
/**
|
|
3834
|
+
* Amount under dispute on this cycle, minor units. Null when no dispute
|
|
3835
|
+
* figure has been reported — which is not the same as `0`.
|
|
3836
|
+
*/
|
|
3837
|
+
disputed_amount?: number | null;
|
|
3785
3838
|
/** ISO 8601 timestamp of when this invoice was recorded. */
|
|
3786
|
-
created_at
|
|
3839
|
+
created_at: string;
|
|
3787
3840
|
}
|
|
3788
3841
|
/**
|
|
3789
3842
|
* One subscription's billing history, returned by
|
|
@@ -4028,6 +4081,17 @@ interface ResumeSubscriptionResponse {
|
|
|
4028
4081
|
next_billing_at?: string | null;
|
|
4029
4082
|
}
|
|
4030
4083
|
/** Returned by `POST /subscriptions/{id}/cancel`. */
|
|
4084
|
+
/**
|
|
4085
|
+
* Whether a cancellation was performed the way it was asked for. A processor
|
|
4086
|
+
* can answer a scheduled cancel by cancelling immediately (Creem does, on a
|
|
4087
|
+
* store whose billing settings default to immediate) and name nothing about
|
|
4088
|
+
* the mode applied; the subscription really is cancelled, so the merchant is
|
|
4089
|
+
* owed a statement that the mode performed was not the mode requested. Four
|
|
4090
|
+
* states, because merging any pair misleads: "we cannot tell" (`unknown`,
|
|
4091
|
+
* render as no claim) is not "it matched", and a cancellation performed
|
|
4092
|
+
* *earlier* than asked is not the same event as one performed *later*.
|
|
4093
|
+
*/
|
|
4094
|
+
type CancelModeOutcome = 'as_requested' | 'executed_immediately' | 'executed_later' | 'unknown';
|
|
4031
4095
|
interface CancelSubscriptionResponse {
|
|
4032
4096
|
id: string;
|
|
4033
4097
|
status: SubscriptionStatus;
|
|
@@ -4037,6 +4101,8 @@ interface CancelSubscriptionResponse {
|
|
|
4037
4101
|
customer_id: string;
|
|
4038
4102
|
/** ISO-8601 timestamp the subscription was cancelled at. */
|
|
4039
4103
|
cancelled_at?: string | null;
|
|
4104
|
+
/** Whether the mode performed was the mode requested — see {@link CancelModeOutcome}. */
|
|
4105
|
+
cancel_mode_outcome: CancelModeOutcome;
|
|
4040
4106
|
}
|
|
4041
4107
|
/** A subscription item with its prices, as returned by `GET /subscriptions/items`. */
|
|
4042
4108
|
interface GetSubscriptionItemsResponse {
|
|
@@ -4278,6 +4344,147 @@ interface UpdateRoleConnectorGrantParams {
|
|
|
4278
4344
|
* ignored — the server pins the scope to the authenticated merchant — so only
|
|
4279
4345
|
* `project_id` / `shop_id` (drill) and the window/section fields are honoured.
|
|
4280
4346
|
*/
|
|
4347
|
+
/** Series bucket size of the payments dashboard. */
|
|
4348
|
+
type AnalyticsGranularity = 'day' | 'hour' | '30m' | '15m' | '5m';
|
|
4349
|
+
/** The dashboards' four outcomes; `open` is processing + awaiting action. */
|
|
4350
|
+
type AnalyticsOutcome = 'success' | 'open' | 'failed' | 'void';
|
|
4351
|
+
/** Checkout channel token, as the device dashboard's channel series names them. */
|
|
4352
|
+
type AnalyticsChannel = 'hosted' | 'embedded' | 'api' | 'dashboard' | 'sdk' | 'unknown';
|
|
4353
|
+
/** Sort keys of the payments drill (`GET /analytics/scope/transactions`). */
|
|
4354
|
+
type ScopeDrillSortKey = 'created_at' | 'payment_created_at' | 'amount' | 'status' | 'connector' | 'method';
|
|
4355
|
+
/** Sort keys of the geo and device drills: the payments keys plus `time_to_pay`. */
|
|
4356
|
+
type ClientDrillSortKey = ScopeDrillSortKey | 'time_to_pay';
|
|
4357
|
+
/** Sort keys of the subscription drill. */
|
|
4358
|
+
type SubscriptionDrillSortKey = 'created_at' | 'payment_created_at' | 'amount' | 'status' | 'connector' | 'plan';
|
|
4359
|
+
/** Every sort key any drill accepts; each request narrows it to its own endpoint's set. */
|
|
4360
|
+
type DrillSortKey = ClientDrillSortKey | SubscriptionDrillSortKey;
|
|
4361
|
+
/**
|
|
4362
|
+
* The drawer's list controls, shared by every drill-through list. Applied
|
|
4363
|
+
* server-side over the whole match — the list is paged, so a client-side
|
|
4364
|
+
* sort or search would only ever cover the loaded page.
|
|
4365
|
+
*/
|
|
4366
|
+
interface DrillListControls<SortKey extends DrillSortKey = DrillSortKey> {
|
|
4367
|
+
/**
|
|
4368
|
+
* Free-text search (case-insensitive substring) over the ids a reader has
|
|
4369
|
+
* in front of them: payment id, customer id, description, the processor's
|
|
4370
|
+
* transaction reference and the shop name (invoice / subscription id on
|
|
4371
|
+
* the subscription drill).
|
|
4372
|
+
*/
|
|
4373
|
+
q?: string | null;
|
|
4374
|
+
/**
|
|
4375
|
+
* Sort key; `created_at` (newest first) by default — the observation time
|
|
4376
|
+
* on geo/device, the cycle on subscriptions; `payment_created_at` is the
|
|
4377
|
+
* payment's own time everywhere. `amount` sorts on USD. Each request
|
|
4378
|
+
* narrows this to the keys its endpoint accepts — the server answers
|
|
4379
|
+
* `400` to any other.
|
|
4380
|
+
*/
|
|
4381
|
+
sort_on?: SortKey | null;
|
|
4382
|
+
/** `asc` | `desc` (default `desc`). */
|
|
4383
|
+
sort_by?: 'asc' | 'desc' | null;
|
|
4384
|
+
/**
|
|
4385
|
+
* Row filter: an outcome token or one raw intent status (one raw invoice
|
|
4386
|
+
* status on the subscription drill).
|
|
4387
|
+
*/
|
|
4388
|
+
status?: AnalyticsOutcome | string | null;
|
|
4389
|
+
/** Row filter: processor name, `"Direct"` included. */
|
|
4390
|
+
connector?: string | null;
|
|
4391
|
+
/** Row filter: high-level payment method; `"none"` = no attempt. */
|
|
4392
|
+
method?: string | null;
|
|
4393
|
+
/** Row filter: checkout channel token. */
|
|
4394
|
+
channel?: AnalyticsChannel | null;
|
|
4395
|
+
/** Row filter: ISO currency code. */
|
|
4396
|
+
currency?: string | null;
|
|
4397
|
+
/** Page size, default 50, at most 200. */
|
|
4398
|
+
limit?: number | null;
|
|
4399
|
+
/** Offset into the sorted list. `total` in the response is the full match count. */
|
|
4400
|
+
offset?: number | null;
|
|
4401
|
+
}
|
|
4402
|
+
/** The window / scope / chip part of a payments drill. */
|
|
4403
|
+
interface ScopeDrillBase extends DrillListControls<ScopeDrillSortKey> {
|
|
4404
|
+
days?: number | null;
|
|
4405
|
+
start_date?: string | null;
|
|
4406
|
+
end_date?: string | null;
|
|
4407
|
+
/** Ignored (server-pinned) on `analytics.scopeTransactions`. */
|
|
4408
|
+
merchant_id?: string | null;
|
|
4409
|
+
project_id?: string | null;
|
|
4410
|
+
shop_id?: string | null;
|
|
4411
|
+
test_mode?: boolean | null;
|
|
4412
|
+
/**
|
|
4413
|
+
* The bucket size the series was drawn in, so a sub-day `target_bucket`
|
|
4414
|
+
* spans the right interval. Defaults to `"hour"` for a timestamp bucket and
|
|
4415
|
+
* `"day"` for a date.
|
|
4416
|
+
*/
|
|
4417
|
+
granularity?: AnalyticsGranularity | null;
|
|
4418
|
+
/** Active chip filters, so the drill lists what the charts counted. */
|
|
4419
|
+
country?: string | null;
|
|
4420
|
+
country_source?: string | null;
|
|
4421
|
+
device_class?: string | null;
|
|
4422
|
+
}
|
|
4423
|
+
/** The targets that stand on their own and combine freely. */
|
|
4424
|
+
interface ScopeDrillFreeTargets {
|
|
4425
|
+
/** Clicked processor slice (`connectors[].name`, `"Direct"` included). */
|
|
4426
|
+
target_connector?: string;
|
|
4427
|
+
/** Clicked outcome segment of a series bar. */
|
|
4428
|
+
target_outcome?: AnalyticsOutcome;
|
|
4429
|
+
/**
|
|
4430
|
+
* Clicked series bucket, in the shape the series describes: `YYYY-MM-DD`
|
|
4431
|
+
* for a day, `YYYY-MM-DDTHH:MM:00Z` for a sub-day bucket. Narrows every
|
|
4432
|
+
* other target to that bucket.
|
|
4433
|
+
*/
|
|
4434
|
+
target_bucket?: string;
|
|
4435
|
+
}
|
|
4436
|
+
/**
|
|
4437
|
+
* A method type only ever qualifies a method: either both travel, or
|
|
4438
|
+
* neither. The `?: never` arm is what keeps an orphan `target_method_type`
|
|
4439
|
+
* out on every other combination of targets, not just when the method arm
|
|
4440
|
+
* is the one satisfying "at least one".
|
|
4441
|
+
*/
|
|
4442
|
+
type ScopeDrillMethodPart = {
|
|
4443
|
+
/** Clicked payment-method slice (`methods[].method`); `"none"` = the null-method slice. */
|
|
4444
|
+
target_method: string;
|
|
4445
|
+
/** Narrows `target_method` to one `methods[].method_type`. */
|
|
4446
|
+
target_method_type?: string;
|
|
4447
|
+
} | {
|
|
4448
|
+
target_method?: never;
|
|
4449
|
+
target_method_type?: never;
|
|
4450
|
+
};
|
|
4451
|
+
/**
|
|
4452
|
+
* A child id without its kind cannot be resolved (the server matches
|
|
4453
|
+
* nothing rather than everything), so the pair is one unit on every arm.
|
|
4454
|
+
*/
|
|
4455
|
+
type ScopeDrillChildPart = {
|
|
4456
|
+
/** Clicked breakdown row, with the kind needed to resolve it. */
|
|
4457
|
+
target_child: string;
|
|
4458
|
+
target_child_kind: 'merchant' | 'project' | 'shop';
|
|
4459
|
+
} | {
|
|
4460
|
+
target_child?: never;
|
|
4461
|
+
target_child_kind?: never;
|
|
4462
|
+
};
|
|
4463
|
+
type ScopeDrillTargets = ScopeDrillFreeTargets & ScopeDrillMethodPart & ScopeDrillChildPart;
|
|
4464
|
+
/**
|
|
4465
|
+
* The clicked target(s) of a payments drill. **At least one**, and they
|
|
4466
|
+
* combine — a connector *and* an outcome is "that connector's failed
|
|
4467
|
+
* payments" — so unlike the subscription drill this is "one or more", not
|
|
4468
|
+
* "exactly one". What the union refuses is a request with no target at all
|
|
4469
|
+
* (`{}` would otherwise list the whole window, which no click means), a
|
|
4470
|
+
* `target_method_type` with no `target_method`, and a child id with no kind
|
|
4471
|
+
* — the last two on every arm, because the pair rules are intersected into
|
|
4472
|
+
* each of them rather than living only on the arm that names the pair.
|
|
4473
|
+
*/
|
|
4474
|
+
type ScopeDrillTarget = (ScopeDrillTargets & {
|
|
4475
|
+
target_connector: string;
|
|
4476
|
+
}) | (ScopeDrillTargets & {
|
|
4477
|
+
target_method: string;
|
|
4478
|
+
}) | (ScopeDrillTargets & {
|
|
4479
|
+
target_outcome: AnalyticsOutcome;
|
|
4480
|
+
}) | (ScopeDrillTargets & {
|
|
4481
|
+
target_bucket: string;
|
|
4482
|
+
}) | (ScopeDrillTargets & {
|
|
4483
|
+
target_child: string;
|
|
4484
|
+
target_child_kind: 'merchant' | 'project' | 'shop';
|
|
4485
|
+
});
|
|
4486
|
+
/** Query for the payments drill-through list: `GET /analytics/scope/transactions`. */
|
|
4487
|
+
type ScopeDrillRequest = ScopeDrillBase & ScopeDrillTarget;
|
|
4281
4488
|
interface AnalyticsScopeRequest {
|
|
4282
4489
|
/** Trailing days for a rolling window ending now. Default 7, capped at 90. */
|
|
4283
4490
|
days?: number | null;
|
|
@@ -4308,13 +4515,15 @@ interface AnalyticsScopeRequest {
|
|
|
4308
4515
|
*/
|
|
4309
4516
|
test_mode?: boolean | null;
|
|
4310
4517
|
/**
|
|
4311
|
-
* Series bucket size: `"day"` (default)
|
|
4312
|
-
*
|
|
4313
|
-
*
|
|
4314
|
-
*
|
|
4315
|
-
*
|
|
4518
|
+
* Series bucket size: `"day"` (default), `"hour"`, `"30m"`, `"15m"` or
|
|
4519
|
+
* `"5m"`. Any sub-day grain over any window, as long as the series stays
|
|
4520
|
+
* within the bucket ceiling of 2208 (an hourly view of the widest 92-day
|
|
4521
|
+
* window; a 5-minute view of a week) — past it the request is rejected with
|
|
4522
|
+
* the count it would have needed. Sub-day buckets are UTC and always
|
|
4523
|
+
* aggregate live. Older backends accept only `"day"` / `"hour"` and cap
|
|
4524
|
+
* hourly at a 48-hour window.
|
|
4316
4525
|
*/
|
|
4317
|
-
granularity?:
|
|
4526
|
+
granularity?: AnalyticsGranularity | null;
|
|
4318
4527
|
/**
|
|
4319
4528
|
* Restrict to payments from one country (ISO alpha-2), matched against the
|
|
4320
4529
|
* claim `country_source` names. A filtered request always aggregates live
|
|
@@ -4410,22 +4619,22 @@ interface AnalyticsScopeResponse {
|
|
|
4410
4619
|
/** "root" | "merchant" | "project" | "shop". */
|
|
4411
4620
|
level: string;
|
|
4412
4621
|
/**
|
|
4413
|
-
* Bucket size of `series` / `previous_series` / `connectors[].days`: `"day"
|
|
4414
|
-
*
|
|
4415
|
-
* backends, which always return daily buckets.
|
|
4622
|
+
* Bucket size of `series` / `previous_series` / `connectors[].days`: `"day"`,
|
|
4623
|
+
* `"hour"`, `"30m"`, `"15m"` or `"5m"` (UTC, sub-day). Mirrors the request.
|
|
4416
4624
|
*/
|
|
4417
|
-
granularity
|
|
4625
|
+
granularity: AnalyticsGranularity;
|
|
4418
4626
|
/**
|
|
4419
|
-
* UTC instant of the first bucket's start
|
|
4420
|
-
* (`YYYY-MM-DDTHH:
|
|
4421
|
-
* `days` describe the axis.
|
|
4627
|
+
* UTC instant of the first bucket's start for a sub-day `granularity`
|
|
4628
|
+
* (`YYYY-MM-DDTHH:MM:00Z` — the window start floored to the bucket); absent
|
|
4629
|
+
* for daily buckets, where `end_date` + `days` describe the axis.
|
|
4422
4630
|
*/
|
|
4423
4631
|
bucket_start?: string | null;
|
|
4424
4632
|
series: AnalyticsDayBucket[];
|
|
4425
4633
|
/**
|
|
4426
4634
|
* Equal-length previous window (for period-over-period deltas + comparison).
|
|
4427
|
-
* For
|
|
4428
|
-
*
|
|
4635
|
+
* For sub-day buckets this is the same time span shifted back by the
|
|
4636
|
+
* window's length in whole days (24h for an intra-day view, 7 days for a
|
|
4637
|
+
* week), so bucket `i` compares with the same time-of-day one window earlier.
|
|
4429
4638
|
*/
|
|
4430
4639
|
previous_series: AnalyticsDayBucket[];
|
|
4431
4640
|
connectors: AnalyticsConnectorSeries[];
|
|
@@ -4464,10 +4673,12 @@ interface ClientAnalyticsRequest {
|
|
|
4464
4673
|
/** `false` = live only, `true` = test only. Omit for both. */
|
|
4465
4674
|
test_mode?: boolean | null;
|
|
4466
4675
|
/**
|
|
4467
|
-
* Series bucket size: `"day"` (default) or `"hour"
|
|
4468
|
-
*
|
|
4676
|
+
* Series bucket size: `"day"` (default) or `"hour"` — these pages have no
|
|
4677
|
+
* sub-hour view. Any window, up to the shared ceiling of 2208 buckets
|
|
4678
|
+
* (hourly over the widest window); hourly always aggregates live. Older
|
|
4679
|
+
* backends cap hourly at a 48-hour window.
|
|
4469
4680
|
*/
|
|
4470
|
-
granularity?:
|
|
4681
|
+
granularity?: 'day' | 'hour' | null;
|
|
4471
4682
|
/**
|
|
4472
4683
|
* Comma-separated response blocks to compute; omit for all. Devices:
|
|
4473
4684
|
* `totals`, `browsers`, `platforms`, `classes`, `models`, `channels`,
|
|
@@ -4732,7 +4943,7 @@ interface GeoAnalyticsResponse {
|
|
|
4732
4943
|
previous_top_country_share?: number | null;
|
|
4733
4944
|
}
|
|
4734
4945
|
/** Query for the geo drill-through list: the page's window/scope/filters plus the clicked target. */
|
|
4735
|
-
interface GeoDrillRequest {
|
|
4946
|
+
interface GeoDrillRequest extends DrillListControls<ClientDrillSortKey> {
|
|
4736
4947
|
days?: number | null;
|
|
4737
4948
|
start_date?: string | null;
|
|
4738
4949
|
end_date?: string | null;
|
|
@@ -4754,11 +4965,11 @@ interface GeoDrillRequest {
|
|
|
4754
4965
|
dow?: number | null;
|
|
4755
4966
|
/** Heatmap cell: buyer-local hour 0-23. Requires dow. */
|
|
4756
4967
|
hour?: number | null;
|
|
4757
|
-
/** Pagination offset into the newest-first list (page size 50). */
|
|
4758
|
-
offset?: number | null;
|
|
4759
4968
|
}
|
|
4760
|
-
/**
|
|
4761
|
-
|
|
4969
|
+
/** Time-to-pay histogram bar labels, in histogram order. */
|
|
4970
|
+
type TimeToPayBucketLabel = 'lt_30s' | 's30_60s' | 'm1_2' | 'm2_5' | 'm5_15' | 'gt_15m';
|
|
4971
|
+
/** The window / scope / chip part of a device drill. */
|
|
4972
|
+
interface DeviceDrillBase extends DrillListControls<ClientDrillSortKey> {
|
|
4762
4973
|
days?: number | null;
|
|
4763
4974
|
start_date?: string | null;
|
|
4764
4975
|
end_date?: string | null;
|
|
@@ -4770,17 +4981,57 @@ interface DeviceDrillRequest {
|
|
|
4770
4981
|
country?: string | null;
|
|
4771
4982
|
country_source?: string | null;
|
|
4772
4983
|
device_class?: string | null;
|
|
4984
|
+
}
|
|
4985
|
+
interface DeviceBrowserTarget {
|
|
4773
4986
|
/** Clicked browser family token (chrome, safari, ...). */
|
|
4774
|
-
target_browser
|
|
4987
|
+
target_browser: string;
|
|
4988
|
+
}
|
|
4989
|
+
interface DevicePlatformTarget {
|
|
4775
4990
|
/** Clicked platform family token (ios, android, macos, ...). */
|
|
4776
|
-
target_platform
|
|
4991
|
+
target_platform: string;
|
|
4992
|
+
}
|
|
4993
|
+
interface DeviceModelTarget {
|
|
4777
4994
|
/** Clicked device-model label, exactly as listed by the models card. */
|
|
4778
|
-
target_model
|
|
4779
|
-
/** Clicked device class (phone | tablet | desktop | unknown). */
|
|
4780
|
-
target_device_class?: string | null;
|
|
4781
|
-
/** Pagination offset into the newest-first list (page size 50). */
|
|
4782
|
-
offset?: number | null;
|
|
4995
|
+
target_model: string;
|
|
4783
4996
|
}
|
|
4997
|
+
interface DeviceClassTarget {
|
|
4998
|
+
/** Clicked device class. */
|
|
4999
|
+
target_device_class: 'phone' | 'tablet' | 'desktop' | 'unknown';
|
|
5000
|
+
}
|
|
5001
|
+
interface DeviceTtpTarget {
|
|
5002
|
+
/**
|
|
5003
|
+
* Clicked time-to-pay histogram bar. Paid, timed sessions only — exactly
|
|
5004
|
+
* the bar's own population; rows carry `time_to_pay_s`.
|
|
5005
|
+
*/
|
|
5006
|
+
target_ttp_bucket: TimeToPayBucketLabel;
|
|
5007
|
+
}
|
|
5008
|
+
interface DeviceChannelTarget {
|
|
5009
|
+
/** Clicked checkout channel; rows carry `channel`. */
|
|
5010
|
+
target_channel: AnalyticsChannel;
|
|
5011
|
+
/**
|
|
5012
|
+
* One bar of the channel series, in the shape the series emits
|
|
5013
|
+
* (`YYYY-MM-DD` or `YYYY-MM-DDTHH:00:00Z`). Only meaningful with the
|
|
5014
|
+
* channel, which is why it lives on this arm alone.
|
|
5015
|
+
*/
|
|
5016
|
+
target_bucket?: string;
|
|
5017
|
+
}
|
|
5018
|
+
type DeviceTargetKey = 'target_browser' | 'target_platform' | 'target_model' | 'target_device_class' | 'target_ttp_bucket' | 'target_channel' | 'target_bucket';
|
|
5019
|
+
/** Every device target key this arm does not itself set, forbidden. */
|
|
5020
|
+
type NotOtherDevice<Set extends DeviceTargetKey> = Partial<Record<Exclude<DeviceTargetKey, Set>, never>>;
|
|
5021
|
+
/**
|
|
5022
|
+
* The clicked device target. **Exactly one** of six, as a discriminated
|
|
5023
|
+
* union: the endpoint refuses two targets with a `400`, and `{}` would
|
|
5024
|
+
* otherwise compile into a request that lists nothing a click meant. Each
|
|
5025
|
+
* arm marks every other target `?: never`; `target_bucket` is allowed on the
|
|
5026
|
+
* channel arm only, because a bar of the channel series is the only thing it
|
|
5027
|
+
* can name here.
|
|
5028
|
+
*/
|
|
5029
|
+
type DeviceDrillTarget = (DeviceBrowserTarget & NotOtherDevice<'target_browser'>) | (DevicePlatformTarget & NotOtherDevice<'target_platform'>) | (DeviceModelTarget & NotOtherDevice<'target_model'>) | (DeviceClassTarget & NotOtherDevice<'target_device_class'>) | (DeviceTtpTarget & NotOtherDevice<'target_ttp_bucket'>) | (DeviceChannelTarget & NotOtherDevice<'target_channel' | 'target_bucket'>);
|
|
5030
|
+
/**
|
|
5031
|
+
* Query for the device drill-through list: the page's window/scope/filters
|
|
5032
|
+
* plus exactly one clicked device target.
|
|
5033
|
+
*/
|
|
5034
|
+
type DeviceDrillRequest = DeviceDrillBase & DeviceDrillTarget;
|
|
4784
5035
|
/** One payment behind a clicked geo target. */
|
|
4785
5036
|
interface DrillPayment {
|
|
4786
5037
|
payment_id: string;
|
|
@@ -4814,6 +5065,38 @@ interface DrillPayment {
|
|
|
4814
5065
|
country?: string | null;
|
|
4815
5066
|
/** IP-resolved city, when GeoLite2 had one. */
|
|
4816
5067
|
city?: string | null;
|
|
5068
|
+
/**
|
|
5069
|
+
* Processor of the active attempt (`"Direct"` when the attempt carried
|
|
5070
|
+
* none); null when the intent never reached an attempt.
|
|
5071
|
+
*/
|
|
5072
|
+
connector: string | null;
|
|
5073
|
+
/** High-level payment method of the active attempt (`card`, `wallet`, …). */
|
|
5074
|
+
payment_method: string | null;
|
|
5075
|
+
/** Narrower method type of the active attempt (`credit`, `apple_pay`, …). */
|
|
5076
|
+
payment_method_type: string | null;
|
|
5077
|
+
/** Checkout channel token; null on rows that are not payments. */
|
|
5078
|
+
channel: AnalyticsChannel | null;
|
|
5079
|
+
/** Device class of the canonical observation, when one exists. */
|
|
5080
|
+
device_class: string | null;
|
|
5081
|
+
/** Browser family of the canonical observation (`chrome`, `safari`, …). */
|
|
5082
|
+
browser_family: string | null;
|
|
5083
|
+
/** Platform family of the canonical observation (`ios`, `android`, …). */
|
|
5084
|
+
platform_family: string | null;
|
|
5085
|
+
/**
|
|
5086
|
+
* Seconds from the first checkout open to the succeeded transition; null
|
|
5087
|
+
* when either endpoint is missing.
|
|
5088
|
+
*/
|
|
5089
|
+
time_to_pay_s: number | null;
|
|
5090
|
+
/**
|
|
5091
|
+
* The amount in USD major units, FX-converted with the same rates the
|
|
5092
|
+
* dashboard sums with — so the drawer's figures agree with the chart that
|
|
5093
|
+
* was clicked. Null when the currency has no fresh rate.
|
|
5094
|
+
*/
|
|
5095
|
+
amount_usd: number | null;
|
|
5096
|
+
/** Successfully refunded amount in the payment's own minor units, when any. */
|
|
5097
|
+
refunded_minor: number | null;
|
|
5098
|
+
/** The buyer's customer id, when the payment carried one. */
|
|
5099
|
+
customer_id: string | null;
|
|
4817
5100
|
/**
|
|
4818
5101
|
* Subscription this row belongs to. Set only by the subscription drill; its
|
|
4819
5102
|
* presence is what tells a client to link the row at the subscription
|
|
@@ -4828,15 +5111,63 @@ interface DrillPayment {
|
|
|
4828
5111
|
* only.
|
|
4829
5112
|
*/
|
|
4830
5113
|
invoice_status?: string | null;
|
|
5114
|
+
/** Plan the subscription is on. Subscription drill only. */
|
|
5115
|
+
plan?: string | null;
|
|
5116
|
+
/** Billing processor that raised the cycle. Subscription drill only. */
|
|
5117
|
+
billing_processor?: string | null;
|
|
5118
|
+
/** The subscription's own status. Subscription drill only. */
|
|
5119
|
+
subscription_status?: string | null;
|
|
5120
|
+
}
|
|
5121
|
+
/**
|
|
5122
|
+
* Figures over the **whole** match of a drill — not the returned page — so a
|
|
5123
|
+
* drawer header can summarise what was clicked while the list is paged.
|
|
5124
|
+
*/
|
|
5125
|
+
interface DrillSummary {
|
|
5126
|
+
/**
|
|
5127
|
+
* Rows matched (equals the response's `total`). On the subscription drill
|
|
5128
|
+
* a row is a billing cycle, so this is the invoice count.
|
|
5129
|
+
*/
|
|
5130
|
+
count: number;
|
|
5131
|
+
/** Rows whose outcome is `success` (settled cycles on the subscription drill). */
|
|
5132
|
+
successful_count: number;
|
|
5133
|
+
/**
|
|
5134
|
+
* USD major units, FX-converted with the dashboard's rates; rows with no
|
|
5135
|
+
* fresh rate contribute their count but not their volume. On the
|
|
5136
|
+
* subscription drill this is the billed volume of the matched cycles.
|
|
5137
|
+
*/
|
|
5138
|
+
successful_volume_usd: number;
|
|
5139
|
+
/** Successfully refunded volume behind the matched rows, USD major units. */
|
|
5140
|
+
refund_volume_usd: number;
|
|
5141
|
+
/** `successful_count / count`, `0` when nothing matched. */
|
|
5142
|
+
success_rate: number;
|
|
5143
|
+
/** Median successful amount, USD major units; null when none converted. */
|
|
5144
|
+
median_amount_usd: number | null;
|
|
5145
|
+
/** Median time-to-pay over the matched paid, timed sessions (device/geo drills); null elsewhere. */
|
|
5146
|
+
median_time_to_pay_s: number | null;
|
|
5147
|
+
/** Distinct subscriptions behind the matched cycles (subscription drill); null elsewhere. */
|
|
5148
|
+
subscriptions: number | null;
|
|
5149
|
+
/**
|
|
5150
|
+
* Rows whose currency had no fresh USD rate, so the USD figures above are
|
|
5151
|
+
* a lower bound when this is non-zero.
|
|
5152
|
+
*/
|
|
5153
|
+
unconverted_count: number;
|
|
4831
5154
|
}
|
|
4832
|
-
/**
|
|
5155
|
+
/** A drill-through list: the rows behind one clicked chart element. */
|
|
4833
5156
|
interface DrillResponse {
|
|
4834
5157
|
enabled: boolean;
|
|
4835
5158
|
caveats: ClientAnalyticsCaveat[];
|
|
4836
|
-
/**
|
|
5159
|
+
/**
|
|
5160
|
+
* One page, sorted per the request's `sort_on` / `sort_by` (newest first by
|
|
5161
|
+
* default), `limit` rows (default 50).
|
|
5162
|
+
*/
|
|
4837
5163
|
payments: DrillPayment[];
|
|
4838
5164
|
/** Full match count (may exceed payments.length). */
|
|
4839
5165
|
total: number;
|
|
5166
|
+
/**
|
|
5167
|
+
* Figures over the whole match. Absent on older backends, which predate
|
|
5168
|
+
* the summary — treat a missing block as "no summary", not as zeros.
|
|
5169
|
+
*/
|
|
5170
|
+
summary?: DrillSummary;
|
|
4840
5171
|
}
|
|
4841
5172
|
/** Query for the subscription-analytics endpoint. */
|
|
4842
5173
|
interface SubscriptionAnalyticsRequest {
|
|
@@ -5089,7 +5420,11 @@ interface SubscriptionAnalyticsResponse {
|
|
|
5089
5420
|
previous_totals?: SubscriptionTotals | null;
|
|
5090
5421
|
}
|
|
5091
5422
|
/** The window, scope and chip filters every drill call carries. */
|
|
5092
|
-
interface SubscriptionDrillBase {
|
|
5423
|
+
interface SubscriptionDrillBase extends Omit<DrillListControls<SubscriptionDrillSortKey>, 'method' | 'channel' | 'status' | 'connector'> {
|
|
5424
|
+
/** Row filter: one invoice status, verbatim. */
|
|
5425
|
+
status?: string | null;
|
|
5426
|
+
/** Row filter: the charging connector. */
|
|
5427
|
+
connector?: string | null;
|
|
5093
5428
|
days?: number | null;
|
|
5094
5429
|
start_date?: string | null;
|
|
5095
5430
|
end_date?: string | null;
|
|
@@ -5106,8 +5441,6 @@ interface SubscriptionDrillBase {
|
|
|
5106
5441
|
* that one day, so it combines with any of them rather than replacing them.
|
|
5107
5442
|
*/
|
|
5108
5443
|
target_bucket?: string | null;
|
|
5109
|
-
/** Offset into the newest-first list (page size 50). */
|
|
5110
|
-
offset?: number | null;
|
|
5111
5444
|
}
|
|
5112
5445
|
/**
|
|
5113
5446
|
* The clicked target. **Exactly one**, encoded as a discriminated union rather
|
|
@@ -6152,13 +6485,15 @@ interface CheckoutBrandingUpdate {
|
|
|
6152
6485
|
payment_link_config?: BusinessPaymentLinkConfig | null;
|
|
6153
6486
|
}
|
|
6154
6487
|
/**
|
|
6155
|
-
* Response of
|
|
6488
|
+
* Response of both checkout-branding routes: the `GET` on
|
|
6489
|
+
* `/shops/{merchant_id}/{shop_id}/checkout-branding`, and the `POST` echoing
|
|
6490
|
+
* back what it persisted.
|
|
6156
6491
|
*
|
|
6157
6492
|
* Deliberately not a `ProfileResponse`: that carries `payment_response_hash_key`
|
|
6158
6493
|
* — the webhook signing secret — plus the card-vault and authentication
|
|
6159
6494
|
* configuration, and a role that may only restyle a checkout has no business
|
|
6160
|
-
* reading any of it
|
|
6161
|
-
* else.
|
|
6495
|
+
* reading any of it, whether it asked to load the checkout or has just saved
|
|
6496
|
+
* it. This carries what the branding editor renders and nothing else.
|
|
6162
6497
|
*/
|
|
6163
6498
|
interface CheckoutBrandingResponse {
|
|
6164
6499
|
/** The shop (business profile) this branding belongs to. */
|
|
@@ -7186,7 +7521,7 @@ declare class Disputes {
|
|
|
7186
7521
|
* @param params - Evidence request body identifying what to delete.
|
|
7187
7522
|
* @returns The updated dispute.
|
|
7188
7523
|
*/
|
|
7189
|
-
deleteEvidence(params:
|
|
7524
|
+
deleteEvidence(params: DeleteEvidenceRequest): Promise<DisputeResponse>;
|
|
7190
7525
|
/** List disputes (profile-scoped). `GET /disputes/profile/list` */
|
|
7191
7526
|
listByProfile(params?: DisputeListParams): Promise<DisputeResponse[]>;
|
|
7192
7527
|
/** Get dispute filter options. `GET /disputes/filter` */
|
|
@@ -8639,9 +8974,12 @@ declare class Shops {
|
|
|
8639
8974
|
* @param merchantId - The merchant account ID.
|
|
8640
8975
|
* @param shopId - The shop (business profile) ID to restyle.
|
|
8641
8976
|
* @param params - The new `payment_link_config` blob (full replacement).
|
|
8642
|
-
* @returns The
|
|
8977
|
+
* @returns The saved branding — the same shape `retrieveCheckoutBranding`
|
|
8978
|
+
* returns, not the whole shop. A role whose only power is restyling a
|
|
8979
|
+
* checkout must not receive the webhook signing key or the card-vault
|
|
8980
|
+
* configuration back from a save.
|
|
8643
8981
|
*/
|
|
8644
|
-
updateCheckoutBranding(merchantId: string, shopId: string, params: CheckoutBrandingUpdate, options?: RequestExtras): Promise<
|
|
8982
|
+
updateCheckoutBranding(merchantId: string, shopId: string, params: CheckoutBrandingUpdate, options?: RequestExtras): Promise<CheckoutBrandingResponse>;
|
|
8645
8983
|
/**
|
|
8646
8984
|
* Read only the checkout appearance of a shop, so the role that may restyle a
|
|
8647
8985
|
* checkout can load the checkout it may restyle.
|
|
@@ -9070,6 +9408,19 @@ declare class Analytics {
|
|
|
9070
9408
|
* `GET /analytics/devices/transactions`
|
|
9071
9409
|
*/
|
|
9072
9410
|
deviceTransactions(params: DeviceDrillRequest): Promise<DrillResponse>;
|
|
9411
|
+
/**
|
|
9412
|
+
* The payments behind one clicked element of the payments dashboard: a
|
|
9413
|
+
* processor-donut slice, a payment-method slice, an outcome segment of a
|
|
9414
|
+
* series bar, a series bucket, or a breakdown row — combinable, with
|
|
9415
|
+
* `target_bucket` narrowing every other target. The outcome mapping is the
|
|
9416
|
+
* one the series and donuts are folded with, expanded server-side, so the
|
|
9417
|
+
* list is what the clicked number was made of. Rows and the whole-match
|
|
9418
|
+
* `summary` carry USD figures converted with the dashboard's own rates.
|
|
9419
|
+
* Same window/scope/chip contract as `scope`; sorted per `sort_on` /
|
|
9420
|
+
* `sort_by`, `limit` rows (default 50) per page, `offset` for the next.
|
|
9421
|
+
* `GET /analytics/scope/transactions`
|
|
9422
|
+
*/
|
|
9423
|
+
scopeTransactions(params: ScopeDrillRequest): Promise<DrillResponse>;
|
|
9073
9424
|
/**
|
|
9074
9425
|
* Subscription analytics over `subscription` and `invoice`: estimated
|
|
9075
9426
|
* recurring volume, the invoice funnel, movement (new / expansion /
|
|
@@ -10312,6 +10663,59 @@ declare function logoDimensions(size: LogoSize): {
|
|
|
10312
10663
|
radius: number;
|
|
10313
10664
|
};
|
|
10314
10665
|
declare function isHexColor(value: string): boolean;
|
|
10666
|
+
/** Minimum contrast for body text — WCAG 2.1 success criterion 1.4.3. */
|
|
10667
|
+
declare const WCAG_AA_TEXT = 4.5;
|
|
10668
|
+
/**
|
|
10669
|
+
* Minimum contrast for non-text UI — WCAG 2.1 success criterion 1.4.11.
|
|
10670
|
+
* Focus rings, borders, icons carrying meaning.
|
|
10671
|
+
*/
|
|
10672
|
+
declare const WCAG_AA_UI = 3;
|
|
10673
|
+
/**
|
|
10674
|
+
* WCAG 2.1 contrast ratio between two colours, 1–21. Order does not matter.
|
|
10675
|
+
*
|
|
10676
|
+
* Compare against {@link WCAG_AA_TEXT} or {@link WCAG_AA_UI}:
|
|
10677
|
+
*
|
|
10678
|
+
* ```ts
|
|
10679
|
+
* const ratio = contrastRatio(branding.surface, branding.text);
|
|
10680
|
+
* if (ratio === null || ratio < WCAG_AA_TEXT) useDefaultPalette();
|
|
10681
|
+
* ```
|
|
10682
|
+
*
|
|
10683
|
+
* ⚠️ Returns `null` — never a number — when either colour cannot be parsed.
|
|
10684
|
+
* That is the load-bearing part of this signature. Every colour bug this API
|
|
10685
|
+
* exists to prevent came from a helper answering with a plausible value for
|
|
10686
|
+
* something it could not read, and a `0` or a `21` here would be silently
|
|
10687
|
+
* believed by exactly the branch that is deciding whether text is legible.
|
|
10688
|
+
*
|
|
10689
|
+
* Accepts `#rgb` and `#rrggbb` — a CSS `<hex-color>`. ⚠️ A hash-less token is
|
|
10690
|
+
* `null`, not a ratio: `applyBrandingVariables` writes branding values into
|
|
10691
|
+
* custom properties verbatim, so `'000'` reaches CSS as something that is not a
|
|
10692
|
+
* colour. Returning `21` for it would approve a palette that never renders.
|
|
10693
|
+
* ({@link isDarkSurface} keeps its historical hash-less tolerance; this is new
|
|
10694
|
+
* API and does not inherit it.)
|
|
10695
|
+
*/
|
|
10696
|
+
declare function contrastRatio(a: string, b: string): number | null;
|
|
10697
|
+
/**
|
|
10698
|
+
* Crude perceived-luminance check — picks the right Stripe Elements preset
|
|
10699
|
+
* (`'night'` vs `'stripe'`) when the merchant has a dark surface.
|
|
10700
|
+
*
|
|
10701
|
+
* ⚠️ **This is not a readability test. Use {@link contrastRatio} for that.**
|
|
10702
|
+
* It is a YIQ luma split at 128, and on real brand colours its verdict and
|
|
10703
|
+
* actual legibility are not merely imprecise relative to each other — they can
|
|
10704
|
+
* be anti-correlated:
|
|
10705
|
+
*
|
|
10706
|
+
* | colour | `isDarkSurface` | vs white | |
|
|
10707
|
+
* | --- | --- | --- | --- |
|
|
10708
|
+
* | `#ff00ff` | `true` | 3.14:1 | fails AA text |
|
|
10709
|
+
* | `#00ff00` | `false` | 1.37:1 | fails AA text |
|
|
10710
|
+
* | `#0000ff` | `true` | 8.59:1 | passes |
|
|
10711
|
+
*
|
|
10712
|
+
* A caller picking text colour from this gets the wrong answer on both failing
|
|
10713
|
+
* cases. It is kept because choosing a Stripe preset is a legitimate and
|
|
10714
|
+
* different question.
|
|
10715
|
+
*
|
|
10716
|
+
* Inputs that are not a 3-/6-digit hex fall through to "light", the safer
|
|
10717
|
+
* assumption for the default palette.
|
|
10718
|
+
*/
|
|
10315
10719
|
declare function isDarkSurface(color: string): boolean;
|
|
10316
10720
|
declare const DEFAULT_BADGES: TrustBadge[];
|
|
10317
10721
|
declare const DEFAULT_BADGES_DARK: TrustBadge[];
|
|
@@ -11261,4 +11665,4 @@ declare const decodeNativePanes: typeof decodePanes;
|
|
|
11261
11665
|
/** @deprecated Renamed to {@link encodePanes}. Removed in 0.112.0. */
|
|
11262
11666
|
declare const encodeNativePanes: typeof encodePanes;
|
|
11263
11667
|
|
|
11264
|
-
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, Audit, 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, type CardSpecificFeatures, Cards, type ChangePasswordRequest, type CheckoutBranding, type CheckoutBrandingResponse, 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 ConnectorFeatureMatrixEntry, type ConnectorIntegrationStatus, type ConnectorListResponse, type ConnectorOwnership, type ConnectorResponse, type ConnectorRisk, 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 DecidePendingOperationRequest, type DeleteAccountRequest, type DeleteUserRoleRequest, Delopay, DelopayAuthenticationError, type DelopayConnectorCategory, DelopayError, type DelopayLogger, type DelopayOptions, type DeviceAnalyticsChild, type DeviceAnalyticsTotals, type DeviceBrowserSlice, type DeviceChannelBucket, type DeviceClassSlice, type DeviceDrillRequest, type DeviceModelSlice, type DevicePlatformSlice, type DeviceSessionBucket, type DevicesAnalyticsResponse, type DisputeEvidenceBlock, type DisputeEvidenceRequest, type DisputeEvidenceType, type DisputeListParams, type DisputeResponse, type DisputeStage, type DisputeStatus, type DrillPayment, type DrillResponse, type EncodedBranding, type EntityType, 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 FeatureMatrixResponse, type FeatureStatus, 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 GeoDrillRequest, type GeoLanguageSlice, type GetSubscriptionItemsParams, type GetSubscriptionItemsResponse, type GlobalSearchRequest, type GroupNode, type ImpersonateEmployeeRequest, type IntentStatus, type InviteUsersRequest, type InviteUsersResponse, type InvoiceAmountState, type InvoiceOutcomes, 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 MarginQuality, type MerchantAccountCreateRequest, type MerchantAccountResponse, type MerchantAccountType, type MerchantAccountUpdateRequest, type MerchantAuditActorInfo, type MerchantAuditActorKind, type MerchantAuditImpersonationKind, type MerchantAuditLogEntry, type MerchantAuditLogListParams, type MerchantAuditLogListResponse, type MerchantAuditSessionInfo, type MerchantConnectorWebhookDetailsUpdate, type MerchantOverviewResponse, type MerchantOverviewStat, type MerchantRisk, type MerchantRoutingAlgorithm, type MethodSurcharge, type MinimalRoleInfo, NATIVE_PANES_MAX, NATIVE_PANE_CATEGORY_KEYS, NATIVE_PANE_ICON_KEYS, type NativePaneCapability, type NativePaneMethodInfo, type NativePaneOpenTarget, type NativePaneRail, type NativePaneView, type NativePaneVisibility, type NativePanesCatalogResponse, type NativePanesConnectorCatalog, type NonPillRadius, type OperationLimitOnExceeded, type OperationLimitRule, type OperationLimitRuleDeleteResponse, type OperationLimitRuleListParams, type OperationLimitScope, type OperationLimitSettings, type OperationLimitWindowMode, OperationLimits, type OverrideAction, type OverrideScope, PANES_MAX, PANE_CATEGORY_KEYS, PANE_ICON_KEYS, type Pane, type PaneCapability, type PaneDisplayDefaults, type PaneIssue, type PaneIssueCode, type PaneMethodInfo, type PaneOpenTarget, type PaneRail, type PaneView, type PaneVisibility, type PanesCatalogResponse, type PanesConnectorCatalog, 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 PendingApprovalErrorDetails, type PendingOperation, type PendingOperationLimitContext, type PendingOperationListParams, type PendingOperationListResponse, type PendingOperationStatus, type PendingOperationSummary, type PerMethodSurchargeItem, type PermissionScope, type PhoneDetails, type PhoneOtpRequest, type PhoneOtpResponse, type PhoneOtpVerifyRequest, type PhoneOtpVerifyResponse, type PlanSlice, type PlatformFeeKind, type PlatformFeeOutput, type PlatformFeeProgram, type PlatformFeeRule, type PlatformFeeRuleInput, type PlatformFeeRuleOutput, type PlatformFeeRuleRecord, type PlatformFeeRuleRequest, type PollStatus, type PollStatusResponse, type ProcessorCostBasis, type ProcessorCostBucket, type ProcessorCostSource, type ProcessorSlice, 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, Risk, type RoleConnectorGrant, type RoleConnectorGrantEntry, type RoutableConnectorChoice, type RoutingActivatePayload, type RoutingAlgorithmKind, type RoutingConfigCreateRequest, type RoutingConfigHistoryResponse, type RoutingConfigResponse, type RoutingConfigUpdateRequest, type RoutingConfigVersion, type RoutingConnectorCap, type RoutingConnectorCaps, type RoutingDeactivateRequest, type RoutingDictionary, type RoutingDictionaryRecord, type RoutingHistoryParams, type RuleConnectorSelection, STRIPE_FALLBACK_PANE_CATALOG, STRIPE_FALLBACK_PANE_METHODS, STRIPE_NATIVE_PANE_METHODS, Search, type SearchGroupResponse, type SearchIndex, type SearchStatus, type SearchTimeRange, Settlement, type SettlementBackfillRequest, type SettlementBackfillResponse, type SettlementBucket, type SettlementCostParams, type SettlementCostPeriod, type SettlementCostResponse, 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 ShopRisk, 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 SubscriptionAnalyticsRequest, type SubscriptionAnalyticsResponse, type SubscriptionBillingProcessorResponse, type SubscriptionBucket, type SubscriptionCaveat, type SubscriptionChild, type SubscriptionDrillBase, type SubscriptionDrillRequest, type SubscriptionDrillTarget, type SubscriptionEstimateParams, type SubscriptionEstimateResponse, type SubscriptionFilters, type SubscriptionInvoice, type SubscriptionInvoiceListParams, type SubscriptionInvoiceListResponse, type SubscriptionItem, type SubscriptionItemPrice, type SubscriptionItemType, type SubscriptionLineItem, type SubscriptionListParams, type SubscriptionMovement, type SubscriptionPaymentData, type SubscriptionPaymentDetails, type SubscriptionPaymentLink, type SubscriptionPaymentLookupRequest, type SubscriptionPaymentLookupResponse, type SubscriptionPeriodUnit, type SubscriptionProcessors, type SubscriptionResponse, type SubscriptionStatus, type SubscriptionTotals, Subscriptions, type SummaryPosition, type SupportedPaymentMethod, 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 UpdateRoleConnectorGrantParams, type UpdateSubscriptionRequest, type UpdateUserDetailsRequest, type UpdateUserRoleRequest, type UpsertOperationLimitRuleRequest, type UpsertRefundLimitRuleRequest, type UpsertSettlementAdjustmentLimitRuleRequest, type UpsertSettlementPayoutLimitRuleRequest, 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, clonePane, customFieldContextFromMetadata, customFieldIsTextLike, customFieldOperatorTakesValue, customFieldOptionLabel, customFieldText, decodeBadges, decodeBranding, decodeCustomFields, decodeNativePanes, decodePanes, defaultBranding, defaultCustomFieldVisibility, defaultNativePane, defaultOperatorForSource, defaultPane, emptyPaneCatalog, encodeBadges, encodeBranding, encodeCustomFields, encodeNativePanes, encodePanes, evaluateCustomFieldCondition, evaluateCustomFieldVisibility, feeProgram, focusedCheckoutUrl, fontStack, fontWeightValue, inputPadValue, isCheckboxChecked, isDarkSurface, isHexColor, leaf, logoDimensions, nativePaneMethodInfo, offerablePaneMethods, paneCatalogFor, paneDisplayDefaults, paneMethodInfo, paneRailAllowed, paneViewVisibility, parseCustomFieldsLoose, parseImportedBranding, programToTree, radiusValue, ruleMatchToTree, sanitizeCustomCss, shadowFor, surfacePadValue, validatePanes, verticalGapValue, visibleCustomFields };
|
|
11668
|
+
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 AnalyticsChannel, type AnalyticsChild, type AnalyticsConnectorDay, type AnalyticsConnectorSeries, AnalyticsDashboard, type AnalyticsDayBucket, type AnalyticsGranularity, type AnalyticsMethodSlice, type AnalyticsOutcome, 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, Audit, 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 CancelModeOutcome, type CancelSubscriptionRequest, type CancelSubscriptionResponse, type CaptureMethod, type CardDetail, type CardDetailFromLocker, type CardNetworkTypes, type CardSpecificFeatures, Cards, type ChangePasswordRequest, type CheckoutBranding, type CheckoutBrandingResponse, 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 ClientDrillSortKey, type ConditionNode, type ConfirmSubscriptionPaymentDetails, type ConfirmSubscriptionRequest, type ConfirmSubscriptionResponse, type Connector, type ConnectorCloneRequest, type ConnectorCreateRequest, type ConnectorFeatureMatrixEntry, type ConnectorIntegrationStatus, type ConnectorListResponse, type ConnectorOwnership, type ConnectorResponse, type ConnectorRisk, 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 DecidePendingOperationRequest, type DeleteAccountRequest, type DeleteEvidenceRequest, type DeleteUserRoleRequest, Delopay, DelopayAuthenticationError, type DelopayConnectorCategory, DelopayError, type DelopayLogger, type DelopayOptions, type DeviceAnalyticsChild, type DeviceAnalyticsTotals, type DeviceBrowserSlice, type DeviceChannelBucket, type DeviceClassSlice, type DeviceDrillBase, type DeviceDrillRequest, type DeviceDrillTarget, type DeviceModelSlice, type DevicePlatformSlice, type DeviceSessionBucket, type DevicesAnalyticsResponse, type DisputeEvidenceBlock, type DisputeEvidenceRequest, type DisputeEvidenceType, type DisputeListParams, type DisputeOutcomeReporting, type DisputeResponse, type DisputeStage, type DisputeStatus, type DrillListControls, type DrillPayment, type DrillResponse, type DrillSortKey, type DrillSummary, type EncodedBranding, type EntityType, 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 FeatureMatrixResponse, type FeatureStatus, 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 GeoDrillRequest, type GeoLanguageSlice, type GetSubscriptionItemsParams, type GetSubscriptionItemsResponse, type GlobalSearchRequest, type GroupNode, type ImpersonateEmployeeRequest, type IntentStatus, type InviteUsersRequest, type InviteUsersResponse, type InvoiceAmountState, type InvoiceOutcomes, 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 MarginQuality, type MerchantAccountCreateRequest, type MerchantAccountResponse, type MerchantAccountType, type MerchantAccountUpdateRequest, type MerchantAuditActorInfo, type MerchantAuditActorKind, type MerchantAuditImpersonationKind, type MerchantAuditLogEntry, type MerchantAuditLogListParams, type MerchantAuditLogListResponse, type MerchantAuditSessionInfo, type MerchantConnectorWebhookDetailsUpdate, type MerchantOverviewResponse, type MerchantOverviewStat, type MerchantRisk, type MerchantRoutingAlgorithm, type MethodSurcharge, type MinimalRoleInfo, NATIVE_PANES_MAX, NATIVE_PANE_CATEGORY_KEYS, NATIVE_PANE_ICON_KEYS, type NativePaneCapability, type NativePaneMethodInfo, type NativePaneOpenTarget, type NativePaneRail, type NativePaneView, type NativePaneVisibility, type NativePanesCatalogResponse, type NativePanesConnectorCatalog, type NonPillRadius, type OperationLimitOnExceeded, type OperationLimitRule, type OperationLimitRuleDeleteResponse, type OperationLimitRuleListParams, type OperationLimitScope, type OperationLimitSettings, type OperationLimitWindowMode, OperationLimits, type OverrideAction, type OverrideScope, PANES_MAX, PANE_CATEGORY_KEYS, PANE_ICON_KEYS, type Pane, type PaneCapability, type PaneDisplayDefaults, type PaneIssue, type PaneIssueCode, type PaneMethodInfo, type PaneOpenTarget, type PaneRail, type PaneView, type PaneVisibility, type PanesCatalogResponse, type PanesConnectorCatalog, 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 PendingApprovalErrorDetails, type PendingOperation, type PendingOperationLimitContext, type PendingOperationListParams, type PendingOperationListResponse, type PendingOperationStatus, type PendingOperationSummary, type PerMethodSurchargeItem, type PermissionScope, type PhoneDetails, type PhoneOtpRequest, type PhoneOtpResponse, type PhoneOtpVerifyRequest, type PhoneOtpVerifyResponse, type PlanSlice, type PlatformFeeKind, type PlatformFeeOutput, type PlatformFeeProgram, type PlatformFeeRule, type PlatformFeeRuleInput, type PlatformFeeRuleOutput, type PlatformFeeRuleRecord, type PlatformFeeRuleRequest, type PollStatus, type PollStatusResponse, type ProcessorCostBasis, type ProcessorCostBucket, type ProcessorCostSource, type ProcessorSlice, 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, Risk, type RoleConnectorGrant, type RoleConnectorGrantEntry, type RoutableConnectorChoice, type RoutingActivatePayload, type RoutingAlgorithmKind, type RoutingConfigCreateRequest, type RoutingConfigHistoryResponse, type RoutingConfigResponse, type RoutingConfigUpdateRequest, type RoutingConfigVersion, type RoutingConnectorCap, type RoutingConnectorCaps, type RoutingDeactivateRequest, type RoutingDictionary, type RoutingDictionaryRecord, type RoutingHistoryParams, type RuleConnectorSelection, STRIPE_FALLBACK_PANE_CATALOG, STRIPE_FALLBACK_PANE_METHODS, STRIPE_NATIVE_PANE_METHODS, type ScopeDrillBase, type ScopeDrillRequest, type ScopeDrillSortKey, type ScopeDrillTarget, Search, type SearchGroupResponse, type SearchIndex, type SearchStatus, type SearchTimeRange, Settlement, type SettlementBackfillRequest, type SettlementBackfillResponse, type SettlementBucket, type SettlementCostParams, type SettlementCostPeriod, type SettlementCostResponse, 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 ShopRisk, 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 SubscriptionAnalyticsRequest, type SubscriptionAnalyticsResponse, type SubscriptionBillingProcessorResponse, type SubscriptionBucket, type SubscriptionCaveat, type SubscriptionChild, type SubscriptionDrillBase, type SubscriptionDrillRequest, type SubscriptionDrillSortKey, type SubscriptionDrillTarget, type SubscriptionEstimateParams, type SubscriptionEstimateResponse, type SubscriptionFilters, type SubscriptionInvoice, type SubscriptionInvoiceListParams, type SubscriptionInvoiceListResponse, type SubscriptionItem, type SubscriptionItemPrice, type SubscriptionItemType, type SubscriptionLineItem, type SubscriptionListParams, type SubscriptionMovement, type SubscriptionPaymentData, type SubscriptionPaymentDetails, type SubscriptionPaymentLink, type SubscriptionPaymentLookupRequest, type SubscriptionPaymentLookupResponse, type SubscriptionPeriodUnit, type SubscriptionProcessors, type SubscriptionResponse, type SubscriptionStatus, type SubscriptionTotals, Subscriptions, type SummaryPosition, type SupportedPaymentMethod, 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 TimeToPayBucketLabel, type TimeToPayStats, type TokenPurpose, type TokenResponse, type TopupRequest, type TopupResponse, type TotpResponse, type TransactionType, type TrustBadge, type UpdateMetadataRequest, type UpdateOperationLimitSettingsRequest, type UpdateRoleConnectorGrantParams, type UpdateSubscriptionRequest, type UpdateUserDetailsRequest, type UpdateUserRoleRequest, type UpsertOperationLimitRuleRequest, type UpsertRefundLimitRuleRequest, type UpsertSettlementAdjustmentLimitRuleRequest, type UpsertSettlementPayoutLimitRuleRequest, 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, WCAG_AA_TEXT, WCAG_AA_UI, type WebhookDeliveryAttempt, type WebhookDeliveryTerminalReason, type WebhookDetails, type WebhookEvent, type WebhookRefundStatus, type WebhookRegistrationEnvironment, Webhooks, allOf, anyOf, applyBrandingVariables, buildBrandingExport, buttonPadValue, cloneBranding, cloneCustomField, cloneNativePane, clonePane, contrastRatio, customFieldContextFromMetadata, customFieldIsTextLike, customFieldOperatorTakesValue, customFieldOptionLabel, customFieldText, decodeBadges, decodeBranding, decodeCustomFields, decodeNativePanes, decodePanes, defaultBranding, defaultCustomFieldVisibility, defaultNativePane, defaultOperatorForSource, defaultPane, emptyPaneCatalog, encodeBadges, encodeBranding, encodeCustomFields, encodeNativePanes, encodePanes, evaluateCustomFieldCondition, evaluateCustomFieldVisibility, feeProgram, focusedCheckoutUrl, fontStack, fontWeightValue, inputPadValue, isCheckboxChecked, isDarkSurface, isHexColor, leaf, logoDimensions, nativePaneMethodInfo, offerablePaneMethods, paneCatalogFor, paneDisplayDefaults, paneMethodInfo, paneRailAllowed, paneViewVisibility, parseCustomFieldsLoose, parseImportedBranding, programToTree, radiusValue, ruleMatchToTree, sanitizeCustomCss, shadowFor, surfacePadValue, validatePanes, verticalGapValue, visibleCustomFields };
|