@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
@@ -23,6 +23,8 @@ docs/AlertConditionYoyRulesInner.md
23
23
  docs/AlertEvent.md
24
24
  docs/AlertEventsApi.md
25
25
  docs/AlertQuotaUsage.md
26
+ docs/AlertTemplate.md
27
+ docs/AlertTemplateInput.md
26
28
  docs/AlertTestAccepted.md
27
29
  docs/AlertTrigger.md
28
30
  docs/AlertTriggerActiveWindow.md
@@ -58,6 +60,8 @@ docs/CompanyListItem.md
58
60
  docs/CompanyRef.md
59
61
  docs/CreateAlertRequest.md
60
62
  docs/CreateDestinationRequest.md
63
+ docs/CreateScriptRequest.md
64
+ docs/CreateScriptVersionRequest.md
61
65
  docs/Dataset.md
62
66
  docs/Destination.md
63
67
  docs/DestinationCreated.md
@@ -141,6 +145,21 @@ docs/Holding.md
141
145
  docs/HoldingChange.md
142
146
  docs/HoldingsApi.md
143
147
  docs/IPOsApi.md
148
+ docs/IndicatorCondition.md
149
+ docs/IndicatorConditionInput.md
150
+ docs/IndicatorFilterChild.md
151
+ docs/IndicatorFilterChildInput.md
152
+ docs/IndicatorFilterCondition.md
153
+ docs/IndicatorFilterConditionInput.md
154
+ docs/IndicatorFilterLeaf.md
155
+ docs/IndicatorFilterLeafInput.md
156
+ docs/IndicatorFilters.md
157
+ docs/IndicatorFiltersInput.md
158
+ docs/IndicatorOperand.md
159
+ docs/IndicatorOperandInput.md
160
+ docs/IndicatorResolved.md
161
+ docs/IndicatorResolvedThreshold.md
162
+ docs/IndicatorTemplateRef.md
144
163
  docs/InsiderTrade.md
145
164
  docs/InsiderTradeFootnote.md
146
165
  docs/InsiderTradesApi.md
@@ -157,6 +176,7 @@ docs/KpiMention.md
157
176
  docs/KpiMentionFilingLink.md
158
177
  docs/KpiMentionFilingLinkFactPeriod.md
159
178
  docs/ListAlertEvents200Response.md
179
+ docs/ListAlertTemplates200Response.md
160
180
  docs/ListAlerts200Response.md
161
181
  docs/ListAlerts200ResponseMeta.md
162
182
  docs/ListAnnouncements200Response.md
@@ -206,6 +226,8 @@ docs/ListParticipants200Response.md
206
226
  docs/ListPeople200Response.md
207
227
  docs/ListQa200Response.md
208
228
  docs/ListRatios200Response.md
229
+ docs/ListScriptVersions200Response.md
230
+ docs/ListScripts200Response.md
209
231
  docs/ListSectionCatalog200Response.md
210
232
  docs/ListSegments200Response.md
211
233
  docs/ListSegmentsDetailed200Response.md
@@ -264,6 +286,10 @@ docs/QaPairScoresEvidence.md
264
286
  docs/RatioPeriod.md
265
287
  docs/ReferenceApi.md
266
288
  docs/ReviewChain.md
289
+ docs/Script.md
290
+ docs/ScriptDiagnostic.md
291
+ docs/ScriptVersion.md
292
+ docs/ScriptsApi.md
267
293
  docs/SearchCoverage.md
268
294
  docs/SearchCoverageLeg.md
269
295
  docs/SearchFilings200Response.md
@@ -333,6 +359,7 @@ src/apis/InvestorDocumentsApi.ts
333
359
  src/apis/MetricsApi.ts
334
360
  src/apis/NewsApi.ts
335
361
  src/apis/ReferenceApi.ts
362
+ src/apis/ScriptsApi.ts
336
363
  src/apis/TranscriptsApi.ts
