@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.
Files changed (69) hide show
  1. package/dist/apis/FilingsApi.d.ts +2 -2
  2. package/dist/apis/FilingsApi.js +2 -2
  3. package/dist/apis/ReferenceApi.d.ts +4 -4
  4. package/dist/apis/ReferenceApi.js +4 -4
  5. package/dist/esm/apis/FilingsApi.d.ts +2 -2
  6. package/dist/esm/apis/FilingsApi.js +2 -2
  7. package/dist/esm/apis/ReferenceApi.d.ts +4 -4
  8. package/dist/esm/apis/ReferenceApi.js +4 -4
  9. package/dist/esm/models/AlertCondition.d.ts +199 -5
  10. package/dist/esm/models/AlertCondition.js +113 -0
  11. package/dist/esm/models/AlertConditionInput.d.ts +199 -5
  12. package/dist/esm/models/AlertConditionInput.js +113 -0
  13. package/dist/esm/models/Company.d.ts +8 -8
  14. package/dist/esm/models/CompanyListItem.d.ts +1 -1
  15. package/dist/esm/models/CompanyRef.d.ts +1 -1
  16. package/dist/esm/models/CreateDestinationRequest.d.ts +12 -0
  17. package/dist/esm/models/CreateDestinationRequest.js +4 -0
  18. package/dist/esm/models/Destination.d.ts +12 -0
  19. package/dist/esm/models/Destination.js +8 -0
  20. package/dist/esm/models/DestinationCreated.d.ts +12 -0
  21. package/dist/esm/models/DestinationCreated.js +8 -0
  22. package/dist/esm/models/UpdateDestinationRequest.d.ts +12 -0
  23. package/dist/esm/models/UpdateDestinationRequest.js +4 -0
  24. package/dist/models/AlertCondition.d.ts +199 -5
  25. package/dist/models/AlertCondition.js +114 -1
  26. package/dist/models/AlertConditionInput.d.ts +199 -5
  27. package/dist/models/AlertConditionInput.js +114 -1
  28. package/dist/models/Company.d.ts +8 -8
  29. package/dist/models/CompanyListItem.d.ts +1 -1
  30. package/dist/models/CompanyRef.d.ts +1 -1
  31. package/dist/models/CreateDestinationRequest.d.ts +12 -0
  32. package/dist/models/CreateDestinationRequest.js +4 -0
  33. package/dist/models/Destination.d.ts +12 -0
  34. package/dist/models/Destination.js +8 -0
  35. package/dist/models/DestinationCreated.d.ts +12 -0
  36. package/dist/models/DestinationCreated.js +8 -0
  37. package/dist/models/UpdateDestinationRequest.d.ts +12 -0
  38. package/dist/models/UpdateDestinationRequest.js +4 -0
  39. package/docs/AlertCondition.md +37 -1
  40. package/docs/AlertConditionInput.md +37 -1
  41. package/docs/CompaniesApi.md +2 -2
  42. package/docs/CreateDestinationRequest.md +4 -0
  43. package/docs/Destination.md +4 -0
  44. package/docs/DestinationCreated.md +4 -0
  45. package/docs/EventsApi.md +2 -2
  46. package/docs/FilingsApi.md +5 -5
  47. package/docs/FinancialsApi.md +12 -12
  48. package/docs/GuidanceApi.md +4 -4
  49. package/docs/HoldingsApi.md +6 -6
  50. package/docs/IPOsApi.md +2 -2
  51. package/docs/InsiderTradesApi.md +2 -2
  52. package/docs/InvestorDocumentsApi.md +4 -4
  53. package/docs/MetricsApi.md +10 -10
  54. package/docs/NewsApi.md +6 -6
  55. package/docs/ReferenceApi.md +8 -8
  56. package/docs/TranscriptsApi.md +2 -2
  57. package/docs/UpdateDestinationRequest.md +4 -0
  58. package/package.json +1 -1
  59. package/src/apis/FilingsApi.ts +2 -2
  60. package/src/apis/ReferenceApi.ts +4 -4
  61. package/src/models/AlertCondition.ts +244 -5
  62. package/src/models/AlertConditionInput.ts +244 -5
  63. package/src/models/Company.ts +8 -8
  64. package/src/models/CompanyListItem.ts +1 -1
  65. package/src/models/CompanyRef.ts +1 -1
  66. package/src/models/CreateDestinationRequest.ts +16 -0
  67. package/src/models/Destination.ts +18 -0
  68. package/src/models/DestinationCreated.ts +18 -0
  69. package/src/models/UpdateDestinationRequest.ts +16 -0
