@delopay/sdk 0.25.0 → 0.27.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-64E3LG2C.js → chunk-TE4LLC2R.js} +156 -192
- package/dist/chunk-TE4LLC2R.js.map +1 -0
- package/dist/index.cjs +155 -191
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +95 -74
- package/dist/index.d.ts +95 -74
- package/dist/index.js +1 -1
- package/dist/internal.cjs +155 -191
- package/dist/internal.cjs.map +1 -1
- package/dist/internal.d.cts +10 -1
- package/dist/internal.d.ts +10 -1
- package/dist/internal.js +1 -1
- package/package.json +1 -1
- package/dist/chunk-64E3LG2C.js.map +0 -1
package/dist/index.d.cts
CHANGED
|
@@ -877,6 +877,15 @@ interface BillingCompleteSetupRequest {
|
|
|
877
877
|
}
|
|
878
878
|
interface TopupRequest {
|
|
879
879
|
amount: number;
|
|
880
|
+
/**
|
|
881
|
+
* Client-supplied idempotency key. When set, the server passes it to
|
|
882
|
+
* Stripe as `Idempotency-Key` on the PaymentIntent create, so a retry
|
|
883
|
+
* with the same key is collapsed into a single charge. Generate a
|
|
884
|
+
* fresh UUID per click on the dashboard; reuse across retries of the
|
|
885
|
+
* same logical attempt. Optional — omitted requests behave the same
|
|
886
|
+
* as historical SDK calls (no dedup).
|
|
887
|
+
*/
|
|
888
|
+
idempotency_key?: string;
|
|
880
889
|
}
|
|
881
890
|
interface TopupResponse {
|
|
882
891
|
payment_intent_id: string;
|
|
@@ -915,6 +924,15 @@ interface AutoRechargeUpdateRequest {
|
|
|
915
924
|
interface AllocationTransferRequest {
|
|
916
925
|
profile_id: string;
|
|
917
926
|
amount: number;
|
|
927
|
+
/**
|
|
928
|
+
* Client-supplied idempotency key. When set, the server derives a
|
|
929
|
+
* deterministic ledger row id from it so a retry collides on the
|
|
930
|
+
* ledger UNIQUE index and the second call is treated as a
|
|
931
|
+
* success-replay rather than a fresh transfer. Generate a fresh UUID
|
|
932
|
+
* per click; reuse across retries of the same logical attempt.
|
|
933
|
+
* Optional — omitted requests behave as before (no dedup).
|
|
934
|
+
*/
|
|
935
|
+
idempotency_key?: string;
|
|
918
936
|
}
|
|
919
937
|
interface AllocationTransferResponse {
|
|
920
938
|
allocation_id: string;
|
|
@@ -1858,6 +1876,24 @@ interface RegionResponse {
|
|
|
1858
1876
|
region_name: string;
|
|
1859
1877
|
[key: string]: unknown;
|
|
1860
1878
|
}
|
|
1879
|
+
/**
|
|
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()`.
|
|
1884
|
+
*/
|
|
1885
|
+
type ParentGroup = 'Operations' | 'Connectors' | 'Workflows' | 'Analytics' | 'Users' | 'Account' | 'ReconOps' | 'ReconReports' | 'Internal' | 'Theme' | 'ShopDetails';
|
|
1886
|
+
/** Two scopes — `Read` allows viewing, `Write` is required for any mutation. */
|
|
1887
|
+
type PermissionScope = 'Read' | 'Write';
|
|
1888
|
+
/**
|
|
1889
|
+
* One entry in the response of `GET /user/role/v3`. The caller's role
|
|
1890
|
+
* has the listed `scopes` for the resources implied by `name`.
|
|
1891
|
+
*/
|
|
1892
|
+
interface ParentGroupInfo {
|
|
1893
|
+
name: ParentGroup;
|
|
1894
|
+
resources: string[];
|
|
1895
|
+
scopes: PermissionScope[];
|
|
1896
|
+
}
|
|
1861
1897
|
|
|
1862
1898
|
/** Create and manage API keys for a merchant account. */
|
|
1863
1899
|
declare class ApiKeys {
|
|
@@ -1919,7 +1955,7 @@ declare class Authentication {
|
|
|
1919
1955
|
sync(authId: string, params?: Record<string, unknown>): Promise<AuthenticationResponse>;
|
|
1920
1956
|
/** Redirect after authentication. `POST /authentication/{authId}/redirect` */
|
|
1921
1957
|
redirect(authId: string, params: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
1922
|
-
/** Enable authn methods token. `POST /authentication/{authId}/
|
|
1958
|
+
/** Enable authn methods token. `POST /authentication/{authId}/enabled-authn-methods-token` */
|
|
1923
1959
|
enabledAuthnMethodsToken(authId: string, params: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
1924
1960
|
/** Submit eligibility check. `POST /authentication/{authId}/eligibility-check` */
|
|
1925
1961
|
eligibilityCheck(authId: string, params: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
@@ -2065,7 +2101,7 @@ declare class Connectors {
|
|
|
2065
2101
|
registerWebhook(merchantId: string, connectorId: string, params?: ConnectorWebhookRegisterRequest): Promise<ConnectorWebhookRegisterResponse>;
|
|
2066
2102
|
/** Get registered webhooks for a connector. `GET /account/{merchantId}/connectors/webhooks/{connectorId}` */
|
|
2067
2103
|
getWebhook(merchantId: string, connectorId: string): Promise<ConnectorWebhookListResponse>;
|
|
2068
|
-
/** List available payment methods. `GET /account/
|
|
2104
|
+
/** List available payment methods. `GET /account/payment-methods` */
|
|
2069
2105
|
listPaymentMethods(): Promise<Record<string, unknown>[]>;
|
|
2070
2106
|
}
|
|
2071
2107
|
|
|
@@ -2122,7 +2158,7 @@ declare class Customers {
|
|
|
2122
2158
|
* @returns Array of customer objects.
|
|
2123
2159
|
*/
|
|
2124
2160
|
list(params?: CustomerListParams): Promise<CustomerResponse[]>;
|
|
2125
|
-
/** List customers with count. `GET /customers/
|
|
2161
|
+
/** List customers with count. `GET /customers/list-with-count` */
|
|
2126
2162
|
listWithCount(params?: CustomerListParams): Promise<{
|
|
2127
2163
|
count: number;
|
|
2128
2164
|
total_count: number;
|
|
@@ -2347,9 +2383,9 @@ declare class PaymentLinks {
|
|
|
2347
2383
|
* @returns Paginated list of payment links.
|
|
2348
2384
|
*/
|
|
2349
2385
|
list(params?: PaymentLinkListParams): Promise<PaymentLinkListResponse>;
|
|
2350
|
-
/** Initiate (render) a payment link page. `GET /
|
|
2386
|
+
/** Initiate (render) a payment link page. `GET /payment-link/{merchantId}/{paymentId}` */
|
|
2351
2387
|
initiate(merchantId: string, paymentId: string): Promise<Record<string, unknown>>;
|
|
2352
|
-
/** Get payment link status. `GET /
|
|
2388
|
+
/** Get payment link status. `GET /payment-linkstatus/{merchantId}/{paymentId}` */
|
|
2353
2389
|
status(merchantId: string, paymentId: string): Promise<Record<string, unknown>>;
|
|
2354
2390
|
}
|
|
2355
2391
|
|
|
@@ -2427,27 +2463,27 @@ declare class PaymentMethods {
|
|
|
2427
2463
|
* @returns The updated payment method.
|
|
2428
2464
|
*/
|
|
2429
2465
|
setDefault(customerId: string, methodId: string): Promise<PaymentMethodResponse>;
|
|
2430
|
-
/** Migrate a payment method. `POST /
|
|
2466
|
+
/** Migrate a payment method. `POST /payment-methods/migrate` */
|
|
2431
2467
|
migrate(params: Record<string, unknown>): Promise<PaymentMethodResponse>;
|
|
2432
|
-
/** Batch migrate payment methods. `POST /
|
|
2468
|
+
/** Batch migrate payment methods. `POST /payment-methods/migrate-batch` */
|
|
2433
2469
|
migrateBatch(params: Record<string, unknown>[]): Promise<Record<string, unknown>>;
|
|
2434
|
-
/** Batch update payment methods. `POST /
|
|
2470
|
+
/** Batch update payment methods. `POST /payment-methods/update-batch` */
|
|
2435
2471
|
updateBatch(params: Record<string, unknown>[]): Promise<Record<string, unknown>>;
|
|
2436
|
-
/** Batch retrieve payment methods. `GET /
|
|
2472
|
+
/** Batch retrieve payment methods. `GET /payment-methods/batch` */
|
|
2437
2473
|
batchRetrieve(params?: Record<string, string | number | undefined>): Promise<PaymentMethodResponse[]>;
|
|
2438
|
-
/** Tokenize a card. `POST /
|
|
2474
|
+
/** Tokenize a card. `POST /payment-methods/tokenize-card` */
|
|
2439
2475
|
tokenizeCard(params: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
2440
|
-
/** Batch tokenize cards. `POST /
|
|
2476
|
+
/** Batch tokenize cards. `POST /payment-methods/tokenize-card-batch` */
|
|
2441
2477
|
tokenizeCardBatch(params: Record<string, unknown>[]): Promise<Record<string, unknown>>;
|
|
2442
|
-
/** Initiate payment method collect link flow. `POST /
|
|
2478
|
+
/** Initiate payment method collect link flow. `POST /payment-methods/collect` */
|
|
2443
2479
|
collect(params: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
2444
|
-
/** Save a payment method. `POST /
|
|
2480
|
+
/** Save a payment method. `POST /payment-methods/{methodId}/save` */
|
|
2445
2481
|
save(methodId: string, params?: Record<string, unknown>): Promise<PaymentMethodResponse>;
|
|
2446
|
-
/** Create payment method auth link token. `POST /
|
|
2482
|
+
/** Create payment method auth link token. `POST /payment-methods/auth/link` */
|
|
2447
2483
|
createAuthLink(params: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
2448
|
-
/** Exchange payment method auth token. `POST /
|
|
2484
|
+
/** Exchange payment method auth token. `POST /payment-methods/auth/exchange` */
|
|
2449
2485
|
exchangeAuthToken(params: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
2450
|
-
/** Tokenize card using existing PM. `POST /
|
|
2486
|
+
/** Tokenize card using existing PM. `POST /payment-methods/{methodId}/tokenize-card` */
|
|
2451
2487
|
tokenizeCardForMethod(methodId: string, params: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
2452
2488
|
}
|
|
2453
2489
|
|
|
@@ -2538,23 +2574,23 @@ declare class Payments {
|
|
|
2538
2574
|
* ```
|
|
2539
2575
|
*/
|
|
2540
2576
|
list(params?: PaymentListParams): Promise<PaymentListResponse>;
|
|
2541
|
-
/** Generate session tokens. `POST /payments/
|
|
2577
|
+
/** Generate session tokens. `POST /payments/session-tokens` */
|
|
2542
2578
|
sessionTokens(params: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
2543
2579
|
/** Retrieve payment with gateway credentials. `POST /payments/sync` */
|
|
2544
2580
|
sync(params: Record<string, unknown>): Promise<PaymentResponse>;
|
|
2545
|
-
/** Cancel after partial capture. `POST /payments/{paymentId}/
|
|
2581
|
+
/** Cancel after partial capture. `POST /payments/{paymentId}/cancel-post-capture` */
|
|
2546
2582
|
cancelPostCapture(paymentId: string, params?: Record<string, unknown>): Promise<PaymentResponse>;
|
|
2547
|
-
/** Incrementally authorize more funds. `POST /payments/{paymentId}/
|
|
2583
|
+
/** Incrementally authorize more funds. `POST /payments/{paymentId}/incremental-authorization` */
|
|
2548
2584
|
incrementalAuthorization(paymentId: string, params: Record<string, unknown>): Promise<PaymentResponse>;
|
|
2549
|
-
/** Extend authorization window. `POST /payments/{paymentId}/
|
|
2585
|
+
/** Extend authorization window. `POST /payments/{paymentId}/extend-authorization` */
|
|
2550
2586
|
extendAuthorization(paymentId: string, params?: Record<string, unknown>): Promise<PaymentResponse>;
|
|
2551
|
-
/** Complete authorization. `POST /payments/{paymentId}/
|
|
2587
|
+
/** Complete authorization. `POST /payments/{paymentId}/complete-authorize` */
|
|
2552
2588
|
completeAuthorize(paymentId: string, params?: Record<string, unknown>): Promise<PaymentResponse>;
|
|
2553
|
-
/** Dynamic tax calculation. `POST /payments/{paymentId}/
|
|
2589
|
+
/** Dynamic tax calculation. `POST /payments/{paymentId}/calculate-tax` */
|
|
2554
2590
|
calculateTax(paymentId: string, params: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
2555
|
-
/** Update payment metadata. `POST /payments/{paymentId}/
|
|
2591
|
+
/** Update payment metadata. `POST /payments/{paymentId}/update-metadata` */
|
|
2556
2592
|
updateMetadata(paymentId: string, params: Record<string, unknown>): Promise<PaymentResponse>;
|
|
2557
|
-
/** Retrieve extended card info. `GET /payments/{paymentId}/
|
|
2593
|
+
/** Retrieve extended card info. `GET /payments/{paymentId}/extended-card-info` */
|
|
2558
2594
|
extendedCardInfo(paymentId: string): Promise<Record<string, unknown>>;
|
|
2559
2595
|
/** List payments (profile-scoped). `GET /payments/profile/list` */
|
|
2560
2596
|
listByProfile(params?: PaymentListParams): Promise<PaymentListResponse>;
|
|
@@ -2562,10 +2598,8 @@ declare class Payments {
|
|
|
2562
2598
|
listAllShops(params?: PaymentListParams): Promise<PaymentListResponse>;
|
|
2563
2599
|
/** List payments by filter (POST body). `POST /payments/list` */
|
|
2564
2600
|
listByFilter(params: Record<string, unknown>): Promise<PaymentListResponse>;
|
|
2565
|
-
/** Get payment filter options. `
|
|
2566
|
-
getFilters(params?: Record<string,
|
|
2567
|
-
/** Get payment filters (v2). `GET /payments/v2/filter` */
|
|
2568
|
-
getFiltersV2(params?: Record<string, string | number | undefined>): Promise<Record<string, unknown>>;
|
|
2601
|
+
/** Get payment filter options. `GET /payments/filter` */
|
|
2602
|
+
getFilters(params?: Record<string, string | number | undefined>): Promise<Record<string, unknown>>;
|
|
2569
2603
|
/** Get payment aggregates. `GET /payments/aggregate` */
|
|
2570
2604
|
aggregate(params?: Record<string, string | number | undefined>): Promise<Record<string, unknown>>;
|
|
2571
2605
|
/** Get payment aggregates (profile-scoped). `GET /payments/profile/aggregate` */
|
|
@@ -2681,9 +2715,9 @@ declare class Profiles {
|
|
|
2681
2715
|
list(accountId: string): Promise<ProfileResponse[]>;
|
|
2682
2716
|
update(accountId: string, profileId: string, params: ProfileUpdateRequest): Promise<ProfileResponse>;
|
|
2683
2717
|
delete(accountId: string, profileId: string): Promise<ProfileResponse>;
|
|
2684
|
-
/** Toggle extended card info for a profile. `POST /account/{accountId}/
|
|
2718
|
+
/** Toggle extended card info for a profile. `POST /account/{accountId}/business-profile/{profileId}/toggle-extended-card-info` */
|
|
2685
2719
|
toggleExtendedCardInfo(accountId: string, profileId: string): Promise<ProfileResponse>;
|
|
2686
|
-
/** Toggle connector agnostic MIT. `POST /account/{accountId}/
|
|
2720
|
+
/** Toggle connector agnostic MIT. `POST /account/{accountId}/business-profile/{profileId}/toggle-connector-agnostic-mit` */
|
|
2687
2721
|
toggleConnectorAgnosticMit(accountId: string, profileId: string): Promise<ProfileResponse>;
|
|
2688
2722
|
}
|
|
2689
2723
|
|
|
@@ -2803,10 +2837,8 @@ declare class Refunds {
|
|
|
2803
2837
|
list(params?: RefundListParams): Promise<RefundListResponse>;
|
|
2804
2838
|
/** List refunds (profile-scoped). `POST /refunds/profile/list` */
|
|
2805
2839
|
listByProfile(params?: RefundListParams): Promise<RefundListResponse>;
|
|
2806
|
-
/** Get refund filter options. `
|
|
2807
|
-
getFilters(params?: Record<string,
|
|
2808
|
-
/** Get refund filters (v2). `GET /refunds/v2/filter` */
|
|
2809
|
-
getFiltersV2(params?: Record<string, string | number | undefined>): Promise<Record<string, unknown>>;
|
|
2840
|
+
/** Get refund filter options. `GET /refunds/filter` */
|
|
2841
|
+
getFilters(params?: Record<string, string | number | undefined>): Promise<Record<string, unknown>>;
|
|
2810
2842
|
/** Get refund aggregates. `GET /refunds/aggregate` */
|
|
2811
2843
|
aggregate(params?: Record<string, string | number | undefined>): Promise<Record<string, unknown>>;
|
|
2812
2844
|
/** Get refund aggregates (profile-scoped). `GET /refunds/profile/aggregate` */
|
|
@@ -2940,7 +2972,7 @@ declare class Search {
|
|
|
2940
2972
|
constructor(request: RequestFn);
|
|
2941
2973
|
/**
|
|
2942
2974
|
* Search every supported index for `query`.
|
|
2943
|
-
* `POST /analytics/
|
|
2975
|
+
* `POST /analytics/search`
|
|
2944
2976
|
*
|
|
2945
2977
|
* @example
|
|
2946
2978
|
* ```typescript
|
|
@@ -3068,11 +3100,11 @@ declare class StripeConnect {
|
|
|
3068
3100
|
constructor(request: RequestFn);
|
|
3069
3101
|
createAccount(params: StripeConnectAccountRequest): Promise<StripeConnectAccountResponse>;
|
|
3070
3102
|
createAccountLink(params: StripeConnectLinkRequest): Promise<StripeConnectLinkResponse>;
|
|
3071
|
-
/** Get onboarding action URL. `POST /
|
|
3103
|
+
/** Get onboarding action URL. `POST /connector-onboarding/action-url` */
|
|
3072
3104
|
getActionUrl(params: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
3073
|
-
/** Sync onboarding status. `POST /
|
|
3105
|
+
/** Sync onboarding status. `POST /connector-onboarding/sync` */
|
|
3074
3106
|
syncOnboarding(params: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
3075
|
-
/** Reset tracking ID. `POST /
|
|
3107
|
+
/** Reset tracking ID. `POST /connector-onboarding/reset-tracking-id` */
|
|
3076
3108
|
resetTrackingId(params: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
3077
3109
|
}
|
|
3078
3110
|
|
|
@@ -3206,13 +3238,10 @@ declare class Users {
|
|
|
3206
3238
|
verifyRecoveryCode(params: Record<string, unknown>): Promise<AuthResponse>;
|
|
3207
3239
|
sendPhoneOtp(params: PhoneOtpRequest): Promise<PhoneOtpResponse>;
|
|
3208
3240
|
verifyPhoneOtp(params: PhoneOtpVerifyRequest): Promise<PhoneOtpVerifyResponse>;
|
|
3209
|
-
getRoleFromToken(): Promise<Record<string, unknown>>;
|
|
3210
3241
|
listRoles(): Promise<Record<string, unknown>[]>;
|
|
3211
3242
|
listUserRoles(params?: Record<string, unknown>): Promise<Record<string, unknown>[]>;
|
|
3212
3243
|
updateUserRole(params: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
3213
3244
|
deleteUserRole(params: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
3214
|
-
/** Sign in (v2). `POST /user/v2/signin` */
|
|
3215
|
-
signInV2(params: Record<string, unknown>): Promise<AuthResponse>;
|
|
3216
3245
|
/** Sign in via OIDC. `POST /user/oidc` */
|
|
3217
3246
|
signInOidc(params: Record<string, unknown>): Promise<AuthResponse>;
|
|
3218
3247
|
/** Transfer key. `POST /user/key/transfer` */
|
|
@@ -3221,8 +3250,6 @@ declare class Users {
|
|
|
3221
3250
|
listInvitations(): Promise<Record<string, unknown>[]>;
|
|
3222
3251
|
/** Check 2FA status. `GET /user/2fa` */
|
|
3223
3252
|
check2faStatus(): Promise<Record<string, unknown>>;
|
|
3224
|
-
/** Check 2FA status (v2). `GET /user/2fa/v2` */
|
|
3225
|
-
check2faStatusV2(): Promise<Record<string, unknown>>;
|
|
3226
3253
|
/**
|
|
3227
3254
|
* Finish first-time TOTP setup: commit the secret generated by `beginTotp`
|
|
3228
3255
|
* against a 6-digit code from the user's authenticator app.
|
|
@@ -3248,22 +3275,16 @@ declare class Users {
|
|
|
3248
3275
|
getAuthUrl(): Promise<Record<string, unknown>>;
|
|
3249
3276
|
/** Select auth method. `POST /user/auth/select` */
|
|
3250
3277
|
selectAuth(params: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
3251
|
-
/** List
|
|
3252
|
-
listUserRolesV2(params?: Record<string, unknown>): Promise<Record<string, unknown>[]>;
|
|
3253
|
-
/** List users in lineage. `GET /user/user/list` */
|
|
3278
|
+
/** List users in lineage. `GET /user/employees/list` */
|
|
3254
3279
|
listUsersInLineage(): Promise<Record<string, unknown>[]>;
|
|
3255
|
-
/**
|
|
3256
|
-
listUsersInLineageV2(): Promise<Record<string, unknown>[]>;
|
|
3257
|
-
/** Accept invitation (v2). `POST /user/user/invite/accept/v2` */
|
|
3258
|
-
acceptInvitationV2(params: Record<string, unknown>): Promise<AuthResponse>;
|
|
3259
|
-
/** Resend invite. `POST /user/user/resend_invite` */
|
|
3280
|
+
/** Resend invite. `POST /user/employees/resend-invite` */
|
|
3260
3281
|
resendInvite(params: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
3261
|
-
/**
|
|
3262
|
-
|
|
3263
|
-
|
|
3264
|
-
|
|
3265
|
-
|
|
3266
|
-
|
|
3282
|
+
/**
|
|
3283
|
+
* Get the caller's parent permission groups + scopes.
|
|
3284
|
+
*
|
|
3285
|
+
* `GET /user/role`
|
|
3286
|
+
*/
|
|
3287
|
+
getRolePermissions(): Promise<ParentGroupInfo[]>;
|
|
3267
3288
|
/**
|
|
3268
3289
|
* List invitable roles. `GET /user/role/list/invite`
|
|
3269
3290
|
*
|
|
@@ -3274,7 +3295,7 @@ declare class Users {
|
|
|
3274
3295
|
listInvitableRoles(params?: ListInvitableRolesParams): Promise<Record<string, unknown>[]>;
|
|
3275
3296
|
/** List updatable roles. `GET /user/role/list/update` */
|
|
3276
3297
|
listUpdatableRoles(): Promise<Record<string, unknown>[]>;
|
|
3277
|
-
/** Get permission info. `GET /user/
|
|
3298
|
+
/** Get permission info. `GET /user/permission-info` */
|
|
3278
3299
|
getPermissionInfo(): Promise<Record<string, unknown>>;
|
|
3279
3300
|
/** Get module list. `GET /user/module/list` */
|
|
3280
3301
|
getModuleList(): Promise<Record<string, unknown>[]>;
|
|
@@ -3300,13 +3321,13 @@ declare class AnalyticsDomain {
|
|
|
3300
3321
|
private readonly request;
|
|
3301
3322
|
private readonly domain;
|
|
3302
3323
|
constructor(request: RequestFn, domain: string);
|
|
3303
|
-
/** Get metrics. `POST /analytics/
|
|
3324
|
+
/** Get metrics. `POST /analytics/metrics/{domain}` */
|
|
3304
3325
|
metrics(params: Record<string, unknown>, scope?: AnalyticsScope): Promise<Record<string, unknown>>;
|
|
3305
|
-
/** Get filters. `POST /analytics/
|
|
3326
|
+
/** Get filters. `POST /analytics/filters/{domain}` */
|
|
3306
3327
|
filters(params: Record<string, unknown>, scope?: AnalyticsScope): Promise<Record<string, unknown>>;
|
|
3307
|
-
/** Generate report. `POST /analytics/
|
|
3328
|
+
/** Generate report. `POST /analytics/report/{domain}` */
|
|
3308
3329
|
report(params: Record<string, unknown>, scope?: AnalyticsScope): Promise<Record<string, unknown>>;
|
|
3309
|
-
/** Sankey chart data. `POST /analytics/
|
|
3330
|
+
/** Sankey chart data. `POST /analytics/metrics/{domain}/sankey` */
|
|
3310
3331
|
sankey(params: Record<string, unknown>, scope?: AnalyticsScope): Promise<Record<string, unknown>>;
|
|
3311
3332
|
}
|
|
3312
3333
|
declare class Analytics {
|
|
@@ -3320,21 +3341,21 @@ declare class Analytics {
|
|
|
3320
3341
|
readonly apiEvents: AnalyticsDomain;
|
|
3321
3342
|
readonly routing: AnalyticsDomain;
|
|
3322
3343
|
constructor(request: RequestFn);
|
|
3323
|
-
/** Global search. `POST /analytics/
|
|
3344
|
+
/** Global search. `POST /analytics/search` */
|
|
3324
3345
|
search(params: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
3325
|
-
/** Domain-specific search. `POST /analytics/
|
|
3346
|
+
/** Domain-specific search. `POST /analytics/search/{domain}` */
|
|
3326
3347
|
searchDomain(domain: string, params: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
3327
|
-
/** Get analytics info. `GET /analytics/
|
|
3348
|
+
/** Get analytics info. `GET /analytics/{domain}/info` */
|
|
3328
3349
|
getInfo(domain: string): Promise<Record<string, unknown>>;
|
|
3329
|
-
/** Get API event logs. `GET /analytics/
|
|
3350
|
+
/** Get API event logs. `GET /analytics/api-event-logs` */
|
|
3330
3351
|
apiEventLogs(params?: Record<string, string | number | undefined>): Promise<Record<string, unknown>>;
|
|
3331
|
-
/** Get SDK event logs. `POST /analytics/
|
|
3352
|
+
/** Get SDK event logs. `POST /analytics/sdk-event-logs` */
|
|
3332
3353
|
sdkEventLogs(params: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
3333
|
-
/** Get connector event logs. `GET /analytics/
|
|
3354
|
+
/** Get connector event logs. `GET /analytics/connector-event-logs` */
|
|
3334
3355
|
connectorEventLogs(params?: Record<string, string | number | undefined>): Promise<Record<string, unknown>>;
|
|
3335
|
-
/** Get routing event logs. `GET /analytics/
|
|
3356
|
+
/** Get routing event logs. `GET /analytics/routing-event-logs` */
|
|
3336
3357
|
routingEventLogs(params?: Record<string, string | number | undefined>): Promise<Record<string, unknown>>;
|
|
3337
|
-
/** Get outgoing webhook event logs. `GET /analytics/
|
|
3358
|
+
/** Get outgoing webhook event logs. `GET /analytics/outgoing-webhook-event-logs` */
|
|
3338
3359
|
outgoingWebhookEventLogs(params?: Record<string, string | number | undefined>): Promise<Record<string, unknown>>;
|
|
3339
3360
|
}
|
|
3340
3361
|
|
|
@@ -3368,13 +3389,13 @@ declare class Export {
|
|
|
3368
3389
|
declare class FeatureMatrix {
|
|
3369
3390
|
private readonly request;
|
|
3370
3391
|
constructor(request: RequestFn);
|
|
3371
|
-
/** Retrieve the feature matrix. `GET /
|
|
3392
|
+
/** Retrieve the feature matrix. `GET /feature-matrix` */
|
|
3372
3393
|
retrieve(): Promise<Record<string, unknown>>;
|
|
3373
3394
|
/**
|
|
3374
3395
|
* Retrieve the feature matrix scoped to a merchant. Beta connectors
|
|
3375
3396
|
* are filtered against the merchant's allowlist so the dashboard only
|
|
3376
3397
|
* surfaces connectors the merchant can actually attach.
|
|
3377
|
-
* `GET /
|
|
3398
|
+
* `GET /feature-matrix/{merchantId}`
|
|
3378
3399
|
*/
|
|
3379
3400
|
retrieveForMerchant(merchantId: string): Promise<Record<string, unknown>>;
|
|
3380
3401
|
}
|
|
@@ -3395,7 +3416,7 @@ declare class Forex {
|
|
|
3395
3416
|
constructor(request: RequestFn);
|
|
3396
3417
|
/** Retrieve forex rates. `GET /forex/rates` */
|
|
3397
3418
|
getRates(params?: Record<string, string | number | undefined>): Promise<Record<string, unknown>>;
|
|
3398
|
-
/** Convert from minor currency. `GET /forex/
|
|
3419
|
+
/** Convert from minor currency. `GET /forex/convert-from-minor` */
|
|
3399
3420
|
convertFromMinor(params: Record<string, string | number | undefined>): Promise<Record<string, unknown>>;
|
|
3400
3421
|
}
|
|
3401
3422
|
|
|
@@ -3876,4 +3897,4 @@ declare function parseImportedBranding(raw: unknown): CheckoutBranding;
|
|
|
3876
3897
|
declare function applyBrandingVariables(el: HTMLElement, b: CheckoutBranding): void;
|
|
3877
3898
|
declare function shadowFor(style: SurfaceStyle): string;
|
|
3878
3899
|
|
|
3879
|
-
export { type Address, type AddressDetails, type AllocationListResponse, type AllocationResponse, type AllocationTransferRequest, type AllocationTransferResponse, Analytics, AnalyticsDashboard, type ApiKeyCreateRequest, type ApiKeyCreateResponse, type ApiKeyExpiration, type ApiKeyResponse, type ApiKeyRevokeResponse, type ApiKeyUpdateRequest, type ApplePayVerificationRequest, type ApplePayVerificationResponse, type ApplePayVerifiedDomainsResponse, type AuthResponse, type AuthenticationCreateRequest, type AuthenticationResponse, type AuthenticationStatus, type AuthenticationType, type AutoRechargeConfig, type AutoRechargeUpdateRequest, BRANDING_EXPORT_FORMAT, BRANDING_EXPORT_VERSION, type BillingCompleteSetupRequest, type BillingProfileResponse, type BillingSetupRequest, type BillingSetupResponse, type BlocklistAddRequest, type BlocklistDataKind, type BlocklistResponse, type BrandingExport, type BrandingSource, type BusinessPaymentLinkConfig, CUSTOM_CSS_MAX_LENGTH, type CaptureMethod, type CardDetail, type CardDetailFromLocker, Cards, type ChangePasswordRequest, type CheckoutBranding, type Connector, type ConnectorCreateRequest, type ConnectorListResponse, type ConnectorResponse, type ConnectorType, type ConnectorUpdateRequest, type ConnectorVolumeSplit, type ConnectorWebhookEntry, type ConnectorWebhookEventType, type ConnectorWebhookListResponse, type ConnectorWebhookRegisterRequest, type ConnectorWebhookRegisterResponse, type CornerRadius, type Currency, type CustomerCreateRequest, type CustomerListParams, type CustomerPaymentMethodsListParams, type CustomerPaymentMethodsListResponse, type CustomerResponse, type CustomerUpdateRequest, DEFAULT_BADGES, DEFAULT_BADGES_DARK, DEFAULT_BRANDING, DEFAULT_BRANDING_DARK, type DeleteAccountRequest, Delopay, DelopayAuthenticationError, DelopayError, type DelopayLogger, type DelopayOptions, type DisputeEvidenceRequest, type DisputeListParams, type DisputeResponse, type DisputeStage, type DisputeStatus, type EncodedBranding, type EphemeralKeyCreateRequest, type EphemeralKeyCreateResponse, type EventClass, type EventDeliveryAttemptResponse, type EventDetailResponse, type EventListParams, type EventListResponse, type EventResponse, type EventType, Export, FeatureMatrix, type FeeOwner, type FeeScheduleCreateRequest, type FeeScheduleResponse, type FeeScheduleUpdateRequest, type FeeType, Files, type FontFamily, type FontWeight, Forex, type ForgotPasswordRequest, type FromEmailRequest, type GatewayConnectRequest, type GatewayResponse, type GlobalSearchRequest, type IntentStatus, type InviteUsersRequest, type InviteUsersResponse, type LabelStyle, type LayoutStyle, type LedgerEntry, type LedgerListParams, type LedgerResponse, type LinkedRoutingConfigRetrieveResponse, type ListInvitableRolesParams, type LoginHistoryEntry, type LoginHistoryParams, type LoginHistoryResponse, type LogoShape, type LogoSize, type MandateListParams, type MandateResponse, type MandateRevokedResponse, type MandateStatus, type MandateType, type MerchantAccountCreateRequest, type MerchantAccountResponse, type MerchantAccountType, type MerchantAccountUpdateRequest, type MerchantOverviewResponse, type MerchantOverviewStat, type MerchantRoutingAlgorithm, type NonPillRadius, type PaymentCancelRequest, type PaymentCaptureRequest, type PaymentConfirmRequest, type PaymentCreateRequest, type PaymentLayout, type PaymentLinkBackgroundImageConfig, type PaymentLinkConfigRequest, type PaymentLinkListParams, type PaymentLinkListResponse, type PaymentLinkResponse, type PaymentLinkTransactionDetails, type PaymentListParams, type PaymentListResponse, type PaymentMethod, type PaymentMethodCreateRequest, type PaymentMethodDeleteResponse, type PaymentMethodListParams, type PaymentMethodResponse, type PaymentMethodType, type PaymentMethodUpdateRequest, type PaymentResponse, type PaymentRetrieveOptions, type PaymentUpdateRequest, type PayoutCreateRequest, type PayoutListParams, type PayoutListResponse, type PayoutResponse, type PayoutStatus, type PayoutType, type PayoutUpdateRequest, type PhoneDetails, type PhoneOtpRequest, type PhoneOtpResponse, type PhoneOtpVerifyRequest, type PhoneOtpVerifyResponse, type PollStatus, type PollStatusResponse, type ProfileAcquirerCreateRequest, type ProfileAcquirerResponse, type ProfileAcquirerUpdateRequest, type ProfileCreateRequest, type ProfileDefaultRoutingConfig, type ProfileLogoUploadResponse, type ProfileResponse, type ProfileUpdateRequest, type ProjectCreateRequest, type ProjectResponse, type ProjectStats, type ProjectStatsResponse, type ProjectUpdateRequest, type RecoveryCodesResponse, type RefundCreateRequest, type RefundListParams, type RefundListResponse, type RefundResponse, type RefundStatus, type RefundType, type RefundUpdateRequest, type RegionCreateRequest, type RegionResponse, type RegionUpdateRequest, Regions, type RelayRequest, type RelayResponse, type RelayStatus, type RelayType, type RequestFn, type RequestOptions, type ResetPasswordRequest, type RoutableConnectorChoice, type RoutingActivatePayload, type RoutingConfigCreateRequest, type RoutingConfigResponse, type RoutingDeactivateRequest, type RoutingDictionary, type RoutingDictionaryRecord, Search, type SearchGroupResponse, type SearchIndex, type SearchStatus, type ShopCreateRequest, type ShopResponse, type ShopStats, type ShopUpdateRequest, type SignInRequest, type SignUpRequest, type SignUpWithMerchantIdRequest, type SignUpWithMerchantRequest, type SizeScale, type SpacingScale, type StaticRoutingAlgorithm, type StripeConnectAccountRequest, type StripeConnectAccountResponse, type StripeConnectLinkRequest, type StripeConnectLinkResponse, type SubscriptionCreateRequest, type SubscriptionListParams, type SubscriptionListResponse, type SubscriptionResponse, type SubscriptionUpdateRequest, Subscriptions, type SummaryPosition, type SurfaceStyle, type SwitchMerchantRequest, type SwitchProfileRequest, type Terminate2faQueryParams, type ThreeDSDecision, type ThreeDsRuleExecuteRequest, type ThreeDsRuleResponse, type TierSummary, type TokenPurpose, type TokenResponse, type TopupRequest, type TopupResponse, type TotpResponse, type TransactionType, type TrustBadge, type UpdateUserDetailsRequest, type UserResponse, type UserSessionEntry, type UserSessionListResponse, type UserSessionRevokeResponse, type VerifyTotpRequest, type WebhookDeliveryAttempt, type WebhookEvent, Webhooks, applyBrandingVariables, buildBrandingExport, buttonPadValue, cloneBranding, decodeBadges, decodeBranding, defaultBranding, encodeBadges, encodeBranding, fontStack, fontWeightValue, inputPadValue, isDarkSurface, isHexColor, logoDimensions, parseImportedBranding, radiusValue, sanitizeCustomCss, shadowFor, surfacePadValue, verticalGapValue };
|
|
3900
|
+
export { type Address, type AddressDetails, type AllocationListResponse, type AllocationResponse, type AllocationTransferRequest, type AllocationTransferResponse, Analytics, AnalyticsDashboard, type ApiKeyCreateRequest, type ApiKeyCreateResponse, type ApiKeyExpiration, type ApiKeyResponse, type ApiKeyRevokeResponse, type ApiKeyUpdateRequest, type ApplePayVerificationRequest, type ApplePayVerificationResponse, type ApplePayVerifiedDomainsResponse, type AuthResponse, type AuthenticationCreateRequest, type AuthenticationResponse, type AuthenticationStatus, type AuthenticationType, type AutoRechargeConfig, type AutoRechargeUpdateRequest, BRANDING_EXPORT_FORMAT, BRANDING_EXPORT_VERSION, type BillingCompleteSetupRequest, type BillingProfileResponse, type BillingSetupRequest, type BillingSetupResponse, type BlocklistAddRequest, type BlocklistDataKind, type BlocklistResponse, type BrandingExport, type BrandingSource, type BusinessPaymentLinkConfig, CUSTOM_CSS_MAX_LENGTH, type CaptureMethod, type CardDetail, type CardDetailFromLocker, Cards, type ChangePasswordRequest, type CheckoutBranding, type Connector, type ConnectorCreateRequest, type ConnectorListResponse, type ConnectorResponse, type ConnectorType, type ConnectorUpdateRequest, type ConnectorVolumeSplit, type ConnectorWebhookEntry, type ConnectorWebhookEventType, type ConnectorWebhookListResponse, type ConnectorWebhookRegisterRequest, type ConnectorWebhookRegisterResponse, type CornerRadius, type Currency, type CustomerCreateRequest, type CustomerListParams, type CustomerPaymentMethodsListParams, type CustomerPaymentMethodsListResponse, type CustomerResponse, type CustomerUpdateRequest, DEFAULT_BADGES, DEFAULT_BADGES_DARK, DEFAULT_BRANDING, DEFAULT_BRANDING_DARK, type DeleteAccountRequest, Delopay, DelopayAuthenticationError, DelopayError, type DelopayLogger, type DelopayOptions, type DisputeEvidenceRequest, type DisputeListParams, type DisputeResponse, type DisputeStage, type DisputeStatus, type EncodedBranding, type EphemeralKeyCreateRequest, type EphemeralKeyCreateResponse, type EventClass, type EventDeliveryAttemptResponse, type EventDetailResponse, type EventListParams, type EventListResponse, type EventResponse, type EventType, Export, FeatureMatrix, type FeeOwner, type FeeScheduleCreateRequest, type FeeScheduleResponse, type FeeScheduleUpdateRequest, type FeeType, Files, type FontFamily, type FontWeight, Forex, type ForgotPasswordRequest, type FromEmailRequest, type GatewayConnectRequest, type GatewayResponse, type GlobalSearchRequest, type IntentStatus, type InviteUsersRequest, type InviteUsersResponse, type LabelStyle, type LayoutStyle, type LedgerEntry, type LedgerListParams, type LedgerResponse, type LinkedRoutingConfigRetrieveResponse, type ListInvitableRolesParams, type LoginHistoryEntry, type LoginHistoryParams, type LoginHistoryResponse, type LogoShape, type LogoSize, type MandateListParams, type MandateResponse, type MandateRevokedResponse, type MandateStatus, type MandateType, type MerchantAccountCreateRequest, type MerchantAccountResponse, type MerchantAccountType, type MerchantAccountUpdateRequest, type MerchantOverviewResponse, type MerchantOverviewStat, type MerchantRoutingAlgorithm, type NonPillRadius, type ParentGroup, type ParentGroupInfo, type PaymentCancelRequest, type PaymentCaptureRequest, type PaymentConfirmRequest, type PaymentCreateRequest, type PaymentLayout, type PaymentLinkBackgroundImageConfig, type PaymentLinkConfigRequest, type PaymentLinkListParams, type PaymentLinkListResponse, type PaymentLinkResponse, type PaymentLinkTransactionDetails, type PaymentListParams, type PaymentListResponse, type PaymentMethod, type PaymentMethodCreateRequest, type PaymentMethodDeleteResponse, type PaymentMethodListParams, type PaymentMethodResponse, type PaymentMethodType, type PaymentMethodUpdateRequest, type PaymentResponse, type PaymentRetrieveOptions, type PaymentUpdateRequest, type PayoutCreateRequest, type PayoutListParams, type PayoutListResponse, type PayoutResponse, type PayoutStatus, type PayoutType, type PayoutUpdateRequest, type PermissionScope, type PhoneDetails, type PhoneOtpRequest, type PhoneOtpResponse, type PhoneOtpVerifyRequest, type PhoneOtpVerifyResponse, type PollStatus, type PollStatusResponse, type ProfileAcquirerCreateRequest, type ProfileAcquirerResponse, type ProfileAcquirerUpdateRequest, type ProfileCreateRequest, type ProfileDefaultRoutingConfig, type ProfileLogoUploadResponse, type ProfileResponse, type ProfileUpdateRequest, type ProjectCreateRequest, type ProjectResponse, type ProjectStats, type ProjectStatsResponse, type ProjectUpdateRequest, type RecoveryCodesResponse, type RefundCreateRequest, type RefundListParams, type RefundListResponse, type RefundResponse, type RefundStatus, type RefundType, type RefundUpdateRequest, type RegionCreateRequest, type RegionResponse, type RegionUpdateRequest, Regions, type RelayRequest, type RelayResponse, type RelayStatus, type RelayType, type RequestFn, type RequestOptions, type ResetPasswordRequest, type RoutableConnectorChoice, type RoutingActivatePayload, type RoutingConfigCreateRequest, type RoutingConfigResponse, type RoutingDeactivateRequest, type RoutingDictionary, type RoutingDictionaryRecord, Search, type SearchGroupResponse, type SearchIndex, type SearchStatus, type ShopCreateRequest, type ShopResponse, type ShopStats, type ShopUpdateRequest, type SignInRequest, type SignUpRequest, type SignUpWithMerchantIdRequest, type SignUpWithMerchantRequest, type SizeScale, type SpacingScale, type StaticRoutingAlgorithm, type StripeConnectAccountRequest, type StripeConnectAccountResponse, type StripeConnectLinkRequest, type StripeConnectLinkResponse, type SubscriptionCreateRequest, type SubscriptionListParams, type SubscriptionListResponse, type SubscriptionResponse, type SubscriptionUpdateRequest, Subscriptions, type SummaryPosition, type SurfaceStyle, type SwitchMerchantRequest, type SwitchProfileRequest, type Terminate2faQueryParams, type ThreeDSDecision, type ThreeDsRuleExecuteRequest, type ThreeDsRuleResponse, type TierSummary, type TokenPurpose, type TokenResponse, type TopupRequest, type TopupResponse, type TotpResponse, type TransactionType, type TrustBadge, type UpdateUserDetailsRequest, type UserResponse, type UserSessionEntry, type UserSessionListResponse, type UserSessionRevokeResponse, type VerifyTotpRequest, type WebhookDeliveryAttempt, type WebhookEvent, Webhooks, applyBrandingVariables, buildBrandingExport, buttonPadValue, cloneBranding, decodeBadges, decodeBranding, defaultBranding, encodeBadges, encodeBranding, fontStack, fontWeightValue, inputPadValue, isDarkSurface, isHexColor, logoDimensions, parseImportedBranding, radiusValue, sanitizeCustomCss, shadowFor, surfacePadValue, verticalGapValue };
|