@lightsage/mcp 0.4.17 → 0.4.19

package/src/mcp-server/tools/promptsRunCancel.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 0560657e0c9b
+ */
+
+import { promptsRunCancel } from "../../funcs/promptsRunCancel.js";
+import { V2PromptRunsCancelRequest$zodSchema } from "../../models/v2promptrunscancelop.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: V2PromptRunsCancelRequest$zodSchema,
+};
+
+export const tool$promptsRunCancel: ToolDefinition<typeof args> = {
+  name: "prompts-run-cancel",
+  description: `Cancel a prompt run
+
+Marks an active prompt run as cancelled and prevents queued prompts from starting. Running coding-agent attempts are stopped asynchronously. Requests already sent to an answer platform cannot be recalled, so prompts already in progress may still finish and store their results, but the run stays cancelled. Prompts that never start use no usage-based credits. The response has the same shape as the status operation, with cancelled prompts counted in \`progress.cancelled\`. Repeating this request for an already-cancelled run is safe.`,
+  annotations: {
+    "title": "",
+    "destructiveHint": false,
+    "idempotentHint": false,
+    "openWorldHint": false,
+    "readOnlyHint": false,
+  },
+  args,
+  tool: async (client, args, ctx) => {
+    const [result] = await promptsRunCancel(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    return formatResult(result.value);
+  },
+};

package/src/mcp-server/tools/promptsTargetsList.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: ea463f944d6c
+ */
+
+import { promptsTargetsList } from "../../funcs/promptsTargetsList.js";
+import { V2PromptTargetsListRequest$zodSchema } from "../../models/v2prompttargetslistop.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: V2PromptTargetsListRequest$zodSchema.optional(),
+};
+
+export const tool$promptsTargetsList: ToolDefinition<typeof args> = {
+  name: "prompts-targets-list",
+  description: `List Targets
+
+Returns the answer engines and coding agents that run the organization's prompts on schedule, with each target's topic and frequency. Provide \`topic_id\` to list one topic's targets.`,
+  annotations: {
+    "title": "",
+    "destructiveHint": false,
+    "idempotentHint": false,
+    "openWorldHint": false,
+    "readOnlyHint": true,
+  },
+  args,
+  tool: async (client, args, ctx) => {
+    const [result] = await promptsTargetsList(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    return formatResult(result.value);
+  },
+};

package/src/mcp-server/tools/promptsTargetsSet.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: f1ffd3b02650
+ */
+
+import { promptsTargetsSet } from "../../funcs/promptsTargetsSet.js";
+import { SetV2PromptTargetsRequest$zodSchema } from "../../models/setv2prompttargetsrequest.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: SetV2PromptTargetsRequest$zodSchema,
+};
+
+export const tool$promptsTargetsSet: ToolDefinition<typeof args> = {
+  name: "prompts-targets-set",
+  description: `Set Targets
+
+Sets which answer engines and coding agents run a topic's prompts on schedule, the same way the prompt editor does. The list replaces the topic's targets: targets you leave out stop running. Every prompt in the topic is set to exactly these platforms; you can still narrow one prompt afterwards with \`platform_ids\`. Name coding agents with IDs from \`GET /v2/agents\`, and list a harness more than once to run it on several models. To pick agents for a single run without changing the schedule, pass \`agent\` to \`POST /v2/prompts/runs\` instead.`,
+  annotations: {
+    "title": "",
+    "destructiveHint": false,
+    "idempotentHint": false,
+    "openWorldHint": false,
+    "readOnlyHint": false,
+  },
+  args,
+  tool: async (client, args, ctx) => {
+    const [result] = await promptsTargetsSet(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    return formatResult(result.value);
+  },
+};

package/src/mcp-server/tools/visibilityCitationsList.ts

@@ -15,7 +15,7 @@ export const tool$visibilityCitationsList: ToolDefinition<typeof args> = {
   name: "visibility-citations-list",
   description: `List Top Cited Urls
 
-Returns URL-level citation counts ranked from most to least cited. Results can be filtered by platform and to owned or external sources.`,
+Returns URL-level citation counts ranked from most to least cited. Results can be filtered by platform and to owned or external sources. For totals by URL prefix, domain, or day compared with the previous period, use the citations summary.`,
   annotations: {
     "title": "",
     "destructiveHint": false,

package/src/mcp-server/tools/visibilityCitationsSummaryRetrieve.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 094c7750d43d
+ */
+
+import { visibilityCitationsSummaryRetrieve } from "../../funcs/visibilityCitationsSummaryRetrieve.js";
+import { V2VisibilityCitationsSummaryRetrieveRequest$zodSchema } from "../../models/v2visibilitycitationssummaryretrieveop.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: V2VisibilityCitationsSummaryRetrieveRequest$zodSchema.optional(),
+};
+
+export const tool$visibilityCitationsSummaryRetrieve: ToolDefinition<
+  typeof args
+> = {
+  name: "visibility-citations-summary-retrieve",
+  description: `Retrieve Citation Summary
+
+Returns citation totals grouped by URL prefix (domain and first path segment, such as \`example.com/blog\`), URL, domain, or day, each compared with the previous period, with per-run rates and run coverage. Filter to one section of a site with \`url_prefix\`, for example \`https://example.com/blog/\`. Aggregated in one call; use it instead of paging the citations list.`,
+  annotations: {
+    "title": "",
+    "destructiveHint": false,
+    "idempotentHint": false,
+    "openWorldHint": false,
+    "readOnlyHint": true,
+  },
+  args,
+  tool: async (client, args, ctx) => {
+    const [result] = await visibilityCitationsSummaryRetrieve(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    return formatResult(result.value);
+  },
+};

package/src/mcp-server/tools/visibilityCurrentRetrieve.ts

@@ -15,7 +15,7 @@ export const tool$visibilityCurrentRetrieve: ToolDefinition<typeof args> = {
   name: "visibility-current-retrieve",
   description: `Retrieve Current Visibility
 
-Returns recommendation score, visibility score, ranks, and date-range metadata for the configured primary company. Metrics are computed from active prompts only; when no data exists, values are \`null\`.`,
+Returns recommendation score, visibility score, ranks, and date-range metadata for the configured primary company, with the same metrics for the previous period, run coverage, and per-run rates. Metrics are computed from active prompts only; when no data exists, values are \`null\`. Pass \`period\` (for example \`last_30_days\` or \`2026Q4\`) instead of computing dates.`,
   annotations: {
     "title": "",
     "destructiveHint": false,

package/src/mcp-server/tools/visibilityOverviewRetrieve.ts

@@ -15,7 +15,7 @@ export const tool$visibilityOverviewRetrieve: ToolDefinition<typeof args> = {
   name: "visibility-overview-retrieve",
   description: `Retrieve Visibility Overview
 
-Returns aggregate snapshot, daily trends, per-platform breakdowns, and competitor comparison. Calculated from active prompts only.`,
+Returns aggregate snapshot, daily trends, per-platform breakdowns, and competitor comparison, with run coverage and per-run rates against the previous period. Calculated from active prompts only.`,
   annotations: {
     "title": "",
     "destructiveHint": false,

package/src/models/createv2promptrequest.ts

@@ -19,7 +19,7 @@ export type CreateV2PromptRequest = {
 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.",
+      "Platform IDs, as returned in `platforms` on `GET /v2/prompts`. Omit to attach none. To choose which coding-agent models a run uses, pass `agent` to `POST /v2/prompts/runs`.",
     ),
     run_settings: V2PromptRunSettingsInput$zodSchema.nullable().optional()
       .describe(

package/src/models/createv2promptrunrequest.ts

@@ -7,14 +7,18 @@ import * as z from "zod";
 
 export type CreateV2PromptRunRequest = {
   prompt_ids?: Array<string> | null | undefined;
+  agent?: Array<string> | null | undefined;
   force?: boolean | undefined;
 };
 
 export const CreateV2PromptRunRequest$zodSchema: z.ZodType<
   CreateV2PromptRunRequest
 > = z.object({
+  agent: z.array(z.string()).nullable().optional().describe(
+    "Runnable agents from `GET /v2/agents`, each a coding-agent harness and model such as `claude-code:claude-opus-5-5`. Every selected prompt runs once on each agent, so you can compare how several coding tools and models answer the same question. When set, this run uses only these agents instead of the organization's configured targets, including answer engines, and saves nothing. Omit it to use the configured targets; change those with `PUT /v2/prompts/targets`. CLI clients expose repeatable `--agent`.",
+  ),
   force: z.boolean().default(false).describe(
-    "Run even when a prompt already ran today on the configured platform and model.",
+    "Run even when a prompt already ran today on the same platform and model.",
   ),
   prompt_ids: z.array(z.string()).nullable().optional().describe(
     "Prompt IDs from `GET /v2/prompts`. Omit this field to run all active prompts.",

package/src/models/evaltemplateschedule.ts

@@ -9,7 +9,7 @@ import { ClosedEnum } from "../types/enums.js";
 /**
  * Schedule cadence used when `enabled` is true.
  */
-export const Frequency = {
+export const EvalTemplateScheduleFrequency = {
   Daily: "daily",
   EveryOtherDay: "every_other_day",
   Weekly: "weekly",
@@ -17,9 +17,11 @@ export const Frequency = {
 /**
  * Schedule cadence used when `enabled` is true.
  */
-export type Frequency = ClosedEnum<typeof Frequency>;
+export type EvalTemplateScheduleFrequency = ClosedEnum<
+  typeof EvalTemplateScheduleFrequency
+>;
 
-export const Frequency$zodSchema = z.enum([
+export const EvalTemplateScheduleFrequency$zodSchema = z.enum([
   "daily",
   "every_other_day",
   "weekly",
@@ -30,7 +32,7 @@ export const Frequency$zodSchema = z.enum([
  */
 export type EvalTemplateSchedule = {
   enabled?: boolean | undefined;
-  frequency?: Frequency | undefined;
+  frequency?: EvalTemplateScheduleFrequency | undefined;
 };
 
 export const EvalTemplateSchedule$zodSchema: z.ZodType<EvalTemplateSchedule> = z
@@ -38,7 +40,6 @@ export const EvalTemplateSchedule$zodSchema: z.ZodType<EvalTemplateSchedule> = z
     enabled: z.boolean().default(false).describe(
       "Whether each eval created from the template receives a schedule.",
     ),
-    frequency: Frequency$zodSchema.default("weekly").describe(
-      "Schedule cadence used when `enabled` is true.",
-    ),
+    frequency: EvalTemplateScheduleFrequency$zodSchema.default("weekly")
+      .describe("Schedule cadence used when `enabled` is true."),
   }).describe("Schedule copied into every eval created from the template.");

package/src/models/publicagentanalyticscountrylistresponse.ts

@@ -8,11 +8,16 @@ import {
   PublicAgentCountry,
   PublicAgentCountry$zodSchema,
 } from "./publicagentcountry.js";
+import {
+  PublicResolvedPeriod,
+  PublicResolvedPeriod$zodSchema,
+} from "./publicresolvedperiod.js";
 
 export type PublicAgentAnalyticsCountryListResponse = {
   site_id: string;
   start_date: string;
   end_date: string;
+  period?: PublicResolvedPeriod | null | undefined;
   countries?: Array<PublicAgentCountry> | undefined;
 };
 
@@ -23,6 +28,9 @@ export const PublicAgentAnalyticsCountryListResponse$zodSchema: z.ZodType<
     "Visits from coding agents and AI assistants per country, most visits first. The country is located from the IP address the request came from. For hosted assistants such as ChatGPT that is usually the provider's servers, not the person who asked; for coding agents it is usually the developer's machine.",
   ),
   end_date: z.string().date(),
+  period: PublicResolvedPeriod$zodSchema.nullable().optional().describe(
+    "The resolved period and the previous period it is compared with.",
+  ),
   site_id: z.string(),
   start_date: z.string().date(),
 });

package/src/models/publicagentanalyticserrorpagelistresponse.ts

@@ -8,11 +8,16 @@ import {
   PublicAgentErrorPage,
   PublicAgentErrorPage$zodSchema,
 } from "./publicagenterrorpage.js";
+import {
+  PublicResolvedPeriod,
+  PublicResolvedPeriod$zodSchema,
+} from "./publicresolvedperiod.js";
 
 export type PublicAgentAnalyticsErrorPageListResponse = {
   site_id: string;
   start_date: string;
   end_date: string;
+  period?: PublicResolvedPeriod | null | undefined;
   status_codes_tracked: boolean;
   pages?: Array<PublicAgentErrorPage> | undefined;
 };
@@ -24,6 +29,9 @@ export const PublicAgentAnalyticsErrorPageListResponse$zodSchema: z.ZodType<
   pages: z.array(PublicAgentErrorPage$zodSchema).optional().describe(
     "Most error requests first.",
   ),
+  period: PublicResolvedPeriod$zodSchema.nullable().optional().describe(
+    "The resolved period and the previous period it is compared with.",
+  ),
   site_id: z.string(),
   start_date: z.string().date(),
   status_codes_tracked: z.boolean().describe(

package/src/models/publicagentanalyticspagelistresponse.ts

@@ -8,11 +8,16 @@ import {
   PublicAgentTrafficPage,
   PublicAgentTrafficPage$zodSchema,
 } from "./publicagenttrafficpage.js";
+import {
+  PublicResolvedPeriod,
+  PublicResolvedPeriod$zodSchema,
+} from "./publicresolvedperiod.js";
 
 export type PublicAgentAnalyticsPageListResponse = {
   site_id: string;
   start_date: string;
   end_date: string;
+  period?: PublicResolvedPeriod | null | undefined;
   agent?: string | null | undefined;
   pages?: Array<PublicAgentTrafficPage> | undefined;
 };
@@ -25,6 +30,9 @@ export const PublicAgentAnalyticsPageListResponse$zodSchema: z.ZodType<
   ),
   end_date: z.string().date(),
   pages: z.array(PublicAgentTrafficPage$zodSchema).optional(),
+  period: PublicResolvedPeriod$zodSchema.nullable().optional().describe(
+    "The resolved period and the previous period it is compared with.",
+  ),
   site_id: z.string(),
   start_date: z.string().date(),
 });

package/src/models/publicagentanalyticssourcelistresponse.ts

@@ -8,11 +8,16 @@ import {
   PublicAgentTrafficSource,
   PublicAgentTrafficSource$zodSchema,
 } from "./publicagenttrafficsource.js";
+import {
+  PublicResolvedPeriod,
+  PublicResolvedPeriod$zodSchema,
+} from "./publicresolvedperiod.js";
 
 export type PublicAgentAnalyticsSourceListResponse = {
   site_id: string;
   start_date: string;
   end_date: string;
+  period?: PublicResolvedPeriod | null | undefined;
   sources?: Array<PublicAgentTrafficSource> | undefined;
 };
 
@@ -20,6 +25,9 @@ export const PublicAgentAnalyticsSourceListResponse$zodSchema: z.ZodType<
   PublicAgentAnalyticsSourceListResponse
 > = z.object({
   end_date: z.string().date(),
+  period: PublicResolvedPeriod$zodSchema.nullable().optional().describe(
+    "The resolved period and the previous period it is compared with.",
+  ),
   site_id: z.string(),
   sources: z.array(PublicAgentTrafficSource$zodSchema).optional().describe(
     "Most visits first.",

package/src/models/publicagentanalyticssummary.ts

@@ -8,11 +8,16 @@ import {
   PublicAgentTrafficTotals,
   PublicAgentTrafficTotals$zodSchema,
 } from "./publicagenttraffictotals.js";
+import {
+  PublicResolvedPeriod,
+  PublicResolvedPeriod$zodSchema,
+} from "./publicresolvedperiod.js";
 
 export type PublicAgentAnalyticsSummary = {
   site_id: string;
   start_date: string;
   end_date: string;
+  period?: PublicResolvedPeriod | null | undefined;
   current: PublicAgentTrafficTotals;
   previous: PublicAgentTrafficTotals;
 };
@@ -22,6 +27,9 @@ export const PublicAgentAnalyticsSummary$zodSchema: z.ZodType<
 > = z.object({
   current: PublicAgentTrafficTotals$zodSchema,
   end_date: z.string().date(),
+  period: PublicResolvedPeriod$zodSchema.nullable().optional().describe(
+    "The resolved period and the previous period it is compared with.",
+  ),
   previous: PublicAgentTrafficTotals$zodSchema,
   site_id: z.string(),
   start_date: z.string().date(),

package/src/models/publiccitationsummarygroup.ts

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 5da2b8693555
+ */
+
+import * as z from "zod";
+
+export type PublicCitationSummaryGroup = {
+  key: string;
+  url?: string | null | undefined;
+  title?: string | null | undefined;
+  is_company_link: boolean;
+  citation_count: number;
+  previous_citation_count: number;
+  change?: number | null | undefined;
+  citations_per_run?: number | null | undefined;
+  previous_citations_per_run?: number | null | undefined;
+  per_run_change?: number | null | undefined;
+  prompt_count: number;
+  url_count: number;
+};
+
+export const PublicCitationSummaryGroup$zodSchema: z.ZodType<
+  PublicCitationSummaryGroup
+> = z.object({
+  change: z.number().nullable().optional().describe(
+    "Relative change in citations; 0.25 means 25% higher.",
+  ),
+  citation_count: z.int().describe("Citations in the period."),
+  citations_per_run: z.number().nullable().optional(),
+  is_company_link: z.boolean().describe(
+    "Whether the group includes an owned company domain.",
+  ),
+  key: z.string().describe(
+    "The group: a URL prefix (domain and first path segment, such as `example.com/blog`), a normalized URL, a domain, or a day (YYYY-MM-DD).",
+  ),
+  per_run_change: z.number().nullable().optional().describe(
+    "Relative change in citations per run.",
+  ),
+  previous_citation_count: z.int().describe(
+    "Citations in the previous period. For `day` groups, the matching day of the previous period.",
+  ),
+  previous_citations_per_run: z.number().nullable().optional(),
+  prompt_count: z.int().describe(
+    "Distinct active prompts that cited the group in the period.",
+  ),
+  title: z.string().nullable().optional().describe(
+    "Page title, for `url` groups.",
+  ),
+  url: z.string().nullable().optional().describe(
+    "Most frequently observed variant of the URL, for `url` groups.",
+  ),
+  url_count: z.int().describe("Distinct URLs in the group in the period."),
+});

package/src/models/publiccitationsummaryresponse.ts

@@ -0,0 +1,110 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 0db6ff4a9411
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../types/enums.js";
+import {
+  PublicCitationSummaryGroup,
+  PublicCitationSummaryGroup$zodSchema,
+} from "./publiccitationsummarygroup.js";
+import {
+  PublicCitationSummaryTotals,
+  PublicCitationSummaryTotals$zodSchema,
+} from "./publiccitationsummarytotals.js";
+import { PublicCoverage, PublicCoverage$zodSchema } from "./publiccoverage.js";
+import {
+  PublicResolvedPeriod,
+  PublicResolvedPeriod$zodSchema,
+} from "./publicresolvedperiod.js";
+
+export const GroupBy = {
+  UrlPrefix: "url_prefix",
+  Url: "url",
+  Domain: "domain",
+  Day: "day",
+} as const;
+export type GroupBy = ClosedEnum<typeof GroupBy>;
+
+export const GroupBy$zodSchema = z.enum([
+  "url_prefix",
+  "url",
+  "domain",
+  "day",
+]);
+
+export const PublicCitationSummaryResponseSourceType = {
+  All: "all",
+  Owned: "owned",
+  External: "external",
+} as const;
+export type PublicCitationSummaryResponseSourceType = ClosedEnum<
+  typeof PublicCitationSummaryResponseSourceType
+>;
+
+export const PublicCitationSummaryResponseSourceType$zodSchema = z.enum([
+  "all",
+  "owned",
+  "external",
+]);
+
+/**
+ * The number to lead with: citation counts when the periods are comparable, otherwise citations per run.
+ */
+export const PublicCitationSummaryResponseHeadlineMetric = {
+  CitationCount: "citation_count",
+  CitationsPerRun: "citations_per_run",
+} as const;
+/**
+ * The number to lead with: citation counts when the periods are comparable, otherwise citations per run.
+ */
+export type PublicCitationSummaryResponseHeadlineMetric = ClosedEnum<
+  typeof PublicCitationSummaryResponseHeadlineMetric
+>;
+
+export const PublicCitationSummaryResponseHeadlineMetric$zodSchema = z.enum([
+  "citation_count",
+  "citations_per_run",
+]).describe(
+  "The number to lead with: citation counts when the periods are comparable, otherwise citations per run.",
+);
+
+export type PublicCitationSummaryResponse = {
+  period: PublicResolvedPeriod;
+  group_by: GroupBy;
+  url_prefix?: string | null | undefined;
+  source_type: PublicCitationSummaryResponseSourceType;
+  platform?: string | null | undefined;
+  headline_metric: PublicCitationSummaryResponseHeadlineMetric;
+  totals: PublicCitationSummaryTotals;
+  has_data: boolean;
+  group_count: number;
+  count: number;
+  groups?: Array<PublicCitationSummaryGroup> | undefined;
+  coverage: PublicCoverage;
+};
+
+export const PublicCitationSummaryResponse$zodSchema: z.ZodType<
+  PublicCitationSummaryResponse
+> = z.object({
+  count: z.int().describe("Groups returned."),
+  coverage: PublicCoverage$zodSchema,
+  group_by: GroupBy$zodSchema,
+  group_count: z.int().describe("Groups matching the filters, before `limit`."),
+  groups: z.array(PublicCitationSummaryGroup$zodSchema).optional().describe(
+    "Groups by citation count, most first; `day` groups are in date order.",
+  ),
+  has_data: z.boolean(),
+  headline_metric: PublicCitationSummaryResponseHeadlineMetric$zodSchema
+    .describe(
+      "The number to lead with: citation counts when the periods are comparable, otherwise citations per run.",
+    ),
+  period: PublicResolvedPeriod$zodSchema,
+  platform: z.string().nullable().optional(),
+  source_type: PublicCitationSummaryResponseSourceType$zodSchema,
+  totals: PublicCitationSummaryTotals$zodSchema,
+  url_prefix: z.string().nullable().optional().describe(
+    "URL prefix filter applied, if any.",
+  ),
+});

package/src/models/publiccitationsummarytotals.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 10a1503650d5
+ */
+
+import * as z from "zod";
+
+export type PublicCitationSummaryTotals = {
+  citation_count: number;
+  previous_citation_count: number;
+  change?: number | null | undefined;
+  run_count: number;
+  previous_run_count: number;
+  citations_per_run?: number | null | undefined;
+  previous_citations_per_run?: number | null | undefined;
+  per_run_change?: number | null | undefined;
+  url_count: number;
+};
+
+export const PublicCitationSummaryTotals$zodSchema: z.ZodType<
+  PublicCitationSummaryTotals
+> = z.object({
+  change: z.number().nullable().optional().describe(
+    "Relative change in citations; 0.25 means 25% higher.",
+  ),
+  citation_count: z.int(),
+  citations_per_run: z.number().nullable().optional(),
+  per_run_change: z.number().nullable().optional().describe(
+    "Relative change in citations per run.",
+  ),
+  previous_citation_count: z.int(),
+  previous_citations_per_run: z.number().nullable().optional(),
+  previous_run_count: z.int(),
+  run_count: z.int().describe(
+    "Successful runs of active prompts in the period, after the platform filter.",
+  ),
+  url_count: z.int().describe("Distinct cited URLs in the period."),
+});

package/src/models/publiccoverage.ts

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 4193289784d8
+ */
+
+import * as z from "zod";
+import {
+  PublicCoverageDay,
+  PublicCoverageDay$zodSchema,
+} from "./publiccoverageday.js";
+import {
+  PublicPeriodCoverage,
+  PublicPeriodCoverage$zodSchema,
+} from "./publicperiodcoverage.js";
+
+export type PublicCoverage = {
+  comparable: boolean;
+  notes?: Array<string> | undefined;
+  current: PublicPeriodCoverage;
+  previous: PublicPeriodCoverage;
+  days?: Array<PublicCoverageDay> | undefined;
+};
+
+export const PublicCoverage$zodSchema: z.ZodType<PublicCoverage> = z.object({
+  comparable: z.boolean().describe(
+    "Whether totals can be compared between the two periods. False when either period has a missing or short day or runs per day differ by more than 20%; compare per-run rates instead.",
+  ),
+  current: PublicPeriodCoverage$zodSchema,
+  days: z.array(PublicCoverageDay$zodSchema).optional(),
+  notes: z.array(z.string()).optional().describe(
+    "Why the periods are not comparable, in plain sentences.",
+  ),
+  previous: PublicPeriodCoverage$zodSchema,
+});