@invinite-org/data-api-client 5.0.0 → 5.5.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 +5 -0
- package/README.md +29 -10
- package/dist/errors.d.ts +39 -0
- package/dist/errors.js +98 -0
- package/dist/esm/errors.d.ts +39 -0
- package/dist/esm/errors.js +93 -0
- package/dist/esm/index.d.ts +1 -0
- package/dist/esm/index.js +1 -0
- package/dist/esm/models/Event.d.ts +14 -0
- package/dist/esm/models/Event.js +6 -0
- package/dist/esm/models/EventPeriodicReport.d.ts +62 -0
- package/dist/esm/models/EventPeriodicReport.js +63 -0
- package/dist/esm/models/EventResultsFiling.d.ts +50 -0
- package/dist/esm/models/EventResultsFiling.js +55 -0
- package/dist/esm/models/Problem.d.ts +6 -0
- package/dist/esm/models/Problem.js +4 -0
- package/dist/esm/models/index.d.ts +2 -0
- package/dist/esm/models/index.js +2 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +1 -0
- package/dist/models/Event.d.ts +14 -0
- package/dist/models/Event.js +6 -0
- package/dist/models/EventPeriodicReport.d.ts +62 -0
- package/dist/models/EventPeriodicReport.js +70 -0
- package/dist/models/EventResultsFiling.d.ts +50 -0
- package/dist/models/EventResultsFiling.js +62 -0
- package/dist/models/Problem.d.ts +6 -0
- package/dist/models/Problem.js +4 -0
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/docs/Event.md +4 -0
- package/docs/EventPeriodicReport.md +45 -0
- package/docs/EventResultsFiling.md +41 -0
- package/docs/Problem.md +2 -0
- package/package.json +1 -1
- package/src/errors.ts +123 -0
- package/src/index.ts +1 -0
- package/src/models/Event.ts +30 -0
- package/src/models/EventPeriodicReport.ts +111 -0
- package/src/models/EventResultsFiling.ts +93 -0
- package/src/models/Problem.ts +9 -0
- package/src/models/index.ts +2 -0
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
|
|
2
|
+
# EventResultsFiling
|
|
3
|
+
|
|
4
|
+
The results filing: the earnings 8-K / 6-K (or its first attributed filing) whose EDGAR acceptance stamped `results_released_at`. Read the document with the SEC filing operations by `accession`. null before the results are filed. Appended 2026-11
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`accession` | string
|
|
11
|
+
`form` | string
|
|
12
|
+
`accepted_at` | Date
|
|
13
|
+
`edgar_index_url` | string
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import type { EventResultsFiling } from '@invinite-org/data-api-client'
|
|
19
|
+
|
|
20
|
+
// TODO: Update the object below with actual values
|
|
21
|
+
const example = {
|
|
22
|
+
"accession": null,
|
|
23
|
+
"form": null,
|
|
24
|
+
"accepted_at": null,
|
|
25
|
+
"edgar_index_url": null,
|
|
26
|
+
} satisfies EventResultsFiling
|
|
27
|
+
|
|
28
|
+
console.log(example)
|
|
29
|
+
|
|
30
|
+
// Convert the instance to a JSON string
|
|
31
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
32
|
+
console.log(exampleJSON)
|
|
33
|
+
|
|
34
|
+
// Parse the JSON string back to an object
|
|
35
|
+
const exampleParsed = JSON.parse(exampleJSON) as EventResultsFiling
|
|
36
|
+
console.log(exampleParsed)
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
40
|
+
|
|
41
|
+
|
package/docs/Problem.md
CHANGED
|
@@ -14,6 +14,7 @@ Name | Type
|
|
|
14
14
|
`code` | string
|
|
15
15
|
`param` | string
|
|
16
16
|
`errors` | [Array<ProblemErrorsInner>](ProblemErrorsInner.md)
|
|
17
|
+
`remedy` | string
|
|
17
18
|
`request_id` | string
|
|
18
19
|
`docs_url` | string
|
|
19
20
|
|
|
@@ -31,6 +32,7 @@ const example = {
|
|
|
31
32
|
"code": invalid_parameter,
|
|
32
33
|
"param": limit,
|
|
33
34
|
"errors": null,
|
|
35
|
+
"remedy": Pass a limit of at most 200, or walk the pages with next_cursor.,
|
|
34
36
|
"request_id": req_01JCX3V7Q9W2N8M4K6T0B5R1YZ,
|
|
35
37
|
"docs_url": https://data.invinite.com/docs/errors#invalid_parameter,
|
|
36
38
|
} satisfies Problem
|
package/package.json
CHANGED
package/src/errors.ts
ADDED
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Typed problem errors: every 4xx / 5xx answer of the Data API is an RFC 9457 `application/problem+json` body
|
|
5
|
+
* `{ type, title, status, detail, code, param?, errors?, remedy, request_id, docs_url }`.
|
|
6
|
+
*
|
|
7
|
+
* Hand-written, not generated from the spec: `sdks/data/templates/typescript/errors.mustache` in
|
|
8
|
+
* outraday-org/invinite-data-api.
|
|
9
|
+
*
|
|
10
|
+
* ```ts
|
|
11
|
+
* try {
|
|
12
|
+
* await filings.listFilings({ company: "AAPL", limit: 500 });
|
|
13
|
+
* } catch (error) {
|
|
14
|
+
* const problem = await toApiError(error);
|
|
15
|
+
* if (!problem) throw error;
|
|
16
|
+
* console.error(problem.detail);
|
|
17
|
+
* console.error(problem.remedy);
|
|
18
|
+
* }
|
|
19
|
+
* ```
|
|
20
|
+
*/
|
|
21
|
+
import { ResponseError } from './runtime';
|
|
22
|
+
|
|
23
|
+
/** One parameter problem of a 400 (`errors[]`). */
|
|
24
|
+
export interface InviniteApiErrorIssue {
|
|
25
|
+
param: string | null;
|
|
26
|
+
code: string;
|
|
27
|
+
detail: string;
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
/** A problem answer of the Data API, read once from a `ResponseError`. */
|
|
31
|
+
export class InviniteApiError extends Error {
|
|
32
|
+
override name: "InviniteApiError" = "InviniteApiError";
|
|
33
|
+
|
|
34
|
+
/** HTTP status of the answer. */
|
|
35
|
+
readonly status: number;
|
|
36
|
+
/** Stable lower_snake code (`invalid_parameter`, `not_found`, …). */
|
|
37
|
+
readonly code: string;
|
|
38
|
+
/** What happened, one sentence. */
|
|
39
|
+
readonly detail: string;
|
|
40
|
+
/** What to do next, one sentence (absent only on an answer that does not carry it). */
|
|
41
|
+
readonly remedy?: string;
|
|
42
|
+
/** The parameter the problem is about. */
|
|
43
|
+
readonly param?: string;
|
|
44
|
+
/** Every parameter problem of a 400. */
|
|
45
|
+
readonly errors?: InviniteApiErrorIssue[];
|
|
46
|
+
/** The `X-Request-Id` of the answer: quote it when reporting a problem. */
|
|
47
|
+
readonly requestId: string;
|
|
48
|
+
/** Documentation of the code. */
|
|
49
|
+
readonly docsUrl: string;
|
|
50
|
+
/** The `Retry-After` header in milliseconds (429 / 503). */
|
|
51
|
+
readonly retryAfterMs?: number;
|
|
52
|
+
/** The whole problem body. */
|
|
53
|
+
readonly body: Record<string, unknown>;
|
|
54
|
+
/** The HTTP response it was read from. */
|
|
55
|
+
readonly response: Response;
|
|
56
|
+
|
|
57
|
+
constructor(response: Response, body: Record<string, unknown>) {
|
|
58
|
+
const text = (key: string): string | undefined => (typeof body[key] === "string" ? (body[key] as string) : undefined);
|
|
59
|
+
const detail = text("detail") ?? text("title") ?? `HTTP ${response.status}`;
|
|
60
|
+
|
|
61
|
+
super(detail);
|
|
62
|
+
|
|
63
|
+
Object.setPrototypeOf(this, new.target.prototype);
|
|
64
|
+
|
|
65
|
+
this.status = typeof body.status === "number" ? body.status : response.status;
|
|
66
|
+
this.code = text("code") ?? "";
|
|
67
|
+
this.detail = detail;
|
|
68
|
+
this.remedy = text("remedy");
|
|
69
|
+
this.param = text("param");
|
|
70
|
+
this.errors = Array.isArray(body.errors) ? (body.errors as InviniteApiErrorIssue[]) : undefined;
|
|
71
|
+
this.requestId = text("request_id") ?? response.headers.get("X-Request-Id") ?? "";
|
|
72
|
+
this.docsUrl = text("docs_url") ?? "";
|
|
73
|
+
|
|
74
|
+
const retryAfter = Number(response.headers.get("Retry-After") ?? Number.NaN);
|
|
75
|
+
|
|
76
|
+
this.retryAfterMs = Number.isFinite(retryAfter) && retryAfter >= 0 ? retryAfter * 1000 : undefined;
|
|
77
|
+
this.body = body;
|
|
78
|
+
this.response = response;
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
const read = new WeakMap<object, Promise<InviniteApiError | undefined>>();
|
|
83
|
+
|
|
84
|
+
async function parse(error: ResponseError): Promise<InviniteApiError | undefined> {
|
|
85
|
+
const response = error.response;
|
|
86
|
+
|
|
87
|
+
if (!response || response.bodyUsed) return undefined;
|
|
88
|
+
|
|
89
|
+
let body: unknown;
|
|
90
|
+
|
|
91
|
+
try {
|
|
92
|
+
// A clone: the caller can still read `error.response` itself.
|
|
93
|
+
body = JSON.parse(await response.clone().text());
|
|
94
|
+
} catch {
|
|
95
|
+
return undefined;
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
if (typeof body !== "object" || body === null || Array.isArray(body)) return undefined;
|
|
99
|
+
|
|
100
|
+
if (typeof (body as Record<string, unknown>).code !== "string") return undefined;
|
|
101
|
+
|
|
102
|
+
return new InviniteApiError(response, body as Record<string, unknown>);
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
/**
|
|
106
|
+
* The problem behind an error a generated method threw: an `InviniteApiError` for a `ResponseError` whose body is a
|
|
107
|
+
* problem, `undefined` for anything else (a network error, a non-problem body, an already-read body). The body is
|
|
108
|
+
* read once per error; calling it again returns the same object.
|
|
109
|
+
*/
|
|
110
|
+
export async function toApiError(e: unknown): Promise<InviniteApiError | undefined> {
|
|
111
|
+
if (e instanceof InviniteApiError) return e;
|
|
112
|
+
|
|
113
|
+
if (!(e instanceof ResponseError)) return undefined;
|
|
114
|
+
|
|
115
|
+
let pending = read.get(e);
|
|
116
|
+
|
|
117
|
+
if (!pending) {
|
|
118
|
+
pending = parse(e);
|
|
119
|
+
read.set(e, pending);
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
return pending;
|
|
123
|
+
}
|
package/src/index.ts
CHANGED
package/src/models/Event.ts
CHANGED
|
@@ -13,6 +13,20 @@
|
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
15
|
import { mapValues } from '../runtime';
|
|
16
|
+
import type { EventPeriodicReport } from './EventPeriodicReport';
|
|
17
|
+
import {
|
|
18
|
+
EventPeriodicReportFromJSON,
|
|
19
|
+
EventPeriodicReportFromJSONTyped,
|
|
20
|
+
EventPeriodicReportToJSON,
|
|
21
|
+
EventPeriodicReportToJSONTyped,
|
|
22
|
+
} from './EventPeriodicReport';
|
|
23
|
+
import type { EventResultsFiling } from './EventResultsFiling';
|
|
24
|
+
import {
|
|
25
|
+
EventResultsFilingFromJSON,
|
|
26
|
+
EventResultsFilingFromJSONTyped,
|
|
27
|
+
EventResultsFilingToJSON,
|
|
28
|
+
EventResultsFilingToJSONTyped,
|
|
29
|
+
} from './EventResultsFiling';
|
|
16
30
|
import type { EventVideo } from './EventVideo';
|
|
17
31
|
import {
|
|
18
32
|
EventVideoFromJSON,
|
|
@@ -215,6 +229,18 @@ export interface Event {
|
|
|
215
229
|
* @memberof Event
|
|
216
230
|
*/
|
|
217
231
|
video: EventVideo | null;
|
|
232
|
+
/**
|
|
233
|
+
*
|
|
234
|
+
* @type {EventResultsFiling}
|
|
235
|
+
* @memberof Event
|
|
236
|
+
*/
|
|
237
|
+
results_filing?: EventResultsFiling | null;
|
|
238
|
+
/**
|
|
239
|
+
*
|
|
240
|
+
* @type {EventPeriodicReport}
|
|
241
|
+
* @memberof Event
|
|
242
|
+
*/
|
|
243
|
+
periodic_report?: EventPeriodicReport | null;
|
|
218
244
|
/**
|
|
219
245
|
* Date / time observations, oldest first (at most 50)
|
|
220
246
|
* @type {Array<EventObservationsInner>}
|
|
@@ -366,6 +392,8 @@ export function EventFromJSONTyped(json: any, ignoreDiscriminator: boolean): Eve
|
|
|
366
392
|
'has_documents': json['has_documents'],
|
|
367
393
|
'webcast_url': json['webcast_url'],
|
|
368
394
|
'video': EventVideoFromJSON(json['video']),
|
|
395
|
+
'results_filing': json['results_filing'] == null ? undefined : EventResultsFilingFromJSON(json['results_filing']),
|
|
396
|
+
'periodic_report': json['periodic_report'] == null ? undefined : EventPeriodicReportFromJSON(json['periodic_report']),
|
|
369
397
|
'observations': json['observations'] == null ? undefined : ((json['observations'] as Array<any>).map(EventObservationsInnerFromJSON)),
|
|
370
398
|
'calendar': json['calendar'] == null ? undefined : EventCalendarFromJSON(json['calendar']),
|
|
371
399
|
};
|
|
@@ -411,6 +439,8 @@ export function EventToJSONTyped(value?: Event | null, ignoreDiscriminator: bool
|
|
|
411
439
|
'has_documents': value['has_documents'],
|
|
412
440
|
'webcast_url': value['webcast_url'],
|
|
413
441
|
'video': EventVideoToJSON(value['video']),
|
|
442
|
+
'results_filing': EventResultsFilingToJSON(value['results_filing']),
|
|
443
|
+
'periodic_report': EventPeriodicReportToJSON(value['periodic_report']),
|
|
414
444
|
'observations': value['observations'] == null ? undefined : ((value['observations'] as Array<any>).map(EventObservationsInnerToJSON)),
|
|
415
445
|
'calendar': EventCalendarToJSON(value['calendar']),
|
|
416
446
|
};
|
|
@@ -0,0 +1,111 @@
|
|
|
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 SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`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 Accounts on LITE and above subscribe with `POST /v1/webhooks` to the `event.*` lifecycle events (filtered by company) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the companies it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `event.test` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `event.test` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## 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.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2026-11-11
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
/**
|
|
17
|
+
* The periodic report of the event's fiscal period: the 10-Q (10-QT) for a fiscal Q1–Q3, the 10-K (10-KT, 20-F, 40-F) for a fiscal Q4. null until it is filed and attributed; never an amendment. A foreign filer has none for Q1–Q3 (no quarterly form). Appended 2026-11
|
|
18
|
+
* @export
|
|
19
|
+
* @interface EventPeriodicReport
|
|
20
|
+
*/
|
|
21
|
+
export interface EventPeriodicReport {
|
|
22
|
+
/**
|
|
23
|
+
* SEC accession number (0000320193-26-000024)
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof EventPeriodicReport
|
|
26
|
+
*/
|
|
27
|
+
accession: string;
|
|
28
|
+
/**
|
|
29
|
+
* Form type (10-Q, 10-QT, 10-K, 10-KT, 20-F, 40-F)
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof EventPeriodicReport
|
|
32
|
+
*/
|
|
33
|
+
form: string;
|
|
34
|
+
/**
|
|
35
|
+
* Period end the filing reports (YYYY-MM-DD)
|
|
36
|
+
* @type {Date}
|
|
37
|
+
* @memberof EventPeriodicReport
|
|
38
|
+
*/
|
|
39
|
+
period_end: Date | null;
|
|
40
|
+
/**
|
|
41
|
+
* SEC filing date (YYYY-MM-DD)
|
|
42
|
+
* @type {Date}
|
|
43
|
+
* @memberof EventPeriodicReport
|
|
44
|
+
*/
|
|
45
|
+
filing_date: Date | null;
|
|
46
|
+
/**
|
|
47
|
+
* EDGAR acceptance time (ISO 8601 UTC)
|
|
48
|
+
* @type {Date}
|
|
49
|
+
* @memberof EventPeriodicReport
|
|
50
|
+
*/
|
|
51
|
+
accepted_at: Date | null;
|
|
52
|
+
/**
|
|
53
|
+
* The filing's EDGAR index page; null when the CIK is unknown
|
|
54
|
+
* @type {string}
|
|
55
|
+
* @memberof EventPeriodicReport
|
|
56
|
+
*/
|
|
57
|
+
edgar_index_url: string | null;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
/**
|
|
61
|
+
* Check if a given object implements the EventPeriodicReport interface.
|
|
62
|
+
*/
|
|
63
|
+
export function instanceOfEventPeriodicReport(value: object): value is EventPeriodicReport {
|
|
64
|
+
if (!('accession' in value) || value['accession'] === undefined) return false;
|
|
65
|
+
if (!('form' in value) || value['form'] === undefined) return false;
|
|
66
|
+
if (!('period_end' in value) || value['period_end'] === undefined) return false;
|
|
67
|
+
if (!('filing_date' in value) || value['filing_date'] === undefined) return false;
|
|
68
|
+
if (!('accepted_at' in value) || value['accepted_at'] === undefined) return false;
|
|
69
|
+
if (!('edgar_index_url' in value) || value['edgar_index_url'] === undefined) return false;
|
|
70
|
+
return true;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
export function EventPeriodicReportFromJSON(json: any): EventPeriodicReport {
|
|
74
|
+
return EventPeriodicReportFromJSONTyped(json, false);
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
export function EventPeriodicReportFromJSONTyped(json: any, ignoreDiscriminator: boolean): EventPeriodicReport {
|
|
78
|
+
if (json == null) {
|
|
79
|
+
return json;
|
|
80
|
+
}
|
|
81
|
+
return {
|
|
82
|
+
|
|
83
|
+
'accession': json['accession'],
|
|
84
|
+
'form': json['form'],
|
|
85
|
+
'period_end': (json['period_end'] == null ? null : new Date(json['period_end'])),
|
|
86
|
+
'filing_date': (json['filing_date'] == null ? null : new Date(json['filing_date'])),
|
|
87
|
+
'accepted_at': (json['accepted_at'] == null ? null : new Date(json['accepted_at'])),
|
|
88
|
+
'edgar_index_url': json['edgar_index_url'],
|
|
89
|
+
};
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
export function EventPeriodicReportToJSON(json: any): EventPeriodicReport {
|
|
93
|
+
return EventPeriodicReportToJSONTyped(json, false);
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
export function EventPeriodicReportToJSONTyped(value?: EventPeriodicReport | null, ignoreDiscriminator: boolean = false): any {
|
|
97
|
+
if (value == null) {
|
|
98
|
+
return value;
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
return {
|
|
102
|
+
|
|
103
|
+
'accession': value['accession'],
|
|
104
|
+
'form': value['form'],
|
|
105
|
+
'period_end': value['period_end'] == null ? value['period_end'] : value['period_end'].toISOString().substring(0,10),
|
|
106
|
+
'filing_date': value['filing_date'] == null ? value['filing_date'] : value['filing_date'].toISOString().substring(0,10),
|
|
107
|
+
'accepted_at': value['accepted_at'] == null ? value['accepted_at'] : value['accepted_at'].toISOString(),
|
|
108
|
+
'edgar_index_url': value['edgar_index_url'],
|
|
109
|
+
};
|
|
110
|
+
}
|
|
111
|
+
|
|
@@ -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 SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`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 Accounts on LITE and above subscribe with `POST /v1/webhooks` to the `event.*` lifecycle events (filtered by company) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the companies it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `event.test` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `event.test` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## 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.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2026-11-11
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
/**
|
|
17
|
+
* The results filing: the earnings 8-K / 6-K (or its first attributed filing) whose EDGAR acceptance stamped `results_released_at`. Read the document with the SEC filing operations by `accession`. null before the results are filed. Appended 2026-11
|
|
18
|
+
* @export
|
|
19
|
+
* @interface EventResultsFiling
|
|
20
|
+
*/
|
|
21
|
+
export interface EventResultsFiling {
|
|
22
|
+
/**
|
|
23
|
+
* SEC accession number (0000320193-26-000024)
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof EventResultsFiling
|
|
26
|
+
*/
|
|
27
|
+
accession: string;
|
|
28
|
+
/**
|
|
29
|
+
* Form type (8-K, 8-K/A, 6-K, 6-K/A)
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof EventResultsFiling
|
|
32
|
+
*/
|
|
33
|
+
form: string;
|
|
34
|
+
/**
|
|
35
|
+
* EDGAR acceptance time (ISO 8601 UTC)
|
|
36
|
+
* @type {Date}
|
|
37
|
+
* @memberof EventResultsFiling
|
|
38
|
+
*/
|
|
39
|
+
accepted_at: Date | null;
|
|
40
|
+
/**
|
|
41
|
+
* The filing's EDGAR index page; null when the CIK is unknown
|
|
42
|
+
* @type {string}
|
|
43
|
+
* @memberof EventResultsFiling
|
|
44
|
+
*/
|
|
45
|
+
edgar_index_url: string | null;
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
* Check if a given object implements the EventResultsFiling interface.
|
|
50
|
+
*/
|
|
51
|
+
export function instanceOfEventResultsFiling(value: object): value is EventResultsFiling {
|
|
52
|
+
if (!('accession' in value) || value['accession'] === undefined) return false;
|
|
53
|
+
if (!('form' in value) || value['form'] === undefined) return false;
|
|
54
|
+
if (!('accepted_at' in value) || value['accepted_at'] === undefined) return false;
|
|
55
|
+
if (!('edgar_index_url' in value) || value['edgar_index_url'] === undefined) return false;
|
|
56
|
+
return true;
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
export function EventResultsFilingFromJSON(json: any): EventResultsFiling {
|
|
60
|
+
return EventResultsFilingFromJSONTyped(json, false);
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
export function EventResultsFilingFromJSONTyped(json: any, ignoreDiscriminator: boolean): EventResultsFiling {
|
|
64
|
+
if (json == null) {
|
|
65
|
+
return json;
|
|
66
|
+
}
|
|
67
|
+
return {
|
|
68
|
+
|
|
69
|
+
'accession': json['accession'],
|
|
70
|
+
'form': json['form'],
|
|
71
|
+
'accepted_at': (json['accepted_at'] == null ? null : new Date(json['accepted_at'])),
|
|
72
|
+
'edgar_index_url': json['edgar_index_url'],
|
|
73
|
+
};
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
export function EventResultsFilingToJSON(json: any): EventResultsFiling {
|
|
77
|
+
return EventResultsFilingToJSONTyped(json, false);
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
export function EventResultsFilingToJSONTyped(value?: EventResultsFiling | null, ignoreDiscriminator: boolean = false): any {
|
|
81
|
+
if (value == null) {
|
|
82
|
+
return value;
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
return {
|
|
86
|
+
|
|
87
|
+
'accession': value['accession'],
|
|
88
|
+
'form': value['form'],
|
|
89
|
+
'accepted_at': value['accepted_at'] == null ? value['accepted_at'] : value['accepted_at'].toISOString(),
|
|
90
|
+
'edgar_index_url': value['edgar_index_url'],
|
|
91
|
+
};
|
|
92
|
+
}
|
|
93
|
+
|
package/src/models/Problem.ts
CHANGED
|
@@ -69,6 +69,12 @@ export interface Problem {
|
|
|
69
69
|
* @memberof Problem
|
|
70
70
|
*/
|
|
71
71
|
errors?: Array<ProblemErrorsInner>;
|
|
72
|
+
/**
|
|
73
|
+
* What to do next: one imperative sentence ending with a period, surface neutral (no CLI command, no HTTP status number). A per-code default when the operation gives none
|
|
74
|
+
* @type {string}
|
|
75
|
+
* @memberof Problem
|
|
76
|
+
*/
|
|
77
|
+
remedy: string;
|
|
72
78
|
/**
|
|
73
79
|
* The `X-Request-Id` of this response
|
|
74
80
|
* @type {string}
|
|
@@ -115,6 +121,7 @@ export function instanceOfProblem(value: object): value is Problem {
|
|
|
115
121
|
if (!('status' in value) || value['status'] === undefined) return false;
|
|
116
122
|
if (!('detail' in value) || value['detail'] === undefined) return false;
|
|
117
123
|
if (!('code' in value) || value['code'] === undefined) return false;
|
|
124
|
+
if (!('remedy' in value) || value['remedy'] === undefined) return false;
|
|
118
125
|
if (!('request_id' in value) || value['request_id'] === undefined) return false;
|
|
119
126
|
if (!('docs_url' in value) || value['docs_url'] === undefined) return false;
|
|
120
127
|
return true;
|
|
@@ -137,6 +144,7 @@ export function ProblemFromJSONTyped(json: any, ignoreDiscriminator: boolean): P
|
|
|
137
144
|
'code': json['code'],
|
|
138
145
|
'param': json['param'] == null ? undefined : json['param'],
|
|
139
146
|
'errors': json['errors'] == null ? undefined : ((json['errors'] as Array<any>).map(ProblemErrorsInnerFromJSON)),
|
|
147
|
+
'remedy': json['remedy'],
|
|
140
148
|
'request_id': json['request_id'],
|
|
141
149
|
'docs_url': json['docs_url'],
|
|
142
150
|
};
|
|
@@ -160,6 +168,7 @@ export function ProblemToJSONTyped(value?: Problem | null, ignoreDiscriminator:
|
|
|
160
168
|
'code': value['code'],
|
|
161
169
|
'param': value['param'],
|
|
162
170
|
'errors': value['errors'] == null ? undefined : ((value['errors'] as Array<any>).map(ProblemErrorsInnerToJSON)),
|
|
171
|
+
'remedy': value['remedy'],
|
|
163
172
|
'request_id': value['request_id'],
|
|
164
173
|
'docs_url': value['docs_url'],
|
|
165
174
|
};
|
package/src/models/index.ts
CHANGED
|
@@ -44,7 +44,9 @@ export * from './EventComparisonNewTopicsInner';
|
|
|
44
44
|
export * from './EventComparisonPriorEvent';
|
|
45
45
|
export * from './EventComparisonSlideDiff';
|
|
46
46
|
export * from './EventObservationsInner';
|
|
47
|
+
export * from './EventPeriodicReport';
|
|
47
48
|
export * from './EventRef';
|
|
49
|
+
export * from './EventResultsFiling';
|
|
48
50
|
export * from './EventStats';
|
|
49
51
|
export * from './EventStatsEvent';
|
|
50
52
|
export * from './EventTypeCatalogEntry';
|