@invinite-org/data-api-client 0.4.0 → 0.6.0

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.
Files changed (114) hide show
  1. package/.openapi-generator/FILES +12 -0
  2. package/dist/apis/EarningsCallsApi.d.ts +4 -8
  3. package/dist/apis/EarningsCallsApi.js +6 -10
  4. package/dist/apis/IPOsApi.d.ts +55 -2
  5. package/dist/apis/IPOsApi.js +95 -3
  6. package/dist/apis/SECFilingsApi.d.ts +2 -2
  7. package/dist/apis/SECFilingsApi.js +2 -2
  8. package/dist/esm/apis/EarningsCallsApi.d.ts +4 -8
  9. package/dist/esm/apis/EarningsCallsApi.js +6 -10
  10. package/dist/esm/apis/IPOsApi.d.ts +55 -2
  11. package/dist/esm/apis/IPOsApi.js +94 -2
  12. package/dist/esm/apis/SECFilingsApi.d.ts +2 -2
  13. package/dist/esm/apis/SECFilingsApi.js +2 -2
  14. package/dist/esm/models/EarningsCallsDocumentSearch200Response.d.ts +0 -2
  15. package/dist/esm/models/EarningsCallsDocumentSearch200Response.js +1 -3
  16. package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +1 -1
  17. package/dist/esm/models/EarningsCallsSearch200Response.d.ts +0 -2
  18. package/dist/esm/models/EarningsCallsSearch200Response.js +1 -3
  19. package/dist/esm/models/EarningsCallsSearch200ResponseHitsInner.d.ts +1 -1
  20. package/dist/esm/models/HitMatch.d.ts +4 -12
  21. package/dist/esm/models/HitMatch.js +1 -7
  22. package/dist/esm/models/IposList200ResponseIposInner.d.ts +7 -0
  23. package/dist/esm/models/IposList200ResponseIposInner.js +5 -0
  24. package/dist/esm/models/IposList200ResponseIposInnerRegistration.d.ts +63 -0
  25. package/dist/esm/models/IposList200ResponseIposInnerRegistration.js +67 -0
  26. package/dist/esm/models/IposRegistrationsList200Response.d.ts +39 -0
  27. package/dist/esm/models/IposRegistrationsList200Response.js +46 -0
  28. package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInner.d.ts +182 -0
  29. package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInner.js +149 -0
  30. package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerFilingsInner.d.ts +62 -0
  31. package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerFilingsInner.js +63 -0
  32. package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerMassive.d.ts +62 -0
  33. package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerMassive.js +63 -0
  34. package/dist/esm/models/ProposedSymbol.d.ts +56 -0
  35. package/dist/esm/models/ProposedSymbol.js +59 -0
  36. package/dist/esm/models/SearchCoverage.d.ts +1 -11
  37. package/dist/esm/models/SearchCoverage.js +0 -8
  38. package/dist/esm/models/SearchCoverageLeg.d.ts +1 -1
  39. package/dist/esm/models/SecFilingsList200ResponseCompaniesInner.d.ts +2 -2
  40. package/dist/esm/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.d.ts +7 -0
  41. package/dist/esm/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.js +5 -0
  42. package/dist/esm/models/WebSocketFiling.d.ts +14 -1
  43. package/dist/esm/models/WebSocketFiling.js +9 -0
  44. package/dist/esm/models/index.d.ts +6 -0
  45. package/dist/esm/models/index.js +6 -0
  46. package/dist/models/EarningsCallsDocumentSearch200Response.d.ts +0 -2
  47. package/dist/models/EarningsCallsDocumentSearch200Response.js +1 -3
  48. package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +1 -1
  49. package/dist/models/EarningsCallsSearch200Response.d.ts +0 -2
  50. package/dist/models/EarningsCallsSearch200Response.js +1 -3
  51. package/dist/models/EarningsCallsSearch200ResponseHitsInner.d.ts +1 -1
  52. package/dist/models/HitMatch.d.ts +4 -12
  53. package/dist/models/HitMatch.js +1 -7
  54. package/dist/models/IposList200ResponseIposInner.d.ts +7 -0
  55. package/dist/models/IposList200ResponseIposInner.js +5 -0
  56. package/dist/models/IposList200ResponseIposInnerRegistration.d.ts +63 -0
  57. package/dist/models/IposList200ResponseIposInnerRegistration.js +75 -0
  58. package/dist/models/IposRegistrationsList200Response.d.ts +39 -0
  59. package/dist/models/IposRegistrationsList200Response.js +53 -0
  60. package/dist/models/IposRegistrationsList200ResponseRegistrationsInner.d.ts +182 -0
  61. package/dist/models/IposRegistrationsList200ResponseRegistrationsInner.js +157 -0
  62. package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerFilingsInner.d.ts +62 -0
  63. package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerFilingsInner.js +70 -0
  64. package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerMassive.d.ts +62 -0
  65. package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerMassive.js +70 -0
  66. package/dist/models/ProposedSymbol.d.ts +56 -0
  67. package/dist/models/ProposedSymbol.js +66 -0
  68. package/dist/models/SearchCoverage.d.ts +1 -11
  69. package/dist/models/SearchCoverage.js +0 -8
  70. package/dist/models/SearchCoverageLeg.d.ts +1 -1
  71. package/dist/models/SecFilingsList200ResponseCompaniesInner.d.ts +2 -2
  72. package/dist/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.d.ts +7 -0
  73. package/dist/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.js +5 -0
  74. package/dist/models/WebSocketFiling.d.ts +14 -1
  75. package/dist/models/WebSocketFiling.js +9 -0
  76. package/dist/models/index.d.ts +6 -0
  77. package/dist/models/index.js +6 -0
  78. package/docs/EarningsCallsApi.md +12 -14
  79. package/docs/HitMatch.md +0 -2
  80. package/docs/IPOsApi.md +94 -1
  81. package/docs/IposList200ResponseIposInner.md +2 -0
  82. package/docs/IposList200ResponseIposInnerRegistration.md +41 -0
  83. package/docs/IposRegistrationsList200Response.md +36 -0
  84. package/docs/IposRegistrationsList200ResponseRegistrationsInner.md +76 -0
  85. package/docs/IposRegistrationsList200ResponseRegistrationsInnerFilingsInner.md +44 -0
  86. package/docs/IposRegistrationsList200ResponseRegistrationsInnerMassive.md +45 -0
  87. package/docs/ProposedSymbol.md +43 -0
  88. package/docs/SECFilingsApi.md +3 -3
  89. package/docs/SearchCoverage.md +1 -3
  90. package/docs/SearchCoverageLeg.md +1 -1
  91. package/docs/SecFilingsList200ResponseCompaniesInnerFilingsInner.md +2 -0
  92. package/docs/WebSocketFiling.md +5 -0
  93. package/package.json +1 -1
  94. package/src/apis/EarningsCallsApi.ts +6 -10
  95. package/src/apis/IPOsApi.ts +121 -2
  96. package/src/apis/SECFilingsApi.ts +2 -2
  97. package/src/models/EarningsCallsDocumentSearch200Response.ts +1 -3
  98. package/src/models/EarningsCallsDocumentSearch200ResponseHitsInner.ts +1 -1
  99. package/src/models/EarningsCallsSearch200Response.ts +1 -3
  100. package/src/models/EarningsCallsSearch200ResponseHitsInner.ts +1 -1
  101. package/src/models/HitMatch.ts +5 -16
  102. package/src/models/IposList200ResponseIposInner.ts +17 -0
  103. package/src/models/IposList200ResponseIposInnerRegistration.ts +109 -0
  104. package/src/models/IposRegistrationsList200Response.ts +82 -0
  105. package/src/models/IposRegistrationsList200ResponseRegistrationsInner.ts +302 -0
  106. package/src/models/IposRegistrationsList200ResponseRegistrationsInnerFilingsInner.ts +111 -0
  107. package/src/models/IposRegistrationsList200ResponseRegistrationsInnerMassive.ts +111 -0
  108. package/src/models/ProposedSymbol.ts +102 -0
  109. package/src/models/SearchCoverage.ts +1 -14
  110. package/src/models/SearchCoverageLeg.ts +1 -1
  111. package/src/models/SecFilingsList200ResponseCompaniesInner.ts +2 -2
  112. package/src/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.ts +17 -0
  113. package/src/models/WebSocketFiling.ts +27 -1
  114. package/src/models/index.ts +6 -0
