@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
|
@@ -50,7 +50,7 @@ import {
|
|
|
50
50
|
} from './AlertConditionInputYieldRule';
|
|
51
51
|
|
|
52
52
|
/**
|
|
53
|
-
* 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)
|
|
53
|
+
* 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.
|
|
54
54
|
* @export
|
|
55
55
|
* @interface AlertConditionInput
|
|
56
56
|
*/
|
|
@@ -62,7 +62,7 @@ export interface AlertConditionInput {
|
|
|
62
62
|
*/
|
|
63
63
|
ciks?: Array<string>;
|
|
64
64
|
/**
|
|
65
|
-
* Companies by ticker. Same types as `ciks
|
|
65
|
+
* Companies by ticker. Same types as `ciks`; a US ETF ticker for the types that take ETFs
|
|
66
66
|
* @type {Array<string>}
|
|
67
67
|
* @memberof AlertConditionInput
|
|
68
68
|
*/
|
|
@@ -74,7 +74,7 @@ export interface AlertConditionInput {
|
|
|
74
74
|
*/
|
|
75
75
|
cik?: string;
|
|
76
76
|
/**
|
|
77
|
-
* The company by ticker. Same types as `cik
|
|
77
|
+
* 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)
|
|
78
78
|
* @type {string}
|
|
79
79
|
* @memberof AlertConditionInput
|
|
80
80
|
*/
|
|
@@ -236,13 +236,13 @@ export interface AlertConditionInput {
|
|
|
236
236
|
*/
|
|
237
237
|
minutes_before?: number;
|
|
238
238
|
/**
|
|
239
|
-
* Local minute of the day the reminder fires (default 540 = 09:00). event_countdown
|
|
239
|
+
* Local minute of the day the reminder fires (event_countdown: default 540 = 09:00). event_countdown, price_reminder
|
|
240
240
|
* @type {number}
|
|
241
241
|
* @memberof AlertConditionInput
|
|
242
242
|
*/
|
|
243
243
|
time_of_day_minutes?: number;
|
|
244
244
|
/**
|
|
245
|
-
* IANA time zone. event_countdown
|
|
245
|
+
* IANA time zone (price_reminder: default America/New_York). event_countdown, price_reminder
|
|
246
246
|
* @type {string}
|
|
247
247
|
* @memberof AlertConditionInput
|
|
248
248
|
*/
|
|
@@ -253,6 +253,114 @@ export interface AlertConditionInput {
|
|
|
253
253
|
* @memberof AlertConditionInput
|
|
254
254
|
*/
|
|
255
255
|
notify_on_date_change?: boolean;
|
|
256
|
+
/**
|
|
257
|
+
* 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
|
|
258
|
+
* @type {AlertConditionInputAssetClassEnum}
|
|
259
|
+
* @memberof AlertConditionInput
|
|
260
|
+
*/
|
|
261
|
+
asset_class?: AlertConditionInputAssetClassEnum;
|
|
262
|
+
/**
|
|
263
|
+
* `crosses_*` fire when the price crosses `level`; `above` / `below` also fire at once when the price is already on that side. price
|
|
264
|
+
* @type {AlertConditionInputOperatorEnum}
|
|
265
|
+
* @memberof AlertConditionInput
|
|
266
|
+
*/
|
|
267
|
+
operator?: AlertConditionInputOperatorEnum;
|
|
268
|
+
/**
|
|
269
|
+
* The price level (> 0). price
|
|
270
|
+
* @type {number}
|
|
271
|
+
* @memberof AlertConditionInput
|
|
272
|
+
*/
|
|
273
|
+
level?: number;
|
|
274
|
+
/**
|
|
275
|
+
* Which move fires. price_move
|
|
276
|
+
* @type {AlertConditionInputDirectionEnum}
|
|
277
|
+
* @memberof AlertConditionInput
|
|
278
|
+
*/
|
|
279
|
+
direction?: AlertConditionInputDirectionEnum;
|
|
280
|
+
/**
|
|
281
|
+
* The move in percent of the baseline. price_move
|
|
282
|
+
* @type {number}
|
|
283
|
+
* @memberof AlertConditionInput
|
|
284
|
+
*/
|
|
285
|
+
pct?: number;
|
|
286
|
+
/**
|
|
287
|
+
* What the move is measured from (ignored with window_minutes); gap_open = the session open against the prior close, once per session. price_move
|
|
288
|
+
* @type {AlertConditionInputBaselineEnum}
|
|
289
|
+
* @memberof AlertConditionInput
|
|
290
|
+
*/
|
|
291
|
+
baseline?: AlertConditionInputBaselineEnum;
|
|
292
|
+
/**
|
|
293
|
+
* Measure the move against the price this many minutes ago instead of the baseline. price_move
|
|
294
|
+
* @type {number}
|
|
295
|
+
* @memberof AlertConditionInput
|
|
296
|
+
*/
|
|
297
|
+
window_minutes?: number;
|
|
298
|
+
/**
|
|
299
|
+
* `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
|
|
300
|
+
* @type {AlertConditionInputModeEnum}
|
|
301
|
+
* @memberof AlertConditionInput
|
|
302
|
+
*/
|
|
303
|
+
mode?: AlertConditionInputModeEnum;
|
|
304
|
+
/**
|
|
305
|
+
* The bar evaluated at its close (relative / absolute). volume_spike
|
|
306
|
+
* @type {AlertConditionInputIntervalEnum}
|
|
307
|
+
* @memberof AlertConditionInput
|
|
308
|
+
*/
|
|
309
|
+
interval?: AlertConditionInputIntervalEnum;
|
|
310
|
+
/**
|
|
311
|
+
* Volume multiple of the baseline (relative / session). volume_spike
|
|
312
|
+
* @type {number}
|
|
313
|
+
* @memberof AlertConditionInput
|
|
314
|
+
*/
|
|
315
|
+
multiple?: number;
|
|
316
|
+
/**
|
|
317
|
+
* Bar volume threshold, > 0 (absolute). volume_spike
|
|
318
|
+
* @type {number}
|
|
319
|
+
* @memberof AlertConditionInput
|
|
320
|
+
*/
|
|
321
|
+
threshold?: number;
|
|
322
|
+
/**
|
|
323
|
+
* Bars in the baseline, 5–200 (rvol_slot: sessions, 2–20). volume_spike
|
|
324
|
+
* @type {number}
|
|
325
|
+
* @memberof AlertConditionInput
|
|
326
|
+
*/
|
|
327
|
+
lookback_bars?: number;
|
|
328
|
+
/**
|
|
329
|
+
* 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
|
|
330
|
+
* @type {AlertConditionInputBaselineModeEnum}
|
|
331
|
+
* @memberof AlertConditionInput
|
|
332
|
+
*/
|
|
333
|
+
baseline_mode?: AlertConditionInputBaselineModeEnum;
|
|
334
|
+
/**
|
|
335
|
+
* Only bars that closed up / down (default any). volume_spike
|
|
336
|
+
* @type {AlertConditionInputPriceDirectionEnum}
|
|
337
|
+
* @memberof AlertConditionInput
|
|
338
|
+
*/
|
|
339
|
+
price_direction?: AlertConditionInputPriceDirectionEnum;
|
|
340
|
+
/**
|
|
341
|
+
* When the reminder fires: once at `at`, on the hour, daily or weekly at `time_of_day_minutes`. price_reminder
|
|
342
|
+
* @type {AlertConditionInputFrequencyEnum}
|
|
343
|
+
* @memberof AlertConditionInput
|
|
344
|
+
*/
|
|
345
|
+
frequency?: AlertConditionInputFrequencyEnum;
|
|
346
|
+
/**
|
|
347
|
+
* The instant of a `once` reminder (ISO 8601 date-time with offset, e.g. 2026-12-01T14:30:00Z). price_reminder
|
|
348
|
+
* @type {string}
|
|
349
|
+
* @memberof AlertConditionInput
|
|
350
|
+
*/
|
|
351
|
+
at?: string;
|
|
352
|
+
/**
|
|
353
|
+
* Day of a weekly reminder, 0 = Sunday. price_reminder
|
|
354
|
+
* @type {number}
|
|
355
|
+
* @memberof AlertConditionInput
|
|
356
|
+
*/
|
|
357
|
+
weekday?: number;
|
|
358
|
+
/**
|
|
359
|
+
* Several weekdays (0 = Sunday) of a daily / weekly reminder. price_reminder
|
|
360
|
+
* @type {Array<number>}
|
|
361
|
+
* @memberof AlertConditionInput
|
|
362
|
+
*/
|
|
363
|
+
days?: Array<number>;
|
|
256
364
|
}
|
|
257
365
|
|
|
258
366
|
|
|
@@ -380,6 +488,101 @@ export const AlertConditionInputEventEnum = {
|
|
|
380
488
|
} as const;
|
|
381
489
|
export type AlertConditionInputEventEnum = typeof AlertConditionInputEventEnum[keyof typeof AlertConditionInputEventEnum];
|
|
382
490
|
|
|
491
|
+
/**
|
|
492
|
+
* @export
|
|
493
|
+
*/
|
|
494
|
+
export const AlertConditionInputAssetClassEnum = {
|
|
495
|
+
UsStock: 'us_stock',
|
|
496
|
+
Crypto: 'crypto'
|
|
497
|
+
} as const;
|
|
498
|
+
export type AlertConditionInputAssetClassEnum = typeof AlertConditionInputAssetClassEnum[keyof typeof AlertConditionInputAssetClassEnum];
|
|
499
|
+
|
|
500
|
+
/**
|
|
501
|
+
* @export
|
|
502
|
+
*/
|
|
503
|
+
export const AlertConditionInputOperatorEnum = {
|
|
504
|
+
CrossesAbove: 'crosses_above',
|
|
505
|
+
CrossesBelow: 'crosses_below',
|
|
506
|
+
Crosses: 'crosses',
|
|
507
|
+
Above: 'above',
|
|
508
|
+
Below: 'below'
|
|
509
|
+
} as const;
|
|
510
|
+
export type AlertConditionInputOperatorEnum = typeof AlertConditionInputOperatorEnum[keyof typeof AlertConditionInputOperatorEnum];
|
|
511
|
+
|
|
512
|
+
/**
|
|
513
|
+
* @export
|
|
514
|
+
*/
|
|
515
|
+
export const AlertConditionInputDirectionEnum = {
|
|
516
|
+
Up: 'up',
|
|
517
|
+
Down: 'down',
|
|
518
|
+
Both: 'both'
|
|
519
|
+
} as const;
|
|
520
|
+
export type AlertConditionInputDirectionEnum = typeof AlertConditionInputDirectionEnum[keyof typeof AlertConditionInputDirectionEnum];
|
|
521
|
+
|
|
522
|
+
/**
|
|
523
|
+
* @export
|
|
524
|
+
*/
|
|
525
|
+
export const AlertConditionInputBaselineEnum = {
|
|
526
|
+
PriorClose: 'prior_close',
|
|
527
|
+
IntradayOpen: 'intraday_open',
|
|
528
|
+
SessionHigh: 'session_high',
|
|
529
|
+
SessionLow: 'session_low',
|
|
530
|
+
GapOpen: 'gap_open'
|
|
531
|
+
} as const;
|
|
532
|
+
export type AlertConditionInputBaselineEnum = typeof AlertConditionInputBaselineEnum[keyof typeof AlertConditionInputBaselineEnum];
|
|
533
|
+
|
|
534
|
+
/**
|
|
535
|
+
* @export
|
|
536
|
+
*/
|
|
537
|
+
export const AlertConditionInputModeEnum = {
|
|
538
|
+
Relative: 'relative',
|
|
539
|
+
Absolute: 'absolute',
|
|
540
|
+
Session: 'session'
|
|
541
|
+
} as const;
|
|
542
|
+
export type AlertConditionInputModeEnum = typeof AlertConditionInputModeEnum[keyof typeof AlertConditionInputModeEnum];
|
|
543
|
+
|
|
544
|
+
/**
|
|
545
|
+
* @export
|
|
546
|
+
*/
|
|
547
|
+
export const AlertConditionInputIntervalEnum = {
|
|
548
|
+
_1h: '1h',
|
|
549
|
+
_1d: '1d',
|
|
550
|
+
_1w: '1w',
|
|
551
|
+
_1mo: '1mo'
|
|
552
|
+
} as const;
|
|
553
|
+
export type AlertConditionInputIntervalEnum = typeof AlertConditionInputIntervalEnum[keyof typeof AlertConditionInputIntervalEnum];
|
|
554
|
+
|
|
555
|
+
/**
|
|
556
|
+
* @export
|
|
557
|
+
*/
|
|
558
|
+
export const AlertConditionInputBaselineModeEnum = {
|
|
559
|
+
FlatMean: 'flat_mean',
|
|
560
|
+
RvolSlot: 'rvol_slot',
|
|
561
|
+
Median: 'median'
|
|
562
|
+
} as const;
|
|
563
|
+
export type AlertConditionInputBaselineModeEnum = typeof AlertConditionInputBaselineModeEnum[keyof typeof AlertConditionInputBaselineModeEnum];
|
|
564
|
+
|
|
565
|
+
/**
|
|
566
|
+
* @export
|
|
567
|
+
*/
|
|
568
|
+
export const AlertConditionInputPriceDirectionEnum = {
|
|
569
|
+
Up: 'up',
|
|
570
|
+
Down: 'down',
|
|
571
|
+
Any: 'any'
|
|
572
|
+
} as const;
|
|
573
|
+
export type AlertConditionInputPriceDirectionEnum = typeof AlertConditionInputPriceDirectionEnum[keyof typeof AlertConditionInputPriceDirectionEnum];
|
|
574
|
+
|
|
575
|
+
/**
|
|
576
|
+
* @export
|
|
577
|
+
*/
|
|
578
|
+
export const AlertConditionInputFrequencyEnum = {
|
|
579
|
+
Once: 'once',
|
|
580
|
+
Hourly: 'hourly',
|
|
581
|
+
Daily: 'daily',
|
|
582
|
+
Weekly: 'weekly'
|
|
583
|
+
} as const;
|
|
584
|
+
export type AlertConditionInputFrequencyEnum = typeof AlertConditionInputFrequencyEnum[keyof typeof AlertConditionInputFrequencyEnum];
|
|
585
|
+
|
|
383
586
|
|
|
384
587
|
/**
|
|
385
588
|
* Check if a given object implements the AlertConditionInput interface.
|
|
@@ -431,6 +634,24 @@ export function AlertConditionInputFromJSONTyped(json: any, ignoreDiscriminator:
|
|
|
431
634
|
'time_of_day_minutes': json['time_of_day_minutes'] == null ? undefined : json['time_of_day_minutes'],
|
|
432
635
|
'timezone': json['timezone'] == null ? undefined : json['timezone'],
|
|
433
636
|
'notify_on_date_change': json['notify_on_date_change'] == null ? undefined : json['notify_on_date_change'],
|
|
637
|
+
'asset_class': json['asset_class'] == null ? undefined : json['asset_class'],
|
|
638
|
+
'operator': json['operator'] == null ? undefined : json['operator'],
|
|
639
|
+
'level': json['level'] == null ? undefined : json['level'],
|
|
640
|
+
'direction': json['direction'] == null ? undefined : json['direction'],
|
|
641
|
+
'pct': json['pct'] == null ? undefined : json['pct'],
|
|
642
|
+
'baseline': json['baseline'] == null ? undefined : json['baseline'],
|
|
643
|
+
'window_minutes': json['window_minutes'] == null ? undefined : json['window_minutes'],
|
|
644
|
+
'mode': json['mode'] == null ? undefined : json['mode'],
|
|
645
|
+
'interval': json['interval'] == null ? undefined : json['interval'],
|
|
646
|
+
'multiple': json['multiple'] == null ? undefined : json['multiple'],
|
|
647
|
+
'threshold': json['threshold'] == null ? undefined : json['threshold'],
|
|
648
|
+
'lookback_bars': json['lookback_bars'] == null ? undefined : json['lookback_bars'],
|
|
649
|
+
'baseline_mode': json['baseline_mode'] == null ? undefined : json['baseline_mode'],
|
|
650
|
+
'price_direction': json['price_direction'] == null ? undefined : json['price_direction'],
|
|
651
|
+
'frequency': json['frequency'] == null ? undefined : json['frequency'],
|
|
652
|
+
'at': json['at'] == null ? undefined : json['at'],
|
|
653
|
+
'weekday': json['weekday'] == null ? undefined : json['weekday'],
|
|
654
|
+
'days': json['days'] == null ? undefined : json['days'],
|
|
434
655
|
};
|
|
435
656
|
}
|
|
436
657
|
|
|
@@ -478,6 +699,24 @@ export function AlertConditionInputToJSONTyped(value?: AlertConditionInput | nul
|
|
|
478
699
|
'time_of_day_minutes': value['time_of_day_minutes'],
|
|
479
700
|
'timezone': value['timezone'],
|
|
480
701
|
'notify_on_date_change': value['notify_on_date_change'],
|
|
702
|
+
'asset_class': value['asset_class'],
|
|
703
|
+
'operator': value['operator'],
|
|
704
|
+
'level': value['level'],
|
|
705
|
+
'direction': value['direction'],
|
|
706
|
+
'pct': value['pct'],
|
|
707
|
+
'baseline': value['baseline'],
|
|
708
|
+
'window_minutes': value['window_minutes'],
|
|
709
|
+
'mode': value['mode'],
|
|
710
|
+
'interval': value['interval'],
|
|
711
|
+
'multiple': value['multiple'],
|
|
712
|
+
'threshold': value['threshold'],
|
|
713
|
+
'lookback_bars': value['lookback_bars'],
|
|
714
|
+
'baseline_mode': value['baseline_mode'],
|
|
715
|
+
'price_direction': value['price_direction'],
|
|
716
|
+
'frequency': value['frequency'],
|
|
717
|
+
'at': value['at'],
|
|
718
|
+
'weekday': value['weekday'],
|
|
719
|
+
'days': value['days'],
|
|
481
720
|
};
|
|
482
721
|
}
|
|
483
722
|
|
package/src/models/Company.ts
CHANGED
|
@@ -58,23 +58,23 @@ export interface Company {
|
|
|
58
58
|
*/
|
|
59
59
|
category: string;
|
|
60
60
|
/**
|
|
61
|
-
* Sector, from the issuer's SIC code (SEC mapping)
|
|
61
|
+
* Sector, from the issuer's SIC code (SEC mapping); null for a US ETF (no SIC-derived values are shown for a fund)
|
|
62
62
|
* @type {string}
|
|
63
63
|
* @memberof Company
|
|
64
64
|
*/
|
|
65
|
-
sector: string;
|
|
65
|
+
sector: string | null;
|
|
66
66
|
/**
|
|
67
|
-
* Industry, from the issuer's SIC code (SEC mapping)
|
|
67
|
+
* Industry, from the issuer's SIC code (SEC mapping); null for a US ETF (no SIC-derived values are shown for a fund)
|
|
68
68
|
* @type {string}
|
|
69
69
|
* @memberof Company
|
|
70
70
|
*/
|
|
71
|
-
industry: string;
|
|
71
|
+
industry: string | null;
|
|
72
72
|
/**
|
|
73
|
-
* SIC code
|
|
73
|
+
* SIC code; null for a US ETF (no SIC-derived values are shown for a fund)
|
|
74
74
|
* @type {string}
|
|
75
75
|
* @memberof Company
|
|
76
76
|
*/
|
|
77
|
-
sic: string;
|
|
77
|
+
sic: string | null;
|
|
78
78
|
/**
|
|
79
79
|
* Fama-French sector
|
|
80
80
|
* @type {string}
|
|
@@ -208,13 +208,13 @@ export interface Company {
|
|
|
208
208
|
*/
|
|
209
209
|
street: string | null;
|
|
210
210
|
/**
|
|
211
|
-
* City
|
|
211
|
+
* City; null for a US ETF
|
|
212
212
|
* @type {string}
|
|
213
213
|
* @memberof Company
|
|
214
214
|
*/
|
|
215
215
|
city: string | null;
|
|
216
216
|
/**
|
|
217
|
-
* State or province
|
|
217
|
+
* State or province; null for a US ETF
|
|
218
218
|
* @type {string}
|
|
219
219
|
* @memberof Company
|
|
220
220
|
*/
|
package/src/models/CompanyRef.ts
CHANGED
|
@@ -20,7 +20,7 @@ import { mapValues } from '../runtime';
|
|
|
20
20
|
*/
|
|
21
21
|
export interface CompanyRef {
|
|
22
22
|
/**
|
|
23
|
-
* SEC CIK, 10 digits
|
|
23
|
+
* 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
|
|
24
24
|
* @type {string}
|
|
25
25
|
* @memberof CompanyRef
|
|
26
26
|
*/
|
|
@@ -55,6 +55,18 @@ export interface CreateDestinationRequest {
|
|
|
55
55
|
* @memberof CreateDestinationRequest
|
|
56
56
|
*/
|
|
57
57
|
preset?: CreateDestinationRequestPresetEnum;
|
|
58
|
+
/**
|
|
59
|
+
* 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
|
|
60
|
+
* @type {number}
|
|
61
|
+
* @memberof CreateDestinationRequest
|
|
62
|
+
*/
|
|
63
|
+
max_events_per_minute?: number;
|
|
64
|
+
/**
|
|
65
|
+
* 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)
|
|
66
|
+
* @type {number}
|
|
67
|
+
* @memberof CreateDestinationRequest
|
|
68
|
+
*/
|
|
69
|
+
digest_seconds?: number | null;
|
|
58
70
|
}
|
|
59
71
|
|
|
60
72
|
|
|
@@ -101,6 +113,8 @@ export function CreateDestinationRequestFromJSONTyped(json: any, ignoreDiscrimin
|
|
|
101
113
|
'headers': json['headers'] == null ? undefined : json['headers'],
|
|
102
114
|
'body_template': json['body_template'] == null ? undefined : json['body_template'],
|
|
103
115
|
'preset': json['preset'] == null ? undefined : json['preset'],
|
|
116
|
+
'max_events_per_minute': json['max_events_per_minute'] == null ? undefined : json['max_events_per_minute'],
|
|
117
|
+
'digest_seconds': json['digest_seconds'] == null ? undefined : json['digest_seconds'],
|
|
104
118
|
};
|
|
105
119
|
}
|
|
106
120
|
|
|
@@ -121,6 +135,8 @@ export function CreateDestinationRequestToJSONTyped(value?: CreateDestinationReq
|
|
|
121
135
|
'headers': value['headers'],
|
|
122
136
|
'body_template': value['body_template'],
|
|
123
137
|
'preset': value['preset'],
|
|
138
|
+
'max_events_per_minute': value['max_events_per_minute'],
|
|
139
|
+
'digest_seconds': value['digest_seconds'],
|
|
124
140
|
};
|
|
125
141
|
}
|
|
126
142
|
|
|
@@ -85,6 +85,18 @@ export interface Destination {
|
|
|
85
85
|
* @memberof Destination
|
|
86
86
|
*/
|
|
87
87
|
body_template: string | null;
|
|
88
|
+
/**
|
|
89
|
+
* 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
|
|
90
|
+
* @type {number}
|
|
91
|
+
* @memberof Destination
|
|
92
|
+
*/
|
|
93
|
+
max_events_per_minute: number;
|
|
94
|
+
/**
|
|
95
|
+
* 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
|
|
96
|
+
* @type {number}
|
|
97
|
+
* @memberof Destination
|
|
98
|
+
*/
|
|
99
|
+
digest_seconds: number | null;
|
|
88
100
|
/**
|
|
89
101
|
* The rotated-out secret signs until then
|
|
90
102
|
* @type {Date}
|
|
@@ -149,6 +161,8 @@ export function instanceOfDestination(value: object): value is Destination {
|
|
|
149
161
|
if (!('secret_hint' in value) || value['secret_hint'] === undefined) return false;
|
|
150
162
|
if (!('header_names' in value) || value['header_names'] === undefined) return false;
|
|
151
163
|
if (!('body_template' in value) || value['body_template'] === undefined) return false;
|
|
164
|
+
if (!('max_events_per_minute' in value) || value['max_events_per_minute'] === undefined) return false;
|
|
165
|
+
if (!('digest_seconds' in value) || value['digest_seconds'] === undefined) return false;
|
|
152
166
|
if (!('previous_secret_expires_at' in value) || value['previous_secret_expires_at'] === undefined) return false;
|
|
153
167
|
if (!('created_at' in value) || value['created_at'] === undefined) return false;
|
|
154
168
|
if (!('updated_at' in value) || value['updated_at'] === undefined) return false;
|
|
@@ -176,6 +190,8 @@ export function DestinationFromJSONTyped(json: any, ignoreDiscriminator: boolean
|
|
|
176
190
|
'secret_hint': json['secret_hint'],
|
|
177
191
|
'header_names': json['header_names'],
|
|
178
192
|
'body_template': json['body_template'],
|
|
193
|
+
'max_events_per_minute': json['max_events_per_minute'],
|
|
194
|
+
'digest_seconds': json['digest_seconds'],
|
|
179
195
|
'previous_secret_expires_at': (json['previous_secret_expires_at'] == null ? null : new Date(json['previous_secret_expires_at'])),
|
|
180
196
|
'created_at': (new Date(json['created_at'])),
|
|
181
197
|
'updated_at': (new Date(json['updated_at'])),
|
|
@@ -204,6 +220,8 @@ export function DestinationToJSONTyped(value?: Destination | null, ignoreDiscrim
|
|
|
204
220
|
'secret_hint': value['secret_hint'],
|
|
205
221
|
'header_names': value['header_names'],
|
|
206
222
|
'body_template': value['body_template'],
|
|
223
|
+
'max_events_per_minute': value['max_events_per_minute'],
|
|
224
|
+
'digest_seconds': value['digest_seconds'],
|
|
207
225
|
'previous_secret_expires_at': value['previous_secret_expires_at'] == null ? value['previous_secret_expires_at'] : value['previous_secret_expires_at'].toISOString(),
|
|
208
226
|
'created_at': value['created_at'].toISOString(),
|
|
209
227
|
'updated_at': value['updated_at'].toISOString(),
|
|
@@ -85,6 +85,18 @@ export interface DestinationCreated {
|
|
|
85
85
|
* @memberof DestinationCreated
|
|
86
86
|
*/
|
|
87
87
|
body_template: string | null;
|
|
88
|
+
/**
|
|
89
|
+
* 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
|
|
90
|
+
* @type {number}
|
|
91
|
+
* @memberof DestinationCreated
|
|
92
|
+
*/
|
|
93
|
+
max_events_per_minute: number;
|
|
94
|
+
/**
|
|
95
|
+
* 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
|
|
96
|
+
* @type {number}
|
|
97
|
+
* @memberof DestinationCreated
|
|
98
|
+
*/
|
|
99
|
+
digest_seconds: number | null;
|
|
88
100
|
/**
|
|
89
101
|
* The rotated-out secret signs until then
|
|
90
102
|
* @type {Date}
|
|
@@ -155,6 +167,8 @@ export function instanceOfDestinationCreated(value: object): value is Destinatio
|
|
|
155
167
|
if (!('secret_hint' in value) || value['secret_hint'] === undefined) return false;
|
|
156
168
|
if (!('header_names' in value) || value['header_names'] === undefined) return false;
|
|
157
169
|
if (!('body_template' in value) || value['body_template'] === undefined) return false;
|
|
170
|
+
if (!('max_events_per_minute' in value) || value['max_events_per_minute'] === undefined) return false;
|
|
171
|
+
if (!('digest_seconds' in value) || value['digest_seconds'] === undefined) return false;
|
|
158
172
|
if (!('previous_secret_expires_at' in value) || value['previous_secret_expires_at'] === undefined) return false;
|
|
159
173
|
if (!('created_at' in value) || value['created_at'] === undefined) return false;
|
|
160
174
|
if (!('updated_at' in value) || value['updated_at'] === undefined) return false;
|
|
@@ -183,6 +197,8 @@ export function DestinationCreatedFromJSONTyped(json: any, ignoreDiscriminator:
|
|
|
183
197
|
'secret_hint': json['secret_hint'],
|
|
184
198
|
'header_names': json['header_names'],
|
|
185
199
|
'body_template': json['body_template'],
|
|
200
|
+
'max_events_per_minute': json['max_events_per_minute'],
|
|
201
|
+
'digest_seconds': json['digest_seconds'],
|
|
186
202
|
'previous_secret_expires_at': (json['previous_secret_expires_at'] == null ? null : new Date(json['previous_secret_expires_at'])),
|
|
187
203
|
'created_at': (new Date(json['created_at'])),
|
|
188
204
|
'updated_at': (new Date(json['updated_at'])),
|
|
@@ -212,6 +228,8 @@ export function DestinationCreatedToJSONTyped(value?: DestinationCreated | null,
|
|
|
212
228
|
'secret_hint': value['secret_hint'],
|
|
213
229
|
'header_names': value['header_names'],
|
|
214
230
|
'body_template': value['body_template'],
|
|
231
|
+
'max_events_per_minute': value['max_events_per_minute'],
|
|
232
|
+
'digest_seconds': value['digest_seconds'],
|
|
215
233
|
'previous_secret_expires_at': value['previous_secret_expires_at'] == null ? value['previous_secret_expires_at'] : value['previous_secret_expires_at'].toISOString(),
|
|
216
234
|
'created_at': value['created_at'].toISOString(),
|
|
217
235
|
'updated_at': value['updated_at'].toISOString(),
|
|
@@ -55,6 +55,18 @@ export interface UpdateDestinationRequest {
|
|
|
55
55
|
* @memberof UpdateDestinationRequest
|
|
56
56
|
*/
|
|
57
57
|
preset?: UpdateDestinationRequestPresetEnum;
|
|
58
|
+
/**
|
|
59
|
+
* 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
|
|
60
|
+
* @type {number}
|
|
61
|
+
* @memberof UpdateDestinationRequest
|
|
62
|
+
*/
|
|
63
|
+
max_events_per_minute?: number;
|
|
64
|
+
/**
|
|
65
|
+
* 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
|
|
66
|
+
* @type {number}
|
|
67
|
+
* @memberof UpdateDestinationRequest
|
|
68
|
+
*/
|
|
69
|
+
digest_seconds?: number | null;
|
|
58
70
|
/**
|
|
59
71
|
* active re-enables; disabled pauses it
|
|
60
72
|
* @type {UpdateDestinationRequestStatusEnum}
|
|
@@ -115,6 +127,8 @@ export function UpdateDestinationRequestFromJSONTyped(json: any, ignoreDiscrimin
|
|
|
115
127
|
'headers': json['headers'] == null ? undefined : json['headers'],
|
|
116
128
|
'body_template': json['body_template'] == null ? undefined : json['body_template'],
|
|
117
129
|
'preset': json['preset'] == null ? undefined : json['preset'],
|
|
130
|
+
'max_events_per_minute': json['max_events_per_minute'] == null ? undefined : json['max_events_per_minute'],
|
|
131
|
+
'digest_seconds': json['digest_seconds'] == null ? undefined : json['digest_seconds'],
|
|
118
132
|
'status': json['status'] == null ? undefined : json['status'],
|
|
119
133
|
};
|
|
120
134
|
}
|
|
@@ -136,6 +150,8 @@ export function UpdateDestinationRequestToJSONTyped(value?: UpdateDestinationReq
|
|
|
136
150
|
'headers': value['headers'],
|
|
137
151
|
'body_template': value['body_template'],
|
|
138
152
|
'preset': value['preset'],
|
|
153
|
+
'max_events_per_minute': value['max_events_per_minute'],
|
|
154
|
+
'digest_seconds': value['digest_seconds'],
|
|
139
155
|
'status': value['status'],
|
|
140
156
|
};
|
|
141
157
|
}
|