api

type Calendar struct {
	Days int `json:"days"`

	// From Today, UTC.
	From openapi_types.Date `json:"from"`

	// Stocks Soonest ex-date first.
	Stocks []struct {
		ExDividendDate openapi_types.Date `json:"ex_dividend_date"`
		Name           *string            `json:"name,omitempty"`

		// PaymentFrequency Example: quarterly
		PaymentFrequency *string `json:"payment_frequency,omitempty"`
		Sector           *string `json:"sector,omitempty"`
		Symbol           string  `json:"symbol"`
	} `json:"stocks"`
}

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

type ClientInterface interface {

	// GetCalendar Upcoming ex-dividend dates
	//
	// Every stock Quantic tracks going ex-dividend in the next `days` days, soonest first. Public: no token needed. Buy before the ex-date to receive the next dividend.
	//
	// Corresponds with GET /api/v1/calendar (the `GetCalendar` operationId).
	GetCalendar(ctx context.Context, params *GetCalendarParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListDividends Your received dividends
	//
	// Dividends paid to you, newest first.
	//
	// Corresponds with GET /api/v1/dividends (the `ListDividends` operationId).
	ListDividends(ctx context.Context, params *ListDividendsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListHoldings Your holdings
	//
	// Each position's shares and average cost, from the ledger: cost basis, no live prices.
	//
	// Corresponds with GET /api/v1/holdings (the `ListHoldings` operationId).
	ListHoldings(ctx context.Context, params *ListHoldingsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetIncome Your dividend income outlook
	//
	// Forward annual dividend income at today's rates, in your preferred currency, gross and net of estimated foreign withholding; the holdings it comes from; a year-by-year projection; and how a typical year's income falls across the months.
	//
	// Corresponds with GET /api/v1/income (the `GetIncome` operationId).
	GetIncome(ctx context.Context, params *GetIncomeParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetMe The user the token belongs to
	//
	// Also the cheapest way to check that a token works.
	//
	// Corresponds with GET /api/v1/me (the `GetMe` operationId).
	GetMe(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListPortfolios Your portfolios
	//
	// Corresponds with GET /api/v1/portfolios (the `ListPortfolios` operationId).
	ListPortfolios(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchStocks Search stocks
	//
	// By ticker or company name, up to about 10 matches. Anonymous callers search the stocks Quantic already tracks; with a token the search also asks the market-data provider.
	//
	// Corresponds with GET /api/v1/stocks (the `SearchStocks` operationId).
	SearchStocks(ctx context.Context, params *SearchStocksParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetStock One stock
	//
	// Identity, price, dividend profile, dividend safety and the 0–10 scores. With a token the price is live; without one it is the last price Quantic stored, with its time.
	//
	// Corresponds with GET /api/v1/stocks/{symbol} (the `GetStock` operationId).
	GetStock(ctx context.Context, symbol string, reqEditors ...RequestEditorFn) (*http.Response, error)
}

type ClientOption func(*genClient) error

type ClientWithResponses struct {
	ClientInterface
}

type ClientWithResponsesInterface interface {

	// GetCalendarWithResponse Upcoming ex-dividend dates
	//
	// Every stock Quantic tracks going ex-dividend in the next `days` days, soonest first. Public: no token needed. Buy before the ex-date to receive the next dividend.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/calendar (the `GetCalendar` operationId).
	GetCalendarWithResponse(ctx context.Context, params *GetCalendarParams, reqEditors ...RequestEditorFn) (*GetCalendarResponse, error)

	// ListDividendsWithResponse Your received dividends
	//
	// Dividends paid to you, newest first.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/dividends (the `ListDividends` operationId).
	ListDividendsWithResponse(ctx context.Context, params *ListDividendsParams, reqEditors ...RequestEditorFn) (*ListDividendsResponse, error)

	// ListHoldingsWithResponse Your holdings
	//
	// Each position's shares and average cost, from the ledger: cost basis, no live prices.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/holdings (the `ListHoldings` operationId).
	ListHoldingsWithResponse(ctx context.Context, params *ListHoldingsParams, reqEditors ...RequestEditorFn) (*ListHoldingsResponse, error)

	// GetIncomeWithResponse Your dividend income outlook
	//
	// Forward annual dividend income at today's rates, in your preferred currency, gross and net of estimated foreign withholding; the holdings it comes from; a year-by-year projection; and how a typical year's income falls across the months.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/income (the `GetIncome` operationId).
	GetIncomeWithResponse(ctx context.Context, params *GetIncomeParams, reqEditors ...RequestEditorFn) (*GetIncomeResponse, error)

	// GetMeWithResponse The user the token belongs to
	//
	// Also the cheapest way to check that a token works.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/me (the `GetMe` operationId).
	GetMeWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetMeResponse, error)

	// ListPortfoliosWithResponse Your portfolios
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/portfolios (the `ListPortfolios` operationId).
	ListPortfoliosWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListPortfoliosResponse, error)

	// SearchStocksWithResponse Search stocks
	//
	// By ticker or company name, up to about 10 matches. Anonymous callers search the stocks Quantic already tracks; with a token the search also asks the market-data provider.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/stocks (the `SearchStocks` operationId).
	SearchStocksWithResponse(ctx context.Context, params *SearchStocksParams, reqEditors ...RequestEditorFn) (*SearchStocksResponse, error)

	// GetStockWithResponse One stock
	//
	// Identity, price, dividend profile, dividend safety and the 0–10 scores. With a token the price is live; without one it is the last price Quantic stored, with its time.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/stocks/{symbol} (the `GetStock` operationId).
	GetStockWithResponse(ctx context.Context, symbol string, reqEditors ...RequestEditorFn) (*GetStockResponse, error)
}

type Config struct {
	// BaseURL is where Quantic is: https://quantic.finance, or a local
	// Phoenix server in development. The API's paths are added to it.
	BaseURL string

	// UserAgent names the client in Quantic's logs, e.g. "quantic-cli/v0.1.0".
	UserAgent string

	// Token is sent as "Authorization: Bearer …" on every request; zero
	// means signed out. Go's http.Client drops the header if a redirect
	// leads to another host, so it only ever goes to BaseURL's.
	Token auth.Secret

	// Transport sends the requests; nil means http.DefaultTransport. Tests
	// replace it to count or break requests.
	Transport http.RoundTripper
}

type Dividend struct {
	// Amount Gross.
	Amount Money `json:"amount"`

	// Date Pay date.
	Date openapi_types.Date `json:"date"`
	Isin *string            `json:"isin,omitempty"`
	Name *string            `json:"name,omitempty"`

	// Net What reached you.
	Net            Money  `json:"net"`
	PerShareAmount *Money `json:"per_share_amount,omitempty"`

	// Portfolio Which portfolio, when you have more than one and didn't pick one.
	Portfolio *string `json:"portfolio,omitempty"`

	// Quantity Shares it was paid on.
	Quantity *int `json:"quantity,omitempty"`

	// Source How it was recorded, e.g. manual or an import.
	Source *string `json:"source,omitempty"`

	// Symbol Example: KO
	Symbol string `json:"symbol"`

	// WithholdingTax Withheld abroad.
	WithholdingTax *Money `json:"withholding_tax,omitempty"`
}

type DividendList struct {
	Dividends []Dividend `json:"dividends"`
}

type Error struct {
	Error struct {
		// Code Stable, for programs to branch on.
		Code ErrorErrorCode `json:"code"`

		// Message For humans; may change.
		Message string `json:"message"`
	} `json:"error"`
}

type ErrorErrorCode string

type GetCalendarParams struct {
	// Days How far ahead, 1 to 120. Default 45.
	Days *int `form:"days,omitempty" json:"days,omitempty"`
}

type GetCalendarResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Calendar
	// JSON422 the response for an HTTP 422 `application/json` response
	JSON422 *Error
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *Error
}

type GetIncomeParams struct {
	// Years Projection horizon, 1 to 50. Default 10.
	Years *int `form:"years,omitempty" json:"years,omitempty"`

	// Drip Compound reinvested dividends. Default false.
	Drip *bool `form:"drip,omitempty" json:"drip,omitempty"`

	// Portfolio A portfolio name or slug, case-insensitive. Omitted: all portfolios.
	Portfolio *string `form:"portfolio,omitempty" json:"portfolio,omitempty"`
}

type GetIncomeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Income
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON422 the response for an HTTP 422 `application/json` response
	JSON422 *Error
}

type GetMeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Me
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
}

type GetStockResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Stock
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *Error
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *Error
}

type Holding struct {
	// AverageCost Per share, in the currency the position trades in; full precision.
	AverageCost    Money   `json:"average_cost"`
	InstrumentType *string `json:"instrument_type,omitempty"`
	Isin           *string `json:"isin,omitempty"`
	Name           *string `json:"name"`

	// Portfolio Which portfolio, when you have more than one and didn't pick one.
	Portfolio *string `json:"portfolio,omitempty"`
	Sector    *string `json:"sector,omitempty"`

	// Shares A decimal string: shares can be fractional.
	Shares string `json:"shares"`

	// Symbol Example: KO
	Symbol string `json:"symbol"`
}

type HoldingList struct {
	Holdings []Holding `json:"holdings"`
}

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

type Income struct {
	// AnnualIncome Forward, at today's rates, gross.
	AnnualIncome Money `json:"annual_income"`

	// CurrentYieldPct A percentage.
	CurrentYieldPct *float64 `json:"current_yield_pct,omitempty"`
	Drip            bool     `json:"drip"`

	// GrowthRate Income-weighted dividend growth, a fraction.
	GrowthRate *float64 `json:"growth_rate,omitempty"`

	// Holdings Where the income comes from, biggest first.
	Holdings []struct {
		// Cagr5y A fraction.
		Cagr5y *float64 `json:"cagr_5y,omitempty"`

		// Growth A fraction.
		Growth *float64 `json:"growth,omitempty"`

		// Income An amount and its currency. The amount is a decimal string, never a float.
		Income Money `json:"income"`

		// NetIncome An amount and its currency. The amount is a decimal string, never a float.
		NetIncome Money `json:"net_income"`

		// Streak Consecutive years of increases.
		Streak *int   `json:"streak,omitempty"`
		Symbol string `json:"symbol"`
	} `json:"holdings"`

	// IncomeYear How a typical year's income falls across the months. Null for a portfolio too small for the shape to mean anything.
	IncomeYear *struct {
		// AverageMonth An amount and its currency. The amount is a decimal string, never a float.
		AverageMonth  *Money `json:"average_month,omitempty"`
		BiggestMonths *[]int `json:"biggest_months,omitempty"`

		// BiggestMonthsShare Share of the year in the biggest months. 0.25 is perfectly even.
		BiggestMonthsShare *float64 `json:"biggest_months_share,omitempty"`

		// ByMonth Keyed by month, "1" to "12", every month present.
		ByMonth          *map[string]Money `json:"by_month,omitempty"`
		EmptyMonths      *[]int            `json:"empty_months,omitempty"`
		NetOfWithholding *bool             `json:"net_of_withholding,omitempty"`

		// ThinMonths Below average, thinnest first.
		ThinMonths *[]int `json:"thin_months,omitempty"`
	} `json:"income_year,omitempty"`

	// NetAnnualIncome The same, net of estimated foreign withholding.
	NetAnnualIncome Money `json:"net_annual_income"`

	// Projection One entry per year, from 0 (now) to `years`.
	Projection []struct {
		// Income An amount and its currency. The amount is a decimal string, never a float.
		Income Money `json:"income"`

		// NetIncome An amount and its currency. The amount is a decimal string, never a float.
		NetIncome  Money `json:"net_income"`
		YearOffset int   `json:"year_offset"`
	} `json:"projection"`
	Years int `json:"years"`
}

type ListDividendsParams struct {
	// Symbol Only this ticker. An unknown one matches nothing.
	Symbol *string `form:"symbol,omitempty" json:"symbol,omitempty"`

	// From Paid on or after.
	From *openapi_types.Date `form:"from,omitempty" json:"from,omitempty"`

	// To Paid on or before.
	To *openapi_types.Date `form:"to,omitempty" json:"to,omitempty"`

	// Portfolio A portfolio name or slug, case-insensitive. Omitted: all portfolios, and each row says which one it is in when you have more than one.
	Portfolio *string `form:"portfolio,omitempty" json:"portfolio,omitempty"`
}

type ListDividendsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *DividendList
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON422 the response for an HTTP 422 `application/json` response
	JSON422 *Error
}

