@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
@@ -23,6 +23,11 @@ import {
23
23
  IposList200ResponseFromJSON,
24
24
  IposList200ResponseToJSON,
25
25
  } from '../models/IposList200Response';
26
+ import {
27
+ type IposRegistrationsList200Response,
28
+ IposRegistrationsList200ResponseFromJSON,
29
+ IposRegistrationsList200ResponseToJSON,
30
+ } from '../models/IposRegistrationsList200Response';
26
31
 
27
32
  export interface IposListRequest {
28
33
  startDate?: Date;
@@ -32,6 +37,16 @@ export interface IposListRequest {
32
37
  offset?: number;
33
38
  }
34
39
 
40
+ export interface IposRegistrationsListRequest {
41
+ startDate?: Date;
42
+ endDate?: Date;
43
+ stage?: Array<IposRegistrationsListStageEnum>;
44
+ isSpac?: IposRegistrationsListIsSpacEnum;
45
+ sort?: IposRegistrationsListSortEnum;
46
+ limit?: number;
47
+ offset?: number;
48
+ }
49
+
35
50
  /**
36
51
  *
37
52
  */
@@ -85,7 +100,7 @@ export class IPOsApi extends runtime.BaseAPI {
85
100
  }
86
101
 
87
102
  /**
88
- * List all IPOs. Minimum tier for redistribute: PRO.
103
+ * List all IPOs of the Massive IPO calendar, keyed by ticker; rows usually appear near pricing. `registration` links a row to the SEC-sourced registration track (`GET /v1/ipos/registrations`) Massive matched to the same ticker, or is null. Minimum tier for redistribute: PRO.
89
104
  * List IPOs
90
105
  */
91
106
  async iposListRaw(requestParameters: IposListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IposList200Response>> {
@@ -96,7 +111,7 @@ export class IPOsApi extends runtime.BaseAPI {
96
111
  }
97
112
 
98
113
  /**
99
- * List all IPOs. Minimum tier for redistribute: PRO.
114
+ * List all IPOs of the Massive IPO calendar, keyed by ticker; rows usually appear near pricing. `registration` links a row to the SEC-sourced registration track (`GET /v1/ipos/registrations`) Massive matched to the same ticker, or is null. Minimum tier for redistribute: PRO.
100
115
  * List IPOs
101
116
  */
102
117
  async iposList(requestParameters: IposListRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IposList200Response> {
@@ -104,6 +119,81 @@ export class IPOsApi extends runtime.BaseAPI {
104
119
  return await response.value();
105
120
  }
106
121
 
122
+ /**
123
+ * Creates request options for iposRegistrationsList without sending the request
124
+ */
125
+ async iposRegistrationsListRequestOpts(requestParameters: IposRegistrationsListRequest): Promise<runtime.RequestOpts> {
126
+ const queryParameters: any = {};
127
+
128
+ if (requestParameters['startDate'] != null) {
129
+ queryParameters['start_date'] = (requestParameters['startDate'] as any).toISOString().substring(0,10);
130
+ }
131
+
132
+ if (requestParameters['endDate'] != null) {
133
+ queryParameters['end_date'] = (requestParameters['endDate'] as any).toISOString().substring(0,10);
134
+ }
135
+
136
+ if (requestParameters['stage'] != null) {
137
+ queryParameters['stage'] = requestParameters['stage'];
138
+ }
139
+
140
+ if (requestParameters['isSpac'] != null) {
141
+ queryParameters['is_spac'] = requestParameters['isSpac'];
142
+ }
143
+
144
+ if (requestParameters['sort'] != null) {
145
+ queryParameters['sort'] = requestParameters['sort'];
146
+ }
147
+
148
+ if (requestParameters['limit'] != null) {
149
+ queryParameters['limit'] = requestParameters['limit'];
150
+ }
151
+
152
+ if (requestParameters['offset'] != null) {
153
+ queryParameters['offset'] = requestParameters['offset'];
154
+ }
155
+
156
+ const headerParameters: runtime.HTTPHeaders = {};
157
+
158
+ if (this.configuration && this.configuration.accessToken) {
159
+ const token = this.configuration.accessToken;
160
+ const tokenString = await token("bearerAuth", []);
161
+
162
+ if (tokenString) {
163
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
164
+ }
165
+ }
166
+
167
+ let urlPath = `/v1/ipos/registrations`;
168
+
169
+ return {
170
+ path: urlPath,
171
+ method: 'GET',
172
+ headers: headerParameters,
173
+ query: queryParameters,
174
+ };
175
+ }
176
+
177
+ /**
178
+ * The SEC-sourced IPO calendar: one row per registration statement of a company that is not listed yet, from its first public S-1 or F-1 until it trades or is withdrawn, keyed by CIK. Each row carries the stage, the proposed ticker(s), the price range and final price from the prospectus, the SEC timestamps of every step, and the filings that moved it. `GET /v1/ipos` is a different source: the Massive IPO calendar, keyed by ticker, whose rows usually appear only near pricing. A registration shows up weeks earlier. `massive` holds the Massive row matched to a registration (by ticker and issuer name), `proposed_symbols[].ipo_calendar_match` flags a proposed ticker that is on that calendar, and each `GET /v1/ipos` row links back through `registration`. Pre-IPO companies have no ticker yet: read their filings with `GET /v1/sec-filings/filings?identifier=<cik>`. Minimum tier for redistribute: PRO.
179
+ * List IPO registrations (SEC)
180
+ */
181
+ async iposRegistrationsListRaw(requestParameters: IposRegistrationsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IposRegistrationsList200Response>> {
182
+ const requestOptions = await this.iposRegistrationsListRequestOpts(requestParameters);
183
+ const response = await this.request(requestOptions, initOverrides);
184
+
185
+ return new runtime.JSONApiResponse(response, (jsonValue) => IposRegistrationsList200ResponseFromJSON(jsonValue));
186
+ }
187
+
188
+ /**
189
+ * The SEC-sourced IPO calendar: one row per registration statement of a company that is not listed yet, from its first public S-1 or F-1 until it trades or is withdrawn, keyed by CIK. Each row carries the stage, the proposed ticker(s), the price range and final price from the prospectus, the SEC timestamps of every step, and the filings that moved it. `GET /v1/ipos` is a different source: the Massive IPO calendar, keyed by ticker, whose rows usually appear only near pricing. A registration shows up weeks earlier. `massive` holds the Massive row matched to a registration (by ticker and issuer name), `proposed_symbols[].ipo_calendar_match` flags a proposed ticker that is on that calendar, and each `GET /v1/ipos` row links back through `registration`. Pre-IPO companies have no ticker yet: read their filings with `GET /v1/sec-filings/filings?identifier=<cik>`. Minimum tier for redistribute: PRO.
190
+ * List IPO registrations (SEC)
191
+ */
192
+ async iposRegistrationsList(requestParameters: IposRegistrationsListRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IposRegistrationsList200Response> {
193
+ const response = await this.iposRegistrationsListRaw(requestParameters, initOverrides);
194
+ return await response.value();
195
+ }
196
+
107
197
  }
108
198
 
109
199
  /**
@@ -114,3 +204,32 @@ export const IposListSortEnum = {
114
204
  Desc: 'desc'
115
205
  } as const;
116
206
  export type IposListSortEnum = typeof IposListSortEnum[keyof typeof IposListSortEnum];
207
+ /**
208
+ * @export
209
+ */
210
+ export const IposRegistrationsListStageEnum = {
211
+ Registered: 'registered',
212
+ PriceRange: 'price_range',
213
+ ExchangeApproved: 'exchange_approved',
214
+ Effective: 'effective',
215
+ Priced: 'priced',
216
+ Trading: 'trading',
217
+ Withdrawn: 'withdrawn'
218
+ } as const;
219
+ export type IposRegistrationsListStageEnum = typeof IposRegistrationsListStageEnum[keyof typeof IposRegistrationsListStageEnum];
220
+ /**
221
+ * @export
222
+ */
223
+ export const IposRegistrationsListIsSpacEnum = {
224
+ True: 'true',
225
+ False: 'false'
226
+ } as const;
227
+ export type IposRegistrationsListIsSpacEnum = typeof IposRegistrationsListIsSpacEnum[keyof typeof IposRegistrationsListIsSpacEnum];
228
+ /**
229
+ * @export
230
+ */
231
+ export const IposRegistrationsListSortEnum = {
232
+ Asc: 'asc',
233
+ Desc: 'desc'
234
+ } as const;
235
+ export type IposRegistrationsListSortEnum = typeof IposRegistrationsListSortEnum[keyof typeof IposRegistrationsListSortEnum];
@@ -177,7 +177,7 @@ export class SECFilingsApi extends runtime.BaseAPI {
177
177
  }
178
178
 
179
179
  /**
180
- * Fetch SEC filings for a company. Minimum tier for display: FREE.
180
+ * Fetch SEC filings for a company. `identifier` is a ticker or a CIK; a CIK also resolves a company that is not listed yet (a pre-IPO registrant), whose `ticker` is null. Registration statements (S-1, S-1/A, F-1, F-1/A) carry the `proposed_symbols` the prospectus names. Minimum tier for display: FREE.
181
181
  * SEC filings
182
182
  */
183
183
  async secFilingsListRaw(requestParameters: SecFilingsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecFilingsList200Response>> {
@@ -188,7 +188,7 @@ export class SECFilingsApi extends runtime.BaseAPI {
188
188
  }
189
189
 
190
190
  /**
191
- * Fetch SEC filings for a company. Minimum tier for display: FREE.
191
+ * Fetch SEC filings for a company. `identifier` is a ticker or a CIK; a CIK also resolves a company that is not listed yet (a pre-IPO registrant), whose `ticker` is null. Registration statements (S-1, S-1/A, F-1, F-1/A) carry the `proposed_symbols` the prospectus names. Minimum tier for display: FREE.
192
192
  * SEC filings
193
193
  */
194
194
  async secFilingsList(requestParameters: SecFilingsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecFilingsList200Response> {
@@ -66,9 +66,7 @@ export interface EarningsCallsDocumentSearch200Response {
66
66
  */
67
67
  export const EarningsCallsDocumentSearch200ResponseModeEnum = {
68
68
  Lexical: 'lexical',
69
- Literal: 'literal',
70
- Semantic: 'semantic',
71
- Hybrid: 'hybrid'
69
+ Literal: 'literal'
72
70
  } as const;
73
71
  export type EarningsCallsDocumentSearch200ResponseModeEnum = typeof EarningsCallsDocumentSearch200ResponseModeEnum[keyof typeof EarningsCallsDocumentSearch200ResponseModeEnum];
74
72
 
@@ -28,7 +28,7 @@ import {
28
28
  */
29
29
  export interface EarningsCallsDocumentSearch200ResponseHitsInner {
30
30
  /**
31
- * Relevance per mode: lexical = ts_rank_cd (4 decimals), literal = 0 (hits are ordered newest year first), semantic = cosine similarity (4 decimals), hybrid = reciprocal-rank-fusion score (6 decimals)
31
+ * Relevance per mode: lexical = ts_rank_cd (4 decimals), literal = 0 (hits are ordered newest year first)
32
32
  * @type {number}
33
33
  * @memberof EarningsCallsDocumentSearch200ResponseHitsInner
34
34
  */
@@ -66,9 +66,7 @@ export interface EarningsCallsSearch200Response {
66
66
  */
67
67
  export const EarningsCallsSearch200ResponseModeEnum = {
68
68
  Lexical: 'lexical',
69
- Literal: 'literal',
70
- Semantic: 'semantic',
71
- Hybrid: 'hybrid'
69
+ Literal: 'literal'
72
70
  } as const;
73
71
  export type EarningsCallsSearch200ResponseModeEnum = typeof EarningsCallsSearch200ResponseModeEnum[keyof typeof EarningsCallsSearch200ResponseModeEnum];
74
72
 
@@ -120,7 +120,7 @@ export interface EarningsCallsSearch200ResponseHitsInner {
120
120
  */
121
121
  text_truncated: boolean;
122
122
  /**
123
- * Relevance per mode: lexical = ts_rank_cd (4 decimals), literal = 0 (hits are ordered newest call first), semantic = cosine similarity (4 decimals), hybrid = reciprocal-rank-fusion score (6 decimals)
123
+ * Relevance per mode: lexical = BM25 with `identifier` / `event_id` (an answer attached to its question scores 0.99 × the question), else ts_rank_cd (4 decimals), literal = 0 (hits are ordered newest call first)
124
124
  * @type {number}
125
125
  * @memberof EarningsCallsSearch200ResponseHitsInner
126
126
  */
@@ -28,25 +28,19 @@ import {
28
28
  */
29
29
  export interface HitMatch {
30
30
  /**
31
- * The leg that found the passage; hybrid = both legs of mode=hybrid
31
+ * The mode that found the passage
32
32
  * @type {HitMatchTypeEnum}
33
33
  * @memberof HitMatch
34
34
  */
35
35
  type: HitMatchTypeEnum;
36
36
  /**
37
- * 1-based rank in the keyword leg (lexical / literal); null when it did not find it
37
+ * 1-based rank of the passage in the answer
38
38
  * @type {number}
39
39
  * @memberof HitMatch
40
40
  */
41
- lexical_rank: number | null;
41
+ lexical_rank: number;
42
42
  /**
43
- * 1-based rank in the semantic leg; null when it did not find it
44
- * @type {number}
45
- * @memberof HitMatch
46
- */
47
- semantic_rank: number | null;
48
- /**
49
- * Matched characters in `text`; empty for semantic matches
43
+ * Matched characters in `text`; empty for an answer attached after its matched question (scoped lexical transcript search)
50
44
  * @type {Array<MatchSpan>}
51
45
  * @memberof HitMatch
52
46
  */
@@ -59,9 +53,7 @@ export interface HitMatch {
59
53
  */
60
54
  export const HitMatchTypeEnum = {
61
55
  Lexical: 'lexical',
62
- Literal: 'literal',
63
- Semantic: 'semantic',
64
- Hybrid: 'hybrid'
56
+ Literal: 'literal'
65
57
  } as const;
66
58
  export type HitMatchTypeEnum = typeof HitMatchTypeEnum[keyof typeof HitMatchTypeEnum];
67
59
 
@@ -72,7 +64,6 @@ export type HitMatchTypeEnum = typeof HitMatchTypeEnum[keyof typeof HitMatchType
72
64
  export function instanceOfHitMatch(value: object): value is HitMatch {
73
65
  if (!('type' in value) || value['type'] === undefined) return false;
74
66
  if (!('lexical_rank' in value) || value['lexical_rank'] === undefined) return false;
75
- if (!('semantic_rank' in value) || value['semantic_rank'] === undefined) return false;
76
67
  if (!('spans' in value) || value['spans'] === undefined) return false;
77
68
  return true;
78
69
  }
@@ -89,7 +80,6 @@ export function HitMatchFromJSONTyped(json: any, ignoreDiscriminator: boolean):
89
80
 
90
81
  'type': json['type'],
91
82
  'lexical_rank': json['lexical_rank'],
92
- 'semantic_rank': json['semantic_rank'],
93
83
  'spans': ((json['spans'] as Array<any>).map(MatchSpanFromJSON)),
94
84
  };
95
85
  }
@@ -107,7 +97,6 @@ export function HitMatchToJSONTyped(value?: HitMatch | null, ignoreDiscriminator
107
97
 
108
98
  'type': value['type'],
109
99
  'lexical_rank': value['lexical_rank'],
110
- 'semantic_rank': value['semantic_rank'],
111
100
  'spans': ((value['spans'] as Array<any>).map(MatchSpanToJSON)),
112
101
  };
113
102
  }
@@ -13,6 +13,14 @@
13
13
  */
14
14
 
15
15
  import { mapValues } from '../runtime';
16
+ import type { IposList200ResponseIposInnerRegistration } from './IposList200ResponseIposInnerRegistration';
17
+ import {
18
+ IposList200ResponseIposInnerRegistrationFromJSON,
19
+ IposList200ResponseIposInnerRegistrationFromJSONTyped,
20
+ IposList200ResponseIposInnerRegistrationToJSON,
21
+ IposList200ResponseIposInnerRegistrationToJSONTyped,
22
+ } from './IposList200ResponseIposInnerRegistration';
23
+
16
24
  /**
17
25
  *
18
26
  * @export
@@ -151,6 +159,12 @@ export interface IposList200ResponseIposInner {
151
159
  * @memberof IposList200ResponseIposInner
152
160
  */
153
161
  us_code: string;
162
+ /**
163
+ *
164
+ * @type {IposList200ResponseIposInnerRegistration}
165
+ * @memberof IposList200ResponseIposInner
166
+ */
167
+ registration: IposList200ResponseIposInnerRegistration | null;
154
168
  }
155
169
 
156
170
  /**
@@ -179,6 +193,7 @@ export function instanceOfIposList200ResponseIposInner(value: object): value is
179
193
  if (!('ticker' in value) || value['ticker'] === undefined) return false;
180
194
  if (!('total_offer_size' in value) || value['total_offer_size'] === undefined) return false;
181
195
  if (!('us_code' in value) || value['us_code'] === undefined) return false;
196
+ if (!('registration' in value) || value['registration'] === undefined) return false;
182
197
  return true;
183
198
  }
184
199
 
@@ -214,6 +229,7 @@ export function IposList200ResponseIposInnerFromJSONTyped(json: any, ignoreDiscr
214
229
  'ticker': json['ticker'],
215
230
  'total_offer_size': json['total_offer_size'],
216
231
  'us_code': json['us_code'],
232
+ 'registration': IposList200ResponseIposInnerRegistrationFromJSON(json['registration']),
217
233
  };
218
234
  }
219
235
 
@@ -250,6 +266,7 @@ export function IposList200ResponseIposInnerToJSONTyped(value?: IposList200Respo
250
266
  'ticker': value['ticker'],
251
267
  'total_offer_size': value['total_offer_size'],
252
268
  'us_code': value['us_code'],
269
+ 'registration': IposList200ResponseIposInnerRegistrationToJSON(value['registration']),
253
270
  };
254
271
  }
255
272
 
@@ -0,0 +1,109 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Invinite API
5
+ * Invinite financial data API. Each endpoint has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Included-Remaining` what is left of the plan\'s included credits. `GET /v1/account/usage` returns your account\'s usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `ping` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `ping` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/account/usage` serves no licensed data and carries none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, WebSocket, Account.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ /**
17
+ * The SEC registration track (GET /v1/ipos/registrations) matched to this ticker; null when none is
18
+ * @export
19
+ * @interface IposList200ResponseIposInnerRegistration
20
+ */
21
+ export interface IposList200ResponseIposInnerRegistration {
22
+ /**
23
+ * 10-digit CIK of the issuer
24
+ * @type {string}
25
+ * @memberof IposList200ResponseIposInnerRegistration
26
+ */
27
+ cik: string;
28
+ /**
29
+ * The registration's track key
30
+ * @type {string}
31
+ * @memberof IposList200ResponseIposInnerRegistration
32
+ */
33
+ track_key: string;
34
+ /**
35
+ * The registration's stage
36
+ * @type {IposList200ResponseIposInnerRegistrationStageEnum}
37
+ * @memberof IposList200ResponseIposInnerRegistration
38
+ */
39
+ stage: IposList200ResponseIposInnerRegistrationStageEnum;
40
+ /**
41
+ * Final offering price from the SEC final prospectus (decimal string)
42
+ * @type {string}
43
+ * @memberof IposList200ResponseIposInnerRegistration
44
+ */
45
+ final_offer_price: string | null;
46
+ }
47
+
48
+
49
+ /**
50
+ * @export
51
+ */
52
+ export const IposList200ResponseIposInnerRegistrationStageEnum = {
53
+ Registered: 'registered',
54
+ PriceRange: 'price_range',
55
+ ExchangeApproved: 'exchange_approved',
56
+ Effective: 'effective',
57
+ Priced: 'priced',
58
+ Trading: 'trading',
59
+ Withdrawn: 'withdrawn'
60
+ } as const;
61
+ export type IposList200ResponseIposInnerRegistrationStageEnum = typeof IposList200ResponseIposInnerRegistrationStageEnum[keyof typeof IposList200ResponseIposInnerRegistrationStageEnum];
62
+
63
+
64
+ /**
65
+ * Check if a given object implements the IposList200ResponseIposInnerRegistration interface.
66
+ */
67
+ export function instanceOfIposList200ResponseIposInnerRegistration(value: object): value is IposList200ResponseIposInnerRegistration {
68
+ if (!('cik' in value) || value['cik'] === undefined) return false;
69
+ if (!('track_key' in value) || value['track_key'] === undefined) return false;
70
+ if (!('stage' in value) || value['stage'] === undefined) return false;
71
+ if (!('final_offer_price' in value) || value['final_offer_price'] === undefined) return false;
72
+ return true;
73
+ }
74
+
75
+ export function IposList200ResponseIposInnerRegistrationFromJSON(json: any): IposList200ResponseIposInnerRegistration {
76
+ return IposList200ResponseIposInnerRegistrationFromJSONTyped(json, false);
77
+ }
78
+
79
+ export function IposList200ResponseIposInnerRegistrationFromJSONTyped(json: any, ignoreDiscriminator: boolean): IposList200ResponseIposInnerRegistration {
80
+ if (json == null) {
81
+ return json;
82
+ }
83
+ return {
84
+
85
+ 'cik': json['cik'],
86
+ 'track_key': json['track_key'],
87
+ 'stage': json['stage'],
88
+ 'final_offer_price': json['final_offer_price'],
89
+ };
90
+ }
91
+
92
+ export function IposList200ResponseIposInnerRegistrationToJSON(json: any): IposList200ResponseIposInnerRegistration {
93
+ return IposList200ResponseIposInnerRegistrationToJSONTyped(json, false);
94
+ }
95
+
96
+ export function IposList200ResponseIposInnerRegistrationToJSONTyped(value?: IposList200ResponseIposInnerRegistration | null, ignoreDiscriminator: boolean = false): any {
97
+ if (value == null) {
98
+ return value;
99
+ }
100
+
101
+ return {
102
+
103
+ 'cik': value['cik'],
104
+ 'track_key': value['track_key'],
105
+ 'stage': value['stage'],
106
+ 'final_offer_price': value['final_offer_price'],
107
+ };
108
+ }
109
+
@@ -0,0 +1,82 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Invinite API
5
+ * Invinite financial data API. Each endpoint has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Included-Remaining` what is left of the plan\'s included credits. `GET /v1/account/usage` returns your account\'s usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `ping` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `ping` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/account/usage` serves no licensed data and carries none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, WebSocket, Account.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ import type { IposRegistrationsList200ResponseRegistrationsInner } from './IposRegistrationsList200ResponseRegistrationsInner';
17
+ import {
18
+ IposRegistrationsList200ResponseRegistrationsInnerFromJSON,
19
+ IposRegistrationsList200ResponseRegistrationsInnerFromJSONTyped,
20
+ IposRegistrationsList200ResponseRegistrationsInnerToJSON,
21
+ IposRegistrationsList200ResponseRegistrationsInnerToJSONTyped,
22
+ } from './IposRegistrationsList200ResponseRegistrationsInner';
23
+
24
+ /**
25
+ *
26
+ * @export
27
+ * @interface IposRegistrationsList200Response
28
+ */
29
+ export interface IposRegistrationsList200Response {
30
+ /**
31
+ * IPO registrations, one per registration statement track
32
+ * @type {Array<IposRegistrationsList200ResponseRegistrationsInner>}
33
+ * @memberof IposRegistrationsList200Response
34
+ */
35
+ registrations: Array<IposRegistrationsList200ResponseRegistrationsInner>;
36
+ /**
37
+ * URL for the next page (includes next offset and same limit). Omitted when no next page exists.
38
+ * @type {string}
39
+ * @memberof IposRegistrationsList200Response
40
+ */
41
+ next_url?: string;
42
+ }
43
+
44
+ /**
45
+ * Check if a given object implements the IposRegistrationsList200Response interface.
46
+ */
47
+ export function instanceOfIposRegistrationsList200Response(value: object): value is IposRegistrationsList200Response {
48
+ if (!('registrations' in value) || value['registrations'] === undefined) return false;
49
+ return true;
50
+ }
51
+
52
+ export function IposRegistrationsList200ResponseFromJSON(json: any): IposRegistrationsList200Response {
53
+ return IposRegistrationsList200ResponseFromJSONTyped(json, false);
54
+ }
55
+
56
+ export function IposRegistrationsList200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): IposRegistrationsList200Response {
57
+ if (json == null) {
58
+ return json;
59
+ }
60
+ return {
61
+
62
+ 'registrations': ((json['registrations'] as Array<any>).map(IposRegistrationsList200ResponseRegistrationsInnerFromJSON)),
63
+ 'next_url': json['next_url'] == null ? undefined : json['next_url'],
64
+ };
65
+ }
66
+
67
+ export function IposRegistrationsList200ResponseToJSON(json: any): IposRegistrationsList200Response {
68
+ return IposRegistrationsList200ResponseToJSONTyped(json, false);
69
+ }
70
+
71
+ export function IposRegistrationsList200ResponseToJSONTyped(value?: IposRegistrationsList200Response | null, ignoreDiscriminator: boolean = false): any {
72
+ if (value == null) {
73
+ return value;
74
+ }
75
+
76
+ return {
77
+
78
+ 'registrations': ((value['registrations'] as Array<any>).map(IposRegistrationsList200ResponseRegistrationsInnerToJSON)),
79
+ 'next_url': value['next_url'],
80
+ };
81
+ }
82
+