@invinite-org/data-api-client 0.3.0 → 0.5.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 +42 -6
- package/dist/apis/EarningsCallsApi.js +47 -7
- package/dist/esm/apis/EarningsCallsApi.d.ts +42 -6
- package/dist/esm/apis/EarningsCallsApi.js +46 -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 +21 -0
- package/dist/esm/models/EarningsCallsDocumentSearch200Response.js +16 -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 +21 -0
- package/dist/esm/models/EarningsCallsSearch200Response.js +16 -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 +53 -0
- package/dist/esm/models/HitMatch.js +59 -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 +63 -0
- package/dist/esm/models/SearchCoverage.js +68 -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 +21 -0
- package/dist/models/EarningsCallsDocumentSearch200Response.js +17 -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 +21 -0
- package/dist/models/EarningsCallsSearch200Response.js +17 -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 +53 -0
- package/dist/models/HitMatch.js +67 -0
- package/dist/models/MatchSpan.d.ts +38 -0
- package/dist/models/MatchSpan.js +54 -0
- package/dist/models/SearchCoverage.d.ts +63 -0
- package/dist/models/SearchCoverage.js +76 -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 -12
- 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 +39 -0
- package/docs/MatchSpan.md +36 -0
- package/docs/SearchCoverage.md +39 -0
- package/docs/SearchCoverageLeg.md +41 -0
- package/package.json +1 -1
- package/src/apis/EarningsCallsApi.ts +58 -6
- package/src/models/EarningsCallsCalendar200ResponseEventsInner.ts +17 -0
- package/src/models/EarningsCallsCalendar200ResponseEventsInnerVideo.ts +140 -0
- package/src/models/EarningsCallsDocumentSearch200Response.ts +36 -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 +36 -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 +103 -0
- package/src/models/MatchSpan.ts +75 -0
- package/src/models/SearchCoverage.ts +114 -0
- package/src/models/SearchCoverageLeg.ts +105 -0
- package/src/models/index.ts +6 -0
|
@@ -13,6 +13,14 @@
|
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
15
|
import { mapValues } from '../runtime';
|
|
16
|
+
import type { EarningsCallsCalendar200ResponseEventsInnerVideo } from './EarningsCallsCalendar200ResponseEventsInnerVideo';
|
|
17
|
+
import {
|
|
18
|
+
EarningsCallsCalendar200ResponseEventsInnerVideoFromJSON,
|
|
19
|
+
EarningsCallsCalendar200ResponseEventsInnerVideoFromJSONTyped,
|
|
20
|
+
EarningsCallsCalendar200ResponseEventsInnerVideoToJSON,
|
|
21
|
+
EarningsCallsCalendar200ResponseEventsInnerVideoToJSONTyped,
|
|
22
|
+
} from './EarningsCallsCalendar200ResponseEventsInnerVideo';
|
|
23
|
+
|
|
16
24
|
/**
|
|
17
25
|
*
|
|
18
26
|
* @export
|
|
@@ -181,6 +189,12 @@ export interface EarningsCallsLive200ResponseEventsInner {
|
|
|
181
189
|
* @memberof EarningsCallsLive200ResponseEventsInner
|
|
182
190
|
*/
|
|
183
191
|
webcast_url: string | null;
|
|
192
|
+
/**
|
|
193
|
+
*
|
|
194
|
+
* @type {EarningsCallsCalendar200ResponseEventsInnerVideo}
|
|
195
|
+
* @memberof EarningsCallsLive200ResponseEventsInner
|
|
196
|
+
*/
|
|
197
|
+
video: EarningsCallsCalendar200ResponseEventsInnerVideo | null;
|
|
184
198
|
/**
|
|
185
199
|
* WebSocket channel to subscribe to with event_id for the live transcript
|
|
186
200
|
* @type {EarningsCallsLive200ResponseEventsInnerLiveChannelEnum}
|
|
@@ -286,6 +300,7 @@ export function instanceOfEarningsCallsLive200ResponseEventsInner(value: object)
|
|
|
286
300
|
if (!('has_press_release' in value) || value['has_press_release'] === undefined) return false;
|
|
287
301
|
if (!('has_documents' in value) || value['has_documents'] === undefined) return false;
|
|
288
302
|
if (!('webcast_url' in value) || value['webcast_url'] === undefined) return false;
|
|
303
|
+
if (!('video' in value) || value['video'] === undefined) return false;
|
|
289
304
|
if (!('live_channel' in value) || value['live_channel'] === undefined) return false;
|
|
290
305
|
if (value['live_channel'] !== 'earnings-calls.live') return false;
|
|
291
306
|
|
|
@@ -331,6 +346,7 @@ export function EarningsCallsLive200ResponseEventsInnerFromJSONTyped(json: any,
|
|
|
331
346
|
'has_press_release': json['has_press_release'],
|
|
332
347
|
'has_documents': json['has_documents'],
|
|
333
348
|
'webcast_url': json['webcast_url'],
|
|
349
|
+
'video': EarningsCallsCalendar200ResponseEventsInnerVideoFromJSON(json['video']),
|
|
334
350
|
'live_channel': json['live_channel'],
|
|
335
351
|
'live_audio': json['live_audio'],
|
|
336
352
|
'live_prices': json['live_prices'],
|
|
@@ -375,6 +391,7 @@ export function EarningsCallsLive200ResponseEventsInnerToJSONTyped(value?: Earni
|
|
|
375
391
|
'has_press_release': value['has_press_release'],
|
|
376
392
|
'has_documents': value['has_documents'],
|
|
377
393
|
'webcast_url': value['webcast_url'],
|
|
394
|
+
'video': EarningsCallsCalendar200ResponseEventsInnerVideoToJSON(value['video']),
|
|
378
395
|
'live_channel': value['live_channel'],
|
|
379
396
|
'live_audio': value['live_audio'],
|
|
380
397
|
'live_prices': value['live_prices'],
|
|
@@ -20,6 +20,13 @@ import {
|
|
|
20
20
|
EarningsCallsSearch200ResponseHitsInnerToJSON,
|
|
21
21
|
EarningsCallsSearch200ResponseHitsInnerToJSONTyped,
|
|
22
22
|
} from './EarningsCallsSearch200ResponseHitsInner';
|
|
23
|
+
import type { SearchCoverage } from './SearchCoverage';
|
|
24
|
+
import {
|
|
25
|
+
SearchCoverageFromJSON,
|
|
26
|
+
SearchCoverageFromJSONTyped,
|
|
27
|
+
SearchCoverageToJSON,
|
|
28
|
+
SearchCoverageToJSONTyped,
|
|
29
|
+
} from './SearchCoverage';
|
|
23
30
|
|
|
24
31
|
/**
|
|
25
32
|
*
|
|
@@ -33,6 +40,18 @@ export interface EarningsCallsSearch200Response {
|
|
|
33
40
|
* @memberof EarningsCallsSearch200Response
|
|
34
41
|
*/
|
|
35
42
|
query: string;
|
|
43
|
+
/**
|
|
44
|
+
* The mode searched
|
|
45
|
+
* @type {EarningsCallsSearch200ResponseModeEnum}
|
|
46
|
+
* @memberof EarningsCallsSearch200Response
|
|
47
|
+
*/
|
|
48
|
+
mode: EarningsCallsSearch200ResponseModeEnum;
|
|
49
|
+
/**
|
|
50
|
+
*
|
|
51
|
+
* @type {SearchCoverage}
|
|
52
|
+
* @memberof EarningsCallsSearch200Response
|
|
53
|
+
*/
|
|
54
|
+
coverage: SearchCoverage;
|
|
36
55
|
/**
|
|
37
56
|
* Passages, best match first
|
|
38
57
|
* @type {Array<EarningsCallsSearch200ResponseHitsInner>}
|
|
@@ -41,11 +60,24 @@ export interface EarningsCallsSearch200Response {
|
|
|
41
60
|
hits: Array<EarningsCallsSearch200ResponseHitsInner>;
|
|
42
61
|
}
|
|
43
62
|
|
|
63
|
+
|
|
64
|
+
/**
|
|
65
|
+
* @export
|
|
66
|
+
*/
|
|
67
|
+
export const EarningsCallsSearch200ResponseModeEnum = {
|
|
68
|
+
Lexical: 'lexical',
|
|
69
|
+
Literal: 'literal'
|
|
70
|
+
} as const;
|
|
71
|
+
export type EarningsCallsSearch200ResponseModeEnum = typeof EarningsCallsSearch200ResponseModeEnum[keyof typeof EarningsCallsSearch200ResponseModeEnum];
|
|
72
|
+
|
|
73
|
+
|
|
44
74
|
/**
|
|
45
75
|
* Check if a given object implements the EarningsCallsSearch200Response interface.
|
|
46
76
|
*/
|
|
47
77
|
export function instanceOfEarningsCallsSearch200Response(value: object): value is EarningsCallsSearch200Response {
|
|
48
78
|
if (!('query' in value) || value['query'] === undefined) return false;
|
|
79
|
+
if (!('mode' in value) || value['mode'] === undefined) return false;
|
|
80
|
+
if (!('coverage' in value) || value['coverage'] === undefined) return false;
|
|
49
81
|
if (!('hits' in value) || value['hits'] === undefined) return false;
|
|
50
82
|
return true;
|
|
51
83
|
}
|
|
@@ -61,6 +93,8 @@ export function EarningsCallsSearch200ResponseFromJSONTyped(json: any, ignoreDis
|
|
|
61
93
|
return {
|
|
62
94
|
|
|
63
95
|
'query': json['query'],
|
|
96
|
+
'mode': json['mode'],
|
|
97
|
+
'coverage': SearchCoverageFromJSON(json['coverage']),
|
|
64
98
|
'hits': ((json['hits'] as Array<any>).map(EarningsCallsSearch200ResponseHitsInnerFromJSON)),
|
|
65
99
|
};
|
|
66
100
|
}
|
|
@@ -77,6 +111,8 @@ export function EarningsCallsSearch200ResponseToJSONTyped(value?: EarningsCallsS
|
|
|
77
111
|
return {
|
|
78
112
|
|
|
79
113
|
'query': value['query'],
|
|
114
|
+
'mode': value['mode'],
|
|
115
|
+
'coverage': SearchCoverageToJSON(value['coverage']),
|
|
80
116
|
'hits': ((value['hits'] as Array<any>).map(EarningsCallsSearch200ResponseHitsInnerToJSON)),
|
|
81
117
|
};
|
|
82
118
|
}
|
|
@@ -27,6 +27,13 @@ import {
|
|
|
27
27
|
EarningsCallsSearch200ResponseHitsInnerSlideToJSON,
|
|
28
28
|
EarningsCallsSearch200ResponseHitsInnerSlideToJSONTyped,
|
|
29
29
|
} from './EarningsCallsSearch200ResponseHitsInnerSlide';
|
|
30
|
+
import type { HitMatch } from './HitMatch';
|
|
31
|
+
import {
|
|
32
|
+
HitMatchFromJSON,
|
|
33
|
+
HitMatchFromJSONTyped,
|
|
34
|
+
HitMatchToJSON,
|
|
35
|
+
HitMatchToJSONTyped,
|
|
36
|
+
} from './HitMatch';
|
|
30
37
|
|
|
31
38
|
/**
|
|
32
39
|
*
|
|
@@ -95,17 +102,35 @@ export interface EarningsCallsSearch200ResponseHitsInner {
|
|
|
95
102
|
*/
|
|
96
103
|
end_ms: number | null;
|
|
97
104
|
/**
|
|
98
|
-
*
|
|
105
|
+
* Position of the passage among the call's transcript (or slide) passages; null for a passage indexed before positions were stored
|
|
106
|
+
* @type {number}
|
|
107
|
+
* @memberof EarningsCallsSearch200ResponseHitsInner
|
|
108
|
+
*/
|
|
109
|
+
chunk_index: number | null;
|
|
110
|
+
/**
|
|
111
|
+
* The passage, cut to at most 600 characters on word boundaries around the first match
|
|
99
112
|
* @type {string}
|
|
100
113
|
* @memberof EarningsCallsSearch200ResponseHitsInner
|
|
101
114
|
*/
|
|
102
115
|
text: string;
|
|
103
116
|
/**
|
|
104
|
-
*
|
|
117
|
+
* true = text is shorter than the passage
|
|
118
|
+
* @type {boolean}
|
|
119
|
+
* @memberof EarningsCallsSearch200ResponseHitsInner
|
|
120
|
+
*/
|
|
121
|
+
text_truncated: boolean;
|
|
122
|
+
/**
|
|
123
|
+
* Relevance per mode: lexical = BM25 with `identifier` / `event_id` (an answer attached to its question scores 0.99 × the question), else ts_rank_cd (4 decimals), literal = 0 (hits are ordered newest call first)
|
|
105
124
|
* @type {number}
|
|
106
125
|
* @memberof EarningsCallsSearch200ResponseHitsInner
|
|
107
126
|
*/
|
|
108
127
|
score: number;
|
|
128
|
+
/**
|
|
129
|
+
*
|
|
130
|
+
* @type {HitMatch}
|
|
131
|
+
* @memberof EarningsCallsSearch200ResponseHitsInner
|
|
132
|
+
*/
|
|
133
|
+
match: HitMatch;
|
|
109
134
|
/**
|
|
110
135
|
* 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.
|
|
111
136
|
* @type {string}
|
|
@@ -147,8 +172,11 @@ export function instanceOfEarningsCallsSearch200ResponseHitsInner(value: object)
|
|
|
147
172
|
if (!('speaker' in value) || value['speaker'] === undefined) return false;
|
|
148
173
|
if (!('start_ms' in value) || value['start_ms'] === undefined) return false;
|
|
149
174
|
if (!('end_ms' in value) || value['end_ms'] === undefined) return false;
|
|
175
|
+
if (!('chunk_index' in value) || value['chunk_index'] === undefined) return false;
|
|
150
176
|
if (!('text' in value) || value['text'] === undefined) return false;
|
|
177
|
+
if (!('text_truncated' in value) || value['text_truncated'] === undefined) return false;
|
|
151
178
|
if (!('score' in value) || value['score'] === undefined) return false;
|
|
179
|
+
if (!('match' in value) || value['match'] === undefined) return false;
|
|
152
180
|
if (!('audio_url' in value) || value['audio_url'] === undefined) return false;
|
|
153
181
|
if (!('slide' in value) || value['slide'] === undefined) return false;
|
|
154
182
|
return true;
|
|
@@ -174,8 +202,11 @@ export function EarningsCallsSearch200ResponseHitsInnerFromJSONTyped(json: any,
|
|
|
174
202
|
'speaker': EarningsCallsExtractions200ResponseGuidanceInnerSourcesInnerSpeakerFromJSON(json['speaker']),
|
|
175
203
|
'start_ms': json['start_ms'],
|
|
176
204
|
'end_ms': json['end_ms'],
|
|
205
|
+
'chunk_index': json['chunk_index'],
|
|
177
206
|
'text': json['text'],
|
|
207
|
+
'text_truncated': json['text_truncated'],
|
|
178
208
|
'score': json['score'],
|
|
209
|
+
'match': HitMatchFromJSON(json['match']),
|
|
179
210
|
'audio_url': json['audio_url'],
|
|
180
211
|
'slide': EarningsCallsSearch200ResponseHitsInnerSlideFromJSON(json['slide']),
|
|
181
212
|
};
|
|
@@ -202,8 +233,11 @@ export function EarningsCallsSearch200ResponseHitsInnerToJSONTyped(value?: Earni
|
|
|
202
233
|
'speaker': EarningsCallsExtractions200ResponseGuidanceInnerSourcesInnerSpeakerToJSON(value['speaker']),
|
|
203
234
|
'start_ms': value['start_ms'],
|
|
204
235
|
'end_ms': value['end_ms'],
|
|
236
|
+
'chunk_index': value['chunk_index'],
|
|
205
237
|
'text': value['text'],
|
|
238
|
+
'text_truncated': value['text_truncated'],
|
|
206
239
|
'score': value['score'],
|
|
240
|
+
'match': HitMatchToJSON(value['match']),
|
|
207
241
|
'audio_url': value['audio_url'],
|
|
208
242
|
'slide': EarningsCallsSearch200ResponseHitsInnerSlideToJSON(value['slide']),
|
|
209
243
|
};
|
|
@@ -34,6 +34,13 @@ import {
|
|
|
34
34
|
EarningsCallsSlides200ResponseSlidesInnerToJSON,
|
|
35
35
|
EarningsCallsSlides200ResponseSlidesInnerToJSONTyped,
|
|
36
36
|
} from './EarningsCallsSlides200ResponseSlidesInner';
|
|
37
|
+
import type { EarningsCallsSlides200ResponseTimelineInner } from './EarningsCallsSlides200ResponseTimelineInner';
|
|
38
|
+
import {
|
|
39
|
+
EarningsCallsSlides200ResponseTimelineInnerFromJSON,
|
|
40
|
+
EarningsCallsSlides200ResponseTimelineInnerFromJSONTyped,
|
|
41
|
+
EarningsCallsSlides200ResponseTimelineInnerToJSON,
|
|
42
|
+
EarningsCallsSlides200ResponseTimelineInnerToJSONTyped,
|
|
43
|
+
} from './EarningsCallsSlides200ResponseTimelineInner';
|
|
37
44
|
|
|
38
45
|
/**
|
|
39
46
|
*
|
|
@@ -59,6 +66,12 @@ export interface EarningsCallsSlides200Response {
|
|
|
59
66
|
* @memberof EarningsCallsSlides200Response
|
|
60
67
|
*/
|
|
61
68
|
slides: Array<EarningsCallsSlides200ResponseSlidesInner>;
|
|
69
|
+
/**
|
|
70
|
+
* Player slides keyed to the call audio (ms from the audio's start), ascending; [] when the webcast player showed no slides
|
|
71
|
+
* @type {Array<EarningsCallsSlides200ResponseTimelineInner>}
|
|
72
|
+
* @memberof EarningsCallsSlides200Response
|
|
73
|
+
*/
|
|
74
|
+
timeline: Array<EarningsCallsSlides200ResponseTimelineInner>;
|
|
62
75
|
}
|
|
63
76
|
|
|
64
77
|
/**
|
|
@@ -68,6 +81,7 @@ export function instanceOfEarningsCallsSlides200Response(value: object): value i
|
|
|
68
81
|
if (!('event' in value) || value['event'] === undefined) return false;
|
|
69
82
|
if (!('deck' in value) || value['deck'] === undefined) return false;
|
|
70
83
|
if (!('slides' in value) || value['slides'] === undefined) return false;
|
|
84
|
+
if (!('timeline' in value) || value['timeline'] === undefined) return false;
|
|
71
85
|
return true;
|
|
72
86
|
}
|
|
73
87
|
|
|
@@ -84,6 +98,7 @@ export function EarningsCallsSlides200ResponseFromJSONTyped(json: any, ignoreDis
|
|
|
84
98
|
'event': EarningsCallsLiveStream200ResponseEventFromJSON(json['event']),
|
|
85
99
|
'deck': EarningsCallsSlides200ResponseDeckFromJSON(json['deck']),
|
|
86
100
|
'slides': ((json['slides'] as Array<any>).map(EarningsCallsSlides200ResponseSlidesInnerFromJSON)),
|
|
101
|
+
'timeline': ((json['timeline'] as Array<any>).map(EarningsCallsSlides200ResponseTimelineInnerFromJSON)),
|
|
87
102
|
};
|
|
88
103
|
}
|
|
89
104
|
|
|
@@ -101,6 +116,7 @@ export function EarningsCallsSlides200ResponseToJSONTyped(value?: EarningsCallsS
|
|
|
101
116
|
'event': EarningsCallsLiveStream200ResponseEventToJSON(value['event']),
|
|
102
117
|
'deck': EarningsCallsSlides200ResponseDeckToJSON(value['deck']),
|
|
103
118
|
'slides': ((value['slides'] as Array<any>).map(EarningsCallsSlides200ResponseSlidesInnerToJSON)),
|
|
119
|
+
'timeline': ((value['timeline'] as Array<any>).map(EarningsCallsSlides200ResponseTimelineInnerToJSON)),
|
|
104
120
|
};
|
|
105
121
|
}
|
|
106
122
|
|
|
@@ -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. ## 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.
|
|
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 EarningsCallsSlides200ResponseTimelineInner
|
|
20
|
+
*/
|
|
21
|
+
export interface EarningsCallsSlides200ResponseTimelineInner {
|
|
22
|
+
/**
|
|
23
|
+
* When the slide appeared, in ms from the start of the event's audio file
|
|
24
|
+
* @type {number}
|
|
25
|
+
* @memberof EarningsCallsSlides200ResponseTimelineInner
|
|
26
|
+
*/
|
|
27
|
+
at_ms: number;
|
|
28
|
+
/**
|
|
29
|
+
* Signed URL of the slide screenshot (same expiry as the deck)
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof EarningsCallsSlides200ResponseTimelineInner
|
|
32
|
+
*/
|
|
33
|
+
image_url: string;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
/**
|
|
37
|
+
* Check if a given object implements the EarningsCallsSlides200ResponseTimelineInner interface.
|
|
38
|
+
*/
|
|
39
|
+
export function instanceOfEarningsCallsSlides200ResponseTimelineInner(value: object): value is EarningsCallsSlides200ResponseTimelineInner {
|
|
40
|
+
if (!('at_ms' in value) || value['at_ms'] === undefined) return false;
|
|
41
|
+
if (!('image_url' in value) || value['image_url'] === undefined) return false;
|
|
42
|
+
return true;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
export function EarningsCallsSlides200ResponseTimelineInnerFromJSON(json: any): EarningsCallsSlides200ResponseTimelineInner {
|
|
46
|
+
return EarningsCallsSlides200ResponseTimelineInnerFromJSONTyped(json, false);
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
export function EarningsCallsSlides200ResponseTimelineInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): EarningsCallsSlides200ResponseTimelineInner {
|
|
50
|
+
if (json == null) {
|
|
51
|
+
return json;
|
|
52
|
+
}
|
|
53
|
+
return {
|
|
54
|
+
|
|
55
|
+
'at_ms': json['at_ms'],
|
|
56
|
+
'image_url': json['image_url'],
|
|
57
|
+
};
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
export function EarningsCallsSlides200ResponseTimelineInnerToJSON(json: any): EarningsCallsSlides200ResponseTimelineInner {
|
|
61
|
+
return EarningsCallsSlides200ResponseTimelineInnerToJSONTyped(json, false);
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
export function EarningsCallsSlides200ResponseTimelineInnerToJSONTyped(value?: EarningsCallsSlides200ResponseTimelineInner | null, ignoreDiscriminator: boolean = false): any {
|
|
65
|
+
if (value == null) {
|
|
66
|
+
return value;
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
return {
|
|
70
|
+
|
|
71
|
+
'at_ms': value['at_ms'],
|
|
72
|
+
'image_url': value['image_url'],
|
|
73
|
+
};
|
|
74
|
+
}
|
|
75
|
+
|
|
@@ -0,0 +1,103 @@
|
|
|
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. ## 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.
|
|
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 { MatchSpan } from './MatchSpan';
|
|
17
|
+
import {
|
|
18
|
+
MatchSpanFromJSON,
|
|
19
|
+
MatchSpanFromJSONTyped,
|
|
20
|
+
MatchSpanToJSON,
|
|
21
|
+
MatchSpanToJSONTyped,
|
|
22
|
+
} from './MatchSpan';
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* How the passage matched
|
|
26
|
+
* @export
|
|
27
|
+
* @interface HitMatch
|
|
28
|
+
*/
|
|
29
|
+
export interface HitMatch {
|
|
30
|
+
/**
|
|
31
|
+
* The mode that found the passage
|
|
32
|
+
* @type {HitMatchTypeEnum}
|
|
33
|
+
* @memberof HitMatch
|
|
34
|
+
*/
|
|
35
|
+
type: HitMatchTypeEnum;
|
|
36
|
+
/**
|
|
37
|
+
* 1-based rank of the passage in the answer
|
|
38
|
+
* @type {number}
|
|
39
|
+
* @memberof HitMatch
|
|
40
|
+
*/
|
|
41
|
+
lexical_rank: number;
|
|
42
|
+
/**
|
|
43
|
+
* Matched characters in `text`; empty for an answer attached after its matched question (scoped lexical transcript search)
|
|
44
|
+
* @type {Array<MatchSpan>}
|
|
45
|
+
* @memberof HitMatch
|
|
46
|
+
*/
|
|
47
|
+
spans: Array<MatchSpan>;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
/**
|
|
52
|
+
* @export
|
|
53
|
+
*/
|
|
54
|
+
export const HitMatchTypeEnum = {
|
|
55
|
+
Lexical: 'lexical',
|
|
56
|
+
Literal: 'literal'
|
|
57
|
+
} as const;
|
|
58
|
+
export type HitMatchTypeEnum = typeof HitMatchTypeEnum[keyof typeof HitMatchTypeEnum];
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
/**
|
|
62
|
+
* Check if a given object implements the HitMatch interface.
|
|
63
|
+
*/
|
|
64
|
+
export function instanceOfHitMatch(value: object): value is HitMatch {
|
|
65
|
+
if (!('type' in value) || value['type'] === undefined) return false;
|
|
66
|
+
if (!('lexical_rank' in value) || value['lexical_rank'] === undefined) return false;
|
|
67
|
+
if (!('spans' in value) || value['spans'] === undefined) return false;
|
|
68
|
+
return true;
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
export function HitMatchFromJSON(json: any): HitMatch {
|
|
72
|
+
return HitMatchFromJSONTyped(json, false);
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
export function HitMatchFromJSONTyped(json: any, ignoreDiscriminator: boolean): HitMatch {
|
|
76
|
+
if (json == null) {
|
|
77
|
+
return json;
|
|
78
|
+
}
|
|
79
|
+
return {
|
|
80
|
+
|
|
81
|
+
'type': json['type'],
|
|
82
|
+
'lexical_rank': json['lexical_rank'],
|
|
83
|
+
'spans': ((json['spans'] as Array<any>).map(MatchSpanFromJSON)),
|
|
84
|
+
};
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
export function HitMatchToJSON(json: any): HitMatch {
|
|
88
|
+
return HitMatchToJSONTyped(json, false);
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
export function HitMatchToJSONTyped(value?: HitMatch | null, ignoreDiscriminator: boolean = false): any {
|
|
92
|
+
if (value == null) {
|
|
93
|
+
return value;
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
return {
|
|
97
|
+
|
|
98
|
+
'type': value['type'],
|
|
99
|
+
'lexical_rank': value['lexical_rank'],
|
|
100
|
+
'spans': ((value['spans'] as Array<any>).map(MatchSpanToJSON)),
|
|
101
|
+
};
|
|
102
|
+
}
|
|
103
|
+
|
|
@@ -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. ## 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.
|
|
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 MatchSpan
|
|
20
|
+
*/
|
|
21
|
+
export interface MatchSpan {
|
|
22
|
+
/**
|
|
23
|
+
* Zero-based Unicode code-point offset into `text`
|
|
24
|
+
* @type {number}
|
|
25
|
+
* @memberof MatchSpan
|
|
26
|
+
*/
|
|
27
|
+
start: number;
|
|
28
|
+
/**
|
|
29
|
+
* End offset, exclusive
|
|
30
|
+
* @type {number}
|
|
31
|
+
* @memberof MatchSpan
|
|
32
|
+
*/
|
|
33
|
+
end: number;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
/**
|
|
37
|
+
* Check if a given object implements the MatchSpan interface.
|
|
38
|
+
*/
|
|
39
|
+
export function instanceOfMatchSpan(value: object): value is MatchSpan {
|
|
40
|
+
if (!('start' in value) || value['start'] === undefined) return false;
|
|
41
|
+
if (!('end' in value) || value['end'] === undefined) return false;
|
|
42
|
+
return true;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
export function MatchSpanFromJSON(json: any): MatchSpan {
|
|
46
|
+
return MatchSpanFromJSONTyped(json, false);
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
export function MatchSpanFromJSONTyped(json: any, ignoreDiscriminator: boolean): MatchSpan {
|
|
50
|
+
if (json == null) {
|
|
51
|
+
return json;
|
|
52
|
+
}
|
|
53
|
+
return {
|
|
54
|
+
|
|
55
|
+
'start': json['start'],
|
|
56
|
+
'end': json['end'],
|
|
57
|
+
};
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
export function MatchSpanToJSON(json: any): MatchSpan {
|
|
61
|
+
return MatchSpanToJSONTyped(json, false);
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
export function MatchSpanToJSONTyped(value?: MatchSpan | null, ignoreDiscriminator: boolean = false): any {
|
|
65
|
+
if (value == null) {
|
|
66
|
+
return value;
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
return {
|
|
70
|
+
|
|
71
|
+
'start': value['start'],
|
|
72
|
+
'end': value['end'],
|
|
73
|
+
};
|
|
74
|
+
}
|
|
75
|
+
|
|
@@ -0,0 +1,114 @@
|
|
|
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. ## 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.
|
|
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 { SearchCoverageLeg } from './SearchCoverageLeg';
|
|
17
|
+
import {
|
|
18
|
+
SearchCoverageLegFromJSON,
|
|
19
|
+
SearchCoverageLegFromJSONTyped,
|
|
20
|
+
SearchCoverageLegToJSON,
|
|
21
|
+
SearchCoverageLegToJSONTyped,
|
|
22
|
+
} from './SearchCoverageLeg';
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* How much of the searched scope the text index covers
|
|
26
|
+
* @export
|
|
27
|
+
* @interface SearchCoverage
|
|
28
|
+
*/
|
|
29
|
+
export interface SearchCoverage {
|
|
30
|
+
/**
|
|
31
|
+
* complete = no hits is a genuine no-result; partial / unknown = the answer may be incomplete
|
|
32
|
+
* @type {SearchCoverageCompletenessEnum}
|
|
33
|
+
* @memberof SearchCoverage
|
|
34
|
+
*/
|
|
35
|
+
completeness: SearchCoverageCompletenessEnum;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @type {SearchCoverageLeg}
|
|
39
|
+
* @memberof SearchCoverage
|
|
40
|
+
*/
|
|
41
|
+
lexical: SearchCoverageLeg | null;
|
|
42
|
+
/**
|
|
43
|
+
* Why the answer may be incomplete
|
|
44
|
+
* @type {Array<SearchCoverageReasonsEnum>}
|
|
45
|
+
* @memberof SearchCoverage
|
|
46
|
+
*/
|
|
47
|
+
reasons: Array<SearchCoverageReasonsEnum>;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
/**
|
|
52
|
+
* @export
|
|
53
|
+
*/
|
|
54
|
+
export const SearchCoverageCompletenessEnum = {
|
|
55
|
+
Complete: 'complete',
|
|
56
|
+
Partial: 'partial',
|
|
57
|
+
Unknown: 'unknown'
|
|
58
|
+
} as const;
|
|
59
|
+
export type SearchCoverageCompletenessEnum = typeof SearchCoverageCompletenessEnum[keyof typeof SearchCoverageCompletenessEnum];
|
|
60
|
+
|
|
61
|
+
/**
|
|
62
|
+
* @export
|
|
63
|
+
*/
|
|
64
|
+
export const SearchCoverageReasonsEnum = {
|
|
65
|
+
LexicalBackfillPending: 'lexical_backfill_pending',
|
|
66
|
+
ProjectionFailed: 'projection_failed',
|
|
67
|
+
CoverageUnavailable: 'coverage_unavailable'
|
|
68
|
+
} as const;
|
|
69
|
+
export type SearchCoverageReasonsEnum = typeof SearchCoverageReasonsEnum[keyof typeof SearchCoverageReasonsEnum];
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
/**
|
|
73
|
+
* Check if a given object implements the SearchCoverage interface.
|
|
74
|
+
*/
|
|
75
|
+
export function instanceOfSearchCoverage(value: object): value is SearchCoverage {
|
|
76
|
+
if (!('completeness' in value) || value['completeness'] === undefined) return false;
|
|
77
|
+
if (!('lexical' in value) || value['lexical'] === undefined) return false;
|
|
78
|
+
if (!('reasons' in value) || value['reasons'] === undefined) return false;
|
|
79
|
+
return true;
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
export function SearchCoverageFromJSON(json: any): SearchCoverage {
|
|
83
|
+
return SearchCoverageFromJSONTyped(json, false);
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
export function SearchCoverageFromJSONTyped(json: any, ignoreDiscriminator: boolean): SearchCoverage {
|
|
87
|
+
if (json == null) {
|
|
88
|
+
return json;
|
|
89
|
+
}
|
|
90
|
+
return {
|
|
91
|
+
|
|
92
|
+
'completeness': json['completeness'],
|
|
93
|
+
'lexical': SearchCoverageLegFromJSON(json['lexical']),
|
|
94
|
+
'reasons': json['reasons'],
|
|
95
|
+
};
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
export function SearchCoverageToJSON(json: any): SearchCoverage {
|
|
99
|
+
return SearchCoverageToJSONTyped(json, false);
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
export function SearchCoverageToJSONTyped(value?: SearchCoverage | null, ignoreDiscriminator: boolean = false): any {
|
|
103
|
+
if (value == null) {
|
|
104
|
+
return value;
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
return {
|
|
108
|
+
|
|
109
|
+
'completeness': value['completeness'],
|
|
110
|
+
'lexical': SearchCoverageLegToJSON(value['lexical']),
|
|
111
|
+
'reasons': value['reasons'],
|
|
112
|
+
};
|
|
113
|
+
}
|
|
114
|
+
|