@aventurevc/api-schemas 0.8.224 → 0.8.225

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -9,7 +9,7 @@ type EntityDetailBatchDefinition = z.infer<typeof EntityDetailBatchSchemaDefinit
9
9
  export interface EntityDetailBatchSchemaInput extends z.input<typeof EntityDetailBatchSchemaDefinition> {
10
10
  }
11
11
  /**
12
- * Batch request for entity detail retrieval by id, slug, or current joined URL. Each identifier array accepts at most 200 values, and at most 200 identifiers may be submitted across entityId, slug, and url.
12
+ * Batch request for entity detail retrieval by id, slug, or current joined URL. Each identifier array accepts at most 200 values, and at most 200 identifiers may be submitted across entityId, slug, and url. It takes no names: identify a company by name with lookupRecord and its name field.
13
13
  *
14
14
  * @openapiSchema EntityDetailBatch
15
15
  * @endpoint POST /v1/entities/lookup-batch
@@ -24,7 +24,7 @@ const EntityDetailBatchSchemaDefinition = z
24
24
  }
25
25
  });
26
26
  /**
27
- * Batch request for entity detail retrieval by id, slug, or current joined URL. Each identifier array accepts at most 200 values, and at most 200 identifiers may be submitted across entityId, slug, and url.
27
+ * Batch request for entity detail retrieval by id, slug, or current joined URL. Each identifier array accepts at most 200 values, and at most 200 identifiers may be submitted across entityId, slug, and url. It takes no names: identify a company by name with lookupRecord and its name field.
28
28
  *
29
29
  * @openapiSchema EntityDetailBatch
30
30
  * @endpoint POST /v1/entities/lookup-batch
@@ -106,7 +106,7 @@ export const EntityFilterSchema = z.strictObject({
106
106
  suppressZeroTotalRaised: z.boolean().nullish(),
107
107
  /** General classification tag values. */
108
108
  tag: z.array(z.string()).optional(),
109
- /** Non-blank keyword/full-text search term. Use natural-search for plain-English or multi-constraint company requests. */
109
+ /** Non-blank company-identity search term: it matches only brand names, legal names, slugs, and name aliases (including near spellings of them), never descriptions, products, or topics. A topic, sector, or market word such as "climate" or "corporate card" returns no rows or name lookalikes here: filter by the industry, tag, mainProduct, or other classification fields, send the phrase as semanticQuery on POST /v1/entities/search, or ask natural search for plain-English or multi-constraint company requests. */
110
110
  textSearch: z.string().nullish(),
111
111
  /** Customer-type classification values. */
112
112
  typeCustomer: z.array(z.string()).optional(),
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Entity list filters and saved-view query state including semantic entity search. semanticQuery executes on GET /v1/entities and POST /v1/entities/search; saved views persist it for replay. Every other reused EntityFilter surface accepts the base EntityFilter, which omits semanticQuery. There is no query field: send free text describing the companies as semanticQuery, a keyword as textSearch, or a known company name as entityName.
3
+ * Entity list filters and saved-view query state including semantic entity search. semanticQuery executes on GET /v1/entities and POST /v1/entities/search; saved views persist it for replay. Every other reused EntityFilter surface accepts the base EntityFilter, which omits semanticQuery. There is no query field: send free text describing the companies as semanticQuery, a word of a company's name, legal name, slug, or alias as textSearch, or a known company name as entityName.
4
4
  *
5
5
  * @openapiSchema EntityListFilter
6
6
  * @endpoint GET /v1/search/link
@@ -9,7 +9,7 @@ import { EntityUrlTypeSchema } from "./url-type.js";
9
9
  import { IntRangeSchema } from "../int/range.js";
10
10
  import { UrlMatchModeSchema } from "../url/match-mode.js";
11
11
  /**
12
- * Entity list filters and saved-view query state including semantic entity search. semanticQuery executes on GET /v1/entities and POST /v1/entities/search; saved views persist it for replay. Every other reused EntityFilter surface accepts the base EntityFilter, which omits semanticQuery. There is no query field: send free text describing the companies as semanticQuery, a keyword as textSearch, or a known company name as entityName.
12
+ * Entity list filters and saved-view query state including semantic entity search. semanticQuery executes on GET /v1/entities and POST /v1/entities/search; saved views persist it for replay. Every other reused EntityFilter surface accepts the base EntityFilter, which omits semanticQuery. There is no query field: send free text describing the companies as semanticQuery, a word of a company's name, legal name, slug, or alias as textSearch, or a known company name as entityName.
13
13
  *
14
14
  * @openapiSchema EntityListFilter
15
15
  * @endpoint GET /v1/search/link
@@ -104,7 +104,7 @@ export const EntityListFilterSchema = z.strictObject({
104
104
  suppressZeroTotalRaised: z.boolean().nullish(),
105
105
  /** General classification tag values. */
