@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
@@ -9,31 +9,40 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import type { SecFilingsSearch200ResponseSourcesInner } from './SecFilingsSearch200ResponseSourcesInner';
12
+ import type { SecReadiness } from './SecReadiness';
13
13
  /**
14
- *
14
+ * The active dataset releases
15
15
  * @export
16
- * @interface SecFilingsSearch200Response
16
+ * @interface SecDatasets200Response
17
17
  */
18
- export interface SecFilingsSearch200Response {
18
+ export interface SecDatasets200Response {
19
+ [key: string]: any | any;
19
20
  /**
20
- * The search response text answering the query
21
+ * The backend contract version (`secdoors.v1`)
21
22
  * @type {string}
22
- * @memberof SecFilingsSearch200Response
23
+ * @memberof SecDatasets200Response
24
+ */
25
+ api_schema: string;
26
+ /**
27
+ * Datasets
28
+ * @type {{ [key: string]: any; }}
29
+ * @memberof SecDatasets200Response
23
30
  */
24
- text: string;
31
+ datasets?: {
32
+ [key: string]: any;
33
+ };
25
34
  /**
26
- * List of SEC filing sources that were used to generate the response
27
- * @type {Array<SecFilingsSearch200ResponseSourcesInner>}
28
- * @memberof SecFilingsSearch200Response
35
+ *
36
+ * @type {SecReadiness}
37
+ * @memberof SecDatasets200Response
29
38
  */
30
- sources: Array<SecFilingsSearch200ResponseSourcesInner>;
39
+ readiness: SecReadiness;
31
40
  }
32
41
  /**
33
- * Check if a given object implements the SecFilingsSearch200Response interface.
42
+ * Check if a given object implements the SecDatasets200Response interface.
34
43
  */
35
- export declare function instanceOfSecFilingsSearch200Response(value: object): value is SecFilingsSearch200Response;
36
- export declare function SecFilingsSearch200ResponseFromJSON(json: any): SecFilingsSearch200Response;
37
- export declare function SecFilingsSearch200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecFilingsSearch200Response;
38
- export declare function SecFilingsSearch200ResponseToJSON(json: any): SecFilingsSearch200Response;
39
- export declare function SecFilingsSearch200ResponseToJSONTyped(value?: SecFilingsSearch200Response | null, ignoreDiscriminator?: boolean): any;
44
+ export declare function instanceOfSecDatasets200Response(value: object): value is SecDatasets200Response;
45
+ export declare function SecDatasets200ResponseFromJSON(json: any): SecDatasets200Response;
46
+ export declare function SecDatasets200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecDatasets200Response;
47
+ export declare function SecDatasets200ResponseToJSON(json: any): SecDatasets200Response;
48
+ export declare function SecDatasets200ResponseToJSONTyped(value?: SecDatasets200Response | null, ignoreDiscriminator?: boolean): any;
@@ -11,38 +11,32 @@
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
- import { SecFilingsSearch200ResponseSourcesInnerFromJSON, SecFilingsSearch200ResponseSourcesInnerToJSON, } from './SecFilingsSearch200ResponseSourcesInner';
14
+ import { SecReadinessFromJSON, SecReadinessToJSON, } from './SecReadiness';
15
15
  /**
16
- * Check if a given object implements the SecFilingsSearch200Response interface.
16
+ * Check if a given object implements the SecDatasets200Response interface.
17
17
  */
18
- export function instanceOfSecFilingsSearch200Response(value) {
19
- if (!('text' in value) || value['text'] === undefined)
18
+ export function instanceOfSecDatasets200Response(value) {
19
+ if (!('api_schema' in value) || value['api_schema'] === undefined)
20
20
  return false;
21
- if (!('sources' in value) || value['sources'] === undefined)
21
+ if (!('readiness' in value) || value['readiness'] === undefined)
22
22
  return false;
23
23
  return true;
24
24
  }
25
- export function SecFilingsSearch200ResponseFromJSON(json) {
26
- return SecFilingsSearch200ResponseFromJSONTyped(json, false);
25
+ export function SecDatasets200ResponseFromJSON(json) {
26
+ return SecDatasets200ResponseFromJSONTyped(json, false);
27
27
  }
28
- export function SecFilingsSearch200ResponseFromJSONTyped(json, ignoreDiscriminator) {
28
+ export function SecDatasets200ResponseFromJSONTyped(json, ignoreDiscriminator) {
29
29
  if (json == null) {
30
30
  return json;
31
31
  }
32
- return {
33
- 'text': json['text'],
34
- 'sources': (json['sources'].map(SecFilingsSearch200ResponseSourcesInnerFromJSON)),
35
- };
32
+ return Object.assign(Object.assign({}, json), { 'api_schema': json['api_schema'], 'datasets': json['datasets'] == null ? undefined : json['datasets'], 'readiness': SecReadinessFromJSON(json['readiness']) });
36
33
  }
37
- export function SecFilingsSearch200ResponseToJSON(json) {
38
- return SecFilingsSearch200ResponseToJSONTyped(json, false);
34
+ export function SecDatasets200ResponseToJSON(json) {
35
+ return SecDatasets200ResponseToJSONTyped(json, false);
39
36
  }
40
- export function SecFilingsSearch200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
37
+ export function SecDatasets200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
41
38
  if (value == null) {
42
39
  return value;
43
40
  }
44
- return {
45
- 'text': value['text'],
46
- 'sources': (value['sources'].map(SecFilingsSearch200ResponseSourcesInnerToJSON)),
47
- };
41
+ return Object.assign(Object.assign({}, value), { 'api_schema': value['api_schema'], 'datasets': value['datasets'], 'readiness': SecReadinessToJSON(value['readiness']) });
48
42
  }
@@ -0,0 +1,104 @@
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
+ * One pinned document version (selected blocks)
15
+ * @export
16
+ * @interface SecDocument200Response
17
+ */
18
+ export interface SecDocument200Response {
19
+ [key: string]: any | any;
20
+ /**
21
+ * The backend contract version (`secdoors.v1`)
22
+ * @type {string}
23
+ * @memberof SecDocument200Response
24
+ */
25
+ api_schema: string;
26
+ /**
27
+ * Blocks
28
+ * @type {Array<{ [key: string]: any; }>}
29
+ * @memberof SecDocument200Response
30
+ */
31
+ blocks?: Array<{
32
+ [key: string]: any;
33
+ }>;
34
+ /**
35
+ * Footnotes
36
+ * @type {Array<{ [key: string]: any; }>}
37
+ * @memberof SecDocument200Response
38
+ */
39
+ footnotes?: Array<{
40
+ [key: string]: any;
41
+ }>;
42
+ /**
43
+ * Pages
44
+ * @type {Array<{ [key: string]: any; }>}
45
+ * @memberof SecDocument200Response
46
+ */
47
+ pages?: Array<{
48
+ [key: string]: any;
49
+ }>;
50
+ /**
51
+ * Quality
52
+ * @type {{ [key: string]: any; }}
53
+ * @memberof SecDocument200Response
54
+ */
55
+ quality?: {
56
+ [key: string]: any;
57
+ } | null;
58
+ /**
59
+ *
60
+ * @type {SecReadiness}
61
+ * @memberof SecDocument200Response
62
+ */
63
+ readiness: SecReadiness;
64
+ /**
65
+ * Selection
66
+ * @type {{ [key: string]: any; }}
67
+ * @memberof SecDocument200Response
68
+ */
69
+ selection?: {
70
+ [key: string]: any;
71
+ } | null;
72
+ /**
73
+ * Source
74
+ * @type {{ [key: string]: any; }}
75
+ * @memberof SecDocument200Response
76
+ */
77
+ source?: {
78
+ [key: string]: any;
79
+ } | null;
80
+ /**
81
+ * Toc
82
+ * @type {Array<{ [key: string]: any; }>}
83
+ * @memberof SecDocument200Response
84
+ */
85
+ toc?: Array<{
86
+ [key: string]: any;
87
+ }>;
88
+ /**
89
+ * Version
90
+ * @type {{ [key: string]: any; }}
91
+ * @memberof SecDocument200Response
92
+ */
93
+ version?: {
94
+ [key: string]: any;
95
+ } | null;
96
+ }
97
+ /**
98
+ * Check if a given object implements the SecDocument200Response interface.
99
+ */
100
+ export declare function instanceOfSecDocument200Response(value: object): value is SecDocument200Response;
101
+ export declare function SecDocument200ResponseFromJSON(json: any): SecDocument200Response;
102
+ export declare function SecDocument200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecDocument200Response;
103
+ export declare function SecDocument200ResponseToJSON(json: any): SecDocument200Response;
104
+ export declare function SecDocument200ResponseToJSONTyped(value?: SecDocument200Response | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,42 @@
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
+ import { SecReadinessFromJSON, SecReadinessToJSON, } from './SecReadiness';
15
+ /**
16
+ * Check if a given object implements the SecDocument200Response interface.
17
+ */
18
+ export function instanceOfSecDocument200Response(value) {
19
+ if (!('api_schema' in value) || value['api_schema'] === undefined)
20
+ return false;
21
+ if (!('readiness' in value) || value['readiness'] === undefined)
22
+ return false;
23
+ return true;
24
+ }
25
+ export function SecDocument200ResponseFromJSON(json) {
26
+ return SecDocument200ResponseFromJSONTyped(json, false);
27
+ }
28
+ export function SecDocument200ResponseFromJSONTyped(json, ignoreDiscriminator) {
29
+ if (json == null) {
30
+ return json;
31
+ }
32
+ return Object.assign(Object.assign({}, json), { 'api_schema': json['api_schema'], 'blocks': json['blocks'] == null ? undefined : json['blocks'], 'footnotes': json['footnotes'] == null ? undefined : json['footnotes'], 'pages': json['pages'] == null ? undefined : json['pages'], 'quality': json['quality'] == null ? undefined : json['quality'], 'readiness': SecReadinessFromJSON(json['readiness']), 'selection': json['selection'] == null ? undefined : json['selection'], 'source': json['source'] == null ? undefined : json['source'], 'toc': json['toc'] == null ? undefined : json['toc'], 'version': json['version'] == null ? undefined : json['version'] });
33
+ }
34
+ export function SecDocument200ResponseToJSON(json) {
35
+ return SecDocument200ResponseToJSONTyped(json, false);
36
+ }
37
+ export function SecDocument200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
38
+ if (value == null) {
39
+ return value;
40
+ }
41
+ return Object.assign(Object.assign({}, value), { 'api_schema': value['api_schema'], 'blocks': value['blocks'], 'footnotes': value['footnotes'], 'pages': value['pages'], 'quality': value['quality'], 'readiness': SecReadinessToJSON(value['readiness']), 'selection': value['selection'], 'source': value['source'], 'toc': value['toc'], 'version': value['version'] });
42
+ }
@@ -0,0 +1,88 @@
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
+ * One page of fact places
15
+ * @export
16
+ * @interface SecDocumentFactPlaces200Response
17
+ */
18
+ export interface SecDocumentFactPlaces200Response {
19
+ [key: string]: any | any;
20
+ /**
21
+ * The backend contract version (`secdoors.v1`)
22
+ * @type {string}
23
+ * @memberof SecDocumentFactPlaces200Response
24
+ */
25
+ api_schema: string;
26
+ /**
27
+ * Counts
28
+ * @type {{ [key: string]: any; }}
29
+ * @memberof SecDocumentFactPlaces200Response
30
+ */
31
+ counts?: {
32
+ [key: string]: any;
33
+ };
34
+ /**
35
+ * Nextcursor
36
+ * @type {string}
37
+ * @memberof SecDocumentFactPlaces200Response
38
+ */
39
+ next_cursor?: string | null;
40
+ /**
41
+ * Places
42
+ * @type {Array<{ [key: string]: any; }>}
43
+ * @memberof SecDocumentFactPlaces200Response
44
+ */
45
+ places?: Array<{
46
+ [key: string]: any;
47
+ }>;
48
+ /**
49
+ * Provider
50
+ * @type {{ [key: string]: any; }}
51
+ * @memberof SecDocumentFactPlaces200Response
52
+ */
53
+ provider?: {
54
+ [key: string]: any;
55
+ } | null;
56
+ /**
57
+ *
58
+ * @type {SecReadiness}
59
+ * @memberof SecDocumentFactPlaces200Response
60
+ */
61
+ readiness: SecReadiness;
62
+ /**
63
+ * Resolverversion
64
+ * @type {string}
65
+ * @memberof SecDocumentFactPlaces200Response
66
+ */
67
+ resolver_version?: string | null;
68
+ /**
69
+ * Versionid
70
+ * @type {string}
71
+ * @memberof SecDocumentFactPlaces200Response
72
+ */
73
+ version_id?: string;
74
+ /**
75
+ * URL of the next page (same filters, the next cursor). Omitted on the last page.
76
+ * @type {string}
77
+ * @memberof SecDocumentFactPlaces200Response
78
+ */
79
+ next_url?: string;
80
+ }
81
+ /**
82
+ * Check if a given object implements the SecDocumentFactPlaces200Response interface.
83
+ */
84
+ export declare function instanceOfSecDocumentFactPlaces200Response(value: object): value is SecDocumentFactPlaces200Response;
85
+ export declare function SecDocumentFactPlaces200ResponseFromJSON(json: any): SecDocumentFactPlaces200Response;
86
+ export declare function SecDocumentFactPlaces200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecDocumentFactPlaces200Response;
87
+ export declare function SecDocumentFactPlaces200ResponseToJSON(json: any): SecDocumentFactPlaces200Response;
88
+ export declare function SecDocumentFactPlaces200ResponseToJSONTyped(value?: SecDocumentFactPlaces200Response | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,42 @@
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
+ import { SecReadinessFromJSON, SecReadinessToJSON, } from './SecReadiness';
15
+ /**
16
+ * Check if a given object implements the SecDocumentFactPlaces200Response interface.
17
+ */
18
+ export function instanceOfSecDocumentFactPlaces200Response(value) {
19
+ if (!('api_schema' in value) || value['api_schema'] === undefined)
20
+ return false;
21
+ if (!('readiness' in value) || value['readiness'] === undefined)
22
+ return false;
23
+ return true;
24
+ }
25
+ export function SecDocumentFactPlaces200ResponseFromJSON(json) {
26
+ return SecDocumentFactPlaces200ResponseFromJSONTyped(json, false);
27
+ }
28
+ export function SecDocumentFactPlaces200ResponseFromJSONTyped(json, ignoreDiscriminator) {
29
+ if (json == null) {
30
+ return json;
31
+ }
32
+ return Object.assign(Object.assign({}, json), { 'api_schema': json['api_schema'], 'counts': json['counts'] == null ? undefined : json['counts'], 'next_cursor': json['next_cursor'] == null ? undefined : json['next_cursor'], 'places': json['places'] == null ? undefined : json['places'], 'provider': json['provider'] == null ? undefined : json['provider'], 'readiness': SecReadinessFromJSON(json['readiness']), 'resolver_version': json['resolver_version'] == null ? undefined : json['resolver_version'], 'version_id': json['version_id'] == null ? undefined : json['version_id'], 'next_url': json['next_url'] == null ? undefined : json['next_url'] });
33
+ }
34
+ export function SecDocumentFactPlaces200ResponseToJSON(json) {
35
+ return SecDocumentFactPlaces200ResponseToJSONTyped(json, false);
36
+ }
37
+ export function SecDocumentFactPlaces200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
38
+ if (value == null) {
39
+ return value;
40
+ }
41
+ return Object.assign(Object.assign({}, value), { 'api_schema': value['api_schema'], 'counts': value['counts'], 'next_cursor': value['next_cursor'], 'places': value['places'], 'provider': value['provider'], 'readiness': SecReadinessToJSON(value['readiness']), 'resolver_version': value['resolver_version'], 'version_id': value['version_id'], 'next_url': value['next_url'] });
42
+ }
@@ -0,0 +1,70 @@
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
+ * One figure
15
+ * @export
16
+ * @interface SecDocumentFigure200Response
17
+ */
18
+ export interface SecDocumentFigure200Response {
19
+ [key: string]: any | any;
20
+ /**
21
+ * The backend contract version (`secdoors.v1`)
22
+ * @type {string}
23
+ * @memberof SecDocumentFigure200Response
24
+ */
25
+ api_schema: string;
26
+ /**
27
+ * Citation
28
+ * @type {{ [key: string]: any; }}
29
+ * @memberof SecDocumentFigure200Response
30
+ */
31
+ citation?: {
32
+ [key: string]: any;
33
+ } | null;
34
+ /**
35
+ * Figure
36
+ * @type {{ [key: string]: any; }}
37
+ * @memberof SecDocumentFigure200Response
38
+ */
39
+ figure?: {
40
+ [key: string]: any;
41
+ } | null;
42
+ /**
43
+ * Image
44
+ * @type {{ [key: string]: any; }}
45
+ * @memberof SecDocumentFigure200Response
46
+ */
47
+ image?: {
48
+ [key: string]: any;
49
+ } | null;
50
+ /**
51
+ *
52
+ * @type {SecReadiness}
53
+ * @memberof SecDocumentFigure200Response
54
+ */
55
+ readiness: SecReadiness;
56
+ /**
57
+ * Versionid
58
+ * @type {string}
59
+ * @memberof SecDocumentFigure200Response
60
+ */
61
+ version_id?: string | null;
62
+ }
63
+ /**
64
+ * Check if a given object implements the SecDocumentFigure200Response interface.
65
+ */
66
+ export declare function instanceOfSecDocumentFigure200Response(value: object): value is SecDocumentFigure200Response;
67
+ export declare function SecDocumentFigure200ResponseFromJSON(json: any): SecDocumentFigure200Response;
68
+ export declare function SecDocumentFigure200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecDocumentFigure200Response;
69
+ export declare function SecDocumentFigure200ResponseToJSON(json: any): SecDocumentFigure200Response;
70
+ export declare function SecDocumentFigure200ResponseToJSONTyped(value?: SecDocumentFigure200Response | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,42 @@
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
+ import { SecReadinessFromJSON, SecReadinessToJSON, } from './SecReadiness';
15
+ /**
16
+ * Check if a given object implements the SecDocumentFigure200Response interface.
17
+ */
18
+ export function instanceOfSecDocumentFigure200Response(value) {
19
+ if (!('api_schema' in value) || value['api_schema'] === undefined)
20
+ return false;
21
+ if (!('readiness' in value) || value['readiness'] === undefined)
22
+ return false;
23
+ return true;
24
+ }
25
+ export function SecDocumentFigure200ResponseFromJSON(json) {
26
+ return SecDocumentFigure200ResponseFromJSONTyped(json, false);
27
+ }
28
+ export function SecDocumentFigure200ResponseFromJSONTyped(json, ignoreDiscriminator) {
29
+ if (json == null) {
30
+ return json;
31
+ }
32
+ return Object.assign(Object.assign({}, json), { 'api_schema': json['api_schema'], 'citation': json['citation'] == null ? undefined : json['citation'], 'figure': json['figure'] == null ? undefined : json['figure'], 'image': json['image'] == null ? undefined : json['image'], 'readiness': SecReadinessFromJSON(json['readiness']), 'version_id': json['version_id'] == null ? undefined : json['version_id'] });
33
+ }
34
+ export function SecDocumentFigure200ResponseToJSON(json) {
35
+ return SecDocumentFigure200ResponseToJSONTyped(json, false);
36
+ }
37
+ export function SecDocumentFigure200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
38
+ if (value == null) {
39
+ return value;
40
+ }
41
+ return Object.assign(Object.assign({}, value), { 'api_schema': value['api_schema'], 'citation': value['citation'], 'figure': value['figure'], 'image': value['image'], 'readiness': SecReadinessToJSON(value['readiness']), 'version_id': value['version_id'] });
42
+ }
@@ -0,0 +1,71 @@
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
+ import type { SecDocumentSections200ResponseSectionsInner } from './SecDocumentSections200ResponseSectionsInner';
14
+ /**
15
+ * One version's section outline
16
+ * @export
17
+ * @interface SecDocumentSections200Response
18
+ */
19
+ export interface SecDocumentSections200Response {
20
+ [key: string]: any | any;
21
+ /**
22
+ * Accession
23
+ * @type {string}
24
+ * @memberof SecDocumentSections200Response
25
+ */
26
+ accession?: string | null;
27
+ /**
28
+ * The backend contract version (`secdoors.v1`)
29
+ * @type {string}
30
+ * @memberof SecDocumentSections200Response
31
+ */
32
+ api_schema: string;
33
+ /**
34
+ * Filename
35
+ * @type {string}
36
+ * @memberof SecDocumentSections200Response
37
+ */
38
+ filename?: string | null;
39
+ /**
40
+ * Projectionversion
41
+ * @type {string}
42
+ * @memberof SecDocumentSections200Response
43
+ */
44
+ projection_version?: string | null;
45
+ /**
46
+ *
47
+ * @type {SecReadiness}
48
+ * @memberof SecDocumentSections200Response
49
+ */
50
+ readiness: SecReadiness;
51
+ /**
52
+ * Sections in outline order
53
+ * @type {Array<SecDocumentSections200ResponseSectionsInner>}
54
+ * @memberof SecDocumentSections200Response
55
+ */
56
+ sections?: Array<SecDocumentSections200ResponseSectionsInner>;
57
+ /**
58
+ * Versionid
59
+ * @type {string}
60
+ * @memberof SecDocumentSections200Response
61
+ */
62
+ version_id?: string | null;
63
+ }
64
+ /**
65
+ * Check if a given object implements the SecDocumentSections200Response interface.
66
+ */
67
+ export declare function instanceOfSecDocumentSections200Response(value: object): value is SecDocumentSections200Response;
68
+ export declare function SecDocumentSections200ResponseFromJSON(json: any): SecDocumentSections200Response;
69
+ export declare function SecDocumentSections200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecDocumentSections200Response;
70
+ export declare function SecDocumentSections200ResponseToJSON(json: any): SecDocumentSections200Response;
71
+ export declare function SecDocumentSections200ResponseToJSONTyped(value?: SecDocumentSections200Response | null, ignoreDiscriminator?: boolean): any;