@aventurevc/api-schemas 0.8.131 → 0.8.132

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.
@@ -886,6 +886,10 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
886
886
  SearchPassage: { modulePath: "search/passage", schemaName: "SearchPassageSchema" },
887
887
  SearchRelevance: { modulePath: "search/relevance", schemaName: "SearchRelevanceSchema" },
888
888
  SecCompany: { modulePath: "sec/company", schemaName: "SecCompanySchema" },
889
+ SecListingProspectus: {
890
+ modulePath: "sec/listing-prospectus",
891
+ schemaName: "SecListingProspectusSchema",
892
+ },
889
893
  SharedSearch: { modulePath: "shared/search", schemaName: "SharedSearchSchema" },
890
894
  SharedSearchList: { modulePath: "shared/search-list", schemaName: "SharedSearchListSchema" },
891
895
  SharedSearchMutation: {
@@ -5,6 +5,7 @@ declare const SecCompanySchemaDefinition: z.ZodObject<{
5
5
  entityType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
6
6
  exchange: z.ZodArray<z.ZodString>;
7
7
  filerCategory: z.ZodOptional<z.ZodNullable<z.ZodString>>;
8
+ filingHistoryStart: z.ZodOptional<z.ZodNullable<z.ZodISODate>>;
8
9
  fiscalYearEnd: z.ZodOptional<z.ZodNullable<z.ZodString>>;
9
10
  headquartersCity: z.ZodOptional<z.ZodNullable<z.ZodString>>;
10
11
  headquartersCountry: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -12,6 +13,12 @@ declare const SecCompanySchemaDefinition: z.ZodObject<{
12
13
  headquartersState: z.ZodOptional<z.ZodNullable<z.ZodString>>;
13
14
  headquartersStreet: z.ZodOptional<z.ZodNullable<z.ZodString>>;
14
15
  isOperating: z.ZodBoolean;
16
+ listingProspectus: z.ZodOptional<z.ZodNullable<z.ZodObject<{
17
+ accessionNumber: z.ZodString;
18
+ documentUrl: z.ZodString;
19
+ filingDate: z.ZodISODate;
20
+ form: z.ZodString;
21
+ }, z.core.$strip>>>;
15
22
  matchedVia: z.ZodEnum<{
16
23
  NAME: "NAME";
17
24
  TICKER: "TICKER";
@@ -1,5 +1,6 @@
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 { SecListingProspectusSchema } from "./listing-prospectus.js";
3
4
  const SecCompanySchemaDefinition = z.object({
4
5
  /** SEC Central Index Key, 10-digit zero-padded. The stable cross-sync join key. */
5
6
  cik: z.string(),
@@ -11,6 +12,8 @@ const SecCompanySchemaDefinition = z.object({
11
12
  exchange: z.array(z.string()),
12
13
  /** SEC filer size category. */
13
14
  filerCategory: z.string().nullish(),
15
+ /** Date of the registrant's earliest EDGAR filing. EDGAR filing became mandatory for all registrants in May 1996, so a listing before this date predates the electronic record. */
16
+ filingHistoryStart: z.iso.date().nullish(),
14
17
  /** Fiscal year-end as MMDD. */
15
18
  fiscalYearEnd: z.string().nullish(),
16
19
  /** Headquarters city from the SEC business address. */
@@ -25,13 +28,15 @@ const SecCompanySchemaDefinition = z.object({
25
28
  headquartersStreet: z.string().nullish(),
26
29
  /** True when SEC classifies this registrant as an operating company, false for a SPAC/trust/holding/shell vehicle. */
27
30
  isOperating: z.boolean(),
31
+ /** The registrant's IPO prospectus: its first final prospectus (Form 424B4 or 424B1), reported only when an offering registration statement (S-1, F-1, SB-2, S-11) precedes it and no annual or quarterly report does. Null when EDGAR shows no such prospectus, including every company that listed before its EDGAR history starts and every follow-on offering. */
32
+ listingProspectus: SecListingProspectusSchema.nullish(),
28
33
  /** How the query resolved to this registrant. */
29
34
  matchedVia: z.enum(["TICKER", "NAME"]),
30
35
  /** Former registered legal names from SEC `formerNames`, most recent first. */
31
36
  nameAlias: z.array(z.string()),
32
37
  /** Registered legal name from SEC filings. */
33
38
  nameLegal: z.string(),
34
- /** Other registrants whose name also matched the query (legal names). Empty for an exact ticker resolution; non-empty signals an ambiguous name query. */
39
+ /** Other registrants whose title also contains the name query (legal names) beside the exact title match that bound. Empty for a ticker resolution. */
35
40
  otherCandidate: z.array(z.string()),
36
41
  /** Business phone from SEC filings. */
37
42
  phone: z.string().nullish(),
@@ -0,0 +1,18 @@
1
+ import { z } from "zod/v4";
2
+ /**
3
+ * The final IPO prospectus a registrant filed on SEC EDGAR.
4
+ *
5
+ * @openapiSchema SecListingProspectus
6
+ * @endpoint GET /v1/entities/sec
7
+ * @usedBySchema SecCompanySchema
8
+ * @contractShape sec.listing-prospectus
9
+ * @contractRole canonical
10
+ */
11
+ export declare const SecListingProspectusSchema: z.ZodObject<{
12
+ accessionNumber: z.ZodString;
13
+ documentUrl: z.ZodString;
14
+ filingDate: z.ZodISODate;
15
+ form: z.ZodString;
16
+ }, z.core.$strip>;
17
+ export type SecListingProspectus = z.infer<typeof SecListingProspectusSchema>;
18
+ //# sourceMappingURL=listing-prospectus.d.ts.map
@@ -0,0 +1,22 @@
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
+ * The final IPO prospectus a registrant filed on SEC EDGAR.
5
+ *
6
+ * @openapiSchema SecListingProspectus
7
+ * @endpoint GET /v1/entities/sec
8
+ * @usedBySchema SecCompanySchema
9
+ * @contractShape sec.listing-prospectus
10
+ * @contractRole canonical
11
+ */
12
+ export const SecListingProspectusSchema = z.object({
13
+ /** SEC accession number. */
14
+ accessionNumber: z.string(),
15
+ /** SEC EDGAR Archives URL of the prospectus document. */
16
+ documentUrl: z.string(),
17
+ /** Date SEC received the prospectus. */
18
+ filingDate: z.iso.date(),
19
+ /** SEC form type of the prospectus. */
20
+ form: z.string(),
21
+ });
22
+ //# sourceMappingURL=listing-prospectus.js.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aventurevc/api-schemas",
3
- "version": "0.8.131",
3
+ "version": "0.8.132",
4
4
  "private": false,
5
5
  "description": "Zod v4 schemas and TypeScript types for the aVenture API.",
6
6
  "license": "Apache-2.0",