@aventurevc/api-schemas 0.8.174 → 0.8.176
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/agent/help-question.d.ts +1 -1
- package/dist/agent/help-question.js +4 -4
- package/dist/agent/help.d.ts +1 -1
- package/dist/agent/help.js +1 -1
- package/dist/classification/catalog-bucket.js +2 -2
- package/dist/classification/catalog.d.ts +1 -1
- package/dist/classification/catalog.js +1 -1
- package/dist/classification/inactive-tag-details.d.ts +7 -0
- package/dist/classification/inactive-tag-details.js +4 -1
- package/dist/domain/conflict-details.d.ts +11 -1
- package/dist/domain/conflict-details.js +1 -1
- package/dist/domain/conflict-type.d.ts +24 -0
- package/dist/domain/conflict-type.js +27 -0
- package/dist/duplicate/create-review.d.ts +7 -0
- package/dist/duplicate/create-review.js +3 -0
- package/dist/enrichment/mode.d.ts +2 -2
- package/dist/enrichment/mode.js +2 -2
- package/dist/entity/alias-type.d.ts +1 -1
- package/dist/entity/alias-type.js +1 -1
- package/dist/entity/classification-suggestion.d.ts +1 -1
- package/dist/entity/classification-suggestion.js +3 -3
- package/dist/entity/classification.d.ts +1 -1
- package/dist/entity/classification.js +2 -2
- package/dist/entity/enrichment.js +1 -1
- package/dist/entity/entity.d.ts +2 -2
- package/dist/entity/entity.js +2 -2
- package/dist/entity/image.d.ts +1 -1
- package/dist/entity/image.js +1 -1
- package/dist/entity/investments-param.d.ts +0 -1
- package/dist/entity/investments-param.js +0 -2
- package/dist/entity/investors-param.d.ts +1 -1
- package/dist/entity/investors-param.js +2 -2
- package/dist/entity/lookup-batch-param.d.ts +0 -1
- package/dist/entity/lookup-batch-param.js +0 -2
- package/dist/entity/lookup-exact-param.d.ts +0 -1
- package/dist/entity/lookup-exact-param.js +0 -2
- package/dist/entity/name-alias-entity-alias-type.d.ts +1 -1
- package/dist/entity/name-alias-entity-alias-type.js +1 -1
- package/dist/entity/people-param.d.ts +0 -1
- package/dist/entity/people-param.js +0 -2
- package/dist/entity/relationship.js +3 -3
- package/dist/entity/research-detail.d.ts +1 -1
- package/dist/entity/research-detail.js +1 -1
- package/dist/entity/search-param.d.ts +0 -1
- package/dist/entity/search-param.js +1 -3
- package/dist/entity/sitemap.d.ts +1 -1
- package/dist/entity/sitemap.js +1 -1
- package/dist/entity/tag.d.ts +1 -1
- package/dist/entity/tag.js +8 -8
- package/dist/entity/valuation-data-confidence.d.ts +1 -1
- package/dist/entity/valuation-data-confidence.js +1 -1
- package/dist/federated/natural-search.js +4 -4
- package/dist/harness/chassis.d.ts +2 -2
- package/dist/harness/chassis.js +2 -2
- package/dist/harness/llm-api.d.ts +2 -2
- package/dist/harness/llm-api.js +2 -2
- package/dist/harness/run-create.d.ts +1 -1
- package/dist/harness/run-create.js +1 -1
- package/dist/harness/run-detail.d.ts +2 -2
- package/dist/harness/run-detail.js +5 -5
- package/dist/harness/run-environment.d.ts +2 -5
- package/dist/harness/run-environment.js +2 -5
- package/dist/harness/run-lane.d.ts +2 -2
- package/dist/harness/run-lane.js +2 -2
- package/dist/harness/run-progress.d.ts +1 -1
- package/dist/harness/run-progress.js +2 -2
- package/dist/harness/run-status.d.ts +3 -3
- package/dist/harness/run-status.js +3 -3
- package/dist/harness/run-type.d.ts +3 -3
- package/dist/harness/run-type.js +3 -3
- package/dist/harness/run.d.ts +3 -3
- package/dist/harness/run.js +10 -10
- package/dist/help/resolution.js +1 -1
- package/dist/http/problem-detail.d.ts +10 -0
- package/dist/http/problem-detail.js +18 -3
- package/dist/identification/candidate.js +4 -4
- package/dist/identification/identification.d.ts +2 -4
- package/dist/identification/identification.js +7 -11
- package/dist/identification/subject.js +1 -1
- package/dist/lookup/job-mention.d.ts +3 -5
- package/dist/lookup/job-mention.js +5 -5
- package/dist/lookup/job-mutation.js +2 -2
- package/dist/lookup/job.d.ts +4 -10
- package/dist/lookup/mention.js +1 -1
- package/dist/media/upload.js +1 -1
- package/dist/mention/lookup.d.ts +2 -6
- package/dist/natural/search-result.js +1 -1
- package/dist/natural/search.js +4 -4
- package/dist/news/resolved-entity-link.js +1 -0
- package/dist/news/source-url-conflict.d.ts +7 -0
- package/dist/news/source-url-conflict.js +3 -0
- package/dist/openapi-component-manifest.js +4 -9
- package/dist/person/lookup-batch-param.d.ts +0 -1
- package/dist/person/lookup-batch-param.js +0 -2
- package/dist/person/lookup-exact-param.d.ts +0 -1
- package/dist/person/lookup-exact-param.js +0 -2
- package/dist/person/natural-search-result.js +1 -1
- package/dist/person/search-param.d.ts +0 -1
- package/dist/person/search-param.js +0 -2
- package/dist/research/finding.d.ts +1 -1
- package/dist/research/finding.js +1 -1
- package/dist/search/search.d.ts +0 -8
- package/dist/search/search.js +4 -11
- package/dist/standardized/classification.d.ts +1 -1
- package/dist/standardized/classification.js +4 -4
- package/dist/strict/url-lookup-conflict.d.ts +7 -0
- package/dist/strict/url-lookup-conflict.js +3 -0
- package/dist/system/status.js +1 -1
- package/dist/url/duplicate-conflict.d.ts +7 -0
- package/dist/url/duplicate-conflict.js +3 -0
- package/dist/url/duplicate-join.d.ts +1 -1
- package/dist/url/duplicate-join.js +2 -2
- package/dist/web/search.d.ts +0 -6
- package/package.json +1 -1
- package/dist/datasource/data-source-type.d.ts +0 -24
- package/dist/datasource/data-source-type.js +0 -24
- package/dist/datasource/provenance-actor-type.d.ts +0 -15
- package/dist/datasource/provenance-actor-type.js +0 -12
- package/dist/suppression/reason.d.ts +0 -17
- package/dist/suppression/reason.js +0 -16
|
@@ -14,7 +14,7 @@ type AgentHelpQuestionDefinition = z.infer<typeof AgentHelpQuestionSchemaDefinit
|
|
|
14
14
|
export interface AgentHelpQuestionSchemaInput extends z.input<typeof AgentHelpQuestionSchemaDefinition> {
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
|
-
* A
|
|
17
|
+
* A plain-English question about how to use aVenture, answered with references to the operations that do it.
|
|
18
18
|
*
|
|
19
19
|
* @openapiSchema AgentHelpQuestion
|
|
20
20
|
* @endpoint POST /v1/agents/help
|
|
@@ -2,19 +2,19 @@
|
|
|
2
2
|
import { z } from "zod/v4";
|
|
3
3
|
import { HelpScopeSchema } from "../help/scope.js";
|
|
4
4
|
const AgentHelpQuestionSchemaDefinition = z.object({
|
|
5
|
-
/** False limits
|
|
5
|
+
/** False limits answers to operations every account can run; omit it to match your account's access. */
|
|
6
6
|
includePrivate: z.boolean().nullish(),
|
|
7
|
-
/** Optional
|
|
7
|
+
/** Optional supported model for the answer. Omit it to use the default; an unsupported model answers 422. */
|
|
8
8
|
model: z.string().nullish(),
|
|
9
9
|
/** The question to answer, in natural language. */
|
|
10
10
|
question: z.string().max(2000),
|
|
11
|
-
/** True
|
|
11
|
+
/** True recommends the operation or workflow that does what the question asks, or asks a clarifying question, instead of writing an answer. It ignores model and has its own per-account limit. */
|
|
12
12
|
resolve: z.boolean().optional(),
|
|
13
13
|
/** Optional scope restricting which operations the answer may recommend; null means all. */
|
|
14
14
|
scope: HelpScopeSchema.nullish(),
|
|
15
15
|
});
|
|
16
16
|
/**
|
|
17
|
-
* A
|
|
17
|
+
* A plain-English question about how to use aVenture, answered with references to the operations that do it.
|
|
18
18
|
*
|
|
19
19
|
* @openapiSchema AgentHelpQuestion
|
|
20
20
|
* @endpoint POST /v1/agents/help
|
package/dist/agent/help.d.ts
CHANGED
|
@@ -91,7 +91,7 @@ type AgentHelpDefinition = z.infer<typeof AgentHelpSchemaDefinition>;
|
|
|
91
91
|
export interface AgentHelpSchemaInput extends z.input<typeof AgentHelpSchemaDefinition> {
|
|
92
92
|
}
|
|
93
93
|
/**
|
|
94
|
-
*
|
|
94
|
+
* Help answer with citations to the operations it draws on. Unsupported questions abstain (LOW confidence) rather than guess.
|
|
95
95
|
*
|
|
96
96
|
* @openapiSchema AgentHelp
|
|
97
97
|
* @endpoint POST /v1/agents/help
|
package/dist/agent/help.js
CHANGED
|
@@ -14,7 +14,7 @@ const AgentHelpSchemaDefinition = z.object({
|
|
|
14
14
|
resolution: HelpResolutionSchema.nullish(),
|
|
15
15
|
});
|
|
16
16
|
/**
|
|
17
|
-
*
|
|
17
|
+
* Help answer with citations to the operations it draws on. Unsupported questions abstain (LOW confidence) rather than guess.
|
|
18
18
|
*
|
|
19
19
|
* @openapiSchema AgentHelp
|
|
20
20
|
* @endpoint POST /v1/agents/help
|
|
@@ -4,7 +4,7 @@ import { EntityTagSchema } from "../entity/tag.js";
|
|
|
4
4
|
const ClassificationCatalogBucketSchemaDefinition = z.object({
|
|
5
5
|
/** Other accepted spellings for this bucket (JSON key plus storage form, deduplicated against `type`). The /tags ?type= and /catalog ?bucketType= parameters accept any of `[type, ...alias]`. Empty when the bucket has only one canonical spelling. */
|
|
6
6
|
alias: z.array(z.string()),
|
|
7
|
-
/** Canonical
|
|
7
|
+
/** Canonical classification bucket key. */
|
|
8
8
|
bucket: z.string().nullish(),
|
|
9
9
|
/** Whether missing values in this bucket can be created by name. */
|
|
10
10
|
creatable: z.boolean(),
|
|
@@ -12,7 +12,7 @@ const ClassificationCatalogBucketSchemaDefinition = z.object({
|
|
|
12
12
|
hierarchical: z.boolean(),
|
|
13
13
|
/** Human-readable bucket label (e.g. 'Revenue Model'). */
|
|
14
14
|
label: z.string(),
|
|
15
|
-
/** Active
|
|
15
|
+
/** Active tags only. Empty when includeTags=false. */
|
|
16
16
|
tag: z.array(EntityTagSchema),
|
|
17
17
|
/** Total active tags in this bucket. Populated regardless of `includeTags` so callers can decide whether to fetch detail without a follow-up count query. */
|
|
18
18
|
tagCount: z.int(),
|
|
@@ -114,7 +114,7 @@ type ClassificationCatalogDefinition = z.infer<typeof ClassificationCatalogSchem
|
|
|
114
114
|
export interface ClassificationCatalogSchemaInput extends z.input<typeof ClassificationCatalogSchemaDefinition> {
|
|
115
115
|
}
|
|
116
116
|
/**
|
|
117
|
-
* Full active entity classification taxonomy in one payload.
|
|
117
|
+
* Full active entity classification taxonomy in one payload. Inactive tags are omitted.
|
|
118
118
|
*
|
|
119
119
|
* @openapiSchema ClassificationCatalog
|
|
120
120
|
* @endpoint GET /v1/entities/classifications/catalog
|
|
@@ -12,7 +12,7 @@ const ClassificationCatalogSchemaDefinition = z.object({
|
|
|
12
12
|
totalTag: z.int(),
|
|
13
13
|
});
|
|
14
14
|
/**
|
|
15
|
-
* Full active entity classification taxonomy in one payload.
|
|
15
|
+
* Full active entity classification taxonomy in one payload. Inactive tags are omitted.
|
|
16
16
|
*
|
|
17
17
|
* @openapiSchema ClassificationCatalog
|
|
18
18
|
* @endpoint GET /v1/entities/classifications/catalog
|
|
@@ -4,6 +4,13 @@ declare const ClassificationInactiveTagDetailsSchemaDefinition: z.ZodObject<{
|
|
|
4
4
|
ATTACH_INACTIVE: "ATTACH_INACTIVE";
|
|
5
5
|
REACTIVATE: "REACTIVATE";
|
|
6
6
|
}>>;
|
|
7
|
+
conflictType: z.ZodOptional<z.ZodUnion<readonly [z.ZodEnum<{
|
|
8
|
+
CLASSIFICATION_INACTIVE_TAG: "CLASSIFICATION_INACTIVE_TAG";
|
|
9
|
+
DUPLICATE_CREATE_REVIEW: "DUPLICATE_CREATE_REVIEW";
|
|
10
|
+
NEWS_SOURCE_URL: "NEWS_SOURCE_URL";
|
|
11
|
+
STRICT_URL_LOOKUP: "STRICT_URL_LOOKUP";
|
|
12
|
+
URL_DUPLICATE: "URL_DUPLICATE";
|
|
13
|
+
}>, z.ZodString]>>;
|
|
7
14
|
slug: z.ZodString;
|
|
8
15
|
tagId: z.ZodInt;
|
|
9
16
|
}, z.core.$strip>;
|
|
@@ -1,12 +1,15 @@
|
|
|
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 { EntityClassificationInactiveTagOverrideSchema } from "../entity/classification-inactive-tag-override.js";
|
|
4
5
|
const ClassificationInactiveTagDetailsSchemaDefinition = z.object({
|
|
5
6
|
/** Allowed inactiveTagOverride values for this conflict */
|
|
6
7
|
availableOverrides: z.array(EntityClassificationInactiveTagOverrideSchema),
|
|
8
|
+
/** Conflict kind that identifies this details shape. */
|
|
9
|
+
conflictType: DomainConflictTypeSchema.optional(),
|
|
7
10
|
/** Existing dormant value slug or lookup key */
|
|
8
11
|
slug: z.string(),
|
|
9
|
-
/** Existing tag id
|
|
12
|
+
/** Existing tag id */
|
|
10
13
|
tagId: z.int(),
|
|
11
14
|
});
|
|
12
15
|
/**
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { z } from "zod/v4";
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* Details of an HTTP 409 conflict. conflictType names the shape: URL_DUPLICATE when the URL is already a current URL on another record; STRICT_URL_LOOKUP when an exact URL lookup matches more than one record; DUPLICATE_CREATE_REVIEW when a create or lookup returns candidate records to review; CLASSIFICATION_INACTIVE_TAG when a classification value exists but is inactive; NEWS_SOURCE_URL when another article already has the same publication and URL.
|
|
4
4
|
*
|
|
5
5
|
* @openapiSchema DomainConflictDetails
|
|
6
6
|
* @standardProblemResponse
|
|
@@ -9,6 +9,7 @@ import { z } from "zod/v4";
|
|
|
9
9
|
* @contractRole canonical
|
|
10
10
|
*/
|
|
11
11
|
export declare const DomainConflictDetailsSchema: z.ZodUnion<readonly [z.ZodType<{
|
|
12
|
+
conflictType?: string | undefined;
|
|
12
13
|
existingJoin: {
|
|
13
14
|
owner: {
|
|
14
15
|
entityId?: string | null | undefined;
|
|
@@ -26,6 +27,7 @@ export declare const DomainConflictDetailsSchema: z.ZodUnion<readonly [z.ZodType
|
|
|
26
27
|
url: string;
|
|
27
28
|
urlType: string;
|
|
28
29
|
}, import("../url/duplicate-conflict.ts").UrlDuplicateConflictSchemaInput, z.core.$ZodTypeInternals<{
|
|
30
|
+
conflictType?: string | undefined;
|
|
29
31
|
existingJoin: {
|
|
30
32
|
owner: {
|
|
31
33
|
entityId?: string | null | undefined;
|
|
@@ -45,6 +47,7 @@ export declare const DomainConflictDetailsSchema: z.ZodUnion<readonly [z.ZodType
|
|
|
45
47
|
}, import("../url/duplicate-conflict.ts").UrlDuplicateConflictSchemaInput>>, z.ZodType<{
|
|
46
48
|
candidateEntityId: string[];
|
|
47
49
|
candidatePersonId: string[];
|
|
50
|
+
conflictType?: string | undefined;
|
|
48
51
|
hint: string;
|
|
49
52
|
normalizedUrl?: string | null | undefined;
|
|
50
53
|
url: string;
|
|
@@ -52,6 +55,7 @@ export declare const DomainConflictDetailsSchema: z.ZodUnion<readonly [z.ZodType
|
|
|
52
55
|
}, import("../strict/url-lookup-conflict.ts").StrictUrlLookupConflictSchemaInput, z.core.$ZodTypeInternals<{
|
|
53
56
|
candidateEntityId: string[];
|
|
54
57
|
candidatePersonId: string[];
|
|
58
|
+
conflictType?: string | undefined;
|
|
55
59
|
hint: string;
|
|
56
60
|
normalizedUrl?: string | null | undefined;
|
|
57
61
|
url: string;
|
|
@@ -68,6 +72,7 @@ export declare const DomainConflictDetailsSchema: z.ZodUnion<readonly [z.ZodType
|
|
|
68
72
|
slug?: string | null | undefined;
|
|
69
73
|
typeRecord?: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service" | null | undefined;
|
|
70
74
|
}[] | null | undefined;
|
|
75
|
+
conflictType?: string | undefined;
|
|
71
76
|
newsCandidate?: {
|
|
72
77
|
externalId?: string | null | undefined;
|
|
73
78
|
id: number;
|
|
@@ -89,6 +94,7 @@ export declare const DomainConflictDetailsSchema: z.ZodUnion<readonly [z.ZodType
|
|
|
89
94
|
slug?: string | null | undefined;
|
|
90
95
|
typeRecord?: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service" | null | undefined;
|
|
91
96
|
}[] | null | undefined;
|
|
97
|
+
conflictType?: string | undefined;
|
|
92
98
|
newsCandidate?: {
|
|
93
99
|
externalId?: string | null | undefined;
|
|
94
100
|
id: number;
|
|
@@ -100,20 +106,24 @@ export declare const DomainConflictDetailsSchema: z.ZodUnion<readonly [z.ZodType
|
|
|
100
106
|
threshold: number;
|
|
101
107
|
}, import("../duplicate/create-review.ts").DuplicateCreateReviewSchemaInput>>, z.ZodType<{
|
|
102
108
|
availableOverrides: ("ATTACH_INACTIVE" | "REACTIVATE")[];
|
|
109
|
+
conflictType?: string | undefined;
|
|
103
110
|
slug: string;
|
|
104
111
|
tagId: number;
|
|
105
112
|
}, import("../classification/inactive-tag-details.ts").ClassificationInactiveTagDetailsSchemaInput, z.core.$ZodTypeInternals<{
|
|
106
113
|
availableOverrides: ("ATTACH_INACTIVE" | "REACTIVATE")[];
|
|
114
|
+
conflictType?: string | undefined;
|
|
107
115
|
slug: string;
|
|
108
116
|
tagId: number;
|
|
109
117
|
}, import("../classification/inactive-tag-details.ts").ClassificationInactiveTagDetailsSchemaInput>>, z.ZodType<{
|
|
110
118
|
conflictingArticleId: number;
|
|
111
119
|
conflictingArticleSlug: string;
|
|
112
120
|
conflictingArticleTitle: string;
|
|
121
|
+
conflictType?: string | undefined;
|
|
113
122
|
}, import("../news/source-url-conflict.ts").NewsSourceUrlConflictSchemaInput, z.core.$ZodTypeInternals<{
|
|
114
123
|
conflictingArticleId: number;
|
|
115
124
|
conflictingArticleSlug: string;
|
|
116
125
|
conflictingArticleTitle: string;
|
|
126
|
+
conflictType?: string | undefined;
|
|
117
127
|
}, import("../news/source-url-conflict.ts").NewsSourceUrlConflictSchemaInput>>]>;
|
|
118
128
|
export type DomainConflictDetails = z.infer<typeof DomainConflictDetailsSchema>;
|
|
119
129
|
//# sourceMappingURL=conflict-details.d.ts.map
|
|
@@ -6,7 +6,7 @@ import { NewsSourceUrlConflictSchema } from "../news/source-url-conflict.js";
|
|
|
6
6
|
import { StrictUrlLookupConflictSchema } from "../strict/url-lookup-conflict.js";
|
|
7
7
|
import { UrlDuplicateConflictSchema } from "../url/duplicate-conflict.js";
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* Details of an HTTP 409 conflict. conflictType names the shape: URL_DUPLICATE when the URL is already a current URL on another record; STRICT_URL_LOOKUP when an exact URL lookup matches more than one record; DUPLICATE_CREATE_REVIEW when a create or lookup returns candidate records to review; CLASSIFICATION_INACTIVE_TAG when a classification value exists but is inactive; NEWS_SOURCE_URL when another article already has the same publication and URL.
|
|
10
10
|
*
|
|
11
11
|
* @openapiSchema DomainConflictDetails
|
|
12
12
|
* @standardProblemResponse
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { z } from "zod/v4";
|
|
2
|
+
/**
|
|
3
|
+
* Conflict kind that identifies which details shape a 409 response carries.
|
|
4
|
+
*
|
|
5
|
+
* @openapiSchema DomainConflictType
|
|
6
|
+
* @standardProblemResponse
|
|
7
|
+
* @usedBySchema ClassificationInactiveTagDetailsSchema
|
|
8
|
+
* @usedBySchema DomainConflictDetailsSchema
|
|
9
|
+
* @usedBySchema DuplicateCreateReviewSchema
|
|
10
|
+
* @usedBySchema NewsSourceUrlConflictSchema
|
|
11
|
+
* @usedBySchema StrictUrlLookupConflictSchema
|
|
12
|
+
* @usedBySchema UrlDuplicateConflictSchema
|
|
13
|
+
* @contractShape domain.conflict-type
|
|
14
|
+
* @contractRole canonical
|
|
15
|
+
*/
|
|
16
|
+
export declare const DomainConflictTypeSchema: z.ZodUnion<readonly [z.ZodEnum<{
|
|
17
|
+
CLASSIFICATION_INACTIVE_TAG: "CLASSIFICATION_INACTIVE_TAG";
|
|
18
|
+
DUPLICATE_CREATE_REVIEW: "DUPLICATE_CREATE_REVIEW";
|
|
19
|
+
NEWS_SOURCE_URL: "NEWS_SOURCE_URL";
|
|
20
|
+
STRICT_URL_LOOKUP: "STRICT_URL_LOOKUP";
|
|
21
|
+
URL_DUPLICATE: "URL_DUPLICATE";
|
|
22
|
+
}>, z.ZodString]>;
|
|
23
|
+
export type DomainConflictType = z.infer<typeof DomainConflictTypeSchema>;
|
|
24
|
+
//# sourceMappingURL=conflict-type.d.ts.map
|
|
@@ -0,0 +1,27 @@
|
|
|
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
|
+
* Conflict kind that identifies which details shape a 409 response carries.
|
|
5
|
+
*
|
|
6
|
+
* @openapiSchema DomainConflictType
|
|
7
|
+
* @standardProblemResponse
|
|
8
|
+
* @usedBySchema ClassificationInactiveTagDetailsSchema
|
|
9
|
+
* @usedBySchema DomainConflictDetailsSchema
|
|
10
|
+
* @usedBySchema DuplicateCreateReviewSchema
|
|
11
|
+
* @usedBySchema NewsSourceUrlConflictSchema
|
|
12
|
+
* @usedBySchema StrictUrlLookupConflictSchema
|
|
13
|
+
* @usedBySchema UrlDuplicateConflictSchema
|
|
14
|
+
* @contractShape domain.conflict-type
|
|
15
|
+
* @contractRole canonical
|
|
16
|
+
*/
|
|
17
|
+
export const DomainConflictTypeSchema = z.union([
|
|
18
|
+
z.enum([
|
|
19
|
+
"URL_DUPLICATE",
|
|
20
|
+
"STRICT_URL_LOOKUP",
|
|
21
|
+
"DUPLICATE_CREATE_REVIEW",
|
|
22
|
+
"CLASSIFICATION_INACTIVE_TAG",
|
|
23
|
+
"NEWS_SOURCE_URL",
|
|
24
|
+
]),
|
|
25
|
+
z.string(),
|
|
26
|
+
]);
|
|
27
|
+
//# sourceMappingURL=conflict-type.js.map
|
|
@@ -21,6 +21,13 @@ declare const DuplicateCreateReviewSchemaDefinition: z.ZodObject<{
|
|
|
21
21
|
slug?: string | null | undefined;
|
|
22
22
|
typeRecord?: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service" | null | undefined;
|
|
23
23
|
}, import("../search/duplicate-candidate-score.ts").SearchDuplicateCandidateScoreSchemaInput>>>>>;
|
|
24
|
+
conflictType: z.ZodOptional<z.ZodUnion<readonly [z.ZodEnum<{
|
|
25
|
+
CLASSIFICATION_INACTIVE_TAG: "CLASSIFICATION_INACTIVE_TAG";
|
|
26
|
+
DUPLICATE_CREATE_REVIEW: "DUPLICATE_CREATE_REVIEW";
|
|
27
|
+
NEWS_SOURCE_URL: "NEWS_SOURCE_URL";
|
|
28
|
+
STRICT_URL_LOOKUP: "STRICT_URL_LOOKUP";
|
|
29
|
+
URL_DUPLICATE: "URL_DUPLICATE";
|
|
30
|
+
}>, z.ZodString]>>;
|
|
24
31
|
newsCandidate: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
|
|
25
32
|
externalId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
26
33
|
id: z.ZodInt;
|
|
@@ -1,10 +1,13 @@
|
|
|
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 { NewsCandidateScoreSchema } from "../news/candidate-score.js";
|
|
4
5
|
import { SearchDuplicateCandidateScoreSchema } from "../search/duplicate-candidate-score.js";
|
|
5
6
|
const DuplicateCreateReviewSchemaDefinition = z.object({
|
|
6
7
|
/** Entity/person candidates returned by lookup or create duplicate review. If a candidate is the requested record, read/update that candidate by id. Create with duplicate override only after every candidate is reviewed as distinct. */
|
|
7
8
|
candidate: z.array(SearchDuplicateCandidateScoreSchema).nullish(),
|
|
9
|
+
/** Conflict kind that identifies this details shape. */
|
|
10
|
+
conflictType: DomainConflictTypeSchema.optional(),
|
|
8
11
|
/** News candidates returned by lookup or create duplicate review. If a candidate is the requested article, read/update that article by id. Otherwise block until source evidence proves a distinct article. */
|
|
9
12
|
newsCandidate: z.array(NewsCandidateScoreSchema).nullish(),
|
|
10
13
|
/** Create endpoint to retry only after reviewing the returned candidates and supplying overrideGate=duplicate and overrideReason as query parameters. Null for detail lookup ambiguity, where the next action is review/update/block. */
|
|
@@ -3,11 +3,11 @@ import { z } from "zod/v4";
|
|
|
3
3
|
* Whether the run performs comprehensive enrichment or only selected tasks
|
|
4
4
|
*
|
|
5
5
|
* @openapiSchema EnrichmentMode
|
|
6
|
-
* @endpoint GET /v1/
|
|
6
|
+
* @endpoint GET /v1/research-runs/{runId}
|
|
7
7
|
* @endpoint POST /v1/enrichments
|
|
8
8
|
* @endpoint POST /v1/entities/{entityId}/enrichments
|
|
9
|
-
* @endpoint POST /v1/harness/runs
|
|
10
9
|
* @endpoint POST /v1/people/{personId}/enrichments
|
|
10
|
+
* @endpoint POST /v1/research-runs
|
|
11
11
|
* @usedBySchema EnrichmentBatchSchema
|
|
12
12
|
* @usedBySchema HarnessRunCreateSchema
|
|
13
13
|
* @usedBySchema HarnessRunSchema
|
package/dist/enrichment/mode.js
CHANGED
|
@@ -4,11 +4,11 @@ import { z } from "zod/v4";
|
|
|
4
4
|
* Whether the run performs comprehensive enrichment or only selected tasks
|
|
5
5
|
*
|
|
6
6
|
* @openapiSchema EnrichmentMode
|
|
7
|
-
* @endpoint GET /v1/
|
|
7
|
+
* @endpoint GET /v1/research-runs/{runId}
|
|
8
8
|
* @endpoint POST /v1/enrichments
|
|
9
9
|
* @endpoint POST /v1/entities/{entityId}/enrichments
|
|
10
|
-
* @endpoint POST /v1/harness/runs
|
|
11
10
|
* @endpoint POST /v1/people/{personId}/enrichments
|
|
11
|
+
* @endpoint POST /v1/research-runs
|
|
12
12
|
* @usedBySchema EnrichmentBatchSchema
|
|
13
13
|
* @usedBySchema HarnessRunCreateSchema
|
|
14
14
|
* @usedBySchema HarnessRunSchema
|
|
@@ -21,12 +21,12 @@ import { z } from "zod/v4";
|
|
|
21
21
|
* @endpoint GET /v1/entities/{entityId}/similar
|
|
22
22
|
* @endpoint GET /v1/entities/{entityId}/similar/summary
|
|
23
23
|
* @endpoint GET /v1/entities/relationships/{relationshipId}
|
|
24
|
-
* @endpoint GET /v1/harness/runs/{runId}
|
|
25
24
|
* @endpoint GET /v1/lookup-jobs/{jobId}
|
|
26
25
|
* @endpoint GET /v1/news/{newsId}/related-entities
|
|
27
26
|
* @endpoint GET /v1/people/{personId}
|
|
28
27
|
* @endpoint GET /v1/people/{personId}/graph
|
|
29
28
|
* @endpoint GET /v1/people/{personId}/investments
|
|
29
|
+
* @endpoint GET /v1/research-runs/{runId}
|
|
30
30
|
* @endpoint GET /v1/search/link/jobs/{jobId}
|
|
31
31
|
* @endpoint GET /v1/search/shared/{id}
|
|
32
32
|
* @endpoint GET /v1/search/shared/slug/{slug}
|
|
@@ -22,12 +22,12 @@ import { z } from "zod/v4";
|
|
|
22
22
|
* @endpoint GET /v1/entities/{entityId}/similar
|
|
23
23
|
* @endpoint GET /v1/entities/{entityId}/similar/summary
|
|
24
24
|
* @endpoint GET /v1/entities/relationships/{relationshipId}
|
|
25
|
-
* @endpoint GET /v1/harness/runs/{runId}
|
|
26
25
|
* @endpoint GET /v1/lookup-jobs/{jobId}
|
|
27
26
|
* @endpoint GET /v1/news/{newsId}/related-entities
|
|
28
27
|
* @endpoint GET /v1/people/{personId}
|
|
29
28
|
* @endpoint GET /v1/people/{personId}/graph
|
|
30
29
|
* @endpoint GET /v1/people/{personId}/investments
|
|
30
|
+
* @endpoint GET /v1/research-runs/{runId}
|
|
31
31
|
* @endpoint GET /v1/search/link/jobs/{jobId}
|
|
32
32
|
* @endpoint GET /v1/search/shared/{id}
|
|
33
33
|
* @endpoint GET /v1/search/shared/slug/{slug}
|
|
@@ -62,7 +62,7 @@ type EntityClassificationSuggestionDefinition = z.infer<typeof EntityClassificat
|
|
|
62
62
|
export interface EntityClassificationSuggestionSchemaInput extends z.input<typeof EntityClassificationSuggestionSchemaDefinition> {
|
|
63
63
|
}
|
|
64
64
|
/**
|
|
65
|
-
* Ranked classification suggestion derived from the
|
|
65
|
+
* Ranked classification suggestion derived from the entity profile and classification embeddings.
|
|
66
66
|
*
|
|
67
67
|
* @openapiSchema EntityClassificationSuggestion
|
|
68
68
|
* @endpoint GET /v1/entities/{entityId}/classifications/suggestions
|
|
@@ -3,9 +3,9 @@ import { z } from "zod/v4";
|
|
|
3
3
|
import { EntityTagSchema } from "./tag.js";
|
|
4
4
|
import { StandardizedClassificationSchema } from "../standardized/classification.js";
|
|
5
5
|
const EntityClassificationSuggestionSchemaDefinition = z.object({
|
|
6
|
-
/** True when the entity already has
|
|
6
|
+
/** True when the entity already has this classification, current or historical. */
|
|
7
7
|
alreadyJoined: z.boolean(),
|
|
8
|
-
/** Suggested
|
|
8
|
+
/** Suggested classification tag or standardized classification code. */
|
|
9
9
|
classification: z.union([EntityTagSchema, StandardizedClassificationSchema]),
|
|
10
10
|
/** Whether a missing editorial tag value may be created with type plus name instead of tagId. */
|
|
11
11
|
creatable: z.boolean(),
|
|
@@ -17,7 +17,7 @@ const EntityClassificationSuggestionSchemaDefinition = z.object({
|
|
|
17
17
|
writable: z.boolean(),
|
|
18
18
|
});
|
|
19
19
|
/**
|
|
20
|
-
* Ranked classification suggestion derived from the
|
|
20
|
+
* Ranked classification suggestion derived from the entity profile and classification embeddings.
|
|
21
21
|
*
|
|
22
22
|
* @openapiSchema EntityClassificationSuggestion
|
|
23
23
|
* @endpoint GET /v1/entities/{entityId}/classifications/suggestions
|
|
@@ -266,7 +266,7 @@ type EntityClassificationDefinition = z.infer<typeof EntityClassificationSchemaD
|
|
|
266
266
|
export interface EntityClassificationSchemaInput extends z.input<typeof EntityClassificationSchemaDefinition> {
|
|
267
267
|
}
|
|
268
268
|
/**
|
|
269
|
-
* Entity
|
|
269
|
+
* Entity classifications grouped by bucket. Reads return current classifications by default; includeInactive=true adds inactive and historical ones.
|
|
270
270
|
*
|
|
271
271
|
* @openapiSchema EntityClassification
|
|
272
272
|
* @endpoint GET /v1/entities
|
|
@@ -9,7 +9,7 @@ const EntityClassificationSchemaDefinition = z.object({
|
|
|
9
9
|
industry: z.array(EntityTagSchema).default([]).optional(),
|
|
10
10
|
/** Main product filter values */
|
|
11
11
|
mainProduct: z.array(EntityTagSchema).default([]).optional(),
|
|
12
|
-
/** Standardized
|
|
12
|
+
/** Standardized taxonomy classifications such as NAICS, SIC, or ISIC codes, with category and code metadata. */
|
|
13
13
|
standardizedClassification: z.array(StandardizedClassificationSchema).default([]).optional(),
|
|
14
14
|
/** Tag filter values */
|
|
15
15
|
tag: z.array(EntityTagSchema).default([]).optional(),
|
|
@@ -25,7 +25,7 @@ const EntityClassificationSchemaDefinition = z.object({
|
|
|
25
25
|
typeTechnologyUsed: z.array(EntityTagSchema).default([]).optional(),
|
|
26
26
|
});
|
|
27
27
|
/**
|
|
28
|
-
* Entity
|
|
28
|
+
* Entity classifications grouped by bucket. Reads return current classifications by default; includeInactive=true adds inactive and historical ones.
|
|
29
29
|
*
|
|
30
30
|
* @openapiSchema EntityClassification
|
|
31
31
|
* @endpoint GET /v1/entities
|
|
@@ -7,7 +7,7 @@ import { EntityTextBundleSchema } from "./text-bundle.js";
|
|
|
7
7
|
import { EntityUrlLinkSchema } from "./url-link.js";
|
|
8
8
|
const EntityEnrichmentSchemaDefinition = z.object({
|
|
9
9
|
address: z.array(AddressSchema),
|
|
10
|
-
/** Entity
|
|
10
|
+
/** Entity classifications. Single-detail and full-detail batch reads include history; list, default batch, and similar-entity reads may return only current classifications. Use GET /v1/entities/{entityId}/classifications?includeInactive=true for the full history. */
|
|
11
11
|
classification: EntityClassificationSchema,
|
|
12
12
|
fundingDetail: EntityFundingDetailSchema.nullish(),
|
|
13
13
|
/** Address id of the current headquarters: the current dominant (operating) address; absent when none is on record, even when a domicile (legal seat) exists. Read this instead of the deprecated isHq flag, which marks the legal seat. */
|
package/dist/entity/entity.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { z } from "zod/v4";
|
|
2
2
|
/**
|
|
3
|
-
* Flat entity core record — identity, naming, status, image, and source metadata. An entity is our umbrella record for organizations such as companies, funds, investment firms and investors, accelerators, nonprofits, and government agencies, plus products and services connected to those organizations.
|
|
3
|
+
* Flat entity core record — identity, naming, status, image, and source metadata. An entity is our umbrella record for organizations such as companies, funds, investment firms and investors, accelerators, nonprofits, and government agencies, plus products and services connected to those organizations. Nested as .core inside EntityList for default list reads and EntityDetail for detail reads.
|
|
4
4
|
*
|
|
5
5
|
* @openapiSchema Entity
|
|
6
6
|
* @endpoint GET /v1/entities
|
|
@@ -21,12 +21,12 @@ import { z } from "zod/v4";
|
|
|
21
21
|
* @endpoint GET /v1/entities/{entityId}/similar
|
|
22
22
|
* @endpoint GET /v1/entities/{entityId}/similar/summary
|
|
23
23
|
* @endpoint GET /v1/entities/relationships/{relationshipId}
|
|
24
|
-
* @endpoint GET /v1/harness/runs/{runId}
|
|
25
24
|
* @endpoint GET /v1/lookup-jobs/{jobId}
|
|
26
25
|
* @endpoint GET /v1/news/{newsId}/related-entities
|
|
27
26
|
* @endpoint GET /v1/people/{personId}
|
|
28
27
|
* @endpoint GET /v1/people/{personId}/graph
|
|
29
28
|
* @endpoint GET /v1/people/{personId}/investments
|
|
29
|
+
* @endpoint GET /v1/research-runs/{runId}
|
|
30
30
|
* @endpoint GET /v1/search/link/jobs/{jobId}
|
|
31
31
|
* @endpoint GET /v1/search/shared/{id}
|
|
32
32
|
* @endpoint GET /v1/search/shared/slug/{slug}
|
package/dist/entity/entity.js
CHANGED
|
@@ -5,7 +5,7 @@ import { EntityNameAliasEntityAliasTypeSchema } from "./name-alias-entity-alias-
|
|
|
5
5
|
import { EntitySitemapSchema } from "./sitemap.js";
|
|
6
6
|
import { EntityTypeSchema } from "./type.js";
|
|
7
7
|
/**
|
|
8
|
-
* Flat entity core record — identity, naming, status, image, and source metadata. An entity is our umbrella record for organizations such as companies, funds, investment firms and investors, accelerators, nonprofits, and government agencies, plus products and services connected to those organizations.
|
|
8
|
+
* Flat entity core record — identity, naming, status, image, and source metadata. An entity is our umbrella record for organizations such as companies, funds, investment firms and investors, accelerators, nonprofits, and government agencies, plus products and services connected to those organizations. Nested as .core inside EntityList for default list reads and EntityDetail for detail reads.
|
|
9
9
|
*
|
|
10
10
|
* @openapiSchema Entity
|
|
11
11
|
* @endpoint GET /v1/entities
|
|
@@ -26,12 +26,12 @@ import { EntityTypeSchema } from "./type.js";
|
|
|
26
26
|
* @endpoint GET /v1/entities/{entityId}/similar
|
|
27
27
|
* @endpoint GET /v1/entities/{entityId}/similar/summary
|
|
28
28
|
* @endpoint GET /v1/entities/relationships/{relationshipId}
|
|
29
|
-
* @endpoint GET /v1/harness/runs/{runId}
|
|
30
29
|
* @endpoint GET /v1/lookup-jobs/{jobId}
|
|
31
30
|
* @endpoint GET /v1/news/{newsId}/related-entities
|
|
32
31
|
* @endpoint GET /v1/people/{personId}
|
|
33
32
|
* @endpoint GET /v1/people/{personId}/graph
|
|
34
33
|
* @endpoint GET /v1/people/{personId}/investments
|
|
34
|
+
* @endpoint GET /v1/research-runs/{runId}
|
|
35
35
|
* @endpoint GET /v1/search/link/jobs/{jobId}
|
|
36
36
|
* @endpoint GET /v1/search/shared/{id}
|
|
37
37
|
* @endpoint GET /v1/search/shared/slug/{slug}
|
package/dist/entity/image.d.ts
CHANGED
|
@@ -31,7 +31,6 @@ export interface EntityImageSchemaInput extends z.input<typeof EntityImageSchema
|
|
|
31
31
|
* @endpoint GET /v1/entities/{entityId}/similar
|
|
32
32
|
* @endpoint GET /v1/entities/{entityId}/similar/summary
|
|
33
33
|
* @endpoint GET /v1/entities/relationships/{relationshipId}
|
|
34
|
-
* @endpoint GET /v1/harness/runs/{runId}
|
|
35
34
|
* @endpoint GET /v1/lookup-jobs/{jobId}
|
|
36
35
|
* @endpoint GET /v1/news/{newsId}/related-entities
|
|
37
36
|
* @endpoint GET /v1/people/{personId}
|
|
@@ -40,6 +39,7 @@ export interface EntityImageSchemaInput extends z.input<typeof EntityImageSchema
|
|
|
40
39
|
* @endpoint GET /v1/people/{personId}/graph
|
|
41
40
|
* @endpoint GET /v1/people/{personId}/investments
|
|
42
41
|
* @endpoint GET /v1/people/{personId}/similar
|
|
42
|
+
* @endpoint GET /v1/research-runs/{runId}
|
|
43
43
|
* @endpoint GET /v1/search/link/jobs/{jobId}
|
|
44
44
|
* @endpoint GET /v1/search/shared/{id}
|
|
45
45
|
* @endpoint GET /v1/search/shared/slug/{slug}
|
package/dist/entity/image.js
CHANGED
|
@@ -30,7 +30,6 @@ const EntityImageSchemaDefinition = z.object({
|
|
|
30
30
|
* @endpoint GET /v1/entities/{entityId}/similar
|
|
31
31
|
* @endpoint GET /v1/entities/{entityId}/similar/summary
|
|
32
32
|
* @endpoint GET /v1/entities/relationships/{relationshipId}
|
|
33
|
-
* @endpoint GET /v1/harness/runs/{runId}
|
|
34
33
|
* @endpoint GET /v1/lookup-jobs/{jobId}
|
|
35
34
|
* @endpoint GET /v1/news/{newsId}/related-entities
|
|
36
35
|
* @endpoint GET /v1/people/{personId}
|
|
@@ -39,6 +38,7 @@ const EntityImageSchemaDefinition = z.object({
|
|
|
39
38
|
* @endpoint GET /v1/people/{personId}/graph
|
|
40
39
|
* @endpoint GET /v1/people/{personId}/investments
|
|
41
40
|
* @endpoint GET /v1/people/{personId}/similar
|
|
41
|
+
* @endpoint GET /v1/research-runs/{runId}
|
|
42
42
|
* @endpoint GET /v1/search/link/jobs/{jobId}
|
|
43
43
|
* @endpoint GET /v1/search/shared/{id}
|
|
44
44
|
* @endpoint GET /v1/search/shared/slug/{slug}
|
|
@@ -16,7 +16,6 @@ export declare const EntityInvestmentsParamSchema: z.ZodObject<{
|
|
|
16
16
|
cursor: z.ZodOptional<z.ZodString>;
|
|
17
17
|
dateFrom: z.ZodOptional<z.ZodISODate>;
|
|
18
18
|
dateTo: z.ZodOptional<z.ZodISODate>;
|
|
19
|
-
includePrivate: z.ZodOptional<z.ZodBoolean>;
|
|
20
19
|
latestPerEntity: z.ZodOptional<z.ZodBoolean>;
|
|
21
20
|
maxAmount: z.ZodOptional<z.ZodNumber>;
|
|
22
21
|
minAmount: z.ZodOptional<z.ZodNumber>;
|
|
@@ -18,8 +18,6 @@ export const EntityInvestmentsParamSchema = PageParamSchema.extend({
|
|
|
18
18
|
dateFrom: z.iso.date().optional(),
|
|
19
19
|
/** Inclusive maximum announced date */
|
|
20
20
|
dateTo: z.iso.date().optional(),
|
|
21
|
-
/** Includes private fundraise data when the caller has private-visibility authority. Omit to use the caller's default visibility. */
|
|
22
|
-
includePrivate: z.boolean().optional(),
|
|
23
21
|
/** Return latest transaction per entity */
|
|
24
22
|
latestPerEntity: z.boolean().optional(),
|
|
25
23
|
/** Inclusive maximum amount raised. Use a plain whole-number amount such as 50000000; do not include currency signs, codes, comma grouping, decimals, or strings. */
|
|
@@ -13,8 +13,8 @@ export declare const EntityInvestorsParamSchema: z.ZodObject<{
|
|
|
13
13
|
page: z.ZodOptional<z.ZodInt>;
|
|
14
14
|
size: z.ZodOptional<z.ZodInt>;
|
|
15
15
|
sort: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
|
|
16
|
+
compact: z.ZodOptional<z.ZodBoolean>;
|
|
16
17
|
cursor: z.ZodOptional<z.ZodString>;
|
|
17
|
-
includePrivate: z.ZodOptional<z.ZodBoolean>;
|
|
18
18
|
permitMonogram: z.ZodOptional<z.ZodBoolean>;
|
|
19
19
|
}, z.core.$strip>;
|
|
20
20
|
export type EntityInvestorsParam = z.infer<typeof EntityInvestorsParamSchema>;
|
|
@@ -12,10 +12,10 @@ export const ENTITY_INVESTORS_ENDPOINT = "/v1/entities/{entityId}/investors";
|
|
|
12
12
|
* @contractRole canonical
|
|
13
13
|
*/
|
|
14
14
|
export const EntityInvestorsParamSchema = PageParamSchema.extend({
|
|
15
|
+
/** Set true to return each investor's own profile with its people, news, funding rounds, relationships, and research as empty lists, not absent fields; the profile's sitemap flags still show which of them exist. Responses are much smaller. */
|
|
16
|
+
compact: z.boolean().optional(),
|
|
15
17
|
/** Opaque URL-safe cursor token from X-Next-Cursor. Reuse the same filters and sort. */
|
|
16
18
|
cursor: z.string().optional(),
|
|
17
|
-
/** Includes private fundraise data when the caller has private-visibility authority. Omit to use the caller's default visibility. */
|
|
18
|
-
includePrivate: z.boolean().optional(),
|
|
19
19
|
/** Permit generated monogram fallback */
|
|
20
20
|
permitMonogram: z.boolean().optional(),
|
|
21
21
|
});
|
|
@@ -10,7 +10,6 @@ export declare const ENTITY_LOOKUP_BATCH_ENDPOINT: "/v1/entities/lookup-batch";
|
|
|
10
10
|
* @contractRole canonical
|
|
11
11
|
*/
|
|
12
12
|
export declare const EntityLookupBatchParamSchema: z.ZodObject<{
|
|
13
|
-
includePrivate: z.ZodOptional<z.ZodBoolean>;
|
|
14
13
|
page: z.ZodOptional<z.ZodInt>;
|
|
15
14
|
size: z.ZodOptional<z.ZodInt>;
|
|
16
15
|
}, z.core.$strip>;
|
|
@@ -11,8 +11,6 @@ export const ENTITY_LOOKUP_BATCH_ENDPOINT = "/v1/entities/lookup-batch";
|
|
|
11
11
|
* @contractRole canonical
|
|
12
12
|
*/
|
|
13
13
|
export const EntityLookupBatchParamSchema = z.object({
|
|
14
|
-
/** Includes hidden, unverified, and not-yet-published entities when the caller has private-visibility authority. Omit to use the caller's default visibility. */
|
|
15
|
-
includePrivate: z.boolean().optional(),
|
|
16
14
|
/** Zero-based page index (0..N); omit page and size for the full batch. */
|
|
17
15
|
page: z.int().optional(),
|
|
18
16
|
/** The size of the page to be returned; omit page and size for the full batch. */
|
|
@@ -11,7 +11,6 @@ export declare const ENTITY_LOOKUP_EXACT_ENDPOINT: "/v1/entities/lookup-exact";
|
|
|
11
11
|
*/
|
|
12
12
|
export declare const EntityLookupExactParamSchema: z.ZodObject<{
|
|
13
13
|
companySlug: z.ZodOptional<z.ZodString>;
|
|
14
|
-
includePrivate: z.ZodOptional<z.ZodBoolean>;
|
|
15
14
|
location: z.ZodOptional<z.ZodString>;
|
|
16
15
|
name: z.ZodOptional<z.ZodString>;
|
|
17
16
|
nameBrand: z.ZodOptional<z.ZodString>;
|
|
@@ -17,8 +17,6 @@ export const EntityLookupExactParamSchema = z.object({
|
|
|
17
17
|
.regex(/^[a-z0-9_-]+$/)
|
|
18
18
|
.max(255)
|
|
19
19
|
.optional(),
|
|
20
|
-
/** Includes hidden or off-sitemap entities and hidden research snippets when the caller has private-visibility authority. */
|
|
21
|
-
includePrivate: z.boolean().optional(),
|
|
22
20
|
/** Location candidate: city, state, or country. */
|
|
23
21
|
location: z.string().optional(),
|
|
24
22
|
/** Primary entity name candidate. */
|