@aventurevc/api-schemas 0.8.375 → 0.8.376
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/address/address.d.ts +1 -1
- package/dist/address/address.js +1 -1
- package/dist/agent/task-preset-catalog.js +1 -1
- package/dist/agent/task-preset-phase.d.ts +1 -1
- package/dist/agent/task-preset-phase.js +1 -1
- package/dist/agent/task-preset.js +1 -1
- package/dist/auth/operation-authorization.d.ts +1 -1
- package/dist/auth/operation-authorization.js +2 -2
- package/dist/blog/post-type.d.ts +1 -1
- package/dist/blog/post-type.js +1 -1
- package/dist/blog/post.d.ts +1 -1
- package/dist/blog/post.js +2 -2
- package/dist/classification/catalog-bucket.js +1 -1
- package/dist/classification/catalog-category.js +1 -1
- package/dist/classification/join-registry.d.ts +1 -1
- package/dist/classification/join-registry.js +1 -1
- package/dist/cli/authorization-poll.js +1 -1
- package/dist/cli/authorization.js +1 -1
- package/dist/content/compliance.d.ts +1 -1
- package/dist/content/compliance.js +2 -2
- package/dist/content/embedding-match.d.ts +1 -1
- package/dist/content/embedding-match.js +3 -3
- package/dist/content/source-type.d.ts +1 -1
- package/dist/content/source-type.js +1 -1
- package/dist/datasource/source-metadata.d.ts +1 -1
- package/dist/datasource/source-metadata.js +1 -1
- package/dist/enrichment/batch.js +2 -2
- package/dist/entity/accelerator-participation.d.ts +1 -1
- package/dist/entity/accelerator-participation.js +3 -3
- package/dist/entity/acquisition.js +5 -5
- package/dist/entity/analysis-replay.js +1 -1
- package/dist/entity/brand.d.ts +1 -1
- package/dist/entity/brand.js +1 -1
- package/dist/entity/comparison-signals.d.ts +1 -1
- package/dist/entity/comparison-signals.js +1 -1
- package/dist/entity/detail.d.ts +1 -1
- package/dist/entity/detail.js +3 -3
- package/dist/entity/entity.d.ts +1 -1
- package/dist/entity/entity.js +3 -3
- package/dist/entity/filter-control-type.d.ts +1 -1
- package/dist/entity/filter-control-type.js +1 -1
- package/dist/entity/filter-meta.d.ts +1 -1
- package/dist/entity/filter-meta.js +2 -2
- package/dist/entity/filter-option-set-meta.d.ts +1 -1
- package/dist/entity/filter-option-set-meta.js +1 -1
- package/dist/entity/filter-request-value-shape.d.ts +1 -1
- package/dist/entity/filter-request-value-shape.js +1 -1
- package/dist/entity/filter.js +6 -6
- package/dist/entity/fundraise-investor-join.d.ts +1 -1
- package/dist/entity/fundraise-investor-join.js +1 -1
- package/dist/entity/fundraise-transaction-entity.d.ts +1 -1
- package/dist/entity/fundraise-transaction-entity.js +1 -1
- package/dist/entity/fundraise-transaction.d.ts +1 -1
- package/dist/entity/fundraise-transaction.js +2 -2
- package/dist/entity/fundraise.js +1 -1
- package/dist/entity/list-filter.js +6 -6
- package/dist/entity/list-quality-gate.d.ts +1 -1
- package/dist/entity/list-quality-gate.js +1 -1
- package/dist/entity/list-research.d.ts +1 -1
- package/dist/entity/list-research.js +3 -3
- package/dist/entity/list.d.ts +1 -1
- package/dist/entity/list.js +4 -4
- package/dist/entity/natural-search.js +1 -1
- package/dist/entity/person-association.js +11 -11
- package/dist/entity/provider.d.ts +1 -1
- package/dist/entity/provider.js +1 -1
- package/dist/entity/relationship-type-option.js +2 -2
- package/dist/entity/relationship.d.ts +1 -1
- package/dist/entity/relationship.js +2 -2
- package/dist/entity/research-detail.js +1 -1
- package/dist/entity/research-fact-value.d.ts +1 -1
- package/dist/entity/research-fact-value.js +2 -2
- package/dist/entity/research-snippet.js +2 -2
- package/dist/entity/research-value-type.d.ts +1 -1
- package/dist/entity/research-value-type.js +1 -1
- package/dist/entity/research.d.ts +1 -1
- package/dist/entity/research.js +3 -3
- package/dist/entity/similarity-summary.d.ts +1 -1
- package/dist/entity/similarity-summary.js +1 -1
- package/dist/entity/sitemap.js +5 -5
- package/dist/entity/tag.js +1 -1
- package/dist/entity/text.d.ts +1 -1
- package/dist/entity/text.js +4 -4
- package/dist/entity/type-alias.d.ts +1 -1
- package/dist/entity/type-alias.js +2 -2
- package/dist/entity/type-group-membership.d.ts +1 -1
- package/dist/entity/type-group-membership.js +1 -1
- package/dist/entity/type-group.d.ts +1 -1
- package/dist/entity/type-group.js +1 -1
- package/dist/entity/type.d.ts +1 -1
- package/dist/entity/type.js +1 -1
- package/dist/entity/url-link.d.ts +1 -1
- package/dist/entity/url-link.js +2 -2
- package/dist/entity/valuation-source.d.ts +1 -1
- package/dist/entity/valuation-source.js +1 -1
- package/dist/entity/valuation-time-series-point.js +2 -2
- package/dist/federated/search-provenance.js +3 -3
- package/dist/federated/search.d.ts +1 -1
- package/dist/federated/search.js +2 -2
- package/dist/fundraise/investment-evidence.d.ts +1 -1
- package/dist/fundraise/investment-evidence.js +1 -1
- package/dist/github/repo.js +1 -1
- package/dist/harness/chassis.d.ts +1 -1
- package/dist/harness/chassis.js +1 -1
- package/dist/harness/llm-api.d.ts +1 -1
- package/dist/harness/llm-api.js +1 -1
- package/dist/harness/research-outcome.d.ts +1 -1
- package/dist/harness/research-outcome.js +1 -1
- package/dist/harness/run-detail.js +1 -1
- package/dist/harness/run-event.js +1 -1
- package/dist/harness/run-follow-up-admission.d.ts +1 -1
- package/dist/harness/run-follow-up-admission.js +1 -1
- package/dist/harness/run-follow-up.d.ts +1 -1
- package/dist/harness/run-follow-up.js +4 -4
- package/dist/harness/run-lane.d.ts +1 -1
- package/dist/harness/run-lane.js +1 -1
- package/dist/harness/run-progress.js +1 -1
- package/dist/harness/run.js +9 -9
- package/dist/harness/task-input-binding.js +2 -2
- package/dist/harness/task-input-type.d.ts +1 -1
- package/dist/harness/task-input-type.js +1 -1
- package/dist/harness/task-plan.js +1 -1
- package/dist/harness/task-write-guidance.js +1 -1
- package/dist/help/source-type.d.ts +1 -1
- package/dist/help/source-type.js +1 -1
- package/dist/http/problem-detail.js +2 -2
- package/dist/identification/candidate.js +2 -2
- package/dist/identification/identification.js +2 -2
- package/dist/investor/portfolio-recipient.d.ts +1 -1
- package/dist/investor/portfolio-recipient.js +1 -1
- package/dist/lookup/job.js +2 -2
- package/dist/lookup/source-read.d.ts +1 -1
- package/dist/lookup/source-read.js +2 -2
- package/dist/natural/search-result.d.ts +1 -1
- package/dist/natural/search-result.js +3 -3
- package/dist/natural/search.d.ts +1 -1
- package/dist/natural/search.js +1 -1
- package/dist/news/analysis.js +1 -1
- package/dist/news/detail.d.ts +1 -1
- package/dist/news/detail.js +1 -1
- package/dist/news/news.d.ts +1 -1
- package/dist/news/news.js +3 -3
- package/dist/news/resolved-entity-link.js +2 -2
- package/dist/news/resolved-person-link.js +2 -2
- package/dist/news/source-url-conflict.js +1 -1
- package/dist/person/detail.d.ts +1 -1
- package/dist/person/detail.js +1 -1
- package/dist/person/filter.d.ts +1 -1
- package/dist/person/filter.js +1 -1
- package/dist/person/graph-career-context.js +2 -2
- package/dist/person/graph-co-investor.js +2 -2
- package/dist/person/graph-member.d.ts +1 -1
- package/dist/person/graph-member.js +4 -4
- package/dist/person/graph-similar-entity.js +1 -1
- package/dist/person/graph.d.ts +1 -1
- package/dist/person/graph.js +1 -1
- package/dist/person/image.d.ts +1 -1
- package/dist/person/image.js +1 -1
- package/dist/person/investment.d.ts +1 -1
- package/dist/person/investment.js +2 -2
- package/dist/person/lookup-exact-param.js +4 -4
- package/dist/person/natural-search-result.d.ts +1 -1
- package/dist/person/natural-search-result.js +2 -2
- package/dist/person/natural-search.js +1 -1
- package/dist/person/person.d.ts +1 -1
- package/dist/person/person.js +5 -5
- package/dist/redirect/current-slug-owner.d.ts +1 -1
- package/dist/redirect/current-slug-owner.js +1 -1
- package/dist/research/allowance-usage.js +1 -1
- package/dist/research/derived-range.d.ts +1 -1
- package/dist/research/derived-range.js +1 -1
- package/dist/research/detail-type.js +1 -1
- package/dist/research/paragraph-shape.d.ts +1 -1
- package/dist/research/paragraph-shape.js +1 -1
- package/dist/research/snippet-type.d.ts +1 -1
- package/dist/research/snippet-type.js +3 -3
- package/dist/search/cache-mode.d.ts +1 -1
- package/dist/search/cache-mode.js +1 -1
- package/dist/search/investment.d.ts +1 -1
- package/dist/search/investment.js +1 -1
- package/dist/search/mode-execution.d.ts +1 -1
- package/dist/search/mode-execution.js +2 -2
- package/dist/sec/company.js +1 -1
- package/dist/shared/directory-list.js +1 -1
- package/dist/shared/search-list.js +1 -1
- package/dist/source/document-list.d.ts +1 -1
- package/dist/source/document-list.js +3 -3
- package/dist/stage/frequency.d.ts +1 -1
- package/dist/stage/frequency.js +1 -1
- package/dist/standardized/classification-filter.js +1 -1
- package/dist/text/type-option.d.ts +1 -1
- package/dist/text/type-option.js +5 -5
- package/dist/unique/id-mutation.js +1 -1
- package/dist/unique/id-type-alias.d.ts +1 -1
- package/dist/unique/id-type-alias.js +3 -3
- package/dist/unique/id.js +1 -1
- package/dist/url/duplicate-conflict.js +2 -2
- package/dist/url/duplicate-join.d.ts +1 -1
- package/dist/url/duplicate-join.js +1 -1
- package/dist/url/type-alias.d.ts +1 -1
- package/dist/url/type-alias.js +2 -2
- package/dist/web/search.js +1 -1
- package/dist/writer/claim-surface.d.ts +1 -1
- package/dist/writer/claim-surface.js +1 -1
- package/package.json +1 -1
|
@@ -7,7 +7,7 @@ const InvestorPortfolioRecipientSchemaDefinition = z.object({
|
|
|
7
7
|
funding: EntityFundingDetailSchema,
|
|
8
8
|
});
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
10
|
+
* A portfolio recipient and the funding aVenture has recorded for it.
|
|
11
11
|
*
|
|
12
12
|
* @openapiSchema InvestorPortfolioRecipient
|
|
13
13
|
* @endpoint GET /v1/entities/lookup-exact
|
package/dist/lookup/job.js
CHANGED
|
@@ -19,7 +19,7 @@ const LookupJobSchemaDefinition = z.object({
|
|
|
19
19
|
jobId: z.uuid(),
|
|
20
20
|
/** True when a bulk lookup returned its name bound; more names may remain. False does not prove that extraction found every name on a page. */
|
|
21
21
|
limitReached: z.boolean(),
|
|
22
|
-
/**
|
|
22
|
+
/** Most names a bulk lookup accepts; absent for older article jobs. */
|
|
23
23
|
maxNames: z.int().nullish(),
|
|
24
24
|
/** Each identified company and person; bulk results are available while running. */
|
|
25
25
|
mention: z.array(LookupJobMentionSchema),
|
|
@@ -31,7 +31,7 @@ const LookupJobSchemaDefinition = z.object({
|
|
|
31
31
|
news: NewsSchema.nullish(),
|
|
32
32
|
/** The article the job reads or names supplied for a bulk lookup. */
|
|
33
33
|
source: LookupJobMutationSchema,
|
|
34
|
-
/**
|
|
34
|
+
/** Reading progress for an accepted, stored lookup of a shared article, post, or profile. */
|
|
35
35
|
sourceRead: LookupSourceReadSchema.nullish(),
|
|
36
36
|
/** Current job state. */
|
|
37
37
|
state: JobStateSchema,
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { z } from "zod/v4";
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* The shared article, post, or profile, or the caller's own captured document, being read, and what the server is doing with it now.
|
|
4
4
|
*
|
|
5
5
|
* @openapiSchema LookupSourceRead
|
|
6
6
|
* @endpoint GET /v1/lookup/jobs/{jobId}
|
|
@@ -4,7 +4,7 @@ import { JobEnqueueSchema } from "../job/enqueue.js";
|
|
|
4
4
|
import { LookupSourceKindSchema } from "./source-kind.js";
|
|
5
5
|
import { LookupSourceReadPhaseSchema } from "./source-read-phase.js";
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
7
|
+
* The shared article, post, or profile, or the caller's own captured document, being read, and what the server is doing with it now.
|
|
8
8
|
*
|
|
9
9
|
* @openapiSchema LookupSourceRead
|
|
10
10
|
* @endpoint GET /v1/lookup/jobs/{jobId}
|
|
@@ -18,7 +18,7 @@ export const LookupSourceReadSchema = z.object({
|
|
|
18
18
|
/** A committed durable lookup to follow; only its presence permits a promise to leave and return. Follow its status URL with the same caller's bearer, honoring Retry-After. */
|
|
19
19
|
continuation: JobEnqueueSchema.nullish(),
|
|
20
20
|
faviconUrl: z.string().nullish(),
|
|
21
|
-
/** What the source is, so a client names it while it loads; absent only on
|
|
21
|
+
/** What the source is, so a client names it while it loads; absent only on lookups accepted before this field existed. */
|
|
22
22
|
kind: LookupSourceKindSchema.nullish(),
|
|
23
23
|
logoUrl: z.string().nullish(),
|
|
24
24
|
/** Informational messages to cycle within this stage, never evidence of completed work. */
|
|
@@ -6064,7 +6064,7 @@ type NaturalSearchResultDefinition = z.infer<typeof NaturalSearchResultSchemaDef
|
|
|
6064
6064
|
export interface NaturalSearchResultSchemaInput extends z.input<typeof NaturalSearchResultSchemaDefinition> {
|
|
6065
6065
|
}
|
|
6066
6066
|
/**
|
|
6067
|
-
*
|
|
6067
|
+
* Result of a plain-English entity search: how the query was interpreted, and the resulting page of entities.
|
|
6068
6068
|
*
|
|
6069
6069
|
* @openapiSchema NaturalSearchResult
|
|
6070
6070
|
* @endpoint GET /v1/search/link
|
|
@@ -28,9 +28,9 @@ const NaturalSearchResultSchemaDefinition = z.object({
|
|
|
28
28
|
peer: z.array(EntitySimilarityResultSchema),
|
|
29
29
|
/** Web searches for this question not yet stored; their evidence joins a later request. Empty without the `web` layer. */
|
|
30
30
|
pendingWebQuery: z.array(z.string()),
|
|
31
|
-
/** Whether
|
|
31
|
+
/** Whether this search is mainly about people; set only on entity events in the stream. */
|
|
32
32
|
personLead: z.boolean(),
|
|
33
|
-
/**
|
|
33
|
+
/** Page of matching entities. */
|
|
34
34
|
result: PageResultEntityListSchema,
|
|
35
35
|
/** Id of this search's stored record. Null when the search was not recorded. */
|
|
36
36
|
searchRequestId: z.uuid().nullish(),
|
|
@@ -38,7 +38,7 @@ const NaturalSearchResultSchemaDefinition = z.object({
|
|
|
38
38
|
subject: z.array(EntityListSchema),
|
|
39
39
|
});
|
|
40
40
|
/**
|
|
41
|
-
*
|
|
41
|
+
* Result of a plain-English entity search: how the query was interpreted, and the resulting page of entities.
|
|
42
42
|
*
|
|
43
43
|
* @openapiSchema NaturalSearchResult
|
|
44
44
|
* @endpoint GET /v1/search/link
|
package/dist/natural/search.d.ts
CHANGED
|
@@ -54,7 +54,7 @@ type NaturalSearchDefinition = z.infer<typeof NaturalSearchSchemaDefinition>;
|
|
|
54
54
|
export interface NaturalSearchSchemaInput extends z.input<typeof NaturalSearchSchemaDefinition> {
|
|
55
55
|
}
|
|
56
56
|
/**
|
|
57
|
-
* Plain-English search request. The server
|
|
57
|
+
* Plain-English search request. The server turns the query into a filter and sort for the target record type, then runs that type's standard list search.
|
|
58
58
|
*
|
|
59
59
|
* @openapiSchema NaturalSearch
|
|
60
60
|
* @endpoint POST /v1/content/search
|
package/dist/natural/search.js
CHANGED
|
@@ -27,7 +27,7 @@ const NaturalSearchSchemaDefinition = z.object({
|
|
|
27
27
|
tenantPolicyRevision: z.int().nullish(),
|
|
28
28
|
});
|
|
29
29
|
/**
|
|
30
|
-
* Plain-English search request. The server
|
|
30
|
+
* Plain-English search request. The server turns the query into a filter and sort for the target record type, then runs that type's standard list search.
|
|
31
31
|
*
|
|
32
32
|
* @openapiSchema NaturalSearch
|
|
33
33
|
* @endpoint POST /v1/content/search
|
package/dist/news/analysis.js
CHANGED
|
@@ -12,7 +12,7 @@ import { NewsAnalysisSectionSchema } from "./analysis-section.js";
|
|
|
12
12
|
* @contractRole canonical
|
|
13
13
|
*/
|
|
14
14
|
export const NewsAnalysisSchema = z.object({
|
|
15
|
-
/**
|
|
15
|
+
/** Identifier of a news article */
|
|
16
16
|
newsId: z.int(),
|
|
17
17
|
publishedAt: z.iso.datetime({ offset: true }),
|
|
18
18
|
section: z.array(NewsAnalysisSectionSchema),
|
package/dist/news/detail.d.ts
CHANGED
|
@@ -135,7 +135,7 @@ type NewsDetailDefinition = z.infer<typeof NewsDetailSchemaDefinition>;
|
|
|
135
135
|
export interface NewsDetailSchemaInput extends z.input<typeof NewsDetailSchemaDefinition> {
|
|
136
136
|
}
|
|
137
137
|
/**
|
|
138
|
-
*
|
|
138
|
+
* A news article with all of its detail fields.
|
|
139
139
|
*
|
|
140
140
|
* @openapiSchema NewsDetail
|
|
141
141
|
* @endpoint GET /v1/news/lookup
|
package/dist/news/detail.js
CHANGED
|
@@ -19,7 +19,7 @@ const NewsDetailSchemaDefinition = z.object({
|
|
|
19
19
|
personMentionResolved: z.array(NewsResolvedPersonLinkSchema),
|
|
20
20
|
});
|
|
21
21
|
/**
|
|
22
|
-
*
|
|
22
|
+
* A news article with all of its detail fields.
|
|
23
23
|
*
|
|
24
24
|
* @openapiSchema NewsDetail
|
|
25
25
|
* @endpoint GET /v1/news/lookup
|
package/dist/news/news.d.ts
CHANGED
package/dist/news/news.js
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
import { z } from "zod/v4";
|
|
3
3
|
import { NewsTitleMentionSchema } from "./title-mention.js";
|
|
4
4
|
/**
|
|
5
|
-
*
|
|
5
|
+
* A news article, as returned by news lists and the entity.news.published webhook.
|
|
6
6
|
*
|
|
7
7
|
* @openapiSchema News
|
|
8
8
|
* @endpoint GET /v1/entities/lookup-exact
|
|
@@ -46,14 +46,14 @@ export const NewsSchema = z.object({
|
|
|
46
46
|
/** Article summary from the source publication feed; null means the feed supplied no description (expected absence, not an error) — full text is NewsDetail.content */
|
|
47
47
|
excerpt: z.string().nullish(),
|
|
48
48
|
externalNewsArticle: z.boolean().nullish(),
|
|
49
|
-
/**
|
|
49
|
+
/** Identifier of a news article */
|
|
50
50
|
id: z.int(),
|
|
51
51
|
newsImageThumbnail: z.string().nullish(),
|
|
52
52
|
/** Canonical article URL after host and tracking-parameter normalization. */
|
|
53
53
|
newsUrlOriginal: z.string().nullish(),
|
|
54
54
|
publication: z.string().nullish(),
|
|
55
55
|
publishedAt: z.iso.datetime({ offset: true }).nullish(),
|
|
56
|
-
/**
|
|
56
|
+
/** Lowercase URL slug that identifies the record. */
|
|
57
57
|
slug: z
|
|
58
58
|
.string()
|
|
59
59
|
.regex(/^[a-z0-9_-]+$/)
|
|
@@ -37,14 +37,14 @@ import { NewsMatchStatusSchema } from "./match-status.js";
|
|
|
37
37
|
*/
|
|
38
38
|
export const NewsResolvedEntityLinkSchema = z.object({
|
|
39
39
|
createdAt: z.iso.datetime({ offset: true }),
|
|
40
|
-
/**
|
|
40
|
+
/** Entity id (UUID) */
|
|
41
41
|
entityId: z.uuid(),
|
|
42
42
|
href: z.string().nullish(),
|
|
43
43
|
/** True when href links to this entity's aVenture page; false when the entity has no page to link to. */
|
|
44
44
|
internal: z.boolean(),
|
|
45
45
|
matchStatus: NewsMatchStatusSchema.nullish(),
|
|
46
46
|
mention: z.string().nullish(),
|
|
47
|
-
/**
|
|
47
|
+
/** Lowercase URL slug that identifies the record. */
|
|
48
48
|
slug: z
|
|
49
49
|
.string()
|
|
50
50
|
.regex(/^[a-z0-9_-]+$/)
|
|
@@ -38,9 +38,9 @@ export const NewsResolvedPersonLinkSchema = z.object({
|
|
|
38
38
|
href: z.string().nullish(),
|
|
39
39
|
matchStatus: NewsMatchStatusSchema.nullish(),
|
|
40
40
|
mention: z.string().nullish(),
|
|
41
|
-
/**
|
|
41
|
+
/** Person id (UUID) */
|
|
42
42
|
personId: z.uuid(),
|
|
43
|
-
/**
|
|
43
|
+
/** Lowercase URL slug that identifies the record. */
|
|
44
44
|
slug: z
|
|
45
45
|
.string()
|
|
46
46
|
.regex(/^[a-z0-9_-]+$/)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
import { z } from "zod/v4";
|
|
3
3
|
import { DomainConflictTypeSchema } from "../domain/conflict-type.js";
|
|
4
4
|
const NewsSourceUrlConflictSchemaDefinition = z.object({
|
|
5
|
-
/**
|
|
5
|
+
/** Id of the existing article that already has this publication and URL. */
|
|
6
6
|
conflictingArticleId: z.int(),
|
|
7
7
|
/** Existing article slug, or empty string when the existing article has no slug. Use with GET /v1/news/lookup?slug= to fetch the conflicting article. */
|
|
8
8
|
conflictingArticleSlug: z.string(),
|
package/dist/person/detail.d.ts
CHANGED
|
@@ -2395,7 +2395,7 @@ type PersonDetailDefinition = z.infer<typeof PersonDetailSchemaDefinition>;
|
|
|
2395
2395
|
export interface PersonDetailSchemaInput extends z.input<typeof PersonDetailSchemaDefinition> {
|
|
2396
2396
|
}
|
|
2397
2397
|
/**
|
|
2398
|
-
*
|
|
2398
|
+
* Full person detail: core identity, additional data, associations, and investments. Core fields are under core (for example .core.slug or .core.nameFull).
|
|
2399
2399
|
*
|
|
2400
2400
|
* @openapiSchema PersonDetail
|
|
2401
2401
|
* @endpoint GET /v1/entities/lookup-exact
|
package/dist/person/detail.js
CHANGED
|
@@ -32,7 +32,7 @@ const PersonDetailSchemaDefinition = z.object({
|
|
|
32
32
|
similar: z.array(PersonSimilarityResultSchema).nullish(),
|
|
33
33
|
});
|
|
34
34
|
/**
|
|
35
|
-
*
|
|
35
|
+
* Full person detail: core identity, additional data, associations, and investments. Core fields are under core (for example .core.slug or .core.nameFull).
|
|
36
36
|
*
|
|
37
37
|
* @openapiSchema PersonDetail
|
|
38
38
|
* @endpoint GET /v1/entities/lookup-exact
|
package/dist/person/filter.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { z } from "zod/v4";
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* Filters for listing and searching people, used by the GET, POST, and batch people endpoints.
|
|
4
4
|
*
|
|
5
5
|
* @openapiSchema PersonFilter
|
|
6
6
|
* @endpoint GET /v1/search/link
|
package/dist/person/filter.js
CHANGED
|
@@ -6,7 +6,7 @@ import { InvestorActivityFilterSchema } from "../investor/activity-filter.js";
|
|
|
6
6
|
import { PersonAssociationTenureSchema } from "./association-tenure.js";
|
|
7
7
|
import { PersonListArrayFilterSchema } from "./list-array-filter.js";
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* Filters for listing and searching people, used by the GET, POST, and batch people endpoints.
|
|
10
10
|
*
|
|
11
11
|
* @openapiSchema PersonFilter
|
|
12
12
|
* @endpoint GET /v1/search/link
|
|
@@ -11,13 +11,13 @@ const PersonGraphCareerContextSchemaDefinition = z.object({
|
|
|
11
11
|
colleague: z.array(PersonGraphMemberSchema),
|
|
12
12
|
/** Most recent employee-count research fact when one is recorded */
|
|
13
13
|
employeeCount: EmployeeCountSchema.nullish(),
|
|
14
|
-
/** Entity card
|
|
14
|
+
/** Entity card: core identity plus total funding */
|
|
15
15
|
entity: EntityFundraiseTransactionEntitySchema,
|
|
16
16
|
/** Primary address of the entity when one is recorded */
|
|
17
17
|
primaryAddress: AddressSchema.nullish(),
|
|
18
18
|
/** Most recent news linked to the entity, newest first */
|
|
19
19
|
recentNews: z.array(NewsSchema),
|
|
20
|
-
/** Entities similar to this entity, from
|
|
20
|
+
/** Entities similar to this entity, from aVenture's similar-entity lists */
|
|
21
21
|
similarEntity: z.array(PersonGraphSimilarEntitySchema),
|
|
22
22
|
});
|
|
23
23
|
/**
|
|
@@ -5,11 +5,11 @@ import { PersonGraphMemberSchema } from "./graph-member.js";
|
|
|
5
5
|
const PersonGraphCoInvestorSchemaDefinition = z.object({
|
|
6
6
|
/** Number of shared fundraise transactions between the two people */
|
|
7
7
|
overlapCount: z.int(),
|
|
8
|
-
/**
|
|
8
|
+
/** The co-investor's person card */
|
|
9
9
|
person: PersonGraphMemberSchema,
|
|
10
10
|
/** Round label of the shared fundraise transaction */
|
|
11
11
|
round: z.string().nullish(),
|
|
12
|
-
/** Entity whose
|
|
12
|
+
/** Entity whose funding round both people participated in */
|
|
13
13
|
sharedEntity: EntitySchema.nullish(),
|
|
14
14
|
/** Shared fundraise transaction id */
|
|
15
15
|
transactionId: z.uuid().nullish(),
|
|
@@ -29,7 +29,7 @@ type PersonGraphMemberDefinition = z.infer<typeof PersonGraphMemberSchemaDefinit
|
|
|
29
29
|
export interface PersonGraphMemberSchemaInput extends z.input<typeof PersonGraphMemberSchemaDefinition> {
|
|
30
30
|
}
|
|
31
31
|
/**
|
|
32
|
-
*
|
|
32
|
+
* Short person card with the person's title at the entity
|
|
33
33
|
*
|
|
34
34
|
* @openapiSchema PersonGraphMember
|
|
35
35
|
* @endpoint GET /v1/entities/lookup-exact
|
|
@@ -5,20 +5,20 @@ const PersonGraphMemberSchemaDefinition = z.object({
|
|
|
5
5
|
isCurrent: z.boolean().nullish(),
|
|
6
6
|
/** Associated person id */
|
|
7
7
|
personId: z.uuid(),
|
|
8
|
-
/**
|
|
8
|
+
/** The person's image fields. */
|
|
9
9
|
personImage: PersonImageSchema,
|
|
10
10
|
/** Person display name */
|
|
11
11
|
personName: z.string(),
|
|
12
|
-
/**
|
|
12
|
+
/** Lowercase URL slug that identifies the record. */
|
|
13
13
|
personSlug: z
|
|
14
14
|
.string()
|
|
15
15
|
.regex(/^[a-z0-9_-]+$/)
|
|
16
16
|
.max(255),
|
|
17
|
-
/**
|
|
17
|
+
/** Job title text for this role (read-only). */
|
|
18
18
|
titleName: z.string().nullish(),
|
|
19
19
|
});
|
|
20
20
|
/**
|
|
21
|
-
*
|
|
21
|
+
* Short person card with the person's title at the entity
|
|
22
22
|
*
|
|
23
23
|
* @openapiSchema PersonGraphMember
|
|
24
24
|
* @endpoint GET /v1/entities/lookup-exact
|
|
@@ -3,7 +3,7 @@ import { z } from "zod/v4";
|
|
|
3
3
|
import { EntityFundraiseTransactionEntitySchema } from "../entity/fundraise-transaction-entity.js";
|
|
4
4
|
import { PersonGraphMemberSchema } from "./graph-member.js";
|
|
5
5
|
const PersonGraphSimilarEntitySchemaDefinition = z.object({
|
|
6
|
-
/** Entity card
|
|
6
|
+
/** Entity card: core identity plus total funding */
|
|
7
7
|
entity: EntityFundraiseTransactionEntitySchema,
|
|
8
8
|
/** Top-ranked current people at the similar entity */
|
|
9
9
|
keyPerson: z.array(PersonGraphMemberSchema),
|
package/dist/person/graph.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { z } from "zod/v4";
|
|
2
2
|
/**
|
|
3
|
-
* Precomputed professional-graph document for one person: career context per associated entity (entity facts, recent news, colleagues, similar entities with key people), plus co-investors. Lists are capped and pre-ranked server-side; the response is the display order.
|
|
3
|
+
* Precomputed professional-graph document for one person: career context per associated entity (entity facts, recent news, colleagues, similar entities with key people), plus co-investors. Lists are capped and pre-ranked server-side; the response is the display order. The graph is computed ahead of time; member names, images, and slugs are filled in from current person records when you read it. computedAt is null only when the graph has not been computed yet.
|
|
4
4
|
*
|
|
5
5
|
* @openapiSchema PersonGraph
|
|
6
6
|
* @endpoint GET /v1/entities/lookup-exact
|
package/dist/person/graph.js
CHANGED
|
@@ -3,7 +3,7 @@ import { z } from "zod/v4";
|
|
|
3
3
|
import { PersonGraphCareerContextSchema } from "./graph-career-context.js";
|
|
4
4
|
import { PersonGraphCoInvestorSchema } from "./graph-co-investor.js";
|
|
5
5
|
/**
|
|
6
|
-
* Precomputed professional-graph document for one person: career context per associated entity (entity facts, recent news, colleagues, similar entities with key people), plus co-investors. Lists are capped and pre-ranked server-side; the response is the display order.
|
|
6
|
+
* Precomputed professional-graph document for one person: career context per associated entity (entity facts, recent news, colleagues, similar entities with key people), plus co-investors. Lists are capped and pre-ranked server-side; the response is the display order. The graph is computed ahead of time; member names, images, and slugs are filled in from current person records when you read it. computedAt is null only when the graph has not been computed yet.
|
|
7
7
|
*
|
|
8
8
|
* @openapiSchema PersonGraph
|
|
9
9
|
* @endpoint GET /v1/entities/lookup-exact
|
package/dist/person/image.d.ts
CHANGED
|
@@ -18,7 +18,7 @@ type PersonImageDefinition = z.infer<typeof PersonImageSchemaDefinition>;
|
|
|
18
18
|
export interface PersonImageSchemaInput extends z.input<typeof PersonImageSchemaDefinition> {
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
|
-
*
|
|
21
|
+
* A person's image fields, as returned in detail and list responses.
|
|
22
22
|
*
|
|
23
23
|
* @openapiSchema PersonImage
|
|
24
24
|
* @endpoint GET /v1/entities/lookup-exact
|
package/dist/person/image.js
CHANGED
|
@@ -9,7 +9,7 @@ const PersonImageSchemaDefinition = z.object({
|
|
|
9
9
|
pictureVariant: z.array(ImageVariantSchema).nullish(),
|
|
10
10
|
});
|
|
11
11
|
/**
|
|
12
|
-
*
|
|
12
|
+
* A person's image fields, as returned in detail and list responses.
|
|
13
13
|
*
|
|
14
14
|
* @openapiSchema PersonImage
|
|
15
15
|
* @endpoint GET /v1/entities/lookup-exact
|
|
@@ -169,7 +169,7 @@ type PersonInvestmentDefinition = z.infer<typeof PersonInvestmentSchemaDefinitio
|
|
|
169
169
|
export interface PersonInvestmentSchemaInput extends z.input<typeof PersonInvestmentSchemaDefinition> {
|
|
170
170
|
}
|
|
171
171
|
/**
|
|
172
|
-
*
|
|
172
|
+
* A person's investment in an entity's funding round
|
|
173
173
|
*
|
|
174
174
|
* @openapiSchema PersonInvestment
|
|
175
175
|
* @endpoint GET /v1/entities/lookup-exact
|
|
@@ -12,7 +12,7 @@ const PersonInvestmentSchemaDefinition = z.object({
|
|
|
12
12
|
.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)))?)?)?$/)
|
|
13
13
|
.nullish(),
|
|
14
14
|
fundraiseTransaction: EntityFundraiseSchema.nullish(),
|
|
15
|
-
/**
|
|
15
|
+
/** Funding round id (UUID) */
|
|
16
16
|
fundraiseTransactionId: z.uuid(),
|
|
17
17
|
id: z.string(),
|
|
18
18
|
/** When aVenture recorded this person's participation in the round. It is not the investment date: imported portfolios share their import date. Use date for when the round happened. */
|
|
@@ -22,7 +22,7 @@ const PersonInvestmentSchemaDefinition = z.object({
|
|
|
22
22
|
round: z.string().nullish(),
|
|
23
23
|
});
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
25
|
+
* A person's investment in an entity's funding round
|
|
26
26
|
*
|
|
27
27
|
* @openapiSchema PersonInvestment
|
|
28
28
|
* @endpoint GET /v1/entities/lookup-exact
|
|
@@ -13,15 +13,15 @@ export const PERSON_LOOKUP_EXACT_ENDPOINT = "/v1/people/lookup-exact";
|
|
|
13
13
|
*/
|
|
14
14
|
export const PersonLookupExactParamSchema = z.object({
|
|
15
15
|
include: z.array(PersonDetailIncludeSchema).optional(),
|
|
16
|
-
/**
|
|
16
|
+
/** Include address values in the response (default: true). Set false to omit address array. */
|
|
17
17
|
includeAddress: z.boolean().optional(),
|
|
18
|
-
/**
|
|
18
|
+
/** Include association values in the response (default: true). Set false to omit association array. */
|
|
19
19
|
includeAssociation: z.boolean().optional(),
|
|
20
|
-
/**
|
|
20
|
+
/** Include URL link values in the response (default: true). Set false to omit urlLink array. */
|
|
21
21
|
includeUrl: z.boolean().optional(),
|
|
22
22
|
/** Group C — candidate lookup signal: person location (city, state, country). Combine with other group-C signals for bounded search. Mutually exclusive with id and slug; may be combined with url for fallback. */
|
|
23
23
|
location: z.string().optional(),
|
|
24
|
-
/**
|
|
24
|
+
/** Maximum association values to return; the server caps it at its own association limit. Default: 40. */
|
|
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(),
|
|
@@ -1293,7 +1293,7 @@ type PersonNaturalSearchResultDefinition = z.infer<typeof PersonNaturalSearchRes
|
|
|
1293
1293
|
export interface PersonNaturalSearchResultSchemaInput extends z.input<typeof PersonNaturalSearchResultSchemaDefinition> {
|
|
1294
1294
|
}
|
|
1295
1295
|
/**
|
|
1296
|
-
*
|
|
1296
|
+
* Result of a plain-English people search: how the query was interpreted, and the resulting page of people.
|
|
1297
1297
|
*
|
|
1298
1298
|
* @openapiSchema PersonNaturalSearchResult
|
|
1299
1299
|
* @endpoint GET /v1/search/link
|
|
@@ -13,13 +13,13 @@ const PersonNaturalSearchResultSchemaDefinition = z.object({
|
|
|
13
13
|
personLead: z.boolean(),
|
|
14
14
|
/** aVenture people resolved or filed from web-discovered LinkedIn profiles whom no returned person matches, grouped by `named` in query order. A search that has not run yet runs only for a signed-in subscriber with `layer=web`. */
|
|
15
15
|
profile: z.array(SearchPersonProfileSchema),
|
|
16
|
-
/**
|
|
16
|
+
/** Page of matching people. */
|
|
17
17
|
result: PageResultPersonSchema,
|
|
18
18
|
/** Id of this search's stored record. Null when the search was not recorded. */
|
|
19
19
|
searchRequestId: z.uuid().nullish(),
|
|
20
20
|
});
|
|
21
21
|
/**
|
|
22
|
-
*
|
|
22
|
+
* Result of a plain-English people search: how the query was interpreted, and the resulting page of people.
|
|
23
23
|
*
|
|
24
24
|
* @openapiSchema PersonNaturalSearchResult
|
|
25
25
|
* @endpoint GET /v1/search/link
|
|
@@ -5,7 +5,7 @@ import { PersonFilterSchema } from "./filter.js";
|
|
|
5
5
|
const PersonNaturalSearchSchemaDefinition = z.object({
|
|
6
6
|
/** Explicit people constraints. Caller-supplied fields override planner values; the planner fills only fields left at their canonical defaults. */
|
|
7
7
|
filter: PersonFilterSchema.optional(),
|
|
8
|
-
/**
|
|
8
|
+
/** The plain-English search request and the search method to use. */
|
|
9
9
|
search: NaturalSearchSchema,
|
|
10
10
|
});
|
|
11
11
|
/**
|
package/dist/person/person.d.ts
CHANGED
|
@@ -94,7 +94,7 @@ type PersonDefinition = z.infer<typeof PersonSchemaDefinition>;
|
|
|
94
94
|
export interface PersonSchemaInput extends z.input<typeof PersonSchemaDefinition> {
|
|
95
95
|
}
|
|
96
96
|
/**
|
|
97
|
-
*
|
|
97
|
+
* A person's core profile fields.
|
|
98
98
|
*
|
|
99
99
|
* @openapiSchema Person
|
|
100
100
|
* @endpoint GET /v1/entities/lookup-exact
|
package/dist/person/person.js
CHANGED
|
@@ -8,7 +8,7 @@ const PersonSchemaDefinition = z.object({
|
|
|
8
8
|
/** Record creation timestamp */
|
|
9
9
|
createdAt: z.iso.datetime({ offset: true }).nullish(),
|
|
10
10
|
gender: z.string().nullish(),
|
|
11
|
-
/**
|
|
11
|
+
/** Person id (UUID) */
|
|
12
12
|
id: z.uuid(),
|
|
13
13
|
image: PersonImageSchema,
|
|
14
14
|
/** Provenance-grounded last-modified watermark (schema.org dateModified): the latest effective time across all writes attributed to this person. */
|
|
@@ -23,14 +23,14 @@ const PersonSchemaDefinition = z.object({
|
|
|
23
23
|
/** Middle name as stored after name normalization */
|
|
24
24
|
nameMiddle: z.string().nullish(),
|
|
25
25
|
nickname: z.string().nullish(),
|
|
26
|
-
/** Stable, immutable public handle (e.g. `pV1StGXR8Z5ab`). Never changes once assigned, unlike the slug. Null on
|
|
26
|
+
/** Stable, immutable public handle (e.g. `pV1StGXR8Z5ab`). Never changes once assigned, unlike the slug. Null on responses that do not include it and on older records not yet given a handle. */
|
|
27
27
|
publicId: z
|
|
28
28
|
.string()
|
|
29
29
|
.regex(/^p[0-9A-Za-z]{12}$/)
|
|
30
30
|
.nullish(),
|
|
31
|
-
/**
|
|
31
|
+
/** Why this person matched a meaning-based (semantic) search; set only on semantic searches. */
|
|
32
32
|
semanticMatch: ContentEmbeddingMatchSchema.nullish(),
|
|
33
|
-
/**
|
|
33
|
+
/** Lowercase URL slug that identifies the record. */
|
|
34
34
|
slug: z
|
|
35
35
|
.string()
|
|
36
36
|
.regex(/^[a-z0-9_-]+$/)
|
|
@@ -42,7 +42,7 @@ const PersonSchemaDefinition = z.object({
|
|
|
42
42
|
updatedAt: z.iso.datetime({ offset: true }).nullish(),
|
|
43
43
|
});
|
|
44
44
|
/**
|
|
45
|
-
*
|
|
45
|
+
* A person's core profile fields.
|
|
46
46
|
*
|
|
47
47
|
* @openapiSchema Person
|
|
48
48
|
* @endpoint GET /v1/entities/lookup-exact
|
|
@@ -4,7 +4,7 @@ import { ResearchAllowanceSchema } from "./allowance.js";
|
|
|
4
4
|
const ResearchAllowanceUsageSchemaDefinition = z.object({
|
|
5
5
|
/** Research runs on company targets, new or existing */
|
|
6
6
|
company: ResearchAllowanceSchema,
|
|
7
|
-
/**
|
|
7
|
+
/** Company brand summary reads (names, logos, links, tags) */
|
|
8
8
|
entityBrand: ResearchAllowanceSchema,
|
|
9
9
|
/** Company profile views; Essential shares included usage with personView, while paid tiers meter each separately */
|
|
10
10
|
entityView: ResearchAllowanceSchema,
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { z } from "zod/v4";
|
|
2
2
|
/**
|
|
3
|
-
* Read-only
|
|
3
|
+
* Read-only time range computed for targetDateAbsolute research details
|
|
4
4
|
*
|
|
5
5
|
* @openapiSchema ResearchDerivedRange
|
|
6
6
|
* @endpoint GET /v1/entities/lookup-exact
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
import { z } from "zod/v4";
|
|
3
3
|
import { ResearchDerivedBucketSchema } from "./derived-bucket.js";
|
|
4
4
|
/**
|
|
5
|
-
* Read-only
|
|
5
|
+
* Read-only time range computed for targetDateAbsolute research details
|
|
6
6
|
*
|
|
7
7
|
* @openapiSchema ResearchDerivedRange
|
|
8
8
|
* @endpoint GET /v1/entities/lookup-exact
|
|
@@ -19,7 +19,7 @@ const ResearchDetailTypeSchemaDefinition = z.object({
|
|
|
19
19
|
typeValue: z.string(),
|
|
20
20
|
/** Write-time value shape token. For numericCountOrRange details, send either discreteValue for an exact count or textValue for an employee range. */
|
|
21
21
|
valueShape: ResearchValueShapeTypeSchema,
|
|
22
|
-
/**
|
|
22
|
+
/** Value kind on reads; pick write fields from valueShape. */
|
|
23
23
|
valueType: EntityResearchValueTypeSchema,
|
|
24
24
|
/** How to encode a write for this valueShape: which of valueResearchDetail, discreteValue, textValue, and asOfDate to send, with an example. */
|
|
25
25
|
writeHint: z.string(),
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { z } from "zod/v4";
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* Paragraph rules that text must meet when written. Paragraphs split on `\n\n` (one blank line). Each paragraph must satisfy minChars..maxChars and minSentences..maxSentences; whole body must satisfy minParagraphs..maxParagraphs (null maxParagraphs = unbounded). Sentence boundaries follow Unicode rules (java.text.BreakIterator), so 'Inc.' and 'U.S.' do not split a sentence. Each paragraph ends in terminal punctuation (. ! ? or the CJK full stop, exclamation, and question marks), optionally followed by a closing quote, parenthesis, bracket, or guillemet.
|
|
4
4
|
*
|
|
5
5
|
* @openapiSchema ResearchParagraphShape
|
|
6
6
|
* @endpoint GET /v1/entities/research-snippets/types
|
|
@@ -1,7 +1,7 @@
|
|
|
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
|
/**
|
|
4
|
-
*
|
|
4
|
+
* Paragraph rules that text must meet when written. Paragraphs split on `\n\n` (one blank line). Each paragraph must satisfy minChars..maxChars and minSentences..maxSentences; whole body must satisfy minParagraphs..maxParagraphs (null maxParagraphs = unbounded). Sentence boundaries follow Unicode rules (java.text.BreakIterator), so 'Inc.' and 'U.S.' do not split a sentence. Each paragraph ends in terminal punctuation (. ! ? or the CJK full stop, exclamation, and question marks), optionally followed by a closing quote, parenthesis, bracket, or guillemet.
|
|
5
5
|
*
|
|
6
6
|
* @openapiSchema ResearchParagraphShape
|
|
7
7
|
* @endpoint GET /v1/entities/research-snippets/types
|