@invinite-org/data-api-client 6.1.0 → 6.3.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 (224) hide show
  1. package/.openapi-generator/FILES +52 -0
  2. package/dist/apis/FilingsApi.d.ts +2 -2
  3. package/dist/apis/FilingsApi.js +2 -2
  4. package/dist/apis/ReferenceApi.d.ts +4 -4
  5. package/dist/apis/ReferenceApi.js +4 -4
  6. package/dist/apis/ScriptsApi.d.ts +148 -0
  7. package/dist/apis/ScriptsApi.js +396 -0
  8. package/dist/apis/index.d.ts +1 -0
  9. package/dist/apis/index.js +1 -0
  10. package/dist/esm/apis/FilingsApi.d.ts +2 -2
  11. package/dist/esm/apis/FilingsApi.js +2 -2
  12. package/dist/esm/apis/ReferenceApi.d.ts +4 -4
  13. package/dist/esm/apis/ReferenceApi.js +4 -4
  14. package/dist/esm/apis/ScriptsApi.d.ts +148 -0
  15. package/dist/esm/apis/ScriptsApi.js +392 -0
  16. package/dist/esm/apis/index.d.ts +1 -0
  17. package/dist/esm/apis/index.js +1 -0
  18. package/dist/esm/models/Alert.d.ts +6 -0
  19. package/dist/esm/models/Alert.js +4 -0
  20. package/dist/esm/models/AlertCondition.d.ts +62 -6
  21. package/dist/esm/models/AlertCondition.js +27 -1
  22. package/dist/esm/models/AlertConditionInput.d.ts +55 -6
  23. package/dist/esm/models/AlertConditionInput.js +24 -1
  24. package/dist/esm/models/AlertTemplate.d.ts +83 -0
  25. package/dist/esm/models/AlertTemplate.js +79 -0
  26. package/dist/esm/models/AlertTemplateInput.d.ts +78 -0
  27. package/dist/esm/models/AlertTemplateInput.js +70 -0
  28. package/dist/esm/models/AlertTrigger.d.ts +1 -1
  29. package/dist/esm/models/AlertTriggerInput.d.ts +1 -1
  30. package/dist/esm/models/Company.d.ts +8 -8
  31. package/dist/esm/models/CompanyListItem.d.ts +1 -1
  32. package/dist/esm/models/CompanyRef.d.ts +1 -1
  33. package/dist/esm/models/CreateScriptRequest.d.ts +44 -0
  34. package/dist/esm/models/CreateScriptRequest.js +49 -0
  35. package/dist/esm/models/CreateScriptVersionRequest.d.ts +32 -0
  36. package/dist/esm/models/CreateScriptVersionRequest.js +43 -0
  37. package/dist/esm/models/IndicatorCondition.d.ts +56 -0
  38. package/dist/esm/models/IndicatorCondition.js +62 -0
  39. package/dist/esm/models/IndicatorConditionInput.d.ts +56 -0
  40. package/dist/esm/models/IndicatorConditionInput.js +62 -0
  41. package/dist/esm/models/IndicatorFilterChild.d.ts +68 -0
  42. package/dist/esm/models/IndicatorFilterChild.js +65 -0
  43. package/dist/esm/models/IndicatorFilterChildInput.d.ts +68 -0
  44. package/dist/esm/models/IndicatorFilterChildInput.js +65 -0
  45. package/dist/esm/models/IndicatorFilterCondition.d.ts +73 -0
  46. package/dist/esm/models/IndicatorFilterCondition.js +74 -0
  47. package/dist/esm/models/IndicatorFilterConditionInput.d.ts +73 -0
  48. package/dist/esm/models/IndicatorFilterConditionInput.js +74 -0
  49. package/dist/esm/models/IndicatorFilterLeaf.d.ts +46 -0
  50. package/dist/esm/models/IndicatorFilterLeaf.js +54 -0
  51. package/dist/esm/models/IndicatorFilterLeafInput.d.ts +46 -0
  52. package/dist/esm/models/IndicatorFilterLeafInput.js +56 -0
  53. package/dist/esm/models/IndicatorFilters.d.ts +47 -0
  54. package/dist/esm/models/IndicatorFilters.js +55 -0
  55. package/dist/esm/models/IndicatorFiltersInput.d.ts +47 -0
  56. package/dist/esm/models/IndicatorFiltersInput.js +55 -0
  57. package/dist/esm/models/IndicatorOperand.d.ts +91 -0
  58. package/dist/esm/models/IndicatorOperand.js +74 -0
  59. package/dist/esm/models/IndicatorOperandInput.d.ts +91 -0
  60. package/dist/esm/models/IndicatorOperandInput.js +74 -0
  61. package/dist/esm/models/IndicatorResolved.d.ts +67 -0
  62. package/dist/esm/models/IndicatorResolved.js +65 -0
  63. package/dist/esm/models/IndicatorResolvedThreshold.d.ts +47 -0
  64. package/dist/esm/models/IndicatorResolvedThreshold.js +55 -0
  65. package/dist/esm/models/IndicatorTemplateRef.d.ts +46 -0
  66. package/dist/esm/models/IndicatorTemplateRef.js +47 -0
  67. package/dist/esm/models/ListAlertTemplates200Response.d.ts +52 -0
  68. package/dist/esm/models/ListAlertTemplates200Response.js +57 -0
  69. package/dist/esm/models/ListScriptVersions200Response.d.ts +52 -0
  70. package/dist/esm/models/ListScriptVersions200Response.js +57 -0
  71. package/dist/esm/models/ListScripts200Response.d.ts +52 -0
  72. package/dist/esm/models/ListScripts200Response.js +57 -0
  73. package/dist/esm/models/Script.d.ts +69 -0
  74. package/dist/esm/models/Script.js +68 -0
  75. package/dist/esm/models/ScriptDiagnostic.d.ts +64 -0
  76. package/dist/esm/models/ScriptDiagnostic.js +66 -0
  77. package/dist/esm/models/ScriptVersion.d.ts +103 -0
  78. package/dist/esm/models/ScriptVersion.js +91 -0
  79. package/dist/esm/models/index.d.ts +25 -0
  80. package/dist/esm/models/index.js +25 -0
  81. package/dist/models/Alert.d.ts +6 -0
  82. package/dist/models/Alert.js +4 -0
  83. package/dist/models/AlertCondition.d.ts +62 -6
  84. package/dist/models/AlertCondition.js +27 -1
  85. package/dist/models/AlertConditionInput.d.ts +55 -6
  86. package/dist/models/AlertConditionInput.js +24 -1
  87. package/dist/models/AlertTemplate.d.ts +83 -0
  88. package/dist/models/AlertTemplate.js +87 -0
  89. package/dist/models/AlertTemplateInput.d.ts +78 -0
  90. package/dist/models/AlertTemplateInput.js +78 -0
  91. package/dist/models/AlertTrigger.d.ts +1 -1
  92. package/dist/models/AlertTriggerInput.d.ts +1 -1
  93. package/dist/models/Company.d.ts +8 -8
  94. package/dist/models/CompanyListItem.d.ts +1 -1
  95. package/dist/models/CompanyRef.d.ts +1 -1
  96. package/dist/models/CreateScriptRequest.d.ts +44 -0
  97. package/dist/models/CreateScriptRequest.js +56 -0
  98. package/dist/models/CreateScriptVersionRequest.d.ts +32 -0
  99. package/dist/models/CreateScriptVersionRequest.js +50 -0
  100. package/dist/models/IndicatorCondition.d.ts +56 -0
  101. package/dist/models/IndicatorCondition.js +70 -0
  102. package/dist/models/IndicatorConditionInput.d.ts +56 -0
  103. package/dist/models/IndicatorConditionInput.js +70 -0
  104. package/dist/models/IndicatorFilterChild.d.ts +68 -0
  105. package/dist/models/IndicatorFilterChild.js +73 -0
  106. package/dist/models/IndicatorFilterChildInput.d.ts +68 -0
  107. package/dist/models/IndicatorFilterChildInput.js +73 -0
  108. package/dist/models/IndicatorFilterCondition.d.ts +73 -0
  109. package/dist/models/IndicatorFilterCondition.js +82 -0
  110. package/dist/models/IndicatorFilterConditionInput.d.ts +73 -0
  111. package/dist/models/IndicatorFilterConditionInput.js +82 -0
  112. package/dist/models/IndicatorFilterLeaf.d.ts +46 -0
  113. package/dist/models/IndicatorFilterLeaf.js +62 -0
  114. package/dist/models/IndicatorFilterLeafInput.d.ts +46 -0
  115. package/dist/models/IndicatorFilterLeafInput.js +64 -0
  116. package/dist/models/IndicatorFilters.d.ts +47 -0
  117. package/dist/models/IndicatorFilters.js +63 -0
  118. package/dist/models/IndicatorFiltersInput.d.ts +47 -0
  119. package/dist/models/IndicatorFiltersInput.js +63 -0
  120. package/dist/models/IndicatorOperand.d.ts +91 -0
  121. package/dist/models/IndicatorOperand.js +82 -0
  122. package/dist/models/IndicatorOperandInput.d.ts +91 -0
  123. package/dist/models/IndicatorOperandInput.js +82 -0
  124. package/dist/models/IndicatorResolved.d.ts +67 -0
  125. package/dist/models/IndicatorResolved.js +73 -0
  126. package/dist/models/IndicatorResolvedThreshold.d.ts +47 -0
  127. package/dist/models/IndicatorResolvedThreshold.js +63 -0
  128. package/dist/models/IndicatorTemplateRef.d.ts +46 -0
  129. package/dist/models/IndicatorTemplateRef.js +54 -0
  130. package/dist/models/ListAlertTemplates200Response.d.ts +52 -0
  131. package/dist/models/ListAlertTemplates200Response.js +64 -0
  132. package/dist/models/ListScriptVersions200Response.d.ts +52 -0
  133. package/dist/models/ListScriptVersions200Response.js +64 -0
  134. package/dist/models/ListScripts200Response.d.ts +52 -0
  135. package/dist/models/ListScripts200Response.js +64 -0
  136. package/dist/models/Script.d.ts +69 -0
  137. package/dist/models/Script.js +75 -0
  138. package/dist/models/ScriptDiagnostic.d.ts +64 -0
  139. package/dist/models/ScriptDiagnostic.js +74 -0
  140. package/dist/models/ScriptVersion.d.ts +103 -0
  141. package/dist/models/ScriptVersion.js +99 -0
  142. package/dist/models/index.d.ts +25 -0
  143. package/dist/models/index.js +25 -0
  144. package/docs/Alert.md +2 -0
  145. package/docs/AlertCondition.md +15 -1
  146. package/docs/AlertConditionInput.md +13 -1
  147. package/docs/AlertTemplate.md +49 -0
  148. package/docs/AlertTemplateInput.md +47 -0
  149. package/docs/CompaniesApi.md +2 -2
  150. package/docs/CreateScriptRequest.md +38 -0
  151. package/docs/CreateScriptVersionRequest.md +34 -0
  152. package/docs/EventsApi.md +2 -2
  153. package/docs/FilingsApi.md +5 -5
  154. package/docs/FinancialsApi.md +12 -12
  155. package/docs/GuidanceApi.md +4 -4
  156. package/docs/HoldingsApi.md +6 -6
  157. package/docs/IPOsApi.md +2 -2
  158. package/docs/IndicatorCondition.md +39 -0
  159. package/docs/IndicatorConditionInput.md +39 -0
  160. package/docs/IndicatorFilterChild.md +41 -0
  161. package/docs/IndicatorFilterChildInput.md +41 -0
  162. package/docs/IndicatorFilterCondition.md +41 -0
  163. package/docs/IndicatorFilterConditionInput.md +41 -0
  164. package/docs/IndicatorFilterLeaf.md +37 -0
  165. package/docs/IndicatorFilterLeafInput.md +37 -0
  166. package/docs/IndicatorFilters.md +37 -0
  167. package/docs/IndicatorFiltersInput.md +37 -0
  168. package/docs/IndicatorOperand.md +47 -0
  169. package/docs/IndicatorOperandInput.md +47 -0
  170. package/docs/IndicatorResolved.md +43 -0
  171. package/docs/IndicatorResolvedThreshold.md +37 -0
  172. package/docs/IndicatorTemplateRef.md +39 -0
  173. package/docs/InsiderTradesApi.md +2 -2
  174. package/docs/InvestorDocumentsApi.md +4 -4
  175. package/docs/ListAlertTemplates200Response.md +41 -0
  176. package/docs/ListScriptVersions200Response.md +41 -0
  177. package/docs/ListScripts200Response.md +41 -0
  178. package/docs/MetricsApi.md +10 -10
  179. package/docs/NewsApi.md +6 -6
  180. package/docs/ReferenceApi.md +8 -8
  181. package/docs/Script.md +46 -0
  182. package/docs/ScriptDiagnostic.md +42 -0
  183. package/docs/ScriptVersion.md +54 -0
  184. package/docs/ScriptsApi.md +588 -0
  185. package/docs/TranscriptsApi.md +2 -2
  186. package/package.json +1 -1
  187. package/src/apis/FilingsApi.ts +2 -2
  188. package/src/apis/ReferenceApi.ts +4 -4
  189. package/src/apis/ScriptsApi.ts +504 -0
  190. package/src/apis/index.ts +1 -0
  191. package/src/models/Alert.ts +9 -0
  192. package/src/models/AlertCondition.ts +99 -7
  193. package/src/models/AlertConditionInput.ts +84 -7
  194. package/src/models/AlertTemplate.ts +148 -0
  195. package/src/models/AlertTemplateInput.ts +130 -0
  196. package/src/models/AlertTrigger.ts +1 -1
  197. package/src/models/AlertTriggerInput.ts +1 -1
  198. package/src/models/Company.ts +8 -8
  199. package/src/models/CompanyListItem.ts +1 -1
  200. package/src/models/CompanyRef.ts +1 -1
  201. package/src/models/CreateScriptRequest.ts +83 -0
  202. package/src/models/CreateScriptVersionRequest.ts +66 -0
  203. package/src/models/IndicatorCondition.ts +106 -0
  204. package/src/models/IndicatorConditionInput.ts +106 -0
  205. package/src/models/IndicatorFilterChild.ts +125 -0
  206. package/src/models/IndicatorFilterChildInput.ts +125 -0
  207. package/src/models/IndicatorFilterCondition.ts +126 -0
  208. package/src/models/IndicatorFilterConditionInput.ts +126 -0
  209. package/src/models/IndicatorFilterLeaf.ts +93 -0
  210. package/src/models/IndicatorFilterLeafInput.ts +95 -0
  211. package/src/models/IndicatorFilters.ts +94 -0
  212. package/src/models/IndicatorFiltersInput.ts +94 -0
  213. package/src/models/IndicatorOperand.ts +139 -0
  214. package/src/models/IndicatorOperandInput.ts +139 -0
  215. package/src/models/IndicatorResolved.ts +120 -0
  216. package/src/models/IndicatorResolvedThreshold.ts +87 -0
  217. package/src/models/IndicatorTemplateRef.ts +82 -0
  218. package/src/models/ListAlertTemplates200Response.ts +108 -0
  219. package/src/models/ListScriptVersions200Response.ts +108 -0
  220. package/src/models/ListScripts200Response.ts +108 -0
  221. package/src/models/Script.ts +128 -0
  222. package/src/models/ScriptDiagnostic.ts +113 -0
  223. package/src/models/ScriptVersion.ts +175 -0
  224. package/src/models/index.ts +25 -0
