@invinite-org/data-api-client 6.2.0 → 6.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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/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/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/CreateScriptRequest.md +38 -0
- package/docs/CreateScriptVersionRequest.md +34 -0
- 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/ListAlertTemplates200Response.md +41 -0
- package/docs/ListScriptVersions200Response.md +41 -0
- package/docs/ListScripts200Response.md +41 -0
- 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/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/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,125 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Invinite API
|
|
5
|
+
* Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Alerts (`POST /v1/alerts`) deliver their events to your destinations (`POST /v1/destinations`) as [Standard Webhooks](https://github.com/standard-webhooks/standard-webhooks/blob/main/spec/standard-webhooks.md): `alert.fired`, `alert.fired.batch`, `alert.status_changed`, `destination.disabled`, `destination.test`, `account.fire_cap_reached`; see `x-webhooks` for each `data` object. Every event is also on the pull feed `GET /v1/alert-events`. Every delivery is a `POST` with `Content-Type: application/json`, the body `{type, timestamp, data}` (or the destination\'s `body_template`) and the headers `webhook-id` (the event id; a batch: its `bat_…` id), `webhook-timestamp` (unix seconds) and `webhook-signature`: space-separated `v1,<base64 HMAC-SHA256 of <webhook-id>.<webhook-timestamp>.<raw body>>`, keyed with the base64-DECODED bytes of the destination\'s `whsec_…` secret — any Standard Webhooks library verifies it. After `POST /v1/destinations/{id}:rotate-secret` the old secret keeps signing beside the new one for 24 h (two `v1` entries). Reject a timestamp older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed; a body above 256 KB is not sent. A failed attempt is retried after [0, 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 10 h, 10 h, 34 h] (attempt n waits the n-th step) plus up to 10 % jitter; the delivery is dead after attempt 10. A 410 disables the destination at once; so do 72 h of nothing but failures with at least 10 failed attempts in a row (a `destination.disabled` event on the feed and a mail; `PATCH` with `status: active` re-enables it). Delivery is at-least-once and unordered: dedupe on `webhook-id`, order by `timestamp`. A `batch_webhook` destination receives `alert.fired.batch` with the pending events in `data.events[]` (dedupe on each `data.event_id`). Fires and deliveries cost no credits; two fair-use caps apply instead: at most 60 fires per alert per rolling hour (beyond: suppressed and counted in the next fire\'s `suppressed_since_last`) and per account and UTC day FREE 100 · LITE 5,000 · STANDARD 50,000 · PRO 500,000 fires (beyond: written to the feed with `delivery_skipped: fire_cap`, not delivered; one `account.fire_cap_reached` per day). ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/me` and `/v1/me/usage` serve no licensed data and carry none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account, Alerts.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2026-11-13
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
import type { IndicatorFilterLeafInput } from './IndicatorFilterLeafInput';
|
|
17
|
+
import {
|
|
18
|
+
IndicatorFilterLeafInputFromJSON,
|
|
19
|
+
IndicatorFilterLeafInputFromJSONTyped,
|
|
20
|
+
IndicatorFilterLeafInputToJSON,
|
|
21
|
+
IndicatorFilterLeafInputToJSONTyped,
|
|
22
|
+
} from './IndicatorFilterLeafInput';
|
|
23
|
+
import type { IndicatorFilterConditionInput } from './IndicatorFilterConditionInput';
|
|
24
|
+
import {
|
|
25
|
+
IndicatorFilterConditionInputFromJSON,
|
|
26
|
+
IndicatorFilterConditionInputFromJSONTyped,
|
|
27
|
+
IndicatorFilterConditionInputToJSON,
|
|
28
|
+
IndicatorFilterConditionInputToJSONTyped,
|
|
29
|
+
} from './IndicatorFilterConditionInput';
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
* A filter leaf (`kind: condition` + `condition`) or one nested group (`kind: group` + `op` + `children` of leaves). (request form)
|
|
33
|
+
* @export
|
|
34
|
+
* @interface IndicatorFilterChildInput
|
|
35
|
+
*/
|
|
36
|
+
export interface IndicatorFilterChildInput {
|
|
37
|
+
/**
|
|
38
|
+
* A leaf or a group
|
|
39
|
+
* @type {IndicatorFilterChildInputKindEnum}
|
|
40
|
+
* @memberof IndicatorFilterChildInput
|
|
41
|
+
*/
|
|
42
|
+
kind: IndicatorFilterChildInputKindEnum;
|
|
43
|
+
/**
|
|
44
|
+
*
|
|
45
|
+
* @type {IndicatorFilterConditionInput}
|
|
46
|
+
* @memberof IndicatorFilterChildInput
|
|
47
|
+
*/
|
|
48
|
+
condition?: IndicatorFilterConditionInput;
|
|
49
|
+
/**
|
|
50
|
+
* group: how its leaves combine
|
|
51
|
+
* @type {IndicatorFilterChildInputOpEnum}
|
|
52
|
+
* @memberof IndicatorFilterChildInput
|
|
53
|
+
*/
|
|
54
|
+
op?: IndicatorFilterChildInputOpEnum;
|
|
55
|
+
/**
|
|
56
|
+
* group: its leaves
|
|
57
|
+
* @type {Array<IndicatorFilterLeafInput>}
|
|
58
|
+
* @memberof IndicatorFilterChildInput
|
|
59
|
+
*/
|
|
60
|
+
children?: Array<IndicatorFilterLeafInput>;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
/**
|
|
65
|
+
* @export
|
|
66
|
+
*/
|
|
67
|
+
export const IndicatorFilterChildInputKindEnum = {
|
|
68
|
+
Condition: 'condition',
|
|
69
|
+
Group: 'group'
|
|
70
|
+
} as const;
|
|
71
|
+
export type IndicatorFilterChildInputKindEnum = typeof IndicatorFilterChildInputKindEnum[keyof typeof IndicatorFilterChildInputKindEnum];
|
|
72
|
+
|
|
73
|
+
/**
|
|
74
|
+
* @export
|
|
75
|
+
*/
|
|
76
|
+
export const IndicatorFilterChildInputOpEnum = {
|
|
77
|
+
And: 'and',
|
|
78
|
+
Or: 'or'
|
|
79
|
+
} as const;
|
|
80
|
+
export type IndicatorFilterChildInputOpEnum = typeof IndicatorFilterChildInputOpEnum[keyof typeof IndicatorFilterChildInputOpEnum];
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
/**
|
|
84
|
+
* Check if a given object implements the IndicatorFilterChildInput interface.
|
|
85
|
+
*/
|
|
86
|
+
export function instanceOfIndicatorFilterChildInput(value: object): value is IndicatorFilterChildInput {
|
|
87
|
+
if (!('kind' in value) || value['kind'] === undefined) return false;
|
|
88
|
+
return true;
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
export function IndicatorFilterChildInputFromJSON(json: any): IndicatorFilterChildInput {
|
|
92
|
+
return IndicatorFilterChildInputFromJSONTyped(json, false);
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
export function IndicatorFilterChildInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): IndicatorFilterChildInput {
|
|
96
|
+
if (json == null) {
|
|
97
|
+
return json;
|
|
98
|
+
}
|
|
99
|
+
return {
|
|
100
|
+
|
|
101
|
+
'kind': json['kind'],
|
|
102
|
+
'condition': json['condition'] == null ? undefined : IndicatorFilterConditionInputFromJSON(json['condition']),
|
|
103
|
+
'op': json['op'] == null ? undefined : json['op'],
|
|
104
|
+
'children': json['children'] == null ? undefined : ((json['children'] as Array<any>).map(IndicatorFilterLeafInputFromJSON)),
|
|
105
|
+
};
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
export function IndicatorFilterChildInputToJSON(json: any): IndicatorFilterChildInput {
|
|
109
|
+
return IndicatorFilterChildInputToJSONTyped(json, false);
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
export function IndicatorFilterChildInputToJSONTyped(value?: IndicatorFilterChildInput | null, ignoreDiscriminator: boolean = false): any {
|
|
113
|
+
if (value == null) {
|
|
114
|
+
return value;
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
return {
|
|
118
|
+
|
|
119
|
+
'kind': value['kind'],
|
|
120
|
+
'condition': IndicatorFilterConditionInputToJSON(value['condition']),
|
|
121
|
+
'op': value['op'],
|
|
122
|
+
'children': value['children'] == null ? undefined : ((value['children'] as Array<any>).map(IndicatorFilterLeafInputToJSON)),
|
|
123
|
+
};
|
|
124
|
+
}
|
|
125
|
+
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Invinite API
|
|
5
|
+
* Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Alerts (`POST /v1/alerts`) deliver their events to your destinations (`POST /v1/destinations`) as [Standard Webhooks](https://github.com/standard-webhooks/standard-webhooks/blob/main/spec/standard-webhooks.md): `alert.fired`, `alert.fired.batch`, `alert.status_changed`, `destination.disabled`, `destination.test`, `account.fire_cap_reached`; see `x-webhooks` for each `data` object. Every event is also on the pull feed `GET /v1/alert-events`. Every delivery is a `POST` with `Content-Type: application/json`, the body `{type, timestamp, data}` (or the destination\'s `body_template`) and the headers `webhook-id` (the event id; a batch: its `bat_…` id), `webhook-timestamp` (unix seconds) and `webhook-signature`: space-separated `v1,<base64 HMAC-SHA256 of <webhook-id>.<webhook-timestamp>.<raw body>>`, keyed with the base64-DECODED bytes of the destination\'s `whsec_…` secret — any Standard Webhooks library verifies it. After `POST /v1/destinations/{id}:rotate-secret` the old secret keeps signing beside the new one for 24 h (two `v1` entries). Reject a timestamp older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed; a body above 256 KB is not sent. A failed attempt is retried after [0, 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 10 h, 10 h, 34 h] (attempt n waits the n-th step) plus up to 10 % jitter; the delivery is dead after attempt 10. A 410 disables the destination at once; so do 72 h of nothing but failures with at least 10 failed attempts in a row (a `destination.disabled` event on the feed and a mail; `PATCH` with `status: active` re-enables it). Delivery is at-least-once and unordered: dedupe on `webhook-id`, order by `timestamp`. A `batch_webhook` destination receives `alert.fired.batch` with the pending events in `data.events[]` (dedupe on each `data.event_id`). Fires and deliveries cost no credits; two fair-use caps apply instead: at most 60 fires per alert per rolling hour (beyond: suppressed and counted in the next fire\'s `suppressed_since_last`) and per account and UTC day FREE 100 · LITE 5,000 · STANDARD 50,000 · PRO 500,000 fires (beyond: written to the feed with `delivery_skipped: fire_cap`, not delivered; one `account.fire_cap_reached` per day). ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/me` and `/v1/me/usage` serve no licensed data and carry none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account, Alerts.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2026-11-13
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
import type { IndicatorOperand } from './IndicatorOperand';
|
|
17
|
+
import {
|
|
18
|
+
IndicatorOperandFromJSON,
|
|
19
|
+
IndicatorOperandFromJSONTyped,
|
|
20
|
+
IndicatorOperandToJSON,
|
|
21
|
+
IndicatorOperandToJSONTyped,
|
|
22
|
+
} from './IndicatorOperand';
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* A state comparison that must hold on the trigger bar.
|
|
26
|
+
* @export
|
|
27
|
+
* @interface IndicatorFilterCondition
|
|
28
|
+
*/
|
|
29
|
+
export interface IndicatorFilterCondition {
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {IndicatorOperand}
|
|
33
|
+
* @memberof IndicatorFilterCondition
|
|
34
|
+
*/
|
|
35
|
+
lhs: IndicatorOperand;
|
|
36
|
+
/**
|
|
37
|
+
* The state comparison
|
|
38
|
+
* @type {IndicatorFilterConditionComparatorEnum}
|
|
39
|
+
* @memberof IndicatorFilterCondition
|
|
40
|
+
*/
|
|
41
|
+
comparator: IndicatorFilterConditionComparatorEnum;
|
|
42
|
+
/**
|
|
43
|
+
*
|
|
44
|
+
* @type {IndicatorOperand}
|
|
45
|
+
* @memberof IndicatorFilterCondition
|
|
46
|
+
*/
|
|
47
|
+
rhs: IndicatorOperand;
|
|
48
|
+
/**
|
|
49
|
+
* Read on another timeframe of the same symbol (absent = the alert's interval)
|
|
50
|
+
* @type {IndicatorFilterConditionIntervalEnum}
|
|
51
|
+
* @memberof IndicatorFilterCondition
|
|
52
|
+
*/
|
|
53
|
+
interval?: IndicatorFilterConditionIntervalEnum;
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
/**
|
|
58
|
+
* @export
|
|
59
|
+
*/
|
|
60
|
+
export const IndicatorFilterConditionComparatorEnum = {
|
|
61
|
+
GreaterThan: 'greater_than',
|
|
62
|
+
LessThan: 'less_than',
|
|
63
|
+
GreaterThanOrEqual: 'greater_than_or_equal',
|
|
64
|
+
LessThanOrEqual: 'less_than_or_equal'
|
|
65
|
+
} as const;
|
|
66
|
+
export type IndicatorFilterConditionComparatorEnum = typeof IndicatorFilterConditionComparatorEnum[keyof typeof IndicatorFilterConditionComparatorEnum] | (string & {});
|
|
67
|
+
|
|
68
|
+
/**
|
|
69
|
+
* @export
|
|
70
|
+
*/
|
|
71
|
+
export const IndicatorFilterConditionIntervalEnum = {
|
|
72
|
+
_1m: '1m',
|
|
73
|
+
_5m: '5m',
|
|
74
|
+
_15m: '15m',
|
|
75
|
+
_30m: '30m',
|
|
76
|
+
_1h: '1h',
|
|
77
|
+
_1d: '1d'
|
|
78
|
+
} as const;
|
|
79
|
+
export type IndicatorFilterConditionIntervalEnum = typeof IndicatorFilterConditionIntervalEnum[keyof typeof IndicatorFilterConditionIntervalEnum] | (string & {});
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
/**
|
|
83
|
+
* Check if a given object implements the IndicatorFilterCondition interface.
|
|
84
|
+
*/
|
|
85
|
+
export function instanceOfIndicatorFilterCondition(value: object): value is IndicatorFilterCondition {
|
|
86
|
+
if (!('lhs' in value) || value['lhs'] === undefined) return false;
|
|
87
|
+
if (!('comparator' in value) || value['comparator'] === undefined) return false;
|
|
88
|
+
if (!('rhs' in value) || value['rhs'] === undefined) return false;
|
|
89
|
+
return true;
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
export function IndicatorFilterConditionFromJSON(json: any): IndicatorFilterCondition {
|
|
93
|
+
return IndicatorFilterConditionFromJSONTyped(json, false);
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
export function IndicatorFilterConditionFromJSONTyped(json: any, ignoreDiscriminator: boolean): IndicatorFilterCondition {
|
|
97
|
+
if (json == null) {
|
|
98
|
+
return json;
|
|
99
|
+
}
|
|
100
|
+
return {
|
|
101
|
+
|
|
102
|
+
'lhs': IndicatorOperandFromJSON(json['lhs']),
|
|
103
|
+
'comparator': json['comparator'],
|
|
104
|
+
'rhs': IndicatorOperandFromJSON(json['rhs']),
|
|
105
|
+
'interval': json['interval'] == null ? undefined : json['interval'],
|
|
106
|
+
};
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
export function IndicatorFilterConditionToJSON(json: any): IndicatorFilterCondition {
|
|
110
|
+
return IndicatorFilterConditionToJSONTyped(json, false);
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
export function IndicatorFilterConditionToJSONTyped(value?: IndicatorFilterCondition | null, ignoreDiscriminator: boolean = false): any {
|
|
114
|
+
if (value == null) {
|
|
115
|
+
return value;
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
return {
|
|
119
|
+
|
|
120
|
+
'lhs': IndicatorOperandToJSON(value['lhs']),
|
|
121
|
+
'comparator': value['comparator'],
|
|
122
|
+
'rhs': IndicatorOperandToJSON(value['rhs']),
|
|
123
|
+
'interval': value['interval'],
|
|
124
|
+
};
|
|
125
|
+
}
|
|
126
|
+
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Invinite API
|
|
5
|
+
* Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Alerts (`POST /v1/alerts`) deliver their events to your destinations (`POST /v1/destinations`) as [Standard Webhooks](https://github.com/standard-webhooks/standard-webhooks/blob/main/spec/standard-webhooks.md): `alert.fired`, `alert.fired.batch`, `alert.status_changed`, `destination.disabled`, `destination.test`, `account.fire_cap_reached`; see `x-webhooks` for each `data` object. Every event is also on the pull feed `GET /v1/alert-events`. Every delivery is a `POST` with `Content-Type: application/json`, the body `{type, timestamp, data}` (or the destination\'s `body_template`) and the headers `webhook-id` (the event id; a batch: its `bat_…` id), `webhook-timestamp` (unix seconds) and `webhook-signature`: space-separated `v1,<base64 HMAC-SHA256 of <webhook-id>.<webhook-timestamp>.<raw body>>`, keyed with the base64-DECODED bytes of the destination\'s `whsec_…` secret — any Standard Webhooks library verifies it. After `POST /v1/destinations/{id}:rotate-secret` the old secret keeps signing beside the new one for 24 h (two `v1` entries). Reject a timestamp older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed; a body above 256 KB is not sent. A failed attempt is retried after [0, 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 10 h, 10 h, 34 h] (attempt n waits the n-th step) plus up to 10 % jitter; the delivery is dead after attempt 10. A 410 disables the destination at once; so do 72 h of nothing but failures with at least 10 failed attempts in a row (a `destination.disabled` event on the feed and a mail; `PATCH` with `status: active` re-enables it). Delivery is at-least-once and unordered: dedupe on `webhook-id`, order by `timestamp`. A `batch_webhook` destination receives `alert.fired.batch` with the pending events in `data.events[]` (dedupe on each `data.event_id`). Fires and deliveries cost no credits; two fair-use caps apply instead: at most 60 fires per alert per rolling hour (beyond: suppressed and counted in the next fire\'s `suppressed_since_last`) and per account and UTC day FREE 100 · LITE 5,000 · STANDARD 50,000 · PRO 500,000 fires (beyond: written to the feed with `delivery_skipped: fire_cap`, not delivered; one `account.fire_cap_reached` per day). ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/me` and `/v1/me/usage` serve no licensed data and carry none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account, Alerts.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2026-11-13
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
import type { IndicatorOperandInput } from './IndicatorOperandInput';
|
|
17
|
+
import {
|
|
18
|
+
IndicatorOperandInputFromJSON,
|
|
19
|
+
IndicatorOperandInputFromJSONTyped,
|
|
20
|
+
IndicatorOperandInputToJSON,
|
|
21
|
+
IndicatorOperandInputToJSONTyped,
|
|
22
|
+
} from './IndicatorOperandInput';
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* A state comparison that must hold on the trigger bar. (request form)
|
|
26
|
+
* @export
|
|
27
|
+
* @interface IndicatorFilterConditionInput
|
|
28
|
+
*/
|
|
29
|
+
export interface IndicatorFilterConditionInput {
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {IndicatorOperandInput}
|
|
33
|
+
* @memberof IndicatorFilterConditionInput
|
|
34
|
+
*/
|
|
35
|
+
lhs: IndicatorOperandInput;
|
|
36
|
+
/**
|
|
37
|
+
* The state comparison
|
|
38
|
+
* @type {IndicatorFilterConditionInputComparatorEnum}
|
|
39
|
+
* @memberof IndicatorFilterConditionInput
|
|
40
|
+
*/
|
|
41
|
+
comparator: IndicatorFilterConditionInputComparatorEnum;
|
|
42
|
+
/**
|
|
43
|
+
*
|
|
44
|
+
* @type {IndicatorOperandInput}
|
|
45
|
+
* @memberof IndicatorFilterConditionInput
|
|
46
|
+
*/
|
|
47
|
+
rhs: IndicatorOperandInput;
|
|
48
|
+
/**
|
|
49
|
+
* Read on another timeframe of the same symbol (absent = the alert's interval)
|
|
50
|
+
* @type {IndicatorFilterConditionInputIntervalEnum}
|
|
51
|
+
* @memberof IndicatorFilterConditionInput
|
|
52
|
+
*/
|
|
53
|
+
interval?: IndicatorFilterConditionInputIntervalEnum;
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
/**
|
|
58
|
+
* @export
|
|
59
|
+
*/
|
|
60
|
+
export const IndicatorFilterConditionInputComparatorEnum = {
|
|
61
|
+
GreaterThan: 'greater_than',
|
|
62
|
+
LessThan: 'less_than',
|
|
63
|
+
GreaterThanOrEqual: 'greater_than_or_equal',
|
|
64
|
+
LessThanOrEqual: 'less_than_or_equal'
|
|
65
|
+
} as const;
|
|
66
|
+
export type IndicatorFilterConditionInputComparatorEnum = typeof IndicatorFilterConditionInputComparatorEnum[keyof typeof IndicatorFilterConditionInputComparatorEnum];
|
|
67
|
+
|
|
68
|
+
/**
|
|
69
|
+
* @export
|
|
70
|
+
*/
|
|
71
|
+
export const IndicatorFilterConditionInputIntervalEnum = {
|
|
72
|
+
_1m: '1m',
|
|
73
|
+
_5m: '5m',
|
|
74
|
+
_15m: '15m',
|
|
75
|
+
_30m: '30m',
|
|
76
|
+
_1h: '1h',
|
|
77
|
+
_1d: '1d'
|
|
78
|
+
} as const;
|
|
79
|
+
export type IndicatorFilterConditionInputIntervalEnum = typeof IndicatorFilterConditionInputIntervalEnum[keyof typeof IndicatorFilterConditionInputIntervalEnum];
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
/**
|
|
83
|
+
* Check if a given object implements the IndicatorFilterConditionInput interface.
|
|
84
|
+
*/
|
|
85
|
+
export function instanceOfIndicatorFilterConditionInput(value: object): value is IndicatorFilterConditionInput {
|
|
86
|
+
if (!('lhs' in value) || value['lhs'] === undefined) return false;
|
|
87
|
+
if (!('comparator' in value) || value['comparator'] === undefined) return false;
|
|
88
|
+
if (!('rhs' in value) || value['rhs'] === undefined) return false;
|
|
89
|
+
return true;
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
export function IndicatorFilterConditionInputFromJSON(json: any): IndicatorFilterConditionInput {
|
|
93
|
+
return IndicatorFilterConditionInputFromJSONTyped(json, false);
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
export function IndicatorFilterConditionInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): IndicatorFilterConditionInput {
|
|
97
|
+
if (json == null) {
|
|
98
|
+
return json;
|
|
99
|
+
}
|
|
100
|
+
return {
|
|
101
|
+
|
|
102
|
+
'lhs': IndicatorOperandInputFromJSON(json['lhs']),
|
|
103
|
+
'comparator': json['comparator'],
|
|
104
|
+
'rhs': IndicatorOperandInputFromJSON(json['rhs']),
|
|
105
|
+
'interval': json['interval'] == null ? undefined : json['interval'],
|
|
106
|
+
};
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
export function IndicatorFilterConditionInputToJSON(json: any): IndicatorFilterConditionInput {
|
|
110
|
+
return IndicatorFilterConditionInputToJSONTyped(json, false);
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
export function IndicatorFilterConditionInputToJSONTyped(value?: IndicatorFilterConditionInput | null, ignoreDiscriminator: boolean = false): any {
|
|
114
|
+
if (value == null) {
|
|
115
|
+
return value;
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
return {
|
|
119
|
+
|
|
120
|
+
'lhs': IndicatorOperandInputToJSON(value['lhs']),
|
|
121
|
+
'comparator': value['comparator'],
|
|
122
|
+
'rhs': IndicatorOperandInputToJSON(value['rhs']),
|
|
123
|
+
'interval': value['interval'],
|
|
124
|
+
};
|
|
125
|
+
}
|
|
126
|
+
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Invinite API
|
|
5
|
+
* Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Alerts (`POST /v1/alerts`) deliver their events to your destinations (`POST /v1/destinations`) as [Standard Webhooks](https://github.com/standard-webhooks/standard-webhooks/blob/main/spec/standard-webhooks.md): `alert.fired`, `alert.fired.batch`, `alert.status_changed`, `destination.disabled`, `destination.test`, `account.fire_cap_reached`; see `x-webhooks` for each `data` object. Every event is also on the pull feed `GET /v1/alert-events`. Every delivery is a `POST` with `Content-Type: application/json`, the body `{type, timestamp, data}` (or the destination\'s `body_template`) and the headers `webhook-id` (the event id; a batch: its `bat_…` id), `webhook-timestamp` (unix seconds) and `webhook-signature`: space-separated `v1,<base64 HMAC-SHA256 of <webhook-id>.<webhook-timestamp>.<raw body>>`, keyed with the base64-DECODED bytes of the destination\'s `whsec_…` secret — any Standard Webhooks library verifies it. After `POST /v1/destinations/{id}:rotate-secret` the old secret keeps signing beside the new one for 24 h (two `v1` entries). Reject a timestamp older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed; a body above 256 KB is not sent. A failed attempt is retried after [0, 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 10 h, 10 h, 34 h] (attempt n waits the n-th step) plus up to 10 % jitter; the delivery is dead after attempt 10. A 410 disables the destination at once; so do 72 h of nothing but failures with at least 10 failed attempts in a row (a `destination.disabled` event on the feed and a mail; `PATCH` with `status: active` re-enables it). Delivery is at-least-once and unordered: dedupe on `webhook-id`, order by `timestamp`. A `batch_webhook` destination receives `alert.fired.batch` with the pending events in `data.events[]` (dedupe on each `data.event_id`). Fires and deliveries cost no credits; two fair-use caps apply instead: at most 60 fires per alert per rolling hour (beyond: suppressed and counted in the next fire\'s `suppressed_since_last`) and per account and UTC day FREE 100 · LITE 5,000 · STANDARD 50,000 · PRO 500,000 fires (beyond: written to the feed with `delivery_skipped: fire_cap`, not delivered; one `account.fire_cap_reached` per day). ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/me` and `/v1/me/usage` serve no licensed data and carry none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account, Alerts.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2026-11-13
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
import type { IndicatorFilterCondition } from './IndicatorFilterCondition';
|
|
17
|
+
import {
|
|
18
|
+
IndicatorFilterConditionFromJSON,
|
|
19
|
+
IndicatorFilterConditionFromJSONTyped,
|
|
20
|
+
IndicatorFilterConditionToJSON,
|
|
21
|
+
IndicatorFilterConditionToJSONTyped,
|
|
22
|
+
} from './IndicatorFilterCondition';
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* One filter comparison.
|
|
26
|
+
* @export
|
|
27
|
+
* @interface IndicatorFilterLeaf
|
|
28
|
+
*/
|
|
29
|
+
export interface IndicatorFilterLeaf {
|
|
30
|
+
/**
|
|
31
|
+
* Always `condition`
|
|
32
|
+
* @type {IndicatorFilterLeafKindEnum}
|
|
33
|
+
* @memberof IndicatorFilterLeaf
|
|
34
|
+
*/
|
|
35
|
+
kind: IndicatorFilterLeafKindEnum;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @type {IndicatorFilterCondition}
|
|
39
|
+
* @memberof IndicatorFilterLeaf
|
|
40
|
+
*/
|
|
41
|
+
condition: IndicatorFilterCondition;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
/**
|
|
46
|
+
* @export
|
|
47
|
+
*/
|
|
48
|
+
export const IndicatorFilterLeafKindEnum = {
|
|
49
|
+
Condition: 'condition'
|
|
50
|
+
} as const;
|
|
51
|
+
export type IndicatorFilterLeafKindEnum = typeof IndicatorFilterLeafKindEnum[keyof typeof IndicatorFilterLeafKindEnum] | (string & {});
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
/**
|
|
55
|
+
* Check if a given object implements the IndicatorFilterLeaf interface.
|
|
56
|
+
*/
|
|
57
|
+
export function instanceOfIndicatorFilterLeaf(value: object): value is IndicatorFilterLeaf {
|
|
58
|
+
if (!('kind' in value) || value['kind'] === undefined) return false;
|
|
59
|
+
if (!('condition' in value) || value['condition'] === undefined) return false;
|
|
60
|
+
return true;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
export function IndicatorFilterLeafFromJSON(json: any): IndicatorFilterLeaf {
|
|
64
|
+
return IndicatorFilterLeafFromJSONTyped(json, false);
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
export function IndicatorFilterLeafFromJSONTyped(json: any, ignoreDiscriminator: boolean): IndicatorFilterLeaf {
|
|
68
|
+
if (json == null) {
|
|
69
|
+
return json;
|
|
70
|
+
}
|
|
71
|
+
return {
|
|
72
|
+
|
|
73
|
+
'kind': json['kind'],
|
|
74
|
+
'condition': IndicatorFilterConditionFromJSON(json['condition']),
|
|
75
|
+
};
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
export function IndicatorFilterLeafToJSON(json: any): IndicatorFilterLeaf {
|
|
79
|
+
return IndicatorFilterLeafToJSONTyped(json, false);
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
export function IndicatorFilterLeafToJSONTyped(value?: IndicatorFilterLeaf | null, ignoreDiscriminator: boolean = false): any {
|
|
83
|
+
if (value == null) {
|
|
84
|
+
return value;
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
return {
|
|
88
|
+
|
|
89
|
+
'kind': value['kind'],
|
|
90
|
+
'condition': IndicatorFilterConditionToJSON(value['condition']),
|
|
91
|
+
};
|
|
92
|
+
}
|
|
93
|
+
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Invinite API
|
|
5
|
+
* Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Alerts (`POST /v1/alerts`) deliver their events to your destinations (`POST /v1/destinations`) as [Standard Webhooks](https://github.com/standard-webhooks/standard-webhooks/blob/main/spec/standard-webhooks.md): `alert.fired`, `alert.fired.batch`, `alert.status_changed`, `destination.disabled`, `destination.test`, `account.fire_cap_reached`; see `x-webhooks` for each `data` object. Every event is also on the pull feed `GET /v1/alert-events`. Every delivery is a `POST` with `Content-Type: application/json`, the body `{type, timestamp, data}` (or the destination\'s `body_template`) and the headers `webhook-id` (the event id; a batch: its `bat_…` id), `webhook-timestamp` (unix seconds) and `webhook-signature`: space-separated `v1,<base64 HMAC-SHA256 of <webhook-id>.<webhook-timestamp>.<raw body>>`, keyed with the base64-DECODED bytes of the destination\'s `whsec_…` secret — any Standard Webhooks library verifies it. After `POST /v1/destinations/{id}:rotate-secret` the old secret keeps signing beside the new one for 24 h (two `v1` entries). Reject a timestamp older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed; a body above 256 KB is not sent. A failed attempt is retried after [0, 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 10 h, 10 h, 34 h] (attempt n waits the n-th step) plus up to 10 % jitter; the delivery is dead after attempt 10. A 410 disables the destination at once; so do 72 h of nothing but failures with at least 10 failed attempts in a row (a `destination.disabled` event on the feed and a mail; `PATCH` with `status: active` re-enables it). Delivery is at-least-once and unordered: dedupe on `webhook-id`, order by `timestamp`. A `batch_webhook` destination receives `alert.fired.batch` with the pending events in `data.events[]` (dedupe on each `data.event_id`). Fires and deliveries cost no credits; two fair-use caps apply instead: at most 60 fires per alert per rolling hour (beyond: suppressed and counted in the next fire\'s `suppressed_since_last`) and per account and UTC day FREE 100 · LITE 5,000 · STANDARD 50,000 · PRO 500,000 fires (beyond: written to the feed with `delivery_skipped: fire_cap`, not delivered; one `account.fire_cap_reached` per day). ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/me` and `/v1/me/usage` serve no licensed data and carry none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account, Alerts.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2026-11-13
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
import type { IndicatorFilterConditionInput } from './IndicatorFilterConditionInput';
|
|
17
|
+
import {
|
|
18
|
+
IndicatorFilterConditionInputFromJSON,
|
|
19
|
+
IndicatorFilterConditionInputFromJSONTyped,
|
|
20
|
+
IndicatorFilterConditionInputToJSON,
|
|
21
|
+
IndicatorFilterConditionInputToJSONTyped,
|
|
22
|
+
} from './IndicatorFilterConditionInput';
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* One filter comparison. (request form)
|
|
26
|
+
* @export
|
|
27
|
+
* @interface IndicatorFilterLeafInput
|
|
28
|
+
*/
|
|
29
|
+
export interface IndicatorFilterLeafInput {
|
|
30
|
+
/**
|
|
31
|
+
* Always `condition`
|
|
32
|
+
* @type {IndicatorFilterLeafInputKindEnum}
|
|
33
|
+
* @memberof IndicatorFilterLeafInput
|
|
34
|
+
*/
|
|
35
|
+
kind: IndicatorFilterLeafInputKindEnum;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @type {IndicatorFilterConditionInput}
|
|
39
|
+
* @memberof IndicatorFilterLeafInput
|
|
40
|
+
*/
|
|
41
|
+
condition: IndicatorFilterConditionInput;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
/**
|
|
46
|
+
* @export
|
|
47
|
+
*/
|
|
48
|
+
export const IndicatorFilterLeafInputKindEnum = {
|
|
49
|
+
Condition: 'condition'
|
|
50
|
+
} as const;
|
|
51
|
+
export type IndicatorFilterLeafInputKindEnum = typeof IndicatorFilterLeafInputKindEnum[keyof typeof IndicatorFilterLeafInputKindEnum];
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
/**
|
|
55
|
+
* Check if a given object implements the IndicatorFilterLeafInput interface.
|
|
56
|
+
*/
|
|
57
|
+
export function instanceOfIndicatorFilterLeafInput(value: object): value is IndicatorFilterLeafInput {
|
|
58
|
+
if (!('kind' in value) || value['kind'] === undefined) return false;
|
|
59
|
+
if (value['kind'] !== 'condition') return false;
|
|
60
|
+
|
|
61
|
+
if (!('condition' in value) || value['condition'] === undefined) return false;
|
|
62
|
+
return true;
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
export function IndicatorFilterLeafInputFromJSON(json: any): IndicatorFilterLeafInput {
|
|
66
|
+
return IndicatorFilterLeafInputFromJSONTyped(json, false);
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
export function IndicatorFilterLeafInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): IndicatorFilterLeafInput {
|
|
70
|
+
if (json == null) {
|
|
71
|
+
return json;
|
|
72
|
+
}
|
|
73
|
+
return {
|
|
74
|
+
|
|
75
|
+
'kind': json['kind'],
|
|
76
|
+
'condition': IndicatorFilterConditionInputFromJSON(json['condition']),
|
|
77
|
+
};
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
export function IndicatorFilterLeafInputToJSON(json: any): IndicatorFilterLeafInput {
|
|
81
|
+
return IndicatorFilterLeafInputToJSONTyped(json, false);
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
export function IndicatorFilterLeafInputToJSONTyped(value?: IndicatorFilterLeafInput | null, ignoreDiscriminator: boolean = false): any {
|
|
85
|
+
if (value == null) {
|
|
86
|
+
return value;
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
return {
|
|
90
|
+
|
|
91
|
+
'kind': value['kind'],
|
|
92
|
+
'condition': IndicatorFilterConditionInputToJSON(value['condition']),
|
|
93
|
+
};
|
|
94
|
+
}
|
|
95
|
+
|