@aventurevc/api-schemas 0.8.408 → 0.8.410

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.
@@ -4,6 +4,7 @@ declare const BillingCatalogPlanSchemaDefinition: z.ZodObject<{
4
4
  cadence: z.ZodString;
5
5
  currency: z.ZodString;
6
6
  displayName: z.ZodString;
7
+ freeTrialDays: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
7
8
  introductoryAmount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
8
9
  plan: z.ZodUnion<readonly [z.ZodEnum<{
9
10
  PLUS_MONTHLY: "PLUS_MONTHLY";
@@ -9,6 +9,8 @@ const BillingCatalogPlanSchemaDefinition = z.object({
9
9
  /** ISO 4217 currency code. */
10
10
  currency: z.string(),
11
11
  displayName: z.string(),
12
+ /** Free trial duration in days for a new Stripe Checkout on the Customer's first transaction; absent when this plan has no free trial. Payment details are required; the plan automatically renews at unitAmount per cadence afterward. Existing subscription changes receive no trial. App Store eligibility and offers come from StoreKit separately. */
13
+ freeTrialDays: z.int().nullish(),
12
14
  /** First invoice amount in currency minor units (USD cents) when an automatic, one-time Checkout offer is available; absent otherwise. Renewals use unitAmount. */
13
15
  introductoryAmount: z.number().int().nullish(),
14
16
  plan: BillingPlanTypeSchema,
@@ -22,6 +22,7 @@ declare const BillingCatalogSchemaDefinition: z.ZodObject<{
22
22
  cadence: string;
23
23
  currency: string;
24
24
  displayName: string;
25
+ freeTrialDays?: number | null | undefined;
25
26
  introductoryAmount?: number | null | undefined;
26
27
  plan: string;
27
28
  tier: "ESSENTIAL" | "PLUS" | "PRO" | "UNLIMITED";
@@ -31,6 +32,7 @@ declare const BillingCatalogSchemaDefinition: z.ZodObject<{
31
32
  cadence: string;
32
33
  currency: string;
33
34
  displayName: string;
35
+ freeTrialDays?: number | null | undefined;
34
36
  introductoryAmount?: number | null | undefined;
35
37
  plan: string;
36
38
  tier: "ESSENTIAL" | "PLUS" | "PRO" | "UNLIMITED";
@@ -1,5 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  declare const BillingPaymentProfileSchemaDefinition: z.ZodObject<{
3
+ freeTrialEligible: z.ZodOptional<z.ZodBoolean>;
3
4
  introductoryOfferEligible: z.ZodBoolean;
4
5
  paymentMethod: z.ZodOptional<z.ZodNullable<z.ZodObject<{
5
6
  brand: z.ZodString;
@@ -12,7 +13,7 @@ type BillingPaymentProfileDefinition = z.infer<typeof BillingPaymentProfileSchem
12
13
  export interface BillingPaymentProfileSchemaInput extends z.input<typeof BillingPaymentProfileSchemaDefinition> {
13
14
  }
14
15
  /**
15
- * The caller's card on file and whether its next purchase of, or upgrade to, a plan with an introductoryAmount is charged that amount, read live from Stripe.
16
+ * The caller's card on file, paid introductory discount eligibility, and eligibility for a free trial on a new Stripe Checkout, read live from Stripe.
16
17
  *
17
18
  * @openapiSchema BillingPaymentProfile
18
19
  * @endpoint GET /v1/billing/subscription/payment-profile
@@ -2,13 +2,15 @@
2
2
  import { z } from "zod/v4";
3
3
  import { BillingPaymentMethodSchema } from "./payment-method.js";
4
4
  const BillingPaymentProfileSchemaDefinition = z.object({
5
+ /** Whether a new Stripe Checkout for a plan with freeTrialDays receives its free trial: the App Store does not bill the account and its Stripe Customer has no prior subscription, successful payment, or non-void invoice. An account without a Stripe Customer is eligible. This is Stripe history eligibility, not a guarantee of one trial across payment providers; plan changes are excluded. Absent on servers released before free-trial eligibility was introduced. */
6
+ freeTrialEligible: z.boolean().optional(),
5
7
  /** Whether the caller's next purchase or upgrade to a plan with an introductoryAmount is charged that amount: true when the catalog offers introductoryAmount, the App Store does not bill the account, and either it has no earlier subscription, payment, or unvoided invoice, or it pays an active subscription on a cheaper sold plan and has never redeemed the introductory discount; false otherwise */
6
8
  introductoryOfferEligible: z.boolean(),
7
9
  /** Card that pays the continuing Stripe subscription; absent without one or when it is paid by something other than a card */
8
10
  paymentMethod: BillingPaymentMethodSchema.nullish(),
9
11
  });
10
12
  /**
11
- * The caller's card on file and whether its next purchase of, or upgrade to, a plan with an introductoryAmount is charged that amount, read live from Stripe.
13
+ * The caller's card on file, paid introductory discount eligibility, and eligibility for a free trial on a new Stripe Checkout, read live from Stripe.
12
14
  *
13
15
  * @openapiSchema BillingPaymentProfile
14
16
  * @endpoint GET /v1/billing/subscription/payment-profile
@@ -0,0 +1,30 @@
1
+ import { z } from "zod/v4";
2
+ /**
3
+ * Result section a search page renders: people; companies (operating companies, business lines, nonprofits, and governments); products and services; or investors (investment firms and funds).
4
+ *
5
+ * @openapiSchema FederatedSearchSection
6
+ * @endpoint GET /v1/search/link
7
+ * @endpoint GET /v1/search/link/jobs/{jobId}
8
+ * @endpoint GET /v1/search/shared/{id}
9
+ * @endpoint GET /v1/search/shared/slug/{slug}
10
+ * @endpoint POST /v1/search
11
+ * @endpoint POST /v1/search/shared
12
+ * @usedBySchema FederatedSearchSchema
13
+ * @contractShape federated.search-section
14
+ * @contractRole canonical
15
+ */
16
+ export declare const FederatedSearchSectionSchema: z.ZodUnion<readonly [z.ZodEnum<{
17
+ company: "company";
18
+ investor: "investor";
19
+ person: "person";
20
+ productService: "productService";
21
+ }>, z.ZodString]> & {
22
+ enum: {
23
+ company: "company";
24
+ investor: "investor";
25
+ person: "person";
26
+ productService: "productService";
27
+ };
28
+ };
29
+ export type FederatedSearchSection = z.infer<typeof FederatedSearchSectionSchema>;
30
+ //# sourceMappingURL=search-section.d.ts.map
@@ -0,0 +1,24 @@
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 FederatedSearchSectionSchemaKnownMembers = z.enum([
4
+ "person",
5
+ "company",
6
+ "productService",
7
+ "investor",
8
+ ]);
9
+ /**
10
+ * Result section a search page renders: people; companies (operating companies, business lines, nonprofits, and governments); products and services; or investors (investment firms and funds).
11
+ *
12
+ * @openapiSchema FederatedSearchSection
13
+ * @endpoint GET /v1/search/link
14
+ * @endpoint GET /v1/search/link/jobs/{jobId}
15
+ * @endpoint GET /v1/search/shared/{id}
16
+ * @endpoint GET /v1/search/shared/slug/{slug}
17
+ * @endpoint POST /v1/search
18
+ * @endpoint POST /v1/search/shared
19
+ * @usedBySchema FederatedSearchSchema
20
+ * @contractShape federated.search-section
21
+ * @contractRole canonical
22
+ */
23
+ export const FederatedSearchSectionSchema = Object.assign(z.union([FederatedSearchSectionSchemaKnownMembers, z.string()]), { enum: FederatedSearchSectionSchemaKnownMembers.enum });
24
+ //# sourceMappingURL=search-section.js.map
@@ -14556,12 +14556,19 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
14556
14556
  }, import("../search/qualifier-option.ts").SearchQualifierOptionSchemaInput>>>;
14557
14557
  prompt: z.ZodString;
14558
14558
  }, z.core.$strip>>>;
14559
- section: z.ZodOptional<z.ZodArray<z.ZodEnum<{
14559
+ section: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodEnum<{
14560
14560
  company: "company";
14561
14561
  investor: "investor";
14562
14562
  person: "person";
14563
14563
  productService: "productService";
14564
- }>>>;
14564
+ }>, z.ZodString]> & {
14565
+ enum: {
14566
+ company: "company";
14567
+ investor: "investor";
14568
+ person: "person";
14569
+ productService: "productService";
14570
+ };
14571
+ }>>;
14565
14572
  }, z.core.$strip>;
14566
14573
  type FederatedSearchDefinition = z.infer<typeof FederatedSearchSchemaDefinition>;
14567
14574
  export interface FederatedSearchSchemaInput extends z.input<typeof FederatedSearchSchemaDefinition> {
@@ -2,6 +2,7 @@
2
2
  import { z } from "zod/v4";
3
3
  import { EntityDetailSchema } from "../entity/detail.js";
4
4
  import { FederatedSearchProvenanceSchema } from "./search-provenance.js";
5
+ import { FederatedSearchSectionSchema } from "./search-section.js";
5
6
  import { NaturalSearchResultSchema } from "../natural/search-result.js";
6
7
  import { NewsEntityMentionSchema } from "../news/entity-mention.js";
7
8
  import { PageResultNewsSchema } from "../pagination/schemas.js";
@@ -28,7 +29,7 @@ const FederatedSearchSchemaDefinition = z.object({
28
29
  /** A prompt with rewritten queries offered beside a broad query's results, from the search catalog revision the search read; null when no qualifier rule matches. */
29
30
  qualifier: SearchQualifierSchema.nullish(),
30
31
  /** Result sections from most to least relevant. People lead when `personLead` is true and come last otherwise. Companies, products and services, and investors follow the rank of each section's best entity row, so a name whose best match is an investment firm leads with investors; sections with no entity row follow in that same fixed order. */
31
- section: z.array(z.enum(["person", "company", "productService", "investor"])).optional(),
32
+ section: z.array(FederatedSearchSectionSchema).optional(),
32
33
  });
33
34
  /**
34
35
  * Combined entity, person, and news search results, each from that record type's own search, with the search method used for each.
@@ -210,7 +210,7 @@ export const ProblemDetailSchema = z.object({
210
210
  detail: z.string().optional(),
211
211
  /** Structured conflict details. A possible duplicate or an ambiguous lookup returns its candidate records; score and threshold rank the candidates and do not prove that the requested record is absent. */
212
212
  details: DomainConflictDetailsSchema.nullish(),
213
- /** Whether a service-unavailable failure can be retried. */
213
+ /** Whether this classified failure can be retried. */
214
214
  disposition: z.enum(["TRANSIENT", "TERMINAL"]).nullish(),
215
215
  error: z.record(z.string(), z.string()).nullish(),
216
216
  /** On a duplicate 409, the id of the stored record the request collided with; read or update that record instead of creating it again. Absent when the conflict names no single stored record. */
@@ -7332,7 +7332,7 @@ declare const LinkSearchSchemaDefinition: z.ZodObject<{
7332
7332
  }[];
7333
7333
  prompt: string;
7334
7334
  } | null | undefined;
7335
- section?: ("company" | "investor" | "person" | "productService")[] | undefined;
7335
+ section?: string[] | undefined;
7336
7336
  }, import("../federated/search.ts").FederatedSearchSchemaInput, z.core.$ZodTypeInternals<{
7337
7337
  entity: {
7338
7338
  answer?: {
@@ -14664,7 +14664,7 @@ declare const LinkSearchSchemaDefinition: z.ZodObject<{
14664
14664
  }[];
14665
14665
  prompt: string;
14666
14666
  } | null | undefined;
14667
- section?: ("company" | "investor" | "person" | "productService")[] | undefined;
14667
+ section?: string[] | undefined;
14668
14668
  }, import("../federated/search.ts").FederatedSearchSchemaInput>>;
14669
14669
  url: z.ZodString;
14670
14670
  }, z.core.$strip>;
@@ -660,6 +660,10 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
660
660
  modulePath: "federated/search-rejection",
661
661
  schemaName: "FederatedSearchRejectionSchema",
662
662
  },
663
+ FederatedSearchSection: {
664
+ modulePath: "federated/search-section",
665
+ schemaName: "FederatedSearchSectionSchema",
666
+ },
663
667
  FundingApplicability: {
664
668
  modulePath: "funding/applicability",
665
669
  schemaName: "FundingApplicabilitySchema",
@@ -7343,7 +7343,7 @@ declare const SharedSearchSchemaDefinition: z.ZodObject<{
7343
7343
  }[];
7344
7344
  prompt: string;
7345
7345
  } | null | undefined;
7346
- section?: ("company" | "investor" | "person" | "productService")[] | undefined;
7346
+ section?: string[] | undefined;
7347
7347
  }, import("../federated/search.ts").FederatedSearchSchemaInput, z.core.$ZodTypeInternals<{
7348
7348
  entity: {
7349
7349
  answer?: {
@@ -14675,7 +14675,7 @@ declare const SharedSearchSchemaDefinition: z.ZodObject<{
14675
14675
  }[];
14676
14676
  prompt: string;
14677
14677
  } | null | undefined;
14678
- section?: ("company" | "investor" | "person" | "productService")[] | undefined;
14678
+ section?: string[] | undefined;
14679
14679
  }, import("../federated/search.ts").FederatedSearchSchemaInput>>;
14680
14680
  }, z.core.$strip>;
