@apex-inc/sdk 0.20.1 → 0.21.0

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

@@ -28,40 +28,6 @@ export interface ApexEventPayloads {
         value?: number;
         currency?: string;
     };
-    "adoption_gap_detected": {
-        name?: string;
-        first_name?: string;
-        feature_id: string;
-        feature_name?: string;
-        nudge_url?: 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;
-    };
     "api_request_completed": {
         endpoint?: string;
         count?: number;
@@ -82,27 +48,6 @@ export interface ApexEventPayloads {
         asset_id?: string;
         asset_type?: string;
     };
-    "billing_limit_approaching": {
-        name?: string;
-        first_name?: string;
-        org_name?: string;
-        usage_pct?: number;
-        driver_meter?: string;
-        billing_url?: string;
-    };
-    "billing_limit_reached": {
-        name?: string;
-        first_name?: string;
-        org_name?: string;
-        driver_meter?: string;
-        billing_url?: string;
-    };
-    "billing_limit_resolved": {
-        name?: string;
-        first_name?: string;
-        org_name?: string;
-        billing_url?: string;
-    };
     "buyer_review_requested": {
         order_id?: string;
         product_name?: string;
@@ -179,10 +124,6 @@ export interface ApexEventPayloads {
         report_id?: string;
         client_id?: string;
     };
-    "cognito_verification_code": {
-        code: string;
-        code_parameter?: string;
-    };
     "comment_added": {
         target_id?: string;
     };
@@ -214,15 +155,6 @@ export interface ApexEventPayloads {
         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;
-    };
     "dispute_opened": {
         transaction_id?: string;
         reason?: string;
@@ -241,225 +173,12 @@ export interface ApexEventPayloads {
         duration?: number;
         scroll_depth?: number;
     };
-    "experiment_awaiting_promotion": {
-        experiment_name: string;
-        winning_arm?: string;
-        confidence?: string;
-        lift?: string;
-        rate_line?: string;
-        primary_metric?: string;
-        exposures?: string;
-        preview_url?: string;
-        experiment_url?: string;
-    };
-    "experiment_concluded": {
-        experiment_name: string;
-        result?: string;
-        winner?: string;
-        lift?: string;
-        confidence?: string;
-        rate_line?: string;
-        confidence_interval?: string;
-        safety_verdict?: string;
-        exposures?: string;
-        preview_url?: string;
-        preview_url_b?: string;
-        experiment_url?: string;
-        result_label?: string;
-        subject_line?: string;
-        why?: string;
-        what_happens_now?: string;
-        next_step?: string;
-        cta_label?: string;
-        stat_value?: string;
-        stat_caption?: string;
-        sample_floor_per_arm?: string;
-        control_count?: string;
-        variant_count?: string;
-        belief_note?: string;
-        outcome_kind?: string;
-        primary_metric?: string;
-        variants?: unknown[];
-    };
-    "experiment_created": {
-        experiment_id?: string;
-        experiment_name: string;
-        surface?: string;
-        experiment_url?: string;
-        hypothesis?: string;
-        prediction?: string;
-        primary_metric?: string;
-        variants?: unknown[];
-        preview_url?: string;
-        preview_url_b?: string;
-    };
-    "experiment_daily_recap": {
-        count?: number;
-        workspace_name?: string;
-        experiments?: string;
-    };
-    "experiment_deploying": {
-        experiment_name: string;
-        experiment_url?: string;
-    };
     "experiment_exposure": {
         experiment_id: string;
         variant_key: string;
         surface?: string;
         assignment_id?: string;
     };
-    "experiment_extended": {
-        experiment_id?: string;
-        experiment_name: string;
-        added_days?: string;
-        previous_duration_days?: string;
-        new_duration_days?: string;
-        why?: string;
-        experiment_url?: string;
-        run_window?: string;
-        variants?: unknown[];
-        preview_url?: string;
-        preview_url_b?: string;
-    };
-    "experiment_first_exposure": {
-        experiment_id?: string;
-        experiment_name: string;
-        experiment_url?: string;
-        run_window?: string;
-        variants?: unknown[];
-        preview_url?: string;
-        preview_url_b?: string;
-    };
-    "experiment_graduated": {
-        experiment_name: string;
-        graduation_pr_url: string;
-        experiment_url?: string;
-    };
-    "experiment_invalid": {
-        experiment_id?: string;
-        experiment_name: string;
-        experiment_url?: string;
-        href?: string;
-    };
-    "experiment_launched": {
-        experiment_name: string;
-        experiment_url?: string;
-        hypothesis?: string;
-    };
-    "experiment_paused": {
-        experiment_name: string;
-        experiment_url?: string;
-        hypothesis?: string;
-        prediction?: string;
-        primary_metric?: string;
-        guardrail?: string;
-        run_window?: string;
-        belief?: string;
-        variants?: unknown[];
-        preview_url?: string;
-        preview_url_b?: string;
-    };
-    "experiment_projected_underpowered": {
-        experiment_id?: string;
-        experiment_name: string;
-        projection_reason?: string;
-        exposure_per_arm?: string;
-        sample_floor_per_arm?: string;
-        days_elapsed?: string;
-        days_remaining?: string;
-        days_still_needed?: string;
-        lift_so_far?: string;
-        confidence_so_far?: string;
-        preview_url?: string;
-        experiment_url?: string;
-        why?: string;
-        variants?: unknown[];
-        preview_url_b?: string;
-    };
-    "experiment_promoted": {
-        experiment_name: string;
-        winning_arm?: string;
-        lift?: string;
-        confidence?: string;
-        exposures?: string;
-        preview_url?: string;
-        experiment_url?: string;
-    };
-    "experiment_resumed": {
-        experiment_name: string;
-        experiment_url?: string;
-        hypothesis?: string;
-        prediction?: string;
-        primary_metric?: string;
-        guardrail?: string;
-        run_window?: string;
-        belief?: string;
-        variants?: unknown[];
-        preview_url?: string;
-        preview_url_b?: string;
-    };
-    "experiment_scheduled": {
-        experiment_name: string;
-        experiment_url?: string;
-        scheduled_start?: string;
-        hypothesis?: string;
-        prediction?: string;
-        primary_metric?: string;
-        guardrail?: string;
-        run_window?: string;
-        belief?: string;
-        variants?: unknown[];
-        preview_url?: string;
-        preview_url_b?: string;
-    };
-    "experiment_significant": {
-        experiment_name: string;
-        winning_arm?: string;
-        lift?: string;
-        confidence?: string;
-        rate_line?: string;
-        primary_metric?: string;
-        exposures?: string;
-        preview_url?: string;
-        experiment_url?: string;
-    };
-    "experiment_stale": {
-        experiment_name: string;
-        reason?: string;
-        conclusion?: string;
-        experiment_url?: string;
-    };
-    "experiment_started": {
-        experiment_name: string;
-        experiment_url?: string;
-        hypothesis?: string;
-        prediction?: string;
-        primary_metric?: string;
-        guardrail?: string;
-        run_window?: string;
-        belief?: string;
-        variants?: unknown[];
-        preview_url?: string;
-        preview_url_b?: string;
-    };
-    "experiment_window_closed_underpowered": {
-        experiment_id?: string;
-        experiment_name: string;
-        exposure_per_arm?: string;
-        sample_floor_per_arm?: string;
-        detectable_lift_floor?: string;
-        grace_days_remaining?: string;
-        experiment_url?: string;
-        variants?: unknown[];
-        preview_url?: string;
-        preview_url_b?: string;
-    };
-    "feature_unused_for_7d": {
-        name?: string;
-        first_name?: string;
-        feature_name: string;
-        cta_url?: string;
-    };
     "feature_used": {
         feature_name: string;
         count?: number;
@@ -479,28 +198,6 @@ export interface ApexEventPayloads {
         goal_id: string;
         value?: number;
     };
-    "guardrail_autopaused": {
-        experiment_id?: string;
-        experiment_name: string;
-        experiment_url?: string;
-        href?: string;
-        guardrail_metric?: string;
-        guardrail_value?: string;
-        variants?: unknown[];
-        preview_url?: string;
-        preview_url_b?: string;
-    };
-    "guardrail_breached": {
-        experiment_id?: string;
-        experiment_name: string;
-        experiment_url?: string;
-        href?: string;
-        guardrail_metric?: string;
-        guardrail_value?: string;
-        variants?: unknown[];
-        preview_url?: string;
-        preview_url_b?: string;
-    };
     "heartbeat": Record<string, never>;
     "in_app_message_clicked": {
         message_id?: string;
@@ -549,26 +246,6 @@ export interface ApexEventPayloads {
         listing_id?: string;
         thread_id?: string;
     };
-    "integration_connected": {
-        integration_name: string;
-        integrations_url?: string;
-    };
-    "integration_selected": {
-        integration_name: string;
-        source?: 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;
@@ -607,50 +284,9 @@ export interface ApexEventPayloads {
         amount?: number;
         currency?: string;
     };
-    "merchant_access_acknowledged": {
-        name?: string;
-        first_name?: string;
-        email?: string;
-        company_name: string;
-        website?: string;
-    };
-    "merchant_access_granted": {
-        name?: string;
-        first_name?: string;
-        email?: string;
-        company_name: string;
-        signin_url: string;
-    };
-    "merchant_access_requested": {
-        name?: string;
-        first_name?: string;
-        requester_email: string;
-        company_name: string;
-        website: string;
-        note?: string;
-        admin_url: string;
-        requester_id?: string;
-    };
-    "merchant_payout_shortfall": {
-        name?: string;
-        first_name?: string;
-        workspace_key?: string;
-        escalation_level: number;
-        shortfall_usd: number;
-        next_retry_at?: string;
-        payouts_url?: string;
-    };
     "message_sent": {
         thread_id?: string;
     };
-    "milestone_adopted": {
-        name?: string;
-        first_name?: string;
-        milestone_id: string;
-        feature_id: string;
-        milestone_name?: string;
-        celebration_url?: string;
-    };
     "new_capability_launched": {
         capability_id?: string;
         capability_name?: string;
@@ -665,24 +301,11 @@ export interface ApexEventPayloads {
         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;
     };
-    "onboarding_unlock_available": {
-        name?: string;
-        first_name?: string;
-        outcome?: string;
-        artifact_count?: number;
-        reveal_url?: string;
-    };
     "order_delivered": {
         order_id: string;
         delivered_at?: string;
@@ -729,23 +352,9 @@ export interface ApexEventPayloads {
         title?: string;
         referrer?: string;
     };
-    "partner_payout_failed": {
-        name?: string;
-        first_name?: string;
-        reason?: string;
-        payouts_url?: string;
-    };
-    "partner_payout_paid": {
-        name?: string;
-        first_name?: string;
-        amount_usd: number;
-        transfer_id?: string;
-        batch_id?: string;
-        payouts_url?: string;
-    };
     "password_reset_requested": {
-        name?: string;
-        reset_url: string;
+        email?: string;
+        reset_url?: string;
     };
     "payment_failed": {
         invoice_id: string;
@@ -774,50 +383,6 @@ export interface ApexEventPayloads {
         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_company_flagged": {
-        reasons: string;
-        viewer_names?: string;
-        viewer_count?: number;
-        review_url?: string;
-    };
-    "portfolio_reconsent_required": {
-        viewer_name: string;
-        disclosure_text?: string;
-        granted_at?: string;
-        expires_at?: string;
-        review_url?: string;
-    };
-    "portfolio_share_accepted": {
-        viewer_email: string;
-        portfolio_name?: string;
-        portfolio_url?: string;
-        owner_name?: string;
-        shared_at?: string;
-    };
-    "portfolio_workspace_added": {
-        workspace_names: string;
-        viewer_names?: string;
-        viewer_count?: number;
-        review_url?: string;
-    };
     "price_dropped": {
         product_id?: string;
         product_name: string;
@@ -858,16 +423,6 @@ export interface ApexEventPayloads {
     "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;
@@ -884,12 +439,11 @@ export interface ApexEventPayloads {
         quantity?: number;
         cart_id?: string;
     };
-    "report_generated": {
+    "report_ready": {
         report_type?: string;
         report_id?: string;
         period?: string;
         highlights?: string;
-        report_url?: string;
     };
     "report_viewed": {
         report_id?: string;
@@ -943,10 +497,6 @@ export interface ApexEventPayloads {
         seller_id?: string;
         store_name?: string;
     };
-    "sending_domain_verified": {
-        domain: string;
-        dmarc_published?: boolean;
-    };
     "session_end": {
         session_id?: string;
         duration_ms?: number;
@@ -954,22 +504,10 @@ export interface ApexEventPayloads {
     "session_start": {
         session_id?: string;
     };
-    "setup_step_continued": {
-        step_id: string;
-        step_name?: string;
-        cta_label?: string;
-        setup_url?: string;
-    };
     "share": {
         content_id?: string;
         channel?: string;
     };
-    "shared_pool_suspended": {
-        name?: string;
-        first_name?: string;
-        complaint_rate: string;
-        upgrade_url?: string;
-    };
     "smart_banner_click": Record<string, never>;
     "smart_banner_dismiss": Record<string, never>;
     "smart_banner_impression": Record<string, never>;
@@ -1043,20 +581,6 @@ export interface ApexEventPayloads {
         task_id?: string;
         status?: 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;
-    };
     "time_logged": {
         minutes?: number;
         project_id?: string;
@@ -1083,12 +607,9 @@ export interface ApexEventPayloads {
         plan?: string;
     };
     "trial_expiring": {
-        name?: string;
-        first_name?: string;
-        days_remaining?: number;
         plan?: string;
+        days_remaining?: number;
         value_summary?: string;
-        upgrade_url?: string;
     };
     "trust_badge_earned": {
         badge_name: string;
@@ -1105,68 +626,10 @@ export interface ApexEventPayloads {
         campaign_id?: string;
         list_id?: string;
     };
-    "url_drift_detected": {
-        name?: string;
-        first_name?: string;
-        workspace_name?: string;
-        stored_url: string;
-        suggested_url: string;
-        drift_url?: string;
-    };
-    "url_drift_resolved": {
-        name?: string;
-        first_name?: string;
-        workspace_name?: string;
-        drift_url?: string;
-    };
-    "usage_invoice_estimate": {
-        name?: string;
-        first_name?: string;
-        org_id: string;
-        org_name?: string;
-        period: string;
-        estimate_usd: number;
-        email?: string;
-    };
-    "usage_invoice_failed": {
-        name?: string;
-        first_name?: string;
-        org_id: string;
-        org_name?: string;
-        amount_due_usd?: number;
-        hosted_invoice_url?: string;
-        email?: 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;
     };
@@ -1174,25 +637,17 @@ export interface ApexEventPayloads {
         user_id: string;
         traits?: Record<string, unknown>;
     };
-    "user_invitation_accepted": {
-        member_name: string;
+    "user_invite_accepted": {
+        member_name?: string;
         inviter_name?: string;
-        inviter_email?: string;
-        org_name: string;
-        role: 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_invited": {
+        inviter_name?: string;
+        invitee_email?: string;
+        role?: string;
+        accept_url?: string;
     };
     "user_reactivated": {
         inactive_days?: number;
@@ -1206,26 +661,16 @@ export interface ApexEventPayloads {
         method?: string;
         referrer?: string;
     };
-    "user_signup": {
-        name?: string;
-        first_name?: string;
-        onboarding_url?: string;
-        referring_org_id?: string;
-        referral_source?: string;
+    "waitlist_joined": {
+        email?: string;
+        source?: string;
+        waitlist_name?: string;
+        referrer?: 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