@invinite-org/data-api-client 0.5.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 (76) hide show
  1. package/.openapi-generator/FILES +12 -0
  2. package/dist/apis/IPOsApi.d.ts +55 -2
  3. package/dist/apis/IPOsApi.js +95 -3
  4. package/dist/apis/SECFilingsApi.d.ts +2 -2
  5. package/dist/apis/SECFilingsApi.js +2 -2
  6. package/dist/esm/apis/IPOsApi.d.ts +55 -2
  7. package/dist/esm/apis/IPOsApi.js +94 -2
  8. package/dist/esm/apis/SECFilingsApi.d.ts +2 -2
  9. package/dist/esm/apis/SECFilingsApi.js +2 -2
  10. package/dist/esm/models/IposList200ResponseIposInner.d.ts +7 -0
  11. package/dist/esm/models/IposList200ResponseIposInner.js +5 -0
  12. package/dist/esm/models/IposList200ResponseIposInnerRegistration.d.ts +63 -0
  13. package/dist/esm/models/IposList200ResponseIposInnerRegistration.js +67 -0
  14. package/dist/esm/models/IposRegistrationsList200Response.d.ts +39 -0
  15. package/dist/esm/models/IposRegistrationsList200Response.js +46 -0
  16. package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInner.d.ts +182 -0
  17. package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInner.js +149 -0
  18. package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerFilingsInner.d.ts +62 -0
  19. package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerFilingsInner.js +63 -0
  20. package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerMassive.d.ts +62 -0
  21. package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerMassive.js +63 -0
  22. package/dist/esm/models/ProposedSymbol.d.ts +56 -0
  23. package/dist/esm/models/ProposedSymbol.js +59 -0
  24. package/dist/esm/models/SecFilingsList200ResponseCompaniesInner.d.ts +2 -2
  25. package/dist/esm/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.d.ts +7 -0
  26. package/dist/esm/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.js +5 -0
  27. package/dist/esm/models/WebSocketFiling.d.ts +14 -1
  28. package/dist/esm/models/WebSocketFiling.js +9 -0
  29. package/dist/esm/models/index.d.ts +6 -0
  30. package/dist/esm/models/index.js +6 -0
  31. package/dist/models/IposList200ResponseIposInner.d.ts +7 -0
  32. package/dist/models/IposList200ResponseIposInner.js +5 -0
  33. package/dist/models/IposList200ResponseIposInnerRegistration.d.ts +63 -0
  34. package/dist/models/IposList200ResponseIposInnerRegistration.js +75 -0
  35. package/dist/models/IposRegistrationsList200Response.d.ts +39 -0
  36. package/dist/models/IposRegistrationsList200Response.js +53 -0
  37. package/dist/models/IposRegistrationsList200ResponseRegistrationsInner.d.ts +182 -0
  38. package/dist/models/IposRegistrationsList200ResponseRegistrationsInner.js +157 -0
  39. package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerFilingsInner.d.ts +62 -0
  40. package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerFilingsInner.js +70 -0
  41. package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerMassive.d.ts +62 -0
  42. package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerMassive.js +70 -0
  43. package/dist/models/ProposedSymbol.d.ts +56 -0
  44. package/dist/models/ProposedSymbol.js +66 -0
  45. package/dist/models/SecFilingsList200ResponseCompaniesInner.d.ts +2 -2
  46. package/dist/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.d.ts +7 -0
  47. package/dist/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.js +5 -0
  48. package/dist/models/WebSocketFiling.d.ts +14 -1
  49. package/dist/models/WebSocketFiling.js +9 -0
  50. package/dist/models/index.d.ts +6 -0
  51. package/dist/models/index.js +6 -0
  52. package/docs/IPOsApi.md +94 -1
  53. package/docs/IposList200ResponseIposInner.md +2 -0
  54. package/docs/IposList200ResponseIposInnerRegistration.md +41 -0
  55. package/docs/IposRegistrationsList200Response.md +36 -0
  56. package/docs/IposRegistrationsList200ResponseRegistrationsInner.md +76 -0
  57. package/docs/IposRegistrationsList200ResponseRegistrationsInnerFilingsInner.md +44 -0
  58. package/docs/IposRegistrationsList200ResponseRegistrationsInnerMassive.md +45 -0
  59. package/docs/ProposedSymbol.md +43 -0
  60. package/docs/SECFilingsApi.md +3 -3
  61. package/docs/SecFilingsList200ResponseCompaniesInnerFilingsInner.md +2 -0
  62. package/docs/WebSocketFiling.md +5 -0
  63. package/package.json +1 -1
  64. package/src/apis/IPOsApi.ts +121 -2
  65. package/src/apis/SECFilingsApi.ts +2 -2
  66. package/src/models/IposList200ResponseIposInner.ts +17 -0
  67. package/src/models/IposList200ResponseIposInnerRegistration.ts +109 -0
  68. package/src/models/IposRegistrationsList200Response.ts +82 -0
  69. package/src/models/IposRegistrationsList200ResponseRegistrationsInner.ts +302 -0
  70. package/src/models/IposRegistrationsList200ResponseRegistrationsInnerFilingsInner.ts +111 -0
  71. package/src/models/IposRegistrationsList200ResponseRegistrationsInnerMassive.ts +111 -0
  72. package/src/models/ProposedSymbol.ts +102 -0
  73. package/src/models/SecFilingsList200ResponseCompaniesInner.ts +2 -2
  74. package/src/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.ts +17 -0
  75. package/src/models/WebSocketFiling.ts +27 -1
  76. package/src/models/index.ts +6 -0
