@graph8/sdk 0.251.0 → 0.260.0

package/docs/api/radar.d.ts

@@ -0,0 +1,808 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.radar` (Radar): 42 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"aeo_overview_radar_aeo_get">;
+ *
+ * Reference with examples: radar.md
+ */
+/* eslint-disable */
+
+/** `g8.api.radar.<member>` -> the operationId it calls. */
+export interface RadarMembers {
+  aeoOverview: "aeo_overview_radar_aeo_get";
+  aeoProbes: "aeo_probes_radar_aeo_probes_get";
+  aeoRun: "aeo_run_radar_aeo_run_post";
+  analyzeGaps: "analyze_gaps_radar_gaps_analyze_post";
+  approveAllOpportunities: "approve_all_opportunities_radar_opportunities_approve_all_post";
+  approveOpportunity: "approve_opportunity_radar_opportunities__gap_id__approve_post";
+  bulkAddCompetitors: "bulk_add_competitors_radar_competitors_bulk_post";
+  compareSnapshot: "compare_snapshot_radar_snapshots__snapshot_id__compare_get";
+  competitorBattleCard: "competitor_battle_card_radar_competitors__competitor_id__battle_card_get";
+  competitorSuggestions: "competitor_suggestions_radar_competitors_suggestions_get";
+  createCompetitor: "create_competitor_radar_competitors_post";
+  deleteCompetitor: "delete_competitor_radar_competitors__competitor_id__delete";
+  discoverCompetitorPages: "discover_competitor_pages_radar_competitors__competitor_id__discover_pages_get";
+  dispatchAlerts: "dispatch_alerts_radar_alerts_dispatch_post";
+  featureMatrix: "feature_matrix_radar_feature_matrix_get";
+  getCompetitor: "get_competitor_radar_competitors__competitor_id__get";
+  getCompetitorAds: "get_competitor_ads_radar_competitors__competitor_id__ads_get";
+  getCompetitorEngagers: "get_competitor_engagers_radar_competitors__competitor_id__engagers_get";
+  getCompetitorPages: "get_competitor_pages_radar_competitors__competitor_id__pages_get";
+  getCompetitorPosts: "get_competitor_posts_radar_competitors__competitor_id__posts_get";
+  getCompetitorTraffic: "get_competitor_traffic_radar_competitors__competitor_id__traffic_get";
+  getSettings: "get_settings_radar_settings_get";
+  keywordGap: "keyword_gap_radar_keyword_gap_get";
+  listCompetitors: "list_competitors_radar_competitors_get";
+  listGaps: "list_gaps_radar_gaps_get";
+  listInitiatives: "list_initiatives_radar_initiatives_get";
+  listOpportunities: "list_opportunities_radar_opportunities_get";
+  measureInitiatives: "measure_initiatives_radar_initiatives_measure_post";
+  monitoringAdDetail: "monitoring_ad_detail_radar_monitoring_ads__ad_id__get";
+  monitoringAds: "monitoring_ads_radar_monitoring_ads_get";
+  monitoringContent: "monitoring_content_radar_monitoring_content_get";
+  monitoringLinkedin: "monitoring_linkedin_radar_monitoring_linkedin_get";
+  optimizationRuns: "optimization_runs_radar_optimization_runs_get";
+  overview: "overview_radar_overview_get";
+  ownTrafficEstimate: "own_traffic_estimate_radar_own_traffic_estimate_get";
+  pageHistory: "page_history_radar_monitoring_page_history_get";
+  putSettings: "put_settings_radar_settings_put";
+  scanAllCompetitors: "scan_all_competitors_radar_scan_all_post";
+  scanCompetitor: "scan_competitor_radar_competitors__competitor_id__scan_post";
+  traffic: "traffic_radar_traffic_get";
+  updateCompetitor: "update_competitor_radar_competitors__competitor_id__patch";
+  updateGap: "update_gap_radar_gaps__gap_id__patch";
+}
+
+/** Input and output of every `g8.api.radar` operation, keyed by operationId. */
+export interface RadarOperations {
+  /**
+   * GET /radar/aeo
+   * Aeo Overview
+   * tier: read · scope: radar:read
+   */
+  aeo_overview_radar_aeo_get: {
+    input: {
+    query?: {
+      /** Filter to one answer engine (e.g. claude, perplexity). */
+      engine?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * GET /radar/aeo/probes
+   * Aeo Probes
+   * tier: read · scope: radar:read
+   */
+  aeo_probes_radar_aeo_probes_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * POST /radar/aeo/run
+   * Aeo Run
+   * tier: billable · scope: radar:run
+   */
+  aeo_run_radar_aeo_run_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * POST /radar/gaps/analyze
+   * Analyze Gaps
+   * tier: billable · scope: radar:run
+   */
+  analyze_gaps_radar_gaps_analyze_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: AnalyzeGapsRequest;
+  };
+    output: unknown;
+  };
+  /**
+   * POST /radar/opportunities/approve-all
+   * Approve All Opportunities
+   * tier: billable · scope: radar:write
+   */
+  approve_all_opportunities_radar_opportunities_approve_all_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: ApproveAllRequest;
+  };
+    output: unknown;
+  };
+  /**
+   * POST /radar/opportunities/{gap_id}/approve
+   * Approve Opportunity
+   * tier: billable · scope: radar:write
+   */
+  approve_opportunity_radar_opportunities__gap_id__approve_post: {
+    input: {
+    path: {
+      gap_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: ApproveOpportunityRequest;
+  };
+    output: unknown;
+  };
+  /**
+   * POST /radar/competitors/bulk
+   * Bulk Add Competitors
+   * tier: billable · scope: radar:write
+   */
+  bulk_add_competitors_radar_competitors_bulk_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: BulkCompetitorsRequest;
+  };
+    output: unknown;
+  };
+  /**
+   * GET /radar/snapshots/{snapshot_id}/compare
+   * Compare Snapshot
+   * tier: read · scope: radar:read
+   */
+  compare_snapshot_radar_snapshots__snapshot_id__compare_get: {
+    input: {
+    path: {
+      snapshot_id: string;
+    };
+    query?: {
+      against?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * GET /radar/competitors/{competitor_id}/battle-card
+   * Competitor Battle Card
+   * tier: read · scope: radar:read
+   */
+  competitor_battle_card_radar_competitors__competitor_id__battle_card_get: {
+    input: {
+    path: {
+      competitor_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * GET /radar/competitors/suggestions
+   * Competitor Suggestions
+   * tier: read · scope: radar:read
+   */
+  competitor_suggestions_radar_competitors_suggestions_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * POST /radar/competitors
+   * Create Competitor
+   * tier: billable · scope: radar:write
+   */
+  create_competitor_radar_competitors_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: CreateCompetitorRequest;
+  };
+    output: unknown;
+  };
+  /**
+   * DELETE /radar/competitors/{competitor_id}
+   * Delete Competitor
+   * tier: destructive · scope: radar:delete
+   */
+  delete_competitor_radar_competitors__competitor_id__delete: {
+    input: {
+    path: {
+      competitor_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * GET /radar/competitors/{competitor_id}/discover-pages
+   * Discover Competitor Pages
+   * tier: billable · scope: radar:run
+   */
+  discover_competitor_pages_radar_competitors__competitor_id__discover_pages_get: {
+    input: {
+    path: {
+      competitor_id: string;
+    };
+    query?: {
+      /** Bypass the cached page inventory and re-map the site (paid). */
+      refresh?: boolean;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * POST /radar/alerts/dispatch
+   * Dispatch Alerts
+   * tier: external · scope: radar:run
+   */
+  dispatch_alerts_radar_alerts_dispatch_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * GET /radar/feature-matrix
+   * Feature Matrix
+   * tier: read · scope: radar:read
+   */
+  feature_matrix_radar_feature_matrix_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * GET /radar/competitors/{competitor_id}
+   * Get Competitor
+   * tier: read · scope: radar:read
+   */
+  get_competitor_radar_competitors__competitor_id__get: {
+    input: {
+    path: {
+      competitor_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * GET /radar/competitors/{competitor_id}/ads
+   * Get Competitor Ads
+   * tier: read · scope: radar:read
+   */
+  get_competitor_ads_radar_competitors__competitor_id__ads_get: {
+    input: {
+    path: {
+      competitor_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * GET /radar/competitors/{competitor_id}/engagers
+   * Get Competitor Engagers
+   * tier: read · scope: radar:read
+   */
+  get_competitor_engagers_radar_competitors__competitor_id__engagers_get: {
+    input: {
+    path: {
+      competitor_id: string;
+    };
+    query?: {
+      limit?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * GET /radar/competitors/{competitor_id}/pages
+   * Get Competitor Pages
+   * tier: read · scope: radar:read
+   */
+  get_competitor_pages_radar_competitors__competitor_id__pages_get: {
+    input: {
+    path: {
+      competitor_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * GET /radar/competitors/{competitor_id}/posts
+   * Get Competitor Posts
+   * tier: read · scope: radar:read
+   */
+  get_competitor_posts_radar_competitors__competitor_id__posts_get: {
+    input: {
+    path: {
+      competitor_id: string;
+    };
+    query?: {
+      limit?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * GET /radar/competitors/{competitor_id}/traffic
+   * Get Competitor Traffic
+   * tier: read · scope: radar:read
+   */
+  get_competitor_traffic_radar_competitors__competitor_id__traffic_get: {
+    input: {
+    path: {
+      competitor_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * GET /radar/settings
+   * Get Settings
+   * tier: read · scope: radar:read
+   */
+  get_settings_radar_settings_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * GET /radar/keyword-gap
+   * Keyword Gap
+   * tier: read · scope: radar:run
+   */
+  keyword_gap_radar_keyword_gap_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * GET /radar/competitors
+   * List Competitors
+   * tier: read · scope: radar:read
+   */
+  list_competitors_radar_competitors_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * GET /radar/gaps
+   * List Gaps
+   * tier: read · scope: radar:read
+   */
+  list_gaps_radar_gaps_get: {
+    input: {
+    query?: {
+      lens?: string | null;
+      status?: string | null;
+      competitor_id?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * GET /radar/initiatives
+   * List Initiatives
+   * tier: read · scope: radar:read
+   */
+  list_initiatives_radar_initiatives_get: {
+    input: {
+    query?: {
+      lane?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * GET /radar/opportunities
+   * List Opportunities
+   * tier: read · scope: radar:read
+   */
+  list_opportunities_radar_opportunities_get: {
+    input: {
+    query?: {
+      lane?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * POST /radar/initiatives/measure
+   * Measure Initiatives
+   * tier: billable · scope: radar:run
+   */
+  measure_initiatives_radar_initiatives_measure_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * GET /radar/monitoring/ads/{ad_id}
+   * Monitoring Ad Detail
+   * tier: read · scope: radar:read
+   */
+  monitoring_ad_detail_radar_monitoring_ads__ad_id__get: {
+    input: {
+    path: {
+      ad_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * GET /radar/monitoring/ads
+   * Monitoring Ads
+   * tier: read · scope: radar:run
+   */
+  monitoring_ads_radar_monitoring_ads_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * GET /radar/monitoring/content
+   * Monitoring Content
+   * tier: read · scope: radar:read
+   */
+  monitoring_content_radar_monitoring_content_get: {
+    input: {
+    query?: {
+      competitor_id?: string | null;
+      kind?: string | null;
+      change_category?: string | null;
+      change_type?: string | null;
+      min_significance?: number | null;
+      date_from?: string | null;
+      date_to?: string | null;
+      search?: string | null;
+      limit?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * GET /radar/monitoring/linkedin
+   * Monitoring Linkedin
+   * tier: read · scope: radar:read
+   */
+  monitoring_linkedin_radar_monitoring_linkedin_get: {
+    input: {
+    query?: {
+      page?: number;
+      limit?: number;
+      competitor_domain?: string | null;
+      date_from?: string | null;
+      date_to?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * GET /radar/optimization-runs
+   * Optimization Runs
+   * tier: read · scope: radar:read
+   */
+  optimization_runs_radar_optimization_runs_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * GET /radar/overview
+   * Overview
+   * tier: read · scope: radar:read
+   */
+  overview_radar_overview_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * GET /radar/own-traffic-estimate
+   * Own Traffic Estimate
+   * tier: read · scope: radar:run
+   */
+  own_traffic_estimate_radar_own_traffic_estimate_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * GET /radar/monitoring/page-history
+   * Page History
+   * tier: read · scope: radar:read
+   */
+  page_history_radar_monitoring_page_history_get: {
+    input: {
+    query: {
+      url: string;
+      competitor_id: string;
+      limit?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * PUT /radar/settings
+   * Put Settings
+   * tier: billable · scope: radar:write
+   */
+  put_settings_radar_settings_put: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: RadarSettings;
+  };
+    output: unknown;
+  };
+  /**
+   * POST /radar/scan-all
+   * Scan All Competitors
+   * tier: billable · scope: radar:run
+   */
+  scan_all_competitors_radar_scan_all_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * POST /radar/competitors/{competitor_id}/scan
+   * Scan Competitor
+   * tier: billable · scope: radar:run
+   */
+  scan_competitor_radar_competitors__competitor_id__scan_post: {
+    input: {
+    path: {
+      competitor_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * GET /radar/traffic
+   * Traffic
+   * tier: read · scope: radar:read
+   */
+  traffic_radar_traffic_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+  /**
+   * PATCH /radar/competitors/{competitor_id}
+   * Update Competitor
+   * tier: billable · scope: radar:write
+   */
+  update_competitor_radar_competitors__competitor_id__patch: {
+    input: {
+    path: {
+      competitor_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: PatchCompetitorRequest;
+  };
+    output: unknown;
+  };
+  /**
+   * PATCH /radar/gaps/{gap_id}
+   * Update Gap
+   * tier: billable · scope: radar:write
+   */
+  update_gap_radar_gaps__gap_id__patch: {
+    input: {
+    path: {
+      gap_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: PatchGapRequest;
+  };
+    output: unknown;
+  };
+}
+
+// 13 schemas referenced above (the same as G8Contract.<Name>).
+
+export interface AnalyzeGapsRequest {
+  lenses?: Array<string> | null;
+}
+
+export interface ApproveAllRequest {
+  lane?: string;
+}
+
+export interface ApproveOpportunityRequest {
+  content_types?: Array<string> | null;
+  create_crm_task?: boolean;
+  due_date?: string | null;
+  kinds?: Array<string> | null;
+  owner_id?: string | null;
+  seed_context?: SeedContext | null;
+}
+
+export interface BulkCompetitorItem {
+  domain: string;
+  name?: string | null;
+  scan_config?: ScanConfigDTO | null;
+  tier?: string | null;
+}
+
+export interface BulkCompetitorsRequest {
+  competitors?: Array<BulkCompetitorItem>;
+  scan_on_add?: boolean;
+}
+
+export interface CreateCompetitorRequest {
+  domain: string;
+  name?: string | null;
+  scan_config?: ScanConfigDTO | null;
+  scan_on_add?: boolean;
+  tier?: string | null;
+}
+
+export interface PatchCompetitorRequest {
+  is_active?: boolean | null;
+  name?: string | null;
+  scan_config?: ScanConfigDTO | null;
+  tier?: string | null;
+}
+
+export interface PatchGapRequest {
+  status: string;
+}
+
+export interface RadarAlerts {
+  case_files?: boolean;
+  content_velocity?: boolean;
+  hiring_spike?: boolean;
+  keyword_overtake?: boolean;
+  new_ads?: boolean;
+  pricing_change?: boolean;
+  warm_account?: boolean;
+}
+
+export interface RadarChannels {
+  bridge?: boolean;
+  in_app?: boolean;
+}
+
+export interface RadarSettings {
+  ad_source?: "stored" | "linkedin" | "meta" | "google" | "all";
+  alerts?: RadarAlerts;
+  channels?: RadarChannels;
+  monthly_credit_cap?: number | null;
+  tier1_cadence_days?: number;
+  tier2_cadence_days?: number;
+}
+
+/**
+ * Per-competitor page-selection config (persisted on profile.meta.scan_config).
+ *
+ * mode=auto: Firecrawl /map → rank by traffic + pricing/feature paths → scrape
+ * top N (= tier page budget). mode=manual: scrape include_paths (literal or
+ * /wildcard/* patterns), capped to the budget.
+ */
+export interface ScanConfigDTO {
+  include_paths?: Array<string>;
+  mode?: "auto" | "manual";
+}
+
+/**
+ * Optional richer seed for an approved stub — e.g. the target keyword (+ volume/cpc)
+ * to seed an SEO page with. All optional; absent → current behavior unchanged.
+ */
+export interface SeedContext {
+  cpc?: number | null;
+  primary_keyword?: string | null;
+  volume?: number | null;
+}