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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (208) hide show
  1. package/.openapi-generator/FILES +52 -0
  2. package/dist/apis/ScriptsApi.d.ts +148 -0
  3. package/dist/apis/ScriptsApi.js +396 -0
  4. package/dist/apis/index.d.ts +1 -0
  5. package/dist/apis/index.js +1 -0
  6. package/dist/esm/apis/ScriptsApi.d.ts +148 -0
  7. package/dist/esm/apis/ScriptsApi.js +392 -0
  8. package/dist/esm/apis/index.d.ts +1 -0
  9. package/dist/esm/apis/index.js +1 -0
  10. package/dist/esm/models/Alert.d.ts +6 -0
  11. package/dist/esm/models/Alert.js +4 -0
  12. package/dist/esm/models/AlertCondition.d.ts +61 -5
  13. package/dist/esm/models/AlertCondition.js +27 -1
  14. package/dist/esm/models/AlertConditionInput.d.ts +54 -5
  15. package/dist/esm/models/AlertConditionInput.js +24 -1
  16. package/dist/esm/models/AlertTemplate.d.ts +83 -0
  17. package/dist/esm/models/AlertTemplate.js +79 -0
  18. package/dist/esm/models/AlertTemplateInput.d.ts +78 -0
  19. package/dist/esm/models/AlertTemplateInput.js +70 -0
  20. package/dist/esm/models/AlertTrigger.d.ts +1 -1
  21. package/dist/esm/models/AlertTriggerInput.d.ts +1 -1
  22. package/dist/esm/models/Company.d.ts +6 -6
  23. package/dist/esm/models/CreateScriptRequest.d.ts +44 -0
  24. package/dist/esm/models/CreateScriptRequest.js +49 -0
  25. package/dist/esm/models/CreateScriptVersionRequest.d.ts +32 -0
  26. package/dist/esm/models/CreateScriptVersionRequest.js +43 -0
  27. package/dist/esm/models/IndicatorCondition.d.ts +56 -0
  28. package/dist/esm/models/IndicatorCondition.js +62 -0
  29. package/dist/esm/models/IndicatorConditionInput.d.ts +56 -0
  30. package/dist/esm/models/IndicatorConditionInput.js +62 -0
  31. package/dist/esm/models/IndicatorFilterChild.d.ts +68 -0
  32. package/dist/esm/models/IndicatorFilterChild.js +65 -0
  33. package/dist/esm/models/IndicatorFilterChildInput.d.ts +68 -0
  34. package/dist/esm/models/IndicatorFilterChildInput.js +65 -0
  35. package/dist/esm/models/IndicatorFilterCondition.d.ts +73 -0
  36. package/dist/esm/models/IndicatorFilterCondition.js +74 -0
  37. package/dist/esm/models/IndicatorFilterConditionInput.d.ts +73 -0
  38. package/dist/esm/models/IndicatorFilterConditionInput.js +74 -0
  39. package/dist/esm/models/IndicatorFilterLeaf.d.ts +46 -0
  40. package/dist/esm/models/IndicatorFilterLeaf.js +54 -0
  41. package/dist/esm/models/IndicatorFilterLeafInput.d.ts +46 -0
  42. package/dist/esm/models/IndicatorFilterLeafInput.js +56 -0
  43. package/dist/esm/models/IndicatorFilters.d.ts +47 -0
  44. package/dist/esm/models/IndicatorFilters.js +55 -0
  45. package/dist/esm/models/IndicatorFiltersInput.d.ts +47 -0
  46. package/dist/esm/models/IndicatorFiltersInput.js +55 -0
  47. package/dist/esm/models/IndicatorOperand.d.ts +91 -0
  48. package/dist/esm/models/IndicatorOperand.js +74 -0
  49. package/dist/esm/models/IndicatorOperandInput.d.ts +91 -0
  50. package/dist/esm/models/IndicatorOperandInput.js +74 -0
  51. package/dist/esm/models/IndicatorResolved.d.ts +67 -0
  52. package/dist/esm/models/IndicatorResolved.js +65 -0
  53. package/dist/esm/models/IndicatorResolvedThreshold.d.ts +47 -0
  54. package/dist/esm/models/IndicatorResolvedThreshold.js +55 -0
  55. package/dist/esm/models/IndicatorTemplateRef.d.ts +46 -0
  56. package/dist/esm/models/IndicatorTemplateRef.js +47 -0
  57. package/dist/esm/models/ListAlertTemplates200Response.d.ts +52 -0
  58. package/dist/esm/models/ListAlertTemplates200Response.js +57 -0
  59. package/dist/esm/models/ListScriptVersions200Response.d.ts +52 -0
  60. package/dist/esm/models/ListScriptVersions200Response.js +57 -0
  61. package/dist/esm/models/ListScripts200Response.d.ts +52 -0
  62. package/dist/esm/models/ListScripts200Response.js +57 -0
  63. package/dist/esm/models/Script.d.ts +69 -0
  64. package/dist/esm/models/Script.js +68 -0
  65. package/dist/esm/models/ScriptDiagnostic.d.ts +64 -0
  66. package/dist/esm/models/ScriptDiagnostic.js +66 -0
  67. package/dist/esm/models/ScriptVersion.d.ts +103 -0
  68. package/dist/esm/models/ScriptVersion.js +91 -0
  69. package/dist/esm/models/index.d.ts +25 -0
  70. package/dist/esm/models/index.js +25 -0
  71. package/dist/models/Alert.d.ts +6 -0
  72. package/dist/models/Alert.js +4 -0
  73. package/dist/models/AlertCondition.d.ts +61 -5
  74. package/dist/models/AlertCondition.js +27 -1
  75. package/dist/models/AlertConditionInput.d.ts +54 -5
  76. package/dist/models/AlertConditionInput.js +24 -1
  77. package/dist/models/AlertTemplate.d.ts +83 -0
  78. package/dist/models/AlertTemplate.js +87 -0
  79. package/dist/models/AlertTemplateInput.d.ts +78 -0
  80. package/dist/models/AlertTemplateInput.js +78 -0
  81. package/dist/models/AlertTrigger.d.ts +1 -1
  82. package/dist/models/AlertTriggerInput.d.ts +1 -1
  83. package/dist/models/Company.d.ts +6 -6
  84. package/dist/models/CreateScriptRequest.d.ts +44 -0
  85. package/dist/models/CreateScriptRequest.js +56 -0
  86. package/dist/models/CreateScriptVersionRequest.d.ts +32 -0
  87. package/dist/models/CreateScriptVersionRequest.js +50 -0
  88. package/dist/models/IndicatorCondition.d.ts +56 -0
  89. package/dist/models/IndicatorCondition.js +70 -0
  90. package/dist/models/IndicatorConditionInput.d.ts +56 -0
  91. package/dist/models/IndicatorConditionInput.js +70 -0
  92. package/dist/models/IndicatorFilterChild.d.ts +68 -0
  93. package/dist/models/IndicatorFilterChild.js +73 -0
  94. package/dist/models/IndicatorFilterChildInput.d.ts +68 -0
  95. package/dist/models/IndicatorFilterChildInput.js +73 -0
  96. package/dist/models/IndicatorFilterCondition.d.ts +73 -0
  97. package/dist/models/IndicatorFilterCondition.js +82 -0
  98. package/dist/models/IndicatorFilterConditionInput.d.ts +73 -0
  99. package/dist/models/IndicatorFilterConditionInput.js +82 -0
  100. package/dist/models/IndicatorFilterLeaf.d.ts +46 -0
  101. package/dist/models/IndicatorFilterLeaf.js +62 -0
  102. package/dist/models/IndicatorFilterLeafInput.d.ts +46 -0
  103. package/dist/models/IndicatorFilterLeafInput.js +64 -0
  104. package/dist/models/IndicatorFilters.d.ts +47 -0
  105. package/dist/models/IndicatorFilters.js +63 -0
  106. package/dist/models/IndicatorFiltersInput.d.ts +47 -0
  107. package/dist/models/IndicatorFiltersInput.js +63 -0
  108. package/dist/models/IndicatorOperand.d.ts +91 -0
  109. package/dist/models/IndicatorOperand.js +82 -0
  110. package/dist/models/IndicatorOperandInput.d.ts +91 -0
  111. package/dist/models/IndicatorOperandInput.js +82 -0
  112. package/dist/models/IndicatorResolved.d.ts +67 -0
  113. package/dist/models/IndicatorResolved.js +73 -0
  114. package/dist/models/IndicatorResolvedThreshold.d.ts +47 -0
  115. package/dist/models/IndicatorResolvedThreshold.js +63 -0
  116. package/dist/models/IndicatorTemplateRef.d.ts +46 -0
  117. package/dist/models/IndicatorTemplateRef.js +54 -0
  118. package/dist/models/ListAlertTemplates200Response.d.ts +52 -0
  119. package/dist/models/ListAlertTemplates200Response.js +64 -0
  120. package/dist/models/ListScriptVersions200Response.d.ts +52 -0
  121. package/dist/models/ListScriptVersions200Response.js +64 -0
  122. package/dist/models/ListScripts200Response.d.ts +52 -0
  123. package/dist/models/ListScripts200Response.js +64 -0
  124. package/dist/models/Script.d.ts +69 -0
  125. package/dist/models/Script.js +75 -0
  126. package/dist/models/ScriptDiagnostic.d.ts +64 -0
  127. package/dist/models/ScriptDiagnostic.js +74 -0
  128. package/dist/models/ScriptVersion.d.ts +103 -0
  129. package/dist/models/ScriptVersion.js +99 -0
  130. package/dist/models/index.d.ts +25 -0
  131. package/dist/models/index.js +25 -0
  132. package/docs/Alert.md +2 -0
  133. package/docs/AlertCondition.md +15 -1
  134. package/docs/AlertConditionInput.md +13 -1
  135. package/docs/AlertTemplate.md +49 -0
  136. package/docs/AlertTemplateInput.md +47 -0
  137. package/docs/CompaniesApi.md +4 -4
  138. package/docs/CreateScriptRequest.md +38 -0
  139. package/docs/CreateScriptVersionRequest.md +34 -0
  140. package/docs/EventsApi.md +2 -2
  141. package/docs/FilingsApi.md +4 -4
  142. package/docs/FinancialsApi.md +12 -12
  143. package/docs/GuidanceApi.md +4 -4
  144. package/docs/HoldingsApi.md +8 -8
  145. package/docs/IPOsApi.md +4 -4
  146. package/docs/IndicatorCondition.md +39 -0
  147. package/docs/IndicatorConditionInput.md +39 -0
  148. package/docs/IndicatorFilterChild.md +41 -0
  149. package/docs/IndicatorFilterChildInput.md +41 -0
  150. package/docs/IndicatorFilterCondition.md +41 -0
  151. package/docs/IndicatorFilterConditionInput.md +41 -0
  152. package/docs/IndicatorFilterLeaf.md +37 -0
  153. package/docs/IndicatorFilterLeafInput.md +37 -0
  154. package/docs/IndicatorFilters.md +37 -0
  155. package/docs/IndicatorFiltersInput.md +37 -0
  156. package/docs/IndicatorOperand.md +47 -0
  157. package/docs/IndicatorOperandInput.md +47 -0
  158. package/docs/IndicatorResolved.md +43 -0
  159. package/docs/IndicatorResolvedThreshold.md +37 -0
  160. package/docs/IndicatorTemplateRef.md +39 -0
  161. package/docs/InsiderTradesApi.md +2 -2
  162. package/docs/InvestorDocumentsApi.md +4 -4
  163. package/docs/ListAlertTemplates200Response.md +41 -0
  164. package/docs/ListScriptVersions200Response.md +41 -0
  165. package/docs/ListScripts200Response.md +41 -0
  166. package/docs/MetricsApi.md +10 -10
  167. package/docs/NewsApi.md +6 -6
  168. package/docs/ReferenceApi.md +6 -6
  169. package/docs/Script.md +46 -0
  170. package/docs/ScriptDiagnostic.md +42 -0
  171. package/docs/ScriptVersion.md +54 -0
  172. package/docs/ScriptsApi.md +588 -0
  173. package/docs/TranscriptsApi.md +2 -2
  174. package/package.json +1 -1
  175. package/src/apis/ScriptsApi.ts +504 -0
  176. package/src/apis/index.ts +1 -0
  177. package/src/models/Alert.ts +9 -0
  178. package/src/models/AlertCondition.ts +98 -6
  179. package/src/models/AlertConditionInput.ts +83 -6
  180. package/src/models/AlertTemplate.ts +148 -0
  181. package/src/models/AlertTemplateInput.ts +130 -0
  182. package/src/models/AlertTrigger.ts +1 -1
  183. package/src/models/AlertTriggerInput.ts +1 -1
  184. package/src/models/Company.ts +6 -6
  185. package/src/models/CreateScriptRequest.ts +83 -0
  186. package/src/models/CreateScriptVersionRequest.ts +66 -0
  187. package/src/models/IndicatorCondition.ts +106 -0
  188. package/src/models/IndicatorConditionInput.ts +106 -0
  189. package/src/models/IndicatorFilterChild.ts +125 -0
  190. package/src/models/IndicatorFilterChildInput.ts +125 -0
  191. package/src/models/IndicatorFilterCondition.ts +126 -0
  192. package/src/models/IndicatorFilterConditionInput.ts +126 -0
  193. package/src/models/IndicatorFilterLeaf.ts +93 -0
  194. package/src/models/IndicatorFilterLeafInput.ts +95 -0
  195. package/src/models/IndicatorFilters.ts +94 -0
  196. package/src/models/IndicatorFiltersInput.ts +94 -0
  197. package/src/models/IndicatorOperand.ts +139 -0
  198. package/src/models/IndicatorOperandInput.ts +139 -0
  199. package/src/models/IndicatorResolved.ts +120 -0
  200. package/src/models/IndicatorResolvedThreshold.ts +87 -0
  201. package/src/models/IndicatorTemplateRef.ts +82 -0
  202. package/src/models/ListAlertTemplates200Response.ts +108 -0
  203. package/src/models/ListScriptVersions200Response.ts +108 -0
  204. package/src/models/ListScripts200Response.ts +108 -0
  205. package/src/models/Script.ts +128 -0
  206. package/src/models/ScriptDiagnostic.ts +113 -0
  207. package/src/models/ScriptVersion.ts +175 -0
  208. package/src/models/index.ts +25 -0
