models

type ActiveMedia struct {
	Started    time.Time `json:"started"`
	RelPath    *string   `json:"relativePath,omitempty"`
	PositionMs *int64    `json:"positionMs,omitempty"`
	DurationMs *int64    `json:"durationMs,omitempty"`
	// Track is what the tags of an audio track played in-process say about
	// it, omitted when it has none or they have not been read yet.
	Track            *TrackInfo         `json:"track,omitempty"`
	PlaybackState    MediaPlaybackState `json:"playbackState,omitempty"`
	LauncherID       string             `json:"launcherId"`
	SystemID         string             `json:"systemId"`
	SystemName       string             `json:"systemName"`
	Path             string             `json:"mediaPath"`
	Name             string             `json:"mediaName"`
	Slot             string             `json:"slot,omitempty"`
	LauncherControls []string           `json:"launcherControls,omitempty"`
	MediaID          int64              `json:"mediaId,omitempty"`
}

type ActiveMediaQueryParams struct {
	Slot string `json:"slot,omitempty"`
}

type ActiveMediaResponse struct {
	ZapScript string `json:"zapScript"`
	ActiveMedia
}

type ActiveProfile struct {
	LimitsEnabled *bool   `json:"limitsEnabled,omitempty"`
	DailyLimit    *string `json:"dailyLimit,omitempty"`
	SessionLimit  *string `json:"sessionLimit,omitempty"`
	ProfileID     string  `json:"profileId"`
	Name          string  `json:"name"`
	Role          string  `json:"role"`
	HasPIN        bool    `json:"hasPin"`
}

type AddMappingParams struct {
	Label    string `json:"label" validate:"max=255"`
	Type     string `json:"type" validate:"required,oneof=id value data uid text"`
	Match    string `json:"match" validate:"required,oneof=exact partial regex"`
	Pattern  string `json:"pattern" validate:"required"`
	Override string `json:"override"`
	Enabled  bool   `json:"enabled"`
}

type AllMappingsParams struct {
	// IncludeReadOnly also returns read-only mappings loaded from the mappings
	// folder. Defaults to false so older clients keep receiving DB mappings only.
	IncludeReadOnly bool `json:"includeReadOnly,omitempty"`
}

type AllMappingsResponse struct {
	Mappings []MappingResponse `json:"mappings"`
}

type AuthLinkStatusResponse struct {
	ExpiresAt               *time.Time `json:"expiresAt,omitempty"`
	Status                  string     `json:"status"`
	UserCode                string     `json:"userCode,omitempty"`
	VerificationURL         string     `json:"verificationUrl,omitempty"`
	VerificationURLComplete string     `json:"verificationUrlComplete,omitempty"`
	Error                   string     `json:"error,omitempty"`
}

type BackupCategoryStatus struct {
	Files   int64 `json:"files"`
	Bytes   int64 `json:"bytes"`
	Enabled bool  `json:"enabled"`
}

type BackupNameParams struct {
	Name string `json:"name" validate:"required"`
}

type BackupRemoteRestoreParams struct {
	ID string `json:"id" validate:"required"`
}

type BackupStateNotification struct {
	Operation string `json:"operation,omitempty"`
	Paused    bool   `json:"paused"`
	Throttled bool   `json:"throttled"`
	Finished  bool   `json:"finished,omitempty"`
}

type BackupStatusEntry struct {
	LastRunAt             *string                         `json:"lastRunAt,omitempty"`
	LastSuccessAt         *string                         `json:"lastSuccessAt,omitempty"`
	LastSnapshotCreatedAt *string                         `json:"lastSnapshotCreatedAt,omitempty"`
	AvailabilityCheckedAt *string                         `json:"availabilityCheckedAt,omitempty"`
	DeviceName            *string                         `json:"deviceName,omitempty"`
	LinkedAt              *string                         `json:"linkedAt,omitempty"`
	Categories            map[string]BackupCategoryStatus `json:"categories,omitempty"`
	Schedule              string                          `json:"schedule,omitempty"`
	LastError             string                          `json:"lastError,omitempty"`
	Availability          string                          `json:"availability,omitempty"`
	LastStatus            string                          `json:"lastStatus"`
	Warnings              []BackupWarning                 `json:"warnings,omitempty"`
	LastBackupSize        int64                           `json:"lastBackupSize"`
	SkippedFiles          int                             `json:"skippedFiles,omitempty"`
	Linked                bool                            `json:"linked,omitempty"`
	Enabled               bool                            `json:"enabled"`
	// LastRunNoChanges marks the most recent successful run as verified-
	// unchanged: the server already held an identical snapshot, so nothing
	// new was stored. LastSuccessAt still advances on such runs;
	// LastSnapshotCreatedAt is when the stored content last changed.
	LastRunNoChanges bool `json:"lastRunNoChanges,omitempty"`
}

type BackupStatusResponse struct {
	ActiveSince     *string           `json:"activeSince,omitempty"`
	ActiveOperation string            `json:"activeOperation,omitempty"`
	Local           BackupStatusEntry `json:"local"`
	Remote          BackupStatusEntry `json:"remote"`
}

type BackupWarning struct {
	Category string `json:"category"`
	Path     string `json:"path"`
	Reason   string `json:"reason"`
}

type BrowseEntry struct {
	SystemID  *string `json:"systemId,omitempty"`
	RelPath   *string `json:"relativePath,omitempty"`
	ZapScript *string `json:"zapScript,omitempty"`
	FileCount *int    `json:"fileCount,omitempty"`
	Group     *string `json:"group,omitempty"`
	Path      string  `json:"path"`
	Type      string  `json:"type"`
	Name      string  `json:"name"`
	// CoverColor is the cover thumbnail's average colour as "#rrggbb".
	// Omitted until a thumbnail was built.
	CoverColor         string             `json:"coverColor,omitempty"`
	SystemIDs          []string           `json:"systemIds,omitempty"`
	Tags               []database.TagInfo `json:"tags,omitempty"`
	DisambiguatingTags []database.TagInfo `json:"disambiguatingTags,omitempty"`
	MediaID            int64              `json:"mediaId,omitempty"`
	HasCover           bool               `json:"hasCover"`
	// MultiDisc marks a directory entry that stands for several disc images
	// of one game. Its launch fields point at the disc last played from it, or
	// the first disc; the others are listed by browsing the entry's path.
	MultiDisc bool `json:"multiDisc,omitempty"`
}

type BrowseIndexGroup struct {
	Key    string `json:"key"`
	Label  string `json:"label"`
	Cursor string `json:"cursor"`
	Count  int    `json:"count"`
	Offset int    `json:"offset"`
}

type BrowseIndexResults struct {
	Scheme     string             `json:"scheme"`
	EntryType  string             `json:"entryType"`
	Groups     []BrowseIndexGroup `json:"groups"`
	TotalFiles int                `json:"totalFiles"`
}

type BrowseParams struct {
	Systems     *[]string `json:"systems" validate:"omitempty,dive,min=1"`
	FuzzySystem *bool     `json:"fuzzySystem,omitempty"`
	Path        *string   `json:"path,omitempty"`
	RootView    *string   `json:"rootView,omitempty" validate:"omitempty,oneof=routes contents"`
	MaxResults  *int      `json:"maxResults,omitempty" validate:"omitempty,gt=0,max=1000"`
	Cursor      *string   `json:"cursor,omitempty"`
	Tags        *[]string `json:"tags,omitempty" validate:"omitempty,dive,min=1"`
	Letter      *string   `json:"letter,omitempty" validate:"omitempty,letter"`
	Sort        *string   `json:"sort,omitempty" validate:"omitempty,oneof=name-asc name-desc filename-asc filename-desc"`
	// Offset starts the page at this absolute position in the listing,
	// directories first, then files.
	Offset *int `json:"offset,omitempty" validate:"omitempty,gte=0"`
	// AnchorPath returns the page holding this path, starting at the largest
	// multiple of the page size that is not after the path's position.
	AnchorPath    *string `json:"anchorPath,omitempty" validate:"omitempty,min=1"`
	IncludeHidden bool    `json:"includeHidden,omitempty"`
	// Live lists Path straight from disk instead of from the media index,
	// for folders the index does not cover.
	Live bool `json:"live,omitempty"`
}

type BrowseResults struct {
	Pagination *PaginationInfo `json:"pagination,omitempty"`
	// RelPath is the browsed directory's own launcher-relative path. Set
	// only for a single-system browse of a folder under that system's
	// launcher folders.
	RelPath    *string       `json:"relativePath,omitempty"`
	Path       string        `json:"path"`
	Entries    []BrowseEntry `json:"entries"`
	TotalFiles int           `json:"totalFiles"`
	TotalDirs  int           `json:"totalDirs"`
}

type CategorizedError struct {
	Err      error
	Params   map[string]string
	Category string
	Message  string
	Reason   string
}

type ClientError struct {
	Err error
}

type ClientResponse struct {
	Name    string    `json:"name"`
	Address string    `json:"address"`
	Secret  string    `json:"secret"` //nolint:gosec // G117: pairing secret, not a credential
	ID      uuid.UUID `json:"id"`
}

