@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,74 @@
1
+ /**
2
+ * Invinite API
3
+ * Invinite financial data API. Each endpoint has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Included-Remaining` what is left of the plan\'s included credits. `GET /v1/account/usage` returns your account\'s usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost. **Coverage.** Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/company/available-companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the CIKs it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `ping` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `ping` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: Issuer and SEC text is served in full with its attribution; the licensee shows publisher, source URL and date next to it and may forward it unmodified; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs reproduce issuer or SEC text under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/account/usage` serves no licensed data and carries none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { SecSearchCoverageLexical } from './SecSearchCoverageLexical';
13
+ import type { SecSearchCoverageMatches } from './SecSearchCoverageMatches';
14
+ /**
15
+ * 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`).
16
+ * @export
17
+ * @interface SecSearchCoverage
18
+ */
19
+ export interface SecSearchCoverage {
20
+ [key: string]: any | any;
21
+ /**
22
+ * complete = no hits is a genuine no-result; partial / unknown = the answer may be incomplete
23
+ * @type {SecSearchCoverageCompletenessEnum}
24
+ * @memberof SecSearchCoverage
25
+ */
26
+ completeness: SecSearchCoverageCompletenessEnum;
27
+ /**
28
+ *
29
+ * @type {SecSearchCoverageLexical}
30
+ * @memberof SecSearchCoverage
31
+ */
32
+ lexical: SecSearchCoverageLexical | null;
33
+ /**
34
+ * 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
35
+ * @type {Array<string>}
36
+ * @memberof SecSearchCoverage
37
+ */
38
+ reasons: Array<string>;
39
+ /**
40
+ * The indexed form policy (`10-K*` = the form and its /A)
41
+ * @type {Array<string>}
42
+ * @memberof SecSearchCoverage
43
+ */
44
+ forms_indexed?: Array<string> | null;
45
+ /**
46
+ *
47
+ * @type {SecSearchCoverageMatches}
48
+ * @memberof SecSearchCoverage
49
+ */
50
+ matches?: SecSearchCoverageMatches | null;
51
+ /**
52
+ * What to do for a complete answer (set when `matches.capped`; null otherwise)
53
+ * @type {string}
54
+ * @memberof SecSearchCoverage
55
+ */
56
+ hint?: string | null;
57
+ }
58
+ /**
59
+ * @export
60
+ */
61
+ export declare const SecSearchCoverageCompletenessEnum: {
62
+ readonly Complete: "complete";
63
+ readonly Partial: "partial";
64
+ readonly Unknown: "unknown";
65
+ };
66
+ export type SecSearchCoverageCompletenessEnum = typeof SecSearchCoverageCompletenessEnum[keyof typeof SecSearchCoverageCompletenessEnum];
67
+ /**
68
+ * Check if a given object implements the SecSearchCoverage interface.
69
+ */
70
+ export declare function instanceOfSecSearchCoverage(value: object): value is SecSearchCoverage;
71
+ export declare function SecSearchCoverageFromJSON(json: any): SecSearchCoverage;
72
+ export declare function SecSearchCoverageFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecSearchCoverage;
73
+ export declare function SecSearchCoverageToJSON(json: any): SecSearchCoverage;
74
+ export declare function SecSearchCoverageToJSONTyped(value?: SecSearchCoverage | null, ignoreDiscriminator?: boolean): any;
@@ -13,58 +13,49 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.instanceOfSecFilingsSearch200ResponseSourcesInner = instanceOfSecFilingsSearch200ResponseSourcesInner;
17
- exports.SecFilingsSearch200ResponseSourcesInnerFromJSON = SecFilingsSearch200ResponseSourcesInnerFromJSON;
18
- exports.SecFilingsSearch200ResponseSourcesInnerFromJSONTyped = SecFilingsSearch200ResponseSourcesInnerFromJSONTyped;
19
- exports.SecFilingsSearch200ResponseSourcesInnerToJSON = SecFilingsSearch200ResponseSourcesInnerToJSON;
20
- exports.SecFilingsSearch200ResponseSourcesInnerToJSONTyped = SecFilingsSearch200ResponseSourcesInnerToJSONTyped;
16
+ exports.SecSearchCoverageCompletenessEnum = void 0;
17
+ exports.instanceOfSecSearchCoverage = instanceOfSecSearchCoverage;
18
+ exports.SecSearchCoverageFromJSON = SecSearchCoverageFromJSON;
19
+ exports.SecSearchCoverageFromJSONTyped = SecSearchCoverageFromJSONTyped;
20
+ exports.SecSearchCoverageToJSON = SecSearchCoverageToJSON;
21
+ exports.SecSearchCoverageToJSONTyped = SecSearchCoverageToJSONTyped;
22
+ const SecSearchCoverageLexical_1 = require("./SecSearchCoverageLexical");
23
+ const SecSearchCoverageMatches_1 = require("./SecSearchCoverageMatches");
21
24
  /**
22
- * Check if a given object implements the SecFilingsSearch200ResponseSourcesInner interface.
25
+ * @export
23
26
  */
