@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
@@ -94,7 +94,7 @@ example().catch(console.error);
94
94
 
95
95
  ## listInsiderTrades
96
96
 
97
- > ListInsiderTrades200Response listInsiderTrades(company, side, filedAtGte, filedAtGt, filedAtLte, filedAtLt, sort, fields, limit, cursor)
97
+ > ListInsiderTrades200Response listInsiderTrades(company, side, filedAtGte, filedAtGt, filedAtLte, filedAtLt, transactionDateGte, transactionDateLte, isDerivative, sort, fields, limit, cursor)
98
98
 
99
99
  List insider trades
100
100
 
@@ -130,6 +130,12 @@ async function example() {
130
130
  filedAtLte: 2025-01-01,
131
131
  // Date | `filed_at` before this value (optional)
132
132
  filedAtLt: 2025-01-01,
133
+ // Date | `transaction_date` on or after this value (rows without a transaction date are excluded) (optional)
134
+ transactionDateGte: 2025-01-01,
135
+ // Date | `transaction_date` on or before this value (rows without a transaction date are excluded) (optional)
136
+ transactionDateLte: 2025-01-01,
137
+ // boolean | true = only derivative-security lines; false = only non-derivative lines (optional)
138
+ isDerivative: false,
133
139
  // 'filed_at' | '-filed_at' | Sort field (`-` = descending); the id tiebreaker is always appended. Default `-filed_at` (optional)
134
140
  sort: -filed_at,
135
141
  // string | Comma list of root-level fields to keep (R7) (optional)
@@ -163,6 +169,9 @@ example().catch(console.error);
163
169
  | **filedAtGt** | `Date` | `filed_at` after this value | [Optional] [Defaults to `undefined`] |
164
170
  | **filedAtLte** | `Date` | `filed_at` on or before this value | [Optional] [Defaults to `undefined`] |
165
171
  | **filedAtLt** | `Date` | `filed_at` before this value | [Optional] [Defaults to `undefined`] |
172
+ | **transactionDateGte** | `Date` | `transaction_date` on or after this value (rows without a transaction date are excluded) | [Optional] [Defaults to `undefined`] |
173
+ | **transactionDateLte** | `Date` | `transaction_date` on or before this value (rows without a transaction date are excluded) | [Optional] [Defaults to `undefined`] |
174
+ | **isDerivative** | `boolean` | true = only derivative-security lines; false = only non-derivative lines | [Optional] [Defaults to `undefined`] |
166
175
  | **sort** | `filed_at`, `-filed_at` | Sort field (`-` = descending); the id tiebreaker is always appended. Default `-filed_at` | [Optional] [Defaults to `'-filed_at'`] [Enum: filed_at, -filed_at] |
167
176
  | **fields** | `string` | Comma list of root-level fields to keep (R7) | [Optional] [Defaults to `undefined`] |
168
177
  | **limit** | `number` | Rows per page (default 25, max 200) | [Optional] [Defaults to `25`] |
@@ -0,0 +1,41 @@
1
+
2
+ # ListFundHoldings200Response
3
+
4
+ A page of FundHolding rows (the list envelope, R3)
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `data` | [Array<FundHolding>](FundHolding.md)
11
+ `has_more` | boolean
12
+ `next_cursor` | string
13
+ `meta` | [ListHoldings200ResponseMeta](ListHoldings200ResponseMeta.md)
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import type { ListFundHoldings200Response } from '@invinite-org/data-api-client'
19
+
20
+ // TODO: Update the object below with actual values
21
+ const example = {
22
+ "data": null,
23
+ "has_more": null,
24
+ "next_cursor": null,
25
+ "meta": null,
26
+ } satisfies ListFundHoldings200Response
27
+
28
+ console.log(example)
29
+
30
+ // Convert the instance to a JSON string
31
+ const exampleJSON: string = JSON.stringify(example)
32
+ console.log(exampleJSON)
33
+
34
+ // Parse the JSON string back to an object
35
+ const exampleParsed = JSON.parse(exampleJSON) as ListFundHoldings200Response
36
+ console.log(exampleParsed)
37
+ ```
38
+
39
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
40
+
41
+
@@ -0,0 +1,41 @@
1
+
2
+ # ListOfferings200Response
3
+
4
+ A page of Offering rows (the list envelope, R3)
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `data` | [Array<Offering>](Offering.md)
11
+ `has_more` | boolean
12
+ `next_cursor` | string
13
+ `meta` | [ListOfferings200ResponseMeta](ListOfferings200ResponseMeta.md)
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import type { ListOfferings200Response } from '@invinite-org/data-api-client'
19
+
20
+ // TODO: Update the object below with actual values
21
+ const example = {
22
+ "data": null,
23
+ "has_more": null,
24
+ "next_cursor": null,
25
+ "meta": null,
26
+ } satisfies ListOfferings200Response
27
+
28
+ console.log(example)
29
+
30
+ // Convert the instance to a JSON string
31
+ const exampleJSON: string = JSON.stringify(example)
32
+ console.log(exampleJSON)
33
+
34
+ // Parse the JSON string back to an object
35
+ const exampleParsed = JSON.parse(exampleJSON) as ListOfferings200Response
36
+ console.log(exampleParsed)
37
+ ```
38
+
39
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
40
+
41
+
@@ -0,0 +1,37 @@
1
+
2
+ # ListOfferings200ResponseMeta
3
+
4
+ Page metadata
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `coverage` | [MetaCoverage](MetaCoverage.md)
11
+ `pinned_at` | Date
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import type { ListOfferings200ResponseMeta } from '@invinite-org/data-api-client'
17
+
18
+ // TODO: Update the object below with actual values
19
+ const example = {
20
+ "coverage": null,
21
+ "pinned_at": null,
22
+ } satisfies ListOfferings200ResponseMeta
23
+
24
+ console.log(example)
25
+
26
+ // Convert the instance to a JSON string
27
+ const exampleJSON: string = JSON.stringify(example)
28
+ console.log(exampleJSON)
29
+
30
+ // Parse the JSON string back to an object
31
+ const exampleParsed = JSON.parse(exampleJSON) as ListOfferings200ResponseMeta
32
+ console.log(exampleParsed)
33
+ ```
34
+
35
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
36
+
37
+
@@ -0,0 +1,111 @@
1
+
2
+ # Offering
3
+
4
+ One Form D private offering (Regulation D / Section 4(a)(5) exempt offering): the latest filing\'s facts and the held filing history
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `offering_id` | string
11
+ `file_number` | string
12
+ `first_accession` | string
13
+ `latest_accession` | string
14
+ `accessions` | Array<string>
15
+ `primary_issuer_cik` | string
16
+ `issuer_name` | string
17
+ `co_issuer_ciks` | Array<string>
18
+ `filed_first` | Date
19
+ `filed_latest` | Date
20
+ `sale_date` | Date
21
+ `first_sale_yet_to_occur` | boolean
22
+ `amendment_count` | number
23
+ `original_held` | boolean
24
+ `is_amendment` | boolean
25
+ `exemptions` | Array<string>
26
+ `industry_group` | string
27
+ `investment_fund_type` | string
28
+ `is_40_act` | boolean
29
+ `security_types` | Array<string>
30
+ `is_business_combination` | boolean
31
+ `more_than_one_year` | boolean
32
+ `min_investment` | number
33
+ `total_offering_amount` | number
34
+ `total_sold` | number
35
+ `total_remaining` | number
36
+ `indefinite_amount` | boolean
37
+ `has_non_accredited` | boolean
38
+ `non_accredited_count` | number
39
+ `investor_count` | number
40
+ `revenue_range` | string
41
+ `net_asset_value_range` | string
42
+ `sales_commission` | number
43
+ `finders_fee` | number
44
+ `related_persons` | [Array<OfferingRelatedPerson>](OfferingRelatedPerson.md)
45
+ `sic_code` | string
46
+ `jurisdiction` | string
47
+ `entity_type` | string
48
+ `year_of_inc` | string
49
+
50
+ ## Example
51
+
52
+ ```typescript
53
+ import type { Offering } from '@invinite-org/data-api-client'
54
+
55
+ // TODO: Update the object below with actual values
56
+ const example = {
57
+ "offering_id": 021-528681,
58
+ "file_number": null,
59
+ "first_accession": null,
60
+ "latest_accession": null,
61
+ "accessions": null,
62
+ "primary_issuer_cik": 0001991882,
63
+ "issuer_name": null,
64
+ "co_issuer_ciks": null,
65
+ "filed_first": null,
66
+ "filed_latest": null,
67
+ "sale_date": null,
68
+ "first_sale_yet_to_occur": null,
69
+ "amendment_count": null,
70
+ "original_held": null,
71
+ "is_amendment": null,
72
+ "exemptions": null,
73
+ "industry_group": null,
74
+ "investment_fund_type": null,
75
+ "is_40_act": null,
76
+ "security_types": null,
77
+ "is_business_combination": null,
78
+ "more_than_one_year": null,
79
+ "min_investment": null,
80
+ "total_offering_amount": null,
81
+ "total_sold": null,
82
+ "total_remaining": null,
83
+ "indefinite_amount": null,
84
+ "has_non_accredited": null,
85
+ "non_accredited_count": null,
86
+ "investor_count": null,
87
+ "revenue_range": null,
88
+ "net_asset_value_range": null,
89
+ "sales_commission": null,
90
+ "finders_fee": null,
91
+ "related_persons": null,
92
+ "sic_code": null,
93
+ "jurisdiction": null,
94
+ "entity_type": null,
95
+ "year_of_inc": null,
96
+ } satisfies Offering
97
+
98
+ console.log(example)
99
+
100
+ // Convert the instance to a JSON string
101
+ const exampleJSON: string = JSON.stringify(example)
102
+ console.log(exampleJSON)
103
+
104
+ // Parse the JSON string back to an object
105
+ const exampleParsed = JSON.parse(exampleJSON) as Offering
106
+ console.log(exampleParsed)
107
+ ```
108
+
109
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
110
+
111
+
@@ -0,0 +1,39 @@
1
+
2
+ # OfferingRelatedPerson
3
+
4
+ A related person of a Form D offering (executive officer, director, promoter) as filed
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `name` | string
11
+ `relationships` | Array<string>
12
+ `clarification` | string
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import type { OfferingRelatedPerson } from '@invinite-org/data-api-client'
18
+
19
+ // TODO: Update the object below with actual values
20
+ const example = {
21
+ "name": null,
22
+ "relationships": null,
23
+ "clarification": null,
24
+ } satisfies OfferingRelatedPerson
25
+
26
+ console.log(example)
27
+
28
+ // Convert the instance to a JSON string
29
+ const exampleJSON: string = JSON.stringify(example)
30
+ console.log(exampleJSON)
31
+
32
+ // Parse the JSON string back to an object
33
+ const exampleParsed = JSON.parse(exampleJSON) as OfferingRelatedPerson
34
+ console.log(exampleParsed)
35
+ ```
36
+
37
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
38
+
39
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@invinite-org/data-api-client",
3
- "version": "5.6.0",
3
+ "version": "5.9.0",
4
4
  "description": "Typed TypeScript/JavaScript client for the Invinite Data API",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -487,7 +487,7 @@ export class EventsApi extends runtime.BaseAPI {
487
487
  }
488
488
 
489
489
  /**
490
- * Events (earnings calls by default; `type=all` or a list opts into investor days, conferences, AGMs and other events), keyset-paged by `scheduled_at` with the event id as tiebreaker. With `company=` every date of that company is listed; without `company=` the list is a calendar: the `scheduled_at` window defaults to today through today + 14 days (New York calendar days) and may span at most 92 days (a wider window is a 400 `invalid_parameter`); `status=live` alone needs no window. Expired calendar rows (an estimate that never became a call, a duplicate, a non-call issuer) are omitted; `GET /v1/events/{event_id}` still serves them.
490
+ * Events (earnings calls by default; `type=all` or a list opts into investor days, conferences, AGMs and other events), keyset-paged by `scheduled_at` with the event id as tiebreaker. With `company=` every date of that company is listed; without `company=` the list is a calendar: the `scheduled_at` window defaults to today through today + 14 days (New York calendar days) and may span at most 92 days (a wider window is a 400 `invalid_parameter`); `status=live` alone needs no window. Expired calendar rows (an estimate that never became a call, a duplicate, a non-call issuer) are omitted, except one whose `expired_reason` is `results_without_call` (a reported quarter whose call never came); `GET /v1/events/{event_id}` still serves them. A reported quarter (`results_released_at` set) is listed even when its call date is only an estimate.
491
491
  * List events
492
492
  */
493
493
  async listEventsRaw(requestParameters: ListEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListEvents200Response>> {
@@ -498,7 +498,7 @@ export class EventsApi extends runtime.BaseAPI {
498
498
  }
499
499
 
500
500
  /**
501
- * Events (earnings calls by default; `type=all` or a list opts into investor days, conferences, AGMs and other events), keyset-paged by `scheduled_at` with the event id as tiebreaker. With `company=` every date of that company is listed; without `company=` the list is a calendar: the `scheduled_at` window defaults to today through today + 14 days (New York calendar days) and may span at most 92 days (a wider window is a 400 `invalid_parameter`); `status=live` alone needs no window. Expired calendar rows (an estimate that never became a call, a duplicate, a non-call issuer) are omitted; `GET /v1/events/{event_id}` still serves them.
501
+ * Events (earnings calls by default; `type=all` or a list opts into investor days, conferences, AGMs and other events), keyset-paged by `scheduled_at` with the event id as tiebreaker. With `company=` every date of that company is listed; without `company=` the list is a calendar: the `scheduled_at` window defaults to today through today + 14 days (New York calendar days) and may span at most 92 days (a wider window is a 400 `invalid_parameter`); `status=live` alone needs no window. Expired calendar rows (an estimate that never became a call, a duplicate, a non-call issuer) are omitted, except one whose `expired_reason` is `results_without_call` (a reported quarter whose call never came); `GET /v1/events/{event_id}` still serves them. A reported quarter (`results_released_at` set) is listed even when its call date is only an estimate.
502
502
  * List events
503
503
  */
504
504
  async listEvents(requestParameters: ListEventsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListEvents200Response> {
@@ -13,6 +13,11 @@
13
13
  */
14
14
 
15
15
  import * as runtime from '../runtime';
16
+ import {
17
+ type ListFundHoldings200Response,
18
+ ListFundHoldings200ResponseFromJSON,
19
+ ListFundHoldings200ResponseToJSON,
20
+ } from '../models/ListFundHoldings200Response';
16
21
  import {
17
22
  type ListHoldingChanges200Response,
18
23
  ListHoldingChanges200ResponseFromJSON,
@@ -29,6 +34,18 @@ import {
29
34
  ProblemToJSON,
30
35
  } from '../models/Problem';
31
36
 
37
+ export interface ListFundHoldingsRequest {
38
+ company?: string;
39
+ filer?: string;
40
+ series?: string;
41
+ accession?: string;
42
+ periodEnd?: Date;
43
+ sort?: ListFundHoldingsSortEnum;
44
+ fields?: string;
45
+ limit?: number;
46
+ cursor?: string;
47
+ }
48
+
32
49
  export interface ListHoldingChangesRequest {
33
50
  company?: string;
34
51
  filer?: string;
@@ -57,6 +74,89 @@ export interface ListHoldingsRequest {
57
74
  */
58
75
  export class HoldingsApi extends runtime.BaseAPI {
59
76
 
77
+ /**
78
+ * Creates request options for listFundHoldings without sending the request
79
+ */
80
+ async listFundHoldingsRequestOpts(requestParameters: ListFundHoldingsRequest): Promise<runtime.RequestOpts> {
81
+ const queryParameters: any = {};
82
+
83
+ if (requestParameters['company'] != null) {
84
+ queryParameters['company'] = requestParameters['company'];
85
+ }
86
+
87
+ if (requestParameters['filer'] != null) {
88
+ queryParameters['filer'] = requestParameters['filer'];
89
+ }
90
+
91
+ if (requestParameters['series'] != null) {
92
+ queryParameters['series'] = requestParameters['series'];
93
+ }
94
+
95
+ if (requestParameters['accession'] != null) {
96
+ queryParameters['accession'] = requestParameters['accession'];
97
+ }
98
+
99
+ if (requestParameters['periodEnd'] != null) {
100
+ queryParameters['period_end'] = (requestParameters['periodEnd'] as any).toISOString().substring(0,10);
101
+ }
102
+
103
+ if (requestParameters['sort'] != null) {
104
+ queryParameters['sort'] = requestParameters['sort'];
105
+ }
106
+
107
+ if (requestParameters['fields'] != null) {
108
+ queryParameters['fields'] = requestParameters['fields'];
109
+ }
110
+
111
+ if (requestParameters['limit'] != null) {
112
+ queryParameters['limit'] = requestParameters['limit'];
113
+ }
114
+
115
+ if (requestParameters['cursor'] != null) {
116
+ queryParameters['cursor'] = requestParameters['cursor'];
117
+ }
118
+
119
+ const headerParameters: runtime.HTTPHeaders = {};
120
+
121
+ if (this.configuration && this.configuration.accessToken) {
122
+ const token = this.configuration.accessToken;
123
+ const tokenString = await token("bearerAuth", []);
124
+
125
+ if (tokenString) {
126
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
127
+ }
128
+ }
129
+
130
+ let urlPath = `/v1/fund-holdings`;
131
+
132
+ return {
133
+ path: urlPath,
134
+ method: 'GET',
135
+ headers: headerParameters,
136
+ query: queryParameters,
137
+ };
138
+ }
139
+
140
+ /**
141
+ * N-PORT fund and ETF positions from the funds\' quarterly public reports (about 60 days after the report date): by issuer (`company=`, one row per fund holding it, from each fund\'s latest report on or before `period_end`, its positions in the issuer summed), by fund (`filer=` registrant CIK, `series=` when the registrant files for several funds: that fund\'s positions) or by filing (`accession=`, an NPORT-P filing\'s reported holdings as filed); exactly one of `company`, `filer` or `accession` (`series` alone needs `filer`). `period_end` defaults to today. Order: value in USD, descending (`company=`, `filer=`), the filing\'s line order (`accession=`); several companies are read one after another. A fund row is not a 13F `Holding` (different row type, R16): `/v1/holdings` keeps the 13F managers.
142
+ * List N-PORT fund holdings
143
+ */
144
+ async listFundHoldingsRaw(requestParameters: ListFundHoldingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListFundHoldings200Response>> {
145
+ const requestOptions = await this.listFundHoldingsRequestOpts(requestParameters);
146
+ const response = await this.request(requestOptions, initOverrides);
147
+
148
+ return new runtime.JSONApiResponse(response, (jsonValue) => ListFundHoldings200ResponseFromJSON(jsonValue));
149
+ }
150
+
151
+ /**
152
+ * N-PORT fund and ETF positions from the funds\' quarterly public reports (about 60 days after the report date): by issuer (`company=`, one row per fund holding it, from each fund\'s latest report on or before `period_end`, its positions in the issuer summed), by fund (`filer=` registrant CIK, `series=` when the registrant files for several funds: that fund\'s positions) or by filing (`accession=`, an NPORT-P filing\'s reported holdings as filed); exactly one of `company`, `filer` or `accession` (`series` alone needs `filer`). `period_end` defaults to today. Order: value in USD, descending (`company=`, `filer=`), the filing\'s line order (`accession=`); several companies are read one after another. A fund row is not a 13F `Holding` (different row type, R16): `/v1/holdings` keeps the 13F managers.
153
+ * List N-PORT fund holdings
154
+ */
155
+ async listFundHoldings(requestParameters: ListFundHoldingsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListFundHoldings200Response> {
156
+ const response = await this.listFundHoldingsRaw(requestParameters, initOverrides);
157
+ return await response.value();
158
+ }
159
+
60
160
  /**
61
161
  * Creates request options for listHoldingChanges without sending the request
62
162
  */
@@ -221,6 +321,13 @@ export class HoldingsApi extends runtime.BaseAPI {
221
321
 
222
322
  }
223
323
 
324
+ /**
325
+ * @export
326
+ */
327
+ export const ListFundHoldingsSortEnum = {
328
+ ValueUsd: '-value_usd'
329
+ } as const;
330
+ export type ListFundHoldingsSortEnum = typeof ListFundHoldingsSortEnum[keyof typeof ListFundHoldingsSortEnum];
224
331
  /**
225
332
  * @export
226
333
  */