14681
14681
  type SharedSearchDefinition = z.infer<typeof SharedSearchSchemaDefinition>;
@@ -32,7 +32,7 @@ export const UniqueIdMutationSchema = z.object({
32
32
  listingStanding: UniqueIdListingStandingSchema.nullish(),
33
33
  /** Source-stated ticker share class; never inferred from the symbol. */
34
34
  shareClass: z.string().nullish(),
35
- /** Optional attribution source label for the mapping. */
35
+ /** Optional attribution source label for the mapping; at most 100 Unicode code points after trimming surrounding whitespace. Blank labels are stored as null. */
36
36
  source: z.string().nullish(),
37
37
  /** Date from which the source says this listing standing applies, at the precision supplied. */
38
38
  standingAsOf: z
@@ -44,6 +44,7 @@ export declare const UniqueIdTypeSchema: z.ZodUnion<readonly [z.ZodEnum<{
44
44
  isin: "isin";
45
45
  israelCompanyNumber: "israelCompanyNumber";
46
46
  japanCryptoAssetExchangeRegistration: "japanCryptoAssetExchangeRegistration";
47
+ koreaBusinessRegistrationNumber: "koreaBusinessRegistrationNumber";
47
48
  lei: "lei";
48
49
  naicCompanyCode: "naicCompanyCode";
49
50
  ncesLeaId: "ncesLeaId";
@@ -60,10 +61,12 @@ export declare const UniqueIdTypeSchema: z.ZodUnion<readonly [z.ZodEnum<{
60
61
  signalNfxCompany: "signalNfxCompany";
61
62
  signalNfxFirm: "signalNfxFirm";
62
63
  signalNfxPerson: "signalNfxPerson";
64
+ swissUid: "swissUid";
63
65
  ticker: "ticker";
64
66
  ukCompanyNumber: "ukCompanyNumber";
65
67
  ukraineEdrpou: "ukraineEdrpou";
66
68
  usptoPractitioner: "usptoPractitioner";
69
+ vietnamTaxCode: "vietnamTaxCode";
67
70
  }>, z.ZodString]> & {
68
71
  enum: {
69
72
  belgiumEnterpriseNumber: "belgiumEnterpriseNumber";
@@ -85,6 +88,7 @@ export declare const UniqueIdTypeSchema: z.ZodUnion<readonly [z.ZodEnum<{
85
88
  isin: "isin";
86
89
  israelCompanyNumber: "israelCompanyNumber";
87
90
  japanCryptoAssetExchangeRegistration: "japanCryptoAssetExchangeRegistration";
91
+ koreaBusinessRegistrationNumber: "koreaBusinessRegistrationNumber";
88
92
  lei: "lei";
89
93
  naicCompanyCode: "naicCompanyCode";
90
94
  ncesLeaId: "ncesLeaId";
@@ -101,10 +105,12 @@ export declare const UniqueIdTypeSchema: z.ZodUnion<readonly [z.ZodEnum<{
101
105
  signalNfxCompany: "signalNfxCompany";
102
106
  signalNfxFirm: "signalNfxFirm";
103
107
  signalNfxPerson: "signalNfxPerson";
108
+ swissUid: "swissUid";
104
109
  ticker: "ticker";
105
110
  ukCompanyNumber: "ukCompanyNumber";
106
111
  ukraineEdrpou: "ukraineEdrpou";
107
112
  usptoPractitioner: "usptoPractitioner";
113
+ vietnamTaxCode: "vietnamTaxCode";
108
114
  };
109
115
  };
110
116
  export type UniqueIdType = z.infer<typeof UniqueIdTypeSchema>;
@@ -13,6 +13,9 @@ const UniqueIdTypeSchemaKnownMembers = z.enum([
13
13
  "chinaUnifiedSocialCreditCode",
14
14
  "indiaCin",
15
15
  "brazilCnpj",
16
+ "koreaBusinessRegistrationNumber",
17
+ "swissUid",
18
+ "vietnamTaxCode",
16
19
  "ticker",
17
20
  "lei",
18
21
  "duns",
@@ -25,6 +25,7 @@ declare const UniqueIdSchemaDefinition: z.ZodObject<{
25
25
  isin: "isin";
26
26
  israelCompanyNumber: "israelCompanyNumber";
27
27
  japanCryptoAssetExchangeRegistration: "japanCryptoAssetExchangeRegistration";
28
+ koreaBusinessRegistrationNumber: "koreaBusinessRegistrationNumber";
28
29
  lei: "lei";
29
30
  naicCompanyCode: "naicCompanyCode";
30
31
  ncesLeaId: "ncesLeaId";
@@ -41,10 +42,12 @@ declare const UniqueIdSchemaDefinition: z.ZodObject<{
41
42
  signalNfxCompany: "signalNfxCompany";
42
43
  signalNfxFirm: "signalNfxFirm";
43
44
  signalNfxPerson: "signalNfxPerson";
45
+ swissUid: "swissUid";
44
46
  ticker: "ticker";
45
47
  ukCompanyNumber: "ukCompanyNumber";
46
48
  ukraineEdrpou: "ukraineEdrpou";
47
49
  usptoPractitioner: "usptoPractitioner";
50
+ vietnamTaxCode: "vietnamTaxCode";
48
51
  }>, z.ZodString]> & {
49
52
  enum: {
50
53
  belgiumEnterpriseNumber: "belgiumEnterpriseNumber";
@@ -66,6 +69,7 @@ declare const UniqueIdSchemaDefinition: z.ZodObject<{
66
69
  isin: "isin";
67
70
  israelCompanyNumber: "israelCompanyNumber";
68
71
  japanCryptoAssetExchangeRegistration: "japanCryptoAssetExchangeRegistration";
72
+ koreaBusinessRegistrationNumber: "koreaBusinessRegistrationNumber";
69
73
  lei: "lei";
70
74
  naicCompanyCode: "naicCompanyCode";
71
75
  ncesLeaId: "ncesLeaId";
@@ -82,10 +86,12 @@ declare const UniqueIdSchemaDefinition: z.ZodObject<{
82
86
  signalNfxCompany: "signalNfxCompany";
83
87
  signalNfxFirm: "signalNfxFirm";
84
88
  signalNfxPerson: "signalNfxPerson";
89
+ swissUid: "swissUid";
85
90
  ticker: "ticker";
86
91
  ukCompanyNumber: "ukCompanyNumber";
87
92
  ukraineEdrpou: "ukraineEdrpou";
88
93
  usptoPractitioner: "usptoPractitioner";
94
+ vietnamTaxCode: "vietnamTaxCode";
89
95
  };
90
96
  };
91
97
  listingStanding: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodEnum<{
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aventurevc/api-schemas",
3
- "version": "0.8.408",
3
+ "version": "0.8.410",
4
4
  "private": false,
5
5
  "description": "Zod v4 schemas and TypeScript types for the aVenture API.",
6
6
  "license": "Apache-2.0",