@delopay/sdk 0.134.0 → 0.136.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-R4MDAZWF.js → chunk-GGXTGWV5.js} +100 -2
- package/dist/chunk-GGXTGWV5.js.map +1 -0
- package/dist/index.cjs +99 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +306 -10
- package/dist/index.d.ts +306 -10
- package/dist/index.js +1 -1
- package/dist/internal.cjs +99 -1
- package/dist/internal.cjs.map +1 -1
- package/dist/internal.d.cts +1 -1
- package/dist/internal.d.ts +1 -1
- package/dist/internal.js +1 -1
- package/package.json +1 -1
- package/dist/chunk-R4MDAZWF.js.map +0 -1
package/dist/index.d.ts
CHANGED
|
@@ -462,6 +462,26 @@ interface PaymentResponse {
|
|
|
462
462
|
* one. `null` counts as live everywhere it is filtered on.
|
|
463
463
|
*/
|
|
464
464
|
test_mode?: boolean | null;
|
|
465
|
+
/**
|
|
466
|
+
* Where this payment's money has got to, according to its rail
|
|
467
|
+
* (delopay-backend#865) — for the active attempt, the one every other
|
|
468
|
+
* attempt-level field here describes.
|
|
469
|
+
*
|
|
470
|
+
* Present on the payments list and on retrieve. Absent on the create,
|
|
471
|
+
* confirm and update responses, where it is not computed, and absent for a
|
|
472
|
+
* profile-scoped (shop) viewer, who is not shown the host's settlement with
|
|
473
|
+
* the rail. When present the value is total: `not_recorded` is a value,
|
|
474
|
+
* never `null`. `available` is **not** paid out — see
|
|
475
|
+
* {@link ConnectorSettlementStatus}.
|
|
476
|
+
*/
|
|
477
|
+
connector_settlement_status?: ConnectorSettlementStatus;
|
|
478
|
+
/**
|
|
479
|
+
* How the latest attempt's connector was chosen (delopay-backend#990) —
|
|
480
|
+
* the category of the decision, never the rule. Per attempt, read
|
|
481
|
+
* `payments.listAttempts()`, whose rows carry their own value. `null` on a
|
|
482
|
+
* payment recorded before the backend stored it.
|
|
483
|
+
*/
|
|
484
|
+
routing_approach?: RoutingApproach | null;
|
|
465
485
|
[key: string]: unknown;
|
|
466
486
|
}
|
|
467
487
|
interface PaymentListParams {
|
|
@@ -552,8 +572,31 @@ interface PaymentAttemptResponse {
|
|
|
552
572
|
client_version?: string | null;
|
|
553
573
|
/** Structured failure detail resolved from the unified + raw error info. */
|
|
554
574
|
error_details?: PaymentErrorDetails | null;
|
|
575
|
+
/**
|
|
576
|
+
* The connector account (`mca_…`) this attempt ran on
|
|
577
|
+
* (delopay-backend#990). `null` for an attempt that never reached a
|
|
578
|
+
* connector, and absent for a caller whose connector grant does not cover
|
|
579
|
+
* the account.
|
|
580
|
+
*/
|
|
581
|
+
merchant_connector_id?: string | null;
|
|
582
|
+
/**
|
|
583
|
+
* How this attempt's connector was chosen (delopay-backend#990) — the
|
|
584
|
+
* category of the decision, never the rule. `null` on an attempt recorded
|
|
585
|
+
* before the backend stored it.
|
|
586
|
+
*/
|
|
587
|
+
routing_approach?: RoutingApproach | null;
|
|
555
588
|
[key: string]: unknown;
|
|
556
589
|
}
|
|
590
|
+
/**
|
|
591
|
+
* The mechanism that chose a payment attempt's connector
|
|
592
|
+
* (delopay-backend#990): the **category** of the decision, never the rule
|
|
593
|
+
* itself — which rule, which bucket, is delopay-backend#991. The eight known
|
|
594
|
+
* values are listed; the backend publishes the type as an open string, so a
|
|
595
|
+
* value this SDK has not heard of is passed through as recorded rather than
|
|
596
|
+
* mapped to a neighbour. `default_fallback` is the weak reading — no routing
|
|
597
|
+
* rule matched — and not a claim that a default account was chosen.
|
|
598
|
+
*/
|
|
599
|
+
type RoutingApproach = 'rule_based_routing' | 'volume_based_routing' | 'straight_through_routing' | 'success_rate_exploitation' | 'success_rate_exploration' | 'contract_based_routing' | 'debit_routing' | 'default_fallback' | (string & {});
|
|
557
600
|
/** Response body for `payments.listAttempts` — every attempt on a single payment. */
|
|
558
601
|
interface PaymentAttemptsListResponse {
|
|
559
602
|
/** The number of attempts returned for this payment. */
|
|
@@ -4909,7 +4952,54 @@ type ParentGroup = 'Operations' | 'Refunds'
|
|
|
4909
4952
|
* is built from is already on every payment, and the provider authenticates
|
|
4910
4953
|
* the user itself. `Read` is the only scope.
|
|
4911
4954
|
*/
|
|
4912
|
-
| 'ConnectorDashboard'
|
|
4955
|
+
| 'ConnectorDashboard'
|
|
4956
|
+
/** The merchant's own audit log. Read-only — an audit trail is never edited. */
|
|
4957
|
+
| 'AuditLog'
|
|
4958
|
+
/** The hosted checkout's appearance. */
|
|
4959
|
+
| 'CheckoutBranding'
|
|
4960
|
+
/** Carved out of `Operations`. */
|
|
4961
|
+
| 'Transactions'
|
|
4962
|
+
/** Carved out of `Operations`. */
|
|
4963
|
+
| 'Customers'
|
|
4964
|
+
/** Carved out of `Operations`. */
|
|
4965
|
+
| 'Subscriptions'
|
|
4966
|
+
/** Carved out of `Operations`. Read-only: payouts define no write scope. */
|
|
4967
|
+
| 'Payouts'
|
|
4968
|
+
/** Carved out of `Operations`. */
|
|
4969
|
+
| 'Mandates'
|
|
4970
|
+
/** Carved out of `Operations`. */
|
|
4971
|
+
| 'Disputes'
|
|
4972
|
+
/** Carved out of `Analytics`: the payment-performance surface. */
|
|
4973
|
+
| 'AnalyticsPayments'
|
|
4974
|
+
/** Carved out of `Analytics`: the recurring-revenue surface. */
|
|
4975
|
+
| 'AnalyticsSubscriptions'
|
|
4976
|
+
/** Carved out of `Analytics`: the devices & browsers surface. */
|
|
4977
|
+
| 'AnalyticsDevices'
|
|
4978
|
+
/** Carved out of `Analytics`: the countries & cities surface. */
|
|
4979
|
+
| 'AnalyticsGeo'
|
|
4980
|
+
/** Carved out of `Workflows`. */
|
|
4981
|
+
| 'Routing'
|
|
4982
|
+
/** Carved out of `Workflows`. */
|
|
4983
|
+
| 'Surcharges'
|
|
4984
|
+
/** Carved out of `Workflows`. */
|
|
4985
|
+
| 'ThreeDsDecision'
|
|
4986
|
+
/** Carved out of `Workflows`. */
|
|
4987
|
+
| 'MethodAvailability'
|
|
4988
|
+
/** What `Account` narrows to: the merchant's own details, shops and webhooks. */
|
|
4989
|
+
| 'MerchantSettings'
|
|
4990
|
+
/** Carved out of `Account`. */
|
|
4991
|
+
| 'FeeSchedule'
|
|
4992
|
+
/** Carved out of `Account`: the prepaid balance and its ledger. */
|
|
4993
|
+
| 'BalanceLedger'
|
|
4994
|
+
/** Carved out of `Account`. */
|
|
4995
|
+
| 'Blocklist'
|
|
4996
|
+
/**
|
|
4997
|
+
* Which sites may embed the hosted checkout (`iframe_allowed_origins`, the
|
|
4998
|
+
* checkout's `frame-ancestors` CSP). Carved out of `Account` so "may rename
|
|
4999
|
+
* a shop" and "may decide who can frame our checkout" are separately
|
|
5000
|
+
* grantable.
|
|
5001
|
+
*/
|
|
5002
|
+
| 'IframeOrigins';
|
|
4913
5003
|
/**
|
|
4914
5004
|
* What a role may do to the resources a {@link ParentGroup} names.
|
|
4915
5005
|
*
|
|
@@ -4920,12 +5010,15 @@ type ParentGroup = 'Operations' | 'Refunds'
|
|
|
4920
5010
|
* - `Edit` — create and update, but **not** delete.
|
|
4921
5011
|
* - `Write` — create, update and delete.
|
|
4922
5012
|
*
|
|
4923
|
-
* `Edit` is offered
|
|
4924
|
-
*
|
|
4925
|
-
*
|
|
4926
|
-
*
|
|
5013
|
+
* `Edit` is offered where a resource defines it: `Connectors`, and since
|
|
5014
|
+
* todos#913/#120 also `Customers`, `Subscriptions`, `Settlement` and
|
|
5015
|
+
* `CheckoutBranding`. It was added beneath `Write` rather than a `Delete`
|
|
5016
|
+
* scope being added above it, so `Write` still means exactly what it always
|
|
5017
|
+
* did and no existing role's powers changed — treat `Write` as full control,
|
|
5018
|
+
* including deletion, as before.
|
|
4927
5019
|
*
|
|
4928
|
-
* A role holding `Edit` may add and maintain
|
|
5020
|
+
* A role holding `Edit` may add and maintain the area's records but cannot
|
|
5021
|
+
* remove one.
|
|
4929
5022
|
*/
|
|
4930
5023
|
type PermissionScope = 'Read' | 'Edit' | 'Write';
|
|
4931
5024
|
/**
|
|
@@ -7175,15 +7268,132 @@ interface PaymentListFilterConstraints {
|
|
|
7175
7268
|
end_time?: string | null;
|
|
7176
7269
|
/** `true` = test only, `false` = live only, omitted = both environments. */
|
|
7177
7270
|
test_mode?: boolean | null;
|
|
7271
|
+
/**
|
|
7272
|
+
* Filter by what the rail says about settling the payment
|
|
7273
|
+
* (delopay-backend#865). Values combine as OR, and each is the same word
|
|
7274
|
+
* the row's `connector_settlement_status` carries, so a status read off
|
|
7275
|
+
* one payment can be searched for.
|
|
7276
|
+
*
|
|
7277
|
+
* There is deliberately no "not paid out" value: it would have to fold in
|
|
7278
|
+
* the rails that never report settlement (`unavailable`), the rows nothing
|
|
7279
|
+
* has asked yet (`unknown`) and the attempts with no settlement row
|
|
7280
|
+
* (`not_recorded`), and that would claim a rail is holding money it never
|
|
7281
|
+
* said it held. "Still outstanding" is `pending` + `available` +
|
|
7282
|
+
* `payout_failed`.
|
|
7283
|
+
*/
|
|
7284
|
+
connector_settlement_status?: ConnectorSettlementStatus[] | null;
|
|
7178
7285
|
/** Omitted = backend default (`created`, descending). */
|
|
7179
7286
|
order?: PaymentListOrder | null;
|
|
7180
7287
|
}
|
|
7288
|
+
/**
|
|
7289
|
+
* The filter body `POST /payments/profile/list` accepts
|
|
7290
|
+
* (`payments.listByProfileFilter()`): the merchant-wide constraints minus the
|
|
7291
|
+
* keys the route resolves from the caller's own profile (`profile_id`,
|
|
7292
|
+
* `project_id`) and minus `connector_settlement_status`, which the backend
|
|
7293
|
+
* refuses on this route (403). A profile-scoped viewer is not shown the
|
|
7294
|
+
* settlement state, and a filter it could probe one value at a time would
|
|
7295
|
+
* hand it back through `total_count`.
|
|
7296
|
+
*/
|
|
7297
|
+
type ProfilePaymentListFilterConstraints = Omit<PaymentListFilterConstraints, 'profile_id' | 'project_id' | 'connector_settlement_status'> & {
|
|
7298
|
+
profile_id?: never;
|
|
7299
|
+
project_id?: never;
|
|
7300
|
+
connector_settlement_status?: never;
|
|
7301
|
+
};
|
|
7181
7302
|
/** Response of the filtered payment list endpoints (`count` = page size). */
|
|
7182
7303
|
interface PaymentListFilteredResponse {
|
|
7183
7304
|
count: number;
|
|
7184
7305
|
total_count: number;
|
|
7185
7306
|
data: PaymentResponse[];
|
|
7186
7307
|
}
|
|
7308
|
+
/**
|
|
7309
|
+
* Where one attempt's money has got to, according to its rail
|
|
7310
|
+
* (delopay-backend#865). **Not** the hosted-shop `SettlementPayoutStatus`,
|
|
7311
|
+
* which is a host ticking a monthly statement off by hand; this is
|
|
7312
|
+
* acquirer → merchant bank, reported by the rail, per payment.
|
|
7313
|
+
*
|
|
7314
|
+
* Total on purpose: every attempt carries exactly one of these, including
|
|
7315
|
+
* the three that describe an absence, and a client must never default one.
|
|
7316
|
+
*
|
|
7317
|
+
* - `pending` — the rail holds the money and says it has not released it yet.
|
|
7318
|
+
* - `available` — released into the balance the rail holds for this account.
|
|
7319
|
+
* **Not paid out**: the bank transfer is a separate object on a separate
|
|
7320
|
+
* schedule, and an account on a manual payout schedule can sit here
|
|
7321
|
+
* indefinitely. Never render it as "paid out".
|
|
7322
|
+
* - `paid_out` — the rail says it sent this money to a bank account. The only
|
|
7323
|
+
* value entitled to a payout date; `payout_failed` may also carry a reference.
|
|
7324
|
+
* - `payout_failed` — a payout that failed or was reversed, returning the
|
|
7325
|
+
* funds to the rail's balance. **Possibly permanent**: nothing shows the
|
|
7326
|
+
* value later moves to `paid_out` even when the money is paid again, so do
|
|
7327
|
+
* not build "stuck payout" alerting on it clearing itself.
|
|
7328
|
+
* - `unavailable` — this rail does not report settlement at all (Creem,
|
|
7329
|
+
* e-Payouts, Cryptomus, and any rail nobody has wired up). A fact about our
|
|
7330
|
+
* reach, never about the money — it is not "not yet paid out".
|
|
7331
|
+
* - `unknown` — a settlement record exists and this release can read no state
|
|
7332
|
+
* out of it (nothing asked of the rail yet, or a value written by a newer
|
|
7333
|
+
* release).
|
|
7334
|
+
* - `not_recorded` — no settlement record exists for the attempt. Ordinarily
|
|
7335
|
+
* because no capture was ever established, and never proof that no money
|
|
7336
|
+
* moved.
|
|
7337
|
+
*/
|
|
7338
|
+
type ConnectorSettlementStatus = 'pending' | 'available' | 'paid_out' | 'payout_failed' | 'unavailable' | 'unknown' | 'not_recorded';
|
|
7339
|
+
/** One attempt of a payment, and what its rail says about settling it. */
|
|
7340
|
+
interface ConnectorSettlementAttempt {
|
|
7341
|
+
/** `{payment_id}_{n}` — unique per merchant, not globally. */
|
|
7342
|
+
attempt_id: string;
|
|
7343
|
+
/**
|
|
7344
|
+
* The attempt's own payment status, so a `not_recorded` can be read: absent
|
|
7345
|
+
* on a `failure` attempt is the ordinary case; absent on a `charged` one is
|
|
7346
|
+
* a gap worth chasing.
|
|
7347
|
+
*/
|
|
7348
|
+
attempt_status: AttemptStatus;
|
|
7349
|
+
/** The rail this attempt ran on. */
|
|
7350
|
+
connector?: string | null;
|
|
7351
|
+
/** The connector account it ran on. */
|
|
7352
|
+
merchant_connector_id?: string | null;
|
|
7353
|
+
/** Where the money has got to. Always present. */
|
|
7354
|
+
status: ConnectorSettlementStatus;
|
|
7355
|
+
/**
|
|
7356
|
+
* When the rail says the funds became (or become) available in its own
|
|
7357
|
+
* balance — a date, not a promise, and nothing about a bank transfer.
|
|
7358
|
+
* Withheld only beside an `unknown` of the unreadable-value kind.
|
|
7359
|
+
*/
|
|
7360
|
+
available_on?: string | null;
|
|
7361
|
+
/**
|
|
7362
|
+
* The rail's identifier for the batch that carried **or attempted** this
|
|
7363
|
+
* payment to a bank. Present beside `paid_out` and `payout_failed`, and
|
|
7364
|
+
* beside nothing else.
|
|
7365
|
+
*/
|
|
7366
|
+
payout_reference?: string | null;
|
|
7367
|
+
/**
|
|
7368
|
+
* When the rail said the batch carrying this payment would reach a bank —
|
|
7369
|
+
* the payout's own arrival date, **not** `available_on`. Present beside
|
|
7370
|
+
* `paid_out` and nothing else: a date beside `payout_failed` would assert
|
|
7371
|
+
* that money landed. `null` is never a statement that the payment is
|
|
7372
|
+
* unpaid; `status` answers that.
|
|
7373
|
+
*/
|
|
7374
|
+
paid_out_at?: string | null;
|
|
7375
|
+
/**
|
|
7376
|
+
* When this record was last written by Delopay — how fresh the answer is,
|
|
7377
|
+
* not when the rail acted. `null` where there is no record.
|
|
7378
|
+
*/
|
|
7379
|
+
last_recorded_at?: string | null;
|
|
7380
|
+
}
|
|
7381
|
+
/**
|
|
7382
|
+
* Response of `GET /payments/{payment_id}/settlement`
|
|
7383
|
+
* (`payments.settlement()`): what the payment's rail says about settling
|
|
7384
|
+
* each attempt the caller may see, oldest first. Attempts with no settlement
|
|
7385
|
+
* record are listed too, as `not_recorded`.
|
|
7386
|
+
*
|
|
7387
|
+
* A caller narrowed to specific connector accounts receives only the
|
|
7388
|
+
* attempts on connectors it may see, with nothing marking what was omitted —
|
|
7389
|
+
* so `count` is the number returned, never the number that exist.
|
|
7390
|
+
*/
|
|
7391
|
+
interface PaymentConnectorSettlementResponse {
|
|
7392
|
+
payment_id: string;
|
|
7393
|
+
/** How many attempts are in `attempts` — the number returned, never a denominator. */
|
|
7394
|
+
count: number;
|
|
7395
|
+
attempts: ConnectorSettlementAttempt[];
|
|
7396
|
+
}
|
|
7187
7397
|
/** Response of `DELETE /payments/{payment_id}` (soft delete). */
|
|
7188
7398
|
interface PaymentsDeleteResponse {
|
|
7189
7399
|
payment_id: string;
|
|
@@ -8807,8 +9017,56 @@ declare class Customers {
|
|
|
8807
9017
|
total_count: number;
|
|
8808
9018
|
data: CustomerResponse[];
|
|
8809
9019
|
}>;
|
|
9020
|
+
/**
|
|
9021
|
+
* Retrieve one customer, scoped to the authenticated dashboard user's shop
|
|
9022
|
+
* (business profile). The shop-scoped counterpart of {@link retrieve}, and
|
|
9023
|
+
* what makes a shop's own customer list clickable: the list is
|
|
9024
|
+
* `ProfileCustomerRead` while {@link retrieve} is merchant-level, so a shop
|
|
9025
|
+
* member could see a customer they could not open.
|
|
9026
|
+
*
|
|
9027
|
+
* A customer belonging to a sibling shop answers `CustomerNotFound` — the
|
|
9028
|
+
* same answer as a customer that does not exist, deliberately, so one shop
|
|
9029
|
+
* cannot enumerate another's customer ids.
|
|
9030
|
+
*
|
|
9031
|
+
* `GET /customers/profile/{customerId}`
|
|
9032
|
+
*
|
|
9033
|
+
* @param customerId - The unique customer ID.
|
|
9034
|
+
* @returns The customer, with `profile_ids` narrowed to the caller's own shop.
|
|
9035
|
+
*/
|
|
9036
|
+
retrieveByProfile(customerId: string): Promise<CustomerResponse>;
|
|
9037
|
+
/**
|
|
9038
|
+
* Create a customer from a shop, recording that it belongs to that shop so
|
|
9039
|
+
* the shop can see the customer it just created. The shop is taken from the
|
|
9040
|
+
* credential; a caller-chosen `customer_id` is rejected.
|
|
9041
|
+
*
|
|
9042
|
+
* `POST /customers/profile`
|
|
9043
|
+
*
|
|
9044
|
+
* @param params - The customer to create.
|
|
9045
|
+
* @returns The created customer.
|
|
9046
|
+
*/
|
|
9047
|
+
createByProfile(params: CustomerCreateRequest): Promise<CustomerResponse>;
|
|
9048
|
+
/**
|
|
9049
|
+
* Update a customer from a shop, if the customer belongs to that shop.
|
|
9050
|
+
* A sibling shop's customer answers `CustomerNotFound`, as with
|
|
9051
|
+
* {@link retrieveByProfile}.
|
|
9052
|
+
*
|
|
9053
|
+
* `POST /customers/profile/{customerId}`
|
|
9054
|
+
*
|
|
9055
|
+
* @param customerId - The customer ID to update.
|
|
9056
|
+
* @param params - Fields to update.
|
|
9057
|
+
* @returns The updated customer.
|
|
9058
|
+
*/
|
|
9059
|
+
updateByProfile(customerId: string, params: CustomerUpdateRequest): Promise<CustomerResponse>;
|
|
8810
9060
|
/** List mandates for a customer. `GET /customers/{customerId}/mandates` */
|
|
8811
9061
|
listMandates(customerId: string): Promise<Record<string, unknown>[]>;
|
|
9062
|
+
/**
|
|
9063
|
+
* List one customer's mandates, scoped to the caller's shop. Same membership
|
|
9064
|
+
* rule as {@link retrieveByProfile}: a sibling shop's customer answers
|
|
9065
|
+
* `CustomerNotFound` before any mandate is read.
|
|
9066
|
+
*
|
|
9067
|
+
* `GET /customers/profile/{customerId}/mandates`
|
|
9068
|
+
*/
|
|
9069
|
+
listMandatesByProfile(customerId: string): Promise<Record<string, unknown>[]>;
|
|
8812
9070
|
}
|
|
8813
9071
|
|
|
8814
9072
|
/** View and respond to payment disputes and chargebacks. */
|
|
@@ -9360,6 +9618,41 @@ declare class Payments {
|
|
|
9360
9618
|
* ```
|
|
9361
9619
|
*/
|
|
9362
9620
|
listStatusHistory(paymentId: string, options?: RequestExtras): Promise<PaymentStatusHistoryResponse>;
|
|
9621
|
+
/**
|
|
9622
|
+
* What the payment's rail says about settling each attempt: whether the
|
|
9623
|
+
* money is still `pending` in the rail's hands, `available` in its balance
|
|
9624
|
+
* (**not** paid out), `paid_out` to a bank — with the payout's date and
|
|
9625
|
+
* reference — or came back as `payout_failed`; and, for the rest, which
|
|
9626
|
+
* kind of not-knowing applies (`unavailable`, `unknown`, `not_recorded`).
|
|
9627
|
+
* See {@link ConnectorSettlementStatus} for the seven values. The same
|
|
9628
|
+
* status for the active attempt rides on every list row and retrieve as
|
|
9629
|
+
* `connector_settlement_status`, and the list filters on it.
|
|
9630
|
+
*
|
|
9631
|
+
* Not the hosted-shop settlement API under `settlement.*`, which is host →
|
|
9632
|
+
* shop owner and manual; this is acquirer → merchant bank, per payment.
|
|
9633
|
+
*
|
|
9634
|
+
* `GET /payments/{paymentId}/settlement`
|
|
9635
|
+
*
|
|
9636
|
+
* @param paymentId - The payment intent ID.
|
|
9637
|
+
* @param options - Optional per-call extras: extra `headers`, a `timeout`
|
|
9638
|
+
* override, and an `AbortSignal`.
|
|
9639
|
+
* @returns The attempts this caller may see, oldest first, each with its
|
|
9640
|
+
* settlement status.
|
|
9641
|
+
* @throws If the payment does not exist (404), or the caller is a
|
|
9642
|
+
* profile-scoped (shop) role, who is refused rather than shown a redacted
|
|
9643
|
+
* body (403).
|
|
9644
|
+
*
|
|
9645
|
+
* @example
|
|
9646
|
+
* ```typescript
|
|
9647
|
+
* const { attempts } = await delopay.payments.settlement('pay_abc123');
|
|
9648
|
+
* for (const attempt of attempts) {
|
|
9649
|
+
* if (attempt.status === 'paid_out') {
|
|
9650
|
+
* console.log(attempt.paid_out_at, attempt.payout_reference);
|
|
9651
|
+
* }
|
|
9652
|
+
* }
|
|
9653
|
+
* ```
|
|
9654
|
+
*/
|
|
9655
|
+
settlement(paymentId: string, options?: RequestExtras): Promise<PaymentConnectorSettlementResponse>;
|
|
9363
9656
|
/**
|
|
9364
9657
|
* Update an existing payment intent before it is confirmed.
|
|
9365
9658
|
*
|
|
@@ -9452,18 +9745,21 @@ declare class Payments {
|
|
|
9452
9745
|
/** List payments across all shops. `GET /payments/list-all-shops` */
|
|
9453
9746
|
listAllShops(params?: PaymentListParams): Promise<PaymentListResponse>;
|
|
9454
9747
|
/** List payments by filter (POST body). `POST /payments/list` */
|
|
9455
|
-
listByFilter(params:
|
|
9748
|
+
listByFilter(params: PaymentListFilterConstraints): Promise<PaymentListFilteredResponse>;
|
|
9456
9749
|
/**
|
|
9457
9750
|
* List payments by filter, scoped to the caller's profile (the shop-user
|
|
9458
9751
|
* twin of `listByFilter`). The backend narrows to the profile from the
|
|
9459
|
-
* auth context, so `profile_id` / `project_id` must not be sent
|
|
9752
|
+
* auth context, so `profile_id` / `project_id` must not be sent — and
|
|
9753
|
+
* neither may `connector_settlement_status`, which this route refuses
|
|
9754
|
+
* (403): a shop-scoped viewer is not shown the settlement state, and the
|
|
9755
|
+
* type leaves the key out so it cannot be probed through `total_count`.
|
|
9460
9756
|
*
|
|
9461
9757
|
* Not to be confused with {@link Payments.listByProfile}, which is the GET
|
|
9462
9758
|
* cursor variant and rejects this body.
|
|
9463
9759
|
*
|
|
9464
9760
|
* `POST /payments/profile/list`
|
|
9465
9761
|
*/
|
|
9466
|
-
listByProfileFilter(params:
|
|
9762
|
+
listByProfileFilter(params: ProfilePaymentListFilterConstraints, options?: RequestExtras): Promise<PaymentListFilteredResponse>;
|
|
9467
9763
|
/** Get payment filter options. `GET /payments/filter` */
|
|
9468
9764
|
getFilters(params?: Record<string, string | number | undefined>): Promise<Record<string, unknown>>;
|
|
9469
9765
|
/**
|
|
@@ -13316,4 +13612,4 @@ declare const decodeNativePanes: typeof decodePanes;
|
|
|
13316
13612
|
/** @deprecated Renamed to {@link encodePanes}. Removed in 0.112.0. */
|
|
13317
13613
|
declare const encodeNativePanes: typeof encodePanes;
|
|
13318
13614
|
|
|
13319
|
-
export { ALL_CUSTOM_FIELD_CONDITION_SOURCES, ALL_CUSTOM_FIELD_OPERATORS, ALL_CUSTOM_FIELD_TYPES, type AcceptInvitationsPreAuthRequest, type AddUserRequest, type AddUserResponse, type Address, type AddressDetails, type AirwallexApplePayDomainResult, type AirwallexApplePayDomainStatus, type AirwallexApplePayDomainsRegisterRequest, type AirwallexApplePayDomainsRegisterResponse, 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 BinaryExportOptions, 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, CHECKOUT_LOCALES, 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 CardReference, type CardSpecificFeatures, Cards, type ChangePasswordRequest, type CheckoutBranding, type CheckoutBrandingResponse, type CheckoutBrandingUpdate, type CheckoutCustomField, type CheckoutEventKind, type CheckoutLocale, 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 ConnectorCapability, type ConnectorCapabilityState, type ConnectorCloneRequest, type ConnectorCreateRequest, type ConnectorFeatureMatrixEntry, type ConnectorHealthRequirements, type ConnectorHealthResponse, type ConnectorHealthState, type ConnectorHealthUnknownReason, 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 DisputeExportRecord, type DisputeListParams, type DisputeOutcomeReporting, type DisputeResponse, type DisputeStage, type DisputeStatus, type DrillListControls, type DrillPayment, type DrillResponse, type DrillSortKey, type DrillSummary, type DynamicExportOptions, 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 EventManualTriggerRequest, type EventManualTriggerResponse, type EventResponse, type EventType, type ExpenseAllocation, Export, type ExportEnvelope, type ExportFormat, type ExportOptions, 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 HostingFeeTerm, type ImpersonateEmployeeRequest, type IntentStatus, type InvitationEntity, type InviteUsersRequest, type InviteUsersResponse, type InvoiceAmountState, type InvoiceOutcomes, type InvoiceStatus, type InvokeSdkClientNextAction, type JsonExportOptions, LOCALIZABLE_COPY_FIELDS, type LabelStyle, type LayoutStyle, type LeafNode, type LedgerEntry, type LedgerListParams, type LedgerResponse, type LimitedOperation, type LinkedRoutingConfigRetrieveResponse, type ListInvitableRolesParams, type ListUsersInLineageParams, type LocalizableCopyField, type LoginHistoryEntry, type LoginHistoryParams, type LoginHistoryResponse, type LogoShape, type LogoSize, MAX_SECTION_LABEL_LENGTH, MAX_SECTION_ORDER, METHOD_SECTIONS, MIN_SECTION_ORDER, type MandateListParams, type MandateResponse, type MandateRevokedResponse, type MandateStatus, type MandateType, type ManualTriggerEventType, type MarginQuality, type MerchantAccountCreateRequest, type MerchantAccountResponse, type MerchantAccountType, type MerchantAccountUpdateRequest, type MerchantAuditActorInfo, type MerchantAuditActorKind, type MerchantAuditImpersonationKind, type MerchantAuditLogEntry, type MerchantAuditLogExportRecord, type MerchantAuditLogListParams, type MerchantAuditLogListResponse, type MerchantAuditSessionInfo, type MerchantConnectorWebhookDetailsUpdate, type MerchantOverviewResponse, type MerchantOverviewStat, type MerchantRisk, type MerchantRoutingAlgorithm, type MethodSectionLabels, type MethodSectionOrder, type MethodSectionSpec, type MethodSurcharge, type MinimalRoleInfo, NATIVE_ELEMENT_POSITIONS, NATIVE_PANES_MAX, NATIVE_PANE_CATEGORY_KEYS, NATIVE_PANE_ICON_KEYS, type NativeElementPosition, type NativePaneCapability, type NativePaneMethodInfo, type NativePaneNativeElement, type NativePaneOpenTarget, type NativePaneRail, type NativePaneView, type NativePaneVisibility, type NativePanesCatalogResponse, type NativePanesConnectorCatalog, type NextActionCall, type NextActionDataType, type NomupayOppwaCheckoutData, type NonPillRadius, type OperationLimitOnExceeded, type OperationLimitRule, type OperationLimitRuleDeleteResponse, type OperationLimitRuleListParams, type OperationLimitScope, type OperationLimitSettings, type OperationLimitWindowMode, OperationLimits, type OtherNextAction, 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 PaneNativeElement, type PaneOpenTarget, type PanePresetCapability, type PaneRail, type PaneSurcharge, type PaneView, type PaneVisibility, type PanesCatalogResponse, type PanesConnectorCatalog, type ParentGroup, type ParentGroupInfo, type PauseSubscriptionRequest, type PauseSubscriptionResponse, type PaymentAbandonAttemptResponse, 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 PaymentsPostSessionTokensNextAction, type PaymentsPostSessionTokensRequest, type PaymentsPostSessionTokensResponse, type PayoutCreateRequest, type PayoutExportRecord, 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 PeriodExpenseTerm, 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 ProfitCostTerm, type ProgramConnectorSelection, type ProjectCreateRequest, type ProjectResponse, type ProjectStats, type ProjectStatsResponse, type ProjectUpdateRequest, type PublishableKey, RTL_CHECKOUT_LOCALES, type RecordCheckoutEventRequest, type RecordCheckoutEventResponse, type RecoveryCodesResponse, type RefundAggregateResponse, type RefundCreateRequest, type RefundExportRecord, 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 RevenueBasis, Risk, type RoleConnectorGrant, type RoleConnectorGrantEntry, type RoutableConnectorChoice, type RoutingActivatePayload, type RoutingAlgorithmKind, type RoutingConfigCreateRequest, type RoutingConfigDeleteResponse, type RoutingConfigHistoryResponse, type RoutingConfigResponse, type RoutingConfigUpdateRequest, type RoutingConfigVersion, type RoutingConnectorCap, type RoutingConnectorCaps, type RoutingDeactivateRequest, type RoutingDictionary, type RoutingDictionaryRecord, type RoutingHistoryParams, type RoutingVolumeCounter, type RoutingVolumeCounters, type RoutingVolumeScope, type RoutingVolumeWindow, type RuleConnectorSelection, SECTION_ALIASES, STRIPE_FALLBACK_PANE_CATALOG, STRIPE_FALLBACK_PANE_METHODS, STRIPE_NATIVE_PANE_METHODS, SURCHARGE_BORDER_STYLES, SURCHARGE_BORDER_WIDTHS, SURCHARGE_FIGURE_MODES, SURCHARGE_LABEL_MODES, SURCHARGE_POSITIONS, SURCHARGE_SHAPES, SURCHARGE_SIGNS, SURCHARGE_SIZES, SURCHARGE_STYLES, SURCHARGE_WEIGHTS, type SalesRevenueTerm, type ScopeDrillBase, type ScopeDrillRequest, type ScopeDrillSortKey, type ScopeDrillTarget, type SdkNextActionData, 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 SubscriptionExportRecord, 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 SurchargeAmountOperator, type SurchargeBorderStyle, type SurchargeBorderWidth, type SurchargeCondition, type SurchargeConditionSource, type SurchargeCurrencyOperator, type SurchargeDetailsResponse, type SurchargeDirection, type SurchargeFigureMode, type SurchargeFigurePart, type SurchargeFigurePlan, type SurchargeLabelMode, type SurchargeMetadataOperator, type SurchargeOperator, type SurchargePosition, type SurchargeResponse, type SurchargeRuleRequest, type SurchargeRuleResponse, type SurchargeShape, type SurchargeSign, type SurchargeSize, type SurchargeStyle, type SurchargeWeight, type SurfaceStyle, type SwitchMerchantRequest, type SwitchProfileRequest, type TermBearer, 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 TransactionExportParams, type TransactionExportRecord, type TransactionType, type TrustBadge, UNKNOWN_SECTION_ORDER, type UpdateMetadataRequest, type UpdateOperationLimitSettingsRequest, type UpdateRoleConnectorGrantParams, type UpdateSubscriptionRequest, type UpdateUserDetailsRequest, type UpdateUserRoleRequest, type UpsertOperationLimitRuleRequest, type UpsertRefundLimitRuleRequest, type UpsertSettlementAdjustmentLimitRuleRequest, type UpsertSettlementPayoutLimitRuleRequest, type UserInLineage, type UserInvitation, 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, canonicalSectionId, checkoutCopy, checkoutLocaleDir, cloneBranding, cloneCustomField, cloneNativePane, clonePane, compareSections, contrastRatio, copyTranslationsKey, customFieldContextFromMetadata, customFieldIsTextLike, customFieldOperatorTakesValue, customFieldOptionLabel, customFieldText, decodeBadges, decodeBranding, decodeCustomFields, decodeMethodSectionLabels, decodeMethodSectionOrder, decodeNativePanes, decodePanes, defaultBranding, defaultCustomFieldVisibility, defaultMethodSectionOrder, defaultNativePane, defaultOperatorForSource, defaultPane, emptyPaneCatalog, encodeBadges, encodeBranding, encodeCustomFields, encodeMethodSectionLabels, encodeMethodSectionOrder, encodeNativePanes, encodePanes, evaluateCustomFieldCondition, evaluateCustomFieldVisibility, feeProgram, focusedCheckoutUrl, fontStack, fontWeightValue, inputPadValue, isCheckboxChecked, isDarkSurface, isHexColor, knownSectionLabelKey, leaf, logoDimensions, nativePaneMethodInfo, offerablePaneMethods, paneCatalogFor, paneDisplayDefaults, paneMethodInfo, paneRailAllowed, paneViewVisibility, parseCustomFieldsLoose, parseImportedBranding, programToTree, radiusValue, readableInkOn, ruleMatchToTree, sanitizeCustomCss, sectionLabel, sectionOrderOf, shadowFor, surchargeFigurePlan, surchargeShowsLabel, surchargeStyleDrawsAShape, surchargeWordFor, surfacePadValue, validSectionOrder, validatePanes, verticalGapValue, visibleCustomFields };
|
|
13615
|
+
export { ALL_CUSTOM_FIELD_CONDITION_SOURCES, ALL_CUSTOM_FIELD_OPERATORS, ALL_CUSTOM_FIELD_TYPES, type AcceptInvitationsPreAuthRequest, type AddUserRequest, type AddUserResponse, type Address, type AddressDetails, type AirwallexApplePayDomainResult, type AirwallexApplePayDomainStatus, type AirwallexApplePayDomainsRegisterRequest, type AirwallexApplePayDomainsRegisterResponse, 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 BinaryExportOptions, 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, CHECKOUT_LOCALES, 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 CardReference, type CardSpecificFeatures, Cards, type ChangePasswordRequest, type CheckoutBranding, type CheckoutBrandingResponse, type CheckoutBrandingUpdate, type CheckoutCustomField, type CheckoutEventKind, type CheckoutLocale, 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 ConnectorCapability, type ConnectorCapabilityState, type ConnectorCloneRequest, type ConnectorCreateRequest, type ConnectorFeatureMatrixEntry, type ConnectorHealthRequirements, type ConnectorHealthResponse, type ConnectorHealthState, type ConnectorHealthUnknownReason, type ConnectorIntegrationStatus, type ConnectorListResponse, type ConnectorOwnership, type ConnectorResponse, type ConnectorRisk, type ConnectorSelection, type ConnectorSettlementAttempt, type ConnectorSettlementStatus, 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 DisputeExportRecord, type DisputeListParams, type DisputeOutcomeReporting, type DisputeResponse, type DisputeStage, type DisputeStatus, type DrillListControls, type DrillPayment, type DrillResponse, type DrillSortKey, type DrillSummary, type DynamicExportOptions, 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 EventManualTriggerRequest, type EventManualTriggerResponse, type EventResponse, type EventType, type ExpenseAllocation, Export, type ExportEnvelope, type ExportFormat, type ExportOptions, 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 HostingFeeTerm, type ImpersonateEmployeeRequest, type IntentStatus, type InvitationEntity, type InviteUsersRequest, type InviteUsersResponse, type InvoiceAmountState, type InvoiceOutcomes, type InvoiceStatus, type InvokeSdkClientNextAction, type JsonExportOptions, LOCALIZABLE_COPY_FIELDS, type LabelStyle, type LayoutStyle, type LeafNode, type LedgerEntry, type LedgerListParams, type LedgerResponse, type LimitedOperation, type LinkedRoutingConfigRetrieveResponse, type ListInvitableRolesParams, type ListUsersInLineageParams, type LocalizableCopyField, type LoginHistoryEntry, type LoginHistoryParams, type LoginHistoryResponse, type LogoShape, type LogoSize, MAX_SECTION_LABEL_LENGTH, MAX_SECTION_ORDER, METHOD_SECTIONS, MIN_SECTION_ORDER, type MandateListParams, type MandateResponse, type MandateRevokedResponse, type MandateStatus, type MandateType, type ManualTriggerEventType, type MarginQuality, type MerchantAccountCreateRequest, type MerchantAccountResponse, type MerchantAccountType, type MerchantAccountUpdateRequest, type MerchantAuditActorInfo, type MerchantAuditActorKind, type MerchantAuditImpersonationKind, type MerchantAuditLogEntry, type MerchantAuditLogExportRecord, type MerchantAuditLogListParams, type MerchantAuditLogListResponse, type MerchantAuditSessionInfo, type MerchantConnectorWebhookDetailsUpdate, type MerchantOverviewResponse, type MerchantOverviewStat, type MerchantRisk, type MerchantRoutingAlgorithm, type MethodSectionLabels, type MethodSectionOrder, type MethodSectionSpec, type MethodSurcharge, type MinimalRoleInfo, NATIVE_ELEMENT_POSITIONS, NATIVE_PANES_MAX, NATIVE_PANE_CATEGORY_KEYS, NATIVE_PANE_ICON_KEYS, type NativeElementPosition, type NativePaneCapability, type NativePaneMethodInfo, type NativePaneNativeElement, type NativePaneOpenTarget, type NativePaneRail, type NativePaneView, type NativePaneVisibility, type NativePanesCatalogResponse, type NativePanesConnectorCatalog, type NextActionCall, type NextActionDataType, type NomupayOppwaCheckoutData, type NonPillRadius, type OperationLimitOnExceeded, type OperationLimitRule, type OperationLimitRuleDeleteResponse, type OperationLimitRuleListParams, type OperationLimitScope, type OperationLimitSettings, type OperationLimitWindowMode, OperationLimits, type OtherNextAction, 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 PaneNativeElement, type PaneOpenTarget, type PanePresetCapability, type PaneRail, type PaneSurcharge, type PaneView, type PaneVisibility, type PanesCatalogResponse, type PanesConnectorCatalog, type ParentGroup, type ParentGroupInfo, type PauseSubscriptionRequest, type PauseSubscriptionResponse, type PaymentAbandonAttemptResponse, type PaymentAttemptResponse, type PaymentAttemptsListResponse, type PaymentCancelRequest, type PaymentCaptureRequest, type PaymentClientContextEntry, type PaymentClientContextListResponse, type PaymentConfirmRequest, type PaymentConnectorSettlementResponse, 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 PaymentsPostSessionTokensNextAction, type PaymentsPostSessionTokensRequest, type PaymentsPostSessionTokensResponse, type PayoutCreateRequest, type PayoutExportRecord, 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 PeriodExpenseTerm, 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 ProfilePaymentListFilterConstraints, type ProfileResponse, type ProfileUpdateRequest, type ProfitCostTerm, type ProgramConnectorSelection, type ProjectCreateRequest, type ProjectResponse, type ProjectStats, type ProjectStatsResponse, type ProjectUpdateRequest, type PublishableKey, RTL_CHECKOUT_LOCALES, type RecordCheckoutEventRequest, type RecordCheckoutEventResponse, type RecoveryCodesResponse, type RefundAggregateResponse, type RefundCreateRequest, type RefundExportRecord, 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 RevenueBasis, Risk, type RoleConnectorGrant, type RoleConnectorGrantEntry, type RoutableConnectorChoice, type RoutingActivatePayload, type RoutingAlgorithmKind, type RoutingApproach, type RoutingConfigCreateRequest, type RoutingConfigDeleteResponse, type RoutingConfigHistoryResponse, type RoutingConfigResponse, type RoutingConfigUpdateRequest, type RoutingConfigVersion, type RoutingConnectorCap, type RoutingConnectorCaps, type RoutingDeactivateRequest, type RoutingDictionary, type RoutingDictionaryRecord, type RoutingHistoryParams, type RoutingVolumeCounter, type RoutingVolumeCounters, type RoutingVolumeScope, type RoutingVolumeWindow, type RuleConnectorSelection, SECTION_ALIASES, STRIPE_FALLBACK_PANE_CATALOG, STRIPE_FALLBACK_PANE_METHODS, STRIPE_NATIVE_PANE_METHODS, SURCHARGE_BORDER_STYLES, SURCHARGE_BORDER_WIDTHS, SURCHARGE_FIGURE_MODES, SURCHARGE_LABEL_MODES, SURCHARGE_POSITIONS, SURCHARGE_SHAPES, SURCHARGE_SIGNS, SURCHARGE_SIZES, SURCHARGE_STYLES, SURCHARGE_WEIGHTS, type SalesRevenueTerm, type ScopeDrillBase, type ScopeDrillRequest, type ScopeDrillSortKey, type ScopeDrillTarget, type SdkNextActionData, 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 SubscriptionExportRecord, 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 SurchargeAmountOperator, type SurchargeBorderStyle, type SurchargeBorderWidth, type SurchargeCondition, type SurchargeConditionSource, type SurchargeCurrencyOperator, type SurchargeDetailsResponse, type SurchargeDirection, type SurchargeFigureMode, type SurchargeFigurePart, type SurchargeFigurePlan, type SurchargeLabelMode, type SurchargeMetadataOperator, type SurchargeOperator, type SurchargePosition, type SurchargeResponse, type SurchargeRuleRequest, type SurchargeRuleResponse, type SurchargeShape, type SurchargeSign, type SurchargeSize, type SurchargeStyle, type SurchargeWeight, type SurfaceStyle, type SwitchMerchantRequest, type SwitchProfileRequest, type TermBearer, 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 TransactionExportParams, type TransactionExportRecord, type TransactionType, type TrustBadge, UNKNOWN_SECTION_ORDER, type UpdateMetadataRequest, type UpdateOperationLimitSettingsRequest, type UpdateRoleConnectorGrantParams, type UpdateSubscriptionRequest, type UpdateUserDetailsRequest, type UpdateUserRoleRequest, type UpsertOperationLimitRuleRequest, type UpsertRefundLimitRuleRequest, type UpsertSettlementAdjustmentLimitRuleRequest, type UpsertSettlementPayoutLimitRuleRequest, type UserInLineage, type UserInvitation, 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, canonicalSectionId, checkoutCopy, checkoutLocaleDir, cloneBranding, cloneCustomField, cloneNativePane, clonePane, compareSections, contrastRatio, copyTranslationsKey, customFieldContextFromMetadata, customFieldIsTextLike, customFieldOperatorTakesValue, customFieldOptionLabel, customFieldText, decodeBadges, decodeBranding, decodeCustomFields, decodeMethodSectionLabels, decodeMethodSectionOrder, decodeNativePanes, decodePanes, defaultBranding, defaultCustomFieldVisibility, defaultMethodSectionOrder, defaultNativePane, defaultOperatorForSource, defaultPane, emptyPaneCatalog, encodeBadges, encodeBranding, encodeCustomFields, encodeMethodSectionLabels, encodeMethodSectionOrder, encodeNativePanes, encodePanes, evaluateCustomFieldCondition, evaluateCustomFieldVisibility, feeProgram, focusedCheckoutUrl, fontStack, fontWeightValue, inputPadValue, isCheckboxChecked, isDarkSurface, isHexColor, knownSectionLabelKey, leaf, logoDimensions, nativePaneMethodInfo, offerablePaneMethods, paneCatalogFor, paneDisplayDefaults, paneMethodInfo, paneRailAllowed, paneViewVisibility, parseCustomFieldsLoose, parseImportedBranding, programToTree, radiusValue, readableInkOn, ruleMatchToTree, sanitizeCustomCss, sectionLabel, sectionOrderOf, shadowFor, surchargeFigurePlan, surchargeShowsLabel, surchargeStyleDrawsAShape, surchargeWordFor, surfacePadValue, validSectionOrder, validatePanes, verticalGapValue, visibleCustomFields };
|
package/dist/index.js
CHANGED
package/dist/internal.cjs
CHANGED
|
@@ -1057,10 +1057,68 @@ var Customers = class {
|
|
|
1057
1057
|
query: toQuery(params)
|
|
1058
1058
|
});
|
|
1059
1059
|
}
|
|
1060
|
+
/**
|
|
1061
|
+
* Retrieve one customer, scoped to the authenticated dashboard user's shop
|
|
1062
|
+
* (business profile). The shop-scoped counterpart of {@link retrieve}, and
|
|
1063
|
+
* what makes a shop's own customer list clickable: the list is
|
|
1064
|
+
* `ProfileCustomerRead` while {@link retrieve} is merchant-level, so a shop
|
|
1065
|
+
* member could see a customer they could not open.
|
|
1066
|
+
*
|
|
1067
|
+
* A customer belonging to a sibling shop answers `CustomerNotFound` — the
|
|
1068
|
+
* same answer as a customer that does not exist, deliberately, so one shop
|
|
1069
|
+
* cannot enumerate another's customer ids.
|
|
1070
|
+
*
|
|
1071
|
+
* `GET /customers/profile/{customerId}`
|
|
1072
|
+
*
|
|
1073
|
+
* @param customerId - The unique customer ID.
|
|
1074
|
+
* @returns The customer, with `profile_ids` narrowed to the caller's own shop.
|
|
1075
|
+
*/
|
|
1076
|
+
async retrieveByProfile(customerId) {
|
|
1077
|
+
return this.request("GET", `/customers/profile/${encodeURIComponent(customerId)}`);
|
|
1078
|
+
}
|
|
1079
|
+
/**
|
|
1080
|
+
* Create a customer from a shop, recording that it belongs to that shop so
|
|
1081
|
+
* the shop can see the customer it just created. The shop is taken from the
|
|
1082
|
+
* credential; a caller-chosen `customer_id` is rejected.
|
|
1083
|
+
*
|
|
1084
|
+
* `POST /customers/profile`
|
|
1085
|
+
*
|
|
1086
|
+
* @param params - The customer to create.
|
|
1087
|
+
* @returns The created customer.
|
|
1088
|
+
*/
|
|
1089
|
+
async createByProfile(params) {
|
|
1090
|
+
return this.request("POST", "/customers/profile", { body: params });
|
|
1091
|
+
}
|
|
1092
|
+
/**
|
|
1093
|
+
* Update a customer from a shop, if the customer belongs to that shop.
|
|
1094
|
+
* A sibling shop's customer answers `CustomerNotFound`, as with
|
|
1095
|
+
* {@link retrieveByProfile}.
|
|
1096
|
+
*
|
|
1097
|
+
* `POST /customers/profile/{customerId}`
|
|
1098
|
+
*
|
|
1099
|
+
* @param customerId - The customer ID to update.
|
|
1100
|
+
* @param params - Fields to update.
|
|
1101
|
+
* @returns The updated customer.
|
|
1102
|
+
*/
|
|
1103
|
+
async updateByProfile(customerId, params) {
|
|
1104
|
+
return this.request("POST", `/customers/profile/${encodeURIComponent(customerId)}`, {
|
|
1105
|
+
body: params
|
|
1106
|
+
});
|
|
1107
|
+
}
|
|
1060
1108
|
/** List mandates for a customer. `GET /customers/{customerId}/mandates` */
|
|
1061
1109
|
async listMandates(customerId) {
|
|
1062
1110
|
return this.request("GET", `/customers/${encodeURIComponent(customerId)}/mandates`);
|
|
1063
1111
|
}
|
|
1112
|
+
/**
|
|
1113
|
+
* List one customer's mandates, scoped to the caller's shop. Same membership
|
|
1114
|
+
* rule as {@link retrieveByProfile}: a sibling shop's customer answers
|
|
1115
|
+
* `CustomerNotFound` before any mandate is read.
|
|
1116
|
+
*
|
|
1117
|
+
* `GET /customers/profile/{customerId}/mandates`
|
|
1118
|
+
*/
|
|
1119
|
+
async listMandatesByProfile(customerId) {
|
|
1120
|
+
return this.request("GET", `/customers/profile/${encodeURIComponent(customerId)}/mandates`);
|
|
1121
|
+
}
|
|
1064
1122
|
};
|
|
1065
1123
|
|
|
1066
1124
|
// src/resources/disputes.ts
|
|
@@ -1792,6 +1850,43 @@ var Payments = class {
|
|
|
1792
1850
|
options
|
|
1793
1851
|
);
|
|
1794
1852
|
}
|
|
1853
|
+
/**
|
|
1854
|
+
* What the payment's rail says about settling each attempt: whether the
|
|
1855
|
+
* money is still `pending` in the rail's hands, `available` in its balance
|
|
1856
|
+
* (**not** paid out), `paid_out` to a bank — with the payout's date and
|
|
1857
|
+
* reference — or came back as `payout_failed`; and, for the rest, which
|
|
1858
|
+
* kind of not-knowing applies (`unavailable`, `unknown`, `not_recorded`).
|
|
1859
|
+
* See {@link ConnectorSettlementStatus} for the seven values. The same
|
|
1860
|
+
* status for the active attempt rides on every list row and retrieve as
|
|
1861
|
+
* `connector_settlement_status`, and the list filters on it.
|
|
1862
|
+
*
|
|
1863
|
+
* Not the hosted-shop settlement API under `settlement.*`, which is host →
|
|
1864
|
+
* shop owner and manual; this is acquirer → merchant bank, per payment.
|
|
1865
|
+
*
|
|
1866
|
+
* `GET /payments/{paymentId}/settlement`
|
|
1867
|
+
*
|
|
1868
|
+
* @param paymentId - The payment intent ID.
|
|
1869
|
+
* @param options - Optional per-call extras: extra `headers`, a `timeout`
|
|
1870
|
+
* override, and an `AbortSignal`.
|
|
1871
|
+
* @returns The attempts this caller may see, oldest first, each with its
|
|
1872
|
+
* settlement status.
|
|
1873
|
+
* @throws If the payment does not exist (404), or the caller is a
|
|
1874
|
+
* profile-scoped (shop) role, who is refused rather than shown a redacted
|
|
1875
|
+
* body (403).
|
|
1876
|
+
*
|
|
1877
|
+
* @example
|
|
1878
|
+
* ```typescript
|
|
1879
|
+
* const { attempts } = await delopay.payments.settlement('pay_abc123');
|
|
1880
|
+
* for (const attempt of attempts) {
|
|
1881
|
+
* if (attempt.status === 'paid_out') {
|
|
1882
|
+
* console.log(attempt.paid_out_at, attempt.payout_reference);
|
|
1883
|
+
* }
|
|
1884
|
+
* }
|
|
1885
|
+
* ```
|
|
1886
|
+
*/
|
|
1887
|
+
async settlement(paymentId, options) {
|
|
1888
|
+
return this.request("GET", `/payments/${encodeURIComponent(paymentId)}/settlement`, options);
|
|
1889
|
+
}
|
|
1795
1890
|
/**
|
|
1796
1891
|
* Update an existing payment intent before it is confirmed.
|
|
1797
1892
|
*
|
|
@@ -1963,7 +2058,10 @@ var Payments = class {
|
|
|
1963
2058
|
/**
|
|
1964
2059
|
* List payments by filter, scoped to the caller's profile (the shop-user
|
|
1965
2060
|
* twin of `listByFilter`). The backend narrows to the profile from the
|
|
1966
|
-
* auth context, so `profile_id` / `project_id` must not be sent
|
|
2061
|
+
* auth context, so `profile_id` / `project_id` must not be sent — and
|
|
2062
|
+
* neither may `connector_settlement_status`, which this route refuses
|
|
2063
|
+
* (403): a shop-scoped viewer is not shown the settlement state, and the
|
|
2064
|
+
* type leaves the key out so it cannot be probed through `total_count`.
|
|
1967
2065
|
*
|
|
1968
2066
|
* Not to be confused with {@link Payments.listByProfile}, which is the GET
|
|
1969
2067
|
* cursor variant and rejects this body.
|