@invinite-org/data-api-client 2.0.0 → 3.0.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 (94) hide show
  1. package/.openapi-generator/FILES +13 -2
  2. package/dist/apis/AsReportedBalanceSheetApi.d.ts +29 -2
  3. package/dist/apis/AsReportedBalanceSheetApi.js +33 -3
  4. package/dist/apis/AsReportedCashFlowStatementApi.d.ts +56 -2
  5. package/dist/apis/AsReportedCashFlowStatementApi.js +63 -3
  6. package/dist/apis/AsReportedIncomeStatementApi.d.ts +29 -2
  7. package/dist/apis/AsReportedIncomeStatementApi.js +33 -3
  8. package/dist/apis/AsReportedSnapshotApi.d.ts +59 -5
  9. package/dist/apis/AsReportedSnapshotApi.js +65 -5
  10. package/dist/esm/apis/AsReportedBalanceSheetApi.d.ts +29 -2
  11. package/dist/esm/apis/AsReportedBalanceSheetApi.js +32 -2
  12. package/dist/esm/apis/AsReportedCashFlowStatementApi.d.ts +56 -2
  13. package/dist/esm/apis/AsReportedCashFlowStatementApi.js +62 -2
  14. package/dist/esm/apis/AsReportedIncomeStatementApi.d.ts +29 -2
  15. package/dist/esm/apis/AsReportedIncomeStatementApi.js +32 -2
  16. package/dist/esm/apis/AsReportedSnapshotApi.d.ts +59 -5
  17. package/dist/esm/apis/AsReportedSnapshotApi.js +64 -4
  18. package/dist/esm/models/{AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue.d.ts → AsReportedDetailedFact.d.ts} +39 -21
  19. package/dist/esm/models/{AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue.js → AsReportedDetailedFact.js} +33 -13
  20. package/dist/esm/models/AsReportedFact.d.ts +38 -0
  21. package/dist/esm/models/AsReportedFact.js +47 -0
  22. package/dist/esm/models/AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner.d.ts +3 -2
  23. package/dist/esm/models/AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner.js +4 -2
  24. package/dist/esm/models/AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner.d.ts +3 -3
  25. package/dist/esm/models/AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner.js +3 -3
  26. package/dist/esm/models/AsReportedSnapshot200Response.d.ts +33 -0
  27. package/dist/esm/models/AsReportedSnapshot200Response.js +44 -0
  28. package/dist/esm/models/AsReportedSnapshot200ResponseCompaniesInner.d.ts +91 -0
  29. package/dist/esm/models/AsReportedSnapshot200ResponseCompaniesInner.js +85 -0
  30. package/dist/esm/models/AsReportedSnapshot200ResponseCompaniesInnerStatements.d.ts +45 -0
  31. package/dist/esm/models/AsReportedSnapshot200ResponseCompaniesInnerStatements.js +52 -0
  32. package/dist/esm/models/AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement.d.ts +35 -0
  33. package/dist/esm/models/AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement.js +43 -0
  34. package/dist/esm/models/AsReportedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement.d.ts +3 -3
  35. package/dist/esm/models/AsReportedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement.js +3 -3
  36. package/dist/esm/models/InsiderTradesList200ResponseTransactionsInner.d.ts +4 -4
  37. package/dist/esm/models/PresentationFact.d.ts +12 -0
  38. package/dist/esm/models/PresentationFact.js +4 -0
  39. package/dist/esm/models/index.d.ts +6 -1
  40. package/dist/esm/models/index.js +6 -1
  41. package/dist/models/{AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue.d.ts → AsReportedDetailedFact.d.ts} +39 -21
  42. package/dist/models/{AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue.js → AsReportedDetailedFact.js} +38 -18
  43. package/dist/models/AsReportedFact.d.ts +38 -0
  44. package/dist/models/AsReportedFact.js +54 -0
  45. package/dist/models/AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner.d.ts +3 -2
  46. package/dist/models/AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner.js +4 -2
  47. package/dist/models/AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner.d.ts +3 -3
  48. package/dist/models/AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner.js +3 -3
  49. package/dist/models/AsReportedSnapshot200Response.d.ts +33 -0
  50. package/dist/models/AsReportedSnapshot200Response.js +51 -0
  51. package/dist/models/AsReportedSnapshot200ResponseCompaniesInner.d.ts +91 -0
  52. package/dist/models/AsReportedSnapshot200ResponseCompaniesInner.js +93 -0
  53. package/dist/models/AsReportedSnapshot200ResponseCompaniesInnerStatements.d.ts +45 -0
  54. package/dist/models/AsReportedSnapshot200ResponseCompaniesInnerStatements.js +59 -0
  55. package/dist/models/AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement.d.ts +35 -0
  56. package/dist/models/AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement.js +50 -0
  57. package/dist/models/AsReportedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement.d.ts +3 -3
  58. package/dist/models/AsReportedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement.js +3 -3
  59. package/dist/models/InsiderTradesList200ResponseTransactionsInner.d.ts +4 -4
  60. package/dist/models/PresentationFact.d.ts +12 -0
  61. package/dist/models/PresentationFact.js +4 -0
  62. package/dist/models/index.d.ts +6 -1
  63. package/dist/models/index.js +6 -1
  64. package/docs/AsReportedBalanceSheetApi.md +15 -6
  65. package/docs/AsReportedCashFlowStatementApi.md +24 -6
  66. package/docs/{AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue.md → AsReportedDetailedFact.md} +12 -6
  67. package/docs/AsReportedFact.md +36 -0
  68. package/docs/AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner.md +1 -1
  69. package/docs/AsReportedIncomeStatementApi.md +15 -6
  70. package/docs/AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner.md +1 -1
  71. package/docs/AsReportedSnapshot200Response.md +34 -0
  72. package/docs/AsReportedSnapshot200ResponseCompaniesInner.md +50 -0
  73. package/docs/AsReportedSnapshot200ResponseCompaniesInnerStatements.md +38 -0
  74. package/docs/AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement.md +35 -0
  75. package/docs/AsReportedSnapshotApi.md +25 -7
  76. package/docs/AsReportedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement.md +1 -1
  77. package/docs/PresentationFact.md +4 -0
  78. package/package.json +1 -1
  79. package/src/apis/AsReportedBalanceSheetApi.ts +41 -2
  80. package/src/apis/AsReportedCashFlowStatementApi.ts +80 -2
  81. package/src/apis/AsReportedIncomeStatementApi.ts +41 -2
  82. package/src/apis/AsReportedSnapshotApi.ts +88 -10
  83. package/src/models/{AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue.ts → AsReportedDetailedFact.ts} +59 -28
  84. package/src/models/AsReportedFact.ts +75 -0
  85. package/src/models/AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner.ts +12 -4
  86. package/src/models/AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner.ts +10 -10
  87. package/src/models/AsReportedSnapshot200Response.ts +74 -0
  88. package/src/models/AsReportedSnapshot200ResponseCompaniesInner.ts +159 -0
  89. package/src/models/AsReportedSnapshot200ResponseCompaniesInnerStatements.ts +92 -0
  90. package/src/models/AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement.ts +73 -0
  91. package/src/models/AsReportedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement.ts +10 -10
  92. package/src/models/InsiderTradesList200ResponseTransactionsInner.ts +4 -4
  93. package/src/models/PresentationFact.ts +16 -0
  94. package/src/models/index.ts +6 -1
