@aventurevc/api-schemas 0.8.418 → 0.8.419
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.
package/dist/entity/filter.js
CHANGED
|
@@ -74,7 +74,7 @@ export const EntityFilterSchema = z.strictObject({
|
|
|
74
74
|
investorPopulation: z.boolean().nullish(),
|
|
75
75
|
/** First letter of the display name. */
|
|
76
76
|
letter: z.string().nullish(),
|
|
77
|
-
/**
|
|
77
|
+
/** Markets served, not HQ or offices. */
|
|
78
78
|
location: z.array(z.string()).optional(),
|
|
79
79
|
/** Logo sort priority. */
|
|
80
80
|
logoOption: EntityFilterLogoOptionSchema.optional(),
|
|
@@ -70,7 +70,7 @@ export const EntityListFilterSchema = z.strictObject({
|
|
|
70
70
|
investorPopulation: z.boolean().nullish(),
|
|
71
71
|
/** First letter of the display name. */
|
|
72
72
|
letter: z.string().nullish(),
|
|
73
|
-
/**
|
|
73
|
+
/** Markets served, not HQ or offices. */
|
|
74
74
|
location: z.array(z.string()).optional(),
|
|
75
75
|
/** Logo sort priority. */
|
|
76
76
|
logoOption: EntityFilterLogoOptionSchema.optional(),
|
|
@@ -94,7 +94,7 @@ export const EntityListFilterSchema = z.strictObject({
|
|
|
94
94
|
qualityGate: EntityListQualityGateSchema.optional(),
|
|
95
95
|
/** Rank most prominent first (funding, stage, headcount, momentum, recent news, investor breadth), ahead of sort: what best, top, or most promising mean. */
|
|
96
96
|
rankByProminence: z.boolean().nullish(),
|
|
97
|
-
/** Free-text semantic search phrase, this body's query text (there is no query field), such as "AI tools for dental clinics".
|
|
97
|
+
/** Free-text semantic search phrase, this body's query text (there is no query field), such as "AI tools for dental clinics". For an existing-record name read, send this body's entityName field instead, compare the returned candidates' identity fields and evidenced URLs, then read the confirmed id. Search results are candidates, not identity verdicts; an empty result means no visible match for those filters, not permission to file. Use universal lookup (POST /v1/lookup) only when its possible filing effect is intended; it accepts name, not entityName. Executable on POST /v1/entities/search; saved views persist it for replay. A semantic page ranks a bounded nearest-neighbor window: totalElements counts the ranked candidates reachable through continuation, not every matching entity. */
|
|
98
98
|
semanticQuery: z.string().nullish(),
|
|
99
99
|
/** Restrict results to entity slugs. */
|
|
100
100
|
slug: z
|
|
@@ -25,7 +25,7 @@ export const PersonLookupExactParamSchema = z.object({
|
|
|
25
25
|
maxAssociations: z.int().optional(),
|
|
26
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. A name alone never resolves (404): pair it with other group-C signals (location, urlDomain) or url. To find
|
|
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 an existing person by name, use searchPeople with personName, compare candidate identity fields, roles, and evidenced URLs, then read the confirmed id. Search results are candidates, not identity verdicts. Choose universal lookup only when its possible filing effect is intended. 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(),
|