type ClientsCurrentResponse struct {
	Role         *string  `json:"role"`
	Capabilities []string `json:"capabilities"`
	Access       string   `json:"access"`
	Paired       bool     `json:"paired"`
}

type ClientsDeleteParams struct {
	ClientID string `json:"clientId"`
}

type ClientsPairStartParams struct {
	Role string `json:"role" validate:"omitempty,oneof=admin member"`
}

type ClientsPairStartResponse struct {
	PIN       string `json:"pin"`
	ExpiresAt int64  `json:"expiresAt"`
}

type ClientsPairedNotification struct {
	ClientID   string `json:"clientId"`
	ClientName string `json:"clientName"`
}

type ClientsResponse struct {
	Clients []PairedClient `json:"clients"`
}

type DeckCardScriptInput struct {
	Name      string `json:"name"`
	ZapScript string `json:"zapscript" validate:"required,max=5000"`
}

type DeckCoverInput struct {
	Kind   string `json:"kind" validate:"required,oneof=media file none"`
	System string `json:"system,omitempty"`
	Path   string `json:"path,omitempty"`
}

type DeckItemInput struct {
	ID        *int64                `json:"id,omitempty"`
	MediaID   *int64                `json:"mediaId,omitempty"`
	Metadata  json.RawMessage       `json:"metadata,omitempty"`
	Kind      string                `json:"kind" validate:"omitempty,oneof=media script card"`
	Name      string                `json:"name" validate:"max=100"`
	ZapScript string                `json:"zapscript" validate:"max=5000"`
	CardID    string                `json:"cardId" validate:"max=64"`
	System    string                `json:"system"`
	Path      string                `json:"path"`
	Scripts   []DeckCardScriptInput `json:"scripts,omitempty" validate:"omitempty,dive"`
}

type DeckItemMedia struct {
	System string   `json:"system"`
	Path   string   `json:"path"`
	Name   string   `json:"name"`
	Tags   []string `json:"tags,omitempty"`
	// UserTags is the linked file's user utility tags, [] when none is set.
	UserTags  []database.TagInfo `json:"userTags"`
	Available bool               `json:"available"`
}

type DeckItemResponse struct {
	Media     *DeckItemMedia        `json:"media,omitempty"`
	Metadata  json.RawMessage       `json:"metadata,omitempty"`
	Kind      string                `json:"kind"`
	Name      string                `json:"name"`
	ZapScript string                `json:"zapscript,omitempty"`
	CardID    string                `json:"cardId,omitempty"`
	Scripts   []DeckCardScriptInput `json:"scripts,omitempty"`
	ID        int64                 `json:"id"`
	Position  int                   `json:"position"`
	// HasImage reports card art decks.image can serve for a card item.
	HasImage bool `json:"hasImage"`
}

type DeckResponse struct {
	Metadata    json.RawMessage    `json:"metadata,omitempty"`
	DeckID      string             `json:"deckId"`
	Name        string             `json:"name"`
	Description string             `json:"description"`
	SourceURL   string             `json:"sourceUrl,omitempty"`
	OwnedBy     string             `json:"ownedBy,omitempty"`
	Items       []DeckItemResponse `json:"items,omitzero"`
	// ContainsItemIDs lists the items linked to the game the decks list was
	// asked about, and is omitted when it was asked about none.
	ContainsItemIDs []int64 `json:"containsItemIds,omitzero"`
	CreatedAt       int64   `json:"createdAt"`
	UpdatedAt       int64   `json:"updatedAt"`
	ItemCount       int     `json:"itemCount"`
	Owned           bool    `json:"owned"`
	Locked          bool    `json:"locked"`
	Saved           bool    `json:"saved"`
	// HasImage reports a cover decks.image can serve.
	HasImage bool `json:"hasImage"`
}

type DecksChangedNotification struct {
	DeckID string `json:"deckId"`
	Action string `json:"action"`
}

type DecksDeleteParams struct {
	DeckID string `json:"deckId" validate:"required,min=1"`
}

type DecksGetParams struct {
	DeckID string `json:"deckId" validate:"required,min=1"`
}

type DecksImageParams struct {
	ItemID   *int64 `json:"itemId,omitempty"`
	MaxSize  *int32 `json:"maxSize,omitempty" validate:"omitempty,gt=0,max=8192"`
	DeckID   string `json:"deckId" validate:"required,min=1"`
	Delivery string `json:"delivery,omitempty" validate:"omitempty,oneof=inline localPath"`
}

type DecksNewParams struct {
	Name        string          `json:"name" validate:"required,min=1,max=100"`
	Description string          `json:"description" validate:"max=1000"`
	Items       []DeckItemInput `json:"items" validate:"max=120,dive"`
}

type DecksOpenParams struct {
	DeckID string `json:"deckId" validate:"required,min=1"`
	Slot   string `json:"slot"`
}

type DecksParams struct {
	System *string `json:"system" validate:"omitempty,min=1"`
	Path   *string `json:"path" validate:"omitempty,min=1"`
}

type DecksResponse struct {
	Decks []DeckResponse `json:"decks"`
}

type DecksUpdateParams struct {
	Name          *string          `json:"name" validate:"omitempty,min=1,max=100"`
	Description   *string          `json:"description" validate:"omitempty,max=1000"`
	Items         *[]DeckItemInput `json:"items" validate:"omitempty,max=120,dive"`
	Cover         *DeckCoverInput  `json:"cover"`
	DeckID        string           `json:"deckId" validate:"required,min=1"`
	AddItems      []DeckItemInput  `json:"addItems" validate:"omitempty,max=120,dive"`
	RemoveItemIDs []int64          `json:"removeItemIds"`
}

type DeleteClientParams struct {
	ID string `json:"id" validate:"required,min=1"`
}

type DeleteInboxParams struct {
	ID int64 `json:"id" validate:"gt=0"`
}

type DeleteMappingParams struct {
	ID int `json:"id" validate:"gt=0"`
}

type DeleteProfileParams struct {
	ProfileID string `json:"profileId" validate:"required,min=1"`
}

type DeviceBattery struct {
	Percent       *int    `json:"percent"`
	ChargeState   *string `json:"chargeState"`
	TimeRemaining *int64  `json:"timeRemaining,omitempty"`
	ID            string  `json:"id"`
}

type DeviceBluetooth struct {
	Powered *bool `json:"powered"`
	Present bool  `json:"present"`
}

type DeviceBluetoothDevice struct {
	Name *string `json:"name"`
	// DisplayName is the device's model name when Core knows its vendor and
	// product IDs. Clients fall back to Name.
	DisplayName *string `json:"displayName"`
	// VendorID and ProductID are four lowercase hex digits, from the device's
	// modalias.
	VendorID  *string `json:"vendorId"`
	ProductID *string `json:"productId"`
	// ControllerID is the matching device.status controller while the device
	// is connected.
	ControllerID *string `json:"controllerId"`
	ID           string  `json:"id"`
	Paired       bool    `json:"paired"`
	Connected    bool    `json:"connected"`
	Trusted      bool    `json:"trusted"`
	Gamepad      bool    `json:"gamepad"`
}

type DeviceBluetoothDeviceParams struct {
	ID string `json:"id" validate:"required"`
}

type DeviceBluetoothPairing struct {
	Error *string `json:"error"`
	ID    string  `json:"id"`
	State string  `json:"state"`
	// Attempt numbers pair requests in the order Core accepted them, so a
	// client can tell a repeat outcome from the one before it and a reply
	// from a later notification.
	Attempt int `json:"attempt"`
}

type DeviceBluetoothScanParams struct {
	TimeoutSeconds *int `json:"timeoutSeconds" validate:"omitempty,min=1,max=120"`
	All            bool `json:"all"`
}

type DeviceBluetoothState struct {
	Pairing  *DeviceBluetoothPairing `json:"pairing"`
	Devices  []DeviceBluetoothDevice `json:"devices"`
	Powered  bool                    `json:"powered"`
	Scanning bool                    `json:"scanning"`
}

type DeviceCapabilities struct {
	Sections map[string]string `json:"sections"`
	Actions  map[string]string `json:"actions"`
}

type DeviceChangedDisplay struct {
	Docked *bool `json:"docked"`
}

type DeviceChangedNetwork struct {
	Internet *string `json:"internet"`
	Type     string  `json:"type"`
}

type DeviceChangedNotification struct {
	Power       *DeviceChangedPower   `json:"power"`
	Network     *DeviceChangedNetwork `json:"network"`
	Bluetooth   *DeviceBluetooth      `json:"bluetooth"`
	Display     *DeviceChangedDisplay `json:"display"`
	Controllers *DeviceControllers    `json:"controllers"`
	Time        *DeviceChangedTime    `json:"time"`
}

type DeviceChangedPower struct {
	Percent     *int    `json:"percent"`
	Source      *string `json:"source"`
	ChargeState *string `json:"chargeState"`
	Present     bool    `json:"present"`
}

type DeviceChangedTime struct {
	ClockReliable bool `json:"clockReliable"`
}