106
106
  tag: z.array(z.string()).optional(),
107
- /** Non-blank keyword/full-text search term. Use natural-search for plain-English or multi-constraint company requests. */
107
+ /** Non-blank company-identity search term: it matches only brand names, legal names, slugs, and name aliases (including near spellings of them), never descriptions, products, or topics. A topic, sector, or market word such as "climate" or "corporate card" returns no rows or name lookalikes here: filter by the industry, tag, mainProduct, or other classification fields, send the phrase as semanticQuery on POST /v1/entities/search, or ask natural search for plain-English or multi-constraint company requests. */
108
108
  textSearch: z.string().nullish(),
109
109
  /** Customer-type classification values. */
110
110
  typeCustomer: z.array(z.string()).optional(),
@@ -9345,6 +9345,7 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
9345
9345
  };
9346
9346
  }[] | null | undefined;
9347
9347
  }, import("../person/detail.ts").PersonDetailSchemaInput>>>;
9348
+ personLead: z.ZodBoolean;
9348
9349
  provenance: z.ZodType<{
9349
9350
  answerUnavailable: boolean;
9350
9351
  entity: {
@@ -21,6 +21,8 @@ const FederatedSearchSchemaDefinition = z.object({
21
21
  person: PersonNaturalSearchResultSchema,
22
22
  /** Public detail for people on the person result page, in search rank order, with at most two public entity associations per person; person address and URL enrichment is omitted. */
23
23
  personDetail: z.array(PersonDetailSchema),
24
+ /** Whether people lead this page: the query names a person, a web-found person's profile shows, or the query asks for people by a search catalog people term. */
25
+ personLead: z.boolean(),
24
26
  /** Requested and executed strategy for each search scope. */
25
27
  provenance: FederatedSearchProvenanceSchema,
26
28
  /** A prompt with rewritten queries offered beside a broad query's results, from the search catalog revision the search read; null when no qualifier rule matches. */
@@ -60,6 +60,7 @@ declare const HarnessRunDetailSchemaDefinition: z.ZodObject<{
60
60
  hasMore: z.ZodBoolean;
61
61
  runId: z.ZodArray<z.ZodUUID>;
62
62
  }, z.core.$strip>>;
63
+ lastEventAt: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
63
64
  latestStatus: z.ZodOptional<z.ZodNullable<z.ZodObject<{
64
65
  complete: z.ZodBoolean;
65
66
  entitySlug: z.ZodNullable<z.ZodString>;
@@ -9,6 +9,8 @@ const HarnessRunDetailSchemaDefinition = z.object({
9
9
  entity: EntitySchema.nullish(),
10
10
  /** Follow-up admission and direct child run ids for this terminal generation */
11
11
  followUp: HarnessRunFollowUpSchema.optional(),
12
+ /** Time the run's newest stream event was recorded; null when the run has no events. A running run whose value stops advancing has stalled */
13
+ lastEventAt: z.iso.datetime({ offset: true }).nullish(),
12
14
  /** Latest research progress; null when none is available */
13
15
  latestStatus: HarnessRunProgressSchema.nullish(),
14
16
  /** Parent organization's core record when the resolved entity is a Product/Service; null for every other entity type */
@@ -4718,6 +4718,7 @@ declare const LinkSearchSchemaDefinition: z.ZodObject<{
4718
4718
  };
4719
4719
  }[] | null | undefined;
4720
4720
  }[];
4721
+ personLead: boolean;
4721
4722
  provenance: {
4722
4723
  answerUnavailable: boolean;
4723
4724
  entity: {
@@ -9464,6 +9465,7 @@ declare const LinkSearchSchemaDefinition: z.ZodObject<{
9464
9465
  };
9465
9466
  }[] | null | undefined;
9466
9467
  }[];
9468
+ personLead: boolean;
9467
9469
  provenance: {
9468
9470
  answerUnavailable: boolean;
9469
9471
  entity: {
@@ -23,9 +23,9 @@ export const PersonLookupExactParamSchema = z.object({
23
23
  location: z.string().optional(),
24
24
  /** Projection qualifier — max association values to return; bounded internally to the association limit. Default: 40. */
25
25
  maxAssociations: z.int().optional(),
26
- /** Group C — candidate lookup signal: loose name match (any of given/family/full). Combine with other group-C signals for disambiguation. Mutually exclusive with id and slug; may be combined with url for fallback. */
26
+ /** Group C — candidate lookup signal: loose name match (any of given/family/full). A name alone never resolves; combine it with other group-C signals or url. Mutually exclusive with id and slug. */
27
27
  nameAny: z.string().optional(),
28
- /** Group C — candidate lookup signal: person full name. Combine with other group-C signals (nameAny, location, urlDomain) for bounded candidate search. Mutually exclusive with id and slug; may be combined with url for fallback. */
28
+ /** Group C — candidate lookup signal: person full name. A name alone never resolves (404): pair it with other group-C signals (location, urlDomain) or url. To find a person by name, use lookupRecord with kind PERSON; for the people at a company, use listEntityPersonAssociations. Mutually exclusive with id and slug. */
29
29
  nameFull: z.string().optional(),
30
30
  /** Permit generated monogram photo fallback (default: true). Set false to exclude monogram photos in response. */
31
31
  permitMonogram: z.boolean().optional(),
@@ -1,5 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  declare const SearchHitSchemaDefinition: z.ZodObject<{
3
+ image: z.ZodOptional<z.ZodNullable<z.ZodString>>;
3
4
  relevanceScore: z.ZodNumber;
4
5
  snippet: z.ZodString;
5
6
  title: z.ZodString;
@@ -1,6 +1,8 @@
1
1
  // 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
2
2
  import { z } from "zod/v4";
3
3
  const SearchHitSchemaDefinition = z.object({
4
+ /** Image the provider attached to this result (a LinkedIn profile's headshot); null when it attached none. */
5
+ image: z.string().nullish(),
4
6
  relevanceScore: z.number(),
5
7
  snippet: z.string(),
6
8
  title: z.string(),
@@ -15,7 +15,7 @@ const SearchPersonProfileSchemaDefinition = z.object({
15
15
  named: z.string(),
16
16
  /** Where the profile names the organization the query paired with the person: in its headline, elsewhere in the profile text, or not at all; null when the query named no organization. */
17
17
  organizationEvidence: z.enum(["headline", "profile", "none"]).nullish(),
18
- /** Headshot URL from aVenture's stored LinkedIn capture; null until one is stored or when the capture holds no usable headshot. */
18
+ /** Headshot URL: the web search index's LinkedIn headshot until aVenture's stored LinkedIn capture supplies one; null when neither holds a usable headshot. */
19
19
  photoUrl: z.string().nullish(),
20
20
  /** Canonical aVenture person page URL; never an external profile URL. */
21
21
  profileUrl: z.string(),
@@ -4729,6 +4729,7 @@ declare const SharedSearchSchemaDefinition: z.ZodObject<{
4729
4729
  };
4730
4730
  }[] | null | undefined;
4731
4731
  }[];
4732
+ personLead: boolean;
4732
4733
  provenance: {
4733
4734
  answerUnavailable: boolean;
4734
4735
  entity: {
@@ -9475,6 +9476,7 @@ declare const SharedSearchSchemaDefinition: z.ZodObject<{
9475
9476
  };
9476
9477
  }[] | null | undefined;
9477
9478
  }[];
9479
+ personLead: boolean;
9478
9480
  provenance: {
9479
9481
  answerUnavailable: boolean;
9480
9482
  entity: {
@@ -80,11 +80,13 @@ declare const WebSearchSchemaDefinition: z.ZodObject<{
80
80
  }, import("../search/related-question.ts").SearchRelatedQuestionSchemaInput>>>>>;
81
81
  relatedSearch: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
82
82
  result: z.ZodArray<z.ZodType<{
83
+ image?: string | null | undefined;
83
84
  relevanceScore: number;
84
85
  snippet: string;
85
86
  title: string;
86
87
  url: string;
87
88
  }, import("../search/hit.ts").SearchHitSchemaInput, z.core.$ZodTypeInternals<{
89
+ image?: string | null | undefined;
88
90
  relevanceScore: number;
89
91
  snippet: string;
90
92
  title: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aventurevc/api-schemas",
3
- "version": "0.8.224",
3
+ "version": "0.8.225",
4
4
  "private": false,
5
5
  "description": "Zod v4 schemas and TypeScript types for the aVenture API.",
6
6
  "license": "Apache-2.0",