@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.
Files changed (97) hide show
  1. package/.openapi-generator/FILES +12 -0
  2. package/dist/apis/EarningsCallsApi.d.ts +46 -6
  3. package/dist/apis/EarningsCallsApi.js +51 -7
  4. package/dist/esm/apis/EarningsCallsApi.d.ts +46 -6
  5. package/dist/esm/apis/EarningsCallsApi.js +50 -6
  6. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInner.d.ts +7 -0
  7. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInner.js +5 -0
  8. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerVideo.d.ts +82 -0
  9. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerVideo.js +78 -0
  10. package/dist/esm/models/EarningsCallsDocumentSearch200Response.d.ts +23 -0
  11. package/dist/esm/models/EarningsCallsDocumentSearch200Response.js +18 -0
  12. package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +21 -2
  13. package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.js +13 -0
  14. package/dist/esm/models/EarningsCallsEvents200ResponseEventsInner.d.ts +7 -0
  15. package/dist/esm/models/EarningsCallsEvents200ResponseEventsInner.js +5 -0
  16. package/dist/esm/models/EarningsCallsLive200ResponseEventsInner.d.ts +7 -0
  17. package/dist/esm/models/EarningsCallsLive200ResponseEventsInner.js +5 -0
  18. package/dist/esm/models/EarningsCallsSearch200Response.d.ts +23 -0
  19. package/dist/esm/models/EarningsCallsSearch200Response.js +18 -0
  20. package/dist/esm/models/EarningsCallsSearch200ResponseHitsInner.d.ts +21 -2
  21. package/dist/esm/models/EarningsCallsSearch200ResponseHitsInner.js +13 -0
  22. package/dist/esm/models/EarningsCallsSlides200Response.d.ts +7 -0
  23. package/dist/esm/models/EarningsCallsSlides200Response.js +5 -0
  24. package/dist/esm/models/EarningsCallsSlides200ResponseTimelineInner.d.ts +38 -0
  25. package/dist/esm/models/EarningsCallsSlides200ResponseTimelineInner.js +47 -0
  26. package/dist/esm/models/HitMatch.d.ts +61 -0
  27. package/dist/esm/models/HitMatch.js +65 -0
  28. package/dist/esm/models/MatchSpan.d.ts +38 -0
  29. package/dist/esm/models/MatchSpan.js +47 -0
  30. package/dist/esm/models/SearchCoverage.d.ts +73 -0
  31. package/dist/esm/models/SearchCoverage.js +76 -0
  32. package/dist/esm/models/SearchCoverageLeg.d.ts +59 -0
  33. package/dist/esm/models/SearchCoverageLeg.js +63 -0
  34. package/dist/esm/models/index.d.ts +6 -0
  35. package/dist/esm/models/index.js +6 -0
  36. package/dist/models/EarningsCallsCalendar200ResponseEventsInner.d.ts +7 -0
  37. package/dist/models/EarningsCallsCalendar200ResponseEventsInner.js +5 -0
  38. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerVideo.d.ts +82 -0
  39. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerVideo.js +86 -0
  40. package/dist/models/EarningsCallsDocumentSearch200Response.d.ts +23 -0
  41. package/dist/models/EarningsCallsDocumentSearch200Response.js +19 -0
  42. package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +21 -2
  43. package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.js +13 -0
  44. package/dist/models/EarningsCallsEvents200ResponseEventsInner.d.ts +7 -0
  45. package/dist/models/EarningsCallsEvents200ResponseEventsInner.js +5 -0
  46. package/dist/models/EarningsCallsLive200ResponseEventsInner.d.ts +7 -0
  47. package/dist/models/EarningsCallsLive200ResponseEventsInner.js +5 -0
  48. package/dist/models/EarningsCallsSearch200Response.d.ts +23 -0
  49. package/dist/models/EarningsCallsSearch200Response.js +19 -0
  50. package/dist/models/EarningsCallsSearch200ResponseHitsInner.d.ts +21 -2
  51. package/dist/models/EarningsCallsSearch200ResponseHitsInner.js +13 -0
  52. package/dist/models/EarningsCallsSlides200Response.d.ts +7 -0
  53. package/dist/models/EarningsCallsSlides200Response.js +5 -0
  54. package/dist/models/EarningsCallsSlides200ResponseTimelineInner.d.ts +38 -0
  55. package/dist/models/EarningsCallsSlides200ResponseTimelineInner.js +54 -0
  56. package/dist/models/HitMatch.d.ts +61 -0
  57. package/dist/models/HitMatch.js +73 -0
  58. package/dist/models/MatchSpan.d.ts +38 -0
  59. package/dist/models/MatchSpan.js +54 -0
  60. package/dist/models/SearchCoverage.d.ts +73 -0
  61. package/dist/models/SearchCoverage.js +84 -0
  62. package/dist/models/SearchCoverageLeg.d.ts +59 -0
  63. package/dist/models/SearchCoverageLeg.js +71 -0
  64. package/dist/models/index.d.ts +6 -0
  65. package/dist/models/index.js +6 -0
  66. package/docs/EarningsCallsApi.md +22 -10
  67. package/docs/EarningsCallsCalendar200ResponseEventsInner.md +2 -0
  68. package/docs/EarningsCallsCalendar200ResponseEventsInnerVideo.md +49 -0
  69. package/docs/EarningsCallsDocumentSearch200Response.md +4 -0
  70. package/docs/EarningsCallsDocumentSearch200ResponseHitsInner.md +6 -0
  71. package/docs/EarningsCallsEvents200ResponseEventsInner.md +2 -0
  72. package/docs/EarningsCallsLive200ResponseEventsInner.md +2 -0
  73. package/docs/EarningsCallsSearch200Response.md +4 -0
  74. package/docs/EarningsCallsSearch200ResponseHitsInner.md +6 -0
  75. package/docs/EarningsCallsSlides200Response.md +2 -0
  76. package/docs/EarningsCallsSlides200ResponseTimelineInner.md +36 -0
  77. package/docs/HitMatch.md +41 -0
  78. package/docs/MatchSpan.md +36 -0
  79. package/docs/SearchCoverage.md +41 -0
  80. package/docs/SearchCoverageLeg.md +41 -0
  81. package/package.json +1 -1
  82. package/src/apis/EarningsCallsApi.ts +62 -6
  83. package/src/models/EarningsCallsCalendar200ResponseEventsInner.ts +17 -0
  84. package/src/models/EarningsCallsCalendar200ResponseEventsInnerVideo.ts +140 -0
  85. package/src/models/EarningsCallsDocumentSearch200Response.ts +38 -0
  86. package/src/models/EarningsCallsDocumentSearch200ResponseHitsInner.ts +37 -2
  87. package/src/models/EarningsCallsEvents200ResponseEventsInner.ts +16 -0
  88. package/src/models/EarningsCallsLive200ResponseEventsInner.ts +17 -0
  89. package/src/models/EarningsCallsSearch200Response.ts +38 -0
  90. package/src/models/EarningsCallsSearch200ResponseHitsInner.ts +36 -2
  91. package/src/models/EarningsCallsSlides200Response.ts +16 -0
  92. package/src/models/EarningsCallsSlides200ResponseTimelineInner.ts +75 -0
  93. package/src/models/HitMatch.ts +114 -0
  94. package/src/models/MatchSpan.ts +75 -0
  95. package/src/models/SearchCoverage.ts +127 -0
  96. package/src/models/SearchCoverageLeg.ts +105 -0
  97. package/src/models/index.ts +6 -0