type DeviceController struct {
	Name *string `json:"name"`
	// DisplayName is the controller's model name when Core knows its vendor
	// and product IDs. Clients fall back to Name.
	DisplayName *string                  `json:"displayName"`
	VendorID    *string                  `json:"vendorId"`
	ProductID   *string                  `json:"productId"`
	Battery     *DeviceControllerBattery `json:"battery"`
	ID          string                   `json:"id"`
	Connection  string                   `json:"connection"`
}

type DeviceControllerBattery struct {
	Percent     *int    `json:"percent"`
	ChargeState *string `json:"chargeState"`
	Level       string  `json:"level"`
}

type DeviceControllers struct {
	Items []DeviceController `json:"items"`
	Count int                `json:"count"`
}

type DeviceDisplay struct {
	Docked            *bool `json:"docked"`
	InternalPanel     bool  `json:"internalPanel"`
	InternalActive    bool  `json:"internalActive"`
	ExternalConnected bool  `json:"externalConnected"`
	ExternalActive    bool  `json:"externalActive"`
}

type DeviceInterface struct {
	Name      string   `json:"name"`
	Type      string   `json:"type"`
	Addresses []string `json:"addresses"`
	Up        bool     `json:"up"`
}

type DeviceNetwork struct {
	Interface  *string           `json:"interface"`
	Internet   *string           `json:"internet"`
	Type       string            `json:"type"`
	Interfaces []DeviceInterface `json:"interfaces"`
}

type DevicePower struct {
	Percent       *int            `json:"percent"`
	Source        *string         `json:"source"`
	ChargeState   *string         `json:"chargeState"`
	TimeRemaining *int64          `json:"timeRemaining,omitempty"`
	Batteries     []DeviceBattery `json:"batteries"`
	Present       bool            `json:"present"`
}

type DeviceStatusResponse struct {
	Power        *DevicePower       `json:"power"`
	Network      *DeviceNetwork     `json:"network"`
	Bluetooth    *DeviceBluetooth   `json:"bluetooth"`
	Storage      *DeviceStorage     `json:"storage"`
	Display      *DeviceDisplay     `json:"display"`
	Controllers  *DeviceControllers `json:"controllers"`
	Time         *DeviceTime        `json:"time"`
	System       *DeviceSystem      `json:"system"`
	Capabilities DeviceCapabilities `json:"capabilities"`
}

type DeviceStorage struct {
	Volumes []DeviceVolume `json:"volumes"`
}

type DeviceSystem struct {
	Model    *string `json:"model"`
	Hostname string  `json:"hostname"`
	Platform string  `json:"platform"`
	OS       string  `json:"os"`
	Arch     string  `json:"arch"`
}

type DeviceTime struct {
	Timezone      *string `json:"timezone"`
	UTCOffset     int     `json:"utcOffset"`
	ClockReliable bool    `json:"clockReliable"`
}

type DeviceVolume struct {
	Path       string   `json:"path"`
	Roles      []string `json:"roles"`
	TotalBytes uint64   `json:"totalBytes"`
	FreeBytes  uint64   `json:"freeBytes"`
	UsedBytes  uint64   `json:"usedBytes"`
}

type ErrorData struct {
	Params   map[string]string `json:"params,omitempty"`
	Category string            `json:"category"`
	Reason   string            `json:"reason,omitempty"`
}

type ErrorObject struct {
	// Data is optional structured detail about the error. Per JSON-RPC 2.0
	// §5.1 it MUST be a member of the error object, not a sibling.
	Data    any    `json:"data,omitempty"`
	Message string `json:"message"`
	Code    int    `json:"code"`
}

type ExtendPlaytimeParams struct {
	// Duration is the time to add, in Go duration format. Required for
	// mode "duration" and ignored for "today".
	Duration *string `json:"duration" validate:"omitempty,duration"`
	// RequestID makes a grant idempotent across retries. Repeating a
	// request ID reports the original grant instead of adding more time.
	RequestID string `json:"requestId" validate:"omitempty,max=128"`
	// Mode is "duration" or "today".
	Mode string `json:"mode" validate:"required,oneof=duration today"`
}

type ExtendPlaytimeResponse struct {
	Mode             string `json:"mode"`
	Duration         string `json:"duration,omitempty"`
	Expires          string `json:"expires,omitempty"`
	SessionExtension string `json:"sessionExtension,omitempty"`
	ProfileID        string `json:"profileId,omitempty"`
	// Replayed is true when a repeated requestId matched an earlier grant
	// and no additional time was added.
	Replayed bool `json:"replayed"`
}

type HealthCheckResponse struct {
	// Status is kept for callers matching the historical `"status":"ok"`.
	Status string `json:"status"`
	// State is the coarse lifecycle state: starting, ready or failed. New
	// callers should read this rather than Status.
	State string `json:"state"`
}

type HistoryResponse struct {
	Entries []HistoryResponseEntry `json:"entries"`
}

type HistoryResponseEntry struct {
	Time    time.Time `json:"time"`
	Type    string    `json:"type"`
	UID     string    `json:"uid"`
	Text    string    `json:"text"`
	Data    string    `json:"data"`
	Success bool      `json:"success"`
}

type InboxMessage struct {
	CreatedAt time.Time `json:"createdAt"`
	Title     string    `json:"title"`
	Body      string    `json:"body,omitempty"`
	Category  string    `json:"category,omitempty"`
	ID        int64     `json:"id"`
	Severity  int       `json:"severity"`
	ProfileID int64     `json:"profileId,omitempty"`
}

type InboxResponse struct {
	Messages []InboxMessage `json:"messages"`
}

type IndexingScanResponse struct {
	Path    string `json:"path"`
	Entries int    `json:"entries"`
}

type IndexingStatusResponse struct {
	TotalSteps         *int    `json:"totalSteps,omitempty"`
	CurrentStep        *int    `json:"currentStep,omitempty"`
	CurrentStepDisplay *string `json:"currentStepDisplay,omitempty"`
	TotalFiles         *int    `json:"totalFiles,omitempty"`
	TotalMedia         *int    `json:"totalMedia,omitempty"`
	// MissingMedia is the count of indexed media flagged missing on disk —
	// what media.clean.orphans would remove.
	MissingMedia *int `json:"missingMedia,omitempty"`
	// SystemsCompleted/SystemsTotal report per-system indexing coverage so
	// clients can serve partial results while a scan is still running.
	SystemsCompleted *int `json:"systemsCompleted,omitempty"`
	SystemsTotal     *int `json:"systemsTotal,omitempty"`
	// Scan reports a system's folder scan while it runs. A scan can take many
	// minutes on a large library, and without it nothing visibly moves.
	// Absent outside a scan.
	Scan       *IndexingScanResponse `json:"scan,omitempty"`
	Exists     bool                  `json:"exists"`
	Indexing   bool                  `json:"indexing"`
	Optimizing bool                  `json:"optimizing"`
	Paused     bool                  `json:"paused"`
	// Throttled reports that indexing is running at reduced speed while
	// media plays.
	Throttled bool `json:"throttled,omitempty"`
}

type InputGamepadParams struct {
	Buttons string `json:"buttons" validate:"required,min=1"`
}

type InputKeyboardParams struct {
	Keys string `json:"keys" validate:"required,min=1"`
}

type Launcher struct {
	LauncherRuntime
	Detected           *bool    `json:"detected,omitempty"`
	ID                 string   `json:"id"`
	SystemID           string   `json:"systemId,omitempty"`
	SystemName         string   `json:"systemName,omitempty"`
	AvailabilityReason string   `json:"availabilityReason,omitempty"`
	Groups             []string `json:"groups,omitempty"`
	Available          bool     `json:"available"`
	Default            bool     `json:"default,omitempty"`
}

type LauncherRuntime struct {
	MisterCore *MisterCoreInfo `json:"misterCore,omitempty"`
	Backend    string          `json:"backend,omitempty"`
}

type LaunchersParams struct {
	Systems     *[]string `json:"systems,omitempty" validate:"omitempty,dive,min=1"`
	FuzzySystem *bool     `json:"fuzzySystem,omitempty"`
}

type LaunchersResponse struct {
	Launchers []Launcher `json:"launchers"`
}

type LogDownloadResponse struct {
	Filename string `json:"filename"`
	Content  string `json:"content"`
	Size     int    `json:"size"`
}

type MappingResponse struct {
	ID       string `json:"id"`
	Added    string `json:"added"`
	Label    string `json:"label"`
	Type     string `json:"type"`
	Match    string `json:"match"`
	Pattern  string `json:"pattern"`
	Override string `json:"override"`
	// Source identifies where the mapping came from: "database" or "file".
	Source string `json:"source"`
	// ReadOnly is true for mappings that can't be edited via the API (file mappings).
	ReadOnly bool `json:"readOnly"`
	Enabled  bool `json:"enabled"`
}

type MediaActiveImageParams struct {
	MaxSize  *int32 `json:"maxSize,omitempty" validate:"omitempty,gt=0,max=8192"`
	Slot     string `json:"slot,omitempty"`
	Delivery string `json:"delivery,omitempty" validate:"omitempty,oneof=inline localPath"`
}

