@invinite-org/data-api-client 6.0.0 → 6.1.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/esm/models/AlertCondition.d.ts +198 -4
- package/dist/esm/models/AlertCondition.js +113 -0
- package/dist/esm/models/AlertConditionInput.d.ts +198 -4
- package/dist/esm/models/AlertConditionInput.js +113 -0
- 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 +198 -4
- package/dist/models/AlertCondition.js +114 -1
- package/dist/models/AlertConditionInput.d.ts +198 -4
- package/dist/models/AlertConditionInput.js +114 -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/CreateDestinationRequest.md +4 -0
- package/docs/Destination.md +4 -0
- package/docs/DestinationCreated.md +4 -0
- package/docs/UpdateDestinationRequest.md +4 -0
- package/package.json +1 -1
- package/src/models/AlertCondition.ts +243 -4
- package/src/models/AlertConditionInput.ts +243 -4
- 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.AlertConditionEventEnum = exports.AlertConditionReportKindsEnum = exports.AlertConditionStatusesEnum = exports.AlertConditionSpeakerRolesEnum = exports.AlertConditionEventsEnum = exports.AlertConditionKindsEnum = exports.AlertConditionScopeEnum = exports.AlertConditionMatchEnum = exports.AlertConditionStageEnum = exports.AlertConditionFormCategoriesEnum = void 0;
|
|
16
|
+
exports.AlertConditionFrequencyEnum = exports.AlertConditionPriceDirectionEnum = exports.AlertConditionBaselineModeEnum = exports.AlertConditionIntervalEnum = exports.AlertConditionModeEnum = exports.AlertConditionBaselineEnum = exports.AlertConditionDirectionEnum = exports.AlertConditionOperatorEnum = exports.AlertConditionAssetClassEnum = exports.AlertConditionEventEnum = exports.AlertConditionReportKindsEnum = exports.AlertConditionStatusesEnum = exports.AlertConditionSpeakerRolesEnum = exports.AlertConditionEventsEnum = exports.AlertConditionKindsEnum = exports.AlertConditionScopeEnum = exports.AlertConditionMatchEnum = exports.AlertConditionStageEnum = exports.AlertConditionFormCategoriesEnum = void 0;
|
|
17
17
|
exports.instanceOfAlertCondition = instanceOfAlertCondition;
|
|
18
18
|
exports.AlertConditionFromJSON = AlertConditionFromJSON;
|
|
19
19
|
exports.AlertConditionFromJSONTyped = AlertConditionFromJSONTyped;
|
|
@@ -128,6 +128,83 @@ exports.AlertConditionEventEnum = {
|
|
|
128
128
|
ExDividend: 'ex_dividend',
|
|
129
129
|
DividendPayment: 'dividend_payment'
|
|
130
130
|
};
|
|
131
|
+
/**
|
|
132
|
+
* @export
|
|
133
|
+
*/
|
|
134
|
+
exports.AlertConditionAssetClassEnum = {
|
|
135
|
+
UsStock: 'us_stock',
|
|
136
|
+
Crypto: 'crypto'
|
|
137
|
+
};
|
|
138
|
+
/**
|
|
139
|
+
* @export
|
|
140
|
+
*/
|
|
141
|
+
exports.AlertConditionOperatorEnum = {
|
|
142
|
+
CrossesAbove: 'crosses_above',
|
|
143
|
+
CrossesBelow: 'crosses_below',
|
|
144
|
+
Crosses: 'crosses',
|
|
145
|
+
Above: 'above',
|
|
146
|
+
Below: 'below'
|
|
147
|
+
};
|
|
148
|
+
/**
|
|
149
|
+
* @export
|
|
150
|
+
*/
|
|
151
|
+
exports.AlertConditionDirectionEnum = {
|
|
152
|
+
Up: 'up',
|
|
153
|
+
Down: 'down',
|
|
154
|
+
Both: 'both'
|
|
155
|
+
};
|
|
156
|
+
/**
|
|
157
|
+
* @export
|
|
158
|
+
*/
|
|
159
|
+
exports.AlertConditionBaselineEnum = {
|
|
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.AlertConditionModeEnum = {
|
|
170
|
+
Relative: 'relative',
|
|
171
|
+
Absolute: 'absolute',
|
|
172
|
+
Session: 'session'
|
|
173
|
+
};
|
|
174
|
+
/**
|
|
175
|
+
* @export
|
|
176
|
+
*/
|
|
177
|
+
exports.AlertConditionIntervalEnum = {
|
|
178
|
+
_1h: '1h',
|
|
179
|
+
_1d: '1d',
|
|
180
|
+
_1w: '1w',
|
|
181
|
+
_1mo: '1mo'
|
|
182
|
+
};
|
|
183
|
+
/**
|
|
184
|
+
* @export
|
|
185
|
+
*/
|
|
186
|
+
exports.AlertConditionBaselineModeEnum = {
|
|
187
|
+
FlatMean: 'flat_mean',
|
|
188
|
+
RvolSlot: 'rvol_slot',
|
|
189
|
+
Median: 'median'
|
|
190
|
+
};
|
|
191
|
+
/**
|
|
192
|
+
* @export
|
|
193
|
+
*/
|
|
194
|
+
exports.AlertConditionPriceDirectionEnum = {
|
|
195
|
+
Up: 'up',
|
|
196
|
+
Down: 'down',
|
|
197
|
+
Any: 'any'
|
|
198
|
+
};
|
|
199
|
+
/**
|
|
200
|
+
* @export
|
|
201
|
+
*/
|
|
202
|
+
exports.AlertConditionFrequencyEnum = {
|
|
203
|
+
Once: 'once',
|
|
204
|
+
Hourly: 'hourly',
|
|
205
|
+
Daily: 'daily',
|
|
206
|
+
Weekly: 'weekly'
|
|
207
|
+
};
|
|
131
208
|
/**
|
|
132
209
|
* Check if a given object implements the AlertCondition interface.
|
|
133
210
|
*/
|
|
@@ -175,6 +252,24 @@ function AlertConditionFromJSONTyped(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 : (new Date(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 AlertConditionToJSON(json) {
|
|
@@ -218,5 +313,23 @@ function AlertConditionToJSONTyped(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'] == null ? value['at'] : value['at'].toISOString(),
|
|
332
|
+
'weekday': value['weekday'],
|
|
333
|
+
'days': value['days'],
|
|
221
334
|
};
|
|
222
335
|
}
|
|
@@ -15,7 +15,7 @@ import type { AlertConditionInputYoyRulesInner } from './AlertConditionInputYoyR
|
|
|
15
15
|
import type { AlertConditionInputRulesInner } from './AlertConditionInputRulesInner';
|
|
16
16
|
import type { AlertConditionInputYieldRule } from './AlertConditionInputYieldRule';
|
|
17
17
|
/**
|
|
18
|
-
* 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)
|
|
18
|
+
* 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)
|
|
19
19
|
* @export
|
|
20
20
|
* @interface AlertConditionInput
|
|
21
21
|
*/
|
|
@@ -39,7 +39,7 @@ export interface AlertConditionInput {
|
|
|
39
39
|
*/
|
|
40
40
|
cik?: string;
|
|
41
41
|
/**
|
|
42
|
-
* The company by ticker. Same types as `cik
|
|
42
|
+
* The company by ticker. Same types as `cik`; price types: the instrument (a US stock / ETF ticker, or a crypto slug / ticker)
|
|
43
43
|
* @type {string}
|
|
44
44
|
* @memberof AlertConditionInput
|
|
45
45
|
*/
|
|
@@ -201,13 +201,13 @@ export interface AlertConditionInput {
|
|
|
201
201
|
*/
|
|
202
202
|
minutes_before?: number;
|
|
203
203
|
/**
|
|
204
|
-
* Local minute of the day the reminder fires (default 540 = 09:00). event_countdown
|
|
204
|
+
* Local minute of the day the reminder fires (event_countdown: default 540 = 09:00). event_countdown, price_reminder
|
|
205
205
|
* @type {number}
|
|
206
206
|
* @memberof AlertConditionInput
|
|
207
207
|
*/
|
|
208
208
|
time_of_day_minutes?: number;
|
|
209
209
|
/**
|
|
210
|
-
* IANA time zone. event_countdown
|
|
210
|
+
* IANA time zone (price_reminder: default America/New_York). event_countdown, price_reminder
|
|
211
211
|
* @type {string}
|
|
212
212
|
* @memberof AlertConditionInput
|
|
213
213
|
*/
|
|
@@ -218,6 +218,114 @@ export interface AlertConditionInput {
|
|
|
218
218
|
* @memberof AlertConditionInput
|
|
219
219
|
*/
|
|
220
220
|
notify_on_date_change?: boolean;
|
|
221
|
+
/**
|
|
222
|
+
* The instrument's market: `us_stock` (US stocks and ETFs) or `crypto` (coins by CoinGecko slug or ticker). Absent at create = a stock first, then a coin; stored resolved. price, price_move, volume_spike, price_reminder
|
|
223
|
+
* @type {AlertConditionInputAssetClassEnum}
|
|
224
|
+
* @memberof AlertConditionInput
|
|
225
|
+
*/
|
|
226
|
+
asset_class?: AlertConditionInputAssetClassEnum;
|
|
227
|
+
/**
|
|
228
|
+
* `crosses_*` fire when the price crosses `level`; `above` / `below` also fire at once when the price is already on that side. price
|
|
229
|
+
* @type {AlertConditionInputOperatorEnum}
|
|
230
|
+
* @memberof AlertConditionInput
|
|
231
|
+
*/
|
|
232
|
+
operator?: AlertConditionInputOperatorEnum;
|
|
233
|
+
/**
|
|
234
|
+
* The price level (> 0). price
|
|
235
|
+
* @type {number}
|
|
236
|
+
* @memberof AlertConditionInput
|
|
237
|
+
*/
|
|
238
|
+
level?: number;
|
|
239
|
+
/**
|
|
240
|
+
* Which move fires. price_move
|
|
241
|
+
* @type {AlertConditionInputDirectionEnum}
|
|
242
|
+
* @memberof AlertConditionInput
|
|
243
|
+
*/
|
|
244
|
+
direction?: AlertConditionInputDirectionEnum;
|
|
245
|
+
/**
|
|
246
|
+
* The move in percent of the baseline. price_move
|
|
247
|
+
* @type {number}
|
|
248
|
+
* @memberof AlertConditionInput
|
|
249
|
+
*/
|
|
250
|
+
pct?: number;
|
|
251
|
+
/**
|
|
252
|
+
* What the move is measured from (ignored with window_minutes); gap_open = the session open against the prior close, once per session. price_move
|
|
253
|
+
* @type {AlertConditionInputBaselineEnum}
|
|
254
|
+
* @memberof AlertConditionInput
|
|
255
|
+
*/
|
|
256
|
+
baseline?: AlertConditionInputBaselineEnum;
|
|
257
|
+
/**
|
|
258
|
+
* Measure the move against the price this many minutes ago instead of the baseline. price_move
|
|
259
|
+
* @type {number}
|
|
260
|
+
* @memberof AlertConditionInput
|
|
261
|
+
*/
|
|
262
|
+
window_minutes?: number;
|
|
263
|
+
/**
|
|
264
|
+
* `relative` = a closed bar's volume ≥ multiple × its baseline; `absolute` = ≥ threshold; `session` = today's cumulative volume ≥ multiple × the 20-session average daily volume (US stocks). volume_spike
|
|
265
|
+
* @type {AlertConditionInputModeEnum}
|
|
266
|
+
* @memberof AlertConditionInput
|
|
267
|
+
*/
|
|
268
|
+
mode?: AlertConditionInputModeEnum;
|
|
269
|
+
/**
|
|
270
|
+
* The bar evaluated at its close (relative / absolute). volume_spike
|
|
271
|
+
* @type {AlertConditionInputIntervalEnum}
|
|
272
|
+
* @memberof AlertConditionInput
|
|
273
|
+
*/
|
|
274
|
+
interval?: AlertConditionInputIntervalEnum;
|
|
275
|
+
/**
|
|
276
|
+
* Volume multiple of the baseline (relative / session). volume_spike
|
|
277
|
+
* @type {number}
|
|
278
|
+
* @memberof AlertConditionInput
|
|
279
|
+
*/
|
|
280
|
+
multiple?: number;
|
|
281
|
+
/**
|
|
282
|
+
* Bar volume threshold, > 0 (absolute). volume_spike
|
|
283
|
+
* @type {number}
|
|
284
|
+
* @memberof AlertConditionInput
|
|
285
|
+
*/
|
|
286
|
+
threshold?: number;
|
|
287
|
+
/**
|
|
288
|
+
* Bars in the baseline, 5–200 (rvol_slot: sessions, 2–20). volume_spike
|
|
289
|
+
* @type {number}
|
|
290
|
+
* @memberof AlertConditionInput
|
|
291
|
+
*/
|
|
292
|
+
lookback_bars?: number;
|
|
293
|
+
/**
|
|
294
|
+
* The volume baseline: the mean or the median of the previous bars, or `rvol_slot` = the mean of the same time-of-day bar of earlier sessions (default flat_mean). volume_spike
|
|
295
|
+
* @type {AlertConditionInputBaselineModeEnum}
|
|
296
|
+
* @memberof AlertConditionInput
|
|
297
|
+
*/
|
|
298
|
+
baseline_mode?: AlertConditionInputBaselineModeEnum;
|
|
299
|
+
/**
|
|
300
|
+
* Only bars that closed up / down (default any). volume_spike
|
|
301
|
+
* @type {AlertConditionInputPriceDirectionEnum}
|
|
302
|
+
* @memberof AlertConditionInput
|
|
303
|
+
*/
|
|
304
|
+
price_direction?: AlertConditionInputPriceDirectionEnum;
|
|
305
|
+
/**
|
|
306
|
+
* When the reminder fires: once at `at`, on the hour, daily or weekly at `time_of_day_minutes`. price_reminder
|
|
307
|
+
* @type {AlertConditionInputFrequencyEnum}
|
|
308
|
+
* @memberof AlertConditionInput
|
|
309
|
+
*/
|
|
310
|
+
frequency?: AlertConditionInputFrequencyEnum;
|
|
311
|
+
/**
|
|
312
|
+
* The instant of a `once` reminder (ISO 8601 date-time with offset, e.g. 2026-12-01T14:30:00Z). price_reminder
|
|
313
|
+
* @type {string}
|
|
314
|
+
* @memberof AlertConditionInput
|
|
315
|
+
*/
|
|
316
|
+
at?: string;
|
|
317
|
+
/**
|
|
318
|
+
* Day of a weekly reminder, 0 = Sunday. price_reminder
|
|
319
|
+
* @type {number}
|
|
320
|
+
* @memberof AlertConditionInput
|
|
321
|
+
*/
|
|
322
|
+
weekday?: number;
|
|
323
|
+
/**
|
|
324
|
+
* Several weekdays (0 = Sunday) of a daily / weekly reminder. price_reminder
|
|
325
|
+
* @type {Array<number>}
|
|
326
|
+
* @memberof AlertConditionInput
|
|
327
|
+
*/
|
|
328
|
+
days?: Array<number>;
|
|
221
329
|
}
|
|
222
330
|
/**
|
|
223
331
|
* @export
|
|
@@ -333,6 +441,92 @@ export declare const AlertConditionInputEventEnum: {
|
|
|
333
441
|
readonly DividendPayment: "dividend_payment";
|
|
334
442
|
};
|
|
335
443
|
export type AlertConditionInputEventEnum = typeof AlertConditionInputEventEnum[keyof typeof AlertConditionInputEventEnum];
|
|
444
|
+
/**
|
|
445
|
+
* @export
|
|
446
|
+
*/
|
|
447
|
+
export declare const AlertConditionInputAssetClassEnum: {
|
|
448
|
+
readonly UsStock: "us_stock";
|
|
449
|
+
readonly Crypto: "crypto";
|
|
450
|
+
};
|
|
451
|
+
export type AlertConditionInputAssetClassEnum = typeof AlertConditionInputAssetClassEnum[keyof typeof AlertConditionInputAssetClassEnum];
|
|
452
|
+
/**
|
|
453
|
+
* @export
|
|
454
|
+
*/
|
|
455
|
+
export declare const AlertConditionInputOperatorEnum: {
|
|
456
|
+
readonly CrossesAbove: "crosses_above";
|
|
457
|
+
readonly CrossesBelow: "crosses_below";
|
|
458
|
+
readonly Crosses: "crosses";
|
|
459
|
+
readonly Above: "above";
|
|
460
|
+
readonly Below: "below";
|
|
461
|
+
};
|
|
462
|
+
export type AlertConditionInputOperatorEnum = typeof AlertConditionInputOperatorEnum[keyof typeof AlertConditionInputOperatorEnum];
|
|
463
|
+
/**
|
|
464
|
+
* @export
|
|
465
|
+
*/
|
|
466
|
+
export declare const AlertConditionInputDirectionEnum: {
|
|
467
|
+
readonly Up: "up";
|
|
468
|
+
readonly Down: "down";
|
|
469
|
+
readonly Both: "both";
|
|
470
|
+
};
|
|
471
|
+
export type AlertConditionInputDirectionEnum = typeof AlertConditionInputDirectionEnum[keyof typeof AlertConditionInputDirectionEnum];
|
|
472
|
+
/**
|
|
473
|
+
* @export
|
|
474
|
+
*/
|
|
475
|
+
export declare const AlertConditionInputBaselineEnum: {
|
|
476
|
+
readonly PriorClose: "prior_close";
|
|
477
|
+
readonly IntradayOpen: "intraday_open";
|
|
478
|
+
readonly SessionHigh: "session_high";
|
|
479
|
+
readonly SessionLow: "session_low";
|
|
480
|
+
readonly GapOpen: "gap_open";
|
|
481
|
+
};
|
|
482
|
+
export type AlertConditionInputBaselineEnum = typeof AlertConditionInputBaselineEnum[keyof typeof AlertConditionInputBaselineEnum];
|
|
483
|
+
/**
|
|
484
|
+
* @export
|
|
485
|
+
*/
|
|
486
|
+
export declare const AlertConditionInputModeEnum: {
|
|
487
|
+
readonly Relative: "relative";
|
|
488
|
+
readonly Absolute: "absolute";
|
|
489
|
+
readonly Session: "session";
|
|
490
|
+
};
|
|
491
|
+
export type AlertConditionInputModeEnum = typeof AlertConditionInputModeEnum[keyof typeof AlertConditionInputModeEnum];
|
|
492
|
+
/**
|
|
493
|
+
* @export
|
|
494
|
+
*/
|
|
495
|
+
export declare const AlertConditionInputIntervalEnum: {
|
|
496
|
+
readonly _1h: "1h";
|
|
497
|
+
readonly _1d: "1d";
|
|
498
|
+
readonly _1w: "1w";
|
|
499
|
+
readonly _1mo: "1mo";
|
|
500
|
+
};
|
|
501
|
+
export type AlertConditionInputIntervalEnum = typeof AlertConditionInputIntervalEnum[keyof typeof AlertConditionInputIntervalEnum];
|
|
502
|
+
/**
|
|
503
|
+
* @export
|
|
504
|
+
*/
|
|
505
|
+
export declare const AlertConditionInputBaselineModeEnum: {
|
|
506
|
+
readonly FlatMean: "flat_mean";
|
|
507
|
+
readonly RvolSlot: "rvol_slot";
|
|
508
|
+
readonly Median: "median";
|
|
509
|
+
};
|
|
510
|
+
export type AlertConditionInputBaselineModeEnum = typeof AlertConditionInputBaselineModeEnum[keyof typeof AlertConditionInputBaselineModeEnum];
|
|
511
|
+
/**
|
|
512
|
+
* @export
|
|
513
|
+
*/
|
|
514
|
+
export declare const AlertConditionInputPriceDirectionEnum: {
|
|
515
|
+
readonly Up: "up";
|
|
516
|
+
readonly Down: "down";
|
|
517
|
+
readonly Any: "any";
|
|
518
|
+
};
|
|
519
|
+
export type AlertConditionInputPriceDirectionEnum = typeof AlertConditionInputPriceDirectionEnum[keyof typeof AlertConditionInputPriceDirectionEnum];
|
|
520
|
+
/**
|
|
521
|
+
* @export
|
|
522
|
+
*/
|
|
523
|
+
export declare const AlertConditionInputFrequencyEnum: {
|
|
524
|
+
readonly Once: "once";
|
|
525
|
+
readonly Hourly: "hourly";
|
|
526
|
+
readonly Daily: "daily";
|
|
527
|
+
readonly Weekly: "weekly";
|
|
528
|
+
};
|
|
529
|
+
export type AlertConditionInputFrequencyEnum = typeof AlertConditionInputFrequencyEnum[keyof typeof AlertConditionInputFrequencyEnum];
|
|
336
530
|
/**
|
|
337
531
|
* Check if a given object implements the AlertConditionInput interface.
|
|
338
532
|
*/
|
|
@@ -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
|
}
|
|
@@ -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(),
|