@invinite-org/data-api-client 5.6.0 → 5.7.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 (125) hide show
  1. package/.openapi-generator/FILES +26 -0
  2. package/dist/apis/HoldingsApi.d.ts +33 -0
  3. package/dist/apis/HoldingsApi.js +79 -1
  4. package/dist/apis/IPOsApi.d.ts +54 -0
  5. package/dist/apis/IPOsApi.js +137 -1
  6. package/dist/apis/InsiderTradesApi.d.ts +3 -0
  7. package/dist/apis/InsiderTradesApi.js +9 -0
  8. package/dist/esm/apis/HoldingsApi.d.ts +33 -0
  9. package/dist/esm/apis/HoldingsApi.js +78 -0
  10. package/dist/esm/apis/IPOsApi.d.ts +54 -0
  11. package/dist/esm/apis/IPOsApi.js +136 -0
  12. package/dist/esm/apis/InsiderTradesApi.d.ts +3 -0
  13. package/dist/esm/apis/InsiderTradesApi.js +9 -0
  14. package/dist/esm/models/Company.d.ts +1 -1
  15. package/dist/esm/models/Filer.d.ts +6 -0
  16. package/dist/esm/models/Filer.js +2 -0
  17. package/dist/esm/models/FilerDetail.d.ts +14 -0
  18. package/dist/esm/models/FilerDetail.js +6 -0
  19. package/dist/esm/models/FilerFund.d.ts +45 -0
  20. package/dist/esm/models/FilerFund.js +52 -0
  21. package/dist/esm/models/FilerFundAdviser.d.ts +56 -0
  22. package/dist/esm/models/FilerFundAdviser.js +59 -0
  23. package/dist/esm/models/FilerFundReturn.d.ts +62 -0
  24. package/dist/esm/models/FilerFundReturn.js +63 -0
  25. package/dist/esm/models/FilerFundSeries.d.ts +217 -0
  26. package/dist/esm/models/FilerFundSeries.js +169 -0
  27. package/dist/esm/models/FilerFundShareClass.d.ts +44 -0
  28. package/dist/esm/models/FilerFundShareClass.js +51 -0
  29. package/dist/esm/models/FilerPrivateOfferings.d.ts +62 -0
  30. package/dist/esm/models/FilerPrivateOfferings.js +63 -0
  31. package/dist/esm/models/FundHolding.d.ts +140 -0
  32. package/dist/esm/models/FundHolding.js +83 -0
  33. package/dist/esm/models/InsiderTrade.d.ts +101 -0
  34. package/dist/esm/models/InsiderTrade.js +71 -0
  35. package/dist/esm/models/InsiderTradeFootnote.d.ts +38 -0
  36. package/dist/esm/models/InsiderTradeFootnote.js +47 -0
  37. package/dist/esm/models/ListFundHoldings200Response.d.ts +52 -0
  38. package/dist/esm/models/ListFundHoldings200Response.js +57 -0
  39. package/dist/esm/models/ListOfferings200Response.d.ts +52 -0
  40. package/dist/esm/models/ListOfferings200Response.js +57 -0
  41. package/dist/esm/models/ListOfferings200ResponseMeta.d.ts +39 -0
  42. package/dist/esm/models/ListOfferings200ResponseMeta.js +44 -0
  43. package/dist/esm/models/Offering.d.ts +275 -0
  44. package/dist/esm/models/Offering.js +209 -0
  45. package/dist/esm/models/OfferingRelatedPerson.d.ts +44 -0
  46. package/dist/esm/models/OfferingRelatedPerson.js +51 -0
  47. package/dist/esm/models/index.d.ts +13 -0
  48. package/dist/esm/models/index.js +13 -0
  49. package/dist/models/Company.d.ts +1 -1
  50. package/dist/models/Filer.d.ts +6 -0
  51. package/dist/models/Filer.js +2 -0
  52. package/dist/models/FilerDetail.d.ts +14 -0
  53. package/dist/models/FilerDetail.js +6 -0
  54. package/dist/models/FilerFund.d.ts +45 -0
  55. package/dist/models/FilerFund.js +59 -0
  56. package/dist/models/FilerFundAdviser.d.ts +56 -0
  57. package/dist/models/FilerFundAdviser.js +66 -0
  58. package/dist/models/FilerFundReturn.d.ts +62 -0
  59. package/dist/models/FilerFundReturn.js +70 -0
  60. package/dist/models/FilerFundSeries.d.ts +217 -0
  61. package/dist/models/FilerFundSeries.js +177 -0
  62. package/dist/models/FilerFundShareClass.d.ts +44 -0
  63. package/dist/models/FilerFundShareClass.js +58 -0
  64. package/dist/models/FilerPrivateOfferings.d.ts +62 -0
  65. package/dist/models/FilerPrivateOfferings.js +70 -0
  66. package/dist/models/FundHolding.d.ts +140 -0
  67. package/dist/models/FundHolding.js +90 -0
  68. package/dist/models/InsiderTrade.d.ts +101 -0
  69. package/dist/models/InsiderTrade.js +72 -1
  70. package/dist/models/InsiderTradeFootnote.d.ts +38 -0
  71. package/dist/models/InsiderTradeFootnote.js +54 -0
  72. package/dist/models/ListFundHoldings200Response.d.ts +52 -0
  73. package/dist/models/ListFundHoldings200Response.js +64 -0
  74. package/dist/models/ListOfferings200Response.d.ts +52 -0
  75. package/dist/models/ListOfferings200Response.js +64 -0
  76. package/dist/models/ListOfferings200ResponseMeta.d.ts +39 -0
  77. package/dist/models/ListOfferings200ResponseMeta.js +51 -0
  78. package/dist/models/Offering.d.ts +275 -0
  79. package/dist/models/Offering.js +217 -0
  80. package/dist/models/OfferingRelatedPerson.d.ts +44 -0
  81. package/dist/models/OfferingRelatedPerson.js +58 -0
  82. package/dist/models/index.d.ts +13 -0
  83. package/dist/models/index.js +13 -0
  84. package/docs/CompaniesApi.md +2 -2
  85. package/docs/Filer.md +2 -0
  86. package/docs/FilerDetail.md +4 -0
  87. package/docs/FilerFund.md +39 -0
  88. package/docs/FilerFundAdviser.md +43 -0
  89. package/docs/FilerFundReturn.md +45 -0
  90. package/docs/FilerFundSeries.md +93 -0
  91. package/docs/FilerFundShareClass.md +39 -0
  92. package/docs/FilerPrivateOfferings.md +45 -0
  93. package/docs/FundHolding.md +70 -0
  94. package/docs/HoldingsApi.md +105 -0
  95. package/docs/IPOsApi.md +195 -0
  96. package/docs/InsiderTrade.md +28 -0
  97. package/docs/InsiderTradeFootnote.md +37 -0
  98. package/docs/InsiderTradesApi.md +10 -1
  99. package/docs/ListFundHoldings200Response.md +41 -0
  100. package/docs/ListOfferings200Response.md +41 -0
  101. package/docs/ListOfferings200ResponseMeta.md +37 -0
  102. package/docs/Offering.md +111 -0
  103. package/docs/OfferingRelatedPerson.md +39 -0
  104. package/package.json +1 -1
  105. package/src/apis/HoldingsApi.ts +107 -0
  106. package/src/apis/IPOsApi.ts +186 -0
  107. package/src/apis/InsiderTradesApi.ts +15 -0
  108. package/src/models/Company.ts +1 -1
  109. package/src/models/Filer.ts +8 -0
  110. package/src/models/FilerDetail.ts +30 -0
  111. package/src/models/FilerFund.ts +92 -0
  112. package/src/models/FilerFundAdviser.ts +102 -0
  113. package/src/models/FilerFundReturn.ts +111 -0
  114. package/src/models/FilerFundSeries.ts +360 -0
  115. package/src/models/FilerFundShareClass.ts +84 -0
  116. package/src/models/FilerPrivateOfferings.ts +111 -0
  117. package/src/models/FundHolding.ts +212 -0
  118. package/src/models/InsiderTrade.ts +152 -0
  119. package/src/models/InsiderTradeFootnote.ts +75 -0
  120. package/src/models/ListFundHoldings200Response.ts +108 -0
  121. package/src/models/ListOfferings200Response.ts +108 -0
  122. package/src/models/ListOfferings200ResponseMeta.ts +81 -0
  123. package/src/models/Offering.ts +433 -0
  124. package/src/models/OfferingRelatedPerson.ts +84 -0
  125. package/src/models/index.ts +13 -0