@@ -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
+
@@ -0,0 +1,302 @@
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 { IposRegistrationsList200ResponseRegistrationsInnerMassive } from './IposRegistrationsList200ResponseRegistrationsInnerMassive';
17
+ import {
18
+ IposRegistrationsList200ResponseRegistrationsInnerMassiveFromJSON,
19
+ IposRegistrationsList200ResponseRegistrationsInnerMassiveFromJSONTyped,
20
+ IposRegistrationsList200ResponseRegistrationsInnerMassiveToJSON,
21
+ IposRegistrationsList200ResponseRegistrationsInnerMassiveToJSONTyped,
22
+ } from './IposRegistrationsList200ResponseRegistrationsInnerMassive';
23
+ import type { ProposedSymbol } from './ProposedSymbol';
24
+ import {
25
+ ProposedSymbolFromJSON,
26
+ ProposedSymbolFromJSONTyped,
27
+ ProposedSymbolToJSON,
28
+ ProposedSymbolToJSONTyped,
29
+ } from './ProposedSymbol';
30
+ import type { IposRegistrationsList200ResponseRegistrationsInnerFilingsInner } from './IposRegistrationsList200ResponseRegistrationsInnerFilingsInner';
31
+ import {
32
+ IposRegistrationsList200ResponseRegistrationsInnerFilingsInnerFromJSON,
33
+ IposRegistrationsList200ResponseRegistrationsInnerFilingsInnerFromJSONTyped,
34
+ IposRegistrationsList200ResponseRegistrationsInnerFilingsInnerToJSON,
35
+ IposRegistrationsList200ResponseRegistrationsInnerFilingsInnerToJSONTyped,
36
+ } from './IposRegistrationsList200ResponseRegistrationsInnerFilingsInner';
37
+
38
+ /**
39
+ *
40
+ * @export
41
+ * @interface IposRegistrationsList200ResponseRegistrationsInner
42
+ */
43
+ export interface IposRegistrationsList200ResponseRegistrationsInner {
44
+ /**
45
+ * 10-digit CIK of the issuer
46
+ * @type {string}
47
+ * @memberof IposRegistrationsList200ResponseRegistrationsInner
48
+ */
49
+ cik: string;
50
+ /**
51
+ * Issuer name (SEC)
52
+ * @type {string}
53
+ * @memberof IposRegistrationsList200ResponseRegistrationsInner
54
+ */
55
+ company_name: string | null;
56
+ /**
57
+ * The registration: its Securities Act file number (333-…), else the accession of its first registration statement
58
+ * @type {string}
59
+ * @memberof IposRegistrationsList200ResponseRegistrationsInner
60
+ */
61
+ track_key: string;
62
+ /**
63
+ * S-1 (domestic) or F-1 (foreign issuer)
64
+ * @type {IposRegistrationsList200ResponseRegistrationsInnerFormFamilyEnum}
65
+ * @memberof IposRegistrationsList200ResponseRegistrationsInner
66
+ */
67
+ form_family: IposRegistrationsList200ResponseRegistrationsInnerFormFamilyEnum;
68
+ /**
69
+ * registered → price_range (an amendment states the range) → exchange_approved (8-A12B / exchange certification) → effective (SEC EFFECT) → priced (final prospectus 424B4 / 424B1) → trading (a listing appeared); withdrawn (RW) ends a track
70
+ * @type {IposRegistrationsList200ResponseRegistrationsInnerStageEnum}
71
+ * @memberof IposRegistrationsList200ResponseRegistrationsInner
72
+ */
73
+ stage: IposRegistrationsList200ResponseRegistrationsInnerStageEnum;
74
+ /**
75
+ * Blank-check company ("blank check company" on the cover or SIC 6770)
76
+ * @type {boolean}
77
+ * @memberof IposRegistrationsList200ResponseRegistrationsInner
78
+ */
79
+ is_spac: boolean | null;
80
+ /**
81
+ * 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
82
+ * @type {Array<ProposedSymbol>}
83
+ * @memberof IposRegistrationsList200ResponseRegistrationsInner
84
+ */
85
+ proposed_symbols: Array<ProposedSymbol> | null;
86
+ /**
87
+ * Exchange the issuer applied to (NASDAQ, NYSE, NYSE American, NYSE Arca, Cboe BZX)
88
+ * @type {string}
89
+ * @memberof IposRegistrationsList200ResponseRegistrationsInner
90
+ */
91
+ exchange: string | null;
92
+ /**
93
+ * Low end of the price range per share, ADS or unit (decimal string)
94
+ * @type {string}
95
+ * @memberof IposRegistrationsList200ResponseRegistrationsInner
96
+ */
97
+ price_range_low: string | null;
98
+ /**
99
+ * High end of the price range (decimal string)
100
+ * @type {string}
101
+ * @memberof IposRegistrationsList200ResponseRegistrationsInner
102
+ */
103
+ price_range_high: string | null;
104
+ /**
105
+ * Shares offered at the price range
106
+ * @type {number}
107
+ * @memberof IposRegistrationsList200ResponseRegistrationsInner
108
+ */
109
+ shares_offered: number | null;
110
+ /**
111
+ * Final offering price (final prospectus) (decimal string)
112
+ * @type {string}
113
+ * @memberof IposRegistrationsList200ResponseRegistrationsInner
114
+ */
115
+ final_offer_price: string | null;
116
+ /**
117
+ * Shares sold at the final price
118
+ * @type {number}
119
+ * @memberof IposRegistrationsList200ResponseRegistrationsInner
120
+ */
121
+ final_shares_offered: number | null;
122
+ /**
123
+ * SEC acceptance time of the first public registration statement (ISO 8601 UTC)
124
+ * @type {Date}
125
+ * @memberof IposRegistrationsList200ResponseRegistrationsInner
126
+ */
127
+ first_public_at: Date;
128
+ /**
129
+ * When the price range was first filed (ISO 8601 UTC)
130
+ * @type {Date}
131
+ * @memberof IposRegistrationsList200ResponseRegistrationsInner
132
+ */
133
+ price_range_at: Date | null;
134
+ /**
135
+ * When the exchange approval was filed (ISO 8601 UTC)
136
+ * @type {Date}
137
+ * @memberof IposRegistrationsList200ResponseRegistrationsInner
138
+ */
139
+ exchange_approved_at: Date | null;
140
+ /**
141
+ * When the registration became effective (ISO 8601 UTC)
142
+ * @type {Date}
143
+ * @memberof IposRegistrationsList200ResponseRegistrationsInner
144
+ */
145
+ effective_at: Date | null;
146
+ /**
147
+ * When the final prospectus was filed (ISO 8601 UTC)
148
+ * @type {Date}
149
+ * @memberof IposRegistrationsList200ResponseRegistrationsInner
150
+ */
151
+ priced_at: Date | null;
152
+ /**
153
+ * When the withdrawal was filed (ISO 8601 UTC)
154
+ * @type {Date}
155
+ * @memberof IposRegistrationsList200ResponseRegistrationsInner
156
+ */
157
+ withdrawn_at: Date | null;
158
+ /**
159
+ * First trading day of the listing (YYYY-MM-DD); set at stage trading
160
+ * @type {Date}
161
+ * @memberof IposRegistrationsList200ResponseRegistrationsInner
162
+ */
163
+ first_trade_date: Date | null;
164
+ /**
165
+ *
166
+ * @type {IposRegistrationsList200ResponseRegistrationsInnerMassive}
167
+ * @memberof IposRegistrationsList200ResponseRegistrationsInner
168
+ */
169
+ massive: IposRegistrationsList200ResponseRegistrationsInnerMassive | null;
170
+ /**
171
+ * The filings that moved this registration, in the order they were applied
172
+ * @type {Array<IposRegistrationsList200ResponseRegistrationsInnerFilingsInner>}
173
+ * @memberof IposRegistrationsList200ResponseRegistrationsInner
174
+ */
175
+ filings: Array<IposRegistrationsList200ResponseRegistrationsInnerFilingsInner>;
176
+ }
177
+
178
+
179
+ /**
180
+ * @export
181
+ */
182
+ export const IposRegistrationsList200ResponseRegistrationsInnerFormFamilyEnum = {
183
+ S1: 'S-1',
184
+ F1: 'F-1'
185
+ } as const;
186
+ export type IposRegistrationsList200ResponseRegistrationsInnerFormFamilyEnum = typeof IposRegistrationsList200ResponseRegistrationsInnerFormFamilyEnum[keyof typeof IposRegistrationsList200ResponseRegistrationsInnerFormFamilyEnum];
187
+
188
+ /**
189
+ * @export
190
+ */
191
+ export const IposRegistrationsList200ResponseRegistrationsInnerStageEnum = {
192
+ Registered: 'registered',
193
+ PriceRange: 'price_range',
194
+ ExchangeApproved: 'exchange_approved',
195
+ Effective: 'effective',
196
+ Priced: 'priced',
197
+ Trading: 'trading',
198
+ Withdrawn: 'withdrawn'
199
+ } as const;
200
+ export type IposRegistrationsList200ResponseRegistrationsInnerStageEnum = typeof IposRegistrationsList200ResponseRegistrationsInnerStageEnum[keyof typeof IposRegistrationsList200ResponseRegistrationsInnerStageEnum];
201
+
202
+
203
+ /**
204
+ * Check if a given object implements the IposRegistrationsList200ResponseRegistrationsInner interface.
205
+ */
206
+ export function instanceOfIposRegistrationsList200ResponseRegistrationsInner(value: object): value is IposRegistrationsList200ResponseRegistrationsInner {
207
+ if (!('cik' in value) || value['cik'] === undefined) return false;
208
+ if (!('company_name' in value) || value['company_name'] === undefined) return false;
209
+ if (!('track_key' in value) || value['track_key'] === undefined) return false;
210
+ if (!('form_family' in value) || value['form_family'] === undefined) return false;
211
+ if (!('stage' in value) || value['stage'] === undefined) return false;
212
+ if (!('is_spac' in value) || value['is_spac'] === undefined) return false;
213
+ if (!('proposed_symbols' in value) || value['proposed_symbols'] === undefined) return false;
214
+ if (!('exchange' in value) || value['exchange'] === undefined) return false;
215
+ if (!('price_range_low' in value) || value['price_range_low'] === undefined) return false;
216
+ if (!('price_range_high' in value) || value['price_range_high'] === undefined) return false;
217
+ if (!('shares_offered' in value) || value['shares_offered'] === undefined) return false;
218
+ if (!('final_offer_price' in value) || value['final_offer_price'] === undefined) return false;
219
+ if (!('final_shares_offered' in value) || value['final_shares_offered'] === undefined) return false;
220
+ if (!('first_public_at' in value) || value['first_public_at'] === undefined) return false;
221
+ if (!('price_range_at' in value) || value['price_range_at'] === undefined) return false;
222
+ if (!('exchange_approved_at' in value) || value['exchange_approved_at'] === undefined) return false;
223
+ if (!('effective_at' in value) || value['effective_at'] === undefined) return false;
224
+ if (!('priced_at' in value) || value['priced_at'] === undefined) return false;
225
+ if (!('withdrawn_at' in value) || value['withdrawn_at'] === undefined) return false;
226
+ if (!('first_trade_date' in value) || value['first_trade_date'] === undefined) return false;
227
+ if (!('massive' in value) || value['massive'] === undefined) return false;
228
+ if (!('filings' in value) || value['filings'] === undefined) return false;
229
+ return true;
230
+ }
231
+
232
+ export function IposRegistrationsList200ResponseRegistrationsInnerFromJSON(json: any): IposRegistrationsList200ResponseRegistrationsInner {
233
+ return IposRegistrationsList200ResponseRegistrationsInnerFromJSONTyped(json, false);
234
+ }
235
+
236
+ export function IposRegistrationsList200ResponseRegistrationsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): IposRegistrationsList200ResponseRegistrationsInner {
237
+ if (json == null) {
238
+ return json;
239
+ }
240
+ return {
241
+
242
+ 'cik': json['cik'],
243
+ 'company_name': json['company_name'],
244
+ 'track_key': json['track_key'],
245
+ 'form_family': json['form_family'],
246
+ 'stage': json['stage'],
247
+ 'is_spac': json['is_spac'],
248
+ 'proposed_symbols': (json['proposed_symbols'] == null ? null : (json['proposed_symbols'] as Array<any>).map(ProposedSymbolFromJSON)),
249
+ 'exchange': json['exchange'],
250
+ 'price_range_low': json['price_range_low'],
251
+ 'price_range_high': json['price_range_high'],
252
+ 'shares_offered': json['shares_offered'],
253
+ 'final_offer_price': json['final_offer_price'],
254
+ 'final_shares_offered': json['final_shares_offered'],
255
+ 'first_public_at': (new Date(json['first_public_at'])),
256
+ 'price_range_at': (json['price_range_at'] == null ? null : new Date(json['price_range_at'])),
257
+ 'exchange_approved_at': (json['exchange_approved_at'] == null ? null : new Date(json['exchange_approved_at'])),
258
+ 'effective_at': (json['effective_at'] == null ? null : new Date(json['effective_at'])),
259
+ 'priced_at': (json['priced_at'] == null ? null : new Date(json['priced_at'])),
260
+ 'withdrawn_at': (json['withdrawn_at'] == null ? null : new Date(json['withdrawn_at'])),
261
+ 'first_trade_date': (json['first_trade_date'] == null ? null : new Date(json['first_trade_date'])),
262
+ 'massive': IposRegistrationsList200ResponseRegistrationsInnerMassiveFromJSON(json['massive']),
263
+ 'filings': ((json['filings'] as Array<any>).map(IposRegistrationsList200ResponseRegistrationsInnerFilingsInnerFromJSON)),
264
+ };
265
+ }
266
+
267
+ export function IposRegistrationsList200ResponseRegistrationsInnerToJSON(json: any): IposRegistrationsList200ResponseRegistrationsInner {
268
+ return IposRegistrationsList200ResponseRegistrationsInnerToJSONTyped(json, false);
269
+ }
270
+
271
+ export function IposRegistrationsList200ResponseRegistrationsInnerToJSONTyped(value?: IposRegistrationsList200ResponseRegistrationsInner | null, ignoreDiscriminator: boolean = false): any {
272
+ if (value == null) {
273
+ return value;
274
+ }
275
+
276
+ return {
277
+
278
+ 'cik': value['cik'],
279
+ 'company_name': value['company_name'],
280
+ 'track_key': value['track_key'],
281
+ 'form_family': value['form_family'],
282
+ 'stage': value['stage'],
283
+ 'is_spac': value['is_spac'],
284
+ 'proposed_symbols': (value['proposed_symbols'] == null ? null : (value['proposed_symbols'] as Array<any>).map(ProposedSymbolToJSON)),
285
+ 'exchange': value['exchange'],
286
+ 'price_range_low': value['price_range_low'],
287
+ 'price_range_high': value['price_range_high'],
288
+ 'shares_offered': value['shares_offered'],
289
+ 'final_offer_price': value['final_offer_price'],
290
+ 'final_shares_offered': value['final_shares_offered'],
291
+ 'first_public_at': value['first_public_at'].toISOString(),
292
+ 'price_range_at': value['price_range_at'] == null ? value['price_range_at'] : value['price_range_at'].toISOString(),
293
+ 'exchange_approved_at': value['exchange_approved_at'] == null ? value['exchange_approved_at'] : value['exchange_approved_at'].toISOString(),
294
+ 'effective_at': value['effective_at'] == null ? value['effective_at'] : value['effective_at'].toISOString(),
295
+ 'priced_at': value['priced_at'] == null ? value['priced_at'] : value['priced_at'].toISOString(),
296
+ 'withdrawn_at': value['withdrawn_at'] == null ? value['withdrawn_at'] : value['withdrawn_at'].toISOString(),
297
+ 'first_trade_date': value['first_trade_date'] == null ? value['first_trade_date'] : value['first_trade_date'].toISOString().substring(0,10),
298
+ 'massive': IposRegistrationsList200ResponseRegistrationsInnerMassiveToJSON(value['massive']),
299
+ 'filings': ((value['filings'] as Array<any>).map(IposRegistrationsList200ResponseRegistrationsInnerFilingsInnerToJSON)),
300
+ };
301
+ }
302
+