@delopay/sdk 0.39.0 → 0.41.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-IQKFNKHU.js → chunk-DMNCVY25.js} +29 -8
- package/dist/chunk-DMNCVY25.js.map +1 -0
- package/dist/index.cjs +28 -7
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +62 -11
- package/dist/index.d.ts +62 -11
- package/dist/index.js +1 -1
- package/dist/internal.cjs +40 -13
- package/dist/internal.cjs.map +1 -1
- package/dist/internal.d.cts +16 -8
- package/dist/internal.d.ts +16 -8
- package/dist/internal.js +13 -7
- package/dist/internal.js.map +1 -1
- package/package.json +1 -1
- package/dist/chunk-IQKFNKHU.js.map +0 -1
package/dist/index.d.cts
CHANGED
|
@@ -937,6 +937,36 @@ interface LedgerListParams {
|
|
|
937
937
|
offset?: number | null;
|
|
938
938
|
profile_id?: string | null;
|
|
939
939
|
}
|
|
940
|
+
/** A payment attempt rejected by the billing suspension gate before any payment was created. */
|
|
941
|
+
interface BlockedAttempt {
|
|
942
|
+
id: string;
|
|
943
|
+
merchant_id: string;
|
|
944
|
+
payment_id: string;
|
|
945
|
+
/** `billing_suspended` | `billing_setup_incomplete` | `allocation_suspended`. */
|
|
946
|
+
block_reason: string;
|
|
947
|
+
created_at: string;
|
|
948
|
+
profile_id?: string | null;
|
|
949
|
+
/** `auto_recharge` | `admin` — only set when the merchant was suspended. */
|
|
950
|
+
suspension_source?: string | null;
|
|
951
|
+
amount?: number | null;
|
|
952
|
+
currency?: string | null;
|
|
953
|
+
billing_status?: string | null;
|
|
954
|
+
}
|
|
955
|
+
interface BlockedAttemptListResponse {
|
|
956
|
+
entries: BlockedAttempt[];
|
|
957
|
+
total_count?: number | null;
|
|
958
|
+
}
|
|
959
|
+
interface BlockedAttemptListParams {
|
|
960
|
+
limit?: number | null;
|
|
961
|
+
offset?: number | null;
|
|
962
|
+
profile_id?: string | null;
|
|
963
|
+
/** `billing_suspended` | `billing_setup_incomplete` | `allocation_suspended`. */
|
|
964
|
+
block_reason?: string | null;
|
|
965
|
+
/** ISO 8601 timestamp; only attempts at or after this time. */
|
|
966
|
+
created_after?: string | null;
|
|
967
|
+
/** ISO 8601 timestamp; only attempts at or before this time. */
|
|
968
|
+
created_before?: string | null;
|
|
969
|
+
}
|
|
940
970
|
interface AutoRechargeUpdateRequest {
|
|
941
971
|
enabled?: boolean | null;
|
|
942
972
|
threshold_amount?: number | null;
|
|
@@ -2523,6 +2553,18 @@ declare class Billing {
|
|
|
2523
2553
|
* @returns The ledger entries.
|
|
2524
2554
|
*/
|
|
2525
2555
|
listLedger(merchantId: string, params?: LedgerListParams): Promise<LedgerResponse>;
|
|
2556
|
+
/**
|
|
2557
|
+
* List payment attempts that were blocked by the billing suspension gate
|
|
2558
|
+
* (account suspended, setup incomplete, or shop allocation suspended).
|
|
2559
|
+
*
|
|
2560
|
+
* These attempts never created a payment, so they do not appear in the
|
|
2561
|
+
* payments list — this is the only way to retrieve them.
|
|
2562
|
+
*
|
|
2563
|
+
* @param merchantId - The merchant account ID.
|
|
2564
|
+
* @param params - Optional filters (profile, reason, date range) and pagination.
|
|
2565
|
+
* @returns The blocked-attempt entries with a total count.
|
|
2566
|
+
*/
|
|
2567
|
+
listBlockedAttempts(merchantId: string, params?: BlockedAttemptListParams): Promise<BlockedAttemptListResponse>;
|
|
2526
2568
|
/**
|
|
2527
2569
|
* Update auto-recharge configuration (threshold, top-up amount, enabled flag).
|
|
2528
2570
|
*
|
|
@@ -2760,9 +2802,11 @@ declare class Events {
|
|
|
2760
2802
|
* overrides; platform-wide fee programs are administered by Delopay and
|
|
2761
2803
|
* not exposed here.
|
|
2762
2804
|
*
|
|
2763
|
-
* `fees.rules` manages the merchant-owned Euclid fee-rule program
|
|
2764
|
-
*
|
|
2765
|
-
*
|
|
2805
|
+
* `fees.rules` manages the merchant-owned Euclid fee-rule program, which takes
|
|
2806
|
+
* precedence over the flat schedules above. A program is scoped either to one
|
|
2807
|
+
* shop (`profile_id`) or merchant-wide; a shop-scoped program wins for that
|
|
2808
|
+
* shop, otherwise the merchant-wide one applies. Build the program with the
|
|
2809
|
+
* `feeProgram()` helper.
|
|
2766
2810
|
*/
|
|
2767
2811
|
declare class Fees {
|
|
2768
2812
|
private readonly request;
|
|
@@ -2797,8 +2841,10 @@ declare class Fees {
|
|
|
2797
2841
|
delete(feeId: string): Promise<FeeScheduleResponse>;
|
|
2798
2842
|
}
|
|
2799
2843
|
/**
|
|
2800
|
-
* Manages a merchant's
|
|
2801
|
-
* `algorithm` with `feeProgram()`. The SDK
|
|
2844
|
+
* Manages a merchant's Euclid fee-rule programs (merchant-wide or per-shop, one
|
|
2845
|
+
* active program per scope). Build the `algorithm` with `feeProgram()`. The SDK
|
|
2846
|
+
* injects `fee_owner: 'merchant'`; set `profile_id` on the input to scope a
|
|
2847
|
+
* program to a shop.
|
|
2802
2848
|
*/
|
|
2803
2849
|
declare class FeeRulesManager {
|
|
2804
2850
|
private readonly request;
|
|
@@ -2812,18 +2858,23 @@ declare class FeeRulesManager {
|
|
|
2812
2858
|
*/
|
|
2813
2859
|
upsert(params: PlatformFeeRuleInput, merchantId: string): Promise<PlatformFeeRuleRecord>;
|
|
2814
2860
|
/**
|
|
2815
|
-
* Retrieve the
|
|
2861
|
+
* Retrieve the active fee-rule program for a scope, or `null` if none.
|
|
2816
2862
|
*
|
|
2817
2863
|
* @param merchantId - The merchant account ID.
|
|
2864
|
+
* @param profileId - Optional shop (`profile_id`) scope. Omit for the
|
|
2865
|
+
* merchant-wide program; pass a shop id to get that shop's program.
|
|
2818
2866
|
*/
|
|
2819
|
-
retrieve(merchantId: string): Promise<PlatformFeeRuleRecord | null>;
|
|
2867
|
+
retrieve(merchantId: string, profileId?: string): Promise<PlatformFeeRuleRecord | null>;
|
|
2820
2868
|
/**
|
|
2821
|
-
* Deactivate
|
|
2822
|
-
*
|
|
2869
|
+
* Deactivate a fee-rule program (falls back to the flat fee schedules /
|
|
2870
|
+
* volume tier). Idempotent.
|
|
2823
2871
|
*
|
|
2824
2872
|
* @param merchantId - The merchant account ID.
|
|
2873
|
+
* @param profileId - Optional shop (`profile_id`) scope. Omit to target the
|
|
2874
|
+
* merchant-wide program; pass a shop id to delete only that shop's program
|
|
2875
|
+
* (other shops' programs are left intact).
|
|
2825
2876
|
*/
|
|
2826
|
-
delete(merchantId: string): Promise<void>;
|
|
2877
|
+
delete(merchantId: string, profileId?: string): Promise<void>;
|
|
2827
2878
|
}
|
|
2828
2879
|
|
|
2829
2880
|
/** View and revoke recurring payment mandates. */
|
|
@@ -4514,4 +4565,4 @@ declare function parseImportedBranding(raw: unknown): CheckoutBranding;
|
|
|
4514
4565
|
declare function applyBrandingVariables(el: HTMLElement, b: CheckoutBranding): void;
|
|
4515
4566
|
declare function shadowFor(style: SurfaceStyle): string;
|
|
4516
4567
|
|
|
4517
|
-
export { type Address, type AddressDetails, type AllocationListResponse, type AllocationResponse, type AllocationTransferRequest, type AllocationTransferResponse, Analytics, type AnalyticsChild, type AnalyticsConnectorDay, type AnalyticsConnectorSeries, AnalyticsDashboard, type AnalyticsDayBucket, type AnalyticsScopeRequest, type AnalyticsScopeResponse, 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 CancelSubscriptionRequest, type CancelSubscriptionResponse, type CaptureMethod, type CardDetail, type CardDetailFromLocker, Cards, type ChangePasswordRequest, type CheckoutBranding, type ConfirmSubscriptionPaymentDetails, type ConfirmSubscriptionRequest, type ConfirmSubscriptionResponse, 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 CreateAndConfirmSubscriptionRequest, type CreateSubscriptionPaymentDetails, type CreateSubscriptionRequest, 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 EuclidComparison, type EuclidComparisonType, type EuclidIfStatement, type EuclidValue, type EventClass, type EventDeliveryAttemptResponse, type EventDetailResponse, type EventListParams, type EventListResponse, type EventResponse, type EventType, Export, FeatureMatrix, type FeeOwner, FeeProgramBuilder, type FeeRuleConditions, type FeeRuleInput, type FeeScheduleCreateRequest, type FeeScheduleResponse, type FeeScheduleUpdateRequest, type FeeSpecInput, type FeeType, Files, type FontFamily, type FontWeight, Forex, type ForgotPasswordRequest, type FromEmailRequest, type FutureUsage, type GatewayConnectRequest, type GatewayResponse, type GetSubscriptionItemsParams, type GetSubscriptionItemsResponse, type GlobalSearchRequest, type IntentStatus, type InviteUsersRequest, type InviteUsersResponse, type InvoiceStatus, 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 PauseSubscriptionRequest, type PauseSubscriptionResponse, 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 PlatformFeeKind, type PlatformFeeOutput, type PlatformFeeProgram, type PlatformFeeRule, type PlatformFeeRuleInput, type PlatformFeeRuleOutput, type PlatformFeeRuleRecord, type PlatformFeeRuleRequest, 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 RequestExtras, type RequestFn, type RequestOptions, type ResetPasswordRequest, type ResumeSubscriptionRequest, type ResumeSubscriptionResponse, 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 SubscriptionEstimateParams, type SubscriptionEstimateResponse, type SubscriptionInvoice, type SubscriptionItem, type SubscriptionItemPrice, type SubscriptionItemType, type SubscriptionLineItem, type SubscriptionListParams, type SubscriptionPaymentData, type SubscriptionPaymentDetails, type SubscriptionPeriodUnit, type SubscriptionResponse, type SubscriptionStatus, 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 UpdateSubscriptionRequest, 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, feeProgram, fontStack, fontWeightValue, inputPadValue, isDarkSurface, isHexColor, logoDimensions, parseImportedBranding, radiusValue, sanitizeCustomCss, shadowFor, surfacePadValue, verticalGapValue };
|
|
4568
|
+
export { type Address, type AddressDetails, type AllocationListResponse, type AllocationResponse, type AllocationTransferRequest, type AllocationTransferResponse, Analytics, type AnalyticsChild, type AnalyticsConnectorDay, type AnalyticsConnectorSeries, AnalyticsDashboard, type AnalyticsDayBucket, type AnalyticsScopeRequest, type AnalyticsScopeResponse, 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 BlockedAttempt, type BlockedAttemptListParams, type BlockedAttemptListResponse, type BlocklistAddRequest, type BlocklistDataKind, type BlocklistResponse, type BrandingExport, type BrandingSource, type BusinessPaymentLinkConfig, CUSTOM_CSS_MAX_LENGTH, type CancelSubscriptionRequest, type CancelSubscriptionResponse, type CaptureMethod, type CardDetail, type CardDetailFromLocker, Cards, type ChangePasswordRequest, type CheckoutBranding, type ConfirmSubscriptionPaymentDetails, type ConfirmSubscriptionRequest, type ConfirmSubscriptionResponse, 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 CreateAndConfirmSubscriptionRequest, type CreateSubscriptionPaymentDetails, type CreateSubscriptionRequest, 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 EuclidComparison, type EuclidComparisonType, type EuclidIfStatement, type EuclidValue, type EventClass, type EventDeliveryAttemptResponse, type EventDetailResponse, type EventListParams, type EventListResponse, type EventResponse, type EventType, Export, FeatureMatrix, type FeeOwner, FeeProgramBuilder, type FeeRuleConditions, type FeeRuleInput, type FeeScheduleCreateRequest, type FeeScheduleResponse, type FeeScheduleUpdateRequest, type FeeSpecInput, type FeeType, Files, type FontFamily, type FontWeight, Forex, type ForgotPasswordRequest, type FromEmailRequest, type FutureUsage, type GatewayConnectRequest, type GatewayResponse, type GetSubscriptionItemsParams, type GetSubscriptionItemsResponse, type GlobalSearchRequest, type IntentStatus, type InviteUsersRequest, type InviteUsersResponse, type InvoiceStatus, 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 PauseSubscriptionRequest, type PauseSubscriptionResponse, 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 PlatformFeeKind, type PlatformFeeOutput, type PlatformFeeProgram, type PlatformFeeRule, type PlatformFeeRuleInput, type PlatformFeeRuleOutput, type PlatformFeeRuleRecord, type PlatformFeeRuleRequest, 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 RequestExtras, type RequestFn, type RequestOptions, type ResetPasswordRequest, type ResumeSubscriptionRequest, type ResumeSubscriptionResponse, 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 SubscriptionEstimateParams, type SubscriptionEstimateResponse, type SubscriptionInvoice, type SubscriptionItem, type SubscriptionItemPrice, type SubscriptionItemType, type SubscriptionLineItem, type SubscriptionListParams, type SubscriptionPaymentData, type SubscriptionPaymentDetails, type SubscriptionPeriodUnit, type SubscriptionResponse, type SubscriptionStatus, 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 UpdateSubscriptionRequest, 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, feeProgram, fontStack, fontWeightValue, inputPadValue, isDarkSurface, isHexColor, logoDimensions, parseImportedBranding, radiusValue, sanitizeCustomCss, shadowFor, surfacePadValue, verticalGapValue };
|
package/dist/index.d.ts
CHANGED
|
@@ -937,6 +937,36 @@ interface LedgerListParams {
|
|
|
937
937
|
offset?: number | null;
|
|
938
938
|
profile_id?: string | null;
|
|
939
939
|
}
|
|
940
|
+
/** A payment attempt rejected by the billing suspension gate before any payment was created. */
|
|
941
|
+
interface BlockedAttempt {
|
|
942
|
+
id: string;
|
|
943
|
+
merchant_id: string;
|
|
944
|
+
payment_id: string;
|
|
945
|
+
/** `billing_suspended` | `billing_setup_incomplete` | `allocation_suspended`. */
|
|
946
|
+
block_reason: string;
|
|
947
|
+
created_at: string;
|
|
948
|
+
profile_id?: string | null;
|
|
949
|
+
/** `auto_recharge` | `admin` — only set when the merchant was suspended. */
|
|
950
|
+
suspension_source?: string | null;
|
|
951
|
+
amount?: number | null;
|
|
952
|
+
currency?: string | null;
|
|
953
|
+
billing_status?: string | null;
|
|
954
|
+
}
|
|
955
|
+
interface BlockedAttemptListResponse {
|
|
956
|
+
entries: BlockedAttempt[];
|
|
957
|
+
total_count?: number | null;
|
|
958
|
+
}
|
|
959
|
+
interface BlockedAttemptListParams {
|
|
960
|
+
limit?: number | null;
|
|
961
|
+
offset?: number | null;
|
|
962
|
+
profile_id?: string | null;
|
|
963
|
+
/** `billing_suspended` | `billing_setup_incomplete` | `allocation_suspended`. */
|
|
964
|
+
block_reason?: string | null;
|
|
965
|
+
/** ISO 8601 timestamp; only attempts at or after this time. */
|
|
966
|
+
created_after?: string | null;
|
|
967
|
+
/** ISO 8601 timestamp; only attempts at or before this time. */
|
|
968
|
+
created_before?: string | null;
|
|
969
|
+
}
|
|
940
970
|
interface AutoRechargeUpdateRequest {
|
|
941
971
|
enabled?: boolean | null;
|
|
942
972
|
threshold_amount?: number | null;
|
|
@@ -2523,6 +2553,18 @@ declare class Billing {
|
|
|
2523
2553
|
* @returns The ledger entries.
|
|
2524
2554
|
*/
|
|
2525
2555
|
listLedger(merchantId: string, params?: LedgerListParams): Promise<LedgerResponse>;
|
|
2556
|
+
/**
|
|
2557
|
+
* List payment attempts that were blocked by the billing suspension gate
|
|
2558
|
+
* (account suspended, setup incomplete, or shop allocation suspended).
|
|
2559
|
+
*
|
|
2560
|
+
* These attempts never created a payment, so they do not appear in the
|
|
2561
|
+
* payments list — this is the only way to retrieve them.
|
|
2562
|
+
*
|
|
2563
|
+
* @param merchantId - The merchant account ID.
|
|
2564
|
+
* @param params - Optional filters (profile, reason, date range) and pagination.
|
|
2565
|
+
* @returns The blocked-attempt entries with a total count.
|
|
2566
|
+
*/
|
|
2567
|
+
listBlockedAttempts(merchantId: string, params?: BlockedAttemptListParams): Promise<BlockedAttemptListResponse>;
|
|
2526
2568
|
/**
|
|
2527
2569
|
* Update auto-recharge configuration (threshold, top-up amount, enabled flag).
|
|
2528
2570
|
*
|
|
@@ -2760,9 +2802,11 @@ declare class Events {
|
|
|
2760
2802
|
* overrides; platform-wide fee programs are administered by Delopay and
|
|
2761
2803
|
* not exposed here.
|
|
2762
2804
|
*
|
|
2763
|
-
* `fees.rules` manages the merchant-owned Euclid fee-rule program
|
|
2764
|
-
*
|
|
2765
|
-
*
|
|
2805
|
+
* `fees.rules` manages the merchant-owned Euclid fee-rule program, which takes
|
|
2806
|
+
* precedence over the flat schedules above. A program is scoped either to one
|
|
2807
|
+
* shop (`profile_id`) or merchant-wide; a shop-scoped program wins for that
|
|
2808
|
+
* shop, otherwise the merchant-wide one applies. Build the program with the
|
|
2809
|
+
* `feeProgram()` helper.
|
|
2766
2810
|
*/
|
|
2767
2811
|
declare class Fees {
|
|
2768
2812
|
private readonly request;
|
|
@@ -2797,8 +2841,10 @@ declare class Fees {
|
|
|
2797
2841
|
delete(feeId: string): Promise<FeeScheduleResponse>;
|
|
2798
2842
|
}
|
|
2799
2843
|
/**
|
|
2800
|
-
* Manages a merchant's
|
|
2801
|
-
* `algorithm` with `feeProgram()`. The SDK
|
|
2844
|
+
* Manages a merchant's Euclid fee-rule programs (merchant-wide or per-shop, one
|
|
2845
|
+
* active program per scope). Build the `algorithm` with `feeProgram()`. The SDK
|
|
2846
|
+
* injects `fee_owner: 'merchant'`; set `profile_id` on the input to scope a
|
|
2847
|
+
* program to a shop.
|
|
2802
2848
|
*/
|
|
2803
2849
|
declare class FeeRulesManager {
|
|
2804
2850
|
private readonly request;
|
|
@@ -2812,18 +2858,23 @@ declare class FeeRulesManager {
|
|
|
2812
2858
|
*/
|
|
2813
2859
|
upsert(params: PlatformFeeRuleInput, merchantId: string): Promise<PlatformFeeRuleRecord>;
|
|
2814
2860
|
/**
|
|
2815
|
-
* Retrieve the
|
|
2861
|
+
* Retrieve the active fee-rule program for a scope, or `null` if none.
|
|
2816
2862
|
*
|
|
2817
2863
|
* @param merchantId - The merchant account ID.
|
|
2864
|
+
* @param profileId - Optional shop (`profile_id`) scope. Omit for the
|
|
2865
|
+
* merchant-wide program; pass a shop id to get that shop's program.
|
|
2818
2866
|
*/
|
|
2819
|
-
retrieve(merchantId: string): Promise<PlatformFeeRuleRecord | null>;
|
|
2867
|
+
retrieve(merchantId: string, profileId?: string): Promise<PlatformFeeRuleRecord | null>;
|
|
2820
2868
|
/**
|
|
2821
|
-
* Deactivate
|
|
2822
|
-
*
|
|
2869
|
+
* Deactivate a fee-rule program (falls back to the flat fee schedules /
|
|
2870
|
+
* volume tier). Idempotent.
|
|
2823
2871
|
*
|
|
2824
2872
|
* @param merchantId - The merchant account ID.
|
|
2873
|
+
* @param profileId - Optional shop (`profile_id`) scope. Omit to target the
|
|
2874
|
+
* merchant-wide program; pass a shop id to delete only that shop's program
|
|
2875
|
+
* (other shops' programs are left intact).
|
|
2825
2876
|
*/
|
|
2826
|
-
delete(merchantId: string): Promise<void>;
|
|
2877
|
+
delete(merchantId: string, profileId?: string): Promise<void>;
|
|
2827
2878
|
}
|
|
2828
2879
|
|
|
2829
2880
|
/** View and revoke recurring payment mandates. */
|
|
@@ -4514,4 +4565,4 @@ declare function parseImportedBranding(raw: unknown): CheckoutBranding;
|
|
|
4514
4565
|
declare function applyBrandingVariables(el: HTMLElement, b: CheckoutBranding): void;
|
|
4515
4566
|
declare function shadowFor(style: SurfaceStyle): string;
|
|
4516
4567
|
|
|
4517
|
-
export { type Address, type AddressDetails, type AllocationListResponse, type AllocationResponse, type AllocationTransferRequest, type AllocationTransferResponse, Analytics, type AnalyticsChild, type AnalyticsConnectorDay, type AnalyticsConnectorSeries, AnalyticsDashboard, type AnalyticsDayBucket, type AnalyticsScopeRequest, type AnalyticsScopeResponse, 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 CancelSubscriptionRequest, type CancelSubscriptionResponse, type CaptureMethod, type CardDetail, type CardDetailFromLocker, Cards, type ChangePasswordRequest, type CheckoutBranding, type ConfirmSubscriptionPaymentDetails, type ConfirmSubscriptionRequest, type ConfirmSubscriptionResponse, 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 CreateAndConfirmSubscriptionRequest, type CreateSubscriptionPaymentDetails, type CreateSubscriptionRequest, 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 EuclidComparison, type EuclidComparisonType, type EuclidIfStatement, type EuclidValue, type EventClass, type EventDeliveryAttemptResponse, type EventDetailResponse, type EventListParams, type EventListResponse, type EventResponse, type EventType, Export, FeatureMatrix, type FeeOwner, FeeProgramBuilder, type FeeRuleConditions, type FeeRuleInput, type FeeScheduleCreateRequest, type FeeScheduleResponse, type FeeScheduleUpdateRequest, type FeeSpecInput, type FeeType, Files, type FontFamily, type FontWeight, Forex, type ForgotPasswordRequest, type FromEmailRequest, type FutureUsage, type GatewayConnectRequest, type GatewayResponse, type GetSubscriptionItemsParams, type GetSubscriptionItemsResponse, type GlobalSearchRequest, type IntentStatus, type InviteUsersRequest, type InviteUsersResponse, type InvoiceStatus, 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 PauseSubscriptionRequest, type PauseSubscriptionResponse, 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 PlatformFeeKind, type PlatformFeeOutput, type PlatformFeeProgram, type PlatformFeeRule, type PlatformFeeRuleInput, type PlatformFeeRuleOutput, type PlatformFeeRuleRecord, type PlatformFeeRuleRequest, 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 RequestExtras, type RequestFn, type RequestOptions, type ResetPasswordRequest, type ResumeSubscriptionRequest, type ResumeSubscriptionResponse, 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 SubscriptionEstimateParams, type SubscriptionEstimateResponse, type SubscriptionInvoice, type SubscriptionItem, type SubscriptionItemPrice, type SubscriptionItemType, type SubscriptionLineItem, type SubscriptionListParams, type SubscriptionPaymentData, type SubscriptionPaymentDetails, type SubscriptionPeriodUnit, type SubscriptionResponse, type SubscriptionStatus, 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 UpdateSubscriptionRequest, 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, feeProgram, fontStack, fontWeightValue, inputPadValue, isDarkSurface, isHexColor, logoDimensions, parseImportedBranding, radiusValue, sanitizeCustomCss, shadowFor, surfacePadValue, verticalGapValue };
|
|
4568
|
+
export { type Address, type AddressDetails, type AllocationListResponse, type AllocationResponse, type AllocationTransferRequest, type AllocationTransferResponse, Analytics, type AnalyticsChild, type AnalyticsConnectorDay, type AnalyticsConnectorSeries, AnalyticsDashboard, type AnalyticsDayBucket, type AnalyticsScopeRequest, type AnalyticsScopeResponse, 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 BlockedAttempt, type BlockedAttemptListParams, type BlockedAttemptListResponse, type BlocklistAddRequest, type BlocklistDataKind, type BlocklistResponse, type BrandingExport, type BrandingSource, type BusinessPaymentLinkConfig, CUSTOM_CSS_MAX_LENGTH, type CancelSubscriptionRequest, type CancelSubscriptionResponse, type CaptureMethod, type CardDetail, type CardDetailFromLocker, Cards, type ChangePasswordRequest, type CheckoutBranding, type ConfirmSubscriptionPaymentDetails, type ConfirmSubscriptionRequest, type ConfirmSubscriptionResponse, 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 CreateAndConfirmSubscriptionRequest, type CreateSubscriptionPaymentDetails, type CreateSubscriptionRequest, 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 EuclidComparison, type EuclidComparisonType, type EuclidIfStatement, type EuclidValue, type EventClass, type EventDeliveryAttemptResponse, type EventDetailResponse, type EventListParams, type EventListResponse, type EventResponse, type EventType, Export, FeatureMatrix, type FeeOwner, FeeProgramBuilder, type FeeRuleConditions, type FeeRuleInput, type FeeScheduleCreateRequest, type FeeScheduleResponse, type FeeScheduleUpdateRequest, type FeeSpecInput, type FeeType, Files, type FontFamily, type FontWeight, Forex, type ForgotPasswordRequest, type FromEmailRequest, type FutureUsage, type GatewayConnectRequest, type GatewayResponse, type GetSubscriptionItemsParams, type GetSubscriptionItemsResponse, type GlobalSearchRequest, type IntentStatus, type InviteUsersRequest, type InviteUsersResponse, type InvoiceStatus, 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 PauseSubscriptionRequest, type PauseSubscriptionResponse, 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 PlatformFeeKind, type PlatformFeeOutput, type PlatformFeeProgram, type PlatformFeeRule, type PlatformFeeRuleInput, type PlatformFeeRuleOutput, type PlatformFeeRuleRecord, type PlatformFeeRuleRequest, 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 RequestExtras, type RequestFn, type RequestOptions, type ResetPasswordRequest, type ResumeSubscriptionRequest, type ResumeSubscriptionResponse, 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 SubscriptionEstimateParams, type SubscriptionEstimateResponse, type SubscriptionInvoice, type SubscriptionItem, type SubscriptionItemPrice, type SubscriptionItemType, type SubscriptionLineItem, type SubscriptionListParams, type SubscriptionPaymentData, type SubscriptionPaymentDetails, type SubscriptionPeriodUnit, type SubscriptionResponse, type SubscriptionStatus, 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 UpdateSubscriptionRequest, 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, feeProgram, fontStack, fontWeightValue, inputPadValue, isDarkSurface, isHexColor, logoDimensions, parseImportedBranding, radiusValue, sanitizeCustomCss, shadowFor, surfacePadValue, verticalGapValue };
|
package/dist/index.js
CHANGED
package/dist/internal.cjs
CHANGED
|
@@ -359,6 +359,22 @@ var Billing = class {
|
|
|
359
359
|
query: params
|
|
360
360
|
});
|
|
361
361
|
}
|
|
362
|
+
/**
|
|
363
|
+
* List payment attempts that were blocked by the billing suspension gate
|
|
364
|
+
* (account suspended, setup incomplete, or shop allocation suspended).
|
|
365
|
+
*
|
|
366
|
+
* These attempts never created a payment, so they do not appear in the
|
|
367
|
+
* payments list — this is the only way to retrieve them.
|
|
368
|
+
*
|
|
369
|
+
* @param merchantId - The merchant account ID.
|
|
370
|
+
* @param params - Optional filters (profile, reason, date range) and pagination.
|
|
371
|
+
* @returns The blocked-attempt entries with a total count.
|
|
372
|
+
*/
|
|
373
|
+
async listBlockedAttempts(merchantId, params) {
|
|
374
|
+
return this.request("GET", `/billing/${encodeURIComponent(merchantId)}/blocked-attempts`, {
|
|
375
|
+
query: params
|
|
376
|
+
});
|
|
377
|
+
}
|
|
362
378
|
/**
|
|
363
379
|
* Update auto-recharge configuration (threshold, top-up amount, enabled flag).
|
|
364
380
|
*
|
|
@@ -767,24 +783,29 @@ var FeeRulesManager = class {
|
|
|
767
783
|
});
|
|
768
784
|
}
|
|
769
785
|
/**
|
|
770
|
-
* Retrieve the
|
|
786
|
+
* Retrieve the active fee-rule program for a scope, or `null` if none.
|
|
771
787
|
*
|
|
772
788
|
* @param merchantId - The merchant account ID.
|
|
789
|
+
* @param profileId - Optional shop (`profile_id`) scope. Omit for the
|
|
790
|
+
* merchant-wide program; pass a shop id to get that shop's program.
|
|
773
791
|
*/
|
|
774
|
-
async retrieve(merchantId) {
|
|
792
|
+
async retrieve(merchantId, profileId) {
|
|
775
793
|
return this.request("GET", "/merchant-fees/rules", {
|
|
776
|
-
query: { merchant_id: merchantId }
|
|
794
|
+
query: { merchant_id: merchantId, profile_id: profileId }
|
|
777
795
|
});
|
|
778
796
|
}
|
|
779
797
|
/**
|
|
780
|
-
* Deactivate
|
|
781
|
-
*
|
|
798
|
+
* Deactivate a fee-rule program (falls back to the flat fee schedules /
|
|
799
|
+
* volume tier). Idempotent.
|
|
782
800
|
*
|
|
783
801
|
* @param merchantId - The merchant account ID.
|
|
802
|
+
* @param profileId - Optional shop (`profile_id`) scope. Omit to target the
|
|
803
|
+
* merchant-wide program; pass a shop id to delete only that shop's program
|
|
804
|
+
* (other shops' programs are left intact).
|
|
784
805
|
*/
|
|
785
|
-
async delete(merchantId) {
|
|
806
|
+
async delete(merchantId, profileId) {
|
|
786
807
|
await this.request("DELETE", "/merchant-fees/rules", {
|
|
787
|
-
query: { merchant_id: merchantId }
|
|
808
|
+
query: { merchant_id: merchantId, profile_id: profileId }
|
|
788
809
|
});
|
|
789
810
|
}
|
|
790
811
|
};
|
|
@@ -4238,16 +4259,22 @@ var PlatformFeeRulesManager = class {
|
|
|
4238
4259
|
query: { merchant_id: merchantId }
|
|
4239
4260
|
});
|
|
4240
4261
|
}
|
|
4241
|
-
/**
|
|
4242
|
-
|
|
4262
|
+
/**
|
|
4263
|
+
* Retrieve the active platform fee-rule program for a scope, or `null`.
|
|
4264
|
+
* `profileId` omitted = merchant-wide program; set = that shop's program.
|
|
4265
|
+
*/
|
|
4266
|
+
async retrieve(merchantId, profileId) {
|
|
4243
4267
|
return this.request("GET", "/admin/fees/rules", {
|
|
4244
|
-
query: { merchant_id: merchantId }
|
|
4268
|
+
query: { merchant_id: merchantId, profile_id: profileId }
|
|
4245
4269
|
});
|
|
4246
4270
|
}
|
|
4247
|
-
/**
|
|
4248
|
-
|
|
4271
|
+
/**
|
|
4272
|
+
* Deactivate a platform fee-rule program. Idempotent. `profileId` omitted
|
|
4273
|
+
* targets the merchant-wide program; set targets only that shop's program.
|
|
4274
|
+
*/
|
|
4275
|
+
async delete(merchantId, profileId) {
|
|
4249
4276
|
await this.request("DELETE", "/admin/fees/rules", {
|
|
4250
|
-
query: { merchant_id: merchantId }
|
|
4277
|
+
query: { merchant_id: merchantId, profile_id: profileId }
|
|
4251
4278
|
});
|
|
4252
4279
|
}
|
|
4253
4280
|
};
|