@@ -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}
@@ -11,6 +11,7 @@
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
+ import { EarningsCallsCalendar200ResponseEventsInnerVideoFromJSON, EarningsCallsCalendar200ResponseEventsInnerVideoToJSON, } from './EarningsCallsCalendar200ResponseEventsInnerVideo';
14
15
  /**
15
16
  * @export
16
17
  */
@@ -111,6 +112,8 @@ export function instanceOfEarningsCallsLive200ResponseEventsInner(value) {
111
112
  return false;
112
113
  if (!('webcast_url' in value) || value['webcast_url'] === undefined)
113
114
  return false;
115
+ if (!('video' in value) || value['video'] === undefined)
116
+ return false;
114
117
  if (!('live_channel' in value) || value['live_channel'] === undefined)
115
118
  return false;
116
119
  if (value['live_channel'] !== 'earnings-calls.live')
@@ -156,6 +159,7 @@ export function EarningsCallsLive200ResponseEventsInnerFromJSONTyped(json, ignor
156
159
  'has_press_release': json['has_press_release'],
157
160
  'has_documents': json['has_documents'],
158
161
  'webcast_url': json['webcast_url'],
162
+ 'video': EarningsCallsCalendar200ResponseEventsInnerVideoFromJSON(json['video']),
159
163
  'live_channel': json['live_channel'],
160
164
  'live_audio': json['live_audio'],
161
165
  'live_prices': json['live_prices'],
@@ -196,6 +200,7 @@ export function EarningsCallsLive200ResponseEventsInnerToJSONTyped(value, ignore
196
200
  'has_press_release': value['has_press_release'],
197
201
  'has_documents': value['has_documents'],
198
202
  'webcast_url': value['webcast_url'],
203
+ 'video': EarningsCallsCalendar200ResponseEventsInnerVideoToJSON(value['video']),
199
204
  'live_channel': value['live_channel'],
200
205
  'live_audio': value['live_audio'],
201
206
  '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
  */
@@ -12,12 +12,26 @@
12
12
  * Do not edit the class manually.
13
13
  */
14
14
  import { EarningsCallsSearch200ResponseHitsInnerFromJSON, EarningsCallsSearch200ResponseHitsInnerToJSON, } from './EarningsCallsSearch200ResponseHitsInner';
15
+ import { SearchCoverageFromJSON, SearchCoverageToJSON, } from './SearchCoverage';
16
+ /**
17
+ * @export
18
+ */
19
+ export const EarningsCallsSearch200ResponseModeEnum = {
20
+ Lexical: 'lexical',
21
+ Literal: 'literal',
22
+ Semantic: 'semantic',
23
+ Hybrid: 'hybrid'
24
+ };
15
25
  /**
16
26
  * Check if a given object implements the EarningsCallsSearch200Response interface.
17
27
  */
18
28
  export function instanceOfEarningsCallsSearch200Response(value) {
19
29
  if (!('query' in value) || value['query'] === undefined)
20
30
  return false;
31
+ if (!('mode' in value) || value['mode'] === undefined)
32
+ return false;
33
+ if (!('coverage' in value) || value['coverage'] === undefined)
34
+ return false;
21
35
  if (!('hits' in value) || value['hits'] === undefined)
22
36
  return false;
23
37
  return true;
@@ -31,6 +45,8 @@ export function EarningsCallsSearch200ResponseFromJSONTyped(json, ignoreDiscrimi
31
45
  }
32
46
  return {
33
47
  'query': json['query'],
48
+ 'mode': json['mode'],
49
+ 'coverage': SearchCoverageFromJSON(json['coverage']),
34
50
  'hits': (json['hits'].map(EarningsCallsSearch200ResponseHitsInnerFromJSON)),
35
51
  };
36
52
  }
@@ -43,6 +59,8 @@ export function EarningsCallsSearch200ResponseToJSONTyped(value, ignoreDiscrimin
43
59
  }
44
60
  return {
45
61
  'query': value['query'],
62
+ 'mode': value['mode'],
63
+ 'coverage': SearchCoverageToJSON(value['coverage']),
46
64
  'hits': (value['hits'].map(EarningsCallsSearch200ResponseHitsInnerToJSON)),
47
65
  };
48
66
  }
@@ -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
- * The passage, cut to at most 600 characters on a word boundary
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
- * Cosine similarity to the query (4 decimals)
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}
@@ -13,6 +13,7 @@
13
13
  */
14
14
  import { EarningsCallsExtractions200ResponseGuidanceInnerSourcesInnerSpeakerFromJSON, EarningsCallsExtractions200ResponseGuidanceInnerSourcesInnerSpeakerToJSON, } from './EarningsCallsExtractions200ResponseGuidanceInnerSourcesInnerSpeaker';
15
15
  import { EarningsCallsSearch200ResponseHitsInnerSlideFromJSON, EarningsCallsSearch200ResponseHitsInnerSlideToJSON, } from './EarningsCallsSearch200ResponseHitsInnerSlide';
16
+ import { HitMatchFromJSON, HitMatchToJSON, } from './HitMatch';
16
17
  /**
17
18
  * @export
18
19
  */
@@ -46,10 +47,16 @@ export function instanceOfEarningsCallsSearch200ResponseHitsInner(value) {
46
47
  return false;
47
48
  if (!('end_ms' in value) || value['end_ms'] === undefined)
48
49
  return false;
50
+ if (!('chunk_index' in value) || value['chunk_index'] === undefined)
51
+ return false;
49
52
  if (!('text' in value) || value['text'] === undefined)
50
53
  return false;
54
+ if (!('text_truncated' in value) || value['text_truncated'] === undefined)
55
+ return false;
51
56
  if (!('score' in value) || value['score'] === undefined)
52
57
  return false;
58
+ if (!('match' in value) || value['match'] === undefined)
59
+ return false;
53
60
  if (!('audio_url' in value) || value['audio_url'] === undefined)
54
61
  return false;
55
62
  if (!('slide' in value) || value['slide'] === undefined)
@@ -74,8 +81,11 @@ export function EarningsCallsSearch200ResponseHitsInnerFromJSONTyped(json, ignor
74
81
  'speaker': EarningsCallsExtractions200ResponseGuidanceInnerSourcesInnerSpeakerFromJSON(json['speaker']),
75
82
  'start_ms': json['start_ms'],
76
83
  'end_ms': json['end_ms'],
84
+ 'chunk_index': json['chunk_index'],
77
85
  'text': json['text'],
86
+ 'text_truncated': json['text_truncated'],
78
87
  'score': json['score'],
88
+ 'match': HitMatchFromJSON(json['match']),
79
89
  'audio_url': json['audio_url'],
80
90
  'slide': EarningsCallsSearch200ResponseHitsInnerSlideFromJSON(json['slide']),
81
91
  };
@@ -98,8 +108,11 @@ export function EarningsCallsSearch200ResponseHitsInnerToJSONTyped(value, ignore
98
108
  'speaker': EarningsCallsExtractions200ResponseGuidanceInnerSourcesInnerSpeakerToJSON(value['speaker']),
99
109
  'start_ms': value['start_ms'],
100
110
  'end_ms': value['end_ms'],
111
+ 'chunk_index': value['chunk_index'],
101
112
  'text': value['text'],
113
+ 'text_truncated': value['text_truncated'],
102
114
  'score': value['score'],
115
+ 'match': HitMatchToJSON(value['match']),
103
116
  'audio_url': value['audio_url'],
104
117
  'slide': EarningsCallsSearch200ResponseHitsInnerSlideToJSON(value['slide']),
105
118
  };
@@ -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.
@@ -14,6 +14,7 @@
14
14
  import { EarningsCallsLiveStream200ResponseEventFromJSON, EarningsCallsLiveStream200ResponseEventToJSON, } from './EarningsCallsLiveStream200ResponseEvent';
15
15
  import { EarningsCallsSlides200ResponseDeckFromJSON, EarningsCallsSlides200ResponseDeckToJSON, } from './EarningsCallsSlides200ResponseDeck';
16
16
  import { EarningsCallsSlides200ResponseSlidesInnerFromJSON, EarningsCallsSlides200ResponseSlidesInnerToJSON, } from './EarningsCallsSlides200ResponseSlidesInner';
17
+ import { EarningsCallsSlides200ResponseTimelineInnerFromJSON, EarningsCallsSlides200ResponseTimelineInnerToJSON, } from './EarningsCallsSlides200ResponseTimelineInner';
17
18
  /**
18
19
  * Check if a given object implements the EarningsCallsSlides200Response interface.
19
20
  */
@@ -24,6 +25,8 @@ export function instanceOfEarningsCallsSlides200Response(value) {
24
25
  return false;
25
26
  if (!('slides' in value) || value['slides'] === undefined)
26
27
  return false;
28
+ if (!('timeline' in value) || value['timeline'] === undefined)
29
+ return false;
27
30
  return true;
28
31
  }
29
32
  export function EarningsCallsSlides200ResponseFromJSON(json) {
@@ -37,6 +40,7 @@ export function EarningsCallsSlides200ResponseFromJSONTyped(json, ignoreDiscrimi
37
40
  'event': EarningsCallsLiveStream200ResponseEventFromJSON(json['event']),
38
41
  'deck': EarningsCallsSlides200ResponseDeckFromJSON(json['deck']),
39
42
  'slides': (json['slides'].map(EarningsCallsSlides200ResponseSlidesInnerFromJSON)),
43
+ 'timeline': (json['timeline'].map(EarningsCallsSlides200ResponseTimelineInnerFromJSON)),
40
44
  };
41
45
  }
42
46
  export function EarningsCallsSlides200ResponseToJSON(json) {
@@ -50,5 +54,6 @@ export function EarningsCallsSlides200ResponseToJSONTyped(value, ignoreDiscrimin
50
54
  'event': EarningsCallsLiveStream200ResponseEventToJSON(value['event']),
51
55
  'deck': EarningsCallsSlides200ResponseDeckToJSON(value['deck']),
52
56
  'slides': (value['slides'].map(EarningsCallsSlides200ResponseSlidesInnerToJSON)),
57
+ 'timeline': (value['timeline'].map(EarningsCallsSlides200ResponseTimelineInnerToJSON)),
53
58
  };
54
59
  }
@@ -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;
@@ -0,0 +1,47 @@
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
+ * Check if a given object implements the EarningsCallsSlides200ResponseTimelineInner interface.
16
+ */
17
+ export function instanceOfEarningsCallsSlides200ResponseTimelineInner(value) {
18
+ if (!('at_ms' in value) || value['at_ms'] === undefined)
19
+ return false;
20
+ if (!('image_url' in value) || value['image_url'] === undefined)
21
+ return false;
22
+ return true;
23
+ }
24
+ export function EarningsCallsSlides200ResponseTimelineInnerFromJSON(json) {
25
+ return EarningsCallsSlides200ResponseTimelineInnerFromJSONTyped(json, false);
26
+ }
27
+ export function EarningsCallsSlides200ResponseTimelineInnerFromJSONTyped(json, ignoreDiscriminator) {
28
+ if (json == null) {
29
+ return json;
30
+ }
31
+ return {
32
+ 'at_ms': json['at_ms'],
33
+ 'image_url': json['image_url'],
34
+ };
35
+ }
36
+ export function EarningsCallsSlides200ResponseTimelineInnerToJSON(json) {
37
+ return EarningsCallsSlides200ResponseTimelineInnerToJSONTyped(json, false);
38
+ }
39
+ export function EarningsCallsSlides200ResponseTimelineInnerToJSONTyped(value, ignoreDiscriminator = false) {
40
+ if (value == null) {
41
+ return value;
42
+ }
43
+ return {
44
+ 'at_ms': value['at_ms'],
45
+ 'image_url': value['image_url'],
46
+ };
47
+ }
@@ -0,0 +1,61 @@
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
+ import type { MatchSpan } from './MatchSpan';
13
+ /**
14
+ * How the passage matched
15
+ * @export
16
+ * @interface HitMatch
17
+ */
18
+ export interface HitMatch {
19
+ /**
20
+ * The leg that found the passage; hybrid = both legs of mode=hybrid
21
+ * @type {HitMatchTypeEnum}
22
+ * @memberof HitMatch
23
+ */
24
+ type: HitMatchTypeEnum;
25
+ /**
26
+ * 1-based rank in the keyword leg (lexical / literal); null when it did not find it
27
+ * @type {number}
28
+ * @memberof HitMatch
29
+ */
30
+ lexical_rank: number | null;
31
+ /**
32
+ * 1-based rank in the semantic leg; null when it did not find it
33
+ * @type {number}
34
+ * @memberof HitMatch
35
+ */
36
+ semantic_rank: number | null;
37
+ /**
38
+ * Matched characters in `text`; empty for semantic matches
39
+ * @type {Array<MatchSpan>}
40
+ * @memberof HitMatch
41
+ */
42
+ spans: Array<MatchSpan>;
43
+ }
44
+ /**
45
+ * @export
46
+ */
47
+ export declare const HitMatchTypeEnum: {
48
+ readonly Lexical: "lexical";
49
+ readonly Literal: "literal";
50
+ readonly Semantic: "semantic";
51
+ readonly Hybrid: "hybrid";
52
+ };
53
+ export type HitMatchTypeEnum = typeof HitMatchTypeEnum[keyof typeof HitMatchTypeEnum];
54
+ /**
55
+ * Check if a given object implements the HitMatch interface.
56
+ */
57
+ export declare function instanceOfHitMatch(value: object): value is HitMatch;
58
+ export declare function HitMatchFromJSON(json: any): HitMatch;
59
+ export declare function HitMatchFromJSONTyped(json: any, ignoreDiscriminator: boolean): HitMatch;
60
+ export declare function HitMatchToJSON(json: any): HitMatch;
61
+ export declare function HitMatchToJSONTyped(value?: HitMatch | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,65 @@
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
+ import { MatchSpanFromJSON, MatchSpanToJSON, } from './MatchSpan';
15
+ /**
16
+ * @export
17
+ */
18
+ export const HitMatchTypeEnum = {
19
+ Lexical: 'lexical',
20
+ Literal: 'literal',
21
+ Semantic: 'semantic',
22
+ Hybrid: 'hybrid'
23
+ };
24
+ /**
25
+ * Check if a given object implements the HitMatch interface.
26
+ */
27
+ export function instanceOfHitMatch(value) {
28
+ if (!('type' in value) || value['type'] === undefined)
29
+ return false;
30
+ if (!('lexical_rank' in value) || value['lexical_rank'] === undefined)
31
+ return false;
32
+ if (!('semantic_rank' in value) || value['semantic_rank'] === undefined)
33
+ return false;
34
+ if (!('spans' in value) || value['spans'] === undefined)
35
+ return false;
36
+ return true;
37
+ }
38
+ export function HitMatchFromJSON(json) {
39
+ return HitMatchFromJSONTyped(json, false);
40
+ }
41
+ export function HitMatchFromJSONTyped(json, ignoreDiscriminator) {
42
+ if (json == null) {
43
+ return json;
44
+ }
45
+ return {
46
+ 'type': json['type'],
47
+ 'lexical_rank': json['lexical_rank'],
48
+ 'semantic_rank': json['semantic_rank'],
49
+ 'spans': (json['spans'].map(MatchSpanFromJSON)),
50
+ };
51
+ }
52
+ export function HitMatchToJSON(json) {
53
+ return HitMatchToJSONTyped(json, false);
54
+ }
55
+ export function HitMatchToJSONTyped(value, ignoreDiscriminator = false) {
56
+ if (value == null) {
57
+ return value;
58
+ }
59
+ return {
60
+ 'type': value['type'],
61
+ 'lexical_rank': value['lexical_rank'],
62
+ 'semantic_rank': value['semantic_rank'],
63
+ 'spans': (value['spans'].map(MatchSpanToJSON)),
64
+ };
65
+ }
@@ -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 MatchSpan
16
+ */
17
+ export interface MatchSpan {
18
+ /**
19
+ * Zero-based Unicode code-point offset into `text`
20
+ * @type {number}
21
+ * @memberof MatchSpan
22
+ */
23
+ start: number;
24
+ /**
25
+ * End offset, exclusive
26
+ * @type {number}
27
+ * @memberof MatchSpan
28
+ */
29
+ end: number;
30
+ }
31
+ /**
32
+ * Check if a given object implements the MatchSpan interface.
33
+ */
34
+ export declare function instanceOfMatchSpan(value: object): value is MatchSpan;
35
+ export declare function MatchSpanFromJSON(json: any): MatchSpan;
36
+ export declare function MatchSpanFromJSONTyped(json: any, ignoreDiscriminator: boolean): MatchSpan;
37
+ export declare function MatchSpanToJSON(json: any): MatchSpan;
38
+ export declare function MatchSpanToJSONTyped(value?: MatchSpan | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,47 @@
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
+ * Check if a given object implements the MatchSpan interface.
16
+ */
17
+ export function instanceOfMatchSpan(value) {
18
+ if (!('start' in value) || value['start'] === undefined)
19
+ return false;
20
+ if (!('end' in value) || value['end'] === undefined)
21
+ return false;
22
+ return true;
23
+ }
24
+ export function MatchSpanFromJSON(json) {
25
+ return MatchSpanFromJSONTyped(json, false);
26
+ }
27
+ export function MatchSpanFromJSONTyped(json, ignoreDiscriminator) {
28
+ if (json == null) {
29
+ return json;
30
+ }
31
+ return {
32
+ 'start': json['start'],
33
+ 'end': json['end'],
34
+ };
35
+ }
36
+ export function MatchSpanToJSON(json) {
37
+ return MatchSpanToJSONTyped(json, false);
38
+ }
39
+ export function MatchSpanToJSONTyped(value, ignoreDiscriminator = false) {
40
+ if (value == null) {
41
+ return value;
42
+ }
43
+ return {
44
+ 'start': value['start'],
45
+ 'end': value['end'],
46
+ };
47
+ }