@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.
- package/.openapi-generator/FILES +52 -0
- package/dist/apis/ScriptsApi.d.ts +148 -0
- package/dist/apis/ScriptsApi.js +396 -0
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/ScriptsApi.d.ts +148 -0
- package/dist/esm/apis/ScriptsApi.js +392 -0
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/Alert.d.ts +6 -0
- package/dist/esm/models/Alert.js +4 -0
- package/dist/esm/models/AlertCondition.d.ts +61 -5
- package/dist/esm/models/AlertCondition.js +27 -1
- package/dist/esm/models/AlertConditionInput.d.ts +54 -5
- package/dist/esm/models/AlertConditionInput.js +24 -1
- package/dist/esm/models/AlertTemplate.d.ts +83 -0
- package/dist/esm/models/AlertTemplate.js +79 -0
- package/dist/esm/models/AlertTemplateInput.d.ts +78 -0
- package/dist/esm/models/AlertTemplateInput.js +70 -0
- package/dist/esm/models/AlertTrigger.d.ts +1 -1
- package/dist/esm/models/AlertTriggerInput.d.ts +1 -1
- package/dist/esm/models/Company.d.ts +6 -6
- package/dist/esm/models/CreateScriptRequest.d.ts +44 -0
- package/dist/esm/models/CreateScriptRequest.js +49 -0
- package/dist/esm/models/CreateScriptVersionRequest.d.ts +32 -0
- package/dist/esm/models/CreateScriptVersionRequest.js +43 -0
- package/dist/esm/models/IndicatorCondition.d.ts +56 -0
- package/dist/esm/models/IndicatorCondition.js +62 -0
- package/dist/esm/models/IndicatorConditionInput.d.ts +56 -0
- package/dist/esm/models/IndicatorConditionInput.js +62 -0
- package/dist/esm/models/IndicatorFilterChild.d.ts +68 -0
- package/dist/esm/models/IndicatorFilterChild.js +65 -0
- package/dist/esm/models/IndicatorFilterChildInput.d.ts +68 -0
- package/dist/esm/models/IndicatorFilterChildInput.js +65 -0
- package/dist/esm/models/IndicatorFilterCondition.d.ts +73 -0
- package/dist/esm/models/IndicatorFilterCondition.js +74 -0
- package/dist/esm/models/IndicatorFilterConditionInput.d.ts +73 -0
- package/dist/esm/models/IndicatorFilterConditionInput.js +74 -0
- package/dist/esm/models/IndicatorFilterLeaf.d.ts +46 -0
- package/dist/esm/models/IndicatorFilterLeaf.js +54 -0
- package/dist/esm/models/IndicatorFilterLeafInput.d.ts +46 -0
- package/dist/esm/models/IndicatorFilterLeafInput.js +56 -0
- package/dist/esm/models/IndicatorFilters.d.ts +47 -0
- package/dist/esm/models/IndicatorFilters.js +55 -0
- package/dist/esm/models/IndicatorFiltersInput.d.ts +47 -0
- package/dist/esm/models/IndicatorFiltersInput.js +55 -0
- package/dist/esm/models/IndicatorOperand.d.ts +91 -0
- package/dist/esm/models/IndicatorOperand.js +74 -0
- package/dist/esm/models/IndicatorOperandInput.d.ts +91 -0
- package/dist/esm/models/IndicatorOperandInput.js +74 -0
- package/dist/esm/models/IndicatorResolved.d.ts +67 -0
- package/dist/esm/models/IndicatorResolved.js +65 -0
- package/dist/esm/models/IndicatorResolvedThreshold.d.ts +47 -0
- package/dist/esm/models/IndicatorResolvedThreshold.js +55 -0
- package/dist/esm/models/IndicatorTemplateRef.d.ts +46 -0
- package/dist/esm/models/IndicatorTemplateRef.js +47 -0
- package/dist/esm/models/ListAlertTemplates200Response.d.ts +52 -0
- package/dist/esm/models/ListAlertTemplates200Response.js +57 -0
- package/dist/esm/models/ListScriptVersions200Response.d.ts +52 -0
- package/dist/esm/models/ListScriptVersions200Response.js +57 -0
- package/dist/esm/models/ListScripts200Response.d.ts +52 -0
- package/dist/esm/models/ListScripts200Response.js +57 -0
- package/dist/esm/models/Script.d.ts +69 -0
- package/dist/esm/models/Script.js +68 -0
- package/dist/esm/models/ScriptDiagnostic.d.ts +64 -0
- package/dist/esm/models/ScriptDiagnostic.js +66 -0
- package/dist/esm/models/ScriptVersion.d.ts +103 -0
- package/dist/esm/models/ScriptVersion.js +91 -0
- package/dist/esm/models/index.d.ts +25 -0
- package/dist/esm/models/index.js +25 -0
- package/dist/models/Alert.d.ts +6 -0
- package/dist/models/Alert.js +4 -0
- package/dist/models/AlertCondition.d.ts +61 -5
- package/dist/models/AlertCondition.js +27 -1
- package/dist/models/AlertConditionInput.d.ts +54 -5
- package/dist/models/AlertConditionInput.js +24 -1
- package/dist/models/AlertTemplate.d.ts +83 -0
- package/dist/models/AlertTemplate.js +87 -0
- package/dist/models/AlertTemplateInput.d.ts +78 -0
- package/dist/models/AlertTemplateInput.js +78 -0
- package/dist/models/AlertTrigger.d.ts +1 -1
- package/dist/models/AlertTriggerInput.d.ts +1 -1
- package/dist/models/Company.d.ts +6 -6
- package/dist/models/CreateScriptRequest.d.ts +44 -0
- package/dist/models/CreateScriptRequest.js +56 -0
- package/dist/models/CreateScriptVersionRequest.d.ts +32 -0
- package/dist/models/CreateScriptVersionRequest.js +50 -0
- package/dist/models/IndicatorCondition.d.ts +56 -0
- package/dist/models/IndicatorCondition.js +70 -0
- package/dist/models/IndicatorConditionInput.d.ts +56 -0
- package/dist/models/IndicatorConditionInput.js +70 -0
- package/dist/models/IndicatorFilterChild.d.ts +68 -0
- package/dist/models/IndicatorFilterChild.js +73 -0
- package/dist/models/IndicatorFilterChildInput.d.ts +68 -0
- package/dist/models/IndicatorFilterChildInput.js +73 -0
- package/dist/models/IndicatorFilterCondition.d.ts +73 -0
- package/dist/models/IndicatorFilterCondition.js +82 -0
- package/dist/models/IndicatorFilterConditionInput.d.ts +73 -0
- package/dist/models/IndicatorFilterConditionInput.js +82 -0
- package/dist/models/IndicatorFilterLeaf.d.ts +46 -0
- package/dist/models/IndicatorFilterLeaf.js +62 -0
- package/dist/models/IndicatorFilterLeafInput.d.ts +46 -0
- package/dist/models/IndicatorFilterLeafInput.js +64 -0
- package/dist/models/IndicatorFilters.d.ts +47 -0
- package/dist/models/IndicatorFilters.js +63 -0
- package/dist/models/IndicatorFiltersInput.d.ts +47 -0
- package/dist/models/IndicatorFiltersInput.js +63 -0
- package/dist/models/IndicatorOperand.d.ts +91 -0
- package/dist/models/IndicatorOperand.js +82 -0
- package/dist/models/IndicatorOperandInput.d.ts +91 -0
- package/dist/models/IndicatorOperandInput.js +82 -0
- package/dist/models/IndicatorResolved.d.ts +67 -0
- package/dist/models/IndicatorResolved.js +73 -0
- package/dist/models/IndicatorResolvedThreshold.d.ts +47 -0
- package/dist/models/IndicatorResolvedThreshold.js +63 -0
- package/dist/models/IndicatorTemplateRef.d.ts +46 -0
- package/dist/models/IndicatorTemplateRef.js +54 -0
- package/dist/models/ListAlertTemplates200Response.d.ts +52 -0
- package/dist/models/ListAlertTemplates200Response.js +64 -0
- package/dist/models/ListScriptVersions200Response.d.ts +52 -0
- package/dist/models/ListScriptVersions200Response.js +64 -0
- package/dist/models/ListScripts200Response.d.ts +52 -0
- package/dist/models/ListScripts200Response.js +64 -0
- package/dist/models/Script.d.ts +69 -0
- package/dist/models/Script.js +75 -0
- package/dist/models/ScriptDiagnostic.d.ts +64 -0
- package/dist/models/ScriptDiagnostic.js +74 -0
- package/dist/models/ScriptVersion.d.ts +103 -0
- package/dist/models/ScriptVersion.js +99 -0
- package/dist/models/index.d.ts +25 -0
- package/dist/models/index.js +25 -0
- package/docs/Alert.md +2 -0
- package/docs/AlertCondition.md +15 -1
- package/docs/AlertConditionInput.md +13 -1
- package/docs/AlertTemplate.md +49 -0
- package/docs/AlertTemplateInput.md +47 -0
- package/docs/CompaniesApi.md +4 -4
- package/docs/CreateScriptRequest.md +38 -0
- package/docs/CreateScriptVersionRequest.md +34 -0
- package/docs/EventsApi.md +2 -2
- package/docs/FilingsApi.md +4 -4
- package/docs/FinancialsApi.md +12 -12
- package/docs/GuidanceApi.md +4 -4
- package/docs/HoldingsApi.md +8 -8
- package/docs/IPOsApi.md +4 -4
- package/docs/IndicatorCondition.md +39 -0
- package/docs/IndicatorConditionInput.md +39 -0
- package/docs/IndicatorFilterChild.md +41 -0
- package/docs/IndicatorFilterChildInput.md +41 -0
- package/docs/IndicatorFilterCondition.md +41 -0
- package/docs/IndicatorFilterConditionInput.md +41 -0
- package/docs/IndicatorFilterLeaf.md +37 -0
- package/docs/IndicatorFilterLeafInput.md +37 -0
- package/docs/IndicatorFilters.md +37 -0
- package/docs/IndicatorFiltersInput.md +37 -0
- package/docs/IndicatorOperand.md +47 -0
- package/docs/IndicatorOperandInput.md +47 -0
- package/docs/IndicatorResolved.md +43 -0
- package/docs/IndicatorResolvedThreshold.md +37 -0
- package/docs/IndicatorTemplateRef.md +39 -0
- package/docs/InsiderTradesApi.md +2 -2
- package/docs/InvestorDocumentsApi.md +4 -4
- package/docs/ListAlertTemplates200Response.md +41 -0
- package/docs/ListScriptVersions200Response.md +41 -0
- package/docs/ListScripts200Response.md +41 -0
- package/docs/MetricsApi.md +10 -10
- package/docs/NewsApi.md +6 -6
- package/docs/ReferenceApi.md +6 -6
- package/docs/Script.md +46 -0
- package/docs/ScriptDiagnostic.md +42 -0
- package/docs/ScriptVersion.md +54 -0
- package/docs/ScriptsApi.md +588 -0
- package/docs/TranscriptsApi.md +2 -2
- package/package.json +1 -1
- package/src/apis/ScriptsApi.ts +504 -0
- package/src/apis/index.ts +1 -0
- package/src/models/Alert.ts +9 -0
- package/src/models/AlertCondition.ts +98 -6
- package/src/models/AlertConditionInput.ts +83 -6
- package/src/models/AlertTemplate.ts +148 -0
- package/src/models/AlertTemplateInput.ts +130 -0
- package/src/models/AlertTrigger.ts +1 -1
- package/src/models/AlertTriggerInput.ts +1 -1
- package/src/models/Company.ts +6 -6
- package/src/models/CreateScriptRequest.ts +83 -0
- package/src/models/CreateScriptVersionRequest.ts +66 -0
- package/src/models/IndicatorCondition.ts +106 -0
- package/src/models/IndicatorConditionInput.ts +106 -0
- package/src/models/IndicatorFilterChild.ts +125 -0
- package/src/models/IndicatorFilterChildInput.ts +125 -0
- package/src/models/IndicatorFilterCondition.ts +126 -0
- package/src/models/IndicatorFilterConditionInput.ts +126 -0
- package/src/models/IndicatorFilterLeaf.ts +93 -0
- package/src/models/IndicatorFilterLeafInput.ts +95 -0
- package/src/models/IndicatorFilters.ts +94 -0
- package/src/models/IndicatorFiltersInput.ts +94 -0
- package/src/models/IndicatorOperand.ts +139 -0
- package/src/models/IndicatorOperandInput.ts +139 -0
- package/src/models/IndicatorResolved.ts +120 -0
- package/src/models/IndicatorResolvedThreshold.ts +87 -0
- package/src/models/IndicatorTemplateRef.ts +82 -0
- package/src/models/ListAlertTemplates200Response.ts +108 -0
- package/src/models/ListScriptVersions200Response.ts +108 -0
- package/src/models/ListScripts200Response.ts +108 -0
- package/src/models/Script.ts +128 -0
- package/src/models/ScriptDiagnostic.ts +113 -0
- package/src/models/ScriptVersion.ts +175 -0
- package/src/models/index.ts +25 -0
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Invinite API
|
|
5
|
+
* Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Alerts (`POST /v1/alerts`) deliver their events to your destinations (`POST /v1/destinations`) as [Standard Webhooks](https://github.com/standard-webhooks/standard-webhooks/blob/main/spec/standard-webhooks.md): `alert.fired`, `alert.fired.batch`, `alert.status_changed`, `destination.disabled`, `destination.test`, `account.fire_cap_reached`; see `x-webhooks` for each `data` object. Every event is also on the pull feed `GET /v1/alert-events`. Every delivery is a `POST` with `Content-Type: application/json`, the body `{type, timestamp, data}` (or the destination\'s `body_template`) and the headers `webhook-id` (the event id; a batch: its `bat_…` id), `webhook-timestamp` (unix seconds) and `webhook-signature`: space-separated `v1,<base64 HMAC-SHA256 of <webhook-id>.<webhook-timestamp>.<raw body>>`, keyed with the base64-DECODED bytes of the destination\'s `whsec_…` secret — any Standard Webhooks library verifies it. After `POST /v1/destinations/{id}:rotate-secret` the old secret keeps signing beside the new one for 24 h (two `v1` entries). Reject a timestamp older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed; a body above 256 KB is not sent. A failed attempt is retried after [0, 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 10 h, 10 h, 34 h] (attempt n waits the n-th step) plus up to 10 % jitter; the delivery is dead after attempt 10. A 410 disables the destination at once; so do 72 h of nothing but failures with at least 10 failed attempts in a row (a `destination.disabled` event on the feed and a mail; `PATCH` with `status: active` re-enables it). Delivery is at-least-once and unordered: dedupe on `webhook-id`, order by `timestamp`. A `batch_webhook` destination receives `alert.fired.batch` with the pending events in `data.events[]` (dedupe on each `data.event_id`). Fires and deliveries cost no credits; two fair-use caps apply instead: at most 60 fires per alert per rolling hour (beyond: suppressed and counted in the next fire\'s `suppressed_since_last`) and per account and UTC day FREE 100 · LITE 5,000 · STANDARD 50,000 · PRO 500,000 fires (beyond: written to the feed with `delivery_skipped: fire_cap`, not delivered; one `account.fire_cap_reached` per day). ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/me` and `/v1/me/usage` serve no licensed data and carry none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account, Alerts.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2026-11-13
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* @export
|
|
16
|
+
*/
|
|
17
|
+
export const ScriptDiagnosticSeverityEnum = {
|
|
18
|
+
Error: 'error',
|
|
19
|
+
Warning: 'warning'
|
|
20
|
+
};
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the ScriptDiagnostic interface.
|
|
23
|
+
*/
|
|
24
|
+
export function instanceOfScriptDiagnostic(value) {
|
|
25
|
+
if (!('line' in value) || value['line'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
if (!('column' in value) || value['column'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
if (!('message' in value) || value['message'] === undefined)
|
|
30
|
+
return false;
|
|
31
|
+
if (!('code' in value) || value['code'] === undefined)
|
|
32
|
+
return false;
|
|
33
|
+
if (!('severity' in value) || value['severity'] === undefined)
|
|
34
|
+
return false;
|
|
35
|
+
return true;
|
|
36
|
+
}
|
|
37
|
+
export function ScriptDiagnosticFromJSON(json) {
|
|
38
|
+
return ScriptDiagnosticFromJSONTyped(json, false);
|
|
39
|
+
}
|
|
40
|
+
export function ScriptDiagnosticFromJSONTyped(json, ignoreDiscriminator) {
|
|
41
|
+
if (json == null) {
|
|
42
|
+
return json;
|
|
43
|
+
}
|
|
44
|
+
return {
|
|
45
|
+
'line': json['line'],
|
|
46
|
+
'column': json['column'],
|
|
47
|
+
'message': json['message'],
|
|
48
|
+
'code': json['code'],
|
|
49
|
+
'severity': json['severity'],
|
|
50
|
+
};
|
|
51
|
+
}
|
|
52
|
+
export function ScriptDiagnosticToJSON(json) {
|
|
53
|
+
return ScriptDiagnosticToJSONTyped(json, false);
|
|
54
|
+
}
|
|
55
|
+
export function ScriptDiagnosticToJSONTyped(value, ignoreDiscriminator = false) {
|
|
56
|
+
if (value == null) {
|
|
57
|
+
return value;
|
|
58
|
+
}
|
|
59
|
+
return {
|
|
60
|
+
'line': value['line'],
|
|
61
|
+
'column': value['column'],
|
|
62
|
+
'message': value['message'],
|
|
63
|
+
'code': value['code'],
|
|
64
|
+
'severity': value['severity'],
|
|
65
|
+
};
|
|
66
|
+
}
|
|
@@ -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,91 @@
|
|
|
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
|
+
import { ScriptDiagnosticFromJSON, ScriptDiagnosticToJSON, } from './ScriptDiagnostic';
|
|
15
|
+
/**
|
|
16
|
+
* @export
|
|
17
|
+
*/
|
|
18
|
+
export const ScriptVersionStatusEnum = {
|
|
19
|
+
Ok: 'ok',
|
|
20
|
+
Error: 'error'
|
|
21
|
+
};
|
|
22
|
+
/**
|
|
23
|
+
* Check if a given object implements the ScriptVersion interface.
|
|
24
|
+
*/
|
|
25
|
+
export function instanceOfScriptVersion(value) {
|
|
26
|
+
if (!('id' in value) || value['id'] === undefined)
|
|
27
|
+
return false;
|
|
28
|
+
if (!('script_id' in value) || value['script_id'] === undefined)
|
|
29
|
+
return false;
|
|
30
|
+
if (!('version' in value) || value['version'] === undefined)
|
|
31
|
+
return false;
|
|
32
|
+
if (!('status' in value) || value['status'] === undefined)
|
|
33
|
+
return false;
|
|
34
|
+
if (!('compiler_version' in value) || value['compiler_version'] === undefined)
|
|
35
|
+
return false;
|
|
36
|
+
if (!('source_sha256' in value) || value['source_sha256'] === undefined)
|
|
37
|
+
return false;
|
|
38
|
+
if (!('source' in value) || value['source'] === undefined)
|
|
39
|
+
return false;
|
|
40
|
+
if (!('diagnostics' in value) || value['diagnostics'] === undefined)
|
|
41
|
+
return false;
|
|
42
|
+
if (!('manifest' in value) || value['manifest'] === undefined)
|
|
43
|
+
return false;
|
|
44
|
+
if (!('alert_ids' in value) || value['alert_ids'] === undefined)
|
|
45
|
+
return false;
|
|
46
|
+
if (!('created_at' in value) || value['created_at'] === undefined)
|
|
47
|
+
return false;
|
|
48
|
+
return true;
|
|
49
|
+
}
|
|
50
|
+
export function ScriptVersionFromJSON(json) {
|
|
51
|
+
return ScriptVersionFromJSONTyped(json, false);
|
|
52
|
+
}
|
|
53
|
+
export function ScriptVersionFromJSONTyped(json, ignoreDiscriminator) {
|
|
54
|
+
if (json == null) {
|
|
55
|
+
return json;
|
|
56
|
+
}
|
|
57
|
+
return {
|
|
58
|
+
'id': json['id'],
|
|
59
|
+
'script_id': json['script_id'],
|
|
60
|
+
'version': json['version'],
|
|
61
|
+
'status': json['status'],
|
|
62
|
+
'compiler_version': json['compiler_version'],
|
|
63
|
+
'source_sha256': json['source_sha256'],
|
|
64
|
+
'source': json['source'],
|
|
65
|
+
'diagnostics': (json['diagnostics'].map(ScriptDiagnosticFromJSON)),
|
|
66
|
+
'manifest': json['manifest'],
|
|
67
|
+
'alert_ids': json['alert_ids'],
|
|
68
|
+
'created_at': (new Date(json['created_at'])),
|
|
69
|
+
};
|
|
70
|
+
}
|
|
71
|
+
export function ScriptVersionToJSON(json) {
|
|
72
|
+
return ScriptVersionToJSONTyped(json, false);
|
|
73
|
+
}
|
|
74
|
+
export function ScriptVersionToJSONTyped(value, ignoreDiscriminator = false) {
|
|
75
|
+
if (value == null) {
|
|
76
|
+
return value;
|
|
77
|
+
}
|
|
78
|
+
return {
|
|
79
|
+
'id': value['id'],
|
|
80
|
+
'script_id': value['script_id'],
|
|
81
|
+
'version': value['version'],
|
|
82
|
+
'status': value['status'],
|
|
83
|
+
'compiler_version': value['compiler_version'],
|
|
84
|
+
'source_sha256': value['source_sha256'],
|
|
85
|
+
'source': value['source'],
|
|
86
|
+
'diagnostics': (value['diagnostics'].map(ScriptDiagnosticToJSON)),
|
|
87
|
+
'manifest': value['manifest'],
|
|
88
|
+
'alert_ids': value['alert_ids'],
|
|
89
|
+
'created_at': value['created_at'].toISOString(),
|
|
90
|
+
};
|
|
91
|
+
}
|
|
@@ -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';
|
package/dist/esm/models/index.js
CHANGED
|
@@ -19,6 +19,8 @@ export * from './AlertConditionYieldRule';
|
|
|
19
19
|
export * from './AlertConditionYoyRulesInner';
|
|
20
20
|
export * from './AlertEvent';
|
|
21
21
|
export * from './AlertQuotaUsage';
|
|
22
|
+
export * from './AlertTemplate';
|
|
23
|
+
export * from './AlertTemplateInput';
|
|
22
24
|
export * from './AlertTestAccepted';
|
|
23
25
|
export * from './AlertTrigger';
|
|
24
26
|
export * from './AlertTriggerActiveWindow';
|
|
@@ -50,6 +52,8 @@ export * from './CompanyListItem';
|
|
|
50
52
|
export * from './CompanyRef';
|
|
51
53
|
export * from './CreateAlertRequest';
|
|
52
54
|
export * from './CreateDestinationRequest';
|
|
55
|
+
export * from './CreateScriptRequest';
|
|
56
|
+
export * from './CreateScriptVersionRequest';
|
|
53
57
|
export * from './Dataset';
|
|
54
58
|
export * from './Destination';
|
|
55
59
|
export * from './DestinationCreated';
|
|
@@ -125,6 +129,21 @@ export * from './GuidanceItemSourcesInner';
|
|
|
125
129
|
export * from './HitMatch';
|
|
126
130
|
export * from './Holding';
|
|
127
131
|
export * from './HoldingChange';
|
|
132
|
+
export * from './IndicatorCondition';
|
|
133
|
+
export * from './IndicatorConditionInput';
|
|
134
|
+
export * from './IndicatorFilterChild';
|
|
135
|
+
export * from './IndicatorFilterChildInput';
|
|
136
|
+
export * from './IndicatorFilterCondition';
|
|
137
|
+
export * from './IndicatorFilterConditionInput';
|
|
138
|
+
export * from './IndicatorFilterLeaf';
|
|
139
|
+
export * from './IndicatorFilterLeafInput';
|
|
140
|
+
export * from './IndicatorFilters';
|
|
141
|
+
export * from './IndicatorFiltersInput';
|
|
142
|
+
export * from './IndicatorOperand';
|
|
143
|
+
export * from './IndicatorOperandInput';
|
|
144
|
+
export * from './IndicatorResolved';
|
|
145
|
+
export * from './IndicatorResolvedThreshold';
|
|
146
|
+
export * from './IndicatorTemplateRef';
|
|
128
147
|
export * from './InsiderTrade';
|
|
129
148
|
export * from './InsiderTradeFootnote';
|
|
130
149
|
export * from './InvestorDocument';
|
|
@@ -139,6 +158,7 @@ export * from './KpiMention';
|
|
|
139
158
|
export * from './KpiMentionFilingLink';
|
|
140
159
|
export * from './KpiMentionFilingLinkFactPeriod';
|
|
141
160
|
export * from './ListAlertEvents200Response';
|
|
161
|
+
export * from './ListAlertTemplates200Response';
|
|
142
162
|
export * from './ListAlerts200Response';
|
|
143
163
|
export * from './ListAlerts200ResponseMeta';
|
|
144
164
|
export * from './ListAnnouncements200Response';
|
|
@@ -188,6 +208,8 @@ export * from './ListParticipants200Response';
|
|
|
188
208
|
export * from './ListPeople200Response';
|
|
189
209
|
export * from './ListQa200Response';
|
|
190
210
|
export * from './ListRatios200Response';
|
|
211
|
+
export * from './ListScriptVersions200Response';
|
|
212
|
+
export * from './ListScripts200Response';
|
|
191
213
|
export * from './ListSectionCatalog200Response';
|
|
192
214
|
export * from './ListSegments200Response';
|
|
193
215
|
export * from './ListSegmentsDetailed200Response';
|
|
@@ -243,6 +265,9 @@ export * from './QaPairScores';
|
|
|
243
265
|
export * from './QaPairScoresEvidence';
|
|
244
266
|
export * from './RatioPeriod';
|
|
245
267
|
export * from './ReviewChain';
|
|
268
|
+
export * from './Script';
|
|
269
|
+
export * from './ScriptDiagnostic';
|
|
270
|
+
export * from './ScriptVersion';
|
|
246
271
|
export * from './SearchCoverage';
|
|
247
272
|
export * from './SearchCoverageLeg';
|
|
248
273
|
export * from './SearchFilings200Response';
|
package/dist/models/Alert.d.ts
CHANGED
|
@@ -35,6 +35,12 @@ export interface Alert {
|
|
|
35
35
|
* @memberof Alert
|
|
36
36
|
*/
|
|
37
37
|
status: AlertStatusEnum;
|
|
38
|
+
/**
|
|
39
|
+
* Why the platform disabled the alert (`script_error`: its script aborted on 3 bars in a row); null otherwise
|
|
40
|
+
* @type {string}
|
|
41
|
+
* @memberof Alert
|
|
42
|
+
*/
|
|
43
|
+
disabled_reason: string | null;
|
|
38
44
|
/**
|
|
39
45
|
*
|
|
40
46
|
* @type {AlertCondition}
|
package/dist/models/Alert.js
CHANGED
|
@@ -64,6 +64,8 @@ function instanceOfAlert(value) {
|
|
|
64
64
|
return false;
|
|
65
65
|
if (!('status' in value) || value['status'] === undefined)
|
|
66
66
|
return false;
|
|
67
|
+
if (!('disabled_reason' in value) || value['disabled_reason'] === undefined)
|
|
68
|
+
return false;
|
|
67
69
|
if (!('condition' in value) || value['condition'] === undefined)
|
|
68
70
|
return false;
|
|
69
71
|
if (!('trigger' in value) || value['trigger'] === undefined)
|
|
@@ -103,6 +105,7 @@ function AlertFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
103
105
|
'id': json['id'],
|
|
104
106
|
'type': json['type'],
|
|
105
107
|
'status': json['status'],
|
|
108
|
+
'disabled_reason': json['disabled_reason'],
|
|
106
109
|
'condition': (0, AlertCondition_1.AlertConditionFromJSON)(json['condition']),
|
|
107
110
|
'trigger': (0, AlertTrigger_1.AlertTriggerFromJSON)(json['trigger']),
|
|
108
111
|
'destination_ids': json['destination_ids'],
|
|
@@ -129,6 +132,7 @@ function AlertToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
129
132
|
'id': value['id'],
|
|
130
133
|
'type': value['type'],
|
|
131
134
|
'status': value['status'],
|
|
135
|
+
'disabled_reason': value['disabled_reason'],
|
|
132
136
|
'condition': (0, AlertCondition_1.AlertConditionToJSON)(value['condition']),
|
|
133
137
|
'trigger': (0, AlertTrigger_1.AlertTriggerToJSON)(value['trigger']),
|
|
134
138
|
'destination_ids': value['destination_ids'],
|
|
@@ -9,13 +9,17 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import type { IndicatorFilters } from './IndicatorFilters';
|
|
12
13
|
import type { AlertConditionAmountChange } from './AlertConditionAmountChange';
|
|
13
14
|
import type { AlertConditionMentionDeltaRule } from './AlertConditionMentionDeltaRule';
|
|
15
|
+
import type { IndicatorTemplateRef } from './IndicatorTemplateRef';
|
|
14
16
|
import type { AlertConditionRulesInner } from './AlertConditionRulesInner';
|
|
17
|
+
import type { IndicatorResolved } from './IndicatorResolved';
|
|
15
18
|
import type { AlertConditionYieldRule } from './AlertConditionYieldRule';
|
|
16
19
|
import type { AlertConditionYoyRulesInner } from './AlertConditionYoyRulesInner';
|
|
20
|
+
import type { IndicatorCondition } from './IndicatorCondition';
|
|
17
21
|
/**
|
|
18
|
-
* What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Price types (`price`, `price_move`, `volume_spike`, `price_reminder`) watch ONE instrument: `symbol` + `asset_class`. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls. US ETFs: `dividend`, `event_countdown` (`ex_dividend` / `dividend_payment`), `filing` and `filing_keyword` take an ETF ticker (SPY or a trust series such as TQQQ; a series ETF is stored by symbol and fires only on events that name it, never on another series' filing of its trust); `earnings_call`, `earnings_call_keyword`, `earnings_results`, `fundamental_metric` and an `earnings_call` countdown refuse an ETF by name (400 `invalid_parameter`)
|
|
22
|
+
* What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Price types (`price`, `price_move`, `volume_spike`, `price_reminder`) and `script` watch ONE instrument: `symbol` + `asset_class`. A `script` alert runs a script version (`/v1/scripts`) at each close of `interval`; alerts with the same version, instrument, interval, inputs and frequency share one evaluation. An `indicator` alert takes a built-in `template` (`GET /v1/alert-templates`) or a structured `condition` (+ optional `filters`) on `symbol` / `interval`; alerts crossing a constant on the same indicator, instrument and interval share one evaluation whatever the threshold. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls. US ETFs: `dividend`, `event_countdown` (`ex_dividend` / `dividend_payment`), `filing` and `filing_keyword` take an ETF ticker (SPY or a trust series such as TQQQ; a series ETF is stored by symbol and fires only on events that name it, never on another series' filing of its trust); `earnings_call`, `earnings_call_keyword`, `earnings_results`, `fundamental_metric`, `news`, `news_keyword` and an `earnings_call` countdown refuse an ETF of either identity (its ticker or a fund registrant's CIK) by name (400 `invalid_parameter`).
|
|
19
23
|
* @export
|
|
20
24
|
* @interface AlertCondition
|
|
21
25
|
*/
|
|
@@ -39,7 +43,7 @@ export interface AlertCondition {
|
|
|
39
43
|
*/
|
|
40
44
|
cik?: string;
|
|
41
45
|
/**
|
|
42
|
-
* The company (or, for the types that take ETFs, the US ETF) by ticker. Same types as `cik`; price types: the instrument (a US stock / ETF ticker, or a crypto slug / ticker)
|
|
46
|
+
* The company (or, for the types that take ETFs, the US ETF) by ticker. Same types as `cik`; price types, script and indicator: the instrument (a US stock / ETF ticker, or a crypto slug / ticker)
|
|
43
47
|
* @type {string}
|
|
44
48
|
* @memberof AlertCondition
|
|
45
49
|
*/
|
|
@@ -219,7 +223,7 @@ export interface AlertCondition {
|
|
|
219
223
|
*/
|
|
220
224
|
notify_on_date_change?: boolean;
|
|
221
225
|
/**
|
|
222
|
-
* The instrument's market: `us_stock` (US stocks and ETFs) or `crypto` (coins by CoinGecko slug or ticker). Absent at create = a stock first, then a coin; stored resolved. price, price_move, volume_spike, price_reminder
|
|
226
|
+
* The instrument's market: `us_stock` (US stocks and ETFs) or `crypto` (coins by CoinGecko slug or ticker). Absent at create = a stock first, then a coin; stored resolved. price, price_move, volume_spike, price_reminder, script, indicator
|
|
223
227
|
* @type {AlertConditionAssetClassEnum}
|
|
224
228
|
* @memberof AlertCondition
|
|
225
229
|
*/
|
|
@@ -267,7 +271,7 @@ export interface AlertCondition {
|
|
|
267
271
|
*/
|
|
268
272
|
mode?: AlertConditionModeEnum;
|
|
269
273
|
/**
|
|
270
|
-
* The bar evaluated at its close (
|
|
274
|
+
* The bar evaluated at its close. volume_spike (1h, 1d, 1w, 1mo); script and indicator (1m, 5m, 15m, 30m, 1h, 4h, 1d; the plan's shortest: FREE / LITE 1h, STANDARD 5m, PRO 1m)
|
|
271
275
|
* @type {AlertConditionIntervalEnum}
|
|
272
276
|
* @memberof AlertCondition
|
|
273
277
|
*/
|
|
@@ -303,7 +307,7 @@ export interface AlertCondition {
|
|
|
303
307
|
*/
|
|
304
308
|
price_direction?: AlertConditionPriceDirectionEnum;
|
|
305
309
|
/**
|
|
306
|
-
*
|
|
310
|
+
* price_reminder: when the reminder fires — once at `at`, on the hour, daily or weekly at `time_of_day_minutes`. script: when the script's alerts deliver — `once_per_bar_close` (default) at most once per alert id and closed bar, `once_per_bar` the same, `every_time` every evaluation, `once` the first evaluation only. indicator: the same (`once` = this alert's first fire only). price_reminder, script, indicator
|
|
307
311
|
* @type {AlertConditionFrequencyEnum}
|
|
308
312
|
* @memberof AlertCondition
|
|
309
313
|
*/
|
|
@@ -326,6 +330,50 @@ export interface AlertCondition {
|
|
|
326
330
|
* @memberof AlertCondition
|
|
327
331
|
*/
|
|
328
332
|
days?: Array<number>;
|
|
333
|
+
/**
|
|
334
|
+
* The script version evaluated (`scv_…`, status ok, of a script of this account). script
|
|
335
|
+
* @type {string}
|
|
336
|
+
* @memberof AlertCondition
|
|
337
|
+
*/
|
|
338
|
+
script_version_id?: string;
|
|
339
|
+
/**
|
|
340
|
+
* Values for the script's declared inputs (checked against its manifest; absent = the defaults). script
|
|
341
|
+
* @type {{ [key: string]: any; }}
|
|
342
|
+
* @memberof AlertCondition
|
|
343
|
+
*/
|
|
344
|
+
inputs?: {
|
|
345
|
+
[key: string]: any;
|
|
346
|
+
};
|
|
347
|
+
/**
|
|
348
|
+
* Only these of the script's alerts (its version's `alert_ids`); empty = all. script
|
|
349
|
+
* @type {Array<string>}
|
|
350
|
+
* @memberof AlertCondition
|
|
351
|
+
*/
|
|
352
|
+
alert_ids?: Array<string>;
|
|
353
|
+
/**
|
|
354
|
+
*
|
|
355
|
+
* @type {IndicatorTemplateRef}
|
|
356
|
+
* @memberof AlertCondition
|
|
357
|
+
*/
|
|
358
|
+
template?: IndicatorTemplateRef;
|
|
359
|
+
/**
|
|
360
|
+
*
|
|
361
|
+
* @type {IndicatorCondition}
|
|
362
|
+
* @memberof AlertCondition
|
|
363
|
+
*/
|
|
364
|
+
condition?: IndicatorCondition;
|
|
365
|
+
/**
|
|
366
|
+
*
|
|
367
|
+
* @type {IndicatorFilters}
|
|
368
|
+
* @memberof AlertCondition
|
|
369
|
+
*/
|
|
370
|
+
filters?: IndicatorFilters;
|
|
371
|
+
/**
|
|
372
|
+
*
|
|
373
|
+
* @type {IndicatorResolved}
|
|
374
|
+
* @memberof AlertCondition
|
|
375
|
+
*/
|
|
376
|
+
resolved?: IndicatorResolved;
|
|
329
377
|
}
|
|
330
378
|
/**
|
|
331
379
|
* @export
|
|
@@ -493,7 +541,12 @@ export type AlertConditionModeEnum = typeof AlertConditionModeEnum[keyof typeof
|
|
|
493
541
|
* @export
|
|
494
542
|
*/
|
|
495
543
|
export declare const AlertConditionIntervalEnum: {
|
|
544
|
+
readonly _1m: "1m";
|
|
545
|
+
readonly _5m: "5m";
|
|
546
|
+
readonly _15m: "15m";
|
|
547
|
+
readonly _30m: "30m";
|
|
496
548
|
readonly _1h: "1h";
|
|
549
|
+
readonly _4h: "4h";
|
|
497
550
|
readonly _1d: "1d";
|
|
498
551
|
readonly _1w: "1w";
|
|
499
552
|
readonly _1mo: "1mo";
|
|
@@ -525,6 +578,9 @@ export declare const AlertConditionFrequencyEnum: {
|
|
|
525
578
|
readonly Hourly: "hourly";
|
|
526
579
|
readonly Daily: "daily";
|
|
527
580
|
readonly Weekly: "weekly";
|
|
581
|
+
readonly OncePerBar: "once_per_bar";
|
|
582
|
+
readonly OncePerBarClose: "once_per_bar_close";
|
|
583
|
+
readonly EveryTime: "every_time";
|
|
528
584
|
};
|
|
529
585
|
export type AlertConditionFrequencyEnum = typeof AlertConditionFrequencyEnum[keyof typeof AlertConditionFrequencyEnum] | (string & {});
|
|
530
586
|
/**
|
|
@@ -19,11 +19,15 @@ exports.AlertConditionFromJSON = AlertConditionFromJSON;
|
|
|
19
19
|
exports.AlertConditionFromJSONTyped = AlertConditionFromJSONTyped;
|
|
20
20
|
exports.AlertConditionToJSON = AlertConditionToJSON;
|
|
21
21
|
exports.AlertConditionToJSONTyped = AlertConditionToJSONTyped;
|
|
22
|
+
const IndicatorFilters_1 = require("./IndicatorFilters");
|
|
22
23
|
const AlertConditionAmountChange_1 = require("./AlertConditionAmountChange");
|
|
23
24
|
const AlertConditionMentionDeltaRule_1 = require("./AlertConditionMentionDeltaRule");
|
|
25
|
+
const IndicatorTemplateRef_1 = require("./IndicatorTemplateRef");
|
|
24
26
|
const AlertConditionRulesInner_1 = require("./AlertConditionRulesInner");
|
|
27
|
+
const IndicatorResolved_1 = require("./IndicatorResolved");
|
|
25
28
|
const AlertConditionYieldRule_1 = require("./AlertConditionYieldRule");
|
|
26
29
|
const AlertConditionYoyRulesInner_1 = require("./AlertConditionYoyRulesInner");
|
|
30
|
+
const IndicatorCondition_1 = require("./IndicatorCondition");
|
|
27
31
|
/**
|
|
28
32
|
* @export
|
|
29
33
|
*/
|
|
@@ -175,7 +179,12 @@ exports.AlertConditionModeEnum = {
|
|
|
175
179
|
* @export
|
|
176
180
|
*/
|
|
177
181
|
exports.AlertConditionIntervalEnum = {
|
|
182
|
+
_1m: '1m',
|
|
183
|
+
_5m: '5m',
|
|
184
|
+
_15m: '15m',
|
|
185
|
+
_30m: '30m',
|
|
178
186
|
_1h: '1h',
|
|
187
|
+
_4h: '4h',
|
|
179
188
|
_1d: '1d',
|
|
180
189
|
_1w: '1w',
|
|
181
190
|
_1mo: '1mo'
|
|
@@ -203,7 +212,10 @@ exports.AlertConditionFrequencyEnum = {
|
|
|
203
212
|
Once: 'once',
|
|
204
213
|
Hourly: 'hourly',
|
|
205
214
|
Daily: 'daily',
|
|
206
|
-
Weekly: 'weekly'
|
|
215
|
+
Weekly: 'weekly',
|
|
216
|
+
OncePerBar: 'once_per_bar',
|
|
217
|
+
OncePerBarClose: 'once_per_bar_close',
|
|
218
|
+
EveryTime: 'every_time'
|
|
207
219
|
};
|
|
208
220
|
/**
|
|
209
221
|
* Check if a given object implements the AlertCondition interface.
|
|
@@ -270,6 +282,13 @@ function AlertConditionFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
270
282
|
'at': json['at'] == null ? undefined : (new Date(json['at'])),
|
|
271
283
|
'weekday': json['weekday'] == null ? undefined : json['weekday'],
|
|
272
284
|
'days': json['days'] == null ? undefined : json['days'],
|
|
285
|
+
'script_version_id': json['script_version_id'] == null ? undefined : json['script_version_id'],
|
|
286
|
+
'inputs': json['inputs'] == null ? undefined : json['inputs'],
|
|
287
|
+
'alert_ids': json['alert_ids'] == null ? undefined : json['alert_ids'],
|
|
288
|
+
'template': json['template'] == null ? undefined : (0, IndicatorTemplateRef_1.IndicatorTemplateRefFromJSON)(json['template']),
|
|
289
|
+
'condition': json['condition'] == null ? undefined : (0, IndicatorCondition_1.IndicatorConditionFromJSON)(json['condition']),
|
|
290
|
+
'filters': json['filters'] == null ? undefined : (0, IndicatorFilters_1.IndicatorFiltersFromJSON)(json['filters']),
|
|
291
|
+
'resolved': json['resolved'] == null ? undefined : (0, IndicatorResolved_1.IndicatorResolvedFromJSON)(json['resolved']),
|
|
273
292
|
};
|
|
274
293
|
}
|
|
275
294
|
function AlertConditionToJSON(json) {
|
|
@@ -331,5 +350,12 @@ function AlertConditionToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
331
350
|
'at': value['at'] == null ? value['at'] : value['at'].toISOString(),
|
|
332
351
|
'weekday': value['weekday'],
|
|
333
352
|
'days': value['days'],
|
|
353
|
+
'script_version_id': value['script_version_id'],
|
|
354
|
+
'inputs': value['inputs'],
|
|
355
|
+
'alert_ids': value['alert_ids'],
|
|
356
|
+
'template': (0, IndicatorTemplateRef_1.IndicatorTemplateRefToJSON)(value['template']),
|
|
357
|
+
'condition': (0, IndicatorCondition_1.IndicatorConditionToJSON)(value['condition']),
|
|
358
|
+
'filters': (0, IndicatorFilters_1.IndicatorFiltersToJSON)(value['filters']),
|
|
359
|
+
'resolved': (0, IndicatorResolved_1.IndicatorResolvedToJSON)(value['resolved']),
|
|
334
360
|
};
|
|
335
361
|
}
|