brave

type Answer struct {
	Text          string `json:"text"`
	Author        string `json:"author"`
	UpvoteCount   int    `json:"upvoteCount"`
	DownvoteCount int    `json:"downvoteCount"`
}

type Article struct {
	Author              []Person      `json:"author"`
	Date                string        `json:"date"`
	Publisher           *Organization `json:"organization"`
	Thumbnail           *Thumbnail    `json:"thumbnail"`
	IsAccessibleForFree bool          `json:"isAccessibleForFree"`
}

type Book struct {
	Title     string   `json:"title"`
	Author    []Person `json:"author"`
	Date      string   `json:"date"`
	Price     *Price   `json:"price"`
	Pages     Number   `json:"pages"`
	Publisher *Person  `json:"publisher"`
	Rating    *Rating  `json:"rating"`
}

type Brave interface {
	// WebSearch returns web search results.
	WebSearch(ctx context.Context, term string, options ...SearchOption) (*WebSearchResult, error)

	// SuggestSearch returns suggested related search terms.
	SuggestSearch(ctx context.Context, term string, options ...SearchOption) (*SuggestSearchResult, error)

	// Spellcheck returns spelling suggestions.
	Spellcheck(ctx context.Context, term string, options ...SearchOption) (*SpellcheckResult, error)

	// ImageSearch returns image search results.
	ImageSearch(ctx context.Context, term string, options ...SearchOption) (*ImageSearchResult, error)

	// VideoSearch returns video search results.
	VideoSearch(ctx context.Context, term string, options ...SearchOption) (*VideoSearchResult, error)
}

type ButtonResult struct {
	Type  string `json:"type"`
	Title string `json:"title"`
	URL   string `json:"url"`
}

type ClientOption func(clientOptions) clientOptions

type Contact struct {
	Email     string `json:"email"`
	Telephone string `json:"telephone"`
}

type CreativeWork struct {
	Name      string     `json:"name"`
	Thumbnail *Thumbnail `json:"thumbnail"`
	Rating    *Rating    `json:"rating"`
}

type DataProvider struct {
	Type     string `json:"type"`
	Name     string `json:"name"`
	URL      string `json:"url"`
	LongName string `json:"long_name"`
	Image    string `json:"img"`
}

type DayOpeningHours struct {
	AbbrName string `json:"abbr_name"`
	FullName string `json:"full_name"`
	Opens    string `json:"opens"`
	Closes   string `json:"closes"`
}

type DeepResult struct {
	News    []NewsResult            `json:"news"`
	Buttons []ButtonResult          `json:"buttons"`
	Social  []KnowledgeGraphProfile `json:"social"`
	Videos  []VideoResult           `json:"videos"`
	Images  []Image                 `json:"images"`
}

type DiscussionResult struct {
	SearchResult

	Type string    `json:"type"`
	Data ForumData `json:"data"`
}

type Duration time.Duration

type ErrorContext struct {
	EnumValues []string `json:"enum_values"`
}

type ErrorMeta struct {
	Component string           `json:"component"`
	Errors    []ErrorMetaError `json:"errors"`
}

type ErrorMetaError struct {
	Loc     []string     `json:"loc"`
	Message string       `json:"msg"`
	Type    string       `json:"type"`
	Context ErrorContext `json:"ctx"`
}

type ErrorResponse struct {
	ID     string     `json:"id"`
	Status int        `json:"status"`
	Code   string     `json:"code"`
	Detail string     `json:"detail"`
	Meta   ErrorMeta  `json:"meta"`
	Time   *Timestamp `json:"-"`
}

type FAQ struct {
	Type    string `json:"type"`
	Results []QA   `json:"results"`
}

type ForumData struct {
	ForumName  string `json:"forum_name"`
	NumAnswers int    `json:"num_answers"`
	Score      string `json:"score"`
	Question   string `json:"question"`
	TopComment string `json:"top_comment"`
}

type Freshness int8

type GraphInfoBox struct {
	Result

	Type            string         `json:"type"`
	Position        int            `json:"position"`
	Label           string         `json:"label"`
	Category        string         `json:"category"`
	LongDesc        string         `json:"long_desc"`
	Thumbnail       *Thumbnail     `json:"thumbnail"`
	Attributes      []any          `json:"attributes"`
	Profiles        []Profile      `json:"profiles"`
	WebsiteURL      string         `json:"website_url"`
	AttributesShown int            `json:"attributes_shown"`
	Ratings         []Rating       `json:"ratings"`
	Providers       []DataProvider `json:"providers"`
	Distance        *Unit          `json:"distance"`
	Images          []Thumbnail    `json:"images"`
	Movie           *MovieData     `json:"movie"`
}

