@aventurevc/api-schemas 0.8.5 → 0.8.6

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.
Files changed (43) hide show
  1. package/dist/billing/subscription.d.ts +16 -16
  2. package/dist/enrichment/batch.js +4 -4
  3. package/dist/enrichment/enrichment.d.ts +2 -0
  4. package/dist/enrichment/refusal-type.d.ts +3 -1
  5. package/dist/enrichment/refusal-type.js +7 -2
  6. package/dist/entity/alias-type.d.ts +1 -0
  7. package/dist/entity/alias-type.js +1 -0
  8. package/dist/entity/entity.d.ts +2 -0
  9. package/dist/entity/entity.js +2 -0
  10. package/dist/entity/image.d.ts +1 -0
  11. package/dist/entity/image.js +1 -0
  12. package/dist/entity/name-alias-entity-alias-type.d.ts +1 -0
  13. package/dist/entity/name-alias-entity-alias-type.js +1 -0
  14. package/dist/entity/similarity-context.d.ts +2 -0
  15. package/dist/entity/similarity-context.js +2 -0
  16. package/dist/entity/similarity-origin.d.ts +1 -0
  17. package/dist/entity/similarity-origin.js +1 -0
  18. package/dist/entity/similarity-summary.d.ts +125 -0
  19. package/dist/entity/similarity-summary.js +22 -0
  20. package/dist/entity/sitemap.d.ts +1 -0
  21. package/dist/entity/sitemap.js +1 -0
  22. package/dist/entity/url-crawl-cdn-provider.d.ts +1 -0
  23. package/dist/entity/url-crawl-cdn-provider.js +1 -0
  24. package/dist/entity/url-crawl-render-mode.d.ts +1 -0
  25. package/dist/entity/url-crawl-render-mode.js +1 -0
  26. package/dist/entity/url-link.d.ts +2 -0
  27. package/dist/entity/url-link.js +2 -0
  28. package/dist/entity/url-type.d.ts +1 -0
  29. package/dist/entity/url-type.js +1 -0
  30. package/dist/openapi-component-manifest.js +8 -0
  31. package/dist/pageable/object.d.ts +2 -0
  32. package/dist/pageable/object.js +2 -0
  33. package/dist/pagination/schemas.d.ts +164 -0
  34. package/dist/pagination/schemas.js +22 -0
  35. package/dist/problem/type.d.ts +1 -0
  36. package/dist/problem/type.js +1 -0
  37. package/dist/research/allowance-usage.d.ts +99 -54
  38. package/dist/research/allowance-usage.js +4 -4
  39. package/dist/research/allowance.d.ts +9 -6
  40. package/dist/research/allowance.js +10 -9
  41. package/dist/sort/object.d.ts +2 -0
  42. package/dist/sort/object.js +2 -0
  43. package/package.json +1 -1
@@ -44,18 +44,18 @@ declare const BillingSubscriptionSchemaDefinition: z.ZodObject<{
44
44
  resetAt: string;
45
45
  used: number;
46
46
  };
