@invinite-org/data-api-client 0.3.0 → 0.4.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.
- package/.openapi-generator/FILES +12 -0
- package/dist/apis/EarningsCallsApi.d.ts +46 -6
- package/dist/apis/EarningsCallsApi.js +51 -7
- package/dist/esm/apis/EarningsCallsApi.d.ts +46 -6
- package/dist/esm/apis/EarningsCallsApi.js +50 -6
- package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInner.d.ts +7 -0
- package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInner.js +5 -0
- package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerVideo.d.ts +82 -0
- package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerVideo.js +78 -0
- package/dist/esm/models/EarningsCallsDocumentSearch200Response.d.ts +23 -0
- package/dist/esm/models/EarningsCallsDocumentSearch200Response.js +18 -0
- package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +21 -2
- package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.js +13 -0
- package/dist/esm/models/EarningsCallsEvents200ResponseEventsInner.d.ts +7 -0
- package/dist/esm/models/EarningsCallsEvents200ResponseEventsInner.js +5 -0
- package/dist/esm/models/EarningsCallsLive200ResponseEventsInner.d.ts +7 -0
- package/dist/esm/models/EarningsCallsLive200ResponseEventsInner.js +5 -0
- package/dist/esm/models/EarningsCallsSearch200Response.d.ts +23 -0
- package/dist/esm/models/EarningsCallsSearch200Response.js +18 -0
- package/dist/esm/models/EarningsCallsSearch200ResponseHitsInner.d.ts +21 -2
- package/dist/esm/models/EarningsCallsSearch200ResponseHitsInner.js +13 -0
- package/dist/esm/models/EarningsCallsSlides200Response.d.ts +7 -0
- package/dist/esm/models/EarningsCallsSlides200Response.js +5 -0
- package/dist/esm/models/EarningsCallsSlides200ResponseTimelineInner.d.ts +38 -0
- package/dist/esm/models/EarningsCallsSlides200ResponseTimelineInner.js +47 -0
- package/dist/esm/models/HitMatch.d.ts +61 -0
- package/dist/esm/models/HitMatch.js +65 -0
- package/dist/esm/models/MatchSpan.d.ts +38 -0
- package/dist/esm/models/MatchSpan.js +47 -0
- package/dist/esm/models/SearchCoverage.d.ts +73 -0
- package/dist/esm/models/SearchCoverage.js +76 -0
- package/dist/esm/models/SearchCoverageLeg.d.ts +59 -0
- package/dist/esm/models/SearchCoverageLeg.js +63 -0
- package/dist/esm/models/index.d.ts +6 -0
- package/dist/esm/models/index.js +6 -0
- package/dist/models/EarningsCallsCalendar200ResponseEventsInner.d.ts +7 -0
- package/dist/models/EarningsCallsCalendar200ResponseEventsInner.js +5 -0
- package/dist/models/EarningsCallsCalendar200ResponseEventsInnerVideo.d.ts +82 -0
- package/dist/models/EarningsCallsCalendar200ResponseEventsInnerVideo.js +86 -0
- package/dist/models/EarningsCallsDocumentSearch200Response.d.ts +23 -0
- package/dist/models/EarningsCallsDocumentSearch200Response.js +19 -0
- package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +21 -2
- package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.js +13 -0
- package/dist/models/EarningsCallsEvents200ResponseEventsInner.d.ts +7 -0
- package/dist/models/EarningsCallsEvents200ResponseEventsInner.js +5 -0
- package/dist/models/EarningsCallsLive200ResponseEventsInner.d.ts +7 -0
- package/dist/models/EarningsCallsLive200ResponseEventsInner.js +5 -0
- package/dist/models/EarningsCallsSearch200Response.d.ts +23 -0
- package/dist/models/EarningsCallsSearch200Response.js +19 -0
- package/dist/models/EarningsCallsSearch200ResponseHitsInner.d.ts +21 -2
- package/dist/models/EarningsCallsSearch200ResponseHitsInner.js +13 -0
- package/dist/models/EarningsCallsSlides200Response.d.ts +7 -0
- package/dist/models/EarningsCallsSlides200Response.js +5 -0
- package/dist/models/EarningsCallsSlides200ResponseTimelineInner.d.ts +38 -0
- package/dist/models/EarningsCallsSlides200ResponseTimelineInner.js +54 -0
- package/dist/models/HitMatch.d.ts +61 -0
- package/dist/models/HitMatch.js +73 -0
- package/dist/models/MatchSpan.d.ts +38 -0
- package/dist/models/MatchSpan.js +54 -0
- package/dist/models/SearchCoverage.d.ts +73 -0
- package/dist/models/SearchCoverage.js +84 -0
- package/dist/models/SearchCoverageLeg.d.ts +59 -0
- package/dist/models/SearchCoverageLeg.js +71 -0
- package/dist/models/index.d.ts +6 -0
- package/dist/models/index.js +6 -0
- package/docs/EarningsCallsApi.md +22 -10
- package/docs/EarningsCallsCalendar200ResponseEventsInner.md +2 -0
- package/docs/EarningsCallsCalendar200ResponseEventsInnerVideo.md +49 -0
- package/docs/EarningsCallsDocumentSearch200Response.md +4 -0
- package/docs/EarningsCallsDocumentSearch200ResponseHitsInner.md +6 -0
- package/docs/EarningsCallsEvents200ResponseEventsInner.md +2 -0
- package/docs/EarningsCallsLive200ResponseEventsInner.md +2 -0
- package/docs/EarningsCallsSearch200Response.md +4 -0
- package/docs/EarningsCallsSearch200ResponseHitsInner.md +6 -0
- package/docs/EarningsCallsSlides200Response.md +2 -0
- package/docs/EarningsCallsSlides200ResponseTimelineInner.md +36 -0
- package/docs/HitMatch.md +41 -0
- package/docs/MatchSpan.md +36 -0
- package/docs/SearchCoverage.md +41 -0
- package/docs/SearchCoverageLeg.md +41 -0
- package/package.json +1 -1
- package/src/apis/EarningsCallsApi.ts +62 -6
- package/src/models/EarningsCallsCalendar200ResponseEventsInner.ts +17 -0
- package/src/models/EarningsCallsCalendar200ResponseEventsInnerVideo.ts +140 -0
- package/src/models/EarningsCallsDocumentSearch200Response.ts +38 -0
- package/src/models/EarningsCallsDocumentSearch200ResponseHitsInner.ts +37 -2
- package/src/models/EarningsCallsEvents200ResponseEventsInner.ts +16 -0
- package/src/models/EarningsCallsLive200ResponseEventsInner.ts +17 -0
- package/src/models/EarningsCallsSearch200Response.ts +38 -0
- package/src/models/EarningsCallsSearch200ResponseHitsInner.ts +36 -2
- package/src/models/EarningsCallsSlides200Response.ts +16 -0
- package/src/models/EarningsCallsSlides200ResponseTimelineInner.ts +75 -0
- package/src/models/HitMatch.ts +114 -0
- package/src/models/MatchSpan.ts +75 -0
- package/src/models/SearchCoverage.ts +127 -0
- package/src/models/SearchCoverageLeg.ts +105 -0
- package/src/models/index.ts +6 -0
|
@@ -462,6 +462,12 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
462
462
|
if (requestParameters['q'] != null) {
|
|
463
463
|
queryParameters['q'] = requestParameters['q'];
|
|
464
464
|
}
|
|
465
|
+
if (requestParameters['mode'] != null) {
|
|
466
|
+
queryParameters['mode'] = requestParameters['mode'];
|
|
467
|
+
}
|
|
468
|
+
if (requestParameters['caseSensitive'] != null) {
|
|
469
|
+
queryParameters['case_sensitive'] = requestParameters['caseSensitive'];
|
|
470
|
+
}
|
|
465
471
|
if (requestParameters['identifier'] != null) {
|
|
466
472
|
queryParameters['identifier'] = requestParameters['identifier'];
|
|
467
473
|
}
|
|
@@ -498,7 +504,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
498
504
|
});
|
|
499
505
|
}
|
|
500
506
|
/**
|
|
501
|
-
*
|
|
507
|
+
* Search the page text of investor documents by keywords (default `mode=lexical`), exact text (`literal`), meaning (`semantic`) or both (`hybrid`): the documents of earnings calls (CFO commentary, shareholder letters, data sheets, the company\'s own transcripts) and companies\' IR libraries (annual reports, proxy statements, ESG reports, investor-day decks). ### What you get - Up to 20 passages from company-published documents, with page numbers — not verified facts — and a signed URL of the file (open it at `#page=<page>`). - Filter by company (`identifier`), kind, IR section, year or table. - Each hit names the document\'s folder of the company\'s document tree (`group`, e.g. `earnings/fy2027/q2`, `group_label`, `category`), how it matched (`match`); the response says how much of the searched documents is indexed (`coverage`). ### Search modes - `lexical` (default): keyword search — English full text with stemming; quoted phrases, `OR` and `-word` work (`websearch_to_tsquery`); ranked by `ts_rank_cd`. Finance tokens such as `FY2027`, `10-K`, `Q3` or `EBITDA` match as written. - `literal`: the exact characters of the passage — no stemming, no fuzzy matching, `%` / `_` / `\\` match themselves; case-sensitive unless `case_sensitive=false` (only allowed with `mode=literal`; default `true`). A pattern under 3 characters needs `identifier`. Newest first; `score` is 0. - `semantic`: meaning-based search (multilingual sentence embeddings); `score` is the cosine similarity. - `hybrid`: `lexical` and `semantic` fused by reciprocal rank (`score = Σ 1 / (60 + rank)`, equal weights, ties by passage); `match.lexical_rank` / `match.semantic_rank` give each leg\'s rank. Best for natural-language questions. - `match.spans` mark the matched characters in `text` (zero-based, end-exclusive Unicode code-point offsets); `text` is cut around the first match (`text_truncated`). Semantic matches carry no spans. An exact mode never expands into semantic or fuzzy results. Every mode costs the same. ### Coverage - `coverage.completeness` = `complete` (every searched passage is indexed: no hits is a genuine no-result), `partial` (some passages are still being indexed or failed, or a hybrid leg was unavailable) or `unknown` (a mode\'s index is not built for the searched scope, e.g. `semantic_index_missing`) — read it before treating an empty list as \"not found\". - `coverage.lexical` / `coverage.semantic` count the searched transcripts or documents per index (`indexed`, `pending`, `failed`); null for a leg the mode did not use. `reasons` lists why the answer may be incomplete. The counts come from the indexing ledger: a transcript or document whose current version the index has not confirmed counts as `pending`; when they cannot be read, the hits are still returned with `completeness: unknown`, both legs null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`; pass `mode=semantic` for the previous behaviour (or `mode=hybrid` for natural-language questions). ### Errors - `400` for a `mode=lexical` query of stopwords only (no searchable words), for `case_sensitive` with any mode but `literal`, and for a `mode=literal` pattern under 3 characters without a scope (see Search modes). - `429 upstream_rate_limited` and `503 search_unavailable` carry `Retry-After` (`503` also when a keyword search runs over its time limit — never an empty answer). - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for display: FREE.
|
|
502
508
|
* Search investor documents
|
|
503
509
|
*/
|
|
504
510
|
earningsCallsDocumentSearchRaw(requestParameters, initOverrides) {
|
|
@@ -509,7 +515,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
509
515
|
});
|
|
510
516
|
}
|
|
511
517
|
/**
|
|
512
|
-
*
|
|
518
|
+
* Search the page text of investor documents by keywords (default `mode=lexical`), exact text (`literal`), meaning (`semantic`) or both (`hybrid`): the documents of earnings calls (CFO commentary, shareholder letters, data sheets, the company\'s own transcripts) and companies\' IR libraries (annual reports, proxy statements, ESG reports, investor-day decks). ### What you get - Up to 20 passages from company-published documents, with page numbers — not verified facts — and a signed URL of the file (open it at `#page=<page>`). - Filter by company (`identifier`), kind, IR section, year or table. - Each hit names the document\'s folder of the company\'s document tree (`group`, e.g. `earnings/fy2027/q2`, `group_label`, `category`), how it matched (`match`); the response says how much of the searched documents is indexed (`coverage`). ### Search modes - `lexical` (default): keyword search — English full text with stemming; quoted phrases, `OR` and `-word` work (`websearch_to_tsquery`); ranked by `ts_rank_cd`. Finance tokens such as `FY2027`, `10-K`, `Q3` or `EBITDA` match as written. - `literal`: the exact characters of the passage — no stemming, no fuzzy matching, `%` / `_` / `\\` match themselves; case-sensitive unless `case_sensitive=false` (only allowed with `mode=literal`; default `true`). A pattern under 3 characters needs `identifier`. Newest first; `score` is 0. - `semantic`: meaning-based search (multilingual sentence embeddings); `score` is the cosine similarity. - `hybrid`: `lexical` and `semantic` fused by reciprocal rank (`score = Σ 1 / (60 + rank)`, equal weights, ties by passage); `match.lexical_rank` / `match.semantic_rank` give each leg\'s rank. Best for natural-language questions. - `match.spans` mark the matched characters in `text` (zero-based, end-exclusive Unicode code-point offsets); `text` is cut around the first match (`text_truncated`). Semantic matches carry no spans. An exact mode never expands into semantic or fuzzy results. Every mode costs the same. ### Coverage - `coverage.completeness` = `complete` (every searched passage is indexed: no hits is a genuine no-result), `partial` (some passages are still being indexed or failed, or a hybrid leg was unavailable) or `unknown` (a mode\'s index is not built for the searched scope, e.g. `semantic_index_missing`) — read it before treating an empty list as \"not found\". - `coverage.lexical` / `coverage.semantic` count the searched transcripts or documents per index (`indexed`, `pending`, `failed`); null for a leg the mode did not use. `reasons` lists why the answer may be incomplete. The counts come from the indexing ledger: a transcript or document whose current version the index has not confirmed counts as `pending`; when they cannot be read, the hits are still returned with `completeness: unknown`, both legs null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`; pass `mode=semantic` for the previous behaviour (or `mode=hybrid` for natural-language questions). ### Errors - `400` for a `mode=lexical` query of stopwords only (no searchable words), for `case_sensitive` with any mode but `literal`, and for a `mode=literal` pattern under 3 characters without a scope (see Search modes). - `429 upstream_rate_limited` and `503 search_unavailable` carry `Retry-After` (`503` also when a keyword search runs over its time limit — never an empty answer). - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for display: FREE.
|
|
513
519
|
* Search investor documents
|
|
514
520
|
*/
|
|
515
521
|
earningsCallsDocumentSearch(requestParameters, initOverrides) {
|
|
@@ -1421,6 +1427,12 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
1421
1427
|
if (requestParameters['q'] != null) {
|
|
1422
1428
|
queryParameters['q'] = requestParameters['q'];
|
|
1423
1429
|
}
|
|
1430
|
+
if (requestParameters['mode'] != null) {
|
|
1431
|
+
queryParameters['mode'] = requestParameters['mode'];
|
|
1432
|
+
}
|
|
1433
|
+
if (requestParameters['caseSensitive'] != null) {
|
|
1434
|
+
queryParameters['case_sensitive'] = requestParameters['caseSensitive'];
|
|
1435
|
+
}
|
|
1424
1436
|
if (requestParameters['eventId'] != null) {
|
|
1425
1437
|
queryParameters['event_id'] = requestParameters['eventId'];
|
|
1426
1438
|
}
|
|
@@ -1460,7 +1472,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
1460
1472
|
});
|
|
1461
1473
|
}
|
|
1462
1474
|
/**
|
|
1463
|
-
* \"Ask this call\":
|
|
1475
|
+
* \"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`), exact text (`literal`), meaning (`semantic`) or both (`hybrid`) — one call (`event_id`), one company (`identifier`) or every call (default: the last 365 days). ### What you get - Up to 8 passages with speaker and `start_ms`, how each matched (`match`) and the index coverage of the search (`coverage`). Cite `event_id` and `start_ms`. - On plans that include the audio and slides routes (PRO): `audio_url` opens the recording\'s permanent URL at the passage (`#t=<seconds>`; null while no recording is available) and `slide.image_url` (a signed URL) shows the slide. ### Event types - `event_type` (default `earnings_call`; `all` = every type) selects investor days, conferences or shareholder meetings too. ### Search modes - `lexical` (default): keyword search — English full text with stemming; quoted phrases, `OR` and `-word` work (`websearch_to_tsquery`); ranked by `ts_rank_cd`. Finance tokens such as `FY2027`, `10-K`, `Q3` or `EBITDA` match as written. - `literal`: the exact characters of the passage — no stemming, no fuzzy matching, `%` / `_` / `\\` match themselves; case-sensitive unless `case_sensitive=false` (only allowed with `mode=literal`; default `true`). A pattern under 3 characters needs `identifier` or `event_id`. Newest first; `score` is 0. - `semantic`: meaning-based search (multilingual sentence embeddings); `score` is the cosine similarity. - `hybrid`: `lexical` and `semantic` fused by reciprocal rank (`score = Σ 1 / (60 + rank)`, equal weights, ties by passage); `match.lexical_rank` / `match.semantic_rank` give each leg\'s rank. Best for natural-language questions. - `match.spans` mark the matched characters in `text` (zero-based, end-exclusive Unicode code-point offsets); `text` is cut around the first match (`text_truncated`). Semantic matches carry no spans. An exact mode never expands into semantic or fuzzy results. Every mode costs the same. ### Coverage - `coverage.completeness` = `complete` (every searched passage is indexed: no hits is a genuine no-result), `partial` (some passages are still being indexed or failed, or a hybrid leg was unavailable) or `unknown` (a mode\'s index is not built for the searched scope, e.g. `semantic_index_missing`) — read it before treating an empty list as \"not found\". - `coverage.lexical` / `coverage.semantic` count the searched transcripts or documents per index (`indexed`, `pending`, `failed`); null for a leg the mode did not use. `reasons` lists why the answer may be incomplete. The counts come from the indexing ledger: a transcript or document whose current version the index has not confirmed counts as `pending`; when they cannot be read, the hits are still returned with `completeness: unknown`, both legs null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`; pass `mode=semantic` for the previous behaviour (or `mode=hybrid` for natural-language questions). ### Errors - `400` for a `mode=lexical` query of stopwords only (no searchable words), for `case_sensitive` with any mode but `literal`, and for a `mode=literal` pattern under 3 characters without a scope (see Search modes). - `429 upstream_rate_limited` and `503 search_unavailable` carry `Retry-After` (`503` also when a keyword search runs over its time limit — never an empty answer). - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for rag: STANDARD.
|
|
1464
1476
|
* Search earnings calls
|
|
1465
1477
|
*/
|
|
1466
1478
|
earningsCallsSearchRaw(requestParameters, initOverrides) {
|
|
@@ -1471,7 +1483,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
1471
1483
|
});
|
|
1472
1484
|
}
|
|
1473
1485
|
/**
|
|
1474
|
-
* \"Ask this call\":
|
|
1486
|
+
* \"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`), exact text (`literal`), meaning (`semantic`) or both (`hybrid`) — one call (`event_id`), one company (`identifier`) or every call (default: the last 365 days). ### What you get - Up to 8 passages with speaker and `start_ms`, how each matched (`match`) and the index coverage of the search (`coverage`). Cite `event_id` and `start_ms`. - On plans that include the audio and slides routes (PRO): `audio_url` opens the recording\'s permanent URL at the passage (`#t=<seconds>`; null while no recording is available) and `slide.image_url` (a signed URL) shows the slide. ### Event types - `event_type` (default `earnings_call`; `all` = every type) selects investor days, conferences or shareholder meetings too. ### Search modes - `lexical` (default): keyword search — English full text with stemming; quoted phrases, `OR` and `-word` work (`websearch_to_tsquery`); ranked by `ts_rank_cd`. Finance tokens such as `FY2027`, `10-K`, `Q3` or `EBITDA` match as written. - `literal`: the exact characters of the passage — no stemming, no fuzzy matching, `%` / `_` / `\\` match themselves; case-sensitive unless `case_sensitive=false` (only allowed with `mode=literal`; default `true`). A pattern under 3 characters needs `identifier` or `event_id`. Newest first; `score` is 0. - `semantic`: meaning-based search (multilingual sentence embeddings); `score` is the cosine similarity. - `hybrid`: `lexical` and `semantic` fused by reciprocal rank (`score = Σ 1 / (60 + rank)`, equal weights, ties by passage); `match.lexical_rank` / `match.semantic_rank` give each leg\'s rank. Best for natural-language questions. - `match.spans` mark the matched characters in `text` (zero-based, end-exclusive Unicode code-point offsets); `text` is cut around the first match (`text_truncated`). Semantic matches carry no spans. An exact mode never expands into semantic or fuzzy results. Every mode costs the same. ### Coverage - `coverage.completeness` = `complete` (every searched passage is indexed: no hits is a genuine no-result), `partial` (some passages are still being indexed or failed, or a hybrid leg was unavailable) or `unknown` (a mode\'s index is not built for the searched scope, e.g. `semantic_index_missing`) — read it before treating an empty list as \"not found\". - `coverage.lexical` / `coverage.semantic` count the searched transcripts or documents per index (`indexed`, `pending`, `failed`); null for a leg the mode did not use. `reasons` lists why the answer may be incomplete. The counts come from the indexing ledger: a transcript or document whose current version the index has not confirmed counts as `pending`; when they cannot be read, the hits are still returned with `completeness: unknown`, both legs null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`; pass `mode=semantic` for the previous behaviour (or `mode=hybrid` for natural-language questions). ### Errors - `400` for a `mode=lexical` query of stopwords only (no searchable words), for `case_sensitive` with any mode but `literal`, and for a `mode=literal` pattern under 3 characters without a scope (see Search modes). - `429 upstream_rate_limited` and `503 search_unavailable` carry `Retry-After` (`503` also when a keyword search runs over its time limit — never an empty answer). - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for rag: STANDARD.
|
|
1475
1487
|
* Search earnings calls
|
|
1476
1488
|
*/
|
|
1477
1489
|
earningsCallsSearch(requestParameters, initOverrides) {
|
|
@@ -1528,7 +1540,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
1528
1540
|
});
|
|
1529
1541
|
}
|
|
1530
1542
|
/**
|
|
1531
|
-
* The slide deck of one earnings call (PRO): the deck PDF and each page image as signed URLs, page titles and, with `include=markdown`, each page\'s text. ### Files - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. ### Errors - `404 slides_unavailable` when no deck is available. - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for display: FREE.
|
|
1543
|
+
* The slide deck of one earnings call (PRO): the deck PDF and each page image as signed URLs, page titles and, with `include=markdown`, each page\'s text. ### Files - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. - `timeline`: the slides shown in the webcast player, keyed to the call audio (`at_ms` from the start of the recording the audio route serves; the whole call, whatever `pages` asks). ### Errors - `404 slides_unavailable` when no deck is available. - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for display: FREE.
|
|
1532
1544
|
* Earnings call slides
|
|
1533
1545
|
*/
|
|
1534
1546
|
earningsCallsSlidesRaw(requestParameters, initOverrides) {
|
|
@@ -1539,7 +1551,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
1539
1551
|
});
|
|
1540
1552
|
}
|
|
1541
1553
|
/**
|
|
1542
|
-
* The slide deck of one earnings call (PRO): the deck PDF and each page image as signed URLs, page titles and, with `include=markdown`, each page\'s text. ### Files - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. ### Errors - `404 slides_unavailable` when no deck is available. - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for display: FREE.
|
|
1554
|
+
* The slide deck of one earnings call (PRO): the deck PDF and each page image as signed URLs, page titles and, with `include=markdown`, each page\'s text. ### Files - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. - `timeline`: the slides shown in the webcast player, keyed to the call audio (`at_ms` from the start of the recording the audio route serves; the whole call, whatever `pages` asks). ### Errors - `404 slides_unavailable` when no deck is available. - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for display: FREE.
|
|
1543
1555
|
* Earnings call slides
|
|
1544
1556
|
*/
|
|
1545
1557
|
earningsCallsSlides() {
|
|
@@ -2156,6 +2168,22 @@ export const EarningsCallsDiffEventTypeEnum = {
|
|
|
2156
2168
|
export const EarningsCallsDiffVsEnum = {
|
|
2157
2169
|
Prior: 'prior'
|
|
2158
2170
|
};
|
|
2171
|
+
/**
|
|
2172
|
+
* @export
|
|
2173
|
+
*/
|
|
2174
|
+
export const EarningsCallsDocumentSearchModeEnum = {
|
|
2175
|
+
Lexical: 'lexical',
|
|
2176
|
+
Literal: 'literal',
|
|
2177
|
+
Semantic: 'semantic',
|
|
2178
|
+
Hybrid: 'hybrid'
|
|
2179
|
+
};
|
|
2180
|
+
/**
|
|
2181
|
+
* @export
|
|
2182
|
+
*/
|
|
2183
|
+
export const EarningsCallsDocumentSearchCaseSensitiveEnum = {
|
|
2184
|
+
True: 'true',
|
|
2185
|
+
False: 'false'
|
|
2186
|
+
};
|
|
2159
2187
|
/**
|
|
2160
2188
|
* @export
|
|
2161
2189
|
*/
|
|
@@ -2330,6 +2358,22 @@ export const EarningsCallsQaEventTypeEnum = {
|
|
|
2330
2358
|
export const EarningsCallsQaIncludeEnum = {
|
|
2331
2359
|
Scores: 'scores'
|
|
2332
2360
|
};
|
|
2361
|
+
/**
|
|
2362
|
+
* @export
|
|
2363
|
+
*/
|
|
2364
|
+
export const EarningsCallsSearchModeEnum = {
|
|
2365
|
+
Lexical: 'lexical',
|
|
2366
|
+
Literal: 'literal',
|
|
2367
|
+
Semantic: 'semantic',
|
|
2368
|
+
Hybrid: 'hybrid'
|
|
2369
|
+
};
|
|
2370
|
+
/**
|
|
2371
|
+
* @export
|
|
2372
|
+
*/
|
|
2373
|
+
export const EarningsCallsSearchCaseSensitiveEnum = {
|
|
2374
|
+
True: 'true',
|
|
2375
|
+
False: 'false'
|
|
2376
|
+
};
|
|
2333
2377
|
/**
|
|
2334
2378
|
* @export
|
|
2335
2379
|
*/
|
|
@@ -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
|
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
* https://openapi-generator.tech
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
|
+
import { EarningsCallsCalendar200ResponseEventsInnerVideoFromJSON, EarningsCallsCalendar200ResponseEventsInnerVideoToJSON, } from './EarningsCallsCalendar200ResponseEventsInnerVideo';
|
|
14
15
|
/**
|
|
15
16
|
* @export
|
|
16
17
|
*/
|
|
@@ -105,6 +106,8 @@ export function instanceOfEarningsCallsCalendar200ResponseEventsInner(value) {
|
|
|
105
106
|
return false;
|
|
106
107
|
if (!('webcast_url' in value) || value['webcast_url'] === undefined)
|
|
107
108
|
return false;
|
|
109
|
+
if (!('video' in value) || value['video'] === undefined)
|
|
110
|
+
return false;
|
|
108
111
|
return true;
|
|
109
112
|
}
|
|
110
113
|
export function EarningsCallsCalendar200ResponseEventsInnerFromJSON(json) {
|
|
@@ -142,6 +145,7 @@ export function EarningsCallsCalendar200ResponseEventsInnerFromJSONTyped(json, i
|
|
|
142
145
|
'has_press_release': json['has_press_release'],
|
|
143
146
|
'has_documents': json['has_documents'],
|
|
144
147
|
'webcast_url': json['webcast_url'],
|
|
148
|
+
'video': EarningsCallsCalendar200ResponseEventsInnerVideoFromJSON(json['video']),
|
|
145
149
|
};
|
|
146
150
|
}
|
|
147
151
|
export function EarningsCallsCalendar200ResponseEventsInnerToJSON(json) {
|
|
@@ -179,5 +183,6 @@ export function EarningsCallsCalendar200ResponseEventsInnerToJSONTyped(value, ig
|
|
|
179
183
|
'has_press_release': value['has_press_release'],
|
|
180
184
|
'has_documents': value['has_documents'],
|
|
181
185
|
'webcast_url': value['webcast_url'],
|
|
186
|
+
'video': EarningsCallsCalendar200ResponseEventsInnerVideoToJSON(value['video']),
|
|
182
187
|
};
|
|
183
188
|
}
|
|
@@ -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,78 @@
|
|
|
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 EarningsCallsCalendar200ResponseEventsInnerVideoProviderEnum = {
|
|
18
|
+
Youtube: 'youtube',
|
|
19
|
+
Vimeo: 'vimeo'
|
|
20
|
+
};
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the EarningsCallsCalendar200ResponseEventsInnerVideo interface.
|
|
23
|
+
*/
|
|
24
|
+
export function instanceOfEarningsCallsCalendar200ResponseEventsInnerVideo(value) {
|
|
25
|
+
if (!('provider' in value) || value['provider'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
if (!('video_id' in value) || value['video_id'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
if (!('url' in value) || value['url'] === undefined)
|
|
30
|
+
return false;
|
|
31
|
+
if (!('embed_url' in value) || value['embed_url'] === undefined)
|
|
32
|
+
return false;
|
|
33
|
+
if (!('title' in value) || value['title'] === undefined)
|
|
34
|
+
return false;
|
|
35
|
+
if (!('channel' in value) || value['channel'] === undefined)
|
|
36
|
+
return false;
|
|
37
|
+
if (!('thumbnail_url' in value) || value['thumbnail_url'] === undefined)
|
|
38
|
+
return false;
|
|
39
|
+
if (!('embeddable' in value) || value['embeddable'] === undefined)
|
|
40
|
+
return false;
|
|
41
|
+
return true;
|
|
42
|
+
}
|
|
43
|
+
export function EarningsCallsCalendar200ResponseEventsInnerVideoFromJSON(json) {
|
|
44
|
+
return EarningsCallsCalendar200ResponseEventsInnerVideoFromJSONTyped(json, false);
|
|
45
|
+
}
|
|
46
|
+
export function EarningsCallsCalendar200ResponseEventsInnerVideoFromJSONTyped(json, ignoreDiscriminator) {
|
|
47
|
+
if (json == null) {
|
|
48
|
+
return json;
|
|
49
|
+
}
|
|
50
|
+
return {
|
|
51
|
+
'provider': json['provider'],
|
|
52
|
+
'video_id': json['video_id'],
|
|
53
|
+
'url': json['url'],
|
|
54
|
+
'embed_url': json['embed_url'],
|
|
55
|
+
'title': json['title'],
|
|
56
|
+
'channel': json['channel'],
|
|
57
|
+
'thumbnail_url': json['thumbnail_url'],
|
|
58
|
+
'embeddable': json['embeddable'],
|
|
59
|
+
};
|
|
60
|
+
}
|
|
61
|
+
export function EarningsCallsCalendar200ResponseEventsInnerVideoToJSON(json) {
|
|
62
|
+
return EarningsCallsCalendar200ResponseEventsInnerVideoToJSONTyped(json, false);
|
|
63
|
+
}
|
|
64
|
+
export function EarningsCallsCalendar200ResponseEventsInnerVideoToJSONTyped(value, ignoreDiscriminator = false) {
|
|
65
|
+
if (value == null) {
|
|
66
|
+
return value;
|
|
67
|
+
}
|
|
68
|
+
return {
|
|
69
|
+
'provider': value['provider'],
|
|
70
|
+
'video_id': value['video_id'],
|
|
71
|
+
'url': value['url'],
|
|
72
|
+
'embed_url': value['embed_url'],
|
|
73
|
+
'title': value['title'],
|
|
74
|
+
'channel': value['channel'],
|
|
75
|
+
'thumbnail_url': value['thumbnail_url'],
|
|
76
|
+
'embeddable': value['embeddable'],
|
|
77
|
+
};
|
|
78
|
+
}
|
|
@@ -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,16 @@ 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
|
+
readonly Semantic: "semantic";
|
|
52
|
+
readonly Hybrid: "hybrid";
|
|
53
|
+
};
|
|
54
|
+
export type EarningsCallsDocumentSearch200ResponseModeEnum = typeof EarningsCallsDocumentSearch200ResponseModeEnum[keyof typeof EarningsCallsDocumentSearch200ResponseModeEnum];
|
|
32
55
|
/**
|
|
33
56
|
* Check if a given object implements the EarningsCallsDocumentSearch200Response interface.
|
|
34
57
|
*/
|
|
@@ -12,12 +12,26 @@
|
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
14
|
import { EarningsCallsDocumentSearch200ResponseHitsInnerFromJSON, EarningsCallsDocumentSearch200ResponseHitsInnerToJSON, } from './EarningsCallsDocumentSearch200ResponseHitsInner';
|
|
15
|
+
import { SearchCoverageFromJSON, SearchCoverageToJSON, } from './SearchCoverage';
|
|
16
|
+
/**
|
|
17
|
+
* @export
|
|
18
|
+
*/
|
|
19
|
+
export const EarningsCallsDocumentSearch200ResponseModeEnum = {
|
|
20
|
+
Lexical: 'lexical',
|
|
21
|
+
Literal: 'literal',
|
|
22
|
+
Semantic: 'semantic',
|
|
23
|
+
Hybrid: 'hybrid'
|
|
24
|
+
};
|
|
15
25
|
/**
|
|
16
26
|
* Check if a given object implements the EarningsCallsDocumentSearch200Response interface.
|
|
17
27
|
*/
|
|
18
28
|
export function instanceOfEarningsCallsDocumentSearch200Response(value) {
|
|
19
29
|
if (!('query' in value) || value['query'] === undefined)
|
|
20
30
|
return false;
|
|
31
|
+
if (!('mode' in value) || value['mode'] === undefined)
|
|
32
|
+
return false;
|
|
33
|
+
if (!('coverage' in value) || value['coverage'] === undefined)
|
|
34
|
+
return false;
|
|
21
35
|
if (!('hits' in value) || value['hits'] === undefined)
|
|
22
36
|
return false;
|
|
23
37
|
return true;
|
|
@@ -31,6 +45,8 @@ export function EarningsCallsDocumentSearch200ResponseFromJSONTyped(json, ignore
|
|
|
31
45
|
}
|
|
32
46
|
return {
|
|
33
47
|
'query': json['query'],
|
|
48
|
+
'mode': json['mode'],
|
|
49
|
+
'coverage': SearchCoverageFromJSON(json['coverage']),
|
|
34
50
|
'hits': (json['hits'].map(EarningsCallsDocumentSearch200ResponseHitsInnerFromJSON)),
|
|
35
51
|
};
|
|
36
52
|
}
|
|
@@ -43,6 +59,8 @@ export function EarningsCallsDocumentSearch200ResponseToJSONTyped(value, ignoreD
|
|
|
43
59
|
}
|
|
44
60
|
return {
|
|
45
61
|
'query': value['query'],
|
|
62
|
+
'mode': value['mode'],
|
|
63
|
+
'coverage': SearchCoverageToJSON(value['coverage']),
|
|
46
64
|
'hits': (value['hits'].map(EarningsCallsDocumentSearch200ResponseHitsInnerToJSON)),
|
|
47
65
|
};
|
|
48
66
|
}
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import type { HitMatch } from './HitMatch';
|
|
12
13
|
/**
|
|
13
14
|
*
|
|
14
15
|
* @export
|
|
@@ -16,11 +17,17 @@
|
|
|
16
17
|
*/
|
|
17
18
|
export interface EarningsCallsDocumentSearch200ResponseHitsInner {
|
|
18
19
|
/**
|
|
19
|
-
*
|
|
20
|
+
* Relevance per mode: lexical = ts_rank_cd (4 decimals), literal = 0 (hits are ordered newest year first), semantic = cosine similarity (4 decimals), hybrid = reciprocal-rank-fusion score (6 decimals)
|
|
20
21
|
* @type {number}
|
|
21
22
|
* @memberof EarningsCallsDocumentSearch200ResponseHitsInner
|
|
22
23
|
*/
|
|
23
24
|
score: number;
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
* @type {HitMatch}
|
|
28
|
+
* @memberof EarningsCallsDocumentSearch200ResponseHitsInner
|
|
29
|
+
*/
|
|
30
|
+
match: HitMatch;
|
|
24
31
|
/**
|
|
25
32
|
* Document identifier (company_documents: /v1/earnings-calls/company-documents/{document_id})
|
|
26
33
|
* @type {string}
|
|
@@ -88,11 +95,23 @@ export interface EarningsCallsDocumentSearch200ResponseHitsInner {
|
|
|
88
95
|
*/
|
|
89
96
|
heading: string | null;
|
|
90
97
|
/**
|
|
91
|
-
*
|
|
98
|
+
* Position of the passage among the document's passages
|
|
99
|
+
* @type {number}
|
|
100
|
+
* @memberof EarningsCallsDocumentSearch200ResponseHitsInner
|
|
101
|
+
*/
|
|
102
|
+
chunk_index: number | null;
|
|
103
|
+
/**
|
|
104
|
+
* The passage (≤ 600 characters, cut on word boundaries around the first match)
|
|
92
105
|
* @type {string}
|
|
93
106
|
* @memberof EarningsCallsDocumentSearch200ResponseHitsInner
|
|
94
107
|
*/
|
|
95
108
|
text: string;
|
|
109
|
+
/**
|
|
110
|
+
* true = text is shorter than the passage
|
|
111
|
+
* @type {boolean}
|
|
112
|
+
* @memberof EarningsCallsDocumentSearch200ResponseHitsInner
|
|
113
|
+
*/
|
|
114
|
+
text_truncated: boolean;
|
|
96
115
|
/**
|
|
97
116
|
* Document title
|
|
98
117
|
* @type {string}
|
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
* https://openapi-generator.tech
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
|
+
import { HitMatchFromJSON, HitMatchToJSON, } from './HitMatch';
|
|
14
15
|
/**
|
|
15
16
|
* @export
|
|
16
17
|
*/
|
|
@@ -37,6 +38,8 @@ export const EarningsCallsDocumentSearch200ResponseHitsInnerCategoryEnum = {
|
|
|
37
38
|
export function instanceOfEarningsCallsDocumentSearch200ResponseHitsInner(value) {
|
|
38
39
|
if (!('score' in value) || value['score'] === undefined)
|
|
39
40
|
return false;
|
|
41
|
+
if (!('match' in value) || value['match'] === undefined)
|
|
42
|
+
return false;
|
|
40
43
|
if (!('document_id' in value) || value['document_id'] === undefined)
|
|
41
44
|
return false;
|
|
42
45
|
if (!('table' in value) || value['table'] === undefined)
|
|
@@ -59,8 +62,12 @@ export function instanceOfEarningsCallsDocumentSearch200ResponseHitsInner(value)
|
|
|
59
62
|
return false;
|
|
60
63
|
if (!('heading' in value) || value['heading'] === undefined)
|
|
61
64
|
return false;
|
|
65
|
+
if (!('chunk_index' in value) || value['chunk_index'] === undefined)
|
|
66
|
+
return false;
|
|
62
67
|
if (!('text' in value) || value['text'] === undefined)
|
|
63
68
|
return false;
|
|
69
|
+
if (!('text_truncated' in value) || value['text_truncated'] === undefined)
|
|
70
|
+
return false;
|
|
64
71
|
if (!('title' in value) || value['title'] === undefined)
|
|
65
72
|
return false;
|
|
66
73
|
if (!('group' in value) || value['group'] === undefined)
|
|
@@ -84,6 +91,7 @@ export function EarningsCallsDocumentSearch200ResponseHitsInnerFromJSONTyped(jso
|
|
|
84
91
|
}
|
|
85
92
|
return {
|
|
86
93
|
'score': json['score'],
|
|
94
|
+
'match': HitMatchFromJSON(json['match']),
|
|
87
95
|
'document_id': json['document_id'],
|
|
88
96
|
'table': json['table'],
|
|
89
97
|
'event_id': json['event_id'],
|
|
@@ -95,7 +103,9 @@ export function EarningsCallsDocumentSearch200ResponseHitsInnerFromJSONTyped(jso
|
|
|
95
103
|
'period': json['period'],
|
|
96
104
|
'page': json['page'],
|
|
97
105
|
'heading': json['heading'],
|
|
106
|
+
'chunk_index': json['chunk_index'],
|
|
98
107
|
'text': json['text'],
|
|
108
|
+
'text_truncated': json['text_truncated'],
|
|
99
109
|
'title': json['title'],
|
|
100
110
|
'group': json['group'],
|
|
101
111
|
'group_label': json['group_label'],
|
|
@@ -113,6 +123,7 @@ export function EarningsCallsDocumentSearch200ResponseHitsInnerToJSONTyped(value
|
|
|
113
123
|
}
|
|
114
124
|
return {
|
|
115
125
|
'score': value['score'],
|
|
126
|
+
'match': HitMatchToJSON(value['match']),
|
|
116
127
|
'document_id': value['document_id'],
|
|
117
128
|
'table': value['table'],
|
|
118
129
|
'event_id': value['event_id'],
|
|
@@ -124,7 +135,9 @@ export function EarningsCallsDocumentSearch200ResponseHitsInnerToJSONTyped(value
|
|
|
124
135
|
'period': value['period'],
|
|
125
136
|
'page': value['page'],
|
|
126
137
|
'heading': value['heading'],
|
|
138
|
+
'chunk_index': value['chunk_index'],
|
|
127
139
|
'text': value['text'],
|
|
140
|
+
'text_truncated': value['text_truncated'],
|
|
128
141
|
'title': value['title'],
|
|
129
142
|
'group': value['group'],
|
|
130
143
|
'group_label': value['group_label'],
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { EarningsCallsEvents200ResponseEventsInnerObservationsInner } from './EarningsCallsEvents200ResponseEventsInnerObservationsInner';
|
|
13
|
+
import type { EarningsCallsCalendar200ResponseEventsInnerVideo } from './EarningsCallsCalendar200ResponseEventsInnerVideo';
|
|
13
14
|
/**
|
|
14
15
|
*
|
|
15
16
|
* @export
|
|
@@ -178,6 +179,12 @@ export interface EarningsCallsEvents200ResponseEventsInner {
|
|
|
178
179
|
* @memberof EarningsCallsEvents200ResponseEventsInner
|
|
179
180
|
*/
|
|
180
181
|
webcast_url: string | null;
|
|
182
|
+
/**
|
|
183
|
+
*
|
|
184
|
+
* @type {EarningsCallsCalendar200ResponseEventsInnerVideo}
|
|
185
|
+
* @memberof EarningsCallsEvents200ResponseEventsInner
|
|
186
|
+
*/
|
|
187
|
+
video: EarningsCallsCalendar200ResponseEventsInnerVideo | null;
|
|
181
188
|
/**
|
|
182
189
|
* Date / time observations, oldest first (at most 50)
|
|
183
190
|
* @type {Array<EarningsCallsEvents200ResponseEventsInnerObservationsInner>}
|
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
14
|
import { EarningsCallsEvents200ResponseEventsInnerObservationsInnerFromJSON, EarningsCallsEvents200ResponseEventsInnerObservationsInnerToJSON, } from './EarningsCallsEvents200ResponseEventsInnerObservationsInner';
|
|
15
|
+
import { EarningsCallsCalendar200ResponseEventsInnerVideoFromJSON, EarningsCallsCalendar200ResponseEventsInnerVideoToJSON, } from './EarningsCallsCalendar200ResponseEventsInnerVideo';
|
|
15
16
|
/**
|
|
16
17
|
* @export
|
|
17
18
|
*/
|
|
@@ -106,6 +107,8 @@ export function instanceOfEarningsCallsEvents200ResponseEventsInner(value) {
|
|
|
106
107
|
return false;
|
|
107
108
|
if (!('webcast_url' in value) || value['webcast_url'] === undefined)
|
|
108
109
|
return false;
|
|
110
|
+
if (!('video' in value) || value['video'] === undefined)
|
|
111
|
+
return false;
|
|
109
112
|
return true;
|
|
110
113
|
}
|
|
111
114
|
export function EarningsCallsEvents200ResponseEventsInnerFromJSON(json) {
|
|
@@ -143,6 +146,7 @@ export function EarningsCallsEvents200ResponseEventsInnerFromJSONTyped(json, ign
|
|
|
143
146
|
'has_press_release': json['has_press_release'],
|
|
144
147
|
'has_documents': json['has_documents'],
|
|
145
148
|
'webcast_url': json['webcast_url'],
|
|
149
|
+
'video': EarningsCallsCalendar200ResponseEventsInnerVideoFromJSON(json['video']),
|
|
146
150
|
'observations': json['observations'] == null ? undefined : (json['observations'].map(EarningsCallsEvents200ResponseEventsInnerObservationsInnerFromJSON)),
|
|
147
151
|
};
|
|
148
152
|
}
|
|
@@ -181,6 +185,7 @@ export function EarningsCallsEvents200ResponseEventsInnerToJSONTyped(value, igno
|
|
|
181
185
|
'has_press_release': value['has_press_release'],
|
|
182
186
|
'has_documents': value['has_documents'],
|
|
183
187
|
'webcast_url': value['webcast_url'],
|
|
188
|
+
'video': EarningsCallsCalendar200ResponseEventsInnerVideoToJSON(value['video']),
|
|
184
189
|
'observations': value['observations'] == null ? undefined : (value['observations'].map(EarningsCallsEvents200ResponseEventsInnerObservationsInnerToJSON)),
|
|
185
190
|
};
|
|
186
191
|
}
|