@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,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,68 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Invinite API
5
+ * Invinite financial data API. Each endpoint has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Included-Remaining` what is left of the plan\'s included credits. `GET /v1/account/usage` returns your account\'s usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `ping` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `ping` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/account/usage` serves no licensed data and carries none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, WebSocket, Account.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ import { SearchCoverageLegFromJSON, SearchCoverageLegToJSON, } from './SearchCoverageLeg';
15
+ /**
16
+ * @export
17
+ */
18
+ export const SearchCoverageCompletenessEnum = {
19
+ Complete: 'complete',
20
+ Partial: 'partial',
21
+ Unknown: 'unknown'
22
+ };
23
+ /**
24
+ * @export
25
+ */
26
+ export const SearchCoverageReasonsEnum = {
27
+ LexicalBackfillPending: 'lexical_backfill_pending',
28
+ ProjectionFailed: 'projection_failed',
29
+ CoverageUnavailable: 'coverage_unavailable'
30
+ };
31
+ /**
32
+ * Check if a given object implements the SearchCoverage interface.
33
+ */
34
+ export function instanceOfSearchCoverage(value) {
35
+ if (!('completeness' in value) || value['completeness'] === undefined)
36
+ return false;
37
+ if (!('lexical' in value) || value['lexical'] === undefined)
38
+ return false;
39
+ if (!('reasons' in value) || value['reasons'] === undefined)
40
+ return false;
41
+ return true;
42
+ }
43
+ export function SearchCoverageFromJSON(json) {
44
+ return SearchCoverageFromJSONTyped(json, false);
45
+ }
46
+ export function SearchCoverageFromJSONTyped(json, ignoreDiscriminator) {
47
+ if (json == null) {
48
+ return json;
49
+ }
50
+ return {
51
+ 'completeness': json['completeness'],
52
+ 'lexical': SearchCoverageLegFromJSON(json['lexical']),
53
+ 'reasons': json['reasons'],
54
+ };
55
+ }
56
+ export function SearchCoverageToJSON(json) {
57
+ return SearchCoverageToJSONTyped(json, false);
58
+ }
59
+ export function SearchCoverageToJSONTyped(value, ignoreDiscriminator = false) {
60
+ if (value == null) {
61
+ return value;
62
+ }
63
+ return {
64
+ 'completeness': value['completeness'],
65
+ 'lexical': SearchCoverageLegToJSON(value['lexical']),
66
+ 'reasons': value['reasons'],
67
+ };
68
+ }
@@ -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,63 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Invinite API
5
+ * Invinite financial data API. Each endpoint has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Included-Remaining` what is left of the plan\'s included credits. `GET /v1/account/usage` returns your account\'s usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `ping` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `ping` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/account/usage` serves no licensed data and carries none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, WebSocket, Account.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ /**
15
+ * @export
16
+ */
17
+ export const SearchCoverageLegStateEnum = {
18
+ Ready: 'ready',
19
+ Partial: 'partial',
20
+ NotReady: 'not_ready'
21
+ };
22
+ /**
23
+ * Check if a given object implements the SearchCoverageLeg interface.
24
+ */
25
+ export function instanceOfSearchCoverageLeg(value) {
26
+ if (!('state' in value) || value['state'] === undefined)
27
+ return false;
28
+ if (!('indexed' in value) || value['indexed'] === undefined)
29
+ return false;
30
+ if (!('pending' in value) || value['pending'] === undefined)
31
+ return false;
32
+ if (!('failed' in value) || value['failed'] === undefined)
33
+ return false;
34
+ return true;
35
+ }
36
+ export function SearchCoverageLegFromJSON(json) {
37
+ return SearchCoverageLegFromJSONTyped(json, false);
38
+ }
39
+ export function SearchCoverageLegFromJSONTyped(json, ignoreDiscriminator) {
40
+ if (json == null) {
41
+ return json;
42
+ }
43
+ return {
44
+ 'state': json['state'],
45
+ 'indexed': json['indexed'],
46
+ 'pending': json['pending'],
47
+ 'failed': json['failed'],
48
+ };
49
+ }
50
+ export function SearchCoverageLegToJSON(json) {
51
+ return SearchCoverageLegToJSONTyped(json, false);
52
+ }
53
+ export function SearchCoverageLegToJSONTyped(value, ignoreDiscriminator = false) {
54
+ if (value == null) {
55
+ return value;
56
+ }
57
+ return {
58
+ 'state': value['state'],
59
+ 'indexed': value['indexed'],
60
+ 'pending': value['pending'],
61
+ 'failed': value['failed'],
62
+ };
63
+ }
@@ -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';
@@ -46,6 +46,7 @@ export * from './EarningsCallsAnalysts200ResponseAnalystsInner';
46
46
  export * from './EarningsCallsAudio200Response';