type ListHoldingsParams struct {
	// Portfolio A portfolio name or slug, case-insensitive. Omitted: all portfolios, and each row says which one it is in when you have more than one.
	Portfolio *string `form:"portfolio,omitempty" json:"portfolio,omitempty"`
}

type ListHoldingsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *HoldingList
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
	// JSON422 the response for an HTTP 422 `application/json` response
	JSON422 *Error
}

type ListPortfoliosResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *PortfolioList
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *Error
}

type Me struct {
	Email string             `json:"email"`
	Id    openapi_types.UUID `json:"id"`
	Name  *string            `json:"name,omitempty"`

	// PreferredCurrency ISO 4217; the currency aggregates are reported in.
	//
	// Example: EUR
	PreferredCurrency string `json:"preferred_currency"`
}

type Money struct {
	// Amount Example: 12.34
	Amount string `json:"amount"`

	// Currency ISO 4217
	//
	// Example: EUR
	Currency string `json:"currency"`
}

type Portfolio struct {
	Default bool   `json:"default"`
	Name    string `json:"name"`

	// Slug Present only when the portfolio is shared.
	Slug *string `json:"slug,omitempty"`
}

type PortfolioList struct {
	Portfolios []Portfolio `json:"portfolios"`
}

type RequestEditorFn func(ctx context.Context, req *http.Request) error

