@invinite-org/data-api-client 0.3.0 → 0.5.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 (97) hide show
  1. package/.openapi-generator/FILES +12 -0
  2. package/dist/apis/EarningsCallsApi.d.ts +42 -6
  3. package/dist/apis/EarningsCallsApi.js +47 -7
  4. package/dist/esm/apis/EarningsCallsApi.d.ts +42 -6
  5. package/dist/esm/apis/EarningsCallsApi.js +46 -6
  6. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInner.d.ts +7 -0
  7. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInner.js +5 -0
  8. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerVideo.d.ts +82 -0
  9. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerVideo.js +78 -0
  10. package/dist/esm/models/EarningsCallsDocumentSearch200Response.d.ts +21 -0
  11. package/dist/esm/models/EarningsCallsDocumentSearch200Response.js +16 -0
  12. package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +21 -2
  13. package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.js +13 -0
  14. package/dist/esm/models/EarningsCallsEvents200ResponseEventsInner.d.ts +7 -0
  15. package/dist/esm/models/EarningsCallsEvents200ResponseEventsInner.js +5 -0
  16. package/dist/esm/models/EarningsCallsLive200ResponseEventsInner.d.ts +7 -0
  17. package/dist/esm/models/EarningsCallsLive200ResponseEventsInner.js +5 -0
  18. package/dist/esm/models/EarningsCallsSearch200Response.d.ts +21 -0
  19. package/dist/esm/models/EarningsCallsSearch200Response.js +16 -0
  20. package/dist/esm/models/EarningsCallsSearch200ResponseHitsInner.d.ts +21 -2
  21. package/dist/esm/models/EarningsCallsSearch200ResponseHitsInner.js +13 -0
  22. package/dist/esm/models/EarningsCallsSlides200Response.d.ts +7 -0
  23. package/dist/esm/models/EarningsCallsSlides200Response.js +5 -0
  24. package/dist/esm/models/EarningsCallsSlides200ResponseTimelineInner.d.ts +38 -0
  25. package/dist/esm/models/EarningsCallsSlides200ResponseTimelineInner.js +47 -0
  26. package/dist/esm/models/HitMatch.d.ts +53 -0
  27. package/dist/esm/models/HitMatch.js +59 -0
  28. package/dist/esm/models/MatchSpan.d.ts +38 -0
  29. package/dist/esm/models/MatchSpan.js +47 -0
  30. package/dist/esm/models/SearchCoverage.d.ts +63 -0
  31. package/dist/esm/models/SearchCoverage.js +68 -0
  32. package/dist/esm/models/SearchCoverageLeg.d.ts +59 -0
  33. package/dist/esm/models/SearchCoverageLeg.js +63 -0
  34. package/dist/esm/models/index.d.ts +6 -0
  35. package/dist/esm/models/index.js +6 -0
  36. package/dist/models/EarningsCallsCalendar200ResponseEventsInner.d.ts +7 -0
  37. package/dist/models/EarningsCallsCalendar200ResponseEventsInner.js +5 -0
  38. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerVideo.d.ts +82 -0
  39. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerVideo.js +86 -0
  40. package/dist/models/EarningsCallsDocumentSearch200Response.d.ts +21 -0
  41. package/dist/models/EarningsCallsDocumentSearch200Response.js +17 -0
  42. package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +21 -2
  43. package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.js +13 -0
  44. package/dist/models/EarningsCallsEvents200ResponseEventsInner.d.ts +7 -0
  45. package/dist/models/EarningsCallsEvents200ResponseEventsInner.js +5 -0
  46. package/dist/models/EarningsCallsLive200ResponseEventsInner.d.ts +7 -0
  47. package/dist/models/EarningsCallsLive200ResponseEventsInner.js +5 -0
  48. package/dist/models/EarningsCallsSearch200Response.d.ts +21 -0
  49. package/dist/models/EarningsCallsSearch200Response.js +17 -0
  50. package/dist/models/EarningsCallsSearch200ResponseHitsInner.d.ts +21 -2
  51. package/dist/models/EarningsCallsSearch200ResponseHitsInner.js +13 -0
  52. package/dist/models/EarningsCallsSlides200Response.d.ts +7 -0
  53. package/dist/models/EarningsCallsSlides200Response.js +5 -0
  54. package/dist/models/EarningsCallsSlides200ResponseTimelineInner.d.ts +38 -0
  55. package/dist/models/EarningsCallsSlides200ResponseTimelineInner.js +54 -0
  56. package/dist/models/HitMatch.d.ts +53 -0
  57. package/dist/models/HitMatch.js +67 -0
  58. package/dist/models/MatchSpan.d.ts +38 -0
  59. package/dist/models/MatchSpan.js +54 -0
  60. package/dist/models/SearchCoverage.d.ts +63 -0
  61. package/dist/models/SearchCoverage.js +76 -0
  62. package/dist/models/SearchCoverageLeg.d.ts +59 -0
  63. package/dist/models/SearchCoverageLeg.js +71 -0
  64. package/dist/models/index.d.ts +6 -0
  65. package/dist/models/index.js +6 -0
  66. package/docs/EarningsCallsApi.md +22 -12
  67. package/docs/EarningsCallsCalendar200ResponseEventsInner.md +2 -0
  68. package/docs/EarningsCallsCalendar200ResponseEventsInnerVideo.md +49 -0
  69. package/docs/EarningsCallsDocumentSearch200Response.md +4 -0
  70. package/docs/EarningsCallsDocumentSearch200ResponseHitsInner.md +6 -0
  71. package/docs/EarningsCallsEvents200ResponseEventsInner.md +2 -0
  72. package/docs/EarningsCallsLive200ResponseEventsInner.md +2 -0
  73. package/docs/EarningsCallsSearch200Response.md +4 -0
  74. package/docs/EarningsCallsSearch200ResponseHitsInner.md +6 -0
  75. package/docs/EarningsCallsSlides200Response.md +2 -0
  76. package/docs/EarningsCallsSlides200ResponseTimelineInner.md +36 -0
  77. package/docs/HitMatch.md +39 -0
  78. package/docs/MatchSpan.md +36 -0
  79. package/docs/SearchCoverage.md +39 -0
  80. package/docs/SearchCoverageLeg.md +41 -0
  81. package/package.json +1 -1
  82. package/src/apis/EarningsCallsApi.ts +58 -6
  83. package/src/models/EarningsCallsCalendar200ResponseEventsInner.ts +17 -0
  84. package/src/models/EarningsCallsCalendar200ResponseEventsInnerVideo.ts +140 -0
  85. package/src/models/EarningsCallsDocumentSearch200Response.ts +36 -0
  86. package/src/models/EarningsCallsDocumentSearch200ResponseHitsInner.ts +37 -2
  87. package/src/models/EarningsCallsEvents200ResponseEventsInner.ts +16 -0
  88. package/src/models/EarningsCallsLive200ResponseEventsInner.ts +17 -0
  89. package/src/models/EarningsCallsSearch200Response.ts +36 -0
  90. package/src/models/EarningsCallsSearch200ResponseHitsInner.ts +36 -2
  91. package/src/models/EarningsCallsSlides200Response.ts +16 -0
  92. package/src/models/EarningsCallsSlides200ResponseTimelineInner.ts +75 -0
  93. package/src/models/HitMatch.ts +103 -0
  94. package/src/models/MatchSpan.ts +75 -0
  95. package/src/models/SearchCoverage.ts +114 -0
  96. package/src/models/SearchCoverageLeg.ts +105 -0
  97. package/src/models/index.ts +6 -0
