@aventurevc/api-schemas 0.8.374 → 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.d.ts +1 -1
- package/dist/entity/sitemap.js +6 -6
- 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.d.ts +1 -0
- package/dist/http/problem-detail.js +4 -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/answer-paragraph.js +1 -1
- package/dist/search/answer.js +1 -1
- 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
|
@@ -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
|
|
@@ -36,7 +36,7 @@ type ResearchSnippetTypeDefinition = z.infer<typeof ResearchSnippetTypeSchemaDef
|
|
|
36
36
|
export interface ResearchSnippetTypeSchemaInput extends z.input<typeof ResearchSnippetTypeSchemaDefinition> {
|
|
37
37
|
}
|
|
38
38
|
/**
|
|
39
|
-
*
|
|
39
|
+
* A research snippet type and the rules text written to it must meet.
|
|
40
40
|
*
|
|
41
41
|
* @openapiSchema ResearchSnippetType
|
|
42
42
|
* @endpoint GET /v1/entities/research-snippets/types
|
|
@@ -21,17 +21,17 @@ const ResearchSnippetTypeSchemaDefinition = z.object({
|
|
|
21
21
|
paragraphShape: ResearchParagraphShapeSchema.nullish(),
|
|
22
22
|
/** One reader-facing question the analysis answers, shown where readers choose an analysis. */
|
|
23
23
|
readerQuestion: z.string(),
|
|
24
|
-
/** Whether
|
|
24
|
+
/** Whether aVenture recognizes this text type; true for every row this endpoint returns. */
|
|
25
25
|
recognized: z.boolean(),
|
|
26
26
|
/** Dotted research section path the snippet attaches to. */
|
|
27
27
|
targetPath: z.string(),
|
|
28
|
-
/**
|
|
28
|
+
/** Snippet type value used in requests and responses. */
|
|
29
29
|
typeValue: z.string(),
|
|
30
30
|
/** The strategic question this snippet type answers and how to shape it. Snippets are point-in-time strategic analysis of the company's position against its market and named alternatives: open with the judgment and give dated details only as evidence for it, never as a fact list. */
|
|
31
31
|
writeHint: z.string(),
|
|
32
32
|
});
|
|
33
33
|
/**
|
|
34
|
-
*
|
|
34
|
+
* A research snippet type and the rules text written to it must meet.
|
|
35
35
|
*
|
|
36
36
|
* @openapiSchema ResearchSnippetType
|
|
37
37
|
* @endpoint GET /v1/entities/research-snippets/types
|
|
@@ -5,7 +5,7 @@ import { SearchAnswerWebSourceSchema } from "./answer-web-source.js";
|
|
|
5
5
|
const SearchAnswerParagraphSchemaDefinition = z.object({
|
|
6
6
|
/** Evidence this paragraph rests on, most important first. */
|
|
7
7
|
citation: z.array(SearchAnswerCitationSchema),
|
|
8
|
-
/** Paragraph text in plain prose, including
|
|
8
|
+
/** Paragraph text in plain prose, including unchanged source quotations, attributed except on a quoted company profile. */
|
|
9
9
|
text: z.string(),
|
|
10
10
|
/** Short label naming the category, market, or segment this paragraph covers, such as "Smartphones · North America"; absent on the lead paragraph. */
|
|
11
11
|
topic: z.string().nullish(),
|
package/dist/search/answer.js
CHANGED
|
@@ -34,7 +34,7 @@ export const SearchAnswerSchema = z.object({
|
|
|
34
34
|
description: z.string().nullish(),
|
|
35
35
|
/** The question as the answer page's heading: the asker's own words in title case, with record names in their stored casing; it never adds, drops, or corrects a word. Absent when the answer abstains. */
|
|
36
36
|
heading: z.string().nullish(),
|
|
37
|
-
/** The answer's paragraphs in reading order, each citing the evidence it rests on; empty when the answer abstains. A first paragraph without `topic` is the lead, written as a standalone answer of one or two sentences that reads complete when shown alone; later paragraphs expand it by topic without restating it. Source financial answers render recorded funding facts literally,
|
|
37
|
+
/** The answer's paragraphs in reading order, each citing the evidence it rests on; empty when the answer abstains. A first paragraph without `topic` is the lead, written as a standalone answer of one or two sentences that reads complete when shown alone; later paragraphs expand it by topic without restating it. Source financial answers render recorded funding facts literally; a requested company profile follows the lead as one quoted "Products and services" paragraph, then other recorded transactions and attributed unchanged admitted source passages; a recorded total is not a round. */
|
|
38
38
|
paragraph: z.array(SearchAnswerParagraphSchema),
|
|
39
39
|
/** Up to five follow-up searches grounded in the cited evidence; empty when the answer abstains. */
|
|
40
40
|
relatedQuery: z.array(z.string()),
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { z } from "zod/v4";
|
|
2
2
|
/**
|
|
3
|
-
* Search-stage cache policy: use reuses completed and in-flight work; bypass computes independently without retaining search outputs; refresh computes independently and replaces the normal cache entry.
|
|
3
|
+
* Search-stage cache policy: use reuses completed and in-flight work; bypass computes independently without retaining search outputs; refresh computes independently and replaces the normal cache entry. This setting does not affect cached query embeddings, which never change, or cached record data; both follow their own caching rules.
|
|
4
4
|
*
|
|
5
5
|
* @openapiSchema SearchCacheMode
|
|
6
6
|
* @endpoint GET /v1/web/searches/jobs/{jobId}
|
|
@@ -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
|
-
* Search-stage cache policy: use reuses completed and in-flight work; bypass computes independently without retaining search outputs; refresh computes independently and replaces the normal cache entry.
|
|
4
|
+
* Search-stage cache policy: use reuses completed and in-flight work; bypass computes independently without retaining search outputs; refresh computes independently and replaces the normal cache entry. This setting does not affect cached query embeddings, which never change, or cached record data; both follow their own caching rules.
|
|
5
5
|
*
|
|
6
6
|
* @openapiSchema SearchCacheMode
|
|
7
7
|
* @endpoint GET /v1/web/searches/jobs/{jobId}
|
|
@@ -474,7 +474,7 @@ type SearchInvestmentDefinition = z.infer<typeof SearchInvestmentSchemaDefinitio
|
|
|
474
474
|
export interface SearchInvestmentSchemaInput extends z.input<typeof SearchInvestmentSchemaDefinition> {
|
|
475
475
|
}
|
|
476
476
|
/**
|
|
477
|
-
*
|
|
477
|
+
* An investor's participation in a round, with evidence for the portfolio product or service it matched.
|
|
478
478
|
*
|
|
479
479
|
* @openapiSchema SearchInvestment
|
|
480
480
|
* @endpoint GET /v1/search/link
|
|
@@ -9,7 +9,7 @@ const SearchInvestmentSchemaDefinition = z.object({
|
|
|
9
9
|
semanticMatch: ContentEmbeddingMatchSchema.nullish(),
|
|
10
10
|
});
|
|
11
11
|
/**
|
|
12
|
-
*
|
|
12
|
+
* An investor's participation in a round, with evidence for the portfolio product or service it matched.
|
|
13
13
|
*
|
|
14
14
|
* @openapiSchema SearchInvestment
|
|
15
15
|
* @endpoint GET /v1/search/link
|
|
@@ -39,7 +39,7 @@ type SearchModeExecutionDefinition = z.infer<typeof SearchModeExecutionSchemaDef
|
|
|
39
39
|
export interface SearchModeExecutionSchemaInput extends z.input<typeof SearchModeExecutionSchemaDefinition> {
|
|
40
40
|
}
|
|
41
41
|
/**
|
|
42
|
-
* Search
|
|
42
|
+
* Search method the caller asked for and the method the server actually ran.
|
|
43
43
|
*
|
|
44
44
|
* @openapiSchema SearchModeExecution
|
|
45
45
|
* @endpoint GET /v1/search/link
|
|
@@ -4,11 +4,11 @@ import { SearchModeSchema } from "./mode.js";
|
|
|
4
4
|
const SearchModeExecutionSchemaDefinition = z.object({
|
|
5
5
|
/** Search mode requested by the caller. */
|
|
6
6
|
modeRequested: SearchModeSchema,
|
|
7
|
-
/** Search
|
|
7
|
+
/** Search method the server actually ran. */
|
|
8
8
|
modeUsed: SearchModeSchema,
|
|
9
9
|
});
|
|
10
10
|
/**
|
|
11
|
-
* Search
|
|
11
|
+
* Search method the caller asked for and the method the server actually ran.
|
|
12
12
|
*
|
|
13
13
|
* @openapiSchema SearchModeExecution
|
|
14
14
|
* @endpoint GET /v1/search/link
|
package/dist/sec/company.js
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
import { z } from "zod/v4";
|
|
3
3
|
import { SecListingProspectusSchema } from "./listing-prospectus.js";
|
|
4
4
|
const SecCompanySchemaDefinition = z.object({
|
|
5
|
-
/** SEC Central Index Key, 10
|
|
5
|
+
/** SEC Central Index Key, 10 digits with leading zeros. It stays the same across SEC data syncs. */
|
|
6
6
|
cik: z.string(),
|
|
7
7
|
/** Employer Identification Number (tax id), when SEC supplies one. */
|
|
8
8
|
ein: z.string().nullish(),
|
|
@@ -8,7 +8,7 @@ const SharedDirectoryListSchemaDefinition = z.object({
|
|
|
8
8
|
heading: z.string(),
|
|
9
9
|
/** Stable shared-directory UUID */
|
|
10
10
|
id: z.uuid(),
|
|
11
|
-
/**
|
|
11
|
+
/** Lowercase URL slug that identifies the record. */
|
|
12
12
|
slug: z
|
|
13
13
|
.string()
|
|
14
14
|
.regex(/^[a-z0-9_-]+$/)
|
|
@@ -5,7 +5,7 @@ const SharedSearchListSchemaDefinition = z.object({
|
|
|
5
5
|
/** Stable shared-search UUID */
|
|
6
6
|
id: z.uuid(),
|
|
7
7
|
query: z.string(),
|
|
8
|
-
/**
|
|
8
|
+
/** Lowercase URL slug that identifies the record. */
|
|
9
9
|
slug: z
|
|
10
10
|
.string()
|
|
11
11
|
.regex(/^[a-z0-9_-]+$/)
|
|
@@ -21,7 +21,7 @@ type SourceDocumentListDefinition = z.infer<typeof SourceDocumentListSchemaDefin
|
|
|
21
21
|
export interface SourceDocumentListSchemaInput extends z.input<typeof SourceDocumentListSchemaDefinition> {
|
|
22
22
|
}
|
|
23
23
|
/**
|
|
24
|
-
*
|
|
24
|
+
* A stored source document's metadata, without its content.
|
|
25
25
|
*
|
|
26
26
|
* @openapiSchema SourceDocumentList
|
|
27
27
|
* @endpoint GET /v1/web/searches/jobs/{jobId}
|
|
@@ -16,14 +16,14 @@ const SourceDocumentListSchemaDefinition = z.object({
|
|
|
16
16
|
rawByteCount: z.number().int().nullish(),
|
|
17
17
|
rawCharset: z.string().nullish(),
|
|
18
18
|
rawMediaType: z.string().nullish(),
|
|
19
|
-
/**
|
|
19
|
+
/** What identifies this fetch: the normalized URL, a hash of the query, or a dataset name plus an external id */
|
|
20
20
|
sourceKey: z.string(),
|
|
21
21
|
upstreamContentEncoding: z.string().nullish(),
|
|
22
|
-
/** Fetched page URL;
|
|
22
|
+
/** Fetched page URL; also used to page through results by recency */
|
|
23
23
|
url: z.string().nullish(),
|
|
24
24
|
});
|
|
25
25
|
/**
|
|
26
|
-
*
|
|
26
|
+
* A stored source document's metadata, without its content.
|
|
27
27
|
*
|
|
28
28
|
* @openapiSchema SourceDocumentList
|
|
29
29
|
* @endpoint GET /v1/web/searches/jobs/{jobId}
|
|
@@ -7,7 +7,7 @@ type StageFrequencyDefinition = z.infer<typeof StageFrequencySchemaDefinition>;
|
|
|
7
7
|
export interface StageFrequencySchemaInput extends z.input<typeof StageFrequencySchemaDefinition> {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
10
|
+
* Equity stage computed from each round's calculatedRoundLabel, with how many deals reached it, most frequent first.
|
|
11
11
|
*
|
|
12
12
|
* @openapiSchema StageFrequency
|
|
13
13
|
* @endpoint GET /v1/entities/lookup-exact
|
package/dist/stage/frequency.js
CHANGED
|
@@ -5,7 +5,7 @@ const StageFrequencySchemaDefinition = z.object({
|
|
|
5
5
|
stage: z.string(),
|
|
6
6
|
});
|
|
7
7
|
/**
|
|
8
|
-
*
|
|
8
|
+
* Equity stage computed from each round's calculatedRoundLabel, with how many deals reached it, most frequent first.
|
|
9
9
|
*
|
|
10
10
|
* @openapiSchema StageFrequency
|
|
11
11
|
* @endpoint GET /v1/entities/lookup-exact
|
|
@@ -9,7 +9,7 @@ const StandardizedClassificationFilterSchemaDefinition = z.object({
|
|
|
9
9
|
codeText: z.string().max(255).nullish(),
|
|
10
10
|
/** Exact supplied codebook edition; omitted does not assume the current edition. */
|
|
11
11
|
edition: z.string().max(128).nullish(),
|
|
12
|
-
/** true selects recorded editions; false selects unknown edition;
|
|
12
|
+
/** true selects recorded editions; false selects unknown edition; omit it to match either. */
|
|
13
13
|
hasEdition: z.boolean().nullish(),
|
|
14
14
|
});
|
|
15
15
|
/**
|
|
@@ -19,7 +19,7 @@ type TextTypeOptionDefinition = z.infer<typeof TextTypeOptionSchemaDefinition>;
|
|
|
19
19
|
export interface TextTypeOptionSchemaInput extends z.input<typeof TextTypeOptionSchemaDefinition> {
|
|
20
20
|
}
|
|
21
21
|
/**
|
|
22
|
-
*
|
|
22
|
+
* A text type the text endpoints accept; entity rows include minWords, maxWords, rewriteHint, and paragraphShape when that type has length and paragraph rules.
|
|
23
23
|
*
|
|
24
24
|
* @openapiSchema TextTypeOption
|
|
25
25
|
* @endpoint GET /v1/entities/texts/types
|
package/dist/text/type-option.js
CHANGED
|
@@ -4,19 +4,19 @@ import { ResearchParagraphShapeSchema } from "../research/paragraph-shape.js";
|
|
|
4
4
|
const TextTypeOptionSchemaDefinition = z.object({
|
|
5
5
|
/** Canonical textType value. */
|
|
6
6
|
canonical: z.string(),
|
|
7
|
-
/** Maximum words allowed
|
|
7
|
+
/** Maximum words allowed for this text type. */
|
|
8
8
|
maxWords: z.int().nullish(),
|
|
9
|
-
/** Minimum words allowed
|
|
9
|
+
/** Minimum words allowed for this text type. */
|
|
10
10
|
minWords: z.int().nullish(),
|
|
11
|
-
/** Paragraph
|
|
11
|
+
/** Paragraph rules for this text type. */
|
|
12
12
|
paragraphShape: ResearchParagraphShapeSchema.nullish(),
|
|
13
13
|
/** Whether the textType requires trusted read visibility. */
|
|
14
14
|
privateType: z.boolean(),
|
|
15
|
-
/**
|
|
15
|
+
/** Advice for rewriting text that breaks this type's rules. */
|
|
16
16
|
rewriteHint: z.string().nullish(),
|
|
17
17
|
});
|
|
18
18
|
/**
|
|
19
|
-
*
|
|
19
|
+
* A text type the text endpoints accept; entity rows include minWords, maxWords, rewriteHint, and paragraphShape when that type has length and paragraph rules.
|
|
20
20
|
*
|
|
21
21
|
* @openapiSchema TextTypeOption
|
|
22
22
|
* @endpoint GET /v1/entities/texts/types
|
|
@@ -34,7 +34,7 @@ export const UniqueIdMutationSchema = z.object({
|
|
|
34
34
|
shareClass: z.string().nullish(),
|
|
35
35
|
/** Optional attribution source label for the mapping. */
|
|
36
36
|
source: z.string().nullish(),
|
|
37
|
-
/**
|
|
37
|
+
/** Date from which the source says this listing standing applies, at the precision supplied. */
|
|
38
38
|
standingAsOf: z
|
|
39
39
|
.string()
|
|
40
40
|
.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,7 +13,7 @@ type UniqueIdTypeAliasDefinition = z.infer<typeof UniqueIdTypeAliasSchemaDefinit
|
|
|
13
13
|
export interface UniqueIdTypeAliasSchemaInput extends z.input<typeof UniqueIdTypeAliasSchemaDefinition> {
|
|
14
14
|
}
|
|
15
15
|
/**
|
|
16
|
-
*
|
|
16
|
+
* An identifier type with its label, accepted spellings, whether it applies to entities or people, and its format pattern.
|
|
17
17
|
*
|
|
18
18
|
* @openapiSchema UniqueIdTypeAlias
|
|
19
19
|
* @endpoint GET /v1/unique-ids/types
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
import { z } from "zod/v4";
|
|
3
3
|
import { UniqueIdOwnerScopeSchema } from "./id-owner-scope.js";
|
|
4
4
|
const UniqueIdTypeAliasSchemaDefinition = z.object({
|
|
5
|
-
/**
|
|
5
|
+
/** Other spellings accepted for this identifier type on writes. */
|
|
6
6
|
alias: z.array(z.string()),
|
|
7
|
-
/**
|
|
7
|
+
/** Identifier type value, as returned in responses and accepted on writes. */
|
|
8
8
|
canonical: z.string(),
|
|
9
9
|
/** Human-readable label. */
|
|
10
10
|
label: z.string(),
|
|
@@ -14,7 +14,7 @@ const UniqueIdTypeAliasSchemaDefinition = z.object({
|
|
|
14
14
|
pattern: z.string().nullish(),
|
|
15
15
|
});
|
|
16
16
|
/**
|
|
17
|
-
*
|
|
17
|
+
* An identifier type with its label, accepted spellings, whether it applies to entities or people, and its format pattern.
|
|
18
18
|
*
|
|
19
19
|
* @openapiSchema UniqueIdTypeAlias
|
|
20
20
|
* @endpoint GET /v1/unique-ids/types
|
package/dist/unique/id.js
CHANGED
|
@@ -30,7 +30,7 @@ const UniqueIdSchemaDefinition = z.object({
|
|
|
30
30
|
shareClass: z.string().nullish(),
|
|
31
31
|
/** Attribution source label for the mapping, when recorded. */
|
|
32
32
|
source: z.string().nullish(),
|
|
33
|
-
/**
|
|
33
|
+
/** Date from which the source says this listing standing applies, at the precision supplied. */
|
|
34
34
|
standingAsOf: z
|
|
35
35
|
.string()
|
|
36
36
|
.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)))?)?)?$/)
|
|
@@ -6,7 +6,7 @@ import { UrlDuplicateJoinSchema } from "./duplicate-join.js";
|
|
|
6
6
|
const UrlDuplicateConflictSchemaDefinition = z.object({
|
|
7
7
|
/** Conflict kind that identifies this details shape. */
|
|
8
8
|
conflictType: DomainConflictTypeSchema,
|
|
9
|
-
/** Every
|
|
9
|
+
/** Every entity or person that already has this URL (after normalization) with this urlType. Non-empty when this conflict is emitted. */
|
|
10
10
|
existingJoin: z.array(UrlDuplicateJoinSchema),
|
|
11
11
|
/** True when URL fragment differences were ignored during duplicate matching (i.e., the conflict ignores everything after '#'). */
|
|
12
12
|
fragmentIgnored: z.boolean(),
|
|
@@ -14,7 +14,7 @@ const UrlDuplicateConflictSchemaDefinition = z.object({
|
|
|
14
14
|
guidance: z.string(),
|
|
15
15
|
/** Normalized URL match key used for duplicate detection. Null when normalization could not produce a stable key (e.g., malformed input). */
|
|
16
16
|
normalizedUrl: z.string().nullish(),
|
|
17
|
-
/**
|
|
17
|
+
/** Entity or person you tried to add the URL to. */
|
|
18
18
|
requestedOwner: EntityPersonOwnerSchema,
|
|
19
19
|
/** Raw URL as submitted by the caller (pre-normalization). */
|
|
20
20
|
url: z.string(),
|
|
@@ -10,7 +10,7 @@ type UrlDuplicateJoinDefinition = z.infer<typeof UrlDuplicateJoinSchemaDefinitio
|
|
|
10
10
|
export interface UrlDuplicateJoinSchemaInput extends z.input<typeof UrlDuplicateJoinSchemaDefinition> {
|
|
11
11
|
}
|
|
12
12
|
/**
|
|
13
|
-
* Entity or person that currently
|
|
13
|
+
* Entity or person that currently has this URL (after normalization).
|
|
14
14
|
*
|
|
15
15
|
* @openapiSchema UrlDuplicateJoin
|
|
16
16
|
* @standardProblemResponse
|
|
@@ -8,7 +8,7 @@ const UrlDuplicateJoinSchemaDefinition = z.object({
|
|
|
8
8
|
urlId: z.int(),
|
|
9
9
|
});
|
|
10
10
|
/**
|
|
11
|
-
* Entity or person that currently
|
|
11
|
+
* Entity or person that currently has this URL (after normalization).
|
|
12
12
|
*
|
|
13
13
|
* @openapiSchema UrlDuplicateJoin
|
|
14
14
|
* @standardProblemResponse
|
package/dist/url/type-alias.d.ts
CHANGED
|
@@ -8,7 +8,7 @@ type UrlTypeAliasDefinition = z.infer<typeof UrlTypeAliasSchemaDefinition>;
|
|
|
8
8
|
export interface UrlTypeAliasSchemaInput extends z.input<typeof UrlTypeAliasSchemaDefinition> {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
*
|
|
11
|
+
* A URL type, its accepted spellings, and the website hosts that identify it.
|
|
12
12
|
*
|
|
13
13
|
* @openapiSchema UrlTypeAlias
|
|
14
14
|
* @endpoint GET /v1/url-types
|
package/dist/url/type-alias.js
CHANGED
|
@@ -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
|
const UrlTypeAliasSchemaDefinition = z.object({
|
|
4
|
-
/**
|
|
4
|
+
/** Other spellings accepted for this URL type. */
|
|
5
5
|
alias: z.array(z.string()),
|
|
6
6
|
/** Canonical urlType value. */
|
|
7
7
|
canonical: z.string(),
|
|
@@ -9,7 +9,7 @@ const UrlTypeAliasSchemaDefinition = z.object({
|
|
|
9
9
|
hostDomain: z.array(z.string()),
|
|
10
10
|
});
|
|
11
11
|
/**
|
|
12
|
-
*
|
|
12
|
+
* A URL type, its accepted spellings, and the website hosts that identify it.
|
|
13
13
|
*
|
|
14
14
|
* @openapiSchema UrlTypeAlias
|
|
15
15
|
* @endpoint GET /v1/url-types
|
package/dist/web/search.js
CHANGED
|
@@ -13,7 +13,7 @@ const WebSearchSchemaDefinition = z.object({
|
|
|
13
13
|
aiOverview: SearchAiOverviewSchema.nullish(),
|
|
14
14
|
/** Google's direct answer box; null when the page shows none */
|
|
15
15
|
answerBox: SearchAnswerBoxSchema.nullish(),
|
|
16
|
-
/**
|
|
16
|
+
/** Stored record, metadata only, of the page this web search fetched */
|
|
17
17
|
document: SourceDocumentListSchema,
|
|
18
18
|
/** Google's knowledge panel; null when the page shows none */
|
|
19
19
|
knowledgeGraph: SearchKnowledgeGraphSchema.nullish(),
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
import { z } from "zod/v4";
|
|
3
3
|
const WriterClaimSurfaceSchemaKnownMembers = z.enum(["ENTITY_TEXT", "RESEARCH_SNIPPET", "BOTH"]);
|
|
4
4
|
/**
|
|
5
|
-
*
|
|
5
|
+
* Where a sourced claim appears in the written output.
|
|
6
6
|
*
|
|
7
7
|
* @openapiSchema WriterClaimSurface
|
|
8
8
|
* @endpoint POST /v1/entities/{entityId}/enrichments
|