@apex-inc/sdk 0.7.3 → 0.9.0

package/dist/generated/event-payloads.d.ts

@@ -0,0 +1,736 @@
+/**
+ * GENERATED FILE — DO NOT EDIT BY HAND.
+ *
+ * Typed Apex event payloads, generated from the Apex Spec registries by
+ * `app/scripts/generate-spec-types.ts`. Regenerate with:
+ *
+ *   npx tsx app/scripts/generate-spec-types.ts
+ *
+ * The `codegen.test.ts` stale gate fails CI if this drifts from the spec.
+ */
+export interface ApexEventPayloads {
+    "activated": {
+        criterion?: string;
+    };
+    "add_to_cart": {
+        product_id: string;
+        product_name?: string;
+        value?: number;
+        cart_value?: number;
+        currency?: string;
+        quantity?: number;
+        item_count?: number;
+        cart_id?: string;
+    };
+    "add_to_wishlist": {
+        product_id: string;
+        product_name?: string;
+        value?: number;
+        currency?: string;
+    };
+    "anomaly_detected": {
+        metric_name: string;
+        scope?: string;
+        delta?: string;
+        investigate_url: string;
+        anomaly_url?: string;
+    };
+    "apex_setup_first_belief_created": {
+        belief_id?: string;
+        source?: string;
+    };
+    "apex_setup_first_event_detected": {
+        platform?: string;
+        event_name?: string;
+    };
+    "apex_setup_first_identified_event": {
+        surface?: string;
+    };
+    "apex_setup_source_connected": {
+        source_kind: string;
+        source_id?: string;
+    };
+    "apex_setup_templates_unlocked": {
+        unlock_id?: string;
+        track_id?: string;
+        template_count?: number;
+    };
+    "app_background": Record<string, never>;
+    "app_crash": {
+        message?: string;
+        stack?: string;
+        fatal?: boolean;
+    };
+    "app_install": Record<string, never>;
+    "app_open": {
+        source?: string;
+    };
+    "app_reinstall": Record<string, never>;
+    "app_uninstall": Record<string, never>;
+    "badge_awarded": {
+        badge_name: string;
+        category?: string;
+        impact_message?: string;
+        total_badges?: number;
+        next_badge?: string;
+        growth_journey_url?: string;
+    };
+    "buyer_review_requested": {
+        order_id?: string;
+        product_name?: string;
+        seller_name?: string;
+    };
+    "campaign_milestone_reached": {
+        campaign_id?: string;
+        campaign_name?: string;
+        milestone?: string;
+        business_impact?: string;
+    };
+    "cart_snapshot": {
+        items: unknown[];
+        value?: number;
+        currency?: string;
+        item_count?: number;
+        cart_id?: string;
+    };
+    "cart_view": {
+        value?: number;
+        currency?: string;
+        item_count?: number;
+        cart_id?: string;
+    };
+    "checkout_completed": {
+        order_id?: string;
+        value: number;
+        currency: string;
+        item_count?: number;
+        items?: unknown[];
+        cart_id?: string;
+        subtotal?: number;
+        total?: number;
+        tax?: number;
+        shipping?: number;
+        handling?: number;
+        discount?: number;
+        coupon?: string;
+    };
+    "checkout_started": {
+        value?: number;
+        currency?: string;
+        item_count?: number;
+        cart_id?: string;
+    };
+    "click": {
+        target?: string;
+    };
+    "client_onboarded": {
+        client_id?: string;
+        client_name?: string;
+        manager_name?: string;
+    };
+    "cognito_verification_code": {
+        code: string;
+        code_parameter?: string;
+    };
+    "content_view": {
+        content_id: string;
+        content_type?: string;
+        duration_ms?: number;
+    };
+    "contract_renewal_approaching": {
+        contract_id?: string;
+        days_remaining?: number;
+        renewal_date?: string;
+        contract_period?: string;
+    };
+    "custom": Record<string, never>;
+    "dead_click": {
+        target?: string;
+    };
+    "deep_link_open": {
+        url: string;
+        source?: string;
+        campaign_id?: string;
+        referrer?: string;
+    };
+    "developer_invite_sent": {
+        inviter_name: string;
+        inviter_role?: string;
+        developer_email: string;
+        workspace_name?: string;
+        note?: string;
+        handoff_url: string;
+        signup_url?: string;
+    };
+    "drip_step_scheduled": {
+        step_label: string;
+        step_body?: string;
+        step_url?: string;
+    };
+    "email_clicked": {
+        message_id?: string;
+        campaign_id?: string;
+        link?: string;
+    };
+    "email_opened": {
+        message_id?: string;
+        campaign_id?: string;
+    };
+    "engagement": Record<string, never>;
+    "experiment_awaiting_promotion": {
+        experiment_name: string;
+        winning_arm?: string;
+        confidence?: string;
+        experiment_url?: string;
+    };
+    "experiment_concluded": {
+        experiment_name: string;
+        result?: string;
+        lift?: string;
+        confidence?: string;
+        confidence_interval?: string;
+        safety_verdict?: string;
+        experiment_url?: string;
+        result_label?: string;
+    };
+    "experiment_exposure": {
+        experiment_id: string;
+        variant_key: string;
+        surface?: string;
+        assignment_id?: string;
+    };
+    "experiment_invalid": {
+        experiment_id?: string;
+        experiment_name: string;
+        href?: string;
+    };
+    "experiment_launched": {
+        experiment_name: string;
+        experiment_url?: string;
+        hypothesis?: string;
+    };
+    "experiment_promoted": {
+        experiment_name: string;
+        winning_arm?: string;
+        experiment_url?: string;
+    };
+    "experiment_significant": {
+        experiment_name: string;
+        winning_arm?: string;
+        lift?: string;
+        experiment_url?: string;
+    };
+    "experiment_stale": {
+        experiment_name: string;
+        reason?: string;
+        conclusion?: string;
+        experiment_url?: string;
+    };
+    "experiment_started": {
+        experiment_name: string;
+        experiment_url?: string;
+    };
+    "feature_unused_for_7d": {
+        name?: string;
+        first_name?: string;
+        feature_name: string;
+        cta_url?: string;
+    };
+    "feature_used": {
+        feature_name: string;
+        count?: number;
+    };
+    "first_sale_completed": {
+        order_id?: string;
+        value?: number;
+        currency?: string;
+        buyer_name?: string;
+        product_name?: string;
+        payout_days?: number;
+    };
+    "form_submit": {
+        form_id?: string;
+    };
+    "goal_conversion": {
+        goal_id: string;
+        value?: number;
+    };
+    "guardrail_autopaused": {
+        experiment_id?: string;
+        experiment_name: string;
+        href?: string;
+    };
+    "guardrail_breached": {
+        experiment_id?: string;
+        experiment_name: string;
+        href?: string;
+    };
+    "heartbeat": Record<string, never>;
+    "in_app_message_clicked": {
+        message_id?: string;
+        campaign_id?: string;
+        cta?: string;
+    };
+    "in_app_message_seen": {
+        message_id?: string;
+        campaign_id?: string;
+    };
+    "in_app_purchase": {
+        order_id: string;
+        value: number;
+        currency: string;
+        product_id?: string;
+        product_name?: string;
+        transaction_id?: string;
+        items?: unknown[];
+        is_restored?: boolean;
+        subtotal?: number;
+        total?: number;
+        tax?: number;
+        shipping?: number;
+        handling?: number;
+        discount?: number;
+        coupon?: string;
+    };
+    "integration_connected": {
+        integration_name: string;
+        integrations_url?: string;
+    };
+    "integration_sync_completed": {
+        integration_name: string;
+        row_count?: number;
+        performance_url?: string;
+        integrations_url?: string;
+    };
+    "integration_sync_failed": {
+        integration_name: string;
+        error_message?: string;
+        integrations_url?: string;
+    };
+    "invoice_paid": {
+        invoice_id: string;
+        amount: number;
+        currency: string;
+        subscription_id?: string;
+        next_billing_date?: string;
+    };
+    "js_error": {
+        message?: string;
+        stack?: string;
+    };
+    "lifecycle_transition": Record<string, never>;
+    "listing_created": {
+        listing_id?: string;
+        product_name?: string;
+        price?: number;
+        currency?: string;
+    };
+    "loyalty_milestone_reached": {
+        points?: number;
+        reward?: string;
+        milestone?: string;
+    };
+    "new_capability_launched": {
+        capability_id?: string;
+        capability_name?: string;
+        capability_description?: string;
+    };
+    "nudge_scheduled": {
+        name?: string;
+        first_name?: string;
+        nudge_body: string;
+        nudge_url?: string;
+    };
+    "onboarding_completed": {
+        duration_ms?: number;
+        steps_completed?: number;
+    };
+    "onboarding_in_progress": {
+        name?: string;
+        first_name?: string;
+        steps_remaining?: number;
+        onboarding_url?: string;
+    };
+    "onboarding_step_completed": {
+        step_id?: string;
+        step_index?: number;
+        step_name?: string;
+    };
+    "order_delivered": {
+        order_id: string;
+        delivered_at?: string;
+    };
+    "order_placed": {
+        order_id: string;
+        value: number;
+        currency?: string;
+        item_count?: number;
+        product_name?: string;
+        order_url?: string;
+        subtotal?: number;
+        total?: number;
+        tax?: number;
+        shipping?: number;
+        handling?: number;
+        discount?: number;
+        coupon?: string;
+    };
+    "order_shipped": {
+        order_id: string;
+        carrier?: string;
+        tracking_url?: string;
+        delivery_estimate?: string;
+        shipped_at?: string;
+    };
+    "page_view": {
+        path?: string;
+        title?: string;
+        referrer?: string;
+    };
+    "pageview": {
+        path?: string;
+        title?: string;
+        referrer?: string;
+    };
+    "password_reset_requested": {
+        name?: string;
+        reset_url: string;
+    };
+    "payment_failed": {
+        invoice_id: string;
+        amount: number;
+        currency: string;
+        subscription_id?: string;
+        transaction_id?: string;
+        attempt_number?: number;
+        next_retry_at?: string;
+        update_payment_url?: string;
+    };
+    "payment_recovered": {
+        invoice_id: string;
+        amount: number;
+        currency: string;
+        subscription_id?: string;
+        transaction_id?: string;
+    };
+    "payout_sent": {
+        amount: number;
+        currency: string;
+        payout_id?: string;
+        transaction_count?: number;
+        payment_method?: string;
+        processing_days?: number;
+    };
+    "portfolio_access_approved": {
+        granter_name: string;
+        scope?: string;
+        portfolio_url?: string;
+        portfolio_name?: string;
+    };
+    "portfolio_access_rejected": {
+        granter_name: string;
+        portfolio_name?: string;
+        reason?: string;
+    };
+    "portfolio_access_requested": {
+        requester_name: string;
+        requester_email?: string;
+        portfolio_name?: string;
+        approve_url: string;
+        reject_url?: string;
+    };
+    "portfolio_share_accepted": {
+        viewer_email: string;
+        portfolio_name?: string;
+        portfolio_url?: string;
+        owner_name?: string;
+        shared_at?: string;
+    };
+    "price_dropped": {
+        product_id?: string;
+        product_name: string;
+        old_price?: number;
+        new_price?: number;
+        discount_percent?: number;
+        currency?: string;
+        product_url?: string;
+    };
+    "product_view": {
+        product_id: string;
+        product_name?: string;
+        category?: string;
+        value?: number;
+        currency?: string;
+    };
+    "purchase_refunded": {
+        order_id: string;
+        value: number;
+        currency: string;
+        reason?: string;
+    };
+    "push_opened": {
+        message_id?: string;
+        campaign_id?: string;
+        deep_link?: string;
+    };
+    "push_received": {
+        message_id?: string;
+        campaign_id?: string;
+    };
+    "rage_click": {
+        target?: string;
+    };
+    "rate_change_scheduled": {
+        name?: string;
+        first_name?: string;
+        org_name?: string;
+        rate_card: string;
+        effective_period: string;
+        effective_label?: string;
+        changes_summary: string;
+        pricing_url?: string;
+    };
+    "reattribution": {
+        partner_id?: string;
+        original_install_id?: string;
+    };
+    "reengagement": {
+        partner_id?: string;
+        inactive_days?: number;
+    };
+    "remove_from_cart": {
+        product_id: string;
+        product_name?: string;
+        value?: number;
+        currency?: string;
+        quantity?: number;
+        cart_id?: string;
+    };
+    "report_generated": {
+        report_type?: string;
+        report_id?: string;
+        period?: string;
+        highlights?: string;
+        report_url?: string;
+    };
+    "restock_due": {
+        product_id?: string;
+        product_name: string;
+        days_since_purchase?: number;
+        product_url?: string;
+    };
+    "review_request_due": {
+        product_id?: string;
+        product_name: string;
+        order_id?: string;
+        days_ago?: number;
+        review_url?: string;
+    };
+    "screen_view": {
+        screen_name: string;
+        previous_screen?: string;
+    };
+    "search": {
+        query: string;
+        results_count?: number;
+    };
+    "seller_signup": {
+        seller_id?: string;
+        store_name?: string;
+    };
+    "session_end": {
+        session_id?: string;
+        duration_ms?: number;
+    };
+    "session_start": {
+        session_id?: string;
+    };
+    "share": {
+        content_id?: string;
+        channel?: string;
+    };
+    "smart_banner_click": Record<string, never>;
+    "smart_banner_dismiss": Record<string, never>;
+    "smart_banner_impression": Record<string, never>;
+    "subscription_canceled": {
+        product_id: string;
+        reason?: string;
+        expires_at?: string;
+    };
+    "subscription_downgraded": {
+        name?: string;
+        first_name?: string;
+        from_plan: string;
+        to_plan: string;
+        dashboard_url?: string;
+    };
+    "subscription_event": {
+        product_id: string;
+        action: string;
+        amount?: number;
+        currency?: string;
+        period_type?: string;
+        transaction_id?: string;
+        expires_at?: string;
+        is_trial?: boolean;
+    };
+    "subscription_renewed": {
+        product_id?: string;
+        amount?: number;
+        currency?: string;
+        period_type?: string;
+        transaction_id?: string;
+    };
+    "subscription_started": {
+        product_id: string;
+        amount?: number;
+        currency?: string;
+        period_type?: string;
+        transaction_id?: string;
+        is_trial?: boolean;
+    };
+    "subscription_upgraded": {
+        name?: string;
+        first_name?: string;
+        from_plan: string;
+        to_plan: string;
+        dashboard_url?: string;
+    };
+    "survey_completed": {
+        survey_id?: string;
+        score?: number;
+    };
+    "survey_started": {
+        survey_id?: string;
+    };
+    "tier_limit_approaching": {
+        name?: string;
+        first_name?: string;
+        current_tier: string;
+        next_tier?: string;
+        feature_count?: number;
+        top_feature?: string;
+        usage_percent?: number;
+        usage_current?: number;
+        usage_limit?: number;
+        resource_name?: string;
+        recommended_plan?: string;
+        upgrade_url?: string;
+    };
+    "trial_expired": {
+        plan?: string;
+    };
+    "trial_expiring": {
+        name?: string;
+        first_name?: string;
+        days_remaining?: number;
+        plan?: string;
+        value_summary?: string;
+        upgrade_url?: string;
+    };
+    "trust_badge_earned": {
+        badge_name: string;
+    };
+    "unsubscribed": {
+        message_id?: string;
+        campaign_id?: string;
+        list_id?: string;
+    };
+    "usage_milestone_reached": {
+        milestone?: string;
+        percentile?: number;
+    };
+    "usage_period_reset": {
+        name?: string;
+        first_name?: string;
+        period: string;
+        usage_url?: string;
+    };
+    "usage_statement_ready": {
+        name?: string;
+        first_name?: string;
+        period: string;
+        est_total?: number;
+        statement_url?: string;
+    };
+    "usage_threshold_reached": {
+        name?: string;
+        first_name?: string;
+        billing_class: string;
+        meter_label: string;
+        usage_pct: number;
+        free_limit: number;
+        usage_current: number;
+        period: string;
+        cap_kind: string;
+        overage_rate?: number;
+        usage_url?: string;
+    };
+    "user_churned": {
+        reason?: string;
+    };
+    "user_identified": {
+        user_id: string;
+        traits?: Record<string, unknown>;
+    };
+    "user_invitation_accepted": {
+        member_name: string;
+        inviter_name?: string;
+        inviter_email?: string;
+        org_name: string;
+        role: string;
+        invitee_email?: string;
+        href?: string;
+    };
+    "user_invitation_created": {
+        inviter_name: string;
+        inviter_email?: string;
+        org_name: string;
+        org_id: string;
+        invitee_email: string;
+        role: string;
+        accept_url: string;
+        invitation_token?: string;
+        invitation_id?: string;
+    };
+    "user_level_up": {
+        name?: string;
+        first_name?: string;
+        level: string;
+        previous_level?: string;
+        score?: number;
+        growth_journey_url?: string;
+    };
+    "user_reactivated": {
+        inactive_days?: number;
+        changes_summary?: string;
+    };
+    "user_signed_in": {
+        method?: string;
+    };
+    "user_signed_out": Record<string, never>;
+    "user_signed_up": {
+        method?: string;
+        referrer?: string;
+    };
+    "user_signup": {
+        name?: string;
+        first_name?: string;
+        onboarding_url?: string;
+    };
+    "webinar_registered": {
+        webinar_topic?: string;
+        webinar_date?: string;
+    };
+    "weekly_digest_scheduled": {
+        name?: string;
+        first_name?: string;
+        period: string;
+        digest_url?: string;
+        total_imports?: string;
+        active_integrations?: string;
+        experiments?: string;
+    };
+}
+export type ApexEventName = keyof ApexEventPayloads;
+//# sourceMappingURL=event-payloads.d.ts.map