@stackbe/sdk 0.13.0 → 0.15.0

package/dist/index.d.mts

@@ -565,6 +565,56 @@ interface PaymentWebhookPayload {
     status: 'succeeded' | 'failed';
     failureReason?: string;
 }
+/** Payment method details */
+interface PaymentMethod {
+    id: string;
+    customerId: string;
+    gateway: 'stripe' | 'paypal' | 'authorize_net';
+    type: string;
+    last4?: string;
+    brand?: string;
+    expiryMonth?: number;
+    expiryYear?: number;
+    isDefault: boolean;
+    status: 'active' | 'expired' | 'failed';
+    createdAt: string;
+}
+/** Create setup session options */
+interface CreateSetupSessionOptions {
+    successUrl: string;
+    cancelUrl: string;
+}
+/** Setup session response */
+interface SetupSessionResponse {
+    sessionId: string;
+    url: string;
+    clientSecret?: string;
+}
+/** Attach payment method options */
+interface AttachPaymentMethodOptions {
+    gatewayPaymentMethodId: string;
+    setAsDefault?: boolean;
+}
+/** Charge subscription result */
+interface ChargeResult {
+    chargeId: string;
+    success: boolean;
+    status: 'succeeded' | 'failed' | 'pending' | 'requires_action';
+    gatewayChargeId?: string;
+    errorCode?: string;
+    errorMessage?: string;
+    requiresAction?: boolean;
+    actionUrl?: string;
+    actionExpiresAt?: string;
+}
+/** Migration to StackBE-managed result */
+interface MigrateToStackbeManagedResult {
+    subscriptionId: string;
+    billingMode: 'stackbe_managed';
+    paymentMethodId: string;
+    nextBillingDate: string;
+    message: string;
+}
 type SubscriptionCreatedEvent = WebhookEvent<'subscription_created', SubscriptionWebhookPayload>;
 type SubscriptionUpdatedEvent = WebhookEvent<'subscription_updated', SubscriptionWebhookPayload>;
 type SubscriptionCancelledEvent = WebhookEvent<'subscription_cancelled', SubscriptionWebhookPayload>;
@@ -577,6 +627,70 @@ type CustomerCreatedEvent = WebhookEvent<'customer_created', CustomerWebhookPayl
 type CustomerUpdatedEvent = WebhookEvent<'customer_updated', CustomerWebhookPayload>;
 /** Union of all webhook event types */
 type AnyWebhookEvent = SubscriptionCreatedEvent | SubscriptionUpdatedEvent | SubscriptionCancelledEvent | SubscriptionRenewedEvent | TrialStartedEvent | TrialEndedEvent | PaymentSucceededEvent | PaymentFailedEvent | CustomerCreatedEvent | CustomerUpdatedEvent;
