@aventurevc/api-schemas 0.8.56 → 0.8.60
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/filter-search.d.ts +1 -0
- package/dist/entity/filter.d.ts +1 -0
- package/dist/entity/filter.js +2 -0
- package/dist/entity/list-filter.d.ts +1 -0
- package/dist/entity/list-filter.js +2 -0
- package/dist/entity/lookup-exact-param.js +1 -1
- package/dist/entity/natural-search.d.ts +1 -0
- package/dist/entity/person-association.js +2 -1
- package/dist/federated/search.d.ts +2 -0
- package/dist/identification/subject.js +1 -1
- package/dist/link/search.d.ts +2 -0
- package/dist/natural/search-result.d.ts +2 -0
- package/dist/person/investment.js +2 -0
- package/dist/person/lookup-exact-param.js +1 -1
- package/dist/search/interpretation.d.ts +2 -0
- package/package.json +1 -1
|
@@ -9,6 +9,7 @@ declare const EntityFilterSearchSchemaDefinition: z.ZodObject<{
|
|
|
9
9
|
acceleratorName: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
10
10
|
acceleratorStatus: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
11
11
|
affinity: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
12
|
+
closedLast: z.ZodOptional<z.ZodBoolean>;
|
|
12
13
|
employeeCountRange: z.ZodOptional<z.ZodArray<z.ZodType<{
|
|
13
14
|
max?: number | null | undefined;
|
|
14
15
|
min?: number | null | undefined;
|
package/dist/entity/filter.d.ts
CHANGED
|
@@ -17,6 +17,7 @@ export declare const EntityFilterSchema: z.ZodObject<{
|
|
|
17
17
|
acceleratorName: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
18
18
|
acceleratorStatus: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
19
19
|
affinity: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
20
|
+
closedLast: z.ZodOptional<z.ZodBoolean>;
|
|
20
21
|
employeeCountRange: z.ZodOptional<z.ZodArray<z.ZodType<{
|
|
21
22
|
max?: number | null | undefined;
|
|
22
23
|
min?: number | null | undefined;
|
package/dist/entity/filter.js
CHANGED
|
@@ -31,6 +31,8 @@ export const EntityFilterSchema = z.strictObject({
|
|
|
31
31
|
acceleratorStatus: z.array(z.string()).optional(),
|
|
32
32
|
/** Affinity provider organization names accepted by the companies list filter. Affinity rows are member -> provider; use provider names here, not member names. */
|
|
33
33
|
affinity: z.array(z.string()).optional(),
|
|
34
|
+
/** Rank closed entities (Closed, Closed (Acquihire), Inactive) after every other textSearch or semanticQuery match, ahead of relevance and sort; omitted means true. false ranks them by relevance alone. Filter them out with operatingStatus or suppressNonOperating. */
|
|
35
|
+
closedLast: z.boolean().optional(),
|
|
34
36
|
/** Inclusive reported employee-count ranges, in employees. */
|
|
35
37
|
employeeCountRange: z.array(IntRangeSchema).optional(),
|
|
36
38
|
/** Restrict results to specific entity IDs. */
|
|
@@ -5,6 +5,7 @@ declare const EntityListFilterSchemaDefinition: z.ZodObject<{
|
|
|
5
5
|
acceleratorName: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
6
6
|
acceleratorStatus: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
7
7
|
affinity: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
8
|
+
closedLast: z.ZodOptional<z.ZodBoolean>;
|
|
8
9
|
employeeCountRange: z.ZodOptional<z.ZodArray<z.ZodType<{
|
|
9
10
|
max?: number | null | undefined;
|
|
10
11
|
min?: number | null | undefined;
|
|
@@ -19,6 +19,8 @@ const EntityListFilterSchemaDefinition = z.strictObject({
|
|
|
19
19
|
acceleratorStatus: z.array(z.string()).optional(),
|
|
20
20
|
/** Affinity provider organization names accepted by the companies list filter. Affinity rows are member -> provider; use provider names here, not member names. */
|
|
21
21
|
affinity: z.array(z.string()).optional(),
|
|
22
|
+
/** Rank closed entities (Closed, Closed (Acquihire), Inactive) after every other textSearch or semanticQuery match, ahead of relevance and sort; omitted means true. false ranks them by relevance alone. Filter them out with operatingStatus or suppressNonOperating. */
|
|
23
|
+
closedLast: z.boolean().optional(),
|
|
22
24
|
/** Inclusive reported employee-count ranges, in employees. */
|
|
23
25
|
employeeCountRange: z.array(IntRangeSchema).optional(),
|
|
24
26
|
/** Restrict results to specific entity IDs. */
|
|
@@ -39,7 +39,7 @@ export const EntityLookupExactParamSchema = z.object({
|
|
|
39
39
|
.optional(),
|
|
40
40
|
/** Concrete entity type qualifier; group-only Organization is invalid. List the accepted concrete tokens and their aliases with GET /v1/entities/types (CLI: entities types list). */
|
|
41
41
|
typeRecord: z.string().optional(),
|
|
42
|
-
/**
|
|
42
|
+
/** aventure.vc profile URL (such as https://aventure.vc/companies/<slug>), or the entity's own website or domain URL, matched by host and path unless urlMatchMode=domain. */
|
|
43
43
|
url: z.string().optional(),
|
|
44
44
|
/** Website domain candidate without protocol or path. */
|
|
45
45
|
urlDomain: z.string().optional(),
|
|
@@ -6,6 +6,7 @@ declare const EntityNaturalSearchSchemaDefinition: z.ZodObject<{
|
|
|
6
6
|
acceleratorName: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
7
7
|
acceleratorStatus: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
8
8
|
affinity: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
9
|
+
closedLast: z.ZodOptional<z.ZodBoolean>;
|
|
9
10
|
employeeCountRange: z.ZodOptional<z.ZodArray<z.ZodType<{
|
|
10
11
|
max?: number | null | undefined;
|
|
11
12
|
min?: number | null | undefined;
|
|
@@ -33,7 +33,7 @@ import { PersonImageSchema } from "../person/image.js";
|
|
|
33
33
|
export const EntityPersonAssociationSchema = z.object({
|
|
34
34
|
/** Integer person-entity association join row id, not a person or entity UUID */
|
|
35
35
|
associationId: z.int(),
|
|
36
|
-
/** Association period end, preserving source precision */
|
|
36
|
+
/** Association period end, preserving source precision; any value means the association ended and isCurrent is false. Absent only while not terminated */
|
|
37
37
|
endDate: z
|
|
38
38
|
.string()
|
|
39
39
|
.regex(/^(?!0000)[0-9]{4}(?:-(?:0[1-9]|1[0-2])(?:-(?:0[1-9]|[12][0-9]|3[01])(?:T(?:[01][0-9]|2[0-3]):[0-5][0-9](?::[0-5][0-9](?:\.[0-9]{1,9})?)?(?:Z|[+-][0-9]{2}:[0-5][0-9]))?)?)?$/)
|
|
@@ -55,6 +55,7 @@ export const EntityPersonAssociationSchema = z.object({
|
|
|
55
55
|
entityType: EntityTypeSchema.nullish(),
|
|
56
56
|
/** Entity URL links carried on the association projection */
|
|
57
57
|
entityUrlLink: z.array(EntityUrlLinkSchema),
|
|
58
|
+
/** True only while the association has no endDate; any endDate means it ended */
|
|
58
59
|
isCurrent: z.boolean().nullish(),
|
|
59
60
|
/** Person addresses carried on the association projection */
|
|
60
61
|
personAddress: z.array(AddressSchema),
|
|
@@ -14,6 +14,7 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
|
|
|
14
14
|
acceleratorName?: string[] | undefined;
|
|
15
15
|
acceleratorStatus?: string[] | undefined;
|
|
16
16
|
affinity?: string[] | undefined;
|
|
17
|
+
closedLast?: boolean | undefined;
|
|
17
18
|
employeeCountRange?: {
|
|
18
19
|
max?: number | null | undefined;
|
|
19
20
|
min?: number | null | undefined;
|
|
@@ -611,6 +612,7 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
|
|
|
611
612
|
acceleratorName?: string[] | undefined;
|
|
612
613
|
acceleratorStatus?: string[] | undefined;
|
|
613
614
|
affinity?: string[] | undefined;
|
|
615
|
+
closedLast?: boolean | undefined;
|
|
614
616
|
employeeCountRange?: {
|
|
615
617
|
max?: number | null | undefined;
|
|
616
618
|
min?: number | null | undefined;
|
|
@@ -18,7 +18,7 @@ import { EntityTypeSchema } from "../entity/type.js";
|
|
|
18
18
|
export const IdentificationSubjectSchema = z.object({
|
|
19
19
|
/** Specific facts in plain words: product, industry, employer and title, or founder names. Generic words like startup add nothing. */
|
|
20
20
|
context: z.string().max(2000).nullish(),
|
|
21
|
-
/** Kind of record to identify when you know it; the
|
|
21
|
+
/** Kind of record to identify when you know it; the lookup then runs only that kind's ladder. typeRecord or providerId implies ENTITY. */
|
|
22
22
|
kind: z.enum(["ENTITY", "PERSON"]).nullish(),
|
|
23
23
|
/** City, region, or country, such as Austin, TX. Tells namesakes apart; not proof on its own. */
|
|
24
24
|
location: z.string().max(2000).nullish(),
|
package/dist/link/search.d.ts
CHANGED
|
@@ -16,6 +16,7 @@ declare const LinkSearchSchemaDefinition: z.ZodObject<{
|
|
|
16
16
|
acceleratorName?: string[] | undefined;
|
|
17
17
|
acceleratorStatus?: string[] | undefined;
|
|
18
18
|
affinity?: string[] | undefined;
|
|
19
|
+
closedLast?: boolean | undefined;
|
|
19
20
|
employeeCountRange?: {
|
|
20
21
|
max?: number | null | undefined;
|
|
21
22
|
min?: number | null | undefined;
|
|
@@ -773,6 +774,7 @@ declare const LinkSearchSchemaDefinition: z.ZodObject<{
|
|
|
773
774
|
acceleratorName?: string[] | undefined;
|
|
774
775
|
acceleratorStatus?: string[] | undefined;
|
|
775
776
|
affinity?: string[] | undefined;
|
|
777
|
+
closedLast?: boolean | undefined;
|
|
776
778
|
employeeCountRange?: {
|
|
777
779
|
max?: number | null | undefined;
|
|
778
780
|
min?: number | null | undefined;
|
|
@@ -13,6 +13,7 @@ declare const NaturalSearchResultSchemaDefinition: z.ZodObject<{
|
|
|
13
13
|
acceleratorName?: string[] | undefined;
|
|
14
14
|
acceleratorStatus?: string[] | undefined;
|
|
15
15
|
affinity?: string[] | undefined;
|
|
16
|
+
closedLast?: boolean | undefined;
|
|
16
17
|
employeeCountRange?: {
|
|
17
18
|
max?: number | null | undefined;
|
|
18
19
|
min?: number | null | undefined;
|
|
@@ -127,6 +128,7 @@ declare const NaturalSearchResultSchemaDefinition: z.ZodObject<{
|
|
|
127
128
|
acceleratorName?: string[] | undefined;
|
|
128
129
|
acceleratorStatus?: string[] | undefined;
|
|
129
130
|
affinity?: string[] | undefined;
|
|
131
|
+
closedLast?: boolean | undefined;
|
|
130
132
|
employeeCountRange?: {
|
|
131
133
|
max?: number | null | undefined;
|
|
132
134
|
min?: number | null | undefined;
|
|
@@ -6,11 +6,13 @@ import { PersonInvestedCompanySchema } from "./invested-company.js";
|
|
|
6
6
|
const PersonInvestmentSchemaDefinition = z.object({
|
|
7
7
|
amount: z.number().nullish(),
|
|
8
8
|
company: PersonInvestedCompanySchema,
|
|
9
|
+
/** Announced date of the fundraise round. Use this field for when the investment happened; null when the round date is unknown. */
|
|
9
10
|
date: z.iso.datetime({ offset: true }).nullish(),
|
|
10
11
|
fundraiseTransaction: EntityFundraiseSchema.nullish(),
|
|
11
12
|
/** Canonical fundraise transaction UUID */
|
|
12
13
|
fundraiseTransactionId: z.uuid(),
|
|
13
14
|
id: z.string(),
|
|
15
|
+
/** When aVenture recorded this person's participation in the round. It is not the investment date: imported portfolios share their import date. Use date for when the round happened. */
|
|
14
16
|
investmentDate: z.iso.datetime({ offset: true }),
|
|
15
17
|
/** Investor-specific attribution for this person's participation in the fundraise round. amountInvested is a plain decimal number in the fundraise transaction currency and is not added to amount. */
|
|
16
18
|
investorAttribution: FundraiseInvestmentAttributionSchema.nullish(),
|
|
@@ -31,7 +31,7 @@ export const PersonLookupExactParamSchema = z.object({
|
|
|
31
31
|
permitMonogram: z.boolean().optional(),
|
|
32
32
|
/** Group A — exact person slug (URL-friendly identifier). Mutually exclusive with id, url, and every candidate signal in group C. */
|
|
33
33
|
slug: z.string().optional(),
|
|
34
|
-
/** Group B —
|
|
34
|
+
/** Group B — aventure.vc person profile URL (such as https://aventure.vc/people/<slug>) or the person's current profile URL, resolved via strict host+path or domain-only match. Mutually exclusive with id and slug; may be combined with group-C candidate signals for URL-first fallback. */
|
|
35
35
|
url: z.string().optional(),
|
|
36
36
|
/** Group C — candidate lookup signal: person URL domain (host only, no path). Combine with other group-C signals for disambiguation. Mutually exclusive with id and slug; may be combined with url for fallback. */
|
|
37
37
|
urlDomain: z.string().optional(),
|
|
@@ -19,6 +19,7 @@ declare const SearchInterpretationSchemaDefinition: z.ZodObject<{
|
|
|
19
19
|
acceleratorName?: string[] | undefined;
|
|
20
20
|
acceleratorStatus?: string[] | undefined;
|
|
21
21
|
affinity?: string[] | undefined;
|
|
22
|
+
closedLast?: boolean | undefined;
|
|
22
23
|
employeeCountRange?: {
|
|
23
24
|
max?: number | null | undefined;
|
|
24
25
|
min?: number | null | undefined;
|
|
@@ -116,6 +117,7 @@ declare const SearchInterpretationSchemaDefinition: z.ZodObject<{
|
|
|
116
117
|
acceleratorName?: string[] | undefined;
|
|
117
118
|
acceleratorStatus?: string[] | undefined;
|
|
118
119
|
affinity?: string[] | undefined;
|
|
120
|
+
closedLast?: boolean | undefined;
|
|
119
121
|
employeeCountRange?: {
|
|
120
122
|
max?: number | null | undefined;
|
|
121
123
|
min?: number | null | undefined;
|