47
47
  export * from './EarningsCallsCalendar200Response';
48
48
  export * from './EarningsCallsCalendar200ResponseEventsInner';
49
+ export * from './EarningsCallsCalendar200ResponseEventsInnerVideo';
49
50
  export * from './EarningsCallsCompanyDocument200Response';
50
51
  export * from './EarningsCallsCompanyDocuments200Response';
51
52
  export * from './EarningsCallsCompanyDocuments200ResponseCompany';
@@ -104,6 +105,7 @@ export * from './EarningsCallsSearch200ResponseHitsInnerSlide';
104
105
  export * from './EarningsCallsSlides200Response';
105
106
  export * from './EarningsCallsSlides200ResponseDeck';
106
107
  export * from './EarningsCallsSlides200ResponseSlidesInner';
108
+ export * from './EarningsCallsSlides200ResponseTimelineInner';
107
109
  export * from './EarningsCallsTranscript200Response';
108
110
  export * from './EarningsCallsTranscript404Response';
109
111
  export * from './EarningsCallsTranscriptDiff200Response';
@@ -127,6 +129,7 @@ export * from './FinancialMetricsRatios200ResponseCompaniesInner';
127
129
  export * from './FinancialMetricsRatios200ResponseCompaniesInnerPeriodsInner';
128
130
  export * from './ForbiddenError';
129
131
  export * from './HealthGet200Response';
132
+ export * from './HitMatch';
130
133
  export * from './InsiderTradesList200Response';
131
134
  export * from './InsiderTradesList200ResponseTransactionsInner';
132
135
  export * from './InstitutionalOwnershipHoldingsByCompany200Response';
@@ -141,6 +144,7 @@ export * from './IposList200Response';
141
144
  export * from './IposList200ResponseIposInner';
142
145
  export * from './MarketHolidays200Response';
143
146
  export * from './MarketHolidays200ResponseHolidaysInner';
147
+ export * from './MatchSpan';
144
148
  export * from './MetadataAvailableMetrics200Response';
145
149
  export * from './MetadataAvailableMetrics200ResponseMetricsInner';
146
150
  export * from './MetadataAvailableSectionIds200Response';
@@ -148,6 +152,8 @@ export * from './MetadataAvailableSectionIds200ResponseFormTypesInner';
148
152
  export * from './MetadataAvailableSectionIds200ResponseFormTypesInnerSectionsInner';
149
153
  export * from './NotFoundError';
150
154
  export * from './PresentationFact';
155
+ export * from './SearchCoverage';
156
+ export * from './SearchCoverageLeg';
151
157
  export * from './SecFilingsAvailableFormTypes200Response';
152
158
  export * from './SecFilingsList200Response';
153
159
  export * from './SecFilingsList200ResponseCompaniesInner';
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import type { EarningsCallsCalendar200ResponseEventsInnerVideo } from './EarningsCallsCalendar200ResponseEventsInnerVideo';
12
13
  /**
13
14
  *
14
15
  * @export
@@ -177,6 +178,12 @@ export interface EarningsCallsCalendar200ResponseEventsInner {
177
178
  * @memberof EarningsCallsCalendar200ResponseEventsInner
178
179
  */
179
180
  webcast_url: string | null;
181
+ /**
182
+ *
183
+ * @type {EarningsCallsCalendar200ResponseEventsInnerVideo}
184
+ * @memberof EarningsCallsCalendar200ResponseEventsInner
185
+ */
186
+ video: EarningsCallsCalendar200ResponseEventsInnerVideo | null;
180
187
  }
