@invinite-org/data-api-client 6.3.0 → 6.4.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 (92) hide show
  1. package/.openapi-generator/FILES +12 -0
  2. package/dist/apis/InsiderTradesApi.d.ts +2 -2
  3. package/dist/apis/InsiderTradesApi.js +2 -2
  4. package/dist/esm/apis/InsiderTradesApi.d.ts +2 -2
  5. package/dist/esm/apis/InsiderTradesApi.js +2 -2
  6. package/dist/esm/models/AlertCondition.d.ts +29 -5
  7. package/dist/esm/models/AlertCondition.js +12 -1
  8. package/dist/esm/models/AlertConditionInput.d.ts +29 -5
  9. package/dist/esm/models/AlertConditionInput.js +12 -1
  10. package/dist/esm/models/AlertTrigger.d.ts +2 -2
  11. package/dist/esm/models/AlertTriggerInput.d.ts +2 -2
  12. package/dist/esm/models/Company.d.ts +6 -6
  13. package/dist/esm/models/IndicatorFilterCondition.d.ts +3 -0
  14. package/dist/esm/models/IndicatorFilterCondition.js +4 -1
  15. package/dist/esm/models/IndicatorFilterConditionInput.d.ts +3 -0
  16. package/dist/esm/models/IndicatorFilterConditionInput.js +4 -1
  17. package/dist/esm/models/ScriptEvaluation.d.ts +65 -0
  18. package/dist/esm/models/ScriptEvaluation.js +66 -0
  19. package/dist/esm/models/ScriptEvaluationInput.d.ts +65 -0
  20. package/dist/esm/models/ScriptEvaluationInput.js +66 -0
  21. package/dist/esm/models/ScriptNode.d.ts +55 -0
  22. package/dist/esm/models/ScriptNode.js +53 -0
  23. package/dist/esm/models/ScriptNodeInput.d.ts +55 -0
  24. package/dist/esm/models/ScriptNodeInput.js +53 -0
  25. package/dist/esm/models/ScriptSeriesInput.d.ts +99 -0
  26. package/dist/esm/models/ScriptSeriesInput.js +78 -0
  27. package/dist/esm/models/ScriptSeriesInputInput.d.ts +93 -0
  28. package/dist/esm/models/ScriptSeriesInputInput.js +76 -0
  29. package/dist/esm/models/index.d.ts +6 -0
  30. package/dist/esm/models/index.js +6 -0
  31. package/dist/models/AlertCondition.d.ts +29 -5
  32. package/dist/models/AlertCondition.js +12 -1
  33. package/dist/models/AlertConditionInput.d.ts +29 -5
  34. package/dist/models/AlertConditionInput.js +12 -1
  35. package/dist/models/AlertTrigger.d.ts +2 -2
  36. package/dist/models/AlertTriggerInput.d.ts +2 -2
  37. package/dist/models/Company.d.ts +6 -6
  38. package/dist/models/IndicatorFilterCondition.d.ts +3 -0
  39. package/dist/models/IndicatorFilterCondition.js +4 -1
  40. package/dist/models/IndicatorFilterConditionInput.d.ts +3 -0
  41. package/dist/models/IndicatorFilterConditionInput.js +4 -1
  42. package/dist/models/ScriptEvaluation.d.ts +65 -0
  43. package/dist/models/ScriptEvaluation.js +74 -0
  44. package/dist/models/ScriptEvaluationInput.d.ts +65 -0
  45. package/dist/models/ScriptEvaluationInput.js +74 -0
  46. package/dist/models/ScriptNode.d.ts +55 -0
  47. package/dist/models/ScriptNode.js +60 -0
  48. package/dist/models/ScriptNodeInput.d.ts +55 -0
  49. package/dist/models/ScriptNodeInput.js +60 -0
  50. package/dist/models/ScriptSeriesInput.d.ts +99 -0
  51. package/dist/models/ScriptSeriesInput.js +86 -0
  52. package/dist/models/ScriptSeriesInputInput.d.ts +93 -0
  53. package/dist/models/ScriptSeriesInputInput.js +84 -0
  54. package/dist/models/index.d.ts +6 -0
  55. package/dist/models/index.js +6 -0
  56. package/docs/AlertCondition.md +7 -1
  57. package/docs/AlertConditionInput.md +7 -1
  58. package/docs/CompaniesApi.md +4 -4
  59. package/docs/EventsApi.md +2 -2
  60. package/docs/FilingsApi.md +4 -4
  61. package/docs/FinancialsApi.md +12 -12
  62. package/docs/GuidanceApi.md +4 -4
  63. package/docs/HoldingsApi.md +8 -8
  64. package/docs/IPOsApi.md +4 -4
  65. package/docs/InsiderTradesApi.md +5 -5
  66. package/docs/InvestorDocumentsApi.md +4 -4
  67. package/docs/MetricsApi.md +10 -10
  68. package/docs/NewsApi.md +6 -6
  69. package/docs/ReferenceApi.md +6 -6
  70. package/docs/ScriptEvaluation.md +39 -0
  71. package/docs/ScriptEvaluationInput.md +39 -0
  72. package/docs/ScriptNode.md +41 -0
  73. package/docs/ScriptNodeInput.md +41 -0
  74. package/docs/ScriptSeriesInput.md +49 -0
  75. package/docs/ScriptSeriesInputInput.md +47 -0
  76. package/docs/TranscriptsApi.md +2 -2
  77. package/package.json +1 -1
  78. package/src/apis/InsiderTradesApi.ts +2 -2
  79. package/src/models/AlertCondition.ts +52 -6
  80. package/src/models/AlertConditionInput.ts +52 -6
  81. package/src/models/AlertTrigger.ts +2 -2
  82. package/src/models/AlertTriggerInput.ts +2 -2
  83. package/src/models/Company.ts +6 -6
  84. package/src/models/IndicatorFilterCondition.ts +4 -1
  85. package/src/models/IndicatorFilterConditionInput.ts +4 -1
  86. package/src/models/ScriptEvaluation.ts +107 -0
  87. package/src/models/ScriptEvaluationInput.ts +107 -0
  88. package/src/models/ScriptNode.ts +99 -0
  89. package/src/models/ScriptNodeInput.ts +99 -0
  90. package/src/models/ScriptSeriesInput.ts +149 -0
  91. package/src/models/ScriptSeriesInputInput.ts +141 -0
  92. package/src/models/index.ts +6 -0
