@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
@@ -1,344 +0,0 @@
1
- # SECFilingsApi
2
-
3
- All URIs are relative to *https://api.data.invinite.com*
4
-
5
- | Method | HTTP request | Description |
6
- |------------- | ------------- | -------------|
7
- | [**secFilingsAvailableFormTypes**](SECFilingsApi.md#secfilingsavailableformtypes) | **GET** /v1/sec-filings/available-form-types | Available SEC form types |
8
- | [**secFilingsList**](SECFilingsApi.md#secfilingslist) | **GET** /v1/sec-filings/filings | SEC filings |
9
- | [**secFilingsSearch**](SECFilingsApi.md#secfilingssearch) | **GET** /v1/sec-filings/search | Search SEC filings |
10
- | [**secFilingsSections**](SECFilingsApi.md#secfilingssections) | **GET** /v1/sec-filings/sections | SEC filing sections |
11
-
12
-
13
-
14
- ## secFilingsAvailableFormTypes
15
-
16
- > SecFilingsAvailableFormTypes200Response secFilingsAvailableFormTypes(identifier)
17
-
18
- Available SEC form types
19
-
20
- 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.
21
-
22
- ### Example
23
-
24
- ```ts
25
- import {
26
- Configuration,
27
- SECFilingsApi,
28
- } from '@invinite-org/data-api-client';
29
- import type { SecFilingsAvailableFormTypesRequest } from '@invinite-org/data-api-client';
30
-
31
- async function example() {
32
- console.log("🚀 Testing @invinite-org/data-api-client SDK...");
33
- const config = new Configuration({
34
- // Configure HTTP bearer authorization: bearerAuth
35
- accessToken: "YOUR BEARER TOKEN",
36
- });
37
- const api = new SECFilingsApi(config);
38
-
39
- const body = {
40
- // string | Optional ticker symbol or CIK. If omitted, returns form types across all filings. (optional)
41
- identifier: AAPL,
42
- } satisfies SecFilingsAvailableFormTypesRequest;
43
-
44
- try {
45
- const data = await api.secFilingsAvailableFormTypes(body);
46
- console.log(data);
47
- } catch (error) {
48
- console.error(error);
49
- }
50
- }
51
-
52
- // Run the test
53
- example().catch(console.error);
54
- ```
55
-
56
- ### Parameters
57
-
58
-
59
- | Name | Type | Description | Notes |
60
- |------------- | ------------- | ------------- | -------------|
61
- | **identifier** | `string` | Optional ticker symbol or CIK. If omitted, returns form types across all filings. | [Optional] [Defaults to `undefined`] |
62
-
63
- ### Return type
64
-
65
- [**SecFilingsAvailableFormTypes200Response**](SecFilingsAvailableFormTypes200Response.md)
66
-
67
- ### Authorization
68
-
69
- [bearerAuth](../README.md#bearerAuth)
70
-
71
- ### HTTP request headers
72
-
73
- - **Content-Type**: Not defined
74
- - **Accept**: `application/json`
75
-
76
-
77
- ### HTTP response details
78
- | Status code | Description | Response headers |
79
- |-------------|-------------|------------------|
80
- | **200** | Default Response | - |
81
- | **400** | Bad Request - Invalid request parameters | - |
82
- | **401** | Unauthorized - Missing or invalid API key | - |
83
- | **404** | Not Found - Resource not found | - |
84
- | **500** | Internal Server Error - Server error occurred | - |
85
-
86
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
87
-
88
-
89
- ## secFilingsList
90
-
91
- > SecFilingsList200Response secFilingsList(identifier, formType, sort, limit, offset)
92
-
93
- SEC filings
94
-
95
- 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.
96
-
97
- ### Example
98
-
99
- ```ts
100
- import {
101
- Configuration,
102
- SECFilingsApi,
103
- } from '@invinite-org/data-api-client';
104
- import type { SecFilingsListRequest } from '@invinite-org/data-api-client';
105
-
106
- async function example() {
107
- console.log("🚀 Testing @invinite-org/data-api-client SDK...");
108
- const config = new Configuration({
109
- // Configure HTTP bearer authorization: bearerAuth
110
- accessToken: "YOUR BEARER TOKEN",
111
- });
112
- const api = new SECFilingsApi(config);
113
-
114
- const body = {
115
- // string | Ticker symbol or CIK. A CIK also finds a registrant that is not listed yet (pre-IPO).
116
- identifier: AAPL,
117
- // string | SEC form type filter (e.g., 10-K, 10-Q, 8-K, 3, 4, 5, 13F-HR). Leave empty to return all form types. (optional)
118
- formType: 10-K,
119
- // 'asc' | 'desc' | Sort direction for filings by filing_date (optional)
120
- sort: desc,
121
- // number | Maximum number of filings to return (optional)
122
- limit: 5,
123
- // number | Number of filings to skip for pagination (optional)
124
- offset: 0,
125
- } satisfies SecFilingsListRequest;
126
-
127
- try {
128
- const data = await api.secFilingsList(body);
129
- console.log(data);
130
- } catch (error) {
131
- console.error(error);
132
- }
133
- }
134
-
135
- // Run the test
136
- example().catch(console.error);
137
- ```
138
-
139
- ### Parameters
140
-
141
-
142
- | Name | Type | Description | Notes |
143
- |------------- | ------------- | ------------- | -------------|
144
- | **identifier** | `string` | Ticker symbol or CIK. A CIK also finds a registrant that is not listed yet (pre-IPO). | [Defaults to `undefined`] |
145
- | **formType** | `string` | SEC form type filter (e.g., 10-K, 10-Q, 8-K, 3, 4, 5, 13F-HR). Leave empty to return all form types. | [Optional] [Defaults to `undefined`] |
146
- | **sort** | `asc`, `desc` | Sort direction for filings by filing_date | [Optional] [Defaults to `'desc'`] [Enum: asc, desc] |
147
- | **limit** | `number` | Maximum number of filings to return | [Optional] [Defaults to `40`] |
148
- | **offset** | `number` | Number of filings to skip for pagination | [Optional] [Defaults to `0`] |
149
-
150
- ### Return type
151
-
152
- [**SecFilingsList200Response**](SecFilingsList200Response.md)
153
-
154
- ### Authorization
155
-
156
- [bearerAuth](../README.md#bearerAuth)
157
-
158
- ### HTTP request headers
159
-
160
- - **Content-Type**: Not defined
161
- - **Accept**: `application/json`
162
-
163
-
164
- ### HTTP response details
165
- | Status code | Description | Response headers |
166
- |-------------|-------------|------------------|
167
- | **200** | Default Response | - |
168
- | **400** | Bad Request - Invalid request parameters | - |
169
- | **401** | Unauthorized - Missing or invalid API key | - |
170
- | **404** | Not Found - Resource not found | - |
171
- | **500** | Internal Server Error - Server error occurred | - |
172
-
173
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
174
-
175
-
176
- ## secFilingsSearch
177
-
178
- > SecFilingsSearch200Response secFilingsSearch(request, identifier, accessionNumber)
179
-
180
- Search SEC filings
181
-
182
- 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.
183
-
184
- ### Example
185
-
186
- ```ts
187
- import {
188
- Configuration,
189
- SECFilingsApi,
190
- } from '@invinite-org/data-api-client';
191
- import type { SecFilingsSearchRequest } from '@invinite-org/data-api-client';
192
-
193
- async function example() {
194
- console.log("🚀 Testing @invinite-org/data-api-client SDK...");
195
- const config = new Configuration({
196
- // Configure HTTP bearer authorization: bearerAuth
197
- accessToken: "YOUR BEARER TOKEN",
198
- });
199
- const api = new SECFilingsApi(config);
200
-
201
- const body = {
202
- // string | Natural language search request for SEC filing information (e.g., \'What are Apple\'s main risk factors?\')
203
- request: What are Apple's main risk factors?,
204
- // string | Ticker symbol or CIK to filter search results to a specific company (optional)
205
- identifier: AAPL,
206
- // string | Accession number to filter search results to a specific filing (optional)
207
- accessionNumber: 0000320193-25-000079,
208
- } satisfies SecFilingsSearchRequest;
209
-
210
- try {
211
- const data = await api.secFilingsSearch(body);
212
- console.log(data);
213
- } catch (error) {
214
- console.error(error);
215
- }
216
- }
217
-
218
- // Run the test
219
- example().catch(console.error);
220
- ```
221
-
222
- ### Parameters
223
-
224
-
225
- | Name | Type | Description | Notes |
226
- |------------- | ------------- | ------------- | -------------|
227
- | **request** | `string` | Natural language search request for SEC filing information (e.g., \'What are Apple\'s main risk factors?\') | [Defaults to `undefined`] |
228
- | **identifier** | `string` | Ticker symbol or CIK to filter search results to a specific company | [Optional] [Defaults to `undefined`] |
229
- | **accessionNumber** | `string` | Accession number to filter search results to a specific filing | [Optional] [Defaults to `undefined`] |
230
-
231
- ### Return type
232
-
233
- [**SecFilingsSearch200Response**](SecFilingsSearch200Response.md)
234
-
235
- ### Authorization
236
-
237
- [bearerAuth](../README.md#bearerAuth)
238
-
239
- ### HTTP request headers
240
-
241
- - **Content-Type**: Not defined
242
- - **Accept**: `application/json`
243
-
244
-
245
- ### HTTP response details
246
- | Status code | Description | Response headers |
247
- |-------------|-------------|------------------|
248
- | **200** | Default Response | - |
249
- | **400** | Bad Request - Invalid request parameters | - |
250
- | **401** | Unauthorized - Missing or invalid API key | - |
251
- | **500** | Internal Server Error - Server error occurred | - |
252
-
253
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
254
-
255
-
256
- ## secFilingsSections
257
-
258
- > SecFilingsSections200Response secFilingsSections(identifier, formType, sectionId, accessionNumber, fiscalYear, fiscalQuarter)
259
-
260
- SEC filing sections
261
-
262
- Fetch SEC filing sections for a company. Returns parsed sections from 10-Q, 10-K, or 8-K filings. Minimum tier for rag: STANDARD.
263
-
264
- ### Example
265
-
266
- ```ts
267
- import {
268
- Configuration,
269
- SECFilingsApi,
270
- } from '@invinite-org/data-api-client';
271
- import type { SecFilingsSectionsRequest } from '@invinite-org/data-api-client';
272
-
273
- async function example() {
274
- console.log("🚀 Testing @invinite-org/data-api-client SDK...");
275
- const config = new Configuration({
276
- // Configure HTTP bearer authorization: bearerAuth
277
- accessToken: "YOUR BEARER TOKEN",
278
- });
279
- const api = new SECFilingsApi(config);
280
-
281
- const body = {
282
- // string | Ticker symbol or CIK. 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.
283
- identifier: AAPL,
284
- // '10-Q' | '10-K' | '8-K' | SEC form type. Filter requirements vary: 8-K requires accession_number; 10-K requires accession_number or fiscal_year; 10-Q requires accession_number or fiscal_year+fiscal_quarter.
285
- formType: 10-K,
286
- // string | Optional section ID. If not specified, all sections from the filing are returned. A section the filing does not have answers 404 with the section IDs it has. (optional)
287
- sectionId: part_i-item_1a,
288
- // string | SEC accession number of the filing (optional)
289
- accessionNumber: 0000320193-25-000079,
290
- // number | Fiscal year (optional)
291
- fiscalYear: 2025,
292
- // number | Fiscal quarter (1-4). Required for 10-Q when using fiscal_year filter. (optional)
293
- fiscalQuarter: 4,
294
- } satisfies SecFilingsSectionsRequest;
295
-
296
- try {
297
- const data = await api.secFilingsSections(body);
298
- console.log(data);
299
- } catch (error) {
300
- console.error(error);
301
- }
302
- }
303
-
304
- // Run the test
305
- example().catch(console.error);
306
- ```
307
-
308
- ### Parameters
309
-
310
-
311
- | Name | Type | Description | Notes |
312
- |------------- | ------------- | ------------- | -------------|
313
- | **identifier** | `string` | Ticker symbol or CIK. 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. | [Defaults to `undefined`] |
314
- | **formType** | `10-Q`, `10-K`, `8-K` | SEC form type. Filter requirements vary: 8-K requires accession_number; 10-K requires accession_number or fiscal_year; 10-Q requires accession_number or fiscal_year+fiscal_quarter. | [Defaults to `undefined`] [Enum: 10-Q, 10-K, 8-K] |
315
- | **sectionId** | `string` | Optional section ID. If not specified, all sections from the filing are returned. A section the filing does not have answers 404 with the section IDs it has. | [Optional] [Defaults to `undefined`] |
316
- | **accessionNumber** | `string` | SEC accession number of the filing | [Optional] [Defaults to `undefined`] |
317
- | **fiscalYear** | `number` | Fiscal year | [Optional] [Defaults to `undefined`] |
318
- | **fiscalQuarter** | `number` | Fiscal quarter (1-4). Required for 10-Q when using fiscal_year filter. | [Optional] [Defaults to `undefined`] |
319
-
320
- ### Return type
321
-
322
- [**SecFilingsSections200Response**](SecFilingsSections200Response.md)
323
-
324
- ### Authorization
325
-
326
- [bearerAuth](../README.md#bearerAuth)
327
-
328
- ### HTTP request headers
329
-
330
- - **Content-Type**: Not defined
331
- - **Accept**: `application/json`
332
-
333
-
334
- ### HTTP response details
335
- | Status code | Description | Response headers |
336
- |-------------|-------------|------------------|
337
- | **200** | Default Response | - |
338
- | **400** | Bad Request - Invalid request parameters | - |
339
- | **401** | Unauthorized - Missing or invalid API key | - |
340
- | **404** | Not Found - Resource not found | - |
341
- | **500** | Internal Server Error - Server error occurred | - |
342
-
343
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
344
-
@@ -1,54 +0,0 @@
1
-
2
- # SecFilingsList200ResponseCompaniesInnerFilingsInner
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `accession_number` | string
10
- `calendar_quarter` | number
11
- `calendar_year` | number
12
- `cik` | string
13
- `filing_date` | Date
14
- `fiscal_quarter` | number
15
- `fiscal_year` | number
16
- `form_type` | string
17
- `html_url` | string
18
- `period_end` | Date
19
- `proposed_symbols` | [Array<ProposedSymbol>](ProposedSymbol.md)
20
-
21
- ## Example
22
-
23
- ```typescript
24
- import type { SecFilingsList200ResponseCompaniesInnerFilingsInner } from '@invinite-org/data-api-client'
25
-
26
- // TODO: Update the object below with actual values
27
- const example = {
28
- "accession_number": null,
29
- "calendar_quarter": null,
30
- "calendar_year": null,
31
- "cik": null,
32
- "filing_date": null,
33
- "fiscal_quarter": null,
34
- "fiscal_year": null,
35
- "form_type": null,
36
- "html_url": null,
37
- "period_end": null,
38
- "proposed_symbols": null,
39
- } satisfies SecFilingsList200ResponseCompaniesInnerFilingsInner
40
-
41
- console.log(example)
42
-
43
- // Convert the instance to a JSON string
44
- const exampleJSON: string = JSON.stringify(example)
45
- console.log(exampleJSON)
46
-
47
- // Parse the JSON string back to an object
48
- const exampleParsed = JSON.parse(exampleJSON) as SecFilingsList200ResponseCompaniesInnerFilingsInner
49
- console.log(exampleParsed)
50
- ```
51
-
52
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
53
-
54
-
@@ -1,38 +0,0 @@
1
-
2
- # SecFilingsSections200ResponseCompaniesInner
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `ticker` | string
10
- `cik` | string
11
- `sections` | [Array<SecFilingsSections200ResponseCompaniesInnerSectionsInner>](SecFilingsSections200ResponseCompaniesInnerSectionsInner.md)
12
-
13
- ## Example
14
-
15
- ```typescript
16
- import type { SecFilingsSections200ResponseCompaniesInner } from '@invinite-org/data-api-client'
17
-
18
- // TODO: Update the object below with actual values
19
- const example = {
20
- "ticker": null,
21
- "cik": null,
22
- "sections": null,
23
- } satisfies SecFilingsSections200ResponseCompaniesInner
24
-
25
- console.log(example)
26
-
27
- // Convert the instance to a JSON string
28
- const exampleJSON: string = JSON.stringify(example)
29
- console.log(exampleJSON)
30
-
31
- // Parse the JSON string back to an object
32
- const exampleParsed = JSON.parse(exampleJSON) as SecFilingsSections200ResponseCompaniesInner
33
- console.log(exampleParsed)
34
- ```
35
-
36
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
37
-
38
-
@@ -1,62 +0,0 @@
1
-
2
- # SecFilingsSections200ResponseCompaniesInnerSectionsInner
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `accession_number` | string
10
- `calendar_quarter` | number
11
- `calendar_year` | number
12
- `cik` | string
13
- `content` | string
14
- `filing_date` | Date
15
- `fiscal_quarter` | number
16
- `fiscal_year` | number
17
- `form_type` | string
18
- `html_tag_id` | string
19
- `html_url` | string
20
- `item_id` | string
21
- `part` | string
22
- `period_end` | Date
23
- `title` | string
24
-
25
- ## Example
26
-
27
- ```typescript
28
- import type { SecFilingsSections200ResponseCompaniesInnerSectionsInner } from '@invinite-org/data-api-client'
29
-
30
- // TODO: Update the object below with actual values
31
- const example = {
32
- "accession_number": null,
33
- "calendar_quarter": null,
34
- "calendar_year": null,
35
- "cik": null,
36
- "content": null,
37
- "filing_date": null,
38
- "fiscal_quarter": null,
39
- "fiscal_year": null,
40
- "form_type": null,
41
- "html_tag_id": null,
42
- "html_url": null,
43
- "item_id": null,
44
- "part": null,
45
- "period_end": null,
46
- "title": null,
47
- } satisfies SecFilingsSections200ResponseCompaniesInnerSectionsInner
48
-
49
- console.log(example)
50
-
51
- // Convert the instance to a JSON string
52
- const exampleJSON: string = JSON.stringify(example)
53
- console.log(exampleJSON)
54
-
55
- // Parse the JSON string back to an object
56
- const exampleParsed = JSON.parse(exampleJSON) as SecFilingsSections200ResponseCompaniesInnerSectionsInner
57
- console.log(exampleParsed)
58
- ```
59
-
60
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
61
-
62
-