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

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