@aventurevc/api-schemas 0.8.420 → 0.8.422
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/billing/catalog-plan.d.ts +9 -2
- package/dist/billing/catalog-plan.js +2 -1
- package/dist/billing/catalog-tier.d.ts +9 -2
- package/dist/billing/catalog-tier.js +2 -1
- package/dist/billing/catalog.d.ts +4 -4
- package/dist/billing/subscription.d.ts +9 -2
- package/dist/billing/subscription.js +2 -1
- package/dist/billing/tier-type.d.ts +28 -0
- package/dist/billing/tier-type.js +17 -0
- package/dist/entity/detail.d.ts +18 -0
- package/dist/entity/financial.d.ts +38 -0
- package/dist/entity/financial.js +41 -0
- package/dist/entity/investor-participation.d.ts +18 -0
- package/dist/entity/lookup-exact-param.d.ts +2 -0
- package/dist/entity/lookup-exact-param.js +4 -0
- package/dist/entity/research.d.ts +17 -0
- package/dist/entity/research.js +3 -0
- package/dist/entity/resolution.d.ts +18 -0
- package/dist/federated/search.d.ts +18 -0
- package/dist/link/search.d.ts +18 -0
- package/dist/openapi-component-manifest.js +2 -0
- package/dist/pagination/schemas.d.ts +36 -0
- package/dist/shared/search.d.ts +18 -0
- package/package.json +1 -1
|
@@ -23,12 +23,19 @@ declare const BillingCatalogPlanSchemaDefinition: z.ZodObject<{
|
|
|
23
23
|
UNLIMITED_MONTHLY: "UNLIMITED_MONTHLY";
|
|
24
24
|
};
|
|
25
25
|
};
|
|
26
|
-
tier: z.ZodEnum<{
|
|
26
|
+
tier: z.ZodUnion<readonly [z.ZodEnum<{
|
|
27
27
|
ESSENTIAL: "ESSENTIAL";
|
|
28
28
|
PLUS: "PLUS";
|
|
29
29
|
PRO: "PRO";
|
|
30
30
|
UNLIMITED: "UNLIMITED";
|
|
31
|
-
}
|
|
31
|
+
}>, z.ZodString]> & {
|
|
32
|
+
enum: {
|
|
33
|
+
ESSENTIAL: "ESSENTIAL";
|
|
34
|
+
PLUS: "PLUS";
|
|
35
|
+
PRO: "PRO";
|
|
36
|
+
UNLIMITED: "UNLIMITED";
|
|
37
|
+
};
|
|
38
|
+
};
|
|
32
39
|
unitAmount: z.ZodNumber;
|
|
33
40
|
}, z.core.$strip>;
|
|
34
41
|
type BillingCatalogPlanDefinition = z.infer<typeof BillingCatalogPlanSchemaDefinition>;
|
|
@@ -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 { BillingPlanTypeSchema } from "./plan-type.js";
|
|
4
|
+
import { BillingTierTypeSchema } from "./tier-type.js";
|
|
4
5
|
const BillingCatalogPlanSchemaDefinition = z.object({
|
|
5
6
|
/** App Store product id that sells this plan in the iOS and Mac apps; absent when the plan sells only on the web. */
|
|
6
7
|
appStoreProductId: z.string().nullish(),
|
|
@@ -14,7 +15,7 @@ const BillingCatalogPlanSchemaDefinition = z.object({
|
|
|
14
15
|
/** First invoice amount in currency minor units (USD cents) when an automatic, one-time Checkout offer is available; absent otherwise. Renewals use unitAmount. */
|
|
15
16
|
introductoryAmount: z.number().int().nullish(),
|
|
16
17
|
plan: BillingPlanTypeSchema,
|
|
17
|
-
tier:
|
|
18
|
+
tier: BillingTierTypeSchema,
|
|
18
19
|
/** Price per cadence in currency minor units, not major units: USD cents (4900 means USD 49.00). */
|
|
19
20
|
unitAmount: z.number().int(),
|
|
20
21
|
});
|
|
@@ -12,12 +12,19 @@ declare const BillingCatalogTierSchemaDefinition: z.ZodObject<{
|
|
|
12
12
|
displayName: z.ZodString;
|
|
13
13
|
lookupDailyLimit: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
|
|
14
14
|
searchDailyLimit: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
|
|
15
|
-
tier: z.ZodEnum<{
|
|
15
|
+
tier: z.ZodUnion<readonly [z.ZodEnum<{
|
|
16
16
|
ESSENTIAL: "ESSENTIAL";
|
|
17
17
|
PLUS: "PLUS";
|
|
18
18
|
PRO: "PRO";
|
|
19
19
|
UNLIMITED: "UNLIMITED";
|
|
20
|
-
}
|
|
20
|
+
}>, z.ZodString]> & {
|
|
21
|
+
enum: {
|
|
22
|
+
ESSENTIAL: "ESSENTIAL";
|
|
23
|
+
PLUS: "PLUS";
|
|
24
|
+
PRO: "PRO";
|
|
25
|
+
UNLIMITED: "UNLIMITED";
|
|
26
|
+
};
|
|
27
|
+
};
|
|
21
28
|
}, z.core.$strip>;
|
|
22
29
|
type BillingCatalogTierDefinition = z.infer<typeof BillingCatalogTierSchemaDefinition>;
|
|
23
30
|
export interface BillingCatalogTierSchemaInput extends z.input<typeof BillingCatalogTierSchemaDefinition> {
|
|
@@ -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 { BillingCatalogAllowanceSchema } from "./catalog-allowance.js";
|
|
4
|
+
import { BillingTierTypeSchema } from "./tier-type.js";
|
|
4
5
|
const BillingCatalogTierSchemaDefinition = z.object({
|
|
5
6
|
/** Researchly AI credits per Researchly billing period; 0 withholds them and absent means uncapped. */
|
|
6
7
|
aiCreditLimit: z.int().nullish(),
|
|
@@ -12,7 +13,7 @@ const BillingCatalogTierSchemaDefinition = z.object({
|
|
|
12
13
|
lookupDailyLimit: z.int().nullish(),
|
|
13
14
|
/** Searches per UTC day without a paid plan: plain-English company, people, and federated search, one per request; link search always needs a paid plan. Past it a search answers 402 subscription_required until the next UTC day. Absent on a paid tier, which has no daily search gate. */
|
|
14
15
|
searchDailyLimit: z.int().nullish(),
|
|
15
|
-
tier:
|
|
16
|
+
tier: BillingTierTypeSchema,
|
|
16
17
|
});
|
|
17
18
|
/**
|
|
18
19
|
* One subscription tier, its monthly caps, and its free daily allowances.
|
|
@@ -25,7 +25,7 @@ declare const BillingCatalogSchemaDefinition: z.ZodObject<{
|
|
|
25
25
|
freeTrialDays?: number | null | undefined;
|
|
26
26
|
introductoryAmount?: number | null | undefined;
|
|
27
27
|
plan: string;
|
|
28
|
-
tier:
|
|
28
|
+
tier: string;
|
|
29
29
|
unitAmount: number;
|
|
30
30
|
}, import("./catalog-plan.ts").BillingCatalogPlanSchemaInput, z.core.$ZodTypeInternals<{
|
|
31
31
|
appStoreProductId?: string | null | undefined;
|
|
@@ -35,7 +35,7 @@ declare const BillingCatalogSchemaDefinition: z.ZodObject<{
|
|
|
35
35
|
freeTrialDays?: number | null | undefined;
|
|
36
36
|
introductoryAmount?: number | null | undefined;
|
|
37
37
|
plan: string;
|
|
38
|
-
tier:
|
|
38
|
+
tier: string;
|
|
39
39
|
unitAmount: number;
|
|
40
40
|
}, import("./catalog-plan.ts").BillingCatalogPlanSchemaInput>>>;
|
|
41
41
|
tier: z.ZodArray<z.ZodType<{
|
|
@@ -48,7 +48,7 @@ declare const BillingCatalogSchemaDefinition: z.ZodObject<{
|
|
|
48
48
|
displayName: string;
|
|
49
49
|
lookupDailyLimit?: number | null | undefined;
|
|
50
50
|
searchDailyLimit?: number | null | undefined;
|
|
51
|
-
tier:
|
|
51
|
+
tier: string;
|
|
52
52
|
}, import("./catalog-tier.ts").BillingCatalogTierSchemaInput, z.core.$ZodTypeInternals<{
|
|
53
53
|
aiCreditLimit?: number | null | undefined;
|
|
54
54
|
allowance: {
|
|
@@ -59,7 +59,7 @@ declare const BillingCatalogSchemaDefinition: z.ZodObject<{
|
|
|
59
59
|
displayName: string;
|
|
60
60
|
lookupDailyLimit?: number | null | undefined;
|
|
61
61
|
searchDailyLimit?: number | null | undefined;
|
|
62
|
-
tier:
|
|
62
|
+
tier: string;
|
|
63
63
|
}, import("./catalog-tier.ts").BillingCatalogTierSchemaInput>>>;
|
|
64
64
|
}, z.core.$strip>;
|
|
65
65
|
type BillingCatalogDefinition = z.infer<typeof BillingCatalogSchemaDefinition>;
|
|
@@ -236,12 +236,19 @@ declare const BillingSubscriptionSchemaDefinition: z.ZodObject<{
|
|
|
236
236
|
TRIALING: "TRIALING";
|
|
237
237
|
UNPAID: "UNPAID";
|
|
238
238
|
}>;
|
|
239
|
-
tier: z.ZodEnum<{
|
|
239
|
+
tier: z.ZodUnion<readonly [z.ZodEnum<{
|
|
240
240
|
ESSENTIAL: "ESSENTIAL";
|
|
241
241
|
PLUS: "PLUS";
|
|
242
242
|
PRO: "PRO";
|
|
243
243
|
UNLIMITED: "UNLIMITED";
|
|
244
|
-
}
|
|
244
|
+
}>, z.ZodString]> & {
|
|
245
|
+
enum: {
|
|
246
|
+
ESSENTIAL: "ESSENTIAL";
|
|
247
|
+
PLUS: "PLUS";
|
|
248
|
+
PRO: "PRO";
|
|
249
|
+
UNLIMITED: "UNLIMITED";
|
|
250
|
+
};
|
|
251
|
+
};
|
|
245
252
|
}, z.core.$strip>;
|
|
246
253
|
type BillingSubscriptionDefinition = z.infer<typeof BillingSubscriptionSchemaDefinition>;
|
|
247
254
|
export interface BillingSubscriptionSchemaInput extends z.input<typeof BillingSubscriptionSchemaDefinition> {
|
|
@@ -3,6 +3,7 @@ import { z } from "zod/v4";
|
|
|
3
3
|
import { BillingAdditionalUsageSchema } from "./additional-usage.js";
|
|
4
4
|
import { BillingPlanTypeSchema } from "./plan-type.js";
|
|
5
5
|
import { BillingRecurringPriceSchema } from "./recurring-price.js";
|
|
6
|
+
import { BillingTierTypeSchema } from "./tier-type.js";
|
|
6
7
|
import { ResearchAllowanceUsageSchema } from "../research/allowance-usage.js";
|
|
7
8
|
const BillingSubscriptionSchemaDefinition = z.object({
|
|
8
9
|
additionalUsage: BillingAdditionalUsageSchema,
|
|
@@ -44,7 +45,7 @@ const BillingSubscriptionSchemaDefinition = z.object({
|
|
|
44
45
|
"PAUSED",
|
|
45
46
|
]),
|
|
46
47
|
/** Tier whose monthly allowances apply now */
|
|
47
|
-
tier:
|
|
48
|
+
tier: BillingTierTypeSchema,
|
|
48
49
|
});
|
|
49
50
|
/**
|
|
50
51
|
* Current plan (Essential, AI Plus, AI Pro, or Unlimited), subscription status, and monthly usage.
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { z } from "zod/v4";
|
|
2
|
+
/**
|
|
3
|
+
* Subscription tier that sets an account's monthly caps and included features.
|
|
4
|
+
*
|
|
5
|
+
* @openapiSchema BillingTierType
|
|
6
|
+
* @endpoint GET /v1/billing/plans
|
|
7
|
+
* @endpoint GET /v1/billing/subscription
|
|
8
|
+
* @usedBySchema BillingCatalogPlanSchema
|
|
9
|
+
* @usedBySchema BillingCatalogTierSchema
|
|
10
|
+
* @usedBySchema BillingSubscriptionSchema
|
|
11
|
+
* @contractShape billing.tier-type
|
|
12
|
+
* @contractRole canonical
|
|
13
|
+
*/
|
|
14
|
+
export declare const BillingTierTypeSchema: z.ZodUnion<readonly [z.ZodEnum<{
|
|
15
|
+
ESSENTIAL: "ESSENTIAL";
|
|
16
|
+
PLUS: "PLUS";
|
|
17
|
+
PRO: "PRO";
|
|
18
|
+
UNLIMITED: "UNLIMITED";
|
|
19
|
+
}>, z.ZodString]> & {
|
|
20
|
+
enum: {
|
|
21
|
+
ESSENTIAL: "ESSENTIAL";
|
|
22
|
+
PLUS: "PLUS";
|
|
23
|
+
PRO: "PRO";
|
|
24
|
+
UNLIMITED: "UNLIMITED";
|
|
25
|
+
};
|
|
26
|
+
};
|
|
27
|
+
export type BillingTierType = z.infer<typeof BillingTierTypeSchema>;
|
|
28
|
+
//# sourceMappingURL=tier-type.d.ts.map
|
|
@@ -0,0 +1,17 @@
|
|
|
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 BillingTierTypeSchemaKnownMembers = z.enum(["ESSENTIAL", "PLUS", "PRO", "UNLIMITED"]);
|
|
4
|
+
/**
|
|
5
|
+
* Subscription tier that sets an account's monthly caps and included features.
|
|
6
|
+
*
|
|
7
|
+
* @openapiSchema BillingTierType
|
|
8
|
+
* @endpoint GET /v1/billing/plans
|
|
9
|
+
* @endpoint GET /v1/billing/subscription
|
|
10
|
+
* @usedBySchema BillingCatalogPlanSchema
|
|
11
|
+
* @usedBySchema BillingCatalogTierSchema
|
|
12
|
+
* @usedBySchema BillingSubscriptionSchema
|
|
13
|
+
* @contractShape billing.tier-type
|
|
14
|
+
* @contractRole canonical
|
|
15
|
+
*/
|
|
16
|
+
export const BillingTierTypeSchema = Object.assign(z.union([BillingTierTypeSchemaKnownMembers, z.string()]), { enum: BillingTierTypeSchemaKnownMembers.enum });
|
|
17
|
+
//# sourceMappingURL=tier-type.js.map
|
package/dist/entity/detail.d.ts
CHANGED
|
@@ -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;
|
package/dist/entity/research.js
CHANGED
|
@@ -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;
|
package/dist/link/search.d.ts
CHANGED
|
@@ -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;
|
|
@@ -164,6 +164,7 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
|
|
|
164
164
|
modulePath: "billing/subscription-mutation",
|
|
165
165
|
schemaName: "BillingSubscriptionMutationSchema",
|
|
166
166
|
},
|
|
167
|
+
BillingTierType: { modulePath: "billing/tier-type", schemaName: "BillingTierTypeSchema" },
|
|
167
168
|
BlogPost: { modulePath: "blog/post", schemaName: "BlogPostSchema" },
|
|
168
169
|
BlogPostType: { modulePath: "blog/post-type", schemaName: "BlogPostTypeSchema" },
|
|
169
170
|
ChartBucket: { modulePath: "chart/bucket", schemaName: "ChartBucketSchema" },
|
|
@@ -476,6 +477,7 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
|
|
|
476
477
|
modulePath: "entity/filter-ui-meta",
|
|
477
478
|
schemaName: "EntityFilterUiMetaSchema",
|
|
478
479
|
},
|
|
480
|
+
EntityFinancial: { modulePath: "entity/financial", schemaName: "EntityFinancialSchema" },
|
|
479
481
|
EntityFundingDetail: {
|
|
480
482
|
modulePath: "entity/funding-detail",
|
|
481
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;
|
package/dist/shared/search.d.ts
CHANGED
|
@@ -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;
|