337
364
  src/apis/index.ts
338
365
  src/errors.ts
@@ -356,6 +383,8 @@ src/models/AlertConditionYieldRule.ts
356
383
  src/models/AlertConditionYoyRulesInner.ts
357
384
  src/models/AlertEvent.ts
358
385
  src/models/AlertQuotaUsage.ts
386
+ src/models/AlertTemplate.ts
387
+ src/models/AlertTemplateInput.ts
359
388
  src/models/AlertTestAccepted.ts
360
389
  src/models/AlertTrigger.ts
361
390
  src/models/AlertTriggerActiveWindow.ts
@@ -387,6 +416,8 @@ src/models/CompanyListItem.ts
387
416
  src/models/CompanyRef.ts
388
417
  src/models/CreateAlertRequest.ts
389
418
  src/models/CreateDestinationRequest.ts
419
+ src/models/CreateScriptRequest.ts
420
+ src/models/CreateScriptVersionRequest.ts
390
421
  src/models/Dataset.ts
391
422
  src/models/Destination.ts
392
423
  src/models/DestinationCreated.ts
@@ -462,6 +493,21 @@ src/models/GuidanceItemSourcesInner.ts
462
493
  src/models/HitMatch.ts
463
494
  src/models/Holding.ts
464
495
  src/models/HoldingChange.ts
496
+ src/models/IndicatorCondition.ts
497
+ src/models/IndicatorConditionInput.ts
498
+ src/models/IndicatorFilterChild.ts
499
+ src/models/IndicatorFilterChildInput.ts
500
+ src/models/IndicatorFilterCondition.ts
501
+ src/models/IndicatorFilterConditionInput.ts
502
+ src/models/IndicatorFilterLeaf.ts
503
+ src/models/IndicatorFilterLeafInput.ts
504
+ src/models/IndicatorFilters.ts
505
+ src/models/IndicatorFiltersInput.ts
506
+ src/models/IndicatorOperand.ts
507
+ src/models/IndicatorOperandInput.ts
508
+ src/models/IndicatorResolved.ts
509
+ src/models/IndicatorResolvedThreshold.ts
510
+ src/models/IndicatorTemplateRef.ts
465
511
  src/models/InsiderTrade.ts
466
512
  src/models/InsiderTradeFootnote.ts
467
513
  src/models/InvestorDocument.ts
@@ -476,6 +522,7 @@ src/models/KpiMention.ts
476
522
  src/models/KpiMentionFilingLink.ts
477
523
  src/models/KpiMentionFilingLinkFactPeriod.ts
478
524
  src/models/ListAlertEvents200Response.ts
525
+ src/models/ListAlertTemplates200Response.ts
479
526
  src/models/ListAlerts200Response.ts
480
527
  src/models/ListAlerts200ResponseMeta.ts
481
528
  src/models/ListAnnouncements200Response.ts
@@ -525,6 +572,8 @@ src/models/ListParticipants200Response.ts
525
572
  src/models/ListPeople200Response.ts
526
573
  src/models/ListQa200Response.ts
527
574
  src/models/ListRatios200Response.ts
575
+ src/models/ListScriptVersions200Response.ts
576
+ src/models/ListScripts200Response.ts
528
577
  src/models/ListSectionCatalog200Response.ts
529
578
  src/models/ListSegments200Response.ts
530
579
  src/models/ListSegmentsDetailed200Response.ts
@@ -580,6 +629,9 @@ src/models/QaPairScores.ts
580
629
  src/models/QaPairScoresEvidence.ts
581
630
  src/models/RatioPeriod.ts
582
631
  src/models/ReviewChain.ts
632
+ src/models/Script.ts
633
+ src/models/ScriptDiagnostic.ts
634
+ src/models/ScriptVersion.ts
583
635
  src/models/SearchCoverage.ts
584
636
  src/models/SearchCoverageLeg.ts
