@invinite-org/data-api-client 0.9.0 → 0.10.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 +0 -1
- package/dist/apis/EarningsCallsApi.d.ts +12 -12
- package/dist/apis/EarningsCallsApi.js +12 -12
- package/dist/esm/apis/EarningsCallsApi.d.ts +12 -12
- package/dist/esm/apis/EarningsCallsApi.js +12 -12
- package/dist/esm/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.d.ts +2 -8
- package/dist/esm/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.js +0 -4
- package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +1 -7
- package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.js +0 -4
- package/dist/esm/models/EarningsCallsDocuments200ResponseDocumentsInner.d.ts +1 -7
- package/dist/esm/models/EarningsCallsDocuments200ResponseDocumentsInner.js +0 -4
- package/dist/esm/models/EarningsCallsSearch200ResponseHitsInnerSlide.d.ts +1 -1
- package/dist/esm/models/EarningsCallsSlides200ResponseDeck.d.ts +1 -7
- package/dist/esm/models/EarningsCallsSlides200ResponseDeck.js +0 -4
- package/dist/esm/models/EarningsCallsSlides200ResponseSlidesInner.d.ts +1 -1
- package/dist/esm/models/EarningsCallsSlides200ResponseTimelineInner.d.ts +1 -1
- package/dist/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.d.ts +2 -8
- package/dist/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.js +0 -4
- package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +1 -7
- package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.js +0 -4
- package/dist/models/EarningsCallsDocuments200ResponseDocumentsInner.d.ts +1 -7
- package/dist/models/EarningsCallsDocuments200ResponseDocumentsInner.js +0 -4
- package/dist/models/EarningsCallsSearch200ResponseHitsInnerSlide.d.ts +1 -1
- package/dist/models/EarningsCallsSlides200ResponseDeck.d.ts +1 -7
- package/dist/models/EarningsCallsSlides200ResponseDeck.js +0 -4
- package/dist/models/EarningsCallsSlides200ResponseSlidesInner.d.ts +1 -1
- package/dist/models/EarningsCallsSlides200ResponseTimelineInner.d.ts +1 -1
- package/docs/EarningsCallsApi.md +6 -6
- package/docs/EarningsCallsCompanyDocuments200ResponseDocumentsInner.md +0 -2
- package/docs/EarningsCallsDocumentSearch200ResponseHitsInner.md +0 -2
- package/docs/EarningsCallsDocuments200ResponseDocumentsInner.md +0 -2
- package/docs/EarningsCallsSlides200ResponseDeck.md +0 -2
- package/package.json +1 -1
- package/src/apis/EarningsCallsApi.ts +12 -12
- package/src/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.ts +2 -11
- package/src/models/EarningsCallsDocumentSearch200ResponseHitsInner.ts +1 -10
- package/src/models/EarningsCallsDocuments200ResponseDocumentsInner.ts +1 -10
- package/src/models/EarningsCallsSearch200ResponseHitsInnerSlide.ts +1 -1
- package/src/models/EarningsCallsSlides200ResponseDeck.ts +1 -10
- package/src/models/EarningsCallsSlides200ResponseSlidesInner.ts +1 -1
- package/src/models/EarningsCallsSlides200ResponseTimelineInner.ts +1 -1
|
@@ -737,7 +737,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
737
737
|
}
|
|
738
738
|
|
|
739
739
|
/**
|
|
740
|
-
* One company document by `document_id` (from `/v1/earnings-calls/company-documents` or a document search hit with `table` `company_documents`):
|
|
740
|
+
* One company document by `document_id` (from `/v1/earnings-calls/company-documents` or a document search hit with `table` `company_documents`): permanent public URLs of the file and its per-page text. ### What you get - `include=pages` returns the per-page text inline when it is at most 2 MB (else only `pages_url`). - Company-published material, not verified facts. - Files are served as permanent public URLs (immutable; a new version is a new URL), never proxied; they do not expire. ### Errors - `503 media_unavailable` while the media base URL (`R2_PUBLIC_URL`) is not configured. ### 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; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. ### Changelog - 2026-11: media URLs are permanent public URLs; `expires_at` removed. Minimum tier for display: FREE.
|
|
741
741
|
* Company document by ID
|
|
742
742
|
*/
|
|
743
743
|
async earningsCallsCompanyDocumentRaw(requestParameters: EarningsCallsCompanyDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsCompanyDocument200Response>> {
|
|
@@ -748,7 +748,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
748
748
|
}
|
|
749
749
|
|
|
750
750
|
/**
|
|
751
|
-
* One company document by `document_id` (from `/v1/earnings-calls/company-documents` or a document search hit with `table` `company_documents`):
|
|
751
|
+
* One company document by `document_id` (from `/v1/earnings-calls/company-documents` or a document search hit with `table` `company_documents`): permanent public URLs of the file and its per-page text. ### What you get - `include=pages` returns the per-page text inline when it is at most 2 MB (else only `pages_url`). - Company-published material, not verified facts. - Files are served as permanent public URLs (immutable; a new version is a new URL), never proxied; they do not expire. ### Errors - `503 media_unavailable` while the media base URL (`R2_PUBLIC_URL`) is not configured. ### 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; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. ### Changelog - 2026-11: media URLs are permanent public URLs; `expires_at` removed. Minimum tier for display: FREE.
|
|
752
752
|
* Company document by ID
|
|
753
753
|
*/
|
|
754
754
|
async earningsCallsCompanyDocument(requestParameters: EarningsCallsCompanyDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsCompanyDocument200Response> {
|
|
@@ -843,7 +843,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
843
843
|
}
|
|
844
844
|
|
|
845
845
|
/**
|
|
846
|
-
* A company\'s investor-relations documents, newest year first: annual reports, proxy statements, ESG / governance documents, investor-day and conference decks, shareholder letters, fact sheets, and link-only webcast replay pages. By default the IR library outside its earnings calls\' folders; `include=calls` adds the documents of every earnings call (CFO commentary, data sheets, letters, the company\'s own transcript, prepared remarks, 10-Q / 10-K links) to the same list, marked `source: call` with the call\'s `event_id`, so one paged list holds the company\'s whole document tree. Filter by IR section, kind, year, period or event, or by the document tree: `category`, `group` (a folder and everything below it) and `fiscal_year` / `fiscal_quarter` (the earnings folder `earnings/fy<YYYY>/q<N>`). On a call document `year` / `period` are the call\'s fiscal year / quarter; a `section` filter matches IR-library rows only. Documents of one earnings call alone are on `/v1/earnings-calls/documents`; a call\'s press release and slide deck are on `/v1/earnings-calls/press-release` and `/v1/earnings-calls/slides`. A press release that is no call or event material is a news item: `GET /v1/news?publisher=320193`. ### Order and paging - Without `include`: newest year first, then IR section, kind and title. With `include=calls`: newest year first, then folder (`group`), kind, title and id, one total order over both sources, so `offset` pages never skip or repeat a document. ### The document tree Every stored document sits in one folder of the company\'s document tree: `group` (its path) under one of eight `category` spine folders, in this order: `earnings` (`earnings/fy2027/q2` = one fiscal quarter\'s call: release, deck, CFO commentary, data sheets, transcript; `earnings/cy2026/08-26` = a call without a fiscal period), `events` (`events/2026/09-10-<event>` = a conference, investor day or shareholder meeting; its `group_label` reads the event\'s date and name, e.g. \"May 18, 2025 · GTC Taipei 2025\"), `reports` (`reports/2025`: annual reports, proxy statements, annual letters), `presentations` (`presentations/2024`), `governance`, `esg` (`esg/2025`), `shareholder` (`shareholder/tax`, `shareholder/dividends`, `shareholder/stock`) and `other` (`other/faq`, `other/fact-sheets`, `other/financial-data[/2025]`, `other/web-pages`, `other/documents`). `…/undated` = no date could be read. `group` and `category` are null while a document has not been placed yet. A press release that is no call or event material is not a document: it is a news item, served by `GET /v1/news`. ### What you get - Company-published material: displayed as published, not verified facts. -
|
|
846
|
+
* A company\'s investor-relations documents, newest year first: annual reports, proxy statements, ESG / governance documents, investor-day and conference decks, shareholder letters, fact sheets, and link-only webcast replay pages. By default the IR library outside its earnings calls\' folders; `include=calls` adds the documents of every earnings call (CFO commentary, data sheets, letters, the company\'s own transcript, prepared remarks, 10-Q / 10-K links) to the same list, marked `source: call` with the call\'s `event_id`, so one paged list holds the company\'s whole document tree. Filter by IR section, kind, year, period or event, or by the document tree: `category`, `group` (a folder and everything below it) and `fiscal_year` / `fiscal_quarter` (the earnings folder `earnings/fy<YYYY>/q<N>`). On a call document `year` / `period` are the call\'s fiscal year / quarter; a `section` filter matches IR-library rows only. Documents of one earnings call alone are on `/v1/earnings-calls/documents`; a call\'s press release and slide deck are on `/v1/earnings-calls/press-release` and `/v1/earnings-calls/slides`. A press release that is no call or event material is a news item: `GET /v1/news?publisher=320193`. ### Order and paging - Without `include`: newest year first, then IR section, kind and title. With `include=calls`: newest year first, then folder (`group`), kind, title and id, one total order over both sources, so `offset` pages never skip or repeat a document. ### The document tree Every stored document sits in one folder of the company\'s document tree: `group` (its path) under one of eight `category` spine folders, in this order: `earnings` (`earnings/fy2027/q2` = one fiscal quarter\'s call: release, deck, CFO commentary, data sheets, transcript; `earnings/cy2026/08-26` = a call without a fiscal period), `events` (`events/2026/09-10-<event>` = a conference, investor day or shareholder meeting; its `group_label` reads the event\'s date and name, e.g. \"May 18, 2025 · GTC Taipei 2025\"), `reports` (`reports/2025`: annual reports, proxy statements, annual letters), `presentations` (`presentations/2024`), `governance`, `esg` (`esg/2025`), `shareholder` (`shareholder/tax`, `shareholder/dividends`, `shareholder/stock`) and `other` (`other/faq`, `other/fact-sheets`, `other/financial-data[/2025]`, `other/web-pages`, `other/documents`). `…/undated` = no date could be read. `group` and `category` are null while a document has not been placed yet. A press release that is no call or event material is not a document: it is a news item, served by `GET /v1/news`. ### What you get - Company-published material: displayed as published, not verified facts. - `pages_url` is the per-page text (JSON). A link-only row (webcast) has `url` null and `link_status`. - Files are served as permanent public URLs (immutable; a new version is a new URL), never proxied; they do not expire. ### Errors - `503 media_unavailable` while the media base URL (`R2_PUBLIC_URL`) is not configured. ### 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; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. ### Changelog - 2026-11: media URLs are permanent public URLs; `expires_at` removed. Minimum tier for display: FREE.
|
|
847
847
|
* Company documents
|
|
848
848
|
*/
|
|
849
849
|
async earningsCallsCompanyDocumentsRaw(requestParameters: EarningsCallsCompanyDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsCompanyDocuments200Response>> {
|
|
@@ -854,7 +854,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
854
854
|
}
|
|
855
855
|
|
|
856
856
|
/**
|
|
857
|
-
* A company\'s investor-relations documents, newest year first: annual reports, proxy statements, ESG / governance documents, investor-day and conference decks, shareholder letters, fact sheets, and link-only webcast replay pages. By default the IR library outside its earnings calls\' folders; `include=calls` adds the documents of every earnings call (CFO commentary, data sheets, letters, the company\'s own transcript, prepared remarks, 10-Q / 10-K links) to the same list, marked `source: call` with the call\'s `event_id`, so one paged list holds the company\'s whole document tree. Filter by IR section, kind, year, period or event, or by the document tree: `category`, `group` (a folder and everything below it) and `fiscal_year` / `fiscal_quarter` (the earnings folder `earnings/fy<YYYY>/q<N>`). On a call document `year` / `period` are the call\'s fiscal year / quarter; a `section` filter matches IR-library rows only. Documents of one earnings call alone are on `/v1/earnings-calls/documents`; a call\'s press release and slide deck are on `/v1/earnings-calls/press-release` and `/v1/earnings-calls/slides`. A press release that is no call or event material is a news item: `GET /v1/news?publisher=320193`. ### Order and paging - Without `include`: newest year first, then IR section, kind and title. With `include=calls`: newest year first, then folder (`group`), kind, title and id, one total order over both sources, so `offset` pages never skip or repeat a document. ### The document tree Every stored document sits in one folder of the company\'s document tree: `group` (its path) under one of eight `category` spine folders, in this order: `earnings` (`earnings/fy2027/q2` = one fiscal quarter\'s call: release, deck, CFO commentary, data sheets, transcript; `earnings/cy2026/08-26` = a call without a fiscal period), `events` (`events/2026/09-10-<event>` = a conference, investor day or shareholder meeting; its `group_label` reads the event\'s date and name, e.g. \"May 18, 2025 · GTC Taipei 2025\"), `reports` (`reports/2025`: annual reports, proxy statements, annual letters), `presentations` (`presentations/2024`), `governance`, `esg` (`esg/2025`), `shareholder` (`shareholder/tax`, `shareholder/dividends`, `shareholder/stock`) and `other` (`other/faq`, `other/fact-sheets`, `other/financial-data[/2025]`, `other/web-pages`, `other/documents`). `…/undated` = no date could be read. `group` and `category` are null while a document has not been placed yet. A press release that is no call or event material is not a document: it is a news item, served by `GET /v1/news`. ### What you get - Company-published material: displayed as published, not verified facts. -
|
|
857
|
+
* A company\'s investor-relations documents, newest year first: annual reports, proxy statements, ESG / governance documents, investor-day and conference decks, shareholder letters, fact sheets, and link-only webcast replay pages. By default the IR library outside its earnings calls\' folders; `include=calls` adds the documents of every earnings call (CFO commentary, data sheets, letters, the company\'s own transcript, prepared remarks, 10-Q / 10-K links) to the same list, marked `source: call` with the call\'s `event_id`, so one paged list holds the company\'s whole document tree. Filter by IR section, kind, year, period or event, or by the document tree: `category`, `group` (a folder and everything below it) and `fiscal_year` / `fiscal_quarter` (the earnings folder `earnings/fy<YYYY>/q<N>`). On a call document `year` / `period` are the call\'s fiscal year / quarter; a `section` filter matches IR-library rows only. Documents of one earnings call alone are on `/v1/earnings-calls/documents`; a call\'s press release and slide deck are on `/v1/earnings-calls/press-release` and `/v1/earnings-calls/slides`. A press release that is no call or event material is a news item: `GET /v1/news?publisher=320193`. ### Order and paging - Without `include`: newest year first, then IR section, kind and title. With `include=calls`: newest year first, then folder (`group`), kind, title and id, one total order over both sources, so `offset` pages never skip or repeat a document. ### The document tree Every stored document sits in one folder of the company\'s document tree: `group` (its path) under one of eight `category` spine folders, in this order: `earnings` (`earnings/fy2027/q2` = one fiscal quarter\'s call: release, deck, CFO commentary, data sheets, transcript; `earnings/cy2026/08-26` = a call without a fiscal period), `events` (`events/2026/09-10-<event>` = a conference, investor day or shareholder meeting; its `group_label` reads the event\'s date and name, e.g. \"May 18, 2025 · GTC Taipei 2025\"), `reports` (`reports/2025`: annual reports, proxy statements, annual letters), `presentations` (`presentations/2024`), `governance`, `esg` (`esg/2025`), `shareholder` (`shareholder/tax`, `shareholder/dividends`, `shareholder/stock`) and `other` (`other/faq`, `other/fact-sheets`, `other/financial-data[/2025]`, `other/web-pages`, `other/documents`). `…/undated` = no date could be read. `group` and `category` are null while a document has not been placed yet. A press release that is no call or event material is not a document: it is a news item, served by `GET /v1/news`. ### What you get - Company-published material: displayed as published, not verified facts. - `pages_url` is the per-page text (JSON). A link-only row (webcast) has `url` null and `link_status`. - Files are served as permanent public URLs (immutable; a new version is a new URL), never proxied; they do not expire. ### Errors - `503 media_unavailable` while the media base URL (`R2_PUBLIC_URL`) is not configured. ### 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; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. ### Changelog - 2026-11: media URLs are permanent public URLs; `expires_at` removed. Minimum tier for display: FREE.
|
|
858
858
|
* Company documents
|
|
859
859
|
*/
|
|
860
860
|
async earningsCallsCompanyDocuments(requestParameters: EarningsCallsCompanyDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsCompanyDocuments200Response> {
|
|
@@ -1008,7 +1008,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
1008
1008
|
}
|
|
1009
1009
|
|
|
1010
1010
|
/**
|
|
1011
|
-
* Search the page text of investor documents by keywords (default `mode=lexical`) or exact text (`literal`): 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
|
|
1011
|
+
* Search the page text of investor documents by keywords (default `mode=lexical`) or exact text (`literal`): 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 permanent public 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; every word must match; ranked by `ts_rank_cd` (`websearch_to_tsquery`). Without `identifier`, at most 5,000 matching passages are ranked, split evenly between earnings-call documents and IR-library documents (each the first matches in index order, not the best) — add `identifier` to rank every match of one company. 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. - `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`); `match.lexical_rank` is the hit\'s 1-based rank. Neither mode expands into fuzzy results. Both modes cost 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 `unknown` (nothing of the searched scope is indexed yet, or the counts could not be read) — read it before treating an empty list as \"not found\". - `coverage.lexical` counts the searched transcripts or documents in the text index (`indexed`, `pending`, `failed`). `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`, `lexical` null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`. - 2026-11: modes `semantic` and `hybrid` removed; vector search is gone, pass `mode=lexical` (default) or `literal`. - 2026-11: media URLs are permanent public URLs; `expires_at` removed. ### 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). - `503 search_unavailable` (a search over its time limit — never an empty answer) carries `Retry-After`. - `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; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. Minimum tier for display: FREE.
|
|
1012
1012
|
* Search investor documents
|
|
1013
1013
|
*/
|
|
1014
1014
|
async earningsCallsDocumentSearchRaw(requestParameters: EarningsCallsDocumentSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsDocumentSearch200Response>> {
|
|
@@ -1019,7 +1019,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
1019
1019
|
}
|
|
1020
1020
|
|
|
1021
1021
|
/**
|
|
1022
|
-
* Search the page text of investor documents by keywords (default `mode=lexical`) or exact text (`literal`): 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
|
|
1022
|
+
* Search the page text of investor documents by keywords (default `mode=lexical`) or exact text (`literal`): 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 permanent public 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; every word must match; ranked by `ts_rank_cd` (`websearch_to_tsquery`). Without `identifier`, at most 5,000 matching passages are ranked, split evenly between earnings-call documents and IR-library documents (each the first matches in index order, not the best) — add `identifier` to rank every match of one company. 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. - `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`); `match.lexical_rank` is the hit\'s 1-based rank. Neither mode expands into fuzzy results. Both modes cost 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 `unknown` (nothing of the searched scope is indexed yet, or the counts could not be read) — read it before treating an empty list as \"not found\". - `coverage.lexical` counts the searched transcripts or documents in the text index (`indexed`, `pending`, `failed`). `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`, `lexical` null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`. - 2026-11: modes `semantic` and `hybrid` removed; vector search is gone, pass `mode=lexical` (default) or `literal`. - 2026-11: media URLs are permanent public URLs; `expires_at` removed. ### 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). - `503 search_unavailable` (a search over its time limit — never an empty answer) carries `Retry-After`. - `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; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. Minimum tier for display: FREE.
|
|
1023
1023
|
* Search investor documents
|
|
1024
1024
|
*/
|
|
1025
1025
|
async earningsCallsDocumentSearch(requestParameters: EarningsCallsDocumentSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsDocumentSearch200Response> {
|
|
@@ -1103,7 +1103,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
1103
1103
|
}
|
|
1104
1104
|
|
|
1105
1105
|
/**
|
|
1106
|
-
* Further investor documents of one earnings call, ordered by kind: CFO commentary, financial data sheets, shareholder letters, fact sheets, the company\'s own transcript, its prepared remarks / call script, 10-Q / 10-K links. Infographics are stored as fact sheets. ### What you get -
|
|
1106
|
+
* Further investor documents of one earnings call, ordered by kind: CFO commentary, financial data sheets, shareholder letters, fact sheets, the company\'s own transcript, its prepared remarks / call script, 10-Q / 10-K links. Infographics are stored as fact sheets. ### What you get - Link-only rows (`sec_filing`) have `url` null and point to EDGAR through `source_url`. - Files are served as permanent public URLs (immutable; a new version is a new URL), never proxied; they do not expire. - Each document carries its `trust_tier` and its folder of the company\'s document tree (`group`, `group_label`, `category`; filter with `category` / `group`). A call\'s own files sit in its earnings folder, e.g. `earnings/fy2027/q2`. ### The document tree Every stored document sits in one folder of the company\'s document tree: `group` (its path) under one of eight `category` spine folders, in this order: `earnings` (`earnings/fy2027/q2` = one fiscal quarter\'s call: release, deck, CFO commentary, data sheets, transcript; `earnings/cy2026/08-26` = a call without a fiscal period), `events` (`events/2026/09-10-<event>` = a conference, investor day or shareholder meeting; its `group_label` reads the event\'s date and name, e.g. \"May 18, 2025 · GTC Taipei 2025\"), `reports` (`reports/2025`: annual reports, proxy statements, annual letters), `presentations` (`presentations/2024`), `governance`, `esg` (`esg/2025`), `shareholder` (`shareholder/tax`, `shareholder/dividends`, `shareholder/stock`) and `other` (`other/faq`, `other/fact-sheets`, `other/financial-data[/2025]`, `other/web-pages`, `other/documents`). `…/undated` = no date could be read. `group` and `category` are null while a document has not been placed yet. A press release that is no call or event material is not a document: it is a news item, served by `GET /v1/news`. - `documents` is `[]` for a call without further documents (`has_documents` tells ahead). ### Errors - `503 media_unavailable` while the media base URL (`R2_PUBLIC_URL`) 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; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. ### Changelog - 2026-11: media URLs are permanent public URLs; `expires_at` removed. Minimum tier for display: FREE.
|
|
1107
1107
|
* Earnings call documents
|
|
1108
1108
|
*/
|
|
1109
1109
|
async earningsCallsDocumentsRaw(requestParameters: EarningsCallsDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsDocuments200Response>> {
|
|
@@ -1114,7 +1114,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
1114
1114
|
}
|
|
1115
1115
|
|
|
1116
1116
|
/**
|
|
1117
|
-
* Further investor documents of one earnings call, ordered by kind: CFO commentary, financial data sheets, shareholder letters, fact sheets, the company\'s own transcript, its prepared remarks / call script, 10-Q / 10-K links. Infographics are stored as fact sheets. ### What you get -
|
|
1117
|
+
* Further investor documents of one earnings call, ordered by kind: CFO commentary, financial data sheets, shareholder letters, fact sheets, the company\'s own transcript, its prepared remarks / call script, 10-Q / 10-K links. Infographics are stored as fact sheets. ### What you get - Link-only rows (`sec_filing`) have `url` null and point to EDGAR through `source_url`. - Files are served as permanent public URLs (immutable; a new version is a new URL), never proxied; they do not expire. - Each document carries its `trust_tier` and its folder of the company\'s document tree (`group`, `group_label`, `category`; filter with `category` / `group`). A call\'s own files sit in its earnings folder, e.g. `earnings/fy2027/q2`. ### The document tree Every stored document sits in one folder of the company\'s document tree: `group` (its path) under one of eight `category` spine folders, in this order: `earnings` (`earnings/fy2027/q2` = one fiscal quarter\'s call: release, deck, CFO commentary, data sheets, transcript; `earnings/cy2026/08-26` = a call without a fiscal period), `events` (`events/2026/09-10-<event>` = a conference, investor day or shareholder meeting; its `group_label` reads the event\'s date and name, e.g. \"May 18, 2025 · GTC Taipei 2025\"), `reports` (`reports/2025`: annual reports, proxy statements, annual letters), `presentations` (`presentations/2024`), `governance`, `esg` (`esg/2025`), `shareholder` (`shareholder/tax`, `shareholder/dividends`, `shareholder/stock`) and `other` (`other/faq`, `other/fact-sheets`, `other/financial-data[/2025]`, `other/web-pages`, `other/documents`). `…/undated` = no date could be read. `group` and `category` are null while a document has not been placed yet. A press release that is no call or event material is not a document: it is a news item, served by `GET /v1/news`. - `documents` is `[]` for a call without further documents (`has_documents` tells ahead). ### Errors - `503 media_unavailable` while the media base URL (`R2_PUBLIC_URL`) 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; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. ### Changelog - 2026-11: media URLs are permanent public URLs; `expires_at` removed. Minimum tier for display: FREE.
|
|
1118
1118
|
* Earnings call documents
|
|
1119
1119
|
*/
|
|
1120
1120
|
async earningsCallsDocuments(requestParameters: EarningsCallsDocumentsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsDocuments200Response> {
|
|
@@ -2141,7 +2141,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
2141
2141
|
}
|
|
2142
2142
|
|
|
2143
2143
|
/**
|
|
2144
|
-
* \"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`) or exact text (`literal`) — 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
|
|
2144
|
+
* \"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`) or exact text (`literal`) — 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 permanent public 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; scoped by `identifier` or `event_id`, a passage needs any of the words, ranked by BM25 (rarer words weigh more), and the answer to a matching analyst question follows right after it (its `match.spans` may be empty); without a scope every word must match, 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. - `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`); `match.lexical_rank` is the hit\'s 1-based rank. Neither mode expands into fuzzy results. Both modes cost 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 `unknown` (nothing of the searched scope is indexed yet, or the counts could not be read) — read it before treating an empty list as \"not found\". - `coverage.lexical` counts the searched transcripts or documents in the text index (`indexed`, `pending`, `failed`). `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`, `lexical` null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`. - 2026-11: modes `semantic` and `hybrid` removed; vector search is gone, pass `mode=lexical` (default) or `literal`. - 2026-11: `slide.image_url` is a permanent public URL (was a short-lived signed URL). ### 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). - `503 search_unavailable` (a search over its time limit — never an empty answer) carries `Retry-After`. - `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; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. Minimum tier for rag: STANDARD.
|
|
2145
2145
|
* Search earnings calls
|
|
2146
2146
|
*/
|
|
2147
2147
|
async earningsCallsSearchRaw(requestParameters: EarningsCallsSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsSearch200Response>> {
|
|
@@ -2152,7 +2152,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
2152
2152
|
}
|
|
2153
2153
|
|
|
2154
2154
|
/**
|
|
2155
|
-
* \"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`) or exact text (`literal`) — 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
|
|
2155
|
+
* \"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`) or exact text (`literal`) — 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 permanent public 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; scoped by `identifier` or `event_id`, a passage needs any of the words, ranked by BM25 (rarer words weigh more), and the answer to a matching analyst question follows right after it (its `match.spans` may be empty); without a scope every word must match, 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. - `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`); `match.lexical_rank` is the hit\'s 1-based rank. Neither mode expands into fuzzy results. Both modes cost 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 `unknown` (nothing of the searched scope is indexed yet, or the counts could not be read) — read it before treating an empty list as \"not found\". - `coverage.lexical` counts the searched transcripts or documents in the text index (`indexed`, `pending`, `failed`). `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`, `lexical` null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`. - 2026-11: modes `semantic` and `hybrid` removed; vector search is gone, pass `mode=lexical` (default) or `literal`. - 2026-11: `slide.image_url` is a permanent public URL (was a short-lived signed URL). ### 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). - `503 search_unavailable` (a search over its time limit — never an empty answer) carries `Retry-After`. - `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; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. Minimum tier for rag: STANDARD.
|
|
2156
2156
|
* Search earnings calls
|
|
2157
2157
|
*/
|
|
2158
2158
|
async earningsCallsSearch(requestParameters: EarningsCallsSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsSearch200Response> {
|
|
@@ -2220,7 +2220,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
2220
2220
|
}
|
|
2221
2221
|
|
|
2222
2222
|
/**
|
|
2223
|
-
* The slide deck of one earnings call (PRO): the deck PDF and each page image as
|
|
2223
|
+
* The slide deck of one earnings call (PRO): the deck PDF and each page image as permanent public URLs, page titles and, with `include=markdown`, each page\'s text. ### Files - Files are served as permanent public URLs (immutable; a new version is a new URL), never proxied; they do not expire. - `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 the media base URL (`R2_PUBLIC_URL`) 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; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. ### Changelog - 2026-11: media URLs are permanent public URLs; `expires_at` removed. Minimum tier for display: FREE.
|
|
2224
2224
|
* Earnings call slides
|
|
2225
2225
|
*/
|
|
2226
2226
|
async earningsCallsSlidesRaw(requestParameters: EarningsCallsSlidesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsSlides200Response>> {
|
|
@@ -2231,7 +2231,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
2231
2231
|
}
|
|
2232
2232
|
|
|
2233
2233
|
/**
|
|
2234
|
-
* The slide deck of one earnings call (PRO): the deck PDF and each page image as
|
|
2234
|
+
* The slide deck of one earnings call (PRO): the deck PDF and each page image as permanent public URLs, page titles and, with `include=markdown`, each page\'s text. ### Files - Files are served as permanent public URLs (immutable; a new version is a new URL), never proxied; they do not expire. - `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 the media base URL (`R2_PUBLIC_URL`) 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; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. ### Changelog - 2026-11: media URLs are permanent public URLs; `expires_at` removed. Minimum tier for display: FREE.
|
|
2235
2235
|
* Earnings call slides
|
|
2236
2236
|
*/
|
|
2237
2237
|
async earningsCallsSlides(requestParameters: EarningsCallsSlidesRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsSlides200Response> {
|
|
@@ -164,23 +164,17 @@ export interface EarningsCallsCompanyDocuments200ResponseDocumentsInner {
|
|
|
164
164
|
*/
|
|
165
165
|
link_status: EarningsCallsCompanyDocuments200ResponseDocumentsInnerLinkStatusEnum | null;
|
|
166
166
|
/**
|
|
167
|
-
*
|
|
167
|
+
* Permanent public download URL; null for a link-only row (use source_url)
|
|
168
168
|
* @type {string}
|
|
169
169
|
* @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
|
|
170
170
|
*/
|
|
171
171
|
url: string | null;
|
|
172
172
|
/**
|
|
173
|
-
*
|
|
173
|
+
* Permanent public URL of the per-page text (JSON); null before the text was extracted
|
|
174
174
|
* @type {string}
|
|
175
175
|
* @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
|
|
176
176
|
*/
|
|
177
177
|
pages_url: string | null;
|
|
178
|
-
/**
|
|
179
|
-
* When the signed URLs stop working
|
|
180
|
-
* @type {Date}
|
|
181
|
-
* @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
|
|
182
|
-
*/
|
|
183
|
-
expires_at: Date | null;
|
|
184
178
|
/**
|
|
185
179
|
* When we first stored the document
|
|
186
180
|
* @type {Date}
|
|
@@ -380,7 +374,6 @@ export function instanceOfEarningsCallsCompanyDocuments200ResponseDocumentsInner
|
|
|
380
374
|
if (!('link_status' in value) || value['link_status'] === undefined) return false;
|
|
381
375
|
if (!('url' in value) || value['url'] === undefined) return false;
|
|
382
376
|
if (!('pages_url' in value) || value['pages_url'] === undefined) return false;
|
|
383
|
-
if (!('expires_at' in value) || value['expires_at'] === undefined) return false;
|
|
384
377
|
if (!('created_at' in value) || value['created_at'] === undefined) return false;
|
|
385
378
|
if (!('updated_at' in value) || value['updated_at'] === undefined) return false;
|
|
386
379
|
return true;
|
|
@@ -422,7 +415,6 @@ export function EarningsCallsCompanyDocuments200ResponseDocumentsInnerFromJSONTy
|
|
|
422
415
|
'link_status': json['link_status'],
|
|
423
416
|
'url': json['url'],
|
|
424
417
|
'pages_url': json['pages_url'],
|
|
425
|
-
'expires_at': (json['expires_at'] == null ? null : new Date(json['expires_at'])),
|
|
426
418
|
'created_at': (new Date(json['created_at'])),
|
|
427
419
|
'updated_at': (new Date(json['updated_at'])),
|
|
428
420
|
'pages_json': json['pages_json'] == null ? undefined : json['pages_json'],
|
|
@@ -466,7 +458,6 @@ export function EarningsCallsCompanyDocuments200ResponseDocumentsInnerToJSONType
|
|
|
466
458
|
'link_status': value['link_status'],
|
|
467
459
|
'url': value['url'],
|
|
468
460
|
'pages_url': value['pages_url'],
|
|
469
|
-
'expires_at': value['expires_at'] == null ? value['expires_at'] : value['expires_at'].toISOString(),
|
|
470
461
|
'created_at': value['created_at'].toISOString(),
|
|
471
462
|
'updated_at': value['updated_at'].toISOString(),
|
|
472
463
|
'pages_json': value['pages_json'],
|
|
@@ -148,17 +148,11 @@ export interface EarningsCallsDocumentSearch200ResponseHitsInner {
|
|
|
148
148
|
*/
|
|
149
149
|
category: EarningsCallsDocumentSearch200ResponseHitsInnerCategoryEnum | null;
|
|
150
150
|
/**
|
|
151
|
-
*
|
|
151
|
+
* Permanent public URL of the stored file; null for a link-only row
|
|
152
152
|
* @type {string}
|
|
153
153
|
* @memberof EarningsCallsDocumentSearch200ResponseHitsInner
|
|
154
154
|
*/
|
|
155
155
|
url: string | null;
|
|
156
|
-
/**
|
|
157
|
-
* When url stops working
|
|
158
|
-
* @type {Date}
|
|
159
|
-
* @memberof EarningsCallsDocumentSearch200ResponseHitsInner
|
|
160
|
-
*/
|
|
161
|
-
expires_at: Date | null;
|
|
162
156
|
}
|
|
163
157
|
|
|
164
158
|
|
|
@@ -212,7 +206,6 @@ export function instanceOfEarningsCallsDocumentSearch200ResponseHitsInner(value:
|
|
|
212
206
|
if (!('group_label' in value) || value['group_label'] === undefined) return false;
|
|
213
207
|
if (!('category' in value) || value['category'] === undefined) return false;
|
|
214
208
|
if (!('url' in value) || value['url'] === undefined) return false;
|
|
215
|
-
if (!('expires_at' in value) || value['expires_at'] === undefined) return false;
|
|
216
209
|
return true;
|
|
217
210
|
}
|
|
218
211
|
|
|
@@ -247,7 +240,6 @@ export function EarningsCallsDocumentSearch200ResponseHitsInnerFromJSONTyped(jso
|
|
|
247
240
|
'group_label': json['group_label'],
|
|
248
241
|
'category': json['category'],
|
|
249
242
|
'url': json['url'],
|
|
250
|
-
'expires_at': (json['expires_at'] == null ? null : new Date(json['expires_at'])),
|
|
251
243
|
};
|
|
252
244
|
}
|
|
253
245
|
|
|
@@ -283,7 +275,6 @@ export function EarningsCallsDocumentSearch200ResponseHitsInnerToJSONTyped(value
|
|
|
283
275
|
'group_label': value['group_label'],
|
|
284
276
|
'category': value['category'],
|
|
285
277
|
'url': value['url'],
|
|
286
|
-
'expires_at': value['expires_at'] == null ? value['expires_at'] : value['expires_at'].toISOString(),
|
|
287
278
|
};
|
|
288
279
|
}
|
|
289
280
|
|
|
@@ -74,17 +74,11 @@ export interface EarningsCallsDocuments200ResponseDocumentsInner {
|
|
|
74
74
|
*/
|
|
75
75
|
accession_number: string | null;
|
|
76
76
|
/**
|
|
77
|
-
*
|
|
77
|
+
* Permanent public download URL; null for link-only rows (sec_filing) or a failed download: use source_url
|
|
78
78
|
* @type {string}
|
|
79
79
|
* @memberof EarningsCallsDocuments200ResponseDocumentsInner
|
|
80
80
|
*/
|
|
81
81
|
url: string | null;
|
|
82
|
-
/**
|
|
83
|
-
* When url stops working
|
|
84
|
-
* @type {Date}
|
|
85
|
-
* @memberof EarningsCallsDocuments200ResponseDocumentsInner
|
|
86
|
-
*/
|
|
87
|
-
expires_at: Date | null;
|
|
88
82
|
/**
|
|
89
83
|
* MIME type
|
|
90
84
|
* @type {string}
|
|
@@ -220,7 +214,6 @@ export function instanceOfEarningsCallsDocuments200ResponseDocumentsInner(value:
|
|
|
220
214
|
if (!('source_url' in value) || value['source_url'] === undefined) return false;
|
|
221
215
|
if (!('accession_number' in value) || value['accession_number'] === undefined) return false;
|
|
222
216
|
if (!('url' in value) || value['url'] === undefined) return false;
|
|
223
|
-
if (!('expires_at' in value) || value['expires_at'] === undefined) return false;
|
|
224
217
|
if (!('content_type' in value) || value['content_type'] === undefined) return false;
|
|
225
218
|
if (!('bytes' in value) || value['bytes'] === undefined) return false;
|
|
226
219
|
if (!('pages' in value) || value['pages'] === undefined) return false;
|
|
@@ -251,7 +244,6 @@ export function EarningsCallsDocuments200ResponseDocumentsInnerFromJSONTyped(jso
|
|
|
251
244
|
'source_url': json['source_url'],
|
|
252
245
|
'accession_number': json['accession_number'],
|
|
253
246
|
'url': json['url'],
|
|
254
|
-
'expires_at': (json['expires_at'] == null ? null : new Date(json['expires_at'])),
|
|
255
247
|
'content_type': json['content_type'],
|
|
256
248
|
'bytes': json['bytes'],
|
|
257
249
|
'pages': json['pages'],
|
|
@@ -284,7 +276,6 @@ export function EarningsCallsDocuments200ResponseDocumentsInnerToJSONTyped(value
|
|
|
284
276
|
'source_url': value['source_url'],
|
|
285
277
|
'accession_number': value['accession_number'],
|
|
286
278
|
'url': value['url'],
|
|
287
|
-
'expires_at': value['expires_at'] == null ? value['expires_at'] : value['expires_at'].toISOString(),
|
|
288
279
|
'content_type': value['content_type'],
|
|
289
280
|
'bytes': value['bytes'],
|
|
290
281
|
'pages': value['pages'],
|
|
@@ -26,7 +26,7 @@ export interface EarningsCallsSearch200ResponseHitsInnerSlide {
|
|
|
26
26
|
*/
|
|
27
27
|
page: number;
|
|
28
28
|
/**
|
|
29
|
-
*
|
|
29
|
+
* Permanent public page image URL; null without the PRO plan or without an image
|
|
30
30
|
* @type {string}
|
|
31
31
|
* @memberof EarningsCallsSearch200ResponseHitsInnerSlide
|
|
32
32
|
*/
|
|
@@ -20,17 +20,11 @@ import { mapValues } from '../runtime';
|
|
|
20
20
|
*/
|
|
21
21
|
export interface EarningsCallsSlides200ResponseDeck {
|
|
22
22
|
/**
|
|
23
|
-
*
|
|
23
|
+
* Permanent public URL of the deck PDF
|
|
24
24
|
* @type {string}
|
|
25
25
|
* @memberof EarningsCallsSlides200ResponseDeck
|
|
26
26
|
*/
|
|
27
27
|
url: string;
|
|
28
|
-
/**
|
|
29
|
-
* When the signed URL stops working
|
|
30
|
-
* @type {Date}
|
|
31
|
-
* @memberof EarningsCallsSlides200ResponseDeck
|
|
32
|
-
*/
|
|
33
|
-
expires_at: Date;
|
|
34
28
|
/**
|
|
35
29
|
* Page count; null = unknown
|
|
36
30
|
* @type {number}
|
|
@@ -76,7 +70,6 @@ export type EarningsCallsSlides200ResponseDeckTrustTierEnum = typeof EarningsCal
|
|
|
76
70
|
*/
|
|
77
71
|
export function instanceOfEarningsCallsSlides200ResponseDeck(value: object): value is EarningsCallsSlides200ResponseDeck {
|
|
78
72
|
if (!('url' in value) || value['url'] === undefined) return false;
|
|
79
|
-
if (!('expires_at' in value) || value['expires_at'] === undefined) return false;
|
|
80
73
|
if (!('pages' in value) || value['pages'] === undefined) return false;
|
|
81
74
|
if (!('origin' in value) || value['origin'] === undefined) return false;
|
|
82
75
|
if (!('source_url' in value) || value['source_url'] === undefined) return false;
|
|
@@ -95,7 +88,6 @@ export function EarningsCallsSlides200ResponseDeckFromJSONTyped(json: any, ignor
|
|
|
95
88
|
return {
|
|
96
89
|
|
|
97
90
|
'url': json['url'],
|
|
98
|
-
'expires_at': (new Date(json['expires_at'])),
|
|
99
91
|
'pages': json['pages'],
|
|
100
92
|
'origin': json['origin'],
|
|
101
93
|
'source_url': json['source_url'],
|
|
@@ -115,7 +107,6 @@ export function EarningsCallsSlides200ResponseDeckToJSONTyped(value?: EarningsCa
|
|
|
115
107
|
return {
|
|
116
108
|
|
|
117
109
|
'url': value['url'],
|
|
118
|
-
'expires_at': value['expires_at'].toISOString(),
|
|
119
110
|
'pages': value['pages'],
|
|
120
111
|
'origin': value['origin'],
|
|
121
112
|
'source_url': value['source_url'],
|
|
@@ -32,7 +32,7 @@ export interface EarningsCallsSlides200ResponseSlidesInner {
|
|
|
32
32
|
*/
|
|
33
33
|
title: string | null;
|
|
34
34
|
/**
|
|
35
|
-
*
|
|
35
|
+
* Permanent public URL of the page image
|
|
36
36
|
* @type {string}
|
|
37
37
|
* @memberof EarningsCallsSlides200ResponseSlidesInner
|
|
38
38
|
*/
|
|
@@ -26,7 +26,7 @@ export interface EarningsCallsSlides200ResponseTimelineInner {
|
|
|
26
26
|
*/
|
|
27
27
|
at_ms: number;
|
|
28
28
|
/**
|
|
29
|
-
*
|
|
29
|
+
* Permanent public URL of the slide screenshot
|
|
30
30
|
* @type {string}
|
|
31
31
|
* @memberof EarningsCallsSlides200ResponseTimelineInner
|
|
32
32
|
*/
|