@invinite-org/data-api-client 0.10.1 → 1.1.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 +77 -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/IposRegistrationsList200ResponseRegistrationsInnerIpoPending.js +83 -0
- 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/esm/models/SecFilerLifecycle200Response.d.ts +146 -0
- 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 +74 -0
- package/dist/esm/models/SecSearchCoverage.js +53 -0
- package/dist/esm/models/SecSearchCoverageLexical.d.ts +51 -0
- package/dist/esm/models/{SecFilingsAvailableFormTypes200Response.js → SecSearchCoverageLexical.js} +10 -16
- package/dist/{models/SecFilingsList200ResponseCompaniesInnerFilingsInner.d.ts → esm/models/SecSearchCoverageMatches.d.ts} +52 -51
- package/dist/esm/models/SecSearchCoverageMatches.js +65 -0
- 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 +37 -9
- package/dist/esm/models/index.js +37 -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/SecFilerCoverage200Response.js +49 -0
- package/dist/models/SecFilerLifecycle200Response.d.ts +146 -0
- 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 +74 -0
- package/dist/models/{SecFilingsSearch200ResponseSourcesInner.js → SecSearchCoverage.js} +29 -38
- package/dist/models/SecSearchCoverageLexical.d.ts +51 -0
- package/dist/models/{SecFilingsList200Response.js → SecSearchCoverageLexical.js} +15 -22
- package/dist/{esm/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.d.ts → models/SecSearchCoverageMatches.d.ts} +52 -51
- package/dist/{esm/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.js → models/SecSearchCoverageMatches.js} +35 -46
- 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 +37 -9
- package/dist/models/index.js +37 -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 +45 -0
- package/docs/{SecFilingsSearch200Response.md → SecSearchCoverageLexical.md} +13 -8
- package/docs/SecSearchCoverageMatches.md +53 -0
- 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/SecFilerLifecycle200Response.ts +198 -0
- 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 +138 -0
- package/src/models/{SecFilingsList200Response.ts → SecSearchCoverageLexical.ts} +44 -26
- package/src/models/{SecFilingsList200ResponseCompaniesInnerFilingsInner.ts → SecSearchCoverageMatches.ts} +91 -93
- package/src/models/SecStoreError.ts +102 -0
- package/src/models/WebSocketFiling.ts +1 -1
- package/src/models/index.ts +37 -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,51 @@
|
|
|
1
|
+
|
|
2
|
+
# SecFilingReviewChain200Response
|
|
3
|
+
|
|
4
|
+
One filing\'s review graph
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`accession` | string
|
|
11
|
+
`api_schema` | string
|
|
12
|
+
`completeness` | { [key: string]: any; }
|
|
13
|
+
`edges` | Array<{ [key: string]: any; }>
|
|
14
|
+
`nodes` | Array<{ [key: string]: any; }>
|
|
15
|
+
`provider` | { [key: string]: any; }
|
|
16
|
+
`readiness` | [SecReadiness](SecReadiness.md)
|
|
17
|
+
`resolver_version` | string
|
|
18
|
+
`twins` | Array<{ [key: string]: any; }>
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import type { SecFilingReviewChain200Response } from '@invinite-org/data-api-client'
|
|
24
|
+
|
|
25
|
+
// TODO: Update the object below with actual values
|
|
26
|
+
const example = {
|
|
27
|
+
"accession": null,
|
|
28
|
+
"api_schema": null,
|
|
29
|
+
"completeness": null,
|
|
30
|
+
"edges": null,
|
|
31
|
+
"nodes": null,
|
|
32
|
+
"provider": null,
|
|
33
|
+
"readiness": null,
|
|
34
|
+
"resolver_version": null,
|
|
35
|
+
"twins": null,
|
|
36
|
+
} satisfies SecFilingReviewChain200Response
|
|
37
|
+
|
|
38
|
+
console.log(example)
|
|
39
|
+
|
|
40
|
+
// Convert the instance to a JSON string
|
|
41
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
42
|
+
console.log(exampleJSON)
|
|
43
|
+
|
|
44
|
+
// Parse the JSON string back to an object
|
|
45
|
+
const exampleParsed = JSON.parse(exampleJSON) as SecFilingReviewChain200Response
|
|
46
|
+
console.log(exampleParsed)
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
50
|
+
|
|
51
|
+
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
|
|
2
|
+
# SecFilingReviewRelations200Response
|
|
3
|
+
|
|
4
|
+
One page of review relations
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`accession` | string
|
|
11
|
+
`api_schema` | string
|
|
12
|
+
`next_cursor` | string
|
|
13
|
+
`provider` | { [key: string]: any; }
|
|
14
|
+
`readiness` | [SecReadiness](SecReadiness.md)
|
|
15
|
+
`relations` | Array<{ [key: string]: any; }>
|
|
16
|
+
`resolution` | { [key: string]: any; }
|
|
17
|
+
`resolver_version` | string
|
|
18
|
+
`next_url` | string
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import type { SecFilingReviewRelations200Response } from '@invinite-org/data-api-client'
|
|
24
|
+
|
|
25
|
+
// TODO: Update the object below with actual values
|
|
26
|
+
const example = {
|
|
27
|
+
"accession": null,
|
|
28
|
+
"api_schema": null,
|
|
29
|
+
"next_cursor": null,
|
|
30
|
+
"provider": null,
|
|
31
|
+
"readiness": null,
|
|
32
|
+
"relations": null,
|
|
33
|
+
"resolution": null,
|
|
34
|
+
"resolver_version": null,
|
|
35
|
+
"next_url": null,
|
|
36
|
+
} satisfies SecFilingReviewRelations200Response
|
|
37
|
+
|
|
38
|
+
console.log(example)
|
|
39
|
+
|
|
40
|
+
// Convert the instance to a JSON string
|
|
41
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
42
|
+
console.log(exampleJSON)
|
|
43
|
+
|
|
44
|
+
// Parse the JSON string back to an object
|
|
45
|
+
const exampleParsed = JSON.parse(exampleJSON) as SecFilingReviewRelations200Response
|
|
46
|
+
console.log(exampleParsed)
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
50
|
+
|
|
51
|
+
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
|
|
2
|
+
# SecFilings200Response
|
|
3
|
+
|
|
4
|
+
One page of a filer\'s filings
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`api_schema` | string
|
|
11
|
+
`cik` | string
|
|
12
|
+
`filer` | { [key: string]: any; }
|
|
13
|
+
`filings` | [Array<SecFilings200ResponseFilingsInner>](SecFilings200ResponseFilingsInner.md)
|
|
14
|
+
`form_facet` | [Array<SecFilings200ResponseFormFacetInner>](SecFilings200ResponseFormFacetInner.md)
|
|
15
|
+
`next_cursor` | string
|
|
16
|
+
`readiness` | [SecReadiness](SecReadiness.md)
|
|
17
|
+
`withheld` | { [key: string]: any; }
|
|
18
|
+
`next_url` | string
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import type { SecFilings200Response } from '@invinite-org/data-api-client'
|
|
24
|
+
|
|
25
|
+
// TODO: Update the object below with actual values
|
|
26
|
+
const example = {
|
|
27
|
+
"api_schema": null,
|
|
28
|
+
"cik": null,
|
|
29
|
+
"filer": null,
|
|
30
|
+
"filings": null,
|
|
31
|
+
"form_facet": null,
|
|
32
|
+
"next_cursor": null,
|
|
33
|
+
"readiness": null,
|
|
34
|
+
"withheld": null,
|
|
35
|
+
"next_url": null,
|
|
36
|
+
} satisfies SecFilings200Response
|
|
37
|
+
|
|
38
|
+
console.log(example)
|
|
39
|
+
|
|
40
|
+
// Convert the instance to a JSON string
|
|
41
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
42
|
+
console.log(exampleJSON)
|
|
43
|
+
|
|
44
|
+
// Parse the JSON string back to an object
|
|
45
|
+
const exampleParsed = JSON.parse(exampleJSON) as SecFilings200Response
|
|
46
|
+
console.log(exampleParsed)
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
50
|
+
|
|
51
|
+
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
|
|
2
|
+
# SecFilings200ResponseFilingsInner
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`accession` | string
|
|
10
|
+
`form` | string
|
|
11
|
+
`filing_date` | Date
|
|
12
|
+
`report_date` | Date
|
|
13
|
+
`accepted_at` | Date
|
|
14
|
+
`items` | Array<string>
|
|
15
|
+
`primary_document` | string
|
|
16
|
+
`roles` | Array<string>
|
|
17
|
+
`edgar_index_url` | string
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import type { SecFilings200ResponseFilingsInner } from '@invinite-org/data-api-client'
|
|
23
|
+
|
|
24
|
+
// TODO: Update the object below with actual values
|
|
25
|
+
const example = {
|
|
26
|
+
"accession": null,
|
|
27
|
+
"form": null,
|
|
28
|
+
"filing_date": null,
|
|
29
|
+
"report_date": null,
|
|
30
|
+
"accepted_at": null,
|
|
31
|
+
"items": null,
|
|
32
|
+
"primary_document": null,
|
|
33
|
+
"roles": null,
|
|
34
|
+
"edgar_index_url": null,
|
|
35
|
+
} satisfies SecFilings200ResponseFilingsInner
|
|
36
|
+
|
|
37
|
+
console.log(example)
|
|
38
|
+
|
|
39
|
+
// Convert the instance to a JSON string
|
|
40
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
41
|
+
console.log(exampleJSON)
|
|
42
|
+
|
|
43
|
+
// Parse the JSON string back to an object
|
|
44
|
+
const exampleParsed = JSON.parse(exampleJSON) as SecFilings200ResponseFilingsInner
|
|
45
|
+
console.log(exampleParsed)
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
49
|
+
|
|
50
|
+
|
package/docs/{SecFilingsAvailableFormTypes200Response.md → SecFilings200ResponseFormFacetInner.md}
RENAMED
|
@@ -1,22 +1,26 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# SecFilings200ResponseFormFacetInner
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`
|
|
9
|
+
`form` | string
|
|
10
|
+
`count` | number
|
|
11
|
+
`newest_filing_date` | Date
|
|
10
12
|
|
|
11
13
|
## Example
|
|
12
14
|
|
|
13
15
|
```typescript
|
|
14
|
-
import type {
|
|
16
|
+
import type { SecFilings200ResponseFormFacetInner } from '@invinite-org/data-api-client'
|
|
15
17
|
|
|
16
18
|
// TODO: Update the object below with actual values
|
|
17
19
|
const example = {
|
|
18
|
-
"
|
|
19
|
-
|
|
20
|
+
"form": null,
|
|
21
|
+
"count": null,
|
|
22
|
+
"newest_filing_date": null,
|
|
23
|
+
} satisfies SecFilings200ResponseFormFacetInner
|
|
20
24
|
|
|
21
25
|
console.log(example)
|
|
22
26
|
|
|
@@ -25,7 +29,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
25
29
|
console.log(exampleJSON)
|
|
26
30
|
|
|
27
31
|
// Parse the JSON string back to an object
|
|
28
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as SecFilings200ResponseFormFacetInner
|
|
29
33
|
console.log(exampleParsed)
|
|
30
34
|
```
|
|
31
35
|
|
|
@@ -1,22 +1,27 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# SecFinancialsCatalog200Response
|
|
3
3
|
|
|
4
|
+
The rule catalog
|
|
4
5
|
|
|
5
6
|
## Properties
|
|
6
7
|
|
|
7
8
|
Name | Type
|
|
8
9
|
------------ | -------------
|
|
9
|
-
`
|
|
10
|
+
`api_schema` | string
|
|
11
|
+
`provider` | { [key: string]: any; }
|
|
12
|
+
`readiness` | [SecReadiness](SecReadiness.md)
|
|
10
13
|
|
|
11
14
|
## Example
|
|
12
15
|
|
|
13
16
|
```typescript
|
|
14
|
-
import type {
|
|
17
|
+
import type { SecFinancialsCatalog200Response } from '@invinite-org/data-api-client'
|
|
15
18
|
|
|
16
19
|
// TODO: Update the object below with actual values
|
|
17
20
|
const example = {
|
|
18
|
-
"
|
|
19
|
-
|
|
21
|
+
"api_schema": null,
|
|
22
|
+
"provider": null,
|
|
23
|
+
"readiness": null,
|
|
24
|
+
} satisfies SecFinancialsCatalog200Response
|
|
20
25
|
|
|
21
26
|
console.log(example)
|
|
22
27
|
|
|
@@ -25,7 +30,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
25
30
|
console.log(exampleJSON)
|
|
26
31
|
|
|
27
32
|
// Parse the JSON string back to an object
|
|
28
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
33
|
+
const exampleParsed = JSON.parse(exampleJSON) as SecFinancialsCatalog200Response
|
|
29
34
|
console.log(exampleParsed)
|
|
30
35
|
```
|
|
31
36
|
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
|
|
2
|
+
# SecHoldingsHolders200Response
|
|
3
|
+
|
|
4
|
+
One page of 13F holders
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`api_schema` | string
|
|
11
|
+
`counting_policy` | string
|
|
12
|
+
`coverage` | { [key: string]: any; }
|
|
13
|
+
`detail` | { [key: string]: any; }
|
|
14
|
+
`disclosure_limitations` | Array<string>
|
|
15
|
+
`identity` | { [key: string]: any; }
|
|
16
|
+
`next_cursor` | string
|
|
17
|
+
`page_status` | string
|
|
18
|
+
`pinned_at` | Date
|
|
19
|
+
`policy_version` | string
|
|
20
|
+
`provider` | { [key: string]: any; }
|
|
21
|
+
`readiness` | [SecReadiness](SecReadiness.md)
|
|
22
|
+
`rows` | Array<{ [key: string]: any; }>
|
|
23
|
+
`scope` | string
|
|
24
|
+
`snapshot_changed` | boolean
|
|
25
|
+
`value_semantics` | string
|
|
26
|
+
`next_url` | string
|
|
27
|
+
|
|
28
|
+
## Example
|
|
29
|
+
|
|
30
|
+
```typescript
|
|
31
|
+
import type { SecHoldingsHolders200Response } from '@invinite-org/data-api-client'
|
|
32
|
+
|
|
33
|
+
// TODO: Update the object below with actual values
|
|
34
|
+
const example = {
|
|
35
|
+
"api_schema": null,
|
|
36
|
+
"counting_policy": null,
|
|
37
|
+
"coverage": null,
|
|
38
|
+
"detail": null,
|
|
39
|
+
"disclosure_limitations": null,
|
|
40
|
+
"identity": null,
|
|
41
|
+
"next_cursor": null,
|
|
42
|
+
"page_status": null,
|
|
43
|
+
"pinned_at": null,
|
|
44
|
+
"policy_version": null,
|
|
45
|
+
"provider": null,
|
|
46
|
+
"readiness": null,
|
|
47
|
+
"rows": null,
|
|
48
|
+
"scope": null,
|
|
49
|
+
"snapshot_changed": null,
|
|
50
|
+
"value_semantics": null,
|
|
51
|
+
"next_url": null,
|
|
52
|
+
} satisfies SecHoldingsHolders200Response
|
|
53
|
+
|
|
54
|
+
console.log(example)
|
|
55
|
+
|
|
56
|
+
// Convert the instance to a JSON string
|
|
57
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
58
|
+
console.log(exampleJSON)
|
|
59
|
+
|
|
60
|
+
// Parse the JSON string back to an object
|
|
61
|
+
const exampleParsed = JSON.parse(exampleJSON) as SecHoldingsHolders200Response
|
|
62
|
+
console.log(exampleParsed)
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
66
|
+
|
|
67
|
+
|
|
@@ -1,28 +1,35 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# SecIssuers200Response
|
|
3
3
|
|
|
4
|
+
One page of issuers
|
|
4
5
|
|
|
5
6
|
## Properties
|
|
6
7
|
|
|
7
8
|
Name | Type
|
|
8
9
|
------------ | -------------
|
|
9
|
-
`
|
|
10
|
-
`
|
|
11
|
-
`
|
|
10
|
+
`ambiguous` | boolean
|
|
11
|
+
`api_schema` | string
|
|
12
|
+
`issuers` | Array<{ [key: string]: any; }>
|
|
13
|
+
`next_cursor` | string
|
|
14
|
+
`provider` | { [key: string]: any; }
|
|
15
|
+
`readiness` | [SecReadiness](SecReadiness.md)
|
|
12
16
|
`next_url` | string
|
|
13
17
|
|
|
14
18
|
## Example
|
|
15
19
|
|
|
16
20
|
```typescript
|
|
17
|
-
import type {
|
|
21
|
+
import type { SecIssuers200Response } from '@invinite-org/data-api-client'
|
|
18
22
|
|
|
19
23
|
// TODO: Update the object below with actual values
|
|
20
24
|
const example = {
|
|
21
|
-
"
|
|
22
|
-
"
|
|
23
|
-
"
|
|
25
|
+
"ambiguous": null,
|
|
26
|
+
"api_schema": null,
|
|
27
|
+
"issuers": null,
|
|
28
|
+
"next_cursor": null,
|
|
29
|
+
"provider": null,
|
|
30
|
+
"readiness": null,
|
|
24
31
|
"next_url": null,
|
|
25
|
-
} satisfies
|
|
32
|
+
} satisfies SecIssuers200Response
|
|
26
33
|
|
|
27
34
|
console.log(example)
|
|
28
35
|
|
|
@@ -31,7 +38,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
31
38
|
console.log(exampleJSON)
|
|
32
39
|
|
|
33
40
|
// Parse the JSON string back to an object
|
|
34
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
41
|
+
const exampleParsed = JSON.parse(exampleJSON) as SecIssuers200Response
|
|
35
42
|
console.log(exampleParsed)
|
|
36
43
|
```
|
|
37
44
|
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
|
|
2
|
+
# SecReadiness
|
|
3
|
+
|
|
4
|
+
The typed state of the answer\'s subject: ready / partial (200), pending (202, retry later, not billed), excluded (403), unknown (404), failed (424), not_ready (503: the capability is not switched on). Extra named fields (`detail`) may follow.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`status` | string
|
|
11
|
+
`reason` | string
|
|
12
|
+
`recoverable` | boolean
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { SecReadiness } from '@invinite-org/data-api-client'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"status": null,
|
|
22
|
+
"reason": null,
|
|
23
|
+
"recoverable": null,
|
|
24
|
+
} satisfies SecReadiness
|
|
25
|
+
|
|
26
|
+
console.log(example)
|
|
27
|
+
|
|
28
|
+
// Convert the instance to a JSON string
|
|
29
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
30
|
+
console.log(exampleJSON)
|
|
31
|
+
|
|
32
|
+
// Parse the JSON string back to an object
|
|
33
|
+
const exampleParsed = JSON.parse(exampleJSON) as SecReadiness
|
|
34
|
+
console.log(exampleParsed)
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
38
|
+
|
|
39
|
+
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
|
|
2
|
+
# SecSearch200Response
|
|
3
|
+
|
|
4
|
+
Ranked, cited passages and the coverage of the searched scope
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`api_schema` | string
|
|
11
|
+
`coverage` | [SecSearchCoverage](SecSearchCoverage.md)
|
|
12
|
+
`hits` | [Array<SecSearch200ResponseHitsInner>](SecSearch200ResponseHitsInner.md)
|
|
13
|
+
`mode` | string
|
|
14
|
+
`next_cursor` | string
|
|
15
|
+
`provider` | { [key: string]: any; }
|
|
16
|
+
`readiness` | [SecReadiness](SecReadiness.md)
|
|
17
|
+
`next_url` | string
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import type { SecSearch200Response } from '@invinite-org/data-api-client'
|
|
23
|
+
|
|
24
|
+
// TODO: Update the object below with actual values
|
|
25
|
+
const example = {
|
|
26
|
+
"api_schema": null,
|
|
27
|
+
"coverage": null,
|
|
28
|
+
"hits": null,
|
|
29
|
+
"mode": null,
|
|
30
|
+
"next_cursor": null,
|
|
31
|
+
"provider": null,
|
|
32
|
+
"readiness": null,
|
|
33
|
+
"next_url": null,
|
|
34
|
+
} satisfies SecSearch200Response
|
|
35
|
+
|
|
36
|
+
console.log(example)
|
|
37
|
+
|
|
38
|
+
// Convert the instance to a JSON string
|
|
39
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
40
|
+
console.log(exampleJSON)
|
|
41
|
+
|
|
42
|
+
// Parse the JSON string back to an object
|
|
43
|
+
const exampleParsed = JSON.parse(exampleJSON) as SecSearch200Response
|
|
44
|
+
console.log(exampleParsed)
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
48
|
+
|
|
49
|
+
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
|
|
2
|
+
# SecSearch200ResponseHitsInner
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`version_id` | string
|
|
10
|
+
`accession` | string
|
|
11
|
+
`filename` | string
|
|
12
|
+
`form` | string
|
|
13
|
+
`filing_date` | Date
|
|
14
|
+
`text` | string
|
|
15
|
+
`score` | number
|
|
16
|
+
`match` | [HitMatch](HitMatch.md)
|
|
17
|
+
`document_spans` | Array<{ [key: string]: any; }>
|
|
18
|
+
`citation` | { [key: string]: any; }
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import type { SecSearch200ResponseHitsInner } from '@invinite-org/data-api-client'
|
|
24
|
+
|
|
25
|
+
// TODO: Update the object below with actual values
|
|
26
|
+
const example = {
|
|
27
|
+
"version_id": null,
|
|
28
|
+
"accession": null,
|
|
29
|
+
"filename": null,
|
|
30
|
+
"form": null,
|
|
31
|
+
"filing_date": null,
|
|
32
|
+
"text": null,
|
|
33
|
+
"score": null,
|
|
34
|
+
"match": null,
|
|
35
|
+
"document_spans": null,
|
|
36
|
+
"citation": null,
|
|
37
|
+
} satisfies SecSearch200ResponseHitsInner
|
|
38
|
+
|
|
39
|
+
console.log(example)
|
|
40
|
+
|
|
41
|
+
// Convert the instance to a JSON string
|
|
42
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
43
|
+
console.log(exampleJSON)
|
|
44
|
+
|
|
45
|
+
// Parse the JSON string back to an object
|
|
46
|
+
const exampleParsed = JSON.parse(exampleJSON) as SecSearch200ResponseHitsInner
|
|
47
|
+
console.log(exampleParsed)
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
51
|
+
|
|
52
|
+
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
|
|
2
|
+
# SecSearchCoverage
|
|
3
|
+
|
|
4
|
+
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`).
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`completeness` | string
|
|
11
|
+
`lexical` | [SecSearchCoverageLexical](SecSearchCoverageLexical.md)
|
|
12
|
+
`reasons` | Array<string>
|
|
13
|
+
`forms_indexed` | Array<string>
|
|
14
|
+
`matches` | [SecSearchCoverageMatches](SecSearchCoverageMatches.md)
|
|
15
|
+
`hint` | string
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import type { SecSearchCoverage } from '@invinite-org/data-api-client'
|
|
21
|
+
|
|
22
|
+
// TODO: Update the object below with actual values
|
|
23
|
+
const example = {
|
|
24
|
+
"completeness": null,
|
|
25
|
+
"lexical": null,
|
|
26
|
+
"reasons": null,
|
|
27
|
+
"forms_indexed": null,
|
|
28
|
+
"matches": null,
|
|
29
|
+
"hint": null,
|
|
30
|
+
} satisfies SecSearchCoverage
|
|
31
|
+
|
|
32
|
+
console.log(example)
|
|
33
|
+
|
|
34
|
+
// Convert the instance to a JSON string
|
|
35
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
36
|
+
console.log(exampleJSON)
|
|
37
|
+
|
|
38
|
+
// Parse the JSON string back to an object
|
|
39
|
+
const exampleParsed = JSON.parse(exampleJSON) as SecSearchCoverage
|
|
40
|
+
console.log(exampleParsed)
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
44
|
+
|
|
45
|
+
|
|
@@ -1,24 +1,29 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# SecSearchCoverageLexical
|
|
3
3
|
|
|
4
|
+
The text index over the scope; null when nothing was searched (excluded / not indexed by policy)
|
|
4
5
|
|
|
5
6
|
## Properties
|
|
6
7
|
|
|
7
8
|
Name | Type
|
|
8
9
|
------------ | -------------
|
|
9
|
-
`
|
|
10
|
-
`
|
|
10
|
+
`state` | string
|
|
11
|
+
`indexed` | number
|
|
12
|
+
`pending` | number
|
|
13
|
+
`failed` | number
|
|
11
14
|
|
|
12
15
|
## Example
|
|
13
16
|
|
|
14
17
|
```typescript
|
|
15
|
-
import type {
|
|
18
|
+
import type { SecSearchCoverageLexical } from '@invinite-org/data-api-client'
|
|
16
19
|
|
|
17
20
|
// TODO: Update the object below with actual values
|
|
18
21
|
const example = {
|
|
19
|
-
"
|
|
20
|
-
"
|
|
21
|
-
|
|
22
|
+
"state": null,
|
|
23
|
+
"indexed": null,
|
|
24
|
+
"pending": null,
|
|
25
|
+
"failed": null,
|
|
26
|
+
} satisfies SecSearchCoverageLexical
|
|
22
27
|
|
|
23
28
|
console.log(example)
|
|
24
29
|
|
|
@@ -27,7 +32,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
27
32
|
console.log(exampleJSON)
|
|
28
33
|
|
|
29
34
|
// Parse the JSON string back to an object
|
|
30
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
35
|
+
const exampleParsed = JSON.parse(exampleJSON) as SecSearchCoverageLexical
|
|
31
36
|
console.log(exampleParsed)
|
|
32
37
|
```
|
|
33
38
|
|