portfolio

type AssetType int

type ExchangeRate struct {
	// Average rate (base_currency / other_currency).
	AverageRate float64
	// Base currency, e.g. "USD".
	BaseCurrency string
	// Bid rate.
	BidRate float64
	// Offer rate.
	OfferRate float64
	// Other currency, e.g. "HKD".
	OtherCurrency string
}

type ExchangeRates struct {
	// List of exchange rates.
	Exchanges []ExchangeRate
}

type FlowDirection int

type FlowItem struct {
	// Execution date string, e.g. "2024-01-15".
	ExecutedDate string
	// Execution timestamp string.
	ExecutedTimestamp string
	// Security code / ticker.
	Code string
	// Direction of the flow.
	Direction FlowDirection
	// Executed quantity.
	ExecutedQuantity *decimal.Decimal
	// Executed price.
	ExecutedPrice *decimal.Decimal
	// Executed cost.
	ExecutedCost *decimal.Decimal
	// Human-readable description.
	Describe string
}

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

type ProfitAnalysis struct {
	// Summary overview.
	Summary ProfitAnalysisSummary
	// Per-security breakdown.
	Sublist ProfitAnalysisSublist
}

type ProfitAnalysisByMarket struct {
	// Total P&L across all returned items.
	Profit *decimal.Decimal
	// Whether more pages are available.
	HasMore bool
	// Per-security P&L items for the requested market/page.
	StockItems []ProfitAnalysisByMarketItem
}

type ProfitAnalysisByMarketItem struct {
	// Security symbol (ticker code).
	Code string
	// Security name.
	Name string
	// Market, e.g. "HK", "US".
	Market string
	// Profit/loss amount.
	Profit *decimal.Decimal
}

type ProfitAnalysisByMarketOptions struct {
	// Market filter, e.g. "HK", "US" (optional).
	Market string
	// Start date in YYYY-MM-DD format (optional).
	Start string
	// End date in YYYY-MM-DD format (optional).
	End string
	// Currency filter (optional).
	Currency string
	// Page number (1-based).
	Page uint32
	// Page size.
	Size uint32
}

type ProfitAnalysisDetail struct {
	// Total profit/loss.
	Profit *decimal.Decimal
	// Underlying stock P&L details.
	UnderlyingDetails ProfitDetails
	// Derivative P&L details.
	DerivativePnlDetails ProfitDetails
	// Security name.
	Name string
	// Last updated time (unix timestamp string).
	UpdatedAt string
	// Last updated date string.
	UpdatedDate string
	// Currency.
	Currency string
	// Default detail tab: 0 = underlying, 1 = derivative.
	DefaultTag int32
	// Query start time (unix timestamp string).
	Start string
	// Query end time (unix timestamp string).
	End string
	// Query start date string.
	StartDate string
	// Query end date string.
	EndDate string
}

type ProfitAnalysisDetailOptions struct {
	// Symbol, e.g. "TSLA.US".
	Symbol string
	// Start date in YYYY-MM-DD format (optional).
	Start string
	// End date in YYYY-MM-DD format (optional).
	End string
}

type ProfitAnalysisFlows struct {
	// Paginated list of flow items.
	FlowsList []FlowItem
	// Whether there are more pages.
	HasMore bool
}

type ProfitAnalysisFlowsOptions struct {
	// Symbol, e.g. "TSLA.US".
	Symbol string
	// Page number (1-based).
	Page uint32
	// Page size.
	Size uint32
	// Whether to include derivative flows.
	Derivative bool
	// Start date in YYYY-MM-DD format (optional).
	Start string
	// End date in YYYY-MM-DD format (optional).
	End string
}

type ProfitAnalysisItem struct {
	// Security name.
	Name string
	// Market.
	Market string
	// Whether still holding.
	IsHolding bool
	// Profit/loss amount.
	Profit *decimal.Decimal
	// Profit/loss rate.
	ProfitRate *decimal.Decimal
	// Number of completed trades.
	ClearanceTimes int64
	// Asset type.
	ItemType AssetType
	// Currency.
	Currency string
	// Security symbol (converted from counter_id).
	Symbol string
	// Holding period display string.
	HoldingPeriod string
	// Ticker code.
	SecurityCode string
	// ISIN (for funds).
	Isin string
	// Underlying stock P&L.
	UnderlyingProfit *decimal.Decimal
	// Derivatives P&L.
	DerivativesProfit *decimal.Decimal
	// P&L in order currency.
	OrderProfit *decimal.Decimal
}

