httpapi

type AssistantOutcome assistant.Outcome

type AssistantSettings assistant.Settings

type AssistantStatus assistant.Status

type AssistantTerms assistant.TermsProposal

type AssistantTest assistant.TestResult

type AssistantTurn assistant.Turn

type AssistantUsage assistant.UsageList

type AuthSession struct {
	SetupRequired  bool         `json:"setupRequired" doc:"nobody can sign in yet: show the setup wizard"`
	SetupNeedsCode bool         `json:"setupNeedsCode" doc:"the wizard must ask for the setup code (request not from the server's machine)"`
	HasHousehold   bool         `json:"hasHousehold" doc:"a household exists (made with exhale init); setup only creates the owner's login"`
	User           *SessionUser `json:"user,omitempty"`
	Language       string       `json:"language,omitempty" doc:"the language to show the signed-in person: their own, else the household's"`
	TelegramBot    string       `json:"telegramBot,omitempty" doc:"username of the Telegram bot, when Telegram is enabled"`
	SSO            *SSOInfo     `` /* 133-byte string literal not displayed */
	// PasswordLoginDisabled hides the password forms: sign-in, sign-up and
	// join only go through the provider.
	PasswordLoginDisabled bool `json:"passwordLoginDisabled" doc:"password sign-in is turned off: only show single sign-on"`
	Assistant             bool `json:"assistant" doc:"the built-in assistant is on: show Ask Exhale"`
	// TwoFactor is set by a sign-in whose password was right and that now
	// needs a code (ADR 0025).
	TwoFactor *TwoFactorStep `json:"twoFactor,omitempty" doc:"the password was right; send a code to /api/v1/auth/login/two-factor to finish signing in"`
}

type Config struct {
	Version string
	// TrustLocal lets requests from this machine act as the household owner
	// without signing in (development and scripts). Off by default since web
	// sign-in shipped.
	TrustLocal bool
	// SecureCookies marks the session cookie Secure; set it when Exhale is
	// served over HTTPS (behind a reverse proxy).
	SecureCookies bool
	// Telegram configures and reports the household's bot (nil when not
	// available, e.g. in tests).
	Telegram TelegramControl
	// Channels runs the notify-only channels: email, ntfy and webhooks
	// (nil when not available, e.g. when exporting the OpenAPI document).
	Channels *notifiers.Manager
	// Slack configures and reports the team's Slack app (nil when not
	// available, e.g. in tests).
	Slack SlackControl
	// Assistant is the model Exhale itself uses (ADR 0018, part B). When
	// nil, one is made that is off until an owner sets it up in the web.
	Assistant *assistant.Assistant
	Log       *slog.Logger
	// PublicURL is the address people reach Exhale at, e.g.
	// https://exhale.example.com. Single sign-on builds its redirect URI
	// from it; without it only this machine's own address works.
	PublicURL string
	// OIDC enables sign-in with an OpenID Connect provider (nil: off).
	OIDC *auth.OIDC
	// DisablePasswordLogin turns password sign-in off. Only honoured when
	// OIDC is set.
	DisablePasswordLogin bool
	// OAuth is the authorization server of remote MCP (ADR 0024). When nil
	// one is made over the service's store; tests pass their own clock.
	OAuth *oauth.Service
}

type ConnectedApps struct {
	Apps []oauth.App `json:"apps"`
	// MCPURL is the address to give a cloud assistant; empty when the
	// server has no public URL.
	MCPURL string `json:"mcpUrl" doc:"the MCP address to give Claude.ai, ChatGPT or Grok; empty without EXHALE_PUBLIC_URL"`
}

type FeedStatus struct {
	Enabled   bool   `json:"enabled"`
	CreatedAt string `json:"createdAt,omitempty"`
	// Path is returned only when the link is created: Exhale keeps a hash.
	Path string `json:"path,omitempty" doc:"Path of the feed, shown once. Prefix it with the address of this Exhale."`
}

type ImportReviewOut struct {
	Waiting bool              `json:"waiting"`
	Review  *assistant.Review `json:"review,omitempty"`
}

type MemberDone struct {
	OK bool `json:"ok"`
}

type OAuthRequestInfo struct {
	ClientName   string `json:"clientName"`
	Verified     bool   `` /* 146-byte string literal not displayed */
	ClientHost   string `json:"clientHost,omitempty" doc:"host of that address, when verified"`
	ClientURI    string `json:"clientUri,omitempty" doc:"the application's home page, as it describes itself"`
	RedirectHost string `json:"redirectHost" doc:"where the browser goes after the answer"`
	Loopback     bool   `json:"loopback" doc:"the answer goes to a program on this computer"`
	MaxScope     string `json:"maxScope" enum:"read,write" doc:"the most the application asked for; the person may give less"`
	MemberName   string `json:"memberName" doc:"the application will act as this member"`
}

type SSOInfo struct {
	Name string `json:"name" doc:"what the sign-in button says after \"Continue with\""`
}

type SessionUser struct {
	ID          string      `json:"id"`
	Name        string      `json:"name"`
	Email       string      `json:"email"`
	Role        domain.Role `json:"role"`
	HasPassword bool        `json:"hasPassword" doc:"the account has a password (accounts made through single sign-on have none)"`
	SSOHost     string      `json:"ssoHost,omitempty" doc:"host of the identity provider this account is linked to, if any"`
	Locale      string      `json:"locale,omitempty" doc:"the language this person chose; empty: the household's"`
}

type SlackConfig slack.Config

type SlackControl interface {
	Status(ctx context.Context) slack.Status
	Configure(ctx context.Context, in slack.Config) (slack.Status, error)
	Remove(ctx context.Context) (slack.Status, error)
}

type SlackLinkCode struct {
	Code    string    `json:"code"`
	Command string    `json:"command" doc:"what to type in Slack, anywhere"`
	URL     string    `json:"url,omitempty" doc:"link that opens the app in Slack, when it is connected"`
	Expires time.Time `json:"expiresAt"`
}

type SlackStatus slack.Status

type TelegramControl interface {
	Status(ctx context.Context) telegram.BotStatus
	Configure(ctx context.Context, token string) (telegram.BotStatus, error)
	Remove(ctx context.Context) (telegram.BotStatus, error)
	Username() string
}

type TwoFactorStep struct {
	Token     string    `json:"token" doc:"send it back with the code; it works for a few minutes"`
	ExpiresAt time.Time `json:"expiresAt"`
}