@invinite-org/data-api-client 6.2.0 → 6.3.1

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 (208) hide show
  1. package/.openapi-generator/FILES +52 -0
  2. package/dist/apis/ScriptsApi.d.ts +148 -0
  3. package/dist/apis/ScriptsApi.js +396 -0
  4. package/dist/apis/index.d.ts +1 -0
  5. package/dist/apis/index.js +1 -0
  6. package/dist/esm/apis/ScriptsApi.d.ts +148 -0
  7. package/dist/esm/apis/ScriptsApi.js +392 -0
  8. package/dist/esm/apis/index.d.ts +1 -0
  9. package/dist/esm/apis/index.js +1 -0
  10. package/dist/esm/models/Alert.d.ts +6 -0
  11. package/dist/esm/models/Alert.js +4 -0
  12. package/dist/esm/models/AlertCondition.d.ts +61 -5
  13. package/dist/esm/models/AlertCondition.js +27 -1
  14. package/dist/esm/models/AlertConditionInput.d.ts +54 -5
  15. package/dist/esm/models/AlertConditionInput.js +24 -1
  16. package/dist/esm/models/AlertTemplate.d.ts +83 -0
  17. package/dist/esm/models/AlertTemplate.js +79 -0
  18. package/dist/esm/models/AlertTemplateInput.d.ts +78 -0
  19. package/dist/esm/models/AlertTemplateInput.js +70 -0
  20. package/dist/esm/models/AlertTrigger.d.ts +1 -1
  21. package/dist/esm/models/AlertTriggerInput.d.ts +1 -1
  22. package/dist/esm/models/Company.d.ts +6 -6
  23. package/dist/esm/models/CreateScriptRequest.d.ts +44 -0
  24. package/dist/esm/models/CreateScriptRequest.js +49 -0
  25. package/dist/esm/models/CreateScriptVersionRequest.d.ts +32 -0
  26. package/dist/esm/models/CreateScriptVersionRequest.js +43 -0
  27. package/dist/esm/models/IndicatorCondition.d.ts +56 -0
  28. package/dist/esm/models/IndicatorCondition.js +62 -0
  29. package/dist/esm/models/IndicatorConditionInput.d.ts +56 -0
  30. package/dist/esm/models/IndicatorConditionInput.js +62 -0
  31. package/dist/esm/models/IndicatorFilterChild.d.ts +68 -0
  32. package/dist/esm/models/IndicatorFilterChild.js +65 -0
  33. package/dist/esm/models/IndicatorFilterChildInput.d.ts +68 -0
  34. package/dist/esm/models/IndicatorFilterChildInput.js +65 -0
  35. package/dist/esm/models/IndicatorFilterCondition.d.ts +73 -0
  36. package/dist/esm/models/IndicatorFilterCondition.js +74 -0
  37. package/dist/esm/models/IndicatorFilterConditionInput.d.ts +73 -0
  38. package/dist/esm/models/IndicatorFilterConditionInput.js +74 -0
  39. package/dist/esm/models/IndicatorFilterLeaf.d.ts +46 -0
  40. package/dist/esm/models/IndicatorFilterLeaf.js +54 -0
  41. package/dist/esm/models/IndicatorFilterLeafInput.d.ts +46 -0
  42. package/dist/esm/models/IndicatorFilterLeafInput.js +56 -0
  43. package/dist/esm/models/IndicatorFilters.d.ts +47 -0
  44. package/dist/esm/models/IndicatorFilters.js +55 -0
  45. package/dist/esm/models/IndicatorFiltersInput.d.ts +47 -0
  46. package/dist/esm/models/IndicatorFiltersInput.js +55 -0
  47. package/dist/esm/models/IndicatorOperand.d.ts +91 -0
  48. package/dist/esm/models/IndicatorOperand.js +74 -0
  49. package/dist/esm/models/IndicatorOperandInput.d.ts +91 -0
  50. package/dist/esm/models/IndicatorOperandInput.js +74 -0
  51. package/dist/esm/models/IndicatorResolved.d.ts +67 -0
  52. package/dist/esm/models/IndicatorResolved.js +65 -0
  53. package/dist/esm/models/IndicatorResolvedThreshold.d.ts +47 -0
  54. package/dist/esm/models/IndicatorResolvedThreshold.js +55 -0
  55. package/dist/esm/models/IndicatorTemplateRef.d.ts +46 -0
  56. package/dist/esm/models/IndicatorTemplateRef.js +47 -0
  57. package/dist/esm/models/ListAlertTemplates200Response.d.ts +52 -0
  58. package/dist/esm/models/ListAlertTemplates200Response.js +57 -0
  59. package/dist/esm/models/ListScriptVersions200Response.d.ts +52 -0
  60. package/dist/esm/models/ListScriptVersions200Response.js +57 -0
  61. package/dist/esm/models/ListScripts200Response.d.ts +52 -0
  62. package/dist/esm/models/ListScripts200Response.js +57 -0
  63. package/dist/esm/models/Script.d.ts +69 -0
  64. package/dist/esm/models/Script.js +68 -0
  65. package/dist/esm/models/ScriptDiagnostic.d.ts +64 -0
  66. package/dist/esm/models/ScriptDiagnostic.js +66 -0
  67. package/dist/esm/models/ScriptVersion.d.ts +103 -0
  68. package/dist/esm/models/ScriptVersion.js +91 -0
  69. package/dist/esm/models/index.d.ts +25 -0
  70. package/dist/esm/models/index.js +25 -0
  71. package/dist/models/Alert.d.ts +6 -0
  72. package/dist/models/Alert.js +4 -0
  73. package/dist/models/AlertCondition.d.ts +61 -5
  74. package/dist/models/AlertCondition.js +27 -1
  75. package/dist/models/AlertConditionInput.d.ts +54 -5
  76. package/dist/models/AlertConditionInput.js +24 -1
  77. package/dist/models/AlertTemplate.d.ts +83 -0
  78. package/dist/models/AlertTemplate.js +87 -0
  79. package/dist/models/AlertTemplateInput.d.ts +78 -0
  80. package/dist/models/AlertTemplateInput.js +78 -0
  81. package/dist/models/AlertTrigger.d.ts +1 -1
  82. package/dist/models/AlertTriggerInput.d.ts +1 -1
  83. package/dist/models/Company.d.ts +6 -6
  84. package/dist/models/CreateScriptRequest.d.ts +44 -0
  85. package/dist/models/CreateScriptRequest.js +56 -0
  86. package/dist/models/CreateScriptVersionRequest.d.ts +32 -0
  87. package/dist/models/CreateScriptVersionRequest.js +50 -0
  88. package/dist/models/IndicatorCondition.d.ts +56 -0
  89. package/dist/models/IndicatorCondition.js +70 -0
  90. package/dist/models/IndicatorConditionInput.d.ts +56 -0
  91. package/dist/models/IndicatorConditionInput.js +70 -0
  92. package/dist/models/IndicatorFilterChild.d.ts +68 -0
  93. package/dist/models/IndicatorFilterChild.js +73 -0
  94. package/dist/models/IndicatorFilterChildInput.d.ts +68 -0
  95. package/dist/models/IndicatorFilterChildInput.js +73 -0
  96. package/dist/models/IndicatorFilterCondition.d.ts +73 -0
  97. package/dist/models/IndicatorFilterCondition.js +82 -0
  98. package/dist/models/IndicatorFilterConditionInput.d.ts +73 -0
  99. package/dist/models/IndicatorFilterConditionInput.js +82 -0
  100. package/dist/models/IndicatorFilterLeaf.d.ts +46 -0
  101. package/dist/models/IndicatorFilterLeaf.js +62 -0
  102. package/dist/models/IndicatorFilterLeafInput.d.ts +46 -0
  103. package/dist/models/IndicatorFilterLeafInput.js +64 -0
  104. package/dist/models/IndicatorFilters.d.ts +47 -0
  105. package/dist/models/IndicatorFilters.js +63 -0
  106. package/dist/models/IndicatorFiltersInput.d.ts +47 -0
  107. package/dist/models/IndicatorFiltersInput.js +63 -0
  108. package/dist/models/IndicatorOperand.d.ts +91 -0
  109. package/dist/models/IndicatorOperand.js +82 -0
  110. package/dist/models/IndicatorOperandInput.d.ts +91 -0
  111. package/dist/models/IndicatorOperandInput.js +82 -0
  112. package/dist/models/IndicatorResolved.d.ts +67 -0
  113. package/dist/models/IndicatorResolved.js +73 -0
  114. package/dist/models/IndicatorResolvedThreshold.d.ts +47 -0
  115. package/dist/models/IndicatorResolvedThreshold.js +63 -0
  116. package/dist/models/IndicatorTemplateRef.d.ts +46 -0
  117. package/dist/models/IndicatorTemplateRef.js +54 -0
  118. package/dist/models/ListAlertTemplates200Response.d.ts +52 -0
  119. package/dist/models/ListAlertTemplates200Response.js +64 -0
  120. package/dist/models/ListScriptVersions200Response.d.ts +52 -0
  121. package/dist/models/ListScriptVersions200Response.js +64 -0
  122. package/dist/models/ListScripts200Response.d.ts +52 -0
  123. package/dist/models/ListScripts200Response.js +64 -0
  124. package/dist/models/Script.d.ts +69 -0
  125. package/dist/models/Script.js +75 -0
  126. package/dist/models/ScriptDiagnostic.d.ts +64 -0
  127. package/dist/models/ScriptDiagnostic.js +74 -0
  128. package/dist/models/ScriptVersion.d.ts +103 -0
  129. package/dist/models/ScriptVersion.js +99 -0
  130. package/dist/models/index.d.ts +25 -0
  131. package/dist/models/index.js +25 -0
  132. package/docs/Alert.md +2 -0
  133. package/docs/AlertCondition.md +15 -1
  134. package/docs/AlertConditionInput.md +13 -1
  135. package/docs/AlertTemplate.md +49 -0
  136. package/docs/AlertTemplateInput.md +47 -0
  137. package/docs/CompaniesApi.md +4 -4
  138. package/docs/CreateScriptRequest.md +38 -0
  139. package/docs/CreateScriptVersionRequest.md +34 -0
  140. package/docs/EventsApi.md +2 -2
  141. package/docs/FilingsApi.md +4 -4
  142. package/docs/FinancialsApi.md +12 -12
  143. package/docs/GuidanceApi.md +4 -4
  144. package/docs/HoldingsApi.md +8 -8
  145. package/docs/IPOsApi.md +4 -4
  146. package/docs/IndicatorCondition.md +39 -0
  147. package/docs/IndicatorConditionInput.md +39 -0
  148. package/docs/IndicatorFilterChild.md +41 -0
  149. package/docs/IndicatorFilterChildInput.md +41 -0
  150. package/docs/IndicatorFilterCondition.md +41 -0
  151. package/docs/IndicatorFilterConditionInput.md +41 -0
  152. package/docs/IndicatorFilterLeaf.md +37 -0
  153. package/docs/IndicatorFilterLeafInput.md +37 -0
  154. package/docs/IndicatorFilters.md +37 -0
  155. package/docs/IndicatorFiltersInput.md +37 -0
  156. package/docs/IndicatorOperand.md +47 -0
  157. package/docs/IndicatorOperandInput.md +47 -0
  158. package/docs/IndicatorResolved.md +43 -0
  159. package/docs/IndicatorResolvedThreshold.md +37 -0
  160. package/docs/IndicatorTemplateRef.md +39 -0
  161. package/docs/InsiderTradesApi.md +2 -2
  162. package/docs/InvestorDocumentsApi.md +4 -4
  163. package/docs/ListAlertTemplates200Response.md +41 -0
  164. package/docs/ListScriptVersions200Response.md +41 -0
  165. package/docs/ListScripts200Response.md +41 -0
  166. package/docs/MetricsApi.md +10 -10
  167. package/docs/NewsApi.md +6 -6
  168. package/docs/ReferenceApi.md +6 -6
  169. package/docs/Script.md +46 -0
  170. package/docs/ScriptDiagnostic.md +42 -0
  171. package/docs/ScriptVersion.md +54 -0
  172. package/docs/ScriptsApi.md +588 -0
  173. package/docs/TranscriptsApi.md +2 -2
  174. package/package.json +1 -1
  175. package/src/apis/ScriptsApi.ts +504 -0
  176. package/src/apis/index.ts +1 -0
  177. package/src/models/Alert.ts +9 -0
  178. package/src/models/AlertCondition.ts +98 -6
  179. package/src/models/AlertConditionInput.ts +83 -6
  180. package/src/models/AlertTemplate.ts +148 -0
  181. package/src/models/AlertTemplateInput.ts +130 -0
  182. package/src/models/AlertTrigger.ts +1 -1
  183. package/src/models/AlertTriggerInput.ts +1 -1
  184. package/src/models/Company.ts +6 -6
  185. package/src/models/CreateScriptRequest.ts +83 -0
  186. package/src/models/CreateScriptVersionRequest.ts +66 -0
  187. package/src/models/IndicatorCondition.ts +106 -0
  188. package/src/models/IndicatorConditionInput.ts +106 -0
  189. package/src/models/IndicatorFilterChild.ts +125 -0
  190. package/src/models/IndicatorFilterChildInput.ts +125 -0
  191. package/src/models/IndicatorFilterCondition.ts +126 -0
  192. package/src/models/IndicatorFilterConditionInput.ts +126 -0
  193. package/src/models/IndicatorFilterLeaf.ts +93 -0
  194. package/src/models/IndicatorFilterLeafInput.ts +95 -0
  195. package/src/models/IndicatorFilters.ts +94 -0
  196. package/src/models/IndicatorFiltersInput.ts +94 -0
  197. package/src/models/IndicatorOperand.ts +139 -0
  198. package/src/models/IndicatorOperandInput.ts +139 -0
  199. package/src/models/IndicatorResolved.ts +120 -0
  200. package/src/models/IndicatorResolvedThreshold.ts +87 -0
  201. package/src/models/IndicatorTemplateRef.ts +82 -0
  202. package/src/models/ListAlertTemplates200Response.ts +108 -0
  203. package/src/models/ListScriptVersions200Response.ts +108 -0
  204. package/src/models/ListScripts200Response.ts +108 -0
  205. package/src/models/Script.ts +128 -0
  206. package/src/models/ScriptDiagnostic.ts +113 -0
  207. package/src/models/ScriptVersion.ts +175 -0
  208. package/src/models/index.ts +25 -0