181
188
  /**
182
189
  * @export
@@ -19,6 +19,7 @@ exports.EarningsCallsCalendar200ResponseEventsInnerFromJSON = EarningsCallsCalen
19
19
  exports.EarningsCallsCalendar200ResponseEventsInnerFromJSONTyped = EarningsCallsCalendar200ResponseEventsInnerFromJSONTyped;
20
20
  exports.EarningsCallsCalendar200ResponseEventsInnerToJSON = EarningsCallsCalendar200ResponseEventsInnerToJSON;
21
21
  exports.EarningsCallsCalendar200ResponseEventsInnerToJSONTyped = EarningsCallsCalendar200ResponseEventsInnerToJSONTyped;
22
+ const EarningsCallsCalendar200ResponseEventsInnerVideo_1 = require("./EarningsCallsCalendar200ResponseEventsInnerVideo");
22
23
  /**
23
24
  * @export
24
25
  */
@@ -113,6 +114,8 @@ function instanceOfEarningsCallsCalendar200ResponseEventsInner(value) {
113
114
  return false;
114
115
  if (!('webcast_url' in value) || value['webcast_url'] === undefined)
115
116
  return false;
117
+ if (!('video' in value) || value['video'] === undefined)
118
+ return false;
116
119
  return true;
117
120
  }
118
121
  function EarningsCallsCalendar200ResponseEventsInnerFromJSON(json) {
@@ -150,6 +153,7 @@ function EarningsCallsCalendar200ResponseEventsInnerFromJSONTyped(json, ignoreDi
150
153
  'has_press_release': json['has_press_release'],
151
154
  'has_documents': json['has_documents'],
152
155
  'webcast_url': json['webcast_url'],
156
+ 'video': (0, EarningsCallsCalendar200ResponseEventsInnerVideo_1.EarningsCallsCalendar200ResponseEventsInnerVideoFromJSON)(json['video']),
153
157
  };
154
158
  }
155
159
  function EarningsCallsCalendar200ResponseEventsInnerToJSON(json) {
@@ -187,5 +191,6 @@ function EarningsCallsCalendar200ResponseEventsInnerToJSONTyped(value, ignoreDis
187
191
  'has_press_release': value['has_press_release'],
188
192
  'has_documents': value['has_documents'],
189
193
  'webcast_url': value['webcast_url'],
194
+ 'video': (0, EarningsCallsCalendar200ResponseEventsInnerVideo_1.EarningsCallsCalendar200ResponseEventsInnerVideoToJSON)(value['video']),
190
195
  };
191
196
  }