type SearchStocksParams struct {
	// Q Ticker or name.
	Q string `form:"q" json:"q"`
}

type SearchStocksResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *StockSearch
	// JSON422 the response for an HTTP 422 `application/json` response
	JSON422 *Error
	// JSON429 the response for an HTTP 429 `application/json` response
	JSON429 *Error
}

type StatusError struct {
	Status  int
	Code    string
	Message string
}

type Stock struct {
	// Currency The currency it trades in.
	Currency string `json:"currency"`
	Dividend struct {
		// Annual Per share, per year, from the live quote. Null without a token.
		Annual *Money `json:"annual,omitempty"`

		// Cagr5y A fraction.
		Cagr5y         *float64            `json:"cagr_5y,omitempty"`
		ExDividendDate *openapi_types.Date `json:"ex_dividend_date,omitempty"`

		// Frequency Example: quarterly
		Frequency     *string             `json:"frequency,omitempty"`
		PaymentMonths []int               `json:"payment_months"`
		Safety        StockDividendSafety `json:"safety"`

		// StreakYears Consecutive years of increases.
		StreakYears *int `json:"streak_years,omitempty"`

		// YieldAvg5yPct The average yield over about 5 years, a percentage.
		YieldAvg5yPct *float64 `json:"yield_avg_5y_pct,omitempty"`

		// YieldPct A percentage.
		YieldPct *float64 `json:"yield_pct,omitempty"`
	} `json:"dividend"`
	Industry *string `json:"industry,omitempty"`

	// InstrumentType Example: equity
	InstrumentType *string `json:"instrument_type,omitempty"`
	Name           *string `json:"name,omitempty"`

	// Price Money, plus whether it is live. Live with a token; without one, the last price Quantic stored and when. Null when there is neither.
	Price *struct {
		// Amount Example: 12.34
		Amount string `json:"amount"`

		// AsOf When the stored price was seen. Null for a live price.
		AsOf *time.Time `json:"as_of,omitempty"`

		// Currency ISO 4217
		//
		// Example: EUR
		Currency string `json:"currency"`
		Live     bool   `json:"live"`
	} `json:"price"`

	// Scores Quantic's 0–10 lenses.
	Scores struct {
		Momentum *float64 `json:"momentum,omitempty"`
		Rating   *float64 `json:"rating,omitempty"`
		Value    *float64 `json:"value,omitempty"`
	} `json:"scores"`
	Sector *string `json:"sector,omitempty"`

	// Symbol Example: KO
	Symbol string `json:"symbol"`
}

type StockDividendSafety string

type StockSearch struct {
	Results []struct {
		Exchange *string `json:"exchange,omitempty"`
		Name     *string `json:"name,omitempty"`
		Symbol   string  `json:"symbol"`

		// Tracked Quantic has data for it, so /api/v1/stocks/{symbol} answers.
		Tracked bool `json:"tracked"`

		// Type Example: EQUITY
		Type *string `json:"type,omitempty"`
	} `json:"results"`
}

type UnreachableError struct {
	Host string
	Err  error
}