type MediaAssetParams struct {
	MediaID   *int64 `json:"mediaId,omitempty"`
	Offset    *int64 `json:"offset,omitempty"`
	Length    *int64 `json:"length,omitempty"`
	System    string `json:"system" validate:"omitempty,min=1"`
	Path      string `json:"path" validate:"omitempty,min=1"`
	AssetType string `json:"assetType"`
	ETag      string `json:"etag,omitempty"`
}

type MediaAssetResponse struct {
	NextOffset  *int64 `json:"nextOffset,omitempty"`
	AssetType   string `json:"assetType"`
	TypeTag     string `json:"typeTag"`
	ContentType string `json:"contentType"`
	Extension   string `json:"extension"`
	ETag        string `json:"etag"`
	Data        string `json:"data"`
	Size        int64  `json:"size"`
	Offset      int64  `json:"offset"`
	Length      int64  `json:"length"`
	Complete    bool   `json:"complete"`
}

type MediaCleanOrphansResponse struct {
	Deleted int64 `json:"deleted"`
}

type MediaControlParams struct {
	Args   map[string]string `json:"args,omitempty"`
	Action string            `json:"action" validate:"required,min=1"`
	Slot   string            `json:"slot,omitempty"`
}

type MediaHistoryLatestEntry struct {
	RelPath    *string `json:"relativePath,omitempty"`
	SystemID   string  `json:"systemId"`
	SystemName string  `json:"systemName"`
	MediaName  string  `json:"mediaName"`
	MediaPath  string  `json:"mediaPath"`
	LauncherID string  `json:"launcherId"`
	StartedAt  string  `json:"startedAt"`
}

type MediaHistoryLatestResponse struct {
	Entry *MediaHistoryLatestEntry `json:"entry"`
}

type MediaHistoryParams struct {
	Systems       *[]string `json:"systems,omitempty" validate:"omitempty,dive,min=1"`
	FuzzySystem   *bool     `json:"fuzzySystem,omitempty"`
	DistinctMedia *bool     `json:"distinctMedia,omitempty"`
	Limit         *int      `json:"limit,omitempty" validate:"omitempty,gt=0,max=100"`
	Cursor        *string   `json:"cursor,omitempty"`
}

type MediaHistoryResponse struct {
	Pagination *PaginationInfo             `json:"pagination,omitempty"`
	Entries    []MediaHistoryResponseEntry `json:"entries"`
}

type MediaHistoryResponseEntry struct {
	RelPath *string `json:"relativePath,omitempty"`
	EndedAt *string `json:"endedAt,omitempty"`
	// ZapScript is the title command that launches this media. Omitted when
	// the media is no longer indexed or enrichment failed.
	ZapScript  string `json:"zapScript,omitempty"`
	SystemID   string `json:"systemId"`
	SystemName string `json:"systemName"`
	MediaName  string `json:"mediaName"`
	MediaPath  string `json:"mediaPath"`
	LauncherID string `json:"launcherId"`
	StartedAt  string `json:"startedAt"`
	// SessionSource and SessionConfidence distinguish an externally-timed
	// session's evidence from an estimate; a session Core timed itself is
	// "active_media", and a row predating this distinction is "unspecified".
	SessionSource     string `json:"sessionSource"`
	SessionConfidence string `json:"sessionConfidence"`
	// CoverColor is the cover thumbnail's average colour as "#rrggbb".
	// Omitted until a thumbnail was built.
	CoverColor string `json:"coverColor,omitempty"`
	// Tags is nil when the media is unresolved or tag enrichment failed
	// (key omitted) and an empty slice when the media is indexed but
	// untagged (serialised as []). omitzero keeps that distinction;
	// omitempty would drop the empty array.
	Tags     []database.TagInfo `json:"tags,omitzero"`
	PlayTime int                `json:"playTime"`
	MediaID  int64              `json:"mediaId,omitempty"`
	HasCover bool               `json:"hasCover"`
}

type MediaHistoryTopEntry struct {
	RelPath *string `json:"relativePath,omitempty"`
	// ZapScript follows the same rule as MediaHistoryResponseEntry.ZapScript.
	ZapScript    string `json:"zapScript,omitempty"`
	SystemID     string `json:"systemId"`
	SystemName   string `json:"systemName"`
	MediaName    string `json:"mediaName"`
	MediaPath    string `json:"mediaPath"`
	LastPlayedAt string `json:"lastPlayedAt"`
	// Tags follows the same nil-omitted / empty-array rule as
	// MediaHistoryResponseEntry.Tags.
	Tags          []database.TagInfo `json:"tags,omitzero"`
	TotalPlayTime int                `json:"totalPlayTime"`
	SessionCount  int                `json:"sessionCount"`
	MediaID       int64              `json:"mediaId,omitempty"`
}

type MediaHistoryTopParams struct {
	Systems     *[]string `json:"systems,omitempty" validate:"omitempty,dive,min=1"`
	FuzzySystem *bool     `json:"fuzzySystem,omitempty"`
	Since       *string   `json:"since,omitempty"`
	Limit       *int      `json:"limit,omitempty" validate:"omitempty,gt=0,max=100"`
}

type MediaHistoryTopResponse struct {
	Entries []MediaHistoryTopEntry `json:"entries"`
}

type MediaImageParams struct {
	MediaID *int64 `json:"mediaId,omitempty"`
	// MaxSize is a hint for the longest edge (in pixels) of the returned image.
	// The server resizes down to fit a MaxSize×MaxSize box and caches the result;
	// omit it to receive the full-size image. Requests are snapped to a small set
	// of standard sizes server-side, so the returned image may be larger than
	// requested — clients should downscale to their final display size.
	MaxSize    *int32   `json:"maxSize,omitempty" validate:"omitempty,gt=0,max=8192"`
	System     string   `json:"system"            validate:"omitempty,min=1"`
	Path       string   `json:"path"              validate:"omitempty,min=1"`
	Delivery   string   `json:"delivery,omitempty" validate:"omitempty,oneof=inline localPath"`
	ImageTypes []string `json:"imageTypes"        validate:"omitempty,dive,min=1"`
}

type MediaImageResponse struct {
	Extension   *string `json:"extension,omitempty"`
	ContentType string  `json:"contentType"`
	Data        string  `json:"data,omitempty"`      // base64-encoded blob
	Delivery    string  `json:"delivery"`            // "inline" or "localPath"
	LocalPath   string  `json:"localPath,omitempty"` // transient Core-owned thumbnail path
	TypeTag     string  `json:"typeTag"`             // e.g. "property:image-boxart"
}

type MediaIndexParams struct {
	Systems     *[]string `json:"systems" validate:"omitempty,dive,min=1"`
	FuzzySystem *bool     `json:"fuzzySystem,omitempty"`
	// Rebuild discards the media database entirely and indexes from scratch.
	// Scraped metadata is lost and must be re-scraped; user data (favourites,
	// launcher overrides) lives in UserDB and is re-applied after indexing.
	// Incompatible with a systems filter: a fresh database indexed selectively
	// would silently drop every other system's media.
	Rebuild *bool `json:"rebuild,omitempty"`
}

type MediaLookupCandidatesParams struct {
	FuzzySystem *bool  `json:"fuzzySystem,omitempty"`
	MaxResults  *int   `json:"maxResults,omitempty" validate:"omitempty,min=1,max=5"`
	Name        string `json:"name" validate:"required,min=1,max=256"`
	System      string `json:"system" validate:"required,min=1,max=256"`
}

type MediaLookupCandidatesResponse struct {
	Candidates []database.TitleCandidate `json:"candidates"`
}

type MediaLookupMatch struct {
	RelPath            *string            `json:"relativePath,omitempty"`
	System             System             `json:"system"`
	Name               string             `json:"name"`
	Path               string             `json:"path"`
	ZapScript          string             `json:"zapScript"`
	Tags               []database.TagInfo `json:"tags"`
	DisambiguatingTags []database.TagInfo `json:"disambiguatingTags,omitempty"`
	MediaID            int64              `json:"mediaId,omitempty"`
	Confidence         float64            `json:"confidence"`
}

type MediaLookupParams struct {
	FuzzySystem *bool  `json:"fuzzySystem,omitempty"`
	Name        string `json:"name" validate:"required,min=1"`
	System      string `json:"system" validate:"required,min=1"`
}

type MediaLookupResponse struct {
	Match *MediaLookupMatch `json:"match"`
}

type MediaMetaBatchItemResponse struct {
	Media *MediaMetaMediaResponse `json:"media,omitempty"`
	Error *string                 `json:"error,omitempty"`
}

type MediaMetaBatchResponse struct {
	Items []MediaMetaBatchItemResponse `json:"items"`
}

