@aventurevc/api-schemas 0.8.222 → 0.8.223

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.
@@ -2,11 +2,13 @@ import { z } from "zod/v4";
2
2
  declare const AgentHelpSchemaDefinition: z.ZodObject<{
3
3
  answer: z.ZodString;
4
4
  citation: z.ZodArray<z.ZodType<{
5
+ billingAccess?: "DAILY_ALLOWANCE" | "PAID_PLAN" | null | undefined;
5
6
  excerpt: string;
6
7
  sourceId: string;
7
8
  sourceType: string;
8
9
  sourceVersion?: string | null | undefined;
9
10
  }, import("../help/citation.ts").HelpCitationSchemaInput, z.core.$ZodTypeInternals<{
11
+ billingAccess?: "DAILY_ALLOWANCE" | "PAID_PLAN" | null | undefined;
10
12
  excerpt: string;
11
13
  sourceId: string;
12
14
  sourceType: string;
@@ -19,11 +21,13 @@ declare const AgentHelpSchemaDefinition: z.ZodObject<{
19
21
  }>;
20
22
  resolution: z.ZodOptional<z.ZodNullable<z.ZodObject<{
21
23
  candidate: z.ZodArray<z.ZodType<{
24
+ billingAccess?: "DAILY_ALLOWANCE" | "PAID_PLAN" | null | undefined;
22
25
  excerpt: string;
23
26
  sourceId: string;
24
27
  sourceType: string;
25
28
  sourceVersion?: string | null | undefined;
26
29
  }, import("../help/citation.ts").HelpCitationSchemaInput, z.core.$ZodTypeInternals<{
30
+ billingAccess?: "DAILY_ALLOWANCE" | "PAID_PLAN" | null | undefined;
27
31
  excerpt: string;
28
32
  sourceId: string;
29
33
  sourceType: string;
@@ -0,0 +1,17 @@
1
+ import { z } from "zod/v4";
2
+ /**
3
+ * What a caller without a paid plan gets. `PAID_PLAN`: nothing; the operation answers 402 subscription_required until the caller subscribes. `DAILY_ALLOWANCE`: a free UTC-day allowance, then 402 subscription_required until it refills.
4
+ *
5
+ * @openapiSchema BillingAccessType
6
+ * @endpoint POST /v1/agents/help
7
+ * @endpoint POST /v1/help
8
+ * @usedBySchema HelpCitationSchema
9
+ * @contractShape billing.access-type
10
+ * @contractRole canonical
11
+ */
12
+ export declare const BillingAccessTypeSchema: z.ZodEnum<{
13
+ DAILY_ALLOWANCE: "DAILY_ALLOWANCE";
14
+ PAID_PLAN: "PAID_PLAN";
15
+ }>;
16
+ export type BillingAccessType = z.infer<typeof BillingAccessTypeSchema>;
17
+ //# sourceMappingURL=access-type.d.ts.map
@@ -0,0 +1,14 @@
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
+ /**
4
+ * What a caller without a paid plan gets. `PAID_PLAN`: nothing; the operation answers 402 subscription_required until the caller subscribes. `DAILY_ALLOWANCE`: a free UTC-day allowance, then 402 subscription_required until it refills.
5
+ *
6
+ * @openapiSchema BillingAccessType
7
+ * @endpoint POST /v1/agents/help
8
+ * @endpoint POST /v1/help
9
+ * @usedBySchema HelpCitationSchema
10
+ * @contractShape billing.access-type
11
+ * @contractRole canonical
12
+ */
13
+ export const BillingAccessTypeSchema = z.enum(["PAID_PLAN", "DAILY_ALLOWANCE"]);
14
+ //# sourceMappingURL=access-type.js.map
@@ -9,11 +9,11 @@ const BillingCatalogPlanSchemaDefinition = z.object({
9
9
  /** ISO 4217 currency code. */
10
10
  currency: z.string(),
11
11
  displayName: z.string(),
12
- /** First invoice amount when an automatic, one-time Checkout offer is available; absent otherwise. Renewals use unitAmount. */
12
+ /** First invoice amount in currency minor units (USD cents) when an automatic, one-time Checkout offer is available; absent otherwise. Renewals use unitAmount. */
13
13
  introductoryAmount: z.number().int().nullish(),
14
14
  plan: BillingPlanTypeSchema,
15
15
  tier: z.enum(["ESSENTIAL", "PLUS", "PRO", "UNLIMITED"]),
16
- /** Price per cadence in the currency's minor unit, such as cents. */
16
+ /** Price per cadence in currency minor units, not major units: USD cents (4900 means USD 49.00). */
17
17
  unitAmount: z.number().int(),
18
18
  });
19
19
  /**
@@ -85,7 +85,7 @@ export const EntityListFilterSchema = z.strictObject({
85
85
  qualityGate: EntityListQualityGateSchema.optional(),
86
86
  /** Rank most prominent first (funding, stage, headcount, momentum, recent news, investor breadth), ahead of sort: what best, top, or most promising mean. */
87
87
  rankByProminence: z.boolean().nullish(),
88
- /** Free-text semantic search phrase, this body's query text (there is no query field), such as "AI tools for dental clinics". To find one company by name, send entityName instead. Executable on POST /v1/entities/search; saved views persist it for replay. A semantic page ranks a bounded nearest-neighbor window: totalElements counts the ranked candidates reachable through continuation, not every matching entity. */
88
+ /** Free-text semantic search phrase, this body's query text (there is no query field), such as "AI tools for dental clinics". To filter this search to companies by name, send this body's entityName field instead; to identify one record from a name, call lookupRecord (POST /v1/lookup) with name, which accepts no entityName. Executable on POST /v1/entities/search; saved views persist it for replay. A semantic page ranks a bounded nearest-neighbor window: totalElements counts the ranked candidates reachable through continuation, not every matching entity. */
89
89
  semanticQuery: z.string().nullish(),
90
90
  /** Restrict results to entity slugs. */
91
91
  slug: z
@@ -7110,12 +7110,14 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
7110
7110
  profile: {
7111
7111
  currentCompany?: string | null | undefined;
7112
7112
  headline?: string | null | undefined;
7113
+ id: string;
7113
7114
  location?: string | null | undefined;
7114
7115
  name: string;
7115
7116
  named: string;
7116
7117
  organizationEvidence?: "headline" | "none" | "profile" | null | undefined;
7117
7118
  photoUrl?: string | null | undefined;
7118
7119
  profileUrl: string;
7120
+ slug: string;
7119
7121
  }[];
7120
7122
  result: {
7121
7123
  content: {
@@ -7487,12 +7489,14 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
7487
7489
  profile: {
7488
7490
  currentCompany?: string | null | undefined;
7489
7491
  headline?: string | null | undefined;
7492
+ id: string;
7490
7493
  location?: string | null | undefined;
7491
7494
  name: string;
7492
7495
  named: string;
7493
7496
  organizationEvidence?: "headline" | "none" | "profile" | null | undefined;
7494
7497
  photoUrl?: string | null | undefined;
7495
7498
  profileUrl: string;
7499
+ slug: string;
7496
7500
  }[];
7497
7501
  result: {
7498
7502
  content: {
@@ -1,5 +1,9 @@
1
1
  import { z } from "zod/v4";
2
2
  declare const HelpCitationSchemaDefinition: z.ZodObject<{
3
+ billingAccess: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
4
+ DAILY_ALLOWANCE: "DAILY_ALLOWANCE";
5
+ PAID_PLAN: "PAID_PLAN";
6
+ }>>>;
3
7
  excerpt: z.ZodString;
4
8
  sourceId: z.ZodString;
5
9
  sourceType: z.ZodUnion<readonly [z.ZodEnum<{
@@ -1,7 +1,10 @@
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
+ import { BillingAccessTypeSchema } from "../billing/access-type.js";
3
4
  import { HelpSourceTypeSchema } from "./source-type.js";
4
5
  const HelpCitationSchemaDefinition = z.object({
6
+ /** What a caller without a paid plan gets from the cited operation; absent when the operation needs no plan. A resolve for such a caller ranks PAID_PLAN candidates after the others. */
7
+ billingAccess: BillingAccessTypeSchema.nullish(),
5
8
  /** Verbatim excerpt from the cited document supporting the answer. */
6
9
  excerpt: z.string(),
7
10
  /** Stable id within the source type: an operationId, a skill/prompt name, a completion gate id, or a research detail type targetPath. */
@@ -11,11 +11,13 @@ import { z } from "zod/v4";
11
11
  */
12
12
  export declare const HelpResolutionSchema: z.ZodObject<{
13
13
  candidate: z.ZodArray<z.ZodType<{
14
+ billingAccess?: "DAILY_ALLOWANCE" | "PAID_PLAN" | null | undefined;
14
15
  excerpt: string;
15
16
  sourceId: string;
16
17
  sourceType: string;
17
18
  sourceVersion?: string | null | undefined;
18
19
  }, import("./citation.ts").HelpCitationSchemaInput, z.core.$ZodTypeInternals<{
20
+ billingAccess?: "DAILY_ALLOWANCE" | "PAID_PLAN" | null | undefined;
19
21
  excerpt: string;
20
22
  sourceId: string;
21
23
  sourceType: string;
@@ -3761,12 +3761,14 @@ declare const LinkSearchSchemaDefinition: z.ZodObject<{
3761
3761
  profile: {
3762
3762
  currentCompany?: string | null | undefined;
3763
3763
  headline?: string | null | undefined;
3764
+ id: string;
3764
3765
  location?: string | null | undefined;
3765
3766
  name: string;
3766
3767
  named: string;
3767
3768
  organizationEvidence?: "headline" | "none" | "profile" | null | undefined;
3768
3769
  photoUrl?: string | null | undefined;
3769
3770
  profileUrl: string;
3771
+ slug: string;
3770
3772
  }[];
3771
3773
  result: {
3772
3774
  content: {
@@ -8415,12 +8417,14 @@ declare const LinkSearchSchemaDefinition: z.ZodObject<{
8415
8417
  profile: {
8416
8418
  currentCompany?: string | null | undefined;
8417
8419
  headline?: string | null | undefined;
8420
+ id: string;
8418
8421
  location?: string | null | undefined;
8419
8422
  name: string;
8420
8423
  named: string;
8421
8424
  organizationEvidence?: "headline" | "none" | "profile" | null | undefined;
8422
8425
  photoUrl?: string | null | undefined;
8423
8426
  profileUrl: string;
8427
+ slug: string;
8424
8428
  }[];
8425
8429
  result: {
8426
8430
  content: {
@@ -51,6 +51,7 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
51
51
  modulePath: "auth/provider-catalog",
52
52
  schemaName: "AuthProviderCatalogSchema",
53
53
  },
54
+ BillingAccessType: { modulePath: "billing/access-type", schemaName: "BillingAccessTypeSchema" },
54
55
  BillingAdditionalUsage: {
55
56
  modulePath: "billing/additional-usage",
56
57
  schemaName: "BillingAdditionalUsageSchema",
@@ -639,21 +639,25 @@ declare const PersonNaturalSearchResultSchemaDefinition: z.ZodObject<{
639
639
  profile: z.ZodArray<z.ZodType<{
640
640
  currentCompany?: string | null | undefined;
641
641
  headline?: string | null | undefined;
642
+ id: string;
642
643
  location?: string | null | undefined;
643
644
  name: string;
644
645
  named: string;
645
646
  organizationEvidence?: "headline" | "none" | "profile" | null | undefined;
646
647
  photoUrl?: string | null | undefined;
647
648
  profileUrl: string;
649
+ slug: string;
648
650
  }, import("../search/person-profile.ts").SearchPersonProfileSchemaInput, z.core.$ZodTypeInternals<{
649
651
  currentCompany?: string | null | undefined;
650
652
  headline?: string | null | undefined;
653
+ id: string;
651
654
  location?: string | null | undefined;
652
655
  name: string;
653
656
  named: string;
654
657
  organizationEvidence?: "headline" | "none" | "profile" | null | undefined;
655
658
  photoUrl?: string | null | undefined;
656
659
  profileUrl: string;
660
+ slug: string;
657
661
  }, import("../search/person-profile.ts").SearchPersonProfileSchemaInput>>>;
658
662
  result: z.ZodType<{
659
663
  content: {
@@ -9,7 +9,7 @@ const PersonNaturalSearchResultSchemaDefinition = z.object({
9
9
  interpretation: PersonSearchInterpretationSchema,
10
10
  /** Personal investment participation supporting the returned people. Firm portfolio activity is never attributed to employees. Empty for other question intents. */
11
11
  investment: z.array(SearchInvestmentSchema),
12
- /** Public LinkedIn profiles a web search found for people the query names whom no returned person matches, grouped by `named` in query order. A search that has not run yet runs only for a signed-in subscriber with `layer=web`. */
12
+ /** aVenture people resolved or filed from web-discovered LinkedIn profiles whom no returned person matches, grouped by `named` in query order. A search that has not run yet runs only for a signed-in subscriber with `layer=web`. */
13
13
  profile: z.array(SearchPersonProfileSchema),
14
14
  /** Person page returned by the canonical person list engine. */
15
15
  result: PageResultPersonSchema,
@@ -2,6 +2,7 @@ import { z } from "zod/v4";
2
2
  declare const SearchPersonProfileSchemaDefinition: z.ZodObject<{
3
3
  currentCompany: z.ZodOptional<z.ZodNullable<z.ZodString>>;
4
4
  headline: z.ZodOptional<z.ZodNullable<z.ZodString>>;
5
+ id: z.ZodUUID;
5
6
  location: z.ZodOptional<z.ZodNullable<z.ZodString>>;
6
7
  name: z.ZodString;
7
8
  named: z.ZodString;
@@ -12,12 +13,13 @@ declare const SearchPersonProfileSchemaDefinition: z.ZodObject<{
12
13
  }>>>;
13
14
  photoUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
14
15
  profileUrl: z.ZodString;
16
+ slug: z.ZodString;
15
17
  }, z.core.$strip>;
16
18
  type SearchPersonProfileDefinition = z.infer<typeof SearchPersonProfileSchemaDefinition>;
17
19
  export interface SearchPersonProfileSchemaInput extends z.input<typeof SearchPersonProfileSchemaDefinition> {
18
20
  }
19
21
  /**
20
- * Public LinkedIn profile a search found for a person the query names who has no directory record. It shows the profile's own header; it does not assert current employment.
22
+ * A person resolved or filed from a web-discovered LinkedIn profile. Every row links to its aVenture person page; the web header does not assert current employment.
21
23
  *
22
24
  * @openapiSchema SearchPersonProfile
23
25
  * @endpoint GET /v1/search/link
@@ -5,6 +5,8 @@ const SearchPersonProfileSchemaDefinition = z.object({
5
5
  currentCompany: z.string().nullish(),
6
6
  /** Profile headline as the web search index holds it; null when it has none. */
7
7
  headline: z.string().nullish(),
8
+ /** Canonical aVenture person id. */
9
+ id: z.uuid(),
8
10
  /** Profile location as the web search index holds it. */
9
11
  location: z.string().nullish(),
10
12
  /** Name on the profile. */
@@ -15,11 +17,16 @@ const SearchPersonProfileSchemaDefinition = z.object({
15
17
  organizationEvidence: z.enum(["headline", "profile", "none"]).nullish(),
16
18
  /** Headshot URL from aVenture's stored LinkedIn capture; null until one is stored or when the capture holds no usable headshot. */
17
19
  photoUrl: z.string().nullish(),
18
- /** Canonical public LinkedIn profile URL. */
20
+ /** Canonical aVenture person page URL; never an external profile URL. */
19
21
  profileUrl: z.string(),
22
+ /** Canonical aVenture person slug. */
23
+ slug: z
24
+ .string()
25
+ .regex(/^[a-z0-9_-]+$/)
26
+ .max(255),
20
27
  });
21
28
  /**
22
- * Public LinkedIn profile a search found for a person the query names who has no directory record. It shows the profile's own header; it does not assert current employment.
29
+ * A person resolved or filed from a web-discovered LinkedIn profile. Every row links to its aVenture person page; the web header does not assert current employment.
23
30
  *
24
31
  * @openapiSchema SearchPersonProfile
25
32
  * @endpoint GET /v1/search/link
@@ -3772,12 +3772,14 @@ declare const SharedSearchSchemaDefinition: z.ZodObject<{
3772
3772
  profile: {
3773
3773
  currentCompany?: string | null | undefined;
3774
3774
  headline?: string | null | undefined;
3775
+ id: string;
3775
3776
  location?: string | null | undefined;
3776
3777
  name: string;
3777
3778
  named: string;
3778
3779
  organizationEvidence?: "headline" | "none" | "profile" | null | undefined;
3779
3780
  photoUrl?: string | null | undefined;
3780
3781
  profileUrl: string;
3782
+ slug: string;
3781
3783
  }[];
3782
3784
  result: {
3783
3785
  content: {
@@ -8426,12 +8428,14 @@ declare const SharedSearchSchemaDefinition: z.ZodObject<{
8426
8428
  profile: {
8427
8429
  currentCompany?: string | null | undefined;
8428
8430
  headline?: string | null | undefined;
8431
+ id: string;
8429
8432
  location?: string | null | undefined;
8430
8433
  name: string;
8431
8434
  named: string;
8432
8435
  organizationEvidence?: "headline" | "none" | "profile" | null | undefined;
8433
8436
  photoUrl?: string | null | undefined;
8434
8437
  profileUrl: string;
8438
+ slug: string;
8435
8439
  }[];
8436
8440
  result: {
8437
8441
  content: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aventurevc/api-schemas",
3
- "version": "0.8.222",
3
+ "version": "0.8.223",
4
4
  "private": false,
5
5
  "description": "Zod v4 schemas and TypeScript types for the aVenture API.",
6
6
  "license": "Apache-2.0",