@@ -13,6 +13,13 @@
13
13
  */
14
14
 
15
15
  import { mapValues } from '../runtime';
16
+ import type { IndicatorFilters } from './IndicatorFilters';
17
+ import {
18
+ IndicatorFiltersFromJSON,
19
+ IndicatorFiltersFromJSONTyped,
20
+ IndicatorFiltersToJSON,
21
+ IndicatorFiltersToJSONTyped,
22
+ } from './IndicatorFilters';
16
23
  import type { AlertConditionAmountChange } from './AlertConditionAmountChange';
17
24
  import {
18
25
  AlertConditionAmountChangeFromJSON,
@@ -27,6 +34,13 @@ import {
27
34
  AlertConditionMentionDeltaRuleToJSON,
28
35
  AlertConditionMentionDeltaRuleToJSONTyped,
29
36
  } from './AlertConditionMentionDeltaRule';
37
+ import type { IndicatorTemplateRef } from './IndicatorTemplateRef';
38
+ import {
39
+ IndicatorTemplateRefFromJSON,
40
+ IndicatorTemplateRefFromJSONTyped,
41
+ IndicatorTemplateRefToJSON,
42
+ IndicatorTemplateRefToJSONTyped,
43
+ } from './IndicatorTemplateRef';
30
44
  import type { AlertConditionRulesInner } from './AlertConditionRulesInner';
31
45
  import {
32
46
  AlertConditionRulesInnerFromJSON,
@@ -34,6 +48,13 @@ import {
34
48
  AlertConditionRulesInnerToJSON,
35
49
  AlertConditionRulesInnerToJSONTyped,
36
50
  } from './AlertConditionRulesInner';
51
+ import type { IndicatorResolved } from './IndicatorResolved';
52
+ import {
53
+ IndicatorResolvedFromJSON,
54
+ IndicatorResolvedFromJSONTyped,
55
+ IndicatorResolvedToJSON,
56
+ IndicatorResolvedToJSONTyped,
57
+ } from './IndicatorResolved';
37
58
  import type { AlertConditionYieldRule } from './AlertConditionYieldRule';
38
59
  import {
39
60
  AlertConditionYieldRuleFromJSON,
@@ -48,9 +69,16 @@ import {
48
69
  AlertConditionYoyRulesInnerToJSON,
49
70
  AlertConditionYoyRulesInnerToJSONTyped,
50
71
  } from './AlertConditionYoyRulesInner';
72
+ import type { IndicatorCondition } from './IndicatorCondition';
73
+ import {
74
+ IndicatorConditionFromJSON,
75
+ IndicatorConditionFromJSONTyped,
76
+ IndicatorConditionToJSON,
77
+ IndicatorConditionToJSONTyped,
78
+ } from './IndicatorCondition';
51
79
 
52
80
  /**
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. 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.
81
+ * 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`) and `script` watch ONE instrument: `symbol` + `asset_class`. A `script` alert runs a script version (`/v1/scripts`) at each close of `interval`; alerts with the same version, instrument, interval, inputs and frequency share one evaluation. An `indicator` alert takes a built-in `template` (`GET /v1/alert-templates`) or a structured `condition` (+ optional `filters`) on `symbol` / `interval`; alerts crossing a constant on the same indicator, instrument and interval share one evaluation whatever the threshold. 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`, `news`, `news_keyword` and an `earnings_call` countdown refuse an ETF of either identity (its ticker or a fund registrant's CIK) by name (400 `invalid_parameter`).
54
82
  * @export
55
83
  * @interface AlertCondition
56
84
  */
@@ -74,7 +102,7 @@ export interface AlertCondition {
74
102
  */
75
103
  cik?: string;
76
104
  /**
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)
105
+ * The company (or, for the types that take ETFs, the US ETF) by ticker. Same types as `cik`; price types, script and indicator: the instrument (a US stock / ETF ticker, or a crypto slug / ticker)
78
106
  * @type {string}
79
107
  * @memberof AlertCondition
80
108
  */
@@ -254,7 +282,7 @@ export interface AlertCondition {
254
282
  */
255
283
  notify_on_date_change?: boolean;
256
284
  /**
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
285
+ * 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, script, indicator
258
286
  * @type {AlertConditionAssetClassEnum}
259
287
  * @memberof AlertCondition
260
288
  */
@@ -302,7 +330,7 @@ export interface AlertCondition {
302
330
  */
303
331
  mode?: AlertConditionModeEnum;
304
332
  /**
305
- * The bar evaluated at its close (relative / absolute). volume_spike
333
+ * The bar evaluated at its close. volume_spike (1h, 1d, 1w, 1mo); script and indicator (1m, 5m, 15m, 30m, 1h, 4h, 1d; the plan's shortest: FREE / LITE 1h, STANDARD 5m, PRO 1m)
306
334
  * @type {AlertConditionIntervalEnum}
307
335
  * @memberof AlertCondition
308
336
  */
@@ -338,7 +366,7 @@ export interface AlertCondition {
338
366
  */
339
367
  price_direction?: AlertConditionPriceDirectionEnum;
340
368
  /**
341
- * When the reminder fires: once at `at`, on the hour, daily or weekly at `time_of_day_minutes`. price_reminder
369
+ * price_reminder: when the reminder fires — once at `at`, on the hour, daily or weekly at `time_of_day_minutes`. script: when the script's alerts deliver — `once_per_bar_close` (default) at most once per alert id and closed bar, `once_per_bar` the same, `every_time` every evaluation, `once` the first evaluation only. indicator: the same (`once` = this alert's first fire only). price_reminder, script, indicator
342
370
  * @type {AlertConditionFrequencyEnum}
343
371
  * @memberof AlertCondition
344
372
  */
@@ -361,6 +389,48 @@ export interface AlertCondition {
361
389
  * @memberof AlertCondition
362
390
  */
363
391
  days?: Array<number>;
392
+ /**
393
+ * The script version evaluated (`scv_…`, status ok, of a script of this account). script
394
+ * @type {string}
395
+ * @memberof AlertCondition
396
+ */
397
+ script_version_id?: string;
398
+ /**
399
+ * Values for the script's declared inputs (checked against its manifest; absent = the defaults). script
400
+ * @type {{ [key: string]: any; }}
401
+ * @memberof AlertCondition
402
+ */
403
+ inputs?: { [key: string]: any; };
404
+ /**
405
+ * Only these of the script's alerts (its version's `alert_ids`); empty = all. script
406
+ * @type {Array<string>}
407
+ * @memberof AlertCondition
408
+ */
409
+ alert_ids?: Array<string>;
410
+ /**
411
+ *
412
+ * @type {IndicatorTemplateRef}
413
+ * @memberof AlertCondition
414
+ */
415
+ template?: IndicatorTemplateRef;
416
+ /**
417
+ *
418
+ * @type {IndicatorCondition}
419
+ * @memberof AlertCondition
420
+ */
421
+ condition?: IndicatorCondition;
422
+ /**
423
+ *
424
+ * @type {IndicatorFilters}
425
+ * @memberof AlertCondition
426
+ */
427
+ filters?: IndicatorFilters;
428
+ /**
429
+ *
430
+ * @type {IndicatorResolved}
431
+ * @memberof AlertCondition
432
+ */
433
+ resolved?: IndicatorResolved;
364
434
  }
365
435
 
366
436
 
@@ -545,7 +615,12 @@ export type AlertConditionModeEnum = typeof AlertConditionModeEnum[keyof typeof
545
615
  * @export
546
616
  */
547
617
  export const AlertConditionIntervalEnum = {
618
+ _1m: '1m',
619
+ _5m: '5m',
620
+ _15m: '15m',
621
+ _30m: '30m',
548
622
  _1h: '1h',
623
+ _4h: '4h',
549
624
  _1d: '1d',
550
625
  _1w: '1w',
551
626
  _1mo: '1mo'
@@ -579,7 +654,10 @@ export const AlertConditionFrequencyEnum = {
579
654
  Once: 'once',
580
655
  Hourly: 'hourly',
581
656
  Daily: 'daily',
582
- Weekly: 'weekly'
657
+ Weekly: 'weekly',
658
+ OncePerBar: 'once_per_bar',
659
+ OncePerBarClose: 'once_per_bar_close',
660
+ EveryTime: 'every_time'
583
661
  } as const;
584
662
  export type AlertConditionFrequencyEnum = typeof AlertConditionFrequencyEnum[keyof typeof AlertConditionFrequencyEnum] | (string & {});
585
663
 
@@ -652,6 +730,13 @@ export function AlertConditionFromJSONTyped(json: any, ignoreDiscriminator: bool
652
730
  'at': json['at'] == null ? undefined : (new Date(json['at'])),
653
731
  'weekday': json['weekday'] == null ? undefined : json['weekday'],
654
732
  'days': json['days'] == null ? undefined : json['days'],
733
+ 'script_version_id': json['script_version_id'] == null ? undefined : json['script_version_id'],
734
+ 'inputs': json['inputs'] == null ? undefined : json['inputs'],
735
+ 'alert_ids': json['alert_ids'] == null ? undefined : json['alert_ids'],
736
+ 'template': json['template'] == null ? undefined : IndicatorTemplateRefFromJSON(json['template']),
737
+ 'condition': json['condition'] == null ? undefined : IndicatorConditionFromJSON(json['condition']),
738
+ 'filters': json['filters'] == null ? undefined : IndicatorFiltersFromJSON(json['filters']),
739
+ 'resolved': json['resolved'] == null ? undefined : IndicatorResolvedFromJSON(json['resolved']),
655
740
  };
656
741
  }
657
742
 
@@ -717,6 +802,13 @@ export function AlertConditionToJSONTyped(value?: AlertCondition | null, ignoreD
717
802
  'at': value['at'] == null ? value['at'] : value['at'].toISOString(),
718
803
  'weekday': value['weekday'],
719
804
  'days': value['days'],
805
+ 'script_version_id': value['script_version_id'],
806
+ 'inputs': value['inputs'],
807
+ 'alert_ids': value['alert_ids'],
808
+ 'template': IndicatorTemplateRefToJSON(value['template']),
809
+ 'condition': IndicatorConditionToJSON(value['condition']),
810
+ 'filters': IndicatorFiltersToJSON(value['filters']),
811
+ 'resolved': IndicatorResolvedToJSON(value['resolved']),
720
812
  };
721
813
  }
722
814
 
@@ -27,6 +27,20 @@ import {
27
27
  AlertConditionInputMentionDeltaRuleToJSON,
28
28
  AlertConditionInputMentionDeltaRuleToJSONTyped,
29
29
  } from './AlertConditionInputMentionDeltaRule';
30
+ import type { IndicatorTemplateRef } from './IndicatorTemplateRef';
31
+ import {
32
+ IndicatorTemplateRefFromJSON,
33
+ IndicatorTemplateRefFromJSONTyped,
34
+ IndicatorTemplateRefToJSON,
35
+ IndicatorTemplateRefToJSONTyped,
36
+ } from './IndicatorTemplateRef';
37
+ import type { IndicatorConditionInput } from './IndicatorConditionInput';
38
+ import {
39
+ IndicatorConditionInputFromJSON,
40
+ IndicatorConditionInputFromJSONTyped,
41
+ IndicatorConditionInputToJSON,
42
+ IndicatorConditionInputToJSONTyped,
43
+ } from './IndicatorConditionInput';
30
44
  import type { AlertConditionInputYoyRulesInner } from './AlertConditionInputYoyRulesInner';
31
45
  import {
32
46
  AlertConditionInputYoyRulesInnerFromJSON,
@@ -48,9 +62,16 @@ import {
48
62
  AlertConditionInputYieldRuleToJSON,
49
63
  AlertConditionInputYieldRuleToJSONTyped,
50
64
  } from './AlertConditionInputYieldRule';
65
+ import type { IndicatorFiltersInput } from './IndicatorFiltersInput';
66
+ import {
67
+ IndicatorFiltersInputFromJSON,
68
+ IndicatorFiltersInputFromJSONTyped,
69
+ IndicatorFiltersInputToJSON,
70
+ IndicatorFiltersInputToJSONTyped,
71
+ } from './IndicatorFiltersInput';
51
72
 
52
73
  /**
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.
74
+ * 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`), `script` and `indicator` watch ONE instrument: `symbol` + `asset_class`. An `indicator` alert takes a built-in `template` (`GET /v1/alert-templates`) or a structured `condition` (+ optional `filters`) on `symbol` / `interval`; alerts crossing a constant on the same indicator, instrument and interval share one evaluation whatever the threshold. 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`, `news`, `news_keyword` and an `earnings_call` countdown refuse an ETF of either identity (its ticker or a fund registrant's CIK) by name (400 `invalid_parameter`).
54
75
  * @export
55
76
  * @interface AlertConditionInput
56
77
  */
@@ -74,7 +95,7 @@ export interface AlertConditionInput {
74
95
  */
75
96
  cik?: string;
76
97
  /**
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)
98
+ * The company (or, for the types that take ETFs, the US ETF) by ticker. Same types as `cik`; price types, script and indicator: the instrument (a US stock / ETF ticker, or a crypto slug / ticker)
78
99
  * @type {string}
79
100
  * @memberof AlertConditionInput
80
101
  */
@@ -254,7 +275,7 @@ export interface AlertConditionInput {
254
275
  */
255
276
  notify_on_date_change?: boolean;
256
277
  /**
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
278
+ * 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, script, indicator
258
279
  * @type {AlertConditionInputAssetClassEnum}
259
280
  * @memberof AlertConditionInput
260
281
  */
@@ -302,7 +323,7 @@ export interface AlertConditionInput {
302
323
  */
303
324
  mode?: AlertConditionInputModeEnum;
304
325
  /**
305
- * The bar evaluated at its close (relative / absolute). volume_spike
326
+ * The bar evaluated at its close. volume_spike (1h, 1d, 1w, 1mo); script and indicator (1m, 5m, 15m, 30m, 1h, 4h, 1d; the plan's shortest: FREE / LITE 1h, STANDARD 5m, PRO 1m)
306
327
  * @type {AlertConditionInputIntervalEnum}
307
328
  * @memberof AlertConditionInput
308
329
  */
@@ -338,7 +359,7 @@ export interface AlertConditionInput {
338
359
  */
339
360
  price_direction?: AlertConditionInputPriceDirectionEnum;
340
361
  /**
341
- * When the reminder fires: once at `at`, on the hour, daily or weekly at `time_of_day_minutes`. price_reminder
362
+ * price_reminder: when the reminder fires — once at `at`, on the hour, daily or weekly at `time_of_day_minutes`. script: when the script's alerts deliver — `once_per_bar_close` (default) at most once per alert id and closed bar, `once_per_bar` the same, `every_time` every evaluation, `once` the first evaluation only. indicator: the same (`once` = this alert's first fire only). price_reminder, script, indicator
342
363
  * @type {AlertConditionInputFrequencyEnum}
343
364
  * @memberof AlertConditionInput
344
365
  */
@@ -361,6 +382,42 @@ export interface AlertConditionInput {
361
382
  * @memberof AlertConditionInput
362
383
  */
363
384
  days?: Array<number>;
385
+ /**
386
+ * The script version evaluated (`scv_…`, status ok, of a script of this account). script
387
+ * @type {string}
388
+ * @memberof AlertConditionInput
389
+ */
390
+ script_version_id?: string;
391
+ /**
392
+ * Values for the script's declared inputs (checked against its manifest; absent = the defaults). script
393
+ * @type {{ [key: string]: any; }}
394
+ * @memberof AlertConditionInput
395
+ */
396
+ inputs?: { [key: string]: any; };
397
+ /**
398
+ * Only these of the script's alerts (its version's `alert_ids`); empty = all. script
399
+ * @type {Array<string>}
400
+ * @memberof AlertConditionInput
401
+ */
402
+ alert_ids?: Array<string>;
403
+ /**
404
+ *
405
+ * @type {IndicatorTemplateRef}
406
+ * @memberof AlertConditionInput
407
+ */
408
+ template?: IndicatorTemplateRef;
409
+ /**
410
+ *
411
+ * @type {IndicatorConditionInput}
412
+ * @memberof AlertConditionInput
413
+ */
414
+ condition?: IndicatorConditionInput;
415
+ /**
416
+ *
417
+ * @type {IndicatorFiltersInput}
418
+ * @memberof AlertConditionInput
419
+ */
420
+ filters?: IndicatorFiltersInput;
364
421
  }
365
422
 
366
423
 
@@ -545,7 +602,12 @@ export type AlertConditionInputModeEnum = typeof AlertConditionInputModeEnum[key
545
602
  * @export
546
603
  */
547
604
  export const AlertConditionInputIntervalEnum = {
605
+ _1m: '1m',
606
+ _5m: '5m',
607
+ _15m: '15m',
608
+ _30m: '30m',
548
609
  _1h: '1h',
610
+ _4h: '4h',
549
611
  _1d: '1d',
550
612
  _1w: '1w',
551
613
  _1mo: '1mo'
@@ -579,7 +641,10 @@ export const AlertConditionInputFrequencyEnum = {
579
641
  Once: 'once',
580
642
  Hourly: 'hourly',
581
643
  Daily: 'daily',
582
- Weekly: 'weekly'
644
+ Weekly: 'weekly',
645
+ OncePerBar: 'once_per_bar',
646
+ OncePerBarClose: 'once_per_bar_close',
647
+ EveryTime: 'every_time'
583
648
  } as const;
584
649
  export type AlertConditionInputFrequencyEnum = typeof AlertConditionInputFrequencyEnum[keyof typeof AlertConditionInputFrequencyEnum];
585
650
 
@@ -652,6 +717,12 @@ export function AlertConditionInputFromJSONTyped(json: any, ignoreDiscriminator:
652
717
  'at': json['at'] == null ? undefined : json['at'],
653
718
  'weekday': json['weekday'] == null ? undefined : json['weekday'],
654
719
  'days': json['days'] == null ? undefined : json['days'],
720
+ 'script_version_id': json['script_version_id'] == null ? undefined : json['script_version_id'],
721
+ 'inputs': json['inputs'] == null ? undefined : json['inputs'],
722
+ 'alert_ids': json['alert_ids'] == null ? undefined : json['alert_ids'],
723
+ 'template': json['template'] == null ? undefined : IndicatorTemplateRefFromJSON(json['template']),
724
+ 'condition': json['condition'] == null ? undefined : IndicatorConditionInputFromJSON(json['condition']),
725
+ 'filters': json['filters'] == null ? undefined : IndicatorFiltersInputFromJSON(json['filters']),
655
726
  };
656
727
  }
657
728
 
@@ -717,6 +788,12 @@ export function AlertConditionInputToJSONTyped(value?: AlertConditionInput | nul
717
788
  'at': value['at'],
718
789
  'weekday': value['weekday'],
719
790
  'days': value['days'],
791
+ 'script_version_id': value['script_version_id'],
792
+ 'inputs': value['inputs'],
793
+ 'alert_ids': value['alert_ids'],
794
+ 'template': IndicatorTemplateRefToJSON(value['template']),
795
+ 'condition': IndicatorConditionInputToJSON(value['condition']),
796
+ 'filters': IndicatorFiltersInputToJSON(value['filters']),
720
797
  };
721
798
  }
722
799
 
@@ -0,0 +1,148 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Invinite API
5
+ * Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Alerts (`POST /v1/alerts`) deliver their events to your destinations (`POST /v1/destinations`) as [Standard Webhooks](https://github.com/standard-webhooks/standard-webhooks/blob/main/spec/standard-webhooks.md): `alert.fired`, `alert.fired.batch`, `alert.status_changed`, `destination.disabled`, `destination.test`, `account.fire_cap_reached`; see `x-webhooks` for each `data` object. Every event is also on the pull feed `GET /v1/alert-events`. Every delivery is a `POST` with `Content-Type: application/json`, the body `{type, timestamp, data}` (or the destination\'s `body_template`) and the headers `webhook-id` (the event id; a batch: its `bat_…` id), `webhook-timestamp` (unix seconds) and `webhook-signature`: space-separated `v1,<base64 HMAC-SHA256 of <webhook-id>.<webhook-timestamp>.<raw body>>`, keyed with the base64-DECODED bytes of the destination\'s `whsec_…` secret — any Standard Webhooks library verifies it. After `POST /v1/destinations/{id}:rotate-secret` the old secret keeps signing beside the new one for 24 h (two `v1` entries). Reject a timestamp older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed; a body above 256 KB is not sent. A failed attempt is retried after [0, 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 10 h, 10 h, 34 h] (attempt n waits the n-th step) plus up to 10 % jitter; the delivery is dead after attempt 10. A 410 disables the destination at once; so do 72 h of nothing but failures with at least 10 failed attempts in a row (a `destination.disabled` event on the feed and a mail; `PATCH` with `status: active` re-enables it). Delivery is at-least-once and unordered: dedupe on `webhook-id`, order by `timestamp`. A `batch_webhook` destination receives `alert.fired.batch` with the pending events in `data.events[]` (dedupe on each `data.event_id`). Fires and deliveries cost no credits; two fair-use caps apply instead: at most 60 fires per alert per rolling hour (beyond: suppressed and counted in the next fire\'s `suppressed_since_last`) and per account and UTC day FREE 100 · LITE 5,000 · STANDARD 50,000 · PRO 500,000 fires (beyond: written to the feed with `delivery_skipped: fire_cap`, not delivered; one `account.fire_cap_reached` per day). ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/me` and `/v1/me/usage` serve no licensed data and carry none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account, Alerts.
6
+ *
7
+ * The version of the OpenAPI document: 2026-11-13
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ import type { AlertTemplateInput } from './AlertTemplateInput';
17
+ import {
18
+ AlertTemplateInputFromJSON,
19
+ AlertTemplateInputFromJSONTyped,
20
+ AlertTemplateInputToJSON,
21
+ AlertTemplateInputToJSONTyped,
22
+ } from './AlertTemplateInput';
23
+
24
+ /**
25
+ * A built-in template of the `indicator` alert type.
26
+ * @export
27
+ * @interface AlertTemplate
28
+ */
29
+ export interface AlertTemplate {
30
+ /**
31
+ * The template key (`condition.template.key`)
32
+ * @type {string}
33
+ * @memberof AlertTemplate
34
+ */
35
+ key: string;
36
+ /**
37
+ * Its current version
38
+ * @type {number}
39
+ * @memberof AlertTemplate
40
+ */
41
+ version: number;
42
+ /**
43
+ * `builtin:<key>@<version>`
44
+ * @type {string}
45
+ * @memberof AlertTemplate
46
+ */
47
+ source_key: string;
48
+ /**
49
+ * Display name
50
+ * @type {string}
51
+ * @memberof AlertTemplate
52
+ */
53
+ title: string;
54
+ /**
55
+ * What it alerts on
56
+ * @type {string}
57
+ * @memberof AlertTemplate
58
+ */
59
+ description: string;
60
+ /**
61
+ * `exact`: its state restores from a snapshot after a restart; `lossy`: it warms up from history again (crossovers)
62
+ * @type {AlertTemplateFidelityEnum}
63
+ * @memberof AlertTemplate
64
+ */
65
+ fidelity: AlertTemplateFidelityEnum;
66
+ /**
67
+ * Its inputs, in order
68
+ * @type {Array<AlertTemplateInput>}
69
+ * @memberof AlertTemplate
70
+ */
71
+ inputs: Array<AlertTemplateInput>;
72
+ /**
73
+ * The chartlang source
74
+ * @type {string}
75
+ * @memberof AlertTemplate
76
+ */
77
+ source: string;
78
+ }
79
+
80
+
81
+ /**
82
+ * @export
83
+ */
84
+ export const AlertTemplateFidelityEnum = {
85
+ Exact: 'exact',
86
+ Lossy: 'lossy'
87
+ } as const;
88
+ export type AlertTemplateFidelityEnum = typeof AlertTemplateFidelityEnum[keyof typeof AlertTemplateFidelityEnum] | (string & {});
89
+
90
+
91
+ /**
92
+ * Check if a given object implements the AlertTemplate interface.
93
+ */
94
+ export function instanceOfAlertTemplate(value: object): value is AlertTemplate {
95
+ if (!('key' in value) || value['key'] === undefined) return false;
96
+ if (!('version' in value) || value['version'] === undefined) return false;
97
+ if (!('source_key' in value) || value['source_key'] === undefined) return false;
98
+ if (!('title' in value) || value['title'] === undefined) return false;
99
+ if (!('description' in value) || value['description'] === undefined) return false;
100
+ if (!('fidelity' in value) || value['fidelity'] === undefined) return false;
101
+ if (!('inputs' in value) || value['inputs'] === undefined) return false;
102
+ if (!('source' in value) || value['source'] === undefined) return false;
103
+ return true;
104
+ }
105
+
106
+ export function AlertTemplateFromJSON(json: any): AlertTemplate {
107
+ return AlertTemplateFromJSONTyped(json, false);
108
+ }
109
+
110
+ export function AlertTemplateFromJSONTyped(json: any, ignoreDiscriminator: boolean): AlertTemplate {
111
+ if (json == null) {
112
+ return json;
113
+ }
114
+ return {
115
+
116
+ 'key': json['key'],
117
+ 'version': json['version'],
118
+ 'source_key': json['source_key'],
119
+ 'title': json['title'],
120
+ 'description': json['description'],
121
+ 'fidelity': json['fidelity'],
122
+ 'inputs': ((json['inputs'] as Array<any>).map(AlertTemplateInputFromJSON)),
123
+ 'source': json['source'],
124
+ };
125
+ }
126
+
127
+ export function AlertTemplateToJSON(json: any): AlertTemplate {
128
+ return AlertTemplateToJSONTyped(json, false);
129
+ }
130
+
131
+ export function AlertTemplateToJSONTyped(value?: AlertTemplate | null, ignoreDiscriminator: boolean = false): any {
132
+ if (value == null) {
133
+ return value;
134
+ }
135
+
136
+ return {
137
+
138
+ 'key': value['key'],
139
+ 'version': value['version'],
140
+ 'source_key': value['source_key'],
141
+ 'title': value['title'],
142
+ 'description': value['description'],
143
+ 'fidelity': value['fidelity'],
144
+ 'inputs': ((value['inputs'] as Array<any>).map(AlertTemplateInputToJSON)),
145
+ 'source': value['source'],
146
+ };
147
+ }
148
+
@@ -0,0 +1,130 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Invinite API
5
+ * Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Alerts (`POST /v1/alerts`) deliver their events to your destinations (`POST /v1/destinations`) as [Standard Webhooks](https://github.com/standard-webhooks/standard-webhooks/blob/main/spec/standard-webhooks.md): `alert.fired`, `alert.fired.batch`, `alert.status_changed`, `destination.disabled`, `destination.test`, `account.fire_cap_reached`; see `x-webhooks` for each `data` object. Every event is also on the pull feed `GET /v1/alert-events`. Every delivery is a `POST` with `Content-Type: application/json`, the body `{type, timestamp, data}` (or the destination\'s `body_template`) and the headers `webhook-id` (the event id; a batch: its `bat_…` id), `webhook-timestamp` (unix seconds) and `webhook-signature`: space-separated `v1,<base64 HMAC-SHA256 of <webhook-id>.<webhook-timestamp>.<raw body>>`, keyed with the base64-DECODED bytes of the destination\'s `whsec_…` secret — any Standard Webhooks library verifies it. After `POST /v1/destinations/{id}:rotate-secret` the old secret keeps signing beside the new one for 24 h (two `v1` entries). Reject a timestamp older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed; a body above 256 KB is not sent. A failed attempt is retried after [0, 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 10 h, 10 h, 34 h] (attempt n waits the n-th step) plus up to 10 % jitter; the delivery is dead after attempt 10. A 410 disables the destination at once; so do 72 h of nothing but failures with at least 10 failed attempts in a row (a `destination.disabled` event on the feed and a mail; `PATCH` with `status: active` re-enables it). Delivery is at-least-once and unordered: dedupe on `webhook-id`, order by `timestamp`. A `batch_webhook` destination receives `alert.fired.batch` with the pending events in `data.events[]` (dedupe on each `data.event_id`). Fires and deliveries cost no credits; two fair-use caps apply instead: at most 60 fires per alert per rolling hour (beyond: suppressed and counted in the next fire\'s `suppressed_since_last`) and per account and UTC day FREE 100 · LITE 5,000 · STANDARD 50,000 · PRO 500,000 fires (beyond: written to the feed with `delivery_skipped: fire_cap`, not delivered; one `account.fire_cap_reached` per day). ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/me` and `/v1/me/usage` serve no licensed data and carry none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account, Alerts.
6
+ *
7
+ * The version of the OpenAPI document: 2026-11-13
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ /**
17
+ * One input of a template.
18
+ * @export
19
+ * @interface AlertTemplateInput
20
+ */
21
+ export interface AlertTemplateInput {
22
+ /**
23
+ * The input's key in `template.inputs`
24
+ * @type {string}
25
+ * @memberof AlertTemplateInput
26
+ */
27
+ name: string;
28
+ /**
29
+ * Its kind
30
+ * @type {AlertTemplateInputKindEnum}
31
+ * @memberof AlertTemplateInput
32
+ */
33
+ kind: AlertTemplateInputKindEnum;
34
+ /**
35
+ * Display name
36
+ * @type {string}
37
+ * @memberof AlertTemplateInput
38
+ */
39
+ title: string;
40
+ /**
41
+ * The default value (number, string or boolean)
42
+ * @type {any}
43
+ * @memberof AlertTemplateInput
44
+ */
45
+ _default: any | null;
46
+ /**
47
+ * Smallest value (numbers)
48
+ * @type {number}
49
+ * @memberof AlertTemplateInput
50
+ */
51
+ min?: number;
52
+ /**
53
+ * Largest value (numbers)
54
+ * @type {number}
55
+ * @memberof AlertTemplateInput
56
+ */
57
+ max?: number;
58
+ /**
59
+ * The allowed values (enum)
60
+ * @type {Array<string>}
61
+ * @memberof AlertTemplateInput
62
+ */
63
+ options?: Array<string>;
64
+ }
65
+
66
+
67
+ /**
68
+ * @export
69
+ */
70
+ export const AlertTemplateInputKindEnum = {
71
+ Int: 'int',
72
+ Float: 'float',
73
+ Enum: 'enum',
74
+ Bool: 'bool'
75
+ } as const;
76
+ export type AlertTemplateInputKindEnum = typeof AlertTemplateInputKindEnum[keyof typeof AlertTemplateInputKindEnum] | (string & {});
77
+
78
+
79
+ /**
80
+ * Check if a given object implements the AlertTemplateInput interface.
81
+ */
82
+ export function instanceOfAlertTemplateInput(value: object): value is AlertTemplateInput {
83
+ if (!('name' in value) || value['name'] === undefined) return false;
84
+ if (!('kind' in value) || value['kind'] === undefined) return false;
85
+ if (!('title' in value) || value['title'] === undefined) return false;
86
+ if ((!('_default' in value) && !('default' in value)) || (value['_default'] === undefined && value['default'] === undefined)) return false;
87
+ return true;
88
+ }
89
+
90
+ export function AlertTemplateInputFromJSON(json: any): AlertTemplateInput {
91
+ return AlertTemplateInputFromJSONTyped(json, false);
92
+ }
93
+
94
+ export function AlertTemplateInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): AlertTemplateInput {
95
+ if (json == null) {
96
+ return json;
97
+ }
98
+ return {
99
+
100
+ 'name': json['name'],
101
+ 'kind': json['kind'],
102
+ 'title': json['title'],
103
+ '_default': json['default'],
104
+ 'min': json['min'] == null ? undefined : json['min'],
105
+ 'max': json['max'] == null ? undefined : json['max'],
106
+ 'options': json['options'] == null ? undefined : json['options'],
107
+ };
108
+ }
109
+
110
+ export function AlertTemplateInputToJSON(json: any): AlertTemplateInput {
111
+ return AlertTemplateInputToJSONTyped(json, false);
112
+ }
113
+
114
+ export function AlertTemplateInputToJSONTyped(value?: AlertTemplateInput | null, ignoreDiscriminator: boolean = false): any {
115
+ if (value == null) {
116
+ return value;
117
+ }
118
+
119
+ return {
120
+
121
+ 'name': value['name'],
122
+ 'kind': value['kind'],
123
+ 'title': value['title'],
124
+ 'default': value['_default'],
125
+ 'min': value['min'],
126
+ 'max': value['max'],
127
+ 'options': value['options'],
128
+ };
129
+ }
130
+
@@ -40,7 +40,7 @@ export interface AlertTrigger {
40
40
  */
41
41
  cooldown_seconds?: number;
42
42
  /**
43
- * Minimum bars between fires (script / indicator types)
43
+ * Minimum bars between fires (script / indicator types), counted like chartlang: the bar of a fire must start at least cooldown_bars × the interval after the bar of the last fire, so a night or a weekend counts as time
44
44
  * @type {number}
45
45
  * @memberof AlertTrigger
46
46
  */