signal

type AnomalyDetection struct {
	AnomalyResult     string
	SignificanceLevel string
	TestMethod        string
	Thresholds        AnomalyThresholds
}

type AnomalyThresholds struct {
	Low    string
	Medium string
	High   string
}

type FactDataSource struct {
	SourceName string
	SourceType FactType
	URL        string
	Icon       string
}

type FactDirection string

type FactFactor struct {
	// Name is the factor name, e.g. rsi_14.
	Name string
	// FactorGroups are the groups the factor belongs to, e.g. MOMENTUM.
	FactorGroups []string
	// LongShortDirection is the side the factor points to.
	LongShortDirection FactDirection
	// TriggerCondition is the condition that fired the factor.
	TriggerCondition string
	// AnomalyDetection is the anomaly test behind the factor.
	AnomalyDetection AnomalyDetection
}

type FactNlInfo struct {
	// Title is the headline.
	Title string
	// SubTitle is the sub-headline.
	SubTitle string
	// Summary is what happened, as a JSON array of {tag, value} entries carried in
	// a string. Use SummaryTags to read it.
	Summary string
	// InvestAnal is what it may mean for an investor, in the same JSON-in-a-string
	// shape as Summary. Use InvestAnalTags to read it.
	InvestAnal string
	// EliExplain is a plain-language walk-through of the fact, in the same
	// JSON-in-a-string shape as Summary. Use EliExplainTags to read it.
	EliExplain string
}

type FactSymbol struct {
	Symbol       string
	SecurityName string
}

type FactType string

type NlTag struct {
	// Tag is what the entry is about, e.g. RSI.
	Tag string `json:"tag"`
	// Value is the prose.
	Value string `json:"value"`
}

type Outlook string

type SecurityFact struct {
	// FactID is the fact ID, e.g. technical_rsi_14_short_1783674041337603409.
	FactID string
	// FactType is what kind of fact this is.
	FactType FactType
	// Direction is the side the fact points to.
	Direction FactDirection
	// OccurTime is when the fact occurred.
	OccurTime time.Time
	// SymbolsInfo are the securities the fact is about.
	SymbolsInfo []FactSymbol
	// Factors are the factors that contributed to the fact.
	Factors []FactFactor
	// DataSource is where the fact came from.
	DataSource []FactDataSource
	// NlInfo is the natural-language rendering of the fact.
	NlInfo FactNlInfo
}

type SecurityFactsOptions struct {
	// Symbol is the security to query, e.g. AAPL.US or 700.HK. Required.
	Symbol string
	// BeginTime is the start of the query window (zero = earliest available).
	BeginTime time.Time
	// EndTime is the end of the query window (zero = latest available).
	EndTime time.Time
	// Limit is the maximum number of facts to return; when more facts fall inside
	// the window, only the latest Limit are returned (nil = server default of 100).
	Limit *int32
}

type Signal struct {
	// ID is the signal ID, e.g. sign_992_1a00c9425c3_48ab. Pass it to
	// SignalContext.Signal for the full record.
	ID string
	// Symbol is the security symbol, e.g. 992.HK.
	Symbol string
	// CompanyName is the company name.
	CompanyName string
	// Market is the market the security trades in, e.g. HK.
	Market string
	// Title is the signal headline.
	Title string
	// Summary is a natural-language summary of the signal, in Markdown.
	Summary string
	// StrategyID is the strategy ID that produced the signal.
	StrategyID string
	// StrategyName is the strategy name that produced the signal.
	StrategyName string
	// RecommendBy is who recommended the signal; empty for strategy-generated signals.
	RecommendBy string
	// Expression is the strategy expression, e.g. 992.HK:GROWTH:long.
	Expression string
	// KeyFactID is the ID of the fact that triggered the signal.
	KeyFactID string
	// KeyCatalyst is the display label of the catalyst that triggered the signal,
	// e.g. "Q1 Revenue Surge". Filtering with SignalsOptions.CatalystName matches
	// the underlying factor name instead.
	KeyCatalyst string
	// AnalysisPrice is the price the analysis was based on.
	AnalysisPrice float64
	// ConservativePrice is the conservative-scenario target price.
	ConservativePrice float64
	// BenchmarkPrice is the benchmark-scenario target price.
	BenchmarkPrice float64
	// OptimisticPrice is the optimistic-scenario target price.
	OptimisticPrice float64
	// Outlook is the outlook the strategy takes on the security.
	Outlook Outlook
	// OutlookDesc is the localized rendering of Outlook in the caller's language.
	OutlookDesc string
	// Status is where the signal is in its lifecycle.
	Status SignalStatus
	// JsonData is the full analysis behind the signal, as a verbatim JSON document
	// (strategy-specific shape).
	JsonData string
	// CreatedAt is the creation time.
	CreatedAt time.Time
	// UpdatedAt is the last update time.
	UpdatedAt time.Time
}

type SignalContext struct {
	// contains filtered or unexported fields
}

type SignalStatus int32

type SignalsOptions struct {
	// SymbolName filters by security symbol, e.g. AAPL.US or 700.HK.
	SymbolName string
	// StrategyID filters by strategy id, e.g. buffett-value. Preferred over the
	// deprecated StrategyName; takes precedence when both are provided.
	StrategyID string
	// StrategyName filters by strategy name. Deprecated in favour of StrategyID.
	StrategyName string
	// CatalystName filters by the name of the factor that triggered the signal,
	// e.g. EARNINGS_RELEASED or macd_12_26_9 — the triggering fact's factor name,
	// not the display label in Signal.KeyCatalyst.
	CatalystName string
	// CatalystType filters by the catalyst type, e.g. News, Fundamental, Technical.
	CatalystType string
	// StartTime only returns signals created at or after this time (zero = no bound).
	StartTime time.Time
	// EndTime only returns signals created at or before this time (zero = no bound).
	EndTime time.Time
	// Limit is the maximum number of results to return (nil = server default of 20).
	Limit *int32
	// Offset is the number of results to skip for pagination (nil = 0).
	Offset *int32
}

type SignalsResponse struct {
	// Signals are the signals on this page.
	Signals []*Signal
	// Total is the total number of signals matching the filters, for paging with
	// SignalsOptions.Offset.
	Total int32
}