@aventurevc/api-schemas 0.8.3 → 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 (95) hide show
  1. package/dist/billing/additional-usage-meter.d.ts +2 -4
  2. package/dist/billing/additional-usage-type.d.ts +2 -4
  3. package/dist/billing/additional-usage-type.js +2 -4
  4. package/dist/billing/additional-usage.d.ts +2 -2
  5. package/dist/billing/catalog-additional-usage.d.ts +2 -4
  6. package/dist/billing/catalog-allowance.d.ts +2 -4
  7. package/dist/billing/catalog-allowance.js +1 -9
  8. package/dist/billing/catalog-plan.d.ts +1 -0
  9. package/dist/billing/catalog-plan.js +2 -0
  10. package/dist/billing/catalog-tier.d.ts +2 -2
  11. package/dist/billing/catalog.d.ts +6 -4
  12. package/dist/billing/recurring-price.d.ts +15 -0
  13. package/dist/billing/recurring-price.js +18 -0
  14. package/dist/billing/subscription.d.ts +31 -2
  15. package/dist/billing/subscription.js +3 -0
  16. package/dist/enrichment/batch.d.ts +25 -0
  17. package/dist/enrichment/batch.js +27 -0
  18. package/dist/enrichment/enrichment.d.ts +84 -0
  19. package/dist/enrichment/enrichment.js +23 -0
  20. package/dist/enrichment/mode.d.ts +3 -0
  21. package/dist/enrichment/mode.js +3 -0
  22. package/dist/enrichment/refusal-type.d.ts +18 -0
  23. package/dist/enrichment/refusal-type.js +18 -0
  24. package/dist/entity/alias-type.d.ts +2 -0
  25. package/dist/entity/alias-type.js +2 -0
  26. package/dist/entity/entity.d.ts +4 -0
  27. package/dist/entity/entity.js +4 -0
  28. package/dist/entity/image.d.ts +2 -0
  29. package/dist/entity/image.js +2 -0
  30. package/dist/entity/name-alias-entity-alias-type.d.ts +2 -0
  31. package/dist/entity/name-alias-entity-alias-type.js +2 -0
  32. package/dist/entity/person-owner.d.ts +2 -0
  33. package/dist/entity/person-owner.js +2 -0
  34. package/dist/entity/similarity-context.d.ts +2 -0
  35. package/dist/entity/similarity-context.js +2 -0
  36. package/dist/entity/similarity-origin.d.ts +1 -0
  37. package/dist/entity/similarity-origin.js +1 -0
  38. package/dist/entity/similarity-summary.d.ts +125 -0
  39. package/dist/entity/similarity-summary.js +22 -0
  40. package/dist/entity/sitemap.d.ts +2 -0
  41. package/dist/entity/sitemap.js +2 -0
  42. package/dist/entity/url-crawl-cdn-provider.d.ts +1 -0
  43. package/dist/entity/url-crawl-cdn-provider.js +1 -0
  44. package/dist/entity/url-crawl-render-mode.d.ts +1 -0
  45. package/dist/entity/url-crawl-render-mode.js +1 -0
  46. package/dist/entity/url-link.d.ts +2 -0
  47. package/dist/entity/url-link.js +2 -0
  48. package/dist/entity/url-type.d.ts +1 -0
  49. package/dist/entity/url-type.js +1 -0
  50. package/dist/harness/chassis.d.ts +2 -0
  51. package/dist/harness/chassis.js +2 -0
  52. package/dist/harness/llm-api.d.ts +2 -0
  53. package/dist/harness/llm-api.js +2 -0
  54. package/dist/harness/run-detail.d.ts +183 -0
  55. package/dist/harness/run-detail.js +27 -0
  56. package/dist/harness/run-environment.d.ts +2 -0
  57. package/dist/harness/run-environment.js +2 -0
  58. package/dist/harness/run-lane.d.ts +2 -0
  59. package/dist/harness/run-lane.js +2 -0
  60. package/dist/harness/run-progress.d.ts +20 -0
  61. package/dist/harness/run-progress.js +30 -0
  62. package/dist/harness/run-status.d.ts +2 -0
  63. package/dist/harness/run-status.js +2 -0
  64. package/dist/harness/run-type.d.ts +2 -0
  65. package/dist/harness/run-type.js +2 -0
  66. package/dist/harness/run.d.ts +14 -13
  67. package/dist/harness/run.js +14 -11
  68. package/dist/http/problem-detail.d.ts +2 -4
  69. package/dist/http/problem-detail.js +1 -9
  70. package/dist/identification/candidate.d.ts +3 -0
  71. package/dist/identification/candidate.js +5 -0
  72. package/dist/identification/identification.d.ts +19 -14
  73. package/dist/identification/identification.js +13 -12
  74. package/dist/job/enqueue.d.ts +19 -0
  75. package/dist/job/enqueue.js +18 -0
  76. package/dist/job/state.d.ts +20 -0
  77. package/dist/job/state.js +20 -0
  78. package/dist/lookup/job-mention.d.ts +152 -0
  79. package/dist/lookup/job-mention.js +29 -0
  80. package/dist/lookup/job-mutation.d.ts +20 -0
  81. package/dist/lookup/job-mutation.js +20 -0
  82. package/dist/lookup/job.d.ts +202 -0
  83. package/dist/lookup/job.js +31 -0
  84. package/dist/openapi-component-manifest.js +28 -0
  85. package/dist/pageable/object.d.ts +2 -0
  86. package/dist/pageable/object.js +2 -0
  87. package/dist/pagination/schemas.d.ts +164 -0
  88. package/dist/pagination/schemas.js +22 -0
  89. package/dist/problem/type.d.ts +1 -0
  90. package/dist/problem/type.js +1 -0
  91. package/dist/research/allowance-usage.d.ts +22 -0
  92. package/dist/research/allowance-usage.js +8 -0
  93. package/dist/sort/object.d.ts +2 -0
  94. package/dist/sort/object.js +2 -0
  95. package/package.json +1 -1
