@graph8/sdk 0.251.0 → 0.260.0

package/docs/api/research.d.ts

@@ -0,0 +1,295 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.research` (Research): 13 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"approve_research_report_research_reports__report_id__approve_post">;
+ *
+ * Reference with examples: research.md
+ */
+/* eslint-disable */
+
+/** `g8.api.research.<member>` -> the operationId it calls. */
+export interface ResearchMembers {
+  approveResearchReport: "approve_research_report_research_reports__report_id__approve_post";
+  deleteResearchReport: "delete_research_report_research_reports__report_id__delete";
+  generateAllResearchReports: "generate_all_research_reports_research_reports_generate_all_post";
+  generateResearchReport: "generate_research_report_research_reports_generate_post";
+  getResearchReport: "get_research_report_research_reports__report_id__get";
+  getResearchReportByNumber: "get_research_report_by_number_research_reports_by_number__report_number__get";
+  getResearchWorkflowStatus: "get_research_workflow_status_research_reports_workflow_get";
+  resetResearchWorkflow: "reset_research_workflow_research_reports_workflow_reset_post";
+  resumeResearchWorkflow: "resume_research_workflow_research_reports_workflow_resume_post";
+  retryResearchReport: "retry_research_report_research_reports_retry_post";
+  scaffoldResearchReports: "scaffold_research_reports_research_reports_scaffold_post";
+  stopAllResearch: "stop_all_research_research_reports_stop_all_post";
+  unapproveResearchReport: "unapprove_research_report_research_reports__report_id__unapprove_post";
+}
+
+/** Input and output of every `g8.api.research` operation, keyed by operationId. */
+export interface ResearchOperations {
+  /**
+   * POST /research-reports/{report_id}/approve
+   * Approve Research Report
+   * tier: write · scope: campaigns:write
+   */
+  approve_research_report_research_reports__report_id__approve_post: {
+    input: {
+    path: {
+      /** Research report id. */
+      report_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * DELETE /research-reports/{report_id}
+   * Delete Research Report
+   * tier: destructive · scope: campaigns:delete
+   */
+  delete_research_report_research_reports__report_id__delete: {
+    input: {
+    path: {
+      /** Research report id. */
+      report_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * POST /research-reports/generate-all
+   * Generate All Research Reports
+   * tier: billable · scope: campaigns:run
+   */
+  generate_all_research_reports_research_reports_generate_all_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: GenerateAllReportsRequest;
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * POST /research-reports/generate
+   * Generate Research Report
+   * tier: billable · scope: campaigns:run
+   */
+  generate_research_report_research_reports_generate_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: GenerateReportRequest;
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * GET /research-reports/{report_id}
+   * Get Research Report
+   * tier: read · scope: campaigns:read
+   */
+  get_research_report_research_reports__report_id__get: {
+    input: {
+    path: {
+      /** Research report id. */
+      report_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * GET /research-reports/by-number/{report_number}
+   * Get Research Report By Number
+   * tier: read · scope: campaigns:read
+   */
+  get_research_report_by_number_research_reports_by_number__report_number__get: {
+    input: {
+    path: {
+      /** Report number, 1-6. */
+      report_number: number;
+    };
+    query: {
+      /** The website the workflow is scoped to. */
+      website_url: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * GET /research-reports/workflow
+   * Get Research Workflow Status
+   * tier: read · scope: campaigns:read
+   */
+  get_research_workflow_status_research_reports_workflow_get: {
+    input: {
+    query: {
+      /** The website the workflow is scoped to. */
+      website_url: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * POST /research-reports/workflow/reset
+   * Reset Research Workflow
+   * tier: destructive · scope: campaigns:delete
+   */
+  reset_research_workflow_research_reports_workflow_reset_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: GenerateAllReportsRequest;
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * POST /research-reports/workflow/resume
+   * Resume Research Workflow
+   * tier: billable · scope: campaigns:run
+   */
+  resume_research_workflow_research_reports_workflow_resume_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * POST /research-reports/retry
+   * Retry Research Report
+   * tier: billable · scope: campaigns:run
+   */
+  retry_research_report_research_reports_retry_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: RetryResearchReportRequest;
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * POST /research-reports/scaffold
+   * Scaffold Research Reports
+   * tier: write · scope: campaigns:write
+   */
+  scaffold_research_reports_research_reports_scaffold_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentListPayload_;
+  };
+  /**
+   * POST /research-reports/stop-all
+   * Stop All Research
+   * tier: write · scope: campaigns:write
+   */
+  stop_all_research_research_reports_stop_all_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: GenerateAllReportsRequest;
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+  /**
+   * POST /research-reports/{report_id}/unapprove
+   * Unapprove Research Report
+   * tier: write · scope: campaigns:write
+   */
+  unapprove_research_report_research_reports__report_id__unapprove_post: {
+    input: {
+    path: {
+      /** Research report id. */
+      report_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioContentPayload_;
+  };
+}
+
+// 8 schemas referenced above (the same as G8Contract.<Name>).
+
+export interface ApiResponse_StudioContentListPayload_ {
+  data: StudioContentListPayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_StudioContentPayload_ {
+  data: StudioContentPayload;
+  pagination?: PaginationMeta | null;
+}
+
+/** Address the whole six-report workflow for one website. */
+export interface GenerateAllReportsRequest {
+  website_url: string;
+}
+
+/** Generate ONE research report. SPENDS CREDIT - a long multi-pass run. */
+export interface GenerateReportRequest {
+  report_number: number;
+  report_type?: string | null;
+  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;
+}
+
+/** Re-run one failed report. SPENDS CREDIT. */
+export interface RetryResearchReportRequest {
+  report_type: "review_sentiment" | "competitive_teardown" | "voice_of_customer" | "gtm_channel" | "analyst_media" | "buyer_psychology";
+  website_url: string;
+}
+
+/**
+ * A LIST result, open-shaped, with `items` always present.
+ *
+ * The app returns a bare list from some routes and a named key from others
+ * (`pages`, `grids`, `images`, `creatives`, `reports`, `items`). Both are
+ * published: the original key is preserved AND mirrored onto `items`, so a
+ * client can page any Studio collection the same way without a per-route
+ * lookup table.
+ */
+export interface StudioContentListPayload {
+  items?: Array<unknown>;
+  [key: string]: unknown;
+}
+
+/** One Studio object, open-shaped. See the module docstring. */
+export type StudioContentPayload = Record<string, unknown>;