@@ -0,0 +1,108 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Invinite API
5
+ * Invinite financial data API. Each operation 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-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/webhooks` to the `event.*` lifecycle events (filtered by company) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the companies it mentions); 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; `event.test` 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`, `news.published` | ≤ 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 `event.test` 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. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. 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/me` and `/v1/me/usage` serve no licensed data and carry 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, News, WebSocket, Account.
6
+ *
7
+ * The version of the OpenAPI document: 2026-11-13
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 { ListOfferings200ResponseMeta } from './ListOfferings200ResponseMeta';
17
+ import {
18
+ ListOfferings200ResponseMetaFromJSON,
19
+ ListOfferings200ResponseMetaFromJSONTyped,
20
+ ListOfferings200ResponseMetaToJSON,
21
+ ListOfferings200ResponseMetaToJSONTyped,
22
+ } from './ListOfferings200ResponseMeta';
23
+ import type { Offering } from './Offering';
24
+ import {
25
+ OfferingFromJSON,
26
+ OfferingFromJSONTyped,
27
+ OfferingToJSON,
28
+ OfferingToJSONTyped,
29
+ } from './Offering';
30
+
31
+ /**
32
+ * A page of Offering rows (the list envelope, R3)
33
+ * @export
34
+ * @interface ListOfferings200Response
35
+ */
36
+ export interface ListOfferings200Response {
37
+ /**
38
+ * The rows of this page
39
+ * @type {Array<Offering>}
40
+ * @memberof ListOfferings200Response
41
+ */
42
+ data: Array<Offering>;
43
+ /**
44
+ * true when a next page exists
45
+ * @type {boolean}
46
+ * @memberof ListOfferings200Response
47
+ */
48
+ has_more: boolean;
49
+ /**
50
+ * Opaque cursor of the next page; null on the last page
51
+ * @type {string}
52
+ * @memberof ListOfferings200Response
53
+ */
54
+ next_cursor: string | null;
55
+ /**
56
+ *
57
+ * @type {ListOfferings200ResponseMeta}
58
+ * @memberof ListOfferings200Response
59
+ */
60
+ meta: ListOfferings200ResponseMeta;
61
+ }
62
+
63
+ /**
64
+ * Check if a given object implements the ListOfferings200Response interface.
65
+ */
66
+ export function instanceOfListOfferings200Response(value: object): value is ListOfferings200Response {
67
+ if (!('data' in value) || value['data'] === undefined) return false;
68
+ if (!('has_more' in value) || value['has_more'] === undefined) return false;
69
+ if (!('next_cursor' in value) || value['next_cursor'] === undefined) return false;
70
+ if (!('meta' in value) || value['meta'] === undefined) return false;
71
+ return true;
72
+ }
73
+
74
+ export function ListOfferings200ResponseFromJSON(json: any): ListOfferings200Response {
75
+ return ListOfferings200ResponseFromJSONTyped(json, false);
76
+ }
77
+
78
+ export function ListOfferings200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListOfferings200Response {
79
+ if (json == null) {
80
+ return json;
81
+ }
82
+ return {
83
+
84
+ 'data': ((json['data'] as Array<any>).map(OfferingFromJSON)),
85
+ 'has_more': json['has_more'],
86
+ 'next_cursor': json['next_cursor'],
87
+ 'meta': ListOfferings200ResponseMetaFromJSON(json['meta']),
88
+ };
89
+ }
90
+
91
+ export function ListOfferings200ResponseToJSON(json: any): ListOfferings200Response {
92
+ return ListOfferings200ResponseToJSONTyped(json, false);
93
+ }
94
+
95
+ export function ListOfferings200ResponseToJSONTyped(value?: ListOfferings200Response | null, ignoreDiscriminator: boolean = false): any {
96
+ if (value == null) {
97
+ return value;
98
+ }
99
+
100
+ return {
101
+
102
+ 'data': ((value['data'] as Array<any>).map(OfferingToJSON)),
103
+ 'has_more': value['has_more'],
104
+ 'next_cursor': value['next_cursor'],
105
+ 'meta': ListOfferings200ResponseMetaToJSON(value['meta']),
106
+ };
107
+ }
108
+
@@ -0,0 +1,81 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Invinite API
5
+ * Invinite financial data API. Each operation 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-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/webhooks` to the `event.*` lifecycle events (filtered by company) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the companies it mentions); 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; `event.test` 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`, `news.published` | ≤ 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 `event.test` 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. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. 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/me` and `/v1/me/usage` serve no licensed data and carry 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, News, WebSocket, Account.
6
+ *
7
+ * The version of the OpenAPI document: 2026-11-13
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 { MetaCoverage } from './MetaCoverage';
17
+ import {
18
+ MetaCoverageFromJSON,
19
+ MetaCoverageFromJSONTyped,
20
+ MetaCoverageToJSON,
21
+ MetaCoverageToJSONTyped,
22
+ } from './MetaCoverage';
23
+
24
+ /**
25
+ * Page metadata
26
+ * @export
27
+ * @interface ListOfferings200ResponseMeta
28
+ */
29
+ export interface ListOfferings200ResponseMeta {
30
+ /**
31
+ *
32
+ * @type {MetaCoverage}
33
+ * @memberof ListOfferings200ResponseMeta
34
+ */
35
+ coverage?: MetaCoverage;
36
+ /**
37
+ * Instant the page reads the offerings at
38
+ * @type {Date}
39
+ * @memberof ListOfferings200ResponseMeta
40
+ */
41
+ pinned_at?: Date | null;
42
+ }
43
+
44
+ /**
45
+ * Check if a given object implements the ListOfferings200ResponseMeta interface.
46
+ */
47
+ export function instanceOfListOfferings200ResponseMeta(value: object): value is ListOfferings200ResponseMeta {
48
+ return true;
49
+ }
50
+
51
+ export function ListOfferings200ResponseMetaFromJSON(json: any): ListOfferings200ResponseMeta {
52
+ return ListOfferings200ResponseMetaFromJSONTyped(json, false);
53
+ }
54
+
55
+ export function ListOfferings200ResponseMetaFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListOfferings200ResponseMeta {
56
+ if (json == null) {
57
+ return json;
58
+ }
59
+ return {
60
+
61
+ 'coverage': json['coverage'] == null ? undefined : MetaCoverageFromJSON(json['coverage']),
62
+ 'pinned_at': json['pinned_at'] == null ? undefined : (new Date(json['pinned_at'])),
63
+ };
64
+ }
65
+
66
+ export function ListOfferings200ResponseMetaToJSON(json: any): ListOfferings200ResponseMeta {
67
+ return ListOfferings200ResponseMetaToJSONTyped(json, false);
68
+ }
69
+
70
+ export function ListOfferings200ResponseMetaToJSONTyped(value?: ListOfferings200ResponseMeta | null, ignoreDiscriminator: boolean = false): any {
71
+ if (value == null) {
72
+ return value;
73
+ }
74
+
75
+ return {
76
+
77
+ 'coverage': MetaCoverageToJSON(value['coverage']),
78
+ 'pinned_at': value['pinned_at'] == null ? value['pinned_at'] : value['pinned_at'].toISOString(),
79
+ };
80
+ }
81
+
@@ -0,0 +1,433 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Invinite API
5
+ * Invinite financial data API. Each operation 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-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/webhooks` to the `event.*` lifecycle events (filtered by company) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the companies it mentions); 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; `event.test` 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`, `news.published` | ≤ 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 `event.test` 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. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. 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/me` and `/v1/me/usage` serve no licensed data and carry 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, News, WebSocket, Account.
6
+ *
7
+ * The version of the OpenAPI document: 2026-11-13
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 { OfferingRelatedPerson } from './OfferingRelatedPerson';
17
+ import {
18
+ OfferingRelatedPersonFromJSON,
19
+ OfferingRelatedPersonFromJSONTyped,
20
+ OfferingRelatedPersonToJSON,
21
+ OfferingRelatedPersonToJSONTyped,
22
+ } from './OfferingRelatedPerson';
23
+
24
+ /**
25
+ * One Form D private offering (Regulation D / Section 4(a)(5) exempt offering): the latest filing's facts and the held filing history
26
+ * @export
27
+ * @interface Offering
28
+ */
29
+ export interface Offering {
30
+ /**
31
+ * Offering id: SEC's Form D file number (one per offering; every amendment keeps it), or the first accession number for an offering whose filings state none
32
+ * @type {string}
33
+ * @memberof Offering
34
+ */
35
+ offering_id: string;
36
+ /**
37
+ * Form D file number (021-…); null when the offering is keyed by its first accession
38
+ * @type {string}
39
+ * @memberof Offering
40
+ */
41
+ file_number: string | null;
42
+ /**
43
+ * Accession number of the earliest held filing of the offering
44
+ * @type {string}
45
+ * @memberof Offering
46
+ */
47
+ first_accession: string;
48
+ /**
49
+ * Accession number of the latest filing (the row's facts are from it)
50
+ * @type {string}
51
+ * @memberof Offering
52
+ */
53
+ latest_accession: string;
54
+ /**
55
+ * Accession numbers of the held filings, in filing order
56
+ * @type {Array<string>}
57
+ * @memberof Offering
58
+ */
59
+ accessions: Array<string>;
60
+ /**
61
+ * Primary issuer CIK, 10 digits
62
+ * @type {string}
63
+ * @memberof Offering
64
+ */
65
+ primary_issuer_cik: string;
66
+ /**
67
+ * Primary issuer name as filed
68
+ * @type {string}
69
+ * @memberof Offering
70
+ */
71
+ issuer_name: string | null;
72
+ /**
73
+ * CIKs of the other issuers of the offering, 10 digits
74
+ * @type {Array<string>}
75
+ * @memberof Offering
76
+ */
77
+ co_issuer_ciks: Array<string>;
78
+ /**
79
+ * Filing date of the earliest held filing
80
+ * @type {Date}
81
+ * @memberof Offering
82
+ */
83
+ filed_first: Date | null;
84
+ /**
85
+ * Filing date of the latest filing
86
+ * @type {Date}
87
+ * @memberof Offering
88
+ */
89
+ filed_latest: Date | null;
90
+ /**
91
+ * Date of first sale as filed
92
+ * @type {Date}
93
+ * @memberof Offering
94
+ */
95
+ sale_date: Date | null;
96
+ /**
97
+ * The first sale has yet to occur
98
+ * @type {boolean}
99
+ * @memberof Offering
100
+ */
101
+ first_sale_yet_to_occur: boolean | null;
102
+ /**
103
+ * Number of held amendments (D/A)
104
+ * @type {number}
105
+ * @memberof Offering
106
+ */
107
+ amendment_count: number;
108
+ /**
109
+ * The original Form D is inside the held window (five years of quarterly data sets); false = the history starts with an amendment
110
+ * @type {boolean}
111
+ * @memberof Offering
112
+ */
113
+ original_held: boolean;
114
+ /**
115
+ * The latest filing is an amendment (D/A)
116
+ * @type {boolean}
117
+ * @memberof Offering
118
+ */
119
+ is_amendment: boolean;
120
+ /**
121
+ * Federal exemptions and exclusions claimed, as filed: 06b (Rule 506(b)), 06c (Rule 506(c)), 04 (Rule 504), 4a5, 3C, 3C.1, 3C.7, …
122
+ * @type {Array<string>}
123
+ * @memberof Offering
124
+ */
125
+ exemptions: Array<string>;
126
+ /**
127
+ * Industry group as filed (Pooled Investment Fund, Other Technology, …)
128
+ * @type {string}
129
+ * @memberof Offering
130
+ */
131
+ industry_group: string | null;
132
+ /**
133
+ * Investment fund type as filed (Hedge Fund, Private Equity Fund, …)
134
+ * @type {string}
135
+ * @memberof Offering
136
+ */
137
+ investment_fund_type: string | null;
138
+ /**
139
+ * The issuer is registered (or must register) under the Investment Company Act of 1940
140
+ * @type {boolean}
141
+ * @memberof Offering
142
+ */
143
+ is_40_act: boolean | null;
144
+ /**
145
+ * Types of securities offered
146
+ * @type {Array<OfferingSecurityTypesEnum>}
147
+ * @memberof Offering
148
+ */
149
+ security_types: Array<OfferingSecurityTypesEnum>;
150
+ /**
151
+ * The offering is made in connection with a business combination
152
+ * @type {boolean}
153
+ * @memberof Offering
154
+ */
155
+ is_business_combination: boolean | null;
156
+ /**
157
+ * The offering is expected to last more than one year
158
+ * @type {boolean}
159
+ * @memberof Offering
160
+ */
161
+ more_than_one_year: boolean | null;
162
+ /**
163
+ * Minimum investment accepted from an outside investor (USD)
164
+ * @type {number}
165
+ * @memberof Offering
166
+ */
167
+ min_investment: number | null;
168
+ /**
169
+ * Total offering amount (USD); null when indefinite
170
+ * @type {number}
171
+ * @memberof Offering
172
+ */
173
+ total_offering_amount: number | null;
174
+ /**
175
+ * Total amount sold (USD)
176
+ * @type {number}
177
+ * @memberof Offering
178
+ */
179
+ total_sold: number | null;
180
+ /**
181
+ * Total amount remaining to be sold (USD); null when indefinite
182
+ * @type {number}
183
+ * @memberof Offering
184
+ */
185
+ total_remaining: number | null;
186
+ /**
187
+ * The offering amount is stated as indefinite
188
+ * @type {boolean}
189
+ * @memberof Offering
190
+ */
191
+ indefinite_amount: boolean;
192
+ /**
193
+ * Securities were sold to non-accredited investors
194
+ * @type {boolean}
195
+ * @memberof Offering
196
+ */
197
+ has_non_accredited: boolean | null;
198
+ /**
199
+ * Number of non-accredited investors who invested
200
+ * @type {number}
201
+ * @memberof Offering
202
+ */
203
+ non_accredited_count: number | null;
204
+ /**
205
+ * Total number of investors who invested
206
+ * @type {number}
207
+ * @memberof Offering
208
+ */
209
+ investor_count: number | null;
210
+ /**
211
+ * Issuer revenue range as filed (No Revenues, $1 - $1,000,000, Decline to Disclose, …)
212
+ * @type {string}
213
+ * @memberof Offering
214
+ */
215
+ revenue_range: string | null;
216
+ /**
217
+ * Issuer net asset value range as filed (funds)
218
+ * @type {string}
219
+ * @memberof Offering
220
+ */
221
+ net_asset_value_range: string | null;
222
+ /**
223
+ * Sales commissions (USD)
224
+ * @type {number}
225
+ * @memberof Offering
226
+ */
227
+ sales_commission: number | null;
228
+ /**
229
+ * Finders' fees (USD)
230
+ * @type {number}
231
+ * @memberof Offering
232
+ */
233
+ finders_fee: number | null;
234
+ /**
235
+ * Related persons as filed
236
+ * @type {Array<OfferingRelatedPerson>}
237
+ * @memberof Offering
238
+ */
239
+ related_persons: Array<OfferingRelatedPerson>;
240
+ /**
241
+ * SIC code of the issuer
242
+ * @type {string}
243
+ * @memberof Offering
244
+ */
245
+ sic_code: string | null;
246
+ /**
247
+ * Jurisdiction of incorporation as filed
248
+ * @type {string}
249
+ * @memberof Offering
250
+ */
251
+ jurisdiction: string | null;
252
+ /**
253
+ * Entity type as filed (Corporation, Limited Partnership, …)
254
+ * @type {string}
255
+ * @memberof Offering
256
+ */
257
+ entity_type: string | null;
258
+ /**
259
+ * Year of incorporation as filed (a year, or Over Five Years / Within Last Five Years)
260
+ * @type {string}
261
+ * @memberof Offering
262
+ */
263
+ year_of_inc: string | null;
264
+ }
265
+
266
+
267
+ /**
268
+ * @export
269
+ */
270
+ export const OfferingSecurityTypesEnum = {
271
+ Equity: 'equity',
272
+ Debt: 'debt',
273
+ OptionToAcquire: 'option_to_acquire',
274
+ SecurityToBeAcquired: 'security_to_be_acquired',
275
+ PooledInvestmentFund: 'pooled_investment_fund',
276
+ TenantInCommon: 'tenant_in_common',
277
+ MineralProperty: 'mineral_property',
278
+ Other: 'other'
279
+ } as const;
280
+ export type OfferingSecurityTypesEnum = typeof OfferingSecurityTypesEnum[keyof typeof OfferingSecurityTypesEnum] | (string & {});
281
+
282
+
283
+ /**
284
+ * Check if a given object implements the Offering interface.
285
+ */
286
+ export function instanceOfOffering(value: object): value is Offering {
287
+ if (!('offering_id' in value) || value['offering_id'] === undefined) return false;
288
+ if (!('file_number' in value) || value['file_number'] === undefined) return false;
289
+ if (!('first_accession' in value) || value['first_accession'] === undefined) return false;
290
+ if (!('latest_accession' in value) || value['latest_accession'] === undefined) return false;
291
+ if (!('accessions' in value) || value['accessions'] === undefined) return false;
292
+ if (!('primary_issuer_cik' in value) || value['primary_issuer_cik'] === undefined) return false;
293
+ if (!('issuer_name' in value) || value['issuer_name'] === undefined) return false;
294
+ if (!('co_issuer_ciks' in value) || value['co_issuer_ciks'] === undefined) return false;
295
+ if (!('filed_first' in value) || value['filed_first'] === undefined) return false;
296
+ if (!('filed_latest' in value) || value['filed_latest'] === undefined) return false;
297
+ if (!('sale_date' in value) || value['sale_date'] === undefined) return false;
298
+ if (!('first_sale_yet_to_occur' in value) || value['first_sale_yet_to_occur'] === undefined) return false;
299
+ if (!('amendment_count' in value) || value['amendment_count'] === undefined) return false;
300
+ if (!('original_held' in value) || value['original_held'] === undefined) return false;
301
+ if (!('is_amendment' in value) || value['is_amendment'] === undefined) return false;
302
+ if (!('exemptions' in value) || value['exemptions'] === undefined) return false;
303
+ if (!('industry_group' in value) || value['industry_group'] === undefined) return false;
304
+ if (!('investment_fund_type' in value) || value['investment_fund_type'] === undefined) return false;
305
+ if (!('is_40_act' in value) || value['is_40_act'] === undefined) return false;
306
+ if (!('security_types' in value) || value['security_types'] === undefined) return false;
307
+ if (!('is_business_combination' in value) || value['is_business_combination'] === undefined) return false;
308
+ if (!('more_than_one_year' in value) || value['more_than_one_year'] === undefined) return false;
309
+ if (!('min_investment' in value) || value['min_investment'] === undefined) return false;
310
+ if (!('total_offering_amount' in value) || value['total_offering_amount'] === undefined) return false;
311
+ if (!('total_sold' in value) || value['total_sold'] === undefined) return false;
312
+ if (!('total_remaining' in value) || value['total_remaining'] === undefined) return false;
313
+ if (!('indefinite_amount' in value) || value['indefinite_amount'] === undefined) return false;
314
+ if (!('has_non_accredited' in value) || value['has_non_accredited'] === undefined) return false;
315
+ if (!('non_accredited_count' in value) || value['non_accredited_count'] === undefined) return false;
316
+ if (!('investor_count' in value) || value['investor_count'] === undefined) return false;
317
+ if (!('revenue_range' in value) || value['revenue_range'] === undefined) return false;
318
+ if (!('net_asset_value_range' in value) || value['net_asset_value_range'] === undefined) return false;
319
+ if (!('sales_commission' in value) || value['sales_commission'] === undefined) return false;
320
+ if (!('finders_fee' in value) || value['finders_fee'] === undefined) return false;
321
+ if (!('related_persons' in value) || value['related_persons'] === undefined) return false;
322
+ if (!('sic_code' in value) || value['sic_code'] === undefined) return false;
323
+ if (!('jurisdiction' in value) || value['jurisdiction'] === undefined) return false;
324
+ if (!('entity_type' in value) || value['entity_type'] === undefined) return false;
325
+ if (!('year_of_inc' in value) || value['year_of_inc'] === undefined) return false;
326
+ return true;
327
+ }
328
+
329
+ export function OfferingFromJSON(json: any): Offering {
330
+ return OfferingFromJSONTyped(json, false);
331
+ }
332
+
333
+ export function OfferingFromJSONTyped(json: any, ignoreDiscriminator: boolean): Offering {
334
+ if (json == null) {
335
+ return json;
336
+ }
337
+ return {
338
+
339
+ 'offering_id': json['offering_id'],
340
+ 'file_number': json['file_number'],
341
+ 'first_accession': json['first_accession'],
342
+ 'latest_accession': json['latest_accession'],
343
+ 'accessions': json['accessions'],
344
+ 'primary_issuer_cik': json['primary_issuer_cik'],
345
+ 'issuer_name': json['issuer_name'],
346
+ 'co_issuer_ciks': json['co_issuer_ciks'],
347
+ 'filed_first': (json['filed_first'] == null ? null : new Date(json['filed_first'])),
348
+ 'filed_latest': (json['filed_latest'] == null ? null : new Date(json['filed_latest'])),
349
+ 'sale_date': (json['sale_date'] == null ? null : new Date(json['sale_date'])),
350
+ 'first_sale_yet_to_occur': json['first_sale_yet_to_occur'],
351
+ 'amendment_count': json['amendment_count'],
352
+ 'original_held': json['original_held'],
353
+ 'is_amendment': json['is_amendment'],
354
+ 'exemptions': json['exemptions'],
355
+ 'industry_group': json['industry_group'],
356
+ 'investment_fund_type': json['investment_fund_type'],
357
+ 'is_40_act': json['is_40_act'],
358
+ 'security_types': json['security_types'],
359
+ 'is_business_combination': json['is_business_combination'],
360
+ 'more_than_one_year': json['more_than_one_year'],
361
+ 'min_investment': json['min_investment'],
362
+ 'total_offering_amount': json['total_offering_amount'],
363
+ 'total_sold': json['total_sold'],
364
+ 'total_remaining': json['total_remaining'],
365
+ 'indefinite_amount': json['indefinite_amount'],
366
+ 'has_non_accredited': json['has_non_accredited'],
367
+ 'non_accredited_count': json['non_accredited_count'],
368
+ 'investor_count': json['investor_count'],
369
+ 'revenue_range': json['revenue_range'],
370
+ 'net_asset_value_range': json['net_asset_value_range'],
371
+ 'sales_commission': json['sales_commission'],
372
+ 'finders_fee': json['finders_fee'],
373
+ 'related_persons': ((json['related_persons'] as Array<any>).map(OfferingRelatedPersonFromJSON)),
374
+ 'sic_code': json['sic_code'],
375
+ 'jurisdiction': json['jurisdiction'],
376
+ 'entity_type': json['entity_type'],
377
+ 'year_of_inc': json['year_of_inc'],
378
+ };
379
+ }
380
+
381
+ export function OfferingToJSON(json: any): Offering {
382
+ return OfferingToJSONTyped(json, false);
383
+ }
384
+
385
+ export function OfferingToJSONTyped(value?: Offering | null, ignoreDiscriminator: boolean = false): any {
386
+ if (value == null) {
387
+ return value;
388
+ }
389
+
390
+ return {
391
+
392
+ 'offering_id': value['offering_id'],
393
+ 'file_number': value['file_number'],
394
+ 'first_accession': value['first_accession'],
395
+ 'latest_accession': value['latest_accession'],
396
+ 'accessions': value['accessions'],
397
+ 'primary_issuer_cik': value['primary_issuer_cik'],
398
+ 'issuer_name': value['issuer_name'],
399
+ 'co_issuer_ciks': value['co_issuer_ciks'],
400
+ 'filed_first': value['filed_first'] == null ? value['filed_first'] : value['filed_first'].toISOString().substring(0,10),
401
+ 'filed_latest': value['filed_latest'] == null ? value['filed_latest'] : value['filed_latest'].toISOString().substring(0,10),
402
+ 'sale_date': value['sale_date'] == null ? value['sale_date'] : value['sale_date'].toISOString().substring(0,10),
403
+ 'first_sale_yet_to_occur': value['first_sale_yet_to_occur'],
404
+ 'amendment_count': value['amendment_count'],
405
+ 'original_held': value['original_held'],
406
+ 'is_amendment': value['is_amendment'],
407
+ 'exemptions': value['exemptions'],
408
+ 'industry_group': value['industry_group'],
409
+ 'investment_fund_type': value['investment_fund_type'],
410
+ 'is_40_act': value['is_40_act'],
411
+ 'security_types': value['security_types'],
412
+ 'is_business_combination': value['is_business_combination'],
413
+ 'more_than_one_year': value['more_than_one_year'],
414
+ 'min_investment': value['min_investment'],
415
+ 'total_offering_amount': value['total_offering_amount'],
416
+ 'total_sold': value['total_sold'],
417
+ 'total_remaining': value['total_remaining'],
418
+ 'indefinite_amount': value['indefinite_amount'],
419
+ 'has_non_accredited': value['has_non_accredited'],
420
+ 'non_accredited_count': value['non_accredited_count'],
421
+ 'investor_count': value['investor_count'],
422
+ 'revenue_range': value['revenue_range'],
423
+ 'net_asset_value_range': value['net_asset_value_range'],
424
+ 'sales_commission': value['sales_commission'],
425
+ 'finders_fee': value['finders_fee'],
426
+ 'related_persons': ((value['related_persons'] as Array<any>).map(OfferingRelatedPersonToJSON)),
427
+ 'sic_code': value['sic_code'],
428
+ 'jurisdiction': value['jurisdiction'],
429
+ 'entity_type': value['entity_type'],
430
+ 'year_of_inc': value['year_of_inc'],
431
+ };
432
+ }
433
+