@@ -0,0 +1,78 @@
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
+ * @export
16
+ */
17
+ export const ScriptSeriesInputKindEnum = {
18
+ Ohlc: 'ohlc',
19
+ BuiltinIndicator: 'builtin_indicator',
20
+ ScriptOutput: 'script_output'
21
+ };
22
+ /**
23
+ * @export
24
+ */
25
+ export const ScriptSeriesInputFieldEnum = {
26
+ Open: 'open',
27
+ High: 'high',
28
+ Low: 'low',
29
+ Close: 'close',
30
+ Hl2: 'hl2',
31
+ Hlc3: 'hlc3',
32
+ Ohlc4: 'ohlc4',
33
+ Hlcc4: 'hlcc4'
34
+ };
35
+ /**
36
+ * Check if a given object implements the ScriptSeriesInput interface.
37
+ */
38
+ export function instanceOfScriptSeriesInput(value) {
39
+ if (!('kind' in value) || value['kind'] === undefined)
40
+ return false;
41
+ return true;
42
+ }
43
+ export function ScriptSeriesInputFromJSON(json) {
44
+ return ScriptSeriesInputFromJSONTyped(json, false);
45
+ }
46
+ export function ScriptSeriesInputFromJSONTyped(json, ignoreDiscriminator) {
47
+ if (json == null) {
48
+ return json;
49
+ }
50
+ return {
51
+ 'kind': json['kind'],
52
+ 'field': json['field'] == null ? undefined : json['field'],
53
+ 'indicator_id': json['indicator_id'] == null ? undefined : json['indicator_id'],
54
+ 'series_key': json['series_key'] == null ? undefined : json['series_key'],
55
+ 'params': json['params'] == null ? undefined : json['params'],
56
+ 'resolved_script_version_id': json['resolved_script_version_id'] == null ? undefined : json['resolved_script_version_id'],
57
+ 'node_key': json['node_key'] == null ? undefined : json['node_key'],
58
+ 'slot_id': json['slot_id'] == null ? undefined : json['slot_id'],
59
+ };
60
+ }
61
+ export function ScriptSeriesInputToJSON(json) {
62
+ return ScriptSeriesInputToJSONTyped(json, false);
63
+ }
64
+ export function ScriptSeriesInputToJSONTyped(value, ignoreDiscriminator = false) {
65
+ if (value == null) {
66
+ return value;
67
+ }
68
+ return {
69
+ 'kind': value['kind'],
70
+ 'field': value['field'],
71
+ 'indicator_id': value['indicator_id'],
72
+ 'series_key': value['series_key'],
73
+ 'params': value['params'],
74
+ 'resolved_script_version_id': value['resolved_script_version_id'],
75
+ 'node_key': value['node_key'],
76
+ 'slot_id': value['slot_id'],
77
+ };
78
+ }
@@ -0,0 +1,93 @@
1
+ /**
2
+ * Invinite API
3
+ * 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.
4
+ *
5
+ * The version of the OpenAPI document: 2026-11-13
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * What feeds one `input.externalSeries` input of a script (a script chain), one value per bar on the alert's symbol, interval and bars; a value the producer does not give that bar reads NaN. (request form)
14
+ * @export
15
+ * @interface ScriptSeriesInputInput
16
+ */
17
+ export interface ScriptSeriesInputInput {
18
+ /**
19
+ * What feeds the input every bar: `ohlc` a bar field, `builtin_indicator` a built-in indicator's series, `script_output` a plot of a node of `nodes`
20
+ * @type {ScriptSeriesInputInputKindEnum}
21
+ * @memberof ScriptSeriesInputInput
22
+ */
23
+ kind: ScriptSeriesInputInputKindEnum;
24
+ /**
25
+ * ohlc: the bar field (`hl2` = (high + low) / 2, `hlc3`, `ohlc4`, `hlcc4` = (high + low + 2 × close) / 4; no volume)
26
+ * @type {ScriptSeriesInputInputFieldEnum}
27
+ * @memberof ScriptSeriesInputInput
28
+ */
29
+ field?: ScriptSeriesInputInputFieldEnum;
30
+ /**
31
+ * builtin_indicator: the built-in indicator (`rsi`, `sma`, `ema`, `macd`, `bb`, …; the indicator condition's ids)
32
+ * @type {string}
33
+ * @memberof ScriptSeriesInputInput
34
+ */
35
+ indicator_id?: string;
36
+ /**
37
+ * builtin_indicator: which output series (`rsi`, `macd` / `signal` / `histogram`, `upper` / `basis` / `lower`, …)
38
+ * @type {string}
39
+ * @memberof ScriptSeriesInputInput
40
+ */
41
+ series_key?: string;
42
+ /**
43
+ * builtin_indicator: the indicator's parameters (`length`, `source`, …; absent = its defaults)
44
+ * @type {{ [key: string]: any; }}
45
+ * @memberof ScriptSeriesInputInput
46
+ */
47
+ params?: {
48
+ [key: string]: any;
49
+ };
50
+ /**
51
+ * script_output: the `node_key` of the producing node
52
+ * @type {string}
53
+ * @memberof ScriptSeriesInputInput
54
+ */
55
+ node_key?: string;
56
+ /**
57
+ * script_output: the plot slot of the node's script version (its `manifest.plots[].slotId`)
58
+ * @type {string}
59
+ * @memberof ScriptSeriesInputInput
60
+ */
61
+ slot_id?: string;
62
+ }
63
+ /**
64
+ * @export
65
+ */
66
+ export declare const ScriptSeriesInputInputKindEnum: {
67
+ readonly Ohlc: "ohlc";
68
+ readonly BuiltinIndicator: "builtin_indicator";
69
+ readonly ScriptOutput: "script_output";
70
+ };
71
+ export type ScriptSeriesInputInputKindEnum = typeof ScriptSeriesInputInputKindEnum[keyof typeof ScriptSeriesInputInputKindEnum];
72
+ /**
73
+ * @export
74
+ */
75
+ export declare const ScriptSeriesInputInputFieldEnum: {
76
+ readonly Open: "open";
77
+ readonly High: "high";
78
+ readonly Low: "low";
79
+ readonly Close: "close";
80
+ readonly Hl2: "hl2";
81
+ readonly Hlc3: "hlc3";
82
+ readonly Ohlc4: "ohlc4";
83
+ readonly Hlcc4: "hlcc4";
84
+ };
85
+ export type ScriptSeriesInputInputFieldEnum = typeof ScriptSeriesInputInputFieldEnum[keyof typeof ScriptSeriesInputInputFieldEnum];
86
+ /**
87
+ * Check if a given object implements the ScriptSeriesInputInput interface.
88
+ */
89
+ export declare function instanceOfScriptSeriesInputInput(value: object): value is ScriptSeriesInputInput;
90
+ export declare function ScriptSeriesInputInputFromJSON(json: any): ScriptSeriesInputInput;
91
+ export declare function ScriptSeriesInputInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptSeriesInputInput;
92
+ export declare function ScriptSeriesInputInputToJSON(json: any): ScriptSeriesInputInput;
93
+ export declare function ScriptSeriesInputInputToJSONTyped(value?: ScriptSeriesInputInput | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,76 @@
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
+ * @export
16
+ */
17
+ export const ScriptSeriesInputInputKindEnum = {
18
+ Ohlc: 'ohlc',
19
+ BuiltinIndicator: 'builtin_indicator',
20
+ ScriptOutput: 'script_output'
21
+ };
22
+ /**
23
+ * @export
24
+ */
25
+ export const ScriptSeriesInputInputFieldEnum = {
26
+ Open: 'open',
27
+ High: 'high',
28
+ Low: 'low',
29
+ Close: 'close',
30
+ Hl2: 'hl2',
31
+ Hlc3: 'hlc3',
32
+ Ohlc4: 'ohlc4',
33
+ Hlcc4: 'hlcc4'
34
+ };
35
+ /**
36
+ * Check if a given object implements the ScriptSeriesInputInput interface.
37
+ */
38
+ export function instanceOfScriptSeriesInputInput(value) {
39
+ if (!('kind' in value) || value['kind'] === undefined)
40
+ return false;
41
+ return true;
42
+ }
43
+ export function ScriptSeriesInputInputFromJSON(json) {
44
+ return ScriptSeriesInputInputFromJSONTyped(json, false);
45
+ }
46
+ export function ScriptSeriesInputInputFromJSONTyped(json, ignoreDiscriminator) {
47
+ if (json == null) {
48
+ return json;
49
+ }
50
+ return {
51
+ 'kind': json['kind'],
52
+ 'field': json['field'] == null ? undefined : json['field'],
53
+ 'indicator_id': json['indicator_id'] == null ? undefined : json['indicator_id'],
54
+ 'series_key': json['series_key'] == null ? undefined : json['series_key'],
55
+ 'params': json['params'] == null ? undefined : json['params'],
56
+ 'node_key': json['node_key'] == null ? undefined : json['node_key'],
57
+ 'slot_id': json['slot_id'] == null ? undefined : json['slot_id'],
58
+ };
59
+ }
60
+ export function ScriptSeriesInputInputToJSON(json) {
61
+ return ScriptSeriesInputInputToJSONTyped(json, false);
62
+ }
63
+ export function ScriptSeriesInputInputToJSONTyped(value, ignoreDiscriminator = false) {
64
+ if (value == null) {
65
+ return value;
66
+ }
67
+ return {
68
+ 'kind': value['kind'],
69
+ 'field': value['field'],
70
+ 'indicator_id': value['indicator_id'],
71
+ 'series_key': value['series_key'],
72
+ 'params': value['params'],
73
+ 'node_key': value['node_key'],
74
+ 'slot_id': value['slot_id'],
75
+ };
76
+ }
@@ -265,6 +265,12 @@ export * from './RatioPeriod';
265
265
  export * from './ReviewChain';
266
266
  export * from './Script';
267
267
  export * from './ScriptDiagnostic';
268
+ export * from './ScriptEvaluation';
269
+ export * from './ScriptEvaluationInput';
270
+ export * from './ScriptNode';
271
+ export * from './ScriptNodeInput';
272
+ export * from './ScriptSeriesInput';
273
+ export * from './ScriptSeriesInputInput';
268
274
  export * from './ScriptVersion';
269
275
  export * from './SearchCoverage';
270
276
  export * from './SearchCoverageLeg';
@@ -267,6 +267,12 @@ export * from './RatioPeriod';
267
267
  export * from './ReviewChain';
268
268
  export * from './Script';
269
269
  export * from './ScriptDiagnostic';
270
+ export * from './ScriptEvaluation';
271
+ export * from './ScriptEvaluationInput';
272
+ export * from './ScriptNode';
273
+ export * from './ScriptNodeInput';
274
+ export * from './ScriptSeriesInput';
275
+ export * from './ScriptSeriesInputInput';
270
276
  export * from './ScriptVersion';
271
277
  export * from './SearchCoverage';
272
278
  export * from './SearchCoverageLeg';
@@ -11,15 +11,18 @@
11
11
  */
12
12
  import type { IndicatorFilters } from './IndicatorFilters';
13
13
  import type { AlertConditionAmountChange } from './AlertConditionAmountChange';
14
+ import type { ScriptSeriesInput } from './ScriptSeriesInput';
14
15
  import type { AlertConditionMentionDeltaRule } from './AlertConditionMentionDeltaRule';
15
16
  import type { IndicatorTemplateRef } from './IndicatorTemplateRef';
17
+ import type { ScriptEvaluation } from './ScriptEvaluation';
16
18
  import type { AlertConditionRulesInner } from './AlertConditionRulesInner';
19
+ import type { ScriptNode } from './ScriptNode';
17
20
  import type { IndicatorResolved } from './IndicatorResolved';
18
21
  import type { AlertConditionYieldRule } from './AlertConditionYieldRule';
19
22
  import type { AlertConditionYoyRulesInner } from './AlertConditionYoyRulesInner';
20
23
  import type { IndicatorCondition } from './IndicatorCondition';
21
24
  /**
22
- * 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` and an `earnings_call` countdown refuse an ETF by name (400 `invalid_parameter`), `news` / `news_keyword` a series ETF.
25
+ * 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`).
23
26
  * @export
24
27
  * @interface AlertCondition
25
28
  */
@@ -43,7 +46,7 @@ export interface AlertCondition {
43
46
  */
44
47
  cik?: string;
45
48
  /**
46
- * 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)
49
+ * 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, a crypto slug / ticker, or a commodity `XAUUSD` / `XAGUSD`)
47
50
  * @type {string}
48
51
  * @memberof AlertCondition
49
52
  */
@@ -223,7 +226,7 @@ export interface AlertCondition {
223
226
  */
224
227
  notify_on_date_change?: boolean;
225
228
  /**
226
- * 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
229
+ * The instrument's market: `us_stock` (US stocks and ETFs), `crypto` (coins by CoinGecko slug or ticker) or `commodity` (`XAUUSD` / `XAGUSD`, only when named). Absent at create = a stock first, then a coin; stored resolved. price, price_move, volume_spike, price_reminder, script, indicator
227
230
  * @type {AlertConditionAssetClassEnum}
228
231
  * @memberof AlertCondition
229
232
  */
@@ -271,7 +274,7 @@ export interface AlertCondition {
271
274
  */
272
275
  mode?: AlertConditionModeEnum;
273
276
  /**
274
- * 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)
277
+ * The bar evaluated at its close. volume_spike (1m, 5m, 15m, 30m, 1h, 1d, 1w, 1mo; every closed bar); script and indicator (1m, 5m, 15m, 30m, 1h, 4h, 1d, 1w, 1mo; the plan's shortest: FREE / LITE 1h, STANDARD 5m, PRO 1m)
275
278
  * @type {AlertConditionIntervalEnum}
276
279
  * @memberof AlertCondition
277
280
  */
@@ -307,7 +310,7 @@ export interface AlertCondition {
307
310
  */
308
311
  price_direction?: AlertConditionPriceDirectionEnum;
309
312
  /**
310
- * 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
313
+ * 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). With `evaluation` pre_close: one delivery per alert id and session (`every_time`: every signal of the pass; `once`: the first only). price_reminder, script, indicator
311
314
  * @type {AlertConditionFrequencyEnum}
312
315
  * @memberof AlertCondition
313
316
  */
@@ -344,12 +347,32 @@ export interface AlertCondition {
344
347
  inputs?: {
345
348
  [key: string]: any;
346
349
  };
350
+ /**
351
+ * A script chain: what feeds each of the script's `input.externalSeries` inputs, by its input key (every such input must be bound; ≤ 4 `builtin_indicator`, ≤ 16 in the plan). script
352
+ * @type {{ [key: string]: ScriptSeriesInput; }}
353
+ * @memberof AlertCondition
354
+ */
355
+ series_inputs?: {
356
+ [key: string]: ScriptSeriesInput;
357
+ };
358
+ /**
359
+ * The producer scripts `script_output` series inputs read, producers before the nodes that read them (≤ 8 dependencies, ≤ 16,384 bytes with series_inputs). script
360
+ * @type {Array<ScriptNode>}
361
+ * @memberof AlertCondition
362
+ */
363
+ nodes?: Array<ScriptNode>;
347
364
  /**
348
365
  * Only these of the script's alerts (its version's `alert_ids`); empty = all. script
349
366
  * @type {Array<string>}
350
367
  * @memberof AlertCondition
351
368
  */
352
369
  alert_ids?: Array<string>;
370
+ /**
371
+ *
372
+ * @type {ScriptEvaluation}
373
+ * @memberof AlertCondition
374
+ */
375
+ evaluation?: ScriptEvaluation;
353
376
  /**
354
377
  *
355
378
  * @type {IndicatorTemplateRef}
@@ -495,6 +518,7 @@ export type AlertConditionEventEnum = typeof AlertConditionEventEnum[keyof typeo
495
518
  export declare const AlertConditionAssetClassEnum: {
496
519
  readonly UsStock: "us_stock";
497
520
  readonly Crypto: "crypto";
521
+ readonly Commodity: "commodity";
498
522
  };
499
523
  export type AlertConditionAssetClassEnum = typeof AlertConditionAssetClassEnum[keyof typeof AlertConditionAssetClassEnum] | (string & {});
500
524
  /**
@@ -19,11 +19,15 @@ exports.AlertConditionFromJSON = AlertConditionFromJSON;
19
19
  exports.AlertConditionFromJSONTyped = AlertConditionFromJSONTyped;
20
20
  exports.AlertConditionToJSON = AlertConditionToJSON;
21
21
  exports.AlertConditionToJSONTyped = AlertConditionToJSONTyped;
22
+ const runtime_1 = require("../runtime");
22
23
  const IndicatorFilters_1 = require("./IndicatorFilters");
23
24
  const AlertConditionAmountChange_1 = require("./AlertConditionAmountChange");
25
+ const ScriptSeriesInput_1 = require("./ScriptSeriesInput");
24
26
  const AlertConditionMentionDeltaRule_1 = require("./AlertConditionMentionDeltaRule");
25
27
  const IndicatorTemplateRef_1 = require("./IndicatorTemplateRef");
28
+ const ScriptEvaluation_1 = require("./ScriptEvaluation");
26
29
  const AlertConditionRulesInner_1 = require("./AlertConditionRulesInner");
30
+ const ScriptNode_1 = require("./ScriptNode");
27
31
  const IndicatorResolved_1 = require("./IndicatorResolved");
28
32
  const AlertConditionYieldRule_1 = require("./AlertConditionYieldRule");
29
33
  const AlertConditionYoyRulesInner_1 = require("./AlertConditionYoyRulesInner");
@@ -137,7 +141,8 @@ exports.AlertConditionEventEnum = {
137
141
  */
138
142
  exports.AlertConditionAssetClassEnum = {
139
143
  UsStock: 'us_stock',
140
- Crypto: 'crypto'
144
+ Crypto: 'crypto',
145
+ Commodity: 'commodity'
141
146
  };
142
147
  /**
143
148
  * @export
@@ -284,7 +289,10 @@ function AlertConditionFromJSONTyped(json, ignoreDiscriminator) {
284
289
  'days': json['days'] == null ? undefined : json['days'],
285
290
  'script_version_id': json['script_version_id'] == null ? undefined : json['script_version_id'],
286
291
  'inputs': json['inputs'] == null ? undefined : json['inputs'],
292
+ 'series_inputs': json['series_inputs'] == null ? undefined : ((0, runtime_1.mapValues)(json['series_inputs'], ScriptSeriesInput_1.ScriptSeriesInputFromJSON)),
293
+ 'nodes': json['nodes'] == null ? undefined : (json['nodes'].map(ScriptNode_1.ScriptNodeFromJSON)),
287
294
  'alert_ids': json['alert_ids'] == null ? undefined : json['alert_ids'],
295
+ 'evaluation': json['evaluation'] == null ? undefined : (0, ScriptEvaluation_1.ScriptEvaluationFromJSON)(json['evaluation']),
288
296
  'template': json['template'] == null ? undefined : (0, IndicatorTemplateRef_1.IndicatorTemplateRefFromJSON)(json['template']),
289
297
  'condition': json['condition'] == null ? undefined : (0, IndicatorCondition_1.IndicatorConditionFromJSON)(json['condition']),
290
298
  'filters': json['filters'] == null ? undefined : (0, IndicatorFilters_1.IndicatorFiltersFromJSON)(json['filters']),
@@ -352,7 +360,10 @@ function AlertConditionToJSONTyped(value, ignoreDiscriminator = false) {
352
360
  'days': value['days'],
353
361
  'script_version_id': value['script_version_id'],
354
362
  'inputs': value['inputs'],
363
+ 'series_inputs': value['series_inputs'] == null ? undefined : ((0, runtime_1.mapValues)(value['series_inputs'], ScriptSeriesInput_1.ScriptSeriesInputToJSON)),
364
+ 'nodes': value['nodes'] == null ? undefined : (value['nodes'].map(ScriptNode_1.ScriptNodeToJSON)),
355
365
  'alert_ids': value['alert_ids'],
366
+ 'evaluation': (0, ScriptEvaluation_1.ScriptEvaluationToJSON)(value['evaluation']),
356
367
  'template': (0, IndicatorTemplateRef_1.IndicatorTemplateRefToJSON)(value['template']),
357
368
  'condition': (0, IndicatorCondition_1.IndicatorConditionToJSON)(value['condition']),
358
369
  'filters': (0, IndicatorFilters_1.IndicatorFiltersToJSON)(value['filters']),
@@ -11,14 +11,17 @@
11
11
  */
12
12
  import type { AlertConditionInputAmountChange } from './AlertConditionInputAmountChange';
13
13
  import type { AlertConditionInputMentionDeltaRule } from './AlertConditionInputMentionDeltaRule';
14
+ import type { ScriptSeriesInputInput } from './ScriptSeriesInputInput';
14
15
  import type { IndicatorTemplateRef } from './IndicatorTemplateRef';
15
16
  import type { IndicatorConditionInput } from './IndicatorConditionInput';
16
17
  import type { AlertConditionInputYoyRulesInner } from './AlertConditionInputYoyRulesInner';
18
+ import type { ScriptEvaluationInput } from './ScriptEvaluationInput';
17
19
  import type { AlertConditionInputRulesInner } from './AlertConditionInputRulesInner';
18
20
  import type { AlertConditionInputYieldRule } from './AlertConditionInputYieldRule';
19
21
  import type { IndicatorFiltersInput } from './IndicatorFiltersInput';
22
+ import type { ScriptNodeInput } from './ScriptNodeInput';
20
23
  /**
21
- * 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` and an `earnings_call` countdown refuse an ETF by name (400 `invalid_parameter`), `news` / `news_keyword` a series ETF.
24
+ * 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`).
22
25
  * @export
23
26
  * @interface AlertConditionInput
24
27
  */
@@ -42,7 +45,7 @@ export interface AlertConditionInput {
42
45
  */
43
46
  cik?: string;
44
47
  /**
45
- * 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)
48
+ * 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, a crypto slug / ticker, or a commodity `XAUUSD` / `XAGUSD`)
46
49
  * @type {string}
47
50
  * @memberof AlertConditionInput
48
51
  */
@@ -222,7 +225,7 @@ export interface AlertConditionInput {
222
225
  */
223
226
  notify_on_date_change?: boolean;
224
227
  /**
225
- * 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
228
+ * The instrument's market: `us_stock` (US stocks and ETFs), `crypto` (coins by CoinGecko slug or ticker) or `commodity` (`XAUUSD` / `XAGUSD`, only when named). Absent at create = a stock first, then a coin; stored resolved. price, price_move, volume_spike, price_reminder, script, indicator
226
229
  * @type {AlertConditionInputAssetClassEnum}
227
230
  * @memberof AlertConditionInput
228
231
  */
@@ -270,7 +273,7 @@ export interface AlertConditionInput {
270
273
  */
271
274
  mode?: AlertConditionInputModeEnum;
272
275
  /**
273
- * 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)
276
+ * The bar evaluated at its close. volume_spike (1m, 5m, 15m, 30m, 1h, 1d, 1w, 1mo; every closed bar); script and indicator (1m, 5m, 15m, 30m, 1h, 4h, 1d, 1w, 1mo; the plan's shortest: FREE / LITE 1h, STANDARD 5m, PRO 1m)
274
277
  * @type {AlertConditionInputIntervalEnum}
275
278
  * @memberof AlertConditionInput
276
279
  */
@@ -306,7 +309,7 @@ export interface AlertConditionInput {
306
309
  */
307
310
  price_direction?: AlertConditionInputPriceDirectionEnum;
308
311
  /**
309
- * 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
312
+ * 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). With `evaluation` pre_close: one delivery per alert id and session (`every_time`: every signal of the pass; `once`: the first only). price_reminder, script, indicator
310
313
  * @type {AlertConditionInputFrequencyEnum}
311
314
  * @memberof AlertConditionInput
312
315
  */
@@ -343,12 +346,32 @@ export interface AlertConditionInput {
343
346
  inputs?: {
344
347
  [key: string]: any;
345
348
  };
349
+ /**
350
+ * A script chain: what feeds each of the script's `input.externalSeries` inputs, by its input key (every such input must be bound; ≤ 4 `builtin_indicator`, ≤ 16 in the plan). script
351
+ * @type {{ [key: string]: ScriptSeriesInputInput; }}
352
+ * @memberof AlertConditionInput
353
+ */
354
+ series_inputs?: {
355
+ [key: string]: ScriptSeriesInputInput;
356
+ };
357
+ /**
358
+ * The producer scripts `script_output` series inputs read, producers before the nodes that read them (≤ 8 dependencies, ≤ 16,384 bytes with series_inputs). script
359
+ * @type {Array<ScriptNodeInput>}
360
+ * @memberof AlertConditionInput
361
+ */
362
+ nodes?: Array<ScriptNodeInput>;
346
363
  /**
347
364
  * Only these of the script's alerts (its version's `alert_ids`); empty = all. script
348
365
  * @type {Array<string>}
349
366
  * @memberof AlertConditionInput
350
367
  */
351
368
  alert_ids?: Array<string>;
369
+ /**
370
+ *
371
+ * @type {ScriptEvaluationInput}
372
+ * @memberof AlertConditionInput
373
+ */
374
+ evaluation?: ScriptEvaluationInput;
352
375
  /**
353
376
  *
354
377
  * @type {IndicatorTemplateRef}
@@ -488,6 +511,7 @@ export type AlertConditionInputEventEnum = typeof AlertConditionInputEventEnum[k
488
511
  export declare const AlertConditionInputAssetClassEnum: {
489
512
  readonly UsStock: "us_stock";
490
513
  readonly Crypto: "crypto";
514
+ readonly Commodity: "commodity";
491
515
  };
492
516
  export type AlertConditionInputAssetClassEnum = typeof AlertConditionInputAssetClassEnum[keyof typeof AlertConditionInputAssetClassEnum];
493
517
  /**
@@ -19,14 +19,18 @@ exports.AlertConditionInputFromJSON = AlertConditionInputFromJSON;
19
19
  exports.AlertConditionInputFromJSONTyped = AlertConditionInputFromJSONTyped;
20
20
  exports.AlertConditionInputToJSON = AlertConditionInputToJSON;
21
21
  exports.AlertConditionInputToJSONTyped = AlertConditionInputToJSONTyped;
22
+ const runtime_1 = require("../runtime");
22
23
  const AlertConditionInputAmountChange_1 = require("./AlertConditionInputAmountChange");
23
24
  const AlertConditionInputMentionDeltaRule_1 = require("./AlertConditionInputMentionDeltaRule");
25
+ const ScriptSeriesInputInput_1 = require("./ScriptSeriesInputInput");
24
26
  const IndicatorTemplateRef_1 = require("./IndicatorTemplateRef");
25
27
  const IndicatorConditionInput_1 = require("./IndicatorConditionInput");
26
28
  const AlertConditionInputYoyRulesInner_1 = require("./AlertConditionInputYoyRulesInner");
29
+ const ScriptEvaluationInput_1 = require("./ScriptEvaluationInput");
27
30
  const AlertConditionInputRulesInner_1 = require("./AlertConditionInputRulesInner");
28
31
  const AlertConditionInputYieldRule_1 = require("./AlertConditionInputYieldRule");
29
32
  const IndicatorFiltersInput_1 = require("./IndicatorFiltersInput");
33
+ const ScriptNodeInput_1 = require("./ScriptNodeInput");
30
34
  /**
31
35
  * @export
32
36
  */
@@ -136,7 +140,8 @@ exports.AlertConditionInputEventEnum = {
136
140
  */
137
141
  exports.AlertConditionInputAssetClassEnum = {
138
142
  UsStock: 'us_stock',
139
- Crypto: 'crypto'
143
+ Crypto: 'crypto',
144
+ Commodity: 'commodity'
140
145
  };
141
146
  /**
142
147
  * @export
@@ -283,7 +288,10 @@ function AlertConditionInputFromJSONTyped(json, ignoreDiscriminator) {
283
288
  'days': json['days'] == null ? undefined : json['days'],
284
289
  'script_version_id': json['script_version_id'] == null ? undefined : json['script_version_id'],
285
290
  'inputs': json['inputs'] == null ? undefined : json['inputs'],
291
+ 'series_inputs': json['series_inputs'] == null ? undefined : ((0, runtime_1.mapValues)(json['series_inputs'], ScriptSeriesInputInput_1.ScriptSeriesInputInputFromJSON)),
292
+ 'nodes': json['nodes'] == null ? undefined : (json['nodes'].map(ScriptNodeInput_1.ScriptNodeInputFromJSON)),
286
293
  'alert_ids': json['alert_ids'] == null ? undefined : json['alert_ids'],
294
+ 'evaluation': json['evaluation'] == null ? undefined : (0, ScriptEvaluationInput_1.ScriptEvaluationInputFromJSON)(json['evaluation']),
287
295
  'template': json['template'] == null ? undefined : (0, IndicatorTemplateRef_1.IndicatorTemplateRefFromJSON)(json['template']),
288
296
  'condition': json['condition'] == null ? undefined : (0, IndicatorConditionInput_1.IndicatorConditionInputFromJSON)(json['condition']),
289
297
  'filters': json['filters'] == null ? undefined : (0, IndicatorFiltersInput_1.IndicatorFiltersInputFromJSON)(json['filters']),
@@ -350,7 +358,10 @@ function AlertConditionInputToJSONTyped(value, ignoreDiscriminator = false) {
350
358
  'days': value['days'],
351
359
  'script_version_id': value['script_version_id'],
352
360
  'inputs': value['inputs'],
361
+ 'series_inputs': value['series_inputs'] == null ? undefined : ((0, runtime_1.mapValues)(value['series_inputs'], ScriptSeriesInputInput_1.ScriptSeriesInputInputToJSON)),
362
+ 'nodes': value['nodes'] == null ? undefined : (value['nodes'].map(ScriptNodeInput_1.ScriptNodeInputToJSON)),
353
363
  'alert_ids': value['alert_ids'],
364
+ 'evaluation': (0, ScriptEvaluationInput_1.ScriptEvaluationInputToJSON)(value['evaluation']),
354
365
  'template': (0, IndicatorTemplateRef_1.IndicatorTemplateRefToJSON)(value['template']),
355
366
  'condition': (0, IndicatorConditionInput_1.IndicatorConditionInputToJSON)(value['condition']),
356
367
  'filters': (0, IndicatorFiltersInput_1.IndicatorFiltersInputToJSON)(value['filters']),
@@ -23,13 +23,13 @@ export interface AlertTrigger {
23
23
  */
24
24
  mode?: AlertTriggerModeEnum;
25
25
  /**
26
- * Minimum seconds between fires
26
+ * Minimum seconds between fires (at most 366 days)
27
27
  * @type {number}
28
28
  * @memberof AlertTrigger
29
29
  */
30
30
  cooldown_seconds?: number;
31
31
  /**
32
- * 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
32
+ * 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 (half a bar of slack: a calendar `1mo` / `1w` / `1d` bar shorter than the nominal interval, a February or a DST day, still counts as a whole bar)
33
33
  * @type {number}
34
34
  * @memberof AlertTrigger
35
35
  */