@@ -0,0 +1,53 @@
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. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `ping` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `ping` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/account/usage` serves no licensed data and carries none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, WebSocket, Account.
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
+ import type { MatchSpan } from './MatchSpan';
13
+ /**
14
+ * How the passage matched
15
+ * @export
16
+ * @interface HitMatch
17
+ */
18
+ export interface HitMatch {
19
+ /**
20
+ * The mode that found the passage
21
+ * @type {HitMatchTypeEnum}
22
+ * @memberof HitMatch
23
+ */
24
+ type: HitMatchTypeEnum;
25
+ /**
26
+ * 1-based rank of the passage in the answer
27
+ * @type {number}
28
+ * @memberof HitMatch
29
+ */
30
+ lexical_rank: number;
31
+ /**
32
+ * Matched characters in `text`; empty for an answer attached after its matched question (scoped lexical transcript search)
33
+ * @type {Array<MatchSpan>}
34
+ * @memberof HitMatch
35
+ */
36
+ spans: Array<MatchSpan>;
37
+ }
38
+ /**
39
+ * @export
40
+ */
41
+ export declare const HitMatchTypeEnum: {
42
+ readonly Lexical: "lexical";
43
+ readonly Literal: "literal";
44
+ };
45
+ export type HitMatchTypeEnum = typeof HitMatchTypeEnum[keyof typeof HitMatchTypeEnum];
46
+ /**
47
+ * Check if a given object implements the HitMatch interface.
48
+ */
49
+ export declare function instanceOfHitMatch(value: object): value is HitMatch;
50
+ export declare function HitMatchFromJSON(json: any): HitMatch;
51
+ export declare function HitMatchFromJSONTyped(json: any, ignoreDiscriminator: boolean): HitMatch;
52
+ export declare function HitMatchToJSON(json: any): HitMatch;
53
+ export declare function HitMatchToJSONTyped(value?: HitMatch | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,67 @@
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. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `ping` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `ping` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/account/usage` serves no licensed data and carries none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, WebSocket, Account.
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.HitMatchTypeEnum = void 0;
17
+ exports.instanceOfHitMatch = instanceOfHitMatch;
18
+ exports.HitMatchFromJSON = HitMatchFromJSON;
19
+ exports.HitMatchFromJSONTyped = HitMatchFromJSONTyped;
20
+ exports.HitMatchToJSON = HitMatchToJSON;
21
+ exports.HitMatchToJSONTyped = HitMatchToJSONTyped;
22
+ const MatchSpan_1 = require("./MatchSpan");
23
+ /**
24
+ * @export
25
+ */
26
+ exports.HitMatchTypeEnum = {
27
+ Lexical: 'lexical',
28
+ Literal: 'literal'
29
+ };
30
+ /**
31
+ * Check if a given object implements the HitMatch interface.
32
+ */
33
+ function instanceOfHitMatch(value) {
34
+ if (!('type' in value) || value['type'] === undefined)
35
+ return false;
36
+ if (!('lexical_rank' in value) || value['lexical_rank'] === undefined)
37
+ return false;
38
+ if (!('spans' in value) || value['spans'] === undefined)
39
+ return false;
40
+ return true;
41
+ }
42
+ function HitMatchFromJSON(json) {
43
+ return HitMatchFromJSONTyped(json, false);
44
+ }
45
+ function HitMatchFromJSONTyped(json, ignoreDiscriminator) {
46
+ if (json == null) {
47
+ return json;
48
+ }
49
+ return {
50
+ 'type': json['type'],
51
+ 'lexical_rank': json['lexical_rank'],
52
+ 'spans': (json['spans'].map(MatchSpan_1.MatchSpanFromJSON)),
53
+ };
54
+ }
55
+ function HitMatchToJSON(json) {
56
+ return HitMatchToJSONTyped(json, false);
57
+ }
58
+ function HitMatchToJSONTyped(value, ignoreDiscriminator = false) {
59
+ if (value == null) {
60
+ return value;
61
+ }
62
+ return {
63
+ 'type': value['type'],
64
+ 'lexical_rank': value['lexical_rank'],
65
+ 'spans': (value['spans'].map(MatchSpan_1.MatchSpanToJSON)),
66
+ };
67
+ }
@@ -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. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `ping` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `ping` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/account/usage` serves no licensed data and carries none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, WebSocket, Account.
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 MatchSpan
16
+ */
17
+ export interface MatchSpan {
18
+ /**
19
+ * Zero-based Unicode code-point offset into `text`
20
+ * @type {number}
21
+ * @memberof MatchSpan
22
+ */
23
+ start: number;
24
+ /**
25
+ * End offset, exclusive
26
+ * @type {number}
27
+ * @memberof MatchSpan
28
+ */
29
+ end: number;
30
+ }
31
+ /**
32
+ * Check if a given object implements the MatchSpan interface.
33
+ */
34
+ export declare function instanceOfMatchSpan(value: object): value is MatchSpan;
35
+ export declare function MatchSpanFromJSON(json: any): MatchSpan;
36
+ export declare function MatchSpanFromJSONTyped(json: any, ignoreDiscriminator: boolean): MatchSpan;
37
+ export declare function MatchSpanToJSON(json: any): MatchSpan;
38
+ export declare function MatchSpanToJSONTyped(value?: MatchSpan | 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. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `ping` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `ping` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/account/usage` serves no licensed data and carries none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, WebSocket, Account.
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.instanceOfMatchSpan = instanceOfMatchSpan;
17
+ exports.MatchSpanFromJSON = MatchSpanFromJSON;
18
+ exports.MatchSpanFromJSONTyped = MatchSpanFromJSONTyped;
19
+ exports.MatchSpanToJSON = MatchSpanToJSON;
20
+ exports.MatchSpanToJSONTyped = MatchSpanToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the MatchSpan interface.
23
+ */
24
+ function instanceOfMatchSpan(value) {
25
+ if (!('start' in value) || value['start'] === undefined)
26
+ return false;
27
+ if (!('end' in value) || value['end'] === undefined)
28
+ return false;
29
+ return true;
30
+ }
31
+ function MatchSpanFromJSON(json) {
32
+ return MatchSpanFromJSONTyped(json, false);
33
+ }
34
+ function MatchSpanFromJSONTyped(json, ignoreDiscriminator) {
35
+ if (json == null) {
36
+ return json;
37
+ }
38
+ return {
39
+ 'start': json['start'],
40
+ 'end': json['end'],
41
+ };
42
+ }
43
+ function MatchSpanToJSON(json) {
44
+ return MatchSpanToJSONTyped(json, false);
45
+ }
46
+ function MatchSpanToJSONTyped(value, ignoreDiscriminator = false) {
47
+ if (value == null) {
48
+ return value;
49
+ }
50
+ return {
51
+ 'start': value['start'],
52
+ 'end': value['end'],
53
+ };
54
+ }
@@ -0,0 +1,63 @@
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. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `ping` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `ping` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/account/usage` serves no licensed data and carries none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, WebSocket, Account.
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
+ import type { SearchCoverageLeg } from './SearchCoverageLeg';
13
+ /**
14
+ * How much of the searched scope the text index covers
15
+ * @export
16
+ * @interface SearchCoverage
17
+ */
18
+ export interface SearchCoverage {
19
+ /**
20
+ * complete = no hits is a genuine no-result; partial / unknown = the answer may be incomplete
21
+ * @type {SearchCoverageCompletenessEnum}
22
+ * @memberof SearchCoverage
23
+ */
24
+ completeness: SearchCoverageCompletenessEnum;
25
+ /**
26
+ *
27
+ * @type {SearchCoverageLeg}
28
+ * @memberof SearchCoverage
29
+ */
30
+ lexical: SearchCoverageLeg | null;
31
+ /**
32
+ * Why the answer may be incomplete
33
+ * @type {Array<SearchCoverageReasonsEnum>}
34
+ * @memberof SearchCoverage
35
+ */
36
+ reasons: Array<SearchCoverageReasonsEnum>;
37
+ }
38
+ /**
39
+ * @export
40
+ */
41
+ export declare const SearchCoverageCompletenessEnum: {
42
+ readonly Complete: "complete";
43
+ readonly Partial: "partial";
44
+ readonly Unknown: "unknown";
45
+ };
46
+ export type SearchCoverageCompletenessEnum = typeof SearchCoverageCompletenessEnum[keyof typeof SearchCoverageCompletenessEnum];
47
+ /**
48
+ * @export
49
+ */
50
+ export declare const SearchCoverageReasonsEnum: {
51
+ readonly LexicalBackfillPending: "lexical_backfill_pending";
52
+ readonly ProjectionFailed: "projection_failed";
53
+ readonly CoverageUnavailable: "coverage_unavailable";
54
+ };
55
+ export type SearchCoverageReasonsEnum = typeof SearchCoverageReasonsEnum[keyof typeof SearchCoverageReasonsEnum];
56
+ /**
57
+ * Check if a given object implements the SearchCoverage interface.
58
+ */
59
+ export declare function instanceOfSearchCoverage(value: object): value is SearchCoverage;
60
+ export declare function SearchCoverageFromJSON(json: any): SearchCoverage;
61
+ export declare function SearchCoverageFromJSONTyped(json: any, ignoreDiscriminator: boolean): SearchCoverage;
62
+ export declare function SearchCoverageToJSON(json: any): SearchCoverage;
63
+ export declare function SearchCoverageToJSONTyped(value?: SearchCoverage | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,76 @@
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. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `ping` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `ping` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/account/usage` serves no licensed data and carries none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, WebSocket, Account.
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.SearchCoverageReasonsEnum = exports.SearchCoverageCompletenessEnum = void 0;
17
+ exports.instanceOfSearchCoverage = instanceOfSearchCoverage;
18
+ exports.SearchCoverageFromJSON = SearchCoverageFromJSON;
19
+ exports.SearchCoverageFromJSONTyped = SearchCoverageFromJSONTyped;
20
+ exports.SearchCoverageToJSON = SearchCoverageToJSON;
21
+ exports.SearchCoverageToJSONTyped = SearchCoverageToJSONTyped;
22
+ const SearchCoverageLeg_1 = require("./SearchCoverageLeg");
23
+ /**
24
+ * @export
25
+ */
26
+ exports.SearchCoverageCompletenessEnum = {
27
+ Complete: 'complete',
28
+ Partial: 'partial',
29
+ Unknown: 'unknown'
30
+ };
31
+ /**
32
+ * @export
33
+ */
34
+ exports.SearchCoverageReasonsEnum = {
35
+ LexicalBackfillPending: 'lexical_backfill_pending',
36
+ ProjectionFailed: 'projection_failed',
37
+ CoverageUnavailable: 'coverage_unavailable'
38
+ };
39
+ /**
40
+ * Check if a given object implements the SearchCoverage interface.
41
+ */
42
+ function instanceOfSearchCoverage(value) {
43
+ if (!('completeness' in value) || value['completeness'] === undefined)
44
+ return false;
45
+ if (!('lexical' in value) || value['lexical'] === undefined)
46
+ return false;
47
+ if (!('reasons' in value) || value['reasons'] === undefined)
48
+ return false;
49
+ return true;
50
+ }
51
+ function SearchCoverageFromJSON(json) {
52
+ return SearchCoverageFromJSONTyped(json, false);
53
+ }
54
+ function SearchCoverageFromJSONTyped(json, ignoreDiscriminator) {
55
+ if (json == null) {
56
+ return json;
57
+ }
58
+ return {
59
+ 'completeness': json['completeness'],
60
+ 'lexical': (0, SearchCoverageLeg_1.SearchCoverageLegFromJSON)(json['lexical']),
61
+ 'reasons': json['reasons'],
62
+ };
63
+ }
64
+ function SearchCoverageToJSON(json) {
65
+ return SearchCoverageToJSONTyped(json, false);
66
+ }
67
+ function SearchCoverageToJSONTyped(value, ignoreDiscriminator = false) {
68
+ if (value == null) {
69
+ return value;
70
+ }
71
+ return {
72
+ 'completeness': value['completeness'],
73
+ 'lexical': (0, SearchCoverageLeg_1.SearchCoverageLegToJSON)(value['lexical']),
74
+ 'reasons': value['reasons'],
75
+ };
76
+ }
@@ -0,0 +1,59 @@
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. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `ping` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `ping` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/account/usage` serves no licensed data and carries none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, WebSocket, Account.
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
+ * The text index (lexical and literal); null when the counts could not be read
14
+ * @export
15
+ * @interface SearchCoverageLeg
16
+ */
17
+ export interface SearchCoverageLeg {
18
+ /**
19
+ * ready = nothing outstanding; partial = some owners outstanding; not_ready = nothing indexed
20
+ * @type {SearchCoverageLegStateEnum}
21
+ * @memberof SearchCoverageLeg
22
+ */
23
+ state: SearchCoverageLegStateEnum;
24
+ /**
25
+ * Transcripts / documents of the scope searchable in this index
26
+ * @type {number}
27
+ * @memberof SearchCoverageLeg
28
+ */
29
+ indexed: number;
30
+ /**
31
+ * Not indexed yet (or not provably)
32
+ * @type {number}
33
+ * @memberof SearchCoverageLeg
34
+ */
35
+ pending: number;
36
+ /**
37
+ * Indexing failed
38
+ * @type {number}
39
+ * @memberof SearchCoverageLeg
40
+ */
41
+ failed: number;
42
+ }
43
+ /**
44
+ * @export
45
+ */
46
+ export declare const SearchCoverageLegStateEnum: {
47
+ readonly Ready: "ready";
48
+ readonly Partial: "partial";
49
+ readonly NotReady: "not_ready";
50
+ };
51
+ export type SearchCoverageLegStateEnum = typeof SearchCoverageLegStateEnum[keyof typeof SearchCoverageLegStateEnum];
52
+ /**
53
+ * Check if a given object implements the SearchCoverageLeg interface.
54
+ */
55
+ export declare function instanceOfSearchCoverageLeg(value: object): value is SearchCoverageLeg;
56
+ export declare function SearchCoverageLegFromJSON(json: any): SearchCoverageLeg;
57
+ export declare function SearchCoverageLegFromJSONTyped(json: any, ignoreDiscriminator: boolean): SearchCoverageLeg;
58
+ export declare function SearchCoverageLegToJSON(json: any): SearchCoverageLeg;
59
+ export declare function SearchCoverageLegToJSONTyped(value?: SearchCoverageLeg | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,71 @@
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. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `ping` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `ping` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/account/usage` serves no licensed data and carries none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, WebSocket, Account.
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.SearchCoverageLegStateEnum = void 0;
17
+ exports.instanceOfSearchCoverageLeg = instanceOfSearchCoverageLeg;
18
+ exports.SearchCoverageLegFromJSON = SearchCoverageLegFromJSON;
19
+ exports.SearchCoverageLegFromJSONTyped = SearchCoverageLegFromJSONTyped;
20
+ exports.SearchCoverageLegToJSON = SearchCoverageLegToJSON;
21
+ exports.SearchCoverageLegToJSONTyped = SearchCoverageLegToJSONTyped;
22
+ /**
23
+ * @export
24
+ */
25
+ exports.SearchCoverageLegStateEnum = {
26
+ Ready: 'ready',
27
+ Partial: 'partial',
28
+ NotReady: 'not_ready'
29
+ };
30
+ /**
31
+ * Check if a given object implements the SearchCoverageLeg interface.
32
+ */
33
+ function instanceOfSearchCoverageLeg(value) {
34
+ if (!('state' in value) || value['state'] === undefined)
35
+ return false;
36
+ if (!('indexed' in value) || value['indexed'] === undefined)
37
+ return false;
38
+ if (!('pending' in value) || value['pending'] === undefined)
39
+ return false;
40
+ if (!('failed' in value) || value['failed'] === undefined)
41
+ return false;
42
+ return true;
43
+ }
44
+ function SearchCoverageLegFromJSON(json) {
45
+ return SearchCoverageLegFromJSONTyped(json, false);
46
+ }
47
+ function SearchCoverageLegFromJSONTyped(json, ignoreDiscriminator) {
48
+ if (json == null) {
49
+ return json;
50
+ }
51
+ return {
52
+ 'state': json['state'],
53
+ 'indexed': json['indexed'],
54
+ 'pending': json['pending'],
55
+ 'failed': json['failed'],
56
+ };
57
+ }
58
+ function SearchCoverageLegToJSON(json) {
59
+ return SearchCoverageLegToJSONTyped(json, false);
60
+ }
61
+ function SearchCoverageLegToJSONTyped(value, ignoreDiscriminator = false) {
62
+ if (value == null) {
63
+ return value;
64
+ }
65
+ return {
66
+ 'state': value['state'],
67
+ 'indexed': value['indexed'],
68
+ 'pending': value['pending'],
69
+ 'failed': value['failed'],
70
+ };
71
+ }
@@ -44,6 +44,7 @@ export * from './EarningsCallsAnalysts200ResponseAnalystsInner';
44
44
  export * from './EarningsCallsAudio200Response';
