@invinite-org/data-api-client 0.10.1 → 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/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/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/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/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,115 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Invinite API
|
|
5
|
+
* Invinite financial data API. Each endpoint has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Included-Remaining` what is left of the plan\'s included credits. `GET /v1/account/usage` returns your account\'s usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost. **Coverage.** Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/company/available-companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the CIKs it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `ping` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `ping` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: Issuer and SEC text is served in full with its attribution; the licensee shows publisher, source URL and date next to it and may forward it unmodified; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs reproduce issuer or SEC text under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/account/usage` serves no licensed data and carries none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
import type { SecSearchCoverageLexical } from './SecSearchCoverageLexical';
|
|
17
|
+
import {
|
|
18
|
+
SecSearchCoverageLexicalFromJSON,
|
|
19
|
+
SecSearchCoverageLexicalFromJSONTyped,
|
|
20
|
+
SecSearchCoverageLexicalToJSON,
|
|
21
|
+
SecSearchCoverageLexicalToJSONTyped,
|
|
22
|
+
} from './SecSearchCoverageLexical';
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* How much of the searched SEC scope the text index covers (the earnings search vocabulary). `forms_indexed` / `years_indexed` / `indexed_since` state the index policy; documents of other forms are counted in `lexical.not_indexed_by_policy` (by design, not a gap). For exactly one `cik`, `held` / `mirror` say how much of the filer's history is held (`held_through`).
|
|
26
|
+
* @export
|
|
27
|
+
* @interface SecSearchCoverage
|
|
28
|
+
*/
|
|
29
|
+
export interface SecSearchCoverage {
|
|
30
|
+
[key: string]: any | any;
|
|
31
|
+
/**
|
|
32
|
+
* complete = no hits is a genuine no-result; partial / unknown = the answer may be incomplete
|
|
33
|
+
* @type {SecSearchCoverageCompletenessEnum}
|
|
34
|
+
* @memberof SecSearchCoverage
|
|
35
|
+
*/
|
|
36
|
+
completeness: SecSearchCoverageCompletenessEnum;
|
|
37
|
+
/**
|
|
38
|
+
*
|
|
39
|
+
* @type {SecSearchCoverageLexical}
|
|
40
|
+
* @memberof SecSearchCoverage
|
|
41
|
+
*/
|
|
42
|
+
lexical: SecSearchCoverageLexical | null;
|
|
43
|
+
/**
|
|
44
|
+
* Why the answer may be incomplete: not_projected, projection_failed, not_published, not_held, held_not_verified, candidate_cap_reached, scan_budget_reached, scope_needs_review, scope_not_current, form_not_indexed, older_than_index_window, no_forms_indexed, held_gap, search_provider_not_registered, search_projection_empty, search_timeout, scope_excluded, documents_not_held
|
|
45
|
+
* @type {Array<string>}
|
|
46
|
+
* @memberof SecSearchCoverage
|
|
47
|
+
*/
|
|
48
|
+
reasons: Array<string>;
|
|
49
|
+
/**
|
|
50
|
+
* The indexed form policy (`10-K*` = the form and its /A)
|
|
51
|
+
* @type {Array<string>}
|
|
52
|
+
* @memberof SecSearchCoverage
|
|
53
|
+
*/
|
|
54
|
+
forms_indexed?: Array<string> | null;
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
/**
|
|
59
|
+
* @export
|
|
60
|
+
*/
|
|
61
|
+
export const SecSearchCoverageCompletenessEnum = {
|
|
62
|
+
Complete: 'complete',
|
|
63
|
+
Partial: 'partial',
|
|
64
|
+
Unknown: 'unknown'
|
|
65
|
+
} as const;
|
|
66
|
+
export type SecSearchCoverageCompletenessEnum = typeof SecSearchCoverageCompletenessEnum[keyof typeof SecSearchCoverageCompletenessEnum];
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
/**
|
|
70
|
+
* Check if a given object implements the SecSearchCoverage interface.
|
|
71
|
+
*/
|
|
72
|
+
export function instanceOfSecSearchCoverage(value: object): value is SecSearchCoverage {
|
|
73
|
+
if (!('completeness' in value) || value['completeness'] === undefined) return false;
|
|
74
|
+
if (!('lexical' in value) || value['lexical'] === undefined) return false;
|
|
75
|
+
if (!('reasons' in value) || value['reasons'] === undefined) return false;
|
|
76
|
+
return true;
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
export function SecSearchCoverageFromJSON(json: any): SecSearchCoverage {
|
|
80
|
+
return SecSearchCoverageFromJSONTyped(json, false);
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
export function SecSearchCoverageFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecSearchCoverage {
|
|
84
|
+
if (json == null) {
|
|
85
|
+
return json;
|
|
86
|
+
}
|
|
87
|
+
return {
|
|
88
|
+
|
|
89
|
+
...json,
|
|
90
|
+
'completeness': json['completeness'],
|
|
91
|
+
'lexical': SecSearchCoverageLexicalFromJSON(json['lexical']),
|
|
92
|
+
'reasons': json['reasons'],
|
|
93
|
+
'forms_indexed': json['forms_indexed'] == null ? undefined : json['forms_indexed'],
|
|
94
|
+
};
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
export function SecSearchCoverageToJSON(json: any): SecSearchCoverage {
|
|
98
|
+
return SecSearchCoverageToJSONTyped(json, false);
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
export function SecSearchCoverageToJSONTyped(value?: SecSearchCoverage | null, ignoreDiscriminator: boolean = false): any {
|
|
102
|
+
if (value == null) {
|
|
103
|
+
return value;
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
return {
|
|
107
|
+
|
|
108
|
+
...value,
|
|
109
|
+
'completeness': value['completeness'],
|
|
110
|
+
'lexical': SecSearchCoverageLexicalToJSON(value['lexical']),
|
|
111
|
+
'reasons': value['reasons'],
|
|
112
|
+
'forms_indexed': value['forms_indexed'],
|
|
113
|
+
};
|
|
114
|
+
}
|
|
115
|
+
|
|
@@ -13,62 +13,80 @@
|
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
15
|
import { mapValues } from '../runtime';
|
|
16
|
-
import type { SecFilingsList200ResponseCompaniesInner } from './SecFilingsList200ResponseCompaniesInner';
|
|
17
|
-
import {
|
|
18
|
-
SecFilingsList200ResponseCompaniesInnerFromJSON,
|
|
19
|
-
SecFilingsList200ResponseCompaniesInnerFromJSONTyped,
|
|
20
|
-
SecFilingsList200ResponseCompaniesInnerToJSON,
|
|
21
|
-
SecFilingsList200ResponseCompaniesInnerToJSONTyped,
|
|
22
|
-
} from './SecFilingsList200ResponseCompaniesInner';
|
|
23
|
-
|
|
24
16
|
/**
|
|
25
|
-
*
|
|
17
|
+
* The text index over the scope; null when nothing was searched (excluded / not indexed by policy)
|
|
26
18
|
* @export
|
|
27
|
-
* @interface
|
|
19
|
+
* @interface SecSearchCoverageLexical
|
|
28
20
|
*/
|
|
29
|
-
export interface
|
|
21
|
+
export interface SecSearchCoverageLexical {
|
|
22
|
+
[key: string]: any | any;
|
|
23
|
+
/**
|
|
24
|
+
* ready / partial / not_ready
|
|
25
|
+
* @type {string}
|
|
26
|
+
* @memberof SecSearchCoverageLexical
|
|
27
|
+
*/
|
|
28
|
+
state?: string;
|
|
29
|
+
/**
|
|
30
|
+
* Documents of the scope searchable now
|
|
31
|
+
* @type {number}
|
|
32
|
+
* @memberof SecSearchCoverageLexical
|
|
33
|
+
*/
|
|
34
|
+
indexed?: number;
|
|
35
|
+
/**
|
|
36
|
+
* Not indexed yet
|
|
37
|
+
* @type {number}
|
|
38
|
+
* @memberof SecSearchCoverageLexical
|
|
39
|
+
*/
|
|
40
|
+
pending?: number;
|
|
30
41
|
/**
|
|
31
|
-
*
|
|
32
|
-
* @type {
|
|
33
|
-
* @memberof
|
|
42
|
+
* Indexing failed
|
|
43
|
+
* @type {number}
|
|
44
|
+
* @memberof SecSearchCoverageLexical
|
|
34
45
|
*/
|
|
35
|
-
|
|
46
|
+
failed?: number;
|
|
36
47
|
}
|
|
37
48
|
|
|
38
49
|
/**
|
|
39
|
-
* Check if a given object implements the
|
|
50
|
+
* Check if a given object implements the SecSearchCoverageLexical interface.
|
|
40
51
|
*/
|
|
41
|
-
export function
|
|
42
|
-
if (!('companies' in value) || value['companies'] === undefined) return false;
|
|
52
|
+
export function instanceOfSecSearchCoverageLexical(value: object): value is SecSearchCoverageLexical {
|
|
43
53
|
return true;
|
|
44
54
|
}
|
|
45
55
|
|
|
46
|
-
export function
|
|
47
|
-
return
|
|
56
|
+
export function SecSearchCoverageLexicalFromJSON(json: any): SecSearchCoverageLexical {
|
|
57
|
+
return SecSearchCoverageLexicalFromJSONTyped(json, false);
|
|
48
58
|
}
|
|
49
59
|
|
|
50
|
-
export function
|
|
60
|
+
export function SecSearchCoverageLexicalFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecSearchCoverageLexical {
|
|
51
61
|
if (json == null) {
|
|
52
62
|
return json;
|
|
53
63
|
}
|
|
54
64
|
return {
|
|
55
65
|
|
|
56
|
-
|
|
66
|
+
...json,
|
|
67
|
+
'state': json['state'] == null ? undefined : json['state'],
|
|
68
|
+
'indexed': json['indexed'] == null ? undefined : json['indexed'],
|
|
69
|
+
'pending': json['pending'] == null ? undefined : json['pending'],
|
|
70
|
+
'failed': json['failed'] == null ? undefined : json['failed'],
|
|
57
71
|
};
|
|
58
72
|
}
|
|
59
73
|
|
|
60
|
-
export function
|
|
61
|
-
return
|
|
74
|
+
export function SecSearchCoverageLexicalToJSON(json: any): SecSearchCoverageLexical {
|
|
75
|
+
return SecSearchCoverageLexicalToJSONTyped(json, false);
|
|
62
76
|
}
|
|
63
77
|
|
|
64
|
-
export function
|
|
78
|
+
export function SecSearchCoverageLexicalToJSONTyped(value?: SecSearchCoverageLexical | null, ignoreDiscriminator: boolean = false): any {
|
|
65
79
|
if (value == null) {
|
|
66
80
|
return value;
|
|
67
81
|
}
|
|
68
82
|
|
|
69
83
|
return {
|
|
70
84
|
|
|
71
|
-
|
|
85
|
+
...value,
|
|
86
|
+
'state': value['state'],
|
|
87
|
+
'indexed': value['indexed'],
|
|
88
|
+
'pending': value['pending'],
|
|
89
|
+
'failed': value['failed'],
|
|
72
90
|
};
|
|
73
91
|
}
|
|
74
92
|
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Invinite API
|
|
5
|
+
* Invinite financial data API. Each endpoint has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Included-Remaining` what is left of the plan\'s included credits. `GET /v1/account/usage` returns your account\'s usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost. **Coverage.** Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/company/available-companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the CIKs it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `ping` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `ping` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: Issuer and SEC text is served in full with its attribution; the licensee shows publisher, source URL and date next to it and may forward it unmodified; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs reproduce issuer or SEC text under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/account/usage` serves no licensed data and carries none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
import type { SecReadiness } from './SecReadiness';
|
|
17
|
+
import {
|
|
18
|
+
SecReadinessFromJSON,
|
|
19
|
+
SecReadinessFromJSONTyped,
|
|
20
|
+
SecReadinessToJSON,
|
|
21
|
+
SecReadinessToJSONTyped,
|
|
22
|
+
} from './SecReadiness';
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend's typed answer when there was one (absent for a refused request). Fields of the answer's subject (e.g. `filing`) may follow.
|
|
26
|
+
* @export
|
|
27
|
+
* @interface SecStoreError
|
|
28
|
+
*/
|
|
29
|
+
export interface SecStoreError {
|
|
30
|
+
[key: string]: any | any;
|
|
31
|
+
/**
|
|
32
|
+
* The state or refusal
|
|
33
|
+
* @type {string}
|
|
34
|
+
* @memberof SecStoreError
|
|
35
|
+
*/
|
|
36
|
+
error: string;
|
|
37
|
+
/**
|
|
38
|
+
* One sentence
|
|
39
|
+
* @type {string}
|
|
40
|
+
* @memberof SecStoreError
|
|
41
|
+
*/
|
|
42
|
+
message: string;
|
|
43
|
+
/**
|
|
44
|
+
* Stable snake_case reason
|
|
45
|
+
* @type {string}
|
|
46
|
+
* @memberof SecStoreError
|
|
47
|
+
*/
|
|
48
|
+
code?: string | null;
|
|
49
|
+
/**
|
|
50
|
+
*
|
|
51
|
+
* @type {SecReadiness}
|
|
52
|
+
* @memberof SecStoreError
|
|
53
|
+
*/
|
|
54
|
+
readiness?: SecReadiness;
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
/**
|
|
58
|
+
* Check if a given object implements the SecStoreError interface.
|
|
59
|
+
*/
|
|
60
|
+
export function instanceOfSecStoreError(value: object): value is SecStoreError {
|
|
61
|
+
if (!('error' in value) || value['error'] === undefined) return false;
|
|
62
|
+
if (!('message' in value) || value['message'] === undefined) return false;
|
|
63
|
+
return true;
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
export function SecStoreErrorFromJSON(json: any): SecStoreError {
|
|
67
|
+
return SecStoreErrorFromJSONTyped(json, false);
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
export function SecStoreErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecStoreError {
|
|
71
|
+
if (json == null) {
|
|
72
|
+
return json;
|
|
73
|
+
}
|
|
74
|
+
return {
|
|
75
|
+
|
|
76
|
+
...json,
|
|
77
|
+
'error': json['error'],
|
|
78
|
+
'message': json['message'],
|
|
79
|
+
'code': json['code'] == null ? undefined : json['code'],
|
|
80
|
+
'readiness': json['readiness'] == null ? undefined : SecReadinessFromJSON(json['readiness']),
|
|
81
|
+
};
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
export function SecStoreErrorToJSON(json: any): SecStoreError {
|
|
85
|
+
return SecStoreErrorToJSONTyped(json, false);
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
export function SecStoreErrorToJSONTyped(value?: SecStoreError | null, ignoreDiscriminator: boolean = false): any {
|
|
89
|
+
if (value == null) {
|
|
90
|
+
return value;
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
return {
|
|
94
|
+
|
|
95
|
+
...value,
|
|
96
|
+
'error': value['error'],
|
|
97
|
+
'message': value['message'],
|
|
98
|
+
'code': value['code'],
|
|
99
|
+
'readiness': SecReadinessToJSON(value['readiness']),
|
|
100
|
+
};
|
|
101
|
+
}
|
|
102
|
+
|
|
@@ -22,7 +22,7 @@ import {
|
|
|
22
22
|
} from './ProposedSymbol';
|
|
23
23
|
|
|
24
24
|
/**
|
|
25
|
-
* A new SEC filing
|
|
25
|
+
* A new SEC filing with its `ticker` (null before an IPO) and `proposed_symbols`. Until 2026-10 the frame forwarded the upstream camelCase envelope (`schemaVersion`, `eventKey`, `filing.accessionNumber`, …) instead of this documented shape; it now is exactly this object
|
|
26
26
|
* @export
|
|
27
27
|
* @interface WebSocketFiling
|
|
28
28
|
*/
|
package/src/models/index.ts
CHANGED
|
@@ -46,6 +46,11 @@ export * from './EarningsCallsAnalysts200ResponseAnalystsInner';
|
|
|
46
46
|
export * from './EarningsCallsAudio200Response';
|
|
47
47
|
export * from './EarningsCallsCalendar200Response';
|
|
48
48
|
export * from './EarningsCallsCalendar200ResponseEventsInner';
|
|
49
|
+
export * from './EarningsCallsCalendar200ResponseEventsInnerCalendar';
|
|
50
|
+
export * from './EarningsCallsCalendar200ResponseEventsInnerCalendarCall';
|
|
51
|
+
export * from './EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource';
|
|
52
|
+
export * from './EarningsCallsCalendar200ResponseEventsInnerCalendarReport';
|
|
53
|
+
export * from './EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource';
|
|
49
54
|
export * from './EarningsCallsCalendar200ResponseEventsInnerVideo';
|
|
50
55
|
export * from './EarningsCallsCompanyDocument200Response';
|
|
51
56
|
export * from './EarningsCallsCompanyDocuments200Response';
|
|
@@ -107,6 +112,7 @@ export * from './EarningsCallsSlides200ResponseDeck';
|
|
|
107
112
|
export * from './EarningsCallsSlides200ResponseSlidesInner';
|
|
108
113
|
export * from './EarningsCallsSlides200ResponseTimelineInner';
|
|
109
114
|
export * from './EarningsCallsTranscript200Response';
|
|
115
|
+
export * from './EarningsCallsTranscript200ResponseEvent';
|
|
110
116
|
export * from './EarningsCallsTranscript404Response';
|
|
111
117
|
export * from './EarningsCallsTranscriptDiff200Response';
|
|
112
118
|
export * from './EarningsCallsTranscriptDiff200ResponseChangesInner';
|
|
@@ -146,6 +152,8 @@ export * from './IposList200ResponseIposInnerRegistration';
|
|
|
146
152
|
export * from './IposRegistrationsList200Response';
|
|
147
153
|
export * from './IposRegistrationsList200ResponseRegistrationsInner';
|
|
148
154
|
export * from './IposRegistrationsList200ResponseRegistrationsInnerFilingsInner';
|
|
155
|
+
export * from './IposRegistrationsList200ResponseRegistrationsInnerIpoPending';
|
|
156
|
+
export * from './IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile';
|
|
149
157
|
export * from './IposRegistrationsList200ResponseRegistrationsInnerMassive';
|
|
150
158
|
export * from './MarketHolidays200Response';
|
|
151
159
|
export * from './MarketHolidays200ResponseHolidaysInner';
|
|
@@ -188,15 +196,34 @@ export * from './PresentationFact';
|
|
|
188
196
|
export * from './ProposedSymbol';
|
|
189
197
|
export * from './SearchCoverage';
|
|
190
198
|
export * from './SearchCoverageLeg';
|
|
191
|
-
export * from './
|
|
192
|
-
export * from './
|
|
193
|
-
export * from './
|
|
194
|
-
export * from './
|
|
195
|
-
export * from './
|
|
196
|
-
export * from './
|
|
197
|
-
export * from './
|
|
198
|
-
export * from './
|
|
199
|
-
export * from './
|
|
199
|
+
export * from './SecDatasets200Response';
|
|
200
|
+
export * from './SecDocument200Response';
|
|
201
|
+
export * from './SecDocumentFactPlaces200Response';
|
|
202
|
+
export * from './SecDocumentFigure200Response';
|
|
203
|
+
export * from './SecDocumentSections200Response';
|
|
204
|
+
export * from './SecDocumentSections200ResponseSectionsInner';
|
|
205
|
+
export * from './SecFiler200Response';
|
|
206
|
+
export * from './SecFilerCoverage200Response';
|
|
207
|
+
export * from './SecFilerLifecycle200Response';
|
|
208
|
+
export * from './SecFilers200Response';
|
|
209
|
+
export * from './SecFilers200ResponseMatchesInner';
|
|
210
|
+
export * from './SecFiling200Response';
|
|
211
|
+
export * from './SecFilingFacts200Response';
|
|
212
|
+
export * from './SecFilingHoldings200Response';
|
|
213
|
+
export * from './SecFilingReviewChain200Response';
|
|
214
|
+
export * from './SecFilingReviewRelations200Response';
|
|
215
|
+
export * from './SecFilings200Response';
|
|
216
|
+
export * from './SecFilings200ResponseFilingsInner';
|
|
217
|
+
export * from './SecFilings200ResponseFormFacetInner';
|
|
218
|
+
export * from './SecFinancialsCatalog200Response';
|
|
219
|
+
export * from './SecHoldingsHolders200Response';
|
|
220
|
+
export * from './SecIssuers200Response';
|
|
221
|
+
export * from './SecReadiness';
|
|
222
|
+
export * from './SecSearch200Response';
|
|
223
|
+
export * from './SecSearch200ResponseHitsInner';
|
|
224
|
+
export * from './SecSearchCoverage';
|
|
225
|
+
export * from './SecSearchCoverageLexical';
|
|
226
|
+
export * from './SecStoreError';
|
|
200
227
|
export * from './SegmentedFinancials200Response';
|
|
201
228
|
export * from './SegmentedFinancials200ResponseCompaniesInner';
|
|
202
229
|
export * from './SegmentedFinancials200ResponseCompaniesInnerPeriodsInner';
|
|
@@ -1,117 +0,0 @@
|
|
|
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 * as runtime from '../runtime';
|
|
13
|
-
import { type SecFilingsAvailableFormTypes200Response } from '../models/SecFilingsAvailableFormTypes200Response';
|
|
14
|
-
import { type SecFilingsList200Response } from '../models/SecFilingsList200Response';
|
|
15
|
-
import { type SecFilingsSearch200Response } from '../models/SecFilingsSearch200Response';
|
|
16
|
-
import { type SecFilingsSections200Response } from '../models/SecFilingsSections200Response';
|
|
17
|
-
export interface SecFilingsAvailableFormTypesRequest {
|
|
18
|
-
identifier?: string;
|
|
19
|
-
}
|
|
20
|
-
export interface SecFilingsListRequest {
|
|
21
|
-
identifier: string;
|
|
22
|
-
formType?: string;
|
|
23
|
-
sort?: SecFilingsListSortEnum;
|
|
24
|
-
limit?: number;
|
|
25
|
-
offset?: number;
|
|
26
|
-
}
|
|
27
|
-
export interface SecFilingsSearchRequest {
|
|
28
|
-
request: string;
|
|
29
|
-
identifier?: string;
|
|
30
|
-
accessionNumber?: string;
|
|
31
|
-
}
|
|
32
|
-
export interface SecFilingsSectionsRequest {
|
|
33
|
-
identifier: string;
|
|
34
|
-
formType: SecFilingsSectionsFormTypeEnum;
|
|
35
|
-
sectionId?: string;
|
|
36
|
-
accessionNumber?: string;
|
|
37
|
-
fiscalYear?: number;
|
|
38
|
-
fiscalQuarter?: number;
|
|
39
|
-
}
|
|
40
|
-
/**
|
|
41
|
-
*
|
|
42
|
-
*/
|
|
43
|
-
export declare class SECFilingsApi extends runtime.BaseAPI {
|
|
44
|
-
/**
|
|
45
|
-
* Creates request options for secFilingsAvailableFormTypes without sending the request
|
|
46
|
-
*/
|
|
47
|
-
secFilingsAvailableFormTypesRequestOpts(requestParameters: SecFilingsAvailableFormTypesRequest): Promise<runtime.RequestOpts>;
|
|
48
|
-
/**
|
|
49
|
-
* List available SEC filing form types present in the filings table. Optionally filter by a company identifier (ticker or CIK). Minimum tier for display: FREE.
|
|
50
|
-
* Available SEC form types
|
|
51
|
-
*/
|
|
52
|
-
secFilingsAvailableFormTypesRaw(requestParameters: SecFilingsAvailableFormTypesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecFilingsAvailableFormTypes200Response>>;
|
|
53
|
-
/**
|
|
54
|
-
* List available SEC filing form types present in the filings table. Optionally filter by a company identifier (ticker or CIK). Minimum tier for display: FREE.
|
|
55
|
-
* Available SEC form types
|
|
56
|
-
*/
|
|
57
|
-
secFilingsAvailableFormTypes(requestParameters?: SecFilingsAvailableFormTypesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecFilingsAvailableFormTypes200Response>;
|
|
58
|
-
/**
|
|
59
|
-
* Creates request options for secFilingsList without sending the request
|
|
60
|
-
*/
|
|
61
|
-
secFilingsListRequestOpts(requestParameters: SecFilingsListRequest): Promise<runtime.RequestOpts>;
|
|
62
|
-
/**
|
|
63
|
-
* Fetch SEC filings for a company. `identifier` is a ticker or a CIK; a CIK also resolves a company that is not listed yet (a pre-IPO registrant), whose `ticker` is null. Registration statements (S-1, S-1/A, F-1, F-1/A) carry the `proposed_symbols` the prospectus names. Minimum tier for display: FREE.
|
|
64
|
-
* SEC filings
|
|
65
|
-
*/
|
|
66
|
-
secFilingsListRaw(requestParameters: SecFilingsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecFilingsList200Response>>;
|
|
67
|
-
/**
|
|
68
|
-
* Fetch SEC filings for a company. `identifier` is a ticker or a CIK; a CIK also resolves a company that is not listed yet (a pre-IPO registrant), whose `ticker` is null. Registration statements (S-1, S-1/A, F-1, F-1/A) carry the `proposed_symbols` the prospectus names. Minimum tier for display: FREE.
|
|
69
|
-
* SEC filings
|
|
70
|
-
*/
|
|
71
|
-
secFilingsList(requestParameters: SecFilingsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecFilingsList200Response>;
|
|
72
|
-
/**
|
|
73
|
-
* Creates request options for secFilingsSearch without sending the request
|
|
74
|
-
*/
|
|
75
|
-
secFilingsSearchRequestOpts(requestParameters: SecFilingsSearchRequest): Promise<runtime.RequestOpts>;
|
|
76
|
-
/**
|
|
77
|
-
* Search SEC filings using natural language queries. Returns AI-generated answers with source citations from official SEC documents (10-K, 10-Q, 8-K). Minimum tier for rag: STANDARD.
|
|
78
|
-
* Search SEC filings
|
|
79
|
-
*/
|
|
80
|
-
secFilingsSearchRaw(requestParameters: SecFilingsSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecFilingsSearch200Response>>;
|
|
81
|
-
/**
|
|
82
|
-
* Search SEC filings using natural language queries. Returns AI-generated answers with source citations from official SEC documents (10-K, 10-Q, 8-K). Minimum tier for rag: STANDARD.
|
|
83
|
-
* Search SEC filings
|
|
84
|
-
*/
|
|
85
|
-
secFilingsSearch(requestParameters: SecFilingsSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecFilingsSearch200Response>;
|
|
86
|
-
/**
|
|
87
|
-
* Creates request options for secFilingsSections without sending the request
|
|
88
|
-
*/
|
|
89
|
-
secFilingsSectionsRequestOpts(requestParameters: SecFilingsSectionsRequest): Promise<runtime.RequestOpts>;
|
|
90
|
-
/**
|
|
91
|
-
* Fetch SEC filing sections for a company. Returns parsed sections from 10-Q, 10-K, or 8-K filings. Minimum tier for rag: STANDARD.
|
|
92
|
-
* SEC filing sections
|
|
93
|
-
*/
|
|
94
|
-
secFilingsSectionsRaw(requestParameters: SecFilingsSectionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SecFilingsSections200Response>>;
|
|
95
|
-
/**
|
|
96
|
-
* Fetch SEC filing sections for a company. Returns parsed sections from 10-Q, 10-K, or 8-K filings. Minimum tier for rag: STANDARD.
|
|
97
|
-
* SEC filing sections
|
|
98
|
-
*/
|
|
99
|
-
secFilingsSections(requestParameters: SecFilingsSectionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecFilingsSections200Response>;
|
|
100
|
-
}
|
|
101
|
-
/**
|
|
102
|
-
* @export
|
|
103
|
-
*/
|
|
104
|
-
export declare const SecFilingsListSortEnum: {
|
|
105
|
-
readonly Asc: "asc";
|
|
106
|
-
readonly Desc: "desc";
|
|
107
|
-
};
|
|
108
|
-
export type SecFilingsListSortEnum = typeof SecFilingsListSortEnum[keyof typeof SecFilingsListSortEnum];
|
|
109
|
-
/**
|
|
110
|
-
* @export
|
|
111
|
-
*/
|
|
112
|
-
export declare const SecFilingsSectionsFormTypeEnum: {
|
|
113
|
-
readonly _10Q: "10-Q";
|
|
114
|
-
readonly _10K: "10-K";
|
|
115
|
-
readonly _8K: "8-K";
|
|
116
|
-
};
|
|
117
|
-
export type SecFilingsSectionsFormTypeEnum = typeof SecFilingsSectionsFormTypeEnum[keyof typeof SecFilingsSectionsFormTypeEnum];
|