@aventurevc/api-schemas 0.8.375 → 0.8.377

package/dist/entity/filter.js

@@ -80,9 +80,9 @@ export const EntityFilterSchema = z.strictObject({
     logoOption: EntityFilterLogoOptionSchema.optional(),
     /** Main product classification values. */
     mainProduct: z.array(z.string()).optional(),
-    /** Precise notable activity in 48h. */
+    /** When true, only operating companies or business lines with a real logo, founding year, and current headquarters that had notable activity in the last 48 hours. */
     noteworthyOnly: z.boolean().optional(),
-    /** Operating states to include; omit to include every state. */
+    /** Operating states; omit for all. */
     operatingStatus: z.array(EntityOperatingStatusSchema).optional(),
     /** Countries an entity is from: its headquarters country or the country of its current origin (founding) address, never a legal seat alone. What a nationality adjective (Colombian startups) means; headquartersCountry is only where it is based now. */
     originCountry: z.array(z.string()).optional(),
@@ -94,7 +94,7 @@ export const EntityFilterSchema = z.strictObject({
     portfolioHeadquartersCountry: z.array(z.string()).optional(),
     /** Portfolio-company headquarters state or region values. */
     portfolioHeadquartersState: z.array(z.string()).optional(),
-    /** Server-owned list quality gate. */
+    /** Extra listing check: COMPANY_LISTING_READY or NONE (default, no check). */
     qualityGate: EntityListQualityGateSchema.optional(),
     /** Rank most prominent first (funding, stage, headcount, momentum, recent news, investor breadth), ahead of sort: what best, top, or most promising mean. */
     rankByProminence: z.boolean().nullish(),
@@ -107,7 +107,7 @@ export const EntityFilterSchema = z.strictObject({
         .optional(),
     /** Stage classification values. */
     stage: z.array(z.string()).optional(),
-    /** OR exact tuples within this facet; AND with other facets. */
+    /** Matches any one of these entries; combined with the other filters by AND. */
     standardizedClassification: z.array(StandardizedClassificationFilterSchema).max(20).optional(),
     /** Exclude public and acquired companies (including acquired subsidiaries); what startup means. Private companies at any round stay, as do companies without a recorded stage or operating status. */
     suppressLateStage: z.boolean().nullish(),
@@ -129,9 +129,9 @@ export const EntityFilterSchema = z.strictObject({
     typeRecord: z.array(EntityTypeSchema).optional(),
     /** Revenue-model classification values. */
     typeRevenue: z.array(z.string()).optional(),
-    /** Technology-used classification values. */
+    /** Technology-used values. */
     typeTechnologyUsed: z.array(z.string()).optional(),
-    /** OR public-registry identifier predicates; AND with other facets. */
+    /** Matches any listed registry identifier; combined with other filters by AND. */
     uniqueId: z.array(EntityUniqueIdFilterSchema).max(20).optional(),
     /** Current URL to match by normalized host and path. */
     url: z.string().nullish(),

package/dist/entity/fundraise-investor-join.d.ts

@@ -35,7 +35,7 @@ type EntityFundraiseInvestorJoinDefinition = z.infer<typeof EntityFundraiseInves
 export interface EntityFundraiseInvestorJoinSchemaInput extends z.input<typeof EntityFundraiseInvestorJoinSchemaDefinition> {
 }
 /**
- * Canonical fundraise investor join row for API serialization
+ * One investor's participation in one funding round.
  *
  * @openapiSchema EntityFundraiseInvestorJoin
  * @endpoint GET /v1/entities/lookup-exact

package/dist/entity/fundraise-investor-join.js

@@ -32,7 +32,7 @@ const EntityFundraiseInvestorJoinSchemaDefinition = z.object({
     updatedAt: z.iso.datetime({ offset: true }),
 });
 /**
- * Canonical fundraise investor join row for API serialization
+ * One investor's participation in one funding round.
  *
  * @openapiSchema EntityFundraiseInvestorJoin
  * @endpoint GET /v1/entities/lookup-exact

package/dist/entity/fundraise-transaction-entity.d.ts

@@ -1,6 +1,6 @@
 import { z } from "zod/v4";
 /**
- * Entity projection used inside FundraiseTransaction responses
+ * Basic entity fields shown inside a funding round.
  *
  * @openapiSchema EntityFundraiseTransactionEntity
  * @endpoint GET /v1/entities/lookup-exact

package/dist/entity/fundraise-transaction-entity.js

@@ -3,7 +3,7 @@ import { z } from "zod/v4";
 import { EntitySchema } from "./entity.js";
 import { EntityFundingDetailSchema } from "./funding-detail.js";
 /**
- * Entity projection used inside FundraiseTransaction responses
+ * Basic entity fields shown inside a funding round.
  *
  * @openapiSchema EntityFundraiseTransactionEntity
  * @endpoint GET /v1/entities/lookup-exact

package/dist/entity/fundraise-transaction.d.ts

@@ -398,7 +398,7 @@ type EntityFundraiseTransactionDefinition = z.infer<typeof EntityFundraiseTransa
 export interface EntityFundraiseTransactionSchemaInput extends z.input<typeof EntityFundraiseTransactionSchemaDefinition> {
 }
 /**
- * Canonical fundraise transaction view. ONE row per discrete round. An entity that raised pre-seed, seed, and Series A is THREE rows. Combined or rolled-up totals are never modeled here — total raised is a sum across rows.
+ * One funding round. ONE row per discrete round. An entity that raised pre-seed, seed, and Series A is THREE rows. Combined or rolled-up totals are never modeled here — total raised is a sum across rows.
  *
  * @openapiSchema EntityFundraiseTransaction
  * @endpoint GET /v1/entities/lookup-exact

package/dist/entity/fundraise-transaction.js

@@ -27,7 +27,7 @@ const EntityFundraiseTransactionSchemaDefinition = z.object({
     entity: EntityFundraiseTransactionEntitySchema.nullish(),
     /** Source-reported financial instrument persisted for this round. */
     financialInstrumentType: FundraiseFinancialInstrumentTypeSchema.nullish(),
-    /** Canonical fundraise transaction UUID */
+    /** Funding round id (UUID) */
     id: z.uuid(),
     investor: z.array(EntityFundraiseInvestorJoinSchema).nullish(),
     /** Investor-specific attribution when returned from investor-perspective investment views. amountInvested is not added to amountRaised; it is the selected investor's whole investment in this round: its joins here (one per vehicle, such as a CEA and a SAFE) summed. joinId names one of those joins. */
@@ -52,7 +52,7 @@ const EntityFundraiseTransactionSchemaDefinition = z.object({
     valuationPreMoney: z.number().int().nullish(),
 });
 /**
- * Canonical fundraise transaction view. ONE row per discrete round. An entity that raised pre-seed, seed, and Series A is THREE rows. Combined or rolled-up totals are never modeled here — total raised is a sum across rows.
+ * One funding round. ONE row per discrete round. An entity that raised pre-seed, seed, and Series A is THREE rows. Combined or rolled-up totals are never modeled here — total raised is a sum across rows.
  *
  * @openapiSchema EntityFundraiseTransaction
  * @endpoint GET /v1/entities/lookup-exact

package/dist/entity/fundraise.js

@@ -33,7 +33,7 @@ export const EntityFundraiseSchema = z.object({
         .string()
         .regex(/^(?!0000)[0-9]{4}(?:-(?:0[1-9]|1[0-2])(?:-(?:0[1-9]|[12][0-9]|3[01])(?:T(?:[01][0-9]|2[0-3]):[0-5][0-9](?::[0-5][0-9](?:\.[0-9]{1,9})?)?(?:Z|[+-](?:(?:0[0-9]|1[0-7]):[0-5][0-9]|18:00)))?)?)?$/)
         .nullish(),
-    /** Canonical fundraise transaction UUID */
+    /** Funding round id (UUID) */
     id: z.uuid(),
     image: EntityImageSchema,
     investorCount: z.int().nullish(),

package/dist/entity/list-filter.js

@@ -76,9 +76,9 @@ export const EntityListFilterSchema = z.strictObject({
     logoOption: EntityFilterLogoOptionSchema.optional(),
     /** Main product classification values. */
     mainProduct: z.array(z.string()).optional(),
-    /** Precise notable activity in 48h. */
+    /** When true, only operating companies or business lines with a real logo, founding year, and current headquarters that had notable activity in the last 48 hours. */
     noteworthyOnly: z.boolean().optional(),
-    /** Operating states to include; omit to include every state. */
+    /** Operating states; omit for all. */
     operatingStatus: z.array(EntityOperatingStatusSchema).optional(),
     /** Countries an entity is from: its headquarters country or the country of its current origin (founding) address, never a legal seat alone. What a nationality adjective (Colombian startups) means; headquartersCountry is only where it is based now. */
     originCountry: z.array(z.string()).optional(),
@@ -90,7 +90,7 @@ export const EntityListFilterSchema = z.strictObject({
     portfolioHeadquartersCountry: z.array(z.string()).optional(),
     /** Portfolio-company headquarters state or region values. */
     portfolioHeadquartersState: z.array(z.string()).optional(),
-    /** Server-owned list quality gate. */
+    /** Extra listing check: COMPANY_LISTING_READY or NONE (default, no check). */
     qualityGate: EntityListQualityGateSchema.optional(),
     /** Rank most prominent first (funding, stage, headcount, momentum, recent news, investor breadth), ahead of sort: what best, top, or most promising mean. */
     rankByProminence: z.boolean().nullish(),
@@ -105,7 +105,7 @@ export const EntityListFilterSchema = z.strictObject({
         .optional(),
     /** Stage classification values. */
     stage: z.array(z.string()).optional(),
-    /** OR exact tuples within this facet; AND with other facets. */
+    /** Matches any one of these entries; combined with the other filters by AND. */
     standardizedClassification: z.array(StandardizedClassificationFilterSchema).max(20).optional(),
     /** Exclude public and acquired companies (including acquired subsidiaries); what startup means. Private companies at any round stay, as do companies without a recorded stage or operating status. */
     suppressLateStage: z.boolean().nullish(),
@@ -127,9 +127,9 @@ export const EntityListFilterSchema = z.strictObject({
     typeRecord: z.array(EntityTypeSchema).optional(),
     /** Revenue-model classification values. */
     typeRevenue: z.array(z.string()).optional(),
-    /** Technology-used classification values. */
+    /** Technology-used values. */
     typeTechnologyUsed: z.array(z.string()).optional(),
-    /** OR public-registry identifier predicates; AND with other facets. */
+    /** Matches any listed registry identifier; combined with other filters by AND. */
     uniqueId: z.array(EntityUniqueIdFilterSchema).max(20).optional(),
     /** Current URL to match by normalized host and path. */
     url: z.string().nullish(),

package/dist/entity/list-quality-gate.d.ts

@@ -1,6 +1,6 @@
 import { z } from "zod/v4";
 /**
- * Named quality gates for entity list endpoints.
+ * Extra check on listed entities. COMPANY_LISTING_READY returns only operating companies and business lines that have a real (not generated) logo, a founding year, a current headquarters, and recorded positive funding with a stage; NONE applies no extra check.
  *
  * @openapiSchema EntityListQualityGate
  * @endpoint GET /v1/search/link

package/dist/entity/list-quality-gate.js

@@ -1,7 +1,7 @@
 // LLM AGENTS MAY NOT EDIT THIS FILE UNDER ANY CIRCUMSTANCES. DO NOT EDIT - generated from Kotlin data classes via OpenAPI. Edit the backend owner and run: make docs-openapi && make docs-zod
 import { z } from "zod/v4";
 /**
- * Named quality gates for entity list endpoints.
+ * Extra check on listed entities. COMPANY_LISTING_READY returns only operating companies and business lines that have a real (not generated) logo, a founding year, a current headquarters, and recorded positive funding with a stage; NONE applies no extra check.
  *
  * @openapiSchema EntityListQualityGate
  * @endpoint GET /v1/search/link

package/dist/entity/list-research.d.ts

@@ -161,7 +161,7 @@ type EntityListResearchDefinition = z.infer<typeof EntityListResearchSchemaDefin
 export interface EntityListResearchSchemaInput extends z.input<typeof EntityListResearchSchemaDefinition> {
 }
 /**
- * Nested research projection owned by EntityList rows, excluding snippet text.
+ * Research findings included in each entity list row, without snippet text.
  *
  * @openapiSchema EntityListResearch
  * @endpoint GET /v1/search/link

package/dist/entity/list-research.js

@@ -3,13 +3,13 @@ import { z } from "zod/v4";
 import { EntityAcceleratorParticipationSchema } from "./accelerator-participation.js";
 import { EntityResearchDetailSchema } from "./research-detail.js";
 const EntityListResearchSchemaDefinition = z.object({
-    /** Joined accelerator participation derived from governed accelerator research rows */
+    /** Accelerator programs the entity took part in, derived from its accelerator research records */
     acceleratorParticipation: z.array(EntityAcceleratorParticipationSchema),
-    /** Flat governed research detail rows filtered by visibility */
+    /** Structured research details the caller is allowed to see */
     detail: z.array(EntityResearchDetailSchema),
 });
 /**
- * Nested research projection owned by EntityList rows, excluding snippet text.
+ * Research findings included in each entity list row, without snippet text.
  *
  * @openapiSchema EntityListResearch
  * @endpoint GET /v1/search/link

package/dist/entity/list.d.ts

@@ -1436,7 +1436,7 @@ type EntityListDefinition = z.infer<typeof EntityListSchemaDefinition>;
 export interface EntityListSchemaInput extends z.input<typeof EntityListSchemaDefinition> {
 }
 /**
- * Narrow entity row for list and batch-list reads. Keeps core identity, enrichment, governed research detail, accelerator participation, and fundraise rounds while omitting detail-only relationship, newsArticle, person, sitemap, and research snippet sections. Classification enrichment is current-only on list rows; use the entity classifications subresource with includeInactive=true to audit historical joins. Addresses are bounded current-location samples, not a complete office inventory; use the entity addresses subresource to list every office and association.
+ * Entity row returned by list and batch-list reads. It includes core identity, additional data, research details, accelerator participation, and funding rounds, but not the relationship, newsArticle, person, sitemap, and research snippet sections that detail reads return. List rows show only current classifications; to see past ones, call the entity classifications endpoint with includeInactive=true. Addresses are a few current locations, not every office; use the entity addresses endpoint to list every office and association.
  *
  * @openapiSchema EntityList
  * @endpoint GET /v1/search/link

package/dist/entity/list.js

@@ -10,7 +10,7 @@ import { EntityProviderSchema } from "./provider.js";
 const EntityListSchemaDefinition = z.object({
     /** Public buyer of the newest completed acquisition; null for announced or non-public buyers. */
     acquirer: EntitySchema.nullish(),
-    /** Flat entity core — identity, naming, status, image, and source metadata */
+    /** Core fields of the entity: identity, names, status, image, and source details */
     core: EntitySchema,
     /** The queued or running full-research run covering this record, whoever filed it; set only on federated search result and subject rows, null when none and on every other list read. */
     coveringRunId: z.uuid().nullish(),
@@ -22,13 +22,13 @@ const EntityListSchemaDefinition = z.object({
     profileStatus: EntityProfileStatusSchema.optional(),
     /** Fund manager firm or product/service provider; null otherwise. */
     provider: EntityProviderSchema.nullish(),
-    /** List-safe research disclosure without text snippets */
+    /** Research findings for list rows, without the written snippets */
     research: EntityListResearchSchema,
-    /** Semantic embedding match evidence populated only for semantic list reads. */
+    /** Why this row matched a meaning-based (semantic) search; set only on semantic searches. */
     semanticMatch: ContentEmbeddingMatchSchema.nullish(),
 });
 /**
- * Narrow entity row for list and batch-list reads. Keeps core identity, enrichment, governed research detail, accelerator participation, and fundraise rounds while omitting detail-only relationship, newsArticle, person, sitemap, and research snippet sections. Classification enrichment is current-only on list rows; use the entity classifications subresource with includeInactive=true to audit historical joins. Addresses are bounded current-location samples, not a complete office inventory; use the entity addresses subresource to list every office and association.
+ * Entity row returned by list and batch-list reads. It includes core identity, additional data, research details, accelerator participation, and funding rounds, but not the relationship, newsArticle, person, sitemap, and research snippet sections that detail reads return. List rows show only current classifications; to see past ones, call the entity classifications endpoint with includeInactive=true. Addresses are a few current locations, not every office; use the entity addresses endpoint to list every office and association.
  *
  * @openapiSchema EntityList
  * @endpoint GET /v1/search/link

package/dist/entity/natural-search.js

@@ -5,7 +5,7 @@ import { NaturalSearchSchema } from "../natural/search.js";
 const EntityNaturalSearchSchemaDefinition = z.object({
     /** Explicit entity constraints. Caller-supplied fields override planner values; the planner fills only fields left at their canonical defaults. */
     filter: EntityFilterSchema.optional(),
-    /** Canonical plain-English search request and strategy. */
+    /** The plain-English search request and the search method to use. */
     search: NaturalSearchSchema,
     /** The stored aVenture news article this search started from. Its approved public Company and Business Line mentions are ordered subjects, rather than candidates judged from the headline. An unknown or non-public article, or one without such mentions, keeps the ordinary search. */
     sourceNewsId: z.int().min(1).nullish(),

package/dist/entity/person-association.js

@@ -44,38 +44,38 @@ export const EntityPersonAssociationSchema = z.object({
         .string()
         .regex(/^(?!0000)[0-9]{4}(?:-(?:0[1-9]|1[0-2])(?:-(?:0[1-9]|[12][0-9]|3[01])(?:T(?:[01][0-9]|2[0-3]):[0-5][0-9](?::[0-5][0-9](?:\.[0-9]{1,9})?)?(?:Z|[+-](?:(?:0[0-9]|1[0-7]):[0-5][0-9]|18:00)))?)?)?$/)
         .nullish(),
-    /** Entity addresses carried on the association projection. Person detail carries at most one: the entity's current headquarters, else its most recently updated current address; GET /v1/entities/{entityId}/addresses lists them all */
+    /** The entity's addresses. Person detail includes at most one: the entity's current headquarters, else its most recently updated current address; GET /v1/entities/{entityId}/addresses lists them all */
     entityAddress: z.array(AddressSchema),
     /** Associated entity id */
     entityId: z.uuid(),
-    /** Entity logo image projection */
+    /** The entity's logo fields. */
     entityLogo: EntityImageSchema,
     entityName: z.string().nullish(),
     entityOperatingStatus: z.string().nullish(),
-    /** Canonical lowercase URL slug for the resource */
+    /** Lowercase URL slug that identifies the record. */
     entitySlug: z
         .string()
         .regex(/^[a-z0-9_-]+$/)
         .max(255),
     /** Entity type classification */
     entityType: EntityTypeSchema.nullish(),
-    /** Entity URL links carried on the association projection */
+    /** The entity's URL links. */
     entityUrlLink: z.array(EntityUrlLinkSchema),
     /** True only while the association has no endDate; any endDate means it ended */
     isCurrent: z.boolean().nullish(),
-    /** Person addresses carried on the association projection */
+    /** The person's addresses. */
     personAddress: z.array(AddressSchema),
     /** Associated person id */
     personId: z.uuid(),
-    /** Person image projection */
+    /** The person's image fields. */
     personImage: PersonImageSchema,
     personName: z.string(),
-    /** Canonical lowercase URL slug for the resource */
+    /** Lowercase URL slug that identifies the record. */
     personSlug: z
         .string()
         .regex(/^[a-z0-9_-]+$/)
         .max(255),
-    /** Person URL links carried on the association projection */
+    /** The person's URL links. */
     personUrlLink: z.array(EntityUrlLinkSchema),
     score: z.int().nullish(),
     /** Association period start, preserving source precision */
@@ -83,13 +83,13 @@ export const EntityPersonAssociationSchema = z.object({
         .string()
         .regex(/^(?!0000)[0-9]{4}(?:-(?:0[1-9]|1[0-2])(?:-(?:0[1-9]|[12][0-9]|3[01])(?:T(?:[01][0-9]|2[0-3]):[0-5][0-9](?::[0-5][0-9](?:\.[0-9]{1,9})?)?(?:Z|[+-](?:(?:0[0-9]|1[0-7]):[0-5][0-9]|18:00)))?)?)?$/)
         .nullish(),
-    /** Read-side corporate title function for the association row */
+    /** Job function of the title (read-only). */
     titleFunction: z.string().nullish(),
     /** Corporate title id for the association row */
     titleId: z.int().nullish(),
-    /** Read-side corporate title level for the association row */
+    /** Seniority level of the title (read-only). */
     titleLevel: z.string().nullish(),
-    /** Read-side corporate title text for the association row */
+    /** Job title text for this role (read-only). */
     titleName: z.string().nullish(),
 });
 //# sourceMappingURL=person-association.js.map

package/dist/entity/provider.d.ts

@@ -1,6 +1,6 @@
 import { z } from "zod/v4";
 /**
- * The current entity a fund or product/service is offered by: a fund's manager organization, a product/service's provider, through its current primary edge to a live, listed provider. Null on every other entity type.
+ * The current entity a fund or product/service is offered by: a fund's manager organization, a product/service's provider, through its current primary relationship to a live, publicly listed provider. Null on every other entity type.
  *
  * @openapiSchema EntityProvider
  * @endpoint GET /v1/entities/lookup-exact

package/dist/entity/provider.js

@@ -3,7 +3,7 @@ import { z } from "zod/v4";
 import { AddressSchema } from "../address/address.js";
 import { EntitySchema } from "./entity.js";
 /**
- * The current entity a fund or product/service is offered by: a fund's manager organization, a product/service's provider, through its current primary edge to a live, listed provider. Null on every other entity type.
+ * The current entity a fund or product/service is offered by: a fund's manager organization, a product/service's provider, through its current primary relationship to a live, publicly listed provider. Null on every other entity type.
  *
  * @openapiSchema EntityProvider
  * @endpoint GET /v1/entities/lookup-exact

package/dist/entity/relationship-type-option.js

@@ -4,7 +4,7 @@ import { RelationshipDirectionSchema } from "../relationship/direction.js";
 const EntityRelationshipTypeOptionSchemaDefinition = z.object({
     /** Whether this type must be written through acquisition endpoints. */
     acquisitionManaged: z.boolean(),
-    /** Accepted aliases that normalize to canonical. */
+    /** Other spellings accepted for this relationship type. */
     alias: z.array(z.string()),
     /** Canonical relationship type token used in reads and writes. */
     canonical: z.string(),
@@ -16,7 +16,7 @@ const EntityRelationshipTypeOptionSchemaDefinition = z.object({
     exclusiveRelationshipType: z.array(z.string()),
     /** Whether generic relationship join/write endpoints accept this type. */
     joinable: z.boolean(),
-    /** Entity type pairing rule enforced before persistence. */
+    /** Which entity types may be on each side of this relationship; writes that break it are rejected. */
     pairRule: z.string(),
     /** Whether this type is emitted by reads only and rejected on writes. */
     readOnly: z.boolean(),

package/dist/entity/relationship.d.ts

@@ -341,7 +341,7 @@ type EntityRelationshipDefinition = z.infer<typeof EntityRelationshipSchemaDefin
 export interface EntityRelationshipSchemaInput extends z.input<typeof EntityRelationshipSchemaDefinition> {
 }
 /**
- * Domain record for entity relationships - oriented from the requested entity to the joined entity
+ * A relationship between two entities, described from the requested entity toward the related one
  *
  * @openapiSchema EntityRelationship
  * @endpoint GET /v1/entities/lookup-exact

package/dist/entity/relationship.js

@@ -17,7 +17,7 @@ const EntityRelationshipSchemaDefinition = z.object({
     detail: z.string().nullish(),
     /** Joined entity on the other side of this relationship — read-only display projection. Writes name one endpoint in the URL path and the other in targetEntityId; the relationship type determines stored orientation. */
     entity: EntitySchema,
-    /** Integer entity_relationship.id row id, not an entity UUID */
+    /** Integer id of the relationship record, not an entity UUID */
     id: z.int().nullish(),
     /** Whether this relationship is current. Default relationship reads return only rows where isCurrent=true and isPrimary=true. */
     isCurrent: z.boolean().nullish(),
@@ -40,7 +40,7 @@ const EntityRelationshipSchemaDefinition = z.object({
     updatedAt: z.iso.datetime({ offset: true }).nullish(),
 });
 /**
- * Domain record for entity relationships - oriented from the requested entity to the joined entity
+ * A relationship between two entities, described from the requested entity toward the related one
  *
  * @openapiSchema EntityRelationship
  * @endpoint GET /v1/entities/lookup-exact

package/dist/entity/research-detail.js

@@ -16,7 +16,7 @@ const EntityResearchDetailSchemaDefinition = z.object({
     /** Read-only range derived only for targetDateAbsolute detail rows */
     derivedRange: ResearchDerivedRangeSchema.nullish(),
     discreteValue: z.number().nullish(),
-    /** Canonical entity UUID */
+    /** Entity id (UUID) */
     entityId: z.uuid(),
     id: z.int(),
     /** Source-stated measurement/accounting basis; null means unknown. */

package/dist/entity/research-fact-value.d.ts

@@ -28,7 +28,7 @@ type EntityResearchFactValueDefinition = z.infer<typeof EntityResearchFactValueS
 export interface EntityResearchFactValueSchemaInput extends z.input<typeof EntityResearchFactValueSchemaDefinition> {
 }
 /**
- * Canonical typed fact value nested under entity research fields
+ * A typed research fact value, nested under the entity's research fields
  *
  * @openapiSchema EntityResearchFactValue
  * @endpoint GET /v1/entities/lookup-exact

package/dist/entity/research-fact-value.js

@@ -8,7 +8,7 @@ const EntityResearchFactValueSchemaDefinition = z.object({
         .string()
         .regex(/^(?!0000)[0-9]{4}(?:-(?:0[1-9]|1[0-2])(?:-(?:0[1-9]|[12][0-9]|3[01])(?:T(?:[01][0-9]|2[0-3]):[0-5][0-9](?::[0-5][0-9](?:\.[0-9]{1,9})?)?(?:Z|[+-](?:(?:0[0-9]|1[0-7]):[0-5][0-9]|18:00)))?)?)?$/)
         .nullish(),
-    /** Current-fact eligibility projected from the canonical research detail row. */
+    /** Whether this fact counts as current, taken from its research detail. */
     currentEligible: z.boolean().nullish(),
     dataConfidence: EntityValuationDataConfidenceSchema.nullish(),
     /** Date-valued research fact, preserving the source's year, month, day, or timestamp precision. */
@@ -30,7 +30,7 @@ const EntityResearchFactValueSchemaDefinition = z.object({
     valueType: EntityResearchValueTypeSchema,
 });
 /**
- * Canonical typed fact value nested under entity research fields
+ * A typed research fact value, nested under the entity's research fields
  *
  * @openapiSchema EntityResearchFactValue
  * @endpoint GET /v1/entities/lookup-exact

package/dist/entity/research-snippet.js

@@ -29,9 +29,9 @@ import { EntityResearchPublicSourceSchema } from "./research-public-source.js";
  * @contractRole canonical
  */
 export const EntityResearchSnippetSchema = z.object({
-    /** Derived character/word counts and governed-contract compliance for this snippet row; null when not evaluated. */
+    /** Character and word counts for this snippet and whether it meets its type's length and paragraph rules; null when not checked. */
     compliance: ContentComplianceSchema.nullish(),
-    /** Canonical entity UUID */
+    /** Entity id (UUID) */
     entityId: z.uuid(),
     id: z.int(),
     /** Published page behind this value, read from the provenance event that wrote it; absent for internal sources. */

package/dist/entity/research-value-type.d.ts

@@ -1,6 +1,6 @@
 import { z } from "zod/v4";
 /**
- * Output kind for governed research detail values
+ * Kind of value a research detail holds
  *
  * @openapiSchema EntityResearchValueType
  * @endpoint GET /v1/entities/lookup-exact

package/dist/entity/research-value-type.js

@@ -1,7 +1,7 @@
 // LLM AGENTS MAY NOT EDIT THIS FILE UNDER ANY CIRCUMSTANCES. DO NOT EDIT - generated from Kotlin data classes via OpenAPI. Edit the backend owner and run: make docs-openapi && make docs-zod
 import { z } from "zod/v4";
 /**
- * Output kind for governed research detail values
+ * Kind of value a research detail holds
  *
  * @openapiSchema EntityResearchValueType
  * @endpoint GET /v1/entities/lookup-exact

package/dist/entity/research.d.ts

@@ -180,7 +180,7 @@ type EntityResearchDefinition = z.infer<typeof EntityResearchSchemaDefinition>;
 export interface EntityResearchSchemaInput extends z.input<typeof EntityResearchSchemaDefinition> {
 }
 /**
- * Combined entity research disclosure: governed detail rows, research text snippets, and joined accelerator participation.
+ * Research findings for an entity: structured research details, written research snippets, and accelerator participation.
  *
  * @openapiSchema EntityResearch
  * @endpoint GET /v1/entities/lookup-exact

package/dist/entity/research.js

@@ -4,15 +4,15 @@ import { EntityAcceleratorParticipationSchema } from "./accelerator-participatio
 import { EntityResearchDetailSchema } from "./research-detail.js";
 import { EntityResearchSnippetSchema } from "./research-snippet.js";
 const EntityResearchSchemaDefinition = z.object({
-    /** Joined accelerator participation derived from governed accelerator research rows */
+    /** Accelerator programs the entity took part in, derived from its accelerator research records */
     acceleratorParticipation: z.array(EntityAcceleratorParticipationSchema),
-    /** Flat governed research detail rows filtered by visibility */
+    /** Structured research details the caller is allowed to see */
     detail: z.array(EntityResearchDetailSchema),
     /** Research text snippets for this entity */
     snippet: z.array(EntityResearchSnippetSchema),
 });
 /**
- * Combined entity research disclosure: governed detail rows, research text snippets, and joined accelerator participation.
+ * Research findings for an entity: structured research details, written research snippets, and accelerator participation.
  *
  * @openapiSchema EntityResearch
  * @endpoint GET /v1/entities/lookup-exact

package/dist/entity/similarity-summary.d.ts

@@ -263,7 +263,7 @@ type EntitySimilaritySummaryDefinition = z.infer<typeof EntitySimilaritySummaryS
 export interface EntitySimilaritySummarySchemaInput extends z.input<typeof EntitySimilaritySummarySchemaDefinition> {
 }
 /**
- * Lean similar-entity rail row: core identity, current URL links, funding totals, and similarity provenance. Use EntitySimilarityResult for full EntityList rows.
+ * Short similar-entity card: core identity, current URL links, funding totals, and why it counts as similar. Use EntitySimilarityResult for full EntityList rows.
  *
  * @openapiSchema EntitySimilaritySummary
  * @endpoint GET /v1/entities/{entityId}/similar/summary

package/dist/entity/similarity-summary.js

@@ -13,7 +13,7 @@ const EntitySimilaritySummarySchemaDefinition = z.object({
     urlLink: z.array(EntityUrlLinkSchema),
 });
 /**
- * Lean similar-entity rail row: core identity, current URL links, funding totals, and similarity provenance. Use EntitySimilarityResult for full EntityList rows.
+ * Short similar-entity card: core identity, current URL links, funding totals, and why it counts as similar. Use EntitySimilarityResult for full EntityList rows.
  *
  * @openapiSchema EntitySimilaritySummary
  * @endpoint GET /v1/entities/{entityId}/similar/summary

package/dist/entity/sitemap.d.ts

@@ -1,6 +1,6 @@
 import { z } from "zod/v4";
 /**
- * Sub-route eligibility GATE for sitemap.xml emission, not a write receipt. Each boolean is true only when the underlying rows EXIST AND every entity that sub-route renders (this entity and any counterpart, e.g. the acquired/acquirer company behind `hasAcquisitions`) currently passes publication visibility (not hidden, on sitemap). Served from a materialized projection that a scheduled refresh rebuilds; refresh requests made soon after a completed refresh are skipped until the next scheduled run, so polling sooner changes nothing. A `false` flag whose qualifying write committed after the last refresh started is refresh lag that clears on the next refresh. A `false` flag whose write predates that refresh is the gate result: an unmet visibility prerequisite -- publish the hidden entity -- confirmed against the owning command-side read.
+ * Which of the entity's profile pages are listed in sitemap.xml; this does not confirm that a write succeeded. Each flag is true only when the page's data EXISTS AND every entity the page shows (this entity and any other, such as the acquired or acquiring company behind `hasAcquisitions`) is currently publicly visible (not hidden, and included in the sitemap). Flags come from a precomputed view that a scheduled refresh rebuilds; a refresh requested soon after a completed one waits for the next scheduled run, so polling sooner changes nothing. A `false` flag whose qualifying write committed after the last refresh started clears on the next refresh. A `false` flag whose write predates that refresh means an entity the page shows is still hidden: publish it, after checking that entity's own record.
  *
  * @openapiSchema EntitySitemap
  * @endpoint GET /v1/entities/brand

package/dist/entity/sitemap.js

@@ -1,7 +1,7 @@
 // LLM AGENTS MAY NOT EDIT THIS FILE UNDER ANY CIRCUMSTANCES. DO NOT EDIT - generated from Kotlin data classes via OpenAPI. Edit the backend owner and run: make docs-openapi && make docs-zod
 import { z } from "zod/v4";
 /**
- * Sub-route eligibility GATE for sitemap.xml emission, not a write receipt. Each boolean is true only when the underlying rows EXIST AND every entity that sub-route renders (this entity and any counterpart, e.g. the acquired/acquirer company behind `hasAcquisitions`) currently passes publication visibility (not hidden, on sitemap). Served from a materialized projection that a scheduled refresh rebuilds; refresh requests made soon after a completed refresh are skipped until the next scheduled run, so polling sooner changes nothing. A `false` flag whose qualifying write committed after the last refresh started is refresh lag that clears on the next refresh. A `false` flag whose write predates that refresh is the gate result: an unmet visibility prerequisite -- publish the hidden entity -- confirmed against the owning command-side read.
+ * Which of the entity's profile pages are listed in sitemap.xml; this does not confirm that a write succeeded. Each flag is true only when the page's data EXISTS AND every entity the page shows (this entity and any other, such as the acquired or acquiring company behind `hasAcquisitions`) is currently publicly visible (not hidden, and included in the sitemap). Flags come from a precomputed view that a scheduled refresh rebuilds; a refresh requested soon after a completed one waits for the next scheduled run, so polling sooner changes nothing. A `false` flag whose qualifying write committed after the last refresh started clears on the next refresh. A `false` flag whose write predates that refresh means an entity the page shows is still hidden: publish it, after checking that entity's own record.
  *
  * @openapiSchema EntitySitemap
  * @endpoint GET /v1/entities/brand
@@ -48,15 +48,15 @@ import { z } from "zod/v4";
  * @contractRole canonical
  */
 export const EntitySitemapSchema = z.object({
-    /** Whether `/companies/<slug>/acquisitions` should be emitted. True only when an acquisition relationship exists AND both the acquired and acquirer entities are publicly visible. `entities acquisitions list` returning zero rows for a confirmed acquisition relationship always means a counterpart entity is still hidden -- publish it; that list reads live rows and never lags. A `false` flag on a row newer than the last refresh is refresh lag (see `EntitySitemap`). */
+    /** Whether `/companies/<slug>/acquisitions` is listed in the sitemap. True only when an acquisition relationship exists AND both the acquired and acquirer entities are publicly visible. `entities acquisitions list` returning zero rows for a confirmed acquisition relationship always means a counterpart entity is still hidden -- publish it; that list reads live rows and never lags. A `false` flag on a row newer than the last refresh is refresh lag (see `EntitySitemap`). */
     hasAcquisitions: z.boolean().default(false).optional(),
-    /** Whether the profile Analysis sub-route should be emitted. */
+    /** Whether the entity's Analysis profile page is listed in the sitemap. */
     hasAnalysis: z.boolean(),
-    /** Whether the profile Employees sub-route should be emitted. */
+    /** Whether the entity's Employees profile page is listed in the sitemap. */
     hasEmployees: z.boolean(),
-    /** Whether the profile Fundraising sub-route should be emitted. */
+    /** Whether the entity's Fundraising profile page is listed in the sitemap. */
     hasFundraising: z.boolean(),
-    /** Whether the profile News sub-route should be emitted. */
+    /** Whether the entity's News profile page is listed in the sitemap. */
     hasNews: z.boolean(),
     /** Slugs of related Product/Service entities that should each get their own `/companies/<slug>/products-services/<productSlug>` URL, capped at `MAX_PRODUCT_SERVICE_SLUGS` server-side. Derived from current `productService` relationships in either stored direction; the entity relationships resource is the authoritative, read-your-writes view of those joins. */
     productServiceSlug: z.array(z.string()),

package/dist/entity/tag.js

@@ -42,7 +42,7 @@ import { ClassificationSchema } from "../classification/classification.js";
  * @contractRole canonical
  */
 export const EntityTagSchema = z.intersection(ClassificationSchema, z.object({
-    /** Canonical classification bucket key; `type` is the value tag search and the catalog accept. */
+    /** Classification bucket key; tag search and the classification catalog accept this value as `type`. */
     bucket: z.string().nullish(),
     /** Id of this classification on the entity; null in catalog and search results. */
     classificationId: z.int().nullish(),

package/dist/entity/text.d.ts

@@ -26,7 +26,7 @@ type EntityTextDefinition = z.infer<typeof EntityTextSchemaDefinition>;
 export interface EntityTextSchemaInput extends z.input<typeof EntityTextSchemaDefinition> {
 }
 /**
- * Canonical entity/person text read record
+ * A text record, such as a description, of an entity or person.
  *
  * @openapiSchema EntityText
  * @endpoint GET /v1/entities/{entityId}/texts