type MediaMetaMediaResponse struct {
	Properties       map[string]MediaMetaPropertyItem `json:"properties"`
	LauncherOverride *string                          `json:"launcherOverride,omitempty"`
	// RelPath is the launcher-relative convenience path, when one can be
	// derived.
	RelPath *string `json:"relativePath,omitempty"`
	Path    string  `json:"path"`
	// ZapScript is the title command that launches this media. Omitted for
	// a missing media row.
	ZapScript           string                 `json:"zapScript,omitempty"`
	ParentDir           string                 `json:"parentDir"`
	Tags                []database.TagInfo     `json:"tags"`
	AvailableImageTypes []string               `json:"availableImageTypes,omitempty"`
	Title               MediaMetaTitleResponse `json:"title"`
	IsMissing           bool                   `json:"isMissing"`
}

type MediaMetaParams struct {
	MediaID *int64 `json:"mediaId,omitempty"`
	System  string `json:"system" validate:"omitempty,min=1"`
	Path    string `json:"path"   validate:"omitempty,min=1"`
}

type MediaMetaPropertyItem struct {
	Extension   *string `json:"extension,omitempty"`
	Text        string  `json:"text"`
	ContentType string  `json:"contentType"`
	BlobSize    int64   `json:"blobSize,omitempty"`
}

type MediaMetaResponse struct {
	Media MediaMetaMediaResponse `json:"media"`
}

type MediaMetaSystemResponse struct {
	ID   string `json:"id"`
	Name string `json:"name"`
}

type MediaMetaTitleResponse struct {
	SecondarySlug       *string                          `json:"secondarySlug,omitempty"`
	Properties          map[string]MediaMetaPropertyItem `json:"properties"`
	System              MediaMetaSystemResponse          `json:"system"`
	Slug                string                           `json:"slug"`
	Name                string                           `json:"name"`
	Tags                []database.TagInfo               `json:"tags"`
	AvailableImageTypes []string                         `json:"availableImageTypes,omitempty"`
	SlugLength          int                              `json:"slugLength"`
	SlugWordCount       int                              `json:"slugWordCount"`
}

type MediaMetaUpdateParams struct {
	MediaID *int64          `json:"mediaId,omitempty"`
	System  string          `json:"system" validate:"omitempty,min=1"`
	Path    string          `json:"path"   validate:"omitempty,min=1"`
	Media   json.RawMessage `json:"media,omitempty"`
}

type MediaPlaybackState string

type MediaResponse struct {
	Database  IndexingStatusResponse `json:"database"`
	Active    []ActiveMediaResponse  `json:"active"`
	Playlists []PlaylistState        `json:"playlists,omitempty"`
}

type MediaScrapeParams struct {
	Scope     *MediaScrapeScope `json:"scope,omitempty"`
	ScraperID string            `json:"scraperId" validate:"required,min=1"`
	Systems   []string          `json:"systems"   validate:"omitempty,dive,min=1"`
	Force     bool              `json:"force"`
}

type MediaScrapePath struct {
	System string `json:"system"`
	Path   string `json:"path"`
}

type MediaScrapeScope struct {
	MediaID *int64           `json:"mediaId,omitempty"`
	File    *MediaScrapePath `json:"file,omitempty"`
	Subtree *MediaScrapePath `json:"subtree,omitempty"`
}

type MediaStartedParams struct {
	SystemID   string `json:"systemId" validate:"required"`
	SystemName string `json:"systemName" validate:"required"`
	MediaPath  string `json:"mediaPath" validate:"required"`
	MediaName  string `json:"mediaName" validate:"required"`
	Slot       string `json:"slot,omitempty"`
}

type MediaStoppedParams struct {
	SystemID   string `json:"systemId"`
	SystemName string `json:"systemName"`
	MediaName  string `json:"mediaName"`
	MediaPath  string `json:"mediaPath"`
	LauncherID string `json:"launcherId"`
	Slot       string `json:"slot,omitempty"`
	// Reason says why the media stopped; see the MediaStopReason constants.
	// Clients written before it existed ignore the field.
	Reason  string `json:"reason,omitempty"`
	Elapsed int    `json:"elapsed"`
}

type MediaTagsChangedNotification struct {
	System string             `json:"system"`
	Path   string             `json:"path"`
	Tags   []database.TagInfo `json:"tags"`
}

type MediaTagsUpdateParams struct {
	MediaID *int64   `json:"mediaId,omitempty"`
	System  string   `json:"system" validate:"omitempty,min=1"`
	Path    string   `json:"path"   validate:"omitempty,min=1"`
	Add     []string `json:"add,omitempty" validate:"omitempty,dive,min=1"`
	Remove  []string `json:"remove,omitempty" validate:"omitempty,dive,min=1"`
}

type MediaTitleParseParams struct {
	SystemID string `json:"systemId" validate:"required,min=1"`
	Path     string `json:"path" validate:"required,min=1"`
}

type MediaTitleParseResponse struct {
	SecondarySlug *string `json:"secondarySlug,omitempty"`
	Slug          string  `json:"slug"`
	Name          string  `json:"name"`
	SlugLength    int     `json:"slugLength"`
	SlugWordCount int     `json:"slugWordCount"`
}

type MisterCoreInfo struct {
	// Name is the RBF short name, e.g. "3DO".
	Name string `json:"name"`
	// File is the installed RBF's filename, e.g. "3DO_20250101.rbf". Encodes
	// the installed core version; absent from Name and MGLPath.
	File string `json:"file"`
	// MGLPath is the SD-relative core identity used to launch it, e.g.
	// "_Console (Dual SDRAM)/3DO". Never an absolute filesystem path.
	MGLPath string `json:"mglPath"`
}

type NewClientParams struct {
	Name string `json:"name" validate:"required,min=1,max=255"`
}

type NewProfileParams struct {
	PIN           *string `json:"pin" validate:"omitempty,numeric,min=4,max=8"`
	LimitsEnabled *bool   `json:"limitsEnabled"`
	DailyLimit    *string `json:"dailyLimit" validate:"omitempty,duration"`
	SessionLimit  *string `json:"sessionLimit" validate:"omitempty,duration"`
	Name          string  `json:"name" validate:"required,min=1,max=255"`
	Role          string  `json:"role" validate:"omitempty,oneof=admin member"`
}

type Notification struct {
	Method string `json:"method"`
	// CoalesceKey separates notifications of one method that carry
	// independent state, such as one per media slot, so that merging a burst
	// for a slow client keeps the latest of each rather than only the latest
	// of the method. It is never sent.
	CoalesceKey string          `json:"-"`
	Params      json.RawMessage `json:"params"`
}

type NotificationObject struct {
	JSONRPC string          `json:"jsonrpc"`
	Method  string          `json:"method"`
	Params  json.RawMessage `json:"params,omitempty"`
}

type OnlineStatusResponse struct {
	FeaturesCheckedAt *string  `json:"featuresCheckedAt"`
	DeviceName        *string  `json:"deviceName,omitempty"`
	LinkedAt          *string  `json:"linkedAt,omitempty"`
	Features          []string `json:"features"`
	Linked            bool     `json:"linked"`
}

type PaginationInfo struct {
	NextCursor *string `json:"nextCursor,omitempty"`
	// Offset and AnchorIndex are media.browse only: the absolute position of
	// the page's first row and of the requested anchor.
	Offset      *int `json:"offset,omitempty"`
	AnchorIndex *int `json:"anchorIndex,omitempty"`
	HasNextPage bool `json:"hasNextPage"`
	PageSize    int  `json:"pageSize"`
}

type PairedClient struct {
	ClientID   string `json:"clientId"`
	ClientName string `json:"clientName"`
	Role       string `json:"role"`
	CreatedAt  int64  `json:"createdAt"`
	LastSeenAt int64  `json:"lastSeenAt"`
}

type PlaylistItemInfo struct {
	Name      string `json:"name"`
	ZapScript string `json:"zapScript"`
}

type PlaylistState struct {
	// AdvanceMs, IdleMs and CountdownMs are the playlist's rotation settings in
	// milliseconds, omitted when unset. A countdown of 0 is set: it switches
	// with no notice.
	AdvanceMs   *int64             `json:"advanceMs,omitempty"`
	IdleMs      *int64             `json:"idleMs,omitempty"`
	CountdownMs *int64             `json:"countdownMs,omitempty"`
	ID          string             `json:"id"`
	Name        string             `json:"name"`
	Slot        string             `json:"slot"`
	Repeat      string             `json:"repeat"`
	Items       []PlaylistItemInfo `json:"items"`
	Index       int                `json:"index"`
	Total       int                `json:"total"`
	Playing     bool               `json:"playing"`
	Unsafe      bool               `json:"unsafe"`
	// Shuffle reports that the items are in a random order. Items lists them
	// in the order they play.
	Shuffle bool `json:"shuffle"`
	// Armed reports an idle playlist that is loaded and waiting for the
	// device to go idle before it starts.
	Armed bool `json:"armed,omitempty"`
}

type PlaylistsChangedParams struct {
	Playlists []PlaylistState `json:"playlists"`
}

type PlaylistsUpdateParams struct {
	Shuffle *bool   `json:"shuffle,omitempty"`
	Repeat  *string `json:"repeat,omitempty"`
	Slot    string  `json:"slot,omitempty"`
}

