@invinite-org/data-api-client 0.10.1 → 1.1.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 (286) hide show
  1. package/.openapi-generator/FILES +77 -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/IposRegistrationsList200ResponseRegistrationsInnerIpoPending.js +83 -0
  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/esm/models/SecFilerLifecycle200Response.d.ts +146 -0
  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 +74 -0
  92. package/dist/esm/models/SecSearchCoverage.js +53 -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/{models/SecFilingsList200ResponseCompaniesInnerFilingsInner.d.ts → esm/models/SecSearchCoverageMatches.d.ts} +52 -51
  96. package/dist/esm/models/SecSearchCoverageMatches.js +65 -0
  97. package/dist/esm/models/SecStoreError.d.ts +52 -0
  98. package/dist/esm/models/{SecFilingsSections200Response.js → SecStoreError.js} +14 -16
  99. package/dist/esm/models/WebSocketFiling.d.ts +1 -1
  100. package/dist/esm/models/index.d.ts +37 -9
  101. package/dist/esm/models/index.js +37 -9
  102. package/dist/models/EarningsCallsCalendar200ResponseEventsInner.d.ts +7 -0
  103. package/dist/models/EarningsCallsCalendar200ResponseEventsInner.js +3 -0
  104. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendar.d.ts +95 -0
  105. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendar.js +103 -0
  106. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCall.d.ts +102 -0
  107. package/dist/models/{SecFilingsSections200ResponseCompaniesInnerSectionsInner.js → EarningsCallsCalendar200ResponseEventsInnerCalendarCall.js} +69 -67
  108. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource.d.ts +56 -0
  109. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource.js +66 -0
  110. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReport.d.ts +69 -0
  111. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReport.js +80 -0
  112. package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource.d.ts +44 -0
  113. package/dist/models/{SecFilingsList200ResponseCompaniesInner.js → EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource.js} +22 -25
  114. package/dist/models/EarningsCallsTranscript200Response.d.ts +3 -3
  115. package/dist/models/EarningsCallsTranscript200Response.js +3 -3
  116. package/dist/models/EarningsCallsTranscript200ResponseEvent.d.ts +233 -0
  117. package/dist/models/EarningsCallsTranscript200ResponseEvent.js +196 -0
  118. package/dist/models/IposRegistrationsList200ResponseRegistrationsInner.d.ts +7 -0
  119. package/dist/models/IposRegistrationsList200ResponseRegistrationsInner.js +3 -0
  120. package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPending.d.ts +89 -0
  121. package/dist/models/{SecFilingsList200ResponseCompaniesInnerFilingsInner.js → IposRegistrationsList200ResponseRegistrationsInnerIpoPending.js} +49 -49
  122. package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.d.ts +74 -0
  123. package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.js +62 -0
  124. package/dist/{esm/models/SecFilingsSearch200Response.d.ts → models/SecDatasets200Response.d.ts} +26 -17
  125. package/dist/models/{SecFilingsSections200Response.js → SecDatasets200Response.js} +19 -21
  126. package/dist/models/SecDocument200Response.d.ts +104 -0
  127. package/dist/models/{SecFilingsSections200ResponseCompaniesInner.js → SecDocument200Response.js} +18 -28
  128. package/dist/models/SecDocumentFactPlaces200Response.d.ts +88 -0
  129. package/dist/models/SecDocumentFactPlaces200Response.js +49 -0
  130. package/dist/models/SecDocumentFigure200Response.d.ts +70 -0
  131. package/dist/models/SecDocumentFigure200Response.js +49 -0
  132. package/dist/models/SecDocumentSections200Response.d.ts +71 -0
  133. package/dist/models/SecDocumentSections200Response.js +50 -0
  134. package/dist/models/SecDocumentSections200ResponseSectionsInner.d.ts +85 -0
  135. package/dist/models/SecDocumentSections200ResponseSectionsInner.js +52 -0
  136. package/dist/models/SecFiler200Response.d.ts +80 -0
  137. package/dist/models/SecFiler200Response.js +49 -0
  138. package/dist/models/SecFilerCoverage200Response.d.ts +82 -0
  139. package/dist/models/SecFilerCoverage200Response.js +49 -0
  140. package/dist/models/SecFilerLifecycle200Response.d.ts +146 -0
  141. package/dist/models/SecFilerLifecycle200Response.js +49 -0
  142. package/dist/models/SecFilers200Response.d.ts +53 -0
  143. package/dist/models/SecFilers200Response.js +50 -0
  144. package/dist/models/{SecFilingsSearch200ResponseSourcesInner.d.ts → SecFilers200ResponseMatchesInner.d.ts} +31 -28
  145. package/dist/models/SecFilers200ResponseMatchesInner.js +44 -0
  146. package/dist/models/SecFiling200Response.d.ts +88 -0
  147. package/dist/models/SecFiling200Response.js +49 -0
  148. package/dist/models/{SecFilingsList200Response.d.ts → SecFilingFacts200Response.d.ts} +43 -14
  149. package/dist/models/SecFilingFacts200Response.js +49 -0
  150. package/dist/models/SecFilingHoldings200Response.d.ts +74 -0
  151. package/dist/models/SecFilingHoldings200Response.js +49 -0
  152. package/dist/models/SecFilingReviewChain200Response.d.ts +92 -0
  153. package/dist/models/SecFilingReviewChain200Response.js +49 -0
  154. package/dist/models/SecFilingReviewRelations200Response.d.ts +88 -0
  155. package/dist/models/SecFilingReviewRelations200Response.js +49 -0
  156. package/dist/models/SecFilings200Response.d.ts +88 -0
  157. package/dist/models/SecFilings200Response.js +51 -0
  158. package/dist/models/SecFilings200ResponseFilingsInner.d.ts +81 -0
  159. package/dist/models/SecFilings200ResponseFilingsInner.js +44 -0
  160. package/dist/{esm/models/SecFilingsSections200Response.d.ts → models/SecFilings200ResponseFormFacetInner.d.ts} +25 -13
  161. package/dist/models/SecFilings200ResponseFormFacetInner.js +44 -0
  162. package/dist/models/SecFinancialsCatalog200Response.d.ts +48 -0
  163. package/dist/models/SecFinancialsCatalog200Response.js +49 -0
  164. package/dist/{esm/models/SecFilingsSections200ResponseCompaniesInnerSectionsInner.d.ts → models/SecHoldingsHolders200Response.d.ts} +88 -64
  165. package/dist/models/SecHoldingsHolders200Response.js +49 -0
  166. package/dist/models/{SecFilingsList200ResponseCompaniesInner.d.ts → SecIssuers200Response.d.ts} +45 -22
  167. package/dist/models/SecIssuers200Response.js +49 -0
  168. package/dist/models/{SecFilingsSections200ResponseCompaniesInner.d.ts → SecReadiness.d.ts} +34 -21
  169. package/dist/models/SecReadiness.js +63 -0
  170. package/dist/models/SecSearch200Response.d.ts +88 -0
  171. package/dist/models/SecSearch200Response.js +59 -0
  172. package/dist/models/SecSearch200ResponseHitsInner.d.ts +92 -0
  173. package/dist/models/SecSearch200ResponseHitsInner.js +45 -0
  174. package/dist/models/SecSearchCoverage.d.ts +74 -0
  175. package/dist/models/{SecFilingsSearch200ResponseSourcesInner.js → SecSearchCoverage.js} +29 -38
  176. package/dist/models/SecSearchCoverageLexical.d.ts +51 -0
  177. package/dist/models/{SecFilingsList200Response.js → SecSearchCoverageLexical.js} +15 -22
  178. package/dist/{esm/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.d.ts → models/SecSearchCoverageMatches.d.ts} +52 -51
  179. package/dist/{esm/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.js → models/SecSearchCoverageMatches.js} +35 -46
  180. package/dist/models/SecStoreError.d.ts +52 -0
  181. package/dist/models/{SecFilingsAvailableFormTypes200Response.js → SecStoreError.js} +19 -20
  182. package/dist/models/WebSocketFiling.d.ts +1 -1
  183. package/dist/models/index.d.ts +37 -9
  184. package/dist/models/index.js +37 -9
  185. package/docs/EarningsCallsApi.md +8 -2
  186. package/docs/EarningsCallsCalendar200ResponseEventsInner.md +2 -0
  187. package/docs/EarningsCallsCalendar200ResponseEventsInnerCalendar.md +43 -0
  188. package/docs/EarningsCallsCalendar200ResponseEventsInnerCalendarCall.md +45 -0
  189. package/docs/EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource.md +43 -0
  190. package/docs/EarningsCallsCalendar200ResponseEventsInnerCalendarReport.md +41 -0
  191. package/docs/EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource.md +39 -0
  192. package/docs/EarningsCallsTranscript200Response.md +1 -1
  193. package/docs/EarningsCallsTranscript200ResponseEvent.md +88 -0
  194. package/docs/IPOsApi.md +5 -2
  195. package/docs/IposRegistrationsList200ResponseRegistrationsInner.md +2 -0
  196. package/docs/IposRegistrationsList200ResponseRegistrationsInnerIpoPending.md +51 -0
  197. package/docs/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.md +49 -0
  198. package/docs/SECApi.md +2646 -0
  199. package/docs/{SecFilingsList200Response.md → SecDatasets200Response.md} +11 -6
  200. package/docs/SecDocument200Response.md +53 -0
  201. package/docs/SecDocumentFactPlaces200Response.md +51 -0
  202. package/docs/SecDocumentFigure200Response.md +45 -0
  203. package/docs/SecDocumentSections200Response.md +47 -0
  204. package/docs/SecDocumentSections200ResponseSectionsInner.md +48 -0
  205. package/docs/SecFiler200Response.md +47 -0
  206. package/docs/SecFilerCoverage200Response.md +49 -0
  207. package/docs/SecFilerLifecycle200Response.md +65 -0
  208. package/docs/SecFilers200Response.md +41 -0
  209. package/docs/{SecFilingsSearch200ResponseSourcesInner.md → SecFilers200ResponseMatchesInner.md} +14 -14
  210. package/docs/SecFiling200Response.md +49 -0
  211. package/docs/SecFilingFacts200Response.md +43 -0
  212. package/docs/SecFilingHoldings200Response.md +47 -0
  213. package/docs/SecFilingReviewChain200Response.md +51 -0
  214. package/docs/SecFilingReviewRelations200Response.md +51 -0
  215. package/docs/SecFilings200Response.md +51 -0
  216. package/docs/SecFilings200ResponseFilingsInner.md +50 -0
  217. package/docs/{SecFilingsAvailableFormTypes200Response.md → SecFilings200ResponseFormFacetInner.md} +10 -6
  218. package/docs/{SecFilingsSections200Response.md → SecFinancialsCatalog200Response.md} +11 -6
  219. package/docs/SecHoldingsHolders200Response.md +67 -0
  220. package/docs/{SecFilingsList200ResponseCompaniesInner.md → SecIssuers200Response.md} +17 -10
  221. package/docs/SecReadiness.md +39 -0
  222. package/docs/SecSearch200Response.md +49 -0
  223. package/docs/SecSearch200ResponseHitsInner.md +52 -0
  224. package/docs/SecSearchCoverage.md +45 -0
  225. package/docs/{SecFilingsSearch200Response.md → SecSearchCoverageLexical.md} +13 -8
  226. package/docs/SecSearchCoverageMatches.md +53 -0
  227. package/docs/SecStoreError.md +41 -0
  228. package/docs/WebSocketFiling.md +1 -1
  229. package/package.json +1 -1
  230. package/src/apis/EarningsCallsApi.ts +32 -2
  231. package/src/apis/IPOsApi.ts +15 -2
  232. package/src/apis/SECApi.ts +2596 -0
  233. package/src/apis/index.ts +1 -1
  234. package/src/models/EarningsCallsCalendar200ResponseEventsInner.ts +15 -0
  235. package/src/models/EarningsCallsCalendar200ResponseEventsInnerCalendar.ts +159 -0
  236. package/src/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCall.ts +163 -0
  237. package/src/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource.ts +102 -0
  238. package/src/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReport.ts +123 -0
  239. package/src/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource.ts +84 -0
  240. package/src/models/EarningsCallsTranscript200Response.ts +10 -10
  241. package/src/models/EarningsCallsTranscript200ResponseEvent.ts +363 -0
  242. package/src/models/IposRegistrationsList200ResponseRegistrationsInner.ts +15 -0
  243. package/src/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPending.ts +157 -0
  244. package/src/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.ts +121 -0
  245. package/src/models/{SecFilingsSearch200Response.ts → SecDatasets200Response.ts} +41 -30
  246. package/src/models/SecDocument200Response.ts +150 -0
  247. package/src/models/SecDocumentFactPlaces200Response.ts +142 -0
  248. package/src/models/{SecFilingsSections200ResponseCompaniesInner.ts → SecDocumentFigure200Response.ts} +63 -37
  249. package/src/models/SecDocumentSections200Response.ts +133 -0
  250. package/src/models/SecDocumentSections200ResponseSectionsInner.ts +135 -0
  251. package/src/models/{SecFilingsSearch200ResponseSourcesInner.ts → SecFiler200Response.ts} +67 -52
  252. package/src/models/SecFilerCoverage200Response.ts +134 -0
  253. package/src/models/SecFilerLifecycle200Response.ts +198 -0
  254. package/src/models/SecFilers200Response.ts +109 -0
  255. package/src/models/SecFilers200ResponseMatchesInner.ts +108 -0
  256. package/src/models/SecFiling200Response.ts +134 -0
  257. package/src/models/SecFilingFacts200Response.ts +110 -0
  258. package/src/models/SecFilingHoldings200Response.ts +126 -0
  259. package/src/models/SecFilingReviewChain200Response.ts +142 -0
  260. package/src/models/SecFilingReviewRelations200Response.ts +142 -0
  261. package/src/models/SecFilings200Response.ts +156 -0
  262. package/src/models/SecFilings200ResponseFilingsInner.ts +132 -0
  263. package/src/models/{SecFilingsSections200Response.ts → SecFilings200ResponseFormFacetInner.ts} +35 -25
  264. package/src/models/SecFinancialsCatalog200Response.ts +94 -0
  265. package/src/models/{SecFilingsSections200ResponseCompaniesInnerSectionsInner.ts → SecHoldingsHolders200Response.ts} +125 -111
  266. package/src/models/{SecFilingsList200ResponseCompaniesInner.ts → SecIssuers200Response.ts} +64 -38
  267. package/src/models/SecReadiness.ts +103 -0
  268. package/src/models/SecSearch200Response.ts +159 -0
  269. package/src/models/SecSearch200ResponseHitsInner.ts +148 -0
  270. package/src/models/SecSearchCoverage.ts +138 -0
  271. package/src/models/{SecFilingsList200Response.ts → SecSearchCoverageLexical.ts} +44 -26
  272. package/src/models/{SecFilingsList200ResponseCompaniesInnerFilingsInner.ts → SecSearchCoverageMatches.ts} +91 -93
  273. package/src/models/SecStoreError.ts +102 -0
  274. package/src/models/WebSocketFiling.ts +1 -1
  275. package/src/models/index.ts +37 -9
  276. package/dist/apis/SECFilingsApi.d.ts +0 -117
  277. package/dist/apis/SECFilingsApi.js +0 -284
  278. package/dist/esm/apis/SECFilingsApi.d.ts +0 -117
  279. package/dist/esm/apis/SECFilingsApi.js +0 -280
  280. package/dist/models/SecFilingsAvailableFormTypes200Response.d.ts +0 -32
  281. package/dist/models/SecFilingsSections200Response.d.ts +0 -33
  282. package/docs/SECFilingsApi.md +0 -344
  283. package/docs/SecFilingsList200ResponseCompaniesInnerFilingsInner.md +0 -54
  284. package/docs/SecFilingsSections200ResponseCompaniesInner.md +0 -38
  285. package/docs/SecFilingsSections200ResponseCompaniesInnerSectionsInner.md +0 -62
  286. package/src/apis/SECFilingsApi.ts +0 -368
