@aventurevc/api-schemas 0.8.180 → 0.8.182
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.d.ts +2 -0
- package/dist/blog/post-type.d.ts +16 -0
- package/dist/blog/post-type.js +16 -0
- package/dist/blog/post.d.ts +17 -0
- package/dist/blog/post.js +17 -0
- package/dist/employee/count.d.ts +16 -0
- package/dist/employee/count.js +16 -0
- package/dist/entity/detail.d.ts +954 -0
- package/dist/entity/funding-detail.d.ts +4 -0
- package/dist/entity/funding-detail.js +4 -0
- package/dist/entity/fundraise-investor-activity.d.ts +27 -15
- package/dist/entity/fundraise-investor-activity.js +27 -11
- package/dist/entity/fundraise-transaction-entity.d.ts +4 -0
- package/dist/entity/fundraise-transaction-entity.js +4 -0
- package/dist/entity/investor-participation.d.ts +954 -0
- package/dist/entity/research-fact-value.d.ts +16 -0
- package/dist/entity/research-fact-value.js +16 -0
- package/dist/entity/research-value-type.d.ts +4 -0
- package/dist/entity/research-value-type.js +4 -0
- package/dist/entity/resolution.d.ts +954 -0
- package/dist/entity/url-crawl-cdn-provider.d.ts +5 -0
- package/dist/entity/url-crawl-cdn-provider.js +5 -0
- package/dist/entity/url-crawl-render-mode.d.ts +5 -0
- package/dist/entity/url-crawl-render-mode.js +5 -0
- package/dist/entity/valuation-data-confidence.d.ts +16 -0
- package/dist/entity/valuation-data-confidence.js +16 -0
- package/dist/federated/search.d.ts +2042 -134
- package/dist/funding/stage.d.ts +4 -0
- package/dist/funding/stage.js +4 -0
- package/dist/harness/task-input-type.d.ts +3 -1
- package/dist/harness/task-input-type.js +2 -2
- package/dist/harness/task-plan.d.ts +2 -0
- package/dist/harness/task.d.ts +3 -0
- package/dist/harness/task.js +2 -0
- package/dist/help/resolution.d.ts +2 -0
- package/dist/http/problem-detail.d.ts +4 -0
- package/dist/http/problem-detail.js +2 -0
- package/dist/identification/identification.d.ts +19 -0
- package/dist/identification/identification.js +5 -2
- package/dist/identification/subject.d.ts +5 -0
- package/dist/identification/subject.js +3 -0
- package/dist/link/search.d.ts +2125 -217
- package/dist/lookup/job-mention.d.ts +19 -0
- package/dist/lookup/job-mention.js +1 -1
- package/dist/lookup/job-mutation.d.ts +5 -0
- package/dist/lookup/job.d.ts +49 -0
- package/dist/mention/lookup.d.ts +20 -0
- package/dist/news/news.d.ts +4 -0
- package/dist/news/news.js +4 -0
- package/dist/openapi-component-manifest.js +9 -0
- package/dist/pagination/schemas.d.ts +4255 -439
- package/dist/person/detail-include.d.ts +19 -0
- package/dist/person/detail-include.js +19 -0
- package/dist/person/detail.d.ts +934 -0
- package/dist/person/detail.js +13 -1
- package/dist/person/graph-career-context.d.ts +16 -0
- package/dist/person/graph-career-context.js +16 -0
- package/dist/person/graph-co-investor.d.ts +16 -0
- package/dist/person/graph-co-investor.js +16 -0
- package/dist/person/graph-member.d.ts +16 -0
- package/dist/person/graph-member.js +16 -0
- package/dist/person/graph-similar-entity.d.ts +16 -0
- package/dist/person/graph-similar-entity.js +16 -0
- package/dist/person/graph.d.ts +26 -14
- package/dist/person/graph.js +25 -9
- package/dist/person/investor-participation.d.ts +954 -0
- package/dist/person/lookup-exact-param.d.ts +7 -0
- package/dist/person/lookup-exact-param.js +2 -0
- package/dist/person/similarity-context.d.ts +16 -0
- package/dist/person/similarity-context.js +16 -0
- package/dist/person/similarity-origin.d.ts +16 -0
- package/dist/person/similarity-origin.js +16 -0
- package/dist/person/similarity-result.d.ts +17 -0
- package/dist/person/similarity-result.js +17 -0
- package/dist/problem/type.d.ts +2 -0
- package/dist/problem/type.js +1 -0
- package/dist/shared/search.d.ts +2125 -217
- package/dist/stage/frequency.d.ts +16 -0
- package/dist/stage/frequency.js +16 -0
- package/dist/unique/id-mutation.d.ts +22 -0
- package/dist/unique/id-mutation.js +25 -0
- package/dist/unique/id-type.d.ts +3 -1
- package/dist/unique/id-type.js +2 -1
- package/dist/unique/id.d.ts +2 -0
- package/dist/url/host-form-resolution.d.ts +63 -0
- package/dist/url/host-form-resolution.js +38 -0
- package/package.json +1 -1
package/dist/funding/stage.d.ts
CHANGED
|
@@ -5,17 +5,20 @@ import { z } from "zod/v4";
|
|
|
5
5
|
* @openapiSchema FundingStage
|
|
6
6
|
* @endpoint GET /v1/entities
|
|
7
7
|
* @endpoint GET /v1/entities/lookup-exact
|
|
8
|
+
* @endpoint GET /v1/people/lookup-exact
|
|
8
9
|
* @endpoint GET /v1/search/link
|
|
9
10
|
* @endpoint GET /v1/entities/{entityId}
|
|
10
11
|
* @endpoint GET /v1/entities/{entityId}/fundraise-rounds
|
|
11
12
|
* @endpoint GET /v1/entities/{entityId}/fundraise-rounds/{fundraiseRoundId}
|
|
12
13
|
* @endpoint GET /v1/entities/{entityId}/investments
|
|
13
14
|
* @endpoint GET /v1/entities/{entityId}/investors
|
|
15
|
+
* @endpoint GET /v1/entities/{entityId}/person-investors
|
|
14
16
|
* @endpoint GET /v1/entities/{entityId}/relationships
|
|
15
17
|
* @endpoint GET /v1/entities/{entityId}/similar
|
|
16
18
|
* @endpoint GET /v1/entities/{entityId}/similar/summary
|
|
17
19
|
* @endpoint GET /v1/entities/relationships/{relationshipId}
|
|
18
20
|
* @endpoint GET /v1/lookup-jobs/{jobId}
|
|
21
|
+
* @endpoint GET /v1/people/{personId}
|
|
19
22
|
* @endpoint GET /v1/people/{personId}/graph
|
|
20
23
|
* @endpoint GET /v1/search/link/jobs/{jobId}
|
|
21
24
|
* @endpoint GET /v1/search/shared/{id}
|
|
@@ -24,6 +27,7 @@ import { z } from "zod/v4";
|
|
|
24
27
|
* @endpoint POST /v1/entities/lookup-matches
|
|
25
28
|
* @endpoint POST /v1/entities/search
|
|
26
29
|
* @endpoint POST /v1/lookup-mentions
|
|
30
|
+
* @endpoint POST /v1/people/lookup-batch
|
|
27
31
|
* @endpoint POST /v1/search
|
|
28
32
|
* @endpoint POST /v1/search/natural/entities
|
|
29
33
|
* @endpoint POST /v1/search/natural/people
|
package/dist/funding/stage.js
CHANGED
|
@@ -45,17 +45,20 @@ const FundingStageSchemaKnownMembers = z.enum([
|
|
|
45
45
|
* @openapiSchema FundingStage
|
|
46
46
|
* @endpoint GET /v1/entities
|
|
47
47
|
* @endpoint GET /v1/entities/lookup-exact
|
|
48
|
+
* @endpoint GET /v1/people/lookup-exact
|
|
48
49
|
* @endpoint GET /v1/search/link
|
|
49
50
|
* @endpoint GET /v1/entities/{entityId}
|
|
50
51
|
* @endpoint GET /v1/entities/{entityId}/fundraise-rounds
|
|
51
52
|
* @endpoint GET /v1/entities/{entityId}/fundraise-rounds/{fundraiseRoundId}
|
|
52
53
|
* @endpoint GET /v1/entities/{entityId}/investments
|
|
53
54
|
* @endpoint GET /v1/entities/{entityId}/investors
|
|
55
|
+
* @endpoint GET /v1/entities/{entityId}/person-investors
|
|
54
56
|
* @endpoint GET /v1/entities/{entityId}/relationships
|
|
55
57
|
* @endpoint GET /v1/entities/{entityId}/similar
|
|
56
58
|
* @endpoint GET /v1/entities/{entityId}/similar/summary
|
|
57
59
|
* @endpoint GET /v1/entities/relationships/{relationshipId}
|
|
58
60
|
* @endpoint GET /v1/lookup-jobs/{jobId}
|
|
61
|
+
* @endpoint GET /v1/people/{personId}
|
|
59
62
|
* @endpoint GET /v1/people/{personId}/graph
|
|
60
63
|
* @endpoint GET /v1/search/link/jobs/{jobId}
|
|
61
64
|
* @endpoint GET /v1/search/shared/{id}
|
|
@@ -64,6 +67,7 @@ const FundingStageSchemaKnownMembers = z.enum([
|
|
|
64
67
|
* @endpoint POST /v1/entities/lookup-matches
|
|
65
68
|
* @endpoint POST /v1/entities/search
|
|
66
69
|
* @endpoint POST /v1/lookup-mentions
|
|
70
|
+
* @endpoint POST /v1/people/lookup-batch
|
|
67
71
|
* @endpoint POST /v1/search
|
|
68
72
|
* @endpoint POST /v1/search/natural/entities
|
|
69
73
|
* @endpoint POST /v1/search/natural/people
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { z } from "zod/v4";
|
|
2
2
|
/**
|
|
3
|
-
* ENTITY binds a target entity to its canonical id through entity identification; TEXT is a literal value the request states.
|
|
3
|
+
* ENTITY binds a target entity to its canonical id through entity identification; TEXT is a literal value the request states; WRITER_BRIEF is the typed research analysis a prose writer composes from (claim ledger, positioning frame, paragraph plan).
|
|
4
4
|
*
|
|
5
5
|
* @openapiSchema HarnessTaskInputType
|
|
6
6
|
* @endpoint POST /v1/agents/help
|
|
@@ -12,10 +12,12 @@ import { z } from "zod/v4";
|
|
|
12
12
|
export declare const HarnessTaskInputTypeSchema: z.ZodUnion<readonly [z.ZodEnum<{
|
|
13
13
|
ENTITY: "ENTITY";
|
|
14
14
|
TEXT: "TEXT";
|
|
15
|
+
WRITER_BRIEF: "WRITER_BRIEF";
|
|
15
16
|
}>, z.ZodString]> & {
|
|
16
17
|
enum: {
|
|
17
18
|
ENTITY: "ENTITY";
|
|
18
19
|
TEXT: "TEXT";
|
|
20
|
+
WRITER_BRIEF: "WRITER_BRIEF";
|
|
19
21
|
};
|
|
20
22
|
};
|
|
21
23
|
export type HarnessTaskInputType = z.infer<typeof HarnessTaskInputTypeSchema>;
|
|
@@ -1,8 +1,8 @@
|
|
|
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
|
-
const HarnessTaskInputTypeSchemaKnownMembers = z.enum(["ENTITY", "TEXT"]);
|
|
3
|
+
const HarnessTaskInputTypeSchemaKnownMembers = z.enum(["ENTITY", "TEXT", "WRITER_BRIEF"]);
|
|
4
4
|
/**
|
|
5
|
-
* ENTITY binds a target entity to its canonical id through entity identification; TEXT is a literal value the request states.
|
|
5
|
+
* ENTITY binds a target entity to its canonical id through entity identification; TEXT is a literal value the request states; WRITER_BRIEF is the typed research analysis a prose writer composes from (claim ledger, positioning frame, paragraph plan).
|
|
6
6
|
*
|
|
7
7
|
* @openapiSchema HarnessTaskInputType
|
|
8
8
|
* @endpoint POST /v1/agents/help
|
|
@@ -13,10 +13,12 @@ export declare const HarnessTaskPlanSchema: z.ZodObject<{
|
|
|
13
13
|
catalogRevision: z.ZodOptional<z.ZodInt>;
|
|
14
14
|
gateId: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
15
15
|
input: z.ZodArray<z.ZodType<{
|
|
16
|
+
allowedValue?: string | null | undefined;
|
|
16
17
|
description: string;
|
|
17
18
|
key: string;
|
|
18
19
|
type: string;
|
|
19
20
|
}, import("./task.ts").HarnessTaskSchemaInput, z.core.$ZodTypeInternals<{
|
|
21
|
+
allowedValue?: string | null | undefined;
|
|
20
22
|
description: string;
|
|
21
23
|
key: string;
|
|
22
24
|
type: string;
|
package/dist/harness/task.d.ts
CHANGED
|
@@ -1,14 +1,17 @@
|
|
|
1
1
|
import { z } from "zod/v4";
|
|
2
2
|
declare const HarnessTaskSchemaDefinition: z.ZodObject<{
|
|
3
|
+
allowedValue: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
3
4
|
description: z.ZodString;
|
|
4
5
|
key: z.ZodString;
|
|
5
6
|
type: z.ZodUnion<readonly [z.ZodEnum<{
|
|
6
7
|
ENTITY: "ENTITY";
|
|
7
8
|
TEXT: "TEXT";
|
|
9
|
+
WRITER_BRIEF: "WRITER_BRIEF";
|
|
8
10
|
}>, z.ZodString]> & {
|
|
9
11
|
enum: {
|
|
10
12
|
ENTITY: "ENTITY";
|
|
11
13
|
TEXT: "TEXT";
|
|
14
|
+
WRITER_BRIEF: "WRITER_BRIEF";
|
|
12
15
|
};
|
|
13
16
|
};
|
|
14
17
|
}, z.core.$strip>;
|
package/dist/harness/task.js
CHANGED
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
import { z } from "zod/v4";
|
|
3
3
|
import { HarnessTaskInputTypeSchema } from "./task-input-type.js";
|
|
4
4
|
const HarnessTaskSchemaDefinition = z.object({
|
|
5
|
+
/** Optional exact literal accepted for a TEXT input; when present, the run and its mutation guard require this value instead of accepting an arbitrary string. */
|
|
6
|
+
allowedValue: z.string().nullish(),
|
|
5
7
|
/** What the value is, written for the caller that supplies it. */
|
|
6
8
|
description: z.string(),
|
|
7
9
|
/** Input key, unique within its task. */
|
|
@@ -34,10 +34,12 @@ export declare const HelpResolutionSchema: z.ZodObject<{
|
|
|
34
34
|
catalogRevision: z.ZodOptional<z.ZodInt>;
|
|
35
35
|
gateId: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
36
36
|
input: z.ZodArray<z.ZodType<{
|
|
37
|
+
allowedValue?: string | null | undefined;
|
|
37
38
|
description: string;
|
|
38
39
|
key: string;
|
|
39
40
|
type: string;
|
|
40
41
|
}, import("../harness/task.ts").HarnessTaskSchemaInput, z.core.$ZodTypeInternals<{
|
|
42
|
+
allowedValue?: string | null | undefined;
|
|
41
43
|
description: string;
|
|
42
44
|
key: string;
|
|
43
45
|
type: string;
|
|
@@ -214,6 +214,10 @@ declare const ProblemDetailSchemaDefinition: z.ZodObject<{
|
|
|
214
214
|
conflictingArticleTitle: string;
|
|
215
215
|
conflictType: string;
|
|
216
216
|
}, import("../news/source-url-conflict.ts").NewsSourceUrlConflictSchemaInput>>]>>>;
|
|
217
|
+
disposition: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
|
|
218
|
+
TERMINAL: "TERMINAL";
|
|
219
|
+
TRANSIENT: "TRANSIENT";
|
|
220
|
+
}>>>;
|
|
217
221
|
error: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>>;
|
|
218
222
|
existingRecordId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
219
223
|
existingRedirect: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
|
@@ -164,6 +164,8 @@ const ProblemDetailSchemaDefinition = z.object({
|
|
|
164
164
|
detail: z.string().optional(),
|
|
165
165
|
/** Structured conflict details. A possible duplicate or an ambiguous lookup returns its candidate records; score and threshold rank the candidates and do not prove that the requested record is absent. */
|
|
166
166
|
details: DomainConflictDetailsSchema.nullish(),
|
|
167
|
+
/** Whether a service-unavailable failure can be retried. */
|
|
168
|
+
disposition: z.enum(["TRANSIENT", "TERMINAL"]).nullish(),
|
|
167
169
|
error: z.record(z.string(), z.string()).nullish(),
|
|
168
170
|
/** On a duplicate 409, the id of the stored record the request collided with; read or update that record instead of creating it again. Absent when the conflict names no single stored record. */
|
|
169
171
|
existingRecordId: z.string().nullish(),
|
|
@@ -200,6 +200,25 @@ export declare const IdentificationSchema: z.ZodObject<{
|
|
|
200
200
|
NEEDS_REVIEW: "NEEDS_REVIEW";
|
|
201
201
|
NO_MATCH: "NO_MATCH";
|
|
202
202
|
}>;
|
|
203
|
+
urlHostForm: z.ZodArray<z.ZodType<{
|
|
204
|
+
concluded: boolean;
|
|
205
|
+
crawlCdnProvider?: "akamai" | "awsCloudfront" | "azureCdn" | "bunny" | "cdn77" | "cdnetworks" | "cloudflare" | "digitalocean" | "fastly" | "gcore" | "googlecloudCdn" | "incapsula" | "keycdn" | "leaseweb" | "netlify" | "none" | "stackpath" | "sucuri" | "unknown" | "vercel" | null | undefined;
|
|
206
|
+
crawlRenderMode?: "jsEnhanced" | "jsRequired" | "static" | null | undefined;
|
|
207
|
+
landingHost?: string | null | undefined;
|
|
208
|
+
outcome?: "noResponse" | "refusal" | "rejection" | "success" | "transient" | null | undefined;
|
|
209
|
+
status?: string | null | undefined;
|
|
210
|
+
submittedUrl: string;
|
|
211
|
+
url: string;
|
|
212
|
+
}, import("../url/host-form-resolution.ts").UrlHostFormResolutionSchemaInput, z.core.$ZodTypeInternals<{
|
|
213
|
+
concluded: boolean;
|
|
214
|
+
crawlCdnProvider?: "akamai" | "awsCloudfront" | "azureCdn" | "bunny" | "cdn77" | "cdnetworks" | "cloudflare" | "digitalocean" | "fastly" | "gcore" | "googlecloudCdn" | "incapsula" | "keycdn" | "leaseweb" | "netlify" | "none" | "stackpath" | "sucuri" | "unknown" | "vercel" | null | undefined;
|
|
215
|
+
crawlRenderMode?: "jsEnhanced" | "jsRequired" | "static" | null | undefined;
|
|
216
|
+
landingHost?: string | null | undefined;
|
|
217
|
+
outcome?: "noResponse" | "refusal" | "rejection" | "success" | "transient" | null | undefined;
|
|
218
|
+
status?: string | null | undefined;
|
|
219
|
+
submittedUrl: string;
|
|
220
|
+
url: string;
|
|
221
|
+
}, import("../url/host-form-resolution.ts").UrlHostFormResolutionSchemaInput>>>;
|
|
203
222
|
}, z.core.$strip>;
|
|
204
223
|
export type Identification = z.infer<typeof IdentificationSchema>;
|
|
205
224
|
//# sourceMappingURL=identification.d.ts.map
|
|
@@ -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 { IdentificationCandidateSchema } from "./candidate.js";
|
|
4
|
+
import { UrlHostFormResolutionSchema } from "../url/host-form-resolution.js";
|
|
4
5
|
/**
|
|
5
6
|
* Which existing entity or person satisfies the requested identity, type, and provider scope, how that was settled, and the candidates considered, most probable first.
|
|
6
7
|
*
|
|
@@ -19,13 +20,13 @@ import { IdentificationCandidateSchema } from "./candidate.js";
|
|
|
19
20
|
export const IdentificationSchema = z.object({
|
|
20
21
|
/** Records considered, most probable first. */
|
|
21
22
|
candidate: z.array(IdentificationCandidateSchema),
|
|
22
|
-
/**
|
|
23
|
+
/** The new unpublished record a NO_MATCH subject with a proven own site was added as, or the existing one that already held its website. Absent otherwise. */
|
|
23
24
|
created: IdentificationCandidateSchema.nullish(),
|
|
24
25
|
/** One sentence naming what settled the answer or what the user must decide. */
|
|
25
26
|
detail: z.string(),
|
|
26
27
|
/** Other records that appear to describe the same subject as match. Empty when none were found. */
|
|
27
28
|
duplicate: z.array(IdentificationCandidateSchema),
|
|
28
|
-
/** Research request filed for the created record; absent without created, and when the record is already public. */
|
|
29
|
+
/** Research request filed for the created record; absent without created, when the lookup did not request research on it, and when the record is already public. */
|
|
29
30
|
enrichmentRunId: z.uuid().nullish(),
|
|
30
31
|
/** true when the match was settled on a second, slower review; confirm it before relying on it. Absent otherwise. */
|
|
31
32
|
languageModelSettled: z.boolean().nullish(),
|
|
@@ -35,5 +36,7 @@ export const IdentificationSchema = z.object({
|
|
|
35
36
|
officialUrl: z.string().nullish(),
|
|
36
37
|
/** Use the scoped match, record scoped absence, or refine an ambiguous identity with evidence. */
|
|
37
38
|
status: z.enum(["MATCHED", "NO_MATCH", "NEEDS_REVIEW"]),
|
|
39
|
+
/** Fresh backend URL evidence gathered when verifyUrl=true; empty otherwise. */
|
|
40
|
+
urlHostForm: z.array(UrlHostFormResolutionSchema),
|
|
38
41
|
});
|
|
39
42
|
//# sourceMappingURL=identification.js.map
|
|
@@ -22,6 +22,11 @@ export declare const IdentificationSubjectSchema: z.ZodObject<{
|
|
|
22
22
|
location: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
23
23
|
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
24
24
|
providerId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
|
|
25
|
+
sourceIdentifier: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
|
26
|
+
identifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
27
|
+
idType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
28
|
+
source: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
29
|
+
}, z.core.$strip>>>;
|
|
25
30
|
sourceNewsId: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
|
|
26
31
|
sourceUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
27
32
|
typeRecord: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
|
|
@@ -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 { EntityTypeSchema } from "../entity/type.js";
|
|
4
|
+
import { UniqueIdMutationSchema } from "../unique/id-mutation.js";
|
|
4
5
|
/**
|
|
5
6
|
* The company, Product, Service, or person to identify. Send the name, a URL it owns, or both, plus every location and source you have; a website or profile URL usually settles the answer without any model call.
|
|
6
7
|
*
|
|
@@ -26,6 +27,8 @@ export const IdentificationSubjectSchema = z.object({
|
|
|
26
27
|
name: z.string().max(200).nullish(),
|
|
27
28
|
/** Provider entity id for a Product or Service lookup. Omit it when the provider is unknown. With no typeRecord, searches both Product and Service. Invalid for a company type or a person lookup. */
|
|
28
29
|
providerId: z.uuid().nullish(),
|
|
30
|
+
/** Internal permanent Folk source identity. Requires private visibility and resolves before names or URLs. */
|
|
31
|
+
sourceIdentifier: UniqueIdMutationSchema.nullish(),
|
|
29
32
|
/** aVenture news id of the article that mentions the subject; an unknown id is a 400. */
|
|
30
33
|
sourceNewsId: z.int().nullish(),
|
|
31
34
|
/** URL of the article that mentions the subject; read from aVenture news when stored there, otherwise fetched. */
|