type Image struct {
	Thumbnail  *Thumbnail       `json:"thumbnail"`
	URL        string           `json:"url"`
	Properties *ImageProperties `json:"properties"`
}

type ImageProperties struct {
	URL         string `json:"url"`
	Resized     string `json:"resized"`
	Height      int    `json:"height"`
	Width       int    `json:"width"`
	Format      string `json:"format"`
	ContentSize string `json:"content_size"`
	Placeholder string `json:"placeholder"`
}

type ImageResult struct {
	Type        string           `json:"type"`
	Title       string           `json:"title"`
	URL         string           `json:"url"`
	Source      string           `json:"source"`
	PageFetched *Timestamp       `json:"page_fetched"`
	Thumbnail   *Thumbnail       `json:"thumbnail"`
	Properties  *ImageProperties `json:"properties"`
	MetaURL     *MetaURL         `json:"meta_url"`
}

type ImageSearchResult struct {
	ResultContainer[ImageResult]
	Query *Query `json:"query"`
}

type KnowledgeGraphEntity struct {
	Title       string `json:"title"`
	Description string `json:"description"`
	URL         *URL   `json:"url"`
	Thumbnail   *URL   `json:"thumbnail"`
}

type KnowledgeGraphProfile struct {
	KnowledgeGraphEntity

	URL         string `json:"url"`
	Description string `json:"description"`
}

type Language struct {
	Main string `json:"main"`
}

type LocationResult struct {
	Result

	Type          string          `json:"type"`
	ProviderURL   string          `json:"provider_url"`
	Coordinates   []float32       `json:"coordinates"`
	ZoomLevel     int             `json:"zoom_level"`
	Thumbnail     *Thumbnail      `json:"thumbnail"`
	PostalAddress *PostalAddress  `json:"postal_address"`
	OpeningHours  *OpeningHours   `json:"opening_hours"`
	Contact       *Contact        `json:"contact"`
	PriceRange    string          `json:"price_range"`
	Rating        *Rating         `json:"rating"`
	Distance      *Unit           `json:"distance"`
	Profiles      []DataProvider  `json:"profiles"`
	Reviews       *Reviews        `json:"reviews"`
	Pictures      *PictureResults `json:"pictures"`
	ServesCuisine []string        `json:"serves_cuisine"`
}

type Locations struct {
	Type    string           `json:"type"`
	Results []LocationResult `json:"results"`
}

type MetaURL struct {
	Scheme   string `json:"scheme"`
	NetLoc   string `json:"netloc"`
	Hostname string `json:"hostname"`
	Favicon  string `json:"favicon"`
	Path     string `json:"path"`
}

type Mixed struct {
	Type string `json:"type"`
	Main []ResultReference
	Top  []ResultReference
	Side []ResultReference
}

type MobileURLItem struct {
	Original string `json:"original"`
	AMP      string `json:"amp"`
	Android  string `json:"android"`
	IOS      string `json:"ios"`
}

type MovieData struct {
	Name        string     `json:"name"`
	Description string     `json:"description"`
	URL         string     `json:"url"`
	Thumbnail   *Thumbnail `json:"thumbnail"`
	Release     string     `json:"release"`
	Directors   []Person   `json:"directors"`
	Actors      []Person   `json:"actors"`
	Rating      *Rating    `json:"rating"`
}

type MusicRecording struct {
	Name      string     `json:"name"`
	Thumbnail *Thumbnail `json:"thumbnail"`
	Rating    *Rating    `json:"rating"`
}

type NewsResult struct {
	Result
	MetaURL   MetaURL    `json:"meta_url"`
	Source    string     `json:"source"`
	Breaking  bool       `json:"breaking"`
	Thumbnail *Thumbnail `json:"thumbnail"`
	Age       *Timestamp `json:"age"`
}

type Number int

type OpeningHours struct {
	CurrentDay []DayOpeningHours   `json:"current_day"`
	Days       [][]DayOpeningHours `json:"days"`
}

type Organization struct {
	Person

	Type string `json:"type"`
}

type Person struct {
	Type      string     `json:"type"`
	Name      string     `json:"name"`
	URL       string     `json:"url"`
	Thumbnail *Thumbnail `json:"thumbnail"`
}