45
45
  export * from './EarningsCallsCalendar200Response';
46
46
  export * from './EarningsCallsCalendar200ResponseEventsInner';
47
+ export * from './EarningsCallsCalendar200ResponseEventsInnerVideo';
47
48
  export * from './EarningsCallsCompanyDocument200Response';
48
49
  export * from './EarningsCallsCompanyDocuments200Response';
49
50
  export * from './EarningsCallsCompanyDocuments200ResponseCompany';
@@ -102,6 +103,7 @@ export * from './EarningsCallsSearch200ResponseHitsInnerSlide';
102
103
  export * from './EarningsCallsSlides200Response';
103
104
  export * from './EarningsCallsSlides200ResponseDeck';
104
105
  export * from './EarningsCallsSlides200ResponseSlidesInner';
106
+ export * from './EarningsCallsSlides200ResponseTimelineInner';
105
107
  export * from './EarningsCallsTranscript200Response';
106
108
  export * from './EarningsCallsTranscript404Response';
107
109
  export * from './EarningsCallsTranscriptDiff200Response';
@@ -125,6 +127,7 @@ export * from './FinancialMetricsRatios200ResponseCompaniesInner';
125
127
  export * from './FinancialMetricsRatios200ResponseCompaniesInnerPeriodsInner';
126
128
  export * from './ForbiddenError';
