@invinite-org/data-api-client 2.0.0 → 3.0.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 +13 -2
- package/dist/apis/AsReportedBalanceSheetApi.d.ts +29 -2
- package/dist/apis/AsReportedBalanceSheetApi.js +33 -3
- package/dist/apis/AsReportedCashFlowStatementApi.d.ts +56 -2
- package/dist/apis/AsReportedCashFlowStatementApi.js +63 -3
- package/dist/apis/AsReportedIncomeStatementApi.d.ts +29 -2
- package/dist/apis/AsReportedIncomeStatementApi.js +33 -3
- package/dist/apis/AsReportedSnapshotApi.d.ts +59 -5
- package/dist/apis/AsReportedSnapshotApi.js +65 -5
- package/dist/esm/apis/AsReportedBalanceSheetApi.d.ts +29 -2
- package/dist/esm/apis/AsReportedBalanceSheetApi.js +32 -2
- package/dist/esm/apis/AsReportedCashFlowStatementApi.d.ts +56 -2
- package/dist/esm/apis/AsReportedCashFlowStatementApi.js +62 -2
- package/dist/esm/apis/AsReportedIncomeStatementApi.d.ts +29 -2
- package/dist/esm/apis/AsReportedIncomeStatementApi.js +32 -2
- package/dist/esm/apis/AsReportedSnapshotApi.d.ts +59 -5
- package/dist/esm/apis/AsReportedSnapshotApi.js +64 -4
- package/dist/esm/models/{AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue.d.ts → AsReportedDetailedFact.d.ts} +39 -21
- package/dist/esm/models/{AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue.js → AsReportedDetailedFact.js} +33 -13
- package/dist/esm/models/AsReportedFact.d.ts +38 -0
- package/dist/esm/models/AsReportedFact.js +47 -0
- package/dist/esm/models/AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner.d.ts +3 -2
- package/dist/esm/models/AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner.js +4 -2
- package/dist/esm/models/AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner.d.ts +3 -3
- package/dist/esm/models/AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner.js +3 -3
- package/dist/esm/models/AsReportedSnapshot200Response.d.ts +33 -0
- package/dist/esm/models/AsReportedSnapshot200Response.js +44 -0
- package/dist/esm/models/AsReportedSnapshot200ResponseCompaniesInner.d.ts +91 -0
- package/dist/esm/models/AsReportedSnapshot200ResponseCompaniesInner.js +85 -0
- package/dist/esm/models/AsReportedSnapshot200ResponseCompaniesInnerStatements.d.ts +45 -0
- package/dist/esm/models/AsReportedSnapshot200ResponseCompaniesInnerStatements.js +52 -0
- package/dist/esm/models/AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement.d.ts +35 -0
- package/dist/esm/models/AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement.js +43 -0
- package/dist/esm/models/AsReportedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement.d.ts +3 -3
- package/dist/esm/models/AsReportedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement.js +3 -3
- package/dist/esm/models/InsiderTradesList200ResponseTransactionsInner.d.ts +4 -4
- package/dist/esm/models/PresentationFact.d.ts +12 -0
- package/dist/esm/models/PresentationFact.js +4 -0
- package/dist/esm/models/index.d.ts +6 -1
- package/dist/esm/models/index.js +6 -1
- package/dist/models/{AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue.d.ts → AsReportedDetailedFact.d.ts} +39 -21
- package/dist/models/{AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue.js → AsReportedDetailedFact.js} +38 -18
- package/dist/models/AsReportedFact.d.ts +38 -0
- package/dist/models/AsReportedFact.js +54 -0
- package/dist/models/AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner.d.ts +3 -2
- package/dist/models/AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner.js +4 -2
- package/dist/models/AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner.d.ts +3 -3
- package/dist/models/AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner.js +3 -3
- package/dist/models/AsReportedSnapshot200Response.d.ts +33 -0
- package/dist/models/AsReportedSnapshot200Response.js +51 -0
- package/dist/models/AsReportedSnapshot200ResponseCompaniesInner.d.ts +91 -0
- package/dist/models/AsReportedSnapshot200ResponseCompaniesInner.js +93 -0
- package/dist/models/AsReportedSnapshot200ResponseCompaniesInnerStatements.d.ts +45 -0
- package/dist/models/AsReportedSnapshot200ResponseCompaniesInnerStatements.js +59 -0
- package/dist/models/AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement.d.ts +35 -0
- package/dist/models/AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement.js +50 -0
- package/dist/models/AsReportedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement.d.ts +3 -3
- package/dist/models/AsReportedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement.js +3 -3
- package/dist/models/InsiderTradesList200ResponseTransactionsInner.d.ts +4 -4
- package/dist/models/PresentationFact.d.ts +12 -0
- package/dist/models/PresentationFact.js +4 -0
- package/dist/models/index.d.ts +6 -1
- package/dist/models/index.js +6 -1
- package/docs/AsReportedBalanceSheetApi.md +15 -6
- package/docs/AsReportedCashFlowStatementApi.md +24 -6
- package/docs/{AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue.md → AsReportedDetailedFact.md} +12 -6
- package/docs/AsReportedFact.md +36 -0
- package/docs/AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner.md +1 -1
- package/docs/AsReportedIncomeStatementApi.md +15 -6
- package/docs/AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner.md +1 -1
- package/docs/AsReportedSnapshot200Response.md +34 -0
- package/docs/AsReportedSnapshot200ResponseCompaniesInner.md +50 -0
- package/docs/AsReportedSnapshot200ResponseCompaniesInnerStatements.md +38 -0
- package/docs/AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement.md +35 -0
- package/docs/AsReportedSnapshotApi.md +25 -7
- package/docs/AsReportedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement.md +1 -1
- package/docs/PresentationFact.md +4 -0
- package/package.json +1 -1
- package/src/apis/AsReportedBalanceSheetApi.ts +41 -2
- package/src/apis/AsReportedCashFlowStatementApi.ts +80 -2
- package/src/apis/AsReportedIncomeStatementApi.ts +41 -2
- package/src/apis/AsReportedSnapshotApi.ts +88 -10
- package/src/models/{AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue.ts → AsReportedDetailedFact.ts} +59 -28
- package/src/models/AsReportedFact.ts +75 -0
- package/src/models/AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner.ts +12 -4
- package/src/models/AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner.ts +10 -10
- package/src/models/AsReportedSnapshot200Response.ts +74 -0
- package/src/models/AsReportedSnapshot200ResponseCompaniesInner.ts +159 -0
- package/src/models/AsReportedSnapshot200ResponseCompaniesInnerStatements.ts +92 -0
- package/src/models/AsReportedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement.ts +73 -0
- package/src/models/AsReportedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement.ts +10 -10
- package/src/models/InsiderTradesList200ResponseTransactionsInner.ts +4 -4
- package/src/models/PresentationFact.ts +16 -0
- package/src/models/index.ts +6 -1
|
@@ -12,7 +12,7 @@ All URIs are relative to *https://api.data.invinite.com*
|
|
|
12
12
|
|
|
13
13
|
## asReportedSnapshot
|
|
14
14
|
|
|
15
|
-
>
|
|
15
|
+
> AsReportedSnapshot200Response asReportedSnapshot(identifiers, fiscalPeriodType, calendarYear, calendarQuarter, reportedOnly, displaySign)
|
|
16
16
|
|
|
17
17
|
As-reported snapshot
|
|
18
18
|
|
|
@@ -44,6 +44,10 @@ async function example() {
|
|
|
44
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
46
|
calendarQuarter: 4,
|
|
47
|
+
// 'true' | 'false' | `true`: only the facts the company reported (`derived: false`); the pipeline\'s derived Q4 / TTM / YTD values are left out (optional)
|
|
48
|
+
reportedOnly: true,
|
|
49
|
+
// 'as_filed' | 'cash_flow_direction' | Sign of cash-flow facts. `as_filed` (default): the value as the company tagged it in XBRL. `cash_flow_direction`: a credit-balance cash-flow fact (outside the supplemental disclosures) is negated so outflows read negative. Standardized cash-flow metrics already carry one sign per metric (outflows negative, capital expenditures positive). (optional)
|
|
50
|
+
displaySign: as_filed,
|
|
47
51
|
} satisfies AsReportedSnapshotRequest;
|
|
48
52
|
|
|
49
53
|
try {
|
|
@@ -67,10 +71,12 @@ example().catch(console.error);
|
|
|
67
71
|
| **fiscalPeriodType** | `quarterly`, `annual`, `ytd`, `ttm` | Type of fiscal period | [Defaults to `undefined`] [Enum: quarterly, annual, ytd, ttm] |
|
|
68
72
|
| **calendarYear** | `number` | Calendar year. For annual periods, only calendar_year is needed. For non-annual periods, must be provided together with calendar_quarter. | [Optional] [Defaults to `undefined`] |
|
|
69
73
|
| **calendarQuarter** | `number` | Calendar quarter (1-4). For annual periods, should not be provided. For non-annual periods, must be provided together with calendar_year. | [Optional] [Defaults to `undefined`] |
|
|
74
|
+
| **reportedOnly** | `true`, `false` | `true`: only the facts the company reported (`derived: false`); the pipeline\'s derived Q4 / TTM / YTD values are left out | [Optional] [Defaults to `'false'`] [Enum: true, false] |
|
|
75
|
+
| **displaySign** | `as_filed`, `cash_flow_direction` | Sign of cash-flow facts. `as_filed` (default): the value as the company tagged it in XBRL. `cash_flow_direction`: a credit-balance cash-flow fact (outside the supplemental disclosures) is negated so outflows read negative. Standardized cash-flow metrics already carry one sign per metric (outflows negative, capital expenditures positive). | [Optional] [Defaults to `'as_filed'`] [Enum: as_filed, cash_flow_direction] |
|
|
70
76
|
|
|
71
77
|
### Return type
|
|
72
78
|
|
|
73
|
-
[**
|
|
79
|
+
[**AsReportedSnapshot200Response**](AsReportedSnapshot200Response.md)
|
|
74
80
|
|
|
75
81
|
### Authorization
|
|
76
82
|
|
|
@@ -96,11 +102,11 @@ example().catch(console.error);
|
|
|
96
102
|
|
|
97
103
|
## asReportedSnapshotDetailed
|
|
98
104
|
|
|
99
|
-
> AsReportedSnapshotDetailed200Response asReportedSnapshotDetailed(identifiers, fiscalPeriodType, calendarYear, calendarQuarter, withFormula)
|
|
105
|
+
> AsReportedSnapshotDetailed200Response asReportedSnapshotDetailed(identifiers, fiscalPeriodType, calendarYear, calendarQuarter, reportedOnly, displaySign, withFormula)
|
|
100
106
|
|
|
101
107
|
As-reported snapshot (detailed)
|
|
102
108
|
|
|
103
|
-
Fetch latest complete detailed as-reported financial statements snapshot with
|
|
109
|
+
Fetch latest complete detailed as-reported financial statements snapshot with derived flag, taxonomy and company labels, decimals, accession number, html tag id and optional formula. Minimum tier for redistribute: PRO.
|
|
104
110
|
|
|
105
111
|
### Example
|
|
106
112
|
|
|
@@ -128,7 +134,11 @@ async function example() {
|
|
|
128
134
|
calendarYear: 2024,
|
|
129
135
|
// 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
136
|
calendarQuarter: 4,
|
|
131
|
-
// 'true' | 'false' |
|
|
137
|
+
// 'true' | 'false' | `true`: only the facts the company reported (`derived: false`); the pipeline\'s derived Q4 / TTM / YTD values are left out (optional)
|
|
138
|
+
reportedOnly: true,
|
|
139
|
+
// 'as_filed' | 'cash_flow_direction' | Sign of cash-flow facts. `as_filed` (default): the value as the company tagged it in XBRL. `cash_flow_direction`: a credit-balance cash-flow fact (outside the supplemental disclosures) is negated so outflows read negative. Standardized cash-flow metrics already carry one sign per metric (outflows negative, capital expenditures positive). (optional)
|
|
140
|
+
displaySign: as_filed,
|
|
141
|
+
// 'true' | 'false' | Include each derived fact\'s formula (its members and their values) (optional)
|
|
132
142
|
withFormula: true,
|
|
133
143
|
} satisfies AsReportedSnapshotDetailedRequest;
|
|
134
144
|
|
|
@@ -153,7 +163,9 @@ example().catch(console.error);
|
|
|
153
163
|
| **fiscalPeriodType** | `quarterly`, `annual`, `ytd`, `ttm` | Type of fiscal period | [Defaults to `undefined`] [Enum: quarterly, annual, ytd, ttm] |
|
|
154
164
|
| **calendarYear** | `number` | Calendar year. For annual periods, only calendar_year is needed. For non-annual periods, must be provided together with calendar_quarter. | [Optional] [Defaults to `undefined`] |
|
|
155
165
|
| **calendarQuarter** | `number` | Calendar quarter (1-4). For annual periods, should not be provided. For non-annual periods, must be provided together with calendar_year. | [Optional] [Defaults to `undefined`] |
|
|
156
|
-
| **
|
|
166
|
+
| **reportedOnly** | `true`, `false` | `true`: only the facts the company reported (`derived: false`); the pipeline\'s derived Q4 / TTM / YTD values are left out | [Optional] [Defaults to `'false'`] [Enum: true, false] |
|
|
167
|
+
| **displaySign** | `as_filed`, `cash_flow_direction` | Sign of cash-flow facts. `as_filed` (default): the value as the company tagged it in XBRL. `cash_flow_direction`: a credit-balance cash-flow fact (outside the supplemental disclosures) is negated so outflows read negative. Standardized cash-flow metrics already carry one sign per metric (outflows negative, capital expenditures positive). | [Optional] [Defaults to `'as_filed'`] [Enum: as_filed, cash_flow_direction] |
|
|
168
|
+
| **withFormula** | `true`, `false` | Include each derived fact\'s formula (its members and their values) | [Optional] [Defaults to `'false'`] [Enum: true, false] |
|
|
157
169
|
|
|
158
170
|
### Return type
|
|
159
171
|
|
|
@@ -183,7 +195,7 @@ example().catch(console.error);
|
|
|
183
195
|
|
|
184
196
|
## asReportedSnapshotPresentation
|
|
185
197
|
|
|
186
|
-
> AsReportedSnapshotPresentation200Response asReportedSnapshotPresentation(identifiers, fiscalPeriodType, calendarYear, calendarQuarter)
|
|
198
|
+
> AsReportedSnapshotPresentation200Response asReportedSnapshotPresentation(identifiers, fiscalPeriodType, calendarYear, calendarQuarter, reportedOnly, displaySign)
|
|
187
199
|
|
|
188
200
|
As-reported snapshot (presentation)
|
|
189
201
|
|
|
@@ -215,6 +227,10 @@ async function example() {
|
|
|
215
227
|
calendarYear: 2024,
|
|
216
228
|
// 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
229
|
calendarQuarter: 4,
|
|
230
|
+
// 'true' | 'false' | `true`: only the facts the company reported (`derived: false`); the pipeline\'s derived Q4 / TTM / YTD values are left out (optional)
|
|
231
|
+
reportedOnly: true,
|
|
232
|
+
// 'as_filed' | 'cash_flow_direction' | Sign of cash-flow facts. `as_filed` (default): the value as the company tagged it in XBRL. `cash_flow_direction`: a credit-balance cash-flow fact (outside the supplemental disclosures) is negated so outflows read negative. Standardized cash-flow metrics already carry one sign per metric (outflows negative, capital expenditures positive). (optional)
|
|
233
|
+
displaySign: as_filed,
|
|
218
234
|
} satisfies AsReportedSnapshotPresentationRequest;
|
|
219
235
|
|
|
220
236
|
try {
|
|
@@ -238,6 +254,8 @@ example().catch(console.error);
|
|
|
238
254
|
| **fiscalPeriodType** | `quarterly`, `annual`, `ytd`, `ttm` | Type of fiscal period | [Defaults to `undefined`] [Enum: quarterly, annual, ytd, ttm] |
|
|
239
255
|
| **calendarYear** | `number` | Calendar year. For annual periods, only calendar_year is needed. For non-annual periods, must be provided together with calendar_quarter. | [Optional] [Defaults to `undefined`] |
|
|
240
256
|
| **calendarQuarter** | `number` | Calendar quarter (1-4). For annual periods, should not be provided. For non-annual periods, must be provided together with calendar_year. | [Optional] [Defaults to `undefined`] |
|
|
257
|
+
| **reportedOnly** | `true`, `false` | `true`: only the facts the company reported (`derived: false`); the pipeline\'s derived Q4 / TTM / YTD values are left out | [Optional] [Defaults to `'false'`] [Enum: true, false] |
|
|
258
|
+
| **displaySign** | `as_filed`, `cash_flow_direction` | Sign of cash-flow facts. `as_filed` (default): the value as the company tagged it in XBRL. `cash_flow_direction`: a credit-balance cash-flow fact (outside the supplemental disclosures) is negated so outflows read negative. Standardized cash-flow metrics already carry one sign per metric (outflows negative, capital expenditures positive). | [Optional] [Defaults to `'as_filed'`] [Enum: as_filed, cash_flow_direction] |
|
|
241
259
|
|
|
242
260
|
### Return type
|
|
243
261
|
|
package/docs/AsReportedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement.md
CHANGED
|
@@ -7,7 +7,7 @@ Latest income statement facts or null if not available
|
|
|
7
7
|
|
|
8
8
|
Name | Type
|
|
9
9
|
------------ | -------------
|
|
10
|
-
`facts` | [{ [key: string]:
|
|
10
|
+
`facts` | [{ [key: string]: AsReportedDetailedFact; }](AsReportedDetailedFact.md)
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
package/docs/PresentationFact.md
CHANGED
|
@@ -9,6 +9,8 @@ Name | Type
|
|
|
9
9
|
`concept` | string
|
|
10
10
|
`label` | string
|
|
11
11
|
`value` | number
|
|
12
|
+
`derived` | boolean
|
|
13
|
+
`company_label` | string
|
|
12
14
|
`depth` | number
|
|
13
15
|
`isTotal` | boolean
|
|
14
16
|
`children` | [Array<PresentationFact>](PresentationFact.md)
|
|
@@ -23,6 +25,8 @@ const example = {
|
|
|
23
25
|
"concept": null,
|
|
24
26
|
"label": null,
|
|
25
27
|
"value": null,
|
|
28
|
+
"derived": null,
|
|
29
|
+
"company_label": null,
|
|
26
30
|
"depth": null,
|
|
27
31
|
"isTotal": null,
|
|
28
32
|
"children": null,
|
package/package.json
CHANGED
|
@@ -40,6 +40,7 @@ export interface AsReportedBalanceSheetRequest {
|
|
|
40
40
|
sort?: AsReportedBalanceSheetSortEnum;
|
|
41
41
|
limit?: number;
|
|
42
42
|
offset?: number;
|
|
43
|
+
reportedOnly?: AsReportedBalanceSheetReportedOnlyEnum;
|
|
43
44
|
}
|
|
44
45
|
|
|
45
46
|
export interface AsReportedBalanceSheetDetailedRequest {
|
|
@@ -49,6 +50,7 @@ export interface AsReportedBalanceSheetDetailedRequest {
|
|
|
49
50
|
limit?: number;
|
|
50
51
|
offset?: number;
|
|
51
52
|
withFormula?: AsReportedBalanceSheetDetailedWithFormulaEnum;
|
|
53
|
+
reportedOnly?: AsReportedBalanceSheetDetailedReportedOnlyEnum;
|
|
52
54
|
}
|
|
53
55
|
|
|
54
56
|
export interface AsReportedBalanceSheetPresentationRequest {
|
|
@@ -57,6 +59,7 @@ export interface AsReportedBalanceSheetPresentationRequest {
|
|
|
57
59
|
sort?: AsReportedBalanceSheetPresentationSortEnum;
|
|
58
60
|
limit?: number;
|
|
59
61
|
offset?: number;
|
|
62
|
+
reportedOnly?: AsReportedBalanceSheetPresentationReportedOnlyEnum;
|
|
60
63
|
}
|
|
61
64
|
|
|
62
65
|
/**
|
|
@@ -104,6 +107,10 @@ export class AsReportedBalanceSheetApi extends runtime.BaseAPI {
|
|
|
104
107
|
queryParameters['offset'] = requestParameters['offset'];
|
|
105
108
|
}
|
|
106
109
|
|
|
110
|
+
if (requestParameters['reportedOnly'] != null) {
|
|
111
|
+
queryParameters['reported_only'] = requestParameters['reportedOnly'];
|
|
112
|
+
}
|
|
113
|
+
|
|
107
114
|
const headerParameters: runtime.HTTPHeaders = {};
|
|
108
115
|
|
|
109
116
|
if (this.configuration && this.configuration.accessToken) {
|
|
@@ -189,6 +196,10 @@ export class AsReportedBalanceSheetApi extends runtime.BaseAPI {
|
|
|
189
196
|
queryParameters['with_formula'] = requestParameters['withFormula'];
|
|
190
197
|
}
|
|
191
198
|
|
|
199
|
+
if (requestParameters['reportedOnly'] != null) {
|
|
200
|
+
queryParameters['reported_only'] = requestParameters['reportedOnly'];
|
|
201
|
+
}
|
|
202
|
+
|
|
192
203
|
const headerParameters: runtime.HTTPHeaders = {};
|
|
193
204
|
|
|
194
205
|
if (this.configuration && this.configuration.accessToken) {
|
|
@@ -211,7 +222,7 @@ export class AsReportedBalanceSheetApi extends runtime.BaseAPI {
|
|
|
211
222
|
}
|
|
212
223
|
|
|
213
224
|
/**
|
|
214
|
-
* Fetch detailed as-reported balance sheet data with
|
|
225
|
+
* Fetch detailed as-reported balance sheet data with derived flag, taxonomy and company labels, decimals, accession number, html tag id and optional formula. Minimum tier for redistribute: PRO.
|
|
215
226
|
* As-reported balance sheet (detailed)
|
|
216
227
|
*/
|
|
217
228
|
async asReportedBalanceSheetDetailedRaw(requestParameters: AsReportedBalanceSheetDetailedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AsReportedIncomeStatementDetailed200Response>> {
|
|
@@ -222,7 +233,7 @@ export class AsReportedBalanceSheetApi extends runtime.BaseAPI {
|
|
|
222
233
|
}
|
|
223
234
|
|
|
224
235
|
/**
|
|
225
|
-
* Fetch detailed as-reported balance sheet data with
|
|
236
|
+
* Fetch detailed as-reported balance sheet data with derived flag, taxonomy and company labels, decimals, accession number, html tag id and optional formula. Minimum tier for redistribute: PRO.
|
|
226
237
|
* As-reported balance sheet (detailed)
|
|
227
238
|
*/
|
|
228
239
|
async asReportedBalanceSheetDetailed(requestParameters: AsReportedBalanceSheetDetailedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AsReportedIncomeStatementDetailed200Response> {
|
|
@@ -270,6 +281,10 @@ export class AsReportedBalanceSheetApi extends runtime.BaseAPI {
|
|
|
270
281
|
queryParameters['offset'] = requestParameters['offset'];
|
|
271
282
|
}
|
|
272
283
|
|
|
284
|
+
if (requestParameters['reportedOnly'] != null) {
|
|
285
|
+
queryParameters['reported_only'] = requestParameters['reportedOnly'];
|
|
286
|
+
}
|
|
287
|
+
|
|
273
288
|
const headerParameters: runtime.HTTPHeaders = {};
|
|
274
289
|
|
|
275
290
|
if (this.configuration && this.configuration.accessToken) {
|
|
@@ -331,6 +346,14 @@ export const AsReportedBalanceSheetSortEnum = {
|
|
|
331
346
|
Desc: 'desc'
|
|
332
347
|
} as const;
|
|
333
348
|
export type AsReportedBalanceSheetSortEnum = typeof AsReportedBalanceSheetSortEnum[keyof typeof AsReportedBalanceSheetSortEnum];
|
|
349
|
+
/**
|
|
350
|
+
* @export
|
|
351
|
+
*/
|
|
352
|
+
export const AsReportedBalanceSheetReportedOnlyEnum = {
|
|
353
|
+
True: 'true',
|
|
354
|
+
False: 'false'
|
|
355
|
+
} as const;
|
|
356
|
+
export type AsReportedBalanceSheetReportedOnlyEnum = typeof AsReportedBalanceSheetReportedOnlyEnum[keyof typeof AsReportedBalanceSheetReportedOnlyEnum];
|
|
334
357
|
/**
|
|
335
358
|
* @export
|
|
336
359
|
*/
|
|
@@ -357,6 +380,14 @@ export const AsReportedBalanceSheetDetailedWithFormulaEnum = {
|
|
|
357
380
|
False: 'false'
|
|
358
381
|
} as const;
|
|
359
382
|
export type AsReportedBalanceSheetDetailedWithFormulaEnum = typeof AsReportedBalanceSheetDetailedWithFormulaEnum[keyof typeof AsReportedBalanceSheetDetailedWithFormulaEnum];
|
|
383
|
+
/**
|
|
384
|
+
* @export
|
|
385
|
+
*/
|
|
386
|
+
export const AsReportedBalanceSheetDetailedReportedOnlyEnum = {
|
|
387
|
+
True: 'true',
|
|
388
|
+
False: 'false'
|
|
389
|
+
} as const;
|
|
390
|
+
export type AsReportedBalanceSheetDetailedReportedOnlyEnum = typeof AsReportedBalanceSheetDetailedReportedOnlyEnum[keyof typeof AsReportedBalanceSheetDetailedReportedOnlyEnum];
|
|
360
391
|
/**
|
|
361
392
|
* @export
|
|
362
393
|
*/
|
|
@@ -375,3 +406,11 @@ export const AsReportedBalanceSheetPresentationSortEnum = {
|
|
|
375
406
|
Desc: 'desc'
|
|
376
407
|
} as const;
|
|
377
408
|
export type AsReportedBalanceSheetPresentationSortEnum = typeof AsReportedBalanceSheetPresentationSortEnum[keyof typeof AsReportedBalanceSheetPresentationSortEnum];
|
|
409
|
+
/**
|
|
410
|
+
* @export
|
|
411
|
+
*/
|
|
412
|
+
export const AsReportedBalanceSheetPresentationReportedOnlyEnum = {
|
|
413
|
+
True: 'true',
|
|
414
|
+
False: 'false'
|
|
415
|
+
} as const;
|
|
416
|
+
export type AsReportedBalanceSheetPresentationReportedOnlyEnum = typeof AsReportedBalanceSheetPresentationReportedOnlyEnum[keyof typeof AsReportedBalanceSheetPresentationReportedOnlyEnum];
|
|
@@ -40,6 +40,8 @@ export interface AsReportedCashFlowStatementRequest {
|
|
|
40
40
|
sort?: AsReportedCashFlowStatementSortEnum;
|
|
41
41
|
limit?: number;
|
|
42
42
|
offset?: number;
|
|
43
|
+
reportedOnly?: AsReportedCashFlowStatementReportedOnlyEnum;
|
|
44
|
+
displaySign?: AsReportedCashFlowStatementDisplaySignEnum;
|
|
43
45
|
}
|
|
44
46
|
|
|
45
47
|
export interface AsReportedCashFlowStatementDetailedRequest {
|
|
@@ -49,6 +51,8 @@ export interface AsReportedCashFlowStatementDetailedRequest {
|
|
|
49
51
|
limit?: number;
|
|
50
52
|
offset?: number;
|
|
51
53
|
withFormula?: AsReportedCashFlowStatementDetailedWithFormulaEnum;
|
|
54
|
+
reportedOnly?: AsReportedCashFlowStatementDetailedReportedOnlyEnum;
|
|
55
|
+
displaySign?: AsReportedCashFlowStatementDetailedDisplaySignEnum;
|
|
52
56
|
}
|
|
53
57
|
|
|
54
58
|
export interface AsReportedCashFlowStatementPresentationRequest {
|
|
@@ -57,6 +61,8 @@ export interface AsReportedCashFlowStatementPresentationRequest {
|
|
|
57
61
|
sort?: AsReportedCashFlowStatementPresentationSortEnum;
|
|
58
62
|
limit?: number;
|
|
59
63
|
offset?: number;
|
|
64
|
+
reportedOnly?: AsReportedCashFlowStatementPresentationReportedOnlyEnum;
|
|
65
|
+
displaySign?: AsReportedCashFlowStatementPresentationDisplaySignEnum;
|
|
60
66
|
}
|
|
61
67
|
|
|
62
68
|
/**
|
|
@@ -104,6 +110,14 @@ export class AsReportedCashFlowStatementApi extends runtime.BaseAPI {
|
|
|
104
110
|
queryParameters['offset'] = requestParameters['offset'];
|
|
105
111
|
}
|
|
106
112
|
|
|
113
|
+
if (requestParameters['reportedOnly'] != null) {
|
|
114
|
+
queryParameters['reported_only'] = requestParameters['reportedOnly'];
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
if (requestParameters['displaySign'] != null) {
|
|
118
|
+
queryParameters['display_sign'] = requestParameters['displaySign'];
|
|
119
|
+
}
|
|
120
|
+
|
|
107
121
|
const headerParameters: runtime.HTTPHeaders = {};
|
|
108
122
|
|
|
109
123
|
if (this.configuration && this.configuration.accessToken) {
|
|
@@ -189,6 +203,14 @@ export class AsReportedCashFlowStatementApi extends runtime.BaseAPI {
|
|
|
189
203
|
queryParameters['with_formula'] = requestParameters['withFormula'];
|
|
190
204
|
}
|
|
191
205
|
|
|
206
|
+
if (requestParameters['reportedOnly'] != null) {
|
|
207
|
+
queryParameters['reported_only'] = requestParameters['reportedOnly'];
|
|
208
|
+
}
|
|
209
|
+
|
|
210
|
+
if (requestParameters['displaySign'] != null) {
|
|
211
|
+
queryParameters['display_sign'] = requestParameters['displaySign'];
|
|
212
|
+
}
|
|
213
|
+
|
|
192
214
|
const headerParameters: runtime.HTTPHeaders = {};
|
|
193
215
|
|
|
194
216
|
if (this.configuration && this.configuration.accessToken) {
|
|
@@ -211,7 +233,7 @@ export class AsReportedCashFlowStatementApi extends runtime.BaseAPI {
|
|
|
211
233
|
}
|
|
212
234
|
|
|
213
235
|
/**
|
|
214
|
-
* Fetch detailed as-reported cash flow statement data with
|
|
236
|
+
* Fetch detailed as-reported cash flow statement data with derived flag, taxonomy and company labels, decimals, accession number, html tag id and optional formula. Minimum tier for redistribute: PRO.
|
|
215
237
|
* As-reported cash flow statement (detailed)
|
|
216
238
|
*/
|
|
217
239
|
async asReportedCashFlowStatementDetailedRaw(requestParameters: AsReportedCashFlowStatementDetailedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AsReportedIncomeStatementDetailed200Response>> {
|
|
@@ -222,7 +244,7 @@ export class AsReportedCashFlowStatementApi extends runtime.BaseAPI {
|
|
|
222
244
|
}
|
|
223
245
|
|
|
224
246
|
/**
|
|
225
|
-
* Fetch detailed as-reported cash flow statement data with
|
|
247
|
+
* Fetch detailed as-reported cash flow statement data with derived flag, taxonomy and company labels, decimals, accession number, html tag id and optional formula. Minimum tier for redistribute: PRO.
|
|
226
248
|
* As-reported cash flow statement (detailed)
|
|
227
249
|
*/
|
|
228
250
|
async asReportedCashFlowStatementDetailed(requestParameters: AsReportedCashFlowStatementDetailedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AsReportedIncomeStatementDetailed200Response> {
|
|
@@ -270,6 +292,14 @@ export class AsReportedCashFlowStatementApi extends runtime.BaseAPI {
|
|
|
270
292
|
queryParameters['offset'] = requestParameters['offset'];
|
|
271
293
|
}
|
|
272
294
|
|
|
295
|
+
if (requestParameters['reportedOnly'] != null) {
|
|
296
|
+
queryParameters['reported_only'] = requestParameters['reportedOnly'];
|
|
297
|
+
}
|
|
298
|
+
|
|
299
|
+
if (requestParameters['displaySign'] != null) {
|
|
300
|
+
queryParameters['display_sign'] = requestParameters['displaySign'];
|
|
301
|
+
}
|
|
302
|
+
|
|
273
303
|
const headerParameters: runtime.HTTPHeaders = {};
|
|
274
304
|
|
|
275
305
|
if (this.configuration && this.configuration.accessToken) {
|
|
@@ -331,6 +361,22 @@ export const AsReportedCashFlowStatementSortEnum = {
|
|
|
331
361
|
Desc: 'desc'
|
|
332
362
|
} as const;
|
|
333
363
|
export type AsReportedCashFlowStatementSortEnum = typeof AsReportedCashFlowStatementSortEnum[keyof typeof AsReportedCashFlowStatementSortEnum];
|
|
364
|
+
/**
|
|
365
|
+
* @export
|
|
366
|
+
*/
|
|
367
|
+
export const AsReportedCashFlowStatementReportedOnlyEnum = {
|
|
368
|
+
True: 'true',
|
|
369
|
+
False: 'false'
|
|
370
|
+
} as const;
|
|
371
|
+
export type AsReportedCashFlowStatementReportedOnlyEnum = typeof AsReportedCashFlowStatementReportedOnlyEnum[keyof typeof AsReportedCashFlowStatementReportedOnlyEnum];
|
|
372
|
+
/**
|
|
373
|
+
* @export
|
|
374
|
+
*/
|
|
375
|
+
export const AsReportedCashFlowStatementDisplaySignEnum = {
|
|
376
|
+
AsFiled: 'as_filed',
|
|
377
|
+
CashFlowDirection: 'cash_flow_direction'
|
|
378
|
+
} as const;
|
|
379
|
+
export type AsReportedCashFlowStatementDisplaySignEnum = typeof AsReportedCashFlowStatementDisplaySignEnum[keyof typeof AsReportedCashFlowStatementDisplaySignEnum];
|
|
334
380
|
/**
|
|
335
381
|
* @export
|
|
336
382
|
*/
|
|
@@ -357,6 +403,22 @@ export const AsReportedCashFlowStatementDetailedWithFormulaEnum = {
|
|
|
357
403
|
False: 'false'
|
|
358
404
|
} as const;
|
|
359
405
|
export type AsReportedCashFlowStatementDetailedWithFormulaEnum = typeof AsReportedCashFlowStatementDetailedWithFormulaEnum[keyof typeof AsReportedCashFlowStatementDetailedWithFormulaEnum];
|
|
406
|
+
/**
|
|
407
|
+
* @export
|
|
408
|
+
*/
|
|
409
|
+
export const AsReportedCashFlowStatementDetailedReportedOnlyEnum = {
|
|
410
|
+
True: 'true',
|
|
411
|
+
False: 'false'
|
|
412
|
+
} as const;
|
|
413
|
+
export type AsReportedCashFlowStatementDetailedReportedOnlyEnum = typeof AsReportedCashFlowStatementDetailedReportedOnlyEnum[keyof typeof AsReportedCashFlowStatementDetailedReportedOnlyEnum];
|
|
414
|
+
/**
|
|
415
|
+
* @export
|
|
416
|
+
*/
|
|
417
|
+
export const AsReportedCashFlowStatementDetailedDisplaySignEnum = {
|
|
418
|
+
AsFiled: 'as_filed',
|
|
419
|
+
CashFlowDirection: 'cash_flow_direction'
|
|
420
|
+
} as const;
|
|
421
|
+
export type AsReportedCashFlowStatementDetailedDisplaySignEnum = typeof AsReportedCashFlowStatementDetailedDisplaySignEnum[keyof typeof AsReportedCashFlowStatementDetailedDisplaySignEnum];
|
|
360
422
|
/**
|
|
361
423
|
* @export
|
|
362
424
|
*/
|
|
@@ -375,3 +437,19 @@ export const AsReportedCashFlowStatementPresentationSortEnum = {
|
|
|
375
437
|
Desc: 'desc'
|
|
376
438
|
} as const;
|
|
377
439
|
export type AsReportedCashFlowStatementPresentationSortEnum = typeof AsReportedCashFlowStatementPresentationSortEnum[keyof typeof AsReportedCashFlowStatementPresentationSortEnum];
|
|
440
|
+
/**
|
|
441
|
+
* @export
|
|
442
|
+
*/
|
|
443
|
+
export const AsReportedCashFlowStatementPresentationReportedOnlyEnum = {
|
|
444
|
+
True: 'true',
|
|
445
|
+
False: 'false'
|
|
446
|
+
} as const;
|
|
447
|
+
export type AsReportedCashFlowStatementPresentationReportedOnlyEnum = typeof AsReportedCashFlowStatementPresentationReportedOnlyEnum[keyof typeof AsReportedCashFlowStatementPresentationReportedOnlyEnum];
|
|
448
|
+
/**
|
|
449
|
+
* @export
|
|
450
|
+
*/
|
|
451
|
+
export const AsReportedCashFlowStatementPresentationDisplaySignEnum = {
|
|
452
|
+
AsFiled: 'as_filed',
|
|
453
|
+
CashFlowDirection: 'cash_flow_direction'
|
|
454
|
+
} as const;
|
|
455
|
+
export type AsReportedCashFlowStatementPresentationDisplaySignEnum = typeof AsReportedCashFlowStatementPresentationDisplaySignEnum[keyof typeof AsReportedCashFlowStatementPresentationDisplaySignEnum];
|
|
@@ -40,6 +40,7 @@ export interface AsReportedIncomeStatementRequest {
|
|
|
40
40
|
sort?: AsReportedIncomeStatementSortEnum;
|
|
41
41
|
limit?: number;
|
|
42
42
|
offset?: number;
|
|
43
|
+
reportedOnly?: AsReportedIncomeStatementReportedOnlyEnum;
|
|
43
44
|
}
|
|
44
45
|
|
|
45
46
|
export interface AsReportedIncomeStatementDetailedRequest {
|
|
@@ -49,6 +50,7 @@ export interface AsReportedIncomeStatementDetailedRequest {
|
|
|
49
50
|
limit?: number;
|
|
50
51
|
offset?: number;
|
|
51
52
|
withFormula?: AsReportedIncomeStatementDetailedWithFormulaEnum;
|
|
53
|
+
reportedOnly?: AsReportedIncomeStatementDetailedReportedOnlyEnum;
|
|
52
54
|
}
|
|
53
55
|
|
|
54
56
|
export interface AsReportedIncomeStatementPresentationRequest {
|
|
@@ -57,6 +59,7 @@ export interface AsReportedIncomeStatementPresentationRequest {
|
|
|
57
59
|
sort?: AsReportedIncomeStatementPresentationSortEnum;
|
|
58
60
|
limit?: number;
|
|
59
61
|
offset?: number;
|
|
62
|
+
reportedOnly?: AsReportedIncomeStatementPresentationReportedOnlyEnum;
|
|
60
63
|
}
|
|
61
64
|
|
|
62
65
|
/**
|
|
@@ -104,6 +107,10 @@ export class AsReportedIncomeStatementApi extends runtime.BaseAPI {
|
|
|
104
107
|
queryParameters['offset'] = requestParameters['offset'];
|
|
105
108
|
}
|
|
106
109
|
|
|
110
|
+
if (requestParameters['reportedOnly'] != null) {
|
|
111
|
+
queryParameters['reported_only'] = requestParameters['reportedOnly'];
|
|
112
|
+
}
|
|
113
|
+
|
|
107
114
|
const headerParameters: runtime.HTTPHeaders = {};
|
|
108
115
|
|
|
109
116
|
if (this.configuration && this.configuration.accessToken) {
|
|
@@ -189,6 +196,10 @@ export class AsReportedIncomeStatementApi extends runtime.BaseAPI {
|
|
|
189
196
|
queryParameters['with_formula'] = requestParameters['withFormula'];
|
|
190
197
|
}
|
|
191
198
|
|
|
199
|
+
if (requestParameters['reportedOnly'] != null) {
|
|
200
|
+
queryParameters['reported_only'] = requestParameters['reportedOnly'];
|
|
201
|
+
}
|
|
202
|
+
|
|
192
203
|
const headerParameters: runtime.HTTPHeaders = {};
|
|
193
204
|
|
|
194
205
|
if (this.configuration && this.configuration.accessToken) {
|
|
@@ -211,7 +222,7 @@ export class AsReportedIncomeStatementApi extends runtime.BaseAPI {
|
|
|
211
222
|
}
|
|
212
223
|
|
|
213
224
|
/**
|
|
214
|
-
* Fetch detailed as-reported income statement data with
|
|
225
|
+
* Fetch detailed as-reported income statement data with derived flag, taxonomy and company labels, decimals, accession number, html tag id and optional formula. Minimum tier for redistribute: PRO.
|
|
215
226
|
* As-reported income statement (detailed)
|
|
216
227
|
*/
|
|
217
228
|
async asReportedIncomeStatementDetailedRaw(requestParameters: AsReportedIncomeStatementDetailedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AsReportedIncomeStatementDetailed200Response>> {
|
|
@@ -222,7 +233,7 @@ export class AsReportedIncomeStatementApi extends runtime.BaseAPI {
|
|
|
222
233
|
}
|
|
223
234
|
|
|
224
235
|
/**
|
|
225
|
-
* Fetch detailed as-reported income statement data with
|
|
236
|
+
* Fetch detailed as-reported income statement data with derived flag, taxonomy and company labels, decimals, accession number, html tag id and optional formula. Minimum tier for redistribute: PRO.
|
|
226
237
|
* As-reported income statement (detailed)
|
|
227
238
|
*/
|
|
228
239
|
async asReportedIncomeStatementDetailed(requestParameters: AsReportedIncomeStatementDetailedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AsReportedIncomeStatementDetailed200Response> {
|
|
@@ -270,6 +281,10 @@ export class AsReportedIncomeStatementApi extends runtime.BaseAPI {
|
|
|
270
281
|
queryParameters['offset'] = requestParameters['offset'];
|
|
271
282
|
}
|
|
272
283
|
|
|
284
|
+
if (requestParameters['reportedOnly'] != null) {
|
|
285
|
+
queryParameters['reported_only'] = requestParameters['reportedOnly'];
|
|
286
|
+
}
|
|
287
|
+
|
|
273
288
|
const headerParameters: runtime.HTTPHeaders = {};
|
|
274
289
|
|
|
275
290
|
if (this.configuration && this.configuration.accessToken) {
|
|
@@ -331,6 +346,14 @@ export const AsReportedIncomeStatementSortEnum = {
|
|
|
331
346
|
Desc: 'desc'
|
|
332
347
|
} as const;
|
|
333
348
|
export type AsReportedIncomeStatementSortEnum = typeof AsReportedIncomeStatementSortEnum[keyof typeof AsReportedIncomeStatementSortEnum];
|
|
349
|
+
/**
|
|
350
|
+
* @export
|
|
351
|
+
*/
|
|
352
|
+
export const AsReportedIncomeStatementReportedOnlyEnum = {
|
|
353
|
+
True: 'true',
|
|
354
|
+
False: 'false'
|
|
355
|
+
} as const;
|
|
356
|
+
export type AsReportedIncomeStatementReportedOnlyEnum = typeof AsReportedIncomeStatementReportedOnlyEnum[keyof typeof AsReportedIncomeStatementReportedOnlyEnum];
|
|
334
357
|
/**
|
|
335
358
|
* @export
|
|
336
359
|
*/
|
|
@@ -357,6 +380,14 @@ export const AsReportedIncomeStatementDetailedWithFormulaEnum = {
|
|
|
357
380
|
False: 'false'
|
|
358
381
|
} as const;
|
|
359
382
|
export type AsReportedIncomeStatementDetailedWithFormulaEnum = typeof AsReportedIncomeStatementDetailedWithFormulaEnum[keyof typeof AsReportedIncomeStatementDetailedWithFormulaEnum];
|
|
383
|
+
/**
|
|
384
|
+
* @export
|
|
385
|
+
*/
|
|
386
|
+
export const AsReportedIncomeStatementDetailedReportedOnlyEnum = {
|
|
387
|
+
True: 'true',
|
|
388
|
+
False: 'false'
|
|
389
|
+
} as const;
|
|
390
|
+
export type AsReportedIncomeStatementDetailedReportedOnlyEnum = typeof AsReportedIncomeStatementDetailedReportedOnlyEnum[keyof typeof AsReportedIncomeStatementDetailedReportedOnlyEnum];
|
|
360
391
|
/**
|
|
361
392
|
* @export
|
|
362
393
|
*/
|
|
@@ -375,3 +406,11 @@ export const AsReportedIncomeStatementPresentationSortEnum = {
|
|
|
375
406
|
Desc: 'desc'
|
|
376
407
|
} as const;
|
|
377
408
|
export type AsReportedIncomeStatementPresentationSortEnum = typeof AsReportedIncomeStatementPresentationSortEnum[keyof typeof AsReportedIncomeStatementPresentationSortEnum];
|
|
409
|
+
/**
|
|
410
|
+
* @export
|
|
411
|
+
*/
|
|
412
|
+
export const AsReportedIncomeStatementPresentationReportedOnlyEnum = {
|
|
413
|
+
True: 'true',
|
|
414
|
+
False: 'false'
|
|
415
|
+
} as const;
|
|
416
|
+
export type AsReportedIncomeStatementPresentationReportedOnlyEnum = typeof AsReportedIncomeStatementPresentationReportedOnlyEnum[keyof typeof AsReportedIncomeStatementPresentationReportedOnlyEnum];
|