@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
|
@@ -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) 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.
|
|
19
19
|
* @export
|
|
20
20
|
* @interface AlertConditionInput
|
|
21
21
|
*/
|
|
@@ -27,7 +27,7 @@ export interface AlertConditionInput {
|
|
|
27
27
|
*/
|
|
28
28
|
ciks?: Array<string>;
|
|
29
29
|
/**
|
|
30
|
-
* Companies by ticker. Same types as `ciks
|
|
30
|
+
* Companies by ticker. Same types as `ciks`; a US ETF ticker for the types that take ETFs
|
|
31
31
|
* @type {Array<string>}
|
|
32
32
|
* @memberof AlertConditionInput
|
|
33
33
|
*/
|
|
@@ -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 (or, for the types that take ETFs, the US ETF) 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
|
*/
|
|
@@ -120,6 +120,83 @@ export const AlertConditionInputEventEnum = {
|
|
|
120
120
|
ExDividend: 'ex_dividend',
|
|
121
121
|
DividendPayment: 'dividend_payment'
|
|
122
122
|
};
|
|
123
|
+
/**
|
|
124
|
+
* @export
|
|
125
|
+
*/
|
|
126
|
+
export const AlertConditionInputAssetClassEnum = {
|
|
127
|
+
UsStock: 'us_stock',
|
|
128
|
+
Crypto: 'crypto'
|
|
129
|
+
};
|
|
130
|
+
/**
|
|
131
|
+
* @export
|
|
132
|
+
*/
|
|
133
|
+
export const AlertConditionInputOperatorEnum = {
|
|
134
|
+
CrossesAbove: 'crosses_above',
|
|
135
|
+
CrossesBelow: 'crosses_below',
|
|
136
|
+
Crosses: 'crosses',
|
|
137
|
+
Above: 'above',
|
|
138
|
+
Below: 'below'
|
|
139
|
+
};
|
|
140
|
+
/**
|
|
141
|
+
* @export
|
|
142
|
+
*/
|
|
143
|
+
export const AlertConditionInputDirectionEnum = {
|
|
144
|
+
Up: 'up',
|
|
145
|
+
Down: 'down',
|
|
146
|
+
Both: 'both'
|
|
147
|
+
};
|
|
148
|
+
/**
|
|
149
|
+
* @export
|
|
150
|
+
*/
|
|
151
|
+
export const AlertConditionInputBaselineEnum = {
|
|
152
|
+
PriorClose: 'prior_close',
|
|
153
|
+
IntradayOpen: 'intraday_open',
|
|
154
|
+
SessionHigh: 'session_high',
|
|
155
|
+
SessionLow: 'session_low',
|
|
156
|
+
GapOpen: 'gap_open'
|
|
157
|
+
};
|
|
158
|
+
/**
|
|
159
|
+
* @export
|
|
160
|
+
*/
|
|
161
|
+
export const AlertConditionInputModeEnum = {
|
|
162
|
+
Relative: 'relative',
|
|
163
|
+
Absolute: 'absolute',
|
|
164
|
+
Session: 'session'
|
|
165
|
+
};
|
|
166
|
+
/**
|
|
167
|
+
* @export
|
|
168
|
+
*/
|
|
169
|
+
export const AlertConditionInputIntervalEnum = {
|
|
170
|
+
_1h: '1h',
|
|
171
|
+
_1d: '1d',
|
|
172
|
+
_1w: '1w',
|
|
173
|
+
_1mo: '1mo'
|
|
174
|
+
};
|
|
175
|
+
/**
|
|
176
|
+
* @export
|
|
177
|
+
*/
|
|
178
|
+
export const AlertConditionInputBaselineModeEnum = {
|
|
179
|
+
FlatMean: 'flat_mean',
|
|
180
|
+
RvolSlot: 'rvol_slot',
|
|
181
|
+
Median: 'median'
|
|
182
|
+
};
|
|
183
|
+
/**
|
|
184
|
+
* @export
|
|
185
|
+
*/
|
|
186
|
+
export const AlertConditionInputPriceDirectionEnum = {
|
|
187
|
+
Up: 'up',
|
|
188
|
+
Down: 'down',
|
|
189
|
+
Any: 'any'
|
|
190
|
+
};
|
|
191
|
+
/**
|
|
192
|
+
* @export
|
|
193
|
+
*/
|
|
194
|
+
export const AlertConditionInputFrequencyEnum = {
|
|
195
|
+
Once: 'once',
|
|
196
|
+
Hourly: 'hourly',
|
|
197
|
+
Daily: 'daily',
|
|
198
|
+
Weekly: 'weekly'
|
|
199
|
+
};
|
|
123
200
|
/**
|
|
124
201
|
* Check if a given object implements the AlertConditionInput interface.
|
|
125
202
|
*/
|
|
@@ -167,6 +244,24 @@ export function AlertConditionInputFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
167
244
|
'time_of_day_minutes': json['time_of_day_minutes'] == null ? undefined : json['time_of_day_minutes'],
|
|
168
245
|
'timezone': json['timezone'] == null ? undefined : json['timezone'],
|
|
169
246
|
'notify_on_date_change': json['notify_on_date_change'] == null ? undefined : json['notify_on_date_change'],
|
|
247
|
+
'asset_class': json['asset_class'] == null ? undefined : json['asset_class'],
|
|
248
|
+
'operator': json['operator'] == null ? undefined : json['operator'],
|
|
249
|
+
'level': json['level'] == null ? undefined : json['level'],
|
|
250
|
+
'direction': json['direction'] == null ? undefined : json['direction'],
|
|
251
|
+
'pct': json['pct'] == null ? undefined : json['pct'],
|
|
252
|
+
'baseline': json['baseline'] == null ? undefined : json['baseline'],
|
|
253
|
+
'window_minutes': json['window_minutes'] == null ? undefined : json['window_minutes'],
|
|
254
|
+
'mode': json['mode'] == null ? undefined : json['mode'],
|
|
255
|
+
'interval': json['interval'] == null ? undefined : json['interval'],
|
|
256
|
+
'multiple': json['multiple'] == null ? undefined : json['multiple'],
|
|
257
|
+
'threshold': json['threshold'] == null ? undefined : json['threshold'],
|
|
258
|
+
'lookback_bars': json['lookback_bars'] == null ? undefined : json['lookback_bars'],
|
|
259
|
+
'baseline_mode': json['baseline_mode'] == null ? undefined : json['baseline_mode'],
|
|
260
|
+
'price_direction': json['price_direction'] == null ? undefined : json['price_direction'],
|
|
261
|
+
'frequency': json['frequency'] == null ? undefined : json['frequency'],
|
|
262
|
+
'at': json['at'] == null ? undefined : json['at'],
|
|
263
|
+
'weekday': json['weekday'] == null ? undefined : json['weekday'],
|
|
264
|
+
'days': json['days'] == null ? undefined : json['days'],
|
|
170
265
|
};
|
|
171
266
|
}
|
|
172
267
|
export function AlertConditionInputToJSON(json) {
|
|
@@ -210,5 +305,23 @@ export function AlertConditionInputToJSONTyped(value, ignoreDiscriminator = fals
|
|
|
210
305
|
'time_of_day_minutes': value['time_of_day_minutes'],
|
|
211
306
|
'timezone': value['timezone'],
|
|
212
307
|
'notify_on_date_change': value['notify_on_date_change'],
|
|
308
|
+
'asset_class': value['asset_class'],
|
|
309
|
+
'operator': value['operator'],
|
|
310
|
+
'level': value['level'],
|
|
311
|
+
'direction': value['direction'],
|
|
312
|
+
'pct': value['pct'],
|
|
313
|
+
'baseline': value['baseline'],
|
|
314
|
+
'window_minutes': value['window_minutes'],
|
|
315
|
+
'mode': value['mode'],
|
|
316
|
+
'interval': value['interval'],
|
|
317
|
+
'multiple': value['multiple'],
|
|
318
|
+
'threshold': value['threshold'],
|
|
319
|
+
'lookback_bars': value['lookback_bars'],
|
|
320
|
+
'baseline_mode': value['baseline_mode'],
|
|
321
|
+
'price_direction': value['price_direction'],
|
|
322
|
+
'frequency': value['frequency'],
|
|
323
|
+
'at': value['at'],
|
|
324
|
+
'weekday': value['weekday'],
|
|
325
|
+
'days': value['days'],
|
|
213
326
|
};
|
|
214
327
|
}
|
|
@@ -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
|
|
@@ -47,6 +47,8 @@ export function CreateDestinationRequestFromJSONTyped(json, ignoreDiscriminator)
|
|
|
47
47
|
'headers': json['headers'] == null ? undefined : json['headers'],
|
|
48
48
|
'body_template': json['body_template'] == null ? undefined : json['body_template'],
|
|
49
49
|
'preset': json['preset'] == null ? undefined : json['preset'],
|
|
50
|
+
'max_events_per_minute': json['max_events_per_minute'] == null ? undefined : json['max_events_per_minute'],
|
|
51
|
+
'digest_seconds': json['digest_seconds'] == null ? undefined : json['digest_seconds'],
|
|
50
52
|
};
|
|
51
53
|
}
|
|
52
54
|
export function CreateDestinationRequestToJSON(json) {
|
|
@@ -63,5 +65,7 @@ export function CreateDestinationRequestToJSONTyped(value, ignoreDiscriminator =
|
|
|
63
65
|
'headers': value['headers'],
|
|
64
66
|
'body_template': value['body_template'],
|
|
65
67
|
'preset': value['preset'],
|
|
68
|
+
'max_events_per_minute': value['max_events_per_minute'],
|
|
69
|
+
'digest_seconds': value['digest_seconds'],
|
|
66
70
|
};
|
|
67
71
|
}
|
|
@@ -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}
|
|
@@ -58,6 +58,10 @@ export function instanceOfDestination(value) {
|
|
|
58
58
|
return false;
|
|
59
59
|
if (!('body_template' in value) || value['body_template'] === undefined)
|
|
60
60
|
return false;
|
|
61
|
+
if (!('max_events_per_minute' in value) || value['max_events_per_minute'] === undefined)
|
|
62
|
+
return false;
|
|
63
|
+
if (!('digest_seconds' in value) || value['digest_seconds'] === undefined)
|
|
64
|
+
return false;
|
|
61
65
|
if (!('previous_secret_expires_at' in value) || value['previous_secret_expires_at'] === undefined)
|
|
62
66
|
return false;
|
|
63
67
|
if (!('created_at' in value) || value['created_at'] === undefined)
|
|
@@ -85,6 +89,8 @@ export function DestinationFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
85
89
|
'secret_hint': json['secret_hint'],
|
|
86
90
|
'header_names': json['header_names'],
|
|
87
91
|
'body_template': json['body_template'],
|
|
92
|
+
'max_events_per_minute': json['max_events_per_minute'],
|
|
93
|
+
'digest_seconds': json['digest_seconds'],
|
|
88
94
|
'previous_secret_expires_at': (json['previous_secret_expires_at'] == null ? null : new Date(json['previous_secret_expires_at'])),
|
|
89
95
|
'created_at': (new Date(json['created_at'])),
|
|
90
96
|
'updated_at': (new Date(json['updated_at'])),
|
|
@@ -109,6 +115,8 @@ export function DestinationToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
109
115
|
'secret_hint': value['secret_hint'],
|
|
110
116
|
'header_names': value['header_names'],
|
|
111
117
|
'body_template': value['body_template'],
|
|
118
|
+
'max_events_per_minute': value['max_events_per_minute'],
|
|
119
|
+
'digest_seconds': value['digest_seconds'],
|
|
112
120
|
'previous_secret_expires_at': value['previous_secret_expires_at'] == null ? value['previous_secret_expires_at'] : value['previous_secret_expires_at'].toISOString(),
|
|
113
121
|
'created_at': value['created_at'].toISOString(),
|
|
114
122
|
'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}
|
|
@@ -58,6 +58,10 @@ export function instanceOfDestinationCreated(value) {
|
|
|
58
58
|
return false;
|
|
59
59
|
if (!('body_template' in value) || value['body_template'] === undefined)
|
|
60
60
|
return false;
|
|
61
|
+
if (!('max_events_per_minute' in value) || value['max_events_per_minute'] === undefined)
|
|
62
|
+
return false;
|
|
63
|
+
if (!('digest_seconds' in value) || value['digest_seconds'] === undefined)
|
|
64
|
+
return false;
|
|
61
65
|
if (!('previous_secret_expires_at' in value) || value['previous_secret_expires_at'] === undefined)
|
|
62
66
|
return false;
|
|
63
67
|
if (!('created_at' in value) || value['created_at'] === undefined)
|
|
@@ -87,6 +91,8 @@ export function DestinationCreatedFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
87
91
|
'secret_hint': json['secret_hint'],
|
|
88
92
|
'header_names': json['header_names'],
|
|
89
93
|
'body_template': json['body_template'],
|
|
94
|
+
'max_events_per_minute': json['max_events_per_minute'],
|
|
95
|
+
'digest_seconds': json['digest_seconds'],
|
|
90
96
|
'previous_secret_expires_at': (json['previous_secret_expires_at'] == null ? null : new Date(json['previous_secret_expires_at'])),
|
|
91
97
|
'created_at': (new Date(json['created_at'])),
|
|
92
98
|
'updated_at': (new Date(json['updated_at'])),
|
|
@@ -112,6 +118,8 @@ export function DestinationCreatedToJSONTyped(value, ignoreDiscriminator = false
|
|
|
112
118
|
'secret_hint': value['secret_hint'],
|
|
113
119
|
'header_names': value['header_names'],
|
|
114
120
|
'body_template': value['body_template'],
|
|
121
|
+
'max_events_per_minute': value['max_events_per_minute'],
|
|
122
|
+
'digest_seconds': value['digest_seconds'],
|
|
115
123
|
'previous_secret_expires_at': value['previous_secret_expires_at'] == null ? value['previous_secret_expires_at'] : value['previous_secret_expires_at'].toISOString(),
|
|
116
124
|
'created_at': value['created_at'].toISOString(),
|
|
117
125
|
'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}
|
|
@@ -52,6 +52,8 @@ export function UpdateDestinationRequestFromJSONTyped(json, ignoreDiscriminator)
|
|
|
52
52
|
'headers': json['headers'] == null ? undefined : json['headers'],
|
|
53
53
|
'body_template': json['body_template'] == null ? undefined : json['body_template'],
|
|
54
54
|
'preset': json['preset'] == null ? undefined : json['preset'],
|
|
55
|
+
'max_events_per_minute': json['max_events_per_minute'] == null ? undefined : json['max_events_per_minute'],
|
|
56
|
+
'digest_seconds': json['digest_seconds'] == null ? undefined : json['digest_seconds'],
|
|
55
57
|
'status': json['status'] == null ? undefined : json['status'],
|
|
56
58
|
};
|
|
57
59
|
}
|
|
@@ -69,6 +71,8 @@ export function UpdateDestinationRequestToJSONTyped(value, ignoreDiscriminator =
|
|
|
69
71
|
'headers': value['headers'],
|
|
70
72
|
'body_template': value['body_template'],
|
|
71
73
|
'preset': value['preset'],
|
|
74
|
+
'max_events_per_minute': value['max_events_per_minute'],
|
|
75
|
+
'digest_seconds': value['digest_seconds'],
|
|
72
76
|
'status': value['status'],
|
|
73
77
|
};
|
|
74
78
|
}
|