@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
|
@@ -53,6 +53,18 @@ export interface UpdateDestinationRequest {
|
|
|
53
53
|
* @memberof UpdateDestinationRequest
|
|
54
54
|
*/
|
|
55
55
|
preset?: UpdateDestinationRequestPresetEnum;
|
|
56
|
+
/**
|
|
57
|
+
* Events per minute this destination receives at most (a token bucket across all delivery machines); events over it stay queued and go out as the bucket refills, never dropped
|
|
58
|
+
* @type {number}
|
|
59
|
+
* @memberof UpdateDestinationRequest
|
|
60
|
+
*/
|
|
61
|
+
max_events_per_minute?: number;
|
|
62
|
+
/**
|
|
63
|
+
* Digest window: new events are held until the oldest is this many seconds old, then go out together as ONE alert.fired.batch (≤ 500 events / 1 MB per request); retries are not held. Not with preset claude_routine; null turns it off
|
|
64
|
+
* @type {number}
|
|
65
|
+
* @memberof UpdateDestinationRequest
|
|
66
|
+
*/
|
|
67
|
+
digest_seconds?: number | null;
|
|
56
68
|
/**
|
|
57
69
|
* active re-enables; disabled pauses it
|
|
58
70
|
* @type {UpdateDestinationRequestStatusEnum}
|
|
@@ -60,6 +60,8 @@ function UpdateDestinationRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
60
60
|
'headers': json['headers'] == null ? undefined : json['headers'],
|
|
61
61
|
'body_template': json['body_template'] == null ? undefined : json['body_template'],
|
|
62
62
|
'preset': json['preset'] == null ? undefined : json['preset'],
|
|
63
|
+
'max_events_per_minute': json['max_events_per_minute'] == null ? undefined : json['max_events_per_minute'],
|
|
64
|
+
'digest_seconds': json['digest_seconds'] == null ? undefined : json['digest_seconds'],
|
|
63
65
|
'status': json['status'] == null ? undefined : json['status'],
|
|
64
66
|
};
|
|
65
67
|
}
|
|
@@ -77,6 +79,8 @@ function UpdateDestinationRequestToJSONTyped(value, ignoreDiscriminator = false)
|
|
|
77
79
|
'headers': value['headers'],
|
|
78
80
|
'body_template': value['body_template'],
|
|
79
81
|
'preset': value['preset'],
|
|
82
|
+
'max_events_per_minute': value['max_events_per_minute'],
|
|
83
|
+
'digest_seconds': value['digest_seconds'],
|
|
80
84
|
'status': value['status'],
|
|
81
85
|
};
|
|
82
86
|
}
|
package/docs/AlertCondition.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
|
|
2
2
|
# AlertCondition
|
|
3
3
|
|
|
4
|
-
What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls.
|
|
4
|
+
What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Price types (`price`, `price_move`, `volume_spike`, `price_reminder`) watch ONE instrument: `symbol` + `asset_class`. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls.
|
|
5
5
|
|
|
6
6
|
## Properties
|
|
7
7
|
|
|
@@ -40,6 +40,24 @@ Name | Type
|
|
|
40
40
|
`time_of_day_minutes` | number
|
|
41
41
|
`timezone` | string
|
|
42
42
|
`notify_on_date_change` | boolean
|
|
43
|
+
`asset_class` | string
|
|
44
|
+
`operator` | string
|
|
45
|
+
`level` | number
|
|
46
|
+
`direction` | string
|
|
47
|
+
`pct` | number
|
|
48
|
+
`baseline` | string
|
|
49
|
+
`window_minutes` | number
|
|
50
|
+
`mode` | string
|
|
51
|
+
`interval` | string
|
|
52
|
+
`multiple` | number
|
|
53
|
+
`threshold` | number
|
|
54
|
+
`lookback_bars` | number
|
|
55
|
+
`baseline_mode` | string
|
|
56
|
+
`price_direction` | string
|
|
57
|
+
`frequency` | string
|
|
58
|
+
`at` | Date
|
|
59
|
+
`weekday` | number
|
|
60
|
+
`days` | Array<number>
|
|
43
61
|
|
|
44
62
|
## Example
|
|
45
63
|
|
|
@@ -81,6 +99,24 @@ const example = {
|
|
|
81
99
|
"time_of_day_minutes": null,
|
|
82
100
|
"timezone": null,
|
|
83
101
|
"notify_on_date_change": null,
|
|
102
|
+
"asset_class": null,
|
|
103
|
+
"operator": null,
|
|
104
|
+
"level": null,
|
|
105
|
+
"direction": null,
|
|
106
|
+
"pct": null,
|
|
107
|
+
"baseline": null,
|
|
108
|
+
"window_minutes": null,
|
|
109
|
+
"mode": null,
|
|
110
|
+
"interval": null,
|
|
111
|
+
"multiple": null,
|
|
112
|
+
"threshold": null,
|
|
113
|
+
"lookback_bars": null,
|
|
114
|
+
"baseline_mode": null,
|
|
115
|
+
"price_direction": null,
|
|
116
|
+
"frequency": null,
|
|
117
|
+
"at": null,
|
|
118
|
+
"weekday": null,
|
|
119
|
+
"days": null,
|
|
84
120
|
} satisfies AlertCondition
|
|
85
121
|
|
|
86
122
|
console.log(example)
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
|
|
2
2
|
# AlertConditionInput
|
|
3
3
|
|
|
4
|
-
What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls. (request form)
|
|
4
|
+
What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Price types (`price`, `price_move`, `volume_spike`, `price_reminder`) watch ONE instrument: `symbol` + `asset_class`. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls. (request form)
|
|
5
5
|
|
|
6
6
|
## Properties
|
|
7
7
|
|
|
@@ -40,6 +40,24 @@ Name | Type
|
|
|
40
40
|
`time_of_day_minutes` | number
|
|
41
41
|
`timezone` | string
|
|
42
42
|
`notify_on_date_change` | boolean
|
|
43
|
+
`asset_class` | string
|
|
44
|
+
`operator` | string
|
|
45
|
+
`level` | number
|
|
46
|
+
`direction` | string
|
|
47
|
+
`pct` | number
|
|
48
|
+
`baseline` | string
|
|
49
|
+
`window_minutes` | number
|
|
50
|
+
`mode` | string
|
|
51
|
+
`interval` | string
|
|
52
|
+
`multiple` | number
|
|
53
|
+
`threshold` | number
|
|
54
|
+
`lookback_bars` | number
|
|
55
|
+
`baseline_mode` | string
|
|
56
|
+
`price_direction` | string
|
|
57
|
+
`frequency` | string
|
|
58
|
+
`at` | string
|
|
59
|
+
`weekday` | number
|
|
60
|
+
`days` | Array<number>
|
|
43
61
|
|
|
44
62
|
## Example
|
|
45
63
|
|
|
@@ -81,6 +99,24 @@ const example = {
|
|
|
81
99
|
"time_of_day_minutes": null,
|
|
82
100
|
"timezone": null,
|
|
83
101
|
"notify_on_date_change": null,
|
|
102
|
+
"asset_class": null,
|
|
103
|
+
"operator": null,
|
|
104
|
+
"level": null,
|
|
105
|
+
"direction": null,
|
|
106
|
+
"pct": null,
|
|
107
|
+
"baseline": null,
|
|
108
|
+
"window_minutes": null,
|
|
109
|
+
"mode": null,
|
|
110
|
+
"interval": null,
|
|
111
|
+
"multiple": null,
|
|
112
|
+
"threshold": null,
|
|
113
|
+
"lookback_bars": null,
|
|
114
|
+
"baseline_mode": null,
|
|
115
|
+
"price_direction": null,
|
|
116
|
+
"frequency": null,
|
|
117
|
+
"at": null,
|
|
118
|
+
"weekday": null,
|
|
119
|
+
"days": null,
|
|
84
120
|
} satisfies AlertConditionInput
|
|
85
121
|
|
|
86
122
|
console.log(example)
|
|
@@ -12,6 +12,8 @@ Name | Type
|
|
|
12
12
|
`headers` | { [key: string]: string; }
|
|
13
13
|
`body_template` | string
|
|
14
14
|
`preset` | string
|
|
15
|
+
`max_events_per_minute` | number
|
|
16
|
+
`digest_seconds` | number
|
|
15
17
|
|
|
16
18
|
## Example
|
|
17
19
|
|
|
@@ -26,6 +28,8 @@ const example = {
|
|
|
26
28
|
"headers": null,
|
|
27
29
|
"body_template": null,
|
|
28
30
|
"preset": null,
|
|
31
|
+
"max_events_per_minute": null,
|
|
32
|
+
"digest_seconds": null,
|
|
29
33
|
} satisfies CreateDestinationRequest
|
|
30
34
|
|
|
31
35
|
console.log(example)
|
package/docs/Destination.md
CHANGED
|
@@ -17,6 +17,8 @@ Name | Type
|
|
|
17
17
|
`secret_hint` | string
|
|
18
18
|
`header_names` | Array<string>
|
|
19
19
|
`body_template` | string
|
|
20
|
+
`max_events_per_minute` | number
|
|
21
|
+
`digest_seconds` | number
|
|
20
22
|
`previous_secret_expires_at` | Date
|
|
21
23
|
`created_at` | Date
|
|
22
24
|
`updated_at` | Date
|
|
@@ -39,6 +41,8 @@ const example = {
|
|
|
39
41
|
"secret_hint": null,
|
|
40
42
|
"header_names": null,
|
|
41
43
|
"body_template": null,
|
|
44
|
+
"max_events_per_minute": null,
|
|
45
|
+
"digest_seconds": null,
|
|
42
46
|
"previous_secret_expires_at": null,
|
|
43
47
|
"created_at": null,
|
|
44
48
|
"updated_at": null,
|
|
@@ -18,6 +18,8 @@ Name | Type
|
|
|
18
18
|
`secret_hint` | string
|
|
19
19
|
`header_names` | Array<string>
|
|
20
20
|
`body_template` | string
|
|
21
|
+
`max_events_per_minute` | number
|
|
22
|
+
`digest_seconds` | number
|
|
21
23
|
`previous_secret_expires_at` | Date
|
|
22
24
|
`created_at` | Date
|
|
23
25
|
`updated_at` | Date
|
|
@@ -41,6 +43,8 @@ const example = {
|
|
|
41
43
|
"secret_hint": null,
|
|
42
44
|
"header_names": null,
|
|
43
45
|
"body_template": null,
|
|
46
|
+
"max_events_per_minute": null,
|
|
47
|
+
"digest_seconds": null,
|
|
44
48
|
"previous_secret_expires_at": null,
|
|
45
49
|
"created_at": null,
|
|
46
50
|
"updated_at": null,
|
|
@@ -13,6 +13,8 @@ Name | Type
|
|
|
13
13
|
`headers` | { [key: string]: string; }
|
|
14
14
|
`body_template` | string
|
|
15
15
|
`preset` | string
|
|
16
|
+
`max_events_per_minute` | number
|
|
17
|
+
`digest_seconds` | number
|
|
16
18
|
`status` | string
|
|
17
19
|
|
|
18
20
|
## Example
|
|
@@ -28,6 +30,8 @@ const example = {
|
|
|
28
30
|
"headers": null,
|
|
29
31
|
"body_template": null,
|
|
30
32
|
"preset": null,
|
|
33
|
+
"max_events_per_minute": null,
|
|
34
|
+
"digest_seconds": null,
|
|
31
35
|
"status": null,
|
|
32
36
|
} satisfies UpdateDestinationRequest
|
|
33
37
|
|
package/package.json
CHANGED
|
@@ -50,7 +50,7 @@ import {
|
|
|
50
50
|
} from './AlertConditionYoyRulesInner';
|
|
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.
|
|
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.
|
|
54
54
|
* @export
|
|
55
55
|
* @interface AlertCondition
|
|
56
56
|
*/
|
|
@@ -74,7 +74,7 @@ export interface AlertCondition {
|
|
|
74
74
|
*/
|
|
75
75
|
cik?: string;
|
|
76
76
|
/**
|
|
77
|
-
* The company by ticker. Same types as `cik
|
|
77
|
+
* The company 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 AlertCondition
|
|
80
80
|
*/
|
|
@@ -236,13 +236,13 @@ export interface AlertCondition {
|
|
|
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 AlertCondition
|
|
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 AlertCondition
|
|
248
248
|
*/
|
|
@@ -253,6 +253,114 @@ export interface AlertCondition {
|
|
|
253
253
|
* @memberof AlertCondition
|
|
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 {AlertConditionAssetClassEnum}
|
|
259
|
+
* @memberof AlertCondition
|
|
260
|
+
*/
|
|
261
|
+
asset_class?: AlertConditionAssetClassEnum;
|
|
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 {AlertConditionOperatorEnum}
|
|
265
|
+
* @memberof AlertCondition
|
|
266
|
+
*/
|
|
267
|
+
operator?: AlertConditionOperatorEnum;
|
|
268
|
+
/**
|
|
269
|
+
* The price level (> 0). price
|
|
270
|
+
* @type {number}
|
|
271
|
+
* @memberof AlertCondition
|
|
272
|
+
*/
|
|
273
|
+
level?: number;
|
|
274
|
+
/**
|
|
275
|
+
* Which move fires. price_move
|
|
276
|
+
* @type {AlertConditionDirectionEnum}
|
|
277
|
+
* @memberof AlertCondition
|
|
278
|
+
*/
|
|
279
|
+
direction?: AlertConditionDirectionEnum;
|
|
280
|
+
/**
|
|
281
|
+
* The move in percent of the baseline. price_move
|
|
282
|
+
* @type {number}
|
|
283
|
+
* @memberof AlertCondition
|
|
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 {AlertConditionBaselineEnum}
|
|
289
|
+
* @memberof AlertCondition
|
|
290
|
+
*/
|
|
291
|
+
baseline?: AlertConditionBaselineEnum;
|
|
292
|
+
/**
|
|
293
|
+
* Measure the move against the price this many minutes ago instead of the baseline. price_move
|
|
294
|
+
* @type {number}
|
|
295
|
+
* @memberof AlertCondition
|
|
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 {AlertConditionModeEnum}
|
|
301
|
+
* @memberof AlertCondition
|
|
302
|
+
*/
|
|
303
|
+
mode?: AlertConditionModeEnum;
|
|
304
|
+
/**
|
|
305
|
+
* The bar evaluated at its close (relative / absolute). volume_spike
|
|
306
|
+
* @type {AlertConditionIntervalEnum}
|
|
307
|
+
* @memberof AlertCondition
|
|
308
|
+
*/
|
|
309
|
+
interval?: AlertConditionIntervalEnum;
|
|
310
|
+
/**
|
|
311
|
+
* Volume multiple of the baseline (relative / session). volume_spike
|
|
312
|
+
* @type {number}
|
|
313
|
+
* @memberof AlertCondition
|
|
314
|
+
*/
|
|
315
|
+
multiple?: number;
|
|
316
|
+
/**
|
|
317
|
+
* Bar volume threshold, > 0 (absolute). volume_spike
|
|
318
|
+
* @type {number}
|
|
319
|
+
* @memberof AlertCondition
|
|
320
|
+
*/
|
|
321
|
+
threshold?: number;
|
|
322
|
+
/**
|
|
323
|
+
* Bars in the baseline, 5–200 (rvol_slot: sessions, 2–20). volume_spike
|
|
324
|
+
* @type {number}
|
|
325
|
+
* @memberof AlertCondition
|
|
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 {AlertConditionBaselineModeEnum}
|
|
331
|
+
* @memberof AlertCondition
|
|
332
|
+
*/
|
|
333
|
+
baseline_mode?: AlertConditionBaselineModeEnum;
|
|
334
|
+
/**
|
|
335
|
+
* Only bars that closed up / down (default any). volume_spike
|
|
336
|
+
* @type {AlertConditionPriceDirectionEnum}
|
|
337
|
+
* @memberof AlertCondition
|
|
338
|
+
*/
|
|
339
|
+
price_direction?: AlertConditionPriceDirectionEnum;
|
|
340
|
+
/**
|
|
341
|
+
* When the reminder fires: once at `at`, on the hour, daily or weekly at `time_of_day_minutes`. price_reminder
|
|
342
|
+
* @type {AlertConditionFrequencyEnum}
|
|
343
|
+
* @memberof AlertCondition
|
|
344
|
+
*/
|
|
345
|
+
frequency?: AlertConditionFrequencyEnum;
|
|
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 {Date}
|
|
349
|
+
* @memberof AlertCondition
|
|
350
|
+
*/
|
|
351
|
+
at?: Date;
|
|
352
|
+
/**
|
|
353
|
+
* Day of a weekly reminder, 0 = Sunday. price_reminder
|
|
354
|
+
* @type {number}
|
|
355
|
+
* @memberof AlertCondition
|
|
356
|
+
*/
|
|
357
|
+
weekday?: number;
|
|
358
|
+
/**
|
|
359
|
+
* Several weekdays (0 = Sunday) of a daily / weekly reminder. price_reminder
|
|
360
|
+
* @type {Array<number>}
|
|
361
|
+
* @memberof AlertCondition
|
|
362
|
+
*/
|
|
363
|
+
days?: Array<number>;
|
|
256
364
|
}
|
|
257
365
|
|
|
258
366
|
|
|
@@ -380,6 +488,101 @@ export const AlertConditionEventEnum = {
|
|
|
380
488
|
} as const;
|
|
381
489
|
export type AlertConditionEventEnum = typeof AlertConditionEventEnum[keyof typeof AlertConditionEventEnum] | (string & {});
|
|
382
490
|
|
|
491
|
+
/**
|
|
492
|
+
* @export
|
|
493
|
+
*/
|
|
494
|
+
export const AlertConditionAssetClassEnum = {
|
|
495
|
+
UsStock: 'us_stock',
|
|
496
|
+
Crypto: 'crypto'
|
|
497
|
+
} as const;
|
|
498
|
+
export type AlertConditionAssetClassEnum = typeof AlertConditionAssetClassEnum[keyof typeof AlertConditionAssetClassEnum] | (string & {});
|
|
499
|
+
|
|
500
|
+
/**
|
|
501
|
+
* @export
|
|
502
|
+
*/
|
|
503
|
+
export const AlertConditionOperatorEnum = {
|
|
504
|
+
CrossesAbove: 'crosses_above',
|
|
505
|
+
CrossesBelow: 'crosses_below',
|
|
506
|
+
Crosses: 'crosses',
|
|
507
|
+
Above: 'above',
|
|
508
|
+
Below: 'below'
|
|
509
|
+
} as const;
|
|
510
|
+
export type AlertConditionOperatorEnum = typeof AlertConditionOperatorEnum[keyof typeof AlertConditionOperatorEnum] | (string & {});
|
|
511
|
+
|
|
512
|
+
/**
|
|
513
|
+
* @export
|
|
514
|
+
*/
|
|
515
|
+
export const AlertConditionDirectionEnum = {
|
|
516
|
+
Up: 'up',
|
|
517
|
+
Down: 'down',
|
|
518
|
+
Both: 'both'
|
|
519
|
+
} as const;
|
|
520
|
+
export type AlertConditionDirectionEnum = typeof AlertConditionDirectionEnum[keyof typeof AlertConditionDirectionEnum] | (string & {});
|
|
521
|
+
|
|
522
|
+
/**
|
|
523
|
+
* @export
|
|
524
|
+
*/
|
|
525
|
+
export const AlertConditionBaselineEnum = {
|
|
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 AlertConditionBaselineEnum = typeof AlertConditionBaselineEnum[keyof typeof AlertConditionBaselineEnum] | (string & {});
|
|
533
|
+
|
|
534
|
+
/**
|
|
535
|
+
* @export
|
|
536
|
+
*/
|
|
537
|
+
export const AlertConditionModeEnum = {
|
|
538
|
+
Relative: 'relative',
|
|
539
|
+
Absolute: 'absolute',
|
|
540
|
+
Session: 'session'
|
|
541
|
+
} as const;
|
|
542
|
+
export type AlertConditionModeEnum = typeof AlertConditionModeEnum[keyof typeof AlertConditionModeEnum] | (string & {});
|
|
543
|
+
|
|
544
|
+
/**
|
|
545
|
+
* @export
|
|
546
|
+
*/
|
|
547
|
+
export const AlertConditionIntervalEnum = {
|
|
548
|
+
_1h: '1h',
|
|
549
|
+
_1d: '1d',
|
|
550
|
+
_1w: '1w',
|
|
551
|
+
_1mo: '1mo'
|
|
552
|
+
} as const;
|
|
553
|
+
export type AlertConditionIntervalEnum = typeof AlertConditionIntervalEnum[keyof typeof AlertConditionIntervalEnum] | (string & {});
|
|
554
|
+
|
|
555
|
+
/**
|
|
556
|
+
* @export
|
|
557
|
+
*/
|
|
558
|
+
export const AlertConditionBaselineModeEnum = {
|
|
559
|
+
FlatMean: 'flat_mean',
|
|
560
|
+
RvolSlot: 'rvol_slot',
|
|
561
|
+
Median: 'median'
|
|
562
|
+
} as const;
|
|
563
|
+
export type AlertConditionBaselineModeEnum = typeof AlertConditionBaselineModeEnum[keyof typeof AlertConditionBaselineModeEnum] | (string & {});
|
|
564
|
+
|
|
565
|
+
/**
|
|
566
|
+
* @export
|
|
567
|
+
*/
|
|
568
|
+
export const AlertConditionPriceDirectionEnum = {
|
|
569
|
+
Up: 'up',
|
|
570
|
+
Down: 'down',
|
|
571
|
+
Any: 'any'
|
|
572
|
+
} as const;
|
|
573
|
+
export type AlertConditionPriceDirectionEnum = typeof AlertConditionPriceDirectionEnum[keyof typeof AlertConditionPriceDirectionEnum] | (string & {});
|
|
574
|
+
|
|
575
|
+
/**
|
|
576
|
+
* @export
|
|
577
|
+
*/
|
|
578
|
+
export const AlertConditionFrequencyEnum = {
|
|
579
|
+
Once: 'once',
|
|
580
|
+
Hourly: 'hourly',
|
|
581
|
+
Daily: 'daily',
|
|
582
|
+
Weekly: 'weekly'
|
|
583
|
+
} as const;
|
|
584
|
+
export type AlertConditionFrequencyEnum = typeof AlertConditionFrequencyEnum[keyof typeof AlertConditionFrequencyEnum] | (string & {});
|
|
585
|
+
|
|
383
586
|
|
|
384
587
|
/**
|
|
385
588
|
* Check if a given object implements the AlertCondition interface.
|
|
@@ -431,6 +634,24 @@ export function AlertConditionFromJSONTyped(json: any, ignoreDiscriminator: bool
|
|
|
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 : (new Date(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 AlertConditionToJSONTyped(value?: AlertCondition | null, ignoreD
|
|
|
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'] == null ? value['at'] : value['at'].toISOString(),
|
|
718
|
+
'weekday': value['weekday'],
|
|
719
|
+
'days': value['days'],
|
|
481
720
|
};
|
|
482
721
|
}
|
|
483
722
|
|