@@ -0,0 +1,20 @@
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
+ const LookupJobMutationSchemaDefinition = z.object({
4
+ /** aVenture news id of the article; an unknown id fails the job. */
5
+ sourceNewsId: z.int().nullish(),
6
+ /** URL of the article; read from aVenture news when stored there, otherwise fetched. */
7
+ sourceUrl: z.string().max(2000).nullish(),
8
+ });
9
+ /**
10
+ * The article whose companies and people a lookup job identifies. Send sourceUrl, sourceNewsId, or both.
11
+ *
12
+ * @openapiSchema LookupJobMutation
13
+ * @endpoint GET /v1/lookup-jobs/{jobId}
14
+ * @endpoint POST /v1/lookup-jobs
15
+ * @usedBySchema LookupJobSchema
16
+ * @contractShape lookup.job-mutation
17
+ * @contractRole canonical
18
+ */
19
+ export const LookupJobMutationSchema = LookupJobMutationSchemaDefinition;
20
+ //# sourceMappingURL=job-mutation.js.map
@@ -0,0 +1,202 @@
1
+ import { z } from "zod/v4";
2
+ declare const LookupJobSchemaDefinition: z.ZodObject<{
3
+ createdAt: z.ZodISODateTime;
4
+ failureReason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
5
+ jobId: z.ZodUUID;
6
+ mention: z.ZodArray<z.ZodType<{
7
+ failureReason?: string | null | undefined;
8
+ identification?: {
9
+ candidate: {
10
+ dataCompletionCoverage?: number | null | undefined;
11
+ duplicateBasis?: "JUDGED" | "SHARED_FACT" | "STUB" | null | undefined;
12
+ duplicateProbability?: number | null | undefined;
13
+ owner: {
14
+ entityId?: string | null | undefined;
15
+ personId?: string | null | undefined;
16
+ };
17
+ probability?: number | null | undefined;
18
+ record: {
19
+ externalId?: string | null | undefined;
20
+ id: string;
21
+ name?: string | null | undefined;
22
+ operatingStatus?: string | null | undefined;
23
+ publicPath?: string | null | undefined;
24
+ reason: string[];
25
+ score: number;
26
+ slug?: string | null | undefined;
27
+ typeRecord?: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service" | null | undefined;
28
+ };
29
+ updatedAt?: string | null | undefined;
30
+ }[];
31
+ detail: string;
32
+ duplicate: {
33
+ dataCompletionCoverage?: number | null | undefined;
34
+ duplicateBasis?: "JUDGED" | "SHARED_FACT" | "STUB" | null | undefined;
35
+ duplicateProbability?: number | null | undefined;
36
+ owner: {
37
+ entityId?: string | null | undefined;
38
+ personId?: string | null | undefined;
39
+ };
40
+ probability?: number | null | undefined;
41
+ record: {
42
+ externalId?: string | null | undefined;
43
+ id: string;
44
+ name?: string | null | undefined;
45
+ operatingStatus?: string | null | undefined;
46
+ publicPath?: string | null | undefined;
47
+ reason: string[];
48
+ score: number;
49
+ slug?: string | null | undefined;
50
+ typeRecord?: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service" | null | undefined;
51
+ };
52
+ updatedAt?: string | null | undefined;
53
+ }[];
54
+ match?: {
55
+ dataCompletionCoverage?: number | null | undefined;
56
+ duplicateBasis?: "JUDGED" | "SHARED_FACT" | "STUB" | null | undefined;
57
+ duplicateProbability?: number | null | undefined;
58
+ owner: {
59
+ entityId?: string | null | undefined;
60
+ personId?: string | null | undefined;
61
+ };
62
+ probability?: number | null | undefined;
63
+ record: {
64
+ externalId?: string | null | undefined;
65
+ id: string;
66
+ name?: string | null | undefined;
67
+ operatingStatus?: string | null | undefined;
68
+ publicPath?: string | null | undefined;
69
+ reason: string[];
70
+ score: number;
71
+ slug?: string | null | undefined;
72
+ typeRecord?: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service" | null | undefined;
73
+ };
74
+ updatedAt?: string | null | undefined;
75
+ } | null | undefined;
76
+ matchConfidence?: number | null | undefined;
77
+ matchEvidenceProbability?: number | null | undefined;
78
+ officialUrl?: string | null | undefined;
79
+ stage: "DETERMINISTIC" | "JUDGMENT" | "WEB_EVIDENCE";
80
+ status: "MATCHED" | "NEEDS_REVIEW" | "NO_MATCH";
81
+ } | null | undefined;
82
+ mentionType: "COMPANY" | "PERSON";
83
+ name: string;
84
+ shell?: {
85
+ entityId?: string | null | undefined;
86
+ personId?: string | null | undefined;
87
+ } | null | undefined;
88
+ shellDetail?: string | null | undefined;
89
+ }, unknown, z.core.$ZodTypeInternals<{
90
+ failureReason?: string | null | undefined;
91
+ identification?: {
92
+ candidate: {
93
+ dataCompletionCoverage?: number | null | undefined;
94
+ duplicateBasis?: "JUDGED" | "SHARED_FACT" | "STUB" | null | undefined;
95
+ duplicateProbability?: number | null | undefined;
96
+ owner: {
97
+ entityId?: string | null | undefined;
98
+ personId?: string | null | undefined;
99
+ };
100
+ probability?: number | null | undefined;
101
+ record: {
102
+ externalId?: string | null | undefined;
103
+ id: string;
104
+ name?: string | null | undefined;
105
+ operatingStatus?: string | null | undefined;
106
+ publicPath?: string | null | undefined;
107
+ reason: string[];
108
+ score: number;
109
+ slug?: string | null | undefined;
110
+ typeRecord?: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service" | null | undefined;
111
+ };
112
+ updatedAt?: string | null | undefined;
113
+ }[];
114
+ detail: string;
115
+ duplicate: {
116
+ dataCompletionCoverage?: number | null | undefined;
117
+ duplicateBasis?: "JUDGED" | "SHARED_FACT" | "STUB" | null | undefined;
118
+ duplicateProbability?: number | null | undefined;
119
+ owner: {
120
+ entityId?: string | null | undefined;
121
+ personId?: string | null | undefined;
122
+ };
123
+ probability?: number | null | undefined;
124
+ record: {
125
+ externalId?: string | null | undefined;
126
+ id: string;
127
+ name?: string | null | undefined;
128
+ operatingStatus?: string | null | undefined;
129
+ publicPath?: string | null | undefined;
130
+ reason: string[];
131
+ score: number;
132
+ slug?: string | null | undefined;
133
+ typeRecord?: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service" | null | undefined;
134
+ };
135
+ updatedAt?: string | null | undefined;
136
+ }[];
137
+ match?: {
138
+ dataCompletionCoverage?: number | null | undefined;
139
+ duplicateBasis?: "JUDGED" | "SHARED_FACT" | "STUB" | null | undefined;
140
+ duplicateProbability?: number | null | undefined;
141
+ owner: {
142
+ entityId?: string | null | undefined;
143
+ personId?: string | null | undefined;
144
+ };
145
+ probability?: number | null | undefined;
146
+ record: {
147
+ externalId?: string | null | undefined;
148
+ id: string;
149
+ name?: string | null | undefined;
150
+ operatingStatus?: string | null | undefined;
151
+ publicPath?: string | null | undefined;
152
+ reason: string[];
153
+ score: number;
154
+ slug?: string | null | undefined;
155
+ typeRecord?: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service" | null | undefined;
156
+ };
157
+ updatedAt?: string | null | undefined;
158
+ } | null | undefined;
159
+ matchConfidence?: number | null | undefined;
160
+ matchEvidenceProbability?: number | null | undefined;
161
+ officialUrl?: string | null | undefined;
162
+ stage: "DETERMINISTIC" | "JUDGMENT" | "WEB_EVIDENCE";
163
+ status: "MATCHED" | "NEEDS_REVIEW" | "NO_MATCH";
164
+ } | null | undefined;
165
+ mentionType: "COMPANY" | "PERSON";
166
+ name: string;
167
+ shell?: {
168
+ entityId?: string | null | undefined;
169
+ personId?: string | null | undefined;
170
+ } | null | undefined;
171
+ shellDetail?: string | null | undefined;
172
+ }, unknown>>>;
173
+ source: z.ZodType<{
174
+ sourceNewsId?: number | null | undefined;
175
+ sourceUrl?: string | null | undefined;
176
+ }, unknown, z.core.$ZodTypeInternals<{
177
+ sourceNewsId?: number | null | undefined;
178
+ sourceUrl?: string | null | undefined;
179
+ }, unknown>>;
180
+ state: z.ZodEnum<{
181
+ CANCELED: "CANCELED";
182
+ COMPLETED: "COMPLETED";
183
+ FAILED: "FAILED";
184
+ PENDING: "PENDING";
185
+ RUNNING: "RUNNING";
186
+ UNKNOWN: "UNKNOWN";
187
+ }>;
188
+ updatedAt: z.ZodISODateTime;
189
+ }, z.core.$strip>;
190
+ type LookupJobDefinition = z.infer<typeof LookupJobSchemaDefinition>;
191
+ /**
192
+ * An async lookup job's state and, once COMPLETED, every company and person the article names, each identified against stored records.
193
+ *
194
+ * @openapiSchema LookupJob
195
+ * @endpoint GET /v1/lookup-jobs/{jobId}
196
+ * @contractShape lookup.job
197
+ * @contractRole canonical
198
+ */
199
+ export declare const LookupJobSchema: z.ZodType<LookupJobDefinition>;
200
+ export type LookupJob = z.infer<typeof LookupJobSchema>;
201
+ export {};
202
+ //# sourceMappingURL=job.d.ts.map
@@ -0,0 +1,31 @@
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 { JobStateSchema } from "../job/state.js";
4
+ import { LookupJobMentionSchema } from "./job-mention.js";
5
+ import { LookupJobMutationSchema } from "./job-mutation.js";
6
+ const LookupJobSchemaDefinition = z.object({
7
+ /** When the job was requested. */
8
+ createdAt: z.iso.datetime({ offset: true }),
9
+ /** Why the job failed; absent unless state is FAILED. */
10
+ failureReason: z.string().nullish(),
11
+ /** Lookup job id. */
12
+ jobId: z.uuid(),
13
+ /** Each distinct company and person the article names; empty until COMPLETED. */
14
+ mention: z.array(LookupJobMentionSchema),
15
+ /** The article the job reads. */
16
+ source: LookupJobMutationSchema,
17
+ /** Current job state. */
18
+ state: JobStateSchema,
19
+ /** When the job last changed state. */
20
+ updatedAt: z.iso.datetime({ offset: true }),
21
+ });
22
+ /**
23
+ * An async lookup job's state and, once COMPLETED, every company and person the article names, each identified against stored records.
24
+ *
25
+ * @openapiSchema LookupJob
26
+ * @endpoint GET /v1/lookup-jobs/{jobId}
27
+ * @contractShape lookup.job
28
+ * @contractRole canonical
29
+ */
30
+ export const LookupJobSchema = LookupJobSchemaDefinition;
31
+ //# sourceMappingURL=job.js.map
@@ -111,6 +111,10 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
111
111
  },
