@delopay/sdk 0.26.0 → 0.28.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -12,11 +12,10 @@ type PaymentMethod = 'card' | 'card_redirect' | 'pay_later' | 'wallet' | 'bank_r
12
12
  type PaymentMethodType = string;
13
13
  type ConnectorType = 'payment_processor' | 'payment_vas' | 'fin_operations' | 'fiz_operations' | 'networks' | 'banking_entities' | 'non_banking_finance' | 'payout_processor' | 'payment_method_auth' | 'authentication_processor' | 'tax_processor' | 'billing_processor' | 'vault_processor';
14
14
  /**
15
- * Snake-case connector identifiers, mirroring the backend `Connector`
16
- * enum in `crates/common_enums/src/connector_enums.rs`. The trailing
17
- * `string` keeps it open: new connectors land in the backend before the
18
- * SDK is regenerated, so consumers can pass any name without a type
19
- * error. Known names get IDE autocomplete.
15
+ * Snake-case connector identifiers recognized by the Delopay API. The
16
+ * trailing `string` keeps this type open: new connectors may be added
17
+ * to the API before the SDK is updated, so any name can be passed
18
+ * without a type error. Known names get IDE autocomplete.
20
19
  */
21
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' | 'chargebee' | 'checkbook' | 'checkout' | 'coinbase' | 'coingate' | 'creem' | 'cryptomus' | 'cryptopay' | 'ctp_mastercard' | 'ctp_visa' | 'cybersource' | 'cybersourcedecisionmanager' | 'datatrans' | 'delopay_vault' | 'delopaythreedsserver' | 'deutschebank' | 'digitalvirgo' | 'dlocal' | 'dwolla' | 'ebanx' | 'elavon' | 'envoy' | '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' | (string & {});
22
21
  type DisputeStage = 'pre_dispute' | 'dispute' | 'pre_arbitration' | 'arbitration' | 'dispute_reversal';