type PlaytimeExtendedParams struct {
	Mode string `json:"mode"`
	// Duration is what this grant added. Omitted for a day waiver.
	Duration string `json:"duration,omitempty"`
	// Expires is when a day waiver lapses, RFC3339. Omitted otherwise.
	Expires string `json:"expires,omitempty"`
	// SessionExtension is the session's accumulated duration grant.
	SessionExtension string `json:"sessionExtension,omitempty"`
	// ProfileID is the recipient. Empty is the shared profile.
	ProfileID string `json:"profileId,omitempty"`
	// GrantedBy is the profile that authorized the grant.
	GrantedBy string `json:"grantedBy,omitempty"`
}

type PlaytimeLimitReachedParams struct {
	Reason string `json:"reason"`
}

type PlaytimeLimitWarningParams struct {
	Interval  string `json:"interval"`
	Remaining string `json:"remaining"`
}

type PlaytimeLimitsResponse struct {
	Daily        *string  `json:"daily,omitempty"`
	Session      *string  `json:"session,omitempty"`
	SessionReset *string  `json:"sessionReset,omitempty"`
	Retention    *int     `json:"retention,omitempty"`
	Warnings     []string `json:"warnings,omitempty"`
	Enabled      bool     `json:"enabled"`
}

type PlaytimeStatusResponse struct {
	SessionStarted        *string `json:"sessionStarted,omitempty"`
	SessionDuration       *string `json:"sessionDuration,omitempty"`
	SessionCumulativeTime *string `json:"sessionCumulativeTime,omitempty"`
	SessionRemaining      *string `json:"sessionRemaining,omitempty"`
	CooldownRemaining     *string `json:"cooldownRemaining,omitempty"`
	DailyUsageToday       *string `json:"dailyUsageToday,omitempty"`
	DailyRemaining        *string `json:"dailyRemaining,omitempty"`
	// SessionExtension is the time granted on top of the configured session
	// limit for the current session. Omitted when nothing was granted.
	SessionExtension *string `json:"sessionExtension,omitempty"`
	// SessionExtendedUntil is when a session-limit waiver lapses, RFC3339.
	// While it is set the session limit is not enforced and
	// sessionRemaining is omitted; the daily limit still applies.
	SessionExtendedUntil *string `json:"sessionExtendedUntil,omitempty"`
	State                string  `json:"state"`
	SessionActive        bool    `json:"sessionActive"`
	LimitsEnabled        bool    `json:"limitsEnabled"`
}

type ProfileResponse struct {
	LimitsEnabled *bool   `json:"limitsEnabled,omitempty"`
	DailyLimit    *string `json:"dailyLimit,omitempty"`
	SessionLimit  *string `json:"sessionLimit,omitempty"`
	LastUsedAt    *int64  `json:"lastUsedAt,omitempty"`
	ProfileID     string  `json:"profileId"`
	Name          string  `json:"name"`
	Role          string  `json:"role"`
	SwitchID      string  `json:"switchId,omitempty"`
	CreatedAt     int64   `json:"createdAt"`
	LastUpdatedAt int64   `json:"lastUpdatedAt"`
	HasPIN        bool    `json:"hasPin"`
}

type ProfileVerifyResponse struct {
	ProfileID string `json:"profileId"`
	Name      string `json:"name"`
	Role      string `json:"role"`
	HasPIN    bool   `json:"hasPin"`
}

type ProfilesActiveNotification struct {
	Profile *ActiveProfile `json:"profile"`
}

type ProfilesDataNotification struct {
	ProfileID string `json:"profileId"`
	Status    string `json:"status"`
	Reason    string `json:"reason,omitempty"`
}

type ProfilesResponse struct {
	Profiles []ProfileResponse `json:"profiles"`
}

type QuietClientError struct {
	Err error
}

type RPCID struct {
	json.RawMessage
}

type ReaderConnection struct {
	Enabled  *bool  `json:"enabled,omitempty"`
	Driver   string `json:"driver" validate:"required,min=1"`
	Path     string `json:"path"`
	IDSource string `json:"idSource,omitempty"`
	// ScanMode is validated by the handler rather than by a tag, so it accepts
	// the same spellings a config file does ("HOLD", " hold ") and stores the
	// canonical one. See config.NormalizeScanMode.
	ScanMode string `json:"scanMode,omitempty"`
}

type ReaderInfo struct {
	ID           string   `json:"id"`
	ReaderID     string   `json:"readerId"`
	Driver       string   `json:"driver"`
	Info         string   `json:"info"`
	ScanMode     string   `json:"scanMode"`
	Capabilities []string `json:"capabilities"`
	Connected    bool     `json:"connected"`
}

type ReaderResponse struct {
	Driver    string `json:"driver"`
	Path      string `json:"path"`
	Connected bool   `json:"connected"`
}

type ReaderWriteCancelParams struct {
	ReaderID *string `json:"readerId,omitempty"`
}

type ReaderWriteParams struct {
	ReaderID *string `json:"readerId,omitempty"`
	Text     string  `json:"text" validate:"required"`
}

type ReadersResponse struct {
	HoldOwnerReaderID string       `json:"holdOwnerReaderId,omitempty"`
	HoldScanMode      string       `json:"holdScanMode,omitempty"`
	Readers           []ReaderInfo `json:"readers"`
}

type RemoteActivityEntry struct {
	CreatedAt     string `json:"createdAt"`
	OperationType string `json:"operationType"`
	OriginKind    string `json:"originKind"`
	OriginKeyName string `json:"originKeyName,omitempty"`
	State         string `json:"state"`
	Status        string `json:"status,omitempty"`
	ErrorCode     string `json:"errorCode,omitempty"`
}

type RemoteActivityParams struct {
	Limit *int `json:"limit,omitempty" validate:"omitempty,gt=0,max=100"`
}

type RemoteActivityResponse struct {
	Status  RemoteStatusInfo      `json:"status"`
	Entries []RemoteActivityEntry `json:"entries"`
}

type RemoteStatusInfo struct {
	State         string `json:"state"`
	LastContactAt string `json:"lastContactAt,omitempty"`
	LastErrorCode string `json:"lastErrorCode,omitempty"`
}

type RequestObject struct {
	JSONRPC string          `json:"jsonrpc"`
	ID      RPCID           `json:"id,omitempty"`
	Method  string          `json:"method"`
	Params  json.RawMessage `json:"params,omitempty"`
}

type ResponseErrorObject struct {
	Error   *ErrorObject `json:"error"`
	JSONRPC string       `json:"jsonrpc"`
	ID      RPCID        `json:"id"`
}

type ResponseObject struct {
	Result  any          `json:"result"`
	Error   *ErrorObject `json:"error,omitempty"`
	JSONRPC string       `json:"jsonrpc"`
	ID      RPCID        `json:"id"`
}

type ResponseWithCallback struct {
	Result     any
	AfterWrite func()
}

type RunFailedParams struct {
	PlaylistIndex *int   `json:"playlistIndex,omitempty"`
	Source        string `json:"source"`
	ReaderID      string `json:"readerId,omitempty"`
	Script        string `json:"script,omitempty"`
	Command       string `json:"command,omitempty"`
	Category      string `json:"category"`
	Message       string `json:"message"`
	PlaylistID    string `json:"playlistId,omitempty"`
}

type RunParams struct {
	Type   *string `json:"type"`
	UID    *string `json:"uid"`
	Text   *string `json:"text"`
	Data   *string `json:"data" validate:"omitempty,hexdata"`
	Unsafe bool    `json:"unsafe"`
}

type RunScriptParams struct {
	Name      *string                  `json:"name"`
	Cmds      []zapscript.ZapScriptCmd `json:"cmds"`
	ZapScript int                      `json:"zapscript"`
	Unsafe    bool                     `json:"unsafe"`
}

type ScrapeSystemProgressResponse struct {
	SystemID   string `json:"systemId"`
	SystemName string `json:"systemName,omitempty"`
	Processed  int    `json:"processed"`
	Total      int    `json:"total"`
	Matched    int    `json:"matched"`
	Skipped    int    `json:"skipped"`
}

type ScraperInfo struct {
	ID               string   `json:"id"`
	Name             string   `json:"name"`
	SupportedSystems []string `json:"supportedSystems"`
}

type ScrapersResponse struct {
	Scrapers []ScraperInfo `json:"scrapers"`
}

type ScrapingStatusResponse struct {
	CurrentStep        *int                          `json:"currentStep,omitempty"`
	CurrentStepDisplay *string                       `json:"currentStepDisplay,omitempty"`
	TotalSteps         *int                          `json:"totalSteps,omitempty"`
	CurrentSystem      *ScrapeSystemProgressResponse `json:"currentSystem,omitempty"`
	ScraperID          string                        `json:"scraperId,omitempty"`
	SystemID           string                        `json:"systemId,omitempty"`
	State              string                        `json:"state,omitempty"`
	Error              string                        `json:"error,omitempty"`
	Processed          int                           `json:"processed"`
	Total              int                           `json:"total"`
	Matched            int                           `json:"matched"`
	Skipped            int                           `json:"skipped"`
	TotalScraped       int                           `json:"totalScraped"`
	Scraping           bool                          `json:"scraping"`
	Done               bool                          `json:"done"`
	Paused             bool                          `json:"paused"`
	// Throttled reports that scraping is running at reduced speed while
	// media plays.
	Throttled bool `json:"throttled,omitempty"`
	Force     bool `json:"force"`
}