112
112
  BillingPlanType: { modulePath: "billing/plan-type", schemaName: "BillingPlanTypeSchema" },
113
113
  BillingPortal: { modulePath: "billing/portal", schemaName: "BillingPortalSchema" },
114
+ BillingRecurringPrice: {
115
+ modulePath: "billing/recurring-price",
116
+ schemaName: "BillingRecurringPriceSchema",
117
+ },
114
118
  BillingSubscription: {
115
119
  modulePath: "billing/subscription",
116
120
  schemaName: "BillingSubscriptionSchema",
@@ -196,7 +200,13 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
196
200
  schemaName: "DuplicateCreateReviewSchema",
197
201
  },
198
202
  EmployeeCount: { modulePath: "employee/count", schemaName: "EmployeeCountSchema" },
203
+ Enrichment: { modulePath: "enrichment/enrichment", schemaName: "EnrichmentSchema" },
204
+ EnrichmentBatch: { modulePath: "enrichment/batch", schemaName: "EnrichmentBatchSchema" },
199
205
  EnrichmentMode: { modulePath: "enrichment/mode", schemaName: "EnrichmentModeSchema" },
206
+ EnrichmentRefusalType: {
207
+ modulePath: "enrichment/refusal-type",
208
+ schemaName: "EnrichmentRefusalTypeSchema",
209
+ },
200
210
  Entity: { modulePath: "entity/entity", schemaName: "EntitySchema" },
