@invinite-org/data-api-client 6.0.0 → 6.2.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/dist/apis/FilingsApi.d.ts +2 -2
- package/dist/apis/FilingsApi.js +2 -2
- package/dist/apis/ReferenceApi.d.ts +4 -4
- package/dist/apis/ReferenceApi.js +4 -4
- package/dist/esm/apis/FilingsApi.d.ts +2 -2
- package/dist/esm/apis/FilingsApi.js +2 -2
- package/dist/esm/apis/ReferenceApi.d.ts +4 -4
- package/dist/esm/apis/ReferenceApi.js +4 -4
- package/dist/esm/models/AlertCondition.d.ts +199 -5
- package/dist/esm/models/AlertCondition.js +113 -0
- package/dist/esm/models/AlertConditionInput.d.ts +199 -5
- package/dist/esm/models/AlertConditionInput.js +113 -0
- package/dist/esm/models/Company.d.ts +8 -8
- package/dist/esm/models/CompanyListItem.d.ts +1 -1
- package/dist/esm/models/CompanyRef.d.ts +1 -1
- package/dist/esm/models/CreateDestinationRequest.d.ts +12 -0
- package/dist/esm/models/CreateDestinationRequest.js +4 -0
- package/dist/esm/models/Destination.d.ts +12 -0
- package/dist/esm/models/Destination.js +8 -0
- package/dist/esm/models/DestinationCreated.d.ts +12 -0
- package/dist/esm/models/DestinationCreated.js +8 -0
- package/dist/esm/models/UpdateDestinationRequest.d.ts +12 -0
- package/dist/esm/models/UpdateDestinationRequest.js +4 -0
- package/dist/models/AlertCondition.d.ts +199 -5
- package/dist/models/AlertCondition.js +114 -1
- package/dist/models/AlertConditionInput.d.ts +199 -5
- package/dist/models/AlertConditionInput.js +114 -1
- package/dist/models/Company.d.ts +8 -8
- package/dist/models/CompanyListItem.d.ts +1 -1
- package/dist/models/CompanyRef.d.ts +1 -1
- package/dist/models/CreateDestinationRequest.d.ts +12 -0
- package/dist/models/CreateDestinationRequest.js +4 -0
- package/dist/models/Destination.d.ts +12 -0
- package/dist/models/Destination.js +8 -0
- package/dist/models/DestinationCreated.d.ts +12 -0
- package/dist/models/DestinationCreated.js +8 -0
- package/dist/models/UpdateDestinationRequest.d.ts +12 -0
- package/dist/models/UpdateDestinationRequest.js +4 -0
- package/docs/AlertCondition.md +37 -1
- package/docs/AlertConditionInput.md +37 -1
- package/docs/CompaniesApi.md +2 -2
- package/docs/CreateDestinationRequest.md +4 -0
- package/docs/Destination.md +4 -0
- package/docs/DestinationCreated.md +4 -0
- package/docs/EventsApi.md +2 -2
- package/docs/FilingsApi.md +5 -5
- package/docs/FinancialsApi.md +12 -12
- package/docs/GuidanceApi.md +4 -4
- package/docs/HoldingsApi.md +6 -6
- package/docs/IPOsApi.md +2 -2
- package/docs/InsiderTradesApi.md +2 -2
- package/docs/InvestorDocumentsApi.md +4 -4
- package/docs/MetricsApi.md +10 -10
- package/docs/NewsApi.md +6 -6
- package/docs/ReferenceApi.md +8 -8
- package/docs/TranscriptsApi.md +2 -2
- package/docs/UpdateDestinationRequest.md +4 -0
- package/package.json +1 -1
- package/src/apis/FilingsApi.ts +2 -2
- package/src/apis/ReferenceApi.ts +4 -4
- package/src/models/AlertCondition.ts +244 -5
- package/src/models/AlertConditionInput.ts +244 -5
- package/src/models/Company.ts +8 -8
- package/src/models/CompanyListItem.ts +1 -1
- package/src/models/CompanyRef.ts +1 -1
- package/src/models/CreateDestinationRequest.ts +16 -0
- package/src/models/Destination.ts +18 -0
- package/src/models/DestinationCreated.ts +18 -0
- package/src/models/UpdateDestinationRequest.ts +16 -0
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
* Do not edit the class manually.
|
|
14
14
|
*/
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
-
exports.AlertConditionInputEventEnum = exports.AlertConditionInputReportKindsEnum = exports.AlertConditionInputStatusesEnum = exports.AlertConditionInputSpeakerRolesEnum = exports.AlertConditionInputEventsEnum = exports.AlertConditionInputKindsEnum = exports.AlertConditionInputScopeEnum = exports.AlertConditionInputMatchEnum = exports.AlertConditionInputStageEnum = exports.AlertConditionInputFormCategoriesEnum = void 0;
|
|
16
|
+
exports.AlertConditionInputFrequencyEnum = exports.AlertConditionInputPriceDirectionEnum = exports.AlertConditionInputBaselineModeEnum = exports.AlertConditionInputIntervalEnum = exports.AlertConditionInputModeEnum = exports.AlertConditionInputBaselineEnum = exports.AlertConditionInputDirectionEnum = exports.AlertConditionInputOperatorEnum = exports.AlertConditionInputAssetClassEnum = exports.AlertConditionInputEventEnum = exports.AlertConditionInputReportKindsEnum = exports.AlertConditionInputStatusesEnum = exports.AlertConditionInputSpeakerRolesEnum = exports.AlertConditionInputEventsEnum = exports.AlertConditionInputKindsEnum = exports.AlertConditionInputScopeEnum = exports.AlertConditionInputMatchEnum = exports.AlertConditionInputStageEnum = exports.AlertConditionInputFormCategoriesEnum = void 0;
|
|
17
17
|
exports.instanceOfAlertConditionInput = instanceOfAlertConditionInput;
|
|
18
18
|
exports.AlertConditionInputFromJSON = AlertConditionInputFromJSON;
|
|
19
19
|
exports.AlertConditionInputFromJSONTyped = AlertConditionInputFromJSONTyped;
|
|
@@ -128,6 +128,83 @@ exports.AlertConditionInputEventEnum = {
|
|
|
128
128
|
ExDividend: 'ex_dividend',
|
|
129
129
|
DividendPayment: 'dividend_payment'
|
|
130
130
|
};
|
|
131
|
+
/**
|
|
132
|
+
* @export
|
|
133
|
+
*/
|
|
134
|
+
exports.AlertConditionInputAssetClassEnum = {
|
|
135
|
+
UsStock: 'us_stock',
|
|
136
|
+
Crypto: 'crypto'
|
|
137
|
+
};
|
|
138
|
+
/**
|
|
139
|
+
* @export
|
|
140
|
+
*/
|
|
141
|
+
exports.AlertConditionInputOperatorEnum = {
|
|
142
|
+
CrossesAbove: 'crosses_above',
|
|
143
|
+
CrossesBelow: 'crosses_below',
|
|
144
|
+
Crosses: 'crosses',
|
|
145
|
+
Above: 'above',
|
|
146
|
+
Below: 'below'
|
|
147
|
+
};
|
|
148
|
+
/**
|
|
149
|
+
* @export
|
|
150
|
+
*/
|
|
151
|
+
exports.AlertConditionInputDirectionEnum = {
|
|
152
|
+
Up: 'up',
|
|
153
|
+
Down: 'down',
|
|
154
|
+
Both: 'both'
|
|
155
|
+
};
|
|
156
|
+
/**
|
|
157
|
+
* @export
|
|
158
|
+
*/
|
|
159
|
+
exports.AlertConditionInputBaselineEnum = {
|
|
160
|
+
PriorClose: 'prior_close',
|
|
161
|
+
IntradayOpen: 'intraday_open',
|
|
162
|
+
SessionHigh: 'session_high',
|
|
163
|
+
SessionLow: 'session_low',
|
|
164
|
+
GapOpen: 'gap_open'
|
|
165
|
+
};
|
|
166
|
+
/**
|
|
167
|
+
* @export
|
|
168
|
+
*/
|
|
169
|
+
exports.AlertConditionInputModeEnum = {
|
|
170
|
+
Relative: 'relative',
|
|
171
|
+
Absolute: 'absolute',
|
|
172
|
+
Session: 'session'
|
|
173
|
+
};
|
|
174
|
+
/**
|
|
175
|
+
* @export
|
|
176
|
+
*/
|
|
177
|
+
exports.AlertConditionInputIntervalEnum = {
|
|
178
|
+
_1h: '1h',
|
|
179
|
+
_1d: '1d',
|
|
180
|
+
_1w: '1w',
|
|
181
|
+
_1mo: '1mo'
|
|
182
|
+
};
|
|
183
|
+
/**
|
|
184
|
+
* @export
|
|
185
|
+
*/
|
|
186
|
+
exports.AlertConditionInputBaselineModeEnum = {
|
|
187
|
+
FlatMean: 'flat_mean',
|
|
188
|
+
RvolSlot: 'rvol_slot',
|
|
189
|
+
Median: 'median'
|
|
190
|
+
};
|
|
191
|
+
/**
|
|
192
|
+
* @export
|
|
193
|
+
*/
|
|
194
|
+
exports.AlertConditionInputPriceDirectionEnum = {
|
|
195
|
+
Up: 'up',
|
|
196
|
+
Down: 'down',
|
|
197
|
+
Any: 'any'
|
|
198
|
+
};
|
|
199
|
+
/**
|
|
200
|
+
* @export
|
|
201
|
+
*/
|
|
202
|
+
exports.AlertConditionInputFrequencyEnum = {
|
|
203
|
+
Once: 'once',
|
|
204
|
+
Hourly: 'hourly',
|
|
205
|
+
Daily: 'daily',
|
|
206
|
+
Weekly: 'weekly'
|
|
207
|
+
};
|
|
131
208
|
/**
|
|
132
209
|
* Check if a given object implements the AlertConditionInput interface.
|
|
133
210
|
*/
|
|
@@ -175,6 +252,24 @@ function AlertConditionInputFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
175
252
|
'time_of_day_minutes': json['time_of_day_minutes'] == null ? undefined : json['time_of_day_minutes'],
|
|
176
253
|
'timezone': json['timezone'] == null ? undefined : json['timezone'],
|
|
177
254
|
'notify_on_date_change': json['notify_on_date_change'] == null ? undefined : json['notify_on_date_change'],
|
|
255
|
+
'asset_class': json['asset_class'] == null ? undefined : json['asset_class'],
|
|
256
|
+
'operator': json['operator'] == null ? undefined : json['operator'],
|
|
257
|
+
'level': json['level'] == null ? undefined : json['level'],
|
|
258
|
+
'direction': json['direction'] == null ? undefined : json['direction'],
|
|
259
|
+
'pct': json['pct'] == null ? undefined : json['pct'],
|
|
260
|
+
'baseline': json['baseline'] == null ? undefined : json['baseline'],
|
|
261
|
+
'window_minutes': json['window_minutes'] == null ? undefined : json['window_minutes'],
|
|
262
|
+
'mode': json['mode'] == null ? undefined : json['mode'],
|
|
263
|
+
'interval': json['interval'] == null ? undefined : json['interval'],
|
|
264
|
+
'multiple': json['multiple'] == null ? undefined : json['multiple'],
|
|
265
|
+
'threshold': json['threshold'] == null ? undefined : json['threshold'],
|
|
266
|
+
'lookback_bars': json['lookback_bars'] == null ? undefined : json['lookback_bars'],
|
|
267
|
+
'baseline_mode': json['baseline_mode'] == null ? undefined : json['baseline_mode'],
|
|
268
|
+
'price_direction': json['price_direction'] == null ? undefined : json['price_direction'],
|
|
269
|
+
'frequency': json['frequency'] == null ? undefined : json['frequency'],
|
|
270
|
+
'at': json['at'] == null ? undefined : json['at'],
|
|
271
|
+
'weekday': json['weekday'] == null ? undefined : json['weekday'],
|
|
272
|
+
'days': json['days'] == null ? undefined : json['days'],
|
|
178
273
|
};
|
|
179
274
|
}
|
|
180
275
|
function AlertConditionInputToJSON(json) {
|
|
@@ -218,5 +313,23 @@ function AlertConditionInputToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
218
313
|
'time_of_day_minutes': value['time_of_day_minutes'],
|
|
219
314
|
'timezone': value['timezone'],
|
|
220
315
|
'notify_on_date_change': value['notify_on_date_change'],
|
|
316
|
+
'asset_class': value['asset_class'],
|
|
317
|
+
'operator': value['operator'],
|
|
318
|
+
'level': value['level'],
|
|
319
|
+
'direction': value['direction'],
|
|
320
|
+
'pct': value['pct'],
|
|
321
|
+
'baseline': value['baseline'],
|
|
322
|
+
'window_minutes': value['window_minutes'],
|
|
323
|
+
'mode': value['mode'],
|
|
324
|
+
'interval': value['interval'],
|
|
325
|
+
'multiple': value['multiple'],
|
|
326
|
+
'threshold': value['threshold'],
|
|
327
|
+
'lookback_bars': value['lookback_bars'],
|
|
328
|
+
'baseline_mode': value['baseline_mode'],
|
|
329
|
+
'price_direction': value['price_direction'],
|
|
330
|
+
'frequency': value['frequency'],
|
|
331
|
+
'at': value['at'],
|
|
332
|
+
'weekday': value['weekday'],
|
|
333
|
+
'days': value['days'],
|
|
221
334
|
};
|
|
222
335
|
}
|
package/dist/models/Company.d.ts
CHANGED
|
@@ -47,23 +47,23 @@ export interface Company {
|
|
|
47
47
|
*/
|
|
48
48
|
category: string;
|
|
49
49
|
/**
|
|
50
|
-
* Sector, from the issuer's SIC code (SEC mapping)
|
|
50
|
+
* Sector, from the issuer's SIC code (SEC mapping); null for a US ETF (no SIC-derived values are shown for a fund)
|
|
51
51
|
* @type {string}
|
|
52
52
|
* @memberof Company
|
|
53
53
|
*/
|
|
54
|
-
sector: string;
|
|
54
|
+
sector: string | null;
|
|
55
55
|
/**
|
|
56
|
-
* Industry, from the issuer's SIC code (SEC mapping)
|
|
56
|
+
* Industry, from the issuer's SIC code (SEC mapping); null for a US ETF (no SIC-derived values are shown for a fund)
|
|
57
57
|
* @type {string}
|
|
58
58
|
* @memberof Company
|
|
59
59
|
*/
|
|
60
|
-
industry: string;
|
|
60
|
+
industry: string | null;
|
|
61
61
|
/**
|
|
62
|
-
* SIC code
|
|
62
|
+
* SIC code; null for a US ETF (no SIC-derived values are shown for a fund)
|
|
63
63
|
* @type {string}
|
|
64
64
|
* @memberof Company
|
|
65
65
|
*/
|
|
66
|
-
sic: string;
|
|
66
|
+
sic: string | null;
|
|
67
67
|
/**
|
|
68
68
|
* Fama-French sector
|
|
69
69
|
* @type {string}
|
|
@@ -197,13 +197,13 @@ export interface Company {
|
|
|
197
197
|
*/
|
|
198
198
|
street: string | null;
|
|
199
199
|
/**
|
|
200
|
-
* City
|
|
200
|
+
* City; null for a US ETF
|
|
201
201
|
* @type {string}
|
|
202
202
|
* @memberof Company
|
|
203
203
|
*/
|
|
204
204
|
city: string | null;
|
|
205
205
|
/**
|
|
206
|
-
* State or province
|
|
206
|
+
* State or province; null for a US ETF
|
|
207
207
|
* @type {string}
|
|
208
208
|
* @memberof Company
|
|
209
209
|
*/
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export interface CompanyRef {
|
|
18
18
|
/**
|
|
19
|
-
* SEC CIK, 10 digits
|
|
19
|
+
* SEC CIK, 10 digits; for a US ETF that is a series of a trust (TQQQ) the trust's CIK, empty ("") for such an ETF without a registrant link
|
|
20
20
|
* @type {string}
|
|
21
21
|
* @memberof CompanyRef
|
|
22
22
|
*/
|
|
@@ -53,6 +53,18 @@ export interface CreateDestinationRequest {
|
|
|
53
53
|
* @memberof CreateDestinationRequest
|
|
54
54
|
*/
|
|
55
55
|
preset?: CreateDestinationRequestPresetEnum;
|
|
56
|
+
/**
|
|
57
|
+
* Events per minute this destination receives at most (a token bucket across all delivery machines); events over it stay queued and go out as the bucket refills, never dropped; default 600
|
|
58
|
+
* @type {number}
|
|
59
|
+
* @memberof CreateDestinationRequest
|
|
60
|
+
*/
|
|
61
|
+
max_events_per_minute?: number;
|
|
62
|
+
/**
|
|
63
|
+
* Digest window: new events are held until the oldest is this many seconds old, then go out together as ONE alert.fired.batch (≤ 500 events / 1 MB per request); retries are not held. Not with preset claude_routine; default null (off)
|
|
64
|
+
* @type {number}
|
|
65
|
+
* @memberof CreateDestinationRequest
|
|
66
|
+
*/
|
|
67
|
+
digest_seconds?: number | null;
|
|
56
68
|
}
|
|
57
69
|
/**
|
|
58
70
|
* @export
|
|
@@ -55,6 +55,8 @@ function CreateDestinationRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
55
55
|
'headers': json['headers'] == null ? undefined : json['headers'],
|
|
56
56
|
'body_template': json['body_template'] == null ? undefined : json['body_template'],
|
|
57
57
|
'preset': json['preset'] == null ? undefined : json['preset'],
|
|
58
|
+
'max_events_per_minute': json['max_events_per_minute'] == null ? undefined : json['max_events_per_minute'],
|
|
59
|
+
'digest_seconds': json['digest_seconds'] == null ? undefined : json['digest_seconds'],
|
|
58
60
|
};
|
|
59
61
|
}
|
|
60
62
|
function CreateDestinationRequestToJSON(json) {
|
|
@@ -71,5 +73,7 @@ function CreateDestinationRequestToJSONTyped(value, ignoreDiscriminator = false)
|
|
|
71
73
|
'headers': value['headers'],
|
|
72
74
|
'body_template': value['body_template'],
|
|
73
75
|
'preset': value['preset'],
|
|
76
|
+
'max_events_per_minute': value['max_events_per_minute'],
|
|
77
|
+
'digest_seconds': value['digest_seconds'],
|
|
74
78
|
};
|
|
75
79
|
}
|
|
@@ -81,6 +81,18 @@ export interface Destination {
|
|
|
81
81
|
* @memberof Destination
|
|
82
82
|
*/
|
|
83
83
|
body_template: string | null;
|
|
84
|
+
/**
|
|
85
|
+
* Events per minute this destination receives at most (a token bucket across all delivery machines); events over it stay queued and go out as the bucket refills, never dropped
|
|
86
|
+
* @type {number}
|
|
87
|
+
* @memberof Destination
|
|
88
|
+
*/
|
|
89
|
+
max_events_per_minute: number;
|
|
90
|
+
/**
|
|
91
|
+
* Digest window: new events are held until the oldest is this many seconds old, then go out together as ONE alert.fired.batch (≤ 500 events / 1 MB per request); retries are not held. Not with preset claude_routine; null = off
|
|
92
|
+
* @type {number}
|
|
93
|
+
* @memberof Destination
|
|
94
|
+
*/
|
|
95
|
+
digest_seconds: number | null;
|
|
84
96
|
/**
|
|
85
97
|
* The rotated-out secret signs until then
|
|
86
98
|
* @type {Date}
|
|
@@ -66,6 +66,10 @@ function instanceOfDestination(value) {
|
|
|
66
66
|
return false;
|
|
67
67
|
if (!('body_template' in value) || value['body_template'] === undefined)
|
|
68
68
|
return false;
|
|
69
|
+
if (!('max_events_per_minute' in value) || value['max_events_per_minute'] === undefined)
|
|
70
|
+
return false;
|
|
71
|
+
if (!('digest_seconds' in value) || value['digest_seconds'] === undefined)
|
|
72
|
+
return false;
|
|
69
73
|
if (!('previous_secret_expires_at' in value) || value['previous_secret_expires_at'] === undefined)
|
|
70
74
|
return false;
|
|
71
75
|
if (!('created_at' in value) || value['created_at'] === undefined)
|
|
@@ -93,6 +97,8 @@ function DestinationFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
93
97
|
'secret_hint': json['secret_hint'],
|
|
94
98
|
'header_names': json['header_names'],
|
|
95
99
|
'body_template': json['body_template'],
|
|
100
|
+
'max_events_per_minute': json['max_events_per_minute'],
|
|
101
|
+
'digest_seconds': json['digest_seconds'],
|
|
96
102
|
'previous_secret_expires_at': (json['previous_secret_expires_at'] == null ? null : new Date(json['previous_secret_expires_at'])),
|
|
97
103
|
'created_at': (new Date(json['created_at'])),
|
|
98
104
|
'updated_at': (new Date(json['updated_at'])),
|
|
@@ -117,6 +123,8 @@ function DestinationToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
117
123
|
'secret_hint': value['secret_hint'],
|
|
118
124
|
'header_names': value['header_names'],
|
|
119
125
|
'body_template': value['body_template'],
|
|
126
|
+
'max_events_per_minute': value['max_events_per_minute'],
|
|
127
|
+
'digest_seconds': value['digest_seconds'],
|
|
120
128
|
'previous_secret_expires_at': value['previous_secret_expires_at'] == null ? value['previous_secret_expires_at'] : value['previous_secret_expires_at'].toISOString(),
|
|
121
129
|
'created_at': value['created_at'].toISOString(),
|
|
122
130
|
'updated_at': value['updated_at'].toISOString(),
|
|
@@ -81,6 +81,18 @@ export interface DestinationCreated {
|
|
|
81
81
|
* @memberof DestinationCreated
|
|
82
82
|
*/
|
|
83
83
|
body_template: string | null;
|
|
84
|
+
/**
|
|
85
|
+
* Events per minute this destination receives at most (a token bucket across all delivery machines); events over it stay queued and go out as the bucket refills, never dropped
|
|
86
|
+
* @type {number}
|
|
87
|
+
* @memberof DestinationCreated
|
|
88
|
+
*/
|
|
89
|
+
max_events_per_minute: number;
|
|
90
|
+
/**
|
|
91
|
+
* Digest window: new events are held until the oldest is this many seconds old, then go out together as ONE alert.fired.batch (≤ 500 events / 1 MB per request); retries are not held. Not with preset claude_routine; null = off
|
|
92
|
+
* @type {number}
|
|
93
|
+
* @memberof DestinationCreated
|
|
94
|
+
*/
|
|
95
|
+
digest_seconds: number | null;
|
|
84
96
|
/**
|
|
85
97
|
* The rotated-out secret signs until then
|
|
86
98
|
* @type {Date}
|
|
@@ -66,6 +66,10 @@ function instanceOfDestinationCreated(value) {
|
|
|
66
66
|
return false;
|
|
67
67
|
if (!('body_template' in value) || value['body_template'] === undefined)
|
|
68
68
|
return false;
|
|
69
|
+
if (!('max_events_per_minute' in value) || value['max_events_per_minute'] === undefined)
|
|
70
|
+
return false;
|
|
71
|
+
if (!('digest_seconds' in value) || value['digest_seconds'] === undefined)
|
|
72
|
+
return false;
|
|
69
73
|
if (!('previous_secret_expires_at' in value) || value['previous_secret_expires_at'] === undefined)
|
|
70
74
|
return false;
|
|
71
75
|
if (!('created_at' in value) || value['created_at'] === undefined)
|
|
@@ -95,6 +99,8 @@ function DestinationCreatedFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
95
99
|
'secret_hint': json['secret_hint'],
|
|
96
100
|
'header_names': json['header_names'],
|
|
97
101
|
'body_template': json['body_template'],
|
|
102
|
+
'max_events_per_minute': json['max_events_per_minute'],
|
|
103
|
+
'digest_seconds': json['digest_seconds'],
|
|
98
104
|
'previous_secret_expires_at': (json['previous_secret_expires_at'] == null ? null : new Date(json['previous_secret_expires_at'])),
|
|
99
105
|
'created_at': (new Date(json['created_at'])),
|
|
100
106
|
'updated_at': (new Date(json['updated_at'])),
|
|
@@ -120,6 +126,8 @@ function DestinationCreatedToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
120
126
|
'secret_hint': value['secret_hint'],
|
|
121
127
|
'header_names': value['header_names'],
|
|
122
128
|
'body_template': value['body_template'],
|
|
129
|
+
'max_events_per_minute': value['max_events_per_minute'],
|
|
130
|
+
'digest_seconds': value['digest_seconds'],
|
|
123
131
|
'previous_secret_expires_at': value['previous_secret_expires_at'] == null ? value['previous_secret_expires_at'] : value['previous_secret_expires_at'].toISOString(),
|
|
124
132
|
'created_at': value['created_at'].toISOString(),
|
|
125
133
|
'updated_at': value['updated_at'].toISOString(),
|
|
@@ -53,6 +53,18 @@ export interface UpdateDestinationRequest {
|
|
|
53
53
|
* @memberof UpdateDestinationRequest
|
|
54
54
|
*/
|
|
55
55
|
preset?: UpdateDestinationRequestPresetEnum;
|
|
56
|
+
/**
|
|
57
|
+
* Events per minute this destination receives at most (a token bucket across all delivery machines); events over it stay queued and go out as the bucket refills, never dropped
|
|
58
|
+
* @type {number}
|
|
59
|
+
* @memberof UpdateDestinationRequest
|
|
60
|
+
*/
|
|
61
|
+
max_events_per_minute?: number;
|
|
62
|
+
/**
|
|
63
|
+
* Digest window: new events are held until the oldest is this many seconds old, then go out together as ONE alert.fired.batch (≤ 500 events / 1 MB per request); retries are not held. Not with preset claude_routine; null turns it off
|
|
64
|
+
* @type {number}
|
|
65
|
+
* @memberof UpdateDestinationRequest
|
|
66
|
+
*/
|
|
67
|
+
digest_seconds?: number | null;
|
|
56
68
|
/**
|
|
57
69
|
* active re-enables; disabled pauses it
|
|
58
70
|
* @type {UpdateDestinationRequestStatusEnum}
|
|
@@ -60,6 +60,8 @@ function UpdateDestinationRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
60
60
|
'headers': json['headers'] == null ? undefined : json['headers'],
|
|
61
61
|
'body_template': json['body_template'] == null ? undefined : json['body_template'],
|
|
62
62
|
'preset': json['preset'] == null ? undefined : json['preset'],
|
|
63
|
+
'max_events_per_minute': json['max_events_per_minute'] == null ? undefined : json['max_events_per_minute'],
|
|
64
|
+
'digest_seconds': json['digest_seconds'] == null ? undefined : json['digest_seconds'],
|
|
63
65
|
'status': json['status'] == null ? undefined : json['status'],
|
|
64
66
|
};
|
|
65
67
|
}
|
|
@@ -77,6 +79,8 @@ function UpdateDestinationRequestToJSONTyped(value, ignoreDiscriminator = false)
|
|
|
77
79
|
'headers': value['headers'],
|
|
78
80
|
'body_template': value['body_template'],
|
|
79
81
|
'preset': value['preset'],
|
|
82
|
+
'max_events_per_minute': value['max_events_per_minute'],
|
|
83
|
+
'digest_seconds': value['digest_seconds'],
|
|
80
84
|
'status': value['status'],
|
|
81
85
|
};
|
|
82
86
|
}
|
package/docs/AlertCondition.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
|
|
2
2
|
# AlertCondition
|
|
3
3
|
|
|
4
|
-
What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls.
|
|
4
|
+
What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Price types (`price`, `price_move`, `volume_spike`, `price_reminder`) watch ONE instrument: `symbol` + `asset_class`. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls. US ETFs: `dividend`, `event_countdown` (`ex_dividend` / `dividend_payment`), `filing` and `filing_keyword` take an ETF ticker (SPY or a trust series such as TQQQ; a series ETF is stored by symbol and fires only on events that name it, never on another series\' filing of its trust); `earnings_call`, `earnings_call_keyword`, `earnings_results`, `fundamental_metric` and an `earnings_call` countdown refuse an ETF by name (400 `invalid_parameter`), `news` / `news_keyword` a series ETF.
|
|
5
5
|
|
|
6
6
|
## Properties
|
|
7
7
|
|
|
@@ -40,6 +40,24 @@ Name | Type
|
|
|
40
40
|
`time_of_day_minutes` | number
|
|
41
41
|
`timezone` | string
|
|
42
42
|
`notify_on_date_change` | boolean
|
|
43
|
+
`asset_class` | string
|
|
44
|
+
`operator` | string
|
|
45
|
+
`level` | number
|
|
46
|
+
`direction` | string
|
|
47
|
+
`pct` | number
|
|
48
|
+
`baseline` | string
|
|
49
|
+
`window_minutes` | number
|
|
50
|
+
`mode` | string
|
|
51
|
+
`interval` | string
|
|
52
|
+
`multiple` | number
|
|
53
|
+
`threshold` | number
|
|
54
|
+
`lookback_bars` | number
|
|
55
|
+
`baseline_mode` | string
|
|
56
|
+
`price_direction` | string
|
|
57
|
+
`frequency` | string
|
|
58
|
+
`at` | Date
|
|
59
|
+
`weekday` | number
|
|
60
|
+
`days` | Array<number>
|
|
43
61
|
|
|
44
62
|
## Example
|
|
45
63
|
|
|
@@ -81,6 +99,24 @@ const example = {
|
|
|
81
99
|
"time_of_day_minutes": null,
|
|
82
100
|
"timezone": null,
|
|
83
101
|
"notify_on_date_change": null,
|
|
102
|
+
"asset_class": null,
|
|
103
|
+
"operator": null,
|
|
104
|
+
"level": null,
|
|
105
|
+
"direction": null,
|
|
106
|
+
"pct": null,
|
|
107
|
+
"baseline": null,
|
|
108
|
+
"window_minutes": null,
|
|
109
|
+
"mode": null,
|
|
110
|
+
"interval": null,
|
|
111
|
+
"multiple": null,
|
|
112
|
+
"threshold": null,
|
|
113
|
+
"lookback_bars": null,
|
|
114
|
+
"baseline_mode": null,
|
|
115
|
+
"price_direction": null,
|
|
116
|
+
"frequency": null,
|
|
117
|
+
"at": null,
|
|
118
|
+
"weekday": null,
|
|
119
|
+
"days": null,
|
|
84
120
|
} satisfies AlertCondition
|
|
85
121
|
|
|
86
122
|
console.log(example)
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
|
|
2
2
|
# AlertConditionInput
|
|
3
3
|
|
|
4
|
-
What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls. (request form)
|
|
4
|
+
What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Price types (`price`, `price_move`, `volume_spike`, `price_reminder`) watch ONE instrument: `symbol` + `asset_class`. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls. (request form) US ETFs: `dividend`, `event_countdown` (`ex_dividend` / `dividend_payment`), `filing` and `filing_keyword` take an ETF ticker (SPY or a trust series such as TQQQ; a series ETF is stored by symbol and fires only on events that name it, never on another series\' filing of its trust); `earnings_call`, `earnings_call_keyword`, `earnings_results`, `fundamental_metric` and an `earnings_call` countdown refuse an ETF by name (400 `invalid_parameter`), `news` / `news_keyword` a series ETF.
|
|
5
5
|
|
|
6
6
|
## Properties
|
|
7
7
|
|
|
@@ -40,6 +40,24 @@ Name | Type
|
|
|
40
40
|
`time_of_day_minutes` | number
|
|
41
41
|
`timezone` | string
|
|
42
42
|
`notify_on_date_change` | boolean
|
|
43
|
+
`asset_class` | string
|
|
44
|
+
`operator` | string
|
|
45
|
+
`level` | number
|
|
46
|
+
`direction` | string
|
|
47
|
+
`pct` | number
|
|
48
|
+
`baseline` | string
|
|
49
|
+
`window_minutes` | number
|
|
50
|
+
`mode` | string
|
|
51
|
+
`interval` | string
|
|
52
|
+
`multiple` | number
|
|
53
|
+
`threshold` | number
|
|
54
|
+
`lookback_bars` | number
|
|
55
|
+
`baseline_mode` | string
|
|
56
|
+
`price_direction` | string
|
|
57
|
+
`frequency` | string
|
|
58
|
+
`at` | string
|
|
59
|
+
`weekday` | number
|
|
60
|
+
`days` | Array<number>
|
|
43
61
|
|
|
44
62
|
## Example
|
|
45
63
|
|
|
@@ -81,6 +99,24 @@ const example = {
|
|
|
81
99
|
"time_of_day_minutes": null,
|
|
82
100
|
"timezone": null,
|
|
83
101
|
"notify_on_date_change": null,
|
|
102
|
+
"asset_class": null,
|
|
103
|
+
"operator": null,
|
|
104
|
+
"level": null,
|
|
105
|
+
"direction": null,
|
|
106
|
+
"pct": null,
|
|
107
|
+
"baseline": null,
|
|
108
|
+
"window_minutes": null,
|
|
109
|
+
"mode": null,
|
|
110
|
+
"interval": null,
|
|
111
|
+
"multiple": null,
|
|
112
|
+
"threshold": null,
|
|
113
|
+
"lookback_bars": null,
|
|
114
|
+
"baseline_mode": null,
|
|
115
|
+
"price_direction": null,
|
|
116
|
+
"frequency": null,
|
|
117
|
+
"at": null,
|
|
118
|
+
"weekday": null,
|
|
119
|
+
"days": null,
|
|
84
120
|
} satisfies AlertConditionInput
|
|
85
121
|
|
|
86
122
|
console.log(example)
|
package/docs/CompaniesApi.md
CHANGED
|
@@ -587,7 +587,7 @@ async function example() {
|
|
|
587
587
|
const api = new CompaniesApi(config);
|
|
588
588
|
|
|
589
589
|
const body = {
|
|
590
|
-
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. (optional)
|
|
590
|
+
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. (optional)
|
|
591
591
|
company: AAPL,
|
|
592
592
|
// string | Event id (optional)
|
|
593
593
|
event: evt_01JC8M2X,
|
|
@@ -622,7 +622,7 @@ example().catch(console.error);
|
|
|
622
622
|
|
|
623
623
|
| Name | Type | Description | Notes |
|
|
624
624
|
|------------- | ------------- | ------------- | -------------|
|
|
625
|
-
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. | [Optional] [Defaults to `undefined`] |
|
|
625
|
+
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [Optional] [Defaults to `undefined`] |
|
|
626
626
|
| **event** | `string` | Event id | [Optional] [Defaults to `undefined`] |
|
|
627
627
|
| **role** | `executive`, `analyst`, `operator`, `other` | Role | [Optional] [Defaults to `undefined`] [Enum: executive, analyst, operator, other] |
|
|
628
628
|
| **q** | `string` | Name | [Optional] [Defaults to `undefined`] |
|
|
@@ -12,6 +12,8 @@ Name | Type
|
|
|
12
12
|
`headers` | { [key: string]: string; }
|
|
13
13
|
`body_template` | string
|
|
14
14
|
`preset` | string
|
|
15
|
+
`max_events_per_minute` | number
|
|
16
|
+
`digest_seconds` | number
|
|
15
17
|
|
|
16
18
|
## Example
|
|
17
19
|
|
|
@@ -26,6 +28,8 @@ const example = {
|
|
|
26
28
|
"headers": null,
|
|
27
29
|
"body_template": null,
|
|
28
30
|
"preset": null,
|
|
31
|
+
"max_events_per_minute": null,
|
|
32
|
+
"digest_seconds": null,
|
|
29
33
|
} satisfies CreateDestinationRequest
|
|
30
34
|
|
|
31
35
|
console.log(example)
|
package/docs/Destination.md
CHANGED
|
@@ -17,6 +17,8 @@ Name | Type
|
|
|
17
17
|
`secret_hint` | string
|
|
18
18
|
`header_names` | Array<string>
|
|
19
19
|
`body_template` | string
|
|
20
|
+
`max_events_per_minute` | number
|
|
21
|
+
`digest_seconds` | number
|
|
20
22
|
`previous_secret_expires_at` | Date
|
|
21
23
|
`created_at` | Date
|
|
22
24
|
`updated_at` | Date
|
|
@@ -39,6 +41,8 @@ const example = {
|
|
|
39
41
|
"secret_hint": null,
|
|
40
42
|
"header_names": null,
|
|
41
43
|
"body_template": null,
|
|
44
|
+
"max_events_per_minute": null,
|
|
45
|
+
"digest_seconds": null,
|
|
42
46
|
"previous_secret_expires_at": null,
|
|
43
47
|
"created_at": null,
|
|
44
48
|
"updated_at": null,
|
|
@@ -18,6 +18,8 @@ Name | Type
|
|
|
18
18
|
`secret_hint` | string
|
|
19
19
|
`header_names` | Array<string>
|
|
20
20
|
`body_template` | string
|
|
21
|
+
`max_events_per_minute` | number
|
|
22
|
+
`digest_seconds` | number
|
|
21
23
|
`previous_secret_expires_at` | Date
|
|
22
24
|
`created_at` | Date
|
|
23
25
|
`updated_at` | Date
|
|
@@ -41,6 +43,8 @@ const example = {
|
|
|
41
43
|
"secret_hint": null,
|
|
42
44
|
"header_names": null,
|
|
43
45
|
"body_template": null,
|
|
46
|
+
"max_events_per_minute": null,
|
|
47
|
+
"digest_seconds": null,
|
|
44
48
|
"previous_secret_expires_at": null,
|
|
45
49
|
"created_at": null,
|
|
46
50
|
"updated_at": null,
|
package/docs/EventsApi.md
CHANGED
|
@@ -452,7 +452,7 @@ async function example() {
|
|
|
452
452
|
const api = new EventsApi(config);
|
|
453
453
|
|
|
454
454
|
const body = {
|
|
455
|
-
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. (optional)
|
|
455
|
+
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. (optional)
|
|
456
456
|
company: AAPL,
|
|
457
457
|
// string | Event types (default earnings_call) — any of `earnings_call`, `investor_day`, `conference`, `agm`, `other`, `all`, comma-separated (optional)
|
|
458
458
|
type: earnings_call,
|
|
@@ -501,7 +501,7 @@ example().catch(console.error);
|
|
|
501
501
|
|
|
502
502
|
| Name | Type | Description | Notes |
|
|
503
503
|
|------------- | ------------- | ------------- | -------------|
|
|
504
|
-
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. | [Optional] [Defaults to `undefined`] |
|
|
504
|
+
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [Optional] [Defaults to `undefined`] |
|
|
505
505
|
| **type** | `string` | Event types (default earnings_call) — any of `earnings_call`, `investor_day`, `conference`, `agm`, `other`, `all`, comma-separated | [Optional] [Defaults to `undefined`] |
|
|
506
506
|
| **status** | `string` | Status — any of `upcoming`, `live`, `ended`, comma-separated | [Optional] [Defaults to `undefined`] |
|
|
507
507
|
| **scheduledAtGte** | `Date` | `scheduled_at` on or after this value | [Optional] [Defaults to `undefined`] |
|