@graph8/sdk 0.251.0 → 0.260.0

package/docs/api/companyIntelligence.d.ts

@@ -0,0 +1,299 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.companyIntelligence` (Company Intelligence): 14 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"analyze_website_intelligence_analyze_post">;
+ *
+ * Reference with examples: companyIntelligence.md
+ */
+/* eslint-disable */
+
+/** `g8.api.companyIntelligence.<member>` -> the operationId it calls. */
+export interface CompanyIntelligenceMembers {
+  analyzeWebsite: "analyze_website_intelligence_analyze_post";
+  generateGlobalContextDocument: "generate_global_context_document_global_context_generate__doc_type__post";
+  getAllIntelligenceData: "get_all_intelligence_data_intelligence_all__website_url__get";
+  getGlobalContextTree: "get_global_context_tree_global_context_tree_get";
+  getGlobalContextTreeFlat: "get_global_context_tree_flat_global_context_tree_flat_get";
+  getIntelligenceData: "get_intelligence_data_intelligence_data__data_type__get";
+  getIntelligenceOrgDomain: "get_intelligence_org_domain_intelligence_org_domain_get";
+  getIntelligencePrimaryWebsite: "get_intelligence_primary_website_intelligence_primary_website_get";
+  getIntelligenceStatus: "get_intelligence_status_intelligence_status__task_id__get";
+  getLatestIntelligenceTask: "get_latest_intelligence_task_intelligence_latest_task_get";
+  getResearchReportThinking: "get_research_report_thinking_research_reports__report_id__thinking_get";
+  listIntelligenceDocuments: "list_intelligence_documents_intelligence_documents_get";
+  resetIntelligence: "reset_intelligence_intelligence_delete";
+  retryIntelligenceSource: "retry_intelligence_source_intelligence_retry_post";
+}
+
+/** Input and output of every `g8.api.companyIntelligence` operation, keyed by operationId. */
+export interface CompanyIntelligenceOperations {
+  /**
+   * POST /intelligence/analyze
+   * Analyze Website
+   * tier: billable · scope: knowledge:run
+   */
+  analyze_website_intelligence_analyze_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: IntelligenceAnalyzeRequest;
+  };
+    output: ApiResponse_IntelligencePayload_;
+  };
+  /**
+   * POST /global-context/generate/{doc_type}
+   * Generate Global Context Document
+   * tier: billable · scope: knowledge:run
+   */
+  generate_global_context_document_global_context_generate__doc_type__post: {
+    input: {
+    path: {
+      /** The document type to (re)generate. */
+      doc_type: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: GlobalContextGenerateRequest;
+  };
+    output: ApiResponse_IntelligencePayload_;
+  };
+  /**
+   * GET /intelligence/all/{website_url}
+   * Get All Intelligence Data
+   * tier: read · scope: knowledge:read
+   */
+  get_all_intelligence_data_intelligence_all__website_url__get: {
+    input: {
+    path: {
+      /** The researched website (host, no scheme). */
+      website_url: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_IntelligencePayload_;
+  };
+  /**
+   * GET /global-context/tree
+   * Get Global Context Tree
+   * tier: read · scope: knowledge:read
+   */
+  get_global_context_tree_global_context_tree_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_IntelligencePayload_;
+  };
+  /**
+   * GET /global-context/tree/flat
+   * Get Global Context Tree Flat
+   * tier: read · scope: knowledge:read
+   */
+  get_global_context_tree_flat_global_context_tree_flat_get: {
+    input: {
+    query?: {
+      /** Only documents under this folder. */
+      folder_path?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_IntelligencePayload_;
+  };
+  /**
+   * GET /intelligence/data/{data_type}
+   * Get Intelligence Data
+   * tier: read · scope: knowledge:read
+   */
+  get_intelligence_data_intelligence_data__data_type__get: {
+    input: {
+    path: {
+      /** Which data source, e.g. `company_info`. */
+      data_type: string;
+    };
+    query?: {
+      website_url?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_IntelligencePayload_;
+  };
+  /**
+   * GET /intelligence/org-domain
+   * Get Intelligence Org Domain
+   * tier: read · scope: knowledge:read
+   */
+  get_intelligence_org_domain_intelligence_org_domain_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_IntelligencePayload_;
+  };
+  /**
+   * GET /intelligence/primary-website
+   * Get Intelligence Primary Website
+   * tier: read · scope: knowledge:read
+   */
+  get_intelligence_primary_website_intelligence_primary_website_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_IntelligencePayload_;
+  };
+  /**
+   * GET /intelligence/status/{task_id}
+   * Get Intelligence Status
+   * tier: read · scope: knowledge:read
+   */
+  get_intelligence_status_intelligence_status__task_id__get: {
+    input: {
+    path: {
+      /** Task id returned by `POST /intelligence/analyze`. */
+      task_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_IntelligencePayload_;
+  };
+  /**
+   * GET /intelligence/latest-task
+   * Get Latest Intelligence Task
+   * tier: read · scope: knowledge:read
+   */
+  get_latest_intelligence_task_intelligence_latest_task_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_IntelligencePayload_;
+  };
+  /**
+   * GET /research-reports/{report_id}/thinking
+   * Get Research Report Thinking
+   * tier: read · scope: knowledge:read
+   */
+  get_research_report_thinking_research_reports__report_id__thinking_get: {
+    input: {
+    path: {
+      /** Research report id. */
+      report_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_IntelligencePayload_;
+  };
+  /**
+   * GET /intelligence/documents
+   * List Intelligence Documents
+   * tier: read · scope: knowledge:read
+   */
+  list_intelligence_documents_intelligence_documents_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_IntelligenceListPayload_;
+  };
+  /**
+   * DELETE /intelligence
+   * Reset Intelligence
+   * tier: destructive · scope: knowledge:delete
+   */
+  reset_intelligence_intelligence_delete: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_IntelligencePayload_;
+  };
+  /**
+   * POST /intelligence/retry
+   * Retry Intelligence Source
+   * tier: billable · scope: knowledge:run
+   */
+  retry_intelligence_source_intelligence_retry_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: IntelligenceSourceRetryRequest;
+  };
+    output: ApiResponse_IntelligencePayload_;
+  };
+}
+
+// 8 schemas referenced above (the same as G8Contract.<Name>).
+
+export interface ApiResponse_IntelligenceListPayload_ {
+  data: IntelligenceListPayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_IntelligencePayload_ {
+  data: IntelligencePayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface GlobalContextGenerateRequest {
+  /** Must match the `doc_type` in the path. */
+  doc_type: string;
+  website_url: string;
+}
+
+export interface IntelligenceAnalyzeRequest {
+  /** Re-run even when a recent analysis exists. */
+  force?: boolean;
+  /** The company website to research. */
+  website_url: string;
+}
+
+/** A list result under `items`. */
+export interface IntelligenceListPayload {
+  items?: Array<unknown>;
+  [key: string]: unknown;
+}
+
+/** An intelligence task, data record or document, as the app returns it. */
+export type IntelligencePayload = Record<string, unknown>;
+
+export interface IntelligenceSourceRetryRequest {
+  /** The one data source to re-collect. */
+  data_type: string;
+  website_url: string;
+}
+
+export interface PaginationMeta {
+  /** Whether there are more pages */
+  has_next: boolean;
+  /** Items per page */
+  limit: number;
+  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
+  next_cursor?: string | null;
+  /** Current page number (1-indexed) */
+  page: number;
+  /** Total number of items */
+  total: number;
+}