201
211
  EntityAcceleratorParticipation: {
202
212
  modulePath: "entity/accelerator-participation",
@@ -391,6 +401,10 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
391
401
  modulePath: "entity/similarity-result",
392
402
  schemaName: "EntitySimilarityResultSchema",
393
403
  },
404
+ EntitySimilaritySummary: {
405
+ modulePath: "entity/similarity-summary",
406
+ schemaName: "EntitySimilaritySummarySchema",
407
+ },
394
408
  EntitySitemap: { modulePath: "entity/sitemap", schemaName: "EntitySitemapSchema" },
395
409
  EntityTag: { modulePath: "entity/tag", schemaName: "EntityTagSchema" },
396
410
  EntityText: { modulePath: "entity/text", schemaName: "EntityTextSchema" },
@@ -458,11 +472,16 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
458
472
  HarnessChassis: { modulePath: "harness/chassis", schemaName: "HarnessChassisSchema" },
459
473
  HarnessLlmApi: { modulePath: "harness/llm-api", schemaName: "HarnessLlmApiSchema" },
460
474
  HarnessRun: { modulePath: "harness/run", schemaName: "HarnessRunSchema" },
475
+ HarnessRunDetail: { modulePath: "harness/run-detail", schemaName: "HarnessRunDetailSchema" },
461
476
  HarnessRunEnvironment: {
462
477
  modulePath: "harness/run-environment",
463
478
  schemaName: "HarnessRunEnvironmentSchema",
464
479
  },