type ScreenshotResponse struct {
	Path string `json:"path"`
	Data string `json:"data"` // base64 encoded
	Size int    `json:"size"` // original byte count
}

type SearchParams struct {
	Systems       *[]string `json:"systems" validate:"omitempty,dive,min=1"`
	FuzzySystem   *bool     `json:"fuzzySystem,omitempty"`
	PathPrefix    *string   `json:"pathPrefix,omitempty"`
	MaxResults    *int      `json:"maxResults" validate:"omitempty,gt=0,max=1000"`
	Cursor        *string   `json:"cursor,omitempty"`
	Tags          *[]string `json:"tags,omitempty" validate:"omitempty,dive,min=1"`
	Letter        *string   `json:"letter,omitempty" validate:"omitempty,letter"`
	Sort          *string   `json:"sort,omitempty" validate:"omitempty,oneof=name-asc name-desc filename-asc filename-desc added-desc"`
	Query         *string   `json:"query"`
	GroupBy       *string   `json:"groupBy,omitempty" validate:"omitempty,oneof=title"`
	TitleID       *int64    `json:"titleId,omitempty" validate:"omitempty,gt=0"`
	IncludeHidden bool      `json:"includeHidden,omitempty"`
}

type SearchResultMedia struct {
	RelPath *string `json:"relativePath,omitempty"`
	// VersionCount is set by a search grouped by title: how many versions of
	// the title matched, across the whole search rather than this page.
	VersionCount *int   `json:"versionCount,omitempty"`
	System       System `json:"system"`
	Name         string `json:"name"`
	Path         string `json:"path"`
	ZapScript    string `json:"zapScript"`
	// CoverColor is the cover thumbnail's average colour as "#rrggbb", for a
	// placeholder while the image loads. Omitted until a thumbnail was built.
	CoverColor         string             `json:"coverColor,omitempty"`
	Tags               []database.TagInfo `json:"tags"`
	DisambiguatingTags []database.TagInfo `json:"disambiguatingTags,omitempty"`
	MediaID            int64              `json:"mediaId,omitempty"`
	// TitleID identifies the media's title for a titleId search, which lists
	// its versions. Valid until the next media index.
	TitleID  int64 `json:"titleId,omitempty"`
	HasCover bool  `json:"hasCover"`
}

type SearchResults struct {
	Pagination *PaginationInfo     `json:"pagination,omitempty"`
	Results    []SearchResultMedia `json:"results"`
	Total      int                 `json:"total"`
}

type SettingsAuthClaimParams struct {
	ClaimURL string `json:"claimUrl" validate:"required,url"`
	Token    string `json:"token" validate:"required"`
}

type SettingsAuthClaimResponse struct {
	Domains []string `json:"domains"`
}

type SettingsAuthLinkParams struct {
	// URL overrides the auth server base URL; defaults to the official
	// Zaparoo API.
	URL string `json:"url,omitempty" validate:"omitempty,url"`
}

type SettingsAuthStatusParams struct {
	URL string `json:"url,omitempty" validate:"omitempty,url"`
}

type SettingsAuthStatusResponse struct {
	Linked bool `json:"linked"`
}

type SettingsAuthUnlinkResponse struct {
	Domains []string `json:"domains"`
}

type SettingsResponse struct {
	BackupRemoteEnabled       *bool              `json:"backupRemoteEnabled,omitempty"`
	PlaytimeSyncEnabled       *bool              `json:"playtimeSyncEnabled,omitempty"`
	LibrarySyncEnabled        *bool              `json:"librarySyncEnabled,omitempty"`
	RemoteControlEnabled      *bool              `json:"remoteControlEnabled,omitempty"`
	BackupRemoteSchedule      *string            `json:"backupRemoteSchedule,omitempty"`
	OnlineBaseURL             *string            `json:"onlineBaseUrl,omitempty"`
	MediaImageDir             *string            `json:"mediaImageDir,omitempty"`
	UpdateChannel             string             `json:"updateChannel"`
	AudioMidiSoundFont        string             `json:"audioMidiSoundFont"`
	ReadersScanMode           string             `json:"readersScanMode"`
	ReadersScanIgnoreSystem   []string           `json:"readersScanIgnoreSystems"`
	ReadersConnect            []ReaderConnection `json:"readersConnect"`
	SystemDefaults            []SystemDefault    `json:"systemDefaults"`
	LauncherPreference        []string           `json:"launcherPreference"`
	AudioVolume               int                `json:"audioVolume"`
	AudioMusicVolume          int                `json:"audioMusicVolume"`
	MediaThumbCacheMaxMB      int                `json:"mediaThumbCacheMaxMb"`
	LaunchGuardTimeout        float32            `json:"launchGuardTimeout"`
	LaunchGuardDelay          float32            `json:"launchGuardDelay"`
	ReadersScanExitDelay      float32            `json:"readersScanExitDelay"`
	RunZapScript              bool               `json:"runZapScript"`
	DebugLogging              bool               `json:"debugLogging"`
	AudioScanFeedback         bool               `json:"audioScanFeedback"`
	AudioMusicAutoplay        bool               `json:"audioMusicAutoplay"`
	AudioNormalize            bool               `json:"audioNormalize"`
	AudioMusicPauseOnLaunch   bool               `json:"audioMusicPauseOnLaunch"`
	ReadersAutoDetect         bool               `json:"readersAutoDetect"`
	ErrorReporting            bool               `json:"errorReporting"`
	Encryption                bool               `json:"encryption"`
	LaunchGuardEnabled        bool               `json:"launchGuardEnabled"`
	LaunchGuardRequireConfirm bool               `json:"launchGuardRequireConfirm"`
	ProfilesRequireForLaunch  bool               `json:"profilesRequireForLaunch"`
	ProfilesSwapData          bool               `json:"profilesSwapData"`
	UpdateCheck               bool               `json:"updateCheck"`
	UpdateInstall             bool               `json:"updateInstall"`
}

type SwitchProfileParams struct {
	ProfileID *string `json:"profileId"`
	SwitchID  *string `json:"switchId"`
	PIN       *string `json:"pin"`
}

type System struct {
	ReleaseDate  *string  `json:"releaseDate,omitempty"`
	Manufacturer *string  `json:"manufacturer,omitempty"`
	MediaCount   *int     `json:"mediaCount,omitempty"`
	ID           string   `json:"id,omitempty"`
	Name         string   `json:"name,omitempty"`
	Category     string   `json:"category,omitempty"`
	ZapScript    string   `json:"zapScript,omitempty"`
	Categories   []string `json:"categories,omitempty"`
}

type SystemDefault struct {
	System     string `json:"system" validate:"required,system"`
	Launcher   string `json:"launcher,omitempty"`
	BeforeExit string `json:"beforeExit,omitempty"`
}

type SystemsParams struct {
	Tags          *[]string `json:"tags,omitempty" validate:"omitempty,dive,min=1"`
	All           bool      `json:"all,omitempty"`
	IncludeHidden bool      `json:"includeHidden,omitempty"`
}

type SystemsResponse struct {
	Systems []System `json:"systems"`
}

type TagsResponse struct {
	Tags []database.TagInfo `json:"tags"`
}

type TokenResponse struct {
	ScanTime time.Time `json:"scanTime"`
	Type     string    `json:"type"`
	UID      string    `json:"uid"`
	Text     string    `json:"text"`
	Data     string    `json:"data"`
	ReaderID string    `json:"readerId,omitempty"`
}

type TokensResponse struct {
	Last   *TokenResponse  `json:"last,omitempty"`
	Active []TokenResponse `json:"active"`
}

type TrackInfo struct {
	Title       string `json:"title,omitempty"`
	Artist      string `json:"artist,omitempty"`
	Album       string `json:"album,omitempty"`
	AlbumArtist string `json:"albumArtist,omitempty"`
	Genre       string `json:"genre,omitempty"`
	Year        int    `json:"year,omitempty"`
	TrackNumber int    `json:"trackNumber,omitempty"`
	TrackTotal  int    `json:"trackTotal,omitempty"`
	DiscNumber  int    `json:"discNumber,omitempty"`
	DiscTotal   int    `json:"discTotal,omitempty"`
	// HasArt reports cover art that media.active.image can return.
	HasArt bool `json:"hasArt,omitempty"`
}

type UIChoice struct {
	Media *UIChoiceMedia `json:"media,omitempty"`
	ID    string         `json:"id"`
	Label string         `json:"label"`
	// Current marks the choice standing for what is open now, such as the
	// playing item of a playlist. Host widgets mark it; API clients get the
	// initial selection from selectedChoiceId instead.
	Current bool `json:"-"`
}

