@withpotter/lib 0.13.0-next.101

package/dist/api/types/collections.d.ts

@@ -0,0 +1,189 @@
+/**
+ * COLLECTIONS API (Merchant Payments) — as the API sends it.
+ *
+ * One slice of what was a 4,164-line `types.ts`. The sections were already
+ * here as comment fences; they are files now, so a type is found by the
+ * endpoint it belongs to rather than by scrolling.
+ */
+export interface MerchantBankAccount {
+    id: string;
+    tenantId: string;
+    bankCode: string;
+    bankName: string;
+    accountNumber: string;
+    accountName: string;
+    paystackSubaccountCode?: string;
+    splitPercentage: number;
+    status: 'pending' | 'active' | 'failed' | 'disabled';
+    isDefault: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface MembershipBenefit {
+    id: string;
+    name: string;
+    description?: string;
+    icon?: string;
+}
+export type PlanPricingKind = 'fixed' | 'sum-of-items';
+export type PlanGroupRole = 'cadence-sibling' | 'tier-sibling' | 'default' | 'alternate';
+export interface PlanIncludes {
+    productIds: string[];
+    minItems?: number;
+    maxItems?: number;
+}
+export interface MerchantPlan {
+    id: string;
+    tenantId: string;
+    name: string;
+    description?: string;
+    amount: number;
+    currency: string;
+    interval: 'daily' | 'weekly' | 'monthly' | 'quarterly' | 'biannually' | 'annually';
+    intervalCount: number;
+    paystackPlanCode?: string;
+    status: 'active' | 'inactive' | 'archived';
+    features: {
+        name: string;
+        included: boolean;
+        limit?: number;
+    }[];
+    trialDays?: number;
+    subscriberCount: number;
+    pricingKind?: PlanPricingKind;
+    includes?: PlanIncludes | null;
+    subscriptionDiscountPercent?: number | null;
+    badges?: string[] | null;
+    groupId?: string | null;
+    groupLabel?: string | null;
+    groupRole?: PlanGroupRole | null;
+    /**
+     * What the member gets. These were `membership_tiers` — a second object for
+     * the same product, whose benefits only reached a customer through a
+     * reconcile after payment, so a tier nobody linked granted nothing while
+     * looking entirely live.
+     */
+    slug?: string | null;
+    icon?: string | null;
+    color?: string | null;
+    benefits?: {
+        id: string;
+        name: string;
+        description?: string;
+    }[];
+    /** Off everything a member buys — not `subscriptionDiscountPercent`, which
+     *  discounts a sum-of-items plan's own cycle. */
+    memberDiscountPercent?: number | null;
+    freeServicesPerMonth?: number | null;
+    priorityBooking?: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface CustomerSubscription {
+    id: string;
+    tenantId: string;
+    planId: string;
+    customerId: string;
+    customerEmail: string;
+    status: 'active' | 'non_renewing' | 'attention' | 'cancelled' | 'completed';
+    amount: number;
+    currency: string;
+    currentPeriodStart?: string;
+    currentPeriodEnd?: string;
+    nextPaymentDate?: string;
+    cancelledAt?: string;
+    paymentsCount: number;
+    metadata?: Record<string, unknown>;
+    createdAt: string;
+    updatedAt: string;
+    plan?: MerchantPlan;
+    customer?: {
+        id: string;
+        name?: string;
+        email: string;
+    };
+}
+export interface SubscriptionStats {
+    totalActive: number;
+    totalNonRenewing: number;
+    totalCancelled: number;
+    monthlyRecurringRevenue: number;
+}
+export interface Bank {
+    name: string;
+    code: string;
+    longcode: string;
+    type: string;
+    country: string;
+    currency: string;
+    active: boolean;
+}
+export interface OverviewStats {
+    totalPageViews: number;
+    uniqueVisitors: number;
+    totalSessions: number;
+    averageSessionDuration: number;
+    bounceRate: number;
+}
+export interface SalesStats {
+    totalRevenue: number;
+    totalOrders: number;
+    averageOrderValue: number;
+    conversionRate: number;
+    /**
+     * What discounts cost over the period, summed from the orders that carried
+     * them. Exact — unlike totalRevenue, which is derived from purchase beacons.
+     * Do not render the two as a percentage of each other.
+     */
+    totalDiscounted?: number;
+    /** How many paid orders used a discount. */
+    discountedOrders?: number;
+}
+export interface TopContent {
+    contentId: string;
+    title?: string;
+    views: number;
+    uniqueViews: number;
+}
+export interface TopProduct {
+    contentId: string;
+    title: string;
+    unitsSold: number;
+    revenue: number;
+}
+export interface TopPage {
+    pageUrl: string;
+    views: number;
+    uniqueVisitors: number;
+}
+export interface TrafficSource {
+    source: string;
+    sessions: number;
+    percentage: number;
+}
+export interface DeviceStats {
+    device: 'desktop' | 'mobile' | 'tablet' | 'unknown';
+    sessions: number;
+    percentage: number;
+}
+export interface TimeSeriesPoint {
+    date: string;
+    value: number;
+}
+export interface FunnelStats {
+    productViews: number;
+    addToCart: number;
+    checkoutStart: number;
+    /** Sessions that placed an order, paid or not. */
+    checkoutComplete: number;
+    purchase: number;
+    viewToCartRate: number;
+    cartToCheckoutRate: number;
+    /** Share of started checkouts that produced an order. */
+    checkoutToOrderRate: number;
+    /** Share of placed orders that were paid for. */
+    orderToPaymentRate: number;
+    /** Started checkout to paid. Unchanged: still spans both steps above. */
+    checkoutToPurchaseRate: number;
+    overallConversionRate: number;
+}

package/dist/api/types/collections.js

@@ -0,0 +1 @@
+//# sourceMappingURL=collections.js.map

package/dist/api/types/collections.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/api/types/crm.d.ts

@@ -0,0 +1,264 @@
+/**
+ * CRM — Segments & Analytics — as the API sends it.
+ *
+ * One slice of what was a 4,164-line `types.ts`. The sections were already
+ * here as comment fences; they are files now, so a type is found by the
+ * endpoint it belongs to rather than by scrolling.
+ */
+export interface SendSegmentEmailInput {
+    segmentId: string;
+    templateType: string;
+    templateId?: string;
+    commonVariables?: Record<string, string>;
+}
+export interface BulkEmailResult {
+    total: number;
+    sent: number;
+    failed: number;
+    skipped: number;
+}
+/**
+ * One message Box sent on the business's behalf, and what became of it.
+ *
+ * `status` is the notification's own state; `deliveredAt` is the provider
+ * saying it landed. Both matter and they are not the same thing — a message
+ * can be sent and never delivered, which is precisely the case a merchant
+ * needs to see and currently cannot.
+ */
+export interface NotificationLogItem {
+    id: string;
+    channel: string;
+    templateType: string;
+    templateId?: string;
+    memberId?: string;
+    recipientEmail?: string;
+    recipientPhone?: string;
+    subject: string;
+    status: string;
+    errorMessage?: string;
+    /**
+     * The provider's own message id.
+     *
+     * The only thing that proves the external effect exists. Box's id
+     * answers "what do I quote to support"; this one answers "did it really
+     * leave", and a merchant checking their own records needs the second.
+     */
+    externalId?: string;
+    sentAt?: string;
+    deliveredAt?: string;
+    createdAt: string;
+    customerId?: string | null;
+    orderId?: string | null;
+    transactionId?: string | null;
+    messageType?: string | null;
+}
+/**
+ * Delivery health for a period, as potter-api already counts it.
+ *
+ * `sent` and `delivered` are separate numbers and that separation is the
+ * point: a message the provider accepted and never landed is the case a
+ * merchant needs to see, and a single "sent" total hides exactly that.
+ */
+export interface NotificationStats {
+    total: number;
+    sent: number;
+    delivered: number;
+    failed: number;
+    pending: number;
+    deliveryRate: number;
+}
+/**
+ * What one customer has agreed to hear about.
+ *
+ * The engine has enforced these on every send since it was written and no
+ * screen has ever read them, so a customer who opted out of marketing looked
+ * exactly like one who was never written to. That is the same silence the
+ * record trace was built to end, on the other side of the same question.
+ */
+export interface NotificationPreferences {
+    id: string;
+    memberId: string;
+    orderConfirmation: boolean;
+    orderShipped: boolean;
+    orderDelivered: boolean;
+    newsletter: boolean;
+    promotional: boolean;
+    reviewRequest: boolean;
+    abandonedCart: boolean;
+    emailEnabled: boolean;
+    smsEnabled: boolean;
+    pushEnabled: boolean;
+    updatedAt: string;
+}
+export interface NotificationLogPage {
+    items: NotificationLogItem[];
+    total: number;
+    page: number;
+    limit: number;
+    totalPages: number;
+}
+export interface SendMessageResult {
+    success: boolean;
+    notificationId: string;
+    messageId?: string;
+    error?: string;
+}
+export interface MerchantNotification {
+    id: string;
+    type: string;
+    title: string;
+    body: string;
+    link: string | null;
+    readAt: string | null;
+    createdAt: string;
+}
+export interface MerchantNotificationList {
+    notifications: MerchantNotification[];
+    hasMore: boolean;
+    unreadCount: number;
+}
+export interface AssigneePrefs {
+    id: string;
+    memberId: string;
+    /** Notify me when an order is placed for a product I'm assigned to. */
+    assignmentNewOrder: boolean;
+    /** Notify me when a booking targets a service I'm assigned to. */
+    assignmentNewBooking: boolean;
+    /** Notify me when a product I'm assigned to is running low. */
+    assignmentLowStock: boolean;
+    /** Deliver alerts by email (Account.email). */
+    emailEnabled: boolean;
+    /** Deliver alerts by SMS to the number managed by a workspace admin. */
+    smsEnabled: boolean;
+    /** Deliver alerts by WhatsApp to the number managed by a workspace admin. */
+    whatsappEnabled: boolean;
+    /** Show alerts in the dashboard bell dropdown. */
+    inappEnabled: boolean;
+    /** Whether a workspace admin has configured an SMS/WhatsApp destination. */
+    phoneConfigured: boolean;
+    updatedAt: string;
+}
+export type AssigneePrefsUpdate = Partial<Pick<AssigneePrefs, 'assignmentNewOrder' | 'assignmentNewBooking' | 'assignmentLowStock' | 'emailEnabled' | 'smsEnabled' | 'whatsappEnabled' | 'inappEnabled'>>;
+export interface LoyaltyProgram {
+    id: string;
+    name: string;
+    pointsName: string;
+    pointsPerCurrency: number;
+    currencyPerPoint: number;
+    minRedeemPoints: number;
+    pointsExpiryDays: number | null;
+    isActive: boolean;
+    settings: Record<string, unknown>;
+    tiers: LoyaltyTier[];
+    earnRules: LoyaltyEarnRule[];
+}
+export interface LoyaltyTier {
+    id: string;
+    name: string;
+    minLifetimePoints: number;
+    earnMultiplier: number;
+    perks: Record<string, unknown>;
+    badgeColor: string;
+    position: number;
+}
+export interface LoyaltyEarnRule {
+    id: string;
+    trigger: string;
+    pointsAmount: number | null;
+    pointsPerCurrencyOverride: number | null;
+    description: string;
+    isActive: boolean;
+    conditions: Record<string, unknown> | null;
+}
+export interface LoyaltyBalance {
+    id: string;
+    memberId: string;
+    memberName: string | null;
+    memberEmail: string | null;
+    currentPoints: number;
+    lifetimePoints: number;
+    redeemedPoints: number;
+    tierId: string | null;
+    tierName: string | null;
+    tierBadgeColor: string | null;
+    lastEarnedAt: string | null;
+    lastRedeemedAt: string | null;
+    nextTier: {
+        name: string;
+        pointsNeeded: number;
+    } | null;
+}
+export interface LoyaltyTransaction {
+    id: string;
+    type: 'earn' | 'redeem' | 'expire' | 'adjust' | 'refund';
+    points: number;
+    description: string;
+    trigger: string | null;
+    orderId: string | null;
+    bookingId: string | null;
+    memberId: string | null;
+    memberName: string | null;
+    memberEmail: string | null;
+    createdAt: string;
+}
+export interface LoyaltyStats {
+    totalMembers: number;
+    totalPointsIssued: number;
+    totalPointsRedeemed: number;
+    activeMembers: number;
+    programActive: boolean;
+}
+export type ReferralStatus = 'pending' | 'completed';
+export interface ReferralMember {
+    id: string;
+    name: string | null;
+    email: string | null;
+}
+export interface Referral {
+    id: string;
+    code: string;
+    status: ReferralStatus;
+    referrer: ReferralMember | null;
+    referred: ReferralMember | null;
+    referrerPoints: number | null;
+    referredPoints: number | null;
+    rewardedAt: string | null;
+    createdAt: string;
+}
+export interface PaginatedReferrals {
+    referrals: Referral[];
+    total: number;
+    page: number;
+    limit: number;
+    totalPages: number;
+}
+export interface ReferralStats {
+    totalReferrers: number;
+    completedReferrals: number;
+    pendingReferrals: number;
+    totalPointsAwarded: number;
+}
+export type DiscountType = 'percentage' | 'fixed_amount' | 'free_shipping' | 'buy_x_get_y';
+export type DiscountStatus = 'active' | 'inactive' | 'expired' | 'scheduled';
+export interface DiscountConditions {
+    minOrderAmount?: number;
+    minQuantity?: number;
+    maxQuantity?: number;
+    productIds?: string[];
+    categoryIds?: string[];
+    excludedProductIds?: string[];
+    memberOnly?: boolean;
+    firstOrderOnly?: boolean;
+    /**
+     * Loyalty tiers this code is reserved for. Empty means every customer.
+     * Narrower than `memberOnly`, which only asks whether they are signed in —
+     * this asks which tier they reached.
+     */
+    loyaltyTierIds?: string[];
+}
+export interface BuyXGetYConfig {
+    buyQuantity: number;
+    getQuantity: number;
+    getProductIds?: string[];
+    getDiscountPercent?: number;
+}

package/dist/api/types/crm.js

@@ -0,0 +1 @@
+//# sourceMappingURL=crm.js.map

package/dist/api/types/crm.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}