@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.
Files changed (42) hide show
  1. package/.openapi-generator/FILES +5 -0
  2. package/README.md +29 -10
  3. package/dist/errors.d.ts +39 -0
  4. package/dist/errors.js +98 -0
  5. package/dist/esm/errors.d.ts +39 -0
  6. package/dist/esm/errors.js +93 -0
  7. package/dist/esm/index.d.ts +1 -0
  8. package/dist/esm/index.js +1 -0
  9. package/dist/esm/models/Event.d.ts +14 -0
  10. package/dist/esm/models/Event.js +6 -0
  11. package/dist/esm/models/EventPeriodicReport.d.ts +62 -0
  12. package/dist/esm/models/EventPeriodicReport.js +63 -0
  13. package/dist/esm/models/EventResultsFiling.d.ts +50 -0
  14. package/dist/esm/models/EventResultsFiling.js +55 -0
  15. package/dist/esm/models/Problem.d.ts +6 -0
  16. package/dist/esm/models/Problem.js +4 -0
  17. package/dist/esm/models/index.d.ts +2 -0
  18. package/dist/esm/models/index.js +2 -0
  19. package/dist/index.d.ts +1 -0
  20. package/dist/index.js +1 -0
  21. package/dist/models/Event.d.ts +14 -0
  22. package/dist/models/Event.js +6 -0
  23. package/dist/models/EventPeriodicReport.d.ts +62 -0
  24. package/dist/models/EventPeriodicReport.js +70 -0
  25. package/dist/models/EventResultsFiling.d.ts +50 -0
  26. package/dist/models/EventResultsFiling.js +62 -0
  27. package/dist/models/Problem.d.ts +6 -0
  28. package/dist/models/Problem.js +4 -0
  29. package/dist/models/index.d.ts +2 -0
  30. package/dist/models/index.js +2 -0
  31. package/docs/Event.md +4 -0
  32. package/docs/EventPeriodicReport.md +45 -0
  33. package/docs/EventResultsFiling.md +41 -0
  34. package/docs/Problem.md +2 -0
  35. package/package.json +1 -1
  36. package/src/errors.ts +123 -0
  37. package/src/index.ts +1 -0
  38. package/src/models/Event.ts +30 -0
  39. package/src/models/EventPeriodicReport.ts +111 -0
  40. package/src/models/EventResultsFiling.ts +93 -0
  41. package/src/models/Problem.ts +9 -0
  42. package/src/models/index.ts +2 -0
@@ -51,7 +51,9 @@ docs/EventComparisonNewTopicsInner.md
51
51
  docs/EventComparisonPriorEvent.md
52
52
  docs/EventComparisonSlideDiff.md
53
53
  docs/EventObservationsInner.md
54
+ docs/EventPeriodicReport.md
54
55
  docs/EventRef.md
56
+ docs/EventResultsFiling.md
55
57
  docs/EventStats.md
56
58
  docs/EventStatsEvent.md
57
59
  docs/EventTypeCatalogEntry.md
@@ -280,6 +282,7 @@ src/apis/ReferenceApi.ts
280
282
  src/apis/TranscriptsApi.ts
281
283
  src/apis/WebhooksApi.ts
282
284
  src/apis/index.ts
285
+ src/errors.ts
283
286
  src/index.ts
284
287
  src/models/Announcement.ts
285
288
  src/models/AnnouncementCounterpartiesInner.ts
@@ -325,7 +328,9 @@ src/models/EventComparisonNewTopicsInner.ts
325
328
  src/models/EventComparisonPriorEvent.ts
326
329
  src/models/EventComparisonSlideDiff.ts
327
330
  src/models/EventObservationsInner.ts
331
+ src/models/EventPeriodicReport.ts
328
332
  src/models/EventRef.ts
333
+ src/models/EventResultsFiling.ts
329
334
  src/models/EventStats.ts
330
335
  src/models/EventStatsEvent.ts
331
336
  src/models/EventTypeCatalogEntry.ts
