@aventurevc/api-schemas 0.8.175 → 0.8.176
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.
|
@@ -13,6 +13,7 @@ export declare const EntityInvestorsParamSchema: z.ZodObject<{
|
|
|
13
13
|
page: z.ZodOptional<z.ZodInt>;
|
|
14
14
|
size: z.ZodOptional<z.ZodInt>;
|
|
15
15
|
sort: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
|
|
16
|
+
compact: z.ZodOptional<z.ZodBoolean>;
|
|
16
17
|
cursor: z.ZodOptional<z.ZodString>;
|
|
17
18
|
permitMonogram: z.ZodOptional<z.ZodBoolean>;
|
|
18
19
|
}, z.core.$strip>;
|
|
@@ -12,6 +12,8 @@ export const ENTITY_INVESTORS_ENDPOINT = "/v1/entities/{entityId}/investors";
|
|
|
12
12
|
* @contractRole canonical
|
|
13
13
|
*/
|
|
14
14
|
export const EntityInvestorsParamSchema = PageParamSchema.extend({
|
|
15
|
+
/** Set true to return each investor's own profile with its people, news, funding rounds, relationships, and research as empty lists, not absent fields; the profile's sitemap flags still show which of them exist. Responses are much smaller. */
|
|
16
|
+
compact: z.boolean().optional(),
|
|
15
17
|
/** Opaque URL-safe cursor token from X-Next-Cursor. Reuse the same filters and sort. */
|
|
16
18
|
cursor: z.string().optional(),
|
|
17
19
|
/** Permit generated monogram fallback */
|
package/dist/help/resolution.js
CHANGED
|
@@ -20,7 +20,7 @@ export const HelpResolutionSchema = z.object({
|
|
|
20
20
|
operationId: z.string().nullish(),
|
|
21
21
|
/** Which of the mutually exclusive resolve outcomes was reached. */
|
|
22
22
|
outcome: HelpResolutionOutcomeSchema,
|
|
23
|
-
/**
|
|
23
|
+
/** Confidence, 0 to 1, in the chosen option (an operation, a catalog task, several, or none). A low-confidence choice becomes CLARIFY, listing the candidates. */
|
|
24
24
|
probability: z.number().nullish(),
|
|
25
25
|
/** The chosen catalog task for TASK_PLAN, or the task leading a CLARIFY. */
|
|
26
26
|
taskKey: z.string().nullish(),
|
|
@@ -25,7 +25,7 @@ export const IdentificationCandidateSchema = z.object({
|
|
|
25
25
|
domainAgreement: z.enum(["MATCH", "CONFLICT", "UNKNOWN"]).nullish(),
|
|
26
26
|
/** How this record was checked as the picked record stored again; absent when it was not checked. */
|
|
27
27
|
duplicateBasis: z.enum(["STUB", "SHARED_FACT", "JUDGED"]).nullish(),
|
|
28
|
-
/**
|
|
28
|
+
/** Probability, 0 to 1, that this record is the picked record stored again; present only when duplicateBasis is JUDGED. */
|
|
29
29
|
duplicateProbability: z.number().nullish(),
|
|
30
30
|
/** The year the entity was founded, when stored; absent for people and records without one. */
|
|
31
31
|
foundedYear: z.int().nullish(),
|
|
@@ -18,7 +18,7 @@ import { EntityTypeSchema } from "../entity/type.js";
|
|
|
18
18
|
export const IdentificationSubjectSchema = z.object({
|
|
19
19
|
/** Specific facts in plain words: product, industry, employer and title, or founder names. Generic words like startup add nothing. */
|
|
20
20
|
context: z.string().max(2000).nullish(),
|
|
21
|
-
/** Kind of record to identify when you know it;
|
|
21
|
+
/** Kind of record to identify when you know it; only that kind is looked up. typeRecord or providerId implies ENTITY. */
|
|
22
22
|
kind: z.enum(["ENTITY", "PERSON"]).nullish(),
|
|
23
23
|
/** City, region, or country, such as Austin, TX. Tells namesakes apart; not proof on its own. */
|
|
24
24
|
location: z.string().max(2000).nullish(),
|
|
@@ -7,7 +7,7 @@ import { PersonSchema } from "../person/person.js";
|
|
|
7
7
|
const LookupJobMentionSchemaDefinition = z.object({
|
|
8
8
|
/** Research request filed for this mention, if any. */
|
|
9
9
|
enrichmentRunId: z.uuid().nullish(),
|
|
10
|
-
/** POST /v1/lookup-mentions only: the candidate companies as search results show them, the match first, then by
|
|
10
|
+
/** POST /v1/lookup-mentions only: the candidate companies as search results show them, the match first, then by match probability and duplicate-check score. */
|
|
11
11
|
entity: z.array(EntityListSchema),
|
|
12
12
|
/** One sentence on why this name could not be identified; absent otherwise. */
|
|
13
13
|
failureReason: z.string().nullish(),
|