@invinite-org/data-api-client 0.10.1 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (280) hide show
  1. package/.openapi-generator/FILES +74 -20
  2. package/README.md +32 -2
  3. package/dist/apis/EarningsCallsApi.d.ts +24 -2
  4. package/dist/apis/EarningsCallsApi.js +27 -3
  5. package/dist/apis/IPOsApi.d.ts +11 -2
  6. package/dist/apis/IPOsApi.js +13 -3
  7. package/dist/apis/SECApi.d.ts +840 -0
  8. package/dist/apis/SECApi.js +1959 -0
  9. package/dist/apis/index.d.ts +1 -1
  10. package/dist/apis/index.js +1 -1
  11. package/dist/esm/apis/EarningsCallsApi.d.ts +24 -2
  12. package/dist/esm/apis/EarningsCallsApi.js +26 -2
  13. package/dist/esm/apis/IPOsApi.d.ts +11 -2
  14. package/dist/esm/apis/IPOsApi.js +12 -2
  15. package/dist/esm/apis/SECApi.d.ts +840 -0
  16. package/dist/esm/apis/SECApi.js +1955 -0
  17. package/dist/esm/apis/index.d.ts +1 -1
  18. package/dist/esm/apis/index.js +1 -1
  19. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInner.d.ts +7 -0
  20. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInner.js +3 -0
  21. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerCalendar.d.ts +95 -0
  22. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerCalendar.js +95 -0
  23. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCall.d.ts +102 -0
  24. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCall.js +100 -0
  25. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource.d.ts +56 -0
  26. package/dist/esm/models/{SecFilingsSearch200ResponseSourcesInner.js → EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource.js} +23 -27
  27. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReport.d.ts +69 -0
  28. package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReport.js +72 -0
  29. package/{src/models/SecFilingsAvailableFormTypes200Response.ts → dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource.d.ts} +26 -48
  30. package/dist/esm/models/{SecFilingsSections200ResponseCompaniesInner.js → EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource.js} +17 -18
  31. package/dist/esm/models/EarningsCallsTranscript200Response.d.ts +3 -3
  32. package/dist/esm/models/EarningsCallsTranscript200Response.js +3 -3
  33. package/dist/esm/models/EarningsCallsTranscript200ResponseEvent.d.ts +233 -0
  34. package/dist/esm/models/{SecFilingsSections200ResponseCompaniesInnerSectionsInner.js → EarningsCallsTranscript200ResponseEvent.js} +136 -47
  35. package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInner.d.ts +7 -0
  36. package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInner.js +3 -0
  37. package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPending.d.ts +89 -0
  38. package/dist/esm/models/{SecFilingsList200ResponseCompaniesInnerFilingsInner.js → IposRegistrationsList200ResponseRegistrationsInnerIpoPending.js} +43 -44
  39. package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.d.ts +74 -0
  40. package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.js +55 -0
  41. package/dist/{models/SecFilingsSearch200Response.d.ts → esm/models/SecDatasets200Response.d.ts} +26 -17
  42. package/dist/esm/models/{SecFilingsSearch200Response.js → SecDatasets200Response.js} +13 -19
  43. package/dist/esm/models/SecDocument200Response.d.ts +104 -0
  44. package/dist/esm/models/SecDocument200Response.js +42 -0
  45. package/dist/esm/models/SecDocumentFactPlaces200Response.d.ts +88 -0
  46. package/dist/esm/models/SecDocumentFactPlaces200Response.js +42 -0
  47. package/dist/esm/models/SecDocumentFigure200Response.d.ts +70 -0
  48. package/dist/esm/models/SecDocumentFigure200Response.js +42 -0
  49. package/dist/esm/models/SecDocumentSections200Response.d.ts +71 -0
  50. package/dist/esm/models/SecDocumentSections200Response.js +43 -0
  51. package/dist/esm/models/SecDocumentSections200ResponseSectionsInner.d.ts +85 -0
  52. package/dist/esm/models/SecDocumentSections200ResponseSectionsInner.js +44 -0
  53. package/dist/esm/models/SecFiler200Response.d.ts +80 -0
  54. package/dist/esm/models/{SecFilingsList200ResponseCompaniesInner.js → SecFiler200Response.js} +13 -25
  55. package/dist/esm/models/SecFilerCoverage200Response.d.ts +82 -0
  56. package/dist/esm/models/SecFilerCoverage200Response.js +42 -0
  57. package/dist/{models/SecFilingsList200ResponseCompaniesInnerFilingsInner.d.ts → esm/models/SecFilerLifecycle200Response.d.ts} +106 -53
  58. package/dist/esm/models/SecFilerLifecycle200Response.js +42 -0
  59. package/dist/esm/models/SecFilers200Response.d.ts +53 -0
  60. package/dist/esm/models/SecFilers200Response.js +43 -0
  61. package/dist/esm/models/{SecFilingsSearch200ResponseSourcesInner.d.ts → SecFilers200ResponseMatchesInner.d.ts} +31 -28
  62. package/dist/esm/models/SecFilers200ResponseMatchesInner.js +37 -0
  63. package/dist/esm/models/SecFiling200Response.d.ts +88 -0
  64. package/dist/{models/SecFilingsSearch200Response.js → esm/models/SecFiling200Response.js} +13 -26
  65. package/dist/esm/models/{SecFilingsList200Response.d.ts → SecFilingFacts200Response.d.ts} +43 -14
  66. package/dist/esm/models/SecFilingFacts200Response.js +42 -0
  67. package/dist/esm/models/SecFilingHoldings200Response.d.ts +74 -0
  68. package/dist/esm/models/SecFilingHoldings200Response.js +42 -0
  69. package/dist/esm/models/SecFilingReviewChain200Response.d.ts +92 -0
  70. package/dist/esm/models/SecFilingReviewChain200Response.js +42 -0
  71. package/dist/esm/models/SecFilingReviewRelations200Response.d.ts +88 -0
  72. package/dist/esm/models/SecFilingReviewRelations200Response.js +42 -0
  73. package/dist/esm/models/SecFilings200Response.d.ts +88 -0
  74. package/dist/esm/models/SecFilings200Response.js +44 -0
  75. package/dist/esm/models/SecFilings200ResponseFilingsInner.d.ts +81 -0
  76. package/dist/esm/models/SecFilings200ResponseFilingsInner.js +37 -0
  77. package/dist/esm/models/{SecFilingsAvailableFormTypes200Response.d.ts → SecFilings200ResponseFormFacetInner.d.ts} +25 -12
  78. package/dist/esm/models/{SecFilingsList200Response.js → SecFilings200ResponseFormFacetInner.js} +10 -17
  79. package/dist/esm/models/SecFinancialsCatalog200Response.d.ts +48 -0
  80. package/dist/esm/models/SecFinancialsCatalog200Response.js +42 -0
  81. package/dist/{models/SecFilingsSections200ResponseCompaniesInnerSectionsInner.d.ts → esm/models/SecHoldingsHolders200Response.d.ts} +88 -64
  82. package/dist/esm/models/SecHoldingsHolders200Response.js +42 -0
  83. package/dist/esm/models/{SecFilingsList200ResponseCompaniesInner.d.ts → SecIssuers200Response.d.ts} +45 -22
  84. package/dist/esm/models/SecIssuers200Response.js +42 -0
  85. package/dist/esm/models/{SecFilingsSections200ResponseCompaniesInner.d.ts → SecReadiness.d.ts} +34 -21
  86. package/dist/esm/models/SecReadiness.js +55 -0
  87. package/dist/esm/models/SecSearch200Response.d.ts +88 -0
  88. package/dist/esm/models/SecSearch200Response.js +51 -0
  89. package/dist/esm/models/SecSearch200ResponseHitsInner.d.ts +92 -0
  90. package/dist/esm/models/SecSearch200ResponseHitsInner.js +38 -0
  91. package/dist/esm/models/SecSearchCoverage.d.ts +61 -0
  92. package/dist/esm/models/SecSearchCoverage.js +52 -0
  93. package/dist/esm/models/SecSearchCoverageLexical.d.ts +51 -0
  94. package/dist/esm/models/{SecFilingsAvailableFormTypes200Response.js → SecSearchCoverageLexical.js} +10 -16
  95. package/dist/esm/models/SecStoreError.d.ts +52 -0
  96. package/dist/esm/models/{SecFilingsSections200Response.js → SecStoreError.js} +14 -16
  97. package/dist/esm/models/WebSocketFiling.d.ts +1 -1
  98. package/dist/esm/models/index.d.ts +36 -9
  99. package/dist/esm/models/index.js +36 -9
  100. package/dist/models/EarningsCallsCalendar200ResponseEventsInner.d.ts +7 -0
  101. package/dist/models/EarningsCallsCalendar200ResponseEventsInner.js +3 -0
  102. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendar.d.ts +95 -0
  103. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendar.js +103 -0
  104. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCall.d.ts +102 -0
  105. package/dist/models/{SecFilingsSections200ResponseCompaniesInnerSectionsInner.js → EarningsCallsCalendar200ResponseEventsInnerCalendarCall.js} +69 -67
  106. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource.d.ts +56 -0
  107. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource.js +66 -0
  108. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReport.d.ts +69 -0
  109. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReport.js +80 -0
  110. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource.d.ts +44 -0
  111. package/dist/models/{SecFilingsList200ResponseCompaniesInner.js → EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource.js} +22 -25
  112. package/dist/models/EarningsCallsTranscript200Response.d.ts +3 -3
  113. package/dist/models/EarningsCallsTranscript200Response.js +3 -3
  114. package/dist/models/EarningsCallsTranscript200ResponseEvent.d.ts +233 -0
  115. package/dist/models/EarningsCallsTranscript200ResponseEvent.js +196 -0
  116. package/dist/models/IposRegistrationsList200ResponseRegistrationsInner.d.ts +7 -0
  117. package/dist/models/IposRegistrationsList200ResponseRegistrationsInner.js +3 -0
  118. package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPending.d.ts +89 -0
  119. package/dist/models/{SecFilingsList200ResponseCompaniesInnerFilingsInner.js → IposRegistrationsList200ResponseRegistrationsInnerIpoPending.js} +49 -49
  120. package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.d.ts +74 -0
  121. package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.js +62 -0
  122. package/dist/{esm/models/SecFilingsSearch200Response.d.ts → models/SecDatasets200Response.d.ts} +26 -17
  123. package/dist/models/{SecFilingsSections200Response.js → SecDatasets200Response.js} +19 -21
  124. package/dist/models/SecDocument200Response.d.ts +104 -0
  125. package/dist/models/{SecFilingsSections200ResponseCompaniesInner.js → SecDocument200Response.js} +18 -28
  126. package/dist/models/SecDocumentFactPlaces200Response.d.ts +88 -0
  127. package/dist/models/SecDocumentFactPlaces200Response.js +49 -0
  128. package/dist/models/SecDocumentFigure200Response.d.ts +70 -0
  129. package/dist/models/SecDocumentFigure200Response.js +49 -0
  130. package/dist/models/SecDocumentSections200Response.d.ts +71 -0
  131. package/dist/models/SecDocumentSections200Response.js +50 -0
  132. package/dist/models/SecDocumentSections200ResponseSectionsInner.d.ts +85 -0
  133. package/dist/models/SecDocumentSections200ResponseSectionsInner.js +52 -0
  134. package/dist/models/SecFiler200Response.d.ts +80 -0
  135. package/dist/models/SecFiler200Response.js +49 -0
  136. package/dist/models/SecFilerCoverage200Response.d.ts +82 -0
  137. package/dist/models/{SecFilingsSearch200ResponseSourcesInner.js → SecFilerCoverage200Response.js} +18 -39
  138. package/dist/{esm/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.d.ts → models/SecFilerLifecycle200Response.d.ts} +106 -53
  139. package/dist/models/SecFilerLifecycle200Response.js +49 -0
  140. package/dist/models/SecFilers200Response.d.ts +53 -0
  141. package/dist/models/SecFilers200Response.js +50 -0
  142. package/dist/models/{SecFilingsSearch200ResponseSourcesInner.d.ts → SecFilers200ResponseMatchesInner.d.ts} +31 -28
  143. package/dist/models/SecFilers200ResponseMatchesInner.js +44 -0
  144. package/dist/models/SecFiling200Response.d.ts +88 -0
  145. package/dist/models/SecFiling200Response.js +49 -0
  146. package/dist/models/{SecFilingsList200Response.d.ts → SecFilingFacts200Response.d.ts} +43 -14
  147. package/dist/models/SecFilingFacts200Response.js +49 -0
  148. package/dist/models/SecFilingHoldings200Response.d.ts +74 -0
  149. package/dist/models/SecFilingHoldings200Response.js +49 -0
  150. package/dist/models/SecFilingReviewChain200Response.d.ts +92 -0
  151. package/dist/models/SecFilingReviewChain200Response.js +49 -0
  152. package/dist/models/SecFilingReviewRelations200Response.d.ts +88 -0
  153. package/dist/models/SecFilingReviewRelations200Response.js +49 -0
  154. package/dist/models/SecFilings200Response.d.ts +88 -0
  155. package/dist/models/SecFilings200Response.js +51 -0
  156. package/dist/models/SecFilings200ResponseFilingsInner.d.ts +81 -0
  157. package/dist/models/SecFilings200ResponseFilingsInner.js +44 -0
  158. package/dist/{esm/models/SecFilingsSections200Response.d.ts → models/SecFilings200ResponseFormFacetInner.d.ts} +25 -13
  159. package/dist/models/SecFilings200ResponseFormFacetInner.js +44 -0
  160. package/dist/models/SecFinancialsCatalog200Response.d.ts +48 -0
  161. package/dist/models/SecFinancialsCatalog200Response.js +49 -0
  162. package/dist/{esm/models/SecFilingsSections200ResponseCompaniesInnerSectionsInner.d.ts → models/SecHoldingsHolders200Response.d.ts} +88 -64
  163. package/dist/models/SecHoldingsHolders200Response.js +49 -0
  164. package/dist/models/{SecFilingsList200ResponseCompaniesInner.d.ts → SecIssuers200Response.d.ts} +45 -22
  165. package/dist/models/SecIssuers200Response.js +49 -0
  166. package/dist/models/{SecFilingsSections200ResponseCompaniesInner.d.ts → SecReadiness.d.ts} +34 -21
  167. package/dist/models/SecReadiness.js +63 -0
  168. package/dist/models/SecSearch200Response.d.ts +88 -0
  169. package/dist/models/SecSearch200Response.js +59 -0
  170. package/dist/models/SecSearch200ResponseHitsInner.d.ts +92 -0
  171. package/dist/models/SecSearch200ResponseHitsInner.js +45 -0
  172. package/dist/models/SecSearchCoverage.d.ts +61 -0
  173. package/dist/models/SecSearchCoverage.js +60 -0
  174. package/dist/models/SecSearchCoverageLexical.d.ts +51 -0
  175. package/dist/models/{SecFilingsList200Response.js → SecSearchCoverageLexical.js} +15 -22
  176. package/dist/models/SecStoreError.d.ts +52 -0
  177. package/dist/models/{SecFilingsAvailableFormTypes200Response.js → SecStoreError.js} +19 -20
  178. package/dist/models/WebSocketFiling.d.ts +1 -1
  179. package/dist/models/index.d.ts +36 -9
  180. package/dist/models/index.js +36 -9
  181. package/docs/EarningsCallsApi.md +8 -2
  182. package/docs/EarningsCallsCalendar200ResponseEventsInner.md +2 -0
  183. package/docs/EarningsCallsCalendar200ResponseEventsInnerCalendar.md +43 -0
  184. package/docs/EarningsCallsCalendar200ResponseEventsInnerCalendarCall.md +45 -0
  185. package/docs/EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource.md +43 -0
  186. package/docs/EarningsCallsCalendar200ResponseEventsInnerCalendarReport.md +41 -0
  187. package/docs/EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource.md +39 -0
  188. package/docs/EarningsCallsTranscript200Response.md +1 -1
  189. package/docs/EarningsCallsTranscript200ResponseEvent.md +88 -0
  190. package/docs/IPOsApi.md +5 -2
  191. package/docs/IposRegistrationsList200ResponseRegistrationsInner.md +2 -0
  192. package/docs/IposRegistrationsList200ResponseRegistrationsInnerIpoPending.md +51 -0
  193. package/docs/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.md +49 -0
  194. package/docs/SECApi.md +2646 -0
  195. package/docs/{SecFilingsList200Response.md → SecDatasets200Response.md} +11 -6
  196. package/docs/SecDocument200Response.md +53 -0
  197. package/docs/SecDocumentFactPlaces200Response.md +51 -0
  198. package/docs/SecDocumentFigure200Response.md +45 -0
  199. package/docs/SecDocumentSections200Response.md +47 -0
  200. package/docs/SecDocumentSections200ResponseSectionsInner.md +48 -0
  201. package/docs/SecFiler200Response.md +47 -0
  202. package/docs/SecFilerCoverage200Response.md +49 -0
  203. package/docs/SecFilerLifecycle200Response.md +65 -0
  204. package/docs/SecFilers200Response.md +41 -0
  205. package/docs/{SecFilingsSearch200ResponseSourcesInner.md → SecFilers200ResponseMatchesInner.md} +14 -14
  206. package/docs/SecFiling200Response.md +49 -0
  207. package/docs/SecFilingFacts200Response.md +43 -0
  208. package/docs/SecFilingHoldings200Response.md +47 -0
  209. package/docs/SecFilingReviewChain200Response.md +51 -0
  210. package/docs/SecFilingReviewRelations200Response.md +51 -0
  211. package/docs/SecFilings200Response.md +51 -0
  212. package/docs/SecFilings200ResponseFilingsInner.md +50 -0
  213. package/docs/{SecFilingsAvailableFormTypes200Response.md → SecFilings200ResponseFormFacetInner.md} +10 -6
  214. package/docs/{SecFilingsSections200Response.md → SecFinancialsCatalog200Response.md} +11 -6
  215. package/docs/SecHoldingsHolders200Response.md +67 -0
  216. package/docs/{SecFilingsList200ResponseCompaniesInner.md → SecIssuers200Response.md} +17 -10
  217. package/docs/SecReadiness.md +39 -0
  218. package/docs/SecSearch200Response.md +49 -0
  219. package/docs/SecSearch200ResponseHitsInner.md +52 -0
  220. package/docs/SecSearchCoverage.md +41 -0
  221. package/docs/{SecFilingsSearch200Response.md → SecSearchCoverageLexical.md} +13 -8
  222. package/docs/SecStoreError.md +41 -0
  223. package/docs/WebSocketFiling.md +1 -1
  224. package/package.json +1 -1
  225. package/src/apis/EarningsCallsApi.ts +32 -2
  226. package/src/apis/IPOsApi.ts +15 -2
  227. package/src/apis/SECApi.ts +2596 -0
  228. package/src/apis/index.ts +1 -1
  229. package/src/models/EarningsCallsCalendar200ResponseEventsInner.ts +15 -0
  230. package/src/models/EarningsCallsCalendar200ResponseEventsInnerCalendar.ts +159 -0
  231. package/src/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCall.ts +163 -0
  232. package/src/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource.ts +102 -0
  233. package/src/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReport.ts +123 -0
  234. package/src/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource.ts +84 -0
  235. package/src/models/EarningsCallsTranscript200Response.ts +10 -10
  236. package/src/models/EarningsCallsTranscript200ResponseEvent.ts +363 -0
  237. package/src/models/IposRegistrationsList200ResponseRegistrationsInner.ts +15 -0
  238. package/src/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPending.ts +157 -0
  239. package/src/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.ts +121 -0
  240. package/src/models/{SecFilingsSearch200Response.ts → SecDatasets200Response.ts} +41 -30
  241. package/src/models/SecDocument200Response.ts +150 -0
  242. package/src/models/SecDocumentFactPlaces200Response.ts +142 -0
  243. package/src/models/{SecFilingsSections200ResponseCompaniesInner.ts → SecDocumentFigure200Response.ts} +63 -37
  244. package/src/models/SecDocumentSections200Response.ts +133 -0
  245. package/src/models/SecDocumentSections200ResponseSectionsInner.ts +135 -0
  246. package/src/models/{SecFilingsSearch200ResponseSourcesInner.ts → SecFiler200Response.ts} +67 -52
  247. package/src/models/SecFilerCoverage200Response.ts +134 -0
  248. package/src/models/{SecFilingsList200ResponseCompaniesInnerFilingsInner.ts → SecFilerLifecycle200Response.ts} +126 -92
  249. package/src/models/SecFilers200Response.ts +109 -0
  250. package/src/models/SecFilers200ResponseMatchesInner.ts +108 -0
  251. package/src/models/SecFiling200Response.ts +134 -0
  252. package/src/models/SecFilingFacts200Response.ts +110 -0
  253. package/src/models/SecFilingHoldings200Response.ts +126 -0
  254. package/src/models/SecFilingReviewChain200Response.ts +142 -0
  255. package/src/models/SecFilingReviewRelations200Response.ts +142 -0
  256. package/src/models/SecFilings200Response.ts +156 -0
  257. package/src/models/SecFilings200ResponseFilingsInner.ts +132 -0
  258. package/src/models/{SecFilingsSections200Response.ts → SecFilings200ResponseFormFacetInner.ts} +35 -25
  259. package/src/models/SecFinancialsCatalog200Response.ts +94 -0
  260. package/src/models/{SecFilingsSections200ResponseCompaniesInnerSectionsInner.ts → SecHoldingsHolders200Response.ts} +125 -111
  261. package/src/models/{SecFilingsList200ResponseCompaniesInner.ts → SecIssuers200Response.ts} +64 -38
  262. package/src/models/SecReadiness.ts +103 -0
  263. package/src/models/SecSearch200Response.ts +159 -0
  264. package/src/models/SecSearch200ResponseHitsInner.ts +148 -0
  265. package/src/models/SecSearchCoverage.ts +115 -0
  266. package/src/models/{SecFilingsList200Response.ts → SecSearchCoverageLexical.ts} +44 -26
  267. package/src/models/SecStoreError.ts +102 -0
  268. package/src/models/WebSocketFiling.ts +1 -1
  269. package/src/models/index.ts +36 -9
  270. package/dist/apis/SECFilingsApi.d.ts +0 -117
  271. package/dist/apis/SECFilingsApi.js +0 -284
  272. package/dist/esm/apis/SECFilingsApi.d.ts +0 -117
  273. package/dist/esm/apis/SECFilingsApi.js +0 -280
  274. package/dist/models/SecFilingsAvailableFormTypes200Response.d.ts +0 -32
  275. package/dist/models/SecFilingsSections200Response.d.ts +0 -33
  276. package/docs/SECFilingsApi.md +0 -344
  277. package/docs/SecFilingsList200ResponseCompaniesInnerFilingsInner.md +0 -54
  278. package/docs/SecFilingsSections200ResponseCompaniesInner.md +0 -38
  279. package/docs/SecFilingsSections200ResponseCompaniesInnerSectionsInner.md +0 -62
  280. package/src/apis/SECFilingsApi.ts +0 -368
