@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,109 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Invinite API
|
|
5
|
+
* Invinite financial data API. Each endpoint has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Included-Remaining` what is left of the plan\'s included credits. `GET /v1/account/usage` returns your account\'s usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost. **Coverage.** Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/company/available-companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the CIKs it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `ping` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `ping` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: Issuer and SEC text is served in full with its attribution; the licensee shows publisher, source URL and date next to it and may forward it unmodified; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs reproduce issuer or SEC text under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/account/usage` serves no licensed data and carries none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
import type { SecReadiness } from './SecReadiness';
|
|
17
|
+
import {
|
|
18
|
+
SecReadinessFromJSON,
|
|
19
|
+
SecReadinessFromJSONTyped,
|
|
20
|
+
SecReadinessToJSON,
|
|
21
|
+
SecReadinessToJSONTyped,
|
|
22
|
+
} from './SecReadiness';
|
|
23
|
+
import type { SecFilers200ResponseMatchesInner } from './SecFilers200ResponseMatchesInner';
|
|
24
|
+
import {
|
|
25
|
+
SecFilers200ResponseMatchesInnerFromJSON,
|
|
26
|
+
SecFilers200ResponseMatchesInnerFromJSONTyped,
|
|
27
|
+
SecFilers200ResponseMatchesInnerToJSON,
|
|
28
|
+
SecFilers200ResponseMatchesInnerToJSONTyped,
|
|
29
|
+
} from './SecFilers200ResponseMatchesInner';
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
* Filers matching the filters, name order
|
|
33
|
+
* @export
|
|
34
|
+
* @interface SecFilers200Response
|
|
35
|
+
*/
|
|
36
|
+
export interface SecFilers200Response {
|
|
37
|
+
[key: string]: any | any;
|
|
38
|
+
/**
|
|
39
|
+
* The backend contract version (`secdoors.v1`)
|
|
40
|
+
* @type {string}
|
|
41
|
+
* @memberof SecFilers200Response
|
|
42
|
+
*/
|
|
43
|
+
api_schema: string;
|
|
44
|
+
/**
|
|
45
|
+
* Limit
|
|
46
|
+
* @type {number}
|
|
47
|
+
* @memberof SecFilers200Response
|
|
48
|
+
*/
|
|
49
|
+
limit?: number;
|
|
50
|
+
/**
|
|
51
|
+
* Matching filers
|
|
52
|
+
* @type {Array<SecFilers200ResponseMatchesInner>}
|
|
53
|
+
* @memberof SecFilers200Response
|
|
54
|
+
*/
|
|
55
|
+
matches?: Array<SecFilers200ResponseMatchesInner>;
|
|
56
|
+
/**
|
|
57
|
+
*
|
|
58
|
+
* @type {SecReadiness}
|
|
59
|
+
* @memberof SecFilers200Response
|
|
60
|
+
*/
|
|
61
|
+
readiness: SecReadiness;
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
/**
|
|
65
|
+
* Check if a given object implements the SecFilers200Response interface.
|
|
66
|
+
*/
|
|
67
|
+
export function instanceOfSecFilers200Response(value: object): value is SecFilers200Response {
|
|
68
|
+
if (!('api_schema' in value) || value['api_schema'] === undefined) return false;
|
|
69
|
+
if (!('readiness' in value) || value['readiness'] === undefined) return false;
|
|
70
|
+
return true;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
export function SecFilers200ResponseFromJSON(json: any): SecFilers200Response {
|
|
74
|
+
return SecFilers200ResponseFromJSONTyped(json, false);
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
export function SecFilers200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecFilers200Response {
|
|
78
|
+
if (json == null) {
|
|
79
|
+
return json;
|
|
80
|
+
}
|
|
81
|
+
return {
|
|
82
|
+
|
|
83
|
+
...json,
|
|
84
|
+
'api_schema': json['api_schema'],
|
|
85
|
+
'limit': json['limit'] == null ? undefined : json['limit'],
|
|
86
|
+
'matches': json['matches'] == null ? undefined : ((json['matches'] as Array<any>).map(SecFilers200ResponseMatchesInnerFromJSON)),
|
|
87
|
+
'readiness': SecReadinessFromJSON(json['readiness']),
|
|
88
|
+
};
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
export function SecFilers200ResponseToJSON(json: any): SecFilers200Response {
|
|
92
|
+
return SecFilers200ResponseToJSONTyped(json, false);
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
export function SecFilers200ResponseToJSONTyped(value?: SecFilers200Response | null, ignoreDiscriminator: boolean = false): any {
|
|
96
|
+
if (value == null) {
|
|
97
|
+
return value;
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
return {
|
|
101
|
+
|
|
102
|
+
...value,
|
|
103
|
+
'api_schema': value['api_schema'],
|
|
104
|
+
'limit': value['limit'],
|
|
105
|
+
'matches': value['matches'] == null ? undefined : ((value['matches'] as Array<any>).map(SecFilers200ResponseMatchesInnerToJSON)),
|
|
106
|
+
'readiness': SecReadinessToJSON(value['readiness']),
|
|
107
|
+
};
|
|
108
|
+
}
|
|
109
|
+
|
|
@@ -0,0 +1,108 @@
|
|
|
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
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface SecFilers200ResponseMatchesInner
|
|
20
|
+
*/
|
|
21
|
+
export interface SecFilers200ResponseMatchesInner {
|
|
22
|
+
[key: string]: any | any;
|
|
23
|
+
/**
|
|
24
|
+
* CIK (no zero padding)
|
|
25
|
+
* @type {string}
|
|
26
|
+
* @memberof SecFilers200ResponseMatchesInner
|
|
27
|
+
*/
|
|
28
|
+
cik?: string;
|
|
29
|
+
/**
|
|
30
|
+
* Current SEC name
|
|
31
|
+
* @type {string}
|
|
32
|
+
* @memberof SecFilers200ResponseMatchesInner
|
|
33
|
+
*/
|
|
34
|
+
name?: string | null;
|
|
35
|
+
/**
|
|
36
|
+
* SEC entity type
|
|
37
|
+
* @type {string}
|
|
38
|
+
* @memberof SecFilers200ResponseMatchesInner
|
|
39
|
+
*/
|
|
40
|
+
entity_type?: string | null;
|
|
41
|
+
/**
|
|
42
|
+
* SIC code
|
|
43
|
+
* @type {string}
|
|
44
|
+
* @memberof SecFilers200ResponseMatchesInner
|
|
45
|
+
*/
|
|
46
|
+
sic?: string | null;
|
|
47
|
+
/**
|
|
48
|
+
* Tickers the filer states (evidence, not a listing)
|
|
49
|
+
* @type {Array<string>}
|
|
50
|
+
* @memberof SecFilers200ResponseMatchesInner
|
|
51
|
+
*/
|
|
52
|
+
stated_tickers?: Array<string>;
|
|
53
|
+
/**
|
|
54
|
+
* What the store serves for this filer
|
|
55
|
+
* @type {{ [key: string]: any; }}
|
|
56
|
+
* @memberof SecFilers200ResponseMatchesInner
|
|
57
|
+
*/
|
|
58
|
+
scope?: { [key: string]: any; };
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
/**
|
|
62
|
+
* Check if a given object implements the SecFilers200ResponseMatchesInner interface.
|
|
63
|
+
*/
|
|
64
|
+
export function instanceOfSecFilers200ResponseMatchesInner(value: object): value is SecFilers200ResponseMatchesInner {
|
|
65
|
+
return true;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
export function SecFilers200ResponseMatchesInnerFromJSON(json: any): SecFilers200ResponseMatchesInner {
|
|
69
|
+
return SecFilers200ResponseMatchesInnerFromJSONTyped(json, false);
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
export function SecFilers200ResponseMatchesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecFilers200ResponseMatchesInner {
|
|
73
|
+
if (json == null) {
|
|
74
|
+
return json;
|
|
75
|
+
}
|
|
76
|
+
return {
|
|
77
|
+
|
|
78
|
+
...json,
|
|
79
|
+
'cik': json['cik'] == null ? undefined : json['cik'],
|
|
80
|
+
'name': json['name'] == null ? undefined : json['name'],
|
|
81
|
+
'entity_type': json['entity_type'] == null ? undefined : json['entity_type'],
|
|
82
|
+
'sic': json['sic'] == null ? undefined : json['sic'],
|
|
83
|
+
'stated_tickers': json['stated_tickers'] == null ? undefined : json['stated_tickers'],
|
|
84
|
+
'scope': json['scope'] == null ? undefined : json['scope'],
|
|
85
|
+
};
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
export function SecFilers200ResponseMatchesInnerToJSON(json: any): SecFilers200ResponseMatchesInner {
|
|
89
|
+
return SecFilers200ResponseMatchesInnerToJSONTyped(json, false);
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
export function SecFilers200ResponseMatchesInnerToJSONTyped(value?: SecFilers200ResponseMatchesInner | null, ignoreDiscriminator: boolean = false): any {
|
|
93
|
+
if (value == null) {
|
|
94
|
+
return value;
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
return {
|
|
98
|
+
|
|
99
|
+
...value,
|
|
100
|
+
'cik': value['cik'],
|
|
101
|
+
'name': value['name'],
|
|
102
|
+
'entity_type': value['entity_type'],
|
|
103
|
+
'sic': value['sic'],
|
|
104
|
+
'stated_tickers': value['stated_tickers'],
|
|
105
|
+
'scope': value['scope'],
|
|
106
|
+
};
|
|
107
|
+
}
|
|
108
|
+
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Invinite API
|
|
5
|
+
* Invinite financial data API. Each endpoint has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Included-Remaining` what is left of the plan\'s included credits. `GET /v1/account/usage` returns your account\'s usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost. **Coverage.** Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/company/available-companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the CIKs it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `ping` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `ping` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: Issuer and SEC text is served in full with its attribution; the licensee shows publisher, source URL and date next to it and may forward it unmodified; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs reproduce issuer or SEC text under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/account/usage` serves no licensed data and carries none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
import type { SecReadiness } from './SecReadiness';
|
|
17
|
+
import {
|
|
18
|
+
SecReadinessFromJSON,
|
|
19
|
+
SecReadinessFromJSONTyped,
|
|
20
|
+
SecReadinessToJSON,
|
|
21
|
+
SecReadinessToJSONTyped,
|
|
22
|
+
} from './SecReadiness';
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* One filing's document manifest
|
|
26
|
+
* @export
|
|
27
|
+
* @interface SecFiling200Response
|
|
28
|
+
*/
|
|
29
|
+
export interface SecFiling200Response {
|
|
30
|
+
[key: string]: any | any;
|
|
31
|
+
/**
|
|
32
|
+
* The backend contract version (`secdoors.v1`)
|
|
33
|
+
* @type {string}
|
|
34
|
+
* @memberof SecFiling200Response
|
|
35
|
+
*/
|
|
36
|
+
api_schema: string;
|
|
37
|
+
/**
|
|
38
|
+
* Documents
|
|
39
|
+
* @type {Array<{ [key: string]: any; }>}
|
|
40
|
+
* @memberof SecFiling200Response
|
|
41
|
+
*/
|
|
42
|
+
documents?: Array<{ [key: string]: any; }>;
|
|
43
|
+
/**
|
|
44
|
+
* Filing
|
|
45
|
+
* @type {{ [key: string]: any; }}
|
|
46
|
+
* @memberof SecFiling200Response
|
|
47
|
+
*/
|
|
48
|
+
filing?: { [key: string]: any; } | null;
|
|
49
|
+
/**
|
|
50
|
+
* Parties
|
|
51
|
+
* @type {Array<{ [key: string]: any; }>}
|
|
52
|
+
* @memberof SecFiling200Response
|
|
53
|
+
*/
|
|
54
|
+
parties?: Array<{ [key: string]: any; }>;
|
|
55
|
+
/**
|
|
56
|
+
*
|
|
57
|
+
* @type {SecReadiness}
|
|
58
|
+
* @memberof SecFiling200Response
|
|
59
|
+
*/
|
|
60
|
+
readiness: SecReadiness;
|
|
61
|
+
/**
|
|
62
|
+
* Recovery
|
|
63
|
+
* @type {{ [key: string]: any; }}
|
|
64
|
+
* @memberof SecFiling200Response
|
|
65
|
+
*/
|
|
66
|
+
recovery?: { [key: string]: any; } | null;
|
|
67
|
+
/**
|
|
68
|
+
* Relations
|
|
69
|
+
* @type {Array<{ [key: string]: any; }>}
|
|
70
|
+
* @memberof SecFiling200Response
|
|
71
|
+
*/
|
|
72
|
+
relations?: Array<{ [key: string]: any; }>;
|
|
73
|
+
/**
|
|
74
|
+
* Source
|
|
75
|
+
* @type {{ [key: string]: any; }}
|
|
76
|
+
* @memberof SecFiling200Response
|
|
77
|
+
*/
|
|
78
|
+
source?: { [key: string]: any; } | null;
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
/**
|
|
82
|
+
* Check if a given object implements the SecFiling200Response interface.
|
|
83
|
+
*/
|
|
84
|
+
export function instanceOfSecFiling200Response(value: object): value is SecFiling200Response {
|
|
85
|
+
if (!('api_schema' in value) || value['api_schema'] === undefined) return false;
|
|
86
|
+
if (!('readiness' in value) || value['readiness'] === undefined) return false;
|
|
87
|
+
return true;
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
export function SecFiling200ResponseFromJSON(json: any): SecFiling200Response {
|
|
91
|
+
return SecFiling200ResponseFromJSONTyped(json, false);
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
export function SecFiling200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecFiling200Response {
|
|
95
|
+
if (json == null) {
|
|
96
|
+
return json;
|
|
97
|
+
}
|
|
98
|
+
return {
|
|
99
|
+
|
|
100
|
+
...json,
|
|
101
|
+
'api_schema': json['api_schema'],
|
|
102
|
+
'documents': json['documents'] == null ? undefined : json['documents'],
|
|
103
|
+
'filing': json['filing'] == null ? undefined : json['filing'],
|
|
104
|
+
'parties': json['parties'] == null ? undefined : json['parties'],
|
|
105
|
+
'readiness': SecReadinessFromJSON(json['readiness']),
|
|
106
|
+
'recovery': json['recovery'] == null ? undefined : json['recovery'],
|
|
107
|
+
'relations': json['relations'] == null ? undefined : json['relations'],
|
|
108
|
+
'source': json['source'] == null ? undefined : json['source'],
|
|
109
|
+
};
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
export function SecFiling200ResponseToJSON(json: any): SecFiling200Response {
|
|
113
|
+
return SecFiling200ResponseToJSONTyped(json, false);
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
export function SecFiling200ResponseToJSONTyped(value?: SecFiling200Response | null, ignoreDiscriminator: boolean = false): any {
|
|
117
|
+
if (value == null) {
|
|
118
|
+
return value;
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
return {
|
|
122
|
+
|
|
123
|
+
...value,
|
|
124
|
+
'api_schema': value['api_schema'],
|
|
125
|
+
'documents': value['documents'],
|
|
126
|
+
'filing': value['filing'],
|
|
127
|
+
'parties': value['parties'],
|
|
128
|
+
'readiness': SecReadinessToJSON(value['readiness']),
|
|
129
|
+
'recovery': value['recovery'],
|
|
130
|
+
'relations': value['relations'],
|
|
131
|
+
'source': value['source'],
|
|
132
|
+
};
|
|
133
|
+
}
|
|
134
|
+
|
|
@@ -0,0 +1,110 @@
|
|
|
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
|
+
* Dataset facts of one filing
|
|
26
|
+
* @export
|
|
27
|
+
* @interface SecFilingFacts200Response
|
|
28
|
+
*/
|
|
29
|
+
export interface SecFilingFacts200Response {
|
|
30
|
+
[key: string]: any | any;
|
|
31
|
+
/**
|
|
32
|
+
* Accession
|
|
33
|
+
* @type {string}
|
|
34
|
+
* @memberof SecFilingFacts200Response
|
|
35
|
+
*/
|
|
36
|
+
accession?: string;
|
|
37
|
+
/**
|
|
38
|
+
* The backend contract version (`secdoors.v1`)
|
|
39
|
+
* @type {string}
|
|
40
|
+
* @memberof SecFilingFacts200Response
|
|
41
|
+
*/
|
|
42
|
+
api_schema: string;
|
|
43
|
+
/**
|
|
44
|
+
* Datasetfacts
|
|
45
|
+
* @type {Array<{ [key: string]: any; }>}
|
|
46
|
+
* @memberof SecFilingFacts200Response
|
|
47
|
+
*/
|
|
48
|
+
dataset_facts?: Array<{ [key: string]: any; }>;
|
|
49
|
+
/**
|
|
50
|
+
*
|
|
51
|
+
* @type {SecReadiness}
|
|
52
|
+
* @memberof SecFilingFacts200Response
|
|
53
|
+
*/
|
|
54
|
+
readiness: SecReadiness;
|
|
55
|
+
/**
|
|
56
|
+
* Release
|
|
57
|
+
* @type {{ [key: string]: any; }}
|
|
58
|
+
* @memberof SecFilingFacts200Response
|
|
59
|
+
*/
|
|
60
|
+
release?: { [key: string]: any; } | null;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
/**
|
|
64
|
+
* Check if a given object implements the SecFilingFacts200Response interface.
|
|
65
|
+
*/
|
|
66
|
+
export function instanceOfSecFilingFacts200Response(value: object): value is SecFilingFacts200Response {
|
|
67
|
+
if (!('api_schema' in value) || value['api_schema'] === undefined) return false;
|
|
68
|
+
if (!('readiness' in value) || value['readiness'] === undefined) return false;
|
|
69
|
+
return true;
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
export function SecFilingFacts200ResponseFromJSON(json: any): SecFilingFacts200Response {
|
|
73
|
+
return SecFilingFacts200ResponseFromJSONTyped(json, false);
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
export function SecFilingFacts200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecFilingFacts200Response {
|
|
77
|
+
if (json == null) {
|
|
78
|
+
return json;
|
|
79
|
+
}
|
|
80
|
+
return {
|
|
81
|
+
|
|
82
|
+
...json,
|
|
83
|
+
'accession': json['accession'] == null ? undefined : json['accession'],
|
|
84
|
+
'api_schema': json['api_schema'],
|
|
85
|
+
'dataset_facts': json['dataset_facts'] == null ? undefined : json['dataset_facts'],
|
|
86
|
+
'readiness': SecReadinessFromJSON(json['readiness']),
|
|
87
|
+
'release': json['release'] == null ? undefined : json['release'],
|
|
88
|
+
};
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
export function SecFilingFacts200ResponseToJSON(json: any): SecFilingFacts200Response {
|
|
92
|
+
return SecFilingFacts200ResponseToJSONTyped(json, false);
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
export function SecFilingFacts200ResponseToJSONTyped(value?: SecFilingFacts200Response | null, ignoreDiscriminator: boolean = false): any {
|
|
96
|
+
if (value == null) {
|
|
97
|
+
return value;
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
return {
|
|
101
|
+
|
|
102
|
+
...value,
|
|
103
|
+
'accession': value['accession'],
|
|
104
|
+
'api_schema': value['api_schema'],
|
|
105
|
+
'dataset_facts': value['dataset_facts'],
|
|
106
|
+
'readiness': SecReadinessToJSON(value['readiness']),
|
|
107
|
+
'release': value['release'],
|
|
108
|
+
};
|
|
109
|
+
}
|
|
110
|
+
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Invinite API
|
|
5
|
+
* Invinite financial data API. Each endpoint has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Included-Remaining` what is left of the plan\'s included credits. `GET /v1/account/usage` returns your account\'s usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost. **Coverage.** Financial data covers SEC registrants and US listings; a foreign suffix (`SAP.DE`, `VOD.L`) or a crypto pair (`X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/company/available-companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the CIKs it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `ping` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `ping` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: Issuer and SEC text is served in full with its attribution; the licensee shows publisher, source URL and date next to it and may forward it unmodified; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs reproduce issuer or SEC text under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/account/usage` serves no licensed data and carries none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
import type { SecReadiness } from './SecReadiness';
|
|
17
|
+
import {
|
|
18
|
+
SecReadinessFromJSON,
|
|
19
|
+
SecReadinessFromJSONTyped,
|
|
20
|
+
SecReadinessToJSON,
|
|
21
|
+
SecReadinessToJSONTyped,
|
|
22
|
+
} from './SecReadiness';
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* One page of a 13F information table
|
|
26
|
+
* @export
|
|
27
|
+
* @interface SecFilingHoldings200Response
|
|
28
|
+
*/
|
|
29
|
+
export interface SecFilingHoldings200Response {
|
|
30
|
+
[key: string]: any | any;
|
|
31
|
+
/**
|
|
32
|
+
* Accession
|
|
33
|
+
* @type {string}
|
|
34
|
+
* @memberof SecFilingHoldings200Response
|
|
35
|
+
*/
|
|
36
|
+
accession?: string;
|
|
37
|
+
/**
|
|
38
|
+
* The backend contract version (`secdoors.v1`)
|
|
39
|
+
* @type {string}
|
|
40
|
+
* @memberof SecFilingHoldings200Response
|
|
41
|
+
*/
|
|
42
|
+
api_schema: string;
|
|
43
|
+
/**
|
|
44
|
+
* Nextafter
|
|
45
|
+
* @type {number}
|
|
46
|
+
* @memberof SecFilingHoldings200Response
|
|
47
|
+
*/
|
|
48
|
+
next_after?: number | null;
|
|
49
|
+
/**
|
|
50
|
+
*
|
|
51
|
+
* @type {SecReadiness}
|
|
52
|
+
* @memberof SecFilingHoldings200Response
|
|
53
|
+
*/
|
|
54
|
+
readiness: SecReadiness;
|
|
55
|
+
/**
|
|
56
|
+
* Rows
|
|
57
|
+
* @type {Array<{ [key: string]: any; }>}
|
|
58
|
+
* @memberof SecFilingHoldings200Response
|
|
59
|
+
*/
|
|
60
|
+
rows?: Array<{ [key: string]: any; }>;
|
|
61
|
+
/**
|
|
62
|
+
* Summary
|
|
63
|
+
* @type {{ [key: string]: any; }}
|
|
64
|
+
* @memberof SecFilingHoldings200Response
|
|
65
|
+
*/
|
|
66
|
+
summary?: { [key: string]: any; } | null;
|
|
67
|
+
/**
|
|
68
|
+
* URL of the next page (same filters, the next cursor). Omitted on the last page.
|
|
69
|
+
* @type {string}
|
|
70
|
+
* @memberof SecFilingHoldings200Response
|
|
71
|
+
*/
|
|
72
|
+
next_url?: string;
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
/**
|
|
76
|
+
* Check if a given object implements the SecFilingHoldings200Response interface.
|
|
77
|
+
*/
|
|
78
|
+
export function instanceOfSecFilingHoldings200Response(value: object): value is SecFilingHoldings200Response {
|
|
79
|
+
if (!('api_schema' in value) || value['api_schema'] === undefined) return false;
|
|
80
|
+
if (!('readiness' in value) || value['readiness'] === undefined) return false;
|
|
81
|
+
return true;
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
export function SecFilingHoldings200ResponseFromJSON(json: any): SecFilingHoldings200Response {
|
|
85
|
+
return SecFilingHoldings200ResponseFromJSONTyped(json, false);
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
export function SecFilingHoldings200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SecFilingHoldings200Response {
|
|
89
|
+
if (json == null) {
|
|
90
|
+
return json;
|
|
91
|
+
}
|
|
92
|
+
return {
|
|
93
|
+
|
|
94
|
+
...json,
|
|
95
|
+
'accession': json['accession'] == null ? undefined : json['accession'],
|
|
96
|
+
'api_schema': json['api_schema'],
|
|
97
|
+
'next_after': json['next_after'] == null ? undefined : json['next_after'],
|
|
98
|
+
'readiness': SecReadinessFromJSON(json['readiness']),
|
|
99
|
+
'rows': json['rows'] == null ? undefined : json['rows'],
|
|
100
|
+
'summary': json['summary'] == null ? undefined : json['summary'],
|
|
101
|
+
'next_url': json['next_url'] == null ? undefined : json['next_url'],
|
|
102
|
+
};
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
export function SecFilingHoldings200ResponseToJSON(json: any): SecFilingHoldings200Response {
|
|
106
|
+
return SecFilingHoldings200ResponseToJSONTyped(json, false);
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
export function SecFilingHoldings200ResponseToJSONTyped(value?: SecFilingHoldings200Response | null, ignoreDiscriminator: boolean = false): any {
|
|
110
|
+
if (value == null) {
|
|
111
|
+
return value;
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
return {
|
|
115
|
+
|
|
116
|
+
...value,
|
|
117
|
+
'accession': value['accession'],
|
|
118
|
+
'api_schema': value['api_schema'],
|
|
119
|
+
'next_after': value['next_after'],
|
|
120
|
+
'readiness': SecReadinessToJSON(value['readiness']),
|
|
121
|
+
'rows': value['rows'],
|
|
122
|
+
'summary': value['summary'],
|
|
123
|
+
'next_url': value['next_url'],
|
|
124
|
+
};
|
|
125
|
+
}
|
|
126
|
+
|