@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
@@ -13,99 +13,114 @@
13
13
  */
14
14
 
15
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
+
16
24
  /**
17
- *
25
+ * One filer
18
26
  * @export
19
- * @interface SecFilingsSearch200ResponseSourcesInner
27
+ * @interface SecFiler200Response
20
28
  */
21
- export interface SecFilingsSearch200ResponseSourcesInner {
29
+ export interface SecFiler200Response {
30
+ [key: string]: any | any;
22
31
  /**
23
- * CIK of the filing
32
+ * The backend contract version (`secdoors.v1`)
24
33
  * @type {string}
25
- * @memberof SecFilingsSearch200ResponseSourcesInner
34
+ * @memberof SecFiler200Response
26
35
  */
27
- cik: string;
36
+ api_schema: string;
28
37
  /**
29
- * Accession number of the filing
30
- * @type {string}
31
- * @memberof SecFilingsSearch200ResponseSourcesInner
38
+ * Filer
39
+ * @type {{ [key: string]: any; }}
40
+ * @memberof SecFiler200Response
32
41
  */
33
- accession_number: string;
42
+ filer?: { [key: string]: any; } | null;
34
43
  /**
35
- * URL to view the filing
36
- * @type {string}
37
- * @memberof SecFilingsSearch200ResponseSourcesInner
44
+ * Formernames
45
+ * @type {Array<{ [key: string]: any; }>}
46
+ * @memberof SecFiler200Response
38
47
  */
39
- html_url: string;
48
+ former_names?: Array<{ [key: string]: any; }>;
40
49
  /**
41
- * Ticker symbol of the company
42
- * @type {string}
43
- * @memberof SecFilingsSearch200ResponseSourcesInner
50
+ *
51
+ * @type {SecReadiness}
52
+ * @memberof SecFiler200Response
44
53
  */
45
- ticker: string;
54
+ readiness: SecReadiness;
46
55
  /**
47
- * Date of the filing
48
- * @type {Date}
49
- * @memberof SecFilingsSearch200ResponseSourcesInner
56
+ * Scope
57
+ * @type {{ [key: string]: any; }}
58
+ * @memberof SecFiler200Response
50
59
  */
51
- filing_date: Date;
60
+ scope?: { [key: string]: any; } | null;
52
61
  /**
53
- * Form type of the filing (e.g., 10-K, 10-Q, 8-K)
54
- * @type {string}
55
- * @memberof SecFilingsSearch200ResponseSourcesInner
62
+ * Successors
63
+ * @type {Array<{ [key: string]: any; }>}
64
+ * @memberof SecFiler200Response
65
+ */
66
+ successors?: Array<{ [key: string]: any; }>;
67
+ /**
68
+ * Tickerevidence
69
+ * @type {Array<{ [key: string]: any; }>}
70
+ * @memberof SecFiler200Response
56
71
  */
57
- form_type: string;
72
+ ticker_evidence?: Array<{ [key: string]: any; }>;
58
73
  }
59
74
 
60
75
  /**
61
- * Check if a given object implements the SecFilingsSearch200ResponseSourcesInner interface.
76
+ * Check if a given object implements the SecFiler200Response interface.
62
77
  */
63
- export function instanceOfSecFilingsSearch200ResponseSourcesInner(value: object): value is SecFilingsSearch200ResponseSourcesInner {
64
- if (!('cik' in value) || value['cik'] === undefined) return false;
65
- if (!('accession_number' in value) || value['accession_number'] === undefined) return false;
66
- if (!('html_url' in value) || value['html_url'] === undefined) return false;
67
- if (!('ticker' in value) || value['ticker'] === undefined) return false;
68
- if (!('filing_date' in value) || value['filing_date'] === undefined) return false;
69
- if (!('form_type' in value) || value['form_type'] === undefined) return false;
78
+ export function instanceOfSecFiler200Response(value: object): value is SecFiler200Response {
79
+ if (!('api_schema' in value) || value['api_schema'] === undefined) return false;
80
+ if (!('readiness' in value) || value['readiness'] === undefined) return false;
70
81
  return true;
71
82
  }
72
83
 
73
- export function SecFilingsSearch200ResponseSourcesInnerFromJSON(json: any): SecFilingsSearch200ResponseSourcesInner {
74
- return SecFilingsSearch200ResponseSourcesInnerFromJSONTyped(json, false);
84
+ export function SecFiler200ResponseFromJSON(json: any): SecFiler200Response {
85
+ return SecFiler200ResponseFromJSONTyped(json, false);
75
86
  }
76
87
 
77
- export function SecFilingsSearch200ResponseSourcesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecFilingsSearch200ResponseSourcesInner {
88
+ export function SecFiler200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecFiler200Response {
78
89
  if (json == null) {
79
90
  return json;
80
91
  }
81
92
  return {
82
93
 
83
- 'cik': json['cik'],
84
- 'accession_number': json['accession_number'],
85
- 'html_url': json['html_url'],
86
- 'ticker': json['ticker'],
87
- 'filing_date': (new Date(json['filing_date'])),
88
- 'form_type': json['form_type'],
94
+ ...json,
95
+ 'api_schema': json['api_schema'],
96
+ 'filer': json['filer'] == null ? undefined : json['filer'],
97
+ 'former_names': json['former_names'] == null ? undefined : json['former_names'],
98
+ 'readiness': SecReadinessFromJSON(json['readiness']),
99
+ 'scope': json['scope'] == null ? undefined : json['scope'],
100
+ 'successors': json['successors'] == null ? undefined : json['successors'],
101
+ 'ticker_evidence': json['ticker_evidence'] == null ? undefined : json['ticker_evidence'],
89
102
  };
90
103
  }
91
104
 
92
- export function SecFilingsSearch200ResponseSourcesInnerToJSON(json: any): SecFilingsSearch200ResponseSourcesInner {
93
- return SecFilingsSearch200ResponseSourcesInnerToJSONTyped(json, false);
105
+ export function SecFiler200ResponseToJSON(json: any): SecFiler200Response {
106
+ return SecFiler200ResponseToJSONTyped(json, false);
94
107
  }
95
108
 
96
- export function SecFilingsSearch200ResponseSourcesInnerToJSONTyped(value?: SecFilingsSearch200ResponseSourcesInner | null, ignoreDiscriminator: boolean = false): any {
109
+ export function SecFiler200ResponseToJSONTyped(value?: SecFiler200Response | null, ignoreDiscriminator: boolean = false): any {
97
110
  if (value == null) {
98
111
  return value;
99
112
  }
100
113
 
101
114
  return {
102
115
 
103
- 'cik': value['cik'],
104
- 'accession_number': value['accession_number'],
105
- 'html_url': value['html_url'],
106
- 'ticker': value['ticker'],
107
- 'filing_date': value['filing_date'].toISOString().substring(0,10),
108
- 'form_type': value['form_type'],
116
+ ...value,
117
+ 'api_schema': value['api_schema'],
118
+ 'filer': value['filer'],
119
+ 'former_names': value['former_names'],
120
+ 'readiness': SecReadinessToJSON(value['readiness']),
121
+ 'scope': value['scope'],
122
+ 'successors': value['successors'],
123
+ 'ticker_evidence': value['ticker_evidence'],
109
124
  };
110
125
  }
111
126
 
@@ -0,0 +1,134 @@
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 filer's document coverage
26
+ * @export
27
+ * @interface SecFilerCoverage200Response
28
+ */
29
+ export interface SecFilerCoverage200Response {
30
+ [key: string]: any | any;
31
+ /**
32
+ * The backend contract version (`secdoors.v1`)
33
+ * @type {string}
34
+ * @memberof SecFilerCoverage200Response
35
+ */
36
+ api_schema: string;
37
+ /**
38
+ * Cik
39
+ * @type {string}
40
+ * @memberof SecFilerCoverage200Response
41
+ */
42
+ cik?: string;
43
+ /**
44
+ * Coverage
45
+ * @type {{ [key: string]: any; }}
46
+ * @memberof SecFilerCoverage200Response
47
+ */
48
+ coverage?: { [key: string]: any; } | null;
49
+ /**
50
+ * Coverageobservedat
51
+ * @type {Date}
52
+ * @memberof SecFilerCoverage200Response
53
+ */
54
+ coverage_observed_at?: Date | null;
55
+ /**
56
+ * Coveragesource
57
+ * @type {string}
58
+ * @memberof SecFilerCoverage200Response
59
+ */
60
+ coverage_source?: string | null;
61
+ /**
62
+ * Indexed
63
+ * @type {{ [key: string]: any; }}
64
+ * @memberof SecFilerCoverage200Response
65
+ */
66
+ indexed?: { [key: string]: any; } | null;
67
+ /**
68
+ * Manifest
69
+ * @type {{ [key: string]: any; }}
70
+ * @memberof SecFilerCoverage200Response
71
+ */
72
+ manifest?: { [key: string]: any; } | null;
73
+ /**
74
+ *
75
+ * @type {SecReadiness}
76
+ * @memberof SecFilerCoverage200Response
77
+ */
78
+ readiness: SecReadiness;
79
+ }
80
+
81
+ /**
82
+ * Check if a given object implements the SecFilerCoverage200Response interface.
83
+ */
84
+ export function instanceOfSecFilerCoverage200Response(value: object): value is SecFilerCoverage200Response {
85
+ if (!('api_schema' in value) || value['api_schema'] === undefined) return false;
86
+ if (!('readiness' in value) || value['readiness'] === undefined) return false;
87
+ return true;
88
+ }
89
+
90
+ export function SecFilerCoverage200ResponseFromJSON(json: any): SecFilerCoverage200Response {
91
+ return SecFilerCoverage200ResponseFromJSONTyped(json, false);
92
+ }
93
+
94
+ export function SecFilerCoverage200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecFilerCoverage200Response {
95
+ if (json == null) {
96
+ return json;
97
+ }
98
+ return {
99
+
100
+ ...json,
101
+ 'api_schema': json['api_schema'],
102
+ 'cik': json['cik'] == null ? undefined : json['cik'],
103
+ 'coverage': json['coverage'] == null ? undefined : json['coverage'],
104
+ 'coverage_observed_at': json['coverage_observed_at'] == null ? undefined : (new Date(json['coverage_observed_at'])),
105
+ 'coverage_source': json['coverage_source'] == null ? undefined : json['coverage_source'],
106
+ 'indexed': json['indexed'] == null ? undefined : json['indexed'],
107
+ 'manifest': json['manifest'] == null ? undefined : json['manifest'],
108
+ 'readiness': SecReadinessFromJSON(json['readiness']),
109
+ };
110
+ }
111
+
112
+ export function SecFilerCoverage200ResponseToJSON(json: any): SecFilerCoverage200Response {
113
+ return SecFilerCoverage200ResponseToJSONTyped(json, false);
114
+ }
115
+
116
+ export function SecFilerCoverage200ResponseToJSONTyped(value?: SecFilerCoverage200Response | null, ignoreDiscriminator: boolean = false): any {
117
+ if (value == null) {
118
+ return value;
119
+ }
120
+
121
+ return {
122
+
123
+ ...value,
124
+ 'api_schema': value['api_schema'],
125
+ 'cik': value['cik'],
126
+ 'coverage': value['coverage'],
127
+ 'coverage_observed_at': value['coverage_observed_at'] == null ? value['coverage_observed_at'] : value['coverage_observed_at'].toISOString(),
128
+ 'coverage_source': value['coverage_source'],
129
+ 'indexed': value['indexed'],
130
+ 'manifest': value['manifest'],
131
+ 'readiness': SecReadinessToJSON(value['readiness']),
132
+ };
133
+ }
134
+
@@ -0,0 +1,198 @@
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 issuer's lifecycle
26
+ * @export
27
+ * @interface SecFilerLifecycle200Response
28
+ */
29
+ export interface SecFilerLifecycle200Response {
30
+ [key: string]: any | any;
31
+ /**
32
+ * The backend contract version (`secdoors.v1`)
33
+ * @type {string}
34
+ * @memberof SecFilerLifecycle200Response
35
+ */
36
+ api_schema: string;
37
+ /**
38
+ * Cik
39
+ * @type {string}
40
+ * @memberof SecFilerLifecycle200Response
41
+ */
42
+ cik?: string | null;
43
+ /**
44
+ * Cik10
45
+ * @type {string}
46
+ * @memberof SecFilerLifecycle200Response
47
+ */
48
+ cik10?: string | null;
49
+ /**
50
+ * Decision
51
+ * @type {{ [key: string]: any; }}
52
+ * @memberof SecFilerLifecycle200Response
53
+ */
54
+ decision?: { [key: string]: any; } | null;
55
+ /**
56
+ * Evidence
57
+ * @type {Array<{ [key: string]: any; }>}
58
+ * @memberof SecFilerLifecycle200Response
59
+ */
60
+ evidence?: Array<{ [key: string]: any; }>;
61
+ /**
62
+ * Families
63
+ * @type {{ [key: string]: any; }}
64
+ * @memberof SecFilerLifecycle200Response
65
+ */
66
+ families?: { [key: string]: any; } | null;
67
+ /**
68
+ * Ipopending
69
+ * @type {Array<{ [key: string]: any; }>}
70
+ * @memberof SecFilerLifecycle200Response
71
+ */
72
+ ipo_pending?: Array<{ [key: string]: any; }>;
73
+ /**
74
+ * Issuer
75
+ * @type {{ [key: string]: any; }}
76
+ * @memberof SecFilerLifecycle200Response
77
+ */
78
+ issuer?: { [key: string]: any; } | null;
79
+ /**
80
+ * Listing
81
+ * @type {{ [key: string]: any; }}
82
+ * @memberof SecFilerLifecycle200Response
83
+ */
84
+ listing?: { [key: string]: any; } | null;
85
+ /**
86
+ * Names
87
+ * @type {{ [key: string]: any; }}
88
+ * @memberof SecFilerLifecycle200Response
89
+ */
90
+ names?: { [key: string]: any; } | null;
91
+ /**
92
+ * Pendingactions
93
+ * @type {Array<{ [key: string]: any; }>}
94
+ * @memberof SecFilerLifecycle200Response
95
+ */
96
+ pending_actions?: Array<{ [key: string]: any; }>;
97
+ /**
98
+ * Provider
99
+ * @type {{ [key: string]: any; }}
100
+ * @memberof SecFilerLifecycle200Response
101
+ */
102
+ provider?: { [key: string]: any; } | null;
103
+ /**
104
+ *
105
+ * @type {SecReadiness}
106
+ * @memberof SecFilerLifecycle200Response
107
+ */
108
+ readiness: SecReadiness;
109
+ /**
110
+ * Registrationtracks
111
+ * @type {Array<{ [key: string]: any; }>}
112
+ * @memberof SecFilerLifecycle200Response
113
+ */
114
+ registration_tracks?: Array<{ [key: string]: any; }>;
115
+ /**
116
+ * Successions
117
+ * @type {{ [key: string]: any; }}
118
+ * @memberof SecFilerLifecycle200Response
119
+ */
120
+ successions?: { [key: string]: any; } | null;
121
+ /**
122
+ * Warnings
123
+ * @type {Array<string>}
124
+ * @memberof SecFilerLifecycle200Response
125
+ */
126
+ warnings?: Array<string>;
127
+ }
128
+
129
+ /**
130
+ * Check if a given object implements the SecFilerLifecycle200Response interface.
131
+ */
132
+ export function instanceOfSecFilerLifecycle200Response(value: object): value is SecFilerLifecycle200Response {
133
+ if (!('api_schema' in value) || value['api_schema'] === undefined) return false;
134
+ if (!('readiness' in value) || value['readiness'] === undefined) return false;
135
+ return true;
136
+ }
137
+
138
+ export function SecFilerLifecycle200ResponseFromJSON(json: any): SecFilerLifecycle200Response {
139
+ return SecFilerLifecycle200ResponseFromJSONTyped(json, false);
140
+ }
141
+
142
+ export function SecFilerLifecycle200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecFilerLifecycle200Response {
143
+ if (json == null) {
144
+ return json;
145
+ }
146
+ return {
147
+
148
+ ...json,
149
+ 'api_schema': json['api_schema'],
150
+ 'cik': json['cik'] == null ? undefined : json['cik'],
151
+ 'cik10': json['cik10'] == null ? undefined : json['cik10'],
152
+ 'decision': json['decision'] == null ? undefined : json['decision'],
153
+ 'evidence': json['evidence'] == null ? undefined : json['evidence'],
154
+ 'families': json['families'] == null ? undefined : json['families'],
155
+ 'ipo_pending': json['ipo_pending'] == null ? undefined : json['ipo_pending'],
156
+ 'issuer': json['issuer'] == null ? undefined : json['issuer'],
157
+ 'listing': json['listing'] == null ? undefined : json['listing'],
158
+ 'names': json['names'] == null ? undefined : json['names'],
159
+ 'pending_actions': json['pending_actions'] == null ? undefined : json['pending_actions'],
160
+ 'provider': json['provider'] == null ? undefined : json['provider'],
161
+ 'readiness': SecReadinessFromJSON(json['readiness']),
162
+ 'registration_tracks': json['registration_tracks'] == null ? undefined : json['registration_tracks'],
163
+ 'successions': json['successions'] == null ? undefined : json['successions'],
164
+ 'warnings': json['warnings'] == null ? undefined : json['warnings'],
165
+ };
166
+ }
167
+
168
+ export function SecFilerLifecycle200ResponseToJSON(json: any): SecFilerLifecycle200Response {
169
+ return SecFilerLifecycle200ResponseToJSONTyped(json, false);
170
+ }
171
+
172
+ export function SecFilerLifecycle200ResponseToJSONTyped(value?: SecFilerLifecycle200Response | null, ignoreDiscriminator: boolean = false): any {
173
+ if (value == null) {
174
+ return value;
175
+ }
176
+
177
+ return {
178
+
179
+ ...value,
180
+ 'api_schema': value['api_schema'],
181
+ 'cik': value['cik'],
182
+ 'cik10': value['cik10'],
183
+ 'decision': value['decision'],
184
+ 'evidence': value['evidence'],
185
+ 'families': value['families'],
186
+ 'ipo_pending': value['ipo_pending'],
187
+ 'issuer': value['issuer'],
188
+ 'listing': value['listing'],
189
+ 'names': value['names'],
190
+ 'pending_actions': value['pending_actions'],
191
+ 'provider': value['provider'],
192
+ 'readiness': SecReadinessToJSON(value['readiness']),
193
+ 'registration_tracks': value['registration_tracks'],
194
+ 'successions': value['successions'],
195
+ 'warnings': value['warnings'],
196
+ };
197
+ }
198
+
@@ -0,0 +1,109 @@
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 { SecFilers200ResponseMatchesInner } from './SecFilers200ResponseMatchesInner';
24
+ import {
25
+ SecFilers200ResponseMatchesInnerFromJSON,
26
+ SecFilers200ResponseMatchesInnerFromJSONTyped,
27
+ SecFilers200ResponseMatchesInnerToJSON,
28
+ SecFilers200ResponseMatchesInnerToJSONTyped,
29
+ } from './SecFilers200ResponseMatchesInner';
30
+
31
+ /**
32
+ * Filers matching the filters, name order
33
+ * @export
34
+ * @interface SecFilers200Response
35
+ */
36
+ export interface SecFilers200Response {
37
+ [key: string]: any | any;
38
+ /**
39
+ * The backend contract version (`secdoors.v1`)
40
+ * @type {string}
41
+ * @memberof SecFilers200Response
42
+ */
43
+ api_schema: string;
44
+ /**
45
+ * Limit
46
+ * @type {number}
47
+ * @memberof SecFilers200Response
48
+ */
49
+ limit?: number;
50
+ /**
51
+ * Matching filers
52
+ * @type {Array<SecFilers200ResponseMatchesInner>}
53
+ * @memberof SecFilers200Response
54
+ */
55
+ matches?: Array<SecFilers200ResponseMatchesInner>;
56
+ /**
57
+ *
58
+ * @type {SecReadiness}
59
+ * @memberof SecFilers200Response
60
+ */
61
+ readiness: SecReadiness;
62
+ }
63
+
64
+ /**
65
+ * Check if a given object implements the SecFilers200Response interface.
66
+ */
67
+ export function instanceOfSecFilers200Response(value: object): value is SecFilers200Response {
68
+ if (!('api_schema' in value) || value['api_schema'] === undefined) return false;
69
+ if (!('readiness' in value) || value['readiness'] === undefined) return false;
70
+ return true;
71
+ }
72
+
73
+ export function SecFilers200ResponseFromJSON(json: any): SecFilers200Response {
74
+ return SecFilers200ResponseFromJSONTyped(json, false);
75
+ }
76
+
77
+ export function SecFilers200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecFilers200Response {
78
+ if (json == null) {
79
+ return json;
80
+ }
81
+ return {
82
+
83
+ ...json,
84
+ 'api_schema': json['api_schema'],
85
+ 'limit': json['limit'] == null ? undefined : json['limit'],
86
+ 'matches': json['matches'] == null ? undefined : ((json['matches'] as Array<any>).map(SecFilers200ResponseMatchesInnerFromJSON)),
87
+ 'readiness': SecReadinessFromJSON(json['readiness']),
88
+ };
89
+ }
90
+
91
+ export function SecFilers200ResponseToJSON(json: any): SecFilers200Response {
92
+ return SecFilers200ResponseToJSONTyped(json, false);
93
+ }
94
+
95
+ export function SecFilers200ResponseToJSONTyped(value?: SecFilers200Response | null, ignoreDiscriminator: boolean = false): any {
96
+ if (value == null) {
97
+ return value;
98
+ }
99
+
100
+ return {
101
+
102
+ ...value,
103
+ 'api_schema': value['api_schema'],
104
+ 'limit': value['limit'],
105
+ 'matches': value['matches'] == null ? undefined : ((value['matches'] as Array<any>).map(SecFilers200ResponseMatchesInnerToJSON)),
106
+ 'readiness': SecReadinessToJSON(value['readiness']),
107
+ };
108
+ }
109
+