47
- newCompany?: {
47
+ newCompany: {
48
48
  limit?: number | null | undefined;
49
49
  remaining?: number | null | undefined;
50
50
  resetAt: string;
51
51
  used: number;
52
- } | undefined;
53
- newPerson?: {
52
+ };
53
+ newPerson: {
54
54
  limit?: number | null | undefined;
55
55
  remaining?: number | null | undefined;
56
56
  resetAt: string;
57
57
  used: number;
58
- } | undefined;
58
+ };
59
59
  person: {
60
60
  limit?: number | null | undefined;
61
61
  remaining?: number | null | undefined;
@@ -68,18 +68,18 @@ declare const BillingSubscriptionSchemaDefinition: z.ZodObject<{
68
68
  resetAt: string;
69
69
  used: number;
70
70
  };
71
- update?: {
71
+ update: {
72
72
  limit?: number | null | undefined;
73
73
  remaining?: number | null | undefined;
74
74
  resetAt: string;
75
75
  used: number;
76
- } | undefined;
77
- updatePerson?: {
76
+ };
77
+ updatePerson: {
78
78
  limit?: number | null | undefined;
79
79
  remaining?: number | null | undefined;
80
80
  resetAt: string;
81
81
  used: number;
82
- } | undefined;
82
+ };
83
83
  webSearch: {
84
84
  limit?: number | null | undefined;
85
85
  remaining?: number | null | undefined;
@@ -99,18 +99,18 @@ declare const BillingSubscriptionSchemaDefinition: z.ZodObject<{
99
99
  resetAt: string;
100
100
  used: number;
101
101
  };
102
- newCompany?: {
102
+ newCompany: {
103
103
  limit?: number | null | undefined;
104
104
  remaining?: number | null | undefined;
105
105
  resetAt: string;
106
106
  used: number;
107
- } | undefined;
108
- newPerson?: {
107
+ };
108
+ newPerson: {
109
109
  limit?: number | null | undefined;
110
110
  remaining?: number | null | undefined;
111
111
  resetAt: string;
112
112
  used: number;
113
- } | undefined;
113
+ };
114
114
  person: {
115
115
  limit?: number | null | undefined;
116
116
  remaining?: number | null | undefined;
@@ -123,18 +123,18 @@ declare const BillingSubscriptionSchemaDefinition: z.ZodObject<{
123
123
  resetAt: string;
124
124
  used: number;
125
125
  };
126
- update?: {
126
+ update: {
127
127
  limit?: number | null | undefined;
128
128
  remaining?: number | null | undefined;
129
129
  resetAt: string;
130
130
  used: number;
131
- } | undefined;
132
- updatePerson?: {
131
+ };
132
+ updatePerson: {
133
133
  limit?: number | null | undefined;
134
134
  remaining?: number | null | undefined;
135
135
  resetAt: string;
136
136
  used: number;
137
- } | undefined;
137
+ };
138
138
  webSearch: {
139
139
  limit?: number | null | undefined;
140
140
  remaining?: number | null | undefined;
@@ -4,15 +4,15 @@ import { EnrichmentModeSchema } from "./mode.js";
4
4
  const EnrichmentBatchSchemaDefinition = z.object({
5
5
  /** Canonical entity UUIDs to enrich, filed in order before any person */
6
6
  entityId: z.array(z.uuid()).optional(),
7
- /** Enrichment breadth; omitted requests the comprehensive default */
7
+ /** COMPREHENSIVE (the default) researches each whole profile; INDIVIDUAL runs only the tasks named in taskPresetKey */
8
8
  mode: EnrichmentModeSchema.optional(),
9
- /** Orchestrator model override; omitted uses the configured role default */
9
+ /** Model id for each run's lead agent; omit to use aVenture's default model */
10
10
  model: z.string().nullish(),
11
11
  /** Canonical person UUIDs to enrich, filed in order after every entity */
12
12
  personId: z.array(z.uuid()).optional(),
13
- /** Task preset keys that scope or emphasize every run */
13
+ /** Task preset keys that scope or emphasize every run; at least one is required when mode is INDIVIDUAL, and an unknown key is a 400 */
14
14
  taskPresetKey: z.array(z.string()).nullish(),
15
- /** Optional steering prompt */
15
+ /** Plain-language instruction for every run, such as which facts or sources to check first */
16
16
  userPrompt: z.string().nullish(),
17
17
  });
18
18
  /**
@@ -6,7 +6,9 @@ declare const EnrichmentSchemaDefinition: z.ZodObject<{
6
6
  }, z.core.$strip>;
7
7
  refusal: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
8
8
  ALLOWANCE_EXHAUSTED: "ALLOWANCE_EXHAUSTED";
9
+ AMBIGUOUS: "AMBIGUOUS";
9
10
  NOT_FOUND: "NOT_FOUND";
11
+ SUBSCRIPTION_REQUIRED: "SUBSCRIPTION_REQUIRED";
10
12
  }>>>;
11
13
  run: z.ZodOptional<z.ZodNullable<z.ZodObject<{
12
14
  attempt: z.ZodInt;
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Why a batch enrichment filed no run: NOT_FOUND for an unknown record, ALLOWANCE_EXHAUSTED once the caller's research allowance ran out during the batch
3
+ * Why a batch enrichment filed no run: NOT_FOUND for an unknown record; ALLOWANCE_EXHAUSTED when the record's company or person research allowance is spent and additional usage is off or at its spend cap or prepaid credit; AMBIGUOUS when the record's profile matches more than one current record; SUBSCRIPTION_REQUIRED when the subscription stopped covering research mid-batch, such as additional usage while past due
4
4
  *
5
5
  * @openapiSchema EnrichmentRefusalType
6
6
  * @endpoint POST /v1/enrichments
@@ -10,7 +10,9 @@ import { z } from "zod/v4";
10
10
  */
11
11
  export declare const EnrichmentRefusalTypeSchema: z.ZodEnum<{
12
12
  ALLOWANCE_EXHAUSTED: "ALLOWANCE_EXHAUSTED";
13
+ AMBIGUOUS: "AMBIGUOUS";
13
14
  NOT_FOUND: "NOT_FOUND";
15
+ SUBSCRIPTION_REQUIRED: "SUBSCRIPTION_REQUIRED";
14
16
  }>;
15
17
  export type EnrichmentRefusalType = z.infer<typeof EnrichmentRefusalTypeSchema>;
16
18
  //# sourceMappingURL=refusal-type.d.ts.map
@@ -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
- * Why a batch enrichment filed no run: NOT_FOUND for an unknown record, ALLOWANCE_EXHAUSTED once the caller's research allowance ran out during the batch
4
+ * Why a batch enrichment filed no run: NOT_FOUND for an unknown record; ALLOWANCE_EXHAUSTED when the record's company or person research allowance is spent and additional usage is off or at its spend cap or prepaid credit; AMBIGUOUS when the record's profile matches more than one current record; SUBSCRIPTION_REQUIRED when the subscription stopped covering research mid-batch, such as additional usage while past due
5
5
  *
6
6
  * @openapiSchema EnrichmentRefusalType
7
7
  * @endpoint POST /v1/enrichments
@@ -9,5 +9,10 @@ import { z } from "zod/v4";
9
9
  * @contractShape enrichment.refusal-type
10
10
  * @contractRole canonical
11
11
  */
12
- export const EnrichmentRefusalTypeSchema = z.enum(["NOT_FOUND", "ALLOWANCE_EXHAUSTED"]);
12
+ export const EnrichmentRefusalTypeSchema = z.enum([
13
+ "NOT_FOUND",
14
+ "ALLOWANCE_EXHAUSTED",
15
+ "AMBIGUOUS",
16
+ "SUBSCRIPTION_REQUIRED",
17
+ ]);
13
18
  //# sourceMappingURL=refusal-type.js.map
@@ -18,6 +18,7 @@ import { z } from "zod/v4";
18
18
  * @endpoint GET /v1/entities/{entityId}/relationships
19
19
  * @endpoint GET /v1/entities/{entityId}/research
20
20
  * @endpoint GET /v1/entities/{entityId}/similar
21
+ * @endpoint GET /v1/entities/{entityId}/similar/summary
21
22
  * @endpoint GET /v1/entities/relationships/{relationshipId}
22
23
  * @endpoint GET /v1/harness/runs/{runId}
23
24
  * @endpoint GET /v1/news/{newsId}/related-entities
@@ -19,6 +19,7 @@ import { z } from "zod/v4";
19
19
  * @endpoint GET /v1/entities/{entityId}/relationships
20
20
  * @endpoint GET /v1/entities/{entityId}/research
21
21
  * @endpoint GET /v1/entities/{entityId}/similar
22
+ * @endpoint GET /v1/entities/{entityId}/similar/summary
22
23
  * @endpoint GET /v1/entities/relationships/{relationshipId}
23
24
  * @endpoint GET /v1/harness/runs/{runId}
24
25
  * @endpoint GET /v1/news/{newsId}/related-entities
@@ -18,6 +18,7 @@ import { z } from "zod/v4";
18
18
  * @endpoint GET /v1/entities/{entityId}/relationships
19
19
  * @endpoint GET /v1/entities/{entityId}/research
20
20
  * @endpoint GET /v1/entities/{entityId}/similar
21
+ * @endpoint GET /v1/entities/{entityId}/similar/summary
21
22
  * @endpoint GET /v1/entities/relationships/{relationshipId}
22
23
  * @endpoint GET /v1/harness/runs/{runId}
23
24
  * @endpoint GET /v1/news/{newsId}/related-entities
@@ -38,6 +39,7 @@ import { z } from "zod/v4";
38
39
  * @usedBySchema EntityFundraiseTransactionEntitySchema
39
40
  * @usedBySchema EntityListSchema
40
41
  * @usedBySchema EntityRelationshipSchema
42
+ * @usedBySchema EntitySimilaritySummarySchema
41
43
  * @usedBySchema HarnessRunDetailSchema
42
44
  * @usedBySchema PageEntitySchema
43
45
  * @usedBySchema PersonGraphCoInvestorSchema
@@ -23,6 +23,7 @@ import { EntityTypeSchema } from "./type.js";
23
23
  * @endpoint GET /v1/entities/{entityId}/relationships
24
24
  * @endpoint GET /v1/entities/{entityId}/research
25
25
  * @endpoint GET /v1/entities/{entityId}/similar
26
+ * @endpoint GET /v1/entities/{entityId}/similar/summary
26
27
  * @endpoint GET /v1/entities/relationships/{relationshipId}
27
28
  * @endpoint GET /v1/harness/runs/{runId}
28
29
  * @endpoint GET /v1/news/{newsId}/related-entities
@@ -43,6 +44,7 @@ import { EntityTypeSchema } from "./type.js";
43
44
  * @usedBySchema EntityFundraiseTransactionEntitySchema
44
45
  * @usedBySchema EntityListSchema
45
46
  * @usedBySchema EntityRelationshipSchema
47
+ * @usedBySchema EntitySimilaritySummarySchema
46
48
  * @usedBySchema HarnessRunDetailSchema
47
49
  * @usedBySchema PageEntitySchema
48
50
  * @usedBySchema PersonGraphCoInvestorSchema
@@ -26,6 +26,7 @@ type EntityImageDefinition = z.infer<typeof EntityImageSchemaDefinition>;
26
26
  * @endpoint GET /v1/entities/{entityId}/relationships
27
27
  * @endpoint GET /v1/entities/{entityId}/research
28
28
  * @endpoint GET /v1/entities/{entityId}/similar
29
+ * @endpoint GET /v1/entities/{entityId}/similar/summary
29
30
  * @endpoint GET /v1/entities/relationships/{relationshipId}
30
31
  * @endpoint GET /v1/harness/runs/{runId}
31
32
  * @endpoint GET /v1/news/{newsId}/related-entities
@@ -27,6 +27,7 @@ const EntityImageSchemaDefinition = z.object({
27
27
  * @endpoint GET /v1/entities/{entityId}/relationships
28
28
  * @endpoint GET /v1/entities/{entityId}/research
29
29
  * @endpoint GET /v1/entities/{entityId}/similar
30
+ * @endpoint GET /v1/entities/{entityId}/similar/summary
30
31
  * @endpoint GET /v1/entities/relationships/{relationshipId}
31
32
  * @endpoint GET /v1/harness/runs/{runId}
32
33
  * @endpoint GET /v1/news/{newsId}/related-entities
@@ -27,6 +27,7 @@ type EntityNameAliasEntityAliasTypeDefinition = z.infer<typeof EntityNameAliasEn
27
27
  * @endpoint GET /v1/entities/{entityId}/relationships
28
28
  * @endpoint GET /v1/entities/{entityId}/research
29
29
  * @endpoint GET /v1/entities/{entityId}/similar
30
+ * @endpoint GET /v1/entities/{entityId}/similar/summary
30
31
  * @endpoint GET /v1/entities/relationships/{relationshipId}
31
32
  * @endpoint GET /v1/harness/runs/{runId}
32
33
  * @endpoint GET /v1/news/{newsId}/related-entities
@@ -28,6 +28,7 @@ const EntityNameAliasEntityAliasTypeSchemaDefinition = z.object({
28
28
  * @endpoint GET /v1/entities/{entityId}/relationships
29
29
  * @endpoint GET /v1/entities/{entityId}/research
30
30
  * @endpoint GET /v1/entities/{entityId}/similar
31
+ * @endpoint GET /v1/entities/{entityId}/similar/summary
31
32
  * @endpoint GET /v1/entities/relationships/{relationshipId}
32
33
  * @endpoint GET /v1/harness/runs/{runId}
33
34
  * @endpoint GET /v1/news/{newsId}/related-entities
@@ -23,7 +23,9 @@ type EntitySimilarityContextDefinition = z.infer<typeof EntitySimilarityContextS
23
23
  *
24
24
  * @openapiSchema EntitySimilarityContext
25
25
  * @endpoint GET /v1/entities/{entityId}/similar
26
+ * @endpoint GET /v1/entities/{entityId}/similar/summary
26
27
  * @usedBySchema EntitySimilarityResultSchema
28
+ * @usedBySchema EntitySimilaritySummarySchema
27
29
  * @contractShape entity.similarity-context
28
30
  * @contractRole canonical
29
31
  */
@@ -27,7 +27,9 @@ const EntitySimilarityContextSchemaDefinition = z.object({
27
27
  *
28
28
  * @openapiSchema EntitySimilarityContext
29
29
  * @endpoint GET /v1/entities/{entityId}/similar
30
+ * @endpoint GET /v1/entities/{entityId}/similar/summary
30
31
  * @usedBySchema EntitySimilarityResultSchema
32
+ * @usedBySchema EntitySimilaritySummarySchema
31
33
  * @contractShape entity.similarity-context
32
34
  * @contractRole canonical
33
35
  */
@@ -4,6 +4,7 @@ import { z } from "zod/v4";
4
4
  *
5
5
  * @openapiSchema EntitySimilarityOrigin
6
6
  * @endpoint GET /v1/entities/{entityId}/similar
7
+ * @endpoint GET /v1/entities/{entityId}/similar/summary
7
8
  * @usedBySchema EntitySimilarityContextSchema
8
9
  * @contractShape entity.similarity-origin
9
10
  * @contractRole canonical
@@ -5,6 +5,7 @@ import { z } from "zod/v4";
5
5
  *
6
6
  * @openapiSchema EntitySimilarityOrigin
7
7
  * @endpoint GET /v1/entities/{entityId}/similar
8
+ * @endpoint GET /v1/entities/{entityId}/similar/summary
8
9
  * @usedBySchema EntitySimilarityContextSchema
9
10
  * @contractShape entity.similarity-origin
10
11
  * @contractRole canonical
@@ -0,0 +1,125 @@
1
+ import { z } from "zod/v4";
2
+ declare const EntitySimilaritySummarySchemaDefinition: z.ZodObject<{
3
+ core: z.ZodObject<{
4
+ defaultCurrency: z.ZodOptional<z.ZodNullable<z.ZodString>>;
5
+ foundedYear: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
6
+ id: z.ZodUUID;
7
+ image: z.ZodType<{
8
+ isMonogram: boolean;
9
+ logo?: string | null | undefined;
10
+ logoSquare?: string | null | undefined;
11
+ }, unknown, z.core.$ZodTypeInternals<{
12
+ isMonogram: boolean;
13
+ logo?: string | null | undefined;
14
+ logoSquare?: string | null | undefined;
15
+ }, unknown>>;
16
+ lastModifiedAt: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
17
+ nameAlias: z.ZodArray<z.ZodType<{
18
+ displayable?: boolean | null | undefined;
19
+ name: string;
20
+ type?: "alternativeDba" | "relatedLegal" | null | undefined;
21
+ }, unknown, z.core.$ZodTypeInternals<{
22
+ displayable?: boolean | null | undefined;
23
+ name: string;
24
+ type?: "alternativeDba" | "relatedLegal" | null | undefined;
25
+ }, unknown>>>;
26
+ nameBrand: z.ZodString;
27
+ nameLegal: z.ZodOptional<z.ZodNullable<z.ZodString>>;
28
+ operatingStatus: z.ZodOptional<z.ZodNullable<z.ZodString>>;
29
+ publicId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
30
+ publicUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
31
+ sitemap: z.ZodOptional<z.ZodNullable<z.ZodObject<{
32
+ hasAcquisitions: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
33
+ hasAnalysis: z.ZodBoolean;
34
+ hasEmployees: z.ZodBoolean;
35
+ hasFundraising: z.ZodBoolean;
36
+ hasNews: z.ZodBoolean;
37
+ productServiceSlug: z.ZodArray<z.ZodString>;
38
+ }, z.core.$strip>>>;
39
+ slug: z.ZodString;
40
+ typeRecord: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
41
+ "Business Line": "Business Line";
42
+ Company: "Company";
43
+ Fund: "Fund";
44
+ Government: "Government";
45
+ "Investment Firm": "Investment Firm";
46
+ Nonprofit: "Nonprofit";
47
+ Organization: "Organization";
48
+ Product: "Product";
49
+ Service: "Service";
50
+ }>>>;
51
+ updatedAt: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
52
+ }, z.core.$strip>;
53
+ similarity: z.ZodType<{
54
+ compositeScore?: number | null | undefined;
55
+ cosineScore?: number | null | undefined;
56
+ curatedAsOf?: string | null | undefined;
57
+ curatedRelationshipType?: string | null | undefined;
58
+ curatedSource?: string | null | undefined;
59
+ derivedFromEntityId?: string | null | undefined;
60
+ matchedSectionWeight?: number | null | undefined;
61
+ origin: "computed" | "curated" | "derived" | "precomputed" | "semantic";
62
+ rank: number;
63
+ sharedSectionCount?: number | null | undefined;
64
+ }, unknown, z.core.$ZodTypeInternals<{
65
+ compositeScore?: number | null | undefined;
66
+ cosineScore?: number | null | undefined;
67
+ curatedAsOf?: string | null | undefined;
68
+ curatedRelationshipType?: string | null | undefined;
69
+ curatedSource?: string | null | undefined;
70
+ derivedFromEntityId?: string | null | undefined;
71
+ matchedSectionWeight?: number | null | undefined;
72
+ origin: "computed" | "curated" | "derived" | "precomputed" | "semantic";
73
+ rank: number;
74
+ sharedSectionCount?: number | null | undefined;
75
+ }, unknown>>;
76
+ urlLink: z.ZodArray<z.ZodType<{
77
+ crawlCdnProvider?: "akamai" | "awsCloudfront" | "azureCdn" | "bunny" | "cdn77" | "cdnetworks" | "cloudflare" | "digitalocean" | "fastly" | "gcore" | "googlecloudCdn" | "incapsula" | "keycdn" | "leaseweb" | "netlify" | "none" | "stackpath" | "sucuri" | "unknown" | "vercel" | null | undefined;
78
+ crawlRenderMode?: "jsEnhanced" | "jsRequired" | "static" | null | undefined;
79
+ createdAt?: string | null | undefined;
80
+ id?: number | null | undefined;
81
+ isCurrent?: boolean | null | undefined;
82
+ isPrimary?: boolean | null | undefined;
83
+ owner?: {
84
+ entityId?: string | null | undefined;
85
+ personId?: string | null | undefined;
86
+ } | null | undefined;
87
+ sourceId?: string | null | undefined;
88
+ status?: string | null | undefined;
89
+ statusChecked?: string | null | undefined;
90
+ updatedAt?: string | null | undefined;
91
+ url: string;
92
+ urlType: "alternativeto" | "angellist" | "appstore" | "awsmarketplace" | "bloomberg" | "capterra" | "changelog" | "chromewebstore" | "crates" | "crunchbase" | "discord" | "dockerhub" | "documentation" | "facebook" | "forum" | "g2" | "gartnerpeerinsights" | "getapp" | "github" | "glassdoor" | "googleplay" | "homebrew" | "hubspotmarketplace" | "huggingface" | "instagram" | "linkedin" | "maven" | "morningstar" | "nasdaq" | "npm" | "nyse" | "pitchbook" | "producthunt" | "pypi" | "roadmap" | "salesforceappexchange" | "slackappdirectory" | "sourceforge" | "statuspage" | "subreddit" | "support" | "theorg" | "tiktok" | "trustpilot" | "trustradius" | "twitter" | "vscodemarketplace" | "website" | "wellfound" | "wikipedia" | "ycombinator" | "youtube";
93
+ }, unknown, z.core.$ZodTypeInternals<{
94
+ crawlCdnProvider?: "akamai" | "awsCloudfront" | "azureCdn" | "bunny" | "cdn77" | "cdnetworks" | "cloudflare" | "digitalocean" | "fastly" | "gcore" | "googlecloudCdn" | "incapsula" | "keycdn" | "leaseweb" | "netlify" | "none" | "stackpath" | "sucuri" | "unknown" | "vercel" | null | undefined;
95
+ crawlRenderMode?: "jsEnhanced" | "jsRequired" | "static" | null | undefined;
96
+ createdAt?: string | null | undefined;
97
+ id?: number | null | undefined;
98
+ isCurrent?: boolean | null | undefined;
99
+ isPrimary?: boolean | null | undefined;
100
+ owner?: {
101
+ entityId?: string | null | undefined;
102
+ personId?: string | null | undefined;
103
+ } | null | undefined;
104
+ sourceId?: string | null | undefined;
105
+ status?: string | null | undefined;
106
+ statusChecked?: string | null | undefined;
107
+ updatedAt?: string | null | undefined;
108
+ url: string;
109
+ urlType: "alternativeto" | "angellist" | "appstore" | "awsmarketplace" | "bloomberg" | "capterra" | "changelog" | "chromewebstore" | "crates" | "crunchbase" | "discord" | "dockerhub" | "documentation" | "facebook" | "forum" | "g2" | "gartnerpeerinsights" | "getapp" | "github" | "glassdoor" | "googleplay" | "homebrew" | "hubspotmarketplace" | "huggingface" | "instagram" | "linkedin" | "maven" | "morningstar" | "nasdaq" | "npm" | "nyse" | "pitchbook" | "producthunt" | "pypi" | "roadmap" | "salesforceappexchange" | "slackappdirectory" | "sourceforge" | "statuspage" | "subreddit" | "support" | "theorg" | "tiktok" | "trustpilot" | "trustradius" | "twitter" | "vscodemarketplace" | "website" | "wellfound" | "wikipedia" | "ycombinator" | "youtube";
110
+ }, unknown>>>;
111
+ }, z.core.$strip>;
112
+ type EntitySimilaritySummaryDefinition = z.infer<typeof EntitySimilaritySummarySchemaDefinition>;
113
+ /**
114
+ * Lean similar-entity rail row: core identity, current URL links, and similarity provenance. Use EntitySimilarityResult for full EntityList rows.
115
+ *
116
+ * @openapiSchema EntitySimilaritySummary
117
+ * @endpoint GET /v1/entities/{entityId}/similar/summary
118
+ * @usedBySchema PageEntitySimilaritySummarySchema
119
+ * @contractShape entity.similarity-summary
120
+ * @contractRole canonical
121
+ */
122
+ export declare const EntitySimilaritySummarySchema: z.ZodType<EntitySimilaritySummaryDefinition>;
123
+ export type EntitySimilaritySummary = z.infer<typeof EntitySimilaritySummarySchema>;
124
+ export {};
125
+ //# sourceMappingURL=similarity-summary.d.ts.map
@@ -0,0 +1,22 @@
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
+ import { EntitySchema } from "./entity.js";
4
+ import { EntitySimilarityContextSchema } from "./similarity-context.js";
5
+ import { EntityUrlLinkSchema } from "./url-link.js";
6
+ const EntitySimilaritySummarySchemaDefinition = z.object({
7
+ core: EntitySchema,
8
+ similarity: EntitySimilarityContextSchema,
9
+ /** Current primary URL links, one per URL type */
10
+ urlLink: z.array(EntityUrlLinkSchema),
11
+ });
12
+ /**
13
+ * Lean similar-entity rail row: core identity, current URL links, and similarity provenance. Use EntitySimilarityResult for full EntityList rows.
14
+ *
15
+ * @openapiSchema EntitySimilaritySummary
16
+ * @endpoint GET /v1/entities/{entityId}/similar/summary
17
+ * @usedBySchema PageEntitySimilaritySummarySchema
18
+ * @contractShape entity.similarity-summary
19
+ * @contractRole canonical
20
+ */
21
+ export const EntitySimilaritySummarySchema = EntitySimilaritySummarySchemaDefinition;
22
+ //# sourceMappingURL=similarity-summary.js.map
@@ -18,6 +18,7 @@ import { z } from "zod/v4";
18
18
  * @endpoint GET /v1/entities/{entityId}/relationships
19
19
  * @endpoint GET /v1/entities/{entityId}/research
20
20
  * @endpoint GET /v1/entities/{entityId}/similar
21
+ * @endpoint GET /v1/entities/{entityId}/similar/summary
21
22
  * @endpoint GET /v1/entities/relationships/{relationshipId}
22
23
  * @endpoint GET /v1/harness/runs/{runId}
23
24
  * @endpoint GET /v1/news/{newsId}/related-entities
@@ -19,6 +19,7 @@ import { z } from "zod/v4";
19
19
  * @endpoint GET /v1/entities/{entityId}/relationships
20
20
  * @endpoint GET /v1/entities/{entityId}/research
21
21
  * @endpoint GET /v1/entities/{entityId}/similar
22
+ * @endpoint GET /v1/entities/{entityId}/similar/summary
22
23
  * @endpoint GET /v1/entities/relationships/{relationshipId}
23
24
  * @endpoint GET /v1/harness/runs/{runId}
24
25
  * @endpoint GET /v1/news/{newsId}/related-entities
@@ -13,6 +13,7 @@ import { z } from "zod/v4";
13
13
  * @endpoint GET /v1/entities/{entityId}/people/{associationId}
14
14
  * @endpoint GET /v1/entities/{entityId}/person-investors
15
15
  * @endpoint GET /v1/entities/{entityId}/similar
16
+ * @endpoint GET /v1/entities/{entityId}/similar/summary
16
17
  * @endpoint GET /v1/entities/{entityId}/urls
17
18
  * @endpoint GET /v1/entities/{entityId}/urls/{urlId}
18
19
  * @endpoint GET /v1/people/{personId}
@@ -14,6 +14,7 @@ import { z } from "zod/v4";
14
14
  * @endpoint GET /v1/entities/{entityId}/people/{associationId}
15
15
  * @endpoint GET /v1/entities/{entityId}/person-investors
16
16
  * @endpoint GET /v1/entities/{entityId}/similar
17
+ * @endpoint GET /v1/entities/{entityId}/similar/summary
17
18
  * @endpoint GET /v1/entities/{entityId}/urls
18
19
  * @endpoint GET /v1/entities/{entityId}/urls/{urlId}
19
20
  * @endpoint GET /v1/people/{personId}
@@ -13,6 +13,7 @@ import { z } from "zod/v4";
13
13
  * @endpoint GET /v1/entities/{entityId}/people/{associationId}
14
14
  * @endpoint GET /v1/entities/{entityId}/person-investors
15
15
  * @endpoint GET /v1/entities/{entityId}/similar
16
+ * @endpoint GET /v1/entities/{entityId}/similar/summary
16
17
  * @endpoint GET /v1/entities/{entityId}/urls
17
18
  * @endpoint GET /v1/entities/{entityId}/urls/{urlId}
18
19
  * @endpoint GET /v1/people/{personId}
@@ -14,6 +14,7 @@ import { z } from "zod/v4";
14
14
  * @endpoint GET /v1/entities/{entityId}/people/{associationId}
15
15
  * @endpoint GET /v1/entities/{entityId}/person-investors
16
16
  * @endpoint GET /v1/entities/{entityId}/similar
17
+ * @endpoint GET /v1/entities/{entityId}/similar/summary
17
18
  * @endpoint GET /v1/entities/{entityId}/urls
18
19
  * @endpoint GET /v1/entities/{entityId}/urls/{urlId}
19
20
  * @endpoint GET /v1/people/{personId}
@@ -110,6 +110,7 @@ type EntityUrlLinkDefinition = z.infer<typeof EntityUrlLinkSchemaDefinition>;
110
110
  * @endpoint GET /v1/entities/{entityId}/people/{associationId}
111
111
  * @endpoint GET /v1/entities/{entityId}/person-investors
112
112
  * @endpoint GET /v1/entities/{entityId}/similar
113
+ * @endpoint GET /v1/entities/{entityId}/similar/summary
113
114
  * @endpoint GET /v1/entities/{entityId}/urls
114
115
  * @endpoint GET /v1/entities/{entityId}/urls/{urlId}
115
116
  * @endpoint GET /v1/people/{personId}
@@ -128,6 +129,7 @@ type EntityUrlLinkDefinition = z.infer<typeof EntityUrlLinkSchemaDefinition>;
128
129
  * @endpoint POST /v1/search/natural/entities
129
130
  * @usedBySchema EntityEnrichmentSchema
130
131
  * @usedBySchema EntityPersonAssociationSchema
132
+ * @usedBySchema EntitySimilaritySummarySchema
131
133
  * @usedBySchema PageEntityUrlLinkSchema
132
134
  * @usedBySchema PersonEnrichmentSchema
133
135
  * @contractShape entity.url-link
@@ -37,6 +37,7 @@ const EntityUrlLinkSchemaDefinition = z.object({
37
37
  * @endpoint GET /v1/entities/{entityId}/people/{associationId}
38
38
  * @endpoint GET /v1/entities/{entityId}/person-investors
39
39
  * @endpoint GET /v1/entities/{entityId}/similar
40
+ * @endpoint GET /v1/entities/{entityId}/similar/summary
40
41
  * @endpoint GET /v1/entities/{entityId}/urls
41
42
  * @endpoint GET /v1/entities/{entityId}/urls/{urlId}
42
43
  * @endpoint GET /v1/people/{personId}
@@ -55,6 +56,7 @@ const EntityUrlLinkSchemaDefinition = z.object({
55
56
  * @endpoint POST /v1/search/natural/entities
56
57
  * @usedBySchema EntityEnrichmentSchema
57
58
  * @usedBySchema EntityPersonAssociationSchema
59
+ * @usedBySchema EntitySimilaritySummarySchema
58
60
  * @usedBySchema PageEntityUrlLinkSchema
59
61
  * @usedBySchema PersonEnrichmentSchema
60
62
  * @contractShape entity.url-link
@@ -13,6 +13,7 @@ import { z } from "zod/v4";
13
13
  * @endpoint GET /v1/entities/{entityId}/people/{associationId}
14
14
  * @endpoint GET /v1/entities/{entityId}/person-investors
15
15
  * @endpoint GET /v1/entities/{entityId}/similar
16
+ * @endpoint GET /v1/entities/{entityId}/similar/summary
16
17
  * @endpoint GET /v1/entities/{entityId}/urls
17
18
  * @endpoint GET /v1/entities/{entityId}/urls/{urlId}
18
19
  * @endpoint GET /v1/people/{personId}
@@ -14,6 +14,7 @@ import { z } from "zod/v4";
14
14
  * @endpoint GET /v1/entities/{entityId}/people/{associationId}
15
15
  * @endpoint GET /v1/entities/{entityId}/person-investors
16
16
  * @endpoint GET /v1/entities/{entityId}/similar
17
+ * @endpoint GET /v1/entities/{entityId}/similar/summary
17
18
  * @endpoint GET /v1/entities/{entityId}/urls
18
19
  * @endpoint GET /v1/entities/{entityId}/urls/{urlId}
19
20
  * @endpoint GET /v1/people/{personId}
@@ -401,6 +401,10 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
401
401
  modulePath: "entity/similarity-result",
402
402
  schemaName: "EntitySimilarityResultSchema",
403
403
  },
404
+ EntitySimilaritySummary: {
405
+ modulePath: "entity/similarity-summary",
406
+ schemaName: "EntitySimilaritySummarySchema",
407
+ },
404
408
  EntitySitemap: { modulePath: "entity/sitemap", schemaName: "EntitySitemapSchema" },
405
409
  EntityTag: { modulePath: "entity/tag", schemaName: "EntityTagSchema" },
406
410
  EntityText: { modulePath: "entity/text", schemaName: "EntityTextSchema" },
@@ -585,6 +589,10 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
585
589
  modulePath: "pagination/schemas",
586
590
  schemaName: "PageEntitySimilarityResultSchema",
587
591
  },
592
+ PageEntitySimilaritySummary: {
593
+ modulePath: "pagination/schemas",
594
+ schemaName: "PageEntitySimilaritySummarySchema",
595
+ },
588
596
  PageEntityText: { modulePath: "pagination/schemas", schemaName: "PageEntityTextSchema" },
589
597
  PageEntityUrlLink: { modulePath: "pagination/schemas", schemaName: "PageEntityUrlLinkSchema" },
590
598
  PageEntityValuationTimeSeriesPoint: {
@@ -20,6 +20,7 @@ import { z } from "zod/v4";
20
20
  * @endpoint GET /v1/entities/{entityId}/research-details
21
21
  * @endpoint GET /v1/entities/{entityId}/research-snippets
22
22
  * @endpoint GET /v1/entities/{entityId}/similar
23
+ * @endpoint GET /v1/entities/{entityId}/similar/summary
23
24
  * @endpoint GET /v1/entities/{entityId}/texts
24
25
  * @endpoint GET /v1/entities/{entityId}/trending-news
25
26
  * @endpoint GET /v1/entities/{entityId}/unique-ids
@@ -56,6 +57,7 @@ import { z } from "zod/v4";
56
57
  * @usedBySchema PageEntityResearchSnippetSchema
57
58
  * @usedBySchema PageEntitySchema
58
59
  * @usedBySchema PageEntitySimilarityResultSchema
60
+ * @usedBySchema PageEntitySimilaritySummarySchema
59
61
  * @usedBySchema PageEntityTextSchema
60
62
  * @usedBySchema PageEntityUrlLinkSchema
61
63
  * @usedBySchema PageEntityValuationTimeSeriesPointSchema
@@ -22,6 +22,7 @@ import { SortObjectSchema } from "../sort/object.js";
22
22
  * @endpoint GET /v1/entities/{entityId}/research-details
23
23
  * @endpoint GET /v1/entities/{entityId}/research-snippets
24
24
  * @endpoint GET /v1/entities/{entityId}/similar
25
+ * @endpoint GET /v1/entities/{entityId}/similar/summary
25
26
  * @endpoint GET /v1/entities/{entityId}/texts
26
27
  * @endpoint GET /v1/entities/{entityId}/trending-news
27
28
  * @endpoint GET /v1/entities/{entityId}/unique-ids
@@ -58,6 +59,7 @@ import { SortObjectSchema } from "../sort/object.js";
58
59
  * @usedBySchema PageEntityResearchSnippetSchema
59
60
  * @usedBySchema PageEntitySchema
60
61
  * @usedBySchema PageEntitySimilarityResultSchema
62
+ * @usedBySchema PageEntitySimilaritySummarySchema
61
63
  * @usedBySchema PageEntityTextSchema
62
64
  * @usedBySchema PageEntityUrlLinkSchema
63
65
  * @usedBySchema PageEntityValuationTimeSeriesPointSchema
@@ -6946,6 +6946,170 @@ type PageEntitySimilarityResultDefinition = z.infer<typeof PageEntitySimilarityR
6946
6946
  */
6947
6947
  export declare const PageEntitySimilarityResultSchema: z.ZodType<PageEntitySimilarityResultDefinition>;
6948
6948
  export type PageEntitySimilarityResult = z.infer<typeof PageEntitySimilarityResultSchema>;
6949
+ declare const PageEntitySimilaritySummarySchemaDefinition: z.ZodObject<{
6950
+ content: z.ZodOptional<z.ZodArray<z.ZodType<{
6951
+ core: {
6952
+ defaultCurrency?: string | null | undefined;
6953
+ foundedYear?: number | null | undefined;
6954
+ id: string;
6955
+ image: {
6956
+ isMonogram: boolean;
6957
+ logo?: string | null | undefined;
6958
+ logoSquare?: string | null | undefined;
6959
+ };
6960
+ lastModifiedAt?: string | null | undefined;
6961
+ nameAlias: {
6962
+ displayable?: boolean | null | undefined;
6963
+ name: string;
6964
+ type?: "alternativeDba" | "relatedLegal" | null | undefined;
6965
+ }[];
6966
+ nameBrand: string;
6967
+ nameLegal?: string | null | undefined;
6968
+ operatingStatus?: string | null | undefined;
6969
+ publicId?: string | null | undefined;
6970
+ publicUrl?: string | null | undefined;
6971
+ sitemap?: {
6972
+ hasAcquisitions?: boolean | undefined;
6973
+ hasAnalysis: boolean;
6974
+ hasEmployees: boolean;
6975
+ hasFundraising: boolean;
6976
+ hasNews: boolean;
6977
+ productServiceSlug: string[];
6978
+ } | null | undefined;
6979
+ slug: string;
6980
+ typeRecord?: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service" | null | undefined;
6981
+ updatedAt?: string | null | undefined;
6982
+ };
6983
+ similarity: {
6984
+ compositeScore?: number | null | undefined;
6985
+ cosineScore?: number | null | undefined;
6986
+ curatedAsOf?: string | null | undefined;
6987
+ curatedRelationshipType?: string | null | undefined;
6988
+ curatedSource?: string | null | undefined;
6989
+ derivedFromEntityId?: string | null | undefined;
6990
+ matchedSectionWeight?: number | null | undefined;
6991
+ origin: "computed" | "curated" | "derived" | "precomputed" | "semantic";
6992
+ rank: number;
6993
+ sharedSectionCount?: number | null | undefined;
6994
+ };
6995
+ urlLink: {
6996
+ crawlCdnProvider?: "akamai" | "awsCloudfront" | "azureCdn" | "bunny" | "cdn77" | "cdnetworks" | "cloudflare" | "digitalocean" | "fastly" | "gcore" | "googlecloudCdn" | "incapsula" | "keycdn" | "leaseweb" | "netlify" | "none" | "stackpath" | "sucuri" | "unknown" | "vercel" | null | undefined;
6997
+ crawlRenderMode?: "jsEnhanced" | "jsRequired" | "static" | null | undefined;
6998
+ createdAt?: string | null | undefined;
6999
+ id?: number | null | undefined;
7000
+ isCurrent?: boolean | null | undefined;
7001
+ isPrimary?: boolean | null | undefined;
7002
+ owner?: {
7003
+ entityId?: string | null | undefined;
7004
+ personId?: string | null | undefined;
7005
+ } | null | undefined;
7006
+ sourceId?: string | null | undefined;
7007
+ status?: string | null | undefined;
7008
+ statusChecked?: string | null | undefined;
7009
+ updatedAt?: string | null | undefined;
7010
+ url: string;
7011
+ urlType: "alternativeto" | "angellist" | "appstore" | "awsmarketplace" | "bloomberg" | "capterra" | "changelog" | "chromewebstore" | "crates" | "crunchbase" | "discord" | "dockerhub" | "documentation" | "facebook" | "forum" | "g2" | "gartnerpeerinsights" | "getapp" | "github" | "glassdoor" | "googleplay" | "homebrew" | "hubspotmarketplace" | "huggingface" | "instagram" | "linkedin" | "maven" | "morningstar" | "nasdaq" | "npm" | "nyse" | "pitchbook" | "producthunt" | "pypi" | "roadmap" | "salesforceappexchange" | "slackappdirectory" | "sourceforge" | "statuspage" | "subreddit" | "support" | "theorg" | "tiktok" | "trustpilot" | "trustradius" | "twitter" | "vscodemarketplace" | "website" | "wellfound" | "wikipedia" | "ycombinator" | "youtube";
7012
+ }[];
7013
+ }, unknown, z.core.$ZodTypeInternals<{
7014
+ core: {
7015
+ defaultCurrency?: string | null | undefined;
7016
+ foundedYear?: number | null | undefined;
7017
+ id: string;
7018
+ image: {
7019
+ isMonogram: boolean;
7020
+ logo?: string | null | undefined;
7021
+ logoSquare?: string | null | undefined;
7022
+ };
7023
+ lastModifiedAt?: string | null | undefined;
7024
+ nameAlias: {
7025
+ displayable?: boolean | null | undefined;
7026
+ name: string;
7027
+ type?: "alternativeDba" | "relatedLegal" | null | undefined;
7028
+ }[];
7029
+ nameBrand: string;
7030
+ nameLegal?: string | null | undefined;
7031
+ operatingStatus?: string | null | undefined;
7032
+ publicId?: string | null | undefined;
7033
+ publicUrl?: string | null | undefined;
7034
+ sitemap?: {
7035
+ hasAcquisitions?: boolean | undefined;
7036
+ hasAnalysis: boolean;
7037
+ hasEmployees: boolean;
7038
+ hasFundraising: boolean;
7039
+ hasNews: boolean;
7040
+ productServiceSlug: string[];
7041
+ } | null | undefined;
7042
+ slug: string;
7043
+ typeRecord?: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service" | null | undefined;
7044
+ updatedAt?: string | null | undefined;
7045
+ };
7046
+ similarity: {
7047
+ compositeScore?: number | null | undefined;
7048
+ cosineScore?: number | null | undefined;
7049
+ curatedAsOf?: string | null | undefined;
7050
+ curatedRelationshipType?: string | null | undefined;
7051
+ curatedSource?: string | null | undefined;
7052
+ derivedFromEntityId?: string | null | undefined;
7053
+ matchedSectionWeight?: number | null | undefined;
7054
+ origin: "computed" | "curated" | "derived" | "precomputed" | "semantic";
7055
+ rank: number;
7056
+ sharedSectionCount?: number | null | undefined;
7057
+ };
7058
+ urlLink: {
7059
+ crawlCdnProvider?: "akamai" | "awsCloudfront" | "azureCdn" | "bunny" | "cdn77" | "cdnetworks" | "cloudflare" | "digitalocean" | "fastly" | "gcore" | "googlecloudCdn" | "incapsula" | "keycdn" | "leaseweb" | "netlify" | "none" | "stackpath" | "sucuri" | "unknown" | "vercel" | null | undefined;
7060
+ crawlRenderMode?: "jsEnhanced" | "jsRequired" | "static" | null | undefined;
7061
+ createdAt?: string | null | undefined;
7062
+ id?: number | null | undefined;
7063
+ isCurrent?: boolean | null | undefined;
7064
+ isPrimary?: boolean | null | undefined;
7065
+ owner?: {
7066
+ entityId?: string | null | undefined;
7067
+ personId?: string | null | undefined;
7068
+ } | null | undefined;
7069
+ sourceId?: string | null | undefined;
7070
+ status?: string | null | undefined;
7071
+ statusChecked?: string | null | undefined;
7072
+ updatedAt?: string | null | undefined;
7073
+ url: string;
7074
+ urlType: "alternativeto" | "angellist" | "appstore" | "awsmarketplace" | "bloomberg" | "capterra" | "changelog" | "chromewebstore" | "crates" | "crunchbase" | "discord" | "dockerhub" | "documentation" | "facebook" | "forum" | "g2" | "gartnerpeerinsights" | "getapp" | "github" | "glassdoor" | "googleplay" | "homebrew" | "hubspotmarketplace" | "huggingface" | "instagram" | "linkedin" | "maven" | "morningstar" | "nasdaq" | "npm" | "nyse" | "pitchbook" | "producthunt" | "pypi" | "roadmap" | "salesforceappexchange" | "slackappdirectory" | "sourceforge" | "statuspage" | "subreddit" | "support" | "theorg" | "tiktok" | "trustpilot" | "trustradius" | "twitter" | "vscodemarketplace" | "website" | "wellfound" | "wikipedia" | "ycombinator" | "youtube";
7075
+ }[];
7076
+ }, unknown>>>>;
7077
+ empty: z.ZodOptional<z.ZodBoolean>;
7078
+ first: z.ZodOptional<z.ZodBoolean>;
7079
+ last: z.ZodOptional<z.ZodBoolean>;
7080
+ number: z.ZodOptional<z.ZodInt>;
7081
+ numberOfElements: z.ZodOptional<z.ZodInt>;
7082
+ pageable: z.ZodOptional<z.ZodObject<{
7083
+ offset: z.ZodOptional<z.ZodNumber>;
7084
+ paged: z.ZodOptional<z.ZodBoolean>;
7085
+ pageNumber: z.ZodOptional<z.ZodInt>;
7086
+ pageSize: z.ZodOptional<z.ZodInt>;
7087
+ sort: z.ZodOptional<z.ZodObject<{
7088
+ empty: z.ZodOptional<z.ZodBoolean>;
7089
+ sorted: z.ZodOptional<z.ZodBoolean>;
7090
+ unsorted: z.ZodOptional<z.ZodBoolean>;
7091
+ }, z.core.$strip>>;
7092
+ unpaged: z.ZodOptional<z.ZodBoolean>;
7093
+ }, z.core.$strip>>;
7094
+ size: z.ZodOptional<z.ZodInt>;
7095
+ sort: z.ZodOptional<z.ZodObject<{
7096
+ empty: z.ZodOptional<z.ZodBoolean>;
7097
+ sorted: z.ZodOptional<z.ZodBoolean>;
7098
+ unsorted: z.ZodOptional<z.ZodBoolean>;
7099
+ }, z.core.$strip>>;
7100
+ totalElements: z.ZodOptional<z.ZodNumber>;
7101
+ totalPages: z.ZodOptional<z.ZodInt>;
7102
+ }, z.core.$strip>;
7103
+ type PageEntitySimilaritySummaryDefinition = z.infer<typeof PageEntitySimilaritySummarySchemaDefinition>;
7104
+ /**
7105
+ * @openapiSchema PageEntitySimilaritySummary
7106
+ * @endpoint GET /v1/entities/{entityId}/similar/summary
7107
+ * @contractShape pagination.page-entity-similarity-summary
7108
+ * @contractRole canonical
7109
+ * @ownerModule pagination/schemas.ts
7110
+ */
7111
+ export declare const PageEntitySimilaritySummarySchema: z.ZodType<PageEntitySimilaritySummaryDefinition>;
7112
+ export type PageEntitySimilaritySummary = z.infer<typeof PageEntitySimilaritySummarySchema>;
6949
7113
  declare const PageEntityTextSchemaDefinition: z.ZodObject<{
6950
7114
  content: z.ZodOptional<z.ZodArray<z.ZodType<{
6951
7115
  compliance?: {
@@ -14,6 +14,7 @@ import { EntityRelationshipSchema } from "../entity/relationship.js";
14
14
  import { EntityResearchDetailSchema } from "../entity/research-detail.js";
15
15
  import { EntityResearchSnippetSchema } from "../entity/research-snippet.js";
16
16
  import { EntitySimilarityResultSchema } from "../entity/similarity-result.js";
17
+ import { EntitySimilaritySummarySchema } from "../entity/similarity-summary.js";
17
18
  import { EntityTagSchema } from "../entity/tag.js";
18
19
  import { EntityTextSchema } from "../entity/text.js";
19
20
  import { EntityUrlLinkSchema } from "../entity/url-link.js";
@@ -350,6 +351,27 @@ const PageEntitySimilarityResultSchemaDefinition = z.object({
350
351
  * @ownerModule pagination/schemas.ts
351
352
  */
352
353
  export const PageEntitySimilarityResultSchema = PageEntitySimilarityResultSchemaDefinition;
354
+ const PageEntitySimilaritySummarySchemaDefinition = z.object({
355
+ content: z.array(EntitySimilaritySummarySchema).optional(),
356
+ empty: z.boolean().optional(),
357
+ first: z.boolean().optional(),
358
+ last: z.boolean().optional(),
359
+ number: z.int().optional(),
360
+ numberOfElements: z.int().optional(),
361
+ pageable: PageableObjectSchema.optional(),
362
+ size: z.int().optional(),
363
+ sort: SortObjectSchema.optional(),
364
+ totalElements: z.number().int().optional(),
365
+ totalPages: z.int().optional(),
366
+ });
367
+ /**
368
+ * @openapiSchema PageEntitySimilaritySummary
369
+ * @endpoint GET /v1/entities/{entityId}/similar/summary
370
+ * @contractShape pagination.page-entity-similarity-summary
371
+ * @contractRole canonical
372
+ * @ownerModule pagination/schemas.ts
373
+ */
374
+ export const PageEntitySimilaritySummarySchema = PageEntitySimilaritySummarySchemaDefinition;
353
375
  const PageEntityTextSchemaDefinition = z.object({
354
376
  content: z.array(EntityTextSchema).optional(),
355
377
  empty: z.boolean().optional(),
@@ -49,6 +49,7 @@ export declare const ProblemTypeSchema: z.ZodEnum<{
49
49
  readonly SLUG_HELD_BY_RECORD: "https://api.aventure.vc/errors/slug-held-by-record";
50
50
  readonly SLUG_HELD_BY_REDIRECT: "https://api.aventure.vc/errors/slug-held-by-redirect";
51
51
  readonly SLUG_AMBIGUOUS: "https://api.aventure.vc/errors/slug-ambiguous";
52
+ readonly TARGET_AMBIGUOUS: "https://api.aventure.vc/errors/target-ambiguous";
52
53
  readonly DUPLICATE: "https://api.aventure.vc/errors/duplicate";
53
54
  readonly DUPLICATE_KEY: "https://api.aventure.vc/errors/duplicate-key";
54
55
  readonly INTEGRITY_VIOLATION: "https://api.aventure.vc/errors/integrity-violation";
@@ -50,6 +50,7 @@ export const ProblemTypeSchema = z.enum({
50
50
  SLUG_HELD_BY_RECORD: "https://api.aventure.vc/errors/slug-held-by-record",
51
51
  SLUG_HELD_BY_REDIRECT: "https://api.aventure.vc/errors/slug-held-by-redirect",
52
52
  SLUG_AMBIGUOUS: "https://api.aventure.vc/errors/slug-ambiguous",
53
+ TARGET_AMBIGUOUS: "https://api.aventure.vc/errors/target-ambiguous",
53
54
  DUPLICATE: "https://api.aventure.vc/errors/duplicate",
54
55
  DUPLICATE_KEY: "https://api.aventure.vc/errors/duplicate-key",
55
56
  INTEGRITY_VIOLATION: "https://api.aventure.vc/errors/integrity-violation",
@@ -1,59 +1,104 @@
1
1
  import { z } from "zod/v4";
2
2
  declare const ResearchAllowanceUsageSchemaDefinition: z.ZodObject<{
3
- company: z.ZodObject<{
4
- limit: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
5
- remaining: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
6
- resetAt: z.ZodISODateTime;
7
- used: z.ZodInt;
8
- }, z.core.$strip>;
9
- entityView: z.ZodObject<{
10
- limit: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
11
- remaining: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
12
- resetAt: z.ZodISODateTime;
13
- used: z.ZodInt;
14
- }, z.core.$strip>;
15
- newCompany: z.ZodOptional<z.ZodObject<{
16
- limit: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
17
- remaining: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
18
- resetAt: z.ZodISODateTime;
19
- used: z.ZodInt;
20
- }, z.core.$strip>>;
21
- newPerson: z.ZodOptional<z.ZodObject<{
22
- limit: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
23
- remaining: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
24
- resetAt: z.ZodISODateTime;
25
- used: z.ZodInt;
26
- }, z.core.$strip>>;
27
- person: z.ZodObject<{
28
- limit: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
29
- remaining: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
30
- resetAt: z.ZodISODateTime;
31
- used: z.ZodInt;
32
- }, z.core.$strip>;
33
- personView: z.ZodObject<{
34
- limit: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
35
- remaining: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
36
- resetAt: z.ZodISODateTime;
37
- used: z.ZodInt;
38
- }, z.core.$strip>;
39
- update: z.ZodOptional<z.ZodObject<{
40
- limit: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
41
- remaining: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
42
- resetAt: z.ZodISODateTime;
43
- used: z.ZodInt;
44
- }, z.core.$strip>>;
45
- updatePerson: z.ZodOptional<z.ZodObject<{
46
- limit: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
47
- remaining: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
48
- resetAt: z.ZodISODateTime;
49
- used: z.ZodInt;
50
- }, z.core.$strip>>;
51
- webSearch: z.ZodObject<{
52
- limit: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
53
- remaining: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
54
- resetAt: z.ZodISODateTime;
55
- used: z.ZodInt;
56
- }, z.core.$strip>;
3
+ company: z.ZodType<{
4
+ limit?: number | null | undefined;
5
+ remaining?: number | null | undefined;
6
+ resetAt: string;
7
+ used: number;
8
+ }, unknown, z.core.$ZodTypeInternals<{
9
+ limit?: number | null | undefined;
10
+ remaining?: number | null | undefined;
11
+ resetAt: string;
12
+ used: number;
13
+ }, unknown>>;
14
+ entityView: z.ZodType<{
15
+ limit?: number | null | undefined;
16
+ remaining?: number | null | undefined;
17
+ resetAt: string;
18
+ used: number;
19
+ }, unknown, z.core.$ZodTypeInternals<{
20
+ limit?: number | null | undefined;
21
+ remaining?: number | null | undefined;
22
+ resetAt: string;
23
+ used: number;
24
+ }, unknown>>;
25
+ newCompany: z.ZodType<{
26
+ limit?: number | null | undefined;
27
+ remaining?: number | null | undefined;
28
+ resetAt: string;
29
+ used: number;
30
+ }, unknown, z.core.$ZodTypeInternals<{
31
+ limit?: number | null | undefined;
32
+ remaining?: number | null | undefined;
33
+ resetAt: string;
34
+ used: number;
35
+ }, unknown>>;
36
+ newPerson: z.ZodType<{
37
+ limit?: number | null | undefined;
38
+ remaining?: number | null | undefined;
39
+ resetAt: string;
40
+ used: number;
41
+ }, unknown, z.core.$ZodTypeInternals<{
42
+ limit?: number | null | undefined;
43
+ remaining?: number | null | undefined;
44
+ resetAt: string;
45
+ used: number;
46
+ }, unknown>>;
47
+ person: z.ZodType<{
48
+ limit?: number | null | undefined;
49
+ remaining?: number | null | undefined;
50
+ resetAt: string;
51
+ used: number;
52
+ }, unknown, z.core.$ZodTypeInternals<{
53
+ limit?: number | null | undefined;
54
+ remaining?: number | null | undefined;
55
+ resetAt: string;
56
+ used: number;
57
+ }, unknown>>;
58
+ personView: z.ZodType<{
59
+ limit?: number | null | undefined;
60
+ remaining?: number | null | undefined;
61
+ resetAt: string;
62
+ used: number;
63
+ }, unknown, z.core.$ZodTypeInternals<{
64
+ limit?: number | null | undefined;
65
+ remaining?: number | null | undefined;
66
+ resetAt: string;
67
+ used: number;
68
+ }, unknown>>;
69
+ update: z.ZodType<{
70
+ limit?: number | null | undefined;
71
+ remaining?: number | null | undefined;
72
+ resetAt: string;
73
+ used: number;
74
+ }, unknown, z.core.$ZodTypeInternals<{
75
+ limit?: number | null | undefined;
76
+ remaining?: number | null | undefined;
77
+ resetAt: string;
78
+ used: number;
79
+ }, unknown>>;
80
+ updatePerson: z.ZodType<{
81
+ limit?: number | null | undefined;
82
+ remaining?: number | null | undefined;
83
+ resetAt: string;
84
+ used: number;
85
+ }, unknown, z.core.$ZodTypeInternals<{
86
+ limit?: number | null | undefined;
87
+ remaining?: number | null | undefined;
88
+ resetAt: string;
89
+ used: number;
90
+ }, unknown>>;
91
+ webSearch: z.ZodType<{
92
+ limit?: number | null | undefined;
93
+ remaining?: number | null | undefined;
94
+ resetAt: string;
95
+ used: number;
96
+ }, unknown, z.core.$ZodTypeInternals<{
97
+ limit?: number | null | undefined;
98
+ remaining?: number | null | undefined;
99
+ resetAt: string;
100
+ used: number;
101
+ }, unknown>>;
57
102
  }, z.core.$strip>;
58
103
  type ResearchAllowanceUsageDefinition = z.infer<typeof ResearchAllowanceUsageSchemaDefinition>;
59
104
  /**
@@ -6,16 +6,16 @@ const ResearchAllowanceUsageSchemaDefinition = z.object({
6
6
  company: ResearchAllowanceSchema,
7
7
  entityView: ResearchAllowanceSchema,
8
8
  /** Deprecated: replaced by company, which it mirrors. */
9
- newCompany: ResearchAllowanceSchema.optional(),
9
+ newCompany: ResearchAllowanceSchema,
10
10
  /** Deprecated: replaced by person, which it mirrors. */
11
- newPerson: ResearchAllowanceSchema.optional(),
11
+ newPerson: ResearchAllowanceSchema,
12
12
  /** Research runs on person-profile targets, new or existing */
13
13
  person: ResearchAllowanceSchema,
14
14
  personView: ResearchAllowanceSchema,
15
15
  /** Deprecated: replaced by company, which it mirrors. */
16
- update: ResearchAllowanceSchema.optional(),
16
+ update: ResearchAllowanceSchema,
17
17
  /** Deprecated: replaced by person, which it mirrors. */
18
- updatePerson: ResearchAllowanceSchema.optional(),
18
+ updatePerson: ResearchAllowanceSchema,
19
19
  webSearch: ResearchAllowanceSchema,
20
20
  });
21
21
  /**
@@ -1,4 +1,11 @@
1
1
  import { z } from "zod/v4";
2
+ declare const ResearchAllowanceSchemaDefinition: z.ZodObject<{
3
+ limit: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
4
+ remaining: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
5
+ resetAt: z.ZodISODateTime;
6
+ used: z.ZodInt;
7
+ }, z.core.$strip>;
8
+ type ResearchAllowanceDefinition = z.infer<typeof ResearchAllowanceSchemaDefinition>;
2
9
  /**
3
10
  * @openapiSchema ResearchAllowance
4
11
  * @endpoint GET /v1/billing/ai-credits
@@ -7,11 +14,7 @@ import { z } from "zod/v4";
7
14
  * @contractShape research.allowance
8
15
  * @contractRole canonical
9
16
  */
10
- export declare const ResearchAllowanceSchema: z.ZodObject<{
11
- limit: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
12
- remaining: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
13
- resetAt: z.ZodISODateTime;
14
- used: z.ZodInt;
15
- }, z.core.$strip>;
17
+ export declare const ResearchAllowanceSchema: z.ZodType<ResearchAllowanceDefinition>;
16
18
  export type ResearchAllowance = z.infer<typeof ResearchAllowanceSchema>;
19
+ export {};
17
20
  //# sourceMappingURL=allowance.d.ts.map
@@ -1,14 +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
- /**
4
- * @openapiSchema ResearchAllowance
5
- * @endpoint GET /v1/billing/ai-credits
6
- * @endpoint GET /v1/billing/subscription
7
- * @usedBySchema ResearchAllowanceUsageSchema
8
- * @contractShape research.allowance
9
- * @contractRole canonical
10
- */
11
- export const ResearchAllowanceSchema = z.object({
3
+ const ResearchAllowanceSchemaDefinition = z.object({
12
4
  /** Cap for the period; absent when the tier meters without a cap */
13
5
  limit: z.int().nullish(),
14
6
  /** Cap minus used, never negative; absent when there is no cap */
@@ -18,4 +10,13 @@ export const ResearchAllowanceSchema = z.object({
18
10
  /** Amount used so far in the period */
19
11
  used: z.int(),
20
12
  });
13
+ /**
14
+ * @openapiSchema ResearchAllowance
15
+ * @endpoint GET /v1/billing/ai-credits
16
+ * @endpoint GET /v1/billing/subscription
17
+ * @usedBySchema ResearchAllowanceUsageSchema
18
+ * @contractShape research.allowance
19
+ * @contractRole canonical
20
+ */
21
+ export const ResearchAllowanceSchema = ResearchAllowanceSchemaDefinition;
21
22
  //# sourceMappingURL=allowance.js.map
@@ -20,6 +20,7 @@ import { z } from "zod/v4";
20
20
  * @endpoint GET /v1/entities/{entityId}/research-details
21
21
  * @endpoint GET /v1/entities/{entityId}/research-snippets
22
22
  * @endpoint GET /v1/entities/{entityId}/similar
23
+ * @endpoint GET /v1/entities/{entityId}/similar/summary
23
24
  * @endpoint GET /v1/entities/{entityId}/texts
24
25
  * @endpoint GET /v1/entities/{entityId}/trending-news
25
26
  * @endpoint GET /v1/entities/{entityId}/unique-ids
@@ -57,6 +58,7 @@ import { z } from "zod/v4";
57
58
  * @usedBySchema PageEntityResearchSnippetSchema
58
59
  * @usedBySchema PageEntitySchema
59
60
  * @usedBySchema PageEntitySimilarityResultSchema
61
+ * @usedBySchema PageEntitySimilaritySummarySchema
60
62
  * @usedBySchema PageEntityTextSchema
61
63
  * @usedBySchema PageEntityUrlLinkSchema
62
64
  * @usedBySchema PageEntityValuationTimeSeriesPointSchema
@@ -21,6 +21,7 @@ import { z } from "zod/v4";
21
21
  * @endpoint GET /v1/entities/{entityId}/research-details
22
22
  * @endpoint GET /v1/entities/{entityId}/research-snippets
23
23
  * @endpoint GET /v1/entities/{entityId}/similar
24
+ * @endpoint GET /v1/entities/{entityId}/similar/summary
24
25
  * @endpoint GET /v1/entities/{entityId}/texts
25
26
  * @endpoint GET /v1/entities/{entityId}/trending-news
26
27
  * @endpoint GET /v1/entities/{entityId}/unique-ids
@@ -58,6 +59,7 @@ import { z } from "zod/v4";
58
59
  * @usedBySchema PageEntityResearchSnippetSchema
59
60
  * @usedBySchema PageEntitySchema
60
61
  * @usedBySchema PageEntitySimilarityResultSchema
62
+ * @usedBySchema PageEntitySimilaritySummarySchema
61
63
  * @usedBySchema PageEntityTextSchema
62
64
  * @usedBySchema PageEntityUrlLinkSchema
63
65
  * @usedBySchema PageEntityValuationTimeSeriesPointSchema
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aventurevc/api-schemas",
3
- "version": "0.8.5",
3
+ "version": "0.8.6",
4
4
  "private": false,
5
5
  "description": "Zod v4 schemas for the public aVenture API.",
6
6
  "license": "Apache-2.0",