type PictureResults struct {
	Results     []Thumbnail `json:"results"`
	ViewMoreURL string      `json:"viewMoreUrl"`
}

type PostalAddress struct {
	Type            string `json:"type"`
	Country         string `json:"country"`
	PostalCode      string `json:"postalCode"`
	StreetAddress   string `json:"streetAddress"`
	AddressRegion   string `json:"addressRegion"`
	AddressLocality string `json:"addressLocality"`
	DisplayAddress  string `json:"displayAddress"`
}

type Price struct {
	Price         string `json:"price"`
	PriceCurrency string `json:"price_currency"`
}

type Profile struct {
	Name     string `json:"name"`
	LongName string `json:"long_name"`
	URL      string `json:"url"`
	Image    string `json:"img"`
}

type QA struct {
	Question string  `json:"question"`
	Answer   string  `json:"answer"`
	Title    string  `json:"title"`
	URL      string  `json:"url"`
	MetaURL  MetaURL `json:"meta_url"`
}

type QAPage struct {
	Question string  `json:"question"`
	Answer   *Answer `json:"answer"`
}

type Query struct {
	Original             string    `json:"original"`
	ShowStrictWarning    bool      `json:"show_strict_warning"`
	Altered              string    `json:"altered"`
	Safesearch           bool      `json:"safesearch"`
	IsNavigational       bool      `json:"is_navigational"`
	IsGeolocal           bool      `json:"is_geolocal"`
	LocalDecision        string    `json:"local_decision"`
	LocalLocationsIdx    int       `json:"local_locations_idx"`
	IsTrending           bool      `json:"is_trending"`
	IsNewsBreaking       bool      `json:"is_news_breaking"`
	AskForLocation       bool      `json:"ask_for_location"`
	Language             *Language `json:"language"`
	SpellcheckOff        bool      `json:"spellcheck_off"`
	Country              string    `json:"country"`
	BadResults           bool      `json:"bad_results"`
	ShouldFallback       bool      `json:"should_fallback"`
	Lat                  string    `json:"lat"`
	Long                 string    `json:"long"`
	PostalCode           string    `json:"postal_code"`
	City                 string    `json:"city"`
	State                string    `json:"state"`
	HeaderCountry        string    `json:"header_country"`
	MoreResultsAvailable bool      `json:"more_results_available"`
	CustomLocationLabel  string    `json:"custom_location_label"`
	RedditCluster        string    `json:"reddit_cluster"`
}

type Rating struct {
	RatingValue   float32  `json:"ratingValue"`
	BestRating    float32  `json:"bestRating"`
	ReviewCount   int      `json:"reviewCount"`
	Profile       *Profile `json:"profile"`
	IsTripadvisor bool     `json:"is_tripadvisor"`
}

type Result struct {
	Title          string     `json:"title"`
	URL            string     `json:"url"`
	IsSourceLocal  bool       `json:"is_source_local"`
	IsSourceBoth   bool       `json:"is_source_both"`
	Description    string     `json:"description"`
	PageAge        *Timestamp `json:"page_age"`
	PageFetched    string     `json:"page_fetched"`
	Profile        *Profile   `json:"profile"`
	Language       string     `json:"language"`
	FamilyFriendly bool       `json:"family_friendly"`
}

type ResultContainer[T any] struct {
	Type             string `json:"type"`
	Results          []T    `json:"results"`
	MutatedByGoggles bool   `json:"mutated_by_goggles"`
}

type ResultFilter string

type ResultReference struct {
	Type  string `json:"type"`
	Index int    `json:"index"`
	All   bool   `json:"all"`
}

type Review struct {
	Type        string     `json:"type"`
	Name        string     `json:"name"`
	Thumbnail   *Thumbnail `json:"thumbnail"`
	Description string     `json:"description"`
	Rating      *Rating    `json:"rating"`
}

type Reviews struct {
	Results                  []TripAdvisorReview `json:"results"`
	ViewMoreURL              string              `json:"viewMoreUrl"`
	ReviewsInForeignLanguage bool                `json:"reviews_in_foreign_language"`
}

type Safesearch int8

type SearchOption func(searchOptions) searchOptions

