@delopay/sdk 0.6.0 → 0.7.0

package/dist/internal.d.cts

@@ -1,5 +1,255 @@
-import { RequestFn, AdminSignInRequest, AuthResponse, CreateInternalUserRequest, AuthorizeResponse, CreateTenantUserRequest, SignUpWithMerchantIdRequest, SignupToggleRequest, SignupToggleResponse, OnboardMerchantRequest, OnboardMerchantResponse, AdminCustomerListParams, AdminCustomerListResponse, AdminCustomerDetail, AdminTransactionListParams, AdminTransactionListResponse, AdminAnalyticsRequest, PlatformAnalyticsResponse, OverviewStatsResponse, PaymentAnalyticsRequest, PaymentAnalyticsResponse, MerchantAccountResponse, MerchantAccountUpdateRequest, AuditLogListParams, AuditLogListResponse, AuditLogResponse, Delopay } from './index.cjs';
-export { Address, AddressDetails, AdminAdjustmentRequest, AdminAdjustmentResponse, AllocationListResponse, AllocationResponse, AllocationTransferRequest, AllocationTransferResponse, Analytics, AnalyticsDashboard, ApiKeyCreateRequest, ApiKeyCreateResponse, ApiKeyExpiration, ApiKeyResponse, ApiKeyRevokeResponse, ApiKeyUpdateRequest, ApplePayVerificationRequest, ApplePayVerificationResponse, ApplePayVerifiedDomainsResponse, AuthenticationCreateRequest, AuthenticationResponse, AuthenticationStatus, AuthenticationType, AutoRechargeConfig, AutoRechargeUpdateRequest, BillingCompleteSetupRequest, BillingProfileResponse, BillingSetupRequest, BillingSetupResponse, BlocklistAddRequest, BlocklistDataKind, BlocklistResponse, Cache, CaptureMethod, CardDetail, CardDetailFromLocker, CardIssuerCreateRequest, CardIssuerListResponse, CardIssuerResponse, CardIssuerUpdateRequest, Cards, ChangePasswordRequest, Configs, ConnectorCreateRequest, ConnectorListResponse, ConnectorResponse, ConnectorType, ConnectorUpdateRequest, Currency, CustomerCreateRequest, CustomerListParams, CustomerPaymentMethodsListParams, CustomerPaymentMethodsListResponse, CustomerResponse, CustomerSummary, CustomerUpdateRequest, CustomerUser, DelopayAuthenticationError, DelopayError, DelopayLogger, DelopayOptions, DisputeEvidenceRequest, DisputeListParams, DisputeResponse, DisputeStage, DisputeStatus, EphemeralKeyCreateRequest, EphemeralKeyCreateResponse, EventClass, EventDeliveryAttemptResponse, EventDetailResponse, EventListParams, EventListResponse, EventResponse, EventType, Export, FeatureMatrix, FeeOwner, FeeScheduleCreateRequest, FeeScheduleResponse, FeeScheduleUpdateRequest, FeeType, Files, Forex, ForgotPasswordRequest, FromEmailRequest, GatewayConnectRequest, GatewayResponse, GsmDecision, GsmRuleCreateRequest, GsmRuleResponse, GsmRuleUpdateRequest, IntentStatus, InviteUsersRequest, InviteUsersResponse, LedgerEntry, LedgerListParams, LedgerResponse, MandateListParams, MandateResponse, MandateRevokedResponse, MandateStatus, MandateType, MerchantAccountCreateRequest, MerchantAccountType, MerchantOverviewResponse, MerchantOverviewStat, OverviewStat, PaymentCancelRequest, PaymentCaptureRequest, PaymentConfirmRequest, PaymentCreateRequest, PaymentLinkListParams, PaymentLinkListResponse, PaymentLinkResponse, PaymentListParams, PaymentListResponse, PaymentMethod, PaymentMethodCreateRequest, PaymentMethodDeleteResponse, PaymentMethodListParams, PaymentMethodResponse, PaymentMethodType, PaymentMethodUpdateRequest, PaymentResponse, PaymentStat, PaymentUpdateRequest, PayoutCreateRequest, PayoutListParams, PayoutListResponse, PayoutResponse, PayoutStatus, PayoutType, PayoutUpdateRequest, PhoneDetails, PhoneOtpRequest, PhoneOtpResponse, PhoneOtpVerifyRequest, PhoneOtpVerifyResponse, PollStatus, PollStatusResponse, ProfileAcquirerCreateRequest, ProfileAcquirerResponse, ProfileAcquirerUpdateRequest, ProfileCreateRequest, ProfileResponse, ProfileUpdateRequest, ProjectCreateRequest, ProjectResponse, ProjectStats, ProjectStatsResponse, ProjectUpdateRequest, RecoveryCodesResponse, RefundCreateRequest, RefundListParams, RefundListResponse, RefundResponse, RefundStatus, RefundType, RefundUpdateRequest, RegionCreateRequest, RegionResponse, RegionUpdateRequest, Regions, RelayRequest, RelayResponse, RelayStatus, RelayType, RequestOptions, ResetPasswordRequest, RoutingConfigCreateRequest, RoutingConfigResponse, ShopCreateRequest, ShopResponse, ShopStats, ShopUpdateRequest, SignInRequest, SignUpRequest, SignUpWithMerchantRequest, StripeConnectAccountRequest, StripeConnectAccountResponse, StripeConnectLinkRequest, StripeConnectLinkResponse, SubscriptionCreateRequest, SubscriptionListParams, SubscriptionListResponse, SubscriptionResponse, SubscriptionUpdateRequest, Subscriptions, SwitchMerchantRequest, SwitchProfileRequest, Terminate2faQueryParams, ThreeDSDecision, ThreeDsRuleExecuteRequest, ThreeDsRuleResponse, TokenPurpose, TokenResponse, TopupRequest, TopupResponse, TotpResponse, TransactionType, UpdateUserDetailsRequest, UserResponse, VerifyOptions, VerifyTotpRequest, WebhookDeliveryAttempt, WebhookEvent, Webhooks } from './index.cjs';
+import { ProjectResponse, ShopResponse, PaymentResponse, RequestFn, AuthResponse, SignUpWithMerchantIdRequest, MerchantAccountResponse, MerchantAccountUpdateRequest, FeeScheduleCreateRequest, FeeScheduleResponse, FeeScheduleUpdateRequest, Delopay } from './index.cjs';
+export { Address, AddressDetails, AdminAdjustmentRequest, AdminAdjustmentResponse, AllocationListResponse, AllocationResponse, AllocationTransferRequest, AllocationTransferResponse, Analytics, AnalyticsDashboard, ApiKeyCreateRequest, ApiKeyCreateResponse, ApiKeyExpiration, ApiKeyResponse, ApiKeyRevokeResponse, ApiKeyUpdateRequest, ApplePayVerificationRequest, ApplePayVerificationResponse, ApplePayVerifiedDomainsResponse, AuthenticationCreateRequest, AuthenticationResponse, AuthenticationStatus, AuthenticationType, AutoRechargeConfig, AutoRechargeUpdateRequest, BillingCompleteSetupRequest, BillingProfileResponse, BillingSetupRequest, BillingSetupResponse, BlocklistAddRequest, BlocklistDataKind, BlocklistResponse, CaptureMethod, CardDetail, CardDetailFromLocker, Cards, ChangePasswordRequest, ConnectorCreateRequest, ConnectorListResponse, ConnectorResponse, ConnectorType, ConnectorUpdateRequest, Currency, CustomerCreateRequest, CustomerListParams, CustomerPaymentMethodsListParams, CustomerPaymentMethodsListResponse, CustomerResponse, CustomerUpdateRequest, DelopayAuthenticationError, DelopayError, DelopayLogger, DelopayOptions, DisputeEvidenceRequest, DisputeListParams, DisputeResponse, DisputeStage, DisputeStatus, EphemeralKeyCreateRequest, EphemeralKeyCreateResponse, EventClass, EventDeliveryAttemptResponse, EventDetailResponse, EventListParams, EventListResponse, EventResponse, EventType, Export, FeatureMatrix, FeeOwner, FeeType, Files, Forex, ForgotPasswordRequest, FromEmailRequest, GatewayConnectRequest, GatewayResponse, IntentStatus, InviteUsersRequest, InviteUsersResponse, LedgerEntry, LedgerListParams, LedgerResponse, MandateListParams, MandateResponse, MandateRevokedResponse, MandateStatus, MandateType, MerchantAccountCreateRequest, MerchantAccountType, MerchantOverviewResponse, MerchantOverviewStat, PaymentCancelRequest, PaymentCaptureRequest, PaymentConfirmRequest, PaymentCreateRequest, PaymentLinkListParams, PaymentLinkListResponse, PaymentLinkResponse, PaymentListParams, PaymentListResponse, PaymentMethod, PaymentMethodCreateRequest, PaymentMethodDeleteResponse, PaymentMethodListParams, PaymentMethodResponse, PaymentMethodType, PaymentMethodUpdateRequest, PaymentUpdateRequest, PayoutCreateRequest, PayoutListParams, PayoutListResponse, PayoutResponse, PayoutStatus, PayoutType, PayoutUpdateRequest, PhoneDetails, PhoneOtpRequest, PhoneOtpResponse, PhoneOtpVerifyRequest, PhoneOtpVerifyResponse, PollStatus, PollStatusResponse, ProfileAcquirerCreateRequest, ProfileAcquirerResponse, ProfileAcquirerUpdateRequest, ProfileCreateRequest, ProfileResponse, ProfileUpdateRequest, ProjectCreateRequest, ProjectStats, ProjectStatsResponse, ProjectUpdateRequest, RecoveryCodesResponse, RefundCreateRequest, RefundListParams, RefundListResponse, RefundResponse, RefundStatus, RefundType, RefundUpdateRequest, RegionCreateRequest, RegionResponse, RegionUpdateRequest, Regions, RelayRequest, RelayResponse, RelayStatus, RelayType, RequestOptions, ResetPasswordRequest, RoutingConfigCreateRequest, RoutingConfigResponse, ShopCreateRequest, ShopStats, ShopUpdateRequest, SignInRequest, SignUpRequest, SignUpWithMerchantRequest, StripeConnectAccountRequest, StripeConnectAccountResponse, StripeConnectLinkRequest, StripeConnectLinkResponse, SubscriptionCreateRequest, SubscriptionListParams, SubscriptionListResponse, SubscriptionResponse, SubscriptionUpdateRequest, Subscriptions, SwitchMerchantRequest, SwitchProfileRequest, Terminate2faQueryParams, ThreeDSDecision, ThreeDsRuleExecuteRequest, ThreeDsRuleResponse, TokenPurpose, TokenResponse, TopupRequest, TopupResponse, TotpResponse, TransactionType, UpdateUserDetailsRequest, UserResponse, VerifyOptions, VerifyTotpRequest, WebhookDeliveryAttempt, WebhookEvent, Webhooks } from './index.cjs';
+
+/**
+ * Internal-only type surface. Exposed via `'@delopay/sdk/internal'` only.
+ *
+ * Any type that describes an admin-plane operation (bootstrap admin
+ * signup, platform analytics, audit log read, card-issuer program mgmt,
+ * GSM routing rules, …) lives here rather than in the public types
+ * barrel — otherwise merchants importing from `'@delopay/sdk'` could
+ * autocomplete or destructure shapes that hint at the admin API.
+ *
+ * Types that are genuinely shared between merchant and admin resources
+ * (e.g. `FeeSchedule*`, `ProjectResponse`, `PaymentResponse`) stay in
+ * `src/types.ts` and are imported here where needed.
+ */
+
+interface AdminSignInRequest {
+    email: string;
+    password: string;
+}
+/**
+ * Response returned by admin signup/signin endpoints.
+ *
+ * The admin flow is passwordless-after-signup: the endpoint triggers an
+ * email (confirmation or sign-in link) and `is_email_sent` indicates whether
+ * delivery was attempted successfully.
+ */
+interface AuthorizeResponse {
+    is_email_sent: boolean;
+}
+/** Create a new internal DeloPay admin user. Requires the server admin API key. */
+interface CreateInternalUserRequest {
+    name: string;
+    email: string;
+    password: string;
+    /** Predefined internal role id (e.g. `internal_view_only`). Cannot be `internal_admin`. */
+    role_id: string;
+}
+/** Create a new tenant-level admin user. Requires the server admin API key. */
+interface CreateTenantUserRequest {
+    name: string;
+    email: string;
+    password: string;
+}
+/** Bootstrap a new merchant: creates user, merchant account, project, profile, and API keys in one call. */
+interface OnboardMerchantRequest {
+    email: string;
+    name: string;
+    password: string;
+    company_name: string;
+}
+/** All identifiers and keys produced by the onboard flow. */
+interface OnboardMerchantResponse {
+    merchant_id: string;
+    user_id: string;
+    user_email: string;
+    project_id: string;
+    profile_id: string;
+    /** Secret API key (sk_…). Show once; store securely. */
+    api_key: string;
+    /** Publishable key (pk_…) for client-side SDKs. */
+    publishable_key: string;
+}
+/** Toggle public signup on or off at runtime. */
+interface SignupToggleRequest {
+    enabled: boolean;
+}
+/** Current public-signup status. */
+interface SignupToggleResponse {
+    signup_enabled: boolean;
+}
+interface AdminCustomerListParams {
+    search?: string | null;
+    is_active?: boolean | null;
+    offset?: number | null;
+    limit?: number | null;
+}
+interface CustomerSummary {
+    customer_id: string;
+    organization_id: string;
+    shop_count: number;
+    is_active: boolean;
+    created_at: string;
+    customer_name?: string | null;
+    email?: string | null;
+}
+interface AdminCustomerListResponse {
+    customers: CustomerSummary[];
+    total_count: number;
+    offset: number;
+    limit: number;
+}
+interface CustomerUser {
+    user_id: string;
+    email?: string | null;
+    name?: string | null;
+    role_id?: string | null;
+    is_active: boolean;
+    created_at: string;
+}
+interface AdminCustomerDetail {
+    customer_id: string;
+    organization_id: string;
+    employee_count: number;
+    total_transactions: number;
+    total_volume: number;
+    created_at: string;
+    customer_name?: string | null;
+    projects: ProjectResponse[];
+    shops: ShopResponse[];
+    users: CustomerUser[];
+}
+interface AdminTransactionListParams {
+    merchant_id?: string | null;
+    shop_id?: string | null;
+    status?: string | null;
+    start_date?: string | null;
+    end_date?: string | null;
+    offset?: number | null;
+    limit?: number | null;
+}
+interface AdminTransactionListResponse {
+    data: PaymentResponse[];
+    total_count?: number | null;
+}
+interface AdminAnalyticsRequest {
+    start_date?: string | null;
+    end_date?: string | null;
+}
+interface OverviewStat {
+    label: string;
+    value: number;
+    change_percent: number;
+}
+interface OverviewStatsResponse {
+    total_accounts: OverviewStat;
+    total_admins: OverviewStat;
+    audit_events: OverviewStat;
+}
+interface PlatformAnalyticsResponse {
+    total_customers: number;
+    total_shops: number;
+    total_transactions: number;
+    total_volume: number;
+    total_fees_collected: number;
+    period_start: string;
+    period_end: string;
+}
+interface PaymentAnalyticsRequest {
+    period?: number | null;
+    currency?: string | null;
+}
+interface PaymentStat {
+    label: string;
+    value: number;
+    change_percent: number;
+}
+interface PaymentAnalyticsResponse {
+    total_volume: PaymentStat;
+    success_rate: PaymentStat;
+    transactions: PaymentStat;
+    avg_transaction: PaymentStat;
+    currency: string;
+    period_days: number;
+}
+interface AuditLogListParams {
+    user_id?: string | null;
+    merchant_id?: string | null;
+    profile_id?: string | null;
+    action?: string | null;
+    entity_type?: string | null;
+    start_date?: string | null;
+    end_date?: string | null;
+    offset?: number | null;
+    limit?: number | null;
+}
+interface AuditLogResponse {
+    id: string;
+    user_id: string;
+    action: string;
+    entity_type: string;
+    created_at: string;
+    merchant_id?: string | null;
+    profile_id?: string | null;
+    entity_id?: string | null;
+    details?: unknown | null;
+    ip_address?: string | null;
+}
+interface AuditLogListResponse {
+    entries: AuditLogResponse[];
+    total_count: number;
+    offset: number;
+    limit: number;
+}
+interface CardIssuerCreateRequest {
+    issuer_name: string;
+}
+interface CardIssuerUpdateRequest {
+    issuer_name: string;
+}
+interface CardIssuerResponse {
+    id: string;
+    issuer_name: string;
+}
+interface CardIssuerListResponse {
+    issuers: CardIssuerResponse[];
+}
+type GsmDecision = 'retry' | 'do_default';
+interface GsmRuleCreateRequest {
+    connector: string;
+    flow: string;
+    sub_flow: string;
+    code: string;
+    message: string;
+    status: string;
+    decision: GsmDecision;
+    step_up_possible: boolean;
+    clear_pan_possible: boolean;
+    router_error?: string | null;
+    unified_code?: string | null;
+    unified_message?: string | null;
+}
+interface GsmRuleUpdateRequest {
+    connector: string;
+    flow: string;
+    sub_flow: string;
+    code: string;
+    message: string;
+    status?: string | null;
+    router_error?: string | null;
+    decision?: GsmDecision | null;
+    step_up_possible?: boolean | null;
+    unified_code?: string | null;
+    unified_message?: string | null;
+}
+interface GsmRuleResponse {
+    connector: string;
+    flow: string;
+    sub_flow: string;
+    code: string;
+    message: string;
+    status: string;
+    decision: GsmDecision;
+    step_up_possible: boolean;
+    clear_pan_possible: boolean;
+    feature: string;
+    feature_data: unknown;
+    router_error?: string | null;
+    unified_code?: string | null;
+    unified_message?: string | null;
+}
 
 declare class Admin {
     private readonly request;
@@ -59,6 +309,62 @@ declare class AuditLogs {
     retrieve(logId: string): Promise<AuditLogResponse>;
 }
 
+declare class Cache {
+    private readonly request;
+    constructor(request: RequestFn);
+    /** Invalidate a cache entry by key. `POST /cache/invalidate/{key}` */
+    invalidate(key: string): Promise<Record<string, unknown>>;
+}
+
+declare class CardIssuers {
+    private readonly request;
+    constructor(request: RequestFn);
+    create(params: CardIssuerCreateRequest): Promise<CardIssuerResponse>;
+    update(issuerId: string, params: CardIssuerUpdateRequest): Promise<CardIssuerResponse>;
+    list(): Promise<CardIssuerListResponse>;
+}
+
+declare class Configs {
+    private readonly request;
+    constructor(request: RequestFn);
+    /** Create a config. `POST /configs` */
+    create(params: Record<string, unknown>): Promise<Record<string, unknown>>;
+    /** Retrieve a config by key. `GET /configs/{key}` */
+    retrieve(key: string): Promise<Record<string, unknown>>;
+    /** Update a config. `PUT /configs/{key}` */
+    update(key: string, params: Record<string, unknown>): Promise<Record<string, unknown>>;
+    /** Delete a config. `DELETE /configs/{key}` */
+    delete(key: string): Promise<Record<string, unknown>>;
+}
+
+declare class Gsm {
+    private readonly request;
+    constructor(request: RequestFn);
+    create(params: GsmRuleCreateRequest): Promise<GsmRuleResponse>;
+    retrieve(params: Record<string, unknown>): Promise<GsmRuleResponse>;
+    update(params: GsmRuleUpdateRequest): Promise<GsmRuleResponse>;
+    delete(params: Record<string, unknown>): Promise<GsmRuleResponse>;
+}
+
+/**
+ * Platform-wide fee schedule management. Admin-only routes under
+ * `/admin/fees/*`. Exposed only via `'@delopay/sdk/internal'`.
+ */
+declare class PlatformFees {
+    private readonly request;
+    constructor(request: RequestFn);
+    /** Create a platform fee schedule for a specific merchant. */
+    create(params: FeeScheduleCreateRequest, merchantId: string): Promise<FeeScheduleResponse>;
+    /** List every platform fee schedule assigned to a merchant. */
+    list(merchantId: string): Promise<FeeScheduleResponse[]>;
+    /** Retrieve a single platform fee schedule by ID. */
+    retrieve(feeId: string): Promise<FeeScheduleResponse>;
+    /** Update a platform fee schedule. */
+    update(feeId: string, params: FeeScheduleUpdateRequest): Promise<FeeScheduleResponse>;
+    /** Delete a platform fee schedule. */
+    delete(feeId: string): Promise<FeeScheduleResponse>;
+}
+
 /**
  * Internal-only Delopay client for DeloPay staff tooling (the admin
  * control-center, audit UIs, etc.). Extends the public `Delopay` surface
@@ -68,19 +374,25 @@ declare class AuditLogs {
  * Import path: `import { DelopayInternal } from '@delopay/sdk/internal'`.
  * The merchant-facing `import { Delopay } from '@delopay/sdk'` never
  * surfaces these.
- *
- * Security note: the admin plane code still physically ships in the
- * public npm tarball (merchants who crack the tarball can read it); the
- * split is a discoverability fence, not an authorization boundary. The
- * backend's authz is what actually protects the admin routes — this
- * split just stops the merchant SDK from documenting their shape on
- * autocompletion.
  */
 declare class DelopayInternal extends Delopay {
+    /** Bootstrap admin endpoints — signup, signin, onboarding. */
     readonly admin: Admin;
+    /** Platform-wide customer, transaction, analytics, merchant-account ops. */
     readonly adminPortal: AdminPortal;
+    /** Audit log reads. */
     readonly auditLogs: AuditLogs;
+    /** Backend cache invalidation. */
+    readonly cache: Cache;
+    /** Platform card-issuer program management. */
+    readonly cardIssuers: CardIssuers;
+    /** Generic platform config store. */
+    readonly configs: Configs;
+    /** GSM (Gateway Status Mapping) routing rules. */
+    readonly gsm: Gsm;
+    /** Platform-wide fee schedules assigned to merchants. */
+    readonly platformFees: PlatformFees;
     constructor(...args: ConstructorParameters<typeof Delopay>);
 }
 
-export { Admin, AdminAnalyticsRequest, AdminCustomerDetail, AdminCustomerListParams, AdminCustomerListResponse, AdminPortal, AdminSignInRequest, AdminTransactionListParams, AdminTransactionListResponse, AuditLogListParams, AuditLogListResponse, AuditLogResponse, AuditLogs, AuthResponse, AuthorizeResponse, CreateInternalUserRequest, CreateTenantUserRequest, Delopay, DelopayInternal, MerchantAccountResponse, MerchantAccountUpdateRequest, OnboardMerchantRequest, OnboardMerchantResponse, OverviewStatsResponse, PaymentAnalyticsRequest, PaymentAnalyticsResponse, PlatformAnalyticsResponse, RequestFn, SignUpWithMerchantIdRequest, SignupToggleRequest, SignupToggleResponse };
+export { Admin, type AdminAnalyticsRequest, type AdminCustomerDetail, type AdminCustomerListParams, type AdminCustomerListResponse, AdminPortal, type AdminSignInRequest, type AdminTransactionListParams, type AdminTransactionListResponse, type AuditLogListParams, type AuditLogListResponse, type AuditLogResponse, AuditLogs, AuthResponse, type AuthorizeResponse, Cache, type CardIssuerCreateRequest, type CardIssuerListResponse, type CardIssuerResponse, type CardIssuerUpdateRequest, CardIssuers, Configs, type CreateInternalUserRequest, type CreateTenantUserRequest, type CustomerSummary, type CustomerUser, Delopay, DelopayInternal, FeeScheduleCreateRequest, FeeScheduleResponse, FeeScheduleUpdateRequest, Gsm, type GsmDecision, type GsmRuleCreateRequest, type GsmRuleResponse, type GsmRuleUpdateRequest, MerchantAccountResponse, MerchantAccountUpdateRequest, type OnboardMerchantRequest, type OnboardMerchantResponse, type OverviewStat, type OverviewStatsResponse, type PaymentAnalyticsRequest, type PaymentAnalyticsResponse, PaymentResponse, type PaymentStat, type PlatformAnalyticsResponse, PlatformFees, ProjectResponse, RequestFn, ShopResponse, SignUpWithMerchantIdRequest, type SignupToggleRequest, type SignupToggleResponse };