@invinite-org/data-api-client 0.3.0 → 0.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 (97) hide show
  1. package/.openapi-generator/FILES +12 -0
  2. package/dist/apis/EarningsCallsApi.d.ts +42 -6
  3. package/dist/apis/EarningsCallsApi.js +47 -7
  4. package/dist/esm/apis/EarningsCallsApi.d.ts +42 -6
  5. package/dist/esm/apis/EarningsCallsApi.js +46 -6
  6. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInner.d.ts +7 -0
  7. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInner.js +5 -0
  8. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerVideo.d.ts +82 -0
  9. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerVideo.js +78 -0
  10. package/dist/esm/models/EarningsCallsDocumentSearch200Response.d.ts +21 -0
  11. package/dist/esm/models/EarningsCallsDocumentSearch200Response.js +16 -0
  12. package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +21 -2
  13. package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.js +13 -0
  14. package/dist/esm/models/EarningsCallsEvents200ResponseEventsInner.d.ts +7 -0
  15. package/dist/esm/models/EarningsCallsEvents200ResponseEventsInner.js +5 -0
  16. package/dist/esm/models/EarningsCallsLive200ResponseEventsInner.d.ts +7 -0
  17. package/dist/esm/models/EarningsCallsLive200ResponseEventsInner.js +5 -0
  18. package/dist/esm/models/EarningsCallsSearch200Response.d.ts +21 -0
  19. package/dist/esm/models/EarningsCallsSearch200Response.js +16 -0
  20. package/dist/esm/models/EarningsCallsSearch200ResponseHitsInner.d.ts +21 -2
  21. package/dist/esm/models/EarningsCallsSearch200ResponseHitsInner.js +13 -0
  22. package/dist/esm/models/EarningsCallsSlides200Response.d.ts +7 -0
  23. package/dist/esm/models/EarningsCallsSlides200Response.js +5 -0
  24. package/dist/esm/models/EarningsCallsSlides200ResponseTimelineInner.d.ts +38 -0
  25. package/dist/esm/models/EarningsCallsSlides200ResponseTimelineInner.js +47 -0
  26. package/dist/esm/models/HitMatch.d.ts +53 -0
  27. package/dist/esm/models/HitMatch.js +59 -0
  28. package/dist/esm/models/MatchSpan.d.ts +38 -0
  29. package/dist/esm/models/MatchSpan.js +47 -0
  30. package/dist/esm/models/SearchCoverage.d.ts +63 -0
  31. package/dist/esm/models/SearchCoverage.js +68 -0
  32. package/dist/esm/models/SearchCoverageLeg.d.ts +59 -0
  33. package/dist/esm/models/SearchCoverageLeg.js +63 -0
  34. package/dist/esm/models/index.d.ts +6 -0
  35. package/dist/esm/models/index.js +6 -0
  36. package/dist/models/EarningsCallsCalendar200ResponseEventsInner.d.ts +7 -0
  37. package/dist/models/EarningsCallsCalendar200ResponseEventsInner.js +5 -0
  38. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerVideo.d.ts +82 -0
  39. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerVideo.js +86 -0
  40. package/dist/models/EarningsCallsDocumentSearch200Response.d.ts +21 -0
  41. package/dist/models/EarningsCallsDocumentSearch200Response.js +17 -0
  42. package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +21 -2
  43. package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.js +13 -0
  44. package/dist/models/EarningsCallsEvents200ResponseEventsInner.d.ts +7 -0
  45. package/dist/models/EarningsCallsEvents200ResponseEventsInner.js +5 -0
  46. package/dist/models/EarningsCallsLive200ResponseEventsInner.d.ts +7 -0
  47. package/dist/models/EarningsCallsLive200ResponseEventsInner.js +5 -0
  48. package/dist/models/EarningsCallsSearch200Response.d.ts +21 -0
  49. package/dist/models/EarningsCallsSearch200Response.js +17 -0
  50. package/dist/models/EarningsCallsSearch200ResponseHitsInner.d.ts +21 -2
  51. package/dist/models/EarningsCallsSearch200ResponseHitsInner.js +13 -0
  52. package/dist/models/EarningsCallsSlides200Response.d.ts +7 -0
  53. package/dist/models/EarningsCallsSlides200Response.js +5 -0
  54. package/dist/models/EarningsCallsSlides200ResponseTimelineInner.d.ts +38 -0
  55. package/dist/models/EarningsCallsSlides200ResponseTimelineInner.js +54 -0
  56. package/dist/models/HitMatch.d.ts +53 -0
  57. package/dist/models/HitMatch.js +67 -0
  58. package/dist/models/MatchSpan.d.ts +38 -0
  59. package/dist/models/MatchSpan.js +54 -0
  60. package/dist/models/SearchCoverage.d.ts +63 -0
  61. package/dist/models/SearchCoverage.js +76 -0
  62. package/dist/models/SearchCoverageLeg.d.ts +59 -0
  63. package/dist/models/SearchCoverageLeg.js +71 -0
  64. package/dist/models/index.d.ts +6 -0
  65. package/dist/models/index.js +6 -0
  66. package/docs/EarningsCallsApi.md +22 -12
  67. package/docs/EarningsCallsCalendar200ResponseEventsInner.md +2 -0
  68. package/docs/EarningsCallsCalendar200ResponseEventsInnerVideo.md +49 -0
  69. package/docs/EarningsCallsDocumentSearch200Response.md +4 -0
  70. package/docs/EarningsCallsDocumentSearch200ResponseHitsInner.md +6 -0
  71. package/docs/EarningsCallsEvents200ResponseEventsInner.md +2 -0
  72. package/docs/EarningsCallsLive200ResponseEventsInner.md +2 -0
  73. package/docs/EarningsCallsSearch200Response.md +4 -0
  74. package/docs/EarningsCallsSearch200ResponseHitsInner.md +6 -0
  75. package/docs/EarningsCallsSlides200Response.md +2 -0
  76. package/docs/EarningsCallsSlides200ResponseTimelineInner.md +36 -0
  77. package/docs/HitMatch.md +39 -0
  78. package/docs/MatchSpan.md +36 -0
  79. package/docs/SearchCoverage.md +39 -0
  80. package/docs/SearchCoverageLeg.md +41 -0
  81. package/package.json +1 -1
  82. package/src/apis/EarningsCallsApi.ts +58 -6
  83. package/src/models/EarningsCallsCalendar200ResponseEventsInner.ts +17 -0
  84. package/src/models/EarningsCallsCalendar200ResponseEventsInnerVideo.ts +140 -0
  85. package/src/models/EarningsCallsDocumentSearch200Response.ts +36 -0
  86. package/src/models/EarningsCallsDocumentSearch200ResponseHitsInner.ts +37 -2
  87. package/src/models/EarningsCallsEvents200ResponseEventsInner.ts +16 -0
  88. package/src/models/EarningsCallsLive200ResponseEventsInner.ts +17 -0
  89. package/src/models/EarningsCallsSearch200Response.ts +36 -0
  90. package/src/models/EarningsCallsSearch200ResponseHitsInner.ts +36 -2
  91. package/src/models/EarningsCallsSlides200Response.ts +16 -0
  92. package/src/models/EarningsCallsSlides200ResponseTimelineInner.ts +75 -0
  93. package/src/models/HitMatch.ts +103 -0
  94. package/src/models/MatchSpan.ts +75 -0
  95. package/src/models/SearchCoverage.ts +114 -0
  96. package/src/models/SearchCoverageLeg.ts +105 -0
  97. package/src/models/index.ts +6 -0