type SearchResult struct {
	Result
	Type        string          `json:"type"`
	Subtype     string          `json:"subtype"`
	DeepResults *DeepResult     `json:"deep_results"`
	Schemas     any             `json:"schemas"`
	MetaURL     MetaURL         `json:"meta_url"`
	Thumbnail   *Thumbnail      `json:"thumbnail"`
	Age         *Timestamp      `json:"age"`
	Language    string          `json:"language"`
	Restaurant  *LocationResult `json:"restaurant"`
	Locations   *Locations      `json:"locations"`
	Video       *VideoData      `json:"video"`
	Movie       *MovieData      `json:"movie"`
	FAQ         *FAQ            `json:"faq"`
	QA          *QAPage         `json:"qa"`
	Book        *Book           `json:"book"`
	Rating      *Rating         `json:"rating"`
	Article     *Article        `json:"article"`
	// Product     any             `json:"product"`
	// ProductCluster []any `json:"product_cluster"`
	ClusterType    string          `json:"cluster_type"`
	Cluster        []Result        `json:"cluster"`
	CreativeWork   *CreativeWork   `json:"creative_work"`
	MusicRecording *MusicRecording `json:"music_recording"`
	Review         *Review         `json:"review"`
	Software       *Software       `json:"software"`
	ContentType    string          `json:"content_type"`
}

type Software struct {
	Name           string `json:"name"`
	Author         string `json:"author"`
	Version        string `json:"version"`
	CodeRepository string `json:"codeRepository"`
	Homepage       string `json:"homepage"`
	DatePublished  string `json:"datePublisher"`
	IsNPM          bool   `json:"is_npm"`
	IsPyPi         bool   `json:"is_pypi"`
}

type SpellcheckResult struct {
	Type    string                 `json:"type"`
	Query   *Query                 `json:"query"`
	Results []SpellcheckResultItem `json:"results"`
}

type SpellcheckResultItem struct {
	Query string `json:"query"`
}

type SuggestResult struct {
	Query       string `json:"string"`
	IsEntity    bool   `json:"is_entity"`
	Title       string `json:"title"`
	Description string `json:"description"`
	Image       string `json:"img"`
}

type SuggestSearchResult struct {
	Type    string          `json:"type"`
	Query   *Query          `json:"query"`
	Results []SuggestResult `json:"results"`
}

type Thumbnail struct {
	Src             string `json:"src"`
	Height          int    `json:"height"`
	Width           int    `json:"width"`
	BackgroundColor string `json:"bg_color"`
	Original        string `json:"original"`
	Logo            bool   `json:"logo"`
	Duplicated      bool   `json:"duplicated"`
	Theme           string `json:"theme"`
}

type Timestamp time.Time

type TripAdvisorReview struct {
	Title       string  `json:"title"`
	Description string  `json:"description"`
	Date        string  `json:"date"`
	Rating      *Rating `json:"rating"`
	Author      *Person `json:"author"`
	ReviewURL   string  `json:"review_url"`
	Language    string  `json:"language"`
}

type URL struct {
	Original     string        `json:"original"`
	Display      string        `json:"display"`
	Alternatives []string      `json:"alternatives"`
	Canonical    string        `json:"canonical"`
	Mobile       MobileURLItem `json:"mobile"`
}

type Unit struct {
	Value float32 `json:"value"`
	Units string  `json:"units"`
}

type UnitType int8

type VideoData struct {
	Duration  *Duration  `json:"duration"`
	Views     VideoViews `json:"views"`
	Creator   string     `json:"creator"`
	Publisher string     `json:"publisher"`
	Thumbnail *Thumbnail `json:"thumbnail"`
}

type VideoResult struct {
	Result
	Type      string     `json:"type"`
	Data      *VideoData `json:"video"`
	MetaURL   MetaURL    `json:"meta_url"`
	Thumbnail *Thumbnail `json:"thumbnail"`
	Age       *Timestamp `json:"age"`
}

type VideoSearchResult struct {
	ResultContainer[VideoResult]
	Query *Query `json:"query"`
}

type VideoViews int

type WebSearchResult struct {
	Type        string                             `json:"type"`
	Discussions *ResultContainer[DiscussionResult] `json:"discussions"`
	FAQ         any                                `json:"faq"`
	InfoBox     *ResultContainer[GraphInfoBox]     `json:"infobox"`
	Locations   *Locations                         `json:"locations"`
	Mixed       *Mixed                             `json:"mixed"`
	News        *ResultContainer[NewsResult]       `json:"news"`
	Query       *Query                             `json:"query"`
	Videos      *ResultContainer[VideoResult]      `json:"videos"`
	Web         *ResultContainer[SearchResult]     `json:"web"`
}