@invinite-org/data-api-client 5.6.0 → 5.9.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 (141) hide show
  1. package/.openapi-generator/FILES +26 -0
  2. package/dist/apis/EventsApi.d.ts +2 -2
  3. package/dist/apis/EventsApi.js +2 -2
  4. package/dist/apis/HoldingsApi.d.ts +33 -0
  5. package/dist/apis/HoldingsApi.js +79 -1
  6. package/dist/apis/IPOsApi.d.ts +54 -0
  7. package/dist/apis/IPOsApi.js +137 -1
  8. package/dist/apis/InsiderTradesApi.d.ts +3 -0
  9. package/dist/apis/InsiderTradesApi.js +9 -0
  10. package/dist/esm/apis/EventsApi.d.ts +2 -2
  11. package/dist/esm/apis/EventsApi.js +2 -2
  12. package/dist/esm/apis/HoldingsApi.d.ts +33 -0
  13. package/dist/esm/apis/HoldingsApi.js +78 -0
  14. package/dist/esm/apis/IPOsApi.d.ts +54 -0
  15. package/dist/esm/apis/IPOsApi.js +136 -0
  16. package/dist/esm/apis/InsiderTradesApi.d.ts +3 -0
  17. package/dist/esm/apis/InsiderTradesApi.js +9 -0
  18. package/dist/esm/models/Company.d.ts +1 -1
  19. package/dist/esm/models/Event.d.ts +2 -1
  20. package/dist/esm/models/Event.js +2 -1
  21. package/dist/esm/models/EventCalendarCall.d.ts +2 -1
  22. package/dist/esm/models/EventCalendarCall.js +1 -0
  23. package/dist/esm/models/Filer.d.ts +6 -0
  24. package/dist/esm/models/Filer.js +2 -0
  25. package/dist/esm/models/FilerDetail.d.ts +14 -0
  26. package/dist/esm/models/FilerDetail.js +6 -0
  27. package/dist/esm/models/FilerFund.d.ts +45 -0
  28. package/dist/esm/models/FilerFund.js +52 -0
  29. package/dist/esm/models/FilerFundAdviser.d.ts +56 -0
  30. package/dist/esm/models/FilerFundAdviser.js +59 -0
  31. package/dist/esm/models/FilerFundReturn.d.ts +62 -0
  32. package/dist/esm/models/FilerFundReturn.js +63 -0
  33. package/dist/esm/models/FilerFundSeries.d.ts +217 -0
  34. package/dist/esm/models/FilerFundSeries.js +169 -0
  35. package/dist/esm/models/FilerFundShareClass.d.ts +44 -0
  36. package/dist/esm/models/FilerFundShareClass.js +51 -0
  37. package/dist/esm/models/FilerPrivateOfferings.d.ts +62 -0
  38. package/dist/esm/models/FilerPrivateOfferings.js +63 -0
  39. package/dist/esm/models/FundHolding.d.ts +140 -0
  40. package/dist/esm/models/FundHolding.js +83 -0
  41. package/dist/esm/models/InsiderTrade.d.ts +101 -0
  42. package/dist/esm/models/InsiderTrade.js +71 -0
  43. package/dist/esm/models/InsiderTradeFootnote.d.ts +38 -0
  44. package/dist/esm/models/InsiderTradeFootnote.js +47 -0
  45. package/dist/esm/models/ListFundHoldings200Response.d.ts +52 -0
  46. package/dist/esm/models/ListFundHoldings200Response.js +57 -0
  47. package/dist/esm/models/ListOfferings200Response.d.ts +52 -0
  48. package/dist/esm/models/ListOfferings200Response.js +57 -0
  49. package/dist/esm/models/ListOfferings200ResponseMeta.d.ts +39 -0
  50. package/dist/esm/models/ListOfferings200ResponseMeta.js +44 -0
  51. package/dist/esm/models/Offering.d.ts +275 -0
  52. package/dist/esm/models/Offering.js +209 -0
  53. package/dist/esm/models/OfferingRelatedPerson.d.ts +44 -0
  54. package/dist/esm/models/OfferingRelatedPerson.js +51 -0
  55. package/dist/esm/models/index.d.ts +13 -0
  56. package/dist/esm/models/index.js +13 -0
  57. package/dist/models/Company.d.ts +1 -1
  58. package/dist/models/Event.d.ts +2 -1
  59. package/dist/models/Event.js +2 -1
  60. package/dist/models/EventCalendarCall.d.ts +2 -1
  61. package/dist/models/EventCalendarCall.js +1 -0
  62. package/dist/models/Filer.d.ts +6 -0
  63. package/dist/models/Filer.js +2 -0
  64. package/dist/models/FilerDetail.d.ts +14 -0
  65. package/dist/models/FilerDetail.js +6 -0
  66. package/dist/models/FilerFund.d.ts +45 -0
  67. package/dist/models/FilerFund.js +59 -0
  68. package/dist/models/FilerFundAdviser.d.ts +56 -0
  69. package/dist/models/FilerFundAdviser.js +66 -0
  70. package/dist/models/FilerFundReturn.d.ts +62 -0
  71. package/dist/models/FilerFundReturn.js +70 -0
  72. package/dist/models/FilerFundSeries.d.ts +217 -0
  73. package/dist/models/FilerFundSeries.js +177 -0
  74. package/dist/models/FilerFundShareClass.d.ts +44 -0
  75. package/dist/models/FilerFundShareClass.js +58 -0
  76. package/dist/models/FilerPrivateOfferings.d.ts +62 -0
  77. package/dist/models/FilerPrivateOfferings.js +70 -0
  78. package/dist/models/FundHolding.d.ts +140 -0
  79. package/dist/models/FundHolding.js +90 -0
  80. package/dist/models/InsiderTrade.d.ts +101 -0
  81. package/dist/models/InsiderTrade.js +72 -1
  82. package/dist/models/InsiderTradeFootnote.d.ts +38 -0
  83. package/dist/models/InsiderTradeFootnote.js +54 -0
  84. package/dist/models/ListFundHoldings200Response.d.ts +52 -0
  85. package/dist/models/ListFundHoldings200Response.js +64 -0
  86. package/dist/models/ListOfferings200Response.d.ts +52 -0
  87. package/dist/models/ListOfferings200Response.js +64 -0
  88. package/dist/models/ListOfferings200ResponseMeta.d.ts +39 -0
  89. package/dist/models/ListOfferings200ResponseMeta.js +51 -0
  90. package/dist/models/Offering.d.ts +275 -0
  91. package/dist/models/Offering.js +217 -0
  92. package/dist/models/OfferingRelatedPerson.d.ts +44 -0
  93. package/dist/models/OfferingRelatedPerson.js +58 -0
  94. package/dist/models/index.d.ts +13 -0
  95. package/dist/models/index.js +13 -0
  96. package/docs/CompaniesApi.md +2 -2
  97. package/docs/EventsApi.md +1 -1
  98. package/docs/Filer.md +2 -0
  99. package/docs/FilerDetail.md +4 -0
  100. package/docs/FilerFund.md +39 -0
  101. package/docs/FilerFundAdviser.md +43 -0
  102. package/docs/FilerFundReturn.md +45 -0
  103. package/docs/FilerFundSeries.md +93 -0
  104. package/docs/FilerFundShareClass.md +39 -0
  105. package/docs/FilerPrivateOfferings.md +45 -0
  106. package/docs/FundHolding.md +70 -0
  107. package/docs/HoldingsApi.md +105 -0
  108. package/docs/IPOsApi.md +195 -0
  109. package/docs/InsiderTrade.md +28 -0
  110. package/docs/InsiderTradeFootnote.md +37 -0
  111. package/docs/InsiderTradesApi.md +10 -1
  112. package/docs/ListFundHoldings200Response.md +41 -0
  113. package/docs/ListOfferings200Response.md +41 -0
  114. package/docs/ListOfferings200ResponseMeta.md +37 -0
  115. package/docs/Offering.md +111 -0
  116. package/docs/OfferingRelatedPerson.md +39 -0
  117. package/package.json +1 -1
  118. package/src/apis/EventsApi.ts +2 -2
  119. package/src/apis/HoldingsApi.ts +107 -0
  120. package/src/apis/IPOsApi.ts +186 -0
  121. package/src/apis/InsiderTradesApi.ts +15 -0
  122. package/src/models/Company.ts +1 -1
  123. package/src/models/Event.ts +3 -2
  124. package/src/models/EventCalendarCall.ts +2 -1
  125. package/src/models/Filer.ts +8 -0
  126. package/src/models/FilerDetail.ts +30 -0
  127. package/src/models/FilerFund.ts +92 -0
  128. package/src/models/FilerFundAdviser.ts +102 -0
  129. package/src/models/FilerFundReturn.ts +111 -0
  130. package/src/models/FilerFundSeries.ts +360 -0
  131. package/src/models/FilerFundShareClass.ts +84 -0
  132. package/src/models/FilerPrivateOfferings.ts +111 -0
  133. package/src/models/FundHolding.ts +212 -0
  134. package/src/models/InsiderTrade.ts +152 -0
  135. package/src/models/InsiderTradeFootnote.ts +75 -0
  136. package/src/models/ListFundHoldings200Response.ts +108 -0
  137. package/src/models/ListOfferings200Response.ts +108 -0
  138. package/src/models/ListOfferings200ResponseMeta.ts +81 -0
  139. package/src/models/Offering.ts +433 -0
  140. package/src/models/OfferingRelatedPerson.ts +84 -0
  141. package/src/models/index.ts +13 -0