+interface DealRegistration {
+    id: string;
+    affiliateId: string;
+    programId: string;
+    leadEmail: string;
+    leadName?: string | null;
+    notes?: string | null;
+    status: 'pending' | 'approved' | 'converted' | 'expired' | 'rejected';
+    expiresAt: string;
+    approvedAt?: string | null;
+    convertedAt?: string | null;
+    rejectedAt?: string | null;
+    rejectionReason?: string | null;
+    convertedCustomerId?: string | null;
+    convertedSubscriptionId?: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+interface PartnerDashboard {
+    affiliate: {
+        id: string;
+        code: string;
+        type: string;
+        status: string;
+        totalEarned: number;
+        pendingBalance: number;
+        paidOut: number;
+        totalReferrals: number;
+        totalConversions: number;
+    };
+    tier?: {
+        id: string;
+        name: string;
+        level: number;
+        commissionRate: number;
+        commissionType: string;
+    } | null;
+    earningsBySource: {
+        link: number;
+        coupon: number;
+        deal: number;
+    };
+    recentCommissions: Array<{
+        id: string;
+        amount: number;
+        currency: string;
+        status: string;
+        createdAt: string;
+    }>;
+    activeDeals: Array<{
+        id: string;
+        leadEmail: string;
+        status: string;
+        expiresAt: string;
+        createdAt: string;
+    }>;
+    coupons: Array<{
+        id: string;
+        code: string;
+        discountType: string;
+        discountValue: number;
+        timesRedeemed: number;
+    }>;
+}
 
 declare class UsageClient {
     private http;
@@ -1348,6 +1462,160 @@ declare class SubscriptionsClient {
     checkAccess(subscriptionId: string): Promise<{
         hasAccess: boolean;
     }>;
+    /**
+     * Manually charge a StackBE-managed subscription.
+     *
+     * This is useful for:
+     * - Testing billing in development
+     * - Recovering from failed automatic charges
+     * - Charging ahead of schedule
+     *
+     * The subscription must be in `stackbe_managed` billing mode.
+     *
+     * @example
+     * ```typescript
+     * const result = await stackbe.subscriptions.charge('sub_123');
+     *
+     * if (result.success) {
+     *   console.log('Charge successful:', result.chargeId);
+     * } else if (result.requiresAction) {
+     *   // Redirect customer to 3DS authentication
+     *   window.location.href = result.actionUrl;
+     * } else {
+     *   console.log('Charge failed:', result.errorMessage);
+     * }
+     * ```
+     */
+    charge(subscriptionId: string): Promise<ChargeResult>;
+    /**
+     * Migrate a subscription from gateway-managed to StackBE-managed billing.
+     *
+     * This will:
+     * 1. Extract the payment method from the gateway subscription
+     * 2. Store it in StackBE's PaymentMethod table
+     * 3. Set the subscription to `stackbe_managed` billing mode
+     * 4. Cancel the gateway subscription at period end
+     * 5. StackBE will handle renewals going forward
+     *
+     * Use cases:
+     * - Migrate existing Stripe subscriptions to unified StackBE billing
+     * - Prepare for multi-gateway support
+     * - Gain more control over billing timing and retry logic
+     *
+     * @example
+     * ```typescript
+     * const result = await stackbe.subscriptions.migrateToStackbeManaged('sub_123');
+     *
+     * console.log('Migration complete');
+     * console.log('Payment method:', result.paymentMethodId);
+     * console.log('Next billing date:', result.nextBillingDate);
+     * ```
+     */
+    migrateToStackbeManaged(subscriptionId: string): Promise<MigrateToStackbeManagedResult>;
+}
+
+declare class PaymentMethodsClient {
+    private http;
+    constructor(http: HttpClient);
+    /**
+     * Create a setup session for collecting a payment method.
+     *
+     * Returns a URL to redirect the customer to for secure payment method collection.
+     * This is similar to Stripe Checkout but in setup mode - no charge is made.
+     *
+     * @example
+     * ```typescript
+     * const session = await stackbe.paymentMethods.createSetupSession('cust_123', {
+     *   successUrl: 'https://yourapp.com/payment-methods/success',
+     *   cancelUrl: 'https://yourapp.com/payment-methods/cancel',
+     * });
+     *
+     * // Redirect customer to payment method collection
+     * window.location.href = session.url;
+     * ```
+     */
+    createSetupSession(customerId: string, options: CreateSetupSessionOptions): Promise<SetupSessionResponse>;
+    /**
+     * Attach a payment method to a customer.
+     *
+     * After the customer completes the setup session, call this to store
+     * the payment method in StackBE for future charges.
+     *
+     * @example
+     * ```typescript
+     * // After redirect from setup session
+     * const paymentMethod = await stackbe.paymentMethods.attach('cust_123', {
+     *   gatewayPaymentMethodId: 'pm_1234...', // From setup session completion
+     *   setAsDefault: true,
+     * });
+     *
+     * console.log(`Added ${paymentMethod.brand} ending in ${paymentMethod.last4}`);
+     * ```
+     */
+    attach(customerId: string, options: AttachPaymentMethodOptions): Promise<PaymentMethod>;
+    /**
+     * List all payment methods for a customer.
+     *
+     * @example
+     * ```typescript
+     * const paymentMethods = await stackbe.paymentMethods.list('cust_123');
+     *
+     * for (const pm of paymentMethods) {
+     *   console.log(`${pm.brand} **** ${pm.last4} ${pm.isDefault ? '(default)' : ''}`);
+     * }
+     * ```
+     */
+    list(customerId: string, options?: {
+        status?: string;
+    }): Promise<PaymentMethod[]>;
+    /**
+     * Get a specific payment method.
+     *
+     * @example
+     * ```typescript
+     * const pm = await stackbe.paymentMethods.get('cust_123', 'pm_123');
+     * console.log(`Expires: ${pm.expiryMonth}/${pm.expiryYear}`);
+     * ```
+     */
+    get(customerId: string, paymentMethodId: string): Promise<PaymentMethod>;
+    /**
+     * Set a payment method as the default for a customer.
+     *
+     * The default payment method is used for subscription renewals.
+     *
+     * @example
+     * ```typescript
+     * await stackbe.paymentMethods.setDefault('cust_123', 'pm_456');
+     * console.log('Default payment method updated');
+     * ```
+     */
+    setDefault(customerId: string, paymentMethodId: string): Promise<PaymentMethod>;
+    /**
+     * Remove a payment method.
+     *
+     * Cannot remove a payment method that is being used by an active subscription.
+     *
+     * @example
+     * ```typescript
+     * await stackbe.paymentMethods.remove('cust_123', 'pm_old');
+     * console.log('Payment method removed');
+     * ```
+     */
+    remove(customerId: string, paymentMethodId: string): Promise<{
+        success: boolean;
+    }>;
+    /**
+     * Get the default payment method for a customer.
+     *
+     * @example
+     * ```typescript
+     * const defaultPM = await stackbe.paymentMethods.getDefault('cust_123');
+     * if (defaultPM) {
+     *   console.log(`Default: ${defaultPM.brand} **** ${defaultPM.last4}`);
+     * }
+     * ```
+     */
+    getDefault(customerId: string): Promise<PaymentMethod | null>;
 }
 
 interface AuthClientOptions {
@@ -2073,6 +2341,7 @@ interface AffiliateInfo {
     enrolled: boolean;
     id?: string;
     code?: string;
+    type?: 'affiliate' | 'referral' | 'reseller';
     status?: 'active' | 'suspended' | 'pending';
     totalEarned?: number;
     pendingBalance?: number;
@@ -2084,6 +2353,7 @@ interface AffiliateInfo {
 interface AffiliateEnrollment {
     id: string;
     code: string;
+    type: string;
     status: string;
     createdAt: string;
 }
@@ -2116,6 +2386,20 @@ interface EnrollOptions {
     code?: string;
     /** PayPal email for payouts */
     payoutEmail?: string;
+    /** Partner type (default: 'affiliate') */
+    type?: 'affiliate' | 'referral' | 'reseller';
+}
+interface RegisterDealOptions {
+    /** Email of the lead */
+    leadEmail: string;
+    /** Name of the lead */
+    leadName?: string;
+    /** Notes about the deal */
+    notes?: string;
+}
+interface DealListResponse {
+    deals: DealRegistration[];
+    total: number;
 }
 declare class AffiliatesClient {
     private http;
@@ -2123,86 +2407,66 @@ declare class AffiliatesClient {
     /**
      * Get the current customer's affiliate info.
      * Requires customer session token.
-     *
-     * @example
-     * ```typescript
-     * const affiliate = await stackbe.affiliates.get();
-     *
-     * if (affiliate.enrolled) {
-     *   console.log(`Your referral code: ${affiliate.code}`);
-     *   console.log(`Earnings: $${(affiliate.totalEarned! / 100).toFixed(2)}`);
-     * } else {
-     *   console.log('Not enrolled in affiliate program');
-     * }
-     * ```
      */
     get(): Promise<AffiliateInfo>;
     /**
-     * Enroll the current customer as an affiliate.
+     * Enroll the current customer as an affiliate/partner.
      * Requires customer session token.
      *
      * @example
      * ```typescript
-     * // Enroll with auto-generated code
-     * const affiliate = await stackbe.affiliates.enroll();
+     * const affiliate = await stackbe.affiliates.enroll({ type: 'referral' });
      * console.log(`Your referral code: ${affiliate.code}`);
-     *
-     * // Enroll with custom code
-     * const affiliate = await stackbe.affiliates.enroll({
-     *   code: 'MYCODE',
-     *   payoutEmail: 'payouts@example.com',
-     * });
      * ```
      */
     enroll(options?: EnrollOptions): Promise<AffiliateEnrollment>;
     /**
      * Get affiliate statistics.
      * Requires customer session token.
-     *
-     * @example
-     * ```typescript
-     * const stats = await stackbe.affiliates.getStats();
-     *
-     * if (stats.enrolled) {
-     *   console.log(`Total earned: $${(stats.totalEarned / 100).toFixed(2)}`);
-     *   console.log(`Pending: $${(stats.pendingBalance / 100).toFixed(2)}`);
-     *   console.log(`Referrals: ${stats.totalReferrals}`);
-     *   console.log(`Conversions: ${stats.totalConversions}`);
-     * }
-     * ```
      */
     getStats(): Promise<AffiliateStats>;
     /**
      * Get affiliate commission history.
      * Requires customer session token.
+     */
+    getCommissions(): Promise<AffiliateCommissionsResponse>;
+    /**
+     * Track a referral click (store token for attribution).
+     * Requires API key.
+     */
+    trackReferral(code: string, referralUrl?: string): Promise<TrackReferralResponse>;
+    /**
+     * Get the full partner dashboard with stats, earnings by source, deals, and coupons.
+     * Requires customer session token.
      *
      * @example
      * ```typescript
-     * const { commissions, total } = await stackbe.affiliates.getCommissions();
-     *
-     * commissions.forEach((c) => {
-     *   console.log(`$${(c.amount / 100).toFixed(2)} - ${c.status}`);
-     * });
+     * const dashboard = await stackbe.affiliates.getDashboard();
+     * console.log(`Link earnings: $${dashboard.earningsBySource.link}`);
+     * console.log(`Coupon earnings: $${dashboard.earningsBySource.coupon}`);
+     * console.log(`Deal earnings: $${dashboard.earningsBySource.deal}`);
      * ```
      */
-    getCommissions(): Promise<AffiliateCommissionsResponse>;
+    getDashboard(): Promise<PartnerDashboard>;
     /**
-     * Track a referral click (store token for attribution).
-     * Call this when a user lands on your site with a referral code.
-     * Requires API key.
+     * Register a deal (lead attribution).
+     * Requires customer session token and active partner enrollment.
      *
      * @example
      * ```typescript
-     * // In your landing page handler
-     * const refCode = req.query.ref;
-     * if (refCode) {
-     *   const { token, expiresInDays } = await stackbe.affiliates.trackReferral(refCode);
-     *   // Store token in cookie for attribution on signup
-     *   res.cookie('ref_token', token, { maxAge: expiresInDays * 24 * 60 * 60 * 1000 });
-     * }
+     * const deal = await stackbe.affiliates.registerDeal({
+     *   leadEmail: 'prospect@company.com',
+     *   leadName: 'John Smith',
+     *   notes: 'Met at conference, interested in Pro plan',
+     * });
      * ```
      */
-    trackReferral(code: string, referralUrl?: string): Promise<TrackReferralResponse>;
+    registerDeal(options: RegisterDealOptions): Promise<DealRegistration>;
+    /**
+     * List the current partner's deal registrations.
+     * Requires customer session token.
+     */
+    listDeals(): Promise<DealListResponse>;
 }
 
 interface EarlyAccessSignup {
@@ -2665,6 +2929,8 @@ declare class StackBE {
     readonly checkout: CheckoutClient;
     /** Subscription management */
     readonly subscriptions: SubscriptionsClient;
+    /** Payment method management (StackBE-managed billing) */
+    readonly paymentMethods: PaymentMethodsClient;
     /** Customer authentication (magic links) */
     readonly auth: AuthClient;
     /** Organization management (B2B multi-user) */
@@ -2783,4 +3049,4 @@ declare class StackBE {
     }): (req: any, res: any, next: any) => Promise<any>;
 }
 
-export { type AddMemberOptions, type AffiliateCommission, type AffiliateCommissionsResponse, type AffiliateEnrollment, type AffiliateInfo, type AffiliateStats, AffiliatesClient, AnalyticsClient, type AnalyticsFilterOptions, type AnyWebhookEvent, AuthClient, type BillingPortalSession, type CancelSubscriptionOptions, type CancelSubscriptionResponse, type CheckEntitlementResponse, type CheckUsageResponse, CheckoutClient, type CheckoutSessionResponse, type Coupon, type CouponDiscountType, type CouponDuration, CouponsClient, type CreateCheckoutOptions, type CreateCouponOptions, type CreateCustomerOptions, type CreateEarlyAccessSignupOptions, type CreateFeatureRequestOptions, type CreateOrganizationOptions, type Customer, type CustomerCreatedEvent, type CustomerFeatureActivity, type CustomerInvoice, type CustomerInvoicesResponse, type CustomerPaymentMethod, type CustomerSubscriptionHistory, type CustomerSubscriptionHistoryResponse, type CustomerUpdatedEvent, type CustomerUsageResponse, type CustomerWebhookPayload, type CustomerWithSubscription, CustomersClient, type DashboardMetrics, type DunningStatus, EarlyAccessClient, type EarlyAccessSignup, type EarlyAccessSignupListResponse, type EnrollOptions, EntitlementsClient, type EntitlementsResponse, type FeatureRequest, type FeatureRequestComment, type FeatureRequestImage, type FeatureRequestListResponse, FeatureRequestsClient, type FeatureUsagePoint, type GetSubscriptionOptions, type GrowthChartPoint, type GrowthMetrics, type InterestedCustomer, type InterestedCustomersResponse, type InviteMemberOptions, type ListEarlyAccessOptions, type ListFeatureRequestsOptions, type ListPlansOptions, type ListProductsOptions, type MRRHistoryPoint, type MagicLinkOptions, type MagicLinkResponse, type Organization, type OrganizationInvite, type OrganizationMember, OrganizationsClient, type PaymentFailedEvent, type PaymentSucceededEvent, type PaymentWebhookPayload, type PerformanceMetrics, type Plan, type PlanMetrics, PlansClient, type PopularEndpoint, type Product, ProductsClient, type RequestCountPoint, type RevenueByPlan, type SessionResponse, StackBE, type StackBEConfig, StackBEError, type StackBEErrorCode, type StackBEErrorResponse, type Subscription, type SubscriptionCancelledEvent, type SubscriptionCreatedEvent, type SubscriptionPlan, type SubscriptionRenewedEvent, type SubscriptionUpdatedEvent, type SubscriptionWebhookPayload, type SubscriptionWithPlan, SubscriptionsClient, type SwitchOrganizationResponse, type TimeRangeOptions, type TrackReferralResponse, type TrackUsageOptions, type TrackUsageResponse, type TrialEndedEvent, type TrialMetrics, type TrialStartedEvent, type TrialStatus, type UpcomingInvoice, type UpdateCouponOptions, type UpdateCustomerOptions, type UpdateOrganizationOptions, type UpdateSubscriptionOptions, UsageClient, type UsageMetric, type ValidateCouponResult, type VerifyTokenResponse, type WebhookEvent, type WebhookEventType };
+export { type AddMemberOptions, type AffiliateCommission, type AffiliateCommissionsResponse, type AffiliateEnrollment, type AffiliateInfo, type AffiliateStats, AffiliatesClient, AnalyticsClient, type AnalyticsFilterOptions, type AnyWebhookEvent, type AttachPaymentMethodOptions, AuthClient, type BillingPortalSession, type CancelSubscriptionOptions, type CancelSubscriptionResponse, type ChargeResult, type CheckEntitlementResponse, type CheckUsageResponse, CheckoutClient, type CheckoutSessionResponse, type Coupon, type CouponDiscountType, type CouponDuration, CouponsClient, type CreateCheckoutOptions, type CreateCouponOptions, type CreateCustomerOptions, type CreateEarlyAccessSignupOptions, type CreateFeatureRequestOptions, type CreateOrganizationOptions, type CreateSetupSessionOptions, type Customer, type CustomerCreatedEvent, type CustomerFeatureActivity, type CustomerInvoice, type CustomerInvoicesResponse, type CustomerPaymentMethod, type CustomerSubscriptionHistory, type CustomerSubscriptionHistoryResponse, type CustomerUpdatedEvent, type CustomerUsageResponse, type CustomerWebhookPayload, type CustomerWithSubscription, CustomersClient, type DashboardMetrics, type DunningStatus, EarlyAccessClient, type EarlyAccessSignup, type EarlyAccessSignupListResponse, type EnrollOptions, EntitlementsClient, type EntitlementsResponse, type FeatureRequest, type FeatureRequestComment, type FeatureRequestImage, type FeatureRequestListResponse, FeatureRequestsClient, type FeatureUsagePoint, type GetSubscriptionOptions, type GrowthChartPoint, type GrowthMetrics, type InterestedCustomer, type InterestedCustomersResponse, type InviteMemberOptions, type ListEarlyAccessOptions, type ListFeatureRequestsOptions, type ListPlansOptions, type ListProductsOptions, type MRRHistoryPoint, type MagicLinkOptions, type MagicLinkResponse, type MigrateToStackbeManagedResult, type Organization, type OrganizationInvite, type OrganizationMember, OrganizationsClient, type PaymentFailedEvent, type PaymentMethod, PaymentMethodsClient, type PaymentSucceededEvent, type PaymentWebhookPayload, type PerformanceMetrics, type Plan, type PlanMetrics, PlansClient, type PopularEndpoint, type Product, ProductsClient, type RequestCountPoint, type RevenueByPlan, type SessionResponse, type SetupSessionResponse, StackBE, type StackBEConfig, StackBEError, type StackBEErrorCode, type StackBEErrorResponse, type Subscription, type SubscriptionCancelledEvent, type SubscriptionCreatedEvent, type SubscriptionPlan, type SubscriptionRenewedEvent, type SubscriptionUpdatedEvent, type SubscriptionWebhookPayload, type SubscriptionWithPlan, SubscriptionsClient, type SwitchOrganizationResponse, type TimeRangeOptions, type TrackReferralResponse, type TrackUsageOptions, type TrackUsageResponse, type TrialEndedEvent, type TrialMetrics, type TrialStartedEvent, type TrialStatus, type UpcomingInvoice, type UpdateCouponOptions, type UpdateCustomerOptions, type UpdateOrganizationOptions, type UpdateSubscriptionOptions, UsageClient, type UsageMetric, type ValidateCouponResult, type VerifyTokenResponse, type WebhookEvent, type WebhookEventType };