@@ -0,0 +1,157 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Invinite API
5
+ * Invinite financial data API. Each endpoint has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Included-Remaining` what is left of the plan\'s included credits. `GET /v1/account/usage` returns your account\'s usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost. **Coverage.** Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/company/available-companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the CIKs it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `ping` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `ping` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: Issuer and SEC text is served in full with its attribution; the licensee shows publisher, source URL and date next to it and may forward it unmodified; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs reproduce issuer or SEC text under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/account/usage` serves no licensed data and carries none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ import type { IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile } from './IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile';
17
+ import {
18
+ IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfileFromJSON,
19
+ IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfileFromJSONTyped,
20
+ IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfileToJSON,
21
+ IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfileToJSONTyped,
22
+ } from './IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile';
23
+
24
+ /**
25
+ * The issuer lifecycle's IPO-pending entry of this registration ("Pre-IPO, proposed XYZ (exchange)"), matched by CIK and track; null when the track has none. Proposed symbols stay attributes, never a listing
26
+ * @export
27
+ * @interface IposRegistrationsList200ResponseRegistrationsInnerIpoPending
28
+ */
29
+ export interface IposRegistrationsList200ResponseRegistrationsInnerIpoPending {
30
+ /**
31
+ * open (the issuer is still pre-IPO on this track) or closed
32
+ * @type {string}
33
+ * @memberof IposRegistrationsList200ResponseRegistrationsInnerIpoPending
34
+ */
35
+ status: string;
36
+ /**
37
+ * What opened the entry: exchange_approval (8-A12B / exchange certification) or ipo_calendar_match
38
+ * @type {string}
39
+ * @memberof IposRegistrationsList200ResponseRegistrationsInnerIpoPending
40
+ */
41
+ open_reason: string;
42
+ /**
43
+ * When the entry opened (ISO 8601 UTC)
44
+ * @type {Date}
45
+ * @memberof IposRegistrationsList200ResponseRegistrationsInnerIpoPending
46
+ */
47
+ opened_at: Date;
48
+ /**
49
+ * When the entry closed (ISO 8601 UTC)
50
+ * @type {Date}
51
+ * @memberof IposRegistrationsList200ResponseRegistrationsInnerIpoPending
52
+ */
53
+ closed_at: Date | null;
54
+ /**
55
+ * Why the entry closed (listed, withdrawn, …)
56
+ * @type {string}
57
+ * @memberof IposRegistrationsList200ResponseRegistrationsInnerIpoPending
58
+ */
59
+ close_reason: string | null;
60
+ /**
61
+ * Exchange the entry names
62
+ * @type {string}
63
+ * @memberof IposRegistrationsList200ResponseRegistrationsInnerIpoPending
64
+ */
65
+ exchange: string | null;
66
+ /**
67
+ *
68
+ * @type {IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile}
69
+ * @memberof IposRegistrationsList200ResponseRegistrationsInnerIpoPending
70
+ */
71
+ profile: IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile | null;
72
+ /**
73
+ * Permanent public logo URL when enriched
74
+ * @type {string}
75
+ * @memberof IposRegistrationsList200ResponseRegistrationsInnerIpoPending
76
+ */
77
+ logo_url: string | null;
78
+ /**
79
+ * Whether the profile lookup ran
80
+ * @type {IposRegistrationsList200ResponseRegistrationsInnerIpoPendingEnrichmentEnum}
81
+ * @memberof IposRegistrationsList200ResponseRegistrationsInnerIpoPending
82
+ */
83
+ enrichment: IposRegistrationsList200ResponseRegistrationsInnerIpoPendingEnrichmentEnum;
84
+ }
85
+
86
+
87
+ /**
88
+ * @export
89
+ */
90
+ export const IposRegistrationsList200ResponseRegistrationsInnerIpoPendingEnrichmentEnum = {
91
+ Enriched: 'enriched',
92
+ Pending: 'pending'
93
+ } as const;
94
+ export type IposRegistrationsList200ResponseRegistrationsInnerIpoPendingEnrichmentEnum = typeof IposRegistrationsList200ResponseRegistrationsInnerIpoPendingEnrichmentEnum[keyof typeof IposRegistrationsList200ResponseRegistrationsInnerIpoPendingEnrichmentEnum];
95
+
96
+
97
+ /**
98
+ * Check if a given object implements the IposRegistrationsList200ResponseRegistrationsInnerIpoPending interface.
99
+ */
100
+ export function instanceOfIposRegistrationsList200ResponseRegistrationsInnerIpoPending(value: object): value is IposRegistrationsList200ResponseRegistrationsInnerIpoPending {
101
+ if (!('status' in value) || value['status'] === undefined) return false;
102
+ if (!('open_reason' in value) || value['open_reason'] === undefined) return false;
103
+ if (!('opened_at' in value) || value['opened_at'] === undefined) return false;
104
+ if (!('closed_at' in value) || value['closed_at'] === undefined) return false;
105
+ if (!('close_reason' in value) || value['close_reason'] === undefined) return false;
106
+ if (!('exchange' in value) || value['exchange'] === undefined) return false;
107
+ if (!('profile' in value) || value['profile'] === undefined) return false;
108
+ if (!('logo_url' in value) || value['logo_url'] === undefined) return false;
109
+ if (!('enrichment' in value) || value['enrichment'] === undefined) return false;
110
+ return true;
111
+ }
112
+
113
+ export function IposRegistrationsList200ResponseRegistrationsInnerIpoPendingFromJSON(json: any): IposRegistrationsList200ResponseRegistrationsInnerIpoPending {
114
+ return IposRegistrationsList200ResponseRegistrationsInnerIpoPendingFromJSONTyped(json, false);
115
+ }
116
+
117
+ export function IposRegistrationsList200ResponseRegistrationsInnerIpoPendingFromJSONTyped(json: any, ignoreDiscriminator: boolean): IposRegistrationsList200ResponseRegistrationsInnerIpoPending {
118
+ if (json == null) {
119
+ return json;
120
+ }
121
+ return {
122
+
123
+ 'status': json['status'],
124
+ 'open_reason': json['open_reason'],
125
+ 'opened_at': (new Date(json['opened_at'])),
126
+ 'closed_at': (json['closed_at'] == null ? null : new Date(json['closed_at'])),
127
+ 'close_reason': json['close_reason'],
128
+ 'exchange': json['exchange'],
129
+ 'profile': IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfileFromJSON(json['profile']),
130
+ 'logo_url': json['logo_url'],
131
+ 'enrichment': json['enrichment'],
132
+ };
133
+ }
134
+
135
+ export function IposRegistrationsList200ResponseRegistrationsInnerIpoPendingToJSON(json: any): IposRegistrationsList200ResponseRegistrationsInnerIpoPending {
136
+ return IposRegistrationsList200ResponseRegistrationsInnerIpoPendingToJSONTyped(json, false);
137
+ }
138
+
139
+ export function IposRegistrationsList200ResponseRegistrationsInnerIpoPendingToJSONTyped(value?: IposRegistrationsList200ResponseRegistrationsInnerIpoPending | null, ignoreDiscriminator: boolean = false): any {
140
+ if (value == null) {
141
+ return value;
142
+ }
143
+
144
+ return {
145
+
146
+ 'status': value['status'],
147
+ 'open_reason': value['open_reason'],
148
+ 'opened_at': value['opened_at'].toISOString(),
149
+ 'closed_at': value['closed_at'] == null ? value['closed_at'] : value['closed_at'].toISOString(),
150
+ 'close_reason': value['close_reason'],
151
+ 'exchange': value['exchange'],
152
+ 'profile': IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfileToJSON(value['profile']),
153
+ 'logo_url': value['logo_url'],
154
+ 'enrichment': value['enrichment'],
155
+ };
156
+ }
157
+
@@ -0,0 +1,121 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Invinite API
5
+ * Invinite financial data API. Each endpoint has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Included-Remaining` what is left of the plan\'s included credits. `GET /v1/account/usage` returns your account\'s usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost. **Coverage.** Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/company/available-companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the CIKs it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `ping` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `ping` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: Issuer and SEC text is served in full with its attribution; the licensee shows publisher, source URL and date next to it and may forward it unmodified; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs reproduce issuer or SEC text under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/account/usage` serves no licensed data and carries none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ /**
17
+ * Issuer profile when enriched (FMP profile by CIK); only the fields present are listed
18
+ * @export
19
+ * @interface IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile
20
+ */
21
+ export interface IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile
26
+ */
27
+ company_name?: string;
28
+ /**
29
+ *
30
+ * @type {string}
31
+ * @memberof IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile
32
+ */
33
+ website?: string;
34
+ /**
35
+ *
36
+ * @type {string}
37
+ * @memberof IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile
38
+ */
39
+ industry?: string;
40
+ /**
41
+ *
42
+ * @type {string}
43
+ * @memberof IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile
44
+ */
45
+ sector?: string;
46
+ /**
47
+ *
48
+ * @type {string}
49
+ * @memberof IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile
50
+ */
51
+ country?: string;
52
+ /**
53
+ *
54
+ * @type {string}
55
+ * @memberof IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile
56
+ */
57
+ ceo?: string;
58
+ /**
59
+ *
60
+ * @type {number}
61
+ * @memberof IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile
62
+ */
63
+ full_time_employees?: number;
64
+ /**
65
+ * First 600 characters
66
+ * @type {string}
67
+ * @memberof IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile
68
+ */
69
+ description?: string;
70
+ }
71
+
72
+ /**
73
+ * Check if a given object implements the IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile interface.
74
+ */
75
+ export function instanceOfIposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile(value: object): value is IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile {
76
+ return true;
77
+ }
78
+
79
+ export function IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfileFromJSON(json: any): IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile {
80
+ return IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfileFromJSONTyped(json, false);
81
+ }
82
+
83
+ export function IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfileFromJSONTyped(json: any, ignoreDiscriminator: boolean): IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile {
84
+ if (json == null) {
85
+ return json;
86
+ }
87
+ return {
88
+
89
+ 'company_name': json['company_name'] == null ? undefined : json['company_name'],
90
+ 'website': json['website'] == null ? undefined : json['website'],
91
+ 'industry': json['industry'] == null ? undefined : json['industry'],
92
+ 'sector': json['sector'] == null ? undefined : json['sector'],
93
+ 'country': json['country'] == null ? undefined : json['country'],
94
+ 'ceo': json['ceo'] == null ? undefined : json['ceo'],
95
+ 'full_time_employees': json['full_time_employees'] == null ? undefined : json['full_time_employees'],
96
+ 'description': json['description'] == null ? undefined : json['description'],
97
+ };
98
+ }
99
+
100
+ export function IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfileToJSON(json: any): IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile {
101
+ return IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfileToJSONTyped(json, false);
102
+ }
103
+
104
+ export function IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfileToJSONTyped(value?: IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile | null, ignoreDiscriminator: boolean = false): any {
105
+ if (value == null) {
106
+ return value;
107
+ }
108
+
109
+ return {
110
+
111
+ 'company_name': value['company_name'],
112
+ 'website': value['website'],
113
+ 'industry': value['industry'],
114
+ 'sector': value['sector'],
115
+ 'country': value['country'],
116
+ 'ceo': value['ceo'],
117
+ 'full_time_employees': value['full_time_employees'],
118
+ 'description': value['description'],
119
+ };
120
+ }
121
+
@@ -13,71 +13,82 @@
13
13
  */
