@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,103 @@
|
|
|
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.EarningsCallsCalendar200ResponseEventsInnerCalendarWarningsEnum = exports.EarningsCallsCalendar200ResponseEventsInnerCalendarFiscalPeriodQualityEnum = exports.EarningsCallsCalendar200ResponseEventsInnerCalendarStatusEnum = void 0;
|
|
17
|
+
exports.instanceOfEarningsCallsCalendar200ResponseEventsInnerCalendar = instanceOfEarningsCallsCalendar200ResponseEventsInnerCalendar;
|
|
18
|
+
exports.EarningsCallsCalendar200ResponseEventsInnerCalendarFromJSON = EarningsCallsCalendar200ResponseEventsInnerCalendarFromJSON;
|
|
19
|
+
exports.EarningsCallsCalendar200ResponseEventsInnerCalendarFromJSONTyped = EarningsCallsCalendar200ResponseEventsInnerCalendarFromJSONTyped;
|
|
20
|
+
exports.EarningsCallsCalendar200ResponseEventsInnerCalendarToJSON = EarningsCallsCalendar200ResponseEventsInnerCalendarToJSON;
|
|
21
|
+
exports.EarningsCallsCalendar200ResponseEventsInnerCalendarToJSONTyped = EarningsCallsCalendar200ResponseEventsInnerCalendarToJSONTyped;
|
|
22
|
+
const EarningsCallsCalendar200ResponseEventsInnerCalendarCall_1 = require("./EarningsCallsCalendar200ResponseEventsInnerCalendarCall");
|
|
23
|
+
const EarningsCallsCalendar200ResponseEventsInnerCalendarReport_1 = require("./EarningsCallsCalendar200ResponseEventsInnerCalendarReport");
|
|
24
|
+
/**
|
|
25
|
+
* @export
|
|
26
|
+
*/
|
|
27
|
+
exports.EarningsCallsCalendar200ResponseEventsInnerCalendarStatusEnum = {
|
|
28
|
+
Cancelled: 'cancelled',
|
|
29
|
+
Postponed: 'postponed',
|
|
30
|
+
Reported: 'reported',
|
|
31
|
+
Confirmed: 'confirmed',
|
|
32
|
+
Announced: 'announced',
|
|
33
|
+
Estimated: 'estimated'
|
|
34
|
+
};
|
|
35
|
+
/**
|
|
36
|
+
* @export
|
|
37
|
+
*/
|
|
38
|
+
exports.EarningsCallsCalendar200ResponseEventsInnerCalendarFiscalPeriodQualityEnum = {
|
|
39
|
+
Stated: 'stated',
|
|
40
|
+
Inferred: 'inferred',
|
|
41
|
+
Unknown: 'unknown'
|
|
42
|
+
};
|
|
43
|
+
/**
|
|
44
|
+
* @export
|
|
45
|
+
*/
|
|
46
|
+
exports.EarningsCallsCalendar200ResponseEventsInnerCalendarWarningsEnum = {
|
|
47
|
+
DateOnlyCall: 'date_only_call',
|
|
48
|
+
CallTimeFilingStandIn: 'call_time_filing_stand_in',
|
|
49
|
+
CallTimeLowConfidence: 'call_time_low_confidence',
|
|
50
|
+
CallTimeProvisional: 'call_time_provisional',
|
|
51
|
+
CallTimeVendor: 'call_time_vendor',
|
|
52
|
+
CallSuppressedNonCallIssuer: 'call_suppressed_non_call_issuer',
|
|
53
|
+
EstimateExpired: 'estimate_expired',
|
|
54
|
+
ReportTimeFromFilingAcceptance: 'report_time_from_filing_acceptance',
|
|
55
|
+
FiscalPeriodInferred: 'fiscal_period_inferred',
|
|
56
|
+
FiscalPeriodUnknown: 'fiscal_period_unknown'
|
|
57
|
+
};
|
|
58
|
+
/**
|
|
59
|
+
* Check if a given object implements the EarningsCallsCalendar200ResponseEventsInnerCalendar interface.
|
|
60
|
+
*/
|
|
61
|
+
function instanceOfEarningsCallsCalendar200ResponseEventsInnerCalendar(value) {
|
|
62
|
+
if (!('status' in value) || value['status'] === undefined)
|
|
63
|
+
return false;
|
|
64
|
+
if (!('call' in value) || value['call'] === undefined)
|
|
65
|
+
return false;
|
|
66
|
+
if (!('report' in value) || value['report'] === undefined)
|
|
67
|
+
return false;
|
|
68
|
+
if (!('fiscal_period_quality' in value) || value['fiscal_period_quality'] === undefined)
|
|
69
|
+
return false;
|
|
70
|
+
if (!('warnings' in value) || value['warnings'] === undefined)
|
|
71
|
+
return false;
|
|
72
|
+
return true;
|
|
73
|
+
}
|
|
74
|
+
function EarningsCallsCalendar200ResponseEventsInnerCalendarFromJSON(json) {
|
|
75
|
+
return EarningsCallsCalendar200ResponseEventsInnerCalendarFromJSONTyped(json, false);
|
|
76
|
+
}
|
|
77
|
+
function EarningsCallsCalendar200ResponseEventsInnerCalendarFromJSONTyped(json, ignoreDiscriminator) {
|
|
78
|
+
if (json == null) {
|
|
79
|
+
return json;
|
|
80
|
+
}
|
|
81
|
+
return {
|
|
82
|
+
'status': json['status'],
|
|
83
|
+
'call': (0, EarningsCallsCalendar200ResponseEventsInnerCalendarCall_1.EarningsCallsCalendar200ResponseEventsInnerCalendarCallFromJSON)(json['call']),
|
|
84
|
+
'report': (0, EarningsCallsCalendar200ResponseEventsInnerCalendarReport_1.EarningsCallsCalendar200ResponseEventsInnerCalendarReportFromJSON)(json['report']),
|
|
85
|
+
'fiscal_period_quality': json['fiscal_period_quality'],
|
|
86
|
+
'warnings': json['warnings'],
|
|
87
|
+
};
|
|
88
|
+
}
|
|
89
|
+
function EarningsCallsCalendar200ResponseEventsInnerCalendarToJSON(json) {
|
|
90
|
+
return EarningsCallsCalendar200ResponseEventsInnerCalendarToJSONTyped(json, false);
|
|
91
|
+
}
|
|
92
|
+
function EarningsCallsCalendar200ResponseEventsInnerCalendarToJSONTyped(value, ignoreDiscriminator = false) {
|
|
93
|
+
if (value == null) {
|
|
94
|
+
return value;
|
|
95
|
+
}
|
|
96
|
+
return {
|
|
97
|
+
'status': value['status'],
|
|
98
|
+
'call': (0, EarningsCallsCalendar200ResponseEventsInnerCalendarCall_1.EarningsCallsCalendar200ResponseEventsInnerCalendarCallToJSON)(value['call']),
|
|
99
|
+
'report': (0, EarningsCallsCalendar200ResponseEventsInnerCalendarReport_1.EarningsCallsCalendar200ResponseEventsInnerCalendarReportToJSON)(value['report']),
|
|
100
|
+
'fiscal_period_quality': value['fiscal_period_quality'],
|
|
101
|
+
'warnings': value['warnings'],
|
|
102
|
+
};
|
|
103
|
+
}
|
|
@@ -0,0 +1,102 @@
|
|
|
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 { EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource } from './EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource';
|
|
13
|
+
/**
|
|
14
|
+
* The call (null fields when no call is expected)
|
|
15
|
+
* @export
|
|
16
|
+
* @interface EarningsCallsCalendar200ResponseEventsInnerCalendarCall
|
|
17
|
+
*/
|
|
18
|
+
export interface EarningsCallsCalendar200ResponseEventsInnerCalendarCall {
|
|
19
|
+
/**
|
|
20
|
+
* Call status: the event statuses without reported, plus held, no_call, expired, not_expected (a non-call issuer)
|
|
21
|
+
* @type {EarningsCallsCalendar200ResponseEventsInnerCalendarCallStatusEnum}
|
|
22
|
+
* @memberof EarningsCallsCalendar200ResponseEventsInnerCalendarCall
|
|
23
|
+
*/
|
|
24
|
+
status: EarningsCallsCalendar200ResponseEventsInnerCalendarCallStatusEnum | null;
|
|
25
|
+
/**
|
|
26
|
+
* Call day (YYYY-MM-DD; New York day of a timed call)
|
|
27
|
+
* @type {Date}
|
|
28
|
+
* @memberof EarningsCallsCalendar200ResponseEventsInnerCalendarCall
|
|
29
|
+
*/
|
|
30
|
+
date: Date | null;
|
|
31
|
+
/**
|
|
32
|
+
* Call start (ISO 8601 UTC); null for a date-only call or a filing-time stand-in
|
|
33
|
+
* @type {Date}
|
|
34
|
+
* @memberof EarningsCallsCalendar200ResponseEventsInnerCalendarCall
|
|
35
|
+
*/
|
|
36
|
+
at: Date | null;
|
|
37
|
+
/**
|
|
38
|
+
* How good `at` is
|
|
39
|
+
* @type {EarningsCallsCalendar200ResponseEventsInnerCalendarCallTimeQualityEnum}
|
|
40
|
+
* @memberof EarningsCallsCalendar200ResponseEventsInnerCalendarCall
|
|
41
|
+
*/
|
|
42
|
+
time_quality: EarningsCallsCalendar200ResponseEventsInnerCalendarCallTimeQualityEnum | null;
|
|
43
|
+
/**
|
|
44
|
+
* Where the call date comes from
|
|
45
|
+
* @type {EarningsCallsCalendar200ResponseEventsInnerCalendarCallDateBasisEnum}
|
|
46
|
+
* @memberof EarningsCallsCalendar200ResponseEventsInnerCalendarCall
|
|
47
|
+
*/
|
|
48
|
+
date_basis: EarningsCallsCalendar200ResponseEventsInnerCalendarCallDateBasisEnum | null;
|
|
49
|
+
/**
|
|
50
|
+
*
|
|
51
|
+
* @type {EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource}
|
|
52
|
+
* @memberof EarningsCallsCalendar200ResponseEventsInnerCalendarCall
|
|
53
|
+
*/
|
|
54
|
+
source: EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource | null;
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* @export
|
|
58
|
+
*/
|
|
59
|
+
export declare const EarningsCallsCalendar200ResponseEventsInnerCalendarCallStatusEnum: {
|
|
60
|
+
readonly Cancelled: "cancelled";
|
|
61
|
+
readonly Postponed: "postponed";
|
|
62
|
+
readonly Held: "held";
|
|
63
|
+
readonly NoCall: "no_call";
|
|
64
|
+
readonly Expired: "expired";
|
|
65
|
+
readonly NotExpected: "not_expected";
|
|
66
|
+
readonly Confirmed: "confirmed";
|
|
67
|
+
readonly Announced: "announced";
|
|
68
|
+
readonly Estimated: "estimated";
|
|
69
|
+
};
|
|
70
|
+
export type EarningsCallsCalendar200ResponseEventsInnerCalendarCallStatusEnum = typeof EarningsCallsCalendar200ResponseEventsInnerCalendarCallStatusEnum[keyof typeof EarningsCallsCalendar200ResponseEventsInnerCalendarCallStatusEnum];
|
|
71
|
+
/**
|
|
72
|
+
* @export
|
|
73
|
+
*/
|
|
74
|
+
export declare const EarningsCallsCalendar200ResponseEventsInnerCalendarCallTimeQualityEnum: {
|
|
75
|
+
readonly FirstParty: "first_party";
|
|
76
|
+
readonly FirstPartyLow: "first_party_low";
|
|
77
|
+
readonly Vendor: "vendor";
|
|
78
|
+
readonly Provisional: "provisional";
|
|
79
|
+
readonly Estimate: "estimate";
|
|
80
|
+
readonly DateOnly: "date_only";
|
|
81
|
+
readonly None: "none";
|
|
82
|
+
};
|
|
83
|
+
export type EarningsCallsCalendar200ResponseEventsInnerCalendarCallTimeQualityEnum = typeof EarningsCallsCalendar200ResponseEventsInnerCalendarCallTimeQualityEnum[keyof typeof EarningsCallsCalendar200ResponseEventsInnerCalendarCallTimeQualityEnum];
|
|
84
|
+
/**
|
|
85
|
+
* @export
|
|
86
|
+
*/
|
|
87
|
+
export declare const EarningsCallsCalendar200ResponseEventsInnerCalendarCallDateBasisEnum: {
|
|
88
|
+
readonly FirstParty: "first_party";
|
|
89
|
+
readonly Provisional: "provisional";
|
|
90
|
+
readonly Vendor: "vendor";
|
|
91
|
+
readonly Estimate: "estimate";
|
|
92
|
+
readonly None: "none";
|
|
93
|
+
};
|
|
94
|
+
export type EarningsCallsCalendar200ResponseEventsInnerCalendarCallDateBasisEnum = typeof EarningsCallsCalendar200ResponseEventsInnerCalendarCallDateBasisEnum[keyof typeof EarningsCallsCalendar200ResponseEventsInnerCalendarCallDateBasisEnum];
|
|
95
|
+
/**
|
|
96
|
+
* Check if a given object implements the EarningsCallsCalendar200ResponseEventsInnerCalendarCall interface.
|
|
97
|
+
*/
|
|
98
|
+
export declare function instanceOfEarningsCallsCalendar200ResponseEventsInnerCalendarCall(value: object): value is EarningsCallsCalendar200ResponseEventsInnerCalendarCall;
|
|
99
|
+
export declare function EarningsCallsCalendar200ResponseEventsInnerCalendarCallFromJSON(json: any): EarningsCallsCalendar200ResponseEventsInnerCalendarCall;
|
|
100
|
+
export declare function EarningsCallsCalendar200ResponseEventsInnerCalendarCallFromJSONTyped(json: any, ignoreDiscriminator: boolean): EarningsCallsCalendar200ResponseEventsInnerCalendarCall;
|
|
101
|
+
export declare function EarningsCallsCalendar200ResponseEventsInnerCalendarCallToJSON(json: any): EarningsCallsCalendar200ResponseEventsInnerCalendarCall;
|
|
102
|
+
export declare function EarningsCallsCalendar200ResponseEventsInnerCalendarCallToJSONTyped(value?: EarningsCallsCalendar200ResponseEventsInnerCalendarCall | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -13,94 +13,96 @@
|
|
|
13
13
|
* Do not edit the class manually.
|
|
14
14
|
*/
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
-
exports.
|
|
17
|
-
exports.
|
|
18
|
-
exports.
|
|
19
|
-
exports.
|
|
20
|
-
exports.
|
|
16
|
+
exports.EarningsCallsCalendar200ResponseEventsInnerCalendarCallDateBasisEnum = exports.EarningsCallsCalendar200ResponseEventsInnerCalendarCallTimeQualityEnum = exports.EarningsCallsCalendar200ResponseEventsInnerCalendarCallStatusEnum = void 0;
|
|
17
|
+
exports.instanceOfEarningsCallsCalendar200ResponseEventsInnerCalendarCall = instanceOfEarningsCallsCalendar200ResponseEventsInnerCalendarCall;
|
|
18
|
+
exports.EarningsCallsCalendar200ResponseEventsInnerCalendarCallFromJSON = EarningsCallsCalendar200ResponseEventsInnerCalendarCallFromJSON;
|
|
19
|
+
exports.EarningsCallsCalendar200ResponseEventsInnerCalendarCallFromJSONTyped = EarningsCallsCalendar200ResponseEventsInnerCalendarCallFromJSONTyped;
|
|
20
|
+
exports.EarningsCallsCalendar200ResponseEventsInnerCalendarCallToJSON = EarningsCallsCalendar200ResponseEventsInnerCalendarCallToJSON;
|
|
21
|
+
exports.EarningsCallsCalendar200ResponseEventsInnerCalendarCallToJSONTyped = EarningsCallsCalendar200ResponseEventsInnerCalendarCallToJSONTyped;
|
|
22
|
+
const EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource_1 = require("./EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource");
|
|
21
23
|
/**
|
|
22
|
-
*
|
|
24
|
+
* @export
|
|
23
25
|
*/
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
26
|
+
exports.EarningsCallsCalendar200ResponseEventsInnerCalendarCallStatusEnum = {
|
|
27
|
+
Cancelled: 'cancelled',
|
|
28
|
+
Postponed: 'postponed',
|
|
29
|
+
Held: 'held',
|
|
30
|
+
NoCall: 'no_call',
|
|
31
|
+
Expired: 'expired',
|
|
32
|
+
NotExpected: 'not_expected',
|
|
33
|
+
Confirmed: 'confirmed',
|
|
34
|
+
Announced: 'announced',
|
|
35
|
+
Estimated: 'estimated'
|
|
36
|
+
};
|
|
37
|
+
/**
|
|
38
|
+
* @export
|
|
39
|
+
*/
|
|
40
|
+
exports.EarningsCallsCalendar200ResponseEventsInnerCalendarCallTimeQualityEnum = {
|
|
41
|
+
FirstParty: 'first_party',
|
|
42
|
+
FirstPartyLow: 'first_party_low',
|
|
43
|
+
Vendor: 'vendor',
|
|
44
|
+
Provisional: 'provisional',
|
|
45
|
+
Estimate: 'estimate',
|
|
46
|
+
DateOnly: 'date_only',
|
|
47
|
+
None: 'none'
|
|
48
|
+
};
|
|
49
|
+
/**
|
|
50
|
+
* @export
|
|
51
|
+
*/
|
|
52
|
+
exports.EarningsCallsCalendar200ResponseEventsInnerCalendarCallDateBasisEnum = {
|
|
53
|
+
FirstParty: 'first_party',
|
|
54
|
+
Provisional: 'provisional',
|
|
55
|
+
Vendor: 'vendor',
|
|
56
|
+
Estimate: 'estimate',
|
|
57
|
+
None: 'none'
|
|
58
|
+
};
|
|
59
|
+
/**
|
|
60
|
+
* Check if a given object implements the EarningsCallsCalendar200ResponseEventsInnerCalendarCall interface.
|
|
61
|
+
*/
|
|
62
|
+
function instanceOfEarningsCallsCalendar200ResponseEventsInnerCalendarCall(value) {
|
|
63
|
+
if (!('status' in value) || value['status'] === undefined)
|
|
44
64
|
return false;
|
|
45
|
-
if (!('
|
|
65
|
+
if (!('date' in value) || value['date'] === undefined)
|
|
46
66
|
return false;
|
|
47
|
-
if (!('
|
|
67
|
+
if (!('at' in value) || value['at'] === undefined)
|
|
48
68
|
return false;
|
|
49
|
-
if (!('
|
|
69
|
+
if (!('time_quality' in value) || value['time_quality'] === undefined)
|
|
50
70
|
return false;
|
|
51
|
-
if (!('
|
|
71
|
+
if (!('date_basis' in value) || value['date_basis'] === undefined)
|
|
52
72
|
return false;
|
|
53
|
-
if (!('
|
|
73
|
+
if (!('source' in value) || value['source'] === undefined)
|
|
54
74
|
return false;
|
|
55
75
|
return true;
|
|
56
76
|
}
|
|
57
|
-
function
|
|
58
|
-
return
|
|
77
|
+
function EarningsCallsCalendar200ResponseEventsInnerCalendarCallFromJSON(json) {
|
|
78
|
+
return EarningsCallsCalendar200ResponseEventsInnerCalendarCallFromJSONTyped(json, false);
|
|
59
79
|
}
|
|
60
|
-
function
|
|
80
|
+
function EarningsCallsCalendar200ResponseEventsInnerCalendarCallFromJSONTyped(json, ignoreDiscriminator) {
|
|
61
81
|
if (json == null) {
|
|
62
82
|
return json;
|
|
63
83
|
}
|
|
64
84
|
return {
|
|
65
|
-
'
|
|
66
|
-
'
|
|
67
|
-
'
|
|
68
|
-
'
|
|
69
|
-
'
|
|
70
|
-
'
|
|
71
|
-
'fiscal_quarter': json['fiscal_quarter'],
|
|
72
|
-
'fiscal_year': json['fiscal_year'],
|
|
73
|
-
'form_type': json['form_type'],
|
|
74
|
-
'html_tag_id': json['html_tag_id'],
|
|
75
|
-
'html_url': json['html_url'],
|
|
76
|
-
'item_id': json['item_id'],
|
|
77
|
-
'part': json['part'],
|
|
78
|
-
'period_end': (new Date(json['period_end'])),
|
|
79
|
-
'title': json['title'],
|
|
85
|
+
'status': json['status'],
|
|
86
|
+
'date': (json['date'] == null ? null : new Date(json['date'])),
|
|
87
|
+
'at': (json['at'] == null ? null : new Date(json['at'])),
|
|
88
|
+
'time_quality': json['time_quality'],
|
|
89
|
+
'date_basis': json['date_basis'],
|
|
90
|
+
'source': (0, EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource_1.EarningsCallsCalendar200ResponseEventsInnerCalendarCallSourceFromJSON)(json['source']),
|
|
80
91
|
};
|
|
81
92
|
}
|
|
82
|
-
function
|
|
83
|
-
return
|
|
93
|
+
function EarningsCallsCalendar200ResponseEventsInnerCalendarCallToJSON(json) {
|
|
94
|
+
return EarningsCallsCalendar200ResponseEventsInnerCalendarCallToJSONTyped(json, false);
|
|
84
95
|
}
|
|
85
|
-
function
|
|
96
|
+
function EarningsCallsCalendar200ResponseEventsInnerCalendarCallToJSONTyped(value, ignoreDiscriminator = false) {
|
|
86
97
|
if (value == null) {
|
|
87
98
|
return value;
|
|
88
99
|
}
|
|
89
100
|
return {
|
|
90
|
-
'
|
|
91
|
-
'
|
|
92
|
-
'
|
|
93
|
-
'
|
|
94
|
-
'
|
|
95
|
-
'
|
|
96
|
-
'fiscal_quarter': value['fiscal_quarter'],
|
|
97
|
-
'fiscal_year': value['fiscal_year'],
|
|
98
|
-
'form_type': value['form_type'],
|
|
99
|
-
'html_tag_id': value['html_tag_id'],
|
|
100
|
-
'html_url': value['html_url'],
|
|
101
|
-
'item_id': value['item_id'],
|
|
102
|
-
'part': value['part'],
|
|
103
|
-
'period_end': value['period_end'].toISOString().substring(0, 10),
|
|
104
|
-
'title': value['title'],
|
|
101
|
+
'status': value['status'],
|
|
102
|
+
'date': value['date'] == null ? value['date'] : value['date'].toISOString().substring(0, 10),
|
|
103
|
+
'at': value['at'] == null ? value['at'] : value['at'].toISOString(),
|
|
104
|
+
'time_quality': value['time_quality'],
|
|
105
|
+
'date_basis': value['date_basis'],
|
|
106
|
+
'source': (0, EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource_1.EarningsCallsCalendar200ResponseEventsInnerCalendarCallSourceToJSON)(value['source']),
|
|
105
107
|
};
|
|
106
108
|
}
|
|
@@ -0,0 +1,56 @@
|
|
|
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
|
+
* The observation that states the date / time
|
|
14
|
+
* @export
|
|
15
|
+
* @interface EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource
|
|
16
|
+
*/
|
|
17
|
+
export interface EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource {
|
|
18
|
+
/**
|
|
19
|
+
* Source type (wire, edgar, ir_feed, ir_page, vendor, …)
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource
|
|
22
|
+
*/
|
|
23
|
+
type: string | null;
|
|
24
|
+
/**
|
|
25
|
+
* A citable URL or accession; null for a vendor row
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource
|
|
28
|
+
*/
|
|
29
|
+
ref: string | null;
|
|
30
|
+
/**
|
|
31
|
+
* When it was observed
|
|
32
|
+
* @type {Date}
|
|
33
|
+
* @memberof EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource
|
|
34
|
+
*/
|
|
35
|
+
observed_at: Date | null;
|
|
36
|
+
/**
|
|
37
|
+
* The zone the time was stated in
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource
|
|
40
|
+
*/
|
|
41
|
+
tz: string | null;
|
|
42
|
+
/**
|
|
43
|
+
* true = the zone was inferred, not stated
|
|
44
|
+
* @type {boolean}
|
|
45
|
+
* @memberof EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource
|
|
46
|
+
*/
|
|
47
|
+
tz_inferred: boolean | null;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Check if a given object implements the EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource interface.
|
|
51
|
+
*/
|
|
52
|
+
export declare function instanceOfEarningsCallsCalendar200ResponseEventsInnerCalendarCallSource(value: object): value is EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource;
|
|
53
|
+
export declare function EarningsCallsCalendar200ResponseEventsInnerCalendarCallSourceFromJSON(json: any): EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource;
|
|
54
|
+
export declare function EarningsCallsCalendar200ResponseEventsInnerCalendarCallSourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource;
|
|
55
|
+
export declare function EarningsCallsCalendar200ResponseEventsInnerCalendarCallSourceToJSON(json: any): EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource;
|
|
56
|
+
export declare function EarningsCallsCalendar200ResponseEventsInnerCalendarCallSourceToJSONTyped(value?: EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,66 @@
|
|
|
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.instanceOfEarningsCallsCalendar200ResponseEventsInnerCalendarCallSource = instanceOfEarningsCallsCalendar200ResponseEventsInnerCalendarCallSource;
|
|
17
|
+
exports.EarningsCallsCalendar200ResponseEventsInnerCalendarCallSourceFromJSON = EarningsCallsCalendar200ResponseEventsInnerCalendarCallSourceFromJSON;
|
|
18
|
+
exports.EarningsCallsCalendar200ResponseEventsInnerCalendarCallSourceFromJSONTyped = EarningsCallsCalendar200ResponseEventsInnerCalendarCallSourceFromJSONTyped;
|
|
19
|
+
exports.EarningsCallsCalendar200ResponseEventsInnerCalendarCallSourceToJSON = EarningsCallsCalendar200ResponseEventsInnerCalendarCallSourceToJSON;
|
|
20
|
+
exports.EarningsCallsCalendar200ResponseEventsInnerCalendarCallSourceToJSONTyped = EarningsCallsCalendar200ResponseEventsInnerCalendarCallSourceToJSONTyped;
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource interface.
|
|
23
|
+
*/
|
|
24
|
+
function instanceOfEarningsCallsCalendar200ResponseEventsInnerCalendarCallSource(value) {
|
|
25
|
+
if (!('type' in value) || value['type'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
if (!('ref' in value) || value['ref'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
if (!('observed_at' in value) || value['observed_at'] === undefined)
|
|
30
|
+
return false;
|
|
31
|
+
if (!('tz' in value) || value['tz'] === undefined)
|
|
32
|
+
return false;
|
|
33
|
+
if (!('tz_inferred' in value) || value['tz_inferred'] === undefined)
|
|
34
|
+
return false;
|
|
35
|
+
return true;
|
|
36
|
+
}
|
|
37
|
+
function EarningsCallsCalendar200ResponseEventsInnerCalendarCallSourceFromJSON(json) {
|
|
38
|
+
return EarningsCallsCalendar200ResponseEventsInnerCalendarCallSourceFromJSONTyped(json, false);
|
|
39
|
+
}
|
|
40
|
+
function EarningsCallsCalendar200ResponseEventsInnerCalendarCallSourceFromJSONTyped(json, ignoreDiscriminator) {
|
|
41
|
+
if (json == null) {
|
|
42
|
+
return json;
|
|
43
|
+
}
|
|
44
|
+
return {
|
|
45
|
+
'type': json['type'],
|
|
46
|
+
'ref': json['ref'],
|
|
47
|
+
'observed_at': (json['observed_at'] == null ? null : new Date(json['observed_at'])),
|
|
48
|
+
'tz': json['tz'],
|
|
49
|
+
'tz_inferred': json['tz_inferred'],
|
|
50
|
+
};
|
|
51
|
+
}
|
|
52
|
+
function EarningsCallsCalendar200ResponseEventsInnerCalendarCallSourceToJSON(json) {
|
|
53
|
+
return EarningsCallsCalendar200ResponseEventsInnerCalendarCallSourceToJSONTyped(json, false);
|
|
54
|
+
}
|
|
55
|
+
function EarningsCallsCalendar200ResponseEventsInnerCalendarCallSourceToJSONTyped(value, ignoreDiscriminator = false) {
|
|
56
|
+
if (value == null) {
|
|
57
|
+
return value;
|
|
58
|
+
}
|
|
59
|
+
return {
|
|
60
|
+
'type': value['type'],
|
|
61
|
+
'ref': value['ref'],
|
|
62
|
+
'observed_at': value['observed_at'] == null ? value['observed_at'] : value['observed_at'].toISOString(),
|
|
63
|
+
'tz': value['tz'],
|
|
64
|
+
'tz_inferred': value['tz_inferred'],
|
|
65
|
+
};
|
|
66
|
+
}
|
|
@@ -0,0 +1,69 @@
|
|
|
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 { EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource } from './EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource';
|
|
13
|
+
/**
|
|
14
|
+
* The results release
|
|
15
|
+
* @export
|
|
16
|
+
* @interface EarningsCallsCalendar200ResponseEventsInnerCalendarReport
|
|
17
|
+
*/
|
|
18
|
+
export interface EarningsCallsCalendar200ResponseEventsInnerCalendarReport {
|
|
19
|
+
/**
|
|
20
|
+
* Report day (New York); null before the results
|
|
21
|
+
* @type {Date}
|
|
22
|
+
* @memberof EarningsCallsCalendar200ResponseEventsInnerCalendarReport
|
|
23
|
+
*/
|
|
24
|
+
date: Date | null;
|
|
25
|
+
/**
|
|
26
|
+
* bmo (before 09:30 New York) / amc (from 16:00) from the results filing's acceptance, unknown otherwise; exact is reserved for a stated release time
|
|
27
|
+
* @type {EarningsCallsCalendar200ResponseEventsInnerCalendarReportTimeKindEnum}
|
|
28
|
+
* @memberof EarningsCallsCalendar200ResponseEventsInnerCalendarReport
|
|
29
|
+
*/
|
|
30
|
+
time_kind: EarningsCallsCalendar200ResponseEventsInnerCalendarReportTimeKindEnum | null;
|
|
31
|
+
/**
|
|
32
|
+
* filing_acceptance (the results filing's acceptance) or none
|
|
33
|
+
* @type {EarningsCallsCalendar200ResponseEventsInnerCalendarReportQualityEnum}
|
|
34
|
+
* @memberof EarningsCallsCalendar200ResponseEventsInnerCalendarReport
|
|
35
|
+
*/
|
|
36
|
+
quality: EarningsCallsCalendar200ResponseEventsInnerCalendarReportQualityEnum | null;
|
|
37
|
+
/**
|
|
38
|
+
*
|
|
39
|
+
* @type {EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource}
|
|
40
|
+
* @memberof EarningsCallsCalendar200ResponseEventsInnerCalendarReport
|
|
41
|
+
*/
|
|
42
|
+
source: EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource | null;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* @export
|
|
46
|
+
*/
|
|
47
|
+
export declare const EarningsCallsCalendar200ResponseEventsInnerCalendarReportTimeKindEnum: {
|
|
48
|
+
readonly Exact: "exact";
|
|
49
|
+
readonly Bmo: "bmo";
|
|
50
|
+
readonly Amc: "amc";
|
|
51
|
+
readonly Unknown: "unknown";
|
|
52
|
+
};
|
|
53
|
+
export type EarningsCallsCalendar200ResponseEventsInnerCalendarReportTimeKindEnum = typeof EarningsCallsCalendar200ResponseEventsInnerCalendarReportTimeKindEnum[keyof typeof EarningsCallsCalendar200ResponseEventsInnerCalendarReportTimeKindEnum];
|
|
54
|
+
/**
|
|
55
|
+
* @export
|
|
56
|
+
*/
|
|
57
|
+
export declare const EarningsCallsCalendar200ResponseEventsInnerCalendarReportQualityEnum: {
|
|
58
|
+
readonly FilingAcceptance: "filing_acceptance";
|
|
59
|
+
readonly None: "none";
|
|
60
|
+
};
|
|
61
|
+
export type EarningsCallsCalendar200ResponseEventsInnerCalendarReportQualityEnum = typeof EarningsCallsCalendar200ResponseEventsInnerCalendarReportQualityEnum[keyof typeof EarningsCallsCalendar200ResponseEventsInnerCalendarReportQualityEnum];
|
|
62
|
+
/**
|
|
63
|
+
* Check if a given object implements the EarningsCallsCalendar200ResponseEventsInnerCalendarReport interface.
|
|
64
|
+
*/
|
|
65
|
+
export declare function instanceOfEarningsCallsCalendar200ResponseEventsInnerCalendarReport(value: object): value is EarningsCallsCalendar200ResponseEventsInnerCalendarReport;
|
|
66
|
+
export declare function EarningsCallsCalendar200ResponseEventsInnerCalendarReportFromJSON(json: any): EarningsCallsCalendar200ResponseEventsInnerCalendarReport;
|
|
67
|
+
export declare function EarningsCallsCalendar200ResponseEventsInnerCalendarReportFromJSONTyped(json: any, ignoreDiscriminator: boolean): EarningsCallsCalendar200ResponseEventsInnerCalendarReport;
|
|
68
|
+
export declare function EarningsCallsCalendar200ResponseEventsInnerCalendarReportToJSON(json: any): EarningsCallsCalendar200ResponseEventsInnerCalendarReport;
|
|
69
|
+
export declare function EarningsCallsCalendar200ResponseEventsInnerCalendarReportToJSONTyped(value?: EarningsCallsCalendar200ResponseEventsInnerCalendarReport | null, ignoreDiscriminator?: boolean): any;
|