@invinite-org/data-api-client 0.4.0 → 0.6.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 +12 -0
- package/dist/apis/EarningsCallsApi.d.ts +4 -8
- package/dist/apis/EarningsCallsApi.js +6 -10
- package/dist/apis/IPOsApi.d.ts +55 -2
- package/dist/apis/IPOsApi.js +95 -3
- package/dist/apis/SECFilingsApi.d.ts +2 -2
- package/dist/apis/SECFilingsApi.js +2 -2
- package/dist/esm/apis/EarningsCallsApi.d.ts +4 -8
- package/dist/esm/apis/EarningsCallsApi.js +6 -10
- package/dist/esm/apis/IPOsApi.d.ts +55 -2
- package/dist/esm/apis/IPOsApi.js +94 -2
- package/dist/esm/apis/SECFilingsApi.d.ts +2 -2
- package/dist/esm/apis/SECFilingsApi.js +2 -2
- package/dist/esm/models/EarningsCallsDocumentSearch200Response.d.ts +0 -2
- package/dist/esm/models/EarningsCallsDocumentSearch200Response.js +1 -3
- package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +1 -1
- package/dist/esm/models/EarningsCallsSearch200Response.d.ts +0 -2
- package/dist/esm/models/EarningsCallsSearch200Response.js +1 -3
- package/dist/esm/models/EarningsCallsSearch200ResponseHitsInner.d.ts +1 -1
- package/dist/esm/models/HitMatch.d.ts +4 -12
- package/dist/esm/models/HitMatch.js +1 -7
- package/dist/esm/models/IposList200ResponseIposInner.d.ts +7 -0
- package/dist/esm/models/IposList200ResponseIposInner.js +5 -0
- package/dist/esm/models/IposList200ResponseIposInnerRegistration.d.ts +63 -0
- package/dist/esm/models/IposList200ResponseIposInnerRegistration.js +67 -0
- package/dist/esm/models/IposRegistrationsList200Response.d.ts +39 -0
- package/dist/esm/models/IposRegistrationsList200Response.js +46 -0
- package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInner.d.ts +182 -0
- package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInner.js +149 -0
- package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerFilingsInner.d.ts +62 -0
- package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerFilingsInner.js +63 -0
- package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerMassive.d.ts +62 -0
- package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerMassive.js +63 -0
- package/dist/esm/models/ProposedSymbol.d.ts +56 -0
- package/dist/esm/models/ProposedSymbol.js +59 -0
- package/dist/esm/models/SearchCoverage.d.ts +1 -11
- package/dist/esm/models/SearchCoverage.js +0 -8
- package/dist/esm/models/SearchCoverageLeg.d.ts +1 -1
- package/dist/esm/models/SecFilingsList200ResponseCompaniesInner.d.ts +2 -2
- package/dist/esm/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.d.ts +7 -0
- package/dist/esm/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.js +5 -0
- package/dist/esm/models/WebSocketFiling.d.ts +14 -1
- package/dist/esm/models/WebSocketFiling.js +9 -0
- package/dist/esm/models/index.d.ts +6 -0
- package/dist/esm/models/index.js +6 -0
- package/dist/models/EarningsCallsDocumentSearch200Response.d.ts +0 -2
- package/dist/models/EarningsCallsDocumentSearch200Response.js +1 -3
- package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +1 -1
- package/dist/models/EarningsCallsSearch200Response.d.ts +0 -2
- package/dist/models/EarningsCallsSearch200Response.js +1 -3
- package/dist/models/EarningsCallsSearch200ResponseHitsInner.d.ts +1 -1
- package/dist/models/HitMatch.d.ts +4 -12
- package/dist/models/HitMatch.js +1 -7
- package/dist/models/IposList200ResponseIposInner.d.ts +7 -0
- package/dist/models/IposList200ResponseIposInner.js +5 -0
- package/dist/models/IposList200ResponseIposInnerRegistration.d.ts +63 -0
- package/dist/models/IposList200ResponseIposInnerRegistration.js +75 -0
- package/dist/models/IposRegistrationsList200Response.d.ts +39 -0
- package/dist/models/IposRegistrationsList200Response.js +53 -0
- package/dist/models/IposRegistrationsList200ResponseRegistrationsInner.d.ts +182 -0
- package/dist/models/IposRegistrationsList200ResponseRegistrationsInner.js +157 -0
- package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerFilingsInner.d.ts +62 -0
- package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerFilingsInner.js +70 -0
- package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerMassive.d.ts +62 -0
- package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerMassive.js +70 -0
- package/dist/models/ProposedSymbol.d.ts +56 -0
- package/dist/models/ProposedSymbol.js +66 -0
- package/dist/models/SearchCoverage.d.ts +1 -11
- package/dist/models/SearchCoverage.js +0 -8
- package/dist/models/SearchCoverageLeg.d.ts +1 -1
- package/dist/models/SecFilingsList200ResponseCompaniesInner.d.ts +2 -2
- package/dist/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.d.ts +7 -0
- package/dist/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.js +5 -0
- package/dist/models/WebSocketFiling.d.ts +14 -1
- package/dist/models/WebSocketFiling.js +9 -0
- package/dist/models/index.d.ts +6 -0
- package/dist/models/index.js +6 -0
- package/docs/EarningsCallsApi.md +12 -14
- package/docs/HitMatch.md +0 -2
- package/docs/IPOsApi.md +94 -1
- package/docs/IposList200ResponseIposInner.md +2 -0
- package/docs/IposList200ResponseIposInnerRegistration.md +41 -0
- package/docs/IposRegistrationsList200Response.md +36 -0
- package/docs/IposRegistrationsList200ResponseRegistrationsInner.md +76 -0
- package/docs/IposRegistrationsList200ResponseRegistrationsInnerFilingsInner.md +44 -0
- package/docs/IposRegistrationsList200ResponseRegistrationsInnerMassive.md +45 -0
- package/docs/ProposedSymbol.md +43 -0
- package/docs/SECFilingsApi.md +3 -3
- package/docs/SearchCoverage.md +1 -3
- package/docs/SearchCoverageLeg.md +1 -1
- package/docs/SecFilingsList200ResponseCompaniesInnerFilingsInner.md +2 -0
- package/docs/WebSocketFiling.md +5 -0
- package/package.json +1 -1
- package/src/apis/EarningsCallsApi.ts +6 -10
- package/src/apis/IPOsApi.ts +121 -2
- package/src/apis/SECFilingsApi.ts +2 -2
- package/src/models/EarningsCallsDocumentSearch200Response.ts +1 -3
- package/src/models/EarningsCallsDocumentSearch200ResponseHitsInner.ts +1 -1
- package/src/models/EarningsCallsSearch200Response.ts +1 -3
- package/src/models/EarningsCallsSearch200ResponseHitsInner.ts +1 -1
- package/src/models/HitMatch.ts +5 -16
- package/src/models/IposList200ResponseIposInner.ts +17 -0
- package/src/models/IposList200ResponseIposInnerRegistration.ts +109 -0
- package/src/models/IposRegistrationsList200Response.ts +82 -0
- package/src/models/IposRegistrationsList200ResponseRegistrationsInner.ts +302 -0
- package/src/models/IposRegistrationsList200ResponseRegistrationsInnerFilingsInner.ts +111 -0
- package/src/models/IposRegistrationsList200ResponseRegistrationsInnerMassive.ts +111 -0
- package/src/models/ProposedSymbol.ts +102 -0
- package/src/models/SearchCoverage.ts +1 -14
- package/src/models/SearchCoverageLeg.ts +1 -1
- package/src/models/SecFilingsList200ResponseCompaniesInner.ts +2 -2
- package/src/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.ts +17 -0
- package/src/models/WebSocketFiling.ts +27 -1
- package/src/models/index.ts +6 -0
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
|
-
* The
|
|
13
|
+
* The text index (lexical and literal); null when the counts could not be read
|
|
14
14
|
* @export
|
|
15
15
|
* @interface SearchCoverageLeg
|
|
16
16
|
*/
|
|
@@ -17,11 +17,11 @@ import type { SecFilingsList200ResponseCompaniesInnerFilingsInner } from './SecF
|
|
|
17
17
|
*/
|
|
18
18
|
export interface SecFilingsList200ResponseCompaniesInner {
|
|
19
19
|
/**
|
|
20
|
-
* Ticker symbol
|
|
20
|
+
* Ticker symbol; null for a company that is not listed yet (pre-IPO)
|
|
21
21
|
* @type {string}
|
|
22
22
|
* @memberof SecFilingsList200ResponseCompaniesInner
|
|
23
23
|
*/
|
|
24
|
-
ticker: string;
|
|
24
|
+
ticker: string | null;
|
|
25
25
|
/**
|
|
26
26
|
* CIK (with or without leading zeros)
|
|
27
27
|
* @type {string}
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import type { ProposedSymbol } from './ProposedSymbol';
|
|
12
13
|
/**
|
|
13
14
|
*
|
|
14
15
|
* @export
|
|
@@ -75,6 +76,12 @@ export interface SecFilingsList200ResponseCompaniesInnerFilingsInner {
|
|
|
75
76
|
* @memberof SecFilingsList200ResponseCompaniesInnerFilingsInner
|
|
76
77
|
*/
|
|
77
78
|
period_end: Date | null;
|
|
79
|
+
/**
|
|
80
|
+
* Tickers the registration statement proposes (S-1, S-1/A, F-1, F-1/A only). null = not a registration form (or not read), [] = none found
|
|
81
|
+
* @type {Array<ProposedSymbol>}
|
|
82
|
+
* @memberof SecFilingsList200ResponseCompaniesInnerFilingsInner
|
|
83
|
+
*/
|
|
84
|
+
proposed_symbols: Array<ProposedSymbol> | null;
|
|
78
85
|
}
|
|
79
86
|
/**
|
|
80
87
|
* Check if a given object implements the SecFilingsList200ResponseCompaniesInnerFilingsInner interface.
|
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
* https://openapi-generator.tech
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
|
+
import { ProposedSymbolFromJSON, ProposedSymbolToJSON, } from './ProposedSymbol';
|
|
14
15
|
/**
|
|
15
16
|
* Check if a given object implements the SecFilingsList200ResponseCompaniesInnerFilingsInner interface.
|
|
16
17
|
*/
|
|
@@ -35,6 +36,8 @@ export function instanceOfSecFilingsList200ResponseCompaniesInnerFilingsInner(va
|
|
|
35
36
|
return false;
|
|
36
37
|
if (!('period_end' in value) || value['period_end'] === undefined)
|
|
37
38
|
return false;
|
|
39
|
+
if (!('proposed_symbols' in value) || value['proposed_symbols'] === undefined)
|
|
40
|
+
return false;
|
|
38
41
|
return true;
|
|
39
42
|
}
|
|
40
43
|
export function SecFilingsList200ResponseCompaniesInnerFilingsInnerFromJSON(json) {
|
|
@@ -55,6 +58,7 @@ export function SecFilingsList200ResponseCompaniesInnerFilingsInnerFromJSONTyped
|
|
|
55
58
|
'form_type': json['form_type'],
|
|
56
59
|
'html_url': json['html_url'],
|
|
57
60
|
'period_end': (json['period_end'] == null ? null : new Date(json['period_end'])),
|
|
61
|
+
'proposed_symbols': (json['proposed_symbols'] == null ? null : json['proposed_symbols'].map(ProposedSymbolFromJSON)),
|
|
58
62
|
};
|
|
59
63
|
}
|
|
60
64
|
export function SecFilingsList200ResponseCompaniesInnerFilingsInnerToJSON(json) {
|
|
@@ -75,5 +79,6 @@ export function SecFilingsList200ResponseCompaniesInnerFilingsInnerToJSONTyped(v
|
|
|
75
79
|
'form_type': value['form_type'],
|
|
76
80
|
'html_url': value['html_url'],
|
|
77
81
|
'period_end': value['period_end'] == null ? value['period_end'] : value['period_end'].toISOString().substring(0, 10),
|
|
82
|
+
'proposed_symbols': (value['proposed_symbols'] == null ? null : value['proposed_symbols'].map(ProposedSymbolToJSON)),
|
|
78
83
|
};
|
|
79
84
|
}
|
|
@@ -9,8 +9,9 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import type { ProposedSymbol } from './ProposedSymbol';
|
|
12
13
|
/**
|
|
13
|
-
*
|
|
14
|
+
* A new SEC filing, the same fields as a GET /v1/sec-filings/filings row plus `ticker`. Until 2026-10 the frame forwarded the upstream camelCase envelope (`schemaVersion`, `eventKey`, `filing.accessionNumber`, …) instead of this documented shape; it now is exactly this object
|
|
14
15
|
* @export
|
|
15
16
|
* @interface WebSocketFiling
|
|
16
17
|
*/
|
|
@@ -75,6 +76,18 @@ export interface WebSocketFiling {
|
|
|
75
76
|
* @memberof WebSocketFiling
|
|
76
77
|
*/
|
|
77
78
|
period_end: Date | null;
|
|
79
|
+
/**
|
|
80
|
+
* Ticker of the company's primary listing; null for a company that is not listed yet (pre-IPO)
|
|
81
|
+
* @type {string}
|
|
82
|
+
* @memberof WebSocketFiling
|
|
83
|
+
*/
|
|
84
|
+
ticker: string | null;
|
|
85
|
+
/**
|
|
86
|
+
* Tickers a registration statement (S-1, S-1/A, F-1, F-1/A) proposes; null when the filing carries none
|
|
87
|
+
* @type {Array<ProposedSymbol>}
|
|
88
|
+
* @memberof WebSocketFiling
|
|
89
|
+
*/
|
|
90
|
+
proposed_symbols: Array<ProposedSymbol> | null;
|
|
78
91
|
}
|
|
79
92
|
/**
|
|
80
93
|
* Check if a given object implements the WebSocketFiling interface.
|
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
* https://openapi-generator.tech
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
|
+
import { ProposedSymbolFromJSON, ProposedSymbolToJSON, } from './ProposedSymbol';
|
|
14
15
|
/**
|
|
15
16
|
* Check if a given object implements the WebSocketFiling interface.
|
|
16
17
|
*/
|
|
@@ -35,6 +36,10 @@ export function instanceOfWebSocketFiling(value) {
|
|
|
35
36
|
return false;
|
|
36
37
|
if (!('period_end' in value) || value['period_end'] === undefined)
|
|
37
38
|
return false;
|
|
39
|
+
if (!('ticker' in value) || value['ticker'] === undefined)
|
|
40
|
+
return false;
|
|
41
|
+
if (!('proposed_symbols' in value) || value['proposed_symbols'] === undefined)
|
|
42
|
+
return false;
|
|
38
43
|
return true;
|
|
39
44
|
}
|
|
40
45
|
export function WebSocketFilingFromJSON(json) {
|
|
@@ -55,6 +60,8 @@ export function WebSocketFilingFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
55
60
|
'form_type': json['form_type'],
|
|
56
61
|
'html_url': json['html_url'],
|
|
57
62
|
'period_end': (json['period_end'] == null ? null : new Date(json['period_end'])),
|
|
63
|
+
'ticker': json['ticker'],
|
|
64
|
+
'proposed_symbols': (json['proposed_symbols'] == null ? null : json['proposed_symbols'].map(ProposedSymbolFromJSON)),
|
|
58
65
|
};
|
|
59
66
|
}
|
|
60
67
|
export function WebSocketFilingToJSON(json) {
|
|
@@ -75,5 +82,7 @@ export function WebSocketFilingToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
75
82
|
'form_type': value['form_type'],
|
|
76
83
|
'html_url': value['html_url'],
|
|
77
84
|
'period_end': value['period_end'] == null ? value['period_end'] : value['period_end'].toISOString().substring(0, 10),
|
|
85
|
+
'ticker': value['ticker'],
|
|
86
|
+
'proposed_symbols': (value['proposed_symbols'] == null ? null : value['proposed_symbols'].map(ProposedSymbolToJSON)),
|
|
78
87
|
};
|
|
79
88
|
}
|
|
@@ -140,6 +140,11 @@ export * from './InstitutionalOwnershipTransactions200ResponseTransactionsInner'
|
|
|
140
140
|
export * from './InternalServerError';
|
|
141
141
|
export * from './IposList200Response';
|
|
142
142
|
export * from './IposList200ResponseIposInner';
|
|
143
|
+
export * from './IposList200ResponseIposInnerRegistration';
|
|
144
|
+
export * from './IposRegistrationsList200Response';
|
|
145
|
+
export * from './IposRegistrationsList200ResponseRegistrationsInner';
|
|
146
|
+
export * from './IposRegistrationsList200ResponseRegistrationsInnerFilingsInner';
|
|
147
|
+
export * from './IposRegistrationsList200ResponseRegistrationsInnerMassive';
|
|
143
148
|
export * from './MarketHolidays200Response';
|
|
144
149
|
export * from './MarketHolidays200ResponseHolidaysInner';
|
|
145
150
|
export * from './MatchSpan';
|
|
@@ -150,6 +155,7 @@ export * from './MetadataAvailableSectionIds200ResponseFormTypesInner';
|
|
|
150
155
|
export * from './MetadataAvailableSectionIds200ResponseFormTypesInnerSectionsInner';
|
|
151
156
|
export * from './NotFoundError';
|
|
152
157
|
export * from './PresentationFact';
|
|
158
|
+
export * from './ProposedSymbol';
|
|
153
159
|
export * from './SearchCoverage';
|
|
154
160
|
export * from './SearchCoverageLeg';
|
|
155
161
|
export * from './SecFilingsAvailableFormTypes200Response';
|
package/dist/esm/models/index.js
CHANGED
|
@@ -142,6 +142,11 @@ export * from './InstitutionalOwnershipTransactions200ResponseTransactionsInner'
|
|
|
142
142
|
export * from './InternalServerError';
|
|
143
143
|
export * from './IposList200Response';
|
|
144
144
|
export * from './IposList200ResponseIposInner';
|
|
145
|
+
export * from './IposList200ResponseIposInnerRegistration';
|
|
146
|
+
export * from './IposRegistrationsList200Response';
|
|
147
|
+
export * from './IposRegistrationsList200ResponseRegistrationsInner';
|
|
148
|
+
export * from './IposRegistrationsList200ResponseRegistrationsInnerFilingsInner';
|
|
149
|
+
export * from './IposRegistrationsList200ResponseRegistrationsInnerMassive';
|
|
145
150
|
export * from './MarketHolidays200Response';
|
|
146
151
|
export * from './MarketHolidays200ResponseHolidaysInner';
|
|
147
152
|
export * from './MatchSpan';
|
|
@@ -152,6 +157,7 @@ export * from './MetadataAvailableSectionIds200ResponseFormTypesInner';
|
|
|
152
157
|
export * from './MetadataAvailableSectionIds200ResponseFormTypesInnerSectionsInner';
|
|
153
158
|
export * from './NotFoundError';
|
|
154
159
|
export * from './PresentationFact';
|
|
160
|
+
export * from './ProposedSymbol';
|
|
155
161
|
export * from './SearchCoverage';
|
|
156
162
|
export * from './SearchCoverageLeg';
|
|
157
163
|
export * from './SecFilingsAvailableFormTypes200Response';
|
|
@@ -48,8 +48,6 @@ export interface EarningsCallsDocumentSearch200Response {
|
|
|
48
48
|
export declare const EarningsCallsDocumentSearch200ResponseModeEnum: {
|
|
49
49
|
readonly Lexical: "lexical";
|
|
50
50
|
readonly Literal: "literal";
|
|
51
|
-
readonly Semantic: "semantic";
|
|
52
|
-
readonly Hybrid: "hybrid";
|
|
53
51
|
};
|
|
54
52
|
export type EarningsCallsDocumentSearch200ResponseModeEnum = typeof EarningsCallsDocumentSearch200ResponseModeEnum[keyof typeof EarningsCallsDocumentSearch200ResponseModeEnum];
|
|
55
53
|
/**
|
|
@@ -26,9 +26,7 @@ const SearchCoverage_1 = require("./SearchCoverage");
|
|
|
26
26
|
*/
|
|
27
27
|
exports.EarningsCallsDocumentSearch200ResponseModeEnum = {
|
|
28
28
|
Lexical: 'lexical',
|
|
29
|
-
Literal: 'literal'
|
|
30
|
-
Semantic: 'semantic',
|
|
31
|
-
Hybrid: 'hybrid'
|
|
29
|
+
Literal: 'literal'
|
|
32
30
|
};
|
|
33
31
|
/**
|
|
34
32
|
* Check if a given object implements the EarningsCallsDocumentSearch200Response interface.
|
|
@@ -17,7 +17,7 @@ import type { HitMatch } from './HitMatch';
|
|
|
17
17
|
*/
|
|
18
18
|
export interface EarningsCallsDocumentSearch200ResponseHitsInner {
|
|
19
19
|
/**
|
|
20
|
-
* Relevance per mode: lexical = ts_rank_cd (4 decimals), literal = 0 (hits are ordered newest year first)
|
|
20
|
+
* Relevance per mode: lexical = ts_rank_cd (4 decimals), literal = 0 (hits are ordered newest year first)
|
|
21
21
|
* @type {number}
|
|
22
22
|
* @memberof EarningsCallsDocumentSearch200ResponseHitsInner
|
|
23
23
|
*/
|
|
@@ -48,8 +48,6 @@ export interface EarningsCallsSearch200Response {
|
|
|
48
48
|
export declare const EarningsCallsSearch200ResponseModeEnum: {
|
|
49
49
|
readonly Lexical: "lexical";
|
|
50
50
|
readonly Literal: "literal";
|
|
51
|
-
readonly Semantic: "semantic";
|
|
52
|
-
readonly Hybrid: "hybrid";
|
|
53
51
|
};
|
|
54
52
|
export type EarningsCallsSearch200ResponseModeEnum = typeof EarningsCallsSearch200ResponseModeEnum[keyof typeof EarningsCallsSearch200ResponseModeEnum];
|
|
55
53
|
/**
|
|
@@ -26,9 +26,7 @@ const SearchCoverage_1 = require("./SearchCoverage");
|
|
|
26
26
|
*/
|
|
27
27
|
exports.EarningsCallsSearch200ResponseModeEnum = {
|
|
28
28
|
Lexical: 'lexical',
|
|
29
|
-
Literal: 'literal'
|
|
30
|
-
Semantic: 'semantic',
|
|
31
|
-
Hybrid: 'hybrid'
|
|
29
|
+
Literal: 'literal'
|
|
32
30
|
};
|
|
33
31
|
/**
|
|
34
32
|
* Check if a given object implements the EarningsCallsSearch200Response interface.
|
|
@@ -97,7 +97,7 @@ export interface EarningsCallsSearch200ResponseHitsInner {
|
|
|
97
97
|
*/
|
|
98
98
|
text_truncated: boolean;
|
|
99
99
|
/**
|
|
100
|
-
* Relevance per mode: lexical =
|
|
100
|
+
* Relevance per mode: lexical = BM25 with `identifier` / `event_id` (an answer attached to its question scores 0.99 × the question), else ts_rank_cd (4 decimals), literal = 0 (hits are ordered newest call first)
|
|
101
101
|
* @type {number}
|
|
102
102
|
* @memberof EarningsCallsSearch200ResponseHitsInner
|
|
103
103
|
*/
|
|
@@ -17,25 +17,19 @@ import type { MatchSpan } from './MatchSpan';
|
|
|
17
17
|
*/
|
|
18
18
|
export interface HitMatch {
|
|
19
19
|
/**
|
|
20
|
-
* The
|
|
20
|
+
* The mode that found the passage
|
|
21
21
|
* @type {HitMatchTypeEnum}
|
|
22
22
|
* @memberof HitMatch
|
|
23
23
|
*/
|
|
24
24
|
type: HitMatchTypeEnum;
|
|
25
25
|
/**
|
|
26
|
-
* 1-based rank
|
|
26
|
+
* 1-based rank of the passage in the answer
|
|
27
27
|
* @type {number}
|
|
28
28
|
* @memberof HitMatch
|
|
29
29
|
*/
|
|
30
|
-
lexical_rank: number
|
|
30
|
+
lexical_rank: number;
|
|
31
31
|
/**
|
|
32
|
-
*
|
|
33
|
-
* @type {number}
|
|
34
|
-
* @memberof HitMatch
|
|
35
|
-
*/
|
|
36
|
-
semantic_rank: number | null;
|
|
37
|
-
/**
|
|
38
|
-
* Matched characters in `text`; empty for semantic matches
|
|
32
|
+
* Matched characters in `text`; empty for an answer attached after its matched question (scoped lexical transcript search)
|
|
39
33
|
* @type {Array<MatchSpan>}
|
|
40
34
|
* @memberof HitMatch
|
|
41
35
|
*/
|
|
@@ -47,8 +41,6 @@ export interface HitMatch {
|
|
|
47
41
|
export declare const HitMatchTypeEnum: {
|
|
48
42
|
readonly Lexical: "lexical";
|
|
49
43
|
readonly Literal: "literal";
|
|
50
|
-
readonly Semantic: "semantic";
|
|
51
|
-
readonly Hybrid: "hybrid";
|
|
52
44
|
};
|
|
53
45
|
export type HitMatchTypeEnum = typeof HitMatchTypeEnum[keyof typeof HitMatchTypeEnum];
|
|
54
46
|
/**
|
package/dist/models/HitMatch.js
CHANGED
|
@@ -25,9 +25,7 @@ const MatchSpan_1 = require("./MatchSpan");
|
|
|
25
25
|
*/
|
|
26
26
|
exports.HitMatchTypeEnum = {
|
|
27
27
|
Lexical: 'lexical',
|
|
28
|
-
Literal: 'literal'
|
|
29
|
-
Semantic: 'semantic',
|
|
30
|
-
Hybrid: 'hybrid'
|
|
28
|
+
Literal: 'literal'
|
|
31
29
|
};
|
|
32
30
|
/**
|
|
33
31
|
* Check if a given object implements the HitMatch interface.
|
|
@@ -37,8 +35,6 @@ function instanceOfHitMatch(value) {
|
|
|
37
35
|
return false;
|
|
38
36
|
if (!('lexical_rank' in value) || value['lexical_rank'] === undefined)
|
|
39
37
|
return false;
|
|
40
|
-
if (!('semantic_rank' in value) || value['semantic_rank'] === undefined)
|
|
41
|
-
return false;
|
|
42
38
|
if (!('spans' in value) || value['spans'] === undefined)
|
|
43
39
|
return false;
|
|
44
40
|
return true;
|
|
@@ -53,7 +49,6 @@ function HitMatchFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
53
49
|
return {
|
|
54
50
|
'type': json['type'],
|
|
55
51
|
'lexical_rank': json['lexical_rank'],
|
|
56
|
-
'semantic_rank': json['semantic_rank'],
|
|
57
52
|
'spans': (json['spans'].map(MatchSpan_1.MatchSpanFromJSON)),
|
|
58
53
|
};
|
|
59
54
|
}
|
|
@@ -67,7 +62,6 @@ function HitMatchToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
67
62
|
return {
|
|
68
63
|
'type': value['type'],
|
|
69
64
|
'lexical_rank': value['lexical_rank'],
|
|
70
|
-
'semantic_rank': value['semantic_rank'],
|
|
71
65
|
'spans': (value['spans'].map(MatchSpan_1.MatchSpanToJSON)),
|
|
72
66
|
};
|
|
73
67
|
}
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import type { IposList200ResponseIposInnerRegistration } from './IposList200ResponseIposInnerRegistration';
|
|
12
13
|
/**
|
|
13
14
|
*
|
|
14
15
|
* @export
|
|
@@ -147,6 +148,12 @@ export interface IposList200ResponseIposInner {
|
|
|
147
148
|
* @memberof IposList200ResponseIposInner
|
|
148
149
|
*/
|
|
149
150
|
us_code: string;
|
|
151
|
+
/**
|
|
152
|
+
*
|
|
153
|
+
* @type {IposList200ResponseIposInnerRegistration}
|
|
154
|
+
* @memberof IposList200ResponseIposInner
|
|
155
|
+
*/
|
|
156
|
+
registration: IposList200ResponseIposInnerRegistration | null;
|
|
150
157
|
}
|
|
151
158
|
/**
|
|
152
159
|
* Check if a given object implements the IposList200ResponseIposInner interface.
|
|
@@ -18,6 +18,7 @@ exports.IposList200ResponseIposInnerFromJSON = IposList200ResponseIposInnerFromJ
|
|
|
18
18
|
exports.IposList200ResponseIposInnerFromJSONTyped = IposList200ResponseIposInnerFromJSONTyped;
|
|
19
19
|
exports.IposList200ResponseIposInnerToJSON = IposList200ResponseIposInnerToJSON;
|
|
20
20
|
exports.IposList200ResponseIposInnerToJSONTyped = IposList200ResponseIposInnerToJSONTyped;
|
|
21
|
+
const IposList200ResponseIposInnerRegistration_1 = require("./IposList200ResponseIposInnerRegistration");
|
|
21
22
|
/**
|
|
22
23
|
* Check if a given object implements the IposList200ResponseIposInner interface.
|
|
23
24
|
*/
|
|
@@ -66,6 +67,8 @@ function instanceOfIposList200ResponseIposInner(value) {
|
|
|
66
67
|
return false;
|
|
67
68
|
if (!('us_code' in value) || value['us_code'] === undefined)
|
|
68
69
|
return false;
|
|
70
|
+
if (!('registration' in value) || value['registration'] === undefined)
|
|
71
|
+
return false;
|
|
69
72
|
return true;
|
|
70
73
|
}
|
|
71
74
|
function IposList200ResponseIposInnerFromJSON(json) {
|
|
@@ -98,6 +101,7 @@ function IposList200ResponseIposInnerFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
98
101
|
'ticker': json['ticker'],
|
|
99
102
|
'total_offer_size': json['total_offer_size'],
|
|
100
103
|
'us_code': json['us_code'],
|
|
104
|
+
'registration': (0, IposList200ResponseIposInnerRegistration_1.IposList200ResponseIposInnerRegistrationFromJSON)(json['registration']),
|
|
101
105
|
};
|
|
102
106
|
}
|
|
103
107
|
function IposList200ResponseIposInnerToJSON(json) {
|
|
@@ -130,5 +134,6 @@ function IposList200ResponseIposInnerToJSONTyped(value, ignoreDiscriminator = fa
|
|
|
130
134
|
'ticker': value['ticker'],
|
|
131
135
|
'total_offer_size': value['total_offer_size'],
|
|
132
136
|
'us_code': value['us_code'],
|
|
137
|
+
'registration': (0, IposList200ResponseIposInnerRegistration_1.IposList200ResponseIposInnerRegistrationToJSON)(value['registration']),
|
|
133
138
|
};
|
|
134
139
|
}
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Invinite API
|
|
3
|
+
* 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.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
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 SEC registration track (GET /v1/ipos/registrations) matched to this ticker; null when none is
|
|
14
|
+
* @export
|
|
15
|
+
* @interface IposList200ResponseIposInnerRegistration
|
|
16
|
+
*/
|
|
17
|
+
export interface IposList200ResponseIposInnerRegistration {
|
|
18
|
+
/**
|
|
19
|
+
* 10-digit CIK of the issuer
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof IposList200ResponseIposInnerRegistration
|
|
22
|
+
*/
|
|
23
|
+
cik: string;
|
|
24
|
+
/**
|
|
25
|
+
* The registration's track key
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof IposList200ResponseIposInnerRegistration
|
|
28
|
+
*/
|
|
29
|
+
track_key: string;
|
|
30
|
+
/**
|
|
31
|
+
* The registration's stage
|
|
32
|
+
* @type {IposList200ResponseIposInnerRegistrationStageEnum}
|
|
33
|
+
* @memberof IposList200ResponseIposInnerRegistration
|
|
34
|
+
*/
|
|
35
|
+
stage: IposList200ResponseIposInnerRegistrationStageEnum;
|
|
36
|
+
/**
|
|
37
|
+
* Final offering price from the SEC final prospectus (decimal string)
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof IposList200ResponseIposInnerRegistration
|
|
40
|
+
*/
|
|
41
|
+
final_offer_price: string | null;
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* @export
|
|
45
|
+
*/
|
|
46
|
+
export declare const IposList200ResponseIposInnerRegistrationStageEnum: {
|
|
47
|
+
readonly Registered: "registered";
|
|
48
|
+
readonly PriceRange: "price_range";
|
|
49
|
+
readonly ExchangeApproved: "exchange_approved";
|
|
50
|
+
readonly Effective: "effective";
|
|
51
|
+
readonly Priced: "priced";
|
|
52
|
+
readonly Trading: "trading";
|
|
53
|
+
readonly Withdrawn: "withdrawn";
|
|
54
|
+
};
|
|
55
|
+
export type IposList200ResponseIposInnerRegistrationStageEnum = typeof IposList200ResponseIposInnerRegistrationStageEnum[keyof typeof IposList200ResponseIposInnerRegistrationStageEnum];
|
|
56
|
+
/**
|
|
57
|
+
* Check if a given object implements the IposList200ResponseIposInnerRegistration interface.
|
|
58
|
+
*/
|
|
59
|
+
export declare function instanceOfIposList200ResponseIposInnerRegistration(value: object): value is IposList200ResponseIposInnerRegistration;
|
|
60
|
+
export declare function IposList200ResponseIposInnerRegistrationFromJSON(json: any): IposList200ResponseIposInnerRegistration;
|
|
61
|
+
export declare function IposList200ResponseIposInnerRegistrationFromJSONTyped(json: any, ignoreDiscriminator: boolean): IposList200ResponseIposInnerRegistration;
|
|
62
|
+
export declare function IposList200ResponseIposInnerRegistrationToJSON(json: any): IposList200ResponseIposInnerRegistration;
|
|
63
|
+
export declare function IposList200ResponseIposInnerRegistrationToJSONTyped(value?: IposList200ResponseIposInnerRegistration | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Invinite API
|
|
6
|
+
* 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.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.IposList200ResponseIposInnerRegistrationStageEnum = void 0;
|
|
17
|
+
exports.instanceOfIposList200ResponseIposInnerRegistration = instanceOfIposList200ResponseIposInnerRegistration;
|
|
18
|
+
exports.IposList200ResponseIposInnerRegistrationFromJSON = IposList200ResponseIposInnerRegistrationFromJSON;
|
|
19
|
+
exports.IposList200ResponseIposInnerRegistrationFromJSONTyped = IposList200ResponseIposInnerRegistrationFromJSONTyped;
|
|
20
|
+
exports.IposList200ResponseIposInnerRegistrationToJSON = IposList200ResponseIposInnerRegistrationToJSON;
|
|
21
|
+
exports.IposList200ResponseIposInnerRegistrationToJSONTyped = IposList200ResponseIposInnerRegistrationToJSONTyped;
|
|
22
|
+
/**
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
exports.IposList200ResponseIposInnerRegistrationStageEnum = {
|
|
26
|
+
Registered: 'registered',
|
|
27
|
+
PriceRange: 'price_range',
|
|
28
|
+
ExchangeApproved: 'exchange_approved',
|
|
29
|
+
Effective: 'effective',
|
|
30
|
+
Priced: 'priced',
|
|
31
|
+
Trading: 'trading',
|
|
32
|
+
Withdrawn: 'withdrawn'
|
|
33
|
+
};
|
|
34
|
+
/**
|
|
35
|
+
* Check if a given object implements the IposList200ResponseIposInnerRegistration interface.
|
|
36
|
+
*/
|
|
37
|
+
function instanceOfIposList200ResponseIposInnerRegistration(value) {
|
|
38
|
+
if (!('cik' in value) || value['cik'] === undefined)
|
|
39
|
+
return false;
|
|
40
|
+
if (!('track_key' in value) || value['track_key'] === undefined)
|
|
41
|
+
return false;
|
|
42
|
+
if (!('stage' in value) || value['stage'] === undefined)
|
|
43
|
+
return false;
|
|
44
|
+
if (!('final_offer_price' in value) || value['final_offer_price'] === undefined)
|
|
45
|
+
return false;
|
|
46
|
+
return true;
|
|
47
|
+
}
|
|
48
|
+
function IposList200ResponseIposInnerRegistrationFromJSON(json) {
|
|
49
|
+
return IposList200ResponseIposInnerRegistrationFromJSONTyped(json, false);
|
|
50
|
+
}
|
|
51
|
+
function IposList200ResponseIposInnerRegistrationFromJSONTyped(json, ignoreDiscriminator) {
|
|
52
|
+
if (json == null) {
|
|
53
|
+
return json;
|
|
54
|
+
}
|
|
55
|
+
return {
|
|
56
|
+
'cik': json['cik'],
|
|
57
|
+
'track_key': json['track_key'],
|
|
58
|
+
'stage': json['stage'],
|
|
59
|
+
'final_offer_price': json['final_offer_price'],
|
|
60
|
+
};
|
|
61
|
+
}
|
|
62
|
+
function IposList200ResponseIposInnerRegistrationToJSON(json) {
|
|
63
|
+
return IposList200ResponseIposInnerRegistrationToJSONTyped(json, false);
|
|
64
|
+
}
|
|
65
|
+
function IposList200ResponseIposInnerRegistrationToJSONTyped(value, ignoreDiscriminator = false) {
|
|
66
|
+
if (value == null) {
|
|
67
|
+
return value;
|
|
68
|
+
}
|
|
69
|
+
return {
|
|
70
|
+
'cik': value['cik'],
|
|
71
|
+
'track_key': value['track_key'],
|
|
72
|
+
'stage': value['stage'],
|
|
73
|
+
'final_offer_price': value['final_offer_price'],
|
|
74
|
+
};
|
|
75
|
+
}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Invinite API
|
|
3
|
+
* 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.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { IposRegistrationsList200ResponseRegistrationsInner } from './IposRegistrationsList200ResponseRegistrationsInner';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface IposRegistrationsList200Response
|
|
17
|
+
*/
|
|
18
|
+
export interface IposRegistrationsList200Response {
|
|
19
|
+
/**
|
|
20
|
+
* IPO registrations, one per registration statement track
|
|
21
|
+
* @type {Array<IposRegistrationsList200ResponseRegistrationsInner>}
|
|
22
|
+
* @memberof IposRegistrationsList200Response
|
|
23
|
+
*/
|
|
24
|
+
registrations: Array<IposRegistrationsList200ResponseRegistrationsInner>;
|
|
25
|
+
/**
|
|
26
|
+
* URL for the next page (includes next offset and same limit). Omitted when no next page exists.
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof IposRegistrationsList200Response
|
|
29
|
+
*/
|
|
30
|
+
next_url?: string;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Check if a given object implements the IposRegistrationsList200Response interface.
|
|
34
|
+
*/
|
|
35
|
+
export declare function instanceOfIposRegistrationsList200Response(value: object): value is IposRegistrationsList200Response;
|
|
36
|
+
export declare function IposRegistrationsList200ResponseFromJSON(json: any): IposRegistrationsList200Response;
|
|
37
|
+
export declare function IposRegistrationsList200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): IposRegistrationsList200Response;
|
|
38
|
+
export declare function IposRegistrationsList200ResponseToJSON(json: any): IposRegistrationsList200Response;
|
|
39
|
+
export declare function IposRegistrationsList200ResponseToJSONTyped(value?: IposRegistrationsList200Response | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Invinite API
|
|
6
|
+
* 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.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.instanceOfIposRegistrationsList200Response = instanceOfIposRegistrationsList200Response;
|
|
17
|
+
exports.IposRegistrationsList200ResponseFromJSON = IposRegistrationsList200ResponseFromJSON;
|
|
18
|
+
exports.IposRegistrationsList200ResponseFromJSONTyped = IposRegistrationsList200ResponseFromJSONTyped;
|
|
19
|
+
exports.IposRegistrationsList200ResponseToJSON = IposRegistrationsList200ResponseToJSON;
|
|
20
|
+
exports.IposRegistrationsList200ResponseToJSONTyped = IposRegistrationsList200ResponseToJSONTyped;
|
|
21
|
+
const IposRegistrationsList200ResponseRegistrationsInner_1 = require("./IposRegistrationsList200ResponseRegistrationsInner");
|
|
22
|
+
/**
|
|
23
|
+
* Check if a given object implements the IposRegistrationsList200Response interface.
|
|
24
|
+
*/
|
|
25
|
+
function instanceOfIposRegistrationsList200Response(value) {
|
|
26
|
+
if (!('registrations' in value) || value['registrations'] === undefined)
|
|
27
|
+
return false;
|
|
28
|
+
return true;
|
|
29
|
+
}
|
|
30
|
+
function IposRegistrationsList200ResponseFromJSON(json) {
|
|
31
|
+
return IposRegistrationsList200ResponseFromJSONTyped(json, false);
|
|
32
|
+
}
|
|
33
|
+
function IposRegistrationsList200ResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
34
|
+
if (json == null) {
|
|
35
|
+
return json;
|
|
36
|
+
}
|
|
37
|
+
return {
|
|
38
|
+
'registrations': (json['registrations'].map(IposRegistrationsList200ResponseRegistrationsInner_1.IposRegistrationsList200ResponseRegistrationsInnerFromJSON)),
|
|
39
|
+
'next_url': json['next_url'] == null ? undefined : json['next_url'],
|
|
40
|
+
};
|
|
41
|
+
}
|
|
42
|
+
function IposRegistrationsList200ResponseToJSON(json) {
|
|
43
|
+
return IposRegistrationsList200ResponseToJSONTyped(json, false);
|
|
44
|
+
}
|
|
45
|
+
function IposRegistrationsList200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
46
|
+
if (value == null) {
|
|
47
|
+
return value;
|
|
48
|
+
}
|
|
49
|
+
return {
|
|
50
|
+
'registrations': (value['registrations'].map(IposRegistrationsList200ResponseRegistrationsInner_1.IposRegistrationsList200ResponseRegistrationsInnerToJSON)),
|
|
51
|
+
'next_url': value['next_url'],
|
|
52
|
+
};
|
|
53
|
+
}
|