465
480
  HarnessRunLane: { modulePath: "harness/run-lane", schemaName: "HarnessRunLaneSchema" },
481
+ HarnessRunProgress: {
482
+ modulePath: "harness/run-progress",
483
+ schemaName: "HarnessRunProgressSchema",
484
+ },
466
485
  HarnessRunStatus: { modulePath: "harness/run-status", schemaName: "HarnessRunStatusSchema" },
467
486
  HarnessRunType: { modulePath: "harness/run-type", schemaName: "HarnessRunTypeSchema" },
468
487
  HelpCitation: { modulePath: "help/citation", schemaName: "HelpCitationSchema" },
@@ -485,8 +504,13 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
485
504
  modulePath: "investor/activity-filter",
486
505
  schemaName: "InvestorActivityFilterSchema",
487
506
  },
507
+ JobEnqueue: { modulePath: "job/enqueue", schemaName: "JobEnqueueSchema" },
508
+ JobState: { modulePath: "job/state", schemaName: "JobStateSchema" },
488
509
  JsonValue: { modulePath: "http/json-value", schemaName: "JsonValueSchema" },
489
510
  LinkSearch: { modulePath: "link/search", schemaName: "LinkSearchSchema" },
511
+ LookupJob: { modulePath: "lookup/job", schemaName: "LookupJobSchema" },
512
+ LookupJobMention: { modulePath: "lookup/job-mention", schemaName: "LookupJobMentionSchema" },
513
+ LookupJobMutation: { modulePath: "lookup/job-mutation", schemaName: "LookupJobMutationSchema" },
490
514
  MediaObjectType: { modulePath: "media/object-type", schemaName: "MediaObjectTypeSchema" },