@@ -0,0 +1,74 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Invinite API
6
+ * 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.
7
+ *
8
+ * The version of the OpenAPI document: 2026-11-13
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.ScriptDiagnosticSeverityEnum = void 0;
17
+ exports.instanceOfScriptDiagnostic = instanceOfScriptDiagnostic;
18
+ exports.ScriptDiagnosticFromJSON = ScriptDiagnosticFromJSON;
19
+ exports.ScriptDiagnosticFromJSONTyped = ScriptDiagnosticFromJSONTyped;
20
+ exports.ScriptDiagnosticToJSON = ScriptDiagnosticToJSON;
21
+ exports.ScriptDiagnosticToJSONTyped = ScriptDiagnosticToJSONTyped;
22
+ /**
23
+ * @export
24
+ */
25
+ exports.ScriptDiagnosticSeverityEnum = {
26
+ Error: 'error',
27
+ Warning: 'warning'
28
+ };
29
+ /**
30
+ * Check if a given object implements the ScriptDiagnostic interface.
31
+ */
32
+ function instanceOfScriptDiagnostic(value) {
33
+ if (!('line' in value) || value['line'] === undefined)
34
+ return false;
35
+ if (!('column' in value) || value['column'] === undefined)
36
+ return false;
37
+ if (!('message' in value) || value['message'] === undefined)
38
+ return false;
39
+ if (!('code' in value) || value['code'] === undefined)
40
+ return false;
41
+ if (!('severity' in value) || value['severity'] === undefined)
42
+ return false;
43
+ return true;
44
+ }
45
+ function ScriptDiagnosticFromJSON(json) {
46
+ return ScriptDiagnosticFromJSONTyped(json, false);
47
+ }
48
+ function ScriptDiagnosticFromJSONTyped(json, ignoreDiscriminator) {
49
+ if (json == null) {
50
+ return json;
51
+ }
52
+ return {
53
+ 'line': json['line'],
54
+ 'column': json['column'],
55
+ 'message': json['message'],
56
+ 'code': json['code'],
57
+ 'severity': json['severity'],
58
+ };
59
+ }
60
+ function ScriptDiagnosticToJSON(json) {
61
+ return ScriptDiagnosticToJSONTyped(json, false);
62
+ }
63
+ function ScriptDiagnosticToJSONTyped(value, ignoreDiscriminator = false) {
64
+ if (value == null) {
65
+ return value;
66
+ }
67
+ return {
68
+ 'line': value['line'],
69
+ 'column': value['column'],
70
+ 'message': value['message'],
71
+ 'code': value['code'],
72
+ 'severity': value['severity'],
73
+ };
74
+ }
@@ -0,0 +1,103 @@
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
+ import type { ScriptDiagnostic } from './ScriptDiagnostic';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface ScriptVersion
17
+ */
18
+ export interface ScriptVersion {
19
+ /**
20
+ * Script version id (`scv_…`); the `script_version_id` of a `script` alert
21
+ * @type {string}
22
+ * @memberof ScriptVersion
23
+ */
24
+ id: string;
25
+ /**
26
+ * Script id (`scr_…`)
27
+ * @type {string}
28
+ * @memberof ScriptVersion
29
+ */
30
+ script_id: string;
31
+ /**
32
+ * 1, 2, … per script (at most 20)
33
+ * @type {number}
34
+ * @memberof ScriptVersion
35
+ */
36
+ version: number;
37
+ /**
38
+ * `ok` = compiled, usable in alerts; `error` = see `diagnostics`
39
+ * @type {ScriptVersionStatusEnum}
40
+ * @memberof ScriptVersion
41
+ */
42
+ status: ScriptVersionStatusEnum;
43
+ /**
44
+ * The chartlang compiler that built it (pinned per version)
45
+ * @type {string}
46
+ * @memberof ScriptVersion
47
+ */
48
+ compiler_version: string;
49
+ /**
50
+ * SHA-256 (hex) of `source`
51
+ * @type {string}
52
+ * @memberof ScriptVersion
53
+ */
54
+ source_sha256: string;
55
+ /**
56
+ * The source as uploaded
57
+ * @type {string}
58
+ * @memberof ScriptVersion
59
+ */
60
+ source: string;
61
+ /**
62
+ * Compile errors (status error) or warnings
63
+ * @type {Array<ScriptDiagnostic>}
64
+ * @memberof ScriptVersion
65
+ */
66
+ diagnostics: Array<ScriptDiagnostic>;
67
+ /**
68
+ * The compiler's manifest (name, kind, inputs, alertConditions, requestedIntervals, …); null when the compile failed
69
+ * @type {{ [key: string]: any; }}
70
+ * @memberof ScriptVersion
71
+ */
72
+ manifest: {
73
+ [key: string]: any;
74
+ } | null;
75
+ /**
76
+ * The ids a `script` alert's `condition.alert_ids` can name: the `defineAlertCondition` ids and the `alert()` callsite ids
77
+ * @type {Array<string>}
78
+ * @memberof ScriptVersion
79
+ */
80
+ alert_ids: Array<string>;
81
+ /**
82
+ *
83
+ * @type {Date}
84
+ * @memberof ScriptVersion
85
+ */
86
+ created_at: Date;
87
+ }
88
+ /**
89
+ * @export
90
+ */
91
+ export declare const ScriptVersionStatusEnum: {
92
+ readonly Ok: "ok";
93
+ readonly Error: "error";
94
+ };
95
+ export type ScriptVersionStatusEnum = typeof ScriptVersionStatusEnum[keyof typeof ScriptVersionStatusEnum] | (string & {});
96
+ /**
97
+ * Check if a given object implements the ScriptVersion interface.
98
+ */
99
+ export declare function instanceOfScriptVersion(value: object): value is ScriptVersion;
100
+ export declare function ScriptVersionFromJSON(json: any): ScriptVersion;
101
+ export declare function ScriptVersionFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptVersion;
102
+ export declare function ScriptVersionToJSON(json: any): ScriptVersion;
103
+ export declare function ScriptVersionToJSONTyped(value?: ScriptVersion | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,99 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Invinite API
6
+ * 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.
7
+ *
8
+ * The version of the OpenAPI document: 2026-11-13
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.ScriptVersionStatusEnum = void 0;
17
+ exports.instanceOfScriptVersion = instanceOfScriptVersion;
18
+ exports.ScriptVersionFromJSON = ScriptVersionFromJSON;
19
+ exports.ScriptVersionFromJSONTyped = ScriptVersionFromJSONTyped;
20
+ exports.ScriptVersionToJSON = ScriptVersionToJSON;
21
+ exports.ScriptVersionToJSONTyped = ScriptVersionToJSONTyped;
22
+ const ScriptDiagnostic_1 = require("./ScriptDiagnostic");
23
+ /**
24
+ * @export
25
+ */
26
+ exports.ScriptVersionStatusEnum = {
27
+ Ok: 'ok',
28
+ Error: 'error'
29
+ };
30
+ /**
31
+ * Check if a given object implements the ScriptVersion interface.
32
+ */
33
+ function instanceOfScriptVersion(value) {
34
+ if (!('id' in value) || value['id'] === undefined)
35
+ return false;
36
+ if (!('script_id' in value) || value['script_id'] === undefined)
37
+ return false;
38
+ if (!('version' in value) || value['version'] === undefined)
39
+ return false;
40
+ if (!('status' in value) || value['status'] === undefined)
41
+ return false;
42
+ if (!('compiler_version' in value) || value['compiler_version'] === undefined)
43
+ return false;
44
+ if (!('source_sha256' in value) || value['source_sha256'] === undefined)
45
+ return false;
46
+ if (!('source' in value) || value['source'] === undefined)
47
+ return false;
48
+ if (!('diagnostics' in value) || value['diagnostics'] === undefined)
49
+ return false;
50
+ if (!('manifest' in value) || value['manifest'] === undefined)
51
+ return false;
52
+ if (!('alert_ids' in value) || value['alert_ids'] === undefined)
53
+ return false;
54
+ if (!('created_at' in value) || value['created_at'] === undefined)
55
+ return false;
56
+ return true;
57
+ }
58
+ function ScriptVersionFromJSON(json) {
59
+ return ScriptVersionFromJSONTyped(json, false);
60
+ }
61
+ function ScriptVersionFromJSONTyped(json, ignoreDiscriminator) {
62
+ if (json == null) {
63
+ return json;
64
+ }
65
+ return {
66
+ 'id': json['id'],
67
+ 'script_id': json['script_id'],
68
+ 'version': json['version'],
69
+ 'status': json['status'],
70
+ 'compiler_version': json['compiler_version'],
71
+ 'source_sha256': json['source_sha256'],
72
+ 'source': json['source'],
73
+ 'diagnostics': (json['diagnostics'].map(ScriptDiagnostic_1.ScriptDiagnosticFromJSON)),
74
+ 'manifest': json['manifest'],
75
+ 'alert_ids': json['alert_ids'],
76
+ 'created_at': (new Date(json['created_at'])),
77
+ };
78
+ }
79
+ function ScriptVersionToJSON(json) {
80
+ return ScriptVersionToJSONTyped(json, false);
81
+ }
82
+ function ScriptVersionToJSONTyped(value, ignoreDiscriminator = false) {
83
+ if (value == null) {
84
+ return value;
85
+ }
86
+ return {
87
+ 'id': value['id'],
88
+ 'script_id': value['script_id'],
89
+ 'version': value['version'],
90
+ 'status': value['status'],
91
+ 'compiler_version': value['compiler_version'],
92
+ 'source_sha256': value['source_sha256'],
93
+ 'source': value['source'],
94
+ 'diagnostics': (value['diagnostics'].map(ScriptDiagnostic_1.ScriptDiagnosticToJSON)),
95
+ 'manifest': value['manifest'],
96
+ 'alert_ids': value['alert_ids'],
97
+ 'created_at': value['created_at'].toISOString(),
98
+ };
99
+ }
@@ -17,6 +17,8 @@ export * from './AlertConditionYieldRule';
17
17
  export * from './AlertConditionYoyRulesInner';
18
18
  export * from './AlertEvent';
19
19
  export * from './AlertQuotaUsage';
20
+ export * from './AlertTemplate';
21
+ export * from './AlertTemplateInput';
20
22
  export * from './AlertTestAccepted';
21
23
  export * from './AlertTrigger';
22
24
  export * from './AlertTriggerActiveWindow';
@@ -48,6 +50,8 @@ export * from './CompanyListItem';
48
50
  export * from './CompanyRef';
49
51
  export * from './CreateAlertRequest';
50
52
  export * from './CreateDestinationRequest';
53
+ export * from './CreateScriptRequest';
54
+ export * from './CreateScriptVersionRequest';
51
55
  export * from './Dataset';
52
56
  export * from './Destination';
53
57
  export * from './DestinationCreated';
@@ -123,6 +127,21 @@ export * from './GuidanceItemSourcesInner';
123
127
  export * from './HitMatch';
124
128
  export * from './Holding';
125
129
  export * from './HoldingChange';
130
+ export * from './IndicatorCondition';
131
+ export * from './IndicatorConditionInput';
132
+ export * from './IndicatorFilterChild';
133
+ export * from './IndicatorFilterChildInput';
134
+ export * from './IndicatorFilterCondition';
135
+ export * from './IndicatorFilterConditionInput';
136
+ export * from './IndicatorFilterLeaf';
137
+ export * from './IndicatorFilterLeafInput';
138
+ export * from './IndicatorFilters';
139
+ export * from './IndicatorFiltersInput';
140
+ export * from './IndicatorOperand';
141
+ export * from './IndicatorOperandInput';
142
+ export * from './IndicatorResolved';
143
+ export * from './IndicatorResolvedThreshold';
144
+ export * from './IndicatorTemplateRef';
126
145
  export * from './InsiderTrade';
127
146
  export * from './InsiderTradeFootnote';
128
147
  export * from './InvestorDocument';
@@ -137,6 +156,7 @@ export * from './KpiMention';
137
156
  export * from './KpiMentionFilingLink';
138
157
  export * from './KpiMentionFilingLinkFactPeriod';
139
158
  export * from './ListAlertEvents200Response';
159
+ export * from './ListAlertTemplates200Response';
140
160
  export * from './ListAlerts200Response';
141
161
  export * from './ListAlerts200ResponseMeta';
142
162
  export * from './ListAnnouncements200Response';
@@ -186,6 +206,8 @@ export * from './ListParticipants200Response';
186
206
  export * from './ListPeople200Response';
187
207
  export * from './ListQa200Response';
188
208
  export * from './ListRatios200Response';
209
+ export * from './ListScriptVersions200Response';
210
+ export * from './ListScripts200Response';
189
211
  export * from './ListSectionCatalog200Response';
190
212
  export * from './ListSegments200Response';
191
213
  export * from './ListSegmentsDetailed200Response';
@@ -241,6 +263,9 @@ export * from './QaPairScores';
241
263
  export * from './QaPairScoresEvidence';
242
264
  export * from './RatioPeriod';
243
265
  export * from './ReviewChain';
266
+ export * from './Script';
267
+ export * from './ScriptDiagnostic';
268
+ export * from './ScriptVersion';
244
269
  export * from './SearchCoverage';
245
270
  export * from './SearchCoverageLeg';
246
271
  export * from './SearchFilings200Response';
@@ -35,6 +35,8 @@ __exportStar(require("./AlertConditionYieldRule"), exports);
35
35
  __exportStar(require("./AlertConditionYoyRulesInner"), exports);
36
36
  __exportStar(require("./AlertEvent"), exports);
37
37
  __exportStar(require("./AlertQuotaUsage"), exports);
38
+ __exportStar(require("./AlertTemplate"), exports);
39
+ __exportStar(require("./AlertTemplateInput"), exports);
38
40
  __exportStar(require("./AlertTestAccepted"), exports);
39
41
  __exportStar(require("./AlertTrigger"), exports);
40
42
  __exportStar(require("./AlertTriggerActiveWindow"), exports);
@@ -66,6 +68,8 @@ __exportStar(require("./CompanyListItem"), exports);
66
68
  __exportStar(require("./CompanyRef"), exports);
67
69
  __exportStar(require("./CreateAlertRequest"), exports);
68
70
  __exportStar(require("./CreateDestinationRequest"), exports);
71
+ __exportStar(require("./CreateScriptRequest"), exports);
72
+ __exportStar(require("./CreateScriptVersionRequest"), exports);
69
73
  __exportStar(require("./Dataset"), exports);
70
74
  __exportStar(require("./Destination"), exports);
71
75
  __exportStar(require("./DestinationCreated"), exports);
@@ -141,6 +145,21 @@ __exportStar(require("./GuidanceItemSourcesInner"), exports);
141
145
  __exportStar(require("./HitMatch"), exports);
142
146
  __exportStar(require("./Holding"), exports);
143
147
  __exportStar(require("./HoldingChange"), exports);
148
+ __exportStar(require("./IndicatorCondition"), exports);
149
+ __exportStar(require("./IndicatorConditionInput"), exports);
150
+ __exportStar(require("./IndicatorFilterChild"), exports);
151
+ __exportStar(require("./IndicatorFilterChildInput"), exports);
152
+ __exportStar(require("./IndicatorFilterCondition"), exports);
153
+ __exportStar(require("./IndicatorFilterConditionInput"), exports);
154
+ __exportStar(require("./IndicatorFilterLeaf"), exports);
155
+ __exportStar(require("./IndicatorFilterLeafInput"), exports);
156
+ __exportStar(require("./IndicatorFilters"), exports);
157
+ __exportStar(require("./IndicatorFiltersInput"), exports);
158
+ __exportStar(require("./IndicatorOperand"), exports);
159
+ __exportStar(require("./IndicatorOperandInput"), exports);
160
+ __exportStar(require("./IndicatorResolved"), exports);
161
+ __exportStar(require("./IndicatorResolvedThreshold"), exports);
162
+ __exportStar(require("./IndicatorTemplateRef"), exports);
144
163
  __exportStar(require("./InsiderTrade"), exports);
145
164
  __exportStar(require("./InsiderTradeFootnote"), exports);
146
165
  __exportStar(require("./InvestorDocument"), exports);
@@ -155,6 +174,7 @@ __exportStar(require("./KpiMention"), exports);
155
174
  __exportStar(require("./KpiMentionFilingLink"), exports);
156
175
  __exportStar(require("./KpiMentionFilingLinkFactPeriod"), exports);
157
176
  __exportStar(require("./ListAlertEvents200Response"), exports);
177
+ __exportStar(require("./ListAlertTemplates200Response"), exports);
158
178
  __exportStar(require("./ListAlerts200Response"), exports);
159
179
  __exportStar(require("./ListAlerts200ResponseMeta"), exports);
160
180
  __exportStar(require("./ListAnnouncements200Response"), exports);
@@ -204,6 +224,8 @@ __exportStar(require("./ListParticipants200Response"), exports);
204
224
  __exportStar(require("./ListPeople200Response"), exports);
205
225
  __exportStar(require("./ListQa200Response"), exports);
206
226
  __exportStar(require("./ListRatios200Response"), exports);
227
+ __exportStar(require("./ListScriptVersions200Response"), exports);
228
+ __exportStar(require("./ListScripts200Response"), exports);
207
229
  __exportStar(require("./ListSectionCatalog200Response"), exports);
208
230
  __exportStar(require("./ListSegments200Response"), exports);
209
231
  __exportStar(require("./ListSegmentsDetailed200Response"), exports);
@@ -259,6 +281,9 @@ __exportStar(require("./QaPairScores"), exports);
259
281
  __exportStar(require("./QaPairScoresEvidence"), exports);
260
282
  __exportStar(require("./RatioPeriod"), exports);
261
283
  __exportStar(require("./ReviewChain"), exports);
284
+ __exportStar(require("./Script"), exports);
285
+ __exportStar(require("./ScriptDiagnostic"), exports);
286
+ __exportStar(require("./ScriptVersion"), exports);
262
287
  __exportStar(require("./SearchCoverage"), exports);
263
288
  __exportStar(require("./SearchCoverageLeg"), exports);
264
289
  __exportStar(require("./SearchFilings200Response"), exports);
package/docs/Alert.md CHANGED
@@ -9,6 +9,7 @@ Name | Type
9
9
  `id` | string
10
10
  `type` | string
11
11
  `status` | string
12
+ `disabled_reason` | string
12
13
  `condition` | [AlertCondition](AlertCondition.md)
13
14
  `trigger` | [AlertTrigger](AlertTrigger.md)
14
15
  `destination_ids` | Array&lt;string&gt;
@@ -33,6 +34,7 @@ const example = {
33
34
  "id": null,
34
35
  "type": null,
35
36
  "status": null,
37
+ "disabled_reason": null,
36
38
  "condition": null,
37
39
  "trigger": null,
38
40
  "destination_ids": null,
@@ -1,7 +1,7 @@
1
1
 
2
2
  # AlertCondition
3
3
 
4
- What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. 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.
4
+ What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Price types (`price`, `price_move`, `volume_spike`, `price_reminder`) 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.
5
5
 
6
6
  ## Properties
7
7
 
@@ -58,6 +58,13 @@ Name | Type
58
58
  `at` | Date
59
59
  `weekday` | number
60
60
  `days` | Array&lt;number&gt;
61
+ `script_version_id` | string
62
+ `inputs` | { [key: string]: any; }
63
+ `alert_ids` | Array&lt;string&gt;
64
+ `template` | [IndicatorTemplateRef](IndicatorTemplateRef.md)
65
+ `condition` | [IndicatorCondition](IndicatorCondition.md)
66
+ `filters` | [IndicatorFilters](IndicatorFilters.md)
67
+ `resolved` | [IndicatorResolved](IndicatorResolved.md)
61
68
 
62
69
  ## Example
63
70
 
@@ -117,6 +124,13 @@ const example = {
117
124
  "at": null,
118
125
  "weekday": null,
119
126
  "days": null,
127
+ "script_version_id": null,
128
+ "inputs": null,
129
+ "alert_ids": null,
130
+ "template": null,
131
+ "condition": null,
132
+ "filters": null,
133
+ "resolved": null,
120
134
  } satisfies AlertCondition
121
135
 
122
136
  console.log(example)
@@ -1,7 +1,7 @@
1
1
 
2
2
  # AlertConditionInput
3
3
 
4
- What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. 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)
4
+ What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Price types (`price`, `price_move`, `volume_spike`, `price_reminder`), `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.
5
5
 
6
6
  ## Properties
7
7
 
@@ -58,6 +58,12 @@ Name | Type
58
58
  `at` | string
59
59
  `weekday` | number
60
60
  `days` | Array&lt;number&gt;
61
+ `script_version_id` | string
62
+ `inputs` | { [key: string]: any; }
63
+ `alert_ids` | Array&lt;string&gt;
64
+ `template` | [IndicatorTemplateRef](IndicatorTemplateRef.md)
65
+ `condition` | [IndicatorConditionInput](IndicatorConditionInput.md)
66
+ `filters` | [IndicatorFiltersInput](IndicatorFiltersInput.md)
61
67
 
62
68
  ## Example
63
69
 
@@ -117,6 +123,12 @@ const example = {
117
123
  "at": null,
118
124
  "weekday": null,
119
125
  "days": null,
126
+ "script_version_id": null,
127
+ "inputs": null,
128
+ "alert_ids": null,
129
+ "template": null,
130
+ "condition": null,
131
+ "filters": null,
120
132
  } satisfies AlertConditionInput
121
133
 
122
134
  console.log(example)
@@ -0,0 +1,49 @@
1
+
2
+ # AlertTemplate
3
+
4
+ A built-in template of the `indicator` alert type.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `key` | string
11
+ `version` | number
12
+ `source_key` | string
13
+ `title` | string
14
+ `description` | string
15
+ `fidelity` | string
16
+ `inputs` | [Array&lt;AlertTemplateInput&gt;](AlertTemplateInput.md)
17
+ `source` | string
18
+
19
+ ## Example
20
+
21
+ ```typescript
22
+ import type { AlertTemplate } from '@invinite-org/data-api-client'
23
+
24
+ // TODO: Update the object below with actual values
25
+ const example = {
26
+ "key": null,
27
+ "version": null,
28
+ "source_key": null,
29
+ "title": null,
30
+ "description": null,
31
+ "fidelity": null,
32
+ "inputs": null,
33
+ "source": null,
34
+ } satisfies AlertTemplate
35
+
36
+ console.log(example)
37
+
38
+ // Convert the instance to a JSON string
39
+ const exampleJSON: string = JSON.stringify(example)
40
+ console.log(exampleJSON)
41
+
42
+ // Parse the JSON string back to an object
43
+ const exampleParsed = JSON.parse(exampleJSON) as AlertTemplate
44
+ console.log(exampleParsed)
45
+ ```
46
+
47
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
48
+
49
+
@@ -0,0 +1,47 @@
1
+
2
+ # AlertTemplateInput
3
+
4
+ One input of a template.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `name` | string
11
+ `kind` | string
12
+ `title` | string
13
+ `_default` | any
14
+ `min` | number
15
+ `max` | number
16
+ `options` | Array&lt;string&gt;
17
+
18
+ ## Example
19
+
20
+ ```typescript
21
+ import type { AlertTemplateInput } from '@invinite-org/data-api-client'
22
+
23
+ // TODO: Update the object below with actual values
24
+ const example = {
25
+ "name": null,
26
+ "kind": null,
27
+ "title": null,
28
+ "_default": null,
29
+ "min": null,
30
+ "max": null,
31
+ "options": null,
32
+ } satisfies AlertTemplateInput
33
+
34
+ console.log(example)
35
+
36
+ // Convert the instance to a JSON string
37
+ const exampleJSON: string = JSON.stringify(example)
38
+ console.log(exampleJSON)
39
+
40
+ // Parse the JSON string back to an object
41
+ const exampleParsed = JSON.parse(exampleJSON) as AlertTemplateInput
42
+ console.log(exampleParsed)
43
+ ```
44
+
45
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
46
+
47
+
@@ -587,7 +587,7 @@ async function example() {
587
587
  const api = new CompaniesApi(config);
588
588
 
589
589
  const body = {
590
- // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. (optional)
590
+ // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. (optional)
591
591
  company: AAPL,
592
592
  // string | Event id (optional)
593
593
  event: evt_01JC8M2X,
@@ -622,7 +622,7 @@ example().catch(console.error);
622
622
 
623
623
  | Name | Type | Description | Notes |
624
624
  |------------- | ------------- | ------------- | -------------|
625
- | **company** | `string` | Ticker (&#x60;AAPL&#x60;) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. | [Optional] [Defaults to `undefined`] |
625
+ | **company** | `string` | Ticker (&#x60;AAPL&#x60;) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on &#x60;/v1/dividends&#x60;, &#x60;/v1/splits&#x60; and &#x60;/v1/filings&#x60; (a trust series\&#39; filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\&#39;s; a row\&#39;s &#x60;company.cik&#x60; is the trust\&#39;s CIK, empty for an ETF without a registrant link). The company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 &#x60;not_covered&#x60; naming the ETF (\&quot;TQQQ is an ETF: … exists only for companies\&quot;); on the other lists a series ETF such as TQQQ is not a known company. | [Optional] [Defaults to `undefined`] |
626
626
  | **event** | `string` | Event id | [Optional] [Defaults to `undefined`] |
627
627
  | **role** | `executive`, `analyst`, `operator`, `other` | Role | [Optional] [Defaults to `undefined`] [Enum: executive, analyst, operator, other] |
628
628
  | **q** | `string` | Name | [Optional] [Defaults to `undefined`] |