package/README.md CHANGED
@@ -61,6 +61,23 @@ Every API class is named after a docs group (`CompaniesApi`, `FinancialsApi`, `F
61
61
  (`listFilings`, `getCompany`). The company is always a filter: `company` takes a ticker
62
62
  or a CIK, or a comma list of up to 50. Date parameters take a `Date`.
63
63
 
64
+ ## An earnings event and its filings
65
+
66
+ Every event names its two SEC filings: `results_filing` (the earnings 8-K / 6-K) and
67
+ `periodic_report` (the 10-Q / 10-K of the event's fiscal period), each with
68
+ `edgar_index_url`; while unknown the API sends `null` and the client gives `undefined`:
69
+
70
+ ```ts
71
+ import { Configuration, EventsApi } from "@invinite-org/data-api-client";
72
+
73
+ const api = new EventsApi(new Configuration({ accessToken: process.env.INVINITE_DATA_API_KEY }));
74
+
75
+ const page = await api.listEvents({ company: "AAPL", fiscalYear: 2026, fiscalQuarter: 4 });
76
+ const event = await api.getEvent({ eventId: page.data[0].event_id });
77
+ console.log(event.results_filing?.accession, event.results_filing?.form);
78
+ console.log(event.periodic_report?.form, event.periodic_report?.period_end, event.periodic_report?.edgar_index_url);
79
+ ```
80
+
64
81
  ## Lists, cursors and the pager
65
82
 
66
83
  Every list answers ONE envelope: `{ data, has_more, next_cursor, meta }`. Pass
@@ -102,21 +119,23 @@ const page = await response.value();
102
119
 
103
120
  On a non-2xx response the client throws `ResponseError`. The body is an RFC 9457
104
121
  `application/problem+json` document with a stable `code` (`not_covered`,
105
- `invalid_parameter`, `cursor_mismatch`, `rate_limited`, …) and a `request_id`. On `429`
106
- and `503`, wait for the `Retry-After` header before retrying.
122
+ `invalid_parameter`, `cursor_mismatch`, `rate_limited`, …), a `detail` (what happened), a
123
+ `remedy` (what to do next, one sentence) and a `request_id`. `toApiError` reads that body
124
+ once and returns an `InviniteApiError` with `status`, `code`, `detail`, `remedy`, `param`,
125
+ `errors`, `requestId`, `docsUrl`, `retryAfterMs` (the `Retry-After` header of a `429` /
126
+ `503`) and the whole `body`; it returns `undefined` for anything that is not a problem
127
+ answer (a network error, for example).
107
128
 
108
129
  ```ts
109
- import { ResponseError } from "@invinite-org/data-api-client";
130
+ import { toApiError } from "@invinite-org/data-api-client";
110
131
 
111
132
  try {
112
- await api.listFilings({ company: "NOPE" });
133
+ await api.listFilings({ company: "AAPL", limit: 500 });
113
134
  } catch (error) {
114
- if (error instanceof ResponseError) {
115
- const problem = await error.response.json();
116
- console.error(error.response.status, problem.code, problem.detail, problem.request_id);
117
- } else {
118
- throw error;
119
- }
135
+ const problem = await toApiError(error);
136
+ if (!problem) throw error;
137
+ console.error(problem.detail); // limit: must be <= 200.
138
+ console.error(problem.remedy); // Pass a limit of at most 200, or walk the pages with next_cursor.
120
139
  }
121
140
  ```
122
141
 
@@ -0,0 +1,39 @@
1
+ /** One parameter problem of a 400 (`errors[]`). */
2
+ export interface InviniteApiErrorIssue {
3
+ param: string | null;
4
+ code: string;
5
+ detail: string;
6
+ }
7
+ /** A problem answer of the Data API, read once from a `ResponseError`. */
8
+ export declare class InviniteApiError extends Error {
9
+ name: "InviniteApiError";
10
+ /** HTTP status of the answer. */
11
+ readonly status: number;
12
+ /** Stable lower_snake code (`invalid_parameter`, `not_found`, …). */
13
+ readonly code: string;
14
+ /** What happened, one sentence. */
15
+ readonly detail: string;
16
+ /** What to do next, one sentence (absent only on an answer that does not carry it). */
17
+ readonly remedy?: string;
18
+ /** The parameter the problem is about. */
19
+ readonly param?: string;
20
+ /** Every parameter problem of a 400. */
21
+ readonly errors?: InviniteApiErrorIssue[];
22
+ /** The `X-Request-Id` of the answer: quote it when reporting a problem. */
23
+ readonly requestId: string;
24
+ /** Documentation of the code. */
25
+ readonly docsUrl: string;
26
+ /** The `Retry-After` header in milliseconds (429 / 503). */
27
+ readonly retryAfterMs?: number;
28
+ /** The whole problem body. */
29
+ readonly body: Record<string, unknown>;
30
+ /** The HTTP response it was read from. */
31
+ readonly response: Response;
32
+ constructor(response: Response, body: Record<string, unknown>);
33
+ }
34
+ /**
35
+ * The problem behind an error a generated method threw: an `InviniteApiError` for a `ResponseError` whose body is a
36
+ * problem, `undefined` for anything else (a network error, a non-problem body, an already-read body). The body is
37
+ * read once per error; calling it again returns the same object.
38
+ */
39
+ export declare function toApiError(e: unknown): Promise<InviniteApiError | undefined>;
package/dist/errors.js ADDED
@@ -0,0 +1,98 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.InviniteApiError = void 0;
13
+ exports.toApiError = toApiError;
14
+ /* tslint:disable */
15
+ /* eslint-disable */
16
+ /**
17
+ * Typed problem errors: every 4xx / 5xx answer of the Data API is an RFC 9457 `application/problem+json` body
18
+ * `{ type, title, status, detail, code, param?, errors?, remedy, request_id, docs_url }`.
19
+ *
20
+ * Hand-written, not generated from the spec: `sdks/data/templates/typescript/errors.mustache` in
21
+ * outraday-org/invinite-data-api.
22
+ *
23
+ * ```ts
24
+ * try {
25
+ * await filings.listFilings({ company: "AAPL", limit: 500 });
26
+ * } catch (error) {
27
+ * const problem = await toApiError(error);
28
+ * if (!problem) throw error;
29
+ * console.error(problem.detail);
30
+ * console.error(problem.remedy);
31
+ * }
32
+ * ```
33
+ */
34
+ const runtime_1 = require("./runtime");
35
+ /** A problem answer of the Data API, read once from a `ResponseError`. */
36
+ class InviniteApiError extends Error {
37
+ constructor(response, body) {
38
+ var _a, _b, _c, _d, _e, _f, _g;
39
+ const text = (key) => (typeof body[key] === "string" ? body[key] : undefined);
40
+ const detail = (_b = (_a = text("detail")) !== null && _a !== void 0 ? _a : text("title")) !== null && _b !== void 0 ? _b : `HTTP ${response.status}`;
41
+ super(detail);
42
+ this.name = "InviniteApiError";
43
+ Object.setPrototypeOf(this, new.target.prototype);
44
+ this.status = typeof body.status === "number" ? body.status : response.status;
45
+ this.code = (_c = text("code")) !== null && _c !== void 0 ? _c : "";
46
+ this.detail = detail;
47
+ this.remedy = text("remedy");
48
+ this.param = text("param");
49
+ this.errors = Array.isArray(body.errors) ? body.errors : undefined;
50
+ this.requestId = (_e = (_d = text("request_id")) !== null && _d !== void 0 ? _d : response.headers.get("X-Request-Id")) !== null && _e !== void 0 ? _e : "";
51
+ this.docsUrl = (_f = text("docs_url")) !== null && _f !== void 0 ? _f : "";
52
+ const retryAfter = Number((_g = response.headers.get("Retry-After")) !== null && _g !== void 0 ? _g : Number.NaN);
53
+ this.retryAfterMs = Number.isFinite(retryAfter) && retryAfter >= 0 ? retryAfter * 1000 : undefined;
54
+ this.body = body;
55
+ this.response = response;
56
+ }
57
+ }
58
+ exports.InviniteApiError = InviniteApiError;
59
+ const read = new WeakMap();
60
+ function parse(error) {
61
+ return __awaiter(this, void 0, void 0, function* () {
62
+ const response = error.response;
63
+ if (!response || response.bodyUsed)
64
+ return undefined;
65
+ let body;
66
+ try {
67
+ // A clone: the caller can still read `error.response` itself.
68
+ body = JSON.parse(yield response.clone().text());
69
+ }
70
+ catch (_a) {
71
+ return undefined;
72
+ }
73
+ if (typeof body !== "object" || body === null || Array.isArray(body))
74
+ return undefined;
75
+ if (typeof body.code !== "string")
76
+ return undefined;
77
+ return new InviniteApiError(response, body);
78
+ });
79
+ }
80
+ /**
81
+ * The problem behind an error a generated method threw: an `InviniteApiError` for a `ResponseError` whose body is a
82
+ * problem, `undefined` for anything else (a network error, a non-problem body, an already-read body). The body is
83
+ * read once per error; calling it again returns the same object.
84
+ */
85
+ function toApiError(e) {
86
+ return __awaiter(this, void 0, void 0, function* () {
87
+ if (e instanceof InviniteApiError)
88
+ return e;
89
+ if (!(e instanceof runtime_1.ResponseError))
90
+ return undefined;
91
+ let pending = read.get(e);
92
+ if (!pending) {
93
+ pending = parse(e);
94
+ read.set(e, pending);
95
+ }
96
+ return pending;
97
+ });
98
+ }
@@ -0,0 +1,39 @@
1
+ /** One parameter problem of a 400 (`errors[]`). */
2
+ export interface InviniteApiErrorIssue {
3
+ param: string | null;
4
+ code: string;
5
+ detail: string;
6
+ }
7
+ /** A problem answer of the Data API, read once from a `ResponseError`. */
8
+ export declare class InviniteApiError extends Error {
9
+ name: "InviniteApiError";
10
+ /** HTTP status of the answer. */
11
+ readonly status: number;
12
+ /** Stable lower_snake code (`invalid_parameter`, `not_found`, …). */
13
+ readonly code: string;
14
+ /** What happened, one sentence. */
15
+ readonly detail: string;
16
+ /** What to do next, one sentence (absent only on an answer that does not carry it). */
17
+ readonly remedy?: string;
18
+ /** The parameter the problem is about. */
19
+ readonly param?: string;
20
+ /** Every parameter problem of a 400. */
21
+ readonly errors?: InviniteApiErrorIssue[];
22
+ /** The `X-Request-Id` of the answer: quote it when reporting a problem. */
23
+ readonly requestId: string;
24
+ /** Documentation of the code. */
25
+ readonly docsUrl: string;
26
+ /** The `Retry-After` header in milliseconds (429 / 503). */
27
+ readonly retryAfterMs?: number;
28
+ /** The whole problem body. */
29
+ readonly body: Record<string, unknown>;
30
+ /** The HTTP response it was read from. */
31
+ readonly response: Response;
32
+ constructor(response: Response, body: Record<string, unknown>);
33
+ }
34
+ /**
35
+ * The problem behind an error a generated method threw: an `InviniteApiError` for a `ResponseError` whose body is a
36
+ * problem, `undefined` for anything else (a network error, a non-problem body, an already-read body). The body is
37
+ * read once per error; calling it again returns the same object.
38
+ */
39
+ export declare function toApiError(e: unknown): Promise<InviniteApiError | undefined>;
@@ -0,0 +1,93 @@
1
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
2
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
3
+ return new (P || (P = Promise))(function (resolve, reject) {
4
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
5
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
6
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
7
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
8
+ });
9
+ };
10
+ /* tslint:disable */
11
+ /* eslint-disable */
12
+ /**
13
+ * Typed problem errors: every 4xx / 5xx answer of the Data API is an RFC 9457 `application/problem+json` body
14
+ * `{ type, title, status, detail, code, param?, errors?, remedy, request_id, docs_url }`.
15
+ *
16
+ * Hand-written, not generated from the spec: `sdks/data/templates/typescript/errors.mustache` in
17
+ * outraday-org/invinite-data-api.
18
+ *
19
+ * ```ts
20
+ * try {
21
+ * await filings.listFilings({ company: "AAPL", limit: 500 });
22
+ * } catch (error) {
23
+ * const problem = await toApiError(error);
24
+ * if (!problem) throw error;
25
+ * console.error(problem.detail);
26
+ * console.error(problem.remedy);
27
+ * }
28
+ * ```
29
+ */
30
+ import { ResponseError } from './runtime';
31
+ /** A problem answer of the Data API, read once from a `ResponseError`. */
32
+ export class InviniteApiError extends Error {
33
+ constructor(response, body) {
34
+ var _a, _b, _c, _d, _e, _f, _g;
35
+ const text = (key) => (typeof body[key] === "string" ? body[key] : undefined);
36
+ const detail = (_b = (_a = text("detail")) !== null && _a !== void 0 ? _a : text("title")) !== null && _b !== void 0 ? _b : `HTTP ${response.status}`;
37
+ super(detail);
38
+ this.name = "InviniteApiError";
39
+ Object.setPrototypeOf(this, new.target.prototype);
40
+ this.status = typeof body.status === "number" ? body.status : response.status;
41
+ this.code = (_c = text("code")) !== null && _c !== void 0 ? _c : "";
42
+ this.detail = detail;
43
+ this.remedy = text("remedy");
44
+ this.param = text("param");
45
+ this.errors = Array.isArray(body.errors) ? body.errors : undefined;
46
+ this.requestId = (_e = (_d = text("request_id")) !== null && _d !== void 0 ? _d : response.headers.get("X-Request-Id")) !== null && _e !== void 0 ? _e : "";
47
+ this.docsUrl = (_f = text("docs_url")) !== null && _f !== void 0 ? _f : "";
48
+ const retryAfter = Number((_g = response.headers.get("Retry-After")) !== null && _g !== void 0 ? _g : Number.NaN);
49
+ this.retryAfterMs = Number.isFinite(retryAfter) && retryAfter >= 0 ? retryAfter * 1000 : undefined;
50
+ this.body = body;
51
+ this.response = response;
52
+ }
53
+ }
54
+ const read = new WeakMap();
55
+ function parse(error) {
56
+ return __awaiter(this, void 0, void 0, function* () {
57
+ const response = error.response;
58
+ if (!response || response.bodyUsed)
59
+ return undefined;
60
+ let body;
61
+ try {
62
+ // A clone: the caller can still read `error.response` itself.
63
+ body = JSON.parse(yield response.clone().text());
64
+ }
65
+ catch (_a) {
66
+ return undefined;
67
+ }
68
+ if (typeof body !== "object" || body === null || Array.isArray(body))
69
+ return undefined;
70
+ if (typeof body.code !== "string")
71
+ return undefined;
72
+ return new InviniteApiError(response, body);
73
+ });
74
+ }
75
+ /**
76
+ * The problem behind an error a generated method threw: an `InviniteApiError` for a `ResponseError` whose body is a
77
+ * problem, `undefined` for anything else (a network error, a non-problem body, an already-read body). The body is
78
+ * read once per error; calling it again returns the same object.
79
+ */
80
+ export function toApiError(e) {
81
+ return __awaiter(this, void 0, void 0, function* () {
82
+ if (e instanceof InviniteApiError)
83
+ return e;
84
+ if (!(e instanceof ResponseError))
85
+ return undefined;
86
+ let pending = read.get(e);
87
+ if (!pending) {
88
+ pending = parse(e);
89
+ read.set(e, pending);
90
+ }
91
+ return pending;
92
+ });
93
+ }
@@ -2,3 +2,4 @@ export * from './runtime';
2
2
  export * from './apis/index';
3
3
  export * from './models/index';
4
4
  export * from './pagination';
5
+ export * from './errors';
package/dist/esm/index.js CHANGED
@@ -4,3 +4,4 @@ export * from './runtime';
4
4
  export * from './apis/index';
5
5
  export * from './models/index';
6
6
  export * from './pagination';
7
+ export * from './errors';
@@ -9,6 +9,8 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import type { EventPeriodicReport } from './EventPeriodicReport';
13
+ import type { EventResultsFiling } from './EventResultsFiling';
12
14
  import type { EventVideo } from './EventVideo';
13
15
  import type { EventObservationsInner } from './EventObservationsInner';
14
16
  import type { EventCalendar } from './EventCalendar';
@@ -192,6 +194,18 @@ export interface Event {
192
194
  * @memberof Event
193
195
  */
194
196
  video: EventVideo | null;
197
+ /**
198
+ *
199
+ * @type {EventResultsFiling}
200
+ * @memberof Event
201
+ */
202
+ results_filing?: EventResultsFiling | null;
203
+ /**
204
+ *
205
+ * @type {EventPeriodicReport}
206
+ * @memberof Event
207
+ */
208
+ periodic_report?: EventPeriodicReport | null;
195
209
  /**
196
210
  * Date / time observations, oldest first (at most 50)
197
211
  * @type {Array<EventObservationsInner>}
@@ -11,6 +11,8 @@
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
+ import { EventPeriodicReportFromJSON, EventPeriodicReportToJSON, } from './EventPeriodicReport';
15
+ import { EventResultsFilingFromJSON, EventResultsFilingToJSON, } from './EventResultsFiling';
14
16
  import { EventVideoFromJSON, EventVideoToJSON, } from './EventVideo';
15
17
  import { EventObservationsInnerFromJSON, EventObservationsInnerToJSON, } from './EventObservationsInner';
16
18
  import { EventCalendarFromJSON, EventCalendarToJSON, } from './EventCalendar';
@@ -164,6 +166,8 @@ export function EventFromJSONTyped(json, ignoreDiscriminator) {
164
166
  'has_documents': json['has_documents'],
165
167
  'webcast_url': json['webcast_url'],
166
168
  'video': EventVideoFromJSON(json['video']),
169
+ 'results_filing': json['results_filing'] == null ? undefined : EventResultsFilingFromJSON(json['results_filing']),
170
+ 'periodic_report': json['periodic_report'] == null ? undefined : EventPeriodicReportFromJSON(json['periodic_report']),
167
171
  'observations': json['observations'] == null ? undefined : (json['observations'].map(EventObservationsInnerFromJSON)),
168
172
  'calendar': json['calendar'] == null ? undefined : EventCalendarFromJSON(json['calendar']),
169
173
  };
@@ -205,6 +209,8 @@ export function EventToJSONTyped(value, ignoreDiscriminator = false) {
205
209
  'has_documents': value['has_documents'],
206
210
  'webcast_url': value['webcast_url'],
207
211
  'video': EventVideoToJSON(value['video']),
212
+ 'results_filing': EventResultsFilingToJSON(value['results_filing']),
213
+ 'periodic_report': EventPeriodicReportToJSON(value['periodic_report']),
208
214
  'observations': value['observations'] == null ? undefined : (value['observations'].map(EventObservationsInnerToJSON)),
209
215
  'calendar': EventCalendarToJSON(value['calendar']),
210
216
  };
@@ -0,0 +1,62 @@
1
+ /**
2
+ * Invinite API
3
+ * Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers 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.
4
+ *
5
+ * The version of the OpenAPI document: 2026-11-11
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * 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
14
+ * @export
15
+ * @interface EventPeriodicReport
16
+ */
17
+ export interface EventPeriodicReport {
18
+ /**
19
+ * SEC accession number (0000320193-26-000024)
20
+ * @type {string}
21
+ * @memberof EventPeriodicReport
22
+ */
23
+ accession: string;
24
+ /**
25
+ * Form type (10-Q, 10-QT, 10-K, 10-KT, 20-F, 40-F)
26
+ * @type {string}
27
+ * @memberof EventPeriodicReport
28
+ */
29
+ form: string;
30
+ /**
31
+ * Period end the filing reports (YYYY-MM-DD)
32
+ * @type {Date}
33
+ * @memberof EventPeriodicReport
34
+ */
35
+ period_end: Date | null;
36
+ /**
37
+ * SEC filing date (YYYY-MM-DD)
38
+ * @type {Date}
39
+ * @memberof EventPeriodicReport
40
+ */
41
+ filing_date: Date | null;
42
+ /**
43
+ * EDGAR acceptance time (ISO 8601 UTC)
44
+ * @type {Date}
45
+ * @memberof EventPeriodicReport
46
+ */
47
+ accepted_at: Date | null;
48
+ /**
49
+ * The filing's EDGAR index page; null when the CIK is unknown
50
+ * @type {string}
51
+ * @memberof EventPeriodicReport
52
+ */
53
+ edgar_index_url: string | null;
54
+ }
55
+ /**
56
+ * Check if a given object implements the EventPeriodicReport interface.
57
+ */
58
+ export declare function instanceOfEventPeriodicReport(value: object): value is EventPeriodicReport;
59
+ export declare function EventPeriodicReportFromJSON(json: any): EventPeriodicReport;
60
+ export declare function EventPeriodicReportFromJSONTyped(json: any, ignoreDiscriminator: boolean): EventPeriodicReport;
61
+ export declare function EventPeriodicReportToJSON(json: any): EventPeriodicReport;
62
+ export declare function EventPeriodicReportToJSONTyped(value?: EventPeriodicReport | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,63 @@
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
+ * Check if a given object implements the EventPeriodicReport interface.
16
+ */
17
+ export function instanceOfEventPeriodicReport(value) {
18
+ if (!('accession' in value) || value['accession'] === undefined)
19
+ return false;
20
+ if (!('form' in value) || value['form'] === undefined)
21
+ return false;
22
+ if (!('period_end' in value) || value['period_end'] === undefined)
23
+ return false;
24
+ if (!('filing_date' in value) || value['filing_date'] === undefined)
25
+ return false;
26
+ if (!('accepted_at' in value) || value['accepted_at'] === undefined)
27
+ return false;
28
+ if (!('edgar_index_url' in value) || value['edgar_index_url'] === undefined)
29
+ return false;
30
+ return true;
31
+ }
32
+ export function EventPeriodicReportFromJSON(json) {
33
+ return EventPeriodicReportFromJSONTyped(json, false);
34
+ }
35
+ export function EventPeriodicReportFromJSONTyped(json, ignoreDiscriminator) {
36
+ if (json == null) {
37
+ return json;
38
+ }
39
+ return {
40
+ 'accession': json['accession'],
41
+ 'form': json['form'],
42
+ 'period_end': (json['period_end'] == null ? null : new Date(json['period_end'])),
43
+ 'filing_date': (json['filing_date'] == null ? null : new Date(json['filing_date'])),
44
+ 'accepted_at': (json['accepted_at'] == null ? null : new Date(json['accepted_at'])),
45
+ 'edgar_index_url': json['edgar_index_url'],
46
+ };
47
+ }
48
+ export function EventPeriodicReportToJSON(json) {
49
+ return EventPeriodicReportToJSONTyped(json, false);
50
+ }
51
+ export function EventPeriodicReportToJSONTyped(value, ignoreDiscriminator = false) {
52
+ if (value == null) {
53
+ return value;
54
+ }
55
+ return {
56
+ 'accession': value['accession'],
57
+ 'form': value['form'],
58
+ 'period_end': value['period_end'] == null ? value['period_end'] : value['period_end'].toISOString().substring(0, 10),
59
+ 'filing_date': value['filing_date'] == null ? value['filing_date'] : value['filing_date'].toISOString().substring(0, 10),
60
+ 'accepted_at': value['accepted_at'] == null ? value['accepted_at'] : value['accepted_at'].toISOString(),
61
+ 'edgar_index_url': value['edgar_index_url'],
62
+ };
63
+ }
@@ -0,0 +1,50 @@
1
+ /**
2
+ * Invinite API
3
+ * Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers 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.
4
+ *
5
+ * The version of the OpenAPI document: 2026-11-11
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * 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
14
+ * @export
15
+ * @interface EventResultsFiling
16
+ */
17
+ export interface EventResultsFiling {
18
+ /**
19
+ * SEC accession number (0000320193-26-000024)
20
+ * @type {string}
21
+ * @memberof EventResultsFiling
22
+ */
23
+ accession: string;
24
+ /**
25
+ * Form type (8-K, 8-K/A, 6-K, 6-K/A)
26
+ * @type {string}
27
+ * @memberof EventResultsFiling
28
+ */
29
+ form: string;
30
+ /**
31
+ * EDGAR acceptance time (ISO 8601 UTC)
32
+ * @type {Date}
33
+ * @memberof EventResultsFiling
34
+ */
35
+ accepted_at: Date | null;
36
+ /**
37
+ * The filing's EDGAR index page; null when the CIK is unknown
38
+ * @type {string}
39
+ * @memberof EventResultsFiling
40
+ */
41
+ edgar_index_url: string | null;
42
+ }
43
+ /**
44
+ * Check if a given object implements the EventResultsFiling interface.
45
+ */
46
+ export declare function instanceOfEventResultsFiling(value: object): value is EventResultsFiling;
47
+ export declare function EventResultsFilingFromJSON(json: any): EventResultsFiling;
48
+ export declare function EventResultsFilingFromJSONTyped(json: any, ignoreDiscriminator: boolean): EventResultsFiling;
49
+ export declare function EventResultsFilingToJSON(json: any): EventResultsFiling;
50
+ export declare function EventResultsFilingToJSONTyped(value?: EventResultsFiling | null, ignoreDiscriminator?: boolean): any;