127
129
  export * from './HealthGet200Response';
130
+ export * from './HitMatch';
128
131
  export * from './InsiderTradesList200Response';
129
132
  export * from './InsiderTradesList200ResponseTransactionsInner';
130
133
  export * from './InstitutionalOwnershipHoldingsByCompany200Response';
@@ -139,6 +142,7 @@ export * from './IposList200Response';
139
142
  export * from './IposList200ResponseIposInner';
140
143
  export * from './MarketHolidays200Response';
141
144
  export * from './MarketHolidays200ResponseHolidaysInner';
145
+ export * from './MatchSpan';
142
146
  export * from './MetadataAvailableMetrics200Response';
143
147
  export * from './MetadataAvailableMetrics200ResponseMetricsInner';
144
148
  export * from './MetadataAvailableSectionIds200Response';
@@ -146,6 +150,8 @@ export * from './MetadataAvailableSectionIds200ResponseFormTypesInner';
146
150
  export * from './MetadataAvailableSectionIds200ResponseFormTypesInnerSectionsInner';
147
151
  export * from './NotFoundError';
148
152
  export * from './PresentationFact';
153
+ export * from './SearchCoverage';
154
+ export * from './SearchCoverageLeg';
149
155
  export * from './SecFilingsAvailableFormTypes200Response';