@@ -0,0 +1,82 @@
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 company's public broadcast on a video platform (YouTube, Vimeo). Embed `embed_url` when `embeddable` is not false; otherwise link `url`. Present before, during and after the event; null = none known.
14
+ * @export
15
+ * @interface EarningsCallsCalendar200ResponseEventsInnerVideo
16
+ */
17
+ export interface EarningsCallsCalendar200ResponseEventsInnerVideo {
18
+ /**
19
+ * Video platform
20
+ * @type {EarningsCallsCalendar200ResponseEventsInnerVideoProviderEnum}
21
+ * @memberof EarningsCallsCalendar200ResponseEventsInnerVideo
22
+ */
23
+ provider: EarningsCallsCalendar200ResponseEventsInnerVideoProviderEnum;
24
+ /**
25
+ * The platform's video id
26
+ * @type {string}
27
+ * @memberof EarningsCallsCalendar200ResponseEventsInnerVideo
28
+ */
29
+ video_id: string;
30
+ /**
31
+ * Watch page
32
+ * @type {string}
33
+ * @memberof EarningsCallsCalendar200ResponseEventsInnerVideo
34
+ */
35
+ url: string;
36
+ /**
37
+ * Privacy-enhanced player URL (YouTube: youtube-nocookie.com; Vimeo: dnt=1)
38
+ * @type {string}
39
+ * @memberof EarningsCallsCalendar200ResponseEventsInnerVideo
40
+ */
41
+ embed_url: string;
42
+ /**
43
+ * Video title
44
+ * @type {string}
45
+ * @memberof EarningsCallsCalendar200ResponseEventsInnerVideo
46
+ */
47
+ title: string | null;
48
+ /**
49
+ * Channel or account that published it
50
+ * @type {string}
51
+ * @memberof EarningsCallsCalendar200ResponseEventsInnerVideo
52
+ */
53
+ channel: string | null;
54
+ /**
55
+ * Thumbnail image
56
+ * @type {string}
57
+ * @memberof EarningsCallsCalendar200ResponseEventsInnerVideo
58
+ */
59
+ thumbnail_url: string | null;
60
+ /**
61
+ * false = the owner disabled or restricted embedding (link `url`); null = not checked yet
62
+ * @type {boolean}
63
+ * @memberof EarningsCallsCalendar200ResponseEventsInnerVideo
64
+ */
65
+ embeddable: boolean | null;
66
+ }
67
+ /**
68
+ * @export
69
+ */
70
+ export declare const EarningsCallsCalendar200ResponseEventsInnerVideoProviderEnum: {
71
+ readonly Youtube: "youtube";
72
+ readonly Vimeo: "vimeo";
73
+ };
74
+ export type EarningsCallsCalendar200ResponseEventsInnerVideoProviderEnum = typeof EarningsCallsCalendar200ResponseEventsInnerVideoProviderEnum[keyof typeof EarningsCallsCalendar200ResponseEventsInnerVideoProviderEnum];
75
+ /**
76
+ * Check if a given object implements the EarningsCallsCalendar200ResponseEventsInnerVideo interface.
77
+ */
78
+ export declare function instanceOfEarningsCallsCalendar200ResponseEventsInnerVideo(value: object): value is EarningsCallsCalendar200ResponseEventsInnerVideo;
79
+ export declare function EarningsCallsCalendar200ResponseEventsInnerVideoFromJSON(json: any): EarningsCallsCalendar200ResponseEventsInnerVideo;
80
+ export declare function EarningsCallsCalendar200ResponseEventsInnerVideoFromJSONTyped(json: any, ignoreDiscriminator: boolean): EarningsCallsCalendar200ResponseEventsInnerVideo;
81
+ export declare function EarningsCallsCalendar200ResponseEventsInnerVideoToJSON(json: any): EarningsCallsCalendar200ResponseEventsInnerVideo;
82
+ export declare function EarningsCallsCalendar200ResponseEventsInnerVideoToJSONTyped(value?: EarningsCallsCalendar200ResponseEventsInnerVideo | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,86 @@
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.EarningsCallsCalendar200ResponseEventsInnerVideoProviderEnum = void 0;
17
+ exports.instanceOfEarningsCallsCalendar200ResponseEventsInnerVideo = instanceOfEarningsCallsCalendar200ResponseEventsInnerVideo;
18
+ exports.EarningsCallsCalendar200ResponseEventsInnerVideoFromJSON = EarningsCallsCalendar200ResponseEventsInnerVideoFromJSON;
19
+ exports.EarningsCallsCalendar200ResponseEventsInnerVideoFromJSONTyped = EarningsCallsCalendar200ResponseEventsInnerVideoFromJSONTyped;
20
+ exports.EarningsCallsCalendar200ResponseEventsInnerVideoToJSON = EarningsCallsCalendar200ResponseEventsInnerVideoToJSON;
21
+ exports.EarningsCallsCalendar200ResponseEventsInnerVideoToJSONTyped = EarningsCallsCalendar200ResponseEventsInnerVideoToJSONTyped;
22
+ /**
23
+ * @export
24
+ */
25
+ exports.EarningsCallsCalendar200ResponseEventsInnerVideoProviderEnum = {
26
+ Youtube: 'youtube',
27
+ Vimeo: 'vimeo'
28
+ };
29
+ /**
30
+ * Check if a given object implements the EarningsCallsCalendar200ResponseEventsInnerVideo interface.
31
+ */
32
+ function instanceOfEarningsCallsCalendar200ResponseEventsInnerVideo(value) {
33
+ if (!('provider' in value) || value['provider'] === undefined)
34
+ return false;
35
+ if (!('video_id' in value) || value['video_id'] === undefined)
36
+ return false;
37
+ if (!('url' in value) || value['url'] === undefined)
38
+ return false;
39
+ if (!('embed_url' in value) || value['embed_url'] === undefined)
40
+ return false;
41
+ if (!('title' in value) || value['title'] === undefined)
42
+ return false;
43
+ if (!('channel' in value) || value['channel'] === undefined)
44
+ return false;
45
+ if (!('thumbnail_url' in value) || value['thumbnail_url'] === undefined)
46
+ return false;
47
+ if (!('embeddable' in value) || value['embeddable'] === undefined)
48
+ return false;
49
+ return true;
50
+ }
51
+ function EarningsCallsCalendar200ResponseEventsInnerVideoFromJSON(json) {
52
+ return EarningsCallsCalendar200ResponseEventsInnerVideoFromJSONTyped(json, false);
53
+ }
54
+ function EarningsCallsCalendar200ResponseEventsInnerVideoFromJSONTyped(json, ignoreDiscriminator) {
55
+ if (json == null) {
56
+ return json;
57
+ }
58
+ return {
59
+ 'provider': json['provider'],
60
+ 'video_id': json['video_id'],
61
+ 'url': json['url'],
62
+ 'embed_url': json['embed_url'],
63
+ 'title': json['title'],
64
+ 'channel': json['channel'],
65
+ 'thumbnail_url': json['thumbnail_url'],
66
+ 'embeddable': json['embeddable'],
67
+ };
68
+ }
69
+ function EarningsCallsCalendar200ResponseEventsInnerVideoToJSON(json) {
70
+ return EarningsCallsCalendar200ResponseEventsInnerVideoToJSONTyped(json, false);
71
+ }
72
+ function EarningsCallsCalendar200ResponseEventsInnerVideoToJSONTyped(value, ignoreDiscriminator = false) {
73
+ if (value == null) {
74
+ return value;
75
+ }
76
+ return {
77
+ 'provider': value['provider'],
78
+ 'video_id': value['video_id'],
79
+ 'url': value['url'],
80
+ 'embed_url': value['embed_url'],
81
+ 'title': value['title'],
82
+ 'channel': value['channel'],
83
+ 'thumbnail_url': value['thumbnail_url'],
84
+ 'embeddable': value['embeddable'],
85
+ };
86
+ }
@@ -10,6 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import type { EarningsCallsDocumentSearch200ResponseHitsInner } from './EarningsCallsDocumentSearch200ResponseHitsInner';
13
+ import type { SearchCoverage } from './SearchCoverage';
13
14
  /**
14
15
  *
15
16
  * @export
@@ -22,6 +23,18 @@ export interface EarningsCallsDocumentSearch200Response {
22
23
  * @memberof EarningsCallsDocumentSearch200Response
23
24
  */
24
25
  query: string;
26
+ /**
27
+ * The mode searched
28
+ * @type {EarningsCallsDocumentSearch200ResponseModeEnum}
29
+ * @memberof EarningsCallsDocumentSearch200Response
30
+ */
31
+ mode: EarningsCallsDocumentSearch200ResponseModeEnum;
32
+ /**
33
+ *
34
+ * @type {SearchCoverage}
35
+ * @memberof EarningsCallsDocumentSearch200Response
36
+ */
37
+ coverage: SearchCoverage;
25
38
  /**
26
39
  * Passages, best first
27
40
  * @type {Array<EarningsCallsDocumentSearch200ResponseHitsInner>}
@@ -29,6 +42,14 @@ export interface EarningsCallsDocumentSearch200Response {
29
42
  */
30
43
  hits: Array<EarningsCallsDocumentSearch200ResponseHitsInner>;
31
44
  }
45
+ /**
46
+ * @export
47
+ */
48
+ export declare const EarningsCallsDocumentSearch200ResponseModeEnum: {
49
+ readonly Lexical: "lexical";
50
+ readonly Literal: "literal";
51
+ };
52
+ export type EarningsCallsDocumentSearch200ResponseModeEnum = typeof EarningsCallsDocumentSearch200ResponseModeEnum[keyof typeof EarningsCallsDocumentSearch200ResponseModeEnum];
32
53
  /**
33
54
  * Check if a given object implements the EarningsCallsDocumentSearch200Response interface.
34
55
  */