type ProfitAnalysisOptions struct {
	// Start date in YYYY-MM-DD format (optional).
	Start string
	// End date in YYYY-MM-DD format (optional).
	End string
}

type ProfitAnalysisSublist struct {
	// Start time (unix timestamp string).
	Start string
	// End time (unix timestamp string).
	End string
	// Start date string.
	StartDate string
	// End date string.
	EndDate string
	// Last updated time (unix timestamp string).
	UpdatedAt string
	// Last updated date string.
	UpdatedDate string
	// Per-security items.
	Items []ProfitAnalysisItem
}

type ProfitAnalysisSummary struct {
	// Account currency.
	Currency string
	// Current total asset value.
	CurrentTotalAsset *decimal.Decimal
	// Query start date string.
	StartDate string
	// Query end date string.
	EndDate string
	// Start time (unix timestamp string).
	StartTime string
	// End time (unix timestamp string).
	EndTime string
	// Ending asset value.
	EndingAssetValue *decimal.Decimal
	// Initial asset value.
	InitialAssetValue *decimal.Decimal
	// Total invested amount.
	InvestAmount *decimal.Decimal
	// Whether any trades occurred.
	IsTraded bool
	// Total profit/loss.
	SumProfit *decimal.Decimal
	// Total profit/loss rate.
	SumProfitRate *decimal.Decimal
	// Per-asset-type breakdown.
	Profits ProfitSummaryBreakdown
}

type ProfitDetailEntry struct {
	// Description.
	Describe string
	// Amount.
	Amount *decimal.Decimal
}

type ProfitDetails struct {
	// Current holding market value.
	HoldingValue *decimal.Decimal
	// Total profit/loss.
	Profit *decimal.Decimal
	// Cumulative credited amount.
	CumulativeCreditedAmount *decimal.Decimal
	// Credit detail entries.
	CreditedDetails []ProfitDetailEntry
	// Cumulative debited amount.
	CumulativeDebitedAmount *decimal.Decimal
	// Debit detail entries.
	DebitedDetails []ProfitDetailEntry
	// Cumulative fee amount.
	CumulativeFeeAmount *decimal.Decimal
	// Fee detail entries.
	FeeDetails []ProfitDetailEntry
	// Short position holding value.
	ShortHoldingValue *decimal.Decimal
	// Long position holding value.
	LongHoldingValue *decimal.Decimal
	// Opening position market value at period start.
	HoldingValueAtBeginning *decimal.Decimal
	// Closing position market value at period end.
	HoldingValueAtEnding *decimal.Decimal
}

type ProfitSummaryBreakdown struct {
	// Stock P&L.
	Stock *decimal.Decimal
	// Fund P&L.
	Fund *decimal.Decimal
	// Crypto P&L.
	Crypto *decimal.Decimal
	// Money market fund P&L.
	Mmf *decimal.Decimal
	// Other P&L.
	Other *decimal.Decimal
	// Cumulative transaction amount.
	CumulativeTransactionAmount *decimal.Decimal
	// Total number of orders.
	TradeOrderNum string
	// Total number of traded securities.
	TradeStockNum string
	// IPO P&L.
	Ipo *decimal.Decimal
	// IPO hits.
	IpoHit int32
	// IPO subscriptions.
	IpoSubscription int32
	// Per-category summary info.
	SummaryInfo []ProfitSummaryInfo
}

type ProfitSummaryInfo struct {
	// Asset type.
	AssetType AssetType
	// Security with the maximum profit.
	ProfitMax string
	// Name of the max-profit security.
	ProfitMaxName string
	// Security with the maximum loss.
	LossMax string
	// Name of the max-loss security.
	LossMaxName string
}