@aventurevc/api-schemas 0.8.255 → 0.8.257
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/entity/fundraise-transaction.js +1 -1
- package/dist/entity/research-public-source.d.ts +1 -1
- package/dist/entity/research-public-source.js +1 -1
- package/dist/fundraise/investment-attribution.d.ts +1 -1
- package/dist/fundraise/investment-attribution.js +3 -3
- package/dist/identification/identification.d.ts +6 -0
- package/dist/identification/identification.js +5 -0
- package/dist/identification/subject.d.ts +1 -0
- package/dist/identification/subject.js +2 -0
- package/dist/job/enqueue.d.ts +10 -10
- package/dist/job/enqueue.js +11 -7
- package/dist/lookup/job-mention.d.ts +6 -0
- package/dist/lookup/job-mutation.d.ts +1 -0
- package/dist/lookup/job-mutation.js +1 -1
- package/dist/lookup/job.d.ts +20 -0
- package/dist/lookup/job.js +1 -1
- package/dist/mention/lookup.d.ts +17 -0
- package/dist/mention/lookup.js +3 -0
- package/dist/unique/id-type.d.ts +15 -1
- package/dist/unique/id-type.js +8 -1
- package/dist/unique/id.d.ts +14 -0
- package/package.json +1 -1
|
@@ -29,7 +29,7 @@ const EntityFundraiseTransactionSchemaDefinition = z.object({
|
|
|
29
29
|
/** Canonical fundraise transaction UUID */
|
|
30
30
|
id: z.uuid(),
|
|
31
31
|
investor: z.array(EntityFundraiseInvestorJoinSchema).nullish(),
|
|
32
|
-
/** Investor-specific attribution when returned from investor-perspective investment views. amountInvested is not added to amountRaised; it is the selected investor's
|
|
32
|
+
/** Investor-specific attribution when returned from investor-perspective investment views. amountInvested is not added to amountRaised; it is the selected investor's whole investment in this round: its joins here (one per vehicle, such as a CEA and a SAFE) summed. joinId names one of those joins. */
|
|
33
33
|
investorAttribution: FundraiseInvestmentAttributionSchema.nullish(),
|
|
34
34
|
/** Source-reported number of investors in the round. This can exceed the identified investor joins when a source reports a total without naming every investor. */
|
|
35
35
|
investorCount: z.int().nullish(),
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { z } from "zod/v4";
|
|
2
2
|
/**
|
|
3
|
-
* Published page behind a research value, read from the provenance event that wrote the value. Absent for internal sources
|
|
3
|
+
* Published page behind a research value, read from the provenance event that wrote the value. Absent for internal sources, privacy, terms, or other legal pages, and, in public views, suppressed secondary sources such as data aggregators.
|
|
4
4
|
*
|
|
5
5
|
* @openapiSchema EntityResearchPublicSource
|
|
6
6
|
* @endpoint GET /v1/entities
|
|
@@ -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
|
-
* Published page behind a research value, read from the provenance event that wrote the value. Absent for internal sources
|
|
4
|
+
* Published page behind a research value, read from the provenance event that wrote the value. Absent for internal sources, privacy, terms, or other legal pages, and, in public views, suppressed secondary sources such as data aggregators.
|
|
5
5
|
*
|
|
6
6
|
* @openapiSchema EntityResearchPublicSource
|
|
7
7
|
* @endpoint GET /v1/entities
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { z } from "zod/v4";
|
|
2
2
|
/**
|
|
3
|
-
* Investor-specific attribution
|
|
3
|
+
* Investor-specific attribution: an investor's investment in one round (its joins there, one per vehicle, summed) or, in source attribution, one investor join
|
|
4
4
|
*
|
|
5
5
|
* @openapiSchema FundraiseInvestmentAttribution
|
|
6
6
|
* @endpoint GET /v1/entities
|
|
@@ -3,7 +3,7 @@ import { z } from "zod/v4";
|
|
|
3
3
|
import { FundraiseInvestmentAttributionTypeSchema } from "./investment-attribution-type.js";
|
|
4
4
|
import { RoundLabelSchema } from "../round/label.js";
|
|
5
5
|
/**
|
|
6
|
-
* Investor-specific attribution
|
|
6
|
+
* Investor-specific attribution: an investor's investment in one round (its joins there, one per vehicle, summed) or, in source attribution, one investor join
|
|
7
7
|
*
|
|
8
8
|
* @openapiSchema FundraiseInvestmentAttribution
|
|
9
9
|
* @endpoint GET /v1/entities
|
|
@@ -41,7 +41,7 @@ import { RoundLabelSchema } from "../round/label.js";
|
|
|
41
41
|
* @contractRole canonical
|
|
42
42
|
*/
|
|
43
43
|
export const FundraiseInvestmentAttributionSchema = z.object({
|
|
44
|
-
/** Investor-level attributed amount invested in the fundraise transaction currency. Serialized as a plain JSON number such as 220000 or 123456.78; no currency sign, currency code, comma grouping, or abbreviated amount text is valid. */
|
|
44
|
+
/** Investor-level attributed amount invested in the fundraise transaction currency: the investor's joins on the round summed for an investment, or one join's amount in source attribution. Serialized as a plain JSON number such as 220000 or 123456.78; no currency sign, currency code, comma grouping, or abbreviated amount text is valid. */
|
|
45
45
|
amountInvested: z.number().nullish(),
|
|
46
46
|
/** How this attribution row participates in the investor view. */
|
|
47
47
|
attributionType: FundraiseInvestmentAttributionTypeSchema,
|
|
@@ -49,7 +49,7 @@ export const FundraiseInvestmentAttributionSchema = z.object({
|
|
|
49
49
|
beneficialEntityId: z.uuid().nullish(),
|
|
50
50
|
/** Fund-manager relationship id when the attribution rolls up through a managed fund. */
|
|
51
51
|
fundManagerRelationshipId: z.int().nullish(),
|
|
52
|
-
/** Fundraise investor join identifier */
|
|
52
|
+
/** Fundraise investor join identifier; for a summed investment, one of the joins it sums */
|
|
53
53
|
joinId: z.uuid(),
|
|
54
54
|
/** Whether this investor is the lead investor for the round — the lead/anchor investor that set the round terms or made the primary commitment. */
|
|
55
55
|
leadInvestor: z.boolean(),
|
|
@@ -149,6 +149,12 @@ export declare const IdentificationSchema: z.ZodObject<{
|
|
|
149
149
|
website: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
150
150
|
}, z.core.$strip>>;
|
|
151
151
|
enrichmentRunId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
|
|
152
|
+
filing: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
|
153
|
+
jobId: z.ZodUUID;
|
|
154
|
+
mode: z.ZodString;
|
|
155
|
+
statusUrl: z.ZodString;
|
|
156
|
+
}, z.core.$strip>>>;
|
|
157
|
+
inserted: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
|
|
152
158
|
languageModelSettled: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
|
|
153
159
|
match: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
|
154
160
|
createdAt: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
|
|
@@ -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 { JobEnqueueSchema } from "../job/enqueue.js";
|
|
4
5
|
import { UrlHostFormResolutionSchema } from "../url/host-form-resolution.js";
|
|
5
6
|
/**
|
|
6
7
|
* Which existing entity or person satisfies the requested identity, type, and provider scope, how that was settled, and the candidates considered, most probable first.
|
|
@@ -28,6 +29,10 @@ export const IdentificationSchema = z.object({
|
|
|
28
29
|
duplicate: z.array(IdentificationCandidateSchema),
|
|
29
30
|
/** 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. */
|
|
30
31
|
enrichmentRunId: z.uuid().nullish(),
|
|
32
|
+
/** 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. */
|
|
33
|
+
filing: JobEnqueueSchema.nullish(),
|
|
34
|
+
/** Present only for callers that sent Prefer: respond-async. For a completed filing job, whether that request inserted created. */
|
|
35
|
+
inserted: z.boolean().nullish(),
|
|
31
36
|
/** true when the match was settled on a second, slower review; confirm it before relying on it. Absent otherwise. */
|
|
32
37
|
languageModelSettled: z.boolean().nullish(),
|
|
33
38
|
/** The matched record when status is MATCHED. */
|
|
@@ -15,6 +15,7 @@ import { z } from "zod/v4";
|
|
|
15
15
|
*/
|
|
16
16
|
export declare const IdentificationSubjectSchema: z.ZodObject<{
|
|
17
17
|
context: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
18
|
+
email: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
18
19
|
employer: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
19
20
|
kind: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
|
|
20
21
|
ENTITY: "ENTITY";
|
|
@@ -19,6 +19,8 @@ import { UniqueIdMutationSchema } from "../unique/id-mutation.js";
|
|
|
19
19
|
export const IdentificationSubjectSchema = z.object({
|
|
20
20
|
/** Specific facts in plain words: product, industry, employer and title, or founder names. Generic words like startup add nothing. */
|
|
21
21
|
context: z.string().max(2000).nullish(),
|
|
22
|
+
/** Exact email address the record holds as a contact detail. Requires private visibility; when exactly one record of the requested kind holds it, that record matches before names or URLs. */
|
|
23
|
+
email: z.string().nullish(),
|
|
22
24
|
/** Companies the subject is known to work at; a person filing accepts a LinkedIn profile only when one of them appears in the profile's employer fields. */
|
|
23
25
|
employer: z.array(z.string()).max(10).optional(),
|
|
24
26
|
/** Kind of record to identify when you know it: ENTITY for companies, funds, and firms (and their products or services); PERSON for people. Only that kind is looked up; typeRecord or providerId implies ENTITY. */
|
package/dist/job/enqueue.d.ts
CHANGED
|
@@ -1,12 +1,4 @@
|
|
|
1
1
|
import { z } from "zod/v4";
|
|
2
|
-
declare const JobEnqueueSchemaDefinition: z.ZodObject<{
|
|
3
|
-
jobId: z.ZodUUID;
|
|
4
|
-
mode: z.ZodString;
|
|
5
|
-
statusUrl: z.ZodString;
|
|
6
|
-
}, z.core.$strip>;
|
|
7
|
-
type JobEnqueueDefinition = z.infer<typeof JobEnqueueSchemaDefinition>;
|
|
8
|
-
export interface JobEnqueueSchemaInput extends z.input<typeof JobEnqueueSchemaDefinition> {
|
|
9
|
-
}
|
|
10
2
|
/**
|
|
11
3
|
* Accepted asynchronous app job enqueue response.
|
|
12
4
|
*
|
|
@@ -14,16 +6,24 @@ export interface JobEnqueueSchemaInput extends z.input<typeof JobEnqueueSchemaDe
|
|
|
14
6
|
* @endpoint GET /v1/lookup
|
|
15
7
|
* @endpoint GET /v1/search/link
|
|
16
8
|
* @endpoint GET /v1/entities/search/jobs/{jobId}
|
|
9
|
+
* @endpoint GET /v1/lookup-jobs/{jobId}
|
|
17
10
|
* @endpoint GET /v1/search/link/jobs/{jobId}
|
|
18
11
|
* @endpoint GET /v1/web/searches/jobs/{jobId}
|
|
19
12
|
* @endpoint POST /v1/entities/lookup
|
|
20
13
|
* @endpoint POST /v1/entities/search
|
|
21
14
|
* @endpoint POST /v1/lookup
|
|
22
15
|
* @endpoint POST /v1/lookup-jobs
|
|
16
|
+
* @endpoint POST /v1/lookup-mentions
|
|
17
|
+
* @endpoint POST /v1/people/lookup
|
|
18
|
+
* @usedBySchema IdentificationSchema
|
|
19
|
+
* @usedBySchema MentionLookupSchema
|
|
23
20
|
* @contractShape job.enqueue
|
|
24
21
|
* @contractRole canonical
|
|
25
22
|
*/
|
|
26
|
-
export declare const JobEnqueueSchema: z.
|
|
23
|
+
export declare const JobEnqueueSchema: z.ZodObject<{
|
|
24
|
+
jobId: z.ZodUUID;
|
|
25
|
+
mode: z.ZodString;
|
|
26
|
+
statusUrl: z.ZodString;
|
|
27
|
+
}, z.core.$strip>;
|
|
27
28
|
export type JobEnqueue = z.infer<typeof JobEnqueueSchema>;
|
|
28
|
-
export {};
|
|
29
29
|
//# sourceMappingURL=enqueue.d.ts.map
|
package/dist/job/enqueue.js
CHANGED
|
@@ -1,11 +1,5 @@
|
|
|
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 JobEnqueueSchemaDefinition = z.object({
|
|
4
|
-
jobId: z.uuid(),
|
|
5
|
-
mode: z.string(),
|
|
6
|
-
/** Endpoint to poll for asynchronous job state and result. */
|
|
7
|
-
statusUrl: z.string(),
|
|
8
|
-
});
|
|
9
3
|
/**
|
|
10
4
|
* Accepted asynchronous app job enqueue response.
|
|
11
5
|
*
|
|
@@ -13,14 +7,24 @@ const JobEnqueueSchemaDefinition = z.object({
|
|
|
13
7
|
* @endpoint GET /v1/lookup
|
|
14
8
|
* @endpoint GET /v1/search/link
|
|
15
9
|
* @endpoint GET /v1/entities/search/jobs/{jobId}
|
|
10
|
+
* @endpoint GET /v1/lookup-jobs/{jobId}
|
|
16
11
|
* @endpoint GET /v1/search/link/jobs/{jobId}
|
|
17
12
|
* @endpoint GET /v1/web/searches/jobs/{jobId}
|
|
18
13
|
* @endpoint POST /v1/entities/lookup
|
|
19
14
|
* @endpoint POST /v1/entities/search
|
|
20
15
|
* @endpoint POST /v1/lookup
|
|
21
16
|
* @endpoint POST /v1/lookup-jobs
|
|
17
|
+
* @endpoint POST /v1/lookup-mentions
|
|
18
|
+
* @endpoint POST /v1/people/lookup
|
|
19
|
+
* @usedBySchema IdentificationSchema
|
|
20
|
+
* @usedBySchema MentionLookupSchema
|
|
22
21
|
* @contractShape job.enqueue
|
|
23
22
|
* @contractRole canonical
|
|
24
23
|
*/
|
|
25
|
-
export const JobEnqueueSchema =
|
|
24
|
+
export const JobEnqueueSchema = z.object({
|
|
25
|
+
jobId: z.uuid(),
|
|
26
|
+
mode: z.string(),
|
|
27
|
+
/** Endpoint to poll for asynchronous job state and result. */
|
|
28
|
+
statusUrl: z.string(),
|
|
29
|
+
});
|
|
26
30
|
//# sourceMappingURL=enqueue.js.map
|
|
@@ -1228,6 +1228,12 @@ declare const LookupJobMentionSchemaDefinition: z.ZodObject<{
|
|
|
1228
1228
|
website: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1229
1229
|
}, z.core.$strip>>;
|
|
1230
1230
|
enrichmentRunId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
|
|
1231
|
+
filing: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
|
1232
|
+
jobId: z.ZodUUID;
|
|
1233
|
+
mode: z.ZodString;
|
|
1234
|
+
statusUrl: z.ZodString;
|
|
1235
|
+
}, z.core.$strip>>>;
|
|
1236
|
+
inserted: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
|
|
1231
1237
|
languageModelSettled: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
|
|
1232
1238
|
match: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
|
1233
1239
|
createdAt: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
|
|
@@ -17,6 +17,7 @@ declare const LookupJobMutationSchemaDefinition: z.ZodObject<{
|
|
|
17
17
|
sourceUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
18
18
|
subject: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
|
19
19
|
context: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
20
|
+
email: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
20
21
|
employer: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
21
22
|
kind: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
|
|
22
23
|
ENTITY: "ENTITY";
|
|
@@ -13,7 +13,7 @@ const LookupJobMutationSchemaDefinition = z.object({
|
|
|
13
13
|
sourceNewsId: z.int().nullish(),
|
|
14
14
|
/** URL of the article; read from aVenture news when stored there, otherwise fetched. */
|
|
15
15
|
sourceUrl: z.string().max(2000).nullish(),
|
|
16
|
-
/** Read-only: the subject of a GET or POST /v1/lookup or POST /v1/entities/lookup request sent with Prefer: respond-async,
|
|
16
|
+
/** Read-only: the subject of a GET or POST /v1/lookup or POST /v1/entities/lookup request sent with Prefer: respond-async, rolled over from a signed-in live lookup, or handed off for pending filing. This job preserves the route's options. Requests to create a job or read mentions must omit it. */
|
|
17
17
|
subject: IdentificationSubjectSchema.nullish(),
|
|
18
18
|
});
|
|
19
19
|
/**
|
package/dist/lookup/job.d.ts
CHANGED
|
@@ -137,6 +137,12 @@ declare const LookupJobSchemaDefinition: z.ZodObject<{
|
|
|
137
137
|
website: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
138
138
|
}, z.core.$strip>>;
|
|
139
139
|
enrichmentRunId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
|
|
140
|
+
filing: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
|
141
|
+
jobId: z.ZodUUID;
|
|
142
|
+
mode: z.ZodString;
|
|
143
|
+
statusUrl: z.ZodString;
|
|
144
|
+
}, z.core.$strip>>>;
|
|
145
|
+
inserted: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
|
|
140
146
|
languageModelSettled: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
|
|
141
147
|
match: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
|
142
148
|
createdAt: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
|
|
@@ -841,6 +847,12 @@ declare const LookupJobSchemaDefinition: z.ZodObject<{
|
|
|
841
847
|
website?: string | null | undefined;
|
|
842
848
|
}[];
|
|
843
849
|
enrichmentRunId?: string | null | undefined;
|
|
850
|
+
filing?: {
|
|
851
|
+
jobId: string;
|
|
852
|
+
mode: string;
|
|
853
|
+
statusUrl: string;
|
|
854
|
+
} | null | undefined;
|
|
855
|
+
inserted?: boolean | null | undefined;
|
|
844
856
|
languageModelSettled?: boolean | null | undefined;
|
|
845
857
|
match?: {
|
|
846
858
|
createdAt?: string | null | undefined;
|
|
@@ -1558,6 +1570,12 @@ declare const LookupJobSchemaDefinition: z.ZodObject<{
|
|
|
1558
1570
|
website?: string | null | undefined;
|
|
1559
1571
|
}[];
|
|
1560
1572
|
enrichmentRunId?: string | null | undefined;
|
|
1573
|
+
filing?: {
|
|
1574
|
+
jobId: string;
|
|
1575
|
+
mode: string;
|
|
1576
|
+
statusUrl: string;
|
|
1577
|
+
} | null | undefined;
|
|
1578
|
+
inserted?: boolean | null | undefined;
|
|
1561
1579
|
languageModelSettled?: boolean | null | undefined;
|
|
1562
1580
|
match?: {
|
|
1563
1581
|
createdAt?: string | null | undefined;
|
|
@@ -1661,6 +1679,7 @@ declare const LookupJobSchemaDefinition: z.ZodObject<{
|
|
|
1661
1679
|
sourceUrl?: string | null | undefined;
|
|
1662
1680
|
subject?: {
|
|
1663
1681
|
context?: string | null | undefined;
|
|
1682
|
+
email?: string | null | undefined;
|
|
1664
1683
|
employer?: string[] | undefined;
|
|
1665
1684
|
kind?: "ENTITY" | "PERSON" | null | undefined;
|
|
1666
1685
|
location?: string | null | undefined;
|
|
@@ -1689,6 +1708,7 @@ declare const LookupJobSchemaDefinition: z.ZodObject<{
|
|
|
1689
1708
|
sourceUrl?: string | null | undefined;
|
|
1690
1709
|
subject?: {
|
|
1691
1710
|
context?: string | null | undefined;
|
|
1711
|
+
email?: string | null | undefined;
|
|
1692
1712
|
employer?: string[] | undefined;
|
|
1693
1713
|
kind?: "ENTITY" | "PERSON" | null | undefined;
|
|
1694
1714
|
location?: string | null | undefined;
|
package/dist/lookup/job.js
CHANGED
|
@@ -9,7 +9,7 @@ const LookupJobSchemaDefinition = z.object({
|
|
|
9
9
|
createdAt: z.iso.datetime({ offset: true }),
|
|
10
10
|
/** Why the job failed; absent unless state is FAILED. */
|
|
11
11
|
failureReason: z.string().nullish(),
|
|
12
|
-
/** Subject jobs only: once COMPLETED, the identification GET /v1/lookup or POST /v1/entities/lookup returns for source.subject; absent otherwise. */
|
|
12
|
+
/** Subject jobs only: once COMPLETED, the identification GET or POST /v1/lookup or POST /v1/entities/lookup returns for source.subject, including requested filing and source-claim outcomes; absent otherwise. */
|
|
13
13
|
identification: IdentificationSchema.nullish(),
|
|
14
14
|
/** Lookup job id. */
|
|
15
15
|
jobId: z.uuid(),
|
package/dist/mention/lookup.d.ts
CHANGED
|
@@ -1,5 +1,10 @@
|
|
|
1
1
|
import { z } from "zod/v4";
|
|
2
2
|
declare const MentionLookupSchemaDefinition: z.ZodObject<{
|
|
3
|
+
filing: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
|
4
|
+
jobId: z.ZodUUID;
|
|
5
|
+
mode: z.ZodString;
|
|
6
|
+
statusUrl: z.ZodString;
|
|
7
|
+
}, z.core.$strip>>>;
|
|
3
8
|
mention: z.ZodArray<z.ZodType<{
|
|
4
9
|
enrichmentRunId?: string | null | undefined;
|
|
5
10
|
entity: {
|
|
@@ -630,6 +635,12 @@ declare const MentionLookupSchemaDefinition: z.ZodObject<{
|
|
|
630
635
|
website?: string | null | undefined;
|
|
631
636
|
}[];
|
|
632
637
|
enrichmentRunId?: string | null | undefined;
|
|
638
|
+
filing?: {
|
|
639
|
+
jobId: string;
|
|
640
|
+
mode: string;
|
|
641
|
+
statusUrl: string;
|
|
642
|
+
} | null | undefined;
|
|
643
|
+
inserted?: boolean | null | undefined;
|
|
633
644
|
languageModelSettled?: boolean | null | undefined;
|
|
634
645
|
match?: {
|
|
635
646
|
createdAt?: string | null | undefined;
|
|
@@ -1347,6 +1358,12 @@ declare const MentionLookupSchemaDefinition: z.ZodObject<{
|
|
|
1347
1358
|
website?: string | null | undefined;
|
|
1348
1359
|
}[];
|
|
1349
1360
|
enrichmentRunId?: string | null | undefined;
|
|
1361
|
+
filing?: {
|
|
1362
|
+
jobId: string;
|
|
1363
|
+
mode: string;
|
|
1364
|
+
statusUrl: string;
|
|
1365
|
+
} | null | undefined;
|
|
1366
|
+
inserted?: boolean | null | undefined;
|
|
1350
1367
|
languageModelSettled?: boolean | null | undefined;
|
|
1351
1368
|
match?: {
|
|
1352
1369
|
createdAt?: string | null | undefined;
|
package/dist/mention/lookup.js
CHANGED
|
@@ -1,7 +1,10 @@
|
|
|
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 { JobEnqueueSchema } from "../job/enqueue.js";
|
|
3
4
|
import { LookupJobMentionSchema } from "../lookup/job-mention.js";
|
|
4
5
|
const MentionLookupSchemaDefinition = z.object({
|
|
6
|
+
/** Present only for callers that sent Prefer: respond-async. Identifications are settled but shell filing is pending. Poll statusUrl until the lookup job completes; merge its filing outcomes by mentionType and name. */
|
|
7
|
+
filing: JobEnqueueSchema.nullish(),
|
|
5
8
|
/** Each distinct name: the page's own company first, then the order the source shows them, with news outlets and the page's bylined authors last. */
|
|
6
9
|
mention: z.array(LookupJobMentionSchema),
|
|
7
10
|
/** True when the page names more than this answer holds: more names than one live lookup reads, or a body longer than the read limit. A lookup job with maxNames reads every name. */
|
package/dist/unique/id-type.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { z } from "zod/v4";
|
|
2
2
|
/**
|
|
3
|
-
* External identifier type that maps an owner to a registry id
|
|
3
|
+
* External identifier type that maps an owner to a well-known registry id.
|
|
4
4
|
*
|
|
5
5
|
* @openapiSchema UniqueIdType
|
|
6
6
|
* @endpoint GET /v1/entities/lookup-exact
|
|
@@ -30,14 +30,21 @@ export declare const UniqueIdTypeSchema: z.ZodUnion<readonly [z.ZodEnum<{
|
|
|
30
30
|
duns: "duns";
|
|
31
31
|
ein: "ein";
|
|
32
32
|
fdicCert: "fdicCert";
|
|
33
|
+
firmCrd: "firmCrd";
|
|
33
34
|
folk: "folk";
|
|
34
35
|
holdingCompanyRssd: "holdingCompanyRssd";
|
|
36
|
+
ipedsUnitId: "ipedsUnitId";
|
|
35
37
|
isin: "isin";
|
|
36
38
|
lei: "lei";
|
|
39
|
+
ncesLeaId: "ncesLeaId";
|
|
40
|
+
ncesPssId: "ncesPssId";
|
|
41
|
+
ncesSchoolId: "ncesSchoolId";
|
|
37
42
|
ncuaCharter: "ncuaCharter";
|
|
43
|
+
npi: "npi";
|
|
38
44
|
orcid: "orcid";
|
|
39
45
|
rssd: "rssd";
|
|
40
46
|
secCik: "secCik";
|
|
47
|
+
secPrivateFundId: "secPrivateFundId";
|
|
41
48
|
signalNfxCompany: "signalNfxCompany";
|
|
42
49
|
signalNfxFirm: "signalNfxFirm";
|
|
43
50
|
signalNfxPerson: "signalNfxPerson";
|
|
@@ -49,14 +56,21 @@ export declare const UniqueIdTypeSchema: z.ZodUnion<readonly [z.ZodEnum<{
|
|
|
49
56
|
duns: "duns";
|
|
50
57
|
ein: "ein";
|
|
51
58
|
fdicCert: "fdicCert";
|
|
59
|
+
firmCrd: "firmCrd";
|
|
52
60
|
folk: "folk";
|
|
53
61
|
holdingCompanyRssd: "holdingCompanyRssd";
|
|
62
|
+
ipedsUnitId: "ipedsUnitId";
|
|
54
63
|
isin: "isin";
|
|
55
64
|
lei: "lei";
|
|
65
|
+
ncesLeaId: "ncesLeaId";
|
|
66
|
+
ncesPssId: "ncesPssId";
|
|
67
|
+
ncesSchoolId: "ncesSchoolId";
|
|
56
68
|
ncuaCharter: "ncuaCharter";
|
|
69
|
+
npi: "npi";
|
|
57
70
|
orcid: "orcid";
|
|
58
71
|
rssd: "rssd";
|
|
59
72
|
secCik: "secCik";
|
|
73
|
+
secPrivateFundId: "secPrivateFundId";
|
|
60
74
|
signalNfxCompany: "signalNfxCompany";
|
|
61
75
|
signalNfxFirm: "signalNfxFirm";
|
|
62
76
|
signalNfxPerson: "signalNfxPerson";
|
package/dist/unique/id-type.js
CHANGED
|
@@ -9,6 +9,13 @@ const UniqueIdTypeSchemaKnownMembers = z.enum([
|
|
|
9
9
|
"isin",
|
|
10
10
|
"cusip",
|
|
11
11
|
"crd",
|
|
12
|
+
"firmCrd",
|
|
13
|
+
"secPrivateFundId",
|
|
14
|
+
"npi",
|
|
15
|
+
"ipedsUnitId",
|
|
16
|
+
"ncesSchoolId",
|
|
17
|
+
"ncesLeaId",
|
|
18
|
+
"ncesPssId",
|
|
12
19
|
"orcid",
|
|
13
20
|
"fdicCert",
|
|
14
21
|
"ncuaCharter",
|
|
@@ -20,7 +27,7 @@ const UniqueIdTypeSchemaKnownMembers = z.enum([
|
|
|
20
27
|
"folk",
|
|
21
28
|
]);
|
|
22
29
|
/**
|
|
23
|
-
* External identifier type that maps an owner to a registry id
|
|
30
|
+
* External identifier type that maps an owner to a well-known registry id.
|
|
24
31
|
*
|
|
25
32
|
* @openapiSchema UniqueIdType
|
|
26
33
|
* @endpoint GET /v1/entities/lookup-exact
|
package/dist/unique/id.d.ts
CHANGED
|
@@ -9,14 +9,21 @@ declare const UniqueIdSchemaDefinition: z.ZodObject<{
|
|
|
9
9
|
duns: "duns";
|
|
10
10
|
ein: "ein";
|
|
11
11
|
fdicCert: "fdicCert";
|
|
12
|
+
firmCrd: "firmCrd";
|
|
12
13
|
folk: "folk";
|
|
13
14
|
holdingCompanyRssd: "holdingCompanyRssd";
|
|
15
|
+
ipedsUnitId: "ipedsUnitId";
|
|
14
16
|
isin: "isin";
|
|
15
17
|
lei: "lei";
|
|
18
|
+
ncesLeaId: "ncesLeaId";
|
|
19
|
+
ncesPssId: "ncesPssId";
|
|
20
|
+
ncesSchoolId: "ncesSchoolId";
|
|
16
21
|
ncuaCharter: "ncuaCharter";
|
|
22
|
+
npi: "npi";
|
|
17
23
|
orcid: "orcid";
|
|
18
24
|
rssd: "rssd";
|
|
19
25
|
secCik: "secCik";
|
|
26
|
+
secPrivateFundId: "secPrivateFundId";
|
|
20
27
|
signalNfxCompany: "signalNfxCompany";
|
|
21
28
|
signalNfxFirm: "signalNfxFirm";
|
|
22
29
|
signalNfxPerson: "signalNfxPerson";
|
|
@@ -28,14 +35,21 @@ declare const UniqueIdSchemaDefinition: z.ZodObject<{
|
|
|
28
35
|
duns: "duns";
|
|
29
36
|
ein: "ein";
|
|
30
37
|
fdicCert: "fdicCert";
|
|
38
|
+
firmCrd: "firmCrd";
|
|
31
39
|
folk: "folk";
|
|
32
40
|
holdingCompanyRssd: "holdingCompanyRssd";
|
|
41
|
+
ipedsUnitId: "ipedsUnitId";
|
|
33
42
|
isin: "isin";
|
|
34
43
|
lei: "lei";
|
|
44
|
+
ncesLeaId: "ncesLeaId";
|
|
45
|
+
ncesPssId: "ncesPssId";
|
|
46
|
+
ncesSchoolId: "ncesSchoolId";
|
|
35
47
|
ncuaCharter: "ncuaCharter";
|
|
48
|
+
npi: "npi";
|
|
36
49
|
orcid: "orcid";
|
|
37
50
|
rssd: "rssd";
|
|
38
51
|
secCik: "secCik";
|
|
52
|
+
secPrivateFundId: "secPrivateFundId";
|
|
39
53
|
signalNfxCompany: "signalNfxCompany";
|
|
40
54
|
signalNfxFirm: "signalNfxFirm";
|
|
41
55
|
signalNfxPerson: "signalNfxPerson";
|