@@ -23,6 +23,16 @@ import {
23
23
  ListIpos200ResponseFromJSON,
24
24
  ListIpos200ResponseToJSON,
25
25
  } from '../models/ListIpos200Response';
26
+ import {
27
+ type ListOfferings200Response,
28
+ ListOfferings200ResponseFromJSON,
29
+ ListOfferings200ResponseToJSON,
30
+ } from '../models/ListOfferings200Response';
31
+ import {
32
+ type Offering,
33
+ OfferingFromJSON,
34
+ OfferingToJSON,
35
+ } from '../models/Offering';
26
36
  import {
27
37
  type Problem,
28
38
  ProblemFromJSON,
@@ -34,6 +44,11 @@ export interface GetIpoRequest {
34
44
  fields?: string;
35
45
  }
36
46
 
47
+ export interface GetOfferingRequest {
48
+ offeringId: string;
49
+ fields?: string;
50
+ }
51
+
37
52
  export interface ListIposRequest {
38
53
  stage?: string;
39
54
  isSpac?: boolean;
@@ -48,6 +63,20 @@ export interface ListIposRequest {
48
63
  cursor?: string;
49
64
  }
50
65
 
66
+ export interface ListOfferingsRequest {
67
+ company?: string;
68
+ filedAtGte?: Date;
69
+ filedAtLte?: Date;
70
+ exemption?: string;
71
+ industry?: string;
72
+ totalSoldGte?: number;
73
+ isAmendment?: boolean;
74
+ sort?: ListOfferingsSortEnum;
75
+ fields?: string;
76
+ limit?: number;
77
+ cursor?: string;
78
+ }
79
+
51
80
  /**
52
81
  *
53
82
  */
@@ -112,6 +141,65 @@ export class IPOsApi extends runtime.BaseAPI {
112
141
  return await response.value();
113
142
  }
114
143
 
144
+ /**
145
+ * Creates request options for getOffering without sending the request
146
+ */
147
+ async getOfferingRequestOpts(requestParameters: GetOfferingRequest): Promise<runtime.RequestOpts> {
148
+ if (requestParameters['offeringId'] == null) {
149
+ throw new runtime.RequiredError(
150
+ 'offeringId',
151
+ 'Required parameter "offeringId" was null or undefined when calling getOffering().'
152
+ );
153
+ }
154
+
155
+ const queryParameters: any = {};
156
+
157
+ if (requestParameters['fields'] != null) {
158
+ queryParameters['fields'] = requestParameters['fields'];
159
+ }
160
+
161
+ const headerParameters: runtime.HTTPHeaders = {};
162
+
163
+ if (this.configuration && this.configuration.accessToken) {
164
+ const token = this.configuration.accessToken;
165
+ const tokenString = await token("bearerAuth", []);
166
+
167
+ if (tokenString) {
168
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
169
+ }
170
+ }
171
+
172
+ let urlPath = `/v1/offerings/{offering_id}`;
173
+ urlPath = urlPath.replace('{offering_id}', encodeURIComponent(String(requestParameters['offeringId'])));
174
+
175
+ return {
176
+ path: urlPath,
177
+ method: 'GET',
178
+ headers: headerParameters,
179
+ query: queryParameters,
180
+ };
181
+ }
182
+
183
+ /**
184
+ * One Form D private offering by its id (the Form D file number, e.g. `021-528681`), with the latest filing\'s facts and the held filing history; an unknown id answers 404. Form D is research data, not limited to listed companies: `company=` answers any Form D issuer CIK (funds, private companies; a ticker resolves only for a listed company), and the list is not gated by the coverage of the financial families.
185
+ * Get a Form D private offering
186
+ */
187
+ async getOfferingRaw(requestParameters: GetOfferingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Offering>> {
188
+ const requestOptions = await this.getOfferingRequestOpts(requestParameters);
189
+ const response = await this.request(requestOptions, initOverrides);
190
+
191
+ return new runtime.JSONApiResponse(response, (jsonValue) => OfferingFromJSON(jsonValue));
192
+ }
193
+
194
+ /**
195
+ * One Form D private offering by its id (the Form D file number, e.g. `021-528681`), with the latest filing\'s facts and the held filing history; an unknown id answers 404. Form D is research data, not limited to listed companies: `company=` answers any Form D issuer CIK (funds, private companies; a ticker resolves only for a listed company), and the list is not gated by the coverage of the financial families.
196
+ * Get a Form D private offering
197
+ */
198
+ async getOffering(requestParameters: GetOfferingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Offering> {
199
+ const response = await this.getOfferingRaw(requestParameters, initOverrides);
200
+ return await response.value();
201
+ }
202
+
115
203
  /**
116
204
  * Creates request options for listIpos without sending the request
117
205
  */
@@ -203,6 +291,97 @@ export class IPOsApi extends runtime.BaseAPI {
203
291
  return await response.value();
204
292
  }
205
293
 
294
+ /**
295
+ * Creates request options for listOfferings without sending the request
296
+ */
297
+ async listOfferingsRequestOpts(requestParameters: ListOfferingsRequest): Promise<runtime.RequestOpts> {
298
+ const queryParameters: any = {};
299
+
300
+ if (requestParameters['company'] != null) {
301
+ queryParameters['company'] = requestParameters['company'];
302
+ }
303
+
304
+ if (requestParameters['filedAtGte'] != null) {
305
+ queryParameters['filed_at.gte'] = (requestParameters['filedAtGte'] as any).toISOString().substring(0,10);
306
+ }
307
+
308
+ if (requestParameters['filedAtLte'] != null) {
309
+ queryParameters['filed_at.lte'] = (requestParameters['filedAtLte'] as any).toISOString().substring(0,10);
310
+ }
311
+
312
+ if (requestParameters['exemption'] != null) {
313
+ queryParameters['exemption'] = requestParameters['exemption'];
314
+ }
315
+
316
+ if (requestParameters['industry'] != null) {
317
+ queryParameters['industry'] = requestParameters['industry'];
318
+ }
319
+
320
+ if (requestParameters['totalSoldGte'] != null) {
321
+ queryParameters['total_sold.gte'] = requestParameters['totalSoldGte'];
322
+ }
323
+
324
+ if (requestParameters['isAmendment'] != null) {
325
+ queryParameters['is_amendment'] = requestParameters['isAmendment'];
326
+ }
327
+
328
+ if (requestParameters['sort'] != null) {
329
+ queryParameters['sort'] = requestParameters['sort'];
330
+ }
331
+
332
+ if (requestParameters['fields'] != null) {
333
+ queryParameters['fields'] = requestParameters['fields'];
334
+ }
335
+
336
+ if (requestParameters['limit'] != null) {
337
+ queryParameters['limit'] = requestParameters['limit'];
338
+ }
339
+
340
+ if (requestParameters['cursor'] != null) {
341
+ queryParameters['cursor'] = requestParameters['cursor'];
342
+ }
343
+
344
+ const headerParameters: runtime.HTTPHeaders = {};
345
+
346
+ if (this.configuration && this.configuration.accessToken) {
347
+ const token = this.configuration.accessToken;
348
+ const tokenString = await token("bearerAuth", []);
349
+
350
+ if (tokenString) {
351
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
352
+ }
353
+ }
354
+
355
+ let urlPath = `/v1/offerings`;
356
+
357
+ return {
358
+ path: urlPath,
359
+ method: 'GET',
360
+ headers: headerParameters,
361
+ query: queryParameters,
362
+ };
363
+ }
364
+
365
+ /**
366
+ * Form D private offerings (Regulation D and Section 4(a)(5) exempt offerings) from the SEC\'s quarterly Form D data sets, five years held: one row per offering (SEC\'s Form D file number; every amendment folds into it) with the latest filing\'s facts — issuer and co-issuers, exemptions as filed, industry group, security types, offering / sold / remaining amounts (USD), investors, related persons — and the held filing history. Filters: `company=` (one issuer CIK or listed ticker), `filed_at.gte|lte` (latest filing date), `exemption=`, `industry=`, `total_sold.gte`, `is_amendment`. Order: latest filing date descending, then offering id. An issuer CIK the SEC registry and the data set do not know answers 404; a known issuer without offerings an empty page. Form D is research data, not limited to listed companies: `company=` answers any Form D issuer CIK (funds, private companies; a ticker resolves only for a listed company), and the list is not gated by the coverage of the financial families.
367
+ * List Form D private offerings
368
+ */
369
+ async listOfferingsRaw(requestParameters: ListOfferingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListOfferings200Response>> {
370
+ const requestOptions = await this.listOfferingsRequestOpts(requestParameters);
371
+ const response = await this.request(requestOptions, initOverrides);
372
+
373
+ return new runtime.JSONApiResponse(response, (jsonValue) => ListOfferings200ResponseFromJSON(jsonValue));
374
+ }
375
+
376
+ /**
377
+ * Form D private offerings (Regulation D and Section 4(a)(5) exempt offerings) from the SEC\'s quarterly Form D data sets, five years held: one row per offering (SEC\'s Form D file number; every amendment folds into it) with the latest filing\'s facts — issuer and co-issuers, exemptions as filed, industry group, security types, offering / sold / remaining amounts (USD), investors, related persons — and the held filing history. Filters: `company=` (one issuer CIK or listed ticker), `filed_at.gte|lte` (latest filing date), `exemption=`, `industry=`, `total_sold.gte`, `is_amendment`. Order: latest filing date descending, then offering id. An issuer CIK the SEC registry and the data set do not know answers 404; a known issuer without offerings an empty page. Form D is research data, not limited to listed companies: `company=` answers any Form D issuer CIK (funds, private companies; a ticker resolves only for a listed company), and the list is not gated by the coverage of the financial families.
378
+ * List Form D private offerings
379
+ */
380
+ async listOfferings(requestParameters: ListOfferingsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListOfferings200Response> {
381
+ const response = await this.listOfferingsRaw(requestParameters, initOverrides);
382
+ return await response.value();
383
+ }
384
+
206
385
  }
207
386
 
208
387
  /**
@@ -215,3 +394,10 @@ export const ListIposSortEnum = {
215
394
  FirstPublicAt2: '-first_public_at'
216
395
  } as const;
217
396
  export type ListIposSortEnum = typeof ListIposSortEnum[keyof typeof ListIposSortEnum];
397
+ /**
398
+ * @export
399
+ */
400
+ export const ListOfferingsSortEnum = {
401
+ FiledLatest: '-filed_latest'
402
+ } as const;
403
+ export type ListOfferingsSortEnum = typeof ListOfferingsSortEnum[keyof typeof ListOfferingsSortEnum];
@@ -41,6 +41,9 @@ export interface ListInsiderTradesRequest {
41
41
  filedAtGt?: Date;
42
42
  filedAtLte?: Date;
43
43
  filedAtLt?: Date;
44
+ transactionDateGte?: Date;
45
+ transactionDateLte?: Date;
46
+ isDerivative?: boolean;
44
47
  sort?: ListInsiderTradesSortEnum;
45
48
  fields?: string;
46
49
  limit?: number;
@@ -148,6 +151,18 @@ export class InsiderTradesApi extends runtime.BaseAPI {
148
151
  queryParameters['filed_at.lt'] = (requestParameters['filedAtLt'] as any).toISOString().substring(0,10);
149
152
  }
150
153
 
154
+ if (requestParameters['transactionDateGte'] != null) {
155
+ queryParameters['transaction_date.gte'] = (requestParameters['transactionDateGte'] as any).toISOString().substring(0,10);
156
+ }
157
+
158
+ if (requestParameters['transactionDateLte'] != null) {
159
+ queryParameters['transaction_date.lte'] = (requestParameters['transactionDateLte'] as any).toISOString().substring(0,10);
160
+ }
161
+
162
+ if (requestParameters['isDerivative'] != null) {
163
+ queryParameters['is_derivative'] = requestParameters['isDerivative'];
164
+ }
165
+
151
166
  if (requestParameters['sort'] != null) {
152
167
  queryParameters['sort'] = requestParameters['sort'];
153
168
  }
@@ -130,7 +130,7 @@ export interface Company {
130
130
  */
131
131
  employees: number | null;
132
132
  /**
133
- * Market capitalization; null for ETFs (no AUM source)
133
+ * Market capitalization; for an ETF: fund net assets from its latest public N-PORT report (single-class funds only), else null
134
134
  * @type {number}
135
135
  * @memberof Company
136
136
  */
@@ -218,7 +218,7 @@ export interface Event {
218
218
  */
219
219
  has_documents: boolean;
220
220
  /**
221
- * Webcast page of an upcoming dated call; null once published
221
+ * Webcast page of an upcoming dated call; null once published and for a `not_covered` call (`calendar.call.status`)
222
222
  * @type {string}
223
223
  * @memberof Event
224
224
  */
@@ -313,7 +313,8 @@ export const EventExpiredReasonEnum = {
313
313
  SupersededEstimate: 'superseded_estimate',
314
314
  AgentDifferentDate: 'agent_different_date',
315
315
  AgentNoWebcast: 'agent_no_webcast',
316
- SupersededByReschedule: 'superseded_by_reschedule'
316
+ SupersededByReschedule: 'superseded_by_reschedule',
317
+ ResultsWithoutCall: 'results_without_call'
317
318
  } as const;
318
319
  export type EventExpiredReasonEnum = typeof EventExpiredReasonEnum[keyof typeof EventExpiredReasonEnum] | (string & {});
319
320
 
@@ -28,7 +28,7 @@ import {
28
28
  */
29
29
  export interface EventCalendarCall {
30
30
  /**
31
- * Call status: the event statuses without reported, plus held, no_call, expired, not_expected (a non-call issuer)
31
+ * Call status: the event statuses without reported, plus held, no_call, expired, not_expected (a non-call issuer), not_covered (a reported quarter of a call issuer that our coverage never saw: the call was likely held, we have no record). Clients must accept unknown enum values.
32
32
  * @type {EventCalendarCallStatusEnum}
33
33
  * @memberof EventCalendarCall
34
34
  */
@@ -76,6 +76,7 @@ export const EventCalendarCallStatusEnum = {
76
76
  NoCall: 'no_call',
77
77
  Expired: 'expired',
78
78
  NotExpected: 'not_expected',
79
+ NotCovered: 'not_covered',
79
80
  Confirmed: 'confirmed',
80
81
  Announced: 'announced',
81
82
  Estimated: 'estimated'
@@ -75,6 +75,12 @@ export interface Filer {
75
75
  * @memberof Filer
76
76
  */
77
77
  listing: FilerListing | null;
78
+ /**
79
+ * Number of Form D private offerings naming the filer (`phase=pre_ipo` lists); null on other lists and while Form D data is not served (optional: answers captured before release 5.7 lack it)
80
+ * @type {number}
81
+ * @memberof Filer
82
+ */
83
+ private_offerings_count?: number | null;
78
84
  }
79
85
 
80
86
 
@@ -124,6 +130,7 @@ export function FilerFromJSONTyped(json: any, ignoreDiscriminator: boolean): Fil
124
130
  'forms': json['forms'],
125
131
  'stated_tickers': json['stated_tickers'],
126
132
  'listing': FilerListingFromJSON(json['listing']),
133
+ 'private_offerings_count': json['private_offerings_count'] == null ? undefined : json['private_offerings_count'],
127
134
  };
128
135
  }
129
136
 
@@ -146,6 +153,7 @@ export function FilerToJSONTyped(value?: Filer | null, ignoreDiscriminator: bool
146
153
  'forms': value['forms'],
147
154
  'stated_tickers': value['stated_tickers'],
148
155
  'listing': FilerListingToJSON(value['listing']),
156
+ 'private_offerings_count': value['private_offerings_count'],
149
157
  };
150
158
  }
151
159
 
@@ -41,6 +41,20 @@ import {
41
41
  FilerListingToJSON,
42
42
  FilerListingToJSONTyped,
43
43
  } from './FilerListing';
44
+ import type { FilerPrivateOfferings } from './FilerPrivateOfferings';
45
+ import {
46
+ FilerPrivateOfferingsFromJSON,
47
+ FilerPrivateOfferingsFromJSONTyped,
48
+ FilerPrivateOfferingsToJSON,
49
+ FilerPrivateOfferingsToJSONTyped,
50
+ } from './FilerPrivateOfferings';
51
+ import type { FilerFund } from './FilerFund';
52
+ import {
53
+ FilerFundFromJSON,
54
+ FilerFundFromJSONTyped,
55
+ FilerFundToJSON,
56
+ FilerFundToJSONTyped,
57
+ } from './FilerFund';
44
58
 
45
59
  /**
46
60
  * One SEC filer's registry identity
@@ -120,6 +134,18 @@ export interface FilerDetail {
120
134
  * @memberof FilerDetail
121
135
  */
122
136
  successors?: Array<FilerDetailSuccessorsInner> | null;
137
+ /**
138
+ * With `expand=fund`: the registered investment company's fund series (SEC N-CEN census, risk/return prospectus data, N-PORT net assets); null for a filer without fund series and while fund data is not served
139
+ * @type {FilerFund}
140
+ * @memberof FilerDetail
141
+ */
142
+ fund?: FilerFund | null;
143
+ /**
144
+ * With `expand=private_offerings`: summary of the filer's Form D private offerings (GET /v1/offerings?company=); null for a filer without Form D offerings and while Form D data is not served. Only for filers the SEC registry knows
145
+ * @type {FilerPrivateOfferings}
146
+ * @memberof FilerDetail
147
+ */
148
+ private_offerings?: FilerPrivateOfferings | null;
123
149
  }
124
150
 
125
151
 
@@ -173,6 +199,8 @@ export function FilerDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean
173
199
  'proposed_symbols': json['proposed_symbols'] == null ? undefined : ((json['proposed_symbols'] as Array<any>).map(ProposedTickerFromJSON)),
174
200
  'former_names': json['former_names'] == null ? undefined : ((json['former_names'] as Array<any>).map(FilerDetailFormerNamesInnerFromJSON)),
175
201
  'successors': json['successors'] == null ? undefined : ((json['successors'] as Array<any>).map(FilerDetailSuccessorsInnerFromJSON)),
202
+ 'fund': json['fund'] == null ? undefined : FilerFundFromJSON(json['fund']),
203
+ 'private_offerings': json['private_offerings'] == null ? undefined : FilerPrivateOfferingsFromJSON(json['private_offerings']),
176
204
  };
177
205
  }
178
206
 
@@ -199,6 +227,8 @@ export function FilerDetailToJSONTyped(value?: FilerDetail | null, ignoreDiscrim
199
227
  'proposed_symbols': value['proposed_symbols'] == null ? undefined : ((value['proposed_symbols'] as Array<any>).map(ProposedTickerToJSON)),
200
228
  'former_names': value['former_names'] == null ? undefined : ((value['former_names'] as Array<any>).map(FilerDetailFormerNamesInnerToJSON)),
201
229
  'successors': value['successors'] == null ? undefined : ((value['successors'] as Array<any>).map(FilerDetailSuccessorsInnerToJSON)),
230
+ 'fund': FilerFundToJSON(value['fund']),
231
+ 'private_offerings': FilerPrivateOfferingsToJSON(value['private_offerings']),
202
232
  };
203
233
  }
204
234
 
@@ -0,0 +1,92 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Invinite API
5
+ * Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks 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-13
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ import type { FilerFundSeries } from './FilerFundSeries';
17
+ import {
18
+ FilerFundSeriesFromJSON,
19
+ FilerFundSeriesFromJSONTyped,
20
+ FilerFundSeriesToJSON,
21
+ FilerFundSeriesToJSONTyped,
22
+ } from './FilerFundSeries';
23
+
24
+ /**
25
+ * A registered investment company's fund series (SEC N-CEN, risk/return prospectus data, N-PORT)
26
+ * @export
27
+ * @interface FilerFund
28
+ */
29
+ export interface FilerFund {
30
+ /**
31
+ * Registration form of the investment company: N-1A (open-end fund, ETF) or N-2 (closed-end fund); null when mixed or unknown
32
+ * @type {string}
33
+ * @memberof FilerFund
34
+ */
35
+ investment_company_type: string | null;
36
+ /**
37
+ * Number of fund series
38
+ * @type {number}
39
+ * @memberof FilerFund
40
+ */
41
+ series_count: number;
42
+ /**
43
+ * The fund series
44
+ * @type {Array<FilerFundSeries>}
45
+ * @memberof FilerFund
46
+ */
47
+ series: Array<FilerFundSeries>;
48
+ }
49
+
50
+ /**
51
+ * Check if a given object implements the FilerFund interface.
52
+ */
53
+ export function instanceOfFilerFund(value: object): value is FilerFund {
54
+ if (!('investment_company_type' in value) || value['investment_company_type'] === undefined) return false;
55
+ if (!('series_count' in value) || value['series_count'] === undefined) return false;
56
+ if (!('series' in value) || value['series'] === undefined) return false;
57
+ return true;
58
+ }
59
+
60
+ export function FilerFundFromJSON(json: any): FilerFund {
61
+ return FilerFundFromJSONTyped(json, false);
62
+ }
63
+
64
+ export function FilerFundFromJSONTyped(json: any, ignoreDiscriminator: boolean): FilerFund {
65
+ if (json == null) {
66
+ return json;
67
+ }
68
+ return {
69
+
70
+ 'investment_company_type': json['investment_company_type'],
71
+ 'series_count': json['series_count'],
72
+ 'series': ((json['series'] as Array<any>).map(FilerFundSeriesFromJSON)),
73
+ };
74
+ }
75
+
76
+ export function FilerFundToJSON(json: any): FilerFund {
77
+ return FilerFundToJSONTyped(json, false);
78
+ }
79
+
80
+ export function FilerFundToJSONTyped(value?: FilerFund | null, ignoreDiscriminator: boolean = false): any {
81
+ if (value == null) {
82
+ return value;
83
+ }
84
+
85
+ return {
86
+
87
+ 'investment_company_type': value['investment_company_type'],
88
+ 'series_count': value['series_count'],
89
+ 'series': ((value['series'] as Array<any>).map(FilerFundSeriesToJSON)),
90
+ };
91
+ }
92
+
@@ -0,0 +1,102 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Invinite API
5
+ * Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks 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-13
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ /**
17
+ * One investment adviser of a fund series (N-CEN)
18
+ * @export
19
+ * @interface FilerFundAdviser
20
+ */
21
+ export interface FilerFundAdviser {
22
+ /**
23
+ * Adviser name as reported
24
+ * @type {string}
25
+ * @memberof FilerFundAdviser
26
+ */
27
+ name: string | null;
28
+ /**
29
+ * Adviser CRD number
30
+ * @type {string}
31
+ * @memberof FilerFundAdviser
32
+ */
33
+ crd: string | null;
34
+ /**
35
+ * Adviser LEI
36
+ * @type {string}
37
+ * @memberof FilerFundAdviser
38
+ */
39
+ lei: string | null;
40
+ /**
41
+ * Whether the adviser is an affiliated person of the fund
42
+ * @type {boolean}
43
+ * @memberof FilerFundAdviser
44
+ */
45
+ is_affiliated: boolean | null;
46
+ /**
47
+ * Adviser role as reported: Advisor, Subadvisor, Terminated Advisor, …
48
+ * @type {string}
49
+ * @memberof FilerFundAdviser
50
+ */
51
+ role: string | null;
52
+ }
53
+
54
+ /**
55
+ * Check if a given object implements the FilerFundAdviser interface.
56
+ */
57
+ export function instanceOfFilerFundAdviser(value: object): value is FilerFundAdviser {
58
+ if (!('name' in value) || value['name'] === undefined) return false;
59
+ if (!('crd' in value) || value['crd'] === undefined) return false;
60
+ if (!('lei' in value) || value['lei'] === undefined) return false;
61
+ if (!('is_affiliated' in value) || value['is_affiliated'] === undefined) return false;
62
+ if (!('role' in value) || value['role'] === undefined) return false;
63
+ return true;
64
+ }
65
+
66
+ export function FilerFundAdviserFromJSON(json: any): FilerFundAdviser {
67
+ return FilerFundAdviserFromJSONTyped(json, false);
68
+ }
69
+
70
+ export function FilerFundAdviserFromJSONTyped(json: any, ignoreDiscriminator: boolean): FilerFundAdviser {
71
+ if (json == null) {
72
+ return json;
73
+ }
74
+ return {
75
+
76
+ 'name': json['name'],
77
+ 'crd': json['crd'],
78
+ 'lei': json['lei'],
79
+ 'is_affiliated': json['is_affiliated'],
80
+ 'role': json['role'],
81
+ };
82
+ }
83
+
84
+ export function FilerFundAdviserToJSON(json: any): FilerFundAdviser {
85
+ return FilerFundAdviserToJSONTyped(json, false);
86
+ }
87
+
88
+ export function FilerFundAdviserToJSONTyped(value?: FilerFundAdviser | null, ignoreDiscriminator: boolean = false): any {
89
+ if (value == null) {
90
+ return value;
91
+ }
92
+
93
+ return {
94
+
95
+ 'name': value['name'],
96
+ 'crd': value['crd'],
97
+ 'lei': value['lei'],
98
+ 'is_affiliated': value['is_affiliated'],
99
+ 'role': value['role'],
100
+ };
101
+ }
102
+