@aventurevc/api-schemas 0.8.223 → 0.8.225
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/detail-batch.d.ts +1 -1
- package/dist/entity/detail-batch.js +1 -1
- package/dist/entity/detail.d.ts +30 -0
- package/dist/entity/detail.js +1 -1
- package/dist/entity/filter.js +1 -1
- package/dist/entity/fundraise-investor-join.d.ts +25 -0
- package/dist/entity/fundraise-investor-join.js +32 -1
- package/dist/entity/fundraise-transaction.d.ts +29 -0
- package/dist/entity/fundraise-transaction.js +2 -0
- package/dist/entity/investor-participation.d.ts +30 -0
- package/dist/entity/list-filter.d.ts +1 -1
- package/dist/entity/list-filter.js +2 -2
- package/dist/entity/list.d.ts +30 -0
- package/dist/entity/resolution.d.ts +30 -0
- package/dist/entity/similarity-result.d.ts +30 -0
- package/dist/federated/search.d.ts +181 -0
- package/dist/federated/search.js +2 -0
- package/dist/fundraise/investment-evidence.d.ts +30 -0
- package/dist/harness/run-detail.d.ts +1 -0
- package/dist/harness/run-detail.js +2 -0
- package/dist/link/search.d.ts +182 -0
- package/dist/lookup/job-mention.d.ts +30 -0
- package/dist/lookup/job.d.ts +30 -0
- package/dist/mention/lookup.d.ts +30 -0
- package/dist/natural/search-result.d.ts +120 -0
- package/dist/pagination/schemas.d.ts +184 -0
- package/dist/person/lookup-exact-param.js +2 -2
- package/dist/person/natural-search-result.d.ts +30 -0
- package/dist/search/hit.d.ts +1 -0
- package/dist/search/hit.js +2 -0
- package/dist/search/investment.d.ts +30 -0
- package/dist/search/person-profile.js +1 -1
- package/dist/shared/search.d.ts +182 -0
- package/dist/web/search.d.ts +2 -0
- package/package.json +1 -1
|
@@ -9,7 +9,7 @@ type EntityDetailBatchDefinition = z.infer<typeof EntityDetailBatchSchemaDefinit
|
|
|
9
9
|
export interface EntityDetailBatchSchemaInput extends z.input<typeof EntityDetailBatchSchemaDefinition> {
|
|
10
10
|
}
|
|
11
11
|
/**
|
|
12
|
-
* Batch request for entity detail retrieval by id, slug, or current joined URL. Each identifier array accepts at most 200 values, and at most 200 identifiers may be submitted across entityId, slug, and url.
|
|
12
|
+
* Batch request for entity detail retrieval by id, slug, or current joined URL. Each identifier array accepts at most 200 values, and at most 200 identifiers may be submitted across entityId, slug, and url. It takes no names: identify a company by name with lookupRecord and its name field.
|
|
13
13
|
*
|
|
14
14
|
* @openapiSchema EntityDetailBatch
|
|
15
15
|
* @endpoint POST /v1/entities/lookup-batch
|
|
@@ -24,7 +24,7 @@ const EntityDetailBatchSchemaDefinition = z
|
|
|
24
24
|
}
|
|
25
25
|
});
|
|
26
26
|
/**
|
|
27
|
-
* Batch request for entity detail retrieval by id, slug, or current joined URL. Each identifier array accepts at most 200 values, and at most 200 identifiers may be submitted across entityId, slug, and url.
|
|
27
|
+
* Batch request for entity detail retrieval by id, slug, or current joined URL. Each identifier array accepts at most 200 values, and at most 200 identifiers may be submitted across entityId, slug, and url. It takes no names: identify a company by name with lookupRecord and its name field.
|
|
28
28
|
*
|
|
29
29
|
* @openapiSchema EntityDetailBatch
|
|
30
30
|
* @endpoint POST /v1/entities/lookup-batch
|
package/dist/entity/detail.d.ts
CHANGED
|
@@ -626,6 +626,21 @@ export declare const EntityDetailSchema: z.ZodObject<{
|
|
|
626
626
|
} | null | undefined;
|
|
627
627
|
financialInstrumentType?: "Bond" | "Common Stock" | "Convertible Note" | "Grant" | "Loan" | "Other Debt" | "Other Equity" | "Preferred Stock" | "SAFE" | "Token" | null | undefined;
|
|
628
628
|
id: string;
|
|
629
|
+
investor?: {
|
|
630
|
+
amountInvested?: number | null | undefined;
|
|
631
|
+
createdAt: string;
|
|
632
|
+
financialInstrumentType?: "Bond" | "Common Stock" | "Convertible Note" | "Grant" | "Loan" | "Other Debt" | "Other Equity" | "Preferred Stock" | "SAFE" | "Token" | null | undefined;
|
|
633
|
+
id: string;
|
|
634
|
+
investor: {
|
|
635
|
+
entityId?: string | null | undefined;
|
|
636
|
+
personId?: string | null | undefined;
|
|
637
|
+
};
|
|
638
|
+
investorName?: string | null | undefined;
|
|
639
|
+
investorSlug?: string | null | undefined;
|
|
640
|
+
leadInvestor: boolean;
|
|
641
|
+
transactionId: string;
|
|
642
|
+
updatedAt: string;
|
|
643
|
+
}[] | null | undefined;
|
|
629
644
|
investorAttribution?: {
|
|
630
645
|
amountInvested?: number | null | undefined;
|
|
631
646
|
attributionType: "direct" | "managedFund";
|
|
@@ -720,6 +735,21 @@ export declare const EntityDetailSchema: z.ZodObject<{
|
|
|
720
735
|
} | null | undefined;
|
|
721
736
|
financialInstrumentType?: "Bond" | "Common Stock" | "Convertible Note" | "Grant" | "Loan" | "Other Debt" | "Other Equity" | "Preferred Stock" | "SAFE" | "Token" | null | undefined;
|
|
722
737
|
id: string;
|
|
738
|
+
investor?: {
|
|
739
|
+
amountInvested?: number | null | undefined;
|
|
740
|
+
createdAt: string;
|
|
741
|
+
financialInstrumentType?: "Bond" | "Common Stock" | "Convertible Note" | "Grant" | "Loan" | "Other Debt" | "Other Equity" | "Preferred Stock" | "SAFE" | "Token" | null | undefined;
|
|
742
|
+
id: string;
|
|
743
|
+
investor: {
|
|
744
|
+
entityId?: string | null | undefined;
|
|
745
|
+
personId?: string | null | undefined;
|
|
746
|
+
};
|
|
747
|
+
investorName?: string | null | undefined;
|
|
748
|
+
investorSlug?: string | null | undefined;
|
|
749
|
+
leadInvestor: boolean;
|
|
750
|
+
transactionId: string;
|
|
751
|
+
updatedAt: string;
|
|
752
|
+
}[] | null | undefined;
|
|
723
753
|
investorAttribution?: {
|
|
724
754
|
amountInvested?: number | null | undefined;
|
|
725
755
|
attributionType: "direct" | "managedFund";
|
package/dist/entity/detail.js
CHANGED
|
@@ -40,7 +40,7 @@ export const EntityDetailSchema = z.object({
|
|
|
40
40
|
enrichment: EntityEnrichmentSchema,
|
|
41
41
|
/** Fundraise rounds associated with this entity. When newsArticle or an external source reports a newer round not yet listed here, report both and ask the user whether to request a record update via POST /v1/entities/{entityId}/enrichments (CLI: entities enrichments enrich; MCP: aventure_job enrichEntity). */
|
|
42
42
|
fundraiseRound: z.array(EntityFundraiseTransactionSchema),
|
|
43
|
-
/** News articles associated with this entity; full-detail search carries the first few, and GET /v1/news?owner.entityId={entityId} lists them all. When an indexed article reports a newer funding round, role, or milestone not yet reflected in structured fields, report both and offer to request an update on the record. */
|
|
43
|
+
/** News articles associated with this entity; full-detail search carries the first few, and GET /v1/news?owner.entityId={entityId} lists them all. Articles whose headline names the entity (brand or alias) and were published within a recent window lead, then newest first; explicit sorts and text search on the list are unchanged. When an indexed article reports a newer funding round, role, or milestone not yet reflected in structured fields, report both and offer to request an update on the record. */
|
|
44
44
|
newsArticle: z.array(NewsSchema),
|
|
45
45
|
/** People associated with this entity; full-detail search carries the first few, and GET /v1/entities/{entityId}/people lists them all. */
|
|
46
46
|
person: z.array(PersonDetailSchema),
|
package/dist/entity/filter.js
CHANGED
|
@@ -106,7 +106,7 @@ export const EntityFilterSchema = z.strictObject({
|
|
|
106
106
|
suppressZeroTotalRaised: z.boolean().nullish(),
|
|
107
107
|
/** General classification tag values. */
|
|
108
108
|
tag: z.array(z.string()).optional(),
|
|
109
|
-
/** Non-blank
|
|
109
|
+
/** Non-blank company-identity search term: it matches only brand names, legal names, slugs, and name aliases (including near spellings of them), never descriptions, products, or topics. A topic, sector, or market word such as "climate" or "corporate card" returns no rows or name lookalikes here: filter by the industry, tag, mainProduct, or other classification fields, send the phrase as semanticQuery on POST /v1/entities/search, or ask natural search for plain-English or multi-constraint company requests. */
|
|
110
110
|
textSearch: z.string().nullish(),
|
|
111
111
|
/** Customer-type classification values. */
|
|
112
112
|
typeCustomer: z.array(z.string()).optional(),
|
|
@@ -19,6 +19,8 @@ declare const EntityFundraiseInvestorJoinSchemaDefinition: z.ZodObject<{
|
|
|
19
19
|
entityId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
|
|
20
20
|
personId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
|
|
21
21
|
}, z.core.$strip>;
|
|
22
|
+
investorName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
23
|
+
investorSlug: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
22
24
|
leadInvestor: z.ZodBoolean;
|
|
23
25
|
transactionId: z.ZodUUID;
|
|
24
26
|
updatedAt: z.ZodISODateTime;
|
|
@@ -30,8 +32,31 @@ export interface EntityFundraiseInvestorJoinSchemaInput extends z.input<typeof E
|
|
|
30
32
|
* Canonical fundraise investor join row for API serialization
|
|
31
33
|
*
|
|
32
34
|
* @openapiSchema EntityFundraiseInvestorJoin
|
|
35
|
+
* @endpoint GET /v1/entities
|
|
36
|
+
* @endpoint GET /v1/entities/lookup-exact
|
|
37
|
+
* @endpoint GET /v1/search/link
|
|
38
|
+
* @endpoint GET /v1/entities/{entityId}
|
|
33
39
|
* @endpoint GET /v1/entities/{entityId}/fundraise-investor-joins
|
|
34
40
|
* @endpoint GET /v1/entities/{entityId}/fundraise-investor-joins/{joinId}
|
|
41
|
+
* @endpoint GET /v1/entities/{entityId}/fundraise-rounds
|
|
42
|
+
* @endpoint GET /v1/entities/{entityId}/fundraise-rounds/{fundraiseRoundId}
|
|
43
|
+
* @endpoint GET /v1/entities/{entityId}/investments
|
|
44
|
+
* @endpoint GET /v1/entities/{entityId}/investors
|
|
45
|
+
* @endpoint GET /v1/entities/{entityId}/similar
|
|
46
|
+
* @endpoint GET /v1/entities/search/jobs/{jobId}
|
|
47
|
+
* @endpoint GET /v1/lookup-jobs/{jobId}
|
|
48
|
+
* @endpoint GET /v1/search/link/jobs/{jobId}
|
|
49
|
+
* @endpoint GET /v1/search/shared/{id}
|
|
50
|
+
* @endpoint GET /v1/search/shared/slug/{slug}
|
|
51
|
+
* @endpoint POST /v1/entities/lookup-batch
|
|
52
|
+
* @endpoint POST /v1/entities/lookup-matches
|
|
53
|
+
* @endpoint POST /v1/entities/search
|
|
54
|
+
* @endpoint POST /v1/lookup-mentions
|
|
55
|
+
* @endpoint POST /v1/search
|
|
56
|
+
* @endpoint POST /v1/search/natural/entities
|
|
57
|
+
* @endpoint POST /v1/search/natural/people
|
|
58
|
+
* @endpoint POST /v1/search/shared
|
|
59
|
+
* @usedBySchema EntityFundraiseTransactionSchema
|
|
35
60
|
* @usedBySchema PageEntityFundraiseInvestorJoinSchema
|
|
36
61
|
* @contractShape entity.fundraise-investor-join
|
|
37
62
|
* @contractRole canonical
|
|
@@ -11,8 +11,16 @@ const EntityFundraiseInvestorJoinSchemaDefinition = z.object({
|
|
|
11
11
|
financialInstrumentType: FundraiseFinancialInstrumentTypeSchema.nullish(),
|
|
12
12
|
/** Fundraise investor join identifier */
|
|
13
13
|
id: z.uuid(),
|
|
14
|
-
/** Investor identity, nested: investor.entityId for a firm/fund investor or investor.personId for an angel — exactly one is set.
|
|
14
|
+
/** Investor identity, nested: investor.entityId for a firm/fund investor or investor.personId for an angel — exactly one is set. investorName and investorSlug on this row name that investor; never read each id separately. */
|
|
15
15
|
investor: EntityPersonOwnerSchema,
|
|
16
|
+
/** Investor display name, read from the investor's own entity record (brand name, else legal name) or person record (full name). Omitted when that record holds no name. */
|
|
17
|
+
investorName: z.string().nullish(),
|
|
18
|
+
/** Investor profile slug, read from the investor's own entity or person record; open the profile with it instead of resolving investor ids one by one. */
|
|
19
|
+
investorSlug: z
|
|
20
|
+
.string()
|
|
21
|
+
.regex(/^[a-z0-9_-]+$/)
|
|
22
|
+
.max(255)
|
|
23
|
+
.nullish(),
|
|
16
24
|
/** Whether this investor is the lead investor for the round — the lead/anchor investor that set the round terms or made the primary commitment. */
|
|
17
25
|
leadInvestor: z.boolean(),
|
|
18
26
|
/** Fundraise transaction identifier */
|
|
@@ -24,8 +32,31 @@ const EntityFundraiseInvestorJoinSchemaDefinition = z.object({
|
|
|
24
32
|
* Canonical fundraise investor join row for API serialization
|
|
25
33
|
*
|
|
26
34
|
* @openapiSchema EntityFundraiseInvestorJoin
|
|
35
|
+
* @endpoint GET /v1/entities
|
|
36
|
+
* @endpoint GET /v1/entities/lookup-exact
|
|
37
|
+
* @endpoint GET /v1/search/link
|
|
38
|
+
* @endpoint GET /v1/entities/{entityId}
|
|
27
39
|
* @endpoint GET /v1/entities/{entityId}/fundraise-investor-joins
|
|
28
40
|
* @endpoint GET /v1/entities/{entityId}/fundraise-investor-joins/{joinId}
|
|
41
|
+
* @endpoint GET /v1/entities/{entityId}/fundraise-rounds
|
|
42
|
+
* @endpoint GET /v1/entities/{entityId}/fundraise-rounds/{fundraiseRoundId}
|
|
43
|
+
* @endpoint GET /v1/entities/{entityId}/investments
|
|
44
|
+
* @endpoint GET /v1/entities/{entityId}/investors
|
|
45
|
+
* @endpoint GET /v1/entities/{entityId}/similar
|
|
46
|
+
* @endpoint GET /v1/entities/search/jobs/{jobId}
|
|
47
|
+
* @endpoint GET /v1/lookup-jobs/{jobId}
|
|
48
|
+
* @endpoint GET /v1/search/link/jobs/{jobId}
|
|
49
|
+
* @endpoint GET /v1/search/shared/{id}
|
|
50
|
+
* @endpoint GET /v1/search/shared/slug/{slug}
|
|
51
|
+
* @endpoint POST /v1/entities/lookup-batch
|
|
52
|
+
* @endpoint POST /v1/entities/lookup-matches
|
|
53
|
+
* @endpoint POST /v1/entities/search
|
|
54
|
+
* @endpoint POST /v1/lookup-mentions
|
|
55
|
+
* @endpoint POST /v1/search
|
|
56
|
+
* @endpoint POST /v1/search/natural/entities
|
|
57
|
+
* @endpoint POST /v1/search/natural/people
|
|
58
|
+
* @endpoint POST /v1/search/shared
|
|
59
|
+
* @usedBySchema EntityFundraiseTransactionSchema
|
|
29
60
|
* @usedBySchema PageEntityFundraiseInvestorJoinSchema
|
|
30
61
|
* @contractShape entity.fundraise-investor-join
|
|
31
62
|
* @contractRole canonical
|
|
@@ -167,6 +167,35 @@ declare const EntityFundraiseTransactionSchemaDefinition: z.ZodObject<{
|
|
|
167
167
|
Token: "Token";
|
|
168
168
|
}>>>;
|
|
169
169
|
id: z.ZodUUID;
|
|
170
|
+
investor: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodType<{
|
|
171
|
+
amountInvested?: number | null | undefined;
|
|
172
|
+
createdAt: string;
|
|
173
|
+
financialInstrumentType?: "Bond" | "Common Stock" | "Convertible Note" | "Grant" | "Loan" | "Other Debt" | "Other Equity" | "Preferred Stock" | "SAFE" | "Token" | null | undefined;
|
|
174
|
+
id: string;
|
|
175
|
+
investor: {
|
|
176
|
+
entityId?: string | null | undefined;
|
|
177
|
+
personId?: string | null | undefined;
|
|
178
|
+
};
|
|
179
|
+
investorName?: string | null | undefined;
|
|
180
|
+
investorSlug?: string | null | undefined;
|
|
181
|
+
leadInvestor: boolean;
|
|
182
|
+
transactionId: string;
|
|
183
|
+
updatedAt: string;
|
|
184
|
+
}, import("./fundraise-investor-join.ts").EntityFundraiseInvestorJoinSchemaInput, z.core.$ZodTypeInternals<{
|
|
185
|
+
amountInvested?: number | null | undefined;
|
|
186
|
+
createdAt: string;
|
|
187
|
+
financialInstrumentType?: "Bond" | "Common Stock" | "Convertible Note" | "Grant" | "Loan" | "Other Debt" | "Other Equity" | "Preferred Stock" | "SAFE" | "Token" | null | undefined;
|
|
188
|
+
id: string;
|
|
189
|
+
investor: {
|
|
190
|
+
entityId?: string | null | undefined;
|
|
191
|
+
personId?: string | null | undefined;
|
|
192
|
+
};
|
|
193
|
+
investorName?: string | null | undefined;
|
|
194
|
+
investorSlug?: string | null | undefined;
|
|
195
|
+
leadInvestor: boolean;
|
|
196
|
+
transactionId: string;
|
|
197
|
+
updatedAt: string;
|
|
198
|
+
}, import("./fundraise-investor-join.ts").EntityFundraiseInvestorJoinSchemaInput>>>>>;
|
|
170
199
|
investorAttribution: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
|
171
200
|
amountInvested: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
172
201
|
attributionType: z.ZodEnum<{
|
|
@@ -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 { EntityFundraiseInvestorJoinSchema } from "./fundraise-investor-join.js";
|
|
3
4
|
import { EntityFundraiseTransactionEntitySchema } from "./fundraise-transaction-entity.js";
|
|
4
5
|
import { EntityResearchPublicSourceSchema } from "./research-public-source.js";
|
|
5
6
|
import { FundraiseDataConfidenceSchema } from "../fundraise/data-confidence.js";
|
|
@@ -27,6 +28,7 @@ const EntityFundraiseTransactionSchemaDefinition = z.object({
|
|
|
27
28
|
financialInstrumentType: FundraiseFinancialInstrumentTypeSchema.nullish(),
|
|
28
29
|
/** Canonical fundraise transaction UUID */
|
|
29
30
|
id: z.uuid(),
|
|
31
|
+
investor: z.array(EntityFundraiseInvestorJoinSchema).nullish(),
|
|
30
32
|
/** Investor-specific attribution when returned from investor-perspective investment views. amountInvested is not added to amountRaised; it is the selected investor's attributed participation amount for this round. */
|
|
31
33
|
investorAttribution: FundraiseInvestmentAttributionSchema.nullish(),
|
|
32
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. */
|
|
@@ -604,6 +604,21 @@ declare const EntityInvestorParticipationSchemaDefinition: z.ZodObject<{
|
|
|
604
604
|
} | null | undefined;
|
|
605
605
|
financialInstrumentType?: "Bond" | "Common Stock" | "Convertible Note" | "Grant" | "Loan" | "Other Debt" | "Other Equity" | "Preferred Stock" | "SAFE" | "Token" | null | undefined;
|
|
606
606
|
id: string;
|
|
607
|
+
investor?: {
|
|
608
|
+
amountInvested?: number | null | undefined;
|
|
609
|
+
createdAt: string;
|
|
610
|
+
financialInstrumentType?: "Bond" | "Common Stock" | "Convertible Note" | "Grant" | "Loan" | "Other Debt" | "Other Equity" | "Preferred Stock" | "SAFE" | "Token" | null | undefined;
|
|
611
|
+
id: string;
|
|
612
|
+
investor: {
|
|
613
|
+
entityId?: string | null | undefined;
|
|
614
|
+
personId?: string | null | undefined;
|
|
615
|
+
};
|
|
616
|
+
investorName?: string | null | undefined;
|
|
617
|
+
investorSlug?: string | null | undefined;
|
|
618
|
+
leadInvestor: boolean;
|
|
619
|
+
transactionId: string;
|
|
620
|
+
updatedAt: string;
|
|
621
|
+
}[] | null | undefined;
|
|
607
622
|
investorAttribution?: {
|
|
608
623
|
amountInvested?: number | null | undefined;
|
|
609
624
|
attributionType: "direct" | "managedFund";
|
|
@@ -698,6 +713,21 @@ declare const EntityInvestorParticipationSchemaDefinition: z.ZodObject<{
|
|
|
698
713
|
} | null | undefined;
|
|
699
714
|
financialInstrumentType?: "Bond" | "Common Stock" | "Convertible Note" | "Grant" | "Loan" | "Other Debt" | "Other Equity" | "Preferred Stock" | "SAFE" | "Token" | null | undefined;
|
|
700
715
|
id: string;
|
|
716
|
+
investor?: {
|
|
717
|
+
amountInvested?: number | null | undefined;
|
|
718
|
+
createdAt: string;
|
|
719
|
+
financialInstrumentType?: "Bond" | "Common Stock" | "Convertible Note" | "Grant" | "Loan" | "Other Debt" | "Other Equity" | "Preferred Stock" | "SAFE" | "Token" | null | undefined;
|
|
720
|
+
id: string;
|
|
721
|
+
investor: {
|
|
722
|
+
entityId?: string | null | undefined;
|
|
723
|
+
personId?: string | null | undefined;
|
|
724
|
+
};
|
|
725
|
+
investorName?: string | null | undefined;
|
|
726
|
+
investorSlug?: string | null | undefined;
|
|
727
|
+
leadInvestor: boolean;
|
|
728
|
+
transactionId: string;
|
|
729
|
+
updatedAt: string;
|
|
730
|
+
}[] | null | undefined;
|
|
701
731
|
investorAttribution?: {
|
|
702
732
|
amountInvested?: number | null | undefined;
|
|
703
733
|
attributionType: "direct" | "managedFund";
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { z } from "zod/v4";
|
|
2
2
|
/**
|
|
3
|
-
* Entity list filters and saved-view query state including semantic entity search. semanticQuery executes on GET /v1/entities and POST /v1/entities/search; saved views persist it for replay. Every other reused EntityFilter surface accepts the base EntityFilter, which omits semanticQuery. There is no query field: send free text describing the companies as semanticQuery, a
|
|
3
|
+
* Entity list filters and saved-view query state including semantic entity search. semanticQuery executes on GET /v1/entities and POST /v1/entities/search; saved views persist it for replay. Every other reused EntityFilter surface accepts the base EntityFilter, which omits semanticQuery. There is no query field: send free text describing the companies as semanticQuery, a word of a company's name, legal name, slug, or alias as textSearch, or a known company name as entityName.
|
|
4
4
|
*
|
|
5
5
|
* @openapiSchema EntityListFilter
|
|
6
6
|
* @endpoint GET /v1/search/link
|
|
@@ -9,7 +9,7 @@ import { EntityUrlTypeSchema } from "./url-type.js";
|
|
|
9
9
|
import { IntRangeSchema } from "../int/range.js";
|
|
10
10
|
import { UrlMatchModeSchema } from "../url/match-mode.js";
|
|
11
11
|
/**
|
|
12
|
-
* Entity list filters and saved-view query state including semantic entity search. semanticQuery executes on GET /v1/entities and POST /v1/entities/search; saved views persist it for replay. Every other reused EntityFilter surface accepts the base EntityFilter, which omits semanticQuery. There is no query field: send free text describing the companies as semanticQuery, a
|
|
12
|
+
* Entity list filters and saved-view query state including semantic entity search. semanticQuery executes on GET /v1/entities and POST /v1/entities/search; saved views persist it for replay. Every other reused EntityFilter surface accepts the base EntityFilter, which omits semanticQuery. There is no query field: send free text describing the companies as semanticQuery, a word of a company's name, legal name, slug, or alias as textSearch, or a known company name as entityName.
|
|
13
13
|
*
|
|
14
14
|
* @openapiSchema EntityListFilter
|
|
15
15
|
* @endpoint GET /v1/search/link
|
|
@@ -104,7 +104,7 @@ export const EntityListFilterSchema = z.strictObject({
|
|
|
104
104
|
suppressZeroTotalRaised: z.boolean().nullish(),
|
|
105
105
|
/** General classification tag values. */
|
|
106
106
|
tag: z.array(z.string()).optional(),
|
|
107
|
-
/** Non-blank
|
|
107
|
+
/** Non-blank company-identity search term: it matches only brand names, legal names, slugs, and name aliases (including near spellings of them), never descriptions, products, or topics. A topic, sector, or market word such as "climate" or "corporate card" returns no rows or name lookalikes here: filter by the industry, tag, mainProduct, or other classification fields, send the phrase as semanticQuery on POST /v1/entities/search, or ask natural search for plain-English or multi-constraint company requests. */
|
|
108
108
|
textSearch: z.string().nullish(),
|
|
109
109
|
/** Customer-type classification values. */
|
|
110
110
|
typeCustomer: z.array(z.string()).optional(),
|
package/dist/entity/list.d.ts
CHANGED
|
@@ -603,6 +603,21 @@ declare const EntityListSchemaDefinition: z.ZodObject<{
|
|
|
603
603
|
} | null | undefined;
|
|
604
604
|
financialInstrumentType?: "Bond" | "Common Stock" | "Convertible Note" | "Grant" | "Loan" | "Other Debt" | "Other Equity" | "Preferred Stock" | "SAFE" | "Token" | null | undefined;
|
|
605
605
|
id: string;
|
|
606
|
+
investor?: {
|
|
607
|
+
amountInvested?: number | null | undefined;
|
|
608
|
+
createdAt: string;
|
|
609
|
+
financialInstrumentType?: "Bond" | "Common Stock" | "Convertible Note" | "Grant" | "Loan" | "Other Debt" | "Other Equity" | "Preferred Stock" | "SAFE" | "Token" | null | undefined;
|
|
610
|
+
id: string;
|
|
611
|
+
investor: {
|
|
612
|
+
entityId?: string | null | undefined;
|
|
613
|
+
personId?: string | null | undefined;
|
|
614
|
+
};
|
|
615
|
+
investorName?: string | null | undefined;
|
|
616
|
+
investorSlug?: string | null | undefined;
|
|
617
|
+
leadInvestor: boolean;
|
|
618
|
+
transactionId: string;
|
|
619
|
+
updatedAt: string;
|
|
620
|
+
}[] | null | undefined;
|
|
606
621
|
investorAttribution?: {
|
|
607
622
|
amountInvested?: number | null | undefined;
|
|
608
623
|
attributionType: "direct" | "managedFund";
|
|
@@ -697,6 +712,21 @@ declare const EntityListSchemaDefinition: z.ZodObject<{
|
|
|
697
712
|
} | null | undefined;
|
|
698
713
|
financialInstrumentType?: "Bond" | "Common Stock" | "Convertible Note" | "Grant" | "Loan" | "Other Debt" | "Other Equity" | "Preferred Stock" | "SAFE" | "Token" | null | undefined;
|
|
699
714
|
id: string;
|
|
715
|
+
investor?: {
|
|
716
|
+
amountInvested?: number | null | undefined;
|
|
717
|
+
createdAt: string;
|
|
718
|
+
financialInstrumentType?: "Bond" | "Common Stock" | "Convertible Note" | "Grant" | "Loan" | "Other Debt" | "Other Equity" | "Preferred Stock" | "SAFE" | "Token" | null | undefined;
|
|
719
|
+
id: string;
|
|
720
|
+
investor: {
|
|
721
|
+
entityId?: string | null | undefined;
|
|
722
|
+
personId?: string | null | undefined;
|
|
723
|
+
};
|
|
724
|
+
investorName?: string | null | undefined;
|
|
725
|
+
investorSlug?: string | null | undefined;
|
|
726
|
+
leadInvestor: boolean;
|
|
727
|
+
transactionId: string;
|
|
728
|
+
updatedAt: string;
|
|
729
|
+
}[] | null | undefined;
|
|
700
730
|
investorAttribution?: {
|
|
701
731
|
amountInvested?: number | null | undefined;
|
|
702
732
|
attributionType: "direct" | "managedFund";
|
|
@@ -605,6 +605,21 @@ declare const EntityResolutionSchemaDefinition: z.ZodObject<{
|
|
|
605
605
|
} | null | undefined;
|
|
606
606
|
financialInstrumentType?: "Bond" | "Common Stock" | "Convertible Note" | "Grant" | "Loan" | "Other Debt" | "Other Equity" | "Preferred Stock" | "SAFE" | "Token" | null | undefined;
|
|
607
607
|
id: string;
|
|
608
|
+
investor?: {
|
|
609
|
+
amountInvested?: number | null | undefined;
|
|
610
|
+
createdAt: string;
|
|
611
|
+
financialInstrumentType?: "Bond" | "Common Stock" | "Convertible Note" | "Grant" | "Loan" | "Other Debt" | "Other Equity" | "Preferred Stock" | "SAFE" | "Token" | null | undefined;
|
|
612
|
+
id: string;
|
|
613
|
+
investor: {
|
|
614
|
+
entityId?: string | null | undefined;
|
|
615
|
+
personId?: string | null | undefined;
|
|
616
|
+
};
|
|
617
|
+
investorName?: string | null | undefined;
|
|
618
|
+
investorSlug?: string | null | undefined;
|
|
619
|
+
leadInvestor: boolean;
|
|
620
|
+
transactionId: string;
|
|
621
|
+
updatedAt: string;
|
|
622
|
+
}[] | null | undefined;
|
|
608
623
|
investorAttribution?: {
|
|
609
624
|
amountInvested?: number | null | undefined;
|
|
610
625
|
attributionType: "direct" | "managedFund";
|
|
@@ -699,6 +714,21 @@ declare const EntityResolutionSchemaDefinition: z.ZodObject<{
|
|
|
699
714
|
} | null | undefined;
|
|
700
715
|
financialInstrumentType?: "Bond" | "Common Stock" | "Convertible Note" | "Grant" | "Loan" | "Other Debt" | "Other Equity" | "Preferred Stock" | "SAFE" | "Token" | null | undefined;
|
|
701
716
|
id: string;
|
|
717
|
+
investor?: {
|
|
718
|
+
amountInvested?: number | null | undefined;
|
|
719
|
+
createdAt: string;
|
|
720
|
+
financialInstrumentType?: "Bond" | "Common Stock" | "Convertible Note" | "Grant" | "Loan" | "Other Debt" | "Other Equity" | "Preferred Stock" | "SAFE" | "Token" | null | undefined;
|
|
721
|
+
id: string;
|
|
722
|
+
investor: {
|
|
723
|
+
entityId?: string | null | undefined;
|
|
724
|
+
personId?: string | null | undefined;
|
|
725
|
+
};
|
|
726
|
+
investorName?: string | null | undefined;
|
|
727
|
+
investorSlug?: string | null | undefined;
|
|
728
|
+
leadInvestor: boolean;
|
|
729
|
+
transactionId: string;
|
|
730
|
+
updatedAt: string;
|
|
731
|
+
}[] | null | undefined;
|
|
702
732
|
investorAttribution?: {
|
|
703
733
|
amountInvested?: number | null | undefined;
|
|
704
734
|
attributionType: "direct" | "managedFund";
|
|
@@ -338,6 +338,21 @@ declare const EntitySimilarityResultSchemaDefinition: z.ZodObject<{
|
|
|
338
338
|
} | null | undefined;
|
|
339
339
|
financialInstrumentType?: "Bond" | "Common Stock" | "Convertible Note" | "Grant" | "Loan" | "Other Debt" | "Other Equity" | "Preferred Stock" | "SAFE" | "Token" | null | undefined;
|
|
340
340
|
id: string;
|
|
341
|
+
investor?: {
|
|
342
|
+
amountInvested?: number | null | undefined;
|
|
343
|
+
createdAt: string;
|
|
344
|
+
financialInstrumentType?: "Bond" | "Common Stock" | "Convertible Note" | "Grant" | "Loan" | "Other Debt" | "Other Equity" | "Preferred Stock" | "SAFE" | "Token" | null | undefined;
|
|
345
|
+
id: string;
|
|
346
|
+
investor: {
|
|
347
|
+
entityId?: string | null | undefined;
|
|
348
|
+
personId?: string | null | undefined;
|
|
349
|
+
};
|
|
350
|
+
investorName?: string | null | undefined;
|
|
351
|
+
investorSlug?: string | null | undefined;
|
|
352
|
+
leadInvestor: boolean;
|
|
353
|
+
transactionId: string;
|
|
354
|
+
updatedAt: string;
|
|
355
|
+
}[] | null | undefined;
|
|
341
356
|
investorAttribution?: {
|
|
342
357
|
amountInvested?: number | null | undefined;
|
|
343
358
|
attributionType: "direct" | "managedFund";
|
|
@@ -868,6 +883,21 @@ declare const EntitySimilarityResultSchemaDefinition: z.ZodObject<{
|
|
|
868
883
|
} | null | undefined;
|
|
869
884
|
financialInstrumentType?: "Bond" | "Common Stock" | "Convertible Note" | "Grant" | "Loan" | "Other Debt" | "Other Equity" | "Preferred Stock" | "SAFE" | "Token" | null | undefined;
|
|
870
885
|
id: string;
|
|
886
|
+
investor?: {
|
|
887
|
+
amountInvested?: number | null | undefined;
|
|
888
|
+
createdAt: string;
|
|
889
|
+
financialInstrumentType?: "Bond" | "Common Stock" | "Convertible Note" | "Grant" | "Loan" | "Other Debt" | "Other Equity" | "Preferred Stock" | "SAFE" | "Token" | null | undefined;
|
|
890
|
+
id: string;
|
|
891
|
+
investor: {
|
|
892
|
+
entityId?: string | null | undefined;
|
|
893
|
+
personId?: string | null | undefined;
|
|
894
|
+
};
|
|
895
|
+
investorName?: string | null | undefined;
|
|
896
|
+
investorSlug?: string | null | undefined;
|
|
897
|
+
leadInvestor: boolean;
|
|
898
|
+
transactionId: string;
|
|
899
|
+
updatedAt: string;
|
|
900
|
+
}[] | null | undefined;
|
|
871
901
|
investorAttribution?: {
|
|
872
902
|
amountInvested?: number | null | undefined;
|
|
873
903
|
attributionType: "direct" | "managedFund";
|