@@ -0,0 +1,43 @@
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. **Coverage.** Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`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/company/available-companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the CIKs 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; `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`, `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 `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. 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/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, News, 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
+ import { mapValues } from '../runtime';
15
+ import { AsReportedFactFromJSON, AsReportedFactToJSON, } from './AsReportedFact';
16
+ /**
17
+ * Check if a given object implements the AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement interface.
18
+ */
19
+ export function instanceOfAsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement(value) {
20
+ return true;
21
+ }
22
+ export function AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatementFromJSON(json) {
23
+ return AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatementFromJSONTyped(json, false);
24
+ }
25
+ export function AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatementFromJSONTyped(json, ignoreDiscriminator) {
26
+ if (json == null) {
27
+ return json;
28
+ }
29
+ return {
30
+ 'facts': json['facts'] == null ? undefined : (mapValues(json['facts'], AsReportedFactFromJSON)),
31
+ };
32
+ }
33
+ export function AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatementToJSON(json) {
34
+ return AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatementToJSONTyped(json, false);
35
+ }
36
+ export function AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatementToJSONTyped(value, ignoreDiscriminator = false) {
37
+ if (value == null) {
38
+ return value;
39
+ }
40
+ return {
41
+ 'facts': value['facts'] == null ? undefined : (mapValues(value['facts'], AsReportedFactToJSON)),
42
+ };
43
+ }
@@ -9,7 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import type { AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue } from './AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue';
12
+ import type { AsReportedDetailedFact } from './AsReportedDetailedFact';
13
13
  /**
14
14
  * Latest income statement facts or null if not available
15
15
  * @export
@@ -18,11 +18,11 @@ import type { AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsI
18
18
  export interface AsReportedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement {
19
19
  /**
20
20
  *
21
- * @type {{ [key: string]: AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue; }}
21
+ * @type {{ [key: string]: AsReportedDetailedFact; }}
22
22
  * @memberof AsReportedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement
23
23
  */
24
24
  facts?: {
25
- [key: string]: AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue;
25
+ [key: string]: AsReportedDetailedFact;
26
26
  };
27
27
  }
28
28
  /**
@@ -12,7 +12,7 @@
12
12
  * Do not edit the class manually.
13
13
  */
14
14
  import { mapValues } from '../runtime';
15
- import { AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFromJSON, AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueToJSON, } from './AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue';
15
+ import { AsReportedDetailedFactFromJSON, AsReportedDetailedFactToJSON, } from './AsReportedDetailedFact';
16
16
  /**
17
17
  * Check if a given object implements the AsReportedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement interface.
18
18
  */
@@ -27,7 +27,7 @@ export function AsReportedSnapshotDetailed200ResponseCompaniesInnerStatementsInc
27
27
  return json;
28
28
  }
29
29
  return {
30
- 'facts': json['facts'] == null ? undefined : (mapValues(json['facts'], AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFromJSON)),
30
+ 'facts': json['facts'] == null ? undefined : (mapValues(json['facts'], AsReportedDetailedFactFromJSON)),
31
31
  };
32
32
  }
33
33
  export function AsReportedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatementToJSON(json) {
@@ -38,6 +38,6 @@ export function AsReportedSnapshotDetailed200ResponseCompaniesInnerStatementsInc
38
38
  return value;
39
39
  }
40
40
  return {
41
- 'facts': value['facts'] == null ? undefined : (mapValues(value['facts'], AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueToJSON)),
41
+ 'facts': value['facts'] == null ? undefined : (mapValues(value['facts'], AsReportedDetailedFactToJSON)),
42
42
  };
43
43
  }
@@ -112,17 +112,17 @@ export interface InsiderTradesList200ResponseTransactionsInner {
112
112
  */
113
113
  shares: number;
114
114
  /**
115
- * Price per share
115
+ * Price per share (null when the filing states none, e.g. a gift or grant)
116
116
  * @type {number}
117
117
  * @memberof InsiderTradesList200ResponseTransactionsInner
118
118
  */
119
- share_price: number;
119
+ share_price: number | null;
120
120
  /**
121
- * Total transaction value
121
+ * Total transaction value (null when the filing states no price)
122
122
  * @type {number}
123
123
  * @memberof InsiderTradesList200ResponseTransactionsInner
124
124
  */
125
- total: number;
125
+ total: number | null;
126
126
  /**
127
127
  * Shares held after the transaction
128
128
  * @type {number}
@@ -33,6 +33,18 @@ export interface PresentationFact {
33
33
  * @memberof PresentationFact
34
34
  */
35
35
  value?: number | null;
36
+ /**
37
+ * Set with `value`: true when Invinite computed the value (Q4, TTM or YTD derivation), false = the company reported it
38
+ * @type {boolean}
39
+ * @memberof PresentationFact
40
+ */
41
+ derived?: boolean;
42
+ /**
43
+ * Set with `value`: the company's own caption of the line item (null when not extracted)
44
+ * @type {string}
45
+ * @memberof PresentationFact
46
+ */
47
+ company_label?: string | null;
36
48
  /**
37
49
  * Depth level in the tree structure (0 for root items)
38
50
  * @type {number}
@@ -34,6 +34,8 @@ export function PresentationFactFromJSONTyped(json, ignoreDiscriminator) {
34
34
  'concept': json['concept'],
35
35
  'label': json['label'],
36
36
  'value': json['value'] == null ? undefined : json['value'],
37
+ 'derived': json['derived'] == null ? undefined : json['derived'],
38
+ 'company_label': json['company_label'] == null ? undefined : json['company_label'],
37
39
  'depth': json['depth'],
38
40
  'isTotal': json['isTotal'] == null ? undefined : json['isTotal'],
39
41
  'children': json['children'] == null ? undefined : (json['children'].map(PresentationFactFromJSON)),
@@ -50,6 +52,8 @@ export function PresentationFactToJSONTyped(value, ignoreDiscriminator = false)
50
52
  'concept': value['concept'],
51
53
  'label': value['label'],
52
54
  'value': value['value'],
55
+ 'derived': value['derived'],
56
+ 'company_label': value['company_label'],
53
57
  'depth': value['depth'],
54
58
  'isTotal': value['isTotal'],
55
59
  'children': value['children'] == null ? undefined : (value['children'].map(PresentationFactToJSON)),
@@ -4,16 +4,21 @@ export * from './AccountUsage200ResponseByKeyInner';
4
4
  export * from './AccountUsage200ResponseDailyInner';
5
5
  export * from './AccountUsage200ResponseDailyInnerErrors';
6
6
  export * from './AccountUsage200ResponsePeriod';
7
+ export * from './AsReportedDetailedFact';
8
+ export * from './AsReportedFact';
7
9
  export * from './AsReportedIncomeStatement200Response';
8
10
  export * from './AsReportedIncomeStatement200ResponseCompaniesInner';
9
11
  export * from './AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner';
10
12
  export * from './AsReportedIncomeStatementDetailed200Response';
11
13
  export * from './AsReportedIncomeStatementDetailed200ResponseCompaniesInner';
12
14
  export * from './AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner';
13
- export * from './AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue';
14
15
  export * from './AsReportedIncomeStatementPresentation200Response';
15
16
  export * from './AsReportedIncomeStatementPresentation200ResponseCompaniesInner';
16
17
  export * from './AsReportedIncomeStatementPresentation200ResponseCompaniesInnerPeriodsInner';
18
+ export * from './AsReportedSnapshot200Response';
19
+ export * from './AsReportedSnapshot200ResponseCompaniesInner';
20
+ export * from './AsReportedSnapshot200ResponseCompaniesInnerStatements';
21
+ export * from './AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement';
17
22
  export * from './AsReportedSnapshotDetailed200Response';
18
23
  export * from './AsReportedSnapshotDetailed200ResponseCompaniesInner';
19
24
  export * from './AsReportedSnapshotDetailed200ResponseCompaniesInnerStatements';
@@ -6,16 +6,21 @@ export * from './AccountUsage200ResponseByKeyInner';
6
6
  export * from './AccountUsage200ResponseDailyInner';
7
7
  export * from './AccountUsage200ResponseDailyInnerErrors';
8
8
  export * from './AccountUsage200ResponsePeriod';
9
+ export * from './AsReportedDetailedFact';
10
+ export * from './AsReportedFact';
9
11
  export * from './AsReportedIncomeStatement200Response';
10
12
  export * from './AsReportedIncomeStatement200ResponseCompaniesInner';
11
13
  export * from './AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner';
12
14
  export * from './AsReportedIncomeStatementDetailed200Response';
13
15
  export * from './AsReportedIncomeStatementDetailed200ResponseCompaniesInner';
14
16
  export * from './AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner';
15
- export * from './AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue';
16
17
  export * from './AsReportedIncomeStatementPresentation200Response';
17
18
  export * from './AsReportedIncomeStatementPresentation200ResponseCompaniesInner';
18
19
  export * from './AsReportedIncomeStatementPresentation200ResponseCompaniesInnerPeriodsInner';
20
+ export * from './AsReportedSnapshot200Response';
21
+ export * from './AsReportedSnapshot200ResponseCompaniesInner';
22
+ export * from './AsReportedSnapshot200ResponseCompaniesInnerStatements';
23
+ export * from './AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement';
19
24
  export * from './AsReportedSnapshotDetailed200Response';
20
25
  export * from './AsReportedSnapshotDetailed200ResponseCompaniesInner';
21
26
  export * from './AsReportedSnapshotDetailed200ResponseCompaniesInnerStatements';
@@ -13,45 +13,63 @@ import type { StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriod
13
13
  /**
14
14
  *
15
15
  * @export
16
- * @interface AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue
16
+ * @interface AsReportedDetailedFact
17
17
  */
18
- export interface AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue {
18
+ export interface AsReportedDetailedFact {
19
19
  /**
20
- *
20
+ * Fact value (as filed unless `display_sign=cash_flow_direction`)
21
21
  * @type {number}
22
- * @memberof AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue
22
+ * @memberof AsReportedDetailedFact
23
23
  */
24
- value?: number;
24
+ value: number;
25
25
  /**
26
- *
26
+ * true when Invinite computed the value (a Q4, TTM or YTD derivation, see `formula`); false = the company reported it
27
+ * @type {boolean}
28
+ * @memberof AsReportedDetailedFact
29
+ */
30
+ derived: boolean;
31
+ /**
32
+ * The concept's taxonomy label
33
+ * @type {string}
34
+ * @memberof AsReportedDetailedFact
35
+ */
36
+ label: string | null;
37
+ /**
38
+ * The company's own caption of the line item in the filing (null when it was not extracted)
27
39
  * @type {string}
28
- * @memberof AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue
40
+ * @memberof AsReportedDetailedFact
41
+ */
42
+ company_label: string | null;
43
+ /**
44
+ * XBRL decimals of the reported fact (-6 = rounded to millions); null = exact (INF) or not stated. A derived fact carries its source fact's
45
+ * @type {number}
46
+ * @memberof AsReportedDetailedFact
29
47
  */
30
- html_label?: string | null;
48
+ decimals: number | null;
31
49
  /**
32
50
  *
33
51
  * @type {StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormula}
34
- * @memberof AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue
52
+ * @memberof AsReportedDetailedFact
35
53
  */
36
54
  formula?: StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormula | null;
37
55
  /**
38
- *
56
+ * Accession number of the filing that holds the value
39
57
  * @type {string}
40
- * @memberof AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue
58
+ * @memberof AsReportedDetailedFact
41
59
  */
42
- accession_number?: string | null;
60
+ accession_number: string | null;
43
61
  /**
44
- *
62
+ * Anchor of the fact in the filing's HTML (null on a derived fact)
45
63
  * @type {string}
46
- * @memberof AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue
64
+ * @memberof AsReportedDetailedFact
47
65
  */
48
- html_tag_id?: string | null;
66
+ html_tag_id: string | null;
49
67
  }
50
68
  /**
51
- * Check if a given object implements the AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue interface.
69
+ * Check if a given object implements the AsReportedDetailedFact interface.
52
70
  */
53
- export declare function instanceOfAsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue(value: object): value is AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue;
54
- export declare function AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFromJSON(json: any): AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue;
55
- export declare function AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFromJSONTyped(json: any, ignoreDiscriminator: boolean): AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue;
56
- export declare function AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueToJSON(json: any): AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue;
57
- export declare function AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueToJSONTyped(value?: AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue | null, ignoreDiscriminator?: boolean): any;
71
+ export declare function instanceOfAsReportedDetailedFact(value: object): value is AsReportedDetailedFact;
72
+ export declare function AsReportedDetailedFactFromJSON(json: any): AsReportedDetailedFact;
73
+ export declare function AsReportedDetailedFactFromJSONTyped(json: any, ignoreDiscriminator: boolean): AsReportedDetailedFact;
74
+ export declare function AsReportedDetailedFactToJSON(json: any): AsReportedDetailedFact;
75
+ export declare function AsReportedDetailedFactToJSONTyped(value?: AsReportedDetailedFact | null, ignoreDiscriminator?: boolean): any;
@@ -13,43 +13,63 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.instanceOfAsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue = instanceOfAsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue;
17
- exports.AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFromJSON = AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFromJSON;
18
- exports.AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFromJSONTyped = AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFromJSONTyped;
19
- exports.AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueToJSON = AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueToJSON;
20
- exports.AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueToJSONTyped = AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueToJSONTyped;
16
+ exports.instanceOfAsReportedDetailedFact = instanceOfAsReportedDetailedFact;
17
+ exports.AsReportedDetailedFactFromJSON = AsReportedDetailedFactFromJSON;
18
+ exports.AsReportedDetailedFactFromJSONTyped = AsReportedDetailedFactFromJSONTyped;
19
+ exports.AsReportedDetailedFactToJSON = AsReportedDetailedFactToJSON;
20
+ exports.AsReportedDetailedFactToJSONTyped = AsReportedDetailedFactToJSONTyped;
21
21
  const StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormula_1 = require("./StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormula");
22
22
  /**
23
- * Check if a given object implements the AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue interface.
23
+ * Check if a given object implements the AsReportedDetailedFact interface.
24
24
  */
25
- function instanceOfAsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue(value) {
25
+ function instanceOfAsReportedDetailedFact(value) {
26
+ if (!('value' in value) || value['value'] === undefined)
27
+ return false;
28
+ if (!('derived' in value) || value['derived'] === undefined)
29
+ return false;
30
+ if (!('label' in value) || value['label'] === undefined)
31
+ return false;
32
+ if (!('company_label' in value) || value['company_label'] === undefined)
33
+ return false;
34
+ if (!('decimals' in value) || value['decimals'] === undefined)
35
+ return false;
36
+ if (!('accession_number' in value) || value['accession_number'] === undefined)
37
+ return false;
38
+ if (!('html_tag_id' in value) || value['html_tag_id'] === undefined)
39
+ return false;
26
40
  return true;
27
41
  }
28
- function AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFromJSON(json) {
29
- return AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFromJSONTyped(json, false);
42
+ function AsReportedDetailedFactFromJSON(json) {
43
+ return AsReportedDetailedFactFromJSONTyped(json, false);
30
44
  }
31
- function AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFromJSONTyped(json, ignoreDiscriminator) {
45
+ function AsReportedDetailedFactFromJSONTyped(json, ignoreDiscriminator) {
32
46
  if (json == null) {
33
47
  return json;
34
48
  }
35
49
  return {
36
- 'value': json['value'] == null ? undefined : json['value'],
37
- 'html_label': json['html_label'] == null ? undefined : json['html_label'],
50
+ 'value': json['value'],
51
+ 'derived': json['derived'],
52
+ 'label': json['label'],
53
+ 'company_label': json['company_label'],
54
+ 'decimals': json['decimals'],
38
55
  'formula': json['formula'] == null ? undefined : (0, StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormula_1.StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormulaFromJSON)(json['formula']),
39
- 'accession_number': json['accession_number'] == null ? undefined : json['accession_number'],
40
- 'html_tag_id': json['html_tag_id'] == null ? undefined : json['html_tag_id'],
56
+ 'accession_number': json['accession_number'],
57
+ 'html_tag_id': json['html_tag_id'],
41
58
  };
42
59
  }
43
- function AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueToJSON(json) {
44
- return AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueToJSONTyped(json, false);
60
+ function AsReportedDetailedFactToJSON(json) {
61
+ return AsReportedDetailedFactToJSONTyped(json, false);
45
62
  }
46
- function AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueToJSONTyped(value, ignoreDiscriminator = false) {
63
+ function AsReportedDetailedFactToJSONTyped(value, ignoreDiscriminator = false) {
47
64
  if (value == null) {
48
65
  return value;
49
66
  }
50
67
  return {
51
68
  'value': value['value'],
52
- 'html_label': value['html_label'],
69
+ 'derived': value['derived'],
70
+ 'label': value['label'],
71
+ 'company_label': value['company_label'],
72
+ 'decimals': value['decimals'],
53
73
  'formula': (0, StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormula_1.StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormulaToJSON)(value['formula']),
54
74
  'accession_number': value['accession_number'],
55
75
  'html_tag_id': value['html_tag_id'],
@@ -0,0 +1,38 @@
1
+ /**
2
+ * Invinite API
3
+ * 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. **Coverage.** Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`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/company/available-companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the CIKs 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; `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`, `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 `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. 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/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, News, WebSocket, Account.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface AsReportedFact
16
+ */
17
+ export interface AsReportedFact {
18
+ /**
19
+ * Fact value (as filed unless `display_sign=cash_flow_direction`)
20
+ * @type {number}
21
+ * @memberof AsReportedFact
22
+ */
23
+ value: number;
24
+ /**
25
+ * true when Invinite computed the value (a Q4, TTM or YTD derivation; `formula` on the detailed route names its members); false = the company reported it
26
+ * @type {boolean}
27
+ * @memberof AsReportedFact
28
+ */
29
+ derived: boolean;
30
+ }
31
+ /**
32
+ * Check if a given object implements the AsReportedFact interface.
33
+ */
34
+ export declare function instanceOfAsReportedFact(value: object): value is AsReportedFact;
35
+ export declare function AsReportedFactFromJSON(json: any): AsReportedFact;
36
+ export declare function AsReportedFactFromJSONTyped(json: any, ignoreDiscriminator: boolean): AsReportedFact;
37
+ export declare function AsReportedFactToJSON(json: any): AsReportedFact;
38
+ export declare function AsReportedFactToJSONTyped(value?: AsReportedFact | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,54 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Invinite API
6
+ * 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. **Coverage.** Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`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/company/available-companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the CIKs 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; `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`, `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 `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. 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/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, News, WebSocket, Account.
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfAsReportedFact = instanceOfAsReportedFact;
17
+ exports.AsReportedFactFromJSON = AsReportedFactFromJSON;
18
+ exports.AsReportedFactFromJSONTyped = AsReportedFactFromJSONTyped;
19
+ exports.AsReportedFactToJSON = AsReportedFactToJSON;
20
+ exports.AsReportedFactToJSONTyped = AsReportedFactToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the AsReportedFact interface.
23
+ */
24
+ function instanceOfAsReportedFact(value) {
25
+ if (!('value' in value) || value['value'] === undefined)
26
+ return false;
27
+ if (!('derived' in value) || value['derived'] === undefined)
28
+ return false;
29
+ return true;
30
+ }
31
+ function AsReportedFactFromJSON(json) {
32
+ return AsReportedFactFromJSONTyped(json, false);
33
+ }
34
+ function AsReportedFactFromJSONTyped(json, ignoreDiscriminator) {
35
+ if (json == null) {
36
+ return json;
37
+ }
38
+ return {
39
+ 'value': json['value'],
40
+ 'derived': json['derived'],
41
+ };
42
+ }
43
+ function AsReportedFactToJSON(json) {
44
+ return AsReportedFactToJSONTyped(json, false);
45
+ }
46
+ function AsReportedFactToJSONTyped(value, ignoreDiscriminator = false) {
47
+ if (value == null) {
48
+ return value;
49
+ }
50
+ return {
51
+ 'value': value['value'],
52
+ 'derived': value['derived'],
53
+ };
54
+ }
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import type { AsReportedFact } from './AsReportedFact';
12
13
  /**
13
14
  *
14
15
  * @export
@@ -53,11 +54,11 @@ export interface AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner
53
54
  period_end: Date;
54
55
  /**
55
56
  * As-reported facts keyed by concept
56
- * @type {{ [key: string]: number; }}
57
+ * @type {{ [key: string]: AsReportedFact; }}
57
58
  * @memberof AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner
58
59
  */
59
60
  facts: {
60
- [key: string]: number;
61
+ [key: string]: AsReportedFact;
61
62
  };
62
63
  }
63
64
  /**
@@ -18,6 +18,8 @@ exports.AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInnerFromJSON =
18
18
  exports.AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInnerFromJSONTyped = AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInnerFromJSONTyped;
19
19
  exports.AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInnerToJSON = AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInnerToJSON;
20
20
  exports.AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInnerToJSONTyped = AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInnerToJSONTyped;
21
+ const runtime_1 = require("../runtime");
22
+ const AsReportedFact_1 = require("./AsReportedFact");
21
23
  /**
22
24
  * Check if a given object implements the AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner interface.
23
25
  */
@@ -52,7 +54,7 @@ function AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInnerFromJSONT
52
54
  'calendar_quarter': json['calendar_quarter'],
53
55
  'fiscal_period_type': json['fiscal_period_type'],
54
56
  'period_end': (new Date(json['period_end'])),
55
- 'facts': json['facts'],
57
+ 'facts': ((0, runtime_1.mapValues)(json['facts'], AsReportedFact_1.AsReportedFactFromJSON)),
56
58
  };
57
59
  }
58
60
  function AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInnerToJSON(json) {
@@ -69,6 +71,6 @@ function AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInnerToJSONTyp
69
71
  'calendar_quarter': value['calendar_quarter'],
70
72
  'fiscal_period_type': value['fiscal_period_type'],
71
73
  'period_end': value['period_end'].toISOString().substring(0, 10),
72
- 'facts': value['facts'],
74
+ 'facts': ((0, runtime_1.mapValues)(value['facts'], AsReportedFact_1.AsReportedFactToJSON)),
73
75
  };
74
76
  }
@@ -9,7 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import type { AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue } from './AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue';
12
+ import type { AsReportedDetailedFact } from './AsReportedDetailedFact';
13
13
  /**
14
14
  *
15
15
  * @export
@@ -54,11 +54,11 @@ export interface AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPerio
54
54
  period_end: Date;
55
55
  /**
56
56
  *
57
- * @type {{ [key: string]: AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue; }}
57
+ * @type {{ [key: string]: AsReportedDetailedFact; }}
58
58
  * @memberof AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner
59
59
  */
60
60
  facts: {
61
- [key: string]: AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue;
61
+ [key: string]: AsReportedDetailedFact;
62
62
  };
63
63
  }
64
64
  /**
@@ -19,7 +19,7 @@ exports.AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFr
19
19
  exports.AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerToJSON = AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerToJSON;
20
20
  exports.AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerToJSONTyped = AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerToJSONTyped;
21
21
  const runtime_1 = require("../runtime");
22
- const AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue_1 = require("./AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue");
22
+ const AsReportedDetailedFact_1 = require("./AsReportedDetailedFact");
23
23
  /**
24
24
  * Check if a given object implements the AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner interface.
25
25
  */
@@ -54,7 +54,7 @@ function AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerF
54
54
  'calendar_quarter': json['calendar_quarter'],
55
55
  'fiscal_period_type': json['fiscal_period_type'],
56
56
  'period_end': (new Date(json['period_end'])),
57
- 'facts': ((0, runtime_1.mapValues)(json['facts'], AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue_1.AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFromJSON)),
57
+ 'facts': ((0, runtime_1.mapValues)(json['facts'], AsReportedDetailedFact_1.AsReportedDetailedFactFromJSON)),
58
58
  };
59
59
  }
60
60
  function AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerToJSON(json) {
@@ -71,6 +71,6 @@ function AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerT
71
71
  'calendar_quarter': value['calendar_quarter'],
72
72
  'fiscal_period_type': value['fiscal_period_type'],
73
73
  'period_end': value['period_end'].toISOString().substring(0, 10),
74
- 'facts': ((0, runtime_1.mapValues)(value['facts'], AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue_1.AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueToJSON)),
74
+ 'facts': ((0, runtime_1.mapValues)(value['facts'], AsReportedDetailedFact_1.AsReportedDetailedFactToJSON)),
75
75
  };
76
76
  }