@instockng/api-client 1.0.6 → 1.0.8

package/dist/apps/backend/src/lib/order-recovery.d.ts

@@ -0,0 +1,459 @@
+import { PrismaClient, ProspectReason } from '@prisma/client';
+export declare const PROSPECT_RECOVERY_SCHEDULE: readonly [{
+    readonly attempt: 1;
+    readonly delayHours: 0;
+    readonly discountPercentage: 0;
+    readonly template: "ProspectRecoveryReminder";
+    readonly subject: "We tried reaching you about your order";
+}, {
+    readonly attempt: 2;
+    readonly delayHours: 8;
+    readonly discountPercentage: 5;
+    readonly template: "ProspectRecovery";
+    readonly subject: "Your order is waiting - 5% discount inside";
+}, {
+    readonly attempt: 3;
+    readonly delayHours: 24;
+    readonly discountPercentage: 10;
+    readonly template: "ProspectRecovery";
+    readonly subject: "Still interested? Save 10% today";
+}, {
+    readonly attempt: 4;
+    readonly delayHours: 48;
+    readonly discountPercentage: 15;
+    readonly template: "ProspectRecoveryFinal";
+    readonly subject: "Final chance - 15% off expires soon";
+}];
+export declare const AUTO_CANCEL_HOURS = 72;
+/**
+ * Find prospect orders ready for recovery attempt
+ */
+export declare function findProspectOrdersForRecovery(prisma: PrismaClient, attemptNumber: number): Promise<({
+    brand: {
+        id: string;
+        name: string;
+        slug: string;
+        logoUrl: string | null;
+        siteUrl: string;
+        domain: string;
+        metaPixelId: string | null;
+        createdAt: Date;
+        updatedAt: Date;
+        deletedAt: Date | null;
+    };
+    deliveryZone: {
+        id: string;
+        name: string;
+        createdAt: Date;
+        updatedAt: Date;
+        deletedAt: Date | null;
+        brandId: string | null;
+        stateId: string;
+        deliveryCost: import("@prisma/client/runtime/library").Decimal;
+        freeShippingThreshold: import("@prisma/client/runtime/library").Decimal | null;
+        allowCOD: boolean;
+        allowOnline: boolean;
+        waybillOnly: boolean;
+        estimatedDays: number | null;
+        noteTitle: string | null;
+        noteContent: string | null;
+        isActive: boolean;
+    };
+    recoveryDiscountCode: {
+        id: string;
+        type: string;
+        value: import("@prisma/client/runtime/library").Decimal;
+        createdAt: Date;
+        updatedAt: Date;
+        deletedAt: Date | null;
+        brandId: string | null;
+        isActive: boolean;
+        code: string;
+        minPurchase: import("@prisma/client/runtime/library").Decimal | null;
+        maxDiscount: import("@prisma/client/runtime/library").Decimal | null;
+        usageLimit: number | null;
+        usageCount: number;
+        perCustomerLimit: number | null;
+        validFrom: Date;
+        validUntil: Date | null;
+        isAutoApply: boolean;
+        description: string | null;
+        category: string;
+        createdBy: string | null;
+    };
+    items: ({
+        variant: {
+            product: {
+                id: string;
+                name: string;
+                slug: string;
+                createdAt: Date;
+                updatedAt: Date;
+                deletedAt: Date | null;
+                brandId: string;
+                isActive: boolean;
+                description: string | null;
+                thumbnailUrl: string | null;
+                quantityDiscounts: import("@prisma/client/runtime/library").JsonValue | null;
+            };
+        } & {
+            id: string;
+            name: string | null;
+            createdAt: Date;
+            updatedAt: Date;
+            deletedAt: Date | null;
+            isActive: boolean;
+            thumbnailUrl: string | null;
+            productId: string;
+            sku: string;
+            price: import("@prisma/client/runtime/library").Decimal;
+            trackInventory: boolean;
+            lowStockThreshold: number | null;
+        };
+    } & {
+        id: string;
+        orderId: string;
+        variantId: string;
+        warehouseId: string | null;
+        quantity: number;
+        priceAtPurchase: import("@prisma/client/runtime/library").Decimal;
+    })[];
+} & {
+    email: string | null;
+    id: string;
+    createdAt: Date;
+    updatedAt: Date;
+    deletedAt: Date | null;
+    brandId: string;
+    deliveryZoneId: string;
+    recoveryAttempts: number;
+    lastRecoveryAttemptAt: Date | null;
+    recoveryDiscountCodeId: string | null;
+    wasRecovered: boolean;
+    estimatedDays: number | null;
+    orderNumber: number;
+    firstName: string;
+    lastName: string;
+    phone: string;
+    address: string;
+    city: string;
+    deliveryCharge: import("@prisma/client/runtime/library").Decimal;
+    totalPrice: import("@prisma/client/runtime/library").Decimal;
+    discountCodeId: string | null;
+    discountAmount: import("@prisma/client/runtime/library").Decimal | null;
+    paymentMethod: import("@prisma/client").$Enums.PaymentMethod;
+    paystackReference: string | null;
+    status: import("@prisma/client").$Enums.OrderStatus;
+    cancellationReason: string | null;
+    prospectReason: import("@prisma/client").$Enums.ProspectReason | null;
+    prospectSince: Date | null;
+    userActionToken: string;
+})[]>;
+/**
+ * Prepare order for recovery attempt (atomic operation)
+ */
+export declare function prepareOrderForRecoveryAttempt(prisma: PrismaClient, orderId: string, attemptNumber: number, brandId: string): Promise<{
+    brand: {
+        id: string;
+        name: string;
+        slug: string;
+        logoUrl: string | null;
+        siteUrl: string;
+        domain: string;
+        metaPixelId: string | null;
+        createdAt: Date;
+        updatedAt: Date;
+        deletedAt: Date | null;
+    };
+    deliveryZone: {
+        id: string;
+        name: string;
+        createdAt: Date;
+        updatedAt: Date;
+        deletedAt: Date | null;
+        brandId: string | null;
+        stateId: string;
+        deliveryCost: import("@prisma/client/runtime/library").Decimal;
+        freeShippingThreshold: import("@prisma/client/runtime/library").Decimal | null;
+        allowCOD: boolean;
+        allowOnline: boolean;
+        waybillOnly: boolean;
+        estimatedDays: number | null;
+        noteTitle: string | null;
+        noteContent: string | null;
+        isActive: boolean;
+    };
+    recoveryDiscountCode: {
+        id: string;
+        type: string;
+        value: import("@prisma/client/runtime/library").Decimal;
+        createdAt: Date;
+        updatedAt: Date;
+        deletedAt: Date | null;
+        brandId: string | null;
+        isActive: boolean;
+        code: string;
+        minPurchase: import("@prisma/client/runtime/library").Decimal | null;
+        maxDiscount: import("@prisma/client/runtime/library").Decimal | null;
+        usageLimit: number | null;
+        usageCount: number;
+        perCustomerLimit: number | null;
+        validFrom: Date;
+        validUntil: Date | null;
+        isAutoApply: boolean;
+        description: string | null;
+        category: string;
+        createdBy: string | null;
+    };
+    items: ({
+        variant: {
+            product: {
+                id: string;
+                name: string;
+                slug: string;
+                createdAt: Date;
+                updatedAt: Date;
+                deletedAt: Date | null;
+                brandId: string;
+                isActive: boolean;
+                description: string | null;
+                thumbnailUrl: string | null;
+                quantityDiscounts: import("@prisma/client/runtime/library").JsonValue | null;
+            };
+        } & {
+            id: string;
+            name: string | null;
+            createdAt: Date;
+            updatedAt: Date;
+            deletedAt: Date | null;
+            isActive: boolean;
+            thumbnailUrl: string | null;
+            productId: string;
+            sku: string;
+            price: import("@prisma/client/runtime/library").Decimal;
+            trackInventory: boolean;
+            lowStockThreshold: number | null;
+        };
+    } & {
+        id: string;
+        orderId: string;
+        variantId: string;
+        warehouseId: string | null;
+        quantity: number;
+        priceAtPurchase: import("@prisma/client/runtime/library").Decimal;
+    })[];
+    notes: {
+        id: string;
+        metadata: import("@prisma/client/runtime/library").JsonValue | null;
+        type: import("@prisma/client").$Enums.NoteType;
+        createdAt: Date;
+        createdBy: string | null;
+        orderId: string;
+        note: string;
+    }[];
+} & {
+    email: string | null;
+    id: string;
+    createdAt: Date;
+    updatedAt: Date;
+    deletedAt: Date | null;
+    brandId: string;
+    deliveryZoneId: string;
+    recoveryAttempts: number;
+    lastRecoveryAttemptAt: Date | null;
+    recoveryDiscountCodeId: string | null;
+    wasRecovered: boolean;
+    estimatedDays: number | null;
+    orderNumber: number;
+    firstName: string;
+    lastName: string;
+    phone: string;
+    address: string;
+    city: string;
+    deliveryCharge: import("@prisma/client/runtime/library").Decimal;
+    totalPrice: import("@prisma/client/runtime/library").Decimal;
+    discountCodeId: string | null;
+    discountAmount: import("@prisma/client/runtime/library").Decimal | null;
+    paymentMethod: import("@prisma/client").$Enums.PaymentMethod;
+    paystackReference: string | null;
+    status: import("@prisma/client").$Enums.OrderStatus;
+    cancellationReason: string | null;
+    prospectReason: import("@prisma/client").$Enums.ProspectReason | null;
+    prospectSince: Date | null;
+    userActionToken: string;
+}>;
+/**
+ * Convert prospect order back to pending when customer confirms
+ */
+export declare function confirmProspectOrder(prisma: PrismaClient, orderId: string, userActionToken: string): Promise<{
+    brand: {
+        id: string;
+        name: string;
+        slug: string;
+        logoUrl: string | null;
+        siteUrl: string;
+        domain: string;
+        metaPixelId: string | null;
+        createdAt: Date;
+        updatedAt: Date;
+        deletedAt: Date | null;
+    };
+    deliveryZone: {
+        state: {
+            id: string;
+            name: string;
+            createdAt: Date;
+            updatedAt: Date;
+            deletedAt: Date | null;
+            isActive: boolean;
+        };
+    } & {
+        id: string;
+        name: string;
+        createdAt: Date;
+        updatedAt: Date;
+        deletedAt: Date | null;
+        brandId: string | null;
+        stateId: string;
+        deliveryCost: import("@prisma/client/runtime/library").Decimal;
+        freeShippingThreshold: import("@prisma/client/runtime/library").Decimal | null;
+        allowCOD: boolean;
+        allowOnline: boolean;
+        waybillOnly: boolean;
+        estimatedDays: number | null;
+        noteTitle: string | null;
+        noteContent: string | null;
+        isActive: boolean;
+    };
+    items: ({
+        warehouse: {
+            id: string;
+            name: string;
+            createdAt: Date;
+            updatedAt: Date;
+            deletedAt: Date | null;
+            isActive: boolean;
+            address: string | null;
+            city: string | null;
+            state: string | null;
+        };
+        variant: {
+            product: {
+                id: string;
+                name: string;
+                slug: string;
+                createdAt: Date;
+                updatedAt: Date;
+                deletedAt: Date | null;
+                brandId: string;
+                isActive: boolean;
+                description: string | null;
+                thumbnailUrl: string | null;
+                quantityDiscounts: import("@prisma/client/runtime/library").JsonValue | null;
+            };
+        } & {
+            id: string;
+            name: string | null;
+            createdAt: Date;
+            updatedAt: Date;
+            deletedAt: Date | null;
+            isActive: boolean;
+            thumbnailUrl: string | null;
+            productId: string;
+            sku: string;
+            price: import("@prisma/client/runtime/library").Decimal;
+            trackInventory: boolean;
+            lowStockThreshold: number | null;
+        };
+    } & {
+        id: string;
+        orderId: string;
+        variantId: string;
+        warehouseId: string | null;
+        quantity: number;
+        priceAtPurchase: import("@prisma/client/runtime/library").Decimal;
+    })[];
+} & {
+    email: string | null;
+    id: string;
+    createdAt: Date;
+    updatedAt: Date;
+    deletedAt: Date | null;
+    brandId: string;
+    deliveryZoneId: string;
+    recoveryAttempts: number;
+    lastRecoveryAttemptAt: Date | null;
+    recoveryDiscountCodeId: string | null;
+    wasRecovered: boolean;
+    estimatedDays: number | null;
+    orderNumber: number;
+    firstName: string;
+    lastName: string;
+    phone: string;
+    address: string;
+    city: string;
+    deliveryCharge: import("@prisma/client/runtime/library").Decimal;
+    totalPrice: import("@prisma/client/runtime/library").Decimal;
+    discountCodeId: string | null;
+    discountAmount: import("@prisma/client/runtime/library").Decimal | null;
+    paymentMethod: import("@prisma/client").$Enums.PaymentMethod;
+    paystackReference: string | null;
+    status: import("@prisma/client").$Enums.OrderStatus;
+    cancellationReason: string | null;
+    prospectReason: import("@prisma/client").$Enums.ProspectReason | null;
+    prospectSince: Date | null;
+    userActionToken: string;
+}>;
+/**
+ * Auto-cancel prospect orders that have exceeded the time limit
+ */
+export declare function autoCancelProspectOrders(prisma: PrismaClient): Promise<{
+    processed: number;
+    succeeded: number;
+    failed: number;
+}>;
+/**
+ * Get recovery statistics for dashboard
+ */
+export declare function getProspectRecoveryStats(prisma: PrismaClient, brandId?: string): Promise<{
+    totalProspects: number;
+    recovered: number;
+    cancelled: number;
+    stillProspect: number;
+    recoveryRate: string;
+    revenueRecovered: number;
+}>;
+/**
+ * Mark order as prospect with reason
+ */
+export declare function markOrderAsProspect(prisma: PrismaClient, orderId: string, reason: ProspectReason, notes: string, userId?: string): Promise<{
+    email: string | null;
+    id: string;
+    createdAt: Date;
+    updatedAt: Date;
+    deletedAt: Date | null;
+    brandId: string;
+    deliveryZoneId: string;
+    recoveryAttempts: number;
+    lastRecoveryAttemptAt: Date | null;
+    recoveryDiscountCodeId: string | null;
+    wasRecovered: boolean;
+    estimatedDays: number | null;
+    orderNumber: number;
+    firstName: string;
+    lastName: string;
+    phone: string;
+    address: string;
+    city: string;
+    deliveryCharge: import("@prisma/client/runtime/library").Decimal;
+    totalPrice: import("@prisma/client/runtime/library").Decimal;
+    discountCodeId: string | null;
+    discountAmount: import("@prisma/client/runtime/library").Decimal | null;
+    paymentMethod: import("@prisma/client").$Enums.PaymentMethod;
+    paystackReference: string | null;
+    status: import("@prisma/client").$Enums.OrderStatus;
+    cancellationReason: string | null;
+    prospectReason: import("@prisma/client").$Enums.ProspectReason | null;
+    prospectSince: Date | null;
+    userActionToken: string;
+}>;