@invinite-org/data-api-client 0.10.1 → 1.0.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 (280) hide show
  1. package/.openapi-generator/FILES +74 -20
  2. package/README.md +32 -2
  3. package/dist/apis/EarningsCallsApi.d.ts +24 -2
  4. package/dist/apis/EarningsCallsApi.js +27 -3
  5. package/dist/apis/IPOsApi.d.ts +11 -2
  6. package/dist/apis/IPOsApi.js +13 -3
  7. package/dist/apis/SECApi.d.ts +840 -0
  8. package/dist/apis/SECApi.js +1959 -0
  9. package/dist/apis/index.d.ts +1 -1
  10. package/dist/apis/index.js +1 -1
  11. package/dist/esm/apis/EarningsCallsApi.d.ts +24 -2
  12. package/dist/esm/apis/EarningsCallsApi.js +26 -2
  13. package/dist/esm/apis/IPOsApi.d.ts +11 -2
  14. package/dist/esm/apis/IPOsApi.js +12 -2
  15. package/dist/esm/apis/SECApi.d.ts +840 -0
  16. package/dist/esm/apis/SECApi.js +1955 -0
  17. package/dist/esm/apis/index.d.ts +1 -1
  18. package/dist/esm/apis/index.js +1 -1
  19. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInner.d.ts +7 -0
  20. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInner.js +3 -0
  21. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerCalendar.d.ts +95 -0
  22. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerCalendar.js +95 -0
  23. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCall.d.ts +102 -0
  24. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCall.js +100 -0
  25. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource.d.ts +56 -0
  26. package/dist/esm/models/{SecFilingsSearch200ResponseSourcesInner.js → EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource.js} +23 -27
  27. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReport.d.ts +69 -0
  28. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReport.js +72 -0
  29. package/{src/models/SecFilingsAvailableFormTypes200Response.ts → dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource.d.ts} +26 -48
  30. package/dist/esm/models/{SecFilingsSections200ResponseCompaniesInner.js → EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource.js} +17 -18
  31. package/dist/esm/models/EarningsCallsTranscript200Response.d.ts +3 -3
  32. package/dist/esm/models/EarningsCallsTranscript200Response.js +3 -3
  33. package/dist/esm/models/EarningsCallsTranscript200ResponseEvent.d.ts +233 -0
  34. package/dist/esm/models/{SecFilingsSections200ResponseCompaniesInnerSectionsInner.js → EarningsCallsTranscript200ResponseEvent.js} +136 -47
  35. package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInner.d.ts +7 -0
  36. package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInner.js +3 -0
  37. package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPending.d.ts +89 -0
  38. package/dist/esm/models/{SecFilingsList200ResponseCompaniesInnerFilingsInner.js → IposRegistrationsList200ResponseRegistrationsInnerIpoPending.js} +43 -44
  39. package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.d.ts +74 -0
  40. package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.js +55 -0
  41. package/dist/{models/SecFilingsSearch200Response.d.ts → esm/models/SecDatasets200Response.d.ts} +26 -17
  42. package/dist/esm/models/{SecFilingsSearch200Response.js → SecDatasets200Response.js} +13 -19
  43. package/dist/esm/models/SecDocument200Response.d.ts +104 -0
  44. package/dist/esm/models/SecDocument200Response.js +42 -0
  45. package/dist/esm/models/SecDocumentFactPlaces200Response.d.ts +88 -0
  46. package/dist/esm/models/SecDocumentFactPlaces200Response.js +42 -0
  47. package/dist/esm/models/SecDocumentFigure200Response.d.ts +70 -0
  48. package/dist/esm/models/SecDocumentFigure200Response.js +42 -0
  49. package/dist/esm/models/SecDocumentSections200Response.d.ts +71 -0
  50. package/dist/esm/models/SecDocumentSections200Response.js +43 -0
  51. package/dist/esm/models/SecDocumentSections200ResponseSectionsInner.d.ts +85 -0
  52. package/dist/esm/models/SecDocumentSections200ResponseSectionsInner.js +44 -0
  53. package/dist/esm/models/SecFiler200Response.d.ts +80 -0
  54. package/dist/esm/models/{SecFilingsList200ResponseCompaniesInner.js → SecFiler200Response.js} +13 -25
  55. package/dist/esm/models/SecFilerCoverage200Response.d.ts +82 -0
  56. package/dist/esm/models/SecFilerCoverage200Response.js +42 -0
  57. package/dist/{models/SecFilingsList200ResponseCompaniesInnerFilingsInner.d.ts → esm/models/SecFilerLifecycle200Response.d.ts} +106 -53
  58. package/dist/esm/models/SecFilerLifecycle200Response.js +42 -0
  59. package/dist/esm/models/SecFilers200Response.d.ts +53 -0
  60. package/dist/esm/models/SecFilers200Response.js +43 -0
  61. package/dist/esm/models/{SecFilingsSearch200ResponseSourcesInner.d.ts → SecFilers200ResponseMatchesInner.d.ts} +31 -28
  62. package/dist/esm/models/SecFilers200ResponseMatchesInner.js +37 -0
  63. package/dist/esm/models/SecFiling200Response.d.ts +88 -0
  64. package/dist/{models/SecFilingsSearch200Response.js → esm/models/SecFiling200Response.js} +13 -26
  65. package/dist/esm/models/{SecFilingsList200Response.d.ts → SecFilingFacts200Response.d.ts} +43 -14
  66. package/dist/esm/models/SecFilingFacts200Response.js +42 -0
  67. package/dist/esm/models/SecFilingHoldings200Response.d.ts +74 -0
  68. package/dist/esm/models/SecFilingHoldings200Response.js +42 -0
  69. package/dist/esm/models/SecFilingReviewChain200Response.d.ts +92 -0
  70. package/dist/esm/models/SecFilingReviewChain200Response.js +42 -0
  71. package/dist/esm/models/SecFilingReviewRelations200Response.d.ts +88 -0
  72. package/dist/esm/models/SecFilingReviewRelations200Response.js +42 -0
  73. package/dist/esm/models/SecFilings200Response.d.ts +88 -0
  74. package/dist/esm/models/SecFilings200Response.js +44 -0
  75. package/dist/esm/models/SecFilings200ResponseFilingsInner.d.ts +81 -0
  76. package/dist/esm/models/SecFilings200ResponseFilingsInner.js +37 -0
  77. package/dist/esm/models/{SecFilingsAvailableFormTypes200Response.d.ts → SecFilings200ResponseFormFacetInner.d.ts} +25 -12
  78. package/dist/esm/models/{SecFilingsList200Response.js → SecFilings200ResponseFormFacetInner.js} +10 -17
  79. package/dist/esm/models/SecFinancialsCatalog200Response.d.ts +48 -0
  80. package/dist/esm/models/SecFinancialsCatalog200Response.js +42 -0
  81. package/dist/{models/SecFilingsSections200ResponseCompaniesInnerSectionsInner.d.ts → esm/models/SecHoldingsHolders200Response.d.ts} +88 -64
  82. package/dist/esm/models/SecHoldingsHolders200Response.js +42 -0
  83. package/dist/esm/models/{SecFilingsList200ResponseCompaniesInner.d.ts → SecIssuers200Response.d.ts} +45 -22
  84. package/dist/esm/models/SecIssuers200Response.js +42 -0
  85. package/dist/esm/models/{SecFilingsSections200ResponseCompaniesInner.d.ts → SecReadiness.d.ts} +34 -21
  86. package/dist/esm/models/SecReadiness.js +55 -0
  87. package/dist/esm/models/SecSearch200Response.d.ts +88 -0
  88. package/dist/esm/models/SecSearch200Response.js +51 -0
  89. package/dist/esm/models/SecSearch200ResponseHitsInner.d.ts +92 -0
  90. package/dist/esm/models/SecSearch200ResponseHitsInner.js +38 -0
  91. package/dist/esm/models/SecSearchCoverage.d.ts +61 -0
  92. package/dist/esm/models/SecSearchCoverage.js +52 -0
  93. package/dist/esm/models/SecSearchCoverageLexical.d.ts +51 -0
  94. package/dist/esm/models/{SecFilingsAvailableFormTypes200Response.js → SecSearchCoverageLexical.js} +10 -16
  95. package/dist/esm/models/SecStoreError.d.ts +52 -0
  96. package/dist/esm/models/{SecFilingsSections200Response.js → SecStoreError.js} +14 -16
  97. package/dist/esm/models/WebSocketFiling.d.ts +1 -1
  98. package/dist/esm/models/index.d.ts +36 -9
  99. package/dist/esm/models/index.js +36 -9
  100. package/dist/models/EarningsCallsCalendar200ResponseEventsInner.d.ts +7 -0
  101. package/dist/models/EarningsCallsCalendar200ResponseEventsInner.js +3 -0
  102. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendar.d.ts +95 -0
  103. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendar.js +103 -0
  104. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCall.d.ts +102 -0
  105. package/dist/models/{SecFilingsSections200ResponseCompaniesInnerSectionsInner.js → EarningsCallsCalendar200ResponseEventsInnerCalendarCall.js} +69 -67
  106. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource.d.ts +56 -0
  107. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource.js +66 -0
  108. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReport.d.ts +69 -0
  109. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReport.js +80 -0
  110. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource.d.ts +44 -0
  111. package/dist/models/{SecFilingsList200ResponseCompaniesInner.js → EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource.js} +22 -25
  112. package/dist/models/EarningsCallsTranscript200Response.d.ts +3 -3
  113. package/dist/models/EarningsCallsTranscript200Response.js +3 -3
  114. package/dist/models/EarningsCallsTranscript200ResponseEvent.d.ts +233 -0
  115. package/dist/models/EarningsCallsTranscript200ResponseEvent.js +196 -0
  116. package/dist/models/IposRegistrationsList200ResponseRegistrationsInner.d.ts +7 -0
  117. package/dist/models/IposRegistrationsList200ResponseRegistrationsInner.js +3 -0
  118. package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPending.d.ts +89 -0
  119. package/dist/models/{SecFilingsList200ResponseCompaniesInnerFilingsInner.js → IposRegistrationsList200ResponseRegistrationsInnerIpoPending.js} +49 -49
  120. package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.d.ts +74 -0
  121. package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.js +62 -0
  122. package/dist/{esm/models/SecFilingsSearch200Response.d.ts → models/SecDatasets200Response.d.ts} +26 -17
  123. package/dist/models/{SecFilingsSections200Response.js → SecDatasets200Response.js} +19 -21
  124. package/dist/models/SecDocument200Response.d.ts +104 -0
  125. package/dist/models/{SecFilingsSections200ResponseCompaniesInner.js → SecDocument200Response.js} +18 -28
  126. package/dist/models/SecDocumentFactPlaces200Response.d.ts +88 -0
  127. package/dist/models/SecDocumentFactPlaces200Response.js +49 -0
  128. package/dist/models/SecDocumentFigure200Response.d.ts +70 -0
  129. package/dist/models/SecDocumentFigure200Response.js +49 -0
  130. package/dist/models/SecDocumentSections200Response.d.ts +71 -0
  131. package/dist/models/SecDocumentSections200Response.js +50 -0
  132. package/dist/models/SecDocumentSections200ResponseSectionsInner.d.ts +85 -0
  133. package/dist/models/SecDocumentSections200ResponseSectionsInner.js +52 -0
  134. package/dist/models/SecFiler200Response.d.ts +80 -0
  135. package/dist/models/SecFiler200Response.js +49 -0
  136. package/dist/models/SecFilerCoverage200Response.d.ts +82 -0
  137. package/dist/models/{SecFilingsSearch200ResponseSourcesInner.js → SecFilerCoverage200Response.js} +18 -39
  138. package/dist/{esm/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.d.ts → models/SecFilerLifecycle200Response.d.ts} +106 -53
  139. package/dist/models/SecFilerLifecycle200Response.js +49 -0
  140. package/dist/models/SecFilers200Response.d.ts +53 -0
  141. package/dist/models/SecFilers200Response.js +50 -0
  142. package/dist/models/{SecFilingsSearch200ResponseSourcesInner.d.ts → SecFilers200ResponseMatchesInner.d.ts} +31 -28
  143. package/dist/models/SecFilers200ResponseMatchesInner.js +44 -0
  144. package/dist/models/SecFiling200Response.d.ts +88 -0
  145. package/dist/models/SecFiling200Response.js +49 -0
  146. package/dist/models/{SecFilingsList200Response.d.ts → SecFilingFacts200Response.d.ts} +43 -14
  147. package/dist/models/SecFilingFacts200Response.js +49 -0
  148. package/dist/models/SecFilingHoldings200Response.d.ts +74 -0
  149. package/dist/models/SecFilingHoldings200Response.js +49 -0
  150. package/dist/models/SecFilingReviewChain200Response.d.ts +92 -0
  151. package/dist/models/SecFilingReviewChain200Response.js +49 -0
  152. package/dist/models/SecFilingReviewRelations200Response.d.ts +88 -0
  153. package/dist/models/SecFilingReviewRelations200Response.js +49 -0
  154. package/dist/models/SecFilings200Response.d.ts +88 -0
  155. package/dist/models/SecFilings200Response.js +51 -0
  156. package/dist/models/SecFilings200ResponseFilingsInner.d.ts +81 -0
  157. package/dist/models/SecFilings200ResponseFilingsInner.js +44 -0
  158. package/dist/{esm/models/SecFilingsSections200Response.d.ts → models/SecFilings200ResponseFormFacetInner.d.ts} +25 -13
  159. package/dist/models/SecFilings200ResponseFormFacetInner.js +44 -0
  160. package/dist/models/SecFinancialsCatalog200Response.d.ts +48 -0
  161. package/dist/models/SecFinancialsCatalog200Response.js +49 -0
  162. package/dist/{esm/models/SecFilingsSections200ResponseCompaniesInnerSectionsInner.d.ts → models/SecHoldingsHolders200Response.d.ts} +88 -64
  163. package/dist/models/SecHoldingsHolders200Response.js +49 -0
  164. package/dist/models/{SecFilingsList200ResponseCompaniesInner.d.ts → SecIssuers200Response.d.ts} +45 -22
  165. package/dist/models/SecIssuers200Response.js +49 -0
  166. package/dist/models/{SecFilingsSections200ResponseCompaniesInner.d.ts → SecReadiness.d.ts} +34 -21
  167. package/dist/models/SecReadiness.js +63 -0
  168. package/dist/models/SecSearch200Response.d.ts +88 -0
  169. package/dist/models/SecSearch200Response.js +59 -0
  170. package/dist/models/SecSearch200ResponseHitsInner.d.ts +92 -0
  171. package/dist/models/SecSearch200ResponseHitsInner.js +45 -0
  172. package/dist/models/SecSearchCoverage.d.ts +61 -0
  173. package/dist/models/SecSearchCoverage.js +60 -0
  174. package/dist/models/SecSearchCoverageLexical.d.ts +51 -0
  175. package/dist/models/{SecFilingsList200Response.js → SecSearchCoverageLexical.js} +15 -22
  176. package/dist/models/SecStoreError.d.ts +52 -0
  177. package/dist/models/{SecFilingsAvailableFormTypes200Response.js → SecStoreError.js} +19 -20
  178. package/dist/models/WebSocketFiling.d.ts +1 -1
  179. package/dist/models/index.d.ts +36 -9
  180. package/dist/models/index.js +36 -9
  181. package/docs/EarningsCallsApi.md +8 -2
  182. package/docs/EarningsCallsCalendar200ResponseEventsInner.md +2 -0
  183. package/docs/EarningsCallsCalendar200ResponseEventsInnerCalendar.md +43 -0
  184. package/docs/EarningsCallsCalendar200ResponseEventsInnerCalendarCall.md +45 -0
  185. package/docs/EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource.md +43 -0
  186. package/docs/EarningsCallsCalendar200ResponseEventsInnerCalendarReport.md +41 -0
  187. package/docs/EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource.md +39 -0
  188. package/docs/EarningsCallsTranscript200Response.md +1 -1
  189. package/docs/EarningsCallsTranscript200ResponseEvent.md +88 -0
  190. package/docs/IPOsApi.md +5 -2
  191. package/docs/IposRegistrationsList200ResponseRegistrationsInner.md +2 -0
  192. package/docs/IposRegistrationsList200ResponseRegistrationsInnerIpoPending.md +51 -0
  193. package/docs/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.md +49 -0
  194. package/docs/SECApi.md +2646 -0
  195. package/docs/{SecFilingsList200Response.md → SecDatasets200Response.md} +11 -6
  196. package/docs/SecDocument200Response.md +53 -0
  197. package/docs/SecDocumentFactPlaces200Response.md +51 -0
  198. package/docs/SecDocumentFigure200Response.md +45 -0
  199. package/docs/SecDocumentSections200Response.md +47 -0
  200. package/docs/SecDocumentSections200ResponseSectionsInner.md +48 -0
  201. package/docs/SecFiler200Response.md +47 -0
  202. package/docs/SecFilerCoverage200Response.md +49 -0
  203. package/docs/SecFilerLifecycle200Response.md +65 -0
  204. package/docs/SecFilers200Response.md +41 -0
  205. package/docs/{SecFilingsSearch200ResponseSourcesInner.md → SecFilers200ResponseMatchesInner.md} +14 -14
  206. package/docs/SecFiling200Response.md +49 -0
  207. package/docs/SecFilingFacts200Response.md +43 -0
  208. package/docs/SecFilingHoldings200Response.md +47 -0
  209. package/docs/SecFilingReviewChain200Response.md +51 -0
  210. package/docs/SecFilingReviewRelations200Response.md +51 -0
  211. package/docs/SecFilings200Response.md +51 -0
  212. package/docs/SecFilings200ResponseFilingsInner.md +50 -0
  213. package/docs/{SecFilingsAvailableFormTypes200Response.md → SecFilings200ResponseFormFacetInner.md} +10 -6
  214. package/docs/{SecFilingsSections200Response.md → SecFinancialsCatalog200Response.md} +11 -6
  215. package/docs/SecHoldingsHolders200Response.md +67 -0
  216. package/docs/{SecFilingsList200ResponseCompaniesInner.md → SecIssuers200Response.md} +17 -10
  217. package/docs/SecReadiness.md +39 -0
  218. package/docs/SecSearch200Response.md +49 -0
  219. package/docs/SecSearch200ResponseHitsInner.md +52 -0
  220. package/docs/SecSearchCoverage.md +41 -0
  221. package/docs/{SecFilingsSearch200Response.md → SecSearchCoverageLexical.md} +13 -8
  222. package/docs/SecStoreError.md +41 -0
  223. package/docs/WebSocketFiling.md +1 -1
  224. package/package.json +1 -1
  225. package/src/apis/EarningsCallsApi.ts +32 -2
  226. package/src/apis/IPOsApi.ts +15 -2
  227. package/src/apis/SECApi.ts +2596 -0
  228. package/src/apis/index.ts +1 -1
  229. package/src/models/EarningsCallsCalendar200ResponseEventsInner.ts +15 -0
  230. package/src/models/EarningsCallsCalendar200ResponseEventsInnerCalendar.ts +159 -0
  231. package/src/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCall.ts +163 -0
  232. package/src/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource.ts +102 -0
  233. package/src/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReport.ts +123 -0
  234. package/src/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource.ts +84 -0
  235. package/src/models/EarningsCallsTranscript200Response.ts +10 -10
  236. package/src/models/EarningsCallsTranscript200ResponseEvent.ts +363 -0
  237. package/src/models/IposRegistrationsList200ResponseRegistrationsInner.ts +15 -0
  238. package/src/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPending.ts +157 -0
  239. package/src/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.ts +121 -0
  240. package/src/models/{SecFilingsSearch200Response.ts → SecDatasets200Response.ts} +41 -30
  241. package/src/models/SecDocument200Response.ts +150 -0
  242. package/src/models/SecDocumentFactPlaces200Response.ts +142 -0
  243. package/src/models/{SecFilingsSections200ResponseCompaniesInner.ts → SecDocumentFigure200Response.ts} +63 -37
  244. package/src/models/SecDocumentSections200Response.ts +133 -0
  245. package/src/models/SecDocumentSections200ResponseSectionsInner.ts +135 -0
  246. package/src/models/{SecFilingsSearch200ResponseSourcesInner.ts → SecFiler200Response.ts} +67 -52
  247. package/src/models/SecFilerCoverage200Response.ts +134 -0
  248. package/src/models/{SecFilingsList200ResponseCompaniesInnerFilingsInner.ts → SecFilerLifecycle200Response.ts} +126 -92
  249. package/src/models/SecFilers200Response.ts +109 -0
  250. package/src/models/SecFilers200ResponseMatchesInner.ts +108 -0
  251. package/src/models/SecFiling200Response.ts +134 -0
  252. package/src/models/SecFilingFacts200Response.ts +110 -0
  253. package/src/models/SecFilingHoldings200Response.ts +126 -0
  254. package/src/models/SecFilingReviewChain200Response.ts +142 -0
  255. package/src/models/SecFilingReviewRelations200Response.ts +142 -0
  256. package/src/models/SecFilings200Response.ts +156 -0
  257. package/src/models/SecFilings200ResponseFilingsInner.ts +132 -0
  258. package/src/models/{SecFilingsSections200Response.ts → SecFilings200ResponseFormFacetInner.ts} +35 -25
  259. package/src/models/SecFinancialsCatalog200Response.ts +94 -0
  260. package/src/models/{SecFilingsSections200ResponseCompaniesInnerSectionsInner.ts → SecHoldingsHolders200Response.ts} +125 -111
  261. package/src/models/{SecFilingsList200ResponseCompaniesInner.ts → SecIssuers200Response.ts} +64 -38
  262. package/src/models/SecReadiness.ts +103 -0
  263. package/src/models/SecSearch200Response.ts +159 -0
  264. package/src/models/SecSearch200ResponseHitsInner.ts +148 -0
  265. package/src/models/SecSearchCoverage.ts +115 -0
  266. package/src/models/{SecFilingsList200Response.ts → SecSearchCoverageLexical.ts} +44 -26
  267. package/src/models/SecStoreError.ts +102 -0
  268. package/src/models/WebSocketFiling.ts +1 -1
  269. package/src/models/index.ts +36 -9
  270. package/dist/apis/SECFilingsApi.d.ts +0 -117
  271. package/dist/apis/SECFilingsApi.js +0 -284
  272. package/dist/esm/apis/SECFilingsApi.d.ts +0 -117
  273. package/dist/esm/apis/SECFilingsApi.js +0 -280
  274. package/dist/models/SecFilingsAvailableFormTypes200Response.d.ts +0 -32
  275. package/dist/models/SecFilingsSections200Response.d.ts +0 -33
  276. package/docs/SECFilingsApi.md +0 -344
  277. package/docs/SecFilingsList200ResponseCompaniesInnerFilingsInner.md +0 -54
  278. package/docs/SecFilingsSections200ResponseCompaniesInner.md +0 -38
  279. package/docs/SecFilingsSections200ResponseCompaniesInnerSectionsInner.md +0 -62
  280. package/src/apis/SECFilingsApi.ts +0 -368
