@fantastic.dev/better-stripe 0.23.1 → 0.24.0

package/dist/component/_generated/component.d.ts

@@ -19,6 +19,398 @@ import type { FunctionReference } from "convex/server";
  * ```
  */
 export type ComponentApi<Name extends string | undefined = string | undefined> = {
+    affiliateEarnings: {
+        mutations: {
+            confirmEarning: FunctionReference<"mutation", "internal", {
+                earningId: string;
+                stripeTransferId?: string;
+            }, null, Name>;
+            reserveEarning: FunctionReference<"mutation", "internal", {
+                affiliateAccountId: string;
+                sourceChargeId: string;
+            }, {
+                _creationTime: number;
+                _id: string;
+                affiliateAccountId: string;
+                currency: string;
+                originalCommission: number;
+                paymentIntentId?: string;
+                releaseAmount: number;
+                sourceChargeId: string;
+                sourceInvoiceId?: string;
+                status: "reserved" | "paid";
+                stripeTransferId?: string;
+                withheldAmount: number;
+            }, Name>;
+        };
+    };
+    affiliatePayouts: {
+        mutations: {
+            finishPayout: FunctionReference<"mutation", "internal", {
+                operationKey: string;
+                state: "unknown" | "submitted" | "failed";
+                stripePayoutId?: string;
+            }, null, Name>;
+            reservePayout: FunctionReference<"mutation", "internal", {
+                affiliateAccountId: string;
+                amount: number;
+                currency: string;
+                minimumAmount: number;
+                now: number;
+                operationKey?: string;
+            }, {
+                _creationTime: number;
+                _id: string;
+                affiliateAccountId: string;
+                amount: number;
+                createdAt: number;
+                currency: string;
+                minimumAmount: number;
+                operationKey: string;
+                state: "pending" | "unknown" | "submitted" | "failed";
+                stripePayoutId?: string;
+            } | null, Name>;
+        };
+        queries: {
+            pendingPayouts: FunctionReference<"query", "internal", {
+                paginationOpts: {
+                    cursor: string | null;
+                    endCursor?: string | null;
+                    id?: number;
+                    maximumBytesRead?: number;
+                    maximumRowsRead?: number;
+                    numItems: number;
+                };
+                state: "pending" | "unknown";
+            }, {
+                continueCursor: string;
+                isDone: boolean;
+                page: Array<{
+                    _creationTime: number;
+                    _id: string;
+                    affiliateAccountId: string;
+                    amount: number;
+                    createdAt: number;
+                    currency: string;
+                    minimumAmount: number;
+                    operationKey: string;
+                    state: "pending" | "unknown" | "submitted" | "failed";
+                    stripePayoutId?: string;
+                }>;
+                pageStatus?: "SplitRecommended" | "SplitRequired" | null;
+                splitCursor?: string | null;
+            }, Name>;
+        };
+    };
+    affiliateRecovery: {
+        mutations: {
+            beginOperation: FunctionReference<"mutation", "internal", {
+                operationId: string;
+            }, {
+                _creationTime: number;
+                _id: string;
+                amount: number;
+                attempted: boolean;
+                createdAt: number;
+                error?: string;
+                kind: "recovery" | "restoration";
+                obligationId: string;
+                providerBaseline?: number;
+                receiptId?: string;
+                sourceEventId?: string;
+                state: "pending" | "unknown" | "insufficient_balance" | "unsupported" | "failed" | "succeeded" | "canceled";
+            }, Name>;
+            completeOperation: FunctionReference<"mutation", "internal", {
+                confirmedTransferReversed?: number;
+                error?: string;
+                operationId: string;
+                receiptId?: string;
+                state: "pending" | "unknown" | "insufficient_balance" | "unsupported" | "failed" | "succeeded" | "canceled";
+            }, null, Name>;
+            reserveOperation: FunctionReference<"mutation", "internal", {
+                kind: "recovery" | "restoration";
+                now: number;
+                obligationId: string;
+            }, {
+                _creationTime: number;
+                _id: string;
+                amount: number;
+                attempted: boolean;
+                createdAt: number;
+                error?: string;
+                kind: "recovery" | "restoration";
+                obligationId: string;
+                providerBaseline?: number;
+                receiptId?: string;
+                sourceEventId?: string;
+                state: "pending" | "unknown" | "insufficient_balance" | "unsupported" | "failed" | "succeeded" | "canceled";
+            } | null, Name>;
+            reviewLegacy: FunctionReference<"mutation", "internal", {
+                exposure: {
+                    chargeAmount: number;
+                    disputeId?: string;
+                    disputeState?: "open" | "lost" | "won";
+                    finalized: boolean;
+                    kind: "refund" | "dispute";
+                    principal: number;
+                    refundId?: string;
+                    refundedPrincipal?: number;
+                };
+                note: string;
+                obligationId: string;
+                receipts: Array<{
+                    amount: number;
+                    id: string;
+                }>;
+                recoveredAmount: number;
+                restorationIds: Array<string>;
+                restoredAmount: number;
+            }, null, Name>;
+        };
+        queries: {
+            chargeObligations: FunctionReference<"query", "internal", {
+                sourceChargeId: string;
+            }, Array<{
+                _creationTime: number;
+                _id: string;
+                accounted?: boolean;
+                activeOperationId?: string;
+                affiliateAccountId: string;
+                chargeAmount: number;
+                creditAmount?: number;
+                currency: string;
+                debtAmount?: number;
+                debtStatus?: "open" | "settled";
+                disputeId?: string;
+                disputeState?: "open" | "lost" | "won";
+                disputedPrincipal: number;
+                earningId?: string;
+                finalizedAmount: number;
+                lastError?: string;
+                lastRefundId?: string;
+                lastState?: string;
+                legacyReceiptIds?: Array<string>;
+                legacyRestorationIds?: Array<string>;
+                lostPrincipal: number;
+                needsReconciliation: boolean;
+                offsetAmount?: number;
+                operationSequence?: number;
+                operatorNote?: string;
+                originalCommission: number;
+                paymentId?: string;
+                paymentIntentId?: string;
+                provisionalAmount: number;
+                recoveredAmount: number;
+                refundedPrincipal: number;
+                releasedCommission?: number;
+                reservedRecovery?: number;
+                reservedRestoration?: number;
+                restoredAmount?: number;
+                sourceChargeId: string;
+                sourceInvoiceId?: string;
+                storeAccountId?: string;
+                stripeTransferId?: string;
+            }>, Name>;
+            getEarning: FunctionReference<"query", "internal", {
+                affiliateAccountId: string;
+                sourceChargeId: string;
+            }, {
+                _creationTime: number;
+                _id: string;
+                affiliateAccountId: string;
+                currency: string;
+                originalCommission: number;
+                paymentIntentId?: string;
+                releaseAmount: number;
+                sourceChargeId: string;
+                sourceInvoiceId?: string;
+                status: "reserved" | "paid";
+                stripeTransferId?: string;
+                withheldAmount: number;
+            } | null, Name>;
+            getObligation: FunctionReference<"query", "internal", {
+                obligationId: string;
+            }, {
+                _creationTime: number;
+                _id: string;
+                accounted?: boolean;
+                activeOperationId?: string;
+                affiliateAccountId: string;
+                chargeAmount: number;
+                creditAmount?: number;
+                currency: string;
+                debtAmount?: number;
+                debtStatus?: "open" | "settled";
+                disputeId?: string;
+                disputeState?: "open" | "lost" | "won";
+                disputedPrincipal: number;
+                earningId?: string;
+                finalizedAmount: number;
+                lastError?: string;
+                lastRefundId?: string;
+                lastState?: string;
+                legacyReceiptIds?: Array<string>;
+                legacyRestorationIds?: Array<string>;
+                lostPrincipal: number;
+                needsReconciliation: boolean;
+                offsetAmount?: number;
+                operationSequence?: number;
+                operatorNote?: string;
+                originalCommission: number;
+                paymentId?: string;
+                paymentIntentId?: string;
+                provisionalAmount: number;
+                recoveredAmount: number;
+                refundedPrincipal: number;
+                releasedCommission?: number;
+                reservedRecovery?: number;
+                reservedRestoration?: number;
+                restoredAmount?: number;
+                sourceChargeId: string;
+                sourceInvoiceId?: string;
+                storeAccountId?: string;
+                stripeTransferId?: string;
+            } | null, Name>;
+            operationHistory: FunctionReference<"query", "internal", {
+                obligationId: string;
+                paginationOpts: {
+                    cursor: string | null;
+                    endCursor?: string | null;
+                    id?: number;
+                    maximumBytesRead?: number;
+                    maximumRowsRead?: number;
+                    numItems: number;
+                };
+            }, {
+                continueCursor: string;
+                isDone: boolean;
+                page: Array<{
+                    _creationTime: number;
+                    _id: string;
+                    amount: number;
+                    attempted: boolean;
+                    createdAt: number;
+                    error?: string;
+                    kind: "recovery" | "restoration";
+                    obligationId: string;
+                    providerBaseline?: number;
+                    receiptId?: string;
+                    sourceEventId?: string;
+                    state: "pending" | "unknown" | "insufficient_balance" | "unsupported" | "failed" | "succeeded" | "canceled";
+                }>;
+                pageStatus?: "SplitRecommended" | "SplitRequired" | null;
+                splitCursor?: string | null;
+            }, Name>;
+            pendingOperations: FunctionReference<"query", "internal", {
+                paginationOpts: {
+                    cursor: string | null;
+                    endCursor?: string | null;
+                    id?: number;
+                    maximumBytesRead?: number;
+                    maximumRowsRead?: number;
+                    numItems: number;
+                };
+                state: "pending" | "unknown";
+            }, {
+                continueCursor: string;
+                isDone: boolean;
+                page: Array<{
+                    _creationTime: number;
+                    _id: string;
+                    amount: number;
+                    attempted: boolean;
+                    createdAt: number;
+                    error?: string;
+                    kind: "recovery" | "restoration";
+                    obligationId: string;
+                    providerBaseline?: number;
+                    receiptId?: string;
+                    sourceEventId?: string;
+                    state: "pending" | "unknown" | "insufficient_balance" | "unsupported" | "failed" | "succeeded" | "canceled";
+                }>;
+                pageStatus?: "SplitRecommended" | "SplitRequired" | null;
+                splitCursor?: string | null;
+            }, Name>;
+            recoverySnapshot: FunctionReference<"query", "internal", {
+                affiliateAccountId: string;
+                currency: string;
+                paginationOpts: {
+                    cursor: string | null;
+                    endCursor?: string | null;
+                    id?: number;
+                    maximumBytesRead?: number;
+                    maximumRowsRead?: number;
+                    numItems: number;
+                };
+            }, {
+                balance: {
+                    _creationTime: number;
+                    _id: string;
+                    activePayoutKey?: string;
+                    affiliateAccountId: string;
+                    currency: string;
+                    netPayable: number;
+                    offsetAmount: number;
+                    originalCommission: number;
+                    outstandingDebt: number;
+                    pendingPayoutAmount?: number;
+                    recoveredAmount: number;
+                    reservedRecovery: number;
+                    reservedRestoration: number;
+                    restorationDue: number;
+                    restoredAmount: number;
+                    withheldAmount: number;
+                } | null;
+                obligations: {
+                    continueCursor: string;
+                    isDone: boolean;
+                    page: Array<{
+                        _creationTime: number;
+                        _id: string;
+                        accounted?: boolean;
+                        activeOperationId?: string;
+                        affiliateAccountId: string;
+                        chargeAmount: number;
+                        creditAmount?: number;
+                        currency: string;
+                        debtAmount?: number;
+                        debtStatus?: "open" | "settled";
+                        disputeId?: string;
+                        disputeState?: "open" | "lost" | "won";
+                        disputedPrincipal: number;
+                        earningId?: string;
+                        finalizedAmount: number;
+                        lastError?: string;
+                        lastRefundId?: string;
+                        lastState?: string;
+                        legacyReceiptIds?: Array<string>;
+                        legacyRestorationIds?: Array<string>;
+                        lostPrincipal: number;
+                        needsReconciliation: boolean;
+                        offsetAmount?: number;
+                        operationSequence?: number;
+                        operatorNote?: string;
+                        originalCommission: number;
+                        paymentId?: string;
+                        paymentIntentId?: string;
+                        provisionalAmount: number;
+                        recoveredAmount: number;
+                        refundedPrincipal: number;
+                        releasedCommission?: number;
+                        reservedRecovery?: number;
+                        reservedRestoration?: number;
+                        restoredAmount?: number;
+                        sourceChargeId: string;
+                        sourceInvoiceId?: string;
+                        storeAccountId?: string;
+                        stripeTransferId?: string;
+                    }>;
+                    pageStatus?: "SplitRecommended" | "SplitRequired" | null;
+                    splitCursor?: string | null;
+                };
+            }, Name>;
+        };
+    };
     billing: {
         mutations: {
             upsertCheckoutSession: FunctionReference<"mutation", "internal", {
@@ -572,6 +964,16 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
     connect: {
         mutations: {
             claimReversalSlices: FunctionReference<"mutation", "internal", {
+                commissionExposure?: {
+                    chargeAmount: number;
+                    disputeId?: string;
+                    disputeState?: "open" | "lost" | "won";
+                    finalized: boolean;
+                    kind: "refund" | "dispute";
+                    principal: number;
+                    refundId?: string;
+                    refundedPrincipal?: number;
+                };
                 mode: {
                     kind: "full";
                 } | {
@@ -590,6 +992,7 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
             }, {
                 replay: boolean;
                 slices: Array<{
+                    commissionTracked?: boolean;
                     confirmed: number;
                     from: number;
                     stripeTransferId: string;
@@ -602,6 +1005,11 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
                 stripePaymentIntentId: string;
             }, null, Name>;
             recordTransferReversal: FunctionReference<"mutation", "internal", {
+                receipt?: {
+                    amount: number;
+                    operationId: string;
+                    stripeReversalId: string;
+                };
                 reversedAmount: number;
                 stripeTransferId: string;
             }, null, Name>;
@@ -907,6 +1315,16 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
             }, {
                 _creationTime: number;
                 _id: string;
+                commissionExposure?: {
+                    chargeAmount: number;
+                    disputeId?: string;
+                    disputeState?: "open" | "lost" | "won";
+                    finalized: boolean;
+                    kind: "refund" | "dispute";
+                    principal: number;
+                    refundId?: string;
+                    refundedPrincipal?: number;
+                };
                 operationId: string;
                 slices: Array<{
                     from: number;
@@ -2530,6 +2948,75 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
             }, Name>;
         };
     };
+    payoutSync: {
+        mutations: {
+            begin: FunctionReference<"mutation", "internal", {
+                accountId: string;
+                stripePayoutId: string;
+            }, number, Name>;
+            finish: FunctionReference<"mutation", "internal", {
+                accountId: string;
+                generation: number;
+                payout: {
+                    accountId: string;
+                    amount: number;
+                    arrivalDate?: string;
+                    currency: string;
+                    failureCode?: string;
+                    failureMessage?: string;
+                    metadata?: Record<string, string>;
+                    method?: string;
+                    status: "pending" | "paid" | "failed" | "canceled" | "in_transit";
+                    stripePayoutId: string;
+                };
+                stripePayoutId: string;
+            }, {
+                changed: boolean;
+                generation: number;
+                payout: {
+                    _creationTime: number;
+                    _id: string;
+                    accountId: string;
+                    amount: number;
+                    arrivalDate?: string;
+                    currency: string;
+                    failureCode?: string;
+                    failureMessage?: string;
+                    metadata?: any;
+                    method?: string;
+                    status: "pending" | "paid" | "failed" | "canceled" | "in_transit";
+                    stripePayoutId: string;
+                    totalsRecorded?: true;
+                };
+                status: "accepted";
+            } | {
+                generation: number;
+                status: "superseded";
+            }, Name>;
+            markUnknown: FunctionReference<"mutation", "internal", {
+                accountId: string;
+                generation: number;
+                stripePayoutId: string;
+            }, null, Name>;
+        };
+        queries: {
+            get: FunctionReference<"query", "internal", {
+                accountId: string;
+                stripePayoutId: string;
+            }, {
+                _creationTime: number;
+                _id: string;
+                acceptedAt?: number;
+                acceptedFingerprint?: string;
+                acceptedGeneration?: number;
+                accountId: string;
+                generation: number;
+                startedAt: number;
+                status: "pending" | "accepted" | "unknown";
+                stripePayoutId: string;
+            } | null, Name>;
+        };
+    };
     products: {
         mutations: {
             upsertPrice: FunctionReference<"mutation", "internal", {
@@ -2775,6 +3262,21 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
                 replay: boolean;
                 term: "forever" | "one_time";
             }, Name>;
+            migrateAffiliateObligations: FunctionReference<"mutation", "internal", {
+                paginationOpts: {
+                    cursor: string | null;
+                    endCursor?: string | null;
+                    id?: number;
+                    maximumBytesRead?: number;
+                    maximumRowsRead?: number;
+                    numItems: number;
+                };
+            }, {
+                continueCursor: string;
+                isDone: boolean;
+                migrated: number;
+                skipped: number;
+            }, Name>;
             reserveSettlementAllocation: FunctionReference<"mutation", "internal", {
                 adjustmentAmount?: number;
                 currency: string;
@@ -2838,6 +3340,64 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
                     role: "store" | "affiliate" | "other";
                 }>;
             } | null, Name>;
+            listAffiliateObligations: FunctionReference<"query", "internal", {
+                affiliateAccountId: string;
+                currency: string;
+                paginationOpts: {
+                    cursor: string | null;
+                    endCursor?: string | null;
+                    id?: number;
+                    maximumBytesRead?: number;
+                    maximumRowsRead?: number;
+                    numItems: number;
+                };
+            }, {
+                continueCursor: string;
+                isDone: boolean;
+                page: Array<{
+                    _creationTime: number;
+                    _id: string;
+                    accounted?: boolean;
+                    activeOperationId?: string;
+                    affiliateAccountId: string;
+                    chargeAmount: number;
+                    creditAmount?: number;
+                    currency: string;
+                    debtAmount?: number;
+                    debtStatus?: "open" | "settled";
+                    disputeId?: string;
+                    disputeState?: "open" | "lost" | "won";
+                    disputedPrincipal: number;
+                    earningId?: string;
+                    finalizedAmount: number;
+                    lastError?: string;
+                    lastRefundId?: string;
+                    lastState?: string;
+                    legacyReceiptIds?: Array<string>;
+                    legacyRestorationIds?: Array<string>;
+                    lostPrincipal: number;
+                    needsReconciliation: boolean;
+                    offsetAmount?: number;
+                    operationSequence?: number;
+                    operatorNote?: string;
+                    originalCommission: number;
+                    paymentId?: string;
+                    paymentIntentId?: string;
+                    provisionalAmount: number;
+                    recoveredAmount: number;
+                    refundedPrincipal: number;
+                    releasedCommission?: number;
+                    reservedRecovery?: number;
+                    reservedRestoration?: number;
+                    restoredAmount?: number;
+                    sourceChargeId: string;
+                    sourceInvoiceId?: string;
+                    storeAccountId?: string;
+                    stripeTransferId?: string;
+                }>;
+                pageStatus?: "SplitRecommended" | "SplitRequired" | null;
+                splitCursor?: string | null;
+            }, Name>;
         };
     };
     webhooks: {