@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.
- package/.openapi-generator/FILES +74 -20
- package/README.md +32 -2
- package/dist/apis/EarningsCallsApi.d.ts +24 -2
- package/dist/apis/EarningsCallsApi.js +27 -3
- package/dist/apis/IPOsApi.d.ts +11 -2
- package/dist/apis/IPOsApi.js +13 -3
- package/dist/apis/SECApi.d.ts +840 -0
- package/dist/apis/SECApi.js +1959 -0
- package/dist/apis/index.d.ts +1 -1
- package/dist/apis/index.js +1 -1
- package/dist/esm/apis/EarningsCallsApi.d.ts +24 -2
- package/dist/esm/apis/EarningsCallsApi.js +26 -2
- package/dist/esm/apis/IPOsApi.d.ts +11 -2
- package/dist/esm/apis/IPOsApi.js +12 -2
- package/dist/esm/apis/SECApi.d.ts +840 -0
- package/dist/esm/apis/SECApi.js +1955 -0
- package/dist/esm/apis/index.d.ts +1 -1
- package/dist/esm/apis/index.js +1 -1
- package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInner.d.ts +7 -0
- package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInner.js +3 -0
- package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerCalendar.d.ts +95 -0
- package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerCalendar.js +95 -0
- package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCall.d.ts +102 -0
- package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCall.js +100 -0
- package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource.d.ts +56 -0
- package/dist/esm/models/{SecFilingsSearch200ResponseSourcesInner.js → EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource.js} +23 -27
- package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReport.d.ts +69 -0
- package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReport.js +72 -0
- package/{src/models/SecFilingsAvailableFormTypes200Response.ts → dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource.d.ts} +26 -48
- package/dist/esm/models/{SecFilingsSections200ResponseCompaniesInner.js → EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource.js} +17 -18
- package/dist/esm/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.d.ts +6 -0
- package/dist/esm/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.js +2 -0
- package/dist/esm/models/EarningsCallsDocuments200ResponseDocumentsInner.d.ts +6 -0
- package/dist/esm/models/EarningsCallsDocuments200ResponseDocumentsInner.js +2 -0
- package/dist/esm/models/EarningsCallsTranscript200Response.d.ts +3 -3
- package/dist/esm/models/EarningsCallsTranscript200Response.js +3 -3
- package/dist/esm/models/EarningsCallsTranscript200ResponseEvent.d.ts +233 -0
- package/dist/esm/models/{SecFilingsSections200ResponseCompaniesInnerSectionsInner.js → EarningsCallsTranscript200ResponseEvent.js} +136 -47
- package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInner.d.ts +7 -0
- package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInner.js +3 -0
- package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPending.d.ts +89 -0
- package/dist/esm/models/{SecFilingsList200ResponseCompaniesInnerFilingsInner.js → IposRegistrationsList200ResponseRegistrationsInnerIpoPending.js} +43 -44
- package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.d.ts +74 -0
- package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.js +55 -0
- package/dist/{models/SecFilingsSearch200Response.d.ts → esm/models/SecDatasets200Response.d.ts} +26 -17
- package/dist/esm/models/{SecFilingsSearch200Response.js → SecDatasets200Response.js} +13 -19
- package/dist/esm/models/SecDocument200Response.d.ts +104 -0
- package/dist/esm/models/SecDocument200Response.js +42 -0
- package/dist/esm/models/SecDocumentFactPlaces200Response.d.ts +88 -0
- package/dist/esm/models/SecDocumentFactPlaces200Response.js +42 -0
- package/dist/esm/models/SecDocumentFigure200Response.d.ts +70 -0
- package/dist/esm/models/SecDocumentFigure200Response.js +42 -0
- package/dist/esm/models/SecDocumentSections200Response.d.ts +71 -0
- package/dist/esm/models/SecDocumentSections200Response.js +43 -0
- package/dist/esm/models/SecDocumentSections200ResponseSectionsInner.d.ts +85 -0
- package/dist/esm/models/SecDocumentSections200ResponseSectionsInner.js +44 -0
- package/dist/esm/models/SecFiler200Response.d.ts +80 -0
- package/dist/esm/models/{SecFilingsList200ResponseCompaniesInner.js → SecFiler200Response.js} +13 -25
- package/dist/esm/models/SecFilerCoverage200Response.d.ts +82 -0
- package/dist/esm/models/SecFilerCoverage200Response.js +42 -0
- package/dist/{models/SecFilingsList200ResponseCompaniesInnerFilingsInner.d.ts → esm/models/SecFilerLifecycle200Response.d.ts} +106 -53
- package/dist/esm/models/SecFilerLifecycle200Response.js +42 -0
- package/dist/esm/models/SecFilers200Response.d.ts +53 -0
- package/dist/esm/models/SecFilers200Response.js +43 -0
- package/dist/esm/models/{SecFilingsSearch200ResponseSourcesInner.d.ts → SecFilers200ResponseMatchesInner.d.ts} +31 -28
- package/dist/esm/models/SecFilers200ResponseMatchesInner.js +37 -0
- package/dist/esm/models/SecFiling200Response.d.ts +88 -0
- package/dist/{models/SecFilingsSearch200Response.js → esm/models/SecFiling200Response.js} +13 -26
- package/dist/esm/models/{SecFilingsList200Response.d.ts → SecFilingFacts200Response.d.ts} +43 -14
- package/dist/esm/models/SecFilingFacts200Response.js +42 -0
- package/dist/esm/models/SecFilingHoldings200Response.d.ts +74 -0
- package/dist/esm/models/SecFilingHoldings200Response.js +42 -0
- package/dist/esm/models/SecFilingReviewChain200Response.d.ts +92 -0
- package/dist/esm/models/SecFilingReviewChain200Response.js +42 -0
- package/dist/esm/models/SecFilingReviewRelations200Response.d.ts +88 -0
- package/dist/esm/models/SecFilingReviewRelations200Response.js +42 -0
- package/dist/esm/models/SecFilings200Response.d.ts +88 -0
- package/dist/esm/models/SecFilings200Response.js +44 -0
- package/dist/esm/models/SecFilings200ResponseFilingsInner.d.ts +81 -0
- package/dist/esm/models/SecFilings200ResponseFilingsInner.js +37 -0
- package/dist/esm/models/{SecFilingsAvailableFormTypes200Response.d.ts → SecFilings200ResponseFormFacetInner.d.ts} +25 -12
- package/dist/esm/models/{SecFilingsList200Response.js → SecFilings200ResponseFormFacetInner.js} +10 -17
- package/dist/esm/models/SecFinancialsCatalog200Response.d.ts +48 -0
- package/dist/esm/models/SecFinancialsCatalog200Response.js +42 -0
- package/dist/{models/SecFilingsSections200ResponseCompaniesInnerSectionsInner.d.ts → esm/models/SecHoldingsHolders200Response.d.ts} +88 -64
- package/dist/esm/models/SecHoldingsHolders200Response.js +42 -0
- package/dist/esm/models/{SecFilingsList200ResponseCompaniesInner.d.ts → SecIssuers200Response.d.ts} +45 -22
- package/dist/esm/models/SecIssuers200Response.js +42 -0
- package/dist/esm/models/{SecFilingsSections200ResponseCompaniesInner.d.ts → SecReadiness.d.ts} +34 -21
- package/dist/esm/models/SecReadiness.js +55 -0
- package/dist/esm/models/SecSearch200Response.d.ts +88 -0
- package/dist/esm/models/SecSearch200Response.js +51 -0
- package/dist/esm/models/SecSearch200ResponseHitsInner.d.ts +92 -0
- package/dist/esm/models/SecSearch200ResponseHitsInner.js +38 -0
- package/dist/esm/models/SecSearchCoverage.d.ts +61 -0
- package/dist/esm/models/SecSearchCoverage.js +52 -0
- package/dist/esm/models/SecSearchCoverageLexical.d.ts +51 -0
- package/dist/esm/models/{SecFilingsAvailableFormTypes200Response.js → SecSearchCoverageLexical.js} +10 -16
- package/dist/esm/models/SecStoreError.d.ts +52 -0
- package/dist/esm/models/{SecFilingsSections200Response.js → SecStoreError.js} +14 -16
- package/dist/esm/models/WebSocketFiling.d.ts +1 -1
- package/dist/esm/models/index.d.ts +36 -9
- package/dist/esm/models/index.js +36 -9
- package/dist/models/EarningsCallsCalendar200ResponseEventsInner.d.ts +7 -0
- package/dist/models/EarningsCallsCalendar200ResponseEventsInner.js +3 -0
- package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendar.d.ts +95 -0
- package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendar.js +103 -0
- package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCall.d.ts +102 -0
- package/dist/models/{SecFilingsSections200ResponseCompaniesInnerSectionsInner.js → EarningsCallsCalendar200ResponseEventsInnerCalendarCall.js} +69 -67
- package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource.d.ts +56 -0
- package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource.js +66 -0
- package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReport.d.ts +69 -0
- package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReport.js +80 -0
- package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource.d.ts +44 -0
- package/dist/models/{SecFilingsList200ResponseCompaniesInner.js → EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource.js} +22 -25
- package/dist/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.d.ts +6 -0
- package/dist/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.js +2 -0
- package/dist/models/EarningsCallsDocuments200ResponseDocumentsInner.d.ts +6 -0
- package/dist/models/EarningsCallsDocuments200ResponseDocumentsInner.js +2 -0
- package/dist/models/EarningsCallsTranscript200Response.d.ts +3 -3
- package/dist/models/EarningsCallsTranscript200Response.js +3 -3
- package/dist/models/EarningsCallsTranscript200ResponseEvent.d.ts +233 -0
- package/dist/models/EarningsCallsTranscript200ResponseEvent.js +196 -0
- package/dist/models/IposRegistrationsList200ResponseRegistrationsInner.d.ts +7 -0
- package/dist/models/IposRegistrationsList200ResponseRegistrationsInner.js +3 -0
- package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPending.d.ts +89 -0
- package/dist/models/{SecFilingsList200ResponseCompaniesInnerFilingsInner.js → IposRegistrationsList200ResponseRegistrationsInnerIpoPending.js} +49 -49
- package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.d.ts +74 -0
- package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.js +62 -0
- package/dist/{esm/models/SecFilingsSearch200Response.d.ts → models/SecDatasets200Response.d.ts} +26 -17
- package/dist/models/{SecFilingsSections200Response.js → SecDatasets200Response.js} +19 -21
- package/dist/models/SecDocument200Response.d.ts +104 -0
- package/dist/models/{SecFilingsSections200ResponseCompaniesInner.js → SecDocument200Response.js} +18 -28
- package/dist/models/SecDocumentFactPlaces200Response.d.ts +88 -0
- package/dist/models/SecDocumentFactPlaces200Response.js +49 -0
- package/dist/models/SecDocumentFigure200Response.d.ts +70 -0
- package/dist/models/SecDocumentFigure200Response.js +49 -0
- package/dist/models/SecDocumentSections200Response.d.ts +71 -0
- package/dist/models/SecDocumentSections200Response.js +50 -0
- package/dist/models/SecDocumentSections200ResponseSectionsInner.d.ts +85 -0
- package/dist/models/SecDocumentSections200ResponseSectionsInner.js +52 -0
- package/dist/models/SecFiler200Response.d.ts +80 -0
- package/dist/models/SecFiler200Response.js +49 -0
- package/dist/models/SecFilerCoverage200Response.d.ts +82 -0
- package/dist/models/{SecFilingsSearch200ResponseSourcesInner.js → SecFilerCoverage200Response.js} +18 -39
- package/dist/{esm/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.d.ts → models/SecFilerLifecycle200Response.d.ts} +106 -53
- package/dist/models/SecFilerLifecycle200Response.js +49 -0
- package/dist/models/SecFilers200Response.d.ts +53 -0
- package/dist/models/SecFilers200Response.js +50 -0
- package/dist/models/{SecFilingsSearch200ResponseSourcesInner.d.ts → SecFilers200ResponseMatchesInner.d.ts} +31 -28
- package/dist/models/SecFilers200ResponseMatchesInner.js +44 -0
- package/dist/models/SecFiling200Response.d.ts +88 -0
- package/dist/models/SecFiling200Response.js +49 -0
- package/dist/models/{SecFilingsList200Response.d.ts → SecFilingFacts200Response.d.ts} +43 -14
- package/dist/models/SecFilingFacts200Response.js +49 -0
- package/dist/models/SecFilingHoldings200Response.d.ts +74 -0
- package/dist/models/SecFilingHoldings200Response.js +49 -0
- package/dist/models/SecFilingReviewChain200Response.d.ts +92 -0
- package/dist/models/SecFilingReviewChain200Response.js +49 -0
- package/dist/models/SecFilingReviewRelations200Response.d.ts +88 -0
- package/dist/models/SecFilingReviewRelations200Response.js +49 -0
- package/dist/models/SecFilings200Response.d.ts +88 -0
- package/dist/models/SecFilings200Response.js +51 -0
- package/dist/models/SecFilings200ResponseFilingsInner.d.ts +81 -0
- package/dist/models/SecFilings200ResponseFilingsInner.js +44 -0
- package/dist/{esm/models/SecFilingsSections200Response.d.ts → models/SecFilings200ResponseFormFacetInner.d.ts} +25 -13
- package/dist/models/SecFilings200ResponseFormFacetInner.js +44 -0
- package/dist/models/SecFinancialsCatalog200Response.d.ts +48 -0
- package/dist/models/SecFinancialsCatalog200Response.js +49 -0
- package/dist/{esm/models/SecFilingsSections200ResponseCompaniesInnerSectionsInner.d.ts → models/SecHoldingsHolders200Response.d.ts} +88 -64
- package/dist/models/SecHoldingsHolders200Response.js +49 -0
- package/dist/models/{SecFilingsList200ResponseCompaniesInner.d.ts → SecIssuers200Response.d.ts} +45 -22
- package/dist/models/SecIssuers200Response.js +49 -0
- package/dist/models/{SecFilingsSections200ResponseCompaniesInner.d.ts → SecReadiness.d.ts} +34 -21
- package/dist/models/SecReadiness.js +63 -0
- package/dist/models/SecSearch200Response.d.ts +88 -0
- package/dist/models/SecSearch200Response.js +59 -0
- package/dist/models/SecSearch200ResponseHitsInner.d.ts +92 -0
- package/dist/models/SecSearch200ResponseHitsInner.js +45 -0
- package/dist/models/SecSearchCoverage.d.ts +61 -0
- package/dist/models/SecSearchCoverage.js +60 -0
- package/dist/models/SecSearchCoverageLexical.d.ts +51 -0
- package/dist/models/{SecFilingsList200Response.js → SecSearchCoverageLexical.js} +15 -22
- package/dist/models/SecStoreError.d.ts +52 -0
- package/dist/models/{SecFilingsAvailableFormTypes200Response.js → SecStoreError.js} +19 -20
- package/dist/models/WebSocketFiling.d.ts +1 -1
- package/dist/models/index.d.ts +36 -9
- package/dist/models/index.js +36 -9
- package/docs/EarningsCallsApi.md +8 -2
- package/docs/EarningsCallsCalendar200ResponseEventsInner.md +2 -0
- package/docs/EarningsCallsCalendar200ResponseEventsInnerCalendar.md +43 -0
- package/docs/EarningsCallsCalendar200ResponseEventsInnerCalendarCall.md +45 -0
- package/docs/EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource.md +43 -0
- package/docs/EarningsCallsCalendar200ResponseEventsInnerCalendarReport.md +41 -0
- package/docs/EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource.md +39 -0
- package/docs/EarningsCallsCompanyDocuments200ResponseDocumentsInner.md +2 -0
- package/docs/EarningsCallsDocuments200ResponseDocumentsInner.md +2 -0
- package/docs/EarningsCallsTranscript200Response.md +1 -1
- package/docs/EarningsCallsTranscript200ResponseEvent.md +88 -0
- package/docs/IPOsApi.md +5 -2
- package/docs/IposRegistrationsList200ResponseRegistrationsInner.md +2 -0
- package/docs/IposRegistrationsList200ResponseRegistrationsInnerIpoPending.md +51 -0
- package/docs/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.md +49 -0
- package/docs/SECApi.md +2646 -0
- package/docs/{SecFilingsList200Response.md → SecDatasets200Response.md} +11 -6
- package/docs/SecDocument200Response.md +53 -0
- package/docs/SecDocumentFactPlaces200Response.md +51 -0
- package/docs/SecDocumentFigure200Response.md +45 -0
- package/docs/SecDocumentSections200Response.md +47 -0
- package/docs/SecDocumentSections200ResponseSectionsInner.md +48 -0
- package/docs/SecFiler200Response.md +47 -0
- package/docs/SecFilerCoverage200Response.md +49 -0
- package/docs/SecFilerLifecycle200Response.md +65 -0
- package/docs/SecFilers200Response.md +41 -0
- package/docs/{SecFilingsSearch200ResponseSourcesInner.md → SecFilers200ResponseMatchesInner.md} +14 -14
- package/docs/SecFiling200Response.md +49 -0
- package/docs/SecFilingFacts200Response.md +43 -0
- package/docs/SecFilingHoldings200Response.md +47 -0
- package/docs/SecFilingReviewChain200Response.md +51 -0
- package/docs/SecFilingReviewRelations200Response.md +51 -0
- package/docs/SecFilings200Response.md +51 -0
- package/docs/SecFilings200ResponseFilingsInner.md +50 -0
- package/docs/{SecFilingsAvailableFormTypes200Response.md → SecFilings200ResponseFormFacetInner.md} +10 -6
- package/docs/{SecFilingsSections200Response.md → SecFinancialsCatalog200Response.md} +11 -6
- package/docs/SecHoldingsHolders200Response.md +67 -0
- package/docs/{SecFilingsList200ResponseCompaniesInner.md → SecIssuers200Response.md} +17 -10
- package/docs/SecReadiness.md +39 -0
- package/docs/SecSearch200Response.md +49 -0
- package/docs/SecSearch200ResponseHitsInner.md +52 -0
- package/docs/SecSearchCoverage.md +41 -0
- package/docs/{SecFilingsSearch200Response.md → SecSearchCoverageLexical.md} +13 -8
- package/docs/SecStoreError.md +41 -0
- package/docs/WebSocketFiling.md +1 -1
- package/package.json +1 -1
- package/src/apis/EarningsCallsApi.ts +32 -2
- package/src/apis/IPOsApi.ts +15 -2
- package/src/apis/SECApi.ts +2596 -0
- package/src/apis/index.ts +1 -1
- package/src/models/EarningsCallsCalendar200ResponseEventsInner.ts +15 -0
- package/src/models/EarningsCallsCalendar200ResponseEventsInnerCalendar.ts +159 -0
- package/src/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCall.ts +163 -0
- package/src/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource.ts +102 -0
- package/src/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReport.ts +123 -0
- package/src/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource.ts +84 -0
- package/src/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.ts +8 -0
- package/src/models/EarningsCallsDocuments200ResponseDocumentsInner.ts +8 -0
- package/src/models/EarningsCallsTranscript200Response.ts +10 -10
- package/src/models/EarningsCallsTranscript200ResponseEvent.ts +363 -0
- package/src/models/IposRegistrationsList200ResponseRegistrationsInner.ts +15 -0
- package/src/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPending.ts +157 -0
- package/src/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.ts +121 -0
- package/src/models/{SecFilingsSearch200Response.ts → SecDatasets200Response.ts} +41 -30
- package/src/models/SecDocument200Response.ts +150 -0
- package/src/models/SecDocumentFactPlaces200Response.ts +142 -0
- package/src/models/{SecFilingsSections200ResponseCompaniesInner.ts → SecDocumentFigure200Response.ts} +63 -37
- package/src/models/SecDocumentSections200Response.ts +133 -0
- package/src/models/SecDocumentSections200ResponseSectionsInner.ts +135 -0
- package/src/models/{SecFilingsSearch200ResponseSourcesInner.ts → SecFiler200Response.ts} +67 -52
- package/src/models/SecFilerCoverage200Response.ts +134 -0
- package/src/models/{SecFilingsList200ResponseCompaniesInnerFilingsInner.ts → SecFilerLifecycle200Response.ts} +126 -92
- package/src/models/SecFilers200Response.ts +109 -0
- package/src/models/SecFilers200ResponseMatchesInner.ts +108 -0
- package/src/models/SecFiling200Response.ts +134 -0
- package/src/models/SecFilingFacts200Response.ts +110 -0
- package/src/models/SecFilingHoldings200Response.ts +126 -0
- package/src/models/SecFilingReviewChain200Response.ts +142 -0
- package/src/models/SecFilingReviewRelations200Response.ts +142 -0
- package/src/models/SecFilings200Response.ts +156 -0
- package/src/models/SecFilings200ResponseFilingsInner.ts +132 -0
- package/src/models/{SecFilingsSections200Response.ts → SecFilings200ResponseFormFacetInner.ts} +35 -25
- package/src/models/SecFinancialsCatalog200Response.ts +94 -0
- package/src/models/{SecFilingsSections200ResponseCompaniesInnerSectionsInner.ts → SecHoldingsHolders200Response.ts} +125 -111
- package/src/models/{SecFilingsList200ResponseCompaniesInner.ts → SecIssuers200Response.ts} +64 -38
- package/src/models/SecReadiness.ts +103 -0
- package/src/models/SecSearch200Response.ts +159 -0
- package/src/models/SecSearch200ResponseHitsInner.ts +148 -0
- package/src/models/SecSearchCoverage.ts +115 -0
- package/src/models/{SecFilingsList200Response.ts → SecSearchCoverageLexical.ts} +44 -26
- package/src/models/SecStoreError.ts +102 -0
- package/src/models/WebSocketFiling.ts +1 -1
- package/src/models/index.ts +36 -9
- package/dist/apis/SECFilingsApi.d.ts +0 -117
- package/dist/apis/SECFilingsApi.js +0 -284
- package/dist/esm/apis/SECFilingsApi.d.ts +0 -117
- package/dist/esm/apis/SECFilingsApi.js +0 -280
- package/dist/models/SecFilingsAvailableFormTypes200Response.d.ts +0 -32
- package/dist/models/SecFilingsSections200Response.d.ts +0 -33
- package/docs/SECFilingsApi.md +0 -344
- package/docs/SecFilingsList200ResponseCompaniesInnerFilingsInner.md +0 -54
- package/docs/SecFilingsSections200ResponseCompaniesInner.md +0 -38
- package/docs/SecFilingsSections200ResponseCompaniesInnerSectionsInner.md +0 -62
- 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 fact places
|
|
15
|
+
* @export
|
|
16
|
+
* @interface SecDocumentFactPlaces200Response
|
|
17
|
+
*/
|
|
18
|
+
export interface SecDocumentFactPlaces200Response {
|
|
19
|
+
[key: string]: any | any;
|
|
20
|
+
/**
|
|
21
|
+
* The backend contract version (`secdoors.v1`)
|
|
22
|
+
* @type {string}
|
|
23
|
+
* @memberof SecDocumentFactPlaces200Response
|
|
24
|
+
*/
|
|
25
|
+
api_schema: string;
|
|
26
|
+
/**
|
|
27
|
+
* Counts
|
|
28
|
+
* @type {{ [key: string]: any; }}
|
|
29
|
+
* @memberof SecDocumentFactPlaces200Response
|
|
30
|
+
*/
|
|
31
|
+
counts?: {
|
|
32
|
+
[key: string]: any;
|
|
33
|
+
};
|
|
34
|
+
/**
|
|
35
|
+
* Nextcursor
|
|
36
|
+
* @type {string}
|
|
37
|
+
* @memberof SecDocumentFactPlaces200Response
|
|
38
|
+
*/
|
|
39
|
+
next_cursor?: string | null;
|
|
40
|
+
/**
|
|
41
|
+
* Places
|
|
42
|
+
* @type {Array<{ [key: string]: any; }>}
|
|
43
|
+
* @memberof SecDocumentFactPlaces200Response
|
|
44
|
+
*/
|
|
45
|
+
places?: Array<{
|
|
46
|
+
[key: string]: any;
|
|
47
|
+
}>;
|
|
48
|
+
/**
|
|
49
|
+
* Provider
|
|
50
|
+
* @type {{ [key: string]: any; }}
|
|
51
|
+
* @memberof SecDocumentFactPlaces200Response
|
|
52
|
+
*/
|
|
53
|
+
provider?: {
|
|
54
|
+
[key: string]: any;
|
|
55
|
+
} | null;
|
|
56
|
+
/**
|
|
57
|
+
*
|
|
58
|
+
* @type {SecReadiness}
|
|
59
|
+
* @memberof SecDocumentFactPlaces200Response
|
|
60
|
+
*/
|
|
61
|
+
readiness: SecReadiness;
|
|
62
|
+
/**
|
|
63
|
+
* Resolverversion
|
|
64
|
+
* @type {string}
|
|
65
|
+
* @memberof SecDocumentFactPlaces200Response
|
|
66
|
+
*/
|
|
67
|
+
resolver_version?: string | null;
|
|
68
|
+
/**
|
|
69
|
+
* Versionid
|
|
70
|
+
* @type {string}
|
|
71
|
+
* @memberof SecDocumentFactPlaces200Response
|
|
72
|
+
*/
|
|
73
|
+
version_id?: string;
|
|
74
|
+
/**
|
|
75
|
+
* URL of the next page (same filters, the next cursor). Omitted on the last page.
|
|
76
|
+
* @type {string}
|
|
77
|
+
* @memberof SecDocumentFactPlaces200Response
|
|
78
|
+
*/
|
|
79
|
+
next_url?: string;
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* Check if a given object implements the SecDocumentFactPlaces200Response interface.
|
|
83
|
+
*/
|
|
84
|
+
export declare function instanceOfSecDocumentFactPlaces200Response(value: object): value is SecDocumentFactPlaces200Response;
|
|
85
|
+
export declare function SecDocumentFactPlaces200ResponseFromJSON(json: any): SecDocumentFactPlaces200Response;
|
|
86
|
+
export declare function SecDocumentFactPlaces200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecDocumentFactPlaces200Response;
|
|
87
|
+
export declare function SecDocumentFactPlaces200ResponseToJSON(json: any): SecDocumentFactPlaces200Response;
|
|
88
|
+
export declare function SecDocumentFactPlaces200ResponseToJSONTyped(value?: SecDocumentFactPlaces200Response | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Invinite API
|
|
5
|
+
* Invinite financial data API. Each endpoint has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Included-Remaining` what is left of the plan\'s included credits. `GET /v1/account/usage` returns your account\'s usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost. **Coverage.** Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/company/available-companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the CIKs it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `ping` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `ping` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: Issuer and SEC text is served in full with its attribution; the licensee shows publisher, source URL and date next to it and may forward it unmodified; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs reproduce issuer or SEC text under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/account/usage` serves no licensed data and carries none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import { SecReadinessFromJSON, SecReadinessToJSON, } from './SecReadiness';
|
|
15
|
+
/**
|
|
16
|
+
* Check if a given object implements the SecDocumentFactPlaces200Response interface.
|
|
17
|
+
*/
|
|
18
|
+
export function instanceOfSecDocumentFactPlaces200Response(value) {
|
|
19
|
+
if (!('api_schema' in value) || value['api_schema'] === undefined)
|
|
20
|
+
return false;
|
|
21
|
+
if (!('readiness' in value) || value['readiness'] === undefined)
|
|
22
|
+
return false;
|
|
23
|
+
return true;
|
|
24
|
+
}
|
|
25
|
+
export function SecDocumentFactPlaces200ResponseFromJSON(json) {
|
|
26
|
+
return SecDocumentFactPlaces200ResponseFromJSONTyped(json, false);
|
|
27
|
+
}
|
|
28
|
+
export function SecDocumentFactPlaces200ResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
29
|
+
if (json == null) {
|
|
30
|
+
return json;
|
|
31
|
+
}
|
|
32
|
+
return Object.assign(Object.assign({}, json), { 'api_schema': json['api_schema'], 'counts': json['counts'] == null ? undefined : json['counts'], 'next_cursor': json['next_cursor'] == null ? undefined : json['next_cursor'], 'places': json['places'] == null ? undefined : json['places'], 'provider': json['provider'] == null ? undefined : json['provider'], 'readiness': SecReadinessFromJSON(json['readiness']), 'resolver_version': json['resolver_version'] == null ? undefined : json['resolver_version'], 'version_id': json['version_id'] == null ? undefined : json['version_id'], 'next_url': json['next_url'] == null ? undefined : json['next_url'] });
|
|
33
|
+
}
|
|
34
|
+
export function SecDocumentFactPlaces200ResponseToJSON(json) {
|
|
35
|
+
return SecDocumentFactPlaces200ResponseToJSONTyped(json, false);
|
|
36
|
+
}
|
|
37
|
+
export function SecDocumentFactPlaces200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
38
|
+
if (value == null) {
|
|
39
|
+
return value;
|
|
40
|
+
}
|
|
41
|
+
return Object.assign(Object.assign({}, value), { 'api_schema': value['api_schema'], 'counts': value['counts'], 'next_cursor': value['next_cursor'], 'places': value['places'], 'provider': value['provider'], 'readiness': SecReadinessToJSON(value['readiness']), 'resolver_version': value['resolver_version'], 'version_id': value['version_id'], 'next_url': value['next_url'] });
|
|
42
|
+
}
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Invinite API
|
|
3
|
+
* Invinite financial data API. Each endpoint has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Included-Remaining` what is left of the plan\'s included credits. `GET /v1/account/usage` returns your account\'s usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost. **Coverage.** Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/company/available-companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the CIKs it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `ping` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `ping` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: Issuer and SEC text is served in full with its attribution; the licensee shows publisher, source URL and date next to it and may forward it unmodified; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs reproduce issuer or SEC text under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/account/usage` serves no licensed data and carries none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { SecReadiness } from './SecReadiness';
|
|
13
|
+
/**
|
|
14
|
+
* One figure
|
|
15
|
+
* @export
|
|
16
|
+
* @interface SecDocumentFigure200Response
|
|
17
|
+
*/
|
|
18
|
+
export interface SecDocumentFigure200Response {
|
|
19
|
+
[key: string]: any | any;
|
|
20
|
+
/**
|
|
21
|
+
* The backend contract version (`secdoors.v1`)
|
|
22
|
+
* @type {string}
|
|
23
|
+
* @memberof SecDocumentFigure200Response
|
|
24
|
+
*/
|
|
25
|
+
api_schema: string;
|
|
26
|
+
/**
|
|
27
|
+
* Citation
|
|
28
|
+
* @type {{ [key: string]: any; }}
|
|
29
|
+
* @memberof SecDocumentFigure200Response
|
|
30
|
+
*/
|
|
31
|
+
citation?: {
|
|
32
|
+
[key: string]: any;
|
|
33
|
+
} | null;
|
|
34
|
+
/**
|
|
35
|
+
* Figure
|
|
36
|
+
* @type {{ [key: string]: any; }}
|
|
37
|
+
* @memberof SecDocumentFigure200Response
|
|
38
|
+
*/
|
|
39
|
+
figure?: {
|
|
40
|
+
[key: string]: any;
|
|
41
|
+
} | null;
|
|
42
|
+
/**
|
|
43
|
+
* Image
|
|
44
|
+
* @type {{ [key: string]: any; }}
|
|
45
|
+
* @memberof SecDocumentFigure200Response
|
|
46
|
+
*/
|
|
47
|
+
image?: {
|
|
48
|
+
[key: string]: any;
|
|
49
|
+
} | null;
|
|
50
|
+
/**
|
|
51
|
+
*
|
|
52
|
+
* @type {SecReadiness}
|
|
53
|
+
* @memberof SecDocumentFigure200Response
|
|
54
|
+
*/
|
|
55
|
+
readiness: SecReadiness;
|
|
56
|
+
/**
|
|
57
|
+
* Versionid
|
|
58
|
+
* @type {string}
|
|
59
|
+
* @memberof SecDocumentFigure200Response
|
|
60
|
+
*/
|
|
61
|
+
version_id?: string | null;
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* Check if a given object implements the SecDocumentFigure200Response interface.
|
|
65
|
+
*/
|
|
66
|
+
export declare function instanceOfSecDocumentFigure200Response(value: object): value is SecDocumentFigure200Response;
|
|
67
|
+
export declare function SecDocumentFigure200ResponseFromJSON(json: any): SecDocumentFigure200Response;
|
|
68
|
+
export declare function SecDocumentFigure200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecDocumentFigure200Response;
|
|
69
|
+
export declare function SecDocumentFigure200ResponseToJSON(json: any): SecDocumentFigure200Response;
|
|
70
|
+
export declare function SecDocumentFigure200ResponseToJSONTyped(value?: SecDocumentFigure200Response | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Invinite API
|
|
5
|
+
* Invinite financial data API. Each endpoint has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Included-Remaining` what is left of the plan\'s included credits. `GET /v1/account/usage` returns your account\'s usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost. **Coverage.** Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/company/available-companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the CIKs it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `ping` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `ping` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: Issuer and SEC text is served in full with its attribution; the licensee shows publisher, source URL and date next to it and may forward it unmodified; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs reproduce issuer or SEC text under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/account/usage` serves no licensed data and carries none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import { SecReadinessFromJSON, SecReadinessToJSON, } from './SecReadiness';
|
|
15
|
+
/**
|
|
16
|
+
* Check if a given object implements the SecDocumentFigure200Response interface.
|
|
17
|
+
*/
|
|
18
|
+
export function instanceOfSecDocumentFigure200Response(value) {
|
|
19
|
+
if (!('api_schema' in value) || value['api_schema'] === undefined)
|
|
20
|
+
return false;
|
|
21
|
+
if (!('readiness' in value) || value['readiness'] === undefined)
|
|
22
|
+
return false;
|
|
23
|
+
return true;
|
|
24
|
+
}
|
|
25
|
+
export function SecDocumentFigure200ResponseFromJSON(json) {
|
|
26
|
+
return SecDocumentFigure200ResponseFromJSONTyped(json, false);
|
|
27
|
+
}
|
|
28
|
+
export function SecDocumentFigure200ResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
29
|
+
if (json == null) {
|
|
30
|
+
return json;
|
|
31
|
+
}
|
|
32
|
+
return Object.assign(Object.assign({}, json), { 'api_schema': json['api_schema'], 'citation': json['citation'] == null ? undefined : json['citation'], 'figure': json['figure'] == null ? undefined : json['figure'], 'image': json['image'] == null ? undefined : json['image'], 'readiness': SecReadinessFromJSON(json['readiness']), 'version_id': json['version_id'] == null ? undefined : json['version_id'] });
|
|
33
|
+
}
|
|
34
|
+
export function SecDocumentFigure200ResponseToJSON(json) {
|
|
35
|
+
return SecDocumentFigure200ResponseToJSONTyped(json, false);
|
|
36
|
+
}
|
|
37
|
+
export function SecDocumentFigure200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
38
|
+
if (value == null) {
|
|
39
|
+
return value;
|
|
40
|
+
}
|
|
41
|
+
return Object.assign(Object.assign({}, value), { 'api_schema': value['api_schema'], 'citation': value['citation'], 'figure': value['figure'], 'image': value['image'], 'readiness': SecReadinessToJSON(value['readiness']), 'version_id': value['version_id'] });
|
|
42
|
+
}
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Invinite API
|
|
3
|
+
* Invinite financial data API. Each endpoint has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Included-Remaining` what is left of the plan\'s included credits. `GET /v1/account/usage` returns your account\'s usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost. **Coverage.** Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/company/available-companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the CIKs it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `ping` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `ping` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: Issuer and SEC text is served in full with its attribution; the licensee shows publisher, source URL and date next to it and may forward it unmodified; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs reproduce issuer or SEC text under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/account/usage` serves no licensed data and carries none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { SecReadiness } from './SecReadiness';
|
|
13
|
+
import type { SecDocumentSections200ResponseSectionsInner } from './SecDocumentSections200ResponseSectionsInner';
|
|
14
|
+
/**
|
|
15
|
+
* One version's section outline
|
|
16
|
+
* @export
|
|
17
|
+
* @interface SecDocumentSections200Response
|
|
18
|
+
*/
|
|
19
|
+
export interface SecDocumentSections200Response {
|
|
20
|
+
[key: string]: any | any;
|
|
21
|
+
/**
|
|
22
|
+
* Accession
|
|
23
|
+
* @type {string}
|
|
24
|
+
* @memberof SecDocumentSections200Response
|
|
25
|
+
*/
|
|
26
|
+
accession?: string | null;
|
|
27
|
+
/**
|
|
28
|
+
* The backend contract version (`secdoors.v1`)
|
|
29
|
+
* @type {string}
|
|
30
|
+
* @memberof SecDocumentSections200Response
|
|
31
|
+
*/
|
|
32
|
+
api_schema: string;
|
|
33
|
+
/**
|
|
34
|
+
* Filename
|
|
35
|
+
* @type {string}
|
|
36
|
+
* @memberof SecDocumentSections200Response
|
|
37
|
+
*/
|
|
38
|
+
filename?: string | null;
|
|
39
|
+
/**
|
|
40
|
+
* Projectionversion
|
|
41
|
+
* @type {string}
|
|
42
|
+
* @memberof SecDocumentSections200Response
|
|
43
|
+
*/
|
|
44
|
+
projection_version?: string | null;
|
|
45
|
+
/**
|
|
46
|
+
*
|
|
47
|
+
* @type {SecReadiness}
|
|
48
|
+
* @memberof SecDocumentSections200Response
|
|
49
|
+
*/
|
|
50
|
+
readiness: SecReadiness;
|
|
51
|
+
/**
|
|
52
|
+
* Sections in outline order
|
|
53
|
+
* @type {Array<SecDocumentSections200ResponseSectionsInner>}
|
|
54
|
+
* @memberof SecDocumentSections200Response
|
|
55
|
+
*/
|
|
56
|
+
sections?: Array<SecDocumentSections200ResponseSectionsInner>;
|
|
57
|
+
/**
|
|
58
|
+
* Versionid
|
|
59
|
+
* @type {string}
|
|
60
|
+
* @memberof SecDocumentSections200Response
|
|
61
|
+
*/
|
|
62
|
+
version_id?: string | null;
|
|
63
|
+
}
|
|
64
|
+
/**
|
|
65
|
+
* Check if a given object implements the SecDocumentSections200Response interface.
|
|
66
|
+
*/
|
|
67
|
+
export declare function instanceOfSecDocumentSections200Response(value: object): value is SecDocumentSections200Response;
|
|
68
|
+
export declare function SecDocumentSections200ResponseFromJSON(json: any): SecDocumentSections200Response;
|
|
69
|
+
export declare function SecDocumentSections200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecDocumentSections200Response;
|
|
70
|
+
export declare function SecDocumentSections200ResponseToJSON(json: any): SecDocumentSections200Response;
|
|
71
|
+
export declare function SecDocumentSections200ResponseToJSONTyped(value?: SecDocumentSections200Response | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Invinite API
|
|
5
|
+
* Invinite financial data API. Each endpoint has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Included-Remaining` what is left of the plan\'s included credits. `GET /v1/account/usage` returns your account\'s usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost. **Coverage.** Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/company/available-companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the CIKs it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `ping` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `ping` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: Issuer and SEC text is served in full with its attribution; the licensee shows publisher, source URL and date next to it and may forward it unmodified; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs reproduce issuer or SEC text under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/account/usage` serves no licensed data and carries none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import { SecReadinessFromJSON, SecReadinessToJSON, } from './SecReadiness';
|
|
15
|
+
import { SecDocumentSections200ResponseSectionsInnerFromJSON, SecDocumentSections200ResponseSectionsInnerToJSON, } from './SecDocumentSections200ResponseSectionsInner';
|
|
16
|
+
/**
|
|
17
|
+
* Check if a given object implements the SecDocumentSections200Response interface.
|
|
18
|
+
*/
|
|
19
|
+
export function instanceOfSecDocumentSections200Response(value) {
|
|
20
|
+
if (!('api_schema' in value) || value['api_schema'] === undefined)
|
|
21
|
+
return false;
|
|
22
|
+
if (!('readiness' in value) || value['readiness'] === undefined)
|
|
23
|
+
return false;
|
|
24
|
+
return true;
|
|
25
|
+
}
|
|
26
|
+
export function SecDocumentSections200ResponseFromJSON(json) {
|
|
27
|
+
return SecDocumentSections200ResponseFromJSONTyped(json, false);
|
|
28
|
+
}
|
|
29
|
+
export function SecDocumentSections200ResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
30
|
+
if (json == null) {
|
|
31
|
+
return json;
|
|
32
|
+
}
|
|
33
|
+
return Object.assign(Object.assign({}, json), { 'accession': json['accession'] == null ? undefined : json['accession'], 'api_schema': json['api_schema'], 'filename': json['filename'] == null ? undefined : json['filename'], 'projection_version': json['projection_version'] == null ? undefined : json['projection_version'], 'readiness': SecReadinessFromJSON(json['readiness']), 'sections': json['sections'] == null ? undefined : (json['sections'].map(SecDocumentSections200ResponseSectionsInnerFromJSON)), 'version_id': json['version_id'] == null ? undefined : json['version_id'] });
|
|
34
|
+
}
|
|
35
|
+
export function SecDocumentSections200ResponseToJSON(json) {
|
|
36
|
+
return SecDocumentSections200ResponseToJSONTyped(json, false);
|
|
37
|
+
}
|
|
38
|
+
export function SecDocumentSections200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
39
|
+
if (value == null) {
|
|
40
|
+
return value;
|
|
41
|
+
}
|
|
42
|
+
return Object.assign(Object.assign({}, value), { 'accession': value['accession'], 'api_schema': value['api_schema'], 'filename': value['filename'], 'projection_version': value['projection_version'], 'readiness': SecReadinessToJSON(value['readiness']), 'sections': value['sections'] == null ? undefined : (value['sections'].map(SecDocumentSections200ResponseSectionsInnerToJSON)), 'version_id': value['version_id'] });
|
|
43
|
+
}
|
|
@@ -0,0 +1,85 @@
|
|
|
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 SecDocumentSections200ResponseSectionsInner
|
|
16
|
+
*/
|
|
17
|
+
export interface SecDocumentSections200ResponseSectionsInner {
|
|
18
|
+
[key: string]: any | any;
|
|
19
|
+
/**
|
|
20
|
+
* legacy = the existing section ids; generic = other headings
|
|
21
|
+
* @type {SecDocumentSections200ResponseSectionsInnerOutlineEnum}
|
|
22
|
+
* @memberof SecDocumentSections200ResponseSectionsInner
|
|
23
|
+
*/
|
|
24
|
+
outline?: SecDocumentSections200ResponseSectionsInnerOutlineEnum;
|
|
25
|
+
/**
|
|
26
|
+
* Position in its outline
|
|
27
|
+
* @type {number}
|
|
28
|
+
* @memberof SecDocumentSections200ResponseSectionsInner
|
|
29
|
+
*/
|
|
30
|
+
ordinal?: number;
|
|
31
|
+
/**
|
|
32
|
+
* The section id of the legacy sections route (null for generic)
|
|
33
|
+
* @type {string}
|
|
34
|
+
* @memberof SecDocumentSections200ResponseSectionsInner
|
|
35
|
+
*/
|
|
36
|
+
legacy_section_key?: string | null;
|
|
37
|
+
/**
|
|
38
|
+
* Part heading
|
|
39
|
+
* @type {string}
|
|
40
|
+
* @memberof SecDocumentSections200ResponseSectionsInner
|
|
41
|
+
*/
|
|
42
|
+
part?: string | null;
|
|
43
|
+
/**
|
|
44
|
+
* Item number
|
|
45
|
+
* @type {string}
|
|
46
|
+
* @memberof SecDocumentSections200ResponseSectionsInner
|
|
47
|
+
*/
|
|
48
|
+
item_id?: string | null;
|
|
49
|
+
/**
|
|
50
|
+
* Heading
|
|
51
|
+
* @type {string}
|
|
52
|
+
* @memberof SecDocumentSections200ResponseSectionsInner
|
|
53
|
+
*/
|
|
54
|
+
title?: string;
|
|
55
|
+
/**
|
|
56
|
+
* `blocks` selectors of the section's spans
|
|
57
|
+
* @type {Array<string>}
|
|
58
|
+
* @memberof SecDocumentSections200ResponseSectionsInner
|
|
59
|
+
*/
|
|
60
|
+
blocks?: Array<string>;
|
|
61
|
+
/**
|
|
62
|
+
* `{from, to}` block ids
|
|
63
|
+
* @type {Array<{ [key: string]: any; }>}
|
|
64
|
+
* @memberof SecDocumentSections200ResponseSectionsInner
|
|
65
|
+
*/
|
|
66
|
+
block_spans?: Array<{
|
|
67
|
+
[key: string]: any;
|
|
68
|
+
}>;
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* @export
|
|
72
|
+
*/
|
|
73
|
+
export declare const SecDocumentSections200ResponseSectionsInnerOutlineEnum: {
|
|
74
|
+
readonly Legacy: "legacy";
|
|
75
|
+
readonly Generic: "generic";
|
|
76
|
+
};
|
|
77
|
+
export type SecDocumentSections200ResponseSectionsInnerOutlineEnum = typeof SecDocumentSections200ResponseSectionsInnerOutlineEnum[keyof typeof SecDocumentSections200ResponseSectionsInnerOutlineEnum];
|
|
78
|
+
/**
|
|
79
|
+
* Check if a given object implements the SecDocumentSections200ResponseSectionsInner interface.
|
|
80
|
+
*/
|
|
81
|
+
export declare function instanceOfSecDocumentSections200ResponseSectionsInner(value: object): value is SecDocumentSections200ResponseSectionsInner;
|
|
82
|
+
export declare function SecDocumentSections200ResponseSectionsInnerFromJSON(json: any): SecDocumentSections200ResponseSectionsInner;
|
|
83
|
+
export declare function SecDocumentSections200ResponseSectionsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecDocumentSections200ResponseSectionsInner;
|
|
84
|
+
export declare function SecDocumentSections200ResponseSectionsInnerToJSON(json: any): SecDocumentSections200ResponseSectionsInner;
|
|
85
|
+
export declare function SecDocumentSections200ResponseSectionsInnerToJSONTyped(value?: SecDocumentSections200ResponseSectionsInner | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,44 @@
|
|
|
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
|
+
* @export
|
|
16
|
+
*/
|
|
17
|
+
export const SecDocumentSections200ResponseSectionsInnerOutlineEnum = {
|
|
18
|
+
Legacy: 'legacy',
|
|
19
|
+
Generic: 'generic'
|
|
20
|
+
};
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the SecDocumentSections200ResponseSectionsInner interface.
|
|
23
|
+
*/
|
|
24
|
+
export function instanceOfSecDocumentSections200ResponseSectionsInner(value) {
|
|
25
|
+
return true;
|
|
26
|
+
}
|
|
27
|
+
export function SecDocumentSections200ResponseSectionsInnerFromJSON(json) {
|
|
28
|
+
return SecDocumentSections200ResponseSectionsInnerFromJSONTyped(json, false);
|
|
29
|
+
}
|
|
30
|
+
export function SecDocumentSections200ResponseSectionsInnerFromJSONTyped(json, ignoreDiscriminator) {
|
|
31
|
+
if (json == null) {
|
|
32
|
+
return json;
|
|
33
|
+
}
|
|
34
|
+
return Object.assign(Object.assign({}, json), { 'outline': json['outline'] == null ? undefined : json['outline'], 'ordinal': json['ordinal'] == null ? undefined : json['ordinal'], 'legacy_section_key': json['legacy_section_key'] == null ? undefined : json['legacy_section_key'], 'part': json['part'] == null ? undefined : json['part'], 'item_id': json['item_id'] == null ? undefined : json['item_id'], 'title': json['title'] == null ? undefined : json['title'], 'blocks': json['blocks'] == null ? undefined : json['blocks'], 'block_spans': json['block_spans'] == null ? undefined : json['block_spans'] });
|
|
35
|
+
}
|
|
36
|
+
export function SecDocumentSections200ResponseSectionsInnerToJSON(json) {
|
|
37
|
+
return SecDocumentSections200ResponseSectionsInnerToJSONTyped(json, false);
|
|
38
|
+
}
|
|
39
|
+
export function SecDocumentSections200ResponseSectionsInnerToJSONTyped(value, ignoreDiscriminator = false) {
|
|
40
|
+
if (value == null) {
|
|
41
|
+
return value;
|
|
42
|
+
}
|
|
43
|
+
return Object.assign(Object.assign({}, value), { 'outline': value['outline'], 'ordinal': value['ordinal'], 'legacy_section_key': value['legacy_section_key'], 'part': value['part'], 'item_id': value['item_id'], 'title': value['title'], 'blocks': value['blocks'], 'block_spans': value['block_spans'] });
|
|
44
|
+
}
|