@happyvertical/smrt-affiliates 0.30.0

package/dist/index.d.ts

@@ -0,0 +1,932 @@
+import { SmrtCollection } from '@happyvertical/smrt-core';
+import { SmrtObject } from '@happyvertical/smrt-core';
+
+/**
+ * Commission tracks revenue attribution from ad events to partners.
+ *
+ * Each ad event can generate multiple commissions:
+ * - Display commission to publisher (site owner)
+ * - Referral commission to referrer (who brought in the publisher)
+ * - Sales commission to salesperson (who brought in the advertiser)
+ * - Parent commission to salesperson's parent publisher
+ *
+ * References:
+ * - eventId: String reference to smrt-ads AdEvent (cross-package)
+ * - partnerId: FK to Partner (within package)
+ * - payoutId: FK to Payout (within package)
+ *
+ * @example
+ * ```typescript
+ * // Create display commission for a publisher
+ * const commission = await commissions.create({
+ *   eventId: 'adevent-uuid',
+ *   partnerId: publisher.id,
+ *   commissionType: CommissionType.DISPLAY,
+ *   grossRevenue: 100,  // 1 cent = $0.01
+ *   commissionRate: 0.50,
+ *   commissionAmount: 50,  // 0.5 cents
+ *   currency: 'CAD',
+ *   status: CommissionStatus.PENDING
+ * });
+ * ```
+ */
+export declare class Commission extends SmrtObject {
+    /**
+     * Calculate commission amount from gross revenue and rate
+     *
+     * @param grossRevenue - Gross revenue in cents
+     * @param rate - Commission rate (0-1)
+     * @returns Commission amount in cents (rounded)
+     *
+     * @example
+     * ```typescript
+     * const amount = Commission.calculateAmount(1000, 0.50); // 500 cents
+     * ```
+     */
+    static calculateAmount(grossRevenue: number, rate: number): number;
+    /**
+     * Ad Event ID (FK to smrt-ads AdEvent, cross-package)
+     */
+    eventId: string;
+    /**
+     * Partner ID (FK to Partner)
+     */
+    partnerId: string;
+    /**
+     * Commission type (display, referral, sales, parent)
+     */
+    commissionType: CommissionType;
+    /**
+     * Gross revenue from the event in cents
+     * This is the total ad revenue before commission split
+     */
+    grossRevenue: number;
+    /**
+     * Commission rate applied (0-1)
+     * Copied from partner at time of event for audit trail
+     */
+    commissionRate: number;
+    /**
+     * Calculated commission amount in cents
+     * = grossRevenue * commissionRate
+     */
+    commissionAmount: number;
+    /**
+     * Currency code
+     * Defaults to CAD
+     */
+    currency: string;
+    /**
+     * Payout ID when commission is included in a payout
+     */
+    payoutId: string;
+    /**
+     * Commission status
+     */
+    status: CommissionStatus;
+    /**
+     * Event timestamp (copied from AdEvent for reporting)
+     */
+    eventTimestamp: Date;
+    /**
+     * Network ID for aggregate queries (optional context)
+     */
+    networkId: string;
+    /**
+     * Site/Property ID for aggregate queries (optional context)
+     */
+    siteId: string;
+    /**
+     * Campaign ID for aggregate queries (optional context)
+     */
+    campaignId: string;
+    /**
+     * Additional metadata as JSON string
+     */
+    metadata: string;
+    constructor(options?: any);
+    /**
+     * Check if commission is pending (not yet in a payout)
+     */
+    isPending(): boolean;
+    /**
+     * Check if commission is included in a payout
+     */
+    isIncluded(): boolean;
+    /**
+     * Check if commission has been paid
+     */
+    isPaid(): boolean;
+    /**
+     * Check if this is a display commission
+     */
+    isDisplay(): boolean;
+    /**
+     * Check if this is a referral commission
+     */
+    isReferral(): boolean;
+    /**
+     * Check if this is a sales commission
+     */
+    isSales(): boolean;
+    /**
+     * Check if this is a parent commission
+     */
+    isParent(): boolean;
+    /**
+     * Check if this is an overhead commission
+     */
+    isOverhead(): boolean;
+    /**
+     * Get commission amount in dollars (for display)
+     */
+    getAmountInDollars(): number;
+    /**
+     * Get gross revenue in dollars (for display)
+     */
+    getGrossRevenueInDollars(): number;
+    /**
+     * Get metadata as object
+     */
+    getMetadata(): Record<string, any>;
+    /**
+     * Set metadata from object
+     */
+    setMetadata(data: Record<string, any>): void;
+}
+
+export declare class CommissionCollection extends SmrtCollection<Commission> {
+    static readonly _itemClass: typeof Commission;
+    /**
+     * Find commissions by partner
+     *
+     * @param partnerId - Partner ID
+     * @returns Array of commissions
+     */
+    findByPartner(partnerId: string): Promise<Commission[]>;
+    /**
+     * Find commissions by ad event
+     *
+     * @param eventId - Ad Event ID
+     * @returns Array of commissions
+     */
+    findByEvent(eventId: string): Promise<Commission[]>;
+    /**
+     * Find commissions by payout
+     *
+     * @param payoutId - Payout ID
+     * @returns Array of commissions
+     */
+    findByPayout(payoutId: string): Promise<Commission[]>;
+    /**
+     * Find commissions by status
+     *
+     * @param status - Commission status
+     * @returns Array of commissions
+     */
+    findByStatus(status: CommissionStatus): Promise<Commission[]>;
+    /**
+     * Find all pending commissions
+     */
+    findPending(): Promise<Commission[]>;
+    /**
+     * Find pending commissions for a partner
+     *
+     * @param partnerId - Partner ID
+     * @returns Array of pending commissions
+     */
+    findPendingByPartner(partnerId: string): Promise<Commission[]>;
+    /**
+     * Find commissions by type
+     *
+     * @param commissionType - Commission type
+     * @returns Array of commissions
+     */
+    findByType(commissionType: CommissionType): Promise<Commission[]>;
+    /**
+     * Find commissions in date range
+     *
+     * @param start - Start date
+     * @param end - End date
+     * @returns Array of commissions
+     */
+    findByDateRange(start: Date, end: Date): Promise<Commission[]>;
+    /**
+     * Find commissions for a partner in date range
+     *
+     * @param partnerId - Partner ID
+     * @param start - Start date
+     * @param end - End date
+     * @returns Array of commissions
+     */
+    findByPartnerAndDateRange(partnerId: string, start: Date, end: Date): Promise<Commission[]>;
+    /**
+     * Find all commissions for a network
+     *
+     * @param networkId - Network ID
+     * @returns Array of commissions
+     */
+    findByNetwork(networkId: string): Promise<Commission[]>;
+    /**
+     * Find commissions for a network filtered by type
+     *
+     * @param networkId - Network ID
+     * @param commissionType - Commission type
+     * @returns Array of commissions
+     */
+    findByNetworkAndType(networkId: string, commissionType: CommissionType): Promise<Commission[]>;
+    /**
+     * Find pending commissions for a network
+     *
+     * @param networkId - Network ID
+     * @returns Array of pending commissions
+     */
+    findPendingByNetwork(networkId: string): Promise<Commission[]>;
+    /**
+     * Get aggregate summary of commissions by type and site for a network.
+     *
+     * @param networkId - Network ID
+     * @param options - Optional filters (siteId, from, to, commissionType)
+     * @returns Summary with byType, bySite, total, and count
+     */
+    getSummaryByNetwork(networkId: string, options?: {
+        siteId?: string;
+        from?: Date;
+        to?: Date;
+        commissionType?: CommissionType;
+    }): Promise<{
+        byType: Record<string, number>;
+        bySite: Record<string, number>;
+        total: number;
+        count: number;
+    }>;
+    /**
+     * Get pending commissions grouped by partnerId for a network.
+     *
+     * @param networkId - Network ID
+     * @returns Array of payout groups (partnerId, totalPending, currency, entries)
+     */
+    getPendingPayoutsByNetwork(networkId: string): Promise<Array<{
+        partnerId: string;
+        totalPending: number;
+        currency: string;
+        entryCount: number;
+        entries: Array<{
+            id: string;
+            commissionType: string;
+            commissionAmount: number;
+            campaignId: string;
+            siteId: string;
+        }>;
+    }>>;
+    /**
+     * Sum pending commissions for a partner
+     *
+     * @param partnerId - Partner ID
+     * @returns Total pending amount in cents
+     */
+    sumPendingByPartner(partnerId: string): Promise<number>;
+    /**
+     * Sum commissions by type for a partner
+     *
+     * @param partnerId - Partner ID
+     * @param commissionType - Commission type
+     * @returns Total amount in cents
+     */
+    sumByPartnerAndType(partnerId: string, commissionType: CommissionType): Promise<number>;
+    /**
+     * Get earnings breakdown for a partner
+     *
+     * @param partnerId - Partner ID
+     * @returns Breakdown by commission type
+     */
+    getEarningsBreakdown(partnerId: string): Promise<{
+        display: number;
+        referral: number;
+        sales: number;
+        parent: number;
+        overhead: number;
+        total: number;
+    }>;
+    /**
+     * Get pending earnings breakdown for a partner
+     *
+     * @param partnerId - Partner ID
+     * @returns Breakdown of pending commissions by type
+     */
+    getPendingBreakdown(partnerId: string): Promise<{
+        display: number;
+        referral: number;
+        sales: number;
+        parent: number;
+        overhead: number;
+        total: number;
+    }>;
+}
+
+/**
+ * Commission status - lifecycle of a commission
+ */
+export declare enum CommissionStatus {
+    PENDING = "pending",
+    INCLUDED = "included",
+    PAID = "paid"
+}
+
+/**
+ * Commission types - how earnings were generated
+ */
+export declare enum CommissionType {
+    DISPLAY = "display",
+    REFERRAL = "referral",
+    SALES = "sales",
+    PARENT = "parent",
+    OVERHEAD = "overhead"
+}
+
+/**
+ * Partner represents an entity that earns commissions from ad revenue.
+ *
+ * Partners can be:
+ * - Publishers: Own sites that display ads (earn display commissions)
+ * - Salespeople: Bring in advertisers (earn sales commissions)
+ * - Referrers: Refer new publishers/partners (earn referral commissions)
+ *
+ * References:
+ * - profileId: String reference to smrt-profiles Profile (cross-package)
+ * - propertyId: String reference to smrt-properties Property (cross-package)
+ * - parentPartnerId: Self-reference for site-attached salespeople
+ *
+ * @example
+ * ```typescript
+ * // Create a publisher partner
+ * const publisher = await partners.create({
+ *   profileId: 'profile-uuid',
+ *   propertyId: 'property-uuid',
+ *   partnerTypes: JSON.stringify([PartnerType.PUBLISHER]),
+ *   displayCommissionRate: 0.50,
+ *   status: PartnerStatus.ACTIVE
+ * });
+ *
+ * // Create a salesperson attached to a publisher
+ * const salesperson = await partners.create({
+ *   profileId: 'salesperson-profile-uuid',
+ *   parentPartnerId: publisher.id,
+ *   partnerTypes: JSON.stringify([PartnerType.SALESPERSON]),
+ *   salesCommissionRate: 0.10,
+ *   parentCommissionShare: 0.20,
+ *   status: PartnerStatus.ACTIVE
+ * });
+ * ```
+ */
+export declare class Partner extends SmrtObject {
+    /**
+     * Profile ID (FK to smrt-profiles Profile, cross-package)
+     */
+    profileId: string;
+    /**
+     * Property ID (FK to smrt-properties Property, cross-package)
+     * Only set for publisher partners
+     */
+    propertyId: string;
+    /**
+     * Partner types as JSON array (publisher, salesperson, referrer)
+     * A partner can have multiple types
+     */
+    partnerTypes: string;
+    /**
+     * Parent partner ID (self-reference)
+     * For site-attached salespeople, this is the publisher they work under
+     */
+    parentPartnerId: string;
+    /**
+     * Referred by partner ID (self-reference)
+     * Tracks who referred this partner for referral commission attribution
+     */
+    referredById: string;
+    /**
+     * Share of commission that goes to parent partner (0-1)
+     * e.g., 0.20 means 20% of this partner's sales commission goes to parent
+     */
+    parentCommissionShare: number;
+    /**
+     * Commission rate for display (impression) revenue (0-1)
+     * Default 50% - publisher earns half of ad impression revenue
+     */
+    displayCommissionRate: number;
+    /**
+     * Commission rate for referral revenue (0-1)
+     * Default 5% - referrer earns 5% of referred partner's first-year revenue
+     */
+    referralCommissionRate: number;
+    /**
+     * Commission rate for sales revenue (0-1)
+     * Default 10% - salesperson earns 10% of advertiser spend they brought in
+     */
+    salesCommissionRate: number;
+    /**
+     * Minimum payout threshold in cents
+     * Default $50 = 5000 cents
+     */
+    payoutThreshold: number;
+    /**
+     * Preferred payout method
+     */
+    payoutMethod: PayoutMethod;
+    /**
+     * Currency code for all monetary values
+     * Defaults to CAD, allows future multi-currency support
+     */
+    currency: string;
+    /**
+     * Partner status
+     */
+    status: PartnerStatus;
+    /**
+     * Additional metadata as JSON string
+     * (bank details, tax info, etc.)
+     */
+    metadata: string;
+    constructor(options?: any);
+    /**
+     * Get partner types as array
+     */
+    getPartnerTypes(): PartnerType[];
+    /**
+     * Set partner types from array
+     */
+    setPartnerTypes(types: PartnerType[]): void;
+    /**
+     * Check if partner has a specific type
+     */
+    hasType(type: PartnerType): boolean;
+    /**
+     * Check if partner is a publisher
+     */
+    isPublisher(): boolean;
+    /**
+     * Check if partner is a salesperson
+     */
+    isSalesperson(): boolean;
+    /**
+     * Check if partner is a referrer
+     */
+    isReferrer(): boolean;
+    /**
+     * Check if partner is active
+     */
+    isActive(): boolean;
+    /**
+     * Check if partner is pending approval
+     */
+    isPending(): boolean;
+    /**
+     * Check if partner is suspended
+     */
+    isSuspended(): boolean;
+    /**
+     * Check if partner has a parent (site-attached)
+     */
+    hasParent(): boolean;
+    /**
+     * Check if partner was referred by another partner
+     */
+    wasReferred(): boolean;
+    /**
+     * Get metadata as object
+     */
+    getMetadata(): Record<string, any>;
+    /**
+     * Set metadata from object
+     */
+    setMetadata(data: Record<string, any>): void;
+    /**
+     * Calculate effective sales commission rate (after parent share)
+     */
+    getEffectiveSalesRate(): number;
+}
+
+export declare class PartnerCollection extends SmrtCollection<Partner> {
+    static readonly _itemClass: typeof Partner;
+    /**
+     * Find partners by profile ID
+     *
+     * @param profileId - Profile ID
+     * @returns Array of partners
+     */
+    findByProfile(profileId: string): Promise<Partner[]>;
+    /**
+     * Find partner by property ID (publishers)
+     *
+     * @param propertyId - Property ID
+     * @returns Partner or null
+     */
+    findByProperty(propertyId: string): Promise<Partner | null>;
+    /**
+     * Find partners by parent partner ID
+     *
+     * @param parentPartnerId - Parent partner ID
+     * @returns Array of child partners
+     */
+    findByParent(parentPartnerId: string): Promise<Partner[]>;
+    /**
+     * Find partners referred by a specific partner
+     *
+     * @param referredById - Referrer partner ID
+     * @returns Array of referred partners
+     */
+    findByReferrer(referredById: string): Promise<Partner[]>;
+    /**
+     * Find partners by status
+     *
+     * @param status - Partner status
+     * @returns Array of partners
+     */
+    findByStatus(status: PartnerStatus): Promise<Partner[]>;
+    /**
+     * Find all active partners
+     */
+    findActive(): Promise<Partner[]>;
+    /**
+     * Find all pending partners (awaiting approval)
+     */
+    findPending(): Promise<Partner[]>;
+    /**
+     * Find all suspended partners
+     */
+    findSuspended(): Promise<Partner[]>;
+    /**
+     * Find partners by type (requires in-memory filtering for JSON field)
+     *
+     * @param type - Partner type to filter by
+     * @returns Array of partners with that type
+     */
+    findByType(type: PartnerType): Promise<Partner[]>;
+    /**
+     * Find all publisher partners
+     */
+    findPublishers(): Promise<Partner[]>;
+    /**
+     * Find all salesperson partners
+     */
+    findSalespeople(): Promise<Partner[]>;
+    /**
+     * Find all referrer partners
+     */
+    findReferrers(): Promise<Partner[]>;
+    /**
+     * Find active publishers (for ad serving)
+     */
+    findActivePublishers(): Promise<Partner[]>;
+    /**
+     * Find partner for ad serving by property ID
+     * Returns active publisher partner for the property
+     *
+     * @param propertyId - Property ID
+     * @returns Active publisher partner or null
+     */
+    findActiveByProperty(propertyId: string): Promise<Partner | null>;
+    /**
+     * Find partners eligible for payout
+     * (active partners with pending commissions above threshold)
+     * Note: Actual threshold check requires joining with commissions
+     */
+    findEligibleForPayout(): Promise<Partner[]>;
+}
+
+/**
+ * Partner status
+ */
+export declare enum PartnerStatus {
+    PENDING = "pending",
+    ACTIVE = "active",
+    SUSPENDED = "suspended"
+}
+
+/**
+ * Types and enums for smrt-affiliates package
+ */
+/**
+ * Partner types - what role(s) this partner plays
+ */
+export declare enum PartnerType {
+    PUBLISHER = "publisher",
+    SALESPERSON = "salesperson",
+    REFERRER = "referrer"
+}
+
+/**
+ * Payout represents an aggregated payment batch for a partner.
+ *
+ * Payouts are created periodically (e.g., monthly) and include
+ * all pending commissions for a partner that meet the threshold.
+ *
+ * References:
+ * - partnerId: FK to Partner (within package)
+ * - invoiceId: String reference to smrt-commerce Invoice (cross-package)
+ *
+ * @example
+ * ```typescript
+ * // Create a payout for a partner
+ * const payout = await payouts.create({
+ *   partnerId: publisher.id,
+ *   periodStart: new Date('2024-01-01'),
+ *   periodEnd: new Date('2024-01-31'),
+ *   displayEarnings: 25000,  // $250.00
+ *   referralEarnings: 500,   // $5.00
+ *   salesEarnings: 0,
+ *   parentEarnings: 0,
+ *   totalAmount: 25500,      // $255.00
+ *   currency: 'CAD',
+ *   status: PayoutStatus.PENDING
+ * });
+ * ```
+ */
+export declare class Payout extends SmrtObject {
+    /**
+     * Partner ID (FK to Partner)
+     */
+    partnerId: string;
+    /**
+     * Period start date
+     */
+    periodStart: Date;
+    /**
+     * Period end date
+     */
+    periodEnd: Date;
+    /**
+     * Total display earnings in cents
+     */
+    displayEarnings: number;
+    /**
+     * Total referral earnings in cents
+     */
+    referralEarnings: number;
+    /**
+     * Total sales earnings in cents
+     */
+    salesEarnings: number;
+    /**
+     * Total parent earnings in cents (from site-attached salespeople)
+     */
+    parentEarnings: number;
+    /**
+     * Total overhead earnings in cents (network overhead commissions)
+     */
+    overheadEarnings: number;
+    /**
+     * Total payout amount in cents
+     * = displayEarnings + referralEarnings + salesEarnings + parentEarnings + overheadEarnings
+     */
+    totalAmount: number;
+    /**
+     * Currency code
+     * Defaults to CAD
+     */
+    currency: string;
+    /**
+     * Invoice ID when payout is processed (FK to smrt-commerce Invoice)
+     * Partner is treated as a Vendor for payout invoices
+     */
+    invoiceId: string;
+    /**
+     * Payout status
+     */
+    status: PayoutStatus;
+    /**
+     * Payment reference (check number, transfer ID, etc.)
+     */
+    paymentReference: string;
+    /**
+     * Date payment was processed
+     */
+    paidAt: Date | null;
+    /**
+     * Notes from admin (approval notes, issues, etc.)
+     */
+    notes: string;
+    /**
+     * Additional metadata as JSON string
+     */
+    metadata: string;
+    constructor(options?: any);
+    /**
+     * Check if payout is pending approval
+     */
+    isPending(): boolean;
+    /**
+     * Check if payout is approved (waiting for processing)
+     */
+    isApproved(): boolean;
+    /**
+     * Check if payout is being processed
+     */
+    isProcessing(): boolean;
+    /**
+     * Check if payout is completed
+     */
+    isCompleted(): boolean;
+    /**
+     * Check if payout failed
+     */
+    isFailed(): boolean;
+    /**
+     * Get total amount in dollars (for display)
+     */
+    getTotalInDollars(): number;
+    /**
+     * Get display earnings in dollars
+     */
+    getDisplayEarningsInDollars(): number;
+    /**
+     * Get referral earnings in dollars
+     */
+    getReferralEarningsInDollars(): number;
+    /**
+     * Get sales earnings in dollars
+     */
+    getSalesEarningsInDollars(): number;
+    /**
+     * Get parent earnings in dollars
+     */
+    getParentEarningsInDollars(): number;
+    /**
+     * Get overhead earnings in dollars
+     */
+    getOverheadEarningsInDollars(): number;
+    /**
+     * Calculate total from component earnings
+     */
+    calculateTotal(): number;
+    /**
+     * Get period as human-readable string
+     */
+    getPeriodString(): string;
+    /**
+     * Get metadata as object
+     */
+    getMetadata(): Record<string, any>;
+    /**
+     * Set metadata from object
+     */
+    setMetadata(data: Record<string, any>): void;
+    /**
+     * Approve the payout for processing
+     *
+     * @throws Error if payout is not in pending status
+     */
+    approve(): void;
+    /**
+     * Mark payout as processing (payment in progress)
+     *
+     * @throws Error if payout is not in approved status
+     */
+    markProcessing(): void;
+    /**
+     * Mark payout as completed
+     *
+     * @param paymentReference - Payment reference (check number, transfer ID, etc.)
+     * @throws Error if payout is not in processing status
+     */
+    complete(paymentReference: string): void;
+    /**
+     * Mark payout as failed
+     *
+     * @param reason - Reason for failure (stored in notes)
+     */
+    fail(reason: string): void;
+}
+
+export declare class PayoutCollection extends SmrtCollection<Payout> {
+    static readonly _itemClass: typeof Payout;
+    /**
+     * Find payouts by partner
+     *
+     * @param partnerId - Partner ID
+     * @returns Array of payouts
+     */
+    findByPartner(partnerId: string): Promise<Payout[]>;
+    /**
+     * Find payouts by status
+     *
+     * @param status - Payout status
+     * @returns Array of payouts
+     */
+    findByStatus(status: PayoutStatus): Promise<Payout[]>;
+    /**
+     * Find all pending payouts (awaiting approval)
+     */
+    findPending(): Promise<Payout[]>;
+    /**
+     * Find all approved payouts (ready for processing)
+     */
+    findApproved(): Promise<Payout[]>;
+    /**
+     * Find all processing payouts
+     */
+    findProcessing(): Promise<Payout[]>;
+    /**
+     * Find all completed payouts
+     */
+    findCompleted(): Promise<Payout[]>;
+    /**
+     * Find all failed payouts
+     */
+    findFailed(): Promise<Payout[]>;
+    /**
+     * Find payouts by invoice
+     *
+     * @param invoiceId - Invoice ID
+     * @returns Array of payouts
+     */
+    findByInvoice(invoiceId: string): Promise<Payout[]>;
+    /**
+     * Find payouts in period range
+     *
+     * @param start - Period start date
+     * @param end - Period end date
+     * @returns Array of payouts
+     */
+    findByPeriod(start: Date, end: Date): Promise<Payout[]>;
+    /**
+     * Find payouts for a partner by status
+     *
+     * @param partnerId - Partner ID
+     * @param status - Payout status
+     * @returns Array of payouts
+     */
+    findByPartnerAndStatus(partnerId: string, status: PayoutStatus): Promise<Payout[]>;
+    /**
+     * Find pending payouts for a partner
+     *
+     * @param partnerId - Partner ID
+     * @returns Array of pending payouts
+     */
+    findPendingByPartner(partnerId: string): Promise<Payout[]>;
+    /**
+     * Find completed payouts for a partner
+     *
+     * @param partnerId - Partner ID
+     * @returns Array of completed payouts
+     */
+    findCompletedByPartner(partnerId: string): Promise<Payout[]>;
+    /**
+     * Sum total paid to a partner
+     *
+     * @param partnerId - Partner ID
+     * @returns Total paid in cents
+     */
+    sumPaidByPartner(partnerId: string): Promise<number>;
+    /**
+     * Sum total pending for a partner
+     *
+     * @param partnerId - Partner ID
+     * @returns Total pending in cents
+     */
+    sumPendingByPartner(partnerId: string): Promise<number>;
+    /**
+     * Get most recent payout for a partner
+     *
+     * @param partnerId - Partner ID
+     * @returns Most recent payout or null
+     */
+    findLatestByPartner(partnerId: string): Promise<Payout | null>;
+    /**
+     * Get payout statistics
+     *
+     * @returns Stats object
+     */
+    getStats(): Promise<{
+        pending: number;
+        approved: number;
+        processing: number;
+        completed: number;
+        failed: number;
+        totalPaid: number;
+        totalPending: number;
+    }>;
+}
+
+/**
+ * Payout method - how payment is delivered
+ */
+export declare enum PayoutMethod {
+    BANK_TRANSFER = "bank_transfer",
+    CHECK = "check",
+    PAYPAL = "paypal",
+    CREDIT = "credit"
+}
+
+/**
+ * Payout status - lifecycle of a payout batch
+ */
+export declare enum PayoutStatus {
+    PENDING = "pending",
+    APPROVED = "approved",
+    PROCESSING = "processing",
+    COMPLETED = "completed",
+    FAILED = "failed"
+}
+
+export { }