@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
|
@@ -13,6 +13,11 @@
|
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
15
|
import * as runtime from '../runtime';
|
|
16
|
+
import {
|
|
17
|
+
type AsReportedSnapshot200Response,
|
|
18
|
+
AsReportedSnapshot200ResponseFromJSON,
|
|
19
|
+
AsReportedSnapshot200ResponseToJSON,
|
|
20
|
+
} from '../models/AsReportedSnapshot200Response';
|
|
16
21
|
import {
|
|
17
22
|
type AsReportedSnapshotDetailed200Response,
|
|
18
23
|
AsReportedSnapshotDetailed200ResponseFromJSON,
|
|
@@ -28,17 +33,14 @@ import {
|
|
|
28
33
|
CompanyAvailableCompanies401ResponseFromJSON,
|
|
29
34
|
CompanyAvailableCompanies401ResponseToJSON,
|
|
30
35
|
} from '../models/CompanyAvailableCompanies401Response';
|
|
31
|
-
import {
|
|
32
|
-
type StandardizedSnapshot200Response,
|
|
33
|
-
StandardizedSnapshot200ResponseFromJSON,
|
|
34
|
-
StandardizedSnapshot200ResponseToJSON,
|
|
35
|
-
} from '../models/StandardizedSnapshot200Response';
|
|
36
36
|
|
|
37
37
|
export interface AsReportedSnapshotRequest {
|
|
38
38
|
identifiers: string;
|
|
39
39
|
fiscalPeriodType: AsReportedSnapshotFiscalPeriodTypeEnum;
|
|
40
40
|
calendarYear?: number;
|
|
41
41
|
calendarQuarter?: number;
|
|
42
|
+
reportedOnly?: AsReportedSnapshotReportedOnlyEnum;
|
|
43
|
+
displaySign?: AsReportedSnapshotDisplaySignEnum;
|
|
42
44
|
}
|
|
43
45
|
|
|
44
46
|
export interface AsReportedSnapshotDetailedRequest {
|
|
@@ -46,6 +48,8 @@ export interface AsReportedSnapshotDetailedRequest {
|
|
|
46
48
|
fiscalPeriodType: AsReportedSnapshotDetailedFiscalPeriodTypeEnum;
|
|
47
49
|
calendarYear?: number;
|
|
48
50
|
calendarQuarter?: number;
|
|
51
|
+
reportedOnly?: AsReportedSnapshotDetailedReportedOnlyEnum;
|
|
52
|
+
displaySign?: AsReportedSnapshotDetailedDisplaySignEnum;
|
|
49
53
|
withFormula?: AsReportedSnapshotDetailedWithFormulaEnum;
|
|
50
54
|
}
|
|
51
55
|
|
|
@@ -54,6 +58,8 @@ export interface AsReportedSnapshotPresentationRequest {
|
|
|
54
58
|
fiscalPeriodType: AsReportedSnapshotPresentationFiscalPeriodTypeEnum;
|
|
55
59
|
calendarYear?: number;
|
|
56
60
|
calendarQuarter?: number;
|
|
61
|
+
reportedOnly?: AsReportedSnapshotPresentationReportedOnlyEnum;
|
|
62
|
+
displaySign?: AsReportedSnapshotPresentationDisplaySignEnum;
|
|
57
63
|
}
|
|
58
64
|
|
|
59
65
|
/**
|
|
@@ -97,6 +103,14 @@ export class AsReportedSnapshotApi extends runtime.BaseAPI {
|
|
|
97
103
|
queryParameters['calendar_quarter'] = requestParameters['calendarQuarter'];
|
|
98
104
|
}
|
|
99
105
|
|
|
106
|
+
if (requestParameters['reportedOnly'] != null) {
|
|
107
|
+
queryParameters['reported_only'] = requestParameters['reportedOnly'];
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
if (requestParameters['displaySign'] != null) {
|
|
111
|
+
queryParameters['display_sign'] = requestParameters['displaySign'];
|
|
112
|
+
}
|
|
113
|
+
|
|
100
114
|
const headerParameters: runtime.HTTPHeaders = {};
|
|
101
115
|
|
|
102
116
|
if (this.configuration && this.configuration.accessToken) {
|
|
@@ -122,18 +136,18 @@ export class AsReportedSnapshotApi extends runtime.BaseAPI {
|
|
|
122
136
|
* Fetch latest complete as-reported financial statements snapshot for multiple companies. Minimum tier for redistribute: PRO.
|
|
123
137
|
* As-reported snapshot
|
|
124
138
|
*/
|
|
125
|
-
async asReportedSnapshotRaw(requestParameters: AsReportedSnapshotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
139
|
+
async asReportedSnapshotRaw(requestParameters: AsReportedSnapshotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AsReportedSnapshot200Response>> {
|
|
126
140
|
const requestOptions = await this.asReportedSnapshotRequestOpts(requestParameters);
|
|
127
141
|
const response = await this.request(requestOptions, initOverrides);
|
|
128
142
|
|
|
129
|
-
return new runtime.JSONApiResponse(response, (jsonValue) =>
|
|
143
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => AsReportedSnapshot200ResponseFromJSON(jsonValue));
|
|
130
144
|
}
|
|
131
145
|
|
|
132
146
|
/**
|
|
133
147
|
* Fetch latest complete as-reported financial statements snapshot for multiple companies. Minimum tier for redistribute: PRO.
|
|
134
148
|
* As-reported snapshot
|
|
135
149
|
*/
|
|
136
|
-
async asReportedSnapshot(requestParameters: AsReportedSnapshotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
150
|
+
async asReportedSnapshot(requestParameters: AsReportedSnapshotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AsReportedSnapshot200Response> {
|
|
137
151
|
const response = await this.asReportedSnapshotRaw(requestParameters, initOverrides);
|
|
138
152
|
return await response.value();
|
|
139
153
|
}
|
|
@@ -174,6 +188,14 @@ export class AsReportedSnapshotApi extends runtime.BaseAPI {
|
|
|
174
188
|
queryParameters['calendar_quarter'] = requestParameters['calendarQuarter'];
|
|
175
189
|
}
|
|
176
190
|
|
|
191
|
+
if (requestParameters['reportedOnly'] != null) {
|
|
192
|
+
queryParameters['reported_only'] = requestParameters['reportedOnly'];
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
if (requestParameters['displaySign'] != null) {
|
|
196
|
+
queryParameters['display_sign'] = requestParameters['displaySign'];
|
|
197
|
+
}
|
|
198
|
+
|
|
177
199
|
if (requestParameters['withFormula'] != null) {
|
|
178
200
|
queryParameters['with_formula'] = requestParameters['withFormula'];
|
|
179
201
|
}
|
|
@@ -200,7 +222,7 @@ export class AsReportedSnapshotApi extends runtime.BaseAPI {
|
|
|
200
222
|
}
|
|
201
223
|
|
|
202
224
|
/**
|
|
203
|
-
* Fetch latest complete detailed as-reported financial statements snapshot with
|
|
225
|
+
* 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.
|
|
204
226
|
* As-reported snapshot (detailed)
|
|
205
227
|
*/
|
|
206
228
|
async asReportedSnapshotDetailedRaw(requestParameters: AsReportedSnapshotDetailedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AsReportedSnapshotDetailed200Response>> {
|
|
@@ -211,7 +233,7 @@ export class AsReportedSnapshotApi extends runtime.BaseAPI {
|
|
|
211
233
|
}
|
|
212
234
|
|
|
213
235
|
/**
|
|
214
|
-
* Fetch latest complete detailed as-reported financial statements snapshot with
|
|
236
|
+
* 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.
|
|
215
237
|
* As-reported snapshot (detailed)
|
|
216
238
|
*/
|
|
217
239
|
async asReportedSnapshotDetailed(requestParameters: AsReportedSnapshotDetailedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AsReportedSnapshotDetailed200Response> {
|
|
@@ -255,6 +277,14 @@ export class AsReportedSnapshotApi extends runtime.BaseAPI {
|
|
|
255
277
|
queryParameters['calendar_quarter'] = requestParameters['calendarQuarter'];
|
|
256
278
|
}
|
|
257
279
|
|
|
280
|
+
if (requestParameters['reportedOnly'] != null) {
|
|
281
|
+
queryParameters['reported_only'] = requestParameters['reportedOnly'];
|
|
282
|
+
}
|
|
283
|
+
|
|
284
|
+
if (requestParameters['displaySign'] != null) {
|
|
285
|
+
queryParameters['display_sign'] = requestParameters['displaySign'];
|
|
286
|
+
}
|
|
287
|
+
|
|
258
288
|
const headerParameters: runtime.HTTPHeaders = {};
|
|
259
289
|
|
|
260
290
|
if (this.configuration && this.configuration.accessToken) {
|
|
@@ -308,6 +338,22 @@ export const AsReportedSnapshotFiscalPeriodTypeEnum = {
|
|
|
308
338
|
Ttm: 'ttm'
|
|
309
339
|
} as const;
|
|
310
340
|
export type AsReportedSnapshotFiscalPeriodTypeEnum = typeof AsReportedSnapshotFiscalPeriodTypeEnum[keyof typeof AsReportedSnapshotFiscalPeriodTypeEnum];
|
|
341
|
+
/**
|
|
342
|
+
* @export
|
|
343
|
+
*/
|
|
344
|
+
export const AsReportedSnapshotReportedOnlyEnum = {
|
|
345
|
+
True: 'true',
|
|
346
|
+
False: 'false'
|
|
347
|
+
} as const;
|
|
348
|
+
export type AsReportedSnapshotReportedOnlyEnum = typeof AsReportedSnapshotReportedOnlyEnum[keyof typeof AsReportedSnapshotReportedOnlyEnum];
|
|
349
|
+
/**
|
|
350
|
+
* @export
|
|
351
|
+
*/
|
|
352
|
+
export const AsReportedSnapshotDisplaySignEnum = {
|
|
353
|
+
AsFiled: 'as_filed',
|
|
354
|
+
CashFlowDirection: 'cash_flow_direction'
|
|
355
|
+
} as const;
|
|
356
|
+
export type AsReportedSnapshotDisplaySignEnum = typeof AsReportedSnapshotDisplaySignEnum[keyof typeof AsReportedSnapshotDisplaySignEnum];
|
|
311
357
|
/**
|
|
312
358
|
* @export
|
|
313
359
|
*/
|
|
@@ -318,6 +364,22 @@ export const AsReportedSnapshotDetailedFiscalPeriodTypeEnum = {
|
|
|
318
364
|
Ttm: 'ttm'
|
|
319
365
|
} as const;
|
|
320
366
|
export type AsReportedSnapshotDetailedFiscalPeriodTypeEnum = typeof AsReportedSnapshotDetailedFiscalPeriodTypeEnum[keyof typeof AsReportedSnapshotDetailedFiscalPeriodTypeEnum];
|
|
367
|
+
/**
|
|
368
|
+
* @export
|
|
369
|
+
*/
|
|
370
|
+
export const AsReportedSnapshotDetailedReportedOnlyEnum = {
|
|
371
|
+
True: 'true',
|
|
372
|
+
False: 'false'
|
|
373
|
+
} as const;
|
|
374
|
+
export type AsReportedSnapshotDetailedReportedOnlyEnum = typeof AsReportedSnapshotDetailedReportedOnlyEnum[keyof typeof AsReportedSnapshotDetailedReportedOnlyEnum];
|
|
375
|
+
/**
|
|
376
|
+
* @export
|
|
377
|
+
*/
|
|
378
|
+
export const AsReportedSnapshotDetailedDisplaySignEnum = {
|
|
379
|
+
AsFiled: 'as_filed',
|
|
380
|
+
CashFlowDirection: 'cash_flow_direction'
|
|
381
|
+
} as const;
|
|
382
|
+
export type AsReportedSnapshotDetailedDisplaySignEnum = typeof AsReportedSnapshotDetailedDisplaySignEnum[keyof typeof AsReportedSnapshotDetailedDisplaySignEnum];
|
|
321
383
|
/**
|
|
322
384
|
* @export
|
|
323
385
|
*/
|
|
@@ -336,3 +398,19 @@ export const AsReportedSnapshotPresentationFiscalPeriodTypeEnum = {
|
|
|
336
398
|
Ttm: 'ttm'
|
|
337
399
|
} as const;
|
|
338
400
|
export type AsReportedSnapshotPresentationFiscalPeriodTypeEnum = typeof AsReportedSnapshotPresentationFiscalPeriodTypeEnum[keyof typeof AsReportedSnapshotPresentationFiscalPeriodTypeEnum];
|
|
401
|
+
/**
|
|
402
|
+
* @export
|
|
403
|
+
*/
|
|
404
|
+
export const AsReportedSnapshotPresentationReportedOnlyEnum = {
|
|
405
|
+
True: 'true',
|
|
406
|
+
False: 'false'
|
|
407
|
+
} as const;
|
|
408
|
+
export type AsReportedSnapshotPresentationReportedOnlyEnum = typeof AsReportedSnapshotPresentationReportedOnlyEnum[keyof typeof AsReportedSnapshotPresentationReportedOnlyEnum];
|
|
409
|
+
/**
|
|
410
|
+
* @export
|
|
411
|
+
*/
|
|
412
|
+
export const AsReportedSnapshotPresentationDisplaySignEnum = {
|
|
413
|
+
AsFiled: 'as_filed',
|
|
414
|
+
CashFlowDirection: 'cash_flow_direction'
|
|
415
|
+
} as const;
|
|
416
|
+
export type AsReportedSnapshotPresentationDisplaySignEnum = typeof AsReportedSnapshotPresentationDisplaySignEnum[keyof typeof AsReportedSnapshotPresentationDisplaySignEnum];
|
|
@@ -24,71 +24,99 @@ import {
|
|
|
24
24
|
/**
|
|
25
25
|
*
|
|
26
26
|
* @export
|
|
27
|
-
* @interface
|
|
27
|
+
* @interface AsReportedDetailedFact
|
|
28
28
|
*/
|
|
29
|
-
export interface
|
|
29
|
+
export interface AsReportedDetailedFact {
|
|
30
30
|
/**
|
|
31
|
-
*
|
|
31
|
+
* Fact value (as filed unless `display_sign=cash_flow_direction`)
|
|
32
32
|
* @type {number}
|
|
33
|
-
* @memberof
|
|
33
|
+
* @memberof AsReportedDetailedFact
|
|
34
34
|
*/
|
|
35
|
-
value
|
|
35
|
+
value: number;
|
|
36
36
|
/**
|
|
37
|
-
*
|
|
37
|
+
* true when Invinite computed the value (a Q4, TTM or YTD derivation, see `formula`); false = the company reported it
|
|
38
|
+
* @type {boolean}
|
|
39
|
+
* @memberof AsReportedDetailedFact
|
|
40
|
+
*/
|
|
41
|
+
derived: boolean;
|
|
42
|
+
/**
|
|
43
|
+
* The concept's taxonomy label
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof AsReportedDetailedFact
|
|
46
|
+
*/
|
|
47
|
+
label: string | null;
|
|
48
|
+
/**
|
|
49
|
+
* The company's own caption of the line item in the filing (null when it was not extracted)
|
|
38
50
|
* @type {string}
|
|
39
|
-
* @memberof
|
|
51
|
+
* @memberof AsReportedDetailedFact
|
|
52
|
+
*/
|
|
53
|
+
company_label: string | null;
|
|
54
|
+
/**
|
|
55
|
+
* XBRL decimals of the reported fact (-6 = rounded to millions); null = exact (INF) or not stated. A derived fact carries its source fact's
|
|
56
|
+
* @type {number}
|
|
57
|
+
* @memberof AsReportedDetailedFact
|
|
40
58
|
*/
|
|
41
|
-
|
|
59
|
+
decimals: number | null;
|
|
42
60
|
/**
|
|
43
61
|
*
|
|
44
62
|
* @type {StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormula}
|
|
45
|
-
* @memberof
|
|
63
|
+
* @memberof AsReportedDetailedFact
|
|
46
64
|
*/
|
|
47
65
|
formula?: StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormula | null;
|
|
48
66
|
/**
|
|
49
|
-
*
|
|
67
|
+
* Accession number of the filing that holds the value
|
|
50
68
|
* @type {string}
|
|
51
|
-
* @memberof
|
|
69
|
+
* @memberof AsReportedDetailedFact
|
|
52
70
|
*/
|
|
53
|
-
accession_number
|
|
71
|
+
accession_number: string | null;
|
|
54
72
|
/**
|
|
55
|
-
*
|
|
73
|
+
* Anchor of the fact in the filing's HTML (null on a derived fact)
|
|
56
74
|
* @type {string}
|
|
57
|
-
* @memberof
|
|
75
|
+
* @memberof AsReportedDetailedFact
|
|
58
76
|
*/
|
|
59
|
-
html_tag_id
|
|
77
|
+
html_tag_id: string | null;
|
|
60
78
|
}
|
|
61
79
|
|
|
62
80
|
/**
|
|
63
|
-
* Check if a given object implements the
|
|
81
|
+
* Check if a given object implements the AsReportedDetailedFact interface.
|
|
64
82
|
*/
|
|
65
|
-
export function
|
|
83
|
+
export function instanceOfAsReportedDetailedFact(value: object): value is AsReportedDetailedFact {
|
|
84
|
+
if (!('value' in value) || value['value'] === undefined) return false;
|
|
85
|
+
if (!('derived' in value) || value['derived'] === undefined) return false;
|
|
86
|
+
if (!('label' in value) || value['label'] === undefined) return false;
|
|
87
|
+
if (!('company_label' in value) || value['company_label'] === undefined) return false;
|
|
88
|
+
if (!('decimals' in value) || value['decimals'] === undefined) return false;
|
|
89
|
+
if (!('accession_number' in value) || value['accession_number'] === undefined) return false;
|
|
90
|
+
if (!('html_tag_id' in value) || value['html_tag_id'] === undefined) return false;
|
|
66
91
|
return true;
|
|
67
92
|
}
|
|
68
93
|
|
|
69
|
-
export function
|
|
70
|
-
return
|
|
94
|
+
export function AsReportedDetailedFactFromJSON(json: any): AsReportedDetailedFact {
|
|
95
|
+
return AsReportedDetailedFactFromJSONTyped(json, false);
|
|
71
96
|
}
|
|
72
97
|
|
|
73
|
-
export function
|
|
98
|
+
export function AsReportedDetailedFactFromJSONTyped(json: any, ignoreDiscriminator: boolean): AsReportedDetailedFact {
|
|
74
99
|
if (json == null) {
|
|
75
100
|
return json;
|
|
76
101
|
}
|
|
77
102
|
return {
|
|
78
103
|
|
|
79
|
-
'value': json['value']
|
|
80
|
-
'
|
|
104
|
+
'value': json['value'],
|
|
105
|
+
'derived': json['derived'],
|
|
106
|
+
'label': json['label'],
|
|
107
|
+
'company_label': json['company_label'],
|
|
108
|
+
'decimals': json['decimals'],
|
|
81
109
|
'formula': json['formula'] == null ? undefined : StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormulaFromJSON(json['formula']),
|
|
82
|
-
'accession_number': json['accession_number']
|
|
83
|
-
'html_tag_id': json['html_tag_id']
|
|
110
|
+
'accession_number': json['accession_number'],
|
|
111
|
+
'html_tag_id': json['html_tag_id'],
|
|
84
112
|
};
|
|
85
113
|
}
|
|
86
114
|
|
|
87
|
-
export function
|
|
88
|
-
return
|
|
115
|
+
export function AsReportedDetailedFactToJSON(json: any): AsReportedDetailedFact {
|
|
116
|
+
return AsReportedDetailedFactToJSONTyped(json, false);
|
|
89
117
|
}
|
|
90
118
|
|
|
91
|
-
export function
|
|
119
|
+
export function AsReportedDetailedFactToJSONTyped(value?: AsReportedDetailedFact | null, ignoreDiscriminator: boolean = false): any {
|
|
92
120
|
if (value == null) {
|
|
93
121
|
return value;
|
|
94
122
|
}
|
|
@@ -96,7 +124,10 @@ export function AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriod
|
|
|
96
124
|
return {
|
|
97
125
|
|
|
98
126
|
'value': value['value'],
|
|
99
|
-
'
|
|
127
|
+
'derived': value['derived'],
|
|
128
|
+
'label': value['label'],
|
|
129
|
+
'company_label': value['company_label'],
|
|
130
|
+
'decimals': value['decimals'],
|
|
100
131
|
'formula': StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormulaToJSON(value['formula']),
|
|
101
132
|
'accession_number': value['accession_number'],
|
|
102
133
|
'html_tag_id': value['html_tag_id'],
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Invinite API
|
|
5
|
+
* Invinite financial data API. Each endpoint has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Included-Remaining` what is left of the plan\'s included credits. `GET /v1/account/usage` returns your account\'s usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost. **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.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface AsReportedFact
|
|
20
|
+
*/
|
|
21
|
+
export interface AsReportedFact {
|
|
22
|
+
/**
|
|
23
|
+
* Fact value (as filed unless `display_sign=cash_flow_direction`)
|
|
24
|
+
* @type {number}
|
|
25
|
+
* @memberof AsReportedFact
|
|
26
|
+
*/
|
|
27
|
+
value: number;
|
|
28
|
+
/**
|
|
29
|
+
* 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
|
|
30
|
+
* @type {boolean}
|
|
31
|
+
* @memberof AsReportedFact
|
|
32
|
+
*/
|
|
33
|
+
derived: boolean;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
/**
|
|
37
|
+
* Check if a given object implements the AsReportedFact interface.
|
|
38
|
+
*/
|
|
39
|
+
export function instanceOfAsReportedFact(value: object): value is AsReportedFact {
|
|
40
|
+
if (!('value' in value) || value['value'] === undefined) return false;
|
|
41
|
+
if (!('derived' in value) || value['derived'] === undefined) return false;
|
|
42
|
+
return true;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
export function AsReportedFactFromJSON(json: any): AsReportedFact {
|
|
46
|
+
return AsReportedFactFromJSONTyped(json, false);
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
export function AsReportedFactFromJSONTyped(json: any, ignoreDiscriminator: boolean): AsReportedFact {
|
|
50
|
+
if (json == null) {
|
|
51
|
+
return json;
|
|
52
|
+
}
|
|
53
|
+
return {
|
|
54
|
+
|
|
55
|
+
'value': json['value'],
|
|
56
|
+
'derived': json['derived'],
|
|
57
|
+
};
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
export function AsReportedFactToJSON(json: any): AsReportedFact {
|
|
61
|
+
return AsReportedFactToJSONTyped(json, false);
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
export function AsReportedFactToJSONTyped(value?: AsReportedFact | null, ignoreDiscriminator: boolean = false): any {
|
|
65
|
+
if (value == null) {
|
|
66
|
+
return value;
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
return {
|
|
70
|
+
|
|
71
|
+
'value': value['value'],
|
|
72
|
+
'derived': value['derived'],
|
|
73
|
+
};
|
|
74
|
+
}
|
|
75
|
+
|
|
@@ -13,6 +13,14 @@
|
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
15
|
import { mapValues } from '../runtime';
|
|
16
|
+
import type { AsReportedFact } from './AsReportedFact';
|
|
17
|
+
import {
|
|
18
|
+
AsReportedFactFromJSON,
|
|
19
|
+
AsReportedFactFromJSONTyped,
|
|
20
|
+
AsReportedFactToJSON,
|
|
21
|
+
AsReportedFactToJSONTyped,
|
|
22
|
+
} from './AsReportedFact';
|
|
23
|
+
|
|
16
24
|
/**
|
|
17
25
|
*
|
|
18
26
|
* @export
|
|
@@ -57,10 +65,10 @@ export interface AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner
|
|
|
57
65
|
period_end: Date;
|
|
58
66
|
/**
|
|
59
67
|
* As-reported facts keyed by concept
|
|
60
|
-
* @type {{ [key: string]:
|
|
68
|
+
* @type {{ [key: string]: AsReportedFact; }}
|
|
61
69
|
* @memberof AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner
|
|
62
70
|
*/
|
|
63
|
-
facts: { [key: string]:
|
|
71
|
+
facts: { [key: string]: AsReportedFact; };
|
|
64
72
|
}
|
|
65
73
|
|
|
66
74
|
/**
|
|
@@ -93,7 +101,7 @@ export function AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInnerFr
|
|
|
93
101
|
'calendar_quarter': json['calendar_quarter'],
|
|
94
102
|
'fiscal_period_type': json['fiscal_period_type'],
|
|
95
103
|
'period_end': (new Date(json['period_end'])),
|
|
96
|
-
'facts': json['facts'],
|
|
104
|
+
'facts': (mapValues(json['facts'], AsReportedFactFromJSON)),
|
|
97
105
|
};
|
|
98
106
|
}
|
|
99
107
|
|
|
@@ -114,7 +122,7 @@ export function AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInnerTo
|
|
|
114
122
|
'calendar_quarter': value['calendar_quarter'],
|
|
115
123
|
'fiscal_period_type': value['fiscal_period_type'],
|
|
116
124
|
'period_end': value['period_end'].toISOString().substring(0,10),
|
|
117
|
-
'facts': value['facts'],
|
|
125
|
+
'facts': (mapValues(value['facts'], AsReportedFactToJSON)),
|
|
118
126
|
};
|
|
119
127
|
}
|
|
120
128
|
|
package/src/models/AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner.ts
CHANGED
|
@@ -13,13 +13,13 @@
|
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
15
|
import { mapValues } from '../runtime';
|
|
16
|
-
import type {
|
|
16
|
+
import type { AsReportedDetailedFact } from './AsReportedDetailedFact';
|
|
17
17
|
import {
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
} from './
|
|
18
|
+
AsReportedDetailedFactFromJSON,
|
|
19
|
+
AsReportedDetailedFactFromJSONTyped,
|
|
20
|
+
AsReportedDetailedFactToJSON,
|
|
21
|
+
AsReportedDetailedFactToJSONTyped,
|
|
22
|
+
} from './AsReportedDetailedFact';
|
|
23
23
|
|
|
24
24
|
/**
|
|
25
25
|
*
|
|
@@ -65,10 +65,10 @@ export interface AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPerio
|
|
|
65
65
|
period_end: Date;
|
|
66
66
|
/**
|
|
67
67
|
*
|
|
68
|
-
* @type {{ [key: string]:
|
|
68
|
+
* @type {{ [key: string]: AsReportedDetailedFact; }}
|
|
69
69
|
* @memberof AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner
|
|
70
70
|
*/
|
|
71
|
-
facts: { [key: string]:
|
|
71
|
+
facts: { [key: string]: AsReportedDetailedFact; };
|
|
72
72
|
}
|
|
73
73
|
|
|
74
74
|
/**
|
|
@@ -101,7 +101,7 @@ export function AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriod
|
|
|
101
101
|
'calendar_quarter': json['calendar_quarter'],
|
|
102
102
|
'fiscal_period_type': json['fiscal_period_type'],
|
|
103
103
|
'period_end': (new Date(json['period_end'])),
|
|
104
|
-
'facts': (mapValues(json['facts'],
|
|
104
|
+
'facts': (mapValues(json['facts'], AsReportedDetailedFactFromJSON)),
|
|
105
105
|
};
|
|
106
106
|
}
|
|
107
107
|
|
|
@@ -122,7 +122,7 @@ export function AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriod
|
|
|
122
122
|
'calendar_quarter': value['calendar_quarter'],
|
|
123
123
|
'fiscal_period_type': value['fiscal_period_type'],
|
|
124
124
|
'period_end': value['period_end'].toISOString().substring(0,10),
|
|
125
|
-
'facts': (mapValues(value['facts'],
|
|
125
|
+
'facts': (mapValues(value['facts'], AsReportedDetailedFactToJSON)),
|
|
126
126
|
};
|
|
127
127
|
}
|
|
128
128
|
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Invinite API
|
|
5
|
+
* Invinite financial data API. Each endpoint has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Included-Remaining` what is left of the plan\'s included credits. `GET /v1/account/usage` returns your account\'s usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost. **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.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
import type { AsReportedSnapshot200ResponseCompaniesInner } from './AsReportedSnapshot200ResponseCompaniesInner';
|
|
17
|
+
import {
|
|
18
|
+
AsReportedSnapshot200ResponseCompaniesInnerFromJSON,
|
|
19
|
+
AsReportedSnapshot200ResponseCompaniesInnerFromJSONTyped,
|
|
20
|
+
AsReportedSnapshot200ResponseCompaniesInnerToJSON,
|
|
21
|
+
AsReportedSnapshot200ResponseCompaniesInnerToJSONTyped,
|
|
22
|
+
} from './AsReportedSnapshot200ResponseCompaniesInner';
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @export
|
|
27
|
+
* @interface AsReportedSnapshot200Response
|
|
28
|
+
*/
|
|
29
|
+
export interface AsReportedSnapshot200Response {
|
|
30
|
+
/**
|
|
31
|
+
* List of companies with their latest financial statements
|
|
32
|
+
* @type {Array<AsReportedSnapshot200ResponseCompaniesInner>}
|
|
33
|
+
* @memberof AsReportedSnapshot200Response
|
|
34
|
+
*/
|
|
35
|
+
companies: Array<AsReportedSnapshot200ResponseCompaniesInner>;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
/**
|
|
39
|
+
* Check if a given object implements the AsReportedSnapshot200Response interface.
|
|
40
|
+
*/
|
|
41
|
+
export function instanceOfAsReportedSnapshot200Response(value: object): value is AsReportedSnapshot200Response {
|
|
42
|
+
if (!('companies' in value) || value['companies'] === undefined) return false;
|
|
43
|
+
return true;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
export function AsReportedSnapshot200ResponseFromJSON(json: any): AsReportedSnapshot200Response {
|
|
47
|
+
return AsReportedSnapshot200ResponseFromJSONTyped(json, false);
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
export function AsReportedSnapshot200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AsReportedSnapshot200Response {
|
|
51
|
+
if (json == null) {
|
|
52
|
+
return json;
|
|
53
|
+
}
|
|
54
|
+
return {
|
|
55
|
+
|
|
56
|
+
'companies': ((json['companies'] as Array<any>).map(AsReportedSnapshot200ResponseCompaniesInnerFromJSON)),
|
|
57
|
+
};
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
export function AsReportedSnapshot200ResponseToJSON(json: any): AsReportedSnapshot200Response {
|
|
61
|
+
return AsReportedSnapshot200ResponseToJSONTyped(json, false);
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
export function AsReportedSnapshot200ResponseToJSONTyped(value?: AsReportedSnapshot200Response | null, ignoreDiscriminator: boolean = false): any {
|
|
65
|
+
if (value == null) {
|
|
66
|
+
return value;
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
return {
|
|
70
|
+
|
|
71
|
+
'companies': ((value['companies'] as Array<any>).map(AsReportedSnapshot200ResponseCompaniesInnerToJSON)),
|
|
72
|
+
};
|
|
73
|
+
}
|
|
74
|
+
|