@lightsage/mcp 0.1.7 → 0.1.11

package/src/models/createv2promptrequest.ts

@@ -0,0 +1,23 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 7cc54f1fe084
+ */
+
+import * as z from "zod";
+
+export type CreateV2PromptRequest = {
+  topic_id: string;
+  text: string;
+  platform_ids?: Array<string> | undefined;
+};
+
+export const CreateV2PromptRequest$zodSchema: z.ZodType<CreateV2PromptRequest> =
+  z.object({
+    platform_ids: z.array(z.string()).optional().describe(
+      "Answer-platform IDs from the prompt configuration. Omit to attach none.",
+    ),
+    text: z.string(),
+    topic_id: z.string().describe(
+      "Prompt topic ID from `GET /v2/prompts/topics`.",
+    ),
+  });

package/src/models/createv2promptsrequest.ts

@@ -0,0 +1,18 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 1dc232a6ca27
+ */
+
+import * as z from "zod";
+import {
+  CreateV2PromptRequest,
+  CreateV2PromptRequest$zodSchema,
+} from "./createv2promptrequest.js";
+
+export type CreateV2PromptsRequest = { prompts: Array<CreateV2PromptRequest> };
+
+export const CreateV2PromptsRequest$zodSchema: z.ZodType<
+  CreateV2PromptsRequest
+> = z.object({
+  prompts: z.array(CreateV2PromptRequest$zodSchema),
+});

package/src/models/createv2repositoryrequest.ts

@@ -0,0 +1,60 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: f465a371e632
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../types/enums.js";
+
+export const CreateV2RepositoryRequestFramework = {
+  Fastify: "fastify",
+  Nuxt: "nuxt",
+  Express: "express",
+  SpaJs: "spa-js",
+  Angular: "angular",
+  React: "react",
+  Fastapi: "fastapi",
+  Vite: "vite",
+  Nextjs: "nextjs",
+  Custom: "custom",
+} as const;
+export type CreateV2RepositoryRequestFramework = ClosedEnum<
+  typeof CreateV2RepositoryRequestFramework
+>;
+
+export const CreateV2RepositoryRequestFramework$zodSchema = z.enum([
+  "fastify",
+  "nuxt",
+  "express",
+  "spa-js",
+  "angular",
+  "react",
+  "fastapi",
+  "vite",
+  "nextjs",
+  "custom",
+]);
+
+export type CreateV2RepositoryRequest = {
+  name: string;
+  repo_url: string;
+  ref?: string | undefined;
+  subdir?: string | undefined;
+  install_steps?: Array<string> | undefined;
+  framework?: CreateV2RepositoryRequestFramework | undefined;
+  enabled?: boolean | undefined;
+};
+
+export const CreateV2RepositoryRequest$zodSchema: z.ZodType<
+  CreateV2RepositoryRequest
+> = z.object({
+  enabled: z.boolean().default(true),
+  framework: CreateV2RepositoryRequestFramework$zodSchema.default("custom"),
+  install_steps: z.array(z.string()).optional(),
+  name: z.string(),
+  ref: z.string().default("main").describe("Branch, tag, or commit SHA."),
+  repo_url: z.string(),
+  subdir: z.string().default("").describe(
+    "Project root inside the repository.",
+  ),
+});

package/src/models/errors/apierror.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: e2280e075454
  */
 
 export class APIError extends Error {

package/src/models/errors/httpclienterrors.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 6948de76af99
  */
 
 /**

package/src/models/errors/sdkvalidationerror.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: fb6b2b49c445
  */
 
 import * as z from "zod";

package/src/models/generatecontentdraftrequest.ts

@@ -1,12 +1,10 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: dd64a9271eda
  */
 
 import * as z from "zod";
 
-/**
- * Generate a draft marketing/blog article and save it.
- */
 export type GenerateContentDraftRequest = {
   title: string;
   topic_name?: string | undefined;
@@ -18,13 +16,13 @@ export const GenerateContentDraftRequest$zodSchema: z.ZodType<
   GenerateContentDraftRequest
 > = z.object({
   description: z.string().optional().describe(
-    "Optional brief describing angle, audience, or goals.",
+    "Brief on angle, audience, or goals.",
   ),
   prompt_texts: z.array(z.string()).optional().describe(
-    "Optional related prompts/questions to ground the article.",
+    "Related prompts or questions to ground the article.",
   ),
-  title: z.string().describe("Article title/headline."),
+  title: z.string(),
   topic_name: z.string().optional().describe(
-    "Topic or theme; defaults to the title when omitted.",
+    "The topic or theme for the article. Defaults to `title`.",
   ),
-}).describe("Generate a draft marketing/blog article and save it.");
+});