150
156
  export * from './SecFilingsList200Response';
151
157
  export * from './SecFilingsList200ResponseCompaniesInner';
@@ -62,6 +62,7 @@ __exportStar(require("./EarningsCallsAnalysts200ResponseAnalystsInner"), exports
62
62
  __exportStar(require("./EarningsCallsAudio200Response"), exports);
63
63
  __exportStar(require("./EarningsCallsCalendar200Response"), exports);
64
64
  __exportStar(require("./EarningsCallsCalendar200ResponseEventsInner"), exports);
65
+ __exportStar(require("./EarningsCallsCalendar200ResponseEventsInnerVideo"), exports);
65
66
  __exportStar(require("./EarningsCallsCompanyDocument200Response"), exports);
66
67
  __exportStar(require("./EarningsCallsCompanyDocuments200Response"), exports);
67
68
  __exportStar(require("./EarningsCallsCompanyDocuments200ResponseCompany"), exports);
@@ -120,6 +121,7 @@ __exportStar(require("./EarningsCallsSearch200ResponseHitsInnerSlide"), exports)
120
121
  __exportStar(require("./EarningsCallsSlides200Response"), exports);
121
122
  __exportStar(require("./EarningsCallsSlides200ResponseDeck"), exports);
122
123
  __exportStar(require("./EarningsCallsSlides200ResponseSlidesInner"), exports);
124
+ __exportStar(require("./EarningsCallsSlides200ResponseTimelineInner"), exports);
123
125
  __exportStar(require("./EarningsCallsTranscript200Response"), exports);
124
126
  __exportStar(require("./EarningsCallsTranscript404Response"), exports);
125
127
  __exportStar(require("./EarningsCallsTranscriptDiff200Response"), exports);
@@ -143,6 +145,7 @@ __exportStar(require("./FinancialMetricsRatios200ResponseCompaniesInner"), expor
143
145
  __exportStar(require("./FinancialMetricsRatios200ResponseCompaniesInnerPeriodsInner"), exports);
144
146
  __exportStar(require("./ForbiddenError"), exports);
145
147
  __exportStar(require("./HealthGet200Response"), exports);
148
+ __exportStar(require("./HitMatch"), exports);
146
149
  __exportStar(require("./InsiderTradesList200Response"), exports);
147
150
  __exportStar(require("./InsiderTradesList200ResponseTransactionsInner"), exports);
148
151
  __exportStar(require("./InstitutionalOwnershipHoldingsByCompany200Response"), exports);
@@ -157,6 +160,7 @@ __exportStar(require("./IposList200Response"), exports);
157
160
  __exportStar(require("./IposList200ResponseIposInner"), exports);
158
161
  __exportStar(require("./MarketHolidays200Response"), exports);
159
162
  __exportStar(require("./MarketHolidays200ResponseHolidaysInner"), exports);
163
+ __exportStar(require("./MatchSpan"), exports);
160
164
  __exportStar(require("./MetadataAvailableMetrics200Response"), exports);
161
165
  __exportStar(require("./MetadataAvailableMetrics200ResponseMetricsInner"), exports);
162
166
  __exportStar(require("./MetadataAvailableSectionIds200Response"), exports);
@@ -164,6 +168,8 @@ __exportStar(require("./MetadataAvailableSectionIds200ResponseFormTypesInner"),
164
168
  __exportStar(require("./MetadataAvailableSectionIds200ResponseFormTypesInnerSectionsInner"), exports);
165
169
  __exportStar(require("./NotFoundError"), exports);
166
170
  __exportStar(require("./PresentationFact"), exports);
171
+ __exportStar(require("./SearchCoverage"), exports);
172
+ __exportStar(require("./SearchCoverageLeg"), exports);
167
173
  __exportStar(require("./SecFilingsAvailableFormTypes200Response"), exports);
168
174
  __exportStar(require("./SecFilingsList200Response"), exports);
169
175
  __exportStar(require("./SecFilingsList200ResponseCompaniesInner"), exports);