@invinite-org/data-api-client 0.1.0 → 0.2.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 +20 -6
- package/dist/apis/EarningsCallsApi.js +34 -7
- package/dist/esm/apis/EarningsCallsApi.d.ts +20 -6
- package/dist/esm/apis/EarningsCallsApi.js +33 -6
- package/dist/esm/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.d.ts +59 -5
- package/dist/esm/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.js +46 -2
- package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +32 -0
- package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.js +25 -0
- package/dist/esm/models/EarningsCallsDocuments200ResponseDocumentsInner.d.ts +32 -0
- package/dist/esm/models/EarningsCallsDocuments200ResponseDocumentsInner.js +25 -0
- package/dist/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.d.ts +59 -5
- package/dist/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.js +47 -3
- package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +32 -0
- package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.js +26 -1
- package/dist/models/EarningsCallsDocuments200ResponseDocumentsInner.d.ts +32 -0
- package/dist/models/EarningsCallsDocuments200ResponseDocumentsInner.js +26 -1
- package/docs/AccountApi.md +1 -1
- package/docs/AsReportedBalanceSheetApi.md +16 -16
- package/docs/AsReportedCashFlowStatementApi.md +16 -16
- package/docs/AsReportedIncomeStatementApi.md +16 -16
- package/docs/AsReportedSnapshotApi.md +13 -13
- package/docs/CompanyApi.md +18 -18
- package/docs/EarningsCallsApi.md +210 -189
- package/docs/EarningsCallsCompanyDocuments200ResponseDocumentsInner.md +8 -0
- package/docs/EarningsCallsDocumentSearch200ResponseHitsInner.md +6 -0
- package/docs/EarningsCallsDocuments200ResponseDocumentsInner.md +6 -0
- package/docs/FinancialMetricsApi.md +17 -17
- package/docs/IPOsApi.md +5 -5
- package/docs/InsiderTradesApi.md +7 -7
- package/docs/InstitutionalOwnershipApi.md +23 -23
- package/docs/MarketApi.md +3 -3
- package/docs/SECFilingsApi.md +15 -15
- package/docs/SegmentedFinancialsApi.md +12 -12
- package/docs/StandardizedBalanceSheetApi.md +16 -16
- package/docs/StandardizedCashFlowStatementApi.md +16 -16
- package/docs/StandardizedIncomeStatementApi.md +16 -16
- package/docs/StandardizedSnapshotApi.md +13 -13
- package/package.json +4 -4
- package/src/apis/EarningsCallsApi.ts +48 -6
- package/src/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.ts +75 -7
- package/src/models/EarningsCallsDocumentSearch200ResponseHitsInner.ts +42 -0
- package/src/models/EarningsCallsDocuments200ResponseDocumentsInner.ts +42 -0
|
@@ -37,13 +37,13 @@ async function example() {
|
|
|
37
37
|
|
|
38
38
|
const body = {
|
|
39
39
|
// string | Comma-separated list of ticker symbols or CIKs (1-10 identifiers)
|
|
40
|
-
identifiers:
|
|
40
|
+
identifiers: AAPL,MSFT,
|
|
41
41
|
// 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
|
|
42
|
-
fiscalPeriodType:
|
|
42
|
+
fiscalPeriodType: annual,
|
|
43
43
|
// number | Calendar year. For annual periods, only calendar_year is needed. For non-annual periods, must be provided together with calendar_quarter. (optional)
|
|
44
|
-
calendarYear:
|
|
44
|
+
calendarYear: 2024,
|
|
45
45
|
// number | Calendar quarter (1-4). For annual periods, should not be provided. For non-annual periods, must be provided together with calendar_year. (optional)
|
|
46
|
-
calendarQuarter:
|
|
46
|
+
calendarQuarter: 4,
|
|
47
47
|
} satisfies StandardizedSnapshotRequest;
|
|
48
48
|
|
|
49
49
|
try {
|
|
@@ -121,15 +121,15 @@ async function example() {
|
|
|
121
121
|
|
|
122
122
|
const body = {
|
|
123
123
|
// string | Comma-separated list of ticker symbols or CIKs (1-10 identifiers)
|
|
124
|
-
identifiers:
|
|
124
|
+
identifiers: AAPL,MSFT,
|
|
125
125
|
// 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
|
|
126
|
-
fiscalPeriodType:
|
|
126
|
+
fiscalPeriodType: annual,
|
|
127
127
|
// number | Calendar year. For annual periods, only calendar_year is needed. For non-annual periods, must be provided together with calendar_quarter. (optional)
|
|
128
|
-
calendarYear:
|
|
128
|
+
calendarYear: 2024,
|
|
129
129
|
// number | Calendar quarter (1-4). For annual periods, should not be provided. For non-annual periods, must be provided together with calendar_year. (optional)
|
|
130
|
-
calendarQuarter:
|
|
130
|
+
calendarQuarter: 4,
|
|
131
131
|
// 'true' | 'false' | Include formula in response (optional)
|
|
132
|
-
withFormula:
|
|
132
|
+
withFormula: true,
|
|
133
133
|
} satisfies StandardizedSnapshotDetailedRequest;
|
|
134
134
|
|
|
135
135
|
try {
|
|
@@ -208,13 +208,13 @@ async function example() {
|
|
|
208
208
|
|
|
209
209
|
const body = {
|
|
210
210
|
// string | Comma-separated list of ticker symbols or CIKs (1-10 identifiers)
|
|
211
|
-
identifiers:
|
|
211
|
+
identifiers: AAPL,MSFT,
|
|
212
212
|
// 'quarterly' | 'annual' | 'ytd' | 'ttm' | Type of fiscal period
|
|
213
|
-
fiscalPeriodType:
|
|
213
|
+
fiscalPeriodType: annual,
|
|
214
214
|
// number | Calendar year. For annual periods, only calendar_year is needed. For non-annual periods, must be provided together with calendar_quarter. (optional)
|
|
215
|
-
calendarYear:
|
|
215
|
+
calendarYear: 2024,
|
|
216
216
|
// number | Calendar quarter (1-4). For annual periods, should not be provided. For non-annual periods, must be provided together with calendar_year. (optional)
|
|
217
|
-
calendarQuarter:
|
|
217
|
+
calendarQuarter: 4,
|
|
218
218
|
} satisfies StandardizedSnapshotPresentationRequest;
|
|
219
219
|
|
|
220
220
|
try {
|
package/package.json
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@invinite-org/data-api-client",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"description": "Typed TypeScript/JavaScript client for the Invinite Data API",
|
|
5
5
|
"author": "OpenAPI-Generator",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
8
|
-
"url": "git+https://github.com/outraday-org/invinite.git"
|
|
8
|
+
"url": "git+https://github.com/outraday-org/invinite-data-api.git"
|
|
9
9
|
},
|
|
10
10
|
"main": "./dist/index.js",
|
|
11
11
|
"types": "./dist/index.d.ts",
|
|
@@ -16,11 +16,11 @@
|
|
|
16
16
|
"prepare": "npm run build"
|
|
17
17
|
},
|
|
18
18
|
"devDependencies": {
|
|
19
|
-
"typescript": "
|
|
19
|
+
"typescript": "5.9.3"
|
|
20
20
|
},
|
|
21
21
|
"homepage": "https://data.invinite.com/docs/sdks",
|
|
22
22
|
"license": "MIT",
|
|
23
23
|
"bugs": {
|
|
24
|
-
"url": "https://github.com/outraday-org/invinite/issues"
|
|
24
|
+
"url": "https://github.com/outraday-org/invinite-data-api/issues"
|
|
25
25
|
}
|
|
26
26
|
}
|
|
@@ -238,6 +238,11 @@ export interface EarningsCallsCompanyDocumentsRequest {
|
|
|
238
238
|
year?: number;
|
|
239
239
|
period?: EarningsCallsCompanyDocumentsPeriodEnum;
|
|
240
240
|
eventId?: string;
|
|
241
|
+
category?: Array<string>;
|
|
242
|
+
group?: string;
|
|
243
|
+
fiscalYear?: number;
|
|
244
|
+
fiscalQuarter?: number;
|
|
245
|
+
include?: Array<EarningsCallsCompanyDocumentsIncludeEnum>;
|
|
241
246
|
limit?: number;
|
|
242
247
|
offset?: number;
|
|
243
248
|
}
|
|
@@ -270,6 +275,8 @@ export interface EarningsCallsDocumentsRequest {
|
|
|
270
275
|
date?: Date;
|
|
271
276
|
eventType?: EarningsCallsDocumentsEventTypeEnum;
|
|
272
277
|
kind?: Array<string>;
|
|
278
|
+
category?: Array<string>;
|
|
279
|
+
group?: string;
|
|
273
280
|
include?: Array<string>;
|
|
274
281
|
limit?: number;
|
|
275
282
|
offset?: number;
|
|
@@ -787,6 +794,26 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
787
794
|
queryParameters['event_id'] = requestParameters['eventId'];
|
|
788
795
|
}
|
|
789
796
|
|
|
797
|
+
if (requestParameters['category'] != null) {
|
|
798
|
+
queryParameters['category'] = requestParameters['category'];
|
|
799
|
+
}
|
|
800
|
+
|
|
801
|
+
if (requestParameters['group'] != null) {
|
|
802
|
+
queryParameters['group'] = requestParameters['group'];
|
|
803
|
+
}
|
|
804
|
+
|
|
805
|
+
if (requestParameters['fiscalYear'] != null) {
|
|
806
|
+
queryParameters['fiscal_year'] = requestParameters['fiscalYear'];
|
|
807
|
+
}
|
|
808
|
+
|
|
809
|
+
if (requestParameters['fiscalQuarter'] != null) {
|
|
810
|
+
queryParameters['fiscal_quarter'] = requestParameters['fiscalQuarter'];
|
|
811
|
+
}
|
|
812
|
+
|
|
813
|
+
if (requestParameters['include'] != null) {
|
|
814
|
+
queryParameters['include'] = requestParameters['include'];
|
|
815
|
+
}
|
|
816
|
+
|
|
790
817
|
if (requestParameters['limit'] != null) {
|
|
791
818
|
queryParameters['limit'] = requestParameters['limit'];
|
|
792
819
|
}
|
|
@@ -817,7 +844,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
817
844
|
}
|
|
818
845
|
|
|
819
846
|
/**
|
|
820
|
-
* A company\'s investor-relations documents
|
|
847
|
+
* 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`. ### 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), `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. ### What you get - Company-published material: displayed as published, not verified facts. - Stored files come as signed URLs; `pages_url` is the per-page text (JSON). A link-only row (webcast) has `url` null and `link_status`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. ### Errors - `503 media_unavailable` while media signing 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. Minimum tier for display: FREE.
|
|
821
848
|
* Company documents
|
|
822
849
|
*/
|
|
823
850
|
async earningsCallsCompanyDocumentsRaw(requestParameters: EarningsCallsCompanyDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsCompanyDocuments200Response>> {
|
|
@@ -828,7 +855,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
828
855
|
}
|
|
829
856
|
|
|
830
857
|
/**
|
|
831
|
-
* A company\'s investor-relations documents
|
|
858
|
+
* 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`. ### 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), `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. ### What you get - Company-published material: displayed as published, not verified facts. - Stored files come as signed URLs; `pages_url` is the per-page text (JSON). A link-only row (webcast) has `url` null and `link_status`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. ### Errors - `503 media_unavailable` while media signing 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. Minimum tier for display: FREE.
|
|
832
859
|
* Company documents
|
|
833
860
|
*/
|
|
834
861
|
async earningsCallsCompanyDocuments(requestParameters: EarningsCallsCompanyDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsCompanyDocuments200Response> {
|
|
@@ -974,7 +1001,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
974
1001
|
}
|
|
975
1002
|
|
|
976
1003
|
/**
|
|
977
|
-
* Semantic search over the page text of investor documents: 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. ### Errors - `429 upstream_rate_limited` and `503 search_unavailable` carry `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. Minimum tier for display: FREE.
|
|
1004
|
+
* Semantic search over the page text of investor documents: 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`). ### Errors - `429 upstream_rate_limited` and `503 search_unavailable` carry `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. Minimum tier for display: FREE.
|
|
978
1005
|
* Search investor documents
|
|
979
1006
|
*/
|
|
980
1007
|
async earningsCallsDocumentSearchRaw(requestParameters: EarningsCallsDocumentSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsDocumentSearch200Response>> {
|
|
@@ -985,7 +1012,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
985
1012
|
}
|
|
986
1013
|
|
|
987
1014
|
/**
|
|
988
|
-
* Semantic search over the page text of investor documents: 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. ### Errors - `429 upstream_rate_limited` and `503 search_unavailable` carry `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. Minimum tier for display: FREE.
|
|
1015
|
+
* Semantic search over the page text of investor documents: 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`). ### Errors - `429 upstream_rate_limited` and `503 search_unavailable` carry `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. Minimum tier for display: FREE.
|
|
989
1016
|
* Search investor documents
|
|
990
1017
|
*/
|
|
991
1018
|
async earningsCallsDocumentSearch(requestParameters: EarningsCallsDocumentSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsDocumentSearch200Response> {
|
|
@@ -1027,6 +1054,14 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
1027
1054
|
queryParameters['kind'] = requestParameters['kind'];
|
|
1028
1055
|
}
|
|
1029
1056
|
|
|
1057
|
+
if (requestParameters['category'] != null) {
|
|
1058
|
+
queryParameters['category'] = requestParameters['category'];
|
|
1059
|
+
}
|
|
1060
|
+
|
|
1061
|
+
if (requestParameters['group'] != null) {
|
|
1062
|
+
queryParameters['group'] = requestParameters['group'];
|
|
1063
|
+
}
|
|
1064
|
+
|
|
1030
1065
|
if (requestParameters['include'] != null) {
|
|
1031
1066
|
queryParameters['include'] = requestParameters['include'];
|
|
1032
1067
|
}
|
|
@@ -1061,7 +1096,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
1061
1096
|
}
|
|
1062
1097
|
|
|
1063
1098
|
/**
|
|
1064
|
-
* 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 - Stored files come as signed URLs; link-only rows (`sec_filing`) have `url` null and point to EDGAR through `source_url`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. - Each document carries its `trust_tier`. - `documents` is `[]` for a call without further documents (`has_documents` tells ahead). ### Errors - `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.
|
|
1099
|
+
* 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 - Stored files come as signed URLs; link-only rows (`sec_filing`) have `url` null and point to EDGAR through `source_url`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. - 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), `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. - `documents` is `[]` for a call without further documents (`has_documents` tells ahead). ### Errors - `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.
|
|
1065
1100
|
* Earnings call documents
|
|
1066
1101
|
*/
|
|
1067
1102
|
async earningsCallsDocumentsRaw(requestParameters: EarningsCallsDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsDocuments200Response>> {
|
|
@@ -1072,7 +1107,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
1072
1107
|
}
|
|
1073
1108
|
|
|
1074
1109
|
/**
|
|
1075
|
-
* 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 - Stored files come as signed URLs; link-only rows (`sec_filing`) have `url` null and point to EDGAR through `source_url`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. - Each document carries its `trust_tier`. - `documents` is `[]` for a call without further documents (`has_documents` tells ahead). ### Errors - `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.
|
|
1110
|
+
* 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 - Stored files come as signed URLs; link-only rows (`sec_filing`) have `url` null and point to EDGAR through `source_url`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. - 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), `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. - `documents` is `[]` for a call without further documents (`has_documents` tells ahead). ### Errors - `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.
|
|
1076
1111
|
* Earnings call documents
|
|
1077
1112
|
*/
|
|
1078
1113
|
async earningsCallsDocuments(requestParameters: EarningsCallsDocumentsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsDocuments200Response> {
|
|
@@ -2864,6 +2899,13 @@ export const EarningsCallsCompanyDocumentsPeriodEnum = {
|
|
|
2864
2899
|
Fy: 'FY'
|
|
2865
2900
|
} as const;
|
|
2866
2901
|
export type EarningsCallsCompanyDocumentsPeriodEnum = typeof EarningsCallsCompanyDocumentsPeriodEnum[keyof typeof EarningsCallsCompanyDocumentsPeriodEnum];
|
|
2902
|
+
/**
|
|
2903
|
+
* @export
|
|
2904
|
+
*/
|
|
2905
|
+
export const EarningsCallsCompanyDocumentsIncludeEnum = {
|
|
2906
|
+
Calls: 'calls'
|
|
2907
|
+
} as const;
|
|
2908
|
+
export type EarningsCallsCompanyDocumentsIncludeEnum = typeof EarningsCallsCompanyDocumentsIncludeEnum[keyof typeof EarningsCallsCompanyDocumentsIncludeEnum];
|
|
2867
2909
|
/**
|
|
2868
2910
|
* @export
|
|
2869
2911
|
*/
|
|
@@ -26,11 +26,17 @@ export interface EarningsCallsCompanyDocuments200ResponseDocumentsInner {
|
|
|
26
26
|
*/
|
|
27
27
|
document_id: string;
|
|
28
28
|
/**
|
|
29
|
-
* IR
|
|
29
|
+
* company = the IR library; call = a document of one earnings call (only with include=calls)
|
|
30
|
+
* @type {EarningsCallsCompanyDocuments200ResponseDocumentsInnerSourceEnum}
|
|
31
|
+
* @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
|
|
32
|
+
*/
|
|
33
|
+
source: EarningsCallsCompanyDocuments200ResponseDocumentsInnerSourceEnum;
|
|
34
|
+
/**
|
|
35
|
+
* IR site section the document is filed in; null on a call document
|
|
30
36
|
* @type {EarningsCallsCompanyDocuments200ResponseDocumentsInnerSectionEnum}
|
|
31
37
|
* @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
|
|
32
38
|
*/
|
|
33
|
-
section: EarningsCallsCompanyDocuments200ResponseDocumentsInnerSectionEnum;
|
|
39
|
+
section: EarningsCallsCompanyDocuments200ResponseDocumentsInnerSectionEnum | null;
|
|
34
40
|
/**
|
|
35
41
|
* Document kind
|
|
36
42
|
* @type {EarningsCallsCompanyDocuments200ResponseDocumentsInnerKindEnum}
|
|
@@ -49,6 +55,24 @@ export interface EarningsCallsCompanyDocuments200ResponseDocumentsInner {
|
|
|
49
55
|
* @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
|
|
50
56
|
*/
|
|
51
57
|
period: EarningsCallsCompanyDocuments200ResponseDocumentsInnerPeriodEnum | null;
|
|
58
|
+
/**
|
|
59
|
+
* Folder of the document tree, e.g. earnings/fy2027/q2, events/2026/09-10-<event>, reports/2025, governance, shareholder/tax; null = not placed yet
|
|
60
|
+
* @type {string}
|
|
61
|
+
* @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
|
|
62
|
+
*/
|
|
63
|
+
group: string | null;
|
|
64
|
+
/**
|
|
65
|
+
* Human label of `group`, e.g. "Q2 FY2027", "Reports 2025", "Shareholder · Tax"
|
|
66
|
+
* @type {string}
|
|
67
|
+
* @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
|
|
68
|
+
*/
|
|
69
|
+
group_label: string | null;
|
|
70
|
+
/**
|
|
71
|
+
* Spine folder of the tree: earnings, events, reports, presentations, governance, esg, shareholder, other; null = not placed yet
|
|
72
|
+
* @type {EarningsCallsCompanyDocuments200ResponseDocumentsInnerCategoryEnum}
|
|
73
|
+
* @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
|
|
74
|
+
*/
|
|
75
|
+
category: EarningsCallsCompanyDocuments200ResponseDocumentsInnerCategoryEnum | null;
|
|
52
76
|
/**
|
|
53
77
|
* The event the document belongs to
|
|
54
78
|
* @type {string}
|
|
@@ -62,7 +86,7 @@ export interface EarningsCallsCompanyDocuments200ResponseDocumentsInner {
|
|
|
62
86
|
*/
|
|
63
87
|
event_type: EarningsCallsCompanyDocuments200ResponseDocumentsInnerEventTypeEnum | null;
|
|
64
88
|
/**
|
|
65
|
-
* The item's own date on the site
|
|
89
|
+
* The item's own date on the site (a call document: the call's New York day)
|
|
66
90
|
* @type {Date}
|
|
67
91
|
* @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
|
|
68
92
|
*/
|
|
@@ -86,13 +110,13 @@ export interface EarningsCallsCompanyDocuments200ResponseDocumentsInner {
|
|
|
86
110
|
*/
|
|
87
111
|
source_url: string;
|
|
88
112
|
/**
|
|
89
|
-
* The IR page that listed the document
|
|
113
|
+
* The IR page that listed the document; null on a call document
|
|
90
114
|
* @type {string}
|
|
91
115
|
* @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
|
|
92
116
|
*/
|
|
93
117
|
page_url: string | null;
|
|
94
118
|
/**
|
|
95
|
-
* How the IR section was read
|
|
119
|
+
* How the IR section was read (a call document: where it was found)
|
|
96
120
|
* @type {EarningsCallsCompanyDocuments200ResponseDocumentsInnerOriginEnum}
|
|
97
121
|
* @memberof EarningsCallsCompanyDocuments200ResponseDocumentsInner
|
|
98
122
|
*/
|
|
@@ -178,6 +202,15 @@ export interface EarningsCallsCompanyDocuments200ResponseDocumentsInner {
|
|
|
178
202
|
}
|
|
179
203
|
|
|
180
204
|
|
|
205
|
+
/**
|
|
206
|
+
* @export
|
|
207
|
+
*/
|
|
208
|
+
export const EarningsCallsCompanyDocuments200ResponseDocumentsInnerSourceEnum = {
|
|
209
|
+
Company: 'company',
|
|
210
|
+
Call: 'call'
|
|
211
|
+
} as const;
|
|
212
|
+
export type EarningsCallsCompanyDocuments200ResponseDocumentsInnerSourceEnum = typeof EarningsCallsCompanyDocuments200ResponseDocumentsInnerSourceEnum[keyof typeof EarningsCallsCompanyDocuments200ResponseDocumentsInnerSourceEnum];
|
|
213
|
+
|
|
181
214
|
/**
|
|
182
215
|
* @export
|
|
183
216
|
*/
|
|
@@ -218,7 +251,8 @@ export const EarningsCallsCompanyDocuments200ResponseDocumentsInnerKindEnum = {
|
|
|
218
251
|
Infographic: 'infographic',
|
|
219
252
|
Webcast: 'webcast',
|
|
220
253
|
Other: 'other',
|
|
221
|
-
PreparedRemarks: 'prepared_remarks'
|
|
254
|
+
PreparedRemarks: 'prepared_remarks',
|
|
255
|
+
SecFiling: 'sec_filing'
|
|
222
256
|
} as const;
|
|
223
257
|
export type EarningsCallsCompanyDocuments200ResponseDocumentsInnerKindEnum = typeof EarningsCallsCompanyDocuments200ResponseDocumentsInnerKindEnum[keyof typeof EarningsCallsCompanyDocuments200ResponseDocumentsInnerKindEnum];
|
|
224
258
|
|
|
@@ -236,6 +270,21 @@ export const EarningsCallsCompanyDocuments200ResponseDocumentsInnerPeriodEnum =
|
|
|
236
270
|
} as const;
|
|
237
271
|
export type EarningsCallsCompanyDocuments200ResponseDocumentsInnerPeriodEnum = typeof EarningsCallsCompanyDocuments200ResponseDocumentsInnerPeriodEnum[keyof typeof EarningsCallsCompanyDocuments200ResponseDocumentsInnerPeriodEnum];
|
|
238
272
|
|
|
273
|
+
/**
|
|
274
|
+
* @export
|
|
275
|
+
*/
|
|
276
|
+
export const EarningsCallsCompanyDocuments200ResponseDocumentsInnerCategoryEnum = {
|
|
277
|
+
Earnings: 'earnings',
|
|
278
|
+
Events: 'events',
|
|
279
|
+
Reports: 'reports',
|
|
280
|
+
Presentations: 'presentations',
|
|
281
|
+
Governance: 'governance',
|
|
282
|
+
Esg: 'esg',
|
|
283
|
+
Shareholder: 'shareholder',
|
|
284
|
+
Other: 'other'
|
|
285
|
+
} as const;
|
|
286
|
+
export type EarningsCallsCompanyDocuments200ResponseDocumentsInnerCategoryEnum = typeof EarningsCallsCompanyDocuments200ResponseDocumentsInnerCategoryEnum[keyof typeof EarningsCallsCompanyDocuments200ResponseDocumentsInnerCategoryEnum];
|
|
287
|
+
|
|
239
288
|
/**
|
|
240
289
|
* @export
|
|
241
290
|
*/
|
|
@@ -257,7 +306,14 @@ export const EarningsCallsCompanyDocuments200ResponseDocumentsInnerOriginEnum =
|
|
|
257
306
|
NotifiedListing: 'notified_listing',
|
|
258
307
|
JsonFeed: 'json_feed',
|
|
259
308
|
HtmlPage: 'html_page',
|
|
260
|
-
Agent: 'agent'
|
|
309
|
+
Agent: 'agent',
|
|
310
|
+
Q4Reports: 'q4_reports',
|
|
311
|
+
Q4Event: 'q4_event',
|
|
312
|
+
EdgarExhibit: 'edgar_exhibit',
|
|
313
|
+
EdgarFiling: 'edgar_filing',
|
|
314
|
+
IrListing: 'ir_listing',
|
|
315
|
+
PlaybookPattern: 'playbook_pattern',
|
|
316
|
+
AgentArchive: 'agent_archive'
|
|
261
317
|
} as const;
|
|
262
318
|
export type EarningsCallsCompanyDocuments200ResponseDocumentsInnerOriginEnum = typeof EarningsCallsCompanyDocuments200ResponseDocumentsInnerOriginEnum[keyof typeof EarningsCallsCompanyDocuments200ResponseDocumentsInnerOriginEnum];
|
|
263
319
|
|
|
@@ -298,10 +354,14 @@ export type EarningsCallsCompanyDocuments200ResponseDocumentsInnerLinkStatusEnum
|
|
|
298
354
|
*/
|
|
299
355
|
export function instanceOfEarningsCallsCompanyDocuments200ResponseDocumentsInner(value: object): value is EarningsCallsCompanyDocuments200ResponseDocumentsInner {
|
|
300
356
|
if (!('document_id' in value) || value['document_id'] === undefined) return false;
|
|
357
|
+
if (!('source' in value) || value['source'] === undefined) return false;
|
|
301
358
|
if (!('section' in value) || value['section'] === undefined) return false;
|
|
302
359
|
if (!('kind' in value) || value['kind'] === undefined) return false;
|
|
303
360
|
if (!('year' in value) || value['year'] === undefined) return false;
|
|
304
361
|
if (!('period' in value) || value['period'] === undefined) return false;
|
|
362
|
+
if (!('group' in value) || value['group'] === undefined) return false;
|
|
363
|
+
if (!('group_label' in value) || value['group_label'] === undefined) return false;
|
|
364
|
+
if (!('category' in value) || value['category'] === undefined) return false;
|
|
305
365
|
if (!('event_id' in value) || value['event_id'] === undefined) return false;
|
|
306
366
|
if (!('event_type' in value) || value['event_type'] === undefined) return false;
|
|
307
367
|
if (!('event_date' in value) || value['event_date'] === undefined) return false;
|
|
@@ -336,10 +396,14 @@ export function EarningsCallsCompanyDocuments200ResponseDocumentsInnerFromJSONTy
|
|
|
336
396
|
return {
|
|
337
397
|
|
|
338
398
|
'document_id': json['document_id'],
|
|
399
|
+
'source': json['source'],
|
|
339
400
|
'section': json['section'],
|
|
340
401
|
'kind': json['kind'],
|
|
341
402
|
'year': json['year'],
|
|
342
403
|
'period': json['period'],
|
|
404
|
+
'group': json['group'],
|
|
405
|
+
'group_label': json['group_label'],
|
|
406
|
+
'category': json['category'],
|
|
343
407
|
'event_id': json['event_id'],
|
|
344
408
|
'event_type': json['event_type'],
|
|
345
409
|
'event_date': (json['event_date'] == null ? null : new Date(json['event_date'])),
|
|
@@ -376,10 +440,14 @@ export function EarningsCallsCompanyDocuments200ResponseDocumentsInnerToJSONType
|
|
|
376
440
|
return {
|
|
377
441
|
|
|
378
442
|
'document_id': value['document_id'],
|
|
443
|
+
'source': value['source'],
|
|
379
444
|
'section': value['section'],
|
|
380
445
|
'kind': value['kind'],
|
|
381
446
|
'year': value['year'],
|
|
382
447
|
'period': value['period'],
|
|
448
|
+
'group': value['group'],
|
|
449
|
+
'group_label': value['group_label'],
|
|
450
|
+
'category': value['category'],
|
|
383
451
|
'event_id': value['event_id'],
|
|
384
452
|
'event_type': value['event_type'],
|
|
385
453
|
'event_date': value['event_date'] == null ? value['event_date'] : value['event_date'].toISOString().substring(0,10),
|
|
@@ -103,6 +103,24 @@ export interface EarningsCallsDocumentSearch200ResponseHitsInner {
|
|
|
103
103
|
* @memberof EarningsCallsDocumentSearch200ResponseHitsInner
|
|
104
104
|
*/
|
|
105
105
|
title: string | null;
|
|
106
|
+
/**
|
|
107
|
+
* Folder of the document tree, e.g. earnings/fy2027/q2, events/2026/09-10-<event>, reports/2025, governance, shareholder/tax; null = not placed yet
|
|
108
|
+
* @type {string}
|
|
109
|
+
* @memberof EarningsCallsDocumentSearch200ResponseHitsInner
|
|
110
|
+
*/
|
|
111
|
+
group: string | null;
|
|
112
|
+
/**
|
|
113
|
+
* Human label of `group`, e.g. "Q2 FY2027", "Reports 2025", "Shareholder · Tax"
|
|
114
|
+
* @type {string}
|
|
115
|
+
* @memberof EarningsCallsDocumentSearch200ResponseHitsInner
|
|
116
|
+
*/
|
|
117
|
+
group_label: string | null;
|
|
118
|
+
/**
|
|
119
|
+
* Spine folder of the tree: earnings, events, reports, presentations, governance, esg, shareholder, other; null = not placed yet
|
|
120
|
+
* @type {EarningsCallsDocumentSearch200ResponseHitsInnerCategoryEnum}
|
|
121
|
+
* @memberof EarningsCallsDocumentSearch200ResponseHitsInner
|
|
122
|
+
*/
|
|
123
|
+
category: EarningsCallsDocumentSearch200ResponseHitsInnerCategoryEnum | null;
|
|
106
124
|
/**
|
|
107
125
|
* Signed URL of the stored file; null for a link-only row
|
|
108
126
|
* @type {string}
|
|
@@ -127,6 +145,21 @@ export const EarningsCallsDocumentSearch200ResponseHitsInnerTableEnum = {
|
|
|
127
145
|
} as const;
|
|
128
146
|
export type EarningsCallsDocumentSearch200ResponseHitsInnerTableEnum = typeof EarningsCallsDocumentSearch200ResponseHitsInnerTableEnum[keyof typeof EarningsCallsDocumentSearch200ResponseHitsInnerTableEnum];
|
|
129
147
|
|
|
148
|
+
/**
|
|
149
|
+
* @export
|
|
150
|
+
*/
|
|
151
|
+
export const EarningsCallsDocumentSearch200ResponseHitsInnerCategoryEnum = {
|
|
152
|
+
Earnings: 'earnings',
|
|
153
|
+
Events: 'events',
|
|
154
|
+
Reports: 'reports',
|
|
155
|
+
Presentations: 'presentations',
|
|
156
|
+
Governance: 'governance',
|
|
157
|
+
Esg: 'esg',
|
|
158
|
+
Shareholder: 'shareholder',
|
|
159
|
+
Other: 'other'
|
|
160
|
+
} as const;
|
|
161
|
+
export type EarningsCallsDocumentSearch200ResponseHitsInnerCategoryEnum = typeof EarningsCallsDocumentSearch200ResponseHitsInnerCategoryEnum[keyof typeof EarningsCallsDocumentSearch200ResponseHitsInnerCategoryEnum];
|
|
162
|
+
|
|
130
163
|
|
|
131
164
|
/**
|
|
132
165
|
* Check if a given object implements the EarningsCallsDocumentSearch200ResponseHitsInner interface.
|
|
@@ -146,6 +179,9 @@ export function instanceOfEarningsCallsDocumentSearch200ResponseHitsInner(value:
|
|
|
146
179
|
if (!('heading' in value) || value['heading'] === undefined) return false;
|
|
147
180
|
if (!('text' in value) || value['text'] === undefined) return false;
|
|
148
181
|
if (!('title' in value) || value['title'] === undefined) return false;
|
|
182
|
+
if (!('group' in value) || value['group'] === undefined) return false;
|
|
183
|
+
if (!('group_label' in value) || value['group_label'] === undefined) return false;
|
|
184
|
+
if (!('category' in value) || value['category'] === undefined) return false;
|
|
149
185
|
if (!('url' in value) || value['url'] === undefined) return false;
|
|
150
186
|
if (!('expires_at' in value) || value['expires_at'] === undefined) return false;
|
|
151
187
|
return true;
|
|
@@ -175,6 +211,9 @@ export function EarningsCallsDocumentSearch200ResponseHitsInnerFromJSONTyped(jso
|
|
|
175
211
|
'heading': json['heading'],
|
|
176
212
|
'text': json['text'],
|
|
177
213
|
'title': json['title'],
|
|
214
|
+
'group': json['group'],
|
|
215
|
+
'group_label': json['group_label'],
|
|
216
|
+
'category': json['category'],
|
|
178
217
|
'url': json['url'],
|
|
179
218
|
'expires_at': (json['expires_at'] == null ? null : new Date(json['expires_at'])),
|
|
180
219
|
};
|
|
@@ -205,6 +244,9 @@ export function EarningsCallsDocumentSearch200ResponseHitsInnerToJSONTyped(value
|
|
|
205
244
|
'heading': value['heading'],
|
|
206
245
|
'text': value['text'],
|
|
207
246
|
'title': value['title'],
|
|
247
|
+
'group': value['group'],
|
|
248
|
+
'group_label': value['group_label'],
|
|
249
|
+
'category': value['category'],
|
|
208
250
|
'url': value['url'],
|
|
209
251
|
'expires_at': value['expires_at'] == null ? value['expires_at'] : value['expires_at'].toISOString(),
|
|
210
252
|
};
|
|
@@ -109,6 +109,24 @@ export interface EarningsCallsDocuments200ResponseDocumentsInner {
|
|
|
109
109
|
* @memberof EarningsCallsDocuments200ResponseDocumentsInner
|
|
110
110
|
*/
|
|
111
111
|
trust_tier: EarningsCallsDocuments200ResponseDocumentsInnerTrustTierEnum | null;
|
|
112
|
+
/**
|
|
113
|
+
* Folder of the document tree, e.g. earnings/fy2027/q2, events/2026/09-10-<event>, reports/2025, governance, shareholder/tax; null = not placed yet
|
|
114
|
+
* @type {string}
|
|
115
|
+
* @memberof EarningsCallsDocuments200ResponseDocumentsInner
|
|
116
|
+
*/
|
|
117
|
+
group: string | null;
|
|
118
|
+
/**
|
|
119
|
+
* Human label of `group`, e.g. "Q2 FY2027", "Reports 2025", "Shareholder · Tax"
|
|
120
|
+
* @type {string}
|
|
121
|
+
* @memberof EarningsCallsDocuments200ResponseDocumentsInner
|
|
122
|
+
*/
|
|
123
|
+
group_label: string | null;
|
|
124
|
+
/**
|
|
125
|
+
* Spine folder of the tree: earnings, events, reports, presentations, governance, esg, shareholder, other; null = not placed yet
|
|
126
|
+
* @type {EarningsCallsDocuments200ResponseDocumentsInnerCategoryEnum}
|
|
127
|
+
* @memberof EarningsCallsDocuments200ResponseDocumentsInner
|
|
128
|
+
*/
|
|
129
|
+
category: EarningsCallsDocuments200ResponseDocumentsInnerCategoryEnum | null;
|
|
112
130
|
/**
|
|
113
131
|
* Extracted text, capped (only with include=body; null for spreadsheets / link-only rows)
|
|
114
132
|
* @type {string}
|
|
@@ -171,6 +189,21 @@ export const EarningsCallsDocuments200ResponseDocumentsInnerTrustTierEnum = {
|
|
|
171
189
|
} as const;
|
|
172
190
|
export type EarningsCallsDocuments200ResponseDocumentsInnerTrustTierEnum = typeof EarningsCallsDocuments200ResponseDocumentsInnerTrustTierEnum[keyof typeof EarningsCallsDocuments200ResponseDocumentsInnerTrustTierEnum];
|
|
173
191
|
|
|
192
|
+
/**
|
|
193
|
+
* @export
|
|
194
|
+
*/
|
|
195
|
+
export const EarningsCallsDocuments200ResponseDocumentsInnerCategoryEnum = {
|
|
196
|
+
Earnings: 'earnings',
|
|
197
|
+
Events: 'events',
|
|
198
|
+
Reports: 'reports',
|
|
199
|
+
Presentations: 'presentations',
|
|
200
|
+
Governance: 'governance',
|
|
201
|
+
Esg: 'esg',
|
|
202
|
+
Shareholder: 'shareholder',
|
|
203
|
+
Other: 'other'
|
|
204
|
+
} as const;
|
|
205
|
+
export type EarningsCallsDocuments200ResponseDocumentsInnerCategoryEnum = typeof EarningsCallsDocuments200ResponseDocumentsInnerCategoryEnum[keyof typeof EarningsCallsDocuments200ResponseDocumentsInnerCategoryEnum];
|
|
206
|
+
|
|
174
207
|
|
|
175
208
|
/**
|
|
176
209
|
* Check if a given object implements the EarningsCallsDocuments200ResponseDocumentsInner interface.
|
|
@@ -191,6 +224,9 @@ export function instanceOfEarningsCallsDocuments200ResponseDocumentsInner(value:
|
|
|
191
224
|
if (!('bytes' in value) || value['bytes'] === undefined) return false;
|
|
192
225
|
if (!('pages' in value) || value['pages'] === undefined) return false;
|
|
193
226
|
if (!('trust_tier' in value) || value['trust_tier'] === undefined) return false;
|
|
227
|
+
if (!('group' in value) || value['group'] === undefined) return false;
|
|
228
|
+
if (!('group_label' in value) || value['group_label'] === undefined) return false;
|
|
229
|
+
if (!('category' in value) || value['category'] === undefined) return false;
|
|
194
230
|
return true;
|
|
195
231
|
}
|
|
196
232
|
|
|
@@ -219,6 +255,9 @@ export function EarningsCallsDocuments200ResponseDocumentsInnerFromJSONTyped(jso
|
|
|
219
255
|
'bytes': json['bytes'],
|
|
220
256
|
'pages': json['pages'],
|
|
221
257
|
'trust_tier': json['trust_tier'],
|
|
258
|
+
'group': json['group'],
|
|
259
|
+
'group_label': json['group_label'],
|
|
260
|
+
'category': json['category'],
|
|
222
261
|
'body_text': json['body_text'] == null ? undefined : json['body_text'],
|
|
223
262
|
};
|
|
224
263
|
}
|
|
@@ -249,6 +288,9 @@ export function EarningsCallsDocuments200ResponseDocumentsInnerToJSONTyped(value
|
|
|
249
288
|
'bytes': value['bytes'],
|
|
250
289
|
'pages': value['pages'],
|
|
251
290
|
'trust_tier': value['trust_tier'],
|
|
291
|
+
'group': value['group'],
|
|
292
|
+
'group_label': value['group_label'],
|
|
293
|
+
'category': value['category'],
|
|
252
294
|
'body_text': value['body_text'],
|
|
253
295
|
};
|
|
254
296
|
}
|