@@ -22,7 +22,7 @@ import {
22
22
  } from './SearchCoverageLeg';
23
23
 
24
24
  /**
25
- * How much of the searched scope the mode's indexes cover
25
+ * How much of the searched scope the text index covers
26
26
  * @export
27
27
  * @interface SearchCoverage
28
28
  */
@@ -39,12 +39,6 @@ export interface SearchCoverage {
39
39
  * @memberof SearchCoverage
40
40
  */
41
41
  lexical: SearchCoverageLeg | null;
42
- /**
43
- *
44
- * @type {SearchCoverageLeg}
45
- * @memberof SearchCoverage
46
- */
47
- semantic: SearchCoverageLeg | null;
48
42
  /**
49
43
  * Why the answer may be incomplete
50
44
  * @type {Array<SearchCoverageReasonsEnum>}
@@ -70,10 +64,6 @@ export type SearchCoverageCompletenessEnum = typeof SearchCoverageCompletenessEn
70
64
  export const SearchCoverageReasonsEnum = {
71
65
  LexicalBackfillPending: 'lexical_backfill_pending',
72
66
  ProjectionFailed: 'projection_failed',
73
- SemanticIndexMissing: 'semantic_index_missing',
74
- SemanticBackfillPending: 'semantic_backfill_pending',
75
- LexicalUnavailable: 'lexical_unavailable',
76
- SemanticUnavailable: 'semantic_unavailable',
77
67
  CoverageUnavailable: 'coverage_unavailable'
78
68
  } as const;
79
69
  export type SearchCoverageReasonsEnum = typeof SearchCoverageReasonsEnum[keyof typeof SearchCoverageReasonsEnum];
@@ -85,7 +75,6 @@ export type SearchCoverageReasonsEnum = typeof SearchCoverageReasonsEnum[keyof t
85
75
  export function instanceOfSearchCoverage(value: object): value is SearchCoverage {
86
76
  if (!('completeness' in value) || value['completeness'] === undefined) return false;
87
77
  if (!('lexical' in value) || value['lexical'] === undefined) return false;
88
- if (!('semantic' in value) || value['semantic'] === undefined) return false;
89
78
  if (!('reasons' in value) || value['reasons'] === undefined) return false;
90
79
  return true;
91
80
  }
@@ -102,7 +91,6 @@ export function SearchCoverageFromJSONTyped(json: any, ignoreDiscriminator: bool
102
91
 
103
92
  'completeness': json['completeness'],
104
93
  'lexical': SearchCoverageLegFromJSON(json['lexical']),
105
- 'semantic': SearchCoverageLegFromJSON(json['semantic']),
106
94
  'reasons': json['reasons'],
107
95
  };
108
96
  }
@@ -120,7 +108,6 @@ export function SearchCoverageToJSONTyped(value?: SearchCoverage | null, ignoreD
120
108
 
121
109
  'completeness': value['completeness'],
122
110
  'lexical': SearchCoverageLegToJSON(value['lexical']),
123
- 'semantic': SearchCoverageLegToJSON(value['semantic']),
124
111
  'reasons': value['reasons'],
125
112
  };
126
113
  }
@@ -14,7 +14,7 @@
14
14
 
15
15
  import { mapValues } from '../runtime';
16
16
  /**
17
- * The keyword index (lexical / literal / hybrid); null when the mode did not use it
17
+ * The text index (lexical and literal); null when the counts could not be read
18
18
  * @export
19
19
  * @interface SearchCoverageLeg
20
20
  */
@@ -28,11 +28,11 @@ import {
28
28
  */
29
29
  export interface SecFilingsList200ResponseCompaniesInner {
30
30
  /**
31
- * Ticker symbol
31
+ * Ticker symbol; null for a company that is not listed yet (pre-IPO)
32
32
  * @type {string}
33
33
  * @memberof SecFilingsList200ResponseCompaniesInner
34
34
  */
35
- ticker: string;
35
+ ticker: string | null;
36
36
  /**
37
37
  * CIK (with or without leading zeros)
38
38
  * @type {string}
@@ -13,6 +13,14 @@
13
13
  */
14
14
 
15
15
  import { mapValues } from '../runtime';
16
+ import type { ProposedSymbol } from './ProposedSymbol';
17
+ import {
18
+ ProposedSymbolFromJSON,
19
+ ProposedSymbolFromJSONTyped,
20
+ ProposedSymbolToJSON,
21
+ ProposedSymbolToJSONTyped,
22
+ } from './ProposedSymbol';
23
+
16
24
  /**
17
25
  *
18
26
  * @export
@@ -79,6 +87,12 @@ export interface SecFilingsList200ResponseCompaniesInnerFilingsInner {
79
87
  * @memberof SecFilingsList200ResponseCompaniesInnerFilingsInner
80
88
  */
81
89
  period_end: Date | null;
90
+ /**
91
+ * Tickers the registration statement proposes (S-1, S-1/A, F-1, F-1/A only). null = not a registration form (or not read), [] = none found
92
+ * @type {Array<ProposedSymbol>}
93
+ * @memberof SecFilingsList200ResponseCompaniesInnerFilingsInner
94
+ */
95
+ proposed_symbols: Array<ProposedSymbol> | null;
82
96
  }
83
97
 
84
98
  /**
@@ -95,6 +109,7 @@ export function instanceOfSecFilingsList200ResponseCompaniesInnerFilingsInner(va
95
109
  if (!('form_type' in value) || value['form_type'] === undefined) return false;
96
110
  if (!('html_url' in value) || value['html_url'] === undefined) return false;
97
111
  if (!('period_end' in value) || value['period_end'] === undefined) return false;
112
+ if (!('proposed_symbols' in value) || value['proposed_symbols'] === undefined) return false;
98
113
  return true;
99
114
  }
100
115
 
@@ -118,6 +133,7 @@ export function SecFilingsList200ResponseCompaniesInnerFilingsInnerFromJSONTyped
118
133
  'form_type': json['form_type'],
119
134
  'html_url': json['html_url'],
120
135
  'period_end': (json['period_end'] == null ? null : new Date(json['period_end'])),
136
+ 'proposed_symbols': (json['proposed_symbols'] == null ? null : (json['proposed_symbols'] as Array<any>).map(ProposedSymbolFromJSON)),
121
137
  };
122
138
  }
123
139
 
@@ -142,6 +158,7 @@ export function SecFilingsList200ResponseCompaniesInnerFilingsInnerToJSONTyped(v
142
158
  'form_type': value['form_type'],
143
159
  'html_url': value['html_url'],
144
160
  'period_end': value['period_end'] == null ? value['period_end'] : value['period_end'].toISOString().substring(0,10),
161
+ 'proposed_symbols': (value['proposed_symbols'] == null ? null : (value['proposed_symbols'] as Array<any>).map(ProposedSymbolToJSON)),
145
162
  };
146
163
  }
147
164
 
@@ -13,8 +13,16 @@
13
13
  */
14
14
 
15
15
  import { mapValues } from '../runtime';
16
+ import type { ProposedSymbol } from './ProposedSymbol';
17
+ import {
18
+ ProposedSymbolFromJSON,
19
+ ProposedSymbolFromJSONTyped,
20
+ ProposedSymbolToJSON,
21
+ ProposedSymbolToJSONTyped,
22
+ } from './ProposedSymbol';
23
+
16
24
  /**
17
- *
25
+ * A new SEC filing, the same fields as a GET /v1/sec-filings/filings row plus `ticker`. Until 2026-10 the frame forwarded the upstream camelCase envelope (`schemaVersion`, `eventKey`, `filing.accessionNumber`, …) instead of this documented shape; it now is exactly this object
18
26
  * @export
19
27
  * @interface WebSocketFiling
20
28
  */
@@ -79,6 +87,18 @@ export interface WebSocketFiling {
79
87
  * @memberof WebSocketFiling
80
88
  */
81
89
  period_end: Date | null;
90
+ /**
91
+ * Ticker of the company's primary listing; null for a company that is not listed yet (pre-IPO)
92
+ * @type {string}
93
+ * @memberof WebSocketFiling
94
+ */
95
+ ticker: string | null;
96
+ /**
97
+ * Tickers a registration statement (S-1, S-1/A, F-1, F-1/A) proposes; null when the filing carries none
98
+ * @type {Array<ProposedSymbol>}
99
+ * @memberof WebSocketFiling
100
+ */
101
+ proposed_symbols: Array<ProposedSymbol> | null;
82
102
  }
83
103
 
84
104
  /**
@@ -95,6 +115,8 @@ export function instanceOfWebSocketFiling(value: object): value is WebSocketFili
95
115
  if (!('form_type' in value) || value['form_type'] === undefined) return false;
96
116
  if (!('html_url' in value) || value['html_url'] === undefined) return false;
97
117
  if (!('period_end' in value) || value['period_end'] === undefined) return false;
118
+ if (!('ticker' in value) || value['ticker'] === undefined) return false;
119
+ if (!('proposed_symbols' in value) || value['proposed_symbols'] === undefined) return false;
98
120
  return true;
99
121
  }
100
122
 
@@ -118,6 +140,8 @@ export function WebSocketFilingFromJSONTyped(json: any, ignoreDiscriminator: boo
118
140
  'form_type': json['form_type'],
119
141
  'html_url': json['html_url'],
120
142
  'period_end': (json['period_end'] == null ? null : new Date(json['period_end'])),
143
+ 'ticker': json['ticker'],
144
+ 'proposed_symbols': (json['proposed_symbols'] == null ? null : (json['proposed_symbols'] as Array<any>).map(ProposedSymbolFromJSON)),
121
145
  };
122
146
  }
123
147
 
@@ -142,6 +166,8 @@ export function WebSocketFilingToJSONTyped(value?: WebSocketFiling | null, ignor
142
166
  'form_type': value['form_type'],
143
167
  'html_url': value['html_url'],
144
168
  'period_end': value['period_end'] == null ? value['period_end'] : value['period_end'].toISOString().substring(0,10),
169
+ 'ticker': value['ticker'],
170
+ 'proposed_symbols': (value['proposed_symbols'] == null ? null : (value['proposed_symbols'] as Array<any>).map(ProposedSymbolToJSON)),
145
171
  };
146
172
  }
147
173
 
@@ -142,6 +142,11 @@ export * from './InstitutionalOwnershipTransactions200ResponseTransactionsInner'
142
142
  export * from './InternalServerError';
143
143
  export * from './IposList200Response';
144
144
  export * from './IposList200ResponseIposInner';
145
+ export * from './IposList200ResponseIposInnerRegistration';
146
+ export * from './IposRegistrationsList200Response';
147
+ export * from './IposRegistrationsList200ResponseRegistrationsInner';
148
+ export * from './IposRegistrationsList200ResponseRegistrationsInnerFilingsInner';
149
+ export * from './IposRegistrationsList200ResponseRegistrationsInnerMassive';
145
150
  export * from './MarketHolidays200Response';
146
151
  export * from './MarketHolidays200ResponseHolidaysInner';
147
152
  export * from './MatchSpan';
@@ -152,6 +157,7 @@ export * from './MetadataAvailableSectionIds200ResponseFormTypesInner';
152
157
  export * from './MetadataAvailableSectionIds200ResponseFormTypesInnerSectionsInner';
153
158
  export * from './NotFoundError';
154
159
  export * from './PresentationFact';
160
+ export * from './ProposedSymbol';
155
161
  export * from './SearchCoverage';
156
162
  export * from './SearchCoverageLeg';
157
163
  export * from './SecFilingsAvailableFormTypes200Response';