@aventurevc/api-schemas 0.8.334 → 0.8.336

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.
@@ -7,6 +7,7 @@ import { z } from "zod/v4";
7
7
  * @usedBySchema ClassificationInactiveTagDetailsSchema
8
8
  * @usedBySchema DomainConflictDetailsSchema
9
9
  * @usedBySchema DuplicateCreateReviewSchema
10
+ * @usedBySchema IdentificationSchema
10
11
  * @usedBySchema NewsSourceUrlConflictSchema
11
12
  * @usedBySchema StrictUrlLookupConflictSchema
12
13
  * @usedBySchema UrlDuplicateConflictSchema
@@ -15,6 +15,7 @@ const DomainConflictTypeSchemaKnownMembers = z.enum([
15
15
  * @usedBySchema ClassificationInactiveTagDetailsSchema
16
16
  * @usedBySchema DomainConflictDetailsSchema
17
17
  * @usedBySchema DuplicateCreateReviewSchema
18
+ * @usedBySchema IdentificationSchema
18
19
  * @usedBySchema NewsSourceUrlConflictSchema
19
20
  * @usedBySchema StrictUrlLookupConflictSchema
20
21
  * @usedBySchema UrlDuplicateConflictSchema
@@ -165,6 +165,21 @@ export declare const IdentificationSchema: z.ZodObject<{
165
165
  mode: z.ZodString;
166
166
  statusUrl: z.ZodString;
167
167
  }, z.core.$strip>>>;
168
+ filingRefusal: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodEnum<{
169
+ CLASSIFICATION_INACTIVE_TAG: "CLASSIFICATION_INACTIVE_TAG";
170
+ DUPLICATE_CREATE_REVIEW: "DUPLICATE_CREATE_REVIEW";
171
+ NEWS_SOURCE_URL: "NEWS_SOURCE_URL";
172
+ STRICT_URL_LOOKUP: "STRICT_URL_LOOKUP";
173
+ URL_DUPLICATE: "URL_DUPLICATE";
174
+ }>, z.ZodString]> & {
175
+ enum: {
176
+ CLASSIFICATION_INACTIVE_TAG: "CLASSIFICATION_INACTIVE_TAG";
177
+ DUPLICATE_CREATE_REVIEW: "DUPLICATE_CREATE_REVIEW";
178
+ NEWS_SOURCE_URL: "NEWS_SOURCE_URL";
179
+ STRICT_URL_LOOKUP: "STRICT_URL_LOOKUP";
180
+ URL_DUPLICATE: "URL_DUPLICATE";
181
+ };
182
+ }>>;
168
183
  inserted: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
169
184
  languageModelSettled: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
170
185
  match: z.ZodOptional<z.ZodNullable<z.ZodObject<{
@@ -1,5 +1,6 @@
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
+ import { DomainConflictTypeSchema } from "../domain/conflict-type.js";
3
4
  import { EntityPersonOwnerSchema } from "../entity/person-owner.js";
4
5
  import { IdentificationCandidateSchema } from "./candidate.js";
5
6
  import { JobEnqueueSchema } from "../job/enqueue.js";
@@ -38,6 +39,8 @@ export const IdentificationSchema = z.object({
38
39
  enrichmentRunId: z.uuid().nullish(),
39
40
  /** Present only for callers that sent Prefer: respond-async. The identification is settled, but filing is pending. Poll statusUrl until the lookup job completes and use its identification; do not treat this as a final unfiled absence. */
40
41
  filing: JobEnqueueSchema.nullish(),
42
+ /** Conflict kind that refused creating the shell, from ProblemDetail.details.conflictType. Absent when no typed conflict refused filing; detail retains the explanation. */
43
+ filingRefusal: DomainConflictTypeSchema.nullish(),
41
44
  /** Present only for callers that sent Prefer: respond-async. For a completed filing job, whether that request inserted created. */
42
45
  inserted: z.boolean().nullish(),
43
46
  /** true when the match was settled on a second, slower review; confirm it before relying on it. Absent otherwise. */
@@ -1432,6 +1432,21 @@ declare const LookupJobMentionSchemaDefinition: z.ZodObject<{
1432
1432
  mode: z.ZodString;
1433
1433
  statusUrl: z.ZodString;
1434
1434
  }, z.core.$strip>>>;
1435
+ filingRefusal: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodEnum<{
1436
+ CLASSIFICATION_INACTIVE_TAG: "CLASSIFICATION_INACTIVE_TAG";
1437
+ DUPLICATE_CREATE_REVIEW: "DUPLICATE_CREATE_REVIEW";
1438
+ NEWS_SOURCE_URL: "NEWS_SOURCE_URL";
1439
+ STRICT_URL_LOOKUP: "STRICT_URL_LOOKUP";
1440
+ URL_DUPLICATE: "URL_DUPLICATE";
1441
+ }>, z.ZodString]> & {
1442
+ enum: {
1443
+ CLASSIFICATION_INACTIVE_TAG: "CLASSIFICATION_INACTIVE_TAG";
1444
+ DUPLICATE_CREATE_REVIEW: "DUPLICATE_CREATE_REVIEW";
1445
+ NEWS_SOURCE_URL: "NEWS_SOURCE_URL";
1446
+ STRICT_URL_LOOKUP: "STRICT_URL_LOOKUP";
1447
+ URL_DUPLICATE: "URL_DUPLICATE";
1448
+ };
1449
+ }>>;
1435
1450
  inserted: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
1436
1451
  languageModelSettled: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
1437
1452
  match: z.ZodOptional<z.ZodNullable<z.ZodObject<{
@@ -155,6 +155,21 @@ declare const LookupJobSchemaDefinition: z.ZodObject<{
155
155
  mode: z.ZodString;
156
156
  statusUrl: z.ZodString;
157
157
  }, z.core.$strip>>>;
158
+ filingRefusal: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodEnum<{
159
+ CLASSIFICATION_INACTIVE_TAG: "CLASSIFICATION_INACTIVE_TAG";
160
+ DUPLICATE_CREATE_REVIEW: "DUPLICATE_CREATE_REVIEW";
161
+ NEWS_SOURCE_URL: "NEWS_SOURCE_URL";
162
+ STRICT_URL_LOOKUP: "STRICT_URL_LOOKUP";
163
+ URL_DUPLICATE: "URL_DUPLICATE";
164
+ }>, z.ZodString]> & {
165
+ enum: {
166
+ CLASSIFICATION_INACTIVE_TAG: "CLASSIFICATION_INACTIVE_TAG";
167
+ DUPLICATE_CREATE_REVIEW: "DUPLICATE_CREATE_REVIEW";
168
+ NEWS_SOURCE_URL: "NEWS_SOURCE_URL";
169
+ STRICT_URL_LOOKUP: "STRICT_URL_LOOKUP";
170
+ URL_DUPLICATE: "URL_DUPLICATE";
171
+ };
172
+ }>>;
158
173
  inserted: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
159
174
  languageModelSettled: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
160
175
  match: z.ZodOptional<z.ZodNullable<z.ZodObject<{
@@ -970,6 +985,7 @@ declare const LookupJobSchemaDefinition: z.ZodObject<{
970
985
  mode: string;
971
986
  statusUrl: string;
972
987
  } | null | undefined;
988
+ filingRefusal?: string | null | undefined;
973
989
  inserted?: boolean | null | undefined;
974
990
  languageModelSettled?: boolean | null | undefined;
975
991
  match?: {
@@ -1805,6 +1821,7 @@ declare const LookupJobSchemaDefinition: z.ZodObject<{
1805
1821
  mode: string;
1806
1822
  statusUrl: string;
1807
1823
  } | null | undefined;
1824
+ filingRefusal?: string | null | undefined;
1808
1825
  inserted?: boolean | null | undefined;
1809
1826
  languageModelSettled?: boolean | null | undefined;
1810
1827
  match?: {
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Observed article-reading activity; unknown future phases retain their supplied copy.
3
+ * Observed source-reading activity; unknown future phases retain their supplied copy.
4
4
  *
5
5
  * @openapiSchema LookupSourceReadPhase
6
6
  * @endpoint GET /v1/lookup-jobs/{jobId}
@@ -2,7 +2,7 @@
2
2
  import { z } from "zod/v4";
3
3
  const LookupSourceReadPhaseSchemaKnownMembers = z.enum(["READING", "MATCHING"]);
4
4
  /**
5
- * Observed article-reading activity; unknown future phases retain their supplied copy.
5
+ * Observed source-reading activity; unknown future phases retain their supplied copy.
6
6
  *
7
7
  * @openapiSchema LookupSourceReadPhase
8
8
  * @endpoint GET /v1/lookup-jobs/{jobId}
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Publisher context and honest reading activity for a shared-article lookup.
3
+ * Source context and honest reading activity for a shared article or profile.
4
4
  *
5
5
  * @openapiSchema LookupSourceRead
6
6
  * @endpoint GET /v1/lookup-jobs/{jobId}
@@ -3,7 +3,7 @@ import { z } from "zod/v4";
3
3
  import { JobEnqueueSchema } from "../job/enqueue.js";
4
4
  import { LookupSourceReadPhaseSchema } from "./source-read-phase.js";
5
5
  /**
6
- * Publisher context and honest reading activity for a shared-article lookup.
6
+ * Source context and honest reading activity for a shared article or profile.
7
7
  *
8
8
  * @openapiSchema LookupSourceRead
9
9
  * @endpoint GET /v1/lookup-jobs/{jobId}
@@ -745,6 +745,7 @@ declare const MentionLookupSchemaDefinition: z.ZodObject<{
745
745
  mode: string;
746
746
  statusUrl: string;
747
747
  } | null | undefined;
748
+ filingRefusal?: string | null | undefined;
748
749
  inserted?: boolean | null | undefined;
749
750
  languageModelSettled?: boolean | null | undefined;
750
751
  match?: {
@@ -1580,6 +1581,7 @@ declare const MentionLookupSchemaDefinition: z.ZodObject<{
1580
1581
  mode: string;
1581
1582
  statusUrl: string;
1582
1583
  } | null | undefined;
1584
+ filingRefusal?: string | null | undefined;
1583
1585
  inserted?: boolean | null | undefined;
1584
1586
  languageModelSettled?: boolean | null | undefined;
1585
1587
  match?: {
@@ -1318,6 +1318,10 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
1318
1318
  UrlTypeAlias: { modulePath: "url/type-alias", schemaName: "UrlTypeAliasSchema" },
1319
1319
  ValuationType: { modulePath: "valuation/type", schemaName: "ValuationTypeSchema" },
1320
1320
  WebSearch: { modulePath: "web/search", schemaName: "WebSearchSchema" },
1321
+ WebSearchCacheSource: {
1322
+ modulePath: "web/search-cache-source",
1323
+ schemaName: "WebSearchCacheSourceSchema",
1324
+ },
1321
1325
  WebSearchProvider: { modulePath: "web/search-provider", schemaName: "WebSearchProviderSchema" },
1322
1326
  WebSearchRecency: { modulePath: "web/search-recency", schemaName: "WebSearchRecencySchema" },
1323
1327
  WriterAnalysisSection: {
@@ -28,7 +28,7 @@ export const RegistryFilingSchema = z.object({
28
28
  nameFormer: z.array(z.string()).max(10).optional(),
29
29
  /** People the filing names: executive officers, directors, promoters. */
30
30
  person: z.array(RegistryFilingPersonSchema).max(100).optional(),
31
- /** Registry ids the filing states, such as secCik, ein, or npi. A record holding the same id is strong evidence; a record holding a different id of the same type is a different filer and never matches. */
31
+ /** Registry ids the filing states, such as secCik, ein, or npi. A record holding the same non-EIN id is strong evidence; an EIN is a reported tax assertion, never independent identity evidence. Filing or claiming a source requires verified tax-owner evidence before any write; unresolved EINs return review. A record holding a different exclusive id of the same type is a different filer. */
32
32
  uniqueId: z.array(UniqueIdMutationSchema).max(5).optional(),
33
33
  });
34
34
  //# sourceMappingURL=filing.js.map
@@ -3,6 +3,10 @@ declare const SearchSchemaDefinition: z.ZodObject<{
3
3
  allowSuspectedShellStrip: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
4
4
  bypassCache: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
5
5
  cacheKey: z.ZodOptional<z.ZodNullable<z.ZodString>>;
6
+ cacheSource: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
7
+ ANY: "ANY";
8
+ PROVIDER: "PROVIDER";
9
+ }>>>;
6
10
  deep: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
7
11
  deferredAiOverview: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
8
12
  language: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -1,6 +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
  import { EntityPersonOwnerSchema } from "../entity/person-owner.js";
4
+ import { WebSearchCacheSourceSchema } from "../web/search-cache-source.js";
4
5
  import { WebSearchProviderSchema } from "../web/search-provider.js";
5
6
  import { WebSearchRecencySchema } from "../web/search-recency.js";
6
7
  const SearchSchemaDefinition = z.object({
@@ -10,6 +11,8 @@ const SearchSchemaDefinition = z.object({
10
11
  bypassCache: z.boolean().default(false).optional(),
11
12
  /** Stable lookup text for cache keying when generated search text varies between runs */
12
13
  cacheKey: z.string().nullish(),
14
+ /** Permit compatible cached results from ANY provider by default, or restrict to PROVIDER. The provider field independently selects live misses; bypassCache skips every provider's cache. document.provider identifies the serving source. */
15
+ cacheSource: WebSearchCacheSourceSchema.default("ANY").optional(),
13
16
  /** Deprecated alias for `provider: EXA_DEEP`; `true` with any other `provider` is refused with 400. */
14
17
  deep: z.boolean().default(false).optional(),
15
18
  /** Wait in-request for Google's AI Overview when Google defers it to a follow-up request, as it does for most company and person lookups: one extra SerpAPI search per overview not already stored. An explicit `true` also reruns a stored search older than SerpAPI's one-hour cache to get a fresh token (its one-minute overview token expired and the cache would return it unchanged). Without it, no deferred overview is fetched; one an earlier fetch stored still comes back at no extra cost. A fetch that returns no overview is not retried for six hours. An overview Google returns inline always comes back in `aiOverview` at no extra cost. Exa results never carry one. */
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Create or merge-patch an external identifier mapping. Omitted fields preserve existing values; listing qualifiers apply only to entity tickers.
3
+ * Create or merge-patch an external identifier mapping. Omitted fields preserve existing values; listing qualifiers apply only to entity tickers. A new or changed EIN requires independently verified tax-owner evidence; an unheld number or source label does not establish ownership. Unchanged bindings and label-only patches preserve the existing tax identity.
4
4
  *
5
5
  * @openapiSchema UniqueIdMutation
6
6
  * @endpoint GET /v1/lookup-jobs/{jobId}
@@ -2,7 +2,7 @@
2
2
  import { z } from "zod/v4";
3
3
  import { UniqueIdListingStandingSchema } from "./id-listing-standing.js";
4
4
  /**
5
- * Create or merge-patch an external identifier mapping. Omitted fields preserve existing values; listing qualifiers apply only to entity tickers.
5
+ * Create or merge-patch an external identifier mapping. Omitted fields preserve existing values; listing qualifiers apply only to entity tickers. A new or changed EIN requires independently verified tax-owner evidence; an unheld number or source label does not establish ownership. Unchanged bindings and label-only patches preserve the existing tax identity.
6
6
  *
7
7
  * @openapiSchema UniqueIdMutation
8
8
  * @endpoint GET /v1/lookup-jobs/{jobId}
@@ -36,6 +36,7 @@ export declare const UniqueIdTypeSchema: z.ZodUnion<readonly [z.ZodEnum<{
36
36
  ipedsUnitId: "ipedsUnitId";
37
37
  isin: "isin";
38
38
  lei: "lei";
39
+ naicCompanyCode: "naicCompanyCode";
39
40
  ncesLeaId: "ncesLeaId";
40
41
  ncesPssId: "ncesPssId";
41
42
  ncesSchoolId: "ncesSchoolId";
@@ -62,6 +63,7 @@ export declare const UniqueIdTypeSchema: z.ZodUnion<readonly [z.ZodEnum<{
62
63
  ipedsUnitId: "ipedsUnitId";
63
64
  isin: "isin";
64
65
  lei: "lei";
66
+ naicCompanyCode: "naicCompanyCode";
65
67
  ncesLeaId: "ncesLeaId";
66
68
  ncesPssId: "ncesPssId";
67
69
  ncesSchoolId: "ncesSchoolId";
@@ -21,6 +21,7 @@ const UniqueIdTypeSchemaKnownMembers = z.enum([
21
21
  "ncuaCharter",
22
22
  "rssd",
23
23
  "holdingCompanyRssd",
24
+ "naicCompanyCode",
24
25
  "signalNfxFirm",
25
26
  "signalNfxPerson",
26
27
  "signalNfxCompany",
@@ -17,6 +17,7 @@ declare const UniqueIdSchemaDefinition: z.ZodObject<{
17
17
  ipedsUnitId: "ipedsUnitId";
18
18
  isin: "isin";
19
19
  lei: "lei";
20
+ naicCompanyCode: "naicCompanyCode";
20
21
  ncesLeaId: "ncesLeaId";
21
22
  ncesPssId: "ncesPssId";
22
23
  ncesSchoolId: "ncesSchoolId";
@@ -43,6 +44,7 @@ declare const UniqueIdSchemaDefinition: z.ZodObject<{
43
44
  ipedsUnitId: "ipedsUnitId";
44
45
  isin: "isin";
45
46
  lei: "lei";
47
+ naicCompanyCode: "naicCompanyCode";
46
48
  ncesLeaId: "ncesLeaId";
47
49
  ncesPssId: "ncesPssId";
48
50
  ncesSchoolId: "ncesSchoolId";
@@ -0,0 +1,17 @@
1
+ import { z } from "zod/v4";
2
+ /**
3
+ * ANY reuses a compatible cached web search from any provider, checking the selected provider first. PROVIDER restricts reuse to the selected live provider. Neither option changes bypassCache, which always fetches from the live provider.
4
+ *
5
+ * @openapiSchema WebSearchCacheSource
6
+ * @endpoint GET /v1/web/searches/jobs/{jobId}
7
+ * @endpoint POST /v1/web/search
8
+ * @usedBySchema SearchSchema
9
+ * @contractShape web.search-cache-source
10
+ * @contractRole canonical
11
+ */
12
+ export declare const WebSearchCacheSourceSchema: z.ZodEnum<{
13
+ ANY: "ANY";
14
+ PROVIDER: "PROVIDER";
15
+ }>;
16
+ export type WebSearchCacheSource = z.infer<typeof WebSearchCacheSourceSchema>;
17
+ //# sourceMappingURL=search-cache-source.d.ts.map
@@ -0,0 +1,14 @@
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
+ import { z } from "zod/v4";
3
+ /**
4
+ * ANY reuses a compatible cached web search from any provider, checking the selected provider first. PROVIDER restricts reuse to the selected live provider. Neither option changes bypassCache, which always fetches from the live provider.
5
+ *
6
+ * @openapiSchema WebSearchCacheSource
7
+ * @endpoint GET /v1/web/searches/jobs/{jobId}
8
+ * @endpoint POST /v1/web/search
9
+ * @usedBySchema SearchSchema
10
+ * @contractShape web.search-cache-source
11
+ * @contractRole canonical
12
+ */
13
+ export const WebSearchCacheSourceSchema = z.enum(["ANY", "PROVIDER"]);
14
+ //# sourceMappingURL=search-cache-source.js.map
@@ -104,6 +104,7 @@ declare const WebSearchSchemaDefinition: z.ZodObject<{
104
104
  allowSuspectedShellStrip?: boolean | null | undefined;
105
105
  bypassCache?: boolean | undefined;
106
106
  cacheKey?: string | null | undefined;
107
+ cacheSource?: "ANY" | "PROVIDER" | undefined;
107
108
  deep?: boolean | undefined;
108
109
  deferredAiOverview?: boolean | undefined;
109
110
  language?: string | null | undefined;
@@ -121,6 +122,7 @@ declare const WebSearchSchemaDefinition: z.ZodObject<{
121
122
  allowSuspectedShellStrip?: boolean | null | undefined;
122
123
  bypassCache?: boolean | undefined;
123
124
  cacheKey?: string | null | undefined;
125
+ cacheSource?: "ANY" | "PROVIDER" | undefined;
124
126
  deep?: boolean | undefined;
125
127
  deferredAiOverview?: boolean | undefined;
126
128
  language?: string | null | undefined;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aventurevc/api-schemas",
3
- "version": "0.8.334",
3
+ "version": "0.8.336",
4
4
  "private": false,
5
5
  "description": "Zod v4 schemas and TypeScript types for the aVenture API.",
6
6
  "license": "Apache-2.0",