491
515
  MediaSlot: { modulePath: "media/slot", schemaName: "MediaSlotSchema" },
492
516
  MediaUpload: { modulePath: "media/upload", schemaName: "MediaUploadSchema" },
@@ -565,6 +589,10 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
565
589
  modulePath: "pagination/schemas",
566
590
  schemaName: "PageEntitySimilarityResultSchema",
567
591
  },
592
+ PageEntitySimilaritySummary: {
593
+ modulePath: "pagination/schemas",
594
+ schemaName: "PageEntitySimilaritySummarySchema",
595
+ },
568
596
  PageEntityText: { modulePath: "pagination/schemas", schemaName: "PageEntityTextSchema" },
569
597
  PageEntityUrlLink: { modulePath: "pagination/schemas", schemaName: "PageEntityUrlLinkSchema" },
570
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,5 +1,16 @@
1
1
  import { z } from "zod/v4";
2
2
  declare const ResearchAllowanceUsageSchemaDefinition: z.ZodObject<{
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>>;
3
14
  entityView: z.ZodType<{
4
15
  limit?: number | null | undefined;
5
16
  remaining?: number | null | undefined;
@@ -33,6 +44,17 @@ declare const ResearchAllowanceUsageSchemaDefinition: z.ZodObject<{
33
44
  resetAt: string;
34
45
  used: number;
35
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>>;
36
58
  personView: z.ZodType<{
37
59
  limit?: number | null | undefined;
38
60
  remaining?: number | null | undefined;
@@ -2,11 +2,19 @@
2
2
  import { z } from "zod/v4";
3
3
  import { ResearchAllowanceSchema } from "./allowance.js";
4
4
  const ResearchAllowanceUsageSchemaDefinition = z.object({
5
+ /** Research runs on company targets, new or existing */
6
+ company: ResearchAllowanceSchema,
5
7
  entityView: ResearchAllowanceSchema,
8
+ /** Deprecated: replaced by company, which it mirrors. */
6
9
  newCompany: ResearchAllowanceSchema,
10
+ /** Deprecated: replaced by person, which it mirrors. */
7
11
  newPerson: ResearchAllowanceSchema,
12
+ /** Research runs on person-profile targets, new or existing */
13
+ person: ResearchAllowanceSchema,
8
14
  personView: ResearchAllowanceSchema,
15
+ /** Deprecated: replaced by company, which it mirrors. */
9
16
  update: ResearchAllowanceSchema,
17
+ /** Deprecated: replaced by person, which it mirrors. */
10
18
  updatePerson: ResearchAllowanceSchema,
11
19
  webSearch: ResearchAllowanceSchema,
12
20
  });