package/src/models/httpvalidationerror.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: f8530b344822
  */
 
 import * as z from "zod";

package/src/models/listopportunitiesresponse.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 3d9200cf3226
  */
 
 import * as z from "zod";
@@ -19,9 +20,13 @@ export type ListOpportunitiesResponse = {
 export const ListOpportunitiesResponse$zodSchema: z.ZodType<
   ListOpportunitiesResponse
 > = z.object({
-  count: z.int(),
+  count: z.int().describe("Capped by `limit`; not the total available."),
   data: z.array(PublicPromptOpportunity$zodSchema).optional(),
   end_date: z.string(),
-  start_date: z.string(),
-  summary: z.record(z.string(), z.any()).optional(),
+  start_date: z.string().describe(
+    "Window start actually used, after resolving `start_date`, `since`, or the default.",
+  ),
+  summary: z.record(z.string(), z.any()).optional().describe(
+    "Breakdowns of the returned items only; each sums to `count`.",
+  ),
 });

package/src/models/listpromptsresponse.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: d7cd8f69c086
  */
 
 import * as z from "zod";

package/src/models/promptbatcherror.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: e82e3c681321
  */
 
 import * as z from "zod";
@@ -9,7 +10,9 @@ export type PromptBatchError = { index: number; text: string; error: string };
 export const PromptBatchError$zodSchema: z.ZodType<PromptBatchError> = z.object(
   {
     error: z.string(),
-    index: z.int(),
+    index: z.int().describe(
+      "Zero-based index into the submitted `prompts` array.",
+    ),
     text: z.string(),
   },
 );

package/src/models/publiccitedurl.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 9b31ee9fd632
+ */
+
+import * as z from "zod";
+
+export type PublicCitedUrl = {
+  url: string;
+  domain?: string | null | undefined;
+  title?: string | null | undefined;
+  favicon_url?: string | null | undefined;
+  is_company_link: boolean;
+  citation_count: number;
+  prompt_count: number;
+  platform_names?: Array<string> | undefined;
+};
+
+export const PublicCitedUrl$zodSchema: z.ZodType<PublicCitedUrl> = z.object({
+  citation_count: z.int().describe(
+    "Number of citations to this normalized URL in the date range.",
+  ),
+  domain: z.string().nullable().optional().describe("Domain of the cited URL."),
+  favicon_url: z.string().nullable().optional().describe(
+    "Page favicon URL, when available.",
+  ),
+  is_company_link: z.boolean().describe(
+    "Whether the URL belongs to an owned company domain.",
+  ),
+  platform_names: z.array(z.string()).optional().describe(
+    "Platforms that cited this URL in the selected date range.",
+  ),
+  prompt_count: z.int().describe(
+    "Number of distinct active prompts that cited this URL.",
+  ),
+  title: z.string().nullable().optional().describe(
+    "Page title, when available.",
+  ),
+  url: z.string().describe(
+    "Most frequently observed variant of the cited URL.",
+  ),
+});

package/src/models/publiccitedurldaterange.ts

@@ -0,0 +1,22 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: f8105c09c83b
+ */
+
+import * as z from "zod";
+
+export type PublicCitedUrlDateRange = {
+  start_date: string;
+  end_date: string;
+  active_prompts_only?: boolean | undefined;
+};
+
+export const PublicCitedUrlDateRange$zodSchema: z.ZodType<
+  PublicCitedUrlDateRange
+> = z.object({
+  active_prompts_only: z.boolean().default(true).describe(
+    "Whether only currently active prompts were included.",
+  ),
+  end_date: z.string().describe("End date used for the calculation."),
+  start_date: z.string().describe("Start date used for the calculation."),
+});

package/src/models/publiccompany.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 5f8b1322b9fa
  */
 
 import * as z from "zod";
@@ -15,5 +16,7 @@ export const PublicCompany$zodSchema: z.ZodType<PublicCompany> = z.object({
   domain: z.string().nullable().optional(),
   logo_url: z.string().nullable().optional(),
   name: z.string(),
-  relationship: z.string().nullable().optional(),
+  relationship: z.string().nullable().optional().describe(
+    "The company relationship: `primary` for the organization's own company or `competitor` for a tracked competitor.",
+  ),
 });

package/src/models/publiccompetitorrow.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: ca0fdacbd034
  */
 
 import * as z from "zod";
@@ -18,22 +19,18 @@ export type PublicCompetitorRow = {
 export const PublicCompetitorRow$zodSchema: z.ZodType<PublicCompetitorRow> = z
   .object({
     average_position: z.number().nullable().optional().describe(
-      "Average mention position aggregated over the date range.",
+      "Mean mention position in AI responses; 1 is first and lower is better. 0 when never mentioned.",
     ),
     average_position_rank: z.int().nullable().optional().describe(
-      "Rank by average mention position among tracked companies.",
+      "Companies with an `average_position` of 0 rank last.",
     ),
     company: PublicCompany$zodSchema,
     share_of_voice: z.number().nullable().optional().describe(
-      "Share of voice aggregated over the date range, from 0 to 1.",
-    ),
-    share_of_voice_rank: z.int().nullable().optional().describe(
-      "Rank by share of voice among tracked companies.",
+      "Share of all brand mentions across tracked companies, 0 to 1; rows sum to about 1.",
     ),
+    share_of_voice_rank: z.int().nullable().optional(),
     visibility_score: z.number().nullable().optional().describe(
-      "Visibility score aggregated over the date range, from 0 to 1.",
-    ),
-    visibility_score_rank: z.int().nullable().optional().describe(
-      "Rank by visibility score among tracked companies.",
+      "The company's visibility score, from 0 to 1. Rows do not sum to 1.",
     ),
+    visibility_score_rank: z.int().nullable().optional(),
   });

package/src/models/publiccontent.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 7b9d6d3d39e6
  */
 
 import * as z from "zod";
@@ -18,6 +19,6 @@ export const PublicContent$zodSchema: z.ZodType<PublicContent> = z.object({
   id: z.string(),
   slug: z.string(),
   status: z.string(),
-  text: z.string(),
+  text: z.string().describe("The article body in Markdown."),
   title: z.string(),
 });

package/src/models/publiccurrentvisibilityresponse.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: c85bd4df4e53
  */
 
 import * as z from "zod";
@@ -23,34 +24,24 @@ export type PublicCurrentVisibilityResponse = {
 export const PublicCurrentVisibilityResponse$zodSchema: z.ZodType<
   PublicCurrentVisibilityResponse
 > = z.object({
-  active_prompts_only: z.boolean().default(true).describe(
-    "Whether only currently active prompts were included.",
-  ),
+  active_prompts_only: z.boolean().default(true),
   average_position: z.number().nullable().optional().describe(
-    "Average mention position for the selected date range.",
-  ),
-  average_position_rank: z.int().nullable().optional().describe(
-    "Rank by average mention position among tracked companies.",
+    "Mean mention position in AI responses; 1 is first and lower is better.",
   ),
+  average_position_rank: z.int().nullable().optional(),
   company: PublicCompany$zodSchema,
   date: z.string().nullable().optional().describe(
-    "Latest prompt-run date included in the calculation.",
-  ),
-  end_date: z.string().describe("End date used for the calculation."),
-  has_data: z.boolean().describe(
-    "Whether the selected date range contains visibility data.",
+    "Latest prompt-run date in the range.",
   ),
+  end_date: z.string(),
+  has_data: z.boolean(),
   share_of_voice: z.number().nullable().optional().describe(
-    "Current share of voice for the selected date range, from 0 to 1.",
+    "Share of all brand mentions across tracked companies, 0 to 1.",
   ),
-  share_of_voice_rank: z.int().nullable().optional().describe(
-    "Rank by share of voice among tracked companies.",
-  ),
-  start_date: z.string().describe("Start date used for the calculation."),
+  share_of_voice_rank: z.int().nullable().optional(),
+  start_date: z.string(),
   visibility_score: z.number().nullable().optional().describe(
-    "Current visibility score for the selected date range, from 0 to 1.",
-  ),
-  visibility_score_rank: z.int().nullable().optional().describe(
-    "Rank by visibility score among tracked companies.",
+    "The visibility score, from 0 to 1.",
   ),
+  visibility_score_rank: z.int().nullable().optional(),
 });

package/src/models/publicevalrunprogress.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 82f70dd975f3
  */
 
 import * as z from "zod";
@@ -21,7 +22,9 @@ export const PublicEvalRunProgress$zodSchema: z.ZodType<PublicEvalRunProgress> =
     completed: z.int().default(0),
     failed: z.int().default(0),
     interrupted: z.int().default(0),
-    percent: z.number().default(0),
+    percent: z.number().default(0).describe(
+      "The percentage of child jobs in a terminal state. It can reach `100` while the parent job is still summarizing, so use `status` to detect completion.",
+    ),
     queued: z.int().default(0),
     running: z.int().default(0),
     total: z.int().default(0),

package/src/models/publicokresponse.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: c2b35dc63f06
  */
 
 import * as z from "zod";

package/src/models/publicplatformref.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 1ee7f0e8efde
  */
 
 import * as z from "zod";
@@ -8,15 +9,19 @@ export type PublicPlatformRef = {
   platform_id: string;
   name: string;
   icon_url?: string | null | undefined;
+  mention_count?: number | undefined;
+  prompt_run_count?: number | undefined;
 };
 
 export const PublicPlatformRef$zodSchema: z.ZodType<PublicPlatformRef> = z
   .object({
-    icon_url: z.string().nullable().optional().describe(
-      "Platform icon URL, if available.",
+    icon_url: z.string().nullable().optional(),
+    mention_count: z.int().default(0).describe(
+      "Prompt runs where the company was mentioned on this platform in the date range.",
     ),
-    name: z.string().describe("Human-readable platform name."),
-    platform_id: z.string().describe(
-      "Stable platform identifier, e.g. chatgpt.",
+    name: z.string(),
+    platform_id: z.string(),
+    prompt_run_count: z.int().default(0).describe(
+      "Total prompt runs on this platform in the date range.",
     ),
   });

package/src/models/publicprompt.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 7c803001c7a9
  */
 
 import * as z from "zod";
@@ -17,18 +18,26 @@ import {
   PublicPromptTopic$zodSchema,
 } from "./publicprompttopic.js";
 
+/**
+ * The prompt lifecycle status. Only `active` prompts run on schedule.
+ */
 export const PublicPromptStatus = {
   Active: "active",
   Inactive: "inactive",
   Archived: "archived",
 } as const;
+/**
+ * The prompt lifecycle status. Only `active` prompts run on schedule.
+ */
 export type PublicPromptStatus = ClosedEnum<typeof PublicPromptStatus>;
 
 export const PublicPromptStatus$zodSchema = z.enum([
   "active",
   "inactive",
   "archived",
-]);
+]).describe(
+  "The prompt lifecycle status. Only `active` prompts run on schedule.",
+);
 
 export type PublicPrompt = {
   id: string;
@@ -36,8 +45,7 @@ export type PublicPrompt = {
   text: string;
   language_id?: string | null | undefined;
   region_id?: string | null | undefined;
-  is_active?: boolean | undefined;
-  status?: PublicPromptStatus | null | undefined;
+  status: PublicPromptStatus;
   topic?: PublicPromptTopic | null | undefined;
   platforms?: Array<PublicPromptPlatform> | undefined;
   tags?: Array<PublicPromptTag> | undefined;
@@ -48,11 +56,12 @@ export type PublicPrompt = {
 export const PublicPrompt$zodSchema: z.ZodType<PublicPrompt> = z.object({
   created_at: z.string().nullable().optional(),
   id: z.string(),
-  is_active: z.boolean().default(true),
   language_id: z.string().nullable().optional(),
   platforms: z.array(PublicPromptPlatform$zodSchema).optional(),
   region_id: z.string().nullable().optional(),
-  status: PublicPromptStatus$zodSchema.nullable().optional(),
+  status: PublicPromptStatus$zodSchema.describe(
+    "The prompt lifecycle status. Only `active` prompts run on schedule.",
+  ),
   tags: z.array(PublicPromptTag$zodSchema).optional(),
   text: z.string(),
   topic: PublicPromptTopic$zodSchema.nullable().optional(),

package/src/models/publicpromptbatchresponse.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 9c5fadb0ac89
  */
 
 import * as z from "zod";

package/src/models/publicpromptopportunity.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 7fc66051ce3a
  */
 
 import * as z from "zod";
@@ -25,16 +26,22 @@ export const PublicPromptOpportunity$zodSchema: z.ZodType<
   z.object({
     action: z.string(),
     category: z.string(),
-    created_at: z.string(),
+    created_at: z.string().describe(
+      "Time of the request, since opportunities are computed per call.",
+    ),
     description: z.string(),
-    execution_prompt: z.string().describe(
-      "Paste-ready instructions for an AI agent to address this opportunity.",
+    execution_prompt: z.string(),
+    id: z.string().describe(
+      "Stable across requests and windows for the same finding. There is no retrieve endpoint.",
+    ),
+    impact_score: z.number().describe(
+      "Out of 100. Recomputed per window, so the same `id` can score differently across windows.",
     ),
-    id: z.string(),
-    impact_score: z.number(),
     priority: z.string(),
     title: z.string(),
-    type: z.string(),
+    type: z.string().describe(
+      "Determines which undeclared extra fields the object carries, such as `winner_brand_name` on `almost_winning`.",
+    ),
   }).catchall(z.any()),
   "AdditionalProperties",
   true,

package/src/models/publicpromptplatform.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 325907ca7795
  */
 
 import * as z from "zod";

package/src/models/publicprompttag.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 66a9e6e2b4f9
  */
 
 import * as z from "zod";

package/src/models/publicprompttopic.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: b8fde377a401
  */
 
 import * as z from "zod";

package/src/models/publicpromptvisibilitydaterange.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: f6898e0edae4
  */
 
 import * as z from "zod";
@@ -14,12 +15,8 @@ export type PublicPromptVisibilityDateRange = {
 export const PublicPromptVisibilityDateRange$zodSchema: z.ZodType<
   PublicPromptVisibilityDateRange
 > = z.object({
-  active_prompts_only: z.boolean().default(true).describe(
-    "Whether only currently active prompts were included.",
-  ),
-  end_date: z.string().describe("End date used for the calculation."),
-  latest_run_date: z.string().nullable().optional().describe(
-    "Latest prompt-run date included in the calculation.",
-  ),
-  start_date: z.string().describe("Start date used for the calculation."),
+  active_prompts_only: z.boolean().default(true),
+  end_date: z.string(),
+  latest_run_date: z.string().nullable().optional(),
+  start_date: z.string(),
 });

package/src/models/publicpromptvisibilitymetrics.ts

@@ -1,5 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 56045e82d361
  */
 
 import * as z from "zod";
@@ -17,21 +18,17 @@ export const PublicPromptVisibilityMetrics$zodSchema: z.ZodType<
   PublicPromptVisibilityMetrics
 > = z.object({
   average_position: z.number().nullable().optional().describe(
-    "Average mention position aggregated over the date range.",
-  ),
-  citation_count: z.int().default(0).describe(
-    "Owned-domain citations found in prompt runs for the date range.",
+    "Mean mention position in AI responses; 1 is first and lower is better. 0 when runs produced no mentions.",
   ),
+  citation_count: z.int().default(0).describe("Owned-domain citations only."),
   run_count: z.int().default(0).describe(
-    "Prompt runs included in the date-range calculation.",
+    "One per prompt, platform, and run date.",
   ),
   share_of_voice: z.number().nullable().optional().describe(
-    "Share of voice aggregated over the date range, from 0 to 1.",
+    "Share of all brand mentions across tracked companies, 0 to 1.",
   ),
   visibility_score: z.number().nullable().optional().describe(
-    "Visibility score aggregated over the date range, from 0 to 1.",
-  ),
-  visibility_score_rank: z.int().nullable().optional().describe(
-    "Rank by visibility score among tracked companies.",
+    "The visibility score, from 0 to 1.",
   ),
+  visibility_score_rank: z.int().nullable().optional(),
 });