@elmohq/sdk 0.0.0-stage → 0.1.1

package/dist/tools-7Hs5J2xb.d.mts

@@ -0,0 +1,1945 @@
+//#region src/types/shared/error.d.ts
+type Error = {
+  /**
+   * Stable machine-readable code. Deliberately not an enum: new values are added without a version
+   * bump, so treat an unrecognized one as its HTTP status implies. Currently: `unauthorized`,
+   * `insufficient_scope`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`,
+   * `method_not_allowed`, `read_only`, `no_active_plan`, `brand_limit`, `prompt_limit`,
+   * `model_not_in_plan`, `model_picks_exceeded`, `premium_not_in_plan`, `premium_pool_exhausted`,
+   * `cadence_faster_than_plan`, `internal_error`.
+   */
+  code?: string;
+  /** Error type */
+  error: string;
+  /** Detailed error message */
+  message?: string;
+};
+/** Authentication required */
+type UnauthorizedError = Error;
+type InternalServerError = Error;
+/**
+ * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+ * read-only (demo) mode.
+ */
+type ForbiddenError = Error;
+/** Per-key rate limit exceeded. */
+type RateLimitError = Error;
+//#endregion
+//#region src/types/shared/model-filter.d.ts
+/**
+ * Inclusive lower bound of the window, an ISO 8601 timestamp such as `2026-01-01T00:00:00Z`. A bare
+ * `YYYY-MM-DD` is rejected: that is `/prompts/{promptId}/snapshot`'s spelling and means a local
+ * calendar day there.
+ */
+type WindowStart = Date;
+/**
+ * Exclusive upper bound of the window, an ISO 8601 timestamp. The window is half-open: a run at
+ * exactly `end` is outside it.
+ */
+type WindowEnd = Date;
+/** Restrict to one model, e.g. `chatgpt`. See `models.list()`. */
+type ModelFilter = string;
+//#endregion
+//#region src/types/shared/not-found-error.d.ts
+/** Resource not found */
+type NotFoundError = Error;
+//#endregion
+//#region src/types/shared/validation-error.d.ts
+/** Invalid request data */
+type ValidationError = Error;
+//#endregion
+//#region src/types/analytics.d.ts
+/**
+ * The window the response was computed over, echoed back as the half-open instants it resolved to.
+ */
+type DateRange = {
+  /** Exclusive upper bound, in UTC. */
+  end: Date;
+  /** Inclusive lower bound, in UTC. */
+  start: Date;
+};
+type VisibilityPoint = {
+  date: string;
+  /**
+   * Null on days with no runs to plot; the series is not gap-filled with zeros. Ratio 0–1; multiply
+   * by 100 for a percentage.
+   *
+   * @minimum 0
+   * @maximum 1
+   */
+  visibility: number | null;
+};
+type ShareOfVoiceEntry = {
+  /** True for the tracked brand's own row. */
+  isBrand: boolean;
+  mentions: number;
+  /** Brand or competitor name. */
+  name: string;
+  /** Distinct prompts this entity appeared in. */
+  prompts: number;
+  /**
+   * This entity's share of all brand and competitor mentions. Ratio 0–1; multiply by 100 for a
+   * percentage.
+   *
+   * @minimum 0
+   * @maximum 1
+   */
+  share: number;
+};
+type ShareOfVoicePoint = {
+  date: string;
+  /**
+   * The brand's share on this day. Null on days with no runs. Ratio 0–1; multiply by 100 for a
+   * percentage.
+   *
+   * @minimum 0
+   * @maximum 1
+   */
+  share: number | null;
+};
+type CitationDomain = {
+  /** Which side of the citation landscape the domain sits on. */
+  category: 'brand' | 'competitor' | 'editorial' | 'reviews' | 'ecommerce' | 'social' | 'developer' | 'pr' | 'reference' | 'institutional' | 'other';
+  /**
+   * How this window compares with the equal-length window before it, as a multiplier of the
+   * previous count: 2 means twice as many citations, 0.5 means half, 1 means unchanged. Not a
+   * percentage change — 1.5 is "1.5x", which is a 50% increase. Null when the domain had no
+   * citations in the previous window, so there is nothing to divide by.
+   *
+   * @minimum 0
+   */
+  changeFactor: number | null;
+  /** Citations to this domain in the window. */
+  count: number;
+  domain: string;
+  /** Citations in the equal-length window immediately before this one. */
+  previousCount: number;
+  /** Distinct prompts whose answers cited this domain. */
+  promptCount: number;
+  /**
+   * Share of all citations in the window. Ratio 0–1; multiply by 100 for a percentage.
+   *
+   * @minimum 0
+   * @maximum 1
+   */
+  share: number;
+};
+type CitationDomainList = {
+  brandId: string;
+  /** Every domain cited over the window, ordered by citation count. */
+  data: Array<CitationDomain>;
+  range: DateRange;
+  totals: {
+    citations: number;
+    uniqueDomains: number;
+    uniqueUrls: number;
+  };
+};
+type CitationURL = {
+  /** Which side of the citation landscape the domain sits on. */
+  category: 'brand' | 'competitor' | 'editorial' | 'reviews' | 'ecommerce' | 'social' | 'developer' | 'pr' | 'reference' | 'institutional' | 'other';
+  count: number;
+  domain: string;
+  /** Not cited in the equal-length window immediately before this one. */
+  isNew: boolean;
+  /** What kind of page was cited. */
+  pageType: 'homepage' | 'article' | 'listicle' | 'howto' | 'comparison' | 'review' | 'forum' | 'video' | 'doc' | 'product' | 'info' | 'search' | 'shopping' | 'other';
+  promptCount: number;
+  title: string | null;
+  url: string;
+};
+type CitationURLList = {
+  brandId: string;
+  /** Every URL cited over the window, ordered by citation count. */
+  data: Array<CitationURL>;
+  range: DateRange;
+  totals: {
+    citations: number;
+    uniqueDomains: number;
+    uniqueUrls: number;
+  };
+};
+type FanoutQuery = {
+  promptCount: number;
+  /** A search the engine ran while answering. */
+  query: string;
+  runs: number;
+};
+type BrandQueryFanout = {
+  avgQueriesPerRun: number;
+  brandId: string;
+  /**
+   * Share of fan-out query instances whose answer mentioned the brand. Ratio 0–1; multiply by 100
+   * for a percentage.
+   *
+   * @minimum 0
+   * @maximum 1
+   */
+  coverageRate: number;
+  /** Every distinct sub-query over the window, ordered by the runs that ran it. */
+  data: Array<FanoutQuery>;
+  /**
+   * Runs that searched at all. Engines that don't expose their searches contribute runs but no
+   * queries.
+   */
+  fanoutRuns: number;
+  range: DateRange;
+  totalQueries: number;
+  totalRuns: number;
+  uniqueQueries: number;
+};
+type PromptPerformance = {
+  /**
+   * Share of this prompt's runs mentioning the brand. Ratio 0–1; multiply by 100 for a percentage.
+   *
+   * @minimum 0
+   * @maximum 1
+   */
+  brandMentionRate: number;
+  /**
+   * Share of this prompt's runs mentioning any tracked competitor. Ratio 0–1; multiply by 100 for a
+   * percentage.
+   *
+   * @minimum 0
+   * @maximum 1
+   */
+  competitorMentionRate: number;
+  firstEvaluatedAt: Date | null;
+  lastRunAt: Date | null;
+  promptId: string;
+  tags: Array<string>;
+  totalRuns: number;
+  value: string;
+};
+type PromptPerformanceList = {
+  brandId: string;
+  /** Every prompt sampled over the window, with its results. */
+  data: Array<PromptPerformance>;
+  range: DateRange;
+};
+type ModelVisibility = {
+  brandMentions: number;
+  citations: number;
+  label: string;
+  model: string;
+  runs: number;
+  /**
+   * Share of this model's runs that mentioned the brand. Ratio 0–1; multiply by 100 for a
+   * percentage.
+   *
+   * @minimum 0
+   * @maximum 1
+   */
+  visibility: number | null;
+};
+/**
+ * Every non-paginated figure for a brand over one window. There is no parameter for selecting a
+ * subset: the four computations behind this share one scope resolution and run concurrently, so a
+ * subset would save a caller a fraction of one request and cost everyone a parameter to reason
+ * about.
+ */
+type BrandAnalytics = {
+  brandId: string;
+  brandName: string;
+  /** Per-model visibility and run counts. Only models that produced a run in the window appear. */
+  models: Array<ModelVisibility>;
+  range: DateRange;
+  /** The brand against its tracked competitors. */
+  shareOfVoice: {
+    /**
+     * The brand's own share at the end of the window. Ratio 0–1; multiply by 100 for a percentage.
+     *
+     * @minimum 0
+     * @maximum 1
+     */
+    brand: number | null;
+    /** Leaderboard, highest share first. */
+    entries: Array<ShareOfVoiceEntry>;
+    /** The brand's share over time. */
+    series: Array<ShareOfVoicePoint>;
+  };
+  totals: {
+    citations: number;
+    /** Enabled prompts counted in the window. */
+    prompts: number;
+    runs: number;
+    uniqueDomains: number;
+    uniqueUrls: number;
+  };
+  /** How often the brand is mentioned at all. */
+  visibility: {
+    /**
+     * The last plotted point — the number the dashboard hero shows. Ratio 0–1; multiply by 100 for
+     * a percentage.
+     *
+     * @minimum 0
+     * @maximum 1
+     */
+    current: number | null;
+    series: Array<VisibilityPoint>;
+  };
+};
+/** Comma-separated prompt tags. Only prompts carrying at least one of them are counted. */
+type TagsFilter = string;
+type GetBrandAnalyticsErrors = {
+  /** Invalid request data */
+  400: ValidationError;
+  /** Authentication required */
+  401: UnauthorizedError;
+  /**
+   * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+   * read-only (demo) mode.
+   */
+  403: ForbiddenError;
+  /** Resource not found */
+  404: NotFoundError;
+  /** Per-key rate limit exceeded. */
+  429: RateLimitError;
+  /** Internal server error */
+  500: InternalServerError;
+};
+type GetBrandAnalyticsResponses = {
+  /** Get a brand's analytics */
+  200: BrandAnalytics;
+};
+type ListBrandCitationDomainsErrors = {
+  /** Invalid request data */
+  400: ValidationError;
+  /** Authentication required */
+  401: UnauthorizedError;
+  /**
+   * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+   * read-only (demo) mode.
+   */
+  403: ForbiddenError;
+  /** Resource not found */
+  404: NotFoundError;
+  /** Per-key rate limit exceeded. */
+  429: RateLimitError;
+  /** Internal server error */
+  500: InternalServerError;
+};
+type ListBrandCitationDomainsResponses = {
+  /** List cited domains */
+  200: CitationDomainList;
+};
+type ListBrandCitationURLsErrors = {
+  /** Invalid request data */
+  400: ValidationError;
+  /** Authentication required */
+  401: UnauthorizedError;
+  /**
+   * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+   * read-only (demo) mode.
+   */
+  403: ForbiddenError;
+  /** Resource not found */
+  404: NotFoundError;
+  /** Per-key rate limit exceeded. */
+  429: RateLimitError;
+  /** Internal server error */
+  500: InternalServerError;
+};
+type ListBrandCitationURLsResponses = {
+  /** List cited URLs */
+  200: CitationURLList;
+};
+type ListBrandPromptPerformanceErrors = {
+  /** Invalid request data */
+  400: ValidationError;
+  /** Authentication required */
+  401: UnauthorizedError;
+  /**
+   * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+   * read-only (demo) mode.
+   */
+  403: ForbiddenError;
+  /** Resource not found */
+  404: NotFoundError;
+  /** Per-key rate limit exceeded. */
+  429: RateLimitError;
+  /** Internal server error */
+  500: InternalServerError;
+};
+type ListBrandPromptPerformanceResponses = {
+  /** List prompt performance */
+  200: PromptPerformanceList;
+};
+type GetBrandQueryFanoutErrors = {
+  /** Invalid request data */
+  400: ValidationError;
+  /** Authentication required */
+  401: UnauthorizedError;
+  /**
+   * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+   * read-only (demo) mode.
+   */
+  403: ForbiddenError;
+  /** Resource not found */
+  404: NotFoundError;
+  /** Per-key rate limit exceeded. */
+  429: RateLimitError;
+  /** Internal server error */
+  500: InternalServerError;
+};
+type GetBrandQueryFanoutResponses = {
+  /** Get query fan-out */
+  200: BrandQueryFanout;
+};
+type GetBrandAnalyticsParams = {
+  /**
+   * Inclusive lower bound of the window, an ISO 8601 timestamp such as `2026-01-01T00:00:00Z`. A
+   * bare `YYYY-MM-DD` is rejected: that is `/prompts/{promptId}/snapshot`'s spelling and means a
+   * local calendar day there.
+   */
+  start: WindowStart;
+  /**
+   * Exclusive upper bound of the window, an ISO 8601 timestamp. The window is half-open: a run at
+   * exactly `end` is outside it.
+   */
+  end: WindowEnd;
+  /** Restrict to one model, e.g. `chatgpt`. See `models.list()`. */
+  model?: ModelFilter;
+  /** Comma-separated prompt tags. Only prompts carrying at least one of them are counted. */
+  tags?: TagsFilter;
+};
+type ListBrandCitationDomainsParams = {
+  /**
+   * Inclusive lower bound of the window, an ISO 8601 timestamp such as `2026-01-01T00:00:00Z`. A
+   * bare `YYYY-MM-DD` is rejected: that is `/prompts/{promptId}/snapshot`'s spelling and means a
+   * local calendar day there.
+   */
+  start: WindowStart;
+  /**
+   * Exclusive upper bound of the window, an ISO 8601 timestamp. The window is half-open: a run at
+   * exactly `end` is outside it.
+   */
+  end: WindowEnd;
+  /** Restrict to one model, e.g. `chatgpt`. See `models.list()`. */
+  model?: ModelFilter;
+  /** Comma-separated prompt tags. Only prompts carrying at least one of them are counted. */
+  tags?: TagsFilter;
+};
+type ListBrandCitationURLsParams = {
+  /**
+   * Inclusive lower bound of the window, an ISO 8601 timestamp such as `2026-01-01T00:00:00Z`. A
+   * bare `YYYY-MM-DD` is rejected: that is `/prompts/{promptId}/snapshot`'s spelling and means a
+   * local calendar day there.
+   */
+  start: WindowStart;
+  /**
+   * Exclusive upper bound of the window, an ISO 8601 timestamp. The window is half-open: a run at
+   * exactly `end` is outside it.
+   */
+  end: WindowEnd;
+  /** Restrict to one model, e.g. `chatgpt`. See `models.list()`. */
+  model?: ModelFilter;
+  /** Comma-separated prompt tags. Only prompts carrying at least one of them are counted. */
+  tags?: TagsFilter;
+};
+type ListBrandPromptPerformanceParams = {
+  /**
+   * Inclusive lower bound of the window, an ISO 8601 timestamp such as `2026-01-01T00:00:00Z`. A
+   * bare `YYYY-MM-DD` is rejected: that is `/prompts/{promptId}/snapshot`'s spelling and means a
+   * local calendar day there.
+   */
+  start: WindowStart;
+  /**
+   * Exclusive upper bound of the window, an ISO 8601 timestamp. The window is half-open: a run at
+   * exactly `end` is outside it.
+   */
+  end: WindowEnd;
+  /** Restrict to one model, e.g. `chatgpt`. See `models.list()`. */
+  model?: ModelFilter;
+  /** Comma-separated prompt tags. Only prompts carrying at least one of them are counted. */
+  tags?: TagsFilter;
+};
+type GetBrandQueryFanoutParams = {
+  /**
+   * Inclusive lower bound of the window, an ISO 8601 timestamp such as `2026-01-01T00:00:00Z`. A
+   * bare `YYYY-MM-DD` is rejected: that is `/prompts/{promptId}/snapshot`'s spelling and means a
+   * local calendar day there.
+   */
+  start: WindowStart;
+  /**
+   * Exclusive upper bound of the window, an ISO 8601 timestamp. The window is half-open: a run at
+   * exactly `end` is outside it.
+   */
+  end: WindowEnd;
+  /** Restrict to one model, e.g. `chatgpt`. See `models.list()`. */
+  model?: ModelFilter;
+  /** Comma-separated prompt tags. Only prompts carrying at least one of them are counted. */
+  tags?: TagsFilter;
+};
+//#endregion
+//#region src/types/shared/brand-id-path.d.ts
+/** Brand identifier. */
+type BrandIdPath = string;
+//#endregion
+//#region src/types/opportunities.d.ts
+type OpportunityPrompt = {
+  /** The tracked prompt it resolved to, or null when it didn't match one. */
+  promptId: string | null;
+  /** The prompt as the report names it. */
+  text: string;
+};
+type CitedPage = {
+  domain: string;
+  title: string | null;
+  url: string;
+};
+type Opportunity = {
+  /**
+   * Which workstream this belongs to: `creation` is net-new content, `existing-content` is a page
+   * that could win the mention with a refresh, `outreach` is earning a placement on a third-party
+   * site assistants cite, `social` is the community conversations they pull from.
+   */
+  category: 'creation' | 'existing-content' | 'outreach' | 'social';
+  /** Pages on competitor domains cited for those prompts. */
+  competitorCitations: Array<CitedPage>;
+  /** Tracked prompts this would help. May be empty. */
+  relatedPrompts: Array<OpportunityPrompt>;
+  /** Short and action-oriented — the concrete surface or angle. */
+  title: string;
+  /** Why it is worth doing, in plain language. */
+  why: string;
+  /** Pages on the brand's own domains already cited for those prompts. */
+  yourCitations: Array<CitedPage>;
+};
+/**
+ * The brand's latest Opportunities report — the same LLM-generated analysis the dashboard shows,
+ * read from the append-only history rather than regenerated. Elmo decides when to produce a new
+ * one; there is no way to trigger generation over the API, because it spends provider budget with
+ * no per-call metering behind it.
+ */
+type BrandOpportunities = {
+  brandId: string;
+  generatedAt: Date | null;
+  /** The model that produced the report, when recorded. */
+  model: string | null;
+  /** Prioritized, highest impact first. */
+  opportunities: Array<Opportunity>;
+  /** Caveats: hard-to-win areas, or tactics to avoid. */
+  risks: Array<string>;
+  /**
+   * `ready` when a report is present. `insufficient-data` when the brand hasn't accumulated enough
+   * tracked answers to say anything useful yet, in which case the lists are empty.
+   */
+  status: 'ready' | 'insufficient-data';
+  /** A few bullets on where the brand stands and the through-line of the plan. */
+  summary: Array<string>;
+};
+type GetBrandOpportunitiesErrors = {
+  /** Authentication required */
+  401: UnauthorizedError;
+  /**
+   * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+   * read-only (demo) mode.
+   */
+  403: ForbiddenError;
+  /** Resource not found */
+  404: NotFoundError;
+  /** Per-key rate limit exceeded. */
+  429: RateLimitError;
+  /** Internal server error */
+  500: InternalServerError;
+};
+type GetBrandOpportunitiesResponses = {
+  /** Get the latest opportunities report */
+  200: BrandOpportunities;
+};
+//#endregion
+//#region src/types/tags.d.ts
+type Tag = {
+  /** The tag, normalized to lower case. */
+  name: string;
+  /** Prompts in this brand carrying the tag. */
+  promptCount: number;
+  /**
+   * True for `branded` and `unbranded`, which Elmo computes from the prompt text. A system tag
+   * always appears here; applying it to a prompt as a user tag overrides the computed
+   * classification rather than creating a new tag.
+   */
+  system: boolean;
+};
+type TagList = {
+  brandId: string;
+  /** System tags first, then user tags alphabetically — the order the dashboard's filter shows. */
+  data: Array<Tag>;
+};
+type ListBrandTagsErrors = {
+  /** Authentication required */
+  401: UnauthorizedError;
+  /**
+   * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+   * read-only (demo) mode.
+   */
+  403: ForbiddenError;
+  /** Resource not found */
+  404: NotFoundError;
+  /** Per-key rate limit exceeded. */
+  429: RateLimitError;
+  /** Internal server error */
+  500: InternalServerError;
+};
+type ListBrandTagsResponses = {
+  /** List a brand's tags */
+  200: TagList;
+};
+//#endregion
+//#region src/types/shared/conflict-error.d.ts
+/** Resource already exists */
+type ConflictError = Error;
+/** The organization has no active subscription. Cloud deployments only. */
+type PaymentRequiredError = Error;
+//#endregion
+//#region src/types/shared/limit.d.ts
+/**
+ * Items per page. Values above the maximum are clamped, not rejected.
+ *
+ * @default 20
+ * @minimum 1
+ * @maximum 100
+ */
+type Limit = number;
+//#endregion
+//#region src/types/shared/page.d.ts
+/**
+ * Page number, 1-based.
+ *
+ * @default 1
+ * @minimum 1
+ */
+type Page = number;
+//#endregion
+//#region src/types/shared/pagination.d.ts
+type Pagination = {
+  limit: number;
+  page: number;
+  /** Total items matching the request. */
+  total: number;
+  totalPages: number;
+};
+//#endregion
+//#region src/types/brands.d.ts
+type Brand = {
+  aliases: Array<string>;
+  createdAt: Date;
+  /** Sampling cadence override in hours. Null means the plan cadence. */
+  delayOverrideHours: number | null;
+  /**
+   * Brand domains. The first entry is the primary website; remaining entries are additional
+   * domains.
+   */
+  domains: Array<string>;
+  enabled: boolean;
+  /** Models this brand is tracked on. Null means the deployment default. */
+  enabledModels: Array<string> | null;
+  /** User-supplied brand identifier (e.g. "acme") */
+  id: string;
+  name: string;
+  onboarded: boolean;
+  /** The organization that owns this brand and is billed for it. */
+  organizationId: string;
+  updatedAt: Date;
+};
+type BrandsList = {
+  /**
+   * Deprecated: read `data` instead. Kept while the one known consumer migrates, and removed in a
+   * future release.
+   *
+   * @deprecated
+   */
+  brands: Array<Brand>;
+  /** The items on this page. Read this rather than the named key below. */
+  data: Array<Brand>;
+  pagination: Pagination;
+};
+type ListBrandsErrors = {
+  /** Authentication required */
+  401: UnauthorizedError;
+  /**
+   * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+   * read-only (demo) mode.
+   */
+  403: ForbiddenError;
+  /** Per-key rate limit exceeded. */
+  429: RateLimitError;
+  /** Internal server error */
+  500: InternalServerError;
+};
+type ListBrandsResponses = {
+  /** Paginated list of brands */
+  200: BrandsList;
+};
+type CreateBrandErrors = {
+  /** Invalid request data */
+  400: ValidationError;
+  /** Authentication required */
+  401: UnauthorizedError;
+  /** The organization has no active subscription. Cloud deployments only. */
+  402: PaymentRequiredError;
+  /**
+   * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+   * read-only (demo) mode.
+   */
+  403: ForbiddenError;
+  /** Resource not found */
+  404: NotFoundError;
+  /** Resource already exists */
+  409: ConflictError;
+  /** Per-key rate limit exceeded. */
+  429: RateLimitError;
+  /** Internal server error */
+  500: InternalServerError;
+};
+type CreateBrandResponses = {
+  /** Brand created */
+  201: Brand;
+};
+type GetBrandErrors = {
+  /** Authentication required */
+  401: UnauthorizedError;
+  /**
+   * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+   * read-only (demo) mode.
+   */
+  403: ForbiddenError;
+  /** Resource not found */
+  404: NotFoundError;
+  /** Per-key rate limit exceeded. */
+  429: RateLimitError;
+  /** Internal server error */
+  500: InternalServerError;
+};
+type GetBrandResponses = {
+  /** Brand */
+  200: Brand;
+};
+type UpdateBrandErrors = {
+  /** Invalid request data */
+  400: ValidationError;
+  /** Authentication required */
+  401: UnauthorizedError;
+  /** The organization has no active subscription. Cloud deployments only. */
+  402: PaymentRequiredError;
+  /**
+   * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+   * read-only (demo) mode.
+   */
+  403: ForbiddenError;
+  /** Resource not found */
+  404: NotFoundError;
+  /** Resource already exists */
+  409: ConflictError;
+  /** Per-key rate limit exceeded. */
+  429: RateLimitError;
+  /** Internal server error */
+  500: InternalServerError;
+};
+type UpdateBrandResponses = {
+  /** Brand updated */
+  200: Brand;
+};
+type ListBrandsParams = {
+  /**
+   * Page number, 1-based.
+   *
+   * @default 1
+   * @minimum 1
+   */
+  page?: Page;
+  /**
+   * Items per page. Values above the maximum are clamped, not rejected.
+   *
+   * @default 20
+   * @minimum 1
+   * @maximum 100
+   */
+  limit?: Limit;
+};
+/**
+ * Create a brand. Skips onboarding. The first entry in `domains` is treated as the brand's primary
+ * website; the rest are stored as additional domains.
+ */
+type CreateBrandParams = {
+  /** @minLength 1 */
+  id: string;
+  /** @minLength 1 */
+  name: string;
+  /**
+   * Brand domains. The first entry is the primary website; remaining entries are additional
+   * domains.
+   *
+   * @minItems 1
+   */
+  domains: Array<string>;
+  aliases?: Array<string>;
+  competitors?: Array<{
+    aliases?: Array<string>;
+    domains?: Array<string>;
+    /** @minLength 1 */
+    name: string;
+  }>;
+  prompts?: Array<{
+    /** @default true */
+    enabled?: boolean;
+    tags?: Array<string>;
+    /** @minLength 1 */
+    value: string;
+  }>;
+  /**
+   * Organization to create the brand in.
+   *
+   * | | Omitted | Present |
+   * | --- | --- | --- |
+   * | **Organization key** | creates in the key's own organization | must name the key's own organization; any other value is a `400` |
+   * | **Admin key** | provisions a new organization named after the brand id | creates in the named organization, which must already exist — `404` if it does not |
+   *
+   * An admin key omitting this field is currently the only way to create an organization over the
+   * API.
+   */
+  organizationId?: string;
+};
+/**
+ * Update brand-level fields. At least one field must be provided. Provided arrays replace the
+ * stored values verbatim. When `domains` is provided, the first entry becomes the primary website
+ * and the rest become additional domains. Prompts and competitors are managed via /prompts and
+ * /competitors.
+ */
+type UpdateBrandParams = {
+  /** @minLength 1 */
+  brandName?: string;
+  /**
+   * Brand domains. The first entry is the primary website; remaining entries are additional
+   * domains.
+   *
+   * @minItems 1
+   */
+  domains?: Array<string>;
+  aliases?: Array<string>;
+  /**
+   * Whether the brand is sampled at all. **Modifiable only with an instance admin key**: setting it
+   * with an organization key is a `403`, because disabling ends tracking silently while the plan
+   * keeps being billed and no dashboard control does it at any role.
+   */
+  enabled?: boolean;
+};
+//#endregion
+//#region src/types/competitors.d.ts
+type Competitor = {
+  aliases: Array<string>;
+  brandId: string;
+  createdAt: Date;
+  domains: Array<string>;
+  id: string;
+  name: string;
+  updatedAt: Date;
+};
+type CompetitorsList = {
+  /**
+   * Deprecated: read `data` instead. Kept while the one known consumer migrates, and removed in a
+   * future release.
+   *
+   * @deprecated
+   */
+  competitors: Array<Competitor>;
+  /** The items on this page. Read this rather than the named key below. */
+  data: Array<Competitor>;
+  pagination: Pagination;
+};
+type ListCompetitorsErrors = {
+  /** Authentication required */
+  401: UnauthorizedError;
+  /**
+   * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+   * read-only (demo) mode.
+   */
+  403: ForbiddenError;
+  /** Per-key rate limit exceeded. */
+  429: RateLimitError;
+  /** Internal server error */
+  500: InternalServerError;
+};
+type ListCompetitorsResponses = {
+  /** Paginated list of competitors */
+  200: CompetitorsList;
+};
+type CreateCompetitorErrors = {
+  /** Invalid request data */
+  400: ValidationError;
+  /** Authentication required */
+  401: UnauthorizedError;
+  /** The organization has no active subscription. Cloud deployments only. */
+  402: PaymentRequiredError;
+  /**
+   * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+   * read-only (demo) mode.
+   */
+  403: ForbiddenError;
+  /** Resource already exists */
+  409: ConflictError;
+  /** Per-key rate limit exceeded. */
+  429: RateLimitError;
+  /** Internal server error */
+  500: InternalServerError;
+};
+type CreateCompetitorResponses = {
+  /** Competitor created */
+  201: Competitor;
+};
+type DeleteCompetitorErrors = {
+  /** Invalid request data */
+  400: ValidationError;
+  /** Authentication required */
+  401: UnauthorizedError;
+  /** The organization has no active subscription. Cloud deployments only. */
+  402: PaymentRequiredError;
+  /**
+   * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+   * read-only (demo) mode.
+   */
+  403: ForbiddenError;
+  /** Resource not found */
+  404: NotFoundError;
+  /** Resource already exists */
+  409: ConflictError;
+  /** Per-key rate limit exceeded. */
+  429: RateLimitError;
+  /** Internal server error */
+  500: InternalServerError;
+};
+type DeleteCompetitorResponses = {
+  /** Competitor deleted (returns the deleted competitor) */
+  200: Competitor;
+};
+type GetCompetitorErrors = {
+  /** Invalid request data */
+  400: ValidationError;
+  /** Authentication required */
+  401: UnauthorizedError;
+  /**
+   * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+   * read-only (demo) mode.
+   */
+  403: ForbiddenError;
+  /** Resource not found */
+  404: NotFoundError;
+  /** Per-key rate limit exceeded. */
+  429: RateLimitError;
+  /** Internal server error */
+  500: InternalServerError;
+};
+type GetCompetitorResponses = {
+  /** Competitor */
+  200: Competitor;
+};
+type UpdateCompetitorErrors = {
+  /** Invalid request data */
+  400: ValidationError;
+  /** Authentication required */
+  401: UnauthorizedError;
+  /** The organization has no active subscription. Cloud deployments only. */
+  402: PaymentRequiredError;
+  /**
+   * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+   * read-only (demo) mode.
+   */
+  403: ForbiddenError;
+  /** Resource not found */
+  404: NotFoundError;
+  /** Resource already exists */
+  409: ConflictError;
+  /** Per-key rate limit exceeded. */
+  429: RateLimitError;
+  /** Internal server error */
+  500: InternalServerError;
+};
+type UpdateCompetitorResponses = {
+  /** Competitor updated */
+  200: Competitor;
+};
+type ListCompetitorsParams = {
+  brandId?: string;
+  /**
+   * Page number, 1-based.
+   *
+   * @default 1
+   * @minimum 1
+   */
+  page?: Page;
+  /**
+   * Items per page. Values above the maximum are clamped, not rejected.
+   *
+   * @default 20
+   * @minimum 1
+   * @maximum 100
+   */
+  limit?: Limit;
+};
+/** Add a competitor to a brand. */
+type CreateCompetitorParams = {
+  /** @minLength 1 */
+  brandId: string;
+  /** @minLength 1 */
+  name: string;
+  domains?: Array<string>;
+  aliases?: Array<string>;
+};
+/**
+ * Update a competitor. At least one field must be provided. Provided arrays replace the stored
+ * values verbatim.
+ */
+type UpdateCompetitorParams = {
+  /** @minLength 1 */
+  name?: string;
+  domains?: Array<string>;
+  aliases?: Array<string>;
+};
+//#endregion
+//#region src/types/identity.d.ts
+type APIKeyIdentity = {
+  /**
+   * Brands the key is narrowed to, or null when it reaches every brand in its organization. Never
+   * an empty array — a restriction to no brands is rejected at creation rather than treated as no
+   * restriction.
+   */
+  brandIds: Array<string> | null;
+  createdAt: Date | null;
+  /** The key's label, as given when it was issued. Null for admin keys. */
+  createdBy: string | null;
+  /** When the key stops working, if it has an expiry. */
+  expiresAt: Date | null;
+  /** `admin` for an instance key, `organization` for a dashboard-issued key. */
+  keyType: 'admin' | 'organization';
+  lastUsedAt: Date | null;
+  /** The organization this key acts inside. Null for admin keys. */
+  organizationId: string | null;
+  organizationName: string | null;
+  /**
+   * The key's configured limit — generous by design: it exists to stop a runaway loop, not to meter
+   * normal use. Enforcement is a fixed window and approximate under concurrency.
+   */
+  rateLimit: {
+    limit: number;
+    window: 'minute' | 'hour';
+  } | null;
+  /** Scopes this key holds. A read-write key lists both; an admin key always does. */
+  scopes: Array<'read' | 'write'>;
+};
+type GetMeErrors = {
+  /** Authentication required */
+  401: UnauthorizedError;
+  /**
+   * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+   * read-only (demo) mode.
+   */
+  403: ForbiddenError;
+  /** Per-key rate limit exceeded. */
+  429: RateLimitError;
+  /** Internal server error */
+  500: InternalServerError;
+};
+type GetMeResponses = {
+  /** Describe the calling key */
+  200: APIKeyIdentity;
+};
+//#endregion
+//#region src/types/models.d.ts
+type ModelList = {
+  data: Array<Model>;
+};
+type Model = {
+  /** Whether this deployment is actually wired to reach it. */
+  configured: boolean;
+  /** Identifier used by the `model` filter, e.g. `chatgpt`. */
+  id: string;
+  /** Human-readable name. */
+  label: string;
+  /** Whether this model can be tracked grounded, spending a premium pairing. */
+  premiumCapable: boolean;
+};
+type ListModelsErrors = {
+  /** Authentication required */
+  401: UnauthorizedError;
+  /**
+   * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+   * read-only (demo) mode.
+   */
+  403: ForbiddenError;
+  /** Per-key rate limit exceeded. */
+  429: RateLimitError;
+  /** Internal server error */
+  500: InternalServerError;
+};
+type ListModelsResponses = {
+  /** List trackable models */
+  200: ModelList;
+};
+//#endregion
+//#region src/types/organizations.d.ts
+type Organization = {
+  brandCount: number;
+  createdAt: Date;
+  id: string;
+  name: string;
+  slug: string;
+};
+/** The organization's plan limits. Every field is null on deployments without billing. */
+type PlanLimits = {
+  /** Null means no limit. */
+  maxBrands: number | null;
+  /** Enabled prompts across the whole organization. Null means no limit. */
+  maxPrompts: number | null;
+  /** Models the plan may pick from. Null means any. */
+  modelMenu: Array<string> | null;
+  /** Models trackable per brand. */
+  modelPicks: number | null;
+  /** Prompt/model pairings trackable grounded. */
+  premiumPool: number;
+  premiumRunsPerDay: number;
+  standardRunsPerDay: number | null;
+};
+/**
+ * Read-only view of an organization's subscription, limits, and usage. The API has no way to change
+ * any of it: there is no billing write endpoint and no billing write scope. Stripe identifiers,
+ * payment methods, and invoices are deliberately not exposed — those live in the Stripe customer
+ * portal.
+ */
+type OrganizationBilling = {
+  /** False on self-hosted deployments, where nothing is metered. */
+  billingEnabled: boolean;
+  limits: PlanLimits | null;
+  organizationId: string;
+  /** Null when the organization has no subscription, or when billing is disabled. */
+  plan: BillingPlan | null;
+  usage: {
+    brands: number;
+    enabledPrompts: number;
+    premiumPairingsAssigned: number;
+  };
+};
+type BillingPlan = {
+  cancelAtPeriodEnd: boolean;
+  /** Null on a negotiated plan, which carries no billing interval. */
+  interval?: 'monthly' | 'annual' | null;
+  /** Plan identifier, or `custom` for a negotiated plan. */
+  key: string | null;
+  /** Display name. */
+  name: string;
+  periodEnd?: Date | null;
+  /**
+   * What the subscription means for service, and the only field a caller needs to act on: `active`
+   * and `grace` keep tracking running, `paused` stops it, `none` is unsubscribed. The payment
+   * provider's own status string is deliberately not passed through.
+   */
+  standing: 'active' | 'grace' | 'paused' | 'none';
+  /** Whether prompts are currently being sampled. */
+  trackingActive: boolean;
+};
+type OrganizationList = {
+  data: Array<Organization>;
+  pagination: Pagination;
+};
+type ListOrganizationsErrors = {
+  /** Authentication required */
+  401: UnauthorizedError;
+  /**
+   * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+   * read-only (demo) mode.
+   */
+  403: ForbiddenError;
+  /** Per-key rate limit exceeded. */
+  429: RateLimitError;
+  /** Internal server error */
+  500: InternalServerError;
+};
+type ListOrganizationsResponses = {
+  /** List organizations */
+  200: OrganizationList;
+};
+type GetOrganizationErrors = {
+  /** Authentication required */
+  401: UnauthorizedError;
+  /**
+   * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+   * read-only (demo) mode.
+   */
+  403: ForbiddenError;
+  /** Resource not found */
+  404: NotFoundError;
+  /** Per-key rate limit exceeded. */
+  429: RateLimitError;
+  /** Internal server error */
+  500: InternalServerError;
+};
+type GetOrganizationResponses = {
+  /** Get an organization */
+  200: Organization;
+};
+type GetOrganizationBillingErrors = {
+  /** Authentication required */
+  401: UnauthorizedError;
+  /**
+   * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+   * read-only (demo) mode.
+   */
+  403: ForbiddenError;
+  /** Resource not found */
+  404: NotFoundError;
+  /** Per-key rate limit exceeded. */
+  429: RateLimitError;
+  /** Internal server error */
+  500: InternalServerError;
+};
+type GetOrganizationBillingResponses = {
+  /** Get billing state */
+  200: OrganizationBilling;
+};
+type ListOrganizationsParams = {
+  /**
+   * Page number, 1-based.
+   *
+   * @default 1
+   * @minimum 1
+   */
+  page?: Page;
+  /**
+   * Items per page. Values above the maximum are clamped, not rejected.
+   *
+   * @default 20
+   * @minimum 1
+   * @maximum 100
+   */
+  limit?: Limit;
+};
+//#endregion
+//#region src/types/runs.d.ts
+/** A single model answer, without its text. Fetch `prompts.runs.get()` for the answer itself. */
+type RunSummary = {
+  brandId: string;
+  brandMentioned: boolean;
+  citationCount: number;
+  competitorsMentioned: Array<string>;
+  createdAt: Date;
+  id: string;
+  model: string;
+  promptId: string;
+  /** How the answer was obtained. Informational; not a stable enum. */
+  provider: string | null;
+  /** Searches the engine ran, where it exposes them. */
+  webQueries: Array<string>;
+  /** Whether the engine answered with its own web search on. */
+  webSearchEnabled: boolean;
+};
+type RunCitation = {
+  /** Position within the answer's citation list. */
+  citationIndex: number;
+  domain: string;
+  title: string | null;
+  url: string;
+};
+/** One model answer with its normalized text and citations. */
+type Run = RunSummary & {
+  answer: {
+    /**
+     * The answer, normalized out of the provider's response. Null when nothing could be extracted.
+     */
+    text: string | null;
+  };
+  citations: Array<RunCitation>;
+};
+type RunList = {
+  data: Array<RunSummary>;
+  pagination: Pagination;
+};
+type ListPromptRunsErrors = {
+  /** Invalid request data */
+  400: ValidationError;
+  /** Authentication required */
+  401: UnauthorizedError;
+  /**
+   * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+   * read-only (demo) mode.
+   */
+  403: ForbiddenError;
+  /** Resource not found */
+  404: NotFoundError;
+  /** Per-key rate limit exceeded. */
+  429: RateLimitError;
+  /** Internal server error */
+  500: InternalServerError;
+};
+type ListPromptRunsResponses = {
+  /** List runs for a prompt */
+  200: RunList;
+};
+type GetRunErrors = {
+  /** Invalid request data */
+  400: ValidationError;
+  /** Authentication required */
+  401: UnauthorizedError;
+  /**
+   * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+   * read-only (demo) mode.
+   */
+  403: ForbiddenError;
+  /** Resource not found */
+  404: NotFoundError;
+  /** Per-key rate limit exceeded. */
+  429: RateLimitError;
+  /** Internal server error */
+  500: InternalServerError;
+};
+type GetRunResponses = {
+  /** Get a run */
+  200: Run;
+};
+type ListPromptRunsParams = {
+  /**
+   * Inclusive lower bound of the window, an ISO 8601 timestamp such as `2026-01-01T00:00:00Z`. A
+   * bare `YYYY-MM-DD` is rejected: that is `/prompts/{promptId}/snapshot`'s spelling and means a
+   * local calendar day there.
+   */
+  start: WindowStart;
+  /**
+   * Exclusive upper bound of the window, an ISO 8601 timestamp. The window is half-open: a run at
+   * exactly `end` is outside it.
+   */
+  end: WindowEnd;
+  /** Restrict to one model, e.g. `chatgpt`. See `models.list()`. */
+  model?: ModelFilter;
+  /**
+   * Page number, 1-based.
+   *
+   * @default 1
+   * @minimum 1
+   */
+  page?: Page;
+  /**
+   * Items per page. Values above the maximum are clamped, not rejected.
+   *
+   * @default 20
+   * @minimum 1
+   * @maximum 100
+   */
+  limit?: Limit;
+};
+//#endregion
+//#region src/types/shared/mention-entry.d.ts
+/** Aggregated mention counts for a prompt across its evaluation runs. */
+type MentionsSummary = {
+  /** Number of runs where the brand was mentioned */
+  brandMentionsTotal: number;
+  /**
+   * Total count of individual competitor mentions across all runs (a single run mentioning 3
+   * competitors counts as 3)
+   */
+  competitorMentionsTotal: number;
+  /** Top-K competitor entities ranked by mention count */
+  mentionsTopK: Array<MentionEntry>;
+  /** Total brand + competitor mentions across all runs */
+  mentionsTotal: number;
+};
+type MentionEntry = {
+  /** Number of runs where this entity was mentioned */
+  count: number;
+  /** Competitor entity name */
+  entity: string;
+};
+//#endregion
+//#region src/types/snapshots.d.ts
+type CitedURLEntry = {
+  /** Number of times this URL was cited */
+  count: number;
+  /** Page title if available */
+  title: string | null;
+  /** The cited URL */
+  url: string;
+};
+type PromptSnapshot = {
+  /** Brand identifier this prompt belongs to */
+  brandId: string;
+  citations: {
+    /** Number of citations to brand-owned domains */
+    brandCitationsTotal: number;
+    /** Total number of citations across all runs */
+    citationsTotal: number;
+    /** Top-K cited URLs ranked by frequency */
+    citedUrlsTopK: Array<CitedURLEntry>;
+    /** Number of citations to competitor-owned domains */
+    competitorCitationsTotal: number;
+  };
+  /** End of the queried date range (YYYY-MM-DD) */
+  endDate: string;
+  mentions: MentionsSummary;
+  /** Unique identifier for the prompt */
+  promptId: string;
+  /** The prompt text */
+  promptValue: string;
+  /** Start of the queried date range (YYYY-MM-DD) */
+  startDate: string;
+};
+type GetPromptSnapshotErrors = {
+  /** Invalid request data */
+  400: ValidationError;
+  /** Authentication required */
+  401: UnauthorizedError;
+  /**
+   * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+   * read-only (demo) mode.
+   */
+  403: ForbiddenError;
+  /** Resource not found */
+  404: NotFoundError;
+  /** Per-key rate limit exceeded. */
+  429: RateLimitError;
+  /** Internal server error */
+  500: InternalServerError;
+};
+type GetPromptSnapshotResponses = {
+  /** Prompt snapshot with mention and citation analytics */
+  200: PromptSnapshot;
+};
+type GetPromptSnapshotParams = {
+  /** Start of date range (YYYY-MM-DD) */
+  startDate: string;
+  /** End of date range (YYYY-MM-DD) */
+  endDate: string;
+  /**
+   * Number of top competitor entities to return in mentionsTopK
+   *
+   * @default 5
+   * @minimum 1
+   * @maximum 50
+   */
+  kMentions?: number;
+  /**
+   * Number of top cited URLs to return in citedUrlsTopK
+   *
+   * @default 10
+   * @minimum 1
+   * @maximum 50
+   */
+  kCitations?: number;
+};
+//#endregion
+//#region src/types/prompts.d.ts
+type Prompt = {
+  /** Brand identifier this prompt belongs to */
+  brandId: string;
+  /** Timestamp when the prompt was created */
+  createdAt: Date;
+  /** Whether the prompt is currently enabled */
+  enabled: boolean;
+  /** Unique identifier for the prompt */
+  id: string;
+  /** Models this prompt is tracked on grounded. Each entry spends one premium pairing. */
+  premiumModels: Array<string>;
+  /** Auto-computed system tags (e.g., 'branded', 'unbranded'). Read-only. */
+  systemTags: Array<string>;
+  /** User-defined tags for categorizing this prompt */
+  tags: Array<string>;
+  /** Timestamp when the prompt was last updated */
+  updatedAt: Date;
+  /** The actual prompt text */
+  value: string;
+};
+type ListPromptsErrors = {
+  /** Authentication required */
+  401: UnauthorizedError;
+  /**
+   * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+   * read-only (demo) mode.
+   */
+  403: ForbiddenError;
+  /** Per-key rate limit exceeded. */
+  429: RateLimitError;
+  /** Internal server error */
+  500: InternalServerError;
+};
+type ListPromptsResponses = {
+  /** List of prompts */
+  200: {
+    /** The items on this page. Read this rather than the named key below. */
+    data: Array<Prompt>;
+    pagination: {
+      limit: number;
+      page: number;
+      total: number;
+      totalPages: number;
+    };
+    /**
+     * Deprecated: read `data` instead. Kept while the one known consumer migrates, and removed in a
+     * future release.
+     *
+     * @deprecated
+     */
+    prompts: Array<Prompt>;
+  };
+};
+type ListPromptsResponse = ListPromptsResponses[keyof ListPromptsResponses];
+type CreatePromptErrors = {
+  /** Invalid request data */
+  400: ValidationError;
+  /** Authentication required */
+  401: UnauthorizedError;
+  /** The organization has no active subscription. Cloud deployments only. */
+  402: PaymentRequiredError;
+  /**
+   * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+   * read-only (demo) mode.
+   */
+  403: ForbiddenError;
+  /** Resource already exists */
+  409: ConflictError;
+  /** Per-key rate limit exceeded. */
+  429: RateLimitError;
+  /** Internal server error */
+  500: InternalServerError;
+};
+type CreatePromptResponses = {
+  /** Prompt created successfully */
+  201: Prompt;
+};
+type DeletePromptErrors = {
+  /** Invalid request data */
+  400: ValidationError;
+  /** Authentication required */
+  401: UnauthorizedError;
+  /** The organization has no active subscription. Cloud deployments only. */
+  402: PaymentRequiredError;
+  /**
+   * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+   * read-only (demo) mode.
+   */
+  403: ForbiddenError;
+  /** Resource not found */
+  404: NotFoundError;
+  /** Resource already exists */
+  409: ConflictError;
+  /** Per-key rate limit exceeded. */
+  429: RateLimitError;
+  /** Internal server error */
+  500: InternalServerError;
+};
+type DeletePromptResponses = {
+  /** Prompt deleted (returns the deleted prompt) */
+  200: Prompt & {
+    /** Number of related prompt_runs rows deleted by the cascade. */
+    deletedRunsCount: number;
+  };
+};
+type DeletePromptResponse = DeletePromptResponses[keyof DeletePromptResponses];
+type GetPromptErrors = {
+  /** Invalid request data */
+  400: ValidationError;
+  /** Authentication required */
+  401: UnauthorizedError;
+  /**
+   * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+   * read-only (demo) mode.
+   */
+  403: ForbiddenError;
+  /** Resource not found */
+  404: NotFoundError;
+  /** Per-key rate limit exceeded. */
+  429: RateLimitError;
+  /** Internal server error */
+  500: InternalServerError;
+};
+type GetPromptResponses = {
+  /** Prompt details */
+  200: Prompt;
+};
+type UpdatePromptErrors = {
+  /** Invalid request data */
+  400: ValidationError;
+  /** Authentication required */
+  401: UnauthorizedError;
+  /** The organization has no active subscription. Cloud deployments only. */
+  402: PaymentRequiredError;
+  /**
+   * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+   * read-only (demo) mode.
+   */
+  403: ForbiddenError;
+  /** Resource not found */
+  404: NotFoundError;
+  /** Resource already exists */
+  409: ConflictError;
+  /** Per-key rate limit exceeded. */
+  429: RateLimitError;
+  /** Internal server error */
+  500: InternalServerError;
+};
+type UpdatePromptResponses = {
+  /** Prompt updated successfully */
+  200: Prompt;
+};
+type ListPromptsParams = {
+  /** Filter prompts by brand ID */
+  brandId?: string;
+  /**
+   * Page number, 1-based.
+   *
+   * @default 1
+   * @minimum 1
+   */
+  page?: Page;
+  /**
+   * Items per page. Values above the maximum are clamped, not rejected. This list had no ceiling
+   * before, so the maximum is set to bound a runaway query rather than to change what an existing
+   * caller gets back.
+   *
+   * @default 20
+   * @minimum 1
+   * @maximum 1000
+   */
+  limit?: number;
+  /** Only prompts with this tracking state. */
+  enabled?: boolean;
+  /** Comma-separated tags. A prompt matches if it carries any of them. */
+  tags?: string;
+  /** Case-insensitive substring match on prompt text. */
+  q?: string;
+};
+type CreatePromptParams = {
+  /** Brand identifier this prompt belongs to */
+  brandId: string;
+  /**
+   * The prompt text
+   *
+   * @minLength 1
+   */
+  value: string;
+  /** User-defined tags for categorizing this prompt */
+  tags?: Array<string>;
+};
+type UpdatePromptParams = {
+  /**
+   * The prompt text
+   *
+   * @minLength 1
+   */
+  value?: string;
+  /** Whether the prompt is enabled */
+  enabled?: boolean;
+  /** User-defined tags for categorizing this prompt */
+  tags?: Array<string>;
+  /** Replaces the prompt's grounded models. Checked against the organization's premium pool. */
+  premiumModels?: Array<string>;
+};
+//#endregion
+//#region src/types/reports.d.ts
+type ReportSummary = {
+  /** Other names counted as brand mentions */
+  brandAliases: Array<string>;
+  /** Brand name analyzed */
+  brandName: string;
+  /** Brand website URL */
+  brandWebsite: string;
+  /** Timestamp when the report completed */
+  completedAt: Date | null;
+  /** Timestamp when the report was created */
+  createdAt: Date;
+  /** Unique identifier for the report */
+  id: string;
+  /** Current report status */
+  status: 'pending' | 'processing' | 'completed' | 'failed';
+};
+/**
+ * Per-prompt snapshot of raw mention data from a report. Consumers compute SoV and other derived
+ * metrics.
+ */
+type ReportPromptSnapshot = {
+  mentions: MentionsSummary;
+  /** The prompt text that was evaluated */
+  promptValue: string;
+  /** Number of evaluation runs for this prompt */
+  totalRuns: number;
+};
+type ListReportsErrors = {
+  /** Authentication required */
+  401: UnauthorizedError;
+  /**
+   * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+   * read-only (demo) mode.
+   */
+  403: ForbiddenError;
+  /** Per-key rate limit exceeded. */
+  429: RateLimitError;
+  /** Internal server error */
+  500: InternalServerError;
+};
+type ListReportsResponses = {
+  /** Paginated list of reports */
+  200: {
+    /** The items on this page. Read this rather than the named key below. */
+    data: Array<ReportSummary>;
+    pagination: {
+      limit: number;
+      page: number;
+      total: number;
+      totalPages: number;
+    };
+    /**
+     * Deprecated: read `data` instead. Kept while the one known consumer migrates, and removed in a
+     * future release.
+     *
+     * @deprecated
+     */
+    reports: Array<ReportSummary>;
+  };
+};
+type ListReportsResponse = ListReportsResponses[keyof ListReportsResponses];
+type CreateReportErrors = {
+  /** Invalid request data */
+  400: ValidationError;
+  /** Authentication required */
+  401: UnauthorizedError;
+  /** The organization has no active subscription. Cloud deployments only. */
+  402: PaymentRequiredError;
+  /**
+   * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+   * read-only (demo) mode.
+   */
+  403: ForbiddenError;
+  /** Resource already exists */
+  409: ConflictError;
+  /** Per-key rate limit exceeded. */
+  429: RateLimitError;
+  /** Internal server error */
+  500: InternalServerError;
+};
+type CreateReportResponses = {
+  /** Report created and queued for generation */
+  201: {
+    brandAliases: Array<string>;
+    brandName: string;
+    brandWebsite: string;
+    createdAt: Date;
+    /** Unique identifier for the created report */
+    reportId: string;
+    /** Initial report status */
+    status: 'pending';
+  };
+};
+type CreateReportResponse = CreateReportResponses[keyof CreateReportResponses];
+type GetReportErrors = {
+  /** Invalid request data */
+  400: ValidationError;
+  /** Authentication required */
+  401: UnauthorizedError;
+  /**
+   * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+   * read-only (demo) mode.
+   */
+  403: ForbiddenError;
+  /** Resource not found */
+  404: NotFoundError;
+  /** Per-key rate limit exceeded. */
+  429: RateLimitError;
+  /** Internal server error */
+  500: InternalServerError;
+};
+type GetReportResponses = {
+  /**
+   * Report status and data. When status is 'completed', includes per-prompt snapshot data with raw
+   * mention counts.
+   */
+  200: {
+    brandAliases: Array<string>;
+    brandName: string;
+    brandWebsite: string;
+    completedAt: Date | null;
+    createdAt: Date;
+    /** Generation progress percentage (0-100). Available while processing. */
+    progress?: number;
+    /** Per-prompt snapshot data. Only present when status is 'completed'. */
+    prompts?: Array<ReportPromptSnapshot>;
+    reportId: string;
+    status: 'pending' | 'processing' | 'completed' | 'failed';
+    /**
+     * Derived stats (SoV, visibility, etc.). Format may change between versions. Only present when
+     * status is 'completed'.
+     */
+    unstable?: {
+      /** Per-competitor SoV breakdown, sorted by SoV descending */
+      competitors?: Array<{
+        /** Competitor name */
+        name: string;
+        /** Number of individual prompt runs where this competitor was mentioned */
+        promptRunsWithMentions: number;
+        /** Number of prompts where this competitor was mentioned in at least one run */
+        promptsWithMentions: number;
+        /**
+         * Share of voice (0-1): this competitor's mentions / total mentions (brand + all
+         * competitors)
+         *
+         * @minimum 0
+         * @maximum 1
+         */
+        sov: number;
+        /**
+         * Visibility (0-1): prompt runs mentioning this competitor / total prompt runs
+         *
+         * @minimum 0
+         * @maximum 1
+         */
+        visibility: number;
+      }>;
+      /** Number of individual prompt runs where the brand was mentioned */
+      promptRunsWithBrandMentions?: number;
+      /** Number of prompts where the brand was mentioned in at least one prompt run */
+      promptsWithBrandMentions?: number;
+      /**
+       * Overall share of voice (0-1): brand_mentions / (brand_mentions + competitor_mentions). Null
+       * when no mentions at all.
+       *
+       * @minimum 0
+       * @maximum 1
+       */
+      sov?: number | null;
+      /**
+       * Total number of prompt runs across all prompts (each prompt is executed multiple times
+       * across different AI engines)
+       */
+      totalPromptRuns?: number;
+      /** Total number of prompts evaluated */
+      totalPrompts?: number;
+      /**
+       * Brand visibility (0-1): brand_mentions / total_prompt_runs (how often the brand appears at
+       * all across all prompt runs)
+       *
+       * @minimum 0
+       * @maximum 1
+       */
+      visibility?: number;
+    };
+  };
+};
+type GetReportResponse = GetReportResponses[keyof GetReportResponses];
+type ListReportsParams = {
+  /**
+   * Page number, 1-based.
+   *
+   * @default 1
+   * @minimum 1
+   */
+  page?: Page;
+  /**
+   * Items per page. Values above the maximum are clamped, not rejected.
+   *
+   * @default 20
+   * @minimum 1
+   * @maximum 100
+   */
+  limit?: Limit;
+};
+type CreateReportParams = {
+  /**
+   * The brand name to analyze
+   *
+   * @minLength 1
+   */
+  brandName: string;
+  /**
+   * Other names the brand goes by (spellings, abbreviations, product names). A mention of any of
+   * them counts as a brand mention.
+   *
+   * @maxItems 10
+   */
+  brandAliases?: Array<string>;
+  /**
+   * The brand's website — a domain (nike.com) or a full URL. A URL with a path (e.g.
+   * https://www.nike.com/golf) scopes the analysis to that page; mentions are tracked against its
+   * domain either way.
+   *
+   * @minLength 1
+   */
+  brandWebsite: string;
+  /** Optional list of custom prompts to include in the report */
+  manualPrompts?: Array<string>;
+};
+type GetReportParams = {
+  /**
+   * Number of top competitor entities to return in each prompt's mentionsTopK
+   *
+   * @default 5
+   * @minimum 1
+   * @maximum 50
+   */
+  kMentions?: number;
+};
+//#endregion
+//#region src/types/tools.d.ts
+type OnboardingSuggestion = {
+  additionalDomains: Array<string>;
+  aliases: Array<string>;
+  brandName: string;
+  competitors: Array<{
+    aliases: Array<string>;
+    domains: Array<string>;
+    name: string;
+  }>;
+  suggestedPrompts: Array<{
+    prompt: string;
+    tags: Array<string>;
+  }>;
+  /** Cleaned hostname */
+  website: string;
+};
+type AnalyzeBrandErrors = {
+  /** Invalid request data */
+  400: ValidationError;
+  /** Authentication required */
+  401: UnauthorizedError;
+  /** The organization has no active subscription. Cloud deployments only. */
+  402: PaymentRequiredError;
+  /**
+   * The key is valid but not permitted: a missing scope, an admin-only endpoint, or a write in
+   * read-only (demo) mode.
+   */
+  403: ForbiddenError;
+  /** Resource already exists */
+  409: ConflictError;
+  /** Per-key rate limit exceeded. */
+  429: RateLimitError;
+  /** Internal server error */
+  500: InternalServerError;
+};
+type AnalyzeBrandResponses = {
+  /** Brand analysis suggestion */
+  200: OnboardingSuggestion;
+};
+type AnalyzeBrandParams = {
+  /**
+   * Brand's website — a hostname or a full URL. A URL with a path (e.g. https://www.nike.com/golf)
+   * is analyzed as given; the returned website is always its domain.
+   *
+   * @minLength 1
+   */
+  website: string;
+  /** Optional brand name hint. If omitted, inferred from the domain. */
+  brandName?: string;
+  /**
+   * Maximum number of competitor suggestions. 0 disables competitor generation entirely.
+   *
+   * @default 20
+   * @minimum 0
+   * @maximum 100
+   */
+  maxCompetitors?: number;
+  /**
+   * Maximum number of suggested prompts. 0 disables prompt generation entirely.
+   *
+   * @default 30
+   * @minimum 0
+   * @maximum 100
+   */
+  maxPrompts?: number;
+};
+//#endregion
+export { GetOrganizationBillingResponses as $, BrandOpportunities as $t, ListPromptsResponses as A, PromptPerformance as An, UpdateCompetitorResponses as At, MentionEntry as B, WindowStart as Bn, ListBrandsResponses as Bt, DeletePromptResponse as C, ListBrandCitationURLsErrors as Cn, GetCompetitorErrors as Ct, ListPromptsErrors as D, ListBrandPromptPerformanceParams as Dn, ListCompetitorsResponses as Dt, GetPromptResponses as E, ListBrandPromptPerformanceErrors as En, ListCompetitorsParams as Et, CitedURLEntry as F, VisibilityPoint as Fn, CreateBrandResponses as Ft, ListPromptRunsParams as G, UnauthorizedError as Gn, Page as Gt, GetRunErrors as H, ForbiddenError as Hn, UpdateBrandParams as Ht, GetPromptSnapshotErrors as I, ValidationError as In, GetBrandErrors as It, RunCitation as J, PaymentRequiredError as Jt, ListPromptRunsResponses as K, Limit as Kt, GetPromptSnapshotParams as L, NotFoundError as Ln, GetBrandResponses as Lt, UpdatePromptErrors as M, ShareOfVoiceEntry as Mn, BrandsList as Mt, UpdatePromptParams as N, ShareOfVoicePoint as Nn, CreateBrandErrors as Nt, ListPromptsParams as O, ListBrandPromptPerformanceResponses as On, UpdateCompetitorErrors as Ot, UpdatePromptResponses as P, TagsFilter as Pn, CreateBrandParams as Pt, GetOrganizationBillingErrors as Q, TagList as Qt, GetPromptSnapshotResponses as R, ModelFilter as Rn, ListBrandsErrors as Rt, DeletePromptErrors as S, ListBrandCitationDomainsResponses as Sn, DeleteCompetitorResponses as St, GetPromptErrors as T, ListBrandCitationURLsResponses as Tn, ListCompetitorsErrors as Tt, GetRunResponses as U, InternalServerError as Un, UpdateBrandResponses as Ut, MentionsSummary as V, Error as Vn, UpdateBrandErrors as Vt, ListPromptRunsErrors as W, RateLimitError as Wn, Pagination as Wt, RunSummary as X, ListBrandTagsResponses as Xt, RunList as Y, ListBrandTagsErrors as Yt, BillingPlan as Z, Tag as Zt, ReportPromptSnapshot as _, GetBrandQueryFanoutErrors as _n, CompetitorsList as _t, CreateReportErrors as a, BrandIdPath as an, Organization as at, CreatePromptParams as b, ListBrandCitationDomainsErrors as bn, CreateCompetitorResponses as bt, CreateReportResponses as c, CitationDomain as cn, PlanLimits as ct, GetReportResponse as d, CitationURLList as dn, Model as dt, CitedPage as en, GetOrganizationErrors as et, GetReportResponses as f, DateRange as fn, ModelList as ft, ListReportsResponses as g, GetBrandAnalyticsResponses as gn, Competitor as gt, ListReportsResponse as h, GetBrandAnalyticsParams as hn, GetMeResponses as ht, OnboardingSuggestion as i, OpportunityPrompt as in, ListOrganizationsResponses as it, Prompt as j, PromptPerformanceList as jn, Brand as jt, ListPromptsResponse as k, ModelVisibility as kn, UpdateCompetitorParams as kt, GetReportErrors as l, CitationDomainList as ln, ListModelsErrors as lt, ListReportsParams as m, GetBrandAnalyticsErrors as mn, GetMeErrors as mt, AnalyzeBrandParams as n, GetBrandOpportunitiesResponses as nn, ListOrganizationsErrors as nt, CreateReportParams as o, BrandAnalytics as on, OrganizationBilling as ot, ListReportsErrors as p, FanoutQuery as pn, APIKeyIdentity as pt, Run as q, ConflictError as qt, AnalyzeBrandResponses as r, Opportunity as rn, ListOrganizationsParams as rt, CreateReportResponse as s, BrandQueryFanout as sn, OrganizationList as st, AnalyzeBrandErrors as t, GetBrandOpportunitiesErrors as tn, GetOrganizationResponses as tt, GetReportParams as u, CitationURL as un, ListModelsResponses as ut, ReportSummary as v, GetBrandQueryFanoutParams as vn, CreateCompetitorErrors as vt, DeletePromptResponses as w, ListBrandCitationURLsParams as wn, GetCompetitorResponses as wt, CreatePromptResponses as x, ListBrandCitationDomainsParams as xn, DeleteCompetitorErrors as xt, CreatePromptErrors as y, GetBrandQueryFanoutResponses as yn, CreateCompetitorParams as yt, PromptSnapshot as z, WindowEnd as zn, ListBrandsParams as zt };
+//# sourceMappingURL=tools-7Hs5J2xb.d.mts.map