@@ -0,0 +1,105 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Invinite API
5
+ * Invinite financial data API. Each endpoint 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-Included-Remaining` what is left of the plan\'s included credits. `GET /v1/account/usage` returns your account\'s usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK); 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; `ping` 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` | ≤ 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 `ping` 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. 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/account/usage` serves no licensed data and carries 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, WebSocket, Account.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
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 text index (lexical and literal); null when the counts could not be read
18
+ * @export
19
+ * @interface SearchCoverageLeg
20
+ */
21
+ export interface SearchCoverageLeg {
22
+ /**
23
+ * ready = nothing outstanding; partial = some owners outstanding; not_ready = nothing indexed
24
+ * @type {SearchCoverageLegStateEnum}
25
+ * @memberof SearchCoverageLeg
26
+ */
27
+ state: SearchCoverageLegStateEnum;
28
+ /**
29
+ * Transcripts / documents of the scope searchable in this index
30
+ * @type {number}
31
+ * @memberof SearchCoverageLeg
32
+ */
33
+ indexed: number;
34
+ /**
35
+ * Not indexed yet (or not provably)
36
+ * @type {number}
37
+ * @memberof SearchCoverageLeg
38
+ */
39
+ pending: number;
40
+ /**
41
+ * Indexing failed
42
+ * @type {number}
43
+ * @memberof SearchCoverageLeg
44
+ */
45
+ failed: number;
46
+ }
47
+
48
+
49
+ /**
50
+ * @export
51
+ */
52
+ export const SearchCoverageLegStateEnum = {
53
+ Ready: 'ready',
54
+ Partial: 'partial',
55
+ NotReady: 'not_ready'
56
+ } as const;
57
+ export type SearchCoverageLegStateEnum = typeof SearchCoverageLegStateEnum[keyof typeof SearchCoverageLegStateEnum];
58
+
59
+
60
+ /**
61
+ * Check if a given object implements the SearchCoverageLeg interface.
62
+ */
63
+ export function instanceOfSearchCoverageLeg(value: object): value is SearchCoverageLeg {
64
+ if (!('state' in value) || value['state'] === undefined) return false;
65
+ if (!('indexed' in value) || value['indexed'] === undefined) return false;
66
+ if (!('pending' in value) || value['pending'] === undefined) return false;
67
+ if (!('failed' in value) || value['failed'] === undefined) return false;
68
+ return true;
69
+ }
70
+
71
+ export function SearchCoverageLegFromJSON(json: any): SearchCoverageLeg {
72
+ return SearchCoverageLegFromJSONTyped(json, false);
73
+ }
74
+
75
+ export function SearchCoverageLegFromJSONTyped(json: any, ignoreDiscriminator: boolean): SearchCoverageLeg {
76
+ if (json == null) {
77
+ return json;
78
+ }
79
+ return {
80
+
81
+ 'state': json['state'],
82
+ 'indexed': json['indexed'],
83
+ 'pending': json['pending'],
84
+ 'failed': json['failed'],
85
+ };
86
+ }
87
+
88
+ export function SearchCoverageLegToJSON(json: any): SearchCoverageLeg {
89
+ return SearchCoverageLegToJSONTyped(json, false);
90
+ }
91
+
92
+ export function SearchCoverageLegToJSONTyped(value?: SearchCoverageLeg | null, ignoreDiscriminator: boolean = false): any {
93
+ if (value == null) {
94
+ return value;
95
+ }
96
+
97
+ return {
98
+
99
+ 'state': value['state'],
100
+ 'indexed': value['indexed'],
101
+ 'pending': value['pending'],
102
+ 'failed': value['failed'],
103
+ };
104
+ }
105
+
@@ -46,6 +46,7 @@ export * from './EarningsCallsAnalysts200ResponseAnalystsInner';
46
46
  export * from './EarningsCallsAudio200Response';
47
47
  export * from './EarningsCallsCalendar200Response';
48
48
  export * from './EarningsCallsCalendar200ResponseEventsInner';
49
+ export * from './EarningsCallsCalendar200ResponseEventsInnerVideo';
49
50
  export * from './EarningsCallsCompanyDocument200Response';
50
51
  export * from './EarningsCallsCompanyDocuments200Response';
51
52
  export * from './EarningsCallsCompanyDocuments200ResponseCompany';
@@ -104,6 +105,7 @@ export * from './EarningsCallsSearch200ResponseHitsInnerSlide';
104
105
  export * from './EarningsCallsSlides200Response';
105
106
  export * from './EarningsCallsSlides200ResponseDeck';
106
107
  export * from './EarningsCallsSlides200ResponseSlidesInner';
108
+ export * from './EarningsCallsSlides200ResponseTimelineInner';
107
109
  export * from './EarningsCallsTranscript200Response';
108
110
  export * from './EarningsCallsTranscript404Response';
109
111
  export * from './EarningsCallsTranscriptDiff200Response';
@@ -127,6 +129,7 @@ export * from './FinancialMetricsRatios200ResponseCompaniesInner';
127
129
  export * from './FinancialMetricsRatios200ResponseCompaniesInnerPeriodsInner';
128
130
  export * from './ForbiddenError';
129
131
  export * from './HealthGet200Response';
132
+ export * from './HitMatch';
130
133
  export * from './InsiderTradesList200Response';
131
134
  export * from './InsiderTradesList200ResponseTransactionsInner';
132
135
  export * from './InstitutionalOwnershipHoldingsByCompany200Response';
@@ -141,6 +144,7 @@ export * from './IposList200Response';
141
144
  export * from './IposList200ResponseIposInner';
142
145
  export * from './MarketHolidays200Response';
143
146
  export * from './MarketHolidays200ResponseHolidaysInner';
147
+ export * from './MatchSpan';
144
148
  export * from './MetadataAvailableMetrics200Response';
145
149
  export * from './MetadataAvailableMetrics200ResponseMetricsInner';
146
150
  export * from './MetadataAvailableSectionIds200Response';
@@ -148,6 +152,8 @@ export * from './MetadataAvailableSectionIds200ResponseFormTypesInner';
148
152
  export * from './MetadataAvailableSectionIds200ResponseFormTypesInnerSectionsInner';
149
153
  export * from './NotFoundError';
150
154
  export * from './PresentationFact';
155
+ export * from './SearchCoverage';
156
+ export * from './SearchCoverageLeg';
151
157
  export * from './SecFilingsAvailableFormTypes200Response';
152
158
  export * from './SecFilingsList200Response';
153
159
  export * from './SecFilingsList200ResponseCompaniesInner';