@invinite-org/data-api-client 0.3.0 → 0.4.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 +12 -0
- package/dist/apis/EarningsCallsApi.d.ts +46 -6
- package/dist/apis/EarningsCallsApi.js +51 -7
- package/dist/esm/apis/EarningsCallsApi.d.ts +46 -6
- package/dist/esm/apis/EarningsCallsApi.js +50 -6
- package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInner.d.ts +7 -0
- package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInner.js +5 -0
- package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerVideo.d.ts +82 -0
- package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerVideo.js +78 -0
- package/dist/esm/models/EarningsCallsDocumentSearch200Response.d.ts +23 -0
- package/dist/esm/models/EarningsCallsDocumentSearch200Response.js +18 -0
- package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +21 -2
- package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.js +13 -0
- package/dist/esm/models/EarningsCallsEvents200ResponseEventsInner.d.ts +7 -0
- package/dist/esm/models/EarningsCallsEvents200ResponseEventsInner.js +5 -0
- package/dist/esm/models/EarningsCallsLive200ResponseEventsInner.d.ts +7 -0
- package/dist/esm/models/EarningsCallsLive200ResponseEventsInner.js +5 -0
- package/dist/esm/models/EarningsCallsSearch200Response.d.ts +23 -0
- package/dist/esm/models/EarningsCallsSearch200Response.js +18 -0
- package/dist/esm/models/EarningsCallsSearch200ResponseHitsInner.d.ts +21 -2
- package/dist/esm/models/EarningsCallsSearch200ResponseHitsInner.js +13 -0
- package/dist/esm/models/EarningsCallsSlides200Response.d.ts +7 -0
- package/dist/esm/models/EarningsCallsSlides200Response.js +5 -0
- package/dist/esm/models/EarningsCallsSlides200ResponseTimelineInner.d.ts +38 -0
- package/dist/esm/models/EarningsCallsSlides200ResponseTimelineInner.js +47 -0
- package/dist/esm/models/HitMatch.d.ts +61 -0
- package/dist/esm/models/HitMatch.js +65 -0
- package/dist/esm/models/MatchSpan.d.ts +38 -0
- package/dist/esm/models/MatchSpan.js +47 -0
- package/dist/esm/models/SearchCoverage.d.ts +73 -0
- package/dist/esm/models/SearchCoverage.js +76 -0
- package/dist/esm/models/SearchCoverageLeg.d.ts +59 -0
- package/dist/esm/models/SearchCoverageLeg.js +63 -0
- package/dist/esm/models/index.d.ts +6 -0
- package/dist/esm/models/index.js +6 -0
- package/dist/models/EarningsCallsCalendar200ResponseEventsInner.d.ts +7 -0
- package/dist/models/EarningsCallsCalendar200ResponseEventsInner.js +5 -0
- package/dist/models/EarningsCallsCalendar200ResponseEventsInnerVideo.d.ts +82 -0
- package/dist/models/EarningsCallsCalendar200ResponseEventsInnerVideo.js +86 -0
- package/dist/models/EarningsCallsDocumentSearch200Response.d.ts +23 -0
- package/dist/models/EarningsCallsDocumentSearch200Response.js +19 -0
- package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +21 -2
- package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.js +13 -0
- package/dist/models/EarningsCallsEvents200ResponseEventsInner.d.ts +7 -0
- package/dist/models/EarningsCallsEvents200ResponseEventsInner.js +5 -0
- package/dist/models/EarningsCallsLive200ResponseEventsInner.d.ts +7 -0
- package/dist/models/EarningsCallsLive200ResponseEventsInner.js +5 -0
- package/dist/models/EarningsCallsSearch200Response.d.ts +23 -0
- package/dist/models/EarningsCallsSearch200Response.js +19 -0
- package/dist/models/EarningsCallsSearch200ResponseHitsInner.d.ts +21 -2
- package/dist/models/EarningsCallsSearch200ResponseHitsInner.js +13 -0
- package/dist/models/EarningsCallsSlides200Response.d.ts +7 -0
- package/dist/models/EarningsCallsSlides200Response.js +5 -0
- package/dist/models/EarningsCallsSlides200ResponseTimelineInner.d.ts +38 -0
- package/dist/models/EarningsCallsSlides200ResponseTimelineInner.js +54 -0
- package/dist/models/HitMatch.d.ts +61 -0
- package/dist/models/HitMatch.js +73 -0
- package/dist/models/MatchSpan.d.ts +38 -0
- package/dist/models/MatchSpan.js +54 -0
- package/dist/models/SearchCoverage.d.ts +73 -0
- package/dist/models/SearchCoverage.js +84 -0
- package/dist/models/SearchCoverageLeg.d.ts +59 -0
- package/dist/models/SearchCoverageLeg.js +71 -0
- package/dist/models/index.d.ts +6 -0
- package/dist/models/index.js +6 -0
- package/docs/EarningsCallsApi.md +22 -10
- package/docs/EarningsCallsCalendar200ResponseEventsInner.md +2 -0
- package/docs/EarningsCallsCalendar200ResponseEventsInnerVideo.md +49 -0
- package/docs/EarningsCallsDocumentSearch200Response.md +4 -0
- package/docs/EarningsCallsDocumentSearch200ResponseHitsInner.md +6 -0
- package/docs/EarningsCallsEvents200ResponseEventsInner.md +2 -0
- package/docs/EarningsCallsLive200ResponseEventsInner.md +2 -0
- package/docs/EarningsCallsSearch200Response.md +4 -0
- package/docs/EarningsCallsSearch200ResponseHitsInner.md +6 -0
- package/docs/EarningsCallsSlides200Response.md +2 -0
- package/docs/EarningsCallsSlides200ResponseTimelineInner.md +36 -0
- package/docs/HitMatch.md +41 -0
- package/docs/MatchSpan.md +36 -0
- package/docs/SearchCoverage.md +41 -0
- package/docs/SearchCoverageLeg.md +41 -0
- package/package.json +1 -1
- package/src/apis/EarningsCallsApi.ts +62 -6
- package/src/models/EarningsCallsCalendar200ResponseEventsInner.ts +17 -0
- package/src/models/EarningsCallsCalendar200ResponseEventsInnerVideo.ts +140 -0
- package/src/models/EarningsCallsDocumentSearch200Response.ts +38 -0
- package/src/models/EarningsCallsDocumentSearch200ResponseHitsInner.ts +37 -2
- package/src/models/EarningsCallsEvents200ResponseEventsInner.ts +16 -0
- package/src/models/EarningsCallsLive200ResponseEventsInner.ts +17 -0
- package/src/models/EarningsCallsSearch200Response.ts +38 -0
- package/src/models/EarningsCallsSearch200ResponseHitsInner.ts +36 -2
- package/src/models/EarningsCallsSlides200Response.ts +16 -0
- package/src/models/EarningsCallsSlides200ResponseTimelineInner.ts +75 -0
- package/src/models/HitMatch.ts +114 -0
- package/src/models/MatchSpan.ts +75 -0
- package/src/models/SearchCoverage.ts +127 -0
- package/src/models/SearchCoverageLeg.ts +105 -0
- package/src/models/index.ts +6 -0
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { EarningsCallsDocumentSearch200ResponseHitsInner } from './EarningsCallsDocumentSearch200ResponseHitsInner';
|
|
13
|
+
import type { SearchCoverage } from './SearchCoverage';
|
|
13
14
|
/**
|
|
14
15
|
*
|
|
15
16
|
* @export
|
|
@@ -22,6 +23,18 @@ export interface EarningsCallsDocumentSearch200Response {
|
|
|
22
23
|
* @memberof EarningsCallsDocumentSearch200Response
|
|
23
24
|
*/
|
|
24
25
|
query: string;
|
|
26
|
+
/**
|
|
27
|
+
* The mode searched
|
|
28
|
+
* @type {EarningsCallsDocumentSearch200ResponseModeEnum}
|
|
29
|
+
* @memberof EarningsCallsDocumentSearch200Response
|
|
30
|
+
*/
|
|
31
|
+
mode: EarningsCallsDocumentSearch200ResponseModeEnum;
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @type {SearchCoverage}
|
|
35
|
+
* @memberof EarningsCallsDocumentSearch200Response
|
|
36
|
+
*/
|
|
37
|
+
coverage: SearchCoverage;
|
|
25
38
|
/**
|
|
26
39
|
* Passages, best first
|
|
27
40
|
* @type {Array<EarningsCallsDocumentSearch200ResponseHitsInner>}
|
|
@@ -29,6 +42,16 @@ export interface EarningsCallsDocumentSearch200Response {
|
|
|
29
42
|
*/
|
|
30
43
|
hits: Array<EarningsCallsDocumentSearch200ResponseHitsInner>;
|
|
31
44
|
}
|
|
45
|
+
/**
|
|
46
|
+
* @export
|
|
47
|
+
*/
|
|
48
|
+
export declare const EarningsCallsDocumentSearch200ResponseModeEnum: {
|
|
49
|
+
readonly Lexical: "lexical";
|
|
50
|
+
readonly Literal: "literal";
|
|
51
|
+
readonly Semantic: "semantic";
|
|
52
|
+
readonly Hybrid: "hybrid";
|
|
53
|
+
};
|
|
54
|
+
export type EarningsCallsDocumentSearch200ResponseModeEnum = typeof EarningsCallsDocumentSearch200ResponseModeEnum[keyof typeof EarningsCallsDocumentSearch200ResponseModeEnum];
|
|
32
55
|
/**
|
|
33
56
|
* Check if a given object implements the EarningsCallsDocumentSearch200Response interface.
|
|
34
57
|
*/
|
|
@@ -13,18 +13,33 @@
|
|
|
13
13
|
* Do not edit the class manually.
|
|
14
14
|
*/
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.EarningsCallsDocumentSearch200ResponseModeEnum = void 0;
|
|
16
17
|
exports.instanceOfEarningsCallsDocumentSearch200Response = instanceOfEarningsCallsDocumentSearch200Response;
|
|
17
18
|
exports.EarningsCallsDocumentSearch200ResponseFromJSON = EarningsCallsDocumentSearch200ResponseFromJSON;
|
|
18
19
|
exports.EarningsCallsDocumentSearch200ResponseFromJSONTyped = EarningsCallsDocumentSearch200ResponseFromJSONTyped;
|
|
19
20
|
exports.EarningsCallsDocumentSearch200ResponseToJSON = EarningsCallsDocumentSearch200ResponseToJSON;
|
|
20
21
|
exports.EarningsCallsDocumentSearch200ResponseToJSONTyped = EarningsCallsDocumentSearch200ResponseToJSONTyped;
|
|
21
22
|
const EarningsCallsDocumentSearch200ResponseHitsInner_1 = require("./EarningsCallsDocumentSearch200ResponseHitsInner");
|
|
23
|
+
const SearchCoverage_1 = require("./SearchCoverage");
|
|
24
|
+
/**
|
|
25
|
+
* @export
|
|
26
|
+
*/
|
|
27
|
+
exports.EarningsCallsDocumentSearch200ResponseModeEnum = {
|
|
28
|
+
Lexical: 'lexical',
|
|
29
|
+
Literal: 'literal',
|
|
30
|
+
Semantic: 'semantic',
|
|
31
|
+
Hybrid: 'hybrid'
|
|
32
|
+
};
|
|
22
33
|
/**
|
|
23
34
|
* Check if a given object implements the EarningsCallsDocumentSearch200Response interface.
|
|
24
35
|
*/
|
|
25
36
|
function instanceOfEarningsCallsDocumentSearch200Response(value) {
|
|
26
37
|
if (!('query' in value) || value['query'] === undefined)
|
|
27
38
|
return false;
|
|
39
|
+
if (!('mode' in value) || value['mode'] === undefined)
|
|
40
|
+
return false;
|
|
41
|
+
if (!('coverage' in value) || value['coverage'] === undefined)
|
|
42
|
+
return false;
|
|
28
43
|
if (!('hits' in value) || value['hits'] === undefined)
|
|
29
44
|
return false;
|
|
30
45
|
return true;
|
|
@@ -38,6 +53,8 @@ function EarningsCallsDocumentSearch200ResponseFromJSONTyped(json, ignoreDiscrim
|
|
|
38
53
|
}
|
|
39
54
|
return {
|
|
40
55
|
'query': json['query'],
|
|
56
|
+
'mode': json['mode'],
|
|
57
|
+
'coverage': (0, SearchCoverage_1.SearchCoverageFromJSON)(json['coverage']),
|
|
41
58
|
'hits': (json['hits'].map(EarningsCallsDocumentSearch200ResponseHitsInner_1.EarningsCallsDocumentSearch200ResponseHitsInnerFromJSON)),
|
|
42
59
|
};
|
|
43
60
|
}
|
|
@@ -50,6 +67,8 @@ function EarningsCallsDocumentSearch200ResponseToJSONTyped(value, ignoreDiscrimi
|
|
|
50
67
|
}
|
|
51
68
|
return {
|
|
52
69
|
'query': value['query'],
|
|
70
|
+
'mode': value['mode'],
|
|
71
|
+
'coverage': (0, SearchCoverage_1.SearchCoverageToJSON)(value['coverage']),
|
|
53
72
|
'hits': (value['hits'].map(EarningsCallsDocumentSearch200ResponseHitsInner_1.EarningsCallsDocumentSearch200ResponseHitsInnerToJSON)),
|
|
54
73
|
};
|
|
55
74
|
}
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import type { HitMatch } from './HitMatch';
|
|
12
13
|
/**
|
|
13
14
|
*
|
|
14
15
|
* @export
|
|
@@ -16,11 +17,17 @@
|
|
|
16
17
|
*/
|
|
17
18
|
export interface EarningsCallsDocumentSearch200ResponseHitsInner {
|
|
18
19
|
/**
|
|
19
|
-
*
|
|
20
|
+
* Relevance per mode: lexical = ts_rank_cd (4 decimals), literal = 0 (hits are ordered newest year first), semantic = cosine similarity (4 decimals), hybrid = reciprocal-rank-fusion score (6 decimals)
|
|
20
21
|
* @type {number}
|
|
21
22
|
* @memberof EarningsCallsDocumentSearch200ResponseHitsInner
|
|
22
23
|
*/
|
|
23
24
|
score: number;
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
* @type {HitMatch}
|
|
28
|
+
* @memberof EarningsCallsDocumentSearch200ResponseHitsInner
|
|
29
|
+
*/
|
|
30
|
+
match: HitMatch;
|
|
24
31
|
/**
|
|
25
32
|
* Document identifier (company_documents: /v1/earnings-calls/company-documents/{document_id})
|
|
26
33
|
* @type {string}
|
|
@@ -88,11 +95,23 @@ export interface EarningsCallsDocumentSearch200ResponseHitsInner {
|
|
|
88
95
|
*/
|
|
89
96
|
heading: string | null;
|
|
90
97
|
/**
|
|
91
|
-
*
|
|
98
|
+
* Position of the passage among the document's passages
|
|
99
|
+
* @type {number}
|
|
100
|
+
* @memberof EarningsCallsDocumentSearch200ResponseHitsInner
|
|
101
|
+
*/
|
|
102
|
+
chunk_index: number | null;
|
|
103
|
+
/**
|
|
104
|
+
* The passage (≤ 600 characters, cut on word boundaries around the first match)
|
|
92
105
|
* @type {string}
|
|
93
106
|
* @memberof EarningsCallsDocumentSearch200ResponseHitsInner
|
|
94
107
|
*/
|
|
95
108
|
text: string;
|
|
109
|
+
/**
|
|
110
|
+
* true = text is shorter than the passage
|
|
111
|
+
* @type {boolean}
|
|
112
|
+
* @memberof EarningsCallsDocumentSearch200ResponseHitsInner
|
|
113
|
+
*/
|
|
114
|
+
text_truncated: boolean;
|
|
96
115
|
/**
|
|
97
116
|
* Document title
|
|
98
117
|
* @type {string}
|
|
@@ -19,6 +19,7 @@ exports.EarningsCallsDocumentSearch200ResponseHitsInnerFromJSON = EarningsCallsD
|
|
|
19
19
|
exports.EarningsCallsDocumentSearch200ResponseHitsInnerFromJSONTyped = EarningsCallsDocumentSearch200ResponseHitsInnerFromJSONTyped;
|
|
20
20
|
exports.EarningsCallsDocumentSearch200ResponseHitsInnerToJSON = EarningsCallsDocumentSearch200ResponseHitsInnerToJSON;
|
|
21
21
|
exports.EarningsCallsDocumentSearch200ResponseHitsInnerToJSONTyped = EarningsCallsDocumentSearch200ResponseHitsInnerToJSONTyped;
|
|
22
|
+
const HitMatch_1 = require("./HitMatch");
|
|
22
23
|
/**
|
|
23
24
|
* @export
|
|
24
25
|
*/
|
|
@@ -45,6 +46,8 @@ exports.EarningsCallsDocumentSearch200ResponseHitsInnerCategoryEnum = {
|
|
|
45
46
|
function instanceOfEarningsCallsDocumentSearch200ResponseHitsInner(value) {
|
|
46
47
|
if (!('score' in value) || value['score'] === undefined)
|
|
47
48
|
return false;
|
|
49
|
+
if (!('match' in value) || value['match'] === undefined)
|
|
50
|
+
return false;
|
|
48
51
|
if (!('document_id' in value) || value['document_id'] === undefined)
|
|
49
52
|
return false;
|
|
50
53
|
if (!('table' in value) || value['table'] === undefined)
|
|
@@ -67,8 +70,12 @@ function instanceOfEarningsCallsDocumentSearch200ResponseHitsInner(value) {
|
|
|
67
70
|
return false;
|
|
68
71
|
if (!('heading' in value) || value['heading'] === undefined)
|
|
69
72
|
return false;
|
|
73
|
+
if (!('chunk_index' in value) || value['chunk_index'] === undefined)
|
|
74
|
+
return false;
|
|
70
75
|
if (!('text' in value) || value['text'] === undefined)
|
|
71
76
|
return false;
|
|
77
|
+
if (!('text_truncated' in value) || value['text_truncated'] === undefined)
|
|
78
|
+
return false;
|
|
72
79
|
if (!('title' in value) || value['title'] === undefined)
|
|
73
80
|
return false;
|
|
74
81
|
if (!('group' in value) || value['group'] === undefined)
|
|
@@ -92,6 +99,7 @@ function EarningsCallsDocumentSearch200ResponseHitsInnerFromJSONTyped(json, igno
|
|
|
92
99
|
}
|
|
93
100
|
return {
|
|
94
101
|
'score': json['score'],
|
|
102
|
+
'match': (0, HitMatch_1.HitMatchFromJSON)(json['match']),
|
|
95
103
|
'document_id': json['document_id'],
|
|
96
104
|
'table': json['table'],
|
|
97
105
|
'event_id': json['event_id'],
|
|
@@ -103,7 +111,9 @@ function EarningsCallsDocumentSearch200ResponseHitsInnerFromJSONTyped(json, igno
|
|
|
103
111
|
'period': json['period'],
|
|
104
112
|
'page': json['page'],
|
|
105
113
|
'heading': json['heading'],
|
|
114
|
+
'chunk_index': json['chunk_index'],
|
|
106
115
|
'text': json['text'],
|
|
116
|
+
'text_truncated': json['text_truncated'],
|
|
107
117
|
'title': json['title'],
|
|
108
118
|
'group': json['group'],
|
|
109
119
|
'group_label': json['group_label'],
|
|
@@ -121,6 +131,7 @@ function EarningsCallsDocumentSearch200ResponseHitsInnerToJSONTyped(value, ignor
|
|
|
121
131
|
}
|
|
122
132
|
return {
|
|
123
133
|
'score': value['score'],
|
|
134
|
+
'match': (0, HitMatch_1.HitMatchToJSON)(value['match']),
|
|
124
135
|
'document_id': value['document_id'],
|
|
125
136
|
'table': value['table'],
|
|
126
137
|
'event_id': value['event_id'],
|
|
@@ -132,7 +143,9 @@ function EarningsCallsDocumentSearch200ResponseHitsInnerToJSONTyped(value, ignor
|
|
|
132
143
|
'period': value['period'],
|
|
133
144
|
'page': value['page'],
|
|
134
145
|
'heading': value['heading'],
|
|
146
|
+
'chunk_index': value['chunk_index'],
|
|
135
147
|
'text': value['text'],
|
|
148
|
+
'text_truncated': value['text_truncated'],
|
|
136
149
|
'title': value['title'],
|
|
137
150
|
'group': value['group'],
|
|
138
151
|
'group_label': value['group_label'],
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { EarningsCallsEvents200ResponseEventsInnerObservationsInner } from './EarningsCallsEvents200ResponseEventsInnerObservationsInner';
|
|
13
|
+
import type { EarningsCallsCalendar200ResponseEventsInnerVideo } from './EarningsCallsCalendar200ResponseEventsInnerVideo';
|
|
13
14
|
/**
|
|
14
15
|
*
|
|
15
16
|
* @export
|
|
@@ -178,6 +179,12 @@ export interface EarningsCallsEvents200ResponseEventsInner {
|
|
|
178
179
|
* @memberof EarningsCallsEvents200ResponseEventsInner
|
|
179
180
|
*/
|
|
180
181
|
webcast_url: string | null;
|
|
182
|
+
/**
|
|
183
|
+
*
|
|
184
|
+
* @type {EarningsCallsCalendar200ResponseEventsInnerVideo}
|
|
185
|
+
* @memberof EarningsCallsEvents200ResponseEventsInner
|
|
186
|
+
*/
|
|
187
|
+
video: EarningsCallsCalendar200ResponseEventsInnerVideo | null;
|
|
181
188
|
/**
|
|
182
189
|
* Date / time observations, oldest first (at most 50)
|
|
183
190
|
* @type {Array<EarningsCallsEvents200ResponseEventsInnerObservationsInner>}
|
|
@@ -20,6 +20,7 @@ exports.EarningsCallsEvents200ResponseEventsInnerFromJSONTyped = EarningsCallsEv
|
|
|
20
20
|
exports.EarningsCallsEvents200ResponseEventsInnerToJSON = EarningsCallsEvents200ResponseEventsInnerToJSON;
|
|
21
21
|
exports.EarningsCallsEvents200ResponseEventsInnerToJSONTyped = EarningsCallsEvents200ResponseEventsInnerToJSONTyped;
|
|
22
22
|
const EarningsCallsEvents200ResponseEventsInnerObservationsInner_1 = require("./EarningsCallsEvents200ResponseEventsInnerObservationsInner");
|
|
23
|
+
const EarningsCallsCalendar200ResponseEventsInnerVideo_1 = require("./EarningsCallsCalendar200ResponseEventsInnerVideo");
|
|
23
24
|
/**
|
|
24
25
|
* @export
|
|
25
26
|
*/
|
|
@@ -114,6 +115,8 @@ function instanceOfEarningsCallsEvents200ResponseEventsInner(value) {
|
|
|
114
115
|
return false;
|
|
115
116
|
if (!('webcast_url' in value) || value['webcast_url'] === undefined)
|
|
116
117
|
return false;
|
|
118
|
+
if (!('video' in value) || value['video'] === undefined)
|
|
119
|
+
return false;
|
|
117
120
|
return true;
|
|
118
121
|
}
|
|
119
122
|
function EarningsCallsEvents200ResponseEventsInnerFromJSON(json) {
|
|
@@ -151,6 +154,7 @@ function EarningsCallsEvents200ResponseEventsInnerFromJSONTyped(json, ignoreDisc
|
|
|
151
154
|
'has_press_release': json['has_press_release'],
|
|
152
155
|
'has_documents': json['has_documents'],
|
|
153
156
|
'webcast_url': json['webcast_url'],
|
|
157
|
+
'video': (0, EarningsCallsCalendar200ResponseEventsInnerVideo_1.EarningsCallsCalendar200ResponseEventsInnerVideoFromJSON)(json['video']),
|
|
154
158
|
'observations': json['observations'] == null ? undefined : (json['observations'].map(EarningsCallsEvents200ResponseEventsInnerObservationsInner_1.EarningsCallsEvents200ResponseEventsInnerObservationsInnerFromJSON)),
|
|
155
159
|
};
|
|
156
160
|
}
|
|
@@ -189,6 +193,7 @@ function EarningsCallsEvents200ResponseEventsInnerToJSONTyped(value, ignoreDiscr
|
|
|
189
193
|
'has_press_release': value['has_press_release'],
|
|
190
194
|
'has_documents': value['has_documents'],
|
|
191
195
|
'webcast_url': value['webcast_url'],
|
|
196
|
+
'video': (0, EarningsCallsCalendar200ResponseEventsInnerVideo_1.EarningsCallsCalendar200ResponseEventsInnerVideoToJSON)(value['video']),
|
|
192
197
|
'observations': value['observations'] == null ? undefined : (value['observations'].map(EarningsCallsEvents200ResponseEventsInnerObservationsInner_1.EarningsCallsEvents200ResponseEventsInnerObservationsInnerToJSON)),
|
|
193
198
|
};
|
|
194
199
|
}
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import type { EarningsCallsCalendar200ResponseEventsInnerVideo } from './EarningsCallsCalendar200ResponseEventsInnerVideo';
|
|
12
13
|
/**
|
|
13
14
|
*
|
|
14
15
|
* @export
|
|
@@ -177,6 +178,12 @@ export interface EarningsCallsLive200ResponseEventsInner {
|
|
|
177
178
|
* @memberof EarningsCallsLive200ResponseEventsInner
|
|
178
179
|
*/
|
|
179
180
|
webcast_url: string | null;
|
|
181
|
+
/**
|
|
182
|
+
*
|
|
183
|
+
* @type {EarningsCallsCalendar200ResponseEventsInnerVideo}
|
|
184
|
+
* @memberof EarningsCallsLive200ResponseEventsInner
|
|
185
|
+
*/
|
|
186
|
+
video: EarningsCallsCalendar200ResponseEventsInnerVideo | null;
|
|
180
187
|
/**
|
|
181
188
|
* WebSocket channel to subscribe to with event_id for the live transcript
|
|
182
189
|
* @type {EarningsCallsLive200ResponseEventsInnerLiveChannelEnum}
|
|
@@ -19,6 +19,7 @@ exports.EarningsCallsLive200ResponseEventsInnerFromJSON = EarningsCallsLive200Re
|
|
|
19
19
|
exports.EarningsCallsLive200ResponseEventsInnerFromJSONTyped = EarningsCallsLive200ResponseEventsInnerFromJSONTyped;
|
|
20
20
|
exports.EarningsCallsLive200ResponseEventsInnerToJSON = EarningsCallsLive200ResponseEventsInnerToJSON;
|
|
21
21
|
exports.EarningsCallsLive200ResponseEventsInnerToJSONTyped = EarningsCallsLive200ResponseEventsInnerToJSONTyped;
|
|
22
|
+
const EarningsCallsCalendar200ResponseEventsInnerVideo_1 = require("./EarningsCallsCalendar200ResponseEventsInnerVideo");
|
|
22
23
|
/**
|
|
23
24
|
* @export
|
|
24
25
|
*/
|
|
@@ -119,6 +120,8 @@ function instanceOfEarningsCallsLive200ResponseEventsInner(value) {
|
|
|
119
120
|
return false;
|
|
120
121
|
if (!('webcast_url' in value) || value['webcast_url'] === undefined)
|
|
121
122
|
return false;
|
|
123
|
+
if (!('video' in value) || value['video'] === undefined)
|
|
124
|
+
return false;
|
|
122
125
|
if (!('live_channel' in value) || value['live_channel'] === undefined)
|
|
123
126
|
return false;
|
|
124
127
|
if (value['live_channel'] !== 'earnings-calls.live')
|
|
@@ -164,6 +167,7 @@ function EarningsCallsLive200ResponseEventsInnerFromJSONTyped(json, ignoreDiscri
|
|
|
164
167
|
'has_press_release': json['has_press_release'],
|
|
165
168
|
'has_documents': json['has_documents'],
|
|
166
169
|
'webcast_url': json['webcast_url'],
|
|
170
|
+
'video': (0, EarningsCallsCalendar200ResponseEventsInnerVideo_1.EarningsCallsCalendar200ResponseEventsInnerVideoFromJSON)(json['video']),
|
|
167
171
|
'live_channel': json['live_channel'],
|
|
168
172
|
'live_audio': json['live_audio'],
|
|
169
173
|
'live_prices': json['live_prices'],
|
|
@@ -204,6 +208,7 @@ function EarningsCallsLive200ResponseEventsInnerToJSONTyped(value, ignoreDiscrim
|
|
|
204
208
|
'has_press_release': value['has_press_release'],
|
|
205
209
|
'has_documents': value['has_documents'],
|
|
206
210
|
'webcast_url': value['webcast_url'],
|
|
211
|
+
'video': (0, EarningsCallsCalendar200ResponseEventsInnerVideo_1.EarningsCallsCalendar200ResponseEventsInnerVideoToJSON)(value['video']),
|
|
207
212
|
'live_channel': value['live_channel'],
|
|
208
213
|
'live_audio': value['live_audio'],
|
|
209
214
|
'live_prices': value['live_prices'],
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { EarningsCallsSearch200ResponseHitsInner } from './EarningsCallsSearch200ResponseHitsInner';
|
|
13
|
+
import type { SearchCoverage } from './SearchCoverage';
|
|
13
14
|
/**
|
|
14
15
|
*
|
|
15
16
|
* @export
|
|
@@ -22,6 +23,18 @@ export interface EarningsCallsSearch200Response {
|
|
|
22
23
|
* @memberof EarningsCallsSearch200Response
|
|
23
24
|
*/
|
|
24
25
|
query: string;
|
|
26
|
+
/**
|
|
27
|
+
* The mode searched
|
|
28
|
+
* @type {EarningsCallsSearch200ResponseModeEnum}
|
|
29
|
+
* @memberof EarningsCallsSearch200Response
|
|
30
|
+
*/
|
|
31
|
+
mode: EarningsCallsSearch200ResponseModeEnum;
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @type {SearchCoverage}
|
|
35
|
+
* @memberof EarningsCallsSearch200Response
|
|
36
|
+
*/
|
|
37
|
+
coverage: SearchCoverage;
|
|
25
38
|
/**
|
|
26
39
|
* Passages, best match first
|
|
27
40
|
* @type {Array<EarningsCallsSearch200ResponseHitsInner>}
|
|
@@ -29,6 +42,16 @@ export interface EarningsCallsSearch200Response {
|
|
|
29
42
|
*/
|
|
30
43
|
hits: Array<EarningsCallsSearch200ResponseHitsInner>;
|
|
31
44
|
}
|
|
45
|
+
/**
|
|
46
|
+
* @export
|
|
47
|
+
*/
|
|
48
|
+
export declare const EarningsCallsSearch200ResponseModeEnum: {
|
|
49
|
+
readonly Lexical: "lexical";
|
|
50
|
+
readonly Literal: "literal";
|
|
51
|
+
readonly Semantic: "semantic";
|
|
52
|
+
readonly Hybrid: "hybrid";
|
|
53
|
+
};
|
|
54
|
+
export type EarningsCallsSearch200ResponseModeEnum = typeof EarningsCallsSearch200ResponseModeEnum[keyof typeof EarningsCallsSearch200ResponseModeEnum];
|
|
32
55
|
/**
|
|
33
56
|
* Check if a given object implements the EarningsCallsSearch200Response interface.
|
|
34
57
|
*/
|
|
@@ -13,18 +13,33 @@
|
|
|
13
13
|
* Do not edit the class manually.
|
|
14
14
|
*/
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.EarningsCallsSearch200ResponseModeEnum = void 0;
|
|
16
17
|
exports.instanceOfEarningsCallsSearch200Response = instanceOfEarningsCallsSearch200Response;
|
|
17
18
|
exports.EarningsCallsSearch200ResponseFromJSON = EarningsCallsSearch200ResponseFromJSON;
|
|
18
19
|
exports.EarningsCallsSearch200ResponseFromJSONTyped = EarningsCallsSearch200ResponseFromJSONTyped;
|
|
19
20
|
exports.EarningsCallsSearch200ResponseToJSON = EarningsCallsSearch200ResponseToJSON;
|
|
20
21
|
exports.EarningsCallsSearch200ResponseToJSONTyped = EarningsCallsSearch200ResponseToJSONTyped;
|
|
21
22
|
const EarningsCallsSearch200ResponseHitsInner_1 = require("./EarningsCallsSearch200ResponseHitsInner");
|
|
23
|
+
const SearchCoverage_1 = require("./SearchCoverage");
|
|
24
|
+
/**
|
|
25
|
+
* @export
|
|
26
|
+
*/
|
|
27
|
+
exports.EarningsCallsSearch200ResponseModeEnum = {
|
|
28
|
+
Lexical: 'lexical',
|
|
29
|
+
Literal: 'literal',
|
|
30
|
+
Semantic: 'semantic',
|
|
31
|
+
Hybrid: 'hybrid'
|
|
32
|
+
};
|
|
22
33
|
/**
|
|
23
34
|
* Check if a given object implements the EarningsCallsSearch200Response interface.
|
|
24
35
|
*/
|
|
25
36
|
function instanceOfEarningsCallsSearch200Response(value) {
|
|
26
37
|
if (!('query' in value) || value['query'] === undefined)
|
|
27
38
|
return false;
|
|
39
|
+
if (!('mode' in value) || value['mode'] === undefined)
|
|
40
|
+
return false;
|
|
41
|
+
if (!('coverage' in value) || value['coverage'] === undefined)
|
|
42
|
+
return false;
|
|
28
43
|
if (!('hits' in value) || value['hits'] === undefined)
|
|
29
44
|
return false;
|
|
30
45
|
return true;
|
|
@@ -38,6 +53,8 @@ function EarningsCallsSearch200ResponseFromJSONTyped(json, ignoreDiscriminator)
|
|
|
38
53
|
}
|
|
39
54
|
return {
|
|
40
55
|
'query': json['query'],
|
|
56
|
+
'mode': json['mode'],
|
|
57
|
+
'coverage': (0, SearchCoverage_1.SearchCoverageFromJSON)(json['coverage']),
|
|
41
58
|
'hits': (json['hits'].map(EarningsCallsSearch200ResponseHitsInner_1.EarningsCallsSearch200ResponseHitsInnerFromJSON)),
|
|
42
59
|
};
|
|
43
60
|
}
|
|
@@ -50,6 +67,8 @@ function EarningsCallsSearch200ResponseToJSONTyped(value, ignoreDiscriminator =
|
|
|
50
67
|
}
|
|
51
68
|
return {
|
|
52
69
|
'query': value['query'],
|
|
70
|
+
'mode': value['mode'],
|
|
71
|
+
'coverage': (0, SearchCoverage_1.SearchCoverageToJSON)(value['coverage']),
|
|
53
72
|
'hits': (value['hits'].map(EarningsCallsSearch200ResponseHitsInner_1.EarningsCallsSearch200ResponseHitsInnerToJSON)),
|
|
54
73
|
};
|
|
55
74
|
}
|
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { EarningsCallsExtractions200ResponseGuidanceInnerSourcesInnerSpeaker } from './EarningsCallsExtractions200ResponseGuidanceInnerSourcesInnerSpeaker';
|
|
13
13
|
import type { EarningsCallsSearch200ResponseHitsInnerSlide } from './EarningsCallsSearch200ResponseHitsInnerSlide';
|
|
14
|
+
import type { HitMatch } from './HitMatch';
|
|
14
15
|
/**
|
|
15
16
|
*
|
|
16
17
|
* @export
|
|
@@ -78,17 +79,35 @@ export interface EarningsCallsSearch200ResponseHitsInner {
|
|
|
78
79
|
*/
|
|
79
80
|
end_ms: number | null;
|
|
80
81
|
/**
|
|
81
|
-
*
|
|
82
|
+
* Position of the passage among the call's transcript (or slide) passages; null for a passage indexed before positions were stored
|
|
83
|
+
* @type {number}
|
|
84
|
+
* @memberof EarningsCallsSearch200ResponseHitsInner
|
|
85
|
+
*/
|
|
86
|
+
chunk_index: number | null;
|
|
87
|
+
/**
|
|
88
|
+
* The passage, cut to at most 600 characters on word boundaries around the first match
|
|
82
89
|
* @type {string}
|
|
83
90
|
* @memberof EarningsCallsSearch200ResponseHitsInner
|
|
84
91
|
*/
|
|
85
92
|
text: string;
|
|
86
93
|
/**
|
|
87
|
-
*
|
|
94
|
+
* true = text is shorter than the passage
|
|
95
|
+
* @type {boolean}
|
|
96
|
+
* @memberof EarningsCallsSearch200ResponseHitsInner
|
|
97
|
+
*/
|
|
98
|
+
text_truncated: boolean;
|
|
99
|
+
/**
|
|
100
|
+
* Relevance per mode: lexical = ts_rank_cd (4 decimals), literal = 0 (hits are ordered newest call first), semantic = cosine similarity (4 decimals), hybrid = reciprocal-rank-fusion score (6 decimals)
|
|
88
101
|
* @type {number}
|
|
89
102
|
* @memberof EarningsCallsSearch200ResponseHitsInner
|
|
90
103
|
*/
|
|
91
104
|
score: number;
|
|
105
|
+
/**
|
|
106
|
+
*
|
|
107
|
+
* @type {HitMatch}
|
|
108
|
+
* @memberof EarningsCallsSearch200ResponseHitsInner
|
|
109
|
+
*/
|
|
110
|
+
match: HitMatch;
|
|
92
111
|
/**
|
|
93
112
|
* The recording's permanent URL opening at the passage (#t=<seconds>); null without the PRO plan, without a servable recording, without start_ms or for an audio opt-out.
|
|
94
113
|
* @type {string}
|
|
@@ -21,6 +21,7 @@ exports.EarningsCallsSearch200ResponseHitsInnerToJSON = EarningsCallsSearch200Re
|
|
|
21
21
|
exports.EarningsCallsSearch200ResponseHitsInnerToJSONTyped = EarningsCallsSearch200ResponseHitsInnerToJSONTyped;
|
|
22
22
|
const EarningsCallsExtractions200ResponseGuidanceInnerSourcesInnerSpeaker_1 = require("./EarningsCallsExtractions200ResponseGuidanceInnerSourcesInnerSpeaker");
|
|
23
23
|
const EarningsCallsSearch200ResponseHitsInnerSlide_1 = require("./EarningsCallsSearch200ResponseHitsInnerSlide");
|
|
24
|
+
const HitMatch_1 = require("./HitMatch");
|
|
24
25
|
/**
|
|
25
26
|
* @export
|
|
26
27
|
*/
|
|
@@ -54,10 +55,16 @@ function instanceOfEarningsCallsSearch200ResponseHitsInner(value) {
|
|
|
54
55
|
return false;
|
|
55
56
|
if (!('end_ms' in value) || value['end_ms'] === undefined)
|
|
56
57
|
return false;
|
|
58
|
+
if (!('chunk_index' in value) || value['chunk_index'] === undefined)
|
|
59
|
+
return false;
|
|
57
60
|
if (!('text' in value) || value['text'] === undefined)
|
|
58
61
|
return false;
|
|
62
|
+
if (!('text_truncated' in value) || value['text_truncated'] === undefined)
|
|
63
|
+
return false;
|
|
59
64
|
if (!('score' in value) || value['score'] === undefined)
|
|
60
65
|
return false;
|
|
66
|
+
if (!('match' in value) || value['match'] === undefined)
|
|
67
|
+
return false;
|
|
61
68
|
if (!('audio_url' in value) || value['audio_url'] === undefined)
|
|
62
69
|
return false;
|
|
63
70
|
if (!('slide' in value) || value['slide'] === undefined)
|
|
@@ -82,8 +89,11 @@ function EarningsCallsSearch200ResponseHitsInnerFromJSONTyped(json, ignoreDiscri
|
|
|
82
89
|
'speaker': (0, EarningsCallsExtractions200ResponseGuidanceInnerSourcesInnerSpeaker_1.EarningsCallsExtractions200ResponseGuidanceInnerSourcesInnerSpeakerFromJSON)(json['speaker']),
|
|
83
90
|
'start_ms': json['start_ms'],
|
|
84
91
|
'end_ms': json['end_ms'],
|
|
92
|
+
'chunk_index': json['chunk_index'],
|
|
85
93
|
'text': json['text'],
|
|
94
|
+
'text_truncated': json['text_truncated'],
|
|
86
95
|
'score': json['score'],
|
|
96
|
+
'match': (0, HitMatch_1.HitMatchFromJSON)(json['match']),
|
|
87
97
|
'audio_url': json['audio_url'],
|
|
88
98
|
'slide': (0, EarningsCallsSearch200ResponseHitsInnerSlide_1.EarningsCallsSearch200ResponseHitsInnerSlideFromJSON)(json['slide']),
|
|
89
99
|
};
|
|
@@ -106,8 +116,11 @@ function EarningsCallsSearch200ResponseHitsInnerToJSONTyped(value, ignoreDiscrim
|
|
|
106
116
|
'speaker': (0, EarningsCallsExtractions200ResponseGuidanceInnerSourcesInnerSpeaker_1.EarningsCallsExtractions200ResponseGuidanceInnerSourcesInnerSpeakerToJSON)(value['speaker']),
|
|
107
117
|
'start_ms': value['start_ms'],
|
|
108
118
|
'end_ms': value['end_ms'],
|
|
119
|
+
'chunk_index': value['chunk_index'],
|
|
109
120
|
'text': value['text'],
|
|
121
|
+
'text_truncated': value['text_truncated'],
|
|
110
122
|
'score': value['score'],
|
|
123
|
+
'match': (0, HitMatch_1.HitMatchToJSON)(value['match']),
|
|
111
124
|
'audio_url': value['audio_url'],
|
|
112
125
|
'slide': (0, EarningsCallsSearch200ResponseHitsInnerSlide_1.EarningsCallsSearch200ResponseHitsInnerSlideToJSON)(value['slide']),
|
|
113
126
|
};
|
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
import type { EarningsCallsLiveStream200ResponseEvent } from './EarningsCallsLiveStream200ResponseEvent';
|
|
13
13
|
import type { EarningsCallsSlides200ResponseDeck } from './EarningsCallsSlides200ResponseDeck';
|
|
14
14
|
import type { EarningsCallsSlides200ResponseSlidesInner } from './EarningsCallsSlides200ResponseSlidesInner';
|
|
15
|
+
import type { EarningsCallsSlides200ResponseTimelineInner } from './EarningsCallsSlides200ResponseTimelineInner';
|
|
15
16
|
/**
|
|
16
17
|
*
|
|
17
18
|
* @export
|
|
@@ -36,6 +37,12 @@ export interface EarningsCallsSlides200Response {
|
|
|
36
37
|
* @memberof EarningsCallsSlides200Response
|
|
37
38
|
*/
|
|
38
39
|
slides: Array<EarningsCallsSlides200ResponseSlidesInner>;
|
|
40
|
+
/**
|
|
41
|
+
* Player slides keyed to the call audio (ms from the audio's start), ascending; [] when the webcast player showed no slides
|
|
42
|
+
* @type {Array<EarningsCallsSlides200ResponseTimelineInner>}
|
|
43
|
+
* @memberof EarningsCallsSlides200Response
|
|
44
|
+
*/
|
|
45
|
+
timeline: Array<EarningsCallsSlides200ResponseTimelineInner>;
|
|
39
46
|
}
|
|
40
47
|
/**
|
|
41
48
|
* Check if a given object implements the EarningsCallsSlides200Response interface.
|
|
@@ -21,6 +21,7 @@ exports.EarningsCallsSlides200ResponseToJSONTyped = EarningsCallsSlides200Respon
|
|
|
21
21
|
const EarningsCallsLiveStream200ResponseEvent_1 = require("./EarningsCallsLiveStream200ResponseEvent");
|
|
22
22
|
const EarningsCallsSlides200ResponseDeck_1 = require("./EarningsCallsSlides200ResponseDeck");
|
|
23
23
|
const EarningsCallsSlides200ResponseSlidesInner_1 = require("./EarningsCallsSlides200ResponseSlidesInner");
|
|
24
|
+
const EarningsCallsSlides200ResponseTimelineInner_1 = require("./EarningsCallsSlides200ResponseTimelineInner");
|
|
24
25
|
/**
|
|
25
26
|
* Check if a given object implements the EarningsCallsSlides200Response interface.
|
|
26
27
|
*/
|
|
@@ -31,6 +32,8 @@ function instanceOfEarningsCallsSlides200Response(value) {
|
|
|
31
32
|
return false;
|
|
32
33
|
if (!('slides' in value) || value['slides'] === undefined)
|
|
33
34
|
return false;
|
|
35
|
+
if (!('timeline' in value) || value['timeline'] === undefined)
|
|
36
|
+
return false;
|
|
34
37
|
return true;
|
|
35
38
|
}
|
|
36
39
|
function EarningsCallsSlides200ResponseFromJSON(json) {
|
|
@@ -44,6 +47,7 @@ function EarningsCallsSlides200ResponseFromJSONTyped(json, ignoreDiscriminator)
|
|
|
44
47
|
'event': (0, EarningsCallsLiveStream200ResponseEvent_1.EarningsCallsLiveStream200ResponseEventFromJSON)(json['event']),
|
|
45
48
|
'deck': (0, EarningsCallsSlides200ResponseDeck_1.EarningsCallsSlides200ResponseDeckFromJSON)(json['deck']),
|
|
46
49
|
'slides': (json['slides'].map(EarningsCallsSlides200ResponseSlidesInner_1.EarningsCallsSlides200ResponseSlidesInnerFromJSON)),
|
|
50
|
+
'timeline': (json['timeline'].map(EarningsCallsSlides200ResponseTimelineInner_1.EarningsCallsSlides200ResponseTimelineInnerFromJSON)),
|
|
47
51
|
};
|
|
48
52
|
}
|
|
49
53
|
function EarningsCallsSlides200ResponseToJSON(json) {
|
|
@@ -57,5 +61,6 @@ function EarningsCallsSlides200ResponseToJSONTyped(value, ignoreDiscriminator =
|
|
|
57
61
|
'event': (0, EarningsCallsLiveStream200ResponseEvent_1.EarningsCallsLiveStream200ResponseEventToJSON)(value['event']),
|
|
58
62
|
'deck': (0, EarningsCallsSlides200ResponseDeck_1.EarningsCallsSlides200ResponseDeckToJSON)(value['deck']),
|
|
59
63
|
'slides': (value['slides'].map(EarningsCallsSlides200ResponseSlidesInner_1.EarningsCallsSlides200ResponseSlidesInnerToJSON)),
|
|
64
|
+
'timeline': (value['timeline'].map(EarningsCallsSlides200ResponseTimelineInner_1.EarningsCallsSlides200ResponseTimelineInnerToJSON)),
|
|
60
65
|
};
|
|
61
66
|
}
|
|
@@ -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. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK); 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` | ≤ 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. 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, 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 EarningsCallsSlides200ResponseTimelineInner
|
|
16
|
+
*/
|
|
17
|
+
export interface EarningsCallsSlides200ResponseTimelineInner {
|
|
18
|
+
/**
|
|
19
|
+
* When the slide appeared, in ms from the start of the event's audio file
|
|
20
|
+
* @type {number}
|
|
21
|
+
* @memberof EarningsCallsSlides200ResponseTimelineInner
|
|
22
|
+
*/
|
|
23
|
+
at_ms: number;
|
|
24
|
+
/**
|
|
25
|
+
* Signed URL of the slide screenshot (same expiry as the deck)
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof EarningsCallsSlides200ResponseTimelineInner
|
|
28
|
+
*/
|
|
29
|
+
image_url: string;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Check if a given object implements the EarningsCallsSlides200ResponseTimelineInner interface.
|
|
33
|
+
*/
|
|
34
|
+
export declare function instanceOfEarningsCallsSlides200ResponseTimelineInner(value: object): value is EarningsCallsSlides200ResponseTimelineInner;
|
|
35
|
+
export declare function EarningsCallsSlides200ResponseTimelineInnerFromJSON(json: any): EarningsCallsSlides200ResponseTimelineInner;
|
|
36
|
+
export declare function EarningsCallsSlides200ResponseTimelineInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): EarningsCallsSlides200ResponseTimelineInner;
|
|
37
|
+
export declare function EarningsCallsSlides200ResponseTimelineInnerToJSON(json: any): EarningsCallsSlides200ResponseTimelineInner;
|
|
38
|
+
export declare function EarningsCallsSlides200ResponseTimelineInnerToJSONTyped(value?: EarningsCallsSlides200ResponseTimelineInner | null, ignoreDiscriminator?: boolean): any;
|