type UIChoiceMedia struct {
	System string `json:"system"`
	Path   string `json:"path"`
	Name   string `json:"name"`
}

type UIEvent struct {
	CreatedAt        time.Time   `json:"createdAt"`
	ExpiresAt        *time.Time  `json:"expiresAt,omitempty"`
	ID               string      `json:"id"`
	Kind             UIEventKind `json:"kind"`
	Title            string      `json:"title,omitempty"`
	Message          string      `json:"message,omitempty"`
	SelectedChoiceID string      `json:"selectedChoiceId,omitempty"`
	Choices          []UIChoice  `json:"choices,omitempty"`
	Dismissible      bool        `json:"dismissible"`
}

type UIEventKind string

type UIOutcome string

type UIResolution struct {
	ID       string    `json:"id"`
	Outcome  UIOutcome `json:"outcome"`
	ChoiceID string    `json:"choiceId,omitempty"`
}

type UIRespondParams struct {
	ID       string           `json:"id" validate:"required"`
	Action   UIResponseAction `json:"action" validate:"required,oneof=dismiss select confirm"`
	ChoiceID string           `json:"choiceId,omitempty"`
}

type UIResponseAction string

type UIStateResponse struct {
	Events   []UIEvent      `json:"events"`
	Resolved []UIResolution `json:"resolved"`
	Revision uint64         `json:"revision"`
}

type UpdateActiveMediaParams struct {
	SystemID  string `json:"systemId" validate:"required"`
	MediaPath string `json:"mediaPath" validate:"required"`
	MediaName string `json:"mediaName" validate:"required"`
}

type UpdateApplyParams struct {
	Force bool `json:"force"`
}

type UpdateApplyResponse struct {
	PreviousVersion string `json:"previousVersion"`
	NewVersion      string `json:"newVersion"`
}

type UpdateBlockedBy struct {
	Reason    string `json:"reason"`
	Message   string `json:"message"`
	Forceable bool   `json:"forceable"`
}

type UpdateCheckResponse struct {
	DeferredSince   *time.Time        `json:"deferredSince,omitempty"`
	LastResult      *UpdateLastResult `json:"lastResult,omitempty"`
	BlockedBy       *UpdateBlockedBy  `json:"blockedBy,omitempty"`
	CheckedAt       *time.Time        `json:"checkedAt,omitempty"`
	CurrentVersion  string            `json:"currentVersion"`
	ReleaseNotes    string            `json:"releaseNotes,omitempty"`
	Channel         string            `json:"channel,omitempty"`
	Eligibility     string            `json:"eligibility,omitempty"`
	DeferredReason  string            `json:"deferredReason,omitempty"`
	LatestVersion   string            `json:"latestVersion,omitempty"`
	UpdateAvailable bool              `json:"updateAvailable"`
	RolloutHeld     bool              `json:"rolloutHeld,omitempty"`
	AutoInstall     bool              `json:"autoInstall"`
}

type UpdateLastResult struct {
	At          time.Time `json:"at"`
	Outcome     string    `json:"outcome"`
	FromVersion string    `json:"fromVersion,omitempty"`
	ToVersion   string    `json:"toVersion,omitempty"`
	Detail      string    `json:"detail,omitempty"`
}

type UpdateMappingParams struct {
	Label    *string `json:"label" validate:"omitempty,max=255"`
	Enabled  *bool   `json:"enabled"`
	Type     *string `json:"type" validate:"omitempty,oneof=id value data uid text"`
	Match    *string `json:"match" validate:"omitempty,oneof=exact partial regex"`
	Pattern  *string `json:"pattern" validate:"omitempty,min=1"`
	Override *string `json:"override"`
	ID       int     `json:"id" validate:"gt=0"`
}

type UpdatePlaytimeLimitsParams struct {
	Enabled      *bool     `json:"enabled"`
	Daily        *string   `json:"daily" validate:"omitempty,duration"`
	Session      *string   `json:"session" validate:"omitempty,duration"`
	SessionReset *string   `json:"sessionReset" validate:"omitempty,duration"`
	Warnings     *[]string `json:"warnings" validate:"omitempty,dive,duration"`
	Retention    *int      `json:"retention" validate:"omitempty,gte=0"`
}

type UpdateProfileParams struct {
	Name               *string `json:"name" validate:"omitempty,min=1,max=255"`
	PIN                *string `json:"pin" validate:"omitempty,numeric,min=4,max=8"`
	LimitsEnabled      *bool   `json:"limitsEnabled"`
	DailyLimit         *string `json:"dailyLimit" validate:"omitempty,duration"`
	SessionLimit       *string `json:"sessionLimit" validate:"omitempty,duration"`
	Role               *string `json:"role" validate:"omitempty,oneof=admin member"`
	ProfileID          string  `json:"profileId" validate:"required,min=1"`
	ClearPIN           bool    `json:"clearPin"`
	ClearLimits        bool    `json:"clearLimits"`
	RegenerateSwitchID bool    `json:"regenerateSwitchId"`
}

type UpdateSettingsParams struct {
	RunZapScript            *bool     `json:"runZapScript"`
	DebugLogging            *bool     `json:"debugLogging"`
	AudioScanFeedback       *bool     `json:"audioScanFeedback"`
	ReadersAutoDetect       *bool     `json:"readersAutoDetect"`
	ErrorReporting          *bool     `json:"errorReporting"`
	Encryption              *bool     `json:"encryption"`
	BackupRemoteEnabled     *bool     `json:"backupRemoteEnabled"`
	PlaytimeSyncEnabled     *bool     `json:"playtimeSyncEnabled"`
	LibrarySyncEnabled      *bool     `json:"librarySyncEnabled"`
	RemoteControlEnabled    *bool     `json:"remoteControlEnabled"`
	UpdateChannel           *string   `json:"updateChannel" validate:"omitempty,oneof=stable beta"`
	BackupRemoteSchedule    *string   `json:"backupRemoteSchedule" validate:"omitempty,oneof=daily weekly manual"`
	ReadersScanMode         *string   `json:"readersScanMode" validate:"omitempty,oneof=tap hold"`
	AudioMidiSoundFont      *string   `json:"audioMidiSoundFont" validate:"omitempty,max=4096"`
	ReadersScanExitDelay    *float32  `json:"readersScanExitDelay" validate:"omitempty,gte=0"`
	ReadersScanIgnoreSystem *[]string `json:"readersScanIgnoreSystems" validate:"omitempty,dive,system"`
	// dive is what makes the tags on ReaderConnection run at all: without it
	// the validator stops at the slice and every element goes unchecked.
	ReadersConnect            *[]ReaderConnection `json:"readersConnect,omitempty" validate:"omitempty,dive"`
	SystemDefaults            *[]SystemDefault    `json:"systemDefaults,omitempty" validate:"omitempty,dive"`
	LauncherPreference        *[]string           `json:"launcherPreference,omitempty" validate:"omitempty,dive,required"`
	AudioVolume               *int                `json:"audioVolume" validate:"omitempty,gte=0,lte=200"`
	AudioMusicVolume          *int                `json:"audioMusicVolume" validate:"omitempty,gte=0,lte=200"`
	AudioMusicAutoplay        *bool               `json:"audioMusicAutoplay"`
	AudioNormalize            *bool               `json:"audioNormalize"`
	AudioMusicPauseOnLaunch   *bool               `json:"audioMusicPauseOnLaunch"`
	LaunchGuardEnabled        *bool               `json:"launchGuardEnabled"`
	LaunchGuardTimeout        *float32            `json:"launchGuardTimeout" validate:"omitempty,gte=-1"`
	LaunchGuardDelay          *float32            `json:"launchGuardDelay" validate:"omitempty,gte=0"`
	LaunchGuardRequireConfirm *bool               `json:"launchGuardRequireConfirm"`
	ProfilesRequireForLaunch  *bool               `json:"profilesRequireForLaunch"`
	ProfilesSwapData          *bool               `json:"profilesSwapData"`
	UpdateCheck               *bool               `json:"updateCheck"`
	UpdateInstall             *bool               `json:"updateInstall"`
	// MediaImageDir is [media] image_dir; "" restores the default.
	MediaImageDir *string `json:"mediaImageDir" validate:"omitempty,max=4096"`
	// MediaThumbCacheMaxMB is [media] thumb_cache_max_mb; 0 restores the default.
	MediaThumbCacheMaxMB *int `json:"mediaThumbCacheMaxMb" validate:"omitempty,gte=0,lte=1048576"`
}

type UpdateStateNotification struct {
	Stage           string `json:"stage"`
	Version         string `json:"version,omitempty"`
	Trigger         string `json:"trigger,omitempty"`
	Error           string `json:"error,omitempty"`
	BytesDownloaded int64  `json:"bytesDownloaded,omitempty"`
	BytesTotal      int64  `json:"bytesTotal,omitempty"`
}

type VerifyProfileParams struct {
	ProfileID *string `json:"profileId"`
	SwitchID  *string `json:"switchId"`
	PIN       *string `json:"pin"`
}

type VersionResponse struct {
	Version  string `json:"version"`
	Platform string `json:"platform"`
}