@@ -15,7 +15,7 @@ import type { AlertConditionRulesInner } from './AlertConditionRulesInner';
15
15
  import type { AlertConditionYieldRule } from './AlertConditionYieldRule';
16
16
  import type { AlertConditionYoyRulesInner } from './AlertConditionYoyRulesInner';
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.
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. 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 AlertCondition
21
21
  */
@@ -27,7 +27,7 @@ export interface AlertCondition {
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 AlertCondition
33
33
  */
@@ -39,7 +39,7 @@ export interface AlertCondition {
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 AlertCondition
45
45
  */
@@ -201,13 +201,13 @@ export interface AlertCondition {
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 AlertCondition
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 AlertCondition
213
213
  */
@@ -218,6 +218,114 @@ export interface AlertCondition {
218
218
  * @memberof AlertCondition
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 {AlertConditionAssetClassEnum}
224
+ * @memberof AlertCondition
225
+ */
226
+ asset_class?: AlertConditionAssetClassEnum;
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 {AlertConditionOperatorEnum}
230
+ * @memberof AlertCondition
231
+ */
232
+ operator?: AlertConditionOperatorEnum;
233
+ /**
234
+ * The price level (> 0). price
235
+ * @type {number}
236
+ * @memberof AlertCondition
237
+ */
238
+ level?: number;
239
+ /**
240
+ * Which move fires. price_move
241
+ * @type {AlertConditionDirectionEnum}
242
+ * @memberof AlertCondition
243
+ */
244
+ direction?: AlertConditionDirectionEnum;
245
+ /**
246
+ * The move in percent of the baseline. price_move
247
+ * @type {number}
248
+ * @memberof AlertCondition
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 {AlertConditionBaselineEnum}
254
+ * @memberof AlertCondition
255
+ */
256
+ baseline?: AlertConditionBaselineEnum;
257
+ /**
258
+ * Measure the move against the price this many minutes ago instead of the baseline. price_move
259
+ * @type {number}
260
+ * @memberof AlertCondition
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 {AlertConditionModeEnum}
266
+ * @memberof AlertCondition
267
+ */
268
+ mode?: AlertConditionModeEnum;
269
+ /**
270
+ * The bar evaluated at its close (relative / absolute). volume_spike
271
+ * @type {AlertConditionIntervalEnum}
272
+ * @memberof AlertCondition
273
+ */
274
+ interval?: AlertConditionIntervalEnum;
275
+ /**
276
+ * Volume multiple of the baseline (relative / session). volume_spike
277
+ * @type {number}
278
+ * @memberof AlertCondition
279
+ */
280
+ multiple?: number;
281
+ /**
282
+ * Bar volume threshold, > 0 (absolute). volume_spike
283
+ * @type {number}
284
+ * @memberof AlertCondition
285
+ */
286
+ threshold?: number;
287
+ /**
288
+ * Bars in the baseline, 5–200 (rvol_slot: sessions, 2–20). volume_spike
289
+ * @type {number}
290
+ * @memberof AlertCondition
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 {AlertConditionBaselineModeEnum}
296
+ * @memberof AlertCondition
297
+ */
298
+ baseline_mode?: AlertConditionBaselineModeEnum;
299
+ /**
300
+ * Only bars that closed up / down (default any). volume_spike
301
+ * @type {AlertConditionPriceDirectionEnum}
302
+ * @memberof AlertCondition
303
+ */
304
+ price_direction?: AlertConditionPriceDirectionEnum;
305
+ /**
306
+ * When the reminder fires: once at `at`, on the hour, daily or weekly at `time_of_day_minutes`. price_reminder
307
+ * @type {AlertConditionFrequencyEnum}
308
+ * @memberof AlertCondition
309
+ */
310
+ frequency?: AlertConditionFrequencyEnum;
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 {Date}
314
+ * @memberof AlertCondition
315
+ */
316
+ at?: Date;
317
+ /**
318
+ * Day of a weekly reminder, 0 = Sunday. price_reminder
319
+ * @type {number}
320
+ * @memberof AlertCondition
321
+ */
322
+ weekday?: number;
323
+ /**
324
+ * Several weekdays (0 = Sunday) of a daily / weekly reminder. price_reminder
325
+ * @type {Array<number>}
326
+ * @memberof AlertCondition
327
+ */
328
+ days?: Array<number>;
221
329
  }
222
330
  /**
223
331
  * @export
@@ -333,6 +441,92 @@ export declare const AlertConditionEventEnum: {
333
441
  readonly DividendPayment: "dividend_payment";
334
442
  };
335
443
  export type AlertConditionEventEnum = typeof AlertConditionEventEnum[keyof typeof AlertConditionEventEnum] | (string & {});
444
+ /**
445
+ * @export
446
+ */
447
+ export declare const AlertConditionAssetClassEnum: {
448
+ readonly UsStock: "us_stock";
449
+ readonly Crypto: "crypto";
450
+ };
451
+ export type AlertConditionAssetClassEnum = typeof AlertConditionAssetClassEnum[keyof typeof AlertConditionAssetClassEnum] | (string & {});
452
+ /**
453
+ * @export
454
+ */
455
+ export declare const AlertConditionOperatorEnum: {
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 AlertConditionOperatorEnum = typeof AlertConditionOperatorEnum[keyof typeof AlertConditionOperatorEnum] | (string & {});
463
+ /**
464
+ * @export
465
+ */
466
+ export declare const AlertConditionDirectionEnum: {
467
+ readonly Up: "up";
468
+ readonly Down: "down";
469
+ readonly Both: "both";
470
+ };
471
+ export type AlertConditionDirectionEnum = typeof AlertConditionDirectionEnum[keyof typeof AlertConditionDirectionEnum] | (string & {});
472
+ /**
473
+ * @export
474
+ */
475
+ export declare const AlertConditionBaselineEnum: {
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 AlertConditionBaselineEnum = typeof AlertConditionBaselineEnum[keyof typeof AlertConditionBaselineEnum] | (string & {});
483
+ /**
484
+ * @export
485
+ */
486
+ export declare const AlertConditionModeEnum: {
487
+ readonly Relative: "relative";
488
+ readonly Absolute: "absolute";
489
+ readonly Session: "session";
490
+ };
491
+ export type AlertConditionModeEnum = typeof AlertConditionModeEnum[keyof typeof AlertConditionModeEnum] | (string & {});
492
+ /**
493
+ * @export
494
+ */
495
+ export declare const AlertConditionIntervalEnum: {
496
+ readonly _1h: "1h";
497
+ readonly _1d: "1d";
498
+ readonly _1w: "1w";
499
+ readonly _1mo: "1mo";
500
+ };
501
+ export type AlertConditionIntervalEnum = typeof AlertConditionIntervalEnum[keyof typeof AlertConditionIntervalEnum] | (string & {});
502
+ /**
503
+ * @export
504
+ */
505
+ export declare const AlertConditionBaselineModeEnum: {
506
+ readonly FlatMean: "flat_mean";
507
+ readonly RvolSlot: "rvol_slot";
508
+ readonly Median: "median";
509
+ };
510
+ export type AlertConditionBaselineModeEnum = typeof AlertConditionBaselineModeEnum[keyof typeof AlertConditionBaselineModeEnum] | (string & {});
511
+ /**
512
+ * @export
513
+ */
514
+ export declare const AlertConditionPriceDirectionEnum: {
515
+ readonly Up: "up";
516
+ readonly Down: "down";
517
+ readonly Any: "any";
518
+ };
519
+ export type AlertConditionPriceDirectionEnum = typeof AlertConditionPriceDirectionEnum[keyof typeof AlertConditionPriceDirectionEnum] | (string & {});
520
+ /**
521
+ * @export
522
+ */
523
+ export declare const AlertConditionFrequencyEnum: {
524
+ readonly Once: "once";
525
+ readonly Hourly: "hourly";
526
+ readonly Daily: "daily";
527
+ readonly Weekly: "weekly";
528
+ };
529
+ export type AlertConditionFrequencyEnum = typeof AlertConditionFrequencyEnum[keyof typeof AlertConditionFrequencyEnum] | (string & {});
336
530
  /**
337
531
  * Check if a given object implements the AlertCondition interface.
338
532
  */
@@ -13,7 +13,7 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.AlertConditionEventEnum = exports.AlertConditionReportKindsEnum = exports.AlertConditionStatusesEnum = exports.AlertConditionSpeakerRolesEnum = exports.AlertConditionEventsEnum = exports.AlertConditionKindsEnum = exports.AlertConditionScopeEnum = exports.AlertConditionMatchEnum = exports.AlertConditionStageEnum = exports.AlertConditionFormCategoriesEnum = void 0;
16
+ exports.AlertConditionFrequencyEnum = exports.AlertConditionPriceDirectionEnum = exports.AlertConditionBaselineModeEnum = exports.AlertConditionIntervalEnum = exports.AlertConditionModeEnum = exports.AlertConditionBaselineEnum = exports.AlertConditionDirectionEnum = exports.AlertConditionOperatorEnum = exports.AlertConditionAssetClassEnum = exports.AlertConditionEventEnum = exports.AlertConditionReportKindsEnum = exports.AlertConditionStatusesEnum = exports.AlertConditionSpeakerRolesEnum = exports.AlertConditionEventsEnum = exports.AlertConditionKindsEnum = exports.AlertConditionScopeEnum = exports.AlertConditionMatchEnum = exports.AlertConditionStageEnum = exports.AlertConditionFormCategoriesEnum = void 0;
17
17
  exports.instanceOfAlertCondition = instanceOfAlertCondition;
18
18
  exports.AlertConditionFromJSON = AlertConditionFromJSON;
19
19
  exports.AlertConditionFromJSONTyped = AlertConditionFromJSONTyped;
@@ -128,6 +128,83 @@ exports.AlertConditionEventEnum = {
128
128
  ExDividend: 'ex_dividend',
129
129
  DividendPayment: 'dividend_payment'
130
130
  };
131
+ /**
132
+ * @export
133
+ */
134
+ exports.AlertConditionAssetClassEnum = {
135
+ UsStock: 'us_stock',
136
+ Crypto: 'crypto'
137
+ };
138
+ /**
139
+ * @export
140
+ */
141
+ exports.AlertConditionOperatorEnum = {
142
+ CrossesAbove: 'crosses_above',
143
+ CrossesBelow: 'crosses_below',
144
+ Crosses: 'crosses',
145
+ Above: 'above',
146
+ Below: 'below'
147
+ };
148
+ /**
149
+ * @export
150
+ */
151
+ exports.AlertConditionDirectionEnum = {
152
+ Up: 'up',
153
+ Down: 'down',
154
+ Both: 'both'
155
+ };
156
+ /**
157
+ * @export
158
+ */
159
+ exports.AlertConditionBaselineEnum = {
160
+ PriorClose: 'prior_close',
161
+ IntradayOpen: 'intraday_open',
162
+ SessionHigh: 'session_high',
163
+ SessionLow: 'session_low',
164
+ GapOpen: 'gap_open'
165
+ };
166
+ /**
167
+ * @export
168
+ */
169
+ exports.AlertConditionModeEnum = {
170
+ Relative: 'relative',
171
+ Absolute: 'absolute',
172
+ Session: 'session'
173
+ };
174
+ /**
175
+ * @export
176
+ */
177
+ exports.AlertConditionIntervalEnum = {
178
+ _1h: '1h',
179
+ _1d: '1d',
180
+ _1w: '1w',
181
+ _1mo: '1mo'
182
+ };
183
+ /**
184
+ * @export
185
+ */
186
+ exports.AlertConditionBaselineModeEnum = {
187
+ FlatMean: 'flat_mean',
188
+ RvolSlot: 'rvol_slot',
189
+ Median: 'median'
190
+ };
191
+ /**
192
+ * @export
193
+ */
194
+ exports.AlertConditionPriceDirectionEnum = {
195
+ Up: 'up',
196
+ Down: 'down',
197
+ Any: 'any'
198
+ };
199
+ /**
200
+ * @export
201
+ */
202
+ exports.AlertConditionFrequencyEnum = {
203
+ Once: 'once',
204
+ Hourly: 'hourly',
205
+ Daily: 'daily',
206
+ Weekly: 'weekly'
207
+ };
131
208
  /**
132
209
  * Check if a given object implements the AlertCondition interface.
133
210
  */
@@ -175,6 +252,24 @@ function AlertConditionFromJSONTyped(json, ignoreDiscriminator) {
175
252
  'time_of_day_minutes': json['time_of_day_minutes'] == null ? undefined : json['time_of_day_minutes'],
176
253
  'timezone': json['timezone'] == null ? undefined : json['timezone'],
177
254
  'notify_on_date_change': json['notify_on_date_change'] == null ? undefined : json['notify_on_date_change'],
255
+ 'asset_class': json['asset_class'] == null ? undefined : json['asset_class'],
256
+ 'operator': json['operator'] == null ? undefined : json['operator'],
257
+ 'level': json['level'] == null ? undefined : json['level'],
258
+ 'direction': json['direction'] == null ? undefined : json['direction'],
259
+ 'pct': json['pct'] == null ? undefined : json['pct'],
260
+ 'baseline': json['baseline'] == null ? undefined : json['baseline'],
261
+ 'window_minutes': json['window_minutes'] == null ? undefined : json['window_minutes'],
262
+ 'mode': json['mode'] == null ? undefined : json['mode'],
263
+ 'interval': json['interval'] == null ? undefined : json['interval'],
264
+ 'multiple': json['multiple'] == null ? undefined : json['multiple'],
265
+ 'threshold': json['threshold'] == null ? undefined : json['threshold'],
266
+ 'lookback_bars': json['lookback_bars'] == null ? undefined : json['lookback_bars'],
267
+ 'baseline_mode': json['baseline_mode'] == null ? undefined : json['baseline_mode'],
268
+ 'price_direction': json['price_direction'] == null ? undefined : json['price_direction'],
269
+ 'frequency': json['frequency'] == null ? undefined : json['frequency'],
270
+ 'at': json['at'] == null ? undefined : (new Date(json['at'])),
271
+ 'weekday': json['weekday'] == null ? undefined : json['weekday'],
272
+ 'days': json['days'] == null ? undefined : json['days'],
178
273
  };
179
274
  }
180
275
  function AlertConditionToJSON(json) {
@@ -218,5 +313,23 @@ function AlertConditionToJSONTyped(value, ignoreDiscriminator = false) {
218
313
  'time_of_day_minutes': value['time_of_day_minutes'],
219
314
  'timezone': value['timezone'],
220
315
  'notify_on_date_change': value['notify_on_date_change'],
316
+ 'asset_class': value['asset_class'],
317
+ 'operator': value['operator'],
318
+ 'level': value['level'],
319
+ 'direction': value['direction'],
320
+ 'pct': value['pct'],
321
+ 'baseline': value['baseline'],
322
+ 'window_minutes': value['window_minutes'],
323
+ 'mode': value['mode'],
324
+ 'interval': value['interval'],
325
+ 'multiple': value['multiple'],
326
+ 'threshold': value['threshold'],
327
+ 'lookback_bars': value['lookback_bars'],
328
+ 'baseline_mode': value['baseline_mode'],
329
+ 'price_direction': value['price_direction'],
330
+ 'frequency': value['frequency'],
331
+ 'at': value['at'] == null ? value['at'] : value['at'].toISOString(),
332
+ 'weekday': value['weekday'],
333
+ 'days': value['days'],
221
334
  };
222
335
  }
@@ -15,7 +15,7 @@ import type { AlertConditionInputYoyRulesInner } from './AlertConditionInputYoyR
15
15
  import type { AlertConditionInputRulesInner } from './AlertConditionInputRulesInner';
16
16
  import type { AlertConditionInputYieldRule } from './AlertConditionInputYieldRule';
17
17
  /**
18
- * What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls. (request form)
18
+ * What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Price types (`price`, `price_move`, `volume_spike`, `price_reminder`) watch ONE instrument: `symbol` + `asset_class`. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls. (request form) 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
  */