585
637
  src/models/SearchFilings200Response.ts
@@ -0,0 +1,148 @@
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 * as runtime from '../runtime';
13
+ import { type CreateScriptRequest } from '../models/CreateScriptRequest';
14
+ import { type CreateScriptVersionRequest } from '../models/CreateScriptVersionRequest';
15
+ import { type ListAlertTemplates200Response } from '../models/ListAlertTemplates200Response';
16
+ import { type ListScriptVersions200Response } from '../models/ListScriptVersions200Response';
17
+ import { type ListScripts200Response } from '../models/ListScripts200Response';
18
+ import { type Script } from '../models/Script';
19
+ import { type ScriptVersion } from '../models/ScriptVersion';
20
+ export interface CreateScriptOperationRequest {
21
+ createScriptRequest: CreateScriptRequest;
22
+ }
23
+ export interface CreateScriptVersionOperationRequest {
24
+ id: string;
25
+ createScriptVersionRequest: CreateScriptVersionRequest;
26
+ }
27
+ export interface DeleteScriptRequest {
28
+ id: string;
29
+ }
30
+ export interface GetScriptRequest {
31
+ id: string;
32
+ }
33
+ export interface ListAlertTemplatesRequest {
34
+ limit?: number;
35
+ cursor?: string;
36
+ }
37
+ export interface ListScriptVersionsRequest {
38
+ id: string;
39
+ limit?: number;
40
+ cursor?: string;
41
+ }
42
+ export interface ListScriptsRequest {
43
+ limit?: number;
44
+ cursor?: string;
45
+ }
46
+ /**
47
+ *
48
+ */
49
+ export declare class ScriptsApi extends runtime.BaseAPI {
50
+ /**
51
+ * Creates request options for createScript without sending the request
52
+ */
53
+ createScriptRequestOpts(requestParameters: CreateScriptOperationRequest): Promise<runtime.RequestOpts>;
54
+ /**
55
+ * Creates the script and its version 1, compiled server-side (≤ 10 s, one compile per account at a time — a second concurrent upload answers 429 with Retry-After; a busy compiler 503 with Retry-After). A compile error is still a 201: the version has `status: error` and `diagnostics` (line, column, message). Answers 503 `unavailable` while hosted scripts are switched off.
56
+ * Upload a script
57
+ */
58
+ createScriptRaw(requestParameters: CreateScriptOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Script>>;
59
+ /**
60
+ * Creates the script and its version 1, compiled server-side (≤ 10 s, one compile per account at a time — a second concurrent upload answers 429 with Retry-After; a busy compiler 503 with Retry-After). A compile error is still a 201: the version has `status: error` and `diagnostics` (line, column, message). Answers 503 `unavailable` while hosted scripts are switched off.
61
+ * Upload a script
62
+ */
63
+ createScript(requestParameters: CreateScriptOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Script>;
64
+ /**
65
+ * Creates request options for createScriptVersion without sending the request
66
+ */
67
+ createScriptVersionRequestOpts(requestParameters: CreateScriptVersionOperationRequest): Promise<runtime.RequestOpts>;
68
+ /**
69
+ * Adds the next version of the script (at most 20 per script), compiled like the first. Existing alerts keep their version. Answers 503 `unavailable` while hosted scripts are switched off.
70
+ * Upload a new script version
71
+ */
72
+ createScriptVersionRaw(requestParameters: CreateScriptVersionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScriptVersion>>;
73
+ /**
74
+ * Adds the next version of the script (at most 20 per script), compiled like the first. Existing alerts keep their version. Answers 503 `unavailable` while hosted scripts are switched off.
75
+ * Upload a new script version
76
+ */
77
+ createScriptVersion(requestParameters: CreateScriptVersionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScriptVersion>;
78
+ /**
79
+ * Creates request options for deleteScript without sending the request
80
+ */
81
+ deleteScriptRequestOpts(requestParameters: DeleteScriptRequest): Promise<runtime.RequestOpts>;
82
+ /**
83
+ * Deletes the script and its versions (204). 409 `conflict` while an alert uses one of its versions (delete those alerts first). Answers 503 `unavailable` while hosted scripts are switched off.
84
+ * Delete a script
85
+ */
86
+ deleteScriptRaw(requestParameters: DeleteScriptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<any>>;
87
+ /**
88
+ * Deletes the script and its versions (204). 409 `conflict` while an alert uses one of its versions (delete those alerts first). Answers 503 `unavailable` while hosted scripts are switched off.
89
+ * Delete a script
90
+ */
91
+ deleteScript(requestParameters: DeleteScriptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<any>;
92
+ /**
93
+ * Creates request options for getScript without sending the request
94
+ */
95
+ getScriptRequestOpts(requestParameters: GetScriptRequest): Promise<runtime.RequestOpts>;
96
+ /**
97
+ * One script with its latest version. Answers 503 `unavailable` while hosted scripts are switched off.
98
+ * Get a script
99
+ */
100
+ getScriptRaw(requestParameters: GetScriptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Script>>;
101
+ /**
102
+ * One script with its latest version. Answers 503 `unavailable` while hosted scripts are switched off.
103
+ * Get a script
104
+ */
105
+ getScript(requestParameters: GetScriptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Script>;
106
+ /**
107
+ * Creates request options for listAlertTemplates without sending the request
108
+ */
109
+ listAlertTemplatesRequestOpts(requestParameters: ListAlertTemplatesRequest): Promise<runtime.RequestOpts>;
110
+ /**
111
+ * The built-in templates of the `indicator` alert type: key, version, inputs with their defaults, snapshot fidelity and chartlang source. Answers 503 `unavailable` while hosted scripts are switched off.
112
+ * List indicator alert templates
113
+ */
114
+ listAlertTemplatesRaw(requestParameters: ListAlertTemplatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListAlertTemplates200Response>>;
115
+ /**
116
+ * The built-in templates of the `indicator` alert type: key, version, inputs with their defaults, snapshot fidelity and chartlang source. Answers 503 `unavailable` while hosted scripts are switched off.
117
+ * List indicator alert templates
118
+ */
119
+ listAlertTemplates(requestParameters?: ListAlertTemplatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListAlertTemplates200Response>;
120
+ /**
121
+ * Creates request options for listScriptVersions without sending the request
122
+ */
123
+ listScriptVersionsRequestOpts(requestParameters: ListScriptVersionsRequest): Promise<runtime.RequestOpts>;
124
+ /**
125
+ * The script\'s versions, oldest first. Answers 503 `unavailable` while hosted scripts are switched off.
126
+ * List script versions
127
+ */
128
+ listScriptVersionsRaw(requestParameters: ListScriptVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListScriptVersions200Response>>;
129
+ /**
130
+ * The script\'s versions, oldest first. Answers 503 `unavailable` while hosted scripts are switched off.
131
+ * List script versions
132
+ */
133
+ listScriptVersions(requestParameters: ListScriptVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListScriptVersions200Response>;
134
+ /**
135
+ * Creates request options for listScripts without sending the request
136
+ */
137
+ listScriptsRequestOpts(requestParameters: ListScriptsRequest): Promise<runtime.RequestOpts>;
138
+ /**
139
+ * The account\'s scripts, oldest first, each with its latest version. Answers 503 `unavailable` while hosted scripts are switched off.
140
+ * List scripts
141
+ */
142
+ listScriptsRaw(requestParameters: ListScriptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListScripts200Response>>;
143
+ /**
144
+ * The account\'s scripts, oldest first, each with its latest version. Answers 503 `unavailable` while hosted scripts are switched off.
145
+ * List scripts
146
+ */
147
+ listScripts(requestParameters?: ListScriptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListScripts200Response>;
148
+ }