@invinite-org/data-api-client 0.10.0 → 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 (292) 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/EarningsCallsCompanyDocuments200ResponseDocumentsInner.d.ts +6 -0
  32. package/dist/esm/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.js +2 -0
  33. package/dist/esm/models/EarningsCallsDocuments200ResponseDocumentsInner.d.ts +6 -0
  34. package/dist/esm/models/EarningsCallsDocuments200ResponseDocumentsInner.js +2 -0
  35. package/dist/esm/models/EarningsCallsTranscript200Response.d.ts +3 -3
  36. package/dist/esm/models/EarningsCallsTranscript200Response.js +3 -3
  37. package/dist/esm/models/EarningsCallsTranscript200ResponseEvent.d.ts +233 -0
  38. package/dist/esm/models/{SecFilingsSections200ResponseCompaniesInnerSectionsInner.js → EarningsCallsTranscript200ResponseEvent.js} +136 -47
  39. package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInner.d.ts +7 -0
  40. package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInner.js +3 -0
  41. package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPending.d.ts +89 -0
  42. package/dist/esm/models/{SecFilingsList200ResponseCompaniesInnerFilingsInner.js → IposRegistrationsList200ResponseRegistrationsInnerIpoPending.js} +43 -44
  43. package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.d.ts +74 -0
  44. package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.js +55 -0
  45. package/dist/{models/SecFilingsSearch200Response.d.ts → esm/models/SecDatasets200Response.d.ts} +26 -17
  46. package/dist/esm/models/{SecFilingsSearch200Response.js → SecDatasets200Response.js} +13 -19
  47. package/dist/esm/models/SecDocument200Response.d.ts +104 -0
  48. package/dist/esm/models/SecDocument200Response.js +42 -0
  49. package/dist/esm/models/SecDocumentFactPlaces200Response.d.ts +88 -0
  50. package/dist/esm/models/SecDocumentFactPlaces200Response.js +42 -0
  51. package/dist/esm/models/SecDocumentFigure200Response.d.ts +70 -0
  52. package/dist/esm/models/SecDocumentFigure200Response.js +42 -0
  53. package/dist/esm/models/SecDocumentSections200Response.d.ts +71 -0
  54. package/dist/esm/models/SecDocumentSections200Response.js +43 -0
  55. package/dist/esm/models/SecDocumentSections200ResponseSectionsInner.d.ts +85 -0
  56. package/dist/esm/models/SecDocumentSections200ResponseSectionsInner.js +44 -0
  57. package/dist/esm/models/SecFiler200Response.d.ts +80 -0
  58. package/dist/esm/models/{SecFilingsList200ResponseCompaniesInner.js → SecFiler200Response.js} +13 -25
  59. package/dist/esm/models/SecFilerCoverage200Response.d.ts +82 -0
  60. package/dist/esm/models/SecFilerCoverage200Response.js +42 -0
  61. package/dist/{models/SecFilingsList200ResponseCompaniesInnerFilingsInner.d.ts → esm/models/SecFilerLifecycle200Response.d.ts} +106 -53
  62. package/dist/esm/models/SecFilerLifecycle200Response.js +42 -0
  63. package/dist/esm/models/SecFilers200Response.d.ts +53 -0
  64. package/dist/esm/models/SecFilers200Response.js +43 -0
  65. package/dist/esm/models/{SecFilingsSearch200ResponseSourcesInner.d.ts → SecFilers200ResponseMatchesInner.d.ts} +31 -28
  66. package/dist/esm/models/SecFilers200ResponseMatchesInner.js +37 -0
  67. package/dist/esm/models/SecFiling200Response.d.ts +88 -0
  68. package/dist/{models/SecFilingsSearch200Response.js → esm/models/SecFiling200Response.js} +13 -26
  69. package/dist/esm/models/{SecFilingsList200Response.d.ts → SecFilingFacts200Response.d.ts} +43 -14
  70. package/dist/esm/models/SecFilingFacts200Response.js +42 -0
  71. package/dist/esm/models/SecFilingHoldings200Response.d.ts +74 -0
  72. package/dist/esm/models/SecFilingHoldings200Response.js +42 -0
  73. package/dist/esm/models/SecFilingReviewChain200Response.d.ts +92 -0
  74. package/dist/esm/models/SecFilingReviewChain200Response.js +42 -0
  75. package/dist/esm/models/SecFilingReviewRelations200Response.d.ts +88 -0
  76. package/dist/esm/models/SecFilingReviewRelations200Response.js +42 -0
  77. package/dist/esm/models/SecFilings200Response.d.ts +88 -0
  78. package/dist/esm/models/SecFilings200Response.js +44 -0
  79. package/dist/esm/models/SecFilings200ResponseFilingsInner.d.ts +81 -0
  80. package/dist/esm/models/SecFilings200ResponseFilingsInner.js +37 -0
  81. package/dist/esm/models/{SecFilingsAvailableFormTypes200Response.d.ts → SecFilings200ResponseFormFacetInner.d.ts} +25 -12
  82. package/dist/esm/models/{SecFilingsList200Response.js → SecFilings200ResponseFormFacetInner.js} +10 -17
  83. package/dist/esm/models/SecFinancialsCatalog200Response.d.ts +48 -0
  84. package/dist/esm/models/SecFinancialsCatalog200Response.js +42 -0
  85. package/dist/{models/SecFilingsSections200ResponseCompaniesInnerSectionsInner.d.ts → esm/models/SecHoldingsHolders200Response.d.ts} +88 -64
  86. package/dist/esm/models/SecHoldingsHolders200Response.js +42 -0
  87. package/dist/esm/models/{SecFilingsList200ResponseCompaniesInner.d.ts → SecIssuers200Response.d.ts} +45 -22
  88. package/dist/esm/models/SecIssuers200Response.js +42 -0
  89. package/dist/esm/models/{SecFilingsSections200ResponseCompaniesInner.d.ts → SecReadiness.d.ts} +34 -21
  90. package/dist/esm/models/SecReadiness.js +55 -0
  91. package/dist/esm/models/SecSearch200Response.d.ts +88 -0
  92. package/dist/esm/models/SecSearch200Response.js +51 -0
  93. package/dist/esm/models/SecSearch200ResponseHitsInner.d.ts +92 -0
  94. package/dist/esm/models/SecSearch200ResponseHitsInner.js +38 -0
  95. package/dist/esm/models/SecSearchCoverage.d.ts +61 -0
  96. package/dist/esm/models/SecSearchCoverage.js +52 -0
  97. package/dist/esm/models/SecSearchCoverageLexical.d.ts +51 -0
  98. package/dist/esm/models/{SecFilingsAvailableFormTypes200Response.js → SecSearchCoverageLexical.js} +10 -16
  99. package/dist/esm/models/SecStoreError.d.ts +52 -0
  100. package/dist/esm/models/{SecFilingsSections200Response.js → SecStoreError.js} +14 -16
  101. package/dist/esm/models/WebSocketFiling.d.ts +1 -1
  102. package/dist/esm/models/index.d.ts +36 -9
  103. package/dist/esm/models/index.js +36 -9
  104. package/dist/models/EarningsCallsCalendar200ResponseEventsInner.d.ts +7 -0
  105. package/dist/models/EarningsCallsCalendar200ResponseEventsInner.js +3 -0
  106. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendar.d.ts +95 -0
  107. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendar.js +103 -0
  108. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCall.d.ts +102 -0
  109. package/dist/models/{SecFilingsSections200ResponseCompaniesInnerSectionsInner.js → EarningsCallsCalendar200ResponseEventsInnerCalendarCall.js} +69 -67
  110. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource.d.ts +56 -0
  111. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource.js +66 -0
  112. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReport.d.ts +69 -0
  113. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReport.js +80 -0
  114. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource.d.ts +44 -0
  115. package/dist/models/{SecFilingsList200ResponseCompaniesInner.js → EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource.js} +22 -25
  116. package/dist/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.d.ts +6 -0
  117. package/dist/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.js +2 -0
  118. package/dist/models/EarningsCallsDocuments200ResponseDocumentsInner.d.ts +6 -0
  119. package/dist/models/EarningsCallsDocuments200ResponseDocumentsInner.js +2 -0
  120. package/dist/models/EarningsCallsTranscript200Response.d.ts +3 -3
  121. package/dist/models/EarningsCallsTranscript200Response.js +3 -3
  122. package/dist/models/EarningsCallsTranscript200ResponseEvent.d.ts +233 -0
  123. package/dist/models/EarningsCallsTranscript200ResponseEvent.js +196 -0
  124. package/dist/models/IposRegistrationsList200ResponseRegistrationsInner.d.ts +7 -0
  125. package/dist/models/IposRegistrationsList200ResponseRegistrationsInner.js +3 -0
  126. package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPending.d.ts +89 -0
  127. package/dist/models/{SecFilingsList200ResponseCompaniesInnerFilingsInner.js → IposRegistrationsList200ResponseRegistrationsInnerIpoPending.js} +49 -49
  128. package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.d.ts +74 -0
  129. package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.js +62 -0
  130. package/dist/{esm/models/SecFilingsSearch200Response.d.ts → models/SecDatasets200Response.d.ts} +26 -17
  131. package/dist/models/{SecFilingsSections200Response.js → SecDatasets200Response.js} +19 -21
  132. package/dist/models/SecDocument200Response.d.ts +104 -0
  133. package/dist/models/{SecFilingsSections200ResponseCompaniesInner.js → SecDocument200Response.js} +18 -28
  134. package/dist/models/SecDocumentFactPlaces200Response.d.ts +88 -0
  135. package/dist/models/SecDocumentFactPlaces200Response.js +49 -0
  136. package/dist/models/SecDocumentFigure200Response.d.ts +70 -0
  137. package/dist/models/SecDocumentFigure200Response.js +49 -0
  138. package/dist/models/SecDocumentSections200Response.d.ts +71 -0
  139. package/dist/models/SecDocumentSections200Response.js +50 -0
  140. package/dist/models/SecDocumentSections200ResponseSectionsInner.d.ts +85 -0
  141. package/dist/models/SecDocumentSections200ResponseSectionsInner.js +52 -0
  142. package/dist/models/SecFiler200Response.d.ts +80 -0
  143. package/dist/models/SecFiler200Response.js +49 -0
  144. package/dist/models/SecFilerCoverage200Response.d.ts +82 -0
  145. package/dist/models/{SecFilingsSearch200ResponseSourcesInner.js → SecFilerCoverage200Response.js} +18 -39
  146. package/dist/{esm/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.d.ts → models/SecFilerLifecycle200Response.d.ts} +106 -53
  147. package/dist/models/SecFilerLifecycle200Response.js +49 -0
  148. package/dist/models/SecFilers200Response.d.ts +53 -0
  149. package/dist/models/SecFilers200Response.js +50 -0
  150. package/dist/models/{SecFilingsSearch200ResponseSourcesInner.d.ts → SecFilers200ResponseMatchesInner.d.ts} +31 -28
  151. package/dist/models/SecFilers200ResponseMatchesInner.js +44 -0
  152. package/dist/models/SecFiling200Response.d.ts +88 -0
  153. package/dist/models/SecFiling200Response.js +49 -0
  154. package/dist/models/{SecFilingsList200Response.d.ts → SecFilingFacts200Response.d.ts} +43 -14
  155. package/dist/models/SecFilingFacts200Response.js +49 -0
  156. package/dist/models/SecFilingHoldings200Response.d.ts +74 -0
  157. package/dist/models/SecFilingHoldings200Response.js +49 -0
  158. package/dist/models/SecFilingReviewChain200Response.d.ts +92 -0
  159. package/dist/models/SecFilingReviewChain200Response.js +49 -0
  160. package/dist/models/SecFilingReviewRelations200Response.d.ts +88 -0
  161. package/dist/models/SecFilingReviewRelations200Response.js +49 -0
  162. package/dist/models/SecFilings200Response.d.ts +88 -0
  163. package/dist/models/SecFilings200Response.js +51 -0
  164. package/dist/models/SecFilings200ResponseFilingsInner.d.ts +81 -0
  165. package/dist/models/SecFilings200ResponseFilingsInner.js +44 -0
  166. package/dist/{esm/models/SecFilingsSections200Response.d.ts → models/SecFilings200ResponseFormFacetInner.d.ts} +25 -13
  167. package/dist/models/SecFilings200ResponseFormFacetInner.js +44 -0
  168. package/dist/models/SecFinancialsCatalog200Response.d.ts +48 -0
  169. package/dist/models/SecFinancialsCatalog200Response.js +49 -0
  170. package/dist/{esm/models/SecFilingsSections200ResponseCompaniesInnerSectionsInner.d.ts → models/SecHoldingsHolders200Response.d.ts} +88 -64
  171. package/dist/models/SecHoldingsHolders200Response.js +49 -0
  172. package/dist/models/{SecFilingsList200ResponseCompaniesInner.d.ts → SecIssuers200Response.d.ts} +45 -22
  173. package/dist/models/SecIssuers200Response.js +49 -0
  174. package/dist/models/{SecFilingsSections200ResponseCompaniesInner.d.ts → SecReadiness.d.ts} +34 -21
  175. package/dist/models/SecReadiness.js +63 -0
  176. package/dist/models/SecSearch200Response.d.ts +88 -0
  177. package/dist/models/SecSearch200Response.js +59 -0
  178. package/dist/models/SecSearch200ResponseHitsInner.d.ts +92 -0
  179. package/dist/models/SecSearch200ResponseHitsInner.js +45 -0
  180. package/dist/models/SecSearchCoverage.d.ts +61 -0
  181. package/dist/models/SecSearchCoverage.js +60 -0
  182. package/dist/models/SecSearchCoverageLexical.d.ts +51 -0
  183. package/dist/models/{SecFilingsList200Response.js → SecSearchCoverageLexical.js} +15 -22
  184. package/dist/models/SecStoreError.d.ts +52 -0
  185. package/dist/models/{SecFilingsAvailableFormTypes200Response.js → SecStoreError.js} +19 -20
  186. package/dist/models/WebSocketFiling.d.ts +1 -1
  187. package/dist/models/index.d.ts +36 -9
  188. package/dist/models/index.js +36 -9
  189. package/docs/EarningsCallsApi.md +8 -2
  190. package/docs/EarningsCallsCalendar200ResponseEventsInner.md +2 -0
  191. package/docs/EarningsCallsCalendar200ResponseEventsInnerCalendar.md +43 -0
  192. package/docs/EarningsCallsCalendar200ResponseEventsInnerCalendarCall.md +45 -0
  193. package/docs/EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource.md +43 -0
  194. package/docs/EarningsCallsCalendar200ResponseEventsInnerCalendarReport.md +41 -0
  195. package/docs/EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource.md +39 -0
  196. package/docs/EarningsCallsCompanyDocuments200ResponseDocumentsInner.md +2 -0
  197. package/docs/EarningsCallsDocuments200ResponseDocumentsInner.md +2 -0
  198. package/docs/EarningsCallsTranscript200Response.md +1 -1
  199. package/docs/EarningsCallsTranscript200ResponseEvent.md +88 -0
  200. package/docs/IPOsApi.md +5 -2
  201. package/docs/IposRegistrationsList200ResponseRegistrationsInner.md +2 -0
  202. package/docs/IposRegistrationsList200ResponseRegistrationsInnerIpoPending.md +51 -0
  203. package/docs/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.md +49 -0
  204. package/docs/SECApi.md +2646 -0
  205. package/docs/{SecFilingsList200Response.md → SecDatasets200Response.md} +11 -6
  206. package/docs/SecDocument200Response.md +53 -0
  207. package/docs/SecDocumentFactPlaces200Response.md +51 -0
  208. package/docs/SecDocumentFigure200Response.md +45 -0
  209. package/docs/SecDocumentSections200Response.md +47 -0
  210. package/docs/SecDocumentSections200ResponseSectionsInner.md +48 -0
  211. package/docs/SecFiler200Response.md +47 -0
  212. package/docs/SecFilerCoverage200Response.md +49 -0
  213. package/docs/SecFilerLifecycle200Response.md +65 -0
  214. package/docs/SecFilers200Response.md +41 -0
  215. package/docs/{SecFilingsSearch200ResponseSourcesInner.md → SecFilers200ResponseMatchesInner.md} +14 -14
  216. package/docs/SecFiling200Response.md +49 -0
  217. package/docs/SecFilingFacts200Response.md +43 -0
  218. package/docs/SecFilingHoldings200Response.md +47 -0
  219. package/docs/SecFilingReviewChain200Response.md +51 -0
  220. package/docs/SecFilingReviewRelations200Response.md +51 -0
  221. package/docs/SecFilings200Response.md +51 -0
  222. package/docs/SecFilings200ResponseFilingsInner.md +50 -0
  223. package/docs/{SecFilingsAvailableFormTypes200Response.md → SecFilings200ResponseFormFacetInner.md} +10 -6
  224. package/docs/{SecFilingsSections200Response.md → SecFinancialsCatalog200Response.md} +11 -6
  225. package/docs/SecHoldingsHolders200Response.md +67 -0
  226. package/docs/{SecFilingsList200ResponseCompaniesInner.md → SecIssuers200Response.md} +17 -10
  227. package/docs/SecReadiness.md +39 -0
  228. package/docs/SecSearch200Response.md +49 -0
  229. package/docs/SecSearch200ResponseHitsInner.md +52 -0
  230. package/docs/SecSearchCoverage.md +41 -0
  231. package/docs/{SecFilingsSearch200Response.md → SecSearchCoverageLexical.md} +13 -8
  232. package/docs/SecStoreError.md +41 -0
  233. package/docs/WebSocketFiling.md +1 -1
  234. package/package.json +1 -1
  235. package/src/apis/EarningsCallsApi.ts +32 -2
  236. package/src/apis/IPOsApi.ts +15 -2
  237. package/src/apis/SECApi.ts +2596 -0
  238. package/src/apis/index.ts +1 -1
  239. package/src/models/EarningsCallsCalendar200ResponseEventsInner.ts +15 -0
  240. package/src/models/EarningsCallsCalendar200ResponseEventsInnerCalendar.ts +159 -0
  241. package/src/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCall.ts +163 -0
  242. package/src/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource.ts +102 -0
  243. package/src/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReport.ts +123 -0
  244. package/src/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource.ts +84 -0
  245. package/src/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.ts +8 -0
  246. package/src/models/EarningsCallsDocuments200ResponseDocumentsInner.ts +8 -0
  247. package/src/models/EarningsCallsTranscript200Response.ts +10 -10
  248. package/src/models/EarningsCallsTranscript200ResponseEvent.ts +363 -0
  249. package/src/models/IposRegistrationsList200ResponseRegistrationsInner.ts +15 -0
  250. package/src/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPending.ts +157 -0
  251. package/src/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.ts +121 -0
  252. package/src/models/{SecFilingsSearch200Response.ts → SecDatasets200Response.ts} +41 -30
  253. package/src/models/SecDocument200Response.ts +150 -0
  254. package/src/models/SecDocumentFactPlaces200Response.ts +142 -0
  255. package/src/models/{SecFilingsSections200ResponseCompaniesInner.ts → SecDocumentFigure200Response.ts} +63 -37
  256. package/src/models/SecDocumentSections200Response.ts +133 -0
  257. package/src/models/SecDocumentSections200ResponseSectionsInner.ts +135 -0
  258. package/src/models/{SecFilingsSearch200ResponseSourcesInner.ts → SecFiler200Response.ts} +67 -52
  259. package/src/models/SecFilerCoverage200Response.ts +134 -0
  260. package/src/models/{SecFilingsList200ResponseCompaniesInnerFilingsInner.ts → SecFilerLifecycle200Response.ts} +126 -92
  261. package/src/models/SecFilers200Response.ts +109 -0
  262. package/src/models/SecFilers200ResponseMatchesInner.ts +108 -0
  263. package/src/models/SecFiling200Response.ts +134 -0
  264. package/src/models/SecFilingFacts200Response.ts +110 -0
  265. package/src/models/SecFilingHoldings200Response.ts +126 -0
  266. package/src/models/SecFilingReviewChain200Response.ts +142 -0
  267. package/src/models/SecFilingReviewRelations200Response.ts +142 -0
  268. package/src/models/SecFilings200Response.ts +156 -0
  269. package/src/models/SecFilings200ResponseFilingsInner.ts +132 -0
  270. package/src/models/{SecFilingsSections200Response.ts → SecFilings200ResponseFormFacetInner.ts} +35 -25
  271. package/src/models/SecFinancialsCatalog200Response.ts +94 -0
  272. package/src/models/{SecFilingsSections200ResponseCompaniesInnerSectionsInner.ts → SecHoldingsHolders200Response.ts} +125 -111
  273. package/src/models/{SecFilingsList200ResponseCompaniesInner.ts → SecIssuers200Response.ts} +64 -38
  274. package/src/models/SecReadiness.ts +103 -0
  275. package/src/models/SecSearch200Response.ts +159 -0
  276. package/src/models/SecSearch200ResponseHitsInner.ts +148 -0
  277. package/src/models/SecSearchCoverage.ts +115 -0
  278. package/src/models/{SecFilingsList200Response.ts → SecSearchCoverageLexical.ts} +44 -26
  279. package/src/models/SecStoreError.ts +102 -0
  280. package/src/models/WebSocketFiling.ts +1 -1
  281. package/src/models/index.ts +36 -9
  282. package/dist/apis/SECFilingsApi.d.ts +0 -117
  283. package/dist/apis/SECFilingsApi.js +0 -284
  284. package/dist/esm/apis/SECFilingsApi.d.ts +0 -117
  285. package/dist/esm/apis/SECFilingsApi.js +0 -280
  286. package/dist/models/SecFilingsAvailableFormTypes200Response.d.ts +0 -32
  287. package/dist/models/SecFilingsSections200Response.d.ts +0 -33
  288. package/docs/SECFilingsApi.md +0 -344
  289. package/docs/SecFilingsList200ResponseCompaniesInnerFilingsInner.md +0 -54
  290. package/docs/SecFilingsSections200ResponseCompaniesInner.md +0 -38
  291. package/docs/SecFilingsSections200ResponseCompaniesInnerSectionsInner.md +0 -62
  292. package/src/apis/SECFilingsApi.ts +0 -368