@@ -347,8 +346,8 @@ interface PaymentListParams {
347
346
  interface PaymentRetrieveOptions {
348
347
  /** Reconcile intent state with the connector before responding. */
349
348
  force_sync?: boolean;
350
- /** Bypass the backend's `should_call_connector` gate so even a
351
- * `requires_payment_method` intent triggers a sync. */
349
+ /** Force a connector sync even for intents in early states like
350
+ * `requires_payment_method` that would otherwise return the local snapshot. */
352
351
  all_keys_required?: boolean;
353
352
  }
354
353
  interface PaymentListResponse {
@@ -758,7 +757,6 @@ interface ProfileLogoUploadResponse {
758
757
  * Event scope when registering a connector webhook.
759
758
  * - `'all_events'`: wildcard registration (cheapest default).
760
759
  * - `{ specific_event: '<EventType>' }`: register only one event type.
761
- * Matches the backend's internally-tagged `ConnectorWebhookEventType`.
762
760
  */
763
761
  type ConnectorWebhookEventType = 'all_events' | {
764
762
  specific_event: string;
@@ -1357,7 +1355,7 @@ interface FromEmailRequest {
1357
1355
  token: string;
1358
1356
  }
1359
1357
  /**
1360
- * Purpose of a single-purpose JWT. The backend decides which purpose to issue
1358
+ * Purpose of a single-purpose JWT. The API decides which purpose to issue
1361
1359
  * next based on the user's current state (e.g. TOTP not set → `totp`, TOTP
1362
1360
  * verified → `reset_password`).
1363
1361
  */
@@ -1376,13 +1374,13 @@ interface VerifyTotpRequest {
1376
1374
  /** Optional query params for `GET /user/2fa/terminate`. */
1377
1375
  interface Terminate2faQueryParams {
1378
1376
  /**
1379
- * Skip the TOTP requirement entirely. Only honored when the backend has
1380
- * `force_two_factor_auth = false`. Use sparingly it weakens security.
1377
+ * Skip the TOTP requirement entirely. Only honored when the server has
1378
+ * `force_two_factor_auth = false`. Use sparingly -- it weakens security.
1381
1379
  */
1382
1380
  skip_two_factor_auth?: boolean;
1383
1381
  }
1384
1382
  /**
1385
- * Optional query for `GET /user/me/login-activity`. Backend clamps `limit`
1383
+ * Optional query for `GET /user/me/login-activity`. The API clamps `limit`
1386
1384
  * to `1..=200` (default 25) and floors `offset` at 0 (default 0).
1387
1385
  */
1388
1386
  interface LoginHistoryParams {
@@ -1407,9 +1405,8 @@ interface LoginHistoryParams {
1407
1405
  * `password`, `magic_link`, `sso_oidc`, `totp`, `recovery_code`.
1408
1406
  *
1409
1407
  * Geo fields (`country_code`, `city`, `latitude`, `longitude`) are populated
1410
- * by an offline MaxMind GeoLite2-City lookup at signin time. They stay
1411
- * `null` for private/loopback IPs, when the lookup misses, or when the
1412
- * GeoIP service is disabled in backend config.
1408
+ * by a GeoIP lookup at signin time. They stay `null` for private/loopback
1409
+ * IPs, when the lookup misses, or when GeoIP is not enabled.
1413
1410
  */
1414
1411
  interface LoginHistoryEntry {
1415
1412
  id: string;
@@ -1429,11 +1426,10 @@ interface LoginHistoryEntry {
1429
1426
  * Response shape for `GET /user/me/login-activity`. `total_count` is the
1430
1427
  * unpaginated row count for client-side page-count calculation.
1431
1428
  *
1432
- * When the authenticated user is a Delopay admin currently impersonating
1433
- * a non-admin merchant via `switch_merchant_for_user_in_org`, the backend
1434
- * returns `entries: []` and `total_count: 0` so the admin's IP / geo
1435
- * doesn't render inside the merchant dashboard. The admin can still see
1436
- * their real activity by switching back to the admin organization.
1429
+ * When a Delopay admin is impersonating a merchant, the API returns
1430
+ * `entries: []` and `total_count: 0` so the admin's IP / geo data is
1431
+ * not exposed inside the merchant dashboard. The admin can still see
1432
+ * their own activity by switching back to the admin organization.
1437
1433
  */
1438
1434
  interface LoginHistoryResponse {
1439
1435
  entries: LoginHistoryEntry[];
@@ -1877,10 +1873,9 @@ interface RegionResponse {
1877
1873
  [key: string]: unknown;
1878
1874
  }
1879
1875
  /**
1880
- * Top-level permission group recognised by the backend. Matches the
1881
- * `ParentGroup` enum in the Delopay backend keep in lock-step.
1882
- * The dashboard / any client that wants to hide buttons for actions
1883
- * the caller can't perform reads this off `getRoleV3()`.
1876
+ * Top-level permission group recognized by the Delopay API. The
1877
+ * dashboard (or any client) uses these to hide UI elements for actions
1878
+ * the caller's role cannot perform, via `getRolePermissions()`.
1884
1879
  */
1885
1880
  type ParentGroup = 'Operations' | 'Connectors' | 'Workflows' | 'Analytics' | 'Users' | 'Account' | 'ReconOps' | 'ReconReports' | 'Internal' | 'Theme' | 'ShopDetails';
1886
1881
  /** Two scopes — `Read` allows viewing, `Write` is required for any mutation. */
@@ -1955,7 +1950,7 @@ declare class Authentication {
1955
1950
  sync(authId: string, params?: Record<string, unknown>): Promise<AuthenticationResponse>;
1956
1951
  /** Redirect after authentication. `POST /authentication/{authId}/redirect` */
1957
1952
  redirect(authId: string, params: Record<string, unknown>): Promise<Record<string, unknown>>;
1958
- /** Enable authn methods token. `POST /authentication/{authId}/enabled_authn_methods_token` */
1953
+ /** Enable authn methods token. `POST /authentication/{authId}/enabled-authn-methods-token` */
1959
1954
  enabledAuthnMethodsToken(authId: string, params: Record<string, unknown>): Promise<Record<string, unknown>>;
1960
1955
  /** Submit eligibility check. `POST /authentication/{authId}/eligibility-check` */
1961
1956
  eligibilityCheck(authId: string, params: Record<string, unknown>): Promise<Record<string, unknown>>;
@@ -2095,13 +2090,13 @@ declare class Connectors {
2095
2090
  * `POST /account/{merchantId}/connectors/webhooks/{connectorId}`
2096
2091
  *
2097
2092
  * @param params - Optional event scope. Defaults to `{ event_type: 'all_events' }`
2098
- * on the backend when omitted; pass `{ event_type: { specific_event: '…' } }`
2099
- * to scope to a single event.
2093
+ * when omitted; pass `{ event_type: { specific_event: '…' } }` to scope
2094
+ * to a single event.
2100
2095
  */
2101
2096
  registerWebhook(merchantId: string, connectorId: string, params?: ConnectorWebhookRegisterRequest): Promise<ConnectorWebhookRegisterResponse>;
2102
2097
  /** Get registered webhooks for a connector. `GET /account/{merchantId}/connectors/webhooks/{connectorId}` */
2103
2098
  getWebhook(merchantId: string, connectorId: string): Promise<ConnectorWebhookListResponse>;
2104
- /** List available payment methods. `GET /account/payment_methods` */
2099
+ /** List available payment methods. `GET /account/payment-methods` */
2105
2100
  listPaymentMethods(): Promise<Record<string, unknown>[]>;
2106
2101
  }
2107
2102
 
@@ -2158,7 +2153,7 @@ declare class Customers {
2158
2153
  * @returns Array of customer objects.
2159
2154
  */
2160
2155
  list(params?: CustomerListParams): Promise<CustomerResponse[]>;
2161
- /** List customers with count. `GET /customers/list_with_count` */
2156
+ /** List customers with count. `GET /customers/list-with-count` */
2162
2157
  listWithCount(params?: CustomerListParams): Promise<{
2163
2158
  count: number;
2164
2159
  total_count: number;
@@ -2383,9 +2378,9 @@ declare class PaymentLinks {
2383
2378
  * @returns Paginated list of payment links.
2384
2379
  */
2385
2380
  list(params?: PaymentLinkListParams): Promise<PaymentLinkListResponse>;
2386
- /** Initiate (render) a payment link page. `GET /payment_link/{merchantId}/{paymentId}` */
2381
+ /** Initiate (render) a payment link page. `GET /payment-link/{merchantId}/{paymentId}` */
2387
2382
  initiate(merchantId: string, paymentId: string): Promise<Record<string, unknown>>;
2388
- /** Get payment link status. `GET /payment_linkstatus/{merchantId}/{paymentId}` */
2383
+ /** Get payment link status. `GET /payment-linkstatus/{merchantId}/{paymentId}` */
2389
2384
  status(merchantId: string, paymentId: string): Promise<Record<string, unknown>>;
2390
2385
  }
2391
2386
 
@@ -2463,27 +2458,27 @@ declare class PaymentMethods {
2463
2458
  * @returns The updated payment method.
2464
2459
  */
2465
2460
  setDefault(customerId: string, methodId: string): Promise<PaymentMethodResponse>;
2466
- /** Migrate a payment method. `POST /payment_methods/migrate` */
2461
+ /** Migrate a payment method. `POST /payment-methods/migrate` */
2467
2462
  migrate(params: Record<string, unknown>): Promise<PaymentMethodResponse>;
2468
- /** Batch migrate payment methods. `POST /payment_methods/migrate-batch` */
2463
+ /** Batch migrate payment methods. `POST /payment-methods/migrate-batch` */
2469
2464
  migrateBatch(params: Record<string, unknown>[]): Promise<Record<string, unknown>>;
2470
- /** Batch update payment methods. `POST /payment_methods/update-batch` */
2465
+ /** Batch update payment methods. `POST /payment-methods/update-batch` */
2471
2466
  updateBatch(params: Record<string, unknown>[]): Promise<Record<string, unknown>>;
2472
- /** Batch retrieve payment methods. `GET /payment_methods/batch` */
2467
+ /** Batch retrieve payment methods. `GET /payment-methods/batch` */
2473
2468
  batchRetrieve(params?: Record<string, string | number | undefined>): Promise<PaymentMethodResponse[]>;
2474
- /** Tokenize a card. `POST /payment_methods/tokenize-card` */
2469
+ /** Tokenize a card. `POST /payment-methods/tokenize-card` */
2475
2470
  tokenizeCard(params: Record<string, unknown>): Promise<Record<string, unknown>>;
2476
- /** Batch tokenize cards. `POST /payment_methods/tokenize-card-batch` */
2471
+ /** Batch tokenize cards. `POST /payment-methods/tokenize-card-batch` */
2477
2472
  tokenizeCardBatch(params: Record<string, unknown>[]): Promise<Record<string, unknown>>;
2478
- /** Initiate payment method collect link flow. `POST /payment_methods/collect` */
2473
+ /** Initiate payment method collect link flow. `POST /payment-methods/collect` */
2479
2474
  collect(params: Record<string, unknown>): Promise<Record<string, unknown>>;
2480
- /** Save a payment method. `POST /payment_methods/{methodId}/save` */
2475
+ /** Save a payment method. `POST /payment-methods/{methodId}/save` */
2481
2476
  save(methodId: string, params?: Record<string, unknown>): Promise<PaymentMethodResponse>;
2482
- /** Create payment method auth link token. `POST /payment_methods/auth/link` */
2477
+ /** Create payment method auth link token. `POST /payment-methods/auth/link` */
2483
2478
  createAuthLink(params: Record<string, unknown>): Promise<Record<string, unknown>>;
2484
- /** Exchange payment method auth token. `POST /payment_methods/auth/exchange` */
2479
+ /** Exchange payment method auth token. `POST /payment-methods/auth/exchange` */
2485
2480
  exchangeAuthToken(params: Record<string, unknown>): Promise<Record<string, unknown>>;
2486
- /** Tokenize card using existing PM. `POST /payment_methods/{methodId}/tokenize-card` */
2481
+ /** Tokenize card using existing PM. `POST /payment-methods/{methodId}/tokenize-card` */
2487
2482
  tokenizeCardForMethod(methodId: string, params: Record<string, unknown>): Promise<Record<string, unknown>>;
2488
2483
  }
2489
2484
 
@@ -2511,13 +2506,12 @@ declare class Payments {
2511
2506
  * Retrieve a payment by its ID.
2512
2507
  *
2513
2508
  * @param paymentId - The unique payment intent ID.
2514
- * @param options - Optional query flags. `force_sync` asks the backend to
2515
- * reconcile state with the connector before returning (used to recover a
2516
- * stuck intent when a webhook was lost). `all_keys_required` lifts the
2517
- * backend's `should_call_connector` gate so a `requires_payment_method`
2518
- * intent can still trigger a sync — without it the backend short-circuits
2519
- * and returns the local snapshot. Both flags are JWT-authenticated dashboard
2520
- * helpers; API-key callers can use them too where the backend allows.
2509
+ * @param options - Optional query flags. `force_sync` reconciles the
2510
+ * intent's state with the connector before returning (useful to recover
2511
+ * a stuck intent when a webhook was lost). `all_keys_required` forces a
2512
+ * connector sync even for intents in early states like
2513
+ * `requires_payment_method` that would otherwise return the local
2514
+ * snapshot. Both flags work with JWT and API-key authentication.
2521
2515
  * @returns The payment intent.
2522
2516
  *
2523
2517
  * @example
@@ -2574,23 +2568,23 @@ declare class Payments {
2574
2568
  * ```
2575
2569
  */
2576
2570
  list(params?: PaymentListParams): Promise<PaymentListResponse>;
2577
- /** Generate session tokens. `POST /payments/session_tokens` */
2571
+ /** Generate session tokens. `POST /payments/session-tokens` */
2578
2572
  sessionTokens(params: Record<string, unknown>): Promise<Record<string, unknown>>;
2579
2573
  /** Retrieve payment with gateway credentials. `POST /payments/sync` */
2580
2574
  sync(params: Record<string, unknown>): Promise<PaymentResponse>;
2581
- /** Cancel after partial capture. `POST /payments/{paymentId}/cancel_post_capture` */
2575
+ /** Cancel after partial capture. `POST /payments/{paymentId}/cancel-post-capture` */
2582
2576
  cancelPostCapture(paymentId: string, params?: Record<string, unknown>): Promise<PaymentResponse>;
2583
- /** Incrementally authorize more funds. `POST /payments/{paymentId}/incremental_authorization` */
2577
+ /** Incrementally authorize more funds. `POST /payments/{paymentId}/incremental-authorization` */
2584
2578
  incrementalAuthorization(paymentId: string, params: Record<string, unknown>): Promise<PaymentResponse>;
2585
- /** Extend authorization window. `POST /payments/{paymentId}/extend_authorization` */
2579
+ /** Extend authorization window. `POST /payments/{paymentId}/extend-authorization` */
2586
2580
  extendAuthorization(paymentId: string, params?: Record<string, unknown>): Promise<PaymentResponse>;
2587
- /** Complete authorization. `POST /payments/{paymentId}/complete_authorize` */
2581
+ /** Complete authorization. `POST /payments/{paymentId}/complete-authorize` */
2588
2582
  completeAuthorize(paymentId: string, params?: Record<string, unknown>): Promise<PaymentResponse>;
2589
- /** Dynamic tax calculation. `POST /payments/{paymentId}/calculate_tax` */
2583
+ /** Dynamic tax calculation. `POST /payments/{paymentId}/calculate-tax` */
2590
2584
  calculateTax(paymentId: string, params: Record<string, unknown>): Promise<Record<string, unknown>>;
2591
- /** Update payment metadata. `POST /payments/{paymentId}/update_metadata` */
2585
+ /** Update payment metadata. `POST /payments/{paymentId}/update-metadata` */
2592
2586
  updateMetadata(paymentId: string, params: Record<string, unknown>): Promise<PaymentResponse>;
2593
- /** Retrieve extended card info. `GET /payments/{paymentId}/extended_card_info` */
2587
+ /** Retrieve extended card info. `GET /payments/{paymentId}/extended-card-info` */
2594
2588
  extendedCardInfo(paymentId: string): Promise<Record<string, unknown>>;
2595
2589
  /** List payments (profile-scoped). `GET /payments/profile/list` */
2596
2590
  listByProfile(params?: PaymentListParams): Promise<PaymentListResponse>;
@@ -2715,9 +2709,9 @@ declare class Profiles {
2715
2709
  list(accountId: string): Promise<ProfileResponse[]>;
2716
2710
  update(accountId: string, profileId: string, params: ProfileUpdateRequest): Promise<ProfileResponse>;
2717
2711
  delete(accountId: string, profileId: string): Promise<ProfileResponse>;
2718
- /** Toggle extended card info for a profile. `POST /account/{accountId}/business_profile/{profileId}/toggle_extended_card_info` */
2712
+ /** Toggle extended card info for a profile. `POST /account/{accountId}/business-profile/{profileId}/toggle-extended-card-info` */
2719
2713
  toggleExtendedCardInfo(accountId: string, profileId: string): Promise<ProfileResponse>;
2720
- /** Toggle connector agnostic MIT. `POST /account/{accountId}/business_profile/{profileId}/toggle_connector_agnostic_mit` */
2714
+ /** Toggle connector agnostic MIT. `POST /account/{accountId}/business-profile/{profileId}/toggle-connector-agnostic-mit` */
2721
2715
  toggleConnectorAgnosticMit(accountId: string, profileId: string): Promise<ProfileResponse>;
2722
2716
  }
2723
2717
 
@@ -3100,11 +3094,11 @@ declare class StripeConnect {
3100
3094
  constructor(request: RequestFn);
3101
3095
  createAccount(params: StripeConnectAccountRequest): Promise<StripeConnectAccountResponse>;
3102
3096
  createAccountLink(params: StripeConnectLinkRequest): Promise<StripeConnectLinkResponse>;
3103
- /** Get onboarding action URL. `POST /connector_onboarding/action_url` */
3097
+ /** Get onboarding action URL. `POST /connector-onboarding/action-url` */
3104
3098
  getActionUrl(params: Record<string, unknown>): Promise<Record<string, unknown>>;
3105
- /** Sync onboarding status. `POST /connector_onboarding/sync` */
3099
+ /** Sync onboarding status. `POST /connector-onboarding/sync` */
3106
3100
  syncOnboarding(params: Record<string, unknown>): Promise<Record<string, unknown>>;
3107
- /** Reset tracking ID. `POST /connector_onboarding/reset_tracking_id` */
3101
+ /** Reset tracking ID. `POST /connector-onboarding/reset-tracking-id` */
3108
3102
  resetTrackingId(params: Record<string, unknown>): Promise<Record<string, unknown>>;
3109
3103
  }
3110
3104
 
@@ -3121,16 +3115,15 @@ declare class Users {
3121
3115
  signIn(params: SignInRequest): Promise<AuthResponse>;
3122
3116
  signOut(): Promise<Record<string, unknown>>;
3123
3117
  /**
3124
- * Paginated login history for the authenticated user IP, User-Agent,
3125
- * country / city / lat-lon (when GeoIP is enabled in backend), success
3126
- * and failure events with their reasons. Strictly scoped to the JWT
3127
- * subject; a user can only see their own activity.
3118
+ * Paginated login history for the authenticated user -- IP, User-Agent,
3119
+ * country / city / lat-lon (when GeoIP is enabled), success and failure
3120
+ * events with their reasons. Strictly scoped to the JWT subject; a user
3121
+ * can only see their own activity.
3128
3122
  *
3129
3123
  * `GET /user/me/login-activity`. Requires a logged-in JWT.
3130
3124
  *
3131
- * The backend returns an empty page when a Delopay admin is impersonating
3132
- * a non-admin merchant, so the admin's metadata never renders inside the
3133
- * merchant dashboard.
3125
+ * Returns an empty page when a Delopay admin is impersonating a merchant,
3126
+ * so the admin's metadata is not exposed inside the merchant dashboard.
3134
3127
  */
3135
3128
  listLoginActivity(params?: LoginHistoryParams): Promise<LoginHistoryResponse>;
3136
3129
  /**
@@ -3162,15 +3155,14 @@ declare class Users {
3162
3155
  update(params: UpdateUserDetailsRequest): Promise<UserResponse>;
3163
3156
  /**
3164
3157
  * Permanently delete the caller's account. Requires a fresh password
3165
- * (and a current 6-digit TOTP code if the user has TOTP enrolled). The
3166
- * backend hard-deletes every `user_roles` row for the caller and soft-
3167
- * deletes the user record itself (`is_active = false`, password / TOTP
3168
- * wiped). On success all in-flight sessions are blacklisted, so the
3169
- * caller should clear local credentials and route to the login page.
3158
+ * (and a current 6-digit TOTP code if the user has TOTP enrolled). On
3159
+ * success all role assignments are removed, the user record is
3160
+ * deactivated, and all in-flight sessions are invalidated. The caller
3161
+ * should clear local credentials and route to the login page.
3170
3162
  *
3171
- * Refuses (`InvalidDeleteOperation`) when the caller is the sole
3172
- * owner-level admin of an org / merchant / profile they must transfer
3173
- * ownership first.
3163
+ * Returns `InvalidDeleteOperation` when the caller is the sole
3164
+ * owner-level admin of an org / merchant / profile -- they must
3165
+ * transfer ownership first.
3174
3166
  */
3175
3167
  deleteAccount(params: DeleteAccountRequest): Promise<Record<string, unknown>>;
3176
3168
  changePassword(params: ChangePasswordRequest): Promise<UserResponse>;
@@ -3275,9 +3267,9 @@ declare class Users {
3275
3267
  getAuthUrl(): Promise<Record<string, unknown>>;
3276
3268
  /** Select auth method. `POST /user/auth/select` */
3277
3269
  selectAuth(params: Record<string, unknown>): Promise<Record<string, unknown>>;
3278
- /** List users in lineage. `GET /user/user/list` */
3270
+ /** List users in lineage. `GET /user/employees/list` */
3279
3271
  listUsersInLineage(): Promise<Record<string, unknown>[]>;
3280
- /** Resend invite. `POST /user/user/resend_invite` */
3272
+ /** Resend invite. `POST /user/employees/resend-invite` */
3281
3273
  resendInvite(params: Record<string, unknown>): Promise<Record<string, unknown>>;
3282
3274
  /**
3283
3275
  * Get the caller's parent permission groups + scopes.
@@ -3295,7 +3287,7 @@ declare class Users {
3295
3287
  listInvitableRoles(params?: ListInvitableRolesParams): Promise<Record<string, unknown>[]>;
3296
3288
  /** List updatable roles. `GET /user/role/list/update` */
3297
3289
  listUpdatableRoles(): Promise<Record<string, unknown>[]>;
3298
- /** Get permission info. `GET /user/permission_info` */
3290
+ /** Get permission info. `GET /user/permission-info` */
3299
3291
  getPermissionInfo(): Promise<Record<string, unknown>>;
3300
3292
  /** Get module list. `GET /user/module/list` */
3301
3293
  getModuleList(): Promise<Record<string, unknown>[]>;
@@ -3347,15 +3339,15 @@ declare class Analytics {
3347
3339
  searchDomain(domain: string, params: Record<string, unknown>): Promise<Record<string, unknown>>;
3348
3340
  /** Get analytics info. `GET /analytics/{domain}/info` */
3349
3341
  getInfo(domain: string): Promise<Record<string, unknown>>;
3350
- /** Get API event logs. `GET /analytics/api_event_logs` */
3342
+ /** Get API event logs. `GET /analytics/api-event-logs` */
3351
3343
  apiEventLogs(params?: Record<string, string | number | undefined>): Promise<Record<string, unknown>>;
3352
- /** Get SDK event logs. `POST /analytics/sdk_event_logs` */
3344
+ /** Get SDK event logs. `POST /analytics/sdk-event-logs` */
3353
3345
  sdkEventLogs(params: Record<string, unknown>): Promise<Record<string, unknown>>;
3354
- /** Get connector event logs. `GET /analytics/connector_event_logs` */
3346
+ /** Get connector event logs. `GET /analytics/connector-event-logs` */
3355
3347
  connectorEventLogs(params?: Record<string, string | number | undefined>): Promise<Record<string, unknown>>;
3356
- /** Get routing event logs. `GET /analytics/routing_event_logs` */
3348
+ /** Get routing event logs. `GET /analytics/routing-event-logs` */
3357
3349
  routingEventLogs(params?: Record<string, string | number | undefined>): Promise<Record<string, unknown>>;
3358
- /** Get outgoing webhook event logs. `GET /analytics/outgoing_webhook_event_logs` */
3350
+ /** Get outgoing webhook event logs. `GET /analytics/outgoing-webhook-event-logs` */
3359
3351
  outgoingWebhookEventLogs(params?: Record<string, string | number | undefined>): Promise<Record<string, unknown>>;
3360
3352
  }
3361
3353
 
@@ -3389,13 +3381,13 @@ declare class Export {
3389
3381
  declare class FeatureMatrix {
3390
3382
  private readonly request;
3391
3383
  constructor(request: RequestFn);
3392
- /** Retrieve the feature matrix. `GET /feature_matrix` */
3384
+ /** Retrieve the feature matrix. `GET /feature-matrix` */
3393
3385
  retrieve(): Promise<Record<string, unknown>>;
3394
3386
  /**
3395
3387
  * Retrieve the feature matrix scoped to a merchant. Beta connectors
3396
3388
  * are filtered against the merchant's allowlist so the dashboard only
3397
3389
  * surfaces connectors the merchant can actually attach.
3398
- * `GET /feature_matrix/{merchantId}`
3390
+ * `GET /feature-matrix/{merchantId}`
3399
3391
  */
3400
3392
  retrieveForMerchant(merchantId: string): Promise<Record<string, unknown>>;
3401
3393
  }
@@ -3416,7 +3408,7 @@ declare class Forex {
3416
3408
  constructor(request: RequestFn);
3417
3409
  /** Retrieve forex rates. `GET /forex/rates` */
3418
3410
  getRates(params?: Record<string, string | number | undefined>): Promise<Record<string, unknown>>;
3419
- /** Convert from minor currency. `GET /forex/convert_from_minor` */
3411
+ /** Convert from minor currency. `GET /forex/convert-from-minor` */
3420
3412
  convertFromMinor(params: Record<string, string | number | undefined>): Promise<Record<string, unknown>>;
3421
3413
  }
3422
3414