@@ -0,0 +1,94 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Invinite API
5
+ * Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Alerts (`POST /v1/alerts`) deliver their events to your destinations (`POST /v1/destinations`) as [Standard Webhooks](https://github.com/standard-webhooks/standard-webhooks/blob/main/spec/standard-webhooks.md): `alert.fired`, `alert.fired.batch`, `alert.status_changed`, `destination.disabled`, `destination.test`, `account.fire_cap_reached`; see `x-webhooks` for each `data` object. Every event is also on the pull feed `GET /v1/alert-events`. Every delivery is a `POST` with `Content-Type: application/json`, the body `{type, timestamp, data}` (or the destination\'s `body_template`) and the headers `webhook-id` (the event id; a batch: its `bat_…` id), `webhook-timestamp` (unix seconds) and `webhook-signature`: space-separated `v1,<base64 HMAC-SHA256 of <webhook-id>.<webhook-timestamp>.<raw body>>`, keyed with the base64-DECODED bytes of the destination\'s `whsec_…` secret — any Standard Webhooks library verifies it. After `POST /v1/destinations/{id}:rotate-secret` the old secret keeps signing beside the new one for 24 h (two `v1` entries). Reject a timestamp older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed; a body above 256 KB is not sent. A failed attempt is retried after [0, 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 10 h, 10 h, 34 h] (attempt n waits the n-th step) plus up to 10 % jitter; the delivery is dead after attempt 10. A 410 disables the destination at once; so do 72 h of nothing but failures with at least 10 failed attempts in a row (a `destination.disabled` event on the feed and a mail; `PATCH` with `status: active` re-enables it). Delivery is at-least-once and unordered: dedupe on `webhook-id`, order by `timestamp`. A `batch_webhook` destination receives `alert.fired.batch` with the pending events in `data.events[]` (dedupe on each `data.event_id`). Fires and deliveries cost no credits; two fair-use caps apply instead: at most 60 fires per alert per rolling hour (beyond: suppressed and counted in the next fire\'s `suppressed_since_last`) and per account and UTC day FREE 100 · LITE 5,000 · STANDARD 50,000 · PRO 500,000 fires (beyond: written to the feed with `delivery_skipped: fire_cap`, not delivered; one `account.fire_cap_reached` per day). ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/me` and `/v1/me/usage` serve no licensed data and carry none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account, Alerts.
6
+ *
7
+ * The version of the OpenAPI document: 2026-11-13
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ import type { IndicatorFilterChild } from './IndicatorFilterChild';
17
+ import {
18
+ IndicatorFilterChildFromJSON,
19
+ IndicatorFilterChildFromJSONTyped,
20
+ IndicatorFilterChildToJSON,
21
+ IndicatorFilterChildToJSONTyped,
22
+ } from './IndicatorFilterChild';
23
+
24
+ /**
25
+ * State filters that gate the trigger (at most 4 comparisons in all, two levels).
26
+ * @export
27
+ * @interface IndicatorFilters
28
+ */
29
+ export interface IndicatorFilters {
30
+ /**
31
+ * How the children combine
32
+ * @type {IndicatorFiltersOpEnum}
33
+ * @memberof IndicatorFilters
34
+ */
35
+ op: IndicatorFiltersOpEnum;
36
+ /**
37
+ * Leaves and groups
38
+ * @type {Array<IndicatorFilterChild>}
39
+ * @memberof IndicatorFilters
40
+ */
41
+ children: Array<IndicatorFilterChild>;
42
+ }
43
+
44
+
45
+ /**
46
+ * @export
47
+ */
48
+ export const IndicatorFiltersOpEnum = {
49
+ And: 'and',
50
+ Or: 'or'
51
+ } as const;
52
+ export type IndicatorFiltersOpEnum = typeof IndicatorFiltersOpEnum[keyof typeof IndicatorFiltersOpEnum] | (string & {});
53
+
54
+
55
+ /**
56
+ * Check if a given object implements the IndicatorFilters interface.
57
+ */
58
+ export function instanceOfIndicatorFilters(value: object): value is IndicatorFilters {
59
+ if (!('op' in value) || value['op'] === undefined) return false;
60
+ if (!('children' in value) || value['children'] === undefined) return false;
61
+ return true;
62
+ }
63
+
64
+ export function IndicatorFiltersFromJSON(json: any): IndicatorFilters {
65
+ return IndicatorFiltersFromJSONTyped(json, false);
66
+ }
67
+
68
+ export function IndicatorFiltersFromJSONTyped(json: any, ignoreDiscriminator: boolean): IndicatorFilters {
69
+ if (json == null) {
70
+ return json;
71
+ }
72
+ return {
73
+
74
+ 'op': json['op'],
75
+ 'children': ((json['children'] as Array<any>).map(IndicatorFilterChildFromJSON)),
76
+ };
77
+ }
78
+
79
+ export function IndicatorFiltersToJSON(json: any): IndicatorFilters {
80
+ return IndicatorFiltersToJSONTyped(json, false);
81
+ }
82
+
83
+ export function IndicatorFiltersToJSONTyped(value?: IndicatorFilters | null, ignoreDiscriminator: boolean = false): any {
84
+ if (value == null) {
85
+ return value;
86
+ }
87
+
88
+ return {
89
+
90
+ 'op': value['op'],
91
+ 'children': ((value['children'] as Array<any>).map(IndicatorFilterChildToJSON)),
92
+ };
93
+ }
94
+
@@ -0,0 +1,94 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Invinite API
5
+ * Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Alerts (`POST /v1/alerts`) deliver their events to your destinations (`POST /v1/destinations`) as [Standard Webhooks](https://github.com/standard-webhooks/standard-webhooks/blob/main/spec/standard-webhooks.md): `alert.fired`, `alert.fired.batch`, `alert.status_changed`, `destination.disabled`, `destination.test`, `account.fire_cap_reached`; see `x-webhooks` for each `data` object. Every event is also on the pull feed `GET /v1/alert-events`. Every delivery is a `POST` with `Content-Type: application/json`, the body `{type, timestamp, data}` (or the destination\'s `body_template`) and the headers `webhook-id` (the event id; a batch: its `bat_…` id), `webhook-timestamp` (unix seconds) and `webhook-signature`: space-separated `v1,<base64 HMAC-SHA256 of <webhook-id>.<webhook-timestamp>.<raw body>>`, keyed with the base64-DECODED bytes of the destination\'s `whsec_…` secret — any Standard Webhooks library verifies it. After `POST /v1/destinations/{id}:rotate-secret` the old secret keeps signing beside the new one for 24 h (two `v1` entries). Reject a timestamp older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed; a body above 256 KB is not sent. A failed attempt is retried after [0, 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 10 h, 10 h, 34 h] (attempt n waits the n-th step) plus up to 10 % jitter; the delivery is dead after attempt 10. A 410 disables the destination at once; so do 72 h of nothing but failures with at least 10 failed attempts in a row (a `destination.disabled` event on the feed and a mail; `PATCH` with `status: active` re-enables it). Delivery is at-least-once and unordered: dedupe on `webhook-id`, order by `timestamp`. A `batch_webhook` destination receives `alert.fired.batch` with the pending events in `data.events[]` (dedupe on each `data.event_id`). Fires and deliveries cost no credits; two fair-use caps apply instead: at most 60 fires per alert per rolling hour (beyond: suppressed and counted in the next fire\'s `suppressed_since_last`) and per account and UTC day FREE 100 · LITE 5,000 · STANDARD 50,000 · PRO 500,000 fires (beyond: written to the feed with `delivery_skipped: fire_cap`, not delivered; one `account.fire_cap_reached` per day). ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/me` and `/v1/me/usage` serve no licensed data and carry none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account, Alerts.
6
+ *
7
+ * The version of the OpenAPI document: 2026-11-13
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ import type { IndicatorFilterChildInput } from './IndicatorFilterChildInput';
17
+ import {
18
+ IndicatorFilterChildInputFromJSON,
19
+ IndicatorFilterChildInputFromJSONTyped,
20
+ IndicatorFilterChildInputToJSON,
21
+ IndicatorFilterChildInputToJSONTyped,
22
+ } from './IndicatorFilterChildInput';
23
+
24
+ /**
25
+ * State filters that gate the trigger (at most 4 comparisons in all, two levels). (request form)
26
+ * @export
27
+ * @interface IndicatorFiltersInput
28
+ */
29
+ export interface IndicatorFiltersInput {
30
+ /**
31
+ * How the children combine
32
+ * @type {IndicatorFiltersInputOpEnum}
33
+ * @memberof IndicatorFiltersInput
34
+ */
35
+ op: IndicatorFiltersInputOpEnum;
36
+ /**
37
+ * Leaves and groups
38
+ * @type {Array<IndicatorFilterChildInput>}
39
+ * @memberof IndicatorFiltersInput
40
+ */
41
+ children: Array<IndicatorFilterChildInput>;
42
+ }
43
+
44
+
45
+ /**
46
+ * @export
47
+ */
48
+ export const IndicatorFiltersInputOpEnum = {
49
+ And: 'and',
50
+ Or: 'or'
51
+ } as const;
52
+ export type IndicatorFiltersInputOpEnum = typeof IndicatorFiltersInputOpEnum[keyof typeof IndicatorFiltersInputOpEnum];
53
+
54
+
55
+ /**
56
+ * Check if a given object implements the IndicatorFiltersInput interface.
57
+ */
58
+ export function instanceOfIndicatorFiltersInput(value: object): value is IndicatorFiltersInput {
59
+ if (!('op' in value) || value['op'] === undefined) return false;
60
+ if (!('children' in value) || value['children'] === undefined) return false;
61
+ return true;
62
+ }
63
+
64
+ export function IndicatorFiltersInputFromJSON(json: any): IndicatorFiltersInput {
65
+ return IndicatorFiltersInputFromJSONTyped(json, false);
66
+ }
67
+
68
+ export function IndicatorFiltersInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): IndicatorFiltersInput {
69
+ if (json == null) {
70
+ return json;
71
+ }
72
+ return {
73
+
74
+ 'op': json['op'],
75
+ 'children': ((json['children'] as Array<any>).map(IndicatorFilterChildInputFromJSON)),
76
+ };
77
+ }
78
+
79
+ export function IndicatorFiltersInputToJSON(json: any): IndicatorFiltersInput {
80
+ return IndicatorFiltersInputToJSONTyped(json, false);
81
+ }
82
+
83
+ export function IndicatorFiltersInputToJSONTyped(value?: IndicatorFiltersInput | null, ignoreDiscriminator: boolean = false): any {
84
+ if (value == null) {
85
+ return value;
86
+ }
87
+
88
+ return {
89
+
90
+ 'op': value['op'],
91
+ 'children': ((value['children'] as Array<any>).map(IndicatorFilterChildInputToJSON)),
92
+ };
93
+ }
94
+
@@ -0,0 +1,139 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Invinite API
5
+ * Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Alerts (`POST /v1/alerts`) deliver their events to your destinations (`POST /v1/destinations`) as [Standard Webhooks](https://github.com/standard-webhooks/standard-webhooks/blob/main/spec/standard-webhooks.md): `alert.fired`, `alert.fired.batch`, `alert.status_changed`, `destination.disabled`, `destination.test`, `account.fire_cap_reached`; see `x-webhooks` for each `data` object. Every event is also on the pull feed `GET /v1/alert-events`. Every delivery is a `POST` with `Content-Type: application/json`, the body `{type, timestamp, data}` (or the destination\'s `body_template`) and the headers `webhook-id` (the event id; a batch: its `bat_…` id), `webhook-timestamp` (unix seconds) and `webhook-signature`: space-separated `v1,<base64 HMAC-SHA256 of <webhook-id>.<webhook-timestamp>.<raw body>>`, keyed with the base64-DECODED bytes of the destination\'s `whsec_…` secret — any Standard Webhooks library verifies it. After `POST /v1/destinations/{id}:rotate-secret` the old secret keeps signing beside the new one for 24 h (two `v1` entries). Reject a timestamp older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed; a body above 256 KB is not sent. A failed attempt is retried after [0, 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 10 h, 10 h, 34 h] (attempt n waits the n-th step) plus up to 10 % jitter; the delivery is dead after attempt 10. A 410 disables the destination at once; so do 72 h of nothing but failures with at least 10 failed attempts in a row (a `destination.disabled` event on the feed and a mail; `PATCH` with `status: active` re-enables it). Delivery is at-least-once and unordered: dedupe on `webhook-id`, order by `timestamp`. A `batch_webhook` destination receives `alert.fired.batch` with the pending events in `data.events[]` (dedupe on each `data.event_id`). Fires and deliveries cost no credits; two fair-use caps apply instead: at most 60 fires per alert per rolling hour (beyond: suppressed and counted in the next fire\'s `suppressed_since_last`) and per account and UTC day FREE 100 · LITE 5,000 · STANDARD 50,000 · PRO 500,000 fires (beyond: written to the feed with `delivery_skipped: fire_cap`, not delivered; one `account.fire_cap_reached` per day). ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/me` and `/v1/me/usage` serve no licensed data and carry none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account, Alerts.
6
+ *
7
+ * The version of the OpenAPI document: 2026-11-13
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ /**
17
+ * One side of an indicator condition (invinite's chart-condition operand): an indicator series, a price field, volume, or a constant (`value`, right side only).
18
+ * @export
19
+ * @interface IndicatorOperand
20
+ */
21
+ export interface IndicatorOperand {
22
+ /**
23
+ * What the operand reads
24
+ * @type {IndicatorOperandKindEnum}
25
+ * @memberof IndicatorOperand
26
+ */
27
+ kind: IndicatorOperandKindEnum;
28
+ /**
29
+ * indicator: the built-in indicator (`rsi`, `sma`, `ema`, `macd`, `bb`, …; the chart's indicator ids)
30
+ * @type {string}
31
+ * @memberof IndicatorOperand
32
+ */
33
+ indicator_id?: string;
34
+ /**
35
+ * indicator: which output series (`rsi`, `macd` / `signal` / `histogram`, `upper` / `basis` / `lower`, …)
36
+ * @type {string}
37
+ * @memberof IndicatorOperand
38
+ */
39
+ series_key?: string;
40
+ /**
41
+ * indicator: the indicator's parameters (`length`, `source`, …; absent = its defaults)
42
+ * @type {{ [key: string]: any; }}
43
+ * @memberof IndicatorOperand
44
+ */
45
+ params?: { [key: string]: any; };
46
+ /**
47
+ * indicator: the name used in the fire summary (default: id and parameters)
48
+ * @type {string}
49
+ * @memberof IndicatorOperand
50
+ */
51
+ label?: string;
52
+ /**
53
+ * price: the bar field (`last` = the close at bar close)
54
+ * @type {IndicatorOperandSourceEnum}
55
+ * @memberof IndicatorOperand
56
+ */
57
+ source?: IndicatorOperandSourceEnum;
58
+ /**
59
+ * value: the constant (right side only)
60
+ * @type {number}
61
+ * @memberof IndicatorOperand
62
+ */
63
+ value?: number;
64
+ }
65
+
66
+
67
+ /**
68
+ * @export
69
+ */
70
+ export const IndicatorOperandKindEnum = {
71
+ Indicator: 'indicator',
72
+ Price: 'price',
73
+ Volume: 'volume',
74
+ Value: 'value'
75
+ } as const;
76
+ export type IndicatorOperandKindEnum = typeof IndicatorOperandKindEnum[keyof typeof IndicatorOperandKindEnum] | (string & {});
77
+
78
+ /**
79
+ * @export
80
+ */
81
+ export const IndicatorOperandSourceEnum = {
82
+ Open: 'open',
83
+ High: 'high',
84
+ Low: 'low',
85
+ Close: 'close',
86
+ Last: 'last'
87
+ } as const;
88
+ export type IndicatorOperandSourceEnum = typeof IndicatorOperandSourceEnum[keyof typeof IndicatorOperandSourceEnum] | (string & {});
89
+
90
+
91
+ /**
92
+ * Check if a given object implements the IndicatorOperand interface.
93
+ */
94
+ export function instanceOfIndicatorOperand(value: object): value is IndicatorOperand {
95
+ if (!('kind' in value) || value['kind'] === undefined) return false;
96
+ return true;
97
+ }
98
+
99
+ export function IndicatorOperandFromJSON(json: any): IndicatorOperand {
100
+ return IndicatorOperandFromJSONTyped(json, false);
101
+ }
102
+
103
+ export function IndicatorOperandFromJSONTyped(json: any, ignoreDiscriminator: boolean): IndicatorOperand {
104
+ if (json == null) {
105
+ return json;
106
+ }
107
+ return {
108
+
109
+ 'kind': json['kind'],
110
+ 'indicator_id': json['indicator_id'] == null ? undefined : json['indicator_id'],
111
+ 'series_key': json['series_key'] == null ? undefined : json['series_key'],
112
+ 'params': json['params'] == null ? undefined : json['params'],
113
+ 'label': json['label'] == null ? undefined : json['label'],
114
+ 'source': json['source'] == null ? undefined : json['source'],
115
+ 'value': json['value'] == null ? undefined : json['value'],
116
+ };
117
+ }
118
+
119
+ export function IndicatorOperandToJSON(json: any): IndicatorOperand {
120
+ return IndicatorOperandToJSONTyped(json, false);
121
+ }
122
+
123
+ export function IndicatorOperandToJSONTyped(value?: IndicatorOperand | null, ignoreDiscriminator: boolean = false): any {
124
+ if (value == null) {
125
+ return value;
126
+ }
127
+
128
+ return {
129
+
130
+ 'kind': value['kind'],
131
+ 'indicator_id': value['indicator_id'],
132
+ 'series_key': value['series_key'],
133
+ 'params': value['params'],
134
+ 'label': value['label'],
135
+ 'source': value['source'],
136
+ 'value': value['value'],
137
+ };
138
+ }
139
+
@@ -0,0 +1,139 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Invinite API
5
+ * Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Alerts (`POST /v1/alerts`) deliver their events to your destinations (`POST /v1/destinations`) as [Standard Webhooks](https://github.com/standard-webhooks/standard-webhooks/blob/main/spec/standard-webhooks.md): `alert.fired`, `alert.fired.batch`, `alert.status_changed`, `destination.disabled`, `destination.test`, `account.fire_cap_reached`; see `x-webhooks` for each `data` object. Every event is also on the pull feed `GET /v1/alert-events`. Every delivery is a `POST` with `Content-Type: application/json`, the body `{type, timestamp, data}` (or the destination\'s `body_template`) and the headers `webhook-id` (the event id; a batch: its `bat_…` id), `webhook-timestamp` (unix seconds) and `webhook-signature`: space-separated `v1,<base64 HMAC-SHA256 of <webhook-id>.<webhook-timestamp>.<raw body>>`, keyed with the base64-DECODED bytes of the destination\'s `whsec_…` secret — any Standard Webhooks library verifies it. After `POST /v1/destinations/{id}:rotate-secret` the old secret keeps signing beside the new one for 24 h (two `v1` entries). Reject a timestamp older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed; a body above 256 KB is not sent. A failed attempt is retried after [0, 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 10 h, 10 h, 34 h] (attempt n waits the n-th step) plus up to 10 % jitter; the delivery is dead after attempt 10. A 410 disables the destination at once; so do 72 h of nothing but failures with at least 10 failed attempts in a row (a `destination.disabled` event on the feed and a mail; `PATCH` with `status: active` re-enables it). Delivery is at-least-once and unordered: dedupe on `webhook-id`, order by `timestamp`. A `batch_webhook` destination receives `alert.fired.batch` with the pending events in `data.events[]` (dedupe on each `data.event_id`). Fires and deliveries cost no credits; two fair-use caps apply instead: at most 60 fires per alert per rolling hour (beyond: suppressed and counted in the next fire\'s `suppressed_since_last`) and per account and UTC day FREE 100 · LITE 5,000 · STANDARD 50,000 · PRO 500,000 fires (beyond: written to the feed with `delivery_skipped: fire_cap`, not delivered; one `account.fire_cap_reached` per day). ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/me` and `/v1/me/usage` serve no licensed data and carry none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account, Alerts.
6
+ *
7
+ * The version of the OpenAPI document: 2026-11-13
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ /**
17
+ * One side of an indicator condition (invinite's chart-condition operand): an indicator series, a price field, volume, or a constant (`value`, right side only). (request form)
18
+ * @export
19
+ * @interface IndicatorOperandInput
20
+ */
21
+ export interface IndicatorOperandInput {
22
+ /**
23
+ * What the operand reads
24
+ * @type {IndicatorOperandInputKindEnum}
25
+ * @memberof IndicatorOperandInput
26
+ */
27
+ kind: IndicatorOperandInputKindEnum;
28
+ /**
29
+ * indicator: the built-in indicator (`rsi`, `sma`, `ema`, `macd`, `bb`, …; the chart's indicator ids)
30
+ * @type {string}
31
+ * @memberof IndicatorOperandInput
32
+ */
33
+ indicator_id?: string;
34
+ /**
35
+ * indicator: which output series (`rsi`, `macd` / `signal` / `histogram`, `upper` / `basis` / `lower`, …)
36
+ * @type {string}
37
+ * @memberof IndicatorOperandInput
38
+ */
39
+ series_key?: string;
40
+ /**
41
+ * indicator: the indicator's parameters (`length`, `source`, …; absent = its defaults)
42
+ * @type {{ [key: string]: any; }}
43
+ * @memberof IndicatorOperandInput
44
+ */
45
+ params?: { [key: string]: any; };
46
+ /**
47
+ * indicator: the name used in the fire summary (default: id and parameters)
48
+ * @type {string}
49
+ * @memberof IndicatorOperandInput
50
+ */
51
+ label?: string;
52
+ /**
53
+ * price: the bar field (`last` = the close at bar close)
54
+ * @type {IndicatorOperandInputSourceEnum}
55
+ * @memberof IndicatorOperandInput
56
+ */
57
+ source?: IndicatorOperandInputSourceEnum;
58
+ /**
59
+ * value: the constant (right side only)
60
+ * @type {number}
61
+ * @memberof IndicatorOperandInput
62
+ */
63
+ value?: number;
64
+ }
65
+
66
+
67
+ /**
68
+ * @export
69
+ */
70
+ export const IndicatorOperandInputKindEnum = {
71
+ Indicator: 'indicator',
72
+ Price: 'price',
73
+ Volume: 'volume',
74
+ Value: 'value'
75
+ } as const;
76
+ export type IndicatorOperandInputKindEnum = typeof IndicatorOperandInputKindEnum[keyof typeof IndicatorOperandInputKindEnum];
77
+
78
+ /**
79
+ * @export
80
+ */
81
+ export const IndicatorOperandInputSourceEnum = {
82
+ Open: 'open',
83
+ High: 'high',
84
+ Low: 'low',
85
+ Close: 'close',
86
+ Last: 'last'
87
+ } as const;
88
+ export type IndicatorOperandInputSourceEnum = typeof IndicatorOperandInputSourceEnum[keyof typeof IndicatorOperandInputSourceEnum];
89
+
90
+
91
+ /**
92
+ * Check if a given object implements the IndicatorOperandInput interface.
93
+ */
94
+ export function instanceOfIndicatorOperandInput(value: object): value is IndicatorOperandInput {
95
+ if (!('kind' in value) || value['kind'] === undefined) return false;
96
+ return true;
97
+ }
98
+
99
+ export function IndicatorOperandInputFromJSON(json: any): IndicatorOperandInput {
100
+ return IndicatorOperandInputFromJSONTyped(json, false);
101
+ }
102
+
103
+ export function IndicatorOperandInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): IndicatorOperandInput {
104
+ if (json == null) {
105
+ return json;
106
+ }
107
+ return {
108
+
109
+ 'kind': json['kind'],
110
+ 'indicator_id': json['indicator_id'] == null ? undefined : json['indicator_id'],
111
+ 'series_key': json['series_key'] == null ? undefined : json['series_key'],
112
+ 'params': json['params'] == null ? undefined : json['params'],
113
+ 'label': json['label'] == null ? undefined : json['label'],
114
+ 'source': json['source'] == null ? undefined : json['source'],
115
+ 'value': json['value'] == null ? undefined : json['value'],
116
+ };
117
+ }
118
+
119
+ export function IndicatorOperandInputToJSON(json: any): IndicatorOperandInput {
120
+ return IndicatorOperandInputToJSONTyped(json, false);
121
+ }
122
+
123
+ export function IndicatorOperandInputToJSONTyped(value?: IndicatorOperandInput | null, ignoreDiscriminator: boolean = false): any {
124
+ if (value == null) {
125
+ return value;
126
+ }
127
+
128
+ return {
129
+
130
+ 'kind': value['kind'],
131
+ 'indicator_id': value['indicator_id'],
132
+ 'series_key': value['series_key'],
133
+ 'params': value['params'],
134
+ 'label': value['label'],
135
+ 'source': value['source'],
136
+ 'value': value['value'],
137
+ };
138
+ }
139
+
@@ -0,0 +1,120 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Invinite API
5
+ * Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Alerts (`POST /v1/alerts`) deliver their events to your destinations (`POST /v1/destinations`) as [Standard Webhooks](https://github.com/standard-webhooks/standard-webhooks/blob/main/spec/standard-webhooks.md): `alert.fired`, `alert.fired.batch`, `alert.status_changed`, `destination.disabled`, `destination.test`, `account.fire_cap_reached`; see `x-webhooks` for each `data` object. Every event is also on the pull feed `GET /v1/alert-events`. Every delivery is a `POST` with `Content-Type: application/json`, the body `{type, timestamp, data}` (or the destination\'s `body_template`) and the headers `webhook-id` (the event id; a batch: its `bat_…` id), `webhook-timestamp` (unix seconds) and `webhook-signature`: space-separated `v1,<base64 HMAC-SHA256 of <webhook-id>.<webhook-timestamp>.<raw body>>`, keyed with the base64-DECODED bytes of the destination\'s `whsec_…` secret — any Standard Webhooks library verifies it. After `POST /v1/destinations/{id}:rotate-secret` the old secret keeps signing beside the new one for 24 h (two `v1` entries). Reject a timestamp older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed; a body above 256 KB is not sent. A failed attempt is retried after [0, 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 10 h, 10 h, 34 h] (attempt n waits the n-th step) plus up to 10 % jitter; the delivery is dead after attempt 10. A 410 disables the destination at once; so do 72 h of nothing but failures with at least 10 failed attempts in a row (a `destination.disabled` event on the feed and a mail; `PATCH` with `status: active` re-enables it). Delivery is at-least-once and unordered: dedupe on `webhook-id`, order by `timestamp`. A `batch_webhook` destination receives `alert.fired.batch` with the pending events in `data.events[]` (dedupe on each `data.event_id`). Fires and deliveries cost no credits; two fair-use caps apply instead: at most 60 fires per alert per rolling hour (beyond: suppressed and counted in the next fire\'s `suppressed_since_last`) and per account and UTC day FREE 100 · LITE 5,000 · STANDARD 50,000 · PRO 500,000 fires (beyond: written to the feed with `delivery_skipped: fire_cap`, not delivered; one `account.fire_cap_reached` per day). ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/me` and `/v1/me/usage` serve no licensed data and carry none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account, Alerts.
6
+ *
7
+ * The version of the OpenAPI document: 2026-11-13
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ import type { IndicatorResolvedThreshold } from './IndicatorResolvedThreshold';
17
+ import {
18
+ IndicatorResolvedThresholdFromJSON,
19
+ IndicatorResolvedThresholdFromJSONTyped,
20
+ IndicatorResolvedThresholdToJSON,
21
+ IndicatorResolvedThresholdToJSONTyped,
22
+ } from './IndicatorResolvedThreshold';
23
+
24
+ /**
25
+ * What the platform runs for an indicator alert (set at create, read-only: a value sent in a request is ignored).
26
+ * @export
27
+ * @interface IndicatorResolved
28
+ */
29
+ export interface IndicatorResolved {
30
+ /**
31
+ * The compiled system script version
32
+ * @type {string}
33
+ * @memberof IndicatorResolved
34
+ */
35
+ script_version_id: string;
36
+ /**
37
+ * The inputs it runs with (defaults filled in)
38
+ * @type {{ [key: string]: any; }}
39
+ * @memberof IndicatorResolved
40
+ */
41
+ inputs: { [key: string]: any; };
42
+ /**
43
+ * `shared`: a constant-threshold crossing, evaluated once per bar for every alert on the same indicator, symbol and interval whatever the threshold; `script`: its own evaluation
44
+ * @type {IndicatorResolvedEvaluationEnum}
45
+ * @memberof IndicatorResolved
46
+ */
47
+ evaluation: IndicatorResolvedEvaluationEnum;
48
+ /**
49
+ * One-line summary of the condition
50
+ * @type {string}
51
+ * @memberof IndicatorResolved
52
+ */
53
+ summary: string;
54
+ /**
55
+ *
56
+ * @type {IndicatorResolvedThreshold}
57
+ * @memberof IndicatorResolved
58
+ */
59
+ threshold?: IndicatorResolvedThreshold;
60
+ }
61
+
62
+
63
+ /**
64
+ * @export
65
+ */
66
+ export const IndicatorResolvedEvaluationEnum = {
67
+ Shared: 'shared',
68
+ Script: 'script'
69
+ } as const;
70
+ export type IndicatorResolvedEvaluationEnum = typeof IndicatorResolvedEvaluationEnum[keyof typeof IndicatorResolvedEvaluationEnum] | (string & {});
71
+
72
+
73
+ /**
74
+ * Check if a given object implements the IndicatorResolved interface.
75
+ */
76
+ export function instanceOfIndicatorResolved(value: object): value is IndicatorResolved {
77
+ if (!('script_version_id' in value) || value['script_version_id'] === undefined) return false;
78
+ if (!('inputs' in value) || value['inputs'] === undefined) return false;
79
+ if (!('evaluation' in value) || value['evaluation'] === undefined) return false;
80
+ if (!('summary' in value) || value['summary'] === undefined) return false;
81
+ return true;
82
+ }
83
+
84
+ export function IndicatorResolvedFromJSON(json: any): IndicatorResolved {
85
+ return IndicatorResolvedFromJSONTyped(json, false);
86
+ }
87
+
88
+ export function IndicatorResolvedFromJSONTyped(json: any, ignoreDiscriminator: boolean): IndicatorResolved {
89
+ if (json == null) {
90
+ return json;
91
+ }
92
+ return {
93
+
94
+ 'script_version_id': json['script_version_id'],
95
+ 'inputs': json['inputs'],
96
+ 'evaluation': json['evaluation'],
97
+ 'summary': json['summary'],
98
+ 'threshold': json['threshold'] == null ? undefined : IndicatorResolvedThresholdFromJSON(json['threshold']),
99
+ };
100
+ }
101
+
102
+ export function IndicatorResolvedToJSON(json: any): IndicatorResolved {
103
+ return IndicatorResolvedToJSONTyped(json, false);
104
+ }
105
+
106
+ export function IndicatorResolvedToJSONTyped(value?: IndicatorResolved | null, ignoreDiscriminator: boolean = false): any {
107
+ if (value == null) {
108
+ return value;
109
+ }
110
+
111
+ return {
112
+
113
+ 'script_version_id': value['script_version_id'],
114
+ 'inputs': value['inputs'],
115
+ 'evaluation': value['evaluation'],
116
+ 'summary': value['summary'],
117
+ 'threshold': IndicatorResolvedThresholdToJSON(value['threshold']),
118
+ };
119
+ }
120
+