@@ -0,0 +1,159 @@
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 { SecSearchCoverage } from './SecSearchCoverage';
17
+ import {
18
+ SecSearchCoverageFromJSON,
19
+ SecSearchCoverageFromJSONTyped,
20
+ SecSearchCoverageToJSON,
21
+ SecSearchCoverageToJSONTyped,
22
+ } from './SecSearchCoverage';
23
+ import type { SecReadiness } from './SecReadiness';
24
+ import {
25
+ SecReadinessFromJSON,
26
+ SecReadinessFromJSONTyped,
27
+ SecReadinessToJSON,
28
+ SecReadinessToJSONTyped,
29
+ } from './SecReadiness';
30
+ import type { SecSearch200ResponseHitsInner } from './SecSearch200ResponseHitsInner';
31
+ import {
32
+ SecSearch200ResponseHitsInnerFromJSON,
33
+ SecSearch200ResponseHitsInnerFromJSONTyped,
34
+ SecSearch200ResponseHitsInnerToJSON,
35
+ SecSearch200ResponseHitsInnerToJSONTyped,
36
+ } from './SecSearch200ResponseHitsInner';
37
+
38
+ /**
39
+ * Ranked, cited passages and the coverage of the searched scope
40
+ * @export
41
+ * @interface SecSearch200Response
42
+ */
43
+ export interface SecSearch200Response {
44
+ [key: string]: any | any;
45
+ /**
46
+ * The backend contract version (`secdoors.v1`)
47
+ * @type {string}
48
+ * @memberof SecSearch200Response
49
+ */
50
+ api_schema: string;
51
+ /**
52
+ *
53
+ * @type {SecSearchCoverage}
54
+ * @memberof SecSearch200Response
55
+ */
56
+ coverage?: SecSearchCoverage;
57
+ /**
58
+ * Hits, best first (literal: newest filing first)
59
+ * @type {Array<SecSearch200ResponseHitsInner>}
60
+ * @memberof SecSearch200Response
61
+ */
62
+ hits?: Array<SecSearch200ResponseHitsInner>;
63
+ /**
64
+ * Mode
65
+ * @type {SecSearch200ResponseModeEnum}
66
+ * @memberof SecSearch200Response
67
+ */
68
+ mode?: SecSearch200ResponseModeEnum | null;
69
+ /**
70
+ * Nextcursor
71
+ * @type {string}
72
+ * @memberof SecSearch200Response
73
+ */
74
+ next_cursor?: string | null;
75
+ /**
76
+ * Provider
77
+ * @type {{ [key: string]: any; }}
78
+ * @memberof SecSearch200Response
79
+ */
80
+ provider?: { [key: string]: any; } | null;
81
+ /**
82
+ *
83
+ * @type {SecReadiness}
84
+ * @memberof SecSearch200Response
85
+ */
86
+ readiness: SecReadiness;
87
+ /**
88
+ * URL of the next page (same filters, the next cursor). Omitted on the last page.
89
+ * @type {string}
90
+ * @memberof SecSearch200Response
91
+ */
92
+ next_url?: string;
93
+ }
94
+
95
+
96
+ /**
97
+ * @export
98
+ */
99
+ export const SecSearch200ResponseModeEnum = {
100
+ Lexical: 'lexical',
101
+ Literal: 'literal'
102
+ } as const;
103
+ export type SecSearch200ResponseModeEnum = typeof SecSearch200ResponseModeEnum[keyof typeof SecSearch200ResponseModeEnum];
104
+
105
+
106
+ /**
107
+ * Check if a given object implements the SecSearch200Response interface.
108
+ */
109
+ export function instanceOfSecSearch200Response(value: object): value is SecSearch200Response {
110
+ if (!('api_schema' in value) || value['api_schema'] === undefined) return false;
111
+ if (!('readiness' in value) || value['readiness'] === undefined) return false;
112
+ return true;
113
+ }
114
+
115
+ export function SecSearch200ResponseFromJSON(json: any): SecSearch200Response {
116
+ return SecSearch200ResponseFromJSONTyped(json, false);
117
+ }
118
+
119
+ export function SecSearch200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecSearch200Response {
120
+ if (json == null) {
121
+ return json;
122
+ }
123
+ return {
124
+
125
+ ...json,
126
+ 'api_schema': json['api_schema'],
127
+ 'coverage': json['coverage'] == null ? undefined : SecSearchCoverageFromJSON(json['coverage']),
128
+ 'hits': json['hits'] == null ? undefined : ((json['hits'] as Array<any>).map(SecSearch200ResponseHitsInnerFromJSON)),
129
+ 'mode': json['mode'] == null ? undefined : json['mode'],
130
+ 'next_cursor': json['next_cursor'] == null ? undefined : json['next_cursor'],
131
+ 'provider': json['provider'] == null ? undefined : json['provider'],
132
+ 'readiness': SecReadinessFromJSON(json['readiness']),
133
+ 'next_url': json['next_url'] == null ? undefined : json['next_url'],
134
+ };
135
+ }
136
+
137
+ export function SecSearch200ResponseToJSON(json: any): SecSearch200Response {
138
+ return SecSearch200ResponseToJSONTyped(json, false);
139
+ }
140
+
141
+ export function SecSearch200ResponseToJSONTyped(value?: SecSearch200Response | null, ignoreDiscriminator: boolean = false): any {
142
+ if (value == null) {
143
+ return value;
144
+ }
145
+
146
+ return {
147
+
148
+ ...value,
149
+ 'api_schema': value['api_schema'],
150
+ 'coverage': SecSearchCoverageToJSON(value['coverage']),
151
+ 'hits': value['hits'] == null ? undefined : ((value['hits'] as Array<any>).map(SecSearch200ResponseHitsInnerToJSON)),
152
+ 'mode': value['mode'],
153
+ 'next_cursor': value['next_cursor'],
154
+ 'provider': value['provider'],
155
+ 'readiness': SecReadinessToJSON(value['readiness']),
156
+ 'next_url': value['next_url'],
157
+ };
158
+ }
159
+
@@ -0,0 +1,148 @@
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 { HitMatch } from './HitMatch';
17
+ import {
18
+ HitMatchFromJSON,
19
+ HitMatchFromJSONTyped,
20
+ HitMatchToJSON,
21
+ HitMatchToJSONTyped,
22
+ } from './HitMatch';
23
+
24
+ /**
25
+ *
26
+ * @export
27
+ * @interface SecSearch200ResponseHitsInner
28
+ */
29
+ export interface SecSearch200ResponseHitsInner {
30
+ [key: string]: any | any;
31
+ /**
32
+ * The cited document version
33
+ * @type {string}
34
+ * @memberof SecSearch200ResponseHitsInner
35
+ */
36
+ version_id?: string;
37
+ /**
38
+ * Accession number
39
+ * @type {string}
40
+ * @memberof SecSearch200ResponseHitsInner
41
+ */
42
+ accession?: string;
43
+ /**
44
+ * Document file name
45
+ * @type {string}
46
+ * @memberof SecSearch200ResponseHitsInner
47
+ */
48
+ filename?: string;
49
+ /**
50
+ * Form type
51
+ * @type {string}
52
+ * @memberof SecSearch200ResponseHitsInner
53
+ */
54
+ form?: string;
55
+ /**
56
+ * SEC filing date
57
+ * @type {Date}
58
+ * @memberof SecSearch200ResponseHitsInner
59
+ */
60
+ filing_date?: Date | null;
61
+ /**
62
+ * The whole search unit (≤ 4,000 code points)
63
+ * @type {string}
64
+ * @memberof SecSearch200ResponseHitsInner
65
+ */
66
+ text?: string;
67
+ /**
68
+ * Lexical rank (ts_rank_cd); 0 for literal
69
+ * @type {number}
70
+ * @memberof SecSearch200ResponseHitsInner
71
+ */
72
+ score?: number;
73
+ /**
74
+ *
75
+ * @type {HitMatch}
76
+ * @memberof SecSearch200ResponseHitsInner
77
+ */
78
+ match?: HitMatch;
79
+ /**
80
+ * Each span in document-text and block offsets (code points)
81
+ * @type {Array<{ [key: string]: any; }>}
82
+ * @memberof SecSearch200ResponseHitsInner
83
+ */
84
+ document_spans?: Array<{ [key: string]: any; }>;
85
+ /**
86
+ * version_id, block, document route and the original's permanent `source.url`
87
+ * @type {{ [key: string]: any; }}
88
+ * @memberof SecSearch200ResponseHitsInner
89
+ */
90
+ citation?: { [key: string]: any; };
91
+ }
92
+
93
+ /**
94
+ * Check if a given object implements the SecSearch200ResponseHitsInner interface.
95
+ */
96
+ export function instanceOfSecSearch200ResponseHitsInner(value: object): value is SecSearch200ResponseHitsInner {
97
+ return true;
98
+ }
99
+
100
+ export function SecSearch200ResponseHitsInnerFromJSON(json: any): SecSearch200ResponseHitsInner {
101
+ return SecSearch200ResponseHitsInnerFromJSONTyped(json, false);
102
+ }
103
+
104
+ export function SecSearch200ResponseHitsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecSearch200ResponseHitsInner {
105
+ if (json == null) {
106
+ return json;
107
+ }
108
+ return {
109
+
110
+ ...json,
111
+ 'version_id': json['version_id'] == null ? undefined : json['version_id'],
112
+ 'accession': json['accession'] == null ? undefined : json['accession'],
113
+ 'filename': json['filename'] == null ? undefined : json['filename'],
114
+ 'form': json['form'] == null ? undefined : json['form'],
115
+ 'filing_date': json['filing_date'] == null ? undefined : (new Date(json['filing_date'])),
116
+ 'text': json['text'] == null ? undefined : json['text'],
117
+ 'score': json['score'] == null ? undefined : json['score'],
118
+ 'match': json['match'] == null ? undefined : HitMatchFromJSON(json['match']),
119
+ 'document_spans': json['document_spans'] == null ? undefined : json['document_spans'],
120
+ 'citation': json['citation'] == null ? undefined : json['citation'],
121
+ };
122
+ }
123
+
124
+ export function SecSearch200ResponseHitsInnerToJSON(json: any): SecSearch200ResponseHitsInner {
125
+ return SecSearch200ResponseHitsInnerToJSONTyped(json, false);
126
+ }
127
+
128
+ export function SecSearch200ResponseHitsInnerToJSONTyped(value?: SecSearch200ResponseHitsInner | null, ignoreDiscriminator: boolean = false): any {
129
+ if (value == null) {
130
+ return value;
131
+ }
132
+
133
+ return {
134
+
135
+ ...value,
136
+ 'version_id': value['version_id'],
137
+ 'accession': value['accession'],
138
+ 'filename': value['filename'],
139
+ 'form': value['form'],
140
+ 'filing_date': value['filing_date'] == null ? value['filing_date'] : value['filing_date'].toISOString().substring(0,10),
141
+ 'text': value['text'],
142
+ 'score': value['score'],
143
+ 'match': HitMatchToJSON(value['match']),
144
+ 'document_spans': value['document_spans'],
145
+ 'citation': value['citation'],
146
+ };
147
+ }
148
+
@@ -0,0 +1,138 @@
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 { SecSearchCoverageLexical } from './SecSearchCoverageLexical';
17
+ import {
18
+ SecSearchCoverageLexicalFromJSON,
19
+ SecSearchCoverageLexicalFromJSONTyped,
20
+ SecSearchCoverageLexicalToJSON,
21
+ SecSearchCoverageLexicalToJSONTyped,
22
+ } from './SecSearchCoverageLexical';
23
+ import type { SecSearchCoverageMatches } from './SecSearchCoverageMatches';
24
+ import {
25
+ SecSearchCoverageMatchesFromJSON,
26
+ SecSearchCoverageMatchesFromJSONTyped,
27
+ SecSearchCoverageMatchesToJSON,
28
+ SecSearchCoverageMatchesToJSONTyped,
29
+ } from './SecSearchCoverageMatches';
30
+
31
+ /**
32
+ * How much of the searched SEC scope the text index covers (the earnings search vocabulary). `forms_indexed` / `years_indexed` / `indexed_since` state the index policy; documents of other forms are counted in `lexical.not_indexed_by_policy` (by design, not a gap). For exactly one `cik`, `held` / `mirror` say how much of the filer's history is held (`held_through`).
33
+ * @export
34
+ * @interface SecSearchCoverage
35
+ */
36
+ export interface SecSearchCoverage {
37
+ [key: string]: any | any;
38
+ /**
39
+ * complete = no hits is a genuine no-result; partial / unknown = the answer may be incomplete
40
+ * @type {SecSearchCoverageCompletenessEnum}
41
+ * @memberof SecSearchCoverage
42
+ */
43
+ completeness: SecSearchCoverageCompletenessEnum;
44
+ /**
45
+ *
46
+ * @type {SecSearchCoverageLexical}
47
+ * @memberof SecSearchCoverage
48
+ */
49
+ lexical: SecSearchCoverageLexical | null;
50
+ /**
51
+ * Why the answer may be incomplete: not_projected, projection_failed, not_published, not_held, held_not_verified, too_many_matches, candidate_cap_reached, scan_budget_reached, scope_needs_review, scope_not_current, form_not_indexed, older_than_index_window, no_forms_indexed, held_gap, search_provider_not_registered, search_projection_empty, search_timeout, scope_excluded, documents_not_held
52
+ * @type {Array<string>}
53
+ * @memberof SecSearchCoverage
54
+ */
55
+ reasons: Array<string>;
56
+ /**
57
+ * The indexed form policy (`10-K*` = the form and its /A)
58
+ * @type {Array<string>}
59
+ * @memberof SecSearchCoverage
60
+ */
61
+ forms_indexed?: Array<string> | null;
62
+ /**
63
+ *
64
+ * @type {SecSearchCoverageMatches}
65
+ * @memberof SecSearchCoverage
66
+ */
67
+ matches?: SecSearchCoverageMatches | null;
68
+ /**
69
+ * What to do for a complete answer (set when `matches.capped`; null otherwise)
70
+ * @type {string}
71
+ * @memberof SecSearchCoverage
72
+ */
73
+ hint?: string | null;
74
+ }
75
+
76
+
77
+ /**
78
+ * @export
79
+ */
80
+ export const SecSearchCoverageCompletenessEnum = {
81
+ Complete: 'complete',
82
+ Partial: 'partial',
83
+ Unknown: 'unknown'
84
+ } as const;
85
+ export type SecSearchCoverageCompletenessEnum = typeof SecSearchCoverageCompletenessEnum[keyof typeof SecSearchCoverageCompletenessEnum];
86
+
87
+
88
+ /**
89
+ * Check if a given object implements the SecSearchCoverage interface.
90
+ */
91
+ export function instanceOfSecSearchCoverage(value: object): value is SecSearchCoverage {
92
+ if (!('completeness' in value) || value['completeness'] === undefined) return false;
93
+ if (!('lexical' in value) || value['lexical'] === undefined) return false;
94
+ if (!('reasons' in value) || value['reasons'] === undefined) return false;
95
+ return true;
96
+ }
97
+
98
+ export function SecSearchCoverageFromJSON(json: any): SecSearchCoverage {
99
+ return SecSearchCoverageFromJSONTyped(json, false);
100
+ }
101
+
102
+ export function SecSearchCoverageFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecSearchCoverage {
103
+ if (json == null) {
104
+ return json;
105
+ }
106
+ return {
107
+
108
+ ...json,
109
+ 'completeness': json['completeness'],
110
+ 'lexical': SecSearchCoverageLexicalFromJSON(json['lexical']),
111
+ 'reasons': json['reasons'],
112
+ 'forms_indexed': json['forms_indexed'] == null ? undefined : json['forms_indexed'],
113
+ 'matches': json['matches'] == null ? undefined : SecSearchCoverageMatchesFromJSON(json['matches']),
114
+ 'hint': json['hint'] == null ? undefined : json['hint'],
115
+ };
116
+ }
117
+
118
+ export function SecSearchCoverageToJSON(json: any): SecSearchCoverage {
119
+ return SecSearchCoverageToJSONTyped(json, false);
120
+ }
121
+
122
+ export function SecSearchCoverageToJSONTyped(value?: SecSearchCoverage | null, ignoreDiscriminator: boolean = false): any {
123
+ if (value == null) {
124
+ return value;
125
+ }
126
+
127
+ return {
128
+
129
+ ...value,
130
+ 'completeness': value['completeness'],
131
+ 'lexical': SecSearchCoverageLexicalToJSON(value['lexical']),
132
+ 'reasons': value['reasons'],
133
+ 'forms_indexed': value['forms_indexed'],
134
+ 'matches': SecSearchCoverageMatchesToJSON(value['matches']),
135
+ 'hint': value['hint'],
136
+ };
137
+ }
138
+
@@ -13,62 +13,80 @@
13
13
  */