14
14
 
15
15
  import { mapValues } from '../runtime';
16
- import type { SecFilingsSearch200ResponseSourcesInner } from './SecFilingsSearch200ResponseSourcesInner';
16
+ import type { SecReadiness } from './SecReadiness';
17
17
  import {
18
- SecFilingsSearch200ResponseSourcesInnerFromJSON,
19
- SecFilingsSearch200ResponseSourcesInnerFromJSONTyped,
20
- SecFilingsSearch200ResponseSourcesInnerToJSON,
21
- SecFilingsSearch200ResponseSourcesInnerToJSONTyped,
22
- } from './SecFilingsSearch200ResponseSourcesInner';
18
+ SecReadinessFromJSON,
19
+ SecReadinessFromJSONTyped,
20
+ SecReadinessToJSON,
21
+ SecReadinessToJSONTyped,
22
+ } from './SecReadiness';
23
23
 
24
24
  /**
25
- *
25
+ * The active dataset releases
26
26
  * @export
27
- * @interface SecFilingsSearch200Response
27
+ * @interface SecDatasets200Response
28
28
  */
29
- export interface SecFilingsSearch200Response {
29
+ export interface SecDatasets200Response {
30
+ [key: string]: any | any;
30
31
  /**
31
- * The search response text answering the query
32
+ * The backend contract version (`secdoors.v1`)
32
33
  * @type {string}
33
- * @memberof SecFilingsSearch200Response
34
+ * @memberof SecDatasets200Response
35
+ */
36
+ api_schema: string;
37
+ /**
38
+ * Datasets
39
+ * @type {{ [key: string]: any; }}
40
+ * @memberof SecDatasets200Response
34
41
  */
35
- text: string;
42
+ datasets?: { [key: string]: any; };
36
43
  /**
37
- * List of SEC filing sources that were used to generate the response
38
- * @type {Array<SecFilingsSearch200ResponseSourcesInner>}
39
- * @memberof SecFilingsSearch200Response
44
+ *
45
+ * @type {SecReadiness}
46
+ * @memberof SecDatasets200Response
40
47
  */
41
- sources: Array<SecFilingsSearch200ResponseSourcesInner>;
48
+ readiness: SecReadiness;
42
49
  }
43
50
 
44
51
  /**
45
- * Check if a given object implements the SecFilingsSearch200Response interface.
52
+ * Check if a given object implements the SecDatasets200Response interface.
46
53
  */
47
- export function instanceOfSecFilingsSearch200Response(value: object): value is SecFilingsSearch200Response {
48
- if (!('text' in value) || value['text'] === undefined) return false;
49
- if (!('sources' in value) || value['sources'] === undefined) return false;
54
+ export function instanceOfSecDatasets200Response(value: object): value is SecDatasets200Response {
55
+ if (!('api_schema' in value) || value['api_schema'] === undefined) return false;
56
+ if (!('readiness' in value) || value['readiness'] === undefined) return false;
50
57
  return true;
51
58
  }
52
59
 
53
- export function SecFilingsSearch200ResponseFromJSON(json: any): SecFilingsSearch200Response {
54
- return SecFilingsSearch200ResponseFromJSONTyped(json, false);
60
+ export function SecDatasets200ResponseFromJSON(json: any): SecDatasets200Response {
61
+ return SecDatasets200ResponseFromJSONTyped(json, false);
55
62
  }
56
63
 
57
- export function SecFilingsSearch200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecFilingsSearch200Response {
64
+ export function SecDatasets200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecDatasets200Response {
58
65
  if (json == null) {
59
66
  return json;
60
67
  }
61
68
  return {
62
69
 
63
- 'text': json['text'],
64
- 'sources': ((json['sources'] as Array<any>).map(SecFilingsSearch200ResponseSourcesInnerFromJSON)),
70
+ ...json,
71
+ 'api_schema': json['api_schema'],
72
+ 'datasets': json['datasets'] == null ? undefined : json['datasets'],
73
+ 'readiness': SecReadinessFromJSON(json['readiness']),
65
74
  };
66
75
  }
67
76
 
68
- export function SecFilingsSearch200ResponseToJSON(json: any): SecFilingsSearch200Response {
69
- return SecFilingsSearch200ResponseToJSONTyped(json, false);
77
+ export function SecDatasets200ResponseToJSON(json: any): SecDatasets200Response {
78
+ return SecDatasets200ResponseToJSONTyped(json, false);
70
79
  }
71
80
 
72
- export function SecFilingsSearch200ResponseToJSONTyped(value?: SecFilingsSearch200Response | null, ignoreDiscriminator: boolean = false): any {
81
+ export function SecDatasets200ResponseToJSONTyped(value?: SecDatasets200Response | null, ignoreDiscriminator: boolean = false): any {
73
82
  if (value == null) {
74
83
  return value;
75
84
  }
76
85
 
77
86
  return {
78
87
 
79
- 'text': value['text'],
80
- 'sources': ((value['sources'] as Array<any>).map(SecFilingsSearch200ResponseSourcesInnerToJSON)),
88
+ ...value,
89
+ 'api_schema': value['api_schema'],
90
+ 'datasets': value['datasets'],
91
+ 'readiness': SecReadinessToJSON(value['readiness']),
81
92
  };
82
93
  }
83
94
 
@@ -0,0 +1,150 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Invinite API
5
+ * Invinite financial data API. Each endpoint has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Included-Remaining` what is left of the plan\'s included credits. `GET /v1/account/usage` returns your account\'s usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost. **Coverage.** Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/company/available-companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the CIKs it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `ping` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `ping` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: Issuer and SEC text is served in full with its attribution; the licensee shows publisher, source URL and date next to it and may forward it unmodified; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs reproduce issuer or SEC text under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/account/usage` serves no licensed data and carries none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ import type { SecReadiness } from './SecReadiness';
17
+ import {
18
+ SecReadinessFromJSON,
19
+ SecReadinessFromJSONTyped,
20
+ SecReadinessToJSON,
21
+ SecReadinessToJSONTyped,
22
+ } from './SecReadiness';
23
+
24
+ /**
25
+ * One pinned document version (selected blocks)
26
+ * @export
27
+ * @interface SecDocument200Response
28
+ */
29
+ export interface SecDocument200Response {
30
+ [key: string]: any | any;
31
+ /**
32
+ * The backend contract version (`secdoors.v1`)
33
+ * @type {string}
34
+ * @memberof SecDocument200Response
35
+ */
36
+ api_schema: string;
37
+ /**
38
+ * Blocks
39
+ * @type {Array<{ [key: string]: any; }>}
40
+ * @memberof SecDocument200Response
41
+ */
42
+ blocks?: Array<{ [key: string]: any; }>;
43
+ /**
44
+ * Footnotes
45
+ * @type {Array<{ [key: string]: any; }>}
46
+ * @memberof SecDocument200Response
47
+ */
48
+ footnotes?: Array<{ [key: string]: any; }>;
49
+ /**
50
+ * Pages
51
+ * @type {Array<{ [key: string]: any; }>}
52
+ * @memberof SecDocument200Response
53
+ */
54
+ pages?: Array<{ [key: string]: any; }>;
55
+ /**
56
+ * Quality
57
+ * @type {{ [key: string]: any; }}
58
+ * @memberof SecDocument200Response
59
+ */
60
+ quality?: { [key: string]: any; } | null;
61
+ /**
62
+ *
63
+ * @type {SecReadiness}
64
+ * @memberof SecDocument200Response
65
+ */
66
+ readiness: SecReadiness;
67
+ /**
68
+ * Selection
69
+ * @type {{ [key: string]: any; }}
70
+ * @memberof SecDocument200Response
71
+ */
72
+ selection?: { [key: string]: any; } | null;
73
+ /**
74
+ * Source
75
+ * @type {{ [key: string]: any; }}
76
+ * @memberof SecDocument200Response
77
+ */
78
+ source?: { [key: string]: any; } | null;
79
+ /**
80
+ * Toc
81
+ * @type {Array<{ [key: string]: any; }>}
82
+ * @memberof SecDocument200Response
83
+ */
84
+ toc?: Array<{ [key: string]: any; }>;
85
+ /**
86
+ * Version
87
+ * @type {{ [key: string]: any; }}
88
+ * @memberof SecDocument200Response
89
+ */
90
+ version?: { [key: string]: any; } | null;
91
+ }
92
+
93
+ /**
94
+ * Check if a given object implements the SecDocument200Response interface.
95
+ */
96
+ export function instanceOfSecDocument200Response(value: object): value is SecDocument200Response {
97
+ if (!('api_schema' in value) || value['api_schema'] === undefined) return false;
98
+ if (!('readiness' in value) || value['readiness'] === undefined) return false;
99
+ return true;
100
+ }
101
+
102
+ export function SecDocument200ResponseFromJSON(json: any): SecDocument200Response {
103
+ return SecDocument200ResponseFromJSONTyped(json, false);
104
+ }
105
+
106
+ export function SecDocument200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecDocument200Response {
107
+ if (json == null) {
108
+ return json;
109
+ }
110
+ return {
111
+
112
+ ...json,
113
+ 'api_schema': json['api_schema'],
114
+ 'blocks': json['blocks'] == null ? undefined : json['blocks'],
115
+ 'footnotes': json['footnotes'] == null ? undefined : json['footnotes'],
116
+ 'pages': json['pages'] == null ? undefined : json['pages'],
117
+ 'quality': json['quality'] == null ? undefined : json['quality'],
118
+ 'readiness': SecReadinessFromJSON(json['readiness']),
119
+ 'selection': json['selection'] == null ? undefined : json['selection'],
120
+ 'source': json['source'] == null ? undefined : json['source'],
121
+ 'toc': json['toc'] == null ? undefined : json['toc'],
122
+ 'version': json['version'] == null ? undefined : json['version'],
123
+ };
124
+ }
125
+
126
+ export function SecDocument200ResponseToJSON(json: any): SecDocument200Response {
127
+ return SecDocument200ResponseToJSONTyped(json, false);
128
+ }
129
+
130
+ export function SecDocument200ResponseToJSONTyped(value?: SecDocument200Response | null, ignoreDiscriminator: boolean = false): any {
131
+ if (value == null) {
132
+ return value;
133
+ }
134
+
135
+ return {
136
+
137
+ ...value,
138
+ 'api_schema': value['api_schema'],
139
+ 'blocks': value['blocks'],
140
+ 'footnotes': value['footnotes'],
141
+ 'pages': value['pages'],
142
+ 'quality': value['quality'],
143
+ 'readiness': SecReadinessToJSON(value['readiness']),
144
+ 'selection': value['selection'],
145
+ 'source': value['source'],
146
+ 'toc': value['toc'],
147
+ 'version': value['version'],
148
+ };
149
+ }
150
+