@aventurevc/api-schemas 0.8.421 → 0.8.423

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.
@@ -4265,6 +4265,15 @@ export declare const EntityDetailSchema: z.ZodObject<{
4265
4265
  valueResearchDetail?: string | null | undefined;
4266
4266
  valueType: "date" | "monetary" | "numeric" | "percentage" | "text";
4267
4267
  }[];
4268
+ financial?: {
4269
+ currency: string | null;
4270
+ entityId: string;
4271
+ functionalCurrency: string | null;
4272
+ id: number;
4273
+ period: string;
4274
+ revenue: string | null;
4275
+ year: number;
4276
+ }[] | null | undefined;
4268
4277
  snippet: {
4269
4278
  compliance?: {
4270
4279
  characterCount: number;
@@ -4364,6 +4373,15 @@ export declare const EntityDetailSchema: z.ZodObject<{
4364
4373
  valueResearchDetail?: string | null | undefined;
4365
4374
  valueType: "date" | "monetary" | "numeric" | "percentage" | "text";
4366
4375
  }[];
4376
+ financial?: {
4377
+ currency: string | null;
4378
+ entityId: string;
4379
+ functionalCurrency: string | null;
4380
+ id: number;
4381
+ period: string;
4382
+ revenue: string | null;
4383
+ year: number;
4384
+ }[] | null | undefined;
4367
4385
  snippet: {
4368
4386
  compliance?: {
4369
4387
  characterCount: number;
@@ -0,0 +1,38 @@
1
+ import { z } from "zod/v4";
2
+ declare const EntityFinancialSchemaDefinition: z.ZodObject<{
3
+ currency: z.ZodNullable<z.ZodString>;
4
+ entityId: z.ZodUUID;
5
+ functionalCurrency: z.ZodNullable<z.ZodString>;
6
+ id: z.ZodInt;
7
+ period: z.ZodString;
8
+ revenue: z.ZodNullable<z.ZodString>;
9
+ year: z.ZodInt;
10
+ }, z.core.$strip>;
11
+ type EntityFinancialDefinition = z.infer<typeof EntityFinancialSchemaDefinition>;
12
+ export interface EntityFinancialSchemaInput extends z.input<typeof EntityFinancialSchemaDefinition> {
13
+ }
14
+ /**
15
+ * Stored financial facts for one exact year and period
16
+ *
17
+ * @openapiSchema EntityFinancial
18
+ * @endpoint GET /v1/entities/lookup-exact
19
+ * @endpoint GET /v1/search/link
20
+ * @endpoint GET /v1/entities/{entityId}
21
+ * @endpoint GET /v1/entities/{entityId}/investors
22
+ * @endpoint GET /v1/entities/{entityId}/research
23
+ * @endpoint GET /v1/search/link/jobs/{jobId}
24
+ * @endpoint GET /v1/search/shared/{id}
25
+ * @endpoint GET /v1/search/shared/slug/{slug}
26
+ * @endpoint POST /v1/entities/lookup-batch
27
+ * @endpoint POST /v1/entities/lookup-matches
28
+ * @endpoint POST /v1/entities/search
29
+ * @endpoint POST /v1/search
30
+ * @endpoint POST /v1/search/shared
31
+ * @usedBySchema EntityResearchSchema
32
+ * @contractShape entity.financial
33
+ * @contractRole canonical
34
+ */
35
+ export declare const EntityFinancialSchema: z.ZodType<EntityFinancialDefinition, EntityFinancialSchemaInput>;
36
+ export type EntityFinancial = z.infer<typeof EntityFinancialSchema>;
37
+ export {};
38
+ //# sourceMappingURL=financial.d.ts.map
@@ -0,0 +1,41 @@
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 EntityFinancialSchemaDefinition = z.object({
4
+ /** Stored revenue currency, when known */
5
+ currency: z.string().nullable(),
6
+ /** Entity that owns this financial row */
7
+ entityId: z.uuid(),
8
+ /** Stored functional currency, independent of revenue currency */
9
+ functionalCurrency: z.string().nullable(),
10
+ /** Financial row ID for the existing private provenance read */
11
+ id: z.int(),
12
+ /** Exact stored period token */
13
+ period: z.string().max(6),
14
+ /** Exact stored integer revenue as text; no FX or scale adjustment */
15
+ revenue: z.string().nullable(),
16
+ /** Stored reporting year */
17
+ year: z.int(),
18
+ });
19
+ /**
20
+ * Stored financial facts for one exact year and period
21
+ *
22
+ * @openapiSchema EntityFinancial
23
+ * @endpoint GET /v1/entities/lookup-exact
24
+ * @endpoint GET /v1/search/link
25
+ * @endpoint GET /v1/entities/{entityId}
26
+ * @endpoint GET /v1/entities/{entityId}/investors
27
+ * @endpoint GET /v1/entities/{entityId}/research
28
+ * @endpoint GET /v1/search/link/jobs/{jobId}
29
+ * @endpoint GET /v1/search/shared/{id}
30
+ * @endpoint GET /v1/search/shared/slug/{slug}
31
+ * @endpoint POST /v1/entities/lookup-batch
32
+ * @endpoint POST /v1/entities/lookup-matches
33
+ * @endpoint POST /v1/entities/search
34
+ * @endpoint POST /v1/search
35
+ * @endpoint POST /v1/search/shared
36
+ * @usedBySchema EntityResearchSchema
37
+ * @contractShape entity.financial
38
+ * @contractRole canonical
39
+ */
40
+ export const EntityFinancialSchema = EntityFinancialSchemaDefinition;
41
+ //# sourceMappingURL=financial.js.map
@@ -4243,6 +4243,15 @@ declare const EntityInvestorParticipationSchemaDefinition: z.ZodObject<{
4243
4243
  valueResearchDetail?: string | null | undefined;
4244
4244
  valueType: "date" | "monetary" | "numeric" | "percentage" | "text";
4245
4245
  }[];
4246
+ financial?: {
4247
+ currency: string | null;
4248
+ entityId: string;
4249
+ functionalCurrency: string | null;
4250
+ id: number;
4251
+ period: string;
4252
+ revenue: string | null;
4253
+ year: number;
4254
+ }[] | null | undefined;
4246
4255
  snippet: {
4247
4256
  compliance?: {
4248
4257
  characterCount: number;
@@ -4342,6 +4351,15 @@ declare const EntityInvestorParticipationSchemaDefinition: z.ZodObject<{
4342
4351
  valueResearchDetail?: string | null | undefined;
4343
4352
  valueType: "date" | "monetary" | "numeric" | "percentage" | "text";
4344
4353
  }[];
4354
+ financial?: {
4355
+ currency: string | null;
4356
+ entityId: string;
4357
+ functionalCurrency: string | null;
4358
+ id: number;
4359
+ period: string;
4360
+ revenue: string | null;
4361
+ year: number;
4362
+ }[] | null | undefined;
4345
4363
  snippet: {
4346
4364
  compliance?: {
4347
4365
  characterCount: number;
@@ -12,6 +12,8 @@ export declare const ENTITY_LOOKUP_EXACT_ENDPOINT: "/v1/entities/lookup-exact";
12
12
  export declare const EntityLookupExactParamSchema: z.ZodObject<{
13
13
  companySlug: z.ZodOptional<z.ZodString>;
14
14
  comparisonEntityId: z.ZodOptional<z.ZodArray<z.ZodUUID>>;
15
+ financialPeriod: z.ZodOptional<z.ZodString>;
16
+ financialYear: z.ZodOptional<z.ZodInt>;
15
17
  location: z.ZodOptional<z.ZodString>;
16
18
  name: z.ZodOptional<z.ZodString>;
17
19
  nameBrand: z.ZodOptional<z.ZodString>;
@@ -19,6 +19,10 @@ export const EntityLookupExactParamSchema = z.object({
19
19
  .optional(),
20
20
  /** Exact peer UUIDs in display order for an optional cited comparison on the UUID item JSON read. Exclude the subject and duplicates; subject plus peers must fit the served search answer policy maxEntityEvidence. Uses public stored evidence only, requires the caller's paid natural-search entitlement, and consumes no search allowance or peer views. Omit for ordinary reads; ignored on HEAD and SSE. */
21
21
  comparisonEntityId: z.array(z.uuid()).optional(),
22
+ /** Exact stored financial period token, without trimming or normalization. Supply with financialYear; must be nonblank and at most six characters. Ignored on HEAD and SSE. */
23
+ financialPeriod: z.string().max(6).optional(),
24
+ /** Select stored financial facts for this exact year together with financialPeriod. Omit both for ordinary detail reads; ignored on HEAD and SSE. */
25
+ financialYear: z.int().optional(),
22
26
  /** Location candidate: city, state, or country. */
23
27
  location: z.string().optional(),
24
28
  /** Primary entity name candidate. */
@@ -156,6 +156,23 @@ declare const EntityResearchSchemaDefinition: z.ZodObject<{
156
156
  valueResearchDetail?: string | null | undefined;
157
157
  valueType: "date" | "monetary" | "numeric" | "percentage" | "text";
158
158
  }, import("./research-detail.ts").EntityResearchDetailSchemaInput>>>;
159
+ financial: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodType<{
160
+ currency: string | null;
161
+ entityId: string;
162
+ functionalCurrency: string | null;
163
+ id: number;
164
+ period: string;
165
+ revenue: string | null;
166
+ year: number;
167
+ }, import("./financial.ts").EntityFinancialSchemaInput, z.core.$ZodTypeInternals<{
168
+ currency: string | null;
169
+ entityId: string;
170
+ functionalCurrency: string | null;
171
+ id: number;
172
+ period: string;
173
+ revenue: string | null;
174
+ year: number;
175
+ }, import("./financial.ts").EntityFinancialSchemaInput>>>>>;
159
176
  snippet: z.ZodArray<z.ZodObject<{
160
177
  compliance: z.ZodOptional<z.ZodNullable<z.ZodObject<{
161
178
  characterCount: z.ZodInt;
@@ -1,6 +1,7 @@
1
1
  // LLM AGENTS MAY NOT EDIT THIS FILE UNDER ANY CIRCUMSTANCES. DO NOT EDIT - generated from Kotlin data classes via OpenAPI. Edit the backend owner and run: make docs-openapi && make docs-zod
2
2
  import { z } from "zod/v4";
3
3
  import { EntityAcceleratorParticipationSchema } from "./accelerator-participation.js";
4
+ import { EntityFinancialSchema } from "./financial.js";
4
5
  import { EntityResearchDetailSchema } from "./research-detail.js";
5
6
  import { EntityResearchSnippetSchema } from "./research-snippet.js";
6
7
  const EntityResearchSchemaDefinition = z.object({
@@ -8,6 +9,8 @@ const EntityResearchSchemaDefinition = z.object({
8
9
  acceleratorParticipation: z.array(EntityAcceleratorParticipationSchema),
9
10
  /** Structured research details the caller is allowed to see */
10
11
  detail: z.array(EntityResearchDetailSchema),
12
+ /** Stored financial facts selected by financialYear and financialPeriod; omitted when not selected, empty when no matching row exists. Includes no private provenance. */
13
+ financial: z.array(EntityFinancialSchema).nullish(),
11
14
  /** Research text snippets for this entity */
12
15
  snippet: z.array(EntityResearchSnippetSchema),
13
16
  });
@@ -4252,6 +4252,15 @@ export declare const EntityResolutionSchema: z.ZodObject<{
4252
4252
  valueResearchDetail?: string | null | undefined;
4253
4253
  valueType: "date" | "monetary" | "numeric" | "percentage" | "text";
4254
4254
  }[];
4255
+ financial?: {
4256
+ currency: string | null;
4257
+ entityId: string;
4258
+ functionalCurrency: string | null;
4259
+ id: number;
4260
+ period: string;
4261
+ revenue: string | null;
4262
+ year: number;
4263
+ }[] | null | undefined;
4255
4264
  snippet: {
4256
4265
  compliance?: {
4257
4266
  characterCount: number;
@@ -4351,6 +4360,15 @@ export declare const EntityResolutionSchema: z.ZodObject<{
4351
4360
  valueResearchDetail?: string | null | undefined;
4352
4361
  valueType: "date" | "monetary" | "numeric" | "percentage" | "text";
4353
4362
  }[];
4363
+ financial?: {
4364
+ currency: string | null;
4365
+ entityId: string;
4366
+ functionalCurrency: string | null;
4367
+ id: number;
4368
+ period: string;
4369
+ revenue: string | null;
4370
+ year: number;
4371
+ }[] | null | undefined;
4354
4372
  snippet: {
4355
4373
  compliance?: {
4356
4374
  characterCount: number;
@@ -10324,6 +10324,15 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
10324
10324
  valueResearchDetail?: string | null | undefined;
10325
10325
  valueType: "date" | "monetary" | "numeric" | "percentage" | "text";
10326
10326
  }[];
10327
+ financial?: {
10328
+ currency: string | null;
10329
+ entityId: string;
10330
+ functionalCurrency: string | null;
10331
+ id: number;
10332
+ period: string;
10333
+ revenue: string | null;
10334
+ year: number;
10335
+ }[] | null | undefined;
10327
10336
  snippet: {
10328
10337
  compliance?: {
10329
10338
  characterCount: number;
@@ -10423,6 +10432,15 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
10423
10432
  valueResearchDetail?: string | null | undefined;
10424
10433
  valueType: "date" | "monetary" | "numeric" | "percentage" | "text";
10425
10434
  }[];
10435
+ financial?: {
10436
+ currency: string | null;
10437
+ entityId: string;
10438
+ functionalCurrency: string | null;
10439
+ id: number;
10440
+ period: string;
10441
+ revenue: string | null;
10442
+ year: number;
10443
+ }[] | null | undefined;
10426
10444
  snippet: {
10427
10445
  compliance?: {
10428
10446
  characterCount: number;
@@ -5245,6 +5245,15 @@ declare const LinkSearchSchemaDefinition: z.ZodObject<{
5245
5245
  valueResearchDetail?: string | null | undefined;
5246
5246
  valueType: "date" | "monetary" | "numeric" | "percentage" | "text";
5247
5247
  }[];
5248
+ financial?: {
5249
+ currency: string | null;
5250
+ entityId: string;
5251
+ functionalCurrency: string | null;
5252
+ id: number;
5253
+ period: string;
5254
+ revenue: string | null;
5255
+ year: number;
5256
+ }[] | null | undefined;
5248
5257
  snippet: {
5249
5258
  compliance?: {
5250
5259
  characterCount: number;
@@ -12577,6 +12586,15 @@ declare const LinkSearchSchemaDefinition: z.ZodObject<{
12577
12586
  valueResearchDetail?: string | null | undefined;
12578
12587
  valueType: "date" | "monetary" | "numeric" | "percentage" | "text";
12579
12588
  }[];
12589
+ financial?: {
12590
+ currency: string | null;
12591
+ entityId: string;
12592
+ functionalCurrency: string | null;
12593
+ id: number;
12594
+ period: string;
12595
+ revenue: string | null;
12596
+ year: number;
12597
+ }[] | null | undefined;
12580
12598
  snippet: {
12581
12599
  compliance?: {
12582
12600
  characterCount: number;
@@ -477,6 +477,7 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
477
477
  modulePath: "entity/filter-ui-meta",
478
478
  schemaName: "EntityFilterUiMetaSchema",
479
479
  },
480
+ EntityFinancial: { modulePath: "entity/financial", schemaName: "EntityFinancialSchema" },
480
481
  EntityFundingDetail: {
481
482
  modulePath: "entity/funding-detail",
482
483
  schemaName: "EntityFundingDetailSchema",
@@ -4869,6 +4869,15 @@ declare const PageEntityDetailSchemaDefinition: z.ZodObject<{
4869
4869
  valueResearchDetail?: string | null | undefined;
4870
4870
  valueType: "date" | "monetary" | "numeric" | "percentage" | "text";
4871
4871
  }[];
4872
+ financial?: {
4873
+ currency: string | null;
4874
+ entityId: string;
4875
+ functionalCurrency: string | null;
4876
+ id: number;
4877
+ period: string;
4878
+ revenue: string | null;
4879
+ year: number;
4880
+ }[] | null | undefined;
4872
4881
  snippet: {
4873
4882
  compliance?: {
4874
4883
  characterCount: number;
@@ -4968,6 +4977,15 @@ declare const PageEntityDetailSchemaDefinition: z.ZodObject<{
4968
4977
  valueResearchDetail?: string | null | undefined;
4969
4978
  valueType: "date" | "monetary" | "numeric" | "percentage" | "text";
4970
4979
  }[];
4980
+ financial?: {
4981
+ currency: string | null;
4982
+ entityId: string;
4983
+ functionalCurrency: string | null;
4984
+ id: number;
4985
+ period: string;
4986
+ revenue: string | null;
4987
+ year: number;
4988
+ }[] | null | undefined;
4971
4989
  snippet: {
4972
4990
  compliance?: {
4973
4991
  characterCount: number;
@@ -7776,6 +7794,15 @@ declare const PageEntityInvestorParticipationSchemaDefinition: z.ZodObject<{
7776
7794
  valueResearchDetail?: string | null | undefined;
7777
7795
  valueType: "date" | "monetary" | "numeric" | "percentage" | "text";
7778
7796
  }[];
7797
+ financial?: {
7798
+ currency: string | null;
7799
+ entityId: string;
7800
+ functionalCurrency: string | null;
7801
+ id: number;
7802
+ period: string;
7803
+ revenue: string | null;
7804
+ year: number;
7805
+ }[] | null | undefined;
7779
7806
  snippet: {
7780
7807
  compliance?: {
7781
7808
  characterCount: number;
@@ -10043,6 +10070,15 @@ declare const PageEntityInvestorParticipationSchemaDefinition: z.ZodObject<{
10043
10070
  valueResearchDetail?: string | null | undefined;
10044
10071
  valueType: "date" | "monetary" | "numeric" | "percentage" | "text";
10045
10072
  }[];
10073
+ financial?: {
10074
+ currency: string | null;
10075
+ entityId: string;
10076
+ functionalCurrency: string | null;
10077
+ id: number;
10078
+ period: string;
10079
+ revenue: string | null;
10080
+ year: number;
10081
+ }[] | null | undefined;
10046
10082
  snippet: {
10047
10083
  compliance?: {
10048
10084
  characterCount: number;
@@ -5256,6 +5256,15 @@ declare const SharedSearchSchemaDefinition: z.ZodObject<{
5256
5256
  valueResearchDetail?: string | null | undefined;
5257
5257
  valueType: "date" | "monetary" | "numeric" | "percentage" | "text";
5258
5258
  }[];
5259
+ financial?: {
5260
+ currency: string | null;
5261
+ entityId: string;
5262
+ functionalCurrency: string | null;
5263
+ id: number;
5264
+ period: string;
5265
+ revenue: string | null;
5266
+ year: number;
5267
+ }[] | null | undefined;
5259
5268
  snippet: {
5260
5269
  compliance?: {
5261
5270
  characterCount: number;
@@ -12588,6 +12597,15 @@ declare const SharedSearchSchemaDefinition: z.ZodObject<{
12588
12597
  valueResearchDetail?: string | null | undefined;
12589
12598
  valueType: "date" | "monetary" | "numeric" | "percentage" | "text";
12590
12599
  }[];
12600
+ financial?: {
12601
+ currency: string | null;
12602
+ entityId: string;
12603
+ functionalCurrency: string | null;
12604
+ id: number;
12605
+ period: string;
12606
+ revenue: string | null;
12607
+ year: number;
12608
+ }[] | null | undefined;
12591
12609
  snippet: {
12592
12610
  compliance?: {
12593
12611
  characterCount: number;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aventurevc/api-schemas",
3
- "version": "0.8.421",
3
+ "version": "0.8.423",
4
4
  "private": false,
5
5
  "description": "Zod v4 schemas and TypeScript types for the aVenture API.",
6
6
  "license": "Apache-2.0",