@@ -0,0 +1,2596 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Invinite API
5
+ * Invinite financial data API. Each endpoint has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Included-Remaining` what is left of the plan\'s included credits. `GET /v1/account/usage` returns your account\'s usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost. **Coverage.** Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/company/available-companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the CIKs 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; `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`, `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 `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. News: Issuer and SEC text is served in full with its attribution; the licensee shows publisher, source URL and date next to it and may forward it unmodified; 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 reproduce issuer or SEC text 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/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, News, WebSocket, Account.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import * as runtime from '../runtime';
16
+ import {
17
+ type CompanyAvailableCompanies401Response,
18
+ CompanyAvailableCompanies401ResponseFromJSON,
19
+ CompanyAvailableCompanies401ResponseToJSON,
20
+ } from '../models/CompanyAvailableCompanies401Response';
21
+ import {
22
+ type SecDatasets200Response,
23
+ SecDatasets200ResponseFromJSON,
24
+ SecDatasets200ResponseToJSON,
25
+ } from '../models/SecDatasets200Response';
26
+ import {
27
+ type SecDocument200Response,
28
+ SecDocument200ResponseFromJSON,
29
+ SecDocument200ResponseToJSON,
30
+ } from '../models/SecDocument200Response';
31
+ import {
32
+ type SecDocumentFactPlaces200Response,
33
+ SecDocumentFactPlaces200ResponseFromJSON,
34
+ SecDocumentFactPlaces200ResponseToJSON,
35
+ } from '../models/SecDocumentFactPlaces200Response';
36
+ import {
37
+ type SecDocumentFigure200Response,
38
+ SecDocumentFigure200ResponseFromJSON,
39
+ SecDocumentFigure200ResponseToJSON,
40
+ } from '../models/SecDocumentFigure200Response';
41
+ import {
42
+ type SecDocumentSections200Response,
43
+ SecDocumentSections200ResponseFromJSON,
44
+ SecDocumentSections200ResponseToJSON,
45
+ } from '../models/SecDocumentSections200Response';
46
+ import {
47
+ type SecFiler200Response,
48
+ SecFiler200ResponseFromJSON,
49
+ SecFiler200ResponseToJSON,
50
+ } from '../models/SecFiler200Response';
51
+ import {
52
+ type SecFilerCoverage200Response,
53
+ SecFilerCoverage200ResponseFromJSON,
54
+ SecFilerCoverage200ResponseToJSON,
55
+ } from '../models/SecFilerCoverage200Response';
56
+ import {
57
+ type SecFilerLifecycle200Response,
58
+ SecFilerLifecycle200ResponseFromJSON,
59
+ SecFilerLifecycle200ResponseToJSON,
60
+ } from '../models/SecFilerLifecycle200Response';
61
+ import {
62
+ type SecFilers200Response,
63
+ SecFilers200ResponseFromJSON,
64
+ SecFilers200ResponseToJSON,
65
+ } from '../models/SecFilers200Response';
66
+ import {
67
+ type SecFiling200Response,
68
+ SecFiling200ResponseFromJSON,
69
+ SecFiling200ResponseToJSON,
70
+ } from '../models/SecFiling200Response';
71
+ import {
72
+ type SecFilingFacts200Response,
73
+ SecFilingFacts200ResponseFromJSON,
74
+ SecFilingFacts200ResponseToJSON,
75
+ } from '../models/SecFilingFacts200Response';
76
+ import {
77
+ type SecFilingHoldings200Response,
78
+ SecFilingHoldings200ResponseFromJSON,
79
+ SecFilingHoldings200ResponseToJSON,
80
+ } from '../models/SecFilingHoldings200Response';
81
+ import {
82
+ type SecFilingReviewChain200Response,
83
+ SecFilingReviewChain200ResponseFromJSON,
84
+ SecFilingReviewChain200ResponseToJSON,
85
+ } from '../models/SecFilingReviewChain200Response';
86
+ import {
87
+ type SecFilingReviewRelations200Response,
88
+ SecFilingReviewRelations200ResponseFromJSON,
89
+ SecFilingReviewRelations200ResponseToJSON,
90
+ } from '../models/SecFilingReviewRelations200Response';
91
+ import {
92
+ type SecFilings200Response,
93
+ SecFilings200ResponseFromJSON,
94
+ SecFilings200ResponseToJSON,
95
+ } from '../models/SecFilings200Response';
96
+ import {
97
+ type SecFinancialsCatalog200Response,
98
+ SecFinancialsCatalog200ResponseFromJSON,
99
+ SecFinancialsCatalog200ResponseToJSON,
100
+ } from '../models/SecFinancialsCatalog200Response';
101
+ import {
102
+ type SecHoldingsHolders200Response,
103
+ SecHoldingsHolders200ResponseFromJSON,
104
+ SecHoldingsHolders200ResponseToJSON,
105
+ } from '../models/SecHoldingsHolders200Response';
106
+ import {
107
+ type SecIssuers200Response,
108
+ SecIssuers200ResponseFromJSON,
109
+ SecIssuers200ResponseToJSON,
110
+ } from '../models/SecIssuers200Response';
111
+ import {
112
+ type SecSearch200Response,
113
+ SecSearch200ResponseFromJSON,
114
+ SecSearch200ResponseToJSON,
115
+ } from '../models/SecSearch200Response';
116
+ import {
117
+ type SecStoreError,
118
+ SecStoreErrorFromJSON,
119
+ SecStoreErrorToJSON,
120
+ } from '../models/SecStoreError';
121
+
122
+ export interface SecDocumentRequest {
123
+ accession: string;
124
+ filename: string;
125
+ blocks?: string;
126
+ pages?: string;
127
+ printed?: string;
128
+ printedOccurrence?: number;
129
+ neighbors?: number;
130
+ footnotes?: SecDocumentFootnotesEnum;
131
+ limit?: number;
132
+ }
133
+
134
+ export interface SecDocumentFactPlacesRequest {
135
+ versionId: string;
136
+ factId?: string;
137
+ status?: SecDocumentFactPlacesStatusEnum;
138
+ cursor?: string;
139
+ limit?: number;
140
+ }
141
+
142
+ export interface SecDocumentFigureRequest {
143
+ versionId: string;
144
+ blockId: string;
145
+ }
146
+
147
+ export interface SecDocumentSectionsRequest {
148
+ versionId: string;
149
+ outline?: SecDocumentSectionsOutlineEnum;
150
+ }
151
+
152
+ export interface SecDocumentVersionRequest {
153
+ versionId: string;
154
+ blocks?: string;
155
+ pages?: string;
156
+ printed?: string;
157
+ printedOccurrence?: number;
158
+ neighbors?: number;
159
+ footnotes?: SecDocumentVersionFootnotesEnum;
160
+ limit?: number;
161
+ }
162
+
163
+ export interface SecExportRequest {
164
+ exportId: string;
165
+ }
166
+
167
+ export interface SecExportFileRequest {
168
+ exportId: string;
169
+ }
170
+
171
+ export interface SecExportsFinancialMetricsRequest {
172
+ metricId: string;
173
+ fiscalYear: number;
174
+ periodType?: SecExportsFinancialMetricsPeriodTypeEnum;
175
+ mode?: SecExportsFinancialMetricsModeEnum;
176
+ generation?: string;
177
+ }
178
+
179
+ export interface SecFilerRequest {
180
+ cik: string;
181
+ }
182
+
183
+ export interface SecFilerCoverageRequest {
184
+ cik: string;
185
+ since?: Date;
186
+ }
187
+
188
+ export interface SecFilerLifecycleRequest {
189
+ cik: string;
190
+ traverse?: SecFilerLifecycleTraverseEnum;
191
+ maxHops?: number;
192
+ }
193
+
194
+ export interface SecFilersRequest {
195
+ name?: string;
196
+ ticker?: string;
197
+ form?: string;
198
+ limit?: number;
199
+ }
200
+
201
+ export interface SecFilingRequest {
202
+ accession: string;
203
+ }
204
+
205
+ export interface SecFilingFactsRequest {
206
+ accession: string;
207
+ tag?: string;
208
+ }
209
+
210
+ export interface SecFilingHoldingsRequest {
211
+ accession: string;
212
+ after?: number;
213
+ limit?: number;
214
+ }
215
+
216
+ export interface SecFilingNotesRequest {
217
+ accession: string;
218
+ tag?: string;
219
+ }
220
+
221
+ export interface SecFilingReviewChainRequest {
222
+ accession: string;
223
+ maxDepth?: number;
224
+ maxNodes?: number;
225
+ }
226
+
227
+ export interface SecFilingReviewRelationsRequest {
228
+ accession: string;
229
+ direction?: SecFilingReviewRelationsDirectionEnum;
230
+ kind?: SecFilingReviewRelationsKindEnum;
231
+ history?: SecFilingReviewRelationsHistoryEnum;
232
+ cursor?: string;
233
+ limit?: number;
234
+ }
235
+
236
+ export interface SecFilingsRequest {
237
+ identifier: string;
238
+ form?: string;
239
+ filedFrom?: Date;
240
+ filedTo?: Date;
241
+ order?: SecFilingsOrderEnum;
242
+ cursor?: string;
243
+ limit?: number;
244
+ }
245
+
246
+ export interface SecFinancialsCatalogRequest {
247
+ statement?: SecFinancialsCatalogStatementEnum;
248
+ metricId?: string;
249
+ }
250
+
251
+ export interface SecFinancialsFactRequest {
252
+ id: string;
253
+ maxDepth?: number;
254
+ maxMembers?: number;
255
+ places?: SecFinancialsFactPlacesEnum;
256
+ }
257
+
258
+ export interface SecFinancialsStatementRequest {
259
+ cik: string;
260
+ statement: SecFinancialsStatementStatementEnum;
261
+ periodType?: SecFinancialsStatementPeriodTypeEnum;
262
+ fiscalYearFrom?: number;
263
+ fiscalYearTo?: number;
264
+ metricId?: string;
265
+ otherEvidence?: SecFinancialsStatementOtherEvidenceEnum;
266
+ limit?: number;
267
+ }
268
+
269
+ export interface SecHoldingsDeltasRequest {
270
+ periodEnd: Date;
271
+ priorPeriodEnd?: Date;
272
+ cusip?: string;
273
+ symbol?: string;
274
+ issuerCik?: string;
275
+ instruments?: SecHoldingsDeltasInstrumentsEnum;
276
+ pinnedAt?: Date;
277
+ cursor?: string;
278
+ limit?: number;
279
+ }
280
+
281
+ export interface SecHoldingsFormFilersRequest {
282
+ form: string;
283
+ exact?: SecHoldingsFormFilersExactEnum;
284
+ name?: string;
285
+ cik?: string;
286
+ cursor?: string;
287
+ limit?: number;
288
+ }
289
+
290
+ export interface SecHoldingsHoldersRequest {
291
+ periodEnd: Date;
292
+ cusip?: string;
293
+ symbol?: string;
294
+ issuerCik?: string;
295
+ instruments?: SecHoldingsHoldersInstrumentsEnum;
296
+ pinnedAt?: Date;
297
+ cursor?: string;
298
+ limit?: number;
299
+ }
300
+
301
+ export interface SecHoldingsManagerPortfolioRequest {
302
+ periodEnd: Date;
303
+ cik: string;
304
+ instruments?: SecHoldingsManagerPortfolioInstrumentsEnum;
305
+ pinnedAt?: Date;
306
+ cursor?: string;
307
+ limit?: number;
308
+ }
309
+
310
+ export interface SecIssuersRequest {
311
+ query?: string;
312
+ phase?: SecIssuersPhaseEnum;
313
+ form?: string;
314
+ publicSeenFrom?: Date;
315
+ publicSeenTo?: Date;
316
+ cursor?: string;
317
+ limit?: number;
318
+ }
319
+
320
+ export interface SecSearchRequest {
321
+ q: string;
322
+ mode?: SecSearchModeEnum;
323
+ caseSensitive?: SecSearchCaseSensitiveEnum;
324
+ cik?: string;
325
+ entityId?: number;
326
+ successors?: SecSearchSuccessorsEnum;
327
+ accession?: string;
328
+ versionId?: string;
329
+ form?: string;
330
+ filename?: string;
331
+ item?: string;
332
+ exhibitType?: string;
333
+ filedFrom?: Date;
334
+ filedTo?: Date;
335
+ cursor?: string;
336
+ limit?: number;
337
+ }
338
+
339
+ /**
340
+ *
341
+ */
342
+ export class SECApi extends runtime.BaseAPI {
343
+
344
+ /**
345
+ * Creates request options for secDatasets without sending the request
346
+ */
347
+ async secDatasetsRequestOpts(): Promise<runtime.RequestOpts> {
348
+ const queryParameters: any = {};
349
+
350
+ const headerParameters: runtime.HTTPHeaders = {};
351
+
352
+ if (this.configuration && this.configuration.accessToken) {
353
+ const token = this.configuration.accessToken;
354
+ const tokenString = await token("bearerAuth", []);
355
+
356
+ if (tokenString) {
357
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
358
+ }
359
+ }
360
+
361
+ let urlPath = `/v1/sec/datasets`;
362
+
363
+ return {
364
+ path: urlPath,
365
+ method: 'GET',
366
+ headers: headerParameters,
367
+ query: queryParameters,
368
+ };
369
+ }
370
+
371
+ /**
372
+ * The active release of each SEC dataset the store loads (Financial Statement and Notes, 13F, company facts): period, release hash, publication and load times — the identity every dataset row cites. Separate from document coverage (`held_through`). Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
373
+ * SEC dataset releases
374
+ */
375
+ async secDatasetsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecDatasets200Response>> {
376
+ const requestOptions = await this.secDatasetsRequestOpts();
377
+ const response = await this.request(requestOptions, initOverrides);
378
+
379
+ return new runtime.JSONApiResponse(response, (jsonValue) => SecDatasets200ResponseFromJSON(jsonValue));
380
+ }
381
+
382
+ /**
383
+ * The active release of each SEC dataset the store loads (Financial Statement and Notes, 13F, company facts): period, release hash, publication and load times — the identity every dataset row cites. Separate from document coverage (`held_through`). Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
384
+ * SEC dataset releases
385
+ */
386
+ async secDatasets(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecDatasets200Response> {
387
+ const response = await this.secDatasetsRaw(initOverrides);
388
+ return await response.value();
389
+ }
390
+
391
+ /**
392
+ * Creates request options for secDocument without sending the request
393
+ */
394
+ async secDocumentRequestOpts(requestParameters: SecDocumentRequest): Promise<runtime.RequestOpts> {
395
+ if (requestParameters['accession'] == null) {
396
+ throw new runtime.RequiredError(
397
+ 'accession',
398
+ 'Required parameter "accession" was null or undefined when calling secDocument().'
399
+ );
400
+ }
401
+
402
+ if (requestParameters['filename'] == null) {
403
+ throw new runtime.RequiredError(
404
+ 'filename',
405
+ 'Required parameter "filename" was null or undefined when calling secDocument().'
406
+ );
407
+ }
408
+
409
+ const queryParameters: any = {};
410
+
411
+ if (requestParameters['blocks'] != null) {
412
+ queryParameters['blocks'] = requestParameters['blocks'];
413
+ }
414
+
415
+ if (requestParameters['pages'] != null) {
416
+ queryParameters['pages'] = requestParameters['pages'];
417
+ }
418
+
419
+ if (requestParameters['printed'] != null) {
420
+ queryParameters['printed'] = requestParameters['printed'];
421
+ }
422
+
423
+ if (requestParameters['printedOccurrence'] != null) {
424
+ queryParameters['printed_occurrence'] = requestParameters['printedOccurrence'];
425
+ }
426
+
427
+ if (requestParameters['neighbors'] != null) {
428
+ queryParameters['neighbors'] = requestParameters['neighbors'];
429
+ }
430
+
431
+ if (requestParameters['footnotes'] != null) {
432
+ queryParameters['footnotes'] = requestParameters['footnotes'];
433
+ }
434
+
435
+ if (requestParameters['limit'] != null) {
436
+ queryParameters['limit'] = requestParameters['limit'];
437
+ }
438
+
439
+ const headerParameters: runtime.HTTPHeaders = {};
440
+
441
+ if (this.configuration && this.configuration.accessToken) {
442
+ const token = this.configuration.accessToken;
443
+ const tokenString = await token("bearerAuth", []);
444
+
445
+ if (tokenString) {
446
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
447
+ }
448
+ }
449
+
450
+ let urlPath = `/v1/sec/documents/{accession}/{filename}`;
451
+ urlPath = urlPath.replace('{accession}', encodeURIComponent(String(requestParameters['accession'])));
452
+ urlPath = urlPath.replace('{filename}', encodeURIComponent(String(requestParameters['filename'])));
453
+
454
+ return {
455
+ path: urlPath,
456
+ method: 'GET',
457
+ headers: headerParameters,
458
+ query: queryParameters,
459
+ };
460
+ }
461
+
462
+ /**
463
+ * One document of a filing as canonical text: the current version is resolved ONCE and every block, neighbor, footnote and figure comes from that version (`version.version_id`; cite it, or reread it with `GET /v1/sec/versions/{version_id}`). Select by `blocks`, physical `pages` or an exact `printed` label (a repeated label is `ambiguous` with every candidate until `printed_occurrence` picks one). Blocks carry `citation` (version, block, physical page, printed label), section paths, tables with composed headers / unit / scale, footnote links. `source.url` is the original\'s permanent public URL. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for rag: STANDARD.
464
+ * SEC document (current version)
465
+ */
466
+ async secDocumentRaw(requestParameters: SecDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecDocument200Response>> {
467
+ const requestOptions = await this.secDocumentRequestOpts(requestParameters);
468
+ const response = await this.request(requestOptions, initOverrides);
469
+
470
+ return new runtime.JSONApiResponse(response, (jsonValue) => SecDocument200ResponseFromJSON(jsonValue));
471
+ }
472
+
473
+ /**
474
+ * One document of a filing as canonical text: the current version is resolved ONCE and every block, neighbor, footnote and figure comes from that version (`version.version_id`; cite it, or reread it with `GET /v1/sec/versions/{version_id}`). Select by `blocks`, physical `pages` or an exact `printed` label (a repeated label is `ambiguous` with every candidate until `printed_occurrence` picks one). Blocks carry `citation` (version, block, physical page, printed label), section paths, tables with composed headers / unit / scale, footnote links. `source.url` is the original\'s permanent public URL. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for rag: STANDARD.
475
+ * SEC document (current version)
476
+ */
477
+ async secDocument(requestParameters: SecDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecDocument200Response> {
478
+ const response = await this.secDocumentRaw(requestParameters, initOverrides);
479
+ return await response.value();
480
+ }
481
+
482
+ /**
483
+ * Creates request options for secDocumentFactPlaces without sending the request
484
+ */
485
+ async secDocumentFactPlacesRequestOpts(requestParameters: SecDocumentFactPlacesRequest): Promise<runtime.RequestOpts> {
486
+ if (requestParameters['versionId'] == null) {
487
+ throw new runtime.RequiredError(
488
+ 'versionId',
489
+ 'Required parameter "versionId" was null or undefined when calling secDocumentFactPlaces().'
490
+ );
491
+ }
492
+
493
+ const queryParameters: any = {};
494
+
495
+ if (requestParameters['factId'] != null) {
496
+ queryParameters['fact_id'] = requestParameters['factId'];
497
+ }
498
+
499
+ if (requestParameters['status'] != null) {
500
+ queryParameters['status'] = requestParameters['status'];
501
+ }
502
+
503
+ if (requestParameters['cursor'] != null) {
504
+ queryParameters['cursor'] = requestParameters['cursor'];
505
+ }
506
+
507
+ if (requestParameters['limit'] != null) {
508
+ queryParameters['limit'] = requestParameters['limit'];
509
+ }
510
+
511
+ const headerParameters: runtime.HTTPHeaders = {};
512
+
513
+ if (this.configuration && this.configuration.accessToken) {
514
+ const token = this.configuration.accessToken;
515
+ const tokenString = await token("bearerAuth", []);
516
+
517
+ if (tokenString) {
518
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
519
+ }
520
+ }
521
+
522
+ let urlPath = `/v1/sec/versions/{version_id}/fact-places`;
523
+ urlPath = urlPath.replace('{version_id}', encodeURIComponent(String(requestParameters['versionId'])));
524
+
525
+ return {
526
+ path: urlPath,
527
+ method: 'GET',
528
+ headers: headerParameters,
529
+ query: queryParameters,
530
+ };
531
+ }
532
+
533
+ /**
534
+ * Where each XBRL fact of a pinned version sits: the original place (native id, block / table row / column), the annotated-rendition anchors and the PDF box as separate fields; a fact without a place keeps its typed status (`hidden`, `not_in_document`, `derived` with its operands, `unmatched`, `ambiguous`). Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
535
+ * XBRL fact places in a document version
536
+ */
537
+ async secDocumentFactPlacesRaw(requestParameters: SecDocumentFactPlacesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecDocumentFactPlaces200Response>> {
538
+ const requestOptions = await this.secDocumentFactPlacesRequestOpts(requestParameters);
539
+ const response = await this.request(requestOptions, initOverrides);
540
+
541
+ return new runtime.JSONApiResponse(response, (jsonValue) => SecDocumentFactPlaces200ResponseFromJSON(jsonValue));
542
+ }
543
+
544
+ /**
545
+ * Where each XBRL fact of a pinned version sits: the original place (native id, block / table row / column), the annotated-rendition anchors and the PDF box as separate fields; a fact without a place keeps its typed status (`hidden`, `not_in_document`, `derived` with its operands, `unmatched`, `ambiguous`). Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
546
+ * XBRL fact places in a document version
547
+ */
548
+ async secDocumentFactPlaces(requestParameters: SecDocumentFactPlacesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecDocumentFactPlaces200Response> {
549
+ const response = await this.secDocumentFactPlacesRaw(requestParameters, initOverrides);
550
+ return await response.value();
551
+ }
552
+
553
+ /**
554
+ * Creates request options for secDocumentFigure without sending the request
555
+ */
556
+ async secDocumentFigureRequestOpts(requestParameters: SecDocumentFigureRequest): Promise<runtime.RequestOpts> {
557
+ if (requestParameters['versionId'] == null) {
558
+ throw new runtime.RequiredError(
559
+ 'versionId',
560
+ 'Required parameter "versionId" was null or undefined when calling secDocumentFigure().'
561
+ );
562
+ }
563
+
564
+ if (requestParameters['blockId'] == null) {
565
+ throw new runtime.RequiredError(
566
+ 'blockId',
567
+ 'Required parameter "blockId" was null or undefined when calling secDocumentFigure().'
568
+ );
569
+ }
570
+
571
+ const queryParameters: any = {};
572
+
573
+ const headerParameters: runtime.HTTPHeaders = {};
574
+
575
+ if (this.configuration && this.configuration.accessToken) {
576
+ const token = this.configuration.accessToken;
577
+ const tokenString = await token("bearerAuth", []);
578
+
579
+ if (tokenString) {
580
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
581
+ }
582
+ }
583
+
584
+ let urlPath = `/v1/sec/versions/{version_id}/figures/{block_id}`;
585
+ urlPath = urlPath.replace('{version_id}', encodeURIComponent(String(requestParameters['versionId'])));
586
+ urlPath = urlPath.replace('{block_id}', encodeURIComponent(String(requestParameters['blockId'])));
587
+
588
+ return {
589
+ path: urlPath,
590
+ method: 'GET',
591
+ headers: headerParameters,
592
+ query: queryParameters,
593
+ };
594
+ }
595
+
596
+ /**
597
+ * One figure of a pinned version: its caption / alt text, citation and the permanent public URL of the image (`image.url`). Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
598
+ * SEC document figure
599
+ */
600
+ async secDocumentFigureRaw(requestParameters: SecDocumentFigureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecDocumentFigure200Response>> {
601
+ const requestOptions = await this.secDocumentFigureRequestOpts(requestParameters);
602
+ const response = await this.request(requestOptions, initOverrides);
603
+
604
+ return new runtime.JSONApiResponse(response, (jsonValue) => SecDocumentFigure200ResponseFromJSON(jsonValue));
605
+ }
606
+
607
+ /**
608
+ * One figure of a pinned version: its caption / alt text, citation and the permanent public URL of the image (`image.url`). Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
609
+ * SEC document figure
610
+ */
611
+ async secDocumentFigure(requestParameters: SecDocumentFigureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecDocumentFigure200Response> {
612
+ const response = await this.secDocumentFigureRaw(requestParameters, initOverrides);
613
+ return await response.value();
614
+ }
615
+
616
+ /**
617
+ * Creates request options for secDocumentSections without sending the request
618
+ */
619
+ async secDocumentSectionsRequestOpts(requestParameters: SecDocumentSectionsRequest): Promise<runtime.RequestOpts> {
620
+ if (requestParameters['versionId'] == null) {
621
+ throw new runtime.RequiredError(
622
+ 'versionId',
623
+ 'Required parameter "versionId" was null or undefined when calling secDocumentSections().'
624
+ );
625
+ }
626
+
627
+ const queryParameters: any = {};
628
+
629
+ if (requestParameters['outline'] != null) {
630
+ queryParameters['outline'] = requestParameters['outline'];
631
+ }
632
+
633
+ const headerParameters: runtime.HTTPHeaders = {};
634
+
635
+ if (this.configuration && this.configuration.accessToken) {
636
+ const token = this.configuration.accessToken;
637
+ const tokenString = await token("bearerAuth", []);
638
+
639
+ if (tokenString) {
640
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
641
+ }
642
+ }
643
+
644
+ let urlPath = `/v1/sec/versions/{version_id}/sections`;
645
+ urlPath = urlPath.replace('{version_id}', encodeURIComponent(String(requestParameters['versionId'])));
646
+
647
+ return {
648
+ path: urlPath,
649
+ method: 'GET',
650
+ headers: headerParameters,
651
+ query: queryParameters,
652
+ };
653
+ }
654
+
655
+ /**
656
+ * The section outline of a pinned version: `legacy` sections keep the legacy section ids (`legacy_section_key`, listed by `GET /v1/metadata/list-available-section-ids`, e.g. `part_i-item_1a`) where a proven correspondence exists, `generic` sections cover every other heading. Each section lists its block spans and `blocks` selectors: read a section with `GET /v1/sec/versions/{version_id}?blocks=<selector>`. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for rag: STANDARD.
657
+ * Sections of an SEC document version
658
+ */
659
+ async secDocumentSectionsRaw(requestParameters: SecDocumentSectionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecDocumentSections200Response>> {
660
+ const requestOptions = await this.secDocumentSectionsRequestOpts(requestParameters);
661
+ const response = await this.request(requestOptions, initOverrides);
662
+
663
+ return new runtime.JSONApiResponse(response, (jsonValue) => SecDocumentSections200ResponseFromJSON(jsonValue));
664
+ }
665
+
666
+ /**
667
+ * The section outline of a pinned version: `legacy` sections keep the legacy section ids (`legacy_section_key`, listed by `GET /v1/metadata/list-available-section-ids`, e.g. `part_i-item_1a`) where a proven correspondence exists, `generic` sections cover every other heading. Each section lists its block spans and `blocks` selectors: read a section with `GET /v1/sec/versions/{version_id}?blocks=<selector>`. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for rag: STANDARD.
668
+ * Sections of an SEC document version
669
+ */
670
+ async secDocumentSections(requestParameters: SecDocumentSectionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecDocumentSections200Response> {
671
+ const response = await this.secDocumentSectionsRaw(requestParameters, initOverrides);
672
+ return await response.value();
673
+ }
674
+
675
+ /**
676
+ * Creates request options for secDocumentVersion without sending the request
677
+ */
678
+ async secDocumentVersionRequestOpts(requestParameters: SecDocumentVersionRequest): Promise<runtime.RequestOpts> {
679
+ if (requestParameters['versionId'] == null) {
680
+ throw new runtime.RequiredError(
681
+ 'versionId',
682
+ 'Required parameter "versionId" was null or undefined when calling secDocumentVersion().'
683
+ );
684
+ }
685
+
686
+ const queryParameters: any = {};
687
+
688
+ if (requestParameters['blocks'] != null) {
689
+ queryParameters['blocks'] = requestParameters['blocks'];
690
+ }
691
+
692
+ if (requestParameters['pages'] != null) {
693
+ queryParameters['pages'] = requestParameters['pages'];
694
+ }
695
+
696
+ if (requestParameters['printed'] != null) {
697
+ queryParameters['printed'] = requestParameters['printed'];
698
+ }
699
+
700
+ if (requestParameters['printedOccurrence'] != null) {
701
+ queryParameters['printed_occurrence'] = requestParameters['printedOccurrence'];
702
+ }
703
+
704
+ if (requestParameters['neighbors'] != null) {
705
+ queryParameters['neighbors'] = requestParameters['neighbors'];
706
+ }
707
+
708
+ if (requestParameters['footnotes'] != null) {
709
+ queryParameters['footnotes'] = requestParameters['footnotes'];
710
+ }
711
+
712
+ if (requestParameters['limit'] != null) {
713
+ queryParameters['limit'] = requestParameters['limit'];
714
+ }
715
+
716
+ const headerParameters: runtime.HTTPHeaders = {};
717
+
718
+ if (this.configuration && this.configuration.accessToken) {
719
+ const token = this.configuration.accessToken;
720
+ const tokenString = await token("bearerAuth", []);
721
+
722
+ if (tokenString) {
723
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
724
+ }
725
+ }
726
+
727
+ let urlPath = `/v1/sec/versions/{version_id}`;
728
+ urlPath = urlPath.replace('{version_id}', encodeURIComponent(String(requestParameters['versionId'])));
729
+
730
+ return {
731
+ path: urlPath,
732
+ method: 'GET',
733
+ headers: headerParameters,
734
+ query: queryParameters,
735
+ };
736
+ }
737
+
738
+ /**
739
+ * One immutable document version by id (an old cited version stays readable): the same selectors and blocks as `GET /v1/sec/documents/{accession}/{filename}`, never mixed with a newer version. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for rag: STANDARD.
740
+ * SEC document version
741
+ */
742
+ async secDocumentVersionRaw(requestParameters: SecDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecDocument200Response>> {
743
+ const requestOptions = await this.secDocumentVersionRequestOpts(requestParameters);
744
+ const response = await this.request(requestOptions, initOverrides);
745
+
746
+ return new runtime.JSONApiResponse(response, (jsonValue) => SecDocument200ResponseFromJSON(jsonValue));
747
+ }
748
+
749
+ /**
750
+ * One immutable document version by id (an old cited version stays readable): the same selectors and blocks as `GET /v1/sec/documents/{accession}/{filename}`, never mixed with a newer version. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for rag: STANDARD.
751
+ * SEC document version
752
+ */
753
+ async secDocumentVersion(requestParameters: SecDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecDocument200Response> {
754
+ const response = await this.secDocumentVersionRaw(requestParameters, initOverrides);
755
+ return await response.value();
756
+ }
757
+
758
+ /**
759
+ * Creates request options for secExport without sending the request
760
+ */
761
+ async secExportRequestOpts(requestParameters: SecExportRequest): Promise<runtime.RequestOpts> {
762
+ if (requestParameters['exportId'] == null) {
763
+ throw new runtime.RequiredError(
764
+ 'exportId',
765
+ 'Required parameter "exportId" was null or undefined when calling secExport().'
766
+ );
767
+ }
768
+
769
+ const queryParameters: any = {};
770
+
771
+ const headerParameters: runtime.HTTPHeaders = {};
772
+
773
+ if (this.configuration && this.configuration.accessToken) {
774
+ const token = this.configuration.accessToken;
775
+ const tokenString = await token("bearerAuth", []);
776
+
777
+ if (tokenString) {
778
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
779
+ }
780
+ }
781
+
782
+ let urlPath = `/v1/sec/exports/{export_id}`;
783
+ urlPath = urlPath.replace('{export_id}', encodeURIComponent(String(requestParameters['exportId'])));
784
+
785
+ return {
786
+ path: urlPath,
787
+ method: 'GET',
788
+ headers: headerParameters,
789
+ query: queryParameters,
790
+ };
791
+ }
792
+
793
+ /**
794
+ * One export\'s manifest (immutable): rows, bytes, SHA-256, schema, coverage, rule lineage and the `download` route. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
795
+ * Metric export manifest
796
+ */
797
+ async secExportRaw(requestParameters: SecExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecFinancialsCatalog200Response>> {
798
+ const requestOptions = await this.secExportRequestOpts(requestParameters);
799
+ const response = await this.request(requestOptions, initOverrides);
800
+
801
+ return new runtime.JSONApiResponse(response, (jsonValue) => SecFinancialsCatalog200ResponseFromJSON(jsonValue));
802
+ }
803
+
804
+ /**
805
+ * One export\'s manifest (immutable): rows, bytes, SHA-256, schema, coverage, rule lineage and the `download` route. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
806
+ * Metric export manifest
807
+ */
808
+ async secExport(requestParameters: SecExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecFinancialsCatalog200Response> {
809
+ const response = await this.secExportRaw(requestParameters, initOverrides);
810
+ return await response.value();
811
+ }
812
+
813
+ /**
814
+ * Creates request options for secExportFile without sending the request
815
+ */
816
+ async secExportFileRequestOpts(requestParameters: SecExportFileRequest): Promise<runtime.RequestOpts> {
817
+ if (requestParameters['exportId'] == null) {
818
+ throw new runtime.RequiredError(
819
+ 'exportId',
820
+ 'Required parameter "exportId" was null or undefined when calling secExportFile().'
821
+ );
822
+ }
823
+
824
+ const queryParameters: any = {};
825
+
826
+ const headerParameters: runtime.HTTPHeaders = {};
827
+
828
+ if (this.configuration && this.configuration.accessToken) {
829
+ const token = this.configuration.accessToken;
830
+ const tokenString = await token("bearerAuth", []);
831
+
832
+ if (tokenString) {
833
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
834
+ }
835
+ }
836
+
837
+ let urlPath = `/v1/sec/exports/{export_id}/file`;
838
+ urlPath = urlPath.replace('{export_id}', encodeURIComponent(String(requestParameters['exportId'])));
839
+
840
+ return {
841
+ path: urlPath,
842
+ method: 'GET',
843
+ headers: headerParameters,
844
+ query: queryParameters,
845
+ };
846
+ }
847
+
848
+ /**
849
+ * The export file itself: gzip-compressed CSV, verified against its SHA-256 before the first byte (`X-Content-SHA256`), `Content-Disposition` names the file. The one byte stream of the family (exports live in a private bucket); billed once per download. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
850
+ * Download a metric export
851
+ */
852
+ async secExportFileRaw(requestParameters: SecExportFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>> {
853
+ const requestOptions = await this.secExportFileRequestOpts(requestParameters);
854
+ const response = await this.request(requestOptions, initOverrides);
855
+
856
+ return new runtime.BlobApiResponse(response);
857
+ }
858
+
859
+ /**
860
+ * The export file itself: gzip-compressed CSV, verified against its SHA-256 before the first byte (`X-Content-SHA256`), `Content-Disposition` names the file. The one byte stream of the family (exports live in a private bucket); billed once per download. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
861
+ * Download a metric export
862
+ */
863
+ async secExportFile(requestParameters: SecExportFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob> {
864
+ const response = await this.secExportFileRaw(requestParameters, initOverrides);
865
+ return await response.value();
866
+ }
867
+
868
+ /**
869
+ * Creates request options for secExportsFinancialMetrics without sending the request
870
+ */
871
+ async secExportsFinancialMetricsRequestOpts(requestParameters: SecExportsFinancialMetricsRequest): Promise<runtime.RequestOpts> {
872
+ if (requestParameters['metricId'] == null) {
873
+ throw new runtime.RequiredError(
874
+ 'metricId',
875
+ 'Required parameter "metricId" was null or undefined when calling secExportsFinancialMetrics().'
876
+ );
877
+ }
878
+
879
+ if (requestParameters['fiscalYear'] == null) {
880
+ throw new runtime.RequiredError(
881
+ 'fiscalYear',
882
+ 'Required parameter "fiscalYear" was null or undefined when calling secExportsFinancialMetrics().'
883
+ );
884
+ }
885
+
886
+ const queryParameters: any = {};
887
+
888
+ if (requestParameters['metricId'] != null) {
889
+ queryParameters['metric_id'] = requestParameters['metricId'];
890
+ }
891
+
892
+ if (requestParameters['fiscalYear'] != null) {
893
+ queryParameters['fiscal_year'] = requestParameters['fiscalYear'];
894
+ }
895
+
896
+ if (requestParameters['periodType'] != null) {
897
+ queryParameters['period_type'] = requestParameters['periodType'];
898
+ }
899
+
900
+ if (requestParameters['mode'] != null) {
901
+ queryParameters['mode'] = requestParameters['mode'];
902
+ }
903
+
904
+ if (requestParameters['generation'] != null) {
905
+ queryParameters['generation'] = requestParameters['generation'];
906
+ }
907
+
908
+ const headerParameters: runtime.HTTPHeaders = {};
909
+
910
+ if (this.configuration && this.configuration.accessToken) {
911
+ const token = this.configuration.accessToken;
912
+ const tokenString = await token("bearerAuth", []);
913
+
914
+ if (tokenString) {
915
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
916
+ }
917
+ }
918
+
919
+ let urlPath = `/v1/sec/exports/financial-metrics`;
920
+
921
+ return {
922
+ path: urlPath,
923
+ method: 'GET',
924
+ headers: headerParameters,
925
+ query: queryParameters,
926
+ };
927
+ }
928
+
929
+ /**
930
+ * The universe-wide export of one standardized metric for one fiscal year (every covered company), as an immutable versioned file: `ready` with its manifest (rows, bytes, SHA-256, schema, coverage, source boundary, rule lineage) and the `download` route, else its state (`pending` while the current set has not published it). No forward-fill: a company without the value has no row. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
931
+ * Request an annual metric export
932
+ */
933
+ async secExportsFinancialMetricsRaw(requestParameters: SecExportsFinancialMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecFinancialsCatalog200Response>> {
934
+ const requestOptions = await this.secExportsFinancialMetricsRequestOpts(requestParameters);
935
+ const response = await this.request(requestOptions, initOverrides);
936
+
937
+ return new runtime.JSONApiResponse(response, (jsonValue) => SecFinancialsCatalog200ResponseFromJSON(jsonValue));
938
+ }
939
+
940
+ /**
941
+ * The universe-wide export of one standardized metric for one fiscal year (every covered company), as an immutable versioned file: `ready` with its manifest (rows, bytes, SHA-256, schema, coverage, source boundary, rule lineage) and the `download` route, else its state (`pending` while the current set has not published it). No forward-fill: a company without the value has no row. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
942
+ * Request an annual metric export
943
+ */
944
+ async secExportsFinancialMetrics(requestParameters: SecExportsFinancialMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecFinancialsCatalog200Response> {
945
+ const response = await this.secExportsFinancialMetricsRaw(requestParameters, initOverrides);
946
+ return await response.value();
947
+ }
948
+
949
+ /**
950
+ * Creates request options for secFiler without sending the request
951
+ */
952
+ async secFilerRequestOpts(requestParameters: SecFilerRequest): Promise<runtime.RequestOpts> {
953
+ if (requestParameters['cik'] == null) {
954
+ throw new runtime.RequiredError(
955
+ 'cik',
956
+ 'Required parameter "cik" was null or undefined when calling secFiler().'
957
+ );
958
+ }
959
+
960
+ const queryParameters: any = {};
961
+
962
+ const headerParameters: runtime.HTTPHeaders = {};
963
+
964
+ if (this.configuration && this.configuration.accessToken) {
965
+ const token = this.configuration.accessToken;
966
+ const tokenString = await token("bearerAuth", []);
967
+
968
+ if (tokenString) {
969
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
970
+ }
971
+ }
972
+
973
+ let urlPath = `/v1/sec/filers/{cik}`;
974
+ urlPath = urlPath.replace('{cik}', encodeURIComponent(String(requestParameters['cik'])));
975
+
976
+ return {
977
+ path: urlPath,
978
+ method: 'GET',
979
+ headers: headerParameters,
980
+ query: queryParameters,
981
+ };
982
+ }
983
+
984
+ /**
985
+ * One filer: names (with former names and their dates), stated tickers / exchanges as SEC evidence, reviewed successors and what the store serves for it (`scope.permissions`). A pre-IPO issuer or SPAC has no stated ticker; its proposed symbols are on `GET /v1/sec/filers/{cik}/lifecycle`. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
986
+ * SEC filer
987
+ */
988
+ async secFilerRaw(requestParameters: SecFilerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecFiler200Response>> {
989
+ const requestOptions = await this.secFilerRequestOpts(requestParameters);
990
+ const response = await this.request(requestOptions, initOverrides);
991
+
992
+ return new runtime.JSONApiResponse(response, (jsonValue) => SecFiler200ResponseFromJSON(jsonValue));
993
+ }
994
+
995
+ /**
996
+ * One filer: names (with former names and their dates), stated tickers / exchanges as SEC evidence, reviewed successors and what the store serves for it (`scope.permissions`). A pre-IPO issuer or SPAC has no stated ticker; its proposed symbols are on `GET /v1/sec/filers/{cik}/lifecycle`. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
997
+ * SEC filer
998
+ */
999
+ async secFiler(requestParameters: SecFilerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecFiler200Response> {
1000
+ const response = await this.secFilerRaw(requestParameters, initOverrides);
1001
+ return await response.value();
1002
+ }
1003
+
1004
+ /**
1005
+ * Creates request options for secFilerCoverage without sending the request
1006
+ */
1007
+ async secFilerCoverageRequestOpts(requestParameters: SecFilerCoverageRequest): Promise<runtime.RequestOpts> {
1008
+ if (requestParameters['cik'] == null) {
1009
+ throw new runtime.RequiredError(
1010
+ 'cik',
1011
+ 'Required parameter "cik" was null or undefined when calling secFilerCoverage().'
1012
+ );
1013
+ }
1014
+
1015
+ const queryParameters: any = {};
1016
+
1017
+ if (requestParameters['since'] != null) {
1018
+ queryParameters['since'] = (requestParameters['since'] as any).toISOString().substring(0,10);
1019
+ }
1020
+
1021
+ const headerParameters: runtime.HTTPHeaders = {};
1022
+
1023
+ if (this.configuration && this.configuration.accessToken) {
1024
+ const token = this.configuration.accessToken;
1025
+ const tokenString = await token("bearerAuth", []);
1026
+
1027
+ if (tokenString) {
1028
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
1029
+ }
1030
+ }
1031
+
1032
+ let urlPath = `/v1/sec/filers/{cik}/coverage`;
1033
+ urlPath = urlPath.replace('{cik}', encodeURIComponent(String(requestParameters['cik'])));
1034
+
1035
+ return {
1036
+ path: urlPath,
1037
+ method: 'GET',
1038
+ headers: headerParameters,
1039
+ query: queryParameters,
1040
+ };
1041
+ }
1042
+
1043
+ /**
1044
+ * How much of one filer\'s document history the store holds: `held_through` (the contiguous bound — the day before the oldest required document not yet held), required / held / pending counts and the holes, for a window back from `since` (default 365 days, at most 3 years). Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
1045
+ * SEC filer document coverage
1046
+ */
1047
+ async secFilerCoverageRaw(requestParameters: SecFilerCoverageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecFilerCoverage200Response>> {
1048
+ const requestOptions = await this.secFilerCoverageRequestOpts(requestParameters);
1049
+ const response = await this.request(requestOptions, initOverrides);
1050
+
1051
+ return new runtime.JSONApiResponse(response, (jsonValue) => SecFilerCoverage200ResponseFromJSON(jsonValue));
1052
+ }
1053
+
1054
+ /**
1055
+ * How much of one filer\'s document history the store holds: `held_through` (the contiguous bound — the day before the oldest required document not yet held), required / held / pending counts and the holes, for a window back from `since` (default 365 days, at most 3 years). Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
1056
+ * SEC filer document coverage
1057
+ */
1058
+ async secFilerCoverage(requestParameters: SecFilerCoverageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecFilerCoverage200Response> {
1059
+ const response = await this.secFilerCoverageRaw(requestParameters, initOverrides);
1060
+ return await response.value();
1061
+ }
1062
+
1063
+ /**
1064
+ * Creates request options for secFilerLifecycle without sending the request
1065
+ */
1066
+ async secFilerLifecycleRequestOpts(requestParameters: SecFilerLifecycleRequest): Promise<runtime.RequestOpts> {
1067
+ if (requestParameters['cik'] == null) {
1068
+ throw new runtime.RequiredError(
1069
+ 'cik',
1070
+ 'Required parameter "cik" was null or undefined when calling secFilerLifecycle().'
1071
+ );
1072
+ }
1073
+
1074
+ const queryParameters: any = {};
1075
+
1076
+ if (requestParameters['traverse'] != null) {
1077
+ queryParameters['traverse'] = requestParameters['traverse'];
1078
+ }
1079
+
1080
+ if (requestParameters['maxHops'] != null) {
1081
+ queryParameters['max_hops'] = requestParameters['maxHops'];
1082
+ }
1083
+
1084
+ const headerParameters: runtime.HTTPHeaders = {};
1085
+
1086
+ if (this.configuration && this.configuration.accessToken) {
1087
+ const token = this.configuration.accessToken;
1088
+ const tokenString = await token("bearerAuth", []);
1089
+
1090
+ if (tokenString) {
1091
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
1092
+ }
1093
+ }
1094
+
1095
+ let urlPath = `/v1/sec/filers/{cik}/lifecycle`;
1096
+ urlPath = urlPath.replace('{cik}', encodeURIComponent(String(requestParameters['cik'])));
1097
+
1098
+ return {
1099
+ path: urlPath,
1100
+ method: 'GET',
1101
+ headers: headerParameters,
1102
+ query: queryParameters,
1103
+ };
1104
+ }
1105
+
1106
+ /**
1107
+ * One issuer\'s lifecycle: phase (pre-IPO, listed SPAC, listed operating, former listed), registration tracks with their proposed symbols (`symbol_authority: proposed_only`), the verified listing, successions (followed only on request, `traverse`) and separate readiness per family (identity, lifecycle, listing, documents, financials, coverage). Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
1108
+ * SEC issuer lifecycle
1109
+ */
1110
+ async secFilerLifecycleRaw(requestParameters: SecFilerLifecycleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecFilerLifecycle200Response>> {
1111
+ const requestOptions = await this.secFilerLifecycleRequestOpts(requestParameters);
1112
+ const response = await this.request(requestOptions, initOverrides);
1113
+
1114
+ return new runtime.JSONApiResponse(response, (jsonValue) => SecFilerLifecycle200ResponseFromJSON(jsonValue));
1115
+ }
1116
+
1117
+ /**
1118
+ * One issuer\'s lifecycle: phase (pre-IPO, listed SPAC, listed operating, former listed), registration tracks with their proposed symbols (`symbol_authority: proposed_only`), the verified listing, successions (followed only on request, `traverse`) and separate readiness per family (identity, lifecycle, listing, documents, financials, coverage). Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
1119
+ * SEC issuer lifecycle
1120
+ */
1121
+ async secFilerLifecycle(requestParameters: SecFilerLifecycleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecFilerLifecycle200Response> {
1122
+ const response = await this.secFilerLifecycleRaw(requestParameters, initOverrides);
1123
+ return await response.value();
1124
+ }
1125
+
1126
+ /**
1127
+ * Creates request options for secFilers without sending the request
1128
+ */
1129
+ async secFilersRequestOpts(requestParameters: SecFilersRequest): Promise<runtime.RequestOpts> {
1130
+ const queryParameters: any = {};
1131
+
1132
+ if (requestParameters['name'] != null) {
1133
+ queryParameters['name'] = requestParameters['name'];
1134
+ }
1135
+
1136
+ if (requestParameters['ticker'] != null) {
1137
+ queryParameters['ticker'] = requestParameters['ticker'];
1138
+ }
1139
+
1140
+ if (requestParameters['form'] != null) {
1141
+ queryParameters['form'] = requestParameters['form'];
1142
+ }
1143
+
1144
+ if (requestParameters['limit'] != null) {
1145
+ queryParameters['limit'] = requestParameters['limit'];
1146
+ }
1147
+
1148
+ const headerParameters: runtime.HTTPHeaders = {};
1149
+
1150
+ if (this.configuration && this.configuration.accessToken) {
1151
+ const token = this.configuration.accessToken;
1152
+ const tokenString = await token("bearerAuth", []);
1153
+
1154
+ if (tokenString) {
1155
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
1156
+ }
1157
+ }
1158
+
1159
+ let urlPath = `/v1/sec/filers`;
1160
+
1161
+ return {
1162
+ path: urlPath,
1163
+ method: 'GET',
1164
+ headers: headerParameters,
1165
+ query: queryParameters,
1166
+ };
1167
+ }
1168
+
1169
+ /**
1170
+ * Find SEC filers by (former) name, stated ticker or a form they filed. A filer is any SEC party: an operating company, a pre-IPO issuer without a ticker, a fund manager filing 13F without an exchange. Tickers and exchanges are the SEC filing\'s statements (`ticker_authority: sec_statement_only`), never a listing. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
1171
+ * Find SEC filers
1172
+ */
1173
+ async secFilersRaw(requestParameters: SecFilersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecFilers200Response>> {
1174
+ const requestOptions = await this.secFilersRequestOpts(requestParameters);
1175
+ const response = await this.request(requestOptions, initOverrides);
1176
+
1177
+ return new runtime.JSONApiResponse(response, (jsonValue) => SecFilers200ResponseFromJSON(jsonValue));
1178
+ }
1179
+
1180
+ /**
1181
+ * Find SEC filers by (former) name, stated ticker or a form they filed. A filer is any SEC party: an operating company, a pre-IPO issuer without a ticker, a fund manager filing 13F without an exchange. Tickers and exchanges are the SEC filing\'s statements (`ticker_authority: sec_statement_only`), never a listing. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
1182
+ * Find SEC filers
1183
+ */
1184
+ async secFilers(requestParameters: SecFilersRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecFilers200Response> {
1185
+ const response = await this.secFilersRaw(requestParameters, initOverrides);
1186
+ return await response.value();
1187
+ }
1188
+
1189
+ /**
1190
+ * Creates request options for secFiling without sending the request
1191
+ */
1192
+ async secFilingRequestOpts(requestParameters: SecFilingRequest): Promise<runtime.RequestOpts> {
1193
+ if (requestParameters['accession'] == null) {
1194
+ throw new runtime.RequiredError(
1195
+ 'accession',
1196
+ 'Required parameter "accession" was null or undefined when calling secFiling().'
1197
+ );
1198
+ }
1199
+
1200
+ const queryParameters: any = {};
1201
+
1202
+ const headerParameters: runtime.HTTPHeaders = {};
1203
+
1204
+ if (this.configuration && this.configuration.accessToken) {
1205
+ const token = this.configuration.accessToken;
1206
+ const tokenString = await token("bearerAuth", []);
1207
+
1208
+ if (tokenString) {
1209
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
1210
+ }
1211
+ }
1212
+
1213
+ let urlPath = `/v1/sec/filings/{accession}`;
1214
+ urlPath = urlPath.replace('{accession}', encodeURIComponent(String(requestParameters['accession'])));
1215
+
1216
+ return {
1217
+ path: urlPath,
1218
+ method: 'GET',
1219
+ headers: headerParameters,
1220
+ query: queryParameters,
1221
+ };
1222
+ }
1223
+
1224
+ /**
1225
+ * One filing with its document manifest: every document with its role, MIME type, true (uncompressed) size, stored size, readiness and the permanent public URL of the original (`source.url`), the current canonical version id per document, the parties and typed relations. A 13F information table names its structured route (`/holdings`) instead of a body URL. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
1226
+ * SEC filing and its documents
1227
+ */
1228
+ async secFilingRaw(requestParameters: SecFilingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecFiling200Response>> {
1229
+ const requestOptions = await this.secFilingRequestOpts(requestParameters);
1230
+ const response = await this.request(requestOptions, initOverrides);
1231
+
1232
+ return new runtime.JSONApiResponse(response, (jsonValue) => SecFiling200ResponseFromJSON(jsonValue));
1233
+ }
1234
+
1235
+ /**
1236
+ * One filing with its document manifest: every document with its role, MIME type, true (uncompressed) size, stored size, readiness and the permanent public URL of the original (`source.url`), the current canonical version id per document, the parties and typed relations. A 13F information table names its structured route (`/holdings`) instead of a body URL. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
1237
+ * SEC filing and its documents
1238
+ */
1239
+ async secFiling(requestParameters: SecFilingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecFiling200Response> {
1240
+ const response = await this.secFilingRaw(requestParameters, initOverrides);
1241
+ return await response.value();
1242
+ }
1243
+
1244
+ /**
1245
+ * Creates request options for secFilingFacts without sending the request
1246
+ */
1247
+ async secFilingFactsRequestOpts(requestParameters: SecFilingFactsRequest): Promise<runtime.RequestOpts> {
1248
+ if (requestParameters['accession'] == null) {
1249
+ throw new runtime.RequiredError(
1250
+ 'accession',
1251
+ 'Required parameter "accession" was null or undefined when calling secFilingFacts().'
1252
+ );
1253
+ }
1254
+
1255
+ const queryParameters: any = {};
1256
+
1257
+ if (requestParameters['tag'] != null) {
1258
+ queryParameters['tag'] = requestParameters['tag'];
1259
+ }
1260
+
1261
+ const headerParameters: runtime.HTTPHeaders = {};
1262
+
1263
+ if (this.configuration && this.configuration.accessToken) {
1264
+ const token = this.configuration.accessToken;
1265
+ const tokenString = await token("bearerAuth", []);
1266
+
1267
+ if (tokenString) {
1268
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
1269
+ }
1270
+ }
1271
+
1272
+ let urlPath = `/v1/sec/filings/{accession}/facts`;
1273
+ urlPath = urlPath.replace('{accession}', encodeURIComponent(String(requestParameters['accession'])));
1274
+
1275
+ return {
1276
+ path: urlPath,
1277
+ method: 'GET',
1278
+ headers: headerParameters,
1279
+ query: queryParameters,
1280
+ };
1281
+ }
1282
+
1283
+ /**
1284
+ * The XBRL facts SEC\'s own datasets (Financial Statement and Notes) publish for one filing, as released (`release`: dataset, period, hash), exact decimal strings. Raw source rows — the standardized statements are `GET /v1/sec/financials/{cik}/statements/{statement}`. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
1285
+ * SEC dataset facts of a filing
1286
+ */
1287
+ async secFilingFactsRaw(requestParameters: SecFilingFactsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecFilingFacts200Response>> {
1288
+ const requestOptions = await this.secFilingFactsRequestOpts(requestParameters);
1289
+ const response = await this.request(requestOptions, initOverrides);
1290
+
1291
+ return new runtime.JSONApiResponse(response, (jsonValue) => SecFilingFacts200ResponseFromJSON(jsonValue));
1292
+ }
1293
+
1294
+ /**
1295
+ * The XBRL facts SEC\'s own datasets (Financial Statement and Notes) publish for one filing, as released (`release`: dataset, period, hash), exact decimal strings. Raw source rows — the standardized statements are `GET /v1/sec/financials/{cik}/statements/{statement}`. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
1296
+ * SEC dataset facts of a filing
1297
+ */
1298
+ async secFilingFacts(requestParameters: SecFilingFactsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecFilingFacts200Response> {
1299
+ const response = await this.secFilingFactsRaw(requestParameters, initOverrides);
1300
+ return await response.value();
1301
+ }
1302
+
1303
+ /**
1304
+ * Creates request options for secFilingHoldings without sending the request
1305
+ */
1306
+ async secFilingHoldingsRequestOpts(requestParameters: SecFilingHoldingsRequest): Promise<runtime.RequestOpts> {
1307
+ if (requestParameters['accession'] == null) {
1308
+ throw new runtime.RequiredError(
1309
+ 'accession',
1310
+ 'Required parameter "accession" was null or undefined when calling secFilingHoldings().'
1311
+ );
1312
+ }
1313
+
1314
+ const queryParameters: any = {};
1315
+
1316
+ if (requestParameters['after'] != null) {
1317
+ queryParameters['after'] = requestParameters['after'];
1318
+ }
1319
+
1320
+ if (requestParameters['limit'] != null) {
1321
+ queryParameters['limit'] = requestParameters['limit'];
1322
+ }
1323
+
1324
+ const headerParameters: runtime.HTTPHeaders = {};
1325
+
1326
+ if (this.configuration && this.configuration.accessToken) {
1327
+ const token = this.configuration.accessToken;
1328
+ const tokenString = await token("bearerAuth", []);
1329
+
1330
+ if (tokenString) {
1331
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
1332
+ }
1333
+ }
1334
+
1335
+ let urlPath = `/v1/sec/filings/{accession}/holdings`;
1336
+ urlPath = urlPath.replace('{accession}', encodeURIComponent(String(requestParameters['accession'])));
1337
+
1338
+ return {
1339
+ path: urlPath,
1340
+ method: 'GET',
1341
+ headers: headerParameters,
1342
+ query: queryParameters,
1343
+ };
1344
+ }
1345
+
1346
+ /**
1347
+ * The information table of one 13F filing as SEC\'s 13F dataset released it, in pages (`summary` first: row count and value). Values are the manager-reported values (the 2023-01-03 dollar rule applied). Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
1348
+ * Holdings of a 13F filing
1349
+ */
1350
+ async secFilingHoldingsRaw(requestParameters: SecFilingHoldingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecFilingHoldings200Response>> {
1351
+ const requestOptions = await this.secFilingHoldingsRequestOpts(requestParameters);
1352
+ const response = await this.request(requestOptions, initOverrides);
1353
+
1354
+ return new runtime.JSONApiResponse(response, (jsonValue) => SecFilingHoldings200ResponseFromJSON(jsonValue));
1355
+ }
1356
+
1357
+ /**
1358
+ * The information table of one 13F filing as SEC\'s 13F dataset released it, in pages (`summary` first: row count and value). Values are the manager-reported values (the 2023-01-03 dollar rule applied). Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
1359
+ * Holdings of a 13F filing
1360
+ */
1361
+ async secFilingHoldings(requestParameters: SecFilingHoldingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecFilingHoldings200Response> {
1362
+ const response = await this.secFilingHoldingsRaw(requestParameters, initOverrides);
1363
+ return await response.value();
1364
+ }
1365
+
1366
+ /**
1367
+ * Creates request options for secFilingNotes without sending the request
1368
+ */
1369
+ async secFilingNotesRequestOpts(requestParameters: SecFilingNotesRequest): Promise<runtime.RequestOpts> {
1370
+ if (requestParameters['accession'] == null) {
1371
+ throw new runtime.RequiredError(
1372
+ 'accession',
1373
+ 'Required parameter "accession" was null or undefined when calling secFilingNotes().'
1374
+ );
1375
+ }
1376
+
1377
+ const queryParameters: any = {};
1378
+
1379
+ if (requestParameters['tag'] != null) {
1380
+ queryParameters['tag'] = requestParameters['tag'];
1381
+ }
1382
+
1383
+ const headerParameters: runtime.HTTPHeaders = {};
1384
+
1385
+ if (this.configuration && this.configuration.accessToken) {
1386
+ const token = this.configuration.accessToken;
1387
+ const tokenString = await token("bearerAuth", []);
1388
+
1389
+ if (tokenString) {
1390
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
1391
+ }
1392
+ }
1393
+
1394
+ let urlPath = `/v1/sec/filings/{accession}/notes`;
1395
+ urlPath = urlPath.replace('{accession}', encodeURIComponent(String(requestParameters['accession'])));
1396
+
1397
+ return {
1398
+ path: urlPath,
1399
+ method: 'GET',
1400
+ headers: headerParameters,
1401
+ query: queryParameters,
1402
+ };
1403
+ }
1404
+
1405
+ /**
1406
+ * The text facts (notes, policies) SEC\'s Financial Statement and Notes dataset publishes for one filing, as released. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
1407
+ * SEC dataset text notes of a filing
1408
+ */
1409
+ async secFilingNotesRaw(requestParameters: SecFilingNotesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecFilingFacts200Response>> {
1410
+ const requestOptions = await this.secFilingNotesRequestOpts(requestParameters);
1411
+ const response = await this.request(requestOptions, initOverrides);
1412
+
1413
+ return new runtime.JSONApiResponse(response, (jsonValue) => SecFilingFacts200ResponseFromJSON(jsonValue));
1414
+ }
1415
+
1416
+ /**
1417
+ * The text facts (notes, policies) SEC\'s Financial Statement and Notes dataset publishes for one filing, as released. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
1418
+ * SEC dataset text notes of a filing
1419
+ */
1420
+ async secFilingNotes(requestParameters: SecFilingNotesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecFilingFacts200Response> {
1421
+ const response = await this.secFilingNotesRaw(requestParameters, initOverrides);
1422
+ return await response.value();
1423
+ }
1424
+
1425
+ /**
1426
+ * Creates request options for secFilingReviewChain without sending the request
1427
+ */
1428
+ async secFilingReviewChainRequestOpts(requestParameters: SecFilingReviewChainRequest): Promise<runtime.RequestOpts> {
1429
+ if (requestParameters['accession'] == null) {
1430
+ throw new runtime.RequiredError(
1431
+ 'accession',
1432
+ 'Required parameter "accession" was null or undefined when calling secFilingReviewChain().'
1433
+ );
1434
+ }
1435
+
1436
+ const queryParameters: any = {};
1437
+
1438
+ if (requestParameters['maxDepth'] != null) {
1439
+ queryParameters['max_depth'] = requestParameters['maxDepth'];
1440
+ }
1441
+
1442
+ if (requestParameters['maxNodes'] != null) {
1443
+ queryParameters['max_nodes'] = requestParameters['maxNodes'];
1444
+ }
1445
+
1446
+ const headerParameters: runtime.HTTPHeaders = {};
1447
+
1448
+ if (this.configuration && this.configuration.accessToken) {
1449
+ const token = this.configuration.accessToken;
1450
+ const tokenString = await token("bearerAuth", []);
1451
+
1452
+ if (tokenString) {
1453
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
1454
+ }
1455
+ }
1456
+
1457
+ let urlPath = `/v1/sec/filings/{accession}/review-chain`;
1458
+ urlPath = urlPath.replace('{accession}', encodeURIComponent(String(requestParameters['accession'])));
1459
+
1460
+ return {
1461
+ path: urlPath,
1462
+ method: 'GET',
1463
+ headers: headerParameters,
1464
+ query: queryParameters,
1465
+ };
1466
+ }
1467
+
1468
+ /**
1469
+ * The bounded SEC review graph around one filing: letters and responses (nodes, with whether the store holds them), confirmed edges (unconfirmed ones listed, never followed), text / PDF twins and what the graph cannot claim (`completeness`). Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
1470
+ * SEC review chain of a filing
1471
+ */
1472
+ async secFilingReviewChainRaw(requestParameters: SecFilingReviewChainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecFilingReviewChain200Response>> {
1473
+ const requestOptions = await this.secFilingReviewChainRequestOpts(requestParameters);
1474
+ const response = await this.request(requestOptions, initOverrides);
1475
+
1476
+ return new runtime.JSONApiResponse(response, (jsonValue) => SecFilingReviewChain200ResponseFromJSON(jsonValue));
1477
+ }
1478
+
1479
+ /**
1480
+ * The bounded SEC review graph around one filing: letters and responses (nodes, with whether the store holds them), confirmed edges (unconfirmed ones listed, never followed), text / PDF twins and what the graph cannot claim (`completeness`). Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
1481
+ * SEC review chain of a filing
1482
+ */
1483
+ async secFilingReviewChain(requestParameters: SecFilingReviewChainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecFilingReviewChain200Response> {
1484
+ const response = await this.secFilingReviewChainRaw(requestParameters, initOverrides);
1485
+ return await response.value();
1486
+ }
1487
+
1488
+ /**
1489
+ * Creates request options for secFilingReviewRelations without sending the request
1490
+ */
1491
+ async secFilingReviewRelationsRequestOpts(requestParameters: SecFilingReviewRelationsRequest): Promise<runtime.RequestOpts> {
1492
+ if (requestParameters['accession'] == null) {
1493
+ throw new runtime.RequiredError(
1494
+ 'accession',
1495
+ 'Required parameter "accession" was null or undefined when calling secFilingReviewRelations().'
1496
+ );
1497
+ }
1498
+
1499
+ const queryParameters: any = {};
1500
+
1501
+ if (requestParameters['direction'] != null) {
1502
+ queryParameters['direction'] = requestParameters['direction'];
1503
+ }
1504
+
1505
+ if (requestParameters['kind'] != null) {
1506
+ queryParameters['kind'] = requestParameters['kind'];
1507
+ }
1508
+
1509
+ if (requestParameters['history'] != null) {
1510
+ queryParameters['history'] = requestParameters['history'];
1511
+ }
1512
+
1513
+ if (requestParameters['cursor'] != null) {
1514
+ queryParameters['cursor'] = requestParameters['cursor'];
1515
+ }
1516
+
1517
+ if (requestParameters['limit'] != null) {
1518
+ queryParameters['limit'] = requestParameters['limit'];
1519
+ }
1520
+
1521
+ const headerParameters: runtime.HTTPHeaders = {};
1522
+
1523
+ if (this.configuration && this.configuration.accessToken) {
1524
+ const token = this.configuration.accessToken;
1525
+ const tokenString = await token("bearerAuth", []);
1526
+
1527
+ if (tokenString) {
1528
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
1529
+ }
1530
+ }
1531
+
1532
+ let urlPath = `/v1/sec/filings/{accession}/review-relations`;
1533
+ urlPath = urlPath.replace('{accession}', encodeURIComponent(String(requestParameters['accession'])));
1534
+
1535
+ return {
1536
+ path: urlPath,
1537
+ method: 'GET',
1538
+ headers: headerParameters,
1539
+ query: queryParameters,
1540
+ };
1541
+ }
1542
+
1543
+ /**
1544
+ * The SEC comment-letter relations from or to one filing (UPLOAD / CORRESP letters, the filings they review, text / PDF twins), with their status, exact quotes and candidates. `history=true` adds superseded observations. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
1545
+ * SEC review relations of a filing
1546
+ */
1547
+ async secFilingReviewRelationsRaw(requestParameters: SecFilingReviewRelationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecFilingReviewRelations200Response>> {
1548
+ const requestOptions = await this.secFilingReviewRelationsRequestOpts(requestParameters);
1549
+ const response = await this.request(requestOptions, initOverrides);
1550
+
1551
+ return new runtime.JSONApiResponse(response, (jsonValue) => SecFilingReviewRelations200ResponseFromJSON(jsonValue));
1552
+ }
1553
+
1554
+ /**
1555
+ * The SEC comment-letter relations from or to one filing (UPLOAD / CORRESP letters, the filings they review, text / PDF twins), with their status, exact quotes and candidates. `history=true` adds superseded observations. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
1556
+ * SEC review relations of a filing
1557
+ */
1558
+ async secFilingReviewRelations(requestParameters: SecFilingReviewRelationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecFilingReviewRelations200Response> {
1559
+ const response = await this.secFilingReviewRelationsRaw(requestParameters, initOverrides);
1560
+ return await response.value();
1561
+ }
1562
+
1563
+ /**
1564
+ * Creates request options for secFilings without sending the request
1565
+ */
1566
+ async secFilingsRequestOpts(requestParameters: SecFilingsRequest): Promise<runtime.RequestOpts> {
1567
+ if (requestParameters['identifier'] == null) {
1568
+ throw new runtime.RequiredError(
1569
+ 'identifier',
1570
+ 'Required parameter "identifier" was null or undefined when calling secFilings().'
1571
+ );
1572
+ }
1573
+
1574
+ const queryParameters: any = {};
1575
+
1576
+ if (requestParameters['identifier'] != null) {
1577
+ queryParameters['identifier'] = requestParameters['identifier'];
1578
+ }
1579
+
1580
+ if (requestParameters['form'] != null) {
1581
+ queryParameters['form'] = requestParameters['form'];
1582
+ }
1583
+
1584
+ if (requestParameters['filedFrom'] != null) {
1585
+ queryParameters['filed_from'] = (requestParameters['filedFrom'] as any).toISOString().substring(0,10);
1586
+ }
1587
+
1588
+ if (requestParameters['filedTo'] != null) {
1589
+ queryParameters['filed_to'] = (requestParameters['filedTo'] as any).toISOString().substring(0,10);
1590
+ }
1591
+
1592
+ if (requestParameters['order'] != null) {
1593
+ queryParameters['order'] = requestParameters['order'];
1594
+ }
1595
+
1596
+ if (requestParameters['cursor'] != null) {
1597
+ queryParameters['cursor'] = requestParameters['cursor'];
1598
+ }
1599
+
1600
+ if (requestParameters['limit'] != null) {
1601
+ queryParameters['limit'] = requestParameters['limit'];
1602
+ }
1603
+
1604
+ const headerParameters: runtime.HTTPHeaders = {};
1605
+
1606
+ if (this.configuration && this.configuration.accessToken) {
1607
+ const token = this.configuration.accessToken;
1608
+ const tokenString = await token("bearerAuth", []);
1609
+
1610
+ if (tokenString) {
1611
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
1612
+ }
1613
+ }
1614
+
1615
+ let urlPath = `/v1/sec/filings`;
1616
+
1617
+ return {
1618
+ path: urlPath,
1619
+ method: 'GET',
1620
+ headers: headerParameters,
1621
+ query: queryParameters,
1622
+ };
1623
+ }
1624
+
1625
+ /**
1626
+ * One filer\'s SEC filings, newest first: form, filing / report date, acceptance (null when SEC never stated it), 8-K items, primary document, the filer\'s roles. `identifier` is a ticker (a ticker the filer stated to the SEC) or a CIK — a CIK also finds a pre-IPO issuer or a fund manager without a ticker. `form_facet` lists every form the filer filed with its count (whatever the page\'s filters); OTC / ABS filings are never listed and are counted in `withheld`. Open a filing\'s documents with `GET /v1/sec/filings/{accession}`. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
1627
+ * SEC filings of a filer
1628
+ */
1629
+ async secFilingsRaw(requestParameters: SecFilingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecFilings200Response>> {
1630
+ const requestOptions = await this.secFilingsRequestOpts(requestParameters);
1631
+ const response = await this.request(requestOptions, initOverrides);
1632
+
1633
+ return new runtime.JSONApiResponse(response, (jsonValue) => SecFilings200ResponseFromJSON(jsonValue));
1634
+ }
1635
+
1636
+ /**
1637
+ * One filer\'s SEC filings, newest first: form, filing / report date, acceptance (null when SEC never stated it), 8-K items, primary document, the filer\'s roles. `identifier` is a ticker (a ticker the filer stated to the SEC) or a CIK — a CIK also finds a pre-IPO issuer or a fund manager without a ticker. `form_facet` lists every form the filer filed with its count (whatever the page\'s filters); OTC / ABS filings are never listed and are counted in `withheld`. Open a filing\'s documents with `GET /v1/sec/filings/{accession}`. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
1638
+ * SEC filings of a filer
1639
+ */
1640
+ async secFilings(requestParameters: SecFilingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecFilings200Response> {
1641
+ const response = await this.secFilingsRaw(requestParameters, initOverrides);
1642
+ return await response.value();
1643
+ }
1644
+
1645
+ /**
1646
+ * Creates request options for secFinancialsCatalog without sending the request
1647
+ */
1648
+ async secFinancialsCatalogRequestOpts(requestParameters: SecFinancialsCatalogRequest): Promise<runtime.RequestOpts> {
1649
+ const queryParameters: any = {};
1650
+
1651
+ if (requestParameters['statement'] != null) {
1652
+ queryParameters['statement'] = requestParameters['statement'];
1653
+ }
1654
+
1655
+ if (requestParameters['metricId'] != null) {
1656
+ queryParameters['metric_id'] = requestParameters['metricId'];
1657
+ }
1658
+
1659
+ const headerParameters: runtime.HTTPHeaders = {};
1660
+
1661
+ if (this.configuration && this.configuration.accessToken) {
1662
+ const token = this.configuration.accessToken;
1663
+ const tokenString = await token("bearerAuth", []);
1664
+
1665
+ if (tokenString) {
1666
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
1667
+ }
1668
+ }
1669
+
1670
+ let urlPath = `/v1/sec/financials/catalog`;
1671
+
1672
+ return {
1673
+ path: urlPath,
1674
+ method: 'GET',
1675
+ headers: headerParameters,
1676
+ query: queryParameters,
1677
+ };
1678
+ }
1679
+
1680
+ /**
1681
+ * The versioned rule catalog behind the standardized statements (`catalog_version`, rules per metric): which XBRL concepts and formulas produce each standardized metric. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
1682
+ * Standardization rule catalog
1683
+ */
1684
+ async secFinancialsCatalogRaw(requestParameters: SecFinancialsCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecFinancialsCatalog200Response>> {
1685
+ const requestOptions = await this.secFinancialsCatalogRequestOpts(requestParameters);
1686
+ const response = await this.request(requestOptions, initOverrides);
1687
+
1688
+ return new runtime.JSONApiResponse(response, (jsonValue) => SecFinancialsCatalog200ResponseFromJSON(jsonValue));
1689
+ }
1690
+
1691
+ /**
1692
+ * The versioned rule catalog behind the standardized statements (`catalog_version`, rules per metric): which XBRL concepts and formulas produce each standardized metric. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
1693
+ * Standardization rule catalog
1694
+ */
1695
+ async secFinancialsCatalog(requestParameters: SecFinancialsCatalogRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecFinancialsCatalog200Response> {
1696
+ const response = await this.secFinancialsCatalogRaw(requestParameters, initOverrides);
1697
+ return await response.value();
1698
+ }
1699
+
1700
+ /**
1701
+ * Creates request options for secFinancialsFact without sending the request
1702
+ */
1703
+ async secFinancialsFactRequestOpts(requestParameters: SecFinancialsFactRequest): Promise<runtime.RequestOpts> {
1704
+ if (requestParameters['id'] == null) {
1705
+ throw new runtime.RequiredError(
1706
+ 'id',
1707
+ 'Required parameter "id" was null or undefined when calling secFinancialsFact().'
1708
+ );
1709
+ }
1710
+
1711
+ const queryParameters: any = {};
1712
+
1713
+ if (requestParameters['id'] != null) {
1714
+ queryParameters['id'] = requestParameters['id'];
1715
+ }
1716
+
1717
+ if (requestParameters['maxDepth'] != null) {
1718
+ queryParameters['max_depth'] = requestParameters['maxDepth'];
1719
+ }
1720
+
1721
+ if (requestParameters['maxMembers'] != null) {
1722
+ queryParameters['max_members'] = requestParameters['maxMembers'];
1723
+ }
1724
+
1725
+ if (requestParameters['places'] != null) {
1726
+ queryParameters['places'] = requestParameters['places'];
1727
+ }
1728
+
1729
+ const headerParameters: runtime.HTTPHeaders = {};
1730
+
1731
+ if (this.configuration && this.configuration.accessToken) {
1732
+ const token = this.configuration.accessToken;
1733
+ const tokenString = await token("bearerAuth", []);
1734
+
1735
+ if (tokenString) {
1736
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
1737
+ }
1738
+ }
1739
+
1740
+ let urlPath = `/v1/sec/financials/facts`;
1741
+
1742
+ return {
1743
+ path: urlPath,
1744
+ method: 'GET',
1745
+ headers: headerParameters,
1746
+ query: queryParameters,
1747
+ };
1748
+ }
1749
+
1750
+ /**
1751
+ * One standardized fact explained: its value, the applied rule (only from a matching receipt; a current-catalog candidate is labelled apart), its source facts with original and annotated places, the bounded formula walk (several operands for a formula value) and quality flags. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
1752
+ * Explain a standardized fact
1753
+ */
1754
+ async secFinancialsFactRaw(requestParameters: SecFinancialsFactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecFinancialsCatalog200Response>> {
1755
+ const requestOptions = await this.secFinancialsFactRequestOpts(requestParameters);
1756
+ const response = await this.request(requestOptions, initOverrides);
1757
+
1758
+ return new runtime.JSONApiResponse(response, (jsonValue) => SecFinancialsCatalog200ResponseFromJSON(jsonValue));
1759
+ }
1760
+
1761
+ /**
1762
+ * One standardized fact explained: its value, the applied rule (only from a matching receipt; a current-catalog candidate is labelled apart), its source facts with original and annotated places, the bounded formula walk (several operands for a formula value) and quality flags. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
1763
+ * Explain a standardized fact
1764
+ */
1765
+ async secFinancialsFact(requestParameters: SecFinancialsFactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecFinancialsCatalog200Response> {
1766
+ const response = await this.secFinancialsFactRaw(requestParameters, initOverrides);
1767
+ return await response.value();
1768
+ }
1769
+
1770
+ /**
1771
+ * Creates request options for secFinancialsStatement without sending the request
1772
+ */
1773
+ async secFinancialsStatementRequestOpts(requestParameters: SecFinancialsStatementRequest): Promise<runtime.RequestOpts> {
1774
+ if (requestParameters['cik'] == null) {
1775
+ throw new runtime.RequiredError(
1776
+ 'cik',
1777
+ 'Required parameter "cik" was null or undefined when calling secFinancialsStatement().'
1778
+ );
1779
+ }
1780
+
1781
+ if (requestParameters['statement'] == null) {
1782
+ throw new runtime.RequiredError(
1783
+ 'statement',
1784
+ 'Required parameter "statement" was null or undefined when calling secFinancialsStatement().'
1785
+ );
1786
+ }
1787
+
1788
+ const queryParameters: any = {};
1789
+
1790
+ if (requestParameters['periodType'] != null) {
1791
+ queryParameters['period_type'] = requestParameters['periodType'];
1792
+ }
1793
+
1794
+ if (requestParameters['fiscalYearFrom'] != null) {
1795
+ queryParameters['fiscal_year_from'] = requestParameters['fiscalYearFrom'];
1796
+ }
1797
+
1798
+ if (requestParameters['fiscalYearTo'] != null) {
1799
+ queryParameters['fiscal_year_to'] = requestParameters['fiscalYearTo'];
1800
+ }
1801
+
1802
+ if (requestParameters['metricId'] != null) {
1803
+ queryParameters['metric_id'] = requestParameters['metricId'];
1804
+ }
1805
+
1806
+ if (requestParameters['otherEvidence'] != null) {
1807
+ queryParameters['other_evidence'] = requestParameters['otherEvidence'];
1808
+ }
1809
+
1810
+ if (requestParameters['limit'] != null) {
1811
+ queryParameters['limit'] = requestParameters['limit'];
1812
+ }
1813
+
1814
+ const headerParameters: runtime.HTTPHeaders = {};
1815
+
1816
+ if (this.configuration && this.configuration.accessToken) {
1817
+ const token = this.configuration.accessToken;
1818
+ const tokenString = await token("bearerAuth", []);
1819
+
1820
+ if (tokenString) {
1821
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
1822
+ }
1823
+ }
1824
+
1825
+ let urlPath = `/v1/sec/financials/{cik}/statements/{statement}`;
1826
+ urlPath = urlPath.replace('{cik}', encodeURIComponent(String(requestParameters['cik'])));
1827
+ urlPath = urlPath.replace('{statement}', encodeURIComponent(String(requestParameters['statement'])));
1828
+
1829
+ return {
1830
+ path: urlPath,
1831
+ method: 'GET',
1832
+ headers: headerParameters,
1833
+ query: queryParameters,
1834
+ };
1835
+ }
1836
+
1837
+ /**
1838
+ * A company\'s standardized statement cells (the values of `/v1/standardized/_*`, unchanged) with their provenance: the applied rule from a matching receipt (`recorded`; `stale` / `legacy_unrecorded` / `not_observed` otherwise — never reconstructed), the source facts and their places. Values are exact decimal strings. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
1839
+ * Standardized statement with provenance
1840
+ */
1841
+ async secFinancialsStatementRaw(requestParameters: SecFinancialsStatementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecFinancialsCatalog200Response>> {
1842
+ const requestOptions = await this.secFinancialsStatementRequestOpts(requestParameters);
1843
+ const response = await this.request(requestOptions, initOverrides);
1844
+
1845
+ return new runtime.JSONApiResponse(response, (jsonValue) => SecFinancialsCatalog200ResponseFromJSON(jsonValue));
1846
+ }
1847
+
1848
+ /**
1849
+ * A company\'s standardized statement cells (the values of `/v1/standardized/_*`, unchanged) with their provenance: the applied rule from a matching receipt (`recorded`; `stale` / `legacy_unrecorded` / `not_observed` otherwise — never reconstructed), the source facts and their places. Values are exact decimal strings. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
1850
+ * Standardized statement with provenance
1851
+ */
1852
+ async secFinancialsStatement(requestParameters: SecFinancialsStatementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecFinancialsCatalog200Response> {
1853
+ const response = await this.secFinancialsStatementRaw(requestParameters, initOverrides);
1854
+ return await response.value();
1855
+ }
1856
+
1857
+ /**
1858
+ * Creates request options for secHoldingsDeltas without sending the request
1859
+ */
1860
+ async secHoldingsDeltasRequestOpts(requestParameters: SecHoldingsDeltasRequest): Promise<runtime.RequestOpts> {
1861
+ if (requestParameters['periodEnd'] == null) {
1862
+ throw new runtime.RequiredError(
1863
+ 'periodEnd',
1864
+ 'Required parameter "periodEnd" was null or undefined when calling secHoldingsDeltas().'
1865
+ );
1866
+ }
1867
+
1868
+ const queryParameters: any = {};
1869
+
1870
+ if (requestParameters['periodEnd'] != null) {
1871
+ queryParameters['period_end'] = (requestParameters['periodEnd'] as any).toISOString().substring(0,10);
1872
+ }
1873
+
1874
+ if (requestParameters['priorPeriodEnd'] != null) {
1875
+ queryParameters['prior_period_end'] = (requestParameters['priorPeriodEnd'] as any).toISOString().substring(0,10);
1876
+ }
1877
+
1878
+ if (requestParameters['cusip'] != null) {
1879
+ queryParameters['cusip'] = requestParameters['cusip'];
1880
+ }
1881
+
1882
+ if (requestParameters['symbol'] != null) {
1883
+ queryParameters['symbol'] = requestParameters['symbol'];
1884
+ }
1885
+
1886
+ if (requestParameters['issuerCik'] != null) {
1887
+ queryParameters['issuer_cik'] = requestParameters['issuerCik'];
1888
+ }
1889
+
1890
+ if (requestParameters['instruments'] != null) {
1891
+ queryParameters['instruments'] = requestParameters['instruments'];
1892
+ }
1893
+
1894
+ if (requestParameters['pinnedAt'] != null) {
1895
+ queryParameters['pinned_at'] = (requestParameters['pinnedAt'] as any).toISOString();
1896
+ }
1897
+
1898
+ if (requestParameters['cursor'] != null) {
1899
+ queryParameters['cursor'] = requestParameters['cursor'];
1900
+ }
1901
+
1902
+ if (requestParameters['limit'] != null) {
1903
+ queryParameters['limit'] = requestParameters['limit'];
1904
+ }
1905
+
1906
+ const headerParameters: runtime.HTTPHeaders = {};
1907
+
1908
+ if (this.configuration && this.configuration.accessToken) {
1909
+ const token = this.configuration.accessToken;
1910
+ const tokenString = await token("bearerAuth", []);
1911
+
1912
+ if (tokenString) {
1913
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
1914
+ }
1915
+ }
1916
+
1917
+ let urlPath = `/v1/sec/holdings/deltas`;
1918
+
1919
+ return {
1920
+ path: urlPath,
1921
+ method: 'GET',
1922
+ headers: headerParameters,
1923
+ query: queryParameters,
1924
+ };
1925
+ }
1926
+
1927
+ /**
1928
+ * Quarter-over-quarter changes of every manager\'s reported position in one security (new, added, reduced, sold out), each against the manager\'s own prior report. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
1929
+ * Position changes in a security (13F)
1930
+ */
1931
+ async secHoldingsDeltasRaw(requestParameters: SecHoldingsDeltasRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecHoldingsHolders200Response>> {
1932
+ const requestOptions = await this.secHoldingsDeltasRequestOpts(requestParameters);
1933
+ const response = await this.request(requestOptions, initOverrides);
1934
+
1935
+ return new runtime.JSONApiResponse(response, (jsonValue) => SecHoldingsHolders200ResponseFromJSON(jsonValue));
1936
+ }
1937
+
1938
+ /**
1939
+ * Quarter-over-quarter changes of every manager\'s reported position in one security (new, added, reduced, sold out), each against the manager\'s own prior report. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
1940
+ * Position changes in a security (13F)
1941
+ */
1942
+ async secHoldingsDeltas(requestParameters: SecHoldingsDeltasRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecHoldingsHolders200Response> {
1943
+ const response = await this.secHoldingsDeltasRaw(requestParameters, initOverrides);
1944
+ return await response.value();
1945
+ }
1946
+
1947
+ /**
1948
+ * Creates request options for secHoldingsFormFilers without sending the request
1949
+ */
1950
+ async secHoldingsFormFilersRequestOpts(requestParameters: SecHoldingsFormFilersRequest): Promise<runtime.RequestOpts> {
1951
+ if (requestParameters['form'] == null) {
1952
+ throw new runtime.RequiredError(
1953
+ 'form',
1954
+ 'Required parameter "form" was null or undefined when calling secHoldingsFormFilers().'
1955
+ );
1956
+ }
1957
+
1958
+ const queryParameters: any = {};
1959
+
1960
+ if (requestParameters['form'] != null) {
1961
+ queryParameters['form'] = requestParameters['form'];
1962
+ }
1963
+
1964
+ if (requestParameters['exact'] != null) {
1965
+ queryParameters['exact'] = requestParameters['exact'];
1966
+ }
1967
+
1968
+ if (requestParameters['name'] != null) {
1969
+ queryParameters['name'] = requestParameters['name'];
1970
+ }
1971
+
1972
+ if (requestParameters['cik'] != null) {
1973
+ queryParameters['cik'] = requestParameters['cik'];
1974
+ }
1975
+
1976
+ if (requestParameters['cursor'] != null) {
1977
+ queryParameters['cursor'] = requestParameters['cursor'];
1978
+ }
1979
+
1980
+ if (requestParameters['limit'] != null) {
1981
+ queryParameters['limit'] = requestParameters['limit'];
1982
+ }
1983
+
1984
+ const headerParameters: runtime.HTTPHeaders = {};
1985
+
1986
+ if (this.configuration && this.configuration.accessToken) {
1987
+ const token = this.configuration.accessToken;
1988
+ const tokenString = await token("bearerAuth", []);
1989
+
1990
+ if (tokenString) {
1991
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
1992
+ }
1993
+ }
1994
+
1995
+ let urlPath = `/v1/sec/holdings/form-filers`;
1996
+
1997
+ return {
1998
+ path: urlPath,
1999
+ method: 'GET',
2000
+ headers: headerParameters,
2001
+ query: queryParameters,
2002
+ };
2003
+ }
2004
+
2005
+ /**
2006
+ * Every filer of one SEC form (e.g. all 13F-HR managers), with or without a ticker or exchange, by name or CIK. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
2007
+ * Filers of an SEC form
2008
+ */
2009
+ async secHoldingsFormFilersRaw(requestParameters: SecHoldingsFormFilersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecHoldingsHolders200Response>> {
2010
+ const requestOptions = await this.secHoldingsFormFilersRequestOpts(requestParameters);
2011
+ const response = await this.request(requestOptions, initOverrides);
2012
+
2013
+ return new runtime.JSONApiResponse(response, (jsonValue) => SecHoldingsHolders200ResponseFromJSON(jsonValue));
2014
+ }
2015
+
2016
+ /**
2017
+ * Every filer of one SEC form (e.g. all 13F-HR managers), with or without a ticker or exchange, by name or CIK. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
2018
+ * Filers of an SEC form
2019
+ */
2020
+ async secHoldingsFormFilers(requestParameters: SecHoldingsFormFilersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecHoldingsHolders200Response> {
2021
+ const response = await this.secHoldingsFormFilersRaw(requestParameters, initOverrides);
2022
+ return await response.value();
2023
+ }
2024
+
2025
+ /**
2026
+ * Creates request options for secHoldingsHolders without sending the request
2027
+ */
2028
+ async secHoldingsHoldersRequestOpts(requestParameters: SecHoldingsHoldersRequest): Promise<runtime.RequestOpts> {
2029
+ if (requestParameters['periodEnd'] == null) {
2030
+ throw new runtime.RequiredError(
2031
+ 'periodEnd',
2032
+ 'Required parameter "periodEnd" was null or undefined when calling secHoldingsHolders().'
2033
+ );
2034
+ }
2035
+
2036
+ const queryParameters: any = {};
2037
+
2038
+ if (requestParameters['periodEnd'] != null) {
2039
+ queryParameters['period_end'] = (requestParameters['periodEnd'] as any).toISOString().substring(0,10);
2040
+ }
2041
+
2042
+ if (requestParameters['cusip'] != null) {
2043
+ queryParameters['cusip'] = requestParameters['cusip'];
2044
+ }
2045
+
2046
+ if (requestParameters['symbol'] != null) {
2047
+ queryParameters['symbol'] = requestParameters['symbol'];
2048
+ }
2049
+
2050
+ if (requestParameters['issuerCik'] != null) {
2051
+ queryParameters['issuer_cik'] = requestParameters['issuerCik'];
2052
+ }
2053
+
2054
+ if (requestParameters['instruments'] != null) {
2055
+ queryParameters['instruments'] = requestParameters['instruments'];
2056
+ }
2057
+
2058
+ if (requestParameters['pinnedAt'] != null) {
2059
+ queryParameters['pinned_at'] = (requestParameters['pinnedAt'] as any).toISOString();
2060
+ }
2061
+
2062
+ if (requestParameters['cursor'] != null) {
2063
+ queryParameters['cursor'] = requestParameters['cursor'];
2064
+ }
2065
+
2066
+ if (requestParameters['limit'] != null) {
2067
+ queryParameters['limit'] = requestParameters['limit'];
2068
+ }
2069
+
2070
+ const headerParameters: runtime.HTTPHeaders = {};
2071
+
2072
+ if (this.configuration && this.configuration.accessToken) {
2073
+ const token = this.configuration.accessToken;
2074
+ const tokenString = await token("bearerAuth", []);
2075
+
2076
+ if (tokenString) {
2077
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
2078
+ }
2079
+ }
2080
+
2081
+ let urlPath = `/v1/sec/holdings/holders`;
2082
+
2083
+ return {
2084
+ path: urlPath,
2085
+ method: 'GET',
2086
+ headers: headerParameters,
2087
+ query: queryParameters,
2088
+ };
2089
+ }
2090
+
2091
+ /**
2092
+ * Every 13F manager reporting a security for one quarter (all public 13F filers, historical; one row per manager report as filed, never a cross-manager sum), with how the CUSIP / symbol / issuer resolved (`identity`), the reconciled coverage boundary and the counting policy. Amendments and restatements follow `counting_policy`. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
2093
+ * Institutional holders of a security (13F)
2094
+ */
2095
+ async secHoldingsHoldersRaw(requestParameters: SecHoldingsHoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecHoldingsHolders200Response>> {
2096
+ const requestOptions = await this.secHoldingsHoldersRequestOpts(requestParameters);
2097
+ const response = await this.request(requestOptions, initOverrides);
2098
+
2099
+ return new runtime.JSONApiResponse(response, (jsonValue) => SecHoldingsHolders200ResponseFromJSON(jsonValue));
2100
+ }
2101
+
2102
+ /**
2103
+ * Every 13F manager reporting a security for one quarter (all public 13F filers, historical; one row per manager report as filed, never a cross-manager sum), with how the CUSIP / symbol / issuer resolved (`identity`), the reconciled coverage boundary and the counting policy. Amendments and restatements follow `counting_policy`. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
2104
+ * Institutional holders of a security (13F)
2105
+ */
2106
+ async secHoldingsHolders(requestParameters: SecHoldingsHoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecHoldingsHolders200Response> {
2107
+ const response = await this.secHoldingsHoldersRaw(requestParameters, initOverrides);
2108
+ return await response.value();
2109
+ }
2110
+
2111
+ /**
2112
+ * Creates request options for secHoldingsManagerPortfolio without sending the request
2113
+ */
2114
+ async secHoldingsManagerPortfolioRequestOpts(requestParameters: SecHoldingsManagerPortfolioRequest): Promise<runtime.RequestOpts> {
2115
+ if (requestParameters['periodEnd'] == null) {
2116
+ throw new runtime.RequiredError(
2117
+ 'periodEnd',
2118
+ 'Required parameter "periodEnd" was null or undefined when calling secHoldingsManagerPortfolio().'
2119
+ );
2120
+ }
2121
+
2122
+ if (requestParameters['cik'] == null) {
2123
+ throw new runtime.RequiredError(
2124
+ 'cik',
2125
+ 'Required parameter "cik" was null or undefined when calling secHoldingsManagerPortfolio().'
2126
+ );
2127
+ }
2128
+
2129
+ const queryParameters: any = {};
2130
+
2131
+ if (requestParameters['periodEnd'] != null) {
2132
+ queryParameters['period_end'] = (requestParameters['periodEnd'] as any).toISOString().substring(0,10);
2133
+ }
2134
+
2135
+ if (requestParameters['instruments'] != null) {
2136
+ queryParameters['instruments'] = requestParameters['instruments'];
2137
+ }
2138
+
2139
+ if (requestParameters['pinnedAt'] != null) {
2140
+ queryParameters['pinned_at'] = (requestParameters['pinnedAt'] as any).toISOString();
2141
+ }
2142
+
2143
+ if (requestParameters['cursor'] != null) {
2144
+ queryParameters['cursor'] = requestParameters['cursor'];
2145
+ }
2146
+
2147
+ if (requestParameters['limit'] != null) {
2148
+ queryParameters['limit'] = requestParameters['limit'];
2149
+ }
2150
+
2151
+ const headerParameters: runtime.HTTPHeaders = {};
2152
+
2153
+ if (this.configuration && this.configuration.accessToken) {
2154
+ const token = this.configuration.accessToken;
2155
+ const tokenString = await token("bearerAuth", []);
2156
+
2157
+ if (tokenString) {
2158
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
2159
+ }
2160
+ }
2161
+
2162
+ let urlPath = `/v1/sec/holdings/managers/{cik}/portfolio`;
2163
+ urlPath = urlPath.replace('{cik}', encodeURIComponent(String(requestParameters['cik'])));
2164
+
2165
+ return {
2166
+ path: urlPath,
2167
+ method: 'GET',
2168
+ headers: headerParameters,
2169
+ query: queryParameters,
2170
+ };
2171
+ }
2172
+
2173
+ /**
2174
+ * One 13F manager\'s reported positions for a quarter — any public 13F filer, with or without an exchange listing of its own. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
2175
+ * Portfolio of a 13F manager
2176
+ */
2177
+ async secHoldingsManagerPortfolioRaw(requestParameters: SecHoldingsManagerPortfolioRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecHoldingsHolders200Response>> {
2178
+ const requestOptions = await this.secHoldingsManagerPortfolioRequestOpts(requestParameters);
2179
+ const response = await this.request(requestOptions, initOverrides);
2180
+
2181
+ return new runtime.JSONApiResponse(response, (jsonValue) => SecHoldingsHolders200ResponseFromJSON(jsonValue));
2182
+ }
2183
+
2184
+ /**
2185
+ * One 13F manager\'s reported positions for a quarter — any public 13F filer, with or without an exchange listing of its own. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
2186
+ * Portfolio of a 13F manager
2187
+ */
2188
+ async secHoldingsManagerPortfolio(requestParameters: SecHoldingsManagerPortfolioRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecHoldingsHolders200Response> {
2189
+ const response = await this.secHoldingsManagerPortfolioRaw(requestParameters, initOverrides);
2190
+ return await response.value();
2191
+ }
2192
+
2193
+ /**
2194
+ * Creates request options for secIssuers without sending the request
2195
+ */
2196
+ async secIssuersRequestOpts(requestParameters: SecIssuersRequest): Promise<runtime.RequestOpts> {
2197
+ const queryParameters: any = {};
2198
+
2199
+ if (requestParameters['query'] != null) {
2200
+ queryParameters['query'] = requestParameters['query'];
2201
+ }
2202
+
2203
+ if (requestParameters['phase'] != null) {
2204
+ queryParameters['phase'] = requestParameters['phase'];
2205
+ }
2206
+
2207
+ if (requestParameters['form'] != null) {
2208
+ queryParameters['form'] = requestParameters['form'];
2209
+ }
2210
+
2211
+ if (requestParameters['publicSeenFrom'] != null) {
2212
+ queryParameters['public_seen_from'] = (requestParameters['publicSeenFrom'] as any).toISOString().substring(0,10);
2213
+ }
2214
+
2215
+ if (requestParameters['publicSeenTo'] != null) {
2216
+ queryParameters['public_seen_to'] = (requestParameters['publicSeenTo'] as any).toISOString().substring(0,10);
2217
+ }
2218
+
2219
+ if (requestParameters['cursor'] != null) {
2220
+ queryParameters['cursor'] = requestParameters['cursor'];
2221
+ }
2222
+
2223
+ if (requestParameters['limit'] != null) {
2224
+ queryParameters['limit'] = requestParameters['limit'];
2225
+ }
2226
+
2227
+ const headerParameters: runtime.HTTPHeaders = {};
2228
+
2229
+ if (this.configuration && this.configuration.accessToken) {
2230
+ const token = this.configuration.accessToken;
2231
+ const tokenString = await token("bearerAuth", []);
2232
+
2233
+ if (tokenString) {
2234
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
2235
+ }
2236
+ }
2237
+
2238
+ let urlPath = `/v1/sec/issuers`;
2239
+
2240
+ return {
2241
+ path: urlPath,
2242
+ method: 'GET',
2243
+ headers: headerParameters,
2244
+ query: queryParameters,
2245
+ };
2246
+ }
2247
+
2248
+ /**
2249
+ * Eligible SEC issuers by name, lifecycle phase, a form they filed or when they first became public — a research list of issuers, not an asset search. Several name candidates set `ambiguous`. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
2250
+ * List SEC issuers
2251
+ */
2252
+ async secIssuersRaw(requestParameters: SecIssuersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecIssuers200Response>> {
2253
+ const requestOptions = await this.secIssuersRequestOpts(requestParameters);
2254
+ const response = await this.request(requestOptions, initOverrides);
2255
+
2256
+ return new runtime.JSONApiResponse(response, (jsonValue) => SecIssuers200ResponseFromJSON(jsonValue));
2257
+ }
2258
+
2259
+ /**
2260
+ * Eligible SEC issuers by name, lifecycle phase, a form they filed or when they first became public — a research list of issuers, not an asset search. Several name candidates set `ambiguous`. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
2261
+ * List SEC issuers
2262
+ */
2263
+ async secIssuers(requestParameters: SecIssuersRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecIssuers200Response> {
2264
+ const response = await this.secIssuersRaw(requestParameters, initOverrides);
2265
+ return await response.value();
2266
+ }
2267
+
2268
+ /**
2269
+ * Creates request options for secSearch without sending the request
2270
+ */
2271
+ async secSearchRequestOpts(requestParameters: SecSearchRequest): Promise<runtime.RequestOpts> {
2272
+ if (requestParameters['q'] == null) {
2273
+ throw new runtime.RequiredError(
2274
+ 'q',
2275
+ 'Required parameter "q" was null or undefined when calling secSearch().'
2276
+ );
2277
+ }
2278
+
2279
+ const queryParameters: any = {};
2280
+
2281
+ if (requestParameters['q'] != null) {
2282
+ queryParameters['q'] = requestParameters['q'];
2283
+ }
2284
+
2285
+ if (requestParameters['mode'] != null) {
2286
+ queryParameters['mode'] = requestParameters['mode'];
2287
+ }
2288
+
2289
+ if (requestParameters['caseSensitive'] != null) {
2290
+ queryParameters['case_sensitive'] = requestParameters['caseSensitive'];
2291
+ }
2292
+
2293
+ if (requestParameters['cik'] != null) {
2294
+ queryParameters['cik'] = requestParameters['cik'];
2295
+ }
2296
+
2297
+ if (requestParameters['entityId'] != null) {
2298
+ queryParameters['entity_id'] = requestParameters['entityId'];
2299
+ }
2300
+
2301
+ if (requestParameters['successors'] != null) {
2302
+ queryParameters['successors'] = requestParameters['successors'];
2303
+ }
2304
+
2305
+ if (requestParameters['accession'] != null) {
2306
+ queryParameters['accession'] = requestParameters['accession'];
2307
+ }
2308
+
2309
+ if (requestParameters['versionId'] != null) {
2310
+ queryParameters['version_id'] = requestParameters['versionId'];
2311
+ }
2312
+
2313
+ if (requestParameters['form'] != null) {
2314
+ queryParameters['form'] = requestParameters['form'];
2315
+ }
2316
+
2317
+ if (requestParameters['filename'] != null) {
2318
+ queryParameters['filename'] = requestParameters['filename'];
2319
+ }
2320
+
2321
+ if (requestParameters['item'] != null) {
2322
+ queryParameters['item'] = requestParameters['item'];
2323
+ }
2324
+
2325
+ if (requestParameters['exhibitType'] != null) {
2326
+ queryParameters['exhibit_type'] = requestParameters['exhibitType'];
2327
+ }
2328
+
2329
+ if (requestParameters['filedFrom'] != null) {
2330
+ queryParameters['filed_from'] = (requestParameters['filedFrom'] as any).toISOString().substring(0,10);
2331
+ }
2332
+
2333
+ if (requestParameters['filedTo'] != null) {
2334
+ queryParameters['filed_to'] = (requestParameters['filedTo'] as any).toISOString().substring(0,10);
2335
+ }
2336
+
2337
+ if (requestParameters['cursor'] != null) {
2338
+ queryParameters['cursor'] = requestParameters['cursor'];
2339
+ }
2340
+
2341
+ if (requestParameters['limit'] != null) {
2342
+ queryParameters['limit'] = requestParameters['limit'];
2343
+ }
2344
+
2345
+ const headerParameters: runtime.HTTPHeaders = {};
2346
+
2347
+ if (this.configuration && this.configuration.accessToken) {
2348
+ const token = this.configuration.accessToken;
2349
+ const tokenString = await token("bearerAuth", []);
2350
+
2351
+ if (tokenString) {
2352
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
2353
+ }
2354
+ }
2355
+
2356
+ let urlPath = `/v1/sec/search`;
2357
+
2358
+ return {
2359
+ path: urlPath,
2360
+ method: 'GET',
2361
+ headers: headerParameters,
2362
+ query: queryParameters,
2363
+ };
2364
+ }
2365
+
2366
+ /**
2367
+ * Find passages in SEC documents, with citations: `mode=lexical` (default; keywords and quoted phrases, English stemming, ranked) or `mode=literal` (the exact characters; `case_sensitive=false` folds case). The earnings search contract: every hit carries `match` (`type`, `lexical_rank`, `spans` = code-point offsets into `text`), `document_spans` (offsets into the document text and each block), the cited blocks with neighbors and footnotes, and `citation` (version, block, the original\'s permanent URL). `coverage` says how complete the answer is: `forms_indexed` / `years_indexed` state the index policy; empty hits with `completeness: complete` is a genuine no-result, anything else is not. A stale or expired cursor answers 409 `restart_required`. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for rag: STANDARD.
2368
+ * Search SEC documents
2369
+ */
2370
+ async secSearchRaw(requestParameters: SecSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecSearch200Response>> {
2371
+ const requestOptions = await this.secSearchRequestOpts(requestParameters);
2372
+ const response = await this.request(requestOptions, initOverrides);
2373
+
2374
+ return new runtime.JSONApiResponse(response, (jsonValue) => SecSearch200ResponseFromJSON(jsonValue));
2375
+ }
2376
+
2377
+ /**
2378
+ * Find passages in SEC documents, with citations: `mode=lexical` (default; keywords and quoted phrases, English stemming, ranked) or `mode=literal` (the exact characters; `case_sensitive=false` folds case). The earnings search contract: every hit carries `match` (`type`, `lexical_rank`, `spans` = code-point offsets into `text`), `document_spans` (offsets into the document text and each block), the cited blocks with neighbors and footnotes, and `citation` (version, block, the original\'s permanent URL). `coverage` says how complete the answer is: `forms_indexed` / `years_indexed` state the index policy; empty hits with `completeness: complete` is a genuine no-result, anything else is not. A stale or expired cursor answers 409 `restart_required`. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for rag: STANDARD.
2379
+ * Search SEC documents
2380
+ */
2381
+ async secSearch(requestParameters: SecSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecSearch200Response> {
2382
+ const response = await this.secSearchRaw(requestParameters, initOverrides);
2383
+ return await response.value();
2384
+ }
2385
+
2386
+ }
2387
+
2388
+ /**
2389
+ * @export
2390
+ */
2391
+ export const SecDocumentFootnotesEnum = {
2392
+ True: 'true',
2393
+ False: 'false'
2394
+ } as const;
2395
+ export type SecDocumentFootnotesEnum = typeof SecDocumentFootnotesEnum[keyof typeof SecDocumentFootnotesEnum];
2396
+ /**
2397
+ * @export
2398
+ */
2399
+ export const SecDocumentFactPlacesStatusEnum = {
2400
+ Exact: 'exact',
2401
+ Ambiguous: 'ambiguous',
2402
+ Hidden: 'hidden',
2403
+ NotInDocument: 'not_in_document',
2404
+ Derived: 'derived',
2405
+ Unmatched: 'unmatched'
2406
+ } as const;
2407
+ export type SecDocumentFactPlacesStatusEnum = typeof SecDocumentFactPlacesStatusEnum[keyof typeof SecDocumentFactPlacesStatusEnum];
2408
+ /**
2409
+ * @export
2410
+ */
2411
+ export const SecDocumentSectionsOutlineEnum = {
2412
+ Legacy: 'legacy',
2413
+ Generic: 'generic'
2414
+ } as const;
2415
+ export type SecDocumentSectionsOutlineEnum = typeof SecDocumentSectionsOutlineEnum[keyof typeof SecDocumentSectionsOutlineEnum];
2416
+ /**
2417
+ * @export
2418
+ */
2419
+ export const SecDocumentVersionFootnotesEnum = {
2420
+ True: 'true',
2421
+ False: 'false'
2422
+ } as const;
2423
+ export type SecDocumentVersionFootnotesEnum = typeof SecDocumentVersionFootnotesEnum[keyof typeof SecDocumentVersionFootnotesEnum];
2424
+ /**
2425
+ * @export
2426
+ */
2427
+ export const SecExportsFinancialMetricsPeriodTypeEnum = {
2428
+ Quarterly: 'quarterly',
2429
+ Annual: 'annual',
2430
+ Ytd: 'ytd',
2431
+ Ttm: 'ttm'
2432
+ } as const;
2433
+ export type SecExportsFinancialMetricsPeriodTypeEnum = typeof SecExportsFinancialMetricsPeriodTypeEnum[keyof typeof SecExportsFinancialMetricsPeriodTypeEnum];
2434
+ /**
2435
+ * @export
2436
+ */
2437
+ export const SecExportsFinancialMetricsModeEnum = {
2438
+ Standardized: 'standardized',
2439
+ Raw: 'raw'
2440
+ } as const;
2441
+ export type SecExportsFinancialMetricsModeEnum = typeof SecExportsFinancialMetricsModeEnum[keyof typeof SecExportsFinancialMetricsModeEnum];
2442
+ /**
2443
+ * @export
2444
+ */
2445
+ export const SecFilerLifecycleTraverseEnum = {
2446
+ Successors: 'successors',
2447
+ Predecessors: 'predecessors'
2448
+ } as const;
2449
+ export type SecFilerLifecycleTraverseEnum = typeof SecFilerLifecycleTraverseEnum[keyof typeof SecFilerLifecycleTraverseEnum];
2450
+ /**
2451
+ * @export
2452
+ */
2453
+ export const SecFilingReviewRelationsDirectionEnum = {
2454
+ From: 'from',
2455
+ To: 'to',
2456
+ Both: 'both'
2457
+ } as const;
2458
+ export type SecFilingReviewRelationsDirectionEnum = typeof SecFilingReviewRelationsDirectionEnum[keyof typeof SecFilingReviewRelationsDirectionEnum];
2459
+ /**
2460
+ * @export
2461
+ */
2462
+ export const SecFilingReviewRelationsKindEnum = {
2463
+ TextTwinOf: 'text_twin_of',
2464
+ RespondsTo: 'responds_to',
2465
+ ReviewsFiling: 'reviews_filing',
2466
+ ContinuesReview: 'continues_review'
2467
+ } as const;
2468
+ export type SecFilingReviewRelationsKindEnum = typeof SecFilingReviewRelationsKindEnum[keyof typeof SecFilingReviewRelationsKindEnum];
2469
+ /**
2470
+ * @export
2471
+ */
2472
+ export const SecFilingReviewRelationsHistoryEnum = {
2473
+ True: 'true',
2474
+ False: 'false'
2475
+ } as const;
2476
+ export type SecFilingReviewRelationsHistoryEnum = typeof SecFilingReviewRelationsHistoryEnum[keyof typeof SecFilingReviewRelationsHistoryEnum];
2477
+ /**
2478
+ * @export
2479
+ */
2480
+ export const SecFilingsOrderEnum = {
2481
+ Desc: 'desc',
2482
+ Asc: 'asc'
2483
+ } as const;
2484
+ export type SecFilingsOrderEnum = typeof SecFilingsOrderEnum[keyof typeof SecFilingsOrderEnum];
2485
+ /**
2486
+ * @export
2487
+ */
2488
+ export const SecFinancialsCatalogStatementEnum = {
2489
+ IncomeStatement: 'income_statement',
2490
+ BalanceSheet: 'balance_sheet',
2491
+ CashFlowStatement: 'cash_flow_statement'
2492
+ } as const;
2493
+ export type SecFinancialsCatalogStatementEnum = typeof SecFinancialsCatalogStatementEnum[keyof typeof SecFinancialsCatalogStatementEnum];
2494
+ /**
2495
+ * @export
2496
+ */
2497
+ export const SecFinancialsFactPlacesEnum = {
2498
+ True: 'true',
2499
+ False: 'false'
2500
+ } as const;
2501
+ export type SecFinancialsFactPlacesEnum = typeof SecFinancialsFactPlacesEnum[keyof typeof SecFinancialsFactPlacesEnum];
2502
+ /**
2503
+ * @export
2504
+ */
2505
+ export const SecFinancialsStatementStatementEnum = {
2506
+ IncomeStatement: 'income_statement',
2507
+ BalanceSheet: 'balance_sheet',
2508
+ CashFlowStatement: 'cash_flow_statement'
2509
+ } as const;
2510
+ export type SecFinancialsStatementStatementEnum = typeof SecFinancialsStatementStatementEnum[keyof typeof SecFinancialsStatementStatementEnum];
2511
+ /**
2512
+ * @export
2513
+ */
2514
+ export const SecFinancialsStatementPeriodTypeEnum = {
2515
+ Quarterly: 'quarterly',
2516
+ Annual: 'annual',
2517
+ Ytd: 'ytd',
2518
+ Ttm: 'ttm'
2519
+ } as const;
2520
+ export type SecFinancialsStatementPeriodTypeEnum = typeof SecFinancialsStatementPeriodTypeEnum[keyof typeof SecFinancialsStatementPeriodTypeEnum];
2521
+ /**
2522
+ * @export
2523
+ */
2524
+ export const SecFinancialsStatementOtherEvidenceEnum = {
2525
+ True: 'true',
2526
+ False: 'false'
2527
+ } as const;
2528
+ export type SecFinancialsStatementOtherEvidenceEnum = typeof SecFinancialsStatementOtherEvidenceEnum[keyof typeof SecFinancialsStatementOtherEvidenceEnum];
2529
+ /**
2530
+ * @export
2531
+ */
2532
+ export const SecHoldingsDeltasInstrumentsEnum = {
2533
+ Shareholder: 'shareholder',
2534
+ All: 'all'
2535
+ } as const;
2536
+ export type SecHoldingsDeltasInstrumentsEnum = typeof SecHoldingsDeltasInstrumentsEnum[keyof typeof SecHoldingsDeltasInstrumentsEnum];
2537
+ /**
2538
+ * @export
2539
+ */
2540
+ export const SecHoldingsFormFilersExactEnum = {
2541
+ True: 'true',
2542
+ False: 'false'
2543
+ } as const;
2544
+ export type SecHoldingsFormFilersExactEnum = typeof SecHoldingsFormFilersExactEnum[keyof typeof SecHoldingsFormFilersExactEnum];
2545
+ /**
2546
+ * @export
2547
+ */
2548
+ export const SecHoldingsHoldersInstrumentsEnum = {
2549
+ Shareholder: 'shareholder',
2550
+ All: 'all'
2551
+ } as const;
2552
+ export type SecHoldingsHoldersInstrumentsEnum = typeof SecHoldingsHoldersInstrumentsEnum[keyof typeof SecHoldingsHoldersInstrumentsEnum];
2553
+ /**
2554
+ * @export
2555
+ */
2556
+ export const SecHoldingsManagerPortfolioInstrumentsEnum = {
2557
+ Shareholder: 'shareholder',
2558
+ All: 'all'
2559
+ } as const;
2560
+ export type SecHoldingsManagerPortfolioInstrumentsEnum = typeof SecHoldingsManagerPortfolioInstrumentsEnum[keyof typeof SecHoldingsManagerPortfolioInstrumentsEnum];
2561
+ /**
2562
+ * @export
2563
+ */
2564
+ export const SecIssuersPhaseEnum = {
2565
+ Observed: 'observed',
2566
+ PublicPreipo: 'public_preipo',
2567
+ ListedSpac: 'listed_spac',
2568
+ ListedOperating: 'listed_operating',
2569
+ FormerListed: 'former_listed',
2570
+ Unresolved: 'unresolved'
2571
+ } as const;
2572
+ export type SecIssuersPhaseEnum = typeof SecIssuersPhaseEnum[keyof typeof SecIssuersPhaseEnum];
2573
+ /**
2574
+ * @export
2575
+ */
2576
+ export const SecSearchModeEnum = {
2577
+ Lexical: 'lexical',
2578
+ Literal: 'literal'
2579
+ } as const;
2580
+ export type SecSearchModeEnum = typeof SecSearchModeEnum[keyof typeof SecSearchModeEnum];
2581
+ /**
2582
+ * @export
2583
+ */
2584
+ export const SecSearchCaseSensitiveEnum = {
2585
+ True: 'true',
2586
+ False: 'false'
2587
+ } as const;
2588
+ export type SecSearchCaseSensitiveEnum = typeof SecSearchCaseSensitiveEnum[keyof typeof SecSearchCaseSensitiveEnum];
2589
+ /**
2590
+ * @export
2591
+ */
2592
+ export const SecSearchSuccessorsEnum = {
2593
+ True: 'true',
2594
+ False: 'false'
2595
+ } as const;
2596
+ export type SecSearchSuccessorsEnum = typeof SecSearchSuccessorsEnum[keyof typeof SecSearchSuccessorsEnum];