14
14
 
15
15
  import { mapValues } from '../runtime';
16
- import type { SecFilingsList200ResponseCompaniesInner } from './SecFilingsList200ResponseCompaniesInner';
17
- import {
18
- SecFilingsList200ResponseCompaniesInnerFromJSON,
19
- SecFilingsList200ResponseCompaniesInnerFromJSONTyped,
20
- SecFilingsList200ResponseCompaniesInnerToJSON,
21
- SecFilingsList200ResponseCompaniesInnerToJSONTyped,
22
- } from './SecFilingsList200ResponseCompaniesInner';
23
-
24
16
  /**
25
- *
17
+ * The text index over the scope; null when nothing was searched (excluded / not indexed by policy)
26
18
  * @export
27
- * @interface SecFilingsList200Response
19
+ * @interface SecSearchCoverageLexical
28
20
  */
29
- export interface SecFilingsList200Response {
21
+ export interface SecSearchCoverageLexical {
22
+ [key: string]: any | any;
23
+ /**
24
+ * ready / partial / not_ready
25
+ * @type {string}
26
+ * @memberof SecSearchCoverageLexical
27
+ */
28
+ state?: string;
29
+ /**
30
+ * Documents of the scope searchable now
31
+ * @type {number}
32
+ * @memberof SecSearchCoverageLexical
33
+ */
34
+ indexed?: number;
35
+ /**
36
+ * Not indexed yet
37
+ * @type {number}
38
+ * @memberof SecSearchCoverageLexical
39
+ */
40
+ pending?: number;
30
41
  /**
31
- * Companies with filings
32
- * @type {Array<SecFilingsList200ResponseCompaniesInner>}
33
- * @memberof SecFilingsList200Response
42
+ * Indexing failed
43
+ * @type {number}
44
+ * @memberof SecSearchCoverageLexical
34
45
  */
35
- companies: Array<SecFilingsList200ResponseCompaniesInner>;
46
+ failed?: number;
36
47
  }
37
48
 
38
49
  /**
39
- * Check if a given object implements the SecFilingsList200Response interface.
50
+ * Check if a given object implements the SecSearchCoverageLexical interface.
40
51
  */
41
- export function instanceOfSecFilingsList200Response(value: object): value is SecFilingsList200Response {
42
- if (!('companies' in value) || value['companies'] === undefined) return false;
52
+ export function instanceOfSecSearchCoverageLexical(value: object): value is SecSearchCoverageLexical {
43
53
  return true;
44
54
  }
45
55
 
46
- export function SecFilingsList200ResponseFromJSON(json: any): SecFilingsList200Response {
47
- return SecFilingsList200ResponseFromJSONTyped(json, false);
56
+ export function SecSearchCoverageLexicalFromJSON(json: any): SecSearchCoverageLexical {
57
+ return SecSearchCoverageLexicalFromJSONTyped(json, false);
48
58
  }
49
59
 
50
- export function SecFilingsList200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecFilingsList200Response {
60
+ export function SecSearchCoverageLexicalFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecSearchCoverageLexical {
51
61
  if (json == null) {
52
62
  return json;
53
63
  }
54
64
  return {
55
65
 
56
- 'companies': ((json['companies'] as Array<any>).map(SecFilingsList200ResponseCompaniesInnerFromJSON)),
66
+ ...json,
67
+ 'state': json['state'] == null ? undefined : json['state'],
68
+ 'indexed': json['indexed'] == null ? undefined : json['indexed'],
69
+ 'pending': json['pending'] == null ? undefined : json['pending'],
70
+ 'failed': json['failed'] == null ? undefined : json['failed'],
57
71
  };
58
72
  }
59
73
 
60
- export function SecFilingsList200ResponseToJSON(json: any): SecFilingsList200Response {
61
- return SecFilingsList200ResponseToJSONTyped(json, false);
74
+ export function SecSearchCoverageLexicalToJSON(json: any): SecSearchCoverageLexical {
75
+ return SecSearchCoverageLexicalToJSONTyped(json, false);
62
76
  }
63
77
 
64
- export function SecFilingsList200ResponseToJSONTyped(value?: SecFilingsList200Response | null, ignoreDiscriminator: boolean = false): any {
78
+ export function SecSearchCoverageLexicalToJSONTyped(value?: SecSearchCoverageLexical | null, ignoreDiscriminator: boolean = false): any {
65
79
  if (value == null) {
66
80
  return value;
67
81
  }
68
82
 
69
83
  return {
70
84
 
71
- 'companies': ((value['companies'] as Array<any>).map(SecFilingsList200ResponseCompaniesInnerToJSON)),
85
+ ...value,
86
+ 'state': value['state'],
87
+ 'indexed': value['indexed'],
88
+ 'pending': value['pending'],
89
+ 'failed': value['failed'],
72
90
  };
73
91
  }
74
92