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

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