@@ -1,284 +0,0 @@
1
- "use strict";
2
- /* tslint:disable */
3
- /* eslint-disable */
4
- /**
5
- * Invinite API
6
- * Invinite financial data API. Each endpoint has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Included-Remaining` what is left of the plan\'s included credits. `GET /v1/account/usage` returns your account\'s usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost. **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.
7
- *
8
- * The version of the OpenAPI document: 1.0.0
9
- *
10
- *
11
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
- * https://openapi-generator.tech
13
- * Do not edit the class manually.
14
- */
15
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
16
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
17
- return new (P || (P = Promise))(function (resolve, reject) {
18
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
19
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
20
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
21
- step((generator = generator.apply(thisArg, _arguments || [])).next());
22
- });
23
- };
24
- Object.defineProperty(exports, "__esModule", { value: true });
25
- exports.SecFilingsSectionsFormTypeEnum = exports.SecFilingsListSortEnum = exports.SECFilingsApi = void 0;
26
- const runtime = require("../runtime");
27
- const SecFilingsAvailableFormTypes200Response_1 = require("../models/SecFilingsAvailableFormTypes200Response");
28
- const SecFilingsList200Response_1 = require("../models/SecFilingsList200Response");
29
- const SecFilingsSearch200Response_1 = require("../models/SecFilingsSearch200Response");
30
- const SecFilingsSections200Response_1 = require("../models/SecFilingsSections200Response");
31
- /**
32
- *
33
- */
34
- class SECFilingsApi extends runtime.BaseAPI {
35
- /**
36
- * Creates request options for secFilingsAvailableFormTypes without sending the request
37
- */
38
- secFilingsAvailableFormTypesRequestOpts(requestParameters) {
39
- return __awaiter(this, void 0, void 0, function* () {
40
- const queryParameters = {};
41
- if (requestParameters['identifier'] != null) {
42
- queryParameters['identifier'] = requestParameters['identifier'];
43
- }
44
- const headerParameters = {};
45
- if (this.configuration && this.configuration.accessToken) {
46
- const token = this.configuration.accessToken;
47
- const tokenString = yield token("bearerAuth", []);
48
- if (tokenString) {
49
- headerParameters["Authorization"] = `Bearer ${tokenString}`;
50
- }
51
- }
52
- let urlPath = `/v1/sec-filings/available-form-types`;
53
- return {
54
- path: urlPath,
55
- method: 'GET',
56
- headers: headerParameters,
57
- query: queryParameters,
58
- };
59
- });
60
- }
61
- /**
62
- * List available SEC filing form types present in the filings table. Optionally filter by a company identifier (ticker or CIK). Minimum tier for display: FREE.
63
- * Available SEC form types
64
- */
65
- secFilingsAvailableFormTypesRaw(requestParameters, initOverrides) {
66
- return __awaiter(this, void 0, void 0, function* () {
67
- const requestOptions = yield this.secFilingsAvailableFormTypesRequestOpts(requestParameters);
68
- const response = yield this.request(requestOptions, initOverrides);
69
- return new runtime.JSONApiResponse(response, (jsonValue) => (0, SecFilingsAvailableFormTypes200Response_1.SecFilingsAvailableFormTypes200ResponseFromJSON)(jsonValue));
70
- });
71
- }
72
- /**
73
- * List available SEC filing form types present in the filings table. Optionally filter by a company identifier (ticker or CIK). Minimum tier for display: FREE.
74
- * Available SEC form types
75
- */
76
- secFilingsAvailableFormTypes() {
77
- return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
78
- const response = yield this.secFilingsAvailableFormTypesRaw(requestParameters, initOverrides);
79
- return yield response.value();
80
- });
81
- }
82
- /**
83
- * Creates request options for secFilingsList without sending the request
84
- */
85
- secFilingsListRequestOpts(requestParameters) {
86
- return __awaiter(this, void 0, void 0, function* () {
87
- if (requestParameters['identifier'] == null) {
88
- throw new runtime.RequiredError('identifier', 'Required parameter "identifier" was null or undefined when calling secFilingsList().');
89
- }
90
- const queryParameters = {};
91
- if (requestParameters['identifier'] != null) {
92
- queryParameters['identifier'] = requestParameters['identifier'];
93
- }
94
- if (requestParameters['formType'] != null) {
95
- queryParameters['form_type'] = requestParameters['formType'];
96
- }
97
- if (requestParameters['sort'] != null) {
98
- queryParameters['sort'] = requestParameters['sort'];
99
- }
100
- if (requestParameters['limit'] != null) {
101
- queryParameters['limit'] = requestParameters['limit'];
102
- }
103
- if (requestParameters['offset'] != null) {
104
- queryParameters['offset'] = requestParameters['offset'];
105
- }
106
- const headerParameters = {};
107
- if (this.configuration && this.configuration.accessToken) {
108
- const token = this.configuration.accessToken;
109
- const tokenString = yield token("bearerAuth", []);
110
- if (tokenString) {
111
- headerParameters["Authorization"] = `Bearer ${tokenString}`;
112
- }
113
- }
114
- let urlPath = `/v1/sec-filings/filings`;
115
- return {
116
- path: urlPath,
117
- method: 'GET',
118
- headers: headerParameters,
119
- query: queryParameters,
120
- };
121
- });
122
- }
123
- /**
124
- * Fetch SEC filings for a company. `identifier` is a ticker or a CIK; a CIK also resolves a company that is not listed yet (a pre-IPO registrant), whose `ticker` is null. Registration statements (S-1, S-1/A, F-1, F-1/A) carry the `proposed_symbols` the prospectus names. Minimum tier for display: FREE.
125
- * SEC filings
126
- */
127
- secFilingsListRaw(requestParameters, initOverrides) {
128
- return __awaiter(this, void 0, void 0, function* () {
129
- const requestOptions = yield this.secFilingsListRequestOpts(requestParameters);
130
- const response = yield this.request(requestOptions, initOverrides);
131
- return new runtime.JSONApiResponse(response, (jsonValue) => (0, SecFilingsList200Response_1.SecFilingsList200ResponseFromJSON)(jsonValue));
132
- });
133
- }
134
- /**
135
- * Fetch SEC filings for a company. `identifier` is a ticker or a CIK; a CIK also resolves a company that is not listed yet (a pre-IPO registrant), whose `ticker` is null. Registration statements (S-1, S-1/A, F-1, F-1/A) carry the `proposed_symbols` the prospectus names. Minimum tier for display: FREE.
136
- * SEC filings
137
- */
138
- secFilingsList(requestParameters, initOverrides) {
139
- return __awaiter(this, void 0, void 0, function* () {
140
- const response = yield this.secFilingsListRaw(requestParameters, initOverrides);
141
- return yield response.value();
142
- });
143
- }
144
- /**
145
- * Creates request options for secFilingsSearch without sending the request
146
- */
147
- secFilingsSearchRequestOpts(requestParameters) {
148
- return __awaiter(this, void 0, void 0, function* () {
149
- if (requestParameters['request'] == null) {
150
- throw new runtime.RequiredError('request', 'Required parameter "request" was null or undefined when calling secFilingsSearch().');
151
- }
152
- const queryParameters = {};
153
- if (requestParameters['request'] != null) {
154
- queryParameters['request'] = requestParameters['request'];
155
- }
156
- if (requestParameters['identifier'] != null) {
157
- queryParameters['identifier'] = requestParameters['identifier'];
158
- }
159
- if (requestParameters['accessionNumber'] != null) {
160
- queryParameters['accession_number'] = requestParameters['accessionNumber'];
161
- }
162
- const headerParameters = {};
163
- if (this.configuration && this.configuration.accessToken) {
164
- const token = this.configuration.accessToken;
165
- const tokenString = yield token("bearerAuth", []);
166
- if (tokenString) {
167
- headerParameters["Authorization"] = `Bearer ${tokenString}`;
168
- }
169
- }
170
- let urlPath = `/v1/sec-filings/search`;
171
- return {
172
- path: urlPath,
173
- method: 'GET',
174
- headers: headerParameters,
175
- query: queryParameters,
176
- };
177
- });
178
- }
179
- /**
180
- * Search SEC filings using natural language queries. Returns AI-generated answers with source citations from official SEC documents (10-K, 10-Q, 8-K). Minimum tier for rag: STANDARD.
181
- * Search SEC filings
182
- */
183
- secFilingsSearchRaw(requestParameters, initOverrides) {
184
- return __awaiter(this, void 0, void 0, function* () {
185
- const requestOptions = yield this.secFilingsSearchRequestOpts(requestParameters);
186
- const response = yield this.request(requestOptions, initOverrides);
187
- return new runtime.JSONApiResponse(response, (jsonValue) => (0, SecFilingsSearch200Response_1.SecFilingsSearch200ResponseFromJSON)(jsonValue));
188
- });
189
- }
190
- /**
191
- * Search SEC filings using natural language queries. Returns AI-generated answers with source citations from official SEC documents (10-K, 10-Q, 8-K). Minimum tier for rag: STANDARD.
192
- * Search SEC filings
193
- */
194
- secFilingsSearch(requestParameters, initOverrides) {
195
- return __awaiter(this, void 0, void 0, function* () {
196
- const response = yield this.secFilingsSearchRaw(requestParameters, initOverrides);
197
- return yield response.value();
198
- });
199
- }
200
- /**
201
- * Creates request options for secFilingsSections without sending the request
202
- */
203
- secFilingsSectionsRequestOpts(requestParameters) {
204
- return __awaiter(this, void 0, void 0, function* () {
205
- if (requestParameters['identifier'] == null) {
206
- throw new runtime.RequiredError('identifier', 'Required parameter "identifier" was null or undefined when calling secFilingsSections().');
207
- }
208
- if (requestParameters['formType'] == null) {
209
- throw new runtime.RequiredError('formType', 'Required parameter "formType" was null or undefined when calling secFilingsSections().');
210
- }
211
- const queryParameters = {};
212
- if (requestParameters['identifier'] != null) {
213
- queryParameters['identifier'] = requestParameters['identifier'];
214
- }
215
- if (requestParameters['formType'] != null) {
216
- queryParameters['form_type'] = requestParameters['formType'];
217
- }
218
- if (requestParameters['sectionId'] != null) {
219
- queryParameters['section_id'] = requestParameters['sectionId'];
220
- }
221
- if (requestParameters['accessionNumber'] != null) {
222
- queryParameters['accession_number'] = requestParameters['accessionNumber'];
223
- }
224
- if (requestParameters['fiscalYear'] != null) {
225
- queryParameters['fiscal_year'] = requestParameters['fiscalYear'];
226
- }
227
- if (requestParameters['fiscalQuarter'] != null) {
228
- queryParameters['fiscal_quarter'] = requestParameters['fiscalQuarter'];
229
- }
230
- const headerParameters = {};
231
- if (this.configuration && this.configuration.accessToken) {
232
- const token = this.configuration.accessToken;
233
- const tokenString = yield token("bearerAuth", []);
234
- if (tokenString) {
235
- headerParameters["Authorization"] = `Bearer ${tokenString}`;
236
- }
237
- }
238
- let urlPath = `/v1/sec-filings/sections`;
239
- return {
240
- path: urlPath,
241
- method: 'GET',
242
- headers: headerParameters,
243
- query: queryParameters,
244
- };
245
- });
246
- }
247
- /**
248
- * Fetch SEC filing sections for a company. Returns parsed sections from 10-Q, 10-K, or 8-K filings. Minimum tier for rag: STANDARD.
249
- * SEC filing sections
250
- */
251
- secFilingsSectionsRaw(requestParameters, initOverrides) {
252
- return __awaiter(this, void 0, void 0, function* () {
253
- const requestOptions = yield this.secFilingsSectionsRequestOpts(requestParameters);
254
- const response = yield this.request(requestOptions, initOverrides);
255
- return new runtime.JSONApiResponse(response, (jsonValue) => (0, SecFilingsSections200Response_1.SecFilingsSections200ResponseFromJSON)(jsonValue));
256
- });
257
- }
258
- /**
259
- * Fetch SEC filing sections for a company. Returns parsed sections from 10-Q, 10-K, or 8-K filings. Minimum tier for rag: STANDARD.
260
- * SEC filing sections
261
- */
262
- secFilingsSections(requestParameters, initOverrides) {
263
- return __awaiter(this, void 0, void 0, function* () {
264
- const response = yield this.secFilingsSectionsRaw(requestParameters, initOverrides);
265
- return yield response.value();
266
- });
267
- }
268
- }
269
- exports.SECFilingsApi = SECFilingsApi;
270
- /**
271
- * @export
272
- */
273
- exports.SecFilingsListSortEnum = {
274
- Asc: 'asc',
275
- Desc: 'desc'
276
- };
277
- /**
278
- * @export
279
- */
280
- exports.SecFilingsSectionsFormTypeEnum = {
281
- _10Q: '10-Q',
282
- _10K: '10-K',
283
- _8K: '8-K'
284
- };
@@ -1,117 +0,0 @@
1
- /**
2
- * Invinite API
3
- * Invinite financial data API. Each endpoint has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Included-Remaining` what is left of the plan\'s included credits. `GET /v1/account/usage` returns your account\'s usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost. **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.
4
- *
5
- * The version of the OpenAPI document: 1.0.0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import * as runtime from '../runtime';
13
- import { type SecFilingsAvailableFormTypes200Response } from '../models/SecFilingsAvailableFormTypes200Response';
14
- import { type SecFilingsList200Response } from '../models/SecFilingsList200Response';
15
- import { type SecFilingsSearch200Response } from '../models/SecFilingsSearch200Response';
16
- import { type SecFilingsSections200Response } from '../models/SecFilingsSections200Response';
17
- export interface SecFilingsAvailableFormTypesRequest {
18
- identifier?: string;
19
- }
20
- export interface SecFilingsListRequest {
21
- identifier: string;
22
- formType?: string;
23
- sort?: SecFilingsListSortEnum;
24
- limit?: number;
25
- offset?: number;
26
- }
27
- export interface SecFilingsSearchRequest {
28
- request: string;
29
- identifier?: string;
30
- accessionNumber?: string;
31
- }
32
- export interface SecFilingsSectionsRequest {
33
- identifier: string;
34
- formType: SecFilingsSectionsFormTypeEnum;
35
- sectionId?: string;
36
- accessionNumber?: string;
37
- fiscalYear?: number;
38
- fiscalQuarter?: number;
39
- }
40
- /**
41
- *
42
- */
43
- export declare class SECFilingsApi extends runtime.BaseAPI {
44
- /**
45
- * Creates request options for secFilingsAvailableFormTypes without sending the request
46
- */
47
- secFilingsAvailableFormTypesRequestOpts(requestParameters: SecFilingsAvailableFormTypesRequest): Promise<runtime.RequestOpts>;
48
- /**
49
- * List available SEC filing form types present in the filings table. Optionally filter by a company identifier (ticker or CIK). Minimum tier for display: FREE.
50
- * Available SEC form types
51
- */
52
- secFilingsAvailableFormTypesRaw(requestParameters: SecFilingsAvailableFormTypesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecFilingsAvailableFormTypes200Response>>;
53
- /**
54
- * List available SEC filing form types present in the filings table. Optionally filter by a company identifier (ticker or CIK). Minimum tier for display: FREE.
55
- * Available SEC form types
56
- */
57
- secFilingsAvailableFormTypes(requestParameters?: SecFilingsAvailableFormTypesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecFilingsAvailableFormTypes200Response>;
58
- /**
59
- * Creates request options for secFilingsList without sending the request
60
- */
61
- secFilingsListRequestOpts(requestParameters: SecFilingsListRequest): Promise<runtime.RequestOpts>;
62
- /**
63
- * Fetch SEC filings for a company. `identifier` is a ticker or a CIK; a CIK also resolves a company that is not listed yet (a pre-IPO registrant), whose `ticker` is null. Registration statements (S-1, S-1/A, F-1, F-1/A) carry the `proposed_symbols` the prospectus names. Minimum tier for display: FREE.
64
- * SEC filings
65
- */
66
- secFilingsListRaw(requestParameters: SecFilingsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecFilingsList200Response>>;
67
- /**
68
- * Fetch SEC filings for a company. `identifier` is a ticker or a CIK; a CIK also resolves a company that is not listed yet (a pre-IPO registrant), whose `ticker` is null. Registration statements (S-1, S-1/A, F-1, F-1/A) carry the `proposed_symbols` the prospectus names. Minimum tier for display: FREE.
69
- * SEC filings
70
- */
71
- secFilingsList(requestParameters: SecFilingsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecFilingsList200Response>;
72
- /**
73
- * Creates request options for secFilingsSearch without sending the request
74
- */
75
- secFilingsSearchRequestOpts(requestParameters: SecFilingsSearchRequest): Promise<runtime.RequestOpts>;
76
- /**
77
- * Search SEC filings using natural language queries. Returns AI-generated answers with source citations from official SEC documents (10-K, 10-Q, 8-K). Minimum tier for rag: STANDARD.
78
- * Search SEC filings
79
- */
80
- secFilingsSearchRaw(requestParameters: SecFilingsSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecFilingsSearch200Response>>;
81
- /**
82
- * Search SEC filings using natural language queries. Returns AI-generated answers with source citations from official SEC documents (10-K, 10-Q, 8-K). Minimum tier for rag: STANDARD.
83
- * Search SEC filings
84
- */
85
- secFilingsSearch(requestParameters: SecFilingsSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecFilingsSearch200Response>;
86
- /**
87
- * Creates request options for secFilingsSections without sending the request
88
- */
89
- secFilingsSectionsRequestOpts(requestParameters: SecFilingsSectionsRequest): Promise<runtime.RequestOpts>;
90
- /**
91
- * Fetch SEC filing sections for a company. Returns parsed sections from 10-Q, 10-K, or 8-K filings. Minimum tier for rag: STANDARD.
92
- * SEC filing sections
93
- */
94
- secFilingsSectionsRaw(requestParameters: SecFilingsSectionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecFilingsSections200Response>>;
95
- /**
96
- * Fetch SEC filing sections for a company. Returns parsed sections from 10-Q, 10-K, or 8-K filings. Minimum tier for rag: STANDARD.
97
- * SEC filing sections
98
- */
99
- secFilingsSections(requestParameters: SecFilingsSectionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecFilingsSections200Response>;
100
- }
101
- /**
102
- * @export
103
- */
104
- export declare const SecFilingsListSortEnum: {
105
- readonly Asc: "asc";
106
- readonly Desc: "desc";
107
- };
108
- export type SecFilingsListSortEnum = typeof SecFilingsListSortEnum[keyof typeof SecFilingsListSortEnum];
109
- /**
110
- * @export
111
- */
112
- export declare const SecFilingsSectionsFormTypeEnum: {
113
- readonly _10Q: "10-Q";
114
- readonly _10K: "10-K";
115
- readonly _8K: "8-K";
116
- };
117
- export type SecFilingsSectionsFormTypeEnum = typeof SecFilingsSectionsFormTypeEnum[keyof typeof SecFilingsSectionsFormTypeEnum];