@aventurevc/api-schemas 0.8.396 → 0.8.398

package/dist/lookup/job-mention.js

@@ -6,11 +6,11 @@ import { EntityPersonOwnerSchema } from "../entity/person-owner.js";
 import { IdentificationSchema } from "../identification/identification.js";
 import { PersonSchema } from "../person/person.js";
 const LookupJobMentionSchemaDefinition = z.object({
-    /** POST /v1/lookup/mentions only: the current titled role of the highest-ranked listed person that has one (its personId names whom); null when none does. */
+    /** The current titled role, at a company aVenture shows publicly, of the highest-ranked listed person visible to the caller that has one (its personId names whom); null when none does or omitRecords is true. A bulk lookup job reads it on each status read. */
     currentRole: EntityPersonAssociationSchema.nullish(),
     /** Research request filed for this mention, if any. */
     enrichmentRunId: z.uuid().nullish(),
-    /** POST /v1/lookup/mentions only: the candidate companies as search results show them, the match first, then by match probability and duplicate-check score. */
+    /** The candidate companies as search results show them, the match first, then by match probability and duplicate-check score; empty when omitRecords is true. */
     entity: z.array(EntityListSchema),
     /** One sentence on why this name could not be identified, if not. */
     failureReason: z.string().nullish(),
@@ -20,7 +20,7 @@ const LookupJobMentionSchemaDefinition = z.object({
     mentionType: z.enum(["COMPANY", "PERSON", "PRODUCT_SERVICE"]),
     /** Name as the source writes it. */
     name: z.string(),
-    /** POST /v1/lookup/mentions only: the candidate people as search results show them, ranked like entity. */
+    /** The candidate people as search results show them, ranked like entity; empty when omitRecords is true. */
     person: z.array(PersonSchema),
     /** New record aVenture created, at no charge, for a NO_MATCH name whose own live site names it: a company public and a person hidden unless publishCreated says otherwise. enrichmentRunId names research filed for it, if any; to file research yourself, send its entityId to POST /v1/entities/{entityId}/enrichments or its personId to POST /v1/people/{personId}/enrichments. */
     shell: EntityPersonOwnerSchema.nullish(),

package/dist/lookup/job-mutation.js

@@ -7,7 +7,7 @@ const LookupJobMutationSchemaDefinition = z.object({
     deterministic: z.boolean().optional(),
     /** Companies and people the caller already read, identified without sending the page or screenshot. Send them alone, without an article or file. On lookup jobs, maxNames is required and no records are created and no research is requested. */
     mention: z.array(LookupMentionSchema).optional(),
-    /** POST /v1/lookup/mentions only: true answers each name with only its name, mentionType, failureReason, and identification status, stage, match, officialUrl, and detail: no entity or person rows and empty candidate and duplicate lists. Defaults to false, the full answer. */
+    /** True answers each name with only its name, mentionType, failureReason, and identification status, stage, match, officialUrl, and detail: no entity or person rows and empty candidate and duplicate lists. Defaults to false. */
     omitRecords: z.boolean().optional(),
     /** Id of a stored source document whose text is the article; send it alone. Only POST /v1/lookup/mentions without maxNames reads it. An event-stream request with Prefer respond-async, source-read accepts any signed-in user's own captured PDF; every other read needs editing rights. */
     sourceDocumentId: z.uuid().nullish(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aventurevc/api-schemas",
-  "version": "0.8.396",
+  "version": "0.8.398",
   "private": false,
   "description": "Zod v4 schemas and TypeScript types for the aVenture API.",
   "license": "Apache-2.0",