@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
|
@@ -19,6 +19,7 @@ export interface AsReportedIncomeStatementRequest {
|
|
|
19
19
|
sort?: AsReportedIncomeStatementSortEnum;
|
|
20
20
|
limit?: number;
|
|
21
21
|
offset?: number;
|
|
22
|
+
reportedOnly?: AsReportedIncomeStatementReportedOnlyEnum;
|
|
22
23
|
}
|
|
23
24
|
export interface AsReportedIncomeStatementDetailedRequest {
|
|
24
25
|
identifier: string;
|
|
@@ -27,6 +28,7 @@ export interface AsReportedIncomeStatementDetailedRequest {
|
|
|
27
28
|
limit?: number;
|
|
28
29
|
offset?: number;
|
|
29
30
|
withFormula?: AsReportedIncomeStatementDetailedWithFormulaEnum;
|
|
31
|
+
reportedOnly?: AsReportedIncomeStatementDetailedReportedOnlyEnum;
|
|
30
32
|
}
|
|
31
33
|
export interface AsReportedIncomeStatementPresentationRequest {
|
|
32
34
|
identifier: string;
|
|
@@ -34,6 +36,7 @@ export interface AsReportedIncomeStatementPresentationRequest {
|
|
|
34
36
|
sort?: AsReportedIncomeStatementPresentationSortEnum;
|
|
35
37
|
limit?: number;
|
|
36
38
|
offset?: number;
|
|
39
|
+
reportedOnly?: AsReportedIncomeStatementPresentationReportedOnlyEnum;
|
|
37
40
|
}
|
|
38
41
|
/**
|
|
39
42
|
*
|
|
@@ -58,12 +61,12 @@ export declare class AsReportedIncomeStatementApi extends runtime.BaseAPI {
|
|
|
58
61
|
*/
|
|
59
62
|
asReportedIncomeStatementDetailedRequestOpts(requestParameters: AsReportedIncomeStatementDetailedRequest): Promise<runtime.RequestOpts>;
|
|
60
63
|
/**
|
|
61
|
-
* Fetch detailed as-reported income statement data with
|
|
64
|
+
* 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.
|
|
62
65
|
* As-reported income statement (detailed)
|
|
63
66
|
*/
|
|
64
67
|
asReportedIncomeStatementDetailedRaw(requestParameters: AsReportedIncomeStatementDetailedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AsReportedIncomeStatementDetailed200Response>>;
|
|
65
68
|
/**
|
|
66
|
-
* Fetch detailed as-reported income statement data with
|
|
69
|
+
* 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.
|
|
67
70
|
* As-reported income statement (detailed)
|
|
68
71
|
*/
|
|
69
72
|
asReportedIncomeStatementDetailed(requestParameters: AsReportedIncomeStatementDetailedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AsReportedIncomeStatementDetailed200Response>;
|
|
@@ -100,6 +103,14 @@ export declare const AsReportedIncomeStatementSortEnum: {
|
|
|
100
103
|
readonly Desc: "desc";
|
|
101
104
|
};
|
|
102
105
|
export type AsReportedIncomeStatementSortEnum = typeof AsReportedIncomeStatementSortEnum[keyof typeof AsReportedIncomeStatementSortEnum];
|
|
106
|
+
/**
|
|
107
|
+
* @export
|
|
108
|
+
*/
|
|
109
|
+
export declare const AsReportedIncomeStatementReportedOnlyEnum: {
|
|
110
|
+
readonly True: "true";
|
|
111
|
+
readonly False: "false";
|
|
112
|
+
};
|
|
113
|
+
export type AsReportedIncomeStatementReportedOnlyEnum = typeof AsReportedIncomeStatementReportedOnlyEnum[keyof typeof AsReportedIncomeStatementReportedOnlyEnum];
|
|
103
114
|
/**
|
|
104
115
|
* @export
|
|
105
116
|
*/
|
|
@@ -126,6 +137,14 @@ export declare const AsReportedIncomeStatementDetailedWithFormulaEnum: {
|
|
|
126
137
|
readonly False: "false";
|
|
127
138
|
};
|
|
128
139
|
export type AsReportedIncomeStatementDetailedWithFormulaEnum = typeof AsReportedIncomeStatementDetailedWithFormulaEnum[keyof typeof AsReportedIncomeStatementDetailedWithFormulaEnum];
|
|
140
|
+
/**
|
|
141
|
+
* @export
|
|
142
|
+
*/
|
|
143
|
+
export declare const AsReportedIncomeStatementDetailedReportedOnlyEnum: {
|
|
144
|
+
readonly True: "true";
|
|
145
|
+
readonly False: "false";
|
|
146
|
+
};
|
|
147
|
+
export type AsReportedIncomeStatementDetailedReportedOnlyEnum = typeof AsReportedIncomeStatementDetailedReportedOnlyEnum[keyof typeof AsReportedIncomeStatementDetailedReportedOnlyEnum];
|
|
129
148
|
/**
|
|
130
149
|
* @export
|
|
131
150
|
*/
|
|
@@ -144,3 +163,11 @@ export declare const AsReportedIncomeStatementPresentationSortEnum: {
|
|
|
144
163
|
readonly Desc: "desc";
|
|
145
164
|
};
|
|
146
165
|
export type AsReportedIncomeStatementPresentationSortEnum = typeof AsReportedIncomeStatementPresentationSortEnum[keyof typeof AsReportedIncomeStatementPresentationSortEnum];
|
|
166
|
+
/**
|
|
167
|
+
* @export
|
|
168
|
+
*/
|
|
169
|
+
export declare const AsReportedIncomeStatementPresentationReportedOnlyEnum: {
|
|
170
|
+
readonly True: "true";
|
|
171
|
+
readonly False: "false";
|
|
172
|
+
};
|
|
173
|
+
export type AsReportedIncomeStatementPresentationReportedOnlyEnum = typeof AsReportedIncomeStatementPresentationReportedOnlyEnum[keyof typeof AsReportedIncomeStatementPresentationReportedOnlyEnum];
|
|
@@ -55,6 +55,9 @@ export class AsReportedIncomeStatementApi extends runtime.BaseAPI {
|
|
|
55
55
|
if (requestParameters['offset'] != null) {
|
|
56
56
|
queryParameters['offset'] = requestParameters['offset'];
|
|
57
57
|
}
|
|
58
|
+
if (requestParameters['reportedOnly'] != null) {
|
|
59
|
+
queryParameters['reported_only'] = requestParameters['reportedOnly'];
|
|
60
|
+
}
|
|
58
61
|
const headerParameters = {};
|
|
59
62
|
if (this.configuration && this.configuration.accessToken) {
|
|
60
63
|
const token = this.configuration.accessToken;
|
|
@@ -123,6 +126,9 @@ export class AsReportedIncomeStatementApi extends runtime.BaseAPI {
|
|
|
123
126
|
if (requestParameters['withFormula'] != null) {
|
|
124
127
|
queryParameters['with_formula'] = requestParameters['withFormula'];
|
|
125
128
|
}
|
|
129
|
+
if (requestParameters['reportedOnly'] != null) {
|
|
130
|
+
queryParameters['reported_only'] = requestParameters['reportedOnly'];
|
|
131
|
+
}
|
|
126
132
|
const headerParameters = {};
|
|
127
133
|
if (this.configuration && this.configuration.accessToken) {
|
|
128
134
|
const token = this.configuration.accessToken;
|
|
@@ -141,7 +147,7 @@ export class AsReportedIncomeStatementApi extends runtime.BaseAPI {
|
|
|
141
147
|
});
|
|
142
148
|
}
|
|
143
149
|
/**
|
|
144
|
-
* Fetch detailed as-reported income statement data with
|
|
150
|
+
* 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.
|
|
145
151
|
* As-reported income statement (detailed)
|
|
146
152
|
*/
|
|
147
153
|
asReportedIncomeStatementDetailedRaw(requestParameters, initOverrides) {
|
|
@@ -152,7 +158,7 @@ export class AsReportedIncomeStatementApi extends runtime.BaseAPI {
|
|
|
152
158
|
});
|
|
153
159
|
}
|
|
154
160
|
/**
|
|
155
|
-
* Fetch detailed as-reported income statement data with
|
|
161
|
+
* 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.
|
|
156
162
|
* As-reported income statement (detailed)
|
|
157
163
|
*/
|
|
158
164
|
asReportedIncomeStatementDetailed(requestParameters, initOverrides) {
|
|
@@ -188,6 +194,9 @@ export class AsReportedIncomeStatementApi extends runtime.BaseAPI {
|
|
|
188
194
|
if (requestParameters['offset'] != null) {
|
|
189
195
|
queryParameters['offset'] = requestParameters['offset'];
|
|
190
196
|
}
|
|
197
|
+
if (requestParameters['reportedOnly'] != null) {
|
|
198
|
+
queryParameters['reported_only'] = requestParameters['reportedOnly'];
|
|
199
|
+
}
|
|
191
200
|
const headerParameters = {};
|
|
192
201
|
if (this.configuration && this.configuration.accessToken) {
|
|
193
202
|
const token = this.configuration.accessToken;
|
|
@@ -243,6 +252,13 @@ export const AsReportedIncomeStatementSortEnum = {
|
|
|
243
252
|
Asc: 'asc',
|
|
244
253
|
Desc: 'desc'
|
|
245
254
|
};
|
|
255
|
+
/**
|
|
256
|
+
* @export
|
|
257
|
+
*/
|
|
258
|
+
export const AsReportedIncomeStatementReportedOnlyEnum = {
|
|
259
|
+
True: 'true',
|
|
260
|
+
False: 'false'
|
|
261
|
+
};
|
|
246
262
|
/**
|
|
247
263
|
* @export
|
|
248
264
|
*/
|
|
@@ -266,6 +282,13 @@ export const AsReportedIncomeStatementDetailedWithFormulaEnum = {
|
|
|
266
282
|
True: 'true',
|
|
267
283
|
False: 'false'
|
|
268
284
|
};
|
|
285
|
+
/**
|
|
286
|
+
* @export
|
|
287
|
+
*/
|
|
288
|
+
export const AsReportedIncomeStatementDetailedReportedOnlyEnum = {
|
|
289
|
+
True: 'true',
|
|
290
|
+
False: 'false'
|
|
291
|
+
};
|
|
269
292
|
/**
|
|
270
293
|
* @export
|
|
271
294
|
*/
|
|
@@ -282,3 +305,10 @@ export const AsReportedIncomeStatementPresentationSortEnum = {
|
|
|
282
305
|
Asc: 'asc',
|
|
283
306
|
Desc: 'desc'
|
|
284
307
|
};
|
|
308
|
+
/**
|
|
309
|
+
* @export
|
|
310
|
+
*/
|
|
311
|
+
export const AsReportedIncomeStatementPresentationReportedOnlyEnum = {
|
|
312
|
+
True: 'true',
|
|
313
|
+
False: 'false'
|
|
314
|
+
};
|
|
@@ -10,20 +10,24 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
+
import { type AsReportedSnapshot200Response } from '../models/AsReportedSnapshot200Response';
|
|
13
14
|
import { type AsReportedSnapshotDetailed200Response } from '../models/AsReportedSnapshotDetailed200Response';
|
|
14
15
|
import { type AsReportedSnapshotPresentation200Response } from '../models/AsReportedSnapshotPresentation200Response';
|
|
15
|
-
import { type StandardizedSnapshot200Response } from '../models/StandardizedSnapshot200Response';
|
|
16
16
|
export interface AsReportedSnapshotRequest {
|
|
17
17
|
identifiers: string;
|
|
18
18
|
fiscalPeriodType: AsReportedSnapshotFiscalPeriodTypeEnum;
|
|
19
19
|
calendarYear?: number;
|
|
20
20
|
calendarQuarter?: number;
|
|
21
|
+
reportedOnly?: AsReportedSnapshotReportedOnlyEnum;
|
|
22
|
+
displaySign?: AsReportedSnapshotDisplaySignEnum;
|
|
21
23
|
}
|
|
22
24
|
export interface AsReportedSnapshotDetailedRequest {
|
|
23
25
|
identifiers: string;
|
|
24
26
|
fiscalPeriodType: AsReportedSnapshotDetailedFiscalPeriodTypeEnum;
|
|
25
27
|
calendarYear?: number;
|
|
26
28
|
calendarQuarter?: number;
|
|
29
|
+
reportedOnly?: AsReportedSnapshotDetailedReportedOnlyEnum;
|
|
30
|
+
displaySign?: AsReportedSnapshotDetailedDisplaySignEnum;
|
|
27
31
|
withFormula?: AsReportedSnapshotDetailedWithFormulaEnum;
|
|
28
32
|
}
|
|
29
33
|
export interface AsReportedSnapshotPresentationRequest {
|
|
@@ -31,6 +35,8 @@ export interface AsReportedSnapshotPresentationRequest {
|
|
|
31
35
|
fiscalPeriodType: AsReportedSnapshotPresentationFiscalPeriodTypeEnum;
|
|
32
36
|
calendarYear?: number;
|
|
33
37
|
calendarQuarter?: number;
|
|
38
|
+
reportedOnly?: AsReportedSnapshotPresentationReportedOnlyEnum;
|
|
39
|
+
displaySign?: AsReportedSnapshotPresentationDisplaySignEnum;
|
|
34
40
|
}
|
|
35
41
|
/**
|
|
36
42
|
*
|
|
@@ -44,23 +50,23 @@ export declare class AsReportedSnapshotApi extends runtime.BaseAPI {
|
|
|
44
50
|
* Fetch latest complete as-reported financial statements snapshot for multiple companies. Minimum tier for redistribute: PRO.
|
|
45
51
|
* As-reported snapshot
|
|
46
52
|
*/
|
|
47
|
-
asReportedSnapshotRaw(requestParameters: AsReportedSnapshotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
53
|
+
asReportedSnapshotRaw(requestParameters: AsReportedSnapshotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AsReportedSnapshot200Response>>;
|
|
48
54
|
/**
|
|
49
55
|
* Fetch latest complete as-reported financial statements snapshot for multiple companies. Minimum tier for redistribute: PRO.
|
|
50
56
|
* As-reported snapshot
|
|
51
57
|
*/
|
|
52
|
-
asReportedSnapshot(requestParameters: AsReportedSnapshotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
58
|
+
asReportedSnapshot(requestParameters: AsReportedSnapshotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AsReportedSnapshot200Response>;
|
|
53
59
|
/**
|
|
54
60
|
* Creates request options for asReportedSnapshotDetailed without sending the request
|
|
55
61
|
*/
|
|
56
62
|
asReportedSnapshotDetailedRequestOpts(requestParameters: AsReportedSnapshotDetailedRequest): Promise<runtime.RequestOpts>;
|
|
57
63
|
/**
|
|
58
|
-
* Fetch latest complete detailed as-reported financial statements snapshot with
|
|
64
|
+
* 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.
|
|
59
65
|
* As-reported snapshot (detailed)
|
|
60
66
|
*/
|
|
61
67
|
asReportedSnapshotDetailedRaw(requestParameters: AsReportedSnapshotDetailedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AsReportedSnapshotDetailed200Response>>;
|
|
62
68
|
/**
|
|
63
|
-
* Fetch latest complete detailed as-reported financial statements snapshot with
|
|
69
|
+
* 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.
|
|
64
70
|
* As-reported snapshot (detailed)
|
|
65
71
|
*/
|
|
66
72
|
asReportedSnapshotDetailed(requestParameters: AsReportedSnapshotDetailedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AsReportedSnapshotDetailed200Response>;
|
|
@@ -89,6 +95,22 @@ export declare const AsReportedSnapshotFiscalPeriodTypeEnum: {
|
|
|
89
95
|
readonly Ttm: "ttm";
|
|
90
96
|
};
|
|
91
97
|
export type AsReportedSnapshotFiscalPeriodTypeEnum = typeof AsReportedSnapshotFiscalPeriodTypeEnum[keyof typeof AsReportedSnapshotFiscalPeriodTypeEnum];
|
|
98
|
+
/**
|
|
99
|
+
* @export
|
|
100
|
+
*/
|
|
101
|
+
export declare const AsReportedSnapshotReportedOnlyEnum: {
|
|
102
|
+
readonly True: "true";
|
|
103
|
+
readonly False: "false";
|
|
104
|
+
};
|
|
105
|
+
export type AsReportedSnapshotReportedOnlyEnum = typeof AsReportedSnapshotReportedOnlyEnum[keyof typeof AsReportedSnapshotReportedOnlyEnum];
|
|
106
|
+
/**
|
|
107
|
+
* @export
|
|
108
|
+
*/
|
|
109
|
+
export declare const AsReportedSnapshotDisplaySignEnum: {
|
|
110
|
+
readonly AsFiled: "as_filed";
|
|
111
|
+
readonly CashFlowDirection: "cash_flow_direction";
|
|
112
|
+
};
|
|
113
|
+
export type AsReportedSnapshotDisplaySignEnum = typeof AsReportedSnapshotDisplaySignEnum[keyof typeof AsReportedSnapshotDisplaySignEnum];
|
|
92
114
|
/**
|
|
93
115
|
* @export
|
|
94
116
|
*/
|
|
@@ -99,6 +121,22 @@ export declare const AsReportedSnapshotDetailedFiscalPeriodTypeEnum: {
|
|
|
99
121
|
readonly Ttm: "ttm";
|
|
100
122
|
};
|
|
101
123
|
export type AsReportedSnapshotDetailedFiscalPeriodTypeEnum = typeof AsReportedSnapshotDetailedFiscalPeriodTypeEnum[keyof typeof AsReportedSnapshotDetailedFiscalPeriodTypeEnum];
|
|
124
|
+
/**
|
|
125
|
+
* @export
|
|
126
|
+
*/
|
|
127
|
+
export declare const AsReportedSnapshotDetailedReportedOnlyEnum: {
|
|
128
|
+
readonly True: "true";
|
|
129
|
+
readonly False: "false";
|
|
130
|
+
};
|
|
131
|
+
export type AsReportedSnapshotDetailedReportedOnlyEnum = typeof AsReportedSnapshotDetailedReportedOnlyEnum[keyof typeof AsReportedSnapshotDetailedReportedOnlyEnum];
|
|
132
|
+
/**
|
|
133
|
+
* @export
|
|
134
|
+
*/
|
|
135
|
+
export declare const AsReportedSnapshotDetailedDisplaySignEnum: {
|
|
136
|
+
readonly AsFiled: "as_filed";
|
|
137
|
+
readonly CashFlowDirection: "cash_flow_direction";
|
|
138
|
+
};
|
|
139
|
+
export type AsReportedSnapshotDetailedDisplaySignEnum = typeof AsReportedSnapshotDetailedDisplaySignEnum[keyof typeof AsReportedSnapshotDetailedDisplaySignEnum];
|
|
102
140
|
/**
|
|
103
141
|
* @export
|
|
104
142
|
*/
|
|
@@ -117,3 +155,19 @@ export declare const AsReportedSnapshotPresentationFiscalPeriodTypeEnum: {
|
|
|
117
155
|
readonly Ttm: "ttm";
|
|
118
156
|
};
|
|
119
157
|
export type AsReportedSnapshotPresentationFiscalPeriodTypeEnum = typeof AsReportedSnapshotPresentationFiscalPeriodTypeEnum[keyof typeof AsReportedSnapshotPresentationFiscalPeriodTypeEnum];
|
|
158
|
+
/**
|
|
159
|
+
* @export
|
|
160
|
+
*/
|
|
161
|
+
export declare const AsReportedSnapshotPresentationReportedOnlyEnum: {
|
|
162
|
+
readonly True: "true";
|
|
163
|
+
readonly False: "false";
|
|
164
|
+
};
|
|
165
|
+
export type AsReportedSnapshotPresentationReportedOnlyEnum = typeof AsReportedSnapshotPresentationReportedOnlyEnum[keyof typeof AsReportedSnapshotPresentationReportedOnlyEnum];
|
|
166
|
+
/**
|
|
167
|
+
* @export
|
|
168
|
+
*/
|
|
169
|
+
export declare const AsReportedSnapshotPresentationDisplaySignEnum: {
|
|
170
|
+
readonly AsFiled: "as_filed";
|
|
171
|
+
readonly CashFlowDirection: "cash_flow_direction";
|
|
172
|
+
};
|
|
173
|
+
export type AsReportedSnapshotPresentationDisplaySignEnum = typeof AsReportedSnapshotPresentationDisplaySignEnum[keyof typeof AsReportedSnapshotPresentationDisplaySignEnum];
|
|
@@ -21,9 +21,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
21
21
|
});
|
|
22
22
|
};
|
|
23
23
|
import * as runtime from '../runtime';
|
|
24
|
+
import { AsReportedSnapshot200ResponseFromJSON, } from '../models/AsReportedSnapshot200Response';
|
|
24
25
|
import { AsReportedSnapshotDetailed200ResponseFromJSON, } from '../models/AsReportedSnapshotDetailed200Response';
|
|
25
26
|
import { AsReportedSnapshotPresentation200ResponseFromJSON, } from '../models/AsReportedSnapshotPresentation200Response';
|
|
26
|
-
import { StandardizedSnapshot200ResponseFromJSON, } from '../models/StandardizedSnapshot200Response';
|
|
27
27
|
/**
|
|
28
28
|
*
|
|
29
29
|
*/
|
|
@@ -52,6 +52,12 @@ export class AsReportedSnapshotApi extends runtime.BaseAPI {
|
|
|
52
52
|
if (requestParameters['calendarQuarter'] != null) {
|
|
53
53
|
queryParameters['calendar_quarter'] = requestParameters['calendarQuarter'];
|
|
54
54
|
}
|
|
55
|
+
if (requestParameters['reportedOnly'] != null) {
|
|
56
|
+
queryParameters['reported_only'] = requestParameters['reportedOnly'];
|
|
57
|
+
}
|
|
58
|
+
if (requestParameters['displaySign'] != null) {
|
|
59
|
+
queryParameters['display_sign'] = requestParameters['displaySign'];
|
|
60
|
+
}
|
|
55
61
|
const headerParameters = {};
|
|
56
62
|
if (this.configuration && this.configuration.accessToken) {
|
|
57
63
|
const token = this.configuration.accessToken;
|
|
@@ -77,7 +83,7 @@ export class AsReportedSnapshotApi extends runtime.BaseAPI {
|
|
|
77
83
|
return __awaiter(this, void 0, void 0, function* () {
|
|
78
84
|
const requestOptions = yield this.asReportedSnapshotRequestOpts(requestParameters);
|
|
79
85
|
const response = yield this.request(requestOptions, initOverrides);
|
|
80
|
-
return new runtime.JSONApiResponse(response, (jsonValue) =>
|
|
86
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => AsReportedSnapshot200ResponseFromJSON(jsonValue));
|
|
81
87
|
});
|
|
82
88
|
}
|
|
83
89
|
/**
|
|
@@ -114,6 +120,12 @@ export class AsReportedSnapshotApi extends runtime.BaseAPI {
|
|
|
114
120
|
if (requestParameters['calendarQuarter'] != null) {
|
|
115
121
|
queryParameters['calendar_quarter'] = requestParameters['calendarQuarter'];
|
|
116
122
|
}
|
|
123
|
+
if (requestParameters['reportedOnly'] != null) {
|
|
124
|
+
queryParameters['reported_only'] = requestParameters['reportedOnly'];
|
|
125
|
+
}
|
|
126
|
+
if (requestParameters['displaySign'] != null) {
|
|
127
|
+
queryParameters['display_sign'] = requestParameters['displaySign'];
|
|
128
|
+
}
|
|
117
129
|
if (requestParameters['withFormula'] != null) {
|
|
118
130
|
queryParameters['with_formula'] = requestParameters['withFormula'];
|
|
119
131
|
}
|
|
@@ -135,7 +147,7 @@ export class AsReportedSnapshotApi extends runtime.BaseAPI {
|
|
|
135
147
|
});
|
|
136
148
|
}
|
|
137
149
|
/**
|
|
138
|
-
* Fetch latest complete detailed as-reported financial statements snapshot with
|
|
150
|
+
* 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.
|
|
139
151
|
* As-reported snapshot (detailed)
|
|
140
152
|
*/
|
|
141
153
|
asReportedSnapshotDetailedRaw(requestParameters, initOverrides) {
|
|
@@ -146,7 +158,7 @@ export class AsReportedSnapshotApi extends runtime.BaseAPI {
|
|
|
146
158
|
});
|
|
147
159
|
}
|
|
148
160
|
/**
|
|
149
|
-
* Fetch latest complete detailed as-reported financial statements snapshot with
|
|
161
|
+
* 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.
|
|
150
162
|
* As-reported snapshot (detailed)
|
|
151
163
|
*/
|
|
152
164
|
asReportedSnapshotDetailed(requestParameters, initOverrides) {
|
|
@@ -179,6 +191,12 @@ export class AsReportedSnapshotApi extends runtime.BaseAPI {
|
|
|
179
191
|
if (requestParameters['calendarQuarter'] != null) {
|
|
180
192
|
queryParameters['calendar_quarter'] = requestParameters['calendarQuarter'];
|
|
181
193
|
}
|
|
194
|
+
if (requestParameters['reportedOnly'] != null) {
|
|
195
|
+
queryParameters['reported_only'] = requestParameters['reportedOnly'];
|
|
196
|
+
}
|
|
197
|
+
if (requestParameters['displaySign'] != null) {
|
|
198
|
+
queryParameters['display_sign'] = requestParameters['displaySign'];
|
|
199
|
+
}
|
|
182
200
|
const headerParameters = {};
|
|
183
201
|
if (this.configuration && this.configuration.accessToken) {
|
|
184
202
|
const token = this.configuration.accessToken;
|
|
@@ -227,6 +245,20 @@ export const AsReportedSnapshotFiscalPeriodTypeEnum = {
|
|
|
227
245
|
Ytd: 'ytd',
|
|
228
246
|
Ttm: 'ttm'
|
|
229
247
|
};
|
|
248
|
+
/**
|
|
249
|
+
* @export
|
|
250
|
+
*/
|
|
251
|
+
export const AsReportedSnapshotReportedOnlyEnum = {
|
|
252
|
+
True: 'true',
|
|
253
|
+
False: 'false'
|
|
254
|
+
};
|
|
255
|
+
/**
|
|
256
|
+
* @export
|
|
257
|
+
*/
|
|
258
|
+
export const AsReportedSnapshotDisplaySignEnum = {
|
|
259
|
+
AsFiled: 'as_filed',
|
|
260
|
+
CashFlowDirection: 'cash_flow_direction'
|
|
261
|
+
};
|
|
230
262
|
/**
|
|
231
263
|
* @export
|
|
232
264
|
*/
|
|
@@ -236,6 +268,20 @@ export const AsReportedSnapshotDetailedFiscalPeriodTypeEnum = {
|
|
|
236
268
|
Ytd: 'ytd',
|
|
237
269
|
Ttm: 'ttm'
|
|
238
270
|
};
|
|
271
|
+
/**
|
|
272
|
+
* @export
|
|
273
|
+
*/
|
|
274
|
+
export const AsReportedSnapshotDetailedReportedOnlyEnum = {
|
|
275
|
+
True: 'true',
|
|
276
|
+
False: 'false'
|
|
277
|
+
};
|
|
278
|
+
/**
|
|
279
|
+
* @export
|
|
280
|
+
*/
|
|
281
|
+
export const AsReportedSnapshotDetailedDisplaySignEnum = {
|
|
282
|
+
AsFiled: 'as_filed',
|
|
283
|
+
CashFlowDirection: 'cash_flow_direction'
|
|
284
|
+
};
|
|
239
285
|
/**
|
|
240
286
|
* @export
|
|
241
287
|
*/
|
|
@@ -252,3 +298,17 @@ export const AsReportedSnapshotPresentationFiscalPeriodTypeEnum = {
|
|
|
252
298
|
Ytd: 'ytd',
|
|
253
299
|
Ttm: 'ttm'
|
|
254
300
|
};
|
|
301
|
+
/**
|
|
302
|
+
* @export
|
|
303
|
+
*/
|
|
304
|
+
export const AsReportedSnapshotPresentationReportedOnlyEnum = {
|
|
305
|
+
True: 'true',
|
|
306
|
+
False: 'false'
|
|
307
|
+
};
|
|
308
|
+
/**
|
|
309
|
+
* @export
|
|
310
|
+
*/
|
|
311
|
+
export const AsReportedSnapshotPresentationDisplaySignEnum = {
|
|
312
|
+
AsFiled: 'as_filed',
|
|
313
|
+
CashFlowDirection: 'cash_flow_direction'
|
|
314
|
+
};
|
|
@@ -13,45 +13,63 @@ import type { StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriod
|
|
|
13
13
|
/**
|
|
14
14
|
*
|
|
15
15
|
* @export
|
|
16
|
-
* @interface
|
|
16
|
+
* @interface AsReportedDetailedFact
|
|
17
17
|
*/
|
|
18
|
-
export interface
|
|
18
|
+
export interface AsReportedDetailedFact {
|
|
19
19
|
/**
|
|
20
|
-
*
|
|
20
|
+
* Fact value (as filed unless `display_sign=cash_flow_direction`)
|
|
21
21
|
* @type {number}
|
|
22
|
-
* @memberof
|
|
22
|
+
* @memberof AsReportedDetailedFact
|
|
23
23
|
*/
|
|
24
|
-
value
|
|
24
|
+
value: number;
|
|
25
25
|
/**
|
|
26
|
-
*
|
|
26
|
+
* true when Invinite computed the value (a Q4, TTM or YTD derivation, see `formula`); false = the company reported it
|
|
27
|
+
* @type {boolean}
|
|
28
|
+
* @memberof AsReportedDetailedFact
|
|
29
|
+
*/
|
|
30
|
+
derived: boolean;
|
|
31
|
+
/**
|
|
32
|
+
* The concept's taxonomy label
|
|
33
|
+
* @type {string}
|
|
34
|
+
* @memberof AsReportedDetailedFact
|
|
35
|
+
*/
|
|
36
|
+
label: string | null;
|
|
37
|
+
/**
|
|
38
|
+
* The company's own caption of the line item in the filing (null when it was not extracted)
|
|
27
39
|
* @type {string}
|
|
28
|
-
* @memberof
|
|
40
|
+
* @memberof AsReportedDetailedFact
|
|
41
|
+
*/
|
|
42
|
+
company_label: string | null;
|
|
43
|
+
/**
|
|
44
|
+
* XBRL decimals of the reported fact (-6 = rounded to millions); null = exact (INF) or not stated. A derived fact carries its source fact's
|
|
45
|
+
* @type {number}
|
|
46
|
+
* @memberof AsReportedDetailedFact
|
|
29
47
|
*/
|
|
30
|
-
|
|
48
|
+
decimals: number | null;
|
|
31
49
|
/**
|
|
32
50
|
*
|
|
33
51
|
* @type {StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormula}
|
|
34
|
-
* @memberof
|
|
52
|
+
* @memberof AsReportedDetailedFact
|
|
35
53
|
*/
|
|
36
54
|
formula?: StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormula | null;
|
|
37
55
|
/**
|
|
38
|
-
*
|
|
56
|
+
* Accession number of the filing that holds the value
|
|
39
57
|
* @type {string}
|
|
40
|
-
* @memberof
|
|
58
|
+
* @memberof AsReportedDetailedFact
|
|
41
59
|
*/
|
|
42
|
-
accession_number
|
|
60
|
+
accession_number: string | null;
|
|
43
61
|
/**
|
|
44
|
-
*
|
|
62
|
+
* Anchor of the fact in the filing's HTML (null on a derived fact)
|
|
45
63
|
* @type {string}
|
|
46
|
-
* @memberof
|
|
64
|
+
* @memberof AsReportedDetailedFact
|
|
47
65
|
*/
|
|
48
|
-
html_tag_id
|
|
66
|
+
html_tag_id: string | null;
|
|
49
67
|
}
|
|
50
68
|
/**
|
|
51
|
-
* Check if a given object implements the
|
|
69
|
+
* Check if a given object implements the AsReportedDetailedFact interface.
|
|
52
70
|
*/
|
|
53
|
-
export declare function
|
|
54
|
-
export declare function
|
|
55
|
-
export declare function
|
|
56
|
-
export declare function
|
|
57
|
-
export declare function
|
|
71
|
+
export declare function instanceOfAsReportedDetailedFact(value: object): value is AsReportedDetailedFact;
|
|
72
|
+
export declare function AsReportedDetailedFactFromJSON(json: any): AsReportedDetailedFact;
|
|
73
|
+
export declare function AsReportedDetailedFactFromJSONTyped(json: any, ignoreDiscriminator: boolean): AsReportedDetailedFact;
|
|
74
|
+
export declare function AsReportedDetailedFactToJSON(json: any): AsReportedDetailedFact;
|
|
75
|
+
export declare function AsReportedDetailedFactToJSONTyped(value?: AsReportedDetailedFact | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -13,36 +13,56 @@
|
|
|
13
13
|
*/
|
|
14
14
|
import { StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormulaFromJSON, StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormulaToJSON, } from './StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormula';
|
|
15
15
|
/**
|
|
16
|
-
* Check if a given object implements the
|
|
16
|
+
* Check if a given object implements the AsReportedDetailedFact interface.
|
|
17
17
|
*/
|
|
18
|
-
export function
|
|
18
|
+
export function instanceOfAsReportedDetailedFact(value) {
|
|
19
|
+
if (!('value' in value) || value['value'] === undefined)
|
|
20
|
+
return false;
|
|
21
|
+
if (!('derived' in value) || value['derived'] === undefined)
|
|
22
|
+
return false;
|
|
23
|
+
if (!('label' in value) || value['label'] === undefined)
|
|
24
|
+
return false;
|
|
25
|
+
if (!('company_label' in value) || value['company_label'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
if (!('decimals' in value) || value['decimals'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
if (!('accession_number' in value) || value['accession_number'] === undefined)
|
|
30
|
+
return false;
|
|
31
|
+
if (!('html_tag_id' in value) || value['html_tag_id'] === undefined)
|
|
32
|
+
return false;
|
|
19
33
|
return true;
|
|
20
34
|
}
|
|
21
|
-
export function
|
|
22
|
-
return
|
|
35
|
+
export function AsReportedDetailedFactFromJSON(json) {
|
|
36
|
+
return AsReportedDetailedFactFromJSONTyped(json, false);
|
|
23
37
|
}
|
|
24
|
-
export function
|
|
38
|
+
export function AsReportedDetailedFactFromJSONTyped(json, ignoreDiscriminator) {
|
|
25
39
|
if (json == null) {
|
|
26
40
|
return json;
|
|
27
41
|
}
|
|
28
42
|
return {
|
|
29
|
-
'value': json['value']
|
|
30
|
-
'
|
|
43
|
+
'value': json['value'],
|
|
44
|
+
'derived': json['derived'],
|
|
45
|
+
'label': json['label'],
|
|
46
|
+
'company_label': json['company_label'],
|
|
47
|
+
'decimals': json['decimals'],
|
|
31
48
|
'formula': json['formula'] == null ? undefined : StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormulaFromJSON(json['formula']),
|
|
32
|
-
'accession_number': json['accession_number']
|
|
33
|
-
'html_tag_id': json['html_tag_id']
|
|
49
|
+
'accession_number': json['accession_number'],
|
|
50
|
+
'html_tag_id': json['html_tag_id'],
|
|
34
51
|
};
|
|
35
52
|
}
|
|
36
|
-
export function
|
|
37
|
-
return
|
|
53
|
+
export function AsReportedDetailedFactToJSON(json) {
|
|
54
|
+
return AsReportedDetailedFactToJSONTyped(json, false);
|
|
38
55
|
}
|
|
39
|
-
export function
|
|
56
|
+
export function AsReportedDetailedFactToJSONTyped(value, ignoreDiscriminator = false) {
|
|
40
57
|
if (value == null) {
|
|
41
58
|
return value;
|
|
42
59
|
}
|
|
43
60
|
return {
|
|
44
61
|
'value': value['value'],
|
|
45
|
-
'
|
|
62
|
+
'derived': value['derived'],
|
|
63
|
+
'label': value['label'],
|
|
64
|
+
'company_label': value['company_label'],
|
|
65
|
+
'decimals': value['decimals'],
|
|
46
66
|
'formula': StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormulaToJSON(value['formula']),
|
|
47
67
|
'accession_number': value['accession_number'],
|
|
48
68
|
'html_tag_id': value['html_tag_id'],
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Invinite API
|
|
3
|
+
* Invinite financial data API. Each endpoint has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Included-Remaining` what is left of the plan\'s included credits. `GET /v1/account/usage` returns your account\'s usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost. **Coverage.** Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/company/available-companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the CIKs it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `ping` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `ping` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/account/usage` serves no licensed data and carries none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface AsReportedFact
|
|
16
|
+
*/
|
|
17
|
+
export interface AsReportedFact {
|
|
18
|
+
/**
|
|
19
|
+
* Fact value (as filed unless `display_sign=cash_flow_direction`)
|
|
20
|
+
* @type {number}
|
|
21
|
+
* @memberof AsReportedFact
|
|
22
|
+
*/
|
|
23
|
+
value: number;
|
|
24
|
+
/**
|
|
25
|
+
* true when Invinite computed the value (a Q4, TTM or YTD derivation; `formula` on the detailed route names its members); false = the company reported it
|
|
26
|
+
* @type {boolean}
|
|
27
|
+
* @memberof AsReportedFact
|
|
28
|
+
*/
|
|
29
|
+
derived: boolean;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Check if a given object implements the AsReportedFact interface.
|
|
33
|
+
*/
|
|
34
|
+
export declare function instanceOfAsReportedFact(value: object): value is AsReportedFact;
|
|
35
|
+
export declare function AsReportedFactFromJSON(json: any): AsReportedFact;
|
|
36
|
+
export declare function AsReportedFactFromJSONTyped(json: any, ignoreDiscriminator: boolean): AsReportedFact;
|
|
37
|
+
export declare function AsReportedFactToJSON(json: any): AsReportedFact;
|
|
38
|
+
export declare function AsReportedFactToJSONTyped(value?: AsReportedFact | null, ignoreDiscriminator?: boolean): any;
|