24
- function instanceOfSecFilingsSearch200ResponseSourcesInner(value) {
25
- if (!('cik' in value) || value['cik'] === undefined)
26
- return false;
27
- if (!('accession_number' in value) || value['accession_number'] === undefined)
28
- return false;
29
- if (!('html_url' in value) || value['html_url'] === undefined)
30
- return false;
31
- if (!('ticker' in value) || value['ticker'] === undefined)
27
+ exports.SecSearchCoverageCompletenessEnum = {
28
+ Complete: 'complete',
29
+ Partial: 'partial',
30
+ Unknown: 'unknown'
31
+ };
32
+ /**
33
+ * Check if a given object implements the SecSearchCoverage interface.
34
+ */
35
+ function instanceOfSecSearchCoverage(value) {
36
+ if (!('completeness' in value) || value['completeness'] === undefined)
32
37
  return false;
33
- if (!('filing_date' in value) || value['filing_date'] === undefined)
38
+ if (!('lexical' in value) || value['lexical'] === undefined)
34
39
  return false;
35
- if (!('form_type' in value) || value['form_type'] === undefined)
40
+ if (!('reasons' in value) || value['reasons'] === undefined)
36
41
  return false;
37
42
  return true;
38
43
  }
39
- function SecFilingsSearch200ResponseSourcesInnerFromJSON(json) {
40
- return SecFilingsSearch200ResponseSourcesInnerFromJSONTyped(json, false);
44
+ function SecSearchCoverageFromJSON(json) {
45
+ return SecSearchCoverageFromJSONTyped(json, false);
41
46
  }
42
- function SecFilingsSearch200ResponseSourcesInnerFromJSONTyped(json, ignoreDiscriminator) {
47
+ function SecSearchCoverageFromJSONTyped(json, ignoreDiscriminator) {
43
48
  if (json == null) {
44
49
  return json;
45
50
  }
46
- return {
47
- 'cik': json['cik'],
48
- 'accession_number': json['accession_number'],
49
- 'html_url': json['html_url'],
50
- 'ticker': json['ticker'],
51
- 'filing_date': (new Date(json['filing_date'])),
52
- 'form_type': json['form_type'],
53
- };
51
+ return Object.assign(Object.assign({}, json), { 'completeness': json['completeness'], 'lexical': (0, SecSearchCoverageLexical_1.SecSearchCoverageLexicalFromJSON)(json['lexical']), 'reasons': json['reasons'], 'forms_indexed': json['forms_indexed'] == null ? undefined : json['forms_indexed'], 'matches': json['matches'] == null ? undefined : (0, SecSearchCoverageMatches_1.SecSearchCoverageMatchesFromJSON)(json['matches']), 'hint': json['hint'] == null ? undefined : json['hint'] });
54
52
  }
55
- function SecFilingsSearch200ResponseSourcesInnerToJSON(json) {
56
- return SecFilingsSearch200ResponseSourcesInnerToJSONTyped(json, false);
53
+ function SecSearchCoverageToJSON(json) {
54
+ return SecSearchCoverageToJSONTyped(json, false);
57
55
  }
58
- function SecFilingsSearch200ResponseSourcesInnerToJSONTyped(value, ignoreDiscriminator = false) {
56
+ function SecSearchCoverageToJSONTyped(value, ignoreDiscriminator = false) {
59
57
  if (value == null) {
60
58
  return value;
61
59
  }
62
- return {
63
- 'cik': value['cik'],
64
- 'accession_number': value['accession_number'],
65
- 'html_url': value['html_url'],
66
- 'ticker': value['ticker'],
67
- 'filing_date': value['filing_date'].toISOString().substring(0, 10),
68
- 'form_type': value['form_type'],
69
- };
60
+ return Object.assign(Object.assign({}, value), { 'completeness': value['completeness'], 'lexical': (0, SecSearchCoverageLexical_1.SecSearchCoverageLexicalToJSON)(value['lexical']), 'reasons': value['reasons'], 'forms_indexed': value['forms_indexed'], 'matches': (0, SecSearchCoverageMatches_1.SecSearchCoverageMatchesToJSON)(value['matches']), 'hint': value['hint'] });
70
61
  }
@@ -0,0 +1,51 @@
1
+ /**
2
+ * Invinite API
3
+ * Invinite financial data API. Each endpoint has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Included-Remaining` what is left of the plan\'s included credits. `GET /v1/account/usage` returns your account\'s usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost. **Coverage.** Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/company/available-companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the CIKs it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `ping` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `ping` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: Issuer and SEC text is served in full with its attribution; the licensee shows publisher, source URL and date next to it and may forward it unmodified; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs reproduce issuer or SEC text under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/account/usage` serves no licensed data and carries none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * The text index over the scope; null when nothing was searched (excluded / not indexed by policy)
14
+ * @export
15
+ * @interface SecSearchCoverageLexical
16
+ */
17
+ export interface SecSearchCoverageLexical {
18
+ [key: string]: any | any;
19
+ /**
20
+ * ready / partial / not_ready
21
+ * @type {string}
22
+ * @memberof SecSearchCoverageLexical
23
+ */
24
+ state?: string;
25
+ /**
26
+ * Documents of the scope searchable now
27
+ * @type {number}
28
+ * @memberof SecSearchCoverageLexical
29
+ */
30
+ indexed?: number;
31
+ /**
32
+ * Not indexed yet
33
+ * @type {number}
34
+ * @memberof SecSearchCoverageLexical
35
+ */
36
+ pending?: number;
37
+ /**
38
+ * Indexing failed
39
+ * @type {number}
40
+ * @memberof SecSearchCoverageLexical
41
+ */
42
+ failed?: number;
43
+ }
44
+ /**
45
+ * Check if a given object implements the SecSearchCoverageLexical interface.
46
+ */
47
+ export declare function instanceOfSecSearchCoverageLexical(value: object): value is SecSearchCoverageLexical;
48
+ export declare function SecSearchCoverageLexicalFromJSON(json: any): SecSearchCoverageLexical;
49
+ export declare function SecSearchCoverageLexicalFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecSearchCoverageLexical;
50
+ export declare function SecSearchCoverageLexicalToJSON(json: any): SecSearchCoverageLexical;
51
+ export declare function SecSearchCoverageLexicalToJSONTyped(value?: SecSearchCoverageLexical | null, ignoreDiscriminator?: boolean): any;
@@ -13,39 +13,32 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.instanceOfSecFilingsList200Response = instanceOfSecFilingsList200Response;
17
- exports.SecFilingsList200ResponseFromJSON = SecFilingsList200ResponseFromJSON;
18
- exports.SecFilingsList200ResponseFromJSONTyped = SecFilingsList200ResponseFromJSONTyped;
19
- exports.SecFilingsList200ResponseToJSON = SecFilingsList200ResponseToJSON;
20
- exports.SecFilingsList200ResponseToJSONTyped = SecFilingsList200ResponseToJSONTyped;
21
- const SecFilingsList200ResponseCompaniesInner_1 = require("./SecFilingsList200ResponseCompaniesInner");
16
+ exports.instanceOfSecSearchCoverageLexical = instanceOfSecSearchCoverageLexical;
17
+ exports.SecSearchCoverageLexicalFromJSON = SecSearchCoverageLexicalFromJSON;
18
+ exports.SecSearchCoverageLexicalFromJSONTyped = SecSearchCoverageLexicalFromJSONTyped;
19
+ exports.SecSearchCoverageLexicalToJSON = SecSearchCoverageLexicalToJSON;
20
+ exports.SecSearchCoverageLexicalToJSONTyped = SecSearchCoverageLexicalToJSONTyped;
22
21
  /**
23
- * Check if a given object implements the SecFilingsList200Response interface.
22
+ * Check if a given object implements the SecSearchCoverageLexical interface.
24
23
  */
25
- function instanceOfSecFilingsList200Response(value) {
26
- if (!('companies' in value) || value['companies'] === undefined)
27
- return false;
24
+ function instanceOfSecSearchCoverageLexical(value) {
28
25
  return true;
29
26
  }
30
- function SecFilingsList200ResponseFromJSON(json) {
31
- return SecFilingsList200ResponseFromJSONTyped(json, false);
27
+ function SecSearchCoverageLexicalFromJSON(json) {
28
+ return SecSearchCoverageLexicalFromJSONTyped(json, false);
32
29
  }
33
- function SecFilingsList200ResponseFromJSONTyped(json, ignoreDiscriminator) {
30
+ function SecSearchCoverageLexicalFromJSONTyped(json, ignoreDiscriminator) {
34
31
  if (json == null) {
35
32
  return json;
36
33
  }
37
- return {
38
- 'companies': (json['companies'].map(SecFilingsList200ResponseCompaniesInner_1.SecFilingsList200ResponseCompaniesInnerFromJSON)),
39
- };
34
+ return Object.assign(Object.assign({}, json), { 'state': json['state'] == null ? undefined : json['state'], 'indexed': json['indexed'] == null ? undefined : json['indexed'], 'pending': json['pending'] == null ? undefined : json['pending'], 'failed': json['failed'] == null ? undefined : json['failed'] });
40
35
  }
41
- function SecFilingsList200ResponseToJSON(json) {
42
- return SecFilingsList200ResponseToJSONTyped(json, false);
36
+ function SecSearchCoverageLexicalToJSON(json) {
37
+ return SecSearchCoverageLexicalToJSONTyped(json, false);
43
38
  }
44
- function SecFilingsList200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
39
+ function SecSearchCoverageLexicalToJSONTyped(value, ignoreDiscriminator = false) {
45
40
  if (value == null) {
46
41
  return value;
47
42
  }
48
- return {
49
- 'companies': (value['companies'].map(SecFilingsList200ResponseCompaniesInner_1.SecFilingsList200ResponseCompaniesInnerToJSON)),
50
- };
43
+ return Object.assign(Object.assign({}, value), { 'state': value['state'], 'indexed': value['indexed'], 'pending': value['pending'], 'failed': value['failed'] });
51
44
  }
@@ -9,85 +9,86 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import type { ProposedSymbol } from './ProposedSymbol';
13
12
  /**
14
- *
13
+ * The selectivity cap of a search WITHOUT any filter (null for a filtered search, which is never capped): at most `cap` matching passages are read from the index, in index order (not ranked, not newest-first), then ranked and cited
15
14
  * @export
16
- * @interface SecFilingsList200ResponseCompaniesInnerFilingsInner
15
+ * @interface SecSearchCoverageMatches
17
16
  */
18
- export interface SecFilingsList200ResponseCompaniesInnerFilingsInner {
17
+ export interface SecSearchCoverageMatches {
18
+ [key: string]: any | any;
19
19
  /**
20
- * SEC filing accession number
21
- * @type {string}
22
- * @memberof SecFilingsList200ResponseCompaniesInnerFilingsInner
20
+ * true = more passages match than were examined: the answer is partial (`too_many_matches`)
21
+ * @type {boolean}
22
+ * @memberof SecSearchCoverageMatches
23
23
  */
24
- accession_number: string;
24
+ capped: boolean;
25
25
  /**
26
- * Calendar quarter (1-4)
26
+ * The most matching passages an unfiltered search reads
27
27
  * @type {number}
28
- * @memberof SecFilingsList200ResponseCompaniesInnerFilingsInner
28
+ * @memberof SecSearchCoverageMatches
29
29
  */
30
- calendar_quarter: number;
30
+ cap: number;
31
31
  /**
32
- * Calendar year
32
+ * Matching passages read from the index (at most `cap`)
33
33
  * @type {number}
34
- * @memberof SecFilingsList200ResponseCompaniesInnerFilingsInner
35
- */
36
- calendar_year: number;
37
- /**
38
- * CIK of the company
39
- * @type {string}
40
- * @memberof SecFilingsList200ResponseCompaniesInnerFilingsInner
34
+ * @memberof SecSearchCoverageMatches
41
35
  */
42
- cik: string;
36
+ examined: number;
43
37
  /**
44
- * Filing date (YYYY-MM-DD)
45
- * @type {Date}
46
- * @memberof SecFilingsList200ResponseCompaniesInnerFilingsInner
38
+ * Of them, passages in searchable documents: the set the hits are ranked from
39
+ * @type {number}
40
+ * @memberof SecSearchCoverageMatches
47
41
  */
48
- filing_date: Date;
42
+ examined_in_scope: number;
49
43
  /**
50
- * Fiscal quarter (1-4)
44
+ * Every matching passage when not capped; null when capped (the total is unknown)
51
45
  * @type {number}
52
- * @memberof SecFilingsList200ResponseCompaniesInnerFilingsInner
46
+ * @memberof SecSearchCoverageMatches
53
47
  */
54
- fiscal_quarter: number | null;
48
+ total: number | null;
55
49
  /**
56
- * Fiscal year
50
+ * When capped: the total is at least this (cap + 1); never an estimate. null when not capped
57
51
  * @type {number}
58
- * @memberof SecFilingsList200ResponseCompaniesInnerFilingsInner
52
+ * @memberof SecSearchCoverageMatches
59
53
  */
60
- fiscal_year: number | null;
54
+ total_at_least: number | null;
61
55
  /**
62
- * SEC form type
63
- * @type {string}
64
- * @memberof SecFilingsList200ResponseCompaniesInnerFilingsInner
56
+ * Which passages were examined: the first ones the index returned (not newest-first)
57
+ * @type {SecSearchCoverageMatchesOrderEnum}
58
+ * @memberof SecSearchCoverageMatches
65
59
  */
66
- form_type: string;
60
+ order: SecSearchCoverageMatchesOrderEnum;
67
61
  /**
68
- * URL to the filing HTML
69
- * @type {string}
70
- * @memberof SecFilingsList200ResponseCompaniesInnerFilingsInner
62
+ * Earliest filing date among the examined passages in searchable documents
63
+ * @type {Date}
64
+ * @memberof SecSearchCoverageMatches
71
65
  */
72
- html_url: string | null;
66
+ filed_from: Date | null;
73
67
  /**
74
- * Period end date
68
+ * Latest filing date among the examined passages in searchable documents
75
69
  * @type {Date}
76
- * @memberof SecFilingsList200ResponseCompaniesInnerFilingsInner
70
+ * @memberof SecSearchCoverageMatches
77
71
  */
78
- period_end: Date | null;
72
+ filed_to: Date | null;
79
73
  /**
80
- * Tickers the registration statement proposes (S-1, S-1/A, F-1, F-1/A only). null = not a registration form (or not read), [] = none found
81
- * @type {Array<ProposedSymbol>}
82
- * @memberof SecFilingsList200ResponseCompaniesInnerFilingsInner
74
+ * What makes the search complete: filer (`cik`), entity (`entity_id`), form (`form`), filed_from / filed_to (`filed_from` / `filed_to`), accession (`accession`)
75
+ * @type {Array<string>}
76
+ * @memberof SecSearchCoverageMatches
83
77
  */
84
- proposed_symbols: Array<ProposedSymbol> | null;
78
+ narrow_with: Array<string>;
85
79
  }
86
80
  /**
87
- * Check if a given object implements the SecFilingsList200ResponseCompaniesInnerFilingsInner interface.
81
+ * @export
82
+ */
83
+ export declare const SecSearchCoverageMatchesOrderEnum: {
84
+ readonly IndexOrder: "index_order";
85
+ };
86
+ export type SecSearchCoverageMatchesOrderEnum = typeof SecSearchCoverageMatchesOrderEnum[keyof typeof SecSearchCoverageMatchesOrderEnum];
87
+ /**
88
+ * Check if a given object implements the SecSearchCoverageMatches interface.
88
89
  */
89
- export declare function instanceOfSecFilingsList200ResponseCompaniesInnerFilingsInner(value: object): value is SecFilingsList200ResponseCompaniesInnerFilingsInner;
90
- export declare function SecFilingsList200ResponseCompaniesInnerFilingsInnerFromJSON(json: any): SecFilingsList200ResponseCompaniesInnerFilingsInner;
91
- export declare function SecFilingsList200ResponseCompaniesInnerFilingsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecFilingsList200ResponseCompaniesInnerFilingsInner;
92
- export declare function SecFilingsList200ResponseCompaniesInnerFilingsInnerToJSON(json: any): SecFilingsList200ResponseCompaniesInnerFilingsInner;
93
- export declare function SecFilingsList200ResponseCompaniesInnerFilingsInnerToJSONTyped(value?: SecFilingsList200ResponseCompaniesInnerFilingsInner | null, ignoreDiscriminator?: boolean): any;
90
+ export declare function instanceOfSecSearchCoverageMatches(value: object): value is SecSearchCoverageMatches;
91
+ export declare function SecSearchCoverageMatchesFromJSON(json: any): SecSearchCoverageMatches;
92
+ export declare function SecSearchCoverageMatchesFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecSearchCoverageMatches;
93
+ export declare function SecSearchCoverageMatchesToJSON(json: any): SecSearchCoverageMatches;
94
+ export declare function SecSearchCoverageMatchesToJSONTyped(value?: SecSearchCoverageMatches | null, ignoreDiscriminator?: boolean): any;
@@ -1,3 +1,4 @@
1
+ "use strict";
1
2
  /* tslint:disable */
2
3
  /* eslint-disable */
3
4
  /**
@@ -11,74 +12,62 @@
11
12
  * https://openapi-generator.tech
12
13
  * Do not edit the class manually.
13
14
  */
14
- import { ProposedSymbolFromJSON, ProposedSymbolToJSON, } from './ProposedSymbol';
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.SecSearchCoverageMatchesOrderEnum = void 0;
17
+ exports.instanceOfSecSearchCoverageMatches = instanceOfSecSearchCoverageMatches;
18
+ exports.SecSearchCoverageMatchesFromJSON = SecSearchCoverageMatchesFromJSON;
19
+ exports.SecSearchCoverageMatchesFromJSONTyped = SecSearchCoverageMatchesFromJSONTyped;
20
+ exports.SecSearchCoverageMatchesToJSON = SecSearchCoverageMatchesToJSON;
21
+ exports.SecSearchCoverageMatchesToJSONTyped = SecSearchCoverageMatchesToJSONTyped;
15
22
  /**
16
- * Check if a given object implements the SecFilingsList200ResponseCompaniesInnerFilingsInner interface.
23
+ * @export
17
24
  */
18
- export function instanceOfSecFilingsList200ResponseCompaniesInnerFilingsInner(value) {
19
- if (!('accession_number' in value) || value['accession_number'] === undefined)
25
+ exports.SecSearchCoverageMatchesOrderEnum = {
26
+ IndexOrder: 'index_order'
27
+ };
28
+ /**
29
+ * Check if a given object implements the SecSearchCoverageMatches interface.
30
+ */
31
+ function instanceOfSecSearchCoverageMatches(value) {
32
+ if (!('capped' in value) || value['capped'] === undefined)
20
33
  return false;
21
- if (!('calendar_quarter' in value) || value['calendar_quarter'] === undefined)
34
+ if (!('cap' in value) || value['cap'] === undefined)
22
35
  return false;
23
- if (!('calendar_year' in value) || value['calendar_year'] === undefined)
36
+ if (!('examined' in value) || value['examined'] === undefined)
24
37
  return false;
25
- if (!('cik' in value) || value['cik'] === undefined)
38
+ if (!('examined_in_scope' in value) || value['examined_in_scope'] === undefined)
26
39
  return false;
27
- if (!('filing_date' in value) || value['filing_date'] === undefined)
40
+ if (!('total' in value) || value['total'] === undefined)
28
41
  return false;
29
- if (!('fiscal_quarter' in value) || value['fiscal_quarter'] === undefined)
42
+ if (!('total_at_least' in value) || value['total_at_least'] === undefined)
30
43
  return false;
31
- if (!('fiscal_year' in value) || value['fiscal_year'] === undefined)
44
+ if (!('order' in value) || value['order'] === undefined)
32
45
  return false;
33
- if (!('form_type' in value) || value['form_type'] === undefined)
46
+ if (value['order'] !== 'index_order')
34
47
  return false;
35
- if (!('html_url' in value) || value['html_url'] === undefined)
48
+ if (!('filed_from' in value) || value['filed_from'] === undefined)
36
49
  return false;
37
- if (!('period_end' in value) || value['period_end'] === undefined)
50
+ if (!('filed_to' in value) || value['filed_to'] === undefined)
38
51
  return false;
39
- if (!('proposed_symbols' in value) || value['proposed_symbols'] === undefined)
52
+ if (!('narrow_with' in value) || value['narrow_with'] === undefined)
40
53
  return false;
41
54
  return true;
42
55
  }
43
- export function SecFilingsList200ResponseCompaniesInnerFilingsInnerFromJSON(json) {
44
- return SecFilingsList200ResponseCompaniesInnerFilingsInnerFromJSONTyped(json, false);
56
+ function SecSearchCoverageMatchesFromJSON(json) {
57
+ return SecSearchCoverageMatchesFromJSONTyped(json, false);
45
58
  }
46
- export function SecFilingsList200ResponseCompaniesInnerFilingsInnerFromJSONTyped(json, ignoreDiscriminator) {
59
+ function SecSearchCoverageMatchesFromJSONTyped(json, ignoreDiscriminator) {
47
60
  if (json == null) {
48
61
  return json;
49
62
  }
50
- return {
51
- 'accession_number': json['accession_number'],
52
- 'calendar_quarter': json['calendar_quarter'],
53
- 'calendar_year': json['calendar_year'],
54
- 'cik': json['cik'],
55
- 'filing_date': (new Date(json['filing_date'])),
56
- 'fiscal_quarter': json['fiscal_quarter'],
57
- 'fiscal_year': json['fiscal_year'],
58
- 'form_type': json['form_type'],
59
- 'html_url': json['html_url'],
60
- 'period_end': (json['period_end'] == null ? null : new Date(json['period_end'])),
61
- 'proposed_symbols': (json['proposed_symbols'] == null ? null : json['proposed_symbols'].map(ProposedSymbolFromJSON)),
62
- };
63
+ return Object.assign(Object.assign({}, json), { 'capped': json['capped'], 'cap': json['cap'], 'examined': json['examined'], 'examined_in_scope': json['examined_in_scope'], 'total': json['total'], 'total_at_least': json['total_at_least'], 'order': json['order'], 'filed_from': (json['filed_from'] == null ? null : new Date(json['filed_from'])), 'filed_to': (json['filed_to'] == null ? null : new Date(json['filed_to'])), 'narrow_with': json['narrow_with'] });
63
64
  }
64
- export function SecFilingsList200ResponseCompaniesInnerFilingsInnerToJSON(json) {
65
- return SecFilingsList200ResponseCompaniesInnerFilingsInnerToJSONTyped(json, false);
65
+ function SecSearchCoverageMatchesToJSON(json) {
66
+ return SecSearchCoverageMatchesToJSONTyped(json, false);
66
67
  }
67
- export function SecFilingsList200ResponseCompaniesInnerFilingsInnerToJSONTyped(value, ignoreDiscriminator = false) {
68
+ function SecSearchCoverageMatchesToJSONTyped(value, ignoreDiscriminator = false) {
68
69
  if (value == null) {
69
70
  return value;
70
71
  }
71
- return {
72
- 'accession_number': value['accession_number'],
73
- 'calendar_quarter': value['calendar_quarter'],
74
- 'calendar_year': value['calendar_year'],
75
- 'cik': value['cik'],
76
- 'filing_date': value['filing_date'].toISOString().substring(0, 10),
77
- 'fiscal_quarter': value['fiscal_quarter'],
78
- 'fiscal_year': value['fiscal_year'],
79
- 'form_type': value['form_type'],
80
- 'html_url': value['html_url'],
81
- 'period_end': value['period_end'] == null ? value['period_end'] : value['period_end'].toISOString().substring(0, 10),
82
- 'proposed_symbols': (value['proposed_symbols'] == null ? null : value['proposed_symbols'].map(ProposedSymbolToJSON)),
83
- };
72
+ return Object.assign(Object.assign({}, value), { 'capped': value['capped'], 'cap': value['cap'], 'examined': value['examined'], 'examined_in_scope': value['examined_in_scope'], 'total': value['total'], 'total_at_least': value['total_at_least'], 'order': value['order'], 'filed_from': value['filed_from'] == null ? value['filed_from'] : value['filed_from'].toISOString().substring(0, 10), 'filed_to': value['filed_to'] == null ? value['filed_to'] : value['filed_to'].toISOString().substring(0, 10), 'narrow_with': value['narrow_with'] });
84
73
  }
@@ -0,0 +1,52 @@
1
+ /**
2
+ * Invinite API
3
+ * Invinite financial data API. Each endpoint has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Included-Remaining` what is left of the plan\'s included credits. `GET /v1/account/usage` returns your account\'s usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost. **Coverage.** Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/company/available-companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the CIKs it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `ping` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `ping` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: Issuer and SEC text is served in full with its attribution; the licensee shows publisher, source URL and date next to it and may forward it unmodified; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs reproduce issuer or SEC text under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/account/usage` serves no licensed data and carries none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { SecReadiness } from './SecReadiness';
13
+ /**
14
+ * `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend's typed answer when there was one (absent for a refused request). Fields of the answer's subject (e.g. `filing`) may follow.
15
+ * @export
16
+ * @interface SecStoreError
17
+ */
18
+ export interface SecStoreError {
19
+ [key: string]: any | any;
20
+ /**
21
+ * The state or refusal
22
+ * @type {string}
23
+ * @memberof SecStoreError
24
+ */
25
+ error: string;
26
+ /**
27
+ * One sentence
28
+ * @type {string}
29
+ * @memberof SecStoreError
30
+ */
31
+ message: string;
32
+ /**
33
+ * Stable snake_case reason
34
+ * @type {string}
35
+ * @memberof SecStoreError
36
+ */
37
+ code?: string | null;
38
+ /**
39
+ *
40
+ * @type {SecReadiness}
41
+ * @memberof SecStoreError
42
+ */
43
+ readiness?: SecReadiness;
44
+ }
45
+ /**
46
+ * Check if a given object implements the SecStoreError interface.
47
+ */
48
+ export declare function instanceOfSecStoreError(value: object): value is SecStoreError;
49
+ export declare function SecStoreErrorFromJSON(json: any): SecStoreError;
50
+ export declare function SecStoreErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecStoreError;
51
+ export declare function SecStoreErrorToJSON(json: any): SecStoreError;
52
+ export declare function SecStoreErrorToJSONTyped(value?: SecStoreError | null, ignoreDiscriminator?: boolean): any;