sentisense 0.52.0 → 0.53.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/README.md +21 -0
- package/dist/cli.cjs +9 -2
- package/dist/index.cjs +9 -2
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.mts +41 -3
- package/dist/index.d.ts +41 -3
- package/dist/index.mjs +9 -2
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -892,6 +892,37 @@ interface StoryCluster {
|
|
|
892
892
|
averageSentiment: number;
|
|
893
893
|
/** Unix timestamp in seconds when the cluster was assembled by our pipeline. */
|
|
894
894
|
clusteredAt: number;
|
|
895
|
+
/**
|
|
896
|
+
* How the story was authored: `"ORIGINAL"` for an editorially authored SentiSense
|
|
897
|
+
* Original, `"AI"` for a pipeline-generated story. Optional because an older API
|
|
898
|
+
* build omits it, in which case it is `undefined` rather than `"AI"`.
|
|
899
|
+
*/
|
|
900
|
+
storySource?: "ORIGINAL" | "AI";
|
|
901
|
+
/**
|
|
902
|
+
* True while the story is still being revised as the event develops. Optional
|
|
903
|
+
* because an older API build omits it, in which case it is `undefined` rather than
|
|
904
|
+
* `false`: read that as "not known", not as "settled".
|
|
905
|
+
*/
|
|
906
|
+
isLive?: boolean;
|
|
907
|
+
}
|
|
908
|
+
/**
|
|
909
|
+
* One dated update on a live story, as served inside the story detail response's
|
|
910
|
+
* `timeline` array (newest first, empty when a story has none).
|
|
911
|
+
*
|
|
912
|
+
* `documents.getStoryDetail()` returns `unknown`, so this type is exported for callers
|
|
913
|
+
* that narrow the response themselves.
|
|
914
|
+
*/
|
|
915
|
+
interface StoryTimelineEntry {
|
|
916
|
+
/** Publication time of this update, Unix milliseconds. */
|
|
917
|
+
publishedAt: number;
|
|
918
|
+
/**
|
|
919
|
+
* `"INITIAL"`, `"UPDATE"` or `"CORRECTION"`. Left open: an unrecognised label is
|
|
920
|
+
* served through rather than rejected, so branch on the three known values and let
|
|
921
|
+
* anything else fall through to a neutral rendering.
|
|
922
|
+
*/
|
|
923
|
+
updateType: "INITIAL" | "UPDATE" | "CORRECTION" | (string & {});
|
|
924
|
+
/** The update text, markdown. */
|
|
925
|
+
content: string;
|
|
895
926
|
}
|
|
896
927
|
interface Story {
|
|
897
928
|
cluster: StoryCluster;
|
|
@@ -2607,7 +2638,14 @@ declare class Documents {
|
|
|
2607
2638
|
getBySource(source: DocumentSource, options?: GetBySourceOptions): Promise<DocumentSearchResponse>;
|
|
2608
2639
|
/** Get AI-curated news story clusters. */
|
|
2609
2640
|
getStories(options?: GetStoriesOptions): Promise<Story[]>;
|
|
2610
|
-
/**
|
|
2641
|
+
/**
|
|
2642
|
+
* Get full story detail by cluster ID.
|
|
2643
|
+
*
|
|
2644
|
+
* Deliberately untyped: narrow it yourself. The response carries `storySource` and
|
|
2645
|
+
* `isLive` alongside the story body, plus a `timeline` array of dated updates,
|
|
2646
|
+
* newest first and empty when the story has none. {@link StoryTimelineEntry} is
|
|
2647
|
+
* exported for that array.
|
|
2648
|
+
*/
|
|
2611
2649
|
getStoryDetail(clusterId: string): Promise<unknown>;
|
|
2612
2650
|
/** Get stories for a specific stock. */
|
|
2613
2651
|
getStoriesByTicker(ticker: string, options?: GetStoriesByTickerOptions): Promise<Story[]>;
|
|
@@ -3639,6 +3677,6 @@ declare class APIError extends SentiSenseError {
|
|
|
3639
3677
|
constructor(message: string, status: number, code?: string);
|
|
3640
3678
|
}
|
|
3641
3679
|
|
|
3642
|
-
declare const VERSION = "0.
|
|
3680
|
+
declare const VERSION = "0.53.0";
|
|
3643
3681
|
|
|
3644
|
-
export { type AISummary, APIError, type AnalystAction, type AnalystCall, type AnalystConsensus, type AnalystCoverage, type AnalystCoverageAnalyst, type AnalystCoverageBookEntry, type AnalystCoverageFirm, type AnalystEarningsSurprise, type AnalystEstimate, type AnalystEstimatesResponse, type AnalystFirmRating, type AnalystFirmTenure, type AnalystNote, type AnalystProfile, type AnalystRatingBuckets, type AssetMetadata, AuthenticationError, type CalendarMeta, type ChartData, type ChartDataPoint, type ClusterBuy, type CompanyKpisData, type CongressTrade, DeepHistoryUnavailableError, type Document, type DocumentSearchResponse, type DocumentSource, type EarningsCalendarResponse, type EarningsEvent, type EarningsKpiHighlight, type EarningsQuarter, type EarningsSource, type EntitySearchResult, type EntitySearchType, type EtfAggregateCoverage, type EtfAnalystAggregate, type EtfAnalystContributor, type EtfHolding, type EtfHoldings, type EtfInfo, type EtfInsiderAggregate, type EtfInsiderContributor, type EtfScreenerExecuteResponse, type EtfScreenerRow, type EtfSentimentAggregate, type EtfSentimentReading, type FeaturedScreen, type FloatInfo, type Fundamentals, type FundamentalsPeriod, type FundamentalsPeriodsResponse, type GetAnalystActionsOptions, type GetAnalystCallsOptions, type GetAnalystCoverageOptions, type GetAnalystMarketActivityOptions, type GetEarningsCalendarOptions, type GetEarningsSummariesOptions, type GetEtfInsiderAggregateOptions, type GetHoldersOptions, type GetInsiderOptions, type GetInsightsOptions, type GetLatestInsightsOptions, type GetOptionsHistoryOptions, type GetPoliticianActivityOptions, type GetPoliticianDirectoryOptions, type GetPoliticianMemberOptions, type GetPoliticiansOptions, type GetRecentEarningsOptions, type GetStockInsightsRangeOptions, type GetUserInsightsOptions, type Holder, type HolderNotableChanges, type IndexConstituent, type IndexHistoryPoint, type IndexHistoryResponse, type IndexListResponse, type IndexListing, type IndexSnapshot, type InsiderActivityResponse, type InsiderActivitySummary, type InsiderTrade, type Insight, type InsightPreviewResponse, type InstitutionList, type InstitutionListResponse, type InstitutionSummary, type InstitutionalFlow, type InstitutionalFlows, type InstitutionalFlowsResponse, type KBEntity, type KpiCoverageEntry, type KpiCoverageResponse, type KpiDataPoint, type KpiSeries, type KpiTypeEntry, type ListInstitutionsOptions, type LockedInsight, type MarketMood, type MarketStatus, type MarketSummary, type MetricDistribution, type MetricDistributionOptions, type MetricType, type MetricsBreakdown, type MetricsOptions, NotFoundError, type OptionsAggregate, type OptionsContext, type OptionsHistory, type OptionsHistoryWindow, type OptionsOiWalls, type OptionsOverview, type OptionsOverviewRow, type OptionsSummary, type OptionsUnusualContract, type OptionsWall, type PoliticianDetail, type PoliticianDirectory, type PoliticianDirectoryEntry, type PoliticianDirectoryResponse, type PoliticianSummary, type PreviewResponse, type Quarter, RateLimitError, type RatingBase, type RatingDimension, type RatingDimensionKey, type RatingFlag, type RatingNotRatedReason, type RatingSubLeg, type RecentEarningsEntry, type RiskAdjustment, type RiskCondition, type ScreenerExecuteOptions, type ScreenerExecuteResponse, type ScreenerFieldCatalog, type ScreenerFieldDescriptor, type ScreenerFieldOption, type ScreenerFilter, type ScreenerPlan, type ScreenerRow, type ScreenerScreensResponse, type ScreenerSort, type SearchEntitiesOptions, SentiSense, SentiSenseError, type SentiSenseOptions, type SentimentEntry, type ServingMetric, type ShortInterest, type ShortVolume, type SimilarStock, type StockDetail, type StockEntity, type StockImage, type StockNotRated, type StockPrice, type StockProfile, type StockQuote, type StockRating, type StockRatingResponse, type StockSocialDominance, type Story, type StoryCluster, type TickerHolders, type TrackerEvent, type TrackerGeoEntry, type TrackerHeadlineMetric, type TrackerListResponse, type TrackerListing, type TrackerMetricValue, type TrackerSignal, type TrackerSnapshot, type TrackerSnapshotResponse, type TrackerSourceRef, type TrackerTableRow, type TrackerTimeSeriesPoint, type TtmFundamentals, VERSION, type WeightedConsensus, type WeightedNetFlow, SentiSense as default };
|
|
3682
|
+
export { type AISummary, APIError, type AnalystAction, type AnalystCall, type AnalystConsensus, type AnalystCoverage, type AnalystCoverageAnalyst, type AnalystCoverageBookEntry, type AnalystCoverageFirm, type AnalystEarningsSurprise, type AnalystEstimate, type AnalystEstimatesResponse, type AnalystFirmRating, type AnalystFirmTenure, type AnalystNote, type AnalystProfile, type AnalystRatingBuckets, type AssetMetadata, AuthenticationError, type CalendarMeta, type ChartData, type ChartDataPoint, type ClusterBuy, type CompanyKpisData, type CongressTrade, DeepHistoryUnavailableError, type Document, type DocumentSearchResponse, type DocumentSource, type EarningsCalendarResponse, type EarningsEvent, type EarningsKpiHighlight, type EarningsQuarter, type EarningsSource, type EntitySearchResult, type EntitySearchType, type EtfAggregateCoverage, type EtfAnalystAggregate, type EtfAnalystContributor, type EtfHolding, type EtfHoldings, type EtfInfo, type EtfInsiderAggregate, type EtfInsiderContributor, type EtfScreenerExecuteResponse, type EtfScreenerRow, type EtfSentimentAggregate, type EtfSentimentReading, type FeaturedScreen, type FloatInfo, type Fundamentals, type FundamentalsPeriod, type FundamentalsPeriodsResponse, type GetAnalystActionsOptions, type GetAnalystCallsOptions, type GetAnalystCoverageOptions, type GetAnalystMarketActivityOptions, type GetEarningsCalendarOptions, type GetEarningsSummariesOptions, type GetEtfInsiderAggregateOptions, type GetHoldersOptions, type GetInsiderOptions, type GetInsightsOptions, type GetLatestInsightsOptions, type GetOptionsHistoryOptions, type GetPoliticianActivityOptions, type GetPoliticianDirectoryOptions, type GetPoliticianMemberOptions, type GetPoliticiansOptions, type GetRecentEarningsOptions, type GetStockInsightsRangeOptions, type GetUserInsightsOptions, type Holder, type HolderNotableChanges, type IndexConstituent, type IndexHistoryPoint, type IndexHistoryResponse, type IndexListResponse, type IndexListing, type IndexSnapshot, type InsiderActivityResponse, type InsiderActivitySummary, type InsiderTrade, type Insight, type InsightPreviewResponse, type InstitutionList, type InstitutionListResponse, type InstitutionSummary, type InstitutionalFlow, type InstitutionalFlows, type InstitutionalFlowsResponse, type KBEntity, type KpiCoverageEntry, type KpiCoverageResponse, type KpiDataPoint, type KpiSeries, type KpiTypeEntry, type ListInstitutionsOptions, type LockedInsight, type MarketMood, type MarketStatus, type MarketSummary, type MetricDistribution, type MetricDistributionOptions, type MetricType, type MetricsBreakdown, type MetricsOptions, NotFoundError, type OptionsAggregate, type OptionsContext, type OptionsHistory, type OptionsHistoryWindow, type OptionsOiWalls, type OptionsOverview, type OptionsOverviewRow, type OptionsSummary, type OptionsUnusualContract, type OptionsWall, type PoliticianDetail, type PoliticianDirectory, type PoliticianDirectoryEntry, type PoliticianDirectoryResponse, type PoliticianSummary, type PreviewResponse, type Quarter, RateLimitError, type RatingBase, type RatingDimension, type RatingDimensionKey, type RatingFlag, type RatingNotRatedReason, type RatingSubLeg, type RecentEarningsEntry, type RiskAdjustment, type RiskCondition, type ScreenerExecuteOptions, type ScreenerExecuteResponse, type ScreenerFieldCatalog, type ScreenerFieldDescriptor, type ScreenerFieldOption, type ScreenerFilter, type ScreenerPlan, type ScreenerRow, type ScreenerScreensResponse, type ScreenerSort, type SearchEntitiesOptions, SentiSense, SentiSenseError, type SentiSenseOptions, type SentimentEntry, type ServingMetric, type ShortInterest, type ShortVolume, type SimilarStock, type StockDetail, type StockEntity, type StockImage, type StockNotRated, type StockPrice, type StockProfile, type StockQuote, type StockRating, type StockRatingResponse, type StockSocialDominance, type Story, type StoryCluster, type StoryTimelineEntry, type TickerHolders, type TrackerEvent, type TrackerGeoEntry, type TrackerHeadlineMetric, type TrackerListResponse, type TrackerListing, type TrackerMetricValue, type TrackerSignal, type TrackerSnapshot, type TrackerSnapshotResponse, type TrackerSourceRef, type TrackerTableRow, type TrackerTimeSeriesPoint, type TtmFundamentals, VERSION, type WeightedConsensus, type WeightedNetFlow, SentiSense as default };
|
package/dist/index.d.ts
CHANGED
|
@@ -892,6 +892,37 @@ interface StoryCluster {
|
|
|
892
892
|
averageSentiment: number;
|
|
893
893
|
/** Unix timestamp in seconds when the cluster was assembled by our pipeline. */
|
|
894
894
|
clusteredAt: number;
|
|
895
|
+
/**
|
|
896
|
+
* How the story was authored: `"ORIGINAL"` for an editorially authored SentiSense
|
|
897
|
+
* Original, `"AI"` for a pipeline-generated story. Optional because an older API
|
|
898
|
+
* build omits it, in which case it is `undefined` rather than `"AI"`.
|
|
899
|
+
*/
|
|
900
|
+
storySource?: "ORIGINAL" | "AI";
|
|
901
|
+
/**
|
|
902
|
+
* True while the story is still being revised as the event develops. Optional
|
|
903
|
+
* because an older API build omits it, in which case it is `undefined` rather than
|
|
904
|
+
* `false`: read that as "not known", not as "settled".
|
|
905
|
+
*/
|
|
906
|
+
isLive?: boolean;
|
|
907
|
+
}
|
|
908
|
+
/**
|
|
909
|
+
* One dated update on a live story, as served inside the story detail response's
|
|
910
|
+
* `timeline` array (newest first, empty when a story has none).
|
|
911
|
+
*
|
|
912
|
+
* `documents.getStoryDetail()` returns `unknown`, so this type is exported for callers
|
|
913
|
+
* that narrow the response themselves.
|
|
914
|
+
*/
|
|
915
|
+
interface StoryTimelineEntry {
|
|
916
|
+
/** Publication time of this update, Unix milliseconds. */
|
|
917
|
+
publishedAt: number;
|
|
918
|
+
/**
|
|
919
|
+
* `"INITIAL"`, `"UPDATE"` or `"CORRECTION"`. Left open: an unrecognised label is
|
|
920
|
+
* served through rather than rejected, so branch on the three known values and let
|
|
921
|
+
* anything else fall through to a neutral rendering.
|
|
922
|
+
*/
|
|
923
|
+
updateType: "INITIAL" | "UPDATE" | "CORRECTION" | (string & {});
|
|
924
|
+
/** The update text, markdown. */
|
|
925
|
+
content: string;
|
|
895
926
|
}
|
|
896
927
|
interface Story {
|
|
897
928
|
cluster: StoryCluster;
|
|
@@ -2607,7 +2638,14 @@ declare class Documents {
|
|
|
2607
2638
|
getBySource(source: DocumentSource, options?: GetBySourceOptions): Promise<DocumentSearchResponse>;
|
|
2608
2639
|
/** Get AI-curated news story clusters. */
|
|
2609
2640
|
getStories(options?: GetStoriesOptions): Promise<Story[]>;
|
|
2610
|
-
/**
|
|
2641
|
+
/**
|
|
2642
|
+
* Get full story detail by cluster ID.
|
|
2643
|
+
*
|
|
2644
|
+
* Deliberately untyped: narrow it yourself. The response carries `storySource` and
|
|
2645
|
+
* `isLive` alongside the story body, plus a `timeline` array of dated updates,
|
|
2646
|
+
* newest first and empty when the story has none. {@link StoryTimelineEntry} is
|
|
2647
|
+
* exported for that array.
|
|
2648
|
+
*/
|
|
2611
2649
|
getStoryDetail(clusterId: string): Promise<unknown>;
|
|
2612
2650
|
/** Get stories for a specific stock. */
|
|
2613
2651
|
getStoriesByTicker(ticker: string, options?: GetStoriesByTickerOptions): Promise<Story[]>;
|
|
@@ -3639,6 +3677,6 @@ declare class APIError extends SentiSenseError {
|
|
|
3639
3677
|
constructor(message: string, status: number, code?: string);
|
|
3640
3678
|
}
|
|
3641
3679
|
|
|
3642
|
-
declare const VERSION = "0.
|
|
3680
|
+
declare const VERSION = "0.53.0";
|
|
3643
3681
|
|
|
3644
|
-
export { type AISummary, APIError, type AnalystAction, type AnalystCall, type AnalystConsensus, type AnalystCoverage, type AnalystCoverageAnalyst, type AnalystCoverageBookEntry, type AnalystCoverageFirm, type AnalystEarningsSurprise, type AnalystEstimate, type AnalystEstimatesResponse, type AnalystFirmRating, type AnalystFirmTenure, type AnalystNote, type AnalystProfile, type AnalystRatingBuckets, type AssetMetadata, AuthenticationError, type CalendarMeta, type ChartData, type ChartDataPoint, type ClusterBuy, type CompanyKpisData, type CongressTrade, DeepHistoryUnavailableError, type Document, type DocumentSearchResponse, type DocumentSource, type EarningsCalendarResponse, type EarningsEvent, type EarningsKpiHighlight, type EarningsQuarter, type EarningsSource, type EntitySearchResult, type EntitySearchType, type EtfAggregateCoverage, type EtfAnalystAggregate, type EtfAnalystContributor, type EtfHolding, type EtfHoldings, type EtfInfo, type EtfInsiderAggregate, type EtfInsiderContributor, type EtfScreenerExecuteResponse, type EtfScreenerRow, type EtfSentimentAggregate, type EtfSentimentReading, type FeaturedScreen, type FloatInfo, type Fundamentals, type FundamentalsPeriod, type FundamentalsPeriodsResponse, type GetAnalystActionsOptions, type GetAnalystCallsOptions, type GetAnalystCoverageOptions, type GetAnalystMarketActivityOptions, type GetEarningsCalendarOptions, type GetEarningsSummariesOptions, type GetEtfInsiderAggregateOptions, type GetHoldersOptions, type GetInsiderOptions, type GetInsightsOptions, type GetLatestInsightsOptions, type GetOptionsHistoryOptions, type GetPoliticianActivityOptions, type GetPoliticianDirectoryOptions, type GetPoliticianMemberOptions, type GetPoliticiansOptions, type GetRecentEarningsOptions, type GetStockInsightsRangeOptions, type GetUserInsightsOptions, type Holder, type HolderNotableChanges, type IndexConstituent, type IndexHistoryPoint, type IndexHistoryResponse, type IndexListResponse, type IndexListing, type IndexSnapshot, type InsiderActivityResponse, type InsiderActivitySummary, type InsiderTrade, type Insight, type InsightPreviewResponse, type InstitutionList, type InstitutionListResponse, type InstitutionSummary, type InstitutionalFlow, type InstitutionalFlows, type InstitutionalFlowsResponse, type KBEntity, type KpiCoverageEntry, type KpiCoverageResponse, type KpiDataPoint, type KpiSeries, type KpiTypeEntry, type ListInstitutionsOptions, type LockedInsight, type MarketMood, type MarketStatus, type MarketSummary, type MetricDistribution, type MetricDistributionOptions, type MetricType, type MetricsBreakdown, type MetricsOptions, NotFoundError, type OptionsAggregate, type OptionsContext, type OptionsHistory, type OptionsHistoryWindow, type OptionsOiWalls, type OptionsOverview, type OptionsOverviewRow, type OptionsSummary, type OptionsUnusualContract, type OptionsWall, type PoliticianDetail, type PoliticianDirectory, type PoliticianDirectoryEntry, type PoliticianDirectoryResponse, type PoliticianSummary, type PreviewResponse, type Quarter, RateLimitError, type RatingBase, type RatingDimension, type RatingDimensionKey, type RatingFlag, type RatingNotRatedReason, type RatingSubLeg, type RecentEarningsEntry, type RiskAdjustment, type RiskCondition, type ScreenerExecuteOptions, type ScreenerExecuteResponse, type ScreenerFieldCatalog, type ScreenerFieldDescriptor, type ScreenerFieldOption, type ScreenerFilter, type ScreenerPlan, type ScreenerRow, type ScreenerScreensResponse, type ScreenerSort, type SearchEntitiesOptions, SentiSense, SentiSenseError, type SentiSenseOptions, type SentimentEntry, type ServingMetric, type ShortInterest, type ShortVolume, type SimilarStock, type StockDetail, type StockEntity, type StockImage, type StockNotRated, type StockPrice, type StockProfile, type StockQuote, type StockRating, type StockRatingResponse, type StockSocialDominance, type Story, type StoryCluster, type TickerHolders, type TrackerEvent, type TrackerGeoEntry, type TrackerHeadlineMetric, type TrackerListResponse, type TrackerListing, type TrackerMetricValue, type TrackerSignal, type TrackerSnapshot, type TrackerSnapshotResponse, type TrackerSourceRef, type TrackerTableRow, type TrackerTimeSeriesPoint, type TtmFundamentals, VERSION, type WeightedConsensus, type WeightedNetFlow, SentiSense as default };
|
|
3682
|
+
export { type AISummary, APIError, type AnalystAction, type AnalystCall, type AnalystConsensus, type AnalystCoverage, type AnalystCoverageAnalyst, type AnalystCoverageBookEntry, type AnalystCoverageFirm, type AnalystEarningsSurprise, type AnalystEstimate, type AnalystEstimatesResponse, type AnalystFirmRating, type AnalystFirmTenure, type AnalystNote, type AnalystProfile, type AnalystRatingBuckets, type AssetMetadata, AuthenticationError, type CalendarMeta, type ChartData, type ChartDataPoint, type ClusterBuy, type CompanyKpisData, type CongressTrade, DeepHistoryUnavailableError, type Document, type DocumentSearchResponse, type DocumentSource, type EarningsCalendarResponse, type EarningsEvent, type EarningsKpiHighlight, type EarningsQuarter, type EarningsSource, type EntitySearchResult, type EntitySearchType, type EtfAggregateCoverage, type EtfAnalystAggregate, type EtfAnalystContributor, type EtfHolding, type EtfHoldings, type EtfInfo, type EtfInsiderAggregate, type EtfInsiderContributor, type EtfScreenerExecuteResponse, type EtfScreenerRow, type EtfSentimentAggregate, type EtfSentimentReading, type FeaturedScreen, type FloatInfo, type Fundamentals, type FundamentalsPeriod, type FundamentalsPeriodsResponse, type GetAnalystActionsOptions, type GetAnalystCallsOptions, type GetAnalystCoverageOptions, type GetAnalystMarketActivityOptions, type GetEarningsCalendarOptions, type GetEarningsSummariesOptions, type GetEtfInsiderAggregateOptions, type GetHoldersOptions, type GetInsiderOptions, type GetInsightsOptions, type GetLatestInsightsOptions, type GetOptionsHistoryOptions, type GetPoliticianActivityOptions, type GetPoliticianDirectoryOptions, type GetPoliticianMemberOptions, type GetPoliticiansOptions, type GetRecentEarningsOptions, type GetStockInsightsRangeOptions, type GetUserInsightsOptions, type Holder, type HolderNotableChanges, type IndexConstituent, type IndexHistoryPoint, type IndexHistoryResponse, type IndexListResponse, type IndexListing, type IndexSnapshot, type InsiderActivityResponse, type InsiderActivitySummary, type InsiderTrade, type Insight, type InsightPreviewResponse, type InstitutionList, type InstitutionListResponse, type InstitutionSummary, type InstitutionalFlow, type InstitutionalFlows, type InstitutionalFlowsResponse, type KBEntity, type KpiCoverageEntry, type KpiCoverageResponse, type KpiDataPoint, type KpiSeries, type KpiTypeEntry, type ListInstitutionsOptions, type LockedInsight, type MarketMood, type MarketStatus, type MarketSummary, type MetricDistribution, type MetricDistributionOptions, type MetricType, type MetricsBreakdown, type MetricsOptions, NotFoundError, type OptionsAggregate, type OptionsContext, type OptionsHistory, type OptionsHistoryWindow, type OptionsOiWalls, type OptionsOverview, type OptionsOverviewRow, type OptionsSummary, type OptionsUnusualContract, type OptionsWall, type PoliticianDetail, type PoliticianDirectory, type PoliticianDirectoryEntry, type PoliticianDirectoryResponse, type PoliticianSummary, type PreviewResponse, type Quarter, RateLimitError, type RatingBase, type RatingDimension, type RatingDimensionKey, type RatingFlag, type RatingNotRatedReason, type RatingSubLeg, type RecentEarningsEntry, type RiskAdjustment, type RiskCondition, type ScreenerExecuteOptions, type ScreenerExecuteResponse, type ScreenerFieldCatalog, type ScreenerFieldDescriptor, type ScreenerFieldOption, type ScreenerFilter, type ScreenerPlan, type ScreenerRow, type ScreenerScreensResponse, type ScreenerSort, type SearchEntitiesOptions, SentiSense, SentiSenseError, type SentiSenseOptions, type SentimentEntry, type ServingMetric, type ShortInterest, type ShortVolume, type SimilarStock, type StockDetail, type StockEntity, type StockImage, type StockNotRated, type StockPrice, type StockProfile, type StockQuote, type StockRating, type StockRatingResponse, type StockSocialDominance, type Story, type StoryCluster, type StoryTimelineEntry, type TickerHolders, type TrackerEvent, type TrackerGeoEntry, type TrackerHeadlineMetric, type TrackerListResponse, type TrackerListing, type TrackerMetricValue, type TrackerSignal, type TrackerSnapshot, type TrackerSnapshotResponse, type TrackerSourceRef, type TrackerTableRow, type TrackerTimeSeriesPoint, type TtmFundamentals, VERSION, type WeightedConsensus, type WeightedNetFlow, SentiSense as default };
|
package/dist/index.mjs
CHANGED
|
@@ -221,7 +221,14 @@ var Documents = class {
|
|
|
221
221
|
async getStories(options) {
|
|
222
222
|
return this.client.get("/api/v1/documents/stories", options);
|
|
223
223
|
}
|
|
224
|
-
/**
|
|
224
|
+
/**
|
|
225
|
+
* Get full story detail by cluster ID.
|
|
226
|
+
*
|
|
227
|
+
* Deliberately untyped: narrow it yourself. The response carries `storySource` and
|
|
228
|
+
* `isLive` alongside the story body, plus a `timeline` array of dated updates,
|
|
229
|
+
* newest first and empty when the story has none. {@link StoryTimelineEntry} is
|
|
230
|
+
* exported for that array.
|
|
231
|
+
*/
|
|
225
232
|
async getStoryDetail(clusterId) {
|
|
226
233
|
return this.client.get(`/api/v1/documents/stories/${encodeURIComponent(clusterId)}`);
|
|
227
234
|
}
|
|
@@ -1208,7 +1215,7 @@ var Trackers = class {
|
|
|
1208
1215
|
};
|
|
1209
1216
|
|
|
1210
1217
|
// src/version.ts
|
|
1211
|
-
var VERSION = "0.
|
|
1218
|
+
var VERSION = "0.53.0";
|
|
1212
1219
|
|
|
1213
1220
|
// src/client.ts
|
|
1214
1221
|
var DEFAULT_BASE_URL = "https://app.sentisense.ai";
|